swell-js 5.9.4 → 5.10.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "swell-js",
-  "version": "5.9.4",
+  "version": "5.10.0",
   "description": "Swell JS library for client-side stores",
   "engines": {
     "node": ">=16"

package/types/index.d.cts

@@ -147,12 +147,14 @@ declare namespace swell {
   export type OrderShippingCamel = import('./index.js', { with: { 'resolution-mode': 'import' } }).OrderShippingCamel;
   export type PaymentCase = import('./index.js', { with: { 'resolution-mode': 'import' } }).PaymentCase;
   export type InputPaymentElementBase = import('./index.js', { with: { 'resolution-mode': 'import' } }).InputPaymentElementBase;
+  export type InputPaymentStripePaymentElement = import('./index.js', { with: { 'resolution-mode': 'import' } }).InputPaymentStripePaymentElement;
   export type InputPaymentElementCard = import('./index.js', { with: { 'resolution-mode': 'import' } }).InputPaymentElementCard;
   export type InputPaymentElementIdeal = import('./index.js', { with: { 'resolution-mode': 'import' } }).InputPaymentElementIdeal;
   export type InputPaymentElementPaypal = import('./index.js', { with: { 'resolution-mode': 'import' } }).InputPaymentElementPaypal;
   export type InputPaymentElementApple = import('./index.js', { with: { 'resolution-mode': 'import' } }).InputPaymentElementApple;
   export type InputPaymentElementGoogle = import('./index.js', { with: { 'resolution-mode': 'import' } }).InputPaymentElementGoogle;
   export type InputPaymentElementSezzle = import('./index.js', { with: { 'resolution-mode': 'import' } }).InputPaymentElementSezzle;
+  export type InputPaymentTokenizeCard = import('./index.js', { with: { 'resolution-mode': 'import' } }).InputPaymentTokenizeCard;
   export type InputPaymentRedirect = import('./index.js', { with: { 'resolution-mode': 'import' } }).InputPaymentRedirect;
   export type Payment = import('./index.js', { with: { 'resolution-mode': 'import' } }).Payment;
   export type PaymentCamel = import('./index.js', { with: { 'resolution-mode': 'import' } }).PaymentCamel;

package/types/index.d.ts

@@ -41,6 +41,7 @@ import type {
   InputPaymentElementApple,
   InputPaymentElementSezzle,
   InputPaymentRedirect,
+  InputPaymentTokenizeCard,
   PaymentCase,
 } from './payment/index.js';
 
@@ -376,24 +377,36 @@ export interface SwellClient<C extends 'snake' | 'camel' = 'snake'> {
     }): Promise<void>;
 
     tokenize(input?: {
-      card?: object;
+      card?: InputPaymentTokenizeCard;
+      /** Without `createElements` iDEAL needs no element: the shopper picks the bank on the iDEAL page */
       ideal?: object;
       klarna?: object;
       bancontact?: object;
       paysafecard?: object;
       amazon?: object;
+      /** Saferpay payment page; has no element, `tokenize` redirects */
+      twint?: InputPaymentRedirect;
     }): Promise<void>;
 
     handleRedirect(input?: {
       card?: InputPaymentRedirect;
+      ideal?: InputPaymentRedirect;
       paysafecard?: InputPaymentRedirect;
       klarna?: InputPaymentRedirect;
       bancontact?: InputPaymentRedirect;
+      amazon?: InputPaymentRedirect;
+      twint?: InputPaymentRedirect;
     }): Promise<void>;
 
     authenticate(id: string): Promise<object | { error: Error }>;
     resetAsyncPayment(id: string): Promise<object>;
 
+    /**
+     * Redirects to the gateway when a submitted order waits for an
+     * asynchronous payment; resolves `true` after starting the redirect
+     */
+    handleAsyncRedirect(order: object): Promise<boolean>;
+
     createIntent(input: { gateway: string; intent: object }): Promise<object>;
 
     updateIntent(input: { gateway: string; intent: object }): Promise<object>;

package/types/payment/index.ts

@@ -27,8 +27,28 @@ export interface InputPaymentElementBase {
   onError?: (error: Error) => void;
 }
 
-export interface InputPaymentElementCard extends InputPaymentElementBase {
-  /** @see {@link https://docs.stripe.com/js/elements_object/create_element?type=card#elements_create-options} */
+/**
+ * Stripe: draw the form with the Payment Element instead of the split elements.
+ * The element mounts into `#payment-element` unless `elementId` is set.
+ */
+export interface InputPaymentStripePaymentElement {
+  paymentElement?: boolean;
+  /**
+   * Payment Element only: Stripe Appearance API object (`theme`, `variables`, `rules`, `labels`).
+   *
+   * @see {@link https://docs.stripe.com/elements/appearance-api}
+   */
+  appearance?: Record<string, unknown>;
+}
+
+export interface InputPaymentElementCard
+  extends InputPaymentElementBase,
+    InputPaymentStripePaymentElement {
+  /**
+   * Split elements: {@link https://docs.stripe.com/js/elements_object/create_element?type=card#elements_create-options}.
+   * Payment Element: {@link https://docs.stripe.com/js/elements_object/create_payment_element#payment_element_create-options},
+   * merged over `{ layout: 'tabs', fields: { billingDetails: 'never' }, wallets: { applePay: 'never', googlePay: 'never' } }`.
+   */
   options?: object;
   separateElements?: boolean;
   cardNumber?: {
@@ -47,9 +67,13 @@ export interface InputPaymentElementCard extends InputPaymentElementBase {
   };
 }
 
-export interface InputPaymentElementIdeal extends InputPaymentElementBase {
+export interface InputPaymentElementIdeal
+  extends InputPaymentElementBase,
+    InputPaymentStripePaymentElement {
+  /** Payment Element: the same options and defaults as the card one */
   options?: {
     style?: unknown;
+    [key: string]: unknown;
   };
 }
 
@@ -127,6 +151,21 @@ export interface InputPaymentElementSezzle extends InputPaymentElementBase {
   };
 }
 
+export interface InputPaymentTokenizeCard
+  extends InputPaymentRedirect,
+    Pick<InputPaymentStripePaymentElement, 'paymentElement'> {
+  /** Stripe: `false` stores the card without a payment intent (default `true`) */
+  createIntent?: boolean;
+  /**
+   * Stripe: the `pm_` id of a card the shopper already has (a saved card, a
+   * wallet's payment method), authorized with an intent and 3-D Secure instead
+   * of an element's card
+   */
+  paymentMethod?: string;
+  /** Saferpay: register a new card even when the cart already has one */
+  replace?: boolean;
+}
+
 export interface InputPaymentRedirect {
   /** @optional called on card payment success */
   onSuccess?: (event: unknown) => void;