@terreno/admin-backend 57.0.0-beta.1 → 57.1.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 +3 -0
- package/dist/adminApp.d.ts +11 -4
- package/dist/adminApp.js +859 -263
- package/dist/adminConfigIdentity.d.ts +16 -0
- package/dist/adminConfigIdentity.js +100 -0
- package/dist/adminTextSearch.d.ts +17 -0
- package/dist/adminTextSearch.js +117 -0
- package/dist/adminUiV2.js +1 -1
- package/dist/aggregateAdmin.d.ts +20 -0
- package/dist/aggregateAdmin.js +275 -0
- package/dist/documentStorageApp.d.ts +3 -1
- package/dist/documentStorageApp.js +20 -42
- package/dist/filterParser.d.ts +11 -0
- package/dist/filterParser.js +260 -0
- package/dist/index.d.ts +9 -0
- package/dist/index.js +15 -1
- package/dist/legacy.d.ts +9 -0
- package/dist/legacy.js +61 -0
- package/dist/resolvedAdminModel.d.ts +23 -0
- package/dist/resolvedAdminModel.js +130 -0
- package/dist/routePath.d.ts +2 -0
- package/dist/routePath.js +18 -0
- package/package.json +4 -3
- package/src/adminApp.models.test.ts +894 -1
- package/src/adminApp.test.ts +35 -1
- package/src/adminApp.ts +599 -98
- package/src/adminConfigIdentity.test.ts +56 -0
- package/src/adminConfigIdentity.ts +87 -0
- package/src/adminTextSearch.test.ts +73 -0
- package/src/adminTextSearch.ts +74 -0
- package/src/adminUiV2.test.ts +1 -0
- package/src/adminUiV2.ts +1 -1
- package/src/aggregateAdmin.test.ts +220 -0
- package/src/aggregateAdmin.ts +206 -0
- package/src/documentStorageApp.test.ts +11 -0
- package/src/documentStorageApp.ts +20 -39
- package/src/filterParser.test.ts +68 -0
- package/src/filterParser.ts +229 -0
- package/src/index.ts +35 -0
- package/src/legacy.test.ts +34 -0
- package/src/legacy.ts +63 -0
- package/src/resolvedAdminModel.ts +114 -0
- package/src/routePath.ts +14 -0
|
@@ -108,6 +108,11 @@ var DocumentStorageApp = /** @class */ (function () {
|
|
|
108
108
|
this.options = options;
|
|
109
109
|
this.storage = new storage_1.Storage();
|
|
110
110
|
}
|
|
111
|
+
DocumentStorageApp.prototype.adminContribution = function () {
|
|
112
|
+
return {
|
|
113
|
+
customScreens: [{ displayName: "Documents", icon: "folder", name: "documents" }],
|
|
114
|
+
};
|
|
115
|
+
};
|
|
111
116
|
Object.defineProperty(DocumentStorageApp.prototype, "bucket", {
|
|
112
117
|
get: function () {
|
|
113
118
|
var bucketName = this.options.bucketName || process.env.GCS_BUCKET;
|
|
@@ -256,9 +261,9 @@ var DocumentStorageApp = /** @class */ (function () {
|
|
|
256
261
|
// GET basePath/download/* — Stream file download
|
|
257
262
|
app.get.apply(app, __spreadArray(__spreadArray(["".concat(basePath, "/download/*filepath")], __read(adminGuard), false), [(0, api_1.asyncHandler)(function (req, res) { return __awaiter(_this, void 0, void 0, function () {
|
|
258
263
|
var filePath, gcsPath, gcsFile, metadata, _a, meta, err_1, storageErr, contentType, filename, err_2, pipelineErr;
|
|
259
|
-
var _b, _c, _d
|
|
260
|
-
return __generator(this, function (
|
|
261
|
-
switch (
|
|
264
|
+
var _b, _c, _d;
|
|
265
|
+
return __generator(this, function (_e) {
|
|
266
|
+
switch (_e.label) {
|
|
262
267
|
case 0:
|
|
263
268
|
filePath = normalizePathParam(req.params.filepath);
|
|
264
269
|
if (!filePath) {
|
|
@@ -266,47 +271,28 @@ var DocumentStorageApp = /** @class */ (function () {
|
|
|
266
271
|
}
|
|
267
272
|
gcsPath = "".concat(this.prefix).concat(filePath);
|
|
268
273
|
gcsFile = this.bucket.file(gcsPath);
|
|
269
|
-
|
|
270
|
-
_f.label = 1;
|
|
274
|
+
_e.label = 1;
|
|
271
275
|
case 1:
|
|
272
|
-
|
|
276
|
+
_e.trys.push([1, 3, , 4]);
|
|
273
277
|
return [4 /*yield*/, gcsFile.getMetadata()];
|
|
274
278
|
case 2:
|
|
275
|
-
_a = __read.apply(void 0, [
|
|
279
|
+
_a = __read.apply(void 0, [_e.sent(), 1]), meta = _a[0];
|
|
276
280
|
metadata = meta;
|
|
277
|
-
console.info("[documentStorage] getMetadata success", {
|
|
278
|
-
contentType: metadata.contentType,
|
|
279
|
-
etag: metadata.etag,
|
|
280
|
-
size: metadata.size,
|
|
281
|
-
});
|
|
282
281
|
return [3 /*break*/, 4];
|
|
283
282
|
case 3:
|
|
284
|
-
err_1 =
|
|
283
|
+
err_1 = _e.sent();
|
|
285
284
|
storageErr = err_1;
|
|
286
285
|
if ((storageErr === null || storageErr === void 0 ? void 0 : storageErr.code) === 404) {
|
|
287
286
|
throw new api_1.APIError({
|
|
288
|
-
detail: filePath,
|
|
289
287
|
disableExternalErrorTracking: true,
|
|
290
288
|
status: 404,
|
|
291
289
|
title: "File not found",
|
|
292
290
|
});
|
|
293
291
|
}
|
|
294
|
-
|
|
295
|
-
code: storageErr === null || storageErr === void 0 ? void 0 : storageErr.
|
|
296
|
-
errors: storageErr === null || storageErr === void 0 ? void 0 : storageErr.errors,
|
|
297
|
-
message: storageErr === null || storageErr === void 0 ? void 0 : storageErr.message,
|
|
298
|
-
response: storageErr === null || storageErr === void 0 ? void 0 : storageErr.response,
|
|
299
|
-
stack: storageErr === null || storageErr === void 0 ? void 0 : storageErr.stack,
|
|
300
|
-
status: storageErr === null || storageErr === void 0 ? void 0 : storageErr.status,
|
|
301
|
-
});
|
|
302
|
-
api_1.logger.error("[documentStorage] getMetadata error", {
|
|
303
|
-
code: storageErr === null || storageErr === void 0 ? void 0 : storageErr.code,
|
|
304
|
-
errors: storageErr === null || storageErr === void 0 ? void 0 : storageErr.errors,
|
|
305
|
-
message: storageErr === null || storageErr === void 0 ? void 0 : storageErr.message,
|
|
306
|
-
status: storageErr === null || storageErr === void 0 ? void 0 : storageErr.status,
|
|
292
|
+
api_1.logger.error("Document download metadata failed", {
|
|
293
|
+
status: (_b = storageErr === null || storageErr === void 0 ? void 0 : storageErr.code) !== null && _b !== void 0 ? _b : storageErr === null || storageErr === void 0 ? void 0 : storageErr.status,
|
|
307
294
|
});
|
|
308
295
|
throw new api_1.APIError({
|
|
309
|
-
detail: (_b = storageErr === null || storageErr === void 0 ? void 0 : storageErr.message) !== null && _b !== void 0 ? _b : String(err_1),
|
|
310
296
|
status: 500,
|
|
311
297
|
title: "Failed to access file",
|
|
312
298
|
});
|
|
@@ -318,29 +304,21 @@ var DocumentStorageApp = /** @class */ (function () {
|
|
|
318
304
|
if (metadata.size) {
|
|
319
305
|
res.setHeader("Content-Length", String(metadata.size));
|
|
320
306
|
}
|
|
321
|
-
|
|
307
|
+
_e.label = 5;
|
|
322
308
|
case 5:
|
|
323
|
-
|
|
309
|
+
_e.trys.push([5, 7, , 8]);
|
|
324
310
|
return [4 /*yield*/, (0, promises_1.pipeline)(gcsFile.createReadStream(), res)];
|
|
325
311
|
case 6:
|
|
326
|
-
|
|
312
|
+
_e.sent();
|
|
327
313
|
return [3 /*break*/, 8];
|
|
328
314
|
case 7:
|
|
329
|
-
err_2 =
|
|
315
|
+
err_2 = _e.sent();
|
|
330
316
|
pipelineErr = err_2;
|
|
331
|
-
|
|
332
|
-
|
|
333
|
-
message: pipelineErr === null || pipelineErr === void 0 ? void 0 : pipelineErr.message,
|
|
334
|
-
stack: pipelineErr === null || pipelineErr === void 0 ? void 0 : pipelineErr.stack,
|
|
335
|
-
});
|
|
336
|
-
api_1.logger.error("[documentStorage] pipeline error", {
|
|
337
|
-
code: pipelineErr === null || pipelineErr === void 0 ? void 0 : pipelineErr.code,
|
|
338
|
-
message: pipelineErr === null || pipelineErr === void 0 ? void 0 : pipelineErr.message,
|
|
339
|
-
stack: pipelineErr === null || pipelineErr === void 0 ? void 0 : pipelineErr.stack,
|
|
317
|
+
api_1.logger.error("Document download stream failed", {
|
|
318
|
+
status: pipelineErr === null || pipelineErr === void 0 ? void 0 : pipelineErr.code,
|
|
340
319
|
});
|
|
341
320
|
if (!res.headersSent) {
|
|
342
321
|
throw new api_1.APIError({
|
|
343
|
-
detail: (_e = pipelineErr === null || pipelineErr === void 0 ? void 0 : pipelineErr.message) !== null && _e !== void 0 ? _e : String(err_2),
|
|
344
322
|
status: 500,
|
|
345
323
|
title: "Failed to stream file",
|
|
346
324
|
});
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
import type { AdminFilter } from "@terreno/api";
|
|
2
|
+
export interface ParseAdminListFiltersResult {
|
|
3
|
+
consumedKeys: Set<string>;
|
|
4
|
+
errors: Record<string, string>;
|
|
5
|
+
filter: Record<string, unknown>;
|
|
6
|
+
}
|
|
7
|
+
/**
|
|
8
|
+
* Parses v2-compatible list query params for declared admin filters.
|
|
9
|
+
* Undeclared keys are ignored; Mongo operator keys are rejected.
|
|
10
|
+
*/
|
|
11
|
+
export declare const parseAdminListFilters: (query: Record<string, unknown>, filters?: AdminFilter[]) => ParseAdminListFiltersResult;
|
|
@@ -0,0 +1,260 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __values = (this && this.__values) || function(o) {
|
|
3
|
+
var s = typeof Symbol === "function" && Symbol.iterator, m = s && o[s], i = 0;
|
|
4
|
+
if (m) return m.call(o);
|
|
5
|
+
if (o && typeof o.length === "number") return {
|
|
6
|
+
next: function () {
|
|
7
|
+
if (o && i >= o.length) o = void 0;
|
|
8
|
+
return { value: o && o[i++], done: !o };
|
|
9
|
+
}
|
|
10
|
+
};
|
|
11
|
+
throw new TypeError(s ? "Object is not iterable." : "Symbol.iterator is not defined.");
|
|
12
|
+
};
|
|
13
|
+
var __read = (this && this.__read) || function (o, n) {
|
|
14
|
+
var m = typeof Symbol === "function" && o[Symbol.iterator];
|
|
15
|
+
if (!m) return o;
|
|
16
|
+
var i = m.call(o), r, ar = [], e;
|
|
17
|
+
try {
|
|
18
|
+
while ((n === void 0 || n-- > 0) && !(r = i.next()).done) ar.push(r.value);
|
|
19
|
+
}
|
|
20
|
+
catch (error) { e = { error: error }; }
|
|
21
|
+
finally {
|
|
22
|
+
try {
|
|
23
|
+
if (r && !r.done && (m = i["return"])) m.call(i);
|
|
24
|
+
}
|
|
25
|
+
finally { if (e) throw e.error; }
|
|
26
|
+
}
|
|
27
|
+
return ar;
|
|
28
|
+
};
|
|
29
|
+
var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
|
|
30
|
+
if (pack || arguments.length === 2) for (var i = 0, l = from.length, ar; i < l; i++) {
|
|
31
|
+
if (ar || !(i in from)) {
|
|
32
|
+
if (!ar) ar = Array.prototype.slice.call(from, 0, i);
|
|
33
|
+
ar[i] = from[i];
|
|
34
|
+
}
|
|
35
|
+
}
|
|
36
|
+
return to.concat(ar || Array.prototype.slice.call(from));
|
|
37
|
+
};
|
|
38
|
+
var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
39
|
+
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
40
|
+
};
|
|
41
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
42
|
+
exports.parseAdminListFilters = void 0;
|
|
43
|
+
var api_1 = require("@terreno/api");
|
|
44
|
+
var luxon_1 = require("luxon");
|
|
45
|
+
var mongoose_1 = __importDefault(require("mongoose"));
|
|
46
|
+
var POLLUTION_KEYS = new Set(["__proto__", "constructor", "prototype"]);
|
|
47
|
+
var isOperatorKey = function (key) {
|
|
48
|
+
return key.startsWith("$");
|
|
49
|
+
};
|
|
50
|
+
var dropPollutionKeys = function (query) {
|
|
51
|
+
var e_1, _a;
|
|
52
|
+
var next = {};
|
|
53
|
+
try {
|
|
54
|
+
for (var _b = __values(Object.entries(query)), _c = _b.next(); !_c.done; _c = _b.next()) {
|
|
55
|
+
var _d = __read(_c.value, 2), key = _d[0], value = _d[1];
|
|
56
|
+
if (POLLUTION_KEYS.has(key)) {
|
|
57
|
+
api_1.logger.warn("[admin] Dropping prototype-pollution query key: ".concat(key));
|
|
58
|
+
continue;
|
|
59
|
+
}
|
|
60
|
+
next[key] = value;
|
|
61
|
+
}
|
|
62
|
+
}
|
|
63
|
+
catch (e_1_1) { e_1 = { error: e_1_1 }; }
|
|
64
|
+
finally {
|
|
65
|
+
try {
|
|
66
|
+
if (_c && !_c.done && (_a = _b.return)) _a.call(_b);
|
|
67
|
+
}
|
|
68
|
+
finally { if (e_1) throw e_1.error; }
|
|
69
|
+
}
|
|
70
|
+
return next;
|
|
71
|
+
};
|
|
72
|
+
var scalarString = function (value) {
|
|
73
|
+
if (typeof value === "string") {
|
|
74
|
+
return value;
|
|
75
|
+
}
|
|
76
|
+
if (typeof value === "number" || typeof value === "boolean") {
|
|
77
|
+
return String(value);
|
|
78
|
+
}
|
|
79
|
+
return undefined;
|
|
80
|
+
};
|
|
81
|
+
var parseBooleanFilter = function (field, value) {
|
|
82
|
+
var scalar = scalarString(value);
|
|
83
|
+
if (scalar === "true") {
|
|
84
|
+
return { ok: true, value: true };
|
|
85
|
+
}
|
|
86
|
+
if (scalar === "false") {
|
|
87
|
+
return { ok: true, value: false };
|
|
88
|
+
}
|
|
89
|
+
return { error: "".concat(field, " must be true or false"), ok: false };
|
|
90
|
+
};
|
|
91
|
+
var parseTextFilter = function (field, value) {
|
|
92
|
+
var scalar = scalarString(value);
|
|
93
|
+
if (scalar === undefined ||
|
|
94
|
+
Array.isArray(value) ||
|
|
95
|
+
(value != null && typeof value === "object")) {
|
|
96
|
+
return { error: "".concat(field, " must be a string"), ok: false };
|
|
97
|
+
}
|
|
98
|
+
return { ok: true, value: scalar };
|
|
99
|
+
};
|
|
100
|
+
var parseChoiceFilter = function (field, value, choices) {
|
|
101
|
+
var parsed = parseTextFilter(field, value);
|
|
102
|
+
if (!parsed.ok) {
|
|
103
|
+
return parsed;
|
|
104
|
+
}
|
|
105
|
+
var allowed = new Set(choices.map(function (choice) { return choice.value; }));
|
|
106
|
+
if (!allowed.has(parsed.value)) {
|
|
107
|
+
return { error: "".concat(field, " must be one of: ").concat(__spreadArray([], __read(allowed), false).join(", ")), ok: false };
|
|
108
|
+
}
|
|
109
|
+
return parsed;
|
|
110
|
+
};
|
|
111
|
+
var parseRefFilter = function (field, value) {
|
|
112
|
+
var parsed = parseTextFilter(field, value);
|
|
113
|
+
if (!parsed.ok) {
|
|
114
|
+
return parsed;
|
|
115
|
+
}
|
|
116
|
+
if (!mongoose_1.default.isValidObjectId(parsed.value)) {
|
|
117
|
+
return { error: "".concat(field, " must be a valid id"), ok: false };
|
|
118
|
+
}
|
|
119
|
+
return parsed;
|
|
120
|
+
};
|
|
121
|
+
var parseIsoDate = function (field, value) {
|
|
122
|
+
var scalar = scalarString(value);
|
|
123
|
+
if (scalar === undefined ||
|
|
124
|
+
Array.isArray(value) ||
|
|
125
|
+
(value != null && typeof value === "object")) {
|
|
126
|
+
return { error: "".concat(field, " must be an ISO date string"), ok: false };
|
|
127
|
+
}
|
|
128
|
+
var parsed = luxon_1.DateTime.fromISO(scalar, { zone: "utc" });
|
|
129
|
+
if (!parsed.isValid) {
|
|
130
|
+
return { error: "".concat(field, " must be an ISO date string"), ok: false };
|
|
131
|
+
}
|
|
132
|
+
return { ok: true, value: parsed.toJSDate() };
|
|
133
|
+
};
|
|
134
|
+
/**
|
|
135
|
+
* Parses v2-compatible list query params for declared admin filters.
|
|
136
|
+
* Undeclared keys are ignored; Mongo operator keys are rejected.
|
|
137
|
+
*/
|
|
138
|
+
var parseAdminListFilters = function (query, filters) {
|
|
139
|
+
var e_2, _a, e_3, _b;
|
|
140
|
+
if (filters === void 0) { filters = []; }
|
|
141
|
+
var safeQuery = dropPollutionKeys(query);
|
|
142
|
+
var errors = {};
|
|
143
|
+
var filter = {};
|
|
144
|
+
var consumedKeys = new Set();
|
|
145
|
+
try {
|
|
146
|
+
for (var filters_1 = __values(filters), filters_1_1 = filters_1.next(); !filters_1_1.done; filters_1_1 = filters_1.next()) {
|
|
147
|
+
var declared = filters_1_1.value;
|
|
148
|
+
var field = declared.field;
|
|
149
|
+
if (declared.kind === "boolean") {
|
|
150
|
+
if (!(field in safeQuery)) {
|
|
151
|
+
continue;
|
|
152
|
+
}
|
|
153
|
+
consumedKeys.add(field);
|
|
154
|
+
var parsed = parseBooleanFilter(field, safeQuery[field]);
|
|
155
|
+
if (!parsed.ok) {
|
|
156
|
+
errors[field] = parsed.error;
|
|
157
|
+
continue;
|
|
158
|
+
}
|
|
159
|
+
filter[field] = parsed.value;
|
|
160
|
+
continue;
|
|
161
|
+
}
|
|
162
|
+
if (declared.kind === "text") {
|
|
163
|
+
if (!(field in safeQuery)) {
|
|
164
|
+
continue;
|
|
165
|
+
}
|
|
166
|
+
consumedKeys.add(field);
|
|
167
|
+
var parsed = parseTextFilter(field, safeQuery[field]);
|
|
168
|
+
if (!parsed.ok) {
|
|
169
|
+
errors[field] = parsed.error;
|
|
170
|
+
continue;
|
|
171
|
+
}
|
|
172
|
+
filter[field] = parsed.value;
|
|
173
|
+
continue;
|
|
174
|
+
}
|
|
175
|
+
if (declared.kind === "choice") {
|
|
176
|
+
if (!(field in safeQuery)) {
|
|
177
|
+
continue;
|
|
178
|
+
}
|
|
179
|
+
consumedKeys.add(field);
|
|
180
|
+
var parsed = parseChoiceFilter(field, safeQuery[field], declared.choices);
|
|
181
|
+
if (!parsed.ok) {
|
|
182
|
+
errors[field] = parsed.error;
|
|
183
|
+
continue;
|
|
184
|
+
}
|
|
185
|
+
filter[field] = parsed.value;
|
|
186
|
+
continue;
|
|
187
|
+
}
|
|
188
|
+
if (declared.kind === "ref") {
|
|
189
|
+
if (!(field in safeQuery)) {
|
|
190
|
+
continue;
|
|
191
|
+
}
|
|
192
|
+
consumedKeys.add(field);
|
|
193
|
+
var parsed = parseRefFilter(field, safeQuery[field]);
|
|
194
|
+
if (!parsed.ok) {
|
|
195
|
+
errors[field] = parsed.error;
|
|
196
|
+
continue;
|
|
197
|
+
}
|
|
198
|
+
filter[field] = parsed.value;
|
|
199
|
+
continue;
|
|
200
|
+
}
|
|
201
|
+
if (declared.kind === "dateRange") {
|
|
202
|
+
var gteKey = "".concat(field, "_gte");
|
|
203
|
+
var lteKey = "".concat(field, "_lte");
|
|
204
|
+
var hasGte = gteKey in safeQuery;
|
|
205
|
+
var hasLte = lteKey in safeQuery;
|
|
206
|
+
if (!hasGte && !hasLte) {
|
|
207
|
+
continue;
|
|
208
|
+
}
|
|
209
|
+
var range = {};
|
|
210
|
+
if (hasGte) {
|
|
211
|
+
consumedKeys.add(gteKey);
|
|
212
|
+
var parsed = parseIsoDate(gteKey, safeQuery[gteKey]);
|
|
213
|
+
if (!parsed.ok) {
|
|
214
|
+
errors[gteKey] = parsed.error;
|
|
215
|
+
}
|
|
216
|
+
else {
|
|
217
|
+
range.$gte = parsed.value;
|
|
218
|
+
}
|
|
219
|
+
}
|
|
220
|
+
if (hasLte) {
|
|
221
|
+
consumedKeys.add(lteKey);
|
|
222
|
+
var parsed = parseIsoDate(lteKey, safeQuery[lteKey]);
|
|
223
|
+
if (!parsed.ok) {
|
|
224
|
+
errors[lteKey] = parsed.error;
|
|
225
|
+
}
|
|
226
|
+
else {
|
|
227
|
+
range.$lte = parsed.value;
|
|
228
|
+
}
|
|
229
|
+
}
|
|
230
|
+
if (Object.keys(range).length > 0) {
|
|
231
|
+
filter[field] = range;
|
|
232
|
+
}
|
|
233
|
+
}
|
|
234
|
+
}
|
|
235
|
+
}
|
|
236
|
+
catch (e_2_1) { e_2 = { error: e_2_1 }; }
|
|
237
|
+
finally {
|
|
238
|
+
try {
|
|
239
|
+
if (filters_1_1 && !filters_1_1.done && (_a = filters_1.return)) _a.call(filters_1);
|
|
240
|
+
}
|
|
241
|
+
finally { if (e_2) throw e_2.error; }
|
|
242
|
+
}
|
|
243
|
+
try {
|
|
244
|
+
for (var _c = __values(Object.keys(safeQuery)), _d = _c.next(); !_d.done; _d = _c.next()) {
|
|
245
|
+
var key = _d.value;
|
|
246
|
+
if (isOperatorKey(key)) {
|
|
247
|
+
errors[key] = "Mongo operators are not allowed in admin list filters";
|
|
248
|
+
}
|
|
249
|
+
}
|
|
250
|
+
}
|
|
251
|
+
catch (e_3_1) { e_3 = { error: e_3_1 }; }
|
|
252
|
+
finally {
|
|
253
|
+
try {
|
|
254
|
+
if (_d && !_d.done && (_b = _c.return)) _b.call(_c);
|
|
255
|
+
}
|
|
256
|
+
finally { if (e_3) throw e_3.error; }
|
|
257
|
+
}
|
|
258
|
+
return { consumedKeys: consumedKeys, errors: errors, filter: filter };
|
|
259
|
+
};
|
|
260
|
+
exports.parseAdminListFilters = parseAdminListFilters;
|
package/dist/index.d.ts
CHANGED
|
@@ -1,7 +1,16 @@
|
|
|
1
|
+
export type { AdminChangeEvent, AdminChangeType, AdminConfig, AdminContribution, AdminCustomScreen, AdminFieldset, AdminFilter, AdminFilterBoolean, AdminFilterChoice, AdminFilterDateRange, AdminFilterKind, AdminFilterRef, AdminFilterText, AdminHomeConfig, AdminHomeSlots, AdminHomeWidgetContribution, AdminModelContribution, AdminModelPermissions, AdminScriptContribution, TerrenoAppAdminEvent, } from "@terreno/api";
|
|
1
2
|
export type { AdminAuditEvent, AdminCustomScreenConfig, AdminFieldOverride, AdminModelConfig, AdminOptions, AdminScriptConfig, } from "./adminApp";
|
|
2
3
|
export { AdminApp } from "./adminApp";
|
|
3
4
|
export * from "./adminUiV2";
|
|
5
|
+
export type { AggregatedAdminContributions } from "./aggregateAdmin";
|
|
6
|
+
export { aggregateAdminContributions, aggregateFromTerrenoApp, collectPluginAdminContributions, collectRegisteredAdminModels, } from "./aggregateAdmin";
|
|
4
7
|
export type { DocumentFile, DocumentListResponse, DocumentStorageOptions, } from "./documentStorageApp";
|
|
5
8
|
export { DocumentStorageApp } from "./documentStorageApp";
|
|
9
|
+
export type { ParseAdminListFiltersResult } from "./filterParser";
|
|
10
|
+
export { parseAdminListFilters } from "./filterParser";
|
|
11
|
+
export { convertLegacyModelConfig, resetLegacyDeprecationWarningsForTests } from "./legacy";
|
|
12
|
+
export type { AdminModelSource, ResolvedAdminModel } from "./resolvedAdminModel";
|
|
13
|
+
export { resolvedModelFromAdminConfig } from "./resolvedAdminModel";
|
|
14
|
+
export { normalizeAdminRoutePath } from "./routePath";
|
|
6
15
|
export type { RunScriptCliOptions, RunScriptCliResult } from "./scriptCli";
|
|
7
16
|
export { runScriptCli } from "./scriptCli";
|
package/dist/index.js
CHANGED
|
@@ -14,11 +14,25 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
|
|
|
14
14
|
for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
|
|
15
15
|
};
|
|
16
16
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
17
|
-
exports.runScriptCli = exports.DocumentStorageApp = exports.AdminApp = void 0;
|
|
17
|
+
exports.runScriptCli = exports.normalizeAdminRoutePath = exports.resolvedModelFromAdminConfig = exports.resetLegacyDeprecationWarningsForTests = exports.convertLegacyModelConfig = exports.parseAdminListFilters = exports.DocumentStorageApp = exports.collectRegisteredAdminModels = exports.collectPluginAdminContributions = exports.aggregateFromTerrenoApp = exports.aggregateAdminContributions = exports.AdminApp = void 0;
|
|
18
18
|
var adminApp_1 = require("./adminApp");
|
|
19
19
|
Object.defineProperty(exports, "AdminApp", { enumerable: true, get: function () { return adminApp_1.AdminApp; } });
|
|
20
20
|
__exportStar(require("./adminUiV2"), exports);
|
|
21
|
+
var aggregateAdmin_1 = require("./aggregateAdmin");
|
|
22
|
+
Object.defineProperty(exports, "aggregateAdminContributions", { enumerable: true, get: function () { return aggregateAdmin_1.aggregateAdminContributions; } });
|
|
23
|
+
Object.defineProperty(exports, "aggregateFromTerrenoApp", { enumerable: true, get: function () { return aggregateAdmin_1.aggregateFromTerrenoApp; } });
|
|
24
|
+
Object.defineProperty(exports, "collectPluginAdminContributions", { enumerable: true, get: function () { return aggregateAdmin_1.collectPluginAdminContributions; } });
|
|
25
|
+
Object.defineProperty(exports, "collectRegisteredAdminModels", { enumerable: true, get: function () { return aggregateAdmin_1.collectRegisteredAdminModels; } });
|
|
21
26
|
var documentStorageApp_1 = require("./documentStorageApp");
|
|
22
27
|
Object.defineProperty(exports, "DocumentStorageApp", { enumerable: true, get: function () { return documentStorageApp_1.DocumentStorageApp; } });
|
|
28
|
+
var filterParser_1 = require("./filterParser");
|
|
29
|
+
Object.defineProperty(exports, "parseAdminListFilters", { enumerable: true, get: function () { return filterParser_1.parseAdminListFilters; } });
|
|
30
|
+
var legacy_1 = require("./legacy");
|
|
31
|
+
Object.defineProperty(exports, "convertLegacyModelConfig", { enumerable: true, get: function () { return legacy_1.convertLegacyModelConfig; } });
|
|
32
|
+
Object.defineProperty(exports, "resetLegacyDeprecationWarningsForTests", { enumerable: true, get: function () { return legacy_1.resetLegacyDeprecationWarningsForTests; } });
|
|
33
|
+
var resolvedAdminModel_1 = require("./resolvedAdminModel");
|
|
34
|
+
Object.defineProperty(exports, "resolvedModelFromAdminConfig", { enumerable: true, get: function () { return resolvedAdminModel_1.resolvedModelFromAdminConfig; } });
|
|
35
|
+
var routePath_1 = require("./routePath");
|
|
36
|
+
Object.defineProperty(exports, "normalizeAdminRoutePath", { enumerable: true, get: function () { return routePath_1.normalizeAdminRoutePath; } });
|
|
23
37
|
var scriptCli_1 = require("./scriptCli");
|
|
24
38
|
Object.defineProperty(exports, "runScriptCli", { enumerable: true, get: function () { return scriptCli_1.runScriptCli; } });
|
package/dist/legacy.d.ts
ADDED
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
import type { AdminModelConfig } from "./adminApp";
|
|
2
|
+
import type { ResolvedAdminModel } from "./resolvedAdminModel";
|
|
3
|
+
/**
|
|
4
|
+
* Converts legacy `AdminApp.models[]` entries into resolved admin models and emits a
|
|
5
|
+
* one-time deprecation warning per model/routePath per process.
|
|
6
|
+
*/
|
|
7
|
+
export declare const convertLegacyModelConfig: (config: AdminModelConfig) => ResolvedAdminModel;
|
|
8
|
+
/** @internal Test helper — clears one-time legacy deprecation warnings. */
|
|
9
|
+
export declare const resetLegacyDeprecationWarningsForTests: () => void;
|
package/dist/legacy.js
ADDED
|
@@ -0,0 +1,61 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __assign = (this && this.__assign) || function () {
|
|
3
|
+
__assign = Object.assign || function(t) {
|
|
4
|
+
for (var s, i = 1, n = arguments.length; i < n; i++) {
|
|
5
|
+
s = arguments[i];
|
|
6
|
+
for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
|
|
7
|
+
t[p] = s[p];
|
|
8
|
+
}
|
|
9
|
+
return t;
|
|
10
|
+
};
|
|
11
|
+
return __assign.apply(this, arguments);
|
|
12
|
+
};
|
|
13
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
14
|
+
exports.resetLegacyDeprecationWarningsForTests = exports.convertLegacyModelConfig = void 0;
|
|
15
|
+
var api_1 = require("@terreno/api");
|
|
16
|
+
var routePath_1 = require("./routePath");
|
|
17
|
+
var warnedLegacyKeys = new Set();
|
|
18
|
+
var legacyWarningKey = function (config) {
|
|
19
|
+
return "".concat(config.model.modelName, ":").concat((0, routePath_1.normalizeAdminRoutePath)(config.routePath));
|
|
20
|
+
};
|
|
21
|
+
/**
|
|
22
|
+
* Converts legacy `AdminApp.models[]` entries into resolved admin models and emits a
|
|
23
|
+
* one-time deprecation warning per model/routePath per process.
|
|
24
|
+
*/
|
|
25
|
+
var convertLegacyModelConfig = function (config) {
|
|
26
|
+
var key = legacyWarningKey(config);
|
|
27
|
+
if (!warnedLegacyKeys.has(key)) {
|
|
28
|
+
warnedLegacyKeys.add(key);
|
|
29
|
+
api_1.logger.warn("[admin] AdminApp.models entry \"".concat(config.displayName, "\" uses the legacy shape (model=").concat(config.model.modelName, ", routePath=").concat(config.routePath, "). Migrate to modelRouter({admin: {...}}) \u2014 see docs/how-to/admin-add-model.md"));
|
|
30
|
+
}
|
|
31
|
+
var admin = {
|
|
32
|
+
actions: config.actions,
|
|
33
|
+
autocompleteFields: undefined,
|
|
34
|
+
bulkPatchAllowlist: config.bulkPatchAllowlist,
|
|
35
|
+
defaultSort: config.defaultSort,
|
|
36
|
+
displayName: config.displayName,
|
|
37
|
+
excludeFields: undefined,
|
|
38
|
+
fieldOrder: config.fieldOrder,
|
|
39
|
+
fieldOverrides: config.fieldOverrides,
|
|
40
|
+
fieldsets: config.fieldsets,
|
|
41
|
+
filters: config.filters,
|
|
42
|
+
group: config.group,
|
|
43
|
+
hiddenFields: config.hiddenFields,
|
|
44
|
+
listDisplay: config.listDisplay,
|
|
45
|
+
listDisplayLinks: config.listDisplayLinks,
|
|
46
|
+
listFields: config.listFields,
|
|
47
|
+
pageSize: config.pageSize,
|
|
48
|
+
readonlyFields: config.readonlyFields,
|
|
49
|
+
realtime: config.realtime,
|
|
50
|
+
recordTitleField: config.recordTitleField,
|
|
51
|
+
searchFields: config.searchFields,
|
|
52
|
+
sortableFields: config.sortableFields,
|
|
53
|
+
};
|
|
54
|
+
return __assign(__assign({}, config), { admin: admin, routePath: (0, routePath_1.normalizeAdminRoutePath)(config.routePath), source: "legacy", sourceLabel: config.displayName });
|
|
55
|
+
};
|
|
56
|
+
exports.convertLegacyModelConfig = convertLegacyModelConfig;
|
|
57
|
+
/** @internal Test helper — clears one-time legacy deprecation warnings. */
|
|
58
|
+
var resetLegacyDeprecationWarningsForTests = function () {
|
|
59
|
+
warnedLegacyKeys.clear();
|
|
60
|
+
};
|
|
61
|
+
exports.resetLegacyDeprecationWarningsForTests = resetLegacyDeprecationWarningsForTests;
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
import type { AdminConfig, ModelRouterOptions, PopulatePath } from "@terreno/api";
|
|
2
|
+
import type { Model } from "mongoose";
|
|
3
|
+
import type { AdminModelConfig } from "./adminApp";
|
|
4
|
+
export type AdminModelSource = "legacy" | "plugin" | "registered";
|
|
5
|
+
export interface ResolvedAdminModel extends AdminModelConfig {
|
|
6
|
+
admin: AdminConfig;
|
|
7
|
+
source: AdminModelSource;
|
|
8
|
+
sourceLabel: string;
|
|
9
|
+
registrationPath?: string;
|
|
10
|
+
excludeFields?: string[];
|
|
11
|
+
autocompleteFields?: string[];
|
|
12
|
+
icon?: string;
|
|
13
|
+
}
|
|
14
|
+
export declare const resolvedModelFromAdminConfig: ({ admin, model, populatePaths, queryFilter, registrationPath, routePath, source, sourceLabel, }: {
|
|
15
|
+
admin: AdminConfig;
|
|
16
|
+
model: Model<unknown>;
|
|
17
|
+
populatePaths?: PopulatePath[];
|
|
18
|
+
queryFilter?: ModelRouterOptions<unknown>["queryFilter"];
|
|
19
|
+
registrationPath?: string;
|
|
20
|
+
routePath: string;
|
|
21
|
+
source: AdminModelSource;
|
|
22
|
+
sourceLabel: string;
|
|
23
|
+
}) => ResolvedAdminModel;
|
|
@@ -0,0 +1,130 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __assign = (this && this.__assign) || function () {
|
|
3
|
+
__assign = Object.assign || function(t) {
|
|
4
|
+
for (var s, i = 1, n = arguments.length; i < n; i++) {
|
|
5
|
+
s = arguments[i];
|
|
6
|
+
for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
|
|
7
|
+
t[p] = s[p];
|
|
8
|
+
}
|
|
9
|
+
return t;
|
|
10
|
+
};
|
|
11
|
+
return __assign.apply(this, arguments);
|
|
12
|
+
};
|
|
13
|
+
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
|
|
14
|
+
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
|
|
15
|
+
return new (P || (P = Promise))(function (resolve, reject) {
|
|
16
|
+
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
|
|
17
|
+
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
|
|
18
|
+
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
|
|
19
|
+
step((generator = generator.apply(thisArg, _arguments || [])).next());
|
|
20
|
+
});
|
|
21
|
+
};
|
|
22
|
+
var __generator = (this && this.__generator) || function (thisArg, body) {
|
|
23
|
+
var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g = Object.create((typeof Iterator === "function" ? Iterator : Object).prototype);
|
|
24
|
+
return g.next = verb(0), g["throw"] = verb(1), g["return"] = verb(2), typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
|
|
25
|
+
function verb(n) { return function (v) { return step([n, v]); }; }
|
|
26
|
+
function step(op) {
|
|
27
|
+
if (f) throw new TypeError("Generator is already executing.");
|
|
28
|
+
while (g && (g = 0, op[0] && (_ = 0)), _) try {
|
|
29
|
+
if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
|
|
30
|
+
if (y = 0, t) op = [op[0] & 2, t.value];
|
|
31
|
+
switch (op[0]) {
|
|
32
|
+
case 0: case 1: t = op; break;
|
|
33
|
+
case 4: _.label++; return { value: op[1], done: false };
|
|
34
|
+
case 5: _.label++; y = op[1]; op = [0]; continue;
|
|
35
|
+
case 7: op = _.ops.pop(); _.trys.pop(); continue;
|
|
36
|
+
default:
|
|
37
|
+
if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
|
|
38
|
+
if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
|
|
39
|
+
if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
|
|
40
|
+
if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
|
|
41
|
+
if (t[2]) _.ops.pop();
|
|
42
|
+
_.trys.pop(); continue;
|
|
43
|
+
}
|
|
44
|
+
op = body.call(thisArg, _);
|
|
45
|
+
} catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
|
|
46
|
+
if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
|
|
47
|
+
}
|
|
48
|
+
};
|
|
49
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
50
|
+
exports.resolvedModelFromAdminConfig = void 0;
|
|
51
|
+
var routePath_1 = require("./routePath");
|
|
52
|
+
var adminPermissionsToModelPermissions = function (permissions) {
|
|
53
|
+
if (!permissions) {
|
|
54
|
+
return undefined;
|
|
55
|
+
}
|
|
56
|
+
var has = function (methods) {
|
|
57
|
+
return methods != null && methods.length > 0;
|
|
58
|
+
};
|
|
59
|
+
var mapped = {};
|
|
60
|
+
if (permissions.create !== undefined) {
|
|
61
|
+
mapped.create = has(permissions.create);
|
|
62
|
+
}
|
|
63
|
+
if (permissions.delete !== undefined) {
|
|
64
|
+
mapped.delete = has(permissions.delete);
|
|
65
|
+
}
|
|
66
|
+
if (permissions.update !== undefined) {
|
|
67
|
+
mapped.update = has(permissions.update);
|
|
68
|
+
}
|
|
69
|
+
return mapped;
|
|
70
|
+
};
|
|
71
|
+
var adminFilterToQueryFilter = function (adminFilter) {
|
|
72
|
+
if (!adminFilter) {
|
|
73
|
+
return undefined;
|
|
74
|
+
}
|
|
75
|
+
return function (user, query) { return __awaiter(void 0, void 0, void 0, function () {
|
|
76
|
+
var stubReq, scoped;
|
|
77
|
+
return __generator(this, function (_a) {
|
|
78
|
+
switch (_a.label) {
|
|
79
|
+
case 0:
|
|
80
|
+
stubReq = { user: user };
|
|
81
|
+
return [4 /*yield*/, adminFilter(stubReq)];
|
|
82
|
+
case 1:
|
|
83
|
+
scoped = _a.sent();
|
|
84
|
+
return [2 /*return*/, __assign(__assign({}, (query !== null && query !== void 0 ? query : {})), scoped)];
|
|
85
|
+
}
|
|
86
|
+
});
|
|
87
|
+
}); };
|
|
88
|
+
};
|
|
89
|
+
var resolvedModelFromAdminConfig = function (_a) {
|
|
90
|
+
var admin = _a.admin, model = _a.model, populatePaths = _a.populatePaths, queryFilter = _a.queryFilter, registrationPath = _a.registrationPath, routePath = _a.routePath, source = _a.source, sourceLabel = _a.sourceLabel;
|
|
91
|
+
var normalizedPath = (0, routePath_1.normalizeAdminRoutePath)(routePath);
|
|
92
|
+
var defaultSort = Array.isArray(admin.defaultSort)
|
|
93
|
+
? admin.defaultSort.join(" ")
|
|
94
|
+
: admin.defaultSort;
|
|
95
|
+
var mergedQueryFilter = queryFilter !== null && queryFilter !== void 0 ? queryFilter : adminFilterToQueryFilter(admin.adminFilter);
|
|
96
|
+
return {
|
|
97
|
+
actions: admin.actions,
|
|
98
|
+
admin: admin,
|
|
99
|
+
autocompleteFields: admin.autocompleteFields,
|
|
100
|
+
bulkPatchAllowlist: admin.bulkPatchAllowlist,
|
|
101
|
+
defaultSort: defaultSort,
|
|
102
|
+
displayName: admin.displayName,
|
|
103
|
+
excludeFields: admin.excludeFields,
|
|
104
|
+
fieldOrder: admin.fieldOrder,
|
|
105
|
+
fieldOverrides: admin.fieldOverrides,
|
|
106
|
+
fieldsets: admin.fieldsets,
|
|
107
|
+
filters: admin.filters,
|
|
108
|
+
group: admin.group,
|
|
109
|
+
hiddenFields: admin.hiddenFields,
|
|
110
|
+
icon: admin.icon,
|
|
111
|
+
listDisplay: admin.listDisplay,
|
|
112
|
+
listDisplayLinks: admin.listDisplayLinks,
|
|
113
|
+
listFields: admin.listFields,
|
|
114
|
+
model: model,
|
|
115
|
+
pageSize: admin.pageSize,
|
|
116
|
+
permissions: adminPermissionsToModelPermissions(admin.adminPermissions),
|
|
117
|
+
populatePaths: populatePaths,
|
|
118
|
+
queryFilter: mergedQueryFilter,
|
|
119
|
+
readonlyFields: admin.readonlyFields,
|
|
120
|
+
realtime: admin.realtime,
|
|
121
|
+
recordTitleField: admin.recordTitleField,
|
|
122
|
+
registrationPath: registrationPath,
|
|
123
|
+
routePath: normalizedPath,
|
|
124
|
+
searchFields: admin.searchFields,
|
|
125
|
+
sortableFields: admin.sortableFields,
|
|
126
|
+
source: source,
|
|
127
|
+
sourceLabel: sourceLabel,
|
|
128
|
+
};
|
|
129
|
+
};
|
|
130
|
+
exports.resolvedModelFromAdminConfig = resolvedModelFromAdminConfig;
|