@peable.to/contracts 0.4.0 → 1.1.0

package/dist/cjs/resources/tax/settings.js

@@ -0,0 +1,104 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.taxSettingsRoutes = exports.updateTaxSettingsParams = exports.taxSettingsSchema = exports.taxAddressParams = exports.taxAddressSchema = void 0;
+const zod_1 = require("zod");
+const objects_1 = require("../../common/objects");
+const primitives_1 = require("../../common/primitives");
+const route_1 = require("../../route");
+const tax_1 = require("../../vocabulary/tax");
+const shared_1 = require("./shared");
+/**
+ * Peable Tax settings (ADR 0011): the seller's legal identity and defaults, and
+ * whether the owner has approved collection. Changed and approved by the owner
+ * in Orbit only; the merchant API reads them.
+ */
+/** An address as Peable Tax stores it: only `country` is always present. */
+exports.taxAddressSchema = (0, objects_1.defineComponent)('TaxAddress', zod_1.z
+    .object({
+    country: shared_1.taxCountry,
+    state: zod_1.z
+        .string()
+        .nullable()
+        .optional()
+        .describe('ISO 3166-2 subdivision without the country prefix (`CA`, `QC`).'),
+    postal_code: zod_1.z.string().nullable().optional(),
+    city: zod_1.z.string().nullable().optional(),
+    line1: zod_1.z.string().nullable().optional(),
+    line2: zod_1.z.string().nullable().optional(),
+})
+    .strict());
+const addressLine = zod_1.z.string().trim().min(1).max(200).nullish();
+/** An address in a tax request. */
+exports.taxAddressParams = zod_1.z
+    .object({
+    country: zod_1.z.string().regex(/^[A-Z]{2}$/),
+    state: zod_1.z
+        .string()
+        .regex(/^[A-Z0-9]{1,3}$/)
+        .nullish(),
+    postal_code: zod_1.z.string().trim().min(1).max(20).nullish(),
+    city: addressLine,
+    line1: addressLine,
+    line2: addressLine,
+})
+    .strict();
+exports.taxSettingsSchema = (0, objects_1.defineObject)('tax.settings', 'TaxSettings', zod_1.z
+    .object({
+    object: zod_1.z.literal('tax.settings'),
+    merchant_id: zod_1.z.string().describe('The merchant (`merch_…`) these settings belong to.'),
+    status: zod_1.z
+        .enum(tax_1.TAX_SETTINGS_STATUSES)
+        .describe('`active` once the owner approved; any edit returns it to `draft`.'),
+    legal_name: primitives_1.nullableString,
+    head_office: exports.taxAddressSchema.nullable(),
+    default_tax_code: zod_1.z.string().describe('The `txcd_…` a line without its own code uses.'),
+    default_tax_behavior: zod_1.z.enum(tax_1.TAX_BEHAVIORS),
+    calculation_account: zod_1.z
+        .enum(tax_1.TAX_CALCULATION_ACCOUNTS)
+        .describe("`platform`: Peable's own provider account (official Oxy applications only). `none`: registered sales cannot be calculated and fail closed."),
+    provider: primitives_1.nullableString.describe('The provider that calculates registered sales, when one is reachable.'),
+    approved_at: primitives_1.unixSeconds.nullable(),
+    approved_by: primitives_1.nullableString.describe('The Oxy user who approved collection.'),
+    updated_at: primitives_1.unixSeconds.nullable(),
+})
+    .strict(), {
+    examples: [
+        {
+            object: 'tax.settings',
+            merchant_id: 'merch_0193b8f2c1a87d3e9f4a',
+            status: 'active',
+            legal_name: 'Example Software SL',
+            head_office: { country: 'ES', state: null, postal_code: '08001', city: 'Barcelona' },
+            default_tax_code: 'txcd_10103001',
+            default_tax_behavior: 'exclusive',
+            calculation_account: 'platform',
+            provider: 'stripe_tax',
+            approved_at: 1793750400,
+            approved_by: 'user_42',
+            updated_at: 1793750400,
+        },
+    ],
+});
+/** Orbit's settings update (the owner's, never the merchant API's). Any change returns the settings to `draft`. */
+exports.updateTaxSettingsParams = zod_1.z
+    .object({
+    legal_name: zod_1.z.string().trim().min(1).max(200).nullable().optional(),
+    head_office: exports.taxAddressParams.nullable().optional(),
+    default_tax_code: zod_1.z.string().optional(),
+    default_tax_behavior: zod_1.z.enum(tax_1.TAX_BEHAVIORS).optional(),
+})
+    .strict();
+exports.taxSettingsRoutes = [
+    (0, route_1.defineRoute)({
+        operationId: 'retrieveTaxSettings',
+        method: 'get',
+        path: '/v1/tax/settings',
+        tag: 'Tax',
+        summary: 'Retrieve tax settings',
+        description: 'Settings are changed, and collection approved, by the owner in Orbit. Until approved, `POST /v1/tax/calculations` refuses with `tax_settings_not_active`.',
+        auth: 'service',
+        scope: 'payments:read',
+        response: exports.taxSettingsSchema,
+        sdk: 'tax.retrieveSettings',
+    }),
+];

package/dist/cjs/resources/tax/shared.js

@@ -0,0 +1,62 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.complianceIdParam = exports.complianceTextParam = exports.complianceStateParam = exports.complianceCountryParam = exports.taxFacts = exports.taxCoverageLimitSchema = exports.taxRuleSourceSchema = exports.taxInstantParam = exports.taxReferenceParam = exports.taxMinorAmount = exports.taxState = exports.taxCountry = void 0;
+const zod_1 = require("zod");
+const objects_1 = require("../../common/objects");
+const params_1 = require("../../common/params");
+/**
+ * Building blocks every Peable Tax resource shares.
+ *
+ * Tax AMOUNTS (calculations, transactions, the report) are integer JSON
+ * numbers in the currency's minor unit, as Peable Tax has always answered
+ * them: unlike a FAIR amount, a tax amount is denominated in a fiat currency
+ * and is bounded by the safe-integer checks the calculator applies. Business
+ * compliance (ADR 0020) amounts are base-unit strings, as ADR 0014 D1 has it.
+ */
+/** ISO 3166-1 alpha-2, as returned. */
+exports.taxCountry = zod_1.z.string().describe('ISO 3166-1 alpha-2.');
+/** An ISO 3166-2 subdivision without its country prefix (`CA`, `QC`), as returned. */
+exports.taxState = zod_1.z
+    .string()
+    .nullable()
+    .describe('ISO 3166-2 subdivision without the country prefix (`CA`, `QC`).');
+/** A minor-unit integer amount (cents), signed: a reversal's amounts are negative. */
+exports.taxMinorAmount = zod_1.z
+    .number()
+    .int()
+    .describe('Minor units of `currency` (cents), as an integer.');
+/** A Peable-side reference: a product, a customer, a refund. */
+exports.taxReferenceParam = zod_1.z
+    .string()
+    .min(1)
+    .max(128)
+    .regex(/^[A-Za-z0-9_.:-]+$/);
+/** An instant in a tax request body. */
+exports.taxInstantParam = params_1.unixSecondsParam;
+/** An official source a rule rests on. */
+exports.taxRuleSourceSchema = (0, objects_1.defineComponent)('TaxRuleSource', zod_1.z
+    .object({
+    title: zod_1.z.string(),
+    publisher: zod_1.z.string(),
+    url: zod_1.z.string(),
+})
+    .strict());
+/** What a rule cannot see or decide, stated rather than implied. */
+exports.taxCoverageLimitSchema = (0, objects_1.defineComponent)('TaxCoverageLimit', zod_1.z.object({ code: zod_1.z.string(), message: zod_1.z.string() }).strict());
+/** The facts a finding or a change rests on: field names, counts, ids — never personal data. */
+exports.taxFacts = zod_1.z.record(zod_1.z.string(), zod_1.z.union([zod_1.z.string(), zod_1.z.number(), zod_1.z.boolean(), zod_1.z.null()]));
+// ── Business compliance request fields (ADR 0020) ────────────────────────────
+/** A country in a compliance request. */
+exports.complianceCountryParam = zod_1.z
+    .string()
+    .regex(/^[A-Z]{2}$/, 'a country is an ISO 3166-1 alpha-2 code');
+/** A subdivision in a compliance request; `null` for the whole country. */
+exports.complianceStateParam = zod_1.z
+    .string()
+    .regex(/^[A-Z0-9]{1,3}$/, 'a state is its ISO 3166-2 subdivision code')
+    .nullable();
+/** Free text in a compliance request: trimmed, never empty (`null` clears it). */
+const complianceTextParam = (max) => zod_1.z.string().trim().min(1).max(max).nullable();
+exports.complianceTextParam = complianceTextParam;
+/** An id another compliance object is linked by (`taxrd_…`, `taxreg_…`, `file_…`). */
+exports.complianceIdParam = zod_1.z.string().min(1).max(64);

package/dist/cjs/resources/tax/transactions.js

@@ -0,0 +1,102 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.taxTransactionRoutes = exports.createTaxReversalParams = exports.listTaxTransactionsQuery = exports.taxTransactionSchema = exports.taxTransactionReversalSchema = void 0;
+const zod_1 = require("zod");
+const envelopes_1 = require("../../common/envelopes");
+const objects_1 = require("../../common/objects");
+const params_1 = require("../../common/params");
+const primitives_1 = require("../../common/primitives");
+const route_1 = require("../../route");
+const tax_1 = require("../../vocabulary/tax");
+const calculations_1 = require("./calculations");
+const shared_1 = require("./shared");
+/**
+ * A tax transaction (`taxtxn_…`, ADR 0011/0013): a calculation that was paid,
+ * created by Peable when the payment it priced is accepted on its rail. The
+ * report and filings are built from these. A `reversal` is a refund (or credit
+ * note) of an earlier transaction, netted into the original's report rows,
+ * never a deletion of it.
+ */
+/**
+ * What a reversal gave back: the original calculation's amounts, scaled to the
+ * refunded share and NEGATIVE (positive only when it reinstates an earlier
+ * reversal, e.g. a refund the bank later failed).
+ */
+exports.taxTransactionReversalSchema = (0, objects_1.defineComponent)('TaxTransactionReversal', zod_1.z
+    .object({
+    amount_total: shared_1.taxMinorAmount,
+    amount_net: shared_1.taxMinorAmount,
+    tax_amount: shared_1.taxMinorAmount,
+    line_items: zod_1.z.array(calculations_1.taxCalculationLineItemSchema),
+})
+    .strict());
+exports.taxTransactionSchema = (0, objects_1.defineObject)('tax.transaction', 'TaxTransaction', zod_1.z
+    .object({
+    object: zod_1.z.literal('tax.transaction'),
+    id: zod_1.z.string().describe('`taxtxn_…`.'),
+    type: zod_1.z.enum(tax_1.TAX_TRANSACTION_TYPES),
+    calculation_id: zod_1.z.string().describe('The calculation (`taxcalc_…`) that was paid.'),
+    reference: zod_1.z.string().describe("The rail's own object, e.g. the invoice id."),
+    rail: zod_1.z.string(),
+    committed_at: primitives_1.unixSeconds.describe('The tax date a filing period is judged by.'),
+    reversal_of: primitives_1.nullableString.describe("The original transaction's id, for a reversal."),
+    reversal: exports.taxTransactionReversalSchema.nullable(),
+    calculation: calculations_1.taxCalculationSchema,
+})
+    .strict());
+/** The shared list parameters; `created[...]` filters `committed_at`. */
+exports.listTaxTransactionsQuery = (0, params_1.listQuery)({});
+/**
+ * Record a refund made outside Peable (a FairCoin payment is refunded from the
+ * seller's own wallet, never by the gateway). Card refunds and credit notes are
+ * observed from the provider instead, so the two cannot double-count one refund.
+ */
+exports.createTaxReversalParams = zod_1.z
+    .object({
+    reference: zod_1.z
+        .string()
+        .min(1)
+        .max(200)
+        .regex(/^[A-Za-z0-9_.:-]+$/)
+        .describe("The refund's own reference; a repeated reference returns the same reversal."),
+    amount: zod_1.z
+        .number()
+        .int()
+        .positive()
+        .safe()
+        .optional()
+        .describe('Gross minor units refunded (what the payer got back). Omitted: everything not yet reversed.'),
+})
+    .strict();
+exports.taxTransactionRoutes = [
+    (0, route_1.defineRoute)({
+        operationId: 'listTaxTransactions',
+        method: 'get',
+        path: '/v1/tax/transactions',
+        tag: 'Tax',
+        summary: 'List tax transactions',
+        description: 'Newest first. `created` filters on `committed_at` — the tax date a filing period is judged by.',
+        auth: 'service',
+        scope: 'payments:read',
+        query: exports.listTaxTransactionsQuery,
+        response: (0, envelopes_1.listOf)(exports.taxTransactionSchema),
+        sdk: 'tax.transactions.list',
+        expandable: 'tax.transaction',
+    }),
+    (0, route_1.defineRoute)({
+        operationId: 'createTaxReversal',
+        method: 'post',
+        path: '/v1/tax/transactions/{id}/reversals',
+        tag: 'Tax',
+        summary: 'Reverse a tax transaction',
+        description: 'For a refund the rail cannot report itself (FairCoin). Card refunds and credit notes, and Orbit invoices, are reversed from their own records and are refused here.',
+        auth: 'service',
+        scope: 'payments:write',
+        idempotent: true,
+        params: { id: 'The original transaction (`taxtxn_…`).' },
+        body: exports.createTaxReversalParams,
+        response: exports.taxTransactionSchema,
+        status: 201,
+        sdk: 'tax.transactions.createReversal',
+    }),
+];

package/dist/cjs/route.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.defineRoute = defineRoute;
+exports.expressPath = expressPath;
+exports.pathParamNames = pathParamNames;
+exports.isJsonResponse = isJsonResponse;
+/** Declare a route, keeping its literal types for the SDK's inference. */
+function defineRoute(route) {
+    return route;
+}
+/** `/v1/customers/{id}` → `/v1/customers/:id`, Express's spelling. */
+function expressPath(path) {
+    return path.replace(/\{([^}]+)\}/g, ':$1');
+}
+/** The path parameter names of a template, in order. */
+function pathParamNames(path) {
+    return [...path.matchAll(/\{([^}]+)\}/g)].map((match) => match[1]);
+}
+/** Whether `response` is a JSON schema (as opposed to bytes or a stream). */
+function isJsonResponse(response) {
+    return '_zod' in response;
+}

package/dist/cjs/routes.js

@@ -0,0 +1,31 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.routes = void 0;
+exports.routeOf = routeOf;
+const billingEngine_1 = require("./resources/billingEngine");
+const catalog_1 = require("./resources/catalog");
+const checkout_1 = require("./resources/checkout");
+const connect_1 = require("./resources/connect");
+const core_1 = require("./resources/core");
+const events_1 = require("./resources/events");
+const payments_1 = require("./resources/payments");
+const tax_1 = require("./resources/tax");
+// Annotated, not inferred: the inferred tuple of every route is larger than the
+// declaration emitter serializes. Each group's own tuple keeps its literal types.
+exports.routes = [
+    ...core_1.coreRoutes,
+    ...payments_1.paymentsRoutes,
+    ...checkout_1.checkoutRoutes,
+    ...catalog_1.catalogRoutes,
+    ...billingEngine_1.billingEngineRoutes,
+    ...connect_1.connectRoutes,
+    ...tax_1.taxRoutes,
+    ...events_1.eventsRoutes,
+];
+/** The route of an operation. */
+function routeOf(operationId) {
+    const route = exports.routes.find((candidate) => candidate.operationId === operationId);
+    if (!route)
+        throw new Error(`no route '${operationId}'`);
+    return route;
+}

package/dist/cjs/vocabulary/billingPortal.js

@@ -0,0 +1,15 @@
+"use strict";
+// The customer portal (ADR 0018 §9) — the closed value sets its schemas are
+// built from. Zod-free: `@peable.to/shared-types` re-exports them at runtime.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PORTAL_PAYMENT_METHOD_UPDATE_STATUSES = exports.PORTAL_SUBSCRIPTION_UPDATES = exports.PORTAL_CANCEL_PRORATION_BEHAVIORS = exports.PORTAL_CANCEL_MODES = exports.PORTAL_CUSTOMER_UPDATES = void 0;
+/** What a portal customer may edit about themselves. */
+exports.PORTAL_CUSTOMER_UPDATES = ['email', 'name', 'address', 'phone'];
+/** When a cancellation from the portal takes effect. */
+exports.PORTAL_CANCEL_MODES = ['at_period_end', 'immediately'];
+/** How a cancellation from the portal prorates. */
+exports.PORTAL_CANCEL_PRORATION_BEHAVIORS = ['create_prorations', 'none'];
+/** What a plan change from the portal may change. */
+exports.PORTAL_SUBSCRIPTION_UPDATES = ['price', 'quantity'];
+/** What finishing a payment method update from the portal answered. */
+exports.PORTAL_PAYMENT_METHOD_UPDATE_STATUSES = ['succeeded', 'pending'];

package/dist/cjs/vocabulary/catalog.js

@@ -0,0 +1,110 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BILLING_RAIL_RENEWALS = exports.BILLING_RAIL_SETTLEMENTS = exports.BILLING_SUBSCRIPTION_STATUSES = exports.METER_STATUSES = exports.METER_AGGREGATIONS = exports.BILLING_SETTINGS_LIMITS = exports.DUNNING_INVOICE_ACTIONS = exports.DUNNING_FINAL_ACTIONS = exports.TEST_CLOCK_STATUSES = exports.RECURRING_INTERVAL_COUNT_MAX = exports.CATALOG_MAX_WHOLE_UNITS = 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 = void 0;
+exports.maxBaseUnits = maxBaseUnits;
+// The catalog's and the billing engine platform's closed value sets (ADR 0016,
+// ADR 0018): what a price, a coupon, a test clock, a meter and the billing
+// settings can say, and the bounds the gateway enforces — restated so a form
+// can say them first. Zod-free: the wallet bundles this.
+const money_1 = require("./money");
+/** How a price's amount is computed from a quantity. */
+exports.PRICE_BILLING_SCHEMES = ['per_unit', 'tiered'];
+/**
+ * How a tiered price reads its tiers.
+ *
+ *  - `volume`    — the WHOLE quantity is priced at the tier it falls into.
+ *  - `graduated` — each unit is priced at the tier it falls into, so a
+ *                  quantity crossing two tiers pays each tier's rate for its
+ *                  share, plus the flat amount of every tier it reaches.
+ */
+exports.PRICE_TIERS_MODES = ['graduated', 'volume'];
+/** `recurring` when the price has a recurring component, `one_time` otherwise. */
+exports.PRICE_TYPES = ['one_time', 'recurring'];
+exports.RECURRING_INTERVALS = ['day', 'week', 'month', 'year'];
+/**
+ * `licensed` bills the quantity on the subscription. `metered` bills the usage
+ * a meter (`recurring.meter`, `mtr_…`) aggregated over the period, in arrears.
+ */
+exports.RECURRING_USAGE_TYPES = ['licensed', 'metered'];
+/**
+ * Whether a price includes tax (Peable Tax, ADR 0011). `unspecified` defers to
+ * the merchant's default tax behavior; once a price says `inclusive` or
+ * `exclusive` it can never change.
+ */
+exports.PRICE_TAX_BEHAVIORS = ['inclusive', 'exclusive', 'unspecified'];
+exports.TRANSFORM_QUANTITY_ROUNDS = ['up', 'down'];
+/** How long a coupon's discount lasts once applied to a subscription. */
+exports.COUPON_DURATIONS = ['once', 'repeating', 'forever'];
+/** The bounds the gateway enforces, published so a form can say them first. */
+exports.CATALOG_LIMITS = Object.freeze({
+    productNameMax: 250,
+    productDescriptionMax: 40000,
+    productImagesMax: 8,
+    urlMax: 2048,
+    unitLabelMax: 12,
+    statementDescriptorMax: 22,
+    marketingFeaturesMax: 15,
+    marketingFeatureNameMax: 80,
+    priceNicknameMax: 250,
+    lookupKeyMax: 200,
+    lookupKeysFilterMax: 10,
+    priceTiersMax: 250,
+    couponIdMax: 64,
+    couponNameMax: 40,
+    couponAppliesToProductsMax: 100,
+    couponDurationInMonthsMax: 1200,
+    promotionCodeMax: 64,
+    idsFilterMax: 100,
+});
+/**
+ * The largest amount the catalog stores, in whole units of any currency, so a
+ * FAIR amount (8 decimals) and a EUR amount (2) are bounded at the same real
+ * size rather than the same number of digits.
+ */
+exports.CATALOG_MAX_WHOLE_UNITS = 1000000000n;
+/** The largest base-unit amount of `currency` the catalog accepts. */
+function maxBaseUnits(currency) {
+    return exports.CATALOG_MAX_WHOLE_UNITS * 10n ** BigInt((0, money_1.decimalsFor)(currency)) - 1n;
+}
+/** The longest a recurring interval may be: three years, in each unit. */
+exports.RECURRING_INTERVAL_COUNT_MAX = Object.freeze({
+    day: 1095,
+    week: 156,
+    month: 36,
+    year: 3,
+});
+// ---- Test clocks -------------------------------------------------------------
+exports.TEST_CLOCK_STATUSES = ['ready', 'advancing', 'internal_failure'];
+// ---- Billing settings --------------------------------------------------------
+/** What dunning does to a subscription once the last retry has failed. */
+exports.DUNNING_FINAL_ACTIONS = ['cancel', 'unpaid', 'past_due'];
+/** What happens to the invoice itself once the last retry has failed. */
+exports.DUNNING_INVOICE_ACTIONS = ['leave_open', 'mark_uncollectible'];
+/** The bounds the gateway enforces on billing settings. */
+exports.BILLING_SETTINGS_LIMITS = Object.freeze({
+    retriesMax: 8,
+    retryDaysMax: 60,
+    daysUntilDueMax: 365,
+    invoicePrefixPattern: '^[A-Z0-9]{3,12}$',
+});
+// ---- Meters ------------------------------------------------------------------
+/** How a meter combines a period's events into the quantity billed. */
+exports.METER_AGGREGATIONS = ['sum', 'count', 'last'];
+exports.METER_STATUSES = ['active', 'inactive'];
+// ---- Recurring billing transport (`/v1/billing/*`) ---------------------------
+/** A provider subscription's status, as the recurring transport observes it. */
+exports.BILLING_SUBSCRIPTION_STATUSES = [
+    'incomplete',
+    'incomplete_expired',
+    'trialing',
+    'active',
+    'past_due',
+    'canceled',
+    'unpaid',
+    'paused',
+];
+/** `fiat` (Stripe and any further provider) or `faircoin` (native, to the merchant's watch-only wallet). */
+exports.BILLING_RAIL_SETTLEMENTS = ['fiat', 'faircoin'];
+/** `automatic`: the provider charges each period. `payer_initiated`: each period is an explicit payment. */
+exports.BILLING_RAIL_RENEWALS = ['automatic', 'payer_initiated'];
+// Product tax codes are Peable Tax's vocabulary: `vocabulary/tax.ts` (`TAX_CODES`).

package/dist/cjs/vocabulary/checkout.js

@@ -0,0 +1,53 @@
+"use strict";
+// Checkout vocabulary (Orbit Phase 3): the closed value sets and bounds of
+// Checkout Sessions and Payment Links. Zod-free, so the hosted checkout and
+// the wallet import them without the schemas (`@peable.to/contracts/vocabulary`,
+// re-exported by `@peable.to/shared-types`).
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PAYMENT_LINK_LIMITS = 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}';
+exports.PAYMENT_LINK_LIMITS = Object.freeze({
+    lineItemsMax: 20,
+    customMessageMax: 500,
+});

package/dist/cjs/vocabulary/connect.js

@@ -0,0 +1,95 @@
+"use strict";
+// Connect and money vocabulary (ADR 0012, ADR 0015): the closed value sets of
+// accounts, balances, payouts, application fees, transfers and reconciliation.
+// Zod-free, like every vocabulary module.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TRANSFER_REVERSAL_STATUSES = exports.TRANSFER_STATUSES = exports.RECONCILIATION_MISMATCH_KINDS = exports.PAYOUT_RECONCILIATION_STATUSES = exports.PAYOUT_DESTINATION_TYPES = exports.PAYOUT_METHODS = exports.PAYOUT_STATUSES = exports.BALANCE_TRANSACTION_FEE_TYPES = exports.BALANCE_TRANSACTION_STATUSES = exports.BALANCE_TRANSACTION_TYPES = exports.PAYOUT_WEEKLY_ANCHORS = exports.PAYOUT_INTERVALS = exports.CONNECTED_ACCOUNT_FAIRCOIN_STATUSES = exports.CONNECTED_ACCOUNT_RAILS = exports.ACCOUNT_LINK_TYPES = exports.ACCOUNT_TYPES = exports.ACCOUNT_CAPABILITY_STATUSES = exports.ACCOUNT_BUSINESS_TYPES = void 0;
+/** Which half of an account a business type opens: the provider's two kinds. */
+exports.ACCOUNT_BUSINESS_TYPES = ['individual', 'company'];
+/** A capability's state as the provider reports it; `null` on the wire means never requested. */
+exports.ACCOUNT_CAPABILITY_STATUSES = ['active', 'pending', 'inactive'];
+/** Whose account an `account` is: the merchant's own, or one of its marketplace sellers. */
+exports.ACCOUNT_TYPES = ['merchant', 'connected'];
+/** What a hosted onboarding link for the merchant's own account is for. */
+exports.ACCOUNT_LINK_TYPES = ['account_onboarding', 'account_update'];
+/**
+ * Which rails a seller's account was opened for (ADR 0012 D1). One seller is
+ * ONE `ca_…`: `card` is the provider account a marketplace settles to by
+ * transfer, `faircoin` is the seller's own watch-only key.
+ */
+exports.CONNECTED_ACCOUNT_RAILS = ['card', 'faircoin'];
+/**
+ * Where a seller's FairCoin half stands: `pending` until the seller registers
+ * a key, `active` once they did.
+ */
+exports.CONNECTED_ACCOUNT_FAIRCOIN_STATUSES = ['pending', 'active'];
+exports.PAYOUT_INTERVALS = ['manual', 'daily', 'weekly', 'monthly'];
+exports.PAYOUT_WEEKLY_ANCHORS = [
+    'monday',
+    'tuesday',
+    'wednesday',
+    'thursday',
+    'friday',
+    'saturday',
+    'sunday',
+];
+/** 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'];
+/** One component of a transaction's fee. `processing_fee` is the acquirer's own. */
+exports.BALANCE_TRANSACTION_FEE_TYPES = [
+    'application_fee',
+    'processing_fee',
+    'tax',
+    'other',
+];
+exports.PAYOUT_STATUSES = ['pending', 'in_transit', 'paid', 'failed', 'canceled'];
+exports.PAYOUT_METHODS = ['standard', 'instant'];
+exports.PAYOUT_DESTINATION_TYPES = ['bank_account', 'card'];
+/**
+ * A payout reconciliation report's state: `complete` once the payout is `paid`
+ * and its transactions were read from the provider, `pending` before.
+ */
+exports.PAYOUT_RECONCILIATION_STATUSES = ['complete', 'pending'];
+/** 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',
+];
+/** Where one settlement stands. */
+exports.TRANSFER_STATUSES = [
+    'pending',
+    'paid',
+    'partially_reversed',
+    'reversed',
+    'failed',
+];
+/** Where one reversal of a settlement stands. */
+exports.TRANSFER_REVERSAL_STATUSES = ['pending', 'succeeded', 'failed'];