@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,139 @@
|
|
|
1
|
+
import type express from "express";
|
|
2
|
+
import mongoose from "mongoose";
|
|
3
|
+
|
|
4
|
+
import type {AdminContribution} from "../adminTypes";
|
|
5
|
+
import {asyncHandler, modelRouter} from "../api";
|
|
6
|
+
import {logger} from "../logger";
|
|
7
|
+
import {Permissions} from "../permissions";
|
|
8
|
+
import type {TerrenoPlugin} from "../terrenoPlugin";
|
|
9
|
+
import {createAuditEventModel} from "./auditEventModel";
|
|
10
|
+
import {auditEnqueueFromEnv} from "./cloudTasksEnqueue";
|
|
11
|
+
import {handleEnqueuedAuditWrite} from "./processQueue";
|
|
12
|
+
import {type AuditEnqueue, installAuditRecorder} from "./record";
|
|
13
|
+
|
|
14
|
+
export interface AuditAppOptions {
|
|
15
|
+
/**
|
|
16
|
+
* When set, persist is delegated (Cloud Tasks). Mongo is not written on the
|
|
17
|
+
* request process. Diffs still run inline so before/after is captured now.
|
|
18
|
+
*/
|
|
19
|
+
enqueue?: AuditEnqueue;
|
|
20
|
+
/** Shared secret for POST on `processQueuePath`. Required when that path is set. */
|
|
21
|
+
processQueueSecret?: string;
|
|
22
|
+
/**
|
|
23
|
+
* Worker URL path Cloud Tasks should POST to. Defaults to `/internal/audit-events`
|
|
24
|
+
* when enqueue comes from env (`GCP_TASKS_AUDIT_QUEUE` + `AUDIT_TASKS_URL`).
|
|
25
|
+
*/
|
|
26
|
+
processQueuePath?: string;
|
|
27
|
+
/** Mongo TTL in days. Omit or 0 = forever (no TTL index). */
|
|
28
|
+
retentionDays?: number;
|
|
29
|
+
}
|
|
30
|
+
|
|
31
|
+
const DEFAULT_PROCESS_QUEUE_PATH = "/internal/audit-events";
|
|
32
|
+
|
|
33
|
+
export class AuditApp implements TerrenoPlugin {
|
|
34
|
+
private readonly options: AuditAppOptions;
|
|
35
|
+
private readonly enqueue: AuditEnqueue | undefined;
|
|
36
|
+
|
|
37
|
+
constructor(options: AuditAppOptions = {}) {
|
|
38
|
+
this.options = options;
|
|
39
|
+
this.enqueue = options.enqueue ?? auditEnqueueFromEnv();
|
|
40
|
+
}
|
|
41
|
+
|
|
42
|
+
getRetentionDays = (): number | undefined => {
|
|
43
|
+
return this.options.retentionDays;
|
|
44
|
+
};
|
|
45
|
+
|
|
46
|
+
adminContribution(): AdminContribution {
|
|
47
|
+
const model = createAuditEventModel(mongoose.connection, {
|
|
48
|
+
retentionDays: this.options.retentionDays,
|
|
49
|
+
});
|
|
50
|
+
return {
|
|
51
|
+
models: [
|
|
52
|
+
{
|
|
53
|
+
admin: {
|
|
54
|
+
adminPermissions: {
|
|
55
|
+
create: [],
|
|
56
|
+
delete: [],
|
|
57
|
+
update: [],
|
|
58
|
+
},
|
|
59
|
+
defaultSort: "-created",
|
|
60
|
+
displayName: "Audit Log",
|
|
61
|
+
listFields: ["created", "verb", "modelName", "recordLabel", "actorId"],
|
|
62
|
+
readonlyFields: [
|
|
63
|
+
"actorId",
|
|
64
|
+
"after",
|
|
65
|
+
"before",
|
|
66
|
+
"created",
|
|
67
|
+
"modelName",
|
|
68
|
+
"operation",
|
|
69
|
+
"organizationId",
|
|
70
|
+
"recordId",
|
|
71
|
+
"recordLabel",
|
|
72
|
+
"source",
|
|
73
|
+
"updated",
|
|
74
|
+
"verb",
|
|
75
|
+
],
|
|
76
|
+
recordTitleField: "recordLabel",
|
|
77
|
+
},
|
|
78
|
+
model,
|
|
79
|
+
permissions: {
|
|
80
|
+
create: [],
|
|
81
|
+
delete: [],
|
|
82
|
+
list: [Permissions.IsAdmin],
|
|
83
|
+
read: [Permissions.IsAdmin],
|
|
84
|
+
update: [],
|
|
85
|
+
},
|
|
86
|
+
routePath: "/audit-events",
|
|
87
|
+
},
|
|
88
|
+
],
|
|
89
|
+
};
|
|
90
|
+
}
|
|
91
|
+
|
|
92
|
+
register(app: express.Application): void {
|
|
93
|
+
const model = createAuditEventModel(mongoose.connection, {
|
|
94
|
+
retentionDays: this.options.retentionDays,
|
|
95
|
+
});
|
|
96
|
+
installAuditRecorder(model, {enqueue: this.enqueue});
|
|
97
|
+
const router = modelRouter(model, {
|
|
98
|
+
permissions: {
|
|
99
|
+
create: [],
|
|
100
|
+
delete: [],
|
|
101
|
+
list: [Permissions.IsAdmin],
|
|
102
|
+
read: [Permissions.IsAdmin],
|
|
103
|
+
update: [],
|
|
104
|
+
},
|
|
105
|
+
queryFields: ["actorId", "modelName", "organizationId", "recordId", "source", "verb"],
|
|
106
|
+
sort: "-created",
|
|
107
|
+
});
|
|
108
|
+
app.use("/audit-events", router);
|
|
109
|
+
this.mountProcessQueue(app);
|
|
110
|
+
}
|
|
111
|
+
|
|
112
|
+
private mountProcessQueue = (app: express.Application): void => {
|
|
113
|
+
const path = this.resolveProcessQueuePath();
|
|
114
|
+
if (!path) {
|
|
115
|
+
return;
|
|
116
|
+
}
|
|
117
|
+
const secret = this.options.processQueueSecret ?? process.env.AUDIT_TASKS_SECRET;
|
|
118
|
+
if (!secret) {
|
|
119
|
+
logger.error("AuditApp processQueuePath requires processQueueSecret or AUDIT_TASKS_SECRET");
|
|
120
|
+
return;
|
|
121
|
+
}
|
|
122
|
+
app.post(
|
|
123
|
+
path,
|
|
124
|
+
asyncHandler(async (req, res) => {
|
|
125
|
+
return handleEnqueuedAuditWrite({req, res, secret});
|
|
126
|
+
})
|
|
127
|
+
);
|
|
128
|
+
};
|
|
129
|
+
|
|
130
|
+
private resolveProcessQueuePath = (): string | undefined => {
|
|
131
|
+
if (this.options.processQueuePath) {
|
|
132
|
+
return this.options.processQueuePath;
|
|
133
|
+
}
|
|
134
|
+
if (this.options.enqueue === undefined && this.enqueue) {
|
|
135
|
+
return DEFAULT_PROCESS_QUEUE_PATH;
|
|
136
|
+
}
|
|
137
|
+
return undefined;
|
|
138
|
+
};
|
|
139
|
+
}
|
|
@@ -0,0 +1,156 @@
|
|
|
1
|
+
import mongoose from "mongoose";
|
|
2
|
+
|
|
3
|
+
import {
|
|
4
|
+
createdUpdatedPlugin,
|
|
5
|
+
type FindExactlyOnePlugin,
|
|
6
|
+
type FindOneOrNonePlugin,
|
|
7
|
+
findExactlyOne,
|
|
8
|
+
findOneOrNone,
|
|
9
|
+
} from "../plugins";
|
|
10
|
+
|
|
11
|
+
export type AuditEventVerb = "created" | "deleted" | "updated";
|
|
12
|
+
export type AuditEventSource = "admin" | "modelRouter" | "rbac";
|
|
13
|
+
export type AuditEventOperation =
|
|
14
|
+
| "arrayPush"
|
|
15
|
+
| "arrayRemove"
|
|
16
|
+
| "arrayUpdate"
|
|
17
|
+
| "create"
|
|
18
|
+
| "delete"
|
|
19
|
+
| "update";
|
|
20
|
+
|
|
21
|
+
type AuditEventMethods = Record<string, never>;
|
|
22
|
+
|
|
23
|
+
interface AuditEventStatics
|
|
24
|
+
extends FindExactlyOnePlugin<AuditEventDocument>,
|
|
25
|
+
FindOneOrNonePlugin<AuditEventDocument> {}
|
|
26
|
+
|
|
27
|
+
export interface AuditEventModel
|
|
28
|
+
extends mongoose.Model<AuditEventDocument, object, AuditEventMethods>,
|
|
29
|
+
AuditEventStatics {}
|
|
30
|
+
|
|
31
|
+
type AuditEventSchema = mongoose.Schema<AuditEventDocument, AuditEventModel, AuditEventMethods>;
|
|
32
|
+
|
|
33
|
+
export interface AuditEventDocument extends mongoose.Document {
|
|
34
|
+
_id: mongoose.Types.ObjectId;
|
|
35
|
+
actorId?: mongoose.Types.ObjectId;
|
|
36
|
+
after?: Record<string, unknown>;
|
|
37
|
+
before?: Record<string, unknown>;
|
|
38
|
+
created: Date;
|
|
39
|
+
modelName: string;
|
|
40
|
+
operation: AuditEventOperation;
|
|
41
|
+
organizationId?: string;
|
|
42
|
+
recordId?: string;
|
|
43
|
+
recordLabel?: string;
|
|
44
|
+
source: AuditEventSource;
|
|
45
|
+
updated: Date;
|
|
46
|
+
verb: AuditEventVerb;
|
|
47
|
+
}
|
|
48
|
+
|
|
49
|
+
const auditEventSchema: AuditEventSchema = new mongoose.Schema<
|
|
50
|
+
AuditEventDocument,
|
|
51
|
+
AuditEventModel,
|
|
52
|
+
AuditEventMethods
|
|
53
|
+
>(
|
|
54
|
+
{
|
|
55
|
+
actorId: {
|
|
56
|
+
description: "User who performed the mutation, when known",
|
|
57
|
+
index: true,
|
|
58
|
+
ref: "User",
|
|
59
|
+
type: mongoose.Schema.Types.ObjectId,
|
|
60
|
+
},
|
|
61
|
+
after: {
|
|
62
|
+
description: "Redacted changed fields after the mutation",
|
|
63
|
+
type: mongoose.Schema.Types.Mixed,
|
|
64
|
+
},
|
|
65
|
+
before: {
|
|
66
|
+
description: "Redacted changed fields before the mutation",
|
|
67
|
+
type: mongoose.Schema.Types.Mixed,
|
|
68
|
+
},
|
|
69
|
+
modelName: {
|
|
70
|
+
description: "Mongoose model name of the affected document",
|
|
71
|
+
index: true,
|
|
72
|
+
required: true,
|
|
73
|
+
trim: true,
|
|
74
|
+
type: String,
|
|
75
|
+
},
|
|
76
|
+
operation: {
|
|
77
|
+
description: "Fine-grained mutation kind",
|
|
78
|
+
enum: ["arrayPush", "arrayRemove", "arrayUpdate", "create", "delete", "update"],
|
|
79
|
+
required: true,
|
|
80
|
+
type: String,
|
|
81
|
+
},
|
|
82
|
+
organizationId: {
|
|
83
|
+
description: "Tenant organization id when known",
|
|
84
|
+
index: true,
|
|
85
|
+
type: String,
|
|
86
|
+
},
|
|
87
|
+
recordId: {
|
|
88
|
+
description: "Primary key of the affected document",
|
|
89
|
+
index: true,
|
|
90
|
+
type: String,
|
|
91
|
+
},
|
|
92
|
+
recordLabel: {
|
|
93
|
+
description: "Short human-readable label for the affected record",
|
|
94
|
+
trim: true,
|
|
95
|
+
type: String,
|
|
96
|
+
},
|
|
97
|
+
source: {
|
|
98
|
+
description: "Which framework surface wrote this event",
|
|
99
|
+
enum: ["admin", "modelRouter", "rbac"],
|
|
100
|
+
index: true,
|
|
101
|
+
required: true,
|
|
102
|
+
type: String,
|
|
103
|
+
},
|
|
104
|
+
verb: {
|
|
105
|
+
description: "Widget-compatible mutation verb",
|
|
106
|
+
enum: ["created", "deleted", "updated"],
|
|
107
|
+
index: true,
|
|
108
|
+
required: true,
|
|
109
|
+
type: String,
|
|
110
|
+
},
|
|
111
|
+
},
|
|
112
|
+
{strict: "throw", toJSON: {virtuals: true}, toObject: {virtuals: true}}
|
|
113
|
+
);
|
|
114
|
+
|
|
115
|
+
auditEventSchema.index({created: -1});
|
|
116
|
+
// Key order is the Mongo prefix (modelName, recordId), not alphabetical.
|
|
117
|
+
// biome-ignore assist/source/useSortedKeys: compound query prefix is modelName then recordId then created
|
|
118
|
+
auditEventSchema.index({modelName: 1, recordId: 1, created: -1});
|
|
119
|
+
auditEventSchema.plugin(createdUpdatedPlugin);
|
|
120
|
+
auditEventSchema.plugin(findOneOrNone);
|
|
121
|
+
auditEventSchema.plugin(findExactlyOne);
|
|
122
|
+
|
|
123
|
+
const ttlExpireAfterSeconds = (retentionDays?: number): number | undefined => {
|
|
124
|
+
if (retentionDays === undefined || retentionDays <= 0) {
|
|
125
|
+
return undefined;
|
|
126
|
+
}
|
|
127
|
+
return retentionDays * 86400;
|
|
128
|
+
};
|
|
129
|
+
|
|
130
|
+
/** createdUpdatedPlugin indexes `{created: 1}`. Put TTL on that same key pattern. */
|
|
131
|
+
const replaceCreatedIndexWithTtl = (schema: mongoose.Schema, expireAfterSeconds: number): void => {
|
|
132
|
+
const createdPath = schema.path("created") as
|
|
133
|
+
| (mongoose.SchemaType & {_index?: unknown})
|
|
134
|
+
| undefined;
|
|
135
|
+
if (!createdPath) {
|
|
136
|
+
schema.index({created: 1}, {expireAfterSeconds, name: "AuditEvent_created_ttl"});
|
|
137
|
+
return;
|
|
138
|
+
}
|
|
139
|
+
createdPath.options.index = {expireAfterSeconds};
|
|
140
|
+
createdPath._index = {expireAfterSeconds};
|
|
141
|
+
};
|
|
142
|
+
|
|
143
|
+
export const createAuditEventModel = (
|
|
144
|
+
connection: mongoose.Connection,
|
|
145
|
+
options: {retentionDays?: number} = {}
|
|
146
|
+
): AuditEventModel => {
|
|
147
|
+
if (connection.models.AuditEvent) {
|
|
148
|
+
return connection.models.AuditEvent as AuditEventModel;
|
|
149
|
+
}
|
|
150
|
+
const schema = auditEventSchema.clone();
|
|
151
|
+
const expireAfterSeconds = ttlExpireAfterSeconds(options.retentionDays);
|
|
152
|
+
if (expireAfterSeconds !== undefined) {
|
|
153
|
+
replaceCreatedIndexWithTtl(schema as unknown as mongoose.Schema, expireAfterSeconds);
|
|
154
|
+
}
|
|
155
|
+
return connection.model<AuditEventDocument, AuditEventModel>("AuditEvent", schema);
|
|
156
|
+
};
|