@delopay/sdk 0.248.0 → 0.255.0

package/dist/index.cjs

@@ -41,6 +41,7 @@ __export(index_exports, {
   AvailabilityOverrides: () => AvailabilityOverrides,
   BRANDING_EXPORT_FORMAT: () => BRANDING_EXPORT_FORMAT,
   BRANDING_EXPORT_VERSION: () => BRANDING_EXPORT_VERSION,
+  BUILTIN_PAYMENT_ICON_KEYS: () => BUILTIN_PAYMENT_ICON_KEYS,
   BuyerBlocklist: () => BuyerBlocklist,
   CARD_FIELD_CHROMES: () => CARD_FIELD_CHROMES,
   CARD_FIELD_FONT_SIZES: () => CARD_FIELD_FONT_SIZES,
@@ -102,7 +103,9 @@ __export(index_exports, {
   PANE_ICON_KEYS: () => PANE_ICON_KEYS,
   PAYPAL_CARD_LAYOUTS: () => PAYPAL_CARD_LAYOUTS,
   PAYPAL_LABEL_STYLES: () => PAYPAL_LABEL_STYLES,
+  PRESENTATION_CONTRACT_VERSION: () => PRESENTATION_CONTRACT_VERSION,
   PaypalDisputes: () => PaypalDisputes,
+  PresentationCache: () => PresentationCache,
   ProcessorCosts: () => ProcessorCosts,
   Products: () => Products,
   RTL_CHECKOUT_LOCALES: () => RTL_CHECKOUT_LOCALES,
@@ -156,6 +159,8 @@ __export(index_exports, {
   applyBrandingVariables: () => applyBrandingVariables,
   asAirwallexCardPreset: () => asAirwallexCardPreset,
   buildBrandingExport: () => buildBrandingExport,
+  builtinPaymentIconDataUri: () => builtinPaymentIconDataUri,
+  builtinPaymentIconSvg: () => builtinPaymentIconSvg,
   buttonPadValue: () => buttonPadValue,
   canonicalSectionId: () => canonicalSectionId,
   cardFieldFontPx: () => cardFieldFontPx,
@@ -213,6 +218,7 @@ __export(index_exports, {
   isNoticeIcon: () => isNoticeIcon,
   isSubscriptionDisputeWebhook: () => isSubscriptionDisputeWebhook,
   isSubscriptionLifecycleWebhook: () => isSubscriptionLifecycleWebhook,
+  isSupportedPresentation: () => isSupportedPresentation,
   knownSectionLabelKey: () => knownSectionLabelKey,
   leaf: () => leaf,
   logoDimensions: () => logoDimensions,
@@ -230,6 +236,9 @@ __export(index_exports, {
   parseCustomFieldsLoose: () => parseCustomFieldsLoose,
   parseImportedBranding: () => parseImportedBranding,
   parseNoticesLoose: () => parseNoticesLoose,
+  presentationIconDataUri: () => presentationIconDataUri,
+  presentationIconSrc: () => presentationIconSrc,
+  presentationTiers: () => presentationTiers,
   programToTree: () => programToTree,
   radiusValue: () => radiusValue,
   readableInkOn: () => readableInkOn,
@@ -244,6 +253,7 @@ __export(index_exports, {
   sanitizeCustomCss: () => sanitizeCustomCss,
   sectionLabel: () => sectionLabel,
   sectionOrderOf: () => sectionOrderOf,
+  selectableEntries: () => selectableEntries,
   shadowFor: () => shadowFor,
   shownNotices: () => shownNotices,
   stripeSpacingValues: () => stripeSpacingValues,
@@ -1227,11 +1237,92 @@ var Connectors = class {
       { body: params }
     );
   }
+  /**
+   * Every webhook the connector's payment provider lists for its credentials
+   * in one environment: Delopay's own, other connector accounts', former
+   * addresses' and other integrations'.
+   * `GET /account/{merchantId}/connectors/webhooks/{connectorId}/provider`
+   *
+   * Available for Stripe, PayPal, Airwallex, Whop and Adyen. Destinations are
+   * masked; `capabilities` says which changes the provider allows and
+   * `editable` whether the caller may make them.
+   */
+  async listProviderWebhooks(merchantId, connectorId, environment) {
+    return this.request("GET", providerWebhooksPath(merchantId, connectorId), {
+      query: { environment }
+    });
+  }
+  /**
+   * Create a webhook at the provider for the merchant's own systems.
+   * `POST /account/{merchantId}/connectors/webhooks/{connectorId}/provider`
+   *
+   * The URL must be `https` and outside Delopay; Delopay's own webhook is
+   * registered with `registerWebhook`. A returned `signing_secret` is not kept
+   * by Delopay and cannot be read again.
+   */
+  async createProviderWebhook(merchantId, connectorId, params) {
+    return this.request("POST", providerWebhooksPath(merchantId, connectorId), { body: params });
+  }
+  /**
+   * Change one webhook at the provider.
+   * `PATCH /account/{merchantId}/connectors/webhooks/{connectorId}/provider/{webhookId}`
+   *
+   * Refused once the webhook changed since `fingerprint`, and for Delopay's
+   * own webhooks.
+   */
+  async updateProviderWebhook(merchantId, connectorId, webhookId, params) {
+    return this.request(
+      "PATCH",
+      `${providerWebhooksPath(merchantId, connectorId)}/${encodeURIComponent(webhookId)}`,
+      { body: params }
+    );
+  }
+  /**
+   * Delete one webhook at the provider.
+   * `POST /account/{merchantId}/connectors/webhooks/{connectorId}/provider/{webhookId}/delete`
+   *
+   * Refused once the webhook changed since `fingerprint`. Deleting Delopay's
+   * own webhook needs `confirm_managed: true`; another connector account's is
+   * never deleted from here.
+   */
+  async deleteProviderWebhook(merchantId, connectorId, webhookId, params) {
+    return this.request(
+      "POST",
+      `${providerWebhooksPath(merchantId, connectorId)}/${encodeURIComponent(webhookId)}/delete`,
+      { body: params }
+    );
+  }
+  /**
+   * What "replace all" would delete and keep. Nothing is changed.
+   * `GET /account/{merchantId}/connectors/webhooks/{connectorId}/provider/replace`
+   */
+  async previewProviderWebhookReplace(merchantId, connectorId, environment) {
+    return this.request("GET", `${providerWebhooksPath(merchantId, connectorId)}/replace`, {
+      query: { environment }
+    });
+  }
+  /**
+   * Keep only Delopay's webhook: delete exactly the confirmed webhooks of the
+   * preview, after registering Delopay's own unless `sequence` is
+   * `delete_first`.
+   * `POST /account/{merchantId}/connectors/webhooks/{connectorId}/provider/replace`
+   *
+   * A list that changed since the preview answers `scope_changed` and deletes
+   * nothing. A second replacement while one runs is refused as busy (`HE_00`).
+   */
+  async replaceProviderWebhooks(merchantId, connectorId, params) {
+    return this.request("POST", `${providerWebhooksPath(merchantId, connectorId)}/replace`, {
+      body: params
+    });
+  }
   /** List available payment methods. `GET /account/payment-methods` */
   async listPaymentMethods() {
     return this.request("GET", "/account/payment-methods");
   }
 };
+function providerWebhooksPath(merchantId, connectorId) {
+  return `/account/${encodeURIComponent(merchantId)}/connectors/webhooks/${encodeURIComponent(connectorId)}/provider`;
+}
 
 // src/resources/customers.ts
 function toQuery(params) {
@@ -2404,6 +2495,44 @@ var PaymentMethods = class {
       query: params
     });
   }
+  /**
+   * The shop's payment buttons as the hosted checkout draws them: order,
+   * labels in the shop's or caller's language, artwork, and what selecting
+   * each one does. For rendering payment buttons on your own site without a
+   * local table of provider names and icons.
+   *
+   * With a secret key, name the shop (`profile_id`) and optionally the
+   * environment and a buyer context; the answer may be reused for
+   * `cache.max_age_seconds` — {@link PresentationCache} does that. With a
+   * publishable key, pass the payment's `client_secret` (or use
+   * `CheckoutSession.paymentMethodPresentation`); that answer is never reused.
+   *
+   * A displayed entry is not a promise: the payment is confirmed against the
+   * current configuration.
+   *
+   * `GET /account/payment-methods/presentation`
+   *
+   * @example
+   * ```typescript
+   * const buttons = await delopay.paymentMethods.presentation({
+   *   profile_id: 'pro_123',
+   *   country: 'DE',
+   *   currency: 'EUR',
+   *   amount: 4999,
+   *   locale: 'de',
+   * });
+   * for (const entry of buttons.entries) {
+   *   if (entry.kind === 'heading') renderHeading(entry.label);
+   *   else renderButton(entry.label, entry.sublabel, presentationIconSrc(entry));
+   * }
+   * ```
+   */
+  async presentation(params, options) {
+    return this.request("GET", "/account/payment-methods/presentation", {
+      query: params,
+      ...options
+    });
+  }
   /**
    * List all saved payment methods for a customer, optionally filtered.
    *
@@ -7246,7 +7375,7 @@ var BuyerAccount = class {
   constructor(request) {
     this.request = request;
   }
-  /** Whether buyers can sign in by email on this platform, and how. */
+  /** Whether buyers can sign in on this platform, and which methods are offered. */
   async availability(options) {
     return this.request("GET", "/buyer-account/availability", { ...options });
   }
@@ -12634,7 +12763,195 @@ var CheckoutSession = class {
       headers: this.pkHeaders(options?.headers)
     });
   }
+  /**
+   * This payment's checkout buttons, as the hosted checkout draws them: order,
+   * labels, artwork, and what selecting each one does. The shop, environment,
+   * currency and amount are the payment's. Ask again when the cart changes;
+   * an answer is never reused for another payment.
+   *
+   * `GET /account/payment-methods/presentation` (publishable key + client secret)
+   *
+   * @param params - `country` outranks the billing address and IP
+   *   geolocation; `locale` names the language of the labels.
+   */
+  async paymentMethodPresentation(params, options) {
+    return this.client.request("GET", "/account/payment-methods/presentation", {
+      query: {
+        client_secret: this.requireClientSecret(),
+        country: params?.country,
+        locale: params?.locale,
+        contract_version: params?.contract_version
+      },
+      ...options,
+      headers: this.pkHeaders(options?.headers)
+    });
+  }
+};
+
+// src/paymentPresentation.ts
+var PRESENTATION_CONTRACT_VERSION = 1;
+var BUILTIN_PAYMENT_ICON_KEYS = [
+  "wallet",
+  "card",
+  "bank",
+  "apple",
+  "google",
+  "bnpl",
+  "cash",
+  "paypal",
+  "klarna",
+  "crypto"
+];
+var SVG_OPEN = '<svg xmlns="http://www.w3.org/2000/svg"';
+function glyph(key, color) {
+  const line = (body) => `${SVG_OPEN} viewBox="0 0 24 24" fill="none" stroke="${color}" stroke-width="1.6" stroke-linecap="round" stroke-linejoin="round">${body}</svg>`;
+  switch (key) {
+    case "card":
+      return line('<rect x="2" y="5" width="20" height="14" rx="2"/><path d="M2 10h20"/>');
+    case "bank":
+      return line(
+        '<path d="M3 10h18"/><path d="m12 3 9 5H3l9-5Z"/><path d="M6 10v7M10 10v7M14 10v7M18 10v7"/><path d="M3 20h18"/>'
+      );
+    case "bnpl":
+      return line(
+        '<rect x="2" y="6" width="20" height="12" rx="2"/><path d="M6 12h4"/><path d="M14 10v4"/><path d="M18 10v4"/>'
+      );
+    case "cash":
+      return line(
+        '<rect x="2" y="6" width="20" height="12" rx="2"/><circle cx="12" cy="12" r="2.5"/><path d="M6 12h.01M18 12h.01"/>'
+      );
+    case "apple":
+      return `${SVG_OPEN} viewBox="0 0 384 512" fill="${color}"><path d="M318.7 268.7c-.2-36.7 16.4-64.4 50-84.8-18.8-26.9-47.2-41.7-84.7-44.6-35.5-2.8-74.3 20.7-88.5 20.7-15 0-49.4-19.7-76.4-19.7C63.3 141.2 4 184.8 4 273.5q0 39.3 14.4 81.2c12.8 36.7 59 126.7 107.2 125.2 25.2-.6 43-17.9 75.8-17.9 31.8 0 48.3 17.9 76.4 17.9 48.6-.7 90.4-82.5 102.6-119.3-65.2-30.7-61.7-90-61.7-91.9zm-56.6-164.2c27.3-32.4 24.8-61.9 24-72.5-24.1 1.4-52 16.4-67.9 34.9-17.5 19.8-27.8 44.3-25.6 71.9 26.1 2 49.9-11.4 69.5-34.3z"/></svg>`;
+    case "google":
+      return `${SVG_OPEN} viewBox="0 0 48 48"><path fill="#4285F4" d="M45.12 24.5c0-1.56-.14-3.06-.4-4.5H24v8.51h11.84c-.51 2.75-2.06 5.08-4.39 6.64v5.52h7.11c4.16-3.83 6.56-9.47 6.56-16.17z"/><path fill="#34A853" d="M24 46c5.94 0 10.92-1.97 14.56-5.33l-7.11-5.52c-1.97 1.32-4.49 2.1-7.45 2.1-5.73 0-10.58-3.87-12.31-9.07H4.34v5.7C7.96 41.07 15.4 46 24 46z"/><path fill="#FBBC05" d="M11.69 28.18C11.25 26.86 11 25.45 11 24s.25-2.86.69-4.18v-5.7H4.34C2.85 17.09 2 20.45 2 24s.85 6.91 2.34 9.88l7.35-5.7z"/><path fill="#EA4335" d="M24 10.75c3.23 0 6.13 1.11 8.41 3.29l6.31-6.31C34.91 4.18 29.93 2 24 2 15.4 2 7.96 6.93 4.34 14.12l7.35 5.7c1.73-5.2 6.58-9.07 12.31-9.07z"/></svg>`;
+    case "paypal":
+      return `${SVG_OPEN} viewBox="0 0 32 32"><path d="M9 4h7.2c3.4 0 6 2.4 5.6 5.8-.4 3.6-3.5 6-7.1 6h-3.2L10.4 23H6.7L9 4z" fill="#003087"/><path d="M13 8.5h7.2c3.4 0 6 2.4 5.6 5.8-.4 3.6-3.5 6-7.1 6h-3.2L14.4 27.5H10.7L13 8.5z" fill="#009cde"/></svg>`;
+    case "klarna":
+      return `${SVG_OPEN} viewBox="0 0 24 24"><rect width="24" height="24" rx="6" fill="#FFA8CD"/><path fill="#0B051D" d="M8 6h2.7v12H8V6zm6.5 0h2.5c-.4 2.7-1.5 5-3 6.6 1.6 1.6 2.7 3.6 3.2 5.4h-2.7c-.5-1.6-1.4-3-2.7-4.2v4.2H10V12c2.1-1 3.8-3.2 4.5-6z"/></svg>`;
+    case "crypto":
+      return `${SVG_OPEN} viewBox="0 0 64 64"><path fill="#F7931A" d="m63.033,39.744c-4.274,17.143-21.637,27.576-38.782,23.301-17.138-4.274-27.571-21.638-23.295-38.78,4.272-17.145,21.635-27.579,38.775-23.305,17.144,4.274,27.576,21.64,23.302,38.784z"/><path fill="#FFF" d="m46.103,27.444c0.637-4.258-2.605-6.547-7.038-8.074l1.438-5.768-3.511-0.875-1.4,5.616c-0.923-0.23-1.871-0.447-2.813-0.662l1.41-5.653-3.509-0.875-1.439,5.766c-0.764-0.174-1.514-0.346-2.242-0.527l0.004-0.018-4.842-1.209-0.934,3.75s2.605,0.597,2.55,0.634c1.422,0.355,1.679,1.296,1.636,2.042l-1.638,6.571c0.098,0.025,0.225,0.061,0.365,0.117-0.117-0.029-0.242-0.061-0.371-0.092l-2.296,9.205c-0.174,0.432-0.615,1.08-1.609,0.834,0.035,0.051-2.552-0.637-2.552-0.637l-1.743,4.019,4.569,1.139c0.85,0.213,1.683,0.436,2.503,0.646l-1.453,5.834,3.507,0.875,1.439-5.772c0.958,0.26,1.888,0.5,2.798,0.726l-1.434,5.745,3.511,0.875,1.453-5.823c5.987,1.133,10.489,0.676,12.384-4.739,1.527-4.36-0.076-6.875-3.226-8.515,2.294-0.529,4.022-2.038,4.483-5.155zm-8.022,11.249c-1.085,4.36-8.426,2.003-10.806,1.412l1.928-7.729c2.38,0.594,10.012,1.77,8.878,6.317zm1.086-11.312c-0.99,3.966-7.1,1.951-9.082,1.457l1.748-7.01c1.982,0.494,8.365,1.416,7.334,5.553z"/></svg>`;
+    case "wallet":
+      return line(
+        '<path d="M3 7a2 2 0 0 1 2-2h12a2 2 0 0 1 2 2"/><rect x="3" y="7" width="18" height="12" rx="2"/><path d="M16 13h3"/>'
+      );
+  }
+}
+function isBuiltinKey(key) {
+  return BUILTIN_PAYMENT_ICON_KEYS.includes(key);
+}
+function builtinPaymentIconSvg(key, color = "#1f2937") {
+  return glyph(isBuiltinKey(key) ? key : "wallet", color);
+}
+function builtinPaymentIconDataUri(key, color) {
+  return `data:image/svg+xml;charset=utf-8,${encodeURIComponent(builtinPaymentIconSvg(key, color))}`;
+}
+function presentationIconDataUri(icon, color) {
+  return icon.type === "svg" ? icon.data_uri : builtinPaymentIconDataUri(icon.key, color);
+}
+function presentationIconSrc(entry, color) {
+  if (entry.icon) return presentationIconDataUri(entry.icon, color);
+  if (entry.fallback_icon) return builtinPaymentIconDataUri(entry.fallback_icon, color);
+  return null;
+}
+function isSupportedPresentation(response) {
+  return response.contract_version === PRESENTATION_CONTRACT_VERSION;
+}
+function presentationTiers(response) {
+  const out = { express: [], normal: [], alternative: [] };
+  for (const entry of response.entries) {
+    if (entry.tier === "express") {
+      const row = entry.row ?? 0;
+      while (out.express.length <= row) out.express.push([]);
+      out.express[row]?.push(entry);
+    } else {
+      out[entry.tier].push(entry);
+    }
+  }
+  out.express = out.express.filter((row) => row.length > 0);
+  return out;
+}
+function selectableEntries(response) {
+  return response.entries.filter((entry) => entry.action !== void 0);
+}
+var PresentationCache = class _PresentationCache {
+  constructor(options) {
+    this.slots = /* @__PURE__ */ new Map();
+    this.load = options.load;
+    this.now = options.now ?? Date.now;
+    this.maxEntries = options.maxEntries ?? 500;
+  }
+  /** The key two requests share exactly when DeloPay would answer them alike. */
+  static keyOf(params) {
+    return JSON.stringify([
+      params.profile_id ?? null,
+      params.environment ?? "live",
+      params.locale?.toLowerCase() ?? null,
+      params.country?.toUpperCase() ?? null,
+      params.currency ?? null,
+      params.amount ?? null,
+      params.contract_version ?? PRESENTATION_CONTRACT_VERSION
+    ]);
+  }
+  async get(params) {
+    const request = {
+      ...params,
+      contract_version: params.contract_version ?? PRESENTATION_CONTRACT_VERSION
+    };
+    if (request.client_secret) {
+      return { response: await this.load(request, {}), stale: false };
+    }
+    const key = _PresentationCache.keyOf(request);
+    const slot = this.slots.get(key);
+    const now = this.now();
+    if (slot && now - slot.fetchedAt < slot.response.cache.max_age_seconds * 1e3) {
+      return { response: slot.response, stale: false };
+    }
+    try {
+      const response = await this.load(
+        request,
+        slot ? { headers: { "If-None-Match": `"${slot.response.revision}"` } } : {}
+      );
+      this.store(key, response, now);
+      return { response, stale: false };
+    } catch (error) {
+      if (slot && error instanceof DelopayError && error.status === 304) {
+        this.store(key, slot.response, now);
+        return { response: slot.response, stale: false };
+      }
+      const policy = slot?.response.cache;
+      const usableUntil = slot ? slot.fetchedAt + ((policy?.max_age_seconds ?? 0) + (policy?.stale_if_error_seconds ?? 0)) * 1e3 : 0;
+      if (slot && isUnavailable(error) && now < usableUntil) {
+        return { response: slot.response, stale: true };
+      }
+      if (slot && isRefusal(error)) this.slots.delete(key);
+      throw error;
+    }
+  }
+  /** Forget every answer, e.g. after the merchant changes the checkout editor. */
+  clear() {
+    this.slots.clear();
+  }
+  store(key, response, now) {
+    if (response.cache.max_age_seconds <= 0) {
+      this.slots.delete(key);
+      return;
+    }
+    this.slots.delete(key);
+    this.slots.set(key, { response, fetchedAt: now });
+    while (this.slots.size > this.maxEntries) {
+      const oldest = this.slots.keys().next().value;
+      if (oldest === void 0) break;
+      this.slots.delete(oldest);
+    }
+  }
 };
+function isRefusal(error) {
+  return error instanceof DelopayError && error.status >= 400 && error.status < 500 && error.status !== 429;
+}
+function isUnavailable(error) {
+  if (!(error instanceof DelopayError)) return false;
+  return error.status === 0 || error.status === 429 || error.status >= 500;
+}
 
 // src/panes.ts
 var PANE_VISIBILITIES = ["always", "embedded_only", "external_only"];
@@ -13064,6 +13381,7 @@ var encodeNativePanes = encodePanes;
   AvailabilityOverrides,
   BRANDING_EXPORT_FORMAT,
   BRANDING_EXPORT_VERSION,
+  BUILTIN_PAYMENT_ICON_KEYS,
   BuyerBlocklist,
   CARD_FIELD_CHROMES,
   CARD_FIELD_FONT_SIZES,
@@ -13125,7 +13443,9 @@ var encodeNativePanes = encodePanes;
   PANE_ICON_KEYS,
   PAYPAL_CARD_LAYOUTS,
   PAYPAL_LABEL_STYLES,
+  PRESENTATION_CONTRACT_VERSION,
   PaypalDisputes,
+  PresentationCache,
   ProcessorCosts,
   Products,
   RTL_CHECKOUT_LOCALES,
@@ -13179,6 +13499,8 @@ var encodeNativePanes = encodePanes;
   applyBrandingVariables,
   asAirwallexCardPreset,
   buildBrandingExport,
+  builtinPaymentIconDataUri,
+  builtinPaymentIconSvg,
   buttonPadValue,
   canonicalSectionId,
   cardFieldFontPx,
@@ -13236,6 +13558,7 @@ var encodeNativePanes = encodePanes;
   isNoticeIcon,
   isSubscriptionDisputeWebhook,
   isSubscriptionLifecycleWebhook,
+  isSupportedPresentation,
   knownSectionLabelKey,
   leaf,
   logoDimensions,
@@ -13253,6 +13576,9 @@ var encodeNativePanes = encodePanes;
   parseCustomFieldsLoose,
   parseImportedBranding,
   parseNoticesLoose,
+  presentationIconDataUri,
+  presentationIconSrc,
+  presentationTiers,
   programToTree,
   radiusValue,
   readableInkOn,
@@ -13267,6 +13593,7 @@ var encodeNativePanes = encodePanes;
   sanitizeCustomCss,
   sectionLabel,
   sectionOrderOf,
+  selectableEntries,
   shadowFor,
   shownNotices,
   stripeSpacingValues,