shutro-erp 0.2.0 → 0.3.0

package/dist/portal/.kosh/schema.d.ts

@@ -0,0 +1,346 @@
+// GENERATED by `pnpm generate:models` (Shutro’s generator). Do not edit. definitions-hash: 435daa394f2704fc
+// Schema view of module `portal` (RFC 0002 §7.7): the models it owns or depends on, with the extensions it can see.
+import type { F } from '../../server/orm.js';
+
+/** Model name → model type (RFC 0002 §7.7). */
+export interface SchemaView {
+  readonly 'audit.event': AuditEvent;
+  readonly 'auth.credential': AuthCredential;
+  readonly 'auth.session': AuthSession;
+  readonly 'auth.user_grant': AuthUserGrant;
+  readonly 'auth.user_group': AuthUserGroup;
+  readonly 'kosh.saved_view': KoshSavedView;
+  readonly 'portal.announcement': PortalAnnouncement;
+  readonly 'portal.invitation': PortalInvitation;
+  readonly 'portal.signature': PortalSignature;
+  readonly 'res.company': ResCompany;
+  readonly 'res.currency': ResCurrency;
+  readonly 'res.partner': ResPartner;
+  readonly 'res.users': ResUsers;
+}
+
+/** `audit.event` (owner: base). */
+export interface AuditEvent {
+  readonly name: 'audit.event';
+  readonly fields: {
+    readonly id: F.Id<'audit.event'>;
+    readonly createdAt: F.Datetime<{ readonly required: true; readonly readonly: true }>;
+    readonly updatedAt: F.Datetime<{ readonly required: true; readonly readonly: true }>;
+    readonly createdBy: F.Many2one<'res.users', { readonly readonly: true }>;
+    readonly updatedBy: F.Many2one<'res.users', { readonly readonly: true }>;
+    readonly displayName: F.Char<{ readonly required: true; readonly readonly: true; readonly compute: true }>;
+    readonly kind: F.Char<{ readonly required: true }>;
+    readonly actor: F.Many2one<'res.users'>;
+    readonly company: F.Many2one<'res.company'>;
+    readonly targetModel: F.Char;
+    readonly targetId: F.Integer;
+    readonly summary: F.Char<{ readonly required: true }>;
+    readonly details: F.Json;
+    readonly ip: F.Char;
+  };
+  readonly methods: AuditEventMethods;
+}
+
+/** Methods of `audit.event`: declared ones and transitions. */
+export interface AuditEventMethods extends F.Methods<typeof import('../../server/index.js').baseShutro, 'audit.event'> {
+}
+
+/** `auth.credential` (owner: base). */
+export interface AuthCredential {
+  readonly name: 'auth.credential';
+  readonly fields: {
+    readonly id: F.Id<'auth.credential'>;
+    readonly createdAt: F.Datetime<{ readonly required: true; readonly readonly: true }>;
+    readonly updatedAt: F.Datetime<{ readonly required: true; readonly readonly: true }>;
+    readonly createdBy: F.Many2one<'res.users', { readonly readonly: true }>;
+    readonly updatedBy: F.Many2one<'res.users', { readonly readonly: true }>;
+    readonly displayName: F.Char<{ readonly required: true; readonly readonly: true; readonly compute: true }>;
+    readonly user: F.Many2one<'res.users', { readonly required: true }>;
+    readonly passwordHash: F.Char;
+    readonly totpSecret: F.Char;
+    readonly totpEnabled: F.Bool<{ readonly required: true; readonly default: true }>;
+    readonly recoveryCodes: F.Json;
+  };
+  readonly methods: AuthCredentialMethods;
+}
+
+/** Methods of `auth.credential`: declared ones and transitions. */
+export interface AuthCredentialMethods extends F.Methods<typeof import('../../server/index.js').baseShutro, 'auth.credential'> {
+}
+
+/** `auth.session` (owner: base). */
+export interface AuthSession {
+  readonly name: 'auth.session';
+  readonly fields: {
+    readonly id: F.Id<'auth.session'>;
+    readonly createdAt: F.Datetime<{ readonly required: true; readonly readonly: true }>;
+    readonly updatedAt: F.Datetime<{ readonly required: true; readonly readonly: true }>;
+    readonly createdBy: F.Many2one<'res.users', { readonly readonly: true }>;
+    readonly updatedBy: F.Many2one<'res.users', { readonly readonly: true }>;
+    readonly displayName: F.Char<{ readonly required: true; readonly readonly: true; readonly compute: true }>;
+    readonly tokenHash: F.Char<{ readonly required: true }>;
+    readonly csrfHash: F.Char<{ readonly required: true }>;
+    readonly user: F.Many2one<'res.users', { readonly required: true }>;
+    readonly twoFactorVerified: F.Bool<{ readonly required: true; readonly default: true }>;
+    readonly secondFactor: F.Bool<{ readonly required: true; readonly default: true }>;
+    readonly expiresAt: F.Datetime<{ readonly required: true }>;
+    readonly lastSeenAt: F.Datetime<{ readonly required: true }>;
+    readonly revoked: F.Bool<{ readonly required: true; readonly default: true }>;
+    readonly ip: F.Char;
+    readonly userAgent: F.Char;
+  };
+  readonly methods: AuthSessionMethods;
+}
+
+/** Methods of `auth.session`: declared ones and transitions. */
+export interface AuthSessionMethods extends F.Methods<typeof import('../../server/index.js').baseShutro, 'auth.session'> {
+}
+
+/** `auth.user_grant` (owner: base). */
+export interface AuthUserGrant {
+  readonly name: 'auth.user_grant';
+  readonly fields: {
+    readonly id: F.Id<'auth.user_grant'>;
+    readonly createdAt: F.Datetime<{ readonly required: true; readonly readonly: true }>;
+    readonly updatedAt: F.Datetime<{ readonly required: true; readonly readonly: true }>;
+    readonly createdBy: F.Many2one<'res.users', { readonly readonly: true }>;
+    readonly updatedBy: F.Many2one<'res.users', { readonly readonly: true }>;
+    readonly displayName: F.Char<{ readonly required: true; readonly readonly: true; readonly compute: true }>;
+    readonly user: F.Many2one<'res.users', { readonly required: true }>;
+    readonly company: F.Many2one<'res.company'>;
+    readonly grant: F.Char<{ readonly required: true }>;
+    readonly expiresAt: F.Datetime;
+    readonly reason: F.Char<{ readonly required: true }>;
+  };
+  readonly methods: AuthUserGrantMethods;
+}
+
+/** Methods of `auth.user_grant`: declared ones and transitions. */
+export interface AuthUserGrantMethods extends F.Methods<typeof import('../../server/index.js').baseShutro, 'auth.user_grant'> {
+}
+
+/** `auth.user_group` (owner: base). */
+export interface AuthUserGroup {
+  readonly name: 'auth.user_group';
+  readonly fields: {
+    readonly id: F.Id<'auth.user_group'>;
+    readonly createdAt: F.Datetime<{ readonly required: true; readonly readonly: true }>;
+    readonly updatedAt: F.Datetime<{ readonly required: true; readonly readonly: true }>;
+    readonly createdBy: F.Many2one<'res.users', { readonly readonly: true }>;
+    readonly updatedBy: F.Many2one<'res.users', { readonly readonly: true }>;
+    readonly displayName: F.Char<{ readonly required: true; readonly readonly: true; readonly compute: true }>;
+    readonly user: F.Many2one<'res.users', { readonly required: true }>;
+    readonly company: F.Many2one<'res.company'>;
+    readonly group: F.Char<{ readonly required: true }>;
+  };
+  readonly methods: AuthUserGroupMethods;
+}
+
+/** Methods of `auth.user_group`: declared ones and transitions. */
+export interface AuthUserGroupMethods extends F.Methods<typeof import('../../server/index.js').baseShutro, 'auth.user_group'> {
+}
+
+/** `kosh.saved_view` (owner: base). */
+export interface KoshSavedView {
+  readonly name: 'kosh.saved_view';
+  readonly fields: {
+    readonly id: F.Id<'kosh.saved_view'>;
+    readonly createdAt: F.Datetime<{ readonly required: true; readonly readonly: true }>;
+    readonly updatedAt: F.Datetime<{ readonly required: true; readonly readonly: true }>;
+    readonly createdBy: F.Many2one<'res.users', { readonly readonly: true }>;
+    readonly updatedBy: F.Many2one<'res.users', { readonly readonly: true }>;
+    readonly displayName: F.Char<{ readonly required: true; readonly readonly: true; readonly compute: true }>;
+    readonly name: F.Char<{ readonly required: true }>;
+    readonly targetModel: F.Char<{ readonly required: true }>;
+    readonly viewType: F.Char<{ readonly required: true; readonly default: true }>;
+    readonly state: F.Json<unknown, { readonly required: true }>;
+    readonly shared: F.Bool<{ readonly required: true; readonly default: true }>;
+    readonly isDefault: F.Bool<{ readonly required: true; readonly default: true }>;
+  };
+  readonly methods: KoshSavedViewMethods;
+}
+
+/** Methods of `kosh.saved_view`: declared ones and transitions. */
+export interface KoshSavedViewMethods extends F.Methods<typeof import('../../server/index.js').baseShutro, 'kosh.saved_view'> {
+}
+
+/** `portal.announcement` (owner: portal). */
+export interface PortalAnnouncement {
+  readonly name: 'portal.announcement';
+  readonly fields: {
+    readonly id: F.Id<'portal.announcement'>;
+    readonly createdAt: F.Datetime<{ readonly required: true; readonly readonly: true }>;
+    readonly updatedAt: F.Datetime<{ readonly required: true; readonly readonly: true }>;
+    readonly createdBy: F.Many2one<'res.users', { readonly readonly: true }>;
+    readonly updatedBy: F.Many2one<'res.users', { readonly readonly: true }>;
+    readonly displayName: F.Char<{ readonly required: true; readonly readonly: true; readonly compute: true }>;
+    readonly resModel: F.Char<{ readonly required: true }>;
+    readonly resId: F.Integer<{ readonly required: true }>;
+    readonly document: F.Char<{ readonly required: true }>;
+    readonly recipients: F.Integer<{ readonly required: true; readonly default: true }>;
+  };
+  readonly methods: PortalAnnouncementMethods;
+}
+
+/** Methods of `portal.announcement`: declared ones and transitions. */
+export interface PortalAnnouncementMethods extends F.Methods<typeof import('../module.js').portalShutro, 'portal.announcement'> {
+}
+
+/** `portal.invitation` (owner: portal). */
+export interface PortalInvitation {
+  readonly name: 'portal.invitation';
+  readonly fields: {
+    readonly id: F.Id<'portal.invitation'>;
+    readonly createdAt: F.Datetime<{ readonly required: true; readonly readonly: true }>;
+    readonly updatedAt: F.Datetime<{ readonly required: true; readonly readonly: true }>;
+    readonly createdBy: F.Many2one<'res.users', { readonly readonly: true }>;
+    readonly updatedBy: F.Many2one<'res.users', { readonly readonly: true }>;
+    readonly displayName: F.Char<{ readonly required: true; readonly readonly: true; readonly compute: true }>;
+    readonly user: F.Many2one<'res.users', { readonly required: true }>;
+    readonly tokenHash: F.Char<{ readonly required: true }>;
+    readonly expiresAt: F.Datetime<{ readonly required: true }>;
+    readonly usedAt: F.Datetime;
+    readonly invitedBy: F.Many2one<'res.users'>;
+  };
+  readonly methods: PortalInvitationMethods;
+}
+
+/** Methods of `portal.invitation`: declared ones and transitions. */
+export interface PortalInvitationMethods extends F.Methods<typeof import('../module.js').portalShutro, 'portal.invitation'> {
+}
+
+/** `portal.signature` (owner: portal). */
+export interface PortalSignature {
+  readonly name: 'portal.signature';
+  readonly fields: {
+    readonly id: F.Id<'portal.signature'>;
+    readonly createdAt: F.Datetime<{ readonly required: true; readonly readonly: true }>;
+    readonly updatedAt: F.Datetime<{ readonly required: true; readonly readonly: true }>;
+    readonly createdBy: F.Many2one<'res.users', { readonly readonly: true }>;
+    readonly updatedBy: F.Many2one<'res.users', { readonly readonly: true }>;
+    readonly displayName: F.Char<{ readonly required: true; readonly readonly: true; readonly compute: true }>;
+    readonly company: F.Many2one<'res.company', { readonly required: true; readonly default: true }>;
+    readonly resModel: F.Char<{ readonly required: true }>;
+    readonly resId: F.Integer<{ readonly required: true }>;
+    readonly action: F.Char<{ readonly required: true }>;
+    readonly user: F.Many2one<'res.users', { readonly required: true }>;
+    readonly signedName: F.Char<{ readonly required: true }>;
+    readonly image: F.Binary;
+    readonly documentHash: F.Char<{ readonly required: true }>;
+    readonly ip: F.Char;
+  };
+  readonly methods: PortalSignatureMethods;
+}
+
+/** Methods of `portal.signature`: declared ones and transitions. */
+export interface PortalSignatureMethods extends F.Methods<typeof import('../module.js').portalShutro, 'portal.signature'> {
+}
+
+/** `res.company` (owner: base). */
+export interface ResCompany {
+  readonly name: 'res.company';
+  readonly fields: {
+    readonly id: F.Id<'res.company'>;
+    readonly createdAt: F.Datetime<{ readonly required: true; readonly readonly: true }>;
+    readonly updatedAt: F.Datetime<{ readonly required: true; readonly readonly: true }>;
+    readonly createdBy: F.Many2one<'res.users', { readonly readonly: true }>;
+    readonly updatedBy: F.Many2one<'res.users', { readonly readonly: true }>;
+    readonly displayName: F.Char<{ readonly required: true; readonly readonly: true; readonly compute: true }>;
+    readonly name: F.Char<{ readonly required: true }>;
+    readonly currency: F.Many2one<'res.currency', { readonly required: true }>;
+    readonly numberGrouping: F.Selection<'international' | 'lakh', { readonly required: true; readonly default: true }>;
+  };
+  readonly methods: ResCompanyMethods;
+}
+
+/** Methods of `res.company`: declared ones and transitions. */
+export interface ResCompanyMethods extends F.Methods<typeof import('../../server/index.js').baseShutro, 'res.company'> {
+}
+
+/** `res.currency` (owner: base). */
+export interface ResCurrency {
+  readonly name: 'res.currency';
+  readonly fields: {
+    readonly id: F.Id<'res.currency'>;
+    readonly createdAt: F.Datetime<{ readonly required: true; readonly readonly: true }>;
+    readonly updatedAt: F.Datetime<{ readonly required: true; readonly readonly: true }>;
+    readonly createdBy: F.Many2one<'res.users', { readonly readonly: true }>;
+    readonly updatedBy: F.Many2one<'res.users', { readonly readonly: true }>;
+    readonly displayName: F.Char<{ readonly required: true; readonly readonly: true; readonly compute: true }>;
+    readonly name: F.Char<{ readonly required: true }>;
+    readonly rounding: F.Decimal<{ readonly required: true; readonly default: true }>;
+    readonly decimalPlaces: F.Integer<{ readonly default: true }>;
+  };
+  readonly methods: ResCurrencyMethods;
+}
+
+/** Methods of `res.currency`: declared ones and transitions. */
+export interface ResCurrencyMethods extends F.Methods<typeof import('../../server/index.js').baseShutro, 'res.currency'> {
+}
+
+/** `res.partner` (owner: contacts; extended by: portal). */
+export interface ResPartner {
+  readonly name: 'res.partner';
+  readonly fields: {
+    readonly id: F.Id<'res.partner'>;
+    readonly createdAt: F.Datetime<{ readonly required: true; readonly readonly: true }>;
+    readonly updatedAt: F.Datetime<{ readonly required: true; readonly readonly: true }>;
+    readonly createdBy: F.Many2one<'res.users', { readonly readonly: true }>;
+    readonly updatedBy: F.Many2one<'res.users', { readonly readonly: true }>;
+    readonly displayName: F.Char<{ readonly required: true; readonly readonly: true; readonly compute: true }>;
+    readonly active: F.Bool<{ readonly required: true; readonly default: true }>;
+    readonly company: F.Many2one<'res.company', { readonly default: true }>;
+    readonly name: F.Char<{ readonly required: true }>;
+    readonly isCompany: F.Bool<{ readonly required: true; readonly default: true }>;
+    readonly parent: F.Many2one<'res.partner'>;
+    readonly contacts: F.One2many<'res.partner', { readonly required: true }>;
+    readonly email: F.Char;
+    readonly phone: F.Char;
+    readonly mobile: F.Char;
+    readonly website: F.Char;
+    readonly street: F.Char;
+    readonly city: F.Char;
+    readonly zip: F.Char;
+    readonly country: F.Char;
+    readonly state: F.Char;
+    readonly taxId: F.Char;
+    readonly isCustomer: F.Bool<{ readonly required: true; readonly default: true }>;
+    readonly isVendor: F.Bool<{ readonly required: true; readonly default: true }>;
+    readonly currency: F.Many2one<'res.currency'>;
+    readonly notes: F.Text;
+    readonly portalUsers: F.One2many<'res.users', { readonly required: true }>; // portal
+  };
+  readonly methods: ResPartnerMethods;
+}
+
+/** Methods of `res.partner`: declared ones and transitions. */
+export interface ResPartnerMethods extends F.Methods<typeof import('../../contacts/index.js').contactsShutro, 'res.partner'>, F.Methods<typeof import('../module.js').portalShutro, 'res.partner'> {
+}
+
+/** `res.users` (owner: base; extended by: portal). */
+export interface ResUsers {
+  readonly name: 'res.users';
+  readonly fields: {
+    readonly id: F.Id<'res.users'>;
+    readonly createdAt: F.Datetime<{ readonly required: true; readonly readonly: true }>;
+    readonly updatedAt: F.Datetime<{ readonly required: true; readonly readonly: true }>;
+    readonly createdBy: F.Many2one<'res.users', { readonly readonly: true }>;
+    readonly updatedBy: F.Many2one<'res.users', { readonly readonly: true }>;
+    readonly displayName: F.Char<{ readonly required: true; readonly readonly: true; readonly compute: true }>;
+    readonly active: F.Bool<{ readonly required: true; readonly default: true }>;
+    readonly login: F.Char<{ readonly required: true }>;
+    readonly name: F.Char<{ readonly required: true }>;
+    readonly email: F.Char;
+    readonly phone: F.Char;
+    readonly company: F.Many2one<'res.company'>;
+    readonly companies: F.Many2many<'res.company', { readonly required: true }>;
+    readonly lang: F.Char<{ readonly default: true }>;
+    readonly tz: F.Char<{ readonly default: true }>;
+    readonly portalPartner: F.Many2one<'res.partner'>; // portal
+  };
+  readonly methods: ResUsersMethods;
+}
+
+/** Methods of `res.users`: declared ones and transitions. */
+export interface ResUsersMethods extends F.Methods<typeof import('../../server/index.js').baseShutro, 'res.users'>, F.Methods<typeof import('../module.js').portalShutro, 'res.users'> {
+}

package/dist/portal/announce.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Telling customers about new documents (RFC 0015 §5.7): when a record enters a declared document's `announce`
+ * domain (a quotation sent, an invoice posted), the portal users who can see it get an email with a link to it in
+ * the portal — once per record and document type (`portal.announcement`). It reads Shutro's `record.changed`
+ * events, so the models must be in a module's `changeEvents` (the bridges list theirs).
+ */
+import { type Mailer } from '../mail/index.js';
+import { type ModuleContext } from '../server/index.js';
+import type { Worker } from '../server/orm.js';
+/** The topic of Shutro's change events. */
+export declare const CHANGE_TOPIC = "record.changed";
+/** The subscriber that announces documents; `start()` it (the module does), tests `drain()` it. */
+export declare function portalAnnouncer(context: ModuleContext, options: {
+    readonly portalUrl: string;
+    readonly mailer?: Mailer | undefined;
+}): Worker;

package/dist/portal/announce.js

@@ -0,0 +1,117 @@
+/**
+ * Telling customers about new documents (RFC 0015 §5.7): when a record enters a declared document's `announce`
+ * domain (a quotation sent, an invoice posted), the portal users who can see it get an email with a link to it in
+ * the portal — once per record and document type (`portal.announcement`). It reads Shutro's `record.changed`
+ * events, so the models must be in a module's `changeEvents` (the bridges list theirs).
+ */
+import { layout } from '../mail/index.js';
+import { publicApiModels } from '../server/index.js';
+import { portalDocuments } from './documents.js';
+const ref = (env, name) => env.model(name);
+/** The topic of Shutro's change events. */
+export const CHANGE_TOPIC = 'record.changed';
+const TEXTS = {
+    en: {
+        intro: (label, name) => `A new document is ready for you: ${label} ${name}.`,
+        open: 'Open it in the portal',
+    },
+    bn: {
+        intro: (label, name) => `আপনার জন্য একটি নতুন নথি প্রস্তুত: ${label} ${name}।`,
+        open: 'পোর্টালে খুলুন',
+    },
+};
+/** The contact a record is for (following a path such as `project.partner`), or null. */
+async function partnerOf(su, models, model, id, path) {
+    let currentModel = model;
+    let currentId = id;
+    for (const segment of path.split('.')) {
+        const loaded = await ref(su, currentModel).browse([currentId]).load([segment]);
+        const rows = loaded.read([segment]);
+        const next = rows[0]?.[segment];
+        const target = models.get(currentModel)?.byKey.get(segment)?.target ?? null;
+        if (typeof next !== 'number' || target === null)
+            return null;
+        currentModel = target;
+        currentId = next;
+    }
+    return currentId;
+}
+/** The active portal users who see documents of `partner`: theirs, their company's, their colleagues'. */
+async function recipientsOf(su, partner) {
+    const [row] = (await ref(su, 'res.partner').browse([partner]).load(['parent'])).read(['parent']);
+    const company = typeof row?.['parent'] === 'number' ? row['parent'] : null;
+    const heads = company === null ? [partner] : [partner, company];
+    const people = await ref(su, 'res.partner').search({ where: { parent: { in: heads } } });
+    const partners = [...new Set([...heads, ...people.ids])];
+    const users = await ref(su, 'res.users').search({
+        where: { portalPartner: { in: partners }, active: true },
+    });
+    return (await users.load(['login', 'name', 'lang'])).read(['login', 'name', 'lang']);
+}
+/** The subscriber that announces documents; `start()` it (the module does), tests `drain()` it. */
+export function portalAnnouncer(context, options) {
+    const models = publicApiModels(context.registry);
+    const announced = [...portalDocuments(context.registry).values()].filter((d) => d.spec.announce !== undefined);
+    return context.shutro.subscribe('portal.announce', CHANGE_TOPIC, async (event, env) => {
+        const payload = (event.payload ?? {});
+        const model = String(payload['model'] ?? '');
+        const ids = Array.isArray(payload['ids'])
+            ? payload['ids'].filter((i) => typeof i === 'number')
+            : [];
+        const documents = announced.filter((d) => d.model.name === model);
+        if (documents.length === 0 || ids.length === 0)
+            return;
+        await env.asSuperuser({ reason: 'portal announcement' }, async (su) => {
+            for (const d of documents) {
+                const found = await ref(su, model).search({
+                    where: { and: [{ id: { in: ids } }, d.spec.domain ?? {}, d.spec.announce] },
+                });
+                for (const id of found.ids) {
+                    const already = await ref(su, 'portal.announcement').search({
+                        where: { resModel: model, resId: id, document: d.spec.key },
+                        limit: 1,
+                    });
+                    if (already.length > 0)
+                        continue;
+                    const partner = await partnerOf(su, models, model, id, d.spec.partner);
+                    const users = partner === null ? [] : await recipientsOf(su, partner);
+                    await ref(su, 'portal.announcement').create([
+                        { resModel: model, resId: id, document: d.spec.key, recipients: users.length },
+                    ]);
+                    const mailer = options.mailer;
+                    if (mailer === undefined || users.length === 0)
+                        continue;
+                    const [record] = (await ref(su, model).browse([id]).load(['displayName'])).read([
+                        'displayName',
+                    ]);
+                    const [company] = (await ref(su, 'res.company').browse([env.companyId]).load(['name'])).read(['name']);
+                    const name = String(record?.['displayName'] ?? `#${id}`);
+                    const from = String(company?.['name'] ?? '');
+                    const url = `${options.portalUrl.replace(/\/$/, '')}/d/${d.spec.key}/${id}`;
+                    const mails = users.map((u) => {
+                        const texts = String(u['lang'] ?? '').startsWith('bn') ? TEXTS.bn : TEXTS.en;
+                        const subject = `${from}: ${d.spec.label} ${name}`;
+                        return {
+                            to: String(u['login']),
+                            subject,
+                            ...layout({
+                                title: subject,
+                                paragraphs: [texts.intro(d.spec.label, name)],
+                                action: { label: texts.open, url },
+                                lang: String(u['lang'] ?? 'en').slice(0, 2),
+                            }),
+                        };
+                    });
+                    // Sent once the announcement is committed; a failed send is logged, not retried.
+                    env.afterCommit(async () => {
+                        for (const mail of mails)
+                            await mailer
+                                .send(mail)
+                                .catch((error) => context.app.log.error({ err: error }, 'portal announcement not sent'));
+                    });
+                }
+            }
+            await su.flush();
+        });
+    }, { pollMs: 5000 });
+}

package/dist/portal/documents.d.ts

@@ -0,0 +1,17 @@
+/**
+ * The portal's catalogue (RFC 0015 §5.3): the documents the installed modules declare, checked when the server
+ * starts. Every declared model, field, line field, transition and template must exist, and the model must give
+ * `portal.user` read access with a record rule, so a declaration can never show a document without the rule that
+ * keeps it to its customer.
+ */
+import type { PortalDocumentSpec } from '../modules-sdk/index.js';
+import { type ApiModel, type KoshRegistry } from '../server/index.js';
+/** A declared document with the models it reads. */
+export interface PortalDocument {
+    readonly spec: PortalDocumentSpec;
+    readonly model: ApiModel;
+    /** The lines' model, when the document has lines. */
+    readonly lineModel: ApiModel | null;
+}
+/** The documents of the loaded modules, by key. @throws {ServerConfigError} for a declaration that cannot work */
+export declare function portalDocuments(registry: KoshRegistry): ReadonlyMap<string, PortalDocument>;

package/dist/portal/documents.js

@@ -0,0 +1,61 @@
+import { publicApiModels, ServerConfigError } from '../server/index.js';
+const fail = (key, problem, hint) => {
+    throw new ServerConfigError(`Portal document '${key}': ${problem}`, hint);
+};
+/** The documents of the loaded modules, by key. @throws {ServerConfigError} for a declaration that cannot work */
+export function portalDocuments(registry) {
+    const models = publicApiModels(registry);
+    const out = new Map();
+    const templates = new Set(registry.loaded.modules.flatMap((m) => (m.documents ?? []).map((d) => `${m.name}.${d.key}`)));
+    for (const module of registry.loaded.modules)
+        for (const spec of module.portal?.documents ?? []) {
+            const key = spec.key;
+            if (out.has(key))
+                fail(key, `declared twice (again by ${module.name}).`, 'Document keys are unique.');
+            const model = models.get(spec.model);
+            if (model === undefined)
+                fail(key, `no served model '${spec.model}'.`, 'Declare a model of an installed module.');
+            const m = model;
+            const definition = registry.registry.get(spec.model).model;
+            const access = definition.access['portal.user'];
+            const ruled = Object.values(definition.rules).some((r) => r.groups !== 'global' && r.groups.includes('portal.user') && r.perms.includes('read'));
+            if (access?.includes('read') !== true || !ruled)
+                fail(key, `${spec.model} gives portal.user no read access with a record rule.`, "Extend the model in the bridge: access { 'portal.user': ['read'] } and rules { portal: portalRule('partner') }.");
+            // The customer: a many2one to res.partner, directly or through many2ones (`project.partner`).
+            let hop = m;
+            let target = null;
+            for (const segment of spec.partner.split('.')) {
+                const field = hop?.byKey.get(segment);
+                if (field?.kind !== 'many2one' || field.target === null) {
+                    target = null;
+                    break;
+                }
+                target = field.target;
+                hop = models.get(field.target);
+            }
+            if (target !== 'res.partner')
+                fail(key, `'${spec.partner}' does not lead to res.partner.`, 'Name the customer field.');
+            for (const field of [...spec.list, ...spec.fields])
+                if (!m.byKey.has(field))
+                    fail(key, `${spec.model} has no field '${field}'.`, 'Declare existing fields.');
+            let lineModel = null;
+            if (spec.lines !== undefined) {
+                const lines = m.byKey.get(spec.lines.field);
+                if (lines?.kind !== 'one2many' || lines.target === null)
+                    fail(key, `'${spec.lines.field}' is not a one2many.`, 'Name the lines field.');
+                lineModel = models.get(lines?.target ?? '') ?? null;
+                if (lineModel === null)
+                    fail(key, `the lines' model ${lines?.target} is not served.`, 'Use a served model.');
+                for (const field of spec.lines.fields)
+                    if (!lineModel.byKey.has(field))
+                        fail(key, `${lines?.target} has no field '${field}'.`, 'Declare existing line fields.');
+            }
+            for (const action of spec.actions ?? [])
+                if (!m.transitions.includes(action.transition))
+                    fail(key, `${spec.model} has no transition '${action.transition}' (action '${action.key}').`, `Transitions: ${m.transitions.join(', ') || 'none'}.`);
+            if (spec.pdf !== undefined && !templates.has(spec.pdf))
+                fail(key, `no document template '${spec.pdf}'.`, 'Name a template a module ships (module.key).');
+            out.set(key, { spec, model: m, lineModel });
+        }
+    return out;
+}

package/dist/portal/index.d.ts

@@ -0,0 +1,20 @@
+import { type KoshModule } from '../modules-sdk/index.js';
+import { type PortalRoutesOptions } from './routes.js';
+export { CHANGE_TOPIC, portalAnnouncer } from './announce.js';
+export { type PortalDocument, portalDocuments } from './documents.js';
+export { PartnerPortalUsers, PortalInvitation, PortalSignature, portalShutro, UserPortalPartner, } from './module.js';
+export { INVITATION_DAYS, PORTAL_USER, type PortalRoutesOptions, registerPortalRoutes, } from './routes.js';
+export { registerPortalDocumentRoutes } from './routes-documents.js';
+export { portalRule } from './rules.js';
+/** Package identity. */
+export declare const PACKAGE: {
+    readonly name: string;
+    readonly rfc: string;
+};
+/** The portal module with explicit options (tests): its URL and mailer. */
+export declare function createPortal(options?: Partial<PortalRoutesOptions> & {
+    /** Announce new documents in this process (default: unless `KOSH_SCHEDULES=off`). */
+    readonly workers?: boolean;
+}): KoshModule;
+/** The portal, configured from the environment (`KOSH_PORTAL_URL`, `SMTP_URL`). */
+export declare const portal: KoshModule;

package/dist/portal/index.js

@@ -0,0 +1,65 @@
+/**
+ * @packageDocumentation
+ * `shutro-erp/portal` (RFC 0015): the customer and vendor portal. Step 1 is who a portal user is — a user of one contact,
+ * holding only `portal.user`, kept to the portal's API by the server — and how they get in: an invitation from a
+ * portal access manager, a one-time link to choose a password, and revocation.
+ */
+import { contacts } from '../contacts/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 { base } from '../server/index.js';
+import { portalAnnouncer } from './announce.js';
+import { portalShutro } from './module.js';
+import { registerPortalRoutes } from './routes.js';
+import { registerPortalDocumentRoutes } from './routes-documents.js';
+export { CHANGE_TOPIC, portalAnnouncer } from './announce.js';
+export { portalDocuments } from './documents.js';
+export { PartnerPortalUsers, PortalInvitation, PortalSignature, portalShutro, UserPortalPartner, } from './module.js';
+export { INVITATION_DAYS, PORTAL_USER, registerPortalRoutes, } from './routes.js';
+export { registerPortalDocumentRoutes } from './routes-documents.js';
+export { portalRule } from './rules.js';
+/** Package identity. */
+export const PACKAGE = Object.freeze({
+    name: 'shutro-erp/portal',
+    rfc: 'RFC 0015',
+});
+/** The portal module with explicit options (tests): its URL and mailer. */
+export function createPortal(options = {}) {
+    return defineModule({
+        shutro: portalShutro,
+        kosh: '^0.1.0',
+        depends: [base, contacts, messaging, reporting],
+        accessLevels: { manager: { label: 'Portal access', groups: ['portal.manager'] } },
+        externalGroups: ['portal.user'],
+        privateModels: ['portal.invitation', 'portal.signature'],
+        // "Portal access" on the contact form, under the ways to reach them.
+        viewExtensions: [
+            {
+                view: 'res.partner.form',
+                operations: [
+                    {
+                        insertAfter: 'reach',
+                        nodes: [{ kind: 'component', id: 'portal_access', component: 'portal.Access' }],
+                    },
+                ],
+            },
+        ],
+        routes: (context) => {
+            const delivery = {
+                portalUrl: options.portalUrl ?? process.env['KOSH_PORTAL_URL'] ?? 'http://localhost:5174',
+                mailer: 'mailer' in options ? options.mailer : mailerFromEnv(),
+            };
+            registerPortalRoutes(context, delivery);
+            registerPortalDocumentRoutes(context);
+            if (!(options.workers ?? process.env['KOSH_SCHEDULES'] !== 'off'))
+                return;
+            const announcer = portalAnnouncer(context, delivery);
+            announcer.start();
+            context.app.addHook('onClose', () => announcer.stop());
+        },
+    });
+}
+/** The portal, configured from the environment (`KOSH_PORTAL_URL`, `SMTP_URL`). */
+export const portal = createPortal();