shutro-erp 0.3.5 → 0.3.7

package/dist/stock_account/module.js

@@ -10,6 +10,7 @@ import { productShutro } from '../product/index.js';
 import { orm } from '../server/orm.js';
 import { stockShutro } from '../stock/index.js';
 import { defineModel, defineModule, extendModel, f, method, } from './.kosh/bindings.js';
+import { ProductLanded, StockLandedCost, StockLandedCostLine } from './landed.js';
 const zero = orm.toDecimal(0);
 const money = (d) => d.toDecimalPlaces(2);
 /** The accounts this bridge adds to a chart (by code), when the chart has none with that code. */
@@ -150,6 +151,14 @@ export async function stockAccountsOf(env, company) {
  * at `incomingUnitCost` (the product's cost; a bridge may know better, a purchase order's price); outgoing stock at
  * the average cost or, FIFO, from the oldest incoming layers still in stock.
  */
+/** The unit cost each original move was valued at (its layer's), by move. */
+async function originalCosts(env, moves) {
+    const ids = moves.filter((m) => m !== null);
+    if (ids.length === 0)
+        return new Map();
+    const layers = await (await env.model('stock.valuation.layer').search({ where: { move: { in: ids } } })).load({ move: true });
+    return new Map(layers.map((l) => [l.move?.id, l.unitCost.abs()]));
+}
 async function valueTransfers(pickings) {
     const env = pickings.env;
     const loaded = await pickings.load({
@@ -157,7 +166,7 @@ async function valueTransfers(pickings) {
         destination: true,
         company: true,
         partner: true,
-        moves: { product: { category: true } },
+        moves: { product: { category: true }, returnOf: true },
     });
     for (const p of loaded) {
         const incoming = p.source.usage !== 'internal' && p.destination.usage === 'internal';
@@ -213,7 +222,29 @@ async function valueTransfers(pickings) {
             }
             else {
                 let left = quantity;
-                if (fifo) {
+                // Goods going back to the vendor leave at what they came in at (RFC 0030 §3.2), off their own layer.
+                const back = m.returnOf === null
+                    ? null
+                    : await (await env.model('stock.valuation.layer').search({
+                        where: { move: m.returnOf.id, quantity: { gt: '0' } },
+                        limit: 1,
+                    })).load(['unitCost', 'remainingQty', 'remainingValue']);
+                const [layer] = back === null ? [] : [...back];
+                if (layer !== undefined) {
+                    value = money(quantity.times(layer.unitCost));
+                    left = zero;
+                    if (fifo && layer.remainingQty.gt(0)) {
+                        const take = quantity.lt(layer.remainingQty) ? quantity : layer.remainingQty;
+                        const part = take.eq(layer.remainingQty)
+                            ? layer.remainingValue
+                            : money(layer.remainingValue.times(take).div(layer.remainingQty));
+                        await layer.write({
+                            remainingQty: layer.remainingQty.minus(take),
+                            remainingValue: layer.remainingValue.minus(part),
+                        });
+                    }
+                }
+                if (fifo && left.gt(0)) {
                     const open = await (await env.model('stock.valuation.layer').search({
                         where: { company: p.company.id, product: product.id, remainingQty: { gt: '0' } },
                         order: ['id asc'],
@@ -294,6 +325,28 @@ async function valueTransfers(pickings) {
     }
 }
 export const MoveCost = extendModel('stock.move', {
+    overrides: {
+        // The ledger's values: each line's valuation layers, when this person may read the valuation.
+        moveValues: async function (next) {
+            const out = await next();
+            const moves = this;
+            if (!moves.env.access.can('stock.valuation.layer', 'read'))
+                return out;
+            const layers = await (await moves.env
+                .model('stock.valuation.layer')
+                .search({ where: { move: { in: [...moves.ids] } }, limit: 50000 })).load({ move: true });
+            for (const l of layers) {
+                const id = l.move?.id;
+                if (id === undefined)
+                    continue;
+                out.set(id, orm
+                    .toDecimal(out.get(id) ?? '0')
+                    .plus(l.value)
+                    .toString());
+            }
+            return out;
+        },
+    },
     methods: {
         /**
          * What each of these lines' stock costs when it comes in, by line, in the product's unit, as a decimal string:
@@ -301,8 +354,13 @@ export const MoveCost = extendModel('stock.move', {
          */
         incomingUnitCost: method('stock.move', async function () {
             const out = new Map();
-            for (const m of await this.load({ product: true }))
-                out.set(m.id, m.product.standardPrice.toString());
+            const moves = await this.load({ product: true, returnOf: true });
+            // A customer's return comes back at what it went out at (RFC 0030 §3.2).
+            const original = await originalCosts(this.env, moves.map((m) => m.returnOf?.id ?? null));
+            for (const m of moves) {
+                const cost = m.returnOf === null ? undefined : original.get(m.returnOf.id);
+                out.set(m.id, (cost ?? m.product.standardPrice).toString());
+            }
             return out;
         }),
     },
@@ -313,12 +371,82 @@ export const PickingValued = extendModel('stock.picking', {
         validated: async function (next) {
             await next();
             await valueTransfers(this);
+            await transportBills(this);
         },
     },
 });
+/**
+ * The transport of validated transfers in the books (RFC 0032 §3.3), as drafts an accountant completes (the account)
+ * and posts: the transport vendor's freight bill — the freight with its additions and deductions — and, for a receipt
+ * whose supplier bears a deduction, a vendor refund to the supplier. Each is made once, when the transfer is validated.
+ */
+async function transportBills(pickings) {
+    const env = pickings.env;
+    for (const p of await pickings.load({
+        charges: true,
+        partner: true,
+        transporter: true,
+        company: true,
+    })) {
+        const journal = (await env.model('account.journal').search({
+            where: { company: p.company.id, type: 'purchase' },
+            limit: 1,
+        })).ids[0];
+        if (journal === undefined)
+            continue; // no chart yet
+        const [company] = await env.model('res.company').browse([p.company.id]).load({});
+        const draft = async (kind, partner, lines) => env.model('account.move').create([
+            {
+                kind,
+                journal,
+                partner,
+                company: p.company.id,
+                currency: company?.currency.id,
+                date: env.today(),
+                invoiceOrigin: p.name,
+                ref: p.origin ? `${p.name} (${p.origin})` : p.name,
+                lines: {
+                    create: lines.map((l) => ({
+                        lineKind: 'product',
+                        name: l.name,
+                        quantity: '1',
+                        priceUnit: l.amount,
+                        debit: '0',
+                        credit: '0',
+                    })),
+                },
+            },
+        ]);
+        if (p.transporter && p.freightAmount?.gt(0)) {
+            const lines = [{ name: `Freight ${p.name}`, amount: p.freightAmount }];
+            for (const c of p.charges)
+                if (c.amount.gt(0))
+                    lines.push({
+                        name: `${c.name} (${p.name})`,
+                        amount: c.kind === 'deduction' ? c.amount.negated() : c.amount,
+                    });
+            await draft('in_invoice', p.transporter.id, lines);
+        }
+        if (p.kind === 'receipt' &&
+            p.deductFromSupplier &&
+            p.partner !== null &&
+            p.supplierDeduction?.gt(0))
+            await draft('in_refund', p.partner.id, [
+                { name: `Deduction on receipt ${p.name}`, amount: p.supplierDeduction },
+            ]);
+    }
+}
 export const stockAccountShutro = defineModule({
     name: 'stock_account',
-    version: '0.1.0',
+    version: '0.2.0',
+    sequences: [
+        orm.defineSequence({
+            code: 'stock.landed.cost',
+            prefix: 'LC/{year}/',
+            padding: 5,
+            reset: 'yearly',
+        }),
+    ],
     depends: [stockShutro, accountingShutro, productShutro],
     groups: [
         orm.defineGroup({
@@ -327,8 +455,9 @@ export const stockAccountShutro = defineModule({
             implies: ['stock.user'],
         }),
     ],
-    models: [StockValuationLayer],
+    models: [StockValuationLayer, StockLandedCost, StockLandedCostLine],
     extensions: [
+        ProductLanded,
         CategoryValuation,
         ProductValuation,
         CompanyStockAccounts,

package/dist/stock_account/web/LandedPreview.d.ts

@@ -0,0 +1,7 @@
+/**
+ * On a draft landed cost (RFC 0030 §3.3): each receipt line's share of the costs, what goes to the stock on hand and
+ * what to the cost of goods sold, before posting. The server splits; this shows it, or why it cannot yet.
+ */
+import { type NodeComponentProps } from '../../ui/index.js';
+import { type ReactElement } from 'react';
+export declare function LandedPreview({ record, api, version }: NodeComponentProps): ReactElement | null;

package/dist/stock_account/web/LandedPreview.js

@@ -0,0 +1,23 @@
+import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
+/**
+ * On a draft landed cost (RFC 0030 §3.3): each receipt line's share of the costs, what goes to the stock on hand and
+ * what to the cost of goods sold, before posting. The server splits; this shows it, or why it cannot yet.
+ */
+import { ApiError } from '../../ui/index.js';
+import { useQuery } from '@tanstack/react-query';
+import { useId } from 'react';
+import { useTranslation } from 'react-i18next';
+export function LandedPreview({ record, api, version }) {
+    const { t } = useTranslation('stock_account');
+    const id = useId();
+    const draft = record !== null && record['state'] === 'draft';
+    const preview = useQuery({
+        queryKey: ['stock_account', 'landed-preview', record?.id, version],
+        queryFn: () => api.call('GET', `/api/v1/stockroom/landed-costs/${record?.id}/preview`),
+        enabled: draft,
+        retry: false,
+    });
+    if (!draft)
+        return null;
+    return (_jsxs("section", { "aria-labelledby": `${id}-title`, className: "grid gap-2 rounded-md border p-3 text-sm", children: [_jsx("h3", { id: `${id}-title`, className: "font-medium", children: t('landed.title') }), preview.error !== null ? (_jsx("p", { className: "text-muted-foreground", children: preview.error instanceof ApiError ? preview.error.message : String(preview.error) })) : (_jsx("div", { className: "overflow-x-auto", children: _jsxs("table", { className: "w-full", children: [_jsx("thead", { className: "text-muted-foreground", children: _jsxs("tr", { children: [_jsx("th", { className: "py-1 text-start font-medium", children: t('landed.receipt') }), _jsx("th", { className: "py-1 text-start font-medium", children: t('landed.product') }), _jsx("th", { className: "py-1 text-end font-medium", children: t('landed.quantity') }), _jsx("th", { className: "py-1 text-end font-medium", children: t('landed.value') }), _jsx("th", { className: "py-1 text-end font-medium", children: t('landed.added') }), _jsx("th", { className: "py-1 text-end font-medium", children: t('landed.toStock') }), _jsx("th", { className: "py-1 text-end font-medium", children: t('landed.toCogs') })] }) }), _jsx("tbody", { children: (preview.data?.lines ?? []).map((l) => (_jsxs("tr", { className: "border-t", children: [_jsx("td", { className: "py-1", children: l.picking }), _jsx("td", { className: "py-1", children: l.product }), _jsx("td", { className: "py-1 text-end tabular-nums", children: l.quantity }), _jsx("td", { className: "py-1 text-end tabular-nums", children: l.value }), _jsx("td", { className: "py-1 text-end tabular-nums font-medium", children: l.added }), _jsx("td", { className: "py-1 text-end tabular-nums", children: l.toStock }), _jsx("td", { className: "py-1 text-end tabular-nums", children: l.toCogs })] }, l.move))) })] }) }))] }));
+}

package/dist/stock_account/web/index.d.ts

@@ -0,0 +1,11 @@
+/**
+ * @packageDocumentation
+ * The web contribution of `shutro-erp/stock_account`: the landed cost split preview (RFC 0030 §3.3).
+ */
+import { type Registry } from '../../ui/index.js';
+import type { i18n } from 'i18next';
+import { messages } from './messages.js';
+export { LandedPreview } from './LandedPreview.js';
+/** Registers the component (and the messages in `i18n`, when given). */
+export declare function registerStockAccountWeb(registry: Registry, i18n?: i18n): Registry;
+export { messages as stockAccountMessages };

package/dist/stock_account/web/index.js

@@ -0,0 +1,16 @@
+/**
+ * @packageDocumentation
+ * The web contribution of `shutro-erp/stock_account`: the landed cost split preview (RFC 0030 §3.3).
+ */
+import { addMessages } from '../../ui/index.js';
+import { LandedPreview } from './LandedPreview.js';
+import { messages } from './messages.js';
+export { LandedPreview } from './LandedPreview.js';
+/** Registers the component (and the messages in `i18n`, when given). */
+export function registerStockAccountWeb(registry, i18n) {
+    registry.registerComponent('stock_account.LandedPreview', LandedPreview);
+    if (i18n !== undefined)
+        addMessages(i18n, 'stock_account', messages);
+    return registry;
+}
+export { messages as stockAccountMessages };

package/dist/stock_account/web/messages.d.ts

@@ -0,0 +1,2 @@
+/** Messages of the stock valuation components (namespace `stock_account`), in English and Bangla. */
+export declare const messages: Readonly<Record<string, object>>;

package/dist/stock_account/web/messages.js

@@ -0,0 +1,27 @@
+/** Messages of the stock valuation components (namespace `stock_account`), in English and Bangla. */
+export const messages = {
+    en: {
+        landed: {
+            title: 'How the costs are split',
+            receipt: 'Receipt',
+            product: 'Product',
+            quantity: 'Quantity',
+            value: 'Value',
+            added: 'Added',
+            toStock: 'To stock',
+            toCogs: 'To cost of sales',
+        },
+    },
+    bn: {
+        landed: {
+            title: 'খরচ কীভাবে ভাগ হয়',
+            receipt: 'রিসিট',
+            product: 'পণ্য',
+            quantity: 'পরিমাণ',
+            value: 'মূল্য',
+            added: 'যোগ',
+            toStock: 'স্টকে',
+            toCogs: 'বিক্রয় খরচে',
+        },
+    },
+};

package/dist/todo/i18n/bn.d.ts

@@ -0,0 +1,2 @@
+/** Bangla for the module's labels, keyed by their English text (RFC 0023 §3.1; `pnpm i18n:extract`). */
+export declare const bn: Readonly<Record<string, string>>;

package/dist/todo/i18n/bn.js

@@ -0,0 +1,66 @@
+/** Bangla for the module's labels, keyed by their English text (RFC 0023 §3.1; `pnpm i18n:extract`). */
+export const bn = {
+    'About (id)': 'সম্পর্কিত (আইডি)',
+    'About (model)': 'সম্পর্কিত (মডেল)',
+    Active: 'সক্রিয়',
+    Amber: 'অ্যাম্বার',
+    Blue: 'নীল',
+    Checklist: 'চেকলিস্ট',
+    'Checklist › Done': 'চেকলিস্ট › সম্পন্ন',
+    'Checklist › Step': 'চেকলিস্ট › ধাপ',
+    'Checklist done (%)': 'চেকলিস্ট সম্পন্ন (%)',
+    'Checklist item': 'চেকলিস্টের বিষয়',
+    Color: 'রং',
+    'Created At': 'তৈরির সময়',
+    'Created By': 'তৈরি করেছেন',
+    'Display Name': 'প্রদর্শিত নাম',
+    Done: 'সম্পন্ন',
+    'Done this month': 'এ মাসে সম্পন্ন',
+    Due: 'নির্ধারিত তারিখ',
+    Focus: 'ফোকাস',
+    'Focus user': 'ফোকাস ব্যবহারকারী',
+    For: 'যার জন্য',
+    Green: 'সবুজ',
+    High: 'উচ্চ',
+    'How pressing it is: normal, high or urgent.': 'এটি কতটা জরুরি: সাধারণ, উচ্চ বা অতি জরুরি।',
+    ID: 'আইডি',
+    List: 'তালিকা',
+    Lists: 'তালিকা',
+    Mine: 'আমার',
+    Name: 'নাম',
+    Normal: 'সাধারণ',
+    Notes: 'নোট',
+    'Open by list': 'তালিকা অনুযায়ী খোলা',
+    'Open by priority': 'অগ্রাধিকার অনুযায়ী খোলা',
+    'Open to-dos': 'খোলা করণীয়',
+    'Open until you mark it done; a done to-do can be reopened.': 'সম্পন্ন চিহ্নিত না করা পর্যন্ত খোলা থাকে; সম্পন্ন করণীয় আবার খোলা যায়।',
+    Overview: 'সারসংক্ষেপ',
+    Owner: 'মালিক',
+    'Page {{page}} of {{pages}}': 'পৃষ্ঠা {{page}} / {{pages}}',
+    Priority: 'অগ্রাধিকার',
+    Productivity: 'উৎপাদনশীলতা',
+    'Progress %': 'অগ্রগতি %',
+    Reopen: 'আবার খুলুন',
+    Rose: 'গোলাপি',
+    Sequence: 'ক্রম',
+    'Shared lists': 'শেয়ার করা তালিকা',
+    'Shared with': 'যাদের সাথে শেয়ার করা',
+    Slate: 'স্লেট',
+    State: 'অবস্থা',
+    Status: 'অবস্থা',
+    Step: 'ধাপ',
+    Task: 'কাজ',
+    Tasks: 'কাজ',
+    'The colour that marks this list and its to-dos.': 'যে রং দিয়ে এই তালিকা ও এর করণীয়গুলো চিহ্নিত হয়।',
+    'To do': 'করণীয়',
+    'To-do': 'করণীয়',
+    'To-do done': 'করণীয় সম্পন্ন',
+    'To-dos': 'করণীয়',
+    'Updated At': 'হালনাগাদের সময়',
+    'Updated By': 'হালনাগাদ করেছেন',
+    Urgent: 'জরুরি',
+    'Urgent or high': 'জরুরি বা উচ্চ',
+    'User (own to-dos and shared lists)': 'ব্যবহারকারী (নিজের করণীয় ও শেয়ার করা তালিকা)',
+    Violet: 'বেগুনি',
+    'Your to-dos and shared lists, with checklists and due dates': 'আপনার করণীয় ও শেয়ার করা তালিকা, চেকলিস্ট ও নির্ধারিত তারিখসহ',
+};

package/dist/todo/index.js

@@ -25,6 +25,65 @@ export const todo = defineModule({
         category: 'Productivity',
         summary: 'Your to-dos and shared lists, with checklists and due dates',
     },
+    documents: [
+        {
+            key: 'todo',
+            name: 'To-do',
+            model: 'todo.task',
+            layout: {
+                paper: 'A4',
+                header: '{{company.name}}',
+                footer: 'Page {{page}} of {{pages}}',
+                blocks: [
+                    { kind: 'heading', id: 'title', text: '{{name}}', level: 1 },
+                    {
+                        kind: 'fields',
+                        id: 'task',
+                        items: [
+                            { label: 'List', bind: 'list.name' },
+                            { label: 'Owner', bind: 'owner.name' },
+                            { label: 'Due', bind: 'dueDate' },
+                            { label: 'Priority', bind: 'priority' },
+                            { label: 'Progress %', bind: 'progress' },
+                            { label: 'Status', bind: 'state' },
+                        ],
+                    },
+                    { kind: 'text', id: 'note', text: '{{note}}' },
+                ],
+            },
+        },
+    ],
+    importTemplates: [
+        {
+            key: 'todo_list',
+            model: 'todo.list',
+            label: 'List',
+            columns: [
+                { header: 'Name', field: 'name' },
+                { header: 'Owner', field: 'owner' },
+                { header: 'Shared with', field: 'members' },
+                { header: 'Color', field: 'color' },
+            ],
+        },
+        {
+            key: 'todo_task',
+            model: 'todo.task',
+            label: 'To-do',
+            columns: [
+                { header: 'To-do', field: 'name' },
+                { header: 'List', field: 'list' },
+                { header: 'For', field: 'owner' },
+                { header: 'Due', field: 'dueDate' },
+                { header: 'Priority', field: 'priority' },
+                { header: 'Notes', field: 'note' },
+                { header: 'Checklist › Step', field: 'items.name' },
+                { header: 'Checklist › Done', field: 'items.done' },
+            ],
+        },
+    ],
+    events: [{ topic: 'todo.task.done', model: 'todo.task', label: 'To-do done' }],
+    // Bangla for the labels it serves (RFC 0023 §3.1; `pnpm i18n:extract`).
+    i18n: { bn: () => import('./i18n/bn.js') },
     accessLevels: {
         user: { label: 'User (own to-dos and shared lists)', groups: ['todo.user'] },
     },

package/dist/todo/module.d.ts

@@ -1,3 +1,8 @@
+/**
+ * The data layer of Focus (RFC 0021): to-do tasks for the people who use them — their own, or on a list shared with
+ * colleagues — with a due date, a priority, a checklist whose progress shows on the task, and an optional link to any
+ * record of another app. People see their own tasks and those of the lists they belong to; nobody else's.
+ */
 /** A shared list: its owner and members see and work on its tasks. */
 export declare const TodoList: import("../server/orm.js").Model<"todo.list", {
     readonly id: import("../server/orm.js").IdField<"todo.list">;

package/dist/todo/module.js

@@ -4,6 +4,7 @@
  * record of another app. People see their own tasks and those of the lists they belong to; nobody else's.
  */
 import { messagingShutro } from '../messaging/index.js';
+import { emitting } from '../server/index.js';
 import { orm } from '../server/orm.js';
 import { compute, defineModel, defineModule, f } from './.kosh/bindings.js';
 const WRITE = ['read', 'write', 'create', 'unlink'];
@@ -33,7 +34,7 @@ export const TodoList = defineModel('todo.list', {
             amber: 'Amber',
             rose: 'Rose',
             violet: 'Violet',
-        }, { required: true, default: 'blue' }),
+        }, { required: true, default: 'blue', help: 'The colour that marks this list and its to-dos.' }),
         sequence: f.integer({ required: true, default: 10 }),
         tasks: f.one2many('todo.task', 'list'),
     },
@@ -63,12 +64,13 @@ export const TodoTask = defineModel('todo.task', {
             label: 'For',
         }),
         dueDate: f.date({ label: 'Due' }),
-        priority: f.selection({ normal: 'Normal', high: 'High', urgent: 'Urgent' }, { required: true, default: 'normal' }),
+        priority: f.selection({ normal: 'Normal', high: 'High', urgent: 'Urgent' }, { required: true, default: 'normal', help: 'How pressing it is: normal, high or urgent.' }),
         state: f.state({
             states: { open: 'To do', done: 'Done' },
             initial: 'open',
+            help: 'Open until you mark it done; a done to-do can be reopened.',
             transitions: {
-                complete: { from: ['open'], to: 'done' },
+                complete: emitting('todo.task.done', { from: ['open'], to: 'done' }),
                 reopen: { from: ['done'], to: 'open' },
             },
         }),

package/dist/trade_finance/.kosh/bindings.js

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

@@ -1,4 +1,4 @@
-// GENERATED by `pnpm generate:models` (Shutro’s generator). Do not edit. definitions-hash: 80f9de4803e6a17b
+// GENERATED by `pnpm generate:models` (Shutro’s generator). Do not edit. definitions-hash: 74b93d9906549950
 // Schema view of module `trade_finance` (RFC 0002 §7.7): the models it owns or depends on, with the extensions it can see.
 import type { F } from '../../server/orm.js';
 
@@ -623,6 +623,7 @@ export interface ResPartner {
     readonly parent: F.Many2one<'res.partner'>;
     readonly contacts: F.One2many<'res.partner', { readonly required: true }>;
     readonly email: F.Char;
+    readonly lang: F.Selection<'en' | 'bn'>;
     readonly phone: F.Char;
     readonly mobile: F.Char;
     readonly website: F.Char;

package/dist/trade_finance/i18n/bn.d.ts

@@ -0,0 +1,2 @@
+/** Bangla for the module's labels, keyed by their English text (RFC 0023 §3.1; `pnpm i18n:extract`). */
+export declare const bn: Readonly<Record<string, string>>;