@cesdk/node 1.11.0-preview.1 → 1.11.0-preview.2

package/example.js

@@ -5,7 +5,8 @@ const CreativeEngine = require('./index.js');
 
 const { DesignBlockType, MimeType } = CreativeEngine;
 
-CreativeEngine.init().then((engine) => {
+CreativeEngine.init().then(async (engine) => {
+  await engine.addDefaultAssetSources();
   console.log('Loading scene');
   engine.scene
     .loadFromURL(`file://${__dirname}/demo.scene`)

package/index.d.ts

@@ -2306,9 +2306,60 @@ declare class CreativeEngine {
      * @returns An engine instance.
      */
     static init(config?: Partial<Configuration> & OldConfiguration): Promise<CreativeEngine>;
+    /**
+     * Convenience function that registers a set of asset sources containing our
+     * default assets. These are
+     *
+     * - `'ly.img.sticker'` - Various stickers
+     * - `'ly.img.vectorpath'` - Shapes and arrows
+     * - `'ly.img.filter.lut'` - LUT effects of various kinds.
+     * - `'ly.img.filter.duotone'` - LUT effects of various kinds.
+     *
+     * These assets are parsed from the IMG.LY CDN at \{\{base_url\}\}/<id>/content.json, where
+     * `base_url` defaults to 'https://cdn.img.ly/assets/v1'.
+     * Each source is created via `addLocalSource` and populated with the parsed assets. To modify the available
+     * assets, you may either exclude certain IDs via `excludeAssetSourceIds` or alter the sources after creation.
+     */
+    addDefaultAssetSources({ baseURL, excludeAssetSourceIds }?: {
+        /** The source of the asset definitions, must be absolute. Defaults to `'https://cdn.img.ly/assets/v1'`. */
+        baseURL?: string;
+        /** A list of IDs, that will be ignored during load. */
+        excludeAssetSourceIds?: DefaultAssetSourceId[];
+    }): Promise<void>;
+    /**
+     * Convenience function that registers a set of demo asset sources containing our
+     * example assets. These are not to meant to be used in your production code.
+     *
+     * These are
+     *
+     * - `'ly.img.image'` - Sample images
+     * - `'ly.img.image.upload'` - Demo source to upload image assets
+     * - `'ly.img.audio'` - Sample audios
+     * - `'ly.img.audio.upload'` - Demo source to upload audio assets
+     * - `'ly.img.video'` - Sample videos
+     * - `'ly.img.video.upload'` - Demo source to upload video assets
+     */
+    addDemoAssetSources({ excludeAssetSourceIds, sceneMode, withUploadAssetSources }?: {
+        /** A list of IDs, that will be ignored during load */
+        excludeAssetSourceIds?: DemoAssetSourceId[];
+        /** If 'Video' video specific demo asset sources will be loaded as well (default 'Design') */
+        sceneMode?: SceneMode;
+        /** If 'true' asset sources for uploads are added (default false) */
+        withUploadAssetSources?: boolean;
+    }): Promise<void>;
 }
 export default CreativeEngine;
 
+/**
+ * @public
+ */
+export declare type DefaultAssetSourceId = 'ly.img.sticker' | 'ly.img.vectorpath' | 'ly.img.filter.lut' | 'ly.img.filter.duotone';
+
+/**
+ * @public
+ */
+export declare type DemoAssetSourceId = 'ly.img.image.upload' | 'ly.img.video.upload' | 'ly.img.audio.upload' | 'ly.img.image' | 'ly.img.video' | 'ly.img.audio';
+
 /**
  * A numerical identifier for a design block
  * @public
@@ -2790,6 +2841,7 @@ declare enum MimeType_2 {
     Jpeg = "image/jpeg",
     Tga = "image/x-tga",
     Mp4 = "video/mp4",
+    QuickTime = "video/quicktime",
     Binary = "application/octet-stream",
     Pdf = "application/pdf",
     Zip = "application/zip"