shutro-erp 0.3.4 → 0.3.6

package/dist/pos_stock/module.js

@@ -0,0 +1,115 @@
+/**
+ * The data layer of the Counter ↔ Stockroom bridge (RFC 0021, Counter step 2): a closed session's sold goods leave
+ * the shop's warehouse as **one delivery per session**, done at once when the stock is there; when it is short the
+ * delivery stays confirmed for a manager to finish from Stockroom. Returns (negative quantities) come back in it.
+ */
+import { posShutro } from '../pos/index.js';
+import { orm } from '../server/orm.js';
+import { defaultLocations, stockShutro } from '../stock/index.js';
+import { defineModule, extendModel, f } from './.kosh/bindings.js';
+const ZERO = orm.toDecimal(0);
+export const ShopWarehouse = extendModel('pos.shop', {
+    fields: {
+        /** The warehouse the shop sells from; the company's first one otherwise. */
+        warehouse: f.many2one('stock.warehouse', { ondelete: 'restrict' }),
+    },
+});
+export const SessionDelivery = extendModel('pos.session', {
+    fields: {
+        delivery: f.many2one('stock.picking', { ondelete: 'set null', label: 'Stock delivery' }),
+    },
+    overrides: {
+        closed: async function (next) {
+            await next();
+            const sessions = this;
+            const env = sessions.env;
+            await env.asSuperuser({ reason: 'counter session to stock' }, async (su) => {
+                for (const s of await su
+                    .model('pos.session')
+                    .browse(sessions.ids)
+                    .load({ shop: true, company: true, orders: { lines: { product: { uom: true } } } })) {
+                    if (s.delivery !== null)
+                        continue;
+                    // What left the shelves: the paid sales' goods, by product (returns take away).
+                    const sold = new Map();
+                    for (const o of s.orders) {
+                        if (o.state !== 'paid')
+                            continue;
+                        for (const l of o.lines) {
+                            if (l.product.kind !== 'goods')
+                                continue;
+                            const slot = sold.get(l.product.id) ?? {
+                                product: l.product.id,
+                                name: l.product.name,
+                                uom: l.product.uom?.id ?? null,
+                                quantity: ZERO,
+                            };
+                            slot.quantity = slot.quantity.plus(l.quantity);
+                            sold.set(l.product.id, slot);
+                        }
+                    }
+                    const moves = [...sold.values()].filter((m) => m.quantity.gt(0));
+                    if (moves.length === 0)
+                        continue;
+                    const shopWarehouse = s.shop.warehouse;
+                    const places = await defaultLocations(su, 'delivery', shopWarehouse?.id ?? null, s.company.id);
+                    if (places.source === null || places.destination === null)
+                        throw new orm.ValidationError('pos.session', ['state'], `The company of ${s.name} has no warehouse to sell from.`, 'Add a warehouse in Stockroom › Configuration › Warehouses.');
+                    const made = await su.model('stock.picking').create([
+                        {
+                            kind: 'delivery',
+                            company: s.company.id,
+                            warehouse: places.warehouse,
+                            source: places.source,
+                            destination: places.destination,
+                            origin: s.name,
+                            moves: {
+                                create: moves.map((m) => ({
+                                    product: m.product,
+                                    name: m.name,
+                                    quantity: m.quantity,
+                                    quantityDone: m.quantity,
+                                    uom: m.uom,
+                                })),
+                            },
+                        },
+                    ]);
+                    await su.flush();
+                    await made.confirm();
+                    await su.flush();
+                    await made.reserve();
+                    await su.flush();
+                    // Done at once when the stock is there; else it waits for a manager in Stockroom.
+                    try {
+                        await made.validate();
+                        await su.flush();
+                    }
+                    catch (error) {
+                        const name = error.name;
+                        // Short stock: the guard of validate refuses; the delivery stays confirmed for Stockroom.
+                        if (!(error instanceof orm.ValidationError || name === 'TransitionGuardError'))
+                            throw error;
+                    }
+                    await su
+                        .model('pos.session')
+                        .browse([s.id])
+                        .write({ delivery: made.ids[0] ?? null });
+                }
+            });
+        },
+    },
+});
+export const posStockShutro = defineModule({
+    name: 'pos_stock',
+    version: '0.1.0',
+    depends: [posShutro, stockShutro],
+    groups: [
+        orm.defineGroup({
+            code: 'pos_stock.user',
+            label: 'Counter sales from stock',
+            implies: ['pos.cashier'],
+        }),
+    ],
+    models: [],
+    extensions: [ShopWarehouse, SessionDelivery],
+});

package/dist/product/.kosh/bindings.js

@@ -1,4 +1,4 @@
-// GENERATED by `pnpm generate:models` (Shutro’s generator). Do not edit. definitions-hash: cc95697afc48b244
+// GENERATED by `pnpm generate:models` (Shutro’s generator). Do not edit. definitions-hash: cf2dd228cb44bc49
 // Bindings of module `product`: 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/product/.kosh/schema.d.ts

@@ -1,4 +1,4 @@
-// GENERATED by `pnpm generate:models` (Shutro’s generator). Do not edit. definitions-hash: cc95697afc48b244
+// GENERATED by `pnpm generate:models` (Shutro’s generator). Do not edit. definitions-hash: cf2dd228cb44bc49
 // Schema view of module `product` (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 'oauth.app': OauthApp;
   readonly 'oauth.code': OauthCode;
   readonly 'oauth.grant': OauthGrant;
@@ -23,6 +24,7 @@ export interface SchemaView {
   readonly 'res.company': ResCompany;
   readonly 'res.currency': ResCurrency;
   readonly 'res.users': ResUsers;
+  readonly 'storage.attachment': StorageAttachment;
   readonly 'uom.uom': UomUom;
 }
 
@@ -270,6 +272,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'> {
+}
+
 /** `oauth.app` (owner: base). */
 export interface OauthApp {
   readonly name: 'oauth.app';
@@ -379,6 +401,7 @@ export interface ProductCategory {
     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 active: F.Bool<{ readonly required: true; readonly default: true }>;
     readonly name: F.Char<{ readonly required: true; readonly translate: true }>;
     readonly parent: F.Many2one<'product.category'>;
   };
@@ -406,6 +429,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 }>;
@@ -500,6 +524,33 @@ export interface ResUsers {
 export interface ResUsersMethods extends F.Methods<typeof import('../../server/index.js').baseShutro, 'res.users'> {
 }
 
+/** `storage.attachment` (owner: storage). */
+export interface StorageAttachment {
+  readonly name: 'storage.attachment';
+  readonly fields: {
+    readonly id: F.Id<'storage.attachment'>;
+    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 mime: F.Char<{ readonly required: true }>;
+    readonly size: F.Integer<{ readonly required: true }>;
+    readonly sha256: F.Char<{ readonly required: true }>;
+    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;
+}
+
+/** Methods of `storage.attachment`: declared ones and transitions. */
+export interface StorageAttachmentMethods extends F.Methods<typeof import('../../storage/index.js').storageShutro, 'storage.attachment'> {
+}
+
 /** `uom.uom` (owner: product). */
 export interface UomUom {
   readonly name: 'uom.uom';

package/dist/product/index.js

@@ -4,7 +4,9 @@
  * categories, units of measure and taxes. Sales and Purchase sell and buy them.
  */
 import { defineModule } from '../modules-sdk/index.js';
+import { reporting } from '../reporting/index.js';
 import { base } from '../server/index.js';
+import { storage } from '../storage/index.js';
 import { action, form, kanban, list, search } from '../views/index.js';
 import { productDemo } from './demo.js';
 import { AccountTax, ProductCategory, ProductProduct, productShutro, UomUom } from './module.js';
@@ -14,7 +16,7 @@ export const product = defineModule({
     shutro: productShutro,
     kosh: '^0.1.0',
     hooks: { demo: productDemo },
-    depends: [base],
+    depends: [base, storage, reporting],
     app: {
         code: 'product',
         label: 'Products',
@@ -27,6 +29,63 @@ export const product = defineModule({
         user: { label: 'User', groups: ['product.user'] },
         manager: { label: 'Manager', groups: ['product.manager'], implies: ['user'] },
     },
+    // The Overview (RFC 0022 step 2): the catalogue at a glance.
+    overview: {
+        cards: [
+            {
+                id: 'products_all',
+                title: 'Products',
+                kind: 'kpi',
+                model: 'product.product',
+                measure: 'count',
+                w: 3,
+            },
+            {
+                id: 'goods',
+                title: 'Goods',
+                kind: 'kpi',
+                model: 'product.product',
+                measure: 'count',
+                filter: { kind: 'goods' },
+                w: 3,
+            },
+            {
+                id: 'services',
+                title: 'Services',
+                kind: 'kpi',
+                model: 'product.product',
+                measure: 'count',
+                filter: { kind: 'service' },
+                w: 3,
+            },
+            {
+                id: 'average_price',
+                title: 'Average sales price',
+                kind: 'kpi',
+                model: 'product.product',
+                measure: 'avg:listPrice',
+                w: 3,
+            },
+            {
+                id: 'by_category',
+                title: 'By category',
+                kind: 'chart',
+                model: 'product.product',
+                measure: 'count',
+                groupBy: 'category',
+                chart: 'pie',
+                w: 6,
+            },
+            {
+                id: 'priciest',
+                title: 'Highest sales prices',
+                kind: 'list',
+                model: 'product.product',
+                measure: 'sum:listPrice',
+                w: 6,
+            },
+        ],
+    },
     actions: {
         'product.action_products': action(ProductProduct, {
             label: 'Products',
@@ -71,15 +130,33 @@ export const product = defineModule({
     views: {
         'product.product.kanban': kanban(ProductProduct, {
             groupBy: 'kind',
-            card: { title: 'name', subtitle: 'code', footer: ['listPrice', 'uom'] },
+            card: { title: 'name', subtitle: 'code', footer: ['listPrice', 'uom'], image: 'image' },
         }),
         'product.product.list': list(ProductProduct, {
-            columns: ['code', 'name', 'kind', 'category', 'listPrice', 'standardPrice', 'uom'],
+            columns: [
+                { field: 'image', widget: 'avatar' },
+                'code',
+                'name',
+                'kind',
+                'category',
+                'listPrice',
+                'standardPrice',
+                'uom',
+            ],
             defaultOrder: ['name asc'],
         }),
         'product.product.form': form(ProductProduct, (k) => ({
             sheet: [
-                k.group('identity', ['name', 'code', 'kind', 'category', 'barcode']),
+                // Sold, bought, on hand: Sales, Purchase and Stockroom append their tiles (RFC 0022 §3.1).
+                k.stats('related', []),
+                k.group('identity', [
+                    { field: 'image', widget: 'image' },
+                    'name',
+                    'code',
+                    'kind',
+                    'category',
+                    'barcode',
+                ]),
                 k.group('prices', ['listPrice', 'standardPrice', 'uom'], { label: 'Prices' }),
                 k.notebook('more', [
                     k.page('sales', 'Sales & purchase', [
@@ -116,6 +193,19 @@ export const product = defineModule({
         })),
     },
     search: {
+        'uom.uom': search(UomUom, { fields: ['name'], groupBy: ['category'] }),
+        'product.category': search(ProductCategory, {
+            fields: ['name', 'parent.name'],
+            groupBy: ['parent'],
+        }),
+        'account.tax': search(AccountTax, {
+            fields: ['name'],
+            filters: {
+                sale: { label: 'On sales', domain: { use: 'sale' }, group: 'use' },
+                purchase: { label: 'On purchases', domain: { use: 'purchase' }, group: 'use' },
+            },
+            groupBy: ['use', 'amountType'],
+        }),
         'product.product': search(ProductProduct, {
             fields: ['name', 'code', 'barcode'],
             filters: {

package/dist/product/module.d.ts

@@ -167,6 +167,7 @@ export declare const ProductCategory: import("../server/orm.js").Model<"product.
         hasDefault: false;
         sequence: false;
     }>;
+    readonly active: import("../server/orm.js").ActiveField;
     readonly name: import("../server/orm.js").CharField<{
         readonly required: true;
         readonly computed: false;
@@ -543,6 +544,16 @@ export declare const ProductProduct: import("../server/orm.js").Model<"product.p
         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;
@@ -695,6 +706,17 @@ export declare const ProductProduct: import("../server/orm.js").Model<"product.p
         readonly hasDefault: false;
         readonly readonly: false;
     }, string>;
+    /** A picture: an attachment of the product (RFC 0022 §3.3), with its 256 px thumbnail. */
+    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;
+    }>;
     /** The sales price, in the company currency. */
     readonly listPrice: import("../server/orm.js").DecimalField<{
         readonly required: true;
@@ -959,6 +981,7 @@ export declare const productShutro: import("../server/orm.js").Module<readonly [
         hasDefault: false;
         sequence: false;
     }>;
+    readonly active: import("../server/orm.js").ActiveField;
     readonly name: import("../server/orm.js").CharField<{
         readonly required: true;
         readonly computed: false;
@@ -1333,6 +1356,16 @@ export declare const productShutro: import("../server/orm.js").Module<readonly [
         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;
@@ -1485,6 +1518,17 @@ export declare const productShutro: import("../server/orm.js").Module<readonly [
         readonly hasDefault: false;
         readonly readonly: false;
     }, string>;
+    /** A picture: an attachment of the product (RFC 0022 §3.3), with its 256 px thumbnail. */
+    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;
+    }>;
     /** The sales price, in the company currency. */
     readonly listPrice: import("../server/orm.js").DecimalField<{
         readonly required: true;
@@ -1580,4 +1624,4 @@ export declare const productShutro: import("../server/orm.js").Module<readonly [
         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 []>;
+}>>], 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 []>;

package/dist/product/module.js

@@ -5,6 +5,7 @@
  */
 import { baseShutro } from '../server/index.js';
 import { orm } from '../server/orm.js';
+import { storageShutro } from '../storage/index.js';
 import { check, defineModel, defineModule, f, record } from './.kosh/bindings.js';
 const ALL = ['read', 'write', 'create', 'unlink', 'export', 'import'];
 const READ = ['read'];
@@ -36,6 +37,7 @@ export const UomUom = defineModel('uom.uom', {
 });
 export const ProductCategory = defineModel('product.category', {
     label: 'Product category',
+    archivable: true,
     order: ['name asc'],
     access: { 'product.user': READ, 'product.manager': ALL },
     fields: {
@@ -90,6 +92,8 @@ export const ProductProduct = defineModel('product.product', {
         category: f.many2one('product.category'),
         uom: f.many2one('uom.uom', { label: 'Unit of measure' }),
         barcode: f.char({ index: 'unique' }),
+        /** A picture: an attachment of the product (RFC 0022 §3.3), with its 256 px thumbnail. */
+        image: f.many2one('storage.attachment', { ondelete: 'set null', label: 'Picture' }),
         /** The sales price, in the company currency. */
         listPrice: f.decimal({ scale: 2, required: true, default: '0', label: 'Sales price' }),
         /** The cost: the default purchase price. */
@@ -121,7 +125,7 @@ export const ProductProduct = defineModel('product.product', {
 const uom = (id, name, category, ratio, rounding) => record('uom.uom', id, { name, category: category, ratio, rounding }, { noupdate: true });
 export const productShutro = defineModule({
     name: 'product',
-    version: '0.3.0',
+    version: '0.4.0',
     migrations: [
         {
             version: '0.2.0',
@@ -138,9 +142,13 @@ export const productShutro = defineModule({
             },
         },
     ],
-    depends: [baseShutro],
+    depends: [baseShutro, storageShutro],
     groups: [
-        orm.defineGroup({ code: 'product.user', label: 'Products user', implies: ['base.user'] }),
+        orm.defineGroup({
+            code: 'product.user',
+            label: 'Products user',
+            implies: ['base.user', 'storage.user'],
+        }),
         orm.defineGroup({
             code: 'product.manager',
             label: 'Products manager',

package/dist/project/.kosh/bindings.js

@@ -1,4 +1,4 @@
-// GENERATED by `pnpm generate:models` (Shutro’s generator). Do not edit. definitions-hash: 695505b1c9a0d796
+// GENERATED by `pnpm generate:models` (Shutro’s generator). Do not edit. definitions-hash: 573a25fb98026e3a
 // Bindings of module `project`: 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';