Hosting Bring Your Own (BYO) Assets

Overview

Hosting Bring Your Own (BYO) external assets lets Creators Also known as Unqork Users, or Designer Users; is anyone who is inside the Unqork platform. host assets on a client-managed CDN (Content Delivery Network). To ensure secure access, the CDN must whitelist the client’s Unqork environment, allowing the Unqork Designer Platform to retrieve the bundle as needed.

The Bring Your Own framework is intended for developers who have a strong understanding of the Unqork Designer Platform and JavaScript JavaScript is an object-oriented computer programming language. It is most-commonly used for interactive effects in the browser..

Requirements

The following sections are requirements to bring your own assets into the Unqork Designer Platform:

Bundle Requirements

• Must adhere to the BYO Component SDK.

• Must be written in JavaScript JavaScript is an object-oriented computer programming language. It is most-commonly used for interactive effects in the browser..

• Must be exported as valid ES module (not CJS or UMD)

  • Unqork recommends using bundlers to help with build options. For example: https://vite.dev/config/build-options#build-lib.

  • Scripts directly import by browser, compiled with es2020 in order to make sure it works across multiple browsers.

• The bundle must not include any rendering libraries or frameworks like React, Angular, or Vue.

• The default export must needs to expose the web component implementation

 

CDN Requirements

As long as your Unqork environment has access to the CDN, the bundled code will be retrievable.

Access

When using a CDN, there are two methods of access:

• Making the CDN publicly accessible.

• Whitelisting the Unqork environment on the CDN.

Example CDN Access Methods

You can use any CDN as long as it provides an accessible URL. If you do not have access to a CDN, consider the following examples to host external assets: