@cesdk/node 1.64.0-nightly.20251106 → 1.64.0-rc.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/index.d.ts CHANGED
@@ -357,20 +357,13 @@ export declare class AssetAPI {
357
357
  * and an `assets` array with asset definitions. Each asset should have an `id`, localized `label` object,
358
358
  * and a `meta` object containing asset-specific properties like `uri`, `thumbUri`, `blockType`, etc.
359
359
  *
360
- * Optionally, you can provide a `basePath` for resolving relative URLs and additional options including a
361
- * `matcher` array to filter which assets are loaded based on their IDs. The matcher patterns support wildcard
362
- * matching using `*`. If multiple patterns are provided, an asset is included if it matches ANY of the patterns.
363
- *
364
360
  * @category Asset Source Management
365
361
  * @param contentJSON - The JSON string containing the asset definitions.
366
362
  * @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.
367
- * @param options - Optional configuration:
368
- * - `matcher`: Array of patterns to filter assets by ID. Supports `*` wildcard. An asset is included if it matches ANY pattern.
369
363
  * @returns The ID of the newly created asset source (as specified in the JSON's `id` field).
370
364
  *
371
365
  * @example
372
366
  * ```javascript
373
- * // Load all assets from JSON
374
367
  * const json = JSON.stringify({
375
368
  * "version": "2.0.0",
376
369
  * "id": "my.custom.assets",
@@ -388,31 +381,9 @@ export declare class AssetAPI {
388
381
  * });
389
382
  * const sourceId = await engine.asset.addLocalAssetSourceFromJSONString(json);
390
383
  * console.log('Created asset source:', sourceId); // "my.custom.assets"
391
- *
392
- * // Load with custom base path
393
- * const sourceId2 = await engine.asset.addLocalAssetSourceFromJSONString(
394
- * json,
395
- * 'https://example.com/'
396
- * );
397
- *
398
- * // Load only assets matching one of the patterns
399
- * const sourceId3 = await engine.asset.addLocalAssetSourceFromJSONString(
400
- * json,
401
- * undefined,
402
- * { matcher: ['sample_*', '*_asset'] }
403
- * );
404
- *
405
- * // Load with custom base path and matcher
406
- * const sourceId4 = await engine.asset.addLocalAssetSourceFromJSONString(
407
- * json,
408
- * 'https://example.com/',
409
- * { matcher: ['portrait_*', 'landscape_*'] }
410
- * );
411
384
  * ```
412
385
  */
413
- addLocalAssetSourceFromJSONString(contentJSON: string, basePath?: string, options?: {
414
- matcher?: string[];
415
- }): Promise<string>;
386
+ addLocalAssetSourceFromJSONString(contentJSON: string, basePath?: string): Promise<string>;
416
387
  /**
417
388
  * Creates a new local asset source from a JSON URI.
418
389
  *
@@ -426,28 +397,38 @@ export declare class AssetAPI {
426
397
  *
427
398
  * @category Asset Source Management
428
399
  * @param contentURI - The URI for the JSON file to load and parse.
429
- * @param options - Optional configuration:
430
- * - `matcher`: Array of patterns to filter assets by ID. Supports `*` wildcard. An asset is included if it matches ANY pattern.
431
400
  * @returns The ID of the newly created asset source (as specified in the JSON's `id` field).
432
401
  *
433
402
  * @example
434
403
  * ```javascript
435
- * // Load all audio assets from IMG.LY's CDN
404
+ * // Load audio assets from IMG.LY's CDN
436
405
  * const sourceId = await engine.asset.addLocalAssetSourceFromJSONURI(
437
406
  * 'https://cdn.img.ly/assets/demo/v2/ly.img.audio/content.json'
438
407
  * );
439
408
  * console.log('Loaded asset source:', sourceId); // "ly.img.audio"
440
409
  *
441
- * // Load only assets matching one of the patterns
442
- * const sourceId2 = await engine.asset.addLocalAssetSourceFromJSONURI(
443
- * 'https://cdn.img.ly/assets/demo/v2/ly.img.image/content.json',
444
- * { matcher: ['image-portrait-*', 'image-landscape-*'] }
445
- * );
446
- * ```
447
- */
448
- addLocalAssetSourceFromJSONURI(contentURI: string, options?: {
449
- matcher?: string[];
450
- }): Promise<string>;
410
+ * // The parent directory (https://cdn.img.ly/assets/demo/v2/ly.img.audio/)
411
+ * // will be used as base path for resolving relative asset URLs
412
+ *
413
+ * // The JSON at this URL contains audio assets with structure like:
414
+ * // {
415
+ * // "version": "2.0.0",
416
+ * // "id": "ly.img.audio",
417
+ * // "assets": [
418
+ * // {
419
+ * // "id": "dance_harder",
420
+ * // "label": { "en": "Dance Harder" },
421
+ * // "meta": {
422
+ * // "uri": "https://cdn.img.ly/.../dance_harder.m4a",
423
+ * // "blockType": "//ly.img.ubq/audio",
424
+ * // "mimeType": "audio/x-m4a"
425
+ * // }
426
+ * // }
427
+ * // ]
428
+ * // }
429
+ * ```
430
+ */
431
+ addLocalAssetSourceFromJSONURI(contentURI: string): Promise<string>;
451
432
  /**
452
433
  * Remove a registered asset source.
453
434
  *
@@ -5575,7 +5556,7 @@ export declare type BlurTypeShorthand = (typeof BLUR_TYPES)[number];
5575
5556
  export declare type BooleanOperation = 'Difference' | 'Intersection' | 'Union' | 'XOR';
5576
5557
 
5577
5558
  /** @public */
5578
- export declare type BoolPropertyName = 'alwaysOnBottom' | 'alwaysOnTop' | 'clipped' | 'flip/horizontal' | 'flip/vertical' | 'highlightEnabled' | 'includedInExport' | 'placeholder/enabled' | 'playback/playing' | 'playback/soloPlaybackEnabled' | 'scene/aspectRatioLock' | 'selected' | 'transformLocked' | 'visible' | 'blur/enabled' | 'dropShadow/clip' | 'dropShadow/enabled' | 'fill/enabled' | 'page/marginEnabled' | 'placeholderControls/showButton' | 'placeholderControls/showOverlay' | 'playback/looping' | 'playback/muted' | 'stroke/enabled' | 'backgroundColor/enabled' | 'placeholderBehavior/enabled' | 'text/automaticFontSizeEnabled' | 'text/clipLinesOutsideOfFrame' | 'text/hasClippedLines' | 'track/automaticallyManageBlockOffsets' | 'caption/automaticFontSizeEnabled' | 'caption/clipLinesOutsideOfFrame' | 'caption/hasClippedLines' | 'captionTrack/automaticallyManageBlockOffsets' | 'animation/slide/fade' | 'animation/pan/fade' | 'animation/blur/fade' | 'animation/zoom/fade' | 'animation/crop_zoom/fade' | 'animation/spin/fade' | 'animation/block_swipe_text/useTextColor' | 'animation/spread_text/fade' | 'animation/ken_burns/fade' | 'effect/enabled' | (string & {});
5559
+ export declare type BoolPropertyName = 'alwaysOnBottom' | 'alwaysOnTop' | 'clipped' | 'flip/horizontal' | 'flip/vertical' | 'highlightEnabled' | 'includedInExport' | 'placeholder/enabled' | 'playback/playing' | 'playback/soloPlaybackEnabled' | 'scene/aspectRatioLock' | 'selected' | 'selectionEnabled' | 'transformLocked' | 'visible' | 'blur/enabled' | 'dropShadow/clip' | 'dropShadow/enabled' | 'fill/enabled' | 'page/marginEnabled' | 'placeholderControls/showButton' | 'placeholderControls/showOverlay' | 'playback/looping' | 'playback/muted' | 'stroke/enabled' | 'backgroundColor/enabled' | 'placeholderBehavior/enabled' | 'text/automaticFontSizeEnabled' | 'text/clipLinesOutsideOfFrame' | 'text/hasClippedLines' | 'track/automaticallyManageBlockOffsets' | 'caption/automaticFontSizeEnabled' | 'caption/clipLinesOutsideOfFrame' | 'caption/hasClippedLines' | 'captionTrack/automaticallyManageBlockOffsets' | 'animation/slide/fade' | 'animation/pan/fade' | 'animation/blur/fade' | 'animation/zoom/fade' | 'animation/crop_zoom/fade' | 'animation/spin/fade' | 'animation/block_swipe_text/useTextColor' | 'animation/spread_text/fade' | 'animation/ken_burns/fade' | 'effect/enabled' | (string & {});
5579
5560
 
5580
5561
  /**
5581
5562
  * Represents a buffer of data.
@@ -8372,6 +8353,7 @@ export declare interface Settings {
8372
8353
 
8373
8354
 
8374
8355
 
8356
+
8375
8357
 
8376
8358
 
8377
8359
  }
@@ -8447,7 +8429,7 @@ export declare type SettingsInt = SettingIntPropertyName;
8447
8429
  export declare type SettingsString = SettingStringPropertyName;
8448
8430
 
8449
8431
  /** @public */
8450
- export declare type SettingStringPropertyName = 'basePath' | 'defaultEmojiFontFileUri' | 'defaultFontFileUri' | 'upload/supportedMimeTypes' | 'license' | 'page/title/separator' | 'page/title/fontFileUri' | 'fallbackFontUri' | (string & {});
8432
+ export declare type SettingStringPropertyName = 'basePath' | 'defaultEmojiFontFileUri' | 'defaultFontFileUri' | 'upload/supportedMimeTypes' | 'license' | 'web/fetchCredentials' | 'page/title/separator' | 'page/title/fontFileUri' | 'fallbackFontUri' | (string & {});
8451
8433
 
8452
8434
  /**
8453
8435
  * Represents the type of a setting.