@vvfx/sdk 0.1.19-alpha.36 → 0.1.19-alpha.38

package/dist/src/sdk-item/group-item.d.ts

@@ -0,0 +1,57 @@
+import type { GroupCreateInfo, GroupItemProperty } from '../types';
+import { SDKItemType, type GroupItemOptions } from './types';
+import { BaseItem } from './base-item';
+/**
+ * @description 空节点/组 SDKItem 类
+ * @description 支持属性扩展
+ */
+export declare class GroupItem extends BaseItem {
+    /**
+     * @description 元素类型
+     */
+    readonly type = SDKItemType.GROUP;
+    /**
+     * @description 元素属性
+     */
+    property: GroupItemProperty;
+    constructor(options: GroupItemOptions);
+    /**
+     * @description 位置
+     */
+    get position(): [number, number];
+    set position(value: [number, number]);
+    /**
+     * @description 大小
+     */
+    get scale(): [number, number];
+    set scale(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 是否正在编辑关键属性
+     * @deprecated 该属性即将废弃，使用 isCoreEditable 代替
+     */
+    get keyPropertyEditing(): boolean;
+    set keyPropertyEditing(value: boolean);
+    /**
+     * @description 转换为 CreateInfo
+     * @param withParent 是否包含父节点ID
+     */
+    toCreateInfo(withParent?: boolean): GroupCreateInfo;
+    /**
+     * @description 克隆 SDKItem
+     */
+    clone(): GroupItem;
+}
+/**
+ * @description 类型守卫：检查是否是 GroupItem
+ */
+export declare function isGroupItem(obj: any): obj is GroupItem;

package/dist/src/sdk-item/index.d.ts

@@ -0,0 +1,36 @@
+export type { SDKItemOptions, SpriteItemOptions, TextItemOptions, VideoItemOptions, GroupItemOptions, GeneratorItemOptions, EffectsItemOptions, FrameItemOptions, CardItemOptions, 
+/** @deprecated 使用 GeneratorItemOptions 替代 */
+VideoGeneratorItemOptions, } from './types';
+export { SDKItemType, } from './types';
+export { BaseItem, isBaseItem } from './base-item';
+export { SpriteItem, isSpriteItem } from './sprite-item';
+export { TextItem, isTextItem } from './text-item';
+export { VideoItem, isVideoItem } from './video-item';
+export { GroupItem, isGroupItem } from './group-item';
+export { GeneratorItem, isGeneratorItem } from './generator-item';
+export { EffectsItem, isEffectsItem } from './effects-item';
+export { FrameItem, isFrameItem } from './frame-item';
+export { CardItem, isCardItem } from './card-item';
+import { spec } from '../shared';
+import { BaseItem } from './base-item';
+import { SpriteItem } from './sprite-item';
+import { GroupItem } from './group-item';
+import { TextItem } from './text-item';
+import { VideoItem } from './video-item';
+import { GeneratorItem } from './generator-item';
+import type { SDKItemOptions } from './types';
+import { EffectsItem } from './effects-item';
+import type { FrameItem } from './frame-item';
+import type { CardItem } from './card-item';
+/**
+ * @description 根据 item type 创建对应的 SDKItem 实例
+ * @param type 元素类型
+ * @param options SDKItem 选项
+ * @returns SDKItem 实例
+ */
+export declare function createSDKItem(type: spec.ItemType, options: SDKItemOptions): BaseItem;
+/**
+ * @description SDKItem 类型联合
+ * @description 用于替换原来的 SDKItem type
+ */
+export type SDKItem = SpriteItem | TextItem | VideoItem | GroupItem | GeneratorItem | EffectsItem | FrameItem | CardItem;

package/dist/src/sdk-item/sprite-item.d.ts

@@ -0,0 +1,67 @@
+import type { SpriteItemProperty, SpriteCreateInfo } from '../types';
+import { SDKItemType, type SpriteItemOptions } from './types';
+import { BaseItem } from './base-item';
+/**
+ * @description 图片元素 SDKItem 类
+ * @description 支持属性扩展
+ */
+export declare class SpriteItem extends BaseItem {
+    /**
+     * @description 元素类型
+     */
+    readonly type = SDKItemType.SPRITE;
+    /**
+     * @description 元素属性
+     */
+    property: SpriteItemProperty;
+    constructor(options: SpriteItemOptions);
+    /**
+     * @description 图片地址
+     */
+    get image(): string;
+    set image(value: string);
+    /**
+     * @description 位置
+     */
+    get position(): [number, number];
+    set position(value: [number, number]);
+    get width(): number;
+    set width(value: number);
+    get height(): number;
+    set height(value: 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 是否正在编辑关键属性
+     * @deprecated 该属性即将废弃，使用 isCoreEditable 代替
+     */
+    get keyPropertyEditing(): boolean;
+    set keyPropertyEditing(value: boolean);
+    /**
+     * @description 转换为 CreateInfo
+     * @param withParent 是否包含父节点ID
+     */
+    toCreateInfo(withParent?: boolean): SpriteCreateInfo;
+    /**
+     * @description 克隆 SDKItem
+     */
+    clone(): SpriteItem;
+    /**
+     * @description 创建包含扩展属性的 CreateInfo
+     * @param withParent 是否包含父节点ID
+     * @param extraProps 额外的属性
+     */
+    toCreateInfoWithExtensions(withParent?: boolean, extraProps?: Record<string, any>): SpriteCreateInfo;
+}
+/**
+ * @description 类型守卫：检查是否是 SpriteItem
+ */
+export declare function isSpriteItem(obj: any): obj is SpriteItem;

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

@@ -0,0 +1,107 @@
+import type { TextItemProperty, TextCreateInfo } from '../types';
+import { spec } from '../shared';
+import { SDKItemType, type TextItemOptions } from './types';
+import { BaseItem } from './base-item';
+/**
+ * @description 文本元素 SDKItem 类
+ * @description 支持属性扩展
+ */
+export declare class TextItem extends BaseItem {
+    /**
+     * @description 元素类型
+     */
+    readonly type = SDKItemType.TEXT;
+    /**
+     * @description 元素属性
+     */
+    property: TextItemProperty;
+    constructor(options: TextItemOptions);
+    /**
+     * @description 文本内容
+     */
+    get text(): string;
+    set text(value: string);
+    /**
+     * @description 字体名称
+     */
+    get fontFamily(): string;
+    set fontFamily(value: string);
+    /**
+     * @description 字号
+     */
+    get fontSize(): number;
+    set fontSize(value: number);
+    /**
+     * @description 字重
+     */
+    get fontWeight(): spec.TextWeight;
+    set fontWeight(value: spec.TextWeight);
+    /**
+     * @description 字体样式
+     */
+    get fontStyle(): spec.FontStyle;
+    set fontStyle(value: spec.FontStyle);
+    /**
+     * @description 文本对齐方式
+     */
+    get textAlign(): spec.TextAlignment;
+    set textAlign(value: spec.TextAlignment);
+    /**
+     * @description 文本颜色 [r, g, b, a]
+     */
+    get color(): [number, number, number, number];
+    set color(value: [number, number, number, number]);
+    /**
+     * @description 文本宽度
+     */
+    get width(): number;
+    set width(value: number);
+    /**
+     * @description 行高
+     */
+    get lineHeight(): number;
+    set lineHeight(value: number);
+    /**
+     * @description 文本高度
+     */
+    get height(): number;
+    set height(value: number);
+    /**
+     * @description 描边颜色
+     */
+    get outlineColor(): spec.vec4 | undefined;
+    set outlineColor(value: spec.vec4 | undefined);
+    /**
+     * @description 描边宽度
+     */
+    get outlineWidth(): number | undefined;
+    set outlineWidth(value: number | undefined);
+    /**
+     * @description 描边开关
+     */
+    get outlineEnabled(): boolean;
+    set outlineEnabled(value: boolean);
+    /**
+     * @description 位置
+     */
+    get position(): [number, number];
+    set position(value: [number, number]);
+    /**
+     * @description 旋转（二维旋转角度）
+     */
+    get rotation(): number;
+    set rotation(value: number);
+    /**
+     * @description 转换为 CreateInfo
+     * @param withParent 是否包含父节点ID
+     */
+    toCreateInfo(withParent?: boolean): TextCreateInfo;
+    /**
+     * @description 克隆 SDKItem
+     */
+    clone(): TextItem;
+}
+/**
+ * @description 类型守卫：检查是否是 TextItem
+ */
+export declare function isTextItem(obj: any): obj is TextItem;

package/dist/src/sdk-item/types.d.ts

@@ -0,0 +1,153 @@
+import type { SpriteItemProperty, TextItemProperty, VideoItemProperty, GeneratorItemProperty, GroupItemProperty, EffectsItemProperty, FrameItemProperty, CardItemProperty } from '../types';
+import { spec } from '../shared';
+/**
+ * @description SDKItem 基础选项接口
+ * @description 支持扩展属性，允许添加任意额外属性
+ */
+export type SDKItemOptions = {
+    /**
+     * @description 元素ID
+     */
+    id: string;
+    /**
+     * @description 元素名称
+     */
+    name: string;
+    /**
+     * @description 父节点ID
+     */
+    parentId?: string;
+    /**
+     * @description 子元素ID列表
+     */
+    children?: string[];
+    /**
+     * @description 元素生命周期
+     */
+    duration?: number;
+    /**
+     * @description 元素生命周期延时
+     */
+    delay?: number;
+    /**
+     * @description 可视状态
+     */
+    visible?: boolean;
+    /**
+     * @description 元素结束行为
+     */
+    endBehavior?: spec.EndBehavior;
+    /**
+     * @description 是否处于锁定状态
+     */
+    isLocked?: boolean;
+    /**
+     * @description 关键属性是否可编辑
+     */
+    isCoreEditable: boolean;
+    /**
+     * @description 扩展属性存储（属性名 -> 属性值）
+     */
+    extension?: Record<string, any>;
+    /**
+     * @description 允许任意额外属性（用于兼容旧代码）
+     */
+    [extraProp: string]: any;
+};
+/**
+ * @description Sprite SDKItem 选项
+ */
+export type SpriteItemOptions = SDKItemOptions & {
+    /**
+     * @description 元素属性
+     */
+    property?: Partial<SpriteItemProperty>;
+};
+/**
+ * @description Text SDKItem 选项
+ */
+export type TextItemOptions = SDKItemOptions & {
+    /**
+     * @description 元素属性
+     */
+    property?: Partial<TextItemProperty>;
+};
+/**
+ * @description Video SDKItem 选项
+ */
+export type VideoItemOptions = SDKItemOptions & {
+    /**
+     * @description 元素属性
+     */
+    property?: Partial<VideoItemProperty>;
+};
+/**
+ * @description Group SDKItem 选项（空节点/组）
+ */
+export type GroupItemOptions = SDKItemOptions & {
+    /**
+     * @description 元素属性
+     */
+    property?: Partial<GroupItemProperty>;
+};
+/**
+ * @description Generator SDKItem 选项（资源生成器）
+ * @description 支持 image 和 video 两种生成器类型
+ * @description 使用 GeneratorItemProperty 包含 generatorType
+ */
+export type GeneratorItemOptions = SDKItemOptions & {
+    /**
+     * @description 元素属性（包含 generatorType）
+     */
+    property?: Partial<GeneratorItemProperty>;
+};
+/**
+ * @deprecated 使用 GeneratorItemOptions 替代
+ */
+export type VideoGeneratorItemOptions = GeneratorItemOptions;
+export type EffectsItemOptions = SDKItemOptions & {
+    property?: Partial<EffectsItemProperty>;
+};
+/**
+ * @description Frame 画板元素 SDKItem 选项
+ */
+export type FrameItemOptions = SDKItemOptions & {
+    /**
+     * @description 元素属性
+     */
+    property?: Partial<FrameItemProperty>;
+};
+/**
+ * @description SDKItem 类型（独立于 spec.ItemType）
+ * @description 包含所有 SDK 层级的元素类型，包括虚拟类型如 generator
+ */
+export declare enum SDKItemType {
+    SPRITE = "sprite",
+    TEXT = "text",
+    VIDEO = "video",
+    GROUP = "group",
+    GENERATOR = "generator",
+    EFFECTS = "effects",
+    FRAME = "frame",
+    CARD = "card"
+}
+/**
+ * @description SDKItemType 与 spec.ItemType 的映射关系
+ */
+export declare const SDKItemTypeToSpecItemType: Record<SDKItemType, spec.ItemType>;
+/**
+ * @description Card 卡片元素 SDKItem 选项
+ * @description 在 Player 中以 SpriteItem 形式渲染
+ */
+export type CardItemOptions = SDKItemOptions & {
+    /**
+     * @description 元素属性（包含 cardType）
+     */
+    property?: Partial<CardItemProperty>;
+};
+/**
+ * @description 根据 SDKItemType 获取对应的 spec.ItemType
+ * @param sdkItemType SDKItem 类型
+ * @returns 对应的 spec.ItemType
+ */
+export declare function getSpecItemType(sdkItemType: SDKItemType): spec.ItemType;

package/dist/src/sdk-item/video-item.d.ts

@@ -0,0 +1,87 @@
+import type { VideoItemProperty, VideoCreateInfo } from '../types';
+import { SDKItemType, type VideoItemOptions } from './types';
+import { BaseItem } from './base-item';
+/**
+ * @description 视频元素 SDKItem 类
+ * @description 支持属性扩展
+ */
+export declare class VideoItem extends BaseItem {
+    /**
+     * @description 元素类型
+     */
+    readonly type = SDKItemType.VIDEO;
+    /**
+     * @description 元素属性
+     */
+    property: VideoItemProperty;
+    constructor(options: VideoItemOptions);
+    /**
+     * @description 视频地址
+     */
+    get video(): string;
+    set video(value: string);
+    /**
+     * @description 位置
+     */
+    get position(): [number, number];
+    set position(value: [number, number]);
+    /**
+     * @description 宽度
+     */
+    get width(): number;
+    set width(value: number);
+    /**
+     * @description 高度
+     */
+    get height(): number;
+    set height(value: 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 是否正在编辑关键属性
+     * @deprecated 该属性即将废弃，使用 isCoreEditable 代替
+     */
+    get keyPropertyEditing(): boolean;
+    set keyPropertyEditing(value: boolean);
+    /**
+     * @description 是否静音
+     */
+    get muted(): boolean;
+    set muted(state: boolean);
+    /**
+     * @description 是否为透明视频
+     */
+    get transparent(): boolean;
+    set transparent(state: boolean);
+    /**
+     * @description 播放音量
+     */
+    get volume(): number;
+    set volume(value: number);
+    /**
+     * @description 播放速率
+     */
+    get playbackRate(): number;
+    set playbackRate(value: number);
+    /**
+     * @description 转换为 CreateInfo
+     * @param withParent 是否包含父节点ID
+     */
+    toCreateInfo(withParent?: boolean): VideoCreateInfo;
+    /**
+     * @description 克隆 SDKItem
+     */
+    clone(): VideoItem;
+}
+/**
+ * @description 类型守卫：检查是否是 VideoItem
+ */
+export declare function isVideoItem(obj: any): obj is VideoItem;