@cesdk/engine 1.11.1 → 1.12.0

package/index.d.ts

@@ -14,7 +14,7 @@ export declare interface Asset {
      */
     id: string;
     /**  Groups of the asset.  */
-    groups?: Groups;
+    groups?: AssetGroups;
     /** Asset-specific and custom meta information */
     meta?: {
         /** The mime type of this asset or the data behind the asset's uri. */
@@ -52,7 +52,7 @@ export declare class AssetAPI {
      * @param applyAssetToBlock - An optional callback that can be used to override the default behavior of applying
      * an asset result to a given block.
      */
-    addLocalSource(id: string, supportedMimeTypes?: string[], applyAsset?: (asset: AssetResult) => Promise<DesignBlockId | undefined>, applyAssetToBlock?: (asset: AssetResult, block: DesignBlockId) => Promise<void>): void;
+    addLocalSource(id: string, supportedMimeTypes?: string[], applyAsset?: (asset: CompleteAssetResult) => Promise<DesignBlockId | undefined>, applyAssetToBlock?: (asset: CompleteAssetResult, block: DesignBlockId) => Promise<void>): void;
     /**
      * Removes an asset source with the given ID.
      * @param id - The ID to refer to the asset source.
@@ -69,7 +69,7 @@ export declare class AssetAPI {
      * @param query - All the options to filter the search results by.
      * @returns The search results.
      */
-    findAssets(sourceId: string, query: AssetQueryData): Promise<AssetsQueryResult>;
+    findAssets(sourceId: string, query: AssetQueryData): Promise<AssetsQueryResult<CompleteAssetResult>>;
     /**
      * Queries the asset source's groups for a certain asset type.
      * @param id - The ID of the asset source.
@@ -169,6 +169,17 @@ export declare interface AssetDefinition extends Asset {
     tags?: Record<Locale, string[]>;
 }
 
+/**
+ * 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
+ */
+export declare type AssetGroups = string[];
+
 /**
  * Defines a request for querying assets
  * @public
@@ -185,9 +196,9 @@ export declare interface AssetQueryData {
      */
     tags?: string | string[];
     /** Query only these groups */
-    groups?: Groups;
+    groups?: AssetGroups;
     /** Filter out assets with this groups */
-    excludeGroups?: Groups;
+    excludeGroups?: AssetGroups;
     /** Choose the locale of the labels and tags for localized search and filtering */
     locale?: Locale;
     /**
@@ -210,7 +221,6 @@ export declare interface AssetResult extends Asset {
     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;
@@ -228,44 +238,27 @@ export declare interface AssetResult extends Asset {
     };
 }
 
-/**
- * Single asset result of a query from the engine.
- * @public
- */
-declare interface AssetResult_2 {
-    /** A unique id of this asset */
-    id: string;
-    /** Asset-specific and custom meta information */
-    meta?: {
-        uri?: string;
-        filename?: string;
-        duration?: 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;
+}
+
+/** @public */
+declare interface AssetResultCredits {
+    name: string;
+    url: string;
+}
+
+/** @public */
+declare interface AssetResultLicense {
+    name: string;
+    url: string;
+}
+
+/** @public */
+declare interface AssetResultUtm {
+    source: string;
+    medium: string;
 }
 
 /**
@@ -276,7 +269,7 @@ 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>;
+    findAssets(queryData: AssetQueryData): Promise<AssetsQueryResult | undefined>;
     /** Return every available group */
     getGroups?: () => Promise<string[]>;
     /** Credits for the source/api */
@@ -289,10 +282,6 @@ export declare interface AssetSource {
         name: string;
         url?: string;
     };
-    /**
-     * @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 and remove assets dynamically? If `false`
      * methods like `addAsset` and `removeAsset` will throw an
@@ -306,12 +295,12 @@ export declare interface AssetSource {
      * You can override this with custom behavior.
      * @returns the id of a new block if one was created from the asset.
      */
-    applyAsset?: (asset: AssetResult) => Promise<DesignBlockId | undefined>;
+    applyAsset?: (asset: CompleteAssetResult) => Promise<DesignBlockId | undefined>;
     /**
      * Apply the given asset result to the given block.
      * You can override this with custom behavior.
      */
-    applyAssetToBlock?: (asset: AssetResult, block: DesignBlockId) => Promise<void>;
+    applyAssetToBlock?: (asset: CompleteAssetResult, block: DesignBlockId) => Promise<void>;
     /**
      * Adds the given asset to this source. Throws an error if the asset source
      * does not support adding assets.
@@ -329,72 +318,13 @@ export declare interface AssetSource {
     getSupportedMimeTypes?(): string[] | undefined;
 }
 
-/**
- * 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<DesignBlockId | undefined>;
-    /**
-     * Apply the given asset result to the given block.
-     * You can override this with custom behavior.
-     */
-    applyAssetToBlock?: (asset: AssetResult_2, block: number) => Promise<void>;
-
-    /** 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;
-    };
-
-    /**
-     * Generates a list of supported mime types for this source.
-     *
-     * @returns a list of the mime types should be supported by this source
-     */
-    getSupportedMimeTypes?(): string[] | undefined;
-}
-
-/** @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 {
+export declare interface AssetsQueryResult<T extends AssetResult = AssetResult> {
     /** The assets in the requested page */
-    assets: AssetResult_2[];
+    assets: T[];
     /** The current, requested page */
     currentPage: number;
     /** The next page to query if it exists */
@@ -904,13 +834,13 @@ export declare class BlockAPI {
      */
     getScreenSpaceBoundingBoxXYWH(ids: DesignBlockId[]): XYWH;
     /**
-     * Align multiple blocks horizontally within their bounding box (or group) or a single block to its parent.
+     * Align multiple blocks horizontally within their bounding box or a single block to its parent.
      * @param ids - A non-empty array of block ids.
      * @param alignment - How they should be aligned: left, right, or center
      */
     alignHorizontally(ids: DesignBlockId[], horizontalBlockAlignment: HorizontalBlockAlignment): void;
     /**
-     * Align multiple blocks vertically within their bounding box (or group) or a single block to its parent.
+     * Align multiple blocks vertically within their bounding box or a single block to its parent.
      * @param ids - A non-empty array of block ids.
      * @param alignment - How they should be aligned: top, bottom, or center
      */
@@ -921,6 +851,31 @@ export declare class BlockAPI {
      * @returns Whether the blocks can be aligned.
      */
     isAlignable(ids: DesignBlockId[]): boolean;
+    /**
+     * Distribute multiple blocks horizontally within their bounding box so that the space between them is even.
+     *
+     * @param ids - A non-empty array of block ids.
+     */
+    distributeHorizontally(ids: DesignBlockId[]): void;
+    /**
+     * Distribute multiple blocks vertically within their bounding box so that the space between them is even.
+     * @param ids - A non-empty array of block ids.
+     */
+    distributeVertically(ids: DesignBlockId[]): void;
+    /**
+     * Confirms that a given set of blocks can be distributed.
+     * @param ids - A non-empty array of block ids.
+     * @returns Whether the blocks can be distributed.
+     */
+    isDistributable(ids: DesignBlockId[]): boolean;
+    /**
+     * Resize all blocks to the given size. The content of the blocks is automatically adjusted
+     * to fit the new dimensions.
+     * @param ids - The blocks to resize.
+     * @param width - The new width of the blocks.
+     * @param height - The new height of the blocks.
+     */
+    resizeContentAware(ids: DesignBlockId[], width: number, height: number): void;
     /**
      * Scales the block and all of its children proportionally around the specified
      * relative anchor point.
@@ -1754,6 +1709,12 @@ export declare class BlockAPI {
      *   If the value is negative and the block is not being edited, this will fall back to the end of the entire text range.
      */
     setTextCase(id: DesignBlockId, textCase: TextCase, from?: number, to?: number): void;
+    /**
+     * Returns the UTF-16 indices of the selected range of the text block that is currently being edited.
+     * If both the start and end index of the returned range have the same value, then the text cursor is positioned at that index.
+     * @returns The selected UTF-16 range or \{ from: -1, to: -1 \} if no text block is currently being edited.
+     */
+    getTextCursorRange(): Range_2;
     /**
      * Query if the given block has fill color properties.
      * @param id - The block to query.
@@ -2247,11 +2208,6 @@ export declare interface BlurEvent extends CustomEvent<EventTarget | null> {
     preventDefault(): void;
 }
 
-/** @public */
-declare type Callbacks = {
-    log?: Logger;
-};
-
 declare type CameraSettings = {
     /** Horizontal resolution in physical pixels */
     width: number;
@@ -2299,78 +2255,256 @@ export declare interface CMYKColor {
 }
 
 /**
- * @deprecated This type definition has been removed.
- * Instead of `ConfigTypes.Color`, this can be imported directly as `PaletteColor`.
- * @public
- */
-declare type Color_2 = PaletteColor;
-
-/**
- * @deprecated This type definition is not used anymore and will be removed.
+ * Asset results that are returned from the engine.
+ *
+ * They contain additional information about the context of the asset.
  * @public
  */
-declare type ColorDefinition = Preset & {
-    value: Color_2;
-};
+export declare interface CompleteAssetResult extends AssetResult {
+    /**
+     * Context how an asset was added or shall be used in the future.
+     * This is added to all assets coming from the engine.
+     */
+    context: {
+        sourceId: string;
+    };
+}
 
 /**
- * @deprecated This type definition is not used anymore and will be removed.
+ * @deprecated This namespace is not used anymore. Please refer to the
+ * deprecation notices on its members to see where they have moved to.
  * @public
  */
-declare type ColorPaletteDefinition = Preset & {
-    entries: Color_2[];
-};
-
-declare namespace ConfigTypes {
-    export {
-        Color_2 as Color,
-        HexColorString_2 as HexColorString,
-        AssetSources,
-        AssetSource_2 as AssetSource,
-        AssetResult_2 as AssetResult,
-        AssetsQueryResult_2 as AssetsQueryResult,
-        QueryData,
-        Preset,
-        VariableDefinition,
-        ColorDefinition,
-        ColorPaletteDefinition,
-        PageFormatDefinition,
-        TemplateDefinition,
-        TypefaceDefinition,
-        Presets,
-        Variables,
-        Core,
-        Extensions,
-        Scene,
-        Page,
-        Callbacks
-    }
+export declare namespace ConfigTypes {
+    /**
+     * @deprecated This type definition has been removed.
+     * Instead of `ConfigTypes.Color`, this can be imported directly as `PaletteColor`.
+     */
+    export type Color = PaletteColor;
+    /**
+     * @deprecated This type definition has been moved
+     * It can instead be imported directly as `HexColorString`
+     */
+    export type HexColorString = HexColorString;
+    /**
+     * @deprecated
+     * This type definition has be removed. Please use the asset api at
+     * `cesdk.engine.asset` instead of `config.assetSources`.
+     */
+    export type AssetSources = {
+        [id: string]: AssetSource;
+    };
+    /**
+     * @deprecated
+     * This type definition has been moved and can be imported directly as `AssetQueryData`.
+     */
+    export type QueryData = AssetQueryData;
+    /**
+     * @deprecated
+     * This type definition has been moved and can be imported directly as `AssetResult`.
+     */
+    export type AssetResult = AssetResult;
+    /**
+     * @deprecated
+     * This type definition has been moved and can be imported directly as `AssetsQueryResult`.
+     */
+    export type AssetsQueryResult = AssetsQueryResult;
+    /**
+     * @deprecated
+     * This type definition has been moved and can be imported directly as `AssetSource`,
+     * when working with the asset api.
+     * @public
+     */
+    export type AssetSource = Omit<AssetSource, 'id'>;
+    /**
+     * @deprecated This type definition is not used anymore and will be removed.
+     */
+    export type Preset = {
+        meta?: {
+            default?: boolean;
+            library?: string;
+            categories?: string[];
+        };
+    };
+    /**
+     * @deprecated This type definition is not used anymore and will be removed.
+     */
+    export type VariableDefinition = Preset & {
+        value: string | number;
+    };
+    /**
+     * @deprecated This type definition is not used anymore and will be removed.
+     */
+    export type ColorDefinition = Preset & {
+        value: Color;
+    };
+    /**
+     * @deprecated This type definition is not used anymore and will be removed.
+     */
+    export type ColorPaletteDefinition = Preset & {
+        entries: Color[];
+    };
+    /**
+     * @deprecated This type definition is not used anymore and will be removed.
+     * In the CE.SDK, you can import `PageFormatDefinition` directly.
+     */
+    export type PageFormatDefinition = Preset & {
+        width: number;
+        height: number;
+        /** @deprecated This property is unused and will be removed  */
+        dpi?: number;
+        /** @deprecated This property is unused and will be removed  */
+        bleedMargin?: number;
+        unit: 'px' | 'mm' | 'in' | DesignUnit;
+        fixedOrientation?: boolean;
+    };
+    /**
+     * @deprecated This type definition has moved and can be imported directly as `TypefaceDefinition`.
+     */
+    export type TypefaceDefinition = _TypefaceDefinition;
+    /**
+     * @deprecated This type definition is not used anymore and will be removed.
+     */
+    export type TemplateDefinition = Preset & {
+        label: string;
+        scene: string | URL | (() => Promise<string>);
+        thumbnailURL?: string | URL;
+    };
+    /**
+     * @deprecated This type definition is not used anymore and will be removed.
+     * If you need to reference this type in your code,
+     * use `Configuration['presets']` instead of `ConfigTypes.Presets`.
+     */
+    export type Presets = {
+        /**
+         * @deprecated The configuration option `presets.colors` does not exist anymore.
+         */
+        colors?: {
+            [id: string]: Color;
+        };
+        typefaces?: {
+            [id: string]: _TypefaceDefinition;
+        };
+        /**
+         * @deprecated The configuration option `presets.colorPalettes` does not exist anymore.
+         */
+        colorPalettes?: {
+            [id: string]: ColorPaletteDefinition;
+        };
+        /**
+         * @deprecated The configuration option `presets.pageFormats` does not exist anymore.
+         */
+        pageFormats?: {
+            [id: string]: PageFormatDefinition;
+        };
+        /**
+         * @deprecated The configuration option `presets.templates` does not exist anymore.
+         * The templates should be defined as asset sources using
+         * the `cesdk.engine.asset.addSource` or `cesdk.engine.asset.addLocalSource` instead.
+         */
+        templates?: {
+            [id: string]: TemplateDefinition;
+        };
+    };
+    /**
+     * @deprecated This type definition is not used anymore and will be removed.
+     */
+    export type Variables = {
+        [id: string]: VariableDefinition;
+    };
+    /**
+     * @deprecated This type definition is not used anymore and will be removed.
+     * The settings that were configured here can be set via the BlockApi on the
+     * scene block:
+     *
+     * ```ts
+     * engine.block.setInt(sceneId, 'scene/dpi', dpi);
+     * engine.block.setInt(sceneId, 'scene/pixelScaleFactor', factor);
+     * ```
+     */
+    export type Scene = {
+        /**
+         * @deprecated Setting this value has no effect. You can change the dpi of the
+         * current scene via `engine.block.setInt(sceneId, 'scene/dpi', dpi)`
+         */
+        dpi: number;
+        /**
+         * @deprecated Setting this value has no effect. You can change the dpi of the
+         * current scene via `engine.block.setInt(sceneId, 'scene/pixelScaleFactor', * factor)`
+         */
+        pixelScaleFactor: number;
+    };
+    /**
+     * @deprecated This type definition is not used anymore and will be removed.
+     * The settings that were configured here can be set via the
+     * following EditorAPI settings:
+     * - `setSettingBool('page/title/show', show)`
+     * - `setSettingString('page/title/fontFileUri', uri)`
+     * - `setSettingBool('page/dimOutOfPageAreas', dim)`
+     * @public
+     */
+    export type Page = {
+        /**
+         * @deprecated
+         * The settings that were configured here can be set via the
+         * following EditorAPI settings:
+         * - `setSettingBool('page/title/show', show)`
+         * - `setSettingString('page/title/fontFileUri', uri)`
+         */
+        title: {
+            /**
+             * @deprecated
+             * Use the EditorAPI to set the title visibility:
+             * - `setSettingBool('page/title/show', show)`
+             */
+            show?: boolean;
+            /**
+             * @deprecated
+             * Use the EditorAPI to set the title font:
+             * - `setSettingString('page/title/fontFileUri', uri)`
+             */
+            fontFileUri?: string;
+        };
+        /**
+         * @deprecated
+         * Use the EditorAPI to control the opacity of out-of-page areas:
+         * - `setSettingBool('page/dimOutOfPageAreas', dim)`
+         */
+        dimOutOfPageAreas?: boolean;
+    };
+    /**
+     * @deprecated This type definition has been removed
+     * @public
+     */
+    export type Callbacks = {
+        /**
+         * @deprecated The logger has moved from `config.callbacks.logger` to `config.logger`
+         */
+        log?: Logger;
+    };
 }
-export { ConfigTypes }
 
 /** @public */
 export declare interface Configuration {
     baseURL: string;
     license?: string;
+    core: {
+        baseURL: string;
+    };
+    logger: Logger;
     featureFlags?: {
         [flag: string]: boolean | string;
     };
     /**
      * @deprecated Extensions have been superseded by AssetSources and should no longer be used.
      */
-    extensions: ConfigTypes.Extensions;
-    core: ConfigTypes.Core;
-    assetSources: ConfigTypes.AssetSources;
+    extensions: {
+        baseURL: string;
+        entries: string[];
+    };
     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.
+     * @deprecated This config key is not used anymore.
      */
     defaultFont?: string;
     /**
@@ -2387,6 +2521,47 @@ export declare interface Configuration {
      * If not configured the fallback value is 'auto'.
      */
     audioOutput?: 'auto' | 'none';
+    /**
+     * @deprecated This config key is not used anymore.
+     * You can configure a role via `setSettingEnum('role', role)` in the
+     * EditorAPI.
+     */
+    role?: RoleString;
+    /**
+     * @deprecated This config key is not used anymore.
+     * The settings that were configured here can be set via the
+     * following EditorAPI settings:
+     * - `setSettingBool('page/title/show', show)`
+     * - `setSettingString('page/title/fontFileUri', uri)`
+     * - `setSettingBool('page/dimOutOfPageAreas', dim)`
+     */
+    page?: ConfigTypes.Page;
+    /**
+     * @deprecated This config key is not used anymore.
+     * The settings that were configured here can be set via the BlockApi on the scene block
+     * @public
+     */
+    scene?: ConfigTypes.Scene;
+    /**
+     * @deprecated This config key is not used anymore.
+     * Please use the asset api at `cesdk.engine.asset` instead of `config.assetSources`.
+     */
+    assetSources?: ConfigTypes.AssetSources;
+    /**
+     * @deprecated This config key is not used anymore.
+     * Please use the VariableAPI at `cesdk.engine.variable` instead of `config.variables`.
+     */
+    variables?: ConfigTypes.Variables;
+    /**
+     * @deprecated This config key is not used anymore
+     * The `config.callbacks.logger` configuration will be moved to `config.logger`
+     */
+    callbacks?: {
+        /**
+         * @deprecated  The `config.callbacks.logger` has moved to `config.logger`
+         */
+        log?: Logger;
+    };
 }
 
 /**
@@ -2398,11 +2573,6 @@ export declare interface Configuration {
  */
 export declare type ContentFillMode = 'Crop' | 'Cover' | 'Contain';
 
-/** @public */
-declare type Core = {
-    baseURL: string;
-};
-
 /**
  * A headless implementation that just initializes & exposes the Document API
  *
@@ -2428,7 +2598,7 @@ declare class CreativeEngine {
      * @param config - An optional configuration object.
      * @returns An engine instance.
      */
-    static init<C extends Partial<Configuration> & OldConfiguration>(config?: C): Promise<CreativeEngine & (C extends {
+    static init<C extends Partial<Configuration>>(config?: C): Promise<CreativeEngine & (C extends {
         readonly canvas: any;
     } ? {
         readonly element: undefined;
@@ -2442,7 +2612,7 @@ declare class CreativeEngine {
      * - `'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.
+     * - `'ly.img.filter.duotone'` - Color 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'.
@@ -2512,7 +2682,7 @@ export declare type DefaultAssetSourceId = 'ly.img.sticker' | 'ly.img.vectorpath
 /**
  * @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';
+export declare type DemoAssetSourceId = 'ly.img.template' | '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
@@ -2900,12 +3070,6 @@ declare interface ExportVideoOptions {
     targetHeight: number;
 }
 
-/** @public */
-declare type Extensions = {
-    baseURL: string;
-    entries: string[];
-};
-
 /**
  * @public
  */
@@ -2955,17 +3119,6 @@ a: number
  */
 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[];
-
 /**
  * Will be called by a stream whenever a new value is available.
  * @public
@@ -2979,13 +3132,6 @@ declare type Handler<T> = (v: T) => void;
  */
 export declare type HexColorString = string;
 
-/**
- * @deprecated This type definition has been moved
- * It can instead be imported directly as `HexColorString`
- * @public
- */
-declare type HexColorString_2 = HexColorString;
-
 /**
  * A numerical identifier for a history stack
  * @public
@@ -3038,14 +3184,23 @@ export declare interface HTMLCreativeEngineCanvasElement extends HTMLElement {
 declare type Locale = string;
 
 /** @public */
-export declare type Logger = (message: string, level: LogLevel) => void;
+export declare interface Logger {
+    (message: string, level?: LogLevel): void;
+}
 
 /** @public */
-export declare enum LogLevel {
-    Info = "Info",
-    Warning = "Warning",
-    Error = "Error"
-}
+export declare type LogLevel = 'Info' | 'Warning' | 'Error';
+
+/**
+ * @public
+ * @deprecated Specifying log levels via `LogLevel.Info` has been deprecated.
+ * Please use the desired LogLevel string directly.
+ */
+export declare const LogLevel: {
+    readonly Info: "Info";
+    readonly Warning: "Warning";
+    readonly Error: "Error";
+};
 
 /** @public */
 declare enum MimeType_2 {
@@ -3060,63 +3215,6 @@ declare enum MimeType_2 {
 }
 export { MimeType_2 as MimeType }
 
-/**
- * Contains configuration keys that have been removed from the actual
- * configuration, but are still supported publicly
- * @public
- */
-export declare interface OldConfiguration {
-    /**
-     * @deprecated This config key has been removed.
-     * You can configure a role via `setSettingEnum('role', role)` in the
-     * EditorAPI.
-     */
-    role?: RoleString;
-    /**
-     * @deprecated This config key has been removed completely.
-     * The settings that were configured here can be set via the
-     * following EditorAPI settings:
-     * - `setSettingBool('page/title/show', show)`
-     * - `setSettingString('page/title/fontFileUri', uri)`
-     * - `setSettingBool('page/title/dimOutOfPageAreas', dim)`
-     */
-    page?: Page;
-    /**
-     * @deprecated This type definition has been removed
-     * The settings that were configured here can be set via the
-     * BlockApi on the scene block
-     * @public
-     */
-    scene?: Scene;
-}
-
-/**
- * @deprecated This type definition has been removed
- * The settings that were configured here can be set via the
- * following EditorAPI settings:
- * - `setSettingBool('page/title/show', show)`
- * - `setSettingString('page/title/fontFileUri', uri)`
- * - `setSettingBool('page/title/dimOutOfPageAreas', dim)`
- * @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 */
 export declare interface PageDuration {
     pageId: DesignBlockId;
@@ -3125,21 +3223,6 @@ export declare interface PageDuration {
     end: number;
 }
 
-/**
- * @deprecated This type definition is unused and will be removed
- * @public
- */
-declare type PageFormatDefinition = Preset & {
-    width: number;
-    height: number;
-    /** @deprecated This property is unused and will be removed  */
-    dpi?: number;
-    /** @deprecated This property is unused and will be removed  */
-    bleedMargin?: number;
-    unit: 'px' | 'mm' | 'in' | DesignUnit;
-    fixedOrientation?: boolean;
-};
-
 /**
  * A color definition for the custom color palette.
  * The RGB and CMYK components must all be specified in the range [0-1].
@@ -3156,62 +3239,20 @@ export declare type PaletteColor = HexColorString | RGBColor | RGBAColor | SpotC
  */
 export declare type PositionMode = 'Absolute' | 'Percent' | 'Auto';
 
-/**
- * @deprecated This type definition is not used anymore and will be removed.
- * @public
- */
-declare type Preset = {
-    meta?: {
-        default?: boolean;
-        library?: string;
-        categories?: string[];
-    };
-};
-
-/**
- * @deprecated This type definition will be removed.
- * If you need to reference this type in your code,
- * use `Configuration['presets']` instead of `ConfigTypes.Presets`.
- * @public
- */
-declare type Presets = {
-    /**
-     * @deprecated The configuration option `presets.colors` does not exist anymore.
-     */
-    colors?: {
-        [id: string]: Color_2;
-    };
-    typefaces?: {
-        [id: string]: TypefaceDefinition;
-    };
-    colorPalettes?: {
-        [id: string]: ColorPaletteDefinition;
-    };
-    pageFormats?: {
-        [id: string]: PageFormatDefinition;
-    };
-    templates?: {
-        [id: string]: TemplateDefinition;
-    };
-};
-
 /** @public */
 export declare type PropertyType = 'Bool' | 'Int' | 'Float' | 'String' | 'Color' | 'Enum' | 'Struct' | 'Double';
 
-/** @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;
+/**
+ * An open range.
+ * @public
+ * */
+declare interface Range_2 {
+    /** The starting value of the range */
+    from: number;
+    /** The non-inclusive ending value of the range */
+    to: number;
 }
+export { Range_2 as Range }
 
 /**
  * A Read only {@link Channel}
@@ -3293,31 +3334,6 @@ export declare interface RGBColor {
 /** @public */
 export declare type RoleString = 'Creator' | 'Adopter' | 'Viewer' | 'Presenter';
 
-/**
- * @deprecated This type definition is not used anymore and will be removed
- * in the future. The settings that were configured here can be set via the
- * BlockApi on the scene block:
- *
- * ```ts
- * engine.block.setInt(sceneId, 'scene/dpi', dpi);
- * engine.block.setInt(sceneId, 'scene/pixelScaleFactor', factor);
- * ```
- *
- * @public
- */
-declare type Scene = {
-    /**
-     * @deprecated Setting this value has no effect. You can change the dpi of the
-     * current scene via `engine.block.setInt(sceneId, 'scene/dpi', dpi)`
-     */
-    dpi: number;
-    /**
-     * @deprecated Setting this value has no effect. You can change the dpi of the
-     * current scene via `engine.block.setInt(sceneId, 'scene/pixelScaleFactor', * factor)`
-     */
-    pixelScaleFactor: number;
-};
-
 /**
  * @public
  */
@@ -3388,8 +3404,8 @@ export declare class SceneAPI {
     /**
      * 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.
+     * of the current scene. The content of the pages is automatically adjusted 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.
      */
@@ -3397,8 +3413,8 @@ export declare class SceneAPI {
     /**
      * 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.
+     * of the current scene. The content of the pages is automatically adjusted 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.
      */
@@ -3600,24 +3616,15 @@ export declare function supportsVideo(): boolean;
  */
 export declare function supportsWasm(): boolean;
 
-/** @public */
-declare type TemplateDefinition = {
-    /** @deprecated The meta field is not used anymore */
-    meta?: Preset['meta'];
-    label: string;
-    scene: string | URL | (() => Promise<string>);
-    thumbnailURL?: string | URL;
-};
-
 /**
  * @public
  */
 export declare type TextCase = 'Normal' | 'Uppercase' | 'Lowercase' | 'Titlecase';
 
 /** @public */
-declare type TypefaceDefinition = {
+export declare type TypefaceDefinition = {
     /** @deprecated The meta field is not used anymore */
-    meta?: Preset['meta'];
+    meta?: ConfigTypes.Preset['meta'];
     family: string;
     fonts: {
         fontURL: string;
@@ -3626,6 +3633,8 @@ declare type TypefaceDefinition = {
     }[];
 };
 
+declare type _TypefaceDefinition = TypefaceDefinition;
+
 /**
  * Invoke to unsubscribe from a stream.
  * @public
@@ -3662,16 +3671,6 @@ export declare class VariableAPI {
     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;