@flopay/js 1.0.3 → 1.1.3

package/dist/index.d.cts

@@ -1,5 +1,5 @@
 import * as _flopay_shared from '@flopay/shared';
-import { PaymentProviderAdapter, ElementOptions, ElementType, MountedElement, FloPayError, FloPayConfig, CreatePaymentMethodResult, ConfirmCardPaymentParams, ConfirmCardPaymentResult, ConfirmPaymentParams, PaymentResult, CheckoutSession, NormalizedCheckoutSession, BillingDetails, BillingProvider, ProcessPaymentParams, InlineSessionDraft, CreateSessionParams, CheckoutSessionResult } from '@flopay/shared';
+import { PaymentProviderAdapter, ElementOptions, ElementType, MountedElement, FloPayError, FloPayConfig, CreatePaymentMethodResult, ConfirmCardPaymentParams, ConfirmCardPaymentResult, ConfirmPaymentParams, PaymentResult, CheckoutSession, NormalizedCheckoutSession, BillingDetails, CheckoutGateways, ProcessPaymentParams, InlineSessionDraft, CreateSessionParams, CheckoutSessionResult } from '@flopay/shared';
 
 /**
  * Manages the creation and lifecycle of payment elements.
@@ -106,8 +106,7 @@ declare class FloPay {
  *
  * Instances are cached per `publishableKey`, so calling `loadFloPay` twice
  * with the same key returns the same instance. Different keys produce
- * independent instances that can run side-by-side (used for the dedicated
- * PayPal Stripe account).
+ * independent instances that can run side-by-side.
  *
  * @example
  * ```ts
@@ -168,30 +167,14 @@ declare class StripeAdapter implements PaymentProviderAdapter {
  * Values from the server response always win — cached values fill in only
  * where the server returned `null` or `undefined`.
  */
-/** Display-only fields per item that can be cached and merged back later. */
-interface SessionDisplayItem {
-    /** Catalog code (preferred match key). */
+/** Display-only fields per product that can be cached and merged back later. */
+interface SessionDisplayProduct {
+    /** Catalog code (match key). */
     code?: string;
-    /** @deprecated Match key fallback when `code` is not provided. */
-    providerItemId?: string;
-    /** Display-only name for the item. Takes priority over `providerItemName`. */
-    itemName?: string | null;
-    /** @deprecated Use `itemName`. */
-    providerItemName?: string | null;
-    totalAmount?: number;
-    overrideAmount?: number | null;
-    currency?: string;
-}
-/** Display-only fields per subscription that can be cached and merged back later. */
-interface SessionDisplaySubscription {
-    /** Catalog code (preferred match key). */
-    code?: string;
-    /** @deprecated Match key fallback when `code` is not provided. */
-    providerPlanId?: string;
-    /** Display-only name for the subscription plan. Takes priority over `providerPlanName`. */
-    subscriptionName?: string | null;
-    /** @deprecated Use `subscriptionName`. */
-    providerPlanName?: string | null;
+    /** Whether this product is a one-time item or a recurring subscription. */
+    type?: 'item' | 'subscription';
+    /** Display-only name for the product. */
+    name?: string | null;
     totalAmount?: number;
     overrideAmount?: number | null;
     currency?: string;
@@ -200,8 +183,7 @@ interface SessionDisplaySubscription {
 interface SessionDisplayCacheData {
     /** Session-level currency (falls into the response only when the server omits it). */
     currency?: string;
-    items?: SessionDisplayItem[];
-    subscriptions?: SessionDisplaySubscription[];
+    products?: SessionDisplayProduct[];
 }
 /**
  * Stash display-only data for a session. Called client-side right after the
@@ -226,71 +208,44 @@ declare function clearSessionDisplayData(sessionId: string): void;
 interface BillingResponse<T> {
     data: T;
 }
-/** Raw checkout session from the billing API (includes gateway field). */
+/** Raw checkout session from the billing API. */
 interface RawCheckoutSession {
     uuid: string;
     nonce: string;
-    gateway?: BillingProvider;
     status: 'pending' | 'completed' | 'expired';
     successUrl: string;
     cancelUrl: string;
-    /** Session-level currency. Takes precedence over per-item/per-subscription currency. */
+    /** Session-level currency. */
     currency?: string;
     createdAt?: string;
     checkoutUrl?: string;
-    items: Array<{
-        uuid: string;
-        checkoutSessionId: string;
-        /** Preferred catalog code. Falls back to the deprecated `providerItemId`. */
-        code?: string;
-        /** @deprecated Use `code`. */
-        providerItemId?: string;
-        /** Display-only name. Preferred over `providerItemName`. */
-        itemName?: string | null;
-        /** @deprecated Use `itemName`. Mirrored for backward compatibility. */
-        providerItemName?: string | null;
-        /** Display-only description from the catalog. */
-        providerItemDescription?: string | null;
-        quantity: number;
-        /** @deprecated Removed from the backend — resolved from the catalog. */
-        totalAmount?: number;
-        /** @deprecated Removed from the backend entirely. */
-        overrideAmount?: number | null;
-        /** @deprecated Use the session-level `currency`. */
-        currency?: string;
-        metadata?: Record<string, unknown> | null;
-    }>;
-    subscriptions: Array<{
+    /** Unified products list returned by the billing API (post-#760). */
+    products?: Array<{
         uuid: string;
         checkoutSessionId: string;
-        /** Preferred catalog code. Falls back to the deprecated `providerPlanId`. */
+        /** 'item' or 'subscription'. */
+        type: 'item' | 'subscription';
         code?: string;
-        /** @deprecated Use `code`. */
-        providerPlanId?: string;
-        /** Display-only name. Preferred over `providerPlanName`. */
-        subscriptionName?: string | null;
-        /** @deprecated Use `subscriptionName`. Mirrored for backward compatibility. */
-        providerPlanName?: string | null;
-        /** Display-only description from the catalog. */
-        providerPlanDescription?: string | null;
+        name?: string | null;
+        description?: string | null;
         quantity: number;
-        /** @deprecated Removed from the backend — resolved from the catalog. */
         totalAmount?: number;
-        /** @deprecated Removed from the backend entirely. */
         overrideAmount?: number | null;
-        /** @deprecated Use the session-level `currency`. */
         currency?: string;
-        /** @deprecated Removed from the backend. Checkouts only create new subscriptions. */
-        isUpdate?: boolean;
         metadata?: Record<string, unknown> | null;
     }>;
     coupons?: string[];
+    /**
+     * Pre-discount total in cart-currency major units. Populated by billing
+     * API ≥ v1.1.2; absent on older backends.
+     */
+    subtotalAmount?: number;
+    /** Total reduction from applied coupons (cart-currency major units). */
+    discountAmount?: number;
+    /** Final charge amount after coupon discount (cart-currency major units). */
+    totalAmount?: number;
     checkoutMode?: 'full' | 'auto' | 'confirm';
-    gatewayData: {
-        publishableKey?: string | null;
-        stripeClientSecret?: string | null;
-        paypalPublishableKey?: string | null;
-    };
+    gateways?: CheckoutGateways;
     accountData: {
         userId: string;
         firstName: string;
@@ -352,9 +307,9 @@ declare class PaymentAPI {
     /**
      * Fetch and normalize a checkout session.
      *
-     * Reads the backend's `gateway` field to determine the provider,
-     * then wraps the session in a `NormalizedCheckoutSession` for
-     * provider-agnostic consumption.
+     * Reads the backend's `gateways` map to enumerate provider-specific data,
+     * then wraps the session in a `NormalizedCheckoutSession` for provider-
+     * agnostic consumption.
      */
     getUnifiedCheckoutSession(checkoutSessionId: string): Promise<NormalizedCheckoutSession>;
     /**
@@ -362,8 +317,13 @@ declare class PaymentAPI {
      *
      * The backend will either succeed, return `type: '3ds_required'`
      * (with a `threeDSecureToken`), or return `type: 'paypal_redirect_required'`.
+     *
+     * @param userId Vestigial — backend's GatewayInterceptor routes via session,
+     *   not headers, so this value is no longer sent on the wire. Kept in the
+     *   signature for back-compat with existing callers; will be removed in a
+     *   future major version.
      */
-    processPayment(userId: string, data: ProcessPaymentParams, options?: {
+    processPayment(_userId: string, data: ProcessPaymentParams, options?: {
         pollTimeoutMs?: number;
     }): Promise<Response>;
     /**
@@ -422,18 +382,15 @@ declare class PaymentAPI {
      * Stash the display-only fields the consumer passed into a create-session
      * call. Runs after the backend assigns a UUID so a later GET on the same
      * session (typically after a redirect) can fill in fields the backend no
-     * longer persists — `overrideAmount`, `totalAmount`, `itemName`, etc.
+     * longer persists — `overrideAmount`, `totalAmount`, `name`, etc.
      *
      * No-op when no UUID is available.
      */
     private autoCacheDisplayData;
     /**
      * Merge cached display-only fields (set by {@link cacheSessionDisplayData})
-     * into a raw session response and mirror the new/legacy name aliases so
-     * readers using either field always get a value when one exists.
-     *
-     * Server values always win — cache fills in only where the server returned
-     * `null` / `undefined`.
+     * into a raw session response. Server values always win — cache fills in
+     * only where the server returned `null` / `undefined`.
      */
     private mergeCachedDisplayData;
 }
@@ -479,4 +436,4 @@ declare function createCheckoutSessionWithRetries(options: CreateSessionParams &
     maxRetries?: number;
 }): Promise<CheckoutSessionResult>;
 
-export { FloPay, FloPayElements, PaymentAPI, type SessionDisplayCacheData, type SessionDisplayItem, type SessionDisplaySubscription, StripeAdapter, cacheSessionDisplayData, clearSessionDisplayData, createCheckoutSession, createCheckoutSessionWithRetries, getSessionDisplayData, loadFloPay };
+export { FloPay, FloPayElements, PaymentAPI, type SessionDisplayCacheData, type SessionDisplayProduct, StripeAdapter, cacheSessionDisplayData, clearSessionDisplayData, createCheckoutSession, createCheckoutSessionWithRetries, getSessionDisplayData, loadFloPay };

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 import * as _flopay_shared from '@flopay/shared';
-import { PaymentProviderAdapter, ElementOptions, ElementType, MountedElement, FloPayError, FloPayConfig, CreatePaymentMethodResult, ConfirmCardPaymentParams, ConfirmCardPaymentResult, ConfirmPaymentParams, PaymentResult, CheckoutSession, NormalizedCheckoutSession, BillingDetails, BillingProvider, ProcessPaymentParams, InlineSessionDraft, CreateSessionParams, CheckoutSessionResult } from '@flopay/shared';
+import { PaymentProviderAdapter, ElementOptions, ElementType, MountedElement, FloPayError, FloPayConfig, CreatePaymentMethodResult, ConfirmCardPaymentParams, ConfirmCardPaymentResult, ConfirmPaymentParams, PaymentResult, CheckoutSession, NormalizedCheckoutSession, BillingDetails, CheckoutGateways, ProcessPaymentParams, InlineSessionDraft, CreateSessionParams, CheckoutSessionResult } from '@flopay/shared';
 
 /**
  * Manages the creation and lifecycle of payment elements.
@@ -106,8 +106,7 @@ declare class FloPay {
  *
  * Instances are cached per `publishableKey`, so calling `loadFloPay` twice
  * with the same key returns the same instance. Different keys produce
- * independent instances that can run side-by-side (used for the dedicated
- * PayPal Stripe account).
+ * independent instances that can run side-by-side.
  *
  * @example
  * ```ts
@@ -168,30 +167,14 @@ declare class StripeAdapter implements PaymentProviderAdapter {
  * Values from the server response always win — cached values fill in only
  * where the server returned `null` or `undefined`.
  */
-/** Display-only fields per item that can be cached and merged back later. */
-interface SessionDisplayItem {
-    /** Catalog code (preferred match key). */
+/** Display-only fields per product that can be cached and merged back later. */
+interface SessionDisplayProduct {
+    /** Catalog code (match key). */
     code?: string;
-    /** @deprecated Match key fallback when `code` is not provided. */
-    providerItemId?: string;
-    /** Display-only name for the item. Takes priority over `providerItemName`. */
-    itemName?: string | null;
-    /** @deprecated Use `itemName`. */
-    providerItemName?: string | null;
-    totalAmount?: number;
-    overrideAmount?: number | null;
-    currency?: string;
-}
-/** Display-only fields per subscription that can be cached and merged back later. */
-interface SessionDisplaySubscription {
-    /** Catalog code (preferred match key). */
-    code?: string;
-    /** @deprecated Match key fallback when `code` is not provided. */
-    providerPlanId?: string;
-    /** Display-only name for the subscription plan. Takes priority over `providerPlanName`. */
-    subscriptionName?: string | null;
-    /** @deprecated Use `subscriptionName`. */
-    providerPlanName?: string | null;
+    /** Whether this product is a one-time item or a recurring subscription. */
+    type?: 'item' | 'subscription';
+    /** Display-only name for the product. */
+    name?: string | null;
     totalAmount?: number;
     overrideAmount?: number | null;
     currency?: string;
@@ -200,8 +183,7 @@ interface SessionDisplaySubscription {
 interface SessionDisplayCacheData {
     /** Session-level currency (falls into the response only when the server omits it). */
     currency?: string;
-    items?: SessionDisplayItem[];
-    subscriptions?: SessionDisplaySubscription[];
+    products?: SessionDisplayProduct[];
 }
 /**
  * Stash display-only data for a session. Called client-side right after the
@@ -226,71 +208,44 @@ declare function clearSessionDisplayData(sessionId: string): void;
 interface BillingResponse<T> {
     data: T;
 }
-/** Raw checkout session from the billing API (includes gateway field). */
+/** Raw checkout session from the billing API. */
 interface RawCheckoutSession {
     uuid: string;
     nonce: string;
-    gateway?: BillingProvider;
     status: 'pending' | 'completed' | 'expired';
     successUrl: string;
     cancelUrl: string;
-    /** Session-level currency. Takes precedence over per-item/per-subscription currency. */
+    /** Session-level currency. */
     currency?: string;
     createdAt?: string;
     checkoutUrl?: string;
-    items: Array<{
-        uuid: string;
-        checkoutSessionId: string;
-        /** Preferred catalog code. Falls back to the deprecated `providerItemId`. */
-        code?: string;
-        /** @deprecated Use `code`. */
-        providerItemId?: string;
-        /** Display-only name. Preferred over `providerItemName`. */
-        itemName?: string | null;
-        /** @deprecated Use `itemName`. Mirrored for backward compatibility. */
-        providerItemName?: string | null;
-        /** Display-only description from the catalog. */
-        providerItemDescription?: string | null;
-        quantity: number;
-        /** @deprecated Removed from the backend — resolved from the catalog. */
-        totalAmount?: number;
-        /** @deprecated Removed from the backend entirely. */
-        overrideAmount?: number | null;
-        /** @deprecated Use the session-level `currency`. */
-        currency?: string;
-        metadata?: Record<string, unknown> | null;
-    }>;
-    subscriptions: Array<{
+    /** Unified products list returned by the billing API (post-#760). */
+    products?: Array<{
         uuid: string;
         checkoutSessionId: string;
-        /** Preferred catalog code. Falls back to the deprecated `providerPlanId`. */
+        /** 'item' or 'subscription'. */
+        type: 'item' | 'subscription';
         code?: string;
-        /** @deprecated Use `code`. */
-        providerPlanId?: string;
-        /** Display-only name. Preferred over `providerPlanName`. */
-        subscriptionName?: string | null;
-        /** @deprecated Use `subscriptionName`. Mirrored for backward compatibility. */
-        providerPlanName?: string | null;
-        /** Display-only description from the catalog. */
-        providerPlanDescription?: string | null;
+        name?: string | null;
+        description?: string | null;
         quantity: number;
-        /** @deprecated Removed from the backend — resolved from the catalog. */
         totalAmount?: number;
-        /** @deprecated Removed from the backend entirely. */
         overrideAmount?: number | null;
-        /** @deprecated Use the session-level `currency`. */
         currency?: string;
-        /** @deprecated Removed from the backend. Checkouts only create new subscriptions. */
-        isUpdate?: boolean;
         metadata?: Record<string, unknown> | null;
     }>;
     coupons?: string[];
+    /**
+     * Pre-discount total in cart-currency major units. Populated by billing
+     * API ≥ v1.1.2; absent on older backends.
+     */
+    subtotalAmount?: number;
+    /** Total reduction from applied coupons (cart-currency major units). */
+    discountAmount?: number;
+    /** Final charge amount after coupon discount (cart-currency major units). */
+    totalAmount?: number;
     checkoutMode?: 'full' | 'auto' | 'confirm';
-    gatewayData: {
-        publishableKey?: string | null;
-        stripeClientSecret?: string | null;
-        paypalPublishableKey?: string | null;
-    };
+    gateways?: CheckoutGateways;
     accountData: {
         userId: string;
         firstName: string;
@@ -352,9 +307,9 @@ declare class PaymentAPI {
     /**
      * Fetch and normalize a checkout session.
      *
-     * Reads the backend's `gateway` field to determine the provider,
-     * then wraps the session in a `NormalizedCheckoutSession` for
-     * provider-agnostic consumption.
+     * Reads the backend's `gateways` map to enumerate provider-specific data,
+     * then wraps the session in a `NormalizedCheckoutSession` for provider-
+     * agnostic consumption.
      */
     getUnifiedCheckoutSession(checkoutSessionId: string): Promise<NormalizedCheckoutSession>;
     /**
@@ -362,8 +317,13 @@ declare class PaymentAPI {
      *
      * The backend will either succeed, return `type: '3ds_required'`
      * (with a `threeDSecureToken`), or return `type: 'paypal_redirect_required'`.
+     *
+     * @param userId Vestigial — backend's GatewayInterceptor routes via session,
+     *   not headers, so this value is no longer sent on the wire. Kept in the
+     *   signature for back-compat with existing callers; will be removed in a
+     *   future major version.
      */
-    processPayment(userId: string, data: ProcessPaymentParams, options?: {
+    processPayment(_userId: string, data: ProcessPaymentParams, options?: {
         pollTimeoutMs?: number;
     }): Promise<Response>;
     /**
@@ -422,18 +382,15 @@ declare class PaymentAPI {
      * Stash the display-only fields the consumer passed into a create-session
      * call. Runs after the backend assigns a UUID so a later GET on the same
      * session (typically after a redirect) can fill in fields the backend no
-     * longer persists — `overrideAmount`, `totalAmount`, `itemName`, etc.
+     * longer persists — `overrideAmount`, `totalAmount`, `name`, etc.
      *
      * No-op when no UUID is available.
      */
     private autoCacheDisplayData;
     /**
      * Merge cached display-only fields (set by {@link cacheSessionDisplayData})
-     * into a raw session response and mirror the new/legacy name aliases so
-     * readers using either field always get a value when one exists.
-     *
-     * Server values always win — cache fills in only where the server returned
-     * `null` / `undefined`.
+     * into a raw session response. Server values always win — cache fills in
+     * only where the server returned `null` / `undefined`.
      */
     private mergeCachedDisplayData;
 }
@@ -479,4 +436,4 @@ declare function createCheckoutSessionWithRetries(options: CreateSessionParams &
     maxRetries?: number;
 }): Promise<CheckoutSessionResult>;
 
-export { FloPay, FloPayElements, PaymentAPI, type SessionDisplayCacheData, type SessionDisplayItem, type SessionDisplaySubscription, StripeAdapter, cacheSessionDisplayData, clearSessionDisplayData, createCheckoutSession, createCheckoutSessionWithRetries, getSessionDisplayData, loadFloPay };
+export { FloPay, FloPayElements, PaymentAPI, type SessionDisplayCacheData, type SessionDisplayProduct, StripeAdapter, cacheSessionDisplayData, clearSessionDisplayData, createCheckoutSession, createCheckoutSessionWithRetries, getSessionDisplayData, loadFloPay };