@terreno/api 57.1.0 → 57.3.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/README.md +17 -7
- package/dist/actions.js +19 -7
- package/dist/adminTypes.d.ts +26 -0
- package/dist/api.d.ts +4 -0
- package/dist/api.js +12 -24
- package/dist/auth.d.ts +23 -10
- package/dist/auth.js +97 -32
- package/dist/authRecovery.d.ts +5 -0
- package/dist/authRecovery.js +350 -0
- package/dist/authTokens.d.ts +8 -0
- package/dist/authTokens.js +162 -0
- package/dist/betterAuth.d.ts +33 -0
- package/dist/betterAuthApp.d.ts +4 -0
- package/dist/betterAuthApp.js +26 -8
- package/dist/betterAuthSetup.d.ts +44 -2
- package/dist/betterAuthSetup.js +288 -18
- package/dist/collectionRegistry.d.ts +38 -0
- package/dist/collectionRegistry.js +72 -0
- package/dist/configurationApp.d.ts +11 -2
- package/dist/configurationApp.js +2 -4
- package/dist/docLoader.js +35 -6
- package/dist/expressServer.d.ts +26 -3
- package/dist/expressServer.js +79 -11
- package/dist/index.d.ts +16 -0
- package/dist/index.js +38 -2
- package/dist/mcp/auth.d.ts +1 -0
- package/dist/mcp/auth.js +47 -25
- package/dist/mcp/handlers.d.ts +1 -1
- package/dist/mcp/handlers.js +67 -233
- package/dist/mcp/query.d.ts +2 -2
- package/dist/mcp/registry.d.ts +1 -5
- package/dist/mcp/registry.js +31 -20
- package/dist/mcp/schemaGenerator.d.ts +2 -7
- package/dist/mcp/schemaGenerator.js +41 -116
- package/dist/mcp/server.d.ts +1 -0
- package/dist/mcp/server.js +1 -0
- package/dist/mcp/serviceTokens.d.ts +16 -0
- package/dist/mcp/serviceTokens.js +345 -0
- package/dist/mcp/types.d.ts +2 -2
- package/dist/models/mcpServiceToken.d.ts +3 -0
- package/dist/models/mcpServiceToken.js +208 -0
- package/dist/openApiBuilder.d.ts +5 -4
- package/dist/openApiBuilder.js +61 -8
- package/dist/openApiCompat.js +1 -1
- package/dist/openApiValidator.js +0 -2
- package/dist/plugins.d.ts +14 -1
- package/dist/plugins.js +17 -6
- package/dist/populate.d.ts +2 -2
- package/dist/populate.js +47 -42
- package/dist/rateLimit/applyTrustProxy.d.ts +3 -0
- package/dist/rateLimit/applyTrustProxy.js +17 -0
- package/dist/rateLimit/createStore.d.ts +2 -0
- package/dist/rateLimit/createStore.js +28 -0
- package/dist/rateLimit/memoryStore.d.ts +2 -0
- package/dist/rateLimit/memoryStore.js +108 -0
- package/dist/rateLimit/middleware.d.ts +11 -0
- package/dist/rateLimit/middleware.js +110 -0
- package/dist/rateLimit/mongoStore.d.ts +3 -0
- package/dist/rateLimit/mongoStore.js +122 -0
- package/dist/rateLimit/policies.d.ts +14 -0
- package/dist/rateLimit/policies.js +151 -0
- package/dist/rateLimit/redisStore.d.ts +3 -0
- package/dist/rateLimit/redisStore.js +155 -0
- package/dist/rateLimit/types.d.ts +54 -0
- package/dist/rateLimit/types.js +9 -0
- package/dist/rbac/access.js +5 -1
- package/dist/rbac/assertAllowed.d.ts +9 -0
- package/dist/rbac/assertAllowed.js +182 -0
- package/dist/rbac/modelRouterAccess.d.ts +1 -0
- package/dist/rbac/modelRouterAccess.js +8 -4
- package/dist/rbac/permissionUtils.js +3 -2
- package/dist/rbac/resolve.js +5 -4
- package/dist/rbac/routes.js +15 -6
- package/dist/rbac/statements.d.ts +10 -0
- package/dist/rbac/statements.js +13 -2
- package/dist/realtime/deprecation.d.ts +12 -0
- package/dist/realtime/deprecation.js +32 -0
- package/dist/realtime/realtimeApp.d.ts +1 -1
- package/dist/realtime/realtimeApp.js +10 -11
- package/dist/realtime/registry.d.ts +0 -31
- package/dist/realtime/registry.js +44 -31
- package/dist/realtime/socketAuth.d.ts +5 -5
- package/dist/realtime/socketAuth.js +11 -1
- package/dist/realtime/socketUser.d.ts +5 -1
- package/dist/realtime/types.d.ts +14 -4
- package/dist/schemaMetadata.d.ts +56 -0
- package/dist/schemaMetadata.js +513 -0
- package/dist/seedRunner.d.ts +88 -0
- package/dist/seedRunner.js +627 -0
- package/dist/sync/executors.d.ts +12 -2
- package/dist/sync/executors.js +8 -10
- package/dist/sync/loadHarness.js +28 -19
- package/dist/sync/models.js +26 -24
- package/dist/sync/mutationHandler.d.ts +9 -0
- package/dist/sync/mutationHandler.js +11 -6
- package/dist/sync/registrationSideEffects.d.ts +35 -0
- package/dist/sync/registrationSideEffects.js +151 -0
- package/dist/sync/registry.d.ts +2 -52
- package/dist/sync/registry.js +38 -187
- package/dist/sync/routes.js +3 -2
- package/dist/sync/scripts/compactTombstones.js +0 -2
- package/dist/sync/syncApp.d.ts +3 -3
- package/dist/sync/syncApp.js +4 -4
- package/dist/sync/syncBatch.js +3 -2
- package/dist/sync/syncSeqPlugin.d.ts +1 -1
- package/dist/sync/syncSeqPlugin.js +20 -16
- package/dist/terrenoApp.d.ts +19 -5
- package/dist/terrenoApp.js +66 -18
- package/dist/tests/models.d.ts +2 -0
- package/dist/tests/models.js +6 -0
- package/dist/types/authToken.d.ts +33 -0
- package/dist/types/authToken.js +2 -0
- package/dist/types/mcpServiceToken.d.ts +41 -0
- package/dist/types/mcpServiceToken.js +2 -0
- package/dist/webhooks/headerValue.d.ts +2 -0
- package/dist/webhooks/headerValue.js +14 -0
- package/dist/webhooks/idempotency/memoryStore.d.ts +10 -0
- package/dist/webhooks/idempotency/memoryStore.js +65 -0
- package/dist/webhooks/idempotency/mongoStore.d.ts +4 -0
- package/dist/webhooks/idempotency/mongoStore.js +150 -0
- package/dist/webhooks/idempotency/webhookReceipt.d.ts +62 -0
- package/dist/webhooks/idempotency/webhookReceipt.js +39 -0
- package/dist/webhooks/rawBody.d.ts +14 -0
- package/dist/webhooks/rawBody.js +22 -0
- package/dist/webhooks/timingSafeEqual.d.ts +4 -0
- package/dist/webhooks/timingSafeEqual.js +17 -0
- package/dist/webhooks/verifiers/hmac.d.ts +15 -0
- package/dist/webhooks/verifiers/hmac.js +49 -0
- package/dist/webhooks/verifiers/sendgrid.d.ts +10 -0
- package/dist/webhooks/verifiers/sendgrid.js +56 -0
- package/dist/webhooks/verifiers/stripe.d.ts +9 -0
- package/dist/webhooks/verifiers/stripe.js +99 -0
- package/dist/webhooks/verifiers/twilio.d.ts +9 -0
- package/dist/webhooks/verifiers/twilio.js +112 -0
- package/dist/webhooks/webhooksApp.d.ts +33 -0
- package/dist/webhooks/webhooksApp.js +195 -0
- package/package.json +5 -6
- package/src/__snapshots__/openApi.test.ts.snap +270 -0
- package/src/__snapshots__/openApiBuilder.test.ts.snap +30 -12
- package/src/__snapshots__/schemaMetadata.test.ts.snap +197 -0
- package/src/actions.ts +20 -13
- package/src/adminModelRouter.test.ts +133 -0
- package/src/adminTypes.ts +23 -0
- package/src/api.arrayOperations.test.ts +43 -31
- package/src/api.hooks.test.ts +38 -29
- package/src/api.query.test.ts +31 -31
- package/src/api.test.ts +95 -96
- package/src/api.ts +16 -27
- package/src/auth.test.ts +107 -51
- package/src/auth.ts +98 -29
- package/src/authRecovery.test.ts +281 -0
- package/src/authRecovery.ts +279 -0
- package/src/authTokens.test.ts +94 -0
- package/src/authTokens.ts +118 -0
- package/src/authVerification.test.ts +293 -0
- package/src/betterAuth.ts +24 -0
- package/src/betterAuthApp.test.ts +1 -0
- package/src/betterAuthApp.ts +27 -9
- package/src/betterAuthSetup.test.ts +568 -38
- package/src/betterAuthSetup.ts +260 -5
- package/src/collectionRegistry.test.ts +165 -0
- package/src/collectionRegistry.ts +115 -0
- package/src/configurationApp.ts +13 -7
- package/src/docLoader.test.ts +45 -1
- package/src/docLoader.ts +37 -6
- package/src/express.d.ts +1 -0
- package/src/expressServer.test.ts +130 -66
- package/src/expressServer.ts +75 -19
- package/src/githubAuth.test.ts +60 -55
- package/src/index.ts +58 -0
- package/src/mcp/auth.test.ts +47 -0
- package/src/mcp/auth.ts +32 -11
- package/src/mcp/handlers.ts +45 -172
- package/src/mcp/integration.test.ts +59 -9
- package/src/mcp/query.ts +2 -4
- package/src/mcp/registry.ts +29 -20
- package/src/mcp/schemaGenerator.test.ts +8 -0
- package/src/mcp/schemaGenerator.ts +49 -131
- package/src/mcp/server.ts +2 -0
- package/src/mcp/serviceTokens.test.ts +330 -0
- package/src/mcp/serviceTokens.ts +307 -0
- package/src/mcp/toolGenerator.test.ts +1 -1
- package/src/mcp/types.ts +2 -6
- package/src/models/mcpServiceToken.test.ts +129 -0
- package/src/models/mcpServiceToken.ts +158 -0
- package/src/openApi.test.ts +80 -64
- package/src/openApiBuilder.test.ts +95 -7
- package/src/openApiBuilder.ts +46 -9
- package/src/openApiCompat.ts +1 -1
- package/src/openApiValidator.test.ts +49 -54
- package/src/openApiValidator.ts +1 -3
- package/src/plugins.test.ts +14 -0
- package/src/plugins.ts +34 -9
- package/src/populate.test.ts +34 -0
- package/src/populate.ts +40 -29
- package/src/rateLimit/applyTrustProxy.ts +17 -0
- package/src/rateLimit/createStore.ts +25 -0
- package/src/rateLimit/memoryStore.ts +40 -0
- package/src/rateLimit/middleware.ts +79 -0
- package/src/rateLimit/mongoStore.test.ts +80 -0
- package/src/rateLimit/mongoStore.ts +76 -0
- package/src/rateLimit/policies.ts +130 -0
- package/src/rateLimit/rateLimit.test.ts +328 -0
- package/src/rateLimit/redisStore.ioredis.test.ts +29 -0
- package/src/rateLimit/redisStore.test.ts +114 -0
- package/src/rateLimit/redisStore.ts +85 -0
- package/src/rateLimit/types.ts +64 -0
- package/src/rbac/access.ts +5 -1
- package/src/rbac/assertAllowed.test.ts +325 -0
- package/src/rbac/assertAllowed.ts +157 -0
- package/src/rbac/backfillAdmins.test.ts +124 -0
- package/src/rbac/fieldViews.test.ts +89 -0
- package/src/rbac/modelRouterAccess.test.ts +126 -0
- package/src/rbac/modelRouterAccess.ts +5 -2
- package/src/rbac/permissionUtils.ts +3 -2
- package/src/rbac/realtimeAccess.test.ts +109 -1
- package/src/rbac/resolve.ts +5 -4
- package/src/rbac/roleManager.test.ts +169 -0
- package/src/rbac/routes.test.ts +233 -0
- package/src/rbac/routes.ts +16 -6
- package/src/rbac/statements.test.ts +2 -0
- package/src/rbac/statements.ts +12 -1
- package/src/realtime/deprecation.test.ts +60 -0
- package/src/realtime/deprecation.ts +32 -0
- package/src/realtime/realtime.test.ts +8 -4
- package/src/realtime/realtimeApp.ts +10 -11
- package/src/realtime/realtimeAppSetup.test.ts +32 -5
- package/src/realtime/registry.ts +48 -42
- package/src/realtime/sessionRevalidation.test.ts +57 -44
- package/src/realtime/socketAuth.test.ts +75 -23
- package/src/realtime/socketAuth.ts +17 -6
- package/src/realtime/socketUser.ts +5 -3
- package/src/realtime/types.ts +14 -4
- package/src/schemaMetadata.test.ts +405 -0
- package/src/schemaMetadata.ts +593 -0
- package/src/scrubAdminFields.test.ts +105 -0
- package/src/seedRunner.test.ts +591 -0
- package/src/seedRunner.ts +464 -0
- package/src/sync/docMatchesMutationData.test.ts +16 -0
- package/src/sync/ensureSyncIndexes.test.ts +54 -15
- package/src/sync/executors.test.ts +40 -0
- package/src/sync/executors.ts +24 -12
- package/src/sync/integration.test.ts +15 -7
- package/src/sync/loadHarness.ts +28 -19
- package/src/sync/models.ts +32 -18
- package/src/sync/mutationHandler.test.ts +16 -16
- package/src/sync/mutationHandler.ts +9 -7
- package/src/sync/registrationSideEffects.test.ts +126 -0
- package/src/sync/registrationSideEffects.ts +131 -0
- package/src/sync/registry.ts +45 -171
- package/src/sync/routes.ts +3 -2
- package/src/sync/scripts/compactTombstones.ts +0 -2
- package/src/sync/sessionRevalidationIntegration.test.ts +12 -11
- package/src/sync/sync.test.ts +25 -23
- package/src/sync/syncApp.ts +4 -4
- package/src/sync/syncBatch.ts +3 -2
- package/src/sync/syncFrontier.test.ts +17 -15
- package/src/sync/syncPhaseC.test.ts +54 -43
- package/src/sync/syncRoutes.test.ts +51 -36
- package/src/sync/syncSeqPlugin.ts +66 -44
- package/src/sync/syncSocket.test.ts +112 -81
- package/src/terrenoApp.mcpServiceTokens.test.ts +173 -0
- package/src/terrenoApp.ts +87 -15
- package/src/tests/models.ts +14 -1
- package/src/types/authToken.ts +43 -0
- package/src/types/mcpServiceToken.ts +54 -0
- package/src/webhooks/headerValue.test.ts +22 -0
- package/src/webhooks/headerValue.ts +12 -0
- package/src/webhooks/idempotency/memoryStore.ts +34 -0
- package/src/webhooks/idempotency/mongoStore.test.ts +274 -0
- package/src/webhooks/idempotency/mongoStore.ts +83 -0
- package/src/webhooks/idempotency/webhookReceipt.ts +70 -0
- package/src/webhooks/rawBody.test.ts +74 -0
- package/src/webhooks/rawBody.ts +23 -0
- package/src/webhooks/timingSafeEqual.ts +16 -0
- package/src/webhooks/verifiers/hmac.test.ts +110 -0
- package/src/webhooks/verifiers/hmac.ts +54 -0
- package/src/webhooks/verifiers/providerVerifiers.test.ts +388 -0
- package/src/webhooks/verifiers/sendgrid.ts +59 -0
- package/src/webhooks/verifiers/stripe.ts +67 -0
- package/src/webhooks/verifiers/twilio.ts +69 -0
- package/src/webhooks/webhooksApp.test.ts +221 -0
- package/src/webhooks/webhooksApp.ts +144 -0
package/dist/sync/registry.d.ts
CHANGED
|
@@ -1,78 +1,28 @@
|
|
|
1
1
|
import type { Model } from "mongoose";
|
|
2
2
|
import type { ModelRouterOptions } from "../api";
|
|
3
|
+
import { ensureSyncIndexes, trackSyncIndexCreation } from "./registrationSideEffects";
|
|
3
4
|
import type { SyncConfig } from "./types";
|
|
4
|
-
/**
|
|
5
|
-
* A registered model with SyncDB local-first sync configuration.
|
|
6
|
-
*/
|
|
7
5
|
export interface SyncRegistryEntry {
|
|
8
|
-
/** Mongoose model name (e.g. "Todo") */
|
|
9
6
|
modelName: string;
|
|
10
|
-
/** Route path (e.g. "/todos") */
|
|
11
7
|
routePath: string;
|
|
12
|
-
/** Collection tag used in the sync protocol (route path without the leading slash) */
|
|
13
8
|
collectionTag: string;
|
|
14
|
-
/** MongoDB collection name (e.g. "todos") */
|
|
15
9
|
collectionName: string;
|
|
16
|
-
/** Sync configuration from modelRouter options */
|
|
17
10
|
config: SyncConfig;
|
|
18
|
-
/** Full modelRouter options (for responseHandler, permissions, etc.) */
|
|
19
11
|
options: ModelRouterOptions<unknown>;
|
|
20
12
|
}
|
|
21
|
-
|
|
22
|
-
* Enqueue an index-creation promise for `ensureSyncIndexes()` to await at startup. Used by
|
|
23
|
-
* `SyncApp.register` for the bookkeeping-model indexes (`SyncCounter`, `SyncMutation`,
|
|
24
|
-
* `SyncScopeMove`, `SyncKey`), which are correctness-critical and must not depend on
|
|
25
|
-
* Mongoose `autoIndex` being enabled.
|
|
26
|
-
*/
|
|
27
|
-
export declare const trackSyncIndexCreation: (promise: Promise<void>) => void;
|
|
28
|
-
/**
|
|
29
|
-
* Register a model for local-first sync. Called automatically by modelRouter when the
|
|
30
|
-
* `sync` option is provided. Validates the schema contract at startup and throws with
|
|
31
|
-
* an actionable message when it is not met:
|
|
32
|
-
* - soft delete (`isDeletedPlugin`) is required so deletes remain queryable tombstones;
|
|
33
|
-
* - `syncPlugin` is required so every write stamps a per-stream `_syncSeq`;
|
|
34
|
-
* - owner/tenant scope fields must exist on the schema.
|
|
35
|
-
*/
|
|
13
|
+
export { ensureSyncIndexes, trackSyncIndexCreation };
|
|
36
14
|
export declare const registerSync: <T>({ model, routePath, config, options, }: {
|
|
37
15
|
model: Model<T>;
|
|
38
16
|
routePath: string;
|
|
39
17
|
config: SyncConfig;
|
|
40
18
|
options: ModelRouterOptions<T>;
|
|
41
19
|
}) => void;
|
|
42
|
-
/**
|
|
43
|
-
* Replace options on an existing sync registry entry after TerrenoApp injects
|
|
44
|
-
* accessControl and modelRouter resolves RBAC permissions.
|
|
45
|
-
*/
|
|
46
20
|
export declare const updateSyncRegistryOptions: (routePath: string, options: ModelRouterOptions<unknown>) => void;
|
|
47
|
-
/**
|
|
48
|
-
* C8: await every enqueued sync index creation — per-model snapshot indexes from
|
|
49
|
-
* `registerSync` plus the bookkeeping-model indexes from `SyncApp.register` — throwing on
|
|
50
|
-
* the first failure. Called at server startup by `TerrenoApp.start()` (after all models
|
|
51
|
-
* and plugins register) so a missing index fails the boot loudly rather than silently
|
|
52
|
-
* degrading the snapshot query to a table scan or breaking mutation idempotency.
|
|
53
|
-
*/
|
|
54
|
-
export declare const ensureSyncIndexes: () => Promise<void>;
|
|
55
|
-
/** Get all registered sync models. */
|
|
56
21
|
export declare const getSyncRegistry: () => SyncRegistryEntry[];
|
|
57
|
-
/**
|
|
58
|
-
* Task 9.21: warn loudly at startup when a tenant/custom-scoped collection is registered
|
|
59
|
-
* but no `userModel` is configured for socket handshakes.
|
|
60
|
-
*
|
|
61
|
-
* Without one, `getSocketUser` falls back to the synthetic decoded-token user: `admin`
|
|
62
|
-
* comes from a JWT claim rather than the database, and `getUserScopes` sees no
|
|
63
|
-
* `organizationIds`, so tenant subscriptions silently resolve to no streams (a client that
|
|
64
|
-
* appears connected but never receives data). This warns rather than throws so an existing
|
|
65
|
-
* deployment cannot be bricked by an upgrade; the message names the collections and the
|
|
66
|
-
* fix. Returns the offending collection tags for tests and callers that want to escalate.
|
|
67
|
-
*/
|
|
68
22
|
export declare const warnOnSyncScopesWithoutUserModel: ({ userModel }: {
|
|
69
23
|
userModel?: unknown;
|
|
70
24
|
}) => string[];
|
|
71
|
-
/** Find a sync registry entry by Mongoose model name. */
|
|
72
25
|
export declare const findSyncEntryByModelName: (modelName: string) => SyncRegistryEntry | undefined;
|
|
73
|
-
/** Find a sync registry entry by collection tag (e.g. "todos"). */
|
|
74
26
|
export declare const findSyncEntryByCollectionTag: (collectionTag: string) => SyncRegistryEntry | undefined;
|
|
75
|
-
/** Find a sync registry entry by MongoDB collection name. */
|
|
76
27
|
export declare const findSyncEntryByCollectionName: (collectionName: string) => SyncRegistryEntry | undefined;
|
|
77
|
-
/** Clear the registry (for testing). */
|
|
78
28
|
export declare const clearSyncRegistry: () => void;
|
package/dist/sync/registry.js
CHANGED
|
@@ -1,200 +1,55 @@
|
|
|
1
1
|
"use strict";
|
|
2
|
-
var
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
};
|
|
11
|
-
|
|
12
|
-
var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g = Object.create((typeof Iterator === "function" ? Iterator : Object).prototype);
|
|
13
|
-
return g.next = verb(0), g["throw"] = verb(1), g["return"] = verb(2), typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
|
|
14
|
-
function verb(n) { return function (v) { return step([n, v]); }; }
|
|
15
|
-
function step(op) {
|
|
16
|
-
if (f) throw new TypeError("Generator is already executing.");
|
|
17
|
-
while (g && (g = 0, op[0] && (_ = 0)), _) try {
|
|
18
|
-
if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
|
|
19
|
-
if (y = 0, t) op = [op[0] & 2, t.value];
|
|
20
|
-
switch (op[0]) {
|
|
21
|
-
case 0: case 1: t = op; break;
|
|
22
|
-
case 4: _.label++; return { value: op[1], done: false };
|
|
23
|
-
case 5: _.label++; y = op[1]; op = [0]; continue;
|
|
24
|
-
case 7: op = _.ops.pop(); _.trys.pop(); continue;
|
|
25
|
-
default:
|
|
26
|
-
if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
|
|
27
|
-
if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
|
|
28
|
-
if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
|
|
29
|
-
if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
|
|
30
|
-
if (t[2]) _.ops.pop();
|
|
31
|
-
_.trys.pop(); continue;
|
|
32
|
-
}
|
|
33
|
-
op = body.call(thisArg, _);
|
|
34
|
-
} catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
|
|
35
|
-
if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
|
|
36
|
-
}
|
|
2
|
+
var __assign = (this && this.__assign) || function () {
|
|
3
|
+
__assign = Object.assign || function(t) {
|
|
4
|
+
for (var s, i = 1, n = arguments.length; i < n; i++) {
|
|
5
|
+
s = arguments[i];
|
|
6
|
+
for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
|
|
7
|
+
t[p] = s[p];
|
|
8
|
+
}
|
|
9
|
+
return t;
|
|
10
|
+
};
|
|
11
|
+
return __assign.apply(this, arguments);
|
|
37
12
|
};
|
|
38
13
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
39
|
-
exports.clearSyncRegistry = exports.findSyncEntryByCollectionName = exports.findSyncEntryByCollectionTag = exports.findSyncEntryByModelName = exports.warnOnSyncScopesWithoutUserModel = exports.getSyncRegistry = exports.
|
|
14
|
+
exports.clearSyncRegistry = exports.findSyncEntryByCollectionName = exports.findSyncEntryByCollectionTag = exports.findSyncEntryByModelName = exports.warnOnSyncScopesWithoutUserModel = exports.getSyncRegistry = exports.updateSyncRegistryOptions = exports.registerSync = exports.trackSyncIndexCreation = exports.ensureSyncIndexes = void 0;
|
|
15
|
+
var collectionRegistry_1 = require("../collectionRegistry");
|
|
40
16
|
var logger_1 = require("../logger");
|
|
41
|
-
var
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
* Mongoose `autoIndex` being enabled.
|
|
57
|
-
*/
|
|
58
|
-
var trackSyncIndexCreation = function (promise) {
|
|
59
|
-
indexCreationPromises.push(promise);
|
|
60
|
-
// Swallow the detached rejection (the failure is logged where it happens and rethrown
|
|
61
|
-
// by `ensureSyncIndexes()` via the retained promise above).
|
|
62
|
-
promise.catch(function () { });
|
|
17
|
+
var registrationSideEffects_1 = require("./registrationSideEffects");
|
|
18
|
+
Object.defineProperty(exports, "ensureSyncIndexes", { enumerable: true, get: function () { return registrationSideEffects_1.ensureSyncIndexes; } });
|
|
19
|
+
Object.defineProperty(exports, "trackSyncIndexCreation", { enumerable: true, get: function () { return registrationSideEffects_1.trackSyncIndexCreation; } });
|
|
20
|
+
var toSyncEntry = function (record) { return ({
|
|
21
|
+
collectionName: record.model.collection.collectionName,
|
|
22
|
+
collectionTag: record.routePath.replace(/^\//, ""),
|
|
23
|
+
config: record.options.sync,
|
|
24
|
+
modelName: record.model.modelName,
|
|
25
|
+
options: record.options,
|
|
26
|
+
routePath: record.routePath,
|
|
27
|
+
}); };
|
|
28
|
+
var syncCollections = function () {
|
|
29
|
+
return (0, collectionRegistry_1.listCollections)()
|
|
30
|
+
.filter(function (record) { return record.surfaces.sync; })
|
|
31
|
+
.map(toSyncEntry);
|
|
63
32
|
};
|
|
64
|
-
exports.trackSyncIndexCreation = trackSyncIndexCreation;
|
|
65
|
-
/**
|
|
66
|
-
* Register a model for local-first sync. Called automatically by modelRouter when the
|
|
67
|
-
* `sync` option is provided. Validates the schema contract at startup and throws with
|
|
68
|
-
* an actionable message when it is not met:
|
|
69
|
-
* - soft delete (`isDeletedPlugin`) is required so deletes remain queryable tombstones;
|
|
70
|
-
* - `syncPlugin` is required so every write stamps a per-stream `_syncSeq`;
|
|
71
|
-
* - owner/tenant scope fields must exist on the schema.
|
|
72
|
-
*/
|
|
73
33
|
var registerSync = function (_a) {
|
|
74
|
-
var _b;
|
|
75
34
|
var model = _a.model, routePath = _a.routePath, config = _a.config, options = _a.options;
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
throw new Error("Model ".concat(name, " has a sync config but no soft delete support. ") +
|
|
80
|
-
"Apply isDeletedPlugin to the schema — sync catch-up requires delete tombstones.");
|
|
81
|
-
}
|
|
82
|
-
if (!model.schema.path("_syncSeq")) {
|
|
83
|
-
throw new Error("Model ".concat(name, " has a sync config but syncPlugin is not applied to its schema. ") +
|
|
84
|
-
"Apply syncPlugin so every write stamps a per-stream _syncSeq.");
|
|
85
|
-
}
|
|
86
|
-
var scopeField = (0, streams_1.getScopeField)(config.scope);
|
|
87
|
-
if (scopeField && !model.schema.path(scopeField)) {
|
|
88
|
-
throw new Error("Model ".concat(name, " has a sync scope on field \"").concat(scopeField, "\" but the schema has no such path."));
|
|
89
|
-
}
|
|
90
|
-
if (typeof config.scope === "function" && !config.snapshotFilter) {
|
|
91
|
-
throw new Error("Model ".concat(name, " uses a custom sync scope resolver, which requires a snapshotFilter ") +
|
|
92
|
-
"so the snapshot endpoint can restrict queries to the caller's documents.");
|
|
93
|
-
}
|
|
94
|
-
if (syncRegistry.some(function (entry) { return entry.modelName === name; })) {
|
|
95
|
-
throw new Error("Model ".concat(name, " is already registered for sync."));
|
|
96
|
-
}
|
|
97
|
-
// C8: a duplicate collectionTag would make two models share sync streams and route
|
|
98
|
-
// snapshots/deltas ambiguously — reject it loudly at registration.
|
|
99
|
-
var collectionTag = routePath.replace(/^\//, "");
|
|
100
|
-
if (syncRegistry.some(function (entry) { return entry.collectionTag === collectionTag; })) {
|
|
101
|
-
throw new Error("Sync collection tag \"".concat(collectionTag, "\" is already registered (routePath ").concat(routePath, "). ") +
|
|
102
|
-
"Each synced model must have a unique route path.");
|
|
103
|
-
}
|
|
104
|
-
syncRegistry.push({
|
|
105
|
-
collectionName: model.collection.collectionName,
|
|
106
|
-
collectionTag: collectionTag,
|
|
107
|
-
config: config,
|
|
108
|
-
modelName: name,
|
|
109
|
-
options: options,
|
|
35
|
+
(0, collectionRegistry_1.registerCollection)({
|
|
36
|
+
model: model,
|
|
37
|
+
options: __assign(__assign({}, options), { sync: config }),
|
|
110
38
|
routePath: routePath,
|
|
111
39
|
});
|
|
112
|
-
// `Model.bulkWrite` bypasses Mongoose middleware entirely, so `syncPlugin`'s query
|
|
113
|
-
// guards never see it: writes land with no `_syncSeq`, invisible to both delta emission
|
|
114
|
-
// and snapshot catch-up, and clients silently never learn about them. The restriction
|
|
115
|
-
// used to be documentation only — replace the static so it throws the same way the
|
|
116
|
-
// guarded multi-document paths do. Idempotent: the replacement never delegates, so a
|
|
117
|
-
// re-registration (tests clearing the registry) re-patching it is harmless.
|
|
118
|
-
model.bulkWrite = function () {
|
|
119
|
-
throw new Error("bulkWrite is not supported on sync-enabled model ".concat(name, ": it bypasses Mongoose ") +
|
|
120
|
-
"middleware, so writes are never stamped with a per-stream _syncSeq and become " +
|
|
121
|
-
"invisible to sync delta emission and snapshot catch-up. Loop per document instead.");
|
|
122
|
-
};
|
|
123
|
-
// Compound index for snapshot/catch-up queries: {scopeField, _syncSeq}. Created
|
|
124
|
-
// directly on the collection because the model is already compiled at registration.
|
|
125
|
-
// C8: track the promise so `ensureSyncIndexes()` (server startup) can fail loudly on a
|
|
126
|
-
// createIndex error — a missing index table-scans the snapshot query under load. The
|
|
127
|
-
// detached path only logs (never throws into an orphaned promise).
|
|
128
|
-
var indexSpec = scopeField ? (_b = {}, _b[scopeField] = 1, _b._syncSeq = 1, _b) : { _syncSeq: 1 };
|
|
129
|
-
var indexPromise = model.collection
|
|
130
|
-
.createIndex(indexSpec)
|
|
131
|
-
.then(function () { })
|
|
132
|
-
.catch(function (error) {
|
|
133
|
-
logger_1.logger.error("[sync] Failed to create sync index for ".concat(name), { error: String(error) });
|
|
134
|
-
throw new Error("Failed to create sync snapshot index for ".concat(name, ": ").concat(String(error), ". ") +
|
|
135
|
-
"The snapshot/catch-up query requires this index; fix the schema/DB and restart.");
|
|
136
|
-
});
|
|
137
|
-
indexCreationPromises.push(indexPromise);
|
|
138
|
-
// Swallow the detached rejection (already logged) so it is not an unhandled rejection;
|
|
139
|
-
// `ensureSyncIndexes()` still observes it via the retained promise above.
|
|
140
|
-
indexPromise.catch(function () { });
|
|
141
40
|
};
|
|
142
41
|
exports.registerSync = registerSync;
|
|
143
|
-
/**
|
|
144
|
-
* Replace options on an existing sync registry entry after TerrenoApp injects
|
|
145
|
-
* accessControl and modelRouter resolves RBAC permissions.
|
|
146
|
-
*/
|
|
147
42
|
var updateSyncRegistryOptions = function (routePath, options) {
|
|
148
|
-
|
|
149
|
-
if (!existing) {
|
|
150
|
-
return;
|
|
151
|
-
}
|
|
152
|
-
existing.options = options;
|
|
43
|
+
(0, collectionRegistry_1.replaceCollectionOptions)(routePath, options);
|
|
153
44
|
};
|
|
154
45
|
exports.updateSyncRegistryOptions = updateSyncRegistryOptions;
|
|
155
|
-
|
|
156
|
-
* C8: await every enqueued sync index creation — per-model snapshot indexes from
|
|
157
|
-
* `registerSync` plus the bookkeeping-model indexes from `SyncApp.register` — throwing on
|
|
158
|
-
* the first failure. Called at server startup by `TerrenoApp.start()` (after all models
|
|
159
|
-
* and plugins register) so a missing index fails the boot loudly rather than silently
|
|
160
|
-
* degrading the snapshot query to a table scan or breaking mutation idempotency.
|
|
161
|
-
*/
|
|
162
|
-
var ensureSyncIndexes = function () { return __awaiter(void 0, void 0, void 0, function () {
|
|
163
|
-
return __generator(this, function (_a) {
|
|
164
|
-
switch (_a.label) {
|
|
165
|
-
case 0: return [4 /*yield*/, Promise.all(indexCreationPromises)];
|
|
166
|
-
case 1:
|
|
167
|
-
_a.sent();
|
|
168
|
-
return [2 /*return*/];
|
|
169
|
-
}
|
|
170
|
-
});
|
|
171
|
-
}); };
|
|
172
|
-
exports.ensureSyncIndexes = ensureSyncIndexes;
|
|
173
|
-
/** Get all registered sync models. */
|
|
174
|
-
var getSyncRegistry = function () { return syncRegistry; };
|
|
46
|
+
var getSyncRegistry = function () { return syncCollections(); };
|
|
175
47
|
exports.getSyncRegistry = getSyncRegistry;
|
|
176
|
-
/**
|
|
177
|
-
* Collection tags whose scope can only be resolved from the FULL user document —
|
|
178
|
-
* tenant scopes read `organizationIds` (or whatever `getUserScopes` looks at) and custom
|
|
179
|
-
* resolvers may read anything. The synthetic `{_id, admin, id}` user built from JWT claims
|
|
180
|
-
* carries none of that.
|
|
181
|
-
*/
|
|
182
48
|
var scopesRequiringFullUser = function () {
|
|
183
|
-
return
|
|
49
|
+
return syncCollections()
|
|
184
50
|
.filter(function (entry) { return typeof entry.config.scope === "function" || entry.config.scope.type === "tenant"; })
|
|
185
51
|
.map(function (entry) { return entry.collectionTag; });
|
|
186
52
|
};
|
|
187
|
-
/**
|
|
188
|
-
* Task 9.21: warn loudly at startup when a tenant/custom-scoped collection is registered
|
|
189
|
-
* but no `userModel` is configured for socket handshakes.
|
|
190
|
-
*
|
|
191
|
-
* Without one, `getSocketUser` falls back to the synthetic decoded-token user: `admin`
|
|
192
|
-
* comes from a JWT claim rather than the database, and `getUserScopes` sees no
|
|
193
|
-
* `organizationIds`, so tenant subscriptions silently resolve to no streams (a client that
|
|
194
|
-
* appears connected but never receives data). This warns rather than throws so an existing
|
|
195
|
-
* deployment cannot be bricked by an upgrade; the message names the collections and the
|
|
196
|
-
* fix. Returns the offending collection tags for tests and callers that want to escalate.
|
|
197
|
-
*/
|
|
198
53
|
var warnOnSyncScopesWithoutUserModel = function (_a) {
|
|
199
54
|
var userModel = _a.userModel;
|
|
200
55
|
if (userModel) {
|
|
@@ -212,24 +67,20 @@ var warnOnSyncScopesWithoutUserModel = function (_a) {
|
|
|
212
67
|
return collections;
|
|
213
68
|
};
|
|
214
69
|
exports.warnOnSyncScopesWithoutUserModel = warnOnSyncScopesWithoutUserModel;
|
|
215
|
-
/** Find a sync registry entry by Mongoose model name. */
|
|
216
70
|
var findSyncEntryByModelName = function (modelName) {
|
|
217
|
-
return
|
|
71
|
+
return syncCollections().find(function (entry) { return entry.modelName === modelName; });
|
|
218
72
|
};
|
|
219
73
|
exports.findSyncEntryByModelName = findSyncEntryByModelName;
|
|
220
|
-
/** Find a sync registry entry by collection tag (e.g. "todos"). */
|
|
221
74
|
var findSyncEntryByCollectionTag = function (collectionTag) {
|
|
222
|
-
return
|
|
75
|
+
return syncCollections().find(function (entry) { return entry.collectionTag === collectionTag; });
|
|
223
76
|
};
|
|
224
77
|
exports.findSyncEntryByCollectionTag = findSyncEntryByCollectionTag;
|
|
225
|
-
/** Find a sync registry entry by MongoDB collection name. */
|
|
226
78
|
var findSyncEntryByCollectionName = function (collectionName) {
|
|
227
|
-
return
|
|
79
|
+
return syncCollections().find(function (entry) { return entry.collectionName === collectionName; });
|
|
228
80
|
};
|
|
229
81
|
exports.findSyncEntryByCollectionName = findSyncEntryByCollectionName;
|
|
230
|
-
/** Clear the registry (for testing). */
|
|
231
82
|
var clearSyncRegistry = function () {
|
|
232
|
-
|
|
233
|
-
|
|
83
|
+
(0, collectionRegistry_1.clearCollectionRegistry)();
|
|
84
|
+
(0, registrationSideEffects_1.clearSyncIndexCreationTasks)();
|
|
234
85
|
};
|
|
235
86
|
exports.clearSyncRegistry = clearSyncRegistry;
|
package/dist/sync/routes.js
CHANGED
|
@@ -94,6 +94,7 @@ var auth_1 = require("../auth");
|
|
|
94
94
|
var errors_1 = require("../errors");
|
|
95
95
|
var logger_1 = require("../logger");
|
|
96
96
|
var permissions_1 = require("../permissions");
|
|
97
|
+
var plugins_1 = require("../plugins");
|
|
97
98
|
var models_1 = require("./models");
|
|
98
99
|
var registry_1 = require("./registry");
|
|
99
100
|
var serialize_1 = require("./serialize");
|
|
@@ -360,10 +361,10 @@ var frontierBelowStreamHead = function (streamKey, frontierSeq) { return __await
|
|
|
360
361
|
var _a;
|
|
361
362
|
return __generator(this, function (_b) {
|
|
362
363
|
switch (_b.label) {
|
|
363
|
-
case 0: return [4 /*yield*/, models_1.SyncCounter
|
|
364
|
+
case 0: return [4 /*yield*/, (0, plugins_1.findOneOrNoneFor)(models_1.SyncCounter, { stream: streamKey })];
|
|
364
365
|
case 1:
|
|
365
366
|
counter = _b.sent();
|
|
366
|
-
head = counter ?
|
|
367
|
+
head = (_a = counter === null || counter === void 0 ? void 0 : counter.seq) !== null && _a !== void 0 ? _a : 0;
|
|
367
368
|
return [2 /*return*/, head > frontierSeq];
|
|
368
369
|
}
|
|
369
370
|
});
|
|
@@ -67,8 +67,6 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
|
67
67
|
};
|
|
68
68
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
69
69
|
exports.compactTombstones = exports.compactEntryTombstones = exports.DEFAULT_TOMBSTONE_RETENTION_DAYS = void 0;
|
|
70
|
-
// noExplicitAny: operates generically across registered sync models
|
|
71
|
-
// biome-ignore-all lint/suspicious/noExplicitAny: operates generically across registered sync models
|
|
72
70
|
var luxon_1 = require("luxon");
|
|
73
71
|
var mongoose_1 = __importDefault(require("mongoose"));
|
|
74
72
|
var logger_1 = require("../../logger");
|
package/dist/sync/syncApp.d.ts
CHANGED
|
@@ -14,9 +14,9 @@ export declare const getSyncAppOptions: (app: express.Application) => SyncAppOpt
|
|
|
14
14
|
* configuration — the socket layer requires both plugins: SyncApp for config/routes and
|
|
15
15
|
* RealtimeApp for the Socket.io server and `sync:delta` emission.
|
|
16
16
|
*
|
|
17
|
-
* Registration also
|
|
18
|
-
* `SyncMutation`, `SyncScopeMove`, `SyncKey`)
|
|
19
|
-
*
|
|
17
|
+
* Registration also enqueues the bookkeeping-model index builds (`SyncCounter`,
|
|
18
|
+
* `SyncMutation`, `SyncScopeMove`, `SyncKey`) for `ensureSyncIndexes()`, which
|
|
19
|
+
* `TerrenoApp.start()` awaits before the HTTP server begins listening. Those indexes are
|
|
20
20
|
* requirements — the unique `mutationId` index is what makes duplicate mutation deliveries
|
|
21
21
|
* idempotent, and the unique `stream` index is what keeps the counter upsert race from
|
|
22
22
|
* minting duplicate seqs — so an index-build failure fails startup loudly. Apps that build
|
package/dist/sync/syncApp.js
CHANGED
|
@@ -21,9 +21,9 @@ exports.getSyncAppOptions = getSyncAppOptions;
|
|
|
21
21
|
* configuration — the socket layer requires both plugins: SyncApp for config/routes and
|
|
22
22
|
* RealtimeApp for the Socket.io server and `sync:delta` emission.
|
|
23
23
|
*
|
|
24
|
-
* Registration also
|
|
25
|
-
* `SyncMutation`, `SyncScopeMove`, `SyncKey`)
|
|
26
|
-
*
|
|
24
|
+
* Registration also enqueues the bookkeeping-model index builds (`SyncCounter`,
|
|
25
|
+
* `SyncMutation`, `SyncScopeMove`, `SyncKey`) for `ensureSyncIndexes()`, which
|
|
26
|
+
* `TerrenoApp.start()` awaits before the HTTP server begins listening. Those indexes are
|
|
27
27
|
* requirements — the unique `mutationId` index is what makes duplicate mutation deliveries
|
|
28
28
|
* idempotent, and the unique `stream` index is what keeps the counter upsert race from
|
|
29
29
|
* minting duplicate seqs — so an index-build failure fails startup loudly. Apps that build
|
|
@@ -36,7 +36,7 @@ var SyncApp = /** @class */ (function () {
|
|
|
36
36
|
}
|
|
37
37
|
SyncApp.prototype.register = function (app) {
|
|
38
38
|
app.locals[SYNC_APP_OPTIONS_LOCAL_KEY] = this.options;
|
|
39
|
-
(0, registry_1.trackSyncIndexCreation)((0, models_1.ensureSyncModelIndexes)());
|
|
39
|
+
(0, registry_1.trackSyncIndexCreation)(function () { return (0, models_1.ensureSyncModelIndexes)(); });
|
|
40
40
|
(0, routes_1.addSyncRoutes)(app, this.options);
|
|
41
41
|
};
|
|
42
42
|
return SyncApp;
|
package/dist/sync/syncBatch.js
CHANGED
|
@@ -75,6 +75,7 @@ var __read = (this && this.__read) || function (o, n) {
|
|
|
75
75
|
};
|
|
76
76
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
77
77
|
exports.runSyncBatch = exports.runSyncMutation = exports.syncMutationRateLimitWindowCount = exports.resetSyncMutationRateLimits = exports.evictExpiredSyncMutationWindows = exports.MAX_SYNC_MUTATIONS_PER_SECOND = void 0;
|
|
78
|
+
var luxon_1 = require("luxon");
|
|
78
79
|
var logger_1 = require("../logger");
|
|
79
80
|
var mutationHandler_1 = require("./mutationHandler");
|
|
80
81
|
/**
|
|
@@ -112,7 +113,7 @@ var lastEvictionAt = 0;
|
|
|
112
113
|
*/
|
|
113
114
|
var evictExpiredSyncMutationWindows = function (_a) {
|
|
114
115
|
var e_1, _b;
|
|
115
|
-
var _c = _a === void 0 ? {} : _a, _d = _c.now, now = _d === void 0 ?
|
|
116
|
+
var _c = _a === void 0 ? {} : _a, _d = _c.now, now = _d === void 0 ? luxon_1.DateTime.now().toMillis() : _d;
|
|
116
117
|
lastEvictionAt = now;
|
|
117
118
|
try {
|
|
118
119
|
for (var mutationWindows_1 = __values(mutationWindows), mutationWindows_1_1 = mutationWindows_1.next(); !mutationWindows_1_1.done; mutationWindows_1_1 = mutationWindows_1.next()) {
|
|
@@ -150,7 +151,7 @@ var maybeEvictExpiredWindows = function (now) {
|
|
|
150
151
|
*/
|
|
151
152
|
var consumeMutationBudget = function (_a) {
|
|
152
153
|
var userId = _a.userId, weight = _a.weight;
|
|
153
|
-
var now =
|
|
154
|
+
var now = luxon_1.DateTime.now().toMillis();
|
|
154
155
|
maybeEvictExpiredWindows(now);
|
|
155
156
|
var existing = mutationWindows.get(userId);
|
|
156
157
|
var window = !existing || now - existing.windowStart >= RATE_LIMIT_WINDOW_MS
|
|
@@ -5,4 +5,4 @@ import type { Schema } from "mongoose";
|
|
|
5
5
|
* so a transient failure (replica step-down, transient network error) is retried.
|
|
6
6
|
*/
|
|
7
7
|
export declare const SCOPE_MOVE_MARKER_ATTEMPTS = 3;
|
|
8
|
-
export declare const syncPlugin: (schema: Schema
|
|
8
|
+
export declare const syncPlugin: (schema: Schema) => void;
|
|
@@ -75,6 +75,7 @@ var __read = (this && this.__read) || function (o, n) {
|
|
|
75
75
|
};
|
|
76
76
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
77
77
|
exports.syncPlugin = exports.SCOPE_MOVE_MARKER_ATTEMPTS = void 0;
|
|
78
|
+
var errors_1 = require("../errors");
|
|
78
79
|
var logger_1 = require("../logger");
|
|
79
80
|
var models_1 = require("./models");
|
|
80
81
|
var registry_1 = require("./registry");
|
|
@@ -349,9 +350,12 @@ var syncPlugin = function (schema) {
|
|
|
349
350
|
// so the `baseVersion` comparison in executeUpdate cannot be defeated by a concurrent
|
|
350
351
|
// save landing between the read and the write.
|
|
351
352
|
if (!schema.options.versionKey) {
|
|
352
|
-
throw new
|
|
353
|
-
|
|
354
|
-
"
|
|
353
|
+
throw new errors_1.APIError({
|
|
354
|
+
status: 500,
|
|
355
|
+
title: "syncPlugin requires a versionKey on the schema: sync relies on Mongoose " +
|
|
356
|
+
"optimisticConcurrency to make the baseVersion conflict check atomic. " +
|
|
357
|
+
"Remove `versionKey: false` from the schema options.",
|
|
358
|
+
});
|
|
355
359
|
}
|
|
356
360
|
schema.set("optimisticConcurrency", true);
|
|
357
361
|
schema.add({
|
|
@@ -640,7 +644,7 @@ var syncPlugin = function (schema) {
|
|
|
640
644
|
if (typeof (doc === null || doc === void 0 ? void 0 : doc.$session) === "function" && doc.$session()) {
|
|
641
645
|
continue;
|
|
642
646
|
}
|
|
643
|
-
obj =
|
|
647
|
+
obj = typeof (doc === null || doc === void 0 ? void 0 : doc.toObject) === "function" ? doc.toObject() : doc;
|
|
644
648
|
seq = obj._syncSeq;
|
|
645
649
|
if (typeof seq !== "number") {
|
|
646
650
|
continue;
|
|
@@ -705,8 +709,6 @@ var syncPlugin = function (schema) {
|
|
|
705
709
|
});
|
|
706
710
|
});
|
|
707
711
|
});
|
|
708
|
-
// Single-document query writes: fetch the target to resolve its stream (and detect
|
|
709
|
-
// scope moves), claim a seq, and merge the stamp into the update.
|
|
710
712
|
var preQueryWrite = function () {
|
|
711
713
|
return __awaiter(this, void 0, void 0, function () {
|
|
712
714
|
var model, entry, operation, rawFilter, session, filter, matches, target, targetObj, previousStream, rawUpdate, op, isTrueReplacement, hasOperators, setFields, scopeField, currentStream, effectiveDoc, unsetFields, newScopeValue, prevStream, claim;
|
|
@@ -827,16 +829,18 @@ var syncPlugin = function (schema) {
|
|
|
827
829
|
// scope-move marker. Query post middleware `this` is the Query (not a document).
|
|
828
830
|
var postQueryWrite = function () {
|
|
829
831
|
return __awaiter(this, void 0, void 0, function () {
|
|
830
|
-
var pending,
|
|
831
|
-
return __generator(this, function (
|
|
832
|
-
switch (
|
|
832
|
+
var pending, claim, currentStream, entityId, entry, prevStream, session;
|
|
833
|
+
return __generator(this, function (_a) {
|
|
834
|
+
switch (_a.label) {
|
|
833
835
|
case 0:
|
|
834
|
-
pending = this
|
|
836
|
+
pending = this
|
|
837
|
+
._syncPendingConfirm;
|
|
835
838
|
if (!pending) {
|
|
836
839
|
return [2 /*return*/];
|
|
837
840
|
}
|
|
838
|
-
this._syncPendingConfirm =
|
|
839
|
-
|
|
841
|
+
this._syncPendingConfirm =
|
|
842
|
+
undefined;
|
|
843
|
+
claim = pending.claim, currentStream = pending.currentStream, entityId = pending.entityId, entry = pending.entry, prevStream = pending.prevStream, session = pending.session;
|
|
840
844
|
if (!claim.registered) return [3 /*break*/, 2];
|
|
841
845
|
return [4 /*yield*/, (0, models_1.confirmSyncSeqs)({ seqs: claim.seqs, stream: currentStream }).catch(function (error) {
|
|
842
846
|
logger_1.logger.error("[sync] Failed to confirm seq after query write", {
|
|
@@ -845,8 +849,8 @@ var syncPlugin = function (schema) {
|
|
|
845
849
|
});
|
|
846
850
|
})];
|
|
847
851
|
case 1:
|
|
848
|
-
|
|
849
|
-
|
|
852
|
+
_a.sent();
|
|
853
|
+
_a.label = 2;
|
|
850
854
|
case 2:
|
|
851
855
|
if (!prevStream) return [3 /*break*/, 4];
|
|
852
856
|
// Retries internally and never throws: the move already committed, so the marker
|
|
@@ -861,8 +865,8 @@ var syncPlugin = function (schema) {
|
|
|
861
865
|
case 3:
|
|
862
866
|
// Retries internally and never throws: the move already committed, so the marker
|
|
863
867
|
// must not be dropped on the first transient failure nor fail the user's write.
|
|
864
|
-
|
|
865
|
-
|
|
868
|
+
_a.sent();
|
|
869
|
+
_a.label = 4;
|
|
866
870
|
case 4: return [2 /*return*/];
|
|
867
871
|
}
|
|
868
872
|
});
|
package/dist/terrenoApp.d.ts
CHANGED
|
@@ -3,10 +3,12 @@ import express from "express";
|
|
|
3
3
|
import type { AdminChangeEvent, TerrenoAppAdminEvent } from "./adminTypes";
|
|
4
4
|
import type { ModelRouterRegistration } from "./api";
|
|
5
5
|
import { type UserModel as UserMongooseModel } from "./auth";
|
|
6
|
-
import { type ConfigurationAppOptions } from "./configurationApp";
|
|
6
|
+
import { type ConfigurationAppOptions, type ConfigurationModelLike } from "./configurationApp";
|
|
7
7
|
import { type AddRoutes, type AuthOptions } from "./expressServer";
|
|
8
8
|
import { type GitHubAuthOptions } from "./githubAuth";
|
|
9
9
|
import { type LoggingOptions } from "./logger";
|
|
10
|
+
import { type McpServiceTokensAppOption } from "./mcp/serviceTokens";
|
|
11
|
+
import type { RateLimitOptions } from "./rateLimit/types";
|
|
10
12
|
import type { RealtimeAppOptions } from "./realtime/types";
|
|
11
13
|
import type { TerrenoPlugin } from "./terrenoPlugin";
|
|
12
14
|
type CorsOrigin = string | boolean | RegExp | Array<boolean | string | RegExp> | ((requestOrigin: string | undefined, callback: (err: Error | null, origin?: boolean | string | RegExp | Array<boolean | string | RegExp>) => void) => void);
|
|
@@ -53,6 +55,17 @@ export interface TerrenoAppOptions {
|
|
|
53
55
|
* Receives the Express app and OpenAPI bundle for `modelRouter` / `createOpenApiBuilder` wiring.
|
|
54
56
|
*/
|
|
55
57
|
configureApp?: AddRoutes;
|
|
58
|
+
/**
|
|
59
|
+
* Optional HTTP rate limiting. Omitted or `undefined` leaves the limiter off
|
|
60
|
+
* (Terreno 58 will default it on). Pass `{}` or `{store, limits, trustProxy}`
|
|
61
|
+
* to enable. See [Rate limiting](../how-to/rate-limiting.md).
|
|
62
|
+
*/
|
|
63
|
+
rateLimit?: RateLimitOptions;
|
|
64
|
+
/**
|
|
65
|
+
* Opt-in personal MCP service tokens. `true` is `{enabled: true}`. When enabled,
|
|
66
|
+
* mounts `/mcp/service-tokens` and accepts `Authorization: Bearer mcp_…` on `/mcp`.
|
|
67
|
+
*/
|
|
68
|
+
mcpServiceTokens?: McpServiceTokensAppOption;
|
|
56
69
|
}
|
|
57
70
|
/**
|
|
58
71
|
* Fluent API for building Express applications with Terreno framework.
|
|
@@ -65,7 +78,7 @@ export interface TerrenoAppOptions {
|
|
|
65
78
|
* 1. CORS
|
|
66
79
|
* 2. Optional `beforeJsonSetup` (configure the app before JSON parsing)
|
|
67
80
|
* 3. Custom middleware (via addMiddleware)
|
|
68
|
-
* 4. JSON body
|
|
81
|
+
* 4. JSON and urlencoded body parsers (stash `req.rawBody`)
|
|
69
82
|
* 5. Auth routes (/auth/login, /auth/signup, etc.)
|
|
70
83
|
* 6. JWT authentication setup
|
|
71
84
|
* 7. Request logging
|
|
@@ -201,13 +214,14 @@ export declare class TerrenoApp {
|
|
|
201
214
|
* .start();
|
|
202
215
|
* ```
|
|
203
216
|
*/
|
|
204
|
-
configure(model:
|
|
217
|
+
configure(model: ConfigurationModelLike, options?: Omit<ConfigurationAppOptions, "model">): this;
|
|
205
218
|
/**
|
|
206
219
|
* Build the Express application without starting the server.
|
|
207
220
|
*
|
|
208
221
|
* Configures the complete middleware stack including:
|
|
209
|
-
* - CORS, JSON parsing,
|
|
210
|
-
* -
|
|
222
|
+
* - CORS, JSON parsing, JWT decode, optional HTTP rate limiting, auth routes
|
|
223
|
+
* - Better Auth session (when BetterAuthApp is registered) before the limiter
|
|
224
|
+
* - Logging, Sentry, OpenAPI, model routers and plugins
|
|
211
225
|
* - Error handling middleware
|
|
212
226
|
*
|
|
213
227
|
* Use this method when you need the Express app instance for testing
|