@terreno/api 57.0.0 → 57.2.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/.ai/skills/mongoose-schema-safety/SKILL.md +8 -0
- package/dist/actions.d.ts +7 -2
- package/dist/actions.js +60 -25
- package/dist/adminModelRouter.d.ts +14 -0
- package/dist/adminModelRouter.js +199 -0
- package/dist/adminTypes.d.ts +182 -0
- package/dist/adminTypes.js +5 -0
- package/dist/api.d.ts +44 -3
- package/dist/api.js +74 -26
- package/dist/auth.d.ts +18 -1
- package/dist/auth.js +122 -20
- package/dist/consentApp.d.ts +2 -0
- package/dist/consentApp.js +98 -0
- package/dist/index.d.ts +22 -1
- package/dist/index.js +51 -7
- package/dist/mcp/auth.d.ts +11 -0
- package/dist/mcp/auth.js +133 -0
- package/dist/mcp/createMCPRequest.d.ts +16 -0
- package/dist/mcp/createMCPRequest.js +26 -0
- package/dist/mcp/handlers.d.ts +8 -0
- package/dist/mcp/handlers.js +793 -0
- package/dist/mcp/query.d.ts +32 -0
- package/dist/mcp/query.js +232 -0
- package/dist/mcp/registry.d.ts +21 -0
- package/dist/mcp/registry.js +54 -0
- package/dist/mcp/schemaGenerator.d.ts +14 -0
- package/dist/mcp/schemaGenerator.js +379 -0
- package/dist/mcp/server.d.ts +8 -0
- package/dist/mcp/server.js +133 -0
- package/dist/mcp/toolGenerator.d.ts +14 -0
- package/dist/mcp/toolGenerator.js +246 -0
- package/dist/mcp/types.d.ts +85 -0
- package/dist/mcp/types.js +2 -0
- package/dist/openApi.d.ts +1 -1
- package/dist/openApi.js +26 -8
- package/dist/permissions.js +15 -15
- package/dist/rbac/access.d.ts +3 -0
- package/dist/rbac/access.js +294 -0
- package/dist/rbac/auditModel.d.ts +31 -0
- package/dist/rbac/auditModel.js +112 -0
- package/dist/rbac/backfillAdmins.d.ts +18 -0
- package/dist/rbac/backfillAdmins.js +139 -0
- package/dist/rbac/fieldViews.d.ts +3 -0
- package/dist/rbac/fieldViews.js +201 -0
- package/dist/rbac/middleware.d.ts +21 -0
- package/dist/rbac/middleware.js +108 -0
- package/dist/rbac/modelRouterAccess.d.ts +42 -0
- package/dist/rbac/modelRouterAccess.js +388 -0
- package/dist/rbac/permissionUtils.d.ts +8 -0
- package/dist/rbac/permissionUtils.js +209 -0
- package/dist/rbac/realtimeAccess.d.ts +18 -0
- package/dist/rbac/realtimeAccess.js +173 -0
- package/dist/rbac/resolve.d.ts +28 -0
- package/dist/rbac/resolve.js +387 -0
- package/dist/rbac/roleManager.d.ts +20 -0
- package/dist/rbac/roleManager.js +741 -0
- package/dist/rbac/roleModel.d.ts +42 -0
- package/dist/rbac/roleModel.js +267 -0
- package/dist/rbac/routes.d.ts +9 -0
- package/dist/rbac/routes.js +211 -0
- package/dist/rbac/scopes.d.ts +15 -0
- package/dist/rbac/scopes.js +155 -0
- package/dist/rbac/statements.d.ts +30 -0
- package/dist/rbac/statements.js +126 -0
- package/dist/rbac/types.d.ts +202 -0
- package/dist/rbac/types.js +2 -0
- package/dist/rbac/userPlugin.d.ts +12 -0
- package/dist/rbac/userPlugin.js +41 -0
- package/dist/realtime/changeStreamWatcher.d.ts +1 -1
- package/dist/realtime/changeStreamWatcher.js +48 -39
- package/dist/realtime/realtimeApp.js +4 -8
- package/dist/realtime/registry.d.ts +5 -0
- package/dist/realtime/registry.js +13 -1
- package/dist/scrubAdminFields.d.ts +17 -0
- package/dist/scrubAdminFields.js +192 -0
- package/dist/sync/executors.d.ts +1 -1
- package/dist/sync/executors.js +63 -40
- package/dist/sync/loadHarness.js +4 -5
- package/dist/sync/registry.d.ts +5 -0
- package/dist/sync/registry.js +13 -1
- package/dist/sync/routes.js +41 -36
- package/dist/sync/serialize.js +5 -6
- package/dist/terrenoApp.d.ts +18 -0
- package/dist/terrenoApp.js +46 -3
- package/dist/terrenoPlugin.d.ts +8 -1
- package/dist/tests/createTestData.js +8 -0
- package/dist/tests/models.d.ts +1 -0
- package/dist/tests/models.js +5 -0
- package/dist/tests/testHelper.js +1 -2
- package/dist/transformers.js +16 -1
- package/package.json +17 -13
- package/src/__snapshots__/openApi.test.ts.snap +192 -0
- package/src/actions.test.ts +194 -1
- package/src/actions.ts +65 -8
- package/src/adminModelRouter.ts +154 -0
- package/src/adminTypes.ts +206 -0
- package/src/api.test.ts +66 -1
- package/src/api.ts +131 -12
- package/src/auth.test.ts +135 -1
- package/src/auth.ts +81 -3
- package/src/consentApp.test.ts +24 -0
- package/src/consentApp.ts +100 -0
- package/src/index.ts +56 -0
- package/src/mcp/auth.test.ts +197 -0
- package/src/mcp/auth.ts +100 -0
- package/src/mcp/createMCPRequest.test.ts +47 -0
- package/src/mcp/createMCPRequest.ts +32 -0
- package/src/mcp/customTools.test.ts +54 -0
- package/src/mcp/handlers.ts +639 -0
- package/src/mcp/integration.test.ts +1493 -0
- package/src/mcp/query.test.ts +172 -0
- package/src/mcp/query.ts +179 -0
- package/src/mcp/registry.ts +70 -0
- package/src/mcp/schemaGenerator.test.ts +182 -0
- package/src/mcp/schemaGenerator.ts +354 -0
- package/src/mcp/server.test.ts +226 -0
- package/src/mcp/server.ts +86 -0
- package/src/mcp/toolGenerator.test.ts +284 -0
- package/src/mcp/toolGenerator.ts +199 -0
- package/src/mcp/types.ts +95 -0
- package/src/openApi.test.ts +107 -0
- package/src/openApi.ts +32 -1
- package/src/permissions.ts +3 -2
- package/src/rbac/access.test.ts +357 -0
- package/src/rbac/access.ts +201 -0
- package/src/rbac/auditModel.ts +103 -0
- package/src/rbac/backfillAdmins.ts +54 -0
- package/src/rbac/fieldViews.test.ts +39 -0
- package/src/rbac/fieldViews.ts +122 -0
- package/src/rbac/middleware.ts +55 -0
- package/src/rbac/modelRouterAccess.test.ts +336 -0
- package/src/rbac/modelRouterAccess.ts +331 -0
- package/src/rbac/permissionUtils.test.ts +112 -0
- package/src/rbac/permissionUtils.ts +83 -0
- package/src/rbac/realtimeAccess.test.ts +242 -0
- package/src/rbac/realtimeAccess.ts +138 -0
- package/src/rbac/resolve.test.ts +358 -0
- package/src/rbac/resolve.ts +285 -0
- package/src/rbac/roleManager.test.ts +915 -0
- package/src/rbac/roleManager.ts +440 -0
- package/src/rbac/roleModel.test.ts +114 -0
- package/src/rbac/roleModel.ts +196 -0
- package/src/rbac/routes.ts +170 -0
- package/src/rbac/scopes.test.ts +105 -0
- package/src/rbac/scopes.ts +81 -0
- package/src/rbac/statements.test.ts +67 -0
- package/src/rbac/statements.ts +73 -0
- package/src/rbac/types.ts +198 -0
- package/src/rbac/userPlugin.test.ts +55 -0
- package/src/rbac/userPlugin.ts +25 -0
- package/src/realtime/changeStreamWatcher.ts +20 -15
- package/src/realtime/realtime.test.ts +25 -1
- package/src/realtime/realtimeApp.ts +2 -5
- package/src/realtime/registry.ts +15 -0
- package/src/scrubAdminFields.test.ts +113 -0
- package/src/scrubAdminFields.ts +158 -0
- package/src/sync/executors.ts +31 -1
- package/src/sync/loadHarness.ts +8 -7
- package/src/sync/models.test.ts +262 -0
- package/src/sync/registry.ts +15 -0
- package/src/sync/routes.ts +25 -11
- package/src/sync/scripts/compactTombstones.test.ts +4 -6
- package/src/sync/serialize.ts +17 -9
- package/src/sync/sync.test.ts +52 -0
- package/src/sync/syncRoutes.test.ts +5 -2
- package/src/sync/syncSocket.test.ts +28 -0
- package/src/terrenoApp.test.ts +100 -0
- package/src/terrenoApp.ts +65 -3
- package/src/terrenoPlugin.ts +10 -1
- package/src/tests/bunSetup.ts +2 -0
- package/src/tests/createTestData.ts +5 -1
- package/src/tests/models.ts +6 -0
- package/src/tests/testHelper.ts +1 -3
- package/src/transformers.test.ts +12 -0
- package/src/transformers.ts +7 -1
|
@@ -125,7 +125,7 @@ var luxon_1 = require("luxon");
|
|
|
125
125
|
var mongoose_1 = __importDefault(require("mongoose"));
|
|
126
126
|
var errors_1 = require("../errors");
|
|
127
127
|
var logger_1 = require("../logger");
|
|
128
|
-
var
|
|
128
|
+
var realtimeAccess_1 = require("../rbac/realtimeAccess");
|
|
129
129
|
var models_1 = require("../sync/models");
|
|
130
130
|
var registry_1 = require("../sync/registry");
|
|
131
131
|
var serialize_1 = require("../sync/serialize");
|
|
@@ -274,11 +274,9 @@ var getSocketsInRoom = function (io, room) {
|
|
|
274
274
|
}
|
|
275
275
|
return sockets;
|
|
276
276
|
};
|
|
277
|
-
var canReadDocument = function (entry, user, doc) { return __awaiter(void 0, void 0, void 0, function () {
|
|
278
|
-
return
|
|
279
|
-
|
|
280
|
-
});
|
|
281
|
-
}); };
|
|
277
|
+
var canReadDocument = function (entry, user, doc) { return __awaiter(void 0, void 0, void 0, function () { return __generator(this, function (_a) {
|
|
278
|
+
return [2 /*return*/, (0, realtimeAccess_1.canReadDocumentRealtime)(entry, user, doc)];
|
|
279
|
+
}); }); };
|
|
282
280
|
/**
|
|
283
281
|
* Determine which Socket.io rooms to emit to based on the room strategy.
|
|
284
282
|
* Exported for testing.
|
|
@@ -342,40 +340,49 @@ exports.ensureApiId = ensureApiId;
|
|
|
342
340
|
* was supposed to strip.
|
|
343
341
|
*/
|
|
344
342
|
var serializeDoc = function (entry, doc, method, user) { return __awaiter(void 0, void 0, void 0, function () {
|
|
345
|
-
var _a, error_1, responseHandler, restMethod, syntheticReq,
|
|
346
|
-
var
|
|
347
|
-
return __generator(this, function (
|
|
348
|
-
switch (
|
|
343
|
+
var _a, error_1, responseHandler, restMethod, syntheticReq, serialized, masked, error_2, fallback, maskedFallback;
|
|
344
|
+
var _b;
|
|
345
|
+
return __generator(this, function (_c) {
|
|
346
|
+
switch (_c.label) {
|
|
349
347
|
case 0:
|
|
350
348
|
if (!entry.config.realtimeResponseHandler) return [3 /*break*/, 4];
|
|
351
|
-
|
|
349
|
+
_c.label = 1;
|
|
352
350
|
case 1:
|
|
353
|
-
|
|
351
|
+
_c.trys.push([1, 3, , 4]);
|
|
354
352
|
_a = exports.ensureApiId;
|
|
355
353
|
return [4 /*yield*/, entry.config.realtimeResponseHandler(doc, method)];
|
|
356
|
-
case 2: return [2 /*return*/, _a.apply(void 0, [
|
|
354
|
+
case 2: return [2 /*return*/, _a.apply(void 0, [_c.sent()])];
|
|
357
355
|
case 3:
|
|
358
|
-
error_1 =
|
|
356
|
+
error_1 = _c.sent();
|
|
359
357
|
logger_1.logger.error("[realtime] realtimeResponseHandler threw for ".concat(entry.modelName, "/").concat(method, ": ").concat(error_1, ". ") +
|
|
360
358
|
"Dropping event to avoid leaking unsanitized data.");
|
|
361
359
|
throw error_1;
|
|
362
360
|
case 4:
|
|
363
|
-
responseHandler = (
|
|
364
|
-
if (!responseHandler) return [3 /*break*/,
|
|
365
|
-
|
|
361
|
+
responseHandler = (_b = entry.options) === null || _b === void 0 ? void 0 : _b.responseHandler;
|
|
362
|
+
if (!responseHandler) return [3 /*break*/, 9];
|
|
363
|
+
_c.label = 5;
|
|
366
364
|
case 5:
|
|
367
|
-
|
|
365
|
+
_c.trys.push([5, 8, , 9]);
|
|
368
366
|
restMethod = method === "delete" ? "read" : method;
|
|
369
367
|
syntheticReq = { params: {}, query: {}, user: user };
|
|
370
|
-
_b = exports.ensureApiId;
|
|
371
368
|
return [4 /*yield*/, responseHandler(doc, restMethod, syntheticReq, entry.options)];
|
|
372
|
-
case 6:
|
|
369
|
+
case 6:
|
|
370
|
+
serialized = _c.sent();
|
|
371
|
+
return [4 /*yield*/, (0, realtimeAccess_1.maskRealtimeDocument)(entry, user, serialized, restMethod)];
|
|
373
372
|
case 7:
|
|
374
|
-
|
|
373
|
+
masked = _c.sent();
|
|
374
|
+
return [2 /*return*/, (0, exports.ensureApiId)(masked)];
|
|
375
|
+
case 8:
|
|
376
|
+
error_2 = _c.sent();
|
|
375
377
|
logger_1.logger.error("[realtime] modelRouter responseHandler threw during realtime serialization for " +
|
|
376
378
|
"".concat(entry.modelName, "/").concat(method, ": ").concat(error_2, ". Dropping event to avoid leaking unsanitized data."));
|
|
377
379
|
throw error_2;
|
|
378
|
-
case
|
|
380
|
+
case 9:
|
|
381
|
+
fallback = typeof doc.toJSON === "function" ? doc.toJSON() : doc;
|
|
382
|
+
return [4 /*yield*/, (0, realtimeAccess_1.maskRealtimeDocument)(entry, user, fallback, method === "delete" ? "read" : method)];
|
|
383
|
+
case 10:
|
|
384
|
+
maskedFallback = _c.sent();
|
|
385
|
+
return [2 /*return*/, (0, exports.ensureApiId)(maskedFallback)];
|
|
379
386
|
}
|
|
380
387
|
});
|
|
381
388
|
}); };
|
|
@@ -398,50 +405,52 @@ var emitPayloadToAuthorizedRoom = function (_a) { return __awaiter(void 0, [_a],
|
|
|
398
405
|
sockets = getSocketsInRoom(io, room);
|
|
399
406
|
_g.label = 1;
|
|
400
407
|
case 1:
|
|
401
|
-
_g.trys.push([1,
|
|
408
|
+
_g.trys.push([1, 10, 11, 12]);
|
|
402
409
|
sockets_1 = __values(sockets), sockets_1_1 = sockets_1.next();
|
|
403
410
|
_g.label = 2;
|
|
404
411
|
case 2:
|
|
405
|
-
if (!!sockets_1_1.done) return [3 /*break*/,
|
|
412
|
+
if (!!sockets_1_1.done) return [3 /*break*/, 9];
|
|
406
413
|
socket = sockets_1_1.value;
|
|
407
|
-
|
|
408
|
-
_g.label = 3;
|
|
414
|
+
return [4 /*yield*/, (0, socketUser_1.awaitSocketFullUser)(socket)];
|
|
409
415
|
case 3:
|
|
410
|
-
_g.
|
|
416
|
+
user = _g.sent();
|
|
417
|
+
_g.label = 4;
|
|
418
|
+
case 4:
|
|
419
|
+
_g.trys.push([4, 7, , 8]);
|
|
411
420
|
permissionDocument = fullDocument !== null && fullDocument !== void 0 ? fullDocument : {};
|
|
412
421
|
return [4 /*yield*/, canReadDocument(entry, user, permissionDocument)];
|
|
413
|
-
case
|
|
422
|
+
case 5:
|
|
414
423
|
canRead = _g.sent();
|
|
415
424
|
if (!canRead) {
|
|
416
425
|
logDebug("[realtime] Skipped ".concat(room, " for ").concat(socket.id, ": read permission denied"));
|
|
417
|
-
return [3 /*break*/,
|
|
426
|
+
return [3 /*break*/, 8];
|
|
418
427
|
}
|
|
419
428
|
_d = (_c = socket).emit;
|
|
420
429
|
_e = [eventName];
|
|
421
430
|
return [4 /*yield*/, buildPayload(user)];
|
|
422
|
-
case 5:
|
|
423
|
-
_d.apply(_c, _e.concat([_g.sent()]));
|
|
424
|
-
return [3 /*break*/, 7];
|
|
425
431
|
case 6:
|
|
432
|
+
_d.apply(_c, _e.concat([_g.sent()]));
|
|
433
|
+
return [3 /*break*/, 8];
|
|
434
|
+
case 7:
|
|
426
435
|
error_3 = _g.sent();
|
|
427
436
|
logger_1.logger.error("[realtime] Failed to emit ".concat(eventName, " for ").concat(entry.modelName, " to socket ").concat(socket.id, ": ").concat(error_3));
|
|
428
437
|
Sentry.captureException(error_3);
|
|
429
|
-
return [3 /*break*/,
|
|
430
|
-
case
|
|
438
|
+
return [3 /*break*/, 8];
|
|
439
|
+
case 8:
|
|
431
440
|
sockets_1_1 = sockets_1.next();
|
|
432
441
|
return [3 /*break*/, 2];
|
|
433
|
-
case
|
|
434
|
-
case
|
|
442
|
+
case 9: return [3 /*break*/, 12];
|
|
443
|
+
case 10:
|
|
435
444
|
e_2_1 = _g.sent();
|
|
436
445
|
e_2 = { error: e_2_1 };
|
|
437
|
-
return [3 /*break*/,
|
|
438
|
-
case
|
|
446
|
+
return [3 /*break*/, 12];
|
|
447
|
+
case 11:
|
|
439
448
|
try {
|
|
440
449
|
if (sockets_1_1 && !sockets_1_1.done && (_f = sockets_1.return)) _f.call(sockets_1);
|
|
441
450
|
}
|
|
442
451
|
finally { if (e_2) throw e_2.error; }
|
|
443
452
|
return [7 /*endfinally*/];
|
|
444
|
-
case
|
|
453
|
+
case 12: return [2 /*return*/];
|
|
445
454
|
}
|
|
446
455
|
});
|
|
447
456
|
}); };
|
|
@@ -85,7 +85,7 @@ var Sentry = __importStar(require("@sentry/bun"));
|
|
|
85
85
|
var socket_io_1 = require("socket.io");
|
|
86
86
|
var errors_1 = require("../errors");
|
|
87
87
|
var logger_1 = require("../logger");
|
|
88
|
-
var
|
|
88
|
+
var realtimeAccess_1 = require("../rbac/realtimeAccess");
|
|
89
89
|
var registry_1 = require("../sync/registry");
|
|
90
90
|
var socketHandlers_1 = require("../sync/socketHandlers");
|
|
91
91
|
var syncApp_1 = require("../sync/syncApp");
|
|
@@ -126,13 +126,9 @@ var redactCredentials = function (url) {
|
|
|
126
126
|
}
|
|
127
127
|
};
|
|
128
128
|
exports.redactCredentials = redactCredentials;
|
|
129
|
-
var canSubscribe = function (entry, method, user) { return __awaiter(void 0, void 0, void 0, function () {
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
permissions = entry.options.permissions[method];
|
|
133
|
-
return [2 /*return*/, (0, permissions_1.checkPermissions)(method, permissions, user)];
|
|
134
|
-
});
|
|
135
|
-
}); };
|
|
129
|
+
var canSubscribe = function (entry, method, user) { return __awaiter(void 0, void 0, void 0, function () { return __generator(this, function (_a) {
|
|
130
|
+
return [2 /*return*/, (0, realtimeAccess_1.canSubscribeRealtime)(entry, method, user)];
|
|
131
|
+
}); }); };
|
|
136
132
|
var getAuthorizedQuery = function (entry, query, user) { return __awaiter(void 0, void 0, void 0, function () {
|
|
137
133
|
var filteredQuery, error_1;
|
|
138
134
|
return __generator(this, function (_a) {
|
|
@@ -23,6 +23,11 @@ export interface RealtimeRegistryEntry {
|
|
|
23
23
|
* when the `realtime` option is provided.
|
|
24
24
|
*/
|
|
25
25
|
export declare const registerRealtime: (entry: RealtimeRegistryEntry) => void;
|
|
26
|
+
/**
|
|
27
|
+
* Replace options on an existing registry entry (e.g. after TerrenoApp injects accessControl).
|
|
28
|
+
* Matches by routePath; no-op if the route was never registered.
|
|
29
|
+
*/
|
|
30
|
+
export declare const updateRealtimeRegistryOptions: (routePath: string, options: ModelRouterOptions<unknown>) => void;
|
|
26
31
|
/**
|
|
27
32
|
* Get all registered real-time models.
|
|
28
33
|
*/
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.clearRealtimeRegistry = exports.findRegistryEntryByRoutePath = exports.findRegistryEntryByCollection = exports.getRealtimeRegistry = exports.registerRealtime = void 0;
|
|
3
|
+
exports.clearRealtimeRegistry = exports.findRegistryEntryByRoutePath = exports.findRegistryEntryByCollection = exports.getRealtimeRegistry = exports.updateRealtimeRegistryOptions = exports.registerRealtime = void 0;
|
|
4
4
|
var realtimeRegistry = [];
|
|
5
5
|
/**
|
|
6
6
|
* Register a model for real-time sync. Called automatically by modelRouter
|
|
@@ -10,6 +10,18 @@ var registerRealtime = function (entry) {
|
|
|
10
10
|
realtimeRegistry.push(entry);
|
|
11
11
|
};
|
|
12
12
|
exports.registerRealtime = registerRealtime;
|
|
13
|
+
/**
|
|
14
|
+
* Replace options on an existing registry entry (e.g. after TerrenoApp injects accessControl).
|
|
15
|
+
* Matches by routePath; no-op if the route was never registered.
|
|
16
|
+
*/
|
|
17
|
+
var updateRealtimeRegistryOptions = function (routePath, options) {
|
|
18
|
+
var existing = realtimeRegistry.find(function (entry) { return entry.routePath === routePath; });
|
|
19
|
+
if (!existing) {
|
|
20
|
+
return;
|
|
21
|
+
}
|
|
22
|
+
existing.options = options;
|
|
23
|
+
};
|
|
24
|
+
exports.updateRealtimeRegistryOptions = updateRealtimeRegistryOptions;
|
|
13
25
|
/**
|
|
14
26
|
* Get all registered real-time models.
|
|
15
27
|
*/
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
import type { Schema } from "mongoose";
|
|
2
|
+
import type { AdminConfig, AdminModelAdminMap } from "./adminTypes";
|
|
3
|
+
export interface ScrubAdminFieldsParams {
|
|
4
|
+
admin: AdminConfig;
|
|
5
|
+
allModelAdmins?: AdminModelAdminMap;
|
|
6
|
+
fieldName?: string;
|
|
7
|
+
schema?: Schema;
|
|
8
|
+
}
|
|
9
|
+
/**
|
|
10
|
+
* Removes `excludeFields` and `hiddenFields` from a document (or nested value).
|
|
11
|
+
* Populated refs are scrubbed using the referenced model's admin config when present
|
|
12
|
+
* in `allModelAdmins` (keyed by Mongoose model name).
|
|
13
|
+
*/
|
|
14
|
+
export declare const scrubAdminFields: (value: unknown, params: ScrubAdminFieldsParams) => unknown;
|
|
15
|
+
/** Keys stripped from POST/PATCH bodies when `admin` is set on modelRouter. */
|
|
16
|
+
export declare const adminBodyFieldsToStrip: (admin: AdminConfig) => Set<string>;
|
|
17
|
+
export declare const stripAdminBodyFields: <T extends Record<string, unknown>>(body: T | T[] | null | undefined, admin: AdminConfig) => T | T[] | null | undefined;
|
|
@@ -0,0 +1,192 @@
|
|
|
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 __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 __values = (this && this.__values) || function(o) {
|
|
39
|
+
var s = typeof Symbol === "function" && Symbol.iterator, m = s && o[s], i = 0;
|
|
40
|
+
if (m) return m.call(o);
|
|
41
|
+
if (o && typeof o.length === "number") return {
|
|
42
|
+
next: function () {
|
|
43
|
+
if (o && i >= o.length) o = void 0;
|
|
44
|
+
return { value: o && o[i++], done: !o };
|
|
45
|
+
}
|
|
46
|
+
};
|
|
47
|
+
throw new TypeError(s ? "Object is not iterable." : "Symbol.iterator is not defined.");
|
|
48
|
+
};
|
|
49
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
50
|
+
exports.stripAdminBodyFields = exports.adminBodyFieldsToStrip = exports.scrubAdminFields = void 0;
|
|
51
|
+
var toPlainObject = function (value) {
|
|
52
|
+
if (value &&
|
|
53
|
+
typeof value === "object" &&
|
|
54
|
+
"toObject" in value &&
|
|
55
|
+
typeof value.toObject === "function") {
|
|
56
|
+
return value.toObject();
|
|
57
|
+
}
|
|
58
|
+
if (value && typeof value === "object" && !Array.isArray(value)) {
|
|
59
|
+
return value;
|
|
60
|
+
}
|
|
61
|
+
return {};
|
|
62
|
+
};
|
|
63
|
+
var adminFieldsToStrip = function (admin) {
|
|
64
|
+
var _a, _b;
|
|
65
|
+
return new Set(__spreadArray(__spreadArray([], __read(((_a = admin.excludeFields) !== null && _a !== void 0 ? _a : [])), false), __read(((_b = admin.hiddenFields) !== null && _b !== void 0 ? _b : [])), false));
|
|
66
|
+
};
|
|
67
|
+
var getRefModelName = function (schemaPath) {
|
|
68
|
+
if (!schemaPath) {
|
|
69
|
+
return undefined;
|
|
70
|
+
}
|
|
71
|
+
var options = schemaPath.options;
|
|
72
|
+
if (typeof (options === null || options === void 0 ? void 0 : options.ref) === "string" && options.ref.length > 0) {
|
|
73
|
+
return options.ref;
|
|
74
|
+
}
|
|
75
|
+
return undefined;
|
|
76
|
+
};
|
|
77
|
+
var isPopulatedDocument = function (value) {
|
|
78
|
+
if (!value || typeof value !== "object" || Array.isArray(value)) {
|
|
79
|
+
return false;
|
|
80
|
+
}
|
|
81
|
+
var plain = value;
|
|
82
|
+
return plain._id != null && Object.keys(plain).length > 1;
|
|
83
|
+
};
|
|
84
|
+
var scrubPlainObject = function (plain, admin, schema, allModelAdmins) {
|
|
85
|
+
var e_1, _a;
|
|
86
|
+
var strip = adminFieldsToStrip(admin);
|
|
87
|
+
var next = {};
|
|
88
|
+
var _loop_1 = function (key, fieldValue) {
|
|
89
|
+
if (strip.has(key)) {
|
|
90
|
+
return "continue";
|
|
91
|
+
}
|
|
92
|
+
if (fieldValue == null) {
|
|
93
|
+
next[key] = fieldValue;
|
|
94
|
+
return "continue";
|
|
95
|
+
}
|
|
96
|
+
if (Array.isArray(fieldValue)) {
|
|
97
|
+
next[key] = fieldValue.map(function (item) {
|
|
98
|
+
return (0, exports.scrubAdminFields)(item, { admin: admin, allModelAdmins: allModelAdmins, fieldName: key, schema: schema });
|
|
99
|
+
});
|
|
100
|
+
return "continue";
|
|
101
|
+
}
|
|
102
|
+
if (isPopulatedDocument(fieldValue) && schema) {
|
|
103
|
+
var refModelName = getRefModelName(schema.path(key));
|
|
104
|
+
var refAdmin = refModelName ? allModelAdmins === null || allModelAdmins === void 0 ? void 0 : allModelAdmins[refModelName] : undefined;
|
|
105
|
+
if (refAdmin) {
|
|
106
|
+
next[key] = (0, exports.scrubAdminFields)(fieldValue, {
|
|
107
|
+
admin: refAdmin,
|
|
108
|
+
allModelAdmins: allModelAdmins,
|
|
109
|
+
schema: undefined,
|
|
110
|
+
});
|
|
111
|
+
return "continue";
|
|
112
|
+
}
|
|
113
|
+
}
|
|
114
|
+
next[key] = fieldValue;
|
|
115
|
+
};
|
|
116
|
+
try {
|
|
117
|
+
for (var _b = __values(Object.entries(plain)), _c = _b.next(); !_c.done; _c = _b.next()) {
|
|
118
|
+
var _d = __read(_c.value, 2), key = _d[0], fieldValue = _d[1];
|
|
119
|
+
_loop_1(key, fieldValue);
|
|
120
|
+
}
|
|
121
|
+
}
|
|
122
|
+
catch (e_1_1) { e_1 = { error: e_1_1 }; }
|
|
123
|
+
finally {
|
|
124
|
+
try {
|
|
125
|
+
if (_c && !_c.done && (_a = _b.return)) _a.call(_b);
|
|
126
|
+
}
|
|
127
|
+
finally { if (e_1) throw e_1.error; }
|
|
128
|
+
}
|
|
129
|
+
return next;
|
|
130
|
+
};
|
|
131
|
+
/**
|
|
132
|
+
* Removes `excludeFields` and `hiddenFields` from a document (or nested value).
|
|
133
|
+
* Populated refs are scrubbed using the referenced model's admin config when present
|
|
134
|
+
* in `allModelAdmins` (keyed by Mongoose model name).
|
|
135
|
+
*/
|
|
136
|
+
var scrubAdminFields = function (value, params) {
|
|
137
|
+
if (value == null) {
|
|
138
|
+
return value;
|
|
139
|
+
}
|
|
140
|
+
if (Array.isArray(value)) {
|
|
141
|
+
return value.map(function (item) { return (0, exports.scrubAdminFields)(item, params); });
|
|
142
|
+
}
|
|
143
|
+
if (typeof value !== "object") {
|
|
144
|
+
return value;
|
|
145
|
+
}
|
|
146
|
+
var plain = toPlainObject(value);
|
|
147
|
+
return scrubPlainObject(plain, params.admin, params.schema, params.allModelAdmins);
|
|
148
|
+
};
|
|
149
|
+
exports.scrubAdminFields = scrubAdminFields;
|
|
150
|
+
/** Keys stripped from POST/PATCH bodies when `admin` is set on modelRouter. */
|
|
151
|
+
var adminBodyFieldsToStrip = function (admin) {
|
|
152
|
+
var _a, _b, _c;
|
|
153
|
+
return new Set(__spreadArray(__spreadArray(__spreadArray([], __read(((_a = admin.readonlyFields) !== null && _a !== void 0 ? _a : [])), false), __read(((_b = admin.excludeFields) !== null && _b !== void 0 ? _b : [])), false), __read(((_c = admin.hiddenFields) !== null && _c !== void 0 ? _c : [])), false));
|
|
154
|
+
};
|
|
155
|
+
exports.adminBodyFieldsToStrip = adminBodyFieldsToStrip;
|
|
156
|
+
var stripAdminBodyFields = function (body, admin) {
|
|
157
|
+
if (body == null) {
|
|
158
|
+
return body;
|
|
159
|
+
}
|
|
160
|
+
var strip = (0, exports.adminBodyFieldsToStrip)(admin);
|
|
161
|
+
var stripObject = function (obj) {
|
|
162
|
+
var e_2, _a;
|
|
163
|
+
var next = __assign({}, obj);
|
|
164
|
+
try {
|
|
165
|
+
for (var strip_1 = __values(strip), strip_1_1 = strip_1.next(); !strip_1_1.done; strip_1_1 = strip_1.next()) {
|
|
166
|
+
var key = strip_1_1.value;
|
|
167
|
+
delete next[key];
|
|
168
|
+
}
|
|
169
|
+
}
|
|
170
|
+
catch (e_2_1) { e_2 = { error: e_2_1 }; }
|
|
171
|
+
finally {
|
|
172
|
+
try {
|
|
173
|
+
if (strip_1_1 && !strip_1_1.done && (_a = strip_1.return)) _a.call(strip_1);
|
|
174
|
+
}
|
|
175
|
+
finally { if (e_2) throw e_2.error; }
|
|
176
|
+
}
|
|
177
|
+
return next;
|
|
178
|
+
};
|
|
179
|
+
if (Array.isArray(body)) {
|
|
180
|
+
return body.map(function (item) {
|
|
181
|
+
if (!item || typeof item !== "object") {
|
|
182
|
+
return item;
|
|
183
|
+
}
|
|
184
|
+
return stripObject(item);
|
|
185
|
+
});
|
|
186
|
+
}
|
|
187
|
+
if (typeof body !== "object") {
|
|
188
|
+
return body;
|
|
189
|
+
}
|
|
190
|
+
return stripObject(body);
|
|
191
|
+
};
|
|
192
|
+
exports.stripAdminBodyFields = stripAdminBodyFields;
|
package/dist/sync/executors.d.ts
CHANGED
|
@@ -17,7 +17,7 @@
|
|
|
17
17
|
import type express from "express";
|
|
18
18
|
import type { Document, Model } from "mongoose";
|
|
19
19
|
import { type ModelRouterOptions } from "../api";
|
|
20
|
-
import type
|
|
20
|
+
import { type User } from "../auth";
|
|
21
21
|
import { APIError, type APIErrorConstructor } from "../errors";
|
|
22
22
|
/** A hydrated mongoose document joined with the router's base type. */
|
|
23
23
|
export type ExecutorDoc<T> = Document<unknown, unknown, unknown> & T;
|
package/dist/sync/executors.js
CHANGED
|
@@ -69,9 +69,11 @@ exports.runPostDelete = exports.executeDelete = exports.runPostUpdate = exports.
|
|
|
69
69
|
var cloneDeep_1 = __importDefault(require("lodash/cloneDeep"));
|
|
70
70
|
var luxon_1 = require("luxon");
|
|
71
71
|
var api_1 = require("../api");
|
|
72
|
+
var auth_1 = require("../auth");
|
|
72
73
|
var docLoader_1 = require("../docLoader");
|
|
73
74
|
var errors_1 = require("../errors");
|
|
74
75
|
var permissions_1 = require("../permissions");
|
|
76
|
+
var modelRouterAccess_1 = require("../rbac/modelRouterAccess");
|
|
75
77
|
var transformers_1 = require("../transformers");
|
|
76
78
|
/**
|
|
77
79
|
* Thrown by executeUpdate when a concurrency check fails. Carries the current server document
|
|
@@ -212,6 +214,8 @@ var executeCreate = function (_a) { return __awaiter(void 0, [_a], void 0, funct
|
|
|
212
214
|
}
|
|
213
215
|
_c.label = 6;
|
|
214
216
|
case 6:
|
|
217
|
+
cleanedBody = (0, auth_1.omitUserRolesFromWriteBody)(model.modelName, options.accessControl, cleanedBody, request
|
|
218
|
+
.terrenoAllowUserAdminWrite === true);
|
|
215
219
|
if (cleanedBody === undefined) {
|
|
216
220
|
throw new errors_1.BadRequestError({
|
|
217
221
|
code: "invalid-request-body",
|
|
@@ -219,55 +223,63 @@ var executeCreate = function (_a) { return __awaiter(void 0, [_a], void 0, funct
|
|
|
219
223
|
title: "Invalid request body",
|
|
220
224
|
});
|
|
221
225
|
}
|
|
222
|
-
|
|
226
|
+
return [4 /*yield*/, (0, modelRouterAccess_1.validateAccessWritePayload)({
|
|
227
|
+
body: cleanedBody,
|
|
228
|
+
options: options,
|
|
229
|
+
phase: "create",
|
|
230
|
+
user: user,
|
|
231
|
+
})];
|
|
223
232
|
case 7:
|
|
224
|
-
_c.
|
|
225
|
-
|
|
233
|
+
_c.sent();
|
|
234
|
+
_c.label = 8;
|
|
226
235
|
case 8:
|
|
227
|
-
|
|
228
|
-
return [
|
|
236
|
+
_c.trys.push([8, 10, , 11]);
|
|
237
|
+
return [4 /*yield*/, model.create(cleanedBody)];
|
|
229
238
|
case 9:
|
|
239
|
+
data = (_c.sent());
|
|
240
|
+
return [3 /*break*/, 11];
|
|
241
|
+
case 10:
|
|
230
242
|
error_2 = _c.sent();
|
|
231
243
|
throw (0, errors_1.passthroughOrWrapWrite)(error_2, {
|
|
232
244
|
code: "create-error",
|
|
233
245
|
status: 400,
|
|
234
246
|
title: "Create error",
|
|
235
247
|
});
|
|
236
|
-
case 10:
|
|
237
|
-
if (!options.populatePaths) return [3 /*break*/, 14];
|
|
238
|
-
_c.label = 11;
|
|
239
248
|
case 11:
|
|
240
|
-
|
|
249
|
+
if (!options.populatePaths) return [3 /*break*/, 15];
|
|
250
|
+
_c.label = 12;
|
|
251
|
+
case 12:
|
|
252
|
+
_c.trys.push([12, 14, , 15]);
|
|
241
253
|
populateQuery = model.findById(data._id);
|
|
242
254
|
populateQuery = (0, api_1.addPopulateToQuery)(populateQuery, options.populatePaths);
|
|
243
255
|
return [4 /*yield*/, populateQuery.exec()];
|
|
244
|
-
case 12:
|
|
245
|
-
data = _c.sent();
|
|
246
|
-
return [3 /*break*/, 14];
|
|
247
256
|
case 13:
|
|
257
|
+
data = _c.sent();
|
|
258
|
+
return [3 /*break*/, 15];
|
|
259
|
+
case 14:
|
|
248
260
|
error_3 = _c.sent();
|
|
249
261
|
throw (0, errors_1.passthroughOrWrap)(error_3, {
|
|
250
262
|
code: "populate-error",
|
|
251
263
|
status: 400,
|
|
252
264
|
title: "Populate error",
|
|
253
265
|
});
|
|
254
|
-
case 14:
|
|
255
|
-
if (!(options.postCreate && !skipPostHooks)) return [3 /*break*/, 18];
|
|
256
|
-
_c.label = 15;
|
|
257
266
|
case 15:
|
|
258
|
-
|
|
259
|
-
|
|
267
|
+
if (!(options.postCreate && !skipPostHooks)) return [3 /*break*/, 19];
|
|
268
|
+
_c.label = 16;
|
|
260
269
|
case 16:
|
|
261
|
-
_c.
|
|
262
|
-
return [
|
|
270
|
+
_c.trys.push([16, 18, , 19]);
|
|
271
|
+
return [4 /*yield*/, options.postCreate(data, request)];
|
|
263
272
|
case 17:
|
|
273
|
+
_c.sent();
|
|
274
|
+
return [3 /*break*/, 19];
|
|
275
|
+
case 18:
|
|
264
276
|
error_4 = _c.sent();
|
|
265
277
|
throw (0, errors_1.passthroughOrWrap)(error_4, {
|
|
266
278
|
code: "post-create-hook-error",
|
|
267
279
|
status: 400,
|
|
268
280
|
title: "postCreate hook error",
|
|
269
281
|
});
|
|
270
|
-
case
|
|
282
|
+
case 19: return [2 /*return*/, { doc: data }];
|
|
271
283
|
}
|
|
272
284
|
});
|
|
273
285
|
}); };
|
|
@@ -386,6 +398,17 @@ var executeUpdate = function (_a) { return __awaiter(void 0, [_a], void 0, funct
|
|
|
386
398
|
}
|
|
387
399
|
_h.label = 10;
|
|
388
400
|
case 10:
|
|
401
|
+
cleanedBody = (0, auth_1.omitUserRolesFromWriteBody)(model.modelName, options.accessControl, cleanedBody, request
|
|
402
|
+
.terrenoAllowUserAdminWrite === true);
|
|
403
|
+
return [4 /*yield*/, (0, modelRouterAccess_1.validateAccessWritePayload)({
|
|
404
|
+
body: cleanedBody,
|
|
405
|
+
doc: doc,
|
|
406
|
+
options: options,
|
|
407
|
+
phase: "write",
|
|
408
|
+
user: user,
|
|
409
|
+
})];
|
|
410
|
+
case 11:
|
|
411
|
+
_h.sent();
|
|
389
412
|
// Conflict detection runs after preUpdate so that unauthorized mutations
|
|
390
413
|
// are rejected before we leak document data in a conflict response.
|
|
391
414
|
if ((concurrencyCheck === null || concurrencyCheck === void 0 ? void 0 : concurrencyCheck.type) === "timestamp") {
|
|
@@ -439,19 +462,19 @@ var executeUpdate = function (_a) { return __awaiter(void 0, [_a], void 0, funct
|
|
|
439
462
|
}
|
|
440
463
|
}
|
|
441
464
|
prevDoc = (0, cloneDeep_1.default)(doc);
|
|
442
|
-
_h.label =
|
|
443
|
-
case
|
|
444
|
-
_h.trys.push([
|
|
465
|
+
_h.label = 12;
|
|
466
|
+
case 12:
|
|
467
|
+
_h.trys.push([12, 14, , 17]);
|
|
445
468
|
doc.set(cleanedBody);
|
|
446
469
|
return [4 /*yield*/, doc.save()];
|
|
447
|
-
case 12:
|
|
448
|
-
_h.sent();
|
|
449
|
-
return [3 /*break*/, 16];
|
|
450
470
|
case 13:
|
|
471
|
+
_h.sent();
|
|
472
|
+
return [3 /*break*/, 17];
|
|
473
|
+
case 14:
|
|
451
474
|
error_6 = _h.sent();
|
|
452
|
-
if (!((concurrencyCheck === null || concurrencyCheck === void 0 ? void 0 : concurrencyCheck.type) === "seq" && (0, exports.isVersionError)(error_6))) return [3 /*break*/,
|
|
475
|
+
if (!((concurrencyCheck === null || concurrencyCheck === void 0 ? void 0 : concurrencyCheck.type) === "seq" && (0, exports.isVersionError)(error_6))) return [3 /*break*/, 16];
|
|
453
476
|
return [4 /*yield*/, reloadDocForConflict(model, id)];
|
|
454
|
-
case
|
|
477
|
+
case 15:
|
|
455
478
|
current = _h.sent();
|
|
456
479
|
serverSeq = (_g = current === null || current === void 0 ? void 0 : current._syncSeq) !== null && _g !== void 0 ? _g : 0;
|
|
457
480
|
throw new ExecutorConflictError({
|
|
@@ -463,30 +486,30 @@ var executeUpdate = function (_a) { return __awaiter(void 0, [_a], void 0, funct
|
|
|
463
486
|
status: 409,
|
|
464
487
|
title: "Sync conflict on ".concat(model.modelName, ":").concat(id, ": a concurrent write landed while this update was in flight (baseSeq ").concat(concurrencyCheck.baseSeq, ")"),
|
|
465
488
|
});
|
|
466
|
-
case
|
|
489
|
+
case 16: throw (0, errors_1.passthroughOrWrapWrite)(error_6, {
|
|
467
490
|
code: "update-save-error",
|
|
468
491
|
detail: "preUpdate hook save error on ".concat(id, ": ").concat((0, errors_1.errorMessage)(error_6)),
|
|
469
492
|
status: 400,
|
|
470
493
|
title: "preUpdate hook save error",
|
|
471
494
|
});
|
|
472
|
-
case
|
|
473
|
-
if (!options.populatePaths) return [3 /*break*/,
|
|
495
|
+
case 17:
|
|
496
|
+
if (!options.populatePaths) return [3 /*break*/, 19];
|
|
474
497
|
populateQuery = model.findById(doc._id);
|
|
475
498
|
populateQuery = (0, api_1.addPopulateToQuery)(populateQuery, options.populatePaths);
|
|
476
499
|
return [4 /*yield*/, populateQuery.exec()];
|
|
477
|
-
case 17:
|
|
478
|
-
doc = _h.sent();
|
|
479
|
-
_h.label = 18;
|
|
480
500
|
case 18:
|
|
481
|
-
|
|
501
|
+
doc = _h.sent();
|
|
482
502
|
_h.label = 19;
|
|
483
503
|
case 19:
|
|
484
|
-
|
|
485
|
-
|
|
504
|
+
if (!(options.postUpdate && !skipPostHooks)) return [3 /*break*/, 23];
|
|
505
|
+
_h.label = 20;
|
|
486
506
|
case 20:
|
|
487
|
-
_h.
|
|
488
|
-
return [
|
|
507
|
+
_h.trys.push([20, 22, , 23]);
|
|
508
|
+
return [4 /*yield*/, options.postUpdate(doc, cleanedBody, request, prevDoc)];
|
|
489
509
|
case 21:
|
|
510
|
+
_h.sent();
|
|
511
|
+
return [3 /*break*/, 23];
|
|
512
|
+
case 22:
|
|
490
513
|
error_7 = _h.sent();
|
|
491
514
|
throw (0, errors_1.passthroughOrWrap)(error_7, {
|
|
492
515
|
code: "post-update-hook-error",
|
|
@@ -494,7 +517,7 @@ var executeUpdate = function (_a) { return __awaiter(void 0, [_a], void 0, funct
|
|
|
494
517
|
status: 400,
|
|
495
518
|
title: "postUpdate hook error",
|
|
496
519
|
});
|
|
497
|
-
case
|
|
520
|
+
case 23: return [2 /*return*/, { cleanedBody: cleanedBody, doc: doc, prevDoc: prevDoc }];
|
|
498
521
|
}
|
|
499
522
|
});
|
|
500
523
|
}); };
|