@terreno/api 57.21.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 +43 -0
- package/README.md +1 -1
- package/biome.jsonc +2 -2
- package/dist/api.d.ts +0 -13
- 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/index.d.ts +4 -5
- package/dist/index.js +8 -20
- package/dist/mcp/adminTracking.js +1 -1
- 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/mcpRequestLog.js +1 -1
- package/dist/models/mcpServiceToken.js +36 -4
- package/dist/openApiBuilder.d.ts +4 -0
- package/dist/openApiBuilder.js +2 -0
- 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 +7 -5
- package/dist/terrenoApp.js +18 -14
- package/dist/tests/openApiResponseSchema.d.ts +39 -0
- package/dist/tests/openApiResponseSchema.js +56 -0
- package/dist/tests.d.ts +1 -0
- package/dist/tests.js +4 -1
- package/dist/types/mcpAdmin.d.ts +1 -1
- package/dist/types/mcpServiceToken.d.ts +7 -4
- package/dist/versionCheckPlugin.d.ts +1 -1
- package/dist/versionCheckPlugin.js +25 -2
- package/package.json +10 -6
- 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/api.test.ts +9 -7
- package/src/api.ts +0 -24
- package/src/auth.ts +116 -5
- package/src/authOpenApi.test.ts +316 -0
- package/src/authRecovery.ts +47 -19
- package/src/betterAuthOAuthHandoff.test.ts +13 -5
- package/src/collectionRegistry.ts +3 -5
- package/src/consentApp.test.ts +98 -0
- package/src/consentApp.ts +67 -2
- package/src/index.ts +6 -28
- package/src/mcp/actionTools.test.ts +2 -2
- package/src/mcp/adminTracking.ts +1 -1
- package/src/mcp/auth.test.ts +7 -3
- package/src/mcp/oauth.test.ts +12 -12
- package/src/mcp/serviceTokens.sync.test.ts +230 -0
- package/src/mcp/serviceTokens.test.ts +112 -61
- package/src/mcp/serviceTokens.ts +193 -212
- package/src/migrations/builtin/mcpServiceTokenStringIds.test.ts +194 -0
- package/src/migrations/builtin/mcpServiceTokenStringIds.ts +121 -0
- package/src/models/mcpRequestLog.ts +1 -1
- package/src/models/mcpServiceToken.test.ts +52 -5
- package/src/models/mcpServiceToken.ts +51 -14
- package/src/openApiBuilder.test.ts +34 -1
- package/src/openApiBuilder.ts +5 -0
- package/src/rateLimit/rateLimit.test.ts +25 -10
- package/src/rbac/realtimeAccess.test.ts +20 -172
- package/src/rbac/realtimeAccess.ts +17 -82
- package/src/realtime/changeStreamWatcher.ts +43 -506
- package/src/realtime/realtime.test.ts +205 -2545
- package/src/realtime/realtimeApp.ts +16 -295
- package/src/realtime/types.ts +0 -72
- package/src/sync/executors.test.ts +28 -0
- package/src/sync/executors.ts +23 -2
- package/src/sync/socketHandlers.ts +1 -1
- package/src/sync/syncSocket.test.ts +77 -113
- package/src/terrenoApp.mcpServiceTokens.test.ts +14 -6
- package/src/terrenoApp.ts +24 -18
- package/src/tests/openApiResponseSchema.ts +104 -0
- package/src/tests.ts +7 -0
- package/src/types/mcpAdmin.ts +1 -1
- package/src/types/mcpServiceToken.ts +7 -4
- package/src/versionCheckPlugin.ts +41 -2
- 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
|
@@ -8,11 +8,19 @@ const node_crypto_1 = require("node:crypto");
|
|
|
8
8
|
const luxon_1 = require("luxon");
|
|
9
9
|
const mongoose_1 = __importDefault(require("mongoose"));
|
|
10
10
|
const plugins_1 = require("../plugins");
|
|
11
|
+
const syncSeqPlugin_1 = require("../sync/syncSeqPlugin");
|
|
11
12
|
exports.MCP_SERVICE_TOKEN_PREFIX = "mcp_";
|
|
12
13
|
const MCP_SERVICE_TOKEN_RANDOM_BYTES = 32;
|
|
13
14
|
const MCP_SERVICE_TOKEN_DISPLAY_LENGTH = 8;
|
|
14
15
|
const hashToken = (token) => (0, node_crypto_1.createHash)("sha256").update(token).digest("hex");
|
|
15
16
|
const mcpServiceTokenSchema = new mongoose_1.default.Schema({
|
|
17
|
+
_id: {
|
|
18
|
+
// Synced collections use String ids. New rows get a UUID; rows created before
|
|
19
|
+
// Terreno 58 keep their ObjectId hex after the mcp-service-token-string-ids migration.
|
|
20
|
+
default: () => (0, node_crypto_1.randomUUID)(),
|
|
21
|
+
description: "The MCP service token id (String so the synced collection can address it)",
|
|
22
|
+
type: String,
|
|
23
|
+
},
|
|
16
24
|
expiresAt: {
|
|
17
25
|
description: "When this MCP service token expires; unset when it does not expire",
|
|
18
26
|
type: Date,
|
|
@@ -57,8 +65,23 @@ const mcpServiceTokenSchema = new mongoose_1.default.Schema({
|
|
|
57
65
|
mcpServiceTokenSchema.index({ expiresAt: 1 }, { expireAfterSeconds: 0 });
|
|
58
66
|
mcpServiceTokenSchema.index({ revokedAt: 1, userId: 1 });
|
|
59
67
|
mcpServiceTokenSchema.plugin(plugins_1.createdUpdatedPlugin);
|
|
68
|
+
mcpServiceTokenSchema.plugin(plugins_1.isDeletedPlugin);
|
|
60
69
|
mcpServiceTokenSchema.plugin(plugins_1.findOneOrNone);
|
|
61
70
|
mcpServiceTokenSchema.plugin(plugins_1.findExactlyOne);
|
|
71
|
+
// Deleting a token means revoking it: the row stays visible to its owner (and the audit
|
|
72
|
+
// trail) with `revokedAt` set. A soft delete (admin DELETE through modelRouter sets
|
|
73
|
+
// `deleted: true`) is turned into a revoke so it never tombstones the owner's synced row.
|
|
74
|
+
mcpServiceTokenSchema.pre("save", function () {
|
|
75
|
+
if (!this.isModified("deleted") || this.deleted !== true) {
|
|
76
|
+
return;
|
|
77
|
+
}
|
|
78
|
+
this.deleted = false;
|
|
79
|
+
if (!this.revokedAt) {
|
|
80
|
+
this.revokedAt = luxon_1.DateTime.now().toJSDate();
|
|
81
|
+
}
|
|
82
|
+
});
|
|
83
|
+
// Stamps a per-stream _syncSeq on every write; required by the /mcp/service-tokens sync config.
|
|
84
|
+
mcpServiceTokenSchema.plugin(syncSeqPlugin_1.syncPlugin);
|
|
62
85
|
const revokeInsteadOfDelete = async (doc) => {
|
|
63
86
|
if (!doc) {
|
|
64
87
|
return null;
|
|
@@ -76,6 +99,9 @@ mcpServiceTokenSchema.methods = {
|
|
|
76
99
|
return revoked ?? this;
|
|
77
100
|
},
|
|
78
101
|
};
|
|
102
|
+
// Query deleteOne revokes instead of removing the row. Registered after syncPlugin so that,
|
|
103
|
+
// once the collection is synced, syncPlugin's hard-delete guard rejects the call before any
|
|
104
|
+
// write happens.
|
|
79
105
|
mcpServiceTokenSchema.pre("deleteOne", { document: false, query: true }, async function () {
|
|
80
106
|
const existing = await (0, plugins_1.findOneOrNoneFor)(this.model, this.getFilter());
|
|
81
107
|
await revokeInsteadOfDelete(existing);
|
|
@@ -109,7 +135,7 @@ mcpServiceTokenSchema.statics = {
|
|
|
109
135
|
},
|
|
110
136
|
async revokeForUser(user, tokenId) {
|
|
111
137
|
return this.findOneAndUpdate({
|
|
112
|
-
_id: tokenId,
|
|
138
|
+
_id: String(tokenId),
|
|
113
139
|
revokedAt: { $exists: false },
|
|
114
140
|
userId: new mongoose_1.default.Types.ObjectId(String(user._id)),
|
|
115
141
|
}, { $set: { revokedAt: luxon_1.DateTime.now().toJSDate() } }, { returnDocument: "after" });
|
|
@@ -120,11 +146,17 @@ mcpServiceTokenSchema.statics = {
|
|
|
120
146
|
*/
|
|
121
147
|
async revokeOutdatedForUser(user) {
|
|
122
148
|
const currentEpoch = user.tokenEpoch ?? 0;
|
|
123
|
-
|
|
149
|
+
const userId = new mongoose_1.default.Types.ObjectId(String(user._id));
|
|
150
|
+
const outdated = await this.find({
|
|
124
151
|
revokedAt: { $exists: false },
|
|
125
152
|
tokenEpoch: { $nin: currentEpoch === 0 ? [0, null] : [currentEpoch] },
|
|
126
|
-
userId
|
|
127
|
-
}
|
|
153
|
+
userId,
|
|
154
|
+
});
|
|
155
|
+
const revokedAt = luxon_1.DateTime.now().toJSDate();
|
|
156
|
+
for (const token of outdated) {
|
|
157
|
+
token.revokedAt = revokedAt;
|
|
158
|
+
await token.save();
|
|
159
|
+
}
|
|
128
160
|
},
|
|
129
161
|
async verify(token) {
|
|
130
162
|
const now = luxon_1.DateTime.now().toJSDate();
|
package/dist/openApiBuilder.d.ts
CHANGED
|
@@ -80,6 +80,8 @@ export interface OpenApiSchemaProperty {
|
|
|
80
80
|
items?: OpenApiSchemaProperty;
|
|
81
81
|
/** Minimum array length when type is "array". */
|
|
82
82
|
minItems?: number;
|
|
83
|
+
/** OpenAPI 3.0 flag: the value may also be `null`. */
|
|
84
|
+
nullable?: boolean;
|
|
83
85
|
/** Nested properties when type is "object" */
|
|
84
86
|
properties?: Record<string, OpenApiSchemaProperty>;
|
|
85
87
|
/** Schema for additional properties or boolean to allow/disallow them */
|
|
@@ -355,6 +357,7 @@ export declare class OpenApiMiddlewareBuilder {
|
|
|
355
357
|
* @param options - Optional configuration for the response
|
|
356
358
|
* @param options.description - Description of the response (default: "Success")
|
|
357
359
|
* @param options.mediaType - Media type for the response (default: "application/json")
|
|
360
|
+
* @param options.required - Top-level property names that are always present (e.g. `["data"]`)
|
|
358
361
|
* @returns The builder instance for chaining
|
|
359
362
|
*
|
|
360
363
|
* @example
|
|
@@ -373,6 +376,7 @@ export declare class OpenApiMiddlewareBuilder {
|
|
|
373
376
|
} | string, options?: {
|
|
374
377
|
description?: string;
|
|
375
378
|
mediaType?: string;
|
|
379
|
+
required?: string[];
|
|
376
380
|
}): this;
|
|
377
381
|
/**
|
|
378
382
|
* Adds an array response definition to the OpenAPI operation.
|
package/dist/openApiBuilder.js
CHANGED
|
@@ -227,6 +227,7 @@ class OpenApiMiddlewareBuilder {
|
|
|
227
227
|
* @param options - Optional configuration for the response
|
|
228
228
|
* @param options.description - Description of the response (default: "Success")
|
|
229
229
|
* @param options.mediaType - Media type for the response (default: "application/json")
|
|
230
|
+
* @param options.required - Top-level property names that are always present (e.g. `["data"]`)
|
|
230
231
|
* @returns The builder instance for chaining
|
|
231
232
|
*
|
|
232
233
|
* @example
|
|
@@ -252,6 +253,7 @@ class OpenApiMiddlewareBuilder {
|
|
|
252
253
|
[options?.mediaType ?? "application/json"]: {
|
|
253
254
|
schema: {
|
|
254
255
|
properties: schema,
|
|
256
|
+
...(options?.required?.length ? { required: options.required } : {}),
|
|
255
257
|
type: "object",
|
|
256
258
|
},
|
|
257
259
|
},
|
|
@@ -1,4 +1,3 @@
|
|
|
1
|
-
import type { RESTMethod } from "../api";
|
|
2
1
|
import type { User } from "../auth";
|
|
3
2
|
import { type PermissionMethod } from "../permissions";
|
|
4
3
|
import type { AnyTerrenoAccess, ModelRouterAccessOptions } from "./types";
|
|
@@ -8,11 +7,13 @@ interface RealtimeAccessEntry {
|
|
|
8
7
|
accessControl?: AnyTerrenoAccess;
|
|
9
8
|
permissions?: {
|
|
10
9
|
read?: PermissionMethod<unknown>[];
|
|
11
|
-
list?: PermissionMethod<unknown>[];
|
|
12
10
|
};
|
|
13
11
|
};
|
|
14
12
|
}
|
|
15
|
-
|
|
13
|
+
/**
|
|
14
|
+
* Socket-side read check for one document, used before emitting `sync:delta` to each
|
|
15
|
+
* socket in a sync stream room. Uses RBAC (`access` + `accessControl`, including
|
|
16
|
+
* `access.scope.check`) when configured, else the router's `permissions.read`.
|
|
17
|
+
*/
|
|
16
18
|
export declare const canReadDocumentRealtime: (entry: RealtimeAccessEntry, user?: User, doc?: Record<string, unknown>) => Promise<boolean>;
|
|
17
|
-
export declare const maskRealtimeDocument: (entry: RealtimeAccessEntry, user: User | undefined, doc: unknown, _method: RESTMethod) => Promise<unknown>;
|
|
18
19
|
export {};
|
|
@@ -1,31 +1,11 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.
|
|
3
|
+
exports.canReadDocumentRealtime = void 0;
|
|
4
4
|
const permissions_1 = require("../permissions");
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
};
|
|
10
|
-
const resolveActionForMethod = (method, access, statements) => {
|
|
11
|
-
const override = access.actions?.[method];
|
|
12
|
-
if (override === null) {
|
|
13
|
-
return null;
|
|
14
|
-
}
|
|
15
|
-
if (override) {
|
|
16
|
-
return override;
|
|
17
|
-
}
|
|
18
|
-
const resourceActions = statements[access.resource] ?? [];
|
|
19
|
-
if (method === "list" && resourceActions.includes("list")) {
|
|
20
|
-
return "list";
|
|
21
|
-
}
|
|
22
|
-
if (method === "list") {
|
|
23
|
-
return "read";
|
|
24
|
-
}
|
|
25
|
-
return DEFAULT_METHOD_ACTIONS[method];
|
|
26
|
-
};
|
|
27
|
-
// REST and snapshot permissions append access.also[method] to the RBAC role and scope checks
|
|
28
|
-
// (buildAccessPermissions), so realtime decisions must apply them too.
|
|
5
|
+
/**
|
|
6
|
+
* REST `access.also[method]` still applies to socket document reads. An empty list allows
|
|
7
|
+
* the read; any listed permission must pass.
|
|
8
|
+
*/
|
|
29
9
|
const checkAlsoPermissions = async (access, method, user, doc) => {
|
|
30
10
|
const also = access.also?.[method] ?? [];
|
|
31
11
|
if (also.length === 0) {
|
|
@@ -33,35 +13,24 @@ const checkAlsoPermissions = async (access, method, user, doc) => {
|
|
|
33
13
|
}
|
|
34
14
|
return (0, permissions_1.checkPermissions)(method, also, user, doc);
|
|
35
15
|
};
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
const
|
|
39
|
-
if (
|
|
40
|
-
|
|
41
|
-
const action = resolveActionForMethod(method, access, statements);
|
|
42
|
-
if (!action) {
|
|
43
|
-
return false;
|
|
44
|
-
}
|
|
45
|
-
const result = await accessControl.can({
|
|
46
|
-
context: { transport: "socket" },
|
|
47
|
-
permissions: { [access.resource]: [action] },
|
|
48
|
-
user,
|
|
49
|
-
});
|
|
50
|
-
if (!result.allowed) {
|
|
51
|
-
return false;
|
|
52
|
-
}
|
|
53
|
-
return checkAlsoPermissions(access, method, user);
|
|
16
|
+
/** The RBAC action for socket document reads: the router's `read` override, else `read`. */
|
|
17
|
+
const resolveReadAction = (access) => {
|
|
18
|
+
const override = access.actions?.read;
|
|
19
|
+
if (override === null) {
|
|
20
|
+
return null;
|
|
54
21
|
}
|
|
55
|
-
|
|
56
|
-
return (0, permissions_1.checkPermissions)(method, permissions, user);
|
|
22
|
+
return override ?? "read";
|
|
57
23
|
};
|
|
58
|
-
|
|
24
|
+
/**
|
|
25
|
+
* Socket-side read check for one document, used before emitting `sync:delta` to each
|
|
26
|
+
* socket in a sync stream room. Uses RBAC (`access` + `accessControl`, including
|
|
27
|
+
* `access.scope.check`) when configured, else the router's `permissions.read`.
|
|
28
|
+
*/
|
|
59
29
|
const canReadDocumentRealtime = async (entry, user, doc) => {
|
|
60
30
|
const access = entry.options.access;
|
|
61
31
|
const accessControl = entry.options.accessControl;
|
|
62
32
|
if (access && accessControl) {
|
|
63
|
-
const
|
|
64
|
-
const action = resolveActionForMethod("read", access, statements);
|
|
33
|
+
const action = resolveReadAction(access);
|
|
65
34
|
if (!action) {
|
|
66
35
|
return false;
|
|
67
36
|
}
|
|
@@ -103,19 +72,3 @@ const canReadDocumentRealtime = async (entry, user, doc) => {
|
|
|
103
72
|
return (0, permissions_1.checkPermissions)("read", entry.options.permissions?.read ?? [], user, doc);
|
|
104
73
|
};
|
|
105
74
|
exports.canReadDocumentRealtime = canReadDocumentRealtime;
|
|
106
|
-
const maskRealtimeDocument = async (entry, user, doc, _method) => {
|
|
107
|
-
const access = entry.options.access;
|
|
108
|
-
const accessControl = entry.options.accessControl;
|
|
109
|
-
if (!access || !accessControl) {
|
|
110
|
-
return doc;
|
|
111
|
-
}
|
|
112
|
-
const phase = "read";
|
|
113
|
-
const mask = await accessControl.fieldMask({
|
|
114
|
-
doc,
|
|
115
|
-
phase,
|
|
116
|
-
resource: access.resource,
|
|
117
|
-
user,
|
|
118
|
-
});
|
|
119
|
-
return (0, fieldViews_1.applyReadMask)(doc, mask);
|
|
120
|
-
};
|
|
121
|
-
exports.maskRealtimeDocument = maskRealtimeDocument;
|
|
@@ -3,8 +3,7 @@ import type { Server } from "socket.io";
|
|
|
3
3
|
import type { User } from "../auth";
|
|
4
4
|
import type { PermissionMethod } from "../permissions";
|
|
5
5
|
import { type SyncRegistryEntry } from "../sync/registry";
|
|
6
|
-
import {
|
|
7
|
-
import type { ChangeStreamConfig, RealtimeEvent } from "./types";
|
|
6
|
+
import type { ChangeStreamConfig } from "./types";
|
|
8
7
|
/**
|
|
9
8
|
* The subset of ChangeStreamDocument variants this watcher actually processes.
|
|
10
9
|
* The pipeline filters for ["insert", "update", "replace", "delete"], so we never
|
|
@@ -31,20 +30,15 @@ export declare const DEFAULT_IGNORED_COLLECTIONS: string[];
|
|
|
31
30
|
/**
|
|
32
31
|
* Map MongoDB change stream operation types to our method names.
|
|
33
32
|
*
|
|
34
|
-
* Soft deletes (an `update` that sets `deleted: true`) are reclassified as
|
|
35
|
-
* `"delete"` only when the model has `"delete"` enabled in its realtime
|
|
36
|
-
* methods. Otherwise they fall back to `"update"` so models that subscribe
|
|
37
|
-
* to updates (but not deletes) still see the change — without this fallback,
|
|
38
|
-
* a model configured with `methods: ["create", "update"]` would silently
|
|
39
|
-
* drop soft-delete events.
|
|
33
|
+
* Soft deletes (an `update` that sets `deleted: true`) are reclassified as `"delete"`.
|
|
40
34
|
*
|
|
41
35
|
* Exported for testing.
|
|
42
36
|
*/
|
|
43
37
|
/** @internal */
|
|
44
|
-
export declare const mapOperationType: (operationType: string, change: ChangeStreamDocument
|
|
38
|
+
export declare const mapOperationType: (operationType: string, change: ChangeStreamDocument) => "create" | "update" | "delete" | null;
|
|
45
39
|
/**
|
|
46
|
-
* The minimal registry-entry shape the authorized-room
|
|
47
|
-
* `
|
|
40
|
+
* The minimal registry-entry shape the authorized-room emitter needs.
|
|
41
|
+
* `SyncRegistryEntry` satisfies it structurally.
|
|
48
42
|
*/
|
|
49
43
|
export interface AuthorizedEmitEntry {
|
|
50
44
|
collectionTag?: string;
|
|
@@ -56,43 +50,18 @@ export interface AuthorizedEmitEntry {
|
|
|
56
50
|
};
|
|
57
51
|
routePath?: string;
|
|
58
52
|
}
|
|
59
|
-
/**
|
|
60
|
-
* Determine which Socket.io rooms to emit to based on the room strategy.
|
|
61
|
-
* Exported for testing.
|
|
62
|
-
*/
|
|
63
|
-
/** @internal */
|
|
64
|
-
export declare const resolveRooms: (entry: RealtimeRegistryEntry, doc: Record<string, unknown>, method: string) => string[];
|
|
65
53
|
/**
|
|
66
54
|
* Ensure serialized documents include `id` to match REST API responses.
|
|
67
55
|
* Change stream fullDocument payloads are raw BSON objects with `_id` only.
|
|
68
56
|
*/
|
|
69
57
|
/** @internal */
|
|
70
58
|
export declare const ensureApiId: (data: unknown) => unknown;
|
|
71
|
-
/**
|
|
72
|
-
* Serialize a document for emission.
|
|
73
|
-
*
|
|
74
|
-
* Precedence:
|
|
75
|
-
* 1. `realtimeResponseHandler` if provided (full control over what's emitted).
|
|
76
|
-
* 2. modelRouter `responseHandler` if provided — invoked with a synthetic request
|
|
77
|
-
* so the same stripping logic used for REST responses (e.g. removing `hash`/`salt`)
|
|
78
|
-
* applies to realtime events. This prevents accidental leaks when an app only
|
|
79
|
-
* configures sanitization in the REST `responseHandler`.
|
|
80
|
-
* 3. `toJSON()` fallback.
|
|
81
|
-
*
|
|
82
|
-
* If a user-supplied handler throws, we re-throw so the caller's outer try/catch
|
|
83
|
-
* records the failure and the event is dropped. Falling back to `toJSON()` here
|
|
84
|
-
* would risk leaking unsanitized fields (e.g. `hash`/`salt`) that the handler
|
|
85
|
-
* was supposed to strip.
|
|
86
|
-
*/
|
|
87
|
-
/** @internal */
|
|
88
|
-
export declare const serializeDoc: (entry: RealtimeRegistryEntry, doc: Record<string, unknown>, method: "create" | "update" | "delete", user?: User) => Promise<unknown>;
|
|
89
59
|
/**
|
|
90
60
|
* Generalized authorized-room emitter: iterates the sockets in `room`, runs the per-socket
|
|
91
61
|
* read-permission check against `fullDocument`, builds the payload per socket (so
|
|
92
62
|
* responseHandlers can tailor output to the receiving user), and emits `eventName`.
|
|
93
63
|
*
|
|
94
|
-
*
|
|
95
|
-
* emission both delegate here.
|
|
64
|
+
* The sync layer's `sync:delta` emission delegates here.
|
|
96
65
|
*/
|
|
97
66
|
export declare const emitPayloadToAuthorizedRoom: ({ io, room, eventName, entry, fullDocument, buildPayload, logDebug, }: {
|
|
98
67
|
io: Server;
|
|
@@ -107,32 +76,11 @@ export declare const emitPayloadToAuthorizedRoom: ({ io, room, eventName, entry,
|
|
|
107
76
|
buildPayload: (user: User | undefined) => Promise<unknown> | unknown;
|
|
108
77
|
logDebug: (msg: string) => void;
|
|
109
78
|
}) => Promise<void>;
|
|
110
|
-
/** @internal */
|
|
111
|
-
export declare const emitToAuthorizedRoom: (io: Server, room: string, event: RealtimeEvent, entry: RealtimeRegistryEntry, fullDocument: Record<string, unknown> | undefined, logDebug: (msg: string) => void) => Promise<void>;
|
|
112
|
-
/**
|
|
113
|
-
* Emit a sync event to document-specific and query rooms.
|
|
114
|
-
*
|
|
115
|
-
* Document rooms: `document:{collection}:{docId}` — clients subscribed to a single document.
|
|
116
|
-
* Query rooms: `query:{queryId}` — clients subscribed to a query filter. The change stream
|
|
117
|
-
* watcher evaluates whether the document matches each active query for the collection.
|
|
118
|
-
*
|
|
119
|
-
* For deletes, we are careful not to leak cross-user activity:
|
|
120
|
-
* - Soft deletes (fullDocument present) are matched against each query like updates so
|
|
121
|
-
* query subscribers only see deletes for docs that matched their filter.
|
|
122
|
-
* - Hard deletes (fullDocument absent) on owner-strategy collections are NOT forwarded
|
|
123
|
-
* to query rooms — subscribers will reconcile on their next fetch. Other strategies
|
|
124
|
-
* forward the delete because the model/broadcast rooms are not user-scoped.
|
|
125
|
-
*
|
|
126
|
-
* Exported for testing.
|
|
127
|
-
*/
|
|
128
|
-
/** @internal */
|
|
129
|
-
export declare const emitToDocumentAndQueryRooms: (io: Server, collection: string, event: RealtimeEvent, fullDocument: Record<string, unknown> | undefined, logDebug: (msg: string) => void, entry?: RealtimeRegistryEntry) => Promise<void>;
|
|
130
79
|
/**
|
|
131
80
|
* Emit `sync:delta` events for a change on a sync-registered collection.
|
|
132
81
|
*
|
|
133
82
|
* Deltas fan out to the dedicated `sync:{stream}` rooms joined via `sync:subscribe`
|
|
134
|
-
*
|
|
135
|
-
* checks as legacy events. `seq` and `stream` come from the post-image: the `syncPlugin`
|
|
83
|
+
* with per-socket read-permission checks. `seq` and `stream` come from the post-image: the `syncPlugin`
|
|
136
84
|
* stamps `_syncSeq` on every synced write and the watcher runs `updateLookup`.
|
|
137
85
|
*
|
|
138
86
|
* Soft deletes (an update setting `deleted: true`, reclassified by `mapOperationType`)
|
|
@@ -151,9 +99,6 @@ export declare const emitToDocumentAndQueryRooms: (io: Server, collection: strin
|
|
|
151
99
|
* emit time, C1); the client advances its cursor to `min(delta.seq, delta.frontierSeq)`
|
|
152
100
|
* so a delta observed out of commit order never advances a cursor past an uncommitted hole.
|
|
153
101
|
*
|
|
154
|
-
* A model with both `realtime` and `sync` configs emits both the legacy "sync" event and
|
|
155
|
-
* "sync:delta" — distinct event names, no interference (documented as transitional).
|
|
156
|
-
*
|
|
157
102
|
* Exported for testing.
|
|
158
103
|
*/
|
|
159
104
|
export declare const emitSyncDeltaForChange: ({ io, entry, change, docId, logDebug, }: {
|
|
@@ -164,7 +109,7 @@ export declare const emitSyncDeltaForChange: ({ io, entry, change, docId, logDeb
|
|
|
164
109
|
logDebug: (msg: string) => void;
|
|
165
110
|
}) => Promise<void>;
|
|
166
111
|
/**
|
|
167
|
-
* Start watching MongoDB change streams and emitting
|
|
112
|
+
* Start watching MongoDB change streams and emitting `sync:delta` events.
|
|
168
113
|
*
|
|
169
114
|
* Task 9.16: the stream is supervised — an `error`/`close`/`end` schedules a re-open with
|
|
170
115
|
* exponential backoff, resuming from the last seen token. Call
|