@terreno/api 57.20.0 → 58.0.0-beta.1
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/CHANGELOG.md +93 -0
- package/README.md +1 -1
- package/biome.jsonc +3 -2
- package/dist/api.d.ts +3 -16
- package/dist/api.js +0 -9
- package/dist/auth.d.ts +3 -2
- package/dist/auth.js +95 -5
- package/dist/authRecovery.d.ts +2 -1
- package/dist/authRecovery.js +35 -17
- package/dist/collectionRegistry.d.ts +3 -4
- package/dist/collectionRegistry.js +0 -1
- package/dist/consentApp.d.ts +1 -1
- package/dist/consentApp.js +58 -2
- package/dist/frameworkModelNames.d.ts +4 -0
- package/dist/frameworkModelNames.js +4 -0
- package/dist/index.d.ts +8 -5
- package/dist/index.js +14 -20
- package/dist/mcp/adminTracking.d.ts +28 -0
- package/dist/mcp/adminTracking.js +80 -0
- package/dist/mcp/auth.d.ts +6 -0
- package/dist/mcp/auth.js +12 -2
- package/dist/mcp/server.d.ts +8 -0
- package/dist/mcp/server.js +48 -4
- package/dist/mcp/serviceTokens.d.ts +21 -1
- package/dist/mcp/serviceTokens.js +159 -183
- package/dist/migrations/builtin/mcpServiceTokenStringIds.d.ts +18 -0
- package/dist/migrations/builtin/mcpServiceTokenStringIds.js +67 -0
- package/dist/models/mcpOAuthToken.js +27 -0
- package/dist/models/mcpRequestLog.d.ts +2 -0
- package/dist/models/mcpRequestLog.js +73 -0
- package/dist/models/mcpServiceToken.js +40 -4
- package/dist/models/mcpToolSetting.d.ts +2 -0
- package/dist/models/mcpToolSetting.js +119 -0
- package/dist/models/versionConfig.d.ts +2 -0
- package/dist/openApiBuilder.d.ts +4 -0
- package/dist/openApiBuilder.js +2 -0
- package/dist/rbac/auditModel.d.ts +2 -1
- package/dist/rbac/realtimeAccess.d.ts +5 -4
- package/dist/rbac/realtimeAccess.js +17 -64
- package/dist/realtime/changeStreamWatcher.d.ts +8 -63
- package/dist/realtime/changeStreamWatcher.js +32 -391
- package/dist/realtime/realtimeApp.d.ts +14 -27
- package/dist/realtime/realtimeApp.js +14 -220
- package/dist/realtime/types.d.ts +0 -64
- package/dist/sync/executors.js +14 -2
- package/dist/sync/socketHandlers.d.ts +1 -1
- package/dist/sync/socketHandlers.js +1 -1
- package/dist/terrenoApp.d.ts +19 -5
- package/dist/terrenoApp.js +21 -14
- package/dist/tests/models.d.ts +17 -22
- package/dist/tests/models.js +7 -1
- package/dist/tests/openApiResponseSchema.d.ts +39 -0
- package/dist/tests/openApiResponseSchema.js +56 -0
- package/dist/tests/testHelper.d.ts +6 -12
- package/dist/tests.d.ts +2 -0
- package/dist/tests.js +6 -1
- package/dist/types/mcpAdmin.d.ts +58 -0
- package/dist/types/mcpAdmin.js +2 -0
- package/dist/types/mcpOAuth.d.ts +2 -0
- package/dist/types/mcpServiceToken.d.ts +9 -4
- package/dist/versionCheckPlugin.d.ts +1 -1
- package/dist/versionCheckPlugin.js +25 -2
- package/e2e/smoke.ts +193 -0
- package/package.json +14 -8
- package/src/__snapshots__/openApi.test.ts.snap +4986 -2478
- package/src/__snapshots__/openApiBuilder.test.ts.snap +836 -0
- package/src/__tests__/openApiResponseSchema.test.ts +148 -0
- package/src/__tests__/versionCheckPlugin.test.ts +72 -0
- package/src/adminModelRouter.test.ts +8 -6
- package/src/api.arrayOperations.test.ts +31 -22
- package/src/api.hooks.test.ts +12 -11
- package/src/api.query.test.ts +2 -2
- package/src/api.test.ts +17 -14
- package/src/api.ts +3 -27
- package/src/audit/auditApp.test.ts +1 -1
- package/src/audit/cloudTasksEnqueue.test.ts +19 -14
- package/src/auth.test.ts +21 -7
- package/src/auth.ts +116 -5
- package/src/authOpenApi.test.ts +316 -0
- package/src/authRecovery.test.ts +10 -10
- package/src/authRecovery.ts +47 -19
- package/src/authVerification.test.ts +7 -7
- package/src/betterAuthFeatures.test.ts +3 -2
- package/src/betterAuthLinking.test.ts +3 -1
- package/src/betterAuthOAuthHandoff.test.ts +13 -5
- package/src/betterAuthSetup.test.ts +77 -51
- package/src/collectionRegistry.test.ts +4 -4
- package/src/collectionRegistry.ts +3 -5
- package/src/consentApp.test.ts +98 -0
- package/src/consentApp.ts +67 -2
- package/src/frameworkModelNames.test.ts +8 -0
- package/src/frameworkModelNames.ts +4 -0
- package/src/githubAuth.test.ts +11 -11
- package/src/index.ts +14 -28
- package/src/isolated/migrateCliConnect.isolated.ts +3 -2
- package/src/mcp/actionTools.test.ts +13 -7
- package/src/mcp/adminTracking.test.ts +272 -0
- package/src/mcp/adminTracking.ts +104 -0
- package/src/mcp/auth.test.ts +7 -3
- package/src/mcp/auth.ts +18 -2
- package/src/mcp/oauth.test.ts +13 -13
- package/src/mcp/server.ts +67 -4
- package/src/mcp/serviceTokens.sync.test.ts +230 -0
- package/src/mcp/serviceTokens.test.ts +114 -62
- package/src/mcp/serviceTokens.ts +193 -212
- package/src/mcp/toolGenerator.test.ts +9 -5
- package/src/migrations/builtin/mcpServiceTokenStringIds.test.ts +194 -0
- package/src/migrations/builtin/mcpServiceTokenStringIds.ts +121 -0
- package/src/migrations/cli.test.ts +15 -14
- package/src/migrations/cli.ts +1 -1
- package/src/migrations/generate.test.ts +2 -2
- package/src/migrations/load.test.ts +1 -1
- package/src/migrations/lock.test.ts +8 -3
- package/src/migrations/runner.test.ts +16 -5
- package/src/migrations/schemaCatalog.test.ts +4 -1
- package/src/models/mcpOAuthToken.test.ts +42 -0
- package/src/models/mcpOAuthToken.ts +32 -0
- package/src/models/mcpRequestLog.ts +81 -0
- package/src/models/mcpServiceToken.test.ts +75 -5
- package/src/models/mcpServiceToken.ts +61 -14
- package/src/models/mcpToolSetting.test.ts +69 -0
- package/src/models/mcpToolSetting.ts +138 -0
- package/src/models/versionConfig.ts +2 -0
- package/src/notifications/notificationsApp.test.ts +5 -8
- package/src/notifiers/slackWebApi.test.ts +30 -8
- package/src/openApi.test.ts +4 -4
- package/src/openApiBuilder.test.ts +34 -1
- package/src/openApiBuilder.ts +5 -0
- package/src/openApiValidator.test.ts +3 -3
- package/src/orgs/orgPermissions.test.ts +2 -2
- package/src/orgs/orgPlugin.test.ts +4 -3
- package/src/orgs/orgSecurityDefects.test.ts +3 -1
- package/src/orgs/organizationSettings.test.ts +1 -1
- package/src/orgs/orgsApp.test.ts +5 -3
- package/src/permissions.test.ts +2 -2
- package/src/rateLimit/rateLimit.test.ts +25 -10
- package/src/rateLimit/redisStore.ioredis.test.ts +3 -2
- package/src/rbac/assertAllowed.test.ts +1 -1
- package/src/rbac/auditModel.ts +10 -2
- package/src/rbac/realtimeAccess.test.ts +20 -171
- package/src/rbac/realtimeAccess.ts +17 -82
- package/src/rbac/routes.test.ts +1 -1
- package/src/rbac/userWriteGuards.test.ts +8 -5
- package/src/realtime/changeStreamWatcher.ts +43 -506
- package/src/realtime/realtime.test.ts +211 -2547
- package/src/realtime/realtimeApp.ts +16 -295
- package/src/realtime/types.ts +0 -72
- package/src/scrubAdminFields.test.ts +1 -1
- package/src/sync/adminWindowMutation.test.ts +4 -3
- package/src/sync/executors.test.ts +29 -1
- package/src/sync/executors.ts +23 -2
- package/src/sync/scripts/compactTombstones.test.ts +4 -3
- package/src/sync/socketHandlers.ts +1 -1
- package/src/sync/sync.test.ts +1 -1
- package/src/sync/syncPhaseC.test.ts +14 -11
- package/src/sync/syncRoutes.test.ts +8 -8
- package/src/sync/syncSeqPlugin.test.ts +1 -2
- package/src/sync/syncSocket.test.ts +78 -113
- package/src/terrenoApp.mcpServiceTokens.test.ts +16 -8
- package/src/terrenoApp.migrations.test.ts +8 -7
- package/src/terrenoApp.ts +38 -18
- package/src/tests/betterAuthStubs.ts +3 -2
- package/src/tests/bunSetup.ts +1 -1
- package/src/tests/models.ts +10 -0
- package/src/tests/openApiResponseSchema.ts +104 -0
- package/src/tests/testEnv.ts +7 -0
- package/src/tests.ts +8 -0
- package/src/types/mcpAdmin.ts +80 -0
- package/src/types/mcpOAuth.ts +5 -0
- package/src/types/mcpServiceToken.ts +12 -4
- package/src/versionCheckPlugin.ts +41 -2
- package/src/webhooks/verifiers/hmac.test.ts +1 -1
- package/tsconfig.typecheck.json +14 -0
- package/dist/realtime/deprecation.d.ts +0 -13
- package/dist/realtime/deprecation.js +0 -31
- package/dist/realtime/queryStore.d.ts +0 -37
- package/dist/realtime/queryStore.js +0 -103
- package/dist/realtime/registry.d.ts +0 -15
- package/dist/realtime/registry.js +0 -52
- package/src/realtime/deprecation.test.ts +0 -60
- package/src/realtime/deprecation.ts +0 -33
- package/src/realtime/queryStore.ts +0 -122
- package/src/realtime/registry.ts +0 -84
|
@@ -1,47 +1,19 @@
|
|
|
1
|
-
import type {RESTMethod} from "../api";
|
|
2
1
|
import type {User} from "../auth";
|
|
3
2
|
import {checkPermissions, type PermissionMethod} from "../permissions";
|
|
4
|
-
import {applyReadMask} from "./fieldViews";
|
|
5
3
|
import type {AnyTerrenoAccess, ModelRouterAccessOptions} from "./types";
|
|
6
4
|
|
|
7
5
|
interface RealtimeAccessEntry {
|
|
8
6
|
options: {
|
|
9
7
|
access?: ModelRouterAccessOptions;
|
|
10
8
|
accessControl?: AnyTerrenoAccess;
|
|
11
|
-
permissions?: {read?: PermissionMethod<unknown>[]
|
|
9
|
+
permissions?: {read?: PermissionMethod<unknown>[]};
|
|
12
10
|
};
|
|
13
11
|
}
|
|
14
12
|
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
const resolveActionForMethod = (
|
|
21
|
-
method: "list" | "read",
|
|
22
|
-
access: ModelRouterAccessOptions,
|
|
23
|
-
statements: Record<string, readonly string[]>
|
|
24
|
-
): string | null => {
|
|
25
|
-
const override = access.actions?.[method];
|
|
26
|
-
if (override === null) {
|
|
27
|
-
return null;
|
|
28
|
-
}
|
|
29
|
-
if (override) {
|
|
30
|
-
return override;
|
|
31
|
-
}
|
|
32
|
-
|
|
33
|
-
const resourceActions = statements[access.resource] ?? [];
|
|
34
|
-
if (method === "list" && resourceActions.includes("list")) {
|
|
35
|
-
return "list";
|
|
36
|
-
}
|
|
37
|
-
if (method === "list") {
|
|
38
|
-
return "read";
|
|
39
|
-
}
|
|
40
|
-
return DEFAULT_METHOD_ACTIONS[method];
|
|
41
|
-
};
|
|
42
|
-
|
|
43
|
-
// REST and snapshot permissions append access.also[method] to the RBAC role and scope checks
|
|
44
|
-
// (buildAccessPermissions), so realtime decisions must apply them too.
|
|
13
|
+
/**
|
|
14
|
+
* REST `access.also[method]` still applies to socket document reads. An empty list allows
|
|
15
|
+
* the read; any listed permission must pass.
|
|
16
|
+
*/
|
|
45
17
|
const checkAlsoPermissions = async (
|
|
46
18
|
access: ModelRouterAccessOptions,
|
|
47
19
|
method: "list" | "read",
|
|
@@ -55,34 +27,20 @@ const checkAlsoPermissions = async (
|
|
|
55
27
|
return checkPermissions(method, also, user, doc);
|
|
56
28
|
};
|
|
57
29
|
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
const access = entry.options.access;
|
|
64
|
-
const accessControl = entry.options.accessControl;
|
|
65
|
-
if (access && accessControl) {
|
|
66
|
-
const statements = accessControl.statements as Record<string, readonly string[]>;
|
|
67
|
-
const action = resolveActionForMethod(method, access, statements);
|
|
68
|
-
if (!action) {
|
|
69
|
-
return false;
|
|
70
|
-
}
|
|
71
|
-
const result = await accessControl.can({
|
|
72
|
-
context: {transport: "socket"},
|
|
73
|
-
permissions: {[access.resource]: [action]},
|
|
74
|
-
user,
|
|
75
|
-
});
|
|
76
|
-
if (!result.allowed) {
|
|
77
|
-
return false;
|
|
78
|
-
}
|
|
79
|
-
return checkAlsoPermissions(access, method, user);
|
|
30
|
+
/** The RBAC action for socket document reads: the router's `read` override, else `read`. */
|
|
31
|
+
const resolveReadAction = (access: ModelRouterAccessOptions): string | null => {
|
|
32
|
+
const override = access.actions?.read;
|
|
33
|
+
if (override === null) {
|
|
34
|
+
return null;
|
|
80
35
|
}
|
|
81
|
-
|
|
82
|
-
const permissions = entry.options.permissions?.[method] ?? [];
|
|
83
|
-
return checkPermissions(method, permissions, user);
|
|
36
|
+
return override ?? "read";
|
|
84
37
|
};
|
|
85
38
|
|
|
39
|
+
/**
|
|
40
|
+
* Socket-side read check for one document, used before emitting `sync:delta` to each
|
|
41
|
+
* socket in a sync stream room. Uses RBAC (`access` + `accessControl`, including
|
|
42
|
+
* `access.scope.check`) when configured, else the router's `permissions.read`.
|
|
43
|
+
*/
|
|
86
44
|
export const canReadDocumentRealtime = async (
|
|
87
45
|
entry: RealtimeAccessEntry,
|
|
88
46
|
user?: User,
|
|
@@ -91,8 +49,7 @@ export const canReadDocumentRealtime = async (
|
|
|
91
49
|
const access = entry.options.access;
|
|
92
50
|
const accessControl = entry.options.accessControl;
|
|
93
51
|
if (access && accessControl) {
|
|
94
|
-
const
|
|
95
|
-
const action = resolveActionForMethod("read", access, statements);
|
|
52
|
+
const action = resolveReadAction(access);
|
|
96
53
|
if (!action) {
|
|
97
54
|
return false;
|
|
98
55
|
}
|
|
@@ -134,25 +91,3 @@ export const canReadDocumentRealtime = async (
|
|
|
134
91
|
|
|
135
92
|
return checkPermissions("read", entry.options.permissions?.read ?? [], user, doc);
|
|
136
93
|
};
|
|
137
|
-
|
|
138
|
-
export const maskRealtimeDocument = async (
|
|
139
|
-
entry: RealtimeAccessEntry,
|
|
140
|
-
user: User | undefined,
|
|
141
|
-
doc: unknown,
|
|
142
|
-
_method: RESTMethod
|
|
143
|
-
): Promise<unknown> => {
|
|
144
|
-
const access = entry.options.access;
|
|
145
|
-
const accessControl = entry.options.accessControl;
|
|
146
|
-
if (!access || !accessControl) {
|
|
147
|
-
return doc;
|
|
148
|
-
}
|
|
149
|
-
|
|
150
|
-
const phase = "read";
|
|
151
|
-
const mask = await accessControl.fieldMask({
|
|
152
|
-
doc,
|
|
153
|
-
phase,
|
|
154
|
-
resource: access.resource,
|
|
155
|
-
user,
|
|
156
|
-
});
|
|
157
|
-
return applyReadMask(doc, mask);
|
|
158
|
-
};
|
package/src/rbac/routes.test.ts
CHANGED
|
@@ -242,7 +242,7 @@ describe("rbacRouter role assignment against a partially resolved target", () =>
|
|
|
242
242
|
const access = createAccess({
|
|
243
243
|
connection: mongoose.connection,
|
|
244
244
|
// The signed-in actor may assign roles but does not hold user:delete.
|
|
245
|
-
resolvePermissions: async ({user}) =>
|
|
245
|
+
resolvePermissions: async ({user}): Promise<PermissionSet> =>
|
|
246
246
|
String(user.id) === target.id ? {} : {rbac: ["read", "assignRoles"]},
|
|
247
247
|
sources: [
|
|
248
248
|
{
|
|
@@ -3,11 +3,11 @@ import type express from "express";
|
|
|
3
3
|
import mongoose from "mongoose";
|
|
4
4
|
|
|
5
5
|
import {modelRouter} from "../api";
|
|
6
|
-
import {addAuthRoutes, setupAuth, type UserModel as UserMongooseModel} from "../auth";
|
|
6
|
+
import {addAuthRoutes, setupAuth, type User, type UserModel as UserMongooseModel} from "../auth";
|
|
7
7
|
import {apiErrorMiddleware, apiUnauthorizedMiddleware} from "../errors";
|
|
8
8
|
import {Permissions} from "../permissions";
|
|
9
9
|
import {executeCreate, executeDelete, executeUpdate} from "../sync/executors";
|
|
10
|
-
import {authAsUser, getBaseServer, setupDb,
|
|
10
|
+
import {authAsUser, getBaseServer, setupDb, UserModel} from "../tests";
|
|
11
11
|
import {createAccess} from "./access";
|
|
12
12
|
import {terrenoStatements} from "./statements";
|
|
13
13
|
import type {AnyTerrenoAccess} from "./types";
|
|
@@ -37,7 +37,7 @@ const buildAccess = async (): Promise<AnyTerrenoAccess> => {
|
|
|
37
37
|
return access as unknown as AnyTerrenoAccess;
|
|
38
38
|
};
|
|
39
39
|
|
|
40
|
-
const setRoles = async (userId:
|
|
40
|
+
const setRoles = async (userId: mongoose.Types.ObjectId, roles: string[]): Promise<void> => {
|
|
41
41
|
await UserModel.updateOne({_id: userId}, {$set: {roles}});
|
|
42
42
|
};
|
|
43
43
|
|
|
@@ -240,7 +240,10 @@ describe("RBAC target-privilege check over modelRouter HTTP", () => {
|
|
|
240
240
|
instanceActions: {
|
|
241
241
|
rename: {
|
|
242
242
|
handler: async ({doc}) => {
|
|
243
|
-
await UserModel.updateOne(
|
|
243
|
+
await UserModel.updateOne(
|
|
244
|
+
{_id: (doc as {_id: mongoose.Types.ObjectId})._id},
|
|
245
|
+
{name: "Action"}
|
|
246
|
+
);
|
|
244
247
|
return {ok: true};
|
|
245
248
|
},
|
|
246
249
|
method: "POST",
|
|
@@ -421,7 +424,7 @@ describe("user:updateIdentity over modelRouter HTTP", () => {
|
|
|
421
424
|
changeEmail: {
|
|
422
425
|
handler: async ({body, doc}) => {
|
|
423
426
|
await UserModel.updateOne(
|
|
424
|
-
{_id: (doc as {_id:
|
|
427
|
+
{_id: (doc as {_id: mongoose.Types.ObjectId})._id},
|
|
425
428
|
{email: (body as {email: string}).email}
|
|
426
429
|
);
|
|
427
430
|
return {ok: true};
|