@cesdk/cesdk-js 1.64.0-nightly.20251025 → 1.64.0-nightly.20251027

package/index.d.ts

@@ -2709,6 +2709,9 @@ declare class CreativeEditorSDK {
      */
     unstable_onActivePageChanged(callback: (id: number) => void): () => void;
     /**
+     * Focus on a specific page and zoom to fit it in the viewport.
+     * @param pageId - The ID of the page to focus on
+     * @returns A promise that resolves when the focus operation is complete
      * @category Page Management
      * @experimental This API is experimental and may change or be removed in future versions.
      */
@@ -4360,6 +4363,39 @@ export declare interface RegisteredActions {
      * Action invoked when the add clip button is pressed in the video timeline
      */
     addClip: VoidFunction;
+    /**
+     * Zoom actions for explicit zoom control
+     */
+    /** Action for zooming to a specific block */
+    'zoom.toBlock': ZoomToBlockAction;
+    /** Action for zooming to the current page with optional padding */
+    'zoom.toPage': ZoomToPageAction;
+    /** Action for zooming to the current selection */
+    'zoom.toSelection': ZoomToSelectionAction;
+    /** Action for zooming in by one step */
+    'zoom.in': ZoomInAction;
+    /** Action for zooming out by one step */
+    'zoom.out': ZoomOutAction;
+    /** Action for setting zoom to a specific level */
+    'zoom.toLevel': ZoomToLevelAction;
+    /**
+     * Scroll actions
+     */
+    /** Action for scrolling to a specific page */
+    'scroll.toPage': ScrollToPageAction;
+    /**
+     * Video timeline zoom actions
+     */
+    /** Action for zooming in the video timeline */
+    'timeline.zoom.in': TimelineZoomInAction;
+    /** Action for zooming out the video timeline */
+    'timeline.zoom.out': TimelineZoomOutAction;
+    /** Action for fitting the video timeline to show all content */
+    'timeline.zoom.fit': TimelineZoomToFitAction;
+    /** Action for setting the video timeline zoom to a specific level */
+    'timeline.zoom.toLevel': TimelineZoomToLevelAction;
+    /** Action for resetting the video timeline zoom to default */
+    'timeline.zoom.reset': TimelineZoomResetAction;
 }
 
 /**
@@ -4430,6 +4466,17 @@ export { SceneMode }
 
 export { Scope }
 
+/**
+ * Action function for scrolling to a specific page
+ * @public
+ */
+export declare type ScrollToPageAction = (options?: {
+    /** The page ID to scroll to (defaults to current page) */
+    pageId?: number;
+    /** Whether to animate the scroll (default: false) */
+    animate?: boolean;
+}) => Promise<void>;
+
 /**
  * Represents options for a section.
  *
@@ -4631,6 +4678,39 @@ declare type ThemeConfig = Theme | ThemeFn | 'system';
  */
 declare type ThemeFn = () => Theme;
 
+/**
+ * Video timeline zoom action types
+ */
+/**
+ * Action function for zooming in the video timeline by one step
+ * @public
+ */
+export declare type TimelineZoomInAction = () => void;
+
+/**
+ * Action function for zooming out the video timeline by one step
+ * @public
+ */
+export declare type TimelineZoomOutAction = () => void;
+
+/**
+ * Action function for resetting the video timeline zoom to default level (1.0)
+ * @public
+ */
+export declare type TimelineZoomResetAction = () => void;
+
+/**
+ * Action function for fitting the video timeline to show all content
+ * @public
+ */
+export declare type TimelineZoomToFitAction = () => void;
+
+/**
+ * Action function for setting the video timeline zoom to a specific level
+ * @public
+ */
+export declare type TimelineZoomToLevelAction = (level: number) => void;
+
 export { TransientResource }
 
 /**
@@ -6534,6 +6614,34 @@ export declare class UtilsAPI {
      * @public
      */
     localUpload(file: File, context?: UploadCallbackContext): Promise<AssetDefinition>;
+    /**
+     * Calculates the recommended viewport padding based on current viewport size and settings.
+     * This utility matches the internal padding used by the SDK for zoom operations.
+     *
+     * @param width - Optional viewport width to use instead of current camera width
+     * @param height - Optional viewport height to use instead of current camera height
+     * @returns An object containing paddingX and paddingY values
+     *
+     * @example
+     * ```typescript
+     * const padding = cesdk.utils.calculateViewportPadding();
+     * console.log(`Padding: ${padding.paddingX}x${padding.paddingY}`);
+     *
+     * // Use with custom zoom
+     * await cesdk.engine.scene.zoomToBlock(
+     *   pageId,
+     *   padding.paddingX,
+     *   padding.paddingY,
+     *   padding.paddingX,
+     *   padding.paddingY
+     * );
+     * ```
+     * @public
+     */
+    calculateViewportPadding(width?: number, height?: number): {
+        paddingX: number;
+        paddingY: number;
+    };
 }
 
 export { VariableAPI }
@@ -6556,6 +6664,153 @@ export { XYWH }
 
 export { ZoomAutoFitAxis }
 
+/**
+ * Action function for zooming in by one step
+ * @public
+ */
+export declare type ZoomInAction = (options?: {
+    /** Custom step size for zoom in (default uses predefined steps) */
+    stepSize?: number;
+    /** Animation configuration - boolean for default animation or object for custom settings */
+    animate?: boolean | {
+        /** Duration of the animation in seconds */
+        duration?: number;
+        /** Easing function for the animation */
+        easing?: 'Linear' | 'EaseIn' | 'EaseOut' | 'EaseInOut';
+        /** Whether the animation can be interrupted */
+        interruptible?: boolean;
+    };
+    /** Maximum allowed zoom level (default: 32) */
+    maxZoom?: number;
+}) => void | Promise<void>;
+
 export { ZoomOptions }
 
+/**
+ * Action function for zooming out by one step
+ * @public
+ */
+export declare type ZoomOutAction = (options?: {
+    /** Custom step size for zoom out (default uses predefined steps) */
+    stepSize?: number;
+    /** Animation configuration - boolean for default animation or object for custom settings */
+    animate?: boolean | {
+        /** Duration of the animation in seconds */
+        duration?: number;
+        /** Easing function for the animation */
+        easing?: 'Linear' | 'EaseIn' | 'EaseOut' | 'EaseInOut';
+        /** Whether the animation can be interrupted */
+        interruptible?: boolean;
+    };
+    /** Minimum allowed zoom level (default: 0.125) */
+    minZoom?: number;
+}) => void | Promise<void>;
+
+/**
+ * Zoom action types for explicit zoom control
+ */
+/**
+ * Action function for zooming to a specific block
+ * @public
+ */
+export declare type ZoomToBlockAction = (blockId: number, options?: {
+    /** Padding configuration around the block */
+    padding?: number | {
+        x?: number;
+        y?: number;
+    } | {
+        top?: number;
+        bottom?: number;
+        left?: number;
+        right?: number;
+    };
+    /** Animation configuration - boolean for default animation or object for custom settings */
+    animate?: boolean | {
+        /** Duration of the animation in seconds */
+        duration?: number;
+        /** Easing function for the animation */
+        easing?: 'Linear' | 'EaseIn' | 'EaseOut' | 'EaseInOut';
+        /** Whether the animation can be interrupted */
+        interruptible?: boolean;
+    };
+    /** Whether to enable auto-fit mode after zooming (default: false) */
+    autoFit?: boolean;
+}) => Promise<void>;
+
+/**
+ * Action function for setting zoom to a specific level
+ * @public
+ */
+export declare type ZoomToLevelAction = (level: number, options?: {
+    /** Animation configuration - boolean for default animation or object for custom settings */
+    animate?: boolean | {
+        /** Duration of the animation in seconds */
+        duration?: number;
+        /** Easing function for the animation */
+        easing?: 'Linear' | 'EaseIn' | 'EaseOut' | 'EaseInOut';
+        /** Whether the animation can be interrupted */
+        interruptible?: boolean;
+    };
+    /** Minimum allowed zoom level (default: 0.125) */
+    minZoom?: number;
+    /** Maximum allowed zoom level (default: 32) */
+    maxZoom?: number;
+}) => void | Promise<void>;
+
+/**
+ * Action function for zooming to the current page with optional padding
+ * @public
+ */
+export declare type ZoomToPageAction = (options?: {
+    /** Padding configuration around the block */
+    padding?: number | {
+        x?: number;
+        y?: number;
+    } | {
+        top?: number;
+        bottom?: number;
+        left?: number;
+        right?: number;
+    };
+    /** Animation configuration - boolean for default animation or object for custom settings */
+    animate?: boolean | {
+        /** Duration of the animation in seconds */
+        duration?: number;
+        /** Easing function for the animation */
+        easing?: 'Linear' | 'EaseIn' | 'EaseOut' | 'EaseInOut';
+        /** Whether the animation can be interrupted */
+        interruptible?: boolean;
+    };
+    /** Whether to enable auto-fit mode after zooming (default: false) */
+    autoFit?: boolean;
+}) => Promise<void>;
+
+/**
+ * Action function for zooming to the current selection
+ * @public
+ */
+export declare type ZoomToSelectionAction = (options?: {
+    /** Padding configuration around the block */
+    padding?: number | {
+        x?: number;
+        y?: number;
+    } | {
+        top?: number;
+        bottom?: number;
+        left?: number;
+        right?: number;
+    };
+    /** Animation configuration - boolean for default animation or object for custom settings */
+    animate?: boolean | {
+        /** Duration of the animation in seconds */
+        duration?: number;
+        /** Easing function for the animation */
+        easing?: 'Linear' | 'EaseIn' | 'EaseOut' | 'EaseInOut';
+        /** Whether the animation can be interrupted */
+        interruptible?: boolean;
+    };
+    /** Whether to enable auto-fit mode after zooming (default: false) */
+    autoFit?: boolean;
+}) => Promise<void>;
+
 export { }