@vvfx/sdk 0.1.14-alpha.1 → 0.1.14-alpha.3

package/dist/index.d.cts

@@ -100,11 +100,14 @@ type GeneratorItemOptions = SDKItemOptions & {
      */
     property?: Partial<SpriteFormProperty>;
 };
+type EffectsItemOptions = SDKItemOptions & {
+    property?: Partial<EffectsFormProperty>;
+};
 /**
  * @description SDKItem 类型（独立于 spec.ItemType）
  * @description 包含所有 SDK 层级的元素类型，包括虚拟类型如 generator
  */
-type SDKItemType = 'sprite' | 'text' | 'video' | 'null' | 'generator';
+type SDKItemType = 'sprite' | 'text' | 'video' | 'null' | 'generator' | 'effects' | 'frame';
 
 /**
  * @description SDKItem 抽象基类
@@ -200,11 +203,6 @@ declare abstract class BaseItem {
      * @description 清空所有扩展属性
      */
     clearExtensions(): void;
-    /**
-     * @description 转换为普通对象（用于序列化）
-     * @returns 普通对象
-     */
-    abstract toJSON(): Record<string, any>;
     /**
      * @description 转换为 CreateInfo（用于元素复制/导出）
      * @param withParent 是否包含父节点ID
@@ -217,10 +215,10 @@ declare abstract class BaseItem {
      */
     abstract clone(): BaseItem;
     /**
-     * @description 获取基础属性的 JSON 对象（子类可用）
-     * @protected
+     * @description 获取基础属性的 JSON 对象,转换为普通对象（用于序列化）
+     * @returns 普通对象
      */
-    protected getBaseJSON(): Record<string, any>;
+    toJSON(): Record<string, any>;
 }
 /**
  * @description 类型守卫函数：检查对象是否是 BaseItem
@@ -278,10 +276,6 @@ declare class SpriteItem extends BaseItem {
      */
     get keyPropertyEditing(): boolean;
     set keyPropertyEditing(value: boolean);
-    /**
-     * @description 转换为普通对象
-     */
-    toJSON(): Record<string, any>;
     /**
      * @description 转换为 CreateInfo
      * @param withParent 是否包含父节点ID
@@ -397,10 +391,6 @@ declare class TextItem extends BaseItem {
      */
     get visible(): boolean;
     set visible(value: boolean);
-    /**
-     * @description 转换为普通对象
-     */
-    toJSON(): Record<string, any>;
     /**
      * @description 转换为 CreateInfo
      * @param withParent 是否包含父节点ID
@@ -465,10 +455,6 @@ declare class VideoItem extends BaseItem {
      */
     get keyPropertyEditing(): boolean;
     set keyPropertyEditing(value: boolean);
-    /**
-     * @description 转换为普通对象
-     */
-    toJSON(): Record<string, any>;
     /**
      * @description 转换为 CreateInfo
      * @param withParent 是否包含父节点ID
@@ -536,10 +522,6 @@ declare class NullItem extends BaseItem {
      * @description 设置缩放（存储在扩展属性中）
      */
     set scaleForCreateInfo(value: [number, number]);
-    /**
-     * @description 转换为普通对象
-     */
-    toJSON(): Record<string, any>;
     /**
      * @description 转换为 CreateInfo
      * @param withParent 是否包含父节点ID
@@ -610,10 +592,6 @@ declare class GeneratorItem extends BaseItem {
      */
     get keyPropertyEditing(): boolean;
     set keyPropertyEditing(value: boolean);
-    /**
-     * @description 转换为普通对象
-     */
-    toJSON(): Record<string, any>;
     /**
      * @description 转换为 GeneratorCreateInfo
      * @param withParent 是否包含父节点ID
@@ -636,6 +614,73 @@ declare class GeneratorItem extends BaseItem {
      */
     clone(): GeneratorItem;
 }
+/**
+ * @description 类型守卫：检查是否是 GeneratorItem
+ */
+declare function isGeneratorItem(obj: any): obj is GeneratorItem;
+
+/**
+ * @description 特效产物 元素 SDKItem 类
+ */
+declare class EffectsItem extends BaseItem {
+    /**
+     * @description 元素类型（独立类型，不属于 spec.ItemType）
+     */
+    readonly type: SDKItemType;
+    /**
+     * @description 元素属性
+     */
+    property: EffectsFormProperty;
+    constructor(options: EffectsItemOptions);
+    /**
+     * @description 特效资源地址
+     */
+    get effects(): string;
+    set effects(value: string);
+    /**
+     * @description 位置
+     */
+    get position(): [number, number];
+    set position(value: [number, number]);
+    /**
+     * @description 大小
+     */
+    get size(): [number, number];
+    set size(value: [number, number]);
+    /**
+     * @description 旋转（二维旋转角度）
+     */
+    get rotation(): number;
+    set rotation(value: number);
+    /**
+     * @description 完整旋转（包含 x, y, z）
+     */
+    get fullRotation(): [number, number, number];
+    set fullRotation(value: [number, number, number]);
+    /**
+     * @description 可见性
+     */
+    get visible(): boolean;
+    set visible(value: boolean);
+    /**
+     * @description 是否正在编辑关键属性
+     */
+    get keyPropertyEditing(): boolean;
+    set keyPropertyEditing(value: boolean);
+    /**
+     * @description 转换为 EffectsCreateInfo
+     * @param withParent 是否包含父节点ID
+     */
+    toCreateInfo(withParent?: boolean): EffectsCreateInfo;
+    /**
+     * @description 克隆 SDKItem
+     */
+    clone(): EffectsItem;
+}
+/**
+ * @description 类型守卫：检查是否是 EffectsItem
+ */
+declare function isEffectsItem(obj: any): obj is EffectsItem;
 
 /**
  * @description 根据 item type 创建对应的 SDKItem 实例
@@ -2320,14 +2365,12 @@ declare class SDK {
      * @param createInfo 生成器创建信息
      * @returns 生成器元素ID
      */
-    createGenerator(createInfo: GeneratorCreateInfo): string;
+    addGeneratorItem(createInfo: GeneratorCreateInfo): string;
     /**
-     * @description 创建视频生成器元素
-     * @param createInfo 视频生成器创建信息
-     * @returns 视频生成器元素ID
-     * @deprecated 使用 createGenerator 替代
+     * @description 创建动效元素（仅限调试使用）
+     * @param effectsInfo 动效创建信息
      */
-    createVideoGenerator(createInfo: GeneratorCreateInfo): string;
+    addEffectsItem(effectsInfo: EffectsCreateInfo): void;
     /**
      * @description 设置生成器资源，将生成器转换为对应的元素
      * @param id 生成器元素ID
@@ -2340,33 +2383,16 @@ declare class SDK {
      * @param resource 生成器资源信息
      */
     setGeneratorResourceFromObject(resource: GeneratorResource): void;
-    /**
-     * @description 将视频生成器转换为视频元素
-     * @param id 视频生成器元素ID
-     * @param videoUrl 视频资源地址
-     * @returns 新的视频元素ID
-     * @deprecated 使用 setGeneratorResource 替代
-     */
-    convertVideoGeneratorToVideo(id: string, videoUrl: string): Promise<string>;
     /**
      * @description 设置视频生成器资源
      * @param resource 视频生成器资源信息
-     * @deprecated 使用 setGeneratorResource 替代
-     */
-    setVideoGeneratorResource(resource: VideoGeneratorResource): void;
-    /**
-     * @description 创建图层生成器元素
-     * @param createInfo 图层生成器创建信息
-     * @returns 图层生成器元素ID
-     * @deprecated 使用 createGenerator 替代
      */
-    createSpriteGenerator(createInfo: GeneratorCreateInfo): string;
+    setVideoGeneratorResource(resource: VideoGeneratorResource): Promise<string>;
     /**
      * @description 设置图层生成器资源
      * @param resource 图层生成器资源信息
-     * @deprecated 使用 setGeneratorResource 替代
      */
-    setSpriteGeneratorResource(resource: SpriteGeneratorResource): void;
+    setSpriteGeneratorResource(resource: SpriteGeneratorResource): Promise<string>;
     setItemLockState(id: string, state: boolean): void;
     getItemLockState(id: string): void;
     openItemCreateGizmo(type: ItemCreateType): void;
@@ -2408,6 +2434,9 @@ type TextFormProperty = BaseFormProperty & {
 type VideoFormProperty = BaseFormProperty & {
     video: string;
 };
+type EffectsFormProperty = BaseFormProperty & {
+    effects: string;
+};
 /**
  * @description 页面表单类型和属性引用
  */
@@ -3017,7 +3046,49 @@ type VideoGeneratorResource = {
     extensions?: Record<string, any>;
 };
 type GeneratorResource = SpriteGeneratorResource | VideoGeneratorResource;
-type ItemCreateInfo = NullCreateInfo | SpriteCreateInfo | TextCreateInfo | VideoCreateInfo | GeneratorCreateInfo;
+type EffectsCreateInfo = {
+    /**
+     * @description 元素类型 - 特效
+     */
+    type: 'effects';
+    /**
+     * @description 元素名称
+     */
+    name?: string;
+    /**
+     * @description 元素id
+     */
+    id?: string;
+    /**
+     * @description 父元素id
+     */
+    parentId?: string;
+    /**
+     * @description 生成器大小
+     */
+    size?: spec.vec2;
+    /**
+     * @description 生成器位置
+     */
+    position: spec.vec2;
+    /**
+     * @description 旋转角度
+     */
+    rotation?: number;
+    /**
+     * @description 缩放
+     */
+    scale?: spec.vec2;
+    /**
+     * @description 动效资源地址
+     */
+    url: string;
+    /**
+     * @description 扩展属性
+     */
+    extensions?: Record<string, any>;
+};
+type ItemCreateInfo = NullCreateInfo | SpriteCreateInfo | TextCreateInfo | VideoCreateInfo | GeneratorCreateInfo | EffectsCreateInfo;
 /**
  * @description 场景创建信息
  */
@@ -3059,4 +3130,4 @@ type ViewportFitShiftParam = {
     bottom?: number;
 };
 
-export { type ActiveData, type BaseFormProperty, BaseItem, Box2, type CreateOperation, type DeleteOperation, type GizmoType, type ItemCreateInfo, ItemOrderAction, type NullCreateInfo, NullItem, type NullItemOptions, type Operation, type PageData, type PageFormTypedProperty, type PageProperty, SDK, type SDKEvents, type SDKInputParam, type SDKItem$1 as SDKItem, type SDKItemOptions, type SDKOptions, type SetItemPropertyValueParam, type SpecificPageFormProps, type SpriteCreateInfo, type SpriteFormProperty, SpriteItem, type SpriteItemOptions, type TextCreateInfo, type TextFormProperty, TextItem, type TextItemOptions, type UpdateOperation, Vector2, type VideoCreateInfo, type VideoFormProperty, VideoItem, type VideoItemOptions, type ViewItemTypedProperty, type ViewParam, type ViewProperty, createSDKItem, createSDKItemFromPlayerItem, isBaseItem, isNullItem, isSpriteItem, isTextItem, isVideoItem };
+export { type ActiveData, type BaseFormProperty, BaseItem, Box2, type CreateOperation, type DeleteOperation, type EffectsCreateInfo, EffectsItem, type EffectsItemOptions, type GeneratorCreateInfo, GeneratorItem, type GeneratorItemOptions, type GizmoType, type ItemCreateInfo, ItemOrderAction, type NullCreateInfo, NullItem, type NullItemOptions, type Operation, type PageData, type PageFormTypedProperty, type PageProperty, SDK, type SDKEvents, type SDKInputParam, type SDKItem$1 as SDKItem, type SDKItemOptions, type SDKOptions, type SetItemPropertyValueParam, type SpecificPageFormProps, type SpriteCreateInfo, type SpriteFormProperty, SpriteItem, type SpriteItemOptions, type TextCreateInfo, type TextFormProperty, TextItem, type TextItemOptions, type UpdateOperation, Vector2, type VideoCreateInfo, type VideoFormProperty, VideoItem, type VideoItemOptions, type ViewItemTypedProperty, type ViewParam, type ViewProperty, createSDKItem, createSDKItemFromPlayerItem, isBaseItem, isEffectsItem, isGeneratorItem, isNullItem, isSpriteItem, isTextItem, isVideoItem };

package/dist/index.d.ts

@@ -100,11 +100,14 @@ type GeneratorItemOptions = SDKItemOptions & {
      */
     property?: Partial<SpriteFormProperty>;
 };
+type EffectsItemOptions = SDKItemOptions & {
+    property?: Partial<EffectsFormProperty>;
+};
 /**
  * @description SDKItem 类型（独立于 spec.ItemType）
  * @description 包含所有 SDK 层级的元素类型，包括虚拟类型如 generator
  */
-type SDKItemType = 'sprite' | 'text' | 'video' | 'null' | 'generator';
+type SDKItemType = 'sprite' | 'text' | 'video' | 'null' | 'generator' | 'effects' | 'frame';
 
 /**
  * @description SDKItem 抽象基类
@@ -200,11 +203,6 @@ declare abstract class BaseItem {
      * @description 清空所有扩展属性
      */
     clearExtensions(): void;
-    /**
-     * @description 转换为普通对象（用于序列化）
-     * @returns 普通对象
-     */
-    abstract toJSON(): Record<string, any>;
     /**
      * @description 转换为 CreateInfo（用于元素复制/导出）
      * @param withParent 是否包含父节点ID
@@ -217,10 +215,10 @@ declare abstract class BaseItem {
      */
     abstract clone(): BaseItem;
     /**
-     * @description 获取基础属性的 JSON 对象（子类可用）
-     * @protected
+     * @description 获取基础属性的 JSON 对象,转换为普通对象（用于序列化）
+     * @returns 普通对象
      */
-    protected getBaseJSON(): Record<string, any>;
+    toJSON(): Record<string, any>;
 }
 /**
  * @description 类型守卫函数：检查对象是否是 BaseItem
@@ -278,10 +276,6 @@ declare class SpriteItem extends BaseItem {
      */
     get keyPropertyEditing(): boolean;
     set keyPropertyEditing(value: boolean);
-    /**
-     * @description 转换为普通对象
-     */
-    toJSON(): Record<string, any>;
     /**
      * @description 转换为 CreateInfo
      * @param withParent 是否包含父节点ID
@@ -397,10 +391,6 @@ declare class TextItem extends BaseItem {
      */
     get visible(): boolean;
     set visible(value: boolean);
-    /**
-     * @description 转换为普通对象
-     */
-    toJSON(): Record<string, any>;
     /**
      * @description 转换为 CreateInfo
      * @param withParent 是否包含父节点ID
@@ -465,10 +455,6 @@ declare class VideoItem extends BaseItem {
      */
     get keyPropertyEditing(): boolean;
     set keyPropertyEditing(value: boolean);
-    /**
-     * @description 转换为普通对象
-     */
-    toJSON(): Record<string, any>;
     /**
      * @description 转换为 CreateInfo
      * @param withParent 是否包含父节点ID
@@ -536,10 +522,6 @@ declare class NullItem extends BaseItem {
      * @description 设置缩放（存储在扩展属性中）
      */
     set scaleForCreateInfo(value: [number, number]);
-    /**
-     * @description 转换为普通对象
-     */
-    toJSON(): Record<string, any>;
     /**
      * @description 转换为 CreateInfo
      * @param withParent 是否包含父节点ID
@@ -610,10 +592,6 @@ declare class GeneratorItem extends BaseItem {
      */
     get keyPropertyEditing(): boolean;
     set keyPropertyEditing(value: boolean);
-    /**
-     * @description 转换为普通对象
-     */
-    toJSON(): Record<string, any>;
     /**
      * @description 转换为 GeneratorCreateInfo
      * @param withParent 是否包含父节点ID
@@ -636,6 +614,73 @@ declare class GeneratorItem extends BaseItem {
      */
     clone(): GeneratorItem;
 }
+/**
+ * @description 类型守卫：检查是否是 GeneratorItem
+ */
+declare function isGeneratorItem(obj: any): obj is GeneratorItem;
+
+/**
+ * @description 特效产物 元素 SDKItem 类
+ */
+declare class EffectsItem extends BaseItem {
+    /**
+     * @description 元素类型（独立类型，不属于 spec.ItemType）
+     */
+    readonly type: SDKItemType;
+    /**
+     * @description 元素属性
+     */
+    property: EffectsFormProperty;
+    constructor(options: EffectsItemOptions);
+    /**
+     * @description 特效资源地址
+     */
+    get effects(): string;
+    set effects(value: string);
+    /**
+     * @description 位置
+     */
+    get position(): [number, number];
+    set position(value: [number, number]);
+    /**
+     * @description 大小
+     */
+    get size(): [number, number];
+    set size(value: [number, number]);
+    /**
+     * @description 旋转（二维旋转角度）
+     */
+    get rotation(): number;
+    set rotation(value: number);
+    /**
+     * @description 完整旋转（包含 x, y, z）
+     */
+    get fullRotation(): [number, number, number];
+    set fullRotation(value: [number, number, number]);
+    /**
+     * @description 可见性
+     */
+    get visible(): boolean;
+    set visible(value: boolean);
+    /**
+     * @description 是否正在编辑关键属性
+     */
+    get keyPropertyEditing(): boolean;
+    set keyPropertyEditing(value: boolean);
+    /**
+     * @description 转换为 EffectsCreateInfo
+     * @param withParent 是否包含父节点ID
+     */
+    toCreateInfo(withParent?: boolean): EffectsCreateInfo;
+    /**
+     * @description 克隆 SDKItem
+     */
+    clone(): EffectsItem;
+}
+/**
+ * @description 类型守卫：检查是否是 EffectsItem
+ */
+declare function isEffectsItem(obj: any): obj is EffectsItem;
 
 /**
  * @description 根据 item type 创建对应的 SDKItem 实例
@@ -2320,14 +2365,12 @@ declare class SDK {
      * @param createInfo 生成器创建信息
      * @returns 生成器元素ID
      */
-    createGenerator(createInfo: GeneratorCreateInfo): string;
+    addGeneratorItem(createInfo: GeneratorCreateInfo): string;
     /**
-     * @description 创建视频生成器元素
-     * @param createInfo 视频生成器创建信息
-     * @returns 视频生成器元素ID
-     * @deprecated 使用 createGenerator 替代
+     * @description 创建动效元素（仅限调试使用）
+     * @param effectsInfo 动效创建信息
      */
-    createVideoGenerator(createInfo: GeneratorCreateInfo): string;
+    addEffectsItem(effectsInfo: EffectsCreateInfo): void;
     /**
      * @description 设置生成器资源，将生成器转换为对应的元素
      * @param id 生成器元素ID
@@ -2340,33 +2383,16 @@ declare class SDK {
      * @param resource 生成器资源信息
      */
     setGeneratorResourceFromObject(resource: GeneratorResource): void;
-    /**
-     * @description 将视频生成器转换为视频元素
-     * @param id 视频生成器元素ID
-     * @param videoUrl 视频资源地址
-     * @returns 新的视频元素ID
-     * @deprecated 使用 setGeneratorResource 替代
-     */
-    convertVideoGeneratorToVideo(id: string, videoUrl: string): Promise<string>;
     /**
      * @description 设置视频生成器资源
      * @param resource 视频生成器资源信息
-     * @deprecated 使用 setGeneratorResource 替代
-     */
-    setVideoGeneratorResource(resource: VideoGeneratorResource): void;
-    /**
-     * @description 创建图层生成器元素
-     * @param createInfo 图层生成器创建信息
-     * @returns 图层生成器元素ID
-     * @deprecated 使用 createGenerator 替代
      */
-    createSpriteGenerator(createInfo: GeneratorCreateInfo): string;
+    setVideoGeneratorResource(resource: VideoGeneratorResource): Promise<string>;
     /**
      * @description 设置图层生成器资源
      * @param resource 图层生成器资源信息
-     * @deprecated 使用 setGeneratorResource 替代
      */
-    setSpriteGeneratorResource(resource: SpriteGeneratorResource): void;
+    setSpriteGeneratorResource(resource: SpriteGeneratorResource): Promise<string>;
     setItemLockState(id: string, state: boolean): void;
     getItemLockState(id: string): void;
     openItemCreateGizmo(type: ItemCreateType): void;
@@ -2408,6 +2434,9 @@ type TextFormProperty = BaseFormProperty & {
 type VideoFormProperty = BaseFormProperty & {
     video: string;
 };
+type EffectsFormProperty = BaseFormProperty & {
+    effects: string;
+};
 /**
  * @description 页面表单类型和属性引用
  */
@@ -3017,7 +3046,49 @@ type VideoGeneratorResource = {
     extensions?: Record<string, any>;
 };
 type GeneratorResource = SpriteGeneratorResource | VideoGeneratorResource;
-type ItemCreateInfo = NullCreateInfo | SpriteCreateInfo | TextCreateInfo | VideoCreateInfo | GeneratorCreateInfo;
+type EffectsCreateInfo = {
+    /**
+     * @description 元素类型 - 特效
+     */
+    type: 'effects';
+    /**
+     * @description 元素名称
+     */
+    name?: string;
+    /**
+     * @description 元素id
+     */
+    id?: string;
+    /**
+     * @description 父元素id
+     */
+    parentId?: string;
+    /**
+     * @description 生成器大小
+     */
+    size?: spec.vec2;
+    /**
+     * @description 生成器位置
+     */
+    position: spec.vec2;
+    /**
+     * @description 旋转角度
+     */
+    rotation?: number;
+    /**
+     * @description 缩放
+     */
+    scale?: spec.vec2;
+    /**
+     * @description 动效资源地址
+     */
+    url: string;
+    /**
+     * @description 扩展属性
+     */
+    extensions?: Record<string, any>;
+};
+type ItemCreateInfo = NullCreateInfo | SpriteCreateInfo | TextCreateInfo | VideoCreateInfo | GeneratorCreateInfo | EffectsCreateInfo;
 /**
  * @description 场景创建信息
  */
@@ -3059,4 +3130,4 @@ type ViewportFitShiftParam = {
     bottom?: number;
 };
 
-export { type ActiveData, type BaseFormProperty, BaseItem, Box2, type CreateOperation, type DeleteOperation, type GizmoType, type ItemCreateInfo, ItemOrderAction, type NullCreateInfo, NullItem, type NullItemOptions, type Operation, type PageData, type PageFormTypedProperty, type PageProperty, SDK, type SDKEvents, type SDKInputParam, type SDKItem$1 as SDKItem, type SDKItemOptions, type SDKOptions, type SetItemPropertyValueParam, type SpecificPageFormProps, type SpriteCreateInfo, type SpriteFormProperty, SpriteItem, type SpriteItemOptions, type TextCreateInfo, type TextFormProperty, TextItem, type TextItemOptions, type UpdateOperation, Vector2, type VideoCreateInfo, type VideoFormProperty, VideoItem, type VideoItemOptions, type ViewItemTypedProperty, type ViewParam, type ViewProperty, createSDKItem, createSDKItemFromPlayerItem, isBaseItem, isNullItem, isSpriteItem, isTextItem, isVideoItem };
+export { type ActiveData, type BaseFormProperty, BaseItem, Box2, type CreateOperation, type DeleteOperation, type EffectsCreateInfo, EffectsItem, type EffectsItemOptions, type GeneratorCreateInfo, GeneratorItem, type GeneratorItemOptions, type GizmoType, type ItemCreateInfo, ItemOrderAction, type NullCreateInfo, NullItem, type NullItemOptions, type Operation, type PageData, type PageFormTypedProperty, type PageProperty, SDK, type SDKEvents, type SDKInputParam, type SDKItem$1 as SDKItem, type SDKItemOptions, type SDKOptions, type SetItemPropertyValueParam, type SpecificPageFormProps, type SpriteCreateInfo, type SpriteFormProperty, SpriteItem, type SpriteItemOptions, type TextCreateInfo, type TextFormProperty, TextItem, type TextItemOptions, type UpdateOperation, Vector2, type VideoCreateInfo, type VideoFormProperty, VideoItem, type VideoItemOptions, type ViewItemTypedProperty, type ViewParam, type ViewProperty, createSDKItem, createSDKItemFromPlayerItem, isBaseItem, isEffectsItem, isGeneratorItem, isNullItem, isSpriteItem, isTextItem, isVideoItem };