The Bring Your Own Assets feature is currently in open beta. Please contact your Unqork representative for more details and access.
Overview
The BYO (Bring Your Own) empowers Creators to extend the Unqork platform with custom-built functionality that goes beyond Unqork's standard configuration. By packaging and deploying custom component, operation, or event logic in a structured, validated format, developers gain full control over application behavior while maintaining compatibility with Unqork’s runtime.
With the BYO framework, you can create custom assets like components, events, and operations. These custom assets are then available for use by all Creators in your Unqork Designer Platform environment.
The Bring Your Own framework is intended for developers who have a strong understanding of the Unqork Designer Platform and JavaScript.
Understanding the BYO End-to-End Flow
The BYO end-to-end process begins by creating a package archive that includes the implementation (.js) and manifest.json files, which define the metadata and configuration contracts.
After installing a package in your Unqork environment, the Unqork Designer Platform performs validation to ensure the structure and contents are valid. After validation, the package is extracted and its files are uploaded to Unqork's object storage solution (Amazon S3). Then, the package is served through Unqork's CDN (Content Delivery Network), making it accessible to browser-based applications.
Next, the Unqork platform parses the manifest.json to extract metadata used in the display and configuration of custom components in the Designer platform's visual interface.
At runtime, during the initial page load of the application, all JavaScript files from the package load. Doing so ensures the custom functionality is available and ready to render as part of the application configuration.
Get Started
Use the links below to learn how the BYO framework functions, including:
How to extend the Unqork platform using custom BYO packages.
The required structure and contents of a valid BYO package, including manifest.json and compiled JavaScript.
A working knowledge of the Runtime Engine API and how your component interacts with state and events.
How to create, configure, and register custom components for use in the Unqork Designer.
End-to-end visibility into the BYO life cycle—from development to deployment in a live application.
BYO Documentation
Create a BYO Package
Discover the structure and content of a BYO Package
Understanding the manifest.json File
Learn about the file's specification, component and event definitions.
Understanding the BYO Runtime Engine API
Discover the interface between your custom BYO components and the Unqork platform.
Custom Component
Understand the state, interface, and events of a custom component.
Custom Component SDK
Extend component functionality in the Unqork Designer Platform.
Custom Events
Learn more about creating custom events for use in the Operations Builder.
Custom Operations
Learn more about creating custom operations for use in the Operations Builder..
Event Payloads
Learn more about viewing and using event payloads with the Operations Builder.
BYO Implementation Examples
Discover examples of component implementation using the Unqork Designer Platform.
Custom Assets Administration
Upload and view BYO custom assets for the environment.
BYO Best Practices
Learn about best practices for implementing and using BYO assets.
BYO General FAQ
Learn about the Bring Your Own Framework and discover frequently asked questions.