@flopay/js 1.0.2 → 1.1.0

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
@@ -226,11 +225,10 @@ 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;
@@ -286,11 +284,7 @@ interface RawCheckoutSession {
     }>;
     coupons?: string[];
     checkoutMode?: 'full' | 'auto' | 'confirm';
-    gatewayData: {
-        publishableKey?: string | null;
-        stripeClientSecret?: string | null;
-        paypalPublishableKey?: string | null;
-    };
+    gateways?: CheckoutGateways;
     accountData: {
         userId: string;
         firstName: string;
@@ -352,9 +346,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 +356,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>;
     /**
@@ -418,6 +417,15 @@ declare class PaymentAPI {
     private resolveProcessResponse;
     private toCheckoutProcessingPending;
     private clampRetryAfterMs;
+    /**
+     * 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.
+     *
+     * 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

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
@@ -226,11 +225,10 @@ 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;
@@ -286,11 +284,7 @@ interface RawCheckoutSession {
     }>;
     coupons?: string[];
     checkoutMode?: 'full' | 'auto' | 'confirm';
-    gatewayData: {
-        publishableKey?: string | null;
-        stripeClientSecret?: string | null;
-        paypalPublishableKey?: string | null;
-    };
+    gateways?: CheckoutGateways;
     accountData: {
         userId: string;
         firstName: string;
@@ -352,9 +346,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 +356,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>;
     /**
@@ -418,6 +417,15 @@ declare class PaymentAPI {
     private resolveProcessResponse;
     private toCheckoutProcessingPending;
     private clampRetryAfterMs;
+    /**
+     * 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.
+     *
+     * 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

package/dist/index.mjs

@@ -603,9 +603,9 @@ var PaymentAPI = class {
   /**
    * 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.
    */
   async getUnifiedCheckoutSession(checkoutSessionId) {
     const res = await this.getCheckoutSession(checkoutSessionId);
@@ -616,16 +616,18 @@ var PaymentAPI = class {
    *
    * 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.
    */
-  async processPayment(userId, data, options) {
+  async processPayment(_userId, data, options) {
     const response = await fetch(
       `${this.baseUrl}/v1/checkouts/sessions/process`,
       {
         method: "POST",
-        headers: {
-          "Content-Type": "application/json",
-          "x-user-id": userId
-        },
+        headers: { "Content-Type": "application/json" },
         body: JSON.stringify(data)
       }
     );
@@ -756,7 +758,8 @@ var PaymentAPI = class {
       throw await buildApiErrorFromResponse(response, "Failed to create checkout session");
     }
     const body = await response.json();
-    if (body.data && "gateway" in body.data) {
+    if (body.data && "gateways" in body.data) {
+      this.autoCacheDisplayData(body.data.uuid, params);
       const merged = this.mergeCachedDisplayData(body.data);
       return {
         ...this.normalizeRawSession(merged),
@@ -769,6 +772,7 @@ var PaymentAPI = class {
     if (!uuid) {
       throw new FloPayError3("No session ID returned", "api_error");
     }
+    this.autoCacheDisplayData(uuid, params);
     const unifiedSession = await this.getUnifiedCheckoutSession(uuid);
     return {
       ...unifiedSession,
@@ -807,41 +811,38 @@ var PaymentAPI = class {
   }
   /** Normalize a raw session into a provider-agnostic shape. */
   normalizeRawSession(session) {
-    const gateway = session.gateway;
-    if (gateway === "chargebee") {
-      return {
-        provider: "chargebee",
-        mode: "tokenize",
-        data: { session: this.toCheckoutSession(session) },
-        raw: { data: session }
-      };
-    }
-    if (gateway === "stripe") {
+    const gateways = session.gateways ?? {};
+    const providers = [];
+    const data = {
+      session: this.toCheckoutSession(session)
+    };
+    const stripeGateway = gateways.stripe;
+    if (stripeGateway?.publishableKey) {
+      providers.push("stripe");
       const rawSession = session;
-      const gatewayDataRecord = session.gatewayData ?? {};
       const stripeClientSecret = [
         rawSession["stripeClientSecret"],
-        gatewayDataRecord["stripeClientSecret"],
-        gatewayDataRecord["clientSecret"]
+        stripeGateway.stripeClientSecret
       ].find((value) => typeof value === "string" && value.length > 0);
-      return {
-        provider: "stripe",
-        mode: "tokenize",
-        data: {
-          session: this.toCheckoutSession(session),
-          stripe: {
-            clientSecret: stripeClientSecret ?? "",
-            publishableKey: session.gatewayData?.publishableKey ?? void 0,
-            paypalPublishableKey: session.gatewayData?.paypalPublishableKey ?? void 0
-          }
-        },
-        raw: { data: session }
+      data.stripe = {
+        clientSecret: stripeClientSecret ?? "",
+        publishableKey: stripeGateway.publishableKey ?? void 0,
+        paypalPublishableKey: stripeGateway.paypalPublishableKey ?? void 0,
+        environment: stripeGateway.environment
+      };
+    }
+    const paypalGateway = gateways.paypal;
+    if (paypalGateway?.publishableKey) {
+      providers.push("paypal");
+      data.paypal = {
+        publishableKey: paypalGateway.publishableKey,
+        environment: paypalGateway.environment
       };
     }
     return {
-      provider: "recurly",
+      providers,
       mode: "tokenize",
-      data: { session: this.toCheckoutSession(session) },
+      data,
       raw: { data: session }
     };
   }
@@ -883,8 +884,7 @@ var PaymentAPI = class {
       cancelUrl: raw.cancelUrl,
       coupons: raw.coupons,
       createdAt: raw.createdAt,
-      gateway: raw.gateway,
-      gatewayData: raw.gatewayData,
+      gateways: raw.gateways,
       accountData: raw.accountData,
       tagsData: raw.tagsData
     };
@@ -937,6 +937,25 @@ var PaymentAPI = class {
   clampRetryAfterMs(retryAfterMs) {
     return Math.max(0, Math.min(retryAfterMs, MAX_PROCESSING_RETRY_AFTER_MS));
   }
+  /**
+   * 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.
+   *
+   * No-op when no UUID is available.
+   */
+  autoCacheDisplayData(sessionId, params) {
+    if (!sessionId) return;
+    if (!params.items?.length && !params.subscriptions?.length && !params.currency) {
+      return;
+    }
+    cacheSessionDisplayData(sessionId, {
+      currency: params.currency,
+      items: params.items,
+      subscriptions: params.subscriptions
+    });
+  }
   /**
    * Merge cached display-only fields (set by {@link cacheSessionDisplayData})
    * into a raw session response and mirror the new/legacy name aliases so
@@ -1200,6 +1219,13 @@ async function createCheckoutSession(options) {
     if (!uuid) {
       throw new Error("Checkout session created but no UUID was returned by the billing API");
     }
+    if (items.length || subscriptions.length || currency) {
+      cacheSessionDisplayData(uuid, {
+        currency,
+        items,
+        subscriptions
+      });
+    }
     const redirectUrl = new URL(`${checkoutBaseUrl.replace(/\/+$/, "")}/secure`);
     redirectUrl.searchParams.set("id", uuid);
     for (const [key, value] of Object.entries(redirectParams)) {