@sunbay/checkout-sdk-protocol 0.0.0-stage → 0.0.1

package/dist/index.d.cts

@@ -0,0 +1,488 @@
+/**
+ * 协议公开类型（真源）。
+ *
+ * 这些类型对外公开，供商户侧 SDK（transport/CheckoutInstance/Element）与
+ * checkout 托管侧同步副本共同引用。字段与 checkout 后端现有类型对齐，但
+ * 对外视图（PublicSessionView）**不含** rsaPublicKey 等敏感/内部字段。
+ */
+/**
+ * 交易状态（直接复用 checkout 后端 TxnStatus，不转义）。
+ * - `I` = 未支付 / 已创建（非终态）
+ * - `S` = 成功（终态）
+ * - `F` = 失败（终态）
+ * - `R` = 需跳转 / 处理中（非终态）
+ */
+type TxnStatus = 'I' | 'S' | 'F' | 'R';
+/**
+ * 地址信息（对齐 checkout 后端 AddressInfo 字段）。
+ * 非敏感数据，允许经公共协议传输。
+ */
+interface AddressInfo {
+    country: string;
+    state?: string;
+    city: string;
+    line1: string;
+    line2?: string;
+    postalCode: string;
+    district?: string;
+    firstName?: string;
+    lastName?: string;
+    recipientName?: string;
+    phone?: string;
+}
+/** 首期支持的支付方式。 */
+type PaymentMethod = 'card' | 'applePay' | 'googlePay';
+/**
+ * 公开支付方式视图（对外只暴露 method/type/name/logoUrl，不含内部配置）。
+ */
+interface PublicPaymentMethod {
+    method: string;
+    type: string;
+    name: string;
+    logoUrl: string;
+}
+/** 公开商品行。 */
+interface PublicProductLine {
+    amount: number;
+    name: string;
+    num: string;
+}
+/**
+ * 公开 Session 视图：金额 / 币种 / 商品 / collect 标记 / 可用支付方式 / 商户信息。
+ * **不含** rsaPublicKey 等敏感或内部字段。
+ */
+interface PublicSessionView {
+    sessionId: string;
+    sessionType: string;
+    currency: string;
+    totalAmount: number;
+    productList: PublicProductLine[];
+    taxAmount: number;
+    productAmount: number;
+    description: string;
+    expiresAt: string;
+    collectBillingAddress: boolean;
+    collectShippingAddress: boolean;
+    paymentMethods: PublicPaymentMethod[];
+    merchantName: string;
+    merchantLogoUrl: string;
+    merchantReturnUrl?: string;
+}
+/**
+ * 支付结果四态（spec 8.2）。
+ * `pending` 非终态，消费者不得只接受首条结果。
+ */
+type PaymentOutcome = {
+    status: 'succeeded';
+    operationId: string;
+    txnId: string;
+} | {
+    status: 'failed';
+    operationId: string;
+    txnId?: string;
+    error: CheckoutError;
+} | {
+    status: 'canceled';
+    operationId: string;
+} | {
+    status: 'pending';
+    operationId: string;
+    txnId?: string;
+};
+/** 错误分类（spec 5.4）。 */
+type CheckoutErrorCategory = 'configuration' | 'validation' | 'network' | 'runtime' | 'payment';
+/**
+ * 结构化错误（spec 5.4）。
+ */
+interface CheckoutError {
+    code: string;
+    /** 展示用消息。 */
+    message: string;
+    category: CheckoutErrorCategory;
+    errorId: string;
+    elementId?: string;
+    field?: string;
+    traceId?: string;
+}
+/**
+ * 外观定制（appearance）。首期为开放映射，交由托管侧解释。
+ */
+interface Appearance {
+    theme?: string;
+    variables?: Record<string, string>;
+}
+/**
+ * 支付方式过滤配置（spec 9：只做减法/排序，禁止前端增开）。
+ */
+interface PaymentMethodFilter {
+    /** 要隐藏的支付方式（method 标识）。 */
+    hide?: string[];
+    /** 展示顺序（method 标识）。 */
+    order?: string[];
+}
+/** 可挂载 Element 类型（spec 6）。 */
+type ElementType = 'card' | 'cardNumber' | 'cardExpiry' | 'cardCvc' | 'address' | 'expressCheckout';
+/** card Element 配置（spec 6）。 */
+interface CardElementOptions {
+    showBillingAddress?: boolean;
+    showShippingAddress?: boolean;
+    showPostalCode?: boolean;
+    appearance?: Appearance;
+}
+/** 拆分卡字段配置（spec 6）。 */
+interface CardFieldElementOptions {
+    appearance?: Appearance;
+}
+/** address Element 配置（spec 6）。 */
+interface AddressElementOptions {
+    mode: 'billing' | 'shipping';
+    appearance?: Appearance;
+}
+/** expressCheckout Element 配置（spec 6）。 */
+interface ExpressCheckoutElementOptions {
+    /**
+     * 各钱包开关（商户显式控制）：
+     * - `false`：强制隐藏该钱包；
+     * - `true` 或缺省：自动模式，按后端业务允许 ∩ 环境可用展示。
+     */
+    paymentMethods?: {
+        applePay?: boolean;
+        googlePay?: boolean;
+    };
+    /** 布局约束（首期仅最大列数）。 */
+    layout?: {
+        maxColumns?: number;
+    };
+    /** 按钮主题（按钱包区分）。 */
+    buttonTheme?: {
+        applePay?: string;
+        googlePay?: string;
+    };
+    /** 按钮高度（像素）。 */
+    buttonHeight?: number;
+}
+/**
+ * express 可用钱包视图（spec 6）。
+ * 表示各钱包在当前环境下是否可用，用于 express 可用性事件载荷。
+ */
+interface AvailableWallets {
+    applePay: boolean;
+    googlePay: boolean;
+}
+/** Element 配置联合（按 type 区分）。 */
+type ElementOptions = CardElementOptions | CardFieldElementOptions | AddressElementOptions | ExpressCheckoutElementOptions;
+/** Element 运行状态机（spec 6）。 */
+type ElementStatus = 'created' | 'loading' | 'ready' | 'destroyed' | 'loadError';
+/** action 载荷（spec 8.3；qrCode/showContent 首期预留）。 */
+interface PaymentAction {
+    type: 'qrCode' | 'redirect' | 'showContent';
+    redirectUrl?: string;
+    qrData?: string;
+    content?: string;
+}
+
+/**
+ * 信封与握手契约（spec 5.1，真源）。
+ *
+ * 协议名 `sunbay-checkout`，`major = 1`。与现有 Native Bridge `{v:1,type,...}`
+ * 是不同协议，数字相同不代表兼容。
+ *
+ * `encodeEnvelope`/`decodeEnvelope`：JSON 序列化 + 最小运行时结构校验
+ * （校验 protocol/major/kind/必填字段），非法抛错。解码器**不**校验 request.name
+ * 是否为已知 CommandName —— 未知 name 仍解为 kind==='request'，由调用方拒绝。
+ */
+
+/** 协议名常量。 */
+declare const PROTOCOL_NAME: "sunbay-checkout";
+/** 当前主版本。 */
+declare const PROTOCOL_MAJOR: 1;
+/**
+ * 握手消息（spec 5.1）。main iframe 加载后先广播，此时尚无 checkoutId。
+ */
+type RuntimeHello = {
+    protocol: 'sunbay-checkout';
+    kind: 'hello';
+    runtimeId: string;
+    supportedMajorVersions: number[];
+    /** 首期：['card','splitCard','address','express','paymentMethodFilter']。 */
+    capabilities: string[];
+};
+/**
+ * 初始化后的公共信封（spec 5.1）。
+ */
+type Envelope = {
+    protocol: 'sunbay-checkout';
+    major: 1;
+    runtimeId: string;
+    checkoutId: string;
+    elementId?: string;
+} & ({
+    kind: 'request';
+    requestId: string;
+    name: string;
+    payload: unknown;
+} | {
+    kind: 'response';
+    requestId: string;
+    ok: true;
+    data: unknown;
+} | {
+    kind: 'response';
+    requestId: string;
+    ok: false;
+    error: CheckoutError;
+} | {
+    kind: 'event';
+    eventId: string;
+    name: string;
+    operationId?: string;
+    payload: unknown;
+});
+/** 协议校验失败错误。 */
+declare class EnvelopeDecodeError extends Error {
+    constructor(message: string);
+}
+/**
+ * 将信封序列化为线缆字符串（JSON）。
+ *
+ * @param envelope 待发送的信封
+ * @returns JSON 字符串
+ * @example
+ * const wire = encodeEnvelope({ protocol: 'sunbay-checkout', major: 1, ... });
+ */
+declare function encodeEnvelope(envelope: Envelope): string;
+/**
+ * 解析并最小结构校验信封。非法（缺 protocol、错 major、非法 kind、缺必填字段、
+ * 非 JSON）一律抛 {@link EnvelopeDecodeError}。
+ *
+ * 注意：解码器不校验 request.name 是否为已知命令 —— 未知 name 仍解为
+ * kind==='request'，交由调用方（如 Orchestrator）拒绝。
+ *
+ * @param wire 线缆字符串
+ * @returns 已校验结构的信封
+ * @example
+ * const env = decodeEnvelope(wire);
+ * if (env.kind === 'request') { ... }
+ */
+declare function decodeEnvelope(wire: string): Envelope;
+
+/**
+ * 协议错误码常量（单一真源，spec 5.4）。
+ *
+ * 不提供可能误导重复付款的通用 `retryable` 布尔。
+ * 仅保留实际会被产出的错误码；新增码须同时有产出点。
+ */
+declare const ErrorCode: {
+    readonly INVALID_OPTIONS: "INVALID_OPTIONS";
+    readonly ELEMENT_CONFLICT: "ELEMENT_CONFLICT";
+    readonly INSTANCE_DESTROYED: "INSTANCE_DESTROYED";
+    readonly CHECKOUT_BUSY: "CHECKOUT_BUSY";
+    readonly VALIDATION_ERROR: "VALIDATION_ERROR";
+    readonly SESSION_LOAD_FAILED: "SESSION_LOAD_FAILED";
+    readonly RUNTIME_LOAD_FAILED: "RUNTIME_LOAD_FAILED";
+    readonly PROTOCOL_UNSUPPORTED: "PROTOCOL_UNSUPPORTED";
+    readonly REQUEST_TIMEOUT: "REQUEST_TIMEOUT";
+    readonly PAYMENT_FLOW_ERROR: "PAYMENT_FLOW_ERROR";
+    readonly UNSUPPORTED_CAPABILITY: "UNSUPPORTED_CAPABILITY";
+};
+/** 错误码字面量联合类型。 */
+type ErrorCodeValue = (typeof ErrorCode)[keyof typeof ErrorCode];
+
+/**
+ * 命令契约（商户 SDK → main，spec 5.2 表，真源）。
+ *
+ * 每命令的请求/响应类型在此定义；跨通道只传 JSON 可序列化数据。
+ */
+
+/** 全部命令名（spec 5.2）。 */
+type CommandName = 'initialize' | 'createElement' | 'updateElement' | 'destroyElement' | 'focus' | 'blur' | 'clear' | 'updateCheckout' | 'getSession' | 'refresh' | 'getPaymentStatus' | 'confirm' | 'destroy';
+/** 已知命令名集合（供调用方校验 request.name 是否受支持）。 */
+declare const COMMAND_NAMES: readonly CommandName[];
+/** 判断字符串是否为已知命令名。 */
+declare function isCommandName(name: string): name is CommandName;
+interface InitializeReq {
+    sessionId: string;
+    locale?: string;
+    appearance?: Appearance;
+    paymentMethods?: PaymentMethodFilter;
+}
+interface InitializeResp {
+    capabilities: string[];
+    session: PublicSessionView;
+}
+interface CreateElementReq {
+    elementId: string;
+    type: ElementType;
+    options?: ElementOptions;
+}
+interface CreateElementResp {
+    elementId: string;
+    registered: true;
+}
+interface UpdateElementReq {
+    elementId: string;
+    patch: Partial<ElementOptions>;
+}
+interface UpdateElementResp {
+    elementId: string;
+    options: ElementOptions;
+}
+interface DestroyElementReq {
+    elementId: string;
+}
+interface DestroyElementResp {
+    elementId: string;
+    released: true;
+}
+interface ElementActionReq {
+    elementId: string;
+}
+interface ElementActionResp {
+    elementId: string;
+    done: true;
+}
+interface UpdateCheckoutReq {
+    locale?: string;
+    appearance?: Appearance;
+}
+interface UpdateCheckoutResp {
+    updated: true;
+}
+type GetSessionReq = Record<string, never>;
+type GetSessionResp = PublicSessionView;
+type GetPaymentStatusReq = Record<string, never>;
+interface GetPaymentStatusResp {
+    txnStatus: TxnStatus;
+    txnId?: string;
+}
+interface ConfirmReq {
+    operationId: string;
+    billingAddress?: AddressInfo;
+    shippingAddress?: AddressInfo;
+    customerName?: string;
+    email?: string;
+    returnUrl?: string;
+}
+interface ConfirmResp {
+    accepted: true;
+}
+type DestroyReq = Record<string, never>;
+interface DestroyResp {
+    released: true;
+}
+/** 命令名 → 请求载荷映射。 */
+interface CommandRequestMap {
+    initialize: InitializeReq;
+    createElement: CreateElementReq;
+    updateElement: UpdateElementReq;
+    destroyElement: DestroyElementReq;
+    focus: ElementActionReq;
+    blur: ElementActionReq;
+    clear: ElementActionReq;
+    updateCheckout: UpdateCheckoutReq;
+    getSession: GetSessionReq;
+    refresh: GetSessionReq;
+    getPaymentStatus: GetPaymentStatusReq;
+    confirm: ConfirmReq;
+    destroy: DestroyReq;
+}
+/** 命令名 → 成功响应载荷映射。 */
+interface CommandResponseMap {
+    initialize: InitializeResp;
+    createElement: CreateElementResp;
+    updateElement: UpdateElementResp;
+    destroyElement: DestroyElementResp;
+    focus: ElementActionResp;
+    blur: ElementActionResp;
+    clear: ElementActionResp;
+    updateCheckout: UpdateCheckoutResp;
+    getSession: GetSessionResp;
+    refresh: GetSessionResp;
+    getPaymentStatus: GetPaymentStatusResp;
+    confirm: ConfirmResp;
+    destroy: DestroyResp;
+}
+
+/**
+ * 事件契约（main → 商户 SDK，spec 5.3 表，真源）。
+ *
+ * 公开事件仅暴露 empty/complete/brand/error 等允许状态，**绝不含卡值**，
+ * 不提供卡数据 getValue。`on` 注册后不重放历史事件。
+ */
+
+/** 全部事件名（spec 5.3）。 */
+type EventName = 'ready' | 'change' | 'focus' | 'blur' | 'loadError' | 'elementReady' | 'availablePaymentMethodsChange' | 'expressAvailabilityChange' | 'paymentStateChange' | 'paymentResult' | 'error';
+/** 已知事件名集合。 */
+declare const EVENT_NAMES: readonly EventName[];
+/** 判断字符串是否为已知事件名。 */
+declare function isEventName(name: string): name is EventName;
+interface ReadyEvent {
+    elementId: string;
+}
+interface ElementReadyEvent {
+    elementId: string;
+    /** 仅 expressCheckout Element ready 时携带：各钱包可用性。 */
+    availableWallets?: AvailableWallets;
+}
+interface ChangeEvent {
+    elementId: string;
+    empty: boolean;
+    complete: boolean;
+    error?: CheckoutError;
+    /** 仅卡号字段允许携带 brand；绝不含卡值。 */
+    brand?: string;
+}
+interface FocusEvent {
+    elementId: string;
+}
+interface BlurEvent {
+    elementId: string;
+}
+interface LoadErrorEvent {
+    elementId: string;
+    error: CheckoutError;
+}
+interface AvailablePaymentMethodsChangeEvent {
+    availablePaymentMethods: PublicPaymentMethod[];
+}
+/**
+ * express 可用钱包变化事件（spec 6）。
+ * 专用于 expressCheckout：以 AvailableWallets 表达各钱包可用性，
+ * 与 AvailablePaymentMethodsChangeEvent（PublicPaymentMethod[]）并存，互不破坏。
+ */
+interface ExpressAvailabilityChangeEvent {
+    availableWallets: AvailableWallets;
+}
+interface PaymentStateChangeEvent {
+    operationId: string;
+    method: PaymentMethod;
+    /** 过程状态；requiresAction 时携带 action 信息。 */
+    state: string;
+    action?: PaymentAction;
+}
+interface PaymentResultEvent {
+    operationId: string;
+    method: PaymentMethod;
+    outcome: PaymentOutcome;
+}
+interface ErrorEvent {
+    /** 异步主动流程错误；可含 operationId（如已创建）。 */
+    operationId?: string;
+    error: CheckoutError;
+}
+/** 事件名 → 载荷映射。 */
+interface EventPayloadMap {
+    ready: ReadyEvent;
+    change: ChangeEvent;
+    focus: FocusEvent;
+    blur: BlurEvent;
+    loadError: LoadErrorEvent;
+    elementReady: ElementReadyEvent;
+    availablePaymentMethodsChange: AvailablePaymentMethodsChangeEvent;
+    expressAvailabilityChange: ExpressAvailabilityChangeEvent;
+    paymentStateChange: PaymentStateChangeEvent;
+    paymentResult: PaymentResultEvent;
+    error: ErrorEvent;
+}
+
+export { type AddressElementOptions, type AddressInfo, type Appearance, type AvailablePaymentMethodsChangeEvent, type AvailableWallets, type BlurEvent, COMMAND_NAMES, type CardElementOptions, type CardFieldElementOptions, type ChangeEvent, type CheckoutError, type CheckoutErrorCategory, type CommandName, type CommandRequestMap, type CommandResponseMap, type ConfirmReq, type ConfirmResp, type CreateElementReq, type CreateElementResp, type DestroyElementReq, type DestroyElementResp, type DestroyReq, type DestroyResp, EVENT_NAMES, type ElementActionReq, type ElementActionResp, type ElementOptions, type ElementReadyEvent, type ElementStatus, type ElementType, type Envelope, EnvelopeDecodeError, ErrorCode, type ErrorCodeValue, type ErrorEvent, type EventName, type EventPayloadMap, type ExpressAvailabilityChangeEvent, type ExpressCheckoutElementOptions, type FocusEvent, type GetPaymentStatusReq, type GetPaymentStatusResp, type GetSessionReq, type GetSessionResp, type InitializeReq, type InitializeResp, type LoadErrorEvent, PROTOCOL_MAJOR, PROTOCOL_NAME, type PaymentAction, type PaymentMethod, type PaymentMethodFilter, type PaymentOutcome, type PaymentResultEvent, type PaymentStateChangeEvent, type PublicPaymentMethod, type PublicProductLine, type PublicSessionView, type ReadyEvent, type RuntimeHello, type TxnStatus, type UpdateCheckoutReq, type UpdateCheckoutResp, type UpdateElementReq, type UpdateElementResp, decodeEnvelope, encodeEnvelope, isCommandName, isEventName };