@worldfirst/worldfirst-js 0.0.1775118337-dev.8 → 1.0.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@worldfirst/worldfirst-js",
-  "version": "0.0.1775118337-dev.8",
+  "version": "1.0.1",
   "description": "worldfirst sdk",
   "exports": {
     ".": {

package/types.d.ts

@@ -86,7 +86,7 @@ declare abstract class BaseElement<Config extends BaseElementConfig = BaseElemen
     /**
      * 卸载元素
      */
-    umount(): void;
+    unmount(): void;
     /* Excluded from this release type: isSingleMode */
     /**
      * 监听消息
@@ -236,6 +236,10 @@ declare interface DefaultAppearanceProps {
     rules: string;
 }
 
+declare const ELEMENT_TYPE: {
+    ONBOARD: string;
+};
+
 /**
  * @description 元素列表项类型
  */
@@ -246,6 +250,8 @@ declare type ElementListItemType = iBaseElementClass | {
 
 declare type ElementMode = 'SINGLE' | 'GROUP';
 
+export declare type ElementTypes = keyof typeof ELEMENT_TYPE;
+
 declare interface ErrorPayload<Code extends string = string> {
     source: ErrorSource;
     code: Code;
@@ -332,13 +338,51 @@ declare type OnboardElementConfig = BaseElementConfig<OnboardAppConfig>;
 /**
  * @description Onboard element events
  */
-export declare type OnboardElementEvents = WorldFirstBridgeEventMap<OnboardAppConfig, OnboardSubmitParams>;
+export declare interface OnboardElementEvents extends WorldFirstBridgeEventMap<OnboardAppConfig, OnboardSubmitParams> {
+    stepChange: {
+        hasNext: boolean;
+        hasPre: boolean;
+        hasTemporaryStorage: boolean;
+        hasSubmit: boolean;
+        nodeId: string;
+        /**
+         * 是否是上一步
+         */
+        stepBack: boolean;
+    };
+    updateTheme: Record<string, string>;
+}
 
 /**
- * @description The submit params
+ * @description submit params
  */
 export declare interface OnboardSubmitParams {
-    [key: string]: any;
+    /**
+     * @description 提交是否成功
+     */
+    success: boolean;
+    /**
+     * @description 返回的数据
+     */
+    data?: Record<string, any>;
+    /**
+     * @description 错误信息
+     */
+    error?: {
+        source: string;
+        code: string;
+        message: string;
+        reason: string;
+        traceId?: string;
+    };
+    /**
+     * @description 兼容旧版本的 result 字段
+     */
+    result?: 'success' | 'fail';
+    /**
+     * @description 兼容旧版本的 errorMessage 字段
+     */
+    errorMessage?: string;
 }
 
 /**
@@ -401,6 +445,12 @@ declare interface PreLoadConfig {
      * 每个值与 createElement 的 type 参数一致，如 'Onboard'、'Vaulting'。
      */
     elements?: string[];
+    /**
+     * @description 语言标识，用于替换 manifest 中多语言资源 URL 的 {lang} 占位符。
+     * 支持的值与 embeddedSDK 的 VALID_LANGUAGES 一致，如 'zh-CN'、'en-US' 等。
+     * 若未传入或不在支持列表中，默认使用 'zh-CN'。
+     */
+    locale?: string;
 }
 
 /**

package/types.untrimmed.d.ts

@@ -192,7 +192,7 @@ declare abstract class BaseElement<Config extends BaseElementConfig = BaseElemen
     /**
      * 卸载元素
      */
-    umount(): void;
+    unmount(): void;
     /**
      * 独立模式，需要实现submit
      * @internal 内部属性不暴露给商户
@@ -462,6 +462,10 @@ declare interface DefaultAppearanceProps {
     rules: string;
 }
 
+declare const ELEMENT_TYPE: {
+    ONBOARD: string;
+};
+
 /**
  * @description 元素列表项类型
  */
@@ -472,6 +476,8 @@ declare type ElementListItemType = iBaseElementClass | {
 
 declare type ElementMode = 'SINGLE' | 'GROUP';
 
+export declare type ElementTypes = keyof typeof ELEMENT_TYPE;
+
 declare interface ErrorPayload<Code extends string = string> {
     source: ErrorSource;
     code: Code;
@@ -558,13 +564,51 @@ declare type OnboardElementConfig = BaseElementConfig<OnboardAppConfig>;
 /**
  * @description Onboard element events
  */
-export declare type OnboardElementEvents = WorldFirstBridgeEventMap<OnboardAppConfig, OnboardSubmitParams>;
+export declare interface OnboardElementEvents extends WorldFirstBridgeEventMap<OnboardAppConfig, OnboardSubmitParams> {
+    stepChange: {
+        hasNext: boolean;
+        hasPre: boolean;
+        hasTemporaryStorage: boolean;
+        hasSubmit: boolean;
+        nodeId: string;
+        /**
+         * 是否是上一步
+         */
+        stepBack: boolean;
+    };
+    updateTheme: Record<string, string>;
+}
 
 /**
- * @description The submit params
+ * @description submit params
  */
 export declare interface OnboardSubmitParams {
-    [key: string]: any;
+    /**
+     * @description 提交是否成功
+     */
+    success: boolean;
+    /**
+     * @description 返回的数据
+     */
+    data?: Record<string, any>;
+    /**
+     * @description 错误信息
+     */
+    error?: {
+        source: string;
+        code: string;
+        message: string;
+        reason: string;
+        traceId?: string;
+    };
+    /**
+     * @description 兼容旧版本的 result 字段
+     */
+    result?: 'success' | 'fail';
+    /**
+     * @description 兼容旧版本的 errorMessage 字段
+     */
+    errorMessage?: string;
 }
 
 /**
@@ -630,6 +674,12 @@ declare interface PreLoadConfig {
      * 每个值与 createElement 的 type 参数一致，如 'Onboard'、'Vaulting'。
      */
     elements?: string[];
+    /**
+     * @description 语言标识，用于替换 manifest 中多语言资源 URL 的 {lang} 占位符。
+     * 支持的值与 embeddedSDK 的 VALID_LANGUAGES 一致，如 'zh-CN'、'en-US' 等。
+     * 若未传入或不在支持列表中，默认使用 'zh-CN'。
+     */
+    locale?: string;
 }
 
 /**