shutro-erp 0.3.5 → 0.3.7

package/dist/approvals/demo.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Approvals' demo data (RFC 0008 §5.8): Rahim's business trip to the Sylhet farm, submitted and waiting for his
+ * category's approvers, and a draft purchase request — so the inbox, My requests and the overview have something
+ * to show.
+ */
+import type { DemoContext } from '../modules-sdk/index.js';
+export declare function approvalsDemo(ctx: DemoContext): Promise<string>;

package/dist/approvals/demo.js

@@ -0,0 +1,41 @@
+const RAHIM = { login: 'rahim', name: 'Rahim Uddin', groups: ['base.user'] };
+export async function approvalsDemo(ctx) {
+    await ctx.as(RAHIM, async (raw) => {
+        const env = raw;
+        const categories = await env
+            .model('approval.category')
+            .search({ where: { code: { in: ['TRIP', 'PR'] } } })
+            .then((r) => r.load(['code']));
+        const byCode = new Map([...categories].map((c) => [c.code, c.id]));
+        const trip = byCode.get('TRIP');
+        const purchase = byCode.get('PR');
+        if (trip !== undefined) {
+            const made = await env.model('approval.ask').create([
+                {
+                    category: trip,
+                    title: 'Visit the Sylhet farm',
+                    description: 'Check the new sheds before the first flock arrives.',
+                    amount: '15000',
+                    dateFrom: ctx.date(7),
+                    dateTo: ctx.date(9),
+                    location: 'Sylhet',
+                },
+            ]);
+            await env.model('approval.ask').browse(made.ids).submit();
+        }
+        if (purchase !== undefined)
+            await env.model('approval.ask').create([
+                {
+                    category: purchase,
+                    title: 'Feeders for shed 3',
+                    lines: {
+                        create: [
+                            { name: 'Feeder, 12 kg', quantity: '40', priceUnit: '650' },
+                            { name: 'Drinker, 8 l', quantity: '40', priceUnit: '420' },
+                        ],
+                    },
+                },
+            ]);
+    });
+    return 'Approvals: a business trip waiting for approval and a draft purchase request.';
+}

package/dist/approvals/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/approvals/i18n/bn.js

@@ -0,0 +1,133 @@
+/** Bangla for the module's labels, keyed by their English text (RFC 0023 §3.1; `pnpm i18n:extract`). */
+export const bn = {
+    'A company is in one segment at most.': 'একটি প্রতিষ্ঠান সর্বোচ্চ একটি সেগমেন্টে থাকে।',
+    'A group of companies (Feed, Poultry, Dairy): an approval policy of the segment covers every company in it.': 'প্রতিষ্ঠানের একটি দল (ফিড, পোলট্রি, ডেইরি): সেগমেন্টের অনুমোদন নীতি এর প্রতিটি প্রতিষ্ঠানে প্রযোজ্য।',
+    'A line asks for a positive quantity at a price not below zero.': 'প্রতিটি লাইনে পরিমাণ শূন্যের বেশি এবং মূল্য শূন্যের কম নয় হতে হবে।',
+    'A period ends on or after it starts.': 'সময়কাল শুরুর দিনে বা তার পরে শেষ হয়।',
+    'A record of the model gets one approval per level whose condition it meets; levels with a lower sequence are decided first, those with the same side by side.': 'মডেলের একটি রেকর্ড যে যে স্তরের শর্ত পূরণ করে, প্রতিটির জন্য একটি করে অনুমোদন পায়; কম ক্রমের স্তর আগে সিদ্ধান্ত হয়, একই ক্রমের স্তরগুলো একসাথে।',
+    Active: 'সক্রিয়',
+    Amount: 'অঙ্ক',
+    'Amount waiting': 'অপেক্ষমাণ অঙ্ক',
+    'An amount is not negative.': 'অঙ্ক ঋণাত্মক হতে পারে না।',
+    'Another category has this code.': 'অন্য একটি শ্রেণির এই কোড আছে।',
+    'Approval policy': 'অনুমোদন নীতি',
+    Approvals: 'অনুমোদন',
+    Approved: 'অনুমোদিত',
+    'Approved on': 'অনুমোদনের তারিখ',
+    'Approved this month': 'এই মাসে অনুমোদিত',
+    Ask: 'চাওয়া',
+    'Ask Amount': 'অঙ্ক চাওয়া',
+    'Ask Attachment': 'সংযুক্তি চাওয়া',
+    'Ask Lines': 'লাইন চাওয়া',
+    'Ask Location': 'অবস্থান চাওয়া',
+    'Ask Partner': 'অংশীদার চাওয়া',
+    'Ask Period': 'সময়কাল চাওয়া',
+    'Ask Quantity': 'পরিমাণ চাওয়া',
+    'Asked by': 'অনুরোধকারী',
+    Asks: 'চাওয়া তথ্য',
+    Attachment: 'সংযুক্তি',
+    Away: 'অনুপস্থিত',
+    Cancel: 'বাতিল করুন',
+    Cancelled: 'বাতিল',
+    Category: 'শ্রেণি',
+    Code: 'কোড',
+    Companies: 'প্রতিষ্ঠানসমূহ',
+    Company: 'প্রতিষ্ঠান',
+    Configuration: 'কনফিগারেশন',
+    Contact: 'যোগাযোগ',
+    'Created At': 'তৈরির সময়',
+    'Created By': 'তৈরি করেছেন',
+    'Decided by': 'সিদ্ধান্ত দিয়েছেন',
+    Description: 'বিবরণ',
+    Details: 'বিস্তারিত',
+    'Display Name': 'প্রদর্শিত নাম',
+    Draft: 'খসড়া',
+    'Empty: nothing more. `purchase`: a request for quotation from the lines (with Purchase).': 'খালি: আর কিছু হয় না। `purchase`: লাইনগুলো থেকে একটি উদ্ধৃতির অনুরোধ (Purchase থাকলে)।',
+    'Everyone (decide and ask)': 'সবাই (সিদ্ধান্ত ও অনুরোধ)',
+    'Everything waiting for your decision, in one place — and what you asked for': 'আপনার সিদ্ধান্তের অপেক্ষায় থাকা সবকিছু এক জায়গায় — এবং আপনি যা চেয়েছেন',
+    'Fill in what the category asks for (and attach a file when it is required).': 'শ্রেণিটি যা চায় তা পূরণ করুন (এবং প্রয়োজন হলে একটি ফাইল সংযুক্ত করুন)।',
+    From: 'থেকে',
+    ID: 'আইডি',
+    Lines: 'লাইন',
+    'Lines › Description': 'লাইন › বিবরণ',
+    'Lines › Quantity': 'লাইন › পরিমাণ',
+    'Lines › Unit price': 'লাইন › একক মূল্য',
+    'Lines total': 'লাইনের মোট',
+    Location: 'অবস্থান',
+    Made: 'তৈরি হয়েছে',
+    'Made document': 'তৈরি নথি',
+    'Manager (policies)': 'ব্যবস্থাপক (নীতি)',
+    Matrix: 'ম্যাট্রিক্স',
+    Mine: 'আমার',
+    'My requests': 'আমার অনুরোধ',
+    Name: 'নাম',
+    'No installed app offers this outcome.': 'ইনস্টল করা কোনো অ্যাপ এই ফলাফল দেয় না।',
+    'Not asked': 'চাওয়া হয়নি',
+    'Not asked, optional or required; submitting checks the required ones.': 'চাওয়া হয়নি, ঐচ্ছিক বা আবশ্যক; জমা দেওয়ার সময় আবশ্যকগুলো যাচাই করা হয়।',
+    Note: 'নোট',
+    Number: 'নম্বর',
+    'On approval': 'অনুমোদনের পর',
+    Optional: 'ঐচ্ছিক',
+    Outcome: 'ফলাফল',
+    Overview: 'সারসংক্ষেপ',
+    'Page {{page}} of {{pages}}': 'পৃষ্ঠা {{page}} / {{pages}}',
+    Period: 'সময়কাল',
+    Policies: 'নীতি',
+    Productivity: 'উৎপাদনশীলতা',
+    Quantity: 'পরিমাণ',
+    Refused: 'নামঞ্জুর',
+    Request: 'অনুরোধ',
+    'Request {{name}}: {{title}}': 'অনুরোধ {{name}}: {{title}}',
+    'Request approved': 'অনুরোধ অনুমোদিত',
+    'Request categories': 'অনুরোধের শ্রেণি',
+    'Request category': 'অনুরোধের শ্রেণি',
+    'Request line': 'অনুরোধের লাইন',
+    Requests: 'অনুরোধ',
+    'Requests by category': 'শ্রেণি অনুযায়ী অনুরোধ',
+    'Requests by state': 'অবস্থা অনুযায়ী অনুরোধ',
+    'Requests waiting': 'অপেক্ষমাণ অনুরোধ',
+    Required: 'আবশ্যক',
+    'Required: the request is submitted only with a file attached.': 'আবশ্যক: ফাইল সংযুক্ত থাকলেই কেবল অনুরোধ জমা দেওয়া যায়।',
+    'Result Id': 'ফলাফল আইডি',
+    Segments: 'সেগমেন্ট',
+    Sequence: 'ক্রম',
+    'Set to draft': 'খসড়ায় ফেরত নিন',
+    'Shown to whoever asks: what to give and why.': 'অনুরোধকারীকে দেখানো হয়: কী দিতে হবে এবং কেন।',
+    State: 'অবস্থা',
+    Status: 'অবস্থা',
+    'Submit for approval': 'অনুমোদনের জন্য জমা দিন',
+    'Submitted to the category’s approvers; approved, its outcome runs.': 'শ্রেণির অনুমোদনকারীদের কাছে জমা দেওয়া হয়; অনুমোদিত হলে এর ফলাফল কার্যকর হয়।',
+    Subtotal: 'উপমোট',
+    'The policy covers this company, these companies and every company of the segment together; leave all three empty for every company.': 'নীতিটি এই প্রতিষ্ঠান, এই প্রতিষ্ঠানগুলো এবং সেগমেন্টের প্রতিটি প্রতিষ্ঠানে একসঙ্গে প্রযোজ্য; সব প্রতিষ্ঠানের জন্য তিনটিই খালি রাখুন।',
+    'The policy’s levels decide (made with the first request: the requester’s manager, else an Approvals manager); edit them on the policy. The outcome runs once approved.': 'নীতির স্তরগুলো সিদ্ধান্ত নেয় (প্রথম অনুরোধের সাথে তৈরি হয়: অনুরোধকারীর ব্যবস্থাপক, না থাকলে একজন অনুমোদন ব্যবস্থাপক); নীতিতে এগুলো সম্পাদনা করুন। অনুমোদিত হলে ফলাফল কার্যকর হয়।',
+    'The quantity times the unit price.': 'পরিমাণ গুণ একক মূল্য।',
+    'The sum of the lines’ subtotals.': 'লাইনগুলোর উপমোটের যোগফল।',
+    'The transitions of the record run when it is approved, rejected, sent back or withdrawn.': 'অনুমোদিত, প্রত্যাখ্যাত, ফেরত পাঠানো বা প্রত্যাহার হলে রেকর্ডের ধাপ পরিবর্তনগুলো কার্যকর হয়।',
+    'To approve': 'অনুমোদনের জন্য',
+    'Unit price': 'একক মূল্য',
+    Until: 'পর্যন্ত',
+    'Updated At': 'হালনাগাদের সময়',
+    'Updated By': 'হালনাগাদ করেছেন',
+    'Waiting for approval': 'অনুমোদনের অপেক্ষায়',
+    'Waiting for approvals.': 'অনুমোদনের অপেক্ষায়।',
+    'What a request asks for': 'একটি অনুরোধ যা চায়',
+    'What for': 'কী উদ্দেশ্যে',
+    'What happens': 'কী ঘটে',
+    'What I decided': 'আমার সিদ্ধান্তগুলো',
+    'What the category asks for; required ones are marked. A file, when asked for, goes in the chatter.': 'শ্রেণিটি যা চায়; আবশ্যকগুলো চিহ্নিত। ফাইল চাওয়া হলে তা চ্যাটারে যুক্ত করুন।',
+    'Whether a request of this category asks for a contact: not asked, optional or required.': 'এই শ্রেণির অনুরোধে একটি যোগাযোগ চাওয়া হয় কি না: চাওয়া হয়নি, ঐচ্ছিক বা আবশ্যক।',
+    'Whether a request of this category asks for a location: not asked, optional or required.': 'এই শ্রেণির অনুরোধে একটি অবস্থান চাওয়া হয় কি না: চাওয়া হয়নি, ঐচ্ছিক বা আবশ্যক।',
+    'Whether a request of this category asks for a period, from and until: not asked, optional or required.': 'এই শ্রেণির অনুরোধে একটি সময়কাল (শুরু ও শেষ) চাওয়া হয় কি না: চাওয়া হয়নি, ঐচ্ছিক বা আবশ্যক।',
+    'Whether a request of this category asks for a quantity: not asked, optional or required.': 'এই শ্রেণির অনুরোধে একটি পরিমাণ চাওয়া হয় কি না: চাওয়া হয়নি, ঐচ্ছিক বা আবশ্যক।',
+    'Whether a request of this category asks for an amount: not asked, optional or required.': 'এই শ্রেণির অনুরোধে একটি অঙ্ক চাওয়া হয় কি না: চাওয়া হয়নি, ঐচ্ছিক বা আবশ্যক।',
+    'Whether a request of this category asks for lines with quantities and prices: not asked, optional or required.': 'এই শ্রেণির অনুরোধে পরিমাণ ও মূল্যসহ লাইন চাওয়া হয় কি না: চাওয়া হয়নি, ঐচ্ছিক বা আবশ্যক।',
+    'Whether this request asks for a contact, as its category says.': 'এই অনুরোধে একটি যোগাযোগ চাওয়া হয় কি না, এর শ্রেণি অনুযায়ী।',
+    'Whether this request asks for a location, as its category says.': 'এই অনুরোধে একটি অবস্থান চাওয়া হয় কি না, এর শ্রেণি অনুযায়ী।',
+    'Whether this request asks for a period, as its category says.': 'এই অনুরোধে একটি সময়কাল চাওয়া হয় কি না, এর শ্রেণি অনুযায়ী।',
+    'Whether this request asks for a quantity, as its category says.': 'এই অনুরোধে একটি পরিমাণ চাওয়া হয় কি না, এর শ্রেণি অনুযায়ী।',
+    'Whether this request asks for an amount, as its category says.': 'এই অনুরোধে একটি অঙ্ক চাওয়া হয় কি না, এর শ্রেণি অনুযায়ী।',
+    'Whether this request asks for an attached file, as its category says.': 'এই অনুরোধে একটি সংযুক্ত ফাইল চাওয়া হয় কি না, এর শ্রেণি অনুযায়ী।',
+    'Whether this request asks for lines, as its category says.': 'এই অনুরোধে লাইন চাওয়া হয় কি না, এর শ্রেণি অনুযায়ী।',
+    'While you are away, the person you choose decides your approvals — in their own name, for you. They never approve their own requests.': 'আপনার অনুপস্থিতিতে আপনার বেছে নেওয়া ব্যক্তি আপনার হয়ে, নিজের নামে আপনার অনুমোদনের সিদ্ধান্ত দেবেন। তিনি কখনো নিজের অনুরোধ অনুমোদন করেন না।',
+    'Who decides and what follows': 'কে সিদ্ধান্ত নেয় এবং এরপর কী হয়',
+};

package/dist/approvals/index.d.ts

@@ -0,0 +1,36 @@
+/**
+ * @packageDocumentation
+ * `shutro-erp/approvals` (RFC 0025): the **Approvals** app on the engine of `shutro-erp/permissions`. Everyone who decides or
+ * asks has it: the inbox (cards with the record, who asked, how long it waits, every level as a step; decided one by
+ * one or many at once, from the keyboard too), my requests (withdrawn while they wait), what I decided, and *Away*
+ * (who decides for me while I am away); for Approvals managers, the policies — levels, who decides each and how many,
+ * the deadline and who it escalates to — edited on screen. Approvers get each request by email with a link of their
+ * own that opens a confirmation page; reminders at half a deadline and escalations once late, hourly.
+ *
+ * - `GET  /api/v1/public/approvals/:token`   the confirmation page of an email link
+ * - `POST /api/v1/public/approvals/:token`   `{ decision: approve | reject | send_back, comment? }`, once
+ * - `POST /api/v1/approvals/deadlines/run`   reminders and escalations now (Approvals managers; hourly too)
+ * - `POST /api/v1/approvals/categories/:id/policy`  a request category's policy, made when missing (Approvals managers)
+ * - `GET  /api/v1/approvals/policies/:id/preview`    which of the last 50 records each level would have asked about
+ *
+ * **Generic requests** (step 4): categories say what a request asks for and what it leads to; a request is decided
+ * through its category's policy, and its outcome runs when approved.
+ */
+import { type Mailer } from '../mail/index.js';
+import { defineModule } from '../modules-sdk/index.js';
+import { type ModuleContext } from '../server/index.js';
+import type { Worker } from '../server/orm.js';
+export { mailDeciders, mailTurn } from './mails.js';
+export { ApprovalAsk, ApprovalAskLine, ApprovalCategory, approvalsShutro, ensureCategoryPolicy, missingFields, outcomesOffered, } from './module.js';
+/** The subscribers that email a record's approvers when its approvals are asked and when a level is approved. */
+export declare function approvalMailWorkers(context: Pick<ModuleContext, 'shutro'>): Worker[];
+export interface ApprovalsOptions {
+    /** Who sends approvers their requests; default: SMTP from the environment (`SMTP_URL`), none without it. */
+    readonly mailer?: Mailer | undefined;
+    /** The API's public address, which email links point to (`KOSH_API_URL`). */
+    readonly apiUrl?: string;
+}
+/** The Approvals app with explicit options (tests: a memory mailer). */
+export declare function approvalsModule(options?: ApprovalsOptions): ReturnType<typeof defineModule>;
+/** The Approvals app (mail from the environment). */
+export declare const approvals: ReturnType<typeof defineModule>;