@delopay/sdk 0.108.0 → 0.109.0

package/dist/index.cjs

@@ -55,8 +55,13 @@ __export(index_exports, {
   NATIVE_PANE_CATEGORY_KEYS: () => NATIVE_PANE_CATEGORY_KEYS,
   NATIVE_PANE_ICON_KEYS: () => NATIVE_PANE_ICON_KEYS,
   OperationLimits: () => OperationLimits,
+  PANES_MAX: () => PANES_MAX,
+  PANE_CATEGORY_KEYS: () => PANE_CATEGORY_KEYS,
+  PANE_ICON_KEYS: () => PANE_ICON_KEYS,
   Regions: () => Regions,
   Risk: () => Risk,
+  STRIPE_FALLBACK_PANE_CATALOG: () => STRIPE_FALLBACK_PANE_CATALOG,
+  STRIPE_FALLBACK_PANE_METHODS: () => STRIPE_FALLBACK_PANE_METHODS,
   STRIPE_NATIVE_PANE_METHODS: () => STRIPE_NATIVE_PANE_METHODS,
   Search: () => Search,
   Settlement: () => Settlement,
@@ -70,6 +75,7 @@ __export(index_exports, {
   cloneBranding: () => cloneBranding,
   cloneCustomField: () => cloneCustomField,
   cloneNativePane: () => cloneNativePane,
+  clonePane: () => clonePane,
   customFieldContextFromMetadata: () => customFieldContextFromMetadata,
   customFieldIsTextLike: () => customFieldIsTextLike,
   customFieldOperatorTakesValue: () => customFieldOperatorTakesValue,
@@ -79,14 +85,18 @@ __export(index_exports, {
   decodeBranding: () => decodeBranding,
   decodeCustomFields: () => decodeCustomFields,
   decodeNativePanes: () => decodeNativePanes,
+  decodePanes: () => decodePanes,
   defaultBranding: () => defaultBranding,
   defaultCustomFieldVisibility: () => defaultCustomFieldVisibility,
   defaultNativePane: () => defaultNativePane,
   defaultOperatorForSource: () => defaultOperatorForSource,
+  defaultPane: () => defaultPane,
+  emptyPaneCatalog: () => emptyPaneCatalog,
   encodeBadges: () => encodeBadges,
   encodeBranding: () => encodeBranding,
   encodeCustomFields: () => encodeCustomFields,
   encodeNativePanes: () => encodeNativePanes,
+  encodePanes: () => encodePanes,
   evaluateCustomFieldCondition: () => evaluateCustomFieldCondition,
   evaluateCustomFieldVisibility: () => evaluateCustomFieldVisibility,
   feeProgram: () => feeProgram,
@@ -100,6 +110,12 @@ __export(index_exports, {
   leaf: () => leaf,
   logoDimensions: () => logoDimensions,
   nativePaneMethodInfo: () => nativePaneMethodInfo,
+  offerablePaneMethods: () => offerablePaneMethods,
+  paneCatalogFor: () => paneCatalogFor,
+  paneDisplayDefaults: () => paneDisplayDefaults,
+  paneMethodInfo: () => paneMethodInfo,
+  paneRailAllowed: () => paneRailAllowed,
+  paneViewVisibility: () => paneViewVisibility,
   parseCustomFieldsLoose: () => parseCustomFieldsLoose,
   parseImportedBranding: () => parseImportedBranding,
   programToTree: () => programToTree,
@@ -108,6 +124,7 @@ __export(index_exports, {
   sanitizeCustomCss: () => sanitizeCustomCss,
   shadowFor: () => shadowFor,
   surfacePadValue: () => surfacePadValue,
+  validatePanes: () => validatePanes,
   verticalGapValue: () => verticalGapValue,
   visibleCustomFields: () => visibleCustomFields
 });
@@ -599,23 +616,38 @@ var Connectors = class {
     );
   }
   /**
-   * Every connector's native-pane capabilities, as the router itself knows
-   * them — which rails a connector supports, and which methods it can publish
-   * as a pane with the confirm routing keys each one carries.
+   * Every connector's pane capabilities, as the router itself knows them —
+   * which rails a connector supports, and which methods it can publish as a
+   * pane with the confirm routing keys each one carries.
    *
    * Capability facts only: no label, sublabel or category comes back. A
    * designer renders a method's copy from its own locale files, keyed by
    * `key`, and takes `payment_method` / `payment_method_type` from here
    * verbatim rather than deriving them client-side.
    *
+   * This is what the pane helpers in `src/panes.ts` should be driven from —
+   * `paneMethodInfo`, `defaultPane` and `validatePanes` all take a
+   * {@link PanesConnectorCatalog} out of this response, so a connector the
+   * router starts publishing panes for needs no SDK release.
+   *
    * `GET /account/{accountId}/connectors/native-panes/catalog`
+   *
+   * The path keeps the `native-panes` spelling deliberately. The identifiers
+   * were renamed off "native pane"; the route was not, and pointing at the
+   * backend's new name before it is deployed everywhere would both 404 against
+   * un-upgraded replicas mid-rollout and fail `scripts/parity-check.mjs`,
+   * which blocks publishing.
    */
-  async getNativePanesCatalog(accountId) {
+  async getPanesCatalog(accountId) {
     return this.request(
       "GET",
       `/account/${encodeURIComponent(accountId)}/connectors/native-panes/catalog`
     );
   }
+  /** @deprecated Renamed to {@link getPanesCatalog}. Removed in 0.112.0. */
+  async getNativePanesCatalog(accountId) {
+    return this.getPanesCatalog(accountId);
+  }
   /**
    * Sweep the merchant's own e-Payouts module and return the rails it
    * actually has enabled. Server-side this makes many upstream calls, so it
@@ -6376,11 +6408,23 @@ var CheckoutSession = class {
   }
 };
 
-// src/nativePanes.ts
-var STRIPE_NATIVE_PANE_METHODS = [
+// src/panes.ts
+var PANE_VISIBILITIES = ["always", "embedded_only", "external_only"];
+function parseVisibility(raw) {
+  return PANE_VISIBILITIES.find((value) => value === raw) ?? "always";
+}
+function paneViewVisibility(view) {
+  const declared = PANE_VISIBILITIES.find((value) => value === view.visibility);
+  if (declared) return declared;
+  return view.embedded_only === true ? "embedded_only" : "always";
+}
+var STRIPE_FALLBACK_PANE_METHODS = [
   {
     key: "apple_pay",
     rail: "wallet",
+    paymentMethod: "wallet",
+    paymentMethodType: "apple_pay",
+    requiresBillingCountry: false,
     defaultLabel: "Apple Pay",
     defaultSublabel: "Pay with Apple Pay",
     defaultCategory: "wallet",
@@ -6389,6 +6433,9 @@ var STRIPE_NATIVE_PANE_METHODS = [
   {
     key: "google_pay",
     rail: "wallet",
+    paymentMethod: "wallet",
+    paymentMethodType: "google_pay",
+    requiresBillingCountry: false,
     defaultLabel: "Google Pay",
     defaultSublabel: "Pay with Google Pay",
     defaultCategory: "wallet",
@@ -6397,6 +6444,9 @@ var STRIPE_NATIVE_PANE_METHODS = [
   {
     key: "link",
     rail: "wallet",
+    paymentMethod: "wallet",
+    paymentMethodType: "link",
+    requiresBillingCountry: false,
     defaultLabel: "Link",
     defaultSublabel: "Pay with saved details",
     defaultCategory: "wallet",
@@ -6405,7 +6455,18 @@ var STRIPE_NATIVE_PANE_METHODS = [
   {
     key: "klarna",
     rail: "redirect",
+    paymentMethod: "pay_later",
+    paymentMethodType: "klarna",
+    // Stripe's Klarna needs the buyer's country echoed into the confirm body.
+    requiresBillingCountry: true,
     defaultLabel: "Klarna",
+    // NOT the router's current "Pay later or in 3 instalments". This table is
+    // what a router predating the capability endpoint (delopay-backend#964)
+    // renders, and that copy only gained the "3" in delopay-backend#1051 —
+    // the same release that added the endpoint. Restating the new string here
+    // would put copy no reachable router emits in front of a merchant, and
+    // would change what the deprecated `nativePaneMethodInfo` has returned
+    // since 0.106.0.
     defaultSublabel: "Pay later or in instalments",
     defaultCategory: "bnpl",
     defaultIcon: "bnpl"
@@ -6413,6 +6474,9 @@ var STRIPE_NATIVE_PANE_METHODS = [
   {
     key: "affirm",
     rail: "redirect",
+    paymentMethod: "pay_later",
+    paymentMethodType: "affirm",
+    requiresBillingCountry: false,
     defaultLabel: "Affirm",
     defaultSublabel: "Pay over time",
     defaultCategory: "bnpl",
@@ -6421,18 +6485,20 @@ var STRIPE_NATIVE_PANE_METHODS = [
   {
     key: "ideal",
     rail: "redirect",
+    paymentMethod: "bank_redirect",
+    paymentMethodType: "ideal",
+    requiresBillingCountry: false,
     defaultLabel: "iDEAL",
     defaultSublabel: "Pay from your bank",
     defaultCategory: "bank_redirect",
     defaultIcon: "bank"
   },
-  // eps / p24 / bancontact were removed from the router catalog: Stripe
-  // hard-requires billing fields the focused checkout never collects (full
-  // name for EPS/Bancontact, email for Przelewy24), so their tiles could
-  // never succeed. They may return behind billing-aware gating.
   {
     key: "alipay",
     rail: "redirect",
+    paymentMethod: "wallet",
+    paymentMethodType: "ali_pay",
+    requiresBillingCountry: false,
     defaultLabel: "Alipay",
     defaultSublabel: "Pay with Alipay",
     defaultCategory: "wallet",
@@ -6441,6 +6507,9 @@ var STRIPE_NATIVE_PANE_METHODS = [
   {
     key: "revolut_pay",
     rail: "redirect",
+    paymentMethod: "wallet",
+    paymentMethodType: "revolut_pay",
+    requiresBillingCountry: false,
     defaultLabel: "Revolut Pay",
     defaultSublabel: "Pay with Revolut",
     defaultCategory: "wallet",
@@ -6449,13 +6518,33 @@ var STRIPE_NATIVE_PANE_METHODS = [
   {
     key: "amazon_pay",
     rail: "redirect",
+    paymentMethod: "wallet",
+    paymentMethodType: "amazon_pay",
+    requiresBillingCountry: false,
     defaultLabel: "Amazon Pay",
     defaultSublabel: "Pay with Amazon",
     defaultCategory: "wallet",
     defaultIcon: "wallet"
   }
 ];
-var NATIVE_PANE_ICON_KEYS = [
+var STRIPE_FALLBACK_PANE_CATALOG = {
+  connector: "stripe",
+  allowed_rails: ["wallet", "redirect"],
+  methods: STRIPE_FALLBACK_PANE_METHODS.map((info) => ({
+    key: info.key,
+    rail: info.rail,
+    payment_method: info.paymentMethod,
+    payment_method_type: info.paymentMethodType,
+    requires_billing_country: info.requiresBillingCountry
+  }))
+};
+function emptyPaneCatalog(connector) {
+  return { connector, allowed_rails: [], methods: [] };
+}
+function paneCatalogFor(response, connector) {
+  return response.connectors.find((entry) => entry.connector === connector) ?? emptyPaneCatalog(connector);
+}
+var PANE_ICON_KEYS = [
   "wallet",
   "card",
   "bank",
@@ -6464,20 +6553,70 @@ var NATIVE_PANE_ICON_KEYS = [
   "bnpl",
   "cash"
 ];
-var NATIVE_PANE_CATEGORY_KEYS = [
+var PANE_CATEGORY_KEYS = [
   "wallet",
   "card",
   "bnpl",
   "bank_redirect",
   "bank_transfer",
+  "crypto",
+  "game_items",
   "cash"
 ];
-var NATIVE_PANES_MAX = 12;
-function nativePaneMethodInfo(method) {
-  return STRIPE_NATIVE_PANE_METHODS.find((m) => m.key === method);
+var PANES_MAX = 12;
+function paneMethodInfo(method, catalog = STRIPE_FALLBACK_PANE_CATALOG) {
+  return catalog.methods.find((info) => info.key === method);
 }
-function defaultNativePane(method) {
-  const info = nativePaneMethodInfo(method);
+function paneRailAllowed(rail, catalog) {
+  return catalog.allowed_rails.includes(rail);
+}
+function offerablePaneMethods(catalog) {
+  return catalog.methods.filter((info) => paneRailAllowed(info.rail, catalog));
+}
+var DISPLAY_DEFAULTS_BY_KEY = {
+  apple_pay: { icon: "apple", category: "wallet" },
+  google_pay: { icon: "google", category: "wallet" }
+};
+var DISPLAY_DEFAULTS_BY_PAYMENT_METHOD = {
+  wallet: { icon: "wallet", category: "wallet" },
+  card: { icon: "card", category: "card" },
+  card_redirect: { icon: "card", category: "card" },
+  pay_later: { icon: "bnpl", category: "bnpl" },
+  bank_redirect: { icon: "bank", category: "bank_redirect" },
+  bank_transfer: { icon: "bank", category: "bank_transfer" },
+  bank_debit: { icon: "bank", category: "bank_transfer" },
+  crypto: { icon: "wallet", category: "crypto" },
+  game_items: { icon: "wallet", category: "game_items" },
+  cash: { icon: "cash", category: "cash" },
+  voucher: { icon: "cash", category: "cash" }
+};
+var DISPLAY_DEFAULTS_FALLBACK = { icon: "wallet", category: "wallet" };
+function paneDisplayDefaults(info) {
+  if (!info) return DISPLAY_DEFAULTS_FALLBACK;
+  return DISPLAY_DEFAULTS_BY_KEY[info.key] ?? DISPLAY_DEFAULTS_BY_PAYMENT_METHOD[info.payment_method] ?? DISPLAY_DEFAULTS_FALLBACK;
+}
+function validatePanes(panes, catalog = STRIPE_FALLBACK_PANE_CATALOG) {
+  const issues = [];
+  const claimedBy = /* @__PURE__ */ new Set();
+  panes.forEach((pane, index) => {
+    const info = paneMethodInfo(pane.method, catalog);
+    if (!info) {
+      issues.push({ index, method: pane.method, code: "method_unknown" });
+    } else if (!paneRailAllowed(info.rail, catalog)) {
+      issues.push({ index, method: pane.method, code: "rail_not_allowed" });
+    } else if (pane.enabled) {
+      if (claimedBy.has(info.key)) {
+        issues.push({ index, method: pane.method, code: "duplicate_method" });
+      } else {
+        claimedBy.add(info.key);
+      }
+    }
+    if (index >= PANES_MAX) issues.push({ index, method: pane.method, code: "over_cap" });
+  });
+  return issues;
+}
+function defaultPane(method, catalog = STRIPE_FALLBACK_PANE_CATALOG) {
+  const defaults = paneDisplayDefaults(paneMethodInfo(method, catalog));
   return {
     method,
     enabled: true,
@@ -6485,15 +6624,15 @@ function defaultNativePane(method) {
     labelTranslations: {},
     sublabel: null,
     sublabelTranslations: {},
-    category: "",
-    icon: info?.defaultIcon ?? "",
+    category: defaults.category,
+    icon: defaults.icon,
     iconSvg: "",
     displayOrder: 0,
     visibility: "always",
     openIn: "tab"
   };
 }
-function cloneNativePane(pane) {
+function clonePane(pane) {
   return {
     ...pane,
     labelTranslations: { ...pane.labelTranslations },
@@ -6520,7 +6659,7 @@ function clampDisplayOrder(raw) {
   if (!Number.isFinite(raw)) return 0;
   return Math.min(DISPLAY_ORDER_MAX, Math.max(DISPLAY_ORDER_MIN, Math.trunc(raw)));
 }
-function decodeNativePanes(raw) {
+function decodePanes(raw) {
   if (!Array.isArray(raw)) return null;
   const decodeRow = (entry, method) => ({
     method,
@@ -6534,14 +6673,14 @@ function decodeNativePanes(raw) {
     iconSvg: str(entry["icon_svg"]),
     displayOrder: clampDisplayOrder(Number(entry["display_order"])),
     // Anything unrecognised degrades to `always` rather than dropping the row.
-    visibility: entry["visibility"] === "embedded_only" ? "embedded_only" : "always",
+    visibility: parseVisibility(entry["visibility"]),
     // Same tolerance: an unknown value degrades to the default `tab`.
     openIn: entry["open_in"] === "popup" ? "popup" : "tab"
   });
   const indexByMethod = /* @__PURE__ */ new Map();
   const out = [];
   for (const entry of raw) {
-    if (out.length >= NATIVE_PANES_MAX) break;
+    if (out.length >= PANES_MAX) break;
     if (!isObject2(entry)) continue;
     const method = str(entry["method"]).trim();
     if (!method) continue;
@@ -6557,12 +6696,12 @@ function decodeNativePanes(raw) {
   }
   return out;
 }
-function encodeNativePanes(panes) {
+function encodePanes(panes) {
   const nonEmpty = (map) => {
     const entries = Object.entries(map).filter(([, v]) => v.trim().length > 0);
     return entries.length > 0 ? Object.fromEntries(entries) : void 0;
   };
-  return panes.slice(0, NATIVE_PANES_MAX).map((pane) => {
+  return panes.slice(0, PANES_MAX).map((pane) => {
     const labelTranslations = nonEmpty(pane.labelTranslations);
     const sublabelTranslations = nonEmpty(pane.sublabelTranslations);
     return {
@@ -6570,7 +6709,7 @@ function encodeNativePanes(panes) {
       enabled: pane.enabled,
       ...pane.label.trim() ? { label: pane.label.trim() } : {},
       ...labelTranslations ? { label_translations: labelTranslations } : {},
-      // `null` omits the key entirely (catalog default wins); `''` is sent
+      // `null` omits the key entirely (catalogue default wins); `''` is sent
       // as-is because that is how the merchant hides the second line.
       ...pane.sublabel !== null ? { sublabel: pane.sublabel } : {},
       ...sublabelTranslations ? { sublabel_translations: sublabelTranslations } : {},
@@ -6582,8 +6721,13 @@ function encodeNativePanes(panes) {
       // writing e.g. 3.5 or Date.now() verbatim would silently delete the
       // pane at render while every read surface shows it healthy.
       display_order: clampDisplayOrder(pane.displayOrder),
-      visibility: pane.visibility,
-      open_in: pane.openIn
+      // Normalised on encode for the same reason `display_order` is clamped:
+      // the router's strict row decode drops a row whole on a value outside
+      // its enum, and a caller who built a `Pane` by hand (or in plain JS)
+      // never went through `decodePanes`. A decoded pane always holds a valid
+      // value, so this is a no-op on the round-trip path.
+      visibility: parseVisibility(pane.visibility),
+      open_in: pane.openIn === "popup" ? "popup" : "tab"
     };
   });
 }
@@ -6593,6 +6737,10 @@ function focusedCheckoutUrl(params) {
     params.paymentId
   )}`;
   const query = new URLSearchParams({ pane: params.method });
+  const connector = params.connector?.trim();
+  if (connector) query.set("connector", connector);
+  const merchantConnectorId = params.merchantConnectorId?.trim();
+  if (merchantConnectorId) query.set("mca", merchantConnectorId);
   if (params.locale) query.set("locale", params.locale);
   if (params.customFieldsCollected) query.set("cf", "1");
   return `${path}?${query.toString()}`;
@@ -6604,6 +6752,24 @@ var CHECKOUT_EVENT_KINDS = [
   "native_pane_abandoned",
   "native_pane_returned"
 ];
+var STRIPE_NATIVE_PANE_METHODS = STRIPE_FALLBACK_PANE_METHODS;
+var NATIVE_PANE_ICON_KEYS = PANE_ICON_KEYS;
+var NATIVE_PANE_CATEGORY_KEYS = PANE_CATEGORY_KEYS;
+var NATIVE_PANES_MAX = PANES_MAX;
+function nativePaneMethodInfo(method) {
+  return STRIPE_FALLBACK_PANE_METHODS.find((info) => info.key === method);
+}
+function defaultNativePane(method) {
+  const info = nativePaneMethodInfo(method);
+  return {
+    ...defaultPane(method),
+    category: "",
+    icon: info?.defaultIcon ?? ""
+  };
+}
+var cloneNativePane = clonePane;
+var decodeNativePanes = decodePanes;
+var encodeNativePanes = encodePanes;
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   ALL_CUSTOM_FIELD_CONDITION_SOURCES,
@@ -6641,8 +6807,13 @@ var CHECKOUT_EVENT_KINDS = [
   NATIVE_PANE_CATEGORY_KEYS,
   NATIVE_PANE_ICON_KEYS,
   OperationLimits,
+  PANES_MAX,
+  PANE_CATEGORY_KEYS,
+  PANE_ICON_KEYS,
   Regions,
   Risk,
+  STRIPE_FALLBACK_PANE_CATALOG,
+  STRIPE_FALLBACK_PANE_METHODS,
   STRIPE_NATIVE_PANE_METHODS,
   Search,
   Settlement,
@@ -6656,6 +6827,7 @@ var CHECKOUT_EVENT_KINDS = [
   cloneBranding,
   cloneCustomField,
   cloneNativePane,
+  clonePane,
   customFieldContextFromMetadata,
   customFieldIsTextLike,
   customFieldOperatorTakesValue,
@@ -6665,14 +6837,18 @@ var CHECKOUT_EVENT_KINDS = [
   decodeBranding,
   decodeCustomFields,
   decodeNativePanes,
+  decodePanes,
   defaultBranding,
   defaultCustomFieldVisibility,
   defaultNativePane,
   defaultOperatorForSource,
+  defaultPane,
+  emptyPaneCatalog,
   encodeBadges,
   encodeBranding,
   encodeCustomFields,
   encodeNativePanes,
+  encodePanes,
   evaluateCustomFieldCondition,
   evaluateCustomFieldVisibility,
   feeProgram,
@@ -6686,6 +6862,12 @@ var CHECKOUT_EVENT_KINDS = [
   leaf,
   logoDimensions,
   nativePaneMethodInfo,
+  offerablePaneMethods,
+  paneCatalogFor,
+  paneDisplayDefaults,
+  paneMethodInfo,
+  paneRailAllowed,
+  paneViewVisibility,
   parseCustomFieldsLoose,
   parseImportedBranding,
   programToTree,
@@ -6694,6 +6876,7 @@ var CHECKOUT_EVENT_KINDS = [
   sanitizeCustomCss,
   shadowFor,
   surfacePadValue,
+  validatePanes,
   verticalGapValue,
   visibleCustomFields
 });