@worldfirst/worldfirst-js 0.0.1 → 0.0.1775118337-dev.7

package/types.d.ts

@@ -0,0 +1,469 @@
+import type * as CSS_2 from 'csstype';
+
+declare interface Appearance<Props extends Partial<DefaultAppearanceProps> = DefaultAppearanceProps> {
+    theme?: Props['theme'];
+    variables?: PartialSpeKey<Props['variables'], string>;
+    rules?: PartialSpeKey<Props['rules'], CSS_2.Properties<string, number>>;
+    displaySetting?: PartialSpeKey<Props['displaySetting'], boolean>;
+    layout?: Props['layout'];
+}
+
+/**
+ * @description 内置基础的桥接事件映射类型
+ */
+declare interface BaseBridgeEventMap<AppConfig extends Record<string, any> = Record<string, any>, SubmitReplay extends Record<string, any> = Record<string, any>, SubmitParams extends Record<string, any> = Record<string, any>, AppErrorCodes extends string = string, OpenModalConfig extends BaseOpenModalConfig = BaseOpenModalConfig> {
+    error: ErrorPayload<AppErrorCodes>;
+    /* Excluded from this release type: "OPENSDK@HANDSHAKE" */
+    /* Excluded from this release type: "OPENSDK@UPDATE_CONFIG" */
+    /* Excluded from this release type: "OPENSDK@HANDSHAKE_ACK" */
+    /* Excluded from this release type: "OPENSDK@SUBMIT" */
+    /* Excluded from this release type: "OPENSDK@SUBMIT_REPLY" */
+    /* Excluded from this release type: "OPENSDK@OPEN_MODAL" */
+    /* Excluded from this release type: "OPENSDK@OPEN_MODAL_ERROR" */
+    /* Excluded from this release type: "OPENSDK@CLOSE_MODAL" */
+    /* Excluded from this release type: "OPENSDK@REDIRECT" */
+    /* Excluded from this release type: "OPENSDK@TRANSFER_MODAL_PORT" */
+    /* Excluded from this release type: "OPENSDK@TRANSFER_MODAL_APPEARANCE" */
+    /* Excluded from this release type: "OPENSDK@TRANSFER_APP_PORT" */
+    /* Excluded from this release type: "OPENSDK@ERROR" */
+    /* Excluded from this release type: "OPENSDK@TRANSFER_RECEIVE_PORT" */
+    /* Excluded from this release type: "OPENSDK@TRANSFER_SEND_PORT" */
+    /* Excluded from this release type: "OPENSDK@MESSAGE" */
+    /* Excluded from this release type: "OPENSDK@HEIGHT_UPDATE" */
+}
+
+declare interface BaseConfig {
+    /**
+     * @description 透传参数
+     */
+    targetOrigin: string;
+    /**
+     * @description 是否开启debug
+     */
+    debug?: boolean;
+    /**
+     * @description 当前的环境
+     */
+    env: 'sandbox' | 'prod';
+    /**
+     * @description 多语言
+     */
+    locale?: string;
+    /* Excluded from this release type: version */
+}
+
+/**
+ * @description 基础组件/页面
+ */
+declare abstract class BaseElement<Config extends BaseElementConfig = BaseElementConfig, EventMap extends BaseBridgeEventMap<Config['appConfig']> = BaseBridgeEventMap<Config['appConfig']>> {
+    static elementType: string;
+    /* Excluded from this release type: name */
+    /* Excluded from this release type: _elementMode */
+    /* Excluded from this release type: _isMainElement */
+    /* Excluded from this release type: config */
+    /* Excluded from this release type: bridge */
+    /* Excluded from this release type: hooks */
+    /* Excluded from this release type: iframe */
+    status: 'initialized' | 'mounting' | 'mounted' | 'ready' | 'destroyed' | 'unmounted';
+    /* Excluded from this release type: cachedSend */
+    constructor(name: string, config: WithAppURL<Config>);
+    /* Excluded from this release type: submit */
+    /* Excluded from this release type: setup */
+    /**
+     * @param {string | HTMLElement} containerId 如果给字符串id不要带#号
+     */
+    mount(containerId: HTMLElement): Promise<void>;
+    /* Excluded from this release type: _mount */
+    /**
+     * 更新webapp配置
+     * @param {Partial<BaseElementAppConfig>} newConfig
+     */
+    updateConfig(newConfig: Partial<Config['appConfig']>): void;
+    /**
+     * 卸载元素
+     */
+    umount(): void;
+    /* Excluded from this release type: isSingleMode */
+    /**
+     * 监听消息
+     */
+    on<T extends keyof EventMap>(event: T, handler: (payload: EventMap[T]) => void): void;
+    /* Excluded from this release type: send */
+    /* Excluded from this release type: _addPort */
+    /* Excluded from this release type: _transferReceivePort */
+    /* Excluded from this release type: _transferSendPort */
+    /* Excluded from this release type: _submit */
+    destroy(): void;
+    get isMainElement(): boolean;
+    /**
+     * 对于独立的input需要实现
+     */
+    protected abstract focus(): void;
+    /**
+     * 对于独立的input需要实现
+     */
+    protected abstract blur(): void;
+    /**
+     * 对于独立的input需要实现
+     */
+    protected abstract clear(): void;
+    /* Excluded from this release type: _addHook */
+}
+
+declare interface BaseElementAppConfig {
+    locale?: string;
+    /* Excluded from this release type: env */
+    /* Excluded from this release type: merchantId */
+    [key: string]: any;
+}
+
+declare interface BaseElementConfig<T extends BaseElementAppConfig = Record<string, any>> extends BaseConfig {
+    appConfig: T;
+    elementMode: ElementMode;
+}
+
+declare abstract class BaseFactory {
+    /* Excluded from this release type: config */
+    /* Excluded from this release type: isInit */
+    /**
+     * @description 当前版本号
+     * 用于日志上报
+     */
+    version: string;
+    /* Excluded from this release type: elementMode */
+    /* Excluded from this release type: _elements */
+    /* Excluded from this release type: globalBridgeForWebApp */
+    /* Excluded from this release type: globalBridgeForModal */
+    /* Excluded from this release type: openModalHandle */
+    /* Excluded from this release type: elementClasses */
+    /**
+     * @param config 配置
+     */
+    constructor(config: BaseFactoryConfig);
+    protected openModal(payload: BaseBridgeEventMap['OPENSDK@OPEN_MODAL']): Promise<OpenModalHandle>;
+    /* Excluded from this release type: canUseElements */
+    /**
+     * @description 无需手动调用
+     */
+    init(): Promise<this>;
+    /* Excluded from this release type: generateElementKey */
+    /**
+     * @description 更新工厂配置 locale debug env
+     * @param config
+     */
+    updateConfig(config: Partial<BaseFactoryConfig>): void;
+    /**
+     * @description 销毁所有元素实例
+     */
+    destroy(): void;
+    /* Excluded from this release type: _generateElementKey */
+    /**
+     * 创建element实例
+     * @param {string} elementType 类型
+     * @param {BaseElementConfig} options 选项
+     */
+    abstract createElement(elementType: string, options?: BaseElementAppConfig): BaseElement;
+    /**
+     * 获取element实例
+     * @param {string} elementType 类型
+     * @param {BaseElementConfig} options 选项
+     */
+    abstract getElement(elementType: string, options?: BaseElementAppConfig): BaseElement;
+    /* Excluded from this release type: _createElement */
+    /* Excluded from this release type: _addElement */
+    /* Excluded from this release type: _removeElement */
+    /* Excluded from this release type: _getElement */
+    /* Excluded from this release type: _getElementSize */
+}
+
+declare interface BaseFactoryConfig extends BaseConfig {
+    /* Excluded from this release type: trackerCode */
+}
+
+declare interface BaseOpenModalConfig {
+    /**
+     * 无需手动传递，app的唯一scope
+     */
+    scope?: string;
+    /**
+     * @description 是否展示关闭按钮
+     */
+    showClose?: boolean;
+    /**
+     * @description 配合showClose使用，在加载完成后是否隐藏按钮
+     */
+    hideCloseWhenLoaded?: boolean;
+    /**
+     * @description 是否展示loading
+     */
+    showLoading?: boolean;
+    /**
+     * @description 点击关闭按钮时的回调
+     */
+    onClose?: () => void;
+    url: string;
+    /**
+     * 关闭时，是否需要app页面二次确认，默认为false，即直接关闭
+     */
+    closeConfirm?: boolean;
+    appearance?: Appearance;
+}
+
+declare interface DefaultAppearanceProps {
+    theme: string;
+    variables: string;
+    displaySetting: string;
+    layout: string;
+    rules: string;
+}
+
+/**
+ * @description 元素列表项类型
+ */
+declare type ElementListItemType = iBaseElementClass | {
+    ElementClass: iBaseElementClass;
+    config?: Partial<BaseElementConfig>;
+};
+
+declare type ElementMode = 'SINGLE' | 'GROUP';
+
+declare interface ErrorPayload<Code extends string = string> {
+    source: ErrorSource;
+    code: Code;
+    message: string;
+    reason: string;
+    traceId?: string;
+    stack?: string;
+}
+
+declare type ErrorSource = ErrorSource_2;
+
+declare type ErrorSource_2 = 'SDK_INTERNAL' | 'SDK_USAGE' | 'APP_RUNTIME' | 'SERVER_API' | 'SYSTEM';
+
+declare type GetI18nQueryParam = string | {
+    /**
+     * 多语言文案的 key
+     */
+    id: string;
+    /**
+     * 多语言文案的默认值
+     */
+    dm?: string;
+    /**
+     * 多语言文案的默认值，defaultMessage 和 dm 只需要一个就行
+     * 推荐使用 dm
+     * defaultMessage 是为了兼容中后台原来的开发习惯
+     */
+    defaultMessage?: string;
+};
+
+declare type GlobalOptions = {
+    i18n?: SimpleI18n;
+    i18nPrefix: string;
+    getDefaultMessage?: () => string;
+};
+
+declare interface iBaseElementClass {
+    new (name: string, config: BaseElementConfig): BaseElement;
+    elementType: string;
+}
+
+/**
+ * @description OpenModal的返回值类型
+ */
+declare type OpenModalHandle = {
+    destroy: () => void;
+    onLoadedSuccess: (onLoadSuccess: () => void) => void;
+    getContentWindow: () => Window | null;
+};
+
+declare class OpenSDKError<Code extends string = string> extends Error {
+    code: Code | OpenSDKInternalErrorCodes;
+    name: string;
+    /* Excluded from this release type: _openSDKErrorFlag */
+    source: ErrorSource;
+    traceId?: string;
+    /**
+     * @description 用于存储原始错误信息的，给内部调试
+     */
+    reason: string;
+    static isError(error: any): error is OpenSDKError;
+    /**
+     * @description 统一转换error为OpenSDKError
+     */
+    static unificationError(error: unknown, source?: ErrorSource): OpenSDKError;
+    static initConfig(config: Partial<GlobalOptions>): void;
+    constructor(_message: string | {
+        message: string;
+        params?: Record<string, any>;
+    }, code: Code | OpenSDKInternalErrorCodes, source: ErrorSource, _traceId?: string, serverAPIWithoutI18n?: boolean);
+    toJSON(): ErrorPayload<Code | OpenSDKInternalErrorCodes>;
+}
+
+declare const OpenSDKInternalErrorCodes: {
+    /**
+     * @description 未知错误
+     */
+    readonly UNKNOWN_ERROR: "UNKNOWN_ERROR";
+    /**
+     * @description 无端口错误，通常发生在模态通信中，SDK期望接收一个MessagePort但未收到
+     */
+    readonly NO_PORTS_ERROR: "NO_PORTS_ERROR";
+    /**
+     * @description 非法的URL
+     */
+    readonly INVALID_REDIRECT_URL: "INVALID_REDIRECT_URL";
+};
+
+declare type OpenSDKInternalErrorCodes = (typeof OpenSDKInternalErrorCodes)[keyof typeof OpenSDKInternalErrorCodes];
+
+declare type PartialSpeKey<T, V> = Partial<T extends infer K extends string ? Record<K, V> : Record<string, V>>;
+
+declare interface PreLoadConfig {
+    /**
+     * @description 预加载参数，可选配置。
+     * 传入需要使用的 element 类型列表，SDK 将提前加载对应资源以优化性能。
+     * 每个值与 createElement 的 type 参数一致，如 'Onboard'、'Vaulting'。
+     */
+    elements?: string[];
+}
+
+/**
+ * @description 用于收集所有其他元素的值
+ */
+declare class ReceivePort {
+    targetPorts: Array<MessagePort>;
+    name: string;
+    constructor(name: string);
+    addPort(port: readonly MessagePort[]): void;
+    removePort(port: MessagePort): void;
+    getValues(config?: {
+        timeout: number;
+    }): Promise<Record<string, any> | undefined>;
+}
+
+declare interface RedirectOption {
+    url: string;
+    mode?: 'redirect' | 'replace';
+    /**
+     * @description 是否重定向后销毁实例，默认为true
+     */
+    destory?: boolean;
+}
+
+/**
+ * @description 其他元素，用于发送value到主元素
+ */
+declare class SendPort<T extends Record<string, any> = Record<string, any>> {
+    targetPort: MessagePort;
+    name: string;
+    constructor(name: string, port: MessagePort);
+    /**
+     * @description 用于监听发送消息节点
+     */
+    onSendRequest(fn: () => void): void;
+    send(values?: T): void;
+}
+
+declare type SimpleI18n = {
+    get(id: GetI18nQueryParam, variable?: Record<string, any>, localeCode?: string): string;
+};
+
+/**
+ * @description submit return type
+ */
+export declare interface SubmitResult {
+    [key: string]: any;
+}
+
+declare type WithAppURL<T> = T & {
+    appUrl: string;
+    isMainElement: boolean;
+};
+
+/**
+ * @public
+ * @description load config type
+ */
+export declare interface WorldFirstLoadConfig extends Omit<BaseFactoryConfig, 'trackerCode' | 'targetOrigin' | 'version'>, PreLoadConfig {
+}
+
+export declare class WorldFirstSDK extends BaseFactory {
+    /**
+     * SDK 版本号
+     */
+    static version: string;
+    constructor(config: WorldFirstSDKConfig);
+    /**
+     * 实现 BaseFactory 的 canUseElements 抽象方法
+     * 返回工厂可用的元素类列表
+     */
+    protected canUseElements(): Array<ElementListItemType>;
+    /**
+     * 实现 BaseElementsFactory 的 elements 方法
+     * 创建并返回元素集合
+     * 当前用不上该方法
+     */
+    /**
+     * 实现 BaseElementsFactory 的 createElement 方法
+     * 创建单个元素
+     */
+    createElement(type: string, options?: any): any;
+    /**
+     * 实现 BaseElementsFactory 的 getElement 方法
+     * 获取已创建的元素
+     */
+    getElement(type: string, options?: any): any;
+}
+
+/**
+ * @description sdk config type
+ */
+export declare interface WorldFirstSDKConfig extends Omit<BaseFactoryConfig, 'version' | 'targetOrigin'>, PreLoadConfig {
+    version?: string;
+}
+
+/**
+ * @description SDK element events map type
+ */
+export declare type WorldFirstSDKElementEventsMap<AppConfig extends Record<string, any> = Record<string, any>, SubmitParams extends Record<string, any> = Record<string, any>> = BaseBridgeEventMap<AppConfig, SubmitResult, SubmitParams, string /**, OpenModalParams */>;
+
+/**
+ * @description SDK Error
+ */
+export declare class WorldFirstSDKError extends OpenSDKError<WorldFirstSDKErrorCodes> {
+    name: string;
+}
+
+/**
+ * @description SDK error codes
+ */
+declare const WorldFirstSDKErrorCodes: {
+    readonly GENERATE_ELEMENT_KEY_FAILED: "GENERATE_ELEMENT_KEY_FAILED";
+    readonly ELEMENT_INIT_FAILED: "ELEMENT_INIT_FAILED";
+    readonly MOUNT_TIMEOUT: "MOUNT_TIMEOUT";
+    readonly MOUNT_MISSING_CONTAINER: "MOUNT_MISSING_CONTAINER";
+    readonly MOUNT_IFRAME_LOAD_ERROR: "MOUNT_IFRAME_LOAD_ERROR";
+    readonly MOUNT_NOT_MAINELEMENT_WITH_SINGLE_MODE: "MOUNT_NOT_MAINELEMENT_WITH_SINGLE_MODE";
+    readonly MOUNT_NOT_SUPPORT: "MOUNT_NOT_SUPPORT";
+    readonly MOUNT_INITIAL_FAILED: "MOUNT_INITIAL_FAILED";
+    readonly ELEMENT_INSTANCE_DESTROYED: "ELEMENT_INSTANCE_DESTROYED";
+    readonly ELEMENT_DEFINE_ERROR: "ELEMENT_DEFINE_ERROR";
+    readonly ELEMENT_ALREADY_REGISTERED: "ELEMENT_ALREADY_REGISTERED";
+    readonly CANNOT_CREATE_SAME_ELEMENT_TWICE: "CANNOT_CREATE_SAME_ELEMENT_TWICE";
+    readonly GROUPS_ONLY_ONE_MAIN_ELEMENT: "GROUPS_ONLY_ONE_MAIN_ELEMENT";
+    readonly GROUPS_NOT_FOUND_MAIN_ELEMENT: "GROUPS_NOT_FOUND_MAIN_ELEMENT";
+    readonly NOT_SUPPORT_ELEMENT: "NOT_SUPPORT_ELEMENT";
+    readonly NOT_SUPPORT_SUBMIT: "NOT_SUPPORT_SUBMIT";
+    readonly INVALID_MODAL_URL: "INVALID_MODAL_URL";
+    readonly LOAD_DEBUGGER_FAILED: "LOAD_DEBUGGER_FAILED";
+};
+
+declare type WorldFirstSDKErrorCodes = (typeof WorldFirstSDKErrorCodes)[keyof typeof WorldFirstSDKErrorCodes];
+
+/**
+ * @description SDK theme
+ */
+export declare type WorldFirstTheme = 'dark' | 'light';
+
+export { }