@forestadmin/agent 1.99.2 → 1.100.1

package/dist/embedded-bff.js

@@ -0,0 +1,220 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+const bff_routes_1 = require("./bff-routes");
+/**
+ * Serialize the BFF's structured log context onto the message: the agent's logger only accepts an
+ * Error as its third argument, so the context would be dropped otherwise. Errors are unfolded by
+ * hand — their `message` and `stack` are not enumerable, so `JSON.stringify` alone turns the one
+ * value worth logging into `{}`. Never throws — logging must not break a request.
+ */
+function formatLog(message, context) {
+    if (!context || Object.keys(context).length === 0)
+        return `[BFF] ${message}`;
+    try {
+        const serialized = JSON.stringify(context, (_key, value) => value instanceof Error
+            ? { name: value.name, message: value.message, stack: value.stack }
+            : value);
+        return `[BFF] ${message} ${serialized}`;
+    }
+    catch {
+        return `[BFF] ${message} [unserializable context]`;
+    }
+}
+/**
+ * Owns the lifecycle of a BFF embedded in the agent process: configuration, dynamic loading of the
+ * optional package, build, and the request handler the agent mounts at `/bff`. The agent only wires
+ * the callback and delegates start/stop.
+ */
+class EmbeddedBff {
+    constructor(options, embedOptions) {
+        this.options = options;
+        this.embedOptions = embedOptions;
+        this.config = null;
+        this.bff = null;
+        this.stopped = false;
+        /**
+         * The callback the agent registers at `/bff`. Answers 503 rather than falling through while the
+         * BFF is not serving: a 404 from the host would read as "wrong url" instead of "not available".
+         * Boot and shutdown are told apart, because a probe should wait on the first and drain on the
+         * second.
+         */
+        this.handle = (req, res) => {
+            if (!this.bff) {
+                const type = this.stopped ? 'bff_stopped' : 'bff_not_started';
+                const message = this.stopped
+                    ? 'The embedded BFF was stopped with the agent.'
+                    : 'The embedded BFF is not started yet.';
+                res.statusCode = 503;
+                res.setHeader('Content-Type', 'application/json');
+                res.end(JSON.stringify({ error: { type, status: 503, message } }));
+                return;
+            }
+            // The BFF knows nothing of the prefix it is served under. `originalUrl` is claimed before the
+            // rewrite so a host logger reading it still reports the url the client asked for.
+            const bffReq = req;
+            bffReq.originalUrl ?? (bffReq.originalUrl = bffReq.url);
+            req.url = (0, bff_routes_1.stripBffPrefix)(req.url ?? bff_routes_1.BFF_PREFIX);
+            this.bff.callback(req, res);
+        };
+    }
+    /**
+     * Load the package and validate the options the caller handed to `addBff()`. Called before the
+     * agent mounts anything: everything checked here is caller input, and `parseConfig` throws on a
+     * mistyped `tokenEncryptionKey`, timezone, timeout or url. Failing here leaves nothing serving,
+     * where failing after mount() would leave the host with a live `/forest` and a bricked `/bff`.
+     */
+    async prepare() {
+        const { parseConfig, IN_PROCESS_AGENT_URL } = await this.importPackage();
+        const { embedOptions } = this;
+        this.config = parseConfig({
+            FOREST_AUTH_SECRET: this.options.authSecret,
+            FOREST_ENV_SECRET: this.options.envSecret,
+            FOREST_SERVER_URL: this.options.forestServerUrl,
+            FOREST_APP_URL: this.options.forestAppUrl,
+            // Names where the agent answers, never how it is reached: the dispatcher is the transport.
+            AGENT_URL: IN_PROCESS_AGENT_URL,
+            BFF_TOKEN_ENCRYPTION_KEY: embedOptions.tokenEncryptionKey,
+            BFF_ALLOWED_ORIGINS: embedOptions.allowedOrigins?.join(','),
+            BFF_DEFAULT_TIMEZONE: embedOptions.defaultTimezone,
+            BFF_AGENT_TIMEOUT_MS: embedOptions.agentTimeoutMs?.toString(),
+            BFF_AI_TIMEOUT_MS: embedOptions.aiTimeoutMs?.toString(),
+            // Off unless asked for: the document is not filtered per caller, so mounting a BFF must not
+            // publish the name of every exposed collection and field on an already-open port.
+            BFF_OPENAPI_ENABLED: String(embedOptions.openapiEnabled ?? false),
+        });
+    }
+    /**
+     * Build the BFF. Called from agent.start() after mount(), because the dispatcher only reaches the
+     * agent's own stack once that stack is mounted.
+     */
+    async start(dispatcher) {
+        if (!this.config)
+            await this.prepare();
+        // Cleared before the await, not after it: a start() following a stop() has to drop the previous
+        // shutdown's flag, while a stop() landing DURING the await must still be seen by the guard below.
+        this.stopped = false;
+        const { buildBff } = await this.importPackage();
+        const bff = await buildBff({
+            config: this.config,
+            dispatcher,
+            basePath: bff_routes_1.BFF_PREFIX,
+            // Counters are the schema cache's and the action-endpoint resolver's only channel — they take
+            // no logger — and every one of them reports a failure, so they go to the host's logs. Gauges
+            // do not: they are periodic cache sizes, and the default console sink reports them at Info,
+            // which would flood a host that only asked for a BFF.
+            metrics: {
+                // Tags carried through: `action_endpoint_error` and `action_endpoint_miss` name the
+                // rendering, collection and action that failed, which is the whole of what makes the line
+                // actionable — the metric name alone says only that something, somewhere, did not resolve.
+                increment: (name, tags) => this.options.logger('Warn', formatLog(`metric ${name}`, tags)),
+                gauge: () => undefined,
+            },
+            logger: (level, message, context) => this.options.logger(level, formatLog(message, context)),
+        });
+        // stop() may have landed while buildBff() was in flight. Assigning anyway would resurrect a
+        // stopped agent's /bff — dispatching into the stack it just tore down instead of answering 503.
+        if (this.stopped)
+            return;
+        this.bff = bff;
+        this.options.logger('Info', formatLog(`Embedded BFF mounted on ${bff_routes_1.BFF_PREFIX}`));
+        await this.warnIfExemptFromIpWhitelist();
+    }
+    /**
+     * The whitelist exempts a caller arriving over a loopback socket with no proxy hop, which is
+     * exactly what the in-process transport looks like — so every BFF request escapes it. That is the
+     * decision, not an oversight: propagating the caller's ip would make the embedded mode stricter
+     * than the standalone one, where the whitelist only ever sees the BFF's own host, and would refuse
+     * the browsers a third-party UI is made of. What it must not be is silent — an operator who turned
+     * the whitelist on to close a door has no other way to learn this door is not part of it.
+     *
+     * Reads the configuration itself rather than borrowing the one `IpWhitelist` already fetched: that
+     * route keeps it private, and reaching into it would put BFF concerns in an unrelated part of the
+     * agent. Costs one round-trip at boot. Never fails the boot: a warning is not worth refusing to
+     * serve over, and this is the same posture as the rest of the BFF's startup.
+     */
+    async warnIfExemptFromIpWhitelist() {
+        try {
+            const { isFeatureEnabled } = await this.options.forestAdminClient.getIpWhitelistConfiguration();
+            if (!isFeatureEnabled)
+                return;
+            this.options.logger('Warn', formatLog(`The IP whitelist is enabled for this environment, but requests served under ` +
+                `${bff_routes_1.BFF_PREFIX} are not subject to it: they reach the agent in-process, which the ` +
+                `whitelist exempts as a trusted loopback caller. A resolved API key or a valid OAuth ` +
+                `session is still required.`));
+        }
+        catch (error) {
+            this.options.logger('Debug', formatLog('Could not read the IP whitelist configuration', {
+                cause: error instanceof Error ? error.message : String(error),
+            }));
+        }
+    }
+    /** Drop what the BFF read from the SaaS. Called on a restart, which means the schema moved. */
+    invalidate() {
+        this.bff?.invalidate();
+    }
+    /**
+     * Stop answering. The host application keeps whatever middleware it registered, so without this
+     * a stopped agent would go on serving BFF data through a dispatcher pointing at a dead stack.
+     */
+    stop() {
+        this.bff = null;
+        this.stopped = true;
+    }
+    /**
+     * Dynamically load the optional @forestadmin/agent-bff package. Deferred so agents that embed no
+     * BFF never load its code at startup.
+     */
+    async importPackage() {
+        try {
+            return await Promise.resolve().then(() => __importStar(require('@forestadmin/agent-bff')));
+        }
+        catch (error) {
+            // The original reason is kept: the package resolves from the host's own node_modules, so this
+            // also fires on a broken transitive dependency, a SyntaxError from a partial install, or a
+            // throw during the package's own evaluation — none of which "install it" would fix.
+            const { message } = error;
+            const wrapped = new Error(`The embedded BFF requires the \`@forestadmin/agent-bff\` package, which failed to ` +
+                `load: ${message}. Install it with \`npm install @forestadmin/agent-bff\`.`);
+            // Assigned rather than passed to the constructor: the repo targets ES2020, whose lib types no
+            // options bag on Error. A plain assignment carries the cause on every runtime, and the reason
+            // is in the message regardless of what reads it.
+            wrapped.cause = error;
+            throw wrapped;
+        }
+    }
+}
+exports.default = EmbeddedBff;
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiZW1iZWRkZWQtYmZmLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vc3JjL2VtYmVkZGVkLWJmZi50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7OztBQUdBLDZDQUEwRDtBQUUxRDs7Ozs7R0FLRztBQUNILFNBQVMsU0FBUyxDQUFDLE9BQWUsRUFBRSxPQUFpQztJQUNuRSxJQUFJLENBQUMsT0FBTyxJQUFJLE1BQU0sQ0FBQyxJQUFJLENBQUMsT0FBTyxDQUFDLENBQUMsTUFBTSxLQUFLLENBQUM7UUFBRSxPQUFPLFNBQVMsT0FBTyxFQUFFLENBQUM7SUFFN0UsSUFBSSxDQUFDO1FBQ0gsTUFBTSxVQUFVLEdBQUcsSUFBSSxDQUFDLFNBQVMsQ0FBQyxPQUFPLEVBQUUsQ0FBQyxJQUFJLEVBQUUsS0FBSyxFQUFFLEVBQUUsQ0FDekQsS0FBSyxZQUFZLEtBQUs7WUFDcEIsQ0FBQyxDQUFDLEVBQUUsSUFBSSxFQUFFLEtBQUssQ0FBQyxJQUFJLEVBQUUsT0FBTyxFQUFFLEtBQUssQ0FBQyxPQUFPLEVBQUUsS0FBSyxFQUFFLEtBQUssQ0FBQyxLQUFLLEVBQUU7WUFDbEUsQ0FBQyxDQUFDLEtBQUssQ0FDVixDQUFDO1FBRUYsT0FBTyxTQUFTLE9BQU8sSUFBSSxVQUFVLEVBQUUsQ0FBQztJQUMxQyxDQUFDO0lBQUMsTUFBTSxDQUFDO1FBQ1AsT0FBTyxTQUFTLE9BQU8sMkJBQTJCLENBQUM7SUFDckQsQ0FBQztBQUNILENBQUM7QUFFRDs7OztHQUlHO0FBQ0gsTUFBcUIsV0FBVztJQUs5QixZQUNtQixPQUFpQyxFQUNqQyxZQUE2QjtRQUQ3QixZQUFPLEdBQVAsT0FBTyxDQUEwQjtRQUNqQyxpQkFBWSxHQUFaLFlBQVksQ0FBaUI7UUFOeEMsV0FBTSxHQUFxQixJQUFJLENBQUM7UUFDaEMsUUFBRyxHQUFlLElBQUksQ0FBQztRQUN2QixZQUFPLEdBQUcsS0FBSyxDQUFDO1FBa0l4Qjs7Ozs7V0FLRztRQUNNLFdBQU0sR0FBaUIsQ0FBQyxHQUFHLEVBQUUsR0FBRyxFQUFFLEVBQUU7WUFDM0MsSUFBSSxDQUFDLElBQUksQ0FBQyxHQUFHLEVBQUUsQ0FBQztnQkFDZCxNQUFNLElBQUksR0FBRyxJQUFJLENBQUMsT0FBTyxDQUFDLENBQUMsQ0FBQyxhQUFhLENBQUMsQ0FBQyxDQUFDLGlCQUFpQixDQUFDO2dCQUM5RCxNQUFNLE9BQU8sR0FBRyxJQUFJLENBQUMsT0FBTztvQkFDMUIsQ0FBQyxDQUFDLDhDQUE4QztvQkFDaEQsQ0FBQyxDQUFDLHNDQUFzQyxDQUFDO2dCQUUzQyxHQUFHLENBQUMsVUFBVSxHQUFHLEdBQUcsQ0FBQztnQkFDckIsR0FBRyxDQUFDLFNBQVMsQ0FBQyxjQUFjLEVBQUUsa0JBQWtCLENBQUMsQ0FBQztnQkFDbEQsR0FBRyxDQUFDLEdBQUcsQ0FBQyxJQUFJLENBQUMsU0FBUyxDQUFDLEVBQUUsS0FBSyxFQUFFLEVBQUUsSUFBSSxFQUFFLE1BQU0sRUFBRSxHQUFHLEVBQUUsT0FBTyxFQUFFLEVBQUUsQ0FBQyxDQUFDLENBQUM7Z0JBRW5FLE9BQU87WUFDVCxDQUFDO1lBRUQsOEZBQThGO1lBQzlGLGtGQUFrRjtZQUNsRixNQUFNLE1BQU0sR0FBRyxHQUE0QyxDQUFDO1lBQzVELE1BQU0sQ0FBQyxXQUFXLEtBQWxCLE1BQU0sQ0FBQyxXQUFXLEdBQUssTUFBTSxDQUFDLEdBQUcsRUFBQztZQUNsQyxHQUFHLENBQUMsR0FBRyxHQUFHLElBQUEsMkJBQWMsRUFBQyxHQUFHLENBQUMsR0FBRyxJQUFJLHVCQUFVLENBQUMsQ0FBQztZQUNoRCxJQUFJLENBQUMsR0FBRyxDQUFDLFFBQVEsQ0FBQyxHQUFHLEVBQUUsR0FBRyxDQUFDLENBQUM7UUFDOUIsQ0FBQyxDQUFDO0lBdkpDLENBQUM7SUFFSjs7Ozs7T0FLRztJQUNILEtBQUssQ0FBQyxPQUFPO1FBQ1gsTUFBTSxFQUFFLFdBQVcsRUFBRSxvQkFBb0IsRUFBRSxHQUFHLE1BQU0sSUFBSSxDQUFDLGFBQWEsRUFBRSxDQUFDO1FBQ3pFLE1BQU0sRUFBRSxZQUFZLEVBQUUsR0FBRyxJQUFJLENBQUM7UUFFOUIsSUFBSSxDQUFDLE1BQU0sR0FBRyxXQUFXLENBQUM7WUFDeEIsa0JBQWtCLEVBQUUsSUFBSSxDQUFDLE9BQU8sQ0FBQyxVQUFVO1lBQzNDLGlCQUFpQixFQUFFLElBQUksQ0FBQyxPQUFPLENBQUMsU0FBUztZQUN6QyxpQkFBaUIsRUFBRSxJQUFJLENBQUMsT0FBTyxDQUFDLGVBQWU7WUFDL0MsY0FBYyxFQUFFLElBQUksQ0FBQyxPQUFPLENBQUMsWUFBWTtZQUN6QywyRkFBMkY7WUFDM0YsU0FBUyxFQUFFLG9CQUFvQjtZQUMvQix3QkFBd0IsRUFBRSxZQUFZLENBQUMsa0JBQWtCO1lBQ3pELG1CQUFtQixFQUFFLFlBQVksQ0FBQyxjQUFjLEVBQUUsSUFBSSxDQUFDLEdBQUcsQ0FBQztZQUMzRCxvQkFBb0IsRUFBRSxZQUFZLENBQUMsZUFBZTtZQUNsRCxvQkFBb0IsRUFBRSxZQUFZLENBQUMsY0FBYyxFQUFFLFFBQVEsRUFBRTtZQUM3RCxpQkFBaUIsRUFBRSxZQUFZLENBQUMsV0FBVyxFQUFFLFFBQVEsRUFBRTtZQUN2RCw0RkFBNEY7WUFDNUYsa0ZBQWtGO1lBQ2xGLG1CQUFtQixFQUFFLE1BQU0sQ0FBQyxZQUFZLENBQUMsY0FBYyxJQUFJLEtBQUssQ0FBQztTQUNsRSxDQUFDLENBQUM7SUFDTCxDQUFDO0lBRUQ7OztPQUdHO0lBQ0gsS0FBSyxDQUFDLEtBQUssQ0FBQyxVQUEyQjtRQUNyQyxJQUFJLENBQUMsSUFBSSxDQUFDLE1BQU07WUFBRSxNQUFNLElBQUksQ0FBQyxPQUFPLEVBQUUsQ0FBQztRQUV2QyxnR0FBZ0c7UUFDaEcsa0dBQWtHO1FBQ2xHLElBQUksQ0FBQyxPQUFPLEdBQUcsS0FBSyxDQUFDO1FBRXJCLE1BQU0sRUFBRSxRQUFRLEVBQUUsR0FBRyxNQUFNLElBQUksQ0FBQyxhQUFhLEVBQUUsQ0FBQztRQUVoRCxNQUFNLEdBQUcsR0FBRyxNQUFNLFFBQVEsQ0FBQztZQUN6QixNQUFNLEVBQUUsSUFBSSxDQUFDLE1BQW1CO1lBQ2hDLFVBQVU7WUFDVixRQUFRLEVBQUUsdUJBQVU7WUFDcEIsOEZBQThGO1lBQzlGLDZGQUE2RjtZQUM3Riw0RkFBNEY7WUFDNUYsc0RBQXNEO1lBQ3RELE9BQU8sRUFBRTtnQkFDUCxvRkFBb0Y7Z0JBQ3BGLDBGQUEwRjtnQkFDMUYsMkZBQTJGO2dCQUMzRixTQUFTLEVBQUUsQ0FBQyxJQUFJLEVBQUUsSUFBSSxFQUFFLEVBQUUsQ0FBQyxJQUFJLENBQUMsT0FBTyxDQUFDLE1BQU0sQ0FBQyxNQUFNLEVBQUUsU0FBUyxDQUFDLFVBQVUsSUFBSSxFQUFFLEVBQUUsSUFBSSxDQUFDLENBQUM7Z0JBQ3pGLEtBQUssRUFBRSxHQUFHLEVBQUUsQ0FBQyxTQUFTO2FBQ3ZCO1lBQ0QsTUFBTSxFQUFFLENBQUMsS0FBSyxFQUFFLE9BQU8sRUFBRSxPQUFPLEVBQUUsRUFBRSxDQUFDLElBQUksQ0FBQyxPQUFPLENBQUMsTUFBTSxDQUFDLEtBQUssRUFBRSxTQUFTLENBQUMsT0FBTyxFQUFFLE9BQU8sQ0FBQyxDQUFDO1NBQzdGLENBQUMsQ0FBQztRQUVILDRGQUE0RjtRQUM1RixnR0FBZ0c7UUFDaEcsSUFBSSxJQUFJLENBQUMsT0FBTztZQUFFLE9BQU87UUFFekIsSUFBSSxDQUFDLEdBQUcsR0FBRyxHQUFHLENBQUM7UUFFZixJQUFJLENBQUMsT0FBTyxDQUFDLE1BQU0sQ0FBQyxNQUFNLEVBQUUsU0FBUyxDQUFDLDJCQUEyQix1QkFBVSxFQUFFLENBQUMsQ0FBQyxDQUFDO1FBRWhGLE1BQU0sSUFBSSxDQUFDLDJCQUEyQixFQUFFLENBQUM7SUFDM0MsQ0FBQztJQUVEOzs7Ozs7Ozs7Ozs7T0FZRztJQUNLLEtBQUssQ0FBQywyQkFBMkI7UUFDdkMsSUFBSSxDQUFDO1lBQ0gsTUFBTSxFQUFFLGdCQUFnQixFQUFFLEdBQ3hCLE1BQU0sSUFBSSxDQUFDLE9BQU8sQ0FBQyxpQkFBaUIsQ0FBQywyQkFBMkIsRUFBRSxDQUFDO1lBRXJFLElBQUksQ0FBQyxnQkFBZ0I7Z0JBQUUsT0FBTztZQUU5QixJQUFJLENBQUMsT0FBTyxDQUFDLE1BQU0sQ0FDakIsTUFBTSxFQUNOLFNBQVMsQ0FDUCw4RUFBOEU7Z0JBQzVFLEdBQUcsdUJBQVUscUVBQXFFO2dCQUNsRixzRkFBc0Y7Z0JBQ3RGLDRCQUE0QixDQUMvQixDQUNGLENBQUM7UUFDSixDQUFDO1FBQUMsT0FBTyxLQUFLLEVBQUUsQ0FBQztZQUNmLElBQUksQ0FBQyxPQUFPLENBQUMsTUFBTSxDQUNqQixPQUFPLEVBQ1AsU0FBUyxDQUFDLCtDQUErQyxFQUFFO2dCQUN6RCxLQUFLLEVBQUUsS0FBSyxZQUFZLEtBQUssQ0FBQyxDQUFDLENBQUMsS0FBSyxDQUFDLE9BQU8sQ0FBQyxDQUFDLENBQUMsTUFBTSxDQUFDLEtBQUssQ0FBQzthQUM5RCxDQUFDLENBQ0gsQ0FBQztRQUNKLENBQUM7SUFDSCxDQUFDO0lBRUQsK0ZBQStGO0lBQy9GLFVBQVU7UUFDUixJQUFJLENBQUMsR0FBRyxFQUFFLFVBQVUsRUFBRSxDQUFDO0lBQ3pCLENBQUM7SUFFRDs7O09BR0c7SUFDSCxJQUFJO1FBQ0YsSUFBSSxDQUFDLEdBQUcsR0FBRyxJQUFJLENBQUM7UUFDaEIsSUFBSSxDQUFDLE9BQU8sR0FBRyxJQUFJLENBQUM7SUFDdEIsQ0FBQztJQThCRDs7O09BR0c7SUFDSyxLQUFLLENBQUMsYUFBYTtRQUN6QixJQUFJLENBQUM7WUFDSCxPQUFPLHdEQUFhLHdCQUF3QixHQUFDLENBQUM7UUFDaEQsQ0FBQztRQUFDLE9BQU8sS0FBSyxFQUFFLENBQUM7WUFDZiw4RkFBOEY7WUFDOUYsMkZBQTJGO1lBQzNGLG9GQUFvRjtZQUNwRixNQUFNLEVBQUUsT0FBTyxFQUFFLEdBQUcsS0FBYyxDQUFDO1lBQ25DLE1BQU0sT0FBTyxHQUFHLElBQUksS0FBSyxDQUN2QixvRkFBb0Y7Z0JBQ2xGLFNBQVMsT0FBTywyREFBMkQsQ0FDOUUsQ0FBQztZQUNGLDhGQUE4RjtZQUM5Riw4RkFBOEY7WUFDOUYsaURBQWlEO1lBQ2hELE9BQXVDLENBQUMsS0FBSyxHQUFHLEtBQUssQ0FBQztZQUV2RCxNQUFNLE9BQU8sQ0FBQztRQUNoQixDQUFDO0lBQ0gsQ0FBQztDQUNGO0FBekxELDhCQXlMQyJ9

package/dist/framework-mounter.d.ts

@@ -1,4 +1,4 @@
-import type { HttpCallback, McpRouteMatcher } from './types';
+import type { HttpCallback, RootHandler } from './types';
 import type { Logger } from '@forestadmin/datasource-toolkit';
 import Router from '@koa/router';
 import InProcessDispatcher from './mcp-in-process-dispatcher';
@@ -11,16 +11,20 @@ export default class FrameworkMounter {
     protected readonly prefix: string;
     private readonly logger;
     private readonly fastifyAdapter;
-    private readonly mcpMiddleware;
+    private readonly rootMiddleware;
     private readonly inProcessDispatcher;
     private inProcessHookRegistered;
     /** Compute the prefix that the main router should be mounted at in the client's application */
     private get completeMountPrefix();
     constructor(prefix: string, logger: Logger);
     /**
-     * Set the MCP HTTP callback. Call this before mount() or remount().
+     * Register the MCP server at the root of the host application, or `null` to unregister it. The
+     * matcher comes with the callback: there is no default pattern set, so nothing can claim host
+     * urls by accident. Call this before mount() or remount().
      */
-    protected setMcpCallback(callback: HttpCallback | null, routeMatcher?: McpRouteMatcher): void;
+    protected setMcpCallback(handler: RootHandler | null): void;
+    /** Serve an embedded BFF at `/bff`. Pass null to stop answering there. */
+    protected setBffCallback(callback: HttpCallback | null): void;
     /**
      * Dispatcher that runs agent-client requests against the agent's own `/forest` stack in-memory.
      * The handler is rebuilt on every (re)mount so a captured reference never goes stale.

package/dist/framework-mounter.js

@@ -7,9 +7,10 @@ const router_1 = __importDefault(require("@koa/router"));
 const http_1 = require("http");
 const koa_1 = __importDefault(require("koa"));
 const path_1 = __importDefault(require("path"));
+const bff_routes_1 = require("./bff-routes");
 const fastify_adapter_1 = __importDefault(require("./fastify-adapter"));
 const mcp_in_process_dispatcher_1 = __importDefault(require("./mcp-in-process-dispatcher"));
-const mcp_middleware_1 = __importDefault(require("./mcp-middleware"));
+const root_middleware_1 = __importDefault(require("./root-middleware"));
 class FrameworkMounter {
     /** Compute the prefix that the main router should be mounted at in the client's application */
     get completeMountPrefix() {
@@ -23,14 +24,20 @@ class FrameworkMounter {
         this.prefix = prefix;
         this.logger = logger;
         this.fastifyAdapter = new fastify_adapter_1.default(logger);
-        this.mcpMiddleware = new mcp_middleware_1.default();
+        this.rootMiddleware = new root_middleware_1.default(logger);
         this.inProcessDispatcher = new mcp_in_process_dispatcher_1.default(logger);
     }
     /**
-     * Set the MCP HTTP callback. Call this before mount() or remount().
+     * Register the MCP server at the root of the host application, or `null` to unregister it. The
+     * matcher comes with the callback: there is no default pattern set, so nothing can claim host
+     * urls by accident. Call this before mount() or remount().
      */
-    setMcpCallback(callback, routeMatcher) {
-        this.mcpMiddleware.setCallback(callback, routeMatcher);
+    setMcpCallback(handler) {
+        this.rootMiddleware.set('mcp', handler);
+    }
+    /** Serve an embedded BFF at `/bff`. Pass null to stop answering there. */
+    setBffCallback(callback) {
+        this.rootMiddleware.set('bff', callback && { callback, matches: bff_routes_1.isBffRoute });
     }
     /**
      * Dispatcher that runs agent-client requests against the agent's own `/forest` stack in-memory.
@@ -101,7 +108,7 @@ class FrameworkMounter {
      */
     mountOnExpress(express) {
         // MCP middleware - the callback handles its own path filtering and calls next() for non-MCP routes
-        express.use(this.mcpMiddleware.getExpressMiddleware());
+        express.use(this.rootMiddleware.getExpressMiddleware());
         // Mount main forest routes at /{prefix}/forest
         express.use(this.completeMountPrefix, this.getConnectCallback(false));
         this.logger('Info', `Successfully mounted on Express.js`);
@@ -113,7 +120,7 @@ class FrameworkMounter {
      */
     mountOnFastify(fastify) {
         // MCP middleware at root - the callback handles its own path filtering
-        this.fastifyAdapter.useCallback(fastify, this.mcpMiddleware.getExpressMiddleware(), '/');
+        this.fastifyAdapter.useCallback(fastify, this.rootMiddleware.getExpressMiddleware(), '/');
         // Mount main forest routes
         const callback = this.getConnectCallback(false);
         this.fastifyAdapter.useCallback(fastify, callback, this.completeMountPrefix);
@@ -138,7 +145,7 @@ class FrameworkMounter {
             parentRouter.use(driverRouter.routes());
         });
         // MCP middleware - intercepts MCP routes before they reach Koa's body parser
-        koa.use(this.mcpMiddleware.getKoaMiddleware());
+        koa.use(this.rootMiddleware.getKoaMiddleware());
         koa.use(parentRouter.routes());
         this.logger('Info', `Successfully mounted on Koa`);
         return this;
@@ -152,13 +159,13 @@ class FrameworkMounter {
         const callback = this.getConnectCallback(false);
         if (adapter.constructor.name === 'ExpressAdapter') {
             // MCP middleware at root - the callback handles its own path filtering
-            nestJs.use(this.mcpMiddleware.getExpressMiddleware());
+            nestJs.use(this.rootMiddleware.getExpressMiddleware());
             // Mount main forest routes
             nestJs.use(this.completeMountPrefix, callback);
         }
         else {
             // Fastify adapter - MCP middleware at root
-            this.fastifyAdapter.useCallback(nestJs, this.mcpMiddleware.getExpressMiddleware(), '/');
+            this.fastifyAdapter.useCallback(nestJs, this.rootMiddleware.getExpressMiddleware(), '/');
             this.fastifyAdapter.useCallback(nestJs, callback, this.completeMountPrefix);
         }
         this.logger('Info', `Successfully mounted on NestJS`);
@@ -176,9 +183,9 @@ class FrameworkMounter {
         return (req, res) => {
             // For standalone server (nested), check MCP callback first
             // The MCP callback handles its own path filtering
-            const mcpCallback = this.mcpMiddleware.getCallback();
-            if (nested && mcpCallback) {
-                mcpCallback(req, res, () => {
+            const rootCallback = this.rootMiddleware.getCallback();
+            if (nested && rootCallback) {
+                rootCallback(req, res, () => {
                     // next() called means not an MCP route - forward to main handler
                     if (handler) {
                         handler(req, res);
@@ -201,4 +208,4 @@ class FrameworkMounter {
     }
 }
 exports.default = FrameworkMounter;
-//# sourceMappingURL=data:application/json;base64,{"version":3,"file":"framework-mounter.js","sourceRoot":"","sources":["../src/framework-mounter.ts"],"names":[],"mappings":";;;;;AAKA,yDAAiC;AACjC,+BAAoC;AACpC,8CAAsB;AACtB,gDAAwB;AAExB,wEAA+C;AAC/C,4FAA8D;AAC9D,sEAA6C;AAE7C,MAAqB,gBAAgB;IAgBnC,+FAA+F;IAC/F,IAAY,mBAAmB;QAC7B,OAAO,cAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;IACrD,CAAC;IAED,YAAY,MAAc,EAAE,MAAc;QAjBzB,iBAAY,GAA4B,EAAE,CAAC;QAC3C,gBAAW,GAA0C,EAAE,CAAC;QAExD,WAAM,GAA4B,EAAE,CAAC;QAO9C,4BAAuB,GAAG,KAAK,CAAC;QAQtC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,cAAc,GAAG,IAAI,yBAAc,CAAC,MAAM,CAAC,CAAC;QACjD,IAAI,CAAC,aAAa,GAAG,IAAI,wBAAa,EAAE,CAAC;QACzC,IAAI,CAAC,mBAAmB,GAAG,IAAI,mCAAmB,CAAC,MAAM,CAAC,CAAC;IAC7D,CAAC;IAED;;OAEG;IACO,cAAc,CAAC,QAA6B,EAAE,YAA8B;QACpF,IAAI,CAAC,aAAa,CAAC,WAAW,CAAC,QAAQ,EAAE,YAAY,CAAC,CAAC;IACzD,CAAC;IAED;;;OAGG;IACO,sBAAsB;QAC9B,IAAI,CAAC,IAAI,CAAC,uBAAuB,EAAE,CAAC;YAClC,IAAI,CAAC,uBAAuB,GAAG,IAAI,CAAC;YACpC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,KAAK,EAAC,YAAY,EAAC,EAAE;gBACzC,MAAM,MAAM,GAAG,IAAI,gBAAM,CAAC,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC,CAAC,GAAG,CAAC,YAAY,CAAC,MAAM,EAAE,CAAC,CAAC;gBAC5E,IAAI,CAAC,mBAAmB,CAAC,UAAU,CAAC,IAAI,aAAG,EAAE,CAAC,GAAG,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAC;YACjF,CAAC,CAAC,CAAC;QACL,CAAC;QAED,OAAO,IAAI,CAAC,mBAAmB,CAAC;IAClC,CAAC;IAES,KAAK,CAAC,KAAK,CAAC,MAAc;QAClC,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,YAAY;YAAE,MAAM,IAAI,EAAE,CAAC,CAAC,uCAAuC;QAE3F,MAAM,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;IAC7B,CAAC;IAES,KAAK,CAAC,OAAO,CAAC,MAAc;QACpC,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,WAAW;YAAE,MAAM,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,uCAAuC;IAClG,CAAC;IAEM,KAAK,CAAC,IAAI;QACf,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,MAAM;YAAE,MAAM,IAAI,EAAE,CAAC,CAAC,uCAAuC;IACvF,CAAC;IAED;;;;;;OAMG;IACH,uBAAuB,CAAC,IAAa,EAAE,IAAa;QAClD,MAAM,WAAW,GAAG,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,SAAS,CAAC;QAC1D,MAAM,UAAU,GAAG,IAAI,IAAI,WAAW,IAAI,IAAI,CAAC;QAC/C,IAAI,CAAC,oBAAoB,GAAG,IAAI,CAAC;QACjC,MAAM,MAAM,GAAG,IAAA,mBAAY,EAAC,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,CAAC,CAAC;QAE3D,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,GAAG,EAAE;YAC1B,OAAO,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;gBAC3C,MAAM,CAAC,MAAM,CAAC,UAAU,EAAE,IAAI,EAAE,GAAG,EAAE;oBACnC,IAAI,CAAC,oBAAoB,GAAI,MAAM,CAAC,OAAO,EAAsB,CAAC,IAAI,CAAC;oBACvE,IAAI,CAAC,MAAM,CACT,MAAM,EACN,qDAAqD,IAAI,IAAI,SAAS,IACpE,IAAI,CAAC,oBACP,GAAG,CACJ,CAAC;oBAEF,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,IAAI,EAAE;wBAC1B,MAAM,IAAI,OAAO,CAAO,CAAC,WAAW,EAAE,UAAU,EAAE,EAAE;4BAClD,MAAM,CAAC,KAAK,CAAC,CAAC,GAAQ,EAAE,EAAE;gCACxB,IAAI,GAAG,EAAE,CAAC;oCACR,UAAU,CAAC,GAAG,CAAC,CAAC;gCAClB,CAAC;qCAAM,CAAC;oCACN,WAAW,EAAE,CAAC;gCAChB,CAAC;4BACH,CAAC,CAAC,CAAC;wBACL,CAAC,CAAC,CAAC;oBACL,CAAC,CAAC,CAAC;oBAEH,OAAO,EAAE,CAAC;gBACZ,CAAC,CAAC,CAAC;gBACH,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;YAC7B,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;OAGG;IACH,cAAc,CAAC,OAAY;QACzB,mGAAmG;QACnG,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,aAAa,CAAC,oBAAoB,EAAE,CAAC,CAAC;QAEvD,+CAA+C;QAC/C,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,mBAAmB,EAAE,IAAI,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC,CAAC;QAEtE,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,oCAAoC,CAAC,CAAC;QAE1D,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;OAGG;IACH,cAAc,CAAC,OAAY;QACzB,uEAAuE;QACvE,IAAI,CAAC,cAAc,CAAC,WAAW,CAAC,OAAO,EAAE,IAAI,CAAC,aAAa,CAAC,oBAAoB,EAAE,EAAE,GAAG,CAAC,CAAC;QAEzF,2BAA2B;QAC3B,MAAM,QAAQ,GAAG,IAAI,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC;QAChD,IAAI,CAAC,cAAc,CAAC,WAAW,CAAC,OAAO,EAAE,QAAQ,EAAE,IAAI,CAAC,mBAAmB,CAAC,CAAC;QAE7E,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,iCAAiC,CAAC,CAAC;QAEvD,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;OAGG;IACH,UAAU,CAAC,GAAQ;QACjB,MAAM,YAAY,GAAG,IAAI,gBAAM,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,mBAAmB,EAAE,CAAC,CAAC;QAEtE,wEAAwE;QACxE,YAAY,CAAC,GAAG,CAAC,GAAG,EAAE,GAAG,CAAC,EAAE;YAC1B,GAAG,CAAC,QAAQ,CAAC,MAAM,GAAG,GAAG,CAAC;YAC1B,GAAG,CAAC,QAAQ,CAAC,IAAI,GAAG,EAAE,KAAK,EAAE,sBAAsB,EAAE,CAAC;QACxD,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,KAAK,EAAC,YAAY,EAAC,EAAE;YACzC,2BAA2B;YAC3B,YAAY,CAAC,KAAK,GAAG,EAAE,CAAC;YACxB,kBAAkB;YAClB,YAAY,CAAC,GAAG,CAAC,YAAY,CAAC,MAAM,EAAE,CAAC,CAAC;QAC1C,CAAC,CAAC,CAAC;QAEH,6EAA6E;QAC7E,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,aAAa,CAAC,gBAAgB,EAAE,CAAC,CAAC;QAC/C,GAAG,CAAC,GAAG,CAAC,YAAY,CAAC,MAAM,EAAE,CAAC,CAAC;QAC/B,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,6BAA6B,CAAC,CAAC;QAEnD,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;OAGG;IACH,aAAa,CAAC,MAAW;QACvB,MAAM,OAAO,GAAG,MAAM,CAAC,cAAc,EAAE,CAAC;QACxC,MAAM,QAAQ,GAAG,IAAI,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC;QAEhD,IAAI,OAAO,CAAC,WAAW,CAAC,IAAI,KAAK,gBAAgB,EAAE,CAAC;YAClD,uEAAuE;YACvE,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,aAAa,CAAC,oBAAoB,EAAE,CAAC,CAAC;YACtD,2BAA2B;YAC3B,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,mBAAmB,EAAE,QAAQ,CAAC,CAAC;QACjD,CAAC;aAAM,CAAC;YACN,2CAA2C;YAC3C,IAAI,CAAC,cAAc,CAAC,WAAW,CAAC,MAAM,EAAE,IAAI,CAAC,aAAa,CAAC,oBAAoB,EAAE,EAAE,GAAG,CAAC,CAAC;YACxF,IAAI,CAAC,cAAc,CAAC,WAAW,CAAC,MAAM,EAAE,QAAQ,EAAE,IAAI,CAAC,mBAAmB,CAAC,CAAC;QAC9E,CAAC;QAED,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,gCAAgC,CAAC,CAAC;QAEtD,OAAO,IAAI,CAAC;IACd,CAAC;IAEO,kBAAkB,CAAC,MAAe;QACxC,IAAI,OAAO,GAA0C,IAAI,CAAC;QAE1D,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,KAAK,EAAC,YAAY,EAAC,EAAE;YACzC,IAAI,MAAM,GAAG,YAAY,CAAC;YAE1B,IAAI,MAAM,EAAE,CAAC;gBACX,MAAM,GAAG,IAAI,gBAAM,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,mBAAmB,EAAE,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC;YACjF,CAAC;YAED,OAAO,GAAG,IAAI,aAAG,EAAE,CAAC,GAAG,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC;QACtD,CAAC,CAAC,CAAC;QAEH,OAAO,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE;YAClB,2DAA2D;YAC3D,kDAAkD;YAClD,MAAM,WAAW,GAAG,IAAI,CAAC,aAAa,CAAC,WAAW,EAAE,CAAC;YAErD,IAAI,MAAM,IAAI,WAAW,EAAE,CAAC;gBAC1B,WAAW,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE;oBACzB,iEAAiE;oBACjE,IAAI,OAAO,EAAE,CAAC;wBACZ,OAAO,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;oBACpB,CAAC;yBAAM,CAAC;wBACN,GAAG,CAAC,SAAS,CAAC,GAAG,EAAE,EAAE,cAAc,EAAE,kBAAkB,EAAE,CAAC,CAAC;wBAC3D,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,KAAK,EAAE,sBAAsB,EAAE,CAAC,CAAC,CAAC;oBAC7D,CAAC;gBACH,CAAC,CAAC,CAAC;gBAEH,OAAO;YACT,CAAC;YAED,IAAI,OAAO,EAAE,CAAC;gBACZ,OAAO,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;YACpB,CAAC;iBAAM,CAAC;gBACN,GAAG,CAAC,SAAS,CAAC,GAAG,EAAE,EAAE,cAAc,EAAE,kBAAkB,EAAE,CAAC,CAAC;gBAC3D,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,KAAK,EAAE,sBAAsB,EAAE,CAAC,CAAC,CAAC;YAC7D,CAAC;QACH,CAAC,CAAC;IACJ,CAAC;CACF;AA5OD,mCA4OC"}
+//# sourceMappingURL=data:application/json;base64,{"version":3,"file":"framework-mounter.js","sourceRoot":"","sources":["../src/framework-mounter.ts"],"names":[],"mappings":";;;;;AAKA,yDAAiC;AACjC,+BAAoC;AACpC,8CAAsB;AACtB,gDAAwB;AAExB,6CAA0C;AAC1C,wEAA+C;AAC/C,4FAA8D;AAC9D,wEAA+C;AAE/C,MAAqB,gBAAgB;IAgBnC,+FAA+F;IAC/F,IAAY,mBAAmB;QAC7B,OAAO,cAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;IACrD,CAAC;IAED,YAAY,MAAc,EAAE,MAAc;QAjBzB,iBAAY,GAA4B,EAAE,CAAC;QAC3C,gBAAW,GAA0C,EAAE,CAAC;QAExD,WAAM,GAA4B,EAAE,CAAC;QAO9C,4BAAuB,GAAG,KAAK,CAAC;QAQtC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,cAAc,GAAG,IAAI,yBAAc,CAAC,MAAM,CAAC,CAAC;QACjD,IAAI,CAAC,cAAc,GAAG,IAAI,yBAAc,CAAC,MAAM,CAAC,CAAC;QACjD,IAAI,CAAC,mBAAmB,GAAG,IAAI,mCAAmB,CAAC,MAAM,CAAC,CAAC;IAC7D,CAAC;IAED;;;;OAIG;IACO,cAAc,CAAC,OAA2B;QAClD,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;IAC1C,CAAC;IAED,0EAA0E;IAChE,cAAc,CAAC,QAA6B;QACpD,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,KAAK,EAAE,QAAQ,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,uBAAU,EAAE,CAAC,CAAC;IAChF,CAAC;IAED;;;OAGG;IACO,sBAAsB;QAC9B,IAAI,CAAC,IAAI,CAAC,uBAAuB,EAAE,CAAC;YAClC,IAAI,CAAC,uBAAuB,GAAG,IAAI,CAAC;YACpC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,KAAK,EAAC,YAAY,EAAC,EAAE;gBACzC,MAAM,MAAM,GAAG,IAAI,gBAAM,CAAC,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC,CAAC,GAAG,CAAC,YAAY,CAAC,MAAM,EAAE,CAAC,CAAC;gBAC5E,IAAI,CAAC,mBAAmB,CAAC,UAAU,CAAC,IAAI,aAAG,EAAE,CAAC,GAAG,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAC;YACjF,CAAC,CAAC,CAAC;QACL,CAAC;QAED,OAAO,IAAI,CAAC,mBAAmB,CAAC;IAClC,CAAC;IAES,KAAK,CAAC,KAAK,CAAC,MAAc;QAClC,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,YAAY;YAAE,MAAM,IAAI,EAAE,CAAC,CAAC,uCAAuC;QAE3F,MAAM,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;IAC7B,CAAC;IAES,KAAK,CAAC,OAAO,CAAC,MAAc;QACpC,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,WAAW;YAAE,MAAM,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,uCAAuC;IAClG,CAAC;IAEM,KAAK,CAAC,IAAI;QACf,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,MAAM;YAAE,MAAM,IAAI,EAAE,CAAC,CAAC,uCAAuC;IACvF,CAAC;IAED;;;;;;OAMG;IACH,uBAAuB,CAAC,IAAa,EAAE,IAAa;QAClD,MAAM,WAAW,GAAG,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,SAAS,CAAC;QAC1D,MAAM,UAAU,GAAG,IAAI,IAAI,WAAW,IAAI,IAAI,CAAC;QAC/C,IAAI,CAAC,oBAAoB,GAAG,IAAI,CAAC;QACjC,MAAM,MAAM,GAAG,IAAA,mBAAY,EAAC,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,CAAC,CAAC;QAE3D,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,GAAG,EAAE;YAC1B,OAAO,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;gBAC3C,MAAM,CAAC,MAAM,CAAC,UAAU,EAAE,IAAI,EAAE,GAAG,EAAE;oBACnC,IAAI,CAAC,oBAAoB,GAAI,MAAM,CAAC,OAAO,EAAsB,CAAC,IAAI,CAAC;oBACvE,IAAI,CAAC,MAAM,CACT,MAAM,EACN,qDAAqD,IAAI,IAAI,SAAS,IACpE,IAAI,CAAC,oBACP,GAAG,CACJ,CAAC;oBAEF,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,IAAI,EAAE;wBAC1B,MAAM,IAAI,OAAO,CAAO,CAAC,WAAW,EAAE,UAAU,EAAE,EAAE;4BAClD,MAAM,CAAC,KAAK,CAAC,CAAC,GAAQ,EAAE,EAAE;gCACxB,IAAI,GAAG,EAAE,CAAC;oCACR,UAAU,CAAC,GAAG,CAAC,CAAC;gCAClB,CAAC;qCAAM,CAAC;oCACN,WAAW,EAAE,CAAC;gCAChB,CAAC;4BACH,CAAC,CAAC,CAAC;wBACL,CAAC,CAAC,CAAC;oBACL,CAAC,CAAC,CAAC;oBAEH,OAAO,EAAE,CAAC;gBACZ,CAAC,CAAC,CAAC;gBACH,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;YAC7B,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;OAGG;IACH,cAAc,CAAC,OAAY;QACzB,mGAAmG;QACnG,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,cAAc,CAAC,oBAAoB,EAAE,CAAC,CAAC;QAExD,+CAA+C;QAC/C,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,mBAAmB,EAAE,IAAI,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC,CAAC;QAEtE,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,oCAAoC,CAAC,CAAC;QAE1D,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;OAGG;IACH,cAAc,CAAC,OAAY;QACzB,uEAAuE;QACvE,IAAI,CAAC,cAAc,CAAC,WAAW,CAAC,OAAO,EAAE,IAAI,CAAC,cAAc,CAAC,oBAAoB,EAAE,EAAE,GAAG,CAAC,CAAC;QAE1F,2BAA2B;QAC3B,MAAM,QAAQ,GAAG,IAAI,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC;QAChD,IAAI,CAAC,cAAc,CAAC,WAAW,CAAC,OAAO,EAAE,QAAQ,EAAE,IAAI,CAAC,mBAAmB,CAAC,CAAC;QAE7E,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,iCAAiC,CAAC,CAAC;QAEvD,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;OAGG;IACH,UAAU,CAAC,GAAQ;QACjB,MAAM,YAAY,GAAG,IAAI,gBAAM,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,mBAAmB,EAAE,CAAC,CAAC;QAEtE,wEAAwE;QACxE,YAAY,CAAC,GAAG,CAAC,GAAG,EAAE,GAAG,CAAC,EAAE;YAC1B,GAAG,CAAC,QAAQ,CAAC,MAAM,GAAG,GAAG,CAAC;YAC1B,GAAG,CAAC,QAAQ,CAAC,IAAI,GAAG,EAAE,KAAK,EAAE,sBAAsB,EAAE,CAAC;QACxD,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,KAAK,EAAC,YAAY,EAAC,EAAE;YACzC,2BAA2B;YAC3B,YAAY,CAAC,KAAK,GAAG,EAAE,CAAC;YACxB,kBAAkB;YAClB,YAAY,CAAC,GAAG,CAAC,YAAY,CAAC,MAAM,EAAE,CAAC,CAAC;QAC1C,CAAC,CAAC,CAAC;QAEH,6EAA6E;QAC7E,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,cAAc,CAAC,gBAAgB,EAAE,CAAC,CAAC;QAChD,GAAG,CAAC,GAAG,CAAC,YAAY,CAAC,MAAM,EAAE,CAAC,CAAC;QAC/B,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,6BAA6B,CAAC,CAAC;QAEnD,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;OAGG;IACH,aAAa,CAAC,MAAW;QACvB,MAAM,OAAO,GAAG,MAAM,CAAC,cAAc,EAAE,CAAC;QACxC,MAAM,QAAQ,GAAG,IAAI,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC;QAEhD,IAAI,OAAO,CAAC,WAAW,CAAC,IAAI,KAAK,gBAAgB,EAAE,CAAC;YAClD,uEAAuE;YACvE,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,cAAc,CAAC,oBAAoB,EAAE,CAAC,CAAC;YACvD,2BAA2B;YAC3B,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,mBAAmB,EAAE,QAAQ,CAAC,CAAC;QACjD,CAAC;aAAM,CAAC;YACN,2CAA2C;YAC3C,IAAI,CAAC,cAAc,CAAC,WAAW,CAAC,MAAM,EAAE,IAAI,CAAC,cAAc,CAAC,oBAAoB,EAAE,EAAE,GAAG,CAAC,CAAC;YACzF,IAAI,CAAC,cAAc,CAAC,WAAW,CAAC,MAAM,EAAE,QAAQ,EAAE,IAAI,CAAC,mBAAmB,CAAC,CAAC;QAC9E,CAAC;QAED,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,gCAAgC,CAAC,CAAC;QAEtD,OAAO,IAAI,CAAC;IACd,CAAC;IAEO,kBAAkB,CAAC,MAAe;QACxC,IAAI,OAAO,GAA0C,IAAI,CAAC;QAE1D,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,KAAK,EAAC,YAAY,EAAC,EAAE;YACzC,IAAI,MAAM,GAAG,YAAY,CAAC;YAE1B,IAAI,MAAM,EAAE,CAAC;gBACX,MAAM,GAAG,IAAI,gBAAM,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,mBAAmB,EAAE,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC;YACjF,CAAC;YAED,OAAO,GAAG,IAAI,aAAG,EAAE,CAAC,GAAG,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC;QACtD,CAAC,CAAC,CAAC;QAEH,OAAO,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE;YAClB,2DAA2D;YAC3D,kDAAkD;YAClD,MAAM,YAAY,GAAG,IAAI,CAAC,cAAc,CAAC,WAAW,EAAE,CAAC;YAEvD,IAAI,MAAM,IAAI,YAAY,EAAE,CAAC;gBAC3B,YAAY,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE;oBAC1B,iEAAiE;oBACjE,IAAI,OAAO,EAAE,CAAC;wBACZ,OAAO,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;oBACpB,CAAC;yBAAM,CAAC;wBACN,GAAG,CAAC,SAAS,CAAC,GAAG,EAAE,EAAE,cAAc,EAAE,kBAAkB,EAAE,CAAC,CAAC;wBAC3D,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,KAAK,EAAE,sBAAsB,EAAE,CAAC,CAAC,CAAC;oBAC7D,CAAC;gBACH,CAAC,CAAC,CAAC;gBAEH,OAAO;YACT,CAAC;YAED,IAAI,OAAO,EAAE,CAAC;gBACZ,OAAO,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;YACpB,CAAC;iBAAM,CAAC;gBACN,GAAG,CAAC,SAAS,CAAC,GAAG,EAAE,EAAE,cAAc,EAAE,kBAAkB,EAAE,CAAC,CAAC;gBAC3D,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,KAAK,EAAE,sBAAsB,EAAE,CAAC,CAAC,CAAC;YAC7D,CAAC;QACH,CAAC,CAAC;IACJ,CAAC;CACF;AAnPD,mCAmPC"}

package/dist/index.d.ts

@@ -3,7 +3,7 @@ import type { TSchema } from '@forestadmin/datasource-customizer';
 import Agent from './agent';
 export declare function createAgent<S extends TSchema = TSchema>(options: AgentOptions): Agent<S>;
 export { Agent };
-export { AgentOptions, WorkflowExecutorEmbedOptions } from './types';
+export { AgentOptions, BffEmbedOptions, WorkflowExecutorEmbedOptions } from './types';
 export * from '@forestadmin/datasource-customizer';
 export { default as SchemaGenerator } from './utils/forest-schema/generator';
 //# sourceMappingURL=index.d.ts.map

package/dist/root-middleware.d.ts

@@ -0,0 +1,33 @@
+import type { HttpCallback, RootHandler } from './types';
+import type { Logger } from '@forestadmin/datasource-toolkit';
+import type Koa from 'koa';
+/**
+ * Handlers the agent serves at the root of the host application rather than under its own router
+ * prefix — the MCP server, the embedded BFF. Each one claims a set of paths through its matcher;
+ * anything else falls through to the host, untouched.
+ *
+ * Registered by name so a handler can be replaced or removed on a restart without the mount points
+ * having to know what is registered.
+ */
+export default class RootMiddleware {
+    private readonly handlers;
+    private readonly logger;
+    constructor(logger: Logger);
+    set(name: string, handler: RootHandler | null): void;
+    private entryFor;
+    /**
+     * First registered matcher wins. Overlapping matchers cannot be caught at registration — the
+     * predicates are opaque — so the winner is named here instead: a request answered by the wrong
+     * handler is otherwise indistinguishable from one whose route was never registered.
+     */
+    private handlerFor;
+    /**
+     * Connect-style middleware. A handler that decides not to answer calls `next()`, which passes the
+     * request on to the host exactly as if nothing had been registered.
+     */
+    getExpressMiddleware(): HttpCallback;
+    getKoaMiddleware(): Koa.Middleware;
+    /** The combined callback, or null when nothing is registered and the host needs no detour. */
+    getCallback(): HttpCallback | null;
+}
+//# sourceMappingURL=root-middleware.d.ts.map

package/dist/root-middleware.js

@@ -0,0 +1,70 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const express_to_koa_1 = __importDefault(require("./utils/express-to-koa"));
+/**
+ * Handlers the agent serves at the root of the host application rather than under its own router
+ * prefix — the MCP server, the embedded BFF. Each one claims a set of paths through its matcher;
+ * anything else falls through to the host, untouched.
+ *
+ * Registered by name so a handler can be replaced or removed on a restart without the mount points
+ * having to know what is registered.
+ */
+class RootMiddleware {
+    constructor(logger) {
+        this.handlers = new Map();
+        this.logger = logger;
+    }
+    set(name, handler) {
+        if (handler)
+            this.handlers.set(name, handler);
+        else
+            this.handlers.delete(name);
+    }
+    entryFor(url) {
+        for (const entry of this.handlers) {
+            if (entry[1].matches(url))
+                return entry;
+        }
+        return null;
+    }
+    /**
+     * First registered matcher wins. Overlapping matchers cannot be caught at registration — the
+     * predicates are opaque — so the winner is named here instead: a request answered by the wrong
+     * handler is otherwise indistinguishable from one whose route was never registered.
+     */
+    handlerFor(url) {
+        const entry = this.entryFor(url);
+        if (!entry)
+            return null;
+        this.logger('Debug', `Root middleware: '${entry[0]}' claims ${url}`);
+        return entry[1].callback;
+    }
+    /**
+     * Connect-style middleware. A handler that decides not to answer calls `next()`, which passes the
+     * request on to the host exactly as if nothing had been registered.
+     */
+    getExpressMiddleware() {
+        return (req, res, next) => {
+            const handler = this.handlerFor(req.url ?? '/');
+            if (handler) {
+                handler(req, res, next);
+                return;
+            }
+            next?.();
+        };
+    }
+    getKoaMiddleware() {
+        return (0, express_to_koa_1.default)(this.getExpressMiddleware(), url => this.entryFor(url) !== null);
+    }
+    /** The combined callback, or null when nothing is registered and the host needs no detour. */
+    getCallback() {
+        if (this.handlers.size === 0)
+            return null;
+        return this.getExpressMiddleware();
+    }
+}
+exports.default = RootMiddleware;
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoicm9vdC1taWRkbGV3YXJlLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vc3JjL3Jvb3QtbWlkZGxld2FyZS50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7OztBQUlBLDRFQUFrRDtBQUVsRDs7Ozs7OztHQU9HO0FBQ0gsTUFBcUIsY0FBYztJQUlqQyxZQUFZLE1BQWM7UUFIVCxhQUFRLEdBQUcsSUFBSSxHQUFHLEVBQXVCLENBQUM7UUFJekQsSUFBSSxDQUFDLE1BQU0sR0FBRyxNQUFNLENBQUM7SUFDdkIsQ0FBQztJQUVELEdBQUcsQ0FBQyxJQUFZLEVBQUUsT0FBMkI7UUFDM0MsSUFBSSxPQUFPO1lBQUUsSUFBSSxDQUFDLFFBQVEsQ0FBQyxHQUFHLENBQUMsSUFBSSxFQUFFLE9BQU8sQ0FBQyxDQUFDOztZQUN6QyxJQUFJLENBQUMsUUFBUSxDQUFDLE1BQU0sQ0FBQyxJQUFJLENBQUMsQ0FBQztJQUNsQyxDQUFDO0lBRU8sUUFBUSxDQUFDLEdBQVc7UUFDMUIsS0FBSyxNQUFNLEtBQUssSUFBSSxJQUFJLENBQUMsUUFBUSxFQUFFLENBQUM7WUFDbEMsSUFBSSxLQUFLLENBQUMsQ0FBQyxDQUFDLENBQUMsT0FBTyxDQUFDLEdBQUcsQ0FBQztnQkFBRSxPQUFPLEtBQUssQ0FBQztRQUMxQyxDQUFDO1FBRUQsT0FBTyxJQUFJLENBQUM7SUFDZCxDQUFDO0lBRUQ7Ozs7T0FJRztJQUNLLFVBQVUsQ0FBQyxHQUFXO1FBQzVCLE1BQU0sS0FBSyxHQUFHLElBQUksQ0FBQyxRQUFRLENBQUMsR0FBRyxDQUFDLENBQUM7UUFFakMsSUFBSSxDQUFDLEtBQUs7WUFBRSxPQUFPLElBQUksQ0FBQztRQUV4QixJQUFJLENBQUMsTUFBTSxDQUFDLE9BQU8sRUFBRSxxQkFBcUIsS0FBSyxDQUFDLENBQUMsQ0FBQyxZQUFZLEdBQUcsRUFBRSxDQUFDLENBQUM7UUFFckUsT0FBTyxLQUFLLENBQUMsQ0FBQyxDQUFDLENBQUMsUUFBUSxDQUFDO0lBQzNCLENBQUM7SUFFRDs7O09BR0c7SUFDSCxvQkFBb0I7UUFDbEIsT0FBTyxDQUFDLEdBQUcsRUFBRSxHQUFHLEVBQUUsSUFBSSxFQUFFLEVBQUU7WUFDeEIsTUFBTSxPQUFPLEdBQUcsSUFBSSxDQUFDLFVBQVUsQ0FBQyxHQUFHLENBQUMsR0FBRyxJQUFJLEdBQUcsQ0FBQyxDQUFDO1lBRWhELElBQUksT0FBTyxFQUFFLENBQUM7Z0JBQ1osT0FBTyxDQUFDLEdBQUcsRUFBRSxHQUFHLEVBQUUsSUFBSSxDQUFDLENBQUM7Z0JBRXhCLE9BQU87WUFDVCxDQUFDO1lBRUQsSUFBSSxFQUFFLEVBQUUsQ0FBQztRQUNYLENBQUMsQ0FBQztJQUNKLENBQUM7SUFFRCxnQkFBZ0I7UUFDZCxPQUFPLElBQUEsd0JBQVksRUFBQyxJQUFJLENBQUMsb0JBQW9CLEVBQUUsRUFBRSxHQUFHLENBQUMsRUFBRSxDQUFDLElBQUksQ0FBQyxRQUFRLENBQUMsR0FBRyxDQUFDLEtBQUssSUFBSSxDQUFDLENBQUM7SUFDdkYsQ0FBQztJQUVELDhGQUE4RjtJQUM5RixXQUFXO1FBQ1QsSUFBSSxJQUFJLENBQUMsUUFBUSxDQUFDLElBQUksS0FBSyxDQUFDO1lBQUUsT0FBTyxJQUFJLENBQUM7UUFFMUMsT0FBTyxJQUFJLENBQUMsb0JBQW9CLEVBQUUsQ0FBQztJQUNyQyxDQUFDO0NBQ0Y7QUFoRUQsaUNBZ0VDIn0=

package/dist/types.d.ts

@@ -151,6 +151,47 @@ export type WorkflowExecutorEmbedOptions = Omit<WorkflowExecutorTuningOptions, '
      */
     encryptionKey?: string;
 };
+/**
+ * Options of an embedded BFF. Everything the BFF shares with the agent — the secrets, the Forest
+ * urls, the logger — is inherited rather than repeated: a divergent `authSecret` would make the
+ * agent reject the very tokens the BFF mints, as an opaque 401.
+ */
+export type BffEmbedOptions = {
+    /**
+     * Base64-encoded 32-byte AES-256 key encrypting stored refresh tokens. Gates the OAuth
+     * login/refresh flow (mode 1) and, with it, the AI relay.
+     *
+     * It is not an access control. The data routes accept a `bff_access` bearer whether or not this
+     * is set, because that token is verified against the agent's `authSecret` alone. Omitting it
+     * closes the login flow, not the session-bearer path — what protects that path is `authSecret`.
+     */
+    tokenEncryptionKey?: string;
+    /**
+     * Exact origins (scheme + host + port) allowed to call the BFF from a browser. No wildcard.
+     * Empty means no cross-origin browser access at all, which for a backend-for-frontend is
+     * almost always a mistake — the BFF warns about it at startup.
+     */
+    allowedOrigins?: string[];
+    /** Fallback IANA timezone for a request that carries none. */
+    defaultTimezone?: string;
+    /**
+     * How long a call to the agent may take. Defaults to 10s.
+     *
+     * It bounds how long the BFF waits, and cancels nothing: an action or a write cut off at the
+     * deadline keeps running inside the agent and still commits, so a client retrying on the timeout
+     * can double the mutation. Raise it rather than relying on a retry for operations that are not
+     * idempotent.
+     */
+    agentTimeoutMs?: number;
+    /** How long the AI relay waits for the Forest server. Defaults to 120s. */
+    aiTimeoutMs?: number;
+    /**
+     * Serve `/bff/docs` and `/bff/agent/openapi.json`. Defaults to `false` when embedded: the
+     * document is not filtered per caller, so any authenticated caller reads the name of every
+     * exposed collection, relation and field.
+     */
+    openapiEnabled?: boolean;
+};
 export type AuditTrailRuntime = AuditTrailConfig & {
     store: AuditStore;
     close: () => Promise<void>;
@@ -159,7 +200,12 @@ export type AgentOptionsWithDefaults = Readonly<Required<Omit<AgentOptions, 'aud
     auditTrail: AuditTrailRuntime | null;
 }>;
 export type HttpCallback = (req: IncomingMessage, res: ServerResponse, next?: () => void) => void;
-export type McpRouteMatcher = (url: string) => boolean;
+export type RouteMatcher = (url: string) => boolean;
+/** A handler served at the root of the host application, with the urls it claims. */
+export type RootHandler = {
+    callback: HttpCallback;
+    matches: RouteMatcher;
+};
 export declare enum HttpCode {
     BadRequest = 400,
     Unauthorized = 401,

package/dist/types.js

@@ -22,4 +22,4 @@ var RouteType;
     RouteType[RouteType["Authentication"] = 3] = "Authentication";
     RouteType[RouteType["PrivateRoute"] = 4] = "PrivateRoute";
 })(RouteType || (exports.RouteType = RouteType = {}));
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidHlwZXMuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9zcmMvdHlwZXMudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7O0FBc0tBLElBQVksUUFVWDtBQVZELFdBQVksUUFBUTtJQUNsQixxREFBZ0IsQ0FBQTtJQUNoQix5REFBa0IsQ0FBQTtJQUNsQixtREFBZSxDQUFBO0lBQ2YsaURBQWMsQ0FBQTtJQUNkLDJEQUFtQixDQUFBO0lBQ25CLCtEQUFxQixDQUFBO0lBQ3JCLHVFQUF5QixDQUFBO0lBQ3pCLG1EQUFlLENBQUE7SUFDZixxQ0FBUSxDQUFBO0FBQ1YsQ0FBQyxFQVZXLFFBQVEsd0JBQVIsUUFBUSxRQVVuQjtBQUVELElBQVksU0FPWDtBQVBELFdBQVksU0FBUztJQUNuQixpR0FBaUc7SUFDakcsMkRBQWlCLENBQUE7SUFDakIseURBQWdCLENBQUE7SUFDaEIsdURBQWUsQ0FBQTtJQUNmLDZEQUFrQixDQUFBO0lBQ2xCLHlEQUFnQixDQUFBO0FBQ2xCLENBQUMsRUFQVyxTQUFTLHlCQUFULFNBQVMsUUFPcEIifQ==
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidHlwZXMuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9zcmMvdHlwZXMudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7O0FBbU5BLElBQVksUUFVWDtBQVZELFdBQVksUUFBUTtJQUNsQixxREFBZ0IsQ0FBQTtJQUNoQix5REFBa0IsQ0FBQTtJQUNsQixtREFBZSxDQUFBO0lBQ2YsaURBQWMsQ0FBQTtJQUNkLDJEQUFtQixDQUFBO0lBQ25CLCtEQUFxQixDQUFBO0lBQ3JCLHVFQUF5QixDQUFBO0lBQ3pCLG1EQUFlLENBQUE7SUFDZixxQ0FBUSxDQUFBO0FBQ1YsQ0FBQyxFQVZXLFFBQVEsd0JBQVIsUUFBUSxRQVVuQjtBQUVELElBQVksU0FPWDtBQVBELFdBQVksU0FBUztJQUNuQixpR0FBaUc7SUFDakcsMkRBQWlCLENBQUE7SUFDakIseURBQWdCLENBQUE7SUFDaEIsdURBQWUsQ0FBQTtJQUNmLDZEQUFrQixDQUFBO0lBQ2xCLHlEQUFnQixDQUFBO0FBQ2xCLENBQUMsRUFQVyxTQUFTLHlCQUFULFNBQVMsUUFPcEIifQ==

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@forestadmin/agent",
-  "version": "1.99.2",
+  "version": "1.100.1",
   "main": "dist/index.js",
   "license": "GPL-3.0",
   "publishConfig": {
@@ -49,35 +49,42 @@
   },
   "devDependencies": {
     "@fastify/express": "^1.1.0",
+    "@forestadmin/agent-bff": "1.29.0",
     "@forestadmin/datasource-sql": "1.17.14",
-    "@forestadmin/workflow-executor": "1.28.0",
+    "@forestadmin/workflow-executor": "1.28.1",
     "@nestjs/common": "^11.1.24",
     "@nestjs/core": "^11.1.24",
     "@nestjs/platform-express": "^11.1.24",
     "@nestjs/platform-fastify": "^11.1.24",
     "@shopify/jest-koa-mocks": "^3.1.0",
-    "sqlite3": "^5.1.7",
     "@types/json-api-serializer": "^2.6.3",
     "@types/jsonwebtoken": "^9.0.1",
     "@types/koa": "^2.13.5",
     "@types/koa__cors": "^3.3.0",
     "@types/superagent": "^8.1.9",
+    "@types/supertest": "^6.0.2",
     "express": "^4.18.2",
     "fastify": "^3.29.0",
     "fastify2": "npm:fastify@^2.15.3",
     "fastify4": "npm:fastify@^4.28.0",
     "openid-client": "^5.7.1",
     "reflect-metadata": "^0.1.13",
-    "rxjs": "^7.8.0"
+    "rxjs": "^7.8.0",
+    "sqlite3": "^5.1.7",
+    "supertest": "^7.1.3"
   },
   "peerDependencies": {
     "@fastify/express": "^1.1.0 || ^2.0.0 || ^3.0.0 || ^4.0.0",
-    "@forestadmin/workflow-executor": "1.28.0"
+    "@forestadmin/agent-bff": "1.29.0",
+    "@forestadmin/workflow-executor": "1.28.1"
   },
   "peerDependenciesMeta": {
     "@fastify/express": {
       "optional": true
     },
+    "@forestadmin/agent-bff": {
+      "optional": true
+    },
     "@forestadmin/workflow-executor": {
       "optional": true
     }