@forestadmin/agent-bff 1.16.0 → 1.18.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 +15 -1
- package/dist/action/action-form-mapper.d.ts +2 -1
- package/dist/action/action-form-mapper.js +1 -1
- package/dist/action/agent-action-client.d.ts +2 -1
- package/dist/action/agent-action-client.js +1 -1
- package/dist/cli-core.d.ts +3 -0
- package/dist/cli-core.js +52 -10
- package/dist/cli-dispatch.d.ts +8 -2
- package/dist/cli-dispatch.js +90 -9
- package/dist/data/data-routes-middleware.js +3 -12
- package/dist/data/pack-id.d.ts +1 -0
- package/dist/data/pack-id.js +4 -3
- package/dist/openapi/collect-unfolding.d.ts +23 -0
- package/dist/openapi/collect-unfolding.js +144 -0
- package/dist/openapi/component-pool.d.ts +18 -0
- package/dist/openapi/component-pool.js +28 -0
- package/dist/openapi/field-schemas.d.ts +9 -0
- package/dist/openapi/field-schemas.js +43 -0
- package/dist/openapi/names.d.ts +16 -0
- package/dist/openapi/names.js +28 -0
- package/dist/openapi/openapi-document.d.ts +2 -1
- package/dist/openapi/openapi-document.js +112 -66
- package/dist/openapi/openapi-routes.d.ts +4 -1
- package/dist/openapi/openapi-routes.js +46 -9
- package/dist/openapi/schemas.d.ts +14 -1
- package/dist/openapi/schemas.js +11 -10
- package/dist/openapi/unfolded-document.d.ts +28 -0
- package/dist/openapi/unfolded-document.js +52 -0
- package/dist/openapi/unfolded-paths.d.ts +20 -0
- package/dist/openapi/unfolded-paths.js +408 -0
- package/dist/openapi/unfolding.d.ts +66 -0
- package/dist/openapi/unfolding.js +17 -0
- package/dist/read-model/agent-capabilities-fetcher.d.ts +8 -3
- package/dist/read-model/agent-capabilities-fetcher.js +15 -7
- package/dist/read-model/capabilities-cache.d.ts +11 -1
- package/dist/read-model/capabilities-cache.js +1 -1
- package/dist/read-model/read-model.d.ts +14 -0
- package/dist/read-model/read-model.js +36 -2
- package/dist/validation/operator-normalizer.d.ts +6 -0
- package/dist/validation/operator-normalizer.js +11 -1
- package/package.json +4 -4
|
@@ -0,0 +1,408 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
3
|
+
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
4
|
+
};
|
|
5
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
6
|
+
exports.default = registerUnfoldedPaths;
|
|
7
|
+
const field_schemas_1 = __importDefault(require("./field-schemas"));
|
|
8
|
+
const names_1 = __importDefault(require("./names"));
|
|
9
|
+
const schemas_1 = require("./schemas");
|
|
10
|
+
const pack_id_1 = require("../data/pack-id");
|
|
11
|
+
const AGGREGATORS = ['And', 'Or'];
|
|
12
|
+
const DEGRADED_NOTE = {
|
|
13
|
+
capabilities_unavailable: 'The field names are NOT enumerated here: the agent could not be asked for this ' +
|
|
14
|
+
"collection's capabilities when the document was built. Any field the collection really " +
|
|
15
|
+
'exposes is still accepted.',
|
|
16
|
+
no_fields: 'The field names are NOT enumerated here: the agent reports no filterable or projectable ' +
|
|
17
|
+
'field on this collection. Any field sent in `projection`, `sort` or `filter` is therefore ' +
|
|
18
|
+
'rejected with 422 unknown_field — call this path without them.',
|
|
19
|
+
};
|
|
20
|
+
function quoted(name) {
|
|
21
|
+
return JSON.stringify(name);
|
|
22
|
+
}
|
|
23
|
+
// A name reaches the runtime through decodeURIComponent, so the document must carry it encoded —
|
|
24
|
+
// including the separators that would otherwise change the route, such as a slash inside an action
|
|
25
|
+
// name (`a/b` is reachable only as `a%2Fb`).
|
|
26
|
+
function segment(name) {
|
|
27
|
+
return encodeURIComponent(name);
|
|
28
|
+
}
|
|
29
|
+
function fieldsEnum(pool, name, fields, description) {
|
|
30
|
+
// An empty enum would forbid every value, so a collection with no known field set keeps a plain
|
|
31
|
+
// string — the runtime is the one that rejects an unknown field, and it says which.
|
|
32
|
+
if (fields.length === 0)
|
|
33
|
+
return { type: 'string' };
|
|
34
|
+
return pool.add(name, { type: 'string', enum: fields, description });
|
|
35
|
+
}
|
|
36
|
+
/**
|
|
37
|
+
* Groups the filterable fields by the operator set they share. One leaf per field would be as exact
|
|
38
|
+
* but would multiply the document by the field count; the number of distinct operator sets is bounded
|
|
39
|
+
* by the column types a collection really uses, and the cross product of a group is precisely the set
|
|
40
|
+
* of valid `(field, operator)` pairs. The grouping is derived from what capabilities reported — two
|
|
41
|
+
* fields of DIFFERENT types sharing an operator set land in one group, so nothing here is a type
|
|
42
|
+
* table.
|
|
43
|
+
*/
|
|
44
|
+
function groupByOperators(filterable) {
|
|
45
|
+
const groups = new Map();
|
|
46
|
+
filterable.forEach(field => {
|
|
47
|
+
// An empty set would emit `enum: []`, which forbids every value and makes the leaf unsatisfiable —
|
|
48
|
+
// the trap `fieldsEnum` guards above. `collectFilterableFields` cannot produce one, but `Unfolding`
|
|
49
|
+
// is hand-constructible plain data, so the generator holds the invariant rather than assume it.
|
|
50
|
+
if (field.operators.length === 0)
|
|
51
|
+
return;
|
|
52
|
+
// Safe as a key because the operators are normalized to one canonical order at collect time.
|
|
53
|
+
const signature = field.operators.join(',');
|
|
54
|
+
const group = groups.get(signature);
|
|
55
|
+
if (group)
|
|
56
|
+
group.fields.push(field.name);
|
|
57
|
+
else
|
|
58
|
+
groups.set(signature, { fields: [field.name], operators: [...field.operators] });
|
|
59
|
+
});
|
|
60
|
+
return [...groups.values()];
|
|
61
|
+
}
|
|
62
|
+
// A node readable as BOTH a leaf and a branch is rejected with 400 (`agent-query.ts`
|
|
63
|
+
// `assertNoNodeReadableAsBothLeafAndBranch`), so each alternative excludes the other's discriminator.
|
|
64
|
+
// The exclusion carries the TYPE the runtime looks for — `isBranch` needs an ARRAY `conditions` and
|
|
65
|
+
// `isLeaf` a STRING `field` — because `{field, operator, conditions: "x"}` is a plain leaf the runtime
|
|
66
|
+
// accepts. Expressed as `not: { required }` rather than `additionalProperties: false`, which would
|
|
67
|
+
// also forbid an unknown extra key the runtime strips.
|
|
68
|
+
function leafShape(field, operators, description) {
|
|
69
|
+
return {
|
|
70
|
+
type: 'object',
|
|
71
|
+
description,
|
|
72
|
+
properties: {
|
|
73
|
+
field,
|
|
74
|
+
operator: { type: 'string', enum: operators },
|
|
75
|
+
value: {},
|
|
76
|
+
},
|
|
77
|
+
required: ['field', 'operator'],
|
|
78
|
+
not: { properties: { conditions: { type: 'array' } }, required: ['conditions'] },
|
|
79
|
+
};
|
|
80
|
+
}
|
|
81
|
+
/**
|
|
82
|
+
* One leaf alternative per operator set. A field absent from `filterable` is in none of them, which is
|
|
83
|
+
* the only honest way to document it: a `ManyToOne` answers 422 field_not_filterable, and a field the
|
|
84
|
+
* collector dropped for an unmappable operator answers 500 mapping_error on every filter.
|
|
85
|
+
*/
|
|
86
|
+
function filterLeaves(pool, plan) {
|
|
87
|
+
const { name, fields } = plan.collection;
|
|
88
|
+
const groups = groupByOperators(fields.filterable);
|
|
89
|
+
// No known filterable field: the field stays free-form and every operator stays allowed, because a
|
|
90
|
+
// collection whose capabilities could not be read still accepts whatever it really exposes.
|
|
91
|
+
if (groups.length === 0) {
|
|
92
|
+
return [
|
|
93
|
+
pool.add(`FilterLeaf_${plan.key}`, leafShape({ type: 'string' }, schemas_1.OPERATORS, `A single condition on ${quoted(name)}.`)),
|
|
94
|
+
];
|
|
95
|
+
}
|
|
96
|
+
// `-` rather than `_` before the index, and the difference is load-bearing: `sanitizeIdentifier` maps
|
|
97
|
+
// every character outside `[A-Za-z0-9_]` to `_`, so a collection key can end in `_<digit>` — either
|
|
98
|
+
// because the customer named a collection `Invoice 1`, or because `createNamer` suffixed a name that
|
|
99
|
+
// collapsed. With `_`, collection `Invoice 1` (no group, so the bare name below) and collection
|
|
100
|
+
// `Invoice` (first group) both claim `FilterLeaf_Invoice_1`, and `ComponentPool.add` settles it
|
|
101
|
+
// last-wins in silence — one collection would document the other's fields and operators. Sanitizing
|
|
102
|
+
// can never produce a `-`, so this separator makes the two namespaces disjoint by construction.
|
|
103
|
+
return groups.map((group, index) => pool.add(`FilterLeaf_${plan.key}-${index + 1}`, leafShape({ type: 'string', enum: group.fields }, group.operators, `A single condition on ${quoted(name)}. These fields share one operator set, as the ` +
|
|
104
|
+
"collection's capabilities report it.")));
|
|
105
|
+
}
|
|
106
|
+
function filterSchema({ pool }, plan) {
|
|
107
|
+
const { name, fields } = plan.collection;
|
|
108
|
+
const treeName = `Filter_${plan.key}`;
|
|
109
|
+
const treeRef = { $ref: `#/components/schemas/${treeName}` };
|
|
110
|
+
const leaves = filterLeaves(pool, plan);
|
|
111
|
+
const pairing = fields.filterable.length > 0
|
|
112
|
+
? ' There is one leaf alternative per operator set: a field accepts only the operators of ' +
|
|
113
|
+
'the alternative listing it, and an operator it does not support answers 400 ' +
|
|
114
|
+
'invalid_filter_operator.'
|
|
115
|
+
: '';
|
|
116
|
+
return pool.add(treeName, {
|
|
117
|
+
description: `A filter on ${quoted(name)}: either a leaf condition or a branch nesting more ` +
|
|
118
|
+
'conditions. A branch must carry its aggregator. A node carrying both `field` and ' +
|
|
119
|
+
`\`conditions\` is rejected with 400, so the two shapes are mutually exclusive.${pairing}`,
|
|
120
|
+
anyOf: [
|
|
121
|
+
...leaves,
|
|
122
|
+
{
|
|
123
|
+
type: 'object',
|
|
124
|
+
properties: {
|
|
125
|
+
aggregator: { type: 'string', enum: AGGREGATORS },
|
|
126
|
+
conditions: { type: 'array', items: treeRef },
|
|
127
|
+
},
|
|
128
|
+
required: ['aggregator', 'conditions'],
|
|
129
|
+
not: { properties: { field: { type: 'string' } }, required: ['field'] },
|
|
130
|
+
},
|
|
131
|
+
],
|
|
132
|
+
});
|
|
133
|
+
}
|
|
134
|
+
function fieldRefs(deps, plan) {
|
|
135
|
+
const { pool } = deps;
|
|
136
|
+
const { name, fields } = plan.collection;
|
|
137
|
+
const projectable = fieldsEnum(pool, `Fields_${plan.key}`, fields.projectable, `A field of ${quoted(name)}.`);
|
|
138
|
+
// Filterable is a strict subset of projectable: the agent reports a ManyToOne without operators, so
|
|
139
|
+
// projecting or sorting on it works while filtering on it answers 422 field_not_filterable. Which is
|
|
140
|
+
// why the filterable fields are not enumerated here but inside the filter leaves, where each one
|
|
141
|
+
// sits next to the operators it actually supports.
|
|
142
|
+
return {
|
|
143
|
+
projectable,
|
|
144
|
+
filter: filterSchema(deps, plan),
|
|
145
|
+
sort: fields.projectable.length === 0
|
|
146
|
+
? pool.reuse('SortClause', schemas_1.SortClauseSchema)
|
|
147
|
+
: pool.add(`SortClause_${plan.key}`, {
|
|
148
|
+
type: 'object',
|
|
149
|
+
description: 'Omitting `direction` sorts ascending.',
|
|
150
|
+
properties: {
|
|
151
|
+
field: projectable,
|
|
152
|
+
direction: { type: 'string', enum: ['asc', 'desc'] },
|
|
153
|
+
},
|
|
154
|
+
required: ['field'],
|
|
155
|
+
}),
|
|
156
|
+
};
|
|
157
|
+
}
|
|
158
|
+
function requestDescription(collection, subject) {
|
|
159
|
+
const note = collection.fields.degraded ? ` ${DEGRADED_NOTE[collection.fields.degraded]}` : '';
|
|
160
|
+
return `${subject}${note}`;
|
|
161
|
+
}
|
|
162
|
+
function registerRequests(deps, plan) {
|
|
163
|
+
const { pool } = deps;
|
|
164
|
+
const { collection, key } = plan;
|
|
165
|
+
const refs = fieldRefs(deps, plan);
|
|
166
|
+
const timezone = pool.reuse('Timezone', schemas_1.TimezoneSchema);
|
|
167
|
+
return {
|
|
168
|
+
list: pool.add(`ListRequest_${key}`, {
|
|
169
|
+
type: 'object',
|
|
170
|
+
description: requestDescription(collection, `Filter, sort and project records of ${quoted(collection.name)}.`),
|
|
171
|
+
properties: {
|
|
172
|
+
filter: refs.filter,
|
|
173
|
+
projection: { type: 'array', items: refs.projectable },
|
|
174
|
+
sort: { type: 'array', items: refs.sort },
|
|
175
|
+
page: pool.reuse('Page', schemas_1.PageSchema),
|
|
176
|
+
timezone,
|
|
177
|
+
},
|
|
178
|
+
}),
|
|
179
|
+
count: pool.add(`CountRequest_${key}`, {
|
|
180
|
+
type: 'object',
|
|
181
|
+
description: requestDescription(collection, `Count records of ${quoted(collection.name)} matching a filter.`),
|
|
182
|
+
properties: { filter: refs.filter, timezone },
|
|
183
|
+
}),
|
|
184
|
+
};
|
|
185
|
+
}
|
|
186
|
+
const PARENT_ID_SHAPE = {
|
|
187
|
+
anyOf: [{ type: 'string', pattern: '\\S' }, { type: 'number' }],
|
|
188
|
+
};
|
|
189
|
+
/**
|
|
190
|
+
* `parentId` is opaque on the wire: `parseParentId` takes a non-blank string or a finite number
|
|
191
|
+
* whatever the key's type is, and forwards it to the agent as a string. So the SHAPE stays that
|
|
192
|
+
* union — narrowing a numeric key to `number` would make a generated client reject `"123"`, which
|
|
193
|
+
* the endpoint accepts. What the read-model knows goes in the description: which column the id
|
|
194
|
+
* belongs to, and, for a composite key, the `|`-joined order `unpackPrimaryKey` expects.
|
|
195
|
+
*/
|
|
196
|
+
function parentIdSchema(pool, parent, primaryKeys) {
|
|
197
|
+
if (primaryKeys.length === 0)
|
|
198
|
+
return pool.reuse('ParentId', schemas_1.ParentIdSchema);
|
|
199
|
+
if (primaryKeys.length > 1) {
|
|
200
|
+
return {
|
|
201
|
+
// A composite id only works as its packed string: a number could never carry the separator.
|
|
202
|
+
type: 'string',
|
|
203
|
+
pattern: '\\S',
|
|
204
|
+
description: `The composite id of the parent ${quoted(parent)} record: the values of ` +
|
|
205
|
+
`${primaryKeys.map(key => key.name).join(', ')} joined by ` +
|
|
206
|
+
`${quoted(pack_id_1.PACKED_ID_SEPARATOR)}, in that order.`,
|
|
207
|
+
};
|
|
208
|
+
}
|
|
209
|
+
const [key] = primaryKeys;
|
|
210
|
+
return {
|
|
211
|
+
...PARENT_ID_SHAPE,
|
|
212
|
+
description: `The parent ${quoted(parent)} record id (${key.name}, ${key.type}). A number or its ` +
|
|
213
|
+
'string form are both accepted; the BFF forwards it to the agent as a string.',
|
|
214
|
+
};
|
|
215
|
+
}
|
|
216
|
+
function registerRelationRequests(deps, plan, relation, relationKey, foreign) {
|
|
217
|
+
const { pool } = deps;
|
|
218
|
+
const parentId = parentIdSchema(pool, plan.collection.name, plan.collection.primaryKeys);
|
|
219
|
+
const parentProperties = {
|
|
220
|
+
type: 'object',
|
|
221
|
+
properties: { parentId },
|
|
222
|
+
required: ['parentId'],
|
|
223
|
+
};
|
|
224
|
+
const description = `Filter, sort and projection apply to ${quoted(foreign.collection.name)}, the foreign ` +
|
|
225
|
+
`collection of ${quoted(plan.collection.name)}.${quoted(relation.name)}; the parent only ` +
|
|
226
|
+
'resolves which records are related.';
|
|
227
|
+
return {
|
|
228
|
+
list: pool.add(`RelationListRequest_${relationKey}`, {
|
|
229
|
+
description,
|
|
230
|
+
allOf: [foreign.requests.list, parentProperties],
|
|
231
|
+
}),
|
|
232
|
+
count: pool.add(`RelationCountRequest_${relationKey}`, {
|
|
233
|
+
description,
|
|
234
|
+
allOf: [foreign.requests.count, parentProperties],
|
|
235
|
+
}),
|
|
236
|
+
};
|
|
237
|
+
}
|
|
238
|
+
function actionFieldSchema(field) {
|
|
239
|
+
const base = field.enums
|
|
240
|
+
? { type: 'string', enum: field.enums }
|
|
241
|
+
: (0, field_schemas_1.default)(field.type);
|
|
242
|
+
return field.isRequired
|
|
243
|
+
? { ...base, description: 'The agent declares this field required on the static form.' }
|
|
244
|
+
: base;
|
|
245
|
+
}
|
|
246
|
+
function actionValuesSchema(action) {
|
|
247
|
+
return {
|
|
248
|
+
type: 'object',
|
|
249
|
+
// No property is required and no additional one is forbidden on purpose: a load or change hook
|
|
250
|
+
// rebuilds the form at call time, so the schema's static fields are an indication, not the
|
|
251
|
+
// contract — and the read-model cannot tell a hookless action from a legacy schema that simply
|
|
252
|
+
// omitted its hooks, so "static" is never certain.
|
|
253
|
+
description: 'The submitted action fields. These are the fields the schema declares statically; a load ' +
|
|
254
|
+
'or change hook can add, drop or require others at call time.',
|
|
255
|
+
properties: Object.fromEntries(action.fields.map(field => [field.name, actionFieldSchema(field)])),
|
|
256
|
+
};
|
|
257
|
+
}
|
|
258
|
+
function registerActionRequest(deps, plan, action, actionKey) {
|
|
259
|
+
const { pool } = deps;
|
|
260
|
+
return pool.add(`ActionRequest_${actionKey}`, {
|
|
261
|
+
type: 'object',
|
|
262
|
+
description: `The body of action ${quoted(action.name)} on ${quoted(plan.collection.name)}. ` +
|
|
263
|
+
'`recordIds` is required even on a global action: send an empty array when the action ' +
|
|
264
|
+
'targets no record.',
|
|
265
|
+
properties: {
|
|
266
|
+
recordIds: { type: 'array', items: { anyOf: [{ type: 'string' }, { type: 'number' }] } },
|
|
267
|
+
values: actionValuesSchema(action),
|
|
268
|
+
timezone: pool.reuse('Timezone', schemas_1.TimezoneSchema),
|
|
269
|
+
},
|
|
270
|
+
required: ['recordIds'],
|
|
271
|
+
});
|
|
272
|
+
}
|
|
273
|
+
function registerOperation(deps, options) {
|
|
274
|
+
deps.registry.registerPath({
|
|
275
|
+
method: 'post',
|
|
276
|
+
path: `${deps.prefix}/${options.path}`,
|
|
277
|
+
operationId: options.operationId,
|
|
278
|
+
summary: options.summary,
|
|
279
|
+
description: options.description,
|
|
280
|
+
security: deps.security,
|
|
281
|
+
request: {
|
|
282
|
+
headers: deps.timezoneHeader,
|
|
283
|
+
body: {
|
|
284
|
+
required: options.bodyRequired,
|
|
285
|
+
content: { 'application/json': { schema: options.request } },
|
|
286
|
+
},
|
|
287
|
+
},
|
|
288
|
+
responses: {
|
|
289
|
+
200: {
|
|
290
|
+
description: options.responseDescription,
|
|
291
|
+
content: { 'application/json': { schema: options.response } },
|
|
292
|
+
},
|
|
293
|
+
...deps.errorResponses(options.executeResults === true),
|
|
294
|
+
},
|
|
295
|
+
});
|
|
296
|
+
}
|
|
297
|
+
function registerCollectionOperations(deps, plan) {
|
|
298
|
+
const { pool } = deps;
|
|
299
|
+
const { name } = plan.collection;
|
|
300
|
+
const listResponse = pool.reuse('ListResponse', schemas_1.ListResponseSchema);
|
|
301
|
+
const countResponse = pool.reuse('CountResponse', schemas_1.CountResponseSchema);
|
|
302
|
+
registerOperation(deps, {
|
|
303
|
+
path: `${segment(name)}/list`,
|
|
304
|
+
operationId: `listRecords_${plan.key}`,
|
|
305
|
+
summary: `List records of ${name}`,
|
|
306
|
+
description: `Lists records of the ${quoted(name)} collection.`,
|
|
307
|
+
request: plan.requests.list,
|
|
308
|
+
response: listResponse,
|
|
309
|
+
responseDescription: `A page of ${quoted(name)} records`,
|
|
310
|
+
bodyRequired: false,
|
|
311
|
+
});
|
|
312
|
+
registerOperation(deps, {
|
|
313
|
+
path: `${segment(name)}/count`,
|
|
314
|
+
operationId: `countRecords_${plan.key}`,
|
|
315
|
+
summary: `Count records of ${name}`,
|
|
316
|
+
description: `Counts records of the ${quoted(name)} collection.`,
|
|
317
|
+
request: plan.requests.count,
|
|
318
|
+
response: countResponse,
|
|
319
|
+
responseDescription: `The matching ${quoted(name)} record count`,
|
|
320
|
+
bodyRequired: false,
|
|
321
|
+
});
|
|
322
|
+
}
|
|
323
|
+
function registerRelationOperations(deps, plan, plansByName, namer) {
|
|
324
|
+
const { pool } = deps;
|
|
325
|
+
plan.collection.relations.forEach(relation => {
|
|
326
|
+
const foreign = plansByName.get(relation.foreignCollection);
|
|
327
|
+
if (!foreign)
|
|
328
|
+
return;
|
|
329
|
+
const relationKey = namer(`${plan.key}_${relation.name}`);
|
|
330
|
+
const requests = registerRelationRequests(deps, plan, relation, relationKey, foreign);
|
|
331
|
+
const parent = `${quoted(plan.collection.name)}.${quoted(relation.name)}`;
|
|
332
|
+
registerOperation(deps, {
|
|
333
|
+
path: `${segment(plan.collection.name)}/relations/${segment(relation.name)}/list`,
|
|
334
|
+
operationId: `listRelatedRecords_${relationKey}`,
|
|
335
|
+
summary: `List ${relation.name} of ${plan.collection.name}`,
|
|
336
|
+
description: `Lists the ${quoted(foreign.collection.name)} records related to a ${quoted(plan.collection.name)} record through ${parent}.`,
|
|
337
|
+
request: requests.list,
|
|
338
|
+
response: pool.reuse('ListResponse', schemas_1.ListResponseSchema),
|
|
339
|
+
responseDescription: `A page of related ${quoted(foreign.collection.name)} records`,
|
|
340
|
+
bodyRequired: true,
|
|
341
|
+
});
|
|
342
|
+
registerOperation(deps, {
|
|
343
|
+
path: `${segment(plan.collection.name)}/relations/${segment(relation.name)}/count`,
|
|
344
|
+
operationId: `countRelatedRecords_${relationKey}`,
|
|
345
|
+
summary: `Count ${relation.name} of ${plan.collection.name}`,
|
|
346
|
+
description: `Counts the ${quoted(foreign.collection.name)} records related through ${parent}.`,
|
|
347
|
+
request: requests.count,
|
|
348
|
+
response: pool.reuse('CountResponse', schemas_1.CountResponseSchema),
|
|
349
|
+
responseDescription: `The matching related ${quoted(foreign.collection.name)} record count`,
|
|
350
|
+
bodyRequired: true,
|
|
351
|
+
});
|
|
352
|
+
});
|
|
353
|
+
}
|
|
354
|
+
function registerActionOperations(deps, plan, namer) {
|
|
355
|
+
plan.collection.actions.forEach(action => {
|
|
356
|
+
const actionKey = namer(`${plan.key}_${action.name}`);
|
|
357
|
+
const request = registerActionRequest(deps, plan, action, actionKey);
|
|
358
|
+
// The path segment is the exact schema action name, URL-encoded — that is what the middleware
|
|
359
|
+
// decodes and looks up. The operationId is sanitized, so the exact name lives in prose.
|
|
360
|
+
const identity = `The action name is exactly ${quoted(action.name)}.`;
|
|
361
|
+
const base = `${segment(plan.collection.name)}/actions/${segment(action.name)}`;
|
|
362
|
+
registerOperation(deps, {
|
|
363
|
+
path: `${base}/form`,
|
|
364
|
+
operationId: `getActionForm_${actionKey}`,
|
|
365
|
+
summary: `Load the form of ${action.name} on ${plan.collection.name}`,
|
|
366
|
+
description: `Loads the form of the custom action. ${identity} An unknown submitted field is skipped here, not rejected.`,
|
|
367
|
+
request,
|
|
368
|
+
response: {},
|
|
369
|
+
responseDescription: 'The action form fields',
|
|
370
|
+
bodyRequired: true,
|
|
371
|
+
});
|
|
372
|
+
registerOperation(deps, {
|
|
373
|
+
path: `${base}/execute`,
|
|
374
|
+
operationId: `executeAction_${actionKey}`,
|
|
375
|
+
summary: `Execute ${action.name} on ${plan.collection.name}`,
|
|
376
|
+
description: `Executes the custom action. ${identity} A submitted field the loaded form does not carry is rejected with 400.`,
|
|
377
|
+
request,
|
|
378
|
+
response: {},
|
|
379
|
+
responseDescription: 'The normalized action result',
|
|
380
|
+
bodyRequired: true,
|
|
381
|
+
executeResults: true,
|
|
382
|
+
});
|
|
383
|
+
});
|
|
384
|
+
}
|
|
385
|
+
/**
|
|
386
|
+
* Emits one path per exposed collection, to-many relation and action. The runtime routes stay the
|
|
387
|
+
* generic regexes — only the document unfolds.
|
|
388
|
+
*/
|
|
389
|
+
function registerUnfoldedPaths(deps, unfolding) {
|
|
390
|
+
// One namer per identifier family, fed the WHOLE composed name. Deduplicating each segment on its
|
|
391
|
+
// own would not be enough: sanitizing produces `_`, which is also the separator, so collection
|
|
392
|
+
// `A_B` with action `C` and collection `A` with action `B_C` both compose `A_B_C` — one action
|
|
393
|
+
// would then get the other's request schema.
|
|
394
|
+
const collections = (0, names_1.default)();
|
|
395
|
+
const relations = (0, names_1.default)();
|
|
396
|
+
const actions = (0, names_1.default)();
|
|
397
|
+
const plans = unfolding.collections.map(collection => {
|
|
398
|
+
const key = collections(collection.name);
|
|
399
|
+
return { collection, key, requests: registerRequests(deps, { collection, key }) };
|
|
400
|
+
});
|
|
401
|
+
const plansByName = new Map(plans.map(plan => [plan.collection.name, plan]));
|
|
402
|
+
plans.forEach(plan => {
|
|
403
|
+
registerCollectionOperations(deps, plan);
|
|
404
|
+
registerRelationOperations(deps, plan, plansByName, relations);
|
|
405
|
+
registerActionOperations(deps, plan, actions);
|
|
406
|
+
});
|
|
407
|
+
}
|
|
408
|
+
//# sourceMappingURL=data:application/json;base64,{"version":3,"file":"unfolded-paths.js","sourceRoot":"","sources":["../../src/openapi/unfolded-paths.ts"],"names":[],"mappings":";;;;;AAkjBA,wCAqBC;AAxjBD,oEAA4C;AAC5C,oDAAkC;AAClC,uCAQmB;AACnB,6CAAsD;AAEtD,MAAM,WAAW,GAAG,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;AAElC,MAAM,aAAa,GAA8D;IAC/E,wBAAwB,EACtB,iFAAiF;QACjF,yFAAyF;QACzF,4BAA4B;IAC9B,SAAS,EACP,0FAA0F;QAC1F,4FAA4F;QAC5F,gEAAgE;CACnE,CAAC;AAsBF,SAAS,MAAM,CAAC,IAAY;IAC1B,OAAO,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;AAC9B,CAAC;AAED,iGAAiG;AACjG,mGAAmG;AACnG,6CAA6C;AAC7C,SAAS,OAAO,CAAC,IAAY;IAC3B,OAAO,kBAAkB,CAAC,IAAI,CAAC,CAAC;AAClC,CAAC;AAED,SAAS,UAAU,CACjB,IAAmB,EACnB,IAAY,EACZ,MAAgB,EAChB,WAAmB;IAEnB,gGAAgG;IAChG,oFAAoF;IACpF,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC;IAEnD,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM,EAAE,WAAW,EAAE,CAAC,CAAC;AACvE,CAAC;AAOD;;;;;;;GAOG;AACH,SAAS,gBAAgB,CAAC,UAA6B;IACrD,MAAM,MAAM,GAAG,IAAI,GAAG,EAAyB,CAAC;IAEhD,UAAU,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE;QACzB,mGAAmG;QACnG,oGAAoG;QACpG,gGAAgG;QAChG,IAAI,KAAK,CAAC,SAAS,CAAC,MAAM,KAAK,CAAC;YAAE,OAAO;QAEzC,6FAA6F;QAC7F,MAAM,SAAS,GAAG,KAAK,CAAC,SAAS,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAC5C,MAAM,KAAK,GAAG,MAAM,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;QAEpC,IAAI,KAAK;YAAE,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;;YACpC,MAAM,CAAC,GAAG,CAAC,SAAS,EAAE,EAAE,MAAM,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,SAAS,EAAE,CAAC,GAAG,KAAK,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC;IACxF,CAAC,CAAC,CAAC;IAEH,OAAO,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC;AAC9B,CAAC;AAED,qFAAqF;AACrF,sGAAsG;AACtG,oGAAoG;AACpG,uGAAuG;AACvG,mGAAmG;AACnG,uDAAuD;AACvD,SAAS,SAAS,CAChB,KAAqC,EACrC,SAAmB,EACnB,WAAmB;IAEnB,OAAO;QACL,IAAI,EAAE,QAAQ;QACd,WAAW;QACX,UAAU,EAAE;YACV,KAAK;YACL,QAAQ,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,SAAS,EAAE;YAC7C,KAAK,EAAE,EAAE;SACV;QACD,QAAQ,EAAE,CAAC,OAAO,EAAE,UAAU,CAAC;QAC/B,GAAG,EAAE,EAAE,UAAU,EAAE,EAAE,UAAU,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,EAAE,EAAE,QAAQ,EAAE,CAAC,YAAY,CAAC,EAAE;KACjF,CAAC;AACJ,CAAC;AAED;;;;GAIG;AACH,SAAS,YAAY,CAAC,IAAmB,EAAE,IAAgD;IACzF,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC,UAAU,CAAC;IACzC,MAAM,MAAM,GAAG,gBAAgB,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;IAEnD,mGAAmG;IACnG,4FAA4F;IAC5F,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACxB,OAAO;YACL,IAAI,CAAC,GAAG,CACN,cAAc,IAAI,CAAC,GAAG,EAAE,EACxB,SAAS,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,EAAE,mBAAS,EAAE,yBAAyB,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CACnF;SACF,CAAC;IACJ,CAAC;IAED,sGAAsG;IACtG,oGAAoG;IACpG,qGAAqG;IACrG,gGAAgG;IAChG,gGAAgG;IAChG,oGAAoG;IACpG,gGAAgG;IAChG,OAAO,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,KAAK,EAAE,EAAE,CACjC,IAAI,CAAC,GAAG,CACN,cAAc,IAAI,CAAC,GAAG,IAAI,KAAK,GAAG,CAAC,EAAE,EACrC,SAAS,CACP,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,KAAK,CAAC,MAAM,EAAE,EACtC,KAAK,CAAC,SAAS,EACf,yBAAyB,MAAM,CAAC,IAAI,CAAC,gDAAgD;QACnF,sCAAsC,CACzC,CACF,CACF,CAAC;AACJ,CAAC;AAED,SAAS,YAAY,CACnB,EAAE,IAAI,EAAQ,EACd,IAAgD;IAEhD,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC,UAAU,CAAC;IACzC,MAAM,QAAQ,GAAG,UAAU,IAAI,CAAC,GAAG,EAAE,CAAC;IACtC,MAAM,OAAO,GAAG,EAAE,IAAI,EAAE,wBAAwB,QAAQ,EAAE,EAAE,CAAC;IAC7D,MAAM,MAAM,GAAG,YAAY,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;IACxC,MAAM,OAAO,GACX,MAAM,CAAC,UAAU,CAAC,MAAM,GAAG,CAAC;QAC1B,CAAC,CAAC,yFAAyF;YACzF,8EAA8E;YAC9E,0BAA0B;QAC5B,CAAC,CAAC,EAAE,CAAC;IAET,OAAO,IAAI,CAAC,GAAG,CAAC,QAAQ,EAAE;QACxB,WAAW,EACT,eAAe,MAAM,CAAC,IAAI,CAAC,qDAAqD;YAChF,mFAAmF;YACnF,iFAAiF,OAAO,EAAE;QAC5F,KAAK,EAAE;YACL,GAAG,MAAM;YACT;gBACE,IAAI,EAAE,QAAQ;gBACd,UAAU,EAAE;oBACV,UAAU,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,WAAW,EAAE;oBACjD,UAAU,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE;iBAC9C;gBACD,QAAQ,EAAE,CAAC,YAAY,EAAE,YAAY,CAAC;gBACtC,GAAG,EAAE,EAAE,UAAU,EAAE,EAAE,KAAK,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,EAAE,EAAE,QAAQ,EAAE,CAAC,OAAO,CAAC,EAAE;aACxE;SACF;KACF,CAAC,CAAC;AACL,CAAC;AAQD,SAAS,SAAS,CAAC,IAAU,EAAE,IAAgD;IAC7E,MAAM,EAAE,IAAI,EAAE,GAAG,IAAI,CAAC;IACtB,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC,UAAU,CAAC;IAEzC,MAAM,WAAW,GAAG,UAAU,CAC5B,IAAI,EACJ,UAAU,IAAI,CAAC,GAAG,EAAE,EACpB,MAAM,CAAC,WAAW,EAClB,cAAc,MAAM,CAAC,IAAI,CAAC,GAAG,CAC9B,CAAC;IAEF,oGAAoG;IACpG,qGAAqG;IACrG,iGAAiG;IACjG,mDAAmD;IACnD,OAAO;QACL,WAAW;QACX,MAAM,EAAE,YAAY,CAAC,IAAI,EAAE,IAAI,CAAC;QAChC,IAAI,EACF,MAAM,CAAC,WAAW,CAAC,MAAM,KAAK,CAAC;YAC7B,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,YAAY,EAAE,0BAAgB,CAAC;YAC5C,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,cAAc,IAAI,CAAC,GAAG,EAAE,EAAE;gBACjC,IAAI,EAAE,QAAQ;gBACd,WAAW,EAAE,uCAAuC;gBACpD,UAAU,EAAE;oBACV,KAAK,EAAE,WAAW;oBAClB,SAAS,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC,KAAK,EAAE,MAAM,CAAC,EAAE;iBACrD;gBACD,QAAQ,EAAE,CAAC,OAAO,CAAC;aACpB,CAAC;KACT,CAAC;AACJ,CAAC;AAED,SAAS,kBAAkB,CAAC,UAA8B,EAAE,OAAe;IACzE,MAAM,IAAI,GAAG,UAAU,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,aAAa,CAAC,UAAU,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;IAE/F,OAAO,GAAG,OAAO,GAAG,IAAI,EAAE,CAAC;AAC7B,CAAC;AAED,SAAS,gBAAgB,CAAC,IAAU,EAAE,IAAsC;IAC1E,MAAM,EAAE,IAAI,EAAE,GAAG,IAAI,CAAC;IACtB,MAAM,EAAE,UAAU,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC;IACjC,MAAM,IAAI,GAAG,SAAS,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;IACnC,MAAM,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,UAAU,EAAE,wBAAc,CAAC,CAAC;IAExD,OAAO;QACL,IAAI,EAAE,IAAI,CAAC,GAAG,CAAC,eAAe,GAAG,EAAE,EAAE;YACnC,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,kBAAkB,CAC7B,UAAU,EACV,uCAAuC,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC,GAAG,CAClE;YACD,UAAU,EAAE;gBACV,MAAM,EAAE,IAAI,CAAC,MAAM;gBACnB,UAAU,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,IAAI,CAAC,WAAW,EAAE;gBACtD,IAAI,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,IAAI,CAAC,IAAI,EAAE;gBACzC,IAAI,EAAE,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,oBAAU,CAAC;gBACpC,QAAQ;aACT;SACF,CAAC;QACF,KAAK,EAAE,IAAI,CAAC,GAAG,CAAC,gBAAgB,GAAG,EAAE,EAAE;YACrC,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,kBAAkB,CAC7B,UAAU,EACV,oBAAoB,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC,qBAAqB,CACjE;YACD,UAAU,EAAE,EAAE,MAAM,EAAE,IAAI,CAAC,MAAM,EAAE,QAAQ,EAAE;SAC9C,CAAC;KACH,CAAC;AACJ,CAAC;AAED,MAAM,eAAe,GAAG;IACtB,KAAK,EAAE,CAAC,EAAE,IAAI,EAAE,QAAiB,EAAE,OAAO,EAAE,KAAK,EAAE,EAAE,EAAE,IAAI,EAAE,QAAiB,EAAE,CAAC;CAClF,CAAC;AAEF;;;;;;GAMG;AACH,SAAS,cAAc,CACrB,IAAmB,EACnB,MAAc,EACd,WAA8B;IAE9B,IAAI,WAAW,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,IAAI,CAAC,KAAK,CAAC,UAAU,EAAE,wBAAc,CAAC,CAAC;IAE5E,IAAI,WAAW,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC3B,OAAO;YACL,4FAA4F;YAC5F,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,KAAK;YACd,WAAW,EACT,kCAAkC,MAAM,CAAC,MAAM,CAAC,yBAAyB;gBACzE,GAAG,WAAW,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,aAAa;gBAC3D,GAAG,MAAM,CAAC,6BAAmB,CAAC,kBAAkB;SACnD,CAAC;IACJ,CAAC;IAED,MAAM,CAAC,GAAG,CAAC,GAAG,WAAW,CAAC;IAE1B,OAAO;QACL,GAAG,eAAe;QAClB,WAAW,EACT,cAAc,MAAM,CAAC,MAAM,CAAC,eAAe,GAAG,CAAC,IAAI,KAAK,GAAG,CAAC,IAAI,qBAAqB;YACrF,8EAA8E;KACjF,CAAC;AACJ,CAAC;AAED,SAAS,wBAAwB,CAC/B,IAAU,EACV,IAAoB,EACpB,QAA0B,EAC1B,WAAmB,EACnB,OAAuB;IAEvB,MAAM,EAAE,IAAI,EAAE,GAAG,IAAI,CAAC;IACtB,MAAM,QAAQ,GAAG,cAAc,CAAC,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;IACzF,MAAM,gBAAgB,GAAG;QACvB,IAAI,EAAE,QAAiB;QACvB,UAAU,EAAE,EAAE,QAAQ,EAAE;QACxB,QAAQ,EAAE,CAAC,UAAU,CAAC;KACvB,CAAC;IACF,MAAM,WAAW,GACf,wCAAwC,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,IAAI,CAAC,gBAAgB;QACvF,iBAAiB,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,oBAAoB;QAC1F,qCAAqC,CAAC;IAExC,OAAO;QACL,IAAI,EAAE,IAAI,CAAC,GAAG,CAAC,uBAAuB,WAAW,EAAE,EAAE;YACnD,WAAW;YACX,KAAK,EAAE,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,EAAE,gBAAgB,CAAC;SACjD,CAAC;QACF,KAAK,EAAE,IAAI,CAAC,GAAG,CAAC,wBAAwB,WAAW,EAAE,EAAE;YACrD,WAAW;YACX,KAAK,EAAE,CAAC,OAAO,CAAC,QAAQ,CAAC,KAAK,EAAE,gBAAgB,CAAC;SAClD,CAAC;KACH,CAAC;AACJ,CAAC;AAED,SAAS,iBAAiB,CAAC,KAAuC;IAChE,MAAM,IAAI,GAAG,KAAK,CAAC,KAAK;QACtB,CAAC,CAAC,EAAE,IAAI,EAAE,QAAiB,EAAE,IAAI,EAAE,KAAK,CAAC,KAAK,EAAE;QAChD,CAAC,CAAC,IAAA,uBAAa,EAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IAE9B,OAAO,KAAK,CAAC,UAAU;QACrB,CAAC,CAAC,EAAE,GAAG,IAAI,EAAE,WAAW,EAAE,4DAA4D,EAAE;QACxF,CAAC,CAAC,IAAI,CAAC;AACX,CAAC;AAED,SAAS,kBAAkB,CAAC,MAAsB;IAChD,OAAO;QACL,IAAI,EAAE,QAAQ;QACd,+FAA+F;QAC/F,2FAA2F;QAC3F,+FAA+F;QAC/F,mDAAmD;QACnD,WAAW,EACT,2FAA2F;YAC3F,8DAA8D;QAChE,UAAU,EAAE,MAAM,CAAC,WAAW,CAC5B,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,KAAK,CAAC,IAAI,EAAE,iBAAiB,CAAC,KAAK,CAAC,CAAC,CAAC,CACnE;KACF,CAAC;AACJ,CAAC;AAED,SAAS,qBAAqB,CAC5B,IAAU,EACV,IAAoB,EACpB,MAAsB,EACtB,SAAiB;IAEjB,MAAM,EAAE,IAAI,EAAE,GAAG,IAAI,CAAC;IAEtB,OAAO,IAAI,CAAC,GAAG,CAAC,iBAAiB,SAAS,EAAE,EAAE;QAC5C,IAAI,EAAE,QAAQ;QACd,WAAW,EACT,sBAAsB,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI;YAChF,uFAAuF;YACvF,oBAAoB;QACtB,UAAU,EAAE;YACV,SAAS,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC,EAAE,EAAE;YACxF,MAAM,EAAE,kBAAkB,CAAC,MAAM,CAAC;YAClC,QAAQ,EAAE,IAAI,CAAC,KAAK,CAAC,UAAU,EAAE,wBAAc,CAAC;SACjD;QACD,QAAQ,EAAE,CAAC,WAAW,CAAC;KACxB,CAAC,CAAC;AACL,CAAC;AAcD,SAAS,iBAAiB,CAAC,IAAU,EAAE,OAAyB;IAC9D,IAAI,CAAC,QAAQ,CAAC,YAAY,CAAC;QACzB,MAAM,EAAE,MAAM;QACd,IAAI,EAAE,GAAG,IAAI,CAAC,MAAM,IAAI,OAAO,CAAC,IAAI,EAAE;QACtC,WAAW,EAAE,OAAO,CAAC,WAAW;QAChC,OAAO,EAAE,OAAO,CAAC,OAAO;QACxB,WAAW,EAAE,OAAO,CAAC,WAAW;QAChC,QAAQ,EAAE,IAAI,CAAC,QAAQ;QACvB,OAAO,EAAE;YACP,OAAO,EAAE,IAAI,CAAC,cAAc;YAC5B,IAAI,EAAE;gBACJ,QAAQ,EAAE,OAAO,CAAC,YAAY;gBAC9B,OAAO,EAAE,EAAE,kBAAkB,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,OAAO,EAAE,EAAE;aAC7D;SACF;QACD,SAAS,EAAE;YACT,GAAG,EAAE;gBACH,WAAW,EAAE,OAAO,CAAC,mBAAmB;gBACxC,OAAO,EAAE,EAAE,kBAAkB,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,QAAQ,EAAE,EAAE;aAC9D;YACD,GAAG,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,cAAc,KAAK,IAAI,CAAC;SACxD;KACF,CAAC,CAAC;AACL,CAAC;AAED,SAAS,4BAA4B,CAAC,IAAU,EAAE,IAAoB;IACpE,MAAM,EAAE,IAAI,EAAE,GAAG,IAAI,CAAC;IACtB,MAAM,EAAE,IAAI,EAAE,GAAG,IAAI,CAAC,UAAU,CAAC;IACjC,MAAM,YAAY,GAAG,IAAI,CAAC,KAAK,CAAC,cAAc,EAAE,4BAAkB,CAAC,CAAC;IACpE,MAAM,aAAa,GAAG,IAAI,CAAC,KAAK,CAAC,eAAe,EAAE,6BAAmB,CAAC,CAAC;IAEvE,iBAAiB,CAAC,IAAI,EAAE;QACtB,IAAI,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,OAAO;QAC7B,WAAW,EAAE,eAAe,IAAI,CAAC,GAAG,EAAE;QACtC,OAAO,EAAE,mBAAmB,IAAI,EAAE;QAClC,WAAW,EAAE,wBAAwB,MAAM,CAAC,IAAI,CAAC,cAAc;QAC/D,OAAO,EAAE,IAAI,CAAC,QAAQ,CAAC,IAAI;QAC3B,QAAQ,EAAE,YAAY;QACtB,mBAAmB,EAAE,aAAa,MAAM,CAAC,IAAI,CAAC,UAAU;QACxD,YAAY,EAAE,KAAK;KACpB,CAAC,CAAC;IAEH,iBAAiB,CAAC,IAAI,EAAE;QACtB,IAAI,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,QAAQ;QAC9B,WAAW,EAAE,gBAAgB,IAAI,CAAC,GAAG,EAAE;QACvC,OAAO,EAAE,oBAAoB,IAAI,EAAE;QACnC,WAAW,EAAE,yBAAyB,MAAM,CAAC,IAAI,CAAC,cAAc;QAChE,OAAO,EAAE,IAAI,CAAC,QAAQ,CAAC,KAAK;QAC5B,QAAQ,EAAE,aAAa;QACvB,mBAAmB,EAAE,gBAAgB,MAAM,CAAC,IAAI,CAAC,eAAe;QAChE,YAAY,EAAE,KAAK;KACpB,CAAC,CAAC;AACL,CAAC;AAED,SAAS,0BAA0B,CACjC,IAAU,EACV,IAAoB,EACpB,WAAwC,EACxC,KAAY;IAEZ,MAAM,EAAE,IAAI,EAAE,GAAG,IAAI,CAAC;IAEtB,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE;QAC3C,MAAM,OAAO,GAAG,WAAW,CAAC,GAAG,CAAC,QAAQ,CAAC,iBAAiB,CAAC,CAAC;QAC5D,IAAI,CAAC,OAAO;YAAE,OAAO;QAErB,MAAM,WAAW,GAAG,KAAK,CAAC,GAAG,IAAI,CAAC,GAAG,IAAI,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAC;QAC1D,MAAM,QAAQ,GAAG,wBAAwB,CAAC,IAAI,EAAE,IAAI,EAAE,QAAQ,EAAE,WAAW,EAAE,OAAO,CAAC,CAAC;QACtF,MAAM,MAAM,GAAG,GAAG,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;QAE1E,iBAAiB,CAAC,IAAI,EAAE;YACtB,IAAI,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,cAAc,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO;YACjF,WAAW,EAAE,sBAAsB,WAAW,EAAE;YAChD,OAAO,EAAE,QAAQ,QAAQ,CAAC,IAAI,OAAO,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE;YAC3D,WAAW,EAAE,aAAa,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,IAAI,CAAC,yBAAyB,MAAM,CACtF,IAAI,CAAC,UAAU,CAAC,IAAI,CACrB,mBAAmB,MAAM,GAAG;YAC7B,OAAO,EAAE,QAAQ,CAAC,IAAI;YACtB,QAAQ,EAAE,IAAI,CAAC,KAAK,CAAC,cAAc,EAAE,4BAAkB,CAAC;YACxD,mBAAmB,EAAE,qBAAqB,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,IAAI,CAAC,UAAU;YACnF,YAAY,EAAE,IAAI;SACnB,CAAC,CAAC;QAEH,iBAAiB,CAAC,IAAI,EAAE;YACtB,IAAI,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,cAAc,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ;YAClF,WAAW,EAAE,uBAAuB,WAAW,EAAE;YACjD,OAAO,EAAE,SAAS,QAAQ,CAAC,IAAI,OAAO,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE;YAC5D,WAAW,EAAE,cAAc,MAAM,CAC/B,OAAO,CAAC,UAAU,CAAC,IAAI,CACxB,4BAA4B,MAAM,GAAG;YACtC,OAAO,EAAE,QAAQ,CAAC,KAAK;YACvB,QAAQ,EAAE,IAAI,CAAC,KAAK,CAAC,eAAe,EAAE,6BAAmB,CAAC;YAC1D,mBAAmB,EAAE,wBAAwB,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,IAAI,CAAC,eAAe;YAC3F,YAAY,EAAE,IAAI;SACnB,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC;AAED,SAAS,wBAAwB,CAAC,IAAU,EAAE,IAAoB,EAAE,KAAY;IAC9E,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE;QACvC,MAAM,SAAS,GAAG,KAAK,CAAC,GAAG,IAAI,CAAC,GAAG,IAAI,MAAM,CAAC,IAAI,EAAE,CAAC,CAAC;QACtD,MAAM,OAAO,GAAG,qBAAqB,CAAC,IAAI,EAAE,IAAI,EAAE,MAAM,EAAE,SAAS,CAAC,CAAC;QACrE,8FAA8F;QAC9F,wFAAwF;QACxF,MAAM,QAAQ,GAAG,8BAA8B,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC;QACtE,MAAM,IAAI,GAAG,GAAG,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,YAAY,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC;QAEhF,iBAAiB,CAAC,IAAI,EAAE;YACtB,IAAI,EAAE,GAAG,IAAI,OAAO;YACpB,WAAW,EAAE,iBAAiB,SAAS,EAAE;YACzC,OAAO,EAAE,oBAAoB,MAAM,CAAC,IAAI,OAAO,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE;YACrE,WAAW,EAAE,wCAAwC,QAAQ,4DAA4D;YACzH,OAAO;YACP,QAAQ,EAAE,EAAE;YACZ,mBAAmB,EAAE,wBAAwB;YAC7C,YAAY,EAAE,IAAI;SACnB,CAAC,CAAC;QAEH,iBAAiB,CAAC,IAAI,EAAE;YACtB,IAAI,EAAE,GAAG,IAAI,UAAU;YACvB,WAAW,EAAE,iBAAiB,SAAS,EAAE;YACzC,OAAO,EAAE,WAAW,MAAM,CAAC,IAAI,OAAO,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE;YAC5D,WAAW,EAAE,+BAA+B,QAAQ,yEAAyE;YAC7H,OAAO;YACP,QAAQ,EAAE,EAAE;YACZ,mBAAmB,EAAE,8BAA8B;YACnD,YAAY,EAAE,IAAI;YAClB,cAAc,EAAE,IAAI;SACrB,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC;AAED;;;GAGG;AACH,SAAwB,qBAAqB,CAAC,IAAU,EAAE,SAAoB;IAC5E,kGAAkG;IAClG,+FAA+F;IAC/F,+FAA+F;IAC/F,6CAA6C;IAC7C,MAAM,WAAW,GAAG,IAAA,eAAW,GAAE,CAAC;IAClC,MAAM,SAAS,GAAG,IAAA,eAAW,GAAE,CAAC;IAChC,MAAM,OAAO,GAAG,IAAA,eAAW,GAAE,CAAC;IAE9B,MAAM,KAAK,GAAG,SAAS,CAAC,WAAW,CAAC,GAAG,CAAC,UAAU,CAAC,EAAE;QACnD,MAAM,GAAG,GAAG,WAAW,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;QAEzC,OAAO,EAAE,UAAU,EAAE,GAAG,EAAE,QAAQ,EAAE,gBAAgB,CAAC,IAAI,EAAE,EAAE,UAAU,EAAE,GAAG,EAAE,CAAC,EAAE,CAAC;IACpF,CAAC,CAAC,CAAC;IACH,MAAM,WAAW,GAAG,IAAI,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC;IAE7E,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE;QACnB,4BAA4B,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QACzC,0BAA0B,CAAC,IAAI,EAAE,IAAI,EAAE,WAAW,EAAE,SAAS,CAAC,CAAC;QAC/D,wBAAwB,CAAC,IAAI,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;IAChD,CAAC,CAAC,CAAC;AACL,CAAC"}
|
|
@@ -0,0 +1,66 @@
|
|
|
1
|
+
import type { FieldType } from '../read-model/capabilities-cache';
|
|
2
|
+
import type { PrimaryKeyField } from '../read-model/read-model';
|
|
3
|
+
import type { Operator } from '@forestadmin/datasource-toolkit';
|
|
4
|
+
/**
|
|
5
|
+
* The snapshot the OpenAPI generator unfolds. It is plain data on purpose: collecting it hits the
|
|
6
|
+
* network (schema + capabilities per collection), generating from it does not, so the route and the
|
|
7
|
+
* CLI can be proven to emit the same document by feeding them one snapshot.
|
|
8
|
+
*/
|
|
9
|
+
export interface Unfolding {
|
|
10
|
+
collections: UnfoldedCollection[];
|
|
11
|
+
}
|
|
12
|
+
export interface UnfoldedCollection {
|
|
13
|
+
name: string;
|
|
14
|
+
fields: CollectionFields;
|
|
15
|
+
primaryKeys: PrimaryKeyField[];
|
|
16
|
+
/** To-many relations whose foreign collection is exposed too — the only ones with a route. */
|
|
17
|
+
relations: UnfoldedRelation[];
|
|
18
|
+
actions: UnfoldedAction[];
|
|
19
|
+
}
|
|
20
|
+
export interface UnfoldedRelation {
|
|
21
|
+
name: string;
|
|
22
|
+
foreignCollection: string;
|
|
23
|
+
}
|
|
24
|
+
/**
|
|
25
|
+
* `projectable` is every capability field; `filterable` is the subset carrying operators. They
|
|
26
|
+
* differ: a `ManyToOne` is reported by the agent without operators, so projecting or sorting on it
|
|
27
|
+
* works while filtering on it answers 422 field_not_filterable.
|
|
28
|
+
*
|
|
29
|
+
* `degraded` is set when the field set could not be established. The collection keeps its paths, but
|
|
30
|
+
* their field schemas stay free-form strings — an empty enum would forbid every valid call.
|
|
31
|
+
*/
|
|
32
|
+
export interface CollectionFields {
|
|
33
|
+
projectable: string[];
|
|
34
|
+
filterable: FilterableField[];
|
|
35
|
+
degraded: DegradedReason | null;
|
|
36
|
+
}
|
|
37
|
+
/**
|
|
38
|
+
* A field the agent reports at least one operator for, with that operator set — the very set the
|
|
39
|
+
* runtime validates a filter leaf against. Normalized to canonical PascalCase and to the
|
|
40
|
+
* `allOperators` order at collect time, so the same capabilities answer always yields the same
|
|
41
|
+
* document whatever order the agent serialized the operators in.
|
|
42
|
+
*/
|
|
43
|
+
export interface FilterableField {
|
|
44
|
+
name: string;
|
|
45
|
+
operators: Operator[];
|
|
46
|
+
}
|
|
47
|
+
export type DegradedReason = 'capabilities_unavailable' | 'no_fields';
|
|
48
|
+
/** True when at least one collection went out without its field set. */
|
|
49
|
+
export declare function hasDegradedCollection(unfolding: Unfolding): boolean;
|
|
50
|
+
/**
|
|
51
|
+
* True when NO collection got its field set — the signature of an unreachable agent rather than of
|
|
52
|
+
* one odd collection. An empty schema is not degraded: there was nothing to enumerate.
|
|
53
|
+
*/
|
|
54
|
+
export declare function isFullyDegraded(unfolding: Unfolding): boolean;
|
|
55
|
+
export interface UnfoldedAction {
|
|
56
|
+
name: string;
|
|
57
|
+
fields: UnfoldedActionField[];
|
|
58
|
+
}
|
|
59
|
+
export interface UnfoldedActionField {
|
|
60
|
+
name: string;
|
|
61
|
+
type: FieldType;
|
|
62
|
+
isRequired: boolean;
|
|
63
|
+
enums: string[] | null;
|
|
64
|
+
}
|
|
65
|
+
export type { FieldType };
|
|
66
|
+
//# sourceMappingURL=unfolding.d.ts.map
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.hasDegradedCollection = hasDegradedCollection;
|
|
4
|
+
exports.isFullyDegraded = isFullyDegraded;
|
|
5
|
+
/** True when at least one collection went out without its field set. */
|
|
6
|
+
function hasDegradedCollection(unfolding) {
|
|
7
|
+
return unfolding.collections.some(collection => collection.fields.degraded !== null);
|
|
8
|
+
}
|
|
9
|
+
/**
|
|
10
|
+
* True when NO collection got its field set — the signature of an unreachable agent rather than of
|
|
11
|
+
* one odd collection. An empty schema is not degraded: there was nothing to enumerate.
|
|
12
|
+
*/
|
|
13
|
+
function isFullyDegraded(unfolding) {
|
|
14
|
+
return (unfolding.collections.length > 0 &&
|
|
15
|
+
unfolding.collections.every(collection => collection.fields.degraded !== null));
|
|
16
|
+
}
|
|
17
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidW5mb2xkaW5nLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vc3JjL29wZW5hcGkvdW5mb2xkaW5nLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7O0FBdURBLHNEQUVDO0FBTUQsMENBS0M7QUFkRCx3RUFBd0U7QUFDeEUsU0FBZ0IscUJBQXFCLENBQUMsU0FBb0I7SUFDeEQsT0FBTyxTQUFTLENBQUMsV0FBVyxDQUFDLElBQUksQ0FBQyxVQUFVLENBQUMsRUFBRSxDQUFDLFVBQVUsQ0FBQyxNQUFNLENBQUMsUUFBUSxLQUFLLElBQUksQ0FBQyxDQUFDO0FBQ3ZGLENBQUM7QUFFRDs7O0dBR0c7QUFDSCxTQUFnQixlQUFlLENBQUMsU0FBb0I7SUFDbEQsT0FBTyxDQUNMLFNBQVMsQ0FBQyxXQUFXLENBQUMsTUFBTSxHQUFHLENBQUM7UUFDaEMsU0FBUyxDQUFDLFdBQVcsQ0FBQyxLQUFLLENBQUMsVUFBVSxDQUFDLEVBQUUsQ0FBQyxVQUFVLENBQUMsTUFBTSxDQUFDLFFBQVEsS0FBSyxJQUFJLENBQUMsQ0FDL0UsQ0FBQztBQUNKLENBQUMifQ==
|
|
@@ -1,12 +1,17 @@
|
|
|
1
1
|
import type { CapabilitiesFetcher } from './capabilities-cache';
|
|
2
2
|
export interface AgentCapabilitiesFetcherOptions {
|
|
3
3
|
agentUrl: string;
|
|
4
|
-
token
|
|
4
|
+
/** A borrowed request token, or a factory when the caller can mint one per fetch. */
|
|
5
|
+
token: string | (() => string);
|
|
5
6
|
timeoutMs?: number;
|
|
6
7
|
}
|
|
7
8
|
/**
|
|
8
|
-
* Builds a capabilities fetcher bound to
|
|
9
|
-
*
|
|
9
|
+
* Builds a capabilities fetcher bound to an agent token. The cache calls it only on a miss, so the
|
|
10
|
+
* token of whichever request first populates a collection is the one used.
|
|
11
|
+
*
|
|
12
|
+
* A factory exists for the token because an agent token lives 5 minutes: a caller fanning out over
|
|
13
|
+
* hundreds of collections can outlive a single one, and the tail of that fan-out would fail on an
|
|
14
|
+
* expired token. A request can only borrow its caller's, so it passes the string.
|
|
10
15
|
*/
|
|
11
16
|
export default function createAgentCapabilitiesFetcher({ agentUrl, token, timeoutMs, }: AgentCapabilitiesFetcherOptions): CapabilitiesFetcher;
|
|
12
17
|
//# sourceMappingURL=agent-capabilities-fetcher.d.ts.map
|
|
@@ -7,15 +7,23 @@ exports.default = createAgentCapabilitiesFetcher;
|
|
|
7
7
|
const agent_client_1 = require("@forestadmin/agent-client");
|
|
8
8
|
const create_agent_http_requester_1 = __importDefault(require("../agent/create-agent-http-requester"));
|
|
9
9
|
/**
|
|
10
|
-
* Builds a capabilities fetcher bound to
|
|
11
|
-
*
|
|
10
|
+
* Builds a capabilities fetcher bound to an agent token. The cache calls it only on a miss, so the
|
|
11
|
+
* token of whichever request first populates a collection is the one used.
|
|
12
|
+
*
|
|
13
|
+
* A factory exists for the token because an agent token lives 5 minutes: a caller fanning out over
|
|
14
|
+
* hundreds of collections can outlive a single one, and the tail of that fan-out would fail on an
|
|
15
|
+
* expired token. A request can only borrow its caller's, so it passes the string.
|
|
12
16
|
*/
|
|
13
17
|
function createAgentCapabilitiesFetcher({ agentUrl, token, timeoutMs, }) {
|
|
14
|
-
const
|
|
18
|
+
const clientFor = (bearer) => (0, agent_client_1.createRemoteAgentClient)({
|
|
15
19
|
url: agentUrl,
|
|
16
|
-
token,
|
|
17
|
-
httpRequester: (0, create_agent_http_requester_1.default)(
|
|
20
|
+
token: bearer,
|
|
21
|
+
httpRequester: (0, create_agent_http_requester_1.default)(bearer, agentUrl, timeoutMs),
|
|
18
22
|
});
|
|
19
|
-
|
|
23
|
+
if (typeof token === 'string') {
|
|
24
|
+
const client = clientFor(token);
|
|
25
|
+
return collection => client.collection(collection).capabilities();
|
|
26
|
+
}
|
|
27
|
+
return collection => clientFor(token()).collection(collection).capabilities();
|
|
20
28
|
}
|
|
21
|
-
//# sourceMappingURL=data:application/json;base64,
|
|
29
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiYWdlbnQtY2FwYWJpbGl0aWVzLWZldGNoZXIuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvcmVhZC1tb2RlbC9hZ2VudC1jYXBhYmlsaXRpZXMtZmV0Y2hlci50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7OztBQXFCQSxpREFtQkM7QUF0Q0QsNERBQW9FO0FBRXBFLHVHQUE0RTtBQVM1RTs7Ozs7OztHQU9HO0FBQ0gsU0FBd0IsOEJBQThCLENBQUMsRUFDckQsUUFBUSxFQUNSLEtBQUssRUFDTCxTQUFTLEdBQ3VCO0lBQ2hDLE1BQU0sU0FBUyxHQUFHLENBQUMsTUFBYyxFQUFFLEVBQUUsQ0FDbkMsSUFBQSxzQ0FBdUIsRUFBQztRQUN0QixHQUFHLEVBQUUsUUFBUTtRQUNiLEtBQUssRUFBRSxNQUFNO1FBQ2IsYUFBYSxFQUFFLElBQUEscUNBQXdCLEVBQUMsTUFBTSxFQUFFLFFBQVEsRUFBRSxTQUFTLENBQUM7S0FDckUsQ0FBQyxDQUFDO0lBRUwsSUFBSSxPQUFPLEtBQUssS0FBSyxRQUFRLEVBQUUsQ0FBQztRQUM5QixNQUFNLE1BQU0sR0FBRyxTQUFTLENBQUMsS0FBSyxDQUFDLENBQUM7UUFFaEMsT0FBTyxVQUFVLENBQUMsRUFBRSxDQUFDLE1BQU0sQ0FBQyxVQUFVLENBQUMsVUFBVSxDQUFDLENBQUMsWUFBWSxFQUFFLENBQUM7SUFDcEUsQ0FBQztJQUVELE9BQU8sVUFBVSxDQUFDLEVBQUUsQ0FBQyxTQUFTLENBQUMsS0FBSyxFQUFFLENBQUMsQ0FBQyxVQUFVLENBQUMsVUFBVSxDQUFDLENBQUMsWUFBWSxFQUFFLENBQUM7QUFDaEYsQ0FBQyJ9
|
|
@@ -1,7 +1,17 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* A Forest column type: a primitive name, a one-element array wrapping another type, a composite
|
|
3
|
+
* `{ fields }`, or a relation marker like `ManyToOne`.
|
|
4
|
+
*/
|
|
5
|
+
export type FieldType = string | FieldType[] | {
|
|
6
|
+
fields: {
|
|
7
|
+
field: string;
|
|
8
|
+
type: FieldType;
|
|
9
|
+
}[];
|
|
10
|
+
};
|
|
1
11
|
export interface CapabilitiesResult {
|
|
2
12
|
fields: {
|
|
3
13
|
name: string;
|
|
4
|
-
type:
|
|
14
|
+
type: FieldType;
|
|
5
15
|
operators?: string[];
|
|
6
16
|
}[];
|
|
7
17
|
}
|
|
@@ -44,4 +44,4 @@ class CapabilitiesCache {
|
|
|
44
44
|
}
|
|
45
45
|
}
|
|
46
46
|
exports.default = CapabilitiesCache;
|
|
47
|
-
//# sourceMappingURL=data:application/json;base64,
|
|
47
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY2FwYWJpbGl0aWVzLWNhY2hlLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vc3JjL3JlYWQtbW9kZWwvY2FwYWJpbGl0aWVzLWNhY2hlLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7O0FBQUEsaURBQTRDO0FBMEI1Qzs7O0dBR0c7QUFDSCxNQUFxQixpQkFBaUI7SUFRcEMsWUFBWSxFQUFFLEdBQUcsR0FBRyxJQUFJLENBQUMsR0FBRyxFQUFFLEtBQUssR0FBRyx5QkFBVSxLQUErQixFQUFFO1FBSmhFLFlBQU8sR0FBRyxJQUFJLEdBQUcsRUFBc0IsQ0FBQztRQUN4QyxhQUFRLEdBQUcsSUFBSSxHQUFHLEVBQXVDLENBQUM7UUFDbkUsZUFBVSxHQUFHLENBQUMsQ0FBQztRQUdyQixJQUFJLENBQUMsR0FBRyxHQUFHLEdBQUcsQ0FBQztRQUNmLElBQUksQ0FBQyxLQUFLLEdBQUcsS0FBSyxDQUFDO0lBQ3JCLENBQUM7SUFFRCxLQUFLLENBQUMsR0FBRyxDQUFDLFVBQWtCLEVBQUUsT0FBNEI7UUFDeEQsTUFBTSxLQUFLLEdBQUcsSUFBSSxDQUFDLE9BQU8sQ0FBQyxHQUFHLENBQUMsVUFBVSxDQUFDLENBQUM7UUFDM0MsSUFBSSxLQUFLLElBQUksSUFBSSxDQUFDLEdBQUcsRUFBRSxHQUFHLEtBQUssQ0FBQyxTQUFTLEdBQUcsSUFBSSxDQUFDLEtBQUs7WUFBRSxPQUFPLEtBQUssQ0FBQyxNQUFNLENBQUM7UUFFNUUsTUFBTSxPQUFPLEdBQUcsSUFBSSxDQUFDLFFBQVEsQ0FBQyxHQUFHLENBQUMsVUFBVSxDQUFDLENBQUM7UUFDOUMsSUFBSSxPQUFPO1lBQUUsT0FBTyxPQUFPLENBQUM7UUFFNUIsTUFBTSxFQUFFLFVBQVUsRUFBRSxHQUFHLElBQUksQ0FBQztRQUM1QixNQUFNLEtBQUssR0FBRyxPQUFPLENBQUMsVUFBVSxDQUFDO2FBQzlCLElBQUksQ0FBQyxNQUFNLENBQUMsRUFBRTtZQUNiLHlGQUF5RjtZQUN6RixxRkFBcUY7WUFDckYsSUFBSSxJQUFJLENBQUMsVUFBVSxLQUFLLFVBQVUsRUFBRSxDQUFDO2dCQUNuQyxJQUFJLENBQUMsT0FBTyxDQUFDLEdBQUcsQ0FBQyxVQUFVLEVBQUUsRUFBRSxNQUFNLEVBQUUsU0FBUyxFQUFFLElBQUksQ0FBQyxHQUFHLEVBQUUsRUFBRSxDQUFDLENBQUM7WUFDbEUsQ0FBQztZQUVELE9BQU8sTUFBTSxDQUFDO1FBQ2hCLENBQUMsQ0FBQzthQUNELE9BQU8sQ0FBQyxHQUFHLEVBQUU7WUFDWixJQUFJLElBQUksQ0FBQyxRQUFRLENBQUMsR0FBRyxDQUFDLFVBQVUsQ0FBQyxLQUFLLEtBQUs7Z0JBQUUsSUFBSSxDQUFDLFFBQVEsQ0FBQyxNQUFNLENBQUMsVUFBVSxDQUFDLENBQUM7UUFDaEYsQ0FBQyxDQUFDLENBQUM7UUFFTCxJQUFJLENBQUMsUUFBUSxDQUFDLEdBQUcsQ0FBQyxVQUFVLEVBQUUsS0FBSyxDQUFDLENBQUM7UUFFckMsT0FBTyxLQUFLLENBQUM7SUFDZixDQUFDO0lBRUQsS0FBSztRQUNILElBQUksQ0FBQyxVQUFVLElBQUksQ0FBQyxDQUFDO1FBQ3JCLElBQUksQ0FBQyxPQUFPLENBQUMsS0FBSyxFQUFFLENBQUM7UUFDckIsSUFBSSxDQUFDLFFBQVEsQ0FBQyxLQUFLLEVBQUUsQ0FBQztJQUN4QixDQUFDO0NBQ0Y7QUE3Q0Qsb0NBNkNDIn0=
|