@happyvertical/smrt-commerce 0.37.11 → 0.38.1

package/AGENTS.md

@@ -14,6 +14,7 @@ E-commerce with Contract STI hierarchy, invoice lifecycle, payment tracking, pay
 - **Invoice**: status machine `DRAFT → SENT → VIEWED → PARTIAL → PAID` (also OVERDUE, CANCELLED, WRITTEN_OFF). `recognizeRevenue()` creates balanced AR journal entry (DR: Accounts Receivable, CR: Revenue, CR: Tax Payable).
 - **InvoiceLineItem**: line items on invoices.
 - **Payment** / **PaymentAllocation**: tracks payments against invoices. Status controlled by `Invoice.updatePaymentStatus()`, not Payment model. Carries optional backend-adapter fields for PaymentBackend-routed flows: `backendId` (rail adapter id — `base-usdc`, `btc`, `stripe`, distinct from `externalProvider` which names an accounting sync destination), `backendTxRef` (chain tx hash or gateway settlement id), `nativeAmount` / `nativeCurrency` (what actually arrived), `usdAtQuote` / `usdAtConfirmation` (drift accounting for volatile-currency rails). `Payment.usdDrift()` returns the confirmation - quote delta, or `0` when either side is unset.
+- **PaymentInstrument**: reusable saved payment method ("card on file"). Stores only provider references and non-sensitive display metadata (`providerCustomerId`, `providerPaymentMethodId`, brand / last4 / expiry), never raw card data. Use `PaymentInstrumentCollection.setDefaultForCustomer()` to change the default so the single-default-per-customer invariant is enforced; generated create/update routes cannot write `isDefault` directly.
 - **PaymentIntent**: short-lived pre-payment commitment with multi-option semantics. Locks a USD price for a fixed window (default 15 minutes) and lists one or more `PaymentOption`s describing different rails (`backendId`, `currency`, `payTo`, `nativeAmount`, optional `chain` / `memo` / `x402Capable` / `expiresAt`). First option to receive payment wins; the others are implicitly retired. State machine `awaiting_payment → paid → (issued | retired)` plus `expired` and `cancelled`. Mutate via dedicated `markPaid` / `markIssued` / `expire` / `cancel` / `retire` helpers — direct status assignment bypasses the invariant checks. Idempotency via natural key `(tenant_id, offering_ref, licensee_email, idempotency_key)` and `PaymentIntentCollection.getOrCreateByIdempotencyKey()`.
 - **Payout**: operator-to-supplier remittance. Distinct from Payment because direction, status machine, and chain semantics differ. Status machine `pending → sent → confirmed → failed` (failed is terminal but resettable via `resetFromFailed()` after fixing the underlying problem). References source `paymentId` (plain string) and destination `vendorId` (foreign key). Amount invariant `supplierNet === grossAmount - operatorFee` (1¢ rounding tolerance) enforced on save. `PayoutCollection.createFromPayment()` is the typical entry point; it pulls native amount / currency from the source Payment.
 - **Fulfillment** / **FulfillmentLineItem**: shipment/delivery tracking.
@@ -40,5 +41,6 @@ E-commerce with Contract STI hierarchy, invoice lifecycle, payment tracking, pay
 - **Profile linking**: separate `ProfileCollection.create()` needed to fetch actual Profile object
 - **PaymentIntent natural key**: `conflictColumns: ['tenant_id', 'offering_ref', 'licensee_email', 'idempotency_key']` — a retried `create` with the same tuple upserts the existing row. Use `getOrCreateByIdempotencyKey()` to branch on `{ intent, created }`. Empty natural-key inputs (e.g. blank `idempotencyKey`) disable dedup by design.
 - **Payout state-machine guards**: `markSent` requires a non-empty `backendTxRef`; `markConfirmed` only valid from `SENT`; `markFailed` only valid from `PENDING` / `SENT` (a confirmed payout can't fail — that path is a refund). `resetFromFailed()` is the dedicated escape hatch from `FAILED` back to `PENDING` after an operator fixes the underlying problem; it clears `backendTxRef` so the next attempt picks up a fresh one.
+- **PaymentInstrument defaults**: `isDefault` is domain-managed, not API-writable. Call `setDefaultForCustomer(customerId, instrumentId)` so the target is validated and the customer's other instruments are cleared.
 - **LicenseSale immutability**: rights snapshot freezes on save-with-status-ACCEPTED. The captured snapshot lives in a module-scoped `WeakMap<LicenseSale, string>` so it doesn't interact with the schema or round-trip through `_meta_data`. Drafts (status != ACCEPTED) remain mutable. To "change" an issued license: `revoke()` it, then issue a new `LicenseSale` row.
 - **Vendor.payoutAddresses normalization**: the constructor accepts either a `Record<string, string>` or a pre-serialized JSON string. `initialize()` re-normalizes after the framework's option-override pass; `save()` re-normalizes defensively against direct field assignment. Non-string values inside the input map are silently dropped to preserve the typed invariant downstream.

package/dist/chunks/{types-B0DwBRVz.js → types-CRnln577.js}

@@ -71,6 +71,12 @@ var PaymentStatus = /* @__PURE__ */ ((PaymentStatus2) => {
 	PaymentStatus2["CANCELLED"] = "cancelled";
 	return PaymentStatus2;
 })(PaymentStatus || {});
+var PaymentInstrumentStatus = /* @__PURE__ */ ((PaymentInstrumentStatus2) => {
+	PaymentInstrumentStatus2["ACTIVE"] = "active";
+	PaymentInstrumentStatus2["EXPIRED"] = "expired";
+	PaymentInstrumentStatus2["REMOVED"] = "removed";
+	return PaymentInstrumentStatus2;
+})(PaymentInstrumentStatus || {});
 var PayoutStatus = /* @__PURE__ */ ((PayoutStatus2) => {
 	PayoutStatus2["PENDING"] = "pending";
 	PayoutStatus2["SENT"] = "sent";
@@ -99,6 +105,6 @@ var InvoiceStatus = /* @__PURE__ */ ((InvoiceStatus2) => {
 	return InvoiceStatus2;
 })(InvoiceStatus || {});
 //#endregion
-export { FulfillmentStatus as a, PaymentIntentStatus as c, PayoutStatus as d, VendorStatus as f, CustomerType as i, PaymentMethod as l, ContractType as n, FulfillmentType as o, CustomerStatus as r, InvoiceStatus as s, ContractStatus as t, PaymentStatus as u };
+export { FulfillmentStatus as a, PaymentInstrumentStatus as c, PaymentStatus as d, PayoutStatus as f, CustomerType as i, PaymentIntentStatus as l, ContractType as n, FulfillmentType as o, VendorStatus as p, CustomerStatus as r, InvoiceStatus as s, ContractStatus as t, PaymentMethod as u };
 
-//# sourceMappingURL=types-B0DwBRVz.js.map
+//# sourceMappingURL=types-CRnln577.js.map

package/dist/chunks/types-CRnln577.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types-CRnln577.js","names":["CustomerStatus","CustomerType","VendorStatus","ContractType","ContractStatus","FulfillmentType","FulfillmentStatus","PaymentMethod","PaymentStatus","PaymentInstrumentStatus","PayoutStatus","PaymentIntentStatus","InvoiceStatus"],"sources":["../../src/types/index.ts"],"sourcesContent":["/**\n * Commerce package type definitions\n * @packageDocumentation\n */\n\nimport type { SmrtObjectOptions } from '@happyvertical/smrt-core';\n\n// ============================================================================\n// Customer/Vendor Types\n// ============================================================================\n\nexport enum CustomerStatus {\n  ACTIVE = 'active',\n  INACTIVE = 'inactive',\n  SUSPENDED = 'suspended',\n}\n\n/**\n * Customer classification — drives channel access, pricing tier, and credit terms.\n *\n * - DTC: direct-to-consumer (end shopper). Pays via storefront checkout.\n * - WHOLESALE: B2B buyer with negotiated terms (NET-30, line sheets, etc.).\n * - RETAIL: in-store walk-in / point-of-sale customer.\n */\nexport enum CustomerType {\n  DTC = 'dtc',\n  WHOLESALE = 'wholesale',\n  RETAIL = 'retail',\n}\n\nexport enum VendorStatus {\n  ACTIVE = 'active',\n  INACTIVE = 'inactive',\n  SUSPENDED = 'suspended',\n}\n\n// ============================================================================\n// Contract Types\n// ============================================================================\n\nexport enum ContractType {\n  ESTIMATE = 'estimate',\n  ORDER = 'order',\n  LEASE = 'lease',\n  AGREEMENT = 'agreement',\n  PURCHASE_ORDER = 'purchase_order',\n  WHOLESALE_ORDER = 'wholesale_order',\n  PRODUCTION_ORDER = 'production_order',\n  CART = 'cart',\n  /**\n   * Industry-neutral licensing primitive. The `LicenseSale` STI subtype\n   * carries an immutable rights snapshot, a licensee email, optional\n   * legal-entity / jurisdiction fields, and a signed-PDF reference.\n   * Any application that sells rights for a fee (stock media,\n   * music licensing, code-asset marketplace, license keys, etc.)\n   * uses this subtype.\n   */\n  LICENSE_SALE = 'license_sale',\n}\n\nexport enum ContractStatus {\n  DRAFT = 'draft',\n  SENT = 'sent',\n  ACCEPTED = 'accepted',\n  DECLINED = 'declined',\n  COMPLETED = 'completed',\n  CANCELLED = 'cancelled',\n}\n\n// ============================================================================\n// Fulfillment Types\n// ============================================================================\n\nexport enum FulfillmentType {\n  SHIPMENT = 'shipment',\n  DELIVERY = 'delivery',\n  PICKUP = 'pickup',\n  DIGITAL = 'digital',\n  SERVICE = 'service',\n}\n\nexport enum FulfillmentStatus {\n  PENDING = 'pending',\n  PROCESSING = 'processing',\n  SHIPPED = 'shipped',\n  DELIVERED = 'delivered',\n  CANCELLED = 'cancelled',\n}\n\n// ============================================================================\n// Payment Types\n// ============================================================================\n\nexport enum PaymentMethod {\n  CASH = 'cash',\n  CHECK = 'check',\n  CREDIT_CARD = 'credit_card',\n  BANK_TRANSFER = 'bank_transfer',\n  CRYPTO = 'crypto',\n  OTHER = 'other',\n}\n\nexport enum PaymentStatus {\n  PENDING = 'pending',\n  COMPLETED = 'completed',\n  FAILED = 'failed',\n  REFUNDED = 'refunded',\n  CANCELLED = 'cancelled',\n}\n\n/**\n * Lifecycle status for a saved {@link PaymentInstrument} (card on file).\n * `active` while chargeable, `expired` once the card lapses, `removed` when the\n * customer detaches it.\n */\nexport enum PaymentInstrumentStatus {\n  ACTIVE = 'active',\n  EXPIRED = 'expired',\n  REMOVED = 'removed',\n}\n\n// ============================================================================\n// Payout Types\n// ============================================================================\n\n/**\n * Status machine for {@link Payout}.\n *\n * `pending → sent → confirmed → failed`. `failed` is terminal but the\n * model exposes a dedicated `resetFromFailed()` so an operator can\n * deliberately requeue a payout after fixing the underlying problem;\n * the reset moves the row back to `pending` and clears the failure\n * metadata.\n *\n * Skipping intermediate states is rejected — a `pending` payout cannot\n * jump straight to `confirmed`, and a `sent` payout cannot regress to\n * `pending` without going through `resetFromFailed()` first.\n */\nexport enum PayoutStatus {\n  PENDING = 'pending',\n  SENT = 'sent',\n  CONFIRMED = 'confirmed',\n  FAILED = 'failed',\n}\n\n// ============================================================================\n// PaymentIntent Types\n// ============================================================================\n\n/**\n * Status machine for {@link PaymentIntent}.\n *\n * `awaiting_payment → paid → (issued | retired)`, with `expired` and\n * `cancelled` as alternate terminal states reachable from\n * `awaiting_payment`.\n *\n * - `AWAITING_PAYMENT` — open quote, accepting any of the listed\n *   payment options.\n * - `PAID` — one option was satisfied by an incoming payment. The\n *   other options are implicitly retired; later inbound funds to a\n *   retired option must be flagged for refund by the consumer.\n * - `ISSUED` — downstream rights / contract / fulfillment have been\n *   created and linked. Terminal happy-path state.\n * - `RETIRED` — paid but the satisfaction was reversed (refund,\n *   chargeback, etc.). Terminal.\n * - `EXPIRED` — the USD-price-lock window passed without payment.\n *   Terminal.\n * - `CANCELLED` — the buyer or the system explicitly cancelled the\n *   intent before it was paid. Terminal.\n */\nexport enum PaymentIntentStatus {\n  AWAITING_PAYMENT = 'awaiting_payment',\n  PAID = 'paid',\n  ISSUED = 'issued',\n  RETIRED = 'retired',\n  EXPIRED = 'expired',\n  CANCELLED = 'cancelled',\n}\n\n/**\n * One way for a {@link PaymentIntent} to be satisfied. The intent lists\n * an array of these; satisfying any one of them transitions the intent\n * to `PAID` and implicitly retires the rest.\n *\n * Industry-neutral: a marketplace that accepts USDC-on-Base and BTC\n * lists two options; a SaaS billing flow that accepts Stripe and\n * PayPal lists two; a kiosk that accepts only one rail lists one.\n */\nexport interface PaymentOption {\n  /**\n   * Stable id of the `PaymentBackend` adapter that fulfills this\n   * option — must match a `backendId` the consumer's payment-routing\n   * layer recognises. Examples: `base-usdc`, `solana-usdc`, `btc`,\n   * `stripe`, `paypal`.\n   */\n  backendId: string;\n  /**\n   * Payout-rail-qualified currency code, e.g. `USDC-base`, `BTC`,\n   * `USD-stripe`. The same convention used by\n   * `Vendor.payoutAddresses` and `Payment.nativeCurrency`.\n   */\n  currency: string;\n  /**\n   * Optional chain identifier for blockchain-backed options (`base`,\n   * `ethereum`, `solana`, ...). Pure-fiat options leave this empty.\n   */\n  chain?: string;\n  /**\n   * Destination address / account id the buyer should send funds to\n   * for this option (EVM address, BTC address, Stripe payment-intent\n   * id, etc.).\n   */\n  payTo: string;\n  /**\n   * Amount denominated in `currency`. Stored at decimal precision —\n   * a USDC option might be `199.0`, a BTC option `0.00713`.\n   */\n  nativeAmount: number;\n  /**\n   * Optional on-chain memo / payment reference (Solana memo, BTC OP_RETURN\n   * tag, Stripe metadata key). Some backends use this to disambiguate\n   * which intent an inbound payment satisfies.\n   */\n  memo?: string;\n  /**\n   * Whether this option supports the x402 HTTP-402 payment-required\n   * flow. Consumers that build agent-driven flows use this flag to\n   * filter the offered options.\n   */\n  x402Capable?: boolean;\n  /**\n   * Optional per-option expiry — when a single rail's quote becomes\n   * stale earlier than the intent-wide price-lock window (e.g. a\n   * volatile-currency option that re-quotes more aggressively). ISO\n   * 8601 string. Empty / missing means \"inherit the intent's\n   * `priceLockExpiresAt`\".\n   */\n  expiresAt?: string;\n}\n\n// ============================================================================\n// Invoice Types\n// ============================================================================\n\nexport enum InvoiceStatus {\n  DRAFT = 'draft',\n  SENT = 'sent',\n  VIEWED = 'viewed',\n  PARTIAL = 'partial',\n  PAID = 'paid',\n  OVERDUE = 'overdue',\n  CANCELLED = 'cancelled',\n  WRITTEN_OFF = 'written_off',\n}\n\n// ============================================================================\n// Common Interfaces\n// ============================================================================\n\n/**\n * Address structure used for billing and shipping\n */\nexport interface Address {\n  street1?: string;\n  street2?: string;\n  city?: string;\n  state?: string;\n  postalCode?: string;\n  country?: string;\n}\n\n/**\n * Options for recording a payment with ledger integration\n */\nexport interface RecordPaymentOptions {\n  /** The ledger to record the journal entry in */\n  ledgerId: string;\n  /** Account ID for receivables (credit side) */\n  receivablesAccountId: string;\n  /** Account ID for cash/bank (debit side) */\n  cashAccountId: string;\n}\n\n/**\n * Options for recognizing revenue on an invoice\n */\nexport interface RecognizeRevenueOptions {\n  /** Account ID for accounts receivable (debit side) */\n  arAccountId: string;\n  /** Account ID for revenue (credit side) */\n  revenueAccountId: string;\n  /** Account ID for tax payable (credit side, optional) */\n  taxAccountId?: string;\n}\n\n// ============================================================================\n// Accounting-provider sync shapes\n// ============================================================================\n\n/**\n * A single line item in the format expected by `@happyvertical/accounting`\n * providers (QBO, Stripe, …). Mirrors the object built by\n * {@link InvoiceLineItem.toAccountingLineItem}. The SDK isn't a dependency of\n * this package, so the shape is declared locally rather than imported.\n */\nexport interface AccountingLineItemInput {\n  description: string;\n  sku?: string;\n  quantity: number;\n  unitPrice: number;\n  discount?: number;\n  taxRate?: number;\n  amount: number;\n  periodStart?: Date;\n  periodEnd?: Date;\n}\n\n/**\n * An invoice in the format expected by `@happyvertical/accounting` providers.\n * Mirrors the object built by {@link Invoice.toAccountingInput}.\n */\nexport interface AccountingInvoiceInput {\n  id: string;\n  externalId?: string;\n  invoiceNumber: string;\n  customerId: string;\n  customerExternalId?: string;\n  issueDate: Date;\n  dueDate: Date;\n  lineItems: AccountingLineItemInput[];\n  subtotal: number;\n  taxAmount: number;\n  totalAmount: number;\n  currency: string;\n  reference?: string;\n  memo?: string;\n}\n\n// ============================================================================\n// Model constructor option interfaces\n//\n// Each model's `constructor(options)` accepts a partial bag of its own fields.\n// Declaring a dedicated `XxxOptions extends SmrtObjectOptions` interface keeps\n// the constructors strongly typed (no `any`) while still allowing the\n// framework's base options (db, ai, fs, _className, …) through.\n// ============================================================================\n\n/**\n * Constructor options for {@link Customer}.\n */\nexport interface CustomerOptions extends SmrtObjectOptions {\n  tenantId?: string | null;\n  profileId?: string;\n  creditLimit?: number;\n  paymentTerms?: string;\n  taxExempt?: boolean;\n  taxId?: string;\n  defaultShippingAddress?: Address;\n  defaultBillingAddress?: Address;\n  status?: CustomerStatus;\n  customerType?: CustomerType | null;\n  notes?: string;\n}\n\n/**\n * Constructor options for {@link Vendor}.\n */\nexport interface VendorOptions extends SmrtObjectOptions {\n  tenantId?: string | null;\n  profileId?: string;\n  leadTimeDays?: number;\n  minimumOrderAmount?: number;\n  paymentTerms?: string;\n  currency?: string;\n  defaultContactEmail?: string;\n  defaultContactPhone?: string;\n  status?: VendorStatus;\n  notes?: string;\n  payoutAddresses?: Record<string, string> | string | null;\n}\n\n/**\n * Constructor options for {@link Contract} and its STI subtypes.\n */\nexport interface ContractOptions extends SmrtObjectOptions {\n  tenantId?: string | null;\n  contractType?: ContractType;\n  status?: ContractStatus;\n  customerId?: string;\n  vendorId?: string;\n  subtotal?: number;\n  taxAmount?: number;\n  totalAmount?: number;\n  currency?: string;\n  issueDate?: Date;\n  dueDate?: Date | null;\n  expiryDate?: Date | null;\n  reference?: string;\n  notes?: string;\n  terms?: string;\n  channelId?: string;\n}\n\n/**\n * Constructor options for {@link LicenseSale} (Contract STI subtype). Extends\n * {@link ContractOptions} with the licensing-specific meta fields.\n */\nexport interface LicenseSaleOptions extends ContractOptions {\n  skuId?: string;\n  paymentId?: string;\n  licenseeEmail?: string;\n  licenseeLegalEntity?: string;\n  licenseeJurisdiction?: string;\n  rightsMedium?: string;\n  rightsDistributionScope?: string;\n  rightsExclusivity?: string;\n  rightsDuration?: string;\n  rightsTerritory?: string;\n  rightsSublicensing?: boolean;\n  rightsDerivatives?: boolean;\n  pdfUrl?: string;\n  pdfHash?: string;\n  onChainHashRegistryRef?: string;\n}\n\n/**\n * Constructor options for {@link ContractLineItem}.\n */\nexport interface ContractLineItemOptions extends SmrtObjectOptions {\n  tenantId?: string | null;\n  contractId?: string;\n  description?: string;\n  quantity?: number;\n  unitPrice?: number;\n  discount?: number;\n  taxRate?: number;\n  amount?: number;\n  productId?: string;\n  sku?: string;\n  startDate?: Date | null;\n  endDate?: Date | null;\n  billingPeriod?: string;\n  sortOrder?: number;\n}\n\n/**\n * Constructor options for {@link Invoice}.\n */\nexport interface InvoiceOptions extends SmrtObjectOptions {\n  tenantId?: string | null;\n  customerId?: string;\n  contractId?: string;\n  invoiceNumber?: string;\n  reference?: string;\n  issueDate?: Date;\n  dueDate?: Date;\n  paidDate?: Date | null;\n  subtotal?: number;\n  taxAmount?: number;\n  totalAmount?: number;\n  amountPaid?: number;\n  currency?: string;\n  status?: InvoiceStatus;\n  arJournalId?: string;\n  revenueJournalId?: string;\n  externalId?: string;\n  customerExternalId?: string;\n  externalProvider?: string;\n  syncedAt?: Date | null;\n  sentAt?: Date | null;\n  viewedAt?: Date | null;\n  remindersSent?: number;\n  lastReminderAt?: Date | null;\n  notes?: string;\n  customerNotes?: string;\n  terms?: string;\n}\n\n/**\n * Constructor options for {@link InvoiceLineItem}.\n */\nexport interface InvoiceLineItemOptions extends SmrtObjectOptions {\n  tenantId?: string | null;\n  invoiceId?: string;\n  description?: string;\n  sku?: string;\n  quantity?: number;\n  unitPrice?: number;\n  discount?: number;\n  taxRate?: number;\n  amount?: number;\n  sourceType?: string;\n  sourceId?: string;\n  periodStart?: Date | null;\n  periodEnd?: Date | null;\n  revenueAccountId?: string;\n  sortOrder?: number;\n}\n\n/**\n * Constructor options for {@link Fulfillment}.\n */\nexport interface FulfillmentOptions extends SmrtObjectOptions {\n  tenantId?: string | null;\n  contractId?: string;\n  fulfillmentType?: FulfillmentType;\n  status?: FulfillmentStatus;\n  trackingNumber?: string;\n  carrier?: string;\n  shippingAddress?: Address;\n  shippedAt?: Date | null;\n  deliveredAt?: Date | null;\n  estimatedDelivery?: Date | null;\n  notes?: string;\n}\n\n/**\n * Constructor options for {@link FulfillmentLineItem}.\n */\nexport interface FulfillmentLineItemOptions extends SmrtObjectOptions {\n  tenantId?: string | null;\n  fulfillmentId?: string;\n  contractLineItemId?: string;\n  quantityFulfilled?: number;\n  notes?: string;\n}\n\n/**\n * Constructor options for {@link Payment}.\n */\nexport interface PaymentOptions extends SmrtObjectOptions {\n  tenantId?: string | null;\n  contractId?: string;\n  customerId?: string;\n  amount?: number;\n  currency?: string;\n  method?: PaymentMethod;\n  status?: PaymentStatus;\n  transactionId?: string;\n  reference?: string;\n  journalId?: string;\n  paidAt?: Date | null;\n  notes?: string;\n  externalId?: string;\n  externalProvider?: string;\n  syncedAt?: Date | null;\n  backendId?: string;\n  backendTxRef?: string;\n  nativeAmount?: number;\n  nativeCurrency?: string;\n  usdAtQuote?: number;\n  usdAtConfirmation?: number;\n}\n\n/**\n * Constructor options for {@link PaymentInstrument}.\n */\nexport interface PaymentInstrumentOptions extends SmrtObjectOptions {\n  tenantId?: string | null;\n  customerId?: string;\n  backendId?: string;\n  providerCustomerId?: string;\n  providerPaymentMethodId?: string;\n  type?: string;\n  brand?: string;\n  last4?: string;\n  expMonth?: number;\n  expYear?: number;\n  isDefault?: boolean;\n  status?: PaymentInstrumentStatus;\n}\n\n/**\n * Constructor options for {@link PaymentAllocation}.\n */\nexport interface PaymentAllocationOptions extends SmrtObjectOptions {\n  tenantId?: string | null;\n  paymentId?: string;\n  invoiceId?: string;\n  amount?: number;\n  allocatedAt?: Date;\n  allocatedBy?: string;\n  notes?: string;\n}\n\n/**\n * Constructor options for {@link PaymentIntent}.\n */\nexport interface PaymentIntentOptions extends SmrtObjectOptions {\n  tenantId?: string | null;\n  skuId?: string;\n  offeringRef?: string;\n  licenseeEmail?: string;\n  customerId?: string;\n  paymentOptions?: PaymentOption[] | string;\n  usdPriceLocked?: number;\n  priceLockWindowMs?: number;\n  priceLockExpiresAt?: Date | number | string | null;\n  status?: PaymentIntentStatus;\n  idempotencyKey?: string;\n  paidOptionBackendId?: string;\n  paymentId?: string;\n  paidAt?: Date | number | string | null;\n  issuedAt?: Date | number | string | null;\n  expiredAt?: Date | number | string | null;\n  cancelledAt?: Date | number | string | null;\n  retiredAt?: Date | number | string | null;\n  notes?: string;\n}\n\n/**\n * Constructor options for {@link Payout}.\n */\nexport interface PayoutOptions extends SmrtObjectOptions {\n  tenantId?: string | null;\n  paymentId?: string;\n  vendorId?: string;\n  grossAmount?: number;\n  operatorFee?: number;\n  supplierNet?: number;\n  currency?: string;\n  backendId?: string;\n  backendTxRef?: string;\n  status?: PayoutStatus;\n  sentAt?: Date | number | string | null;\n  confirmedAt?: Date | number | string | null;\n  failedAt?: Date | number | string | null;\n  failureReason?: string;\n  notes?: string;\n}\n"],"mappings":";AAWO,IAAK,iBAAL,kBAAKA,oBAAL;CACLA,gBAAA,YAAS;CACTA,gBAAA,cAAW;CACXA,gBAAA,eAAY;CAHF,OAAAA;AAAA,EAAA,CAAA,kBAAA,CAAA,CAAA;AAaL,IAAK,eAAL,kBAAKC,kBAAL;CACLA,cAAA,SAAM;CACNA,cAAA,eAAY;CACZA,cAAA,YAAS;CAHC,OAAAA;AAAA,EAAA,CAAA,gBAAA,CAAA,CAAA;AAML,IAAK,eAAL,kBAAKC,kBAAL;CACLA,cAAA,YAAS;CACTA,cAAA,cAAW;CACXA,cAAA,eAAY;CAHF,OAAAA;AAAA,EAAA,CAAA,gBAAA,CAAA,CAAA;AAUL,IAAK,eAAL,kBAAKC,kBAAL;CACLA,cAAA,cAAW;CACXA,cAAA,WAAQ;CACRA,cAAA,WAAQ;CACRA,cAAA,eAAY;CACZA,cAAA,oBAAiB;CACjBA,cAAA,qBAAkB;CAClBA,cAAA,sBAAmB;CACnBA,cAAA,UAAO;CASPA,cAAA,kBAAe;CAjBL,OAAAA;AAAA,EAAA,CAAA,gBAAA,CAAA,CAAA;AAoBL,IAAK,iBAAL,kBAAKC,oBAAL;CACLA,gBAAA,WAAQ;CACRA,gBAAA,UAAO;CACPA,gBAAA,cAAW;CACXA,gBAAA,cAAW;CACXA,gBAAA,eAAY;CACZA,gBAAA,eAAY;CANF,OAAAA;AAAA,EAAA,CAAA,kBAAA,CAAA,CAAA;AAaL,IAAK,kBAAL,kBAAKC,qBAAL;CACLA,iBAAA,cAAW;CACXA,iBAAA,cAAW;CACXA,iBAAA,YAAS;CACTA,iBAAA,aAAU;CACVA,iBAAA,aAAU;CALA,OAAAA;AAAA,EAAA,CAAA,mBAAA,CAAA,CAAA;AAQL,IAAK,oBAAL,kBAAKC,uBAAL;CACLA,mBAAA,aAAU;CACVA,mBAAA,gBAAa;CACbA,mBAAA,aAAU;CACVA,mBAAA,eAAY;CACZA,mBAAA,eAAY;CALF,OAAAA;AAAA,EAAA,CAAA,qBAAA,CAAA,CAAA;AAYL,IAAK,gBAAL,kBAAKC,mBAAL;CACLA,eAAA,UAAO;CACPA,eAAA,WAAQ;CACRA,eAAA,iBAAc;CACdA,eAAA,mBAAgB;CAChBA,eAAA,YAAS;CACTA,eAAA,WAAQ;CANE,OAAAA;AAAA,EAAA,CAAA,iBAAA,CAAA,CAAA;AASL,IAAK,gBAAL,kBAAKC,mBAAL;CACLA,eAAA,aAAU;CACVA,eAAA,eAAY;CACZA,eAAA,YAAS;CACTA,eAAA,cAAW;CACXA,eAAA,eAAY;CALF,OAAAA;AAAA,EAAA,CAAA,iBAAA,CAAA,CAAA;AAaL,IAAK,0BAAL,kBAAKC,6BAAL;CACLA,yBAAA,YAAS;CACTA,yBAAA,aAAU;CACVA,yBAAA,aAAU;CAHA,OAAAA;AAAA,EAAA,CAAA,2BAAA,CAAA,CAAA;AAuBL,IAAK,eAAL,kBAAKC,kBAAL;CACLA,cAAA,aAAU;CACVA,cAAA,UAAO;CACPA,cAAA,eAAY;CACZA,cAAA,YAAS;CAJC,OAAAA;AAAA,EAAA,CAAA,gBAAA,CAAA,CAAA;AAgCL,IAAK,sBAAL,kBAAKC,yBAAL;CACLA,qBAAA,sBAAmB;CACnBA,qBAAA,UAAO;CACPA,qBAAA,YAAS;CACTA,qBAAA,aAAU;CACVA,qBAAA,aAAU;CACVA,qBAAA,eAAY;CANF,OAAAA;AAAA,EAAA,CAAA,uBAAA,CAAA,CAAA;AA0EL,IAAK,gBAAL,kBAAKC,mBAAL;CACLA,eAAA,WAAQ;CACRA,eAAA,UAAO;CACPA,eAAA,YAAS;CACTA,eAAA,aAAU;CACVA,eAAA,UAAO;CACPA,eAAA,aAAU;CACVA,eAAA,eAAY;CACZA,eAAA,iBAAc;CARJ,OAAAA;AAAA,EAAA,CAAA,iBAAA,CAAA,CAAA"}

package/dist/collections/PaymentInstrumentCollection.d.ts

@@ -0,0 +1,67 @@
+import { SmrtCollection } from '@happyvertical/smrt-core';
+import { PaymentInstrument } from '../models/PaymentInstrument.js';
+export declare class PaymentInstrumentCollection extends SmrtCollection<PaymentInstrument> {
+    static readonly _itemClass: typeof PaymentInstrument;
+    /**
+     * Find all instruments saved by a customer, newest first.
+     *
+     * @param customerId - Customer ID
+     * @returns Array of instruments
+     */
+    findByCustomer(customerId: string): Promise<PaymentInstrument[]>;
+    /**
+     * Find a customer's active instruments, newest first.
+     *
+     * @param customerId - Customer ID
+     * @returns Array of active instruments
+     */
+    findActiveByCustomer(customerId: string): Promise<PaymentInstrument[]>;
+    /**
+     * Find a customer's default instrument, or null if none is set.
+     *
+     * @param customerId - Customer ID
+     * @returns The default instrument or null
+     */
+    findDefaultForCustomer(customerId: string): Promise<PaymentInstrument | null>;
+    /**
+     * Find an instrument by its provider payment-method reference (e.g. a Stripe
+     * `pm_...`).
+     *
+     * @param providerPaymentMethodId - Provider payment-method id
+     * @returns The instrument or null
+     */
+    findByProviderPaymentMethodId(providerPaymentMethodId: string): Promise<PaymentInstrument | null>;
+    /**
+     * Make one of a customer's instruments the default, clearing the flag on the
+     * others so only a single default is ever set. Only rows whose flag actually
+     * changes are re-saved.
+     *
+     * @param customerId - Customer ID
+     * @param instrumentId - The instrument to make default
+     */
+    setDefaultForCustomer(customerId: string, instrumentId: string): Promise<void>;
+    /**
+     * Find all instruments belonging to a specific tenant.
+     *
+     * @param tenantId - Tenant ID
+     * @returns Array of instruments for the tenant
+     */
+    findByTenant(tenantId: string): Promise<PaymentInstrument[]>;
+    /**
+     * Find all global instruments (not associated with any tenant). Routes
+     * through the shared tenant-global helper so it does not throw under an
+     * active tenant context. (#1600)
+     *
+     * @returns Array of global instruments
+     */
+    findGlobal(): Promise<PaymentInstrument[]>;
+    /**
+     * Find instruments for a tenant including global instruments. Fails closed if
+     * an active tenant context requests a different tenant's rows. (#1600)
+     *
+     * @param tenantId - Tenant ID
+     * @returns Array of tenant-specific and global instruments
+     */
+    findWithGlobals(tenantId: string): Promise<PaymentInstrument[]>;
+}
+//# sourceMappingURL=PaymentInstrumentCollection.d.ts.map

package/dist/collections/PaymentInstrumentCollection.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"PaymentInstrumentCollection.d.ts","sourceRoot":"","sources":["../../src/collections/PaymentInstrumentCollection.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,cAAc,EAAE,MAAM,0BAA0B,CAAC;AAE1D,OAAO,EAAE,iBAAiB,EAAE,MAAM,gCAAgC,CAAC;AAGnE,qBAAa,2BAA4B,SAAQ,cAAc,CAAC,iBAAiB,CAAC;IAChF,MAAM,CAAC,QAAQ,CAAC,UAAU,2BAAqB;IAE/C;;;;;OAKG;IACG,cAAc,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,iBAAiB,EAAE,CAAC;IAOtE;;;;;OAKG;IACG,oBAAoB,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,iBAAiB,EAAE,CAAC;IAO5E;;;;;OAKG;IACG,sBAAsB,CAC1B,UAAU,EAAE,MAAM,GACjB,OAAO,CAAC,iBAAiB,GAAG,IAAI,CAAC;IAUpC;;;;;;OAMG;IACG,6BAA6B,CACjC,uBAAuB,EAAE,MAAM,GAC9B,OAAO,CAAC,iBAAiB,GAAG,IAAI,CAAC;IAQpC;;;;;;;OAOG;IACG,qBAAqB,CACzB,UAAU,EAAE,MAAM,EAClB,YAAY,EAAE,MAAM,GACnB,OAAO,CAAC,IAAI,CAAC;IA8BhB;;;;;OAKG;IACG,YAAY,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,iBAAiB,EAAE,CAAC;IAIlE;;;;;;OAMG;IACG,UAAU,IAAI,OAAO,CAAC,iBAAiB,EAAE,CAAC;IAIhD;;;;;;OAMG;IACG,eAAe,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,iBAAiB,EAAE,CAAC;CAOtE"}

package/dist/collections/index.d.ts

@@ -11,6 +11,7 @@ export { InvoiceCollection, type InvoiceNumberOptions, UNPAID_STATUSES, } from '
 export { InvoiceLineItemCollection } from './InvoiceLineItemCollection.js';
 export { PaymentAllocationCollection } from './PaymentAllocationCollection.js';
 export { PaymentCollection } from './PaymentCollection.js';
+export { PaymentInstrumentCollection } from './PaymentInstrumentCollection.js';
 export { PaymentIntentCollection, type PaymentIntentIdempotencyArgs, type PaymentIntentSeed, } from './PaymentIntentCollection.js';
 export { type CreatePayoutFromPaymentArgs, PayoutCollection, } from './PayoutCollection.js';
 export { VendorCollection } from './VendorCollection.js';

package/dist/collections/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/collections/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,kBAAkB,EAAE,MAAM,yBAAyB,CAAC;AAC7D,OAAO,EAAE,0BAA0B,EAAE,MAAM,iCAAiC,CAAC;AAC7E,OAAO,EAAE,kBAAkB,EAAE,MAAM,yBAAyB,CAAC;AAC7D,OAAO,EAAE,qBAAqB,EAAE,MAAM,4BAA4B,CAAC;AACnE,OAAO,EAAE,6BAA6B,EAAE,MAAM,oCAAoC,CAAC;AACnF,OAAO,EACL,iBAAiB,EACjB,KAAK,oBAAoB,EACzB,eAAe,GAChB,MAAM,wBAAwB,CAAC;AAChC,OAAO,EAAE,yBAAyB,EAAE,MAAM,gCAAgC,CAAC;AAC3E,OAAO,EAAE,2BAA2B,EAAE,MAAM,kCAAkC,CAAC;AAC/E,OAAO,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAC3D,OAAO,EACL,uBAAuB,EACvB,KAAK,4BAA4B,EACjC,KAAK,iBAAiB,GACvB,MAAM,8BAA8B,CAAC;AACtC,OAAO,EACL,KAAK,2BAA2B,EAChC,gBAAgB,GACjB,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/collections/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,kBAAkB,EAAE,MAAM,yBAAyB,CAAC;AAC7D,OAAO,EAAE,0BAA0B,EAAE,MAAM,iCAAiC,CAAC;AAC7E,OAAO,EAAE,kBAAkB,EAAE,MAAM,yBAAyB,CAAC;AAC7D,OAAO,EAAE,qBAAqB,EAAE,MAAM,4BAA4B,CAAC;AACnE,OAAO,EAAE,6BAA6B,EAAE,MAAM,oCAAoC,CAAC;AACnF,OAAO,EACL,iBAAiB,EACjB,KAAK,oBAAoB,EACzB,eAAe,GAChB,MAAM,wBAAwB,CAAC;AAChC,OAAO,EAAE,yBAAyB,EAAE,MAAM,gCAAgC,CAAC;AAC3E,OAAO,EAAE,2BAA2B,EAAE,MAAM,kCAAkC,CAAC;AAC/E,OAAO,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAC3D,OAAO,EAAE,2BAA2B,EAAE,MAAM,kCAAkC,CAAC;AAC/E,OAAO,EACL,uBAAuB,EACvB,KAAK,4BAA4B,EACjC,KAAK,iBAAiB,GACvB,MAAM,8BAA8B,CAAC;AACtC,OAAO,EACL,KAAK,2BAA2B,EAChC,gBAAgB,GACjB,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC"}

package/dist/index.d.ts

@@ -1,5 +1,5 @@
-export { ContractCollection, ContractLineItemCollection, type CreatePayoutFromPaymentArgs, CustomerCollection, FulfillmentCollection, FulfillmentLineItemCollection, InvoiceCollection, InvoiceLineItemCollection, type InvoiceNumberOptions, PaymentAllocationCollection, PaymentCollection, PaymentIntentCollection, type PaymentIntentIdempotencyArgs, type PaymentIntentSeed, PayoutCollection, UNPAID_STATUSES, VendorCollection, } from './collections/index.js';
-export { Agreement, Cart, Contract, ContractLineItem, Customer, Estimate, Fulfillment, FulfillmentLineItem, Invoice, InvoiceLineItem, Lease, type LicenseRightsSnapshot, LicenseSale, Order, Payment, PaymentAllocation, PaymentIntent, Payout, ProductionOrder, PurchaseOrder, Vendor, WholesaleOrder, } from './models/index.js';
-export { type Address, ContractStatus, ContractType, CustomerStatus, CustomerType, FulfillmentStatus, FulfillmentType, InvoiceStatus, PaymentIntentStatus, PaymentMethod, type PaymentOption, PaymentStatus, PayoutStatus, type RecognizeRevenueOptions, type RecordPaymentOptions, VendorStatus, } from './types/index.js';
+export { ContractCollection, ContractLineItemCollection, type CreatePayoutFromPaymentArgs, CustomerCollection, FulfillmentCollection, FulfillmentLineItemCollection, InvoiceCollection, InvoiceLineItemCollection, type InvoiceNumberOptions, PaymentAllocationCollection, PaymentCollection, PaymentInstrumentCollection, PaymentIntentCollection, type PaymentIntentIdempotencyArgs, type PaymentIntentSeed, PayoutCollection, UNPAID_STATUSES, VendorCollection, } from './collections/index.js';
+export { Agreement, Cart, Contract, ContractLineItem, Customer, Estimate, Fulfillment, FulfillmentLineItem, Invoice, InvoiceLineItem, Lease, type LicenseRightsSnapshot, LicenseSale, Order, Payment, PaymentAllocation, PaymentInstrument, PaymentIntent, Payout, ProductionOrder, PurchaseOrder, Vendor, WholesaleOrder, } from './models/index.js';
+export { type Address, ContractStatus, ContractType, CustomerStatus, CustomerType, FulfillmentStatus, FulfillmentType, InvoiceStatus, PaymentInstrumentStatus, PaymentIntentStatus, PaymentMethod, type PaymentOption, PaymentStatus, PayoutStatus, type RecognizeRevenueOptions, type RecordPaymentOptions, VendorStatus, } from './types/index.js';
 export { COMMERCE_MODULE_META, COMMERCE_UI_SLOTS } from './ui.js';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4DG;AAKH,OAAO,wBAAwB,CAAC;AAGhC,OAAO,EACL,kBAAkB,EAClB,0BAA0B,EAC1B,KAAK,2BAA2B,EAChC,kBAAkB,EAClB,qBAAqB,EACrB,6BAA6B,EAC7B,iBAAiB,EACjB,yBAAyB,EACzB,KAAK,oBAAoB,EACzB,2BAA2B,EAC3B,iBAAiB,EACjB,uBAAuB,EACvB,KAAK,4BAA4B,EACjC,KAAK,iBAAiB,EACtB,gBAAgB,EAChB,eAAe,EACf,gBAAgB,GACjB,MAAM,wBAAwB,CAAC;AAEhC,OAAO,EACL,SAAS,EACT,IAAI,EACJ,QAAQ,EACR,gBAAgB,EAChB,QAAQ,EACR,QAAQ,EACR,WAAW,EACX,mBAAmB,EACnB,OAAO,EACP,eAAe,EACf,KAAK,EACL,KAAK,qBAAqB,EAC1B,WAAW,EACX,KAAK,EACL,OAAO,EACP,iBAAiB,EACjB,aAAa,EACb,MAAM,EACN,eAAe,EACf,aAAa,EACb,MAAM,EACN,cAAc,GACf,MAAM,mBAAmB,CAAC;AAG3B,OAAO,EACL,KAAK,OAAO,EACZ,cAAc,EACd,YAAY,EACZ,cAAc,EACd,YAAY,EACZ,iBAAiB,EACjB,eAAe,EACf,aAAa,EACb,mBAAmB,EACnB,aAAa,EACb,KAAK,aAAa,EAClB,aAAa,EACb,YAAY,EACZ,KAAK,uBAAuB,EAC5B,KAAK,oBAAoB,EACzB,YAAY,GACb,MAAM,kBAAkB,CAAC;AAG1B,OAAO,EAAE,oBAAoB,EAAE,iBAAiB,EAAE,MAAM,SAAS,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4DG;AAKH,OAAO,wBAAwB,CAAC;AAGhC,OAAO,EACL,kBAAkB,EAClB,0BAA0B,EAC1B,KAAK,2BAA2B,EAChC,kBAAkB,EAClB,qBAAqB,EACrB,6BAA6B,EAC7B,iBAAiB,EACjB,yBAAyB,EACzB,KAAK,oBAAoB,EACzB,2BAA2B,EAC3B,iBAAiB,EACjB,2BAA2B,EAC3B,uBAAuB,EACvB,KAAK,4BAA4B,EACjC,KAAK,iBAAiB,EACtB,gBAAgB,EAChB,eAAe,EACf,gBAAgB,GACjB,MAAM,wBAAwB,CAAC;AAEhC,OAAO,EACL,SAAS,EACT,IAAI,EACJ,QAAQ,EACR,gBAAgB,EAChB,QAAQ,EACR,QAAQ,EACR,WAAW,EACX,mBAAmB,EACnB,OAAO,EACP,eAAe,EACf,KAAK,EACL,KAAK,qBAAqB,EAC1B,WAAW,EACX,KAAK,EACL,OAAO,EACP,iBAAiB,EACjB,iBAAiB,EACjB,aAAa,EACb,MAAM,EACN,eAAe,EACf,aAAa,EACb,MAAM,EACN,cAAc,GACf,MAAM,mBAAmB,CAAC;AAG3B,OAAO,EACL,KAAK,OAAO,EACZ,cAAc,EACd,YAAY,EACZ,cAAc,EACd,YAAY,EACZ,iBAAiB,EACjB,eAAe,EACf,aAAa,EACb,uBAAuB,EACvB,mBAAmB,EACnB,aAAa,EACb,KAAK,aAAa,EAClB,aAAa,EACb,YAAY,EACZ,KAAK,uBAAuB,EAC5B,KAAK,oBAAoB,EACzB,YAAY,GACb,MAAM,kBAAkB,CAAC;AAG1B,OAAO,EAAE,oBAAoB,EAAE,iBAAiB,EAAE,MAAM,SAAS,CAAC"}