@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.
Files changed (283) hide show
  1. package/README.md +17 -7
  2. package/dist/actions.js +19 -7
  3. package/dist/adminTypes.d.ts +26 -0
  4. package/dist/api.d.ts +4 -0
  5. package/dist/api.js +12 -24
  6. package/dist/auth.d.ts +23 -10
  7. package/dist/auth.js +97 -32
  8. package/dist/authRecovery.d.ts +5 -0
  9. package/dist/authRecovery.js +350 -0
  10. package/dist/authTokens.d.ts +8 -0
  11. package/dist/authTokens.js +162 -0
  12. package/dist/betterAuth.d.ts +33 -0
  13. package/dist/betterAuthApp.d.ts +4 -0
  14. package/dist/betterAuthApp.js +26 -8
  15. package/dist/betterAuthSetup.d.ts +44 -2
  16. package/dist/betterAuthSetup.js +288 -18
  17. package/dist/collectionRegistry.d.ts +38 -0
  18. package/dist/collectionRegistry.js +72 -0
  19. package/dist/configurationApp.d.ts +11 -2
  20. package/dist/configurationApp.js +2 -4
  21. package/dist/docLoader.js +35 -6
  22. package/dist/expressServer.d.ts +26 -3
  23. package/dist/expressServer.js +79 -11
  24. package/dist/index.d.ts +16 -0
  25. package/dist/index.js +38 -2
  26. package/dist/mcp/auth.d.ts +1 -0
  27. package/dist/mcp/auth.js +47 -25
  28. package/dist/mcp/handlers.d.ts +1 -1
  29. package/dist/mcp/handlers.js +67 -233
  30. package/dist/mcp/query.d.ts +2 -2
  31. package/dist/mcp/registry.d.ts +1 -5
  32. package/dist/mcp/registry.js +31 -20
  33. package/dist/mcp/schemaGenerator.d.ts +2 -7
  34. package/dist/mcp/schemaGenerator.js +41 -116
  35. package/dist/mcp/server.d.ts +1 -0
  36. package/dist/mcp/server.js +1 -0
  37. package/dist/mcp/serviceTokens.d.ts +16 -0
  38. package/dist/mcp/serviceTokens.js +345 -0
  39. package/dist/mcp/types.d.ts +2 -2
  40. package/dist/models/mcpServiceToken.d.ts +3 -0
  41. package/dist/models/mcpServiceToken.js +208 -0
  42. package/dist/openApiBuilder.d.ts +5 -4
  43. package/dist/openApiBuilder.js +61 -8
  44. package/dist/openApiCompat.js +1 -1
  45. package/dist/openApiValidator.js +0 -2
  46. package/dist/plugins.d.ts +14 -1
  47. package/dist/plugins.js +17 -6
  48. package/dist/populate.d.ts +2 -2
  49. package/dist/populate.js +47 -42
  50. package/dist/rateLimit/applyTrustProxy.d.ts +3 -0
  51. package/dist/rateLimit/applyTrustProxy.js +17 -0
  52. package/dist/rateLimit/createStore.d.ts +2 -0
  53. package/dist/rateLimit/createStore.js +28 -0
  54. package/dist/rateLimit/memoryStore.d.ts +2 -0
  55. package/dist/rateLimit/memoryStore.js +108 -0
  56. package/dist/rateLimit/middleware.d.ts +11 -0
  57. package/dist/rateLimit/middleware.js +110 -0
  58. package/dist/rateLimit/mongoStore.d.ts +3 -0
  59. package/dist/rateLimit/mongoStore.js +122 -0
  60. package/dist/rateLimit/policies.d.ts +14 -0
  61. package/dist/rateLimit/policies.js +151 -0
  62. package/dist/rateLimit/redisStore.d.ts +3 -0
  63. package/dist/rateLimit/redisStore.js +155 -0
  64. package/dist/rateLimit/types.d.ts +54 -0
  65. package/dist/rateLimit/types.js +9 -0
  66. package/dist/rbac/access.js +5 -1
  67. package/dist/rbac/assertAllowed.d.ts +9 -0
  68. package/dist/rbac/assertAllowed.js +182 -0
  69. package/dist/rbac/modelRouterAccess.d.ts +1 -0
  70. package/dist/rbac/modelRouterAccess.js +8 -4
  71. package/dist/rbac/permissionUtils.js +3 -2
  72. package/dist/rbac/resolve.js +5 -4
  73. package/dist/rbac/routes.js +15 -6
  74. package/dist/rbac/statements.d.ts +10 -0
  75. package/dist/rbac/statements.js +13 -2
  76. package/dist/realtime/deprecation.d.ts +12 -0
  77. package/dist/realtime/deprecation.js +32 -0
  78. package/dist/realtime/realtimeApp.d.ts +1 -1
  79. package/dist/realtime/realtimeApp.js +10 -11
  80. package/dist/realtime/registry.d.ts +0 -31
  81. package/dist/realtime/registry.js +44 -31
  82. package/dist/realtime/socketAuth.d.ts +5 -5
  83. package/dist/realtime/socketAuth.js +11 -1
  84. package/dist/realtime/socketUser.d.ts +5 -1
  85. package/dist/realtime/types.d.ts +14 -4
  86. package/dist/schemaMetadata.d.ts +56 -0
  87. package/dist/schemaMetadata.js +513 -0
  88. package/dist/seedRunner.d.ts +88 -0
  89. package/dist/seedRunner.js +627 -0
  90. package/dist/sync/executors.d.ts +12 -2
  91. package/dist/sync/executors.js +8 -10
  92. package/dist/sync/loadHarness.js +28 -19
  93. package/dist/sync/models.js +26 -24
  94. package/dist/sync/mutationHandler.d.ts +9 -0
  95. package/dist/sync/mutationHandler.js +11 -6
  96. package/dist/sync/registrationSideEffects.d.ts +35 -0
  97. package/dist/sync/registrationSideEffects.js +151 -0
  98. package/dist/sync/registry.d.ts +2 -52
  99. package/dist/sync/registry.js +38 -187
  100. package/dist/sync/routes.js +3 -2
  101. package/dist/sync/scripts/compactTombstones.js +0 -2
  102. package/dist/sync/syncApp.d.ts +3 -3
  103. package/dist/sync/syncApp.js +4 -4
  104. package/dist/sync/syncBatch.js +3 -2
  105. package/dist/sync/syncSeqPlugin.d.ts +1 -1
  106. package/dist/sync/syncSeqPlugin.js +20 -16
  107. package/dist/terrenoApp.d.ts +19 -5
  108. package/dist/terrenoApp.js +66 -18
  109. package/dist/tests/models.d.ts +2 -0
  110. package/dist/tests/models.js +6 -0
  111. package/dist/types/authToken.d.ts +33 -0
  112. package/dist/types/authToken.js +2 -0
  113. package/dist/types/mcpServiceToken.d.ts +41 -0
  114. package/dist/types/mcpServiceToken.js +2 -0
  115. package/dist/webhooks/headerValue.d.ts +2 -0
  116. package/dist/webhooks/headerValue.js +14 -0
  117. package/dist/webhooks/idempotency/memoryStore.d.ts +10 -0
  118. package/dist/webhooks/idempotency/memoryStore.js +65 -0
  119. package/dist/webhooks/idempotency/mongoStore.d.ts +4 -0
  120. package/dist/webhooks/idempotency/mongoStore.js +150 -0
  121. package/dist/webhooks/idempotency/webhookReceipt.d.ts +62 -0
  122. package/dist/webhooks/idempotency/webhookReceipt.js +39 -0
  123. package/dist/webhooks/rawBody.d.ts +14 -0
  124. package/dist/webhooks/rawBody.js +22 -0
  125. package/dist/webhooks/timingSafeEqual.d.ts +4 -0
  126. package/dist/webhooks/timingSafeEqual.js +17 -0
  127. package/dist/webhooks/verifiers/hmac.d.ts +15 -0
  128. package/dist/webhooks/verifiers/hmac.js +49 -0
  129. package/dist/webhooks/verifiers/sendgrid.d.ts +10 -0
  130. package/dist/webhooks/verifiers/sendgrid.js +56 -0
  131. package/dist/webhooks/verifiers/stripe.d.ts +9 -0
  132. package/dist/webhooks/verifiers/stripe.js +99 -0
  133. package/dist/webhooks/verifiers/twilio.d.ts +9 -0
  134. package/dist/webhooks/verifiers/twilio.js +112 -0
  135. package/dist/webhooks/webhooksApp.d.ts +33 -0
  136. package/dist/webhooks/webhooksApp.js +195 -0
  137. package/package.json +5 -6
  138. package/src/__snapshots__/openApi.test.ts.snap +270 -0
  139. package/src/__snapshots__/openApiBuilder.test.ts.snap +30 -12
  140. package/src/__snapshots__/schemaMetadata.test.ts.snap +197 -0
  141. package/src/actions.ts +20 -13
  142. package/src/adminModelRouter.test.ts +133 -0
  143. package/src/adminTypes.ts +23 -0
  144. package/src/api.arrayOperations.test.ts +43 -31
  145. package/src/api.hooks.test.ts +38 -29
  146. package/src/api.query.test.ts +31 -31
  147. package/src/api.test.ts +95 -96
  148. package/src/api.ts +16 -27
  149. package/src/auth.test.ts +107 -51
  150. package/src/auth.ts +98 -29
  151. package/src/authRecovery.test.ts +281 -0
  152. package/src/authRecovery.ts +279 -0
  153. package/src/authTokens.test.ts +94 -0
  154. package/src/authTokens.ts +118 -0
  155. package/src/authVerification.test.ts +293 -0
  156. package/src/betterAuth.ts +24 -0
  157. package/src/betterAuthApp.test.ts +1 -0
  158. package/src/betterAuthApp.ts +27 -9
  159. package/src/betterAuthSetup.test.ts +568 -38
  160. package/src/betterAuthSetup.ts +260 -5
  161. package/src/collectionRegistry.test.ts +165 -0
  162. package/src/collectionRegistry.ts +115 -0
  163. package/src/configurationApp.ts +13 -7
  164. package/src/docLoader.test.ts +45 -1
  165. package/src/docLoader.ts +37 -6
  166. package/src/express.d.ts +1 -0
  167. package/src/expressServer.test.ts +130 -66
  168. package/src/expressServer.ts +75 -19
  169. package/src/githubAuth.test.ts +60 -55
  170. package/src/index.ts +58 -0
  171. package/src/mcp/auth.test.ts +47 -0
  172. package/src/mcp/auth.ts +32 -11
  173. package/src/mcp/handlers.ts +45 -172
  174. package/src/mcp/integration.test.ts +59 -9
  175. package/src/mcp/query.ts +2 -4
  176. package/src/mcp/registry.ts +29 -20
  177. package/src/mcp/schemaGenerator.test.ts +8 -0
  178. package/src/mcp/schemaGenerator.ts +49 -131
  179. package/src/mcp/server.ts +2 -0
  180. package/src/mcp/serviceTokens.test.ts +330 -0
  181. package/src/mcp/serviceTokens.ts +307 -0
  182. package/src/mcp/toolGenerator.test.ts +1 -1
  183. package/src/mcp/types.ts +2 -6
  184. package/src/models/mcpServiceToken.test.ts +129 -0
  185. package/src/models/mcpServiceToken.ts +158 -0
  186. package/src/openApi.test.ts +80 -64
  187. package/src/openApiBuilder.test.ts +95 -7
  188. package/src/openApiBuilder.ts +46 -9
  189. package/src/openApiCompat.ts +1 -1
  190. package/src/openApiValidator.test.ts +49 -54
  191. package/src/openApiValidator.ts +1 -3
  192. package/src/plugins.test.ts +14 -0
  193. package/src/plugins.ts +34 -9
  194. package/src/populate.test.ts +34 -0
  195. package/src/populate.ts +40 -29
  196. package/src/rateLimit/applyTrustProxy.ts +17 -0
  197. package/src/rateLimit/createStore.ts +25 -0
  198. package/src/rateLimit/memoryStore.ts +40 -0
  199. package/src/rateLimit/middleware.ts +79 -0
  200. package/src/rateLimit/mongoStore.test.ts +80 -0
  201. package/src/rateLimit/mongoStore.ts +76 -0
  202. package/src/rateLimit/policies.ts +130 -0
  203. package/src/rateLimit/rateLimit.test.ts +328 -0
  204. package/src/rateLimit/redisStore.ioredis.test.ts +29 -0
  205. package/src/rateLimit/redisStore.test.ts +114 -0
  206. package/src/rateLimit/redisStore.ts +85 -0
  207. package/src/rateLimit/types.ts +64 -0
  208. package/src/rbac/access.ts +5 -1
  209. package/src/rbac/assertAllowed.test.ts +325 -0
  210. package/src/rbac/assertAllowed.ts +157 -0
  211. package/src/rbac/backfillAdmins.test.ts +124 -0
  212. package/src/rbac/fieldViews.test.ts +89 -0
  213. package/src/rbac/modelRouterAccess.test.ts +126 -0
  214. package/src/rbac/modelRouterAccess.ts +5 -2
  215. package/src/rbac/permissionUtils.ts +3 -2
  216. package/src/rbac/realtimeAccess.test.ts +109 -1
  217. package/src/rbac/resolve.ts +5 -4
  218. package/src/rbac/roleManager.test.ts +169 -0
  219. package/src/rbac/routes.test.ts +233 -0
  220. package/src/rbac/routes.ts +16 -6
  221. package/src/rbac/statements.test.ts +2 -0
  222. package/src/rbac/statements.ts +12 -1
  223. package/src/realtime/deprecation.test.ts +60 -0
  224. package/src/realtime/deprecation.ts +32 -0
  225. package/src/realtime/realtime.test.ts +8 -4
  226. package/src/realtime/realtimeApp.ts +10 -11
  227. package/src/realtime/realtimeAppSetup.test.ts +32 -5
  228. package/src/realtime/registry.ts +48 -42
  229. package/src/realtime/sessionRevalidation.test.ts +57 -44
  230. package/src/realtime/socketAuth.test.ts +75 -23
  231. package/src/realtime/socketAuth.ts +17 -6
  232. package/src/realtime/socketUser.ts +5 -3
  233. package/src/realtime/types.ts +14 -4
  234. package/src/schemaMetadata.test.ts +405 -0
  235. package/src/schemaMetadata.ts +593 -0
  236. package/src/scrubAdminFields.test.ts +105 -0
  237. package/src/seedRunner.test.ts +591 -0
  238. package/src/seedRunner.ts +464 -0
  239. package/src/sync/docMatchesMutationData.test.ts +16 -0
  240. package/src/sync/ensureSyncIndexes.test.ts +54 -15
  241. package/src/sync/executors.test.ts +40 -0
  242. package/src/sync/executors.ts +24 -12
  243. package/src/sync/integration.test.ts +15 -7
  244. package/src/sync/loadHarness.ts +28 -19
  245. package/src/sync/models.ts +32 -18
  246. package/src/sync/mutationHandler.test.ts +16 -16
  247. package/src/sync/mutationHandler.ts +9 -7
  248. package/src/sync/registrationSideEffects.test.ts +126 -0
  249. package/src/sync/registrationSideEffects.ts +131 -0
  250. package/src/sync/registry.ts +45 -171
  251. package/src/sync/routes.ts +3 -2
  252. package/src/sync/scripts/compactTombstones.ts +0 -2
  253. package/src/sync/sessionRevalidationIntegration.test.ts +12 -11
  254. package/src/sync/sync.test.ts +25 -23
  255. package/src/sync/syncApp.ts +4 -4
  256. package/src/sync/syncBatch.ts +3 -2
  257. package/src/sync/syncFrontier.test.ts +17 -15
  258. package/src/sync/syncPhaseC.test.ts +54 -43
  259. package/src/sync/syncRoutes.test.ts +51 -36
  260. package/src/sync/syncSeqPlugin.ts +66 -44
  261. package/src/sync/syncSocket.test.ts +112 -81
  262. package/src/terrenoApp.mcpServiceTokens.test.ts +173 -0
  263. package/src/terrenoApp.ts +87 -15
  264. package/src/tests/models.ts +14 -1
  265. package/src/types/authToken.ts +43 -0
  266. package/src/types/mcpServiceToken.ts +54 -0
  267. package/src/webhooks/headerValue.test.ts +22 -0
  268. package/src/webhooks/headerValue.ts +12 -0
  269. package/src/webhooks/idempotency/memoryStore.ts +34 -0
  270. package/src/webhooks/idempotency/mongoStore.test.ts +274 -0
  271. package/src/webhooks/idempotency/mongoStore.ts +83 -0
  272. package/src/webhooks/idempotency/webhookReceipt.ts +70 -0
  273. package/src/webhooks/rawBody.test.ts +74 -0
  274. package/src/webhooks/rawBody.ts +23 -0
  275. package/src/webhooks/timingSafeEqual.ts +16 -0
  276. package/src/webhooks/verifiers/hmac.test.ts +110 -0
  277. package/src/webhooks/verifiers/hmac.ts +54 -0
  278. package/src/webhooks/verifiers/providerVerifiers.test.ts +388 -0
  279. package/src/webhooks/verifiers/sendgrid.ts +59 -0
  280. package/src/webhooks/verifiers/stripe.ts +67 -0
  281. package/src/webhooks/verifiers/twilio.ts +69 -0
  282. package/src/webhooks/webhooksApp.test.ts +221 -0
  283. package/src/webhooks/webhooksApp.ts +144 -0
@@ -1,5 +1,3 @@
1
- // noExplicitAny: test model typing
2
- // biome-ignore-all lint/suspicious/noExplicitAny: test model typing
3
1
  import {beforeAll, beforeEach, describe, expect, it} from "bun:test";
4
2
  import {model, Schema} from "mongoose";
5
3
  import {type ModelRouterOptions, modelRouter} from "../api";
@@ -73,32 +71,32 @@ unregisteredSchema.plugin(syncPlugin);
73
71
  const UnregisteredModel = model<SyncStuff>("SyncUnregistered", unregisteredSchema);
74
72
 
75
73
  // Missing isDeletedPlugin — registration must throw.
76
- const noDeleteSchema = new Schema({
74
+ const noDeleteSchema = new Schema<SyncStuff>({
77
75
  name: {description: "The name of the item", type: String},
78
76
  ownerId: {description: "The user who owns this item", type: String},
79
77
  });
80
78
  noDeleteSchema.plugin(syncPlugin);
81
- const NoDeleteModel = model("SyncNoDelete", noDeleteSchema);
79
+ const NoDeleteModel = model<SyncStuff>("SyncNoDelete", noDeleteSchema);
82
80
 
83
81
  // Missing syncPlugin — registration must throw.
84
- const noPluginSchema = new Schema({
82
+ const noPluginSchema = new Schema<SyncStuff>({
85
83
  name: {description: "The name of the item", type: String},
86
84
  ownerId: {description: "The user who owns this item", type: String},
87
85
  });
88
86
  noPluginSchema.plugin(isDeletedPlugin);
89
- const NoPluginModel = model("SyncNoPlugin", noPluginSchema);
87
+ const NoPluginModel = model<SyncStuff>("SyncNoPlugin", noPluginSchema);
90
88
 
91
- const stubOptions = {
89
+ const stubOptions = <T>(): ModelRouterOptions<T> => ({
92
90
  permissions: {create: [], delete: [], list: [], read: [], update: []},
93
- } as unknown as ModelRouterOptions<any>;
91
+ });
94
92
 
95
93
  const ownerConfig: SyncConfig = {scope: {type: "owner"}};
96
94
 
97
95
  const registerStuff = (config: SyncConfig = ownerConfig): void => {
98
96
  registerSync({
99
97
  config,
100
- model: SyncStuffModel as any,
101
- options: stubOptions,
98
+ model: SyncStuffModel,
99
+ options: stubOptions<SyncStuff>(),
102
100
  routePath: "/syncStuff",
103
101
  });
104
102
  };
@@ -205,8 +203,8 @@ describe("registerSync validation", () => {
205
203
  expect(() =>
206
204
  registerSync({
207
205
  config: ownerConfig,
208
- model: NoDeleteModel as any,
209
- options: stubOptions,
206
+ model: NoDeleteModel,
207
+ options: stubOptions<SyncStuff>(),
210
208
  routePath: "/noDelete",
211
209
  })
212
210
  ).toThrow(/soft delete/);
@@ -216,8 +214,8 @@ describe("registerSync validation", () => {
216
214
  expect(() =>
217
215
  registerSync({
218
216
  config: ownerConfig,
219
- model: NoPluginModel as any,
220
- options: stubOptions,
217
+ model: NoPluginModel,
218
+ options: stubOptions<SyncStuff>(),
221
219
  routePath: "/noPlugin",
222
220
  })
223
221
  ).toThrow(/syncPlugin/);
@@ -227,8 +225,8 @@ describe("registerSync validation", () => {
227
225
  expect(() =>
228
226
  registerSync({
229
227
  config: {scope: {field: "workspaceId", type: "tenant"}},
230
- model: SyncStuffModel as any,
231
- options: stubOptions,
228
+ model: SyncStuffModel,
229
+ options: stubOptions<SyncStuff>(),
232
230
  routePath: "/syncStuff",
233
231
  })
234
232
  ).toThrow(/workspaceId/);
@@ -248,7 +246,9 @@ describe("registerSync validation", () => {
248
246
 
249
247
  it("updateSyncRegistryOptions replaces options on an existing entry", () => {
250
248
  registerStuff();
251
- const updatedOptions = {permissions: {list: []}} as ModelRouterOptions<unknown>;
249
+ const updatedOptions = {
250
+ permissions: {list: []},
251
+ } as unknown as ModelRouterOptions<unknown>;
252
252
  updateSyncRegistryOptions("/syncStuff", updatedOptions);
253
253
  expect(getSyncRegistry()[0]?.options).toBe(updatedOptions);
254
254
  });
@@ -256,14 +256,16 @@ describe("registerSync validation", () => {
256
256
  it("updateSyncRegistryOptions no-ops when the route path is not registered", () => {
257
257
  registerStuff();
258
258
  const originalOptions = getSyncRegistry()[0]?.options;
259
- updateSyncRegistryOptions("/missing", {permissions: {}} as ModelRouterOptions<unknown>);
259
+ updateSyncRegistryOptions("/missing", {
260
+ permissions: {},
261
+ } as unknown as ModelRouterOptions<unknown>);
260
262
  expect(getSyncRegistry()[0]?.options).toBe(originalOptions);
261
263
  });
262
264
 
263
265
  it("makes bulkWrite throw on the registered model (it bypasses every plugin guard)", () => {
264
266
  registerStuff();
265
267
  expect(() =>
266
- (SyncStuffModel as any).bulkWrite([
268
+ SyncStuffModel.bulkWrite([
267
269
  {updateOne: {filter: {_id: "any"}, update: {$set: {name: "nope"}}}},
268
270
  ])
269
271
  ).toThrow(/bulkWrite is not supported on sync-enabled model SyncStuff/);
@@ -299,8 +301,8 @@ describe("modelRouter sync option", () => {
299
301
  });
300
302
 
301
303
  it("registers the model for sync in the three-argument form", () => {
302
- const registration = modelRouter("/syncStuff", SyncStuffModel as any, {
303
- ...stubOptions,
304
+ const registration = modelRouter("/syncStuff", SyncStuffModel, {
305
+ ...stubOptions<SyncStuff>(),
304
306
  sync: ownerConfig,
305
307
  });
306
308
  expect((registration as {__type: string}).__type).toBe("modelRouter");
@@ -308,7 +310,7 @@ describe("modelRouter sync option", () => {
308
310
  });
309
311
 
310
312
  it("does not register in the two-argument form", () => {
311
- modelRouter(SyncStuffModel as any, {...stubOptions, sync: ownerConfig});
313
+ modelRouter(SyncStuffModel, {...stubOptions<SyncStuff>(), sync: ownerConfig});
312
314
  expect(findSyncEntryByCollectionTag("syncStuff")).toBeUndefined();
313
315
  });
314
316
 
@@ -398,7 +400,7 @@ describe("syncPlugin seq stamping", () => {
398
400
  });
399
401
 
400
402
  it("does not consume a seq when validation fails", async () => {
401
- await expect(SyncStuffModel.create({ownerId: "u1"} as any)).rejects.toThrow();
403
+ await expect(SyncStuffModel.create({ownerId: "u1"} as unknown as SyncStuff)).rejects.toThrow();
402
404
  const doc = await SyncStuffModel.create({name: "valid", ownerId: "u1"});
403
405
  expect(doc._syncSeq).toBe(1);
404
406
  });
@@ -21,9 +21,9 @@ export const getSyncAppOptions = (app: express.Application): SyncAppOptions | un
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 kicks off the bookkeeping-model index builds (`SyncCounter`,
25
- * `SyncMutation`, `SyncScopeMove`, `SyncKey`) and enqueues them for `ensureSyncIndexes()`,
26
- * which `TerrenoApp.start()` awaits before listening. Those indexes are correctness
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
@@ -38,7 +38,7 @@ export class SyncApp implements TerrenoPlugin {
38
38
 
39
39
  register(app: express.Application): void {
40
40
  app.locals[SYNC_APP_OPTIONS_LOCAL_KEY] = this.options;
41
- trackSyncIndexCreation(ensureSyncModelIndexes());
41
+ trackSyncIndexCreation(() => ensureSyncModelIndexes());
42
42
  addSyncRoutes(app, this.options);
43
43
  }
44
44
  }
@@ -1,4 +1,5 @@
1
1
  import type express from "express";
2
+ import {DateTime} from "luxon";
2
3
  import type {User} from "../auth";
3
4
  import {logger} from "../logger";
4
5
  import {
@@ -56,7 +57,7 @@ let lastEvictionAt = 0;
56
57
  * Returns the number of windows still retained.
57
58
  */
58
59
  export const evictExpiredSyncMutationWindows = ({
59
- now = Date.now(),
60
+ now = DateTime.now().toMillis(),
60
61
  }: {
61
62
  now?: number;
62
63
  } = {}): number => {
@@ -93,7 +94,7 @@ const consumeMutationBudget = ({
93
94
  userId: string;
94
95
  weight: number;
95
96
  }): number | undefined => {
96
- const now = Date.now();
97
+ const now = DateTime.now().toMillis();
97
98
  maybeEvictExpiredWindows(now);
98
99
  const existing = mutationWindows.get(userId);
99
100
  const window =
@@ -1,5 +1,3 @@
1
- // noExplicitAny: test model typing
2
- // biome-ignore-all lint/suspicious/noExplicitAny: test model typing
3
1
  import {beforeAll, beforeEach, describe, expect, it} from "bun:test";
4
2
  import {model, Schema} from "mongoose";
5
3
  import type {ModelRouterOptions} from "../api";
@@ -84,7 +82,14 @@ const FrontierModel = model<FrontierStuff>("FrontierStuff", frontierSchema);
84
82
 
85
83
  const stubOptions = {
86
84
  permissions: {create: [], delete: [], list: [], read: [], update: []},
87
- } as unknown as ModelRouterOptions<any>;
85
+ } as unknown as ModelRouterOptions<FrontierStuff>;
86
+
87
+ type ScopeMoveCreate = (...args: Parameters<typeof SyncScopeMove.create>) => Promise<unknown>;
88
+
89
+ // Mongoose's `create` is overloaded, so the marker-retry tests swap it out through a
90
+ // single-signature view of the model.
91
+ const scopeMovePatch = SyncScopeMove as unknown as {create: ScopeMoveCreate};
92
+ const originalScopeMoveCreate: ScopeMoveCreate = SyncScopeMove.create.bind(SyncScopeMove);
88
93
 
89
94
  describe("C1 claimSyncSeqs / confirmSyncSeqs / computeStableFrontier", () => {
90
95
  beforeAll(async () => {
@@ -216,7 +221,7 @@ describe("C1 write-path guards (m9 / m10) + C4 scope-move markers", () => {
216
221
  clearSyncRegistry();
217
222
  registerSync({
218
223
  config: {scope: {field: "orgId", type: "tenant"}} as SyncConfig,
219
- model: FrontierModel as any,
224
+ model: FrontierModel,
220
225
  options: stubOptions,
221
226
  routePath: "/frontierStuff",
222
227
  });
@@ -422,19 +427,18 @@ describe("C1 write-path guards (m9 / m10) + C4 scope-move markers", () => {
422
427
 
423
428
  it("C4: a transient marker-write failure on the query path is retried until it lands", async () => {
424
429
  const doc = await FrontierModel.create({name: "n", orgId: "org1", ownerId: "u1"});
425
- const originalCreate = SyncScopeMove.create.bind(SyncScopeMove);
426
430
  let attempts = 0;
427
- (SyncScopeMove as any).create = async (...args: any[]) => {
431
+ scopeMovePatch.create = async (...args) => {
428
432
  attempts += 1;
429
433
  if (attempts === 1) {
430
434
  throw new Error("transient marker write failure");
431
435
  }
432
- return originalCreate(...(args as Parameters<typeof originalCreate>));
436
+ return originalScopeMoveCreate(...args);
433
437
  };
434
438
  try {
435
439
  await FrontierModel.updateOne({_id: doc._id}, {$set: {orgId: "org2"}});
436
440
  } finally {
437
- (SyncScopeMove as any).create = originalCreate;
441
+ scopeMovePatch.create = originalScopeMoveCreate;
438
442
  }
439
443
  expect(attempts).toBe(2);
440
444
  const markers = await SyncScopeMove.find({entityId: String(doc._id)});
@@ -444,20 +448,19 @@ describe("C1 write-path guards (m9 / m10) + C4 scope-move markers", () => {
444
448
 
445
449
  it("C4: a transient marker-write failure on the save path is retried until it lands", async () => {
446
450
  const doc = await FrontierModel.create({name: "n", orgId: "org1", ownerId: "u1"});
447
- const originalCreate = SyncScopeMove.create.bind(SyncScopeMove);
448
451
  let attempts = 0;
449
- (SyncScopeMove as any).create = async (...args: any[]) => {
452
+ scopeMovePatch.create = async (...args) => {
450
453
  attempts += 1;
451
454
  if (attempts === 1) {
452
455
  throw new Error("transient marker write failure");
453
456
  }
454
- return originalCreate(...(args as Parameters<typeof originalCreate>));
457
+ return originalScopeMoveCreate(...args);
455
458
  };
456
459
  try {
457
460
  doc.orgId = "org2";
458
461
  await doc.save();
459
462
  } finally {
460
- (SyncScopeMove as any).create = originalCreate;
463
+ scopeMovePatch.create = originalScopeMoveCreate;
461
464
  }
462
465
  expect(attempts).toBe(2);
463
466
  const markers = await SyncScopeMove.find({entityId: String(doc._id)});
@@ -467,9 +470,8 @@ describe("C1 write-path guards (m9 / m10) + C4 scope-move markers", () => {
467
470
 
468
471
  it("C4: an exhausted marker-write retry is logged, never failing the committed write", async () => {
469
472
  const doc = await FrontierModel.create({name: "n", orgId: "org1", ownerId: "u1"});
470
- const originalCreate = SyncScopeMove.create.bind(SyncScopeMove);
471
473
  let attempts = 0;
472
- (SyncScopeMove as any).create = async () => {
474
+ scopeMovePatch.create = async () => {
473
475
  attempts += 1;
474
476
  throw new Error("permanent marker write failure");
475
477
  };
@@ -477,7 +479,7 @@ describe("C1 write-path guards (m9 / m10) + C4 scope-move markers", () => {
477
479
  // The document write already committed — a marker failure must not surface as an error.
478
480
  await FrontierModel.updateOne({_id: doc._id}, {$set: {orgId: "org2"}});
479
481
  } finally {
480
- (SyncScopeMove as any).create = originalCreate;
482
+ scopeMovePatch.create = originalScopeMoveCreate;
481
483
  }
482
484
  expect(attempts).toBe(SCOPE_MOVE_MARKER_ATTEMPTS);
483
485
  expect(await SyncScopeMove.countDocuments({entityId: String(doc._id)})).toBe(0);
@@ -1,13 +1,11 @@
1
- // noExplicitAny: test model typing
2
- // biome-ignore-all lint/suspicious/noExplicitAny: test model typing
3
1
  import {beforeEach, describe, expect, it} from "bun:test";
4
2
  import type express from "express";
5
- import {model, Schema} from "mongoose";
3
+ import {type Model, model, Schema} from "mongoose";
6
4
  import supertest from "supertest";
7
5
  import type TestAgent from "supertest/lib/agent";
8
6
  import type {ModelRouterOptions} from "../api";
9
- import {addAuthRoutes, setupAuth, type User} from "../auth";
10
- import {Permissions} from "../permissions";
7
+ import {type UserModel as AuthUserModel, addAuthRoutes, setupAuth, type User} from "../auth";
8
+ import {Permissions, type RESTMethod} from "../permissions";
11
9
  import {createdUpdatedPlugin, type IsDeleted, isDeletedPlugin} from "../plugins";
12
10
  import {DEFAULT_IGNORED_COLLECTIONS} from "../realtime/changeStreamWatcher";
13
11
  import {authAsUser, getBaseServer, setupDb, UserModel} from "../tests";
@@ -36,6 +34,13 @@ interface PhaseCTodo extends IsDeleted {
36
34
  _syncSeq?: number;
37
35
  }
38
36
 
37
+ interface SnapshotEntity {
38
+ id: string;
39
+ seq: number;
40
+ deleted: boolean;
41
+ data: {title?: string} | null;
42
+ }
43
+
39
44
  const phaseCTodoSchema = new Schema<PhaseCTodo>({
40
45
  ownerId: {description: "The owner", type: String},
41
46
  title: {description: "The title", required: true, type: String},
@@ -83,7 +88,7 @@ phaseCProjectSchema.plugin(createdUpdatedPlugin);
83
88
  phaseCProjectSchema.plugin(syncPlugin);
84
89
  const PhaseCProjectModel = model<PhaseCProject>("SyncPhaseCProject", phaseCProjectSchema);
85
90
 
86
- const authedOptions = {
91
+ const authedOptions: ModelRouterOptions<unknown> = {
87
92
  permissions: {
88
93
  create: [Permissions.IsAuthenticated],
89
94
  delete: [Permissions.IsAuthenticated],
@@ -91,7 +96,7 @@ const authedOptions = {
91
96
  read: [Permissions.IsAuthenticated],
92
97
  update: [Permissions.IsAuthenticated],
93
98
  },
94
- } as unknown as ModelRouterOptions<any>;
99
+ };
95
100
 
96
101
  // Per-user tenant membership, mutable so join tests can extend it.
97
102
  const userOrgs = new Map<string, string[]>();
@@ -114,19 +119,19 @@ describe("Phase C sync routes", () => {
114
119
  clearSyncRegistry();
115
120
  registerSync({
116
121
  config: {scope: {type: "owner"}},
117
- model: PhaseCTodoModel as any,
122
+ model: PhaseCTodoModel as unknown as Model<unknown>,
118
123
  options: authedOptions,
119
124
  routePath: "/phaseCTodos",
120
125
  });
121
126
  registerSync({
122
127
  config: {scope: {field: "orgId", type: "tenant"}},
123
- model: PhaseCProjectModel as any,
128
+ model: PhaseCProjectModel as unknown as Model<unknown>,
124
129
  options: authedOptions,
125
130
  routePath: "/phaseCProjects",
126
131
  });
127
132
  registerSync({
128
133
  config: {scope: {type: "owner"}},
129
- model: PhaseCNoteModel as any,
134
+ model: PhaseCNoteModel as unknown as Model<unknown>,
130
135
  options: authedOptions,
131
136
  routePath: "/phaseCNotes",
132
137
  });
@@ -141,8 +146,8 @@ describe("Phase C sync routes", () => {
141
146
  ]);
142
147
 
143
148
  app = getBaseServer();
144
- setupAuth(app as any, UserModel as any);
145
- addAuthRoutes(app as any, UserModel as any);
149
+ setupAuth(app, UserModel as unknown as AuthUserModel);
150
+ addAuthRoutes(app, UserModel as unknown as AuthUserModel);
146
151
  new SyncApp({
147
152
  getUserScopes: (user: User, entry: SyncRegistryEntry) => {
148
153
  // Custom-scoped entries (used by the $or snapshotFilter test) resolve their
@@ -166,7 +171,7 @@ describe("Phase C sync routes", () => {
166
171
  describe("C2 — per-stream cursors and /sync/streams", () => {
167
172
  it("GET /sync/streams returns owner + tenant streams reflecting memberships", async () => {
168
173
  const res = await agent.get("/sync/streams").expect(200);
169
- const streams: string[] = res.body.streams.map((s: any) => s.stream);
174
+ const streams: string[] = res.body.streams.map((s: {stream: string}) => s.stream);
170
175
  expect(streams).toContain(ownerStream());
171
176
  expect(streams).toContain("phaseCProjects|tenant:org1");
172
177
  expect(streams).toContain("phaseCProjects|tenant:org2");
@@ -209,13 +214,15 @@ describe("Phase C sync routes", () => {
209
214
 
210
215
  it("reflects a tenant join in /sync/streams (new stream becomes available)", async () => {
211
216
  let res = await agent.get("/sync/streams").expect(200);
212
- expect(res.body.streams.map((s: any) => s.stream)).not.toContain(
217
+ expect(res.body.streams.map((s: {stream: string}) => s.stream)).not.toContain(
213
218
  "phaseCProjects|tenant:org3"
214
219
  );
215
220
  // Join org3.
216
221
  userOrgs.set(notAdminId, ["org1", "org2", "org3"]);
217
222
  res = await agent.get("/sync/streams").expect(200);
218
- expect(res.body.streams.map((s: any) => s.stream)).toContain("phaseCProjects|tenant:org3");
223
+ expect(res.body.streams.map((s: {stream: string}) => s.stream)).toContain(
224
+ "phaseCProjects|tenant:org3"
225
+ );
219
226
  // And the newly-joined stream is now snapshottable.
220
227
  await PhaseCProjectModel.create({orgId: "org3", title: "joined"});
221
228
  const snap = await agent
@@ -240,7 +247,7 @@ describe("Phase C sync routes", () => {
240
247
  ownerId: notAdminId,
241
248
  title: `legacy-${String(i).padStart(4, "0")}`,
242
249
  }));
243
- await PhaseCTodoModel.collection.insertMany(legacy as any);
250
+ await PhaseCTodoModel.collection.insertMany(legacy as unknown as PhaseCTodo[]);
244
251
  // A couple of modern (stamped) docs after the legacy stratum.
245
252
  await PhaseCTodoModel.create({ownerId: notAdminId, title: "modern-1"});
246
253
  await PhaseCTodoModel.create({ownerId: notAdminId, title: "modern-2"});
@@ -284,14 +291,14 @@ describe("Phase C sync routes", () => {
284
291
  await PhaseCTodoModel.collection.insertMany([
285
292
  {deleted: false, ownerId: notAdminId, title: "legacy-a"},
286
293
  {deleted: false, ownerId: notAdminId, title: "legacy-b"},
287
- ] as any);
294
+ ] as unknown as PhaseCTodo[]);
288
295
  await PhaseCTodoModel.create({ownerId: notAdminId, title: "stamped"});
289
296
 
290
297
  const page1 = await agent
291
298
  .get(`/sync/snapshot?stream=${enc(ownerStream())}&limit=10`)
292
299
  .expect(200);
293
300
  // First page is the legacy stratum (seq 0), with a legacyCursor.
294
- expect(page1.body.entities.every((e: any) => e.seq === 0)).toBe(true);
301
+ expect(page1.body.entities.every((e: SnapshotEntity) => e.seq === 0)).toBe(true);
295
302
  expect(page1.body.legacyCursor).toBeDefined();
296
303
  expect(page1.body.hasMore).toBe(true);
297
304
 
@@ -304,7 +311,7 @@ describe("Phase C sync routes", () => {
304
311
  .expect(200);
305
312
  // Legacy stratum exhausted; falls through to seq paging (no legacyCursor).
306
313
  expect(page2.body.legacyCursor).toBeUndefined();
307
- const stamped = page2.body.entities.find((e: any) => e.data?.title === "stamped");
314
+ const stamped = page2.body.entities.find((e: SnapshotEntity) => e.data?.title === "stamped");
308
315
  expect(stamped?.seq).toBe(1);
309
316
  });
310
317
 
@@ -322,7 +329,7 @@ describe("Phase C sync routes", () => {
322
329
  deleted: false,
323
330
  ownerId: notAdminId,
324
331
  title: `legacy note ${i}`,
325
- })) as any
332
+ })) as unknown as PhaseCNote[]
326
333
  );
327
334
  await PhaseCNoteModel.create({
328
335
  _id: "note-modern",
@@ -364,7 +371,7 @@ describe("Phase C sync routes", () => {
364
371
  it("Task 9.14: 400s (not 500s) on a malformed legacyCursor for an ObjectId-keyed model", async () => {
365
372
  await PhaseCTodoModel.collection.insertMany([
366
373
  {deleted: false, ownerId: notAdminId, title: "legacy-a"},
367
- ] as any);
374
+ ] as unknown as PhaseCTodo[]);
368
375
  await agent
369
376
  .get(`/sync/snapshot?stream=${enc(ownerStream())}&legacyCursor=not-an-object-id`)
370
377
  .expect(400);
@@ -427,21 +434,21 @@ describe("Phase C sync routes", () => {
427
434
  clearSyncRegistry();
428
435
  registerSync({
429
436
  config: {scope: {type: "owner"}},
430
- model: PhaseCTodoModel as any,
437
+ model: PhaseCTodoModel as unknown as Model<unknown>,
431
438
  options: {
432
439
  ...authedOptions,
433
440
  permissions: {
434
- ...(authedOptions as any).permissions,
441
+ ...authedOptions.permissions,
435
442
  read: [
436
- (_method: any, _user: any, doc?: any) => {
443
+ (_method: RESTMethod, _user?: User, doc?: unknown) => {
437
444
  if (!doc) {
438
445
  return true;
439
446
  }
440
- return !String(doc.title).endsWith("-secret");
447
+ return !String((doc as PhaseCTodo).title).endsWith("-secret");
441
448
  },
442
449
  ],
443
450
  },
444
- } as unknown as ModelRouterOptions<any>,
451
+ } as unknown as ModelRouterOptions<unknown>,
445
452
  routePath: "/phaseCTodos",
446
453
  });
447
454
 
@@ -450,7 +457,7 @@ describe("Phase C sync routes", () => {
450
457
  await PhaseCTodoModel.create({ownerId: notAdminId, title: "visible-2"});
451
458
 
452
459
  const res = await agent.get(`/sync/snapshot?stream=${enc(ownerStream())}`).expect(200);
453
- const titles = res.body.entities.map((e: any) => e.data.title);
460
+ const titles = res.body.entities.map((e: SnapshotEntity) => e.data.title);
454
461
  expect(titles).toEqual(["visible-1", "visible-2"]);
455
462
  // The cursor advanced past the denied doc (seq 3), so it is never re-fetched.
456
463
  expect(res.body.cursor).toBe(3);
@@ -461,13 +468,13 @@ describe("Phase C sync routes", () => {
461
468
  clearSyncRegistry();
462
469
  registerSync({
463
470
  config: {scope: {type: "owner"}},
464
- model: PhaseCTodoModel as any,
471
+ model: PhaseCTodoModel as unknown as Model<unknown>,
465
472
  options: {
466
473
  ...authedOptions,
467
474
  permissions: {
468
- ...(authedOptions as any).permissions,
475
+ ...authedOptions.permissions,
469
476
  read: [
470
- (_method: any, _user: any, doc?: any) => {
477
+ (_method: RESTMethod, _user?: User, doc?: unknown) => {
471
478
  if (!doc) {
472
479
  return true;
473
480
  }
@@ -475,7 +482,7 @@ describe("Phase C sync routes", () => {
475
482
  },
476
483
  ],
477
484
  },
478
- } as unknown as ModelRouterOptions<any>,
485
+ } as unknown as ModelRouterOptions<unknown>,
479
486
  routePath: "/phaseCTodos",
480
487
  });
481
488
 
@@ -520,7 +527,7 @@ describe("Phase C sync routes", () => {
520
527
  scope: (doc: Record<string, unknown>) => String(doc.ownerId),
521
528
  snapshotFilter: () => ({$or: [{ownerId: notAdminId}, {ownerId: "shared"}]}),
522
529
  },
523
- model: PhaseCTodoModel as any,
530
+ model: PhaseCTodoModel as unknown as Model<unknown>,
524
531
  options: authedOptions,
525
532
  routePath: "/phaseCTodos",
526
533
  });
@@ -533,14 +540,16 @@ describe("Phase C sync routes", () => {
533
540
 
534
541
  const customStream = `phaseCTodos|custom:${notAdminId}`;
535
542
  const res = await agent.get(`/sync/snapshot?stream=${enc(customStream)}`).expect(200);
536
- const byTitle = new Map(res.body.entities.map((e: any) => [e.id, e]));
543
+ const byTitle = new Map<string, SnapshotEntity>(
544
+ res.body.entities.map((e: SnapshotEntity) => [e.id, e])
545
+ );
537
546
  // "other" is excluded by the $or filter; "mine" appears as a tombstone (data null).
538
547
  const titles = res.body.entities
539
- .filter((e: any) => !e.deleted)
540
- .map((e: any) => e.data.title)
548
+ .filter((e: SnapshotEntity) => !e.deleted)
549
+ .map((e: SnapshotEntity) => e.data.title)
541
550
  .sort();
542
551
  expect(titles).toEqual(["shared"]);
543
- const tombstone = byTitle.get(String(mine._id)) as any;
552
+ const tombstone = byTitle.get(String(mine._id));
544
553
  expect(tombstone?.deleted).toBe(true);
545
554
  expect(tombstone?.data).toBeNull();
546
555
  });
@@ -610,14 +619,14 @@ describe("Phase C sync routes", () => {
610
619
  clearSyncRegistry();
611
620
  registerSync({
612
621
  config: {scope: {type: "owner"}},
613
- model: PhaseCTodoModel as any,
622
+ model: PhaseCTodoModel as unknown as Model<unknown>,
614
623
  options: {
615
624
  ...authedOptions,
616
- responseHandler: (value: any, method: string) => {
625
+ responseHandler: async (value: {title?: string}, method: string) => {
617
626
  seenMethods.push(method);
618
627
  return method === "read" ? {shape: "read", title: value.title} : value;
619
628
  },
620
- } as unknown as ModelRouterOptions<any>,
629
+ } as unknown as ModelRouterOptions<unknown>,
621
630
  routePath: "/phaseCTodos",
622
631
  });
623
632
  await PhaseCTodoModel.create({ownerId: notAdminId, title: "rh"});
@@ -631,7 +640,7 @@ describe("Phase C sync routes", () => {
631
640
  clearSyncRegistry();
632
641
  registerSync({
633
642
  config: {scope: {type: "owner"}},
634
- model: PhaseCTodoModel as any,
643
+ model: PhaseCTodoModel as unknown as Model<unknown>,
635
644
  options: authedOptions,
636
645
  routePath: "/dupTag",
637
646
  });
@@ -641,7 +650,7 @@ describe("Phase C sync routes", () => {
641
650
  expect(() =>
642
651
  registerSync({
643
652
  config: {scope: {field: "orgId", type: "tenant"}},
644
- model: PhaseCProjectModel as any,
653
+ model: PhaseCProjectModel as unknown as Model<unknown>,
645
654
  options: authedOptions,
646
655
  routePath: "/dupTag",
647
656
  })
@@ -700,11 +709,13 @@ describe("Phase C sync routes", () => {
700
709
  const rebootstrap = await agent
701
710
  .get(`/sync/snapshot?stream=${enc(stream)}&cursor=0`)
702
711
  .expect(200);
703
- const ids = rebootstrap.body.entities.map((e: any) => e.id).sort();
712
+ const ids = rebootstrap.body.entities.map((e: SnapshotEntity) => e.id).sort();
704
713
  expect(ids).toEqual(
705
714
  [String(keep._id), String((await PhaseCTodoModel.findOne({title: "later"}))?._id)].sort()
706
715
  );
707
- expect(rebootstrap.body.entities.some((e: any) => e.id === String(doomed._id))).toBe(false);
716
+ expect(
717
+ rebootstrap.body.entities.some((e: SnapshotEntity) => e.id === String(doomed._id))
718
+ ).toBe(false);
708
719
  });
709
720
 
710
721
  it("a live never-deleted early doc no longer pins the retention floor", async () => {