@happyvertical/smrt-commerce 0.51.31 → 0.51.33

package/dist/collections/VendorCollection.d.ts

@@ -1,3 +1,7 @@
+/**
+ * VendorCollection - Collection manager for Vendor objects
+ * @packageDocumentation
+ */
 import { SmrtCollection } from '@happyvertical/smrt-core';
 import { Vendor } from '../models/Vendor.js';
 import { VendorStatus } from '../types/index.js';

package/dist/index.d.ts

@@ -1,3 +1,66 @@
+/**
+ * @happyvertical/smrt-commerce
+ *
+ * Commerce models for the SMRT framework - contracts, fulfillments, payments.
+ *
+ * Key concepts:
+ * - Customer/Vendor link to Profile (from smrt-profiles)
+ * - Contract uses STI for different types (Estimate, Order, Lease, etc.)
+ * - Payment integrates with smrt-ledgers for journal entries
+ *
+ * @example
+ * ```typescript
+ * import {
+ *   Customer,
+ *   CustomerCollection,
+ *   Order,
+ *   ContractCollection,
+ *   Payment,
+ *   PaymentCollection,
+ * } from '@happyvertical/smrt-commerce';
+ *
+ * // Create collections
+ * const customers = await CustomerCollection.create({
+ *   persistence: { type: 'sql', url: 'commerce.db' }
+ * });
+ *
+ * // Create a customer linked to a profile
+ * // Every money value is integer minor units — $100.00 is 10000 (#2401).
+ * const customer = await customers.create({
+ *   profileId: 'profile-uuid',
+ *   creditLimit: 1000000, // $10,000.00
+ *   paymentTerms: 'Net 30'
+ * });
+ * await customer.save();
+ *
+ * // Create an order
+ * const contracts = await ContractCollection.create(customer.options);
+ * const order = await contracts.create({
+ *   _meta_type: 'Order',
+ *   customerId: customer.id,
+ *   totalAmount: 150000 // $1,500.00
+ * });
+ * await order.save();
+ *
+ * // Record payment with ledger integration
+ * const payments = await PaymentCollection.create(order.options);
+ * const payment = await payments.create({
+ *   contractId: order.id,
+ *   customerId: customer.id,
+ *   amount: 150000
+ * });
+ * await payment.save();
+ *
+ * await payment.recordPayment({
+ *   ledgerId: ledger.id,
+ *   receivablesAccountId: arAccount.id,
+ *   cashAccountId: bankAccount.id
+ * });
+ * ```
+ *
+ * @packageDocumentation
+ */
+import './__smrt-register__.js';
 export * from './billing/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 { COMMERCE_MONEY_COLUMNS, COMMERCE_MONEY_MINOR_UNITS_BACKFILL, COMMERCE_NATIVE_UNIT_COLUMNS, migrateCommerceMoneyToMinorUnits, preflightCommerceMoneyMinorUnits, } from './migrations/moneyMinorUnits.js';