@vvfx/sdk 0.2.2-beta.9 → 0.2.3

package/dist/sdk-item/card-item.d.ts

@@ -1,4 +1,4 @@
-import type { CardItemProperty, CardCreateInfo } from '../types';
+import type { CardItemProperty, CardCreateInfo, CardHTML } from '../types';
 import { SDKItemType, type CardItemOptions } from './types';
 import { BaseItem } from './base-item';
 /**
@@ -21,6 +21,11 @@ export declare class CardItem extends BaseItem {
      */
     get cardType(): string;
     set cardType(value: string);
+    /**
+     * @description HTML 覆盖层配置
+     */
+    get html(): CardHTML | undefined;
+    set html(value: CardHTML | undefined);
     /**
      * @description 位置
      */

package/dist/sdk-item/text-item.d.ts

@@ -16,6 +16,8 @@ export declare class TextItem extends BaseItem {
      */
     property: TextItemProperty;
     constructor(options: TextItemOptions);
+    get pixelWidth(): number;
+    get pixelHeight(): number;
     /**
      * @description 文本内容
      */

package/dist/sdk.d.ts

@@ -1,5 +1,5 @@
 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, CardHTML, CardItemTransformInfo, PageAutoLayoutParam } from './types';
+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';
@@ -10,7 +10,7 @@ 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, type CardItem } from './sdk-item';
+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';
@@ -99,7 +99,6 @@ export declare class SDK {
     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 syncCanvasLayerOrder;
     private getInitParam;
     private initExporter;
     private initSDK;
@@ -309,9 +308,9 @@ export declare class SDK {
     setMaskGizmoConfig(config: Partial<MaskGizmoConfig>): void;
     /**
      * @description 设置蒙版工具模式
-     * @param mode 模式类型：'paint' 表示涂抹，'erase' 表示擦除
+     * @param mode 模式类型：'paint' 笔刷涂抹、'erase' 笔刷逐笔擦除、'box-erase' 框选擦除、'box-paint' 框选涂抹
      */
-    setMaskGizmoMode(mode: 'paint' | 'erase'): void;
+    setMaskGizmoMode(mode: 'paint' | 'erase' | 'box-erase' | 'box-paint'): void;
     /**
      * 撤销蒙版操作
      * @returns 是否成功撤销
@@ -508,25 +507,6 @@ export declare class SDK {
      * @returns 是否已注册
      */
     isCardTypeRegistered(type: string): boolean;
-    /**
-     * @description 按 cardType 从注册表解析卡片的 HTML 渲染配置。
-     * @param item 卡片元素
-     * @returns HTML 渲染配置
-     */
-    resolveCardHTML(item: CardItem): CardHTML | undefined;
-    /**
-     * @description 按 cardType 从注册表解析卡片类型配置。
-     * @param item 卡片元素
-     * @returns 卡片类型配置
-     */
-    resolveCardTypeConfig(item: CardItem): CardTypeConfig | undefined;
-    /**
-     * @description 重新解析并挂载指定卡片的 HTML 内容。
-     * @description 当 inline/document 内容依赖 extension 或外部状态变化时，可调用此方法刷新 DOM。
-     * @param id 卡片元素 ID
-     * @returns 是否成功触发刷新
-     */
-    refreshCardHTML(id: string): boolean;
     /**
      * @description 创建卡片元素
      * @description 底层以透明 SpriteItem 形式渲染，支持 cardType 属性

package/dist/types.d.ts

@@ -204,17 +204,6 @@ export type CardHTMLShellContent = {
      */
     render: CardHTMLShellRenderer;
 };
-export type CardHTMLRootStyle = Record<string, string | number | undefined>;
-export type CardHTMLRootConfig = {
-    /**
-     * @description 追加到 HTML 内容根节点的 className。
-     */
-    className?: string;
-    /**
-     * @description 应用到 HTML 内容根节点的内联样式。
-     */
-    style?: CardHTMLRootStyle;
-};
 /**
  * @description Card HTML 覆盖层配置。
  */
@@ -227,19 +216,23 @@ export type CardHTML = {
      * @description HTML 外壳，用于定制承载 content 的容器。
      */
     shell?: CardHTMLShellContent;
-    /**
-     * @description HTML 内容根节点样式配置，用于按内容实例设置 className 或内联 style。
-     */
-    root?: CardHTMLRootConfig;
 };
 /**
  * @description Card 卡片元素属性
  */
 export type CardItemProperty = BaseItemProperty & {
     /**
-     * @description 卡片类型（动态配置，需通过 SDK.registerCardType/registerCardTypes 注册）
+     * @description 卡片类型（动态配置，需在 SDK.config.itemConfig.cardConfig.cardTypes 中注册）
      */
     cardType: string;
+    /**
+     * @description 是否根据 HTML 挂载内容的自然高度自动更新卡片高度
+     */
+    autoHeight?: boolean;
+    /**
+     * @description HTML 覆盖层配置；存在该字段时由 DOM overlay 渲染
+     */
+    html?: CardHTML;
 };
 /**
  * @description Frame 画板元素布局模式
@@ -475,6 +468,10 @@ export type PageAutoLayoutParam = {
      * @description 自动布局间隔
      */
     gap?: number;
+    /**
+     * 视图自适应偏移参数
+     */
+    shift?: ViewportFitShiftParam;
 };
 /**
  * @description 页面配置
@@ -934,7 +931,7 @@ export type CardItemTransformInfo = {
     size: [number, number];
 };
 /**
- * @description 卡片类型（动态配置，需通过 SDK.registerCardType/registerCardTypes 注册）
+ * @description 卡片类型（动态配置，需在 SDK.config.itemConfig.cardConfig.cardTypes 中注册）
  */
 export type CardType = string;
 /**
@@ -977,6 +974,10 @@ export type CardCreateInfo = {
          * @description 卡片元素像素高度
          */
         height: number;
+        /**
+         * @description 是否根据 HTML 挂载内容的自然高度自动更新卡片高度
+         */
+        autoHeight?: boolean;
         /**
          * @description 卡片元素位置
          */
@@ -989,6 +990,10 @@ export type CardCreateInfo = {
          * @description 卡片元素缩放
          */
         scale?: [number, number];
+        /**
+         * @description HTML 覆盖层配置；存在该字段时由 DOM overlay 渲染
+         */
+        html?: CardHTML;
     };
 };
 /**

package/dist/utils/page-data-utils.d.ts

@@ -88,10 +88,6 @@ export declare class PageDataUtils {
      *   2. 单个元素多个属性: { itemId, type, property }
      */
     setItemProperty<T extends SDKItemType>(param: SetItemPropertyParam<T>): Promise<void>;
-    /**
-     * @description 设置元素extension字段
-     */
-    setItemExtension(itemId: string, extension: Record<string, any>): void;
     /**
      * @description 场景 1: 设置单个元素的单个属性
      */
@@ -288,6 +284,15 @@ export declare class PageDataUtils {
     setItemFontFamily(id: string, fontFamilyName: string, url: string): Promise<void>;
     changeItemPropertyByCreateInfo(itemCreateInfo: ItemCreateInfo | ItemCreateInfo[]): Promise<void>;
     getViewBoxByBox(box: Box2): Box2;
+    /**
+     * @description 快照当前所有视频元素的播放状态（播放/暂停 + 当前播放进度），用于属性刷新后恢复，
+     *  避免设置属性导致全量视频被自动播放或进度被重置回 0s
+     */
+    private snapshotVideoPlayStates;
+    /**
+     * @description 按快照恢复视频元素的播放状态（先 pause 再 seek，最后按原状态 play/pause，避免进度抖动）
+     */
+    private restoreVideoPlayStates;
     playVideoItem(id?: string): void;
     pauseVideoItem(id?: string): void;
     playEffectsItem(id?: string): void;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@vvfx/sdk",
   "description": "TODO",
-  "version": "0.2.2-beta.9",
+  "version": "0.2.3",
   "main": "./dist/index.mjs",
   "module": "./dist/index.js",
   "types": "./dist/index.d.ts",
@@ -68,7 +68,7 @@
     "prebuild": "pnpm clean",
     "build": "pnpm build:declaration && pnpm build:module",
     "build:module": "rollup -c --bundleConfigAsCjs",
-    "build:declaration": "tsc -p tsconfig.build.json",
+    "build:declaration": "tsc -d --emitDeclarationOnly",
     "clean": "rimraf dist *.tsbuildinfo",
     "test": "vitest run"
   }

package/dist/layer-order.d.ts

@@ -1,7 +0,0 @@
-export type SDKCanvasLayers = {
-    container: HTMLElement;
-    playerContainer?: HTMLElement;
-    htmlOverlayLayer?: HTMLElement;
-    gestureCanvas?: HTMLElement;
-};
-export declare function orderSDKCanvasLayers({ container, playerContainer, htmlOverlayLayer, gestureCanvas, }: SDKCanvasLayers): void;