@paydock/client-sdk 1.143.0 → 1.144.1-beta

package/bundles/types/wallet-buttons-express/services/apple-pay/interfaces/apple-pay-wallet-meta.interface.d.ts

@@ -3,20 +3,43 @@ import type { ApplePayButtonStyle } from '../types/apple-pay-button-style.type';
 import type { ApplePayButtonType } from '../types/apple-pay-button-type.type';
 import type { ContactShippingEditingMode } from '../types/apple-pay-contact-editing-mode.type';
 import type { AppleShippingType } from '../types/apple-pay-shipping-data';
+/**
+ * Metadata required to configure an `ApplePayWalletButtonExpress` button.
+ * Extends {@link BaseWalletMeta} (`amount`, `currency`) plus Apple Pay specifics.
+ *
+ * The walletToken (JWT) returned from the `onClick` handler authorizes the actual
+ * charge; this meta only configures the button presentation and the Apple Pay sheet.
+ */
 export interface ApplePayWalletMeta extends BaseWalletMeta {
+    /** Label shown next to the total in the Apple Pay sheet (e.g. `'TOTAL'`). */
     amount_label: string;
+    /** ISO 3166-1 alpha-2 country code (e.g. `'AU'`, `'US'`). Required by Apple Pay. */
     country: string;
+    /** Payment capabilities the merchant supports. Must include at least `'supports3DS'`. */
     merchant_capabilities?: Array<'supports3DS' | 'supportsEMV' | 'supportsCredit' | 'supportsDebit'>;
+    /** Card networks the merchant accepts. */
     supported_networks?: Array<'visa' | 'masterCard' | 'amex' | 'chinaUnionPay' | 'discover' | 'interac' | 'jcb' | 'privateLabel'>;
+    /** Billing contact fields the user must provide. Note: Apple does not currently return `'phone'` or `'email'`. */
     required_billing_contact_fields?: Array<'email' | 'name' | 'phone' | 'postalAddress'>;
+    /** Shipping contact fields the user must provide. Include `'postalAddress'` to surface the address fields in the sheet. */
     required_shipping_contact_fields?: Array<'email' | 'phone' | 'postalAddress'>;
+    /**
+     * Device capabilities allowed for the wallet button to be considered available.
+     * Used as a relaxation knob for testing — defaults to `['paymentCredentialsAvailable']` only.
+     */
     apple_pay_capabilities?: Array<'credentials_available' | 'credentials_status_unknown' | 'credentials_unavailable'>;
+    /** Restrict the cards Apple Pay offers to those issued in these ISO 3166 country codes. */
     supported_countries?: string[];
+    /** Visual styling for the Apple Pay button. */
     style?: {
+        /** Variant displayed on the button (e.g. `'buy'`, `'donate'`, `'plain'`). */
         button_type?: ApplePayButtonType;
+        /** Color scheme: `'black'`, `'white'`, or `'white-outline'`. */
         button_style?: ApplePayButtonStyle;
     };
+    /** Pre-filled shipping data to seed the Apple Pay sheet. */
     shipping?: AppleShippingType;
+    /** Whether the user can edit the shipping address: `'available'` allows editing; `'store_pickup'` locks it. */
     shipping_editing_mode?: ContactShippingEditingMode;
 }
 //# sourceMappingURL=apple-pay-wallet-meta.interface.d.ts.map

package/bundles/types/wallet-buttons-express/services/apple-pay/interfaces/apple-pay-wallet-meta.interface.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"apple-pay-wallet-meta.interface.d.ts","sourceRoot":"","sources":["../../../../../src/wallet-buttons-express/services/apple-pay/interfaces/apple-pay-wallet-meta.interface.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,gDAAgD,CAAC;AACrF,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,sCAAsC,CAAC;AAChF,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,qCAAqC,CAAC;AAC9E,OAAO,KAAK,EAAE,0BAA0B,EAAE,MAAM,8CAA8C,CAAC;AAC/F,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,kCAAkC,CAAC;AAE1E,MAAM,WAAW,kBAAmB,SAAQ,cAAc;IACxD,YAAY,EAAE,MAAM,CAAC;IACrB,OAAO,EAAE,MAAM,CAAC;IAChB,qBAAqB,CAAC,EAAE,KAAK,CAC3B,aAAa,GAAG,aAAa,GAAG,gBAAgB,GAAG,eAAe,CACnE,CAAC;IACF,kBAAkB,CAAC,EAAE,KAAK,CACtB,MAAM,GACN,YAAY,GACZ,MAAM,GACN,eAAe,GACf,UAAU,GACV,SAAS,GACT,KAAK,GACL,cAAc,CACjB,CAAC;IACF,+BAA+B,CAAC,EAAE,KAAK,CAAC,OAAO,GAAG,MAAM,GAAG,OAAO,GAAG,eAAe,CAAC,CAAC;IACtF,gCAAgC,CAAC,EAAE,KAAK,CAAC,OAAO,GAAG,OAAO,GAAG,eAAe,CAAC,CAAC;IAC9E,sBAAsB,CAAC,EAAE,KAAK,CAC5B,uBAAuB,GAAG,4BAA4B,GAAG,yBAAyB,CACnF,CAAC;IACF,mBAAmB,CAAC,EAAE,MAAM,EAAE,CAAC;IAC/B,KAAK,CAAC,EAAE;QACN,WAAW,CAAC,EAAE,kBAAkB,CAAC;QACjC,YAAY,CAAC,EAAE,mBAAmB,CAAC;KACpC,CAAC;IACF,QAAQ,CAAC,EAAE,iBAAiB,CAAC;IAC7B,qBAAqB,CAAC,EAAE,0BAA0B,CAAC;CACpD"}
+{"version":3,"file":"apple-pay-wallet-meta.interface.d.ts","sourceRoot":"","sources":["../../../../../src/wallet-buttons-express/services/apple-pay/interfaces/apple-pay-wallet-meta.interface.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,gDAAgD,CAAC;AACrF,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,sCAAsC,CAAC;AAChF,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,qCAAqC,CAAC;AAC9E,OAAO,KAAK,EAAE,0BAA0B,EAAE,MAAM,8CAA8C,CAAC;AAC/F,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,kCAAkC,CAAC;AAE1E;;;;;;GAMG;AACH,MAAM,WAAW,kBAAmB,SAAQ,cAAc;IACxD,6EAA6E;IAC7E,YAAY,EAAE,MAAM,CAAC;IACrB,oFAAoF;IACpF,OAAO,EAAE,MAAM,CAAC;IAChB,yFAAyF;IACzF,qBAAqB,CAAC,EAAE,KAAK,CAC3B,aAAa,GAAG,aAAa,GAAG,gBAAgB,GAAG,eAAe,CACnE,CAAC;IACF,0CAA0C;IAC1C,kBAAkB,CAAC,EAAE,KAAK,CACtB,MAAM,GACN,YAAY,GACZ,MAAM,GACN,eAAe,GACf,UAAU,GACV,SAAS,GACT,KAAK,GACL,cAAc,CACjB,CAAC;IACF,kHAAkH;IAClH,+BAA+B,CAAC,EAAE,KAAK,CAAC,OAAO,GAAG,MAAM,GAAG,OAAO,GAAG,eAAe,CAAC,CAAC;IACtF,2HAA2H;IAC3H,gCAAgC,CAAC,EAAE,KAAK,CAAC,OAAO,GAAG,OAAO,GAAG,eAAe,CAAC,CAAC;IAC9E;;;OAGG;IACH,sBAAsB,CAAC,EAAE,KAAK,CAC5B,uBAAuB,GAAG,4BAA4B,GAAG,yBAAyB,CACnF,CAAC;IACF,2FAA2F;IAC3F,mBAAmB,CAAC,EAAE,MAAM,EAAE,CAAC;IAC/B,+CAA+C;IAC/C,KAAK,CAAC,EAAE;QACN,6EAA6E;QAC7E,WAAW,CAAC,EAAE,kBAAkB,CAAC;QACjC,gEAAgE;QAChE,YAAY,CAAC,EAAE,mBAAmB,CAAC;KACpC,CAAC;IACF,4DAA4D;IAC5D,QAAQ,CAAC,EAAE,iBAAiB,CAAC;IAC7B,+GAA+G;IAC/G,qBAAqB,CAAC,EAAE,0BAA0B,CAAC;CACpD"}

package/bundles/types/wallet-buttons-express/services/paypal/interfaces/paypal-wallet-meta.interface.d.ts

@@ -1,30 +1,61 @@
 import type { BaseWalletMeta } from '../../../interfaces/base-wallet-meta.interface';
+/**
+ * Metadata required to configure a `PaypalWalletButtonExpress` button.
+ * Extends {@link BaseWalletMeta} (`amount`, `currency`) with PayPal-specific options.
+ *
+ * Most PayPal style options mirror the
+ * [PayPal Buttons Style Guide](https://developer.paypal.com/docs/multiparty/checkout/standard/customize/buttons-style-guide/).
+ */
 export interface PaypalWalletMeta extends BaseWalletMeta {
+    /** Enable PayPal's Pay Later (Pay in 4) option. Defaults to `false`. */
     pay_later?: boolean;
+    /** Hide the Pay Later messaging copy under the button. Defaults to `false`. */
     hide_message?: boolean;
+    /** Render the standalone PayPal button instead of the smart button group. Defaults to `false`. */
     standalone?: boolean;
+    /** Capture the transaction immediately (`true`) or authorize for later capture (`false`). Defaults to `false`. */
     capture?: boolean;
+    /** Visual styling for the PayPal button. Mirrors PayPal's smart button style schema. */
     style?: {
+        /** Button layout orientation. */
         layout?: 'vertical' | 'horizontal';
+        /** Button color theme. */
         color?: 'gold' | 'blue' | 'silver' | 'black' | 'white';
+        /** Button shape. */
         shape?: 'rect' | 'pill' | 'sharp';
+        /** Custom border radius in pixels. Overrides `shape` corner roundness. */
         borderRadius?: number;
+        /** Button height in pixels. */
         height?: number;
+        /** When `true`, removes PayPal's default max-width constraint on the button. */
         disableMaxWidth?: boolean;
+        /** Label text displayed on the button. */
         label?: 'paypal' | 'checkout' | 'buynow' | 'pay' | 'installment';
+        /** Whether to show the tagline beneath the button. */
         tagline?: boolean;
+        /** Pay Later messaging configuration shown alongside the button. */
         messages?: {
+            /** Layout type for the messaging block. */
             layout?: 'text' | 'flex';
+            /** PayPal logo configuration in the messaging block. */
             logo?: {
+                /** Logo variant. `'none'` removes the logo entirely. */
                 type?: 'primary' | 'alternative' | 'inline' | 'none';
+                /** Logo position relative to the message text. */
                 position?: 'left' | 'right' | 'top';
             };
+            /** Message text styling. */
             text?: {
+                /** Text color. */
                 color?: 'black' | 'white' | 'monochrome' | 'grayscale';
+                /** Font size in pixels (10-16). */
                 size?: 10 | 11 | 12 | 13 | 14 | 15 | 16;
+                /** Horizontal alignment. */
                 align?: 'left' | 'center' | 'right';
             };
+            /** Background color of the messaging block (used when `layout` is `'flex'`). */
             color?: 'blue' | 'black' | 'white' | 'white-no-border' | 'gray' | 'monochrome' | 'grayscale';
+            /** Aspect ratio of the messaging block. */
             ratio?: '1x1' | '1x4' | '8x1' | '20x1';
         };
     };

package/bundles/types/wallet-buttons-express/services/paypal/interfaces/paypal-wallet-meta.interface.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"paypal-wallet-meta.interface.d.ts","sourceRoot":"","sources":["../../../../../src/wallet-buttons-express/services/paypal/interfaces/paypal-wallet-meta.interface.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,gDAAgD,CAAC;AAErF,MAAM,WAAW,gBAAiB,SAAQ,cAAc;IACtD,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,KAAK,CAAC,EAAE;QACN,MAAM,CAAC,EAAE,UAAU,GAAG,YAAY,CAAC;QACnC,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,QAAQ,GAAG,OAAO,GAAG,OAAO,CAAC;QACvD,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC;QAClC,YAAY,CAAC,EAAE,MAAM,CAAC;QACtB,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,eAAe,CAAC,EAAE,OAAO,CAAC;QAC1B,KAAK,CAAC,EAAE,QAAQ,GAAG,UAAU,GAAG,QAAQ,GAAG,KAAK,GAAG,aAAa,CAAC;QACjE,OAAO,CAAC,EAAE,OAAO,CAAC;QAClB,QAAQ,CAAC,EAAE;YACT,MAAM,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;YACzB,IAAI,CAAC,EAAE;gBACL,IAAI,CAAC,EAAE,SAAS,GAAG,aAAa,GAAG,QAAQ,GAAG,MAAM,CAAC;gBACrD,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,GAAG,KAAK,CAAC;aACrC,CAAC;YACF,IAAI,CAAC,EAAE;gBACL,KAAK,CAAC,EAAE,OAAO,GAAG,OAAO,GAAG,YAAY,GAAG,WAAW,CAAC;gBACvD,IAAI,CAAC,EAAE,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC;gBACxC,KAAK,CAAC,EAAE,MAAM,GAAG,QAAQ,GAAG,OAAO,CAAC;aACrC,CAAC;YACF,KAAK,CAAC,EACF,MAAM,GACN,OAAO,GACP,OAAO,GACP,iBAAiB,GACjB,MAAM,GACN,YAAY,GACZ,WAAW,CAAC;YAChB,KAAK,CAAC,EAAE,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,MAAM,CAAC;SACxC,CAAC;KACH,CAAC;CACH"}
+{"version":3,"file":"paypal-wallet-meta.interface.d.ts","sourceRoot":"","sources":["../../../../../src/wallet-buttons-express/services/paypal/interfaces/paypal-wallet-meta.interface.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,gDAAgD,CAAC;AAErF;;;;;;GAMG;AACH,MAAM,WAAW,gBAAiB,SAAQ,cAAc;IACtD,wEAAwE;IACxE,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,+EAA+E;IAC/E,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,kGAAkG;IAClG,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,kHAAkH;IAClH,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,wFAAwF;IACxF,KAAK,CAAC,EAAE;QACN,iCAAiC;QACjC,MAAM,CAAC,EAAE,UAAU,GAAG,YAAY,CAAC;QACnC,0BAA0B;QAC1B,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,QAAQ,GAAG,OAAO,GAAG,OAAO,CAAC;QACvD,oBAAoB;QACpB,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC;QAClC,0EAA0E;QAC1E,YAAY,CAAC,EAAE,MAAM,CAAC;QACtB,+BAA+B;QAC/B,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,gFAAgF;QAChF,eAAe,CAAC,EAAE,OAAO,CAAC;QAC1B,0CAA0C;QAC1C,KAAK,CAAC,EAAE,QAAQ,GAAG,UAAU,GAAG,QAAQ,GAAG,KAAK,GAAG,aAAa,CAAC;QACjE,sDAAsD;QACtD,OAAO,CAAC,EAAE,OAAO,CAAC;QAClB,oEAAoE;QACpE,QAAQ,CAAC,EAAE;YACT,2CAA2C;YAC3C,MAAM,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;YACzB,wDAAwD;YACxD,IAAI,CAAC,EAAE;gBACL,wDAAwD;gBACxD,IAAI,CAAC,EAAE,SAAS,GAAG,aAAa,GAAG,QAAQ,GAAG,MAAM,CAAC;gBACrD,kDAAkD;gBAClD,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,GAAG,KAAK,CAAC;aACrC,CAAC;YACF,4BAA4B;YAC5B,IAAI,CAAC,EAAE;gBACL,kBAAkB;gBAClB,KAAK,CAAC,EAAE,OAAO,GAAG,OAAO,GAAG,YAAY,GAAG,WAAW,CAAC;gBACvD,mCAAmC;gBACnC,IAAI,CAAC,EAAE,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC;gBACxC,4BAA4B;gBAC5B,KAAK,CAAC,EAAE,MAAM,GAAG,QAAQ,GAAG,OAAO,CAAC;aACrC,CAAC;YACF,gFAAgF;YAChF,KAAK,CAAC,EACF,MAAM,GACN,OAAO,GACP,OAAO,GACP,iBAAiB,GACjB,MAAM,GACN,YAAY,GACZ,WAAW,CAAC;YAChB,2CAA2C;YAC3C,KAAK,CAAC,EAAE,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,MAAM,CAAC;SACxC,CAAC;KACH,CAAC;CACH"}