@peable.to/shared-types 0.14.0 → 0.16.0

package/dist/cjs/account.js

@@ -0,0 +1,23 @@
+"use strict";
+// The merchant's fiat account (ADR 0015 §1) — `GET /v1/account`.
+//
+// Orbit's funds never reach a Peable bank account: a merchant that takes fiat
+// has its OWN provider account, opened and onboarded through Peable, and this
+// object mirrors it. Everything here is what the provider last reported; the
+// provider is the authority and Orbit never decides readiness itself.
+//
+// A marketplace's sellers (`/v1/connected_accounts`) are provider accounts too,
+// and a platform reads one of them in this same shape by sending
+// `Peable-Account: ca_…` to `GET /v1/account`.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PAYOUT_WEEKLY_ANCHORS = exports.PAYOUT_INTERVALS = void 0;
+exports.PAYOUT_INTERVALS = ['manual', 'daily', 'weekly', 'monthly'];
+exports.PAYOUT_WEEKLY_ANCHORS = [
+    'monday',
+    'tuesday',
+    'wednesday',
+    'thursday',
+    'friday',
+    'saturday',
+    'sunday',
+];

package/dist/cjs/balance.js

@@ -0,0 +1,39 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RECONCILIATION_MISMATCH_KINDS = exports.PAYOUT_STATUSES = exports.BALANCE_TRANSACTION_STATUSES = exports.BALANCE_TRANSACTION_TYPES = void 0;
+/** Orbit's vocabulary for what moved — the provider's own types, provider-neutral. */
+exports.BALANCE_TRANSACTION_TYPES = [
+    'charge',
+    'payment',
+    'refund',
+    'payment_refund',
+    'adjustment',
+    'application_fee',
+    'application_fee_refund',
+    'payout',
+    'payout_cancel',
+    'payout_failure',
+    'transfer',
+    'transfer_refund',
+    'dispute',
+    'dispute_reversal',
+    'processing_fee',
+    'faircoin_payment',
+    'faircoin_payment_reversal',
+    'other',
+];
+/**
+ * - `pending` / `available` — the provider's own status for the funds.
+ * - `informational` — a FairCoin payment: recorded, never part of a payable balance.
+ */
+exports.BALANCE_TRANSACTION_STATUSES = ['available', 'pending', 'informational'];
+exports.PAYOUT_STATUSES = ['pending', 'in_transit', 'paid', 'failed', 'canceled'];
+/** What the daily reconciliation found disagreeing with the provider. Never auto-corrected. */
+exports.RECONCILIATION_MISMATCH_KINDS = [
+    'missing_in_ledger',
+    'amount_mismatch',
+    'status_mismatch',
+    'missing_at_provider',
+    'payout_mismatch',
+    'unbalanced_journal',
+];

package/dist/cjs/branding.js

@@ -0,0 +1,31 @@
+"use strict";
+// Merchant branding and customer email settings (Orbit Phase 3).
+//
+// Branding is what the hosted checkout, the embedded checkout and Peable's
+// receipts look like for one merchant. Every value is from a CLOSED set or a
+// validated colour, so nothing a merchant stores can inject markup or a remote
+// font into a payer's page or an email.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DEFAULT_BRANDING = exports.BRANDING_COLOR_PATTERN = exports.BRANDING_BORDER_STYLES = exports.BRANDING_FONTS = void 0;
+/** The fonts checkout may render in — system stacks only, no remote font is ever loaded. */
+exports.BRANDING_FONTS = [
+    'system',
+    'inter',
+    'roboto',
+    'open_sans',
+    'lato',
+    'source_sans',
+    'noto_sans',
+    'serif',
+    'monospace',
+];
+exports.BRANDING_BORDER_STYLES = ['rounded', 'rectangular', 'pill'];
+/** `#rrggbb`, lowercase — the only colour spelling branding stores. */
+exports.BRANDING_COLOR_PATTERN = /^#[0-9a-f]{6}$/;
+/** Peable's defaults, applied wherever a merchant set nothing. */
+exports.DEFAULT_BRANDING = Object.freeze({
+    primary_color: '#1f6feb',
+    accent_color: '#0b1f33',
+    font: 'system',
+    border_style: 'rounded',
+});

package/dist/cjs/checkoutSession.js

@@ -1,2 +1,45 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.CHECKOUT_SESSION_ID_TEMPLATE = exports.CHECKOUT_LIMITS = exports.CHECKOUT_TAX_ID_TYPES = exports.CHECKOUT_CUSTOM_FIELD_TYPES = exports.CHECKOUT_BILLING_ADDRESS_COLLECTIONS = exports.CHECKOUT_CUSTOMER_CREATIONS = exports.CHECKOUT_SUBMIT_TYPES = exports.CHECKOUT_LOCALES = exports.CHECKOUT_UI_MODES = exports.CHECKOUT_PAYMENT_STATUSES = exports.CHECKOUT_SESSION_STATUSES = exports.CHECKOUT_SESSION_MODES = void 0;
+exports.CHECKOUT_SESSION_MODES = ['payment', 'setup', 'subscription'];
+exports.CHECKOUT_SESSION_STATUSES = ['open', 'complete', 'expired'];
+exports.CHECKOUT_PAYMENT_STATUSES = ['paid', 'unpaid', 'no_payment_required'];
+exports.CHECKOUT_UI_MODES = ['hosted', 'embedded'];
+/** The languages the hosted and embedded checkout speak. */
+exports.CHECKOUT_LOCALES = ['en', 'es', 'fr', 'de', 'it', 'pt'];
+exports.CHECKOUT_SUBMIT_TYPES = ['auto', 'pay', 'book', 'donate'];
+exports.CHECKOUT_CUSTOMER_CREATIONS = ['always', 'if_required'];
+exports.CHECKOUT_BILLING_ADDRESS_COLLECTIONS = ['auto', 'required'];
+exports.CHECKOUT_CUSTOM_FIELD_TYPES = ['text', 'numeric', 'dropdown'];
+/** Stripe's tax id types Peable collects; `eu_vat` covers every EU member state. */
+exports.CHECKOUT_TAX_ID_TYPES = [
+    'eu_vat',
+    'gb_vat',
+    'ch_vat',
+    'no_vat',
+    'us_ein',
+    'ca_bn',
+];
+/**
+ * Bounds of the session contract, shared by the gateway's validators and the
+ * clients that build requests, so the two cannot drift.
+ */
+exports.CHECKOUT_LIMITS = Object.freeze({
+    lineItemsMax: 20,
+    quantityMax: 999999,
+    customFieldsMax: 3,
+    customFieldKeyMax: 200,
+    customFieldLabelMax: 50,
+    customFieldTextMax: 255,
+    dropdownOptionsMax: 200,
+    dropdownOptionLabelMax: 100,
+    dropdownOptionValueMax: 100,
+    clientReferenceIdMax: 200,
+    /** `expires_at` must be between 30 minutes and 24 hours from creation. */
+    expiresMinSeconds: 30 * 60,
+    expiresMaxSeconds: 24 * 3600,
+    shippingCountriesMax: 250,
+    termsTextMax: 1200,
+});
+/** The template a `success_url` may carry; replaced with the session's `cs_…`. */
+exports.CHECKOUT_SESSION_ID_TEMPLATE = '{CHECKOUT_SESSION_ID}';

package/dist/cjs/index.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-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;
+exports.PAYOUT_STATUSES = exports.BALANCE_TRANSACTION_TYPES = exports.BALANCE_TRANSACTION_STATUSES = exports.PAYOUT_WEEKLY_ANCHORS = exports.PAYOUT_INTERVALS = 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.DEFAULT_BRANDING = exports.BRANDING_COLOR_PATTERN = exports.BRANDING_BORDER_STYLES = exports.BRANDING_FONTS = exports.CHECKOUT_SESSION_ID_TEMPLATE = exports.CHECKOUT_LIMITS = exports.CHECKOUT_TAX_ID_TYPES = exports.CHECKOUT_CUSTOM_FIELD_TYPES = exports.CHECKOUT_BILLING_ADDRESS_COLLECTIONS = exports.CHECKOUT_CUSTOMER_CREATIONS = exports.CHECKOUT_SUBMIT_TYPES = exports.CHECKOUT_LOCALES = exports.CHECKOUT_UI_MODES = exports.CHECKOUT_PAYMENT_STATUSES = exports.CHECKOUT_SESSION_STATUSES = exports.CHECKOUT_SESSION_MODES = exports.PAYMENT_LINK_LIMITS = exports.MERCHANT_ENVIRONMENTS = exports.verifyWebhook = exports.signWebhook = exports.SIMULATED_FAIRCOIN_OUTCOMES = exports.REQUEST_LOG_RETENTION_DAYS = exports.REQUEST_LOG_METHODS = exports.REFUND_REASONS = exports.RECONCILIATION_MISMATCH_KINDS = 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; } });
@@ -57,6 +57,16 @@ 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 account_1 = require("./account");
+Object.defineProperty(exports, "PAYOUT_INTERVALS", { enumerable: true, get: function () { return account_1.PAYOUT_INTERVALS; } });
+Object.defineProperty(exports, "PAYOUT_WEEKLY_ANCHORS", { enumerable: true, get: function () { return account_1.PAYOUT_WEEKLY_ANCHORS; } });
+var balance_1 = require("./balance");
+Object.defineProperty(exports, "BALANCE_TRANSACTION_STATUSES", { enumerable: true, get: function () { return balance_1.BALANCE_TRANSACTION_STATUSES; } });
+Object.defineProperty(exports, "BALANCE_TRANSACTION_TYPES", { enumerable: true, get: function () { return balance_1.BALANCE_TRANSACTION_TYPES; } });
+Object.defineProperty(exports, "PAYOUT_STATUSES", { enumerable: true, get: function () { return balance_1.PAYOUT_STATUSES; } });
+Object.defineProperty(exports, "RECONCILIATION_MISMATCH_KINDS", { enumerable: true, get: function () { return balance_1.RECONCILIATION_MISMATCH_KINDS; } });
+var settlement_1 = require("./settlement");
+Object.defineProperty(exports, "REFUND_REASONS", { enumerable: true, get: function () { return settlement_1.REFUND_REASONS; } });
 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; } });
@@ -67,6 +77,26 @@ Object.defineProperty(exports, "signWebhook", { enumerable: true, get: function
 Object.defineProperty(exports, "verifyWebhook", { enumerable: true, get: function () { return webhookSigner_1.verifyWebhook; } });
 var merchant_1 = require("./merchant");
 Object.defineProperty(exports, "MERCHANT_ENVIRONMENTS", { enumerable: true, get: function () { return merchant_1.MERCHANT_ENVIRONMENTS; } });
+var paymentLink_1 = require("./paymentLink");
+Object.defineProperty(exports, "PAYMENT_LINK_LIMITS", { enumerable: true, get: function () { return paymentLink_1.PAYMENT_LINK_LIMITS; } });
+var checkoutSession_1 = require("./checkoutSession");
+Object.defineProperty(exports, "CHECKOUT_SESSION_MODES", { enumerable: true, get: function () { return checkoutSession_1.CHECKOUT_SESSION_MODES; } });
+Object.defineProperty(exports, "CHECKOUT_SESSION_STATUSES", { enumerable: true, get: function () { return checkoutSession_1.CHECKOUT_SESSION_STATUSES; } });
+Object.defineProperty(exports, "CHECKOUT_PAYMENT_STATUSES", { enumerable: true, get: function () { return checkoutSession_1.CHECKOUT_PAYMENT_STATUSES; } });
+Object.defineProperty(exports, "CHECKOUT_UI_MODES", { enumerable: true, get: function () { return checkoutSession_1.CHECKOUT_UI_MODES; } });
+Object.defineProperty(exports, "CHECKOUT_LOCALES", { enumerable: true, get: function () { return checkoutSession_1.CHECKOUT_LOCALES; } });
+Object.defineProperty(exports, "CHECKOUT_SUBMIT_TYPES", { enumerable: true, get: function () { return checkoutSession_1.CHECKOUT_SUBMIT_TYPES; } });
+Object.defineProperty(exports, "CHECKOUT_CUSTOMER_CREATIONS", { enumerable: true, get: function () { return checkoutSession_1.CHECKOUT_CUSTOMER_CREATIONS; } });
+Object.defineProperty(exports, "CHECKOUT_BILLING_ADDRESS_COLLECTIONS", { enumerable: true, get: function () { return checkoutSession_1.CHECKOUT_BILLING_ADDRESS_COLLECTIONS; } });
+Object.defineProperty(exports, "CHECKOUT_CUSTOM_FIELD_TYPES", { enumerable: true, get: function () { return checkoutSession_1.CHECKOUT_CUSTOM_FIELD_TYPES; } });
+Object.defineProperty(exports, "CHECKOUT_TAX_ID_TYPES", { enumerable: true, get: function () { return checkoutSession_1.CHECKOUT_TAX_ID_TYPES; } });
+Object.defineProperty(exports, "CHECKOUT_LIMITS", { enumerable: true, get: function () { return checkoutSession_1.CHECKOUT_LIMITS; } });
+Object.defineProperty(exports, "CHECKOUT_SESSION_ID_TEMPLATE", { enumerable: true, get: function () { return checkoutSession_1.CHECKOUT_SESSION_ID_TEMPLATE; } });
+var branding_1 = require("./branding");
+Object.defineProperty(exports, "BRANDING_FONTS", { enumerable: true, get: function () { return branding_1.BRANDING_FONTS; } });
+Object.defineProperty(exports, "BRANDING_BORDER_STYLES", { enumerable: true, get: function () { return branding_1.BRANDING_BORDER_STYLES; } });
+Object.defineProperty(exports, "BRANDING_COLOR_PATTERN", { enumerable: true, get: function () { return branding_1.BRANDING_COLOR_PATTERN; } });
+Object.defineProperty(exports, "DEFAULT_BRANDING", { enumerable: true, get: function () { return branding_1.DEFAULT_BRANDING; } });
 var social_1 = require("./social");
 Object.defineProperty(exports, "SOCIAL_SOURCE_APP_MAX_LENGTH", { enumerable: true, get: function () { return social_1.SOCIAL_SOURCE_APP_MAX_LENGTH; } });
 Object.defineProperty(exports, "SOCIAL_SOURCE_REF_MAX_LENGTH", { enumerable: true, get: function () { return social_1.SOCIAL_SOURCE_REF_MAX_LENGTH; } });

package/dist/cjs/paymentLink.js

@@ -1,2 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.PAYMENT_LINK_LIMITS = void 0;
+exports.PAYMENT_LINK_LIMITS = Object.freeze({
+    lineItemsMax: 20,
+    customMessageMax: 500,
+});

package/dist/cjs/settlement.js

@@ -1,2 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.REFUND_REASONS = void 0;
+/** Stripe's refund reasons. */
+exports.REFUND_REASONS = ['duplicate', 'fraudulent', 'requested_by_customer'];

package/dist/esm/account.js

@@ -0,0 +1,20 @@
+// The merchant's fiat account (ADR 0015 §1) — `GET /v1/account`.
+//
+// Orbit's funds never reach a Peable bank account: a merchant that takes fiat
+// has its OWN provider account, opened and onboarded through Peable, and this
+// object mirrors it. Everything here is what the provider last reported; the
+// provider is the authority and Orbit never decides readiness itself.
+//
+// A marketplace's sellers (`/v1/connected_accounts`) are provider accounts too,
+// and a platform reads one of them in this same shape by sending
+// `Peable-Account: ca_…` to `GET /v1/account`.
+export const PAYOUT_INTERVALS = ['manual', 'daily', 'weekly', 'monthly'];
+export const PAYOUT_WEEKLY_ANCHORS = [
+    'monday',
+    'tuesday',
+    'wednesday',
+    'thursday',
+    'friday',
+    'saturday',
+    'sunday',
+];

package/dist/esm/balance.js

@@ -0,0 +1,36 @@
+/** Orbit's vocabulary for what moved — the provider's own types, provider-neutral. */
+export const BALANCE_TRANSACTION_TYPES = [
+    'charge',
+    'payment',
+    'refund',
+    'payment_refund',
+    'adjustment',
+    'application_fee',
+    'application_fee_refund',
+    'payout',
+    'payout_cancel',
+    'payout_failure',
+    'transfer',
+    'transfer_refund',
+    'dispute',
+    'dispute_reversal',
+    'processing_fee',
+    'faircoin_payment',
+    'faircoin_payment_reversal',
+    'other',
+];
+/**
+ * - `pending` / `available` — the provider's own status for the funds.
+ * - `informational` — a FairCoin payment: recorded, never part of a payable balance.
+ */
+export const BALANCE_TRANSACTION_STATUSES = ['available', 'pending', 'informational'];
+export const PAYOUT_STATUSES = ['pending', 'in_transit', 'paid', 'failed', 'canceled'];
+/** What the daily reconciliation found disagreeing with the provider. Never auto-corrected. */
+export const RECONCILIATION_MISMATCH_KINDS = [
+    'missing_in_ledger',
+    'amount_mismatch',
+    'status_mismatch',
+    'missing_at_provider',
+    'payout_mismatch',
+    'unbalanced_journal',
+];

package/dist/esm/branding.js

@@ -0,0 +1,28 @@
+// Merchant branding and customer email settings (Orbit Phase 3).
+//
+// Branding is what the hosted checkout, the embedded checkout and Peable's
+// receipts look like for one merchant. Every value is from a CLOSED set or a
+// validated colour, so nothing a merchant stores can inject markup or a remote
+// font into a payer's page or an email.
+/** The fonts checkout may render in — system stacks only, no remote font is ever loaded. */
+export const BRANDING_FONTS = [
+    'system',
+    'inter',
+    'roboto',
+    'open_sans',
+    'lato',
+    'source_sans',
+    'noto_sans',
+    'serif',
+    'monospace',
+];
+export const BRANDING_BORDER_STYLES = ['rounded', 'rectangular', 'pill'];
+/** `#rrggbb`, lowercase — the only colour spelling branding stores. */
+export const BRANDING_COLOR_PATTERN = /^#[0-9a-f]{6}$/;
+/** Peable's defaults, applied wherever a merchant set nothing. */
+export const DEFAULT_BRANDING = Object.freeze({
+    primary_color: '#1f6feb',
+    accent_color: '#0b1f33',
+    font: 'system',
+    border_style: 'rounded',
+});

package/dist/esm/checkoutSession.js

@@ -1 +1,42 @@
-export {};
+export const CHECKOUT_SESSION_MODES = ['payment', 'setup', 'subscription'];
+export const CHECKOUT_SESSION_STATUSES = ['open', 'complete', 'expired'];
+export const CHECKOUT_PAYMENT_STATUSES = ['paid', 'unpaid', 'no_payment_required'];
+export const CHECKOUT_UI_MODES = ['hosted', 'embedded'];
+/** The languages the hosted and embedded checkout speak. */
+export const CHECKOUT_LOCALES = ['en', 'es', 'fr', 'de', 'it', 'pt'];
+export const CHECKOUT_SUBMIT_TYPES = ['auto', 'pay', 'book', 'donate'];
+export const CHECKOUT_CUSTOMER_CREATIONS = ['always', 'if_required'];
+export const CHECKOUT_BILLING_ADDRESS_COLLECTIONS = ['auto', 'required'];
+export const CHECKOUT_CUSTOM_FIELD_TYPES = ['text', 'numeric', 'dropdown'];
+/** Stripe's tax id types Peable collects; `eu_vat` covers every EU member state. */
+export const CHECKOUT_TAX_ID_TYPES = [
+    'eu_vat',
+    'gb_vat',
+    'ch_vat',
+    'no_vat',
+    'us_ein',
+    'ca_bn',
+];
+/**
+ * Bounds of the session contract, shared by the gateway's validators and the
+ * clients that build requests, so the two cannot drift.
+ */
+export const CHECKOUT_LIMITS = Object.freeze({
+    lineItemsMax: 20,
+    quantityMax: 999999,
+    customFieldsMax: 3,
+    customFieldKeyMax: 200,
+    customFieldLabelMax: 50,
+    customFieldTextMax: 255,
+    dropdownOptionsMax: 200,
+    dropdownOptionLabelMax: 100,
+    dropdownOptionValueMax: 100,
+    clientReferenceIdMax: 200,
+    /** `expires_at` must be between 30 minutes and 24 hours from creation. */
+    expiresMinSeconds: 30 * 60,
+    expiresMaxSeconds: 24 * 3600,
+    shippingCountriesMax: 250,
+    termsTextMax: 1200,
+});
+/** The template a `success_url` may carry; replaced with the session's `cs_…`. */
+export const CHECKOUT_SESSION_ID_TEMPLATE = '{CHECKOUT_SESSION_ID}';

package/dist/esm/index.js

@@ -8,10 +8,16 @@ export { PRICE_BILLING_SCHEMES, PRICE_TIERS_MODES, PRICE_TYPES, RECURRING_INTERV
 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 { PAYOUT_INTERVALS, PAYOUT_WEEKLY_ANCHORS, } from './account.js';
+export { BALANCE_TRANSACTION_STATUSES, BALANCE_TRANSACTION_TYPES, PAYOUT_STATUSES, RECONCILIATION_MISMATCH_KINDS, } from './balance.js';
+export { REFUND_REASONS } from './settlement.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 { PAYMENT_LINK_LIMITS, } from './paymentLink.js';
+export { CHECKOUT_SESSION_MODES, CHECKOUT_SESSION_STATUSES, CHECKOUT_PAYMENT_STATUSES, CHECKOUT_UI_MODES, CHECKOUT_LOCALES, CHECKOUT_SUBMIT_TYPES, CHECKOUT_CUSTOMER_CREATIONS, CHECKOUT_BILLING_ADDRESS_COLLECTIONS, CHECKOUT_CUSTOM_FIELD_TYPES, CHECKOUT_TAX_ID_TYPES, CHECKOUT_LIMITS, CHECKOUT_SESSION_ID_TEMPLATE, } from './checkoutSession.js';
+export { BRANDING_FONTS, BRANDING_BORDER_STYLES, BRANDING_COLOR_PATTERN, DEFAULT_BRANDING, } from './branding.js';
 export { SOCIAL_SOURCE_APP_MAX_LENGTH, SOCIAL_SOURCE_REF_MAX_LENGTH, } from './social.js';
 export { BILLING_SUBSCRIPTION_STATUSES, } from './billing.js';
 export { canonicalBillingAuthority, canonicalBillingTaxQuote, PEABLE_BILLING_AUTHORITY_KEYS, } from './billing-authority.js';

package/dist/esm/paymentLink.js

@@ -1 +1,4 @@
-export {};
+export const PAYMENT_LINK_LIMITS = Object.freeze({
+    lineItemsMax: 20,
+    customMessageMax: 500,
+});

package/dist/esm/settlement.js

@@ -1 +1,2 @@
-export {};
+/** Stripe's refund reasons. */
+export const REFUND_REASONS = ['duplicate', 'fraudulent', 'requested_by_customer'];

package/dist/types/account.d.ts

@@ -0,0 +1,120 @@
+/** A capability's state as the provider reports it; `null` means never requested. */
+export type AccountCapabilityStatus = 'active' | 'pending' | 'inactive';
+/** Whose account this is: the merchant's own, or one of its marketplace sellers. */
+export type AccountType = 'merchant' | 'connected';
+/**
+ * What the provider is waiting on. Requirement IDENTIFIERS only
+ * (`individual.verification.document`), never their values: the gateway
+ * records that a document is owed and never learns what it says.
+ */
+export interface AccountRequirements {
+    currently_due: string[];
+    eventually_due: string[];
+    past_due: string[];
+    /** Submitted and being checked — nothing for the merchant to do. */
+    pending_verification: string[];
+    /** Why charges or payouts are disabled, in the provider's own code, or `null`. */
+    disabled_reason: string | null;
+}
+export interface AccountBusinessProfile {
+    name: string | null;
+    url: string | null;
+    support_email: string | null;
+    support_url: string | null;
+    product_description: string | null;
+    /** Merchant category code. */
+    mcc: string | null;
+}
+export declare const PAYOUT_INTERVALS: readonly ["manual", "daily", "weekly", "monthly"];
+export type PayoutInterval = (typeof PAYOUT_INTERVALS)[number];
+export declare const PAYOUT_WEEKLY_ANCHORS: readonly ["monday", "tuesday", "wednesday", "thursday", "friday", "saturday", "sunday"];
+export type PayoutWeeklyAnchor = (typeof PAYOUT_WEEKLY_ANCHORS)[number];
+/**
+ * When the provider pays the balance out. `manual` means only an explicit
+ * `POST /v1/payouts` does — the provider still executes it; Orbit never moves
+ * the money itself (ADR 0015 §4).
+ */
+export interface AccountPayoutSchedule {
+    interval: PayoutInterval;
+    /** Days between a payment and its funds becoming payable; `null` when not reported. */
+    delay_days: number | null;
+    /** `weekly` only. */
+    weekly_anchor: PayoutWeeklyAnchor | null;
+    /** `monthly` only: the day of the month, 1–31. */
+    monthly_anchor: number | null;
+}
+export interface AccountSettings {
+    payouts: {
+        schedule: AccountPayoutSchedule | null;
+        /** What the merchant's bank statement shows for a payout. */
+        statement_descriptor: string | null;
+    };
+    payments: {
+        /** What a cardholder's statement shows — the merchant is the merchant of record. */
+        statement_descriptor: string | null;
+    };
+    branding: {
+        primary_color: string | null;
+        secondary_color: string | null;
+    };
+}
+export interface Account {
+    /** `ca_…` — the same id space as a marketplace seller. */
+    id: string;
+    object: 'account';
+    /** `true` for a `production` merchant (ADR 0017). */
+    livemode: boolean;
+    type: AccountType;
+    /** ISO 3166-1 alpha-2. Fixed at the provider once created. */
+    country: string;
+    default_currency: string | null;
+    business_profile: AccountBusinessProfile;
+    capabilities: {
+        card_payments: AccountCapabilityStatus | null;
+        transfers: AccountCapabilityStatus | null;
+    };
+    requirements: AccountRequirements;
+    /** Whether the account can take payments as merchant of record (`on_behalf_of`). */
+    charges_enabled: boolean;
+    /** Whether the provider will pay this account's balance out. */
+    payouts_enabled: boolean;
+    settings: AccountSettings;
+    /** The last provider read; `null` before the first one completed. */
+    last_synced_at: number | null;
+    created: number;
+}
+/** `POST /v1/account`: the account's settings, written to the provider and read back. */
+export interface UpdateAccountParams {
+    /**
+     * Opening the account: required the first time (when the merchant has none),
+     * refused afterwards — a provider account's country cannot change.
+     */
+    country?: string;
+    business_type?: 'individual' | 'company';
+    business_profile?: Partial<AccountBusinessProfile>;
+    settings?: {
+        payouts?: {
+            schedule?: {
+                interval: PayoutInterval;
+                delay_days?: number;
+                weekly_anchor?: PayoutWeeklyAnchor;
+                monthly_anchor?: number;
+            };
+            statement_descriptor?: string;
+        };
+        payments?: {
+            statement_descriptor?: string;
+        };
+        branding?: {
+            primary_color?: string;
+            secondary_color?: string;
+        };
+    };
+}
+/** `POST /v1/account_links`: hosted onboarding (or an update of what was submitted). */
+export interface CreateAccountLinkParams {
+    refresh_url: string;
+    return_url: string;
+    /** Defaults to `account_onboarding`. */
+    type?: 'account_onboarding' | 'account_update';
+}