@cesdk/engine 1.57.0-nightly.20250722 → 1.57.0-rc.0

package/index.d.ts

@@ -115,7 +115,17 @@ export declare type AnimationTypeLonghand = `//ly.img.ubq/animation/${AnimationT
  */
 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' | 'ken_burns';
 
-/** @public */
+/**
+ * Represents the application MIME types used in the editor.
+ *
+ * @categoryDescription Application MIME Type
+ * Defines the possible application MIME types used in the editor.
+ * - 'application/octet-stream': Binary data format.
+ * - 'application/pdf': PDF document format.
+ * - 'application/zip': ZIP archive format.
+ *
+ * @public
+ */
 export declare type ApplicationMimeType = Extract<MimeType_2, 'application/octet-stream' | 'application/pdf' | 'application/zip'>;
 
 /**
@@ -259,6 +269,13 @@ export declare class AssetAPI {
      * @param applyAssetToBlock - An optional callback that can be used to override the default behavior of applying an asset result to a given block.
      */
     addLocalSource(id: string, supportedMimeTypes?: string[], applyAsset?: (asset: CompleteAssetResult) => Promise<DesignBlockId | undefined>, applyAssetToBlock?: (asset: CompleteAssetResult, block: DesignBlockId) => Promise<void>): void;
+    /**
+     * Creates a new local asset source from a JSON string containing asset definitions.
+     * @param contentJSON - The JSON string containing the asset definitions.
+     * @param basePath - An optional base path with which \{\{base_url\}\} strings in the assets should be replaced. If no value is provided, settings.basePath is used.
+     * @returns The ID of the newly created asset source or an error if that could not be created.
+     */
+    addLocalAssetSourceFromJSONString(contentJSON: string, basePath?: string): Promise<string>;
     /**
      * Remove a registered asset source.
      *
@@ -848,13 +865,33 @@ export declare interface AssetResult extends Asset {
     };
 }
 
-/** @public */
+/**
+ * Represents the credits for an asset result.
+ *
+ * The `AssetResultCredits` interface provides a set of properties that describe the credits
+ * for an asset result, including the name and URL of the credits.
+ *
+ * @categoryDescription AssetResultCredits
+ * Methods for working with the credits of asset results.
+ *
+ * @public
+ */
 declare interface AssetResultCredits {
     name: string;
     url: string;
 }
 
-/** @public */
+/**
+ * Represents the license for an asset result.
+ *
+ * The `AssetResultLicense` interface provides a set of properties that describe the license
+ * for an asset result, including the name and URL of the license.
+ *
+ * @categoryDescription AssetResultLicense
+ * Methods for working with the license of asset results.
+ *
+ * @public
+ */
 declare interface AssetResultLicense {
     name: string;
     url: string;
@@ -979,6 +1016,17 @@ export declare interface AssetStringProperty {
 export declare type AssetTransformPreset = AssetFixedAspectRatio | AssetFreeAspectRatio | AssetFixedSize;
 
 /**
+ * Represents the options for exporting audio.
+ *
+ * @categoryDescription Audio Export Options
+ * Defines the possible options for exporting audio.
+ * - 'mimeType': The MIME type of the output audio file.
+ * - 'onProgress': A callback which reports on the progress of the export.
+ * - 'timeOffset': The time offset in seconds relative to the target block.
+ * - 'duration': The duration in seconds of the final audio.
+ * - 'sampleRate': The sample rate of the exported audio.
+ * - 'numberOfChannels': The number of channels of the exported audio.
+ *
  * @public
  */
 export declare type AudioExportOptions = {
@@ -1018,10 +1066,50 @@ export declare type AudioExportOptions = {
     numberOfChannels?: number;
 };
 
-/** @public */
+/**
+ * Represents the audio MIME types used in the editor.
+ *
+ * @categoryDescription Audio MIME Type
+ * Defines the possible audio MIME types used in the editor.
+ * - 'audio/wav': WAV audio format.
+ *
+ * @public
+ */
 export declare type AudioMimeType = Extract<MimeType_2, 'audio/wav'>;
 
 /**
+ * Represents the blend mode of a layer or effect.
+ *
+ * @categoryDescription Blend Mode
+ * Defines the possible blend modes for a layer or effect.
+ * - 'PassThrough': The layer or effect is not blended and is rendered as is.
+ * - 'Normal': The layer or effect is blended normally.
+ * - 'Darken': The layer or effect is blended to darken the underlying content.
+ * - 'Multiply': The layer or effect is blended to multiply the underlying content.
+ * - 'ColorBurn': The layer or effect is blended to burn the underlying content.
+ * - 'LinearBurn': The layer or effect is blended to linearly burn the underlying content.
+ * - 'DarkenColor': The layer or effect is blended to darken the underlying content based on color.
+ * - 'Lighten': The layer or effect is blended to lighten the underlying content.
+ * - 'Screen': The layer or effect is blended to screen the underlying content.
+ * - 'ColorDodge': The layer or effect is blended to dodge the underlying content.
+ * - 'LinearDodge': The layer or effect is blended to linearly dodge the underlying content.
+ * - 'LightenColor': The layer or effect is blended to lighten the underlying content based on color.
+ * - 'Overlay': The layer or effect is blended to overlay the underlying content.
+ * - 'SoftLight': The layer or effect is blended to soft light the underlying content.
+ * - 'HardLight': The layer or effect is blended to hard light the underlying content.
+ * - 'VividLight': The layer or effect is blended to vivid light the underlying content.
+ * - 'LinearLight': The layer or effect is blended to linearly light the underlying content.
+ * - 'PinLight': The layer or effect is blended to pin light the underlying content.
+ * - 'HardMix': The layer or effect is blended to hard mix the underlying content.
+ * - 'Difference': The layer or effect is blended to difference the underlying content.
+ * - 'Exclusion': The layer or effect is blended to exclude the underlying content.
+ * - 'Subtract': The layer or effect is blended to subtract the underlying content.
+ * - 'Divide': The layer or effect is blended to divide the underlying content.
+ * - 'Hue': The layer or effect is blended to hue the underlying content.
+ * - 'Saturation': The layer or effect is blended to saturate the underlying content.
+ * - 'Color': The layer or effect is blended to color the underlying content.
+ * - 'Luminosity': The layer or effect is blended to luminosity the underlying content.
+ *
  * @public
  */
 export declare type BlendMode = 'PassThrough' | 'Normal' | 'Darken' | 'Multiply' | 'ColorBurn' | 'LinearBurn' | 'DarkenColor' | 'Lighten' | 'Screen' | 'ColorDodge' | 'LinearDodge' | 'LightenColor' | 'Overlay' | 'SoftLight' | 'HardLight' | 'VividLight' | 'LinearLight' | 'PinLight' | 'HardMix' | 'Difference' | 'Exclusion' | 'Subtract' | 'Divide' | 'Hue' | 'Saturation' | 'Color' | 'Luminosity';
@@ -4924,29 +5012,79 @@ export declare class BlockAPI {
     moveToBackgroundTrack(block: DesignBlockId): void;
 }
 
-/** @public */
+/**
+ * Represents an event related to a design block.
+ *
+ * The `BlockEvent` interface provides a set of properties that describe an event related to
+ * a design block, including the block ID and the type of event.
+ *
+ * @categoryDescription BlockEvent
+ * Methods for working with events related to design blocks.
+ *
+ * @public
+ */
 export declare interface BlockEvent {
     block: DesignBlockId;
     type: 'Created' | 'Updated' | 'Destroyed';
 }
 
-/** @public Describes the state of the block which affect its rendering. */
+/**
+ * Represents the state of a design block.
+ *
+ * The `BlockState` type is a union of the `BlockStateError`, `BlockStatePending`, and
+ * `BlockStateReady` interfaces, which describe the possible states of a design block.
+ *
+ * @categoryDescription BlockState
+ * Methods for working with the state of design blocks.
+ *
+ * @public
+ */
 export declare type BlockState = BlockStateError | BlockStatePending | BlockStateReady;
 
-/** @public There's an error preventing rendering. */
+/**
+ * Represents an error state for a design block.
+ *
+ * The `BlockStateError` interface provides a set of properties that describe an error state
+ * for a design block, including the type of error and a description of the error.
+ *
+ * @categoryDescription BlockStateError
+ * Methods for working with error states for design blocks.
+ *
+ * @public
+ */
 export declare interface BlockStateError {
     type: 'Error';
     error: 'AudioDecoding' | 'ImageDecoding' | 'FileFetch' | 'Unknown' | 'VideoDecoding';
 }
 
-/** @public There is an ongoing operation on the block. Rendering may be affected. */
+/**
+ * Represents a pending state for a design block.
+ *
+ * The `BlockStatePending` interface provides a set of properties that describe a pending
+ * state for a design block, including the type of state and the progress of the operation.
+ *
+ * @categoryDescription BlockStatePending
+ * Methods for working with pending states for design blocks.
+ *
+ * @public
+ */
 export declare interface BlockStatePending {
     type: 'Pending';
     /** Expected range is [0, 1] */
     progress: number;
 }
 
-/** @public The block is ready to be rendered. */
+/**
+ * Represents a ready state for a design block.
+ *
+ * The `BlockStateReady` interface provides a set of properties that describe a ready state
+ * for a design block, including the type of state.
+ *
+ * @categoryDescription BlockStateReady
+ * Methods for working with ready states for design blocks.
+ *
+ * @public
+ */
 export declare interface BlockStateReady {
     type: 'Ready';
 }
@@ -4987,13 +5125,30 @@ export declare type BlurTypeLonghand = `//ly.img.ubq/blur/${BlurTypeShorthand}`;
 export declare type BlurTypeShorthand = 'uniform' | 'linear' | 'mirrored' | 'radial';
 
 /**
- * Names of boolean operations.
+ * Represents the names of boolean operations.
+ *
+ * @categoryDescription Boolean Operation
+ * Defines the possible boolean operations.
+ * - 'Difference': The difference between two shapes.
+ * - 'Intersection': The intersection of two shapes.
+ * - 'Union': The union of two shapes.
+ * - 'XOR': The exclusive OR of two shapes.
  *
  * @public
  */
 export declare type BooleanOperation = 'Difference' | 'Intersection' | 'Union' | 'XOR';
 
-/** @public */
+/**
+ * Represents a buffer of data.
+ *
+ * The `Buffer` interface provides a set of properties that describe a buffer of data,
+ * including a handle and the buffer itself.
+ *
+ * @categoryDescription Buffer
+ * Methods for working with buffers of data.
+ *
+ * @public
+ */
 export declare interface Buffer {
     handle: string;
     buffer: Uint8Array;
@@ -5018,12 +5173,29 @@ export declare function checkVideoExportSupport(): Promise<void>;
 export declare function checkVideoSupport(): void;
 
 /**
+ * Represents a color in the CMYK color space.
+ *
+ * The `CMYK` type is a tuple that contains four numbers representing the cyan, magenta,
+ * yellow, and black components of the color.
+ *
+ * @categoryDescription CMYK
+ * Methods for working with colors in the CMYK color space.
+ *
  * @public
  */
 export declare type CMYK = [c: number, m: number, y: number, k: number];
 
 /**
- * All components between 0 and 1
+ * Represents a CMYK color value.
+ *
+ * @categoryDescription CMYK Color
+ * Defines a CMYK color value with components between 0 and 1.
+ * - 'c': The cyan component.
+ * - 'm': The magenta component.
+ * - 'y': The yellow component.
+ * - 'k': The black component.
+ * - 'tint': The tint factor.
+ *
  * @public
  */
 export declare interface CMYKColor {
@@ -5040,12 +5212,27 @@ export declare interface CMYKColor {
 }
 
 /**
- * A type alias for all color types supported by the engine.
+ * Represents all color types supported by the engine.
+ *
+ * @categoryDescription Color
+ * Defines all color types supported by the engine.
+ * - 'RGBAColor': An RGBA color value.
+ * - 'CMYKColor': A CMYK color value.
+ * - 'SpotColor': A spot color value.
+ *
  * @public
  */
 export declare type Color = RGBAColor | CMYKColor | SpotColor;
 
 /**
+ * Represents the color space used in the editor.
+ *
+ * @categoryDescription Color Space
+ * Defines the possible color spaces used in the editor.
+ * - 'sRGB': The sRGB color space.
+ * - 'CMYK': The CMYK color space.
+ * - 'SpotColor': The spot color space.
+ *
  * @public
  */
 export declare type ColorSpace = 'sRGB' | 'CMYK' | 'SpotColor';
@@ -5068,7 +5255,19 @@ export declare interface CompleteAssetResult extends AssetResult {
     active: boolean;
 }
 
-/** @public */
+/**
+ * Specifies the configuration for the Creative Editor SDK.
+ *
+ * The `Configuration` interface provides a set of properties that control the behavior
+ * and settings of the editor. These options include settings for the base URL, license,
+ * user ID, core settings, logger, feature flags, presets, force WebGL1, audio output,
+ * and role.
+ *
+ * @categoryDescription Configuration
+ * Methods for configuring the settings of the Creative Editor SDK.
+ *
+ * @public
+ */
 export declare interface Configuration {
     baseURL: string;
     license: string;
@@ -5111,9 +5310,14 @@ export declare interface Configuration {
 }
 
 /**
- * - Crop: Manual crop.
- * - Cover: Automatically cover the entire frame.
- * - Contain: Automatically contain content inside frame.
+ * Represents the mode for filling content within a block.
+ *
+ * The `ContentFillMode` type provides a set of values that control the mode for
+ * filling content within a block. These options include settings for cropping,
+ * covering, and containing the content.
+ *
+ * @categoryDescription ContentFillMode
+ * Methods for configuring the mode for filling content within a block.
  *
  * @public
  */
@@ -5336,16 +5540,49 @@ export declare interface CursorEvent extends CustomEvent<string> {
 }
 
 /**
+ * Represents the operation performed on a cutout.
+ *
+ * @categoryDescription Cutout Operation
+ * Defines the possible operations for a cutout.
+ * - 'Difference': The difference between two shapes.
+ * - 'Intersection': The intersection of two shapes.
+ * - 'Union': The union of two shapes.
+ * - 'XOR': The exclusive OR of two shapes.
+ *
  * @public
  */
 export declare type CutoutOperation = 'Difference' | 'Intersection' | 'Union' | 'XOR';
 
 /**
+ * Represents the type of a cutout.
+ *
+ * @categoryDescription Cutout Type
+ * Defines the possible types for a cutout.
+ * - 'Solid': A solid cutout.
+ * - 'Dashed': A dashed cutout.
+ *
  * @public
  */
 export declare type CutoutType = 'Solid' | 'Dashed';
 
 /**
+ * Represents the default asset source IDs used in the editor.
+ *
+ * @categoryDescription Default Asset Source ID
+ * Defines the possible default asset source IDs used in the editor.
+ * - 'ly.img.sticker': Asset source for stickers.
+ * - 'ly.img.vectorpath': Asset source for vector paths.
+ * - 'ly.img.colors.defaultPalette': Asset source for the default color palette.
+ * - 'ly.img.filter.lut': Asset source for LUT filters.
+ * - 'ly.img.filter.duotone': Asset source for duotone filters.
+ * - 'ly.img.effect': Asset source for effects.
+ * - 'ly.img.blur': Asset source for blur effects.
+ * - 'ly.img.typeface': Asset source for typefaces.
+ * - 'ly.img.page.presets': Asset source for page presets.
+ * - 'ly.img.page.presets.video': Asset source for video page presets.
+ * - 'ly.img.crop.presets': Asset source for crop presets.
+ * - 'ly.img.captionPresets': Asset source for caption presets.
+ *
  * @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' | 'ly.img.typeface' | 'ly.img.page.presets' | 'ly.img.page.presets.video' | 'ly.img.crop.presets' | 'ly.img.captionPresets';
@@ -5354,6 +5591,20 @@ export declare type DefaultAssetSourceId = 'ly.img.sticker' | 'ly.img.vectorpath
 export declare function defaultLogger(message: string, level?: LogLevel): void;
 
 /**
+ * Represents the default demo asset source IDs used in the editor.
+ *
+ * @categoryDescription Default Demo Asset Source ID
+ * Defines the possible default demo asset source IDs used in the editor.
+ * - 'ly.img.template': Asset source for templates.
+ * - 'ly.img.image.upload': Asset source for uploading images.
+ * - 'ly.img.video.upload': Asset source for uploading videos.
+ * - 'ly.img.audio.upload': Asset source for uploading audio.
+ * - 'ly.img.image': Asset source for images.
+ * - 'ly.img.video': Asset source for videos.
+ * - 'ly.img.video.template': Asset source for video templates.
+ * - 'ly.img.audio': Asset source for audio.
+ * - 'ly.img.textComponents': Asset source for text components.
+ *
  * @public
  */
 export declare type DemoAssetSourceId = 'ly.img.template' | 'ly.img.image.upload' | 'ly.img.video.upload' | 'ly.img.audio.upload' | 'ly.img.image' | 'ly.img.video' | 'ly.img.video.template' | 'ly.img.audio' | 'ly.img.textComponents';
@@ -5415,7 +5666,20 @@ export declare type DropShadowOptions = {
     };
 };
 
-/** @public */
+/**
+ * Represents the current edit mode of the editor.
+ *
+ * @categoryDescription Edit Mode
+ * Defines the possible edit modes of the editor.
+ * - 'Transform': The mode for transforming blocks (e.g., resizing, rotating).
+ * - 'Crop': The mode for cropping images.
+ * - 'Text': The mode for editing text.
+ * - 'Playback': The mode for playing back animations or videos.
+ * - 'Trim': The mode for trimming video or audio.
+ * - 'Custom': A custom edit mode defined by the user.
+ *
+ * @public
+ */
 export declare type EditMode = 'Transform' | 'Crop' | 'Text' | 'Playback' | 'Trim' | (string & {});
 
 /**
@@ -6210,14 +6474,32 @@ export declare type EffectTypeLonghand = `//ly.img.ubq/effect/${EffectTypeShorth
  */
 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';
 
-/** @public */
+/**
+ * Represents an engine plugin.
+ *
+ * @categoryDescription Engine Plugin
+ * Defines the structure of an engine plugin, including its name, version, and initialization function.
+ * - 'name': The name of the plugin.
+ * - 'version': The version of the plugin.
+ * - 'initialize': The function to initialize the plugin with the provided context.
+ *
+ * @public
+ */
 export declare interface EnginePlugin {
     name: string;
     version: string;
     initialize: (context: EnginePluginContext) => void;
 }
 
-/** @public */
+/**
+ * Represents the context for an engine plugin.
+ *
+ * @categoryDescription Engine Plugin Context
+ * Defines the context provided to an engine plugin, including APIs for assets, blocks, scenes, editor, events, and variables.
+ * - 'engine': The engine instance containing APIs for asset, block, scene, editor, event, and variable management.
+ *
+ * @public
+ */
 export declare type EnginePluginContext = {
     engine: {
         asset: AssetAPI;
@@ -6254,13 +6536,41 @@ export declare class EventAPI {
     subscribe: (blocks: DesignBlockId[], callback: (events: BlockEvent[]) => void) => (() => void);
 }
 
-/** @public */
+/**
+ * Specifies options for exporting audio design blocks to various formats.
+ *
+ * The `ExportAudioOptions` interface provides a set of properties that control the
+ * behavior and quality of the exported audio content. These options include settings
+ * for sample rate and number of channels.
+ *
+ * @categoryDescription Export Audio Options
+ * Methods for configuring export settings for audio design blocks.
+ *
+ * @public
+ */
 declare interface ExportAudioOptions {
     sampleRate: number;
     numberOfChannels: number;
 }
 
 /**
+ * Represents the options for exporting a design block.
+ *
+ * @categoryDescription Export Options
+ * Defines the possible options for exporting a design block.
+ * - 'mimeType': The MIME type of the output file.
+ * - 'pngCompressionLevel': The PNG compression level to use, when exporting to PNG.
+ * - 'jpegQuality': The JPEG quality to use when encoding to JPEG.
+ * - 'webpQuality': The WebP quality to use when encoding to WebP.
+ * - 'targetWidth': An optional target width used in conjunction with target height.
+ * - 'targetHeight': An optional target height used in conjunction with target width.
+ * - 'exportPdfWithHighCompatibility': Export the PDF document with a higher compatibility to different PDF
+ viewers.
+ * - 'exportPdfWithUnderlayer': Export the PDF document with an underlayer.
+ * - 'underlayerSpotColorName': The name of the spot color to be used for the underlayer's fill.
+ * - 'underlayerOffset': The adjustment in size of the shape of the underlayer.
+ * - 'abortSignal': An abort signal that can be used to cancel the export.
+ *
  * @public
  */
 export declare type ExportOptions = {
@@ -6332,7 +6642,19 @@ export declare type ExportOptions = {
     abortSignal?: AbortSignal;
 };
 
-/** @public */
+/**
+ * Specifies options for exporting design blocks to various formats.
+ *
+ * The `ExportOptions` interface provides a set of properties that control the
+ * behavior and quality of the exported content. These options include settings
+ * for JPEG, WebP, PNG, and PDF exports, as well as options for resizing and
+ * adding underlayers.
+ *
+ * @categoryDescription Export Options
+ * Methods for configuring export settings for design blocks.
+ *
+ * @public
+ */
 declare interface ExportOptions_2 {
     jpegQuality: number;
     webpQuality: number;
@@ -6346,7 +6668,18 @@ declare interface ExportOptions_2 {
     underlayerOffset: number;
 }
 
-/** @public */
+/**
+ * Specifies options for exporting video design blocks to various formats.
+ *
+ * The `ExportVideoOptions` interface provides a set of properties that control the
+ * behavior and quality of the exported video content. These options include settings
+ * for H.264 profile, level, framerate, video bitrate, audio bitrate, and resizing.
+ *
+ * @categoryDescription Export Video Options
+ * Methods for configuring export settings for video design blocks.
+ *
+ * @public
+ */
 declare interface ExportVideoOptions {
     h264Profile: number;
     h264Level: number;
@@ -6380,7 +6713,19 @@ export declare type FillTypeLonghand = `//ly.img.ubq/fill/${FillTypeShorthand}`;
  */
 export declare type FillTypeShorthand = 'color' | 'gradient/linear' | 'gradient/radial' | 'gradient/conical' | 'image' | 'video' | 'pixelStream';
 
-/** @public */
+/**
+ * Represents a query for finding assets.
+ *
+ * The `FindAssetsQuery` interface provides a set of properties that describe a query for finding
+ * assets, including the number of assets per page, the page number, the query string, the tags,
+ * the groups, the excluded groups, the locale, the sorting order, the sort key, and whether to
+ * sort active assets first.
+ *
+ * @categoryDescription FindAssetsQuery
+ * Methods for working with queries for finding assets.
+ *
+ * @public
+ */
 declare interface FindAssetsQuery {
     perPage: number;
     page: number;
@@ -6394,13 +6739,33 @@ declare interface FindAssetsQuery {
     sortActiveFirst: boolean;
 }
 
-/** @public */
+/**
+ * Specifies the horizontal and vertical flip states of a design block.
+ *
+ * The `Flip` interface provides a set of properties that indicate whether the design block
+ * is flipped horizontally or vertically.
+ *
+ * @categoryDescription Flip
+ * Methods for configuring the flip states of a design block.
+ *
+ * @public
+ */
 declare interface Flip {
     horizontal: boolean;
     vertical: boolean;
 }
 
-/** @public */
+/**
+ * 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.
+ *
+ * @categoryDescription Fonts
+ * Methods for managing fonts within the editor.
+ *
+ * @public
+ */
 export declare interface Font {
     uri: string;
     subFamily: string;
@@ -6408,13 +6773,42 @@ export declare interface Font {
     style?: FontStyle;
 }
 
-/** @public */
+/**
+ * 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.
+ *
+ * @categoryDescription Fonts
+ * Methods for managing font styles within the editor.
+ *
+ * @public
+ */
 export declare type FontStyle = 'normal' | 'italic';
 
-/** @public */
+/**
+ * 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.
+ *
+ * @categoryDescription Fonts
+ * Methods for managing font weights within the editor.
+ *
+ * @public
+ */
 export declare type FontWeight = 'thin' | 'extraLight' | 'light' | 'normal' | 'medium' | 'semiBold' | 'bold' | 'extraBold' | 'heavy';
 
-/** @public */
+/**
+ * Represents a gradient color stop.
+ *
+ * @categoryDescription Gradient Color Stop
+ * Defines a gradient color stop with a color and a stop position.
+ * - 'color': The color value.
+ * - 'stop': The relative position of the color within the gradient in the range [0, 1].
+ *
+ * @public
+ */
 export declare interface GradientColorStop {
     /** A color value within a gradient. */
     color: Color;
@@ -6423,6 +6817,14 @@ export declare interface GradientColorStop {
 }
 
 /**
+ * Represents a gradient stop in the RGBA color space.
+ *
+ * The `GradientstopRGBA` type is a tuple that contains five numbers representing the stop
+ * position and the red, green, blue, and alpha components of the color.
+ *
+ * @categoryDescription GradientstopRGBA
+ * Methods for working with gradient stops in the RGBA color space.
+ *
  * @public
  */
 export declare type GradientstopRGBA = [
@@ -6434,8 +6836,13 @@ a: number
 ];
 
 /**
- * A hexadecimal color value (RGB or RGBA) that starts with a '#'
- * @example #6686FF or #6686FFFF
+ * Represents a hexadecimal color value (RGB or RGBA) that starts with a '#'.
+ *
+ * @categoryDescription Hex Color String
+ * Defines a hexadecimal color value that starts with a '#'.
+ * - '#6686FF': A hexadecimal color value for RGB.
+ * - '#6686FFFF': A hexadecimal color value for RGBA.
+ *
  * @public
  */
 export declare type HexColorString = string;
@@ -6447,9 +6854,14 @@ export declare type HexColorString = string;
 export declare type HistoryId = number;
 
 /**
- * - Left: The blocks get left aligned.
- * - Right: The blocks get right aligned.
- * - Center: The blocks get center aligned.
+ * Represents the horizontal alignment of blocks.
+ *
+ * The `HorizontalBlockAlignment` type provides a set of values that control the
+ * horizontal alignment of blocks. These options include settings for aligning
+ * blocks to the left, right, or center.
+ *
+ * @categoryDescription HorizontalBlockAlignment
+ * Methods for configuring the horizontal alignment of blocks.
  *
  * @public
  */
@@ -6488,23 +6900,46 @@ export declare interface HTMLCreativeEngineCanvasElement extends HTMLElement {
     clear(): void;
 }
 
-/** @public */
+/**
+ * Represents the image MIME types used in the editor.
+ *
+ * @categoryDescription Image MIME Type
+ * Defines the possible image MIME types used in the editor.
+ * - 'image/png': PNG image format.
+ * - 'image/jpeg': JPEG image format.
+ * - 'image/webp': WebP image format.
+ * - 'image/x-tga': TGA image format.
+ *
+ * @public
+ */
 export declare type ImageMimeType = Extract<MimeType_2, 'image/png' | 'image/jpeg' | 'image/webp' | 'image/x-tga'>;
 
 /**
- * Type guard for {@link CMYKColor}
+ * Type guard for {@link CMYKColor}.
+ *
+ * @categoryDescription Type Guard
+ * Defines a type guard for CMYKColor.
+ *
  * @public
  */
 export declare function isCMYKColor(color: Color): color is CMYKColor;
 
 /**
- * Type guard for {@link RGBAColor}
+ * Type guard for {@link RGBAColor}.
+ *
+ * @categoryDescription Type Guard
+ * Defines a type guard for RGBAColor.
+ *
  * @public
  */
 export declare function isRGBAColor(color: Color): color is RGBAColor;
 
 /**
- * Type guard for {@link SpotColor}
+ * Type guard for {@link SpotColor}.
+ *
+ * @categoryDescription Type Guard
+ * Defines a type guard for SpotColor.
+ *
  * @public
  */
 export declare function isSpotColor(color: Color): color is SpotColor;
@@ -6515,15 +6950,45 @@ export declare function isSpotColor(color: Color): color is SpotColor;
  */
 declare type Locale = string;
 
-/** @public */
+/**
+ * Represents a logger function.
+ *
+ * The Logger interface defines the structure of a logger function within the Creative Editor SDK.
+ * It includes a method for logging messages with an optional log level.
+ *
+ * @categoryDescription Logging
+ * Methods for managing logging within the editor.
+ *
+ * @public
+ */
 export declare interface Logger {
     (message: string, level?: LogLevel): void;
 }
 
-/** @public */
+/**
+ * Provides logging functionality for the Creative Editor SDK.
+ *
+ * The `Logger` interface and associated types define a standardized way to log messages
+ * at different severity levels within the SDK. This allows developers to track the
+ * behavior of the editor, diagnose issues, and understand the flow of operations.
+ *
+ * @categoryDescription Logging
+ * Methods for managing logging within the editor.
+ *
+ * @public
+ */
 export declare type LogLevel = 'Info' | 'Warning' | 'Error';
 
 /**
+ * Provides a set of predefined log levels for the Creative Editor SDK.
+ *
+ * The `LogLevel` object contains constants representing different severity levels
+ * for logging messages. These levels can be used to categorize log messages based
+ * on their importance and urgency.
+ *
+ * @categoryDescription Logging
+ * Methods for managing logging within the editor.
+ *
  * @public
  * @deprecated Specifying log levels via `LogLevel.Info` has been deprecated.
  * Please use the desired LogLevel string directly.
@@ -6535,9 +7000,24 @@ export declare const LogLevel: {
 };
 
 /**
+ * Represents the MIME types used in the editor.
+ *
+ * @categoryDescription MIME Type
+ * Defines the possible MIME types used in the editor.
+ * - 'image/png': PNG image format.
+ * - 'image/jpeg': JPEG image format.
+ * - 'image/webp': WebP image format.
+ * - 'image/x-tga': TGA image format.
+ * - 'audio/wav': WAV audio format.
+ * - 'video/mp4': MP4 video format.
+ * - 'video/quicktime': QuickTime video format.
+ * - 'application/octet-stream': Binary data format.
+ * - 'application/pdf': PDF document format.
+ * - 'application/zip': ZIP archive format.
+ *
  * @public
- * @deprecated Use The `MimeType` string literal types instead.
- * */
+ * @deprecated Use the `MimeType` string literal types instead.
+ */
 declare const MimeType_2: {
     readonly Png: "image/png";
     readonly Jpeg: "image/jpeg";
@@ -6551,7 +7031,24 @@ declare const MimeType_2: {
     readonly Zip: "application/zip";
 };
 
-/** @public */
+/**
+ * Represents the MIME types used in the editor.
+ *
+ * @categoryDescription MIME Type
+ * Defines the possible MIME types used in the editor.
+ * - 'image/png': PNG image format.
+ * - 'image/jpeg': JPEG image format.
+ * - 'image/webp': WebP image format.
+ * - 'image/x-tga': TGA image format.
+ * - 'audio/wav': WAV audio format.
+ * - 'video/mp4': MP4 video format.
+ * - 'video/quicktime': QuickTime video format.
+ * - 'application/octet-stream': Binary data format.
+ * - 'application/pdf': PDF document format.
+ * - 'application/zip': ZIP archive format.
+ *
+ * @public
+ */
 declare type MimeType_2 = (typeof MimeType_2)[keyof typeof MimeType_2];
 export { MimeType_2 as MimeType }
 
@@ -6596,22 +7093,43 @@ export declare interface PageDuration {
 }
 
 /**
- * A color definition for the custom color palette.
- * The RGB and CMYK components must all be specified in the range [0-1].
+ * Represents a color definition for the custom color palette.
+ *
+ * @categoryDescription Palette Color
+ * Defines a color definition for the custom color palette.
+ * - 'HexColorString': A hexadecimal color value.
+ * - 'RGBColor': An RGB color value.
+ * - 'RGBAColor': An RGBA color value.
+ * - 'SpotColor': A spot color value.
+ *
  * @public
  */
 export declare type PaletteColor = HexColorString | RGBColor | RGBAColor | SpotColor;
 
 /**
- * - Absolute: Position in absolute design units.
- * - Percent: Position in relation to the block's parent's size in percent, where 1.0 means 100%.
- * - Auto: Position is automatically determined
+ * Represents the mode for positioning blocks.
+ *
+ * The `PositionMode` type provides a set of values that control the mode for
+ * positioning blocks. These options include settings for absolute positioning,
+ * percentage-based positioning, and automatic positioning.
+ *
+ * @categoryDescription PositionMode
+ * Methods for configuring the mode for positioning blocks.
  *
  * @public
  */
 export declare type PositionMode = 'Absolute' | 'Percent' | 'Auto';
 
-/** @public */
+/**
+ * Represents the various types of properties that can be associated with design blocks.
+ * Each type corresponds to a different kind of data that can be used to define the properties
+ * of a design block within the system.
+ *
+ * @categoryDescription Property Types
+ * Defines the different types of properties that can be used to describe design blocks.
+ *
+ * @public
+ */
 export declare type PropertyType = 'Bool' | 'Int' | 'Float' | 'String' | 'Color' | 'Enum' | 'Struct' | 'Double' | 'SourceSet';
 
 /**
@@ -6710,12 +7228,28 @@ export declare interface RefocusEvent extends CustomEvent<EventTarget | null> {
 }
 
 /**
+ * Represents a color in the RGBA color space.
+ *
+ * The `RGBA` type is a tuple that contains four numbers representing the red, green,
+ * blue, and alpha components of the color.
+ *
+ * @categoryDescription RGBA
+ * Methods for working with colors in the RGBA color space.
+ *
  * @public
  */
 export declare type RGBA = [r: number, g: number, b: number, a: number];
 
 /**
- * All components between 0 and 1
+ * Represents an RGBA color value.
+ *
+ * @categoryDescription RGBA Color
+ * Defines an RGBA color value with components between 0 and 1.
+ * - 'r': The red component.
+ * - 'g': The green component.
+ * - 'b': The blue component.
+ * - 'a': The alpha component.
+ *
  * @public
  */
 export declare interface RGBAColor {
@@ -6730,7 +7264,14 @@ export declare interface RGBAColor {
 }
 
 /**
- * All components between 0 and 1
+ * Represents an RGB color value.
+ *
+ * @categoryDescription RGB Color
+ * Defines an RGB color value with components between 0 and 1.
+ * - 'r': The red component.
+ * - 'g': The green component.
+ * - 'b': The blue component.
+ *
  * @public
  */
 export declare interface RGBColor {
@@ -6742,7 +7283,17 @@ export declare interface RGBColor {
     b: number;
 }
 
-/** @public */
+/**
+ * Represents a role string.
+ *
+ * The RoleString type defines the possible roles within the Creative Editor SDK.
+ * Each role corresponds to a different level of access and permissions, allowing for flexibility in how users are managed.
+ *
+ * @categoryDescription Roles
+ * Methods for managing roles within the editor.
+ *
+ * @public
+ */
 export declare type RoleString = 'Creator' | 'Adopter' | 'Viewer' | 'Presenter';
 
 /**
@@ -7302,23 +7853,130 @@ export declare type SceneLayout = 'Free' | 'VerticalStack' | 'HorizontalStack' |
 export declare type SceneMode = 'Design' | 'Video';
 
 /**
+ * @public
+ * Represents the various scopes that define the capabilities and permissions
+ * within the Creative Editor SDK. Each scope corresponds to a specific
+ * functionality or action that can be performed within the editor.
+ *
+ * The `Scope` type is used to control access to different features and operations,
+ * allowing for fine-grained control over what actions are permitted.
+ *
+ * @categoryDescription Scopes
+ * Defines the various scopes that control the capabilities and permissions
+ * within the Creative Editor SDK.
+ *
  * @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' | 'appearance/animation' | 'lifecycle/destroy' | 'lifecycle/duplicate' | 'editor/add' | 'editor/select';
 
-/** @public */
+/**
+ * Represents the boolean settings available in the editor.
+ *
+ * @categoryDescription Boolean Settings
+ * Defines the possible boolean settings in the editor.
+ * - 'controlGizmo/showCropHandles': Show crop handles in the control gizmo.
+ * - 'controlGizmo/showCropScaleHandles': Show crop scale handles in the control gizmo.
+ * - 'controlGizmo/showMoveHandles': Show move handles in the control gizmo.
+ * - 'controlGizmo/showResizeHandles': Show resize handles in the control gizmo.
+ * - 'controlGizmo/showRotateHandles': Show rotate handles in the control gizmo.
+ * - 'controlGizmo/showScaleHandles': Show scale handles in the control gizmo.
+ * - 'doubleClickToCropEnabled': Enable double-click to crop.
+ * - 'features/singlePageModeEnabled': Enable single page mode.
+ * - 'features/pageCarouselEnabled': Enable page carousel.
+ * - 'features/transformEditsRetainCoverMode': Retain cover mode during transform edits.
+ * - 'mouse/enableScroll': Enable mouse scroll.
+ * - 'mouse/enableZoom': Enable mouse zoom.
+ * - 'page/allowCropInteraction': Allow crop interaction on pages.
+ * - 'page/allowMoveInteraction': Allow move interaction on pages.
+ * - 'page/allowResizeInteraction': Allow resize interaction on pages.
+ * - 'page/allowRotateInteraction': Allow rotate interaction on pages.
+ * - 'page/dimOutOfPageAreas': Dim out-of-page areas.
+ * - 'page/restrictResizeInteractionToFixedAspectRatio': Restrict resize interaction to fixed aspect ratio.
+ * - 'page/moveChildrenWhenCroppingFill': Move children when cropping fill.
+ * - 'page/title/appendPageName': Append page name to the title.
+ * - 'page/title/show': Show page title.
+ * - 'page/title/showOnSinglePage': Show page title on single page.
+ * - 'page/title/showPageTitleTemplate': Show page title template.
+ * - 'placeholderControls/showButton': Show button in placeholder controls.
+ * - 'placeholderControls/showOverlay': Show overlay in placeholder controls.
+ * - 'blockAnimations/enabled': Enable block animations.
+ * - 'showBuildVersion': Show build version.
+ * - 'touch/dragStartCanSelect': Allow drag start to select.
+ * - 'touch/singlePointPanning': Enable single-point panning.
+ * - 'useSystemFontFallback': Use system font fallback.
+ * - 'forceSystemEmojis': Force system emojis.
+ *
+ * @public
+ */
 export declare type SettingsBool = 'controlGizmo/showCropHandles' | 'controlGizmo/showCropScaleHandles' | 'controlGizmo/showMoveHandles' | 'controlGizmo/showResizeHandles' | 'controlGizmo/showRotateHandles' | 'controlGizmo/showScaleHandles' | 'doubleClickToCropEnabled' | 'features/singlePageModeEnabled' | 'features/pageCarouselEnabled' | 'features/transformEditsRetainCoverMode' | 'mouse/enableScroll' | 'mouse/enableZoom' | 'page/allowCropInteraction' | 'page/allowMoveInteraction' | 'page/allowResizeInteraction' | 'page/allowRotateInteraction' | 'page/dimOutOfPageAreas' | 'page/restrictResizeInteractionToFixedAspectRatio' | 'page/moveChildrenWhenCroppingFill' | 'page/title/appendPageName' | 'page/title/show' | 'page/title/showOnSinglePage' | 'page/title/showPageTitleTemplate' | 'placeholderControls/showButton' | 'placeholderControls/showOverlay' | 'blockAnimations/enabled' | 'showBuildVersion' | 'touch/dragStartCanSelect' | 'touch/singlePointPanning' | 'useSystemFontFallback' | 'forceSystemEmojis';
 
-/** @public
+/**
+ * Represents the color settings available in the editor.
+ *
+ * @categoryDescription Color Settings
+ * Defines the possible color settings in the editor.
+ * - 'borderOutlineColor': The color of the border outline.
+ * - 'clearColor': The clear color.
+ * - 'colorMaskingSettings/maskColor': The color used for masking.
+ * - 'cropOverlayColor': The color of the crop overlay.
+ * - 'errorStateColor': The color indicating an error state.
+ * - 'highlightColor': The highlight color.
+ * - 'page/innerBorderColor': The color of the inner border of the page.
+ * - 'page/marginFillColor': The color of the margin fill.
+ * - 'page/marginFrameColor': The color of the margin frame.
+ * - 'page/outerBorderColor': The color of the outer border of the page.
+ * - 'page/title/color': The color of the page title.
+ * - 'placeholderHighlightColor': The highlight color for placeholders.
+ * - 'progressColor': The color indicating progress.
+ * - 'rotationSnappingGuideColor': The color of the rotation snapping guide.
+ * - 'ruleOfThirdsLineColor': The color of the rule of thirds lines.
+ * - 'snappingGuideColor': The color of the snapping guide.
+ * - 'textVariableHighlightColor': The highlight color for text variables.
+ *
+ * @public
  */
 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' | 'ruleOfThirdsLineColor' | 'snappingGuideColor' | 'textVariableHighlightColor';
 
-/** @public
+/**
+ * Represents the color settings available in the editor.
+ *
+ * @categoryDescription Color Settings
+ * Defines the possible color settings in the editor.
+ * - 'borderOutlineColor': The color of the border outline.
+ * - 'clearColor': The clear color.
+ * - 'colorMaskingSettings/maskColor': The color used for masking.
+ * - 'cropOverlayColor': The color of the crop overlay.
+ * - 'errorStateColor': The color indicating an error state.
+ * - 'highlightColor': The highlight color.
+ * - 'page/innerBorderColor': The color of the inner border of the page.
+ * - 'page/marginFillColor': The color of the margin fill.
+ * - 'page/marginFrameColor': The color of the margin frame.
+ * - 'page/outerBorderColor': The color of the outer border of the page.
+ * - 'page/title/color': The color of the page title.
+ * - 'placeholderHighlightColor': The highlight color for placeholders.
+ * - 'progressColor': The color indicating progress.
+ * - 'rotationSnappingGuideColor': The color of the rotation snapping guide.
+ * - 'ruleOfThirdsLineColor': The color of the rule of thirds lines.
+ * - 'snappingGuideColor': The color of the snapping guide.
+ * - 'textVariableHighlightColor': The highlight color for text variables.
+ *
+ * @public
  * @deprecated Use SettingsColor instead.
  */
 export declare type SettingsColorRGBA = SettingsColor;
 
-/** @public */
+/**
+ * Represents the enum settings available in the editor.
+ *
+ * @categoryDescription Enum Settings
+ * Defines the possible enum settings in the editor.
+ * - 'doubleClickSelectionMode': The mode for double-click selection.
+ * - 'touch/pinchAction': The action for pinch gestures.
+ * - 'touch/rotateAction': The action for rotate gestures.
+ * - 'camera/clamping/overshootMode': The mode for camera clamping overshoot.
+ *
+ * @public
+ */
 export declare type SettingsEnum = {
     doubleClickSelectionMode: 'Direct' | 'Hierarchical';
     'touch/pinchAction': 'None' | 'Zoom' | 'Scale';
@@ -7326,13 +7984,50 @@ export declare type SettingsEnum = {
     'camera/clamping/overshootMode': 'Center' | 'Reverse';
 };
 
-/** @public */
+/**
+ * Represents the float settings available in the editor.
+ *
+ * @categoryDescription Float Settings
+ * Defines the possible float settings in the editor.
+ * - 'controlGizmo/blockScaleDownLimit': The scale down limit for the control gizmo block.
+ * - 'positionSnappingThreshold': The threshold for position snapping.
+ * - 'rotationSnappingThreshold': The threshold for rotation snapping.
+ *
+ * @public
+ */
 export declare type SettingsFloat = 'controlGizmo/blockScaleDownLimit' | 'positionSnappingThreshold' | 'rotationSnappingThreshold';
 
-/** @public */
+/**
+ * Represents the string settings available in the editor.
+ *
+ * @categoryDescription String Settings
+ * Defines the possible string settings in the editor.
+ * - 'basePath': The base path for resources.
+ * - 'defaultEmojiFontFileUri': The default URI for the emoji font file.
+ * - 'defaultFontFileUri': The default URI for the font file.
+ * - 'license': The license key.
+ * - 'page/title/fontFileUri': The URI for the page title font file.
+ * - 'page/title/separator': The separator for the page title.
+ * - 'fallbackFontUri': The URI for the fallback font.
+ *
+ * @public
+ */
 export declare type SettingsString = 'basePath' | 'defaultEmojiFontFileUri' | 'defaultFontFileUri' | 'license' | 'page/title/fontFileUri' | 'page/title/separator' | 'fallbackFontUri';
 
-/** @public */
+/**
+ * Represents the type of a setting.
+ *
+ * @categoryDescription Setting Type
+ * Defines the possible types for a setting.
+ * - 'Bool': A boolean setting.
+ * - 'Int': An integer setting.
+ * - 'Float': A float setting.
+ * - 'String': A string setting.
+ * - 'Color': A color setting.
+ * - 'Enum': An enum setting.
+ *
+ * @public
+ */
 export declare type SettingType = 'Bool' | 'Int' | 'Float' | 'String' | 'Color' | 'Enum';
 
 /**
@@ -7364,9 +8059,14 @@ export declare interface Size2 {
 }
 
 /**
- * - Absolute: Size in absolute design units.
- * - Percent: Size in relation to the block's parent's size in percent, where 1.0 means 100%.
- * - Auto: Size is automatically determined
+ * Represents the mode for sizing blocks.
+ *
+ * The `SizeMode` type provides a set of values that control the mode for sizing
+ * blocks. These options include settings for absolute sizing, percentage-based
+ * sizing, and automatic sizing.
+ *
+ * @categoryDescription SizeMode
+ * Methods for configuring the mode for sizing blocks.
  *
  * @public
  */
@@ -7389,23 +8089,75 @@ export declare interface Source {
     height: number;
 }
 
-/** @public */
+/**
+ * Represents a spot color value.
+ *
+ * @categoryDescription Spot Color
+ * Defines a spot color value with a name, tint, and external reference.
+ * - 'name': The name of the spot color.
+ * - 'tint': The tint factor.
+ * - 'externalReference': The external reference of the spot color.
+ *
+ * @public
+ */
 export declare interface SpotColor {
     name: string;
     tint: number;
     externalReference: string;
 }
 
-/** @public */
+/**
+ * Represents the corner geometry of a stroke.
+ *
+ * @categoryDescription Stroke Corner Geometry
+ * Defines the possible corner geometries for a stroke.
+ * - 'Bevel': A beveled corner.
+ * - 'Miter': A mitered corner.
+ * - 'Round': A rounded corner.
+ *
+ * @public
+ */
 export declare type StrokeCornerGeometry = 'Bevel' | 'Miter' | 'Round';
 
-/**  @public */
+/**
+ * Represents the position of a stroke relative to the shape's boundary.
+ *
+ * @categoryDescription Stroke Position
+ * Defines the possible positions for a stroke relative to the shape's boundary.
+ * - 'Center': The stroke is centered on the shape's boundary.
+ * - 'Inner': The stroke is inside the shape's boundary.
+ * - 'Outer': The stroke is outside the shape's boundary.
+ *
+ * @public
+ */
 export declare type StrokePosition = 'Center' | 'Inner' | 'Outer';
 
-/**  @public */
+/**
+ * Represents the style of a stroke.
+ *
+ * @categoryDescription Stroke Style
+ * Defines the possible styles for a stroke.
+ * - 'Dashed': A dashed line stroke.
+ * - 'DashedRound': A dashed line stroke with rounded ends.
+ * - 'Dotted': A dotted line stroke.
+ * - 'LongDashed': A long dashed line stroke.
+ * - 'LongDashedRound': A long dashed line stroke with rounded ends.
+ * - 'Solid': A solid line stroke.
+ *
+ * @public
+ */
 export declare type StrokeStyle = 'Dashed' | 'DashedRound' | 'Dotted' | 'LongDashed' | 'LongDashedRound' | 'Solid';
 
-/** @public */
+/**
+ * Represents a subscription to an event.
+ *
+ * The `Subscription` type is a number that uniquely identifies a subscription to an event.
+ *
+ * @categoryDescription Subscription
+ * Methods for working with subscriptions to events.
+ *
+ * @public
+ */
 declare type Subscription = number;
 
 /**
@@ -7436,17 +8188,46 @@ export declare function supportsVideoExport(): Promise<boolean>;
 export declare function supportsWasm(): boolean;
 
 /**
+ * Represents the text case of a text block.
+ *
+ * @categoryDescription Text Case
+ * Defines the possible text cases for a text block.
+ * - 'Normal': The text is in its normal case.
+ * - 'Uppercase': The text is in uppercase.
+ * - 'Lowercase': The text is in lowercase.
+ * - 'Titlecase': The text is in title case.
+ *
  * @public
  */
 export declare type TextCase = 'Normal' | 'Uppercase' | 'Lowercase' | 'Titlecase';
 
-/** @public */
+/**
+ * Represents a transient resource.
+ *
+ * The `TransientResource` interface provides a set of properties that describe a transient
+ * resource, including a URI and the size of the resource.
+ *
+ * @categoryDescription TransientResource
+ * Methods for working with transient resources.
+ *
+ * @public
+ */
 export declare interface TransientResource {
     uri: string;
     size: number;
 }
 
-/** @public */
+/**
+ * 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.
+ *
+ * @categoryDescription Fonts
+ * Methods for managing typefaces within the editor.
+ *
+ * @public
+ */
 export declare interface Typeface {
     /** The unique name of this typeface */
     name: string;
@@ -7455,7 +8236,16 @@ export declare interface Typeface {
 }
 
 /**
+ * Represents a typeface definition used in the editor.
+ *
  * @deprecated This type definition is not used anymore and will be removed.
+ *
+ * @categoryDescription Typeface Definition
+ * Defines the structure of a typeface definition, including metadata, family name, and font details.
+ * - 'meta': Optional metadata for the typeface, including default status, library, and categories.
+ * - 'family': The name of the typeface family.
+ * - 'fonts': An array of font definitions, each containing a font URL, weight, and style.
+ *
  * @public
  */
 export declare type TypefaceDefinition = {
@@ -7540,9 +8330,14 @@ export declare interface Vec3 {
 }
 
 /**
- * - Top: The blocks get top aligned.
- * - Bottom: The blocks get bottom aligned.
- * - Center: The blocks get center aligned.
+ * Represents the vertical alignment of blocks.
+ *
+ * The `VerticalBlockAlignment` type provides a set of values that control the
+ * vertical alignment of blocks. These options include settings for aligning
+ * blocks to the top, bottom, or center.
+ *
+ * @categoryDescription VerticalBlockAlignment
+ * Methods for configuring the vertical alignment of blocks.
  *
  * @public
  */
@@ -7555,6 +8350,24 @@ export declare type VerticalBlockAlignment = 'Top' | 'Bottom' | 'Center';
 export declare type VerticalTextAlignment = 'Top' | 'Bottom' | 'Center';
 
 /**
+ * Represents the options for exporting a video.
+ *
+ * @categoryDescription Video Export Options
+ * Defines the possible options for exporting a video.
+ * - 'mimeType': The MIME type of the output video file.
+ * - 'onProgress': A callback which reports on the progress of the export.
+ * - 'h264Profile': Determines the encoder feature set and in turn the quality, size and speed of the
+ encoding process.
+ * - 'h264Level': Controls the H.264 encoding level.
+ * - 'videoBitrate': The video bitrate in bits per second.
+ * - 'audioBitrate': The audio bitrate in bits per second.
+ * - 'timeOffset': The time offset in seconds of the scene's timeline from which the video will start.
+ * - 'duration': The duration in seconds of the final video.
+ * - 'framerate': The target framerate of the exported video in Hz.
+ * - 'targetWidth': An optional target width used in conjunction with target height.
+ * - 'targetHeight': An optional target height used in conjunction with target width.
+ * - 'abortSignal': An abort signal that can be used to cancel the export.
+ *
  * @public
  */
 export declare type VideoExportOptions = {
@@ -7628,13 +8441,27 @@ export declare type VideoExportOptions = {
     abortSignal?: AbortSignal;
 };
 
-/** @public */
+/**
+ * Represents the video MIME types used in the editor.
+ *
+ * @categoryDescription Video MIME Type
+ * Defines the possible video MIME types used in the editor.
+ * - 'video/mp4': MP4 video format.
+ * - 'video/quicktime': QuickTime video format.
+ *
+ * @public
+ */
 export declare type VideoMimeType = Extract<MimeType_2, 'video/mp4' | 'video/quicktime'>;
 
 /**
- * Describes a rectangle on the screen
- * - `x` and `y` indicate the position
- * - `w` and `h` indicate the width and height
+ * Describes a rectangle on the screen.
+ *
+ * The `XYWH` type is a tuple that contains four numbers representing the x and y coordinates
+ * of the top-left corner of the rectangle, as well as the width and height of the rectangle.
+ *
+ * @categoryDescription XYWH
+ * Methods for working with rectangles on the screen.
+ *
  * @public
  */
 export declare type XYWH = [x: number, y: number, w: number, h: number];