@peable.to/shared-types 0.12.0 → 0.14.0

package/dist/cjs/dispute.js

@@ -1,2 +1,78 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.DISPUTE_FILE_EVIDENCE_FIELDS = exports.DISPUTE_TEXT_EVIDENCE_FIELDS = exports.DISPUTE_REASONS = void 0;
+exports.normalizeDisputeReason = normalizeDisputeReason;
+/**
+ * Why the cardholder disputed — Stripe's enum. A network reason code the
+ * provider does not map to one of these reads `general`; the row keeps the
+ * provider's own word, so nothing is lost by the normalisation.
+ */
+exports.DISPUTE_REASONS = [
+    'bank_cannot_process',
+    'check_returned',
+    'credit_not_processed',
+    'customer_initiated',
+    'debit_not_authorized',
+    'duplicate',
+    'fraudulent',
+    'general',
+    'incorrect_account_details',
+    'insufficient_funds',
+    'noncompliant',
+    'product_not_received',
+    'product_unacceptable',
+    'subscription_canceled',
+    'unrecognized',
+];
+/** Map any provider reason onto {@link DisputeReason}: unknown or absent is `general`. */
+function normalizeDisputeReason(reason) {
+    return exports.DISPUTE_REASONS.includes(reason ?? '')
+        ? reason
+        : 'general';
+}
+/**
+ * The TEXT evidence fields — the network's names, spelled the way the rest of
+ * these contracts spell things, never a Peable paraphrase: a merchant assembling
+ * a defence is reading their acquirer's guidance, and renamed fields would make
+ * that guidance not apply.
+ *
+ * Declared ONCE. The route's schema is `satisfies Record<DisputeTextEvidenceField, …>`
+ * and the Stripe adapter's name map is a total `Record`, so a field added here
+ * does not compile until both carry it — the drift that would let a merchant
+ * send a field the network never sees.
+ */
+exports.DISPUTE_TEXT_EVIDENCE_FIELDS = [
+    'access_activity_log',
+    'billing_address',
+    'cancellation_policy_disclosure',
+    'cancellation_rebuttal',
+    'customer_email_address',
+    'customer_name',
+    'customer_purchase_ip',
+    'duplicate_charge_explanation',
+    'product_description',
+    'refund_policy_disclosure',
+    'refund_refusal_explanation',
+    'service_date',
+    'shipping_address',
+    'shipping_carrier',
+    'shipping_date',
+    'shipping_tracking_number',
+    'uncategorized_text',
+];
+/**
+ * The FILE evidence fields. Each names a `file_…` of purpose `dispute_evidence`
+ * uploaded by the same merchant; its bytes go to the provider when the response
+ * is submitted, and only then.
+ */
+exports.DISPUTE_FILE_EVIDENCE_FIELDS = [
+    'cancellation_policy',
+    'customer_communication',
+    'customer_signature',
+    'duplicate_charge_documentation',
+    'receipt',
+    'refund_policy',
+    'service_documentation',
+    'shipping_documentation',
+    'uncategorized_file',
+];

package/dist/cjs/file.js

@@ -0,0 +1,44 @@
+"use strict";
+// Files (`file_…`) — bytes a merchant gives Orbit for one stated purpose
+// (ADR 0016: Orbit owns the object; the storage is Oxy Files, a binding that
+// never reaches the wire). Stripe's Files API, with Oxy Files underneath.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FILE_PURPOSE_POLICIES = exports.FILE_STATUSES = exports.FILE_TYPES = exports.FILE_PURPOSES = void 0;
+/**
+ * What a file is FOR. Decided at upload and never changed: the purpose is what
+ * sets the type and size policy, who may see the bytes, and which objects may
+ * reference the file — a `business_logo` is public, a `dispute_evidence` file
+ * is private and can only be attached to the merchant's own disputes.
+ */
+exports.FILE_PURPOSES = [
+    'dispute_evidence',
+    'business_logo',
+    'identity_document',
+    'additional_verification',
+];
+/** The stored format, by its conventional extension (Stripe's `type`). */
+exports.FILE_TYPES = ['pdf', 'png', 'jpg'];
+/**
+ * Whether the bytes can be used right now.
+ *
+ *  - `available` — Oxy serves the file; it can be shown or forwarded.
+ *  - `withheld` — the file still exists and is not being served (its owner
+ *    trashed it or made it private); it can come back.
+ *  - `removed` — Oxy said the file is gone for good (deleted, taken down, lost).
+ *    The object stays so whatever referenced it can say why it stopped working.
+ */
+exports.FILE_STATUSES = ['available', 'withheld', 'removed'];
+/**
+ * The upload policy of each purpose: the formats it takes, recognised from the
+ * bytes and never from a client's `Content-Type`, and the largest file.
+ *
+ * The provider's own ceilings, restated where the upload is parsed, so a file
+ * the card network would refuse is refused at upload — not at the one-shot
+ * dispute submission it was meant for.
+ */
+exports.FILE_PURPOSE_POLICIES = Object.freeze({
+    dispute_evidence: { types: ['pdf', 'png', 'jpg'], max_bytes: 5 * 1024 * 1024 },
+    business_logo: { types: ['png', 'jpg'], max_bytes: 512 * 1024 },
+    identity_document: { types: ['pdf', 'png', 'jpg'], max_bytes: 10 * 1024 * 1024 },
+    additional_verification: { types: ['pdf', 'png', 'jpg'], max_bytes: 10 * 1024 * 1024 },
+});

package/dist/cjs/index.js

@@ -1,12 +1,14 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.TAX_LOCATION_EVIDENCE_TYPES = exports.TAX_REGISTRATION_SCHEMES = exports.PEABLE_BILLING_AUTHORITY_KEYS = exports.canonicalBillingTaxQuote = exports.canonicalBillingAuthority = exports.BILLING_SUBSCRIPTION_STATUSES = exports.SOCIAL_SOURCE_REF_MAX_LENGTH = exports.SOCIAL_SOURCE_APP_MAX_LENGTH = exports.MERCHANT_ENVIRONMENTS = exports.verifyWebhook = exports.signWebhook = exports.CATALOG_LIMITS = exports.COUPON_DURATIONS = exports.TRANSFORM_QUANTITY_ROUNDS = exports.PRICE_TAX_BEHAVIORS = exports.RECURRING_USAGE_TYPES = exports.RECURRING_INTERVALS = exports.PRICE_TYPES = exports.PRICE_TIERS_MODES = exports.PRICE_BILLING_SCHEMES = exports.WEBHOOK_SECRET_ROLL_MAX_EXPIRES_IN_SECONDS = exports.WEBHOOK_ENDPOINTS_MAX_PER_MERCHANT = exports.WEBHOOK_ENDPOINT_DISABLED_REASONS = exports.WEBHOOK_ENDPOINT_STATUSES = exports.PEABLE_API_VERSION = exports.SETUP_INTENT_STATUSES = exports.isValidStatusTransition = exports.canStillBePaid = exports.canExpire = exports.TERMINAL_STATUSES = exports.PAYMENT_INTENT_STATUSES = exports.PAYMENT_INTENT_SETUP_FUTURE_USAGES = exports.PAYMENT_INTENT_RAILS = exports.PAYMENT_INTENT_CAPTURE_METHODS = exports.PAYMENT_INTENT_CANCELLATION_REASONS = exports.MERCHANT_CANCELLATION_REASONS = exports.EXPIRABLE_STATUSES = exports.CARD_ONLY_STATUSES = exports.isCurrencyCode = exports.decimalsFor = exports.CURRENCY_DECIMALS = exports.CURRENCY_CODES = exports.isBaseUnitString = exports.UNITS_PER_COIN = void 0;
+exports.verifyWebhook = exports.signWebhook = exports.SIMULATED_FAIRCOIN_OUTCOMES = exports.REQUEST_LOG_RETENTION_DAYS = exports.REQUEST_LOG_METHODS = exports.PAYMENT_METHOD_CURRENCIES = exports.PAYMENT_METHOD_CONFIGURATION_TYPES = exports.CARD_RAIL_PAYMENT_METHOD_TYPES = exports.FILE_TYPES = exports.FILE_STATUSES = exports.FILE_PURPOSE_POLICIES = exports.FILE_PURPOSES = exports.normalizeDisputeReason = exports.DISPUTE_TEXT_EVIDENCE_FIELDS = exports.DISPUTE_REASONS = exports.DISPUTE_FILE_EVIDENCE_FIELDS = exports.CATALOG_LIMITS = exports.COUPON_DURATIONS = exports.TRANSFORM_QUANTITY_ROUNDS = exports.PRICE_TAX_BEHAVIORS = exports.RECURRING_USAGE_TYPES = exports.RECURRING_INTERVALS = exports.PRICE_TYPES = exports.PRICE_TIERS_MODES = exports.PRICE_BILLING_SCHEMES = exports.WEBHOOK_SECRET_ROLL_MAX_EXPIRES_IN_SECONDS = exports.WEBHOOK_ENDPOINTS_MAX_PER_MERCHANT = exports.WEBHOOK_ENDPOINT_DISABLED_REASONS = exports.WEBHOOK_ENDPOINT_STATUSES = exports.PEABLE_API_VERSION = exports.SETUP_INTENT_STATUSES = exports.isValidStatusTransition = exports.canStillBePaid = exports.canExpire = exports.TERMINAL_STATUSES = exports.PAYMENT_INTENT_STATUSES = exports.PAYMENT_INTENT_SETUP_FUTURE_USAGES = exports.PAYMENT_INTENT_RAILS = exports.PAYMENT_INTENT_CAPTURE_METHODS = exports.PAYMENT_INTENT_CANCELLATION_REASONS = exports.MERCHANT_CANCELLATION_REASONS = exports.EXPIRABLE_STATUSES = exports.CARD_ONLY_STATUSES = exports.isCurrencyCode = exports.decimalsFor = exports.FIAT_CURRENCY_CODES = exports.CURRENCY_DECIMALS = exports.CURRENCY_CODES = exports.isBaseUnitString = exports.UNITS_PER_COIN = void 0;
+exports.TAX_LOCATION_EVIDENCE_TYPES = exports.TAX_REGISTRATION_SCHEMES = exports.PEABLE_BILLING_AUTHORITY_KEYS = exports.canonicalBillingTaxQuote = exports.canonicalBillingAuthority = exports.BILLING_SUBSCRIPTION_STATUSES = exports.SOCIAL_SOURCE_REF_MAX_LENGTH = exports.SOCIAL_SOURCE_APP_MAX_LENGTH = exports.MERCHANT_ENVIRONMENTS = void 0;
 // @peable.to/shared-types — public API for the Peable Gateway contract.
 var money_1 = require("./money");
 Object.defineProperty(exports, "UNITS_PER_COIN", { enumerable: true, get: function () { return money_1.UNITS_PER_COIN; } });
 Object.defineProperty(exports, "isBaseUnitString", { enumerable: true, get: function () { return money_1.isBaseUnitString; } });
 Object.defineProperty(exports, "CURRENCY_CODES", { enumerable: true, get: function () { return money_1.CURRENCY_CODES; } });
 Object.defineProperty(exports, "CURRENCY_DECIMALS", { enumerable: true, get: function () { return money_1.CURRENCY_DECIMALS; } });
+Object.defineProperty(exports, "FIAT_CURRENCY_CODES", { enumerable: true, get: function () { return money_1.FIAT_CURRENCY_CODES; } });
 Object.defineProperty(exports, "decimalsFor", { enumerable: true, get: function () { return money_1.decimalsFor; } });
 Object.defineProperty(exports, "isCurrencyCode", { enumerable: true, get: function () { return money_1.isCurrencyCode; } });
 var paymentIntent_1 = require("./paymentIntent");
@@ -41,6 +43,25 @@ Object.defineProperty(exports, "PRICE_TAX_BEHAVIORS", { enumerable: true, get: f
 Object.defineProperty(exports, "TRANSFORM_QUANTITY_ROUNDS", { enumerable: true, get: function () { return catalog_1.TRANSFORM_QUANTITY_ROUNDS; } });
 Object.defineProperty(exports, "COUPON_DURATIONS", { enumerable: true, get: function () { return catalog_1.COUPON_DURATIONS; } });
 Object.defineProperty(exports, "CATALOG_LIMITS", { enumerable: true, get: function () { return catalog_1.CATALOG_LIMITS; } });
+var dispute_1 = require("./dispute");
+Object.defineProperty(exports, "DISPUTE_FILE_EVIDENCE_FIELDS", { enumerable: true, get: function () { return dispute_1.DISPUTE_FILE_EVIDENCE_FIELDS; } });
+Object.defineProperty(exports, "DISPUTE_REASONS", { enumerable: true, get: function () { return dispute_1.DISPUTE_REASONS; } });
+Object.defineProperty(exports, "DISPUTE_TEXT_EVIDENCE_FIELDS", { enumerable: true, get: function () { return dispute_1.DISPUTE_TEXT_EVIDENCE_FIELDS; } });
+Object.defineProperty(exports, "normalizeDisputeReason", { enumerable: true, get: function () { return dispute_1.normalizeDisputeReason; } });
+var file_1 = require("./file");
+Object.defineProperty(exports, "FILE_PURPOSES", { enumerable: true, get: function () { return file_1.FILE_PURPOSES; } });
+Object.defineProperty(exports, "FILE_PURPOSE_POLICIES", { enumerable: true, get: function () { return file_1.FILE_PURPOSE_POLICIES; } });
+Object.defineProperty(exports, "FILE_STATUSES", { enumerable: true, get: function () { return file_1.FILE_STATUSES; } });
+Object.defineProperty(exports, "FILE_TYPES", { enumerable: true, get: function () { return file_1.FILE_TYPES; } });
+var paymentMethodConfiguration_1 = require("./paymentMethodConfiguration");
+Object.defineProperty(exports, "CARD_RAIL_PAYMENT_METHOD_TYPES", { enumerable: true, get: function () { return paymentMethodConfiguration_1.CARD_RAIL_PAYMENT_METHOD_TYPES; } });
+Object.defineProperty(exports, "PAYMENT_METHOD_CONFIGURATION_TYPES", { enumerable: true, get: function () { return paymentMethodConfiguration_1.PAYMENT_METHOD_CONFIGURATION_TYPES; } });
+Object.defineProperty(exports, "PAYMENT_METHOD_CURRENCIES", { enumerable: true, get: function () { return paymentMethodConfiguration_1.PAYMENT_METHOD_CURRENCIES; } });
+var requestLog_1 = require("./requestLog");
+Object.defineProperty(exports, "REQUEST_LOG_METHODS", { enumerable: true, get: function () { return requestLog_1.REQUEST_LOG_METHODS; } });
+Object.defineProperty(exports, "REQUEST_LOG_RETENTION_DAYS", { enumerable: true, get: function () { return requestLog_1.REQUEST_LOG_RETENTION_DAYS; } });
+var testHelpers_1 = require("./testHelpers");
+Object.defineProperty(exports, "SIMULATED_FAIRCOIN_OUTCOMES", { enumerable: true, get: function () { return testHelpers_1.SIMULATED_FAIRCOIN_OUTCOMES; } });
 var webhookSigner_1 = require("./webhookSigner");
 Object.defineProperty(exports, "signWebhook", { enumerable: true, get: function () { return webhookSigner_1.signWebhook; } });
 Object.defineProperty(exports, "verifyWebhook", { enumerable: true, get: function () { return webhookSigner_1.verifyWebhook; } });

package/dist/cjs/money.js

@@ -3,12 +3,16 @@
 // canonical integer string in the currency's SMALLEST unit — m⊜ for FairCoin,
 // cents for a fiat currency — so no float ever touches one.
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.UNITS_PER_COIN = exports.CURRENCY_DECIMALS = exports.CURRENCY_CODES = void 0;
+exports.UNITS_PER_COIN = exports.FIAT_CURRENCY_CODES = exports.CURRENCY_DECIMALS = exports.CURRENCY_CODES = void 0;
 exports.isCurrencyCode = isCurrencyCode;
 exports.decimalsFor = decimalsFor;
 exports.isBaseUnitString = isBaseUnitString;
 /**
- * The currencies this gateway can denominate a payment in.
+ * The currencies this gateway can denominate a payment in: FairCoin on the
+ * chain rail, and on the card rail the fiat set the provider settles for the
+ * payment methods Orbit offers (cards, wallets, SEPA Debit, iDEAL, Bancontact,
+ * EPS). A local method narrows it further per payment
+ * (`PAYMENT_METHOD_CURRENCIES` in `paymentMethodConfiguration.ts`).
  *
  * A closed set, and the database mirrors it as a CHECK
  * (`db/schema/valueSets.ts`). ADR 0001 D4: the scale of an amount is a property
@@ -16,7 +20,21 @@ exports.isBaseUnitString = isBaseUnitString;
  * {@link CURRENCY_DECIMALS} exists and why {@link UNITS_PER_COIN} must never be
  * used to interpret a fiat amount.
  */
-exports.CURRENCY_CODES = ['FAIR', 'EUR', 'USD'];
+exports.CURRENCY_CODES = [
+    'FAIR',
+    'EUR',
+    'USD',
+    'GBP',
+    'CHF',
+    'SEK',
+    'NOK',
+    'DKK',
+    'PLN',
+    'CZK',
+    'CAD',
+    'AUD',
+    'JPY',
+];
 /** Whether an arbitrary string is a currency this gateway knows. */
 function isCurrencyCode(value) {
     return exports.CURRENCY_CODES.includes(value);
@@ -25,7 +43,7 @@ function isCurrencyCode(value) {
  * How many decimal places each currency's smallest unit represents — i.e. an
  * amount of `1` means `10^-decimals` of one whole unit.
  *
- * FairCoin's 8 is a consensus constant and is pinned against
+ * ISO 4217's minor units for every fiat member (JPY has none). FairCoin's 8 is a consensus constant and is pinned against
  * {@link UNITS_PER_COIN} by this package's own tests, so the two spellings of
  * one fact cannot drift.
  */
@@ -33,7 +51,21 @@ exports.CURRENCY_DECIMALS = Object.freeze({
     FAIR: 8,
     EUR: 2,
     USD: 2,
+    GBP: 2,
+    CHF: 2,
+    SEK: 2,
+    NOK: 2,
+    DKK: 2,
+    PLN: 2,
+    CZK: 2,
+    CAD: 2,
+    AUD: 2,
+    // A zero-decimal currency: an amount of `1` is one yen, never a hundredth of
+    // one. The provider counts JPY the same way, so the base unit crosses as is.
+    JPY: 0,
 });
+/** The fiat members — every currency the card rail can denominate a payment in. */
+exports.FIAT_CURRENCY_CODES = exports.CURRENCY_CODES.filter((code) => code !== 'FAIR');
 /** The decimal places of `currency`'s smallest unit. */
 function decimalsFor(currency) {
     return exports.CURRENCY_DECIMALS[currency];

package/dist/cjs/paymentMethodConfiguration.js

@@ -0,0 +1,54 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PAYMENT_METHOD_CURRENCIES = exports.CARD_RAIL_PAYMENT_METHOD_TYPES = exports.PAYMENT_METHOD_CONFIGURATION_TYPES = void 0;
+// Payment method breadth on the card rail — which methods a merchant's payers
+// are offered (`pmc_…`), and the web domains wallets may run on (`pmd_…`).
+// Both are Orbit's objects; the provider's configuration and domain are
+// bindings behind them (ADR 0016). Card data and bank credentials are entered
+// in the provider's hosted fields and never reach Peable (PCI SAQ-A).
+const money_1 = require("./money");
+/**
+ * The methods a configuration can turn on.
+ *
+ * `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
+ * `payment_method_types`. `bizum` is listed because merchants ask for it and the
+ * honest answer is a reason, not an absence: the provider does not offer it.
+ *
+ * Deliberately absent: the provider's own consumer wallet (its brand on Orbit's
+ * checkout, `payment-provider-boundary.md`) and giropay (discontinued by the
+ * scheme).
+ */
+exports.PAYMENT_METHOD_CONFIGURATION_TYPES = [
+    'card',
+    'apple_pay',
+    'google_pay',
+    'sepa_debit',
+    'ideal',
+    'bancontact',
+    'eps',
+    'bizum',
+];
+/** The card-rail types a PaymentIntent can carry in `payment_method_types`. */
+exports.CARD_RAIL_PAYMENT_METHOD_TYPES = [
+    'card',
+    'sepa_debit',
+    'ideal',
+    'bancontact',
+    'eps',
+];
+/**
+ * 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.
+ */
+exports.PAYMENT_METHOD_CURRENCIES = Object.freeze({
+    card: money_1.FIAT_CURRENCY_CODES,
+    apple_pay: money_1.FIAT_CURRENCY_CODES,
+    google_pay: money_1.FIAT_CURRENCY_CODES,
+    sepa_debit: ['EUR'],
+    ideal: ['EUR'],
+    bancontact: ['EUR'],
+    eps: ['EUR'],
+    bizum: ['EUR'],
+});

package/dist/cjs/requestLog.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.REQUEST_LOG_RETENTION_DAYS = exports.REQUEST_LOG_METHODS = void 0;
+/**
+ * One merchant API request, as Peable recorded it (`req_…`) — the request log
+ * Orbit and `peable logs tail` read.
+ *
+ * Its `id` IS the `Request-Id` that request was answered with, so the id a
+ * merchant quotes to support and the log row are the same thing.
+ *
+ * Deliberately thin: method, path (no query string), status, duration and the
+ * `Idempotency-Key` it carried. No body, no headers, no query string, no
+ * caller address — a log a merchant can read is a log that must not hold what
+ * a request carried. Kept 30 days.
+ */
+exports.REQUEST_LOG_METHODS = ['GET', 'POST', 'DELETE', 'PATCH', 'PUT'];
+/** How long a request log is kept (and served). */
+exports.REQUEST_LOG_RETENTION_DAYS = 30;

package/dist/cjs/testHelpers.js

@@ -0,0 +1,21 @@
+"use strict";
+/**
+ * Test helpers (`/v1/test_helpers/*`) — test mode only.
+ *
+ * They drive a test-mode object through the SAME state machine a real payment
+ * moves through, so a merchant can exercise their integration end to end
+ * without a wallet or a card: every transition a helper makes is one the
+ * gateway would make, with the same events and webhooks.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SIMULATED_FAIRCOIN_OUTCOMES = void 0;
+/**
+ * What `simulate_faircoin_payment` pretends the payer did.
+ *
+ *  - `settled`   — paid the full amount, which is then seen in the mempool and
+ *    confirmed: `broadcast → confirming → settled`
+ *    (`payment_intent.confirming`, then `payment_intent.settled`).
+ *  - `underpaid` — sent less than the amount: `broadcast → failed`
+ *    (`payment_intent.failed`).
+ */
+exports.SIMULATED_FAIRCOIN_OUTCOMES = ['settled', 'underpaid'];

package/dist/esm/dispute.js

@@ -1 +1,74 @@
-export {};
+/**
+ * Why the cardholder disputed — Stripe's enum. A network reason code the
+ * provider does not map to one of these reads `general`; the row keeps the
+ * provider's own word, so nothing is lost by the normalisation.
+ */
+export const DISPUTE_REASONS = [
+    'bank_cannot_process',
+    'check_returned',
+    'credit_not_processed',
+    'customer_initiated',
+    'debit_not_authorized',
+    'duplicate',
+    'fraudulent',
+    'general',
+    'incorrect_account_details',
+    'insufficient_funds',
+    'noncompliant',
+    'product_not_received',
+    'product_unacceptable',
+    'subscription_canceled',
+    'unrecognized',
+];
+/** Map any provider reason onto {@link DisputeReason}: unknown or absent is `general`. */
+export function normalizeDisputeReason(reason) {
+    return DISPUTE_REASONS.includes(reason ?? '')
+        ? reason
+        : 'general';
+}
+/**
+ * The TEXT evidence fields — the network's names, spelled the way the rest of
+ * these contracts spell things, never a Peable paraphrase: a merchant assembling
+ * a defence is reading their acquirer's guidance, and renamed fields would make
+ * that guidance not apply.
+ *
+ * Declared ONCE. The route's schema is `satisfies Record<DisputeTextEvidenceField, …>`
+ * and the Stripe adapter's name map is a total `Record`, so a field added here
+ * does not compile until both carry it — the drift that would let a merchant
+ * send a field the network never sees.
+ */
+export const DISPUTE_TEXT_EVIDENCE_FIELDS = [
+    'access_activity_log',
+    'billing_address',
+    'cancellation_policy_disclosure',
+    'cancellation_rebuttal',
+    'customer_email_address',
+    'customer_name',
+    'customer_purchase_ip',
+    'duplicate_charge_explanation',
+    'product_description',
+    'refund_policy_disclosure',
+    'refund_refusal_explanation',
+    'service_date',
+    'shipping_address',
+    'shipping_carrier',
+    'shipping_date',
+    'shipping_tracking_number',
+    'uncategorized_text',
+];
+/**
+ * The FILE evidence fields. Each names a `file_…` of purpose `dispute_evidence`
+ * uploaded by the same merchant; its bytes go to the provider when the response
+ * is submitted, and only then.
+ */
+export const DISPUTE_FILE_EVIDENCE_FIELDS = [
+    'cancellation_policy',
+    'customer_communication',
+    'customer_signature',
+    'duplicate_charge_documentation',
+    'receipt',
+    'refund_policy',
+    'service_documentation',
+    'shipping_documentation',
+    'uncategorized_file',
+];

package/dist/esm/file.js

@@ -0,0 +1,41 @@
+// Files (`file_…`) — bytes a merchant gives Orbit for one stated purpose
+// (ADR 0016: Orbit owns the object; the storage is Oxy Files, a binding that
+// never reaches the wire). Stripe's Files API, with Oxy Files underneath.
+/**
+ * What a file is FOR. Decided at upload and never changed: the purpose is what
+ * sets the type and size policy, who may see the bytes, and which objects may
+ * reference the file — a `business_logo` is public, a `dispute_evidence` file
+ * is private and can only be attached to the merchant's own disputes.
+ */
+export const FILE_PURPOSES = [
+    'dispute_evidence',
+    'business_logo',
+    'identity_document',
+    'additional_verification',
+];
+/** The stored format, by its conventional extension (Stripe's `type`). */
+export const FILE_TYPES = ['pdf', 'png', 'jpg'];
+/**
+ * Whether the bytes can be used right now.
+ *
+ *  - `available` — Oxy serves the file; it can be shown or forwarded.
+ *  - `withheld` — the file still exists and is not being served (its owner
+ *    trashed it or made it private); it can come back.
+ *  - `removed` — Oxy said the file is gone for good (deleted, taken down, lost).
+ *    The object stays so whatever referenced it can say why it stopped working.
+ */
+export const FILE_STATUSES = ['available', 'withheld', 'removed'];
+/**
+ * The upload policy of each purpose: the formats it takes, recognised from the
+ * bytes and never from a client's `Content-Type`, and the largest file.
+ *
+ * The provider's own ceilings, restated where the upload is parsed, so a file
+ * the card network would refuse is refused at upload — not at the one-shot
+ * dispute submission it was meant for.
+ */
+export const FILE_PURPOSE_POLICIES = Object.freeze({
+    dispute_evidence: { types: ['pdf', 'png', 'jpg'], max_bytes: 5 * 1024 * 1024 },
+    business_logo: { types: ['png', 'jpg'], max_bytes: 512 * 1024 },
+    identity_document: { types: ['pdf', 'png', 'jpg'], max_bytes: 10 * 1024 * 1024 },
+    additional_verification: { types: ['pdf', 'png', 'jpg'], max_bytes: 10 * 1024 * 1024 },
+});

package/dist/esm/index.js

@@ -1,10 +1,15 @@
 // @peable.to/shared-types — public API for the Peable Gateway contract.
-export { UNITS_PER_COIN, isBaseUnitString, CURRENCY_CODES, CURRENCY_DECIMALS, decimalsFor, isCurrencyCode, } from './money.js';
+export { UNITS_PER_COIN, isBaseUnitString, CURRENCY_CODES, CURRENCY_DECIMALS, FIAT_CURRENCY_CODES, decimalsFor, isCurrencyCode, } from './money.js';
 export { CARD_ONLY_STATUSES, EXPIRABLE_STATUSES, MERCHANT_CANCELLATION_REASONS, PAYMENT_INTENT_CANCELLATION_REASONS, PAYMENT_INTENT_CAPTURE_METHODS, PAYMENT_INTENT_RAILS, PAYMENT_INTENT_SETUP_FUTURE_USAGES, PAYMENT_INTENT_STATUSES, TERMINAL_STATUSES, canExpire, canStillBePaid, isValidStatusTransition, } from './paymentIntent.js';
 export { SETUP_INTENT_STATUSES, } from './setupIntent.js';
 export { PEABLE_API_VERSION, } from './event.js';
 export { WEBHOOK_ENDPOINT_STATUSES, WEBHOOK_ENDPOINT_DISABLED_REASONS, WEBHOOK_ENDPOINTS_MAX_PER_MERCHANT, WEBHOOK_SECRET_ROLL_MAX_EXPIRES_IN_SECONDS, } from './webhookEndpoint.js';
 export { PRICE_BILLING_SCHEMES, PRICE_TIERS_MODES, PRICE_TYPES, RECURRING_INTERVALS, RECURRING_USAGE_TYPES, PRICE_TAX_BEHAVIORS, TRANSFORM_QUANTITY_ROUNDS, COUPON_DURATIONS, CATALOG_LIMITS, } from './catalog.js';
+export { DISPUTE_FILE_EVIDENCE_FIELDS, DISPUTE_REASONS, DISPUTE_TEXT_EVIDENCE_FIELDS, normalizeDisputeReason, } from './dispute.js';
+export { FILE_PURPOSES, FILE_PURPOSE_POLICIES, FILE_STATUSES, FILE_TYPES, } from './file.js';
+export { CARD_RAIL_PAYMENT_METHOD_TYPES, PAYMENT_METHOD_CONFIGURATION_TYPES, PAYMENT_METHOD_CURRENCIES, } from './paymentMethodConfiguration.js';
+export { REQUEST_LOG_METHODS, REQUEST_LOG_RETENTION_DAYS, } from './requestLog.js';
+export { SIMULATED_FAIRCOIN_OUTCOMES, } from './testHelpers.js';
 export { signWebhook, verifyWebhook } from './webhookSigner.js';
 export { MERCHANT_ENVIRONMENTS, } from './merchant.js';
 export { SOCIAL_SOURCE_APP_MAX_LENGTH, SOCIAL_SOURCE_REF_MAX_LENGTH, } from './social.js';

package/dist/esm/money.js

@@ -2,7 +2,11 @@
 // canonical integer string in the currency's SMALLEST unit — m⊜ for FairCoin,
 // cents for a fiat currency — so no float ever touches one.
 /**
- * The currencies this gateway can denominate a payment in.
+ * The currencies this gateway can denominate a payment in: FairCoin on the
+ * chain rail, and on the card rail the fiat set the provider settles for the
+ * payment methods Orbit offers (cards, wallets, SEPA Debit, iDEAL, Bancontact,
+ * EPS). A local method narrows it further per payment
+ * (`PAYMENT_METHOD_CURRENCIES` in `paymentMethodConfiguration.ts`).
  *
  * A closed set, and the database mirrors it as a CHECK
  * (`db/schema/valueSets.ts`). ADR 0001 D4: the scale of an amount is a property
@@ -10,7 +14,21 @@
  * {@link CURRENCY_DECIMALS} exists and why {@link UNITS_PER_COIN} must never be
  * used to interpret a fiat amount.
  */
-export const CURRENCY_CODES = ['FAIR', 'EUR', 'USD'];
+export const CURRENCY_CODES = [
+    'FAIR',
+    'EUR',
+    'USD',
+    'GBP',
+    'CHF',
+    'SEK',
+    'NOK',
+    'DKK',
+    'PLN',
+    'CZK',
+    'CAD',
+    'AUD',
+    'JPY',
+];
 /** Whether an arbitrary string is a currency this gateway knows. */
 export function isCurrencyCode(value) {
     return CURRENCY_CODES.includes(value);
@@ -19,7 +37,7 @@ export function isCurrencyCode(value) {
  * How many decimal places each currency's smallest unit represents — i.e. an
  * amount of `1` means `10^-decimals` of one whole unit.
  *
- * FairCoin's 8 is a consensus constant and is pinned against
+ * ISO 4217's minor units for every fiat member (JPY has none). FairCoin's 8 is a consensus constant and is pinned against
  * {@link UNITS_PER_COIN} by this package's own tests, so the two spellings of
  * one fact cannot drift.
  */
@@ -27,7 +45,21 @@ export const CURRENCY_DECIMALS = Object.freeze({
     FAIR: 8,
     EUR: 2,
     USD: 2,
+    GBP: 2,
+    CHF: 2,
+    SEK: 2,
+    NOK: 2,
+    DKK: 2,
+    PLN: 2,
+    CZK: 2,
+    CAD: 2,
+    AUD: 2,
+    // A zero-decimal currency: an amount of `1` is one yen, never a hundredth of
+    // one. The provider counts JPY the same way, so the base unit crosses as is.
+    JPY: 0,
 });
+/** The fiat members — every currency the card rail can denominate a payment in. */
+export const FIAT_CURRENCY_CODES = CURRENCY_CODES.filter((code) => code !== 'FAIR');
 /** The decimal places of `currency`'s smallest unit. */
 export function decimalsFor(currency) {
     return CURRENCY_DECIMALS[currency];

package/dist/esm/paymentMethodConfiguration.js

@@ -0,0 +1,51 @@
+// Payment method breadth on the card rail — which methods a merchant's payers
+// are offered (`pmc_…`), and the web domains wallets may run on (`pmd_…`).
+// Both are Orbit's objects; the provider's configuration and domain are
+// bindings behind them (ADR 0016). Card data and bank credentials are entered
+// in the provider's hosted fields and never reach Peable (PCI SAQ-A).
+import { FIAT_CURRENCY_CODES } from './money.js';
+/**
+ * The methods a configuration can turn on.
+ *
+ * `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
+ * `payment_method_types`. `bizum` is listed because merchants ask for it and the
+ * honest answer is a reason, not an absence: the provider does not offer it.
+ *
+ * Deliberately absent: the provider's own consumer wallet (its brand on Orbit's
+ * checkout, `payment-provider-boundary.md`) and giropay (discontinued by the
+ * scheme).
+ */
+export const PAYMENT_METHOD_CONFIGURATION_TYPES = [
+    'card',
+    'apple_pay',
+    'google_pay',
+    'sepa_debit',
+    'ideal',
+    'bancontact',
+    'eps',
+    'bizum',
+];
+/** The card-rail types a PaymentIntent can carry in `payment_method_types`. */
+export const CARD_RAIL_PAYMENT_METHOD_TYPES = [
+    'card',
+    'sepa_debit',
+    'ideal',
+    'bancontact',
+    'eps',
+];
+/**
+ * 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.
+ */
+export const PAYMENT_METHOD_CURRENCIES = Object.freeze({
+    card: FIAT_CURRENCY_CODES,
+    apple_pay: FIAT_CURRENCY_CODES,
+    google_pay: FIAT_CURRENCY_CODES,
+    sepa_debit: ['EUR'],
+    ideal: ['EUR'],
+    bancontact: ['EUR'],
+    eps: ['EUR'],
+    bizum: ['EUR'],
+});

package/dist/esm/requestLog.js

@@ -0,0 +1,15 @@
+/**
+ * One merchant API request, as Peable recorded it (`req_…`) — the request log
+ * Orbit and `peable logs tail` read.
+ *
+ * Its `id` IS the `Request-Id` that request was answered with, so the id a
+ * merchant quotes to support and the log row are the same thing.
+ *
+ * Deliberately thin: method, path (no query string), status, duration and the
+ * `Idempotency-Key` it carried. No body, no headers, no query string, no
+ * caller address — a log a merchant can read is a log that must not hold what
+ * a request carried. Kept 30 days.
+ */
+export const REQUEST_LOG_METHODS = ['GET', 'POST', 'DELETE', 'PATCH', 'PUT'];
+/** How long a request log is kept (and served). */
+export const REQUEST_LOG_RETENTION_DAYS = 30;

package/dist/esm/testHelpers.js

@@ -0,0 +1,18 @@
+/**
+ * Test helpers (`/v1/test_helpers/*`) — test mode only.
+ *
+ * They drive a test-mode object through the SAME state machine a real payment
+ * moves through, so a merchant can exercise their integration end to end
+ * without a wallet or a card: every transition a helper makes is one the
+ * gateway would make, with the same events and webhooks.
+ */
+/**
+ * What `simulate_faircoin_payment` pretends the payer did.
+ *
+ *  - `settled`   — paid the full amount, which is then seen in the mempool and
+ *    confirmed: `broadcast → confirming → settled`
+ *    (`payment_intent.confirming`, then `payment_intent.settled`).
+ *  - `underpaid` — sent less than the amount: `broadcast → failed`
+ *    (`payment_intent.failed`).
+ */
+export const SIMULATED_FAIRCOIN_OUTCOMES = ['settled', 'underpaid'];