@cesdk/engine 1.33.0 → 1.34.0-rc.0

package/index.d.ts

@@ -385,8 +385,6 @@ export declare interface AssetResult extends Asset {
     };
 }
 
-declare type _AssetResult = AssetResult;
-
 /** @public */
 declare interface AssetResultCredits {
     name: string;
@@ -467,8 +465,6 @@ export declare interface AssetSource {
     getSupportedMimeTypes?(): string[] | undefined;
 }
 
-declare type _AssetSource = AssetSource;
-
 /**
  * Asset Color payload SpotColor representation
  * @public
@@ -495,8 +491,6 @@ export declare interface AssetsQueryResult<T extends AssetResult = AssetResult>
     total: number;
 }
 
-declare type _AssetsQueryResult = AssetsQueryResult;
-
 /**
  * Asset string property definition
  * @public
@@ -2973,225 +2967,6 @@ export declare interface CompleteAssetResult extends AssetResult {
     active: boolean;
 }
 
-/**
- * @deprecated This namespace is not used anymore. Please refer to the
- * deprecation notices on its members to see where they have moved to.
- * @public
- */
-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 is not used anymore and will be removed.
-     */
-    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;
-        };
-        /**
-         * @deprecated The configuration option `presets.typefaces` does not exist anymore.
-         * Custom typefaces should be defined as asset sources using
-         * the `cesdk.engine.asset.addSource` or `cesdk.engine.asset.addLocalSource` instead.
-         */
-        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;
-    };
-}
-
 /** @public */
 export declare interface Configuration {
     baseURL: string;
@@ -3207,11 +2982,16 @@ export declare interface Configuration {
     /**
      * @deprecated This config key is not used anymore and will be removed.
      */
-    presets: ConfigTypes.Presets;
-    /**
-     * @deprecated This config key is not used anymore.
-     */
-    defaultFont?: string;
+    presets: {
+        /**
+         * @deprecated The configuration option `presets.typefaces` does not exist anymore.
+         * Custom typefaces should be defined as asset sources using
+         * the `cesdk.engine.asset.addSource` or `cesdk.engine.asset.addLocalSource` instead.
+         */
+        typefaces?: {
+            [id: string]: TypefaceDefinition;
+        };
+    };
     /**
      * By default the engine tries to create a webgl2 context. If this fails it
      * falls back to trying to create a webgl1 context. If this configuration
@@ -3227,45 +3007,6 @@ export declare interface Configuration {
      */
     audioOutput?: 'auto' | 'none';
     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)`
-     * - `setSettingBool('page/title/showPageTitleTemplate', show)`
-     * - `setSettingBool('page/title/appendPageName', append)`
-     * - `setSettingBool('page/title/showOnSinglePage', hide)`
-     * - `setSettingString('page/title/separator', separator)`
-     * - `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;
-    };
 }
 
 /**
@@ -3414,6 +3155,9 @@ export declare type CutoutType = 'Solid' | 'Dashed';
  */
 export declare type DefaultAssetSourceId = 'ly.img.sticker' | 'ly.img.vectorpath' | 'ly.img.colors.defaultPalette' | 'ly.img.filter.lut' | 'ly.img.filter.duotone' | 'ly.img.effect' | 'ly.img.blur' | 'ly.img.typeface';
 
+/** @public */
+export declare function defaultLogger(message: string, level?: LogLevel): void;
+
 /**
  * @public
  */
@@ -4149,8 +3893,6 @@ a: number
  */
 export declare type HexColorString = string;
 
-declare type _HexColorString = HexColorString;
-
 /**
  * A numerical identifier for a history stack
  * @public
@@ -4753,7 +4495,7 @@ export declare type SceneMode = 'Design' | 'Video';
 export declare type Scope = 'text/edit' | 'text/character' | 'fill/change' | 'fill/changeType' | 'stroke/change' | 'shape/change' | 'layer/move' | 'layer/resize' | 'layer/rotate' | 'layer/flip' | 'layer/crop' | 'layer/opacity' | 'layer/blendMode' | 'layer/visibility' | 'layer/clipping' | 'appearance/adjustments' | 'appearance/filter' | 'appearance/effect' | 'appearance/blur' | 'appearance/shadow' | 'appearance/animation' | 'lifecycle/destroy' | 'lifecycle/duplicate' | 'editor/add' | 'editor/select';
 
 /** @public */
-export declare type SettingsBool = 'controlGizmo/showCropHandles' | 'controlGizmo/showCropScaleHandles' | 'controlGizmo/showMoveHandles' | 'controlGizmo/showResizeHandles' | 'controlGizmo/showRotateHandles' | 'controlGizmo/showScaleHandles' | 'doubleClickToCropEnabled' | 'features/singlePageModeEnabled' | 'features/pageCarouselEnabled' | 'mouse/enableScroll' | 'mouse/enableZoom' | 'checkScopesInAPIs' | 'page/dimOutOfPageAreas' | 'page/title/appendPageName' | 'page/title/show' | 'page/title/showOnSinglePage' | 'page/title/showPageTitleTemplate' | 'placeholderControls/showButton' | 'placeholderControls/showOverlay' | 'blockAnimations/enabled' | 'showBuildVersion' | 'touch/dragStartCanSelect' | 'touch/singlePointPanning';
+export declare type SettingsBool = 'controlGizmo/blockScaleDownLimit' | 'controlGizmo/showCropHandles' | 'controlGizmo/showCropScaleHandles' | 'controlGizmo/showMoveHandles' | 'controlGizmo/showResizeHandles' | 'controlGizmo/showRotateHandles' | 'controlGizmo/showScaleHandles' | 'doubleClickToCropEnabled' | 'features/singlePageModeEnabled' | 'features/pageCarouselEnabled' | 'mouse/enableScroll' | 'mouse/enableZoom' | 'checkScopesInAPIs' | 'page/dimOutOfPageAreas' | 'page/title/appendPageName' | 'page/title/show' | 'page/title/showOnSinglePage' | 'page/title/showPageTitleTemplate' | 'placeholderControls/showButton' | 'placeholderControls/showOverlay' | 'blockAnimations/enabled' | 'showBuildVersion' | 'touch/dragStartCanSelect' | 'touch/singlePointPanning';
 
 /** @public
  */
@@ -4905,7 +4647,11 @@ export declare interface Typeface {
  */
 export declare type TypefaceDefinition = {
     /** @deprecated The meta field is not used anymore */
-    meta?: ConfigTypes.Preset['meta'];
+    meta?: {
+        default?: boolean;
+        library?: string;
+        categories?: string[];
+    };
     family: string;
     fonts: {
         fontURL: string;
@@ -4914,8 +4660,6 @@ export declare type TypefaceDefinition = {
     }[];
 };
 
-declare type _TypefaceDefinition = TypefaceDefinition;
-
 /**
  * @public
  */