@peable.to/shared-types 0.15.0 → 0.17.0

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/file.js

@@ -3,7 +3,7 @@
 // (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;
+exports.FILE_PURPOSE_POLICIES = exports.FILE_STATUSES = exports.FILE_TYPES = exports.FILE_UPLOAD_PURPOSES = 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
@@ -15,9 +15,22 @@ exports.FILE_PURPOSES = [
     'business_logo',
     'identity_document',
     'additional_verification',
+    'finance_report_run',
+];
+/**
+ * The purposes a merchant may upload or import. `finance_report_run` is not
+ * among them: a report's CSV is written by Peable's report runs
+ * (`/v1/reporting/report_runs`) and nobody else, so a file of that purpose is
+ * always a report Peable produced.
+ */
+exports.FILE_UPLOAD_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'];
+exports.FILE_TYPES = ['pdf', 'png', 'jpg', 'csv'];
 /**
  * Whether the bytes can be used right now.
  *
@@ -29,16 +42,18 @@ exports.FILE_TYPES = ['pdf', 'png', 'jpg'];
  */
 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 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.
+ * dispute submission it was meant for. `finance_report_run` is Peable's own
+ * output (see {@link FILE_UPLOAD_PURPOSES}); its ceiling bounds a report.
  */
 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 },
+    finance_report_run: { types: ['csv'], max_bytes: 64 * 1024 * 1024 },
 });

package/dist/cjs/index.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-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.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;
+exports.REPORT_TYPE_LAYOUTS = exports.REPORT_TYPE_IDS = exports.REPORT_RUN_STATUSES = exports.SEARCH_SUBSTRING_MIN_LENGTH = exports.SEARCH_QUERY_MAX_LENGTH = exports.SEARCH_QUERY_MAX_CLAUSES = exports.SEARCHABLE_RESOURCES = exports.FILE_TYPES = exports.FILE_STATUSES = exports.FILE_UPLOAD_PURPOSES = 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 = 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 = 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; } });
@@ -51,8 +51,18 @@ Object.defineProperty(exports, "normalizeDisputeReason", { enumerable: true, get
 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_UPLOAD_PURPOSES", { enumerable: true, get: function () { return file_1.FILE_UPLOAD_PURPOSES; } });
 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 search_1 = require("./search");
+Object.defineProperty(exports, "SEARCHABLE_RESOURCES", { enumerable: true, get: function () { return search_1.SEARCHABLE_RESOURCES; } });
+Object.defineProperty(exports, "SEARCH_QUERY_MAX_CLAUSES", { enumerable: true, get: function () { return search_1.SEARCH_QUERY_MAX_CLAUSES; } });
+Object.defineProperty(exports, "SEARCH_QUERY_MAX_LENGTH", { enumerable: true, get: function () { return search_1.SEARCH_QUERY_MAX_LENGTH; } });
+Object.defineProperty(exports, "SEARCH_SUBSTRING_MIN_LENGTH", { enumerable: true, get: function () { return search_1.SEARCH_SUBSTRING_MIN_LENGTH; } });
+var reporting_1 = require("./reporting");
+Object.defineProperty(exports, "REPORT_RUN_STATUSES", { enumerable: true, get: function () { return reporting_1.REPORT_RUN_STATUSES; } });
+Object.defineProperty(exports, "REPORT_TYPE_IDS", { enumerable: true, get: function () { return reporting_1.REPORT_TYPE_IDS; } });
+Object.defineProperty(exports, "REPORT_TYPE_LAYOUTS", { enumerable: true, get: function () { return reporting_1.REPORT_TYPE_LAYOUTS; } });
 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; } });
@@ -77,6 +87,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/reporting.js

@@ -0,0 +1,92 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.REPORT_RUN_STATUSES = exports.REPORT_TYPE_LAYOUTS = exports.REPORT_TYPE_IDS = void 0;
+/**
+ * Every report Peable produces, by Stripe's versioned id: the trailing `.1` is
+ * the column layout's version, so a layout can change under a new id without
+ * changing a report a merchant already parses.
+ */
+exports.REPORT_TYPE_IDS = [
+    'payments.itemized.1',
+    'balance.summary.1',
+    'payouts.itemized.1',
+];
+/**
+ * The layout of each report: its name, every column it can carry and the ones
+ * it carries when `parameters.columns` is absent. Fixed per version.
+ *
+ * - `payments.itemized.1` — one row per payment intent CREATED in the
+ *   interval. Amounts are base-unit strings, as on the API.
+ * - `balance.summary.1` — per currency, the balance at `interval_start`, the
+ *   activity and payouts inside the interval, and the balance at
+ *   `interval_end`, from the ledger (ADR 0015). A figure built on a transaction
+ *   whose fee the provider has not reported is empty, never `0`.
+ * - `payouts.itemized.1` — one row per payout created in the interval.
+ */
+exports.REPORT_TYPE_LAYOUTS = Object.freeze({
+    'payments.itemized.1': {
+        name: 'Itemized payments',
+        columns: [
+            'payment_intent_id',
+            'created_utc',
+            'status',
+            'rail',
+            'currency',
+            'amount',
+            'amount_received',
+            'amount_refunded',
+            'customer_id',
+            'charge_id',
+            'capture_method',
+            'description',
+            'receipt_email',
+            'cancellation_reason',
+            'canceled_at_utc',
+        ],
+        default_columns: [
+            'payment_intent_id',
+            'created_utc',
+            'status',
+            'currency',
+            'amount',
+            'amount_received',
+            'amount_refunded',
+            'customer_id',
+        ],
+        ledger: false,
+    },
+    'balance.summary.1': {
+        name: 'Balance summary',
+        columns: ['category', 'description', 'currency', 'net_amount', 'transaction_count'],
+        default_columns: ['category', 'description', 'currency', 'net_amount'],
+        ledger: true,
+    },
+    'payouts.itemized.1': {
+        name: 'Itemized payouts',
+        columns: [
+            'payout_id',
+            'created_utc',
+            'arrival_date_utc',
+            'status',
+            'currency',
+            'amount',
+            'method',
+            'type',
+            'automatic',
+            'description',
+            'statement_descriptor',
+            'failure_code',
+        ],
+        default_columns: [
+            'payout_id',
+            'created_utc',
+            'arrival_date_utc',
+            'status',
+            'currency',
+            'amount',
+            'automatic',
+        ],
+        ledger: true,
+    },
+});
+exports.REPORT_RUN_STATUSES = ['pending', 'succeeded', 'failed'];

package/dist/cjs/search.js

@@ -0,0 +1,18 @@
+"use strict";
+// The search contract (Stripe's Search API): `GET /v1/<objects>/search?query=…`.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SEARCH_SUBSTRING_MIN_LENGTH = exports.SEARCH_QUERY_MAX_CLAUSES = exports.SEARCH_QUERY_MAX_LENGTH = exports.SEARCHABLE_RESOURCES = void 0;
+/** Every searchable resource, by its path segment (`/v1/<resource>/search`). */
+exports.SEARCHABLE_RESOURCES = [
+    'payment_intents',
+    'charges',
+    'customers',
+    'products',
+    'prices',
+    'refunds',
+];
+/** Search query bounds — the gateway's, restated so a client can check before it asks. */
+exports.SEARCH_QUERY_MAX_LENGTH = 1000;
+exports.SEARCH_QUERY_MAX_CLAUSES = 10;
+/** A `~` substring needs at least this many characters (Stripe's rule). */
+exports.SEARCH_SUBSTRING_MIN_LENGTH = 3;

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/file.js

@@ -12,9 +12,22 @@ export const FILE_PURPOSES = [
     'business_logo',
     'identity_document',
     'additional_verification',
+    'finance_report_run',
+];
+/**
+ * The purposes a merchant may upload or import. `finance_report_run` is not
+ * among them: a report's CSV is written by Peable's report runs
+ * (`/v1/reporting/report_runs`) and nobody else, so a file of that purpose is
+ * always a report Peable produced.
+ */
+export const FILE_UPLOAD_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'];
+export const FILE_TYPES = ['pdf', 'png', 'jpg', 'csv'];
 /**
  * Whether the bytes can be used right now.
  *
@@ -26,16 +39,18 @@ export const FILE_TYPES = ['pdf', 'png', 'jpg'];
  */
 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 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.
+ * dispute submission it was meant for. `finance_report_run` is Peable's own
+ * output (see {@link FILE_UPLOAD_PURPOSES}); its ceiling bounds a report.
  */
 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 },
+    finance_report_run: { types: ['csv'], max_bytes: 64 * 1024 * 1024 },
 });

package/dist/esm/index.js

@@ -6,7 +6,9 @@ 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 { FILE_PURPOSES, FILE_PURPOSE_POLICIES, FILE_UPLOAD_PURPOSES, FILE_STATUSES, FILE_TYPES, } from './file.js';
+export { SEARCHABLE_RESOURCES, SEARCH_QUERY_MAX_CLAUSES, SEARCH_QUERY_MAX_LENGTH, SEARCH_SUBSTRING_MIN_LENGTH, } from './search.js';
+export { REPORT_RUN_STATUSES, REPORT_TYPE_IDS, REPORT_TYPE_LAYOUTS, } from './reporting.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';
@@ -15,6 +17,9 @@ export { REQUEST_LOG_METHODS, REQUEST_LOG_RETENTION_DAYS, } from './requestLog.j
 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/reporting.js

@@ -0,0 +1,89 @@
+/**
+ * Every report Peable produces, by Stripe's versioned id: the trailing `.1` is
+ * the column layout's version, so a layout can change under a new id without
+ * changing a report a merchant already parses.
+ */
+export const REPORT_TYPE_IDS = [
+    'payments.itemized.1',
+    'balance.summary.1',
+    'payouts.itemized.1',
+];
+/**
+ * The layout of each report: its name, every column it can carry and the ones
+ * it carries when `parameters.columns` is absent. Fixed per version.
+ *
+ * - `payments.itemized.1` — one row per payment intent CREATED in the
+ *   interval. Amounts are base-unit strings, as on the API.
+ * - `balance.summary.1` — per currency, the balance at `interval_start`, the
+ *   activity and payouts inside the interval, and the balance at
+ *   `interval_end`, from the ledger (ADR 0015). A figure built on a transaction
+ *   whose fee the provider has not reported is empty, never `0`.
+ * - `payouts.itemized.1` — one row per payout created in the interval.
+ */
+export const REPORT_TYPE_LAYOUTS = Object.freeze({
+    'payments.itemized.1': {
+        name: 'Itemized payments',
+        columns: [
+            'payment_intent_id',
+            'created_utc',
+            'status',
+            'rail',
+            'currency',
+            'amount',
+            'amount_received',
+            'amount_refunded',
+            'customer_id',
+            'charge_id',
+            'capture_method',
+            'description',
+            'receipt_email',
+            'cancellation_reason',
+            'canceled_at_utc',
+        ],
+        default_columns: [
+            'payment_intent_id',
+            'created_utc',
+            'status',
+            'currency',
+            'amount',
+            'amount_received',
+            'amount_refunded',
+            'customer_id',
+        ],
+        ledger: false,
+    },
+    'balance.summary.1': {
+        name: 'Balance summary',
+        columns: ['category', 'description', 'currency', 'net_amount', 'transaction_count'],
+        default_columns: ['category', 'description', 'currency', 'net_amount'],
+        ledger: true,
+    },
+    'payouts.itemized.1': {
+        name: 'Itemized payouts',
+        columns: [
+            'payout_id',
+            'created_utc',
+            'arrival_date_utc',
+            'status',
+            'currency',
+            'amount',
+            'method',
+            'type',
+            'automatic',
+            'description',
+            'statement_descriptor',
+            'failure_code',
+        ],
+        default_columns: [
+            'payout_id',
+            'created_utc',
+            'arrival_date_utc',
+            'status',
+            'currency',
+            'amount',
+            'automatic',
+        ],
+        ledger: true,
+    },
+});
+export const REPORT_RUN_STATUSES = ['pending', 'succeeded', 'failed'];

package/dist/esm/search.js

@@ -0,0 +1,15 @@
+// The search contract (Stripe's Search API): `GET /v1/<objects>/search?query=…`.
+/** Every searchable resource, by its path segment (`/v1/<resource>/search`). */
+export const SEARCHABLE_RESOURCES = [
+    'payment_intents',
+    'charges',
+    'customers',
+    'products',
+    'prices',
+    'refunds',
+];
+/** Search query bounds — the gateway's, restated so a client can check before it asks. */
+export const SEARCH_QUERY_MAX_LENGTH = 1000;
+export const SEARCH_QUERY_MAX_CLAUSES = 10;
+/** A `~` substring needs at least this many characters (Stripe's rule). */
+export const SEARCH_SUBSTRING_MIN_LENGTH = 3;