@forestadmin/agent 1.108.2 → 1.110.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/agent.d.ts +14 -9
- package/dist/agent.js +129 -6
- package/dist/audit-trail/sql-store.js +39 -27
- package/dist/audit-trail/types.d.ts +12 -2
- package/dist/bff-routes.d.ts +6 -0
- package/dist/bff-routes.js +51 -2
- package/dist/embedded-bff.d.ts +23 -6
- package/dist/embedded-bff.js +70 -32
- package/dist/framework-mounter.d.ts +2 -1
- package/dist/framework-mounter.js +4 -1
- package/dist/gateway.d.ts +19 -0
- package/dist/gateway.js +96 -0
- package/dist/index.d.ts +1 -1
- package/dist/index.js +1 -1
- package/dist/routes/access/audit-trail-timeline.js +27 -15
- package/dist/routes/capabilities.js +4 -1
- package/dist/types.d.ts +14 -0
- package/dist/types.js +1 -1
- package/dist/utils/express-to-koa.js +3 -1
- package/package.json +7 -7
|
@@ -69,7 +69,7 @@ export type AuditHistoryQuery = {
|
|
|
69
69
|
after?: Pick<AuditRecord, 'timestamp' | 'id'>;
|
|
70
70
|
};
|
|
71
71
|
/**
|
|
72
|
-
* Cross-collection timeline, newest first. Paged by cursor rather than by offset: a project-wide
|
|
72
|
+
* Cross-collection timeline, newest first unless `order` says otherwise. Paged by cursor rather than by offset: a project-wide
|
|
73
73
|
* feed keeps growing at the head, so an offset silently shifts rows across pages.
|
|
74
74
|
*/
|
|
75
75
|
export type AuditTimelineQuery = {
|
|
@@ -81,7 +81,11 @@ export type AuditTimelineQuery = {
|
|
|
81
81
|
* sharing the boundary timestamp aren't skipped; `excludeIds` drops the ones already returned.
|
|
82
82
|
*/
|
|
83
83
|
before?: string;
|
|
84
|
+
/** Mirror of `before` for an `asc` walk: an inclusive lower bound from the previous page. */
|
|
85
|
+
after?: string;
|
|
84
86
|
excludeIds?: number[];
|
|
87
|
+
/** Defaults to `'desc'`; ties follow `id` in the same direction. */
|
|
88
|
+
order?: 'asc' | 'desc';
|
|
85
89
|
userIds?: number[];
|
|
86
90
|
operations?: AuditOperation[];
|
|
87
91
|
/** Inclusive lower bound on `timestamp` as a UTC ISO instant. */
|
|
@@ -122,10 +126,16 @@ export interface AuditStore {
|
|
|
122
126
|
/** Flat list of entries recorded under any of `correlationKeys` for a record, oldest first. */
|
|
123
127
|
listByCorrelations(query: AuditCorrelationsQuery): AuditRecord[] | Promise<AuditRecord[]>;
|
|
124
128
|
/**
|
|
125
|
-
* Cross-collection timeline
|
|
129
|
+
* Cross-collection timeline in `order`, ties broken by `id` the same way. Optional: a store
|
|
126
130
|
* written before this existed simply doesn't serve the project-level route.
|
|
127
131
|
*/
|
|
128
132
|
listTimeline?(query: AuditTimelineQuery): AuditRecord[] | Promise<AuditRecord[]>;
|
|
133
|
+
/**
|
|
134
|
+
* Distinct authors matching the timeline's filters, independent of its cursor. Optional like
|
|
135
|
+
* `listTimeline`: without it the route serves the rows but no author list. An empty
|
|
136
|
+
* `collections` must match nothing.
|
|
137
|
+
*/
|
|
138
|
+
listTimelineUsers?(query: Omit<AuditTimelineQuery, 'limit' | 'before' | 'after' | 'excludeIds' | 'order'>): AuditUserSummary[] | Promise<AuditUserSummary[]>;
|
|
129
139
|
/** Distinct authors matching the query filters, independent of pagination. */
|
|
130
140
|
listDistinctUsers(query: Omit<AuditHistoryQuery, 'skip' | 'limit' | 'order'>): AuditUserSummary[] | Promise<AuditUserSummary[]>;
|
|
131
141
|
/** One-shot bootstrap awaited by `agent.start()`. Must be idempotent. */
|
package/dist/bff-routes.d.ts
CHANGED
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
import type { HttpCallback } from './types';
|
|
2
|
+
import type { Logger } from '@forestadmin/datasource-toolkit';
|
|
1
3
|
/**
|
|
2
4
|
* Where an embedded BFF answers, at the root of the host application. Fixed: the BFF serves its own
|
|
3
5
|
* `/oauth/*` and `/docs`, which would otherwise collide with the MCP server's root paths and with
|
|
@@ -14,6 +16,10 @@ export declare function isBffRoute(url: string): boolean;
|
|
|
14
16
|
* as a malformed request rather than as the root.
|
|
15
17
|
*/
|
|
16
18
|
export declare function stripBffPrefix(url: string): string;
|
|
19
|
+
export declare const BFF_DEPRECATION_TIMESTAMP: number;
|
|
20
|
+
export declare const BFF_DEPRECATION_LINK = "https://docs.forestadmin.com/product/embed/bff";
|
|
21
|
+
export declare const BFF_DEPRECATION_LOG_INTERVAL_MS: number;
|
|
22
|
+
export declare function createBffAliasCallback(handle: HttpCallback, logger: Logger): HttpCallback;
|
|
17
23
|
/**
|
|
18
24
|
* Whether an MCP mount path would land inside `/bff`. The MCP server normalizes its `basePath`
|
|
19
25
|
* (trim, leading slash, collapsed and stripped trailing slashes) before deriving
|
package/dist/bff-routes.js
CHANGED
|
@@ -1,8 +1,9 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.BFF_PREFIX = void 0;
|
|
3
|
+
exports.BFF_DEPRECATION_LOG_INTERVAL_MS = exports.BFF_DEPRECATION_LINK = exports.BFF_DEPRECATION_TIMESTAMP = exports.BFF_PREFIX = void 0;
|
|
4
4
|
exports.isBffRoute = isBffRoute;
|
|
5
5
|
exports.stripBffPrefix = stripBffPrefix;
|
|
6
|
+
exports.createBffAliasCallback = createBffAliasCallback;
|
|
6
7
|
exports.collidesWithBff = collidesWithBff;
|
|
7
8
|
/**
|
|
8
9
|
* Where an embedded BFF answers, at the root of the host application. Fixed: the BFF serves its own
|
|
@@ -23,11 +24,59 @@ function isBffRoute(url) {
|
|
|
23
24
|
* as a malformed request rather than as the root.
|
|
24
25
|
*/
|
|
25
26
|
function stripBffPrefix(url) {
|
|
27
|
+
if (!isBffRoute(url))
|
|
28
|
+
return url;
|
|
26
29
|
const remainder = url.slice(exports.BFF_PREFIX.length);
|
|
27
30
|
if (remainder === '')
|
|
28
31
|
return '/';
|
|
29
32
|
return remainder.startsWith('/') ? remainder : `/${remainder}`;
|
|
30
33
|
}
|
|
34
|
+
exports.BFF_DEPRECATION_TIMESTAMP = Date.UTC(2026, 9, 5) / 1000;
|
|
35
|
+
exports.BFF_DEPRECATION_LINK = 'https://docs.forestadmin.com/product/embed/bff';
|
|
36
|
+
exports.BFF_DEPRECATION_LOG_INTERVAL_MS = 60 * 60 * 1000;
|
|
37
|
+
const EXPOSE_HEADERS = 'Access-Control-Expose-Headers';
|
|
38
|
+
const DEPRECATION_HEADERS = ['Deprecation', 'Link'];
|
|
39
|
+
const DEPRECATION_LINK = `<${exports.BFF_DEPRECATION_LINK}>; rel="deprecation"`;
|
|
40
|
+
function headerValues(res, name) {
|
|
41
|
+
const value = res.getHeader(name);
|
|
42
|
+
return value === undefined ? [] : [value].flat().map(String);
|
|
43
|
+
}
|
|
44
|
+
function markDeprecated(res) {
|
|
45
|
+
const exposed = headerValues(res, EXPOSE_HEADERS)
|
|
46
|
+
.flatMap(value => value.split(','))
|
|
47
|
+
.map(name => name.trim())
|
|
48
|
+
.filter(Boolean);
|
|
49
|
+
const links = headerValues(res, 'Link');
|
|
50
|
+
res.setHeader('Deprecation', `@${exports.BFF_DEPRECATION_TIMESTAMP}`);
|
|
51
|
+
if (!links.includes(DEPRECATION_LINK)) {
|
|
52
|
+
res.setHeader('Link', [...links, DEPRECATION_LINK].join(', '));
|
|
53
|
+
}
|
|
54
|
+
res.setHeader(EXPOSE_HEADERS, [...new Set([...exposed, ...DEPRECATION_HEADERS])].join(', '));
|
|
55
|
+
}
|
|
56
|
+
function markDeprecatedOnWriteHead(res) {
|
|
57
|
+
const { writeHead } = res;
|
|
58
|
+
res.writeHead = ((...args) => {
|
|
59
|
+
markDeprecated(res);
|
|
60
|
+
return writeHead.apply(res, args);
|
|
61
|
+
});
|
|
62
|
+
}
|
|
63
|
+
function createBffAliasCallback(handle, logger) {
|
|
64
|
+
let lastWarnedAt = null;
|
|
65
|
+
return (req, res, next) => {
|
|
66
|
+
const now = Date.now();
|
|
67
|
+
if (lastWarnedAt === null || now - lastWarnedAt >= exports.BFF_DEPRECATION_LOG_INTERVAL_MS) {
|
|
68
|
+
lastWarnedAt = now;
|
|
69
|
+
logger('Warn', `[BFF] ${exports.BFF_PREFIX}/* is deprecated and was called: use addGateway({ api }), ` +
|
|
70
|
+
`which serves the same routes under <basePath>/api (/api by default). ` +
|
|
71
|
+
`See ${exports.BFF_DEPRECATION_LINK}`);
|
|
72
|
+
}
|
|
73
|
+
const aliasReq = req;
|
|
74
|
+
aliasReq.originalUrl ?? (aliasReq.originalUrl = req.url);
|
|
75
|
+
req.url = stripBffPrefix(req.url ?? exports.BFF_PREFIX);
|
|
76
|
+
markDeprecatedOnWriteHead(res);
|
|
77
|
+
handle(req, res, next);
|
|
78
|
+
};
|
|
79
|
+
}
|
|
31
80
|
/**
|
|
32
81
|
* Whether an MCP mount path would land inside `/bff`. The MCP server normalizes its `basePath`
|
|
33
82
|
* (trim, leading slash, collapsed and stripped trailing slashes) before deriving
|
|
@@ -46,4 +95,4 @@ function collidesWithBff(mcpBasePath) {
|
|
|
46
95
|
.replace(/\/+$/, '');
|
|
47
96
|
return isBffRoute(`${normalized}/mcp`);
|
|
48
97
|
}
|
|
49
|
-
//# sourceMappingURL=data:application/json;base64,
|
|
98
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiYmZmLXJvdXRlcy5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uL3NyYy9iZmYtcm91dGVzLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7OztBQWNBLGdDQUlDO0FBT0Qsd0NBUUM7QUEwQ0Qsd0RBc0JDO0FBU0QsMENBWUM7QUFsSEQ7Ozs7R0FJRztBQUNVLFFBQUEsVUFBVSxHQUFHLE1BQU0sQ0FBQztBQUVqQzs7R0FFRztBQUNILFNBQWdCLFVBQVUsQ0FBQyxHQUFXO0lBQ3BDLE1BQU0sQ0FBQyxRQUFRLENBQUMsR0FBRyxHQUFHLENBQUMsS0FBSyxDQUFDLE1BQU0sRUFBRSxDQUFDLENBQUMsQ0FBQztJQUV4QyxPQUFPLFFBQVEsS0FBSyxrQkFBVSxJQUFJLFFBQVEsQ0FBQyxVQUFVLENBQUMsR0FBRyxrQkFBVSxHQUFHLENBQUMsQ0FBQztBQUMxRSxDQUFDO0FBRUQ7Ozs7R0FJRztBQUNILFNBQWdCLGNBQWMsQ0FBQyxHQUFXO0lBQ3hDLElBQUksQ0FBQyxVQUFVLENBQUMsR0FBRyxDQUFDO1FBQUUsT0FBTyxHQUFHLENBQUM7SUFFakMsTUFBTSxTQUFTLEdBQUcsR0FBRyxDQUFDLEtBQUssQ0FBQyxrQkFBVSxDQUFDLE1BQU0sQ0FBQyxDQUFDO0lBRS9DLElBQUksU0FBUyxLQUFLLEVBQUU7UUFBRSxPQUFPLEdBQUcsQ0FBQztJQUVqQyxPQUFPLFNBQVMsQ0FBQyxVQUFVLENBQUMsR0FBRyxDQUFDLENBQUMsQ0FBQyxDQUFDLFNBQVMsQ0FBQyxDQUFDLENBQUMsSUFBSSxTQUFTLEVBQUUsQ0FBQztBQUNqRSxDQUFDO0FBRVksUUFBQSx5QkFBeUIsR0FBRyxJQUFJLENBQUMsR0FBRyxDQUFDLElBQUksRUFBRSxDQUFDLEVBQUUsQ0FBQyxDQUFDLEdBQUcsSUFBSSxDQUFDO0FBQ3hELFFBQUEsb0JBQW9CLEdBQUcsZ0RBQWdELENBQUM7QUFDeEUsUUFBQSwrQkFBK0IsR0FBRyxFQUFFLEdBQUcsRUFBRSxHQUFHLElBQUksQ0FBQztBQUU5RCxNQUFNLGNBQWMsR0FBRywrQkFBK0IsQ0FBQztBQUN2RCxNQUFNLG1CQUFtQixHQUFHLENBQUMsYUFBYSxFQUFFLE1BQU0sQ0FBQyxDQUFDO0FBQ3BELE1BQU0sZ0JBQWdCLEdBQUcsSUFBSSw0QkFBb0Isc0JBQXNCLENBQUM7QUFFeEUsU0FBUyxZQUFZLENBQUMsR0FBbUIsRUFBRSxJQUFZO0lBQ3JELE1BQU0sS0FBSyxHQUFHLEdBQUcsQ0FBQyxTQUFTLENBQUMsSUFBSSxDQUFDLENBQUM7SUFFbEMsT0FBTyxLQUFLLEtBQUssU0FBUyxDQUFDLENBQUMsQ0FBQyxFQUFFLENBQUMsQ0FBQyxDQUFDLENBQUMsS0FBSyxDQUFDLENBQUMsSUFBSSxFQUFFLENBQUMsR0FBRyxDQUFDLE1BQU0sQ0FBQyxDQUFDO0FBQy9ELENBQUM7QUFFRCxTQUFTLGNBQWMsQ0FBQyxHQUFtQjtJQUN6QyxNQUFNLE9BQU8sR0FBRyxZQUFZLENBQUMsR0FBRyxFQUFFLGNBQWMsQ0FBQztTQUM5QyxPQUFPLENBQUMsS0FBSyxDQUFDLEVBQUUsQ0FBQyxLQUFLLENBQUMsS0FBSyxDQUFDLEdBQUcsQ0FBQyxDQUFDO1NBQ2xDLEdBQUcsQ0FBQyxJQUFJLENBQUMsRUFBRSxDQUFDLElBQUksQ0FBQyxJQUFJLEVBQUUsQ0FBQztTQUN4QixNQUFNLENBQUMsT0FBTyxDQUFDLENBQUM7SUFDbkIsTUFBTSxLQUFLLEdBQUcsWUFBWSxDQUFDLEdBQUcsRUFBRSxNQUFNLENBQUMsQ0FBQztJQUV4QyxHQUFHLENBQUMsU0FBUyxDQUFDLGFBQWEsRUFBRSxJQUFJLGlDQUF5QixFQUFFLENBQUMsQ0FBQztJQUU5RCxJQUFJLENBQUMsS0FBSyxDQUFDLFFBQVEsQ0FBQyxnQkFBZ0IsQ0FBQyxFQUFFLENBQUM7UUFDdEMsR0FBRyxDQUFDLFNBQVMsQ0FBQyxNQUFNLEVBQUUsQ0FBQyxHQUFHLEtBQUssRUFBRSxnQkFBZ0IsQ0FBQyxDQUFDLElBQUksQ0FBQyxJQUFJLENBQUMsQ0FBQyxDQUFDO0lBQ2pFLENBQUM7SUFFRCxHQUFHLENBQUMsU0FBUyxDQUFDLGNBQWMsRUFBRSxDQUFDLEdBQUcsSUFBSSxHQUFHLENBQUMsQ0FBQyxHQUFHLE9BQU8sRUFBRSxHQUFHLG1CQUFtQixDQUFDLENBQUMsQ0FBQyxDQUFDLElBQUksQ0FBQyxJQUFJLENBQUMsQ0FBQyxDQUFDO0FBQy9GLENBQUM7QUFFRCxTQUFTLHlCQUF5QixDQUFDLEdBQW1CO0lBQ3BELE1BQU0sRUFBRSxTQUFTLEVBQUUsR0FBRyxHQUFHLENBQUM7SUFFMUIsR0FBRyxDQUFDLFNBQVMsR0FBRyxDQUFDLENBQUMsR0FBRyxJQUFrQyxFQUFFLEVBQUU7UUFDekQsY0FBYyxDQUFDLEdBQUcsQ0FBQyxDQUFDO1FBRXBCLE9BQU8sU0FBUyxDQUFDLEtBQUssQ0FBQyxHQUFHLEVBQUUsSUFBSSxDQUFDLENBQUM7SUFDcEMsQ0FBQyxDQUFxQixDQUFDO0FBQ3pCLENBQUM7QUFFRCxTQUFnQixzQkFBc0IsQ0FBQyxNQUFvQixFQUFFLE1BQWM7SUFDekUsSUFBSSxZQUFZLEdBQWtCLElBQUksQ0FBQztJQUV2QyxPQUFPLENBQUMsR0FBRyxFQUFFLEdBQUcsRUFBRSxJQUFJLEVBQUUsRUFBRTtRQUN4QixNQUFNLEdBQUcsR0FBRyxJQUFJLENBQUMsR0FBRyxFQUFFLENBQUM7UUFFdkIsSUFBSSxZQUFZLEtBQUssSUFBSSxJQUFJLEdBQUcsR0FBRyxZQUFZLElBQUksdUNBQStCLEVBQUUsQ0FBQztZQUNuRixZQUFZLEdBQUcsR0FBRyxDQUFDO1lBQ25CLE1BQU0sQ0FDSixNQUFNLEVBQ04sU0FBUyxrQkFBVSw0REFBNEQ7Z0JBQzdFLHVFQUF1RTtnQkFDdkUsT0FBTyw0QkFBb0IsRUFBRSxDQUNoQyxDQUFDO1FBQ0osQ0FBQztRQUVELE1BQU0sUUFBUSxHQUFHLEdBQTRDLENBQUM7UUFDOUQsUUFBUSxDQUFDLFdBQVcsS0FBcEIsUUFBUSxDQUFDLFdBQVcsR0FBSyxHQUFHLENBQUMsR0FBRyxFQUFDO1FBQ2pDLEdBQUcsQ0FBQyxHQUFHLEdBQUcsY0FBYyxDQUFDLEdBQUcsQ0FBQyxHQUFHLElBQUksa0JBQVUsQ0FBQyxDQUFDO1FBQ2hELHlCQUF5QixDQUFDLEdBQUcsQ0FBQyxDQUFDO1FBQy9CLE1BQU0sQ0FBQyxHQUFHLEVBQUUsR0FBRyxFQUFFLElBQUksQ0FBQyxDQUFDO0lBQ3pCLENBQUMsQ0FBQztBQUNKLENBQUM7QUFFRDs7Ozs7O0dBTUc7QUFDSCxTQUFnQixlQUFlLENBQUMsV0FBb0I7SUFDbEQsSUFBSSxDQUFDLFdBQVc7UUFBRSxPQUFPLEtBQUssQ0FBQztJQUUvQixNQUFNLE9BQU8sR0FBRyxXQUFXLENBQUMsSUFBSSxFQUFFLENBQUM7SUFFbkMsSUFBSSxPQUFPLEtBQUssRUFBRSxJQUFJLE9BQU8sS0FBSyxHQUFHO1FBQUUsT0FBTyxLQUFLLENBQUM7SUFFcEQsTUFBTSxVQUFVLEdBQUcsQ0FBQyxPQUFPLENBQUMsVUFBVSxDQUFDLEdBQUcsQ0FBQyxDQUFDLENBQUMsQ0FBQyxPQUFPLENBQUMsQ0FBQyxDQUFDLElBQUksT0FBTyxFQUFFLENBQUM7U0FDbkUsT0FBTyxDQUFDLE1BQU0sRUFBRSxHQUFHLENBQUM7U0FDcEIsT0FBTyxDQUFDLE1BQU0sRUFBRSxFQUFFLENBQUMsQ0FBQztJQUV2QixPQUFPLFVBQVUsQ0FBQyxHQUFHLFVBQVUsTUFBTSxDQUFDLENBQUM7QUFDekMsQ0FBQyJ9
|
package/dist/embedded-bff.d.ts
CHANGED
|
@@ -1,19 +1,32 @@
|
|
|
1
1
|
import type { AgentOptionsWithDefaults, BffEmbedOptions, HttpCallback } from './types';
|
|
2
|
-
import type { AgentDispatcher } from '@forestadmin/agent-bff';
|
|
2
|
+
import type { AgentDispatcher, ConfigLabels } from '@forestadmin/agent-bff';
|
|
3
|
+
export declare const GATEWAY_API_CONFIG_LABELS: ConfigLabels;
|
|
4
|
+
export type EmbeddedBffMount = {
|
|
5
|
+
prefix: string;
|
|
6
|
+
name?: string;
|
|
7
|
+
requiredVersion?: string;
|
|
8
|
+
skipIpWhitelistWarning?: boolean;
|
|
9
|
+
allowedOAuthClients?: string[];
|
|
10
|
+
gateway?: boolean;
|
|
11
|
+
};
|
|
3
12
|
/** How long `stop()` waits for the activity-log writes no connection holds. */
|
|
4
13
|
export declare const SHUTDOWN_TIMEOUT_MS = 10000;
|
|
5
14
|
/**
|
|
6
15
|
* Owns the lifecycle of a BFF embedded in the agent process: configuration, dynamic loading of the
|
|
7
|
-
* optional package, build, and the request handler the agent mounts
|
|
8
|
-
* the callback and delegates start/stop.
|
|
16
|
+
* optional package, build, and the request handler the agent mounts under its prefix. The agent
|
|
17
|
+
* only wires the callback and delegates start/stop.
|
|
9
18
|
*/
|
|
10
19
|
export default class EmbeddedBff {
|
|
11
20
|
private readonly options;
|
|
12
21
|
private readonly embedOptions;
|
|
22
|
+
private readonly mount;
|
|
13
23
|
private config;
|
|
14
24
|
private bff;
|
|
15
25
|
private stopped;
|
|
16
|
-
|
|
26
|
+
private claimsBffPath;
|
|
27
|
+
constructor(options: AgentOptionsWithDefaults, embedOptions: BffEmbedOptions, mount: EmbeddedBffMount);
|
|
28
|
+
private get name();
|
|
29
|
+
private log;
|
|
17
30
|
/**
|
|
18
31
|
* Load the package and validate the options the caller handed to `addBff()`. Called before the
|
|
19
32
|
* agent mounts anything: everything checked here is caller input, and `parseConfig` throws on a
|
|
@@ -21,6 +34,8 @@ export default class EmbeddedBff {
|
|
|
21
34
|
* where failing after mount() would leave the host with a live `/forest` and a bricked `/bff`.
|
|
22
35
|
*/
|
|
23
36
|
prepare(): Promise<void>;
|
|
37
|
+
private assertRequiredVersion;
|
|
38
|
+
claims(pathname: string): boolean;
|
|
24
39
|
/**
|
|
25
40
|
* Build the BFF. Called from agent.start() after mount(), because the dispatcher only reaches the
|
|
26
41
|
* agent's own stack once that stack is mounted.
|
|
@@ -56,8 +71,10 @@ export default class EmbeddedBff {
|
|
|
56
71
|
*/
|
|
57
72
|
stop(): Promise<void>;
|
|
58
73
|
/**
|
|
59
|
-
* The callback the agent registers
|
|
60
|
-
*
|
|
74
|
+
* The callback the agent registers under the mount prefix, handed requests already stripped of
|
|
75
|
+
* it: terminal, it never strips nor calls `next`. Answers 503 rather than falling through while
|
|
76
|
+
* the BFF is not serving: a 404 from the host would read as "wrong url" instead of "not
|
|
77
|
+
* available".
|
|
61
78
|
* Boot and shutdown are told apart, because a probe should wait on the first and drain on the
|
|
62
79
|
* second.
|
|
63
80
|
*/
|
package/dist/embedded-bff.js
CHANGED
|
@@ -33,8 +33,21 @@ var __importStar = (this && this.__importStar) || (function () {
|
|
|
33
33
|
};
|
|
34
34
|
})();
|
|
35
35
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
36
|
-
exports.SHUTDOWN_TIMEOUT_MS = void 0;
|
|
37
|
-
const
|
|
36
|
+
exports.SHUTDOWN_TIMEOUT_MS = exports.GATEWAY_API_CONFIG_LABELS = void 0;
|
|
37
|
+
const gateway_1 = require("./gateway");
|
|
38
|
+
const BFF_PACKAGE = '@forestadmin/agent-bff';
|
|
39
|
+
exports.GATEWAY_API_CONFIG_LABELS = {
|
|
40
|
+
FOREST_AUTH_SECRET: 'authSecret',
|
|
41
|
+
FOREST_ENV_SECRET: 'envSecret',
|
|
42
|
+
FOREST_SERVER_URL: 'forestServerUrl',
|
|
43
|
+
FOREST_APP_URL: 'forestAppUrl',
|
|
44
|
+
BFF_TOKEN_ENCRYPTION_KEY: 'api.tokenEncryptionKey',
|
|
45
|
+
BFF_ALLOWED_ORIGINS: 'api.allowedOrigins',
|
|
46
|
+
BFF_DEFAULT_TIMEZONE: 'api.defaultTimezone',
|
|
47
|
+
BFF_AGENT_TIMEOUT_MS: 'api.agentTimeoutMs',
|
|
48
|
+
BFF_AI_TIMEOUT_MS: 'api.aiTimeoutMs',
|
|
49
|
+
BFF_OPENAPI_ENABLED: 'api.openapiEnabled',
|
|
50
|
+
};
|
|
38
51
|
/** How long `stop()` waits for the activity-log writes no connection holds. */
|
|
39
52
|
exports.SHUTDOWN_TIMEOUT_MS = 10000;
|
|
40
53
|
/**
|
|
@@ -43,34 +56,38 @@ exports.SHUTDOWN_TIMEOUT_MS = 10000;
|
|
|
43
56
|
* hand — their `message` and `stack` are not enumerable, so `JSON.stringify` alone turns the one
|
|
44
57
|
* value worth logging into `{}`. Never throws — logging must not break a request.
|
|
45
58
|
*/
|
|
46
|
-
function formatLog(message, context) {
|
|
59
|
+
function formatLog(tag, message, context) {
|
|
47
60
|
if (!context || Object.keys(context).length === 0)
|
|
48
|
-
return
|
|
61
|
+
return `${tag} ${message}`;
|
|
49
62
|
try {
|
|
50
63
|
const serialized = JSON.stringify(context, (_key, value) => value instanceof Error
|
|
51
64
|
? { name: value.name, message: value.message, stack: value.stack }
|
|
52
65
|
: value);
|
|
53
|
-
return
|
|
66
|
+
return `${tag} ${message} ${serialized}`;
|
|
54
67
|
}
|
|
55
68
|
catch {
|
|
56
|
-
return
|
|
69
|
+
return `${tag} ${message} [unserializable context]`;
|
|
57
70
|
}
|
|
58
71
|
}
|
|
59
72
|
/**
|
|
60
73
|
* Owns the lifecycle of a BFF embedded in the agent process: configuration, dynamic loading of the
|
|
61
|
-
* optional package, build, and the request handler the agent mounts
|
|
62
|
-
* the callback and delegates start/stop.
|
|
74
|
+
* optional package, build, and the request handler the agent mounts under its prefix. The agent
|
|
75
|
+
* only wires the callback and delegates start/stop.
|
|
63
76
|
*/
|
|
64
77
|
class EmbeddedBff {
|
|
65
|
-
constructor(options, embedOptions) {
|
|
78
|
+
constructor(options, embedOptions, mount) {
|
|
66
79
|
this.options = options;
|
|
67
80
|
this.embedOptions = embedOptions;
|
|
81
|
+
this.mount = mount;
|
|
68
82
|
this.config = null;
|
|
69
83
|
this.bff = null;
|
|
70
84
|
this.stopped = false;
|
|
85
|
+
this.claimsBffPath = null;
|
|
71
86
|
/**
|
|
72
|
-
* The callback the agent registers
|
|
73
|
-
*
|
|
87
|
+
* The callback the agent registers under the mount prefix, handed requests already stripped of
|
|
88
|
+
* it: terminal, it never strips nor calls `next`. Answers 503 rather than falling through while
|
|
89
|
+
* the BFF is not serving: a 404 from the host would read as "wrong url" instead of "not
|
|
90
|
+
* available".
|
|
74
91
|
* Boot and shutdown are told apart, because a probe should wait on the first and drain on the
|
|
75
92
|
* second.
|
|
76
93
|
*/
|
|
@@ -78,21 +95,22 @@ class EmbeddedBff {
|
|
|
78
95
|
if (!this.bff) {
|
|
79
96
|
const type = this.stopped ? 'bff_stopped' : 'bff_not_started';
|
|
80
97
|
const message = this.stopped
|
|
81
|
-
?
|
|
82
|
-
:
|
|
98
|
+
? `${this.name} was stopped with the agent.`
|
|
99
|
+
: `${this.name} is not started yet.`;
|
|
83
100
|
res.statusCode = 503;
|
|
84
101
|
res.setHeader('Content-Type', 'application/json');
|
|
85
102
|
res.end(JSON.stringify({ error: { type, status: 503, message } }));
|
|
86
103
|
return;
|
|
87
104
|
}
|
|
88
|
-
// The BFF knows nothing of the prefix it is served under. `originalUrl` is claimed before the
|
|
89
|
-
// rewrite so a host logger reading it still reports the url the client asked for.
|
|
90
|
-
const bffReq = req;
|
|
91
|
-
bffReq.originalUrl ?? (bffReq.originalUrl = bffReq.url);
|
|
92
|
-
req.url = (0, bff_routes_1.stripBffPrefix)(req.url ?? bff_routes_1.BFF_PREFIX);
|
|
93
105
|
this.bff.callback(req, res);
|
|
94
106
|
};
|
|
95
107
|
}
|
|
108
|
+
get name() {
|
|
109
|
+
return this.mount.name ?? 'The embedded BFF';
|
|
110
|
+
}
|
|
111
|
+
log(message, context) {
|
|
112
|
+
return formatLog(this.mount.gateway ? '[Gateway API]' : '[BFF]', message, context);
|
|
113
|
+
}
|
|
96
114
|
/**
|
|
97
115
|
* Load the package and validate the options the caller handed to `addBff()`. Called before the
|
|
98
116
|
* agent mounts anything: everything checked here is caller input, and `parseConfig` throws on a
|
|
@@ -100,9 +118,12 @@ class EmbeddedBff {
|
|
|
100
118
|
* where failing after mount() would leave the host with a live `/forest` and a bricked `/bff`.
|
|
101
119
|
*/
|
|
102
120
|
async prepare() {
|
|
103
|
-
const
|
|
121
|
+
const bffPackage = await this.importPackage();
|
|
122
|
+
const { parseConfig, IN_PROCESS_AGENT_URL } = bffPackage;
|
|
104
123
|
const { embedOptions } = this;
|
|
105
|
-
this.
|
|
124
|
+
this.assertRequiredVersion(bffPackage.version);
|
|
125
|
+
this.claimsBffPath = bffPackage.claimsBffPath;
|
|
126
|
+
const env = {
|
|
106
127
|
FOREST_AUTH_SECRET: this.options.authSecret,
|
|
107
128
|
FOREST_ENV_SECRET: this.options.envSecret,
|
|
108
129
|
FOREST_SERVER_URL: this.options.forestServerUrl,
|
|
@@ -117,7 +138,20 @@ class EmbeddedBff {
|
|
|
117
138
|
// Off unless asked for: the document is not filtered per caller, so mounting a BFF must not
|
|
118
139
|
// publish the name of every exposed collection and field on an already-open port.
|
|
119
140
|
BFF_OPENAPI_ENABLED: String(embedOptions.openapiEnabled ?? false),
|
|
120
|
-
}
|
|
141
|
+
};
|
|
142
|
+
this.config = parseConfig(env, this.mount.gateway ? exports.GATEWAY_API_CONFIG_LABELS : undefined);
|
|
143
|
+
}
|
|
144
|
+
assertRequiredVersion(installed) {
|
|
145
|
+
const { requiredVersion } = this.mount;
|
|
146
|
+
if (!requiredVersion || installed === requiredVersion)
|
|
147
|
+
return;
|
|
148
|
+
throw new Error(`addGateway({ api }) requires ${BFF_PACKAGE} ${requiredVersion}, found ${installed}. ` +
|
|
149
|
+
`Install it with \`npm install ${BFF_PACKAGE}@${requiredVersion}\`.`);
|
|
150
|
+
}
|
|
151
|
+
claims(pathname) {
|
|
152
|
+
if (!this.claimsBffPath)
|
|
153
|
+
return false;
|
|
154
|
+
return this.claimsBffPath(pathname, { docs: this.embedOptions.openapiEnabled ?? false });
|
|
121
155
|
}
|
|
122
156
|
/**
|
|
123
157
|
* Build the BFF. Called from agent.start() after mount(), because the dispatcher only reaches the
|
|
@@ -133,7 +167,10 @@ class EmbeddedBff {
|
|
|
133
167
|
const bff = await buildBff({
|
|
134
168
|
config: this.config,
|
|
135
169
|
dispatcher,
|
|
136
|
-
basePath:
|
|
170
|
+
basePath: this.mount.prefix,
|
|
171
|
+
allowedOAuthClients: this.mount.allowedOAuthClients,
|
|
172
|
+
gatewayVersion: gateway_1.AGENT_VERSION,
|
|
173
|
+
...(this.mount.gateway ? { labels: exports.GATEWAY_API_CONFIG_LABELS, name: 'Gateway API' } : {}),
|
|
137
174
|
// Counters are the schema cache's and the action-endpoint resolver's only channel — they take
|
|
138
175
|
// no logger — and every one of them reports a failure, so they go to the host's logs. Gauges
|
|
139
176
|
// do not: they are periodic cache sizes, and the default console sink reports them at Info,
|
|
@@ -142,18 +179,19 @@ class EmbeddedBff {
|
|
|
142
179
|
// Tags carried through: `action_endpoint_error` and `action_endpoint_miss` name the
|
|
143
180
|
// rendering, collection and action that failed, which is the whole of what makes the line
|
|
144
181
|
// actionable — the metric name alone says only that something, somewhere, did not resolve.
|
|
145
|
-
increment: (name, tags) => this.options.logger('Warn',
|
|
182
|
+
increment: (name, tags) => this.options.logger('Warn', this.log(`metric ${name}`, tags)),
|
|
146
183
|
gauge: () => undefined,
|
|
147
184
|
},
|
|
148
|
-
logger: (level, message, context) => this.options.logger(level,
|
|
185
|
+
logger: (level, message, context) => this.options.logger(level, this.log(message, context)),
|
|
149
186
|
});
|
|
150
187
|
// stop() may have landed while buildBff() was in flight. Assigning anyway would resurrect a
|
|
151
188
|
// stopped agent's /bff — dispatching into the stack it just tore down instead of answering 503.
|
|
152
189
|
if (this.stopped)
|
|
153
190
|
return;
|
|
154
191
|
this.bff = bff;
|
|
155
|
-
this.options.logger('Info',
|
|
156
|
-
|
|
192
|
+
this.options.logger('Info', this.log(`${this.mount.name ?? 'Embedded BFF'} mounted on ${this.mount.prefix}`));
|
|
193
|
+
if (!this.mount.skipIpWhitelistWarning)
|
|
194
|
+
await this.warnIfExemptFromIpWhitelist();
|
|
157
195
|
}
|
|
158
196
|
/**
|
|
159
197
|
* The whitelist exempts a caller arriving over a loopback socket with no proxy hop, which is
|
|
@@ -173,13 +211,13 @@ class EmbeddedBff {
|
|
|
173
211
|
const { isFeatureEnabled } = await this.options.forestAdminClient.getIpWhitelistConfiguration();
|
|
174
212
|
if (!isFeatureEnabled)
|
|
175
213
|
return;
|
|
176
|
-
this.options.logger('Warn',
|
|
177
|
-
`${
|
|
214
|
+
this.options.logger('Warn', this.log(`The IP whitelist is enabled for this environment, but requests served under ` +
|
|
215
|
+
`${this.mount.prefix} are not subject to it: they reach the agent in-process, which the ` +
|
|
178
216
|
`whitelist exempts as a trusted loopback caller. A resolved API key or a valid OAuth ` +
|
|
179
217
|
`session is still required.`));
|
|
180
218
|
}
|
|
181
219
|
catch (error) {
|
|
182
|
-
this.options.logger('Debug',
|
|
220
|
+
this.options.logger('Debug', this.log('Could not read the IP whitelist configuration', {
|
|
183
221
|
cause: error instanceof Error ? error.message : String(error),
|
|
184
222
|
}));
|
|
185
223
|
}
|
|
@@ -210,7 +248,7 @@ class EmbeddedBff {
|
|
|
210
248
|
const unfinished = await bff.drainActivityLogs(timeoutMs);
|
|
211
249
|
if (unfinished.length === 0)
|
|
212
250
|
return;
|
|
213
|
-
this.options.logger('Warn',
|
|
251
|
+
this.options.logger('Warn', this.log(`Stopped ${this.mount.gateway ? 'the Gateway API' : 'the embedded BFF'} with activity logs still in flight`, {
|
|
214
252
|
timeoutMs,
|
|
215
253
|
unfinished,
|
|
216
254
|
}));
|
|
@@ -228,7 +266,7 @@ class EmbeddedBff {
|
|
|
228
266
|
// also fires on a broken transitive dependency, a SyntaxError from a partial install, or a
|
|
229
267
|
// throw during the package's own evaluation — none of which "install it" would fix.
|
|
230
268
|
const { message } = error;
|
|
231
|
-
const wrapped = new Error(
|
|
269
|
+
const wrapped = new Error(`${this.name} requires the \`@forestadmin/agent-bff\` package, which failed to ` +
|
|
232
270
|
`load: ${message}. Install it with \`npm install @forestadmin/agent-bff\`.`);
|
|
233
271
|
// Assigned rather than passed to the constructor: the repo targets ES2020, whose lib types no
|
|
234
272
|
// options bag on Error. A plain assignment carries the cause on every runtime, and the reason
|
|
@@ -239,4 +277,4 @@ class EmbeddedBff {
|
|
|
239
277
|
}
|
|
240
278
|
}
|
|
241
279
|
exports.default = EmbeddedBff;
|
|
242
|
-
//# sourceMappingURL=data:application/json;base64,
|
|
280
|
+
//# sourceMappingURL=data:application/json;base64,{"version":3,"file":"embedded-bff.js","sourceRoot":"","sources":["../src/embedded-bff.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AASA,uCAA0C;AAE1C,MAAM,WAAW,GAAG,wBAAwB,CAAC;AAEhC,QAAA,yBAAyB,GAAiB;IACrD,kBAAkB,EAAE,YAAY;IAChC,iBAAiB,EAAE,WAAW;IAC9B,iBAAiB,EAAE,iBAAiB;IACpC,cAAc,EAAE,cAAc;IAC9B,wBAAwB,EAAE,wBAAwB;IAClD,mBAAmB,EAAE,oBAAoB;IACzC,oBAAoB,EAAE,qBAAqB;IAC3C,oBAAoB,EAAE,oBAAoB;IAC1C,iBAAiB,EAAE,iBAAiB;IACpC,mBAAmB,EAAE,oBAAoB;CAC1C,CAAC;AAWF,+EAA+E;AAClE,QAAA,mBAAmB,GAAG,KAAM,CAAC;AAE1C;;;;;GAKG;AACH,SAAS,SAAS,CAAC,GAAW,EAAE,OAAe,EAAE,OAAiC;IAChF,IAAI,CAAC,OAAO,IAAI,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,GAAG,GAAG,IAAI,OAAO,EAAE,CAAC;IAE9E,IAAI,CAAC;QACH,MAAM,UAAU,GAAG,IAAI,CAAC,SAAS,CAAC,OAAO,EAAE,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CACzD,KAAK,YAAY,KAAK;YACpB,CAAC,CAAC,EAAE,IAAI,EAAE,KAAK,CAAC,IAAI,EAAE,OAAO,EAAE,KAAK,CAAC,OAAO,EAAE,KAAK,EAAE,KAAK,CAAC,KAAK,EAAE;YAClE,CAAC,CAAC,KAAK,CACV,CAAC;QAEF,OAAO,GAAG,GAAG,IAAI,OAAO,IAAI,UAAU,EAAE,CAAC;IAC3C,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,GAAG,GAAG,IAAI,OAAO,2BAA2B,CAAC;IACtD,CAAC;AACH,CAAC;AAED;;;;GAIG;AACH,MAAqB,WAAW;IAM9B,YACmB,OAAiC,EACjC,YAA6B,EAC7B,KAAuB;QAFvB,YAAO,GAAP,OAAO,CAA0B;QACjC,iBAAY,GAAZ,YAAY,CAAiB;QAC7B,UAAK,GAAL,KAAK,CAAkB;QARlC,WAAM,GAAqB,IAAI,CAAC;QAChC,QAAG,GAAe,IAAI,CAAC;QACvB,YAAO,GAAG,KAAK,CAAC;QAChB,kBAAa,GAAgC,IAAI,CAAC;QAsM1D;;;;;;;WAOG;QACM,WAAM,GAAiB,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE;YAC3C,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC;gBACd,MAAM,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,iBAAiB,CAAC;gBAC9D,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO;oBAC1B,CAAC,CAAC,GAAG,IAAI,CAAC,IAAI,8BAA8B;oBAC5C,CAAC,CAAC,GAAG,IAAI,CAAC,IAAI,sBAAsB,CAAC;gBAEvC,GAAG,CAAC,UAAU,GAAG,GAAG,CAAC;gBACrB,GAAG,CAAC,SAAS,CAAC,cAAc,EAAE,kBAAkB,CAAC,CAAC;gBAClD,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,KAAK,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,EAAE,OAAO,EAAE,EAAE,CAAC,CAAC,CAAC;gBAEnE,OAAO;YACT,CAAC;YAED,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;QAC9B,CAAC,CAAC;IAvNC,CAAC;IAEJ,IAAY,IAAI;QACd,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,IAAI,kBAAkB,CAAC;IAC/C,CAAC;IAEO,GAAG,CAAC,OAAe,EAAE,OAAiC;QAC5D,OAAO,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,eAAe,CAAC,CAAC,CAAC,OAAO,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;IACrF,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,OAAO;QACX,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,aAAa,EAAE,CAAC;QAC9C,MAAM,EAAE,WAAW,EAAE,oBAAoB,EAAE,GAAG,UAAU,CAAC;QACzD,MAAM,EAAE,YAAY,EAAE,GAAG,IAAI,CAAC;QAE9B,IAAI,CAAC,qBAAqB,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;QAC/C,IAAI,CAAC,aAAa,GAAG,UAAU,CAAC,aAAa,CAAC;QAE9C,MAAM,GAAG,GAAsB;YAC7B,kBAAkB,EAAE,IAAI,CAAC,OAAO,CAAC,UAAU;YAC3C,iBAAiB,EAAE,IAAI,CAAC,OAAO,CAAC,SAAS;YACzC,iBAAiB,EAAE,IAAI,CAAC,OAAO,CAAC,eAAe;YAC/C,cAAc,EAAE,IAAI,CAAC,OAAO,CAAC,YAAY;YACzC,2FAA2F;YAC3F,SAAS,EAAE,oBAAoB;YAC/B,wBAAwB,EAAE,YAAY,CAAC,kBAAkB;YACzD,mBAAmB,EAAE,YAAY,CAAC,cAAc,EAAE,IAAI,CAAC,GAAG,CAAC;YAC3D,oBAAoB,EAAE,YAAY,CAAC,eAAe;YAClD,oBAAoB,EAAE,YAAY,CAAC,cAAc,EAAE,QAAQ,EAAE;YAC7D,iBAAiB,EAAE,YAAY,CAAC,WAAW,EAAE,QAAQ,EAAE;YACvD,4FAA4F;YAC5F,kFAAkF;YAClF,mBAAmB,EAAE,MAAM,CAAC,YAAY,CAAC,cAAc,IAAI,KAAK,CAAC;SAClE,CAAC;QAEF,IAAI,CAAC,MAAM,GAAG,WAAW,CAAC,GAAG,EAAE,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,iCAAyB,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;IAC7F,CAAC;IAEO,qBAAqB,CAAC,SAAiB;QAC7C,MAAM,EAAE,eAAe,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC;QAEvC,IAAI,CAAC,eAAe,IAAI,SAAS,KAAK,eAAe;YAAE,OAAO;QAE9D,MAAM,IAAI,KAAK,CACb,gCAAgC,WAAW,IAAI,eAAe,WAAW,SAAS,IAAI;YACpF,iCAAiC,WAAW,IAAI,eAAe,KAAK,CACvE,CAAC;IACJ,CAAC;IAED,MAAM,CAAC,QAAgB;QACrB,IAAI,CAAC,IAAI,CAAC,aAAa;YAAE,OAAO,KAAK,CAAC;QAEtC,OAAO,IAAI,CAAC,aAAa,CAAC,QAAQ,EAAE,EAAE,IAAI,EAAE,IAAI,CAAC,YAAY,CAAC,cAAc,IAAI,KAAK,EAAE,CAAC,CAAC;IAC3F,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,KAAK,CAAC,UAA2B;QACrC,IAAI,CAAC,IAAI,CAAC,MAAM;YAAE,MAAM,IAAI,CAAC,OAAO,EAAE,CAAC;QAEvC,gGAAgG;QAChG,kGAAkG;QAClG,IAAI,CAAC,OAAO,GAAG,KAAK,CAAC;QAErB,MAAM,EAAE,QAAQ,EAAE,GAAG,MAAM,IAAI,CAAC,aAAa,EAAE,CAAC;QAEhD,MAAM,GAAG,GAAG,MAAM,QAAQ,CAAC;YACzB,MAAM,EAAE,IAAI,CAAC,MAAmB;YAChC,UAAU;YACV,QAAQ,EAAE,IAAI,CAAC,KAAK,CAAC,MAAM;YAC3B,mBAAmB,EAAE,IAAI,CAAC,KAAK,CAAC,mBAAmB;YACnD,cAAc,EAAE,uBAAa;YAC7B,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,iCAAyB,EAAE,IAAI,EAAE,aAAa,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;YACzF,8FAA8F;YAC9F,6FAA6F;YAC7F,4FAA4F;YAC5F,sDAAsD;YACtD,OAAO,EAAE;gBACP,oFAAoF;gBACpF,0FAA0F;gBAC1F,2FAA2F;gBAC3F,SAAS,EAAE,CAAC,IAAI,EAAE,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,GAAG,CAAC,UAAU,IAAI,EAAE,EAAE,IAAI,CAAC,CAAC;gBACxF,KAAK,EAAE,GAAG,EAAE,CAAC,SAAS;aACvB;YACD,MAAM,EAAE,CAAC,KAAK,EAAE,OAAO,EAAE,OAAO,EAAE,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,EAAE,IAAI,CAAC,GAAG,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;SAC5F,CAAC,CAAC;QAEH,4FAA4F;QAC5F,gGAAgG;QAChG,IAAI,IAAI,CAAC,OAAO;YAAE,OAAO;QAEzB,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;QAEf,IAAI,CAAC,OAAO,CAAC,MAAM,CACjB,MAAM,EACN,IAAI,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,IAAI,cAAc,eAAe,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC,CACjF,CAAC;QAEF,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,sBAAsB;YAAE,MAAM,IAAI,CAAC,2BAA2B,EAAE,CAAC;IACnF,CAAC;IAED;;;;;;;;;;;;OAYG;IACK,KAAK,CAAC,2BAA2B;QACvC,IAAI,CAAC;YACH,MAAM,EAAE,gBAAgB,EAAE,GACxB,MAAM,IAAI,CAAC,OAAO,CAAC,iBAAiB,CAAC,2BAA2B,EAAE,CAAC;YAErE,IAAI,CAAC,gBAAgB;gBAAE,OAAO;YAE9B,IAAI,CAAC,OAAO,CAAC,MAAM,CACjB,MAAM,EACN,IAAI,CAAC,GAAG,CACN,8EAA8E;gBAC5E,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,qEAAqE;gBACzF,sFAAsF;gBACtF,4BAA4B,CAC/B,CACF,CAAC;QACJ,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,IAAI,CAAC,OAAO,CAAC,MAAM,CACjB,OAAO,EACP,IAAI,CAAC,GAAG,CAAC,+CAA+C,EAAE;gBACxD,KAAK,EAAE,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC;aAC9D,CAAC,CACH,CAAC;QACJ,CAAC;IACH,CAAC;IAED,+FAA+F;IAC/F,UAAU;QACR,IAAI,CAAC,GAAG,EAAE,UAAU,EAAE,CAAC;IACzB,CAAC;IAED;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,IAAI;QACR,MAAM,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC;QAErB,IAAI,CAAC,GAAG,GAAG,IAAI,CAAC;QAChB,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC;QAEpB,IAAI,CAAC,GAAG,EAAE,iBAAiB;YAAE,OAAO;QAEpC,MAAM,SAAS,GAAG,IAAI,CAAC,YAAY,CAAC,iBAAiB,IAAI,2BAAmB,CAAC;QAC7E,MAAM,UAAU,GAAG,MAAM,GAAG,CAAC,iBAAiB,CAAC,SAAS,CAAC,CAAC;QAE1D,IAAI,UAAU,CAAC,MAAM,KAAK,CAAC;YAAE,OAAO;QAEpC,IAAI,CAAC,OAAO,CAAC,MAAM,CACjB,MAAM,EACN,IAAI,CAAC,GAAG,CACN,WACE,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,iBAAiB,CAAC,CAAC,CAAC,kBAC3C,qCAAqC,EACrC;YACE,SAAS;YACT,UAAU;SACX,CACF,CACF,CAAC;IACJ,CAAC;IA2BD;;;OAGG;IACK,KAAK,CAAC,aAAa;QACzB,IAAI,CAAC;YACH,OAAO,wDAAa,wBAAwB,GAAC,CAAC;QAChD,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,8FAA8F;YAC9F,2FAA2F;YAC3F,oFAAoF;YACpF,MAAM,EAAE,OAAO,EAAE,GAAG,KAAc,CAAC;YACnC,MAAM,OAAO,GAAG,IAAI,KAAK,CACvB,GAAG,IAAI,CAAC,IAAI,oEAAoE;gBAC9E,SAAS,OAAO,2DAA2D,CAC9E,CAAC;YACF,8FAA8F;YAC9F,8FAA8F;YAC9F,iDAAiD;YAChD,OAAuC,CAAC,KAAK,GAAG,KAAK,CAAC;YAEvD,MAAM,OAAO,CAAC;QAChB,CAAC;IACH,CAAC;CACF;AA3PD,8BA2PC"}
|
|
@@ -15,7 +15,7 @@ export default class FrameworkMounter {
|
|
|
15
15
|
private readonly inProcessDispatcher;
|
|
16
16
|
private inProcessHookRegistered;
|
|
17
17
|
/** Compute the prefix that the main router should be mounted at in the client's application */
|
|
18
|
-
|
|
18
|
+
protected get completeMountPrefix(): string;
|
|
19
19
|
constructor(prefix: string, logger: Logger);
|
|
20
20
|
/**
|
|
21
21
|
* Register the MCP server at the root of the host application, or `null` to unregister it. The
|
|
@@ -24,6 +24,7 @@ export default class FrameworkMounter {
|
|
|
24
24
|
*/
|
|
25
25
|
protected setMcpCallback(handler: RootHandler | null): void;
|
|
26
26
|
/** Serve an embedded BFF at `/bff`. Pass null to stop answering there. */
|
|
27
|
+
protected setGatewayCallback(handler: RootHandler): void;
|
|
27
28
|
protected setBffCallback(callback: HttpCallback | null): void;
|
|
28
29
|
/**
|
|
29
30
|
* Dispatcher that runs agent-client requests against the agent's own `/forest` stack in-memory.
|
|
@@ -36,6 +36,9 @@ class FrameworkMounter {
|
|
|
36
36
|
this.rootMiddleware.set('mcp', handler);
|
|
37
37
|
}
|
|
38
38
|
/** Serve an embedded BFF at `/bff`. Pass null to stop answering there. */
|
|
39
|
+
setGatewayCallback(handler) {
|
|
40
|
+
this.rootMiddleware.set('gateway', handler);
|
|
41
|
+
}
|
|
39
42
|
setBffCallback(callback) {
|
|
40
43
|
this.rootMiddleware.set('bff', callback && { callback, matches: bff_routes_1.isBffRoute });
|
|
41
44
|
}
|
|
@@ -208,4 +211,4 @@ class FrameworkMounter {
|
|
|
208
211
|
}
|
|
209
212
|
}
|
|
210
213
|
exports.default = FrameworkMounter;
|
|
211
|
-
//# sourceMappingURL=data:application/json;base64,
|
|
214
|
+
//# 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,IAAc,mBAAmB;QAC/B,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,kBAAkB,CAAC,OAAoB;QAC/C,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;IAC9C,CAAC;IAES,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;AAvPD,mCAuPC"}
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
import type { BffEmbedOptions, GatewayOptions, McpEmbedOptions, RootHandler } from './types';
|
|
2
|
+
export declare const AGENT_BFF_PEER_VERSION: string;
|
|
3
|
+
export declare const AGENT_VERSION: string;
|
|
4
|
+
declare const MCP_UNAVAILABLE: {
|
|
5
|
+
starting: string;
|
|
6
|
+
stopped: string;
|
|
7
|
+
};
|
|
8
|
+
export declare function mcpUnavailable(isMcpRoute: (url: string) => boolean, state: keyof typeof MCP_UNAVAILABLE): RootHandler;
|
|
9
|
+
export type GatewayMcpOptions = Omit<McpEmbedOptions, 'basePath' | 'allowedOAuthClients'>;
|
|
10
|
+
export type GatewayServices = {
|
|
11
|
+
mcp: GatewayMcpOptions | null;
|
|
12
|
+
api: BffEmbedOptions | null;
|
|
13
|
+
};
|
|
14
|
+
export declare function resolveGatewayServices({ mcp, api }: GatewayOptions): GatewayServices;
|
|
15
|
+
export declare function assertNoGatewayOverlap(basePath: string, forestPath: string, { mcp, api }: GatewayServices): void;
|
|
16
|
+
export declare function servesOAuth({ mcp, api }: GatewayServices): boolean;
|
|
17
|
+
export declare function describeGatewayRoutes(basePath: string, { mcp, api }: GatewayServices): string[];
|
|
18
|
+
export {};
|
|
19
|
+
//# sourceMappingURL=gateway.d.ts.map
|