@terreno/api 57.2.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.
- package/.ai/skills/mongoose-schema-safety/SKILL.md +23 -10
- package/README.md +23 -7
- package/dist/actions.js +19 -7
- package/dist/adminTypes.d.ts +7 -0
- package/dist/adminTypes.js +6 -1
- package/dist/api.d.ts +14 -0
- package/dist/api.js +111 -60
- package/dist/audit/auditApp.d.ts +30 -0
- package/dist/audit/auditApp.js +155 -0
- package/dist/audit/auditEventModel.d.ts +29 -0
- package/dist/audit/auditEventModel.js +102 -0
- package/dist/audit/cloudTasksEnqueue.d.ts +32 -0
- package/dist/audit/cloudTasksEnqueue.js +162 -0
- package/dist/audit/diff.d.ts +10 -0
- package/dist/audit/diff.js +230 -0
- package/dist/audit/processQueue.d.ts +6 -0
- package/dist/audit/processQueue.js +101 -0
- package/dist/audit/rbacSink.d.ts +2 -0
- package/dist/audit/rbacSink.js +82 -0
- package/dist/audit/record.d.ts +56 -0
- package/dist/audit/record.js +373 -0
- 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 +39 -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 +40 -0
- package/dist/collectionRegistry.js +97 -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 +42 -1
- package/dist/index.js +84 -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 -15
- package/dist/mcp/query.js +8 -8
- 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/migrations/fixtures/all-down/20260910120000-one.d.ts +4 -0
- package/dist/migrations/fixtures/all-down/20260910120000-one.js +49 -0
- package/dist/migrations/fixtures/all-down/20260910120001-two.d.ts +4 -0
- package/dist/migrations/fixtures/all-down/20260910120001-two.js +49 -0
- package/dist/migrations/fixtures/bad-id/20260910120000-mismatch.d.ts +3 -0
- package/dist/migrations/fixtures/bad-id/20260910120000-mismatch.js +45 -0
- package/dist/migrations/fixtures/bad-name/not-a-migration.d.ts +3 -0
- package/dist/migrations/fixtures/bad-name/not-a-migration.js +45 -0
- package/dist/migrations/fixtures/missing-up/20260910120000-noup.d.ts +2 -0
- package/dist/migrations/fixtures/missing-up/20260910120000-noup.js +5 -0
- package/dist/migrations/fixtures/valid/20260910120000-alpha.d.ts +3 -0
- package/dist/migrations/fixtures/valid/20260910120000-alpha.js +45 -0
- package/dist/migrations/fixtures/valid/20260910120001-beta.d.ts +4 -0
- package/dist/migrations/fixtures/valid/20260910120001-beta.js +49 -0
- package/dist/migrations/generate.d.ts +17 -0
- package/dist/migrations/generate.js +277 -0
- package/dist/migrations/load.d.ts +20 -0
- package/dist/migrations/load.js +236 -0
- package/dist/migrations/lock.d.ts +13 -0
- package/dist/migrations/lock.js +145 -0
- package/dist/migrations/runner.d.ts +42 -0
- package/dist/migrations/runner.js +503 -0
- package/dist/migrations/schemaCatalog.d.ts +44 -0
- package/dist/migrations/schemaCatalog.js +326 -0
- package/dist/migrations/types.d.ts +87 -0
- package/dist/migrations/types.js +7 -0
- package/dist/models/mcpServiceToken.d.ts +3 -0
- package/dist/models/mcpServiceToken.js +208 -0
- package/dist/models/notification.d.ts +2 -0
- package/dist/models/notification.js +62 -0
- package/dist/models/notificationPreference.d.ts +2 -0
- package/dist/models/notificationPreference.js +49 -0
- package/dist/notifications/notificationService.d.ts +40 -0
- package/dist/notifications/notificationService.js +323 -0
- package/dist/notifications/notificationsApp.d.ts +18 -0
- package/dist/notifications/notificationsApp.js +250 -0
- package/dist/notifications/notificationsBeforeSend.d.ts +14 -0
- package/dist/notifications/notificationsBeforeSend.js +77 -0
- package/dist/openApi.d.ts +1 -7
- package/dist/openApi.js +7 -6
- package/dist/openApiBuilder.d.ts +19 -7
- package/dist/openApiBuilder.js +61 -8
- package/dist/openApiCompat.js +1 -1
- package/dist/openApiValidator.d.ts +13 -1
- package/dist/openApiValidator.js +200 -38
- package/dist/orgs/orgContext.d.ts +23 -0
- package/dist/orgs/orgContext.js +198 -0
- package/dist/orgs/orgPermissions.d.ts +4 -0
- package/dist/orgs/orgPermissions.js +77 -0
- package/dist/orgs/orgPlugin.d.ts +13 -0
- package/dist/orgs/orgPlugin.js +84 -0
- package/dist/orgs/organizationModel.d.ts +13 -0
- package/dist/orgs/organizationModel.js +301 -0
- package/dist/orgs/organizationSettings.d.ts +19 -0
- package/dist/orgs/organizationSettings.js +120 -0
- package/dist/orgs/orgsApp.d.ts +28 -0
- package/dist/orgs/orgsApp.js +678 -0
- package/dist/permissions.d.ts +7 -13
- package/dist/permissions.js +8 -31
- 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 +3 -0
- package/dist/rateLimit/middleware.js +109 -0
- package/dist/rateLimit/mongoStore.d.ts +4 -0
- package/dist/rateLimit/mongoStore.js +123 -0
- package/dist/rateLimit/policies.d.ts +10 -0
- package/dist/rateLimit/policies.js +149 -0
- package/dist/rateLimit/redisStore.d.ts +4 -0
- package/dist/rateLimit/redisStore.js +156 -0
- package/dist/rateLimit/types.d.ts +54 -0
- package/dist/rateLimit/types.js +9 -0
- package/dist/rbac/access.js +35 -14
- package/dist/rbac/assertAllowed.d.ts +9 -0
- package/dist/rbac/assertAllowed.js +182 -0
- package/dist/rbac/membershipOrgAdminSource.d.ts +6 -0
- package/dist/rbac/membershipOrgAdminSource.js +122 -0
- package/dist/rbac/modelRouterAccess.d.ts +4 -0
- package/dist/rbac/modelRouterAccess.js +11 -4
- package/dist/rbac/permissionUtils.js +3 -2
- package/dist/rbac/resolve.js +65 -35
- package/dist/rbac/roleModel.d.ts +2 -5
- package/dist/rbac/roleModel.js +18 -4
- package/dist/rbac/routes.js +15 -6
- package/dist/rbac/statements.d.ts +10 -1
- package/dist/rbac/statements.js +19 -2
- package/dist/rbac/types.d.ts +5 -0
- package/dist/realtime/changeStreamWatcher.d.ts +10 -4
- package/dist/realtime/changeStreamWatcher.js +110 -64
- package/dist/realtime/deprecation.d.ts +13 -0
- package/dist/realtime/deprecation.js +33 -0
- package/dist/realtime/realtimeApp.d.ts +2 -1
- package/dist/realtime/realtimeApp.js +11 -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 +524 -0
- package/dist/seedRunner.d.ts +88 -0
- package/dist/seedRunner.js +627 -0
- package/dist/sync/adminBroadcastScope.d.ts +40 -0
- package/dist/sync/adminBroadcastScope.js +194 -0
- package/dist/sync/adminWindowAccess.d.ts +13 -0
- package/dist/sync/adminWindowAccess.js +96 -0
- package/dist/sync/adminWindowMutation.d.ts +88 -0
- package/dist/sync/adminWindowMutation.js +247 -0
- package/dist/sync/executors.d.ts +19 -3
- package/dist/sync/executors.js +194 -165
- package/dist/sync/loadHarness.js +28 -19
- package/dist/sync/models.js +26 -24
- package/dist/sync/mutationHandler.d.ts +14 -2
- package/dist/sync/mutationHandler.js +201 -76
- 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 +42 -187
- package/dist/sync/routes.d.ts +13 -0
- package/dist/sync/routes.js +116 -58
- package/dist/sync/scripts/compactTombstones.js +0 -2
- package/dist/sync/socketHandlers.d.ts +8 -2
- package/dist/sync/socketHandlers.js +144 -50
- package/dist/sync/streams.d.ts +2 -0
- package/dist/sync/streams.js +7 -1
- package/dist/sync/syncApp.d.ts +4 -3
- package/dist/sync/syncApp.js +5 -4
- package/dist/sync/syncBatch.d.ts +5 -2
- package/dist/sync/syncBatch.js +7 -6
- package/dist/sync/syncSeqPlugin.d.ts +1 -1
- package/dist/sync/syncSeqPlugin.js +20 -16
- package/dist/sync/types.d.ts +18 -0
- package/dist/terrenoApp.d.ts +48 -5
- package/dist/terrenoApp.js +157 -72
- package/dist/tests/createTestData.d.ts +1 -3
- package/dist/tests/createTestData.js +3 -5
- package/dist/tests/models.d.ts +3 -0
- package/dist/tests/models.js +15 -2
- package/dist/tests/testHelper.d.ts +0 -5
- package/dist/tests/testHelper.js +2 -9
- 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/types/membership.d.ts +23 -0
- package/dist/types/membership.js +2 -0
- package/dist/types/notification.d.ts +28 -0
- package/dist/types/notification.js +2 -0
- package/dist/types/notificationPreference.d.ts +20 -0
- package/dist/types/notificationPreference.js +2 -0
- package/dist/types/organization.d.ts +36 -0
- package/dist/types/organization.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 +17 -0
- package/dist/webhooks/idempotency/webhookReceipt.js +39 -0
- package/dist/webhooks/rawBody.d.ts +15 -0
- package/dist/webhooks/rawBody.js +23 -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 +32 -27
- package/src/__snapshots__/openApi.test.ts.snap +444 -36
- package/src/__snapshots__/openApiBuilder.test.ts.snap +24 -24
- package/src/__snapshots__/schemaMetadata.test.ts.snap +196 -0
- package/src/actions.ts +20 -13
- package/src/adminModelRouter.test.ts +133 -0
- package/src/adminTypes.ts +8 -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 +133 -97
- package/src/api.ts +84 -27
- package/src/audit/auditApp.test.ts +243 -0
- package/src/audit/auditApp.ts +139 -0
- package/src/audit/auditEventModel.ts +156 -0
- package/src/audit/auditRouter.test.ts +456 -0
- package/src/audit/cloudTasksEnqueue.test.ts +124 -0
- package/src/audit/cloudTasksEnqueue.ts +104 -0
- package/src/audit/diff.ts +163 -0
- package/src/audit/processQueue.ts +69 -0
- package/src/audit/rbacSink.test.ts +86 -0
- package/src/audit/rbacSink.ts +42 -0
- package/src/audit/record.test.ts +402 -0
- package/src/audit/record.ts +328 -0
- package/src/auth.test.ts +108 -52
- 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 +31 -0
- package/src/betterAuthApp.test.ts +1 -0
- package/src/betterAuthApp.ts +27 -9
- package/src/betterAuthSetup.test.ts +595 -38
- package/src/betterAuthSetup.ts +261 -5
- package/src/collectionRegistry.test.ts +164 -0
- package/src/collectionRegistry.ts +135 -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 +3 -0
- package/src/expressServer.test.ts +180 -68
- package/src/expressServer.ts +75 -19
- package/src/githubAuth.test.ts +60 -55
- package/src/index.ts +127 -0
- package/src/mcp/auth.test.ts +47 -0
- package/src/mcp/auth.ts +32 -11
- package/src/mcp/handlers.test.ts +275 -0
- package/src/mcp/handlers.ts +45 -172
- package/src/mcp/integration.test.ts +59 -9
- package/src/mcp/query.ts +5 -7
- 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 +82 -1
- package/src/mcp/types.ts +2 -6
- package/src/migrations/cli.test.ts +376 -0
- package/src/migrations/cli.ts +283 -0
- package/src/migrations/fixtures/all-down/20260910120000-one.ts +6 -0
- package/src/migrations/fixtures/all-down/20260910120001-two.ts +6 -0
- package/src/migrations/fixtures/bad-id/20260910120000-mismatch.ts +4 -0
- package/src/migrations/fixtures/bad-name/not-a-migration.ts +4 -0
- package/src/migrations/fixtures/missing-up/20260910120000-noup.ts +2 -0
- package/src/migrations/fixtures/valid/20260910120000-alpha.ts +4 -0
- package/src/migrations/fixtures/valid/20260910120001-beta.ts +6 -0
- package/src/migrations/generate.test.ts +333 -0
- package/src/migrations/generate.ts +216 -0
- package/src/migrations/load.test.ts +103 -0
- package/src/migrations/load.ts +124 -0
- package/src/migrations/lock.test.ts +133 -0
- package/src/migrations/lock.ts +118 -0
- package/src/migrations/runner.test.ts +504 -0
- package/src/migrations/runner.ts +358 -0
- package/src/migrations/schemaCatalog.test.ts +159 -0
- package/src/migrations/schemaCatalog.ts +262 -0
- package/src/migrations/types.ts +94 -0
- package/src/models/mcpServiceToken.test.ts +129 -0
- package/src/models/mcpServiceToken.ts +158 -0
- package/src/models/notification.ts +68 -0
- package/src/models/notificationPreference.ts +62 -0
- package/src/notifications/notificationService.ts +254 -0
- package/src/notifications/notificationsApp.test.ts +505 -0
- package/src/notifications/notificationsApp.ts +200 -0
- package/src/notifications/notificationsBeforeSend.ts +51 -0
- package/src/openApi.test.ts +80 -65
- package/src/openApi.ts +2 -1
- package/src/openApiBuilder.test.ts +95 -7
- package/src/openApiBuilder.ts +60 -12
- package/src/openApiCompat.ts +1 -1
- package/src/openApiValidator.test.ts +270 -56
- package/src/openApiValidator.ts +219 -36
- package/src/orgs/orgAccessOptIn.test.ts +87 -0
- package/src/orgs/orgContext.test.ts +259 -0
- package/src/orgs/orgContext.ts +151 -0
- package/src/orgs/orgPermissions.test.ts +105 -0
- package/src/orgs/orgPermissions.ts +40 -0
- package/src/orgs/orgPlugin.test.ts +130 -0
- package/src/orgs/orgPlugin.ts +70 -0
- package/src/orgs/orgRbac.test.ts +267 -0
- package/src/orgs/orgSecurityDefects.test.ts +415 -0
- package/src/orgs/organizationModel.test.ts +205 -0
- package/src/orgs/organizationModel.ts +257 -0
- package/src/orgs/organizationSettings.test.ts +113 -0
- package/src/orgs/organizationSettings.ts +126 -0
- package/src/orgs/orgsApp.test.ts +382 -0
- package/src/orgs/orgsApp.ts +563 -0
- package/src/permissions.test.ts +62 -36
- package/src/permissions.ts +8 -30
- 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 +77 -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 +86 -0
- package/src/rateLimit/types.ts +64 -0
- package/src/rbac/access.ts +16 -4
- 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/membershipOrgAdminSource.ts +59 -0
- package/src/rbac/modelRouterAccess.test.ts +126 -0
- package/src/rbac/modelRouterAccess.ts +8 -2
- package/src/rbac/permissionUtils.test.ts +26 -5
- package/src/rbac/permissionUtils.ts +3 -2
- package/src/rbac/realtimeAccess.test.ts +109 -1
- package/src/rbac/resolve.test.ts +34 -2
- package/src/rbac/resolve.ts +31 -11
- package/src/rbac/roleManager.test.ts +169 -0
- package/src/rbac/roleModel.test.ts +34 -1
- package/src/rbac/roleModel.ts +17 -1
- package/src/rbac/routes.test.ts +233 -0
- package/src/rbac/routes.ts +16 -6
- package/src/rbac/statements.test.ts +19 -0
- package/src/rbac/statements.ts +19 -1
- package/src/rbac/types.ts +5 -0
- package/src/realtime/changeStreamWatcher.ts +73 -33
- package/src/realtime/deprecation.test.ts +60 -0
- package/src/realtime/deprecation.ts +33 -0
- package/src/realtime/realtime.test.ts +365 -189
- package/src/realtime/realtimeApp.ts +11 -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 +419 -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/adminBroadcastConfig.test.ts +96 -0
- package/src/sync/adminBroadcastScope.test.ts +155 -0
- package/src/sync/adminBroadcastScope.ts +123 -0
- package/src/sync/adminWindowAccess.test.ts +57 -0
- package/src/sync/adminWindowAccess.ts +32 -0
- package/src/sync/adminWindowMutation.test.ts +450 -0
- package/src/sync/adminWindowMutation.ts +283 -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 +57 -18
- 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 +293 -17
- package/src/sync/mutationHandler.ts +180 -36
- package/src/sync/registrationSideEffects.test.ts +126 -0
- package/src/sync/registrationSideEffects.ts +131 -0
- package/src/sync/registry.ts +49 -171
- package/src/sync/routes.ts +55 -10
- package/src/sync/scripts/compactTombstones.ts +0 -2
- package/src/sync/sessionRevalidationIntegration.test.ts +12 -11
- package/src/sync/socketHandlers.ts +154 -58
- package/src/sync/streams.ts +6 -0
- package/src/sync/sync.test.ts +28 -25
- package/src/sync/syncApp.ts +5 -4
- package/src/sync/syncBatch.ts +10 -4
- package/src/sync/syncFrontier.test.ts +17 -15
- package/src/sync/syncPhaseC.test.ts +54 -43
- package/src/sync/syncRoutes.test.ts +347 -38
- package/src/sync/syncSeqPlugin.ts +66 -44
- package/src/sync/syncSocket.test.ts +341 -81
- package/src/sync/types.ts +20 -0
- package/src/terrenoApp.mcpServiceTokens.test.ts +173 -0
- package/src/terrenoApp.migrations.test.ts +114 -0
- package/src/terrenoApp.test.ts +41 -0
- package/src/terrenoApp.ts +181 -46
- package/src/tests/createTestData.ts +2 -2
- package/src/tests/models.ts +24 -3
- package/src/tests/testHelper.ts +1 -7
- package/src/types/authToken.ts +41 -0
- package/src/types/mcpServiceToken.ts +48 -0
- package/src/types/membership.ts +48 -0
- package/src/types/notification.ts +34 -0
- package/src/types/notificationPreference.ts +28 -0
- package/src/types/organization.ts +49 -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 +67 -0
- package/src/webhooks/rawBody.test.ts +107 -0
- package/src/webhooks/rawBody.ts +24 -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/tsconfig.json +1 -1
- package/tsconfig.typedoc.json +2 -1
- package/dist/vendor/wesleytodd-openapi/lib/convert-yaml.d.ts +0 -2
- package/dist/vendor/wesleytodd-openapi/lib/convert-yaml.js +0 -13
- package/src/vendor/wesleytodd-openapi/lib/convert-yaml.js +0 -13
|
@@ -83,29 +83,40 @@ schema.statics = {
|
|
|
83
83
|
- Apply the standard plugins (`createdUpdatedPlugin`, `isDeletedPlugin`, `findOneOrNone`, `findExactlyOne`) on every new model. Most existing models go through `addDefaultPlugins`.
|
|
84
84
|
- `checkModelsStrict()` runs at non-prod startup (`server.ts`) and validates schema consistency — keep it passing.
|
|
85
85
|
|
|
86
|
+
## Migration files
|
|
87
|
+
|
|
88
|
+
Schema and data changes that must run once per environment belong in
|
|
89
|
+
`migrations/<YYYYMMDDHHmmss>-<slug>.ts` with required `up` and optional `down`.
|
|
90
|
+
Generate a draft with `terreno-migrate generate --dir ./migrations --models ./src/models.ts`,
|
|
91
|
+
then `terreno-migrate up --dir ./migrations --dry` before wet apply.
|
|
92
|
+
See [Run MongoDB migrations](../../../../docs/how-to/run-mongodb-migrations.md).
|
|
93
|
+
|
|
94
|
+
Admin **Scripts** (`ScriptRunner` + `BackgroundTask`) stay for one-off operator
|
|
95
|
+
tools. Do not use Scripts as the primary path for versioned schema backfills.
|
|
96
|
+
|
|
86
97
|
## Schema Change Risk Matrix
|
|
87
98
|
|
|
88
99
|
| Change Type | Risk Level | Required Mitigation |
|
|
89
100
|
|-------------|-----------|---------------------|
|
|
90
101
|
| Add optional field | Low | Safe to ship directly (still requires `description`) |
|
|
91
|
-
| Add required field | High | Must provide a default value, OR write a
|
|
102
|
+
| Add required field | High | Must provide a default value, OR write a versioned migration (`terreno-migrate generate` / `up`) with a backfill before wet apply |
|
|
92
103
|
| Remove field | Medium | Soft-remove first (mark optional, stop writing); hard-remove in next PR after deploys settle |
|
|
93
|
-
| Rename field | High | Three-step: add new → backfill → remove old (separate PRs) |
|
|
94
|
-
| Change field type | Critical | Treat as rename: new field + migration + remove old |
|
|
95
|
-
| Add index | Medium |
|
|
104
|
+
| Rename field | High | Three-step: add new → backfill migration → remove old (separate PRs) |
|
|
105
|
+
| Change field type | Critical | Treat as rename: new field + versioned migration + remove old |
|
|
106
|
+
| Add index | Medium | Prefer `terreno-migrate generate` for the index; build can slow writes on large collections — coordinate with ops |
|
|
96
107
|
| Remove index | Low | Safe to ship directly |
|
|
97
|
-
| Add unique index | High | Dedup
|
|
108
|
+
| Add unique index | High | Dedup in a versioned migration first; otherwise the index build fails on existing duplicates |
|
|
98
109
|
|
|
99
|
-
##
|
|
110
|
+
## One-off admin scripts
|
|
100
111
|
|
|
101
|
-
|
|
112
|
+
Ad-hoc operator tools (counts, reseeds, support fixes) still live as admin
|
|
113
|
+
Scripts using `ScriptRunner` and `BackgroundTask`:
|
|
102
114
|
|
|
103
115
|
```typescript
|
|
104
116
|
import type {ScriptContext, ScriptResult, ScriptRunner} from "@terreno/api";
|
|
105
117
|
|
|
106
118
|
export const run: ScriptRunner = async (wetRun, ctx) => {
|
|
107
119
|
const results: string[] = [];
|
|
108
|
-
// ... do work ...
|
|
109
120
|
if (wetRun) {
|
|
110
121
|
// commit changes
|
|
111
122
|
}
|
|
@@ -113,7 +124,9 @@ export const run: ScriptRunner = async (wetRun, ctx) => {
|
|
|
113
124
|
};
|
|
114
125
|
```
|
|
115
126
|
|
|
116
|
-
Always run with `wetRun = false` first
|
|
127
|
+
Always run with `wetRun = false` first. Use `ctx.checkCancellation()`,
|
|
128
|
+
`ctx.addLog()`, and `ctx.updateProgress()` for long-running tasks. Do not put
|
|
129
|
+
repeatable schema backfills here — use `migrations/` and `terreno-migrate`.
|
|
117
130
|
|
|
118
131
|
## Cross-Package Ripple
|
|
119
132
|
|
|
@@ -131,7 +144,7 @@ A schema change in one place often ripples:
|
|
|
131
144
|
- [ ] For a new model: all five types (`Document`, `Methods`, `Statics`, `Model`, `Schema`) created
|
|
132
145
|
- [ ] Statics/methods assigned directly on schema (`schema.statics = {...}`, `schema.methods = {...}`) — not `.static()` / `.method()`
|
|
133
146
|
- [ ] Other model type files checked — any model that populates this one updated if its shape changed
|
|
134
|
-
- [ ]
|
|
147
|
+
- [ ] Versioned migration written (`migrations/` + `terreno-migrate`) and dry-run verified for any backfill; unique-index dedup runs before the index is added
|
|
135
148
|
- [ ] `modelRouter` config updated (`queryFields`, `populatePaths`, `responseHandler`) if needed
|
|
136
149
|
- [ ] `AdminApp` `listFields` updated if the model is in the admin panel
|
|
137
150
|
- [ ] `bun run sdk` run from `example-frontend/` if the API response shape changed
|
package/README.md
CHANGED
|
@@ -1,5 +1,7 @@
|
|
|
1
1
|
# @terreno/api
|
|
2
2
|
|
|
3
|
+
Styled after the Django & Django REST Framework, a batteries-include framework for building REST APIs with Node/Express/Mongoose.
|
|
4
|
+
|
|
3
5
|
This library attempts to make creating REST APIs much easier with Express and Mongoose.
|
|
4
6
|
Most REST APIs wind up being a lot of boilerplate, so this tries to cut that down without turning
|
|
5
7
|
into a full blown framework of its own. This library is inspired by the
|
|
@@ -16,13 +18,13 @@ model instances.
|
|
|
16
18
|
- **Permissions** — Fine-grained access control (IsAuthenticated, IsOwner, IsAdmin, etc.)
|
|
17
19
|
- **OpenAPI** — Automatic spec generation from models and routes
|
|
18
20
|
- **Logging** — Winston-based logging with scoped & feature-flagged loggers, automatic request correlation, and Google Cloud / Sentry support
|
|
19
|
-
- **HTTP client** — Authenticated axios factory for third-party APIs with token caching, safe retries, and normalized error handling (see [Call external APIs](
|
|
20
|
-
|
|
21
|
-
## Getting started
|
|
21
|
+
- **HTTP client** — Authenticated axios factory for third-party APIs with token caching, safe retries, and normalized error handling (see [Call external APIs](https://github.com/flourishhealth/terreno/blob/master/docs/how-to/call-external-apis.md))
|
|
22
22
|
|
|
23
|
-
|
|
23
|
+
## Install
|
|
24
24
|
|
|
25
|
-
|
|
25
|
+
```bash
|
|
26
|
+
bun add @terreno/api
|
|
27
|
+
```
|
|
26
28
|
|
|
27
29
|
## DateOnly Type
|
|
28
30
|
|
|
@@ -165,7 +167,7 @@ setupServer({
|
|
|
165
167
|
});
|
|
166
168
|
```
|
|
167
169
|
|
|
168
|
-
**Learn more:** See the [GitHub OAuth how-to guide](
|
|
170
|
+
**Learn more:** See the [GitHub OAuth how-to guide](https://github.com/flourishhealth/terreno/blob/master/docs/how-to/add-github-oauth.md) for complete setup instructions.
|
|
169
171
|
|
|
170
172
|
## Logging
|
|
171
173
|
|
|
@@ -217,7 +219,7 @@ In production, pass a structured transport (e.g. `@google-cloud/logging-winston`
|
|
|
217
219
|
`loggingOptions`/`setupLogging` so the correlation fields and labels reach Log Explorer as
|
|
218
220
|
`jsonPayload`.
|
|
219
221
|
|
|
220
|
-
**Learn more:** See the [Logging & Tracing reference](
|
|
222
|
+
**Learn more:** See the [Logging & Tracing reference](https://github.com/flourishhealth/terreno/blob/master/docs/reference/api.md#logging--tracing) for
|
|
221
223
|
the full API, label conventions, and Google Cloud Logging / Sentry details.
|
|
222
224
|
|
|
223
225
|
## Sentry
|
|
@@ -225,6 +227,12 @@ To enable Sentry, create a "src/sentryInstrumment.ts" file in your project.
|
|
|
225
227
|
|
|
226
228
|
> **Note:** Bun automatically loads `.env` files before your code runs, so there's no need for `dotenv`. Just place a `.env` file in your project root and `process.env` will have your variables available immediately. See [Bun .env docs](https://bun.sh/docs/runtime/env).
|
|
227
229
|
|
|
230
|
+
Install both SDK packages in the consuming backend:
|
|
231
|
+
|
|
232
|
+
```bash
|
|
233
|
+
bun add @sentry/bun @sentry/profiling-node
|
|
234
|
+
```
|
|
235
|
+
|
|
228
236
|
```
|
|
229
237
|
import * as Sentry from "@sentry/bun";
|
|
230
238
|
import {nodeProfilingIntegration} from "@sentry/profiling-node";
|
|
@@ -288,3 +296,11 @@ A lot of dev may require using bun link. You'll want to keep the `bun run dev` w
|
|
|
288
296
|
bun link
|
|
289
297
|
cd $your-api-repo
|
|
290
298
|
bun link @terreno/api
|
|
299
|
+
|
|
300
|
+
## Documentation
|
|
301
|
+
|
|
302
|
+
Full API reference: [docs/reference/api.md](https://github.com/flourishhealth/terreno/blob/master/docs/reference/api.md)
|
|
303
|
+
|
|
304
|
+
## License and Contributing
|
|
305
|
+
|
|
306
|
+
Licensed under the [MIT License](https://github.com/flourishhealth/terreno/blob/master/LICENSE). See [CONTRIBUTING.md](https://github.com/flourishhealth/terreno/blob/master/CONTRIBUTING.md) for contribution guidelines.
|
package/dist/actions.js
CHANGED
|
@@ -338,23 +338,32 @@ var getArrayFieldNames = function (model) {
|
|
|
338
338
|
.filter(function (config) { return config.instance === "Array"; })
|
|
339
339
|
.map(function (config) { return config.path; });
|
|
340
340
|
};
|
|
341
|
-
// Registration-time validation throws
|
|
341
|
+
// Registration-time validation throws APIError so misconfiguration fails at app boot.
|
|
342
342
|
var validateActionConfig = function (scope, name, config) {
|
|
343
343
|
if (!name) {
|
|
344
|
-
throw new
|
|
344
|
+
throw new errors_1.APIError({ status: 500, title: "Action name cannot be empty" });
|
|
345
345
|
}
|
|
346
346
|
if (!exports.ACTION_NAME_PATTERN.test(name)) {
|
|
347
|
-
throw new
|
|
347
|
+
throw new errors_1.APIError({
|
|
348
|
+
status: 500,
|
|
349
|
+
title: "Invalid action name \"".concat(name, "\". Action names must match ").concat(exports.ACTION_NAME_PATTERN.toString()),
|
|
350
|
+
});
|
|
348
351
|
}
|
|
349
352
|
if (config.permissions === undefined && !config.access) {
|
|
350
|
-
throw new
|
|
351
|
-
|
|
353
|
+
throw new errors_1.APIError({
|
|
354
|
+
status: 500,
|
|
355
|
+
title: "Action \"".concat(name, "\" (").concat(scope, ") is missing required \"permissions\" or \"access\". ") +
|
|
356
|
+
"Provide at least one permission function, an access descriptor, or [] to disable the action.",
|
|
357
|
+
});
|
|
352
358
|
}
|
|
353
359
|
if (config.permissions !== undefined && config.permissions.length === 0 && !config.access) {
|
|
354
360
|
return;
|
|
355
361
|
}
|
|
356
362
|
if (config.method !== "GET" && config.method !== "POST") {
|
|
357
|
-
throw new
|
|
363
|
+
throw new errors_1.APIError({
|
|
364
|
+
status: 500,
|
|
365
|
+
title: "Action \"".concat(name, "\" (").concat(scope, ") only supports GET and POST methods"),
|
|
366
|
+
});
|
|
358
367
|
}
|
|
359
368
|
};
|
|
360
369
|
var assertNoActionCollisions = function (model, options) {
|
|
@@ -369,7 +378,10 @@ var assertNoActionCollisions = function (model, options) {
|
|
|
369
378
|
var _d = __read(_c.value, 2), name_1 = _d[0], config = _d[1];
|
|
370
379
|
validateActionConfig(scope, name_1, config);
|
|
371
380
|
if (scope === "instance" && arrayFields.has(name_1)) {
|
|
372
|
-
throw new
|
|
381
|
+
throw new errors_1.APIError({
|
|
382
|
+
status: 500,
|
|
383
|
+
title: "instanceAction '".concat(name_1, "' collides with array field operations on /:id/").concat(name_1),
|
|
384
|
+
});
|
|
373
385
|
}
|
|
374
386
|
}
|
|
375
387
|
}
|
package/dist/adminTypes.d.ts
CHANGED
|
@@ -7,6 +7,11 @@ import type { ScriptArgDef, ScriptRunner } from "./scriptRunner";
|
|
|
7
7
|
/** Server-side cap on bulk action id lists (v2 bulk-patch). */
|
|
8
8
|
export declare const MAX_BULK_PATCH_IDS = 1000;
|
|
9
9
|
export type AdminFilterKind = "boolean" | "choice" | "dateRange" | "ref" | "text";
|
|
10
|
+
/**
|
|
11
|
+
* Wire-format sentinel for optional choice filters meaning "field is null or unset".
|
|
12
|
+
* Must match `DATA_TABLE_CHOICE_EMPTY_VALUE` in `@terreno/ui`.
|
|
13
|
+
*/
|
|
14
|
+
export declare const ADMIN_LIST_CHOICE_EMPTY_VALUE = "__empty__";
|
|
10
15
|
export interface AdminFilterBoolean {
|
|
11
16
|
field: string;
|
|
12
17
|
kind: "boolean";
|
|
@@ -17,6 +22,8 @@ export interface AdminFilterChoice {
|
|
|
17
22
|
label: string;
|
|
18
23
|
value: string;
|
|
19
24
|
}[];
|
|
25
|
+
/** When true, the filter UI offers an Empty option and the parser accepts {@link ADMIN_LIST_CHOICE_EMPTY_VALUE}. */
|
|
26
|
+
allowEmpty?: boolean;
|
|
20
27
|
field: string;
|
|
21
28
|
kind: "choice";
|
|
22
29
|
label?: string;
|
package/dist/adminTypes.js
CHANGED
|
@@ -1,5 +1,10 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.MAX_BULK_PATCH_IDS = void 0;
|
|
3
|
+
exports.ADMIN_LIST_CHOICE_EMPTY_VALUE = exports.MAX_BULK_PATCH_IDS = void 0;
|
|
4
4
|
/** Server-side cap on bulk action id lists (v2 bulk-patch). */
|
|
5
5
|
exports.MAX_BULK_PATCH_IDS = 1000;
|
|
6
|
+
/**
|
|
7
|
+
* Wire-format sentinel for optional choice filters meaning "field is null or unset".
|
|
8
|
+
* Must match `DATA_TABLE_CHOICE_EMPTY_VALUE` in `@terreno/ui`.
|
|
9
|
+
*/
|
|
10
|
+
exports.ADMIN_LIST_CHOICE_EMPTY_VALUE = "__empty__";
|
package/dist/api.d.ts
CHANGED
|
@@ -3,6 +3,7 @@ import mongoose, { type Document, type Model } from "mongoose";
|
|
|
3
3
|
import { type CollectionActionConfig, type InstanceActionConfig } from "./actions";
|
|
4
4
|
import { type ModelRouterBuildContext } from "./adminModelRouter";
|
|
5
5
|
import type { AdminConfig } from "./adminTypes";
|
|
6
|
+
import { type ModelRouterAuditConfig } from "./audit/record";
|
|
6
7
|
import { type User } from "./auth";
|
|
7
8
|
import type { MCPConfig } from "./mcp/types";
|
|
8
9
|
import { type ModelRouterValidationOptions } from "./openApiValidator";
|
|
@@ -203,6 +204,13 @@ export interface ModelRouterOptions<T> {
|
|
|
203
204
|
* @param value - The document that was deleted, after the soft update of deleted: true (type: T).
|
|
204
205
|
*/
|
|
205
206
|
postDelete?: (request: express.Request, value: T) => void | Promise<void>;
|
|
207
|
+
/**
|
|
208
|
+
* When true or `{redact}`, persist an `AuditEvent` after successful HTTP
|
|
209
|
+
* create/update/delete. Requires `AuditApp`. Extra `redact` names merge with
|
|
210
|
+
* the default secret segments (`password`, `hash`, `salt`, `token`, `secret`,
|
|
211
|
+
* `refreshToken`).
|
|
212
|
+
*/
|
|
213
|
+
audit?: ModelRouterAuditConfig;
|
|
206
214
|
/** Hook that runs after the object is fetched but before it is serialized.
|
|
207
215
|
* Returns a promise so that asynchronous actions can be included in the function.
|
|
208
216
|
* Throw an APIError to return a 400 with an error message.
|
|
@@ -281,11 +289,17 @@ export interface ModelRouterOptions<T> {
|
|
|
281
289
|
* through the RealtimeApp plugin's change stream watcher.
|
|
282
290
|
*
|
|
283
291
|
* Requires the RealtimeApp plugin to be registered with TerrenoApp.
|
|
292
|
+
*
|
|
293
|
+
* @deprecated Removed in Terreno 58. Use `sync` with
|
|
294
|
+
* `@terreno/syncdb` instead. `RealtimeApp` remains required for sync sockets.
|
|
295
|
+
* See docs/how-to/migrate-rtk-to-syncdb.md.
|
|
284
296
|
*/
|
|
285
297
|
realtime?: RealtimeConfig;
|
|
286
298
|
/**
|
|
287
299
|
* Enable local-first sync (@terreno/syncdb) for this model. Documents are scoped
|
|
288
300
|
* into streams (owner/tenant/broadcast/custom) with monotonic per-stream cursors.
|
|
301
|
+
* Set `sync.adminBroadcast: true` to also emit `sync:delta` to `{collection}|admin`
|
|
302
|
+
* (default false; stored on the collection catalog at registration).
|
|
289
303
|
*
|
|
290
304
|
* Requires the schema to use `isDeletedPlugin` (soft delete tombstones) and
|
|
291
305
|
* `syncPlugin` (per-stream `_syncSeq` stamping) — validated at registration.
|
package/dist/api.js
CHANGED
|
@@ -133,7 +133,9 @@ var luxon_1 = require("luxon");
|
|
|
133
133
|
var mongoose_1 = __importDefault(require("mongoose"));
|
|
134
134
|
var actions_1 = require("./actions");
|
|
135
135
|
var adminModelRouter_1 = require("./adminModelRouter");
|
|
136
|
+
var record_1 = require("./audit/record");
|
|
136
137
|
var auth_1 = require("./auth");
|
|
138
|
+
var collectionRegistry_1 = require("./collectionRegistry");
|
|
137
139
|
var errors_1 = require("./errors");
|
|
138
140
|
var logger_1 = require("./logger");
|
|
139
141
|
var registry_1 = require("./mcp/registry");
|
|
@@ -141,9 +143,8 @@ var openApi_1 = require("./openApi");
|
|
|
141
143
|
var openApiValidator_1 = require("./openApiValidator");
|
|
142
144
|
var permissions_1 = require("./permissions");
|
|
143
145
|
var modelRouterAccess_1 = require("./rbac/modelRouterAccess");
|
|
144
|
-
var
|
|
146
|
+
var deprecation_1 = require("./realtime/deprecation");
|
|
145
147
|
var executors_1 = require("./sync/executors");
|
|
146
|
-
var registry_3 = require("./sync/registry");
|
|
147
148
|
var transformers_1 = require("./transformers");
|
|
148
149
|
var utils_1 = require("./utils");
|
|
149
150
|
var addPopulateToQuery = function (
|
|
@@ -373,6 +374,9 @@ var getBodyValidationMiddleware = function (model, options, operation) {
|
|
|
373
374
|
validationOptions.excludeFields = excludeFields;
|
|
374
375
|
}
|
|
375
376
|
}
|
|
377
|
+
if (operation === "update") {
|
|
378
|
+
validationOptions.partial = true;
|
|
379
|
+
}
|
|
376
380
|
return (0, openApiValidator_1.validateModelRequestBody)(model, validationOptions);
|
|
377
381
|
};
|
|
378
382
|
// Get query validation middleware if validation is enabled
|
|
@@ -400,27 +404,17 @@ function modelRouter(pathOrModel, modelOrOptions, maybeOptions) {
|
|
|
400
404
|
model = pathOrModel;
|
|
401
405
|
options = modelOrOptions;
|
|
402
406
|
}
|
|
403
|
-
//
|
|
404
|
-
//
|
|
405
|
-
if (options.mcp) {
|
|
407
|
+
// Pathless MCP only — when a route path is present, registerCollection below
|
|
408
|
+
// owns the catalog entry and MCP shares that routePath key.
|
|
409
|
+
if (options.mcp && path === undefined) {
|
|
406
410
|
(0, registry_1.registerMCPModel)(model, options.mcp, options);
|
|
407
411
|
}
|
|
408
412
|
var shouldDeferBuild = path !== undefined && Boolean(options.access) && !options.accessControl;
|
|
409
413
|
if (path !== undefined) {
|
|
410
|
-
// Register before building so _buildModelRouter can replace options with
|
|
411
|
-
// RBAC-resolved permissions (same contract as MCP).
|
|
412
414
|
if (options.realtime) {
|
|
413
|
-
(0,
|
|
414
|
-
collectionName: model.collection.collectionName,
|
|
415
|
-
config: options.realtime,
|
|
416
|
-
modelName: model.modelName,
|
|
417
|
-
options: options,
|
|
418
|
-
routePath: path,
|
|
419
|
-
});
|
|
420
|
-
}
|
|
421
|
-
if (options.sync) {
|
|
422
|
-
(0, registry_3.registerSync)({ config: options.sync, model: model, options: options, routePath: path });
|
|
415
|
+
(0, deprecation_1.warnRealtimeDeprecated)(model.modelName, path);
|
|
423
416
|
}
|
|
417
|
+
(0, collectionRegistry_1.registerCollection)({ model: model, options: options, routePath: path });
|
|
424
418
|
}
|
|
425
419
|
var router = shouldDeferBuild ? express_1.default.Router() : _buildModelRouter(model, options, path);
|
|
426
420
|
if (path !== undefined) {
|
|
@@ -430,9 +424,7 @@ function modelRouter(pathOrModel, modelOrOptions, maybeOptions) {
|
|
|
430
424
|
var _a;
|
|
431
425
|
var enrichedOptions = (0, adminModelRouter_1.enrichModelRouterOptions)(model, __assign(__assign({}, options), { openApi: context.openApi }), context);
|
|
432
426
|
var runtimeOptions = __assign(__assign({}, enrichedOptions), { accessControl: (_a = enrichedOptions.accessControl) !== null && _a !== void 0 ? _a : context.accessControl });
|
|
433
|
-
|
|
434
|
-
(0, registry_2.updateRealtimeRegistryOptions)(path, runtimeOptions);
|
|
435
|
-
}
|
|
427
|
+
(0, collectionRegistry_1.replaceCollectionOptions)(path, runtimeOptions);
|
|
436
428
|
return _buildModelRouter(model, runtimeOptions, path);
|
|
437
429
|
},
|
|
438
430
|
model: model,
|
|
@@ -442,6 +434,7 @@ function modelRouter(pathOrModel, modelOrOptions, maybeOptions) {
|
|
|
442
434
|
};
|
|
443
435
|
}
|
|
444
436
|
if (options.realtime) {
|
|
437
|
+
(0, deprecation_1.warnRealtimeDeprecated)(model.modelName);
|
|
445
438
|
logger_1.logger.warn("modelRouter for ".concat(model.modelName, " has realtime config but was called without a path. ") +
|
|
446
439
|
"Realtime sync only works with the three-argument form: modelRouter('/path', Model, options)");
|
|
447
440
|
}
|
|
@@ -463,12 +456,12 @@ var _buildModelRouter = function (model, options, routePath) {
|
|
|
463
456
|
scope: (_a = options.access) === null || _a === void 0 ? void 0 : _a.scope,
|
|
464
457
|
});
|
|
465
458
|
options = __assign(__assign({}, options), { permissions: resolvedAccess.permissions, queryFilter: ((_b = resolvedAccess.queryFilter) !== null && _b !== void 0 ? _b : options.queryFilter), responseHandler: ((_d = (_c = resolvedAccess.responseHandler) !== null && _c !== void 0 ? _c : options.responseHandler) !== null && _d !== void 0 ? _d : transformers_1.defaultResponseHandler) });
|
|
459
|
+
if (routePath) {
|
|
460
|
+
(0, collectionRegistry_1.replaceCollectionOptions)(routePath, options);
|
|
461
|
+
}
|
|
466
462
|
if (options.mcp) {
|
|
467
463
|
(0, registry_1.updateMCPRegistryOptions)(model.modelName, options);
|
|
468
464
|
}
|
|
469
|
-
if (options.sync && routePath) {
|
|
470
|
-
(0, registry_3.updateSyncRegistryOptions)(routePath, options);
|
|
471
|
-
}
|
|
472
465
|
(0, actions_1.assertNoActionCollisions)(model, options);
|
|
473
466
|
(0, actions_1.registerActionRoutes)(router, model, options);
|
|
474
467
|
// User endpoints run after actions; actions win on path conflicts.
|
|
@@ -498,6 +491,15 @@ var _buildModelRouter = function (model, options, routePath) {
|
|
|
498
491
|
})];
|
|
499
492
|
case 1:
|
|
500
493
|
doc = (_a.sent()).doc;
|
|
494
|
+
void (0, record_1.maybeRecordModelRouterAudit)({
|
|
495
|
+
after: doc,
|
|
496
|
+
audit: options.audit,
|
|
497
|
+
modelName: model.modelName,
|
|
498
|
+
operation: "create",
|
|
499
|
+
recordId: String(doc._id),
|
|
500
|
+
req: req,
|
|
501
|
+
verb: "created",
|
|
502
|
+
});
|
|
501
503
|
_a.label = 2;
|
|
502
504
|
case 2:
|
|
503
505
|
_a.trys.push([2, 4, , 5]);
|
|
@@ -515,30 +517,29 @@ var _buildModelRouter = function (model, options, routePath) {
|
|
|
515
517
|
}
|
|
516
518
|
});
|
|
517
519
|
}); }));
|
|
518
|
-
// TODO add rate limit
|
|
519
520
|
router.get("/", [
|
|
520
521
|
(0, auth_1.authenticateMiddleware)(options.allowAnonymous),
|
|
521
522
|
(0, permissions_1.permissionMiddleware)(model, options),
|
|
522
523
|
(0, openApi_1.listOpenApiMiddleware)(model, options, routePath),
|
|
523
524
|
queryValidation,
|
|
524
525
|
], (0, exports.asyncHandler)(function (req, res) { return __awaiter(void 0, void 0, void 0, function () {
|
|
525
|
-
var query, _a, _b, queryParam, _c, _d, queryParam, queryFilter, error_2, limit, builtQuery, total, populatedQuery, data, error_3, serialized, error_4, more, msg;
|
|
526
|
-
var e_6,
|
|
527
|
-
var
|
|
528
|
-
return __generator(this, function (
|
|
529
|
-
switch (
|
|
526
|
+
var query, _a, _b, queryParam, _c, _d, queryParam, queryFilter, error_2, _e, _f, _g, key, value, limit, builtQuery, total, populatedQuery, data, error_3, serialized, error_4, more, msg;
|
|
527
|
+
var e_6, _h, e_7, _j, e_8, _k;
|
|
528
|
+
var _l, _m, _o, _p, _q, _r;
|
|
529
|
+
return __generator(this, function (_s) {
|
|
530
|
+
switch (_s.label) {
|
|
530
531
|
case 0:
|
|
531
532
|
query = {};
|
|
532
533
|
try {
|
|
533
|
-
for (_a = __values(Object.keys((
|
|
534
|
+
for (_a = __values(Object.keys((_l = options.defaultQueryParams) !== null && _l !== void 0 ? _l : [])), _b = _a.next(); !_b.done; _b = _a.next()) {
|
|
534
535
|
queryParam = _b.value;
|
|
535
|
-
query[queryParam] = (
|
|
536
|
+
query[queryParam] = (_m = options.defaultQueryParams) === null || _m === void 0 ? void 0 : _m[queryParam];
|
|
536
537
|
}
|
|
537
538
|
}
|
|
538
539
|
catch (e_6_1) { e_6 = { error: e_6_1 }; }
|
|
539
540
|
finally {
|
|
540
541
|
try {
|
|
541
|
-
if (_b && !_b.done && (
|
|
542
|
+
if (_b && !_b.done && (_h = _a.return)) _h.call(_a);
|
|
542
543
|
}
|
|
543
544
|
finally { if (e_6) throw e_6.error; }
|
|
544
545
|
}
|
|
@@ -564,29 +565,29 @@ var _buildModelRouter = function (model, options, routePath) {
|
|
|
564
565
|
catch (e_7_1) { e_7 = { error: e_7_1 }; }
|
|
565
566
|
finally {
|
|
566
567
|
try {
|
|
567
|
-
if (_d && !_d.done && (
|
|
568
|
+
if (_d && !_d.done && (_j = _c.return)) _j.call(_c);
|
|
568
569
|
}
|
|
569
570
|
finally { if (e_7) throw e_7.error; }
|
|
570
571
|
}
|
|
571
572
|
query = mergeDateRangeQueryParams(model, query);
|
|
572
573
|
// Special operators. NOTE: these request Mongo Atlas.
|
|
573
574
|
if (req.query.$search) {
|
|
574
|
-
(
|
|
575
|
+
(_o = mongoose_1.default.connection.db) === null || _o === void 0 ? void 0 : _o.collection(model.collection.collectionName);
|
|
575
576
|
}
|
|
576
577
|
if (req.query.$autocomplete) {
|
|
577
|
-
(
|
|
578
|
+
(_p = mongoose_1.default.connection.db) === null || _p === void 0 ? void 0 : _p.collection(model.collection.collectionName);
|
|
578
579
|
}
|
|
579
580
|
if (!options.queryFilter) return [3 /*break*/, 5];
|
|
580
581
|
queryFilter = void 0;
|
|
581
|
-
|
|
582
|
+
_s.label = 1;
|
|
582
583
|
case 1:
|
|
583
|
-
|
|
584
|
+
_s.trys.push([1, 3, , 4]);
|
|
584
585
|
return [4 /*yield*/, options.queryFilter(req.user, query)];
|
|
585
586
|
case 2:
|
|
586
|
-
queryFilter =
|
|
587
|
+
queryFilter = _s.sent();
|
|
587
588
|
return [3 /*break*/, 4];
|
|
588
589
|
case 3:
|
|
589
|
-
error_2 =
|
|
590
|
+
error_2 = _s.sent();
|
|
590
591
|
throw (0, errors_1.passthroughOrWrap)(error_2, {
|
|
591
592
|
code: "query-filter-error",
|
|
592
593
|
status: 400,
|
|
@@ -599,11 +600,26 @@ var _buildModelRouter = function (model, options, routePath) {
|
|
|
599
600
|
return [2 /*return*/, res.json({ data: [] })];
|
|
600
601
|
}
|
|
601
602
|
query = __assign(__assign({}, query), queryFilter);
|
|
602
|
-
|
|
603
|
+
try {
|
|
604
|
+
for (_e = __values(Object.entries(queryFilter)), _f = _e.next(); !_f.done; _f = _e.next()) {
|
|
605
|
+
_g = __read(_f.value, 2), key = _g[0], value = _g[1];
|
|
606
|
+
if (value === undefined) {
|
|
607
|
+
delete query[key];
|
|
608
|
+
}
|
|
609
|
+
}
|
|
610
|
+
}
|
|
611
|
+
catch (e_8_1) { e_8 = { error: e_8_1 }; }
|
|
612
|
+
finally {
|
|
613
|
+
try {
|
|
614
|
+
if (_f && !_f.done && (_k = _e.return)) _k.call(_e);
|
|
615
|
+
}
|
|
616
|
+
finally { if (e_8) throw e_8.error; }
|
|
617
|
+
}
|
|
618
|
+
_s.label = 5;
|
|
603
619
|
case 5:
|
|
604
|
-
limit = (
|
|
620
|
+
limit = (_q = options.defaultLimit) !== null && _q !== void 0 ? _q : 100;
|
|
605
621
|
if (Number(req.query.limit)) {
|
|
606
|
-
limit = Math.min(Number(req.query.limit), (
|
|
622
|
+
limit = Math.min(Number(req.query.limit), (_r = options.maxLimit) !== null && _r !== void 0 ? _r : 500);
|
|
607
623
|
}
|
|
608
624
|
if (query.period) {
|
|
609
625
|
// need to remove 'period' since it isn't part of any schemas but parsed and applied in
|
|
@@ -613,7 +629,7 @@ var _buildModelRouter = function (model, options, routePath) {
|
|
|
613
629
|
builtQuery = model.find(query).limit(limit + 1);
|
|
614
630
|
return [4 /*yield*/, model.countDocuments(query)];
|
|
615
631
|
case 6:
|
|
616
|
-
total =
|
|
632
|
+
total = _s.sent();
|
|
617
633
|
if (req.query.page) {
|
|
618
634
|
if (Number(req.query.page) === 0 || Number.isNaN(Number(req.query.page))) {
|
|
619
635
|
throw new errors_1.BadRequestError({
|
|
@@ -633,27 +649,27 @@ var _buildModelRouter = function (model, options, routePath) {
|
|
|
633
649
|
builtQuery = builtQuery.sort(options.sort);
|
|
634
650
|
}
|
|
635
651
|
populatedQuery = (0, exports.addPopulateToQuery)(builtQuery, options.populatePaths);
|
|
636
|
-
|
|
652
|
+
_s.label = 7;
|
|
637
653
|
case 7:
|
|
638
|
-
|
|
654
|
+
_s.trys.push([7, 9, , 10]);
|
|
639
655
|
return [4 /*yield*/, populatedQuery.exec()];
|
|
640
656
|
case 8:
|
|
641
|
-
data = (
|
|
657
|
+
data = (_s.sent());
|
|
642
658
|
return [3 /*break*/, 10];
|
|
643
659
|
case 9:
|
|
644
|
-
error_3 =
|
|
660
|
+
error_3 = _s.sent();
|
|
645
661
|
throw (0, errors_1.passthroughOrWrap)(error_3, {
|
|
646
662
|
code: "list-error",
|
|
647
663
|
title: "List error",
|
|
648
664
|
});
|
|
649
665
|
case 10:
|
|
650
|
-
|
|
666
|
+
_s.trys.push([10, 12, , 13]);
|
|
651
667
|
return [4 /*yield*/, responseHandler(data, "list", req, options)];
|
|
652
668
|
case 11:
|
|
653
|
-
serialized =
|
|
669
|
+
serialized = _s.sent();
|
|
654
670
|
return [3 /*break*/, 13];
|
|
655
671
|
case 12:
|
|
656
|
-
error_4 =
|
|
672
|
+
error_4 = _s.sent();
|
|
657
673
|
throw (0, errors_1.passthroughOrWrap)(error_4, {
|
|
658
674
|
code: "response-handler-error",
|
|
659
675
|
title: "responseHandler error",
|
|
@@ -739,7 +755,7 @@ var _buildModelRouter = function (model, options, routePath) {
|
|
|
739
755
|
(0, permissions_1.permissionMiddleware)(model, options),
|
|
740
756
|
updateValidation,
|
|
741
757
|
], (0, exports.asyncHandler)(function (req, res) { return __awaiter(void 0, void 0, void 0, function () {
|
|
742
|
-
var existingDoc, bodyUpdatedAt, preciseUnmodifiedSince, httpUnmodifiedSince, timestampValue, httpTimestampValue, concurrencyCheck, usingPreciseHeader, usingHttpHeader, clientTimestamp, doc, error_6, serialized, serialized, error_7;
|
|
758
|
+
var existingDoc, bodyUpdatedAt, preciseUnmodifiedSince, httpUnmodifiedSince, timestampValue, httpTimestampValue, concurrencyCheck, usingPreciseHeader, usingHttpHeader, clientTimestamp, doc, previous, error_6, serialized, serialized, error_7;
|
|
743
759
|
return __generator(this, function (_a) {
|
|
744
760
|
switch (_a.label) {
|
|
745
761
|
case 0:
|
|
@@ -774,6 +790,7 @@ var _buildModelRouter = function (model, options, routePath) {
|
|
|
774
790
|
type: "timestamp",
|
|
775
791
|
};
|
|
776
792
|
}
|
|
793
|
+
previous = (0, record_1.snapshotAuditBefore)({ audit: options.audit, doc: existingDoc });
|
|
777
794
|
_a.label = 1;
|
|
778
795
|
case 1:
|
|
779
796
|
_a.trys.push([1, 3, , 6]);
|
|
@@ -803,18 +820,30 @@ var _buildModelRouter = function (model, options, routePath) {
|
|
|
803
820
|
})];
|
|
804
821
|
case 5: throw error_6;
|
|
805
822
|
case 6:
|
|
806
|
-
|
|
807
|
-
|
|
823
|
+
void (0, record_1.maybeRecordModelRouterAudit)({
|
|
824
|
+
after: doc,
|
|
825
|
+
audit: options.audit,
|
|
826
|
+
before: previous,
|
|
827
|
+
modelName: model.modelName,
|
|
828
|
+
operation: "update",
|
|
829
|
+
recordId: String(doc._id),
|
|
830
|
+
req: req,
|
|
831
|
+
verb: "updated",
|
|
832
|
+
});
|
|
833
|
+
_a.label = 7;
|
|
808
834
|
case 7:
|
|
835
|
+
_a.trys.push([7, 9, , 10]);
|
|
836
|
+
return [4 /*yield*/, responseHandler(doc, "update", req, options)];
|
|
837
|
+
case 8:
|
|
809
838
|
serialized = _a.sent();
|
|
810
839
|
return [2 /*return*/, res.json({ data: serialized })];
|
|
811
|
-
case
|
|
840
|
+
case 9:
|
|
812
841
|
error_7 = _a.sent();
|
|
813
842
|
throw (0, errors_1.passthroughOrWrap)(error_7, {
|
|
814
843
|
code: "response-handler-error",
|
|
815
844
|
title: "responseHandler error",
|
|
816
845
|
});
|
|
817
|
-
case
|
|
846
|
+
case 10: return [2 /*return*/];
|
|
818
847
|
}
|
|
819
848
|
});
|
|
820
849
|
}); }));
|
|
@@ -823,11 +852,12 @@ var _buildModelRouter = function (model, options, routePath) {
|
|
|
823
852
|
(0, openApi_1.deleteOpenApiMiddleware)(model, options),
|
|
824
853
|
(0, permissions_1.permissionMiddleware)(model, options),
|
|
825
854
|
], (0, exports.asyncHandler)(function (req, res) { return __awaiter(void 0, void 0, void 0, function () {
|
|
826
|
-
var existingDoc;
|
|
855
|
+
var existingDoc, previous;
|
|
827
856
|
return __generator(this, function (_a) {
|
|
828
857
|
switch (_a.label) {
|
|
829
858
|
case 0:
|
|
830
859
|
existingDoc = req.obj;
|
|
860
|
+
previous = (0, record_1.snapshotAuditBefore)({ audit: options.audit, doc: existingDoc });
|
|
831
861
|
return [4 /*yield*/, (0, executors_1.executeDelete)({
|
|
832
862
|
existingDoc: existingDoc,
|
|
833
863
|
id: req.params.id,
|
|
@@ -838,12 +868,21 @@ var _buildModelRouter = function (model, options, routePath) {
|
|
|
838
868
|
})];
|
|
839
869
|
case 1:
|
|
840
870
|
_a.sent();
|
|
871
|
+
void (0, record_1.maybeRecordModelRouterAudit)({
|
|
872
|
+
audit: options.audit,
|
|
873
|
+
before: previous,
|
|
874
|
+
modelName: model.modelName,
|
|
875
|
+
operation: "delete",
|
|
876
|
+
recordId: String(existingDoc._id),
|
|
877
|
+
req: req,
|
|
878
|
+
verb: "deleted",
|
|
879
|
+
});
|
|
841
880
|
return [2 /*return*/, res.status(204).json({})];
|
|
842
881
|
}
|
|
843
882
|
});
|
|
844
883
|
}); }));
|
|
845
884
|
var arrayOperation = function (req, res, operation) { return __awaiter(void 0, void 0, void 0, function () {
|
|
846
|
-
var doc, prevDoc, field, itemId, array, index, body, error_8, error_9, error_10;
|
|
885
|
+
var doc, prevDoc, field, itemId, array, index, body, error_8, error_9, error_10, arrayAuditOperation;
|
|
847
886
|
var _a;
|
|
848
887
|
var _b, _c;
|
|
849
888
|
return __generator(this, function (_d) {
|
|
@@ -1024,9 +1063,21 @@ var _buildModelRouter = function (model, options, routePath) {
|
|
|
1024
1063
|
status: 400,
|
|
1025
1064
|
title: "PATCH Post Update error",
|
|
1026
1065
|
});
|
|
1027
|
-
case 17:
|
|
1028
|
-
|
|
1029
|
-
|
|
1066
|
+
case 17:
|
|
1067
|
+
arrayAuditOperation = operation === "POST" ? "arrayPush" : operation === "PATCH" ? "arrayUpdate" : "arrayRemove";
|
|
1068
|
+
void (0, record_1.maybeRecordModelRouterAudit)({
|
|
1069
|
+
after: doc,
|
|
1070
|
+
audit: options.audit,
|
|
1071
|
+
before: prevDoc,
|
|
1072
|
+
modelName: model.modelName,
|
|
1073
|
+
operation: arrayAuditOperation,
|
|
1074
|
+
recordId: String(doc._id),
|
|
1075
|
+
req: req,
|
|
1076
|
+
verb: "updated",
|
|
1077
|
+
});
|
|
1078
|
+
return [2 /*return*/, res.json({
|
|
1079
|
+
data: (0, transformers_1.serialize)(req, options, doc),
|
|
1080
|
+
})];
|
|
1030
1081
|
}
|
|
1031
1082
|
});
|
|
1032
1083
|
}); };
|