@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,262 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Snapshot Mongoose models into a catalog and diff against the last generated
|
|
3
|
+
* `schemaAfter`. Drives `terreno-migrate generate` (safe ops vs fail-closed stubs).
|
|
4
|
+
*/
|
|
5
|
+
import type {Model, Document as MongooseDocument, SchemaType} from "mongoose";
|
|
6
|
+
|
|
7
|
+
export interface SchemaFieldCatalog {
|
|
8
|
+
path: string;
|
|
9
|
+
instance: string;
|
|
10
|
+
required: boolean;
|
|
11
|
+
unique: boolean;
|
|
12
|
+
}
|
|
13
|
+
|
|
14
|
+
export interface SchemaIndexCatalog {
|
|
15
|
+
keys: Record<string, number | string>;
|
|
16
|
+
unique: boolean;
|
|
17
|
+
}
|
|
18
|
+
|
|
19
|
+
export interface ModelSchemaCatalog {
|
|
20
|
+
collection: string;
|
|
21
|
+
modelName: string;
|
|
22
|
+
fields: SchemaFieldCatalog[];
|
|
23
|
+
indexes: SchemaIndexCatalog[];
|
|
24
|
+
}
|
|
25
|
+
|
|
26
|
+
export interface SchemaCatalog {
|
|
27
|
+
models: Record<string, ModelSchemaCatalog>;
|
|
28
|
+
}
|
|
29
|
+
|
|
30
|
+
export type SchemaDiffKind =
|
|
31
|
+
| "addIndex"
|
|
32
|
+
| "dropIndex"
|
|
33
|
+
| "addOptionalField"
|
|
34
|
+
| "addRequiredField"
|
|
35
|
+
| "addUniqueIndex"
|
|
36
|
+
| "changeFieldType"
|
|
37
|
+
| "removeField"
|
|
38
|
+
| "renameField";
|
|
39
|
+
|
|
40
|
+
export interface SchemaDiffOp {
|
|
41
|
+
kind: SchemaDiffKind;
|
|
42
|
+
safe: boolean;
|
|
43
|
+
modelName: string;
|
|
44
|
+
path?: string;
|
|
45
|
+
fromPath?: string;
|
|
46
|
+
toPath?: string;
|
|
47
|
+
keys?: Record<string, number | string>;
|
|
48
|
+
}
|
|
49
|
+
|
|
50
|
+
export interface SchemaDiff {
|
|
51
|
+
ops: SchemaDiffOp[];
|
|
52
|
+
}
|
|
53
|
+
|
|
54
|
+
const skipPaths = new Set(["_id", "__v"]);
|
|
55
|
+
|
|
56
|
+
const indexKey = (index: SchemaIndexCatalog): string => {
|
|
57
|
+
return `${JSON.stringify(index.keys)}:${index.unique ? "u" : "n"}`;
|
|
58
|
+
};
|
|
59
|
+
|
|
60
|
+
const fieldMap = (fields: SchemaFieldCatalog[]): Map<string, SchemaFieldCatalog> => {
|
|
61
|
+
return new Map(fields.map((field) => [field.path, field]));
|
|
62
|
+
};
|
|
63
|
+
|
|
64
|
+
export const buildSchemaCatalog = ({
|
|
65
|
+
models,
|
|
66
|
+
}: {
|
|
67
|
+
models: Model<MongooseDocument>[];
|
|
68
|
+
}): SchemaCatalog => {
|
|
69
|
+
const catalog: SchemaCatalog = {models: {}};
|
|
70
|
+
for (const model of models) {
|
|
71
|
+
const fields: SchemaFieldCatalog[] = [];
|
|
72
|
+
const paths = model.schema.paths as Record<string, SchemaType>;
|
|
73
|
+
for (const path of Object.keys(paths)) {
|
|
74
|
+
if (skipPaths.has(path)) {
|
|
75
|
+
continue;
|
|
76
|
+
}
|
|
77
|
+
const schemaType = paths[path];
|
|
78
|
+
const required = Boolean(schemaType.isRequired);
|
|
79
|
+
const unique = Boolean((schemaType as {options?: {unique?: boolean}}).options?.unique);
|
|
80
|
+
fields.push({
|
|
81
|
+
instance: schemaType.instance || "Mixed",
|
|
82
|
+
path,
|
|
83
|
+
required,
|
|
84
|
+
unique,
|
|
85
|
+
});
|
|
86
|
+
}
|
|
87
|
+
fields.sort((a, b) => a.path.localeCompare(b.path));
|
|
88
|
+
|
|
89
|
+
const indexes: SchemaIndexCatalog[] = model.schema
|
|
90
|
+
.indexes()
|
|
91
|
+
.map((entry) => {
|
|
92
|
+
const [keys, options] = entry;
|
|
93
|
+
return {
|
|
94
|
+
keys: keys as Record<string, number | string>,
|
|
95
|
+
unique: Boolean(options?.unique),
|
|
96
|
+
};
|
|
97
|
+
})
|
|
98
|
+
.sort((a, b) => indexKey(a).localeCompare(indexKey(b)));
|
|
99
|
+
|
|
100
|
+
catalog.models[model.modelName] = {
|
|
101
|
+
collection: model.collection.collectionName,
|
|
102
|
+
fields,
|
|
103
|
+
indexes,
|
|
104
|
+
modelName: model.modelName,
|
|
105
|
+
};
|
|
106
|
+
}
|
|
107
|
+
return catalog;
|
|
108
|
+
};
|
|
109
|
+
|
|
110
|
+
export const diffSchemaCatalog = ({
|
|
111
|
+
after,
|
|
112
|
+
before,
|
|
113
|
+
}: {
|
|
114
|
+
after: SchemaCatalog;
|
|
115
|
+
before: SchemaCatalog;
|
|
116
|
+
}): SchemaDiff => {
|
|
117
|
+
const ops: SchemaDiffOp[] = [];
|
|
118
|
+
const modelNames = new Set([...Object.keys(before.models), ...Object.keys(after.models)]);
|
|
119
|
+
|
|
120
|
+
for (const modelName of [...modelNames].sort()) {
|
|
121
|
+
const beforeModel = before.models[modelName] ?? {
|
|
122
|
+
collection: after.models[modelName]?.collection ?? modelName,
|
|
123
|
+
fields: [],
|
|
124
|
+
indexes: [],
|
|
125
|
+
modelName,
|
|
126
|
+
};
|
|
127
|
+
const afterModel = after.models[modelName] ?? {
|
|
128
|
+
collection: beforeModel.collection,
|
|
129
|
+
fields: [],
|
|
130
|
+
indexes: [],
|
|
131
|
+
modelName,
|
|
132
|
+
};
|
|
133
|
+
|
|
134
|
+
const beforeFields = fieldMap(beforeModel.fields);
|
|
135
|
+
const afterFields = fieldMap(afterModel.fields);
|
|
136
|
+
const removed = beforeModel.fields.filter((field) => !afterFields.has(field.path));
|
|
137
|
+
const added = afterModel.fields.filter((field) => !beforeFields.has(field.path));
|
|
138
|
+
|
|
139
|
+
const usedRemoved = new Set<string>();
|
|
140
|
+
const usedAdded = new Set<string>();
|
|
141
|
+
for (const removedField of removed) {
|
|
142
|
+
const match = added.find(
|
|
143
|
+
(addedField) =>
|
|
144
|
+
addedField.instance === removedField.instance && !usedAdded.has(addedField.path)
|
|
145
|
+
);
|
|
146
|
+
if (!match) {
|
|
147
|
+
continue;
|
|
148
|
+
}
|
|
149
|
+
usedRemoved.add(removedField.path);
|
|
150
|
+
usedAdded.add(match.path);
|
|
151
|
+
ops.push({
|
|
152
|
+
fromPath: removedField.path,
|
|
153
|
+
kind: "renameField",
|
|
154
|
+
modelName,
|
|
155
|
+
safe: false,
|
|
156
|
+
toPath: match.path,
|
|
157
|
+
});
|
|
158
|
+
if (match.required) {
|
|
159
|
+
ops.push({
|
|
160
|
+
kind: "addRequiredField",
|
|
161
|
+
modelName,
|
|
162
|
+
path: match.path,
|
|
163
|
+
safe: false,
|
|
164
|
+
});
|
|
165
|
+
}
|
|
166
|
+
}
|
|
167
|
+
|
|
168
|
+
for (const field of added) {
|
|
169
|
+
if (usedAdded.has(field.path)) {
|
|
170
|
+
continue;
|
|
171
|
+
}
|
|
172
|
+
if (field.required) {
|
|
173
|
+
ops.push({
|
|
174
|
+
kind: "addRequiredField",
|
|
175
|
+
modelName,
|
|
176
|
+
path: field.path,
|
|
177
|
+
safe: false,
|
|
178
|
+
});
|
|
179
|
+
continue;
|
|
180
|
+
}
|
|
181
|
+
ops.push({
|
|
182
|
+
kind: "addOptionalField",
|
|
183
|
+
modelName,
|
|
184
|
+
path: field.path,
|
|
185
|
+
safe: true,
|
|
186
|
+
});
|
|
187
|
+
}
|
|
188
|
+
|
|
189
|
+
for (const field of removed) {
|
|
190
|
+
if (usedRemoved.has(field.path)) {
|
|
191
|
+
continue;
|
|
192
|
+
}
|
|
193
|
+
ops.push({
|
|
194
|
+
kind: "removeField",
|
|
195
|
+
modelName,
|
|
196
|
+
path: field.path,
|
|
197
|
+
safe: false,
|
|
198
|
+
});
|
|
199
|
+
}
|
|
200
|
+
|
|
201
|
+
for (const field of afterModel.fields) {
|
|
202
|
+
const previous = beforeFields.get(field.path);
|
|
203
|
+
if (!previous) {
|
|
204
|
+
continue;
|
|
205
|
+
}
|
|
206
|
+
if (previous.instance !== field.instance) {
|
|
207
|
+
ops.push({
|
|
208
|
+
kind: "changeFieldType",
|
|
209
|
+
modelName,
|
|
210
|
+
path: field.path,
|
|
211
|
+
safe: false,
|
|
212
|
+
});
|
|
213
|
+
}
|
|
214
|
+
if (!previous.required && field.required) {
|
|
215
|
+
ops.push({
|
|
216
|
+
kind: "addRequiredField",
|
|
217
|
+
modelName,
|
|
218
|
+
path: field.path,
|
|
219
|
+
safe: false,
|
|
220
|
+
});
|
|
221
|
+
}
|
|
222
|
+
}
|
|
223
|
+
|
|
224
|
+
const beforeIndexes = new Set(beforeModel.indexes.map(indexKey));
|
|
225
|
+
const afterIndexes = new Set(afterModel.indexes.map(indexKey));
|
|
226
|
+
|
|
227
|
+
for (const index of afterModel.indexes) {
|
|
228
|
+
if (beforeIndexes.has(indexKey(index))) {
|
|
229
|
+
continue;
|
|
230
|
+
}
|
|
231
|
+
if (index.unique) {
|
|
232
|
+
ops.push({
|
|
233
|
+
keys: index.keys,
|
|
234
|
+
kind: "addUniqueIndex",
|
|
235
|
+
modelName,
|
|
236
|
+
safe: false,
|
|
237
|
+
});
|
|
238
|
+
continue;
|
|
239
|
+
}
|
|
240
|
+
ops.push({
|
|
241
|
+
keys: index.keys,
|
|
242
|
+
kind: "addIndex",
|
|
243
|
+
modelName,
|
|
244
|
+
safe: true,
|
|
245
|
+
});
|
|
246
|
+
}
|
|
247
|
+
|
|
248
|
+
for (const index of beforeModel.indexes) {
|
|
249
|
+
if (afterIndexes.has(indexKey(index))) {
|
|
250
|
+
continue;
|
|
251
|
+
}
|
|
252
|
+
ops.push({
|
|
253
|
+
keys: index.keys,
|
|
254
|
+
kind: "dropIndex",
|
|
255
|
+
modelName,
|
|
256
|
+
safe: true,
|
|
257
|
+
});
|
|
258
|
+
}
|
|
259
|
+
}
|
|
260
|
+
|
|
261
|
+
return {ops};
|
|
262
|
+
};
|
|
@@ -0,0 +1,94 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Shared types and constants for Terreno MongoDB migrations. History and the
|
|
3
|
+
* migrate lock both live in the native `terreno_migrations` collection.
|
|
4
|
+
*/
|
|
5
|
+
import type mongoose from "mongoose";
|
|
6
|
+
|
|
7
|
+
/** Mongo collection that stores applied migration rows and the lock document. */
|
|
8
|
+
export const MIGRATIONS_COLLECTION = "terreno_migrations";
|
|
9
|
+
|
|
10
|
+
/** Reserved `_id` for the migrate lock row (Task 1.2). */
|
|
11
|
+
export const MIGRATION_LOCK_ID = "_lock";
|
|
12
|
+
|
|
13
|
+
/** Native collection documents in `terreno_migrations` (string `_id`, not ObjectId). */
|
|
14
|
+
export interface MigrationStoreDoc {
|
|
15
|
+
_id: string;
|
|
16
|
+
id?: string;
|
|
17
|
+
checksum?: string;
|
|
18
|
+
appliedAt?: Date;
|
|
19
|
+
holder?: string;
|
|
20
|
+
heartbeatAt?: Date;
|
|
21
|
+
expiresAt?: Date;
|
|
22
|
+
}
|
|
23
|
+
|
|
24
|
+
export interface MigrationLogger {
|
|
25
|
+
debug: (message: string, ...meta: unknown[]) => void;
|
|
26
|
+
info: (message: string, ...meta: unknown[]) => void;
|
|
27
|
+
warn: (message: string, ...meta: unknown[]) => void;
|
|
28
|
+
error: (message: string, ...meta: unknown[]) => void;
|
|
29
|
+
}
|
|
30
|
+
|
|
31
|
+
export interface MigrationContext {
|
|
32
|
+
dryRun: boolean;
|
|
33
|
+
mongoose: typeof mongoose;
|
|
34
|
+
logger: MigrationLogger;
|
|
35
|
+
addLog?: (level: "info" | "warn" | "error", message: string) => Promise<void>;
|
|
36
|
+
checkCancellation?: () => Promise<void>;
|
|
37
|
+
}
|
|
38
|
+
|
|
39
|
+
export interface MigrationModule {
|
|
40
|
+
id: string;
|
|
41
|
+
up: (ctx: MigrationContext) => Promise<void>;
|
|
42
|
+
down?: (ctx: MigrationContext) => Promise<void>;
|
|
43
|
+
schemaAfter?: unknown;
|
|
44
|
+
}
|
|
45
|
+
|
|
46
|
+
export interface LoadedMigration extends MigrationModule {
|
|
47
|
+
checksum: string;
|
|
48
|
+
}
|
|
49
|
+
|
|
50
|
+
export interface AppliedMigrationRecord {
|
|
51
|
+
id: string;
|
|
52
|
+
checksum: string;
|
|
53
|
+
appliedAt: Date;
|
|
54
|
+
}
|
|
55
|
+
|
|
56
|
+
export interface RunMigrationsOptions {
|
|
57
|
+
migrations: LoadedMigration[];
|
|
58
|
+
dryRun: boolean;
|
|
59
|
+
connection: mongoose.Connection;
|
|
60
|
+
mongoose: typeof mongoose;
|
|
61
|
+
logger?: MigrationLogger;
|
|
62
|
+
lockTtlMs?: number;
|
|
63
|
+
lockPollMs?: number;
|
|
64
|
+
checkCancellation?: () => Promise<void>;
|
|
65
|
+
addLog?: MigrationContext["addLog"];
|
|
66
|
+
}
|
|
67
|
+
|
|
68
|
+
export interface RunMigrationsResult {
|
|
69
|
+
applied: string[];
|
|
70
|
+
skipped: string[];
|
|
71
|
+
dryRun: boolean;
|
|
72
|
+
}
|
|
73
|
+
|
|
74
|
+
export interface RunDownMigrationsOptions {
|
|
75
|
+
migrations: LoadedMigration[];
|
|
76
|
+
dryRun: boolean;
|
|
77
|
+
connection: mongoose.Connection;
|
|
78
|
+
mongoose: typeof mongoose;
|
|
79
|
+
logger?: MigrationLogger;
|
|
80
|
+
lockTtlMs?: number;
|
|
81
|
+
lockPollMs?: number;
|
|
82
|
+
steps: number;
|
|
83
|
+
}
|
|
84
|
+
|
|
85
|
+
export interface RunDownMigrationsResult {
|
|
86
|
+
reversed: string[];
|
|
87
|
+
dryRun: boolean;
|
|
88
|
+
}
|
|
89
|
+
|
|
90
|
+
export interface MigrationStatus {
|
|
91
|
+
applied: AppliedMigrationRecord[];
|
|
92
|
+
pending: Array<{id: string; checksum: string}>;
|
|
93
|
+
lock: {holder: string; expiresAt: Date} | null;
|
|
94
|
+
}
|
|
@@ -0,0 +1,68 @@
|
|
|
1
|
+
import mongoose from "mongoose";
|
|
2
|
+
import {createdUpdatedPlugin, findExactlyOne, findOneOrNone, isDeletedPlugin} from "../plugins";
|
|
3
|
+
import {syncPlugin} from "../sync/syncSeqPlugin";
|
|
4
|
+
import type {NotificationDocument, NotificationModel} from "../types/notification";
|
|
5
|
+
|
|
6
|
+
const notificationSchema = new mongoose.Schema<NotificationDocument, NotificationModel>(
|
|
7
|
+
{
|
|
8
|
+
_id: {
|
|
9
|
+
default: (): string => new mongoose.Types.ObjectId().toHexString(),
|
|
10
|
+
description: "The document id (string so offline sync clients can mint ids)",
|
|
11
|
+
type: String,
|
|
12
|
+
},
|
|
13
|
+
archivedAt: {
|
|
14
|
+
default: null,
|
|
15
|
+
description:
|
|
16
|
+
"When the owner archived (dismissed) this notification; null means it is still in the active inbox",
|
|
17
|
+
type: Date,
|
|
18
|
+
},
|
|
19
|
+
body: {
|
|
20
|
+
description: "Main notification message text shown in the inbox",
|
|
21
|
+
required: true,
|
|
22
|
+
trim: true,
|
|
23
|
+
type: String,
|
|
24
|
+
},
|
|
25
|
+
href: {
|
|
26
|
+
description: "Optional deep link or in-app route opened when the user taps the notification",
|
|
27
|
+
trim: true,
|
|
28
|
+
type: String,
|
|
29
|
+
},
|
|
30
|
+
kind: {
|
|
31
|
+
description: "Optional category string used for icons or grouping in the UI",
|
|
32
|
+
trim: true,
|
|
33
|
+
type: String,
|
|
34
|
+
},
|
|
35
|
+
ownerId: {
|
|
36
|
+
description: "The user who owns this inbox row",
|
|
37
|
+
ref: "User",
|
|
38
|
+
required: true,
|
|
39
|
+
type: mongoose.Schema.Types.ObjectId,
|
|
40
|
+
},
|
|
41
|
+
readAt: {
|
|
42
|
+
default: null,
|
|
43
|
+
description: "When the owner marked this notification as read; null means unread",
|
|
44
|
+
type: Date,
|
|
45
|
+
},
|
|
46
|
+
title: {
|
|
47
|
+
description: "Short headline shown in the inbox list",
|
|
48
|
+
required: true,
|
|
49
|
+
trim: true,
|
|
50
|
+
type: String,
|
|
51
|
+
},
|
|
52
|
+
},
|
|
53
|
+
{strict: "throw", toJSON: {virtuals: true}, toObject: {virtuals: true}}
|
|
54
|
+
);
|
|
55
|
+
|
|
56
|
+
// biome-ignore assist/source/useSortedKeys: ownerId must lead the compound index for owner-scoped inbox queries
|
|
57
|
+
notificationSchema.index({ownerId: 1, created: -1});
|
|
58
|
+
|
|
59
|
+
notificationSchema.plugin(createdUpdatedPlugin);
|
|
60
|
+
notificationSchema.plugin(isDeletedPlugin);
|
|
61
|
+
notificationSchema.plugin(findExactlyOne);
|
|
62
|
+
notificationSchema.plugin(findOneOrNone);
|
|
63
|
+
notificationSchema.plugin(syncPlugin);
|
|
64
|
+
|
|
65
|
+
export const Notification = mongoose.model<NotificationDocument, NotificationModel>(
|
|
66
|
+
"Notification",
|
|
67
|
+
notificationSchema
|
|
68
|
+
);
|
|
@@ -0,0 +1,62 @@
|
|
|
1
|
+
import mongoose from "mongoose";
|
|
2
|
+
import {createdUpdatedPlugin, findExactlyOne, findOneOrNone, isDeletedPlugin} from "../plugins";
|
|
3
|
+
import {syncPlugin} from "../sync/syncSeqPlugin";
|
|
4
|
+
import type {
|
|
5
|
+
NotificationPreferenceDocument,
|
|
6
|
+
NotificationPreferenceModel,
|
|
7
|
+
} from "../types/notificationPreference";
|
|
8
|
+
|
|
9
|
+
const notificationPreferenceSchema = new mongoose.Schema<
|
|
10
|
+
NotificationPreferenceDocument,
|
|
11
|
+
NotificationPreferenceModel
|
|
12
|
+
>(
|
|
13
|
+
{
|
|
14
|
+
_id: {
|
|
15
|
+
default: (): string => new mongoose.Types.ObjectId().toHexString(),
|
|
16
|
+
description: "The document id (string so offline sync clients can mint ids)",
|
|
17
|
+
type: String,
|
|
18
|
+
},
|
|
19
|
+
inapp: {
|
|
20
|
+
default: true,
|
|
21
|
+
description: "Whether in-app inbox rows are created for this user",
|
|
22
|
+
type: Boolean,
|
|
23
|
+
},
|
|
24
|
+
mail: {
|
|
25
|
+
default: true,
|
|
26
|
+
description: "Whether outbound email is sent for notifications",
|
|
27
|
+
type: Boolean,
|
|
28
|
+
},
|
|
29
|
+
ownerId: {
|
|
30
|
+
description: "The user these preferences belong to",
|
|
31
|
+
ref: "User",
|
|
32
|
+
required: true,
|
|
33
|
+
type: mongoose.Schema.Types.ObjectId,
|
|
34
|
+
},
|
|
35
|
+
push: {
|
|
36
|
+
default: true,
|
|
37
|
+
description: "Whether push notifications are sent for this user",
|
|
38
|
+
type: Boolean,
|
|
39
|
+
},
|
|
40
|
+
sms: {
|
|
41
|
+
default: true,
|
|
42
|
+
description: "Whether SMS messages are sent for this user",
|
|
43
|
+
type: Boolean,
|
|
44
|
+
},
|
|
45
|
+
},
|
|
46
|
+
{strict: "throw", toJSON: {virtuals: true}, toObject: {virtuals: true}}
|
|
47
|
+
);
|
|
48
|
+
|
|
49
|
+
notificationPreferenceSchema.plugin(createdUpdatedPlugin);
|
|
50
|
+
notificationPreferenceSchema.plugin(isDeletedPlugin);
|
|
51
|
+
notificationPreferenceSchema.plugin(findExactlyOne);
|
|
52
|
+
notificationPreferenceSchema.plugin(findOneOrNone);
|
|
53
|
+
notificationPreferenceSchema.plugin(syncPlugin);
|
|
54
|
+
notificationPreferenceSchema.index(
|
|
55
|
+
{ownerId: 1},
|
|
56
|
+
{partialFilterExpression: {deleted: false}, unique: true}
|
|
57
|
+
);
|
|
58
|
+
|
|
59
|
+
export const NotificationPreference = mongoose.model<
|
|
60
|
+
NotificationPreferenceDocument,
|
|
61
|
+
NotificationPreferenceModel
|
|
62
|
+
>("NotificationPreference", notificationPreferenceSchema);
|