@cesdk/engine 1.58.0-nightly.20250801 → 1.58.0-nightly.20250808

package/index.d.ts

@@ -1390,6 +1390,10 @@ export declare class BlockAPI {
      * @category Block Lifecycle
      * @param blocks - The blocks to save.
      * @param allowedResourceSchemes - The resource schemes to allow in the saved string. Defaults to ['buffer', 'http', 'https'].
+     * @param onDisallowedResourceScheme - An optional callback that is called for each resource URL that has a scheme absent from
+     * `resourceSchemesAllowed`. The `url` parameter is the resource URL and the `dataHash` parameter is the hash of the
+     * resource's data. The callback should return a new URL for the resource, which will be used in the serialized
+     * scene. The callback is expected to return the original URL if no persistence is needed.
      * @returns A promise that resolves to a string representing the blocks or an error.
      * @example
      * ```typescript
@@ -1402,7 +1406,7 @@ export declare class BlockAPI {
      * const serialized = await engine.block.saveToString([page]);
      * ```
      */
-    saveToString(blocks: DesignBlockId[], allowedResourceSchemes?: string[]): Promise<string>;
+    saveToString(blocks: DesignBlockId[], allowedResourceSchemes?: string[], onDisallowedResourceScheme?: (url: string, dataHash: string) => Promise<string>): Promise<string>;
     /**
      * Saves the given blocks and their assets to a zip archive.
      *
@@ -5713,12 +5717,15 @@ export declare class EditorAPI {
      *
      * ```javascript
      * engine.editor.setEditMode('Crop');
+     * // With a base mode
+     * engine.editor.setEditMode('CustomMode', 'Crop');
      * ```
      *
      * @category Edit Mode Management
      * @param mode - "Transform", "Crop", "Text", "Playback", "Trim" or a custom value.
+     * @param baseMode - Optional base mode from which the custom mode will inherit the settings.
      */
-    setEditMode(mode: EditMode): void;
+    setEditMode(mode: EditMode, baseMode?: string): void;
     /**
      * Get the editor's current edit mode.
      *
@@ -7303,9 +7310,10 @@ export declare class SceneAPI {
      *
      * @category Scene Loading
      * @param sceneContent - The scene file contents, a base64 string.
+     * @param overrideEditorConfig - Whether to override editor configuration with settings and data from the scene file. Defaults to false.
      * @returns A handle to the loaded scene.
      */
-    loadFromString(sceneContent: string): Promise<DesignBlockId>;
+    loadFromString(sceneContent: string, overrideEditorConfig?: boolean): Promise<DesignBlockId>;
     /**
      * Load a scene from the URL to the scene file.
      *
@@ -7318,9 +7326,10 @@ export declare class SceneAPI {
      *
      * @category Scene Loading
      * @param url - The URL of the scene file.
+     * @param overrideEditorConfig - Whether to override editor configuration with settings and data from the scene file. Defaults to false.
      * @returns scene A promise that resolves once the scene was loaded or rejects with an error otherwise.
      */
-    loadFromURL(url: string): Promise<DesignBlockId>;
+    loadFromURL(url: string, overrideEditorConfig?: boolean): Promise<DesignBlockId>;
     /**
      * Load a previously archived scene from the URL to the scene file.
      *
@@ -7329,16 +7338,22 @@ export declare class SceneAPI {
      *
      * @category Scene Loading
      * @param url - The URL of the scene file.
+     * @param overrideEditorConfig - Whether to override editor configuration with settings and data from the scene file. Defaults to false.
      * @returns scene A promise that resolves once the scene was loaded or rejects with an error otherwise.
      */
-    loadFromArchiveURL(url: string): Promise<DesignBlockId>;
+    loadFromArchiveURL(url: string, overrideEditorConfig?: boolean): Promise<DesignBlockId>;
     /**
      * Serializes the current scene into a string. Selection is discarded.
      *
      * @category Scene Saving
+     * @param allowedResourceSchemes - The resource schemes to allow in the saved string. Defaults to ['blob', 'bundle', 'file', 'http', 'https', 'opfs'].
+     * @param onDisallowedResourceScheme - An optional callback that is called for each resource URL that has a scheme absent from
+     * `resourceSchemesAllowed`. The `url` parameter is the resource URL and the `dataHash` parameter is the hash of the
+     * resource's data. The callback should return a new URL for the resource, which will be used in the serialized
+     * scene. The callback is expected to return the original URL if no persistence is needed.
      * @returns A promise that resolves with a string on success or an error on failure.
      */
-    saveToString(allowedResourceSchemes?: string[]): Promise<string>;
+    saveToString(allowedResourceSchemes?: string[], onDisallowedResourceScheme?: (url: string, dataHash: string) => Promise<string>): Promise<string>;
     /**
      * Saves the current scene and all of its referenced assets into an archive.
      *
@@ -7866,7 +7881,7 @@ export declare type Scope = 'text/edit' | 'text/character' | 'fill/change' | 'fi
  *
  * @public
  */
-export declare type SettingsBool = 'controlGizmo/showCropHandles' | 'controlGizmo/showCropScaleHandles' | 'controlGizmo/showMoveHandles' | 'controlGizmo/showResizeHandles' | 'controlGizmo/showRotateHandles' | 'controlGizmo/showScaleHandles' | 'doubleClickToCropEnabled' | 'features/singlePageModeEnabled' | 'features/pageCarouselEnabled' | 'features/transformEditsRetainCoverMode' | 'mouse/enableScroll' | 'mouse/enableZoom' | 'page/allowCropInteraction' | 'page/allowMoveInteraction' | 'page/allowResizeInteraction' | 'page/allowRotateInteraction' | 'page/dimOutOfPageAreas' | 'page/restrictResizeInteractionToFixedAspectRatio' | 'page/moveChildrenWhenCroppingFill' | 'page/selectWhenNoBlocksSelected' | 'page/title/appendPageName' | 'page/title/show' | 'page/title/showOnSinglePage' | 'page/title/showPageTitleTemplate' | 'placeholderControls/showButton' | 'placeholderControls/showOverlay' | 'blockAnimations/enabled' | 'showBuildVersion' | 'touch/dragStartCanSelect' | 'touch/singlePointPanning' | 'useSystemFontFallback' | 'forceSystemEmojis';
+export declare type SettingsBool = 'controlGizmo/showCropHandles' | 'controlGizmo/showCropScaleHandles' | 'controlGizmo/showMoveHandles' | 'controlGizmo/showResizeHandles' | 'controlGizmo/showRotateHandles' | 'controlGizmo/showScaleHandles' | 'doubleClickToCropEnabled' | 'features/singlePageModeEnabled' | 'features/pageCarouselEnabled' | 'features/transformEditsRetainCoverMode' | 'mouse/enableScroll' | 'mouse/enableZoom' | 'page/allowCropInteraction' | 'page/allowMoveInteraction' | 'page/allowResizeInteraction' | 'page/allowRotateInteraction' | 'page/dimOutOfPageAreas' | 'page/restrictResizeInteractionToFixedAspectRatio' | 'page/moveChildrenWhenCroppingFill' | 'page/title/appendPageName' | 'page/title/show' | 'page/title/showOnSinglePage' | 'page/title/showPageTitleTemplate' | 'placeholderControls/showButton' | 'placeholderControls/showOverlay' | 'blockAnimations/enabled' | 'showBuildVersion' | 'touch/dragStartCanSelect' | 'touch/singlePointPanning' | 'useSystemFontFallback' | 'forceSystemEmojis';
 
 /**
  * Represents the color settings available in the editor.