@cesdk/engine 1.37.0 → 1.38.0

package/index.d.ts

@@ -17,7 +17,7 @@ export declare type AnimationTypeLonghand = `//ly.img.ubq/animation/${AnimationT
  * using `cesdk.engine.block.createAnimation(id)`.
  * @public
  */
-export declare type AnimationTypeShorthand = 'slide' | 'pan' | 'fade' | 'blur' | 'grow' | 'zoom' | 'pop' | 'wipe' | 'baseline' | 'crop_zoom' | 'spin' | 'spin_loop' | 'fade_loop' | 'blur_loop' | 'pulsating_loop' | 'breathing_loop' | 'jump_loop' | 'squeeze_loop' | 'sway_loop';
+export declare type AnimationTypeShorthand = 'slide' | 'pan' | 'fade' | 'blur' | 'grow' | 'zoom' | 'pop' | 'wipe' | 'baseline' | 'crop_zoom' | 'spin' | 'spin_loop' | 'fade_loop' | 'blur_loop' | 'pulsating_loop' | 'breathing_loop' | 'jump_loop' | 'squeeze_loop' | 'sway_loop' | 'typewriter_text' | 'block_swipe_text' | 'spread_text' | 'merge_text';
 
 /**
  * Generic asset information
@@ -1456,6 +1456,14 @@ export declare class BlockAPI {
      * @param uri - The source to add to the source set.
      */
     addImageFileURIToSourceSet(id: DesignBlockId, property: string, uri: string): Promise<void>;
+    /**
+     * Add a video file URI to the `sourceSet` property of the given block.
+     * If there already exists in source set an video with the same width, that existing video will be replaced.
+     * @param id - The block to update.
+     * @param property - The name of the property to modify.
+     * @param uri - The source to add to the source set.
+     */
+    addVideoFileURIToSourceSet(id: DesignBlockId, property: string, uri: string): Promise<void>;
     /**
      * Set an enum property of the given design block to the given value.
      * @param id - The block whose property should be set.
@@ -2088,9 +2096,11 @@ export declare class BlockAPI {
      * 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.
+     * @param useExistingShapeInformation - If true, the existing vector paths of the provided blocks will be used to create the cutout.
+     * If false, new shape information for the cutout will be generated.
      * @returns The newly created block or an error.
      */
-    createCutoutFromBlocks(ids: DesignBlockId[], vectorizeDistanceThreshold?: number, simplifyDistanceThreshold?: number): DesignBlockId;
+    createCutoutFromBlocks(ids: DesignBlockId[], vectorizeDistanceThreshold?: number, simplifyDistanceThreshold?: number, useExistingShapeInformation?: boolean): DesignBlockId;
     /**
      * Create a Cutout block.
      * @param path - An SVG string describing a path.
@@ -2152,6 +2162,19 @@ 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.
      */
     getTextColors(id: DesignBlockId, from?: number, to?: number): Array<Color>;
+    /**
+     * Changes the weight of the text in the selected range to the given weight.
+     * Required scope: 'text/edit'
+     * @param block - The text block whose weight should be changed.
+     * @param fontWeight - The new weight of the selected text range.
+     * @param from - The start index of the UTF-16 range whose weight should be changed.
+     *   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 weight should be changed.
+     *   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.
+     */
+    setTextFontWeight(id: DesignBlockId, fontWeight: FontWeight, from?: number, to?: number): void;
     /**
      * Returns the ordered unique list of font weights of the text in the selected range.
      * @param block - The text block whose font weights should be returned.
@@ -2163,10 +2186,47 @@ 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.
      */
     getTextFontWeights(id: DesignBlockId, from?: number, to?: number): FontWeight[];
+    /**
+     * Sets the given font size for the text block.
+     * Required scope: 'text/character'
+     * @param block - The text block whose font size should be changed.
+     * @param fontSize - The new font size.
+     * @param from - The start index of the UTF-16 range whose font size should be changed.
+     *   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 size should be changed.
+     *   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.
+     */
+    setTextFontSize(id: DesignBlockId, fontSize: number, from?: number, to?: number): void;
+    /**
+     * Returns the ordered unique list of font sizes of the text in the selected range.
+     * @param block - The text block whose font sizes should be returned.
+     * @param from - The start index of the grapheme range whose font sizes should be returned.
+     *   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 sizes should be returned.
+     *   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.
+     */
+    getTextFontSizes(id: DesignBlockId, from?: number, to?: number): number[];
+    /**
+     * Changes the style of the text in the selected range to the given style.
+     * Required scope: 'text/edit'
+     * @param block - The text block whose style should be changed.
+     * @param fontStyle - The new style of the selected text range.
+     * @param from - The start index of the UTF-16 range whose style should be changed.
+     *   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 style should be changed.
+     *   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.
+     */
+    setTextFontStyle(id: DesignBlockId, fontStyle: FontStyle, from?: number, to?: number): void;
     /**
      * Returns the ordered unique list of font styles of the text in the selected range.
      * @param block - The text block whose font styles should be returned.
-     * @param from - The start index of the UTF-16 range whose font weights should be returned.
+     * @param from - The start index of the UTF-16 range whose font styles should be returned.
      *   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 styles should be returned.
@@ -2187,7 +2247,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'
+     * Required scope: 'text/character'
      * @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.
@@ -2199,7 +2259,7 @@ export declare class BlockAPI {
      */
     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.
+     * 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.
@@ -2227,6 +2287,7 @@ export declare class BlockAPI {
     /**
      * 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.
+     * Required scope: 'text/character'
      * @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.
@@ -2239,6 +2300,7 @@ export declare class BlockAPI {
     /**
      * 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.
+     * Required scope: 'text/character'
      * @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.
@@ -2251,6 +2313,7 @@ export declare class BlockAPI {
     /**
      * Sets the given font and typeface for the text block.
      * Existing formatting is reset.
+     * Required scope: 'text/character'
      * @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.
@@ -2260,6 +2323,7 @@ export declare class BlockAPI {
      * Sets the given typeface for the text block.
      * The current formatting, e.g., bold or italic, is retained as far as possible. Some formatting might change if the
      * new typeface does not support it, e.g. thin might change to light, bold to normal, and/or italic to non-italic.
+     * Required scope: 'text/character'
      * @param id - The text block whose font should be changed.
      * @param fallbackFontFileUri - The URI of the fallback font file.
      * @param typeface - The new typeface.
@@ -4502,7 +4566,7 @@ export declare type SceneMode = 'Design' | 'Video';
 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' | 'appearance/animation' | 'lifecycle/destroy' | 'lifecycle/duplicate' | 'editor/add' | 'editor/select';
 
 /** @public */
-export declare type SettingsBool = 'controlGizmo/showCropHandles' | 'controlGizmo/showCropScaleHandles' | 'controlGizmo/showMoveHandles' | 'controlGizmo/showResizeHandles' | 'controlGizmo/showRotateHandles' | 'controlGizmo/showScaleHandles' | 'doubleClickToCropEnabled' | 'features/singlePageModeEnabled' | 'features/pageCarouselEnabled' | 'mouse/enableScroll' | 'mouse/enableZoom' | 'checkScopesInAPIs' | 'page/allowCropInteraction' | 'page/allowMoveInteraction' | 'page/allowResizeInteraction' | 'page/allowRotateInteraction' | 'page/dimOutOfPageAreas' | 'page/restrictResizeInteractionToFixedAspectRatio' | 'page/title/appendPageName' | 'page/title/show' | 'page/title/showOnSinglePage' | 'page/title/showPageTitleTemplate' | 'placeholderControls/showButton' | 'placeholderControls/showOverlay' | 'blockAnimations/enabled' | 'showBuildVersion' | 'touch/dragStartCanSelect' | 'touch/singlePointPanning';
+export declare type SettingsBool = 'controlGizmo/showCropHandles' | 'controlGizmo/showCropScaleHandles' | 'controlGizmo/showMoveHandles' | 'controlGizmo/showResizeHandles' | 'controlGizmo/showRotateHandles' | 'controlGizmo/showScaleHandles' | 'doubleClickToCropEnabled' | 'features/singlePageModeEnabled' | 'features/pageCarouselEnabled' | 'mouse/enableScroll' | 'mouse/enableZoom' | 'page/allowCropInteraction' | 'page/allowMoveInteraction' | 'page/allowResizeInteraction' | 'page/allowRotateInteraction' | 'page/dimOutOfPageAreas' | 'page/restrictResizeInteractionToFixedAspectRatio' | 'page/title/appendPageName' | 'page/title/show' | 'page/title/showOnSinglePage' | 'page/title/showPageTitleTemplate' | 'placeholderControls/showButton' | 'placeholderControls/showOverlay' | 'blockAnimations/enabled' | 'showBuildVersion' | 'touch/dragStartCanSelect' | 'touch/singlePointPanning';
 
 /** @public
  */