shutro-erp 0.3.6 → 0.3.7

package/dist/settings/web/CompaniesPage.js

@@ -4,38 +4,123 @@ import { Fragment as _Fragment, jsx as _jsx, jsxs as _jsxs } from "react/jsx-run
  * in it; switching to one; and, for administrators, a new company — its apps' defaults (journals, sequences, taxes…)
  * are installed with it, and the administrators can switch to it at once.
  */
-import { Alert, ApiError, Avatar, Badge, Button, Dialog, Input, imageUrl, Label, Select, useKosh, } from '../../ui/index.js';
+import { Alert, ApiError, Avatar, Badge, Button, Checkbox, Dialog, Input, imageUrl, Label, Select, Textarea, useKosh, } from '../../ui/index.js';
 import { useMutation, useQuery, useQueryClient } from '@tanstack/react-query';
-import { Building2, Plus } from 'lucide-react';
+import { Building2, CheckCircle2, Info, Plus } from 'lucide-react';
 import { useEffect, useId, useState } from 'react';
 import { useTranslation } from 'react-i18next';
 const message = (error) => (error instanceof ApiError ? error.message : String(error));
-function NewCompanyDialog({ api, currencies, open, onOpenChange, }) {
+/** The details of a new company, grouped as people expect them; anything else an app adds goes under "More". */
+const ADDRESS = ['street', 'street2', 'city', 'state', 'zip', 'country', 'countryCode'];
+const CONTACT = ['email', 'phone', 'mobile', 'website'];
+const REGISTRATION = /tax|vat|bin|tin|gst|pan|registration|trade|licen|fiscal|year/i;
+function DetailInput({ id, field, value, onChange, }) {
+    if (field.kind === 'boolean')
+        return (_jsxs("div", { className: "flex items-center gap-2", children: [_jsx(Checkbox, { id: id, checked: value === true, onCheckedChange: (c) => onChange(c === true), "aria-describedby": field.help === null ? undefined : `${id}-help` }), _jsx(Label, { htmlFor: id, children: field.label })] }));
+    if (field.kind === 'selection' && field.options !== null)
+        return (_jsx(Select, { id: id, label: field.label, value: typeof value === 'string' ? value : null, options: field.options, onChange: onChange }));
+    if (field.kind === 'text')
+        return (_jsx(Textarea, { id: id, rows: 2, value: typeof value === 'string' ? value : '', onChange: (e) => onChange(e.target.value), "aria-describedby": field.help === null ? undefined : `${id}-help` }));
+    return (_jsx(Input, { id: id, type: field.kind === 'integer'
+            ? 'number'
+            : field.key === 'email'
+                ? 'email'
+                : field.key === 'website'
+                    ? 'url'
+                    : field.key.toLowerCase().includes('phone') || field.key === 'mobile'
+                        ? 'tel'
+                        : 'text', value: typeof value === 'string' || typeof value === 'number' ? String(value) : '', onChange: (e) => onChange(field.kind === 'integer'
+            ? e.target.value === ''
+                ? null
+                : Number(e.target.value)
+            : e.target.value), "aria-describedby": field.help === null ? undefined : `${id}-help` }));
+}
+function NewCompanyDialog({ api, currencies, fields, open, onOpenChange, }) {
     const { t } = useTranslation('settings');
+    const { switchCompany } = useKosh();
     const id = useId();
     const queryClient = useQueryClient();
     const [name, setName] = useState('');
     const [currency, setCurrency] = useState(null);
+    const [grouping, setGrouping] = useState('international');
+    const [accent, setAccent] = useState('');
+    const [details, setDetails] = useState({});
     const create = useMutation({
         mutationFn: () => api.call('POST', '/api/v1/settings/companies', {
             name,
             currency: Number(currency),
+            numberGrouping: grouping,
+            ...(accent === '' ? {} : { accentColor: accent }),
+            details: Object.fromEntries(Object.entries(details).filter(([, v]) => v !== '' && v !== null && v !== undefined)),
         }),
         onSuccess: () => {
             void queryClient.invalidateQueries({ queryKey: ['settings', 'companies'] });
             // The switcher lists the user's companies from their details.
             void queryClient.invalidateQueries({ queryKey: ['me'] });
-            onOpenChange(false);
         },
     });
     useEffect(() => {
         if (!open) {
             setName('');
             setCurrency(null);
+            setGrouping('international');
+            setAccent('');
+            setDetails({});
             create.reset();
         }
     }, [open, create.reset]);
-    return (_jsx(Dialog, { open: open, onOpenChange: onOpenChange, title: t('companies.newTitle'), description: t('companies.newHint'), footer: _jsxs(_Fragment, { children: [_jsx(Button, { onClick: () => onOpenChange(false), children: t('profile.cancel') }), _jsx(Button, { variant: "primary", busy: create.isPending, disabled: name.trim() === '' || currency === null, onClick: () => create.mutate(), children: t('companies.create') })] }), children: _jsxs("div", { className: "grid gap-4", children: [_jsxs("div", { className: "grid gap-1.5", children: [_jsx(Label, { htmlFor: `${id}-name`, children: t('company.name') }), _jsx(Input, { id: `${id}-name`, value: name, onChange: (e) => setName(e.target.value) })] }), _jsxs("div", { className: "grid gap-1.5", children: [_jsx(Label, { htmlFor: `${id}-currency`, children: t('companies.currency') }), _jsx(Select, { id: `${id}-currency`, label: t('companies.currency'), value: currency, placeholder: t('companies.chooseCurrency'), options: currencies.map((c) => ({ value: String(c.id), label: c.name })), onChange: setCurrency })] }), create.error === null ? null : _jsx(Alert, { tone: "danger", children: message(create.error) })] }) }));
+    // The lakh and crore grouping suits taka and rupees: suggested when one is chosen (still the person's choice).
+    const chooseCurrency = (value) => {
+        setCurrency(value);
+        const code = currencies.find((c) => String(c.id) === value)?.name ?? '';
+        setGrouping(['BDT', 'INR', 'NPR', 'PKR', 'LKR'].includes(code) ? 'lakh' : 'international');
+    };
+    const set = (key) => (value) => setDetails((d) => ({ ...d, [key]: value }));
+    const groups = [
+        {
+            key: 'address',
+            title: t('companies.address'),
+            hint: t('companies.addressHint'),
+            fields: ADDRESS.flatMap((k) => fields.filter((f) => f.key === k)),
+        },
+        {
+            key: 'contact',
+            title: t('companies.contact'),
+            hint: t('companies.contactHint'),
+            fields: CONTACT.flatMap((k) => fields.filter((f) => f.key === k)),
+        },
+        {
+            key: 'registration',
+            title: t('companies.registration'),
+            hint: t('companies.registrationHint'),
+            fields: fields.filter((f) => !ADDRESS.includes(f.key) &&
+                !CONTACT.includes(f.key) &&
+                REGISTRATION.test(`${f.key} ${f.label}`)),
+        },
+        {
+            key: 'more',
+            title: t('companies.more'),
+            hint: t('companies.moreHint'),
+            fields: fields.filter((f) => !ADDRESS.includes(f.key) &&
+                !CONTACT.includes(f.key) &&
+                !REGISTRATION.test(`${f.key} ${f.label}`)),
+        },
+    ].filter((g) => g.fields.length > 0);
+    const done = create.data;
+    const field = (f) => {
+        const fid = `${id}-${f.key}`;
+        return (_jsxs("div", { className: f.kind === 'text' ? 'grid gap-1.5 sm:col-span-2' : 'grid gap-1.5', children: [f.kind === 'boolean' ? null : _jsx(Label, { htmlFor: fid, children: f.label }), _jsx(DetailInput, { id: fid, field: f, value: details[f.key], onChange: set(f.key) }), f.help === null ? null : (_jsx("p", { id: `${fid}-help`, className: "text-xs text-muted-foreground", children: f.help }))] }, f.key));
+    };
+    return (_jsx(Dialog, { open: open, onOpenChange: onOpenChange, wide: true, title: done === undefined
+            ? t('companies.newTitle')
+            : t('companies.readyTitle', { name: done.name }), description: done === undefined ? t('companies.newHint') : t('companies.readyHint'), footer: done === undefined ? (_jsxs(_Fragment, { children: [_jsx(Button, { onClick: () => onOpenChange(false), children: t('profile.cancel') }), _jsx(Button, { variant: "primary", busy: create.isPending, disabled: name.trim() === '' || currency === null, onClick: () => create.mutate(), children: t('companies.create') })] })) : (_jsxs(_Fragment, { children: [_jsx(Button, { onClick: () => onOpenChange(false), children: t('companies.close') }), switchCompany === undefined ? null : (_jsx(Button, { variant: "primary", onClick: () => switchCompany(done.id), children: t('companies.switchNow') }))] })), children: done !== undefined ? (_jsxs("div", { className: "grid gap-3", children: [_jsxs("p", { className: "flex items-center gap-2 text-sm font-medium text-success", children: [_jsx(CheckCircle2, { className: "size-4", "aria-hidden": true }), t('companies.created', { name: done.name })] }), done.defaults.length === 0 ? null : (_jsxs("section", { "aria-label": t('companies.setUp'), className: "rounded-md border p-3", children: [_jsx("h3", { className: "mb-2 text-sm font-semibold", children: t('companies.setUp') }), _jsx("ul", { className: "grid gap-1 text-sm", children: done.defaults.map((d) => (_jsxs("li", { className: "flex gap-2", children: [_jsx("span", { className: "min-w-28 font-medium", children: d.module }), _jsx("span", { className: "text-muted-foreground", children: d.summary })] }, d.module))) })] })), _jsx("p", { className: "text-sm text-muted-foreground", children: t('companies.nextSteps') })] })) : (_jsxs("form", { className: "grid gap-6", onSubmit: (e) => {
+                e.preventDefault();
+                if (name.trim() !== '' && currency !== null)
+                    create.mutate();
+            }, children: [_jsxs("fieldset", { className: "grid gap-4", children: [_jsx("legend", { className: "mb-1 text-sm font-semibold", children: t('companies.identity') }), _jsx("p", { className: "-mt-2 text-xs text-muted-foreground", children: t('companies.identityHint') }), _jsxs("div", { className: "grid gap-4 sm:grid-cols-2", children: [_jsxs("div", { className: "grid gap-1.5 sm:col-span-2", children: [_jsxs(Label, { htmlFor: `${id}-name`, children: [t('company.name'), ' ', _jsx("span", { "aria-hidden": true, className: "text-danger", children: "*" })] }), _jsx(Input, { id: `${id}-name`, required: true, "aria-required": true, autoFocus: true, value: name, placeholder: t('companies.namePlaceholder'), onChange: (e) => setName(e.target.value) })] }), _jsxs("div", { className: "grid gap-1.5", children: [_jsxs(Label, { htmlFor: `${id}-currency`, children: [t('companies.currency'), ' ', _jsx("span", { "aria-hidden": true, className: "text-danger", children: "*" })] }), _jsx(Select, { id: `${id}-currency`, label: t('companies.currency'), value: currency, placeholder: t('companies.chooseCurrency'), options: currencies.map((c) => ({ value: String(c.id), label: c.name })), onChange: chooseCurrency }), _jsx("p", { className: "text-xs text-muted-foreground", children: t('companies.currencyHint') })] }), _jsxs("div", { className: "grid gap-1.5", children: [_jsx(Label, { htmlFor: `${id}-grouping`, children: t('company.grouping') }), _jsx(Select, { id: `${id}-grouping`, label: t('company.grouping'), value: grouping, options: [
+                                                { value: 'international', label: t('company.international') },
+                                                { value: 'lakh', label: t('company.lakh') },
+                                            ], onChange: (v) => setGrouping(v === 'lakh' ? 'lakh' : 'international') })] }), _jsxs("div", { className: "grid gap-1.5", children: [_jsx(Label, { htmlFor: `${id}-accent`, children: t('company.brand') }), _jsxs("div", { className: "flex items-center gap-2", children: [_jsx("input", { type: "color", "aria-label": t('company.picker'), className: "h-9 w-12 cursor-pointer rounded border bg-surface", value: accent === '' ? '#4f46e5' : accent, onChange: (e) => setAccent(e.target.value) }), _jsx(Input, { id: `${id}-accent`, value: accent, placeholder: "#4f46e5", onChange: (e) => setAccent(e.target.value.trim()) })] }), _jsx("p", { className: "text-xs text-muted-foreground", children: t('companies.brandHint') })] })] })] }), groups.map((g) => (_jsxs("fieldset", { className: "grid gap-4 border-t pt-4", children: [_jsx("legend", { className: "mb-1 text-sm font-semibold", children: g.title }), _jsx("p", { className: "-mt-2 text-xs text-muted-foreground", children: g.hint }), _jsx("div", { className: "grid gap-4 sm:grid-cols-2", children: g.fields.map(field) })] }, g.key))), _jsxs("div", { className: "flex items-start gap-2 rounded-md bg-muted/60 p-3 text-xs text-muted-foreground", children: [_jsx(Info, { className: "mt-0.5 size-4 shrink-0", "aria-hidden": true }), _jsx("p", { children: t('companies.whatHappens') })] }), create.error === null ? null : _jsx(Alert, { tone: "danger", children: message(create.error) }), _jsx("button", { type: "submit", hidden: true, "aria-hidden": true, tabIndex: -1 })] })) }));
 }
 export function CompaniesPage({ api }) {
     const { t } = useTranslation('settings');
@@ -48,5 +133,5 @@ export function CompaniesPage({ api }) {
     if (list.error !== null)
         return _jsx(Alert, { tone: "danger", children: message(list.error) });
     const data = list.data;
-    return (_jsxs("div", { className: "mx-auto grid max-w-3xl gap-6", children: [_jsxs("header", { className: "flex flex-wrap items-start justify-between gap-3", children: [_jsxs("div", { children: [_jsx("h1", { className: "text-xl font-semibold", children: t('companies.title') }), _jsx("p", { className: "text-sm text-muted-foreground", children: t('companies.intro') })] }), data?.canCreate === true ? (_jsxs(Button, { variant: "primary", onClick: () => setCreating(true), children: [_jsx(Plus, { className: "size-4", "aria-hidden": true }), t('companies.new')] })) : null] }), data === undefined ? (_jsx("p", { className: "text-sm text-muted-foreground", children: "\u2026" })) : (_jsx("ul", { className: "divide-y rounded-lg border bg-surface", children: data.companies.map((c) => (_jsxs("li", { className: "flex flex-wrap items-center gap-3 px-4 py-3", children: [c.logo === null ? (_jsx("span", { "aria-hidden": true, className: "grid size-9 shrink-0 place-items-center rounded-md bg-muted text-muted-foreground", children: _jsx(Building2, { className: "size-4" }) })) : (_jsx(Avatar, { name: c.name, src: imageUrl('company', c.id, c.logo), shape: "square", className: "size-9 border" })), _jsxs("div", { className: "min-w-0 flex-1", children: [_jsxs("p", { className: "flex items-center gap-2 font-medium", children: [_jsx("span", { className: "truncate", children: c.name }), c.current ? _jsx(Badge, { tone: "info", children: t('companies.current') }) : null] }), _jsxs("p", { className: "text-sm text-muted-foreground", children: [c.currency, " \u00B7 ", t('companies.people', { count: c.people })] })] }), c.current || !c.member || switchCompany === undefined ? null : (_jsx(Button, { size: "sm", "aria-label": t('companies.switchTo', { name: c.name }), onClick: () => switchCompany(c.id), children: t('companies.switch') }))] }, c.id))) })), data === undefined ? null : (_jsx(NewCompanyDialog, { api: api, currencies: data.currencies, open: creating, onOpenChange: setCreating }))] }));
+    return (_jsxs("div", { className: "mx-auto grid max-w-3xl gap-6", children: [_jsxs("header", { className: "flex flex-wrap items-start justify-between gap-3", children: [_jsxs("div", { children: [_jsx("h1", { className: "text-xl font-semibold", children: t('companies.title') }), _jsx("p", { className: "text-sm text-muted-foreground", children: t('companies.intro') })] }), data?.canCreate === true ? (_jsxs(Button, { variant: "primary", onClick: () => setCreating(true), children: [_jsx(Plus, { className: "size-4", "aria-hidden": true }), t('companies.new')] })) : null] }), data === undefined ? (_jsx("p", { className: "text-sm text-muted-foreground", children: "\u2026" })) : (_jsx("ul", { className: "divide-y rounded-lg border bg-surface", children: data.companies.map((c) => (_jsxs("li", { className: "flex flex-wrap items-center gap-3 px-4 py-3", children: [c.logo === null ? (_jsx("span", { "aria-hidden": true, className: "grid size-9 shrink-0 place-items-center rounded-md bg-muted text-muted-foreground", children: _jsx(Building2, { className: "size-4" }) })) : (_jsx(Avatar, { name: c.name, src: imageUrl('company', c.id, c.logo), shape: "square", className: "size-9 border" })), _jsxs("div", { className: "min-w-0 flex-1", children: [_jsxs("p", { className: "flex items-center gap-2 font-medium", children: [_jsx("span", { className: "truncate", children: c.name }), c.current ? _jsx(Badge, { tone: "info", children: t('companies.current') }) : null] }), _jsxs("p", { className: "text-sm text-muted-foreground", children: [c.currency, " \u00B7 ", t('companies.people', { count: c.people })] })] }), c.current || !c.member || switchCompany === undefined ? null : (_jsx(Button, { size: "sm", "aria-label": t('companies.switchTo', { name: c.name }), onClick: () => switchCompany(c.id), children: t('companies.switch') }))] }, c.id))) })), data === undefined ? null : (_jsx(NewCompanyDialog, { api: api, currencies: data.currencies, fields: data.fields ?? [], open: creating, onOpenChange: setCreating }))] }));
 }

package/dist/settings/web/messages.js

@@ -357,6 +357,27 @@ export const messages = {
             people_other: '{{count}} people',
             switch: 'Switch',
             switchTo: 'Switch to {{name}}',
+            identity: 'Identity',
+            identityHint: 'How the company is named and counts its money. The currency cannot be changed once it has entries.',
+            namePlaceholder: 'e.g. Padma Traders Ltd.',
+            currencyHint: 'Its books, prices and reports are in this currency.',
+            brandHint: 'The accent of the back-office for everyone working in this company. Empty: the default.',
+            address: 'Address',
+            addressHint: 'Printed on its invoices, orders and letters, and shown in the customer portal.',
+            contact: 'Contact',
+            contactHint: 'How customers and vendors reach it; on its documents and emails.',
+            registration: 'Registration and tax',
+            registrationHint: 'Its identifiers with the authorities, on tax invoices and returns. Fill them in now or later in Settings › Company.',
+            more: 'More',
+            moreHint: 'What the installed apps ask of a company. Everything here can be changed later in Settings › Company.',
+            whatHappens: 'Creating it sets up what each installed app needs — journals, taxes, sequences, defaults — and gives administrators access at once. Give others access in People.',
+            readyTitle: '{{name}} is ready',
+            readyHint: 'Its apps are set up. Switch to it to start working in it.',
+            created: '{{name}} was created.',
+            setUp: 'Set up for it',
+            nextSteps: 'Next: invite its people in People, then check its App settings.',
+            switchNow: 'Switch to it now',
+            close: 'Close',
         },
         apiKeys: {
             title: 'API keys',
@@ -410,6 +431,17 @@ export const messages = {
         enable: 'Enable',
         disable: 'Disable',
         upgrade: 'Upgrade',
+        uninstall: 'Uninstall',
+        doneUninstalled: 'removed {{name}} with its data',
+        planTitleUninstall: 'Uninstall {{name}} and remove its data?',
+        planUninstall: 'Removed with its data',
+        planDrops: 'What is deleted',
+        planDropWhat: 'Table or column',
+        planDropRows: 'Rows',
+        planRemovesData: 'This deletes the app’s data for good. A snapshot is kept for 30 days. To keep the data, disable the app instead.',
+        typeName: 'Type {{name}} to confirm',
+        authCode: 'Code from your authenticator app',
+        confirmUninstall: 'Remove the data',
         installedVersion: 'installed {{version}}',
         planTitleUpgrade: 'Upgrade {{name}}?',
         planUpgrade: 'Will be upgraded',
@@ -796,6 +828,27 @@ export const messages = {
             people_other: '{{count}} জন',
             switch: 'যান',
             switchTo: '{{name}}-এ যান',
+            identity: 'পরিচিতি',
+            identityHint: 'প্রতিষ্ঠানের নাম ও তার হিসাবের মুদ্রা। লেনদেন হয়ে গেলে মুদ্রা আর বদলানো যায় না।',
+            namePlaceholder: 'যেমন: পদ্মা ট্রেডার্স লিমিটেড',
+            currencyHint: 'এর হিসাবের খাতা, মূল্য ও প্রতিবেদন এই মুদ্রায় হবে।',
+            brandHint: 'এই প্রতিষ্ঠানে যাঁরা কাজ করেন, তাঁদের সবার জন্য ব্যাক-অফিসের রং। খালি রাখলে ডিফল্ট রং।',
+            address: 'ঠিকানা',
+            addressHint: 'এর চালান, অর্ডার ও চিঠিতে ছাপা হয় এবং গ্রাহক পোর্টালে দেখা যায়।',
+            contact: 'যোগাযোগ',
+            contactHint: 'গ্রাহক ও সরবরাহকারীরা যেভাবে যোগাযোগ করবেন; এর নথি ও ইমেইলে থাকে।',
+            registration: 'নিবন্ধন ও কর',
+            registrationHint: 'কর্তৃপক্ষের কাছে এর শনাক্তকরণ নম্বর, কর চালান ও রিটার্নে থাকে। এখন বা পরে সেটিংস › প্রতিষ্ঠান থেকে পূরণ করুন।',
+            more: 'আরও',
+            moreHint: 'ইনস্টল করা অ্যাপগুলো প্রতিষ্ঠানের কাছে যা জানতে চায়। এখানকার সবকিছু পরে সেটিংস › প্রতিষ্ঠান থেকে বদলানো যায়।',
+            whatHappens: 'তৈরি করলে প্রতিটি ইনস্টল করা অ্যাপের যা দরকার — জার্নাল, কর, ক্রম, ডিফল্ট — সব প্রস্তুত হয় এবং অ্যাডমিনিস্ট্রেটররা সাথে সাথে প্রবেশাধিকার পান। অন্যদের প্রবেশাধিকার দিন জনবল অংশে।',
+            readyTitle: '{{name}} প্রস্তুত',
+            readyHint: 'এর অ্যাপগুলো প্রস্তুত। কাজ শুরু করতে এতে যান।',
+            created: '{{name}} তৈরি হয়েছে।',
+            setUp: 'এর জন্য যা প্রস্তুত হলো',
+            nextSteps: 'এরপর: জনবল অংশে এর লোকজনকে আমন্ত্রণ জানান, তারপর এর অ্যাপ সেটিংস দেখে নিন।',
+            switchNow: 'এখনই এতে যান',
+            close: 'বন্ধ করুন',
         },
         apiKeys: {
             title: 'এপিআই কী',
@@ -849,6 +902,17 @@ export const messages = {
         enable: 'সক্রিয় করুন',
         disable: 'নিষ্ক্রিয় করুন',
         upgrade: 'আপগ্রেড করুন',
+        uninstall: 'আনইনস্টল',
+        doneUninstalled: '{{name}} তার ডেটাসহ মুছে ফেলা হয়েছে',
+        planTitleUninstall: '{{name}} আনইনস্টল করে এর ডেটা মুছবেন?',
+        planUninstall: 'ডেটাসহ মুছে ফেলা হবে',
+        planDrops: 'যা মুছে যাবে',
+        planDropWhat: 'টেবিল বা কলাম',
+        planDropRows: 'সারি',
+        planRemovesData: 'এতে অ্যাপের ডেটা চিরতরে মুছে যায়। একটি স্ন্যাপশট ৩০ দিন রাখা হয়। ডেটা রাখতে চাইলে বরং অ্যাপটি নিষ্ক্রিয় করুন।',
+        typeName: 'নিশ্চিত করতে {{name}} লিখুন',
+        authCode: 'অথেনটিকেটর অ্যাপের কোড',
+        confirmUninstall: 'ডেটা মুছে ফেলুন',
         installedVersion: 'ইনস্টল করা {{version}}',
         planTitleUpgrade: '{{name}} আপগ্রেড করবেন?',
         planUpgrade: 'যা আপগ্রেড হবে',

package/dist/sign/.kosh/bindings.js

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

@@ -1,4 +1,4 @@
-// GENERATED by `pnpm generate:models` (Shutro’s generator). Do not edit. definitions-hash: d701965c73f7d521
+// GENERATED by `pnpm generate:models` (Shutro’s generator). Do not edit. definitions-hash: 8ba09e2d214cd58d
 // Schema view of module `sign` (RFC 0002 §7.7): the models it owns or depends on, with the extensions it can see.
 import type { F } from '../../server/orm.js';
 
@@ -770,6 +770,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/sign/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/sign/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 field is on a page, inside it.': 'ফিল্ড একটি পাতার উপর, তার ভিতরে থাকে।',
+    'A request is out for signature once sent, and signed when the last signer is done, which seals the PDF.': 'পাঠানোর পর অনুরোধটি স্বাক্ষরের জন্য পাঠানো অবস্থায় থাকে, আর শেষ স্বাক্ষরকারী স্বাক্ষর করলে এটি স্বাক্ষরিত হয় এবং PDF সিল করা হয়।',
+    'A signer has an email address.': 'স্বাক্ষরকারীর একটি ইমেইল ঠিকানা থাকতে হবে।',
+    Active: 'সক্রিয়',
+    Asked: 'অনুরোধ করা হয়েছে',
+    'Asked at': 'অনুরোধের সময়',
+    Browser: 'ব্রাউজার',
+    Cancel: 'বাতিল করুন',
+    'Cancel this request? Its links stop working.': 'এই অনুরোধ বাতিল করবেন? এর লিংকগুলো আর কাজ করবে না।',
+    Cancelled: 'বাতিল',
+    Checkbox: 'চেকবক্স',
+    'Code (hash)': 'কোড (হ্যাশ)',
+    'Code Attempts': 'কোডের চেষ্টা',
+    'Code expires': 'কোডের মেয়াদ শেষ',
+    Company: 'প্রতিষ্ঠান',
+    Completed: 'সম্পন্ন',
+    'Completed at': 'সম্পন্নের সময়',
+    'Created At': 'তৈরির সময়',
+    'Created By': 'তৈরি করেছেন',
+    'Date signed': 'স্বাক্ষরের তারিখ',
+    Description: 'বিবরণ',
+    'Display Name': 'প্রদর্শিত নাম',
+    Document: 'নথি',
+    Draft: 'খসড়া',
+    'Each signer gets a link of their own and confirms with a code sent to their email; in order, the next is asked once the one before has signed.': 'প্রত্যেক স্বাক্ষরকারী নিজস্ব লিংক পান এবং ইমেইলে পাঠানো কোড দিয়ে নিশ্চিত করেন; ক্রমানুসারে হলে আগের জন স্বাক্ষর করার পর পরের জনকে অনুরোধ করা হয়।',
+    Email: 'ইমেইল',
+    Fields: 'ফিল্ড',
+    'For (model)': 'যার জন্য (মডেল)',
+    'For (record)': 'যার জন্য (রেকর্ড)',
+    'Hash after': 'পরের হ্যাশ',
+    'Hash before': 'আগের হ্যাশ',
+    Height: 'উচ্চতা',
+    ID: 'আইডি',
+    'In order': 'ক্রমানুসারে',
+    Initials: 'আদ্যক্ষর',
+    'IP address': 'আইপি ঠিকানা',
+    Kind: 'ধরন',
+    Label: 'লেবেল',
+    'Link (hash)': 'লিংক (হ্যাশ)',
+    'Manager (templates)': 'ব্যবস্থাপক (টেমপ্লেট)',
+    Message: 'বার্তা',
+    Name: 'নাম',
+    'Out for signature': 'স্বাক্ষরের জন্য পাঠানো',
+    Overview: 'সারসংক্ষেপ',
+    Page: 'পাতা',
+    'Page {{page}} of {{pages}}': 'পৃষ্ঠা {{page}} / {{pages}}',
+    Pages: 'পাতা',
+    Partner: 'অংশীদার',
+    PDF: 'PDF',
+    Productivity: 'উৎপাদনশীলতা',
+    Refused: 'নামঞ্জুর',
+    'Refused because': 'নামঞ্জুরের কারণ',
+    Request: 'অনুরোধ',
+    Requests: 'অনুরোধ',
+    'Requests by state': 'অবস্থা অনুযায়ী অনুরোধ',
+    'Requests by template': 'টেমপ্লেট অনুযায়ী অনুরোধ',
+    Required: 'আবশ্যক',
+    Role: 'ভূমিকা',
+    'Send for signature': 'স্বাক্ষরের জন্য পাঠান',
+    Sent: 'পাঠানো',
+    Sequence: 'ক্রম',
+    Sign: 'স্বাক্ষর',
+    'Sign manager': 'স্বাক্ষর ব্যবস্থাপক',
+    'Sign user': 'স্বাক্ষর ব্যবহারকারী',
+    Signature: 'স্বাক্ষর',
+    'Signature request': 'স্বাক্ষরের অনুরোধ',
+    'Signatures in order or all at once, one-time codes, a sealed PDF with its certificate': 'ক্রমানুসারে বা একসাথে স্বাক্ষর, এককালীন কোড, সনদসহ সিলমোহরকৃত PDF',
+    Signed: 'স্বাক্ষরিত',
+    'Signed at': 'স্বাক্ষরের সময়',
+    'Signed by everyone': 'সবাই স্বাক্ষর করেছেন',
+    'Signed PDF': 'স্বাক্ষরিত PDF',
+    Signer: 'স্বাক্ষরকারী',
+    Signers: 'স্বাক্ষরকারীরা',
+    'Signers in order': 'ক্রমানুসারে স্বাক্ষরকারী',
+    'Signing field': 'স্বাক্ষরের ফিল্ড',
+    'Signing request': 'স্বাক্ষরের অনুরোধ',
+    'Signing template': 'স্বাক্ষরের টেমপ্লেট',
+    State: 'অবস্থা',
+    Status: 'অবস্থা',
+    Template: 'টেমপ্লেট',
+    Templates: 'টেমপ্লেট',
+    Text: 'লেখা',
+    'Updated At': 'হালনাগাদের সময়',
+    'Updated By': 'হালনাগাদ করেছেন',
+    'Upload the PDF, then place each field: its page, and where it starts and how big it is as fractions of the page.': 'PDF আপলোড করুন, তারপর প্রতিটি ফিল্ড বসান: তার পাতা, আর পাতার ভগ্নাংশ হিসেবে কোথা থেকে শুরু ও কত বড়।',
+    'User (send requests)': 'ব্যবহারকারী (অনুরোধ পাঠান)',
+    Values: 'মান',
+    Waiting: 'অপেক্ষমাণ',
+    'Waiting for the signers before them, asked once their link is sent, then signed or refused.': 'আগের স্বাক্ষরকারীদের জন্য অপেক্ষমাণ, লিংক পাঠানো হলে অনুরোধ করা হয়েছে, তারপর স্বাক্ষরিত বা নামঞ্জুর।',
+    'What the signer fills in here: a signature, initials, the date signed, a text or a checkbox.': 'স্বাক্ষরকারী এখানে কী পূরণ করবেন: স্বাক্ষর, আদ্যক্ষর, স্বাক্ষরের তারিখ, লেখা বা চেকবক্স।',
+    'Why it was refused': 'কেন নামঞ্জুর করা হয়েছে',
+    Width: 'প্রস্থ',
+    X: 'X',
+    Y: 'Y',
+};

package/dist/sign/index.d.ts

@@ -1,3 +1,18 @@
+/**
+ * @packageDocumentation
+ * `shutro-erp/sign` (RFC 0024 §2.8): the **Sign** app. Templates (a PDF with fields per signer's role), requests from a
+ * template — from any record — with signers in order or all at once, each by email link and a one-time code, signing
+ * in the browser (a phone too), and the PDF sealed with the signatures and a certificate page, stored in Documents
+ * and on the record. pdf-lib (MIT, no native code) stamps and seals.
+ *
+ * - `POST /api/v1/sign/templates/:id/pdf`         the raw body is the template's PDF (managers)
+ * - `POST /api/v1/sign/requests`                  `{ template, model?, id?, ordered?, signers: [{ role, name, email }] }`
+ * - `GET  /api/v1/public/sign/:token`             the signing page
+ * - `GET  /api/v1/public/sign/:token/pdf`         the PDF to sign
+ * - `POST /api/v1/public/sign/:token/code`        a one-time code by email
+ * - `POST /api/v1/public/sign/:token/sign`        `{ code, values: { <field id>: text | true | PNG data URL } }`
+ * - `POST /api/v1/public/sign/:token/refuse`      `{ code, reason }`
+ */
 import { type Mailer } from '../mail/index.js';
 import { defineModule } from '../modules-sdk/index.js';
 export { SignRequest, SignSigner, SignTemplate, SignTemplateField, signShutro } from './module.js';

package/dist/sign/index.js

@@ -19,6 +19,7 @@ import { documents } from '../documents/index.js';
 import { mailerFromEnv } from '../mail/index.js';
 import { messaging } from '../messaging/index.js';
 import { defineModule } from '../modules-sdk/index.js';
+import { reporting } from '../reporting/index.js';
 import { HttpProblem } from '../server/index.js';
 import { storageOf } from '../storage/index.js';
 import { action, form, list, search } from '../views/index.js';
@@ -218,7 +219,7 @@ export function signModule(options = {}) {
     return defineModule({
         shutro: signShutro,
         kosh: '^0.1.0',
-        depends: [contacts, messaging, documents],
+        depends: [contacts, messaging, documents, reporting],
         app: {
             code: 'sign',
             label: 'Sign',
@@ -227,6 +228,133 @@ export function signModule(options = {}) {
             category: 'Productivity',
             summary: 'Signatures in order or all at once, one-time codes, a sealed PDF with its certificate',
         },
+        documents: [
+            {
+                key: 'signature_request',
+                name: 'Signature request',
+                model: 'sign.request',
+                layout: {
+                    paper: 'A4',
+                    header: '{{company.name}}',
+                    footer: 'Page {{page}} of {{pages}}',
+                    blocks: [
+                        { kind: 'heading', id: 'title', text: '{{name}}', level: 1 },
+                        {
+                            kind: 'fields',
+                            id: 'request',
+                            items: [
+                                { label: 'Template', bind: 'template.name' },
+                                { label: 'In order', bind: 'ordered' },
+                                { label: 'Completed', bind: 'completedAt' },
+                                { label: 'Status', bind: 'state' },
+                                { label: 'Refused because', bind: 'refusal' },
+                            ],
+                        },
+                        { kind: 'text', id: 'message', text: '{{message}}' },
+                        {
+                            kind: 'table',
+                            id: 'signers',
+                            bind: 'signers',
+                            columns: [
+                                { label: 'Role', bind: 'role' },
+                                { label: 'Name', bind: 'name' },
+                                { label: 'Email', bind: 'email' },
+                                { label: 'Sent', bind: 'sentAt' },
+                                { label: 'Signed', bind: 'signedAt' },
+                                { label: 'Status', bind: 'state' },
+                            ],
+                        },
+                    ],
+                },
+            },
+        ],
+        importTemplates: [
+            {
+                key: 'sign_template',
+                model: 'sign.template',
+                label: 'Signing template',
+                columns: [
+                    { header: 'Name', field: 'name' },
+                    { header: 'Pages', field: 'pages' },
+                    { header: 'Description', field: 'description' },
+                ],
+            },
+        ],
+        standard: {
+            waive: [
+                {
+                    rule: 'A1',
+                    reason: 'Demo signature requests need a template made from an uploaded PDF, which the demo cannot ship; the app is tried with a document of your own.',
+                },
+                {
+                    rule: 'I1',
+                    model: 'sign.request',
+                    reason: 'Sent from a template to its signers; a file cannot sign.',
+                },
+            ],
+        },
+        // Bangla for the labels it serves (RFC 0023 §3.1; `pnpm i18n:extract`).
+        i18n: { bn: () => import('./i18n/bn.js') },
+        overview: {
+            cards: [
+                {
+                    id: 'out',
+                    title: 'Out for signature',
+                    kind: 'kpi',
+                    model: 'sign.request',
+                    measure: 'count',
+                    filter: { state: 'sent' },
+                    w: 3,
+                },
+                {
+                    id: 'signed',
+                    title: 'Signed',
+                    kind: 'kpi',
+                    model: 'sign.request',
+                    measure: 'count',
+                    filter: { state: 'signed' },
+                    comparison: { field: 'completedAt', mode: 'previous' },
+                    w: 3,
+                },
+                {
+                    id: 'refused',
+                    title: 'Refused',
+                    kind: 'kpi',
+                    model: 'sign.request',
+                    measure: 'count',
+                    filter: { state: 'refused' },
+                    w: 3,
+                },
+                {
+                    id: 'templates',
+                    title: 'Templates',
+                    kind: 'kpi',
+                    model: 'sign.template',
+                    measure: 'count',
+                    w: 3,
+                },
+                {
+                    id: 'by_state',
+                    title: 'Requests by state',
+                    kind: 'chart',
+                    model: 'sign.request',
+                    measure: 'count',
+                    groupBy: 'state',
+                    chart: 'pie',
+                    w: 6,
+                },
+                {
+                    id: 'by_template',
+                    title: 'Requests by template',
+                    kind: 'chart',
+                    model: 'sign.request',
+                    measure: 'count',
+                    groupBy: 'template',
+                    chart: 'bar',
+                    w: 6,
+                },
+            ],
+        },
         accessLevels: {
             user: { label: 'User (send requests)', groups: ['sign.user'] },
             manager: { label: 'Manager (templates)', groups: ['sign.manager'], implies: ['user'] },

package/dist/sign/module.d.ts

@@ -2440,6 +2440,16 @@ export declare const signShutro: import("../server/orm.js").Module<readonly [imp
         readonly hasDefault: false;
         readonly readonly: false;
     }, string>;
+    readonly lang: import("../server/orm.js").SelectionField<"bn" | "en", {
+        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 phone: import("../server/orm.js").CharField<{
         readonly required: false;
         readonly computed: false;
@@ -2661,6 +2671,16 @@ export declare const signShutro: import("../server/orm.js").Module<readonly [imp
         readonly hasDefault: false;
         readonly readonly: false;
     }, string>;
+    readonly lang: import("../server/orm.js").SelectionField<"bn" | "en", {
+        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 phone: import("../server/orm.js").CharField<{
         readonly required: false;
         readonly computed: false;
@@ -4103,6 +4123,16 @@ export declare const signShutro: import("../server/orm.js").Module<readonly [imp
         readonly hasDefault: false;
         readonly readonly: false;
     }, string>;
+    readonly lang: import("../server/orm.js").SelectionField<"bn" | "en", {
+        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 phone: import("../server/orm.js").CharField<{
         readonly required: false;
         readonly computed: false;
@@ -4324,6 +4354,16 @@ export declare const signShutro: import("../server/orm.js").Module<readonly [imp
         readonly hasDefault: false;
         readonly readonly: false;
     }, string>;
+    readonly lang: import("../server/orm.js").SelectionField<"bn" | "en", {
+        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 phone: import("../server/orm.js").CharField<{
         readonly required: false;
         readonly computed: false;