@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
|
@@ -1,11 +1,11 @@
|
|
|
1
|
-
// noExplicitAny: test mock typing
|
|
2
|
-
// biome-ignore-all lint/suspicious/noExplicitAny: test mock typing
|
|
3
1
|
import {afterEach, beforeEach, describe, expect, it} from "bun:test";
|
|
4
2
|
import type {ErrorObject} from "ajv";
|
|
5
3
|
import type {NextFunction, Request, Response} from "express";
|
|
4
|
+
import mongoose from "mongoose";
|
|
6
5
|
|
|
6
|
+
import {ADMIN_LIST_CHOICE_EMPTY_VALUE} from "./adminTypes";
|
|
7
7
|
import {modelRouter} from "./api";
|
|
8
|
-
import {addAuthRoutes, setupAuth} from "./auth";
|
|
8
|
+
import {type UserModel as AuthUserModel, addAuthRoutes, setupAuth} from "./auth";
|
|
9
9
|
import type {OpenApiSchemaProperty} from "./openApiBuilder";
|
|
10
10
|
import {
|
|
11
11
|
buildQuerySchemaFromFields,
|
|
@@ -14,6 +14,7 @@ import {
|
|
|
14
14
|
createValidator,
|
|
15
15
|
getOpenApiValidatorConfig,
|
|
16
16
|
getSchemaFromModel,
|
|
17
|
+
isEscapedRegexLiteral,
|
|
17
18
|
isOpenApiValidatorConfigured,
|
|
18
19
|
resetOpenApiValidatorConfig,
|
|
19
20
|
validateModelRequestBody,
|
|
@@ -40,8 +41,8 @@ const requiredRouterOptions = {
|
|
|
40
41
|
|
|
41
42
|
const setupFreshApp = async () => {
|
|
42
43
|
const freshApp = getBaseServer();
|
|
43
|
-
setupAuth(freshApp, UserModel as
|
|
44
|
-
addAuthRoutes(freshApp, UserModel as
|
|
44
|
+
setupAuth(freshApp, UserModel as unknown as AuthUserModel);
|
|
45
|
+
addAuthRoutes(freshApp, UserModel as unknown as AuthUserModel);
|
|
45
46
|
return freshApp;
|
|
46
47
|
};
|
|
47
48
|
|
|
@@ -113,6 +114,22 @@ describe("openApiValidator", () => {
|
|
|
113
114
|
const res = await admin.post("/required").send({about: "no name"}).expect(400);
|
|
114
115
|
expect(res.body.title).toBe("Request validation failed");
|
|
115
116
|
});
|
|
117
|
+
|
|
118
|
+
it("allows PATCH bodies that omit mongoose required fields", async () => {
|
|
119
|
+
configureOpenApiValidator();
|
|
120
|
+
|
|
121
|
+
const freshApp = await setupFreshApp();
|
|
122
|
+
freshApp.use("/required", modelRouter(RequiredModel, requiredRouterOptions));
|
|
123
|
+
const admin = await authAsUser(freshApp, "admin");
|
|
124
|
+
const created = await admin.post("/required").send({name: "Apple"}).expect(201);
|
|
125
|
+
|
|
126
|
+
const patched = await admin
|
|
127
|
+
.patch(`/required/${created.body.data._id}`)
|
|
128
|
+
.send({about: "partial"})
|
|
129
|
+
.expect(200);
|
|
130
|
+
expect(patched.body.data.name).toBe("Apple");
|
|
131
|
+
expect(patched.body.data.about).toBe("partial");
|
|
132
|
+
});
|
|
116
133
|
});
|
|
117
134
|
|
|
118
135
|
describe("onAdditionalPropertiesRemoved hook", () => {
|
|
@@ -268,9 +285,133 @@ describe("openApiValidator", () => {
|
|
|
268
285
|
expect(schema.hidden).toBeUndefined();
|
|
269
286
|
});
|
|
270
287
|
|
|
271
|
-
it("
|
|
288
|
+
it("does not mark query fields as required", () => {
|
|
272
289
|
const schema = buildQuerySchemaFromFields(FoodModel, ["name"]);
|
|
273
|
-
expect(schema.name.required).
|
|
290
|
+
expect(schema.name.required).toBeUndefined();
|
|
291
|
+
});
|
|
292
|
+
});
|
|
293
|
+
|
|
294
|
+
describe("choice list query validation", () => {
|
|
295
|
+
const priorityListSchema = new mongoose.Schema({
|
|
296
|
+
name: {required: true, type: String},
|
|
297
|
+
priority: {enum: ["low", "high"], type: String},
|
|
298
|
+
});
|
|
299
|
+
const PriorityListModel =
|
|
300
|
+
mongoose.models.OpenApiPriorityList ??
|
|
301
|
+
mongoose.model("OpenApiPriorityList", priorityListSchema);
|
|
302
|
+
|
|
303
|
+
const assertQueryAccepted = (query: Record<string, unknown>): void => {
|
|
304
|
+
configureOpenApiValidator({coerceTypes: true});
|
|
305
|
+
const schema = buildQuerySchemaFromFields(PriorityListModel, ["priority"]);
|
|
306
|
+
const middleware = validateQueryParams(schema);
|
|
307
|
+
let nextCalled = false;
|
|
308
|
+
const req = {method: "GET", path: "/test", query: {...query}} as unknown as Request;
|
|
309
|
+
middleware(req, {} as Response, () => {
|
|
310
|
+
nextCalled = true;
|
|
311
|
+
});
|
|
312
|
+
expect(nextCalled).toBe(true);
|
|
313
|
+
};
|
|
314
|
+
|
|
315
|
+
it("accepts scalar and $in choice query shapes", () => {
|
|
316
|
+
assertQueryAccepted({limit: "25", page: "1", priority: "high"});
|
|
317
|
+
assertQueryAccepted({limit: "25", page: "1", priority: {$in: ["high"]}});
|
|
318
|
+
assertQueryAccepted({
|
|
319
|
+
limit: "25",
|
|
320
|
+
page: "1",
|
|
321
|
+
priority: {$in: ["high", ADMIN_LIST_CHOICE_EMPTY_VALUE]},
|
|
322
|
+
});
|
|
323
|
+
});
|
|
324
|
+
|
|
325
|
+
it("rejects invalid choice query shapes", () => {
|
|
326
|
+
configureOpenApiValidator({coerceTypes: true});
|
|
327
|
+
const schema = buildQuerySchemaFromFields(PriorityListModel, ["priority"]);
|
|
328
|
+
const middleware = validateQueryParams(schema);
|
|
329
|
+
const req = {
|
|
330
|
+
method: "GET",
|
|
331
|
+
path: "/test",
|
|
332
|
+
query: {limit: "25", page: "1", priority: {$in: ["high", "missing"]}},
|
|
333
|
+
} as unknown as Request;
|
|
334
|
+
|
|
335
|
+
expect(() => {
|
|
336
|
+
middleware(req, {} as Response, () => {});
|
|
337
|
+
}).toThrow();
|
|
338
|
+
});
|
|
339
|
+
});
|
|
340
|
+
|
|
341
|
+
describe("isEscapedRegexLiteral", () => {
|
|
342
|
+
it("accepts literal text and escaped metacharacters", () => {
|
|
343
|
+
expect(isEscapedRegexLiteral("alice")).toBe(true);
|
|
344
|
+
expect(isEscapedRegexLiteral("\\.\\*")).toBe(true);
|
|
345
|
+
});
|
|
346
|
+
|
|
347
|
+
it("rejects executable regex patterns", () => {
|
|
348
|
+
expect(isEscapedRegexLiteral(".*")).toBe(false);
|
|
349
|
+
expect(isEscapedRegexLiteral("^x")).toBe(false);
|
|
350
|
+
expect(isEscapedRegexLiteral("[a-z]")).toBe(false);
|
|
351
|
+
});
|
|
352
|
+
});
|
|
353
|
+
|
|
354
|
+
describe("query operator hardening", () => {
|
|
355
|
+
const assertQueryRejected = (query: Record<string, unknown>): void => {
|
|
356
|
+
configureOpenApiValidator({coerceTypes: true, removeAdditional: false});
|
|
357
|
+
const schema = buildQuerySchemaFromFields(FoodModel, ["name"]);
|
|
358
|
+
const middleware = validateQueryParams(schema);
|
|
359
|
+
const req = {method: "GET", path: "/test", query: {...query}} as unknown as Request;
|
|
360
|
+
|
|
361
|
+
expect(() => {
|
|
362
|
+
middleware(req, {} as Response, () => {});
|
|
363
|
+
}).toThrow();
|
|
364
|
+
};
|
|
365
|
+
|
|
366
|
+
const assertQueryAccepted = (query: Record<string, unknown>): void => {
|
|
367
|
+
configureOpenApiValidator({coerceTypes: true, removeAdditional: false});
|
|
368
|
+
const schema = buildQuerySchemaFromFields(FoodModel, ["name"]);
|
|
369
|
+
const middleware = validateQueryParams(schema);
|
|
370
|
+
let nextCalled = false;
|
|
371
|
+
const req = {method: "GET", path: "/test", query: {...query}} as unknown as Request;
|
|
372
|
+
middleware(req, {} as Response, () => {
|
|
373
|
+
nextCalled = true;
|
|
374
|
+
});
|
|
375
|
+
expect(nextCalled).toBe(true);
|
|
376
|
+
};
|
|
377
|
+
|
|
378
|
+
it("accepts escaped literal regex operators", () => {
|
|
379
|
+
assertQueryAccepted({
|
|
380
|
+
name: {$options: "i", $regex: "Green Beans"},
|
|
381
|
+
});
|
|
382
|
+
assertQueryAccepted({
|
|
383
|
+
name: {$options: "i", $regex: "\\.\\*"},
|
|
384
|
+
});
|
|
385
|
+
});
|
|
386
|
+
|
|
387
|
+
it("rejects executable regex operators even when removeAdditional is false", () => {
|
|
388
|
+
assertQueryRejected({
|
|
389
|
+
name: {$options: "i", $regex: ".*"},
|
|
390
|
+
});
|
|
391
|
+
assertQueryRejected({
|
|
392
|
+
name: {$options: "i", $regex: "^x"},
|
|
393
|
+
});
|
|
394
|
+
});
|
|
395
|
+
|
|
396
|
+
it("rejects extra nested operators on $in objects", () => {
|
|
397
|
+
assertQueryRejected({
|
|
398
|
+
name: {$in: ["Apple"], $ne: "Banana"},
|
|
399
|
+
});
|
|
400
|
+
});
|
|
401
|
+
|
|
402
|
+
it("rejects extra nested operators on range objects", () => {
|
|
403
|
+
configureOpenApiValidator({coerceTypes: true, removeAdditional: false});
|
|
404
|
+
const schema = buildQuerySchemaFromFields(FoodModel, ["calories"]);
|
|
405
|
+
const middleware = validateQueryParams(schema);
|
|
406
|
+
const req = {
|
|
407
|
+
method: "GET",
|
|
408
|
+
path: "/test",
|
|
409
|
+
query: {calories: {$gte: 1, $where: "1"}},
|
|
410
|
+
} as unknown as Request;
|
|
411
|
+
|
|
412
|
+
expect(() => {
|
|
413
|
+
middleware(req, {} as Response, () => {});
|
|
414
|
+
}).toThrow();
|
|
274
415
|
});
|
|
275
416
|
});
|
|
276
417
|
|
|
@@ -283,8 +424,8 @@ describe("openApiValidator", () => {
|
|
|
283
424
|
});
|
|
284
425
|
|
|
285
426
|
let nextCalled = false;
|
|
286
|
-
const req = {body: {}} as
|
|
287
|
-
const res = {} as
|
|
427
|
+
const req = {body: {}} as unknown as Request;
|
|
428
|
+
const res = {} as Response;
|
|
288
429
|
const next = () => {
|
|
289
430
|
nextCalled = true;
|
|
290
431
|
};
|
|
@@ -300,8 +441,8 @@ describe("openApiValidator", () => {
|
|
|
300
441
|
name: {required: true, type: "string"},
|
|
301
442
|
});
|
|
302
443
|
|
|
303
|
-
const req = {body: {}, method: "POST", path: "/test"} as
|
|
304
|
-
const res = {} as
|
|
444
|
+
const req = {body: {}, method: "POST", path: "/test"} as unknown as Request;
|
|
445
|
+
const res = {} as Response;
|
|
305
446
|
|
|
306
447
|
expect(() => {
|
|
307
448
|
middleware(req, res, () => {});
|
|
@@ -322,8 +463,8 @@ describe("openApiValidator", () => {
|
|
|
322
463
|
);
|
|
323
464
|
|
|
324
465
|
let nextCalled = false;
|
|
325
|
-
const req = {body: {}, method: "POST", path: "/test"} as
|
|
326
|
-
const res = {} as
|
|
466
|
+
const req = {body: {}, method: "POST", path: "/test"} as unknown as Request;
|
|
467
|
+
const res = {} as Response;
|
|
327
468
|
middleware(req, res, () => {
|
|
328
469
|
nextCalled = true;
|
|
329
470
|
});
|
|
@@ -343,8 +484,8 @@ describe("openApiValidator", () => {
|
|
|
343
484
|
const middleware = validateRequestBody({name: {required: true, type: "string"}});
|
|
344
485
|
|
|
345
486
|
let nextCalled = false;
|
|
346
|
-
const req = {body: {}, method: "POST", path: "/test"} as
|
|
347
|
-
const res = {} as
|
|
487
|
+
const req = {body: {}, method: "POST", path: "/test"} as unknown as Request;
|
|
488
|
+
const res = {} as Response;
|
|
348
489
|
middleware(req, res, () => {
|
|
349
490
|
nextCalled = true;
|
|
350
491
|
});
|
|
@@ -362,8 +503,8 @@ describe("openApiValidator", () => {
|
|
|
362
503
|
);
|
|
363
504
|
|
|
364
505
|
let nextCalled = false;
|
|
365
|
-
const req = {body: {}, method: "POST", path: "/test"} as
|
|
366
|
-
const res = {} as
|
|
506
|
+
const req = {body: {}, method: "POST", path: "/test"} as unknown as Request;
|
|
507
|
+
const res = {} as Response;
|
|
367
508
|
middleware(req, res, () => {
|
|
368
509
|
nextCalled = true;
|
|
369
510
|
});
|
|
@@ -377,8 +518,8 @@ describe("openApiValidator", () => {
|
|
|
377
518
|
const middleware = validateRequestBody({name: {required: true, type: "string"}});
|
|
378
519
|
|
|
379
520
|
let nextCalled = false;
|
|
380
|
-
const req = {body: {}, method: "POST", path: "/test"} as
|
|
381
|
-
const res = {} as
|
|
521
|
+
const req = {body: {}, method: "POST", path: "/test"} as unknown as Request;
|
|
522
|
+
const res = {} as Response;
|
|
382
523
|
middleware(req, res, () => {
|
|
383
524
|
nextCalled = true;
|
|
384
525
|
});
|
|
@@ -396,8 +537,8 @@ describe("openApiValidator", () => {
|
|
|
396
537
|
});
|
|
397
538
|
|
|
398
539
|
let nextCalled = false;
|
|
399
|
-
const req = {method: "GET", path: "/test", query: {}} as
|
|
400
|
-
const res = {} as
|
|
540
|
+
const req = {method: "GET", path: "/test", query: {}} as unknown as Request;
|
|
541
|
+
const res = {} as Response;
|
|
401
542
|
middleware(req, res, () => {
|
|
402
543
|
nextCalled = true;
|
|
403
544
|
});
|
|
@@ -412,8 +553,8 @@ describe("openApiValidator", () => {
|
|
|
412
553
|
page: {type: "number"},
|
|
413
554
|
});
|
|
414
555
|
|
|
415
|
-
const req = {method: "GET", path: "/test", query: {page: "3"}} as
|
|
416
|
-
const res = {} as
|
|
556
|
+
const req = {method: "GET", path: "/test", query: {page: "3"}} as unknown as Request;
|
|
557
|
+
const res = {} as Response;
|
|
417
558
|
middleware(req, res, () => {});
|
|
418
559
|
|
|
419
560
|
expect(req.query.page).toBe(3);
|
|
@@ -426,8 +567,8 @@ describe("openApiValidator", () => {
|
|
|
426
567
|
page: {required: true, type: "number"},
|
|
427
568
|
});
|
|
428
569
|
|
|
429
|
-
const req = {method: "GET", path: "/test", query: {}} as
|
|
430
|
-
const res = {} as
|
|
570
|
+
const req = {method: "GET", path: "/test", query: {}} as unknown as Request;
|
|
571
|
+
const res = {} as Response;
|
|
431
572
|
// Required top-level property missing triggers an error
|
|
432
573
|
// We need required: [] at schema level via required: true on property. Confirm via calling.
|
|
433
574
|
expect(() => {
|
|
@@ -436,7 +577,7 @@ describe("openApiValidator", () => {
|
|
|
436
577
|
});
|
|
437
578
|
|
|
438
579
|
it("uses onError callback for query validation", () => {
|
|
439
|
-
let captured:
|
|
580
|
+
let captured: ErrorObject[] = [];
|
|
440
581
|
configureOpenApiValidator({coerceTypes: false});
|
|
441
582
|
|
|
442
583
|
const middleware = validateQueryParams(
|
|
@@ -449,8 +590,8 @@ describe("openApiValidator", () => {
|
|
|
449
590
|
);
|
|
450
591
|
|
|
451
592
|
let nextCalled = false;
|
|
452
|
-
const req = {method: "GET", path: "/test", query: {}} as
|
|
453
|
-
const res = {} as
|
|
593
|
+
const req = {method: "GET", path: "/test", query: {}} as unknown as Request;
|
|
594
|
+
const res = {} as Response;
|
|
454
595
|
middleware(req, res, () => {
|
|
455
596
|
nextCalled = true;
|
|
456
597
|
});
|
|
@@ -468,8 +609,8 @@ describe("openApiValidator", () => {
|
|
|
468
609
|
);
|
|
469
610
|
|
|
470
611
|
let nextCalled = false;
|
|
471
|
-
const req = {method: "GET", path: "/test", query: {}} as
|
|
472
|
-
const res = {} as
|
|
612
|
+
const req = {method: "GET", path: "/test", query: {}} as unknown as Request;
|
|
613
|
+
const res = {} as Response;
|
|
473
614
|
middleware(req, res, () => {
|
|
474
615
|
nextCalled = true;
|
|
475
616
|
});
|
|
@@ -496,10 +637,7 @@ describe("openApiValidator", () => {
|
|
|
496
637
|
|
|
497
638
|
it("returns errors for invalid response shape", () => {
|
|
498
639
|
configureOpenApiValidator({coerceTypes: false, validateResponses: true});
|
|
499
|
-
const result = validateResponseData(
|
|
500
|
-
{name: 42 as any},
|
|
501
|
-
{name: {required: true, type: "string"}}
|
|
502
|
-
);
|
|
640
|
+
const result = validateResponseData({name: 42}, {name: {required: true, type: "string"}});
|
|
503
641
|
expect(result.valid).toBe(false);
|
|
504
642
|
expect(result.errors).toBeDefined();
|
|
505
643
|
});
|
|
@@ -520,8 +658,8 @@ describe("openApiValidator", () => {
|
|
|
520
658
|
method: "POST",
|
|
521
659
|
path: "/test",
|
|
522
660
|
query: {page: "2"},
|
|
523
|
-
} as
|
|
524
|
-
const res = {} as
|
|
661
|
+
} as unknown as Request;
|
|
662
|
+
const res = {} as Response;
|
|
525
663
|
middleware(req, res, () => {
|
|
526
664
|
nextCalled = true;
|
|
527
665
|
});
|
|
@@ -536,8 +674,8 @@ describe("openApiValidator", () => {
|
|
|
536
674
|
const middleware = createValidator({});
|
|
537
675
|
|
|
538
676
|
let nextCalled = false;
|
|
539
|
-
const req = {body: {}, method: "POST", path: "/test", query: {}} as
|
|
540
|
-
const res = {} as
|
|
677
|
+
const req = {body: {}, method: "POST", path: "/test", query: {}} as unknown as Request;
|
|
678
|
+
const res = {} as Response;
|
|
541
679
|
middleware(req, res, () => {
|
|
542
680
|
nextCalled = true;
|
|
543
681
|
});
|
|
@@ -553,8 +691,8 @@ describe("openApiValidator", () => {
|
|
|
553
691
|
});
|
|
554
692
|
|
|
555
693
|
let nextCalled = false;
|
|
556
|
-
const req = {method: "GET", path: "/test", query: {page: "5"}} as
|
|
557
|
-
const res = {} as
|
|
694
|
+
const req = {method: "GET", path: "/test", query: {page: "5"}} as unknown as Request;
|
|
695
|
+
const res = {} as Response;
|
|
558
696
|
middleware(req, res, () => {
|
|
559
697
|
nextCalled = true;
|
|
560
698
|
});
|
|
@@ -617,8 +755,8 @@ describe("openApiValidator", () => {
|
|
|
617
755
|
query: {page: {type: "number"}},
|
|
618
756
|
});
|
|
619
757
|
|
|
620
|
-
const req = {body: {}, method: "POST", path: "/test", query: {}} as
|
|
621
|
-
const res = {} as
|
|
758
|
+
const req = {body: {}, method: "POST", path: "/test", query: {}} as unknown as Request;
|
|
759
|
+
const res = {} as Response;
|
|
622
760
|
|
|
623
761
|
let nextCalled = false;
|
|
624
762
|
middleware(req, res, () => {
|
|
@@ -645,8 +783,8 @@ describe("openApiValidator", () => {
|
|
|
645
783
|
configureOpenApiValidator({coerceTypes: false});
|
|
646
784
|
const {create} = createModelValidators(RequiredModel);
|
|
647
785
|
|
|
648
|
-
const req = {body: {name: 123}, method: "POST", path: "/required"} as
|
|
649
|
-
const res = {} as
|
|
786
|
+
const req = {body: {name: 123}, method: "POST", path: "/required"} as unknown as Request;
|
|
787
|
+
const res = {} as Response;
|
|
650
788
|
expect(() => {
|
|
651
789
|
create(req, res, () => {});
|
|
652
790
|
}).toThrow();
|
|
@@ -656,8 +794,8 @@ describe("openApiValidator", () => {
|
|
|
656
794
|
const {update} = createModelValidators(RequiredModel);
|
|
657
795
|
|
|
658
796
|
let nextCalled = false;
|
|
659
|
-
const req = {body: {about: "info"}, method: "PATCH", path: "/required"} as
|
|
660
|
-
const res = {} as
|
|
797
|
+
const req = {body: {about: "info"}, method: "PATCH", path: "/required"} as unknown as Request;
|
|
798
|
+
const res = {} as Response;
|
|
661
799
|
update(req, res, () => {
|
|
662
800
|
nextCalled = true;
|
|
663
801
|
});
|
|
@@ -679,14 +817,14 @@ describe("openApiValidator", () => {
|
|
|
679
817
|
body: {extra: "strip me", name: "Apple"},
|
|
680
818
|
method: "POST",
|
|
681
819
|
path: "/required",
|
|
682
|
-
} as
|
|
683
|
-
create(req, {} as
|
|
820
|
+
} as unknown as Request;
|
|
821
|
+
create(req, {} as Response, () => {});
|
|
684
822
|
expect(removedProps).toContain("extra");
|
|
685
823
|
});
|
|
686
824
|
|
|
687
825
|
it("supports onError option", () => {
|
|
688
826
|
configureOpenApiValidator({coerceTypes: false});
|
|
689
|
-
let errorHandled:
|
|
827
|
+
let errorHandled: ErrorObject[] = [];
|
|
690
828
|
const {create} = createModelValidators(RequiredModel, {
|
|
691
829
|
onError: (errors) => {
|
|
692
830
|
errorHandled = errors;
|
|
@@ -694,8 +832,8 @@ describe("openApiValidator", () => {
|
|
|
694
832
|
});
|
|
695
833
|
|
|
696
834
|
// Wrong type triggers error handler
|
|
697
|
-
const req = {body: {name: 42}, method: "POST", path: "/required"} as
|
|
698
|
-
create(req, {} as
|
|
835
|
+
const req = {body: {name: 42}, method: "POST", path: "/required"} as unknown as Request;
|
|
836
|
+
create(req, {} as Response, () => {});
|
|
699
837
|
expect(errorHandled.length).toBeGreaterThan(0);
|
|
700
838
|
});
|
|
701
839
|
});
|
|
@@ -708,8 +846,8 @@ describe("openApiValidator", () => {
|
|
|
708
846
|
it("creates a validator from a Mongoose model", () => {
|
|
709
847
|
const middleware = validateModelRequestBody(RequiredModel);
|
|
710
848
|
|
|
711
|
-
const req = {body: {}, method: "POST", path: "/required"} as
|
|
712
|
-
const res = {} as
|
|
849
|
+
const req = {body: {}, method: "POST", path: "/required"} as unknown as Request;
|
|
850
|
+
const res = {} as Response;
|
|
713
851
|
expect(() => {
|
|
714
852
|
middleware(req, res, () => {});
|
|
715
853
|
}).toThrow();
|
|
@@ -722,8 +860,25 @@ describe("openApiValidator", () => {
|
|
|
722
860
|
|
|
723
861
|
// Without 'name' required, empty body passes
|
|
724
862
|
let nextCalled = false;
|
|
725
|
-
const req = {body: {}, method: "POST", path: "/required"} as
|
|
726
|
-
const res = {} as
|
|
863
|
+
const req = {body: {}, method: "POST", path: "/required"} as unknown as Request;
|
|
864
|
+
const res = {} as Response;
|
|
865
|
+
middleware(req, res, () => {
|
|
866
|
+
nextCalled = true;
|
|
867
|
+
});
|
|
868
|
+
|
|
869
|
+
expect(nextCalled).toBe(true);
|
|
870
|
+
});
|
|
871
|
+
|
|
872
|
+
it("does not require mongoose required fields when partial is true", () => {
|
|
873
|
+
const middleware = validateModelRequestBody(RequiredModel, {partial: true});
|
|
874
|
+
|
|
875
|
+
let nextCalled = false;
|
|
876
|
+
const req = {
|
|
877
|
+
body: {about: "only about"},
|
|
878
|
+
method: "PATCH",
|
|
879
|
+
path: "/required",
|
|
880
|
+
} as unknown as Request;
|
|
881
|
+
const res = {} as Response;
|
|
727
882
|
middleware(req, res, () => {
|
|
728
883
|
nextCalled = true;
|
|
729
884
|
});
|
|
@@ -738,6 +893,65 @@ describe("openApiValidator", () => {
|
|
|
738
893
|
expect(schema.name).toBeDefined();
|
|
739
894
|
expect(schema.about).toBeDefined();
|
|
740
895
|
});
|
|
896
|
+
|
|
897
|
+
it("puts enum constraints on array items, not the array property", () => {
|
|
898
|
+
const enumArraySchema = new mongoose.Schema({
|
|
899
|
+
values: {
|
|
900
|
+
default: ["alpha", "beta"],
|
|
901
|
+
enum: ["alpha", "beta"],
|
|
902
|
+
type: [String],
|
|
903
|
+
},
|
|
904
|
+
});
|
|
905
|
+
const EnumArrayModel =
|
|
906
|
+
mongoose.models.OpenApiValidatorEnumArray ??
|
|
907
|
+
mongoose.model("OpenApiValidatorEnumArray", enumArraySchema);
|
|
908
|
+
|
|
909
|
+
const schema = getSchemaFromModel(EnumArrayModel);
|
|
910
|
+
expect(schema.values).toEqual({
|
|
911
|
+
items: {enum: ["alpha", "beta"], type: "string"},
|
|
912
|
+
type: "array",
|
|
913
|
+
});
|
|
914
|
+
});
|
|
915
|
+
});
|
|
916
|
+
|
|
917
|
+
describe("enum array request bodies", () => {
|
|
918
|
+
const enumArraySchema = new mongoose.Schema({
|
|
919
|
+
label: {required: true, type: String},
|
|
920
|
+
values: {
|
|
921
|
+
enum: ["alpha", "beta"],
|
|
922
|
+
type: [String],
|
|
923
|
+
},
|
|
924
|
+
});
|
|
925
|
+
const EnumArrayModel =
|
|
926
|
+
mongoose.models.OpenApiValidatorEnumArrayRoute ??
|
|
927
|
+
mongoose.model("OpenApiValidatorEnumArrayRoute", enumArraySchema);
|
|
928
|
+
|
|
929
|
+
const enumArrayRouterOptions = {
|
|
930
|
+
permissions: {
|
|
931
|
+
create: [Permissions.IsAuthenticated],
|
|
932
|
+
delete: [Permissions.IsAdmin],
|
|
933
|
+
list: [Permissions.IsAuthenticated],
|
|
934
|
+
read: [Permissions.IsAuthenticated],
|
|
935
|
+
update: [Permissions.IsAuthenticated],
|
|
936
|
+
},
|
|
937
|
+
queryFields: ["label"],
|
|
938
|
+
sort: "-label" as const,
|
|
939
|
+
};
|
|
940
|
+
|
|
941
|
+
it("accepts enum array values on create when validation is enabled", async () => {
|
|
942
|
+
configureOpenApiValidator();
|
|
943
|
+
|
|
944
|
+
const freshApp = await setupFreshApp();
|
|
945
|
+
freshApp.use("/enum-arrays", modelRouter(EnumArrayModel, enumArrayRouterOptions));
|
|
946
|
+
const admin = await authAsUser(freshApp, "admin");
|
|
947
|
+
|
|
948
|
+
const res = await admin
|
|
949
|
+
.post("/enum-arrays")
|
|
950
|
+
.send({label: "sample", values: ["alpha", "beta"]})
|
|
951
|
+
.expect(201);
|
|
952
|
+
|
|
953
|
+
expect(res.body.data.values).toEqual(["alpha", "beta"]);
|
|
954
|
+
});
|
|
741
955
|
});
|
|
742
956
|
|
|
743
957
|
describe("getOpenApiValidatorConfig", () => {
|
|
@@ -747,7 +961,7 @@ describe("openApiValidator", () => {
|
|
|
747
961
|
expect(config.removeAdditional).toBe(false);
|
|
748
962
|
|
|
749
963
|
// Mutating the returned copy should not affect internal state
|
|
750
|
-
|
|
964
|
+
config.removeAdditional = true;
|
|
751
965
|
expect(getOpenApiValidatorConfig().removeAdditional).toBe(false);
|
|
752
966
|
});
|
|
753
967
|
});
|