@peable.to/contracts 3.1.0 → 4.1.0

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

@@ -1,6 +1,13 @@
-import { type FiatCurrencyCode } from './money';
+import { type CurrencyCode } from './money';
 /**
- * The methods a configuration can turn on.
+ * The methods a configuration lists.
+ *
+ * `faircoin` is listed and LOCKED (ADR 0021 D2): every payer can always pay
+ * with FairCoin, so its entry is always `display_preference.value: 'on'` with
+ * `locked: true`, and a create or update that sets it `off` is refused with
+ * `payment_method_locked`. It is the chain rail, never a card-provider method:
+ * it is never pushed to the provider and never appears in a card PaymentIntent's
+ * `payment_method_types`. Every other method is the merchant's to turn on and off.
  *
  * `apple_pay` and `google_pay` are WALLETS over a card: a payment made with one
  * is a `card` payment, so they appear here and never in a PaymentIntent's
@@ -11,19 +18,26 @@ import { type FiatCurrencyCode } from './money';
  * checkout, `payment-provider-boundary.md`) and giropay (discontinued by the
  * scheme).
  */
-export declare const PAYMENT_METHOD_CONFIGURATION_TYPES: readonly ["card", "apple_pay", "google_pay", "sepa_debit", "ideal", "bancontact", "eps", "bizum"];
+export declare const PAYMENT_METHOD_CONFIGURATION_TYPES: readonly ["faircoin", "card", "apple_pay", "google_pay", "sepa_debit", "ideal", "bancontact", "eps", "bizum"];
 export type PaymentMethodConfigurationType = (typeof PAYMENT_METHOD_CONFIGURATION_TYPES)[number];
 /**
  * Why a method cannot be offered whatever the merchant chooses.
  *
  *  - `provider_unsupported` — the processing provider does not offer it;
- *  - `requires_card` — a wallet rides on card payments, and card is off.
+ *  - `requires_card` — a wallet rides on card payments, and card is off;
+ *  - `faircoin_wallet_missing` — the Peable wallet of the account that owns
+ *    the merchant isn't set up yet (no identity key), so FairCoin cannot be
+ *    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.
  */
-export declare const PAYMENT_METHOD_UNAVAILABLE_REASONS: readonly ["provider_unsupported", "requires_card"];
+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];
 /**
  * The currencies each method can take a payment in. A method is offered on a
  * payment only when its currency is listed — so iDEAL never appears on a USD
- * payment, and a payer is never shown a method that would fail.
+ * payment, and a payer is never shown a method that would fail. FairCoin takes
+ * every currency: a `FAIR` order directly, a fiat one at a quoted price (ADR 0021).
  */
-export declare const PAYMENT_METHOD_CURRENCIES: Readonly<Record<PaymentMethodConfigurationType, readonly FiatCurrencyCode[]>>;
+export declare const PAYMENT_METHOD_CURRENCIES: Readonly<Record<PaymentMethodConfigurationType, readonly CurrencyCode[]>>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@peable.to/contracts",
-  "version": "3.1.0",
+  "version": "4.1.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",