@tekki-forge/runtime-api 0.1.0

package/dist/bootstrap.js

@@ -0,0 +1,191 @@
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+import "reflect-metadata";
+import { Module } from "@nestjs/common";
+import { NestFactory } from "@nestjs/core";
+import { SwaggerModule } from "@nestjs/swagger";
+import { toNodeHandler } from "better-auth/node";
+import express from "express";
+import { FORGE_SERVICE, ResourceController, SystemController } from "./controllers.js";
+import { ForgeExceptionFilter } from "./errors.js";
+import { createBackup, filesFromPrisma, localBackupStore } from "./backup.js";
+import { ForgeService } from "./service.js";
+let ForgeRootModule = class ForgeRootModule {
+};
+ForgeRootModule = __decorate([
+    Module({})
+], ForgeRootModule);
+export function forgeModule(service, imports = [], pluginControllers = []) {
+    return {
+        module: ForgeRootModule,
+        imports,
+        // Order matters: fixed system and plugin routes must win over the generic `:resource` routes.
+        controllers: [SystemController, ...pluginControllers, ResourceController],
+        providers: [{ provide: FORGE_SERVICE, useValue: service }],
+        exports: [FORGE_SERVICE],
+    };
+}
+/** Instantiate the service and run every plugin's setup (shared by the API server and the worker). */
+export async function setupForge(options) {
+    const service = new ForgeService(options);
+    const shared = service.shared;
+    shared.set("jobDefinitions", [...(options.jobs ?? []), ...(options.app.backups?.schedule ? [backupJob(options.app, service)] : [])]);
+    const plugins = [];
+    for (const runtime of options.plugins ?? []) {
+        const plugin = options.app.plugins.find((p) => p.name === runtime.name);
+        if (!plugin)
+            throw new Error(`[forge] plugin runtime "${runtime.name}" is installed but not listed in forge.config.ts plugins — run forge generate`);
+        const ctx = {
+            app: options.app,
+            plugin,
+            prisma: options.prisma,
+            service,
+            events: service.events,
+            env: process.env,
+            provideFileStore: (store) => service.useFileStore(store),
+            provide: (name, value) => void shared.set(name, value),
+            use: (name) => shared.get(name),
+        };
+        await runtime.setup?.(ctx);
+        plugins.push({ runtime, ctx });
+    }
+    for (const p of options.app.plugins) {
+        if (p.runtime.api && !plugins.some((x) => x.runtime.name === p.name)) {
+            throw new Error(`[forge] forge.config.ts lists the "${p.name}" plugin but its runtime is not loaded — run forge generate`);
+        }
+    }
+    service.assertReady();
+    return { service, plugins };
+}
+/**
+ * `backups: { schedule }` in forge.config.ts: a cron job run by the jobs plugin's worker. It needs pg_dump
+ * (postgresql-client, installed in the generated API image) and stores to S3 when the storage plugin uses
+ * S3, else to FORGE_BACKUP_DIR (default ./backups — mount a volume there).
+ */
+export function backupJob(app, service) {
+    return {
+        name: "forge.backup",
+        schedule: app.backups.schedule,
+        attempts: 2,
+        backoff: 5 * 60_000,
+        timeout: 2 * 60 * 60_000,
+        async handler({ log }) {
+            const databaseUrl = process.env.DATABASE_URL;
+            if (!databaseUrl)
+                throw new Error("[backup] DATABASE_URL is not set");
+            const store = service.shared.get("backupStore");
+            const { manifest, pruned } = await createBackup({
+                databaseUrl,
+                store: store ?? localBackupStore(process.env.FORGE_BACKUP_DIR || "backups"),
+                app: { name: app.name, slug: app.slug },
+                files: () => filesFromPrisma(service.prisma),
+                fileStorage: service.shared.get("backupFileStorage") ?? null,
+                keep: app.backups.keep,
+                log,
+            });
+            return { name: manifest.name, bytes: manifest.dump.bytes, files: manifest.files.count, pruned };
+        },
+    };
+}
+export async function createForgeApi(options) {
+    return (await createForge(options)).app;
+}
+export async function createForge(options) {
+    const { service, plugins } = await setupForge(options);
+    const prefix = options.app.api.prefix;
+    const pluginImports = plugins.flatMap((p) => p.runtime.imports ?? []);
+    const pluginControllers = plugins.flatMap((p) => p.runtime.controllers ?? []);
+    const app = await NestFactory.create(forgeModule(service, [...(options.imports ?? []), ...pluginImports], pluginControllers), {
+        bodyParser: false,
+        logger: options.logger ?? ["log", "warn", "error"],
+    });
+    const server = app.getHttpAdapter().getInstance();
+    server.set("trust proxy", true);
+    server.disable("x-powered-by");
+    // Better Auth reads the raw body, so it is mounted before the JSON parser.
+    server.all(`${prefix}/auth/*splat`, toNodeHandler(options.auth));
+    // Signed webhooks (e.g. Stripe) must be verified against the exact bytes received.
+    for (const path of plugins.flatMap((p) => p.runtime.rawBodyPaths ?? []))
+        server.use(`${prefix}${path}`, express.raw({ type: "*/*", limit: "1mb" }));
+    server.use(express.json({ limit: "1mb" }));
+    if (options.cors?.length)
+        app.enableCors({ origin: options.cors, credentials: true });
+    app.setGlobalPrefix(prefix.replace(/^\//, ""));
+    app.useGlobalFilters(new ForgeExceptionFilter());
+    if (options.openapi && options.app.api.docs) {
+        const doc = options.openapi;
+        server.get(`${prefix}/openapi.json`, (_req, res) => {
+            res.json(doc);
+        });
+        SwaggerModule.setup(`${prefix.replace(/^\//, "")}/docs`, app, doc, {
+            useGlobalPrefix: false,
+            customSiteTitle: `${options.app.name} API`,
+            swaggerOptions: { withCredentials: true, persistAuthorization: true },
+        });
+    }
+    return { app, service, plugins };
+}
+export async function startForgeApi(options) {
+    const { app, plugins } = await createForge(options);
+    app.enableShutdownHooks();
+    const stop = async () => {
+        for (const p of plugins)
+            await p.runtime.onStop?.(p.ctx);
+    };
+    process.once("SIGTERM", () => void stop());
+    process.once("SIGINT", () => void stop());
+    const port = options.port ?? Number(process.env.API_PORT ?? process.env.PORT ?? 4000);
+    await app.listen(port, options.host ?? "0.0.0.0");
+    console.log(`[forge] ${options.app.name} API listening on http://localhost:${port}${options.app.api.prefix}`);
+    if (options.openapi && options.app.api.docs)
+        console.log(`[forge] API docs: http://localhost:${port}${options.app.api.prefix}/docs`);
+    for (const p of plugins)
+        await p.runtime.onStart?.(p.ctx);
+    return app;
+}
+/**
+ * Background worker process: same setup as the API (plugins, file store, mail) but no HTTP server.
+ * Started by apps/api/src/worker.ts.
+ */
+export async function startForgeWorker(options) {
+    const { service, plugins } = await setupForge(options);
+    const contexts = [];
+    for (const runtime of options.workerPlugins) {
+        const api = plugins.find((p) => p.runtime.name === runtime.name);
+        const plugin = options.app.plugins.find((p) => p.name === runtime.name);
+        if (!plugin)
+            throw new Error(`[forge] worker plugin "${runtime.name}" is not listed in forge.config.ts`);
+        const ctx = api?.ctx ?? {
+            app: options.app,
+            plugin,
+            prisma: options.prisma,
+            service,
+            events: service.events,
+            env: process.env,
+            provideFileStore: (store) => service.useFileStore(store),
+            provide: (name, value) => void service.shared.set(name, value),
+            use: (name) => service.shared.get(name),
+        };
+        await runtime.setup?.(ctx);
+        contexts.push({ runtime, ctx });
+    }
+    if (!options.workerPlugins.some((w) => w.name === "jobs"))
+        console.warn("[forge] the worker has nothing to run — add the jobs plugin (forge add jobs)");
+    for (const c of contexts)
+        await c.runtime.onStart?.(c.ctx);
+    console.log(`[forge] ${options.app.name} worker started`);
+    const stop = async () => {
+        for (const c of contexts)
+            await c.runtime.onStop?.(c.ctx);
+        for (const p of plugins)
+            await p.runtime.onStop?.(p.ctx);
+    };
+    process.once("SIGTERM", () => void stop().then(() => process.exit(0)));
+    process.once("SIGINT", () => void stop().then(() => process.exit(0)));
+    return { stop };
+}
+//# sourceMappingURL=bootstrap.js.map

package/dist/bootstrap.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"bootstrap.js","sourceRoot":"","sources":["../src/bootstrap.ts"],"names":[],"mappings":";;;;;;AAAA,OAAO,kBAAkB,CAAC;AAC1B,OAAO,EAAE,MAAM,EAAuE,MAAM,gBAAgB,CAAC;AAC7G,OAAO,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC;AAC3C,OAAO,EAAE,aAAa,EAAsB,MAAM,iBAAiB,CAAC;AACpE,OAAO,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AACjD,OAAO,OAAO,MAAM,SAAS,CAAC;AAC9B,OAAO,EAAE,aAAa,EAAE,kBAAkB,EAAE,gBAAgB,EAAE,MAAM,kBAAkB,CAAC;AACvF,OAAO,EAAE,oBAAoB,EAAE,MAAM,aAAa,CAAC;AAGnD,OAAO,EAAE,YAAY,EAAE,eAAe,EAAE,gBAAgB,EAAoB,MAAM,aAAa,CAAC;AAEhG,OAAO,EAAE,YAAY,EAA4B,MAAM,cAAc,CAAC;AAiBtE,IAAM,eAAe,GAArB,MAAM,eAAe;CAAG,CAAA;AAAlB,eAAe;IADpB,MAAM,CAAC,EAAE,CAAC;GACL,eAAe,CAAG;AAExB,MAAM,UAAU,WAAW,CAAC,OAAqB,EAAE,UAAoC,EAAE,EAAE,oBAA4B,EAAE;IACvH,OAAO;QACL,MAAM,EAAE,eAAe;QACvB,OAAO;QACP,8FAA8F;QAC9F,WAAW,EAAE,CAAC,gBAAgB,EAAE,GAAG,iBAAiB,EAAE,kBAAkB,CAAC;QACzE,SAAS,EAAE,CAAC,EAAE,OAAO,EAAE,aAAa,EAAE,QAAQ,EAAE,OAAO,EAAE,CAAC;QAC1D,OAAO,EAAE,CAAC,aAAa,CAAC;KACzB,CAAC;AACJ,CAAC;AAQD,sGAAsG;AACtG,MAAM,CAAC,KAAK,UAAU,UAAU,CAAC,OAAwB;IACvD,MAAM,OAAO,GAAG,IAAI,YAAY,CAAC,OAAO,CAAC,CAAC;IAC1C,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAC9B,MAAM,CAAC,GAAG,CAAC,gBAAgB,EAAE,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,IAAI,EAAE,CAAC,EAAE,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,OAAO,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;IACrI,MAAM,OAAO,GAAsD,EAAE,CAAC;IACtE,KAAK,MAAM,OAAO,IAAI,OAAO,CAAC,OAAO,IAAI,EAAE,EAAE,CAAC;QAC5C,MAAM,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;QACxE,IAAI,CAAC,MAAM;YAAE,MAAM,IAAI,KAAK,CAAC,2BAA2B,OAAO,CAAC,IAAI,+EAA+E,CAAC,CAAC;QACrJ,MAAM,GAAG,GAAkB;YACzB,GAAG,EAAE,OAAO,CAAC,GAAG;YAChB,MAAM;YACN,MAAM,EAAE,OAAO,CAAC,MAAM;YACtB,OAAO;YACP,MAAM,EAAE,OAAO,CAAC,MAAM;YACtB,GAAG,EAAE,OAAO,CAAC,GAAG;YAChB,gBAAgB,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,OAAO,CAAC,YAAY,CAAC,KAAK,CAAC;YACxD,OAAO,EAAE,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC,KAAK,MAAM,CAAC,GAAG,CAAC,IAAI,EAAE,KAAK,CAAC;YACtD,GAAG,EAAE,CAAK,IAAY,EAAE,EAAE,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAkB;SAC7D,CAAC;QACF,MAAM,OAAO,CAAC,KAAK,EAAE,CAAC,GAAG,CAAC,CAAC;QAC3B,OAAO,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,GAAG,EAAE,CAAC,CAAC;IACjC,CAAC;IACD,KAAK,MAAM,CAAC,IAAI,OAAO,CAAC,GAAG,CAAC,OAAO,EAAE,CAAC;QACpC,IAAI,CAAC,CAAC,OAAO,CAAC,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,KAAK,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC;YACrE,MAAM,IAAI,KAAK,CAAC,sCAAsC,CAAC,CAAC,IAAI,6DAA6D,CAAC,CAAC;QAC7H,CAAC;IACH,CAAC;IACD,OAAO,CAAC,WAAW,EAAE,CAAC;IACtB,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,CAAC;AAC9B,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,SAAS,CAAC,GAAU,EAAE,OAAqB;IACzD,OAAO;QACL,IAAI,EAAE,cAAc;QACpB,QAAQ,EAAE,GAAG,CAAC,OAAQ,CAAC,QAAS;QAChC,QAAQ,EAAE,CAAC;QACX,OAAO,EAAE,CAAC,GAAG,MAAM;QACnB,OAAO,EAAE,CAAC,GAAG,EAAE,GAAG,MAAM;QACxB,KAAK,CAAC,OAAO,CAAC,EAAE,GAAG,EAAE;YACnB,MAAM,WAAW,GAAG,OAAO,CAAC,GAAG,CAAC,YAAY,CAAC;YAC7C,IAAI,CAAC,WAAW;gBAAE,MAAM,IAAI,KAAK,CAAC,kCAAkC,CAAC,CAAC;YACtE,MAAM,KAAK,GAAG,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,aAAa,CAA4B,CAAC;YAC3E,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,GAAG,MAAM,YAAY,CAAC;gBAC9C,WAAW;gBACX,KAAK,EAAE,KAAK,IAAI,gBAAgB,CAAC,OAAO,CAAC,GAAG,CAAC,gBAAgB,IAAI,SAAS,CAAC;gBAC3E,GAAG,EAAE,EAAE,IAAI,EAAE,GAAG,CAAC,IAAI,EAAE,IAAI,EAAE,GAAG,CAAC,IAAI,EAAE;gBACvC,KAAK,EAAE,GAAG,EAAE,CAAC,eAAe,CAAC,OAAO,CAAC,MAAM,CAAC;gBAC5C,WAAW,EAAG,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,mBAAmB,CAAwB,IAAI,IAAI;gBACpF,IAAI,EAAE,GAAG,CAAC,OAAQ,CAAC,IAAI;gBACvB,GAAG;aACJ,CAAC,CAAC;YACH,OAAO,EAAE,IAAI,EAAE,QAAQ,CAAC,IAAI,EAAE,KAAK,EAAE,QAAQ,CAAC,IAAI,CAAC,KAAK,EAAE,KAAK,EAAE,QAAQ,CAAC,KAAK,CAAC,KAAK,EAAE,MAAM,EAAE,CAAC;QAClG,CAAC;KACF,CAAC;AACJ,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,cAAc,CAAC,OAAwB;IAC3D,OAAO,CAAC,MAAM,WAAW,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC;AAC1C,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,WAAW,CAAC,OAAwB;IACxD,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,CAAC;IACvD,MAAM,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,MAAM,CAAC;IACtC,MAAM,aAAa,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,IAAI,EAAE,CAAC,CAAC;IACtE,MAAM,iBAAiB,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,WAAW,IAAI,EAAE,CAAC,CAAC;IAC9E,MAAM,GAAG,GAAG,MAAM,WAAW,CAAC,MAAM,CAAC,WAAW,CAAC,OAAO,EAAE,CAAC,GAAG,CAAC,OAAO,CAAC,OAAO,IAAI,EAAE,CAAC,EAAE,GAAG,aAAa,CAAC,EAAE,iBAAiB,CAAC,EAAE;QAC5H,UAAU,EAAE,KAAK;QACjB,MAAM,EAAE,OAAO,CAAC,MAAM,IAAI,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC;KACnD,CAAC,CAAC;IAEH,MAAM,MAAM,GAAG,GAAG,CAAC,cAAc,EAAE,CAAC,WAAW,EAAqB,CAAC;IACrE,MAAM,CAAC,GAAG,CAAC,aAAa,EAAE,IAAI,CAAC,CAAC;IAChC,MAAM,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC;IAC/B,2EAA2E;IAC3E,MAAM,CAAC,GAAG,CAAC,GAAG,MAAM,cAAc,EAAE,aAAa,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC;IACjE,mFAAmF;IACnF,KAAK,MAAM,IAAI,IAAI,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,YAAY,IAAI,EAAE,CAAC;QAAE,MAAM,CAAC,GAAG,CAAC,GAAG,MAAM,GAAG,IAAI,EAAE,EAAE,OAAO,CAAC,GAAG,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC;IACpJ,MAAM,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC;IAE3C,IAAI,OAAO,CAAC,IAAI,EAAE,MAAM;QAAE,GAAG,CAAC,UAAU,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,IAAI,EAAE,WAAW,EAAE,IAAI,EAAE,CAAC,CAAC;IACtF,GAAG,CAAC,eAAe,CAAC,MAAM,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,CAAC;IAC/C,GAAG,CAAC,gBAAgB,CAAC,IAAI,oBAAoB,EAAE,CAAC,CAAC;IAEjD,IAAI,OAAO,CAAC,OAAO,IAAI,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC;QAC5C,MAAM,GAAG,GAAG,OAAO,CAAC,OAAmC,CAAC;QACxD,MAAM,CAAC,GAAG,CAAC,GAAG,MAAM,eAAe,EAAE,CAAC,IAAI,EAAE,GAAG,EAAE,EAAE;YACjD,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAChB,CAAC,CAAC,CAAC;QACH,aAAa,CAAC,KAAK,CAAC,GAAG,MAAM,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,OAAO,EAAE,GAAG,EAAE,GAAG,EAAE;YACjE,eAAe,EAAE,KAAK;YACtB,eAAe,EAAE,GAAG,OAAO,CAAC,GAAG,CAAC,IAAI,MAAM;YAC1C,cAAc,EAAE,EAAE,eAAe,EAAE,IAAI,EAAE,oBAAoB,EAAE,IAAI,EAAE;SACtE,CAAC,CAAC;IACL,CAAC;IACD,OAAO,EAAE,GAAG,EAAE,OAAO,EAAE,OAAO,EAAE,CAAC;AACnC,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,aAAa,CAAC,OAA2D;IAC7F,MAAM,EAAE,GAAG,EAAE,OAAO,EAAE,GAAG,MAAM,WAAW,CAAC,OAAO,CAAC,CAAC;IACpD,GAAG,CAAC,mBAAmB,EAAE,CAAC;IAC1B,MAAM,IAAI,GAAG,KAAK,IAAI,EAAE;QACtB,KAAK,MAAM,CAAC,IAAI,OAAO;YAAE,MAAM,CAAC,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;IAC3D,CAAC,CAAC;IACF,OAAO,CAAC,IAAI,CAAC,SAAS,EAAE,GAAG,EAAE,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC;IAC3C,OAAO,CAAC,IAAI,CAAC,QAAQ,EAAE,GAAG,EAAE,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC;IAC1C,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,IAAI,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,QAAQ,IAAI,OAAO,CAAC,GAAG,CAAC,IAAI,IAAI,IAAI,CAAC,CAAC;IACtF,MAAM,GAAG,CAAC,MAAM,CAAC,IAAI,EAAE,OAAO,CAAC,IAAI,IAAI,SAAS,CAAC,CAAC;IAClD,OAAO,CAAC,GAAG,CAAC,WAAW,OAAO,CAAC,GAAG,CAAC,IAAI,sCAAsC,IAAI,GAAG,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,MAAM,EAAE,CAAC,CAAC;IAC9G,IAAI,OAAO,CAAC,OAAO,IAAI,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI;QAAE,OAAO,CAAC,GAAG,CAAC,sCAAsC,IAAI,GAAG,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,MAAM,OAAO,CAAC,CAAC;IACrI,KAAK,MAAM,CAAC,IAAI,OAAO;QAAE,MAAM,CAAC,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;IAC1D,OAAO,GAAG,CAAC;AACb,CAAC;AAED;;;GAGG;AACH,MAAM,CAAC,KAAK,UAAU,gBAAgB,CAAC,OAAiE;IACtG,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,CAAC;IACvD,MAAM,QAAQ,GAAyD,EAAE,CAAC;IAC1E,KAAK,MAAM,OAAO,IAAI,OAAO,CAAC,aAAa,EAAE,CAAC;QAC5C,MAAM,GAAG,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;QACjE,MAAM,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;QACxE,IAAI,CAAC,MAAM;YAAE,MAAM,IAAI,KAAK,CAAC,0BAA0B,OAAO,CAAC,IAAI,oCAAoC,CAAC,CAAC;QACzG,MAAM,GAAG,GAAkB,GAAG,EAAE,GAAG,IAAI;YACrC,GAAG,EAAE,OAAO,CAAC,GAAG;YAChB,MAAM;YACN,MAAM,EAAE,OAAO,CAAC,MAAM;YACtB,OAAO;YACP,MAAM,EAAE,OAAO,CAAC,MAAM;YACtB,GAAG,EAAE,OAAO,CAAC,GAAG;YAChB,gBAAgB,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,OAAO,CAAC,YAAY,CAAC,KAAK,CAAC;YACxD,OAAO,EAAE,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC,KAAK,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,EAAE,KAAK,CAAC;YAC9D,GAAG,EAAE,CAAK,IAAY,EAAE,EAAE,CAAC,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAkB;SACrE,CAAC;QACF,MAAM,OAAO,CAAC,KAAK,EAAE,CAAC,GAAG,CAAC,CAAC;QAC3B,QAAQ,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,GAAG,EAAE,CAAC,CAAC;IAClC,CAAC;IACD,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,MAAM,CAAC;QAAE,OAAO,CAAC,IAAI,CAAC,8EAA8E,CAAC,CAAC;IACxJ,KAAK,MAAM,CAAC,IAAI,QAAQ;QAAE,MAAM,CAAC,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;IAC3D,OAAO,CAAC,GAAG,CAAC,WAAW,OAAO,CAAC,GAAG,CAAC,IAAI,iBAAiB,CAAC,CAAC;IAC1D,MAAM,IAAI,GAAG,KAAK,IAAI,EAAE;QACtB,KAAK,MAAM,CAAC,IAAI,QAAQ;YAAE,MAAM,CAAC,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;QAC1D,KAAK,MAAM,CAAC,IAAI,OAAO;YAAE,MAAM,CAAC,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;IAC3D,CAAC,CAAC;IACF,OAAO,CAAC,IAAI,CAAC,SAAS,EAAE,GAAG,EAAE,CAAC,KAAK,IAAI,EAAE,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IACvE,OAAO,CAAC,IAAI,CAAC,QAAQ,EAAE,GAAG,EAAE,CAAC,KAAK,IAAI,EAAE,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IACtE,OAAO,EAAE,IAAI,EAAE,CAAC;AAClB,CAAC"}

package/dist/comments.d.ts

@@ -0,0 +1,139 @@
+import type { EntityIR } from "@tekki-forge/compiler";
+import type { ForgeRequestContext } from "./extension.js";
+import type { ForgeService } from "./service.js";
+type Row = Record<string, any>;
+export declare const COMMENT_MAX_LENGTH = 5000;
+/** User ids mentioned in a comment body, in order of appearance, without duplicates. */
+export declare function parseMentions(body: string): string[];
+/** The body as plain text: mention tokens become `@Name`. */
+export declare function commentText(body: string): string;
+export interface TimelineChange {
+    field: string;
+    label: string;
+    /** false for values that are not shown (files). */
+    values: boolean;
+    from?: unknown;
+    to?: unknown;
+}
+export interface TimelineEvent {
+    id: string;
+    kind: "created" | "updated" | "deleted" | "restored" | "transition" | "action" | "comment";
+    at: string;
+    actor: {
+        id: string;
+        name: string;
+        image: string | null;
+    } | null;
+    changes?: TimelineChange[];
+    transition?: {
+        name: string;
+        label: string;
+        from: string | null;
+        to: string | null;
+    };
+    action?: {
+        name: string;
+        label: string;
+    };
+    comment?: Row;
+}
+/**
+ * Comments on records (entities with `features: { comments: true }`), @mentions and the record timeline
+ * (audit history + comments). Everything is scoped to the records the caller can read, within their organization.
+ */
+export declare class CommentService {
+    private readonly service;
+    private readonly logger;
+    constructor(service: ForgeService);
+    private get prisma();
+    private principal;
+    /** Writing comments and mentioning people needs a person: API keys may only read comments and the timeline. */
+    private person;
+    private orgWhere;
+    private requireComments;
+    /** The record, when the caller can read it (404 otherwise). */
+    private record;
+    private canRead;
+    /**
+     * Users who may be mentioned: members of the caller's organization (all users without multi-tenancy), not banned,
+     * who can read the record. `ids` narrows to those users; `search` matches name or email.
+     */
+    private readers;
+    /** Mentioned ids that are valid: same organization, can read the record. Others are dropped silently. */
+    private validMentions;
+    private body;
+    out(row: Row, ctx: ForgeRequestContext): {
+        id: any;
+        body: any;
+        mentions: any;
+        author: {
+            id: any;
+            name: any;
+            image: any;
+        } | null;
+        createdAt: any;
+        editedAt: any;
+        canEdit: boolean;
+        canDelete: boolean;
+    };
+    private find;
+    private notifyMentions;
+    list(entity: EntityIR, id: string, query: Row, ctx: ForgeRequestContext): Promise<{
+        data: any;
+        meta: {
+            page: number;
+            pageSize: number;
+            total: any;
+            pages: number;
+        };
+    }>;
+    create(entity: EntityIR, id: string, input: unknown, ctx: ForgeRequestContext): Promise<{
+        id: any;
+        body: any;
+        mentions: any;
+        author: {
+            id: any;
+            name: any;
+            image: any;
+        } | null;
+        createdAt: any;
+        editedAt: any;
+        canEdit: boolean;
+        canDelete: boolean;
+    }>;
+    update(entity: EntityIR, id: string, commentId: string, input: unknown, ctx: ForgeRequestContext): Promise<{
+        id: any;
+        body: any;
+        mentions: any;
+        author: {
+            id: any;
+            name: any;
+            image: any;
+        } | null;
+        createdAt: any;
+        editedAt: any;
+        canEdit: boolean;
+        canDelete: boolean;
+    }>;
+    remove(entity: EntityIR, id: string, commentId: string, ctx: ForgeRequestContext): Promise<void>;
+    /** People the caller can @mention on this record. */
+    mentionable(entity: EntityIR, id: string, query: Row, ctx: ForgeRequestContext): Promise<{
+        data: {
+            id: any;
+            name: any;
+            image: any;
+        }[];
+    }>;
+    /**
+     * Audit history and comments of one record, newest first, `limit` per page; pass `before` (the previous
+     * page's `nextCursor`) for older events. Changes to fields the caller cannot read are left out.
+     */
+    timeline(entity: EntityIR, id: string, query: Row, ctx: ForgeRequestContext): Promise<{
+        data: TimelineEvent[];
+        nextCursor: string | null;
+    }>;
+    private commentEvent;
+    private auditEvent;
+    private changes;
+}
+export {};