@happyvertical/smrt-commerce 0.55.6 → 0.55.7

package/dist/manifest.json

@@ -2,7 +2,7 @@
   "version": "1.0.0",
   "timestamp": 0,
   "packageName": "@happyvertical/smrt-commerce",
-  "packageVersion": "0.55.6",
+  "packageVersion": "0.55.7",
   "objects": {
     "@happyvertical/smrt-commerce:ContractCollection": {
       "name": "contractcollection",
@@ -3870,6 +3870,7 @@
       "className": "Contract",
       "qualifiedName": "@happyvertical/smrt-commerce:Contract",
       "collection": "contracts",
+      "description": "Contract is the base class for all commercial agreements.",
       "filePath": "/home/runner/work/smrt/smrt/packages/commerce/src/models/Contract.ts",
       "packageName": "@happyvertical/smrt-commerce",
       "fields": {
@@ -4313,6 +4314,7 @@
       "className": "Estimate",
       "qualifiedName": "@happyvertical/smrt-commerce:Estimate",
       "collection": "contracts",
+      "description": "Quote or proposal for a customer",
       "filePath": "/home/runner/work/smrt/smrt/packages/commerce/src/models/Contract.ts",
       "packageName": "@happyvertical/smrt-commerce",
       "fields": {
@@ -4734,6 +4736,7 @@
       "className": "Order",
       "qualifiedName": "@happyvertical/smrt-commerce:Order",
       "collection": "contracts",
+      "description": "Customer purchase order",
       "filePath": "/home/runner/work/smrt/smrt/packages/commerce/src/models/Contract.ts",
       "packageName": "@happyvertical/smrt-commerce",
       "fields": {
@@ -5155,6 +5158,7 @@
       "className": "Lease",
       "qualifiedName": "@happyvertical/smrt-commerce:Lease",
       "collection": "contracts",
+      "description": "Rental or lease agreement",
       "filePath": "/home/runner/work/smrt/smrt/packages/commerce/src/models/Contract.ts",
       "packageName": "@happyvertical/smrt-commerce",
       "fields": {
@@ -5576,6 +5580,7 @@
       "className": "Agreement",
       "qualifiedName": "@happyvertical/smrt-commerce:Agreement",
       "collection": "contracts",
+      "description": "Service or maintenance agreement",
       "filePath": "/home/runner/work/smrt/smrt/packages/commerce/src/models/Contract.ts",
       "packageName": "@happyvertical/smrt-commerce",
       "fields": {
@@ -5997,6 +6002,7 @@
       "className": "PurchaseOrder",
       "qualifiedName": "@happyvertical/smrt-commerce:PurchaseOrder",
       "collection": "contracts",
+      "description": "Order sent to vendor/supplier",
       "filePath": "/home/runner/work/smrt/smrt/packages/commerce/src/models/Contract.ts",
       "packageName": "@happyvertical/smrt-commerce",
       "fields": {
@@ -6418,6 +6424,7 @@
       "className": "WholesaleOrder",
       "qualifiedName": "@happyvertical/smrt-commerce:WholesaleOrder",
       "collection": "contracts",
+      "description": "B2B order placed by a wholesale customer.",
       "filePath": "/home/runner/work/smrt/smrt/packages/commerce/src/models/Contract.ts",
       "packageName": "@happyvertical/smrt-commerce",
       "fields": {
@@ -6839,6 +6846,7 @@
       "className": "ProductionOrder",
       "qualifiedName": "@happyvertical/smrt-commerce:ProductionOrder",
       "collection": "contracts",
+      "description": "Instruction to commission goods from an internal or external factory.",
       "filePath": "/home/runner/work/smrt/smrt/packages/commerce/src/models/Contract.ts",
       "packageName": "@happyvertical/smrt-commerce",
       "fields": {
@@ -7276,6 +7284,7 @@
       "className": "Cart",
       "qualifiedName": "@happyvertical/smrt-commerce:Cart",
       "collection": "contracts",
+      "description": "Transient order-in-progress for a shopper.",
       "filePath": "/home/runner/work/smrt/smrt/packages/commerce/src/models/Contract.ts",
       "packageName": "@happyvertical/smrt-commerce",
       "fields": {
@@ -7697,6 +7706,7 @@
       "className": "LicenseSale",
       "qualifiedName": "@happyvertical/smrt-commerce:LicenseSale",
       "collection": "contracts",
+      "description": "Industry-neutral licensing primitive.",
       "filePath": "/home/runner/work/smrt/smrt/packages/commerce/src/models/Contract.ts",
       "packageName": "@happyvertical/smrt-commerce",
       "fields": {
@@ -8254,6 +8264,7 @@
       "className": "ContractLineItem",
       "qualifiedName": "@happyvertical/smrt-commerce:ContractLineItem",
       "collection": "contractlineitems",
+      "description": "ContractLineItem represents a single line item on a contract.",
       "filePath": "/home/runner/work/smrt/smrt/packages/commerce/src/models/ContractLineItem.ts",
       "packageName": "@happyvertical/smrt-commerce",
       "fields": {
@@ -8565,6 +8576,7 @@
       "className": "Customer",
       "qualifiedName": "@happyvertical/smrt-commerce:Customer",
       "collection": "customers",
+      "description": "Customer represents the customer role for a Profile.",
       "filePath": "/home/runner/work/smrt/smrt/packages/commerce/src/models/Customer.ts",
       "packageName": "@happyvertical/smrt-commerce",
       "fields": {
@@ -8880,6 +8892,7 @@
       "className": "Fulfillment",
       "qualifiedName": "@happyvertical/smrt-commerce:Fulfillment",
       "collection": "fulfillments",
+      "description": "Fulfillment tracks the delivery or completion of contract items.",
       "filePath": "/home/runner/work/smrt/smrt/packages/commerce/src/models/Fulfillment.ts",
       "packageName": "@happyvertical/smrt-commerce",
       "fields": {
@@ -9197,6 +9210,7 @@
       "className": "FulfillmentLineItem",
       "qualifiedName": "@happyvertical/smrt-commerce:FulfillmentLineItem",
       "collection": "fulfillmentlineitems",
+      "description": "FulfillmentLineItem tracks which contract line items are included in a specific fulfillment and how much was fulfilled.",
       "filePath": "/home/runner/work/smrt/smrt/packages/commerce/src/models/FulfillmentLineItem.ts",
       "packageName": "@happyvertical/smrt-commerce",
       "fields": {
@@ -9390,6 +9404,7 @@
       "className": "Invoice",
       "qualifiedName": "@happyvertical/smrt-commerce:Invoice",
       "collection": "invoices",
+      "description": "Invoice represents a bill sent to a customer for goods or services.",
       "filePath": "/home/runner/work/smrt/smrt/packages/commerce/src/models/Invoice.ts",
       "packageName": "@happyvertical/smrt-commerce",
       "fields": {
@@ -10006,6 +10021,7 @@
       "className": "InvoiceLineItem",
       "qualifiedName": "@happyvertical/smrt-commerce:InvoiceLineItem",
       "collection": "invoicelineitems",
+      "description": "InvoiceLineItem represents a single line item on an invoice.",
       "filePath": "/home/runner/work/smrt/smrt/packages/commerce/src/models/InvoiceLineItem.ts",
       "packageName": "@happyvertical/smrt-commerce",
       "fields": {
@@ -10399,6 +10415,7 @@
       "className": "Payment",
       "qualifiedName": "@happyvertical/smrt-commerce:Payment",
       "collection": "payments",
+      "description": "Payment represents a financial transaction against a contract.",
       "filePath": "/home/runner/work/smrt/smrt/packages/commerce/src/models/Payment.ts",
       "packageName": "@happyvertical/smrt-commerce",
       "fields": {
@@ -10884,6 +10901,7 @@
       "className": "PaymentAllocation",
       "qualifiedName": "@happyvertical/smrt-commerce:PaymentAllocation",
       "collection": "paymentallocations",
+      "description": "PaymentAllocation tracks how payments are applied to invoices.",
       "filePath": "/home/runner/work/smrt/smrt/packages/commerce/src/models/PaymentAllocation.ts",
       "packageName": "@happyvertical/smrt-commerce",
       "fields": {
@@ -11099,6 +11117,7 @@
       "className": "PaymentInstrument",
       "qualifiedName": "@happyvertical/smrt-commerce:PaymentInstrument",
       "collection": "paymentinstruments",
+      "description": "PaymentInstrument stores a reusable payment method a customer has saved with a payment backend (e.g. a card vaulted by Stripe), so it can be charged later without the customer present.",
       "filePath": "/home/runner/work/smrt/smrt/packages/commerce/src/models/PaymentInstrument.ts",
       "packageName": "@happyvertical/smrt-commerce",
       "fields": {
@@ -12302,6 +12321,7 @@
       "className": "Vendor",
       "qualifiedName": "@happyvertical/smrt-commerce:Vendor",
       "collection": "vendors",
+      "description": "Vendor represents the vendor/supplier role for a Profile.",
       "filePath": "/home/runner/work/smrt/smrt/packages/commerce/src/models/Vendor.ts",
       "packageName": "@happyvertical/smrt-commerce",
       "fields": {
@@ -12673,6 +12693,7 @@
       "className": "BillingAccount",
       "qualifiedName": "@happyvertical/smrt-commerce:BillingAccount",
       "collection": "billingaccounts",
+      "description": "One payer's account with one seller: the commerce Customer invoices are issued to, the provider customer they are pushed to, and the payer's billing terms.",
       "filePath": "/home/runner/work/smrt/smrt/packages/commerce/src/models/billing.ts",
       "packageName": "@happyvertical/smrt-commerce",
       "fields": {
@@ -12939,6 +12960,7 @@
       "className": "BillingPeriodClose",
       "qualifiedName": "@happyvertical/smrt-commerce:BillingPeriodClose",
       "collection": "billingperiodcloses",
+      "description": "The idempotency anchor for one payer's invoice in one currency for one period. Its id is derived from that identity, so a retried close always resumes the same row, invoice, and provider invoice.",
       "filePath": "/home/runner/work/smrt/smrt/packages/commerce/src/models/billing.ts",
       "packageName": "@happyvertical/smrt-commerce",
       "fields": {
@@ -13310,6 +13332,7 @@
       "className": "BillingLineSource",
       "qualifiedName": "@happyvertical/smrt-commerce:BillingLineSource",
       "collection": "billinglinesources",
+      "description": "A claim that one billable source — a charge, an adjustment, or a window of a flat plan — is billed on exactly one period close.",
       "filePath": "/home/runner/work/smrt/smrt/packages/commerce/src/models/billing.ts",
       "packageName": "@happyvertical/smrt-commerce",
       "fields": {
@@ -13581,6 +13604,7 @@
       "className": "BillingPaymentAttempt",
       "qualifiedName": "@happyvertical/smrt-commerce:BillingPaymentAttempt",
       "collection": "billingpaymentattempts",
+      "description": "One payment attempt on a payment rail (#3138): a short-lived provider checkout (for example a BTCPay invoice) paying a credit purchase or an issued invoice.",
       "filePath": "/home/runner/work/smrt/smrt/packages/commerce/src/models/billing.ts",
       "packageName": "@happyvertical/smrt-commerce",
       "fields": {

package/dist/smrt-knowledge.json

@@ -3,12 +3,12 @@
   "sensitiveFieldsExcluded": true,
   "generatedAt": "1970-01-01T00:00:00.000Z",
   "packageName": "@happyvertical/smrt-commerce",
-  "packageVersion": "0.55.6",
+  "packageVersion": "0.55.7",
   "sourceManifestPath": "dist/manifest.json",
   "agentDocPath": "AGENTS.md",
   "sourceHashes": {
-    "manifest": "6a3f3014cbbd2d4232d33882bf71b192c257e85b5362cdeee6921d6d62c739b1",
-    "packageJson": "89fed087b96cd53d07ca10e3a6f24e2d01daee344d6b79ff25f529bd7d930678",
+    "manifest": "4df0d8742511a1d86fb3ba87a46ae8021fc87b10796985af4ed6af1103fd0247",
+    "packageJson": "6cda8f067b483bcf6e2760f207f92e039f7a35340d29f677abd12e4b1e4cf7ec",
     "agents": "67b16f7ce35487a5fecaca37b52edbdb66c166b2d99672ce56f08ea3f4a6f3f3",
     "moduleDoc:agents/invoice-quantity.md": "bc3b617d4fb8cc87511763b281283107557ba64795e64522193ef967a3715d32",
     "moduleDoc:agents/commercial-ui.md": "308729a481c82903d06837e7052c04509a92cf17d17345f71dce88d8d42d0431",
@@ -4001,6 +4001,7 @@
       "name": "Contract",
       "qualifiedName": "@happyvertical/smrt-commerce:Contract",
       "collection": "contracts",
+      "description": "Contract is the base class for all commercial agreements.",
       "tableName": "contracts",
       "packageName": "@happyvertical/smrt-commerce",
       "extends": "SmrtObject",
@@ -4394,6 +4395,7 @@
       "name": "Estimate",
       "qualifiedName": "@happyvertical/smrt-commerce:Estimate",
       "collection": "contracts",
+      "description": "Quote or proposal for a customer",
       "tableName": "contracts",
       "packageName": "@happyvertical/smrt-commerce",
       "extends": "Contract",
@@ -4849,6 +4851,7 @@
       "name": "Order",
       "qualifiedName": "@happyvertical/smrt-commerce:Order",
       "collection": "contracts",
+      "description": "Customer purchase order",
       "tableName": "contracts",
       "packageName": "@happyvertical/smrt-commerce",
       "extends": "Contract",
@@ -5304,6 +5307,7 @@
       "name": "Lease",
       "qualifiedName": "@happyvertical/smrt-commerce:Lease",
       "collection": "contracts",
+      "description": "Rental or lease agreement",
       "tableName": "contracts",
       "packageName": "@happyvertical/smrt-commerce",
       "extends": "Contract",
@@ -5759,6 +5763,7 @@
       "name": "Agreement",
       "qualifiedName": "@happyvertical/smrt-commerce:Agreement",
       "collection": "contracts",
+      "description": "Service or maintenance agreement",
       "tableName": "contracts",
       "packageName": "@happyvertical/smrt-commerce",
       "extends": "Contract",
@@ -6214,6 +6219,7 @@
       "name": "PurchaseOrder",
       "qualifiedName": "@happyvertical/smrt-commerce:PurchaseOrder",
       "collection": "contracts",
+      "description": "Order sent to vendor/supplier",
       "tableName": "contracts",
       "packageName": "@happyvertical/smrt-commerce",
       "extends": "Contract",
@@ -6669,6 +6675,7 @@
       "name": "WholesaleOrder",
       "qualifiedName": "@happyvertical/smrt-commerce:WholesaleOrder",
       "collection": "contracts",
+      "description": "B2B order placed by a wholesale customer.",
       "tableName": "contracts",
       "packageName": "@happyvertical/smrt-commerce",
       "extends": "Contract",
@@ -7124,6 +7131,7 @@
       "name": "ProductionOrder",
       "qualifiedName": "@happyvertical/smrt-commerce:ProductionOrder",
       "collection": "contracts",
+      "description": "Instruction to commission goods from an internal or external factory.",
       "tableName": "contracts",
       "packageName": "@happyvertical/smrt-commerce",
       "extends": "Contract",
@@ -7591,6 +7599,7 @@
       "name": "Cart",
       "qualifiedName": "@happyvertical/smrt-commerce:Cart",
       "collection": "contracts",
+      "description": "Transient order-in-progress for a shopper.",
       "tableName": "contracts",
       "packageName": "@happyvertical/smrt-commerce",
       "extends": "Contract",
@@ -8046,6 +8055,7 @@
       "name": "LicenseSale",
       "qualifiedName": "@happyvertical/smrt-commerce:LicenseSale",
       "collection": "contracts",
+      "description": "Industry-neutral licensing primitive.",
       "tableName": "contracts",
       "packageName": "@happyvertical/smrt-commerce",
       "extends": "Contract",
@@ -8641,6 +8651,7 @@
       "name": "ContractLineItem",
       "qualifiedName": "@happyvertical/smrt-commerce:ContractLineItem",
       "collection": "contractlineitems",
+      "description": "ContractLineItem represents a single line item on a contract.",
       "tableName": "contract_line_items",
       "packageName": "@happyvertical/smrt-commerce",
       "extends": "SmrtObject",
@@ -8937,6 +8948,7 @@
       "name": "Customer",
       "qualifiedName": "@happyvertical/smrt-commerce:Customer",
       "collection": "customers",
+      "description": "Customer represents the customer role for a Profile.",
       "tableName": "customers",
       "packageName": "@happyvertical/smrt-commerce",
       "extends": "SmrtObject",
@@ -9203,6 +9215,7 @@
       "name": "Fulfillment",
       "qualifiedName": "@happyvertical/smrt-commerce:Fulfillment",
       "collection": "fulfillments",
+      "description": "Fulfillment tracks the delivery or completion of contract items.",
       "tableName": "fulfillments",
       "packageName": "@happyvertical/smrt-commerce",
       "extends": "SmrtObject",
@@ -9528,6 +9541,7 @@
       "name": "FulfillmentLineItem",
       "qualifiedName": "@happyvertical/smrt-commerce:FulfillmentLineItem",
       "collection": "fulfillmentlineitems",
+      "description": "FulfillmentLineItem tracks which contract line items are included in a specific fulfillment and how much was fulfilled.",
       "tableName": "fulfillment_line_items",
       "packageName": "@happyvertical/smrt-commerce",
       "extends": "SmrtObject",
@@ -9707,6 +9721,7 @@
       "name": "Invoice",
       "qualifiedName": "@happyvertical/smrt-commerce:Invoice",
       "collection": "invoices",
+      "description": "Invoice represents a bill sent to a customer for goods or services.",
       "tableName": "invoices",
       "packageName": "@happyvertical/smrt-commerce",
       "extends": "SmrtObject",
@@ -10327,6 +10342,7 @@
       "name": "InvoiceLineItem",
       "qualifiedName": "@happyvertical/smrt-commerce:InvoiceLineItem",
       "collection": "invoicelineitems",
+      "description": "InvoiceLineItem represents a single line item on an invoice.",
       "tableName": "invoice_line_items",
       "packageName": "@happyvertical/smrt-commerce",
       "extends": "SmrtObject",
@@ -10736,6 +10752,7 @@
       "name": "Payment",
       "qualifiedName": "@happyvertical/smrt-commerce:Payment",
       "collection": "payments",
+      "description": "Payment represents a financial transaction against a contract.",
       "tableName": "payments",
       "packageName": "@happyvertical/smrt-commerce",
       "extends": "SmrtObject",
@@ -11188,6 +11205,7 @@
       "name": "PaymentAllocation",
       "qualifiedName": "@happyvertical/smrt-commerce:PaymentAllocation",
       "collection": "paymentallocations",
+      "description": "PaymentAllocation tracks how payments are applied to invoices.",
       "tableName": "payment_allocations",
       "packageName": "@happyvertical/smrt-commerce",
       "extends": "SmrtObject",
@@ -11338,6 +11356,7 @@
       "name": "PaymentInstrument",
       "qualifiedName": "@happyvertical/smrt-commerce:PaymentInstrument",
       "collection": "paymentinstruments",
+      "description": "PaymentInstrument stores a reusable payment method a customer has saved with a payment backend (e.g. a card vaulted by Stripe), so it can be charged later without the customer present.",
       "tableName": "payment_instruments",
       "packageName": "@happyvertical/smrt-commerce",
       "extends": "SmrtObject",
@@ -12516,6 +12535,7 @@
       "name": "Vendor",
       "qualifiedName": "@happyvertical/smrt-commerce:Vendor",
       "collection": "vendors",
+      "description": "Vendor represents the vendor/supplier role for a Profile.",
       "tableName": "vendors",
       "packageName": "@happyvertical/smrt-commerce",
       "extends": "SmrtObject",
@@ -12858,6 +12878,7 @@
       "qualifiedName": "@happyvertical/smrt-commerce:BillingAccount",
       "displayLabelField": "name",
       "collection": "billingaccounts",
+      "description": "One payer's account with one seller: the commerce Customer invoices are issued to, the provider customer they are pushed to, and the payer's billing terms.",
       "tableName": "_smrt_billing_accounts",
       "packageName": "@happyvertical/smrt-commerce",
       "extends": "SmrtObject",
@@ -12994,6 +13015,7 @@
       "name": "BillingPeriodClose",
       "qualifiedName": "@happyvertical/smrt-commerce:BillingPeriodClose",
       "collection": "billingperiodcloses",
+      "description": "The idempotency anchor for one payer's invoice in one currency for one period. Its id is derived from that identity, so a retried close always resumes the same row, invoice, and provider invoice.",
       "tableName": "_smrt_billing_period_closes",
       "packageName": "@happyvertical/smrt-commerce",
       "extends": "SmrtObject",
@@ -13204,6 +13226,7 @@
       "name": "BillingLineSource",
       "qualifiedName": "@happyvertical/smrt-commerce:BillingLineSource",
       "collection": "billinglinesources",
+      "description": "A claim that one billable source — a charge, an adjustment, or a window of a flat plan — is billed on exactly one period close.",
       "tableName": "_smrt_billing_line_sources",
       "packageName": "@happyvertical/smrt-commerce",
       "extends": "SmrtObject",
@@ -13332,6 +13355,7 @@
       "name": "BillingPaymentAttempt",
       "qualifiedName": "@happyvertical/smrt-commerce:BillingPaymentAttempt",
       "collection": "billingpaymentattempts",
+      "description": "One payment attempt on a payment rail (#3138): a short-lived provider checkout (for example a BTCPay invoice) paying a credit purchase or an issued invoice.",
       "tableName": "_smrt_billing_payment_attempts",
       "packageName": "@happyvertical/smrt-commerce",
       "extends": "SmrtObject",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@happyvertical/smrt-commerce",
-  "version": "0.55.6",
+  "version": "0.55.7",
   "smrtJsdoc": "strict",
   "description": "Commerce models for the SMRT framework - contracts, fulfillments, payments",
   "type": "module",
@@ -55,15 +55,15 @@
     "access": "public"
   },
   "dependencies": {
-    "@happyvertical/accounting": "^0.102.4",
-    "@happyvertical/payments": "^0.102.4",
-    "@happyvertical/smrt-core": "0.55.6",
-    "@happyvertical/smrt-jobs": "0.55.6",
-    "@happyvertical/smrt-ledgers": "0.55.6",
-    "@happyvertical/smrt-subscriptions": "0.55.6",
-    "@happyvertical/smrt-tenancy": "0.55.6",
-    "@happyvertical/smrt-types": "0.55.6",
-    "@happyvertical/smrt-ui": "0.55.6"
+    "@happyvertical/accounting": "^0.102.5",
+    "@happyvertical/payments": "^0.102.5",
+    "@happyvertical/smrt-core": "0.55.7",
+    "@happyvertical/smrt-jobs": "0.55.7",
+    "@happyvertical/smrt-ledgers": "0.55.7",
+    "@happyvertical/smrt-subscriptions": "0.55.7",
+    "@happyvertical/smrt-tenancy": "0.55.7",
+    "@happyvertical/smrt-types": "0.55.7",
+    "@happyvertical/smrt-ui": "0.55.7"
   },
   "peerDependencies": {
     "svelte": "^5.57.0"
@@ -74,7 +74,7 @@
     }
   },
   "devDependencies": {
-    "@happyvertical/smrt-vitest": "0.55.6",
+    "@happyvertical/smrt-vitest": "0.55.7",
     "@sveltejs/package": "^2.5.8",
     "@sveltejs/vite-plugin-svelte": "^7.3.0",
     "@types/node": "24.13.6",