@happyvertical/smrt-commerce 0.30.0

package/dist/models/Vendor.d.ts

@@ -0,0 +1,153 @@
+import { SmrtObject } from '@happyvertical/smrt-core';
+import { VendorStatus } from '../types/index.js';
+/**
+ * Vendor represents the vendor/supplier role for a Profile.
+ *
+ * One Profile can have both Customer and Vendor records - e.g., a company
+ * you both buy from and sell to.
+ *
+ * @example
+ * ```typescript
+ * const vendor = await vendors.create({
+ *   profileId: 'profile-uuid',
+ *   leadTimeDays: 14,
+ *   minimumOrderAmount: 500,
+ *   paymentTerms: 'Net 60'
+ * });
+ * ```
+ */
+export declare class Vendor extends SmrtObject {
+    /**
+     * Tenant ID for multi-tenant isolation
+     * Nullable to support both tenant-scoped and global vendors
+     */
+    tenantId: string | null;
+    /**
+     * Reference to smrt-profiles Profile
+     * Plain string for cross-package reference
+     */
+    profileId: string;
+    /**
+     * Typical lead time in days for orders
+     */
+    leadTimeDays: number;
+    /**
+     * Minimum order amount required
+     */
+    minimumOrderAmount: number;
+    /**
+     * Payment terms for this vendor (e.g., "Net 60")
+     */
+    paymentTerms: string;
+    /**
+     * Default currency for transactions with this vendor
+     */
+    currency: string;
+    /**
+     * Default contact email for orders
+     */
+    defaultContactEmail: string;
+    /**
+     * Default contact phone for orders
+     */
+    defaultContactPhone: string;
+    /**
+     * Vendor status
+     */
+    status: VendorStatus;
+    /**
+     * Internal notes about this vendor
+     */
+    notes: string;
+    /**
+     * Per-currency payout destinations for this vendor.
+     *
+     * Stored as a JSON column. Keys are payout-rail-qualified currency codes —
+     * the code must encode both the asset and the rail (e.g. `USDC-base`,
+     * `USDC-solana`, `BTC`, `USD-stripe`, `USD-wire`). Values are whatever the
+     * receiving rail needs as a destination (EVM address, BTC address, Stripe
+     * Connect account id, IBAN, etc.).
+     *
+     * MVP shape: a flat map on the vendor row. A vendor with no entry for a
+     * given currency cannot be paid in that currency — filtering is the
+     * consumer's responsibility (the upstream `PaymentIntent` builder filters
+     * `paymentOptions` at quote time against this map).
+     *
+     * Use {@link getPayoutAddress} for a `Map.get`-style lookup that returns
+     * `undefined` for missing entries; direct property access is also fine.
+     *
+     * Sensitive (#1540): payout destinations are excluded from generated API/MCP
+     * responses and rejected as a `where` filter key.
+     */
+    payoutAddresses: Record<string, string>;
+    constructor(options?: any);
+    /**
+     * The framework's {@link SmrtObject.initialize} re-applies `options` keys on
+     * top of constructor-set values so option data always wins over field
+     * initializers. That means our constructor's normalization runs *before*
+     * `initializePropertiesFromOptions` overwrites `payoutAddresses` with the
+     * raw cloned value. Re-normalize once super has finished so consumers
+     * who pass a string, a partially-typed map, or `null` end up with a
+     * clean `Record<string, string>` before any save / read happens.
+     */
+    initialize(): Promise<this>;
+    /**
+     * Save with a final normalization pass so direct field assignments
+     * (`vendor.payoutAddresses = somethingFunny`) can't smuggle non-string
+     * values into the persisted row.
+     */
+    save(): Promise<this>;
+    /**
+     * Check if vendor is active
+     */
+    isActive(): boolean;
+    /**
+     * Check if order meets minimum requirements
+     */
+    meetsMinimumOrder(amount: number): boolean;
+    /**
+     * Get the profile ID for external lookup.
+     *
+     * To get the actual Profile object, use the ProfileCollection from smrt-profiles:
+     * ```typescript
+     * const profiles = await ProfileCollection.create(options);
+     * const profile = await profiles.get({ id: vendor.profileId });
+     * ```
+     *
+     * @returns The profile ID or empty string if not set
+     */
+    getProfileId(): string;
+    /**
+     * Look up the payout destination for a single currency. Returns
+     * `undefined` if the vendor has no entry for that currency — caller's
+     * job to decide whether that means "skip the option" or "raise a
+     * configuration error". The lookup is case-sensitive; the contract is
+     * that the currency code passed in matches exactly what was stored
+     * (`USDC-base`, not `usdc-base`).
+     */
+    getPayoutAddress(currency: string): string | undefined;
+    /**
+     * Set the payout destination for a single currency. Mutates the live
+     * map and returns `this` for chaining. Use {@link clearPayoutAddress}
+     * to remove a single entry.
+     */
+    setPayoutAddress(currency: string, destination: string): this;
+    /**
+     * Remove a single currency entry from the payout map. No-op if the
+     * currency was already absent.
+     */
+    clearPayoutAddress(currency: string): this;
+    /**
+     * Normalize an input value (object, pre-serialized JSON string, or
+     * `null`/`undefined`) into a plain `Record<string, string>`. Used by
+     * the constructor so consumers can pass either shape into
+     * `VendorCollection.create({ payoutAddresses: ... })`.
+     *
+     * Non-string values inside an input object are silently dropped — a
+     * `Record<string, string>` invariant is what consumers downstream
+     * (`PaymentIntent` builders, payout SDK adapters) rely on.
+     */
+    private static normalizePayoutAddresses;
+}
+export default Vendor;
+//# sourceMappingURL=Vendor.d.ts.map

package/dist/models/Vendor.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Vendor.d.ts","sourceRoot":"","sources":["../../src/models/Vendor.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAGL,UAAU,EAEX,MAAM,0BAA0B,CAAC;AAElC,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAEjD;;;;;;;;;;;;;;;GAeG;AACH,qBAMa,MAAO,SAAQ,UAAU;IACpC;;;OAGG;IAEH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAQ;IAE/B;;;OAGG;IAEH,SAAS,EAAE,MAAM,CAAM;IAEvB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAK;IAEzB;;OAEG;IACH,kBAAkB,EAAE,MAAM,CAAO;IAEjC;;OAEG;IACH,YAAY,EAAE,MAAM,CAAM;IAE1B;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAS;IAEzB;;OAEG;IACH,mBAAmB,EAAE,MAAM,CAAM;IAEjC;;OAEG;IACH,mBAAmB,EAAE,MAAM,CAAM;IAEjC;;OAEG;IACH,MAAM,EAAE,YAAY,CAAuB;IAE3C;;OAEG;IACH,KAAK,EAAE,MAAM,CAAM;IAEnB;;;;;;;;;;;;;;;;;;;OAmBG;IAEH,eAAe,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAM;gBAEjC,OAAO,GAAE,GAAQ;IAwB7B;;;;;;;;OAQG;IACY,UAAU,IAAI,OAAO,CAAC,IAAI,CAAC;IAQ1C;;;;OAIG;IACY,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IAOpC;;OAEG;IACH,QAAQ,IAAI,OAAO;IAInB;;OAEG;IACH,iBAAiB,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO;IAI1C;;;;;;;;;;OAUG;IACH,YAAY,IAAI,MAAM;IAItB;;;;;;;OAOG;IACH,gBAAgB,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS;IAOtD;;;;OAIG;IACH,gBAAgB,CAAC,QAAQ,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,GAAG,IAAI;IAQ7D;;;OAGG;IACH,kBAAkB,CAAC,QAAQ,EAAE,MAAM,GAAG,IAAI;IAU1C;;;;;;;;;OASG;IACH,OAAO,CAAC,MAAM,CAAC,wBAAwB;CAqBxC;AAED,eAAe,MAAM,CAAC"}

package/dist/models/index.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Model exports for smrt-commerce
+ * @packageDocumentation
+ */
+export { Agreement, Cart, Contract, Estimate, Lease, type LicenseRightsSnapshot, LicenseSale, Order, ProductionOrder, PurchaseOrder, WholesaleOrder, } from './Contract.js';
+export { ContractLineItem } from './ContractLineItem.js';
+export { Customer } from './Customer.js';
+export { Fulfillment } from './Fulfillment.js';
+export { FulfillmentLineItem } from './FulfillmentLineItem.js';
+export { Invoice } from './Invoice.js';
+export { InvoiceLineItem } from './InvoiceLineItem.js';
+export { Payment } from './Payment.js';
+export { PaymentAllocation } from './PaymentAllocation.js';
+export { PaymentIntent } from './PaymentIntent.js';
+export { Payout } from './Payout.js';
+export { Vendor } from './Vendor.js';
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/models/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EACL,SAAS,EACT,IAAI,EACJ,QAAQ,EACR,QAAQ,EACR,KAAK,EACL,KAAK,qBAAqB,EAC1B,WAAW,EACX,KAAK,EACL,eAAe,EACf,aAAa,EACb,cAAc,GACf,MAAM,eAAe,CAAC;AACvB,OAAO,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AACzD,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AACzC,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAC/C,OAAO,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAC;AAC/D,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AACvC,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AACvD,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AACvC,OAAO,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAC3D,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AACnD,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AACrC,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC"}

package/dist/playground.d.ts

@@ -0,0 +1,2 @@
+export { default } from './svelte/playground.js';
+//# sourceMappingURL=playground.d.ts.map

package/dist/playground.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"playground.d.ts","sourceRoot":"","sources":["../src/playground.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,wBAAwB,CAAC"}

package/dist/playground.js

@@ -0,0 +1,108 @@
+import { COMMERCE_MODULE_META } from "./ui.js";
+const noop = () => {
+};
+const sampleInvoice = {
+  id: "invoice-2026-0142",
+  invoiceNumber: "INV-2026-0142",
+  status: "sent",
+  issueDate: "2026-03-15T00:00:00.000Z",
+  dueDate: "2026-03-29T00:00:00.000Z",
+  totalAmount: 128450,
+  customerName: "Riverstone Newsroom",
+  projectName: "Editorial Systems Retainer"
+};
+const sampleUnbilledItems = [
+  {
+    id: "unbilled-time-1",
+    type: "time",
+    description: "Governance workflow setup",
+    date: "2026-03-12T00:00:00.000Z",
+    amount: 42e3,
+    category: "Implementation",
+    selected: true
+  },
+  {
+    id: "unbilled-expense-1",
+    type: "expense",
+    description: "Contributor QA workshop",
+    date: "2026-03-14T00:00:00.000Z",
+    amount: 18500,
+    category: "Training"
+  },
+  {
+    id: "unbilled-time-2",
+    type: "time",
+    description: "Release validation and docs cleanup",
+    date: "2026-03-18T00:00:00.000Z",
+    amount: 33950,
+    category: "QA"
+  }
+];
+const loadInvoiceActions = () => import("./svelte/components/InvoiceActions.svelte");
+const loadInvoiceCard = () => import("./svelte/components/InvoiceCard.svelte");
+const loadUnbilledItems = () => import("./svelte/components/UnbilledItems.svelte");
+const playground = {
+  packageName: "@happyvertical/smrt-commerce",
+  displayName: COMMERCE_MODULE_META.displayName,
+  description: COMMERCE_MODULE_META.description,
+  moduleMeta: COMMERCE_MODULE_META,
+  entries: [
+    {
+      id: "invoice-card",
+      title: "Invoice Card",
+      description: "Compact invoice summary card used in billing and receivables views.",
+      loadComponent: loadInvoiceCard,
+      order: 1,
+      props: {
+        invoice: sampleInvoice,
+        currency: "CAD",
+        onclick: noop
+      },
+      modes: {
+        mock: {
+          label: "Mock"
+        }
+      }
+    },
+    {
+      id: "invoice-actions",
+      title: "Invoice Actions",
+      description: "Status-aware billing actions for sending, printing, exporting, and payment confirmation.",
+      loadComponent: loadInvoiceActions,
+      order: 2,
+      props: {
+        status: "sent",
+        onmarkpaid: noop,
+        onprint: noop,
+        onexport: noop
+      },
+      modes: {
+        mock: {
+          label: "Mock"
+        }
+      }
+    },
+    {
+      id: "unbilled-items",
+      title: "Unbilled Items",
+      description: "Selectable unbilled work list for creating a new invoice from accumulated items.",
+      loadComponent: loadUnbilledItems,
+      order: 3,
+      props: {
+        items: sampleUnbilledItems,
+        currency: "CAD",
+        onselectionchange: noop,
+        oncreate: noop
+      },
+      modes: {
+        mock: {
+          label: "Mock"
+        }
+      }
+    }
+  ]
+};
+export {
+  playground as default
+};
+//# sourceMappingURL=playground.js.map

package/dist/playground.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"playground.js","sources":["../src/svelte/playground.ts"],"sourcesContent":["import { COMMERCE_MODULE_META } from '../ui.js';\n\nconst noop = () => {};\n\nconst sampleInvoice = {\n  id: 'invoice-2026-0142',\n  invoiceNumber: 'INV-2026-0142',\n  status: 'sent',\n  issueDate: '2026-03-15T00:00:00.000Z',\n  dueDate: '2026-03-29T00:00:00.000Z',\n  totalAmount: 128450,\n  customerName: 'Riverstone Newsroom',\n  projectName: 'Editorial Systems Retainer',\n};\n\nconst sampleUnbilledItems = [\n  {\n    id: 'unbilled-time-1',\n    type: 'time',\n    description: 'Governance workflow setup',\n    date: '2026-03-12T00:00:00.000Z',\n    amount: 42000,\n    category: 'Implementation',\n    selected: true,\n  },\n  {\n    id: 'unbilled-expense-1',\n    type: 'expense',\n    description: 'Contributor QA workshop',\n    date: '2026-03-14T00:00:00.000Z',\n    amount: 18500,\n    category: 'Training',\n  },\n  {\n    id: 'unbilled-time-2',\n    type: 'time',\n    description: 'Release validation and docs cleanup',\n    date: '2026-03-18T00:00:00.000Z',\n    amount: 33950,\n    category: 'QA',\n  },\n];\n\nconst loadInvoiceActions = () => import('./components/InvoiceActions.svelte');\nconst loadInvoiceCard = () => import('./components/InvoiceCard.svelte');\nconst loadUnbilledItems = () => import('./components/UnbilledItems.svelte');\n\nexport default {\n  packageName: '@happyvertical/smrt-commerce',\n  displayName: COMMERCE_MODULE_META.displayName,\n  description: COMMERCE_MODULE_META.description,\n  moduleMeta: COMMERCE_MODULE_META,\n  entries: [\n    {\n      id: 'invoice-card',\n      title: 'Invoice Card',\n      description:\n        'Compact invoice summary card used in billing and receivables views.',\n      loadComponent: loadInvoiceCard,\n      order: 1,\n      props: {\n        invoice: sampleInvoice,\n        currency: 'CAD',\n        onclick: noop,\n      },\n      modes: {\n        mock: {\n          label: 'Mock',\n        },\n      },\n    },\n    {\n      id: 'invoice-actions',\n      title: 'Invoice Actions',\n      description:\n        'Status-aware billing actions for sending, printing, exporting, and payment confirmation.',\n      loadComponent: loadInvoiceActions,\n      order: 2,\n      props: {\n        status: 'sent',\n        onmarkpaid: noop,\n        onprint: noop,\n        onexport: noop,\n      },\n      modes: {\n        mock: {\n          label: 'Mock',\n        },\n      },\n    },\n    {\n      id: 'unbilled-items',\n      title: 'Unbilled Items',\n      description:\n        'Selectable unbilled work list for creating a new invoice from accumulated items.',\n      loadComponent: loadUnbilledItems,\n      order: 3,\n      props: {\n        items: sampleUnbilledItems,\n        currency: 'CAD',\n        onselectionchange: noop,\n        oncreate: noop,\n      },\n      modes: {\n        mock: {\n          label: 'Mock',\n        },\n      },\n    },\n  ],\n};\n"],"names":[],"mappings":";AAEA,MAAM,OAAO,MAAM;AAAC;AAEpB,MAAM,gBAAgB;AAAA,EACpB,IAAI;AAAA,EACJ,eAAe;AAAA,EACf,QAAQ;AAAA,EACR,WAAW;AAAA,EACX,SAAS;AAAA,EACT,aAAa;AAAA,EACb,cAAc;AAAA,EACd,aAAa;AACf;AAEA,MAAM,sBAAsB;AAAA,EAC1B;AAAA,IACE,IAAI;AAAA,IACJ,MAAM;AAAA,IACN,aAAa;AAAA,IACb,MAAM;AAAA,IACN,QAAQ;AAAA,IACR,UAAU;AAAA,IACV,UAAU;AAAA,EAAA;AAAA,EAEZ;AAAA,IACE,IAAI;AAAA,IACJ,MAAM;AAAA,IACN,aAAa;AAAA,IACb,MAAM;AAAA,IACN,QAAQ;AAAA,IACR,UAAU;AAAA,EAAA;AAAA,EAEZ;AAAA,IACE,IAAI;AAAA,IACJ,MAAM;AAAA,IACN,aAAa;AAAA,IACb,MAAM;AAAA,IACN,QAAQ;AAAA,IACR,UAAU;AAAA,EAAA;AAEd;AAEA,MAAM,qBAAqB,MAAM,OAAO,2CAAoC;AAC5E,MAAM,kBAAkB,MAAM,OAAO,wCAAiC;AACtE,MAAM,oBAAoB,MAAM,OAAO,0CAAmC;AAE1E,MAAA,aAAe;AAAA,EACb,aAAa;AAAA,EACb,aAAa,qBAAqB;AAAA,EAClC,aAAa,qBAAqB;AAAA,EAClC,YAAY;AAAA,EACZ,SAAS;AAAA,IACP;AAAA,MACE,IAAI;AAAA,MACJ,OAAO;AAAA,MACP,aACE;AAAA,MACF,eAAe;AAAA,MACf,OAAO;AAAA,MACP,OAAO;AAAA,QACL,SAAS;AAAA,QACT,UAAU;AAAA,QACV,SAAS;AAAA,MAAA;AAAA,MAEX,OAAO;AAAA,QACL,MAAM;AAAA,UACJ,OAAO;AAAA,QAAA;AAAA,MACT;AAAA,IACF;AAAA,IAEF;AAAA,MACE,IAAI;AAAA,MACJ,OAAO;AAAA,MACP,aACE;AAAA,MACF,eAAe;AAAA,MACf,OAAO;AAAA,MACP,OAAO;AAAA,QACL,QAAQ;AAAA,QACR,YAAY;AAAA,QACZ,SAAS;AAAA,QACT,UAAU;AAAA,MAAA;AAAA,MAEZ,OAAO;AAAA,QACL,MAAM;AAAA,UACJ,OAAO;AAAA,QAAA;AAAA,MACT;AAAA,IACF;AAAA,IAEF;AAAA,MACE,IAAI;AAAA,MACJ,OAAO;AAAA,MACP,aACE;AAAA,MACF,eAAe;AAAA,MACf,OAAO;AAAA,MACP,OAAO;AAAA,QACL,OAAO;AAAA,QACP,UAAU;AAAA,QACV,mBAAmB;AAAA,QACnB,UAAU;AAAA,MAAA;AAAA,MAEZ,OAAO;AAAA,QACL,MAAM;AAAA,UACJ,OAAO;AAAA,QAAA;AAAA,MACT;AAAA,IACF;AAAA,EACF;AAEJ;"}