@peable.to/contracts 5.2.0 → 5.4.0

package/dist/types/resources/checkout/shared.d.ts

@@ -288,14 +288,23 @@ export declare const amountParam: z.ZodString;
 export declare const redirectUrlParam: z.ZodString;
 /** `auto` follows the payer's browser: parsed as `null`. */
 export declare const localeParam: z.ZodPipe<z.ZodEnum<{
+    id: "id";
+    ar: "ar";
+    bn: "bn";
+    ca: "ca";
+    de: "de";
     en: "en";
     es: "es";
     fr: "fr";
-    de: "de";
+    hi: "hi";
     it: "it";
+    ja: "ja";
     pt: "pt";
+    ru: "ru";
+    tr: "tr";
+    zh: "zh";
     auto: "auto";
-}>, z.ZodTransform<"en" | "es" | "fr" | "de" | "it" | "pt" | null, "en" | "es" | "fr" | "de" | "it" | "pt" | "auto">>;
+}>, z.ZodTransform<"id" | "ar" | "bn" | "ca" | "de" | "en" | "es" | "fr" | "hi" | "it" | "ja" | "pt" | "ru" | "tr" | "zh" | null, "id" | "ar" | "bn" | "ca" | "de" | "en" | "es" | "fr" | "hi" | "it" | "ja" | "pt" | "ru" | "tr" | "zh" | "auto">>;
 export declare const checkoutEmailParam: z.ZodString;
 declare const customFieldParam: z.ZodObject<{
     key: z.ZodString;

package/dist/types/vocabulary/checkout.d.ts

@@ -7,7 +7,8 @@
  *  - `faircoin_network_closed` — this deployment does not open payments on the
  *    order's FairCoin network yet (ADR 0002's gate);
  *  - `price_unavailable` — no fresh FairCoin price exists to quote a fiat order;
- *  - `temporarily_unavailable` — whether the wallet exists could not be checked.
+ *  - `temporarily_unavailable` — whether the wallet exists could not be checked, or every
+ *    address the recipient can hold open is open (ADR 0021 D9) — try again shortly.
  */
 export declare const FAIRCOIN_UNAVAILABLE_REASONS: readonly ["faircoin_wallet_missing", "faircoin_network_closed", "price_unavailable", "temporarily_unavailable"];
 export type FaircoinUnavailableReason = (typeof FAIRCOIN_UNAVAILABLE_REASONS)[number];
@@ -19,9 +20,23 @@ export declare const CHECKOUT_PAYMENT_STATUSES: readonly ["paid", "unpaid", "no_
 export type CheckoutSessionPaymentStatus = (typeof CHECKOUT_PAYMENT_STATUSES)[number];
 export declare const CHECKOUT_UI_MODES: readonly ["hosted", "embedded"];
 export type CheckoutUiMode = (typeof CHECKOUT_UI_MODES)[number];
-/** The languages the hosted and embedded checkout speak. */
-export declare const CHECKOUT_LOCALES: readonly ["en", "es", "fr", "de", "it", "pt"];
+/**
+ * The languages every payer surface speaks — ONE set: the Pay with Peable
+ * sheet (`@peable.to/sdk/checkout/ui`), the hosted and embedded checkout, the
+ * hosted invoice and portal pages, and the customer emails. Each surface keeps
+ * its own catalog (their strings differ, and Metro does not tree-shake), typed
+ * `Record<CheckoutLocale, …>`, so a language added here is a compile error on
+ * every surface until it is translated.
+ *
+ * Language codes: `pt` is Brazilian Portuguese (`pt-BR`), `zh` Simplified
+ * Chinese (`zh-Hans`). A BCP 47 tag resolves to its language.
+ */
+export declare const CHECKOUT_LOCALES: readonly ["ar", "bn", "ca", "de", "en", "es", "fr", "hi", "id", "it", "ja", "pt", "ru", "tr", "zh"];
 export type CheckoutLocale = (typeof CHECKOUT_LOCALES)[number];
+/** The locales written right to left: a surface sets `dir="rtl"` for them. */
+export declare const CHECKOUT_RTL_LOCALES: readonly CheckoutLocale[];
+/** The text direction a locale is written in. */
+export declare function checkoutLocaleDirection(locale: CheckoutLocale): 'ltr' | 'rtl';
 export declare const CHECKOUT_SUBMIT_TYPES: readonly ["auto", "pay", "book", "donate"];
 export type CheckoutSubmitType = (typeof CHECKOUT_SUBMIT_TYPES)[number];
 export declare const CHECKOUT_CUSTOMER_CREATIONS: readonly ["always", "if_required"];

package/dist/types/vocabulary/errors.d.ts

@@ -108,6 +108,7 @@ export declare const ERROR_CODE_DESCRIPTIONS: {
     readonly faircoin_price_unavailable: "No fresh FairCoin price exists right now, so this order cannot be quoted in FAIR. The other payment methods still work; try FairCoin again shortly.";
     readonly faircoin_wallet_missing: "The Peable wallet that receives this payment (the merchant owner's, or the seller's) isn't set up yet, so it cannot be paid in FairCoin. The other payment methods still work.";
     readonly faircoin_network_closed: "FairCoin payments on this network are not open on this deployment yet. The other payment methods still work.";
+    readonly faircoin_capacity_reached: "Too many FairCoin payments to this recipient are waiting to be paid right now, so no new FairCoin address can be handed out. The other payment methods still work; try FairCoin again shortly.";
     readonly faircoin_amount_too_small: "One seller's share of this order is below the smallest amount the FairCoin network relays, so it cannot be paid in FairCoin. The other payment methods still work.";
     readonly credit_note_exceeds_invoice: "The credit note's amount exceeds what the invoice can still credit.";
     readonly test_clock_unexpected_state: "The test clock is advancing; wait until it is ready.";

package/dist/types/vocabulary/paymentMethodConfigurations.d.ts

@@ -30,7 +30,8 @@ export type PaymentMethodConfigurationType = (typeof PAYMENT_METHOD_CONFIGURATIO
  *    received (ADR 0021 D5); the owner sets it up in Peable;
  *  - `faircoin_network_closed` — the deployment does not open the merchant's
  *    FairCoin network yet (ADR 0002's gate);
- *  - `temporarily_unavailable` — the wallet could not be checked just now.
+ *  - `temporarily_unavailable` — the wallet could not be checked just now, or every
+ *    address the recipient can hold open is open (ADR 0021 D9) — try again shortly.
  */
 export declare const PAYMENT_METHOD_UNAVAILABLE_REASONS: readonly ["provider_unsupported", "requires_card", "faircoin_wallet_missing", "faircoin_network_closed", "temporarily_unavailable"];
 export type PaymentMethodUnavailableReason = (typeof PAYMENT_METHOD_UNAVAILABLE_REASONS)[number];

package/dist/types/vocabulary/payments.d.ts

@@ -4,6 +4,13 @@
  */
 export declare const PAYMENT_INTENT_RAILS: readonly ["faircoin", "card"];
 export type PaymentIntentRail = (typeof PAYMENT_INTENT_RAILS)[number];
+/**
+ * The longest a PaymentIntent created through the API may stay payable before
+ * it expires (`expires_in_seconds`): 24 hours. A FairCoin payment holds a
+ * reserved address in the recipient's wallet for as long as it is payable, so
+ * an unbounded expiry is an address nobody can ever recycle (ADR 0021 D9).
+ */
+export declare const PAYMENT_INTENT_MAX_EXPIRES_IN_SECONDS: number;
 /**
  * Stripe's seven statuses, and no others (ADR 0019). The FairCoin rail walks
  * four of them (`requires_action` → `processing` → `succeeded` | `canceled`); a

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@peable.to/contracts",
-  "version": "5.2.0",
+  "version": "5.4.0",
   "description": "The Peable wire, declared once: Zod contracts of every public route, the OpenAPI 3.1 generator and the closed value sets (ADR 0014 D5).",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",