@cesdk/node 1.76.0-nightly.20260514 → 1.76.0-nightly.20260515

package/index.d.ts

@@ -960,8 +960,18 @@ export declare type AssetMetaData = {
     width?: number;
     height?: number;
     duration?: string;
-    effectType?: EffectType;
-    blurType?: BlurType;
+    /**
+     * Effect kind hint. Widened to `string` so this metadata stays
+     * cross-binding (the narrow `EffectType` union remains the
+     * source of truth for `BlockAPI.createEffect`).
+     */
+    effectType?: string;
+    /**
+     * Blur kind hint. Widened to `string` for the same reason as
+     * `effectType` — the narrow `BlurType` union still gates
+     * `BlockAPI.createBlur`.
+     */
+    blurType?: string;
     looping?: boolean;
 } & Record<string, unknown>;
 
@@ -2177,6 +2187,16 @@ export declare class BlockAPI {
      * @returns True if transform locked, false otherwise.
      */
     isTransformLocked(id: DesignBlockId): boolean;
+    /**
+     * Checks whether a graphic block originated as a line shape. Survives the
+     * line's conversion to a vector path during vector-edit; resets only when
+     * the shape is replaced by a non-line shape via `setShape`.
+     *
+     * @category Block Layout
+     * @param id - The block to query.
+     * @returns True if the block originated as a line shape, false otherwise.
+     */
+    isLineOrigin(id: DesignBlockId): boolean;
     /**
      * Sets the transform-locked state of a block.
      *
@@ -4048,6 +4068,138 @@ export declare class BlockAPI {
      * @returns The stroke corner geometry.
      */
     getStrokeCornerGeometry(id: DesignBlockId): StrokeCornerGeometry;
+    /**
+     * Sets the stroke cap of a block. Writes both the start and end caps to the
+     * same value.
+     *
+     * @category Block Strokes
+     * @param id - The block whose stroke cap should be set.
+     * @param cap - The stroke cap to be set.
+     * @deprecated Use `setStrokeStartCap` and `setStrokeEndCap` to set each end
+     * independently.
+     */
+    setStrokeCap(id: DesignBlockId, cap: StrokeCap): void;
+    /**
+     * Gets the legacy single stroke cap of a block. Tracks the value last written
+     * via `setStrokeCap` or `setStrokeStartCap`; ignores changes made via
+     * `setStrokeEndCap`.
+     *
+     * @category Block Strokes
+     * @param id - The block whose stroke cap should be queried.
+     * @returns The stroke cap.
+     * @deprecated Use `getStrokeStartCap` and `getStrokeEndCap` instead.
+     */
+    getStrokeCap(id: DesignBlockId): StrokeCap;
+    /**
+     * Sets the cap geometry at the start of an open stroked path. Use this with
+     * `setStrokeEndCap` to set distinct caps for each end of a stroke (for
+     * example a flat start with an arrowhead end). `setStrokeCap` continues to
+     * set both ends at once and is preserved for backwards compatibility.
+     *
+     * @category Block Strokes
+     * @param id - The block whose stroke start cap should be set.
+     * @param cap - The cap geometry to use at the path start.
+     */
+    setStrokeStartCap(id: DesignBlockId, cap: StrokeCap): void;
+    /**
+     * Gets the cap geometry at the start of an open stroked path.
+     *
+     * @category Block Strokes
+     * @param id - The block whose stroke start cap should be queried.
+     * @returns The start cap.
+     */
+    getStrokeStartCap(id: DesignBlockId): StrokeCap;
+    /**
+     * Sets the cap geometry at the end of an open stroked path. Use this with
+     * `setStrokeStartCap` to set distinct caps for each end of a stroke.
+     *
+     * @category Block Strokes
+     * @param id - The block whose stroke end cap should be set.
+     * @param cap - The cap geometry to use at the path end.
+     */
+    setStrokeEndCap(id: DesignBlockId, cap: StrokeCap): void;
+    /**
+     * Gets the cap geometry at the end of an open stroked path.
+     *
+     * @category Block Strokes
+     * @param id - The block whose stroke end cap should be queried.
+     * @returns The end cap.
+     */
+    getStrokeEndCap(id: DesignBlockId): StrokeCap;
+    /**
+     * Sets the cap geometry at the leading edge of each dash piece (excluding the
+     * line's actual start). Only takes effect when a dash pattern is active.
+     * Distinct from `setStrokeStartCap`, which only applies to the start of the
+     * open path itself.
+     *
+     * @category Block Strokes
+     * @param id - The block whose dash start cap should be set.
+     * @param cap - The cap geometry to use at the leading edge of each dash piece.
+     */
+    setStrokeDashStartCap(id: DesignBlockId, cap: StrokeCap): void;
+    /**
+     * Gets the cap geometry at the leading edge of each dash piece.
+     *
+     * @category Block Strokes
+     * @param id - The block whose dash start cap should be queried.
+     * @returns The dash start cap.
+     */
+    getStrokeDashStartCap(id: DesignBlockId): StrokeCap;
+    /**
+     * Sets the cap geometry at the trailing edge of each dash piece (excluding the
+     * line's actual end). Only takes effect when a dash pattern is active. Distinct
+     * from `setStrokeEndCap`, which only applies to the end of the open path itself.
+     *
+     * @category Block Strokes
+     * @param id - The block whose dash end cap should be set.
+     * @param cap - The cap geometry to use at the trailing edge of each dash piece.
+     */
+    setStrokeDashEndCap(id: DesignBlockId, cap: StrokeCap): void;
+    /**
+     * Gets the cap geometry at the trailing edge of each dash piece.
+     *
+     * @category Block Strokes
+     * @param id - The block whose dash end cap should be queried.
+     * @returns The dash end cap.
+     */
+    getStrokeDashEndCap(id: DesignBlockId): StrokeCap;
+    /**
+     * Sets a custom dash pattern for the block's stroke. Semantics match SVG's
+     * `stroke-dasharray`: alternating on/off lengths in design-unit space. When the
+     * pattern is non-empty it overrides the preset implied by `StrokeStyle`. Pass an
+     * empty array to fall back to the preset.
+     *
+     * @category Block Strokes
+     * @param id - The block whose stroke dash pattern should be set.
+     * @param dashArray - Alternating on/off lengths. Odd-length arrays are doubled to
+     *   an even length, matching SVG behaviour.
+     */
+    setStrokeDashArray(id: DesignBlockId, dashArray: number[]): void;
+    /**
+     * Gets the custom dash pattern of the block's stroke.
+     *
+     * @category Block Strokes
+     * @param id - The block whose stroke dash pattern should be queried.
+     * @returns The dash pattern, or an empty array if no custom pattern is set.
+     */
+    getStrokeDashArray(id: DesignBlockId): number[];
+    /**
+     * Sets the dash offset of the block's stroke. Semantics match SVG's
+     * `stroke-dashoffset`. Ignored when the custom dash pattern is empty.
+     *
+     * @category Block Strokes
+     * @param id - The block whose stroke dash offset should be set.
+     * @param dashOffset - The dash offset in design-unit space.
+     */
+    setStrokeDashOffset(id: DesignBlockId, dashOffset: number): void;
+    /**
+     * Gets the dash offset of the block's stroke.
+     *
+     * @category Block Strokes
+     * @param id - The block whose stroke dash offset should be queried.
+     * @returns The dash offset.
+     */
+    getStrokeDashOffset(id: DesignBlockId): number;
     /**
      * Checks if a block has a drop shadow property.
      *
@@ -5937,6 +6089,7 @@ export declare type BlockEnumType = {
     'scene/layout': SceneLayout;
     'scene/mode': SceneMode;
     'width/mode': WidthMode;
+    'stroke/cap': StrokeCap;
     'stroke/cornerGeometry': StrokeCornerGeometry;
     'stroke/position': StrokePosition;
     'stroke/style': StrokeStyle;
@@ -6066,7 +6219,7 @@ export declare type BlurTypeShorthand = (typeof BLUR_TYPES)[number];
 export declare type BooleanOperation = 'Difference' | 'Intersection' | 'Union' | 'XOR';
 
 /** @public */
-export declare type BoolPropertyName = 'alwaysOnBottom' | 'alwaysOnTop' | 'clipped' | 'flip/horizontal' | 'flip/vertical' | 'highlightEnabled' | 'includedInExport' | 'placeholder/enabled' | 'playback/playing' | 'playback/soloPlaybackEnabled' | 'scene/aspectRatioLock' | 'selected' | 'selectionEnabled' | 'transformLocked' | 'visible' | 'blur/enabled' | 'dropShadow/clip' | 'dropShadow/enabled' | 'fill/enabled' | 'page/guides/gridEnabled' | 'page/guides/gridSnapEnabled' | 'page/marginEnabled' | 'placeholderControls/showButton' | 'placeholderControls/showOverlay' | 'playback/looping' | 'playback/muted' | 'stroke/enabled' | 'backgroundColor/enabled' | 'placeholderBehavior/enabled' | 'text/automaticFontSizeEnabled' | 'text/clipLinesOutsideOfFrame' | 'text/hasClippedLines' | 'track/automaticallyManageBlockOffsets' | 'caption/automaticFontSizeEnabled' | 'caption/clipLinesOutsideOfFrame' | 'caption/hasClippedLines' | 'captionTrack/automaticallyManageBlockOffsets' | 'animation/slide/fade' | 'animation/pan/fade' | 'animation/blur/fade' | 'animation/zoom/fade' | 'animation/crop_zoom/fade' | 'animation/spin/fade' | 'animation/block_swipe_text/useTextColor' | 'animation/spread_text/fade' | 'animation/ken_burns/fade' | 'effect/enabled' | (string & {});
+export declare type BoolPropertyName = 'alwaysOnBottom' | 'alwaysOnTop' | 'clipped' | 'flip/horizontal' | 'flip/vertical' | 'highlightEnabled' | 'includedInExport' | 'placeholder/enabled' | 'playback/playing' | 'playback/soloPlaybackEnabled' | 'scene/aspectRatioLock' | 'selected' | 'selectionEnabled' | 'transformLocked' | 'visible' | 'blur/enabled' | 'dropShadow/clip' | 'dropShadow/enabled' | 'fill/enabled' | 'page/guides/gridEnabled' | 'page/guides/gridSnapEnabled' | 'page/marginEnabled' | 'placeholderControls/showButton' | 'placeholderControls/showOverlay' | 'playback/looping' | 'playback/muted' | 'stroke/enabled' | 'backgroundColor/enabled' | 'placeholderBehavior/enabled' | 'text/automaticFontSizeEnabled' | 'text/clipLinesOutsideOfFrame' | 'text/hasClippedLines' | 'text/useLigatures' | 'text/useKerning' | 'text/useContextualLigatures' | 'text/useDiscretionaryLigatures' | 'track/automaticallyManageBlockOffsets' | 'caption/automaticFontSizeEnabled' | 'caption/clipLinesOutsideOfFrame' | 'caption/hasClippedLines' | 'caption/useLigatures' | 'caption/useKerning' | 'caption/useContextualLigatures' | 'caption/useDiscretionaryLigatures' | 'captionTrack/automaticallyManageBlockOffsets' | 'animation/slide/fade' | 'animation/pan/fade' | 'animation/blur/fade' | 'animation/zoom/fade' | 'animation/crop_zoom/fade' | 'animation/spin/fade' | 'animation/block_swipe_text/useTextColor' | 'animation/spread_text/fade' | 'animation/ken_burns/fade' | 'effect/enabled' | (string & {});
 
 /**
  * Represents a buffer of data.
@@ -6101,8 +6254,10 @@ export declare type CaptionVerticalAlignment = (typeof CaptionVerticalAlignmentV
 export declare const CaptionVerticalAlignmentValues: readonly ["Top", "Bottom", "Center"];
 
 /**
- * Tight ink-paint bounding box of a single grapheme, in global scene coordinates.
- * @public
+ * Tight ink-paint bounding box of a single grapheme, in global scene
+ * coordinates. Returned by `block.getTextCharacterInkBoxes`. The baseline
+ * Y is reported separately because it does not equal `y + height` (the
+ * box is the tight ink rect; the baseline anchors glyph descenders).
  */
 export declare interface CharacterInkBox {
     /** Global X of the tight ink rect (left edge, Y-down scene space). */
@@ -6113,7 +6268,7 @@ export declare interface CharacterInkBox {
     width: number;
     /** Height of the tight ink rect. */
     height: number;
-    /** Global Y of the glyph baseline (needed for underline/cursor overlays). */
+    /** Global Y of the glyph baseline. */
     baselineY: number;
 }
 
@@ -7757,7 +7912,7 @@ export declare type EnginePluginContext = {
 export declare type EnumPropertyName = 'blend/mode' | 'contentFill/mode' | 'height/mode' | 'position/x/mode' | 'position/y/mode' | 'scene/designUnit' | 'scene/layout' | 'scene/mode' | 'width/mode' | 'page/guides/source' | 'stroke/cornerGeometry' | 'stroke/position' | 'stroke/style' | 'text/horizontalAlignment' | 'text/verticalAlignment' | 'cutout/type' | 'caption/horizontalAlignment' | 'caption/verticalAlignment' | 'animationEasing' | 'textAnimationWritingStyle' | 'animation/grow/direction' | 'animation/wipe/direction' | 'animation/baseline/direction' | 'animation/spin/direction' | 'animation/spin_loop/direction' | 'animation/jump_loop/direction' | 'animation/typewriter_text/writingStyle' | 'animation/block_swipe_text/direction' | 'animation/merge_text/direction' | 'animation/ken_burns/direction' | 'animation/scale_loop/direction' | 'fill/pixelStream/orientation' | 'shape/vector_path/fillRule' | (string & {});
 
 /** @public */
-export declare type EnumValues = BlendMode | ContentFillMode | HeightMode | PageGuidesSource | PositionXMode | PositionYMode | SceneDesignUnit | SceneLayout | SceneMode | WidthMode | StrokeCornerGeometry | StrokePosition | StrokeStyle | TextHorizontalAlignment | TextVerticalAlignment | CutoutType | CaptionHorizontalAlignment | CaptionVerticalAlignment | AnimationEasing | TextAnimationWritingStyle | AnimationGrowDirection | AnimationWipeDirection | AnimationBaselineDirection | AnimationSpinDirection | AnimationSpinLoopDirection | AnimationJumpLoopDirection | AnimationTypewriterTextWritingStyle | AnimationBlockSwipeTextDirection | AnimationMergeTextDirection | AnimationKenBurnsDirection | AnimationScaleLoopDirection | FillPixelStreamOrientation | ShapeVectorPathFillRule | (string & {});
+export declare type EnumValues = BlendMode | ContentFillMode | HeightMode | PageGuidesSource | PositionXMode | PositionYMode | SceneDesignUnit | SceneLayout | SceneMode | WidthMode | StrokeCap | StrokeCornerGeometry | StrokePosition | StrokeStyle | TextHorizontalAlignment | TextVerticalAlignment | CutoutType | CaptionHorizontalAlignment | CaptionVerticalAlignment | AnimationEasing | TextAnimationWritingStyle | AnimationGrowDirection | AnimationWipeDirection | AnimationBaselineDirection | AnimationSpinDirection | AnimationSpinLoopDirection | AnimationJumpLoopDirection | AnimationTypewriterTextWritingStyle | AnimationBlockSwipeTextDirection | AnimationMergeTextDirection | AnimationKenBurnsDirection | AnimationScaleLoopDirection | FillPixelStreamOrientation | ShapeVectorPathFillRule | (string & {});
 
 /**
  * @public Subscribe to block lifecycle events in the design engine.
@@ -7986,16 +8141,13 @@ declare interface Flip {
 export declare type FloatPropertyName = 'globalBoundingBox/height' | 'globalBoundingBox/width' | 'globalBoundingBox/x' | 'globalBoundingBox/y' | 'height' | 'lastFrame/height' | 'lastFrame/width' | 'lastFrame/x' | 'lastFrame/y' | 'position/x' | 'position/y' | 'rotation' | 'scene/dpi' | 'scene/pageDimensions/height' | 'scene/pageDimensions/width' | 'scene/pixelScaleFactor' | 'width' | 'camera/pixelRatio' | 'camera/resolution/height' | 'camera/resolution/width' | 'camera/zoomLevel' | 'dropShadow/blurRadius/x' | 'dropShadow/blurRadius/y' | 'dropShadow/offset/x' | 'dropShadow/offset/y' | 'page/guides/gridSpacingX' | 'page/guides/gridSpacingY' | 'page/margin/bottom' | 'page/margin/left' | 'page/margin/right' | 'page/margin/top' | 'playback/speed' | 'playback/volume' | 'stroke/width' | 'opacity' | 'backgroundColor/cornerRadius' | 'backgroundColor/paddingBottom' | 'backgroundColor/paddingLeft' | 'backgroundColor/paddingRight' | 'backgroundColor/paddingTop' | 'text/fontSize' | 'text/letterSpacing' | 'text/lineHeight' | 'text/maxAutomaticFontSize' | 'text/minAutomaticFontSize' | 'text/paragraphSpacing' | 'cutout/offset' | 'cutout/smoothing' | 'caption/fontSize' | 'caption/letterSpacing' | 'caption/lineHeight' | 'caption/maxAutomaticFontSize' | 'caption/minAutomaticFontSize' | 'caption/paragraphSpacing' | 'animation/slide/direction' | 'textAnimationOverlap' | 'animation/pan/direction' | 'animation/pan/distance' | 'animation/blur/intensity' | 'animation/grow/scaleFactor' | 'animation/crop_zoom/scale' | 'animation/spin/intensity' | 'animation/blur_loop/intensity' | 'animation/pulsating_loop/intensity' | 'animation/breathing_loop/intensity' | 'animation/jump_loop/intensity' | 'animation/sway_loop/intensity' | 'animation/scale_loop/startScale' | 'animation/scale_loop/endScale' | 'animation/spread_text/intensity' | 'animation/merge_text/intensity' | 'animation/ken_burns/travelDistanceRatio' | 'animation/ken_burns/zoomIntensity' | 'blur/uniform/intensity' | 'blur/linear/blurRadius' | 'blur/linear/x1' | 'blur/linear/x2' | 'blur/linear/y1' | 'blur/linear/y2' | 'blur/mirrored/blurRadius' | 'blur/mirrored/gradientSize' | 'blur/mirrored/size' | 'blur/mirrored/x1' | 'blur/mirrored/x2' | 'blur/mirrored/y1' | 'blur/mirrored/y2' | 'blur/radial/blurRadius' | 'blur/radial/gradientRadius' | 'blur/radial/radius' | 'blur/radial/x' | 'blur/radial/y' | 'effect/adjustments/blacks' | 'effect/adjustments/brightness' | 'effect/adjustments/clarity' | 'effect/adjustments/contrast' | 'effect/adjustments/exposure' | 'effect/adjustments/gamma' | 'effect/adjustments/highlights' | 'effect/adjustments/saturation' | 'effect/adjustments/shadows' | 'effect/adjustments/sharpness' | 'effect/adjustments/temperature' | 'effect/adjustments/whites' | 'effect/cross_cut/offset' | 'effect/cross_cut/slices' | 'effect/cross_cut/speedV' | 'effect/cross_cut/time' | 'effect/dot_pattern/blur' | 'effect/dot_pattern/dots' | 'effect/dot_pattern/size' | 'effect/duotone_filter/intensity' | 'effect/extrude_blur/amount' | 'effect/glow/amount' | 'effect/glow/darkness' | 'effect/glow/size' | 'effect/green_screen/colorMatch' | 'effect/green_screen/smoothness' | 'effect/green_screen/spill' | 'effect/half_tone/angle' | 'effect/half_tone/scale' | 'effect/linocut/scale' | 'effect/liquid/amount' | 'effect/liquid/scale' | 'effect/liquid/time' | 'effect/lut_filter/intensity' | 'effect/outliner/amount' | 'effect/outliner/passthrough' | 'effect/posterize/levels' | 'effect/radial_pixel/radius' | 'effect/radial_pixel/segments' | 'effect/recolor/brightnessMatch' | 'effect/recolor/colorMatch' | 'effect/recolor/smoothness' | 'effect/shifter/amount' | 'effect/shifter/angle' | 'effect/tilt_shift/amount' | 'effect/tilt_shift/position' | 'effect/tv_glitch/distortion' | 'effect/tv_glitch/distortion2' | 'effect/tv_glitch/rollSpeed' | 'effect/tv_glitch/speed' | 'effect/vignette/darkness' | 'effect/vignette/offset' | 'fill/gradient/linear/endPointX' | 'fill/gradient/linear/endPointY' | 'fill/gradient/linear/startPointX' | 'fill/gradient/linear/startPointY' | 'fill/gradient/radial/centerPointX' | 'fill/gradient/radial/centerPointY' | 'fill/gradient/radial/radius' | 'fill/gradient/conical/centerPointX' | 'fill/gradient/conical/centerPointY' | 'shape/rect/cornerRadiusBL' | 'shape/rect/cornerRadiusBR' | 'shape/rect/cornerRadiusTL' | 'shape/rect/cornerRadiusTR' | 'shape/polygon/cornerRadius' | 'shape/star/innerDiameter' | 'shape/vector_path/cornerRadius' | 'shape/vector_path/height' | 'shape/vector_path/width' | (string & {});
 
 /**
- * Represents a font.
- *
- * The Font interface defines the structure of a font within the Creative Editor SDK.
- * It includes properties for the uri, subFamily, weight, and style.
- *
- * @public
+ * Individual font within a typeface. Field optionality matches `@cesdk/engine`
+ * (WASM) — fields not present in the engine response are simply omitted
+ * rather than empty strings.
  */
 export declare interface Font {
     uri: string;
-    subFamily: string;
+    subFamily?: string;
     weight?: FontWeight;
     style?: FontStyle;
 }
@@ -8035,23 +8187,12 @@ export declare interface FontMetrics {
  */
 export declare type FontSizeUnit = SceneDesignUnit | 'Point';
 
-/**
- * Represents the style of a font.
- *
- * The FontStyle type defines the possible styles of a font within the Creative Editor SDK.
- * Each style corresponds to a different appearance, allowing for flexibility in how fonts are styled.
- *
- * @public
- */
+/** Allowed font styles. Mirrors the WASM `FontStyle` union. */
 export declare type FontStyle = 'normal' | 'italic';
 
 /**
- * Represents the weight of a font.
- *
- * The FontWeight type defines the possible weights of a font within the Creative Editor SDK.
- * Each weight corresponds to a different thickness, allowing for flexibility in how fonts are styled.
- *
- * @public
+ * Allowed font weights. Mirrors the `@cesdk/engine` (WASM) `FontWeight`
+ * union so a single `Font` is interchangeable across bindings.
  */
 export declare type FontWeight = 'thin' | 'extraLight' | 'light' | 'normal' | 'medium' | 'semiBold' | 'bold' | 'extraBold' | 'heavy';
 
@@ -9658,6 +9799,12 @@ export declare interface SpotColor {
 /** @public */
 export declare type StringPropertyName = 'name' | 'scene/pageFormatId' | 'type' | 'uuid' | 'page/titleTemplate' | 'audio/fileURI' | 'text/externalReference' | 'text/fontFileUri' | 'text/text' | 'text/typeface' | 'cutout/path' | 'caption/externalReference' | 'caption/fontFileUri' | 'caption/text' | 'caption/typeface' | 'effect/lut_filter/lutFileURI' | 'fill/image/externalReference' | 'fill/image/imageFileURI' | 'fill/image/previewFileURI' | 'fill/video/fileURI' | 'shape/vector_path/path' | (string & {});
 
+/** @public */
+export declare type StrokeCap = (typeof StrokeCapValues)[number];
+
+/** @public */
+export declare const StrokeCapValues: readonly ["Butt", "Round", "Square"];
+
 /** @public */
 export declare type StrokeCornerGeometry = (typeof StrokeCornerGeometryValues)[number];
 
@@ -9826,18 +9973,9 @@ export declare interface TransientResource {
     size: number;
 }
 
-/**
- * Represents a typeface.
- *
- * The Typeface interface defines the structure of a typeface within the Creative Editor SDK.
- * It includes properties for the name and fonts.
- *
- * @public
- */
+/** Typeface definition */
 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[];
 }