shutro-erp 0.3.0 → 0.3.2

package/README.md

@@ -1,6 +1,6 @@
 # shutro-erp
 
-**Kosh** is an ERP framework for Node.js, TypeScript and PostgreSQL, built on the
+**Shutro ERP** is an ERP framework for Node.js, TypeScript and PostgreSQL, built on the
 [Shutro](https://www.npmjs.com/package/shutro) ORM. Define a model once and get a REST API with OpenAPI, a typed
 client, list / form / kanban / pivot / graph / calendar / gantt / map / dashboard views, exports, PDF documents and a
 chatter on every record. Permissions are checked on the server on every route.
@@ -20,13 +20,13 @@ chatter on every record. Permissions are checked on the server on every route.
 ## Requirements
 
 - **Node.js 24** or later (`node --version`)
-- **PostgreSQL 16** or later, or **Docker** (Kosh can start PostgreSQL for you)
+- **PostgreSQL 16** or later, or **Docker** (Shutro ERP can start PostgreSQL for you)
 - An authenticator app for the administrator's second factor (Google Authenticator, Microsoft Authenticator,
   1Password, …)
 
 ## Install with the terminal
 
-One command creates the project, installs Kosh and asks for everything it needs:
+One command creates the project, installs Shutro ERP and asks for everything it needs:
 
 ```sh
 npx shutro-erp@latest init my-erp   # the project my-erp
@@ -37,7 +37,7 @@ npx shutro-erp@latest init          # asks for the project name first
 
 ```sh
 npm install shutro-erp      # Shutro, the ORM, comes with it
-npx kosh init
+npx shutro-erp init
 ```
 
 The setup asks for what the installation needs, one question at a time: type an answer or press **Enter** for
@@ -58,7 +58,7 @@ the default shown, pick from lists with **↑ ↓** and **Enter**, tick apps wit
 | Authenticator code | `123456` | scan the printed secret, type a code; **keep the recovery codes** it prints |
 
 Then it writes the project, creates the database tables (`migrations/0001_init.sql`), the company and the
-administrator, and loads the apps' default data. **Then it starts Kosh for you**: it installs the project's
+administrator, and loads the apps' default data. **Then it starts Shutro ERP for you**: it installs the project's
 dependencies (with the package manager you ran it with: npm, pnpm, yarn or bun), starts the API and the
 back-office, waits until both answer, and opens the back-office in your browser on the web port. Both keep
 running in that terminal; **Ctrl+C** stops them. Sign in with the administrator's login, password and a code from
@@ -77,21 +77,21 @@ npm run web          # the back-office on http://localhost:5173, in a second ter
 ```sh
 npx shutro-erp@latest init my-erp --yes --docker-db --admin-password "a long passphrase here"
 
-npx kosh init --yes \
+npx shutro-erp init --yes \
   --database-url postgres://postgres:postgres@localhost:5432/my_erp --create-database \
   --company "Padma Traders" --currency BDT --lang bn --tz Asia/Dhaka \
   --admin-login admin --admin-password "a long passphrase here" \
   --apps permissions,reporting,messaging --storage-dir ./var/attachments --port 3000 --web-port 5173
 ```
 
-With `--yes` nothing is asked, so the authenticator is not enrolled: run `npx kosh init` again in a terminal to
-enrol it (administrator rights wait for it). `npx kosh init --help` lists every flag. Replies by email: set `MAIL_INBOUND_DOMAIN` in `.env` (the secrets are generated) and point your email provider's inbound webhook at `/api/v1/mail/inbound` with the `MAIL_INBOUND_WEBHOOK_SECRET`. `--demo` (or a yes to the
+With `--yes` nothing is asked, so the authenticator is not enrolled: run `npx shutro-erp init` again in a terminal to
+enrol it (administrator rights wait for it). `npx shutro-erp init --help` lists every flag. Replies by email: set `MAIL_INBOUND_DOMAIN` in `.env` (the secrets are generated) and point your email provider's inbound webhook at `/api/v1/mail/inbound` with the `MAIL_INBOUND_WEBHOOK_SECRET`. `--demo` (or a yes to the
 question after the apps) loads a sample company with contacts, products, orders, invoices and projects, made by
 the demo users `dina`, `rahim`, `karim` and `sumi` (one shared password, printed at the end); not for production.
 
 ## Install with Docker
 
-`kosh init` writes `Dockerfile`, `compose.yaml`, `nginx.conf` and `.dockerignore` into every project.
+`shutro-erp init` writes `Dockerfile`, `compose.yaml`, `nginx.conf` and `.dockerignore` into every project.
 
 **PostgreSQL in Docker, the app on your machine** (development):
 
@@ -117,21 +117,21 @@ docker compose up -d --build        # db + api + web; the back-office on http://
 | Service | What | Port |
 |---|---|---|
 | `db` | PostgreSQL 18, data in the `db` volume | `127.0.0.1:5432` (`POSTGRES_PORT`) |
-| `api` | the Kosh API; runs `kosh migrate` on every start, then serves | inside the network (`api:3000`) |
+| `api` | the Shutro ERP API; runs `shutro-erp migrate` on every start, then serves | inside the network (`api:3000`) |
 | `web` | nginx with the built back-office, `/api` proxied to `api` | `8080` (`WEB_PORT`) |
 
 Useful commands:
 
 ```sh
 docker compose logs -f api                       # the API's log
-docker compose exec api npx kosh migrate status  # any kosh command inside the container
-docker compose exec api npx kosh seed
+docker compose exec api npx shutro-erp migrate status  # any shutro-erp command inside the container
+docker compose exec api npx shutro-erp seed
 docker compose up -d --build api                 # after changing modules: rebuild and migrate
 docker compose down                              # stop (volumes keep the data)
-docker compose exec db pg_dump -U kosh my_erp > backup.sql   # a backup
+docker compose exec db pg_dump -U shutro my_erp > backup.sql   # a backup
 ```
 
-Behind HTTPS, set `KOSH_SECURE_COOKIES: "true"` in `compose.yaml`. To use a PostgreSQL server outside Docker, set
+Behind HTTPS, set `SHUTRO_ERP_SECURE_COOKIES: "true"` in `compose.yaml`. To use a PostgreSQL server outside Docker, set
 `DOCKER_DATABASE_URL` in `.env` (an address the container can reach, not `localhost`).
 
 ## Project structure
@@ -144,7 +144,7 @@ my-erp/
 ├── src/
 │   ├── modules.ts          the installed modules: base, the apps, your modules
 │   ├── server.ts           the API server (npm start)
-│   ├── modules/            your modules (kosh module create <name>)
+│   ├── modules/            your modules (shutro-erp module create <name>)
 │   │   └── library/
 │   │       ├── index.ts        the module: groups, access levels, app, menus, actions, views
 │   │       ├── models.ts       its models (fields, access per group, record rules)
@@ -152,7 +152,7 @@ my-erp/
 │   │       └── migrations.ts   its data migrations
 │   └── web/
 │       ├── main.tsx        the back-office (React): renderers of each installed app
-│       └── index.css       Tailwind + Kosh's design tokens
+│       └── index.css       Tailwind + Shutro ERP's design tokens
 ├── index.html, vite.config.ts   the back-office build (npm run web / build:web)
 ├── Dockerfile, compose.yaml, nginx.conf, .dockerignore
 └── var/attachments/        uploaded files (with folder storage)
@@ -163,8 +163,8 @@ my-erp/
 A module is a folder with its models and a manifest. Create one:
 
 ```sh
-npx kosh module create library
-npx kosh migrate             # creates its tables, records it, loads its seed data
+npx shutro-erp module create library
+npx shutro-erp migrate             # creates its tables, records it, loads its seed data
 ```
 
 It writes `src/modules/library/` and adds `library` to `src/modules.ts`. After `npm start` and a reload of the
@@ -198,7 +198,7 @@ export const Book = defineModel('library.book', {
 ```
 
 **`index.ts`**: the module: its Shutro part (name, version, groups, models, seed data, data migrations) and its
-Kosh part (access levels, app, menus, actions, views):
+Shutro ERP part (access levels, app, menus, actions, views):
 
 ```ts
 import { base, baseShutro } from 'shutro-erp';
@@ -259,29 +259,29 @@ export const modules = [base, messaging, library];
 ```
 
 ```sh
-npx kosh migrate    # tables, the module's version (shutro_module), its seed data
+npx shutro-erp migrate    # tables, the module's version (shutro_module), its seed data
 ```
 
 A module published on npm installs the same way: `npm install <package>`, import it in `src/modules.ts`, then
-`npx kosh migrate`. Installing does not give anyone access: grant its roles to users ([Users and roles](#users-and-roles)).
+`npx shutro-erp migrate`. Installing does not give anyone access: grant its roles to users ([Users and roles](#users-and-roles)).
 
-**Remove a module**: take it out of `src/modules.ts`; `npx kosh migrate` then plans dropping its tables, which is
-destructive: it stops for review, and `npx kosh migrate --allow-destructive` applies it. Back up first.
+**Remove a module**: take it out of `src/modules.ts`; `npx shutro-erp migrate` then plans dropping its tables, which is
+destructive: it stops for review, and `npx shutro-erp migrate --allow-destructive` applies it. Back up first.
 
 ## Migrations
 
 ```sh
-npx kosh migrate                   # plan + apply + seed
-npx kosh migrate --plan            # only write the plan, to review it
-npx kosh migrate --name add_isbn   # name the new file (migrations/0002_add_isbn.sql)
-npx kosh migrate status            # applied and pending files
-npx kosh migrate --allow-destructive
+npx shutro-erp migrate                   # plan + apply + seed
+npx shutro-erp migrate --plan            # only write the plan, to review it
+npx shutro-erp migrate --name add_isbn   # name the new file (migrations/0002_add_isbn.sql)
+npx shutro-erp migrate status            # applied and pending files
+npx shutro-erp migrate --allow-destructive
 ```
 
-- **Schema migrations** are SQL files in `migrations/`. `kosh migrate` compares your modules with the live database
+- **Schema migrations** are SQL files in `migrations/`. `shutro-erp migrate` compares your modules with the live database
   and writes the differences as the next file (`0002_update.sql`), applies every pending file in order (each in its
   own transaction, recorded in `shutro_migration`), then loads the seed data. Commit the files: a deployment runs the
-  same ones (the Docker `api` service runs `kosh migrate` on start).
+  same ones (the Docker `api` service runs `shutro-erp migrate` on start).
 - **Destructive changes** (dropping a column or a table, narrowing a type) are written but not applied without
   `--allow-destructive`. A file written earlier and not applied yet is applied first.
 - **Per-module data migrations** change existing data when a module is upgraded. Declare them in the module's
@@ -305,7 +305,7 @@ export const migrations: DataMigration[] = [
 
 ```sh
 # index.ts: version: '0.2.0'
-npx kosh migrate    # … module library: 0.1.0 → 0.2.0, data migration library@0.2.0
+npx shutro-erp migrate    # … module library: 0.1.0 → 0.2.0, data migration library@0.2.0
 ```
 
 ## Seed data
@@ -329,18 +329,18 @@ export const data = [
 ```
 
 ```sh
-npx kosh seed                 # every module's seed data, and the apps' defaults
-npx kosh seed library         # one module (or several: kosh seed library inventory)
+npx shutro-erp seed                 # every module's seed data, and the apps' defaults
+npx shutro-erp seed library         # one module (or several: shutro-erp seed library inventory)
 ```
 
-`kosh migrate` seeds too (skip with `--no-seed`). The apps' defaults are also seeded: approval policies
+`shutro-erp migrate` seeds too (skip with `--no-seed`). The apps' defaults are also seeded: approval policies
 (permissions), document templates (reporting), activity types (messaging); users may edit them afterwards.
 
 ## Users and roles
 
 ```sh
-npx kosh user create rahim --name "Rahim Uddin" --email rahim@example.com --roles library.user,messaging.user
-npx kosh user password rahim     # a new password (asked, hidden)
+npx shutro-erp user create rahim --name "Rahim Uddin" --email rahim@example.com --roles library.user,messaging.user
+npx shutro-erp user password rahim     # a new password (asked, hidden)
 ```
 
 Roles are the groups of the installed modules' access levels (`library.user`, `library.manager`,
@@ -354,31 +354,31 @@ their roles grants it. Administrators manage roles, field security and grants in
 |---|---|
 | `DATABASE_URL` | PostgreSQL: `postgres://user:password@host:5432/database` |
 | `PORT`, `HOST` | the API's port (3000) and address (127.0.0.1; 0.0.0.0 in Docker) |
-| `KOSH_STORAGE_DIR` | attachments in this folder, or: |
+| `SHUTRO_ERP_STORAGE_DIR` | attachments in this folder, or: |
 | `S3_ENDPOINT`, `S3_BUCKET`, `S3_ACCESS_KEY`, `S3_SECRET_KEY`, `S3_REGION` | S3-compatible storage |
-| `KOSH_ATTACHMENT_MAX_BYTES` | upload limit (25 MB) |
+| `SHUTRO_ERP_ATTACHMENT_MAX_BYTES` | upload limit (25 MB) |
 | `VALKEY_URL` | optional Valkey/Redis: rate limits and caches across servers |
-| `KOSH_SECURE_COOKIES` | `true` behind HTTPS (default in production), `false` for plain HTTP |
-| `KOSH_SCHEDULES` | `off` stops the scheduled-report ticker on this server |
+| `SHUTRO_ERP_SECURE_COOKIES` | `true` behind HTTPS (default in production), `false` for plain HTTP |
+| `SHUTRO_ERP_SCHEDULES` | `off` stops the scheduled-report ticker on this server |
 | `POSTGRES_USER`, `POSTGRES_PASSWORD`, `POSTGRES_DB`, `POSTGRES_PORT` | the Docker `db` service |
 | `DOCKER_DATABASE_URL`, `WEB_PORT` | Docker: another database for `api`; the back-office's port (8080) |
 
 ## Command reference
 
-Run them in the project folder (`npx kosh …`, or `npm run migrate` / `npm run seed`). They read `.env` and
+Run them in the project folder (`npx shutro-erp …`, or `npm run migrate` / `npm run seed`). They read `.env` and
 `src/modules.ts` (`--modules <file>` for another list).
 
 | Command | What |
 |---|---|
-| `kosh init [folder]` | set up an installation (questions, or flags with `--yes`); again later to enrol 2FA |
-| `kosh migrate` | apply pending files, plan what is missing into a new file and apply it, run data migrations, seed |
-| `kosh migrate --plan` · `--name <n>` · `--allow-destructive` · `--no-seed` | review only · file name · drops · no seeding |
-| `kosh migrate status` | applied and pending migration files |
-| `kosh seed [module …]` | seed data of all modules, or of those named |
-| `kosh module create <name>` | a new module in `src/modules/<name>/`, listed in `src/modules.ts` |
-| `kosh user create <login>` | a user: `--name`, `--email`, `--roles`, `--password` (asked when missing) |
-| `kosh user password <login>` | a new password |
-| `kosh generate client` | a typed API client for your front-end (`--out src/api/kosh.gen.ts`) |
+| `shutro-erp init [folder]` | set up an installation (questions, or flags with `--yes`); again later to enrol 2FA |
+| `shutro-erp migrate` | apply pending files, plan what is missing into a new file and apply it, run data migrations, seed |
+| `shutro-erp migrate --plan` · `--name <n>` · `--allow-destructive` · `--no-seed` | review only · file name · drops · no seeding |
+| `shutro-erp migrate status` | applied and pending migration files |
+| `shutro-erp seed [module …]` | seed data of all modules, or of those named |
+| `shutro-erp module create <name>` | a new module in `src/modules/<name>/`, listed in `src/modules.ts` |
+| `shutro-erp user create <login>` | a user: `--name`, `--email`, `--roles`, `--password` (asked when missing) |
+| `shutro-erp user password <login>` | a new password |
+| `shutro-erp generate client` | a typed API client for your front-end (`--out src/api/shutro-erp.gen.ts`) |
 | `npm start` · `npm run web` · `npm run build:web` | the API · the back-office (dev) · the back-office build (`dist/`) |
 | `npm run docker:up` | `docker compose up -d --build` |
 
@@ -387,26 +387,26 @@ Run them in the project folder (`npx kosh …`, or `npm run migrate` / `npm run
 | Import | What |
 |---|---|
 | `shutro-erp` | the server: `createServer`, `startServer`, `base`, REST + OpenAPI, sessions and 2FA |
-| `shutro-erp/orm` | Shutro (models, fields, groups, records, migrations) as Kosh uses it |
+| `shutro-erp/orm` | Shutro (models, fields, groups, records, migrations) as Shutro ERP uses it |
 | `shutro-erp/modules-sdk` | `defineModule`: manifests, access levels, menus, actions |
 | `shutro-erp/views`, `shutro-erp/search` | view definitions (`list`, `form`, `kanban`, `pivot`, …) and the search layer |
 | `shutro-erp/permissions` | roles, field security, approvals (`/web`: the approval panel) |
 | `shutro-erp/reporting` | pivots, exports, documents, scheduled reports (`/web`: the report views) |
 | `shutro-erp/messaging`, `shutro-erp/storage` | the chatter, activities, attachments (`/web`: the chatter) |
 | `shutro-erp/ui` | the React app shell, design system and renderers; `shutro-erp/ui/styles.css` the tokens |
-| `shutro-erp/cli` | the `kosh` command's functions |
+| `shutro-erp/cli` | the `shutro-erp` command's functions |
 
 ## Troubleshooting
 
 - **"PostgreSQL did not answer"**: nothing listens at that host and port. Start your PostgreSQL service, or
   answer `2` (Docker) to the first question; Docker Desktop must be running.
 - **"password authentication failed"**: the user or password in `DATABASE_URL` is wrong.
-- **Signed in but no apps**: the user has no role granting them (`kosh user create … --roles`); administrators need
-  their authenticator enrolled (`npx kosh init` again).
-- **Sign-in works on the API but not in the browser over plain HTTP**: `KOSH_SECURE_COOKIES=false`.
-- **Lost the phone**: sign in with one of the recovery codes `kosh init` printed.
-- **"It drops or changes existing data"**: `kosh migrate` found a destructive change; read the new file in
-  `migrations/`, back up, then `npx kosh migrate --allow-destructive`.
+- **Signed in but no apps**: the user has no role granting them (`shutro-erp user create … --roles`); administrators need
+  their authenticator enrolled (`npx shutro-erp init` again).
+- **Sign-in works on the API but not in the browser over plain HTTP**: `SHUTRO_ERP_SECURE_COOKIES=false`.
+- **Lost the phone**: sign in with one of the recovery codes `shutro-erp init` printed.
+- **"It drops or changes existing data"**: `shutro-erp migrate` found a destructive change; read the new file in
+  `migrations/`, back up, then `npx shutro-erp migrate --allow-destructive`.
 
 Documentation, design notes and the source: https://github.com/isahaq1/kosh
 

package/dist/account_portal/.kosh/bindings.js

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

@@ -1,4 +1,4 @@
-// GENERATED by `pnpm generate:models` (Shutro’s generator). Do not edit. definitions-hash: d1607b05570077f9
+// GENERATED by `pnpm generate:models` (Shutro’s generator). Do not edit. definitions-hash: 0ea5d21ac5b24166
 // Schema view of module `account_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';
 
@@ -22,6 +22,7 @@ export interface SchemaView {
   readonly 'approval.policy': ApprovalPolicy;
   readonly 'approval.request': ApprovalRequest;
   readonly 'audit.event': AuditEvent;
+  readonly 'auth.api_key': AuthApiKey;
   readonly 'auth.credential': AuthCredential;
   readonly 'auth.session': AuthSession;
   readonly 'auth.user_grant': AuthUserGrant;
@@ -582,6 +583,34 @@ export interface AuditEvent {
 export interface AuditEventMethods extends F.Methods<typeof import('../../server/index.js').baseShutro, 'audit.event'> {
 }
 
+/** `auth.api_key` (owner: base). */
+export interface AuthApiKey {
+  readonly name: 'auth.api_key';
+  readonly fields: {
+    readonly id: F.Id<'auth.api_key'>;
+    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 user: F.Many2one<'res.users', { readonly required: true }>;
+    readonly tokenHash: F.Char<{ readonly required: true }>;
+    readonly prefix: F.Char<{ readonly required: true }>;
+    readonly scopes: F.Text<{ readonly required: true }>;
+    readonly expiresAt: F.Datetime<{ readonly required: true }>;
+    readonly lastUsedAt: F.Datetime;
+    readonly lastUsedIp: F.Char;
+    readonly revoked: F.Bool<{ readonly required: true; readonly default: true }>;
+    readonly issuedBy: F.Many2one<'res.users'>;
+  };
+  readonly methods: AuthApiKeyMethods;
+}
+
+/** Methods of `auth.api_key`: declared ones and transitions. */
+export interface AuthApiKeyMethods extends F.Methods<typeof import('../../server/index.js').baseShutro, 'auth.api_key'> {
+}
+
 /** `auth.credential` (owner: base). */
 export interface AuthCredential {
   readonly name: 'auth.credential';
@@ -1292,6 +1321,7 @@ export interface ResUsers {
     readonly companies: F.Many2many<'res.company', { readonly required: true }>;
     readonly lang: F.Char<{ readonly default: true }>;
     readonly tz: F.Char<{ readonly default: true }>;
+    readonly isService: F.Bool<{ readonly required: true; readonly default: true }>;
     readonly portalPartner: F.Many2one<'res.partner'>; // portal
   };
   readonly methods: ResUsersMethods;

package/dist/account_portal/index.js

@@ -2,8 +2,8 @@
  * @packageDocumentation
  * `shutro-erp/account_portal`: Accounting in the portal (RFC 0015 §5.4). Proposed whenever Accounting and the portal
  * are installed. Customers see their posted invoices and credit notes, what is still due, print them and write on
- * them; vendors see the bills recorded for them. Payment is by the details on the invoice (online payment comes
- * with the integrations RFC).
+ * them; vendors see the bills recorded for them. Open invoices are payable online when the `payment` module and
+ * a provider are installed (RFC 0017 §5.5); otherwise by the payment details on the invoice.
  */
 import { accounting } from '../accounting/index.js';
 import { defineModule } from '../modules-sdk/index.js';
@@ -55,6 +55,7 @@ export const accountPortal = defineModule({
                 thread: true,
                 attention: { kind: 'out_invoice', paymentState: { in: ['not_paid', 'partial'] } },
                 announce: { state: 'posted' },
+                payment: { when: { kind: 'out_invoice', paymentState: { in: ['not_paid', 'partial'] } } },
             },
             {
                 key: 'bills',

package/dist/accounting/.kosh/bindings.js

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

@@ -1,4 +1,4 @@
-// GENERATED by `pnpm generate:models` (Shutro’s generator). Do not edit. definitions-hash: 5c7f5b1c2e181d35
+// GENERATED by `pnpm generate:models` (Shutro’s generator). Do not edit. definitions-hash: c83d584195f8dd43
 // Schema view of module `accounting` (RFC 0002 §7.7): the models it owns or depends on, with the extensions it can see.
 import type { F } from '../../server/orm.js';
 
@@ -22,6 +22,7 @@ export interface SchemaView {
   readonly 'approval.policy': ApprovalPolicy;
   readonly 'approval.request': ApprovalRequest;
   readonly 'audit.event': AuditEvent;
+  readonly 'auth.api_key': AuthApiKey;
   readonly 'auth.credential': AuthCredential;
   readonly 'auth.session': AuthSession;
   readonly 'auth.user_grant': AuthUserGrant;
@@ -579,6 +580,34 @@ export interface AuditEvent {
 export interface AuditEventMethods extends F.Methods<typeof import('../../server/index.js').baseShutro, 'audit.event'> {
 }
 
+/** `auth.api_key` (owner: base). */
+export interface AuthApiKey {
+  readonly name: 'auth.api_key';
+  readonly fields: {
+    readonly id: F.Id<'auth.api_key'>;
+    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 user: F.Many2one<'res.users', { readonly required: true }>;
+    readonly tokenHash: F.Char<{ readonly required: true }>;
+    readonly prefix: F.Char<{ readonly required: true }>;
+    readonly scopes: F.Text<{ readonly required: true }>;
+    readonly expiresAt: F.Datetime<{ readonly required: true }>;
+    readonly lastUsedAt: F.Datetime;
+    readonly lastUsedIp: F.Char;
+    readonly revoked: F.Bool<{ readonly required: true; readonly default: true }>;
+    readonly issuedBy: F.Many2one<'res.users'>;
+  };
+  readonly methods: AuthApiKeyMethods;
+}
+
+/** Methods of `auth.api_key`: declared ones and transitions. */
+export interface AuthApiKeyMethods extends F.Methods<typeof import('../../server/index.js').baseShutro, 'auth.api_key'> {
+}
+
 /** `auth.credential` (owner: base). */
 export interface AuthCredential {
   readonly name: 'auth.credential';
@@ -1216,6 +1245,7 @@ export interface ResUsers {
     readonly companies: F.Many2many<'res.company', { readonly required: true }>;
     readonly lang: F.Char<{ readonly default: true }>;
     readonly tz: F.Char<{ readonly default: true }>;
+    readonly isService: F.Bool<{ readonly required: true; readonly default: true }>;
   };
   readonly methods: ResUsersMethods;
 }

package/dist/accounting/index.js

@@ -404,6 +404,10 @@ export const accounting = defineModule({
             sequence: 5,
         },
     ],
+    // What webhooks may subscribe to besides record changes (RFC 0017 §5.3).
+    events: [
+        { topic: 'account.move.posted', model: 'account.move', label: 'Entry, invoice or bill posted' },
+    ],
     approvals: [
         {
             name: 'Vendor bill approvals',

package/dist/assistant/routes.js

@@ -209,7 +209,7 @@ export function registerAssistantRoutes(context, options) {
                 ? 'No API key is configured on this server (ANTHROPIC_API_KEY).'
                 : 'An administrator has not switched the assistant on for this company.');
         if ((await usedThisMonth(env.companyId)) >= options.monthlyTokens)
-            throw new HttpProblem(429, 'assistant-budget', "The month's assistant budget is used up", `This company used its ${options.monthlyTokens} tokens of the month.`, 'An administrator can raise KOSH_ASSISTANT_MONTHLY_TOKENS.');
+            throw new HttpProblem(429, 'assistant-budget', "The month's assistant budget is used up", `This company used its ${options.monthlyTokens} tokens of the month.`, 'An administrator can raise SHUTRO_ERP_ASSISTANT_MONTHLY_TOKENS.');
         return client;
     };
     /** Logs a call in a transaction of its own (after the model answered: no transaction stays open meanwhile). */

package/dist/automation/engine.js

@@ -832,7 +832,7 @@ export function webhookProblem(url, hosts = webhookHosts()) {
         return 'Webhooks call https URLs (http only for localhost).';
     const allowed = hosts.some((h) => (h.startsWith('*.') ? host.endsWith(h.slice(1)) : host === h));
     if (!allowed)
-        return `The host ${host} is not on the webhook allow-list (KOSH_AUTOMATION_WEBHOOK_HOSTS).`;
+        return `The host ${host} is not on the webhook allow-list (SHUTRO_ERP_AUTOMATION_WEBHOOK_HOSTS).`;
     return null;
 }
 /** The signature of a webhook body: `sha256=<hex HMAC>` with the rule's secret. */

package/dist/automation/web/messages.js

@@ -62,7 +62,7 @@ export const messages = {
             cronHint: 'Minute hour day month weekday: "0 2 * * *" is every night at 02:00; @daily, @weekly, @monthly too. Runs on the records the condition matches.',
             url: 'URL',
             webhookFields: 'Fields to send',
-            webhookHint: "A signed JSON POST (X-Kosh-Signature: sha256 HMAC with the rule's webhook secret), retried on failure; the host must be on the allow-list (KOSH_AUTOMATION_WEBHOOK_HOSTS).",
+            webhookHint: "A signed JSON POST (X-Kosh-Signature: sha256 HMAC with the rule's webhook secret), retried on failure; the host must be on the allow-list (SHUTRO_ERP_AUTOMATION_WEBHOOK_HOSTS).",
             condition: 'And the record matches',
             conditionJson: 'Condition (domain)',
             field: 'Field',
@@ -169,7 +169,7 @@ export const messages = {
             cronHint: 'মিনিট ঘণ্টা দিন মাস সপ্তাহের দিন: "0 2 * * *" মানে প্রতি রাত ০২:০০; @daily, @weekly, @monthly-ও চলে। শর্তে মেলা রেকর্ডে চলে।',
             url: 'URL',
             webhookFields: 'যে ফিল্ড পাঠাবে',
-            webhookHint: 'স্বাক্ষরিত JSON POST (X-Kosh-Signature: নিয়মের ওয়েবহুক সিক্রেট দিয়ে sha256 HMAC), ব্যর্থ হলে আবার চেষ্টা; হোস্ট অনুমোদিত তালিকায় থাকতে হবে (KOSH_AUTOMATION_WEBHOOK_HOSTS)।',
+            webhookHint: 'স্বাক্ষরিত JSON POST (X-Kosh-Signature: নিয়মের ওয়েবহুক সিক্রেট দিয়ে sha256 HMAC), ব্যর্থ হলে আবার চেষ্টা; হোস্ট অনুমোদিত তালিকায় থাকতে হবে (SHUTRO_ERP_AUTOMATION_WEBHOOK_HOSTS)।',
             condition: 'এবং রেকর্ড মেলে',
             conditionJson: 'শর্ত (ডোমেইন)',
             field: 'ফিল্ড',

package/dist/cli/apps.d.ts

@@ -8,5 +8,5 @@ export interface AppsIo {
     /** The confirmation question (tests script it). Default: the terminal. */
     readonly prompter?: Prompter;
 }
-/** Runs `kosh apps …`. Returns the exit code. */
+/** Runs `shutro-erp apps …`. Returns the exit code. */
 export declare function runApps(argv: readonly string[], io: AppsIo): Promise<number>;

package/dist/cli/apps.js

@@ -1,5 +1,5 @@
 /**
- * `kosh apps` (RFC 0008): the App manager in the terminal. Lists the catalogue with each app's state, and installs,
+ * `shutro-erp apps` (RFC 0008): the App manager in the terminal. Lists the catalogue with each app's state, and installs,
  * enables or disables apps: the plan is shown first (modules, dependencies, cascades, schema statements), then
  * applied in one transaction by `shutro-erp` (`prepareApps` / `applyApps`).
  */
@@ -13,14 +13,14 @@ import { PROTECTED_APPS } from '../settings/index.js';
 import { modulesOf, seedWith } from './project.js';
 import { defaultsPrompter, terminalPrompter } from './prompt.js';
 import { createUi, PLAIN_TERMINAL } from './ui.js';
-export const APPS_USAGE = `Usage: kosh apps [command] [app …] [options]
+export const APPS_USAGE = `Usage: shutro-erp apps [command] [app …] [options]
 
-  kosh apps                     the catalogue: installed, disabled and available apps
-  kosh apps install <app …>     install apps and what they need, in one transaction
-  kosh apps enable <app …>      serve disabled apps again (their data is still there)
-  kosh apps disable <app …>     switch apps off: menus, API and access go, tables and data stay
+  shutro-erp apps                     the catalogue: installed, disabled and available apps
+  shutro-erp apps install <app …>     install apps and what they need, in one transaction
+  shutro-erp apps enable <app …>      serve disabled apps again (their data is still there)
+  shutro-erp apps disable <app …>     switch apps off: menus, API and access go, tables and data stay
                                 (apps that depend on them are disabled too)
-  kosh apps upgrade [app …]     move installed apps to their code's version: schema, data migrations,
+  shutro-erp apps upgrade [app …]     move installed apps to their code's version: schema, data migrations,
                                 seed data (default: every app whose code is newer)
 
 Options:
@@ -32,7 +32,7 @@ Options:
 
 After a change, restart the API (npm start) so it serves the new set.
 `;
-/** Pictographs for the apps Kosh ships; other modules get a puzzle piece. */
+/** Pictographs for the apps Shutro ERP ships; other modules get a puzzle piece. */
 const APP_ICONS = {
     base: '🏠',
     settings: '⚙️',
@@ -74,7 +74,7 @@ async function list(ui, driver, catalogue) {
         const label = m.app?.label ?? '';
         const why = row?.reason === 'dependency' ? ui.style('gray', ' (needed by another app)') : '';
         const behind = row !== undefined && row.version !== m.version
-            ? ui.style('cyan', ` (installed ${row.version}: kosh apps upgrade ${m.name})`)
+            ? ui.style('cyan', ` (installed ${row.version}: shutro-erp apps upgrade ${m.name})`)
             : '';
         ui.write(`  ${marks[s]} ${iconOf(ui, m.name)}  ${ui.style('bold', m.name.padEnd(width))}  ${ui.style('gray', m.version.padEnd(8))} ${s.padEnd(9)} ${label}${why}${behind}\n`);
     }
@@ -103,7 +103,7 @@ function showPlan(ui, prepared, catalogue) {
     if (plan.disable.length > 0)
         ui.detail('tables and data stay; enable brings everything back');
 }
-/** Runs `kosh apps …`. Returns the exit code. */
+/** Runs `shutro-erp apps …`. Returns the exit code. */
 export async function runApps(argv, io) {
     const { values, positionals } = parseArgs({
         args: [...argv],
@@ -131,11 +131,11 @@ export async function runApps(argv, io) {
     }
     if (command === 'uninstall') {
         ui.warn('Removing an app and its data comes with a later step of RFC 0008.');
-        ui.info(`Meanwhile: kosh apps disable ${names.join(' ') || '<app>'} (reversible, keeps the data).`);
+        ui.info(`Meanwhile: shutro-erp apps disable ${names.join(' ') || '<app>'} (reversible, keeps the data).`);
         return 2;
     }
     if (command !== 'list' && command !== 'upgrade' && names.length === 0) {
-        ui.fail(`Name the app(s): kosh apps ${command} <app …>`);
+        ui.fail(`Name the app(s): shutro-erp apps ${command} <app …>`);
         return 2;
     }
     const envFile = join(io.cwd, '.env');
@@ -143,14 +143,14 @@ export async function runApps(argv, io) {
         process.loadEnvFile(envFile);
     const databaseUrl = process.env['DATABASE_URL'];
     if (databaseUrl === undefined || databaseUrl === '') {
-        ui.fail('DATABASE_URL is not set: run kosh init, or add it to .env.');
+        ui.fail('DATABASE_URL is not set: run shutro-erp init, or add it to .env.');
         return 1;
     }
     const driver = pg.createDriver({
         url: databaseUrl,
         max: 2,
         parseNumeric: orm.toDecimal,
-        applicationName: 'kosh apps',
+        applicationName: 'shutro-erp apps',
     });
     const prompter = io.prompter ??
         (values.yes === true || values.plan === true ? defaultsPrompter() : terminalPrompter());

package/dist/cli/bin.js

@@ -1,6 +1,9 @@
 #!/usr/bin/env node
+import { applyEnvironmentNames } from '../server/index.js';
 import { runCli } from './index.js';
 import { detectTerminal } from './ui.js';
+// SHUTRO_ERP_* settings, read under their older KOSH_* names.
+applyEnvironmentNames();
 process.exitCode = await runCli(process.argv.slice(2), (text) => process.stdout.write(text), {
     terminal: detectTerminal(process.stdout),
 });