swell-js 5.9.3 → 5.10.0

package/package.json

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

package/types/consent/camel.ts

@@ -0,0 +1,17 @@
+import type { ConvertSnakeToCamelCase } from '../index.js';
+import type { Replace } from '../utils.js';
+
+import type { Consent, ConsentEffective, ConsentInput } from './snake.js';
+
+export type ConsentInputCamel = ConvertSnakeToCamelCase<ConsentInput>;
+
+export type ConsentEffectiveCamel = ConvertSnakeToCamelCase<ConsentEffective>;
+
+export type ConsentCamel = ConvertSnakeToCamelCase<
+  Replace<
+    Consent,
+    {
+      effective: ConsentEffectiveCamel;
+    }
+  >
+>;

package/types/consent/index.ts

@@ -0,0 +1,21 @@
+import type { MakeCase } from '../utils.js';
+
+import type { Consent, ConsentEffective, ConsentInput } from './snake.js';
+import type {
+  ConsentCamel,
+  ConsentEffectiveCamel,
+  ConsentInputCamel,
+} from './camel.js';
+
+export type ConsentCase = MakeCase<Consent, ConsentCamel>;
+
+export type ConsentInputCase = MakeCase<ConsentInput, ConsentInputCamel>;
+
+export type {
+  Consent,
+  ConsentEffective,
+  ConsentInput,
+  ConsentCamel,
+  ConsentEffectiveCamel,
+  ConsentInputCamel,
+};

package/types/consent/snake.ts

@@ -0,0 +1,22 @@
+/** The shopper's answers; purposes left out stay as they are */
+export interface ConsentInput {
+  analytics?: boolean;
+  marketing?: boolean;
+  sale_of_data?: boolean;
+}
+
+/** What the answers allow, after the region's rule and GPC */
+export interface ConsentEffective {
+  analytics: boolean;
+  marketing: boolean;
+  sale_of_data: boolean;
+}
+
+export interface Consent {
+  analytics: boolean | null;
+  marketing: boolean | null;
+  sale_of_data: boolean | null;
+  gpc: boolean;
+  rule: 'opt_in' | 'opt_out' | null;
+  effective: ConsentEffective;
+}

package/types/index.d.cts

@@ -82,6 +82,14 @@ declare namespace swell {
   export type CategoryCase = import('./index.js', { with: { 'resolution-mode': 'import' } }).CategoryCase;
   export type Category = import('./index.js', { with: { 'resolution-mode': 'import' } }).Category;
   export type CategoryCamel = import('./index.js', { with: { 'resolution-mode': 'import' } }).CategoryCamel;
+  export type ConsentCase = import('./index.js', { with: { 'resolution-mode': 'import' } }).ConsentCase;
+  export type ConsentInputCase = import('./index.js', { with: { 'resolution-mode': 'import' } }).ConsentInputCase;
+  export type Consent = import('./index.js', { with: { 'resolution-mode': 'import' } }).Consent;
+  export type ConsentEffective = import('./index.js', { with: { 'resolution-mode': 'import' } }).ConsentEffective;
+  export type ConsentInput = import('./index.js', { with: { 'resolution-mode': 'import' } }).ConsentInput;
+  export type ConsentCamel = import('./index.js', { with: { 'resolution-mode': 'import' } }).ConsentCamel;
+  export type ConsentEffectiveCamel = import('./index.js', { with: { 'resolution-mode': 'import' } }).ConsentEffectiveCamel;
+  export type ConsentInputCamel = import('./index.js', { with: { 'resolution-mode': 'import' } }).ConsentInputCamel;
   export type ContentCase = import('./index.js', { with: { 'resolution-mode': 'import' } }).ContentCase;
   export type ContentSectionCase = import('./index.js', { with: { 'resolution-mode': 'import' } }).ContentSectionCase;
   export type ContentPageCase = import('./index.js', { with: { 'resolution-mode': 'import' } }).ContentPageCase;
@@ -139,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

@@ -17,6 +17,7 @@ import type {
 } from './card/index.js';
 import type { CartCase, CartItemCase } from './cart/index.js';
 import type { CategoryCase } from './category/index.js';
+import type { ConsentCase, ConsentInputCase } from './consent/index.js';
 import type { ContentCase } from './content/index.js';
 import type {
   SelectCurrencyReturnCase,
@@ -40,6 +41,7 @@ import type {
   InputPaymentElementApple,
   InputPaymentElementSezzle,
   InputPaymentRedirect,
+  InputPaymentTokenizeCard,
   PaymentCase,
 } from './payment/index.js';
 
@@ -53,6 +55,7 @@ export type * from './billing/index.js';
 export type * from './card/index.js';
 export type * from './cart/index.js';
 export type * from './category/index.js';
+export type * from './consent/index.js';
 export type * from './content/index.js';
 export type * from './coupon/index.js';
 export type * from './currency/index.js';
@@ -374,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>;
@@ -499,6 +514,15 @@ export interface SwellClient<C extends 'snake' | 'camel' = 'snake'> {
     setCookie(value: string): void;
   };
 
+  consent: {
+    /**
+     * Records the shopper's consent for attribution. Call it from the
+     * storefront's consent banner; purposes left out stay as they are.
+     * Browser only: it calls the storefront's own origin.
+     */
+    set(consent?: ConsentInputCase[C]): Promise<ConsentCase[C]>;
+  };
+
   functions: {
     request<T>(
       method: string,

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;