@payrails/web-sdk 5.44.1 → 5.45.0-RC.3

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@payrails/web-sdk",
-  "version": "5.44.1",
+  "version": "5.45.0-RC.3",
   "description": "SDK providing tokenization options on the client for merchants",
   "main": "index.js",
   "types": "payrails.d.ts",

package/payrails.d.ts

@@ -231,14 +231,14 @@ declare class WorkflowExecution {
     };
     static get url(): string;
     static get meta(): ExecutionMeta;
-    static get availablePaymentMethods(): StorablePaymentCompositionOption<CardMetadata | PayPalMetadata, ApplePayConfig | PayPalConfig | GooglePayConfig | undefined>[];
+    static get availablePaymentMethods(): StorablePaymentCompositionOption<CardMetadata | PayPalMetadata, ApplePayConfig | PayPalConfig | GooglePayWorkflowConfig | undefined>[];
     static get authorizeLink(): string | undefined;
     static get payoutLink(): string | undefined;
     static get createSessionLink(): string | undefined;
     static get createInstrumentLink(): string | undefined;
     static get storedPaymentInstruments(): StoredPaymentInstrument<PayPalMetadata & CardMetadata>[];
     static get storedDropinInstruments(): StoredPaymentInstrument<PayPalMetadata & CardMetadata>[];
-    static getFullPaymentMethodConfig(paymentMethod: PaymentMethodCode): StorablePaymentCompositionOption<CardMetadata | PayPalMetadata, ApplePayConfig | PayPalConfig | GooglePayConfig | undefined> | undefined;
+    static getFullPaymentMethodConfig(paymentMethod: PaymentMethodCode): StorablePaymentCompositionOption<CardMetadata | PayPalMetadata, ApplePayConfig | PayPalConfig | GooglePayWorkflowConfig | undefined> | undefined;
     static isAddressSelectorEnabled(paymentMethod: PaymentMethodCode): boolean | undefined;
     static isPaymentInstallmentsEnabled(paymentMethod: PaymentMethodCode): boolean | undefined;
     static getPaymentInstallmentOptions(paymentMethod: PaymentMethodCode): PaymentInstallmentsConfig;
@@ -248,7 +248,7 @@ declare class WorkflowExecution {
         description?: string;
         status: PAYMENT_INSTRUMENT_STATUS;
         integrationType: INTEGRATION_TYPE;
-        config: ApplePayConfig | PayPalConfig | GooglePayConfig | undefined;
+        config: ApplePayConfig | PayPalConfig | GooglePayWorkflowConfig | undefined;
         clientConfig?: {
             flow?: PAYMENT_CLIENT_FLOW;
             displayName?: string;
@@ -268,7 +268,7 @@ declare class WorkflowExecution {
         description?: string;
         status: PAYMENT_INSTRUMENT_STATUS;
         integrationType: INTEGRATION_TYPE;
-        config: ApplePayConfig | PayPalConfig | GooglePayConfig | undefined;
+        config: ApplePayConfig | PayPalConfig | GooglePayWorkflowConfig | undefined;
         clientConfig?: {
             flow?: PAYMENT_CLIENT_FLOW;
             displayName?: string;
@@ -378,7 +378,7 @@ interface InstallmentUpdateConfig {
     installmentCountry?: string | null;
     installmentOptions?: BaseInstallmentOption[] | null;
 }
-interface StorablePaymentCompositionOption<I = CardMetadata | PayPalMetadata, C = undefined | ApplePayConfig | PayPalConfig | GooglePayConfig> extends BasePaymentMethodConfig {
+interface StorablePaymentCompositionOption<I = CardMetadata | PayPalMetadata, C = undefined | ApplePayConfig | PayPalConfig | GooglePayWorkflowConfig> extends BasePaymentMethodConfig {
     id: string;
     description?: string;
     status: PAYMENT_INSTRUMENT_STATUS;
@@ -397,7 +397,7 @@ interface StorablePaymentCompositionOption<I = CardMetadata | PayPalMetadata, C
     paymentInstruments?: Array<StoredPaymentInstrument<I>>;
     payoutInstruments?: Array<StoredPaymentInstrument<I>>;
 }
-interface GooglePayConfig {
+interface GooglePayWorkflowConfig {
     parameters: {
         allowedAuthMethods: google.payments.api.CardAuthMethod[];
         allowedCardNetworks: google.payments.api.CardNetwork[];
@@ -725,7 +725,7 @@ interface ApplePayButtonOptions extends StoreInstrumentElementOptions {
             paymentScreenLabel?: string;
         };
     };
-    events?: PaymentEvents & {
+    events?: PaymentEvents & Pick<UIEvents, 'onDeliveryAddressChanged'> & {
         onApplePayAvailable?: () => void;
     };
     styles?: {
@@ -750,6 +750,20 @@ declare class ApplePayButton extends PayrailsElementWithStoreInstrumentCheckbox
     private onAuthorizeFailedHandler;
     private completeApplePaySession;
     private createApplePaySession;
+    /**
+     * Apple Pay only exposes redacted contact fields here for privacy
+     * (`countryCode`, `administrativeArea`, `locality`, `postalCode`); full
+     * address is revealed in `onpaymentauthorized` after the user authorizes.
+     *
+     * The session must be answered with `completeShippingContactSelection`
+     * within ~30s or Apple aborts the sheet — so the merchant's
+     * `onDeliveryAddressChanged` callback must be fast.
+     *
+     * `amount` is passed in (rather than read from `getSDKConfig()`) so the
+     * response carries the same total the session was created with, even if
+     * the SDK config is mutated mid-flow.
+     */
+    private onApplePayShippingContactSelected;
     private onApplePayAuthorized;
     private doAuthorizedPayment;
     private doTokenize;
@@ -1502,7 +1516,17 @@ interface LoadingScreenStyles {
     [StyleKeys.loader]?: Partial<CSSStyleDeclaration>;
 }
 
-type GooglePayConfigInput = google.payments.api.IsReadyToPayPaymentMethodSpecification[] | GooglePayConfig;
+type GooglePayConfigInput = {
+    apiVersion?: number;
+    apiVersionMinor?: number;
+    allowedPaymentMethods: google.payments.api.PaymentMethodSpecification[];
+    merchantInfo: google.payments.api.MerchantInfo;
+    emailRequired?: boolean;
+    shippingAddressRequired?: boolean;
+    shippingAddressParameters?: google.payments.api.ShippingAddressParameters;
+    existingPaymentMethodRequired?: boolean;
+} | google.payments.api.PaymentMethodSpecification[];
+
 interface GooglePayButtonOptions extends StoreInstrumentElementOptions {
     environment?: PayrailsEnvironment;
     merchantInfo?: google.payments.api.MerchantInfo;
@@ -1524,17 +1548,11 @@ interface GooglePayButtonOptions extends StoreInstrumentElementOptions {
 declare class GooglePayButton extends PayrailsElementWithStoreInstrumentCheckbox {
     protected options: GooglePayButtonOptions;
     private readonly paymentExecutor;
-    private static googleSDKClient;
-    private sdkLoadedCalled;
     private isProcessing;
-    private buttonElement;
     private action;
-    private static getGooglePayConfigAsArray;
-    private static getSDKClient;
+    private frame;
     static isGooglePayAvailable(allowedPaymentMethods: GooglePayConfigInput, environment?: PayrailsEnvironment, merchantInfo?: google.payments.api.MerchantInfo): Promise<boolean>;
     constructor(options: GooglePayButtonOptions);
-    private sdkLoaded;
-    private authorize;
     private onLoadPaymentData;
     private doTokenize;
     private doAuthorizePayment;
@@ -2188,6 +2206,23 @@ interface UIEvents {
         isValid: boolean;
         billingAddress?: IAddress;
     }) => void;
+    /**
+     * Fires when the shopper changes their delivery/shipping address inside an
+     * express-checkout sheet (PayPal, Apple Pay).
+     *
+     * Apple Pay note: only redacted address fields are exposed before the
+     * shopper authorizes the payment — `city`, `postalCode`, `state`, and
+     * `country.code` (see Apple's privacy model). The full address is only
+     * available on `onSuccess` after authorization.
+     *
+     * Apple Pay also requires the SDK to respond to the address-change event
+     * within ~30 seconds, otherwise the sheet errors out. Keep this callback
+     * fast — typically a region/ZIP validation, not a full cart recompute.
+     *
+     * Resolve to `true` to accept the address, `false` to reject it (the
+     * Apple Pay sheet shows an error and prompts the user to pick another
+     * address; PayPal cancels the address change).
+     */
     onDeliveryAddressChanged?: (data?: onDeliveryAddressChangedResponse) => Promise<boolean>;
 }
 type onPaymentMethodSelectedParams = {