@cesdk/cesdk-js 1.4.5 → 1.5.0

package/cesdk-engine.umd.d.ts

@@ -1,38 +1,1494 @@
-import BlockAPI, { PropertyType } from './BlockAPI';
-import SceneAPI from './SceneAPI';
-import VariableAPI from './VariableAPI';
-import { UserConfiguration } from './types';
-
-export { PropertyType };
-
-/**
- * A headless implementation that just initializes & exposes the Document API
- */
-export default class CreativeEngine {
-  static PropertyType: typeof PropertyType;
-
-  block: BlockAPI;
-
-  scene: SceneAPI;
-
-  variable: VariableAPI;
-
-  private constructor(...args: unknown[]);
-
-  /**
-   * 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?: UserConfiguration,
-    canvas?: HTMLCanvasElement
-  ): Promise<CreativeEngine>;
-}
+declare type Asset = {
+    src: string;
+};
+
+/**
+ * Single asset result of a query from the engine.
+ */
+declare interface AssetResult {
+    /**
+     *  A unique id of this asset
+     */
+    id: string;
+    /**
+     *  E.g. `ly.img.image`
+     */
+    type: 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;
+    };
+}
+
+declare type Assets = {
+    [id: string]: Asset;
+};
+
+/**
+ * API to query for assets
+ */
+declare interface AssetSource {
+    /**
+     * The asset types returned by this source. Will default to ['ly.img.image'].
+     */
+    types?: string[];
+    /**
+     * Find all asset for the given type and the provided query data.
+     */
+    findAssets(type: string, queryData?: QueryData): Promise<AssetsQueryResult | undefined>;
+    /**
+     * 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>;
+    /**
+     * Credits for the source/api
+     */
+    credits?: {
+        name: string;
+        url?: string;
+    };
+    /**
+     * General license for all asset from this source
+     */
+    license?: {
+        name: string;
+        url?: string;
+    };
+}
+
+declare type AssetSources = {
+    [id: string]: AssetSource;
+};
+
+/**
+ * Return type of a `findAssets` query.
+ */
+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 | undefined;
+    /**
+     * How many assets are there in total for the current query regardless of the page
+     */
+    total: number;
+}
+
+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.
+     * @returns A promise that resolves with the exported image or is rejected with an error.
+     */
+    export(handle: DesignBlockId, mimeType?: MimeType_2): 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: DesignElementType): 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): DesignElementType;
+    /**
+     * 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: DesignElementType): DesignBlockId[];
+    /**
+     * Return all blocks currently known to the engine.
+     * @returns A list of block ids.
+     */
+    findAll(): 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 horizontal - Whether the block should be flipped along its x-axis.
+     */
+    setFlipHorizontal(id: DesignBlockId, flip: boolean): void;
+    /**
+     * Update a block's vertical flip.
+     * @param id - The block to update.
+     * @param vertical - Whether the block should be flipped along its y-axis.
+     */
+    setFlipVertical(id: DesignBlockId, flip: boolean): void;
+    /**
+     * 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;
+    /**
+     * 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;
+    /**
+     * Get a block's layouted width. The layouted width is only available after an
+     * internal update loop, which may not happen immediately.
+     * @param id - The block to query.
+     * @returns The layouted width.
+     */
+    getFrameWidth(id: DesignBlockId): number;
+    /**
+     * Get a block's layouted height. The layouted height is only available after an
+     * internal update loop, which may not happen immediately.
+     * @param id - The block to query.
+     * @returns The layouted 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.
+     */
+    getParent(id: DesignBlockId): DesignBlockId;
+    /**
+     * 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;
+    /**
+     * 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 block - 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 block - 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 translation in x direction of the given design block.
+     * @param id - The block whose crop should be set.
+     * @param translationY - The translation in x 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 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;
+    /**
+     * Query if the given block has an opacity.
+     * @param id - The block to query.
+     * @returns true, if the block has an opcity.
+     */
+    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 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;
+    /**
+     * 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;
+}
+
+/**
+ * @public
+ */
+export declare type BlockEvent = {
+    block: DesignBlockId;
+    type: 'Created' | 'Updated' | 'Destroyed';
+};
+
+declare interface BlockEvent_2 {
+    block: Block;
+    type: 'Created' | 'Updated' | 'Destroyed';
+}
+
+declare type Callbacks = {
+    log?: Logger;
+};
+
+/** All components between 0 and 1 */
+declare interface CMYKColor {
+    c: number;
+    m: number;
+    y: number;
+    k: number;
+}
+
+declare type ColorDefinition = Preset & {
+    value: ColorPaletteColor;
+};
+
+/**
+ * A color definition for the custom color palette.
+ * The RGB and CMYK components must all be specified in the range [0-1].
+ */
+declare type ColorPaletteColor = HexColorString | RGBColor | RGBAColor | SpotColor;
+
+declare type ColorPaletteDefinition = Preset & {
+    entries: ColorPaletteColor[];
+};
+
+declare type Command = {
+    identifier: string;
+    argumentTypes: string[];
+    returnType: string;
+};
+
+/**
+ * @public
+ */
+export declare type Configuration = Partial<_Configuration>;
+
+/**
+ * @public
+ */
+export declare interface _Configuration {
+    baseURL: string;
+    license?: string;
+    role: string;
+    featureFlags?: Record<string, string | boolean>;
+    extensions: Extensions;
+    core: Core;
+    scene: Scene;
+    page: Page;
+    assets: Assets;
+    assetSources: AssetSources;
+    presets: Presets;
+    variables: Variables;
+    callbacks: 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;
+}
+
+declare type Core = {
+    baseURL: string;
+};
+
+declare interface CreateSceneOptions {
+    layout: SceneLayout;
+}
+
+/**
+ * A headless implementation that just initializes & exposes the Document API
+ *
+ * @public
+ */
+declare class CreativeEngine {
+    #private;
+    static PositionMode: typeof PositionMode;
+    static SizeMode: typeof SizeMode;
+    static PropertyType: typeof PropertyType;
+    block: BlockAPI;
+    scene: SceneAPI;
+    variable: VariableAPI;
+
+    event: EventAPI;
+
+    /**
+     * 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?: Configuration, canvas?: HTMLCanvasElement): Promise<CreativeEngine>;
+}
+export default CreativeEngine;
+
+/**
+ * A numerical identifier for a design block
+ * @public
+ */
+export declare type DesignBlockId = number;
+
+/**
+ * @public
+ */
+export declare enum DesignElementType {
+    Scene = "//ly.img.ubq/scene",
+    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"
+}
+
+declare enum DesignUnit {
+    Pixel = "px",
+    Millimeter = "mm",
+    Inch = "in"
+}
+
+/**
+ * @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;
+}
+
+declare type EventSubscription = number;
+
+declare interface ExportOptions {
+    jpegQuality: number;
+    pngCompressionLevel: number;
+    useTargetSize: boolean;
+    targetWidth: number;
+    targetHeight: number;
+}
+
+declare type Extensions = {
+    baseURL: string;
+    entries: string[];
+};
+
+declare interface Flip {
+    horizontal: boolean;
+    vertical: boolean;
+}
+
+declare type FontStyle = 'normal' | 'italic';
+
+declare type FontWeight = 'thin' | 'extraLight' | 'Light' | 'normal' | 'medium' | 'semiBold' | 'bold' | 'extraBold' | 'heavy';
+
+/**
+ * A hexadecimal color value (RGB or RGBA) that starts with a '#'
+ * @example #6686FF or #6686FFFF
+ */
+declare type HexColorString = string;
+
+declare type ImageDefinition = Preset & {
+    imageURL: string;
+    thumbnailURL?: string;
+    width: number;
+    height: number;
+    levelOfDetail?: {
+        [lod: number]: string;
+    };
+};
+
+declare type Logger = (message: string, level: LogLevel) => void;
+
+declare enum LogLevel {
+    Info = "Info",
+    Warning = "Warning",
+    Error = "Error"
+}
+
+/** @public */
+declare enum MimeType_2 {
+    Png = "image/png",
+    Jpeg = "image/jpeg",
+    Tga = "image/x-tga",
+    Binary = "application/octet-stream",
+    Pdf = "application/pdf",
+    Zip = "application/zip"
+}
+export { MimeType_2 as MimeType }
+
+declare interface NotificationEvent {
+    type: NotificationType;
+    i18n: string;
+}
+
+declare enum NotificationType {
+    Information = 0,
+    Warning = 1,
+    Error = 2
+}
+
+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;
+};
+
+declare type PageFormatDefinition = Preset & {
+    width: number;
+    height: number;
+    unit: DesignUnit;
+    dpi?: number;
+    bleedMargin?: number;
+};
+
+/**
+ * @public
+ */
+export declare enum PositionMode {
+    /** Position in absolute design units. */
+    Absolute = "Absolute",
+    /** Position in relation to the block's parent's size in percent, where 1.0 means 100%. */
+    Percent = "Percent",
+    /** Position is automatically determined. */
+    Undefined = "Auto"
+}
+
+declare type Preset = {
+    meta?: {
+        default?: boolean;
+        library?: string;
+        categories?: string[];
+    };
+};
+
+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 enum PropertyType {
+    Bool = "Bool",
+    Int = "Int",
+    Float = "Float",
+    String = "String",
+    Color = "Color",
+    Enum = "Enum",
+    Struct = "Struct"
+}
+
+/**
+ * Please read this before you change anything in this file.
+ *
+ * Types in here are a sub-set of the types in `api/asset.ts` and are meant to be
+ * exposed publicly.
+ *
+ * We do not use the types from `asset.ts` directly to handle (copy&paste) the
+ * syncing of the public type declarations and what we actually use in the config.
+ * This makes it easier to ensure that the customer is using the correct types and
+ * any missmatch between this and the `asset.ts` file will be shown by our
+ * type-checker.
+ *
+ * PLEASE NOTE: If you change anything in here, make the according changes in
+ * the `release/types.d.ts` file.
+ */
+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;
+}
+
+declare type RGBA = [r: number, g: number, b: number, a: number];
+
+/** All components between 0 and 1 */
+declare interface RGBAColor {
+    r: number;
+    g: number;
+    b: number;
+    a: number;
+}
+
+/** All components between 0 and 1 */
+declare interface RGBColor {
+    r: number;
+    g: number;
+    b: number;
+}
+
+/**
+ * Enum for the engine-internal numerical representations of the roles
+ */
+declare const enum Role {
+    Creator = 0,
+    Adopter = 1,
+    Viewer = 2,
+    Presenter = 3
+}
+
+/** Export Settings
+ *
+ */
+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 continous `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;
+}
+
+declare enum SceneLayout {
+    Free = 0,
+    VerticalStack = 1,
+    HorizontalStack = 2
+}
+
+/**
+ * @public
+ */
+export declare enum SizeMode {
+    /** Size in absolute design units. */
+    Absolute = "Absolute",
+    /** Size in relation to the block's parent's size in percent, where 1.0 means 100%. */
+    Percent = "Percent",
+    /** Size is determined by the block's content. */
+    Auto = "Auto"
+}
+
+declare type SpotColor = {
+    name: string;
+    rgbApproximation: RGBColor;
+    cmykApproximation: CMYKColor;
+};
+
+/**
+ * @public
+ */
+export declare enum StrokeCornerGeometry {
+    Bevel = "Bevel",
+    Miter = "Miter",
+    Round = "Round"
+}
+
+/**
+ * @public
+ */
+export declare enum StrokePosition {
+    Center = "Center",
+    Inner = "Inner",
+    Outer = "Outer"
+}
+
+/**
+ * @public
+ */
+export declare enum StrokeStyle {
+    Dashed = "Dashed",
+    DashedRound = "DashedRound",
+    Dotted = "Dotted",
+    LongDashed = "LongDashed",
+    LongDashedRound = "LongDashedRound",
+    Solid = "Solid"
+}
+
+declare type TemplateDefinition = Preset & {
+    scene: string | URL | (() => Promise<string>);
+    thumbnailURL?: string | URL;
+};
+
+declare interface TypeDescription {
+    name: string;
+    members: Array<TypeMemberDescription>;
+}
+
+declare type TypefaceDefinition = Preset & {
+    family: string;
+    fonts: [
+        {
+        fontURL: string;
+        weight: FontWeight;
+        style: FontStyle;
+    }
+    ];
+};
+
+declare interface TypeMemberDescription {
+    name: string;
+    type: string;
+    props: Array<TypeProp>;
+}
+
+declare interface TypeProp {
+    key: string;
+    value: number | string;
+}
+
+/**
+ * @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;
+}
+
+declare type VariableDefinition = Preset & {
+    value: string | number;
+};
+
+declare type Variables = {
+    [id: string]: VariableDefinition;
+};
+
+declare interface Vec2 {
+    x: number;
+    y: number;
+}
+
+declare interface Vec3 {
+    x: number;
+    y: number;
+    z: number;
+}
+
+declare interface Vector<T> {
+    size: () => number;
+    get: (index: number) => T;
+    delete: () => void;
+}
+
+export { }