@cesdk/node 1.64.0-nightly.20251104 → 1.64.0-nightly.20251105

package/index.d.ts

@@ -357,13 +357,20 @@ 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",
@@ -381,9 +388,31 @@ 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): Promise<string>;
+    addLocalAssetSourceFromJSONString(contentJSON: string, basePath?: string, options?: {
+        matcher?: string[];
+    }): Promise<string>;
     /**
      * Creates a new local asset source from a JSON URI.
      *
@@ -397,38 +426,28 @@ 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 audio assets from IMG.LY's CDN
+     * // Load all 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"
      *
-     * // 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>;
+     * // 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>;
     /**
      * Remove a registered asset source.
      *