shutro-erp 0.3.5 → 0.3.7

package/dist/account_asset/i18n/bn.js

@@ -0,0 +1,97 @@
+/** Bangla for the module's labels, keyed by their English text (RFC 0023 §3.1; `pnpm i18n:extract`). */
+export const bn = {
+    'A bill line on this account makes a draft asset of this category.': 'এই হিসাবের কোনো বিলের লাইন থেকে এই শ্রেণির একটি খসড়া সম্পদ তৈরি হয়।',
+    'A running asset is depreciated month by month; disposing of it, or the last month, ends it.': 'চালু সম্পদের মাসে মাসে অবচয় হয়; নিষ্পত্তি করলে বা শেষ মাসে তা শেষ হয়।',
+    Accounts: 'হিসাব',
+    'Accumulated depreciation': 'পুঞ্জীভূত অবচয়',
+    Acquired: 'অর্জনের তারিখ',
+    Active: 'সক্রিয়',
+    Amount: 'অঙ্ক',
+    'An asset is used after it is acquired.': 'সম্পদ অর্জনের পরেই ব্যবহার শুরু হয়।',
+    'An asset’s life is at least a month.': 'সম্পদের আয়ুষ্কাল অন্তত এক মাস।',
+    Asset: 'সম্পদ',
+    'Asset account': 'সম্পদের হিসাব',
+    'Asset card': 'সম্পদের কার্ড',
+    'Asset categories': 'সম্পদের শ্রেণি',
+    'Asset category': 'সম্পদের শ্রেণি',
+    'Asset disposed of': 'সম্পদ নিষ্পত্তি হয়েছে',
+    'Asset tag': 'সম্পদ ট্যাগ',
+    'Asset usage': 'সম্পদের ব্যবহার',
+    Board: 'অবচয় তালিকা',
+    'Book value': 'বই মূল্য',
+    Category: 'শ্রেণি',
+    Company: 'প্রতিষ্ঠান',
+    'Confirm and plan the board': 'নিশ্চিত করুন ও অবচয় তালিকা তৈরি করুন',
+    'Confirming plans the board; a revaluation plans the rest of it again.': 'নিশ্চিত করলে অবচয় তালিকা তৈরি হয়; পুনর্মূল্যায়ন বাকি অংশ আবার তৈরি করে।',
+    Cost: 'খরচ',
+    'Cost centre': 'খরচ কেন্দ্র',
+    'Created At': 'তৈরির সময়',
+    'Created By': 'তৈরি করেছেন',
+    Date: 'তারিখ',
+    'Declining balance': 'ক্রমহ্রাসমান জের',
+    'Declining rate (% a year)': 'হ্রাসের হার (বছরে %)',
+    Depreciated: 'অবচয়িত',
+    'Depreciated (posted)': 'অবচয়িত (পোস্টকৃত)',
+    'Depreciated by': 'অবচয়ের ধরন',
+    Depreciation: 'অবচয়',
+    'Depreciation and impairment lower the book value; a revaluation raises it.': 'অবচয় ও অবমূল্যায়ন বই মূল্য কমায়; পুনর্মূল্যায়ন তা বাড়ায়।',
+    'Depreciation expense': 'অবচয় খরচ',
+    'Depreciation line': 'অবচয়ের লাইন',
+    'Depreciation posted': 'অবচয় পোস্টকৃত',
+    'Display Name': 'প্রদর্শিত নাম',
+    Disposal: 'নিষ্পত্তি',
+    Disposed: 'নিষ্পত্তিকৃত',
+    'Disposed on': 'নিষ্পত্তির তারিখ',
+    Draft: 'খসড়া',
+    'Fixed asset': 'স্থায়ী সম্পদ',
+    'Fixed assets': 'স্থায়ী সম্পদ',
+    'Fixed assets (opening register)': 'স্থায়ী সম্পদ (প্রারম্ভিক রেজিস্টার)',
+    'From bill': 'বিল থেকে',
+    'From bill line': 'বিলের লাইন থেকে',
+    'From the category; changeable while the asset is a draft.': 'শ্রেণি থেকে আসে; সম্পদ খসড়া থাকা পর্যন্ত বদলানো যায়।',
+    'From the date of use': 'ব্যবহারের তারিখ থেকে',
+    'Fully depreciated': 'সম্পূর্ণ অবচয়িত',
+    'Gain on disposal': 'নিষ্পত্তিতে লাভ',
+    ID: 'আইডি',
+    Impairment: 'অবমূল্যায়ন',
+    'In use from': 'ব্যবহার শুরু',
+    Journal: 'জার্নাল',
+    'Journal entry': 'জার্নাল এন্ট্রি',
+    Kind: 'ধরন',
+    'Life (months)': 'আয়ুষ্কাল (মাস)',
+    'Loss on disposal or impairment': 'নিষ্পত্তি বা অবমূল্যায়নে ক্ষতি',
+    Method: 'পদ্ধতি',
+    Name: 'নাম',
+    Posted: 'পোস্টকৃত',
+    Revaluation: 'পুনর্মূল্যায়ন',
+    Running: 'চালু',
+    'Salvage value': 'অবশেষ মূল্য',
+    'Sold for': 'বিক্রয়মূল্য',
+    State: 'অবস্থা',
+    Status: 'অবস্থা',
+    'Straight line': 'সরলরৈখিক',
+    'Straight line over the life; declining balance at the rate, switching to straight line at the end; units of production by usage.': 'সরলরৈখিক: আয়ুষ্কাল জুড়ে সমান হারে; ক্রমহ্রাসমান জের: নির্ধারিত হারে, শেষে সরলরৈখিকে বদলায়; উৎপাদন একক: ব্যবহার অনুযায়ী।',
+    Tag: 'ট্যাগ',
+    'Tax book': 'কর হিসাব বই',
+    'Tax depreciation (% a year)': 'কর অবচয় (বছরে %)',
+    'Tax depreciation (%)': 'কর অবচয় (%)',
+    'The cost is positive, the salvage value below it, the life at least a month.': 'খরচ ধনাত্মক, অবশেষ মূল্য তার কম এবং আয়ুষ্কাল অন্তত এক মাস হতে হবে।',
+    'The cost, revaluations included, less what was depreciated.': 'পুনর্মূল্যায়নসহ খরচ থেকে অবচয় বাদে।',
+    'The first month counts from the day the asset is put to use.': 'সম্পদ ব্যবহার শুরুর দিন থেকে প্রথম মাস গণনা হয়।',
+    'The month it was used in (its last day).': 'যে মাসে ব্যবহৃত হয়েছে (মাসের শেষ দিন)।',
+    'The posted depreciation, impairments included.': 'অবমূল্যায়নসহ পোস্টকৃত অবচয়।',
+    'The tag on the asset, scanned in counts.': 'সম্পদের গায়ের ট্যাগ, গণনার সময় স্ক্যান করা হয়।',
+    'The tax book: reducing balance at this rate (Bangladesh: the Third Schedule of the Income Tax Act — verify for the year).': 'কর হিসাব বই: এই হারে ক্রমহ্রাসমান জের (বাংলাদেশ: আয়কর আইনের তৃতীয় তফসিল — বছরের জন্য যাচাই করুন)।',
+    'To confirm': 'নিশ্চিত করতে হবে',
+    Units: 'একক',
+    'Units of production': 'উৎপাদন একক',
+    'Units of production need the units over the asset’s life.': 'উৎপাদন একক পদ্ধতিতে সম্পদের আয়ুষ্কালের মোট একক লাগে।',
+    'Units of production: hours, kilometres, pieces.': 'উৎপাদন একক: ঘণ্টা, কিলোমিটার, পিস।',
+    'Units over its life': 'আয়ুষ্কালে মোট একক',
+    'Updated At': 'হালনাগাদের সময়',
+    'Updated By': 'হালনাগাদ করেছেন',
+    Usage: 'ব্যবহার',
+    'Usage is positive.': 'ব্যবহার ধনাত্মক হতে হবে।',
+    Value: 'মূল্যমান',
+    Vendor: 'সরবরাহকারী',
+};

package/dist/account_asset/index.d.ts

@@ -0,0 +1,9 @@
+import { defineModule } from '../modules-sdk/index.js';
+import { type ModuleContext } from '../server/index.js';
+import { type Worker } from '../server/orm.js';
+export { board, taxBook, unitsLine } from './board.js';
+export { assetsFromBill, dispose, planBoard, postDue, revalue, type TaxBookRow, taxBookOf, } from './books.js';
+export { Asset, AssetCategory, AssetLine, AssetUsage, accountAssetShutro } from './module.js';
+/** The subscriber that makes draft assets of posted bills; tests `drain()` it, the server starts it. */
+export declare function assetWorker(context: Pick<ModuleContext, 'shutro'>): Worker;
+export declare const accountAsset: ReturnType<typeof defineModule>;

package/dist/account_asset/index.js

@@ -0,0 +1,337 @@
+/**
+ * @packageDocumentation
+ * `shutro-erp/account_asset` (RFC 0024 §2.5): **Fixed assets** in Accounting. Categories with their accounts, method and
+ * life; assets from posted bills (a line on a category's asset account) or by hand; boards planned ahead — straight
+ * line with prorata, declining balance switching to straight line, units of production by usage — posted month by
+ * month, once each, with the asset's cost centre; disposal and sale with the gain or loss; revaluation and
+ * impairment; and a tax book (reducing balance at the category's tax rate) beside the accounting book.
+ *
+ * - `POST /api/v1/assets/post-due`             `{ date }`: every running asset's lines due, posted
+ * - `POST /api/v1/assets/:id/dispose`          `{ date, proceeds?, account? }`: disposed of or sold
+ * - `POST /api/v1/assets/:id/revalue`          `{ date, value }`: revalued or impaired
+ * - `GET  /api/v1/assets/tax-book?year=`       the tax book of the fiscal year starting in `year`
+ */
+import { accounting } from '../accounting/index.js';
+import { defineModule } from '../modules-sdk/index.js';
+import { audit, HttpProblem } from '../server/index.js';
+import { orm } from '../server/orm.js';
+import { action, form, list, pivot, search, stat } from '../views/index.js';
+import { assetsFromBill, dispose, postDue, revalue, taxBookOf } from './books.js';
+import { assetDemo } from './demo.js';
+import { Asset, AssetCategory, AssetLine, accountAssetShutro } from './module.js';
+export { board, taxBook, unitsLine } from './board.js';
+export { assetsFromBill, dispose, planBoard, postDue, revalue, taxBookOf, } from './books.js';
+export { Asset, AssetCategory, AssetLine, AssetUsage, accountAssetShutro } from './module.js';
+const DATE = /^\d{4}-\d{2}-\d{2}$/;
+/** The subscriber that makes draft assets of posted bills; tests `drain()` it, the server starts it. */
+export function assetWorker(context) {
+    return context.shutro.subscribe('account_asset.bills', 'account.move.posted', async (event, env) => {
+        const payload = (event.payload ?? {});
+        if (payload.kind !== 'in_invoice')
+            return;
+        const id = Number(payload.id);
+        if (Number.isInteger(id) && id > 0)
+            await env.asSuperuser({ reason: 'assets from a bill' }, (su) => assetsFromBill(su, id));
+    }, { pollMs: 5000 });
+}
+function registerAssetRoutes(context) {
+    const { app } = context;
+    const managers = (env) => {
+        if (!env.administrator && !env.groups.has('account.manager'))
+            throw new HttpProblem(403, 'access', 'Accounting managers', 'This needs the Accounting manager role.');
+    };
+    const dateOf = (v) => {
+        if (typeof v !== 'string' || !DATE.test(v))
+            throw new HttpProblem(422, 'invalid-date', 'Invalid date', 'Give the date as YYYY-MM-DD.');
+        return v;
+    };
+    const amountOf = (v, what) => {
+        const text = typeof v === 'number' ? String(v) : typeof v === 'string' ? v : '';
+        if (!/^\d+(\.\d+)?$/.test(text))
+            throw new HttpProblem(422, 'invalid-amount', 'Invalid amount', `Give ${what} as a number.`);
+        return orm.toDecimal(text);
+    };
+    const asProblem = (error) => {
+        if (error instanceof orm.ValidationError)
+            throw new HttpProblem(422, 'invalid', 'Not possible', error.message);
+        throw error;
+    };
+    app.post('/api/v1/assets/post-due', async (request) => {
+        const date = dateOf(request.body?.['date']);
+        return request.env(async (raw) => {
+            const env = raw;
+            managers(env);
+            return env.asSuperuser({ reason: 'post depreciation' }, async (su) => ({
+                posted: await postDue(su, date),
+            }));
+        }, { write: true });
+    });
+    app.post('/api/v1/assets/:id/dispose', async (request) => {
+        const id = Number(request.params.id);
+        const body = (request.body ?? {});
+        const date = dateOf(body['date']);
+        const proceeds = body['proceeds'] === undefined
+            ? orm.toDecimal(0)
+            : amountOf(body['proceeds'], 'the proceeds');
+        const account = body['account'] === undefined || body['account'] === null ? null : Number(body['account']);
+        return request.env(async (raw) => {
+            const env = raw;
+            managers(env);
+            return env.asSuperuser({ reason: 'asset disposal' }, async (su) => {
+                const move = await dispose(su, id, { date, proceeds, account }).catch(asProblem);
+                await audit(env, {
+                    kind: 'asset.disposed',
+                    summary: `Asset ${id} disposed of.`,
+                    targetModel: 'account.asset',
+                    targetId: id,
+                    ip: request.ip,
+                });
+                return { move };
+            });
+        }, { write: true });
+    });
+    app.post('/api/v1/assets/:id/revalue', async (request) => {
+        const id = Number(request.params.id);
+        const body = (request.body ?? {});
+        const date = dateOf(body['date']);
+        const value = amountOf(body['value'], 'the new value');
+        return request.env(async (raw) => {
+            const env = raw;
+            managers(env);
+            return env.asSuperuser({ reason: 'asset revaluation' }, async (su) => {
+                const move = await revalue(su, id, { date, value }).catch(asProblem);
+                await audit(env, {
+                    kind: 'asset.revalued',
+                    summary: `Asset ${id} revalued to ${value.toString()}.`,
+                    targetModel: 'account.asset',
+                    targetId: id,
+                    ip: request.ip,
+                });
+                return { move };
+            });
+        }, { write: true });
+    });
+    app.get('/api/v1/assets/tax-book', async (request) => {
+        const year = Number(request.query.year);
+        if (!Number.isInteger(year) || year < 1990 || year > 2100)
+            throw new HttpProblem(422, 'invalid-year', 'Invalid year', 'Give the year the fiscal year starts in (2026).');
+        return request.env(async (raw) => {
+            const env = raw;
+            if (!env.administrator && !env.groups.has('account.user'))
+                throw new HttpProblem(403, 'access', 'Accountants', 'This needs the Accountant role.');
+            return { year, rows: await taxBookOf(env, year) };
+        });
+    });
+    if (process.env['KOSH_SCHEDULES'] === 'off')
+        return;
+    const worker = assetWorker(context);
+    worker.start();
+    // Depreciation due, daily, company by company.
+    const run = async () => {
+        try {
+            const today = new Date().toISOString().slice(0, 10);
+            const companies = await context.shutro.bootstrap({ reason: 'depreciation' }, async (env) => (await env.model('res.company').search({})).ids);
+            for (const company of companies)
+                await context.shutro.bootstrap({ reason: 'depreciation', company }, (env) => env.asSuperuser({ reason: 'depreciation' }, (su) => postDue(su, today)));
+        }
+        catch (error) {
+            app.log.error({ err: error }, 'depreciation');
+        }
+    };
+    const timer = setInterval(() => void run(), 86_400_000);
+    timer.unref();
+    app.addHook('onClose', async () => {
+        clearInterval(timer);
+        await worker.stop();
+    });
+}
+export const accountAsset = defineModule({
+    shutro: accountAssetShutro,
+    kosh: '^0.1.0',
+    hooks: { demo: assetDemo },
+    depends: [accounting],
+    // Bangla for the labels it serves (RFC 0023 §3.1; `pnpm i18n:extract`).
+    i18n: { bn: () => import('./i18n/bn.js') },
+    accessLevels: {
+        user: { label: 'Fixed assets', groups: ['account_asset.user'] },
+    },
+    routes: (context) => registerAssetRoutes(context),
+    events: [{ topic: 'account.asset.disposed', model: 'account.asset', label: 'Asset disposed of' }],
+    documents: [
+        {
+            key: 'asset_card',
+            name: 'Asset card',
+            model: 'account.asset',
+            layout: {
+                paper: 'A4',
+                header: '{{company.name}}',
+                blocks: [
+                    { kind: 'heading', id: 'title', text: '{{name}}', level: 1 },
+                    {
+                        kind: 'fields',
+                        id: 'asset',
+                        items: [
+                            { label: 'Tag', bind: 'code' },
+                            { label: 'Category', bind: 'category.name' },
+                            { label: 'Vendor', bind: 'partner.name' },
+                            { label: 'Acquired', bind: 'dateAcquired' },
+                            { label: 'Cost', bind: 'value' },
+                            { label: 'Depreciated', bind: 'depreciated' },
+                            { label: 'Book value', bind: 'bookValue' },
+                            { label: 'Status', bind: 'state' },
+                        ],
+                    },
+                    {
+                        kind: 'table',
+                        id: 'board',
+                        bind: 'lines',
+                        columns: [
+                            { label: 'Date', bind: 'date' },
+                            { label: 'Kind', bind: 'kind' },
+                            { label: 'Amount', bind: 'amount' },
+                            { label: 'Posted', bind: 'posted' },
+                        ],
+                    },
+                    { kind: 'qr', id: 'qr', bind: 'code', size: 22, label: 'Asset tag' },
+                ],
+            },
+        },
+    ],
+    importTemplates: [
+        {
+            key: 'assets',
+            model: 'account.asset',
+            label: 'Fixed assets (opening register)',
+            columns: [
+                { header: 'Name', field: 'name' },
+                { header: 'Tag', field: 'code' },
+                { header: 'Category', field: 'category' },
+                { header: 'Cost', field: 'value' },
+                { header: 'Salvage value', field: 'salvage' },
+                { header: 'Acquired', field: 'dateAcquired' },
+                { header: 'In use from', field: 'dateInUse' },
+                { header: 'Life (months)', field: 'lifeMonths' },
+            ],
+        },
+        {
+            key: 'categories',
+            model: 'account.asset.category',
+            label: 'Asset categories',
+            columns: [
+                { header: 'Name', field: 'name' },
+                { header: 'Asset account', field: 'assetAccount' },
+                { header: 'Accumulated depreciation', field: 'accumulatedAccount' },
+                { header: 'Depreciation expense', field: 'expenseAccount' },
+                { header: 'Journal', field: 'journal' },
+                { header: 'Method', field: 'method' },
+                { header: 'Life (months)', field: 'lifeMonths' },
+                { header: 'Tax depreciation (%)', field: 'taxRate' },
+            ],
+        },
+    ],
+    actions: {
+        'accounting.action_assets': action(Asset, {
+            label: 'Fixed assets',
+            views: ['list', 'form', 'pivot'],
+        }),
+        'accounting.action_asset_categories': action(AssetCategory, {
+            label: 'Asset categories',
+            views: ['list', 'form'],
+        }),
+    },
+    menus: [
+        {
+            id: 'accounting.assets',
+            parent: 'accounting.root',
+            label: 'Fixed assets',
+            action: 'accounting.action_assets',
+            sequence: 6,
+        },
+        {
+            id: 'accounting.asset_categories',
+            parent: 'accounting.configuration',
+            label: 'Asset categories',
+            action: 'accounting.action_asset_categories',
+            sequence: 8,
+        },
+    ],
+    views: {
+        'account.asset.list': list(Asset, {
+            columns: [
+                'code',
+                'name',
+                'category',
+                'dateInUse',
+                'value',
+                'depreciated',
+                'bookValue',
+                'state',
+            ],
+            defaultOrder: ['dateInUse desc'],
+        }),
+        'account.asset.pivot': pivot(Asset, {
+            rows: ['category'],
+            cols: ['state'],
+            measures: [{ sum: 'value' }, { sum: 'bookValue' }],
+        }),
+        'account.asset.form': form(Asset, (k) => ({
+            header: {
+                statusbar: 'state',
+                buttons: [k.button('confirm', { primary: true, label: 'Confirm and plan the board' })],
+            },
+            readonlyWhen: { state: { in: ['disposed', 'closed'] } },
+            sheet: [
+                k.stats('related', [
+                    stat({
+                        id: 'asset_posted',
+                        label: 'Depreciation posted',
+                        model: AssetLine,
+                        where: { asset: { $record: 'id' }, posted: true, kind: 'depreciation' },
+                        measure: { sum: 'amount' },
+                    }),
+                ]),
+                k.group('main', ['name', 'code', 'category', 'partner', 'bill', 'analytic']),
+                k.group('worth', ['value', 'salvage', 'dateAcquired', 'dateInUse', 'depreciated', 'bookValue'], { label: 'Value' }),
+                k.group('depreciation', ['method', 'lifeMonths', 'rate', 'prorata', 'totalUnits'], {
+                    label: 'Depreciation',
+                    description: 'Confirming plans the board; a revaluation plans the rest of it again.',
+                }),
+                k.lines('lines', ['date', 'kind', { field: 'amount', id: 'line_amount' }, 'posted', 'move'], { readonlyWhen: {} }),
+                k.lines('usage', [{ field: 'date', id: 'usage_date' }, 'units', 'line']),
+                k.group('disposal', ['disposedOn', 'proceeds'], { label: 'Disposal' }),
+            ],
+            chatter: true,
+        })),
+        'account.asset.category.list': list(AssetCategory, {
+            columns: ['name', 'method', 'lifeMonths', 'rate', 'taxRate', 'assetAccount'],
+        }),
+        'account.asset.category.form': form(AssetCategory, (k) => ({
+            header: { buttons: [] },
+            sheet: [
+                k.group('main', ['name', 'method', 'lifeMonths', 'rate', 'prorata']),
+                k.group('accounts', [
+                    'assetAccount',
+                    'accumulatedAccount',
+                    'expenseAccount',
+                    'gainAccount',
+                    'lossAccount',
+                    'journal',
+                ], {
+                    label: 'Accounts',
+                }),
+                k.group('tax', ['taxRate'], { label: 'Tax book' }),
+            ],
+        })),
+    },
+    search: {
+        'account.asset': search(Asset, {
+            fields: ['name', 'code', 'partner.name'],
+            filters: {
+                running: { label: 'Running', domain: { state: 'running' }, group: 'state' },
+                draft: { label: 'To confirm', domain: { state: 'draft' }, group: 'state' },
+            },
+            groupBy: ['category', 'state', 'analytic', 'dateAcquired:year'],
+        }),
+        'account.asset.category': search(AssetCategory, { fields: ['name'], groupBy: ['method'] }),
+    },
+});