@cesdk/node 1.25.0 → 1.26.0

package/index.d.ts

@@ -218,6 +218,7 @@ export declare type AssetMetaData = {
 export declare interface AssetPayload {
     color?: AssetColor;
     sourceSet?: Source[];
+    typeface?: Typeface;
 }
 
 /**
@@ -486,6 +487,7 @@ export declare class BlockAPI {
     /**
      * Update the selection state of a block.
      * Fails for invalid blocks.
+     * Required scope: 'editor/select'
      * @param id - The block to query.
      * @param selected - Whether or not the block should be selected.
      */
@@ -533,12 +535,14 @@ export declare class BlockAPI {
     /**
      * Changes selection from selected group to a block within that group.
      * Nothing happens if `group` is not a group.
+     * Required scope: 'editor/select'
      * @param id - The group id from a previous call to `group`.
      */
     enterGroup(id: DesignBlockId): void;
     /**
      * Changes selection from a group's selected block to that group.
      * Nothing happens if the `id` is not part of a group.
+     * Required scope: 'editor/select'
      * @param id - A block id.
      */
     exitGroup(id: DesignBlockId): void;
@@ -556,6 +560,7 @@ export declare class BlockAPI {
      * The parent, fill and  sort order of the new block is that of the prioritized block.
      * When performing a `Union`, `Intersection` or `XOR`, the operation is performed pair-wise starting with the element with the highest sort order.
      * When performing a `Difference`, the operation is performed pair-wise starting with the element with the lowest sort order.
+     * Required scopes: 'lifecycle/duplicate', 'lifecycle/destroy'
      * @param ids - The blocks to combine. They will be destroyed if "lifecycle/destroy" scope is enabled.
      * @param op - The boolean operation to perform.
      * @returns The newly created block or an error.
@@ -627,6 +632,7 @@ export declare class BlockAPI {
      * Sets the block containing the shape properties of the given block.
      * Note that the previous shape block is not destroyed automatically.
      * The new shape is disconnected from its previously attached block.
+     * Required scope: 'shape/change'
      * @param id - The block whose shape should be changed.
      * @param fill - The new shape.
      */
@@ -639,6 +645,7 @@ export declare class BlockAPI {
     isVisible(id: DesignBlockId): boolean;
     /**
      * Update a block's visibility.
+     * Required scope: 'layer/visibility'
      * @param id - The block to update.
      * @param visible - Whether the block shall be visible.
      */
@@ -652,6 +659,7 @@ export declare class BlockAPI {
     isClipped(id: DesignBlockId): boolean;
     /**
      * Update a block's clipped state.
+     * Required scope: 'layer/clipping'
      * @param id - The block to update.
      * @param clipped - Whether the block should clips its contents to its frame.
      */
@@ -695,12 +703,14 @@ export declare class BlockAPI {
     /**
      * Update a block's x position.
      * The position refers to the block's local space, relative to its parent with the origin at the top left.
+     * Required scope: 'layer/move'
      * @param id - The block to update.
      * @param value - The value of the x position.
      */
     setPositionX(id: DesignBlockId, value: number): void;
     /**
      * Set a block's mode for its x position.
+     * Required scope: 'layer/move'
      * @param id - The block to update.
      * @param mode - The x position mode: absolute, percent or undefined.
      */
@@ -708,12 +718,14 @@ export declare class BlockAPI {
     /**
      * Update a block's y position.
      * The position refers to the block's local space, relative to its parent with the origin at the top left.
+     * Required scope: 'layer/move'
      * @param id - The block to update.
      * @param value - The value of the y position.
      */
     setPositionY(id: DesignBlockId, value: number): void;
     /**
      * Set a block's mode for its y position.
+     * Required scope: 'layer/move'
      * @param id - The block to update.
      * @param mode - The y position mode: absolute, percent or undefined.
      */
@@ -782,6 +794,7 @@ export declare class BlockAPI {
     getRotation(id: DesignBlockId): number;
     /**
      * Update a block's rotation.
+     * Required scope: 'layer/rotate'
      * @param id - The block to update.
      * @param radians - The new rotation in radians. Rotation is applied around the block's center.
      */
@@ -800,12 +813,14 @@ export declare class BlockAPI {
     getFlipVertical(id: DesignBlockId): boolean;
     /**
      * Update a block's horizontal flip.
+     * Required scope: 'layer/flip'
      * @param id - The block to update.
      * @param flip - If the flip should be enabled.
      */
     setFlipHorizontal(id: DesignBlockId, flip: boolean): void;
     /**
      * Update a block's vertical flip.
+     * Required scope: 'layer/flip'
      * @param id - The block to update.
      * @param flip - If the flip should be enabled.
      */
@@ -842,24 +857,28 @@ export declare class BlockAPI {
     getHeightMode(id: DesignBlockId): SizeMode;
     /**
      * Update a block's width.
+     * Required scope: 'layer/resize'
      * @param id - The block to update.
      * @param value - The new width of the block.
      */
     setWidth(id: DesignBlockId, value: number): void;
     /**
      * Set a block's mode for its width.
+     * Required scope: 'layer/resize'
      * @param id - The block to update.
      * @param mode - The width mode: Absolute, Percent or Auto.
      */
     setWidthMode(id: DesignBlockId, mode: SizeMode): void;
     /**
      * Update a block's height.
+     * Required scope: 'layer/resize'
      * @param id - The block to update.
      * @param value - The new height of the block.
      */
     setHeight(id: DesignBlockId, value: number): void;
     /**
      * Set a block's mode for its height.
+     * Required scope: 'layer/resize'
      * @param id - The block to update.
      * @param mode - The height mode: Absolute, Percent or Auto.
      */
@@ -894,6 +913,7 @@ export declare class BlockAPI {
     getFrameHeight(id: DesignBlockId): number;
     /**
      * Set a block's content fill mode.
+     * Required scope: 'layer/crop'
      * @param id - The block to update.
      * @param mode - The content fill mode mode: crop, cover or contain.
      */
@@ -906,12 +926,14 @@ export declare class BlockAPI {
     getContentFillMode(id: DesignBlockId): ContentFillMode;
     /**
      * Duplicates a block including its children.
+     * Required scope: 'lifecycle/duplicate'
      * @param id - The block to duplicate.
      * @returns The handle of the duplicate.
      */
     duplicate(id: DesignBlockId): DesignBlockId;
     /**
      * Destroys a block.
+     * Required scope: 'lifecycle/destroy'
      * @param id - The block to destroy.
      */
     destroy(id: DesignBlockId): void;
@@ -937,6 +959,7 @@ export declare class BlockAPI {
     getChildren(id: DesignBlockId): DesignBlockId[];
     /**
      * Insert a new or existing child at a certain position in the parent's children.
+     * Required scope: 'editor/add'
      * @param parent - The block whose children should be updated.
      * @param child - The child to insert. Can be an existing child of `parent`.
      * @param index - The index to insert or move to.
@@ -944,6 +967,7 @@ export declare class BlockAPI {
     insertChild(parent: DesignBlockId, child: DesignBlockId, index: number): void;
     /**
      * Appends a new or existing child to a block's children.
+     * Required scope: 'editor/add'
      * @param parent - The block whose children should be updated.
      * @param child - The child to insert. Can be an existing child of `parent`.
      */
@@ -990,12 +1014,14 @@ export declare class BlockAPI {
     getScreenSpaceBoundingBoxXYWH(ids: DesignBlockId[]): XYWH;
     /**
      * Align multiple blocks horizontally within their bounding box or a single block to its parent.
+     * Required scope: 'layer/move'
      * @param ids - A non-empty array of block ids.
      * @param alignment - How they should be aligned: left, right, or center
      */
     alignHorizontally(ids: DesignBlockId[], horizontalBlockAlignment: HorizontalBlockAlignment): void;
     /**
      * Align multiple blocks vertically within their bounding box or a single block to its parent.
+     * Required scope: 'layer/move'
      * @param ids - A non-empty array of block ids.
      * @param alignment - How they should be aligned: top, bottom, or center
      */
@@ -1008,12 +1034,13 @@ export declare class BlockAPI {
     isAlignable(ids: DesignBlockId[]): boolean;
     /**
      * Distribute multiple blocks horizontally within their bounding box so that the space between them is even.
-     *
+     * Required scope: 'layer/move'
      * @param ids - A non-empty array of block ids.
      */
     distributeHorizontally(ids: DesignBlockId[]): void;
     /**
      * Distribute multiple blocks vertically within their bounding box so that the space between them is even.
+     * Required scope: 'layer/move'
      * @param ids - A non-empty array of block ids.
      */
     distributeVertically(ids: DesignBlockId[]): void;
@@ -1025,12 +1052,15 @@ export declare class BlockAPI {
     isDistributable(ids: DesignBlockId[]): boolean;
     /**
      * Resize and position a block to entirely fill its parent block.
+     * Required scope: 'layer/move'
+     * - 'layer/resize'
      * @param id - The block that should fill its parent.
      */
     fillParent(id: DesignBlockId): void;
     /**
      * Resize all blocks to the given size. The content of the blocks is automatically adjusted
      * to fit the new dimensions.
+     * Required scope: 'layer/resize'
      * @param ids - The blocks to resize.
      * @param width - The new width of the blocks.
      * @param height - The new height of the blocks.
@@ -1043,6 +1073,7 @@ export declare class BlockAPI {
      * This updates the position, size and style properties (e.g. stroke width) of
      * the block and its children.
      *
+     * Required scope: 'layer/resize'
      * @param id - The block that should be scaled.
      * @param scale - The scale factor to be applied to the current properties of the block.
      * @param anchorX - The relative position along the width of the block around which the
@@ -1258,18 +1289,21 @@ export declare class BlockAPI {
     hasCrop(id: DesignBlockId): boolean;
     /**
      * Set the crop scale in x direction of the given design block.
+     * Required scope: 'layer/crop'
      * @param id - The block whose crop should be set.
      * @param scaleX - The scale in x direction.
      */
     setCropScaleX(id: DesignBlockId, scaleX: number): void;
     /**
      * Set the crop scale in y direction of the given design block.
+     * Required scope: 'layer/crop'
      * @param id - The block whose crop should be set.
      * @param scaleY - The scale in y direction.
      */
     setCropScaleY(id: DesignBlockId, scaleY: number): void;
     /**
      * Set the crop rotation of the given design block.
+     * Required scope: 'layer/crop'
      * @param id - The block whose crop should be set.
      * @param rotation - The rotation in radians.
      */
@@ -1278,18 +1312,21 @@ export declare class BlockAPI {
      * Set the crop scale ratio of the given design block.
      * This will uniformly scale the content up or down. The center of the
      * scale operation is the center of the crop frame.
+     * Required scope: 'layer/crop'
      * @param id - The block whose crop should be set.
      * @param scaleRatio - The crop scale ratio.
      */
     setCropScaleRatio(id: DesignBlockId, scaleRatio: number): void;
     /**
      * Set the crop translation in x direction of the given design block.
+     * Required scope: 'layer/crop'
      * @param id - The block whose crop should be set.
      * @param translationY - The translation in y direction.
      */
     setCropTranslationX(id: DesignBlockId, translationX: number): void;
     /**
      * Set the crop translation in y direction of the given design block.
+     * Required scope: 'layer/crop'
      * @param id - The block whose crop should be set.
      * @param translationY - The translation in y direction.
      */
@@ -1297,6 +1334,7 @@ export declare class BlockAPI {
     /**
      * Resets the manually set crop of the given design block.
      * The block's content fill mode is set to 'cover'.
+     * Required scope: 'layer/crop'
      * @param id - The block whose crop should be reset.
      */
     resetCrop(id: DesignBlockId): void;
@@ -1360,6 +1398,7 @@ export declare class BlockAPI {
     hasOpacity(id: DesignBlockId): boolean;
     /**
      * Set the opacity of the given design block.
+     * Required scope: 'layer/opacity'
      * @param id - The block whose opacity should be set.
      * @param opacity - The opacity to be set. The valid range is 0 to 1.
      */
@@ -1378,6 +1417,7 @@ export declare class BlockAPI {
     hasBlendMode(id: DesignBlockId): boolean;
     /**
      * Set the blend mode of the given design block.
+     * Required scope: 'layer/blendMode'
      * @param id - The block whose blend mode should be set.
      * @param blendMode - The blend mode to be set.
      * @returns
@@ -1461,6 +1501,7 @@ export declare class BlockAPI {
     /**
      * Inserts an effect at the given index into the list of effects of the given block.
      * The same effect can appear multiple times in the list and won't be removed if appended again.
+     * Required scope: 'appearance/effect'
      * @param id - The block to update.
      * @param effectId - The effect to insert
      * @param index - The index at which the effect shall be inserted.
@@ -1469,12 +1510,14 @@ export declare class BlockAPI {
     /**
      * Inserts an effect at the end of the list of effects
      * The same effect can appear multiple times in the list and won't be removed if appended again.
+     * Required scope: 'appearance/effect'
      * @param id - The block to append the effect to.
      * @param effectId - The effect to append.
      */
     appendEffect(id: DesignBlockId, effectId: DesignBlockId): void;
     /**
      * Removes the effect at the given index.
+     * Required scope: 'appearance/effect'
      * @param id - The block to remove the effect from.
      * @param index - The index where the effect is stored.
      */
@@ -1511,6 +1554,7 @@ export declare class BlockAPI {
     hasBlur(id: DesignBlockId): boolean;
     /**
      * Connects `block`'s blur to the given `blur` block.
+     * Required scope: 'appearance/blur'
      * @param id - The block to update.
      * @param blurId - A 'blur' block.
      */
@@ -1541,6 +1585,7 @@ export declare class BlockAPI {
     hasBackgroundColor(id: DesignBlockId): boolean;
     /**
      * Set the background color of the given design block.
+     * Required scope: 'fill/change'
      * @param id - The block whose background color should be set.
      * @param color - The background color to be set, a tuple of
      * @param r - The red color component in the range of 0 to 1.
@@ -1559,6 +1604,7 @@ export declare class BlockAPI {
     getBackgroundColorRGBA(id: DesignBlockId): RGBA;
     /**
      * Enable or disable the background of the given design block.
+     * Required scope: 'fill/change'
      * @param id - The block whose background should be enabled or disabled.
      * @param enabled - If true, the background will be enabled.
      */
@@ -1577,6 +1623,7 @@ export declare class BlockAPI {
     hasStroke(id: DesignBlockId): boolean;
     /**
      * Enable or disable the stroke of the given design block.
+     * Required scope: 'stroke/change'
      * @param id - The block whose stroke should be enabled or disabled.
      * @param enabled - If true, the stroke will be enabled.
      */
@@ -1589,6 +1636,7 @@ export declare class BlockAPI {
     isStrokeEnabled(id: DesignBlockId): boolean;
     /**
      * Set the stroke color of the given design block.
+     * Required scope: 'stroke/change'
      * @param id - The block whose stroke color should be set.
      * @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.
@@ -1599,6 +1647,7 @@ export declare class BlockAPI {
     setStrokeColorRGBA(id: DesignBlockId, r: number, g: number, b: number, a?: number): void;
     /**
      * Set the stroke color of the given design block.
+     * Required scope: 'stroke/change'
      * @param id - The block whose stroke color should be set.
      * @param color - The color to set.
      */
@@ -1618,6 +1667,7 @@ export declare class BlockAPI {
     getStrokeColor(id: DesignBlockId): Color;
     /**
      * Set the stroke width of the given design block.
+     * Required scope: 'stroke/change'
      * @param id - The block whose stroke width should be set.
      * @param width - The stroke width to be set.
      */
@@ -1630,6 +1680,7 @@ export declare class BlockAPI {
     getStrokeWidth(id: DesignBlockId): number;
     /**
      * Set the stroke style of the given design block.
+     * Required scope: 'stroke/change'
      * @param id - The block whose stroke style should be set.
      * @param style - The stroke style to be set.
      */
@@ -1642,6 +1693,7 @@ export declare class BlockAPI {
     getStrokeStyle(id: DesignBlockId): StrokeStyle;
     /**
      * Set the stroke position of the given design block.
+     * Required scope: 'stroke/change'
      * @param id - The block whose stroke position should be set.
      * @param position - The stroke position to be set.
      */
@@ -1654,6 +1706,7 @@ export declare class BlockAPI {
     getStrokePosition(id: DesignBlockId): StrokePosition;
     /**
      * Set the stroke corner geometry of the given design block.
+     * Required scope: 'stroke/change'
      * @param id - The block whose stroke join geometry should be set.
      * @param cornerGeometry - The stroke join geometry to be set.
      */
@@ -1672,6 +1725,7 @@ export declare class BlockAPI {
     hasDropShadow(id: DesignBlockId): boolean;
     /**
      * Enable or disable the drop shadow of the given design block.
+     * Required scope: 'appearance/shadow'
      * @param id - The block whose drop shadow should be enabled or disabled.
      * @param enabled - If true, the drop shadow will be enabled.
      */
@@ -1684,6 +1738,7 @@ export declare class BlockAPI {
     isDropShadowEnabled(id: DesignBlockId): boolean;
     /**
      * Set the drop shadow color of the given design block.
+     * Required scope: 'appearance/shadow'
      * @param id - The block whose drop shadow color should be set.
      * @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.
@@ -1694,6 +1749,7 @@ export declare class BlockAPI {
     setDropShadowColorRGBA(id: DesignBlockId, r: number, g: number, b: number, a?: number): void;
     /**
      * Set the drop shadow color of the given design block.
+     * Required scope: 'appearance/shadow'
      * @param id - The block whose drop shadow color should be set.
      * @param color - The color to set.
      */
@@ -1713,6 +1769,7 @@ export declare class BlockAPI {
     getDropShadowColor(id: DesignBlockId): Color;
     /**
      * Set the drop shadow's X offset of the given design block.
+     * Required scope: 'appearance/shadow'
      * @param id - The block whose drop shadow's X offset should be set.
      * @param offsetX - The X offset to be set.
      */
@@ -1725,6 +1782,7 @@ export declare class BlockAPI {
     getDropShadowOffsetX(id: DesignBlockId): number;
     /**
      * Set the drop shadow's Y offset of the given design block.
+     * Required scope: 'appearance/shadow'
      * @param id - The block whose drop shadow's Y offset should be set.
      * @param offsetY - The X offset to be set.
      */
@@ -1737,6 +1795,7 @@ export declare class BlockAPI {
     getDropShadowOffsetY(id: DesignBlockId): number;
     /**
      * Set the drop shadow's blur radius on the X axis of the given design block.
+     * Required scope: 'appearance/shadow'
      * @param id - The block whose drop shadow's blur radius should be set.
      * @param blurRadiusX - The blur radius to be set.
      */
@@ -1749,6 +1808,7 @@ export declare class BlockAPI {
     getDropShadowBlurRadiusX(id: DesignBlockId): number;
     /**
      * Set the drop shadow's blur radius on the Y axis of the given design block.
+     * Required scope: 'appearance/shadow'
      * @param id - The block whose drop shadow's blur radius should be set.
      * @param blurRadiusY - The blur radius to be set.
      */
@@ -1802,6 +1862,7 @@ export declare class BlockAPI {
     createCutoutFromOperation(ids: DesignBlockId[], op: CutoutOperation): DesignBlockId;
     /**
      * Inserts the given text into the selected range of the text block.
+     * Required scope: 'text/edit'
      * @param block - The text block into which to insert the given text.
      * @param text - The text which should replace the selected range in the block.
      * @param from - The start index of the UTF-16 range that should be replaced.
@@ -1813,6 +1874,7 @@ export declare class BlockAPI {
     replaceText(id: DesignBlockId, text: string, from?: number, to?: number): void;
     /**
      * Removes selected range of text of the given text block.
+     * Required scope: 'text/edit'
      * @param block - The text block from which the selected text should be removed.
      * @param from - The start index of the UTF-16 range that should be removed.
      * If the value is negative, this will fall back to the start of the entire text range.
@@ -1822,6 +1884,7 @@ export declare class BlockAPI {
     removeText(id: DesignBlockId, from?: number, to?: number): void;
     /**
      * Changes the color of the text in the selected range to the given color.
+     * Required scope: 'text/edit'
      * @param block - The text block whose color should be changed.
      * @param color - The new color of the selected text range.
      * @param from - The start index of the UTF-16 range whose color should be changed.
@@ -1878,6 +1941,7 @@ export declare class BlockAPI {
     getTextCases(id: DesignBlockId, from?: number, to?: number): TextCase[];
     /**
      * Sets the given text case for the selected range of text.
+     * Required scope: 'text/edit'
      * @param id - The text block whose text case should be changed.
      * @param textCase - The new text case value.
      * @param from - The start index of the UTF-16 range whose text cases should be returned.
@@ -1888,6 +1952,70 @@ export declare class BlockAPI {
      *   If the value is negative and the block is not being edited, this will fall back to the end of the entire text range.
      */
     setTextCase(id: DesignBlockId, textCase: TextCase, from?: number, to?: number): void;
+    /**
+     *  Returns whether the font weight of the given text block can be toggled between bold and normal.
+     * If any part of the selected range is not already bold and the necessary bold font is available, then this function returns true.
+     * @param id - The text block whose font weight should be toggled.
+     * @param from - The start index of the UTF-16 range whose font weight should be toggled.
+     *   If the value is negative and the block is currently being edited, this will fall back to the start of the current cursor index / selected grapheme range.
+     *   If the value is negative and the block is not being edited, this will fall back to the start of the entire text range.
+     * @param to - The UTF-16 index after the last grapheme whose font weight should be toggled.
+     *   If the value is negative and the block is currently being edited, this will fall back to the end of the current cursor index / selected grapheme range.
+     *   If the value is negative and the block is not being edited, this will fall back to the end of the entire text range.
+     * @returns Whether the font weight of the given block can be toggled between bold and normal.
+     */
+    canToggleBoldFont(id: DesignBlockId, from?: number, to?: number): boolean;
+    /**
+     * Toggles the bold font style of the given text block.
+     * If any part of the selected range is not already italic and the necessary italic font is available, then this function returns true.
+     * @param id - The text block whose font style should be toggled.
+     * @param from - The start index of the UTF-16 range whose font style should be toggled.
+     *   If the value is negative and the block is currently being edited, this will fall back to the start of the current cursor index / selected grapheme range.
+     *   If the value is negative and the block is not being edited, this will fall back to the start of the entire text range.
+     * @param to - The UTF-16 index after the last grapheme whose font style should be toggled.
+     *   If the value is negative and the block is currently being edited, this will fall back to the end of the current cursor index / selected grapheme range.
+     *   If the value is negative and the block is not being edited, this will fall back to the end of the entire text range.
+     * @returns Whether the font style of the given block can be toggled between italic and normal.
+     */
+    canToggleItalicFont(id: DesignBlockId, from?: number, to?: number): boolean;
+    /**
+     * Toggles the font weight of the given text block between bold and normal.
+     * If any part of the selected range is not already bold, all of the selected range will become bold. Only if the entire range is already bold will this function toggle it all back to normal.
+     * @param id - The text block whose font weight should be toggled.
+     * @param from - The start index of the UTF-16 range whose font weight should be toggled.
+     *   If the value is negative and the block is currently being edited, this will fall back to the start of the current cursor index / selected grapheme range.
+     *   If the value is negative and the block is not being edited, this will fall back to the start of the entire text range.
+     * @param to - The UTF-16 index after the last grapheme whose font weight should be toggled.
+     *   If the value is negative and the block is currently being edited, this will fall back to the end of the current cursor index / selected grapheme range.
+     *   If the value is negative and the block is not being edited, this will fall back to the end of the entire text range.
+     */
+    toggleBoldFont(id: DesignBlockId, from?: number, to?: number): void;
+    /**
+     * Toggles the font style of the given text block between italic and normal.
+     * If any part of the selected range is not already italic, all of the selected range will become italic. Only if the entire range is already italic will this function toggle it all back to normal.
+     * @param id - The text block whose font style should be toggled.
+     * @param from - The start index of the UTF-16 range whose font style should be toggled.
+     *  If the value is negative and the block is currently being edited, this will fall back to the start of the current cursor index / selected grapheme range.
+     *  If the value is negative and the block is not being edited, this will fall back to the start of the entire text range.
+     * @param to - The UTF-16 index after the last grapheme whose font style should be toggled.
+     *  If the value is negative and the block is currently being edited, this will fall back to the end of the current cursor index / selected grapheme range.
+     *  If the value is negative and the block is not being edited, this will fall back to the end of the entire text range.
+     */
+    toggleItalicFont(id: DesignBlockId, from?: number, to?: number): void;
+    /**
+     * Sets the given font and typeface for the text block.
+     * @param id - The text block whose font should be changed.
+     * @param fontFileUri - The URI of the new font file.
+     * @param typeface - The typeface of the new font.
+     */
+    setFont(id: DesignBlockId, fontFileUri: string, typeface: Typeface): void;
+    /**
+     * Returns the current typeface of the given text block.
+     * @param id - The text block whose typeface should be queried.
+     * @returns The typeface of the text block.
+     * @throws An error if the block does not have a valid typeface.
+     */
+    getTypeface(id: DesignBlockId): Typeface;
     /**
      * Returns the UTF-16 indices of the selected range of the text block that is currently being edited.
      * If both the start and end index of the returned range have the same value, then the text cursor is positioned at that index.
@@ -1908,6 +2036,7 @@ export declare class BlockAPI {
     isFillEnabled(id: DesignBlockId): boolean;
     /**
      * Enable or disable the fill of the given design block.
+     * Required scope: 'fill/change'
      * @param id - The block whose fill should be enabled or disabled.
      * @param enabled - If true, the fill will be enabled.
      * @returns An empty result on success, an error otherwise.
@@ -1922,12 +2051,14 @@ export declare class BlockAPI {
     /**
      * Sets the block containing the fill properties of the given block.
      * Note that the previous fill block is not destroyed automatically.
+     * Required scopes: 'fill/change', 'fill/changeType'
      * @param id - The block whose fill should be changed.
      * @param fill - The new fill.
      */
     setFill(id: DesignBlockId, fill: DesignBlockId): void;
     /**
      * Set the fill color of the given design block.
+     * Required scope: 'fill/change'
      * @param id - The block whose fill color should be set.
      * @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.
@@ -2045,21 +2176,21 @@ export declare class BlockAPI {
      * @param key - The scope to enable or disable.
      * @param enabled - Whether the scope should be enabled or disabled.
      */
-    setScopeEnabled(id: DesignBlockId, key: string, enabled: boolean): void;
+    setScopeEnabled(id: DesignBlockId, key: Scope, enabled: boolean): void;
     /**
      * Query whether a scope is enabled for a given block.
      * @param id - The block whose scope state should be queried.
      * @param key - The scope to query.
      * @returns the enabled state of the scope for the given block.
      */
-    isScopeEnabled(id: DesignBlockId, key: string): boolean;
+    isScopeEnabled(id: DesignBlockId, key: Scope): boolean;
     /**
      * Check if a scope is allowed for a given block.
      * @param id - The block to check.
      * @param key - The scope to check.
      * @returns whether the scope is allowed for the given block.
      */
-    isAllowedByScope(id: DesignBlockId, key: string): boolean;
+    isAllowedByScope(id: DesignBlockId, key: Scope): boolean;
     /**
      * Returns whether the block has a duration property.
      * @param id - The block to query.
@@ -2327,6 +2458,32 @@ export declare class BlockAPI {
      * @param buffer - Use pixel data from a canvas or a video element.
      */
     setNativePixelBuffer(id: number, buffer: HTMLCanvasElement | HTMLVideoElement): void;
+    /**
+     * Returns the block's state.
+     * If this block is in error state or this block has a `Shape` block, `Fill` block or `Effect` block(s), that
+     * is in error state, the returned state will be `Error`.
+     * Else, if this block is in pending state or this block has a `Shape` block, `Fill` block or `Effect` block(s), that
+     * is in pending state, the returned state will be `Pending`.
+     * Else, the returned state will be `Ready`.
+     * @param id - The block to query.
+     * @returns The block's state.
+     */
+    getState(id: DesignBlockId): BlockState;
+    /**
+     * Set the state of a block.
+     * @param id - The block whose state should be set.
+     * @param state - The new state to set.
+     */
+    setState(id: DesignBlockId, state: BlockState): void;
+    /**
+     * Subscribe to changes to the state of a block.
+     * Like `getState`, the state of a block is determined by the state of itself and its `Shape`, `Fill` and
+     * `Effect` block(s).
+     * @param blocks - A list of blocks to filter events by. If the list is empty, events for every block are sent.
+     * @param callback - The event callback.
+     * @returns Subscription A handle to the subscription. Use it to unsubscribe when done.
+     */
+    onStateChanged: (ids: DesignBlockId[], callback: (ids: DesignBlockId[]) => void) => (() => void);
 }
 
 /** @public */
@@ -2335,23 +2492,44 @@ export declare interface BlockEvent {
     type: 'Created' | 'Updated' | 'Destroyed';
 }
 
+/** @public Describes the state of the block which affect its rendering. */
+export declare type BlockState = BlockStateError | BlockStatePending | BlockStateReady;
+
+/** @public There's an error preventing rendering. */
+export declare interface BlockStateError {
+    type: 'Error';
+    error: 'AudioDecoding' | 'FileDecoding' | 'FileFetch' | 'Unknown' | 'VideoDecoding';
+}
+
+/** @public There is an ongoing operation on the block. Rendering may be affected. */
+export declare interface BlockStatePending {
+    type: 'Pending';
+    /** Expected range is [0, 1] */
+    progress: number;
+}
+
+/** @public The block is ready to be rendered. */
+export declare interface BlockStateReady {
+    type: 'Ready';
+}
+
 /**
  * The block type IDs for the blur blocks. These are the IDs used to create new blurs
- * using `cesdk.engine.editor.createBlur(id)`.
+ * using `cesdk.engine.block.createBlur(id)`.
  * @public
  */
 export declare type BlurType = BlurTypeShorthand | BlurTypeLonghand;
 
 /**
  * The longhand block type IDs for the blur blocks. These are the IDs used to create new blurs
- * using `cesdk.engine.editor.createBlur(id)`.
+ * using `cesdk.engine.block.createBlur(id)`.
  * @public
  */
 export declare type BlurTypeLonghand = `//ly.img.ubq/blur/${BlurTypeShorthand}`;
 
 /**
  * The shorthand block type IDs for the blur blocks. These are the IDs used to create new blurs
- * using `cesdk.engine.editor.createBlur(id)`.
+ * using `cesdk.engine.block.createBlur(id)`.
  * @public
  */
 export declare type BlurTypeShorthand = 'uniform' | 'linear' | 'mirrored' | 'radial';
@@ -2501,7 +2679,7 @@ export declare namespace ConfigTypes {
         fixedOrientation?: boolean;
     };
     /**
-     * @deprecated This type definition has moved and can be imported directly as `TypefaceDefinition`.
+     * @deprecated This type definition is not used anymore and will be removed.
      */
     export type TypefaceDefinition = _TypefaceDefinition;
     /**
@@ -2524,6 +2702,11 @@ export declare namespace ConfigTypes {
         colors?: {
             [id: string]: Color;
         };
+        /**
+         * @deprecated The configuration option `presets.typefaces` does not exist anymore.
+         * Custom typefaces should be defined as asset sources using
+         * the `cesdk.engine.asset.addSource` or `cesdk.engine.asset.addLocalSource` instead.
+         */
         typefaces?: {
             [id: string]: _TypefaceDefinition;
         };
@@ -2638,10 +2821,9 @@ export declare interface Configuration {
     featureFlags?: {
         [flag: string]: boolean | string;
     };
-    extensions: {
-        baseURL: string;
-        entries: string[];
-    };
+    /**
+     * @deprecated This config key is not used anymore and will be removed.
+     */
     presets: ConfigTypes.Presets;
     /**
      * @deprecated This config key is not used anymore.
@@ -2798,7 +2980,7 @@ export declare type CutoutType = 'Solid' | 'Dashed';
 /**
  * @public
  */
-export declare type DefaultAssetSourceId = 'ly.img.sticker' | 'ly.img.vectorpath' | 'ly.img.colors.defaultPalette' | 'ly.img.filter.lut' | 'ly.img.filter.duotone' | 'ly.img.effect' | 'ly.img.blur';
+export declare type DefaultAssetSourceId = 'ly.img.sticker' | 'ly.img.vectorpath' | 'ly.img.colors.defaultPalette' | 'ly.img.filter.lut' | 'ly.img.filter.duotone' | 'ly.img.effect' | 'ly.img.blur' | 'ly.img.typeface';
 
 /**
  * @public
@@ -2813,21 +2995,21 @@ export declare type DesignBlockId = number;
 
 /**
  * The block type IDs for the top-level design blocks. These are the IDs used to create new blocks
- * using `cesdk.engine.editor.cerate(id)`.
+ * using `cesdk.engine.block.create(id)`.
  * @public
  */
 export declare type DesignBlockType = DesignBlockTypeShorthand | DesignBlockTypeLonghand;
 
 /**
  * The longhand block type IDs for the top-level design blocks. These are the IDs used to create new blocks
- * using `cesdk.engine.editor.cerate(id)`.
+ * using `cesdk.engine.block.create(id)`.
  * @public
  */
 export declare type DesignBlockTypeLonghand = `//ly.img.ubq/${DesignBlockTypeShorthand}`;
 
 /**
  * The shorthand block type IDs for the top-level design blocks. These are the IDs used to create new blocks
- * using `cesdk.engine.editor.cerate(id)`.
+ * using `cesdk.engine.block.create(id)`.
  * @public
  */
 export declare type DesignBlockTypeShorthand = 'scene' | 'stack' | 'camera' | 'page' | 'graphic' | 'audio' | 'text' | 'group' | 'cutout' | 'track';
@@ -3150,19 +3332,19 @@ export declare class EditorAPI {
      * Get all available global scopes that can be set.
      * @returns The names of all available global scopes.
      */
-    findAllScopes(): string[];
+    findAllScopes(): Scope[];
     /**
      * Set a scope to be globally allowed, denied, or deferred to the block-level.
      * @param key - The scope to set.
      * @param value - `Allow` will always allow the scope, `Deny` will always deny the scope, and `Defer` will defer to the block-level.
      */
-    setGlobalScope(key: string, value: 'Allow' | 'Deny' | 'Defer'): void;
+    setGlobalScope(key: Scope, value: 'Allow' | 'Deny' | 'Defer'): void;
     /**
      * Query the state of a global scope.
      * @param key - The scope to query.
      * @returns `Allow` if the scope is allowed, `Deny` if it is disallowed, and `Defer` if it is deferred to the block-level.
      */
-    getGlobalScope(key: string): 'Allow' | 'Deny' | 'Defer';
+    getGlobalScope(key: Scope): 'Allow' | 'Deny' | 'Defer';
     /**
      * Queries the names of currently set spot colors previously set with `setSpotColorRGB`.
      * @returns The names of set spot colors.
@@ -3230,25 +3412,62 @@ export declare class EditorAPI {
     convertColorToColorSpace(color: Color, colorSpace: 'sRGB'): RGBAColor;
     convertColorToColorSpace(color: Color, colorSpace: 'CMYK'): CMYKColor;
     convertColorToColorSpace(color: Color, colorSpace: ColorSpace): never;
+    /**
+     * Create a resizable buffer that can hold arbitrary data.
+     * @returns A URI to identify the buffer.
+     */
+    createBuffer(): string;
+    /**
+     * Destroy a buffer and free its resources.
+     * @param uri - The URI of the buffer to destroy.
+     */
+    destroyBuffer(uri: string): void;
+    /**
+     * Set the data of a buffer at a given offset.
+     * @param uri - The URI of the buffer to update.
+     * @param offset - The offset in bytes at which to start writing.
+     * @param data - The data to write.
+     */
+    setBufferData(uri: string, offset: number, data: Uint8Array): void;
+    /**
+     * Get the data of a buffer at a given offset.
+     * @param uri - The URI of the buffer to query.
+     * @param offset - The offset in bytes at which to start reading.
+     * @param length - The number of bytes to read.
+     * @returns The data at the given offset.
+     */
+    getBufferData(uri: string, offset: number, length: number): Uint8Array;
+    /**
+     * Set the length of a buffer.
+     * @param uri - The URI of the buffer to update.
+     * @param length - The new length of the buffer in bytes.
+     */
+    setBufferLength(uri: string, length: number): void;
+    /**
+     * Get the length of a buffer.
+     * @param uri - The URI of the buffer to query.
+     * @returns The length of the buffer in bytes.
+     */
+    getBufferLength(uri: string): number;
 }
 
 /**
  * The block type IDs for the effect blocks. These are the IDs used to create new effects
- * using `cesdk.engine.editor.createEffect(id)`.
+ * using `cesdk.engine.block.createEffect(id)`.
  * @public
  */
 export declare type EffectType = EffectTypeShorthand | EffectTypeLonghand;
 
 /**
  * The longhand block type IDs for the effect blocks. These are the IDs used to create new effects
- * using `cesdk.engine.editor.createEffect(id)`.
+ * using `cesdk.engine.block.createEffect(id)`.
  * @public
  */
 export declare type EffectTypeLonghand = `//ly.img.ubq/effect/${EffectTypeShorthand}`;
 
 /**
  * The shorthand block type IDs for the effect blocks. These are the IDs used to create new effects
- * using `cesdk.engine.editor.createEffect(id)`.
+ * using `cesdk.engine.block.createEffect(id)`.
  * @public
  */
 export declare type EffectTypeShorthand = 'adjustments' | 'cross_cut' | 'dot_pattern' | 'duotone_filter' | 'extrude_blur' | 'glow' | 'green_screen' | 'half_tone' | 'linocut' | 'liquid' | 'lut_filter' | 'mirror' | 'outliner' | 'pixelize' | 'posterize' | 'radial_pixel' | 'recolor' | 'sharpie' | 'shifter' | 'tilt_shift' | 'tv_glitch' | 'vignette';
@@ -3356,21 +3575,21 @@ declare interface ExportVideoOptions {
 
 /**
  * The block type IDs for the fill blocks. These are the IDs used to create new fills
- * using `cesdk.engine.editor.createFill(id)`.
+ * using `cesdk.engine.block.createFill(id)`.
  * @public
  */
 export declare type FillType = FillTypeShorthand | FillTypeLonghand;
 
 /**
  * The longhand block type IDs for the fill blocks. These are the IDs used to create new fills
- * using `cesdk.engine.editor.createFill(id)`.
+ * using `cesdk.engine.block.createFill(id)`.
  * @public
  */
 export declare type FillTypeLonghand = `//ly.img.ubq/fill/${FillTypeShorthand}`;
 
 /**
  * The shorthand block type IDs for the fill blocks. These are the IDs used to create new fills
- * using `cesdk.engine.editor.createFill(id)`.
+ * using `cesdk.engine.block.createFill(id)`.
  * @public
  */
 export declare type FillTypeShorthand = 'color' | 'gradient/linear' | 'gradient/radial' | 'gradient/conical' | 'image' | 'video' | 'pixelStream';
@@ -3392,11 +3611,19 @@ declare interface Flip {
     vertical: boolean;
 }
 
+/** @public */
+export declare interface Font {
+    uri: string;
+    subFamily: string;
+    weight?: FontWeight;
+    style?: FontStyle;
+}
+
 /** @public */
 export declare type FontStyle = 'normal' | 'italic';
 
 /** @public */
-export declare type FontWeight = 'thin' | 'extraLight' | 'Light' | 'normal' | 'medium' | 'semiBold' | 'bold' | 'extraBold' | 'heavy';
+export declare type FontWeight = 'thin' | 'extraLight' | 'light' | 'normal' | 'medium' | 'semiBold' | 'bold' | 'extraBold' | 'heavy';
 
 /** @public */
 export declare interface GradientColorStop {
@@ -3847,12 +4074,17 @@ export declare type SceneLayout = 'Free' | 'VerticalStack' | 'HorizontalStack' |
  */
 export declare type SceneMode = 'Design' | 'Video';
 
+/**
+ * @public
+ */
+export declare type Scope = 'text/edit' | 'text/character' | 'fill/change' | 'fill/changeType' | 'stroke/change' | 'shape/change' | 'layer/move' | 'layer/resize' | 'layer/rotate' | 'layer/flip' | 'layer/crop' | 'layer/opacity' | 'layer/blendMode' | 'layer/visibility' | 'layer/clipping' | 'appearance/adjustments' | 'appearance/filter' | 'appearance/effect' | 'appearance/blur' | 'appearance/shadow' | 'lifecycle/destroy' | 'lifecycle/duplicate' | 'editor/add' | 'editor/select';
+
 /** @public */
-export declare type SettingsBool = 'controlGizmo/showCropHandles' | 'controlGizmo/showCropScaleHandles' | 'controlGizmo/showResizeHandles' | 'controlGizmo/showRotateHandles' | 'controlGizmo/showScaleHandles' | 'doubleClickToCropEnabled' | 'features/singlePageModeEnabled' | 'mouse/enableScroll' | 'mouse/enableZoom' | 'page/dimOutOfPageAreas' | 'page/title/appendPageName' | 'page/title/show' | 'page/title/showOnSinglePage' | 'page/title/showPageTitleTemplate' | 'placeholderControls/showButton' | 'placeholderControls/showOverlay' | 'showBuildVersion' | 'touch/dragStartCanSelect' | 'touch/singlePointPanning';
+export declare type SettingsBool = 'controlGizmo/showCropHandles' | 'controlGizmo/showCropScaleHandles' | 'controlGizmo/showResizeHandles' | 'controlGizmo/showRotateHandles' | 'controlGizmo/showScaleHandles' | 'doubleClickToCropEnabled' | 'features/singlePageModeEnabled' | 'mouse/enableScroll' | 'mouse/enableZoom' | 'checkScopesInAPIs' | 'page/dimOutOfPageAreas' | 'page/title/appendPageName' | 'page/title/show' | 'page/title/showOnSinglePage' | 'page/title/showPageTitleTemplate' | 'placeholderControls/showButton' | 'placeholderControls/showOverlay' | 'showBuildVersion' | 'touch/dragStartCanSelect' | 'touch/singlePointPanning';
 
 /** @public
  */
-declare type SettingsColor = 'borderOutlineColor' | 'clearColor' | 'colorMaskingSettings/maskColor' | 'cropOverlayColor' | 'errorStateColor' | 'highlightColor' | 'page/innerBorderColor' | 'page/marginFillColor' | 'page/marginFrameColor' | 'page/outerBorderColor' | 'page/title/color' | 'placeholderHighlightColor' | 'progressColor' | 'rotationSnappingGuideColor' | 'snappingGuideColor' | 'textVariableHighlightColor';
+export declare type SettingsColor = 'borderOutlineColor' | 'clearColor' | 'colorMaskingSettings/maskColor' | 'cropOverlayColor' | 'errorStateColor' | 'highlightColor' | 'page/innerBorderColor' | 'page/marginFillColor' | 'page/marginFrameColor' | 'page/outerBorderColor' | 'page/title/color' | 'placeholderHighlightColor' | 'progressColor' | 'rotationSnappingGuideColor' | 'snappingGuideColor' | 'textVariableHighlightColor';
 
 /** @public
  * @deprecated Use SettingsColor instead.
@@ -3878,21 +4110,21 @@ export declare type SettingType = 'Bool' | 'Int' | 'Float' | 'String' | 'Color'
 
 /**
  * The block type IDs for the shape blocks. These are the IDs used to create new shapes
- * using `cesdk.engine.editor.createShape(id)`.
+ * using `cesdk.engine.block.createShape(id)`.
  * @public
  */
 export declare type ShapeType = ShapeTypeShorthand | ShapeTypeLonghand;
 
 /**
  * The longhand block type IDs for the blocks. These are the IDs used to create new shapes
- * using `cesdk.engine.editor.createShape(id)`.
+ * using `cesdk.engine.block.createShape(id)`.
  * @public
  */
 export declare type ShapeTypeLonghand = `//ly.img.ubq/shape/${ShapeTypeShorthand}`;
 
 /**
  * The shorthand block type IDs for the shape blocks. These are the IDs used to create new shapes
- * using `cesdk.engine.editor.createShape(id)`.
+ * using `cesdk.engine.block.createShape(id)`.
  * @public
  */
 export declare type ShapeTypeShorthand = 'rect' | 'line' | 'ellipse' | 'polygon' | 'star' | 'vector_path';
@@ -3947,6 +4179,17 @@ declare type Subscription = number;
 export declare type TextCase = 'Normal' | 'Uppercase' | 'Lowercase' | 'Titlecase';
 
 /** @public */
+export declare interface Typeface {
+    /** The unique name of this typeface */
+    name: string;
+    /** The list of all fonts that are part of this typeface. */
+    fonts: Font[];
+}
+
+/**
+ * @deprecated This type definition is not used anymore and will be removed.
+ * @public
+ */
 export declare type TypefaceDefinition = {
     /** @deprecated The meta field is not used anymore */
     meta?: ConfigTypes.Preset['meta'];