@forestadmin/gateway 0.0.0-stage → 1.0.0

package/dist/cli-dispatch.d.ts

@@ -0,0 +1,9 @@
+import type { BFFHttpServer, Logger } from '@forestadmin/agent-bff';
+export declare const USAGE = "Usage: forest-gateway [command]\n\nCommands:\n  (none)      Start the Gateway, configured from the environment.\n              FOREST_GATEWAY_SERVICES lists what it serves: mcp, api or mcp,api.\n  openapi     Write the API's OpenAPI document to stdout, its paths under\n              FOREST_GATEWAY_BASE_PATH/api, its server FOREST_GATEWAY_API_PUBLIC_URL\n              when set.\n              --output [file]  Write to a file instead of stdout, defaulting\n                               to openapi.json in the current directory.\n\nOptions:\n  -h, --help     Show this help and exit.\n  -v, --version  Show the package version and exit.";
+export declare const HINT = "Run 'forest-gateway --help' for usage.";
+export interface DispatchOutcome {
+    exitCode: number;
+    server?: BFFHttpServer;
+}
+export default function dispatchCli(argv: string[], env: NodeJS.ProcessEnv, logger?: Logger): Promise<DispatchOutcome>;
+//# sourceMappingURL=cli-dispatch.d.ts.map

package/dist/cli-dispatch.js

@@ -0,0 +1,67 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HINT = exports.USAGE = void 0;
+exports.default = dispatchCli;
+const agent_bff_1 = require("@forestadmin/agent-bff");
+const gateway_env_1 = require("./gateway-env");
+const run_gateway_1 = __importDefault(require("./run-gateway"));
+const version_1 = __importDefault(require("./version"));
+exports.USAGE = `Usage: forest-gateway [command]
+
+Commands:
+  (none)      Start the Gateway, configured from the environment.
+              FOREST_GATEWAY_SERVICES lists what it serves: mcp, api or mcp,api.
+  openapi     Write the API's OpenAPI document to stdout, its paths under
+              FOREST_GATEWAY_BASE_PATH/api, its server FOREST_GATEWAY_API_PUBLIC_URL
+              when set.
+              --output [file]  Write to a file instead of stdout, defaulting
+                               to ${agent_bff_1.DEFAULT_OUTPUT_FILE} in the current directory.
+
+Options:
+  -h, --help     Show this help and exit.
+  -v, --version  Show the package version and exit.`;
+exports.HINT = "Run 'forest-gateway --help' for usage.";
+const HELP_FLAGS = new Set(['-h', '--help']);
+const VERSION_FLAGS = new Set(['-v', '--version']);
+function rejectCli(reason) {
+    process.stderr.write(`${reason}\n${exports.HINT}\n`);
+    return { exitCode: 1 };
+}
+async function renderGatewayOpenApi(env, logger) {
+    const { basePath, api, warnings } = (0, gateway_env_1.parseOpenApiEnv)(env);
+    warnings.forEach(warning => logger('Warn', warning));
+    return (0, agent_bff_1.renderOpenApi)(api.env, logger, { basePath: (0, gateway_env_1.apiBasePath)(basePath), labels: api.labels });
+}
+async function dispatchCli(argv, env, logger) {
+    const [subcommand, ...rest] = argv;
+    if (subcommand === undefined) {
+        return { exitCode: 0, server: await (0, run_gateway_1.default)(env, logger) };
+    }
+    if (HELP_FLAGS.has(subcommand)) {
+        process.stdout.write(`${exports.USAGE}\n`);
+        return { exitCode: 0 };
+    }
+    if (VERSION_FLAGS.has(subcommand)) {
+        process.stdout.write(`${version_1.default}\n`);
+        return { exitCode: 0 };
+    }
+    if (subcommand !== 'openapi') {
+        return rejectCli(subcommand === agent_bff_1.OUTPUT_FLAG
+            ? `${agent_bff_1.OUTPUT_FLAG} only applies to the openapi command`
+            : `Unknown command: ${subcommand}`);
+    }
+    const { file, extras } = (0, agent_bff_1.parseOutputOption)(rest);
+    if (extras.length > 0) {
+        return rejectCli(`openapi accepts only --output, got: ${extras.map(extra => JSON.stringify(extra)).join(' ')}`);
+    }
+    const document = await renderGatewayOpenApi(env, logger ?? (0, agent_bff_1.createConsoleLogger)());
+    if (file !== undefined) {
+        return (0, agent_bff_1.writeOutputFile)(file, document);
+    }
+    process.stdout.write(document);
+    return { exitCode: 0 };
+}
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY2xpLWRpc3BhdGNoLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vc3JjL2NsaS1kaXNwYXRjaC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7Ozs7QUFzREEsOEJBZ0RDO0FBcEdELHNEQU9nQztBQUVoQywrQ0FBNkQ7QUFDN0QsZ0VBQXVDO0FBQ3ZDLHdEQUFnQztBQUVuQixRQUFBLEtBQUssR0FBRzs7Ozs7Ozs7O29DQVNlLCtCQUFtQjs7OztvREFJSCxDQUFDO0FBRXhDLFFBQUEsSUFBSSxHQUFHLHdDQUF3QyxDQUFDO0FBRTdELE1BQU0sVUFBVSxHQUFHLElBQUksR0FBRyxDQUFDLENBQUMsSUFBSSxFQUFFLFFBQVEsQ0FBQyxDQUFDLENBQUM7QUFDN0MsTUFBTSxhQUFhLEdBQUcsSUFBSSxHQUFHLENBQUMsQ0FBQyxJQUFJLEVBQUUsV0FBVyxDQUFDLENBQUMsQ0FBQztBQU9uRCxTQUFTLFNBQVMsQ0FBQyxNQUFjO0lBQy9CLE9BQU8sQ0FBQyxNQUFNLENBQUMsS0FBSyxDQUFDLEdBQUcsTUFBTSxLQUFLLFlBQUksSUFBSSxDQUFDLENBQUM7SUFFN0MsT0FBTyxFQUFFLFFBQVEsRUFBRSxDQUFDLEVBQUUsQ0FBQztBQUN6QixDQUFDO0FBRUQsS0FBSyxVQUFVLG9CQUFvQixDQUFDLEdBQXNCLEVBQUUsTUFBYztJQUN4RSxNQUFNLEVBQUUsUUFBUSxFQUFFLEdBQUcsRUFBRSxRQUFRLEVBQUUsR0FBRyxJQUFBLDZCQUFlLEVBQUMsR0FBRyxDQUFDLENBQUM7SUFFekQsUUFBUSxDQUFDLE9BQU8sQ0FBQyxPQUFPLENBQUMsRUFBRSxDQUFDLE1BQU0sQ0FBQyxNQUFNLEVBQUUsT0FBTyxDQUFDLENBQUMsQ0FBQztJQUVyRCxPQUFPLElBQUEseUJBQWEsRUFBQyxHQUFHLENBQUMsR0FBRyxFQUFFLE1BQU0sRUFBRSxFQUFFLFFBQVEsRUFBRSxJQUFBLHlCQUFXLEVBQUMsUUFBUSxDQUFDLEVBQUUsTUFBTSxFQUFFLEdBQUcsQ0FBQyxNQUFNLEVBQUUsQ0FBQyxDQUFDO0FBQ2pHLENBQUM7QUFFYyxLQUFLLFVBQVUsV0FBVyxDQUN2QyxJQUFjLEVBQ2QsR0FBc0IsRUFDdEIsTUFBZTtJQUVmLE1BQU0sQ0FBQyxVQUFVLEVBQUUsR0FBRyxJQUFJLENBQUMsR0FBRyxJQUFJLENBQUM7SUFFbkMsSUFBSSxVQUFVLEtBQUssU0FBUyxFQUFFLENBQUM7UUFDN0IsT0FBTyxFQUFFLFFBQVEsRUFBRSxDQUFDLEVBQUUsTUFBTSxFQUFFLE1BQU0sSUFBQSxxQkFBVSxFQUFDLEdBQUcsRUFBRSxNQUFNLENBQUMsRUFBRSxDQUFDO0lBQ2hFLENBQUM7SUFFRCxJQUFJLFVBQVUsQ0FBQyxHQUFHLENBQUMsVUFBVSxDQUFDLEVBQUUsQ0FBQztRQUMvQixPQUFPLENBQUMsTUFBTSxDQUFDLEtBQUssQ0FBQyxHQUFHLGFBQUssSUFBSSxDQUFDLENBQUM7UUFFbkMsT0FBTyxFQUFFLFFBQVEsRUFBRSxDQUFDLEVBQUUsQ0FBQztJQUN6QixDQUFDO0lBRUQsSUFBSSxhQUFhLENBQUMsR0FBRyxDQUFDLFVBQVUsQ0FBQyxFQUFFLENBQUM7UUFDbEMsT0FBTyxDQUFDLE1BQU0sQ0FBQyxLQUFLLENBQUMsR0FBRyxpQkFBTyxJQUFJLENBQUMsQ0FBQztRQUVyQyxPQUFPLEVBQUUsUUFBUSxFQUFFLENBQUMsRUFBRSxDQUFDO0lBQ3pCLENBQUM7SUFFRCxJQUFJLFVBQVUsS0FBSyxTQUFTLEVBQUUsQ0FBQztRQUM3QixPQUFPLFNBQVMsQ0FDZCxVQUFVLEtBQUssdUJBQVc7WUFDeEIsQ0FBQyxDQUFDLEdBQUcsdUJBQVcsc0NBQXNDO1lBQ3RELENBQUMsQ0FBQyxvQkFBb0IsVUFBVSxFQUFFLENBQ3JDLENBQUM7SUFDSixDQUFDO0lBRUQsTUFBTSxFQUFFLElBQUksRUFBRSxNQUFNLEVBQUUsR0FBRyxJQUFBLDZCQUFpQixFQUFDLElBQUksQ0FBQyxDQUFDO0lBRWpELElBQUksTUFBTSxDQUFDLE1BQU0sR0FBRyxDQUFDLEVBQUUsQ0FBQztRQUN0QixPQUFPLFNBQVMsQ0FDZCx1Q0FBdUMsTUFBTSxDQUFDLEdBQUcsQ0FBQyxLQUFLLENBQUMsRUFBRSxDQUFDLElBQUksQ0FBQyxTQUFTLENBQUMsS0FBSyxDQUFDLENBQUMsQ0FBQyxJQUFJLENBQUMsR0FBRyxDQUFDLEVBQUUsQ0FDOUYsQ0FBQztJQUNKLENBQUM7SUFFRCxNQUFNLFFBQVEsR0FBRyxNQUFNLG9CQUFvQixDQUFDLEdBQUcsRUFBRSxNQUFNLElBQUksSUFBQSwrQkFBbUIsR0FBRSxDQUFDLENBQUM7SUFFbEYsSUFBSSxJQUFJLEtBQUssU0FBUyxFQUFFLENBQUM7UUFDdkIsT0FBTyxJQUFBLDJCQUFlLEVBQUMsSUFBSSxFQUFFLFFBQVEsQ0FBQyxDQUFDO0lBQ3pDLENBQUM7SUFFRCxPQUFPLENBQUMsTUFBTSxDQUFDLEtBQUssQ0FBQyxRQUFRLENBQUMsQ0FBQztJQUUvQixPQUFPLEVBQUUsUUFBUSxFQUFFLENBQUMsRUFBRSxDQUFDO0FBQ3pCLENBQUMifQ==

package/dist/cli.d.ts

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+export {};
+//# sourceMappingURL=cli.d.ts.map

package/dist/cli.js

@@ -0,0 +1,20 @@
+#!/usr/bin/env node
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+/* istanbul ignore file */
+const cli_dispatch_1 = __importDefault(require("./cli-dispatch"));
+if (require.main === module) {
+    (0, cli_dispatch_1.default)(process.argv.slice(2), process.env)
+        .then(({ exitCode }) => {
+        if (exitCode !== 0)
+            process.exitCode = exitCode;
+    })
+        .catch(error => {
+        process.stderr.write(`Error: ${error instanceof Error ? error.message : String(error)}\n`);
+        process.exitCode = 1;
+    });
+}
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY2xpLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vc3JjL2NsaS50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7Ozs7QUFDQSwwQkFBMEI7QUFDMUIsa0VBQXlDO0FBRXpDLElBQUksT0FBTyxDQUFDLElBQUksS0FBSyxNQUFNLEVBQUUsQ0FBQztJQUM1QixJQUFBLHNCQUFXLEVBQUMsT0FBTyxDQUFDLElBQUksQ0FBQyxLQUFLLENBQUMsQ0FBQyxDQUFDLEVBQUUsT0FBTyxDQUFDLEdBQUcsQ0FBQztTQUM1QyxJQUFJLENBQUMsQ0FBQyxFQUFFLFFBQVEsRUFBRSxFQUFFLEVBQUU7UUFDckIsSUFBSSxRQUFRLEtBQUssQ0FBQztZQUFFLE9BQU8sQ0FBQyxRQUFRLEdBQUcsUUFBUSxDQUFDO0lBQ2xELENBQUMsQ0FBQztTQUNELEtBQUssQ0FBQyxLQUFLLENBQUMsRUFBRTtRQUNiLE9BQU8sQ0FBQyxNQUFNLENBQUMsS0FBSyxDQUFDLFVBQVUsS0FBSyxZQUFZLEtBQUssQ0FBQyxDQUFDLENBQUMsS0FBSyxDQUFDLE9BQU8sQ0FBQyxDQUFDLENBQUMsTUFBTSxDQUFDLEtBQUssQ0FBQyxJQUFJLENBQUMsQ0FBQztRQUMzRixPQUFPLENBQUMsUUFBUSxHQUFHLENBQUMsQ0FBQztJQUN2QixDQUFDLENBQUMsQ0FBQztBQUNQLENBQUMifQ==

package/dist/env-aliases.d.ts

@@ -0,0 +1,15 @@
+export interface Resolution {
+    key: string;
+    value?: string;
+}
+export interface ResolveOptions {
+    blankIsSet?: boolean;
+}
+export default class EnvAliases {
+    private readonly env;
+    readonly warnings: string[];
+    constructor(env: NodeJS.ProcessEnv);
+    resolve(name: string, aliases?: readonly string[], { blankIsSet }?: ResolveOptions): Resolution;
+    ignore(keys: readonly string[], reason: string): void;
+}
+//# sourceMappingURL=env-aliases.d.ts.map

package/dist/env-aliases.js

@@ -0,0 +1,37 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const agent_bff_1 = require("@forestadmin/agent-bff");
+function isSet(value) {
+    return value !== undefined && value.trim() !== '';
+}
+function isNonEmpty(value) {
+    return value !== undefined && value !== '';
+}
+class EnvAliases {
+    constructor(env) {
+        this.env = env;
+        this.warnings = [];
+    }
+    resolve(name, aliases = [], { blankIsSet = false } = {}) {
+        const isUsed = blankIsSet ? isNonEmpty : isSet;
+        const usedAliases = aliases.filter(alias => isUsed(this.env[alias]));
+        if (isUsed(this.env[name])) {
+            usedAliases.forEach(alias => this.warnings.push(`${alias} is ignored: ${name} is set`));
+            return { key: name, value: this.env[name] };
+        }
+        if (new Set(usedAliases.map(alias => this.env[alias]?.trim())).size > 1) {
+            throw new agent_bff_1.ConfigurationError(`${usedAliases.join(' and ')} disagree: set ${name} to the value the Gateway should use.`);
+        }
+        usedAliases.forEach(alias => this.warnings.push(`${alias} is a legacy name: use ${name} instead`));
+        return usedAliases.length > 0
+            ? { key: usedAliases[0], value: this.env[usedAliases[0]] }
+            : { key: name };
+    }
+    ignore(keys, reason) {
+        keys
+            .filter(key => isSet(this.env[key]))
+            .forEach(key => this.warnings.push(`${key} is ignored: ${reason}`));
+    }
+}
+exports.default = EnvAliases;
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiZW52LWFsaWFzZXMuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9zcmMvZW52LWFsaWFzZXMudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7QUFBQSxzREFBNEQ7QUFXNUQsU0FBUyxLQUFLLENBQUMsS0FBeUI7SUFDdEMsT0FBTyxLQUFLLEtBQUssU0FBUyxJQUFJLEtBQUssQ0FBQyxJQUFJLEVBQUUsS0FBSyxFQUFFLENBQUM7QUFDcEQsQ0FBQztBQUVELFNBQVMsVUFBVSxDQUFDLEtBQXlCO0lBQzNDLE9BQU8sS0FBSyxLQUFLLFNBQVMsSUFBSSxLQUFLLEtBQUssRUFBRSxDQUFDO0FBQzdDLENBQUM7QUFFRCxNQUFxQixVQUFVO0lBRzdCLFlBQTZCLEdBQXNCO1FBQXRCLFFBQUcsR0FBSCxHQUFHLENBQW1CO1FBRjFDLGFBQVEsR0FBYSxFQUFFLENBQUM7SUFFcUIsQ0FBQztJQUV2RCxPQUFPLENBQ0wsSUFBWSxFQUNaLFVBQTZCLEVBQUUsRUFDL0IsRUFBRSxVQUFVLEdBQUcsS0FBSyxLQUFxQixFQUFFO1FBRTNDLE1BQU0sTUFBTSxHQUFHLFVBQVUsQ0FBQyxDQUFDLENBQUMsVUFBVSxDQUFDLENBQUMsQ0FBQyxLQUFLLENBQUM7UUFDL0MsTUFBTSxXQUFXLEdBQUcsT0FBTyxDQUFDLE1BQU0sQ0FBQyxLQUFLLENBQUMsRUFBRSxDQUFDLE1BQU0sQ0FBQyxJQUFJLENBQUMsR0FBRyxDQUFDLEtBQUssQ0FBQyxDQUFDLENBQUMsQ0FBQztRQUVyRSxJQUFJLE1BQU0sQ0FBQyxJQUFJLENBQUMsR0FBRyxDQUFDLElBQUksQ0FBQyxDQUFDLEVBQUUsQ0FBQztZQUMzQixXQUFXLENBQUMsT0FBTyxDQUFDLEtBQUssQ0FBQyxFQUFFLENBQUMsSUFBSSxDQUFDLFFBQVEsQ0FBQyxJQUFJLENBQUMsR0FBRyxLQUFLLGdCQUFnQixJQUFJLFNBQVMsQ0FBQyxDQUFDLENBQUM7WUFFeEYsT0FBTyxFQUFFLEdBQUcsRUFBRSxJQUFJLEVBQUUsS0FBSyxFQUFFLElBQUksQ0FBQyxHQUFHLENBQUMsSUFBSSxDQUFDLEVBQUUsQ0FBQztRQUM5QyxDQUFDO1FBRUQsSUFBSSxJQUFJLEdBQUcsQ0FBQyxXQUFXLENBQUMsR0FBRyxDQUFDLEtBQUssQ0FBQyxFQUFFLENBQUMsSUFBSSxDQUFDLEdBQUcsQ0FBQyxLQUFLLENBQUMsRUFBRSxJQUFJLEVBQUUsQ0FBQyxDQUFDLENBQUMsSUFBSSxHQUFHLENBQUMsRUFBRSxDQUFDO1lBQ3hFLE1BQU0sSUFBSSw4QkFBa0IsQ0FDMUIsR0FBRyxXQUFXLENBQUMsSUFBSSxDQUFDLE9BQU8sQ0FBQyxrQkFBa0IsSUFBSSx1Q0FBdUMsQ0FDMUYsQ0FBQztRQUNKLENBQUM7UUFFRCxXQUFXLENBQUMsT0FBTyxDQUFDLEtBQUssQ0FBQyxFQUFFLENBQzFCLElBQUksQ0FBQyxRQUFRLENBQUMsSUFBSSxDQUFDLEdBQUcsS0FBSywwQkFBMEIsSUFBSSxVQUFVLENBQUMsQ0FDckUsQ0FBQztRQUVGLE9BQU8sV0FBVyxDQUFDLE1BQU0sR0FBRyxDQUFDO1lBQzNCLENBQUMsQ0FBQyxFQUFFLEdBQUcsRUFBRSxXQUFXLENBQUMsQ0FBQyxDQUFDLEVBQUUsS0FBSyxFQUFFLElBQUksQ0FBQyxHQUFHLENBQUMsV0FBVyxDQUFDLENBQUMsQ0FBQyxDQUFDLEVBQUU7WUFDMUQsQ0FBQyxDQUFDLEVBQUUsR0FBRyxFQUFFLElBQUksRUFBRSxDQUFDO0lBQ3BCLENBQUM7SUFFRCxNQUFNLENBQUMsSUFBdUIsRUFBRSxNQUFjO1FBQzVDLElBQUk7YUFDRCxNQUFNLENBQUMsR0FBRyxDQUFDLEVBQUUsQ0FBQyxLQUFLLENBQUMsSUFBSSxDQUFDLEdBQUcsQ0FBQyxHQUFHLENBQUMsQ0FBQyxDQUFDO2FBQ25DLE9BQU8sQ0FBQyxHQUFHLENBQUMsRUFBRSxDQUFDLElBQUksQ0FBQyxRQUFRLENBQUMsSUFBSSxDQUFDLEdBQUcsR0FBRyxnQkFBZ0IsTUFBTSxFQUFFLENBQUMsQ0FBQyxDQUFDO0lBQ3hFLENBQUM7Q0FDRjtBQXZDRCw2QkF1Q0MifQ==

package/dist/gateway-env.d.ts

@@ -0,0 +1,42 @@
+import type { ConfigLabels } from '@forestadmin/agent-bff';
+import type { McpEnv, McpEnvLabels } from '@forestadmin/mcp-server';
+export type Service = 'mcp' | 'api';
+export declare const SERVICES: readonly Service[];
+export declare const SERVICES_VAR = "FOREST_GATEWAY_SERVICES";
+export declare const BASE_PATH_VAR = "FOREST_GATEWAY_BASE_PATH";
+export declare const PUBLIC_URL_VAR = "FOREST_GATEWAY_URL";
+export declare const PORT_VAR = "PORT";
+export declare const AGENT_URL_VAR = "FOREST_AGENT_URL";
+export declare const API_PUBLIC_URL_VAR = "FOREST_GATEWAY_API_PUBLIC_URL";
+export declare const ALLOWED_OAUTH_CLIENTS_VAR = "FOREST_GATEWAY_ALLOWED_OAUTH_CLIENTS";
+export declare const DEFAULT_MCP_PORT = 3931;
+export declare const DEFAULT_API_PORT = 3450;
+export interface McpSettings {
+    env: McpEnv;
+    labels: Partial<McpEnvLabels>;
+}
+export interface ApiSettings {
+    env: NodeJS.ProcessEnv;
+    labels: ConfigLabels;
+    allowedOAuthClients?: string[];
+}
+export interface GatewayEnv {
+    services: Set<Service>;
+    basePath: string;
+    port: number;
+    publicUrl?: string;
+    mcp?: McpSettings;
+    api?: ApiSettings;
+    warnings: string[];
+}
+export interface OpenApiEnv {
+    basePath: string;
+    api: ApiSettings;
+    warnings: string[];
+}
+export declare function parseServices(raw: string | undefined): Set<Service>;
+export declare function apiBasePath(basePath: string): string;
+export declare function parseOpenApiEnv(env: NodeJS.ProcessEnv): OpenApiEnv;
+export declare function resolveListenPort(env: NodeJS.ProcessEnv): number;
+export default function parseGatewayEnv(env: NodeJS.ProcessEnv): GatewayEnv;
+//# sourceMappingURL=gateway-env.d.ts.map

package/dist/gateway-env.js

@@ -0,0 +1,181 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DEFAULT_API_PORT = exports.DEFAULT_MCP_PORT = exports.ALLOWED_OAUTH_CLIENTS_VAR = exports.API_PUBLIC_URL_VAR = exports.AGENT_URL_VAR = exports.PORT_VAR = exports.PUBLIC_URL_VAR = exports.BASE_PATH_VAR = exports.SERVICES_VAR = exports.SERVICES = void 0;
+exports.parseServices = parseServices;
+exports.apiBasePath = apiBasePath;
+exports.parseOpenApiEnv = parseOpenApiEnv;
+exports.resolveListenPort = resolveListenPort;
+exports.default = parseGatewayEnv;
+const agent_bff_1 = require("@forestadmin/agent-bff");
+const forestadmin_client_1 = require("@forestadmin/forestadmin-client");
+const mcp_server_1 = require("@forestadmin/mcp-server");
+const env_aliases_1 = __importDefault(require("./env-aliases"));
+exports.SERVICES = ['mcp', 'api'];
+exports.SERVICES_VAR = 'FOREST_GATEWAY_SERVICES';
+exports.BASE_PATH_VAR = 'FOREST_GATEWAY_BASE_PATH';
+exports.PUBLIC_URL_VAR = 'FOREST_GATEWAY_URL';
+exports.PORT_VAR = 'PORT';
+exports.AGENT_URL_VAR = 'FOREST_AGENT_URL';
+exports.API_PUBLIC_URL_VAR = 'FOREST_GATEWAY_API_PUBLIC_URL';
+exports.ALLOWED_OAUTH_CLIENTS_VAR = 'FOREST_GATEWAY_ALLOWED_OAUTH_CLIENTS';
+const API_VAR_PREFIX = 'FOREST_GATEWAY_API_';
+const BFF_VAR_PREFIX = 'BFF_';
+const BFF_LISTENER_ENV = {
+    port: 'HTTP_PORT',
+    publicUrl: 'BFF_PUBLIC_URL',
+};
+const PORT_ALIASES = [mcp_server_1.MCP_LISTENER_ENV.port, BFF_LISTENER_ENV.port];
+const PUBLIC_URL_ALIASES = [mcp_server_1.MCP_LISTENER_ENV.publicUrl];
+const AGENT_URL_ALIASES = ['AGENT_URL'];
+const ALLOWED_OAUTH_CLIENTS_ALIASES = ['FOREST_MCP_ALLOWED_OAUTH_CLIENTS'];
+const MCP_LABELS = {
+    accessTokenTtl: 'FOREST_MCP_ACCESS_TOKEN_TTL_SECONDS',
+    refreshTokenTtl: 'FOREST_MCP_REFRESH_TOKEN_TTL_SECONDS',
+};
+exports.DEFAULT_MCP_PORT = 3931;
+exports.DEFAULT_API_PORT = 3450;
+const MAX_PORT = 65535;
+const DECIMAL_INTEGER = /^\d+$/;
+const HTTP_PROTOCOLS = ['http:', 'https:'];
+function isService(value) {
+    return exports.SERVICES.includes(value);
+}
+function parseServices(raw) {
+    const entries = (raw ?? '')
+        .split(',')
+        .map(entry => entry.trim())
+        .filter(entry => entry !== '');
+    if (entries.length === 0 || !entries.every(isService)) {
+        throw new agent_bff_1.ConfigurationError(`Invalid ${exports.SERVICES_VAR} "${raw ?? ''}": list the services to serve, ` +
+            `among ${exports.SERVICES.map(service => `"${service}"`).join(', ')} (e.g. "mcp,api").`);
+    }
+    return new Set(entries);
+}
+function apiBasePath(basePath) {
+    return `${basePath}/api`;
+}
+function parsePort({ key, value }, fallback) {
+    const trimmed = value?.trim();
+    if (!trimmed)
+        return fallback;
+    const port = DECIMAL_INTEGER.test(trimmed) ? Number(trimmed) : NaN;
+    if (Number.isNaN(port) || port > MAX_PORT) {
+        throw new agent_bff_1.ConfigurationError(`Invalid ${key} "${value}": expected an integer between 0 and ${MAX_PORT}.`);
+    }
+    return port;
+}
+function parseGatewayUrl({ key, value }) {
+    const trimmed = value?.trim();
+    if (!trimmed)
+        return undefined;
+    const parsed = URL.canParse(trimmed) ? new URL(trimmed) : undefined;
+    const isBareHttpOrigin = parsed && HTTP_PROTOCOLS.includes(parsed.protocol) && parsed.href === `${parsed.origin}/`;
+    if (!isBareHttpOrigin) {
+        throw new agent_bff_1.ConfigurationError(`Invalid ${key}: expected an http(s) origin with no path, query, fragment or ` +
+            'credentials, e.g. https://gateway.example.com');
+    }
+    return parsed.origin;
+}
+function assertAgentUrl({ key, value }) {
+    if (value === undefined)
+        return;
+    const parsed = !/\s/.test(value) && URL.canParse(value) ? new URL(value) : undefined;
+    if (!parsed || !HTTP_PROTOCOLS.includes(parsed.protocol) || parsed.search || parsed.hash) {
+        throw new agent_bff_1.ConfigurationError(`Invalid ${key}: expected an absolute http(s) URL with no query string or fragment.`);
+    }
+}
+function parseAllowedOAuthClients({ key, value }) {
+    if (value === undefined)
+        return undefined;
+    return (0, forestadmin_client_1.normalizeDomainList)((0, forestadmin_client_1.parseDomainList)(value) ?? [], key);
+}
+function assertApiPublicUrl(value, key, basePath) {
+    const url = (0, agent_bff_1.parsePublicUrl)(value, key);
+    const suffix = apiBasePath(basePath);
+    if (url !== undefined && !new URL(url).pathname.endsWith(suffix)) {
+        throw new agent_bff_1.ConfigurationError(`Invalid configuration: ${key} must end with ${suffix}, where the Gateway serves the API.`);
+    }
+}
+function resolveApi(env, aliases, basePath, agentUrl) {
+    const apiEnv = {
+        ...env,
+        AGENT_URL: agentUrl.value,
+        [BFF_LISTENER_ENV.port]: undefined,
+    };
+    const labels = { AGENT_URL: agentUrl.key };
+    const bffKeys = agent_bff_1.CONFIG_KEYS.filter((key) => key.startsWith(BFF_VAR_PREFIX));
+    for (const bffKey of bffKeys) {
+        const { key, value } = aliases.resolve(`${API_VAR_PREFIX}${bffKey.slice(BFF_VAR_PREFIX.length)}`, [bffKey]);
+        apiEnv[bffKey] = value;
+        labels[bffKey] = key;
+    }
+    assertApiPublicUrl(apiEnv.BFF_PUBLIC_URL, labels.BFF_PUBLIC_URL ?? exports.API_PUBLIC_URL_VAR, basePath);
+    return { env: apiEnv, labels };
+}
+function resolveAgentUrl(aliases, withApi) {
+    if (!withApi) {
+        aliases.ignore(AGENT_URL_ALIASES, `the api service is off: use ${exports.AGENT_URL_VAR}`);
+    }
+    const agentUrl = aliases.resolve(exports.AGENT_URL_VAR, withApi ? AGENT_URL_ALIASES : []);
+    assertAgentUrl(agentUrl);
+    return agentUrl;
+}
+function parseOpenApiEnv(env) {
+    const basePath = (0, mcp_server_1.normalizeMountPath)(env[exports.BASE_PATH_VAR], exports.BASE_PATH_VAR);
+    const aliases = new env_aliases_1.default(env);
+    const api = resolveApi(env, aliases, basePath, resolveAgentUrl(aliases, true));
+    return { basePath, api, warnings: aliases.warnings };
+}
+function resolvePort(aliases, withMcp) {
+    return parsePort(aliases.resolve(exports.PORT_VAR, PORT_ALIASES), withMcp ? exports.DEFAULT_MCP_PORT : exports.DEFAULT_API_PORT);
+}
+function resolveListenPort(env) {
+    return resolvePort(new env_aliases_1.default(env), parseServices(env[exports.SERVICES_VAR]).has('mcp'));
+}
+function parseGatewayEnv(env) {
+    const services = parseServices(env[exports.SERVICES_VAR]);
+    const withMcp = services.has('mcp');
+    const withApi = services.has('api');
+    const basePath = (0, mcp_server_1.normalizeMountPath)(env[exports.BASE_PATH_VAR], exports.BASE_PATH_VAR);
+    const aliases = new env_aliases_1.default(env);
+    const port = resolvePort(aliases, withMcp);
+    if (!withMcp) {
+        aliases.ignore([exports.PUBLIC_URL_VAR, ...PUBLIC_URL_ALIASES], `the mcp service is off: the API reads ${exports.API_PUBLIC_URL_VAR}`);
+    }
+    const publicUrl = withMcp
+        ? parseGatewayUrl(aliases.resolve(exports.PUBLIC_URL_VAR, PUBLIC_URL_ALIASES))
+        : undefined;
+    const agentUrl = resolveAgentUrl(aliases, withApi);
+    const allowedOAuthClients = aliases.resolve(exports.ALLOWED_OAUTH_CLIENTS_VAR, ALLOWED_OAUTH_CLIENTS_ALIASES, { blankIsSet: true });
+    const allowedClientDomains = parseAllowedOAuthClients(allowedOAuthClients);
+    if (withMcp && port === 0 && !publicUrl) {
+        throw new agent_bff_1.ConfigurationError(`${exports.PORT_VAR}=0 binds a port chosen by the OS, which cannot be in the url advertised to MCP ` +
+            `clients. Set ${exports.PUBLIC_URL_VAR} to the public url they should use.`);
+    }
+    if (withMcp && !publicUrl) {
+        aliases.warnings.push(`${exports.PUBLIC_URL_VAR} is not set: MCP clients are told http://localhost:${port}`);
+    }
+    const mcp = withMcp
+        ? {
+            env: {
+                ...env,
+                FOREST_AGENT_URL: agentUrl.value,
+                FOREST_MCP_ALLOWED_OAUTH_CLIENTS: allowedOAuthClients.value,
+                [mcp_server_1.MCP_LISTENER_ENV.port]: undefined,
+                [mcp_server_1.MCP_LISTENER_ENV.publicUrl]: undefined,
+            },
+            labels: { ...MCP_LABELS, agentUrl: agentUrl.key },
+        }
+        : undefined;
+    const api = withApi
+        ? {
+            ...resolveApi(env, aliases, basePath, agentUrl),
+            allowedOAuthClients: allowedClientDomains,
+        }
+        : undefined;
+    return { services, basePath, port, publicUrl, mcp, api, warnings: aliases.warnings };
+}
+//# sourceMappingURL=data:application/json;base64,{"version":3,"file":"gateway-env.js","sourceRoot":"","sources":["../src/gateway-env.ts"],"names":[],"mappings":";;;;;;AA8EA,sCAcC;AAED,kCAEC;AA0GD,0CAMC;AASD,8CAEC;AAED,kCA2DC;AApRD,sDAAyF;AACzF,wEAAuF;AACvF,wDAA+E;AAE/E,gEAAuC;AAI1B,QAAA,QAAQ,GAAuB,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;AAE9C,QAAA,YAAY,GAAG,yBAAyB,CAAC;AACzC,QAAA,aAAa,GAAG,0BAA0B,CAAC;AAC3C,QAAA,cAAc,GAAG,oBAAoB,CAAC;AACtC,QAAA,QAAQ,GAAG,MAAM,CAAC;AAClB,QAAA,aAAa,GAAG,kBAAkB,CAAC;AACnC,QAAA,kBAAkB,GAAG,+BAA+B,CAAC;AACrD,QAAA,yBAAyB,GAAG,sCAAsC,CAAC;AAEhF,MAAM,cAAc,GAAG,qBAAqB,CAAC;AAC7C,MAAM,cAAc,GAAG,MAAM,CAAC;AAE9B,MAAM,gBAAgB,GAAG;IACvB,IAAI,EAAE,WAAW;IACjB,SAAS,EAAE,gBAAgB;CACiB,CAAC;AAE/C,MAAM,YAAY,GAAG,CAAC,6BAAgB,CAAC,IAAI,EAAE,gBAAgB,CAAC,IAAI,CAAC,CAAC;AACpE,MAAM,kBAAkB,GAAG,CAAC,6BAAgB,CAAC,SAAS,CAAC,CAAC;AACxD,MAAM,iBAAiB,GAAG,CAAC,WAAW,CAAC,CAAC;AACxC,MAAM,6BAA6B,GAAG,CAAC,kCAAkC,CAAC,CAAC;AAE3E,MAAM,UAAU,GAA0B;IACxC,cAAc,EAAE,qCAAqC;IACrD,eAAe,EAAE,sCAAsC;CACxD,CAAC;AAEW,QAAA,gBAAgB,GAAG,IAAI,CAAC;AACxB,QAAA,gBAAgB,GAAG,IAAI,CAAC;AAErC,MAAM,QAAQ,GAAG,KAAK,CAAC;AACvB,MAAM,eAAe,GAAG,OAAO,CAAC;AAChC,MAAM,cAAc,GAAG,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;AA6B3C,SAAS,SAAS,CAAC,KAAa;IAC9B,OAAQ,gBAA8B,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;AACzD,CAAC;AAED,SAAgB,aAAa,CAAC,GAAuB;IACnD,MAAM,OAAO,GAAG,CAAC,GAAG,IAAI,EAAE,CAAC;SACxB,KAAK,CAAC,GAAG,CAAC;SACV,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC;SAC1B,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,KAAK,KAAK,EAAE,CAAC,CAAC;IAEjC,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,SAAS,CAAC,EAAE,CAAC;QACtD,MAAM,IAAI,8BAAkB,CAC1B,WAAW,oBAAY,KAAK,GAAG,IAAI,EAAE,iCAAiC;YACpE,SAAS,gBAAQ,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,CAAC,IAAI,OAAO,GAAG,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,oBAAoB,CAClF,CAAC;IACJ,CAAC;IAED,OAAO,IAAI,GAAG,CAAC,OAAoB,CAAC,CAAC;AACvC,CAAC;AAED,SAAgB,WAAW,CAAC,QAAgB;IAC1C,OAAO,GAAG,QAAQ,MAAM,CAAC;AAC3B,CAAC;AAED,SAAS,SAAS,CAAC,EAAE,GAAG,EAAE,KAAK,EAAc,EAAE,QAAgB;IAC7D,MAAM,OAAO,GAAG,KAAK,EAAE,IAAI,EAAE,CAAC;IAE9B,IAAI,CAAC,OAAO;QAAE,OAAO,QAAQ,CAAC;IAE9B,MAAM,IAAI,GAAG,eAAe,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC;IAEnE,IAAI,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,IAAI,GAAG,QAAQ,EAAE,CAAC;QAC1C,MAAM,IAAI,8BAAkB,CAC1B,WAAW,GAAG,KAAK,KAAK,wCAAwC,QAAQ,GAAG,CAC5E,CAAC;IACJ,CAAC;IAED,OAAO,IAAI,CAAC;AACd,CAAC;AAED,SAAS,eAAe,CAAC,EAAE,GAAG,EAAE,KAAK,EAAc;IACjD,MAAM,OAAO,GAAG,KAAK,EAAE,IAAI,EAAE,CAAC;IAE9B,IAAI,CAAC,OAAO;QAAE,OAAO,SAAS,CAAC;IAE/B,MAAM,MAAM,GAAG,GAAG,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IACpE,MAAM,gBAAgB,GACpB,MAAM,IAAI,cAAc,CAAC,QAAQ,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,MAAM,CAAC,IAAI,KAAK,GAAG,MAAM,CAAC,MAAM,GAAG,CAAC;IAE5F,IAAI,CAAC,gBAAgB,EAAE,CAAC;QACtB,MAAM,IAAI,8BAAkB,CAC1B,WAAW,GAAG,gEAAgE;YAC5E,+CAA+C,CAClD,CAAC;IACJ,CAAC;IAED,OAAO,MAAM,CAAC,MAAM,CAAC;AACvB,CAAC;AAED,SAAS,cAAc,CAAC,EAAE,GAAG,EAAE,KAAK,EAAc;IAChD,IAAI,KAAK,KAAK,SAAS;QAAE,OAAO;IAEhC,MAAM,MAAM,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,GAAG,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IAErF,IAAI,CAAC,MAAM,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,MAAM,CAAC,MAAM,IAAI,MAAM,CAAC,IAAI,EAAE,CAAC;QACzF,MAAM,IAAI,8BAAkB,CAC1B,WAAW,GAAG,sEAAsE,CACrF,CAAC;IACJ,CAAC;AACH,CAAC;AAED,SAAS,wBAAwB,CAAC,EAAE,GAAG,EAAE,KAAK,EAAc;IAC1D,IAAI,KAAK,KAAK,SAAS;QAAE,OAAO,SAAS,CAAC;IAE1C,OAAO,IAAA,wCAAmB,EAAC,IAAA,oCAAe,EAAC,KAAK,CAAC,IAAI,EAAE,EAAE,GAAG,CAAC,CAAC;AAChE,CAAC;AAED,SAAS,kBAAkB,CAAC,KAAyB,EAAE,GAAW,EAAE,QAAgB;IAClF,MAAM,GAAG,GAAG,IAAA,0BAAc,EAAC,KAAK,EAAE,GAAG,CAAC,CAAC;IACvC,MAAM,MAAM,GAAG,WAAW,CAAC,QAAQ,CAAC,CAAC;IAErC,IAAI,GAAG,KAAK,SAAS,IAAI,CAAC,IAAI,GAAG,CAAC,GAAG,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC;QACjE,MAAM,IAAI,8BAAkB,CAC1B,0BAA0B,GAAG,kBAAkB,MAAM,qCAAqC,CAC3F,CAAC;IACJ,CAAC;AACH,CAAC;AAED,SAAS,UAAU,CACjB,GAAsB,EACtB,OAAmB,EACnB,QAAgB,EAChB,QAAoB;IAEpB,MAAM,MAAM,GAAsB;QAChC,GAAG,GAAG;QACN,SAAS,EAAE,QAAQ,CAAC,KAAK;QACzB,CAAC,gBAAgB,CAAC,IAAI,CAAC,EAAE,SAAS;KACnC,CAAC;IACF,MAAM,MAAM,GAAiB,EAAE,SAAS,EAAE,QAAQ,CAAC,GAAG,EAAE,CAAC;IACzD,MAAM,OAAO,GAAG,uBAAW,CAAC,MAAM,CAAC,CAAC,GAAc,EAAE,EAAE,CAAC,GAAG,CAAC,UAAU,CAAC,cAAc,CAAC,CAAC,CAAC;IAEvF,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE,CAAC;QAC7B,MAAM,EAAE,GAAG,EAAE,KAAK,EAAE,GAAG,OAAO,CAAC,OAAO,CACpC,GAAG,cAAc,GAAG,MAAM,CAAC,KAAK,CAAC,cAAc,CAAC,MAAM,CAAC,EAAE,EACzD,CAAC,MAAM,CAAC,CACT,CAAC;QAEF,MAAM,CAAC,MAAM,CAAC,GAAG,KAAK,CAAC;QACvB,MAAM,CAAC,MAAM,CAAC,GAAG,GAAG,CAAC;IACvB,CAAC;IAED,kBAAkB,CAAC,MAAM,CAAC,cAAc,EAAE,MAAM,CAAC,cAAc,IAAI,0BAAkB,EAAE,QAAQ,CAAC,CAAC;IAEjG,OAAO,EAAE,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC;AACjC,CAAC;AAED,SAAS,eAAe,CAAC,OAAmB,EAAE,OAAgB;IAC5D,IAAI,CAAC,OAAO,EAAE,CAAC;QACb,OAAO,CAAC,MAAM,CAAC,iBAAiB,EAAE,+BAA+B,qBAAa,EAAE,CAAC,CAAC;IACpF,CAAC;IAED,MAAM,QAAQ,GAAG,OAAO,CAAC,OAAO,CAAC,qBAAa,EAAE,OAAO,CAAC,CAAC,CAAC,iBAAiB,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;IAClF,cAAc,CAAC,QAAQ,CAAC,CAAC;IAEzB,OAAO,QAAQ,CAAC;AAClB,CAAC;AAED,SAAgB,eAAe,CAAC,GAAsB;IACpD,MAAM,QAAQ,GAAG,IAAA,+BAAkB,EAAC,GAAG,CAAC,qBAAa,CAAC,EAAE,qBAAa,CAAC,CAAC;IACvE,MAAM,OAAO,GAAG,IAAI,qBAAU,CAAC,GAAG,CAAC,CAAC;IACpC,MAAM,GAAG,GAAG,UAAU,CAAC,GAAG,EAAE,OAAO,EAAE,QAAQ,EAAE,eAAe,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC,CAAC;IAE/E,OAAO,EAAE,QAAQ,EAAE,GAAG,EAAE,QAAQ,EAAE,OAAO,CAAC,QAAQ,EAAE,CAAC;AACvD,CAAC;AAED,SAAS,WAAW,CAAC,OAAmB,EAAE,OAAgB;IACxD,OAAO,SAAS,CACd,OAAO,CAAC,OAAO,CAAC,gBAAQ,EAAE,YAAY,CAAC,EACvC,OAAO,CAAC,CAAC,CAAC,wBAAgB,CAAC,CAAC,CAAC,wBAAgB,CAC9C,CAAC;AACJ,CAAC;AAED,SAAgB,iBAAiB,CAAC,GAAsB;IACtD,OAAO,WAAW,CAAC,IAAI,qBAAU,CAAC,GAAG,CAAC,EAAE,aAAa,CAAC,GAAG,CAAC,oBAAY,CAAC,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC;AACvF,CAAC;AAED,SAAwB,eAAe,CAAC,GAAsB;IAC5D,MAAM,QAAQ,GAAG,aAAa,CAAC,GAAG,CAAC,oBAAY,CAAC,CAAC,CAAC;IAClD,MAAM,OAAO,GAAG,QAAQ,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;IACpC,MAAM,OAAO,GAAG,QAAQ,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;IACpC,MAAM,QAAQ,GAAG,IAAA,+BAAkB,EAAC,GAAG,CAAC,qBAAa,CAAC,EAAE,qBAAa,CAAC,CAAC;IACvE,MAAM,OAAO,GAAG,IAAI,qBAAU,CAAC,GAAG,CAAC,CAAC;IACpC,MAAM,IAAI,GAAG,WAAW,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;IAE3C,IAAI,CAAC,OAAO,EAAE,CAAC;QACb,OAAO,CAAC,MAAM,CACZ,CAAC,sBAAc,EAAE,GAAG,kBAAkB,CAAC,EACvC,yCAAyC,0BAAkB,EAAE,CAC9D,CAAC;IACJ,CAAC;IAED,MAAM,SAAS,GAAG,OAAO;QACvB,CAAC,CAAC,eAAe,CAAC,OAAO,CAAC,OAAO,CAAC,sBAAc,EAAE,kBAAkB,CAAC,CAAC;QACtE,CAAC,CAAC,SAAS,CAAC;IACd,MAAM,QAAQ,GAAG,eAAe,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;IACnD,MAAM,mBAAmB,GAAG,OAAO,CAAC,OAAO,CACzC,iCAAyB,EACzB,6BAA6B,EAC7B,EAAE,UAAU,EAAE,IAAI,EAAE,CACrB,CAAC;IACF,MAAM,oBAAoB,GAAG,wBAAwB,CAAC,mBAAmB,CAAC,CAAC;IAE3E,IAAI,OAAO,IAAI,IAAI,KAAK,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC;QACxC,MAAM,IAAI,8BAAkB,CAC1B,GAAG,gBAAQ,iFAAiF;YAC1F,gBAAgB,sBAAc,qCAAqC,CACtE,CAAC;IACJ,CAAC;IAED,IAAI,OAAO,IAAI,CAAC,SAAS,EAAE,CAAC;QAC1B,OAAO,CAAC,QAAQ,CAAC,IAAI,CACnB,GAAG,sBAAc,sDAAsD,IAAI,EAAE,CAC9E,CAAC;IACJ,CAAC;IAED,MAAM,GAAG,GAA4B,OAAO;QAC1C,CAAC,CAAC;YACE,GAAG,EAAE;gBACH,GAAG,GAAG;gBACN,gBAAgB,EAAE,QAAQ,CAAC,KAAK;gBAChC,gCAAgC,EAAE,mBAAmB,CAAC,KAAK;gBAC3D,CAAC,6BAAgB,CAAC,IAAI,CAAC,EAAE,SAAS;gBAClC,CAAC,6BAAgB,CAAC,SAAS,CAAC,EAAE,SAAS;aACxC;YACD,MAAM,EAAE,EAAE,GAAG,UAAU,EAAE,QAAQ,EAAE,QAAQ,CAAC,GAAG,EAAE;SAClD;QACH,CAAC,CAAC,SAAS,CAAC;IACd,MAAM,GAAG,GAA4B,OAAO;QAC1C,CAAC,CAAC;YACE,GAAG,UAAU,CAAC,GAAG,EAAE,OAAO,EAAE,QAAQ,EAAE,QAAQ,CAAC;YAC/C,mBAAmB,EAAE,oBAAoB;SAC1C;QACH,CAAC,CAAC,SAAS,CAAC;IAEd,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,IAAI,EAAE,SAAS,EAAE,GAAG,EAAE,GAAG,EAAE,QAAQ,EAAE,OAAO,CAAC,QAAQ,EAAE,CAAC;AACvF,CAAC"}

package/dist/healthcheck.d.ts

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+export default function probeHealth(env: NodeJS.ProcessEnv, timeoutMs?: number): Promise<string | undefined>;
+//# sourceMappingURL=healthcheck.d.ts.map

package/dist/healthcheck.js

@@ -0,0 +1,43 @@
+#!/usr/bin/env node
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = probeHealth;
+const http_1 = __importDefault(require("http"));
+const gateway_env_1 = require("./gateway-env");
+const standalone_handler_1 = require("./standalone-handler");
+const HTTP_OK = 200;
+const PROBE_TIMEOUT_MS = 4000;
+async function probeHealth(env, timeoutMs = PROBE_TIMEOUT_MS) {
+    let port;
+    try {
+        port = (0, gateway_env_1.resolveListenPort)(env);
+    }
+    catch (error) {
+        return error.message;
+    }
+    if (port === 0)
+        return 'PORT=0 binds a port chosen by the OS, which cannot be probed';
+    return new Promise(resolve => {
+        const request = http_1.default.get({ host: 'localhost', port, path: standalone_handler_1.HEALTH_PATH, timeout: timeoutMs }, response => {
+            response.resume();
+            resolve(response.statusCode === HTTP_OK
+                ? undefined
+                : `${standalone_handler_1.HEALTH_PATH} on port ${port} answered ${response.statusCode}`);
+        });
+        request.on('timeout', () => request.destroy(new Error(`timed out after ${timeoutMs}ms`)));
+        request.on('error', (error) => resolve(`${standalone_handler_1.HEALTH_PATH} on port ${port}: ${error.code ?? error.message}`));
+    });
+}
+/* istanbul ignore next */
+if (require.main === module) {
+    probeHealth(process.env).then(failure => {
+        if (failure === undefined)
+            return;
+        process.stderr.write(`${failure}\n`);
+        process.exitCode = 1;
+    });
+}
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaGVhbHRoY2hlY2suanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9zcmMvaGVhbHRoY2hlY2sudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7Ozs7O0FBU0EsOEJBZ0NDO0FBeENELGdEQUF3QjtBQUV4QiwrQ0FBa0Q7QUFDbEQsNkRBQW1EO0FBRW5ELE1BQU0sT0FBTyxHQUFHLEdBQUcsQ0FBQztBQUNwQixNQUFNLGdCQUFnQixHQUFHLElBQUksQ0FBQztBQUVmLEtBQUssVUFBVSxXQUFXLENBQ3ZDLEdBQXNCLEVBQ3RCLFNBQVMsR0FBRyxnQkFBZ0I7SUFFNUIsSUFBSSxJQUFZLENBQUM7SUFFakIsSUFBSSxDQUFDO1FBQ0gsSUFBSSxHQUFHLElBQUEsK0JBQWlCLEVBQUMsR0FBRyxDQUFDLENBQUM7SUFDaEMsQ0FBQztJQUFDLE9BQU8sS0FBSyxFQUFFLENBQUM7UUFDZixPQUFRLEtBQWUsQ0FBQyxPQUFPLENBQUM7SUFDbEMsQ0FBQztJQUVELElBQUksSUFBSSxLQUFLLENBQUM7UUFBRSxPQUFPLDhEQUE4RCxDQUFDO0lBRXRGLE9BQU8sSUFBSSxPQUFPLENBQUMsT0FBTyxDQUFDLEVBQUU7UUFDM0IsTUFBTSxPQUFPLEdBQUcsY0FBSSxDQUFDLEdBQUcsQ0FDdEIsRUFBRSxJQUFJLEVBQUUsV0FBVyxFQUFFLElBQUksRUFBRSxJQUFJLEVBQUUsZ0NBQVcsRUFBRSxPQUFPLEVBQUUsU0FBUyxFQUFFLEVBQ2xFLFFBQVEsQ0FBQyxFQUFFO1lBQ1QsUUFBUSxDQUFDLE1BQU0sRUFBRSxDQUFDO1lBQ2xCLE9BQU8sQ0FDTCxRQUFRLENBQUMsVUFBVSxLQUFLLE9BQU87Z0JBQzdCLENBQUMsQ0FBQyxTQUFTO2dCQUNYLENBQUMsQ0FBQyxHQUFHLGdDQUFXLFlBQVksSUFBSSxhQUFhLFFBQVEsQ0FBQyxVQUFVLEVBQUUsQ0FDckUsQ0FBQztRQUNKLENBQUMsQ0FDRixDQUFDO1FBRUYsT0FBTyxDQUFDLEVBQUUsQ0FBQyxTQUFTLEVBQUUsR0FBRyxFQUFFLENBQUMsT0FBTyxDQUFDLE9BQU8sQ0FBQyxJQUFJLEtBQUssQ0FBQyxtQkFBbUIsU0FBUyxJQUFJLENBQUMsQ0FBQyxDQUFDLENBQUM7UUFDMUYsT0FBTyxDQUFDLEVBQUUsQ0FBQyxPQUFPLEVBQUUsQ0FBQyxLQUE0QixFQUFFLEVBQUUsQ0FDbkQsT0FBTyxDQUFDLEdBQUcsZ0NBQVcsWUFBWSxJQUFJLEtBQUssS0FBSyxDQUFDLElBQUksSUFBSSxLQUFLLENBQUMsT0FBTyxFQUFFLENBQUMsQ0FDMUUsQ0FBQztJQUNKLENBQUMsQ0FBQyxDQUFDO0FBQ0wsQ0FBQztBQUVELDBCQUEwQjtBQUMxQixJQUFJLE9BQU8sQ0FBQyxJQUFJLEtBQUssTUFBTSxFQUFFLENBQUM7SUFDNUIsV0FBVyxDQUFDLE9BQU8sQ0FBQyxHQUFHLENBQUMsQ0FBQyxJQUFJLENBQUMsT0FBTyxDQUFDLEVBQUU7UUFDdEMsSUFBSSxPQUFPLEtBQUssU0FBUztZQUFFLE9BQU87UUFFbEMsT0FBTyxDQUFDLE1BQU0sQ0FBQyxLQUFLLENBQUMsR0FBRyxPQUFPLElBQUksQ0FBQyxDQUFDO1FBQ3JDLE9BQU8sQ0FBQyxRQUFRLEdBQUcsQ0FBQyxDQUFDO0lBQ3ZCLENBQUMsQ0FBQyxDQUFDO0FBQ0wsQ0FBQyJ9

package/dist/index.d.ts

@@ -0,0 +1,8 @@
+export { default as runGateway, GATEWAY_NAME } from './run-gateway';
+export { default as dispatchCli } from './cli-dispatch';
+export { default as parseGatewayEnv, parseServices, DEFAULT_API_PORT, DEFAULT_MCP_PORT, } from './gateway-env';
+export type { GatewayEnv, Service } from './gateway-env';
+export { GATEWAY_VERSION_HEADER } from './standalone-handler';
+export type { GatewayHealth } from './standalone-handler';
+export { default as version } from './version';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -0,0 +1,21 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.version = exports.GATEWAY_VERSION_HEADER = exports.DEFAULT_MCP_PORT = exports.DEFAULT_API_PORT = exports.parseServices = exports.parseGatewayEnv = exports.dispatchCli = exports.GATEWAY_NAME = exports.runGateway = void 0;
+var run_gateway_1 = require("./run-gateway");
+Object.defineProperty(exports, "runGateway", { enumerable: true, get: function () { return __importDefault(run_gateway_1).default; } });
+Object.defineProperty(exports, "GATEWAY_NAME", { enumerable: true, get: function () { return run_gateway_1.GATEWAY_NAME; } });
+var cli_dispatch_1 = require("./cli-dispatch");
+Object.defineProperty(exports, "dispatchCli", { enumerable: true, get: function () { return __importDefault(cli_dispatch_1).default; } });
+var gateway_env_1 = require("./gateway-env");
+Object.defineProperty(exports, "parseGatewayEnv", { enumerable: true, get: function () { return __importDefault(gateway_env_1).default; } });
+Object.defineProperty(exports, "parseServices", { enumerable: true, get: function () { return gateway_env_1.parseServices; } });
+Object.defineProperty(exports, "DEFAULT_API_PORT", { enumerable: true, get: function () { return gateway_env_1.DEFAULT_API_PORT; } });
+Object.defineProperty(exports, "DEFAULT_MCP_PORT", { enumerable: true, get: function () { return gateway_env_1.DEFAULT_MCP_PORT; } });
+var standalone_handler_1 = require("./standalone-handler");
+Object.defineProperty(exports, "GATEWAY_VERSION_HEADER", { enumerable: true, get: function () { return standalone_handler_1.GATEWAY_VERSION_HEADER; } });
+var version_1 = require("./version");
+Object.defineProperty(exports, "version", { enumerable: true, get: function () { return __importDefault(version_1).default; } });
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9zcmMvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7Ozs7O0FBQUEsNkNBQW9FO0FBQTNELDBIQUFBLE9BQU8sT0FBYztBQUFFLDJHQUFBLFlBQVksT0FBQTtBQUM1QywrQ0FBd0Q7QUFBL0MsNEhBQUEsT0FBTyxPQUFlO0FBQy9CLDZDQUt1QjtBQUpyQiwrSEFBQSxPQUFPLE9BQW1CO0FBQzFCLDRHQUFBLGFBQWEsT0FBQTtBQUNiLCtHQUFBLGdCQUFnQixPQUFBO0FBQ2hCLCtHQUFBLGdCQUFnQixPQUFBO0FBR2xCLDJEQUE4RDtBQUFyRCw0SEFBQSxzQkFBc0IsT0FBQTtBQUUvQixxQ0FBK0M7QUFBdEMsbUhBQUEsT0FBTyxPQUFXIn0=

package/dist/run-gateway.d.ts

@@ -0,0 +1,6 @@
+import type { Logger } from '@forestadmin/agent-bff';
+import { BFFHttpServer } from '@forestadmin/agent-bff';
+export declare const GATEWAY_NAME = "Forest Gateway";
+export declare const GATEWAY_API_NAME = "Gateway API";
+export default function runGateway(env: NodeJS.ProcessEnv, logger?: Logger): Promise<BFFHttpServer>;
+//# sourceMappingURL=run-gateway.d.ts.map