@paydock/client-sdk 1.139.0 → 1.140.0-beta

package/bundles/types/open-wallets/base/open-wallet.service.d.ts

@@ -1,27 +1,85 @@
-import type { SERVICE_TYPES } from 'src/api/api-service-internal';
 import type { ApiInternal } from '../../api/api-internal';
+import type { SERVICE_TYPES } from '../../api/api-service-internal';
 import type { Container } from '../../components/container';
 import type { EventEmitter } from '../../helper/event-emitter';
+import { ERROR_OPERATION } from '../enum/error-operation.enum';
 import { SERVICE_GROUP } from '../enum/service-group.enum';
-import type { WalletPaymentSource } from '../interfaces';
+import type { IOpenWalletProvider, OpenWalletMeta } from '../interfaces';
 import type { CreateOTTData, CreateOTTResponse, WalletType } from '../types';
 import type { OnShippingAddressChangeEventData } from '../types/on-shipping-address-change-event-data.interface';
 import type { OnShippingOptionChangeEventData } from '../types/on-shipping-option-change-event-data.interface';
 import type { ShippingEventToResponse } from '../types/shipping-event-to-response.type';
-export declare abstract class OpenWalletService implements WalletPaymentSource {
+/**
+ * Abstract base class for wallet-specific OpenWallet service implementations.
+ *
+ * Provides shared functionality for OTT creation, shipping event handling,
+ * error/unavailable emission, and DOM cleanup. Concrete implementations
+ * (e.g. Apple Pay, Google Pay) extend this class and implement {@link load} and {@link setMeta}.
+ *
+ * @implements {IOpenWalletProvider}
+ */
+export declare abstract class OpenWalletService implements IOpenWalletProvider {
     protected api: ApiInternal;
     protected eventEmitter: EventEmitter;
     protected walletType: WalletType;
     protected serviceId: string;
     protected container: Container;
     protected serviceType: SERVICE_TYPES;
+    /** The service group identifier used in OTT creation requests. */
     protected readonly serviceGroup = SERVICE_GROUP.WALLET;
+    /**
+     * @param api - API client for backend communication.
+     * @param eventEmitter - Shared event emitter for wallet lifecycle events.
+     * @param walletType - The wallet type identifier (e.g. `'apple'`, `'google'`).
+     * @param serviceId - The service ID for the wallet configuration.
+     * @param container - The DOM container that holds the wallet button.
+     * @param serviceType - The service type from the API configuration.
+     */
     constructor(api: ApiInternal, eventEmitter: EventEmitter, walletType: WalletType, serviceId: string, container: Container, serviceType: SERVICE_TYPES);
+    /**
+     * Loads and renders the wallet button. Must be implemented by each wallet service.
+     */
     abstract load(): Promise<void>;
+    /**
+     * Updates the wallet metadata. Must be implemented by each wallet service.
+     *
+     * @param meta - The updated metadata.
+     */
+    abstract setMeta(meta: OpenWalletMeta): void;
+    /**
+     * Creates a One-Time Token (OTT) by sending the payment data to the API.
+     * Emits {@link EVENT.SUCCESS} on success or {@link EVENT.ERROR} on failure.
+     *
+     * @param data - The payment data including amount, shipping, billing, card info, and ref token.
+     * @returns A promise resolving to the OTT response.
+     */
     protected createOTT(data: CreateOTTData): Promise<CreateOTTResponse>;
+    /**
+     * Delegates a shipping change event to the merchant's registered handler
+     * and returns the merchant's response.
+     *
+     * @param eventData - The shipping address or option change event data.
+     * @returns A promise resolving to the merchant's shipping update response.
+     * @throws {Error} If no handler is registered or the handler returns no result.
+     */
     protected handleMerchantOnShippingChangedEvent<T extends OnShippingAddressChangeEventData | OnShippingOptionChangeEventData>(eventData: T): Promise<ShippingEventToResponse<T>>;
+    /**
+     * Emits the {@link EVENT.UNAVAILABLE} event when the wallet is not available.
+     *
+     * @param reason - A human-readable description of why the wallet is unavailable.
+     */
     protected handleOnUnavailable(reason?: string): void;
-    protected handleOnError(error: Error): void;
+    /**
+     * Emits the {@link EVENT.ERROR} event and logs the error to the console.
+     *
+     * @param error - The error that occurred.
+     * @param operation - The operation that failed. Defaults to {@link ERROR_OPERATION.WALLET_OPERATION}.
+     */
+    protected handleOnError(error: Error, operation?: ERROR_OPERATION): void;
+    /**
+     * Removes the wallet button element from the DOM.
+     * Call this to clean up resources when the button is no longer needed.
+     */
     destroy(): void;
 }
 //# sourceMappingURL=open-wallet.service.d.ts.map

package/bundles/types/open-wallets/base/open-wallet.service.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"open-wallet.service.d.ts","sourceRoot":"","sources":["../../../src/open-wallets/base/open-wallet.service.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,8BAA8B,CAAC;AAClE,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AAC1D,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,4BAA4B,CAAC;AAC5D,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,4BAA4B,CAAC;AAG/D,OAAO,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAC;AAC3D,OAAO,KAAK,EAKV,mBAAmB,EACpB,MAAM,eAAe,CAAC;AACvB,OAAO,KAAK,EACV,aAAa,EAEb,iBAAiB,EACjB,UAAU,EACX,MAAM,UAAU,CAAC;AAClB,OAAO,KAAK,EAAE,gCAAgC,EAAE,MAAM,0DAA0D,CAAC;AACjH,OAAO,KAAK,EAAE,+BAA+B,EAAE,MAAM,yDAAyD,CAAC;AAC/G,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,0CAA0C,CAAC;AAExF,8BAAsB,iBAAkB,YAAW,mBAAmB;IAIlE,SAAS,CAAC,GAAG,EAAE,WAAW;IAC1B,SAAS,CAAC,YAAY,EAAE,YAAY;IACpC,SAAS,CAAC,UAAU,EAAE,UAAU;IAChC,SAAS,CAAC,SAAS,EAAE,MAAM;IAC3B,SAAS,CAAC,SAAS,EAAE,SAAS;IAC9B,SAAS,CAAC,WAAW,EAAE,aAAa;IARtC,SAAS,CAAC,QAAQ,CAAC,YAAY,wBAAwB;gBAG3C,GAAG,EAAE,WAAW,EAChB,YAAY,EAAE,YAAY,EAC1B,UAAU,EAAE,UAAU,EACtB,SAAS,EAAE,MAAM,EACjB,SAAS,EAAE,SAAS,EACpB,WAAW,EAAE,aAAa;IAGtC,QAAQ,CAAC,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IAE9B,SAAS,CAAC,SAAS,CAAC,IAAI,EAAE,aAAa,GAAG,OAAO,CAAC,iBAAiB,CAAC;cAqCpD,oCAAoC,CAClD,CAAC,SAAS,gCAAgC,GAAG,+BAA+B,EAC5E,SAAS,EAAE,CAAC,GAAG,OAAO,CAAC,uBAAuB,CAAC,CAAC,CAAC,CAAC;IAcpD,SAAS,CAAC,mBAAmB,CAAC,MAAM,SAAyB,GAAG,IAAI;IAYpE,SAAS,CAAC,aAAa,CAAC,KAAK,EAAE,KAAK,GAAG,IAAI;IAgBpC,OAAO,IAAI,IAAI;CAMvB"}
+{"version":3,"file":"open-wallet.service.d.ts","sourceRoot":"","sources":["../../../src/open-wallets/base/open-wallet.service.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AAC1D,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,gCAAgC,CAAC;AACpE,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,4BAA4B,CAAC;AAC5D,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,4BAA4B,CAAC;AAC/D,OAAO,EAAE,eAAe,EAAE,MAAM,8BAA8B,CAAC;AAG/D,OAAO,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAC;AAC3D,OAAO,KAAK,EACV,mBAAmB,EAKnB,cAAc,EACf,MAAM,eAAe,CAAC;AACvB,OAAO,KAAK,EACV,aAAa,EAEb,iBAAiB,EACjB,UAAU,EACX,MAAM,UAAU,CAAC;AAClB,OAAO,KAAK,EAAE,gCAAgC,EAAE,MAAM,0DAA0D,CAAC;AACjH,OAAO,KAAK,EAAE,+BAA+B,EAAE,MAAM,yDAAyD,CAAC;AAC/G,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,0CAA0C,CAAC;AA0BxF;;;;;;;;GAQG;AACH,8BAAsB,iBAAkB,YAAW,mBAAmB;IAalE,SAAS,CAAC,GAAG,EAAE,WAAW;IAC1B,SAAS,CAAC,YAAY,EAAE,YAAY;IACpC,SAAS,CAAC,UAAU,EAAE,UAAU;IAChC,SAAS,CAAC,SAAS,EAAE,MAAM;IAC3B,SAAS,CAAC,SAAS,EAAE,SAAS;IAC9B,SAAS,CAAC,WAAW,EAAE,aAAa;IAjBtC,kEAAkE;IAClE,SAAS,CAAC,QAAQ,CAAC,YAAY,wBAAwB;IAEvD;;;;;;;OAOG;gBAES,GAAG,EAAE,WAAW,EAChB,YAAY,EAAE,YAAY,EAC1B,UAAU,EAAE,UAAU,EACtB,SAAS,EAAE,MAAM,EACjB,SAAS,EAAE,SAAS,EACpB,WAAW,EAAE,aAAa;IAGtC;;OAEG;IACH,QAAQ,CAAC,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IAE9B;;;;OAIG;IACH,QAAQ,CAAC,OAAO,CAAC,IAAI,EAAE,cAAc,GAAG,IAAI;IAE5C;;;;;;OAMG;IACH,SAAS,CAAC,SAAS,CAAC,IAAI,EAAE,aAAa,GAAG,OAAO,CAAC,iBAAiB,CAAC;IA2CpE;;;;;;;OAOG;cACa,oCAAoC,CAClD,CAAC,SAAS,gCAAgC,GAAG,+BAA+B,EAC5E,SAAS,EAAE,CAAC,GAAG,OAAO,CAAC,uBAAuB,CAAC,CAAC,CAAC,CAAC;IAcpD;;;;OAIG;IACH,SAAS,CAAC,mBAAmB,CAAC,MAAM,SAAyB,GAAG,IAAI;IAcpE;;;;;OAKG;IACH,SAAS,CAAC,aAAa,CACrB,KAAK,EAAE,KAAK,EACZ,SAAS,GAAE,eAAkD,GAC5D,IAAI;IAkBP;;;OAGG;IACI,OAAO,IAAI,IAAI;CAMvB"}

package/bundles/types/open-wallets/enum/error-operation.enum.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Operations that can fail during the wallet lifecycle.
+ * Used in {@link OnErrorPayload.context.operation} to identify what failed.
+ */
+export declare enum ERROR_OPERATION {
+    /** General wallet lifecycle operation. */
+    WALLET_OPERATION = "wallet_operation",
+    /** Loading or validating the wallet service configuration. */
+    CONFIGURATION = "configuration",
+    /** A required event handler was not registered before calling load(). */
+    HANDLER_REGISTRATION = "handler_registration",
+    /** Processing a shipping address or shipping option update. */
+    SHIPPING_UPDATE = "shipping_update"
+}
+//# sourceMappingURL=error-operation.enum.d.ts.map

package/bundles/types/open-wallets/enum/error-operation.enum.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"error-operation.enum.d.ts","sourceRoot":"","sources":["../../../src/open-wallets/enum/error-operation.enum.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,oBAAY,eAAe;IACzB,0CAA0C;IAC1C,gBAAgB,qBAAqB;IACrC,8DAA8D;IAC9D,aAAa,kBAAkB;IAC/B,yEAAyE;IACzE,oBAAoB,yBAAyB;IAC7C,+DAA+D;IAC/D,eAAe,oBAAoB;CACpC"}

package/bundles/types/open-wallets/enum/event.enum.d.ts

@@ -1,14 +1,22 @@
+/**
+ * Events emitted during the OpenWallet payment lifecycle.
+ */
 export declare enum EVENT {
-    ON_UPDATE = "onUpdate",
+    /** Emitted when the wallet button is clicked by the user. */
     ON_CLICK = "onClick",
-    ON_CHECKOUT_CLOSE = "onCheckoutClose",
+    /** Emitted when the OTT (One-Time Token) creation succeeds. */
     SUCCESS = "success",
+    /** Emitted when the wallet is not available on the current device/browser. */
     UNAVAILABLE = "unavailable",
+    /** Emitted when an error occurs during wallet operation. */
     ERROR = "error",
-    UPDATE = "update",
+    /** Emitted when the wallet button has been loaded and rendered in the DOM. */
     LOADED = "loaded",
+    /** Emitted when the wallet checkout is closed/cancelled by the user (internal). */
     CHECKOUT_CLOSE = "checkoutClose",
+    /** Emitted when the customer selects or updates their shipping address. */
     ON_SHIPPING_ADDRESS_CHANGE = "onShippingAddressChange",
+    /** Emitted when the customer selects a shipping option. */
     ON_SHIPPING_OPTIONS_CHANGE = "onShippingOptionsChange"
 }
 export type OpenWalletEventType = EVENT;

package/bundles/types/open-wallets/enum/event.enum.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"event.enum.d.ts","sourceRoot":"","sources":["../../../src/open-wallets/enum/event.enum.ts"],"names":[],"mappings":"AAAA,oBAAY,KAAK;IACf,SAAS,aAAa;IACtB,QAAQ,YAAY;IACpB,iBAAiB,oBAAoB;IACrC,OAAO,YAAY;IACnB,WAAW,gBAAgB;IAC3B,KAAK,UAAU;IACf,MAAM,WAAW;IACjB,MAAM,WAAW;IACjB,cAAc,kBAAkB;IAChC,0BAA0B,4BAA4B;IACtD,0BAA0B,4BAA4B;CACvD;AAED,MAAM,MAAM,mBAAmB,GAAG,KAAK,CAAC"}
+{"version":3,"file":"event.enum.d.ts","sourceRoot":"","sources":["../../../src/open-wallets/enum/event.enum.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,oBAAY,KAAK;IACf,6DAA6D;IAC7D,QAAQ,YAAY;IACpB,+DAA+D;IAC/D,OAAO,YAAY;IACnB,8EAA8E;IAC9E,WAAW,gBAAgB;IAC3B,4DAA4D;IAC5D,KAAK,UAAU;IACf,8EAA8E;IAC9E,MAAM,WAAW;IACjB,mFAAmF;IACnF,cAAc,kBAAkB;IAChC,2EAA2E;IAC3E,0BAA0B,4BAA4B;IACtD,2DAA2D;IAC3D,0BAA0B,4BAA4B;CACvD;AAED,MAAM,MAAM,mBAAmB,GAAG,KAAK,CAAC"}

package/bundles/types/open-wallets/enum/token-type.enum.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Token types returned in the OTT (One-Time Token) creation response.
+ */
+export declare enum TOKEN_TYPE {
+    /** FPAN - Funding Primary Account Number (Google Pay only). */
+    CARD = "card",
+    /** DPAN - Device Primary Account Number (Apple Pay & Google Pay). */
+    CARD_SCHEME_TOKEN = "card_scheme_token"
+}
+//# sourceMappingURL=token-type.enum.d.ts.map

package/bundles/types/open-wallets/enum/token-type.enum.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"token-type.enum.d.ts","sourceRoot":"","sources":["../../../src/open-wallets/enum/token-type.enum.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,oBAAY,UAAU;IACpB,+DAA+D;IAC/D,IAAI,SAAS;IACb,qEAAqE;IACrE,iBAAiB,sBAAsB;CACxC"}

package/bundles/types/open-wallets/google-pay-open-wallet-button.d.ts

@@ -0,0 +1,65 @@
+import { type GetConfigResponse } from '../api/api-service-internal';
+import type { OpenWalletService } from './base/open-wallet.service';
+import { OpenWalletButtons } from './base/open-wallet-buttons';
+import type { GooglePayOpenWalletMeta } from './interfaces/google-pay';
+import type { WalletType } from './types';
+/**
+ * @classdesc Google Pay wallet button that creates One-Time Tokens (OTT) via Google Pay.
+ *
+ * Provides a fully typed Google Pay integration with Google Pay-specific metadata
+ * and validates that the service configuration corresponds to a Google Pay service.
+ * On `load()`, the button fetches the service configuration and raises an error via `onError`
+ * if the service type does not match Google Pay.
+ *
+ * @class GooglePayOpenWalletButton
+ * @extends OpenWalletButtons
+ *
+ * @param {string} selector - CSS selector of the HTML element that will contain the Google Pay button.
+ * @param {string} publicKeyOrAccessToken - Public key or access token for API authentication.
+ * @param {string} serviceId - The Google Pay service ID configured in PayDock dashboard.
+ * @param {GooglePayOpenWalletMeta} meta - Google Pay-specific metadata (amount, currency, country, card_config, merchant_name, style, etc.).
+ *
+ * @example
+ * const button = new GooglePayOpenWalletButton(
+ *   '#wallet-container',
+ *   publicKeyOrAccessToken,
+ *   serviceId,
+ *   {
+ *     amount: 100,
+ *     currency: 'AUD',
+ *     country: 'AU',
+ *     merchant_name: 'Your Store',
+ *   },
+ * );
+ * button.setEnv('sandbox');
+ * button.onSuccess((data) => console.log('OTT:', data.token));
+ * button.onError((error) => console.error('Error:', error));
+ * button.load();
+ */
+export declare class GooglePayOpenWalletButton extends OpenWalletButtons<GooglePayOpenWalletMeta> {
+    /** @private */
+    readonly walletType: WalletType;
+    /**
+     * Validates Google Pay-specific required metadata fields.
+     * Google Pay has no additional required fields beyond the base (amount, currency, country).
+     * @private
+     */
+    protected validateWalletMeta(): void;
+    /**
+     * Validates that the service configuration type is Google Pay.
+     *
+     * @private
+     * @param serviceConfig - The service configuration response from the API.
+     * @throws {Error} If the service type is not Google Pay.
+     */
+    protected validateServiceType(serviceConfig: GetConfigResponse): void;
+    /**
+     * Creates a Google Pay wallet service instance.
+     *
+     * @private
+     * @param serviceConfig - The service configuration response from the API.
+     * @returns The Google Pay wallet service instance.
+     */
+    protected createWalletService(serviceConfig: GetConfigResponse): OpenWalletService;
+}
+//# sourceMappingURL=google-pay-open-wallet-button.d.ts.map

package/bundles/types/open-wallets/google-pay-open-wallet-button.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"google-pay-open-wallet-button.d.ts","sourceRoot":"","sources":["../../src/open-wallets/google-pay-open-wallet-button.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,iBAAiB,EAEvB,MAAM,6BAA6B,CAAC;AACrC,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,4BAA4B,CAAC;AACpE,OAAO,EAAE,iBAAiB,EAAE,MAAM,4BAA4B,CAAC;AAC/D,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,yBAAyB,CAAC;AAEvE,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,SAAS,CAAC;AAG1C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG;AACH,qBAAa,yBAA0B,SAAQ,iBAAiB,CAAC,uBAAuB,CAAC;IACvF,eAAe;IACf,SAAgB,UAAU,EAAE,UAAU,CAA2B;IAEjE;;;;OAIG;IACH,SAAS,CAAC,kBAAkB,IAAI,IAAI;IAMpC;;;;;;OAMG;IACH,SAAS,CAAC,mBAAmB,CAAC,aAAa,EAAE,iBAAiB,GAAG,IAAI;IASrE;;;;;;OAMG;IACH,SAAS,CAAC,mBAAmB,CAAC,aAAa,EAAE,iBAAiB,GAAG,iBAAiB;CAUnF"}

package/bundles/types/open-wallets/index.d.ts

@@ -1,6 +1,299 @@
+export { ApplePayOpenWalletButton } from './apple-pay-open-wallet-button';
 export { OpenWalletButtons } from './base/open-wallet-buttons';
+export { ERROR_OPERATION } from './enum/error-operation.enum';
 export { EVENT, type OpenWalletEventType } from './enum/event.enum';
+export { TOKEN_TYPE } from './enum/token-type.enum';
+export { GooglePayOpenWalletButton } from './google-pay-open-wallet-button';
 export type * from './interfaces';
 export type * from './types';
 export { WALLET_TYPES } from './types/wallet-type.type';
+/**
+ * Interface for Apple Pay-specific metadata.
+ *
+ * For further information about ApplePay Capabilities refer to [the documentation](https://developer.apple.com/documentation/apple_pay_on_the_web/applepaysession/4440085-applepaycapabilities).
+ * Apple will determine if the device has an ApplePay wallet available and at least one active payment.
+ *
+ * @interface ApplePayOpenWalletMeta
+ *
+ * @type {object}
+ * @param {number} amount - The payment amount.
+ * @param {string} currency - The ISO 4217 currency code.
+ * @param {string} country - The ISO 3166-1 alpha-2 country code.
+ * @param {string} amount_label - Label shown next to the total amount (e.g. `'TOTAL'`). Used in the Apple Pay payment sheet.
+ * @param {boolean} [request_shipping] - Enable shipping address collection in the Apple Pay sheet.
+ * @param {IApplePayShippingOption[]} [shipping_options] - Array of available shipping options. The first item is used as the default selected option. Requires `request_shipping` to be `true`.
+ * @param {boolean} [show_billing_address] - Show billing address fields in the Apple Pay sheet.
+ * @param {string} store_name - The merchant's store name displayed during payment.
+ * @param {Array<'credentials_available' | 'credentials_status_unknown' | 'credentials_unavailable'>} [apple_pay_capabilities] - Device capabilities needed for the wallet button to be available.
+ * @param {Array<'supports3DS' | 'supportsEMV' | 'supportsCredit' | 'supportsDebit'>} [merchant_capabilities] - Array of merchant capabilities influencing the transaction processing features available.
+ * @param {Array<'visa' | 'masterCard' | 'amex' | 'chinaUnionPay' | 'discover' | 'interac' | 'jcb' | 'privateLabel'>} [supported_networks] - List of payment networks supported for Apple Pay transactions.
+ * @param {Array<'email' | 'name' | 'phone' | 'postalAddress'>} [required_billing_contact_fields] - Contact fields required from the user for billing purposes. Phone and email are currently not returned by Apple.
+ * @param {Array<'email' | 'phone' | 'postalAddress' | 'name'>} [required_shipping_contact_fields] - Shipping contact fields required to complete the transaction. Include `'postalAddress'` to show address fields in the Apple Pay sheet. Required handling of onShippingAddressChange callback.
+ * @param {string[]} [supported_countries] - List of countries where Apple Pay is supported by the merchant.
+ * @param {'available' | 'store_pickup'} [shipping_editing_mode] - `'available'` for editable shipping, `'store_pickup'` for non-editable.
+ * @param {object} [style] - Styling configuration for the Apple Pay button.
+ * @param {ApplePayButtonType} [style.button_type] - The type of Apple Pay button (e.g. `'buy'`, `'donate'`, `'plain'`).
+ * @param {ApplePayButtonStyle} [style.button_style] - The style of the Apple Pay button (`'black'`, `'white'`, `'white-outline'`).
+ **/
+/**
+ * Interface for Google Pay-specific metadata.
+ *
+ * @interface GooglePayOpenWalletMeta
+ *
+ * @type {object}
+ * @param {number} amount - The payment amount.
+ * @param {string} currency - The ISO 4217 currency code.
+ * @param {string} country - The ISO 3166-1 alpha-2 country code.
+ * @param {string} [amount_label] - Label shown next to the total amount.
+ * @param {string} [merchant_name] - Display name for the merchant in the Google Pay sheet.
+ * @param {boolean} [request_shipping] - Enable shipping address collection.
+ * @param {IGooglePayShippingOption[]} [shipping_options] - Array of available shipping options. The first item is used as the default selected option. Requires `request_shipping` to be `true`.
+ * @param {boolean} [show_billing_address] - Show billing address fields.
+ * @param {object} [card_config] - Google Pay card configuration for custom auth methods, card networks, and tokenization.
+ * @param {object} [style] - Styling configuration for the Google Pay button.
+ * @param {GooglePayButtonType} [style.button_type] - The type of Google Pay button (`'book'`, `'buy'`, `'checkout'`, `'donate'`, `'order'`, `'pay'`, `'plain'`, `'subscribe'`).
+ * @param {GooglePayButtonColor} [style.button_color] - The color of the Google Pay button (`'default'`, `'black'`, `'white'`).
+ * @param {GooglePayButtonSizeMode} [style.button_size_mode] - The size mode (`'static'`, `'fill'`).
+ **/
+/**
+ * Interface for OnClickEventData.
+ * Emitted when the wallet button is clicked.
+ *
+ * The merchant's `onClick` handler controls the payment flow via its return value:
+ * - Return `void` / `undefined` to continue normally.
+ * - Return `false` to abort the payment flow.
+ * - Return a `Promise<void>` to defer the wallet sheet until the promise resolves.
+ * - Return a `Promise<boolean>` — if it resolves to `false`, the flow is aborted.
+ * - Throwing an error (sync or async) also aborts the flow.
+ *
+ * @interface OnClickEventData
+ *
+ * @type {object}
+ * @param {string} event - Always `'onClick'`.
+ **/
+/**
+ * Interface for OnCreateOTTSuccessfulEventData.
+ * Emitted when the One-Time Token is successfully created.
+ * @interface OnCreateOTTSuccessfulEventData
+ *
+ * @type {object}
+ * @param {string} event - Always `'success'`.
+ * @param {object} [data] - OTT success payload.
+ * @param {object} data.token - The created OTT response.
+ * @param {string} data.token.temp_token - The temporary one-time token string.
+ * @param {TOKEN_TYPE} data.token.token_type - The type of the token. `TOKEN_TYPE.CARD` for FPAN (Google Pay only), `TOKEN_TYPE.CARD_SCHEME_TOKEN` for DPAN (Apple Pay & Google Pay).
+ * @param {number} data.amount - The payment amount.
+ * @param {object} [data.shipping] - The shipping address and contact information, if provided.
+ * @param {string} [data.shipping.method] - The shipping method.
+ * @param {Array<IApplePayShippingOption | IGooglePayShippingOption>} [data.shipping.options] - The selected shipping options.
+ * @param {string} [data.shipping.address_line1] - Shipping address line 1.
+ * @param {string} [data.shipping.address_line2] - Shipping address line 2.
+ * @param {string} [data.shipping.address_city] - Shipping address city.
+ * @param {string} [data.shipping.address_postcode] - Shipping address postal code.
+ * @param {string} [data.shipping.address_state] - Shipping address state or province.
+ * @param {string} [data.shipping.address_country] - Shipping address country code.
+ * @param {string} [data.shipping.address_company] - Shipping company name.
+ * @param {string} [data.shipping.address_origin_postcode] - Origin postal code.
+ * @param {object} [data.shipping.contact] - Shipping contact information.
+ * @param {string} [data.shipping.contact.first_name] - Contact first name.
+ * @param {string} [data.shipping.contact.last_name] - Contact last name.
+ * @param {string} [data.shipping.contact.email] - Contact email address.
+ * @param {string} [data.shipping.contact.phone] - Contact phone number.
+ * @param {string} [data.shipping.contact.phone2] - Contact secondary phone number.
+ * @param {object} [data.billing] - The billing address, if provided.
+ * @param {string} data.billing.address_line1 - Billing address line 1.
+ * @param {string} data.billing.address_line2 - Billing address line 2.
+ * @param {string} data.billing.address_country - Billing address country code.
+ * @param {string} data.billing.address_city - Billing address city.
+ * @param {string} data.billing.address_postcode - Billing address postal code.
+ * @param {string} data.billing.address_state - Billing address state or province.
+ **/
+/**
+ * Interface for OnCreateOTTErrorEventData.
+ * Emitted when OTT creation fails. The error details are in the `data` payload.
+ * @interface OnCreateOTTErrorEventData
+ *
+ * @type {object}
+ * @param {string} event - Always `'error'`.
+ * @param {object} [data] - Error details payload.
+ * @param {string} [data.message] - Error message.
+ * @param {string} [data.code] - Error code.
+ **/
+/**
+ * Interface for OnUnavailableEventData.
+ * Emitted when the wallet is not available on the current device or browser.
+ * @interface OnUnavailableEventData
+ *
+ * @type {object}
+ * @param {string} event - Always `'unavailable'`.
+ * @param {object} [data] - Unavailability details payload.
+ * @param {string} data.reason - A human-readable reason why the wallet is unavailable.
+ * @param {object} [data.details] - Additional details about the unavailability.
+ * @param {string} data.details.service_id - The service ID that was checked.
+ **/
+/**
+ * Interface for OnErrorEventData.
+ * Emitted when an error occurs during wallet operation, including configuration issues, service type mismatches, and OTT creation failures.
+ * @interface OnErrorEventData
+ *
+ * @type {object}
+ * @param {string} event - Always `'error'`.
+ * @param {object} [data] - Error payload.
+ * @param {Error} data.error - The Error object describing what went wrong.
+ * @param {object} [data.context] - Context about the error.
+ * @param {ERROR_OPERATION} [data.context.operation] - The operation that failed. See {@link ERROR_OPERATION} enum for possible values.
+ **/
+/**
+ * Interface for OnLoadedEventData.
+ * Emitted when the wallet button has been loaded and rendered in the DOM.
+ * No payload — the specific wallet type is determined by the concrete button class
+ * ({@link ApplePayOpenWalletButton} or {@link GooglePayOpenWalletButton}).
+ * @interface OnLoadedEventData
+ *
+ * @type {object}
+ * @param {string} event - Always `'loaded'`.
+ **/
+/**
+ * Interface for OnCancelEventData.
+ * Emitted when the wallet checkout is cancelled or closed by the user. No payload data.
+ * @interface OnCancelEventData
+ *
+ * @type {object}
+ * @param {string} event - Always `'checkoutClose'`.
+ **/
+/**
+ * Interface for OnShippingAddressChangeEventData.
+ * Emitted when the customer selects or updates their shipping address in the wallet payment sheet.
+ * This event is also emitted when the payment sheet first opens (INITIALIZE) with the initial shipping address, if present in the User's wallet.
+ *
+ * If no handler is registered for this event, the SDK auto-accepts with the current transaction data.
+ * @interface OnShippingAddressChangeEventData
+ *
+ * @type {object}
+ * @param {string} event - Always `'onShippingAddressChange'`.
+ * @param {object} [data] - Shipping address data.
+ * @param {string} [data.address_city] - Shipping address city.
+ * @param {string} [data.address_state] - Shipping address state.
+ * @param {string} [data.address_postcode] - Shipping address postal code.
+ * @param {string} [data.address_country] - Shipping address country code.
+ * @param {string} [data.address_line1] - Apple Pay only - Shipping address line 1.
+ * @param {string} [data.address_line2] - Apple Pay only - Shipping address line 2.
+ * @param {string} [data.contact.phone] - Apple Pay only - Shipping contact phone.
+ * @param {string} [data.contact.email] - Apple Pay only - Shipping contact email.
+ * @param {string} [data.contact.first_name] - Apple Pay only - Shipping contact first name.
+ * @param {string} [data.contact.last_name] - Apple Pay only - Shipping contact last name.
+ **/
+/**
+ * Interface for OnShippingAddressChangeEventResponse.
+ * Returned by the merchant's `onShippingAddressChange` handler.
+ * @interface OnShippingAddressChangeEventResponse
+ *
+ * @type {object}
+ * @param {number} [amount] - Updated payment amount based on the new shipping address.
+ * @param {Array<IApplePayShippingOption | IGooglePayShippingOption>} [shipping_options] - Updated list of available shipping options. The first item is used as the default selected option.
+ * @param {object} [error] - Error object to display in the wallet payment sheet if the address is invalid.
+ * @param {string} error.code - Error code. Possible values: `'address_error'`, `'country_error'`, `'state_error'`, `'zip_error'`, `'shipping_contact_invalid'`, `'billing_contact_invalid'`.
+ * @param {string} [error.field] - Apple Pay only - The specific field that caused the error. Possible values: `'phone'`, `'email'`, `'name'`, `'phonetic_name'`, `'address_lines'`, `'locality'`, `'postal_code'`, `'administrative_area'`, `'country'`, `'country_code'`.
+ * @param {string} [error.message] - A human-readable error message to display to the customer.
+ **/
+/**
+ * Interface for OnShippingOptionChangeEventData.
+ * Emitted when the customer selects a shipping option in the wallet payment sheet.
+ *
+ * If no handler is registered for this event, the SDK auto-accepts with the current transaction data.
+ * @interface OnShippingOptionChangeEventData
+ *
+ * @type {object}
+ * @param {string} event - Always `'onShippingOptionsChange'`.
+ * @param {object} [data] - Shipping option data.
+ * @param {string} [data.shipping_option_id] - Selected shipping option ID.
+ * @param {string} [data.label] - Selected shipping option label.
+ * @param {string} [data.detail] - Selected shipping option detail.
+ * @param {string} [data.amount] - Apple Pay only - Selected shipping option amount.
+ **/
+/**
+ * Interface for OnShippingOptionChangeEventResponse.
+ * Returned by the merchant's `onShippingOptionsChange` handler.
+ * @interface OnShippingOptionChangeEventResponse
+ *
+ * @type {object}
+ * @param {number} [amount] - Updated total payment amount based on the selected shipping option.
+ * @param {object} [error] - Error object to display if the shipping option is invalid.
+ * @param {string} error.code - Error code. Possible values: `'method_unavailable'`, `'store_unavailable'`.
+ * @param {string} [error.message] - A human-readable error message.
+ **/
+/**
+ * Interface for IApplePayShippingOption.
+ * Used for shipping options in Apple Pay wallets.
+ * @interface IApplePayShippingOption
+ *
+ * @type {object}
+ * @param {string} id - Unique identifier for the shipping option.
+ * @param {string} label - Display name for the shipping option.
+ * @param {number} amount - Shipping cost amount.
+ * @param {string} [detail] - Optional description or detail text.
+ * @param {object} [date_components_range] - Apple Pay only - Delivery date range estimate.
+ * @param {object} [date_components_range.start_date_components] - Start date for the delivery estimate.
+ * @param {number} [date_components_range.start_date_components.years] - Years from now.
+ * @param {number} [date_components_range.start_date_components.months] - Months from now.
+ * @param {number} [date_components_range.start_date_components.days] - Days from now.
+ * @param {number} [date_components_range.start_date_components.hours] - Hours from now.
+ * @param {object} [date_components_range.end_date_components] - End date for the delivery estimate.
+ * @param {number} [date_components_range.end_date_components.years] - Years from now.
+ * @param {number} [date_components_range.end_date_components.months] - Months from now.
+ * @param {number} [date_components_range.end_date_components.days] - Days from now.
+ * @param {number} [date_components_range.end_date_components.hours] - Hours from now.
+ **/
+/**
+ * Interface for IGooglePayShippingOption.
+ * Used for shipping options in Google Pay wallets.
+ * @interface IGooglePayShippingOption
+ *
+ * @type {object}
+ * @param {string} id - Unique identifier for the shipping option.
+ * @param {string} label - Display name for the shipping option.
+ * @param {string} [detail] - Optional description or detail text.
+ * @param {'ELECTRONIC' | 'GROUND' | 'NOT_SHIPPED' | 'OVERNIGHT' | 'PICKUP' | 'PRIORITY' | 'SAME_DAY'} [type] - The shipping type.
+ **/
+/**
+ * List of available event names in the Open Wallet button lifecycle.
+ * @const EVENT
+ *
+ * @type {object}
+ * @param {string} ON_CLICK=onClick - Emitted when the wallet button is clicked.
+ * @param {string} SUCCESS=success - Emitted when OTT creation succeeds.
+ * @param {string} UNAVAILABLE=unavailable - Emitted when the wallet is not available.
+ * @param {string} ERROR=error - Emitted when an error occurs.
+ * @param {string} LOADED=loaded - Emitted when the button is rendered.
+ * @param {string} CHECKOUT_CLOSE=checkoutClose - Emitted when the wallet checkout is cancelled.
+ * @param {string} ON_SHIPPING_ADDRESS_CHANGE=onShippingAddressChange - Emitted when shipping address changes.
+ * @param {string} ON_SHIPPING_OPTIONS_CHANGE=onShippingOptionsChange - Emitted when shipping option changes.
+ */
+/**
+ * Enum of available wallet types.
+ * @const WALLET_TYPES
+ *
+ * @type {object}
+ * @param {string} APPLE_PAY=apple - Apple Pay wallet.
+ * @param {string} GOOGLE_PAY=google - Google Pay wallet.
+ */
+/**
+ * Token types returned in the OTT (One-Time Token) creation response.
+ * @const TOKEN_TYPE
+ *
+ * @type {object}
+ * @param {string} CARD=card - FPAN (Funding Primary Account Number). Available for Google Pay only.
+ * @param {string} CARD_SCHEME_TOKEN=card_scheme_token - DPAN (Device Primary Account Number). Available for both Apple Pay and Google Pay.
+ */
+/**
+ * Operations that can fail during the wallet lifecycle.
+ * Used in the `context.operation` field of {@link OnErrorEventData}.
+ * @const ERROR_OPERATION
+ *
+ * @type {object}
+ * @param {string} WALLET_OPERATION=wallet_operation - General wallet lifecycle operation (default).
+ * @param {string} CONFIGURATION=configuration - Loading or validating the wallet service configuration (e.g. network fetch failure, card config validation).
+ * @param {string} HANDLER_REGISTRATION=handler_registration - A required event handler was not registered before calling load().
+ * @param {string} SHIPPING_UPDATE=shipping_update - Processing a shipping address or shipping option update failed.
+ */
 //# sourceMappingURL=index.d.ts.map

package/bundles/types/open-wallets/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/open-wallets/index.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,iBAAiB,EAAE,MAAM,4BAA4B,CAAC;AAC/D,OAAO,EAAE,KAAK,EAAE,KAAK,mBAAmB,EAAE,MAAM,mBAAmB,CAAC;AACpE,mBAAmB,cAAc,CAAC;AAIlC,mBAAmB,SAAS,CAAC;AAC7B,OAAO,EAAE,YAAY,EAAE,MAAM,0BAA0B,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/open-wallets/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,wBAAwB,EAAE,MAAM,gCAAgC,CAAC;AAC1E,OAAO,EAAE,iBAAiB,EAAE,MAAM,4BAA4B,CAAC;AAC/D,OAAO,EAAE,eAAe,EAAE,MAAM,6BAA6B,CAAC;AAC9D,OAAO,EAAE,KAAK,EAAE,KAAK,mBAAmB,EAAE,MAAM,mBAAmB,CAAC;AACpE,OAAO,EAAE,UAAU,EAAE,MAAM,wBAAwB,CAAC;AACpD,OAAO,EAAE,yBAAyB,EAAE,MAAM,iCAAiC,CAAC;AAC5E,mBAAmB,cAAc,CAAC;AAClC,mBAAmB,SAAS,CAAC;AAC7B,OAAO,EAAE,YAAY,EAAE,MAAM,0BAA0B,CAAC;AAExD;;;;;;;;;;;;;;;;;;;;;;;;;;;IA2BI;AAEJ;;;;;;;;;;;;;;;;;;;IAmBI;AAEJ;;;;;;;;;;;;;;;IAeI;AAEJ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAoCI;AAEJ;;;;;;;;;;IAUI;AAEJ;;;;;;;;;;;IAWI;AAEJ;;;;;;;;;;;IAWI;AAEJ;;;;;;;;;IASI;AAEJ;;;;;;;IAOI;AAEJ;;;;;;;;;;;;;;;;;;;;;IAqBI;AAEJ;;;;;;;;;;;;IAYI;AAEJ;;;;;;;;;;;;;;IAcI;AAEJ;;;;;;;;;;IAUI;AAEJ;;;;;;;;;;;;;;;;;;;;;IAqBI;AAEJ;;;;;;;;;;IAUI;AAEJ;;;;;;;;;;;;;GAaG;AAEH;;;;;;;GAOG;AAEH;;;;;;;GAOG;AAEH;;;;;;;;;;GAUG"}