@cesdk/engine 1.10.0-preview.1 → 1.10.0

package/index.d.ts

@@ -1,5 +1,9 @@
 /// <reference types="offscreencanvas" />
 
+declare type ArbitraryString = string & {
+    arbitrary?: any;
+};
+
 /**
  * Generic asset information
  * @public
@@ -104,7 +108,6 @@ export declare class AssetAPI {
      * @param assetId - The id of the asset to be removed.
      */
     removeAssetFromSource(sourceId: string, assetId: string): void;
-
     /**
      * Apply an asset result to the active scene.
      * The default behavior will instantiate a block and configure it according to the asset's properties.
@@ -132,6 +135,18 @@ export declare class AssetAPI {
      * @param block - The block to apply the asset result to.
      */
     defaultApplyAssetToBlock(assetResult: AssetResult, block: DesignBlockId): Promise<void>;
+    /**
+     * Register a callback to be called every time an asset source is added.
+     * @param callback - The function that is called whenever an asset source is added.
+     * @returns A method to unsubscribe.
+     */
+    onAssetSourceAdded: (callback: (sourceID: string) => void) => (() => void);
+    /**
+     * Register a callback to be called every time an asset source is removed.
+     * @param callback - The function that is called whenever an asset source is added.
+     * @returns A method to unsubscribe.
+     */
+    onAssetSourceRemoved: (callback: (sourceID: string) => void) => (() => void);
 
 }
 
@@ -274,14 +289,6 @@ export declare interface AssetSource {
         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
      */
@@ -290,6 +297,8 @@ export declare interface AssetSource {
      * Can the source add and remove assets dynamically? If `false`
      * methods like `addAsset` and `removeAsset` will throw an
      * error.
+     *
+     * @deprecated Will be removed in v1.11. Use `canAdd` and `canRemove` in the asset library configuration
      */
     canManageAssets?: boolean;
     /**
@@ -304,9 +313,8 @@ export declare interface AssetSource {
      */
     applyAssetToBlock?: (asset: AssetResult, block: DesignBlockId) => Promise<void>;
     /**
-     * Adds the given asset to this source. Throws an error if `canManageAssets`
-     * is `false`.
-     *
+     * Adds the given asset to this source. Throws an error if the asset source
+     * does not support adding assets.
      */
     addAsset?(asset: AssetDefinition): void;
     /**
@@ -341,14 +349,6 @@ declare interface AssetSource_2 {
 
     /** 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;
@@ -408,64 +408,6 @@ declare interface AssetsQueryResult_2 {
  */
 export declare type BlendMode = 'PassThrough' | 'Normal' | 'Darken' | 'Multiply' | 'ColorBurn' | 'Lighten' | 'Screen' | 'ColorDodge' | 'Overlay' | 'SoftLight' | 'HardLight' | 'Difference' | 'Exclusion' | 'Hue' | 'Saturation' | 'Color' | 'Luminosity';
 
-/**
- * Holds Channels for the different properties of a block.
- * Ensures that for each property, only one channel exists.
- * @public
- */
-export declare class Block extends Entity {
-    #private;
-    get type(): DesignBlockType;
-    effects: ReadWriteChannelSync<number[]>;
-    blur: ReadWriteChannelSync<number>;
-    isBlurEnabled: ReadWriteChannelSync<boolean>;
-    soloPlaybackEnabled: ReadWriteChannelSync<boolean>;
-    trimOffset: ReadWriteChannelSync<number>;
-    trimLength: ReadWriteChannelSync<number>;
-    playing: ReadWriteChannelSync<boolean>;
-    playbackTime: ReadWriteChannelSync<number>;
-    selection: ReadWriteChannelSync<boolean>;
-    duration: ReadWriteChannelSync<number>;
-    name: ReadWriteChannelSync<string>;
-    avResourceTotalDuration: ReadWriteChannelSync<number>;
-    timeOffset: ReadWriteChannelSync<number>;
-    cropTranslationX: ReadWriteChannelSync<number>;
-    cropTranslationY: ReadWriteChannelSync<number>;
-    cropTranslation: ReadWriteChannelSync<Vec2>;
-    cropScaleRatio: ReadWriteChannelSync<number>;
-    cropRotation: ReadWriteChannelSync<number>;
-    cropScaleX: ReadWriteChannelSync<number>;
-    cropScaleY: ReadWriteChannelSync<number>;
-    width: ReadWriteChannelSync<number>;
-    height: ReadWriteChannelSync<number>;
-    dimensions: ReadWriteChannelSync<Vec2>;
-    contentFillMode: ReadWriteChannelSync<ContentFillMode>;
-    blendMode: ReadWriteChannelSync<BlendMode>;
-    designStyleScope: ReadWriteChannelSync<boolean>;
-    designArrangeScope: ReadWriteChannelSync<boolean>;
-    designArrangeScopeMove: ReadWriteChannelSync<boolean>;
-    designArrangeScopeResize: ReadWriteChannelSync<boolean>;
-    designArrangeScopeRotate: ReadWriteChannelSync<boolean>;
-    designArrangeScopeFlip: ReadWriteChannelSync<boolean>;
-    contentReplaceScope: ReadWriteChannelSync<boolean>;
-    lifecycleDestroyScope: ReadWriteChannelSync<boolean>;
-    lifecycleDuplicateScope: ReadWriteChannelSync<boolean>;
-    editorAddScope: ReadWriteChannelSync<boolean>;
-    editorInspectScope: ReadWriteChannelSync<boolean>;
-    editorPresentScope: ReadWriteChannelSync<boolean>;
-    editorManagePagesScope: ReadWriteChannelSync<boolean>;
-    editorSelectScope: ReadWriteChannelSync<boolean>;
-    editorZoomScope: ReadWriteChannelSync<boolean>;
-    boundingBox: ReadOnlyChannelSync<{
-        x: number;
-        y: number;
-        width: number;
-        height: number;
-    }>;
-
-
-}
-
 /**
  * @public
  */
@@ -606,9 +548,14 @@ export declare class BlockAPI {
     setName(id: DesignBlockId, name: string): void;
     /**
      * Get a block's name.
-     * @param id - The block to update.
+     * @param id - The block to query.
      */
     getName(id: DesignBlockId): string;
+    /**
+     * Get a block's UUID.
+     * @param id - The block to query.
+     */
+    getUUID(id: DesignBlockId): string;
     /**
      * Finds all blocks with the given name.
      * @param name - The name to search for.
@@ -1270,6 +1217,7 @@ export declare class BlockAPI {
      * Query if the given block has fill color properties.
      * @param id - The block to query.
      * @returns true, if the block has fill color properties.
+     * @deprecated Query the fills type using getFill() and getType() instead.
      */
     hasFillColor(id: DesignBlockId): boolean;
     /**
@@ -1280,24 +1228,28 @@ export declare class BlockAPI {
      * @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 setFillSolidColor() instead.
      */
     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.
+     * @deprecated Use getFillSolidColor() instead.
      */
     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.
+     * @deprecated Use setFillEnabled() instead.
      */
     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.
+     * @deprecated Use isFillEnabled() instead."
      */
     isFillColorEnabled(id: DesignBlockId): boolean;
     /**
@@ -1692,12 +1644,14 @@ export declare class BlockAPI {
      * @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.
+     * @deprecated Use `createFill`, e.g., with type 'color' and then apply the fill block with `setFill` to the block instead.  If the block has a fill, it should be removed with `getFill` and `destroy`.
      */
     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.
+     * @deprecated Use `getEnum(id, 'fill/type')` instead.
      */
     getFillType(id: DesignBlockId): FillType;
     /**
@@ -1721,12 +1675,14 @@ export declare class BlockAPI {
      * @param id - The block whose gradient type should be set.
      * @param type - The gradient type.
      * @returns An empty result on success, an error otherwise.
+     * @deprecated Use `createFill`, e.g., with '//ly.img.ubq/fill/gradient/linear' and then apply the fill block with `setFill` to the block instead. If the block has a fill, it should be removed with `getFill` and `destroy`.
      */
     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.
+     * @deprecated Use `getEnum(id, 'fill/gradient/type')` instead.
      */
     getFillGradientType(id: DesignBlockId): GradientType;
     /**
@@ -1738,6 +1694,7 @@ export declare class BlockAPI {
      * @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.
+     * @deprecated Removed without a direct replacement. Use `block.setFloat(fill, keypath, value)` with key paths 'fill/gradient/linear/startPointX/Y', 'fill/gradient/radial/centerPointX/Y', and 'fill/gradient/conical/centerPointX/Y' to move the control points.
      */
     addFillGradientColorStop(id: DesignBlockId, stop: number, r: number, g: number, b: number, a?: number): void;
     /**
@@ -1745,12 +1702,14 @@ export declare class BlockAPI {
      * @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.
+     * @deprecated Removed without a direct replacement. Use `block.setFloat(fill, keypath, value)` with key paths 'fill/gradient/linear/startPointX/Y', 'fill/gradient/radial/centerPointX/Y', and 'fill/gradient/conical/centerPointX/Y' to move the control points.
      */
     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.
+     * @deprecated Removed without a direct replacement. Use `block.getFloat(fill, keypath)` with key paths 'fill/gradient/linear/startPointX/Y', 'fill/gradient/radial/centerPointX/Y', and 'fill/gradient/conical/centerPointX/Y' instead.
      */
     getFillGradientColorStops(id: DesignBlockId): GradientstopRGBA[];
     /**
@@ -1758,6 +1717,7 @@ export declare class BlockAPI {
      * @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.
+     * @deprecated Removed without a direct replacement. Use `block.setFloat(fill, keypath, value)` with key paths 'fill/gradient/linear/startPointX/Y', 'fill/gradient/radial/centerPointX/Y', and 'fill/gradient/conical/centerPointX/Y' to move the control points.
      */
     setFillGradientColorStops(id: DesignBlockId, stops: GradientstopRGBA[]): void;
     /**
@@ -1768,6 +1728,7 @@ export declare class BlockAPI {
      * @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.
+     * @deprecated Use, e.g., `block.setFloat(fill, 'fill/gradient/linear/startPointX', value)` and `startPointY` instead.
      */
     setFillGradientControlPoint(id: DesignBlockId, gradientControlPointType: GradientControlPointType, x: number, y: number): boolean;
     /**
@@ -1775,6 +1736,7 @@ export declare class BlockAPI {
      * @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.
+     * @deprecated Use `block.getFloat(fill, keypath)` with key paths 'fill/gradient/linear/startPointX', 'fill/gradient/radial/centerPointX', and 'fill/gradient/conical/centerPointX' instead.
      */
     getFillGradientControlPointX(id: DesignBlockId, gradientControlPointType: GradientControlPointType): number;
     /**
@@ -1782,6 +1744,7 @@ export declare class BlockAPI {
      * @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.
+     * @deprecated Use `block.setFloat(fill, keypath, value)` with key paths 'fill/gradient/linear/startPointY', 'fill/gradient/radial/centerPointY', and 'fill/gradient/conical/centerPointY' instead.
      */
     getFillGradientControlPointY(id: DesignBlockId, gradientControlPointType: GradientControlPointType): number;
     /**
@@ -1790,6 +1753,7 @@ export declare class BlockAPI {
      * @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.
+     * @deprecated Use, e.g., `block.setFloat(fill, 'fill/gradient/radial/radius', value)` instead.
      */
     setFillGradientRadius(id: DesignBlockId, radius: number): boolean;
     /**
@@ -1797,6 +1761,7 @@ export declare class BlockAPI {
      * 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.
+     * @deprecated Use, e.g., `block.getFloat(fill, 'fill/gradient/radial/radius')` instead.
      */
     getFillGradientRadius(id: DesignBlockId): number;
     /**
@@ -1815,8 +1780,39 @@ export declare class BlockAPI {
      * Query if the given block shows placeholder content.
      * @param id - The block to query.
      * @returns true, if the block shows placeholder content.
+     * @deprecated Use placeholder controls functions.
      */
     showsPlaceholderContent(id: DesignBlockId): boolean;
+    /**
+     * Checks whether the block supports placeholder controls.
+     * @param block - The block to query.
+     * @returns True, if the block supports placeholder controls.
+     */
+    hasPlaceholderControls(id: DesignBlockId): boolean;
+    /**
+     * Enable or disable the visibility of the placeholder overlay pattern for a block.
+     * @param block - The block whose placeholder overlay should be enabled or disabled.
+     * @param enabled - Whether the placeholder overlay should be shown or not.
+     * @returns An empty result on success, an error otherwise.
+     */
+    setPlaceholderControlsOverlayEnabled(id: DesignBlockId, enabled: boolean): void;
+    /**
+     * Query whether the placeholder overlay pattern for a block is shown.
+     * @param block - The block whose placeholder overlay visibility state should be queried.
+     * @returns An error if the block was invalid, otherwise the visibility state of the block's placeholder overlay pattern.
+     */
+    isPlaceholderControlsOverlayEnabled(id: DesignBlockId): boolean;
+    /** Enable or disable the visibility of the placeholder button for a block.
+     * @param block - The block whose placeholder button should be shown or not.
+     * @param enabled - Whether the placeholder button should be shown or not.
+     * @returns An empty result on success, an error otherwise.
+     */
+    setPlaceholderControlsButtonEnabled(id: DesignBlockId, enabled: boolean): void;
+    /** Query whether the placeholder button for a block is shown.
+     * @param block - The block whose placeholder button visibility state should be queried.
+     * @returns An error if the block was invalid, otherwise
+     */
+    isPlaceholderControlsButtonEnabled(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.
@@ -1959,15 +1955,15 @@ export declare class BlockAPI {
      */
     getTotalSceneDuration(scene: DesignBlockId): number;
     /**
-     * Set whether the block should be during active playback.
+     * Set whether the block should be playing during active playback.
      * @param id - The block that should be updated.
      * @param enabled - Whether the block should be playing its contents.
      */
     setPlaying(id: DesignBlockId, enabled: boolean): void;
     /**
-     * Returns whether the block is currently during active playback.
+     * Returns whether the block is playing during active playback.
      * @param id - The block to query.
-     * @returns whether the block is during playback.
+     * @returns whether the block is playing during playback.
      */
     isPlaying(id: DesignBlockId): boolean;
     /**
@@ -2011,7 +2007,7 @@ export declare class BlockAPI {
      */
     hasPlaybackControl(id: DesignBlockId): boolean;
     /**
-     * Set whether the block should start from the beginning again or stop.
+     * Set whether the block should restart from the beginning again or stop.
      * @param block - The block or video fill to update.
      * @param looping - Whether the block should loop to the beginning or stop.
      */
@@ -2085,15 +2081,6 @@ export declare class BlockAPI {
     getPageThumbnailAtlas(id: DesignBlockId, numberOfColumns: number, numberOfRows: number, thumbnailHeight: number): Promise<Blob>;
 }
 
-/**
- * This maintains a list of Blocks, ensuring that only one Block instance
- * exists per id.
- * @public
- */
-export declare class BlockChannels extends EntityChannels<Block> {
-    getBlock(id: number): Block;
-}
-
 /** @public */
 export declare interface BlockEvent {
     block: DesignBlockId;
@@ -2137,7 +2124,7 @@ declare type CameraSettings = {
  *   the current value.
  * @public
  */
-export declare interface Channel<Out, In = Out> {
+declare interface Channel<Out, In = Out> {
     subscribe: Source<Out>;
     update?: (v: In) => void;
     value?: () => Out;
@@ -2147,7 +2134,7 @@ export declare interface Channel<Out, In = Out> {
  * A {@link Channel} that is guaranteed to have a `value` method
  * @public
  */
-export declare interface ChannelSync<Out, In = Out> extends Channel<Out, In> {
+declare interface ChannelSync<Out, In = Out> extends Channel<Out, In> {
     subscribe: Source<Out>;
     update?: (v: In) => void;
     value: () => Out;
@@ -2197,12 +2184,11 @@ declare namespace ConfigTypes {
         PageFormatDefinition,
         TemplateDefinition,
         TypefaceDefinition,
-        ImageDefinition,
         Presets,
         Variables,
         Core,
         Extensions,
-        Scene_2 as Scene,
+        Scene,
         Page,
         Callbacks
     }
@@ -2215,6 +2201,9 @@ export declare interface Configuration {
     license?: string;
     role: RoleString;
     featureFlags?: Record<string, string | boolean>;
+    /**
+     * @deprecated Extensions have been superseded by AssetSources and should no longer be used.
+     */
     extensions: ConfigTypes.Extensions;
     core: ConfigTypes.Core;
     scene: ConfigTypes.Scene;
@@ -2294,6 +2283,49 @@ declare class CreativeEngine {
     } : {
         readonly element: HTMLCreativeEngineCanvasElement;
     })>;
+    /**
+     * Convenience function that registers a set of asset sources containing our
+     * default assets. These are
+     *
+     * - `'ly.img.sticker'` - Various stickers
+     * - `'ly.img.vectorpath'` - Shapes and arrows
+     * - `'ly.img.filter.lut'` - LUT effects of various kinds.
+     * - `'ly.img.filter.duotone'` - LUT effects of various kinds.
+     *
+     * These assets are parsed from the IMG.LY CDN at \{\{base_url\}\}/<id>/content.json, where
+     * `base_url` defaults to 'https://cdn.img.ly/assets/v1'.
+     * Each source is created via `addLocalSource` and populated with the parsed assets. To modify the available
+     * assets, you may either exclude certain IDs via `excludeAssetSourceIds` or alter the sources after creation.
+     *
+     * @param baseURL - The source of the asset definitions, must be absolute. Defaults to `'https://cdn.img.ly/assets/v1'`.
+     * @param excludeAssetSourceIds - A list of IDs, that will be ignored during load.
+     */
+    addDefaultAssetSources({ baseURL, excludeAssetSourceIds }?: {
+        baseURL?: string;
+        excludeAssetSourceIds?: DefaultAssetSourceId[];
+    }): Promise<void>;
+    /**
+     * Convenience function that registers a set of demo asset sources containing our
+     * example assets. These are not to meant to be used in your production code.
+     *
+     * These are
+     *
+     * - `'ly.img.image'` - Sample images
+     * - `'ly.img.image.upload'` - Demo source to upload image assets
+     * - `'ly.img.audio'` - Sample audios
+     * - `'ly.img.audio.upload'` - Demo source to upload audio assets
+     * - `'ly.img.video'` - Sample audios
+     * - `'ly.img.video.upload'` - Demo source to upload video assets
+     *
+     * @param excludeAssetSourceIds - A list of IDs, that will be ignored during load.
+     * @param sceneMode - if 'Video' video specific demo asset sources will be loaded as well (default 'Design')
+     * @param withUploadAssetSources - if 'true' asset sources for uploads are added (default false)
+     */
+    addDemoAssetSources({ excludeAssetSourceIds, sceneMode, withUploadAssetSources }?: {
+        excludeAssetSourceIds?: DemoAssetSourceId[];
+        sceneMode?: SceneMode;
+        withUploadAssetSources?: boolean;
+    }): Promise<void>;
 
 
 }
@@ -2312,6 +2344,16 @@ export declare interface CursorEvent extends CustomEvent<string> {
     preventDefault(): void;
 }
 
+/**
+ * @public
+ */
+export declare type DefaultAssetSourceId = 'ly.img.sticker' | 'ly.img.vectorpath' | 'ly.img.filter.lut' | 'ly.img.filter.duotone';
+
+/**
+ * @public
+ */
+export declare type DemoAssetSourceId = 'ly.img.image.upload' | 'ly.img.video.upload' | 'ly.img.audio.upload' | 'ly.img.image' | 'ly.img.video' | 'ly.img.audio';
+
 /**
  * A numerical identifier for a design block
  * @public
@@ -2454,13 +2496,13 @@ export declare class EditorAPI {
      * @param value - The value to set.
      * @throws An error, if the keypath is invalid.
      */
-    setSettingBool(keypath: string, value: boolean): void;
+    setSettingBool(keypath: SettingsBool, value: boolean): void;
     /**
      * Get a boolean setting.
      * @param keypath - The settings keypath, e.g. `doubleClickToCropEnabled`
      * @throws An error, if the keypath is invalid.
      */
-    getSettingBool(keypath: string): boolean;
+    getSettingBool(keypath: SettingsBool): boolean;
     /**
      * Set an integer setting.
      * @param keypath - The settings keypath.
@@ -2480,26 +2522,26 @@ export declare class EditorAPI {
      * @param value - The value to set.
      * @throws An error, if the keypath is invalid.
      */
-    setSettingFloat(keypath: string, value: number): void;
+    setSettingFloat(keypath: SettingsFloat, value: number): void;
     /**
      * Get a float setting.
      * @param keypath - The settings keypath, e.g. `positionSnappingThreshold`
      * @throws An error, if the keypath is invalid.
      */
-    getSettingFloat(keypath: string): number;
+    getSettingFloat(keypath: SettingsFloat): number;
     /**
      * Set a string setting.
      * @param keypath - The settings keypath, e.g. `license`
      * @param value - The value to set.
      * @throws An error, if the keypath is invalid.
      */
-    setSettingString(keypath: string, value: string): void;
+    setSettingString(keypath: SettingsString, value: string): void;
     /**
      * Get a string setting.
      * @param keypath - The settings keypath, e.g. `license`
      * @throws An error, if the keypath is invalid.
      */
-    getSettingString(keypath: string): string;
+    getSettingString(keypath: SettingsString): string;
     /**
      * Set a color setting.
      * @param keypath - The settings keypath, e.g. `highlightColor`.
@@ -2508,25 +2550,25 @@ export declare class EditorAPI {
      * @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;
+    setSettingColorRGBA(keypath: SettingsColorRGBA, r: number, g: number, b: number, a?: number): void;
     /**
      * Get a color setting.
      * @param keypath - The settings keypath, e.g. `highlightColor`.
      * @returns A tuple of channels red, green, blue and alpha in the range of 0 to 1.
      */
-    getSettingColorRGBA(keypath: string): RGBA;
+    getSettingColorRGBA(keypath: SettingsColorRGBA): RGBA;
     /**
      * Set an enum setting.
      * @param keypath - The settings keypath, e.g. `role`.
      * @param value - The enum value as string.
      */
-    setSettingEnum(keypath: string, value: string): void;
+    setSettingEnum<T extends keyof SettingsEnum>(keypath: T, value: SettingsEnum[T]): void;
     /**
      * Get an enum setting.
      * @param keypath - The settings keypath, e.g. `role`.
      * @returns The value as string.
      */
-    getSettingEnum(keypath: string): string;
+    getSettingEnum<T extends keyof SettingsEnum>(keypath: T): SettingsEnum[T];
     /**
      * Get the currently available memory in bytes.
      * @returns The currently available memory in bytes.
@@ -2603,48 +2645,6 @@ export declare class EditorAPI {
     removeSpotColor(name: string): void;
 }
 
-/**
- * Holds Channels for the different properties of an effect.
- * Ensures that for each property, only one channel exists.
- * @public
- */
-export declare class Effect extends Entity {
-    enabled: ReadWriteChannelSync<boolean>;
-
-}
-
-/**
- * This maintains a list of Effects, ensuring that only one Block instance
- * exists per id.
- * @public
- */
-export declare class EffectChannels extends EntityChannels<Effect> {
-    getEffect(id: number): Effect;
-}
-
-/**
- * @public
- */
-export declare class Entity {
-    #private;
-
-
-
-    get id(): number;
-    Int(property: string): ReadWriteChannelSync<number>;
-    Float(property: string): ReadWriteChannelSync<number>;
-    Bool(property: string): ReadWriteChannelSync<boolean>;
-}
-
-/** @public */
-export declare class EntityChannels<T extends Entity> {
-    #private;
-
-
-
-    dispose(): void;
-}
-
 /**
  * @public
  */
@@ -2819,19 +2819,21 @@ export declare type HistoryId = number;
 export declare interface HTMLCreativeEngineCanvasElement extends HTMLElement {
 
 
+    /**
+     * Clear the canvas
+     *
+     * This is useful when mounting the canvas into a new position in the DOM.
+     * If the canvas is not cleared, it will appear in the new DOM position, with
+     * its contents stretched to the new size. It will re-render correctly during
+     * the next animation frame, but for a brief moment the canvas contents can
+     * flash distorted.
+     *
+     * Call `clear()` before mounting into the DOM to avoid this. This will cause
+     * the canvas to be cleared until rendering the next frame.
+     */
+    clear(): void;
 }
 
-/** @public */
-declare type ImageDefinition = Preset & {
-    imageURL: string;
-    thumbnailURL?: string;
-    width: number;
-    height: number;
-    levelOfDetail?: {
-        [lod: number]: string;
-    };
-};
-
 /**
  * e.g. `en`, `de`, etc.
  * @public
@@ -2892,8 +2894,6 @@ declare type PageFormatDefinition = Preset & {
     width: number;
     height: number;
     unit: DesignUnit;
-    dpi?: number;
-    bleedMargin?: number;
     fixedOrientation?: boolean;
 };
 
@@ -2923,9 +2923,6 @@ declare type Presets = {
     typefaces?: {
         [id: string]: TypefaceDefinition;
     };
-    images?: {
-        [id: string]: ImageDefinition;
-    };
     pageFormats?: {
         [id: string]: PageFormatDefinition;
     };
@@ -2959,7 +2956,7 @@ declare interface QueryData {
  * A Read only {@link Channel}
  * @public
  */
-export declare interface ReadOnlyChannel<Out> extends Omit<Channel<Out>, 'update'> {
+declare interface ReadOnlyChannel<Out> extends Omit<Channel<Out>, 'update'> {
     subscribe: Source<Out>;
     value?: () => Out;
 }
@@ -2968,7 +2965,7 @@ export declare interface ReadOnlyChannel<Out> extends Omit<Channel<Out>, 'update
  * A {@link ReadOnlyChannel} that is guaranteed to have a `value`
  * @public
  */
-export declare interface ReadOnlyChannelSync<Out> extends Omit<ChannelSync<Out>, 'update'>, ReadOnlyChannel<Out> {
+declare interface ReadOnlyChannelSync<Out> extends Omit<ChannelSync<Out>, 'update'>, ReadOnlyChannel<Out> {
     subscribe: Source<Out>;
     value: () => Out;
 }
@@ -2977,7 +2974,7 @@ export declare interface ReadOnlyChannelSync<Out> extends Omit<ChannelSync<Out>,
  * A {@link Channel} that is guaranteed to have an `update` method.
  * @public
  */
-export declare interface ReadWriteChannel<Out, In = Out> extends Channel<Out, In> {
+declare interface ReadWriteChannel<Out, In = Out> extends Channel<Out, In> {
     subscribe: Source<Out>;
     update: (v: In) => void;
     value?: () => Out;
@@ -2987,7 +2984,7 @@ export declare interface ReadWriteChannel<Out, In = Out> extends Channel<Out, In
  * A {@link ReadWriteChannel} that is guaranteed to have a `value` and an `update` method
  * @public
  */
-export declare interface ReadWriteChannelSync<Out, In = Out> extends ChannelSync<Out, In>, ReadWriteChannel<Out, In> {
+declare interface ReadWriteChannelSync<Out, In = Out> extends ChannelSync<Out, In>, ReadWriteChannel<Out, In> {
     subscribe: Source<Out>;
     update: (v: In) => void;
     value: () => Out;
@@ -3035,31 +3032,11 @@ export declare interface RGBColor {
 /** @public */
 export declare type RoleString = 'Creator' | 'Adopter' | 'Viewer' | 'Presenter';
 
-/**
- * Contains channels for scene-specific information that are valid through
- * scene changes.
- * @public
- */
-export declare class Scene {
-
-    /**
-     * A channel containing the latest Block.
-     * Will emit an event when the scene changes
-     */
-    block: ChannelSync<Block | undefined>;
-    mode: ChannelSync<SceneMode | undefined>;
-    totalDuration: ChannelSync<number>;
-    pages: ChannelSync<DesignBlockId[]>;
-    playing: ReadWriteChannelSync<boolean>;
-    playbackTime: ReadWriteChannelSync<number>;
-    pageDurations: ChannelSync<PageDuration[]>;
-}
-
 /**
  * Export Settings
  * @public
  */
-declare type Scene_2 = {
+declare type Scene = {
     /**
      * 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).
@@ -3267,20 +3244,24 @@ export declare type SceneLayout = 'Free' | 'VerticalStack' | 'HorizontalStack' |
  */
 export declare type SceneMode = 'Design' | 'Video';
 
-/**
- * This channel allows to subscribe/update the selected design blocks.
- * @public
- */
-export declare class SelectionChannel implements ReadWriteChannelSync<number[]> {
-    #private;
-    subscribe: Source<number[]>;
-    update: (selectedDesignElements: number[]) => void;
-    value: () => number[];
-    blocks: ChannelSync<Block[]>;
+/** @public */
+export declare type SettingsBool = 'doubleClickToCropEnabled' | 'features/aiImageMattingEnabled' | 'features/aiImageMattingStagingEnabled' | 'features/aiInpaintingEnabled' | 'features/aiSmartCropEnabled' | 'features/aiSuperResolutionEnabled' | 'features/effectsEnabled' | 'features/hspSelectiveAdjustmentsEnabled' | 'features/layerListEnabled' | 'features/singlePageModeEnabled' | 'features/templatingEnabled' | 'page/dimOutOfPageAreas' | 'page/title/show' | 'placeholderControls/showButton' | 'placeholderControls/showOverlay' | 'showBuildVersion' | 'touch/dragStartCanSelect' | 'touch/singlePointPanning' | 'trackActivePage' | ArbitraryString;
 
-    private deselectAll;
-    private selectAll;
-}
+/** @public */
+export declare type SettingsColorRGBA = 'clearColor' | 'errorStateColor' | 'highlightColor' | 'page/title/color' | 'placeholderHighlightColor' | 'progressColor' | ArbitraryString;
+
+/** @public */
+export declare type SettingsEnum = {
+    role: RoleString;
+    doubleClickSelectionMode: 'Direct' | 'Hierarchical';
+    [key: ArbitraryString]: string;
+};
+
+/** @public */
+export declare type SettingsFloat = 'positionSnappingThreshold';
+
+/** @public */
+export declare type SettingsString = 'ai/apiStagingUrl' | 'ai/apiUrl' | 'ai/backendUrl' | 'basePath' | 'license' | 'page/title/fontFileUri' | ArbitraryString;
 
 /** @public */
 export declare interface Size2 {