@cesdk/engine 1.60.0-nightly.20250901 → 1.60.0-nightly.20250903

package/index.d.ts

@@ -1466,11 +1466,12 @@ export declare class BlockAPI {
     /**
      * Loads blocks from a remote archive URL.
      *
+     * The URL should be that of a file previously saved with `block.saveToArchive`.
      * The blocks are not attached by default and won't be visible until attached to a page or the scene.
      * The UUID of the loaded blocks is replaced with a new one.
      *
      * @category Block Lifecycle
-     * @param url - The URL to load the blocks from.
+     * @param url - The URL of the blocks archive file.
      * @returns A promise that resolves with a list of handles representing the found blocks or an error.
      * @example
      * ```typescript
@@ -5852,6 +5853,14 @@ export declare type EditMode = 'Transform' | 'Crop' | 'Text' | 'Playback' | 'Tri
  * resource handling, and global scope controls. It serves as the central configuration and control interface
  * for the design editor engine.
  *
+ * ## Settings API
+ *
+ * The recommended way to work with settings is through the unified API:
+ * - `setSetting<K>(key: K, value: Settings[K])` - Set any setting value
+ * - `getSetting<K>(key: K): Settings[K]` - Get any setting value
+ *
+ * Legacy methods are available in the `deprecated` namespace for backward compatibility.
+ *
  * @categoryDescription Edit Mode Management
  * Control the editor's current editing mode and interaction state.
  *
@@ -6101,110 +6110,151 @@ export declare class EditorAPI {
      * @returns A method to unsubscribe from the event.
      */
     onRoleChanged: (callback: (role: RoleString) => void) => (() => void);
+    /**
+     * Set a setting value using the unified API.
+     * The type of the value is automatically inferred from the key.
+     *
+     * @category Editor Settings
+     * @param keypath - The setting key from Settings
+     * @param value - The value to set (type-safe based on key)
+     * @throws Error if the keypath is invalid or value type doesn't match
+     *
+     * @example
+     * ```typescript
+     * // Boolean setting
+     * engine.editor.setSetting('doubleClickToCropEnabled', false);
+     *
+     * // Color setting
+     * engine.editor.setSetting('highlightColor', { r: 1, g: 0, b: 1, a: 1 });
+     *
+     * // Enum setting
+     * engine.editor.setSetting('doubleClickSelectionMode', 'Direct');
+     * ```
+     */
+    setSetting<K extends SettingKey>(keypath: OptionalPrefix<K>, value: SettingValueType<K>): void;
+    /**
+     * Get a setting value using the unified API.
+     * The return type is automatically inferred from the key.
+     *
+     * @category Editor Settings
+     * @param keypath - The setting key from Settings
+     * @returns The value of the setting (type-safe based on key)
+     * @throws Error if the keypath is invalid
+     *
+     * @example
+     * ```typescript
+     * // Boolean setting
+     * const cropEnabled = engine.editor.getSetting('doubleClickToCropEnabled');
+     *
+     * // Color setting
+     * const highlight = engine.editor.getSetting('highlightColor');
+     *
+     * // Enum setting
+     * const selectionMode = engine.editor.getSetting('doubleClickSelectionMode');
+     * ```
+     */
+    getSetting<K extends SettingKey>(keypath: OptionalPrefix<K>): SettingValueType<K>;
+
+
     /**
      * Set a boolean setting value.
      *
+     * @deprecated Use setSetting() instead.
+     *
      * @category Editor Settings
      * @param keypath - The settings keypath, e.g. `doubleClickToCropEnabled`.
      * @param value - The boolean value to set.
      * @throws Error if the keypath is invalid.
      */
-    setSettingBool(keypath: SettingsBool, value: boolean): void;
-    /** @deprecated Support for `ubq://` prefixed keypaths will be removed in a future release. */
-    setSettingBool(keypath: `ubq://${SettingsBool}`, value: boolean): void;
-
+    setSettingBool(keypath: OptionalPrefix<SettingsBool>, value: boolean): void;
     /**
      * Get a boolean setting value.
      *
+     * @deprecated Use getSetting() instead.
      * @category Editor Settings
      * @param keypath - The settings keypath, e.g. `doubleClickToCropEnabled`.
      * @returns The boolean value of the setting.
      * @throws Error if the keypath is invalid.
      */
-    getSettingBool(keypath: SettingsBool): boolean;
-    /** @deprecated Support for `ubq://` prefixed keypaths will be removed in a future release. */
-    getSettingBool(keypath: `ubq://${SettingsBool}`): boolean;
-
+    getSettingBool(keypath: OptionalPrefix<SettingsBool>): boolean;
     /**
      * Set an integer setting value.
      *
+     * @deprecated Use setSetting() instead.
      * @category Editor Settings
      * @param keypath - The settings keypath.
      * @param value - The integer value to set.
      * @throws Error if the keypath is invalid.
      */
-    setSettingInt(keypath: string, value: number): void;
+    setSettingInt(keypath: SettingsInt, value: number): void;
     /**
      * Get an integer setting value.
      *
+     * @deprecated Use getSetting() instead.
      * @category Editor Settings
      * @param keypath - The settings keypath.
      * @returns The integer value of the setting.
      * @throws Error if the keypath is invalid.
      */
-    getSettingInt(keypath: string): number;
+    getSettingInt(keypath: SettingsInt): number;
     /**
      * Set a float setting value.
      *
+     * @deprecated Use setSetting() instead.
      * @category Editor Settings
      * @param keypath - The settings keypath, e.g. `positionSnappingThreshold`.
      * @param value - The float value to set.
      * @throws Error if the keypath is invalid.
      */
-    setSettingFloat(keypath: SettingsFloat, value: number): void;
-    /** @deprecated Support for `ubq://` prefixed keypaths will be removed in a future release. */
-    setSettingFloat(keypath: `ubq://${SettingsFloat}`, value: number): void;
+    setSettingFloat(keypath: OptionalPrefix<SettingsFloat>, value: number): void;
     /**
      * Get a float setting value.
      *
+     * @deprecated Use getSetting() instead.
      * @category Editor Settings
      * @param keypath - The settings keypath, e.g. `positionSnappingThreshold`.
      * @returns The float value of the setting.
      * @throws Error if the keypath is invalid.
      */
-    getSettingFloat(keypath: SettingsFloat): number;
-    /** @deprecated Support for `ubq://` prefixed keypaths will be removed in a future release. */
-    getSettingFloat(keypath: `ubq://${SettingsFloat}`): number;
+    getSettingFloat(keypath: OptionalPrefix<SettingsFloat>): number;
     /**
      * Set a string setting value.
      *
+     * @deprecated Use setSetting() instead.
      * @category Editor Settings
      * @param keypath - The settings keypath, e.g. `license`.
      * @param value - The string value to set.
      * @throws Error if the keypath is invalid.
      */
-    setSettingString(keypath: SettingsString, value: string): void;
-    /** @deprecated Support for `ubq://` prefixed keypaths will be removed in a future release. */
-    setSettingString(keypath: `ubq://${SettingsString}`, value: string): void;
+    setSettingString(keypath: OptionalPrefix<SettingsString>, value: string): void;
     /**
      * Get a string setting value.
      *
+     * @deprecated Use getSetting() instead.
      * @category Editor Settings
      * @param keypath - The settings keypath, e.g. `license`.
      * @returns The string value of the setting.
      * @throws Error if the keypath is invalid.
      */
-    getSettingString(keypath: SettingsString): string;
-    /** @deprecated Support for `ubq://` prefixed keypaths will be removed in a future release. */
-    getSettingString(keypath: `ubq://${SettingsString}`): string;
+    getSettingString(keypath: OptionalPrefix<SettingsString>): string;
     /**
      * Set a color setting.
+     *
+     * @deprecated Use setSetting() instead.
      * @category Editor Settings
      * @param keypath - The settings keypath, e.g. `highlightColor`.
      * @param value - The The value to set.
      */
-    setSettingColor(keypath: SettingsColor, value: Color): void;
-    /** @deprecated Support for `ubq://` prefixed keypaths will be removed in a future release. */
-    setSettingColor(keypath: `ubq://${SettingsColor}`, value: Color): void;
+    setSettingColor(keypath: OptionalPrefix<SettingsColor>, value: Color): void;
     /**
      * Get a color setting.
+     *
+     * @deprecated Use getSetting() instead.
      * @category Editor Settings
      * @param keypath - The settings keypath, e.g. `highlightColor`.
      * @throws An error, if the keypath is invalid.
      */
-    getSettingColor(keypath: SettingsColor): Color;
-    /** @deprecated Support for `ubq://` prefixed keypaths will be removed in a future release. */
-    getSettingColor(keypath: `ubq://${SettingsColor}`): Color;
+    getSettingColor(keypath: OptionalPrefix<SettingsColor>): Color;
     /**
      * Set a color setting.
      * @param keypath - The settings keypath, e.g. `highlightColor`.
@@ -6214,34 +6264,32 @@ export declare class EditorAPI {
      * @param a - The alpha color component in the range of 0 to 1.
      * @deprecated Use setSettingColor() instead.
      */
-    setSettingColorRGBA(keypath: SettingsColorRGBA | `ubq://${SettingsColorRGBA}`, r: number, g: number, b: number, a?: number): void;
+    setSettingColorRGBA(keypath: OptionalPrefix<SettingsColorRGBA>, r: number, g: number, b: number, a?: number): void;
     /**
      * Get a color setting.
      * @param keypath - The settings keypath, e.g. `highlightColor`.
      * @returns A tuple of channels red, green, blue and alpha in the range of 0 to 1.
      * @deprecated Use getSettingColor() instead.
      */
-    getSettingColorRGBA(keypath: SettingsColorRGBA | `ubq://${SettingsColorRGBA}`): RGBA;
+    getSettingColorRGBA(keypath: OptionalPrefix<SettingsColorRGBA>): RGBA;
     /**
      * Set an enum setting.
+     *
+     * @deprecated Use setSetting() instead.
      * @category Editor Settings
      * @param keypath - The settings keypath, e.g. `doubleClickSelectionMode`.
      * @param value - The enum value as string.
      */
     setSettingEnum<T extends keyof SettingsEnum>(keypath: T, value: SettingsEnum[T]): void;
-    /** @deprecated Support for `ubq://` prefixed keypaths will be removed in a future release. */
-    setSettingEnum<T extends keyof SettingsEnum>(keypath: `ubq://${T}`, value: SettingsEnum[T]): void;
-
     /**
      * Get an enum setting.
+     *
+     * @deprecated Use getSetting() instead.
      * @category Editor Settings
      * @param keypath - The settings keypath, e.g. `doubleClickSelectionMode`.
      * @returns The value as string.
      */
     getSettingEnum<T extends keyof SettingsEnum>(keypath: T): SettingsEnum[T];
-    /** @deprecated Support for `ubq://` prefixed keypaths will be removed in a future release. */
-    getSettingEnum<T extends keyof SettingsEnum>(keypath: `ubq://${T}`): SettingsEnum[T];
-
     /**
      * Get the possible enum options for a given enum setting.
      * @category Editor Settings
@@ -6249,8 +6297,6 @@ export declare class EditorAPI {
      * @returns The possible enum options as strings.
      */
     getSettingEnumOptions<T extends keyof SettingsEnum>(keypath: T): string[];
-    /** @deprecated Support for `ubq://` prefixed keypaths will be removed in a future release. */
-    getSettingEnumOptions<T extends keyof SettingsEnum>(keypath: `ubq://${T}`): string[];
     /**
      * Set the user role and apply role-dependent defaults.
      *
@@ -6272,7 +6318,7 @@ export declare class EditorAPI {
      * @category Editor Settings
      * @returns A list of settings keypaths.
      */
-    findAllSettings(): string[];
+    findAllSettings(): SettingKey[];
     /**
      * Returns the type of a setting.
      * @category Editor Settings
@@ -7234,6 +7280,12 @@ declare type OffscreenCanvas_2 = {
 };
 export { OffscreenCanvas_2 as OffscreenCanvas }
 
+/**
+ * Type helper for settings keypaths that can optionally include the 'ubq://' prefix.
+ * @public
+ */
+export declare type OptionalPrefix<T extends string> = `ubq://${T}` | T;
+
 /** @public */
 export declare interface PageDuration {
     pageId: DesignBlockId;
@@ -7520,7 +7572,7 @@ export declare class SceneAPI {
      * calls on this engines instance.
      *
      * @category Scene Loading
-     * @param url - The URL of the scene file.
+     * @param url - The URL of the scene archive file.
      * @param overrideEditorConfig - Whether to override editor configuration with settings and data from the scene file. Defaults to false.
      * @returns scene A promise that resolves once the scene was loaded or rejects with an error otherwise.
      */
@@ -8026,95 +8078,216 @@ 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';
 
 /**
- * Represents the boolean settings available in the editor.
+ * Union type of all valid setting keys.
+ * @public
+ */
+export declare type SettingKey = keyof Settings;
+
+/**
+ * Map of all available settings with their types.
+ * This provides type-safe access to all editor settings.
+ *
+ * @public
  *
  * @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';
+ * Boolean settings control various on/off features in the editor:
+ * - Control gizmo visibility settings (crop, move, resize, rotate, scale handles)
+ * - Feature flags (single page mode, page carousel, animations)
+ * - Interaction permissions (mouse scroll/zoom, touch gestures, page interactions)
+ * - Display options (build version, placeholders, page titles)
+ *
+ * @categoryDescription String Settings
+ * String settings configure paths and textual values:
+ * - Resource paths (base path, font URIs)
+ * - License configuration
+ * - Title formatting (separator, font)
+ *
+ * @categoryDescription Float Settings
+ * Float settings define numerical thresholds and limits:
+ * - Snapping thresholds for position and rotation
+ * - Scale limits for control gizmos
+ *
+ * @categoryDescription Integer Settings
+ * Integer settings specify whole number limits:
+ * - Maximum image size constraints
+ *
+ * @categoryDescription Color Settings
+ * Color settings control the visual appearance:
+ * - UI element colors (borders, overlays, highlights)
+ * - Guide colors (snapping, rotation, rule of thirds)
+ * - State colors (error, progress, placeholder highlights)
+ *
+ * @categoryDescription Enum Settings
+ * Enum settings provide predefined choice options:
+ * - Selection modes
+ * - Touch gesture actions
+ * - Camera behavior modes
+ */
+export declare interface Settings {
+    /** Whether to show handles for adjusting the crop area during crop mode. */
+    'controlGizmo/showCropHandles': boolean;
+    /** Whether to display the outer handles that scale the full image during crop. */
+    'controlGizmo/showCropScaleHandles': boolean;
+    /** Whether to show the move handles. */
+    'controlGizmo/showMoveHandles': boolean;
+    /** Whether to display the non-proportional resize handles (edge handles). */
+    'controlGizmo/showResizeHandles': boolean;
+    /** Whether to show the rotation handles. */
+    'controlGizmo/showRotateHandles': boolean;
+    /** Whether to display the proportional scale handles (corner handles). */
+    'controlGizmo/showScaleHandles': boolean;
+    /** Enable double-click to enter crop mode. */
+    doubleClickToCropEnabled: boolean;
+    /** Enable single page mode where only one page is shown at a time. */
+    'features/singlePageModeEnabled': boolean;
+    /** Enable the page carousel for navigating between pages. */
+    'features/pageCarouselEnabled': boolean;
+    /** Whether transform edits should retain the cover mode of the content. */
+    'features/transformEditsRetainCoverMode': boolean;
+    /** Whether the engine processes mouse scroll events. */
+    'mouse/enableScroll': boolean;
+    /** Whether the engine processes mouse zoom events. */
+    'mouse/enableZoom': boolean;
+    /** Whether crop interaction (by handles and gestures) should be possible. */
+    'page/allowCropInteraction': boolean;
+    /** Whether move interaction should be possible when page layout is not controlled by the scene. */
+    'page/allowMoveInteraction': boolean;
+    /** Whether resize interaction (by handles and gestures) should be possible. */
+    'page/allowResizeInteraction': boolean;
+    /** Whether rotation interaction should be possible when page layout is not controlled by the scene. */
+    'page/allowRotateInteraction': boolean;
+    /** Whether the opacity of the region outside of all pages should be reduced. */
+    'page/dimOutOfPageAreas': boolean;
+    /** Whether resize interaction should be restricted to fixed aspect ratio. */
+    'page/restrictResizeInteractionToFixedAspectRatio': boolean;
+    /** Whether children of the page should be transformed to match their old position when cropping. */
+    'page/moveChildrenWhenCroppingFill': boolean;
+    /** Whether to append the page name to the title even if not specified in the template. */
+    'page/title/appendPageName': boolean;
+    /** Whether to show titles above each page. */
+    'page/title/show': boolean;
+    /** Whether to hide the page title when only a single page exists. */
+    'page/title/showOnSinglePage': boolean;
+    /** Whether to include the default page title from page.titleTemplate. */
+    'page/title/showPageTitleTemplate': boolean;
+    /** Whether to show the placeholder button. */
+    'placeholderControls/showButton': boolean;
+    /** Whether to show the overlay pattern for placeholders. */
+    'placeholderControls/showOverlay': boolean;
+    /** Whether animations should be enabled or not. */
+    'blockAnimations/enabled': boolean;
+    /** Whether to display the build version in the UI. */
+    showBuildVersion: boolean;
+    /** Whether drag start can select elements. */
+    'touch/dragStartCanSelect': boolean;
+    /** Whether single-point panning is enabled for touch interactions. */
+    'touch/singlePointPanning': boolean;
+    /** Whether to use system font as fallback for missing glyphs. */
+    useSystemFontFallback: boolean;
+    /** Whether to force the use of system emojis instead of custom emoji fonts. */
+    forceSystemEmojis: boolean;
+    /** The root directory used when resolving relative paths or accessing bundle:// URIs. */
+    basePath: string;
+    /** The URI for the default emoji font file. */
+    defaultEmojiFontFileUri: string;
+    /** The URI for the default font file. */
+    defaultFontFileUri: string;
+    /** The license key for the SDK. */
+    license: string;
+    /** The font file URI for page titles. */
+    'page/title/fontFileUri': string;
+    /** The separator between page number and page name in titles. */
+    'page/title/separator': string;
+    /** The URI for the fallback font used when glyphs are missing. */
+    fallbackFontUri: string;
+    /** Scale-down limit for blocks in screen pixels when scaling with gizmos or touch gestures. */
+    'controlGizmo/blockScaleDownLimit': number;
+    /** The threshold distance in pixels for position snapping. */
+    positionSnappingThreshold: number;
+    /** The threshold angle in degrees for rotation snapping. */
+    rotationSnappingThreshold: number;
+    /** The maximum size (width or height) in pixels for images. */
+    maxImageSize: number;
+    /** The color of the border outline for selected elements. */
+    borderOutlineColor: Color;
+    /** The background clear color. */
+    clearColor: Color;
+    /** The color used for color masking effects. */
+    'colorMaskingSettings/maskColor': Color;
+    /** The color of the crop overlay. */
+    cropOverlayColor: Color;
+    /** The color indicating an error state. */
+    errorStateColor: Color;
+    /** The highlight color for selected or active elements. */
+    highlightColor: Color;
+    /** The color of the inner frame around the page. */
+    'page/innerBorderColor': Color;
+    /** The color filled into the bleed margins of pages. */
+    'page/marginFillColor': Color;
+    /** The color of the frame around the bleed margin area. */
+    'page/marginFrameColor': Color;
+    /** The color of the outer frame around the page. */
+    'page/outerBorderColor': Color;
+    /** The color of page titles visible in preview mode. */
+    'page/title/color': Color;
+    /** The highlight color for placeholder elements. */
+    placeholderHighlightColor: Color;
+    /** The color indicating progress or loading states. */
+    progressColor: Color;
+    /** The color of rotation snapping guide lines. */
+    rotationSnappingGuideColor: Color;
+    /** The color of rule of thirds guide lines. */
+    ruleOfThirdsLineColor: Color;
+    /** The color of snapping guide lines. */
+    snappingGuideColor: Color;
+    /** The highlight color for text variables. */
+    textVariableHighlightColor: Color;
+    /** The selection mode for double-click: Direct selects the clicked element, Hierarchical traverses the hierarchy. */
+    doubleClickSelectionMode: 'Direct' | 'Hierarchical';
+    /** The action performed for pinch gestures: None, Zoom, or Scale. */
+    'touch/pinchAction': 'None' | 'Zoom' | 'Scale';
+    /** The action performed for rotate gestures: None or Rotate. */
+    'touch/rotateAction': 'None' | 'Rotate';
+    /** Controls behavior when clamp area is smaller than viewport: Center or Reverse. */
+    'camera/clamping/overshootMode': 'Center' | 'Reverse';
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+}
 
 /**
- * Represents the color settings available in the editor.
+ * Represents the boolean 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';
+ * @deprecated Use keyof Settings or extract the boolean keys from Settings instead.
+ * @public
+ */
+export declare type SettingsBool = {
+    [K in keyof Settings]: Settings[K] extends boolean ? K : never;
+}[keyof Settings];
 
 /**
  * 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.
+ * @deprecated Use keyof Settings or extract the color keys from Settings instead.
+ * @public
+ */
+export declare type SettingsColor = {
+    [K in keyof Settings]: Settings[K] extends Color ? K : never;
+}[keyof Settings];
+
+/**
+ * Represents the color settings available in the editor.
  *
  * @public
  * @deprecated Use SettingsColor instead.
@@ -8124,50 +8297,37 @@ export declare type SettingsColorRGBA = SettingsColor;
 /**
  * Represents the enum settings available in the editor.
  *
- * 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.
- *
+ * @deprecated Use keyof Settings or extract the enum keys from Settings instead.
  * @public
  */
-export declare type SettingsEnum = {
-    doubleClickSelectionMode: 'Direct' | 'Hierarchical';
-    'touch/pinchAction': 'None' | 'Zoom' | 'Scale';
-    'touch/rotateAction': 'None' | 'Rotate';
-    'camera/clamping/overshootMode': 'Center' | 'Reverse';
-};
+export declare type SettingsEnum = Pick<Settings, 'doubleClickSelectionMode' | 'touch/pinchAction' | 'touch/rotateAction' | 'camera/clamping/overshootMode'>;
 
 /**
  * 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.
+ * @deprecated Use keyof Settings or extract the float keys from Settings instead.
+ * @public
+ */
+export declare type SettingsFloat = Exclude<{
+    [K in keyof Settings]: Settings[K] extends number ? K : never;
+}[keyof Settings], SettingsInt>;
+
+/**
+ * Represents the integer settings available in the editor.
  *
  * @public
  */
-export declare type SettingsFloat = 'controlGizmo/blockScaleDownLimit' | 'positionSnappingThreshold' | 'rotationSnappingThreshold';
+export declare type SettingsInt = 'maxImageSize';
 
 /**
  * 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.
- *
+ * @deprecated Use keyof Settings or extract the string keys from Settings instead.
  * @public
  */
-export declare type SettingsString = 'basePath' | 'defaultEmojiFontFileUri' | 'defaultFontFileUri' | 'license' | 'page/title/fontFileUri' | 'page/title/separator' | 'fallbackFontUri';
+export declare type SettingsString = Exclude<{
+    [K in keyof Settings]: Settings[K] extends string ? K : never;
+}[keyof Settings], keyof SettingsEnum | 'renderMode'>;
 
 /**
  * Represents the type of a setting.
@@ -8185,6 +8345,12 @@ export declare type SettingsString = 'basePath' | 'defaultEmojiFontFileUri' | 'd
  */
 export declare type SettingType = 'Bool' | 'Int' | 'Float' | 'String' | 'Color' | 'Enum';
 
+/**
+ * Gets the value type for a specific setting key.
+ * @public
+ */
+export declare type SettingValueType<K extends SettingKey> = Settings[K];
+
 /**
  * The block type IDs for the shape blocks. These are the IDs used to create new shapes
  * using `cesdk.engine.block.createShape(id)`.