@cesdk/cesdk-js 1.9.1 → 1.10.0-preview.0

package/index.d.ts

@@ -25,21 +25,24 @@ export declare class API {
  */
 export declare interface Asset {
     /**
-     *  Is a combination of source id, extension pack id (optional), type and asset id
-     *  e.g. "extension://ly.img.cesdk.images.samples/ly.img.image/sample.1"
+     * The unique id of this asset.
      */
     id: string;
-    /**   E.g. `ly.img.image` */
     /**  Groups of the asset.  */
     groups?: Groups;
-    /** URI to a thumbnail of the asset used e.g. in the content library UI */
-    thumbUri: string;
-
     /** Asset-specific and custom meta information */
     meta?: {
+        /** The mime type of this asset or the data behind the asset's uri. */
+        mimeType?: string;
+        /** The type id of the design block that should be created from this asset. */
+        blockType?: string;
         uri?: string;
+        thumbUri?: string;
+        previewUri?: string;
         filename?: string;
         vectorPath?: string;
+        width?: number;
+        height?: number;
         duration?: string;
     } & Record<string, unknown>;
 }
@@ -55,6 +58,16 @@ export declare class AssetAPI {
      * @param source - The asset source.
      */
     addSource(source: AssetSource): void;
+    /**
+     * Adds a local asset source. Its ID has to be unique.
+     * @param source - The asset source.
+     * @param supportedMimeTypes - The mime types of assets that are allowed to be added to this local source.
+     * @param applyAsset - An optional callback that can be used to override the default behavior of applying a given
+     * asset result to the active scene.
+     * @param applyAssetToBlock - An optional callback that can be used to override the default behavior of applying
+     * an asset result to a given block.
+     */
+    addLocalSource(id: string, supportedMimeTypes?: string[], applyAsset?: (asset: AssetResult) => Promise<DesignBlockId | undefined>, applyAssetToBlock?: (asset: AssetResult, block: DesignBlockId) => Promise<void>): void;
     /**
      * Removes an asset source with the given ID.
      * @param id - The ID to refer to the asset source.
@@ -78,6 +91,7 @@ export declare class AssetAPI {
      * @returns The asset groups.
      */
     getGroups(id: string): Promise<string[]>;
+    getSupportedMimeTypes(sourceId: string): string[];
     /**
      * Queries the asset source's credits info.
      * @param sourceId - The ID of the asset source.
@@ -97,8 +111,18 @@ export declare class AssetAPI {
         url: string | undefined;
     } | undefined;
     canManageAssets(sourceId: string): boolean;
-
-
+    /**
+     * Adds the given asset to a local asset source.
+     * @param sourceId - The local asset source ID that the asset should be added to.
+     * @param asset - The asset to be added to the asset source.
+     */
+    addAssetToSource(sourceId: string, asset: AssetDefinition): void;
+    /**
+     * Removes the specified asset from its local asset source.
+     * @param sourceId - The id of the local asset source that currently contains the asset.
+     * @param assetId - The id of the asset to be removed.
+     */
+    removeAssetFromSource(sourceId: string, assetId: string): void;
 
 
     /**
@@ -108,7 +132,7 @@ export declare class AssetAPI {
      * @param sourceId - The ID of the asset source.
      * @param assetResult - A single assetResult of a `findAssets` query.
      */
-    apply(sourceId: string, assetResult: AssetResult): Promise<void>;
+    apply(sourceId: string, assetResult: AssetResult): Promise<DesignBlockId | undefined>;
     /**
      * Apply an asset result to the given block.
      * @param sourceId - The ID of the asset source.
@@ -121,7 +145,7 @@ export declare class AssetAPI {
      * This implementation is used when no `applyAsset` function is provided to `addSource`.
      * @param assetResult - A single assetResult of a `findAssets` query.
      */
-    defaultApplyAsset(assetResult: AssetResult): Promise<void>;
+    defaultApplyAsset(assetResult: AssetResult): Promise<DesignBlockId | undefined>;
     /**
      * The default implementation for applying an asset to an existing block.
      * @param assetResult - A single assetResult of a `findAssets` query.
@@ -132,7 +156,7 @@ export declare class AssetAPI {
 }
 
 /**
- * Definition of an assets used if an asset is added to an asset source.
+ * Definition of an asset used if an asset is added to an asset source.
  * @public
  */
 export declare interface AssetDefinition extends Asset {
@@ -150,14 +174,6 @@ export declare interface AssetDefinition extends Asset {
     tags?: Record<Locale, string[]>;
 }
 
-/** @public */
-export declare interface _AssetElement {
-    id: string;
-    name: string;
-    uri: string;
-    thumbUri: string;
-}
-
 /** @public */
 declare type AssetLibraryEntries = AssetLibraryEntry[] | ((currentAssetLibraryEntries: AssetLibraryEntry[], context: {
     selectedBlocks: {
@@ -297,13 +313,6 @@ export declare interface AssetResult extends Asset {
 declare interface AssetResult_2 {
     /** A unique id of this asset */
     id: string;
-    /** URI to a thumbnail of the asset used e.g. in the content library UI */
-    thumbUri: string;
-    /** Original size of the asset. */
-    size: {
-        width: number;
-        height: number;
-    };
     /** Asset-specific and custom meta information */
     meta?: {
         uri?: string;
@@ -371,16 +380,17 @@ export declare interface AssetSource {
      */
     getAsset?(id: string): Promise<AssetResult | undefined>;
     /**
-     * Can the source add, update and remove assets dynamically? If `false`
-     * methods like `addAsset` `updateAsset` and `removeAsset` will throw an
+     * Can the source add and remove assets dynamically? If `false`
+     * methods like `addAsset` and `removeAsset` will throw an
      * error.
      */
     canManageAssets?: boolean;
     /**
      * Apply the given asset result to the active scene.
      * You can override this with custom behavior.
+     * @returns the id of a new block if one was created from the asset.
      */
-    applyAsset?: (asset: AssetResult) => Promise<void>;
+    applyAsset?: (asset: AssetResult) => Promise<DesignBlockId | undefined>;
     /**
      * Apply the given asset result to the given block.
      * You can override this with custom behavior.
@@ -390,16 +400,8 @@ export declare interface AssetSource {
      * Adds the given asset to this source. Throws an error if `canManageAssets`
      * is `false`.
      *
-     * @returns the id of the added asset
      */
-    addAsset?(asset: AssetDefinition): Promise<string>;
-    /**
-     * Updates the asset of this source. Throws an error if `canManageAssets`
-     * is `false` or no asset with the given id could not be found.
-     *
-     * @returns the id of the added asset
-     */
-    updateAsset?(assetId: string, asset: AssetDefinition): Promise<void>;
+    addAsset?(asset: AssetDefinition): void;
     /**
      * Removes the given asset from this source.
      *
@@ -425,7 +427,7 @@ declare interface AssetSource_2 {
      * Apply the given asset result to the active scene.
      * You can override this with custom behavior.
      */
-    applyAsset?: (asset: AssetResult_2) => Promise<void>;
+    applyAsset?: (asset: AssetResult_2) => Promise<DesignBlockId | undefined>;
     /**
      * Apply the given asset result to the given block.
      * You can override this with custom behavior.
@@ -561,6 +563,7 @@ export declare class BlockAPI {
     /**
      * Loads existing blocks from the given string.
      * The blocks are not attached by default and won't be visible until attached to a page or the scene.
+     * The UUID of the loaded blocks is replaced with a new one.
      * @param content - A string representing the given blocks.
      * @returns A promise that resolves with a list of handles representing the found blocks or an error.
      */
@@ -584,13 +587,17 @@ export declare class BlockAPI {
      * @returns The created fill's handle.
      */
     createFill(type: string): DesignBlockId;
-
     /**
      * Get the type of the given block, fails if the block is invalid.
      * @param id - The block to query.
      * @returns The blocks type.
      */
     getType(id: DesignBlockId): DesignBlockType;
+    /**
+     * Selects the given block and deselects all other blocks.
+     * @param id - The block to be selected.
+     */
+    select(id: DesignBlockId): void;
     /**
      * Update the selection state of a block.
      * Fails for invalid blocks.
@@ -855,15 +862,29 @@ export declare class BlockAPI {
      */
     setContentFillMode(id: DesignBlockId, mode: ContentFillMode): void;
     /**
-     * Get a block's layout width. The layout width is only available after an
-     * internal update loop, which may not happen immediately.
+     * Get a block's layout position on the x-axis. The position is only available after an
+     * internal update loop which only occurs if the `features/implicitUpdatesEnabled` setting is set.
+     * @param id - The block to query.
+     * @returns The layout position on the x-axis.
+     */
+    getFrameX(id: DesignBlockId): number;
+    /**
+     * Get a block's layout position on the y-axis. The position is only available after an
+     * internal update loop which only occurs if the `features/implicitUpdatesEnabled` setting is set.
+     * @param id - The block to query.
+     * @returns The layout position on the y-axis.
+     */
+    getFrameY(id: DesignBlockId): number;
+    /**
+     * Get a block's layout width. The width is only available after an
+     * internal update loop which only occurs if the `features/implicitUpdatesEnabled` setting is set.
      * @param id - The block to query.
      * @returns The layout width.
      */
     getFrameWidth(id: DesignBlockId): number;
     /**
-     * Get a block's layout height. The layout height is only available after an
-     * internal update loop, which may not happen immediately.
+     * Get a block's layout height. The height is only available after an
+     * internal update loop which only occurs if the `features/implicitUpdatesEnabled` setting is set.
      * @param id - The block to query.
      * @returns The layout height.
      */
@@ -1990,6 +2011,48 @@ export declare class BlockAPI {
      * @returns Whether solo playback is enabled for this block.
      */
     isSoloPlaybackEnabled(id: DesignBlockId): boolean;
+    /**
+     * Returns whether the block supports a playback control.
+     * @param block - The block to query.
+     * @returns Whether the block has playback control.
+     */
+    hasPlaybackControl(id: DesignBlockId): boolean;
+    /**
+     * Set whether the block should start from the beginning again or stop.
+     * @param block - The block or video fill to update.
+     * @param looping - Whether the block should loop to the beginning or stop.
+     */
+    setLooping(id: DesignBlockId, looping: boolean): void;
+    /**
+     * Query whether the block is looping.
+     * @param block - The block to query.
+     * @returns Whether the block is looping.
+     */
+    isLooping(id: DesignBlockId): boolean;
+    /**
+     * Set whether the audio of the block is muted.
+     * @param block - The block or video fill to update.
+     * @param muted - Whether the audio should be muted.
+     */
+    setMuted(id: DesignBlockId, muted: boolean): void;
+    /**
+     * Query whether the block is muted.
+     * @param block - The block to query.
+     * @returns Whether the block is muted.
+     */
+    isMuted(id: DesignBlockId): boolean;
+    /**
+     * Set the audio volume of the given block.
+     * @param block - The block or video fill to update.
+     * @param volume - The desired volume with a range of [0, 1].
+     */
+    setVolume(id: DesignBlockId, volume: number): void;
+    /**
+     * Get the audio volume of the given block.
+     * @param block - The block to query.
+     * @returns The volume with a range of [0, 1].
+     */
+    getVolume(id: DesignBlockId): number;
     /**
      * Begins loading the required audio and video resource for the given video fill or audio block.
      * @param id - The video fill or audio block whose resource should be loaded.
@@ -2088,9 +2151,6 @@ declare namespace ConfigTypes {
         _RequiredConfiguration as Configuration,
         Theme,
         Scale,
-        PartialImageElement,
-        PartialVideoElement,
-        PartialAudioElement,
         I18n,
         A11y,
         OnUploadCallback,
@@ -2186,16 +2246,6 @@ declare class CreativeEditorSDK {
     setVariableDefinitions(definitions: {
         [id: string]: _EngineConfigTypes.VariableDefinition;
     }): Promise<void>;
-    /**
-     * Adds an image definition which can be used in the image library.
-     *
-     * @param definitions - image definitions
-     *
-     * @returns a resolved promise if all images were add successfully
-     */
-    setImageDefinitions(definitions: {
-        [id: string]: _EngineConfigTypes.ImageDefinition;
-    }): Promise<void[]>;
     /**
      * Adds translations to be used by the editor.
      *
@@ -2469,6 +2519,16 @@ export declare class EditorAPI {
      * @returns The value as string.
      */
     getSettingEnum(keypath: string): string;
+    /**
+     * Get the currently available memory in bytes.
+     * @returns The currently available memory in bytes.
+     */
+    getAvailableMemory(): number;
+    /**
+     * Get the current memory usage of the engine in bytes.
+     * @returns The current memory usage in bytes.
+     */
+    getUsedMemory(): number;
     /**
      * Sets a custom URI resolver.
      * This function can be called more than once. Subsequent calls will overwrite previous calls.
@@ -2796,15 +2856,6 @@ declare type ImageDefinition = Preset & {
     };
 };
 
-/** @public */
-export declare interface _ImageElement extends _AssetElement {
-    previewUri?: string;
-    size: {
-        width: number;
-        height: number;
-    };
-}
-
 /**
  * e.g. `en`, `de`, etc.
  * @public
@@ -2840,7 +2891,7 @@ declare enum NavigationPosition {
 }
 
 /** @public */
-declare type OnUploadCallback = (file: File, onProgress: (progress: number) => void) => Promise<PartialImageElement | PartialVideoElement | PartialAudioElement>;
+declare type OnUploadCallback = (file: File, onProgress: (progress: number) => void) => Promise<AssetDefinition>;
 
 /** @public */
 declare type OnUploadOptions = {
@@ -2888,15 +2939,6 @@ declare enum PanelPosition {
     Right = "right"
 }
 
-/** @public */
-declare type PartialAudioElement = Optional<AudioElement, 'duration'>;
-
-/** @public */
-declare type PartialImageElement = Optional<_ImageElement, 'size'>;
-
-/** @public */
-declare type PartialVideoElement = Optional<VideoElement, 'size' | 'duration'>;
-
 /**
  * - Absolute: Position in absolute design units.
  * - Percent: Position in relation to the block's parent's size in percent, where 1.0 means 100%.
@@ -3106,6 +3148,11 @@ export declare class SceneAPI {
      * @returns The current mode of the scene.
      */
     getMode(): SceneMode;
+    /**
+     * Get the sorted list of pages in the scene.
+     * @returns The sorted list of pages in the scene.
+     */
+    getPages(): DesignBlockId[];
     /**
      * Sets the zoom level of the active scene.
      * Only has an effect if the zoom level is not handled by the UI.
@@ -3288,6 +3335,8 @@ declare namespace UserInterfaceElements {
         UserInterfaceInspectorBlockPage,
         UserInterfaceInspectorBlockText,
         UserInterfaceInspectorBlockImage,
+        UserInterfaceInspectorBlockVideoFill,
+        UserInterfaceInspectorBlockRectShape,
         UserInterfaceInspector,
         UserInterfaceSettings,
         UserInterfaceAssetLibrary,
@@ -3373,12 +3422,22 @@ declare interface UserInterfaceInspectorBlockPage extends UserInterfaceInspector
     manage?: UserInterfaceElement | boolean;
 }
 
+/** @public */
+declare interface UserInterfaceInspectorBlockRectShape extends UserInterfaceInspectorBlock {
+    filters?: UserInterfaceElement | boolean;
+    adjustments?: UserInterfaceElement | boolean;
+    effects?: UserInterfaceElement | boolean;
+    blur?: UserInterfaceElement | boolean;
+}
+
 /** @public */
 declare interface UserInterfaceInspectorBlocks {
     opacity?: UserInterfaceElement | boolean;
     transform?: UserInterfaceElement | boolean;
     trim?: UserInterfaceElement | boolean;
     '//ly.img.ubq/image'?: UserInterfaceInspectorBlockImage;
+    '//ly.img.ubq/fill/video': UserInterfaceInspectorBlockVideoFill;
+    '//ly.img.ubq/shapes/rect': UserInterfaceInspectorBlockRectShape;
     '//ly.img.ubq/text'?: UserInterfaceInspectorBlockText;
     '//ly.img.ubq/page'?: UserInterfaceInspectorBlockPage;
 }
@@ -3389,6 +3448,15 @@ declare interface UserInterfaceInspectorBlockText extends UserInterfaceInspector
     color?: UserInterfaceElement | boolean;
 }
 
+/** @public */
+declare interface UserInterfaceInspectorBlockVideoFill extends UserInterfaceInspectorBlock {
+    crop?: UserInterfaceElement | boolean;
+    filters?: UserInterfaceElement | boolean;
+    adjustments?: UserInterfaceElement | boolean;
+    effects?: UserInterfaceElement | boolean;
+    blur?: UserInterfaceElement | boolean;
+}
+
 /** @public */
 declare interface UserInterfaceNavigation extends UserInterfaceElement {
     position?: NavigationPosition;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cesdk/cesdk-js",
-  "version": "1.9.1",
+  "version": "1.10.0-preview.0",
   "main": "./cesdk.umd.js",
   "types": "./index.d.ts",
   "homepage": "https://www.img.ly",