@cesdk/node 1.14.0 → 1.15.0-rc.0

package/index.d.ts

@@ -19,6 +19,9 @@ export declare interface Asset {
         mimeType?: string;
         /** The type id of the design block that should be created from this asset. */
         blockType?: string;
+        fillType?: string;
+        shapeType?: string;
+        kind?: string;
         uri?: string;
         thumbUri?: string;
         previewUri?: string;
@@ -417,6 +420,19 @@ export declare class BlockAPI {
      * @returns The blocks type.
      */
     getType(id: DesignBlockId): DesignBlockType;
+    /**
+     * Get the kind of the given block, fails if the block is invalid.
+     * @param id - The block to query.
+     * @returns The block's kind.
+     */
+    getKind(id: DesignBlockId): string;
+    /**
+     * Set the kind of the given block, fails if the block is invalid.
+     * @param id - The block whose kind should be changed.
+     * @param kind - The new kind.
+     * @returns The block's kind.
+     */
+    setKind(id: DesignBlockId, kind: string): void;
     /**
      * Selects the given block and deselects all other blocks.
      * @param id - The block to be selected.
@@ -445,16 +461,16 @@ export declare class BlockAPI {
      * @param callback - This function is called at the end of the engine update if the selection has changed.
      * @returns A method to unsubscribe.
      */
-    onSelectionChanged(callback: () => void): () => void;
+    onSelectionChanged: (callback: () => void) => (() => void);
     /**
      * Subscribe to block click events.
      * @param callback - This function is called at the end of the engine update if a block has been clicked.
      * @returns A method to unsubscribe.
      */
-    onClicked(callback: (id: DesignBlockId) => void): () => void;
+    onClicked: (callback: (id: DesignBlockId) => void) => (() => void);
     /**
      * Confirms that a given set of blocks can be grouped together.
-     * @param ids - A non-empty array of block ids.
+     * @param ids - An array of block ids.
      * @returns Whether the blocks can be grouped together.
      */
     isGroupable(ids: DesignBlockId[]): boolean;
@@ -509,6 +525,12 @@ export declare class BlockAPI {
      * @returns A list of block ids.
      */
     findByType(type: DesignBlockType): DesignBlockId[];
+    /**
+     * Finds all blocks with the given kind.
+     * @param type - The kind to search for.
+     * @returns A list of block ids.
+     */
+    findByKind(kind: DesignBlockType): DesignBlockId[];
     /**
      * Return all blocks currently known to the engine.
      * @returns A list of block ids.
@@ -888,7 +910,7 @@ export declare class BlockAPI {
     alignVertically(ids: DesignBlockId[], verticalBlockAlignment: VerticalBlockAlignment): void;
     /**
      * Confirms that a given set of blocks can be aligned.
-     * @param ids - A non-empty array of block ids.
+     * @param ids - An array of block ids.
      * @returns Whether the blocks can be aligned.
      */
     isAlignable(ids: DesignBlockId[]): boolean;
@@ -905,7 +927,7 @@ export declare class BlockAPI {
     distributeVertically(ids: DesignBlockId[]): void;
     /**
      * Confirms that a given set of blocks can be distributed.
-     * @param ids - A non-empty array of block ids.
+     * @param ids - An array of block ids.
      * @returns Whether the blocks can be distributed.
      */
     isDistributable(ids: DesignBlockId[]): boolean;
@@ -1484,60 +1506,6 @@ export declare class BlockAPI {
      * @returns The stroke join geometry.
      */
     getStrokeCornerGeometry(id: DesignBlockId): StrokeCornerGeometry;
-    /**
-     * Query if the given block has outline properties.
-     * @param id - The block to query.
-     * @returns true, if the block has outline properties.
-     * @deprecated Use `hasStroke`.
-     */
-    hasOutline(id: DesignBlockId): boolean;
-    /**
-     * Set the outline color of the given design block.
-     * @param id - The block whose outline color should be set.
-     * @param color - The outline color to be set, a tuple of
-     * @param r - The red color component in the range of 0 to 1.
-     * @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 `setStrokeColorRGBA`.
-     */
-    setOutlineColorRGBA(id: DesignBlockId, r: number, g: number, b: number, a?: number): void;
-    /**
-     * Get the outline color of the given design block.
-     * @param id - The block whose outline color should be queried.
-     * @returns The outline color.
-     * @deprecated Use `getStrokeColorRGBA`.
-     */
-    getOutlineColorRGBA(id: DesignBlockId): RGBA;
-    /**
-     * Enable or disable the outline of the given design block.
-     * @param id - The block whose outline should be enabled or disabled.
-     * @param enabled - If true, the outline will be enabled.
-     * @deprecated Use `setStrokeEnabled`.
-     */
-    setOutlineEnabled(id: DesignBlockId, enabled: boolean): void;
-    /**
-     * Query if the outline of the given design block is enabled.
-     * @param id - The block whose outline state should be queried.
-     * @returns True, if outline is enabled.
-     * @deprecated Use `isStrokeEnabled`.
-     */
-    isOutlineEnabled(id: DesignBlockId): boolean;
-    /**
-     * Set the outline width of the given design block.
-     * @param id - The block whose outline width should be set.
-     * @param width - The outline width to be set.
-     * @deprecated Use `setStrokeWidth`.
-     */
-    setOutlineWidth(id: DesignBlockId, width: number): void;
-    /**
-     * Get the outline width of the given design block.
-     * @param id - The block whose outline width should be queried.
-     * @returns The outline width.
-     * @deprecated Use the Stroke function
-     * @deprecated Use `getStrokeWidth`.
-     */
-    getOutlineWidth(id: DesignBlockId): number;
     /**
      * Query if the given block has a drop shadow property.
      * @param id - The block to query.
@@ -1632,41 +1600,25 @@ export declare class BlockAPI {
      */
     getDropShadowClip(id: DesignBlockId): boolean;
     /**
-     * Create a Cutout block.
+     * Creates a cutout whose path will be the contour of the given blocks.
+     * The cutout path for each element is derived from one two ways:
+     *   - Blocks that have already have a vector path (shapes, SVG-based text or stickers).
+     *   - Blocks that don't have a vector path are vectorized and then, optionally, simplified to eliminate jaggedness
+     *   (images).
      * @param blocks - The blocks whose shape will serve as the basis for the cutout's path.
-     * @returns The handle of the created Cutout.
+     * @param vectorizeDistanceThreshold - The maximum number of pixels by which the cutout's path can deviate from the
+     * original contour.
+     * @param simplifyDistanceThreshold - The maximum number of pixels by which the simplified cutout path can deviate from
+     * the cutout contour. If 0, no simplification step is performed.
+     * @returns The newly created block or an error.
      */
-    createCutoutFromBlocks(ids: DesignBlockId[]): DesignBlockId;
+    createCutoutFromBlocks(ids: DesignBlockId[], vectorizeDistanceThreshold?: number, simplifyDistanceThreshold?: number): DesignBlockId;
     /**
      * Create a Cutout block.
      * @param path - An SVG string describing a path.
-     * @returns The handle of the created Cutout.
+     * @returns The newly created block or an error.
      */
     createCutoutFromPath(path: string): DesignBlockId;
-    /**
-     * Set the cutout's offset from the underlying path.
-     * @param block - The block whose offset should be set.
-     * @param offset - The offset to be set.
-     */
-    setCutoutOffset(id: DesignBlockId, offset: number): void;
-    /**
-     * Get the cutout's offset from the underlying path.
-     * @param block - The block whose offset should be queried.
-     * @returns The cutout's offset.
-     */
-    getCutoutOffset(id: DesignBlockId): number;
-    /**
-     * Set the cutout's type.
-     * @param block - The block whose type should be set.
-     * @param type - The type to be set.
-     */
-    setCutoutType(id: DesignBlockId, type: CutoutType): void;
-    /**
-     * Get the cutout's type.
-     * @param block - The block whose type should be queried.
-     * @returns The cutout's type.
-     */
-    getCutoutType(id: DesignBlockId): CutoutType;
     /** Perform a boolean operation on the given Cutout blocks.
      * The cutout offset of the new block is 0.
      * The cutout type of the new block is that of the first block.
@@ -1957,13 +1909,6 @@ export declare class BlockAPI {
      * @returns the enabled state of the placeholder behavior.
      */
     isPlaceholderBehaviorEnabled(id: DesignBlockId): boolean;
-    /**
-     * 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.
@@ -2934,6 +2879,23 @@ export declare class EditorAPI {
      * @returns The value as string.
      */
     getSettingEnum<T extends keyof SettingsEnum>(keypath: T): SettingsEnum[T];
+    /**
+     * Get the possible enum options for a given enum setting.
+     * @param keypath - The settings keypath, e.g. `role`.
+     * @returns The possible enum options as strings.
+     */
+    getSettingEnumOptions<T extends keyof SettingsEnum>(keypath: T): string[];
+    /**
+     * Returns a list of all the settings available.
+     * @returns A list of settings keypaths.
+     */
+    findAllSettings(): string[];
+    /**
+     * Returns the type of a setting.
+     * @param keypath - The settings keypath, e.g. `role`.
+     * @returns The setting type.
+     */
+    getSettingType(keypath: string): SettingType;
     /**
      * Get the currently available memory in bytes.
      * @returns The currently available memory in bytes.
@@ -3486,7 +3448,7 @@ 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;
+export declare type SettingsBool = 'doubleClickToCropEnabled' | '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;
@@ -3499,10 +3461,13 @@ export declare type SettingsEnum = {
 };
 
 /** @public */
-export declare type SettingsFloat = 'positionSnappingThreshold';
+export declare type SettingsFloat = 'positionSnappingThreshold' | ArbitraryString;
+
+/** @public */
+export declare type SettingsString = 'basePath' | 'license' | 'page/title/fontFileUri' | ArbitraryString;
 
 /** @public */
-export declare type SettingsString = 'ai/apiStagingUrl' | 'ai/apiUrl' | 'ai/backendUrl' | 'basePath' | 'license' | 'page/title/fontFileUri' | ArbitraryString;
+export declare type SettingType = 'Bool' | 'Int' | 'Float' | 'String' | 'Color' | 'Enum';
 
 /** @public */
 export declare interface Size2 {