shutro-erp 0.3.4 → 0.3.5

package/dist/sale_stock/module.js

@@ -0,0 +1,146 @@
+/**
+ * The data layer of the Sales ↔ Stockroom bridge (RFC 0021): a confirmed sales order gets its delivery — one
+ * Stockroom transfer with a line per goods line, in the line's unit, from the company's main warehouse to the
+ * customers — made once through the outbox (`sale.order.confirmed`) and confirmed, so its stock is reserved. The
+ * order shows its deliveries and what is delivered; each line, its delivered quantity.
+ */
+import { productShutro } from '../product/index.js';
+import { salesShutro } from '../sales/index.js';
+import { orm } from '../server/orm.js';
+import { defaultLocations, stockShutro } from '../stock/index.js';
+import { compute, defineModule, extendModel, f } from './.kosh/bindings.js';
+const zero = orm.toDecimal(0);
+export const PickingSale = extendModel('stock.picking', {
+    fields: { saleOrder: f.many2one('sale.order', { ondelete: 'set null', label: 'Sales order' }) },
+    overrides: {
+        // A backorder stays with its order.
+        backorderValues: async function (next) {
+            const out = await next();
+            for (const p of await this.load({}))
+                out.set(p.id, { ...out.get(p.id), saleOrder: p.saleOrder?.id ?? null });
+            return out;
+        },
+    },
+});
+export const MoveSale = extendModel('stock.move', {
+    fields: {
+        saleLine: f.many2one('sale.order.line', { ondelete: 'set null', label: 'Order line' }),
+    },
+    overrides: {
+        // The rest of a line stays tied to its order line.
+        backorderValues: async function (next) {
+            const out = await next();
+            for (const m of await this.load({}))
+                out.set(m.id, { ...out.get(m.id), saleLine: m.saleLine?.id ?? null });
+            return out;
+        },
+    },
+});
+export const LineDelivered = extendModel('sale.order.line', {
+    fields: {
+        moves: f.one2many('stock.move', 'saleLine'),
+        /** Delivered by validated deliveries, in the line's unit. */
+        qtyDelivered: f.decimal({
+            scale: 3,
+            store: true,
+            label: 'Delivered',
+            ...compute('sale.order.line', 'qtyDelivered', ['moves.quantity', 'moves.quantityDone', 'moves.picking.state'], (lines) => {
+                for (const l of lines)
+                    l.qtyDelivered = [...l.moves]
+                        .filter((m) => m.picking.state === 'done')
+                        .reduce((s, m) => s.plus(m.quantityDone ?? m.quantity), zero);
+            }),
+        }),
+    },
+});
+export const OrderDeliveries = extendModel('sale.order', {
+    fields: {
+        deliveries: f.one2many('stock.picking', 'saleOrder'),
+        deliveryState: f.selection({
+            nothing: 'Nothing to deliver',
+            to_deliver: 'To deliver',
+            partial: 'Partly delivered',
+            delivered: 'Delivered',
+        }, {
+            store: true,
+            label: 'Delivery',
+            ...compute('sale.order', 'deliveryState', ['state', 'lines.quantity', 'lines.qtyDelivered', 'lines.product.kind'], (orders) => {
+                for (const o of orders) {
+                    const goods = [...o.lines].filter((l) => l.product.kind === 'goods');
+                    if (goods.length === 0 || (o.state !== 'sale' && o.state !== 'done')) {
+                        o.deliveryState = 'nothing';
+                        continue;
+                    }
+                    const done = goods.every((l) => (l.qtyDelivered ?? zero).gte(l.quantity));
+                    const some = goods.some((l) => (l.qtyDelivered ?? zero).gt(0));
+                    o.deliveryState = done ? 'delivered' : some ? 'partial' : 'to_deliver';
+                }
+            }),
+        }),
+    },
+});
+/**
+ * Makes and confirms the delivery of a confirmed order's goods lines, once (an order with a delivery that is not
+ * cancelled gets no other). Runs in an audited superuser scope: the salesperson who confirmed needs no Stockroom
+ * rights for the warehouse to get its delivery. Returns the delivery, or null when there is nothing to deliver.
+ */
+export async function createDeliveryFor(env, orderId) {
+    return env.asSuperuser({ reason: 'delivery for a confirmed sales order' }, async (su) => {
+        const [order] = await su
+            .model('sale.order')
+            .browse([orm.asId(orderId, 'sale.order')])
+            .load({
+            lines: { product: true, uom: true },
+            partner: true,
+            company: true,
+            deliveries: true,
+        });
+        if (order === undefined || (order.state !== 'sale' && order.state !== 'done'))
+            return null;
+        if ([...order.deliveries].some((d) => d.state !== 'cancel'))
+            return null;
+        const goods = order.lines.filter((l) => l.product.kind === 'goods');
+        if (goods.length === 0)
+            return null;
+        const places = await defaultLocations(su, 'delivery', null, order.company.id);
+        if (places.source === null || places.destination === null)
+            throw new orm.ValidationError('sale.order', ['state'], `The company of ${order.name} has no warehouse to deliver from.`, 'Add a warehouse in Stockroom › Configuration › Warehouses.');
+        const made = await su.model('stock.picking').create([
+            {
+                kind: 'delivery',
+                partner: order.partner.id,
+                company: order.company.id,
+                warehouse: places.warehouse,
+                source: places.source,
+                destination: places.destination,
+                origin: order.name,
+                saleOrder: order.id,
+                moves: {
+                    create: goods.map((l) => ({
+                        product: l.product.id,
+                        name: l.name,
+                        quantity: l.quantity,
+                        uom: l.uom?.id ?? null,
+                        saleLine: l.id,
+                    })),
+                },
+            },
+        ]);
+        await made.confirm();
+        return made.ids[0] ?? null;
+    });
+}
+export const saleStockShutro = defineModule({
+    name: 'sale_stock',
+    version: '0.1.0',
+    depends: [salesShutro, stockShutro, productShutro],
+    groups: [
+        orm.defineGroup({
+            code: 'sale_stock.user',
+            label: 'Sales with deliveries',
+            implies: ['sales.user', 'stock.user'],
+        }),
+    ],
+    models: [],
+    extensions: [PickingSale, MoveSale, LineDelivered, OrderDeliveries],
+});

package/dist/sales/.kosh/bindings.js

@@ -1,4 +1,4 @@
-// GENERATED by `pnpm generate:models` (Shutro’s generator). Do not edit. definitions-hash: 680b65ef8ba5f90d
+// GENERATED by `pnpm generate:models` (Shutro’s generator). Do not edit. definitions-hash: 7a0589ddfebd3ce9
 // Bindings of module `sales`: import the definition API from here to get types scoped to what it can see.
 export { defineModel, defineModule, extendModel, f, replace } from '../../server/orm.js';
 import { definitions } from '../../server/orm.js';

package/dist/sales/.kosh/schema.d.ts

@@ -1,4 +1,4 @@
-// GENERATED by `pnpm generate:models` (Shutro’s generator). Do not edit. definitions-hash: 680b65ef8ba5f90d
+// GENERATED by `pnpm generate:models` (Shutro’s generator). Do not edit. definitions-hash: 7a0589ddfebd3ce9
 // Schema view of module `sales` (RFC 0002 §7.7): the models it owns or depends on, with the extensions it can see.
 import type { F } from '../../server/orm.js';
 
@@ -14,6 +14,7 @@ export interface SchemaView {
   readonly 'auth.user_group': AuthUserGroup;
   readonly 'kosh.image': KoshImage;
   readonly 'kosh.saved_view': KoshSavedView;
+  readonly 'kosh.setting': KoshSetting;
   readonly 'mail.activity': MailActivity;
   readonly 'mail.activity.type': MailActivityType;
   readonly 'mail.channel': MailChannel;
@@ -30,6 +31,7 @@ export interface SchemaView {
   readonly 'res.company': ResCompany;
   readonly 'res.currency': ResCurrency;
   readonly 'res.partner': ResPartner;
+  readonly 'res.partner.tag': ResPartnerTag;
   readonly 'res.users': ResUsers;
   readonly 'sale.order': SaleOrder;
   readonly 'sale.order.line': SaleOrderLine;
@@ -281,6 +283,26 @@ export interface KoshSavedView {
 export interface KoshSavedViewMethods extends F.Methods<typeof import('../../server/index.js').baseShutro, 'kosh.saved_view'> {
 }
 
+/** `kosh.setting` (owner: base). */
+export interface KoshSetting {
+  readonly name: 'kosh.setting';
+  readonly fields: {
+    readonly id: F.Id<'kosh.setting'>;
+    readonly createdAt: F.Datetime<{ readonly required: true; readonly readonly: true }>;
+    readonly updatedAt: F.Datetime<{ readonly required: true; readonly readonly: true }>;
+    readonly createdBy: F.Many2one<'res.users', { readonly readonly: true }>;
+    readonly updatedBy: F.Many2one<'res.users', { readonly readonly: true }>;
+    readonly displayName: F.Char<{ readonly required: true; readonly readonly: true; readonly compute: true }>;
+    readonly key: F.Char<{ readonly required: true }>;
+    readonly value: F.Json;
+  };
+  readonly methods: KoshSettingMethods;
+}
+
+/** Methods of `kosh.setting`: declared ones and transitions. */
+export interface KoshSettingMethods extends F.Methods<typeof import('../../server/index.js').baseShutro, 'kosh.setting'> {
+}
+
 /** `mail.activity` (owner: messaging). */
 export interface MailActivity {
   readonly name: 'mail.activity';
@@ -595,6 +617,7 @@ export interface ProductProduct {
     readonly category: F.Many2one<'product.category'>;
     readonly uom: F.Many2one<'uom.uom'>;
     readonly barcode: F.Char;
+    readonly image: F.Many2one<'storage.attachment'>;
     readonly listPrice: F.Decimal<{ readonly required: true; readonly default: true }>;
     readonly standardPrice: F.Decimal<{ readonly required: true; readonly default: true }>;
     readonly saleOk: F.Bool<{ readonly required: true; readonly default: true }>;
@@ -612,7 +635,7 @@ export interface ProductProduct {
 export interface ProductProductMethods extends F.Methods<typeof import('../../product/index.js').productShutro, 'product.product'> {
 }
 
-/** `res.company` (owner: base). */
+/** `res.company` (owner: base; extended by: contacts, sales). */
 export interface ResCompany {
   readonly name: 'res.company';
   readonly fields: {
@@ -632,12 +655,16 @@ export interface ResCompany {
     readonly email: F.Char;
     readonly phone: F.Char;
     readonly website: F.Char;
+    readonly contactTaxIdRequired: F.Bool<{ readonly required: true; readonly default: true }>; // contacts
+    readonly contactUniqueEmail: F.Bool<{ readonly required: true; readonly default: true }>; // contacts
+    readonly saleValidityDays: F.Integer<{ readonly default: true }>; // sales
+    readonly saleTerms: F.Text; // sales
   };
   readonly methods: ResCompanyMethods;
 }
 
 /** Methods of `res.company`: declared ones and transitions. */
-export interface ResCompanyMethods extends F.Methods<typeof import('../../server/index.js').baseShutro, 'res.company'> {
+export interface ResCompanyMethods extends F.Methods<typeof import('../../server/index.js').baseShutro, 'res.company'>, F.Methods<typeof import('../../contacts/index.js').contactsShutro, 'res.company'>, F.Methods<typeof import('../module.js').salesShutro, 'res.company'> {
 }
 
 /** `res.currency` (owner: base). */
@@ -674,6 +701,10 @@ export interface ResPartner {
     readonly active: F.Bool<{ readonly required: true; readonly default: true }>;
     readonly company: F.Many2one<'res.company', { readonly default: true }>;
     readonly name: F.Char<{ readonly required: true }>;
+    readonly image: F.Many2one<'storage.attachment'>;
+    readonly tags: F.Many2many<'res.partner.tag', { readonly required: true }>;
+    readonly latitude: F.Decimal;
+    readonly longitude: F.Decimal;
     readonly isCompany: F.Bool<{ readonly required: true; readonly default: true }>;
     readonly parent: F.Many2one<'res.partner'>;
     readonly contacts: F.One2many<'res.partner', { readonly required: true }>;
@@ -699,6 +730,25 @@ export interface ResPartner {
 export interface ResPartnerMethods extends F.Methods<typeof import('../../contacts/index.js').contactsShutro, 'res.partner'> {
 }
 
+/** `res.partner.tag` (owner: contacts). */
+export interface ResPartnerTag {
+  readonly name: 'res.partner.tag';
+  readonly fields: {
+    readonly id: F.Id<'res.partner.tag'>;
+    readonly createdAt: F.Datetime<{ readonly required: true; readonly readonly: true }>;
+    readonly updatedAt: F.Datetime<{ readonly required: true; readonly readonly: true }>;
+    readonly createdBy: F.Many2one<'res.users', { readonly readonly: true }>;
+    readonly updatedBy: F.Many2one<'res.users', { readonly readonly: true }>;
+    readonly displayName: F.Char<{ readonly required: true; readonly readonly: true; readonly compute: true }>;
+    readonly name: F.Char<{ readonly required: true }>;
+  };
+  readonly methods: ResPartnerTagMethods;
+}
+
+/** Methods of `res.partner.tag`: declared ones and transitions. */
+export interface ResPartnerTagMethods extends F.Methods<typeof import('../../contacts/index.js').contactsShutro, 'res.partner.tag'> {
+}
+
 /** `res.users` (owner: base). */
 export interface ResUsers {
   readonly name: 'res.users';
@@ -750,6 +800,8 @@ export interface SaleOrder {
     readonly amountUntaxed: F.Monetary<'currency', { readonly readonly: true; readonly compute: true; readonly store: true }>;
     readonly amountTax: F.Monetary<'currency', { readonly readonly: true; readonly compute: true; readonly store: true }>;
     readonly amountTotal: F.Monetary<'currency', { readonly readonly: true; readonly compute: true; readonly store: true }>;
+    readonly margin: F.Monetary<'currency', { readonly readonly: true; readonly compute: true; readonly store: true }>;
+    readonly marginPercent: F.Decimal<{ readonly readonly: true; readonly compute: true; readonly store: true }>;
     readonly state: F.State<'draft' | 'sent' | 'sale' | 'done' | 'cancel', { readonly required: true; readonly readonly: true; readonly default: true }>;
   };
   readonly methods: SaleOrderMethods;
@@ -786,6 +838,7 @@ export interface SaleOrderLine {
     readonly tax: F.Many2one<'account.tax', { readonly readonly: true }>;
     readonly currency: F.Many2one<'res.currency', { readonly readonly: true; readonly compute: true; readonly store: true }>;
     readonly subtotal: F.Monetary<'currency', { readonly readonly: true; readonly compute: true; readonly store: true }>;
+    readonly margin: F.Monetary<'currency', { readonly readonly: true; readonly compute: true; readonly store: true }>;
     readonly taxAmount: F.Monetary<'currency', { readonly readonly: true; readonly compute: true; readonly store: true }>;
   };
   readonly methods: SaleOrderLineMethods;
@@ -812,6 +865,8 @@ export interface StorageAttachment {
     readonly key: F.Char<{ readonly required: true }>;
     readonly resModel: F.Char<{ readonly required: true }>;
     readonly resId: F.Integer<{ readonly required: true }>;
+    readonly variantOf: F.Many2one<'storage.attachment'>;
+    readonly width: F.Integer;
   };
   readonly methods: StorageAttachmentMethods;
 }

package/dist/sales/index.js

@@ -8,7 +8,8 @@ import { contacts } from '../contacts/index.js';
 import { messaging } from '../messaging/index.js';
 import { defineModule } from '../modules-sdk/index.js';
 import { product } from '../product/index.js';
-import { action, form, kanban, list, search } from '../views/index.js';
+import { reporting } from '../reporting/index.js';
+import { action, calendar, form, kanban, list, search, stat } from '../views/index.js';
 import { salesDemo } from './demo.js';
 import { SaleOrder, SaleOrderLine, salesShutro } from './module.js';
 export { SaleOrder, SaleOrderLine, salesShutro } from './module.js';
@@ -16,7 +17,7 @@ export const sales = defineModule({
     shutro: salesShutro,
     kosh: '^0.1.0',
     hooks: { demo: salesDemo },
-    depends: [contacts, product, messaging],
+    depends: [contacts, product, messaging, reporting],
     // What webhooks may subscribe to besides record changes (RFC 0017 §5.3).
     events: [{ topic: 'sale.order.confirmed', model: 'sale.order', label: 'Sales order confirmed' }],
     app: {
@@ -31,6 +32,31 @@ export const sales = defineModule({
         user: { label: 'Salesperson (own orders)', groups: ['sales.user'] },
         manager: { label: 'Manager (all orders)', groups: ['sales.manager'], implies: ['user'] },
     },
+    // Settings › App settings › Sales (RFC 0020): per company, changed by sales managers.
+    settings: {
+        sections: [
+            {
+                key: 'quotations',
+                label: 'Quotations',
+                description: 'How long new quotations stay valid, and the terms they start with.',
+                keywords: 'quote validity expiry terms conditions',
+                scope: 'company',
+                editors: ['sales.manager'],
+                fields: [
+                    {
+                        key: 'saleValidityDays',
+                        min: 0,
+                        max: 365,
+                        help: 'A new quotation is valid until its date plus these days; 0 leaves it open.',
+                    },
+                    {
+                        key: 'saleTerms',
+                        help: 'Filled in on new quotations; each can still be changed.',
+                    },
+                ],
+            },
+        ],
+    },
     // The printed quotation (RFC 0005), installed as a template designers can change; the portal prints it too.
     documents: [
         {
@@ -97,10 +123,157 @@ export const sales = defineModule({
             },
         },
     ],
+    // The Overview page (RFC 0022 §3.2): this month against the last, the year's curve, who buys, what to chase.
+    overview: {
+        cards: [
+            {
+                id: 'sales_month',
+                title: 'Sales this month',
+                kind: 'kpi',
+                model: 'sale.order',
+                measure: 'sum:amountTotal',
+                filter: { state: { in: ['sale', 'done'] } },
+                comparison: { field: 'dateOrder', mode: 'previous' },
+                w: 3,
+            },
+            {
+                id: 'orders_month',
+                title: 'Orders this month',
+                kind: 'kpi',
+                model: 'sale.order',
+                measure: 'count',
+                filter: { state: { in: ['sale', 'done'] } },
+                comparison: { field: 'dateOrder', mode: 'previous' },
+                w: 3,
+            },
+            {
+                id: 'open_quotations',
+                title: 'Open quotations',
+                kind: 'kpi',
+                model: 'sale.order',
+                measure: 'count',
+                filter: { state: { in: ['draft', 'sent'] } },
+                w: 3,
+            },
+            {
+                id: 'average_order',
+                title: 'Average order',
+                kind: 'kpi',
+                model: 'sale.order',
+                measure: 'avg:amountTotal',
+                filter: { state: { in: ['sale', 'done'] } },
+                w: 3,
+            },
+            {
+                id: 'margin_month',
+                title: 'Margin this month',
+                kind: 'kpi',
+                model: 'sale.order',
+                measure: 'sum:margin',
+                filter: { state: { in: ['sale', 'done'] } },
+                comparison: { field: 'dateOrder', mode: 'previous' },
+                w: 3,
+            },
+            {
+                id: 'sales_by_month',
+                title: 'Sales by month',
+                kind: 'chart',
+                model: 'sale.order',
+                measure: 'sum:amountTotal',
+                groupBy: 'dateOrder:month',
+                filter: { state: { in: ['sale', 'done'] } },
+                chart: 'bar',
+                w: 6,
+            },
+            {
+                id: 'top_customers',
+                title: 'Top customers',
+                kind: 'pivot',
+                model: 'sale.order',
+                measure: 'sum:amountTotal',
+                groupBy: 'partner',
+                filter: { state: { in: ['sale', 'done'] } },
+                w: 6,
+            },
+            {
+                id: 'by_salesperson',
+                title: 'By salesperson',
+                kind: 'chart',
+                model: 'sale.order',
+                measure: 'sum:amountTotal',
+                groupBy: 'user',
+                filter: { state: { in: ['sale', 'done'] } },
+                chart: 'pie',
+                w: 6,
+            },
+            {
+                id: 'quotations_to_chase',
+                title: 'Biggest open quotations',
+                kind: 'list',
+                model: 'sale.order',
+                measure: 'sum:amountTotal',
+                filter: { state: { in: ['draft', 'sent'] } },
+                w: 6,
+            },
+        ],
+    },
+    viewExtensions: [
+        {
+            view: 'product.product.form',
+            operations: [
+                {
+                    append: 'related',
+                    nodes: [
+                        stat({
+                            id: 'product_sold',
+                            label: 'Sold',
+                            model: SaleOrderLine,
+                            where: { product: { $record: 'id' }, 'order.state': { in: ['sale', 'done'] } },
+                            measure: { sum: 'quantity' },
+                        }),
+                        stat({
+                            id: 'product_revenue',
+                            label: 'Sales',
+                            model: SaleOrderLine,
+                            where: { product: { $record: 'id' }, 'order.state': { in: ['sale', 'done'] } },
+                            measure: { sum: 'subtotal' },
+                            tone: 'success',
+                        }),
+                    ],
+                },
+            ],
+        },
+        {
+            view: 'res.partner.form',
+            operations: [
+                {
+                    append: 'related',
+                    nodes: [
+                        stat({
+                            id: 'sale_orders',
+                            label: 'Sales orders',
+                            model: SaleOrder,
+                            where: { partner: { $record: 'id' }, state: { in: ['sale', 'done'] } },
+                            action: 'sales.action_orders',
+                        }),
+                        stat({
+                            id: 'sale_revenue',
+                            label: 'Sales',
+                            model: SaleOrder,
+                            where: { partner: { $record: 'id' }, state: { in: ['sale', 'done'] } },
+                            measure: { sum: 'amountTotal' },
+                            action: 'sales.action_orders',
+                            tone: 'success',
+                        }),
+                    ],
+                },
+            ],
+        },
+    ],
     actions: {
         'sales.action_quotations': action(SaleOrder, {
             label: 'Quotations',
-            views: ['list', 'kanban', 'form'],
+            views: ['list', 'kanban', 'calendar', 'form'],
             defaultFilters: ['quotations'],
         }),
         'sales.action_orders': action(SaleOrder, {
@@ -147,9 +320,12 @@ export const sales = defineModule({
                 'partner',
                 'user',
                 { field: 'amountTotal', sum: true },
+                { field: 'margin', sum: true },
+                { field: 'marginPercent', widget: 'percentage' },
                 { field: 'state', widget: 'badge' },
             ],
             defaultOrder: ['dateOrder desc'],
+            decorations: { success: { state: 'done' }, neutral: { state: 'cancel' } },
         }),
         'sale.order.kanban': kanban(SaleOrder, {
             groupBy: 'state',
@@ -168,6 +344,8 @@ export const sales = defineModule({
                 ],
             },
             sheet: [
+                // Invoices, deliveries, tasks: the bridges append their tiles (RFC 0022 §3.1).
+                k.stats('related', []),
                 k.group('customer', ['partner', 'clientReference', 'currency']),
                 k.group('dates', ['name', 'dateOrder', 'validityDate', 'user']),
                 k.lines('lines', [
@@ -180,12 +358,21 @@ export const sales = defineModule({
                     'taxes',
                     'subtotal',
                 ], { readonlyWhen: { state: { in: ['done', 'cancel'] } } }),
-                k.group('totals', ['amountUntaxed', 'amountTax', 'amountTotal'], { label: 'Totals' }),
+                k.group('totals', ['amountUntaxed', 'amountTax', 'amountTotal', 'margin', 'marginPercent'], {
+                    label: 'Totals',
+                }),
                 k.group('terms', ['note'], { columns: 1 }),
             ],
             readonlyWhen: { state: { in: ['done', 'cancel'] } },
             chatter: true,
         })),
+        // Quotations by the day they expire: what to chase this week.
+        'sale.order.calendar': calendar(SaleOrder, {
+            dateStart: 'validityDate',
+            title: 'name',
+            color: 'state',
+            mode: 'month',
+        }),
         'sale.order.line.list': list(SaleOrderLine, {
             columns: ['order', 'product', 'quantity', 'priceUnit', 'subtotal'],
         }),