shutro-erp 0.3.3 → 0.3.5

package/dist/sales/module.d.ts

@@ -161,6 +161,26 @@ export declare const SaleOrder: import("../server/orm.js").Model<"sale.order", {
         readonly hasDefault: false;
         readonly readonly: true;
     }>;
+    readonly margin: import("../server/orm.js").MonetaryField<"currency", {
+        readonly required: false;
+        readonly computed: true;
+        readonly inverse: false;
+        readonly sequence: false;
+        readonly computeName: undefined;
+        readonly store: true;
+        readonly hasDefault: false;
+        readonly readonly: true;
+    }>;
+    readonly marginPercent: import("../server/orm.js").DecimalField<{
+        readonly required: false;
+        readonly computed: true;
+        readonly inverse: false;
+        readonly sequence: false;
+        readonly computeName: undefined;
+        readonly store: true;
+        readonly hasDefault: false;
+        readonly readonly: true;
+    }>;
     readonly state: import("../server/orm.js").StateField<"cancel" | "done" | "draft" | "sale" | "sent", {
         readonly send: {
             readonly from: readonly ["draft"];
@@ -318,6 +338,27 @@ export declare const SaleOrder: import("../server/orm.js").Model<"sale.order", {
         readonly hasDefault: false;
         readonly readonly: true;
     }>;
+    /** RFC 0022 step 2: what the order earns — the lines' untaxed amounts less their products' cost. */
+    readonly margin: import("../server/orm.js").MonetaryField<"currency", {
+        readonly required: false;
+        readonly computed: true;
+        readonly inverse: false;
+        readonly sequence: false;
+        readonly computeName: undefined;
+        readonly store: true;
+        readonly hasDefault: false;
+        readonly readonly: true;
+    }>;
+    readonly marginPercent: import("../server/orm.js").DecimalField<{
+        readonly required: false;
+        readonly computed: true;
+        readonly inverse: false;
+        readonly sequence: false;
+        readonly computeName: undefined;
+        readonly store: true;
+        readonly hasDefault: false;
+        readonly readonly: true;
+    }>;
     readonly state: import("../server/orm.js").StateField<"cancel" | "done" | "draft" | "sale" | "sent", {
         readonly send: {
             readonly from: readonly ["draft"];
@@ -355,6 +396,29 @@ export declare const SaleOrder: import("../server/orm.js").Model<"sale.order", {
         sequence: false;
     }>;
 }>>;
+/** The company's quotation settings (RFC 0020): how long quotations stay valid, and their default terms. */
+export declare const CompanySales: import("../server/orm.js").Extension<"res.company", {
+    readonly saleValidityDays: import("../server/orm.js").ScalarField<"integer", number, number, {
+        readonly required: false;
+        readonly computed: false;
+        readonly inverse: false;
+        readonly sequence: false;
+        readonly computeName: undefined;
+        readonly store: true;
+        readonly hasDefault: true;
+        readonly readonly: false;
+    }>;
+    readonly saleTerms: import("../server/orm.js").ScalarField<"text", string, string, {
+        readonly required: false;
+        readonly computed: false;
+        readonly inverse: false;
+        readonly sequence: false;
+        readonly computeName: undefined;
+        readonly store: true;
+        readonly hasDefault: false;
+        readonly readonly: false;
+    }>;
+}, Record<never, never>>;
 export declare const SaleOrderLine: import("../server/orm.js").Model<"sale.order.line", {
     readonly id: import("../server/orm.js").IdField<"sale.order.line">;
     readonly createdAt: import("../server/orm.js").ScalarField<'datetime', Date, Date, {
@@ -507,6 +571,16 @@ export declare const SaleOrderLine: import("../server/orm.js").Model<"sale.order
         readonly hasDefault: false;
         readonly readonly: true;
     }>;
+    readonly margin: import("../server/orm.js").MonetaryField<"currency", {
+        readonly required: false;
+        readonly computed: true;
+        readonly inverse: false;
+        readonly sequence: false;
+        readonly computeName: undefined;
+        readonly store: true;
+        readonly hasDefault: false;
+        readonly readonly: true;
+    }>;
     readonly taxAmount: import("../server/orm.js").MonetaryField<"currency", {
         readonly required: false;
         readonly computed: true;
@@ -632,6 +706,17 @@ export declare const SaleOrderLine: import("../server/orm.js").Model<"sale.order
         readonly hasDefault: false;
         readonly readonly: true;
     }>;
+    /** The line's untaxed amount less its product's cost at the time (RFC 0022 step 2). */
+    readonly margin: import("../server/orm.js").MonetaryField<"currency", {
+        readonly required: false;
+        readonly computed: true;
+        readonly inverse: false;
+        readonly sequence: false;
+        readonly computeName: undefined;
+        readonly store: true;
+        readonly hasDefault: false;
+        readonly readonly: true;
+    }>;
     readonly taxAmount: import("../server/orm.js").MonetaryField<"currency", {
         readonly required: false;
         readonly computed: true;
@@ -806,6 +891,26 @@ export declare const salesShutro: import("../server/orm.js").Module<readonly [im
         readonly hasDefault: false;
         readonly readonly: true;
     }>;
+    readonly margin: import("../server/orm.js").MonetaryField<"currency", {
+        readonly required: false;
+        readonly computed: true;
+        readonly inverse: false;
+        readonly sequence: false;
+        readonly computeName: undefined;
+        readonly store: true;
+        readonly hasDefault: false;
+        readonly readonly: true;
+    }>;
+    readonly marginPercent: import("../server/orm.js").DecimalField<{
+        readonly required: false;
+        readonly computed: true;
+        readonly inverse: false;
+        readonly sequence: false;
+        readonly computeName: undefined;
+        readonly store: true;
+        readonly hasDefault: false;
+        readonly readonly: true;
+    }>;
     readonly state: import("../server/orm.js").StateField<"cancel" | "done" | "draft" | "sale" | "sent", {
         readonly send: {
             readonly from: readonly ["draft"];
@@ -963,6 +1068,27 @@ export declare const salesShutro: import("../server/orm.js").Module<readonly [im
         readonly hasDefault: false;
         readonly readonly: true;
     }>;
+    /** RFC 0022 step 2: what the order earns — the lines' untaxed amounts less their products' cost. */
+    readonly margin: import("../server/orm.js").MonetaryField<"currency", {
+        readonly required: false;
+        readonly computed: true;
+        readonly inverse: false;
+        readonly sequence: false;
+        readonly computeName: undefined;
+        readonly store: true;
+        readonly hasDefault: false;
+        readonly readonly: true;
+    }>;
+    readonly marginPercent: import("../server/orm.js").DecimalField<{
+        readonly required: false;
+        readonly computed: true;
+        readonly inverse: false;
+        readonly sequence: false;
+        readonly computeName: undefined;
+        readonly store: true;
+        readonly hasDefault: false;
+        readonly readonly: true;
+    }>;
     readonly state: import("../server/orm.js").StateField<"cancel" | "done" | "draft" | "sale" | "sent", {
         readonly send: {
             readonly from: readonly ["draft"];
@@ -1151,6 +1277,16 @@ export declare const salesShutro: import("../server/orm.js").Module<readonly [im
         readonly hasDefault: false;
         readonly readonly: true;
     }>;
+    readonly margin: import("../server/orm.js").MonetaryField<"currency", {
+        readonly required: false;
+        readonly computed: true;
+        readonly inverse: false;
+        readonly sequence: false;
+        readonly computeName: undefined;
+        readonly store: true;
+        readonly hasDefault: false;
+        readonly readonly: true;
+    }>;
     readonly taxAmount: import("../server/orm.js").MonetaryField<"currency", {
         readonly required: false;
         readonly computed: true;
@@ -1276,6 +1412,17 @@ export declare const salesShutro: import("../server/orm.js").Module<readonly [im
         readonly hasDefault: false;
         readonly readonly: true;
     }>;
+    /** The line's untaxed amount less its product's cost at the time (RFC 0022 step 2). */
+    readonly margin: import("../server/orm.js").MonetaryField<"currency", {
+        readonly required: false;
+        readonly computed: true;
+        readonly inverse: false;
+        readonly sequence: false;
+        readonly computeName: undefined;
+        readonly store: true;
+        readonly hasDefault: false;
+        readonly readonly: true;
+    }>;
     readonly taxAmount: import("../server/orm.js").MonetaryField<"currency", {
         readonly required: false;
         readonly computed: true;
@@ -1286,7 +1433,70 @@ export declare const salesShutro: import("../server/orm.js").Module<readonly [im
         readonly hasDefault: false;
         readonly readonly: true;
     }>;
-}>>], readonly [import("../server/orm.js").Module<readonly [import("../server/orm.js").Model<"res.partner", {
+}>>], readonly [import("../server/orm.js").Module<readonly [import("../server/orm.js").Model<"res.partner.tag", {
+    readonly id: import("../server/orm.js").IdField<"res.partner.tag">;
+    readonly createdAt: import("../server/orm.js").ScalarField<'datetime', Date, Date, {
+        required: true;
+        readonly: true;
+        computed: false;
+        inverse: false;
+        hasDefault: false;
+        sequence: false;
+    }>;
+    readonly updatedAt: import("../server/orm.js").ScalarField<'datetime', Date, Date, {
+        required: true;
+        readonly: true;
+        computed: false;
+        inverse: false;
+        hasDefault: false;
+        sequence: false;
+    }>;
+    readonly createdBy: import("../server/orm.js").Many2oneField<'res.users', {
+        required: false;
+        readonly: true;
+        computed: false;
+        inverse: false;
+        hasDefault: false;
+        sequence: false;
+    }>;
+    readonly updatedBy: import("../server/orm.js").Many2oneField<'res.users', {
+        required: false;
+        readonly: true;
+        computed: false;
+        inverse: false;
+        hasDefault: false;
+        sequence: false;
+    }>;
+    readonly displayName: import("../server/orm.js").CharField<{
+        required: true;
+        readonly: true;
+        computed: true;
+        inverse: false;
+        hasDefault: false;
+        sequence: false;
+    }>;
+    readonly name: import("../server/orm.js").CharField<{
+        readonly required: true;
+        readonly computed: false;
+        readonly inverse: false;
+        readonly sequence: false;
+        readonly computeName: undefined;
+        readonly store: true;
+        readonly hasDefault: false;
+        readonly readonly: false;
+    }, string>;
+}, {} & import("../server/orm.js").TransitionMethods<{
+    readonly name: import("../server/orm.js").CharField<{
+        readonly required: true;
+        readonly computed: false;
+        readonly inverse: false;
+        readonly sequence: false;
+        readonly computeName: undefined;
+        readonly store: true;
+        readonly hasDefault: false;
+        readonly readonly: false;
+    }, string>;
+}>>, import("../server/orm.js").Model<"res.partner", {
     readonly id: import("../server/orm.js").IdField<"res.partner">;
     readonly createdAt: import("../server/orm.js").ScalarField<'datetime', Date, Date, {
         required: true;
@@ -1340,6 +1550,46 @@ export declare const salesShutro: import("../server/orm.js").Module<readonly [im
         readonly hasDefault: false;
         readonly readonly: false;
     }, string>;
+    readonly image: import("../server/orm.js").Many2oneField<"storage.attachment", {
+        readonly required: false;
+        readonly computed: false;
+        readonly inverse: false;
+        readonly sequence: false;
+        readonly computeName: undefined;
+        readonly store: true;
+        readonly hasDefault: false;
+        readonly readonly: false;
+    }>;
+    readonly tags: import("../server/orm.js").Many2manyField<"res.partner.tag", {
+        readonly required: true;
+        readonly computed: false;
+        readonly inverse: false;
+        readonly sequence: false;
+        readonly computeName: undefined;
+        readonly store: true;
+        readonly hasDefault: true;
+        readonly readonly: false;
+    }>;
+    readonly latitude: import("../server/orm.js").DecimalField<{
+        readonly required: false;
+        readonly computed: false;
+        readonly inverse: false;
+        readonly sequence: false;
+        readonly computeName: undefined;
+        readonly store: true;
+        readonly hasDefault: false;
+        readonly readonly: false;
+    }>;
+    readonly longitude: import("../server/orm.js").DecimalField<{
+        readonly required: false;
+        readonly computed: false;
+        readonly inverse: false;
+        readonly sequence: false;
+        readonly computeName: undefined;
+        readonly store: true;
+        readonly hasDefault: false;
+        readonly readonly: false;
+    }>;
     readonly isCompany: import("../server/orm.js").ScalarField<"boolean", boolean, boolean, {
         readonly required: true;
         readonly computed: false;
@@ -1521,6 +1771,46 @@ export declare const salesShutro: import("../server/orm.js").Module<readonly [im
         readonly hasDefault: false;
         readonly readonly: false;
     }, string>;
+    readonly image: import("../server/orm.js").Many2oneField<"storage.attachment", {
+        readonly required: false;
+        readonly computed: false;
+        readonly inverse: false;
+        readonly sequence: false;
+        readonly computeName: undefined;
+        readonly store: true;
+        readonly hasDefault: false;
+        readonly readonly: false;
+    }>;
+    readonly tags: import("../server/orm.js").Many2manyField<"res.partner.tag", {
+        readonly required: true;
+        readonly computed: false;
+        readonly inverse: false;
+        readonly sequence: false;
+        readonly computeName: undefined;
+        readonly store: true;
+        readonly hasDefault: true;
+        readonly readonly: false;
+    }>;
+    readonly latitude: import("../server/orm.js").DecimalField<{
+        readonly required: false;
+        readonly computed: false;
+        readonly inverse: false;
+        readonly sequence: false;
+        readonly computeName: undefined;
+        readonly store: true;
+        readonly hasDefault: false;
+        readonly readonly: false;
+    }>;
+    readonly longitude: import("../server/orm.js").DecimalField<{
+        readonly required: false;
+        readonly computed: false;
+        readonly inverse: false;
+        readonly sequence: false;
+        readonly computeName: undefined;
+        readonly store: true;
+        readonly hasDefault: false;
+        readonly readonly: false;
+    }>;
     readonly isCompany: import("../server/orm.js").ScalarField<"boolean", boolean, boolean, {
         readonly required: true;
         readonly computed: false;
@@ -1691,7 +1981,28 @@ export declare const salesShutro: import("../server/orm.js").Module<readonly [im
         readonly hasDefault: false;
         readonly readonly: false;
     }>;
-}>>], readonly [import("../server/orm.js").Module<readonly import("../server/orm.js").AnyModel[], readonly import("../server/orm.js").ModuleBase[], readonly import("../server/orm.js").AnyExtension[]>], readonly []>, import("../server/orm.js").Module<readonly [import("../server/orm.js").Model<"uom.uom", {
+}>>], readonly [import("../server/orm.js").Module<readonly import("../server/orm.js").AnyModel[], readonly import("../server/orm.js").ModuleBase[], readonly import("../server/orm.js").AnyExtension[]>, import("../server/orm.js").Module<readonly import("../server/orm.js").AnyModel[], readonly import("../server/orm.js").ModuleBase[], readonly import("../server/orm.js").AnyExtension[]>], readonly [import("../server/orm.js").Extension<"res.company", {
+    readonly contactTaxIdRequired: import("../server/orm.js").ScalarField<"boolean", boolean, boolean, {
+        readonly required: true;
+        readonly computed: false;
+        readonly inverse: false;
+        readonly sequence: false;
+        readonly computeName: undefined;
+        readonly store: true;
+        readonly hasDefault: true;
+        readonly readonly: false;
+    }>;
+    readonly contactUniqueEmail: import("../server/orm.js").ScalarField<"boolean", boolean, boolean, {
+        readonly required: true;
+        readonly computed: false;
+        readonly inverse: false;
+        readonly sequence: false;
+        readonly computeName: undefined;
+        readonly store: true;
+        readonly hasDefault: true;
+        readonly readonly: false;
+    }>;
+}, Record<never, never>>]>, import("../server/orm.js").Module<readonly [import("../server/orm.js").Model<"uom.uom", {
     readonly id: import("../server/orm.js").IdField<"uom.uom">;
     readonly createdAt: import("../server/orm.js").ScalarField<'datetime', Date, Date, {
         required: true;
@@ -2225,6 +2536,16 @@ export declare const salesShutro: import("../server/orm.js").Module<readonly [im
         readonly hasDefault: false;
         readonly readonly: false;
     }, string>;
+    readonly image: import("../server/orm.js").Many2oneField<"storage.attachment", {
+        readonly required: false;
+        readonly computed: false;
+        readonly inverse: false;
+        readonly sequence: false;
+        readonly computeName: undefined;
+        readonly store: true;
+        readonly hasDefault: false;
+        readonly readonly: false;
+    }>;
     readonly listPrice: import("../server/orm.js").DecimalField<{
         readonly required: true;
         readonly computed: false;
@@ -2376,6 +2697,16 @@ export declare const salesShutro: import("../server/orm.js").Module<readonly [im
         readonly hasDefault: false;
         readonly readonly: false;
     }, string>;
+    readonly image: import("../server/orm.js").Many2oneField<"storage.attachment", {
+        readonly required: false;
+        readonly computed: false;
+        readonly inverse: false;
+        readonly sequence: false;
+        readonly computeName: undefined;
+        readonly store: true;
+        readonly hasDefault: false;
+        readonly readonly: false;
+    }>;
     readonly listPrice: import("../server/orm.js").DecimalField<{
         readonly required: true;
         readonly computed: false;
@@ -2466,4 +2797,25 @@ export declare const salesShutro: import("../server/orm.js").Module<readonly [im
         readonly hasDefault: false;
         readonly readonly: false;
     }>;
-}>>], readonly [import("../server/orm.js").Module<readonly import("../server/orm.js").AnyModel[], readonly import("../server/orm.js").ModuleBase[], readonly import("../server/orm.js").AnyExtension[]>], readonly []>, import("../server/orm.js").Module<readonly import("../server/orm.js").AnyModel[], readonly import("../server/orm.js").ModuleBase[], readonly import("../server/orm.js").AnyExtension[]>], readonly []>;
+}>>], readonly [import("../server/orm.js").Module<readonly import("../server/orm.js").AnyModel[], readonly import("../server/orm.js").ModuleBase[], readonly import("../server/orm.js").AnyExtension[]>, import("../server/orm.js").Module<readonly import("../server/orm.js").AnyModel[], readonly import("../server/orm.js").ModuleBase[], readonly import("../server/orm.js").AnyExtension[]>], readonly []>, import("../server/orm.js").Module<readonly import("../server/orm.js").AnyModel[], readonly import("../server/orm.js").ModuleBase[], readonly import("../server/orm.js").AnyExtension[]>], readonly [import("../server/orm.js").Extension<"res.company", {
+    readonly saleValidityDays: import("../server/orm.js").ScalarField<"integer", number, number, {
+        readonly required: false;
+        readonly computed: false;
+        readonly inverse: false;
+        readonly sequence: false;
+        readonly computeName: undefined;
+        readonly store: true;
+        readonly hasDefault: true;
+        readonly readonly: false;
+    }>;
+    readonly saleTerms: import("../server/orm.js").ScalarField<"text", string, string, {
+        readonly required: false;
+        readonly computed: false;
+        readonly inverse: false;
+        readonly sequence: false;
+        readonly computeName: undefined;
+        readonly store: true;
+        readonly hasDefault: false;
+        readonly readonly: false;
+    }>;
+}, Record<never, never>>]>;

package/dist/sales/module.js

@@ -7,12 +7,20 @@ import { contactsShutro } from '../contacts/index.js';
 import { messagingShutro } from '../messaging/index.js';
 import { computeTaxes, productShutro, taxRule } from '../product/index.js';
 import { orm } from '../server/orm.js';
-import { check, compute, defineModel, defineModule, f, onchange, records, } from './.kosh/bindings.js';
+import { check, compute, defineModel, defineModule, extendModel, f, onchange, records, } from './.kosh/bindings.js';
 /** A line's taxes through the engine (RFC 0016): its amount after discount, its taxes in order. */
 function taxesOf(l) {
     const amount = l.quantity.times(l.priceUnit).times(orm.toDecimal(100).minus(l.discount)).div(100);
     return computeTaxes(amount, l.quantity, [...l.taxes].map(taxRule));
 }
+/** A monetary value's amount (a Money object or a plain Decimal), or null. */
+function amountOf(value) {
+    if (value === null || value === undefined)
+        return null;
+    if (typeof value === 'object' && 'amount' in value)
+        return value.amount;
+    return value;
+}
 const amounts = compute('sale.order', ['amountUntaxed', 'amountTax', 'amountTotal'], ['lines.subtotal', 'lines.taxAmount'], (orders) => {
     for (const o of orders) {
         // A new order has no currency until its partner is chosen: no amounts yet.
@@ -64,6 +72,31 @@ export const SaleOrder = defineModel('sale.order', {
         amountUntaxed: f.monetary({ currency: 'currency', store: true, label: 'Untaxed', ...amounts }),
         amountTax: f.monetary({ currency: 'currency', store: true, label: 'Taxes', ...amounts }),
         amountTotal: f.monetary({ currency: 'currency', store: true, label: 'Total', ...amounts }),
+        /** RFC 0022 step 2: what the order earns — the lines' untaxed amounts less their products' cost. */
+        margin: f.monetary({
+            currency: 'currency',
+            store: true,
+            label: 'Margin',
+            ...compute('sale.order', 'margin', ['lines.margin', 'currency'], (orders) => {
+                for (const o of orders)
+                    o.margin = o.currency === null ? null : o.lines.sum('margin', o.currency);
+            }),
+        }),
+        marginPercent: f.decimal({
+            scale: 1,
+            store: true,
+            label: 'Margin (%)',
+            ...compute('sale.order', 'marginPercent', ['margin', 'amountUntaxed'], (orders) => {
+                for (const o of orders) {
+                    const untaxed = amountOf(o.amountUntaxed);
+                    const margin = amountOf(o.margin);
+                    o.marginPercent =
+                        untaxed === null || margin === null || untaxed.isZero()
+                            ? null
+                            : margin.times(100).div(untaxed).toDecimalPlaces(1);
+                }
+            }),
+        }),
         state: f.state({
             states: {
                 draft: 'Quotation',
@@ -98,8 +131,9 @@ export const SaleOrder = defineModel('sale.order', {
         }),
     },
     onchange: {
-        // The customer's currency, else the company's.
+        // The customer's currency, else the company's; an empty validity and terms from the company's settings.
         partner: onchange('sale.order', async (d, env) => {
+            await quotationDefaults(d, env);
             const p = await d.record('partner');
             if (p?.currency) {
                 d.set('currency', p.currency.id);
@@ -112,8 +146,33 @@ export const SaleOrder = defineModel('sale.order', {
             if (company !== undefined)
                 d.set('currency', company.currency.id);
         }),
+        // A new order date moves the validity with it.
+        dateOrder: onchange('sale.order', async (d, env) => {
+            d.set('validityDate', null);
+            await quotationDefaults(d, env);
+        }),
     },
 });
+/** The company's quotation settings (RFC 0020): how long quotations stay valid, and their default terms. */
+export const CompanySales = extendModel('res.company', {
+    fields: {
+        saleValidityDays: f.integer({ default: 30, label: 'Quotations valid for (days, 0: no limit)' }),
+        saleTerms: f.text({ label: 'Default terms and conditions' }),
+    },
+});
+/** Fills an order's empty validity and terms from its company's settings. */
+async function quotationDefaults(d, env) {
+    const [company] = (await env.model('res.company').browse([env.companyId]).load(['saleValidityDays', 'saleTerms'])).read(['saleValidityDays', 'saleTerms']);
+    const days = Number(company?.['saleValidityDays'] ?? 0);
+    const date = d.get('dateOrder');
+    if ((d.get('validityDate') ?? null) === null && days > 0 && typeof date === 'string') {
+        const [y, m, day] = date.split('-').map(Number);
+        d.set('validityDate', new Date(Date.UTC(y, m - 1, day + days)).toISOString().slice(0, 10));
+    }
+    const terms = company?.['saleTerms'];
+    if ((d.get('note') ?? '') === '' && typeof terms === 'string' && terms !== '')
+        d.set('note', terms);
+}
 export const SaleOrderLine = defineModel('sale.order.line', {
     label: 'Order line',
     access: {
@@ -160,6 +219,21 @@ export const SaleOrderLine = defineModel('sale.order.line', {
                     l.subtotal = taxesOf(l).untaxed;
             }),
         }),
+        /** The line's untaxed amount less its product's cost at the time (RFC 0022 step 2). */
+        margin: f.monetary({
+            currency: 'currency',
+            store: true,
+            label: 'Margin',
+            ...compute('sale.order.line', 'margin', ['subtotal', 'quantity', 'product.standardPrice'], (lines) => {
+                for (const l of lines) {
+                    const untaxed = amountOf(l.subtotal);
+                    l.margin =
+                        untaxed === null || l.product === null
+                            ? null
+                            : untaxed.minus(l.quantity.times(l.product.standardPrice));
+                }
+            }),
+        }),
         taxAmount: f.monetary({
             currency: 'currency',
             store: true,
@@ -207,7 +281,7 @@ export const SaleOrderLine = defineModel('sale.order.line', {
 });
 export const salesShutro = defineModule({
     name: 'sales',
-    version: '0.2.0',
+    version: '0.3.0',
     migrations: [
         {
             version: '0.2.0',
@@ -231,4 +305,5 @@ export const salesShutro = defineModule({
         orm.defineSequence({ code: 'sale.order', prefix: 'SO/{year}/', padding: 5, reset: 'yearly' }),
     ],
     models: [SaleOrder, SaleOrderLine],
+    extensions: [CompanySales],
 });

package/dist/server/api/metadata.d.ts

@@ -20,6 +20,8 @@ export interface ApiField {
     /** `[value, label]` for selection and state fields with a static list. */
     readonly options: readonly (readonly [string, string])[] | null;
     readonly translate: boolean;
+    /** The field's help text, for hints on forms (RFC 0022 §3.4). */
+    readonly help: string | null;
 }
 /** A state transition. */
 export interface TransitionSpec {
@@ -29,6 +31,9 @@ export interface TransitionSpec {
     readonly to: string;
     /** A feature permission the user needs (`definePermission`), or `null`. */
     readonly requires: string | null;
+    /** The transition's guard (the records that may not go) and the message when it refuses (RFC 0022 §3.4). */
+    readonly guard: ((records: unknown) => unknown) | null;
+    readonly message: string | null;
 }
 /** One model as the API exposes it. */
 export interface ApiModel {

package/dist/server/api/metadata.js

@@ -34,6 +34,10 @@ export function apiModels(registry) {
                         from: Array.isArray(spec['from']) ? spec['from'] : [],
                         to: String(spec['to'] ?? ''),
                         requires: typeof spec['requires'] === 'string' ? spec['requires'] : null,
+                        guard: typeof spec['guard'] === 'function'
+                            ? spec['guard']
+                            : null,
+                        message: typeof spec['message'] === 'string' ? spec['message'] : null,
                     });
                 }
             const computedReadonly = d.computed && raw['inverse'] === undefined;
@@ -41,6 +45,7 @@ export function apiModels(registry) {
                 key,
                 kind: d.kind,
                 label: d.label,
+                help: d.help ?? null,
                 required: d.required,
                 readonly: d.readonly || computedReadonly || IMPLICIT_READONLY.has(key) || d.kind === 'state',
                 stored: d.column !== null,