@vvfx/sdk 0.1.19-alpha.8 → 0.2.0

package/dist/src/sdk.d.ts

@@ -0,0 +1,589 @@
+import { Player, spec } from './shared';
+import type { SDKInputParam, PageConfig, PageData, SetItemPropertyParam, ViewProperty, ViewParam, ExportParam, SDKBackgroundType, SpriteCreateInfo, GroupCreateInfo, ItemCreateInfo, TextCreateInfo, ViewportFitShiftParam, SceneCreaetInfo, VideoCreateInfo, GeneratorCreateInfo, GeneratorResource, VideoGeneratorResource, SpriteGeneratorResource, EffectsCreateInfo, FrameCreateInfo, CardCreateInfo, CardItemTransformInfo, PageAutoLayoutParam } from './types';
+import { SDKItemType } from './sdk-item/types';
+import type { CardTypeConfig } from './config';
+import { ItemOrderAction } from './types';
+import type { ExportItemParams, ExportParams, ExportMediaItemDownloadInfo, FileBuffer, Buffers, Extras } from './exporter';
+import { BackgroundManager } from './utils';
+import { SDKConfig, ExportConfig, SDKMode, MaskGizmoConfig } from './config';
+import { Box2, Vector2 } from './math';
+import { GizmoOperation, Operation, UndoRedo } from './service/UndoRedo';
+import { GestureHandlerInteractType, GizmoType, ItemCreateType, SpriteTextInitParam } from './gesture-handler/gizmo';
+import { AlignType, DistributeType } from './utils/types';
+import { SDKItem } from './sdk-item';
+import type { LoadingGizmoItemOptions, LoadingGizmoTip } from './gesture-handler/gizmo/loading-gizmo';
+import type { MaskUndoRedoData } from './gesture-handler/gizmo/mask-gizmo';
+import type { PictureCutUndoRedoData } from './gesture-handler/gizmo/picture-cut-gizmo';
+export type SDKEvents = {
+    'loadingItemChange': [id: string[]];
+    'selectedItemChange': [id: string[]];
+    'preSelectedItemChange': [id: string | undefined];
+    'selectedViewChange': [id: number];
+    'pageDataChange': [pageData: PageData];
+    'zoomChange': [zoom: number];
+    'progress': [{
+        duration: number;
+        time: number;
+        end: boolean;
+        paused: boolean;
+    }];
+    'itemPropertyChange': [{
+        id: string;
+        propertyKeys: string[];
+    }];
+    'exportProgress': [progress?: number];
+    'exportDone': [item: ExportItemParams | undefined, success: boolean, buffer?: FileBuffer];
+    'exportComplete': [success: boolean, taskInfos: ExportParams, buffers: Buffers, extras: Extras];
+    'sdkConfigChange': [preSDKConfig: SDKConfig, curSDKConfig: SDKConfig];
+    'cutBoxChange': [box: Box2];
+    'expandBoxChange': [box: Box2];
+    'textInput': [{
+        itemId: string;
+        text: string;
+        fontFamily: string;
+    }];
+    'undoRedoChange': [Operation];
+    'maskGizmoUndoRedoChange': [GizmoOperation<MaskUndoRedoData>];
+    'pictureCutGizmoUndoRedoChange': [GizmoOperation<PictureCutUndoRedoData>];
+    'viewportTransform': [{
+        zoom: number;
+        translation: [number, number];
+    }];
+    'itemOnDragStart': [type: GizmoType];
+    'itemOnDrag': [type: GizmoType];
+    'itemOnDragEnd': [type: GizmoType];
+    'spriteTextClick': [{
+        id: string;
+        index: number;
+        text: string;
+    } | undefined];
+    'videoPlay': [{
+        id: string;
+        time: number;
+    }];
+    'itemCreate': [{
+        type: ItemCreateType;
+        position: spec.vec2;
+        id: string;
+    }];
+    'cardItemTransformChange': [CardItemTransformInfo[]];
+    'viewLost': [];
+    'viewRebuildFinish': [];
+};
+export declare class SDK {
+    static config: SDKConfig;
+    private _eventEmitter;
+    private _pageData;
+    private _screenShot;
+    private _exporter?;
+    private _htmlOverlayManager?;
+    private _pageDataUtils;
+    private _sizeAdapt;
+    private _gestureHandler;
+    private disposables;
+    private _isSwitchScene;
+    private _undoRedo;
+    private _backgroundManager;
+    player: Player;
+    _container: HTMLElement;
+    private _playerContainer;
+    constructor(container: HTMLElement, mode?: SDKMode);
+    get backgroundManager(): BackgroundManager;
+    get container(): HTMLElement;
+    get pageData(): PageData | undefined;
+    private get initExporterEnabled();
+    get exportStatus(): string | undefined;
+    get undoRedo(): UndoRedo;
+    private get exportOptions();
+    dispose(): void;
+    on: <E extends "progress" | "loadingItemChange" | "selectedItemChange" | "preSelectedItemChange" | "selectedViewChange" | "pageDataChange" | "zoomChange" | "itemPropertyChange" | "exportProgress" | "exportDone" | "exportComplete" | "sdkConfigChange" | "cutBoxChange" | "expandBoxChange" | "textInput" | "undoRedoChange" | "maskGizmoUndoRedoChange" | "pictureCutGizmoUndoRedoChange" | "viewportTransform" | "itemOnDragStart" | "itemOnDrag" | "itemOnDragEnd" | "spriteTextClick" | "videoPlay" | "itemCreate" | "cardItemTransformChange" | "viewLost" | "viewRebuildFinish">(eventName: E, listener: import("@galacean/effects").EventEmitterListener<SDKEvents[E]>, options?: import("@galacean/effects").EventEmitterOptions) => () => void;
+    initPlayer(mode: SDKMode): void;
+    setSDKMode(mode: SDKMode): void;
+    private getInitParam;
+    private initExporter;
+    private initSDK;
+    run(param: SDKInputParam): Promise<void>;
+    getActiveItems(): string[];
+    setPreSelectedItem(id: string): void;
+    getPreSelectedItem(): string;
+    setSelectedItems(itemIds: string[]): void;
+    /**
+     * @description 设置元素属性（支持单个元素的单/多属性设置）
+     * @param param 设置参数，支持两种场景：
+     *   1. 单个元素单个属性: { itemId, type, propertyName, propertyValue }
+     *   2. 单个元素多个属性: { itemId, type, property }
+     */
+    setItemProperty<T extends SDKItemType>(param: SetItemPropertyParam<T>): Promise<void>;
+    generateScreenShot(id: number, size?: [number, number], tick?: number, backgroundColor?: spec.vec4): Promise<string | undefined>;
+    /**
+     * @description 切换场景
+     * @param index 场景索引
+     */
+    switchScene(index: number): Promise<void>;
+    /**
+     * @description 获取页面的 safeAreaPreview、zoom、adsorption、translation 值
+     * @returns 页面的 safeAreaPreview、zoom、adsorption、translation 值
+     */
+    getPageConfig(): PageConfig;
+    /**
+     * 设置页面的 safeAreaPreview、zoom、adsorption 值
+     * @param pageProperty 设置
+     */
+    setPageConfig(pageConfig: PageConfig): void;
+    /**
+     * @description 设置播放进度
+     * @param progress 播放进度 0-100
+     */
+    setPlayProgress(progress: number): Promise<void>;
+    /**
+     * @description 获取元素
+     * @param id 元素ID
+     * @returns 元素
+     * */
+    getSDKItem(id: string): SDKItem | undefined;
+    /**
+     * @description 获取元素数组
+     * @param id 元素ID数组
+     * @returns 元素数组
+     * */
+    getSDKItems(ids?: string[]): SDKItem[];
+    setPlayState(playState: 'play' | 'pause'): Promise<void>;
+    /**
+     * @description 获取场景预览图
+     * @returns 视图预览图
+     */
+    getViewThumbnail(): Promise<{
+        id: number;
+        thumbnail: string | undefined;
+    }>[];
+    /**
+     * @description 获取视图JSON产物
+     * @returns 当前所有视图JSON产物
+     */
+    getViewScene(): {
+        id: number;
+        thumbnail: spec.JSONScene;
+    }[];
+    private destroyCompositions;
+    /**
+     * @description 以媒体格式 buffer 下载
+     */
+    downloadByMediaBuffersOfExporter(params: ExportMediaItemDownloadInfo[], buffers: Buffers, extras: Extras): void;
+    /**
+     * @description 导出
+     * 支持导出媒体或其他，如MP4，未来支持 JSON 等；
+     */
+    onExport(): void;
+    /**
+     * @description 取消导出
+     */
+    cancelExport(): void;
+    loadPageData(data: PageData): Promise<void>;
+    runByPageData(data: PageData): Promise<void>;
+    reloadPageDataByScene(scene: string | spec.JSONScene): Promise<void>;
+    /**
+     * @description 新增视图数据
+     * @param viewParams 视图参数
+     * @param scene 场景数据 - 无输入时为默认场景数据
+     */
+    addViewParams(viewParams: ViewParam[], scene?: spec.JSONScene): Promise<void>;
+    deleteViewParams(ids: number[]): Promise<void>;
+    setExportParam(exportParam: Partial<ExportParam>, id?: number): void;
+    /**
+     * @description 设置视图缩放
+     * @param zoom 缩放值
+     * @param center 缩放中心
+     * @param ignoreClamp 是否忽视约束
+     */
+    setPageZoom(zoom: number, center?: Vector2, ignoreClamp?: boolean): void;
+    /**
+     * @description 设置元素移动
+     * @param targetTranslation 目标移动值
+     */
+    setPageMove(targetTranslation: Vector2): void;
+    /**
+     * @description 设置静态预览功能开关
+     * @param enabled 功能开关
+     */
+    setStaticPreviewEnabled(enabled: boolean): void;
+    /**
+     * @description 设置静态预览视图名称
+     * @param name 视图名称
+     */
+    setStaticPreviewName(name: string): void;
+    /**
+     * @description 设置同步修改功能开关
+     * @param enabled 功能开关
+     */
+    setAsyncEnabled(enabled: boolean): void;
+    /**
+     * @description 设置 成组显影 开关
+     */
+    setGroupVisibleEnabled(enabled: boolean): void;
+    /**
+     * @description 新增过滤元素名称
+     * @param itemNames 过滤元素名称
+     */
+    addFilterItemNames(itemNames: string[] | string): void;
+    /**
+     * @description 设置预览辅助层颜色
+     * @param color 色值
+     */
+    setPreferenceBackgroundColor(color: [number, number, number, number]): void;
+    /**
+     * @description 设置出血区颜色
+     * @param color 色值
+     */
+    setSafeAreaColor(color: [number, number, number, number]): void;
+    /**
+     * @description 设置 尺寸自适应拓展 功能开关
+     * @param enabled 功能开关
+     */
+    setSizeAdaptEnabled(enabled: boolean): void;
+    /**
+     * @description 设置 截图 功能开关
+     * @param enabled 功能开关
+     */
+    setScreenShotEnabled(enabled: boolean): void;
+    /**
+     * @description 设置导出功能初始化配置
+     * @param exportConfig
+     */
+    setExportConfig(exportConfig: Partial<ExportConfig>): void;
+    /**
+     * @description 设置预选框参数
+     * @param preSelectedColor 预选框颜色
+     * @param preSelectedWidth 预选框线框宽度
+     */
+    setSelectorGizmoPreSelectConfig(preSelectedColor?: number, preSelectedWidth?: number): void;
+    /**
+     * @description 设置 变换控制器 交互框参数
+     * @param config 参数
+     */
+    setTranformGizmoWireframeConfig(config: {
+        wireframeColor?: number;
+        wireframeAlpha?: number;
+        wireframeWidth?: number;
+    }): void;
+    /**
+     * @description 获取 SDK 配置参数
+     * @returns SDK 配置参数
+     */
+    getSDKConfig(): SDKConfig;
+    /**
+     * @description 设置 SDK 配置参数
+     * @param config SDK 配置参数
+     */
+    setSDKConfig(config: SDKConfig): void;
+    /**
+     * @description 设置SDK背景
+     * @param type 背景类型
+     * @param value 值
+     */
+    setSDKBackground(type: SDKBackgroundType, value?: string): void;
+    /**
+     * @description 创建图层元素
+     * @param spriteInfo 图层元素信息
+     */
+    addSpriteItem(spriteInfo: SpriteCreateInfo, scene?: spec.JSONScene): Promise<string>;
+    addVideoItem(videoInfo: VideoCreateInfo, scene?: spec.JSONScene): Promise<string>;
+    openPictureCutGizmo(): void;
+    closePictureCutGizmo(): void;
+    getCutInfo(): {
+        cutBox: Box2;
+        itemBox: Box2;
+    } | undefined;
+    setCutBox(min: Vector2, max: Vector2): Box2 | undefined;
+    openPictureExpandGizmo(): void;
+    closePictureExpandGizmo(): void;
+    getExpandInfo(): {
+        expandBox: Box2;
+        itemBox: Box2;
+    } | undefined;
+    setExpandBox(min: Vector2, max: Vector2): Box2 | undefined;
+    openMaskGizmo(brushSize: number): void;
+    clearMaskGizmo(): void;
+    closeMaskGizmo(): void;
+    getMask(): string | null | undefined;
+    setMaskGizmoConfig(config: Partial<MaskGizmoConfig>): void;
+    /**
+     * @description 设置蒙版工具模式
+     * @param mode 模式类型：'paint' 表示涂抹，'erase' 表示擦除
+     */
+    setMaskGizmoMode(mode: 'paint' | 'erase'): void;
+    /**
+     * 撤销蒙版操作
+     * @returns 是否成功撤销
+     */
+    undoMaskGizmo(): boolean;
+    /**
+     * 重做蒙版操作
+     * @returns 是否成功重做
+     */
+    redoMaskGizmo(): boolean;
+    /**
+     * 检查蒙版是否可以撤销
+     */
+    get canUndoMaskGizmo(): boolean;
+    /**
+     * 检查蒙版是否可以重做
+     */
+    get canRedoMaskGizmo(): boolean;
+    /**
+     * 清空蒙版 undoRedo 历史
+     */
+    clearMaskGizmoUndoRedo(): void;
+    /**
+     * 撤销图片裁切操作
+     * @returns 是否成功撤销
+     */
+    undoPictureCutGizmo(): boolean;
+    /**
+     * 重做图片裁切操作
+     * @returns 是否成功重做
+     */
+    redoPictureCutGizmo(): boolean;
+    /**
+     * 检查图片裁切是否可以撤销
+     */
+    get canUndoPictureCutGizmo(): boolean;
+    /**
+     * 检查图片裁切是否可以重做
+     */
+    get canRedoPictureCutGizmo(): boolean;
+    /**
+     * 清空图片裁切 undoRedo 历史
+     */
+    clearPictureCutGizmoUndoRedo(): void;
+    openLoadingGizmo(id: string, options?: LoadingGizmoItemOptions): void;
+    updateLoadingGizmo(id: string, options: {
+        tip?: LoadingGizmoTip;
+    }): void;
+    closeLoadingGizmo(id: string): void;
+    /**
+     * @description 元素打组
+     * @param children 子元素ID
+     */
+    groupItems(groupInfo: GroupCreateInfo, scene?: spec.JSONScene): string | undefined;
+    setItemParent(id: string, parentId: string): void;
+    deleteItemParent(id: string, parentId: string): void;
+    addTextItem(textInfo: TextCreateInfo, scene?: spec.JSONScene): Promise<string | undefined>;
+    addItemByCreateInfos(createInfos: ItemCreateInfo[], asyncMode?: boolean): Promise<string[]>;
+    deleteItems(idInfo: string | string[]): void;
+    getItemCreateInfo(id: string): ItemCreateInfo | undefined;
+    getItemCreateInfos(ids?: string[]): ItemCreateInfo[];
+    createScreenShotSceneByIds(idInfo: string | string[], time?: number): Promise<string | undefined>;
+    createScreenShotByFrame(id: string): Promise<string | undefined>;
+    createScreenShotByEffects(id: string): Promise<string | undefined>;
+    getChildrenIds(id: string): string[];
+    /**
+     * @description 更新元素在图层中的顺序
+     * @param id 元素ID
+     * @param action 排序操作：BringToFront（置于顶层）、SendToBack（置于底层）、BringForward（上移一层）、SendBackward（下移一层）
+     */
+    updateItemOrder(id: string, action: ItemOrderAction): void;
+    /**
+     * @description 导出JSON
+     * @param idInfo 视图序号信息
+     * @returns JSON数组
+     */
+    exportJSON(idInfo?: number | number[]): spec.JSONScene[];
+    getViewBoxById(id: string): Box2;
+    /**
+     * @description 批量设置元素扩展属性
+     * @param id 元素ID
+     * @param extensions 扩展属性对象（支持同时设置多个）
+     * @returns 是否设置成功
+     */
+    setItemExtension(id: string, extension: Record<string, any>): boolean;
+    /**
+     * @description 批量获取元素扩展属性
+     * @param id 元素ID
+     * @param keys 扩展属性名称列表（不传则返回所有扩展属性）
+     * @returns 扩展属性对象
+     */
+    getItemExtension(id: string, keys?: string[]): Record<string, any> | undefined;
+    /**
+     * @description 删除元素扩展属性（支持批量删除）
+     * @param id 元素ID
+     * @param keys 扩展属性名称列表
+     * @returns 是否删除成功
+     */
+    deleteItemExtensions(id: string, keys: string[]): boolean;
+    /**
+     * @description 检查元素是否有指定扩展属性
+     * @param id 元素ID
+     * @param key 扩展属性名称
+     * @returns 是否存在
+     */
+    hasItemExtension(id: string, key: string): boolean;
+    /**
+     * @description 获取元素所有扩展属性的键名列表
+     * @param id 元素ID
+     * @returns 键名数组
+     */
+    getItemExtensionKeys(id: string): string[] | undefined;
+    getViewProperty(id: number): ViewProperty | undefined;
+    pageMove(shift: [number, number]): void;
+    pageZoom(shift: number, center?: [number, number]): void;
+    /**
+     * @description 设置视图缩放工具锁定缩放比例开关
+     * @param state 缩放比例开关
+     */
+    setPictureCutGizmoLockScale(state: boolean): void;
+    /**
+     * @description 设置视图扩展工具锁定缩放比例开关
+     * @param state 缩放比例开关
+     */
+    setPictureExpandGizmoLockScale(state: boolean): void;
+    /**
+     * @description 视图缩放函数
+     * @param shiftParam 视图偏移值
+     */
+    viewportFit(shiftParam?: ViewportFitShiftParam, box?: Box2): void;
+    /**
+     * @description 获取元素包围盒
+     * @param idInfo 元素Id
+     * @returns 元素包围盒
+     */
+    getItemBoxById(idInfo: string): Box2;
+    /**
+     * @description 设置元素字体
+     * @param id 元素Id
+     * @param fontFamilyName 字体名称
+     * @param url 字体地址
+     */
+    setItemFontFamily(id: string, fontFamilyName: string, url: string): Promise<void>;
+    createSceneByCreateInfos(createInfos: ItemCreateInfo[], sceneInfo: SceneCreaetInfo): spec.JSONScene;
+    setSpriteSize(id: string, size: spec.vec2): void;
+    setItemPropertyByCreateInfo(createInfo: ItemCreateInfo | ItemCreateInfo[]): Promise<void>;
+    setTransformGizmoLockScale(state: boolean): void;
+    getViewBoxByBox(box: Box2): Box2;
+    openSpriteTextEditGizmo(initParam: SpriteTextInitParam[]): void;
+    closeSpriteTextEditGizmo(): void;
+    setSpriteTextSelectedIndex(id: string, index: number): void;
+    setSpriteTextSelectedText(id: string, index: number, text: string): void;
+    getBoundingBoxByItemCreateInfo(createInfo: ItemCreateInfo): Box2;
+    getBoundingBoxByItemCreateInfos(createInfos: ItemCreateInfo[]): Box2;
+    setSpriteTextChangedState(id: string, index: number, hasChanged: boolean): void;
+    setSpriteTextEditState(id: string, index: number, isEditing: boolean): void;
+    getVideoItemPlayTime(id: string): number;
+    setVideoItemPlayTime(id: string, time: number): void;
+    getEffectsItemPlayTime(id: string): number | undefined;
+    setEffectsItemPlayTime(id: string, time: number): void;
+    setEffectsResource(id: string, effects: string): void;
+    getPixelPositionByViewPosition(viewPosition: Vector2): Vector2;
+    hitTest(x: number, y: number): string[] | undefined;
+    setInteractType(type: GestureHandlerInteractType): void;
+    getInteractType(): GestureHandlerInteractType;
+    makeItemAlign(type: AlignType, ids?: string[]): void;
+    makeItemDistribute(type: DistributeType, ids?: string[]): void;
+    /**
+     * @description 注册新的卡片类型
+     * @param cardTypeConfig 卡片类型配置（type、label、iconUrl）
+     * @returns 是否注册成功（type 已存在时返回 false）
+     */
+    registerCardType(cardTypeConfig: CardTypeConfig): boolean;
+    /**
+     * @description 批量注册卡片类型
+     * @param configs 卡片类型配置数组
+     * @returns 成功注册的类型数量
+     */
+    registerCardTypes(configs: CardTypeConfig[]): number;
+    /**
+     * @description 注销卡片类型
+     * @param type 卡片类型标识
+     * @returns 是否注销成功（type 不存在时返回 false）
+     */
+    unregisterCardType(type: string): boolean;
+    /**
+     * @description 获取所有已注册的卡片类型
+     * @returns 卡片类型配置数组（只读副本）
+     */
+    getRegisteredCardTypes(): CardTypeConfig[];
+    /**
+     * @description 判断卡片类型是否已注册
+     * @param type 卡片类型标识
+     * @returns 是否已注册
+     */
+    isCardTypeRegistered(type: string): boolean;
+    /**
+     * @description 创建卡片元素
+     * @description 底层以透明 SpriteItem 形式渲染，支持 cardType 属性
+     * @param createInfo 卡片创建信息
+     * @returns 卡片元素ID
+     */
+    addCardItem(createInfo: CardCreateInfo): string | undefined;
+    /**
+     * @description 创建生成器元素
+     * @param createInfo 生成器创建信息
+     * @returns 生成器元素ID
+     */
+    addGeneratorItem(createInfo: GeneratorCreateInfo): string;
+    /**
+     * @description 创建动效元素
+     * @param effectsInfo 动效创建信息
+     */
+    addEffectsItem(effectsInfo: EffectsCreateInfo): Promise<string | undefined>;
+    /**
+     * @description 创建画板元素
+     * @param createInfo 画板创建信息
+     * @returns 画板元素ID
+     */
+    addFrameItem(createInfo: FrameCreateInfo): Promise<string>;
+    /**
+     * @description 将元素移动到 Frame 中
+     * @param itemIds 要移动的元素ID列表
+     * @param frameId 目标 Frame ID
+     */
+    moveItemsToFrame(itemIds: string[], frameId: string): void;
+    /**
+     * @description 将元素从 Frame 中移出到主场景
+     * @param itemIds 要移动的元素ID列表
+     * @param frameId 源 Frame ID（可选，如果不传则从元素的 parentId 推断）
+     */
+    moveItemsOutOfFrame(itemIds: string[]): void;
+    /**
+     * @description 设置生成器资源，将生成器转换为对应的元素
+     * @param id 生成器元素ID
+     * @param resourceUrl 资源地址
+     * @returns 新的元素ID
+     */
+    setGeneratorResource(id: string, resourceUrl: string): Promise<string>;
+    /**
+     * @description 设置生成器资源（使用 GeneratorResource 对象）
+     * @param resource 生成器资源信息
+     */
+    setGeneratorResourceFromObject(resource: GeneratorResource): void;
+    /**
+     * @description 设置视频生成器资源
+     * @param resource 视频生成器资源信息
+     */
+    setVideoGeneratorResource(resource: VideoGeneratorResource): Promise<string>;
+    /**
+     * @description 设置图层生成器资源
+     * @param resource 图层生成器资源信息
+     */
+    setSpriteGeneratorResource(resource: SpriteGeneratorResource): Promise<string>;
+    setItemLockState(id: string, state: boolean): void;
+    getItemLockState(id: string): boolean;
+    openItemCreateGizmo(type: ItemCreateType): void;
+    closeItemCreateGizmo(): void;
+    openTextGizmo(textItemId?: string, mode?: 'select' | 'focus'): void;
+    closeTextGizmo(): void;
+    setItemName(id: string, name: string): void;
+    setSafeAreaPreviewVisible(id: number, type: 'url' | 'color', visible: boolean): void;
+    /**
+     * @description 修改画板元素大小
+     * @param id 元素id
+     * @param size 目标大小 [width, height]
+     * @param translation 位置偏移补偿（可选，用于保持拖拽角点固定）
+     */
+    resizeFrameItem(id: string, size: [number, number], translation?: [number, number]): void;
+    /**
+     * @description 对 FrameItem 执行自动布局（当 layoutMode 为 AUTO 时使用）
+     * @param frameId Frame 元素 ID
+     */
+    applyFrameAutoLayout(frameId: string): void;
+    autoLayoutPage(param?: PageAutoLayoutParam): Promise<void>;
+}

package/dist/src/service/UndoRedo.d.ts

@@ -0,0 +1,48 @@
+import { ItemCreateInfo } from '../types';
+export type CreateOperation = {
+    type: 'create';
+    newData: ItemCreateInfo[];
+};
+export type DeleteOperation = {
+    type: 'delete';
+    oldData: ItemCreateInfo[];
+};
+export type UpdateOperation = {
+    type: 'update';
+    newData: ItemCreateInfo[];
+    oldData: ItemCreateInfo[];
+};
+export type Operation = CreateOperation | UpdateOperation | DeleteOperation;
+export type UndoRedoEvents = Record<string, [Operation]>;
+/**
+ * 通用撤销重做操作类型
+ */
+export type GizmoOperation<T> = {
+    type: 'update';
+    newData: T;
+    oldData: T;
+};
+/**
+ * 通用撤销重做类，支持任意数据类型
+ */
+export declare class GizmoUndoRedo<T> {
+    private index;
+    private operations;
+    get canUndo(): boolean;
+    get canRedo(): boolean;
+    push(operation: GizmoOperation<T>): void;
+    undo(): GizmoOperation<T> | undefined;
+    redo(): GizmoOperation<T> | undefined;
+    clear(): void;
+}
+export declare class UndoRedo {
+    private index;
+    private operations;
+    get canUndo(): boolean;
+    get canRedo(): boolean;
+    oldData?: ItemCreateInfo[];
+    push(operation: Operation): void;
+    undo(): Operation | undefined;
+    redo(): Operation | undefined;
+    clear(): void;
+}

package/dist/src/shared/index.d.ts

@@ -0,0 +1 @@
+export * from './player';

package/dist/src/shared/player.d.ts

@@ -0,0 +1,9 @@
+import '@galacean/effects';
+export { spec, VFXItem, Player, math, Composition, type Region, EventEmitter, assertExist, SpriteComponent, TextComponent, Texture, generateGUID, version as PlayerVersion } from '@galacean/effects';
+import '@galacean/effects-plugin-rich-text';
+export { RichTextComponent } from '@galacean/effects-plugin-rich-text';
+import '@galacean/effects-plugin-model';
+import '@galacean/effects-plugin-multimedia';
+export { VideoComponent } from '@galacean/effects-plugin-multimedia';
+import '@galacean/effects-plugin-spine';
+import '@galacean/effects-plugin-ffd';

package/dist/src/size-adapte/index.d.ts

@@ -0,0 +1 @@
+export * from './size-adapt';

package/dist/src/size-adapte/size-adapt.d.ts

@@ -0,0 +1,28 @@
+import { Box2, Vector2, Vector3 } from '../math';
+import { Composition, spec, VFXItem } from '../shared';
+export type SizeAdaptDirection = 'x' | 'y';
+/**
+ * @description 尺寸适配工具
+ */
+export declare class SizeAdapt {
+    /**
+     * @description 尺寸适配播放器
+     */
+    private _player;
+    /**
+     * @description 尺寸播放器容器
+     */
+    private _container;
+    /**
+     * @description 视图大小
+     */
+    size: spec.vec2;
+    constructor();
+    adjustment(scene: spec.JSONScene, tick: number, originSize: spec.vec2, viewSize: spec.vec2, safeArea?: spec.vec4, direction?: SizeAdaptDirection): Promise<spec.JSONScene>;
+    keepDistribute(scene: spec.JSONScene, composition: Composition, ratio: number, viewSize: spec.vec2): void;
+    keepAdsorption(type: 'centerAdsorption' | 'topAdsorption' | 'bottomAdsorption' | 'leftAdsorption' | 'rightAdsorption', scene: spec.JSONScene, composition: Composition, translation: spec.vec2, originViewBox: Box2, resultViewBox: Box2, adsorptionDirection: SizeAdaptDirection): void;
+    keepDoubleAdsorption(type: 'bottomCenterAdsorption', scene: spec.JSONScene, composition: Composition, translation: spec.vec2, originViewBox: Box2, resultViewBox: Box2, adsorptionDirection: SizeAdaptDirection): void;
+    getViewBoxByHeadlessPlayerItem(targetItem: VFXItem, childrenItem: VFXItem[], projectPoint: (point: Vector3) => Vector2): Box2;
+    transformSceneItem(scene: spec.JSONScene, itemId: string, propertyName: string, propertyValue: any): void;
+    dispose(): void;
+}