@vvfx/sdk 0.0.0-alpha.4 → 0.0.0-alpha.6

package/dist/index.d.cts

@@ -1,16 +1,7 @@
-import { math, spec, Player } from '@galacean/effects';
+import { spec, Player } from '@galacean/effects';
 export { spec } from '@galacean/effects';
 import * as _galacean_effects_weapp from '@galacean/effects/weapp';
 
-declare class Vector2 extends math.Vector2 {
-    subtract(other: Vector2): this;
-    toViewCoordinate(width: number, height: number): this;
-    clone(): Vector2;
-    distanceTo(other: Vector2): number;
-    scaleByCenter(scalar: Vector2, anchor?: Vector2): Vector2;
-    round(precision?: number): this;
-}
-
 type ViewItemTypedProperty = {
     [K in keyof PageFormTypeAndPropertyReference]: {
         /**
@@ -109,7 +100,7 @@ type SDKInputParam = {
     /**
      * @description JSON地址
      */
-    scene: string;
+    scene: string | spec.JSONScene;
     /**
      * @description 视图参数
      */
@@ -185,6 +176,10 @@ type PageConfig = {
      * @description 吸附开关
      */
     adsorption: boolean;
+    /**
+     * @description 同步开关
+     */
+    sync: boolean;
 };
 /**
  * @description 页面属性
@@ -201,7 +196,7 @@ type PageProperty = {
     /**
      * @description 偏移值
      */
-    translation: Vector2;
+    translation: [number, number];
     /**
      * @description 吸附开关
      */
@@ -222,25 +217,12 @@ type ViewParam = {
     /**
      * @description 出血区参数
      */
-    safeArea: SafeAreaParam;
+    safeArea: [number, number, number, number];
     /**
      * @description 导出参数
      */
     export: ExportParam;
 };
-/**
- * @description 安全区数据
- */
-type SafeAreaParam = {
-    /**
-     * @description 出血区大小 - [上, 下, 左, 右]
-     */
-    size: [number, number, number, number];
-    /**
-     * @description 元素名称关键字
-     */
-    keyWords: string[];
-};
 /**
  * @description 导出参数
  */
@@ -277,7 +259,7 @@ type ViewProperty = {
     /**
      * @description 出血区数据
      */
-    safeArea: SafeAreaParam;
+    safeArea: [number, number, number, number];
     /**
      * @description 视图场景数据
      */
@@ -290,6 +272,10 @@ type ViewProperty = {
      * @description 导出参数
      */
     export: ExportParam;
+    /**
+     * @description 忽略交互 - 仅供展示
+     */
+    ignoreInteraction: boolean;
 };
 /**
  * @description 页面活跃数据
@@ -352,6 +338,7 @@ type ExportStatus = typeof ExportStatusMap[keyof typeof ExportStatusMap];
 type SDKEvents = {
     'selectedItemChange': [id: string[]];
     'preSelectedItemChange': [id: string | undefined];
+    'selectedViewChange': [id: number];
     'pageDataChange': [pageData: PageData];
     'zoomChange': [zoom: number];
     'progress': [{
@@ -360,11 +347,12 @@ type SDKEvents = {
         end: boolean;
         paused: boolean;
     }];
-    'exportingChange': [status: ExportStatus, progress?: number];
     'itemPropertyChange': [{
         id: string;
         property: string;
     }];
+    'exportProgress': [progress?: number];
+    'exportComplete': [success: boolean];
 };
 declare class SDK {
     private _eventEmitter;
@@ -375,15 +363,15 @@ declare class SDK {
     private _ExportVideo;
     private _gestureHandler;
     private _playerContainer;
-    private _isExportReady;
     private _exportStatus;
+    private disposables;
     player: Player;
     constructor(container: HTMLElement);
     get pageData(): PageData | undefined;
     get exportStatus(): ExportStatus;
-    private get exportVideoCanceled();
+    private get exportOptions();
     dispose(): void;
-    on: <E extends "progress" | "selectedItemChange" | "preSelectedItemChange" | "pageDataChange" | "zoomChange" | "exportingChange" | "itemPropertyChange">(eventName: E, listener: _galacean_effects_weapp.EventEmitterListener<SDKEvents[E]>, options?: _galacean_effects_weapp.EventEmitterOptions) => () => void;
+    on: <E extends "progress" | "selectedItemChange" | "preSelectedItemChange" | "selectedViewChange" | "pageDataChange" | "zoomChange" | "itemPropertyChange" | "exportProgress" | "exportComplete">(eventName: E, listener: _galacean_effects_weapp.EventEmitterListener<SDKEvents[E]>, options?: _galacean_effects_weapp.EventEmitterOptions) => () => void;
     private getInitParam;
     private initSDK;
     run(param: SDKInputParam): Promise<void>;
@@ -404,7 +392,7 @@ declare class SDK {
      * @returns 元素属性值
      */
     getItemPropertyValue<T extends keyof PageFormTypeAndPropertyReference, N extends keyof PageFormTypeAndPropertyReference[T]>(param: GetItemPropertyValueParam<T, N>): GetItemPropertyValueResult<T, N> | undefined;
-    setItemPropertyValue(param: SetItemPropertyValueParam): void;
+    setItemPropertyValue(param: SetItemPropertyValueParam): Promise<void>;
     generateScreenShot(id: number): Promise<string>;
     /**
      * @description 切换场景
@@ -425,7 +413,7 @@ declare class SDK {
      * @description 设置播放进度
      * @param progress 播放进度 0-100
      */
-    setPlayProgress(progress: number): void;
+    setPlayProgress(progress: number): Promise<void>;
     getViewItems(): ViewItem[];
     setPlayState(playState: 'play' | 'pause'): void;
     /**
@@ -436,12 +424,16 @@ declare class SDK {
         id: number;
         thumbnail: string;
     }[];
+    private onExportProgress;
+    private onExportFinish;
+    private onExportError;
     /**
-     * @description 导出所有视频
-     * @returns 导出视频的 ArrayBuffer 数组
+     * @description 导出视频
      */
-    exportAllVideos(): Promise<void>;
+    exportAllVideos(): void;
     cancelExportAllVideos(): void;
+    loadPageData(data: PageData): Promise<void>;
+    runByPageData(data: PageData): Promise<void>;
 }
 
 export { type ActiveData, type BaseFormProperty, type ExportStatus, ExportStatusMap, type PageData, type PageFormTypedProperty, type PageProperty, SDK, type SDKEvents, type SDKInputParam, type SpecificPageFormProps, type SpriteFormProperty, type TextFormProperty, type ViewItem, type ViewParam, type ViewProperty };

package/dist/index.d.ts

@@ -1,16 +1,7 @@
-import { math, spec, Player } from '@galacean/effects';
+import { spec, Player } from '@galacean/effects';
 export { spec } from '@galacean/effects';
 import * as _galacean_effects_weapp from '@galacean/effects/weapp';
 
-declare class Vector2 extends math.Vector2 {
-    subtract(other: Vector2): this;
-    toViewCoordinate(width: number, height: number): this;
-    clone(): Vector2;
-    distanceTo(other: Vector2): number;
-    scaleByCenter(scalar: Vector2, anchor?: Vector2): Vector2;
-    round(precision?: number): this;
-}
-
 type ViewItemTypedProperty = {
     [K in keyof PageFormTypeAndPropertyReference]: {
         /**
@@ -109,7 +100,7 @@ type SDKInputParam = {
     /**
      * @description JSON地址
      */
-    scene: string;
+    scene: string | spec.JSONScene;
     /**
      * @description 视图参数
      */
@@ -185,6 +176,10 @@ type PageConfig = {
      * @description 吸附开关
      */
     adsorption: boolean;
+    /**
+     * @description 同步开关
+     */
+    sync: boolean;
 };
 /**
  * @description 页面属性
@@ -201,7 +196,7 @@ type PageProperty = {
     /**
      * @description 偏移值
      */
-    translation: Vector2;
+    translation: [number, number];
     /**
      * @description 吸附开关
      */
@@ -222,25 +217,12 @@ type ViewParam = {
     /**
      * @description 出血区参数
      */
-    safeArea: SafeAreaParam;
+    safeArea: [number, number, number, number];
     /**
      * @description 导出参数
      */
     export: ExportParam;
 };
-/**
- * @description 安全区数据
- */
-type SafeAreaParam = {
-    /**
-     * @description 出血区大小 - [上, 下, 左, 右]
-     */
-    size: [number, number, number, number];
-    /**
-     * @description 元素名称关键字
-     */
-    keyWords: string[];
-};
 /**
  * @description 导出参数
  */
@@ -277,7 +259,7 @@ type ViewProperty = {
     /**
      * @description 出血区数据
      */
-    safeArea: SafeAreaParam;
+    safeArea: [number, number, number, number];
     /**
      * @description 视图场景数据
      */
@@ -290,6 +272,10 @@ type ViewProperty = {
      * @description 导出参数
      */
     export: ExportParam;
+    /**
+     * @description 忽略交互 - 仅供展示
+     */
+    ignoreInteraction: boolean;
 };
 /**
  * @description 页面活跃数据
@@ -352,6 +338,7 @@ type ExportStatus = typeof ExportStatusMap[keyof typeof ExportStatusMap];
 type SDKEvents = {
     'selectedItemChange': [id: string[]];
     'preSelectedItemChange': [id: string | undefined];
+    'selectedViewChange': [id: number];
     'pageDataChange': [pageData: PageData];
     'zoomChange': [zoom: number];
     'progress': [{
@@ -360,11 +347,12 @@ type SDKEvents = {
         end: boolean;
         paused: boolean;
     }];
-    'exportingChange': [status: ExportStatus, progress?: number];
     'itemPropertyChange': [{
         id: string;
         property: string;
     }];
+    'exportProgress': [progress?: number];
+    'exportComplete': [success: boolean];
 };
 declare class SDK {
     private _eventEmitter;
@@ -375,15 +363,15 @@ declare class SDK {
     private _ExportVideo;
     private _gestureHandler;
     private _playerContainer;
-    private _isExportReady;
     private _exportStatus;
+    private disposables;
     player: Player;
     constructor(container: HTMLElement);
     get pageData(): PageData | undefined;
     get exportStatus(): ExportStatus;
-    private get exportVideoCanceled();
+    private get exportOptions();
     dispose(): void;
-    on: <E extends "progress" | "selectedItemChange" | "preSelectedItemChange" | "pageDataChange" | "zoomChange" | "exportingChange" | "itemPropertyChange">(eventName: E, listener: _galacean_effects_weapp.EventEmitterListener<SDKEvents[E]>, options?: _galacean_effects_weapp.EventEmitterOptions) => () => void;
+    on: <E extends "progress" | "selectedItemChange" | "preSelectedItemChange" | "selectedViewChange" | "pageDataChange" | "zoomChange" | "itemPropertyChange" | "exportProgress" | "exportComplete">(eventName: E, listener: _galacean_effects_weapp.EventEmitterListener<SDKEvents[E]>, options?: _galacean_effects_weapp.EventEmitterOptions) => () => void;
     private getInitParam;
     private initSDK;
     run(param: SDKInputParam): Promise<void>;
@@ -404,7 +392,7 @@ declare class SDK {
      * @returns 元素属性值
      */
     getItemPropertyValue<T extends keyof PageFormTypeAndPropertyReference, N extends keyof PageFormTypeAndPropertyReference[T]>(param: GetItemPropertyValueParam<T, N>): GetItemPropertyValueResult<T, N> | undefined;
-    setItemPropertyValue(param: SetItemPropertyValueParam): void;
+    setItemPropertyValue(param: SetItemPropertyValueParam): Promise<void>;
     generateScreenShot(id: number): Promise<string>;
     /**
      * @description 切换场景
@@ -425,7 +413,7 @@ declare class SDK {
      * @description 设置播放进度
      * @param progress 播放进度 0-100
      */
-    setPlayProgress(progress: number): void;
+    setPlayProgress(progress: number): Promise<void>;
     getViewItems(): ViewItem[];
     setPlayState(playState: 'play' | 'pause'): void;
     /**
@@ -436,12 +424,16 @@ declare class SDK {
         id: number;
         thumbnail: string;
     }[];
+    private onExportProgress;
+    private onExportFinish;
+    private onExportError;
     /**
-     * @description 导出所有视频
-     * @returns 导出视频的 ArrayBuffer 数组
+     * @description 导出视频
      */
-    exportAllVideos(): Promise<void>;
+    exportAllVideos(): void;
     cancelExportAllVideos(): void;
+    loadPageData(data: PageData): Promise<void>;
+    runByPageData(data: PageData): Promise<void>;
 }
 
 export { type ActiveData, type BaseFormProperty, type ExportStatus, ExportStatusMap, type PageData, type PageFormTypedProperty, type PageProperty, SDK, type SDKEvents, type SDKInputParam, type SpecificPageFormProps, type SpriteFormProperty, type TextFormProperty, type ViewItem, type ViewParam, type ViewProperty };