@happyvertical/smrt-commerce 0.55.7 → 0.55.9

package/dist/recipes.d.ts

@@ -1,53 +1,144 @@
 /**
- * Declared recipes for smrt-commerce (#3590): small, user-facing units of
+ * Declared recipes for smrt-commerce (#3590, #3604): user-facing units of
  * functionality an app or agent can pick instead of the whole package.
- *
- * Deliberately minimal: headers only. Line items, fulfilment, invoices, and
- * payments are later recipes.
+ * The scanner reads these statics into the `recipes` array of `manifest.json`
+ * and `smrt-knowledge.json`; nothing here runs at that point.
  *
  * @packageDocumentation
  */
 import { SmrtRecipe } from '@happyvertical/smrt-core';
-import { Order, PurchaseOrder } from './models/Contract.js';
+import { Agreement, Contract, Estimate, Lease, LicenseSale, Order, PurchaseOrder, WholesaleOrder } from './models/Contract.js';
+import { ContractLineItem } from './models/ContractLineItem.js';
 import { Customer } from './models/Customer.js';
+import { Fulfillment } from './models/Fulfillment.js';
+import { FulfillmentLineItem } from './models/FulfillmentLineItem.js';
+import { Invoice } from './models/Invoice.js';
+import { InvoiceLineItem } from './models/InvoiceLineItem.js';
+import { Payment } from './models/Payment.js';
+import { PaymentAllocation } from './models/PaymentAllocation.js';
 import { Vendor } from './models/Vendor.js';
-/** The people and organisations you sell to. */
+/** Customers: Keep a list of the people and companies you sell to. */
 export declare class CustomersRecipe extends SmrtRecipe {
     static id: string;
     static help: string;
     static label: string;
     static summary: string;
     static synonyms: string[];
+    static section: {
+        id: string;
+        label: string;
+        icon: string;
+        description: string;
+    };
     static models: (typeof Customer)[];
     static nav: {
         label: string;
         model: typeof Customer;
+        icon: string;
+        description: string;
     }[];
+    static options: {
+        readonly Customer: {
+            readonly fields: {
+                readonly profileId: {
+                    readonly label: "Name";
+                    readonly order: -1;
+                };
+            };
+        };
+    };
 }
-/** The people and organisations you buy from. */
-export declare class VendorsRecipe extends SmrtRecipe {
+/** Purchases: Order from your vendors and track what you have bought. */
+export declare class PurchasesRecipe extends SmrtRecipe {
     static id: string;
     static help: string;
     static label: string;
     static summary: string;
     static synonyms: string[];
-    static models: (typeof Vendor)[];
+    static section: {
+        id: string;
+        label: string;
+        icon: string;
+        description: string;
+    };
+    static models: (typeof PurchaseOrder | typeof ContractLineItem)[];
     static nav: {
         label: string;
-        model: typeof Vendor;
+        model: typeof PurchaseOrder;
+        icon: string;
+        description: string;
     }[];
+    static requires: string[];
+    static options: {
+        readonly PurchaseOrder: {
+            readonly fields: {
+                readonly contractType: {
+                    readonly default: "purchase_order";
+                    readonly visibility: "hidden";
+                    readonly locked: true;
+                };
+                readonly customerId: {
+                    readonly visibility: "hidden";
+                    readonly locked: true;
+                };
+                readonly vendorId: {
+                    readonly label: "Vendor";
+                    readonly order: 1;
+                };
+                readonly channelId: {
+                    readonly visibility: "hidden";
+                };
+                readonly expiryDate: {
+                    readonly visibility: "hidden";
+                };
+            };
+        };
+        readonly ContractLineItem: {
+            readonly fields: {
+                readonly sku: {
+                    readonly visibility: "hidden";
+                };
+                readonly startDate: {
+                    readonly visibility: "hidden";
+                };
+                readonly endDate: {
+                    readonly visibility: "hidden";
+                };
+                readonly billingPeriod: {
+                    readonly visibility: "hidden";
+                };
+                readonly sortOrder: {
+                    readonly visibility: "hidden";
+                };
+                readonly discount: {
+                    readonly visibility: "hidden";
+                };
+                readonly taxRate: {
+                    readonly help: "Type a percentage: 5 means 5%.";
+                };
+            };
+        };
+    };
 }
-/** Customer orders. */
+/** Sales: Take customer orders and track them. */
 export declare class SalesRecipe extends SmrtRecipe {
     static id: string;
     static help: string;
     static label: string;
     static summary: string;
     static synonyms: string[];
-    static models: (typeof Order)[];
+    static section: {
+        id: string;
+        label: string;
+        icon: string;
+        description: string;
+    };
+    static models: (typeof Order | typeof ContractLineItem)[];
     static nav: {
         label: string;
         model: typeof Order;
+        icon: string;
+        description: string;
     }[];
     static requires: string[];
     static options: {
@@ -65,40 +156,663 @@ export declare class SalesRecipe extends SmrtRecipe {
                 readonly customerId: {
                     readonly label: "Customer";
                     readonly order: 1;
+                    readonly required: true;
+                };
+                readonly channelId: {
+                    readonly visibility: "hidden";
+                };
+                readonly expiryDate: {
+                    readonly visibility: "hidden";
+                };
+            };
+        };
+        readonly ContractLineItem: {
+            readonly fields: {
+                readonly sku: {
+                    readonly visibility: "hidden";
+                };
+                readonly startDate: {
+                    readonly visibility: "hidden";
+                };
+                readonly endDate: {
+                    readonly visibility: "hidden";
+                };
+                readonly billingPeriod: {
+                    readonly visibility: "hidden";
+                };
+                readonly sortOrder: {
+                    readonly visibility: "hidden";
+                };
+                readonly discount: {
+                    readonly visibility: "hidden";
+                };
+                readonly taxRate: {
+                    readonly help: "Type a percentage: 5 means 5%.";
                 };
             };
         };
     };
 }
-/** Orders placed with vendors. */
-export declare class PurchasesRecipe extends SmrtRecipe {
+/** Vendors: Keep a list of the suppliers you buy from. */
+export declare class VendorsRecipe extends SmrtRecipe {
     static id: string;
     static help: string;
     static label: string;
     static summary: string;
     static synonyms: string[];
-    static models: (typeof PurchaseOrder)[];
+    static section: {
+        id: string;
+        label: string;
+        icon: string;
+        description: string;
+    };
+    static models: (typeof Vendor)[];
     static nav: {
         label: string;
-        model: typeof PurchaseOrder;
+        model: typeof Vendor;
+        icon: string;
+        description: string;
+    }[];
+    static options: {
+        readonly Vendor: {
+            readonly fields: {
+                readonly profileId: {
+                    readonly label: "Name";
+                    readonly order: -1;
+                };
+            };
+        };
+    };
+}
+/** Estimates: Send customers a price quote before they commit. */
+export declare class EstimatesRecipe extends SmrtRecipe {
+    static id: string;
+    static help: string;
+    static label: string;
+    static summary: string;
+    static synonyms: string[];
+    static section: {
+        id: string;
+        label: string;
+        icon: string;
+        description: string;
+    };
+    static models: (typeof Estimate | typeof ContractLineItem)[];
+    static nav: {
+        label: string;
+        model: typeof Estimate;
+        icon: string;
+        description: string;
     }[];
     static requires: string[];
     static options: {
-        readonly PurchaseOrder: {
+        readonly Estimate: {
             readonly fields: {
                 readonly contractType: {
-                    readonly default: "purchase_order";
+                    readonly default: "estimate";
+                    readonly visibility: "hidden";
+                    readonly locked: true;
+                };
+                readonly vendorId: {
                     readonly visibility: "hidden";
                     readonly locked: true;
                 };
                 readonly customerId: {
+                    readonly label: "Customer";
+                    readonly order: 1;
+                    readonly required: true;
+                };
+                readonly channelId: {
+                    readonly visibility: "hidden";
+                };
+            };
+        };
+        readonly ContractLineItem: {
+            readonly fields: {
+                readonly sku: {
+                    readonly visibility: "hidden";
+                };
+                readonly startDate: {
+                    readonly visibility: "hidden";
+                };
+                readonly endDate: {
+                    readonly visibility: "hidden";
+                };
+                readonly billingPeriod: {
+                    readonly visibility: "hidden";
+                };
+                readonly sortOrder: {
+                    readonly visibility: "hidden";
+                };
+                readonly discount: {
+                    readonly visibility: "hidden";
+                };
+                readonly taxRate: {
+                    readonly help: "Type a percentage: 5 means 5%.";
+                };
+            };
+        };
+    };
+}
+/** Wholesale orders: Take bulk orders from trade customers. */
+export declare class WholesaleRecipe extends SmrtRecipe {
+    static id: string;
+    static help: string;
+    static label: string;
+    static summary: string;
+    static synonyms: string[];
+    static section: {
+        id: string;
+        label: string;
+        icon: string;
+        description: string;
+    };
+    static models: (typeof WholesaleOrder | typeof ContractLineItem)[];
+    static nav: {
+        label: string;
+        model: typeof WholesaleOrder;
+        icon: string;
+        description: string;
+    }[];
+    static requires: string[];
+    static options: {
+        readonly WholesaleOrder: {
+            readonly fields: {
+                readonly contractType: {
+                    readonly default: "wholesale_order";
                     readonly visibility: "hidden";
                     readonly locked: true;
                 };
                 readonly vendorId: {
-                    readonly label: "Vendor";
+                    readonly visibility: "hidden";
+                    readonly locked: true;
+                };
+                readonly customerId: {
+                    readonly label: "Customer";
                     readonly order: 1;
                 };
+                readonly channelId: {
+                    readonly visibility: "hidden";
+                };
+                readonly expiryDate: {
+                    readonly visibility: "hidden";
+                };
+            };
+        };
+        readonly ContractLineItem: {
+            readonly fields: {
+                readonly sku: {
+                    readonly visibility: "hidden";
+                };
+                readonly startDate: {
+                    readonly visibility: "hidden";
+                };
+                readonly endDate: {
+                    readonly visibility: "hidden";
+                };
+                readonly billingPeriod: {
+                    readonly visibility: "hidden";
+                };
+                readonly sortOrder: {
+                    readonly visibility: "hidden";
+                };
+                readonly discount: {
+                    readonly visibility: "hidden";
+                };
+                readonly taxRate: {
+                    readonly help: "Type a percentage: 5 means 5%.";
+                };
+            };
+        };
+    };
+}
+/** Invoicing: Bill customers and record the payments that come in. */
+export declare class InvoicingRecipe extends SmrtRecipe {
+    static id: string;
+    static help: string;
+    static label: string;
+    static summary: string;
+    static synonyms: string[];
+    static group: {
+        id: string;
+        label: string;
+        summary: string;
+    };
+    static section: {
+        id: string;
+        label: string;
+        icon: string;
+        description: string;
+    };
+    static models: (typeof InvoiceLineItem | typeof Payment | typeof Invoice | typeof PaymentAllocation)[];
+    static nav: ({
+        label: string;
+        model: typeof Invoice;
+        icon: string;
+        description: string;
+    } | {
+        label: string;
+        model: typeof Payment;
+        icon: string;
+        description: string;
+    })[];
+    static requires: string[];
+    static options: {
+        readonly Invoice: {
+            readonly fields: {
+                readonly providerTaxAmount: {
+                    readonly visibility: "hidden";
+                };
+                readonly arJournalId: {
+                    readonly visibility: "hidden";
+                };
+                readonly revenueJournalId: {
+                    readonly visibility: "hidden";
+                };
+                readonly externalId: {
+                    readonly visibility: "hidden";
+                };
+                readonly customerExternalId: {
+                    readonly visibility: "hidden";
+                };
+                readonly externalProvider: {
+                    readonly visibility: "hidden";
+                };
+                readonly syncedAt: {
+                    readonly visibility: "hidden";
+                };
+                readonly collectionMethod: {
+                    readonly visibility: "hidden";
+                };
+                readonly sentAt: {
+                    readonly visibility: "hidden";
+                };
+                readonly viewedAt: {
+                    readonly visibility: "hidden";
+                };
+                readonly remindersSent: {
+                    readonly visibility: "hidden";
+                };
+                readonly lastReminderAt: {
+                    readonly visibility: "hidden";
+                };
+                readonly reference: {
+                    readonly visibility: "hidden";
+                };
+                readonly customerId: {
+                    readonly required: true;
+                };
+            };
+        };
+        readonly InvoiceLineItem: {
+            readonly fields: {
+                readonly invoiceEditorStateJson: {
+                    readonly visibility: "hidden";
+                };
+                readonly sourceType: {
+                    readonly visibility: "hidden";
+                };
+                readonly sourceId: {
+                    readonly visibility: "hidden";
+                };
+                readonly periodStart: {
+                    readonly visibility: "hidden";
+                };
+                readonly periodEnd: {
+                    readonly visibility: "hidden";
+                };
+                readonly revenueAccountId: {
+                    readonly visibility: "hidden";
+                };
+                readonly sortOrder: {
+                    readonly visibility: "hidden";
+                };
+                readonly sku: {
+                    readonly visibility: "hidden";
+                };
+                readonly discount: {
+                    readonly visibility: "hidden";
+                };
+                readonly taxRate: {
+                    readonly help: "Type a percentage: 5 means 5%.";
+                };
+            };
+        };
+        readonly Payment: {
+            readonly fields: {
+                readonly journalId: {
+                    readonly visibility: "hidden";
+                };
+                readonly externalId: {
+                    readonly visibility: "hidden";
+                };
+                readonly externalProvider: {
+                    readonly visibility: "hidden";
+                };
+                readonly syncedAt: {
+                    readonly visibility: "hidden";
+                };
+                readonly backendId: {
+                    readonly visibility: "hidden";
+                };
+                readonly backendTxRef: {
+                    readonly visibility: "hidden";
+                };
+                readonly nativeAmount: {
+                    readonly visibility: "hidden";
+                };
+                readonly nativeCurrency: {
+                    readonly visibility: "hidden";
+                };
+                readonly usdAtQuote: {
+                    readonly visibility: "hidden";
+                };
+                readonly usdAtConfirmation: {
+                    readonly visibility: "hidden";
+                };
+                readonly transactionId: {
+                    readonly visibility: "hidden";
+                };
+            };
+        };
+        readonly PaymentAllocation: {
+            readonly fields: {
+                readonly allocatedBy: {
+                    readonly visibility: "hidden";
+                };
+            };
+        };
+    };
+}
+/** Shipping: Pack, ship and deliver orders, with tracking. */
+export declare class FulfillmentRecipe extends SmrtRecipe {
+    static id: string;
+    static help: string;
+    static label: string;
+    static summary: string;
+    static synonyms: string[];
+    static group: {
+        id: string;
+        label: string;
+        summary: string;
+    };
+    static section: {
+        id: string;
+        label: string;
+        icon: string;
+        description: string;
+    };
+    static models: (typeof Fulfillment | typeof FulfillmentLineItem)[];
+    static nav: {
+        label: string;
+        model: typeof Fulfillment;
+        icon: string;
+        description: string;
+    }[];
+    static requiresAny: string[][];
+    static options: {
+        readonly Fulfillment: {
+            readonly fields: {
+                readonly estimatedDelivery: {
+                    readonly visibility: "hidden";
+                };
+                readonly shippingAddress: {
+                    readonly visibility: "hidden";
+                };
+            };
+        };
+        readonly FulfillmentLineItem: {
+            readonly fields: {
+                readonly notes: {
+                    readonly visibility: "hidden";
+                };
+            };
+        };
+    };
+}
+/** General agreements: Keep signed agreements with customers, and see every contract in one list. */
+export declare class AgreementsRecipe extends SmrtRecipe {
+    static id: string;
+    static help: string;
+    static label: string;
+    static summary: string;
+    static synonyms: string[];
+    static group: {
+        id: string;
+        label: string;
+        summary: string;
+    };
+    static section: {
+        id: string;
+        label: string;
+        icon: string;
+        description: string;
+    };
+    static models: (typeof Contract | typeof ContractLineItem)[];
+    static nav: {
+        label: string;
+        model: typeof Agreement;
+        icon: string;
+        description: string;
+    }[];
+    static requires: string[];
+    static options: {
+        readonly Agreement: {
+            readonly fields: {
+                readonly contractType: {
+                    readonly default: "agreement";
+                    readonly visibility: "hidden";
+                    readonly locked: true;
+                };
+                readonly customerId: {
+                    readonly label: "Customer";
+                    readonly order: 1;
+                    readonly required: true;
+                };
+                readonly vendorId: {
+                    readonly visibility: "hidden";
+                };
+                readonly subtotal: {
+                    readonly visibility: "hidden";
+                };
+                readonly taxAmount: {
+                    readonly visibility: "hidden";
+                };
+                readonly channelId: {
+                    readonly visibility: "hidden";
+                };
+            };
+        };
+        readonly ContractLineItem: {
+            readonly fields: {
+                readonly sku: {
+                    readonly visibility: "hidden";
+                };
+                readonly startDate: {
+                    readonly visibility: "hidden";
+                };
+                readonly endDate: {
+                    readonly visibility: "hidden";
+                };
+                readonly billingPeriod: {
+                    readonly visibility: "hidden";
+                };
+                readonly sortOrder: {
+                    readonly visibility: "hidden";
+                };
+                readonly discount: {
+                    readonly visibility: "hidden";
+                };
+                readonly taxRate: {
+                    readonly help: "Type a percentage: 5 means 5%.";
+                };
+            };
+        };
+        readonly Contract: {
+            readonly fields: {
+                readonly channelId: {
+                    readonly visibility: "hidden";
+                };
+            };
+        };
+    };
+}
+/** Leases: Rent things out and track the term and the payments due. */
+export declare class LeasesRecipe extends SmrtRecipe {
+    static id: string;
+    static help: string;
+    static label: string;
+    static summary: string;
+    static synonyms: string[];
+    static group: {
+        id: string;
+        label: string;
+        summary: string;
+    };
+    static section: {
+        id: string;
+        label: string;
+        icon: string;
+        description: string;
+    };
+    static models: (typeof Lease | typeof ContractLineItem)[];
+    static nav: {
+        label: string;
+        model: typeof Lease;
+        icon: string;
+        description: string;
+    }[];
+    static requires: string[];
+    static options: {
+        readonly Lease: {
+            readonly fields: {
+                readonly contractType: {
+                    readonly default: "lease";
+                    readonly visibility: "hidden";
+                    readonly locked: true;
+                };
+                readonly customerId: {
+                    readonly label: "Customer";
+                    readonly order: 1;
+                    readonly required: true;
+                };
+                readonly vendorId: {
+                    readonly visibility: "hidden";
+                };
+                readonly subtotal: {
+                    readonly visibility: "hidden";
+                };
+                readonly taxAmount: {
+                    readonly visibility: "hidden";
+                };
+                readonly channelId: {
+                    readonly visibility: "hidden";
+                };
+            };
+        };
+        readonly ContractLineItem: {
+            readonly fields: {
+                readonly sku: {
+                    readonly visibility: "hidden";
+                };
+                readonly startDate: {
+                    readonly visibility: "hidden";
+                };
+                readonly endDate: {
+                    readonly visibility: "hidden";
+                };
+                readonly billingPeriod: {
+                    readonly visibility: "hidden";
+                };
+                readonly sortOrder: {
+                    readonly visibility: "hidden";
+                };
+                readonly discount: {
+                    readonly visibility: "hidden";
+                };
+                readonly taxRate: {
+                    readonly help: "Type a percentage: 5 means 5%.";
+                };
+            };
+        };
+    };
+}
+/** Licence sales: Sell licences to software, content or other rights. */
+export declare class LicensesRecipe extends SmrtRecipe {
+    static id: string;
+    static help: string;
+    static label: string;
+    static summary: string;
+    static synonyms: string[];
+    static group: {
+        id: string;
+        label: string;
+        summary: string;
+    };
+    static section: {
+        id: string;
+        label: string;
+        icon: string;
+        description: string;
+    };
+    static models: (typeof LicenseSale | typeof ContractLineItem)[];
+    static nav: {
+        label: string;
+        model: typeof LicenseSale;
+        icon: string;
+        description: string;
+    }[];
+    static requires: string[];
+    static options: {
+        readonly LicenseSale: {
+            readonly fields: {
+                readonly contractType: {
+                    readonly default: "license_sale";
+                    readonly visibility: "hidden";
+                    readonly locked: true;
+                };
+                readonly customerId: {
+                    readonly label: "Customer";
+                    readonly order: 1;
+                    readonly required: true;
+                };
+                readonly vendorId: {
+                    readonly visibility: "hidden";
+                };
+                readonly subtotal: {
+                    readonly visibility: "hidden";
+                };
+                readonly taxAmount: {
+                    readonly visibility: "hidden";
+                };
+                readonly channelId: {
+                    readonly visibility: "hidden";
+                };
+            };
+        };
+        readonly ContractLineItem: {
+            readonly fields: {
+                readonly sku: {
+                    readonly visibility: "hidden";
+                };
+                readonly startDate: {
+                    readonly visibility: "hidden";
+                };
+                readonly endDate: {
+                    readonly visibility: "hidden";
+                };
+                readonly billingPeriod: {
+                    readonly visibility: "hidden";
+                };
+                readonly sortOrder: {
+                    readonly visibility: "hidden";
+                };
+                readonly discount: {
+                    readonly visibility: "hidden";
+                };
+                readonly taxRate: {
+                    readonly help: "Type a percentage: 5 means 5%.";
+                };
             };
         };
     };