@cesdk/cesdk-js 1.69.0-rc.0 → 1.69.0-rc.2

package/index.d.ts

@@ -2808,12 +2808,14 @@ declare class CreativeEditorSDK {
     }>;
     /**
      * Create a scene with a single empty page with the given format.
+     * @deprecated Use `cesdk.actions.run('scene.create', { mode: 'Design' })` instead.
      * @category Scene Creation
      * @param format - A `PageFormatDefinition` object specifying the page format to use.
      */
     createDesignScene(format?: PageFormatDefinition): Promise<number>;
     /**
      * Create a scene with a single empty page with the given format.
+     * @deprecated Use `cesdk.actions.run('scene.create', { mode: 'Video' })` instead.
      * @category Scene Creation
      * @param format - The page format to use. Can be either a string, identifying
      * a page format that has been configured or a `PageFormatDefinition` object.
@@ -2914,6 +2916,22 @@ declare class CreativeEditorSDK {
      * @category Configuration
      */
     resetEditor(): void;
+    /**
+     * Re-applies the user's initial deprecated configuration that was passed to
+     * `CreativeEditorSDK.create()`. This restores deprecated configuration
+     * values that may have been cleared by `resetEditor()`.
+     *
+     * Config plugins should call this as the last step of their `initialize()`
+     * method, after all features, UI, actions, and settings have been set up.
+     *
+     * @deprecated This method is an intermediate measure to preserve backward
+     * compatibility while users migrate away from deprecated configuration
+     * options. It will be removed once the deprecated configuration paths
+     * are fully dropped.
+     *
+     * @category Configuration
+     */
+    reapplyLegacyUserConfiguration(): void;
     /**
      * Save and return a scene as a base64 encoded string.
      *
@@ -4809,6 +4827,26 @@ export declare interface OrderContext {
  */
 export declare type OrderContextFor<A extends UIArea> = A extends 'ly.img.caption.panel' ? CaptionPanelOrderContext : OrderContext;
 
+/**
+ * Reference to a page preset from an asset source.
+ * @public
+ */
+export declare type PageAssetReference = {
+    sourceId: string;
+    assetId: string;
+};
+
+/**
+ * Direct page dimensions specification.
+ * @public
+ */
+export declare type PageDimensions = {
+    width: number;
+    height: number;
+    unit: DesignUnit;
+    fixedOrientation?: boolean;
+};
+
 /**
  * Represents the definition of a page format in the Creative Editor SDK.
  * This interface defines the width, height, unit, and optional fixed orientation for a page format.
@@ -4823,6 +4861,13 @@ export declare type PageFormatDefinition = {
     fixedOrientation?: boolean;
 };
 
+/**
+ * A page can be specified as direct dimensions, an asset source reference,
+ * or an asset object (e.g., from engine.asset.fetchAsset()).
+ * @public
+ */
+export declare type PageSpec = PageDimensions | PageAssetReference | Asset;
+
 export { PaletteColor }
 
 /**
@@ -5099,6 +5144,11 @@ export declare interface RegisteredActions {
     'video.decode.checkSupport': VideoDecodeCheckSupportAction;
     /** Action for checking video encoding/export support */
     'video.encode.checkSupport': VideoEncodeCheckSupportAction;
+    /**
+     * Scene creation action
+     */
+    /** Action for creating a new scene with configurable mode and page sizes */
+    'scene.create': SceneCreateAction;
 }
 
 /**
@@ -5183,6 +5233,35 @@ declare type ScaleFn = ({ containerWidth, isTouch }: {
 
 export { SceneAPI }
 
+/**
+ * Action for creating a new scene with configurable mode and page sizes.
+ * Returns the scene block ID.
+ * @public
+ */
+export declare type SceneCreateAction = (options?: SceneCreateOptions) => Promise<number>;
+
+/**
+ * Options for creating a new scene.
+ * @public
+ */
+export declare type SceneCreateOptions = {
+    /** Scene mode. Defaults to 'Design'. */
+    mode?: SceneMode;
+    /** Scene layout. Defaults to 'VerticalStack' for Design, ignored for Video. */
+    layout?: SceneLayout;
+} & ({
+    /** A single page spec repeated `pageCount` times. */
+    page?: PageSpec;
+    /** Number of pages to create. Defaults to 1. */
+    pageCount?: number;
+    pages?: never;
+} | {
+    /** An array of page specs, one page per entry. */
+    pages: PageSpec[];
+    page?: never;
+    pageCount?: never;
+});
+
 export { SceneLayout }
 
 export { SceneMode }

package/index.html

@@ -73,7 +73,7 @@
               instance.addDefaultAssetSources(),
               instance.addDemoAssetSources()
             ]);
-            await instance.createDesignScene();
+            await instance.actions.run('scene.create');
           }
         );
       };