@cesdk/cesdk-js 1.65.0-nightly.20251119 → 1.65.0-nightly.20251121

package/index.d.ts

@@ -2722,23 +2722,48 @@ declare class CreativeEditorSDK {
      * Load an encoded scene from the provided string.
      * @category Scene Loading
      * @param scene -  A string starting with UBQ1 and containing the encoded scene.
+     * @param overrideEditorConfig - Whether to override editor configuration with settings and data from the scene file. Defaults to false.
      * @returns a promise which resolves if the scene was successfully loaded.
      */
-    loadFromString(scene: string): Promise<number>;
+    loadFromString(scene: string, overrideEditorConfig?: boolean): Promise<number>;
     /**
      * Load the scene stored in the file at the given URL.
      * @category Scene Loading
      * @param url - The url to fetch to acquire the scene string.
+     * @param overrideEditorConfig - Whether to override editor configuration with settings and data from the scene file. Defaults to false.
      * @returns a promise which resolves if the scene was successfully loaded.
      */
-    loadFromURL(url: string): Promise<number>;
+    loadFromURL(url: string, overrideEditorConfig?: boolean): Promise<number>;
     /**
-     * Create a scene from the provided image.
-     * @category Scene Creation
-     * @param url - The url of the image
+     * Load a previously archived scene from the URL to the scene file.
+     * @category Scene Loading
+     * @param url - The URL of the scene archive file.
+     * @param overrideEditorConfig - Whether to override editor configuration with settings and data from the scene file. Defaults to false.
      * @returns a promise which resolves if the scene was successfully loaded.
      */
-    createFromImage(url: string): Promise<number>;
+    loadFromArchiveURL(url: string, overrideEditorConfig?: boolean): Promise<number>;
+    /**
+     * 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.
+     *
+     * @category Scene Creation
+     * @param url - The image URL.
+     * @param dpi - The scene's DPI. Defaults to 300.
+     * @param pixelScaleFactor - The display's pixel scale factor. Defaults to 1.
+     * @param sceneLayout - The layout of the scene. Defaults to 'Free'.
+     * @param spacing - Spacing between pages. Defaults to 0.
+     * @param spacingInScreenSpace - Whether spacing is in screen space. Defaults to false.
+     * @returns a promise which resolves if the scene was successfully created.
+     */
+    createFromImage(url: string, dpi?: number, pixelScaleFactor?: number, sceneLayout?: SceneLayout, spacing?: number, spacingInScreenSpace?: boolean): Promise<number>;
+    /**
+     * Create a scene from the provided video.
+     * @category Scene Creation
+     * @param url - The url of the video
+     * @returns a promise which resolves if the scene was successfully created.
+     */
+    createFromVideo(url: string): Promise<number>;
     /**
      * Disable the warning logged when no scene is available.
      *
@@ -4676,7 +4701,7 @@ export declare interface RegisteredActions {
      */
     /** Action for zooming to a specific block */
     'zoom.toBlock': ZoomToBlockAction;
-    /** Action for zooming to the current page with optional padding */
+    /** Action for zooming to a page (current, first, last, or by index) with optional padding */
     'zoom.toPage': ZoomToPageAction;
     /** Action for zooming to the current selection */
     'zoom.toSelection': ZoomToSelectionAction;
@@ -4691,6 +4716,8 @@ export declare interface RegisteredActions {
      */
     /** Action for scrolling to a specific page */
     'scroll.toPage': ScrollToPageAction;
+    /** Action for scrolling to a specific block */
+    'scroll.toBlock': ScrollToBlockAction;
     /**
      * Video timeline zoom actions
      */
@@ -4781,6 +4808,15 @@ export { SceneMode }
 
 export { Scope }
 
+/**
+ * Action function for scrolling to a specific block
+ * @public
+ */
+export declare type ScrollToBlockAction = (blockId: number, options?: {
+    /** Whether to animate the scroll (default: false) */
+    animate?: boolean;
+}) => Promise<void>;
+
 /**
  * Action function for scrolling to a specific page
  * @public
@@ -7091,10 +7127,12 @@ export declare type ZoomToLevelAction = (level: number, options?: {
 }) => void | Promise<void>;
 
 /**
- * Action function for zooming to the current page with optional padding
+ * Action function for zooming to a page with optional padding
  * @public
  */
 export declare type ZoomToPageAction = (options?: {
+    /** The page to zoom to - 'current' (default), 'first', 'last', or a numeric page index (0-based) */
+    page?: 'current' | 'first' | 'last' | number;
     /** Padding configuration around the block */
     padding?: number | {
         x?: number;