@cesdk/engine 1.7.0-alpha.4 → 1.7.0

package/index.d.ts

@@ -0,0 +1,2531 @@
+/// <reference types="offscreencanvas" />
+
+/**
+ * Generic asset information
+ * @public
+ */
+export declare interface Asset {
+    /**
+     *  Is a combination of source id, extension pack id (optional), type and asset id
+     *  e.g. "extension://ly.img.cesdk.images.samples/ly.img.image/sample.1"
+     */
+    id: string;
+    /**   E.g. `ly.img.image` */
+    /**  Groups of the asset.  */
+    groups?: Groups;
+    /** URI to a thumbnail of the asset used e.g. in the content library UI */
+    thumbUri: string;
+
+    /** Asset-specific and custom meta information */
+    meta?: {
+        uri?: string;
+        filename?: string;
+        vectorPath?: string;
+    } & Record<string, unknown>;
+}
+
+/**
+ * @public
+ */
+export declare class AssetAPI {
+    #private;
+
+    /**
+     * Adds a custom asset source. Its ID has to be unique.
+     * @param source - The asset source.
+     */
+    addSource(source: AssetSource): void;
+    /**
+     * Removes an asset source with the given ID.
+     * @param id - The ID to refer to the asset source.
+     */
+    removeSource(id: string): void;
+    /**
+     * Finds all registered asset sources.
+     * @returns A list with the IDs of all registered asset sources.
+     */
+    findAllSources(): string[];
+    /**
+     * Finds assets of a given type in a specific asset source.
+     * @param sourceId - The ID of the asset source.
+     * @param query - All the options to filter the search results by.
+     * @returns The search results.
+     */
+    findAssets(sourceId: string, query: AssetQueryData): Promise<AssetsQueryResult>;
+    /**
+     * Queries the asset source's groups for a certain asset type.
+     * @param id - The ID of the asset source.
+     * @returns The asset groups.
+     */
+    getGroups(id: string): Promise<string[]>;
+    /**
+     * Queries the asset source's credits info.
+     * @param sourceId - The ID of the asset source.
+     * @returns The asset source's credits info consisting of a name and an optional URL.
+     */
+    getCredits(sourceId: string): {
+        name: string;
+        url: string | undefined;
+    } | undefined;
+    /**
+     * Queries the asset source's license info.
+     * @param sourceId - The ID of the asset source.
+     * @returns The asset source's license info consisting of a name and an optional URL.
+     */
+    getLicense(sourceId: string): {
+        name: string;
+        url: string | undefined;
+    } | undefined;
+    canManageAssets(sourceId: string): boolean;
+    /**
+     * Apply an asset result to the active scene.
+     * The default behavior will instantiate a block and configure it according to the asset's properties.
+     * Note that this can be overridden by providing an `applyAsset` function when adding the asset source.
+     * @param sourceId - The ID of the asset source.
+     * @param assetResult - A single assetResult of a `findAssets` query.
+     */
+    apply(sourceId: string, assetResult: AssetResult): Promise<void>;
+}
+
+/**
+ * Definition of an assets used if an asset is added to an asset source.
+ * @public
+ */
+export declare interface AssetDefinition extends Asset {
+    /**
+     * Label used to display in aria-label and as a tooltip.
+     * Will be also searched in a query and should be localized
+     */
+    label?: Record<Locale, string>;
+    /**
+     * Tags for this asset. Can be used for filtering, but is also useful for
+     * free-text search. Since the label is searched as well as used for tooltips
+     * you do not want to overdo it, but still add things which are searched.
+     * Thus, it should be localized similar to the `label`.
+     */
+    tags?: Record<Locale, string[]>;
+}
+
+/**
+ * Defines a request for querying assets
+ * @public
+ */
+export declare interface AssetQueryData {
+    /** A query string used for (fuzzy) searching of labels and tags */
+    query?: string;
+    /** The current page queried for paginated views. */
+    page: number;
+    /**
+     * Tags are searched with the query parameter, but this search is fuzzy.
+     * If one needs to get assets with exactly the tag (from a tag cloud or filter)
+     * this query parameter should be used.
+     */
+    tags?: string | string[];
+    /** Query only these groups */
+    groups?: Groups;
+    /** Filter out assets with this groups */
+    excludeGroups?: Groups;
+    /** Choose the locale of the labels and tags for localized search and filtering */
+    locale?: Locale;
+    /**
+     * The number of results queried. How many assets shall be returned regardless
+     * of the total number of assets available.
+     *
+     * Together with `page` this can be used for pagination.
+     */
+    perPage: number;
+}
+
+/**
+ * Single asset result of a query from the engine.
+ * @public
+ */
+export declare interface AssetResult extends Asset {
+    /** The locale of the label and tags */
+    locale?: Locale;
+    /** The label of the result. Used for description and tooltips. */
+    label?: string;
+    /** The tags of this asset. Used for filtering and free-text searching. */
+    tags?: string[];
+
+    /** Credits for the artist of the asset */
+    credits?: {
+        name: string;
+        url?: string;
+    };
+    /** License for this asset. Overwrites the source license if present */
+    license?: {
+        name: string;
+        url?: string;
+    };
+    /** UTM parameters for the links inside the credits */
+    utm?: {
+        source?: string;
+        medium?: string;
+    };
+}
+
+/**
+ * Single asset result of a query from the engine.
+ * @public
+ */
+declare interface AssetResult_2 {
+    /** A unique id of this asset */
+    id: string;
+    /** URI to a thumbnail of the asset used e.g. in the content library UI */
+    thumbUri: string;
+    /** Original size of the asset. */
+    size: {
+        width: number;
+        height: number;
+    };
+    /** Asset-specific and custom meta information */
+    meta?: {
+        uri?: string;
+        filename?: string;
+    } & Record<string, unknown>;
+    /** The locale of the label and tags */
+    locale?: string;
+    /** The label of the result. Used for description and tooltips.  */
+    label?: string;
+    /** The tags of this asset. Used for filtering and free-text searching.  */
+    tags?: string[];
+    context: {
+        sourceId: string;
+    };
+    /** Credits for the artist of the asset */
+    credits?: {
+        name: string;
+        url?: string;
+    };
+    /** License for this asset. Overwrites the source license if present */
+    license?: {
+        name: string;
+        url?: string;
+    };
+}
+
+/** @public */
+declare interface AssetResultContext {
+    sourceId: string;
+    createdByRole: string;
+}
+
+/**
+ * A source of assets
+ * @public
+ */
+export declare interface AssetSource {
+    /** The unique id of the API */
+    id: string;
+    /** Find all asset for the given type and the provided query data.  */
+    findAssets(queryData: AssetQueryData): Promise<AssetsQueryResult>;
+    /** Return every available group */
+    getGroups?: () => Promise<string[]>;
+    /** Credits for the source/api */
+    credits?: {
+        name: string;
+        url?: string;
+    };
+    /** General license for all asset from this source */
+    license?: {
+        name: string;
+        url?: string;
+    };
+    /**
+     * Indicates if the asset shall be downloaded to handle the raw data instead
+     * of an URL reference. Do this if you do not want to depend on
+     * a service after adding the asset to the scene. If this is your own API
+     * with your own service, you do not need to set this and avoid downloading /
+     * re-uploading the assets.
+     */
+    downloadAssets?: (asset: AssetResult) => Promise<Blob>;
+    /**
+     * @returns the asset or undefined if no asset with the given id could be found
+     */
+    getAsset(id: string): Promise<AssetResult | undefined>;
+    /**
+     * Can the source add, update and remove assets dynamically? If `false`
+     * methods like `addAsset` `updateAsset` and `removeAsset` will throw an
+     * error.
+     */
+    canManageAssets?: boolean;
+    /**
+     * Apply the given asset result to the active scene.
+     * You can override this with custom behavior.
+     */
+    applyAsset?: (asset: AssetResult) => Promise<void>;
+    /**
+     * Adds the given asset to this source. Throws an error if `canManageAssets`
+     * is `false`.
+     *
+     * @returns the id of the added asset
+     */
+    addAsset(asset: AssetDefinition): Promise<string>;
+    /**
+     * Updates the asset of this source. Throws an error if `canManageAssets`
+     * is `false` or no asset with the given id could not be found.
+     *
+     * @returns the id of the added asset
+     */
+    updateAsset(assetId: string, asset: AssetDefinition): Promise<void>;
+    /**
+     * Removes the given asset from this source.
+     *
+     * @returns true if asset was found and removed, and false otherwise
+     */
+    removeAsset(assetId: string): Promise<boolean>;
+}
+
+/**
+ * API to query for assets
+ * @public
+ */
+declare interface AssetSource_2 {
+    /** Find all asset for the given type and the provided query data.  */
+    findAssets(queryData?: QueryData): Promise<AssetsQueryResult_2 | undefined>;
+    /**
+     * Apply the given asset result to the active scene.
+     * You can override this with custom behavior.
+     */
+    applyAsset?: (asset: AssetResult_2) => Promise<void>;
+    /** Return every available group */
+    getGroups?: () => Promise<string[]>;
+    /**
+     * Indicates if the asset shall be downloaded to handle the raw data instead
+     * of an URL reference. Do this if you do not want to depend on
+     * a service after adding the asset to the scene. If this is your own API
+     * with your own service, you do not need to set this and avoid downloading /
+     * re-uploading the assets.
+     */
+    downloadAssets?: (asset: AssetResult_2) => Promise<Blob>;
+    /** Credits for the source/api */
+    credits?: {
+        name: string;
+        url?: string;
+    };
+    /** General license for all asset from this source */
+    license?: {
+        name: string;
+        url?: string;
+    };
+}
+
+/** @public */
+declare type AssetSources = {
+    [id: string]: AssetSource_2;
+};
+
+/**
+ * Return type of a `findAssets` query.
+ * @public
+ */
+export declare interface AssetsQueryResult {
+    /** The assets in the requested page */
+    assets: AssetResult[];
+    /** The current, requested page */
+    currentPage: number;
+    /** The next page to query if it exists */
+    nextPage?: number;
+    /** How many assets are there in total for the current query regardless of the page */
+    total: number;
+}
+
+/**
+ * Return type of a `findAssets` query.
+ * @public
+ */
+declare interface AssetsQueryResult_2 {
+    /** The assets in the requested page */
+    assets: AssetResult_2[];
+    /** The current, requested page */
+    currentPage: number;
+    /** The next page to query if it exists */
+    nextPage?: number;
+    /** How many assets are there in total for the current query regardless of the page */
+    total: number;
+}
+
+/**
+ * @public
+ */
+export declare type BlendMode = 'PassThrough' | 'Normal' | 'Darken' | 'Multiply' | 'ColorBurn' | 'Lighten' | 'Screen' | 'ColorDodge' | 'Overlay' | 'SoftLight' | 'HardLight' | 'Difference' | 'Exclusion' | 'Hue' | 'Saturation' | 'Color' | 'Luminosity';
+
+/** @public */
+declare type Block = number;
+
+/**
+ * @public
+ */
+export declare class BlockAPI {
+    #private;
+
+    /**
+     * Exports a design block element as a file of the given mime type.
+     * Performs an internal update to resolve the final layout for the blocks.
+     * @param handle - The design block element to export.
+     * @param mimeType - The mime type of the output file.
+     * @param options - The options for exporting the block type
+     * @returns A promise that resolves with the exported image or is rejected with an error.
+     */
+    export(handle: DesignBlockId, mimeType?: MimeType_2, options?: ExportOptions): Promise<Blob>;
+
+    /**
+     * Loads existing blocks from the given string.
+     * The blocks are not attached by default and won't be visible until attached to a page or the scene.
+     * @param content - A string representing the given blocks.
+     * @returns A promise that resolves with a list of handles representing the found blocks or an error.
+     */
+    loadFromString(content: string): Promise<DesignBlockId[]>;
+    /**
+     * Saves the given blocks into a string. If given the root of a block hierarchy, e.g. a
+     * page with multiple children, the entire hierarchy is saved.
+     * @param blocks - The blocks to save
+     * @returns A promise that resolves to a string representing the blocks or an error.
+     */
+    saveToString(blocks: DesignBlockId[]): Promise<string>;
+    /**
+     * Create a new block, fails if type is unknown.
+     * @param type - The type of the block that shall be created.
+     * @returns The created blocks handle.
+     */
+    create(type: DesignBlockType): DesignBlockId;
+    /**
+     * Create a new fill, fails if type is unknown.
+     * @param type - The type of the fill object that shall be created.
+     * @returns The created fill's handle.
+     */
+    createFill(type: string): DesignBlockId;
+
+    /**
+     * Get the type of the given block, fails if the block is invalid.
+     * @param id - The block to query.
+     * @returns The blocks type.
+     */
+    getType(id: DesignBlockId): DesignBlockType;
+    /**
+     * Update the selection state of a block.
+     * Fails for invalid blocks.
+     * @param id - The block to query.
+     * @param selected - Whether or not the block should be selected.
+     */
+    setSelected(id: DesignBlockId, selected: boolean): void;
+    /**
+     * Get the selected state of a block.
+     * @param id - The block to query.
+     * @returns True if the block is selected, false otherwise.
+     */
+    isSelected(id: DesignBlockId): boolean;
+    /**
+     * Get all currently selected blocks.
+     * @returns An array of block ids.
+     */
+    findAllSelected(): DesignBlockId[];
+    /**
+     * Confirms that a given set of blocks can be grouped together.
+     * @param ids - A non-empty array of block ids.
+     * @returns Whether the blocks can be grouped together.
+     */
+    isGroupable(ids: DesignBlockId[]): boolean;
+    /**
+     * Group blocks together.
+     * @param ids - A non-empty array of block ids.
+     * @returns The block id of the created group.
+     */
+    group(ids: DesignBlockId[]): DesignBlockId;
+    /**
+     * Ungroups a group.
+     * @param id - The group id from a previous call to `group`.
+     */
+    ungroup(id: DesignBlockId): void;
+    /**
+     * Changes selection from selected group to a block within that group.
+     * Nothing happens if `group` is not a group.
+     * @param id - The group id from a previous call to `group`.
+     */
+    enterGroup(id: DesignBlockId): void;
+    /**
+     * Changes selection from a group's selected block to that group.
+     * Nothing happens if the `id` is not part of a group.
+     * @param id - A block id.
+     */
+    exitGroup(id: DesignBlockId): void;
+    /**
+     * Update a block's name.
+     * @param id - The block to update.
+     * @param name - The name to set.
+     */
+    setName(id: DesignBlockId, name: string): void;
+    /**
+     * Get a block's name.
+     * @param id - The block to update.
+     */
+    getName(id: DesignBlockId): string;
+    /**
+     * Finds all blocks with the given name.
+     * @param name - The name to search for.
+     * @returns A list of block ids.
+     */
+    findByName(name: string): DesignBlockId[];
+    /**
+     * Finds all blocks with the given type.
+     * @param type - The type to search for.
+     * @returns A list of block ids.
+     */
+    findByType(type: DesignBlockType): DesignBlockId[];
+    /**
+     * Return all blocks currently known to the engine.
+     * @returns A list of block ids.
+     */
+    findAll(): DesignBlockId[];
+    /**
+     * Return all placeholder blocks in the current scene.
+     * @returns A list of block ids.
+     */
+    findAllPlaceholders(): DesignBlockId[];
+    /**
+     * Query a block's visibility.
+     * @param id - The block to query.
+     * @returns True if visible, false otherwise.
+     */
+    isVisible(id: DesignBlockId): boolean;
+    /**
+     * Update a block's visibility.
+     * @param id - The block to update.
+     * @param visible - Whether the block shall be visible.
+     */
+    setVisible(id: DesignBlockId, visible: boolean): void;
+    /**
+     * Query a block's clipped state. If true, the block should clip
+     * its contents to its frame.
+     * @param id - The block to query.
+     * @returns True if clipped, false otherwise.
+     */
+    isClipped(id: DesignBlockId): boolean;
+    /**
+     * Update a block's clipped state.
+     * @param id - The block to update.
+     * @param clipped - Whether the block should clips its contents to its frame.
+     */
+    setClipped(id: DesignBlockId, clipped: boolean): void;
+    /**
+     * Query a block's x position.
+     * @param id - The block to query.
+     * @returns The value of the x position.
+     */
+    getPositionX(id: DesignBlockId): number;
+    /**
+     * Query a block's mode for its x position.
+     * @param id - The block to query.
+     * @returns The current mode for the x position: absolute, percent or undefined.
+     */
+    getPositionXMode(id: DesignBlockId): PositionMode;
+    /**
+     * Query a block's y position.
+     * @param id - The block to query.
+     * @returns The value of the y position.
+     */
+    getPositionY(id: DesignBlockId): number;
+    /**
+     * Query a block's mode for its y position.
+     * @param id - The block to query.
+     * @returns The current mode for the y position: absolute, percent or undefined.
+     */
+    getPositionYMode(id: DesignBlockId): PositionMode;
+    /**
+     * Update a block's x position.
+     * The position refers to the block's local space, relative to its parent with the origin at the top left.
+     * @param id - The block to update.
+     * @param value - The value of the x position.
+     */
+    setPositionX(id: DesignBlockId, value: number): void;
+    /**
+     * Set a block's mode for its x position.
+     * @param id - The block to update.
+     * @param mode - The x position mode: absolute, percent or undefined.
+     */
+    setPositionXMode(id: DesignBlockId, mode: PositionMode): void;
+    /**
+     * Update a block's y position.
+     * The position refers to the block's local space, relative to its parent with the origin at the top left.
+     * @param id - The block to update.
+     * @param value - The value of the y position.
+     */
+    setPositionY(id: DesignBlockId, value: number): void;
+    /**
+     * Set a block's mode for its y position.
+     * @param id - The block to update.
+     * @param mode - The y position mode: absolute, percent or undefined.
+     */
+    setPositionYMode(id: DesignBlockId, mode: PositionMode): void;
+    /**
+     * Query a block's rotation in radians.
+     * @param id - The block to query.
+     * @returns The block's rotation around its center in radians.
+     */
+    getRotation(id: DesignBlockId): number;
+    /**
+     * Update a block's rotation.
+     * @param id - The block to update.
+     * @param radians - The new rotation in radians. Rotation is applied around the block's center.
+     */
+    setRotation(id: DesignBlockId, radians: number): void;
+    /**
+     * Query a block's horizontal flip state.
+     * @param id - The block to query.
+     * @returns A boolean indicating for whether the block is flipped in the queried direction
+     */
+    getFlipHorizontal(id: DesignBlockId): boolean;
+    /**
+     * Query a block's vertical flip state.
+     * @param id - The block to query.
+     * @returns A boolean indicating for whether the block is flipped in the queried direction
+     */
+    getFlipVertical(id: DesignBlockId): boolean;
+    /**
+     * Update a block's horizontal flip.
+     * @param id - The block to update.
+     * @param flip - If the flip should be enabled.
+     */
+    setFlipHorizontal(id: DesignBlockId, flip: boolean): void;
+    /**
+     * Update a block's vertical flip.
+     * @param id - The block to update.
+     * @param flip - If the flip should be enabled.
+     */
+    setFlipVertical(id: DesignBlockId, flip: boolean): void;
+    /**
+     * Query if the given block has a content fill mode.
+     * @param id - The block to query.
+     * @returns true, if the block has a content fill mode.
+     */
+    hasContentFillMode(id: DesignBlockId): boolean;
+    /**
+     * Query a block's width.
+     * @param id - The block to query.
+     * @returns The value of the block's width.
+     */
+    getWidth(id: DesignBlockId): number;
+    /**
+     * Query a block's mode for its width.
+     * @param id - The block to query.
+     * @returns The current mode for the width: absolute, percent or auto.
+     */
+    getWidthMode(id: DesignBlockId): SizeMode;
+    /**
+     * Query a block's height.
+     * @param id - The block to query.
+     * @returns The value of the block's height.
+     */
+    getHeight(id: DesignBlockId): number;
+    /**
+     * Query a block's mode for its height.
+     * @param id - The block to query.
+     * @returns The current mode for the height: absolute, percent or auto.
+     */
+    getHeightMode(id: DesignBlockId): SizeMode;
+    /**
+     * Query a block's content fill mode.
+     * @param id - The block to query.
+     * @returns The current mode: crop, cover or contain.
+     */
+    getContentFillMode(id: DesignBlockId): ContentFillMode;
+    /**
+     * Update a block's width.
+     * @param id - The block to update.
+     * @param value - The new width of the block.
+     */
+    setWidth(id: DesignBlockId, value: number): void;
+    /**
+     * Set a block's mode for its width.
+     * @param id - The block to update.
+     * @param mode - The width mode: absolute, percent or auto.
+     */
+    setWidthMode(id: DesignBlockId, mode: SizeMode): void;
+    /**
+     * Update a block's height.
+     * @param id - The block to update.
+     * @param value - The new height of the block.
+     */
+    setHeight(id: DesignBlockId, value: number): void;
+    /**
+     * Set a block's mode for its height.
+     * @param id - The block to update.
+     * @param mode - The height mode: absolute, percent or auto.
+     */
+    setHeightMode(id: DesignBlockId, mode: SizeMode): void;
+    /**
+     * Set a block's content fill mode.
+     * @param id - The block to update.
+     * @param mode - The content fill mode mode: crop, cover or contain.
+     */
+    setContentFillMode(id: DesignBlockId, mode: ContentFillMode): void;
+    /**
+     * Get a block's layout width. The layout width is only available after an
+     * internal update loop, which may not happen immediately.
+     * @param id - The block to query.
+     * @returns The layout width.
+     */
+    getFrameWidth(id: DesignBlockId): number;
+    /**
+     * Get a block's layout height. The layout height is only available after an
+     * internal update loop, which may not happen immediately.
+     * @param id - The block to query.
+     * @returns The layout height.
+     */
+    getFrameHeight(id: DesignBlockId): number;
+    /**
+     * Duplicates a block including its children.
+     * @param id - The block to duplicate.
+     * @returns The handle of the duplicate.
+     */
+    duplicate(id: DesignBlockId): DesignBlockId;
+    /**
+     * Destroys a block.
+     * @param id - The block to destroy.
+     */
+    destroy(id: DesignBlockId): void;
+    /**
+     * Check if a block is valid. A block becomes invalid once it has been destroyed.
+     * @param id - The block to query.
+     * @returns True, if the block is valid.
+     */
+    isValid(id: DesignBlockId): boolean;
+    /**
+     * Query a block's parent.
+     * @param id - The block to query.
+     * @returns The parent's handle or null if the block has no parent.
+     */
+    getParent(id: DesignBlockId): DesignBlockId | null;
+    /**
+     * Get all children of the given block. Children
+     * are sorted in their rendering order: Last child is rendered
+     * in front of other children.
+     * @param id - The block to query.
+     * @returns A list of block ids.
+     */
+    getChildren(id: DesignBlockId): DesignBlockId[];
+    /**
+     * Insert a new or existing child at a certain position in the parent's children.
+     * @param parent - The block whose children should be updated.
+     * @param child - The child to insert. Can be an existing child of `parent`.
+     * @param index - The index to insert or move to.
+     */
+    insertChild(parent: DesignBlockId, child: DesignBlockId, index: number): void;
+    /**
+     * Appends a new or existing child to a block's children.
+     * @param parent - The block whose children should be updated.
+     * @param child - The child to insert. Can be an existing child of `parent`.
+     */
+    appendChild(parent: DesignBlockId, child: DesignBlockId): void;
+    /** Checks whether the given block references any variables. Doesn't check the block's children.
+     *
+     * @param id - The block to inspect.
+     * @returns true if the block references variables and false otherwise.
+     */
+    referencesAnyVariables(id: DesignBlockId): boolean;
+    /**
+     * Get the x position of the block's axis-aligned bounding box in the scene's global coordinate space.
+     * The scene's global coordinate space has its origin at the top left.
+     * @param id - The block whose bounding box should be calculated.
+     * @returns float The x coordinate of the position of the axis-aligned bounding box.
+     */
+    getGlobalBoundingBoxX(id: DesignBlockId): number;
+    /**
+     * Get the y position of the block's axis-aligned bounding box in the scene's global coordinate space.
+     * The scene's global coordinate space has its origin at the top left.
+     * @param id - The block whose bounding box should be calculated.
+     * @returns float The y coordinate of the position of the axis-aligned bounding box.
+     */
+    getGlobalBoundingBoxY(id: DesignBlockId): number;
+    /**
+     * Get the width of the block's axis-aligned bounding box in the scene's global coordinate space.
+     * The scene's global coordinate space has its origin at the top left.
+     * @param id - The block whose bounding box should be calculated.
+     * @returns float The width of the axis-aligned bounding box.
+     */
+    getGlobalBoundingBoxWidth(id: DesignBlockId): number;
+    /**
+     * Get the height of the block's axis-aligned bounding box in the scene's global coordinate space.
+     * The scene's global coordinate space has its origin at the top left.
+     * @param id - The block whose bounding box should be calculated.
+     * @returns float The height of the axis-aligned bounding box.
+     */
+    getGlobalBoundingBoxHeight(id: DesignBlockId): number;
+    /**
+     * Scales the block and all of its children proportionally around the specified
+     * relative anchor point.
+     *
+     * This updates the position, size and style properties (e.g. stroke width) of
+     * the block and its children.
+     *
+     * @param id - The block that should be scaled.
+     * @param scale - The scale factor to be applied to the current properties of the block.
+     * @param anchorX - The relative position along the width of the block around which the
+     * scaling should occur. (0 = left edge, 0.5 = center, 1 = right edge)
+     * @param anchorY - The relative position along the height of the block around which the
+     * scaling should occur. (0 = top edge, 0.5 = center, 1 = bottom edge)
+     */
+    scale(id: DesignBlockId, scale: number, anchorX?: number, anchorY?: number): void;
+    /**
+     * Get all available properties of a block.
+     * @param id - The block whose properties should be queried.
+     * @returns A list of the property names.
+     */
+    findAllProperties(id: DesignBlockId): string[];
+    /**
+     * Get the type of a property given its name.
+     * @param property - The name of the property whose type should be queried.
+     * @returns The property type.
+     */
+    getPropertyType(property: string): PropertyType;
+    /**
+     * Get all the possible values of an enum given an enum property.
+     * @param enumProperty - The name of the property whose enum values should be queried.
+     * @returns A list of the enum value names as string.
+     */
+    getEnumValues<T = string>(enumProperty: string): T[];
+    /**
+     * Set a bool property of the given design block to the given value.
+     * @param id - The block whose property should be set.
+     * @param property - The name of the property to set.
+     * @param value - The value to set.
+     */
+    setBool(id: DesignBlockId, property: string, value: boolean): void;
+    /**
+     * Get the value of a bool property of the given design block.
+     * @param id - The block whose property should be queried.
+     * @param property - The name of the property to query.
+     * @returns The value of the property.
+     */
+    getBool(id: DesignBlockId, property: string): boolean;
+    /**
+     * Set an int property of the given design block to the given value.
+     * @param id - The block whose property should be set.
+     * @param property - The name of the property to set.
+     * @param value - The value to set.
+     */
+    setInt(id: DesignBlockId, property: string, value: number): void;
+    /**
+     * Get the value of an int property of the given design block.
+     * @param id - The block whose property should be queried.
+     * @param property - The name of the property to query.
+     * @returns The value of the property.
+     */
+    getInt(id: DesignBlockId, property: string): number;
+    /**
+     * Set a float property of the given design block to the given value.
+     * @param id - The block whose property should be set.
+     * @param property - The name of the property to set.
+     * @param value - The value to set.
+     */
+    setFloat(id: DesignBlockId, property: string, value: number): void;
+    /**
+     * Get the value of a float property of the given design block.
+     * @param id - The block whose property should be queried.
+     * @param property - The name of the property to query.
+     * @returns The value of the property.
+     */
+    getFloat(id: DesignBlockId, property: string): number;
+    /**
+     * Set a string property of the given design block to the given value.
+     * @param id - The block whose property should be set.
+     * @param property - The name of the property to set.
+     * @param value - The value to set.
+     */
+    setString(id: DesignBlockId, property: string, value: string): void;
+    /**
+     * Get the value of a string property of the given design block.
+     * @param id - The block whose property should be queried.
+     * @param property - The name of the property to query.
+     * @returns The value of the property.
+     */
+    getString(id: DesignBlockId, property: string): string;
+    /**
+     * Set a color property of the given design block to the given value.
+     * @param id - The block whose property should be set.
+     * @param property - The name of the property to set.
+     * @param r - The red color component in the range of 0 to 1.
+     * @param g - The green color component in the range of 0 to 1.
+     * @param b - The blue color component in the range of 0 to 1.
+     * @param a - The alpha color component in the range of 0 to 1.
+     */
+    setColorRGBA(id: DesignBlockId, property: string, r: number, g: number, b: number, a?: number): void;
+    /**
+     * Get the value of a string property of the given design block.
+     * @param id - The block whose property should be queried.
+     * @param property - The name of the property to query.
+     * @returns A tuple of channels red, green, blue and alpha in the range of 0 to 1.
+     */
+    getColorRGBA(id: DesignBlockId, property: string): RGBA;
+    /**
+     * Set an enum property of the given design block to the given value.
+     * @param id - The block whose property should be set.
+     * @param property - The name of the property to set.
+     * @param value - The enum value as string.
+     */
+    setEnum(id: DesignBlockId, property: string, value: string): void;
+    /**
+     * Get the value of an enum property of the given design block.
+     * @param id - The block whose property should be queried.
+     * @param property - The name of the property to query.
+     * @returns The value as string.
+     */
+    getEnum(id: DesignBlockId, property: string): string;
+    /**
+     * Query if the given block has crop properties.
+     * @param id - The block to query.
+     * @returns true, if the block has crop properties.
+     */
+    hasCrop(id: DesignBlockId): boolean;
+    /**
+     * Set the crop scale in x direction of the given design block.
+     * @param id - The block whose crop should be set.
+     * @param scaleX - The scale in x direction.
+     */
+    setCropScaleX(id: DesignBlockId, scaleX: number): void;
+    /**
+     * Set the crop scale in y direction of the given design block.
+     * @param id - The block whose crop should be set.
+     * @param scaleY - The scale in y direction.
+     */
+    setCropScaleY(id: DesignBlockId, scaleY: number): void;
+    /**
+     * Set the crop rotation of the given design block.
+     * @param id - The block whose crop should be set.
+     * @param rotation - The rotation in radians.
+     */
+    setCropRotation(id: DesignBlockId, rotation: number): void;
+    /**
+     * Set the crop scale ratio of the given design block.
+     * @param id - The block whose crop should be set.
+     * @param scaleRatio - The crop scale ratio.
+     */
+    setCropScaleRatio(id: DesignBlockId, scaleRatio: number): void;
+    /**
+     * Set the crop translation in x direction of the given design block.
+     * @param id - The block whose crop should be set.
+     * @param translationY - The translation in y direction.
+     */
+    setCropTranslationX(id: DesignBlockId, translationX: number): void;
+    /**
+     * Set the crop translation in y direction of the given design block.
+     * @param id - The block whose crop should be set.
+     * @param translationY - The translation in y direction.
+     */
+    setCropTranslationY(id: DesignBlockId, translationY: number): void;
+    /**
+     * Resets the manually set crop of the given design block.
+     * The block's content fill mode is set to 'cover'.
+     * @param id - The block whose crop should be reset.
+     */
+    resetCrop(id: DesignBlockId): void;
+    /**
+     * Get the crop scale on the x axis of the given design block.
+     * @param id - The block whose scale should be queried.
+     * @returns The scale on the x axis.
+     */
+    getCropScaleX(id: DesignBlockId): number;
+    /**
+     * Get the crop scale on the y axis of the given design block.
+     * @param id - The block whose scale should be queried.
+     * @returns The scale on the y axis.
+     */
+    getCropScaleY(id: DesignBlockId): number;
+    /**
+     * Get the crop rotation of the given design block.
+     * @param id - The block whose crop rotation should be queried.
+     * @returns The crop rotation.
+     */
+    getCropRotation(id: DesignBlockId): number;
+    /**
+     * Get the crop scale ratio of the given design block.
+     * @param id - The block whose crop scale ratio should be queried.
+     * @returns The crop scale ratio.
+     */
+    getCropScaleRatio(id: DesignBlockId): number;
+    /**
+     * Get the crop translation on the x axis of the given design block.
+     * @param id - The block whose translation should be queried.
+     * @returns The translation on the x axis.
+     */
+    getCropTranslationX(id: DesignBlockId): number;
+    /**
+     * Get the crop translation on the y axis of the given design block.
+     * @param id - The block whose translation should be queried.
+     * @returns The translation on the y axis.
+     */
+    getCropTranslationY(id: DesignBlockId): number;
+    /**
+     * Adjust the crop position/scale to at least fill the crop frame.
+     * @param id - The block whose crop scale ratio should be queried.
+     * @param minScaleRatio - The minimal crop scale ratio to go down to.
+     */
+    adjustCropToFillFrame(id: DesignBlockId, minScaleRatio: number): number;
+    /**
+     * Query if the given block has an opacity.
+     * @param id - The block to query.
+     * @returns true, if the block has an opacity.
+     */
+    hasOpacity(id: DesignBlockId): boolean;
+    /**
+     * Set the opacity of the given design block.
+     * @param id - The block whose opacity should be set.
+     * @param opacity - The opacity to be set. The valid range is 0 to 1.
+     */
+    setOpacity(id: DesignBlockId, opacity: number): void;
+    /**
+     * Get the opacity of the given design block.
+     * @param id - The block whose opacity should be queried.
+     * @returns The opacity.
+     */
+    getOpacity(id: DesignBlockId): number;
+    /**
+     * Query if the given block has a blend mode.
+     * @param id - The block to query.
+     * @returns true, if the block has a blend mode.
+     */
+    hasBlendMode(id: DesignBlockId): boolean;
+    /**
+     * Set the blend mode of the given design block.
+     * @param id - The block whose blend mode should be set.
+     * @param blendMode - The blend mode to be set.
+     * @returns
+     */
+    setBlendMode(id: DesignBlockId, blendMode: BlendMode): void;
+    /**
+     * Get the blend mode of the given design block.
+     * @param id - The block whose blend mode should be queried.
+     * @returns The blend mode.
+     */
+    getBlendMode(id: DesignBlockId): BlendMode;
+    /**
+     * Query if the given block has fill color properties.
+     * @param id - The block to query.
+     * @returns true, if the block has fill color properties.
+     */
+    hasFillColor(id: DesignBlockId): boolean;
+    /**
+     * Set the fill color of the given design block.
+     * @param id - The block whose fill color should be set.
+     * @param color - The fill color to be set, a tuple of
+     * @param r - The red color component in the range of 0 to 1.
+     * @param g - The green color component in the range of 0 to 1.
+     * @param b - The blue color component in the range of 0 to 1.
+     * @param a - The alpha color component in the range of 0 to 1.
+     */
+    setFillColorRGBA(id: DesignBlockId, r: number, g: number, b: number, a?: number): void;
+    /**
+     * Get the fill color of the given design block.
+     * @param id - The block whose fill color should be queried.
+     * @returns The fill color.
+     */
+    getFillColorRGBA(id: DesignBlockId): RGBA;
+    /**
+     * Enable or disable the fill of the given design block.
+     * @param id - The block whose fill should be enabled or disabled.
+     * @param enabled - If true, the fill will be enabled.
+     */
+    setFillColorEnabled(id: DesignBlockId, enabled: boolean): void;
+    /**
+     * Query if the fill of the given design block is enabled.
+     * @param id - The block whose fill state should be queried.
+     * @returns True, if fill is enabled.
+     */
+    isFillColorEnabled(id: DesignBlockId): boolean;
+    /**
+     * Create a new effect block, fails if type is unknown or not a valid effect block type.
+     * @param type - The type id of the effect.
+     * @returns The created effects handle.
+     */
+    createEffect(type: string): DesignBlockId;
+    /**
+     * Queries whether the block supports effects.
+     * @param id - The block to query.
+     * @returns True, if the block can render effects, false otherwise.
+     */
+    hasEffects(id: DesignBlockId): boolean;
+    /**
+     * Get a list of all effects attached to this block
+     * @param id - The block to query.
+     * @returns A list of effects or an error, if the block doesn't support effects.
+     */
+    getEffects(id: DesignBlockId): DesignBlockId[];
+    /**
+     * Inserts an effect at the given index into the list of effects of the given block.
+     * The same effect can appear multiple times in the list and won't be removed if appended again.
+     * @param id - The block to update.
+     * @param effectId - The effect to insert
+     * @param index - The index at which the effect shall be inserted.
+     */
+    insertEffect(id: DesignBlockId, effectId: DesignBlockId, index: number): void;
+    /**
+     * Inserts an effect at the end of the list of effects
+     * The same effect can appear multiple times in the list and won't be removed if appended again.
+     * @param id - The block to append the effect to.
+     * @param effectId - The effect to append.
+     */
+    appendEffect(id: DesignBlockId, effectId: DesignBlockId): void;
+    /**
+     * Removes the effect at the given index.
+     * @param id - The block to remove the effect from.
+     * @param index - The index where the effect is stored.
+     */
+    removeEffect(id: DesignBlockId, index: number): void;
+    /**
+     * Checks whether an 'effect' block may be enabled and disabled.
+     * @param effectId - The 'effect' block to query.
+     * @returns True, if the block supports enabling and disabling, false otherwise.
+     */
+    hasEffectEnabled(effectId: DesignBlockId): boolean;
+    /**
+     * Sets the enabled state of an 'effect' block.
+     * @param effectId - The 'effect' block to update.
+     * @param enabled - The new state.
+     */
+    setEffectEnabled(effectId: DesignBlockId, enabled: boolean): void;
+    /**
+     * Queries whether an 'effect' block is enabled and therefore applies its effect.
+     * @param effectId - The 'effect' block to query.
+     * @returns True, if the effect is enabled. False otherwise.
+     */
+    isEffectEnabled(effectId: DesignBlockId): boolean;
+    /**
+     * Create a new blur, fails if type is unknown or not a valid blur type.
+     * @param type - The type id of the block.
+     * @returns The handle of the newly created blur.
+     */
+    createBlur(type: string): DesignBlockId;
+    /**
+     * Checks whether the block supports blur.
+     * @param id - The block to query.
+     * @returns True, if the block supports blur.
+     */
+    hasBlur(id: DesignBlockId): boolean;
+    /**
+     * Connects `block`'s blur to the given `blur` block.
+     * @param id - The block to update.
+     * @param blurId - A 'blur' block.
+     */
+    setBlur(id: DesignBlockId, blurId: DesignBlockId): void;
+    /**
+     * Get the 'blur' block of the given design block.
+     * @param id - The block to query.
+     * @returns The 'blur' block.
+     */
+    getBlur(id: DesignBlockId): DesignBlockId;
+    /**
+     * Enable or disable the blur of the given design block.
+     * @param id - The block to update.
+     * @param enabled - The new enabled value.
+     */
+    setBlurEnabled(id: DesignBlockId, enabled: boolean): void;
+    /**
+     * Query if blur is enabled for the given block.
+     * @param id - The block to query.
+     * @returns True, if the blur is enabled. False otherwise.
+     */
+    isBlurEnabled(id: DesignBlockId): boolean;
+    /**
+     * Query if the given block has background color properties.
+     * @param id - The block to query.
+     * @returns true, if the block has background color properties.
+     */
+    hasBackgroundColor(id: DesignBlockId): boolean;
+    /**
+     * Set the background color of the given design block.
+     * @param id - The block whose background color should be set.
+     * @param color - The background color to be set, a tuple of
+     * @param r - The red color component in the range of 0 to 1.
+     * @param g - The green color component in the range of 0 to 1.
+     * @param b - The blue color component in the range of 0 to 1.
+     * @param a - The alpha color component in the range of 0 to 1.
+     */
+    setBackgroundColorRGBA(id: DesignBlockId, r: number, g: number, b: number, a?: number): void;
+    /**
+     * Get the background color of the given design block.
+     * @param id - The block whose background color should be queried.
+     * @returns The background color.
+     */
+    getBackgroundColorRGBA(id: DesignBlockId): RGBA;
+    /**
+     * Enable or disable the background of the given design block.
+     * @param id - The block whose background should be enabled or disabled.
+     * @param enabled - If true, the background will be enabled.
+     */
+    setBackgroundColorEnabled(id: DesignBlockId, enabled: boolean): void;
+    /**
+     * Query if the background of the given design block is enabled.
+     * @param id - The block whose background state should be queried.
+     * @returns True, if background is enabled.
+     */
+    isBackgroundColorEnabled(id: DesignBlockId): boolean;
+    /**
+     * Query if the given block has a stroke property.
+     * @param id - The block to query.
+     * @returns True if the block has a stroke property.
+     */
+    hasStroke(id: DesignBlockId): boolean;
+    /**
+     * Enable or disable the stroke of the given design block.
+     * @param id - The block whose stroke should be enabled or disabled.
+     * @param enabled - If true, the stroke will be enabled.
+     */
+    setStrokeEnabled(id: DesignBlockId, enabled: boolean): void;
+    /**
+     * Query if the stroke of the given design block is enabled.
+     * @param id - The block whose stroke state should be queried.
+     * @returns True if the block's stroke is enabled.
+     */
+    isStrokeEnabled(id: DesignBlockId): boolean;
+    /**
+     * Set the stroke color of the given design block.
+     * @param id - The block whose stroke color should be set.
+     * @param r - The red color component in the range of 0 to 1.
+     * @param g - The green color component in the range of 0 to 1.
+     * @param b - The blue color component in the range of 0 to 1.
+     * @param a - The alpha color component in the range of 0 to 1.
+     */
+    setStrokeColorRGBA(id: DesignBlockId, r: number, g: number, b: number, a?: number): void;
+    /**
+     * Get the stroke color of the given design block.
+     * @param id - The block whose background color should be queried.
+     * @returns The background color.
+     */
+    getStrokeColorRGBA(id: DesignBlockId): RGBA;
+    /**
+     * Set the stroke width of the given design block.
+     * @param id - The block whose stroke width should be set.
+     * @param width - The stroke width to be set.
+     */
+    setStrokeWidth(id: DesignBlockId, width: number): void;
+    /**
+     * Get the stroke width of the given design block.
+     * @param id - The block whose stroke width should be queried.
+     * @returns The stroke's width.
+     */
+    getStrokeWidth(id: DesignBlockId): number;
+    /**
+     * Set the stroke style of the given design block.
+     * @param id - The block whose stroke style should be set.
+     * @param style - The stroke style to be set.
+     */
+    setStrokeStyle(id: DesignBlockId, style: StrokeStyle): void;
+    /**
+     * Get the stroke style of the given design block.
+     * @param id - The block whose stroke style should be queried.
+     * @returns The stroke's style.
+     */
+    getStrokeStyle(id: DesignBlockId): StrokeStyle;
+    /**
+     * Set the stroke position of the given design block.
+     * @param id - The block whose stroke position should be set.
+     * @param position - The stroke position to be set.
+     */
+    setStrokePosition(id: DesignBlockId, position: StrokePosition): void;
+    /**
+     * Get the stroke position of the given design block.
+     * @param id - The block whose stroke position should be queried.
+     * @returns The stroke position.
+     */
+    getStrokePosition(id: DesignBlockId): StrokePosition;
+    /**
+     * Set the stroke corner geometry of the given design block.
+     * @param id - The block whose stroke join geometry should be set.
+     * @param cornerGeometry - The stroke join geometry to be set.
+     */
+    setStrokeCornerGeometry(id: DesignBlockId, cornerGeometry: StrokeCornerGeometry): void;
+    /**
+     * Get the stroke corner geometry of the given design block.
+     * @param id - The block whose stroke join geometry should be queried.
+     * @returns The stroke join geometry.
+     */
+    getStrokeCornerGeometry(id: DesignBlockId): StrokeCornerGeometry;
+    /**
+     * Query if the given block has outline properties.
+     * @param id - The block to query.
+     * @returns true, if the block has outline properties.
+     * @deprecated Use `hasStroke`.
+     */
+    hasOutline(id: DesignBlockId): boolean;
+    /**
+     * Set the outline color of the given design block.
+     * @param id - The block whose outline color should be set.
+     * @param color - The outline color to be set, a tuple of
+     * @param r - The red color component in the range of 0 to 1.
+     * @param g - The green color component in the range of 0 to 1.
+     * @param b - The blue color component in the range of 0 to 1.
+     * @param a - The alpha color component in the range of 0 to 1.
+     * @deprecated Use `setStrokeColorRGBA`.
+     */
+    setOutlineColorRGBA(id: DesignBlockId, r: number, g: number, b: number, a?: number): void;
+    /**
+     * Get the outline color of the given design block.
+     * @param id - The block whose outline color should be queried.
+     * @returns The outline color.
+     * @deprecated Use `getStrokeColorRGBA`.
+     */
+    getOutlineColorRGBA(id: DesignBlockId): RGBA;
+    /**
+     * Enable or disable the outline of the given design block.
+     * @param id - The block whose outline should be enabled or disabled.
+     * @param enabled - If true, the outline will be enabled.
+     * @deprecated Use `setStrokeEnabled`.
+     */
+    setOutlineEnabled(id: DesignBlockId, enabled: boolean): void;
+    /**
+     * Query if the outline of the given design block is enabled.
+     * @param id - The block whose outline state should be queried.
+     * @returns True, if outline is enabled.
+     * @deprecated Use `isStrokeEnabled`.
+     */
+    isOutlineEnabled(id: DesignBlockId): boolean;
+    /**
+     * Set the outline width of the given design block.
+     * @param id - The block whose outline width should be set.
+     * @param width - The outline width to be set.
+     * @deprecated Use `setStrokeWidth`.
+     */
+    setOutlineWidth(id: DesignBlockId, width: number): void;
+    /**
+     * Get the outline width of the given design block.
+     * @param id - The block whose outline width should be queried.
+     * @returns The outline width.
+     * @deprecated Use the Stroke function
+     * @deprecated Use `getStrokeWidth`.
+     */
+    getOutlineWidth(id: DesignBlockId): number;
+    /**
+     * Query if the given block has a drop shadow property.
+     * @param id - The block to query.
+     * @returns True if the block has a drop shadow property.
+     */
+    hasDropShadow(id: DesignBlockId): boolean;
+    /**
+     * Enable or disable the drop shadow of the given design block.
+     * @param id - The block whose drop shadow should be enabled or disabled.
+     * @param enabled - If true, the drop shadow will be enabled.
+     */
+    setDropShadowEnabled(id: DesignBlockId, enabled: boolean): void;
+    /**
+     * Query if the drop shadow of the given design block is enabled.
+     * @param id - The block whose drop shadow state should be queried.
+     * @returns True if the block's drop shadow is enabled.
+     */
+    isDropShadowEnabled(id: DesignBlockId): boolean;
+    /**
+     * Set the drop shadow color of the given design block.
+     * @param id - The block whose drop shadow color should be set.
+     * @param r - The red color component in the range of 0 to 1.
+     * @param g - The green color component in the range of 0 to 1.
+     * @param b - The blue color component in the range of 0 to 1.
+     * @param a - The alpha color component in the range of 0 to 1.
+     */
+    setDropShadowColorRGBA(id: DesignBlockId, r: number, g: number, b: number, a?: number): void;
+    /**
+     * Get the  drop shadow color of the given design block.
+     * @param id - The block whose background color should be queried.
+     * @returns The background color.
+     */
+    getDropShadowColorRGBA(id: DesignBlockId): RGBA;
+    /**
+     * Set the drop shadow's X offset of the given design block.
+     * @param id - The block whose drop shadow's X offset should be set.
+     * @param offsetX - The X offset to be set.
+     */
+    setDropShadowOffsetX(id: DesignBlockId, offsetX: number): void;
+    /**
+     * Get the drop shadow's X offset of the given design block.
+     * @param id - The block whose drop shadow's X offset should be queried.
+     * @returns The offset.
+     */
+    getDropShadowOffsetX(id: DesignBlockId): number;
+    /**
+     * Set the drop shadow's Y offset of the given design block.
+     * @param id - The block whose drop shadow's Y offset should be set.
+     * @param offsetY - The X offset to be set.
+     */
+    setDropShadowOffsetY(id: DesignBlockId, offsetY: number): void;
+    /**
+     * Get the drop shadow's Y offset of the given design block.
+     * @param id - The block whose drop shadow's Y offset should be queried.
+     * @returns The offset.
+     */
+    getDropShadowOffsetY(id: DesignBlockId): number;
+    /**
+     * Set the drop shadow's blur radius on the X axis of the given design block.
+     * @param id - The block whose drop shadow's blur radius should be set.
+     * @param blurRadiusX - The blur radius to be set.
+     */
+    setDropShadowBlurRadiusX(id: DesignBlockId, blurRadiusX: number): void;
+    /**
+     * Get the drop shadow's blur radius on the X axis of the given design block.
+     * @param id - The block whose drop shadow's blur radius should be queried.
+     * @returns The blur radius.
+     */
+    getDropShadowBlurRadiusX(id: DesignBlockId): number;
+    /**
+     * Set the drop shadow's blur radius on the Y axis of the given design block.
+     * @param id - The block whose drop shadow's blur radius should be set.
+     * @param blurRadiusY - The blur radius to be set.
+     */
+    setDropShadowBlurRadiusY(id: DesignBlockId, blurRadiusY: number): void;
+    /**
+     * Get the drop shadow's blur radius on the Y axis of the given design block.
+     * @param id - The block whose drop shadow's blur radius should be queried.
+     * @returns The blur radius.
+     */
+    getDropShadowBlurRadiusY(id: DesignBlockId): number;
+    /**
+     * Set the drop shadow's clipping of the given design block. (Only applies to shapes.)
+     * @param id - The block whose drop shadow's clip should be set.
+     * @param clip - The drop shadow's clip to be set.
+     */
+    setDropShadowClip(id: DesignBlockId, clip: boolean): void;
+    /**
+     * Get the drop shadow's clipping of the given design block.
+     * @param id - The block whose drop shadow's clipping should be queried.
+     * @returns The drop shadow's clipping.
+     */
+    getDropShadowClip(id: DesignBlockId): boolean;
+    /**
+     * Query if the given block has fill color properties.
+     * @param id - The block to query.
+     * @returns true, if the block has fill color properties, an error otherwise.
+     */
+    hasFill(id: DesignBlockId): boolean;
+    /**
+     * Query if the fill of the given design block is enabled.
+     * @param id - The block whose fill state should be queried.
+     * @returns A result holding the fill state or an error.
+     */
+    isFillEnabled(id: DesignBlockId): boolean;
+    /**
+     * Enable or disable the fill of the given design block.
+     * @param id - The block whose fill should be enabled or disabled.
+     * @param enabled - If true, the fill will be enabled.
+     * @returns An empty result on success, an error otherwise.
+     */
+    setFillEnabled(id: DesignBlockId, enabled: boolean): void;
+    /**
+     * Returns the block containing the fill properties of the given block.
+     * @param id - The block whose fill block should be returned.
+     * @returns The block that currently defines the given block's fill.
+     */
+    getFill(id: DesignBlockId): DesignBlockId;
+    /**
+     * Sets the block containing the fill properties of the given block.
+     * Note that the previous fill block is not destroyed automatically.
+     * @param id - The block whose fill should be changed.
+     * @param fill - The new fill.
+     */
+    setFill(id: DesignBlockId, fill: DesignBlockId): void;
+    /**
+     * Set the fill type of the given design block.
+     * @param id - The block whose fill type should be set.
+     * @param type - The fill type to set.
+     * @returns An empty result on success, an error otherwise.
+     */
+    setFillType(id: DesignBlockId, fillType: FillType): void;
+    /**
+     * Get the fill type of the given design block.
+     * @param id - The block whose fill type should be queried.
+     * @returns The block's fill type or an error.
+     */
+    getFillType(id: DesignBlockId): FillType;
+    /**
+     * Set the fill color of the given design block.
+     * @param id - The block whose fill color should be set.
+     * @param r - The red color component in the range of 0 to 1.
+     * @param g - The green color component in the range of 0 to 1.
+     * @param b - The blue color component in the range of 0 to 1.
+     * @param a - The alpha color component in the range of 0 to 1.
+     * @returns An empty result on success, an error otherwise.
+     */
+    setFillSolidColor(id: DesignBlockId, r: number, g: number, b: number, a?: number): void;
+    /**
+     * Get the fill color of the given design block.
+     * @param id - The block whose fill color should be queried.
+     * @returns A result holding the fill color or an error.
+     */
+    getFillSolidColor(id: DesignBlockId): RGBA;
+    /**
+     * Set the gradient type of the given design block.
+     * @param id - The block whose gradient type should be set.
+     * @param type - The gradient type.
+     * @returns An empty result on success, an error otherwise.
+     */
+    setFillGradientType(id: DesignBlockId, gradientType: GradientType): void;
+    /**
+     * Get the gradient type of the given design block.
+     * @param id - The block whose gradient type should be queried.
+     * @returns The gradient type.
+     */
+    getFillGradientType(id: DesignBlockId): GradientType;
+    /**
+     * Add a gradient color stop on a design block.
+     * @param id - The block on which a gradient color stop should be added.
+     * @param stop - Where to add a color stop in the range 0 to 1.
+     * @param r - The red color component in the range of 0 to 1.
+     * @param g - The green color component in the range of 0 to 1.
+     * @param b - The blue color component in the range of 0 to 1.
+     * @param a - The alpha color component in the range of 0 to 1.
+     * @returns An empty result on success, an error otherwise.
+     */
+    addFillGradientColorStop(id: DesignBlockId, stop: number, r: number, g: number, b: number, a?: number): void;
+    /**
+     * Remove a previously gradient color stop on a design block.
+     * @param id - The block from which to remove the gradient color stop.
+     * @param stop - The stop's position.
+     * @returns An empty result on success, an error otherwise.
+     */
+    removeFillGradientColorStop(id: DesignBlockId, stop: number): void;
+    /**
+     * Get the gradient fill color stops of the given design block.
+     * @param id - The block whose gradient color stop should be queried.
+     * @returns All of the design block's gradient color stops.
+     */
+    getFillGradientColorStops(id: DesignBlockId): GradientstopRGBA[];
+    /**
+     * Set the gradient fill color stops of the given design block, overwriting previously set color stops.
+     * @param id - The block whose gradient color stop should be set.
+     * @param stops - The gradient color stops to set.
+     * @returns An empty result on success, an error otherwise.
+     */
+    setFillGradientColorStops(id: DesignBlockId, stops: GradientstopRGBA[]): void;
+    /**
+     * Set the position of a gradient's control point.
+     * Note that Different gradient types of different control points.
+     * @param id - The block whose gradient control point should be set.
+     * @param gradientControlPointType - The type of control point.
+     * @param x - The horizontal component of the control point.
+     * @param y - The vertical component of the control point.
+     * @returns true if the control point was set, an error otherwise.
+     */
+    setFillGradientControlPoint(id: DesignBlockId, gradientControlPointType: GradientControlPointType, x: number, y: number): boolean;
+    /**
+     * Get the horizontal component of a gradient's control point.
+     * @param id - The block whose gradient control point should be queried.
+     * @param gradientControlPointType - The type of control point.
+     * @returns The horizontal component of the control point, an error otherwise.
+     */
+    getFillGradientControlPointX(id: DesignBlockId, gradientControlPointType: GradientControlPointType): number;
+    /**
+     * Get the vertical component of a gradient's control point.
+     * @param id - The block whose gradient control point should be queried.
+     * @param gradientControlPointType - The type of control point.
+     * @returns The vertical component of the control point, an error otherwise.
+     */
+    getFillGradientControlPointY(id: DesignBlockId, gradientControlPointType: GradientControlPointType): number;
+    /**
+     * Set a gradient's radius.
+     * Note that Not all gradients have a radius.
+     * @param id - The block whose gradient radius should be set.
+     * @param radius - The gradient's radius.
+     * @returns true if the control point was set, an error otherwise.
+     */
+    setFillGradientRadius(id: DesignBlockId, radius: number): boolean;
+    /**
+     * Get a gradient's radius.
+     * Note that Not all gradients have a radius.
+     * @param id - The block whose gradient radius should be queried.
+     * @returns the gradient's radius, an error otherwise.
+     */
+    getFillGradientRadius(id: DesignBlockId): number;
+    /**
+     * Enable or disable the placeholder function for a block.
+     * @param id - The block whose placeholder function should be enabled or disabled.
+     * @param enabled - Whether the function should be enabled or disabled.
+     */
+    setPlaceholderEnabled(id: DesignBlockId, enabled: boolean): void;
+    /**
+     * Query whether the placeholder function for a block is enabled.
+     * @param id - The block whose placeholder function state should be queried.
+     * @returns the enabled state of the placeholder function.
+     */
+    isPlaceholderEnabled(id: DesignBlockId): boolean;
+    /**
+     * Query if the given block shows placeholder content.
+     * @param id - The block to query.
+     * @returns true, if the block shows placeholder content.
+     */
+    showsPlaceholderContent(id: DesignBlockId): boolean;
+    /**
+     * Set a metadata value of a block identified by a key.
+     * If the key does not exist, yet, it will be added.
+     * @param id - The block whose metadata will be accessed.
+     * @param key - The key used to identify the desired piece of metadata.
+     * @param value - The value to set.
+     */
+    setMetadata(id: DesignBlockId, key: string, value: string): void;
+    /**
+     * Get a metadata value of a block identified by a key.
+     * If the key does not exist, yet, this method will fail.
+     * @param id - The block whose metadata will be accessed.
+     * @param key - The key used to identify the desired piece of metadata.
+     * @returns the value associated with the key.
+     */
+    getMetadata(id: DesignBlockId, key: string): string;
+    /**
+     * Check if the block has metadata associated with the key.
+     * @param id - The block whose metadata will be accessed.
+     * @param key - The key used to identify the desired piece of metadata.
+     * @returns whether the key exists.
+     */
+    hasMetadata(id: DesignBlockId, key: string): boolean;
+    /**
+     * Remove metadata associated with the key from the given block.
+     * If the key does not exist, this method will fail.
+     * @param id - The block whose metadata will be accessed.
+     * @param key - The key used to identify the desired piece of metadata.
+     */
+    removeMetadata(id: DesignBlockId, key: string): void;
+    /**
+     * Enable or disable a scope for a given block.
+     * @param id - The block whose scope should be enabled or disabled.
+     * @param key - The scope to enable or disable.
+     * @param enabled - Whether the scope should be enabled or disabled.
+     */
+    setScopeEnabled(id: DesignBlockId, key: string, enabled: boolean): void;
+    /**
+     * Query whether a scope is enabled for a given block.
+     * @param id - The block whose scope state should be queried.
+     * @param key - The scope to query.
+     * @returns the enabled state of the scope for the given block.
+     */
+    isScopeEnabled(id: DesignBlockId, key: string): boolean;
+    /**
+     * Check if a scope is allowed for a given block.
+     * @param id - The block to check.
+     * @param key - The scope to check.
+     * @returns whether the scope is allowed for the given block.
+     */
+    isAllowedByScope(id: DesignBlockId, key: string): boolean;
+}
+
+/**
+ * @public
+ */
+export declare type BlockEvent = {
+    block: DesignBlockId;
+    type: 'Created' | 'Updated' | 'Destroyed';
+};
+
+/** @public */
+declare interface BlockEvent_2 {
+    block: Block;
+    type: 'Created' | 'Updated' | 'Destroyed';
+}
+
+/**
+ * Dispatched on the engine canvas when the text input has been blurred.
+ * Call `preventDefault()` to disallow this and refocus the engine text input.
+ * @public
+ */
+export declare interface BlurEvent extends CustomEvent<EventTarget | null> {
+    readonly type: 'cesdk-blur';
+    /** Contains the element that has received focus during the blur, or null */
+    readonly detail: EventTarget | null;
+    /** Force focus back to the engine input */
+    preventDefault(): void;
+}
+
+/** @public */
+declare type Callbacks = {
+    log?: Logger;
+};
+
+/**
+ * All components between 0 and 1
+ * @public
+ */
+export declare interface CMYKColor {
+    c: number;
+    m: number;
+    y: number;
+    k: number;
+}
+
+/**
+ * A color definition for the custom color palette.
+ * The RGB and CMYK components must all be specified in the range [0-1].
+ * @public
+ */
+declare type Color_2 = HexColorString | RGBColor | RGBAColor | SpotColor;
+
+/** @public */
+declare type ColorDefinition = Preset & {
+    value: Color_2;
+};
+
+/** @public */
+declare type ColorPaletteDefinition = Preset & {
+    entries: Color_2[];
+};
+
+declare namespace ConfigTypes {
+    export {
+        HexColorString,
+        Color_2 as Color,
+        AssetSources,
+        AssetSource_2 as AssetSource,
+        AssetResult_2 as AssetResult,
+        AssetsQueryResult_2 as AssetsQueryResult,
+        QueryData,
+        Preset,
+        VariableDefinition,
+        ColorDefinition,
+        ColorPaletteDefinition,
+        PageFormatDefinition,
+        TemplateDefinition,
+        TypefaceDefinition,
+        ImageDefinition,
+        Presets,
+        Variables,
+        Core,
+        Extensions,
+        Scene,
+        Page,
+        Callbacks
+    }
+}
+export { ConfigTypes }
+
+/** @public */
+export declare interface Configuration {
+    baseURL: string;
+    license?: string;
+    role: RoleString;
+    featureFlags?: Record<string, string | boolean>;
+    extensions: ConfigTypes.Extensions;
+    core: ConfigTypes.Core;
+    scene: ConfigTypes.Scene;
+    page: ConfigTypes.Page;
+    assetSources: ConfigTypes.AssetSources;
+    presets: ConfigTypes.Presets;
+    variables: ConfigTypes.Variables;
+    callbacks: ConfigTypes.Callbacks;
+    /**
+     * The default font used by a text added to the scene. Needs to be the id of
+     * the font from a extension pack including namespace, e.g.
+     *
+     * '//ly.img.cesdk.fonts/roboto_regular'
+     *
+     * If not configured the fallback font is used.
+     */
+    defaultFont?: string;
+}
+
+/**
+ * - Crop: Manual crop.
+ * - Cover: Automatically cover the entire frame.
+ * - Contain: Automatically contain content inside frame.
+ *
+ * @public
+ */
+export declare type ContentFillMode = 'Crop' | 'Cover' | 'Contain';
+
+/** @public */
+declare type Core = {
+    baseURL: string;
+};
+
+/**
+ * A headless implementation that just initializes & exposes the Document API
+ *
+ * @public
+ */
+declare class CreativeEngine {
+    #private;
+    asset: AssetAPI;
+    block: BlockAPI;
+    editor: EditorAPI;
+    event: EventAPI;
+    scene: SceneAPI;
+    variable: VariableAPI;
+
+    /**
+     * Dispose the engine.
+     */
+    dispose(): void;
+    /**
+     * Initialize a `CreativeEngine` using the given `canvas` element and an optional config.
+     * @param config - A configuration object.
+     * @param canvas - The canvas to use for drawing. Optional, if no canvas is provided,
+     *                 the engine works with an internal offscreen-canvas.
+     * @returns An engine instance.
+     */
+    static init(config?: Partial<Configuration>, canvas?: HTMLCanvasElement | OffscreenCanvas): Promise<CreativeEngine>;
+}
+export default CreativeEngine;
+
+/**
+ * A numerical identifier for a design block
+ * @public
+ */
+export declare type DesignBlockId = number;
+
+/**
+ * @public
+ */
+export declare enum DesignBlockType {
+    Scene = "//ly.img.ubq/scene",
+    Stack = "//ly.img.ubq/stack",
+    Camera = "//ly.img.ubq/camera",
+    Page = "//ly.img.ubq/page",
+    Image = "//ly.img.ubq/image",
+    Video = "//ly.img.ubq/video",
+    Text = "//ly.img.ubq/text",
+    Sticker = "//ly.img.ubq/sticker",
+    VectorPath = "//ly.img.ubq/vector_path",
+    RectShape = "//ly.img.ubq/shapes/rect",
+    LineShape = "//ly.img.ubq/shapes/line",
+    StarShape = "//ly.img.ubq/shapes/star",
+    PolygonShape = "//ly.img.ubq/shapes/polygon",
+    EllipseShape = "//ly.img.ubq/shapes/ellipse",
+    Group = "//ly.img.ubq/group"
+}
+
+/** @public */
+export declare type DesignUnit = 'mm' | 'px' | 'in';
+
+/**
+ * @public
+ */
+export declare class EditorAPI {
+    #private;
+
+    /**
+     * Subscribe to changes to the editor state.
+     * @param callback - This function is called at the end of the engine update, if the editor state has changed.
+     * @returns A method to unsubscribe.
+     */
+    onStateChanged(callback: () => void): () => void;
+    /**
+     * Set the edit mode of the editor.
+     * An edit mode defines what type of content can currently be edited by the user.
+     * Hint: the initial edit mode is "Transform".
+     * @param mode - "Transform", "Crop", "Text", or a custom value.
+     */
+    setEditMode(mode: 'Transform' | 'Crop' | 'Text' | string): void;
+    /**
+     * Get the current edit mode of the editor.
+     * An edit mode defines what type of content can currently be edited by the user.
+     * @returns "Transform", "Crop", "Text", or a custom value.
+     */
+    getEditMode(): 'Transform' | 'Crop' | 'Text' | string;
+    /**
+     * Get the type of cursor that should be displayed by the application.
+     * @returns The cursor type.
+     */
+    getCursorType(): 'Arrow' | 'Move' | 'MoveNotPermitted' | 'Resize' | 'Rotate' | 'Text';
+    /**
+     * Get the rotation with which to render the mouse cursor.
+     * @returns The angle in radians.
+     */
+    getCursorRotation(): number;
+    /**
+     * Get the current text cursor's x position in screen space.
+     * @returns The text cursor's x position in screen space.
+     */
+    getTextCursorPositionInScreenSpaceX(): number;
+    /**
+     * Get the current text cursor's y position in screen space.
+     * @returns The text cursor's y position in screen space.
+     */
+    getTextCursorPositionInScreenSpaceY(): number;
+    /**
+     * Adds a new history state to the stack, if undoable changes were made.
+     */
+    addUndoStep(): void;
+    /**
+     * Undo one step in the history if an undo step is available.
+     */
+    undo(): void;
+    /**
+     * Redo one step in the history if a redo step is available.
+     */
+    redo(): void;
+    /**
+     * If an undo step is available.
+     *
+     * @returns True if an undo step is available.
+     */
+    canUndo(): boolean;
+    /**
+     * If a redo step is available.
+     *
+     * @returns True if a redo step is available.
+     */
+    canRedo(): boolean;
+    /**
+     * Subscribe to changes to the editor settings.
+     * @param callback - This function is called at the end of the engine update, if the editor settings have changed.
+     * @returns A method to unsubscribe.
+     */
+    onSettingsChanged(callback: () => void): () => void;
+    /**
+     * Set a boolean setting.
+     * @param keypath - The settings keypath, e.g. `ubq://doubleClickToCropEnabled`
+     * @param value - The value to set.
+     * @throws An error, if the keypath is invalid.
+     */
+    setSettingBool(keypath: string, value: boolean): void;
+    /**
+     * Get a boolean setting.
+     * @param keypath - The settings keypath, e.g. `ubq://doubleClickToCropEnabled`
+     * @throws An error, if the keypath is invalid.
+     */
+    getSettingBool(keypath: string): boolean;
+    /**
+     * Set an integer setting.
+     * @param keypath - The settings keypath.
+     * @param value - The value to set.
+     * @throws An error, if the keypath is invalid.
+     */
+    setSettingInt(keypath: string, value: number): void;
+    /**
+     * Get an integer setting.
+     * @param keypath - The settings keypath.
+     * @throws An error, if the keypath is invalid.
+     */
+    getSettingInt(keypath: string): number;
+    /**
+     * Set a float setting.
+     * @param keypath - The settings keypath, e.g. `ubq://positionSnappingThreshold`
+     * @param value - The value to set.
+     * @throws An error, if the keypath is invalid.
+     */
+    setSettingFloat(keypath: string, value: number): void;
+    /**
+     * Get a float setting.
+     * @param keypath - The settings keypath, e.g. `ubq://positionSnappingThreshold`
+     * @throws An error, if the keypath is invalid.
+     */
+    getSettingFloat(keypath: string): number;
+    /**
+     * Set a string setting.
+     * @param keypath - The settings keypath, e.g. `ubq://license`
+     * @param value - The value to set.
+     * @throws An error, if the keypath is invalid.
+     */
+    setSettingString(keypath: string, value: string): void;
+    /**
+     * Get a string setting.
+     * @param keypath - The settings keypath, e.g. `ubq://license`
+     * @throws An error, if the keypath is invalid.
+     */
+    getSettingString(keypath: string): string;
+    /**
+     * Set a color setting.
+     * @param keypath - The settings keypath, e.g. `ubq://highlightColor`.
+     * @param r - The red color component in the range of 0 to 1.
+     * @param g - The green color component in the range of 0 to 1.
+     * @param b - The blue color component in the range of 0 to 1.
+     * @param a - The alpha color component in the range of 0 to 1.
+     */
+    setSettingColorRGBA(keypath: string, r: number, g: number, b: number, a?: number): void;
+    /**
+     * Get a color setting.
+     * @param keypath - The settings keypath, e.g. `ubq://highlightColor`.
+     * @returns A tuple of channels red, green, blue and alpha in the range of 0 to 1.
+     */
+    getSettingColorRGBA(keypath: string): RGBA;
+    /**
+     * Set an enum setting.
+     * @param keypath - The settings keypath, e.g. `ubq://role`.
+     * @param value - The enum value as string.
+     */
+    setSettingEnum(keypath: string, value: string): void;
+    /**
+     * Get an enum setting.
+     * @param keypath - The settings keypath, e.g. `ubq://role`.
+     * @returns The value as string.
+     */
+    getSettingEnum(keypath: string): string;
+    /**
+     * Sets a custom URI resolver.
+     * This function can be called more than once. Subsequent calls will overwrite previous calls.
+     * To remove a previously set resolver, pass the value `null`.
+     * The given function must return an absolute path with a scheme.
+     * @param resolver - Custom resolution function.
+     */
+    setURIResolver(resolver: (URI: string) => string): void;
+    /**
+     * Resolves the given path.
+     * If a custom resolver has been set with `setURIResolver`, it invokes it with the given path.
+     * Else, it resolves it as relative to the `ubq://basePath` setting.
+     * This performs NO validation of whether a file exists at the specified location.
+     * @param relativePath - A relative path string
+     * @returns The resolved absolute uri or an error if an invalid path was given.
+     */
+    getAbsoluteURI(relativePath: string): string;
+    /**
+     * Set a scope to be globally allowed, denied, or deferred to the block-level.
+     * @param key - The scope to set.
+     * @param value - `Allow` will always allow the scope, `Deny` will always deny the scope, and `Defer` will defer to the block-level.
+     */
+    setGlobalScope(key: string, value: 'Allow' | 'Deny' | 'Defer'): void;
+    /**
+     * Query the state of a global scope.
+     * @param key - The scope to query.
+     * @returns `Allow` if the scope is allowed, `Deny` if it is disallowed, and `Defer` if it is deferred to the block-level.
+     */
+    getGlobalScope(key: string): 'Allow' | 'Deny' | 'Defer';
+}
+
+/**
+ * @public
+ */
+export declare class EventAPI {
+    #private;
+
+    /**
+     * Subscribe to block life-cycle events.
+     * @param blocks - A list of blocks to filter events by. If the list is empty, events for every block are sent.
+     * @param callback - The event callback. Events are bundled and sent at the end of each engine update.
+     * @returns A method to unsubscribe.
+     */
+    subscribe(blocks: DesignBlockId[], callback: (events: BlockEvent[]) => void): () => void;
+}
+
+/**
+ * @public
+ */
+export declare type ExportOptions = {
+    /**
+     * The PNG compression level to use, when exporting to PNG.
+     *
+     * Valid values are 0 to 9, higher means smaller, but slower.
+     * Quality is not affected.
+     * Ignored for other encodings.
+     * @defaultValue 5.
+     */
+    pngCompressionLevel?: number;
+    /**
+     * The JPEG quality to use when encoding to JPEG.
+     *
+     * Valid values are (0-1], higher means better quality.
+     * Ignored for other encodings.
+     *
+     * @defaultValue 0.9
+     */
+    jpegQuality?: number;
+    /**
+     * An optional target width used in conjunction with target height.
+     * If used, the block will be rendered large enough, that it fills the target
+     * size entirely while maintaining its aspect ratio.
+     */
+    targetWidth?: number;
+    /**
+     * An optional target height used in conjunction with target width.
+     * If used, the block will be rendered large enough, that it fills the target
+     * size entirely while maintaining its aspect ratio.
+     */
+    targetHeight?: number;
+};
+
+/** @public */
+declare interface ExportOptions_2 {
+    jpegQuality: number;
+    pngCompressionLevel: number;
+    useTargetSize: boolean;
+    targetWidth: number;
+    targetHeight: number;
+}
+
+/** @public */
+declare interface ExportVideoOptions {
+    h264Profile: number;
+    h264Level: number;
+    framerate: number;
+    useTargetSize: boolean;
+    targetWidth: number;
+    targetHeight: number;
+}
+
+/** @public */
+declare type Extensions = {
+    baseURL: string;
+    entries: string[];
+};
+
+/**
+ * @public
+ */
+export declare type FillType = 'Solid' | 'Gradient';
+
+/** @public */
+declare interface FindAssetsQuery {
+    perPage: number;
+    page: number;
+    query: string;
+    tags: string[];
+    groups: string[];
+    excludeGroups: string[];
+    locale: string;
+}
+
+/** @public */
+declare interface Flip {
+    horizontal: boolean;
+    vertical: boolean;
+}
+
+/** @public */
+export declare type FontStyle = 'normal' | 'italic';
+
+/** @public */
+export declare type FontWeight = 'thin' | 'extraLight' | 'Light' | 'normal' | 'medium' | 'semiBold' | 'bold' | 'extraBold' | 'heavy';
+
+/**
+ * @public
+ */
+export declare type GradientControlPointType = 'Start' | 'End' | 'Center';
+
+/**
+ * @public
+ */
+export declare type GradientstopRGBA = [
+stop: number,
+r: number,
+g: number,
+b: number,
+a: number
+];
+
+/**
+ * @public
+ */
+export declare type GradientType = 'Linear' | 'Radial' | 'Conical';
+
+/**
+ * An asset can be member of multiple groups. Groups have a semantic meaning
+ * used to build and group UIs exploring the assets, e.g.sections in the
+ * content library, or for things like topics in Unsplash for instance.
+ *
+ * Tags in comparison have are more loosely hold meaning used for extended
+ * searching/filtering.
+ * @public
+ */
+declare type Groups = string[];
+
+/**
+ * A hexadecimal color value (RGB or RGBA) that starts with a '#'
+ * @example #6686FF or #6686FFFF
+ * @public
+ */
+declare type HexColorString = string;
+
+/** @public */
+declare type ImageDefinition = Preset & {
+    imageURL: string;
+    thumbnailURL?: string;
+    width: number;
+    height: number;
+    levelOfDetail?: {
+        [lod: number]: string;
+    };
+};
+
+/**
+ * e.g. `en`, `de`, etc.
+ * @public
+ */
+declare type Locale = string;
+
+/** @public */
+export declare type Logger = (message: string, level: LogLevel) => void;
+
+/** @public */
+export declare enum LogLevel {
+    Info = "Info",
+    Warning = "Warning",
+    Error = "Error"
+}
+
+/** @public */
+declare enum MimeType_2 {
+    Png = "image/png",
+    Jpeg = "image/jpeg",
+    Tga = "image/x-tga",
+    Mp4 = "video/mp4",
+    Binary = "application/octet-stream",
+    Pdf = "application/pdf",
+    Zip = "application/zip"
+}
+export { MimeType_2 as MimeType }
+
+/** @public */
+declare type Page = {
+    title: {
+        /**
+         * Whether newly created pages should show a title.
+         */
+        show?: boolean;
+        /**
+         * The font file to use to render the page titles.
+         */
+        fontFileUri?: string;
+    };
+    /**
+     * Whether the opacity of the region outside of all
+     * pages should be reduced.
+     */
+    dimOutOfPageAreas?: boolean;
+};
+
+/** @public */
+declare type PageFormatDefinition = Preset & {
+    width: number;
+    height: number;
+    unit: DesignUnit;
+    dpi?: number;
+    bleedMargin?: number;
+};
+
+/**
+ * - Absolute: Position in absolute design units.
+ * - Percent: Position in relation to the block's parent's size in percent, where 1.0 means 100%.
+ * - Auto: Position is automatically determined
+ *
+ * @public
+ */
+export declare type PositionMode = 'Absolute' | 'Percent' | 'Auto';
+
+/** @public */
+declare type Preset = {
+    meta?: {
+        default?: boolean;
+        library?: string;
+        categories?: string[];
+    };
+};
+
+/** @public */
+declare type Presets = {
+    colors?: {
+        [id: string]: ColorDefinition;
+    };
+    typefaces?: {
+        [id: string]: TypefaceDefinition;
+    };
+    images?: {
+        [id: string]: ImageDefinition;
+    };
+    pageFormats?: {
+        [id: string]: PageFormatDefinition;
+    };
+    colorPalettes?: {
+        [id: string]: ColorPaletteDefinition;
+    };
+    templates?: {
+        [id: string]: TemplateDefinition;
+    };
+};
+
+/** @public */
+export declare type PropertyType = 'Bool' | 'Int' | 'Float' | 'String' | 'Color' | 'Enum' | 'Struct';
+
+/** @public */
+declare interface QueryData {
+    /** A query string used for (fuzzy) searching of labels and tags */
+    query?: string;
+    /**
+     * The number of results queried. How many assets shall be returned regardless
+     * of the total number of assets available.
+     *
+     * Together with `page` this can be used for pagination.
+     */
+    perPage: number;
+    /** The current page queried for paginated views. */
+    page: number;
+}
+
+/**
+ * Dispatched on the engine canvas right before the engine will refocus its text
+ * input after a blur. Call `preventDefault()` to prevent the refocusing.
+ * @public
+ */
+export declare interface RefocusEvent extends CustomEvent<EventTarget | null> {
+    readonly type: 'cesdk-refocus';
+    /** Contains the element that has received focus during the blur, or null */
+    readonly detail: EventTarget | null;
+    /** Prevent refocusing the engine input */
+    preventDefault(): void;
+}
+
+/**
+ * @public
+ */
+export declare type RGBA = [r: number, g: number, b: number, a: number];
+
+/**
+ * All components between 0 and 1
+ * @public
+ */
+export declare interface RGBAColor {
+    r: number;
+    g: number;
+    b: number;
+    a: number;
+}
+
+/**
+ * All components between 0 and 1
+ * @public
+ */
+export declare interface RGBColor {
+    r: number;
+    g: number;
+    b: number;
+}
+
+/** @public */
+export declare type RoleString = 'Creator' | 'Adopter' | 'Viewer' | 'Presenter';
+
+/**
+ * Export Settings
+ * @public
+ */
+declare type Scene = {
+    maskSpotColor?: SpotColor;
+    /**
+     * The DPI value to use when exporting and when converting between pixels and inches or millimeter units.
+     * (In the CESDK, this value is synonymous with PPI).
+     *
+     * This is only relevant for new scenes that are created in the editor. Loaded scenes will use the
+     * value stored in their serialization file.
+     */
+    dpi: number;
+    /**
+     * A scale factor that is applied to the final export resolution.
+     *
+     * This is only relevant for new scenes that are created in the editor. Loaded scenes will use the
+     * value stored in their serialization file.
+     */
+    pixelScaleFactor: number;
+};
+
+/**
+ * @public
+ */
+export declare class SceneAPI {
+    #private;
+
+    /**
+     * Load the contents of a scene file.
+     * @param sceneContent - The scene file contents, a base64 string.
+     * @returns A handle to the loaded scene.
+     */
+    loadFromString(sceneContent: string): Promise<DesignBlockId>;
+    /**
+     * Load a scene from the URL to the scene file.
+     * The scene file will be fetched asynchronously by the engine. This requires continuous `render`
+     * calls on this engines instance.
+     * @param url - The URL of the scene file.
+     * @returns scene A promise that resolves once the scene was loaded or rejects with an error otherwise.
+     */
+    loadFromURL(url: string): Promise<DesignBlockId>;
+    /**
+     * Serializes the current scene into a string. Selection is discarded.
+     * @returns A promise that resolves with a string on success or an error on failure.
+     */
+    saveToString(): Promise<string>;
+    /**
+     * Saves the current scene and all of its referenced assets into an archive.
+     * The archive contains all assets, that were accessible when this function was called.
+     * Blocks in the archived scene reference assets relative from to the location of the scene
+     * file. These references are resolved when loading such a scene via `loadSceneFromURL`.
+     *
+     * @returns A promise that resolves with a Blob on success or an error on failure.
+     */
+    saveToArchive(): Promise<Blob>;
+    /**
+     * Create a new scene, along with its own camera.
+     * @returns The scenes handle.
+     */
+    create(): DesignBlockId;
+    /**
+     * Loads the given image and creates a scene with a single page showing the image.
+     * Fetching the image may take an arbitrary amount of time, so the scene isn't immediately
+     * available.
+     * @param url - The image URL.
+     * @param dpi - The scenes DPI.
+     * @param pixelScaleFactor - The displays pixel scale factor.
+     * @returns A promise that resolves with the scene ID on success or rejected with an error otherwise.
+     */
+    createFromImage(url: string, dpi?: number, pixelScaleFactor?: number): Promise<DesignBlockId>;
+    /**
+     * Return the currently active scene.
+     * @returns The scene or null, if none was created yet.
+     */
+    get(): DesignBlockId | null;
+    /**
+     * Applies the contents of the given template scene to the currently loaded scene.
+     * This loads the template scene while keeping the design unit and page dimensions
+     * of the current scene. Page contents remain centered when the pages are resized
+     * to fit the new dimensions.
+     * @param content - The template scene file contents, a base64 string.
+     * @returns A Promise that resolves once the template was applied or rejects if there was an error.
+     */
+    applyTemplateFromString(content: string): Promise<void>;
+    /**
+     * Applies the contents of the given template scene to the currently loaded scene.
+     * This loads the template scene while keeping the design unit and page dimensions
+     * of the current scene. Page contents remain centered when the pages are resized
+     * to fit the new dimensions.
+     * @param url - The url to the template scene file.
+     * @returns A Promise that resolves once the template was applied or rejects if there was an error.
+     */
+    applyTemplateFromURL(url: string): Promise<void>;
+    /**
+     * Sets the zoom level of the active scene.
+     * Only has an effect if the zoom level is not handled by the UI.
+     *
+     * @param zoomLevel - The new zoom level.
+     */
+    setZoomLevel(zoomLevel?: number): void;
+    /**
+     * Query a camera zoom level of the active scene.
+     * @returns The zoom level of the block's camera.
+     */
+    getZoomLevel(): number;
+    /**
+     * Sets the zoom and focus to show a block.
+     * Only has an effect if the zoom level is not handled by the UI.
+     * Without padding, this results in a tight view on the block.
+     *
+     * @param id - The block that should be focused on.
+     * @param paddingLeft - Optional padding in screen pixels to the left of the block.
+     * @param paddingTop - Optional padding in screen pixels to the top of the block.
+     * @param paddingRight - Optional padding in screen pixels to the right of the block.
+     * @param paddingBottom - Optional padding in screen pixels to the bottom of the block.
+     * @returns A promise that resolves once the zoom was set or rejects with an error otherwise.
+     */
+    zoomToBlock(id: DesignBlockId, paddingLeft?: number, paddingTop?: number, paddingRight?: number, paddingBottom?: number): Promise<void>;
+    /**
+     * Converts all values of the current scene into the given design unit.
+     * @param designUnit - The new design unit of the scene
+     */
+    unstable_setDesignUnit(designUnit: DesignUnit): void;
+    /**
+     * Returns the design unit of the current scene.
+     * @returns The current design unit.
+     */
+    unstable_getDesignUnit(): DesignUnit;
+}
+
+/** @public */
+export declare interface Size2 {
+    width: number;
+    height: number;
+}
+
+/**
+ * - Absolute: Size in absolute design units.
+ * - Percent: Size in relation to the block's parent's size in percent, where 1.0 means 100%.
+ * - Auto: Size is automatically determined
+ *
+ * @public
+ */
+export declare type SizeMode = 'Absolute' | 'Percent' | 'Auto';
+
+/** @public */
+export declare interface SpotColor {
+    name: string;
+    rgbApproximation: RGBAColor;
+    cmykApproximation: CMYKColor;
+}
+
+/** @public */
+export declare type StrokeCornerGeometry = 'Bevel' | 'Miter' | 'Round';
+
+/**  @public */
+export declare type StrokePosition = 'Center' | 'Inner' | 'Outer';
+
+/**  @public */
+export declare type StrokeStyle = 'Dashed' | 'DashedRound' | 'Dotted' | 'LongDashed' | 'LongDashedRound' | 'Solid';
+
+/** @public */
+declare type Subscription = number;
+
+/** @public */
+declare type TemplateDefinition = Preset & {
+    label: string;
+    scene: string | URL | (() => Promise<string>);
+    thumbnailURL?: string | URL;
+};
+
+/** @public */
+declare type TypefaceDefinition = Preset & {
+    family: string;
+    fonts: {
+        fontURL: string;
+        weight: FontWeight;
+        style: FontStyle;
+    }[];
+};
+
+/**
+ * @public
+ */
+export declare class VariableAPI {
+    #private;
+
+    /**
+     * Get all text variables currently stored in the engine.
+     * @returns Return a list of variable names
+     */
+    findAll(): string[];
+    /**
+     * Set a text variable.
+     * @param key - The variable's key.
+     * @param value - The text to replace the variable with.
+     */
+    setString(key: string, value: string): void;
+    /**
+     * Set a text variable.
+     * @param key - The variable's key.
+     * @returns  The text value of the variable.
+     */
+    getString(key: string): string;
+    /**
+     * Destroy a text variable.
+     * @param key - The variable's key.
+     */
+    remove(key: string): void;
+}
+
+/** @public */
+declare type VariableDefinition = Preset & {
+    value: string | number;
+};
+
+/** @public */
+declare type Variables = {
+    [id: string]: VariableDefinition;
+};
+
+/** @public */
+export declare interface Vec2 {
+    x: number;
+    y: number;
+}
+
+/** @public */
+export declare interface Vec3 {
+    x: number;
+    y: number;
+    z: number;
+}
+
+/** @public */
+export declare interface Vec4 {
+    x: number;
+    y: number;
+    z: number;
+    w: number;
+}
+
+export { }