@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
|
@@ -281,6 +281,20 @@ describe("fieldDescriptionToOpenApiProperty", () => {
|
|
|
281
281
|
items: {type: "string"},
|
|
282
282
|
type: "array",
|
|
283
283
|
});
|
|
284
|
+
expect(
|
|
285
|
+
fieldDescriptionToOpenApiProperty({
|
|
286
|
+
description: "Platforms",
|
|
287
|
+
enum: ["ios", "android", "web"],
|
|
288
|
+
isArray: true,
|
|
289
|
+
item: {enum: ["ios", "android", "web"], kind: "string", required: false},
|
|
290
|
+
kind: "string",
|
|
291
|
+
required: false,
|
|
292
|
+
})
|
|
293
|
+
).toEqual({
|
|
294
|
+
description: "Platforms",
|
|
295
|
+
items: {enum: ["ios", "android", "web"], type: "string"},
|
|
296
|
+
type: "array",
|
|
297
|
+
});
|
|
284
298
|
expect(fieldDescriptionToOpenApiProperty(embeddedField)).toEqual(
|
|
285
299
|
expect.objectContaining({
|
|
286
300
|
description: "Profile",
|
package/src/schemaMetadata.ts
CHANGED
|
@@ -176,8 +176,9 @@ const describeSchemaPath = (path: string, schemaPath: MongooseSchemaPath): Field
|
|
|
176
176
|
const itemSchemaPath = getNestedValueSchemaPath(schemaPath);
|
|
177
177
|
if (itemSchemaPath) {
|
|
178
178
|
const item = describeCaster(itemSchemaPath);
|
|
179
|
+
const {enum: _arrayEnum, ...arrayBase} = base;
|
|
179
180
|
return {
|
|
180
|
-
...
|
|
181
|
+
...arrayBase,
|
|
181
182
|
isArray: true,
|
|
182
183
|
item,
|
|
183
184
|
kind: item.kind,
|
|
@@ -362,9 +363,6 @@ export const fieldDescriptionToOpenApiProperty = (
|
|
|
362
363
|
items,
|
|
363
364
|
type: "array",
|
|
364
365
|
};
|
|
365
|
-
if (field.enum) {
|
|
366
|
-
property.enum = field.enum;
|
|
367
|
-
}
|
|
368
366
|
return property;
|
|
369
367
|
}
|
|
370
368
|
|
|
@@ -377,7 +375,9 @@ export const fieldDescriptionToOpenApiProperty = (
|
|
|
377
375
|
if (field.description) {
|
|
378
376
|
property.description = field.description;
|
|
379
377
|
}
|
|
380
|
-
|
|
378
|
+
if (nested.required.length > 0) {
|
|
379
|
+
property.required = nested.required;
|
|
380
|
+
}
|
|
381
381
|
return property;
|
|
382
382
|
}
|
|
383
383
|
|
|
@@ -0,0 +1,96 @@
|
|
|
1
|
+
import {beforeEach, describe, it} from "bun:test";
|
|
2
|
+
import {assert} from "chai";
|
|
3
|
+
import {model, Schema} from "mongoose";
|
|
4
|
+
|
|
5
|
+
import {Permissions} from "../permissions";
|
|
6
|
+
import {createdUpdatedPlugin, type IsDeleted, isDeletedPlugin} from "../plugins";
|
|
7
|
+
import {clearSyncRegistry, getSyncRegistry, registerSync} from "./registry";
|
|
8
|
+
import {syncPlugin} from "./syncSeqPlugin";
|
|
9
|
+
|
|
10
|
+
interface AdminBroadcastTodo extends IsDeleted {
|
|
11
|
+
_id: string;
|
|
12
|
+
ownerId: string;
|
|
13
|
+
title: string;
|
|
14
|
+
_syncSeq?: number;
|
|
15
|
+
}
|
|
16
|
+
|
|
17
|
+
const adminBroadcastTodoSchema = new Schema<AdminBroadcastTodo>({
|
|
18
|
+
ownerId: {description: "The owner", type: String},
|
|
19
|
+
title: {description: "The title", required: true, type: String},
|
|
20
|
+
});
|
|
21
|
+
adminBroadcastTodoSchema.plugin(isDeletedPlugin);
|
|
22
|
+
adminBroadcastTodoSchema.plugin(createdUpdatedPlugin);
|
|
23
|
+
adminBroadcastTodoSchema.plugin(syncPlugin);
|
|
24
|
+
const AdminBroadcastTodoModel = model<AdminBroadcastTodo>(
|
|
25
|
+
"AdminBroadcastTodo",
|
|
26
|
+
adminBroadcastTodoSchema
|
|
27
|
+
);
|
|
28
|
+
|
|
29
|
+
const syncOptions = {
|
|
30
|
+
permissions: {
|
|
31
|
+
create: [Permissions.IsAuthenticated],
|
|
32
|
+
delete: [Permissions.IsAuthenticated],
|
|
33
|
+
list: [Permissions.IsAuthenticated],
|
|
34
|
+
read: [Permissions.IsAuthenticated],
|
|
35
|
+
update: [Permissions.IsAuthenticated],
|
|
36
|
+
},
|
|
37
|
+
sync: {scope: {type: "owner" as const}},
|
|
38
|
+
};
|
|
39
|
+
|
|
40
|
+
describe("SyncConfig.adminBroadcast", () => {
|
|
41
|
+
beforeEach(() => {
|
|
42
|
+
clearSyncRegistry();
|
|
43
|
+
});
|
|
44
|
+
|
|
45
|
+
it("stores adminBroadcast true when registerSync is given the flag", () => {
|
|
46
|
+
registerSync({
|
|
47
|
+
config: {adminBroadcast: true, scope: {type: "owner"}},
|
|
48
|
+
model: AdminBroadcastTodoModel,
|
|
49
|
+
options: syncOptions,
|
|
50
|
+
routePath: "/adminBroadcastTodos",
|
|
51
|
+
});
|
|
52
|
+
|
|
53
|
+
assert.strictEqual(getSyncRegistry()[0]?.config.adminBroadcast, true);
|
|
54
|
+
});
|
|
55
|
+
|
|
56
|
+
it("stores adminBroadcast false when registerSync omits the flag", () => {
|
|
57
|
+
registerSync({
|
|
58
|
+
config: {scope: {type: "owner"}},
|
|
59
|
+
model: AdminBroadcastTodoModel,
|
|
60
|
+
options: syncOptions,
|
|
61
|
+
routePath: "/adminBroadcastTodos",
|
|
62
|
+
});
|
|
63
|
+
|
|
64
|
+
assert.strictEqual(getSyncRegistry()[0]?.config.adminBroadcast, false);
|
|
65
|
+
});
|
|
66
|
+
|
|
67
|
+
it("stores adminBroadcast false when the host sets the flag to false", () => {
|
|
68
|
+
registerSync({
|
|
69
|
+
config: {adminBroadcast: false, scope: {type: "owner"}},
|
|
70
|
+
model: AdminBroadcastTodoModel,
|
|
71
|
+
options: syncOptions,
|
|
72
|
+
routePath: "/adminBroadcastTodos",
|
|
73
|
+
});
|
|
74
|
+
|
|
75
|
+
assert.strictEqual(getSyncRegistry()[0]?.config.adminBroadcast, false);
|
|
76
|
+
});
|
|
77
|
+
|
|
78
|
+
it("treats a second registerSync for the same model and route path as a no-op", () => {
|
|
79
|
+
registerSync({
|
|
80
|
+
config: {adminBroadcast: true, scope: {type: "owner"}},
|
|
81
|
+
model: AdminBroadcastTodoModel,
|
|
82
|
+
options: syncOptions,
|
|
83
|
+
routePath: "/adminBroadcastTodos",
|
|
84
|
+
});
|
|
85
|
+
|
|
86
|
+
registerSync({
|
|
87
|
+
config: {adminBroadcast: true, scope: {type: "owner"}},
|
|
88
|
+
model: AdminBroadcastTodoModel,
|
|
89
|
+
options: syncOptions,
|
|
90
|
+
routePath: "/adminBroadcastTodos",
|
|
91
|
+
});
|
|
92
|
+
|
|
93
|
+
assert.equal(getSyncRegistry().length, 1);
|
|
94
|
+
assert.strictEqual(getSyncRegistry()[0]?.config.adminBroadcast, true);
|
|
95
|
+
});
|
|
96
|
+
});
|
|
@@ -0,0 +1,155 @@
|
|
|
1
|
+
import {describe, it} from "bun:test";
|
|
2
|
+
import {assert} from "chai";
|
|
3
|
+
|
|
4
|
+
import type {User} from "../auth";
|
|
5
|
+
import {
|
|
6
|
+
authorizeAdminBroadcastDocument,
|
|
7
|
+
clearAdminBroadcastScopes,
|
|
8
|
+
isAdminBroadcastSocketRoom,
|
|
9
|
+
registerAdminBroadcastScope,
|
|
10
|
+
} from "./adminBroadcastScope";
|
|
11
|
+
|
|
12
|
+
const adminUser = {admin: true, id: "u-admin"} as User;
|
|
13
|
+
|
|
14
|
+
describe("adminBroadcastScope", () => {
|
|
15
|
+
it("treats an unregistered model as unscoped", async () => {
|
|
16
|
+
clearAdminBroadcastScopes();
|
|
17
|
+
assert.equal(
|
|
18
|
+
await authorizeAdminBroadcastDocument({
|
|
19
|
+
doc: {ownerId: "other"},
|
|
20
|
+
modelName: "Missing",
|
|
21
|
+
user: adminUser,
|
|
22
|
+
}),
|
|
23
|
+
"unscoped"
|
|
24
|
+
);
|
|
25
|
+
});
|
|
26
|
+
|
|
27
|
+
it("denies when list permission fails", async () => {
|
|
28
|
+
clearAdminBroadcastScopes();
|
|
29
|
+
registerAdminBroadcastScope("Scoped", {
|
|
30
|
+
listPermissions: [() => false],
|
|
31
|
+
readPermissions: [() => true],
|
|
32
|
+
});
|
|
33
|
+
assert.equal(
|
|
34
|
+
await authorizeAdminBroadcastDocument({
|
|
35
|
+
doc: {ownerId: "other"},
|
|
36
|
+
modelName: "Scoped",
|
|
37
|
+
user: adminUser,
|
|
38
|
+
}),
|
|
39
|
+
"deny"
|
|
40
|
+
);
|
|
41
|
+
});
|
|
42
|
+
|
|
43
|
+
it("denies when queryFilter excludes the document", async () => {
|
|
44
|
+
clearAdminBroadcastScopes();
|
|
45
|
+
registerAdminBroadcastScope("Scoped", {
|
|
46
|
+
listPermissions: [() => true],
|
|
47
|
+
queryFilter: () => ({tenantId: "acme"}),
|
|
48
|
+
readPermissions: [() => true],
|
|
49
|
+
});
|
|
50
|
+
assert.equal(
|
|
51
|
+
await authorizeAdminBroadcastDocument({
|
|
52
|
+
doc: {tenantId: "other"},
|
|
53
|
+
modelName: "Scoped",
|
|
54
|
+
user: adminUser,
|
|
55
|
+
}),
|
|
56
|
+
"deny"
|
|
57
|
+
);
|
|
58
|
+
assert.equal(
|
|
59
|
+
await authorizeAdminBroadcastDocument({
|
|
60
|
+
doc: {tenantId: "acme"},
|
|
61
|
+
modelName: "Scoped",
|
|
62
|
+
user: adminUser,
|
|
63
|
+
}),
|
|
64
|
+
"allow"
|
|
65
|
+
);
|
|
66
|
+
});
|
|
67
|
+
|
|
68
|
+
it("denies when queryFilter returns null", async () => {
|
|
69
|
+
clearAdminBroadcastScopes();
|
|
70
|
+
registerAdminBroadcastScope("Scoped", {
|
|
71
|
+
listPermissions: [() => true],
|
|
72
|
+
queryFilter: () => null,
|
|
73
|
+
readPermissions: [() => true],
|
|
74
|
+
});
|
|
75
|
+
assert.equal(
|
|
76
|
+
await authorizeAdminBroadcastDocument({
|
|
77
|
+
doc: {tenantId: "acme"},
|
|
78
|
+
modelName: "Scoped",
|
|
79
|
+
user: adminUser,
|
|
80
|
+
}),
|
|
81
|
+
"deny"
|
|
82
|
+
);
|
|
83
|
+
});
|
|
84
|
+
|
|
85
|
+
it("allows when queryFilter is omitted", async () => {
|
|
86
|
+
clearAdminBroadcastScopes();
|
|
87
|
+
registerAdminBroadcastScope("Scoped", {
|
|
88
|
+
listPermissions: [() => true],
|
|
89
|
+
readPermissions: [() => true],
|
|
90
|
+
});
|
|
91
|
+
assert.equal(
|
|
92
|
+
await authorizeAdminBroadcastDocument({
|
|
93
|
+
doc: {ownerId: "other"},
|
|
94
|
+
modelName: "Scoped",
|
|
95
|
+
user: adminUser,
|
|
96
|
+
}),
|
|
97
|
+
"allow"
|
|
98
|
+
);
|
|
99
|
+
});
|
|
100
|
+
|
|
101
|
+
it("denies when queryFilter throws", async () => {
|
|
102
|
+
clearAdminBroadcastScopes();
|
|
103
|
+
registerAdminBroadcastScope("Scoped", {
|
|
104
|
+
listPermissions: [() => true],
|
|
105
|
+
queryFilter: () => {
|
|
106
|
+
throw new Error("filter exploded");
|
|
107
|
+
},
|
|
108
|
+
readPermissions: [() => true],
|
|
109
|
+
});
|
|
110
|
+
assert.equal(
|
|
111
|
+
await authorizeAdminBroadcastDocument({
|
|
112
|
+
doc: {ownerId: "other"},
|
|
113
|
+
modelName: "Scoped",
|
|
114
|
+
user: adminUser,
|
|
115
|
+
}),
|
|
116
|
+
"deny"
|
|
117
|
+
);
|
|
118
|
+
});
|
|
119
|
+
|
|
120
|
+
it("denies when the user is missing", async () => {
|
|
121
|
+
clearAdminBroadcastScopes();
|
|
122
|
+
registerAdminBroadcastScope("Scoped", {
|
|
123
|
+
listPermissions: [() => true],
|
|
124
|
+
readPermissions: [() => true],
|
|
125
|
+
});
|
|
126
|
+
assert.equal(
|
|
127
|
+
await authorizeAdminBroadcastDocument({
|
|
128
|
+
doc: {ownerId: "other"},
|
|
129
|
+
modelName: "Scoped",
|
|
130
|
+
}),
|
|
131
|
+
"deny"
|
|
132
|
+
);
|
|
133
|
+
});
|
|
134
|
+
|
|
135
|
+
it("denies when read permission fails", async () => {
|
|
136
|
+
clearAdminBroadcastScopes();
|
|
137
|
+
registerAdminBroadcastScope("Scoped", {
|
|
138
|
+
listPermissions: [() => true],
|
|
139
|
+
readPermissions: [() => false],
|
|
140
|
+
});
|
|
141
|
+
assert.equal(
|
|
142
|
+
await authorizeAdminBroadcastDocument({
|
|
143
|
+
doc: {ownerId: "other"},
|
|
144
|
+
modelName: "Scoped",
|
|
145
|
+
user: adminUser,
|
|
146
|
+
}),
|
|
147
|
+
"deny"
|
|
148
|
+
);
|
|
149
|
+
});
|
|
150
|
+
|
|
151
|
+
it("identifies the admin broadcast socket room", () => {
|
|
152
|
+
assert.isTrue(isAdminBroadcastSocketRoom("sync:todos|admin", "todos"));
|
|
153
|
+
assert.isFalse(isAdminBroadcastSocketRoom("sync:todos|owner:u1", "todos"));
|
|
154
|
+
});
|
|
155
|
+
});
|
|
@@ -0,0 +1,123 @@
|
|
|
1
|
+
import type {User} from "../auth";
|
|
2
|
+
import {logger} from "../logger";
|
|
3
|
+
import type {PermissionMethod} from "../permissions";
|
|
4
|
+
import {checkPermissions} from "../permissions";
|
|
5
|
+
import {matchesQuery} from "../realtime/queryMatcher";
|
|
6
|
+
import {adminBroadcastStream} from "./streams";
|
|
7
|
+
|
|
8
|
+
/**
|
|
9
|
+
* AdminApp row/resource rules for `{collection}|admin` and admin-window
|
|
10
|
+
* `GET /sync/entities`. Product `queryFilter` / `IsOwner` stay on app streams;
|
|
11
|
+
* this registry is the AdminApp list/read contract (resource actions + tenant
|
|
12
|
+
* `queryFilter`) so a panel user cannot fetch or live-stream rows `/admin` REST
|
|
13
|
+
* would hide.
|
|
14
|
+
*/
|
|
15
|
+
export interface AdminBroadcastScope {
|
|
16
|
+
listPermissions: PermissionMethod<unknown>[];
|
|
17
|
+
queryFilter?: (
|
|
18
|
+
user?: User,
|
|
19
|
+
query?: Record<string, unknown>
|
|
20
|
+
) => Record<string, unknown> | null | Promise<Record<string, unknown> | null>;
|
|
21
|
+
readPermissions: PermissionMethod<unknown>[];
|
|
22
|
+
}
|
|
23
|
+
|
|
24
|
+
const adminBroadcastScopes = new Map<string, AdminBroadcastScope>();
|
|
25
|
+
|
|
26
|
+
export const registerAdminBroadcastScope = (
|
|
27
|
+
modelName: string,
|
|
28
|
+
scope: AdminBroadcastScope
|
|
29
|
+
): void => {
|
|
30
|
+
adminBroadcastScopes.set(modelName, scope);
|
|
31
|
+
};
|
|
32
|
+
|
|
33
|
+
export const getAdminBroadcastScope = (modelName: string): AdminBroadcastScope | undefined =>
|
|
34
|
+
adminBroadcastScopes.get(modelName);
|
|
35
|
+
|
|
36
|
+
export const clearAdminBroadcastScopes = (): void => {
|
|
37
|
+
adminBroadcastScopes.clear();
|
|
38
|
+
};
|
|
39
|
+
|
|
40
|
+
/** Socket.io room for `{collection}|admin` (`sync:{tag}|admin`). */
|
|
41
|
+
export const isAdminBroadcastSocketRoom = (room: string, collectionTag: string): boolean =>
|
|
42
|
+
room === `sync:${adminBroadcastStream(collectionTag)}`;
|
|
43
|
+
|
|
44
|
+
const compactFilter = (filter: Record<string, unknown>): Record<string, unknown> | undefined => {
|
|
45
|
+
const next: Record<string, unknown> = {};
|
|
46
|
+
for (const [key, value] of Object.entries(filter)) {
|
|
47
|
+
if (value !== undefined) {
|
|
48
|
+
next[key] = value;
|
|
49
|
+
}
|
|
50
|
+
}
|
|
51
|
+
return Object.keys(next).length > 0 ? next : undefined;
|
|
52
|
+
};
|
|
53
|
+
|
|
54
|
+
export const resolveAdminBroadcastQueryFilter = async ({
|
|
55
|
+
scope,
|
|
56
|
+
user,
|
|
57
|
+
}: {
|
|
58
|
+
scope: AdminBroadcastScope;
|
|
59
|
+
user: User;
|
|
60
|
+
}): Promise<{denied: boolean; filter?: Record<string, unknown>}> => {
|
|
61
|
+
if (!scope.queryFilter) {
|
|
62
|
+
return {denied: false};
|
|
63
|
+
}
|
|
64
|
+
let resolved: Record<string, unknown> | null;
|
|
65
|
+
try {
|
|
66
|
+
resolved = await scope.queryFilter(user, {});
|
|
67
|
+
} catch (error: unknown) {
|
|
68
|
+
logger.error("[sync] admin broadcast queryFilter threw; denying the read", {
|
|
69
|
+
error: String(error),
|
|
70
|
+
userId: String(user.id),
|
|
71
|
+
});
|
|
72
|
+
return {denied: true};
|
|
73
|
+
}
|
|
74
|
+
if (resolved === null) {
|
|
75
|
+
return {denied: true};
|
|
76
|
+
}
|
|
77
|
+
return {denied: false, filter: compactFilter(resolved)};
|
|
78
|
+
};
|
|
79
|
+
|
|
80
|
+
export const canListAdminBroadcastScope = async ({
|
|
81
|
+
scope,
|
|
82
|
+
user,
|
|
83
|
+
}: {
|
|
84
|
+
scope: AdminBroadcastScope;
|
|
85
|
+
user: User;
|
|
86
|
+
}): Promise<boolean> => checkPermissions("list", scope.listPermissions, user);
|
|
87
|
+
|
|
88
|
+
/**
|
|
89
|
+
* `unscoped` means AdminApp has not registered this model — keep product
|
|
90
|
+
* `IsOwner` / `queryFilter` behavior. `deny` / `allow` replace product read
|
|
91
|
+
* for the admin window.
|
|
92
|
+
*/
|
|
93
|
+
export const authorizeAdminBroadcastDocument = async ({
|
|
94
|
+
doc,
|
|
95
|
+
modelName,
|
|
96
|
+
user,
|
|
97
|
+
}: {
|
|
98
|
+
doc?: Record<string, unknown>;
|
|
99
|
+
modelName: string;
|
|
100
|
+
user?: User;
|
|
101
|
+
}): Promise<"allow" | "deny" | "unscoped"> => {
|
|
102
|
+
const scope = getAdminBroadcastScope(modelName);
|
|
103
|
+
if (!scope) {
|
|
104
|
+
return "unscoped";
|
|
105
|
+
}
|
|
106
|
+
if (!user) {
|
|
107
|
+
return "deny";
|
|
108
|
+
}
|
|
109
|
+
if (!(await canListAdminBroadcastScope({scope, user}))) {
|
|
110
|
+
return "deny";
|
|
111
|
+
}
|
|
112
|
+
const filterResult = await resolveAdminBroadcastQueryFilter({scope, user});
|
|
113
|
+
if (filterResult.denied) {
|
|
114
|
+
return "deny";
|
|
115
|
+
}
|
|
116
|
+
if (doc && filterResult.filter && !matchesQuery(doc, filterResult.filter)) {
|
|
117
|
+
return "deny";
|
|
118
|
+
}
|
|
119
|
+
if (doc && !(await checkPermissions("read", scope.readPermissions, user, doc))) {
|
|
120
|
+
return "deny";
|
|
121
|
+
}
|
|
122
|
+
return "allow";
|
|
123
|
+
};
|
|
@@ -0,0 +1,57 @@
|
|
|
1
|
+
import {describe, it} from "bun:test";
|
|
2
|
+
import {assert} from "chai";
|
|
3
|
+
|
|
4
|
+
import type {User} from "../auth";
|
|
5
|
+
import type {AnyTerrenoAccess} from "../rbac/types";
|
|
6
|
+
import {canUseAdminBroadcastWindow} from "./adminWindowAccess";
|
|
7
|
+
|
|
8
|
+
const adminUser = {admin: true, id: "u-admin"} as User;
|
|
9
|
+
const flagOnlyUser = {admin: true, id: "u-flag"} as User;
|
|
10
|
+
const memberUser = {admin: false, id: "u-member"} as User;
|
|
11
|
+
|
|
12
|
+
describe("canUseAdminBroadcastWindow", () => {
|
|
13
|
+
it("uses user.admin when no RBAC is configured", async () => {
|
|
14
|
+
assert.isTrue(await canUseAdminBroadcastWindow({user: adminUser}));
|
|
15
|
+
assert.isFalse(await canUseAdminBroadcastWindow({user: memberUser}));
|
|
16
|
+
});
|
|
17
|
+
|
|
18
|
+
it("requires admin:access when accessControl is configured", async () => {
|
|
19
|
+
const accessControl = {
|
|
20
|
+
can: async () => ({allowed: false}),
|
|
21
|
+
} as unknown as AnyTerrenoAccess;
|
|
22
|
+
|
|
23
|
+
assert.isFalse(
|
|
24
|
+
await canUseAdminBroadcastWindow({
|
|
25
|
+
accessControl,
|
|
26
|
+
user: flagOnlyUser,
|
|
27
|
+
})
|
|
28
|
+
);
|
|
29
|
+
});
|
|
30
|
+
|
|
31
|
+
it("allows a caller when accessControl grants admin:access", async () => {
|
|
32
|
+
const accessControl = {
|
|
33
|
+
can: async () => ({allowed: true}),
|
|
34
|
+
} as unknown as AnyTerrenoAccess;
|
|
35
|
+
|
|
36
|
+
assert.isTrue(
|
|
37
|
+
await canUseAdminBroadcastWindow({
|
|
38
|
+
accessControl,
|
|
39
|
+
user: memberUser,
|
|
40
|
+
})
|
|
41
|
+
);
|
|
42
|
+
});
|
|
43
|
+
|
|
44
|
+
it("prefers canOpenAdminWindow over accessControl and user.admin", async () => {
|
|
45
|
+
const accessControl = {
|
|
46
|
+
can: async () => ({allowed: true}),
|
|
47
|
+
} as unknown as AnyTerrenoAccess;
|
|
48
|
+
|
|
49
|
+
assert.isFalse(
|
|
50
|
+
await canUseAdminBroadcastWindow({
|
|
51
|
+
accessControl,
|
|
52
|
+
canOpenAdminWindow: () => false,
|
|
53
|
+
user: adminUser,
|
|
54
|
+
})
|
|
55
|
+
);
|
|
56
|
+
});
|
|
57
|
+
});
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
import type {User} from "../auth";
|
|
2
|
+
import {Permissions} from "../permissions";
|
|
3
|
+
import {ADMIN_PAGE_PERMISSION} from "../rbac/statements";
|
|
4
|
+
import type {AnyTerrenoAccess} from "../rbac/types";
|
|
5
|
+
|
|
6
|
+
/**
|
|
7
|
+
* Gate for `{collection}|admin` window subscribe and cross-owner `GET /sync/entities`.
|
|
8
|
+
*
|
|
9
|
+
* Matches the admin UI shell: with `accessControl`, require `admin:access`.
|
|
10
|
+
* Without RBAC, fall back to the legacy `user.admin` flag.
|
|
11
|
+
*/
|
|
12
|
+
export const canUseAdminBroadcastWindow = async ({
|
|
13
|
+
accessControl,
|
|
14
|
+
canOpenAdminWindow,
|
|
15
|
+
user,
|
|
16
|
+
}: {
|
|
17
|
+
accessControl?: AnyTerrenoAccess;
|
|
18
|
+
canOpenAdminWindow?: (user: User) => boolean | Promise<boolean>;
|
|
19
|
+
user: User;
|
|
20
|
+
}): Promise<boolean> => {
|
|
21
|
+
if (canOpenAdminWindow) {
|
|
22
|
+
return Boolean(await canOpenAdminWindow(user));
|
|
23
|
+
}
|
|
24
|
+
if (accessControl) {
|
|
25
|
+
const result = await accessControl.can({
|
|
26
|
+
permissions: {admin: [...ADMIN_PAGE_PERMISSION.admin]},
|
|
27
|
+
user,
|
|
28
|
+
});
|
|
29
|
+
return result.allowed;
|
|
30
|
+
}
|
|
31
|
+
return Permissions.IsAdmin("list", user);
|
|
32
|
+
};
|