shutro-erp 0.3.1 → 0.3.3

package/dist/settings/index.js

@@ -1,51 +1,180 @@
 /**
  * @packageDocumentation
- * `shutro-erp/settings` (RFC 0008): the Settings app. Its App manager lists the installed, disabled and available apps and
- * installs, enables or disables them (`/api/v1/settings/apps`, the Settings → Apps page). Every installation has it;
- * it cannot be disabled. Changing apps needs the Administrator role or the `settings.apps` access level.
+ * `shutro-erp/settings` (RFC 0008, RFC 0019): the Settings app. Its App manager lists the installed, disabled and
+ * available apps and installs, enables or disables them (`/api/v1/settings/apps`); it cannot be disabled. Changing
+ * apps needs the Administrator role or the `settings.apps` access level. Its Company page sets the current company's
+ * name, number grouping, brand colour and details, and Companies lists them, switches and adds one (`settings.company`, RFC 0018,
+ * RFC 0019 §3.4). People (RFC 0019 §3.2) invites, deactivates
+ * and gives roles to the installation's users (`settings.people`).
  */
+import { mailerFromEnv } from '../mail/index.js';
 import { defineModule } from '../modules-sdk/index.js';
 import { base, baseShutro } from '../server/index.js';
 import { orm } from '../server/orm.js';
+import { registerCompanyRoutes } from './company.js';
+import { registerPeopleRoutes } from './people.js';
 import { registerAppRoutes } from './routes.js';
+import { registerSecurityRoutes } from './security.js';
+export { registerCompanyRoutes } from './company.js';
+export { INVITATION_DAYS, registerPeopleRoutes, } from './people.js';
 export { PROTECTED_APPS, registerAppRoutes } from './routes.js';
+export { registerSecurityRoutes } from './security.js';
 /** Package identity. */
 export const PACKAGE = Object.freeze({
     name: 'shutro-erp/settings',
     rfc: 'RFC 0008',
 });
-/** The Shutro module: the App manager group. */
+/** A one-time link that lets an invited person choose their password. Private: read through the People routes. */
+const Invitation = orm.defineModel('settings.invitation', {
+    label: 'Invitation',
+    order: ['id desc'],
+    access: {},
+    fields: {
+        user: orm.f.many2one('res.users', { required: true, ondelete: 'cascade' }),
+        tokenHash: orm.f.char({ required: true, index: 'unique' }),
+        expiresAt: orm.f.datetime({ required: true }),
+        usedAt: orm.f.datetime(),
+        invitedBy: orm.f.many2one('res.users', { ondelete: 'set null' }),
+    },
+});
+/** The Shutro module: the Settings groups and invitations. */
 export const settingsShutro = orm.defineModule({
     name: 'settings',
     version: '0.1.0',
     depends: [baseShutro],
     groups: [
         orm.defineGroup({ code: 'settings.apps', label: 'App manager', implies: ['base.user'] }),
+        orm.defineGroup({
+            code: 'settings.company',
+            label: 'Company settings',
+            implies: ['base.user'],
+        }),
+        orm.defineGroup({ code: 'settings.people', label: 'People manager', implies: ['base.user'] }),
     ],
-    models: [],
-});
-/** The Settings app. */
-export const settings = defineModule({
-    shutro: settingsShutro,
-    kosh: '^0.1.0',
-    depends: [base],
-    app: {
-        code: 'settings',
-        label: 'Settings',
-        icon: 'settings',
-        sequence: 1000,
-        category: 'Administration',
-        summary: 'Apps, and the settings of this installation',
-    },
-    accessLevels: {
-        apps: { label: 'App manager', groups: ['settings.apps'] },
-    },
-    actions: {
-        'settings.action_apps': { type: 'client', page: 'settings.Apps', label: 'Apps' },
-    },
-    menus: [
-        { id: 'settings.root', label: 'Settings', app: 'settings' },
-        { id: 'settings.apps', parent: 'settings.root', label: 'Apps', action: 'settings.action_apps' },
-    ],
-    routes: (context) => registerAppRoutes(context),
+    models: [Invitation],
 });
+/** The Settings app with explicit options (tests): the back-office's address and the mailer of invitations. */
+export function settingsModule(options = {}) {
+    return defineModule({
+        shutro: settingsShutro,
+        kosh: '^0.1.0',
+        depends: [base],
+        app: {
+            code: 'settings',
+            label: 'Settings',
+            icon: 'settings',
+            sequence: 1000,
+            category: 'Administration',
+            summary: 'Apps, people and the settings of this installation',
+        },
+        accessLevels: {
+            apps: { label: 'App manager', groups: ['settings.apps'] },
+            company: { label: 'Company settings', groups: ['settings.company'] },
+            people: { label: 'People manager', groups: ['settings.people'] },
+        },
+        privateModels: ['settings.invitation'],
+        actions: {
+            'settings.action_overview': { type: 'client', page: 'settings.Overview', label: 'Settings' },
+            'settings.action_apps': { type: 'client', page: 'settings.Apps', label: 'Apps' },
+            'settings.action_company': { type: 'client', page: 'settings.Company', label: 'Company' },
+            'settings.action_companies': {
+                type: 'client',
+                page: 'settings.Companies',
+                label: 'Companies',
+            },
+            'settings.action_security': { type: 'client', page: 'settings.Security', label: 'Security' },
+            'settings.action_audit': { type: 'client', page: 'settings.Audit', label: 'Audit log' },
+            'settings.action_people': { type: 'client', page: 'settings.People', label: 'People' },
+            'settings.action_roles': {
+                type: 'client',
+                page: 'settings.Roles',
+                label: 'Roles & permissions',
+            },
+        },
+        menus: [
+            { id: 'settings.root', label: 'Settings', app: 'settings' },
+            // The overview first (the app's home), then the sections in groups (RFC 0019 §3.1). Modules add their
+            // settings under `settings.group_apps`.
+            {
+                id: 'settings.overview',
+                parent: 'settings.root',
+                label: 'Overview',
+                action: 'settings.action_overview',
+                sequence: 0,
+            },
+            { id: 'settings.group_workspace', parent: 'settings.root', label: 'Workspace', sequence: 10 },
+            {
+                id: 'settings.company',
+                parent: 'settings.group_workspace',
+                label: 'Company',
+                action: 'settings.action_company',
+                sequence: 1,
+            },
+            {
+                id: 'settings.companies',
+                parent: 'settings.group_workspace',
+                label: 'Companies',
+                action: 'settings.action_companies',
+                sequence: 2,
+            },
+            { id: 'settings.group_people', parent: 'settings.root', label: 'People', sequence: 20 },
+            {
+                id: 'settings.people',
+                parent: 'settings.group_people',
+                label: 'People',
+                action: 'settings.action_people',
+                sequence: 1,
+            },
+            {
+                id: 'settings.roles',
+                parent: 'settings.group_people',
+                label: 'Roles & permissions',
+                action: 'settings.action_roles',
+                sequence: 2,
+            },
+            // Security: administrators only (the server refuses everyone else).
+            {
+                id: 'settings.group_security',
+                parent: 'settings.root',
+                label: 'Security',
+                sequence: 30,
+                visibleTo: ['base.admin'],
+            },
+            {
+                id: 'settings.security',
+                parent: 'settings.group_security',
+                label: 'Security',
+                action: 'settings.action_security',
+                sequence: 1,
+                visibleTo: ['base.admin'],
+            },
+            {
+                id: 'settings.audit',
+                parent: 'settings.group_security',
+                label: 'Audit log',
+                action: 'settings.action_audit',
+                sequence: 2,
+                visibleTo: ['base.admin'],
+            },
+            { id: 'settings.group_apps', parent: 'settings.root', label: 'Apps', sequence: 40 },
+            {
+                id: 'settings.apps',
+                parent: 'settings.group_apps',
+                label: 'App manager',
+                action: 'settings.action_apps',
+                sequence: 1,
+            },
+        ],
+        routes: (context) => {
+            registerAppRoutes(context);
+            registerCompanyRoutes(context);
+            registerSecurityRoutes(context);
+            registerPeopleRoutes(context, {
+                baseUrl: options.baseUrl ?? process.env['KOSH_BASE_URL'] ?? 'http://localhost:5173',
+                mailer: 'mailer' in options ? options.mailer : mailerFromEnv(),
+            });
+        },
+    });
+}
+/** The Settings app (the back-office's address and the mailer from the environment). */
+export const settings = settingsModule();

package/dist/settings/people.d.ts

@@ -0,0 +1,16 @@
+import { type Mailer } from '../mail/index.js';
+import { type ModuleContext } from '../server/index.js';
+/** How long an invitation works. */
+export declare const INVITATION_DAYS = 7;
+export interface PeopleOptions {
+    /** The back-office's address (`SHUTRO_ERP_BASE_URL`): activation links point there. */
+    readonly baseUrl: string;
+    /** Sends the invitations; without one, the inviter passes the link on. */
+    readonly mailer?: Mailer | undefined;
+}
+export interface Assignment {
+    readonly group: string;
+    /** null: every company. */
+    readonly company: number | null;
+}
+export declare function registerPeopleRoutes(context: ModuleContext, options: PeopleOptions): void;