@terreno/api 57.3.0 → 57.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (293) hide show
  1. package/.ai/skills/mongoose-schema-safety/SKILL.md +23 -10
  2. package/README.md +6 -0
  3. package/dist/adminTypes.d.ts +7 -0
  4. package/dist/adminTypes.js +6 -1
  5. package/dist/api.d.ts +10 -0
  6. package/dist/api.js +99 -36
  7. package/dist/audit/auditApp.d.ts +30 -0
  8. package/dist/audit/auditApp.js +155 -0
  9. package/dist/audit/auditEventModel.d.ts +29 -0
  10. package/dist/audit/auditEventModel.js +102 -0
  11. package/dist/audit/cloudTasksEnqueue.d.ts +32 -0
  12. package/dist/audit/cloudTasksEnqueue.js +162 -0
  13. package/dist/audit/diff.d.ts +10 -0
  14. package/dist/audit/diff.js +230 -0
  15. package/dist/audit/processQueue.d.ts +6 -0
  16. package/dist/audit/processQueue.js +101 -0
  17. package/dist/audit/rbacSink.d.ts +2 -0
  18. package/dist/audit/rbacSink.js +82 -0
  19. package/dist/audit/record.d.ts +56 -0
  20. package/dist/audit/record.js +373 -0
  21. package/dist/betterAuth.d.ts +6 -0
  22. package/dist/betterAuthSetup.js +1 -1
  23. package/dist/collectionRegistry.d.ts +3 -1
  24. package/dist/collectionRegistry.js +25 -0
  25. package/dist/index.d.ts +26 -1
  26. package/dist/index.js +48 -2
  27. package/dist/mcp/query.d.ts +0 -13
  28. package/dist/mcp/query.js +8 -8
  29. package/dist/migrations/fixtures/all-down/20260910120000-one.d.ts +4 -0
  30. package/dist/migrations/fixtures/all-down/20260910120000-one.js +49 -0
  31. package/dist/migrations/fixtures/all-down/20260910120001-two.d.ts +4 -0
  32. package/dist/migrations/fixtures/all-down/20260910120001-two.js +49 -0
  33. package/dist/migrations/fixtures/bad-id/20260910120000-mismatch.d.ts +3 -0
  34. package/dist/migrations/fixtures/bad-id/20260910120000-mismatch.js +45 -0
  35. package/dist/migrations/fixtures/bad-name/not-a-migration.d.ts +3 -0
  36. package/dist/migrations/fixtures/bad-name/not-a-migration.js +45 -0
  37. package/dist/migrations/fixtures/missing-up/20260910120000-noup.d.ts +2 -0
  38. package/dist/migrations/fixtures/missing-up/20260910120000-noup.js +5 -0
  39. package/dist/migrations/fixtures/valid/20260910120000-alpha.d.ts +3 -0
  40. package/dist/migrations/fixtures/valid/20260910120000-alpha.js +45 -0
  41. package/dist/migrations/fixtures/valid/20260910120001-beta.d.ts +4 -0
  42. package/dist/migrations/fixtures/valid/20260910120001-beta.js +49 -0
  43. package/dist/migrations/generate.d.ts +17 -0
  44. package/dist/migrations/generate.js +277 -0
  45. package/dist/migrations/load.d.ts +20 -0
  46. package/dist/migrations/load.js +236 -0
  47. package/dist/migrations/lock.d.ts +13 -0
  48. package/dist/migrations/lock.js +145 -0
  49. package/dist/migrations/runner.d.ts +42 -0
  50. package/dist/migrations/runner.js +503 -0
  51. package/dist/migrations/schemaCatalog.d.ts +44 -0
  52. package/dist/migrations/schemaCatalog.js +326 -0
  53. package/dist/migrations/types.d.ts +87 -0
  54. package/dist/migrations/types.js +7 -0
  55. package/dist/models/notification.d.ts +2 -0
  56. package/dist/models/notification.js +62 -0
  57. package/dist/models/notificationPreference.d.ts +2 -0
  58. package/dist/models/notificationPreference.js +49 -0
  59. package/dist/notifications/notificationService.d.ts +40 -0
  60. package/dist/notifications/notificationService.js +323 -0
  61. package/dist/notifications/notificationsApp.d.ts +18 -0
  62. package/dist/notifications/notificationsApp.js +250 -0
  63. package/dist/notifications/notificationsBeforeSend.d.ts +14 -0
  64. package/dist/notifications/notificationsBeforeSend.js +77 -0
  65. package/dist/openApi.d.ts +1 -7
  66. package/dist/openApi.js +7 -6
  67. package/dist/openApiBuilder.d.ts +14 -3
  68. package/dist/openApiValidator.d.ts +13 -1
  69. package/dist/openApiValidator.js +200 -36
  70. package/dist/orgs/orgContext.d.ts +23 -0
  71. package/dist/orgs/orgContext.js +198 -0
  72. package/dist/orgs/orgPermissions.d.ts +4 -0
  73. package/dist/orgs/orgPermissions.js +77 -0
  74. package/dist/orgs/orgPlugin.d.ts +13 -0
  75. package/dist/orgs/orgPlugin.js +84 -0
  76. package/dist/orgs/organizationModel.d.ts +13 -0
  77. package/dist/orgs/organizationModel.js +301 -0
  78. package/dist/orgs/organizationSettings.d.ts +19 -0
  79. package/dist/orgs/organizationSettings.js +120 -0
  80. package/dist/orgs/orgsApp.d.ts +28 -0
  81. package/dist/orgs/orgsApp.js +678 -0
  82. package/dist/permissions.d.ts +7 -13
  83. package/dist/permissions.js +8 -31
  84. package/dist/rateLimit/middleware.d.ts +0 -8
  85. package/dist/rateLimit/middleware.js +2 -3
  86. package/dist/rateLimit/mongoStore.d.ts +1 -0
  87. package/dist/rateLimit/mongoStore.js +1 -0
  88. package/dist/rateLimit/policies.d.ts +0 -4
  89. package/dist/rateLimit/policies.js +5 -7
  90. package/dist/rateLimit/redisStore.d.ts +1 -0
  91. package/dist/rateLimit/redisStore.js +1 -0
  92. package/dist/rbac/access.js +30 -13
  93. package/dist/rbac/membershipOrgAdminSource.d.ts +6 -0
  94. package/dist/rbac/membershipOrgAdminSource.js +122 -0
  95. package/dist/rbac/modelRouterAccess.d.ts +3 -0
  96. package/dist/rbac/modelRouterAccess.js +3 -0
  97. package/dist/rbac/resolve.js +60 -31
  98. package/dist/rbac/roleModel.d.ts +2 -5
  99. package/dist/rbac/roleModel.js +18 -4
  100. package/dist/rbac/statements.d.ts +10 -1
  101. package/dist/rbac/statements.js +19 -2
  102. package/dist/rbac/types.d.ts +5 -0
  103. package/dist/realtime/changeStreamWatcher.d.ts +10 -4
  104. package/dist/realtime/changeStreamWatcher.js +110 -64
  105. package/dist/realtime/deprecation.d.ts +1 -0
  106. package/dist/realtime/deprecation.js +1 -0
  107. package/dist/realtime/realtimeApp.d.ts +1 -0
  108. package/dist/realtime/realtimeApp.js +1 -0
  109. package/dist/schemaMetadata.js +16 -5
  110. package/dist/sync/adminBroadcastScope.d.ts +40 -0
  111. package/dist/sync/adminBroadcastScope.js +194 -0
  112. package/dist/sync/adminWindowAccess.d.ts +13 -0
  113. package/dist/sync/adminWindowAccess.js +96 -0
  114. package/dist/sync/adminWindowMutation.d.ts +88 -0
  115. package/dist/sync/adminWindowMutation.js +247 -0
  116. package/dist/sync/executors.d.ts +9 -3
  117. package/dist/sync/executors.js +190 -159
  118. package/dist/sync/mutationHandler.d.ts +5 -2
  119. package/dist/sync/mutationHandler.js +191 -71
  120. package/dist/sync/registry.js +4 -0
  121. package/dist/sync/routes.d.ts +13 -0
  122. package/dist/sync/routes.js +113 -56
  123. package/dist/sync/socketHandlers.d.ts +8 -2
  124. package/dist/sync/socketHandlers.js +144 -50
  125. package/dist/sync/streams.d.ts +2 -0
  126. package/dist/sync/streams.js +7 -1
  127. package/dist/sync/syncApp.d.ts +2 -1
  128. package/dist/sync/syncApp.js +2 -1
  129. package/dist/sync/syncBatch.d.ts +5 -2
  130. package/dist/sync/syncBatch.js +4 -4
  131. package/dist/sync/types.d.ts +18 -0
  132. package/dist/terrenoApp.d.ts +29 -0
  133. package/dist/terrenoApp.js +91 -54
  134. package/dist/tests/createTestData.d.ts +1 -3
  135. package/dist/tests/createTestData.js +3 -5
  136. package/dist/tests/models.d.ts +1 -0
  137. package/dist/tests/models.js +9 -2
  138. package/dist/tests/testHelper.d.ts +0 -5
  139. package/dist/tests/testHelper.js +2 -9
  140. package/dist/types/authToken.d.ts +3 -3
  141. package/dist/types/mcpServiceToken.d.ts +2 -2
  142. package/dist/types/membership.d.ts +23 -0
  143. package/dist/types/membership.js +2 -0
  144. package/dist/types/notification.d.ts +28 -0
  145. package/dist/types/notification.js +2 -0
  146. package/dist/types/notificationPreference.d.ts +20 -0
  147. package/dist/types/notificationPreference.js +2 -0
  148. package/dist/types/organization.d.ts +36 -0
  149. package/dist/types/organization.js +2 -0
  150. package/dist/webhooks/idempotency/webhookReceipt.d.ts +4 -49
  151. package/dist/webhooks/idempotency/webhookReceipt.js +7 -7
  152. package/dist/webhooks/rawBody.d.ts +1 -0
  153. package/dist/webhooks/rawBody.js +1 -0
  154. package/package.json +31 -25
  155. package/src/__snapshots__/openApi.test.ts.snap +192 -54
  156. package/src/__snapshots__/openApiBuilder.test.ts.snap +0 -18
  157. package/src/__snapshots__/schemaMetadata.test.ts.snap +0 -1
  158. package/src/adminTypes.ts +8 -0
  159. package/src/api.test.ts +39 -2
  160. package/src/api.ts +68 -0
  161. package/src/audit/auditApp.test.ts +243 -0
  162. package/src/audit/auditApp.ts +139 -0
  163. package/src/audit/auditEventModel.ts +156 -0
  164. package/src/audit/auditRouter.test.ts +456 -0
  165. package/src/audit/cloudTasksEnqueue.test.ts +124 -0
  166. package/src/audit/cloudTasksEnqueue.ts +104 -0
  167. package/src/audit/diff.ts +163 -0
  168. package/src/audit/processQueue.ts +69 -0
  169. package/src/audit/rbacSink.test.ts +86 -0
  170. package/src/audit/rbacSink.ts +42 -0
  171. package/src/audit/record.test.ts +402 -0
  172. package/src/audit/record.ts +328 -0
  173. package/src/auth.test.ts +1 -1
  174. package/src/betterAuth.ts +7 -0
  175. package/src/betterAuthSetup.test.ts +27 -0
  176. package/src/betterAuthSetup.ts +1 -0
  177. package/src/collectionRegistry.test.ts +8 -9
  178. package/src/collectionRegistry.ts +21 -1
  179. package/src/express.d.ts +2 -0
  180. package/src/expressServer.test.ts +50 -2
  181. package/src/index.ts +69 -0
  182. package/src/mcp/handlers.test.ts +275 -0
  183. package/src/mcp/query.ts +3 -3
  184. package/src/mcp/toolGenerator.test.ts +81 -0
  185. package/src/migrations/cli.test.ts +376 -0
  186. package/src/migrations/cli.ts +283 -0
  187. package/src/migrations/fixtures/all-down/20260910120000-one.ts +6 -0
  188. package/src/migrations/fixtures/all-down/20260910120001-two.ts +6 -0
  189. package/src/migrations/fixtures/bad-id/20260910120000-mismatch.ts +4 -0
  190. package/src/migrations/fixtures/bad-name/not-a-migration.ts +4 -0
  191. package/src/migrations/fixtures/missing-up/20260910120000-noup.ts +2 -0
  192. package/src/migrations/fixtures/valid/20260910120000-alpha.ts +4 -0
  193. package/src/migrations/fixtures/valid/20260910120001-beta.ts +6 -0
  194. package/src/migrations/generate.test.ts +333 -0
  195. package/src/migrations/generate.ts +216 -0
  196. package/src/migrations/load.test.ts +103 -0
  197. package/src/migrations/load.ts +124 -0
  198. package/src/migrations/lock.test.ts +133 -0
  199. package/src/migrations/lock.ts +118 -0
  200. package/src/migrations/runner.test.ts +504 -0
  201. package/src/migrations/runner.ts +358 -0
  202. package/src/migrations/schemaCatalog.test.ts +159 -0
  203. package/src/migrations/schemaCatalog.ts +262 -0
  204. package/src/migrations/types.ts +94 -0
  205. package/src/models/notification.ts +68 -0
  206. package/src/models/notificationPreference.ts +62 -0
  207. package/src/notifications/notificationService.ts +254 -0
  208. package/src/notifications/notificationsApp.test.ts +505 -0
  209. package/src/notifications/notificationsApp.ts +200 -0
  210. package/src/notifications/notificationsBeforeSend.ts +51 -0
  211. package/src/openApi.test.ts +0 -1
  212. package/src/openApi.ts +2 -1
  213. package/src/openApiBuilder.ts +14 -3
  214. package/src/openApiValidator.test.ts +221 -2
  215. package/src/openApiValidator.ts +218 -33
  216. package/src/orgs/orgAccessOptIn.test.ts +87 -0
  217. package/src/orgs/orgContext.test.ts +259 -0
  218. package/src/orgs/orgContext.ts +151 -0
  219. package/src/orgs/orgPermissions.test.ts +105 -0
  220. package/src/orgs/orgPermissions.ts +40 -0
  221. package/src/orgs/orgPlugin.test.ts +130 -0
  222. package/src/orgs/orgPlugin.ts +70 -0
  223. package/src/orgs/orgRbac.test.ts +267 -0
  224. package/src/orgs/orgSecurityDefects.test.ts +415 -0
  225. package/src/orgs/organizationModel.test.ts +205 -0
  226. package/src/orgs/organizationModel.ts +257 -0
  227. package/src/orgs/organizationSettings.test.ts +113 -0
  228. package/src/orgs/organizationSettings.ts +126 -0
  229. package/src/orgs/orgsApp.test.ts +382 -0
  230. package/src/orgs/orgsApp.ts +563 -0
  231. package/src/permissions.test.ts +62 -36
  232. package/src/permissions.ts +8 -30
  233. package/src/rateLimit/middleware.ts +1 -1
  234. package/src/rateLimit/mongoStore.ts +1 -0
  235. package/src/rateLimit/policies.ts +2 -2
  236. package/src/rateLimit/redisStore.ts +1 -0
  237. package/src/rbac/access.ts +11 -3
  238. package/src/rbac/membershipOrgAdminSource.ts +59 -0
  239. package/src/rbac/modelRouterAccess.ts +3 -0
  240. package/src/rbac/permissionUtils.test.ts +26 -5
  241. package/src/rbac/resolve.test.ts +34 -2
  242. package/src/rbac/resolve.ts +26 -7
  243. package/src/rbac/roleModel.test.ts +34 -1
  244. package/src/rbac/roleModel.ts +17 -1
  245. package/src/rbac/statements.test.ts +19 -0
  246. package/src/rbac/statements.ts +19 -1
  247. package/src/rbac/types.ts +5 -0
  248. package/src/realtime/changeStreamWatcher.ts +73 -33
  249. package/src/realtime/deprecation.ts +1 -0
  250. package/src/realtime/realtime.test.ts +357 -185
  251. package/src/realtime/realtimeApp.ts +1 -0
  252. package/src/schemaMetadata.test.ts +14 -0
  253. package/src/schemaMetadata.ts +5 -5
  254. package/src/sync/adminBroadcastConfig.test.ts +96 -0
  255. package/src/sync/adminBroadcastScope.test.ts +155 -0
  256. package/src/sync/adminBroadcastScope.ts +123 -0
  257. package/src/sync/adminWindowAccess.test.ts +57 -0
  258. package/src/sync/adminWindowAccess.ts +32 -0
  259. package/src/sync/adminWindowMutation.test.ts +450 -0
  260. package/src/sync/adminWindowMutation.ts +283 -0
  261. package/src/sync/executors.ts +33 -6
  262. package/src/sync/mutationHandler.test.ts +277 -1
  263. package/src/sync/mutationHandler.ts +171 -29
  264. package/src/sync/registry.ts +4 -0
  265. package/src/sync/routes.ts +52 -8
  266. package/src/sync/socketHandlers.ts +154 -58
  267. package/src/sync/streams.ts +6 -0
  268. package/src/sync/sync.test.ts +3 -2
  269. package/src/sync/syncApp.ts +2 -1
  270. package/src/sync/syncBatch.ts +7 -2
  271. package/src/sync/syncRoutes.test.ts +297 -3
  272. package/src/sync/syncSocket.test.ts +229 -0
  273. package/src/sync/types.ts +20 -0
  274. package/src/terrenoApp.migrations.test.ts +114 -0
  275. package/src/terrenoApp.test.ts +41 -0
  276. package/src/terrenoApp.ts +94 -31
  277. package/src/tests/createTestData.ts +2 -2
  278. package/src/tests/models.ts +10 -2
  279. package/src/tests/testHelper.ts +1 -7
  280. package/src/types/authToken.ts +2 -4
  281. package/src/types/mcpServiceToken.ts +1 -7
  282. package/src/types/membership.ts +48 -0
  283. package/src/types/notification.ts +34 -0
  284. package/src/types/notificationPreference.ts +28 -0
  285. package/src/types/organization.ts +49 -0
  286. package/src/webhooks/idempotency/webhookReceipt.ts +4 -7
  287. package/src/webhooks/rawBody.test.ts +33 -0
  288. package/src/webhooks/rawBody.ts +1 -0
  289. package/tsconfig.json +1 -1
  290. package/tsconfig.typedoc.json +2 -1
  291. package/dist/vendor/wesleytodd-openapi/lib/convert-yaml.d.ts +0 -2
  292. package/dist/vendor/wesleytodd-openapi/lib/convert-yaml.js +0 -13
  293. package/src/vendor/wesleytodd-openapi/lib/convert-yaml.js +0 -13
@@ -95,6 +95,8 @@ var errors_1 = require("../errors");
95
95
  var logger_1 = require("../logger");
96
96
  var permissions_1 = require("../permissions");
97
97
  var plugins_1 = require("../plugins");
98
+ var adminBroadcastScope_1 = require("./adminBroadcastScope");
99
+ var adminWindowAccess_1 = require("./adminWindowAccess");
98
100
  var models_1 = require("./models");
99
101
  var registry_1 = require("./registry");
100
102
  var serialize_1 = require("./serialize");
@@ -731,17 +733,17 @@ var addSyncRoutes = function (app, options) {
731
733
  });
732
734
  }); }));
733
735
  router.get("/sync/entities", (0, auth_1.authenticateMiddleware)(), (0, api_1.asyncHandler)(function (req, res) { return __awaiter(void 0, void 0, void 0, function () {
734
- var user, collection, idsParam, ids, entry, memberStreams, memberSet, queryFilterResult, deniedResponse, model, castIds, docs, entities, _a, _b, doc, allowed, docObj, stream, isTombstone, _c, _d, _e, e_5_1, response;
735
- var e_5, _f, _g;
736
- var _h, _j;
737
- return __generator(this, function (_k) {
738
- switch (_k.label) {
736
+ var user, collection, idsParam, ids, entry, isAdminWindow, _a, adminScope, _b, deniedResponse, memberStreams, _c, memberSet, queryFilterResult, _d, _e, deniedResponse, model, castIds, docs, entities, _f, _g, doc, allowed, _h, docObj, stream, isTombstone, _j, _k, _l, e_5_1, response;
737
+ var e_5, _m, _o;
738
+ var _p, _q;
739
+ return __generator(this, function (_r) {
740
+ switch (_r.label) {
739
741
  case 0:
740
742
  user = req.user;
741
743
  if (!user) {
742
744
  throw new errors_1.APIError({ status: 401, title: "Authentication required" });
743
745
  }
744
- collection = String((_h = req.query.collection) !== null && _h !== void 0 ? _h : "").trim();
746
+ collection = String((_p = req.query.collection) !== null && _p !== void 0 ? _p : "").trim();
745
747
  if (!collection) {
746
748
  throw new errors_1.APIError({ status: 400, title: "collection query parameter is required" });
747
749
  }
@@ -773,23 +775,68 @@ var addSyncRoutes = function (app, options) {
773
775
  }
774
776
  return [4 /*yield*/, (0, permissions_1.checkPermissions)("list", entry.options.permissions.list, user)];
775
777
  case 1:
776
- if (!(_k.sent())) {
778
+ if (!(_r.sent())) {
777
779
  throw new errors_1.APIError({
778
780
  status: 403,
779
781
  title: "Access to sync entities for ".concat(collection, " denied for ").concat(user.id),
780
782
  });
781
783
  }
782
- return [4 /*yield*/, (0, streams_1.resolveUserStreamsForEntry)({
783
- entry: entry,
784
- getUserScopes: options.getUserScopes,
784
+ _a = entry.config.adminBroadcast === true;
785
+ if (!_a) return [3 /*break*/, 3];
786
+ return [4 /*yield*/, (0, adminWindowAccess_1.canUseAdminBroadcastWindow)({
787
+ accessControl: options.accessControl,
788
+ canOpenAdminWindow: options.canOpenAdminWindow,
785
789
  user: user,
786
790
  })];
787
791
  case 2:
788
- memberStreams = _k.sent();
789
- memberSet = new Set(memberStreams);
790
- return [4 /*yield*/, resolveSyncQueryFilter({ entry: entry, user: user })];
792
+ _a = (_r.sent());
793
+ _r.label = 3;
791
794
  case 3:
792
- queryFilterResult = _k.sent();
795
+ isAdminWindow = _a;
796
+ adminScope = isAdminWindow ? (0, adminBroadcastScope_1.getAdminBroadcastScope)(entry.modelName) : undefined;
797
+ _b = adminScope;
798
+ if (!_b) return [3 /*break*/, 5];
799
+ return [4 /*yield*/, (0, adminBroadcastScope_1.canListAdminBroadcastScope)({ scope: adminScope, user: user })];
800
+ case 4:
801
+ _b = !(_r.sent());
802
+ _r.label = 5;
803
+ case 5:
804
+ if (_b) {
805
+ deniedResponse = { entities: [] };
806
+ return [2 /*return*/, res.json(deniedResponse)];
807
+ }
808
+ if (!isAdminWindow) return [3 /*break*/, 6];
809
+ _c = [];
810
+ return [3 /*break*/, 8];
811
+ case 6: return [4 /*yield*/, (0, streams_1.resolveUserStreamsForEntry)({
812
+ entry: entry,
813
+ getUserScopes: options.getUserScopes,
814
+ user: user,
815
+ })];
816
+ case 7:
817
+ _c = _r.sent();
818
+ _r.label = 8;
819
+ case 8:
820
+ memberStreams = _c;
821
+ memberSet = new Set(memberStreams);
822
+ if (!adminScope) return [3 /*break*/, 10];
823
+ return [4 /*yield*/, (0, adminBroadcastScope_1.resolveAdminBroadcastQueryFilter)({ scope: adminScope, user: user })];
824
+ case 9:
825
+ _d = _r.sent();
826
+ return [3 /*break*/, 14];
827
+ case 10:
828
+ if (!isAdminWindow) return [3 /*break*/, 11];
829
+ _e = { denied: false, filter: undefined };
830
+ return [3 /*break*/, 13];
831
+ case 11: return [4 /*yield*/, resolveSyncQueryFilter({ entry: entry, user: user })];
832
+ case 12:
833
+ _e = _r.sent();
834
+ _r.label = 13;
835
+ case 13:
836
+ _d = _e;
837
+ _r.label = 14;
838
+ case 14:
839
+ queryFilterResult = _d;
793
840
  if (queryFilterResult.denied) {
794
841
  deniedResponse = { entities: [] };
795
842
  return [2 /*return*/, res.json(deniedResponse)];
@@ -800,22 +847,30 @@ var addSyncRoutes = function (app, options) {
800
847
  queryFilter: queryFilterResult.filter,
801
848
  scopeFilter: { _id: { $in: castIds } },
802
849
  })), { deleted: { $in: [true, false] } }))];
803
- case 4:
804
- docs = _k.sent();
850
+ case 15:
851
+ docs = _r.sent();
805
852
  entities = [];
806
- _k.label = 5;
807
- case 5:
808
- _k.trys.push([5, 13, 14, 15]);
809
- _a = __values(docs), _b = _a.next();
810
- _k.label = 6;
811
- case 6:
812
- if (!!_b.done) return [3 /*break*/, 12];
813
- doc = _b.value;
814
- return [4 /*yield*/, (0, permissions_1.checkPermissions)("read", entry.options.permissions.read, user, doc)];
815
- case 7:
816
- allowed = _k.sent();
853
+ _r.label = 16;
854
+ case 16:
855
+ _r.trys.push([16, 27, 28, 29]);
856
+ _f = __values(docs), _g = _f.next();
857
+ _r.label = 17;
858
+ case 17:
859
+ if (!!_g.done) return [3 /*break*/, 26];
860
+ doc = _g.value;
861
+ if (!adminScope) return [3 /*break*/, 19];
862
+ return [4 /*yield*/, (0, permissions_1.checkPermissions)("read", adminScope.readPermissions, user, doc)];
863
+ case 18:
864
+ _h = _r.sent();
865
+ return [3 /*break*/, 21];
866
+ case 19: return [4 /*yield*/, (0, permissions_1.checkPermissions)("read", entry.options.permissions.read, user, doc)];
867
+ case 20:
868
+ _h = _r.sent();
869
+ _r.label = 21;
870
+ case 21:
871
+ allowed = _h;
817
872
  if (!allowed) {
818
- return [3 /*break*/, 11];
873
+ return [3 /*break*/, 25];
819
874
  }
820
875
  docObj = doc.toObject();
821
876
  stream = (0, streams_1.resolveStreamForDoc)({
@@ -823,41 +878,41 @@ var addSyncRoutes = function (app, options) {
823
878
  doc: docObj,
824
879
  scope: entry.config.scope,
825
880
  });
826
- if (!memberSet.has(stream)) {
827
- return [3 /*break*/, 11];
881
+ if (!isAdminWindow && !memberSet.has(stream)) {
882
+ return [3 /*break*/, 25];
828
883
  }
829
884
  isTombstone = Boolean(docObj.deleted);
830
- _d = (_c = entities).push;
831
- _g = {};
832
- if (!isTombstone) return [3 /*break*/, 8];
833
- _e = null;
834
- return [3 /*break*/, 10];
835
- case 8: return [4 /*yield*/, (0, exports.serializeSyncDoc)({ doc: doc, entry: entry, req: req })];
836
- case 9:
837
- _e = _k.sent();
838
- _k.label = 10;
839
- case 10:
840
- _d.apply(_c, [(_g.data = _e,
841
- _g.deleted = isTombstone,
842
- _g.id = String(doc._id),
843
- _g.seq = (_j = docObj._syncSeq) !== null && _j !== void 0 ? _j : 0,
844
- _g)]);
845
- _k.label = 11;
846
- case 11:
847
- _b = _a.next();
848
- return [3 /*break*/, 6];
849
- case 12: return [3 /*break*/, 15];
850
- case 13:
851
- e_5_1 = _k.sent();
885
+ _k = (_j = entities).push;
886
+ _o = {};
887
+ if (!isTombstone) return [3 /*break*/, 22];
888
+ _l = null;
889
+ return [3 /*break*/, 24];
890
+ case 22: return [4 /*yield*/, (0, exports.serializeSyncDoc)({ doc: doc, entry: entry, req: req })];
891
+ case 23:
892
+ _l = _r.sent();
893
+ _r.label = 24;
894
+ case 24:
895
+ _k.apply(_j, [(_o.data = _l,
896
+ _o.deleted = isTombstone,
897
+ _o.id = String(doc._id),
898
+ _o.seq = (_q = docObj._syncSeq) !== null && _q !== void 0 ? _q : 0,
899
+ _o)]);
900
+ _r.label = 25;
901
+ case 25:
902
+ _g = _f.next();
903
+ return [3 /*break*/, 17];
904
+ case 26: return [3 /*break*/, 29];
905
+ case 27:
906
+ e_5_1 = _r.sent();
852
907
  e_5 = { error: e_5_1 };
853
- return [3 /*break*/, 15];
854
- case 14:
908
+ return [3 /*break*/, 29];
909
+ case 28:
855
910
  try {
856
- if (_b && !_b.done && (_f = _a.return)) _f.call(_a);
911
+ if (_g && !_g.done && (_m = _f.return)) _m.call(_f);
857
912
  }
858
913
  finally { if (e_5) throw e_5.error; }
859
914
  return [7 /*endfinally*/];
860
- case 15:
915
+ case 29:
861
916
  response = { entities: entities };
862
917
  return [2 /*return*/, res.json(response)];
863
918
  }
@@ -876,6 +931,7 @@ var addSyncRoutes = function (app, options) {
876
931
  mutation: req.body,
877
932
  req: req,
878
933
  scopeResolver: options.getUserScopes,
934
+ syncOptions: options,
879
935
  user: user,
880
936
  })];
881
937
  case 1:
@@ -903,6 +959,7 @@ var addSyncRoutes = function (app, options) {
903
959
  mutations: mutations,
904
960
  req: req,
905
961
  scopeResolver: options.getUserScopes,
962
+ syncOptions: options,
906
963
  user: user,
907
964
  })];
908
965
  case 1:
@@ -4,17 +4,23 @@ import type { SyncAppOptions } from "./routes";
4
4
  /**
5
5
  * Socket handlers for the SyncDB local-first protocol:
6
6
  *
7
- * - `sync:subscribe {collections}` / `sync:unsubscribe {collections}` — resolves the
7
+ * - `sync:subscribe {collections, mode?}` / `sync:unsubscribe {collections}` — resolves the
8
8
  * caller's streams from the sync registry scope config and joins/leaves `sync:{stream}`
9
9
  * rooms. Owner scopes always use the socket's own userId (never a client-supplied one);
10
10
  * tenant and custom scopes resolve stream values via `SyncAppOptions.getUserScopes`.
11
+ * `mode: "window"` joins `{collection}|admin` only (requires `adminBroadcast` and
12
+ * admin panel access: `admin:access` when `SyncApp` has `accessControl`, else
13
+ * `user.admin`). When AdminApp has registered a broadcast scope, list
14
+ * permission for that model is required as well. Confirms with
15
+ * `sync:subscribed {mode: "window"}` without dumping snapshot pages.
11
16
  * Sync deltas fan out through these dedicated `sync:{stream}` rooms rather than the
12
17
  * legacy realtime rooms so the two event families never overlap.
13
18
  * - `sync:mutate` — applies a mutation through `applySyncMutation` and replies with
14
19
  * `sync:ack {mutationId, id, seq}` or `sync:nack {mutationId, code, ...}`; when the
15
20
  * client supplied a Socket.io ack callback it also receives `{ack}` / `{nack}`.
16
21
  * - `sync:error {collection, message}` — emitted for per-collection subscribe failures
17
- * (unknown collection, permission denied, missing scope resolver, cap exceeded).
22
+ * (unknown collection, permission denied, non-admin window subscribe, missing scope
23
+ * resolver, cap exceeded).
18
24
  *
19
25
  * ## Wiring
20
26
  *
@@ -60,25 +60,54 @@ var __values = (this && this.__values) || function(o) {
60
60
  Object.defineProperty(exports, "__esModule", { value: true });
61
61
  exports.installSyncSocketHandlers = exports.syncRoomForStream = exports.MAX_SYNC_SUBSCRIBE_ARRAY_LENGTH = exports.MAX_SYNC_COLLECTION_SUBSCRIPTIONS = void 0;
62
62
  var logger_1 = require("../logger");
63
+ var orgContext_1 = require("../orgs/orgContext");
63
64
  var permissions_1 = require("../permissions");
64
65
  var socketUser_1 = require("../realtime/socketUser");
66
+ var adminBroadcastScope_1 = require("./adminBroadcastScope");
67
+ var adminWindowAccess_1 = require("./adminWindowAccess");
65
68
  var registry_1 = require("./registry");
66
69
  var streams_1 = require("./streams");
67
70
  var syncBatch_1 = require("./syncBatch");
71
+ var requestFromOrganizationId = function (_a) {
72
+ var organizationId = _a.organizationId, user = _a.user;
73
+ var trimmed = organizationId === null || organizationId === void 0 ? void 0 : organizationId.trim();
74
+ if (!trimmed) {
75
+ return { user: user };
76
+ }
77
+ return {
78
+ header: function (name) {
79
+ return String(name).toLowerCase() === orgContext_1.ORGANIZATION_ID_HEADER ? trimmed : undefined;
80
+ },
81
+ user: user,
82
+ };
83
+ };
84
+ var organizationIdFromPayload = function (payload) {
85
+ if (typeof payload !== "object" || payload === null) {
86
+ return undefined;
87
+ }
88
+ var organizationId = payload.organizationId;
89
+ return typeof organizationId === "string" ? organizationId : undefined;
90
+ };
68
91
  /**
69
92
  * Socket handlers for the SyncDB local-first protocol:
70
93
  *
71
- * - `sync:subscribe {collections}` / `sync:unsubscribe {collections}` — resolves the
94
+ * - `sync:subscribe {collections, mode?}` / `sync:unsubscribe {collections}` — resolves the
72
95
  * caller's streams from the sync registry scope config and joins/leaves `sync:{stream}`
73
96
  * rooms. Owner scopes always use the socket's own userId (never a client-supplied one);
74
97
  * tenant and custom scopes resolve stream values via `SyncAppOptions.getUserScopes`.
98
+ * `mode: "window"` joins `{collection}|admin` only (requires `adminBroadcast` and
99
+ * admin panel access: `admin:access` when `SyncApp` has `accessControl`, else
100
+ * `user.admin`). When AdminApp has registered a broadcast scope, list
101
+ * permission for that model is required as well. Confirms with
102
+ * `sync:subscribed {mode: "window"}` without dumping snapshot pages.
75
103
  * Sync deltas fan out through these dedicated `sync:{stream}` rooms rather than the
76
104
  * legacy realtime rooms so the two event families never overlap.
77
105
  * - `sync:mutate` — applies a mutation through `applySyncMutation` and replies with
78
106
  * `sync:ack {mutationId, id, seq}` or `sync:nack {mutationId, code, ...}`; when the
79
107
  * client supplied a Socket.io ack callback it also receives `{ack}` / `{nack}`.
80
108
  * - `sync:error {collection, message}` — emitted for per-collection subscribe failures
81
- * (unknown collection, permission denied, missing scope resolver, cap exceeded).
109
+ * (unknown collection, permission denied, non-admin window subscribe, missing scope
110
+ * resolver, cap exceeded).
82
111
  *
83
112
  * ## Wiring
84
113
  *
@@ -163,12 +192,13 @@ var installSyncSocketHandlers = function (_io, socket, options, handlerOptions)
163
192
  socket.data.syncSubscriptions = subscriptions;
164
193
  }
165
194
  socket.on("sync:subscribe", function (payload) { return __awaiter(void 0, void 0, void 0, function () {
166
- var collections, collections_1, collections_1_1, collection, entry, user, streams, rooms, rooms_1, rooms_1_1, room, e_1_1, e_2_1;
167
- var e_2, _a, e_1, _b;
168
- return __generator(this, function (_c) {
169
- switch (_c.label) {
195
+ var collections, isWindow, collections_1, collections_1_1, collection, entry, user, _a, adminScope, _b, streams, _c, rooms, rooms_1, rooms_1_1, room, e_1_1, e_2_1;
196
+ var e_2, _d, e_1, _e;
197
+ return __generator(this, function (_f) {
198
+ switch (_f.label) {
170
199
  case 0:
171
200
  collections = Array.isArray(payload === null || payload === void 0 ? void 0 : payload.collections) ? payload.collections : null;
201
+ isWindow = (payload === null || payload === void 0 ? void 0 : payload.mode) === "window";
172
202
  if (!collections) {
173
203
  return [2 /*return*/];
174
204
  }
@@ -181,20 +211,20 @@ var installSyncSocketHandlers = function (_io, socket, options, handlerOptions)
181
211
  });
182
212
  return [2 /*return*/];
183
213
  }
184
- _c.label = 1;
214
+ _f.label = 1;
185
215
  case 1:
186
- _c.trys.push([1, 16, 17, 18]);
216
+ _f.trys.push([1, 23, 24, 25]);
187
217
  collections_1 = __values(collections), collections_1_1 = collections_1.next();
188
- _c.label = 2;
218
+ _f.label = 2;
189
219
  case 2:
190
- if (!!collections_1_1.done) return [3 /*break*/, 15];
220
+ if (!!collections_1_1.done) return [3 /*break*/, 22];
191
221
  collection = collections_1_1.value;
192
222
  if (typeof collection !== "string" || collection.length === 0) {
193
- return [3 /*break*/, 14];
223
+ return [3 /*break*/, 21];
194
224
  }
195
225
  if (subscriptions.has(collection)) {
196
226
  // Already subscribed — idempotent.
197
- return [3 /*break*/, 14];
227
+ return [3 /*break*/, 21];
198
228
  }
199
229
  if (subscriptions.size >= exports.MAX_SYNC_COLLECTION_SUBSCRIPTIONS) {
200
230
  logInfo("[sync] User ".concat(userId, " hit sync collection subscription limit"));
@@ -202,83 +232,137 @@ var installSyncSocketHandlers = function (_io, socket, options, handlerOptions)
202
232
  collection: collection,
203
233
  message: "Sync subscription limit of ".concat(exports.MAX_SYNC_COLLECTION_SUBSCRIPTIONS, " collections reached"),
204
234
  });
205
- return [3 /*break*/, 14];
235
+ return [3 /*break*/, 21];
206
236
  }
207
237
  entry = (0, registry_1.findSyncEntryByCollectionTag)(collection);
208
238
  if (!entry) {
209
- socket.emit("sync:error", { collection: collection, message: "Unknown sync collection: ".concat(collection) });
210
- return [3 /*break*/, 14];
239
+ socket.emit("sync:error", {
240
+ collection: collection,
241
+ message: "Unknown sync collection: ".concat(collection),
242
+ });
243
+ return [3 /*break*/, 21];
211
244
  }
212
245
  return [4 /*yield*/, currentUser()];
213
246
  case 3:
214
- user = _c.sent();
247
+ user = _f.sent();
215
248
  if (!user) {
216
249
  socket.emit("sync:error", { collection: collection, message: "Authentication required" });
217
- return [3 /*break*/, 14];
250
+ return [3 /*break*/, 21];
218
251
  }
219
252
  return [4 /*yield*/, (0, permissions_1.checkPermissions)("list", entry.options.permissions.list, user)];
220
253
  case 4:
221
- if (!(_c.sent())) {
254
+ if (!(_f.sent())) {
222
255
  logInfo("[sync] User ".concat(userId, " denied sync subscription for ").concat(collection));
223
256
  socket.emit("sync:error", {
224
257
  collection: collection,
225
258
  message: "Access to sync collection ".concat(collection, " denied"),
226
259
  });
227
- return [3 /*break*/, 14];
260
+ return [3 /*break*/, 21];
228
261
  }
229
- return [4 /*yield*/, resolveUserStreams({ entry: entry, options: options, socket: socket, user: user })];
262
+ if (isWindow && entry.config.adminBroadcast !== true) {
263
+ socket.emit("sync:error", {
264
+ collection: collection,
265
+ message: "Window subscribe requires adminBroadcast on ".concat(collection),
266
+ });
267
+ return [3 /*break*/, 21];
268
+ }
269
+ _a = isWindow;
270
+ if (!_a) return [3 /*break*/, 6];
271
+ return [4 /*yield*/, (0, adminWindowAccess_1.canUseAdminBroadcastWindow)({
272
+ accessControl: options.accessControl,
273
+ canOpenAdminWindow: options.canOpenAdminWindow,
274
+ user: user,
275
+ })];
230
276
  case 5:
231
- streams = _c.sent();
277
+ _a = !(_f.sent());
278
+ _f.label = 6;
279
+ case 6:
280
+ if (_a) {
281
+ logInfo("[sync] User ".concat(userId, " denied window subscribe for ").concat(collection));
282
+ socket.emit("sync:error", {
283
+ collection: collection,
284
+ message: "Window subscribe requires admin panel access for ".concat(collection),
285
+ });
286
+ return [3 /*break*/, 21];
287
+ }
288
+ if (!isWindow) return [3 /*break*/, 9];
289
+ adminScope = (0, adminBroadcastScope_1.getAdminBroadcastScope)(entry.modelName);
290
+ _b = adminScope;
291
+ if (!_b) return [3 /*break*/, 8];
292
+ return [4 /*yield*/, (0, adminBroadcastScope_1.canListAdminBroadcastScope)({ scope: adminScope, user: user })];
293
+ case 7:
294
+ _b = !(_f.sent());
295
+ _f.label = 8;
296
+ case 8:
297
+ if (_b) {
298
+ logInfo("[sync] User ".concat(userId, " denied window subscribe list for ").concat(collection));
299
+ socket.emit("sync:error", {
300
+ collection: collection,
301
+ message: "Window subscribe requires admin collection access for ".concat(collection),
302
+ });
303
+ return [3 /*break*/, 21];
304
+ }
305
+ _f.label = 9;
306
+ case 9:
307
+ if (!isWindow) return [3 /*break*/, 10];
308
+ _c = [(0, streams_1.adminBroadcastStream)(collection)];
309
+ return [3 /*break*/, 12];
310
+ case 10: return [4 /*yield*/, resolveUserStreams({ entry: entry, options: options, socket: socket, user: user })];
311
+ case 11:
312
+ _c = _f.sent();
313
+ _f.label = 12;
314
+ case 12:
315
+ streams = _c;
232
316
  if (!streams) {
233
- return [3 /*break*/, 14];
317
+ return [3 /*break*/, 21];
234
318
  }
235
319
  rooms = new Set(streams.map(exports.syncRoomForStream));
236
- _c.label = 6;
237
- case 6:
238
- _c.trys.push([6, 11, 12, 13]);
320
+ _f.label = 13;
321
+ case 13:
322
+ _f.trys.push([13, 18, 19, 20]);
239
323
  rooms_1 = (e_1 = void 0, __values(rooms)), rooms_1_1 = rooms_1.next();
240
- _c.label = 7;
241
- case 7:
242
- if (!!rooms_1_1.done) return [3 /*break*/, 10];
324
+ _f.label = 14;
325
+ case 14:
326
+ if (!!rooms_1_1.done) return [3 /*break*/, 17];
243
327
  room = rooms_1_1.value;
244
328
  return [4 /*yield*/, socket.join(room)];
245
- case 8:
246
- _c.sent();
247
- _c.label = 9;
248
- case 9:
329
+ case 15:
330
+ _f.sent();
331
+ _f.label = 16;
332
+ case 16:
249
333
  rooms_1_1 = rooms_1.next();
250
- return [3 /*break*/, 7];
251
- case 10: return [3 /*break*/, 13];
252
- case 11:
253
- e_1_1 = _c.sent();
334
+ return [3 /*break*/, 14];
335
+ case 17: return [3 /*break*/, 20];
336
+ case 18:
337
+ e_1_1 = _f.sent();
254
338
  e_1 = { error: e_1_1 };
255
- return [3 /*break*/, 13];
256
- case 12:
339
+ return [3 /*break*/, 20];
340
+ case 19:
257
341
  try {
258
- if (rooms_1_1 && !rooms_1_1.done && (_b = rooms_1.return)) _b.call(rooms_1);
342
+ if (rooms_1_1 && !rooms_1_1.done && (_e = rooms_1.return)) _e.call(rooms_1);
259
343
  }
260
344
  finally { if (e_1) throw e_1.error; }
261
345
  return [7 /*endfinally*/];
262
- case 13:
346
+ case 20:
263
347
  subscriptions.set(collection, rooms);
264
- socket.emit("sync:subscribed", { collection: collection, streams: streams });
348
+ socket.emit("sync:subscribed", isWindow ? { collection: collection, mode: "window", streams: streams } : { collection: collection, streams: streams });
265
349
  logInfo("[sync] User ".concat(userId, " subscribed to ").concat(collection, ": ").concat(streams.join(", ")));
266
- _c.label = 14;
267
- case 14:
350
+ _f.label = 21;
351
+ case 21:
268
352
  collections_1_1 = collections_1.next();
269
353
  return [3 /*break*/, 2];
270
- case 15: return [3 /*break*/, 18];
271
- case 16:
272
- e_2_1 = _c.sent();
354
+ case 22: return [3 /*break*/, 25];
355
+ case 23:
356
+ e_2_1 = _f.sent();
273
357
  e_2 = { error: e_2_1 };
274
- return [3 /*break*/, 18];
275
- case 17:
358
+ return [3 /*break*/, 25];
359
+ case 24:
276
360
  try {
277
- if (collections_1_1 && !collections_1_1.done && (_a = collections_1.return)) _a.call(collections_1);
361
+ if (collections_1_1 && !collections_1_1.done && (_d = collections_1.return)) _d.call(collections_1);
278
362
  }
279
363
  finally { if (e_2) throw e_2.error; }
280
364
  return [7 /*endfinally*/];
281
- case 18: return [2 /*return*/];
365
+ case 25: return [2 /*return*/];
282
366
  }
283
367
  });
284
368
  }); });
@@ -389,7 +473,12 @@ var installSyncSocketHandlers = function (_io, socket, options, handlerOptions)
389
473
  _b.trys.push([2, 4, , 5]);
390
474
  return [4 /*yield*/, (0, syncBatch_1.runSyncMutation)({
391
475
  mutation: payload,
476
+ req: requestFromOrganizationId({
477
+ organizationId: organizationIdFromPayload(payload),
478
+ user: user,
479
+ }),
392
480
  scopeResolver: options.getUserScopes,
481
+ syncOptions: options,
393
482
  user: user,
394
483
  })];
395
484
  case 3:
@@ -444,7 +533,12 @@ var installSyncSocketHandlers = function (_io, socket, options, handlerOptions)
444
533
  _b.trys.push([2, 4, , 5]);
445
534
  return [4 /*yield*/, (0, syncBatch_1.runSyncBatch)({
446
535
  mutations: mutations,
536
+ req: requestFromOrganizationId({
537
+ organizationId: organizationIdFromPayload(payload),
538
+ user: user,
539
+ }),
447
540
  scopeResolver: options.getUserScopes,
541
+ syncOptions: options,
448
542
  user: user,
449
543
  })];
450
544
  case 3:
@@ -10,6 +10,8 @@ import type { SyncScope } from "./types";
10
10
  */
11
11
  /** The document field a scope reads, or null for broadcast/custom scopes. */
12
12
  export declare const getScopeField: (scope: SyncScope) => string | null;
13
+ /** Fan-in stream for admin window subscribers when `SyncConfig.adminBroadcast` is true. */
14
+ export declare const adminBroadcastStream: (collectionTag: string) => string;
13
15
  /** Build a stream key from a collection tag and a raw scope value. */
14
16
  export declare const streamForScopeValue: ({ collectionTag, scope, scopeValue, }: {
15
17
  collectionTag: string;
@@ -51,7 +51,7 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
51
51
  }
52
52
  };
53
53
  Object.defineProperty(exports, "__esModule", { value: true });
54
- exports.resolveUserStreamsForEntry = exports.MissingScopeResolverError = exports.assertWritableStream = exports.resolveStreamForDoc = exports.parseStreamKey = exports.streamForScopeValue = exports.getScopeField = void 0;
54
+ exports.resolveUserStreamsForEntry = exports.MissingScopeResolverError = exports.assertWritableStream = exports.resolveStreamForDoc = exports.parseStreamKey = exports.streamForScopeValue = exports.adminBroadcastStream = exports.getScopeField = void 0;
55
55
  var errors_1 = require("../errors");
56
56
  /**
57
57
  * Stream key resolution for SyncDB.
@@ -75,6 +75,9 @@ var getScopeField = function (scope) {
75
75
  return null;
76
76
  };
77
77
  exports.getScopeField = getScopeField;
78
+ /** Fan-in stream for admin window subscribers when `SyncConfig.adminBroadcast` is true. */
79
+ var adminBroadcastStream = function (collectionTag) { return "".concat(collectionTag, "|admin"); };
80
+ exports.adminBroadcastStream = adminBroadcastStream;
78
81
  /** Build a stream key from a collection tag and a raw scope value. */
79
82
  var streamForScopeValue = function (_a) {
80
83
  var collectionTag = _a.collectionTag, scope = _a.scope, scopeValue = _a.scopeValue;
@@ -106,6 +109,9 @@ var parseStreamKey = function (stream) {
106
109
  if (rest === "all") {
107
110
  return { collectionTag: collectionTag, scopeKind: "all", scopeValue: null };
108
111
  }
112
+ if (rest === "admin") {
113
+ return { collectionTag: collectionTag, scopeKind: "admin", scopeValue: null };
114
+ }
109
115
  var colon = rest.indexOf(":");
110
116
  if (colon < 0) {
111
117
  return null;
@@ -16,11 +16,12 @@ export declare const getSyncAppOptions: (app: express.Application) => SyncAppOpt
16
16
  *
17
17
  * Registration also enqueues the bookkeeping-model index builds (`SyncCounter`,
18
18
  * `SyncMutation`, `SyncScopeMove`, `SyncKey`) for `ensureSyncIndexes()`, which
19
- * `TerrenoApp.start()` awaits before the HTTP server begins listening. Those indexes are
19
+ * `TerrenoApp.start()` binds the HTTP port first, then awaits `ensureSyncIndexes()`. 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
23
23
  * the Express app without `TerrenoApp.start()` should await `ensureSyncIndexes()` themselves.
24
+ * Pass `httpServer` when the process already bound `PORT` (Cloud Run startup probe).
24
25
  */
25
26
  export declare class SyncApp implements TerrenoPlugin {
26
27
  private readonly options;
@@ -23,11 +23,12 @@ exports.getSyncAppOptions = getSyncAppOptions;
23
23
  *
24
24
  * Registration also enqueues the bookkeeping-model index builds (`SyncCounter`,
25
25
  * `SyncMutation`, `SyncScopeMove`, `SyncKey`) for `ensureSyncIndexes()`, which
26
- * `TerrenoApp.start()` awaits before the HTTP server begins listening. Those indexes are
26
+ * `TerrenoApp.start()` binds the HTTP port first, then awaits `ensureSyncIndexes()`. 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
30
30
  * the Express app without `TerrenoApp.start()` should await `ensureSyncIndexes()` themselves.
31
+ * Pass `httpServer` when the process already bound `PORT` (Cloud Run startup probe).
31
32
  */
32
33
  var SyncApp = /** @class */ (function () {
33
34
  function SyncApp(options) {