@cesdk/node 1.10.0-preview.1 → 1.10.0

package/index.d.ts

@@ -1,3 +1,7 @@
+declare type ArbitraryString = string & {
+    arbitrary?: any;
+};
+
 /**
  * Generic asset information
  * @public
@@ -102,7 +106,6 @@ export declare class AssetAPI {
      * @param assetId - The id of the asset to be removed.
      */
     removeAssetFromSource(sourceId: string, assetId: string): void;
-
     /**
      * Apply an asset result to the active scene.
      * The default behavior will instantiate a block and configure it according to the asset's properties.
@@ -130,6 +133,18 @@ export declare class AssetAPI {
      * @param block - The block to apply the asset result to.
      */
     defaultApplyAssetToBlock(assetResult: AssetResult, block: DesignBlockId): Promise<void>;
+    /**
+     * Register a callback to be called every time an asset source is added.
+     * @param callback - The function that is called whenever an asset source is added.
+     * @returns A method to unsubscribe.
+     */
+    onAssetSourceAdded: (callback: (sourceID: string) => void) => (() => void);
+    /**
+     * Register a callback to be called every time an asset source is removed.
+     * @param callback - The function that is called whenever an asset source is added.
+     * @returns A method to unsubscribe.
+     */
+    onAssetSourceRemoved: (callback: (sourceID: string) => void) => (() => void);
 
 }
 
@@ -272,14 +287,6 @@ export declare interface AssetSource {
         name: string;
         url?: string;
     };
-    /**
-     * Indicates if the asset shall be downloaded to handle the raw data instead
-     * of an URL reference. Do this if you do not want to depend on
-     * a service after adding the asset to the scene. If this is your own API
-     * with your own service, you do not need to set this and avoid downloading /
-     * re-uploading the assets.
-     */
-    downloadAssets?: (asset: AssetResult) => Promise<Blob>;
     /**
      * @returns the asset or undefined if no asset with the given id could be found
      */
@@ -288,6 +295,8 @@ export declare interface AssetSource {
      * Can the source add and remove assets dynamically? If `false`
      * methods like `addAsset` and `removeAsset` will throw an
      * error.
+     *
+     * @deprecated Will be removed in v1.11. Use `canAdd` and `canRemove` in the asset library configuration
      */
     canManageAssets?: boolean;
     /**
@@ -302,9 +311,8 @@ export declare interface AssetSource {
      */
     applyAssetToBlock?: (asset: AssetResult, block: DesignBlockId) => Promise<void>;
     /**
-     * Adds the given asset to this source. Throws an error if `canManageAssets`
-     * is `false`.
-     *
+     * Adds the given asset to this source. Throws an error if the asset source
+     * does not support adding assets.
      */
     addAsset?(asset: AssetDefinition): void;
     /**
@@ -339,14 +347,6 @@ declare interface AssetSource_2 {
 
     /** Return every available group */
     getGroups?: () => Promise<string[]>;
-    /**
-     * Indicates if the asset shall be downloaded to handle the raw data instead
-     * of an URL reference. Do this if you do not want to depend on
-     * a service after adding the asset to the scene. If this is your own API
-     * with your own service, you do not need to set this and avoid downloading /
-     * re-uploading the assets.
-     */
-    downloadAssets?: (asset: AssetResult_2) => Promise<Blob>;
     /** Credits for the source/api */
     credits?: {
         name: string;
@@ -546,9 +546,14 @@ export declare class BlockAPI {
     setName(id: DesignBlockId, name: string): void;
     /**
      * Get a block's name.
-     * @param id - The block to update.
+     * @param id - The block to query.
      */
     getName(id: DesignBlockId): string;
+    /**
+     * Get a block's UUID.
+     * @param id - The block to query.
+     */
+    getUUID(id: DesignBlockId): string;
     /**
      * Finds all blocks with the given name.
      * @param name - The name to search for.
@@ -1210,6 +1215,7 @@ export declare class BlockAPI {
      * Query if the given block has fill color properties.
      * @param id - The block to query.
      * @returns true, if the block has fill color properties.
+     * @deprecated Query the fills type using getFill() and getType() instead.
      */
     hasFillColor(id: DesignBlockId): boolean;
     /**
@@ -1220,24 +1226,28 @@ export declare class BlockAPI {
      * @param g - The green color component in the range of 0 to 1.
      * @param b - The blue color component in the range of 0 to 1.
      * @param a - The alpha color component in the range of 0 to 1.
+     * @deprecated Use setFillSolidColor() instead.
      */
     setFillColorRGBA(id: DesignBlockId, r: number, g: number, b: number, a?: number): void;
     /**
      * Get the fill color of the given design block.
      * @param id - The block whose fill color should be queried.
      * @returns The fill color.
+     * @deprecated Use getFillSolidColor() instead.
      */
     getFillColorRGBA(id: DesignBlockId): RGBA;
     /**
      * Enable or disable the fill of the given design block.
      * @param id - The block whose fill should be enabled or disabled.
      * @param enabled - If true, the fill will be enabled.
+     * @deprecated Use setFillEnabled() instead.
      */
     setFillColorEnabled(id: DesignBlockId, enabled: boolean): void;
     /**
      * Query if the fill of the given design block is enabled.
      * @param id - The block whose fill state should be queried.
      * @returns True, if fill is enabled.
+     * @deprecated Use isFillEnabled() instead."
      */
     isFillColorEnabled(id: DesignBlockId): boolean;
     /**
@@ -1632,12 +1642,14 @@ export declare class BlockAPI {
      * @param id - The block whose fill type should be set.
      * @param type - The fill type to set.
      * @returns An empty result on success, an error otherwise.
+     * @deprecated Use `createFill`, e.g., with type 'color' and then apply the fill block with `setFill` to the block instead.  If the block has a fill, it should be removed with `getFill` and `destroy`.
      */
     setFillType(id: DesignBlockId, fillType: FillType): void;
     /**
      * Get the fill type of the given design block.
      * @param id - The block whose fill type should be queried.
      * @returns The block's fill type or an error.
+     * @deprecated Use `getEnum(id, 'fill/type')` instead.
      */
     getFillType(id: DesignBlockId): FillType;
     /**
@@ -1661,12 +1673,14 @@ export declare class BlockAPI {
      * @param id - The block whose gradient type should be set.
      * @param type - The gradient type.
      * @returns An empty result on success, an error otherwise.
+     * @deprecated Use `createFill`, e.g., with '//ly.img.ubq/fill/gradient/linear' and then apply the fill block with `setFill` to the block instead. If the block has a fill, it should be removed with `getFill` and `destroy`.
      */
     setFillGradientType(id: DesignBlockId, gradientType: GradientType): void;
     /**
      * Get the gradient type of the given design block.
      * @param id - The block whose gradient type should be queried.
      * @returns The gradient type.
+     * @deprecated Use `getEnum(id, 'fill/gradient/type')` instead.
      */
     getFillGradientType(id: DesignBlockId): GradientType;
     /**
@@ -1678,6 +1692,7 @@ export declare class BlockAPI {
      * @param b - The blue color component in the range of 0 to 1.
      * @param a - The alpha color component in the range of 0 to 1.
      * @returns An empty result on success, an error otherwise.
+     * @deprecated Removed without a direct replacement. Use `block.setFloat(fill, keypath, value)` with key paths 'fill/gradient/linear/startPointX/Y', 'fill/gradient/radial/centerPointX/Y', and 'fill/gradient/conical/centerPointX/Y' to move the control points.
      */
     addFillGradientColorStop(id: DesignBlockId, stop: number, r: number, g: number, b: number, a?: number): void;
     /**
@@ -1685,12 +1700,14 @@ export declare class BlockAPI {
      * @param id - The block from which to remove the gradient color stop.
      * @param stop - The stop's position.
      * @returns An empty result on success, an error otherwise.
+     * @deprecated Removed without a direct replacement. Use `block.setFloat(fill, keypath, value)` with key paths 'fill/gradient/linear/startPointX/Y', 'fill/gradient/radial/centerPointX/Y', and 'fill/gradient/conical/centerPointX/Y' to move the control points.
      */
     removeFillGradientColorStop(id: DesignBlockId, stop: number): void;
     /**
      * Get the gradient fill color stops of the given design block.
      * @param id - The block whose gradient color stop should be queried.
      * @returns All of the design block's gradient color stops.
+     * @deprecated Removed without a direct replacement. Use `block.getFloat(fill, keypath)` with key paths 'fill/gradient/linear/startPointX/Y', 'fill/gradient/radial/centerPointX/Y', and 'fill/gradient/conical/centerPointX/Y' instead.
      */
     getFillGradientColorStops(id: DesignBlockId): GradientstopRGBA[];
     /**
@@ -1698,6 +1715,7 @@ export declare class BlockAPI {
      * @param id - The block whose gradient color stop should be set.
      * @param stops - The gradient color stops to set.
      * @returns An empty result on success, an error otherwise.
+     * @deprecated Removed without a direct replacement. Use `block.setFloat(fill, keypath, value)` with key paths 'fill/gradient/linear/startPointX/Y', 'fill/gradient/radial/centerPointX/Y', and 'fill/gradient/conical/centerPointX/Y' to move the control points.
      */
     setFillGradientColorStops(id: DesignBlockId, stops: GradientstopRGBA[]): void;
     /**
@@ -1708,6 +1726,7 @@ export declare class BlockAPI {
      * @param x - The horizontal component of the control point.
      * @param y - The vertical component of the control point.
      * @returns true if the control point was set, an error otherwise.
+     * @deprecated Use, e.g., `block.setFloat(fill, 'fill/gradient/linear/startPointX', value)` and `startPointY` instead.
      */
     setFillGradientControlPoint(id: DesignBlockId, gradientControlPointType: GradientControlPointType, x: number, y: number): boolean;
     /**
@@ -1715,6 +1734,7 @@ export declare class BlockAPI {
      * @param id - The block whose gradient control point should be queried.
      * @param gradientControlPointType - The type of control point.
      * @returns The horizontal component of the control point, an error otherwise.
+     * @deprecated Use `block.getFloat(fill, keypath)` with key paths 'fill/gradient/linear/startPointX', 'fill/gradient/radial/centerPointX', and 'fill/gradient/conical/centerPointX' instead.
      */
     getFillGradientControlPointX(id: DesignBlockId, gradientControlPointType: GradientControlPointType): number;
     /**
@@ -1722,6 +1742,7 @@ export declare class BlockAPI {
      * @param id - The block whose gradient control point should be queried.
      * @param gradientControlPointType - The type of control point.
      * @returns The vertical component of the control point, an error otherwise.
+     * @deprecated Use `block.setFloat(fill, keypath, value)` with key paths 'fill/gradient/linear/startPointY', 'fill/gradient/radial/centerPointY', and 'fill/gradient/conical/centerPointY' instead.
      */
     getFillGradientControlPointY(id: DesignBlockId, gradientControlPointType: GradientControlPointType): number;
     /**
@@ -1730,6 +1751,7 @@ export declare class BlockAPI {
      * @param id - The block whose gradient radius should be set.
      * @param radius - The gradient's radius.
      * @returns true if the control point was set, an error otherwise.
+     * @deprecated Use, e.g., `block.setFloat(fill, 'fill/gradient/radial/radius', value)` instead.
      */
     setFillGradientRadius(id: DesignBlockId, radius: number): boolean;
     /**
@@ -1737,6 +1759,7 @@ export declare class BlockAPI {
      * Note that Not all gradients have a radius.
      * @param id - The block whose gradient radius should be queried.
      * @returns the gradient's radius, an error otherwise.
+     * @deprecated Use, e.g., `block.getFloat(fill, 'fill/gradient/radial/radius')` instead.
      */
     getFillGradientRadius(id: DesignBlockId): number;
     /**
@@ -1755,8 +1778,39 @@ export declare class BlockAPI {
      * Query if the given block shows placeholder content.
      * @param id - The block to query.
      * @returns true, if the block shows placeholder content.
+     * @deprecated Use placeholder controls functions.
      */
     showsPlaceholderContent(id: DesignBlockId): boolean;
+    /**
+     * Checks whether the block supports placeholder controls.
+     * @param block - The block to query.
+     * @returns True, if the block supports placeholder controls.
+     */
+    hasPlaceholderControls(id: DesignBlockId): boolean;
+    /**
+     * Enable or disable the visibility of the placeholder overlay pattern for a block.
+     * @param block - The block whose placeholder overlay should be enabled or disabled.
+     * @param enabled - Whether the placeholder overlay should be shown or not.
+     * @returns An empty result on success, an error otherwise.
+     */
+    setPlaceholderControlsOverlayEnabled(id: DesignBlockId, enabled: boolean): void;
+    /**
+     * Query whether the placeholder overlay pattern for a block is shown.
+     * @param block - The block whose placeholder overlay visibility state should be queried.
+     * @returns An error if the block was invalid, otherwise the visibility state of the block's placeholder overlay pattern.
+     */
+    isPlaceholderControlsOverlayEnabled(id: DesignBlockId): boolean;
+    /** Enable or disable the visibility of the placeholder button for a block.
+     * @param block - The block whose placeholder button should be shown or not.
+     * @param enabled - Whether the placeholder button should be shown or not.
+     * @returns An empty result on success, an error otherwise.
+     */
+    setPlaceholderControlsButtonEnabled(id: DesignBlockId, enabled: boolean): void;
+    /** Query whether the placeholder button for a block is shown.
+     * @param block - The block whose placeholder button visibility state should be queried.
+     * @returns An error if the block was invalid, otherwise
+     */
+    isPlaceholderControlsButtonEnabled(id: DesignBlockId): boolean;
     /**
      * Set a metadata value of a block identified by a key.
      * If the key does not exist, yet, it will be added.
@@ -1899,15 +1953,15 @@ export declare class BlockAPI {
      */
     getTotalSceneDuration(scene: DesignBlockId): number;
     /**
-     * Set whether the block should be during active playback.
+     * Set whether the block should be playing during active playback.
      * @param id - The block that should be updated.
      * @param enabled - Whether the block should be playing its contents.
      */
     setPlaying(id: DesignBlockId, enabled: boolean): void;
     /**
-     * Returns whether the block is currently during active playback.
+     * Returns whether the block is playing during active playback.
      * @param id - The block to query.
-     * @returns whether the block is during playback.
+     * @returns whether the block is playing during playback.
      */
     isPlaying(id: DesignBlockId): boolean;
     /**
@@ -1951,7 +2005,7 @@ export declare class BlockAPI {
      */
     hasPlaybackControl(id: DesignBlockId): boolean;
     /**
-     * Set whether the block should start from the beginning again or stop.
+     * Set whether the block should restart 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.
      */
@@ -2080,7 +2134,6 @@ declare namespace ConfigTypes {
         PageFormatDefinition,
         TemplateDefinition,
         TypefaceDefinition,
-        ImageDefinition,
         Presets,
         Variables,
         Core,
@@ -2098,6 +2151,9 @@ export declare interface Configuration {
     license?: string;
     role: RoleString;
     featureFlags?: Record<string, string | boolean>;
+    /**
+     * @deprecated Extensions have been superseded by AssetSources and should no longer be used.
+     */
     extensions: ConfigTypes.Extensions;
     core: ConfigTypes.Core;
     scene: ConfigTypes.Scene;
@@ -2319,13 +2375,13 @@ export declare class EditorAPI {
      * @param value - The value to set.
      * @throws An error, if the keypath is invalid.
      */
-    setSettingBool(keypath: string, value: boolean): void;
+    setSettingBool(keypath: SettingsBool, value: boolean): void;
     /**
      * Get a boolean setting.
      * @param keypath - The settings keypath, e.g. `doubleClickToCropEnabled`
      * @throws An error, if the keypath is invalid.
      */
-    getSettingBool(keypath: string): boolean;
+    getSettingBool(keypath: SettingsBool): boolean;
     /**
      * Set an integer setting.
      * @param keypath - The settings keypath.
@@ -2345,26 +2401,26 @@ export declare class EditorAPI {
      * @param value - The value to set.
      * @throws An error, if the keypath is invalid.
      */
-    setSettingFloat(keypath: string, value: number): void;
+    setSettingFloat(keypath: SettingsFloat, value: number): void;
     /**
      * Get a float setting.
      * @param keypath - The settings keypath, e.g. `positionSnappingThreshold`
      * @throws An error, if the keypath is invalid.
      */
-    getSettingFloat(keypath: string): number;
+    getSettingFloat(keypath: SettingsFloat): number;
     /**
      * Set a string setting.
      * @param keypath - The settings keypath, e.g. `license`
      * @param value - The value to set.
      * @throws An error, if the keypath is invalid.
      */
-    setSettingString(keypath: string, value: string): void;
+    setSettingString(keypath: SettingsString, value: string): void;
     /**
      * Get a string setting.
      * @param keypath - The settings keypath, e.g. `license`
      * @throws An error, if the keypath is invalid.
      */
-    getSettingString(keypath: string): string;
+    getSettingString(keypath: SettingsString): string;
     /**
      * Set a color setting.
      * @param keypath - The settings keypath, e.g. `highlightColor`.
@@ -2373,25 +2429,25 @@ export declare class EditorAPI {
      * @param b - The blue color component in the range of 0 to 1.
      * @param a - The alpha color component in the range of 0 to 1.
      */
-    setSettingColorRGBA(keypath: string, r: number, g: number, b: number, a?: number): void;
+    setSettingColorRGBA(keypath: SettingsColorRGBA, r: number, g: number, b: number, a?: number): void;
     /**
      * Get a color setting.
      * @param keypath - The settings keypath, e.g. `highlightColor`.
      * @returns A tuple of channels red, green, blue and alpha in the range of 0 to 1.
      */
-    getSettingColorRGBA(keypath: string): RGBA;
+    getSettingColorRGBA(keypath: SettingsColorRGBA): RGBA;
     /**
      * Set an enum setting.
      * @param keypath - The settings keypath, e.g. `role`.
      * @param value - The enum value as string.
      */
-    setSettingEnum(keypath: string, value: string): void;
+    setSettingEnum<T extends keyof SettingsEnum>(keypath: T, value: SettingsEnum[T]): void;
     /**
      * Get an enum setting.
      * @param keypath - The settings keypath, e.g. `role`.
      * @returns The value as string.
      */
-    getSettingEnum(keypath: string): string;
+    getSettingEnum<T extends keyof SettingsEnum>(keypath: T): SettingsEnum[T];
     /**
      * Get the currently available memory in bytes.
      * @returns The currently available memory in bytes.
@@ -2624,17 +2680,6 @@ declare type HexColorString = string;
  */
 export declare type HistoryId = number;
 
-/** @public */
-declare type ImageDefinition = Preset & {
-    imageURL: string;
-    thumbnailURL?: string;
-    width: number;
-    height: number;
-    levelOfDetail?: {
-        [lod: number]: string;
-    };
-};
-
 /**
  * e.g. `en`, `de`, etc.
  * @public
@@ -2695,8 +2740,6 @@ declare type PageFormatDefinition = Preset & {
     width: number;
     height: number;
     unit: DesignUnit;
-    dpi?: number;
-    bleedMargin?: number;
     fixedOrientation?: boolean;
 };
 
@@ -2726,9 +2769,6 @@ declare type Presets = {
     typefaces?: {
         [id: string]: TypefaceDefinition;
     };
-    images?: {
-        [id: string]: ImageDefinition;
-    };
     pageFormats?: {
         [id: string]: PageFormatDefinition;
     };
@@ -2999,6 +3039,25 @@ export declare type SceneLayout = 'Free' | 'VerticalStack' | 'HorizontalStack' |
  */
 export declare type SceneMode = 'Design' | 'Video';
 
+/** @public */
+export declare type SettingsBool = 'doubleClickToCropEnabled' | 'features/aiImageMattingEnabled' | 'features/aiImageMattingStagingEnabled' | 'features/aiInpaintingEnabled' | 'features/aiSmartCropEnabled' | 'features/aiSuperResolutionEnabled' | 'features/effectsEnabled' | 'features/hspSelectiveAdjustmentsEnabled' | 'features/layerListEnabled' | 'features/singlePageModeEnabled' | 'features/templatingEnabled' | 'page/dimOutOfPageAreas' | 'page/title/show' | 'placeholderControls/showButton' | 'placeholderControls/showOverlay' | 'showBuildVersion' | 'touch/dragStartCanSelect' | 'touch/singlePointPanning' | 'trackActivePage' | ArbitraryString;
+
+/** @public */
+export declare type SettingsColorRGBA = 'clearColor' | 'errorStateColor' | 'highlightColor' | 'page/title/color' | 'placeholderHighlightColor' | 'progressColor' | ArbitraryString;
+
+/** @public */
+export declare type SettingsEnum = {
+    role: RoleString;
+    doubleClickSelectionMode: 'Direct' | 'Hierarchical';
+    [key: ArbitraryString]: string;
+};
+
+/** @public */
+export declare type SettingsFloat = 'positionSnappingThreshold';
+
+/** @public */
+export declare type SettingsString = 'ai/apiStagingUrl' | 'ai/apiUrl' | 'ai/backendUrl' | 'basePath' | 'license' | 'page/title/fontFileUri' | ArbitraryString;
+
 /** @public */
 export declare interface Size2 {
     width: number;