shutro-erp 0.3.3 → 0.3.5

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'],
         }),