@cesdk/engine 1.65.0-rc.0 → 1.65.0

package/index.d.ts

@@ -357,20 +357,13 @@ export declare class AssetAPI {
      * and an `assets` array with asset definitions. Each asset should have an `id`, localized `label` object,
      * and a `meta` object containing asset-specific properties like `uri`, `thumbUri`, `blockType`, etc.
      *
-     * Optionally, you can provide a `basePath` for resolving relative URLs and additional options including a
-     * `matcher` array to filter which assets are loaded based on their IDs. The matcher patterns support wildcard
-     * matching using `*`. If multiple patterns are provided, an asset is included if it matches ANY of the patterns.
-     *
      * @category Asset Source Management
      * @param contentJSON - The JSON string containing the asset definitions.
      * @param basePath - An optional base path with which \{\{base_url\}\} strings in the assets should be replaced. If no value is provided, settings.basePath is used.
-     * @param options - Optional configuration:
-     *   - `matcher`: Array of patterns to filter assets by ID. Supports `*` wildcard. An asset is included if it matches ANY pattern.
      * @returns The ID of the newly created asset source (as specified in the JSON's `id` field).
      *
      * @example
      * ```javascript
-     * // Load all assets from JSON
      * const json = JSON.stringify({
      *   "version": "2.0.0",
      *   "id": "my.custom.assets",
@@ -388,31 +381,9 @@ export declare class AssetAPI {
      * });
      * const sourceId = await engine.asset.addLocalAssetSourceFromJSONString(json);
      * console.log('Created asset source:', sourceId); // "my.custom.assets"
-     *
-     * // Load with custom base path
-     * const sourceId2 = await engine.asset.addLocalAssetSourceFromJSONString(
-     *   json,
-     *   'https://example.com/'
-     * );
-     *
-     * // Load only assets matching one of the patterns
-     * const sourceId3 = await engine.asset.addLocalAssetSourceFromJSONString(
-     *   json,
-     *   undefined,
-     *   { matcher: ['sample_*', '*_asset'] }
-     * );
-     *
-     * // Load with custom base path and matcher
-     * const sourceId4 = await engine.asset.addLocalAssetSourceFromJSONString(
-     *   json,
-     *   'https://example.com/',
-     *   { matcher: ['portrait_*', 'landscape_*'] }
-     * );
      * ```
      */
-    addLocalAssetSourceFromJSONString(contentJSON: string, basePath?: string, options?: {
-        matcher?: string[];
-    }): Promise<string>;
+    addLocalAssetSourceFromJSONString(contentJSON: string, basePath?: string): Promise<string>;
     /**
      * Creates a new local asset source from a JSON URI.
      *
@@ -426,28 +397,38 @@ export declare class AssetAPI {
      *
      * @category Asset Source Management
      * @param contentURI - The URI for the JSON file to load and parse.
-     * @param options - Optional configuration:
-     *   - `matcher`: Array of patterns to filter assets by ID. Supports `*` wildcard. An asset is included if it matches ANY pattern.
      * @returns The ID of the newly created asset source (as specified in the JSON's `id` field).
      *
      * @example
      * ```javascript
-     * // Load all audio assets from IMG.LY's CDN
+     * // Load audio assets from IMG.LY's CDN
      * const sourceId = await engine.asset.addLocalAssetSourceFromJSONURI(
      *   'https://cdn.img.ly/assets/demo/v2/ly.img.audio/content.json'
      * );
      * console.log('Loaded asset source:', sourceId); // "ly.img.audio"
      *
-     * // Load only assets matching one of the patterns
-     * const sourceId2 = await engine.asset.addLocalAssetSourceFromJSONURI(
-     *   'https://cdn.img.ly/assets/demo/v2/ly.img.image/content.json',
-     *   { matcher: ['image-portrait-*', 'image-landscape-*'] }
-     * );
-     * ```
-     */
-    addLocalAssetSourceFromJSONURI(contentURI: string, options?: {
-        matcher?: string[];
-    }): Promise<string>;
+     * // The parent directory (https://cdn.img.ly/assets/demo/v2/ly.img.audio/)
+     * // will be used as base path for resolving relative asset URLs
+     *
+     * // The JSON at this URL contains audio assets with structure like:
+     * // {
+     * //   "version": "2.0.0",
+     * //   "id": "ly.img.audio",
+     * //   "assets": [
+     * //     {
+     * //       "id": "dance_harder",
+     * //       "label": { "en": "Dance Harder" },
+     * //       "meta": {
+     * //         "uri": "https://cdn.img.ly/.../dance_harder.m4a",
+     * //         "blockType": "//ly.img.ubq/audio",
+     * //         "mimeType": "audio/x-m4a"
+     * //       }
+     * //     }
+     * //   ]
+     * // }
+     * ```
+     */
+    addLocalAssetSourceFromJSONURI(contentURI: string): Promise<string>;
     /**
      * Remove a registered asset source.
      *
@@ -8172,9 +8153,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.
+     * @param waitForResources - Whether to wait for all resources to finish loading before resolving. Defaults to false.
      * @returns A handle to the loaded scene.
      */
-    loadFromString(sceneContent: string, overrideEditorConfig?: boolean): Promise<DesignBlockId>;
+    loadFromString(sceneContent: string, overrideEditorConfig?: boolean, waitForResources?: boolean): Promise<DesignBlockId>;
     /**
      * Load a scene from the URL to the scene file.
      *
@@ -8188,9 +8170,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.
+     * @param waitForResources - Whether to wait for all resources to finish loading before resolving. Defaults to false.
      * @returns scene A promise that resolves once the scene was loaded or rejects with an error otherwise.
      */
-    loadFromURL(url: string, overrideEditorConfig?: boolean): Promise<DesignBlockId>;
+    loadFromURL(url: string, overrideEditorConfig?: boolean, waitForResources?: boolean): Promise<DesignBlockId>;
     /**
      * Load a previously archived scene from the URL to the scene file.
      *
@@ -8200,9 +8183,10 @@ export declare class SceneAPI {
      * @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.
+     * @param waitForResources - Whether to wait for all resources to finish loading before resolving. Defaults to false.
      * @returns scene A promise that resolves once the scene was loaded or rejects with an error otherwise.
      */
-    loadFromArchiveURL(url: string, overrideEditorConfig?: boolean): Promise<DesignBlockId>;
+    loadFromArchiveURL(url: string, overrideEditorConfig?: boolean, waitForResources?: boolean): Promise<DesignBlockId>;
     /**
      * Serializes the current scene into a string. Selection is discarded.
      *
@@ -8570,6 +8554,7 @@ export declare class SceneAPI {
     isZoomAutoFitEnabled(blockOrScene: DesignBlockId): boolean;
     /**
      * Continually ensures the camera position to be within the width and height of the blocks axis-aligned bounding box.
+     * Disables any previously set camera position clamping in the scene and also takes priority over clamp camera commands.
      *
      * ```javascript
      * // Keep the scene with padding of 10px within the camera
@@ -8739,7 +8724,7 @@ export declare const SceneModeValues: readonly ["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 SettingBoolPropertyName = 'alwaysHighlightPlaceholders' | 'doubleClickToCropEnabled' | 'showBuildVersion' | 'placeholderControls/showButton' | 'placeholderControls/showOverlay' | 'blockAnimations/enabled' | 'renderTextCursorAndSelectionInEngine' | 'touch/dragStartCanSelect' | 'touch/singlePointPanning' | 'mouse/enableZoom' | 'mouse/enableScroll' | 'controlGizmo/showCropHandles' | 'controlGizmo/showMoveHandles' | 'controlGizmo/showResizeHandles' | 'controlGizmo/showScaleHandles' | 'controlGizmo/showRotateHandles' | 'controlGizmo/showCropScaleHandles' | 'page/title/show' | 'page/title/showPageTitleTemplate' | 'page/title/appendPageName' | 'page/title/showOnSinglePage' | 'page/dimOutOfPageAreas' | 'page/allowCropInteraction' | 'page/allowResizeInteraction' | 'page/restrictResizeInteractionToFixedAspectRatio' | 'page/allowRotateInteraction' | 'page/allowMoveInteraction' | 'page/moveChildrenWhenCroppingFill' | 'page/selectWhenNoBlocksSelected' | 'colorMaskingSettings/secondPass' | 'clampThumbnailTextureSizes' | 'useSystemFontFallback' | 'forceSystemEmojis' | (string & {});
+export declare type SettingBoolPropertyName = 'alwaysHighlightPlaceholders' | 'doubleClickToCropEnabled' | 'showBuildVersion' | 'placeholderControls/showButton' | 'placeholderControls/showOverlay' | 'blockAnimations/enabled' | 'renderTextCursorAndSelectionInEngine' | 'touch/dragStartCanSelect' | 'touch/singlePointPanning' | 'mouse/enableZoom' | 'mouse/enableScroll' | 'controlGizmo/showCropHandles' | 'controlGizmo/showMoveHandles' | 'controlGizmo/showResizeHandles' | 'controlGizmo/showScaleHandles' | 'controlGizmo/showRotateHandles' | 'controlGizmo/showCropScaleHandles' | 'page/title/show' | 'page/title/showPageTitleTemplate' | 'page/title/appendPageName' | 'page/title/showOnSinglePage' | 'page/dimOutOfPageAreas' | 'page/allowCropInteraction' | 'page/allowResizeInteraction' | 'page/restrictResizeInteractionToFixedAspectRatio' | 'page/allowRotateInteraction' | 'page/allowMoveInteraction' | 'page/moveChildrenWhenCroppingFill' | 'page/selectWhenNoBlocksSelected' | 'colorMaskingSettings/secondPass' | 'clampThumbnailTextureSizes' | 'useSystemFontFallback' | 'forceSystemEmojis' | 'features/textEditModeTransformHandlesEnabled' | (string & {});
 
 /** @public */
 export declare type SettingColorPropertyName = 'clearColor' | 'handleFillColor' | 'highlightColor' | 'pageHighlightColor' | 'placeholderHighlightColor' | 'snappingGuideColor' | 'rotationSnappingGuideColor' | 'cropOverlayColor' | 'textVariableHighlightColor' | 'borderOutlineColor' | 'progressColor' | 'errorStateColor' | 'page/title/color' | 'page/marginFillColor' | 'page/marginFrameColor' | 'page/innerBorderColor' | 'page/outerBorderColor' | 'colorMaskingSettings/maskColor' | (string & {});
@@ -8953,6 +8938,7 @@ export declare interface Settings {
 
 
 
+
 
 
 }