@terreno/api 57.3.0 → 57.4.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 +23 -10
- package/README.md +6 -0
- package/dist/adminTypes.d.ts +7 -0
- package/dist/adminTypes.js +6 -1
- package/dist/api.d.ts +10 -0
- package/dist/api.js +99 -36
- package/dist/audit/auditApp.d.ts +30 -0
- package/dist/audit/auditApp.js +155 -0
- package/dist/audit/auditEventModel.d.ts +29 -0
- package/dist/audit/auditEventModel.js +102 -0
- package/dist/audit/cloudTasksEnqueue.d.ts +32 -0
- package/dist/audit/cloudTasksEnqueue.js +162 -0
- package/dist/audit/diff.d.ts +10 -0
- package/dist/audit/diff.js +230 -0
- package/dist/audit/processQueue.d.ts +6 -0
- package/dist/audit/processQueue.js +101 -0
- package/dist/audit/rbacSink.d.ts +2 -0
- package/dist/audit/rbacSink.js +82 -0
- package/dist/audit/record.d.ts +56 -0
- package/dist/audit/record.js +373 -0
- package/dist/betterAuth.d.ts +6 -0
- package/dist/betterAuthSetup.js +1 -1
- package/dist/collectionRegistry.d.ts +3 -1
- package/dist/collectionRegistry.js +25 -0
- package/dist/index.d.ts +26 -1
- package/dist/index.js +48 -2
- package/dist/mcp/query.d.ts +0 -13
- package/dist/mcp/query.js +8 -8
- package/dist/migrations/fixtures/all-down/20260910120000-one.d.ts +4 -0
- package/dist/migrations/fixtures/all-down/20260910120000-one.js +49 -0
- package/dist/migrations/fixtures/all-down/20260910120001-two.d.ts +4 -0
- package/dist/migrations/fixtures/all-down/20260910120001-two.js +49 -0
- package/dist/migrations/fixtures/bad-id/20260910120000-mismatch.d.ts +3 -0
- package/dist/migrations/fixtures/bad-id/20260910120000-mismatch.js +45 -0
- package/dist/migrations/fixtures/bad-name/not-a-migration.d.ts +3 -0
- package/dist/migrations/fixtures/bad-name/not-a-migration.js +45 -0
- package/dist/migrations/fixtures/missing-up/20260910120000-noup.d.ts +2 -0
- package/dist/migrations/fixtures/missing-up/20260910120000-noup.js +5 -0
- package/dist/migrations/fixtures/valid/20260910120000-alpha.d.ts +3 -0
- package/dist/migrations/fixtures/valid/20260910120000-alpha.js +45 -0
- package/dist/migrations/fixtures/valid/20260910120001-beta.d.ts +4 -0
- package/dist/migrations/fixtures/valid/20260910120001-beta.js +49 -0
- package/dist/migrations/generate.d.ts +17 -0
- package/dist/migrations/generate.js +277 -0
- package/dist/migrations/load.d.ts +20 -0
- package/dist/migrations/load.js +236 -0
- package/dist/migrations/lock.d.ts +13 -0
- package/dist/migrations/lock.js +145 -0
- package/dist/migrations/runner.d.ts +42 -0
- package/dist/migrations/runner.js +503 -0
- package/dist/migrations/schemaCatalog.d.ts +44 -0
- package/dist/migrations/schemaCatalog.js +326 -0
- package/dist/migrations/types.d.ts +87 -0
- package/dist/migrations/types.js +7 -0
- package/dist/models/notification.d.ts +2 -0
- package/dist/models/notification.js +62 -0
- package/dist/models/notificationPreference.d.ts +2 -0
- package/dist/models/notificationPreference.js +49 -0
- package/dist/notifications/notificationService.d.ts +40 -0
- package/dist/notifications/notificationService.js +323 -0
- package/dist/notifications/notificationsApp.d.ts +18 -0
- package/dist/notifications/notificationsApp.js +250 -0
- package/dist/notifications/notificationsBeforeSend.d.ts +14 -0
- package/dist/notifications/notificationsBeforeSend.js +77 -0
- package/dist/openApi.d.ts +1 -7
- package/dist/openApi.js +7 -6
- package/dist/openApiBuilder.d.ts +14 -3
- package/dist/openApiValidator.d.ts +13 -1
- package/dist/openApiValidator.js +200 -36
- package/dist/orgs/orgContext.d.ts +23 -0
- package/dist/orgs/orgContext.js +198 -0
- package/dist/orgs/orgPermissions.d.ts +4 -0
- package/dist/orgs/orgPermissions.js +77 -0
- package/dist/orgs/orgPlugin.d.ts +13 -0
- package/dist/orgs/orgPlugin.js +84 -0
- package/dist/orgs/organizationModel.d.ts +13 -0
- package/dist/orgs/organizationModel.js +301 -0
- package/dist/orgs/organizationSettings.d.ts +19 -0
- package/dist/orgs/organizationSettings.js +120 -0
- package/dist/orgs/orgsApp.d.ts +28 -0
- package/dist/orgs/orgsApp.js +678 -0
- package/dist/permissions.d.ts +7 -13
- package/dist/permissions.js +8 -31
- package/dist/rateLimit/middleware.d.ts +0 -8
- package/dist/rateLimit/middleware.js +2 -3
- package/dist/rateLimit/mongoStore.d.ts +1 -0
- package/dist/rateLimit/mongoStore.js +1 -0
- package/dist/rateLimit/policies.d.ts +0 -4
- package/dist/rateLimit/policies.js +5 -7
- package/dist/rateLimit/redisStore.d.ts +1 -0
- package/dist/rateLimit/redisStore.js +1 -0
- package/dist/rbac/access.js +30 -13
- package/dist/rbac/membershipOrgAdminSource.d.ts +6 -0
- package/dist/rbac/membershipOrgAdminSource.js +122 -0
- package/dist/rbac/modelRouterAccess.d.ts +3 -0
- package/dist/rbac/modelRouterAccess.js +3 -0
- package/dist/rbac/resolve.js +60 -31
- package/dist/rbac/roleModel.d.ts +2 -5
- package/dist/rbac/roleModel.js +18 -4
- package/dist/rbac/statements.d.ts +10 -1
- package/dist/rbac/statements.js +19 -2
- package/dist/rbac/types.d.ts +5 -0
- package/dist/realtime/changeStreamWatcher.d.ts +10 -4
- package/dist/realtime/changeStreamWatcher.js +110 -64
- package/dist/realtime/deprecation.d.ts +1 -0
- package/dist/realtime/deprecation.js +1 -0
- package/dist/realtime/realtimeApp.d.ts +1 -0
- package/dist/realtime/realtimeApp.js +1 -0
- package/dist/schemaMetadata.js +16 -5
- package/dist/sync/adminBroadcastScope.d.ts +40 -0
- package/dist/sync/adminBroadcastScope.js +194 -0
- package/dist/sync/adminWindowAccess.d.ts +13 -0
- package/dist/sync/adminWindowAccess.js +96 -0
- package/dist/sync/adminWindowMutation.d.ts +88 -0
- package/dist/sync/adminWindowMutation.js +247 -0
- package/dist/sync/executors.d.ts +9 -3
- package/dist/sync/executors.js +190 -159
- package/dist/sync/mutationHandler.d.ts +5 -2
- package/dist/sync/mutationHandler.js +191 -71
- package/dist/sync/registry.js +4 -0
- package/dist/sync/routes.d.ts +13 -0
- package/dist/sync/routes.js +113 -56
- package/dist/sync/socketHandlers.d.ts +8 -2
- package/dist/sync/socketHandlers.js +144 -50
- package/dist/sync/streams.d.ts +2 -0
- package/dist/sync/streams.js +7 -1
- package/dist/sync/syncApp.d.ts +2 -1
- package/dist/sync/syncApp.js +2 -1
- package/dist/sync/syncBatch.d.ts +5 -2
- package/dist/sync/syncBatch.js +4 -4
- package/dist/sync/types.d.ts +18 -0
- package/dist/terrenoApp.d.ts +29 -0
- package/dist/terrenoApp.js +91 -54
- package/dist/tests/createTestData.d.ts +1 -3
- package/dist/tests/createTestData.js +3 -5
- package/dist/tests/models.d.ts +1 -0
- package/dist/tests/models.js +9 -2
- package/dist/tests/testHelper.d.ts +0 -5
- package/dist/tests/testHelper.js +2 -9
- package/dist/types/authToken.d.ts +3 -3
- package/dist/types/mcpServiceToken.d.ts +2 -2
- package/dist/types/membership.d.ts +23 -0
- package/dist/types/membership.js +2 -0
- package/dist/types/notification.d.ts +28 -0
- package/dist/types/notification.js +2 -0
- package/dist/types/notificationPreference.d.ts +20 -0
- package/dist/types/notificationPreference.js +2 -0
- package/dist/types/organization.d.ts +36 -0
- package/dist/types/organization.js +2 -0
- package/dist/webhooks/idempotency/webhookReceipt.d.ts +4 -49
- package/dist/webhooks/idempotency/webhookReceipt.js +7 -7
- package/dist/webhooks/rawBody.d.ts +1 -0
- package/dist/webhooks/rawBody.js +1 -0
- package/package.json +31 -25
- package/src/__snapshots__/openApi.test.ts.snap +192 -54
- package/src/__snapshots__/openApiBuilder.test.ts.snap +0 -18
- package/src/__snapshots__/schemaMetadata.test.ts.snap +0 -1
- package/src/adminTypes.ts +8 -0
- package/src/api.test.ts +39 -2
- package/src/api.ts +68 -0
- package/src/audit/auditApp.test.ts +243 -0
- package/src/audit/auditApp.ts +139 -0
- package/src/audit/auditEventModel.ts +156 -0
- package/src/audit/auditRouter.test.ts +456 -0
- package/src/audit/cloudTasksEnqueue.test.ts +124 -0
- package/src/audit/cloudTasksEnqueue.ts +104 -0
- package/src/audit/diff.ts +163 -0
- package/src/audit/processQueue.ts +69 -0
- package/src/audit/rbacSink.test.ts +86 -0
- package/src/audit/rbacSink.ts +42 -0
- package/src/audit/record.test.ts +402 -0
- package/src/audit/record.ts +328 -0
- package/src/auth.test.ts +1 -1
- package/src/betterAuth.ts +7 -0
- package/src/betterAuthSetup.test.ts +27 -0
- package/src/betterAuthSetup.ts +1 -0
- package/src/collectionRegistry.test.ts +8 -9
- package/src/collectionRegistry.ts +21 -1
- package/src/express.d.ts +2 -0
- package/src/expressServer.test.ts +50 -2
- package/src/index.ts +69 -0
- package/src/mcp/handlers.test.ts +275 -0
- package/src/mcp/query.ts +3 -3
- package/src/mcp/toolGenerator.test.ts +81 -0
- package/src/migrations/cli.test.ts +376 -0
- package/src/migrations/cli.ts +283 -0
- package/src/migrations/fixtures/all-down/20260910120000-one.ts +6 -0
- package/src/migrations/fixtures/all-down/20260910120001-two.ts +6 -0
- package/src/migrations/fixtures/bad-id/20260910120000-mismatch.ts +4 -0
- package/src/migrations/fixtures/bad-name/not-a-migration.ts +4 -0
- package/src/migrations/fixtures/missing-up/20260910120000-noup.ts +2 -0
- package/src/migrations/fixtures/valid/20260910120000-alpha.ts +4 -0
- package/src/migrations/fixtures/valid/20260910120001-beta.ts +6 -0
- package/src/migrations/generate.test.ts +333 -0
- package/src/migrations/generate.ts +216 -0
- package/src/migrations/load.test.ts +103 -0
- package/src/migrations/load.ts +124 -0
- package/src/migrations/lock.test.ts +133 -0
- package/src/migrations/lock.ts +118 -0
- package/src/migrations/runner.test.ts +504 -0
- package/src/migrations/runner.ts +358 -0
- package/src/migrations/schemaCatalog.test.ts +159 -0
- package/src/migrations/schemaCatalog.ts +262 -0
- package/src/migrations/types.ts +94 -0
- package/src/models/notification.ts +68 -0
- package/src/models/notificationPreference.ts +62 -0
- package/src/notifications/notificationService.ts +254 -0
- package/src/notifications/notificationsApp.test.ts +505 -0
- package/src/notifications/notificationsApp.ts +200 -0
- package/src/notifications/notificationsBeforeSend.ts +51 -0
- package/src/openApi.test.ts +0 -1
- package/src/openApi.ts +2 -1
- package/src/openApiBuilder.ts +14 -3
- package/src/openApiValidator.test.ts +221 -2
- package/src/openApiValidator.ts +218 -33
- package/src/orgs/orgAccessOptIn.test.ts +87 -0
- package/src/orgs/orgContext.test.ts +259 -0
- package/src/orgs/orgContext.ts +151 -0
- package/src/orgs/orgPermissions.test.ts +105 -0
- package/src/orgs/orgPermissions.ts +40 -0
- package/src/orgs/orgPlugin.test.ts +130 -0
- package/src/orgs/orgPlugin.ts +70 -0
- package/src/orgs/orgRbac.test.ts +267 -0
- package/src/orgs/orgSecurityDefects.test.ts +415 -0
- package/src/orgs/organizationModel.test.ts +205 -0
- package/src/orgs/organizationModel.ts +257 -0
- package/src/orgs/organizationSettings.test.ts +113 -0
- package/src/orgs/organizationSettings.ts +126 -0
- package/src/orgs/orgsApp.test.ts +382 -0
- package/src/orgs/orgsApp.ts +563 -0
- package/src/permissions.test.ts +62 -36
- package/src/permissions.ts +8 -30
- package/src/rateLimit/middleware.ts +1 -1
- package/src/rateLimit/mongoStore.ts +1 -0
- package/src/rateLimit/policies.ts +2 -2
- package/src/rateLimit/redisStore.ts +1 -0
- package/src/rbac/access.ts +11 -3
- package/src/rbac/membershipOrgAdminSource.ts +59 -0
- package/src/rbac/modelRouterAccess.ts +3 -0
- package/src/rbac/permissionUtils.test.ts +26 -5
- package/src/rbac/resolve.test.ts +34 -2
- package/src/rbac/resolve.ts +26 -7
- package/src/rbac/roleModel.test.ts +34 -1
- package/src/rbac/roleModel.ts +17 -1
- package/src/rbac/statements.test.ts +19 -0
- package/src/rbac/statements.ts +19 -1
- package/src/rbac/types.ts +5 -0
- package/src/realtime/changeStreamWatcher.ts +73 -33
- package/src/realtime/deprecation.ts +1 -0
- package/src/realtime/realtime.test.ts +357 -185
- package/src/realtime/realtimeApp.ts +1 -0
- package/src/schemaMetadata.test.ts +14 -0
- package/src/schemaMetadata.ts +5 -5
- package/src/sync/adminBroadcastConfig.test.ts +96 -0
- package/src/sync/adminBroadcastScope.test.ts +155 -0
- package/src/sync/adminBroadcastScope.ts +123 -0
- package/src/sync/adminWindowAccess.test.ts +57 -0
- package/src/sync/adminWindowAccess.ts +32 -0
- package/src/sync/adminWindowMutation.test.ts +450 -0
- package/src/sync/adminWindowMutation.ts +283 -0
- package/src/sync/executors.ts +33 -6
- package/src/sync/mutationHandler.test.ts +277 -1
- package/src/sync/mutationHandler.ts +171 -29
- package/src/sync/registry.ts +4 -0
- package/src/sync/routes.ts +52 -8
- package/src/sync/socketHandlers.ts +154 -58
- package/src/sync/streams.ts +6 -0
- package/src/sync/sync.test.ts +3 -2
- package/src/sync/syncApp.ts +2 -1
- package/src/sync/syncBatch.ts +7 -2
- package/src/sync/syncRoutes.test.ts +297 -3
- package/src/sync/syncSocket.test.ts +229 -0
- package/src/sync/types.ts +20 -0
- package/src/terrenoApp.migrations.test.ts +114 -0
- package/src/terrenoApp.test.ts +41 -0
- package/src/terrenoApp.ts +94 -31
- package/src/tests/createTestData.ts +2 -2
- package/src/tests/models.ts +10 -2
- package/src/tests/testHelper.ts +1 -7
- package/src/types/authToken.ts +2 -4
- package/src/types/mcpServiceToken.ts +1 -7
- package/src/types/membership.ts +48 -0
- package/src/types/notification.ts +34 -0
- package/src/types/notificationPreference.ts +28 -0
- package/src/types/organization.ts +49 -0
- package/src/webhooks/idempotency/webhookReceipt.ts +4 -7
- package/src/webhooks/rawBody.test.ts +33 -0
- package/src/webhooks/rawBody.ts +1 -0
- package/tsconfig.json +1 -1
- package/tsconfig.typedoc.json +2 -1
- package/dist/vendor/wesleytodd-openapi/lib/convert-yaml.d.ts +0 -2
- package/dist/vendor/wesleytodd-openapi/lib/convert-yaml.js +0 -13
- package/src/vendor/wesleytodd-openapi/lib/convert-yaml.js +0 -13
|
@@ -0,0 +1,77 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
|
|
3
|
+
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
|
|
4
|
+
return new (P || (P = Promise))(function (resolve, reject) {
|
|
5
|
+
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
|
|
6
|
+
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
|
|
7
|
+
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
|
|
8
|
+
step((generator = generator.apply(thisArg, _arguments || [])).next());
|
|
9
|
+
});
|
|
10
|
+
};
|
|
11
|
+
var __generator = (this && this.__generator) || function (thisArg, body) {
|
|
12
|
+
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);
|
|
13
|
+
return g.next = verb(0), g["throw"] = verb(1), g["return"] = verb(2), typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
|
|
14
|
+
function verb(n) { return function (v) { return step([n, v]); }; }
|
|
15
|
+
function step(op) {
|
|
16
|
+
if (f) throw new TypeError("Generator is already executing.");
|
|
17
|
+
while (g && (g = 0, op[0] && (_ = 0)), _) try {
|
|
18
|
+
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;
|
|
19
|
+
if (y = 0, t) op = [op[0] & 2, t.value];
|
|
20
|
+
switch (op[0]) {
|
|
21
|
+
case 0: case 1: t = op; break;
|
|
22
|
+
case 4: _.label++; return { value: op[1], done: false };
|
|
23
|
+
case 5: _.label++; y = op[1]; op = [0]; continue;
|
|
24
|
+
case 7: op = _.ops.pop(); _.trys.pop(); continue;
|
|
25
|
+
default:
|
|
26
|
+
if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
|
|
27
|
+
if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
|
|
28
|
+
if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
|
|
29
|
+
if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
|
|
30
|
+
if (t[2]) _.ops.pop();
|
|
31
|
+
_.trys.pop(); continue;
|
|
32
|
+
}
|
|
33
|
+
op = body.call(thisArg, _);
|
|
34
|
+
} catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
|
|
35
|
+
if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
|
|
36
|
+
}
|
|
37
|
+
};
|
|
38
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
39
|
+
exports.notificationsBeforeSend = void 0;
|
|
40
|
+
var notificationPreference_1 = require("../models/notificationPreference");
|
|
41
|
+
var PREFERENCE_FIELD_BY_CHANNEL = {
|
|
42
|
+
mail: "mail",
|
|
43
|
+
push: "push",
|
|
44
|
+
sms: "sms",
|
|
45
|
+
};
|
|
46
|
+
/**
|
|
47
|
+
* Duck-typed CommsApp `beforeSend` hook that cancels outbound delivery when the user
|
|
48
|
+
* disabled that channel in NotificationPreference. Missing preference rows default to
|
|
49
|
+
* all channels on. The `verification` channel is never cancelled here.
|
|
50
|
+
*/
|
|
51
|
+
var notificationsBeforeSend = function (_a) { return __awaiter(void 0, [_a], void 0, function (_b) {
|
|
52
|
+
var preferenceField, preference;
|
|
53
|
+
var channel = _b.channel, userId = _b.userId;
|
|
54
|
+
return __generator(this, function (_c) {
|
|
55
|
+
switch (_c.label) {
|
|
56
|
+
case 0:
|
|
57
|
+
if (channel === "verification" || !userId) {
|
|
58
|
+
return [2 /*return*/, undefined];
|
|
59
|
+
}
|
|
60
|
+
preferenceField = PREFERENCE_FIELD_BY_CHANNEL[channel];
|
|
61
|
+
if (!preferenceField) {
|
|
62
|
+
return [2 /*return*/, undefined];
|
|
63
|
+
}
|
|
64
|
+
return [4 /*yield*/, notificationPreference_1.NotificationPreference.findOneOrNone({ ownerId: userId })];
|
|
65
|
+
case 1:
|
|
66
|
+
preference = _c.sent();
|
|
67
|
+
if (!preference) {
|
|
68
|
+
return [2 /*return*/, undefined];
|
|
69
|
+
}
|
|
70
|
+
if (preference[preferenceField] === false) {
|
|
71
|
+
return [2 /*return*/, { cancel: true }];
|
|
72
|
+
}
|
|
73
|
+
return [2 /*return*/, undefined];
|
|
74
|
+
}
|
|
75
|
+
});
|
|
76
|
+
}); };
|
|
77
|
+
exports.notificationsBeforeSend = notificationsBeforeSend;
|
package/dist/openApi.d.ts
CHANGED
|
@@ -1,13 +1,6 @@
|
|
|
1
1
|
import type express from "express";
|
|
2
2
|
import type { Model } from "mongoose";
|
|
3
3
|
import type { ModelRouterOptions } from "./api";
|
|
4
|
-
export declare const apiErrorContent: {
|
|
5
|
-
"application/json": {
|
|
6
|
-
schema: {
|
|
7
|
-
$ref: string;
|
|
8
|
-
};
|
|
9
|
-
};
|
|
10
|
-
};
|
|
11
4
|
export declare const defaultOpenApiErrorResponses: {
|
|
12
5
|
400: {
|
|
13
6
|
content: {
|
|
@@ -58,4 +51,5 @@ export declare const listOpenApiMiddleware: <T>(model: Model<T>, options: Partia
|
|
|
58
51
|
export declare const createOpenApiMiddleware: <T>(model: Model<T>, options: Partial<ModelRouterOptions<T>>) => express.RequestHandler;
|
|
59
52
|
export declare const patchOpenApiMiddleware: <T>(model: Model<T>, options: Partial<ModelRouterOptions<T>>) => express.RequestHandler;
|
|
60
53
|
export declare const deleteOpenApiMiddleware: <T>(model: Model<T>, options: Partial<ModelRouterOptions<T>>) => express.RequestHandler;
|
|
54
|
+
/** @internal */
|
|
61
55
|
export declare const readOpenApiMiddleware: <T>(options: Partial<ModelRouterOptions<T>>, properties: Record<string, unknown>, required: string[], queryParameters: Array<Record<string, unknown>>) => express.RequestHandler;
|
package/dist/openApi.js
CHANGED
|
@@ -39,7 +39,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
|
39
39
|
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
40
40
|
};
|
|
41
41
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
42
|
-
exports.readOpenApiMiddleware = exports.deleteOpenApiMiddleware = exports.patchOpenApiMiddleware = exports.createOpenApiMiddleware = exports.listOpenApiMiddleware = exports.getOpenApiMiddleware = exports.defaultOpenApiErrorResponses =
|
|
42
|
+
exports.readOpenApiMiddleware = exports.deleteOpenApiMiddleware = exports.patchOpenApiMiddleware = exports.createOpenApiMiddleware = exports.listOpenApiMiddleware = exports.getOpenApiMiddleware = exports.defaultOpenApiErrorResponses = void 0;
|
|
43
43
|
var flatten_1 = __importDefault(require("lodash/flatten"));
|
|
44
44
|
var merge_1 = __importDefault(require("lodash/merge"));
|
|
45
45
|
var mongoose_to_swagger_1 = __importDefault(require("mongoose-to-swagger"));
|
|
@@ -49,7 +49,7 @@ var noop = function (_a, _b, next) { return next(); };
|
|
|
49
49
|
var m2sOptions = {
|
|
50
50
|
props: ["readOnly", "required", "enum", "default"],
|
|
51
51
|
};
|
|
52
|
-
|
|
52
|
+
var apiErrorContent = {
|
|
53
53
|
"application/json": {
|
|
54
54
|
schema: { $ref: "#/components/schemas/APIError" },
|
|
55
55
|
},
|
|
@@ -57,22 +57,22 @@ exports.apiErrorContent = {
|
|
|
57
57
|
// Default error responses
|
|
58
58
|
exports.defaultOpenApiErrorResponses = {
|
|
59
59
|
400: {
|
|
60
|
-
content:
|
|
60
|
+
content: apiErrorContent,
|
|
61
61
|
description: "Bad request",
|
|
62
62
|
},
|
|
63
63
|
401: {
|
|
64
64
|
description: "The user must be authenticated",
|
|
65
65
|
},
|
|
66
66
|
403: {
|
|
67
|
-
content:
|
|
67
|
+
content: apiErrorContent,
|
|
68
68
|
description: "The user is not allowed to perform this action on this document",
|
|
69
69
|
},
|
|
70
70
|
404: {
|
|
71
|
-
content:
|
|
71
|
+
content: apiErrorContent,
|
|
72
72
|
description: "Document not found",
|
|
73
73
|
},
|
|
74
74
|
405: {
|
|
75
|
-
content:
|
|
75
|
+
content: apiErrorContent,
|
|
76
76
|
description: "The user is not allowed to perform this action on any document",
|
|
77
77
|
},
|
|
78
78
|
};
|
|
@@ -429,6 +429,7 @@ var deleteOpenApiMiddleware = function (model, options) {
|
|
|
429
429
|
exports.deleteOpenApiMiddleware = deleteOpenApiMiddleware;
|
|
430
430
|
// This is a generic OpenAPI wrapper for a read that returns any object described by `properties`.
|
|
431
431
|
// Useful for endpoints that don't directly map to a model.
|
|
432
|
+
/** @internal */
|
|
432
433
|
var readOpenApiMiddleware = function (options, properties, required, queryParameters) {
|
|
433
434
|
var _c, _d, _e, _f, _g;
|
|
434
435
|
if (!((_c = options.openApi) === null || _c === void 0 ? void 0 : _c.path)) {
|
package/dist/openApiBuilder.d.ts
CHANGED
|
@@ -67,19 +67,30 @@ import type { ModelRouterOptions } from "./api";
|
|
|
67
67
|
*/
|
|
68
68
|
export interface OpenApiSchemaProperty {
|
|
69
69
|
/** The JSON Schema type (e.g., "string", "number", "boolean", "object", "array") */
|
|
70
|
-
type
|
|
70
|
+
type?: string;
|
|
71
|
+
/** JSON Schema oneOf for query operators (scalar or Mongo-style object). */
|
|
72
|
+
oneOf?: OpenApiSchemaProperty[];
|
|
71
73
|
/** Human-readable description of the property */
|
|
72
74
|
description?: string;
|
|
75
|
+
/** Allowed values for string/number enums in query validation. */
|
|
76
|
+
enum?: string[];
|
|
73
77
|
/** Format hint for the type (e.g., "date-time", "email", "uri", "uuid") */
|
|
74
78
|
format?: string;
|
|
75
79
|
/** Schema for array items when type is "array" */
|
|
76
80
|
items?: OpenApiSchemaProperty;
|
|
81
|
+
/** Minimum array length when type is "array". */
|
|
82
|
+
minItems?: number;
|
|
77
83
|
/** Nested properties when type is "object" */
|
|
78
84
|
properties?: Record<string, OpenApiSchemaProperty>;
|
|
79
85
|
/** Schema for additional properties or boolean to allow/disallow them */
|
|
80
86
|
additionalProperties?: OpenApiSchemaProperty | boolean;
|
|
81
|
-
/**
|
|
82
|
-
|
|
87
|
+
/**
|
|
88
|
+
* Property-level required flag, or object-schema required key list for nested
|
|
89
|
+
* operator shapes (`{$in: ...}`, `{$regex: ...}`).
|
|
90
|
+
*/
|
|
91
|
+
required?: boolean | string[];
|
|
92
|
+
/** When true, string values must be escaped regex literals (query `$regex` operator). */
|
|
93
|
+
escapedRegexLiteral?: boolean;
|
|
83
94
|
}
|
|
84
95
|
/**
|
|
85
96
|
* Defines the top-level schema for request bodies and responses.
|
|
@@ -6,7 +6,8 @@
|
|
|
6
6
|
*
|
|
7
7
|
* Validation is always installed as middleware but only activates after
|
|
8
8
|
* `configureOpenApiValidator()` is called. This makes it safe to include
|
|
9
|
-
* in modelRouter by default.
|
|
9
|
+
* in modelRouter by default. Create bodies enforce Mongoose required fields;
|
|
10
|
+
* PATCH/update bodies are partial (present fields only).
|
|
10
11
|
*
|
|
11
12
|
* @module openApiValidator
|
|
12
13
|
*
|
|
@@ -112,6 +113,8 @@ export declare const getOpenApiValidatorConfig: () => OpenApiValidatorConfig;
|
|
|
112
113
|
* Useful for testing.
|
|
113
114
|
*/
|
|
114
115
|
export declare const resetOpenApiValidatorConfig: () => void;
|
|
116
|
+
/** Accepts literal text and escaped metacharacters (e.g. `\\.`), rejects executable patterns. */
|
|
117
|
+
export declare const isEscapedRegexLiteral: (value: string) => boolean;
|
|
115
118
|
/**
|
|
116
119
|
* Options for the request body validator middleware.
|
|
117
120
|
*/
|
|
@@ -124,6 +127,11 @@ export interface RequestBodyValidatorOptions {
|
|
|
124
127
|
* List of required field names.
|
|
125
128
|
*/
|
|
126
129
|
required?: string[];
|
|
130
|
+
/**
|
|
131
|
+
* When true, skip schema-level `required` (PATCH / partial update bodies).
|
|
132
|
+
* Present fields are still type-checked.
|
|
133
|
+
*/
|
|
134
|
+
partial?: boolean;
|
|
127
135
|
/**
|
|
128
136
|
* Fields to exclude from validation (e.g. fields set by preCreate hooks).
|
|
129
137
|
* Excluded fields are removed from both the schema properties and the required array.
|
|
@@ -285,6 +293,10 @@ export declare const createModelValidators: <T>(model: Model<T>, options?: Model
|
|
|
285
293
|
create: (req: Request, res: Response, next: NextFunction) => void;
|
|
286
294
|
update: (req: Request, res: Response, next: NextFunction) => void;
|
|
287
295
|
};
|
|
296
|
+
/** Query schema for string/enum fields: scalar, `$in`, or escaped `$regex`. */
|
|
297
|
+
export declare const buildStringListQueryFieldSchema: (fieldSchema: OpenApiSchemaProperty) => OpenApiSchemaProperty;
|
|
298
|
+
/** Query schema for number/date fields: scalar or comparison operators. */
|
|
299
|
+
export declare const buildNumericListQueryFieldSchema: (fieldSchema: OpenApiSchemaProperty) => OpenApiSchemaProperty;
|
|
288
300
|
/**
|
|
289
301
|
* Build a query parameter schema from a model's Mongoose schema and queryFields array.
|
|
290
302
|
* Always includes pagination parameters (limit, page, sort).
|
package/dist/openApiValidator.js
CHANGED
|
@@ -7,7 +7,8 @@
|
|
|
7
7
|
*
|
|
8
8
|
* Validation is always installed as middleware but only activates after
|
|
9
9
|
* `configureOpenApiValidator()` is called. This makes it safe to include
|
|
10
|
-
* in modelRouter by default.
|
|
10
|
+
* in modelRouter by default. Create bodies enforce Mongoose required fields;
|
|
11
|
+
* PATCH/update bodies are partial (present fields only).
|
|
11
12
|
*
|
|
12
13
|
* @module openApiValidator
|
|
13
14
|
*
|
|
@@ -96,10 +97,10 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
|
96
97
|
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
97
98
|
};
|
|
98
99
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
99
|
-
exports.buildQuerySchemaFromFields = exports.createModelValidators = exports.validateModelRequestBody = exports.getSchemaFromModel = exports.validateResponseData = exports.createValidator = exports.validateQueryParams = exports.validateRequestBody = exports.resetOpenApiValidatorConfig = exports.getOpenApiValidatorConfig = exports.configureOpenApiValidator = exports.isOpenApiValidatorConfigured = void 0;
|
|
100
|
+
exports.buildQuerySchemaFromFields = exports.buildNumericListQueryFieldSchema = exports.buildStringListQueryFieldSchema = exports.createModelValidators = exports.validateModelRequestBody = exports.getSchemaFromModel = exports.validateResponseData = exports.createValidator = exports.validateQueryParams = exports.validateRequestBody = exports.isEscapedRegexLiteral = exports.resetOpenApiValidatorConfig = exports.getOpenApiValidatorConfig = exports.configureOpenApiValidator = exports.isOpenApiValidatorConfigured = void 0;
|
|
100
101
|
var ajv_1 = __importDefault(require("ajv"));
|
|
101
102
|
var ajv_formats_1 = __importDefault(require("ajv-formats"));
|
|
102
|
-
var
|
|
103
|
+
var adminTypes_1 = require("./adminTypes");
|
|
103
104
|
var errors_1 = require("./errors");
|
|
104
105
|
var logger_1 = require("./logger");
|
|
105
106
|
var populate_1 = require("./populate");
|
|
@@ -192,6 +193,11 @@ var getAjvInstance = function () {
|
|
|
192
193
|
validateSchema: false,
|
|
193
194
|
});
|
|
194
195
|
(0, ajv_formats_1.default)(instance);
|
|
196
|
+
instance.addKeyword({
|
|
197
|
+
keyword: ESCAPED_REGEX_LITERAL_KEYWORD,
|
|
198
|
+
type: "string",
|
|
199
|
+
validate: function (_enabled, data) { return (0, exports.isEscapedRegexLiteral)(data); },
|
|
200
|
+
});
|
|
195
201
|
ajvCache.set(key, instance);
|
|
196
202
|
}
|
|
197
203
|
return instance;
|
|
@@ -213,6 +219,42 @@ var VALID_JSON_SCHEMA_TYPES = new Set([
|
|
|
213
219
|
"object",
|
|
214
220
|
"null",
|
|
215
221
|
]);
|
|
222
|
+
var REGEX_META_CHARACTERS = new Set([
|
|
223
|
+
"\\",
|
|
224
|
+
".",
|
|
225
|
+
"*",
|
|
226
|
+
"+",
|
|
227
|
+
"?",
|
|
228
|
+
"^",
|
|
229
|
+
"$",
|
|
230
|
+
"{",
|
|
231
|
+
"}",
|
|
232
|
+
"(",
|
|
233
|
+
")",
|
|
234
|
+
"|",
|
|
235
|
+
"[",
|
|
236
|
+
"]",
|
|
237
|
+
]);
|
|
238
|
+
/** Accepts literal text and escaped metacharacters (e.g. `\\.`), rejects executable patterns. */
|
|
239
|
+
var isEscapedRegexLiteral = function (value) {
|
|
240
|
+
for (var index = 0; index < value.length; index += 1) {
|
|
241
|
+
var character = value[index];
|
|
242
|
+
if (character === "\\") {
|
|
243
|
+
var escapedCharacter = value[index + 1];
|
|
244
|
+
if (!escapedCharacter || !REGEX_META_CHARACTERS.has(escapedCharacter)) {
|
|
245
|
+
return false;
|
|
246
|
+
}
|
|
247
|
+
index += 1;
|
|
248
|
+
continue;
|
|
249
|
+
}
|
|
250
|
+
if (REGEX_META_CHARACTERS.has(character)) {
|
|
251
|
+
return false;
|
|
252
|
+
}
|
|
253
|
+
}
|
|
254
|
+
return true;
|
|
255
|
+
};
|
|
256
|
+
exports.isEscapedRegexLiteral = isEscapedRegexLiteral;
|
|
257
|
+
var ESCAPED_REGEX_LITERAL_KEYWORD = "escapedRegexLiteral";
|
|
216
258
|
// mongoose-to-swagger emits non-standard type strings for some Mongoose types
|
|
217
259
|
var MONGOOSE_TYPE_MAP = {
|
|
218
260
|
dateonly: { format: "date", type: "string" },
|
|
@@ -266,8 +308,56 @@ var sanitizeSchemaForAjv = function (schema) {
|
|
|
266
308
|
if (result.additionalProperties && typeof result.additionalProperties === "object") {
|
|
267
309
|
result.additionalProperties = sanitizeSchemaForAjv(result.additionalProperties);
|
|
268
310
|
}
|
|
311
|
+
if (Array.isArray(result.oneOf)) {
|
|
312
|
+
result.oneOf = result.oneOf.map(function (entry) {
|
|
313
|
+
return typeof entry === "object" && entry !== null
|
|
314
|
+
? sanitizeSchemaForAjv(entry)
|
|
315
|
+
: entry;
|
|
316
|
+
});
|
|
317
|
+
}
|
|
318
|
+
if (typeof result.required === "boolean") {
|
|
319
|
+
delete result.required;
|
|
320
|
+
}
|
|
269
321
|
return result;
|
|
270
322
|
};
|
|
323
|
+
var stripBooleanRequiredFlag = function (schema) {
|
|
324
|
+
if (schema.required === true || schema.required === false) {
|
|
325
|
+
var _1 = schema.required, rest = __rest(schema, ["required"]);
|
|
326
|
+
var cleaned = __assign({}, rest);
|
|
327
|
+
if (cleaned.properties) {
|
|
328
|
+
cleaned.properties = Object.fromEntries(Object.entries(cleaned.properties).map(function (_a) {
|
|
329
|
+
var _b = __read(_a, 2), key = _b[0], value = _b[1];
|
|
330
|
+
return [
|
|
331
|
+
key,
|
|
332
|
+
stripBooleanRequiredFlag(value),
|
|
333
|
+
];
|
|
334
|
+
}));
|
|
335
|
+
}
|
|
336
|
+
if (cleaned.items) {
|
|
337
|
+
cleaned.items = stripBooleanRequiredFlag(cleaned.items);
|
|
338
|
+
}
|
|
339
|
+
if (cleaned.oneOf) {
|
|
340
|
+
cleaned.oneOf = cleaned.oneOf.map(function (entry) { return stripBooleanRequiredFlag(entry); });
|
|
341
|
+
}
|
|
342
|
+
return cleaned;
|
|
343
|
+
}
|
|
344
|
+
if (schema.properties) {
|
|
345
|
+
return __assign(__assign({}, schema), { properties: Object.fromEntries(Object.entries(schema.properties).map(function (_a) {
|
|
346
|
+
var _b = __read(_a, 2), key = _b[0], value = _b[1];
|
|
347
|
+
return [
|
|
348
|
+
key,
|
|
349
|
+
stripBooleanRequiredFlag(value),
|
|
350
|
+
];
|
|
351
|
+
})) });
|
|
352
|
+
}
|
|
353
|
+
if (schema.items) {
|
|
354
|
+
return __assign(__assign({}, schema), { items: stripBooleanRequiredFlag(schema.items) });
|
|
355
|
+
}
|
|
356
|
+
if (schema.oneOf) {
|
|
357
|
+
return __assign(__assign({}, schema), { oneOf: schema.oneOf.map(function (entry) { return stripBooleanRequiredFlag(entry); }) });
|
|
358
|
+
}
|
|
359
|
+
return schema;
|
|
360
|
+
};
|
|
271
361
|
/**
|
|
272
362
|
* Get or create a compiled validator for a schema.
|
|
273
363
|
* Uses the current config so changes take effect on next call.
|
|
@@ -312,26 +402,30 @@ var formatValidationErrors = function (errors) {
|
|
|
312
402
|
* Strips `required` from individual properties (OpenAPI-style) and moves it
|
|
313
403
|
* to the schema-level `required` array (JSON Schema-style) for AJV compatibility.
|
|
314
404
|
*/
|
|
315
|
-
var propertiesToSchema = function (properties, requiredFields) {
|
|
405
|
+
var propertiesToSchema = function (properties, requiredFields, options) {
|
|
316
406
|
var e_2, _a;
|
|
317
|
-
// Extract required fields from properties
|
|
318
|
-
|
|
319
|
-
|
|
320
|
-
|
|
321
|
-
|
|
322
|
-
|
|
323
|
-
|
|
324
|
-
|
|
325
|
-
|
|
326
|
-
|
|
327
|
-
|
|
328
|
-
|
|
407
|
+
// Extract required fields from properties marked required: true (OpenAPI builder style).
|
|
408
|
+
// PATCH bodies are partial: omit mongoose/OpenAPI required so one field can be sent.
|
|
409
|
+
var autoRequired = (options === null || options === void 0 ? void 0 : options.partial)
|
|
410
|
+
? []
|
|
411
|
+
: Object.entries(properties)
|
|
412
|
+
.filter(function (_a) {
|
|
413
|
+
var _b = __read(_a, 2), _ = _b[0], prop = _b[1];
|
|
414
|
+
return prop.required === true;
|
|
415
|
+
})
|
|
416
|
+
.map(function (_a) {
|
|
417
|
+
var _b = __read(_a, 1), key = _b[0];
|
|
418
|
+
return key;
|
|
419
|
+
});
|
|
420
|
+
var allRequired = (options === null || options === void 0 ? void 0 : options.partial)
|
|
421
|
+
? []
|
|
422
|
+
: __spreadArray([], __read(new Set(__spreadArray(__spreadArray([], __read((requiredFields !== null && requiredFields !== void 0 ? requiredFields : [])), false), __read(autoRequired), false))), false);
|
|
423
|
+
// Strip boolean `required` from individual properties — AJV only accepts `required` arrays on objects
|
|
329
424
|
var cleanedProperties = {};
|
|
330
425
|
try {
|
|
331
426
|
for (var _b = __values(Object.entries(properties)), _c = _b.next(); !_c.done; _c = _b.next()) {
|
|
332
427
|
var _d = __read(_c.value, 2), key = _d[0], prop = _d[1];
|
|
333
|
-
|
|
334
|
-
cleanedProperties[key] = rest;
|
|
428
|
+
cleanedProperties[key] = stripBooleanRequiredFlag(prop);
|
|
335
429
|
}
|
|
336
430
|
}
|
|
337
431
|
catch (e_2_1) { e_2 = { error: e_2_1 }; }
|
|
@@ -364,7 +458,9 @@ var propertiesToSchema = function (properties, requiredFields) {
|
|
|
364
458
|
* @returns Express middleware function
|
|
365
459
|
*/
|
|
366
460
|
var validateRequestBody = function (schema, options) {
|
|
367
|
-
var fullSchema = propertiesToSchema(schema, options === null || options === void 0 ? void 0 : options.required
|
|
461
|
+
var fullSchema = propertiesToSchema(schema, options === null || options === void 0 ? void 0 : options.required, {
|
|
462
|
+
partial: options === null || options === void 0 ? void 0 : options.partial,
|
|
463
|
+
});
|
|
368
464
|
return function (req, _res, next) {
|
|
369
465
|
var _a, _b, _c;
|
|
370
466
|
// No-op if not configured
|
|
@@ -586,9 +682,6 @@ var validateResponseData = function (data, schema) {
|
|
|
586
682
|
return { valid: true };
|
|
587
683
|
};
|
|
588
684
|
exports.validateResponseData = validateResponseData;
|
|
589
|
-
var m2sOptions = {
|
|
590
|
-
props: ["readOnly", "required", "enum", "default"],
|
|
591
|
-
};
|
|
592
685
|
/**
|
|
593
686
|
* Extract an OpenAPI-compatible schema from a Mongoose model.
|
|
594
687
|
* This allows you to use the same schema definitions for both documentation
|
|
@@ -598,18 +691,16 @@ var m2sOptions = {
|
|
|
598
691
|
* @returns Schema properties suitable for validation
|
|
599
692
|
*/
|
|
600
693
|
var getSchemaFromModel = function (model) {
|
|
601
|
-
var
|
|
602
|
-
|
|
603
|
-
return modelSwagger.properties;
|
|
694
|
+
var properties = (0, populate_1.getOpenApiSpecForModel)(model).properties;
|
|
695
|
+
return properties;
|
|
604
696
|
};
|
|
605
697
|
exports.getSchemaFromModel = getSchemaFromModel;
|
|
606
698
|
/**
|
|
607
699
|
* Extract required field names from a Mongoose model's swagger schema.
|
|
608
700
|
*/
|
|
609
701
|
var getRequiredFieldsFromModel = function (model) {
|
|
610
|
-
var
|
|
611
|
-
|
|
612
|
-
return (_a = modelSwagger.required) !== null && _a !== void 0 ? _a : [];
|
|
702
|
+
var required = (0, populate_1.getOpenApiSpecForModel)(model).required;
|
|
703
|
+
return required;
|
|
613
704
|
};
|
|
614
705
|
/**
|
|
615
706
|
* Creates a request body validator middleware from a Mongoose model.
|
|
@@ -622,7 +713,7 @@ var getRequiredFieldsFromModel = function (model) {
|
|
|
622
713
|
var validateModelRequestBody = function (model, options) {
|
|
623
714
|
var _a, _b;
|
|
624
715
|
var schema = (0, exports.getSchemaFromModel)(model);
|
|
625
|
-
var requiredFields = getRequiredFieldsFromModel(model);
|
|
716
|
+
var requiredFields = (options === null || options === void 0 ? void 0 : options.partial) ? [] : getRequiredFieldsFromModel(model);
|
|
626
717
|
if ((_a = options === null || options === void 0 ? void 0 : options.excludeFields) === null || _a === void 0 ? void 0 : _a.length) {
|
|
627
718
|
var excluded_1 = new Set(options.excludeFields);
|
|
628
719
|
schema = Object.fromEntries(Object.entries(schema).filter(function (_a) {
|
|
@@ -631,7 +722,7 @@ var validateModelRequestBody = function (model, options) {
|
|
|
631
722
|
}));
|
|
632
723
|
requiredFields = requiredFields.filter(function (f) { return !excluded_1.has(f); });
|
|
633
724
|
}
|
|
634
|
-
return (0, exports.validateRequestBody)(schema, __assign(__assign({}, options), { required: __spreadArray(__spreadArray([], __read(((_b = options === null || options === void 0 ? void 0 : options.required) !== null && _b !== void 0 ? _b : [])), false), __read(requiredFields), false) }));
|
|
725
|
+
return (0, exports.validateRequestBody)(schema, __assign(__assign({}, options), { required: (options === null || options === void 0 ? void 0 : options.partial) ? [] : __spreadArray(__spreadArray([], __read(((_b = options === null || options === void 0 ? void 0 : options.required) !== null && _b !== void 0 ? _b : [])), false), __read(requiredFields), false) }));
|
|
635
726
|
};
|
|
636
727
|
exports.validateModelRequestBody = validateModelRequestBody;
|
|
637
728
|
/**
|
|
@@ -654,10 +745,78 @@ var createModelValidators = function (model, options) {
|
|
|
654
745
|
enabled: options === null || options === void 0 ? void 0 : options.validateUpdate,
|
|
655
746
|
onAdditionalPropertiesRemoved: options === null || options === void 0 ? void 0 : options.onAdditionalPropertiesRemoved,
|
|
656
747
|
onError: options === null || options === void 0 ? void 0 : options.onError,
|
|
748
|
+
partial: true,
|
|
657
749
|
}),
|
|
658
750
|
};
|
|
659
751
|
};
|
|
660
752
|
exports.createModelValidators = createModelValidators;
|
|
753
|
+
var choiceEmptyInItemSchema = function (baseItem) {
|
|
754
|
+
if (baseItem.enum) {
|
|
755
|
+
return {
|
|
756
|
+
oneOf: [
|
|
757
|
+
{ enum: baseItem.enum, type: "string" },
|
|
758
|
+
{ enum: [adminTypes_1.ADMIN_LIST_CHOICE_EMPTY_VALUE], type: "string" },
|
|
759
|
+
],
|
|
760
|
+
};
|
|
761
|
+
}
|
|
762
|
+
return {
|
|
763
|
+
oneOf: [
|
|
764
|
+
stripBooleanRequiredFlag(baseItem),
|
|
765
|
+
{ enum: [adminTypes_1.ADMIN_LIST_CHOICE_EMPTY_VALUE], type: "string" },
|
|
766
|
+
],
|
|
767
|
+
};
|
|
768
|
+
};
|
|
769
|
+
var buildInOperatorSchema = function (itemSchema) { return ({
|
|
770
|
+
additionalProperties: false,
|
|
771
|
+
properties: {
|
|
772
|
+
$in: {
|
|
773
|
+
items: itemSchema,
|
|
774
|
+
minItems: 1,
|
|
775
|
+
type: "array",
|
|
776
|
+
},
|
|
777
|
+
},
|
|
778
|
+
required: ["$in"],
|
|
779
|
+
type: "object",
|
|
780
|
+
}); };
|
|
781
|
+
var buildRegexOperatorSchema = function () { return ({
|
|
782
|
+
additionalProperties: false,
|
|
783
|
+
properties: {
|
|
784
|
+
$options: { enum: ["i"], type: "string" },
|
|
785
|
+
$regex: { escapedRegexLiteral: true, type: "string" },
|
|
786
|
+
},
|
|
787
|
+
required: ["$regex", "$options"],
|
|
788
|
+
type: "object",
|
|
789
|
+
}); };
|
|
790
|
+
var buildRangeOperatorSchema = function (valueSchema) { return ({
|
|
791
|
+
additionalProperties: false,
|
|
792
|
+
properties: {
|
|
793
|
+
$gt: valueSchema,
|
|
794
|
+
$gte: valueSchema,
|
|
795
|
+
$lt: valueSchema,
|
|
796
|
+
$lte: valueSchema,
|
|
797
|
+
},
|
|
798
|
+
type: "object",
|
|
799
|
+
}); };
|
|
800
|
+
/** Query schema for string/enum fields: scalar, `$in`, or escaped `$regex`. */
|
|
801
|
+
var buildStringListQueryFieldSchema = function (fieldSchema) {
|
|
802
|
+
var scalar = stripBooleanRequiredFlag(fieldSchema);
|
|
803
|
+
var inItems = fieldSchema.enum
|
|
804
|
+
? choiceEmptyInItemSchema(fieldSchema)
|
|
805
|
+
: stripBooleanRequiredFlag(fieldSchema);
|
|
806
|
+
return {
|
|
807
|
+
oneOf: [scalar, buildInOperatorSchema(inItems), buildRegexOperatorSchema()],
|
|
808
|
+
};
|
|
809
|
+
};
|
|
810
|
+
exports.buildStringListQueryFieldSchema = buildStringListQueryFieldSchema;
|
|
811
|
+
/** Query schema for number/date fields: scalar or comparison operators. */
|
|
812
|
+
var buildNumericListQueryFieldSchema = function (fieldSchema) {
|
|
813
|
+
var scalar = stripBooleanRequiredFlag(fieldSchema);
|
|
814
|
+
var valueSchema = stripBooleanRequiredFlag(fieldSchema);
|
|
815
|
+
return {
|
|
816
|
+
oneOf: [scalar, buildRangeOperatorSchema(valueSchema)],
|
|
817
|
+
};
|
|
818
|
+
};
|
|
819
|
+
exports.buildNumericListQueryFieldSchema = buildNumericListQueryFieldSchema;
|
|
661
820
|
/**
|
|
662
821
|
* Build a query parameter schema from a model's Mongoose schema and queryFields array.
|
|
663
822
|
* Always includes pagination parameters (limit, page, sort).
|
|
@@ -679,14 +838,19 @@ var buildQuerySchemaFromFields = function (model, queryFields) {
|
|
|
679
838
|
for (var queryFields_1 = __values(queryFields), queryFields_1_1 = queryFields_1.next(); !queryFields_1_1.done; queryFields_1_1 = queryFields_1.next()) {
|
|
680
839
|
var field = queryFields_1_1.value;
|
|
681
840
|
var modelField = modelSchema[field];
|
|
682
|
-
if (modelField) {
|
|
683
|
-
|
|
684
|
-
|
|
841
|
+
if (!modelField) {
|
|
842
|
+
querySchema[field] = (0, exports.buildStringListQueryFieldSchema)({ type: "string" });
|
|
843
|
+
continue;
|
|
844
|
+
}
|
|
845
|
+
if (modelField.type === "boolean") {
|
|
846
|
+
querySchema[field] = stripBooleanRequiredFlag(modelField);
|
|
847
|
+
continue;
|
|
685
848
|
}
|
|
686
|
-
|
|
687
|
-
|
|
688
|
-
|
|
849
|
+
if (modelField.type === "number" || modelField.format === "date-time") {
|
|
850
|
+
querySchema[field] = (0, exports.buildNumericListQueryFieldSchema)(modelField);
|
|
851
|
+
continue;
|
|
689
852
|
}
|
|
853
|
+
querySchema[field] = (0, exports.buildStringListQueryFieldSchema)(modelField);
|
|
690
854
|
}
|
|
691
855
|
}
|
|
692
856
|
catch (e_3_1) { e_3 = { error: e_3_1 }; }
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
import type { RequestHandler } from "express";
|
|
2
|
+
import type { User } from "../auth";
|
|
3
|
+
import type { MembershipDocument } from "../types/membership";
|
|
4
|
+
import type { OrganizationDocument } from "../types/organization";
|
|
5
|
+
export declare const ORGANIZATION_ID_HEADER = "x-organization-id";
|
|
6
|
+
export declare const ORGANIZATION_DISABLED_TITLE = "Organization is disabled";
|
|
7
|
+
export declare const PLATFORM_ORG_ROLE_NAMES: readonly ["operator", "superadmin"];
|
|
8
|
+
export interface ResolvedOrgContext {
|
|
9
|
+
membership?: MembershipDocument;
|
|
10
|
+
organization?: OrganizationDocument;
|
|
11
|
+
}
|
|
12
|
+
export declare const getOrgContext: () => ResolvedOrgContext | undefined;
|
|
13
|
+
export declare const runWithOrgContext: <T>(context: ResolvedOrgContext, fn: () => T) => T;
|
|
14
|
+
export declare const isPlatformOrgActor: (user?: User) => boolean;
|
|
15
|
+
export declare const assertOrganizationEnabled: (organization: OrganizationDocument) => void;
|
|
16
|
+
export declare const resolveOrgContext: (args: {
|
|
17
|
+
organizationId?: string;
|
|
18
|
+
required: boolean;
|
|
19
|
+
user?: User;
|
|
20
|
+
}) => Promise<ResolvedOrgContext>;
|
|
21
|
+
export declare const orgContextMiddleware: (options?: {
|
|
22
|
+
required?: boolean;
|
|
23
|
+
}) => RequestHandler;
|