@isahaq/kosh-server 0.0.0-stage → 0.1.0

package/dist/api/metadata.js

@@ -0,0 +1,88 @@
+const IMPLICIT_READONLY = new Set([
+    'id',
+    'createdAt',
+    'createdBy',
+    'updatedAt',
+    'updatedBy',
+    'displayName',
+]);
+/** `res.partner` → `ResPartner`. */
+export function schemaName(model) {
+    return model
+        .split(/[._]/)
+        .map((s) => s.charAt(0).toUpperCase() + s.slice(1))
+        .join('');
+}
+/** The API metadata of every model of the registry. */
+export function apiModels(registry) {
+    const out = new Map();
+    for (const name of registry.models.keys()) {
+        const description = registry.describe(name);
+        const descriptors = registry.get(name).model.fields;
+        const fields = [];
+        const transitions = [];
+        const transitionSpecs = [];
+        for (const [key, d] of Object.entries(description.fields)) {
+            const raw = descriptors[key] ?? {};
+            const selection = raw['selection'];
+            if (d.kind === 'state')
+                for (const [t, spec] of Object.entries(raw['transitions'] ?? {})) {
+                    transitions.push(t);
+                    transitionSpecs.push({
+                        name: t,
+                        field: key,
+                        from: Array.isArray(spec['from']) ? spec['from'] : [],
+                        to: String(spec['to'] ?? ''),
+                        requires: typeof spec['requires'] === 'string' ? spec['requires'] : null,
+                    });
+                }
+            const computedReadonly = d.computed && raw['inverse'] === undefined;
+            fields.push({
+                key,
+                kind: d.kind,
+                label: d.label,
+                required: d.required,
+                readonly: d.readonly || computedReadonly || IMPLICIT_READONLY.has(key) || d.kind === 'state',
+                stored: d.column !== null,
+                requiredOnCreate: d.required &&
+                    !d.hasDefault &&
+                    !d.computed &&
+                    d.sequence === null &&
+                    !IMPLICIT_READONLY.has(key),
+                target: typeof d['target'] === 'string' ? d['target'] : null,
+                options: Array.isArray(selection)
+                    ? selection
+                    : null,
+                translate: d.translate,
+            });
+        }
+        out.set(name, {
+            name,
+            label: description.label,
+            schemaName: schemaName(name),
+            fields,
+            byKey: new Map(fields.map((f) => [f.key, f])),
+            transitions,
+            transitionSpecs,
+            onchange: [...description.onchange],
+            recName: recNameOf(registry, name, fields),
+        });
+    }
+    return out;
+}
+function recNameOf(registry, name, fields) {
+    const declared = registry.get(name).model.recName;
+    const key = typeof declared === 'string' ? declared : 'name';
+    const field = fields.find((f) => f.key === key);
+    return field?.stored === true && (field.kind === 'char' || field.kind === 'text') ? key : null;
+}
+/** Fields listed by default: stored, not binary, not x2many. */
+export function defaultFields(model) {
+    return model.fields.filter((f) => f.stored && f.kind !== 'binary' && f.kind !== 'one2many' && f.kind !== 'many2many');
+}
+/** The models the generated API serves: every installed model except the modules' `privateModels`. */
+export function publicApiModels(registry) {
+    const hidden = new Set(registry.loaded.modules.flatMap((m) => m.privateModels ?? []));
+    return new Map([...apiModels(registry.registry)].filter(([name]) => !hidden.has(name)));
+}
+//# sourceMappingURL=metadata.js.map

package/dist/api/metadata.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"metadata.js","sourceRoot":"","sources":["../../src/api/metadata.ts"],"names":[],"mappings":"AAqDA,MAAM,iBAAiB,GAAG,IAAI,GAAG,CAAC;IAChC,IAAI;IACJ,WAAW;IACX,WAAW;IACX,WAAW;IACX,WAAW;IACX,aAAa;CACd,CAAC,CAAC;AAEH,oCAAoC;AACpC,MAAM,UAAU,UAAU,CAAC,KAAa;IACtC,OAAO,KAAK;SACT,KAAK,CAAC,MAAM,CAAC;SACb,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;SAClD,IAAI,CAAC,EAAE,CAAC,CAAC;AACd,CAAC;AAED,uDAAuD;AACvD,MAAM,UAAU,SAAS,CAAC,QAAkB;IAC1C,MAAM,GAAG,GAAG,IAAI,GAAG,EAAoB,CAAC;IACxC,KAAK,MAAM,IAAI,IAAI,QAAQ,CAAC,MAAM,CAAC,IAAI,EAAE,EAAE,CAAC;QAC1C,MAAM,WAAW,GAAG,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QAC5C,MAAM,WAAW,GAAG,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,MAE5C,CAAC;QACF,MAAM,MAAM,GAAe,EAAE,CAAC;QAC9B,MAAM,WAAW,GAAa,EAAE,CAAC;QACjC,MAAM,eAAe,GAAqB,EAAE,CAAC;QAC7C,KAAK,MAAM,CAAC,GAAG,EAAE,CAAC,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,WAAW,CAAC,MAAM,CAAC,EAAE,CAAC;YAC1D,MAAM,GAAG,GAAG,WAAW,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC;YACnC,MAAM,SAAS,GAAG,GAAG,CAAC,WAAW,CAAC,CAAC;YACnC,IAAI,CAAC,CAAC,IAAI,KAAK,OAAO;gBACpB,KAAK,MAAM,CAAC,CAAC,EAAE,IAAI,CAAC,IAAI,MAAM,CAAC,OAAO,CACnC,GAAG,CAAC,aAAa,CAAyD,IAAI,EAAE,CAClF,EAAE,CAAC;oBACF,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;oBACpB,eAAe,CAAC,IAAI,CAAC;wBACnB,IAAI,EAAE,CAAC;wBACP,KAAK,EAAE,GAAG;wBACV,IAAI,EAAE,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAE,IAAI,CAAC,MAAM,CAAc,CAAC,CAAC,CAAC,EAAE;wBACnE,EAAE,EAAE,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;wBAC5B,QAAQ,EAAE,OAAO,IAAI,CAAC,UAAU,CAAC,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,IAAI;qBACzE,CAAC,CAAC;gBACL,CAAC;YACH,MAAM,gBAAgB,GAAG,CAAC,CAAC,QAAQ,IAAI,GAAG,CAAC,SAAS,CAAC,KAAK,SAAS,CAAC;YACpE,MAAM,CAAC,IAAI,CAAC;gBACV,GAAG;gBACH,IAAI,EAAE,CAAC,CAAC,IAAI;gBACZ,KAAK,EAAE,CAAC,CAAC,KAAK;gBACd,QAAQ,EAAE,CAAC,CAAC,QAAQ;gBACpB,QAAQ,EACN,CAAC,CAAC,QAAQ,IAAI,gBAAgB,IAAI,iBAAiB,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,IAAI,KAAK,OAAO;gBACpF,MAAM,EAAE,CAAC,CAAC,MAAM,KAAK,IAAI;gBACzB,gBAAgB,EACd,CAAC,CAAC,QAAQ;oBACV,CAAC,CAAC,CAAC,UAAU;oBACb,CAAC,CAAC,CAAC,QAAQ;oBACX,CAAC,CAAC,QAAQ,KAAK,IAAI;oBACnB,CAAC,iBAAiB,CAAC,GAAG,CAAC,GAAG,CAAC;gBAC7B,MAAM,EAAE,OAAO,CAAC,CAAC,QAAQ,CAAC,KAAK,QAAQ,CAAC,CAAC,CAAE,CAAC,CAAC,QAAQ,CAAY,CAAC,CAAC,CAAC,IAAI;gBACxE,OAAO,EAAE,KAAK,CAAC,OAAO,CAAC,SAAS,CAAC;oBAC/B,CAAC,CAAE,SAAoD;oBACvD,CAAC,CAAC,IAAI;gBACR,SAAS,EAAE,CAAC,CAAC,SAAS;aACvB,CAAC,CAAC;QACL,CAAC;QACD,GAAG,CAAC,GAAG,CAAC,IAAI,EAAE;YACZ,IAAI;YACJ,KAAK,EAAE,WAAW,CAAC,KAAK;YACxB,UAAU,EAAE,UAAU,CAAC,IAAI,CAAC;YAC5B,MAAM;YACN,KAAK,EAAE,IAAI,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,CAAC;YAC7C,WAAW;YACX,eAAe;YACf,QAAQ,EAAE,CAAC,GAAG,WAAW,CAAC,QAAQ,CAAC;YACnC,OAAO,EAAE,SAAS,CAAC,QAAQ,EAAE,IAAI,EAAE,MAAM,CAAC;SAC3C,CAAC,CAAC;IACL,CAAC;IACD,OAAO,GAAG,CAAC;AACb,CAAC;AAED,SAAS,SAAS,CAAC,QAAkB,EAAE,IAAY,EAAE,MAA2B;IAC9E,MAAM,QAAQ,GAAI,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,KAA0C,CAAC,OAAO,CAAC;IACxF,MAAM,GAAG,GAAG,OAAO,QAAQ,KAAK,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC;IAC7D,MAAM,KAAK,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,GAAG,KAAK,GAAG,CAAC,CAAC;IAChD,OAAO,KAAK,EAAE,MAAM,KAAK,IAAI,IAAI,CAAC,KAAK,CAAC,IAAI,KAAK,MAAM,IAAI,KAAK,CAAC,IAAI,KAAK,MAAM,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC;AACjG,CAAC;AAED,gEAAgE;AAChE,MAAM,UAAU,aAAa,CAAC,KAAe;IAC3C,OAAO,KAAK,CAAC,MAAM,CAAC,MAAM,CACxB,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,IAAI,CAAC,CAAC,IAAI,KAAK,QAAQ,IAAI,CAAC,CAAC,IAAI,KAAK,UAAU,IAAI,CAAC,CAAC,IAAI,KAAK,WAAW,CAC1F,CAAC;AACJ,CAAC;AAED,sGAAsG;AACtG,MAAM,UAAU,eAAe,CAAC,QAG/B;IACC,MAAM,MAAM,GAAG,IAAI,GAAG,CAAC,QAAQ,CAAC,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,aAAa,IAAI,EAAE,CAAC,CAAC,CAAC;IACtF,OAAO,IAAI,GAAG,CAAC,CAAC,GAAG,SAAS,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,EAAE,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;AAC1F,CAAC"}

package/dist/api/navigation.d.ts

@@ -0,0 +1,46 @@
+/**
+ * Apps, menus and actions per user (RFC 0003 §5.1 "visibility"): installing a module shows nothing; a user sees an
+ * app, menu or action only with an access level of its module, or a group / permission it names in `visibleTo`, and
+ * an action on a model only with read access to it. Administrators see everything. The server filters the tree and
+ * refuses actions it would not show: the UI hiding is a convenience, never the control.
+ *
+ * - `GET /api/v1/apps`          the launcher
+ * - `GET /api/v1/menus`         the menu tree (optionally `?app=`)
+ * - `GET /api/v1/actions/:id`   one action, 403 when not visible
+ */
+import type { KoshModule, LoadedModules, MenuSpec } from '@isahaq/kosh-modules-sdk';
+import type { FastifyInstance } from 'fastify';
+import type { Env } from '../orm.js';
+/** A visible menu entry with its visible children. */
+export interface MenuNode {
+    readonly id: string;
+    readonly label: string;
+    readonly app?: string;
+    readonly action?: string;
+    readonly sequence: number;
+    readonly children: MenuNode[];
+}
+/** True when the user holds an access level of the module (or is an administrator). */
+export declare function moduleVisible(env: Env, module: KoshModule): boolean;
+/** Navigation for a loaded module set. */
+export declare class Navigation {
+    #private;
+    constructor(loaded: LoadedModules);
+    /** The action spec, when the user may open it. */
+    actionVisible(env: Env, id: string): boolean;
+    menuVisible(env: Env, menu: MenuSpec & {
+        readonly module: string;
+    }): boolean;
+    /** The visible tree: hidden parents hide their children; entries without an action and visible children go. */
+    menus(env: Env, app?: string): MenuNode[];
+    /** The launcher: apps of modules the user has an access level of. */
+    apps(env: Env): {
+        code: string;
+        label: string;
+        icon?: string;
+        sequence: number;
+    }[];
+    /** Registers the routes. */
+    register(app: FastifyInstance): void;
+}
+//# sourceMappingURL=navigation.d.ts.map

package/dist/api/navigation.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"navigation.d.ts","sourceRoot":"","sources":["../../src/api/navigation.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AACH,OAAO,KAAK,EAAE,UAAU,EAAE,aAAa,EAAE,QAAQ,EAAE,MAAM,0BAA0B,CAAC;AACpF,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,SAAS,CAAC;AAE/C,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,WAAW,CAAC;AAErC,sDAAsD;AACtD,MAAM,WAAW,QAAQ;IACvB,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,GAAG,CAAC,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,QAAQ,EAAE,QAAQ,EAAE,CAAC;CAC/B;AAgBD,uFAAuF;AACvF,wBAAgB,aAAa,CAAC,GAAG,EAAE,GAAG,EAAE,MAAM,EAAE,UAAU,GAAG,OAAO,CAEnE;AAYD,0CAA0C;AAC1C,qBAAa,UAAU;;IAGrB,YAAY,MAAM,EAAE,aAAa,EAEhC;IAMD,kDAAkD;IAClD,aAAa,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE,EAAE,MAAM,GAAG,OAAO,CAgB3C;IAED,WAAW,CAAC,GAAG,EAAE,GAAG,EAAE,IAAI,EAAE,QAAQ,GAAG;QAAE,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAO3E;IAED,+GAA+G;IAC/G,KAAK,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,EAAE,MAAM,GAAG,QAAQ,EAAE,CAsBxC;IAQD,qEAAqE;IACrE,IAAI,CAAC,GAAG,EAAE,GAAG,GAAG;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAC;QAAC,IAAI,CAAC,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE,MAAM,CAAA;KAAE,EAAE,CAajF;IAED,4BAA4B;IAC5B,QAAQ,CAAC,GAAG,EAAE,eAAe,GAAG,IAAI,CA0BnC;CACF"}

package/dist/api/navigation.js

@@ -0,0 +1,131 @@
+import { HttpProblem } from '../errors.js';
+function holds(env, code) {
+    if (env.groups.has(code))
+        return true;
+    try {
+        return env.access.has(code); // a feature permission (by role, grant or administrator)
+    }
+    catch {
+        return false; // not a declared permission: a group the user does not hold
+    }
+}
+/** The groups of a module's access levels. */
+function levelGroups(module) {
+    return Object.values(module.accessLevels).flatMap((level) => [...level.groups]);
+}
+/** True when the user holds an access level of the module (or is an administrator). */
+export function moduleVisible(env, module) {
+    return env.administrator || levelGroups(module).some((g) => env.groups.has(g));
+}
+function actionModel(spec) {
+    const model = spec?.model;
+    return typeof model === 'string' ? model : undefined;
+}
+function visibleTo(spec) {
+    const codes = spec?.visibleTo;
+    return Array.isArray(codes) ? codes : undefined;
+}
+/** Navigation for a loaded module set. */
+export class Navigation {
+    #loaded;
+    constructor(loaded) {
+        this.#loaded = loaded;
+    }
+    #module(name) {
+        return this.#loaded.byName.get(name);
+    }
+    /** The action spec, when the user may open it. */
+    actionVisible(env, id) {
+        const owner = this.#loaded.actions.get(id);
+        if (owner === undefined)
+            return false;
+        if (env.administrator)
+            return true;
+        const module = this.#module(owner);
+        const spec = module.actions?.[id];
+        const codes = visibleTo(spec);
+        if (codes !== undefined ? !codes.some((c) => holds(env, c)) : !moduleVisible(env, module))
+            return false;
+        const model = actionModel(spec);
+        if (model === undefined)
+            return true;
+        try {
+            return env.access.can(model, 'read');
+        }
+        catch {
+            return false; // a model that is not installed
+        }
+    }
+    menuVisible(env, menu) {
+        if (env.administrator)
+            return true;
+        const own = menu.visibleTo !== undefined
+            ? menu.visibleTo.some((c) => holds(env, c))
+            : moduleVisible(env, this.#module(menu.module));
+        return own && (menu.action === undefined || this.actionVisible(env, menu.action));
+    }
+    /** The visible tree: hidden parents hide their children; entries without an action and visible children go. */
+    menus(env, app) {
+        const all = this.#loaded.menus.filter((m) => app === undefined || this.#appOf(m) === app);
+        const byParent = new Map();
+        for (const m of all) {
+            const parent = m.parent !== undefined && all.some((p) => p.id === m.parent) ? m.parent : undefined;
+            byParent.set(parent, [...(byParent.get(parent) ?? []), m]);
+        }
+        const build = (parent) => (byParent.get(parent) ?? [])
+            .filter((m) => this.menuVisible(env, m))
+            .map((m) => ({
+            id: m.id,
+            label: m.label,
+            ...(this.#appOf(m) === undefined ? {} : { app: this.#appOf(m) }),
+            ...(m.action === undefined ? {} : { action: m.action }),
+            sequence: m.sequence ?? 10,
+            children: build(m.id),
+        }))
+            .filter((m) => m.action !== undefined || m.children.length > 0)
+            .sort((a, b) => a.sequence - b.sequence || a.label.localeCompare(b.label));
+        return build(undefined);
+    }
+    #appOf(menu) {
+        if (menu.app !== undefined)
+            return menu.app;
+        const parent = this.#loaded.menus.find((m) => m.id === menu.parent);
+        return parent === undefined ? this.#module(menu.module).app?.code : this.#appOf(parent);
+    }
+    /** The launcher: apps of modules the user has an access level of. */
+    apps(env) {
+        return this.#loaded.modules
+            .filter((m) => m.app !== undefined && moduleVisible(env, m))
+            .map((m) => {
+            const app = m.app;
+            return {
+                code: app.code,
+                label: app.label,
+                ...(app.icon === undefined ? {} : { icon: app.icon }),
+                sequence: app.sequence ?? 10,
+            };
+        })
+            .sort((a, b) => a.sequence - b.sequence || a.label.localeCompare(b.label));
+    }
+    /** Registers the routes. */
+    register(app) {
+        app.get('/api/v1/apps', async (request) => request.env(async (env) => ({ apps: this.apps(env) })));
+        app.get('/api/v1/menus', async (request) => {
+            const q = (request.query ?? {});
+            const only = typeof q.app === 'string' && q.app !== '' ? q.app : undefined;
+            return request.env(async (env) => ({ menus: this.menus(env, only) }));
+        });
+        app.get('/api/v1/actions/:id', async (request) => {
+            const id = String(request.params.id ?? '');
+            const owner = this.#loaded.actions.get(id);
+            if (owner === undefined)
+                throw new HttpProblem(404, 'unknown-action', 'Unknown action', `No action '${id}'.`);
+            return request.env(async (env) => {
+                if (!this.actionVisible(env, id))
+                    throw new HttpProblem(403, 'access', 'Forbidden', `The action '${id}' is not available to this user.`, 'Ask an administrator for a role of its app.');
+                return { id, module: owner, spec: this.#module(owner).actions?.[id] ?? null };
+            });
+        });
+    }
+}
+//# sourceMappingURL=navigation.js.map

package/dist/api/navigation.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"navigation.js","sourceRoot":"","sources":["../../src/api/navigation.ts"],"names":[],"mappings":"AAYA,OAAO,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC;AAa3C,SAAS,KAAK,CAAC,GAAQ,EAAE,IAAY;IACnC,IAAI,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC;QAAE,OAAO,IAAI,CAAC;IACtC,IAAI,CAAC;QACH,OAAO,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,yDAAyD;IACxF,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,KAAK,CAAC,CAAC,4DAA4D;IAC5E,CAAC;AACH,CAAC;AAED,8CAA8C;AAC9C,SAAS,WAAW,CAAC,MAAkB;IACrC,OAAO,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC;AAClF,CAAC;AAED,uFAAuF;AACvF,MAAM,UAAU,aAAa,CAAC,GAAQ,EAAE,MAAkB;IACxD,OAAO,GAAG,CAAC,aAAa,IAAI,WAAW,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;AACjF,CAAC;AAED,SAAS,WAAW,CAAC,IAAa;IAChC,MAAM,KAAK,GAAI,IAAmC,EAAE,KAAK,CAAC;IAC1D,OAAO,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC;AACvD,CAAC;AAED,SAAS,SAAS,CAAC,IAAa;IAC9B,MAAM,KAAK,GAAI,IAAuC,EAAE,SAAS,CAAC;IAClE,OAAO,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAE,KAAkB,CAAC,CAAC,CAAC,SAAS,CAAC;AAChE,CAAC;AAED,0CAA0C;AAC1C,MAAM,OAAO,UAAU;IACZ,OAAO,CAAgB;IAEhC,YAAY,MAAqB;QAC/B,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;IACxB,CAAC;IAED,OAAO,CAAC,IAAY;QAClB,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAe,CAAC;IACrD,CAAC;IAED,kDAAkD;IAClD,aAAa,CAAC,GAAQ,EAAE,EAAU;QAChC,MAAM,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;QAC3C,IAAI,KAAK,KAAK,SAAS;YAAE,OAAO,KAAK,CAAC;QACtC,IAAI,GAAG,CAAC,aAAa;YAAE,OAAO,IAAI,CAAC;QACnC,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;QACnC,MAAM,IAAI,GAAG,MAAM,CAAC,OAAO,EAAE,CAAC,EAAE,CAAC,CAAC;QAClC,MAAM,KAAK,GAAG,SAAS,CAAC,IAAI,CAAC,CAAC;QAC9B,IAAI,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC,GAAG,EAAE,MAAM,CAAC;YACvF,OAAO,KAAK,CAAC;QACf,MAAM,KAAK,GAAG,WAAW,CAAC,IAAI,CAAC,CAAC;QAChC,IAAI,KAAK,KAAK,SAAS;YAAE,OAAO,IAAI,CAAC;QACrC,IAAI,CAAC;YACH,OAAO,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,KAAc,EAAE,MAAM,CAAC,CAAC;QAChD,CAAC;QAAC,MAAM,CAAC;YACP,OAAO,KAAK,CAAC,CAAC,gCAAgC;QAChD,CAAC;IACH,CAAC;IAED,WAAW,CAAC,GAAQ,EAAE,IAA4C;QAChE,IAAI,GAAG,CAAC,aAAa;YAAE,OAAO,IAAI,CAAC;QACnC,MAAM,GAAG,GACP,IAAI,CAAC,SAAS,KAAK,SAAS;YAC1B,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC;YAC3C,CAAC,CAAC,aAAa,CAAC,GAAG,EAAE,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC;QACpD,OAAO,GAAG,IAAI,CAAC,IAAI,CAAC,MAAM,KAAK,SAAS,IAAI,IAAI,CAAC,aAAa,CAAC,GAAG,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC;IACpF,CAAC;IAED,+GAA+G;IAC/G,KAAK,CAAC,GAAQ,EAAE,GAAY;QAC1B,MAAM,GAAG,GAAG,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,GAAG,KAAK,SAAS,IAAI,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,GAAG,CAAC,CAAC;QAC1F,MAAM,QAAQ,GAAG,IAAI,GAAG,EAAyD,CAAC;QAClF,KAAK,MAAM,CAAC,IAAI,GAAG,EAAE,CAAC;YACpB,MAAM,MAAM,GACV,CAAC,CAAC,MAAM,KAAK,SAAS,IAAI,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC;YACtF,QAAQ,CAAC,GAAG,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;QAC7D,CAAC;QACD,MAAM,KAAK,GAAG,CAAC,MAA0B,EAAc,EAAE,CACvD,CAAC,QAAQ,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC;aACzB,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,WAAW,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC;aACvC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;YACX,EAAE,EAAE,CAAC,CAAC,EAAE;YACR,KAAK,EAAE,CAAC,CAAC,KAAK;YACd,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC,CAAW,EAAE,CAAC;YAC1E,GAAG,CAAC,CAAC,CAAC,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC;YACvD,QAAQ,EAAE,CAAC,CAAC,QAAQ,IAAI,EAAE;YAC1B,QAAQ,EAAE,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC;SACtB,CAAC,CAAC;aACF,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,KAAK,SAAS,IAAI,CAAC,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC;aAC9D,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,GAAG,CAAC,CAAC,QAAQ,IAAI,CAAC,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC;QAC/E,OAAO,KAAK,CAAC,SAAS,CAAC,CAAC;IAC1B,CAAC;IAED,MAAM,CAAC,IAA4C;QACjD,IAAI,IAAI,CAAC,GAAG,KAAK,SAAS;YAAE,OAAO,IAAI,CAAC,GAAG,CAAC;QAC5C,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,IAAI,CAAC,MAAM,CAAC,CAAC;QACpE,OAAO,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;IAC1F,CAAC;IAED,qEAAqE;IACrE,IAAI,CAAC,GAAQ;QACX,OAAO,IAAI,CAAC,OAAO,CAAC,OAAO;aACxB,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,GAAG,KAAK,SAAS,IAAI,aAAa,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC;aAC3D,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE;YACT,MAAM,GAAG,GAAG,CAAC,CAAC,GAAqC,CAAC;YACpD,OAAO;gBACL,IAAI,EAAE,GAAG,CAAC,IAAI;gBACd,KAAK,EAAE,GAAG,CAAC,KAAK;gBAChB,GAAG,CAAC,GAAG,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,GAAG,CAAC,IAAI,EAAE,CAAC;gBACrD,QAAQ,EAAE,GAAG,CAAC,QAAQ,IAAI,EAAE;aAC7B,CAAC;QACJ,CAAC,CAAC;aACD,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,GAAG,CAAC,CAAC,QAAQ,IAAI,CAAC,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC;IAC/E,CAAC;IAED,4BAA4B;IAC5B,QAAQ,CAAC,GAAoB;QAC3B,GAAG,CAAC,GAAG,CAAC,cAAc,EAAE,KAAK,EAAE,OAAO,EAAE,EAAE,CACxC,OAAO,CAAC,GAAG,CAAC,KAAK,EAAE,GAAG,EAAE,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,CACvD,CAAC;QACF,GAAG,CAAC,GAAG,CAAC,eAAe,EAAE,KAAK,EAAE,OAAO,EAAE,EAAE;YACzC,MAAM,CAAC,GAAG,CAAC,OAAO,CAAC,KAAK,IAAI,EAAE,CAAsB,CAAC;YACrD,MAAM,IAAI,GAAG,OAAO,CAAC,CAAC,GAAG,KAAK,QAAQ,IAAI,CAAC,CAAC,GAAG,KAAK,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,SAAS,CAAC;YAC3E,OAAO,OAAO,CAAC,GAAG,CAAC,KAAK,EAAE,GAAG,EAAE,EAAE,CAAC,CAAC,EAAE,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,GAAG,EAAE,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC;QACxE,CAAC,CAAC,CAAC;QACH,GAAG,CAAC,GAAG,CAAC,qBAAqB,EAAE,KAAK,EAAE,OAAO,EAAE,EAAE;YAC/C,MAAM,EAAE,GAAG,MAAM,CAAE,OAAO,CAAC,MAA2B,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC;YACjE,MAAM,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;YAC3C,IAAI,KAAK,KAAK,SAAS;gBACrB,MAAM,IAAI,WAAW,CAAC,GAAG,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,cAAc,EAAE,IAAI,CAAC,CAAC;YACvF,OAAO,OAAO,CAAC,GAAG,CAAC,KAAK,EAAE,GAAG,EAAE,EAAE;gBAC/B,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,GAAG,EAAE,EAAE,CAAC;oBAC9B,MAAM,IAAI,WAAW,CACnB,GAAG,EACH,QAAQ,EACR,WAAW,EACX,eAAe,EAAE,kCAAkC,EACnD,6CAA6C,CAC9C,CAAC;gBACJ,OAAO,EAAE,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,OAAO,EAAE,CAAC,EAAE,CAAC,IAAI,IAAI,EAAE,CAAC;YAChF,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC;CACF"}

package/dist/api/openapi.d.ts

@@ -0,0 +1,22 @@
+/**
+ * The OpenAPI 3.1 document of the installed module set (RFC 0002 §6.4), generated from the model metadata: one read
+ * schema, one create schema and one update schema per model, the generated paths, and RFC 9457 problems. Per-user
+ * restrictions (ACL, field groups, rules) are enforced at request time and visible in `/api/v1/meta/{model}`.
+ */
+import type { KoshModule } from '@isahaq/kosh-modules-sdk';
+import { type ApiField, type ApiModel } from './metadata.js';
+type Schema = Record<string, unknown>;
+/** The read schema of one field value. */
+export declare function fieldSchema(field: ApiField): Schema;
+/** The OpenAPI 3.1 document for these models. */
+export declare function openApiDocument(models: Iterable<ApiModel>, info: {
+    readonly title: string;
+    readonly version: string;
+}): Schema;
+/**
+ * The OpenAPI document of a module set, without a database or a running server (what `kosh generate client` uses).
+ * @throws {ServerConfigError} for modules that cannot load together
+ */
+export declare function openApiOf(modules: readonly KoshModule[]): Schema;
+export {};
+//# sourceMappingURL=openapi.d.ts.map

package/dist/api/openapi.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"openapi.d.ts","sourceRoot":"","sources":["../../src/api/openapi.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,0BAA0B,CAAC;AAE3D,OAAO,EAAE,KAAK,QAAQ,EAAE,KAAK,QAAQ,EAAkC,MAAM,eAAe,CAAC;AAE7F,KAAK,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;AAUtC,0CAA0C;AAC1C,wBAAgB,WAAW,CAAC,KAAK,EAAE,QAAQ,GAAG,MAAM,CAiDnD;AAsOD,iDAAiD;AACjD,wBAAgB,eAAe,CAC7B,MAAM,EAAE,QAAQ,CAAC,QAAQ,CAAC,EAC1B,IAAI,EAAE;IAAE,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAA;CAAE,GACzD,MAAM,CA6DR;AAED;;;GAGG;AACH,wBAAgB,SAAS,CAAC,OAAO,EAAE,SAAS,UAAU,EAAE,GAAG,MAAM,CAGhE"}

package/dist/api/openapi.js

@@ -0,0 +1,349 @@
+import { buildKoshRegistry, KOSH_VERSION } from '../registry.js';
+import { defaultFields, publicApiModels } from './metadata.js';
+const PROBLEM = { $ref: '#/components/schemas/Problem' };
+function nullable(schema, required) {
+    if (required)
+        return schema;
+    if (typeof schema['type'] === 'string')
+        return { ...schema, type: [schema['type'], 'null'] };
+    return { oneOf: [schema, { type: 'null' }] };
+}
+/** The read schema of one field value. */
+export function fieldSchema(field) {
+    const base = (() => {
+        switch (field.kind) {
+            case 'char':
+            case 'text':
+            case 'html':
+                return { type: 'string' };
+            case 'boolean':
+                return { type: 'boolean' };
+            case 'integer':
+            case 'bigint':
+                return { type: 'integer' };
+            case 'float':
+                return { type: 'number' };
+            case 'decimal':
+                return {
+                    type: 'string',
+                    pattern: '^-?\\d+(\\.\\d+)?$',
+                    description: 'Exact decimal as a string (never a float).',
+                };
+            case 'monetary':
+                return { $ref: '#/components/schemas/Money' };
+            case 'quantity':
+                return { $ref: '#/components/schemas/Quantity' };
+            case 'date':
+                return { type: 'string', format: 'date' };
+            case 'datetime':
+                return { type: 'string', format: 'date-time' };
+            case 'selection':
+            case 'state':
+                return field.options === null
+                    ? { type: 'string' }
+                    : { type: 'string', enum: field.options.map(([v]) => v) };
+            case 'many2one':
+                return { type: 'integer', description: `Id of a ${field.target} record.` };
+            case 'one2many':
+            case 'many2many':
+                return {
+                    type: 'array',
+                    items: { type: 'integer' },
+                    description: `Ids of ${field.target} records.`,
+                };
+            case 'binary':
+                return { type: 'string', contentEncoding: 'base64' };
+            default:
+                return {};
+        }
+    })();
+    return { ...nullable(base, field.required || field.key === 'id'), title: field.label };
+}
+function writeSchema(field) {
+    if (field.kind === 'one2many' || field.kind === 'many2many')
+        return {
+            type: 'object',
+            title: field.label,
+            description: `Commands on ${field.target} records.`,
+            properties: {
+                create: { type: 'array', items: { type: 'object' } },
+                update: {
+                    type: 'array',
+                    items: {
+                        type: 'object',
+                        properties: { id: { type: 'integer' }, values: { type: 'object' } },
+                        required: ['id', 'values'],
+                    },
+                },
+                delete: { type: 'array', items: { type: 'integer' } },
+                link: { type: 'array', items: { type: 'integer' } },
+                unlink: { type: 'array', items: { type: 'integer' } },
+                set: { type: 'array', items: { type: 'integer' } },
+                clear: { type: 'boolean', const: true },
+            },
+            additionalProperties: false,
+        };
+    if (field.kind === 'monetary')
+        return nullable({
+            type: 'string',
+            pattern: '^-?\\d+(\\.\\d+)?$',
+            description: 'Amount in the record currency.',
+        }, field.required);
+    if (field.translate)
+        return nullable({ type: 'string', description: 'Text in the request language.' }, field.required);
+    return fieldSchema(field);
+}
+function modelSchemas(model) {
+    const readable = model.fields.filter((f) => f.kind !== 'binary');
+    const writable = model.fields.filter((f) => !f.readonly);
+    return {
+        [model.schemaName]: {
+            type: 'object',
+            title: model.label,
+            properties: Object.fromEntries(readable.map((f) => [f.key, fieldSchema(f)])),
+            required: defaultFields(model)
+                .filter((f) => f.required || f.key === 'id')
+                .map((f) => f.key),
+        },
+        [`${model.schemaName}Create`]: {
+            type: 'object',
+            properties: Object.fromEntries(writable.map((f) => [f.key, writeSchema(f)])),
+            required: writable.filter((f) => f.requiredOnCreate).map((f) => f.key),
+            additionalProperties: false,
+        },
+        [`${model.schemaName}Update`]: {
+            type: 'object',
+            properties: Object.fromEntries(writable.map((f) => [f.key, writeSchema(f)])),
+            additionalProperties: false,
+        },
+    };
+}
+function responses(ok, okStatus = '200') {
+    const problem = { content: { 'application/problem+json': { schema: PROBLEM } } };
+    return {
+        [okStatus]: { description: 'OK', content: { 'application/json': { schema: ok } } },
+        '400': { description: 'Invalid request', ...problem },
+        '401': { description: 'Not authenticated', ...problem },
+        '403': { description: 'Forbidden', ...problem },
+        '404': { description: 'Not found', ...problem },
+        '412': { description: 'Changed since read (If-Match)', ...problem },
+        '422': { description: 'Invalid values', ...problem },
+        '429': { description: 'Rate limited', ...problem },
+    };
+}
+const ID_PARAM = {
+    name: 'id',
+    in: 'path',
+    required: true,
+    schema: { type: 'integer', minimum: 1 },
+};
+const IDEMPOTENCY = {
+    name: 'Idempotency-Key',
+    in: 'header',
+    required: false,
+    schema: { type: 'string', maxLength: 128 },
+    description: 'Replays the first response for a retried request with the same key.',
+};
+function modelPaths(model) {
+    const s = model.schemaName;
+    const ref = { $ref: `#/components/schemas/${s}` };
+    const base = `/api/v1/models/${model.name}`;
+    const tag = [model.name];
+    const paths = {
+        [base]: {
+            get: {
+                operationId: `list${s}`,
+                tags: tag,
+                summary: `Search ${model.label} records`,
+                parameters: [
+                    {
+                        name: 'filter',
+                        in: 'query',
+                        schema: { type: 'string' },
+                        description: 'A Shutro domain as JSON, e.g. {"name":{"ilike":"acme%"}}.',
+                    },
+                    {
+                        name: 'order',
+                        in: 'query',
+                        schema: { type: 'string' },
+                        description: "Comma-separated, e.g. 'name asc,id desc'.",
+                    },
+                    {
+                        name: 'fields',
+                        in: 'query',
+                        schema: { type: 'string' },
+                        description: 'Comma-separated field keys.',
+                    },
+                    {
+                        name: 'limit',
+                        in: 'query',
+                        schema: { type: 'integer', minimum: 1, maximum: 1000, default: 80 },
+                    },
+                    { name: 'offset', in: 'query', schema: { type: 'integer', minimum: 0, default: 0 } },
+                    {
+                        name: 'count',
+                        in: 'query',
+                        schema: { type: 'boolean' },
+                        description: 'Also return the total count.',
+                    },
+                ],
+                responses: responses({
+                    type: 'object',
+                    properties: { items: { type: 'array', items: ref }, count: { type: 'integer' } },
+                    required: ['items'],
+                }),
+            },
+            post: {
+                operationId: `create${s}`,
+                tags: tag,
+                summary: `Create ${model.label} records`,
+                parameters: [IDEMPOTENCY],
+                requestBody: {
+                    required: true,
+                    content: { 'application/json': { schema: { $ref: `#/components/schemas/${s}Create` } } },
+                },
+                responses: responses(ref, '201'),
+            },
+        },
+        [`${base}/{id}`]: {
+            get: { operationId: `get${s}`, tags: tag, parameters: [ID_PARAM], responses: responses(ref) },
+            patch: {
+                operationId: `update${s}`,
+                tags: tag,
+                parameters: [
+                    ID_PARAM,
+                    IDEMPOTENCY,
+                    {
+                        name: 'If-Match',
+                        in: 'header',
+                        schema: { type: 'string' },
+                        description: 'The ETag read with the record: refuses the update (412) if it changed since.',
+                    },
+                ],
+                requestBody: {
+                    required: true,
+                    content: { 'application/json': { schema: { $ref: `#/components/schemas/${s}Update` } } },
+                },
+                responses: responses(ref),
+            },
+            delete: {
+                operationId: `delete${s}`,
+                tags: tag,
+                parameters: [ID_PARAM, IDEMPOTENCY],
+                responses: responses({ type: 'object', properties: { deleted: { type: 'integer' } } }),
+            },
+        },
+        [`${base}/aggregate`]: {
+            post: {
+                operationId: `aggregate${s}`,
+                tags: tag,
+                requestBody: {
+                    required: true,
+                    content: {
+                        'application/json': { schema: { $ref: '#/components/schemas/AggregateQuery' } },
+                    },
+                },
+                responses: responses({
+                    type: 'object',
+                    properties: { rows: { type: 'array', items: { type: 'object' } } },
+                }),
+            },
+        },
+        [`${base}/onchange`]: {
+            post: {
+                operationId: `onchange${s}`,
+                tags: tag,
+                requestBody: {
+                    required: true,
+                    content: {
+                        'application/json': { schema: { $ref: '#/components/schemas/OnchangeInput' } },
+                    },
+                },
+                responses: responses({ $ref: '#/components/schemas/OnchangeResult' }),
+            },
+        },
+    };
+    for (const t of model.transitions)
+        paths[`${base}/{id}/transitions/${t}`] = {
+            post: {
+                operationId: `${t}${s}`,
+                tags: tag,
+                summary: `Transition: ${t}`,
+                parameters: [ID_PARAM, IDEMPOTENCY],
+                responses: responses(ref),
+            },
+        };
+    return paths;
+}
+/** The OpenAPI 3.1 document for these models. */
+export function openApiDocument(models, info) {
+    const list = [...models];
+    return {
+        openapi: '3.1.0',
+        info,
+        paths: Object.assign({}, ...list.map(modelPaths)),
+        components: {
+            schemas: {
+                Problem: {
+                    type: 'object',
+                    properties: {
+                        type: { type: 'string' },
+                        title: { type: 'string' },
+                        status: { type: 'integer' },
+                        detail: { type: 'string' },
+                        hint: { type: 'string' },
+                    },
+                    required: ['type', 'title', 'status', 'detail'],
+                },
+                Money: {
+                    type: 'object',
+                    properties: { amount: { type: 'string' }, currency: { type: 'string' } },
+                    required: ['amount', 'currency'],
+                },
+                Quantity: {
+                    type: 'object',
+                    properties: { value: { type: 'string' }, uom: { type: 'string' } },
+                    required: ['value', 'uom'],
+                },
+                AggregateQuery: {
+                    type: 'object',
+                    properties: {
+                        where: { type: 'object' },
+                        groupBy: { type: 'array', items: { type: 'string' } },
+                        measures: { type: 'object' },
+                        order: { type: 'array', items: { type: 'string' } },
+                        limit: { type: 'integer' },
+                    },
+                    required: ['measures'],
+                },
+                OnchangeInput: {
+                    type: 'object',
+                    properties: {
+                        id: { type: 'integer' },
+                        values: { type: 'object' },
+                        changed: { type: 'array', items: { type: 'string' } },
+                    },
+                    required: ['values', 'changed'],
+                },
+                OnchangeResult: {
+                    type: 'object',
+                    properties: {
+                        values: { type: 'object' },
+                        warnings: { type: 'array', items: { type: 'string' } },
+                        children: { type: 'object' },
+                    },
+                },
+                ...Object.assign({}, ...list.map(modelSchemas)),
+            },
+        },
+    };
+}
+/**
+ * The OpenAPI document of a module set, without a database or a running server (what `kosh generate client` uses).
+ * @throws {ServerConfigError} for modules that cannot load together
+ */
+export function openApiOf(modules) {
+    const models = publicApiModels(buildKoshRegistry(modules));
+    return openApiDocument(models.values(), { title: 'Kosh API', version: KOSH_VERSION });
+}
+//# sourceMappingURL=openapi.js.map