@forestadmin/agent-bff 1.20.2 → 1.21.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/README.md +24 -3
- package/dist/data/agent-query.d.ts +4 -0
- package/dist/data/agent-query.js +53 -41
- package/dist/data/request-schemas.d.ts +49 -0
- package/dist/data/request-schemas.js +40 -0
- package/dist/openapi/schemas.d.ts +10 -0
- package/dist/openapi/schemas.js +37 -19
- package/dist/openapi/zod-openapi.d.ts +1 -2
- package/dist/openapi/zod-openapi.js +5 -4
- package/dist/zod.d.ts +3 -0
- package/dist/zod.js +11 -0
- package/package.json +3 -1
package/README.md
CHANGED
|
@@ -6,7 +6,28 @@ agent from a browser without learning MCP or JSON:API.
|
|
|
6
6
|
It is a bootable Koa 3 server with a `/health` endpoint, a version header, env-driven config
|
|
7
7
|
validation, OAuth (Mode 1) + API-key (Mode 2) auth, and a hardened request edge (timezone, CORS,
|
|
8
8
|
auth-mode precedence, structured error contract), and it serves and exports its own OpenAPI
|
|
9
|
-
document.
|
|
9
|
+
document.
|
|
10
|
+
|
|
11
|
+
## The routes it serves
|
|
12
|
+
|
|
13
|
+
Everything the agent proxy exposes lives under `/agent/v1`. The data and action routes are `POST`
|
|
14
|
+
— the filter, projection and paging all travel in the body, never in the query string:
|
|
15
|
+
|
|
16
|
+
| Route | Method | What it does |
|
|
17
|
+
| --- | --- | --- |
|
|
18
|
+
| `/agent/v1/{collection}/list` · `/count` | `POST` | list or count records of a collection |
|
|
19
|
+
| `/agent/v1/{collection}/relations/{relation}/list` · `/count` | `POST` | same, through a **to-many** relation — to-one relations are not listable and 404 by design |
|
|
20
|
+
| `/agent/v1/{collection}/actions/{action}/form` · `/execute` | `POST` | load a Smart Action's form, then run it |
|
|
21
|
+
| `/agent/v1/permissions` | `GET` | what the caller may see and do, **as display hints** for graying out UI — never an authorization decision |
|
|
22
|
+
| `/agent/openapi.json` | `GET`/`HEAD` | the unfolded document, auth-gated, when `BFF_OPENAPI_ENABLED` is on |
|
|
23
|
+
|
|
24
|
+
`/health` and `/oauth/*` sit outside the prefix and outside the auth edge.
|
|
25
|
+
|
|
26
|
+
**The agent enforces permissions and scopes, not the BFF.** Each proxied call carries a
|
|
27
|
+
short-lived agent token the BFF mints for the caller, so a request reaches the agent as that
|
|
28
|
+
person and comes back filtered exactly as it would for them in Forest. A collection the current
|
|
29
|
+
schema no longer exposes is re-checked on every call, so a schema refresh can never leave a
|
|
30
|
+
dropped collection reachable.
|
|
10
31
|
|
|
11
32
|
## Usage
|
|
12
33
|
|
|
@@ -66,7 +87,7 @@ yarn start:dev # node --env-file=.env dist/cli.js
|
|
|
66
87
|
| `FOREST_AUTH_SECRET` | yes | Agent JWT signing secret (never logged or echoed). |
|
|
67
88
|
| `FOREST_ENV_SECRET` | yes | Forest SaaS environment secret (`forest-secret-key`), server-to-server. |
|
|
68
89
|
| `FOREST_SERVER_URL` | yes | Forest SaaS API base URL. |
|
|
69
|
-
| `FOREST_APP_URL` | yes | Forest front base URL
|
|
90
|
+
| `FOREST_APP_URL` | yes | Forest front base URL, used to build the OAuth front-channel redirect (`src/oauth/oauth-routes.ts`). |
|
|
70
91
|
| `AGENT_URL` | yes | The customer agent base URL the BFF calls via agent-client. |
|
|
71
92
|
| `BFF_TOKEN_ENCRYPTION_KEY`| for OAuth | Base64-encoded 32-byte AES-256 key encrypting stored refresh tokens. Until it is set, the `/oauth/*` token-issuance routes are disabled and `/health` reports `degraded`; already-issued `bff_access` tokens still authenticate on `/agent/*` whenever `FOREST_AUTH_SECRET` is present. |
|
|
72
93
|
| `HTTP_PORT` | no | Server port, integer 0–65535. Defaults to `3450`. `0` binds an OS-assigned ephemeral port. |
|
|
@@ -87,7 +108,7 @@ yarn start:dev # node --env-file=.env dist/cli.js
|
|
|
87
108
|
## Request edge (`/agent/*`)
|
|
88
109
|
|
|
89
110
|
Every agent call flows through a request edge that enforces three cross-cutting concerns before the
|
|
90
|
-
|
|
111
|
+
call is proxied to the agent. Errors use a structured, type-first contract — `{ error: { type, status,
|
|
91
112
|
message, details? } }` — so consumers branch on `error.type`, never on message text.
|
|
92
113
|
|
|
93
114
|
### Auth-mode precedence
|
|
@@ -13,9 +13,13 @@ export interface ListRequestBody {
|
|
|
13
13
|
projection?: string[];
|
|
14
14
|
sort?: BffSortClause[];
|
|
15
15
|
page?: BffPage;
|
|
16
|
+
search?: string;
|
|
17
|
+
searchExtended?: boolean;
|
|
16
18
|
}
|
|
17
19
|
export interface CountRequestBody {
|
|
18
20
|
filter?: unknown;
|
|
21
|
+
search?: string;
|
|
22
|
+
searchExtended?: boolean;
|
|
19
23
|
}
|
|
20
24
|
export type RelationListRequestBody = ListRequestBody & {
|
|
21
25
|
parentId: string;
|
package/dist/data/agent-query.js
CHANGED
|
@@ -10,6 +10,7 @@ exports.parseParentId = parseParentId;
|
|
|
10
10
|
exports.parseRelationListRequest = parseRelationListRequest;
|
|
11
11
|
exports.parseRelationCountRequest = parseRelationCountRequest;
|
|
12
12
|
exports.collectCountFieldPaths = collectCountFieldPaths;
|
|
13
|
+
const request_schemas_1 = require("./request-schemas");
|
|
13
14
|
const bff_local_errors_1 = require("../http/bff-local-errors");
|
|
14
15
|
const capabilities_validator_1 = require("../validation/capabilities-validator");
|
|
15
16
|
Object.defineProperty(exports, "MAX_PARSED_FILTER_DEPTH", { enumerable: true, get: function () { return capabilities_validator_1.MAX_FILTER_DEPTH; } });
|
|
@@ -30,54 +31,41 @@ function assertNoNodeReadableAsBothLeafAndBranch(node, depth = 0) {
|
|
|
30
31
|
node.conditions.forEach(condition => assertNoNodeReadableAsBothLeafAndBranch(condition, depth + 1));
|
|
31
32
|
}
|
|
32
33
|
}
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
34
|
+
/**
|
|
35
|
+
* Checks the flat inputs against the shared schema and reports the first failure as
|
|
36
|
+
* 400 invalid_request, so a malformed shape (`projection` as a string, a fractional `page.limit`)
|
|
37
|
+
* surfaces as a client error rather than a 500 from an array method blowing up downstream.
|
|
38
|
+
*
|
|
39
|
+
* Unknown keys are left alone: the object schemas ignore them, so `filter`, `timezone` and
|
|
40
|
+
* `parentId` travel through untouched and the body is returned by reference, not rebuilt.
|
|
41
|
+
*/
|
|
42
|
+
function assertFlatInputs(schema, body) {
|
|
43
|
+
const result = schema.safeParse(body);
|
|
44
|
+
if (result.success)
|
|
45
|
+
return;
|
|
46
|
+
const [issue] = result.error.issues;
|
|
47
|
+
const path = issue.path.join('.');
|
|
48
|
+
throw (0, bff_local_errors_1.invalidRequest)(path ? `${path}: ${issue.message}` : issue.message);
|
|
49
|
+
}
|
|
50
|
+
function assertFilter(filter) {
|
|
51
|
+
if (filter === undefined)
|
|
52
|
+
return;
|
|
53
|
+
if (!isPlainObject(filter))
|
|
54
|
+
throw (0, bff_local_errors_1.invalidRequest)('filter must be an object');
|
|
55
|
+
assertNoNodeReadableAsBothLeafAndBranch(filter);
|
|
56
|
+
}
|
|
36
57
|
function parseListRequest(body) {
|
|
37
58
|
if (!isPlainObject(body))
|
|
38
59
|
throw (0, bff_local_errors_1.invalidRequest)('Request body must be an object');
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
if (!Array.isArray(projection) || projection.some(field => typeof field !== 'string')) {
|
|
42
|
-
throw (0, bff_local_errors_1.invalidRequest)('projection must be an array of field names');
|
|
43
|
-
}
|
|
44
|
-
}
|
|
45
|
-
if (sort !== undefined) {
|
|
46
|
-
const valid = Array.isArray(sort) &&
|
|
47
|
-
sort.every(clause => isPlainObject(clause) &&
|
|
48
|
-
typeof clause.field === 'string' &&
|
|
49
|
-
(clause.direction === undefined ||
|
|
50
|
-
clause.direction === 'asc' ||
|
|
51
|
-
clause.direction === 'desc'));
|
|
52
|
-
if (!valid)
|
|
53
|
-
throw (0, bff_local_errors_1.invalidRequest)('sort must be an array of { field, direction? }');
|
|
54
|
-
}
|
|
55
|
-
if (filter !== undefined) {
|
|
56
|
-
if (!isPlainObject(filter))
|
|
57
|
-
throw (0, bff_local_errors_1.invalidRequest)('filter must be an object');
|
|
58
|
-
assertNoNodeReadableAsBothLeafAndBranch(filter);
|
|
59
|
-
}
|
|
60
|
-
if (page !== undefined) {
|
|
61
|
-
if (!isPlainObject(page)) {
|
|
62
|
-
throw (0, bff_local_errors_1.invalidRequest)('page must be an object with limit and offset');
|
|
63
|
-
}
|
|
64
|
-
if (!Number.isInteger(page.limit) || page.limit <= 0) {
|
|
65
|
-
throw (0, bff_local_errors_1.invalidRequest)('page.limit must be a positive integer');
|
|
66
|
-
}
|
|
67
|
-
if (!Number.isInteger(page.offset) || page.offset < 0) {
|
|
68
|
-
throw (0, bff_local_errors_1.invalidRequest)('page.offset must be a non-negative integer');
|
|
69
|
-
}
|
|
70
|
-
}
|
|
60
|
+
assertFlatInputs(request_schemas_1.ListFlatInputs, body);
|
|
61
|
+
assertFilter(body.filter);
|
|
71
62
|
return body;
|
|
72
63
|
}
|
|
73
64
|
function parseCountRequest(body) {
|
|
74
65
|
if (!isPlainObject(body))
|
|
75
66
|
throw (0, bff_local_errors_1.invalidRequest)('Request body must be an object');
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
throw (0, bff_local_errors_1.invalidRequest)('filter must be an object');
|
|
79
|
-
assertNoNodeReadableAsBothLeafAndBranch(body.filter);
|
|
80
|
-
}
|
|
67
|
+
assertFlatInputs(request_schemas_1.CountFlatInputs, body);
|
|
68
|
+
assertFilter(body.filter);
|
|
81
69
|
return body;
|
|
82
70
|
}
|
|
83
71
|
function collectFilterFields(filter, acc) {
|
|
@@ -101,6 +89,28 @@ function serializePage(page) {
|
|
|
101
89
|
}
|
|
102
90
|
return { 'page[size]': limit, 'page[number]': offset / limit + 1 };
|
|
103
91
|
}
|
|
92
|
+
/**
|
|
93
|
+
* `search` and `searchExtended` are the wire names the agent reads; no other spelling is parsed.
|
|
94
|
+
*
|
|
95
|
+
* A blank search is dropped rather than forwarded. The agent's search decorator already treats it
|
|
96
|
+
* as absent, but `parseSearch` guards on a truthy value, so a whitespace-only search would raise
|
|
97
|
+
* "Collection is not searchable" on a non-searchable collection while an empty one would not — a
|
|
98
|
+
* cleared search box must not depend on how many spaces it holds.
|
|
99
|
+
*
|
|
100
|
+
* `searchExtended` only ships alongside a real search: on its own it changes nothing agent-side,
|
|
101
|
+
* and emitting it would alter the outgoing query of every search-less request.
|
|
102
|
+
*
|
|
103
|
+
* The value is trimmed on the way out, not in the parser: parsing stays pure validation here, and
|
|
104
|
+
* `parseListRequest` returns the caller's body untouched, which its own callers rely on.
|
|
105
|
+
*/
|
|
106
|
+
function applySearch(query, body) {
|
|
107
|
+
const search = body.search?.trim();
|
|
108
|
+
if (!search)
|
|
109
|
+
return;
|
|
110
|
+
query.search = search;
|
|
111
|
+
if (body.searchExtended !== undefined)
|
|
112
|
+
query.searchExtended = body.searchExtended;
|
|
113
|
+
}
|
|
104
114
|
function buildListAgentQuery(collection, timezone, body) {
|
|
105
115
|
const query = { timezone };
|
|
106
116
|
if (body.filter !== undefined)
|
|
@@ -111,12 +121,14 @@ function buildListAgentQuery(collection, timezone, body) {
|
|
|
111
121
|
query.sort = serializeSort(body.sort);
|
|
112
122
|
if (body.page)
|
|
113
123
|
Object.assign(query, serializePage(body.page));
|
|
124
|
+
applySearch(query, body);
|
|
114
125
|
return query;
|
|
115
126
|
}
|
|
116
127
|
function buildCountAgentQuery(timezone, body) {
|
|
117
128
|
const query = { timezone };
|
|
118
129
|
if (body.filter !== undefined)
|
|
119
130
|
query.filters = JSON.stringify(body.filter);
|
|
131
|
+
applySearch(query, body);
|
|
120
132
|
return query;
|
|
121
133
|
}
|
|
122
134
|
function collectListFieldPaths(body) {
|
|
@@ -152,4 +164,4 @@ function collectCountFieldPaths(body) {
|
|
|
152
164
|
collectFilterFields(body.filter, paths);
|
|
153
165
|
return paths;
|
|
154
166
|
}
|
|
155
|
-
//# sourceMappingURL=data:application/json;base64,
|
|
167
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiYWdlbnQtcXVlcnkuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvZGF0YS9hZ2VudC1xdWVyeS50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7QUFzRkEsNENBT0M7QUFFRCw4Q0FPQztBQW9ERCxrREFjQztBQUVELG9EQU9DO0FBRUQsc0RBTUM7QUFLRCxzQ0FZQztBQUVELDREQUlDO0FBRUQsOERBSUM7QUFFRCx3REFLQztBQTNORCx1REFBb0U7QUFDcEUsK0RBQTBEO0FBQzFELGlGQUEwRjtBQUc3RCx3R0FIcEIseUNBQWdCLE9BRzJCO0FBRnBELHVFQUFnRTtBQW1DaEUsU0FBUyxhQUFhLENBQUMsS0FBYztJQUNuQyxPQUFPLE9BQU8sS0FBSyxLQUFLLFFBQVEsSUFBSSxLQUFLLEtBQUssSUFBSSxJQUFJLENBQUMsS0FBSyxDQUFDLE9BQU8sQ0FBQyxLQUFLLENBQUMsQ0FBQztBQUM5RSxDQUFDO0FBRUQsU0FBUyx1Q0FBdUMsQ0FBQyxJQUFhLEVBQUUsS0FBSyxHQUFHLENBQUM7SUFDdkUsSUFBSSxLQUFLLEdBQUcseUNBQWdCO1FBQUUsTUFBTSxJQUFBLGlDQUFhLEVBQUMseUNBQWdCLENBQUMsQ0FBQztJQUNwRSxJQUFJLE9BQU8sSUFBSSxLQUFLLFFBQVEsSUFBSSxJQUFJLEtBQUssSUFBSTtRQUFFLE9BQU87SUFFdEQsTUFBTSxnQkFBZ0IsR0FBRyxJQUFBLGlDQUFRLEVBQUMsSUFBSSxDQUFDLENBQUM7SUFFeEMsSUFBSSxJQUFBLCtCQUFNLEVBQUMsSUFBSSxDQUFDLElBQUksZ0JBQWdCLEVBQUUsQ0FBQztRQUNyQyxNQUFNLElBQUEsaUNBQWMsRUFBQywwREFBMEQsQ0FBQyxDQUFDO0lBQ25GLENBQUM7SUFFRCxJQUFJLGdCQUFnQixFQUFFLENBQUM7UUFDckIsSUFBSSxDQUFDLFVBQVUsQ0FBQyxPQUFPLENBQUMsU0FBUyxDQUFDLEVBQUUsQ0FDbEMsdUNBQXVDLENBQUMsU0FBUyxFQUFFLEtBQUssR0FBRyxDQUFDLENBQUMsQ0FDOUQsQ0FBQztJQUNKLENBQUM7QUFDSCxDQUFDO0FBRUQ7Ozs7Ozs7R0FPRztBQUNILFNBQVMsZ0JBQWdCLENBQUMsTUFBZSxFQUFFLElBQTZCO0lBQ3RFLE1BQU0sTUFBTSxHQUFHLE1BQU0sQ0FBQyxTQUFTLENBQUMsSUFBSSxDQUFDLENBQUM7SUFDdEMsSUFBSSxNQUFNLENBQUMsT0FBTztRQUFFLE9BQU87SUFFM0IsTUFBTSxDQUFDLEtBQUssQ0FBQyxHQUFHLE1BQU0sQ0FBQyxLQUFLLENBQUMsTUFBTSxDQUFDO0lBQ3BDLE1BQU0sSUFBSSxHQUFHLEtBQUssQ0FBQyxJQUFJLENBQUMsSUFBSSxDQUFDLEdBQUcsQ0FBQyxDQUFDO0lBRWxDLE1BQU0sSUFBQSxpQ0FBYyxFQUFDLElBQUksQ0FBQyxDQUFDLENBQUMsR0FBRyxJQUFJLEtBQUssS0FBSyxDQUFDLE9BQU8sRUFBRSxDQUFDLENBQUMsQ0FBQyxLQUFLLENBQUMsT0FBTyxDQUFDLENBQUM7QUFDM0UsQ0FBQztBQUVELFNBQVMsWUFBWSxDQUFDLE1BQWU7SUFDbkMsSUFBSSxNQUFNLEtBQUssU0FBUztRQUFFLE9BQU87SUFDakMsSUFBSSxDQUFDLGFBQWEsQ0FBQyxNQUFNLENBQUM7UUFBRSxNQUFNLElBQUEsaUNBQWMsRUFBQywwQkFBMEIsQ0FBQyxDQUFDO0lBRTdFLHVDQUF1QyxDQUFDLE1BQU0sQ0FBQyxDQUFDO0FBQ2xELENBQUM7QUFFRCxTQUFnQixnQkFBZ0IsQ0FBQyxJQUFhO0lBQzVDLElBQUksQ0FBQyxhQUFhLENBQUMsSUFBSSxDQUFDO1FBQUUsTUFBTSxJQUFBLGlDQUFjLEVBQUMsZ0NBQWdDLENBQUMsQ0FBQztJQUVqRixnQkFBZ0IsQ0FBQyxnQ0FBYyxFQUFFLElBQUksQ0FBQyxDQUFDO0lBQ3ZDLFlBQVksQ0FBQyxJQUFJLENBQUMsTUFBTSxDQUFDLENBQUM7SUFFMUIsT0FBTyxJQUF1QixDQUFDO0FBQ2pDLENBQUM7QUFFRCxTQUFnQixpQkFBaUIsQ0FBQyxJQUFhO0lBQzdDLElBQUksQ0FBQyxhQUFhLENBQUMsSUFBSSxDQUFDO1FBQUUsTUFBTSxJQUFBLGlDQUFjLEVBQUMsZ0NBQWdDLENBQUMsQ0FBQztJQUVqRixnQkFBZ0IsQ0FBQyxpQ0FBZSxFQUFFLElBQUksQ0FBQyxDQUFDO0lBQ3hDLFlBQVksQ0FBQyxJQUFJLENBQUMsTUFBTSxDQUFDLENBQUM7SUFFMUIsT0FBTyxJQUF3QixDQUFDO0FBQ2xDLENBQUM7QUFFRCxTQUFTLG1CQUFtQixDQUFDLE1BQWUsRUFBRSxHQUFhO0lBQ3pELElBQUksSUFBQSxpQ0FBUSxFQUFDLE1BQU0sQ0FBQyxFQUFFLENBQUM7UUFDckIsTUFBTSxDQUFDLFVBQVUsQ0FBQyxPQUFPLENBQUMsU0FBUyxDQUFDLEVBQUUsQ0FBQyxtQkFBbUIsQ0FBQyxTQUFTLEVBQUUsR0FBRyxDQUFDLENBQUMsQ0FBQztJQUM5RSxDQUFDO1NBQU0sSUFBSSxJQUFBLCtCQUFNLEVBQUMsTUFBTSxDQUFDLEVBQUUsQ0FBQztRQUMxQixHQUFHLENBQUMsSUFBSSxDQUFDLE1BQU0sQ0FBQyxLQUFLLENBQUMsQ0FBQztJQUN6QixDQUFDO0FBQ0gsQ0FBQztBQUVELFNBQVMsYUFBYSxDQUFDLElBQXFCO0lBQzFDLE9BQU8sSUFBSSxDQUFDLEdBQUcsQ0FBQyxDQUFDLEVBQUUsS0FBSyxFQUFFLFNBQVMsRUFBRSxFQUFFLEVBQUUsQ0FBQyxDQUFDLFNBQVMsS0FBSyxNQUFNLENBQUMsQ0FBQyxDQUFDLElBQUksS0FBSyxFQUFFLENBQUMsQ0FBQyxDQUFDLEtBQUssQ0FBQyxDQUFDLENBQUMsSUFBSSxDQUFDLEdBQUcsQ0FBQyxDQUFDO0FBQ3BHLENBQUM7QUFFRCxtR0FBbUc7QUFDbkcsaUdBQWlHO0FBQ2pHLG1HQUFtRztBQUNuRyxTQUFTLGFBQWEsQ0FBQyxJQUFhO0lBQ2xDLE1BQU0sRUFBRSxLQUFLLEVBQUUsTUFBTSxFQUFFLEdBQUcsSUFBSSxDQUFDO0lBRS9CLElBQUksTUFBTSxHQUFHLEtBQUssS0FBSyxDQUFDLEVBQUUsQ0FBQztRQUN6QixNQUFNLElBQUEsaUNBQWMsRUFBQyxnQkFBZ0IsTUFBTSx1Q0FBdUMsS0FBSyxHQUFHLENBQUMsQ0FBQztJQUM5RixDQUFDO0lBRUQsT0FBTyxFQUFFLFlBQVksRUFBRSxLQUFLLEVBQUUsY0FBYyxFQUFFLE1BQU0sR0FBRyxLQUFLLEdBQUcsQ0FBQyxFQUFFLENBQUM7QUFDckUsQ0FBQztBQUVEOzs7Ozs7Ozs7Ozs7O0dBYUc7QUFDSCxTQUFTLFdBQVcsQ0FDbEIsS0FBaUIsRUFDakIsSUFBeUQ7SUFFekQsTUFBTSxNQUFNLEdBQUcsSUFBSSxDQUFDLE1BQU0sRUFBRSxJQUFJLEVBQUUsQ0FBQztJQUNuQyxJQUFJLENBQUMsTUFBTTtRQUFFLE9BQU87SUFFcEIsS0FBSyxDQUFDLE1BQU0sR0FBRyxNQUFNLENBQUM7SUFDdEIsSUFBSSxJQUFJLENBQUMsY0FBYyxLQUFLLFNBQVM7UUFBRSxLQUFLLENBQUMsY0FBYyxHQUFHLElBQUksQ0FBQyxjQUFjLENBQUM7QUFDcEYsQ0FBQztBQUVELFNBQWdCLG1CQUFtQixDQUNqQyxVQUFrQixFQUNsQixRQUFnQixFQUNoQixJQUFxQjtJQUVyQixNQUFNLEtBQUssR0FBZSxFQUFFLFFBQVEsRUFBRSxDQUFDO0lBRXZDLElBQUksSUFBSSxDQUFDLE1BQU0sS0FBSyxTQUFTO1FBQUUsS0FBSyxDQUFDLE9BQU8sR0FBRyxJQUFJLENBQUMsU0FBUyxDQUFDLElBQUksQ0FBQyxNQUFNLENBQUMsQ0FBQztJQUMzRSxJQUFJLElBQUksQ0FBQyxVQUFVLEVBQUUsTUFBTTtRQUFFLEtBQUssQ0FBQyxVQUFVLFVBQVUsR0FBRyxDQUFDLEdBQUcsSUFBSSxDQUFDLFVBQVUsQ0FBQyxJQUFJLENBQUMsR0FBRyxDQUFDLENBQUM7SUFDeEYsSUFBSSxJQUFJLENBQUMsSUFBSSxFQUFFLE1BQU07UUFBRSxLQUFLLENBQUMsSUFBSSxHQUFHLGFBQWEsQ0FBQyxJQUFJLENBQUMsSUFBSSxDQUFDLENBQUM7SUFDN0QsSUFBSSxJQUFJLENBQUMsSUFBSTtRQUFFLE1BQU0sQ0FBQyxNQUFNLENBQUMsS0FBSyxFQUFFLGFBQWEsQ0FBQyxJQUFJLENBQUMsSUFBSSxDQUFDLENBQUMsQ0FBQztJQUM5RCxXQUFXLENBQUMsS0FBSyxFQUFFLElBQUksQ0FBQyxDQUFDO0lBRXpCLE9BQU8sS0FBSyxDQUFDO0FBQ2YsQ0FBQztBQUVELFNBQWdCLG9CQUFvQixDQUFDLFFBQWdCLEVBQUUsSUFBc0I7SUFDM0UsTUFBTSxLQUFLLEdBQWUsRUFBRSxRQUFRLEVBQUUsQ0FBQztJQUV2QyxJQUFJLElBQUksQ0FBQyxNQUFNLEtBQUssU0FBUztRQUFFLEtBQUssQ0FBQyxPQUFPLEdBQUcsSUFBSSxDQUFDLFNBQVMsQ0FBQyxJQUFJLENBQUMsTUFBTSxDQUFDLENBQUM7SUFDM0UsV0FBVyxDQUFDLEtBQUssRUFBRSxJQUFJLENBQUMsQ0FBQztJQUV6QixPQUFPLEtBQUssQ0FBQztBQUNmLENBQUM7QUFFRCxTQUFnQixxQkFBcUIsQ0FBQyxJQUFxQjtJQUN6RCxNQUFNLEtBQUssR0FBYSxDQUFDLEdBQUcsQ0FBQyxJQUFJLENBQUMsVUFBVSxJQUFJLEVBQUUsQ0FBQyxDQUFDLENBQUM7SUFDckQsbUJBQW1CLENBQUMsSUFBSSxDQUFDLE1BQU0sRUFBRSxLQUFLLENBQUMsQ0FBQztJQUN4QyxDQUFDLElBQUksQ0FBQyxJQUFJLElBQUksRUFBRSxDQUFDLENBQUMsT0FBTyxDQUFDLENBQUMsRUFBRSxLQUFLLEVBQUUsRUFBRSxFQUFFLENBQUMsS0FBSyxDQUFDLElBQUksQ0FBQyxLQUFLLENBQUMsQ0FBQyxDQUFDO0lBRTVELE9BQU8sS0FBSyxDQUFDO0FBQ2YsQ0FBQztBQUVELGtHQUFrRztBQUNsRyw2RkFBNkY7QUFDN0YsMEVBQTBFO0FBQzFFLFNBQWdCLGFBQWEsQ0FBQyxRQUFpQjtJQUM3QyxJQUFJLE9BQU8sUUFBUSxLQUFLLFFBQVEsRUFBRSxDQUFDO1FBQ2pDLElBQUksUUFBUSxDQUFDLElBQUksRUFBRSxLQUFLLEVBQUU7WUFBRSxNQUFNLElBQUEsaUNBQWMsRUFBQyw0QkFBNEIsQ0FBQyxDQUFDO1FBRS9FLE9BQU8sUUFBUSxDQUFDO0lBQ2xCLENBQUM7SUFFRCxJQUFJLE9BQU8sUUFBUSxLQUFLLFFBQVEsSUFBSSxNQUFNLENBQUMsUUFBUSxDQUFDLFFBQVEsQ0FBQyxFQUFFLENBQUM7UUFDOUQsT0FBTyxNQUFNLENBQUMsUUFBUSxDQUFDLENBQUM7SUFDMUIsQ0FBQztJQUVELE1BQU0sSUFBQSxpQ0FBYyxFQUFDLGlFQUFpRSxDQUFDLENBQUM7QUFDMUYsQ0FBQztBQUVELFNBQWdCLHdCQUF3QixDQUFDLElBQWE7SUFDcEQsTUFBTSxRQUFRLEdBQUcsYUFBYSxDQUFFLElBQXNDLEVBQUUsUUFBUSxDQUFDLENBQUM7SUFFbEYsT0FBTyxFQUFFLEdBQUcsZ0JBQWdCLENBQUMsSUFBSSxDQUFDLEVBQUUsUUFBUSxFQUFFLENBQUM7QUFDakQsQ0FBQztBQUVELFNBQWdCLHlCQUF5QixDQUFDLElBQWE7SUFDckQsTUFBTSxRQUFRLEdBQUcsYUFBYSxDQUFFLElBQXNDLEVBQUUsUUFBUSxDQUFDLENBQUM7SUFFbEYsT0FBTyxFQUFFLEdBQUcsaUJBQWlCLENBQUMsSUFBSSxDQUFDLEVBQUUsUUFBUSxFQUFFLENBQUM7QUFDbEQsQ0FBQztBQUVELFNBQWdCLHNCQUFzQixDQUFDLElBQXNCO0lBQzNELE1BQU0sS0FBSyxHQUFhLEVBQUUsQ0FBQztJQUMzQixtQkFBbUIsQ0FBQyxJQUFJLENBQUMsTUFBTSxFQUFFLEtBQUssQ0FBQyxDQUFDO0lBRXhDLE9BQU8sS0FBSyxDQUFDO0FBQ2YsQ0FBQyJ9
|
|
@@ -0,0 +1,49 @@
|
|
|
1
|
+
import { z } from '../zod';
|
|
2
|
+
/**
|
|
3
|
+
* The validation rules of a request body, declared once. `src/openapi/schemas.ts` decorates these
|
|
4
|
+
* with names and descriptions to publish them, and the parsers below check bodies against them, so
|
|
5
|
+
* the document and the runtime cannot drift apart.
|
|
6
|
+
*
|
|
7
|
+
* `filter` is deliberately absent: its operators are checked against the collection capabilities
|
|
8
|
+
* (`capabilities-validator`), and a node readable as both leaf and branch has no schema equivalent,
|
|
9
|
+
* so it keeps its own path in `agent-query.ts`.
|
|
10
|
+
*/
|
|
11
|
+
export declare const SortClauseInput: z.ZodObject<{
|
|
12
|
+
field: z.ZodString;
|
|
13
|
+
direction: z.ZodOptional<z.ZodEnum<{
|
|
14
|
+
asc: "asc";
|
|
15
|
+
desc: "desc";
|
|
16
|
+
}>>;
|
|
17
|
+
}, z.core.$strip>;
|
|
18
|
+
export declare const PageInput: z.ZodObject<{
|
|
19
|
+
limit: z.ZodNumber;
|
|
20
|
+
offset: z.ZodNumber;
|
|
21
|
+
}, z.core.$strip>;
|
|
22
|
+
export declare const ProjectionInput: z.ZodArray<z.ZodString>;
|
|
23
|
+
export declare const SearchInput: z.ZodString;
|
|
24
|
+
export declare const SearchExtendedInput: z.ZodBoolean;
|
|
25
|
+
export declare const TimezoneInput: z.ZodString;
|
|
26
|
+
export declare const ParentIdInput: z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>;
|
|
27
|
+
/** Everything a list body carries except `filter`, which is validated separately. */
|
|
28
|
+
export declare const ListFlatInputs: z.ZodObject<{
|
|
29
|
+
projection: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
30
|
+
sort: z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
31
|
+
field: z.ZodString;
|
|
32
|
+
direction: z.ZodOptional<z.ZodEnum<{
|
|
33
|
+
asc: "asc";
|
|
34
|
+
desc: "desc";
|
|
35
|
+
}>>;
|
|
36
|
+
}, z.core.$strip>>>;
|
|
37
|
+
page: z.ZodOptional<z.ZodObject<{
|
|
38
|
+
limit: z.ZodNumber;
|
|
39
|
+
offset: z.ZodNumber;
|
|
40
|
+
}, z.core.$strip>>;
|
|
41
|
+
search: z.ZodOptional<z.ZodString>;
|
|
42
|
+
searchExtended: z.ZodOptional<z.ZodBoolean>;
|
|
43
|
+
}, z.core.$strip>;
|
|
44
|
+
/** A count body carries no projection, sort or page. */
|
|
45
|
+
export declare const CountFlatInputs: z.ZodObject<{
|
|
46
|
+
search: z.ZodOptional<z.ZodString>;
|
|
47
|
+
searchExtended: z.ZodOptional<z.ZodBoolean>;
|
|
48
|
+
}, z.core.$strip>;
|
|
49
|
+
//# sourceMappingURL=request-schemas.d.ts.map
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.CountFlatInputs = exports.ListFlatInputs = exports.ParentIdInput = exports.TimezoneInput = exports.SearchExtendedInput = exports.SearchInput = exports.ProjectionInput = exports.PageInput = exports.SortClauseInput = void 0;
|
|
4
|
+
const zod_1 = require("../zod");
|
|
5
|
+
/**
|
|
6
|
+
* The validation rules of a request body, declared once. `src/openapi/schemas.ts` decorates these
|
|
7
|
+
* with names and descriptions to publish them, and the parsers below check bodies against them, so
|
|
8
|
+
* the document and the runtime cannot drift apart.
|
|
9
|
+
*
|
|
10
|
+
* `filter` is deliberately absent: its operators are checked against the collection capabilities
|
|
11
|
+
* (`capabilities-validator`), and a node readable as both leaf and branch has no schema equivalent,
|
|
12
|
+
* so it keeps its own path in `agent-query.ts`.
|
|
13
|
+
*/
|
|
14
|
+
exports.SortClauseInput = zod_1.z.object({
|
|
15
|
+
field: zod_1.z.string(),
|
|
16
|
+
direction: zod_1.z.enum(['asc', 'desc']).optional(),
|
|
17
|
+
});
|
|
18
|
+
exports.PageInput = zod_1.z.object({
|
|
19
|
+
limit: zod_1.z.number().int().positive(),
|
|
20
|
+
offset: zod_1.z.number().int().nonnegative(),
|
|
21
|
+
});
|
|
22
|
+
exports.ProjectionInput = zod_1.z.array(zod_1.z.string());
|
|
23
|
+
exports.SearchInput = zod_1.z.string();
|
|
24
|
+
exports.SearchExtendedInput = zod_1.z.boolean();
|
|
25
|
+
exports.TimezoneInput = zod_1.z.string();
|
|
26
|
+
exports.ParentIdInput = zod_1.z.union([zod_1.z.string().regex(/\S/), zod_1.z.number()]);
|
|
27
|
+
/** Everything a list body carries except `filter`, which is validated separately. */
|
|
28
|
+
exports.ListFlatInputs = zod_1.z.object({
|
|
29
|
+
projection: exports.ProjectionInput.optional(),
|
|
30
|
+
sort: zod_1.z.array(exports.SortClauseInput).optional(),
|
|
31
|
+
page: exports.PageInput.optional(),
|
|
32
|
+
search: exports.SearchInput.optional(),
|
|
33
|
+
searchExtended: exports.SearchExtendedInput.optional(),
|
|
34
|
+
});
|
|
35
|
+
/** A count body carries no projection, sort or page. */
|
|
36
|
+
exports.CountFlatInputs = zod_1.z.object({
|
|
37
|
+
search: exports.SearchInput.optional(),
|
|
38
|
+
searchExtended: exports.SearchExtendedInput.optional(),
|
|
39
|
+
});
|
|
40
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoicmVxdWVzdC1zY2hlbWFzLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vc3JjL2RhdGEvcmVxdWVzdC1zY2hlbWFzLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7OztBQUFBLGdDQUEyQjtBQUUzQjs7Ozs7Ozs7R0FRRztBQUNVLFFBQUEsZUFBZSxHQUFHLE9BQUMsQ0FBQyxNQUFNLENBQUM7SUFDdEMsS0FBSyxFQUFFLE9BQUMsQ0FBQyxNQUFNLEVBQUU7SUFDakIsU0FBUyxFQUFFLE9BQUMsQ0FBQyxJQUFJLENBQUMsQ0FBQyxLQUFLLEVBQUUsTUFBTSxDQUFDLENBQUMsQ0FBQyxRQUFRLEVBQUU7Q0FDOUMsQ0FBQyxDQUFDO0FBRVUsUUFBQSxTQUFTLEdBQUcsT0FBQyxDQUFDLE1BQU0sQ0FBQztJQUNoQyxLQUFLLEVBQUUsT0FBQyxDQUFDLE1BQU0sRUFBRSxDQUFDLEdBQUcsRUFBRSxDQUFDLFFBQVEsRUFBRTtJQUNsQyxNQUFNLEVBQUUsT0FBQyxDQUFDLE1BQU0sRUFBRSxDQUFDLEdBQUcsRUFBRSxDQUFDLFdBQVcsRUFBRTtDQUN2QyxDQUFDLENBQUM7QUFFVSxRQUFBLGVBQWUsR0FBRyxPQUFDLENBQUMsS0FBSyxDQUFDLE9BQUMsQ0FBQyxNQUFNLEVBQUUsQ0FBQyxDQUFDO0FBRXRDLFFBQUEsV0FBVyxHQUFHLE9BQUMsQ0FBQyxNQUFNLEVBQUUsQ0FBQztBQUV6QixRQUFBLG1CQUFtQixHQUFHLE9BQUMsQ0FBQyxPQUFPLEVBQUUsQ0FBQztBQUVsQyxRQUFBLGFBQWEsR0FBRyxPQUFDLENBQUMsTUFBTSxFQUFFLENBQUM7QUFFM0IsUUFBQSxhQUFhLEdBQUcsT0FBQyxDQUFDLEtBQUssQ0FBQyxDQUFDLE9BQUMsQ0FBQyxNQUFNLEVBQUUsQ0FBQyxLQUFLLENBQUMsSUFBSSxDQUFDLEVBQUUsT0FBQyxDQUFDLE1BQU0sRUFBRSxDQUFDLENBQUMsQ0FBQztBQUUzRSxxRkFBcUY7QUFDeEUsUUFBQSxjQUFjLEdBQUcsT0FBQyxDQUFDLE1BQU0sQ0FBQztJQUNyQyxVQUFVLEVBQUUsdUJBQWUsQ0FBQyxRQUFRLEVBQUU7SUFDdEMsSUFBSSxFQUFFLE9BQUMsQ0FBQyxLQUFLLENBQUMsdUJBQWUsQ0FBQyxDQUFDLFFBQVEsRUFBRTtJQUN6QyxJQUFJLEVBQUUsaUJBQVMsQ0FBQyxRQUFRLEVBQUU7SUFDMUIsTUFBTSxFQUFFLG1CQUFXLENBQUMsUUFBUSxFQUFFO0lBQzlCLGNBQWMsRUFBRSwyQkFBbUIsQ0FBQyxRQUFRLEVBQUU7Q0FDL0MsQ0FBQyxDQUFDO0FBRUgsd0RBQXdEO0FBQzNDLFFBQUEsZUFBZSxHQUFHLE9BQUMsQ0FBQyxNQUFNLENBQUM7SUFDdEMsTUFBTSxFQUFFLG1CQUFXLENBQUMsUUFBUSxFQUFFO0lBQzlCLGNBQWMsRUFBRSwyQkFBbUIsQ0FBQyxRQUFRLEVBQUU7Q0FDL0MsQ0FBQyxDQUFDIn0=
|
|
@@ -13,6 +13,8 @@ export declare const PageSchema: z.ZodObject<{
|
|
|
13
13
|
offset: z.ZodNumber;
|
|
14
14
|
}, z.core.$strip>;
|
|
15
15
|
export declare const TimezoneSchema: z.ZodString;
|
|
16
|
+
export declare const SearchSchema: z.ZodString;
|
|
17
|
+
export declare const SearchExtendedSchema: z.ZodBoolean;
|
|
16
18
|
export declare const ListRequestSchema: z.ZodObject<{
|
|
17
19
|
filter: z.ZodOptional<z.ZodType<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>>;
|
|
18
20
|
projection: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
@@ -27,10 +29,14 @@ export declare const ListRequestSchema: z.ZodObject<{
|
|
|
27
29
|
limit: z.ZodNumber;
|
|
28
30
|
offset: z.ZodNumber;
|
|
29
31
|
}, z.core.$strip>>;
|
|
32
|
+
search: z.ZodOptional<z.ZodString>;
|
|
33
|
+
searchExtended: z.ZodOptional<z.ZodBoolean>;
|
|
30
34
|
timezone: z.ZodOptional<z.ZodString>;
|
|
31
35
|
}, z.core.$strip>;
|
|
32
36
|
export declare const CountRequestSchema: z.ZodObject<{
|
|
33
37
|
filter: z.ZodOptional<z.ZodType<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>>;
|
|
38
|
+
search: z.ZodOptional<z.ZodString>;
|
|
39
|
+
searchExtended: z.ZodOptional<z.ZodBoolean>;
|
|
34
40
|
timezone: z.ZodOptional<z.ZodString>;
|
|
35
41
|
}, z.core.$strip>;
|
|
36
42
|
declare const ParentIdSchema: z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>;
|
|
@@ -48,11 +54,15 @@ export declare const RelationListRequestSchema: z.ZodObject<{
|
|
|
48
54
|
limit: z.ZodNumber;
|
|
49
55
|
offset: z.ZodNumber;
|
|
50
56
|
}, z.core.$strip>>;
|
|
57
|
+
search: z.ZodOptional<z.ZodString>;
|
|
58
|
+
searchExtended: z.ZodOptional<z.ZodBoolean>;
|
|
51
59
|
timezone: z.ZodOptional<z.ZodString>;
|
|
52
60
|
parentId: z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>;
|
|
53
61
|
}, z.core.$strip>;
|
|
54
62
|
export declare const RelationCountRequestSchema: z.ZodObject<{
|
|
55
63
|
filter: z.ZodOptional<z.ZodType<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>>;
|
|
64
|
+
search: z.ZodOptional<z.ZodString>;
|
|
65
|
+
searchExtended: z.ZodOptional<z.ZodBoolean>;
|
|
56
66
|
timezone: z.ZodOptional<z.ZodString>;
|
|
57
67
|
parentId: z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>;
|
|
58
68
|
}, z.core.$strip>;
|
package/dist/openapi/schemas.js
CHANGED
|
@@ -1,8 +1,9 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.OPERATORS = exports.ParentIdSchema = exports.ConditionTreeSchema = exports.MessagelessErrorResponseSchema = exports.ErrorResponseSchema = exports.ContextResponseSchema = exports.CountResponseSchema = exports.ListResponseSchema = exports.ActionRequestSchema = exports.RelationCountRequestSchema = exports.RelationListRequestSchema = exports.CountRequestSchema = exports.ListRequestSchema = exports.TimezoneSchema = exports.PageSchema = exports.SortClauseSchema = void 0;
|
|
3
|
+
exports.OPERATORS = exports.ParentIdSchema = exports.ConditionTreeSchema = exports.MessagelessErrorResponseSchema = exports.ErrorResponseSchema = exports.ContextResponseSchema = exports.CountResponseSchema = exports.ListResponseSchema = exports.ActionRequestSchema = exports.RelationCountRequestSchema = exports.RelationListRequestSchema = exports.CountRequestSchema = exports.ListRequestSchema = exports.SearchExtendedSchema = exports.SearchSchema = exports.TimezoneSchema = exports.PageSchema = exports.SortClauseSchema = void 0;
|
|
4
4
|
const datasource_toolkit_1 = require("@forestadmin/datasource-toolkit");
|
|
5
5
|
const zod_openapi_1 = require("./zod-openapi");
|
|
6
|
+
const request_schemas_1 = require("../data/request-schemas");
|
|
6
7
|
const read_model_1 = require("../read-model/read-model");
|
|
7
8
|
const capabilities_validator_1 = require("../validation/capabilities-validator");
|
|
8
9
|
const OPERATORS = [...datasource_toolkit_1.allOperators];
|
|
@@ -33,42 +34,59 @@ const ConditionTreeSchema = zod_openapi_1.z
|
|
|
33
34
|
'collection capabilities; relation list and count forward the filter without either check.',
|
|
34
35
|
});
|
|
35
36
|
exports.ConditionTreeSchema = ConditionTreeSchema;
|
|
36
|
-
exports.SortClauseSchema =
|
|
37
|
-
.
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
})
|
|
41
|
-
.openapi('SortClause', { description: 'Omitting `direction` sorts ascending.' });
|
|
42
|
-
exports.PageSchema = zod_openapi_1.z
|
|
43
|
-
.object({
|
|
44
|
-
limit: zod_openapi_1.z.number().int().positive(),
|
|
45
|
-
offset: zod_openapi_1.z.number().int().nonnegative(),
|
|
46
|
-
})
|
|
47
|
-
.openapi('Page', {
|
|
37
|
+
exports.SortClauseSchema = request_schemas_1.SortClauseInput.openapi('SortClause', {
|
|
38
|
+
description: 'Omitting `direction` sorts ascending.',
|
|
39
|
+
});
|
|
40
|
+
exports.PageSchema = request_schemas_1.PageInput.openapi('Page', {
|
|
48
41
|
description: 'The agent paginates by page number, so `offset` must be a whole multiple of `limit`. ' +
|
|
49
42
|
'Any other offset is rejected with 400 invalid_request.',
|
|
50
43
|
});
|
|
51
|
-
exports.TimezoneSchema =
|
|
44
|
+
exports.TimezoneSchema = request_schemas_1.TimezoneInput.openapi('Timezone', {
|
|
52
45
|
description: 'Used when the X-Forest-Timezone header is absent. The header wins when both are sent. A ' +
|
|
53
46
|
'deployment with no configured default rejects a request carrying neither with 400 ' +
|
|
54
47
|
'missing_timezone.',
|
|
55
48
|
});
|
|
49
|
+
exports.SearchSchema = request_schemas_1.SearchInput.openapi('Search', {
|
|
50
|
+
description: "The agent's native full-text search, applied on top of `filter` rather than instead of it. " +
|
|
51
|
+
'An empty or whitespace-only value is treated as absent, so clearing a search box is not an ' +
|
|
52
|
+
'error. Searching a collection whose search is disabled is not rejected here: the agent ' +
|
|
53
|
+
'answers 400 validation_error with "Collection is not searchable". The response does not say ' +
|
|
54
|
+
'which field matched. The value is a query, not a plain term: `column:value` narrows the ' +
|
|
55
|
+
'search to one column, and `relation.column:value` narrows it to a column of a related ' +
|
|
56
|
+
'collection — so a search reaches relation fields on its own, with no `searchExtended`, and ' +
|
|
57
|
+
'escapes the 422 relation_field_not_supported that the same path draws in `filter`, `sort` or ' +
|
|
58
|
+
'`projection`. The agent resolves a relation named in a query against its own schema, so a ' +
|
|
59
|
+
'query can filter on a column of a collection this BFF does not expose.',
|
|
60
|
+
});
|
|
61
|
+
exports.SearchExtendedSchema = request_schemas_1.SearchExtendedInput.openapi('SearchExtended', {
|
|
62
|
+
description: 'Widens `search` to every related collection reachable from this one, instead of only this ' +
|
|
63
|
+
"collection's own columns. Meaningless on its own: sent without `search` it is ignored and " +
|
|
64
|
+
'changes nothing. It is not the only way a search reaches a relation — see `Search` for the ' +
|
|
65
|
+
'`relation.column:value` syntax, which does so without this flag.',
|
|
66
|
+
});
|
|
56
67
|
exports.ListRequestSchema = zod_openapi_1.z
|
|
57
68
|
.object({
|
|
58
69
|
filter: ConditionTreeSchema.optional(),
|
|
59
|
-
projection:
|
|
70
|
+
projection: request_schemas_1.ProjectionInput.optional(),
|
|
60
71
|
sort: zod_openapi_1.z.array(exports.SortClauseSchema).optional(),
|
|
61
72
|
page: exports.PageSchema.optional(),
|
|
73
|
+
search: exports.SearchSchema.optional(),
|
|
74
|
+
searchExtended: exports.SearchExtendedSchema.optional(),
|
|
62
75
|
timezone: exports.TimezoneSchema.optional(),
|
|
63
76
|
})
|
|
64
77
|
.openapi('ListRequest');
|
|
65
78
|
exports.CountRequestSchema = zod_openapi_1.z
|
|
66
79
|
.object({
|
|
67
80
|
filter: ConditionTreeSchema.optional(),
|
|
81
|
+
search: exports.SearchSchema.optional(),
|
|
82
|
+
searchExtended: exports.SearchExtendedSchema.optional(),
|
|
68
83
|
timezone: exports.TimezoneSchema.optional(),
|
|
69
84
|
})
|
|
70
|
-
.openapi('CountRequest'
|
|
71
|
-
|
|
85
|
+
.openapi('CountRequest', {
|
|
86
|
+
description: 'Accepts the same search inputs as list, so a client can count exactly the rows its search ' +
|
|
87
|
+
'returns.',
|
|
88
|
+
});
|
|
89
|
+
const ParentIdSchema = request_schemas_1.ParentIdInput.openapi('ParentId', {
|
|
72
90
|
description: 'The parent record id, opaque: a composite or packed id must be passed unchanged. A ' +
|
|
73
91
|
'blank string is rejected.',
|
|
74
92
|
});
|
|
@@ -76,7 +94,7 @@ exports.ParentIdSchema = ParentIdSchema;
|
|
|
76
94
|
exports.RelationListRequestSchema = exports.ListRequestSchema.extend({
|
|
77
95
|
parentId: ParentIdSchema,
|
|
78
96
|
}).openapi('RelationListRequest', {
|
|
79
|
-
description: 'Filter, sort and
|
|
97
|
+
description: 'Filter, sort, projection and search apply to the FOREIGN collection; the parent only resolves ' +
|
|
80
98
|
'which records are related.',
|
|
81
99
|
});
|
|
82
100
|
exports.RelationCountRequestSchema = exports.CountRequestSchema.extend({
|
|
@@ -229,4 +247,4 @@ exports.MessagelessErrorResponseSchema = zod_openapi_1.z
|
|
|
229
247
|
.openapi('MessagelessErrorResponse', {
|
|
230
248
|
description: 'The unsupported-action-result body, which carries no message field unlike every other error.',
|
|
231
249
|
});
|
|
232
|
-
//# sourceMappingURL=data:application/json;base64,
|
|
250
|
+
//# sourceMappingURL=data:application/json;base64,{"version":3,"file":"schemas.js","sourceRoot":"","sources":["../../src/openapi/schemas.ts"],"names":[],"mappings":";;;AAAA,wEAA+D;AAE/D,+CAAkC;AAClC,6DAQiC;AACjC,yDAA8D;AAC9D,iFAAwE;AAExE,MAAM,SAAS,GAAG,CAAC,GAAG,iCAAY,CAA0B,CAAC;AAmSf,8BAAS;AAjSvD,MAAM,uBAAuB,GAAG,eAAC;KAC9B,MAAM,CAAC;IACN,KAAK,EAAE,eAAC,CAAC,MAAM,EAAE;IACjB,QAAQ,EAAE,eAAC,CAAC,IAAI,CAAC,SAAS,CAAC;IAC3B,KAAK,EAAE,eAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;CAC9B,CAAC;KACD,OAAO,CAAC,mBAAmB,EAAE;IAC5B,WAAW,EACT,0FAA0F;QAC1F,qFAAqF;CACxF,CAAC,CAAC;AAEL,MAAM,mBAAmB,GAAc,eAAC;KACrC,IAAI,CAAC,GAAG,EAAE,CACT,eAAC,CAAC,KAAK,CAAC;IACN,uBAAuB;IACvB,eAAC,CAAC,MAAM,CAAC;QACP,UAAU,EAAE,eAAC,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;QACjC,UAAU,EAAE,eAAC,CAAC,KAAK,CAAC,mBAAmB,CAAC;KACzC,CAAC;CACH,CAAC,CACH;KACA,OAAO,CAAC,eAAe,EAAE;IACxB,WAAW,EACT,uFAAuF;QACvF,uFAAuF;QACvF,uFAAuF;QACvF,QAAQ,yCAAgB,4DAA4D;QACpF,2FAA2F;CAC9F,CAAC,CAAC;AAoQI,kDAAmB;AAlQf,QAAA,gBAAgB,GAAG,iCAAe,CAAC,OAAO,CAAC,YAAY,EAAE;IACpE,WAAW,EAAE,uCAAuC;CACrD,CAAC,CAAC;AAEU,QAAA,UAAU,GAAG,2BAAS,CAAC,OAAO,CAAC,MAAM,EAAE;IAClD,WAAW,EACT,uFAAuF;QACvF,wDAAwD;CAC3D,CAAC,CAAC;AAEU,QAAA,cAAc,GAAG,+BAAa,CAAC,OAAO,CAAC,UAAU,EAAE;IAC9D,WAAW,EACT,0FAA0F;QAC1F,oFAAoF;QACpF,mBAAmB;CACtB,CAAC,CAAC;AAEU,QAAA,YAAY,GAAG,6BAAW,CAAC,OAAO,CAAC,QAAQ,EAAE;IACxD,WAAW,EACT,6FAA6F;QAC7F,6FAA6F;QAC7F,yFAAyF;QACzF,8FAA8F;QAC9F,0FAA0F;QAC1F,wFAAwF;QACxF,6FAA6F;QAC7F,+FAA+F;QAC/F,4FAA4F;QAC5F,wEAAwE;CAC3E,CAAC,CAAC;AAEU,QAAA,oBAAoB,GAAG,qCAAmB,CAAC,OAAO,CAAC,gBAAgB,EAAE;IAChF,WAAW,EACT,4FAA4F;QAC5F,4FAA4F;QAC5F,6FAA6F;QAC7F,kEAAkE;CACrE,CAAC,CAAC;AAEU,QAAA,iBAAiB,GAAG,eAAC;KAC/B,MAAM,CAAC;IACN,MAAM,EAAE,mBAAmB,CAAC,QAAQ,EAAE;IACtC,UAAU,EAAE,iCAAe,CAAC,QAAQ,EAAE;IACtC,IAAI,EAAE,eAAC,CAAC,KAAK,CAAC,wBAAgB,CAAC,CAAC,QAAQ,EAAE;IAC1C,IAAI,EAAE,kBAAU,CAAC,QAAQ,EAAE;IAC3B,MAAM,EAAE,oBAAY,CAAC,QAAQ,EAAE;IAC/B,cAAc,EAAE,4BAAoB,CAAC,QAAQ,EAAE;IAC/C,QAAQ,EAAE,sBAAc,CAAC,QAAQ,EAAE;CACpC,CAAC;KACD,OAAO,CAAC,aAAa,CAAC,CAAC;AAEb,QAAA,kBAAkB,GAAG,eAAC;KAChC,MAAM,CAAC;IACN,MAAM,EAAE,mBAAmB,CAAC,QAAQ,EAAE;IACtC,MAAM,EAAE,oBAAY,CAAC,QAAQ,EAAE;IAC/B,cAAc,EAAE,4BAAoB,CAAC,QAAQ,EAAE;IAC/C,QAAQ,EAAE,sBAAc,CAAC,QAAQ,EAAE;CACpC,CAAC;KACD,OAAO,CAAC,cAAc,EAAE;IACvB,WAAW,EACT,4FAA4F;QAC5F,UAAU;CACb,CAAC,CAAC;AAEL,MAAM,cAAc,GAAG,+BAAa,CAAC,OAAO,CAAC,UAAU,EAAE;IACvD,WAAW,EACT,qFAAqF;QACrF,2BAA2B;CAC9B,CAAC,CAAC;AA8L2B,wCAAc;AA5L/B,QAAA,yBAAyB,GAAG,yBAAiB,CAAC,MAAM,CAAC;IAChE,QAAQ,EAAE,cAAc;CACzB,CAAC,CAAC,OAAO,CAAC,qBAAqB,EAAE;IAChC,WAAW,EACT,gGAAgG;QAChG,4BAA4B;CAC/B,CAAC,CAAC;AAEU,QAAA,0BAA0B,GAAG,0BAAkB,CAAC,MAAM,CAAC;IAClE,QAAQ,EAAE,cAAc;CACzB,CAAC,CAAC,OAAO,CAAC,sBAAsB,CAAC,CAAC;AAEtB,QAAA,mBAAmB,GAAG,eAAC;KACjC,MAAM,CAAC;IACN,SAAS,EAAE,eAAC,CAAC,KAAK,CAAC,eAAC,CAAC,KAAK,CAAC,CAAC,eAAC,CAAC,MAAM,EAAE,EAAE,eAAC,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;IACrD,MAAM,EAAE,eAAC,CAAC,MAAM,CAAC,eAAC,CAAC,MAAM,EAAE,EAAE,eAAC,CAAC,OAAO,EAAE,CAAC,CAAC,QAAQ,EAAE;IACpD,QAAQ,EAAE,sBAAc,CAAC,QAAQ,EAAE;CACpC,CAAC;KACD,OAAO,CAAC,eAAe,EAAE;IACxB,WAAW,EACT,wFAAwF;QACxF,+EAA+E;CAClF,CAAC,CAAC;AAEL,MAAM,sBAAsB,GAAG,eAAC;KAC7B,MAAM,CAAC;IACN,UAAU,EAAE,eAAC,CAAC,MAAM,EAAE;IACtB,UAAU,EAAE,eAAC,CAAC,MAAM,CAAC,eAAC,CAAC,MAAM,EAAE,EAAE,eAAC,CAAC,KAAK,CAAC,CAAC,eAAC,CAAC,MAAM,EAAE,EAAE,eAAC,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;CACpE,CAAC;KACD,OAAO,CAAC,kBAAkB,EAAE;IAC3B,WAAW,EACT,uFAAuF;QACvF,mBAAmB;CACtB,CAAC,CAAC;AAEQ,QAAA,kBAAkB,GAAG,eAAC;KAChC,MAAM,CAAC;IACN,IAAI,EAAE,eAAC,CAAC,KAAK,CACX,eAAC,CAAC,MAAM,CAAC,eAAC,CAAC,MAAM,EAAE,EAAE,eAAC,CAAC,OAAO,EAAE,CAAC,CAAC,GAAG,CAAC,eAAC,CAAC,MAAM,CAAC,EAAE,QAAQ,EAAE,sBAAsB,EAAE,CAAC,CAAC,CACtF;IACD,IAAI,EAAE,eAAC,CAAC,MAAM,CAAC,EAAE,WAAW,EAAE,eAAC,CAAC,OAAO,CAAC,eAAe,CAAC,EAAE,CAAC;CAC5D,CAAC;KACD,OAAO,CAAC,cAAc,EAAE;IACvB,WAAW,EACT,yFAAyF;QACzF,yFAAyF;CAC5F,CAAC,CAAC;AAEQ,QAAA,mBAAmB,GAAG,eAAC;KACjC,KAAK,CAAC;IACL,eAAC,CAAC,MAAM,CAAC,EAAE,KAAK,EAAE,eAAC,CAAC,MAAM,EAAE,EAAE,WAAW,EAAE,eAAC,CAAC,OAAO,CAAC,WAAW,CAAC,EAAE,CAAC;IACpE,eAAC,CAAC,MAAM,CAAC,EAAE,KAAK,EAAE,eAAC,CAAC,IAAI,EAAE,EAAE,WAAW,EAAE,eAAC,CAAC,OAAO,CAAC,aAAa,CAAC,EAAE,CAAC;CACrE,CAAC;KACD,OAAO,CAAC,eAAe,EAAE;IACxB,WAAW,EACT,kFAAkF;QAClF,sDAAsD;CACzD,CAAC,CAAC;AAEL,MAAM,sBAAsB,GAAc,eAAC;KACxC,IAAI,CAAC,GAAG,EAAE,CACT,eAAC,CAAC,KAAK,CAAC;IACN,eAAC,CAAC,MAAM,EAAE;IACV,eAAC,CAAC,KAAK,CAAC,sBAAsB,CAAC;IAC/B,eAAC,CAAC,MAAM,CAAC;QACP,MAAM,EAAE,eAAC,CAAC,KAAK,CACb,eAAC,CAAC,MAAM,CAAC;YACP,KAAK,EAAE,eAAC,CAAC,MAAM,EAAE;YACjB,IAAI,EAAE,sBAAsB;YAC5B,KAAK,EAAE,eAAC,CAAC,KAAK,CAAC,eAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;SACtC,CAAC,CACH;KACF,CAAC;CACH,CAAC,CACH;KACA,OAAO,CAAC,kBAAkB,EAAE;IAC3B,WAAW,EACT,4FAA4F;QAC5F,4FAA4F;QAC5F,sFAAsF;QACtF,4FAA4F;QAC5F,6BAA6B;CAChC,CAAC,CAAC;AAEL,MAAM,uBAAuB,GAAG,eAAC;KAC9B,MAAM,CAAC,EAAE,IAAI,EAAE,eAAC,CAAC,MAAM,EAAE,EAAE,KAAK,EAAE,eAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE,EAAE,CAAC;KAC3D,OAAO,CAAC,mBAAmB,EAAE;IAC5B,WAAW,EACT,yFAAyF;QACzF,uFAAuF;QACvF,4FAA4F;QAC5F,0FAA0F;QAC1F,uFAAuF;QACvF,2FAA2F;QAC3F,wFAAwF;QACxF,0CAA0C;CAC7C,CAAC,CAAC;AAEL,MAAM,kBAAkB,GAAG,eAAC,CAAC,MAAM,CAAC;IAClC,KAAK,EAAE,eAAC,CAAC,MAAM,EAAE;IACjB,IAAI,EAAE,sBAAsB;IAC5B,YAAY,EAAE,eAAC,CAAC,IAAI,CAAC,+BAAkB,CAAC,CAAC,QAAQ,EAAE;IACnD,SAAS,EAAE,eAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAChC,SAAS,EAAE,eAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAChC,kBAAkB,EAAE,eAAC,CAAC,KAAK,CAAC,eAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;IAClD,YAAY,EAAE,eAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IACpC,UAAU,EAAE,eAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IAClC,UAAU,EAAE,eAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IAClC,KAAK,EAAE,eAAC,CAAC,KAAK,CAAC,eAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;IACrC,WAAW,EAAE,eAAC,CAAC,KAAK,CAAC,uBAAuB,CAAC,CAAC,QAAQ,EAAE;CACzD,CAAC,CAAC;AAEH,MAAM,mBAAmB,GAAG,eAAC,CAAC,MAAM,CAAC;IACnC,EAAE,EAAE,eAAC,CAAC,MAAM,EAAE;IACd,IAAI,EAAE,eAAC,CAAC,MAAM,EAAE;IAChB,IAAI,EAAE,eAAC,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC;IAC1C,MAAM,EAAE,eAAC,CAAC,KAAK,CACb,eAAC,CAAC,MAAM,CAAC;QACP,KAAK,EAAE,eAAC,CAAC,MAAM,EAAE;QACjB,IAAI,EAAE,sBAAsB;QAC5B,UAAU,EAAE,eAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;QAClC,YAAY,EAAE,eAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;QACpC,KAAK,EAAE,eAAC,CAAC,KAAK,CAAC,eAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;KACtC,CAAC,CACH;CACF,CAAC,CAAC;AAEU,QAAA,qBAAqB,GAAG,eAAC;KACnC,MAAM,CAAC;IACN,WAAW,EAAE,eAAC,CAAC,KAAK,CAClB,eAAC,CAAC,MAAM,CAAC;QACP,IAAI,EAAE,eAAC,CAAC,MAAM,EAAE;QAChB,MAAM,EAAE,eAAC,CAAC,KAAK,CAAC,kBAAkB,CAAC;QACnC,OAAO,EAAE,eAAC,CAAC,KAAK,CAAC,mBAAmB,CAAC;KACtC,CAAC,CACH;IACD,IAAI,EAAE,eAAC,CAAC,MAAM,CAAC,EAAE,cAAc,EAAE,eAAC,CAAC,MAAM,EAAE,EAAE,aAAa,EAAE,eAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,EAAE,CAAC;CACrF,CAAC;KACD,OAAO,CAAC,iBAAiB,EAAE;IAC1B,WAAW,EACT,0FAA0F;QAC1F,yFAAyF;QACzF,uFAAuF;QACvF,yFAAyF;QACzF,yFAAyF;QACzF,0FAA0F;QAC1F,4FAA4F;QAC5F,mFAAmF;QACnF,0FAA0F;QAC1F,mFAAmF;QACnF,0FAA0F;QAC1F,wFAAwF;QACxF,mCAAmC;QACnC,wFAAwF;QACxF,0FAA0F;QAC1F,yFAAyF;QACzF,0FAA0F;QAC1F,+DAA+D;QAC/D,0FAA0F;QAC1F,0FAA0F;QAC1F,wFAAwF;QACxF,kDAAkD;CACrD,CAAC,CAAC;AAEQ,QAAA,mBAAmB,GAAG,eAAC;KACjC,MAAM,CAAC;IACN,KAAK,EAAE,eAAC,CAAC,MAAM,CAAC;QACd,IAAI,EAAE,eAAC,CAAC,MAAM,EAAE;QAChB,MAAM,EAAE,eAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE;QACxB,OAAO,EAAE,eAAC,CAAC,MAAM,EAAE;QACnB,OAAO,EAAE,eAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;KAChC,CAAC;CACH,CAAC;KACD,OAAO,CAAC,eAAe,CAAC,CAAC;AAEf,QAAA,8BAA8B,GAAG,eAAC;KAC5C,MAAM,CAAC;IACN,KAAK,EAAE,eAAC,CAAC,MAAM,CAAC;QACd,IAAI,EAAE,eAAC,CAAC,MAAM,EAAE;QAChB,MAAM,EAAE,eAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE;QACxB,OAAO,EAAE,eAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;KAChC,CAAC;CACH,CAAC;KACD,OAAO,CAAC,0BAA0B,EAAE;IACnC,WAAW,EACT,8FAA8F;CACjG,CAAC,CAAC"}
|
|
@@ -1,8 +1,9 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
3
|
exports.z = void 0;
|
|
4
|
-
|
|
5
|
-
|
|
4
|
+
// Kept as the openapi module's entry point for zod; the extension itself lives in `src/zod.ts` so
|
|
5
|
+
// the request schemas can share the same extended instance without depending on this folder.
|
|
6
|
+
// eslint-disable-next-line import/prefer-default-export
|
|
7
|
+
var zod_1 = require("../zod");
|
|
6
8
|
Object.defineProperty(exports, "z", { enumerable: true, get: function () { return zod_1.z; } });
|
|
7
|
-
|
|
8
|
-
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiem9kLW9wZW5hcGkuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvb3BlbmFwaS96b2Qtb3BlbmFwaS50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7QUFBQSxtRUFBc0U7QUFDdEUsNkJBQXdCO0FBS2Ysa0ZBTEEsT0FBQyxPQUtBO0FBSFYsSUFBQSxxQ0FBb0IsRUFBQyxPQUFDLENBQUMsQ0FBQyJ9
|
|
9
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiem9kLW9wZW5hcGkuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvb3BlbmFwaS96b2Qtb3BlbmFwaS50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7QUFBQSxrR0FBa0c7QUFDbEcsNkZBQTZGO0FBQzdGLHdEQUF3RDtBQUN4RCw4QkFBMkI7QUFBbEIsd0ZBQUEsQ0FBQyxPQUFBIn0=
|
package/dist/zod.d.ts
ADDED
package/dist/zod.js
ADDED
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.z = void 0;
|
|
4
|
+
const zod_to_openapi_1 = require("@asteasolutions/zod-to-openapi");
|
|
5
|
+
const zod_1 = require("zod");
|
|
6
|
+
Object.defineProperty(exports, "z", { enumerable: true, get: function () { return zod_1.z; } });
|
|
7
|
+
// Extended once, here, and imported from here by everyone. A schema built from a plain `zod` import
|
|
8
|
+
// has no `.openapi()`, so the request schemas and the OpenAPI document must share this instance for
|
|
9
|
+
// the same declaration to serve both.
|
|
10
|
+
(0, zod_to_openapi_1.extendZodWithOpenApi)(zod_1.z);
|
|
11
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiem9kLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vc3JjL3pvZC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7QUFBQSxtRUFBc0U7QUFDdEUsNkJBQXdCO0FBUWYsa0ZBUkEsT0FBQyxPQVFBO0FBTlYsb0dBQW9HO0FBQ3BHLG9HQUFvRztBQUNwRyxzQ0FBc0M7QUFDdEMsSUFBQSxxQ0FBb0IsRUFBQyxPQUFDLENBQUMsQ0FBQyJ9
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@forestadmin/agent-bff",
|
|
3
|
-
"version": "1.
|
|
3
|
+
"version": "1.21.0",
|
|
4
4
|
"main": "dist/index.js",
|
|
5
5
|
"bin": {
|
|
6
6
|
"forest-bff": "dist/cli.js"
|
|
@@ -42,6 +42,8 @@
|
|
|
42
42
|
"zod": "4.3.6"
|
|
43
43
|
},
|
|
44
44
|
"devDependencies": {
|
|
45
|
+
"@forestadmin/agent": "1.98.0",
|
|
46
|
+
"@forestadmin/agent-testing": "1.2.4",
|
|
45
47
|
"@hey-api/openapi-ts": "0.99.0",
|
|
46
48
|
"@redocly/cli": "2.35.1",
|
|
47
49
|
"@types/jsonwebtoken": "^9.0.1",
|