@engjts/nexus 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +164 -0
- package/dist/advanced/cache/InMemoryCacheStore.d.ts +18 -0
- package/dist/advanced/cache/InMemoryCacheStore.d.ts.map +1 -0
- package/dist/advanced/cache/InMemoryCacheStore.js +60 -0
- package/dist/advanced/cache/InMemoryCacheStore.js.map +1 -0
- package/dist/advanced/cache/MultiTierCache.d.ts +55 -0
- package/dist/advanced/cache/MultiTierCache.d.ts.map +1 -0
- package/dist/advanced/cache/MultiTierCache.js +159 -0
- package/dist/advanced/cache/MultiTierCache.js.map +1 -0
- package/dist/advanced/cache/RedisCacheStore.d.ts +153 -0
- package/dist/advanced/cache/RedisCacheStore.d.ts.map +1 -0
- package/dist/advanced/cache/RedisCacheStore.js +247 -0
- package/dist/advanced/cache/RedisCacheStore.js.map +1 -0
- package/dist/advanced/cache/index.d.ts +6 -0
- package/dist/advanced/cache/index.d.ts.map +1 -0
- package/dist/advanced/cache/index.js +26 -0
- package/dist/advanced/cache/index.js.map +1 -0
- package/dist/advanced/cache/types.d.ts +35 -0
- package/dist/advanced/cache/types.d.ts.map +1 -0
- package/dist/advanced/cache/types.js +3 -0
- package/dist/advanced/cache/types.js.map +1 -0
- package/dist/advanced/graphql/SimpleDataLoader.d.ts +8 -0
- package/dist/advanced/graphql/SimpleDataLoader.d.ts.map +1 -0
- package/dist/advanced/graphql/SimpleDataLoader.js +43 -0
- package/dist/advanced/graphql/SimpleDataLoader.js.map +1 -0
- package/dist/advanced/graphql/index.d.ts +15 -0
- package/dist/advanced/graphql/index.d.ts.map +1 -0
- package/dist/advanced/graphql/index.js +19 -0
- package/dist/advanced/graphql/index.js.map +1 -0
- package/dist/advanced/graphql/server.d.ts +23 -0
- package/dist/advanced/graphql/server.d.ts.map +1 -0
- package/dist/advanced/graphql/server.js +208 -0
- package/dist/advanced/graphql/server.js.map +1 -0
- package/dist/advanced/graphql/types.d.ts +45 -0
- package/dist/advanced/graphql/types.d.ts.map +1 -0
- package/dist/advanced/graphql/types.js +3 -0
- package/dist/advanced/graphql/types.js.map +1 -0
- package/dist/advanced/jobs/InMemoryQueueStore.d.ts +14 -0
- package/dist/advanced/jobs/InMemoryQueueStore.d.ts.map +1 -0
- package/dist/advanced/jobs/InMemoryQueueStore.js +59 -0
- package/dist/advanced/jobs/InMemoryQueueStore.js.map +1 -0
- package/dist/advanced/jobs/JobQueue.d.ts +178 -0
- package/dist/advanced/jobs/JobQueue.d.ts.map +1 -0
- package/dist/advanced/jobs/JobQueue.js +440 -0
- package/dist/advanced/jobs/JobQueue.js.map +1 -0
- package/dist/advanced/jobs/RedisQueueStore.d.ts +157 -0
- package/dist/advanced/jobs/RedisQueueStore.d.ts.map +1 -0
- package/dist/advanced/jobs/RedisQueueStore.js +264 -0
- package/dist/advanced/jobs/RedisQueueStore.js.map +1 -0
- package/dist/advanced/jobs/index.d.ts +6 -0
- package/dist/advanced/jobs/index.d.ts.map +1 -0
- package/dist/advanced/jobs/index.js +26 -0
- package/dist/advanced/jobs/index.js.map +1 -0
- package/dist/advanced/jobs/types.d.ts +64 -0
- package/dist/advanced/jobs/types.d.ts.map +1 -0
- package/dist/advanced/jobs/types.js +3 -0
- package/dist/advanced/jobs/types.js.map +1 -0
- package/dist/advanced/observability/APMManager.d.ts +64 -0
- package/dist/advanced/observability/APMManager.d.ts.map +1 -0
- package/dist/advanced/observability/APMManager.js +150 -0
- package/dist/advanced/observability/APMManager.js.map +1 -0
- package/dist/advanced/observability/AlertManager.d.ts +30 -0
- package/dist/advanced/observability/AlertManager.d.ts.map +1 -0
- package/dist/advanced/observability/AlertManager.js +98 -0
- package/dist/advanced/observability/AlertManager.js.map +1 -0
- package/dist/advanced/observability/MetricRegistry.d.ts +37 -0
- package/dist/advanced/observability/MetricRegistry.d.ts.map +1 -0
- package/dist/advanced/observability/MetricRegistry.js +129 -0
- package/dist/advanced/observability/MetricRegistry.js.map +1 -0
- package/dist/advanced/observability/ObservabilityCenter.d.ts +113 -0
- package/dist/advanced/observability/ObservabilityCenter.d.ts.map +1 -0
- package/dist/advanced/observability/ObservabilityCenter.js +266 -0
- package/dist/advanced/observability/ObservabilityCenter.js.map +1 -0
- package/dist/advanced/observability/StructuredLogger.d.ts +25 -0
- package/dist/advanced/observability/StructuredLogger.d.ts.map +1 -0
- package/dist/advanced/observability/StructuredLogger.js +137 -0
- package/dist/advanced/observability/StructuredLogger.js.map +1 -0
- package/dist/advanced/observability/TracingManager.d.ts +31 -0
- package/dist/advanced/observability/TracingManager.d.ts.map +1 -0
- package/dist/advanced/observability/TracingManager.js +105 -0
- package/dist/advanced/observability/TracingManager.js.map +1 -0
- package/dist/advanced/observability/adapters.d.ts +134 -0
- package/dist/advanced/observability/adapters.d.ts.map +1 -0
- package/dist/advanced/observability/adapters.js +257 -0
- package/dist/advanced/observability/adapters.js.map +1 -0
- package/dist/advanced/observability/createObservabilityMiddleware.d.ts +8 -0
- package/dist/advanced/observability/createObservabilityMiddleware.d.ts.map +1 -0
- package/dist/advanced/observability/createObservabilityMiddleware.js +46 -0
- package/dist/advanced/observability/createObservabilityMiddleware.js.map +1 -0
- package/dist/advanced/observability/index.d.ts +2 -0
- package/dist/advanced/observability/index.d.ts.map +1 -0
- package/dist/advanced/observability/index.js +13 -0
- package/dist/advanced/observability/index.js.map +1 -0
- package/dist/advanced/observability/types.d.ts +182 -0
- package/dist/advanced/observability/types.d.ts.map +1 -0
- package/dist/advanced/observability/types.js +3 -0
- package/dist/advanced/observability/types.js.map +1 -0
- package/dist/advanced/playground/extractPathParams.d.ts +4 -0
- package/dist/advanced/playground/extractPathParams.d.ts.map +1 -0
- package/dist/advanced/playground/extractPathParams.js +8 -0
- package/dist/advanced/playground/extractPathParams.js.map +1 -0
- package/dist/advanced/playground/generateFieldExample.d.ts +2 -0
- package/dist/advanced/playground/generateFieldExample.d.ts.map +1 -0
- package/dist/advanced/playground/generateFieldExample.js +40 -0
- package/dist/advanced/playground/generateFieldExample.js.map +1 -0
- package/dist/advanced/playground/generatePlaygroundHTML.d.ts +3 -0
- package/dist/advanced/playground/generatePlaygroundHTML.d.ts.map +1 -0
- package/dist/advanced/playground/generatePlaygroundHTML.js +1848 -0
- package/dist/advanced/playground/generatePlaygroundHTML.js.map +1 -0
- package/dist/advanced/playground/generateSummary.d.ts +3 -0
- package/dist/advanced/playground/generateSummary.d.ts.map +1 -0
- package/dist/advanced/playground/generateSummary.js +19 -0
- package/dist/advanced/playground/generateSummary.js.map +1 -0
- package/dist/advanced/playground/getTagFromPath.d.ts +2 -0
- package/dist/advanced/playground/getTagFromPath.d.ts.map +1 -0
- package/dist/advanced/playground/getTagFromPath.js +11 -0
- package/dist/advanced/playground/getTagFromPath.js.map +1 -0
- package/dist/advanced/playground/index.d.ts +7 -0
- package/dist/advanced/playground/index.d.ts.map +1 -0
- package/dist/advanced/playground/index.js +10 -0
- package/dist/advanced/playground/index.js.map +1 -0
- package/dist/advanced/playground/playground.d.ts +4 -0
- package/dist/advanced/playground/playground.d.ts.map +1 -0
- package/dist/advanced/playground/playground.js +139 -0
- package/dist/advanced/playground/playground.js.map +1 -0
- package/dist/advanced/playground/types.d.ts +18 -0
- package/dist/advanced/playground/types.d.ts.map +1 -0
- package/dist/advanced/playground/types.js +3 -0
- package/dist/advanced/playground/types.js.map +1 -0
- package/dist/advanced/playground/zodToExample.d.ts +2 -0
- package/dist/advanced/playground/zodToExample.d.ts.map +1 -0
- package/dist/advanced/playground/zodToExample.js +22 -0
- package/dist/advanced/playground/zodToExample.js.map +1 -0
- package/dist/advanced/playground/zodToParams.d.ts +5 -0
- package/dist/advanced/playground/zodToParams.d.ts.map +1 -0
- package/dist/advanced/playground/zodToParams.js +18 -0
- package/dist/advanced/playground/zodToParams.js.map +1 -0
- package/dist/advanced/postman/buildAuth.d.ts +3 -0
- package/dist/advanced/postman/buildAuth.d.ts.map +1 -0
- package/dist/advanced/postman/buildAuth.js +32 -0
- package/dist/advanced/postman/buildAuth.js.map +1 -0
- package/dist/advanced/postman/buildBody.d.ts +3 -0
- package/dist/advanced/postman/buildBody.d.ts.map +1 -0
- package/dist/advanced/postman/buildBody.js +15 -0
- package/dist/advanced/postman/buildBody.js.map +1 -0
- package/dist/advanced/postman/buildQueryParams.d.ts +3 -0
- package/dist/advanced/postman/buildQueryParams.d.ts.map +1 -0
- package/dist/advanced/postman/buildQueryParams.js +26 -0
- package/dist/advanced/postman/buildQueryParams.js.map +1 -0
- package/dist/advanced/postman/buildRequestItem.d.ts +3 -0
- package/dist/advanced/postman/buildRequestItem.d.ts.map +1 -0
- package/dist/advanced/postman/buildRequestItem.js +33 -0
- package/dist/advanced/postman/buildRequestItem.js.map +1 -0
- package/dist/advanced/postman/buildResponses.d.ts +3 -0
- package/dist/advanced/postman/buildResponses.d.ts.map +1 -0
- package/dist/advanced/postman/buildResponses.js +12 -0
- package/dist/advanced/postman/buildResponses.js.map +1 -0
- package/dist/advanced/postman/buildUrl.d.ts +3 -0
- package/dist/advanced/postman/buildUrl.d.ts.map +1 -0
- package/dist/advanced/postman/buildUrl.js +30 -0
- package/dist/advanced/postman/buildUrl.js.map +1 -0
- package/dist/advanced/postman/capitalize.d.ts +2 -0
- package/dist/advanced/postman/capitalize.d.ts.map +1 -0
- package/dist/advanced/postman/capitalize.js +7 -0
- package/dist/advanced/postman/capitalize.js.map +1 -0
- package/dist/advanced/postman/generateCollection.d.ts +3 -0
- package/dist/advanced/postman/generateCollection.d.ts.map +1 -0
- package/dist/advanced/postman/generateCollection.js +50 -0
- package/dist/advanced/postman/generateCollection.js.map +1 -0
- package/dist/advanced/postman/generateEnvironment.d.ts +3 -0
- package/dist/advanced/postman/generateEnvironment.d.ts.map +1 -0
- package/dist/advanced/postman/generateEnvironment.js +33 -0
- package/dist/advanced/postman/generateEnvironment.js.map +1 -0
- package/dist/advanced/postman/generateExampleFromZod.d.ts +2 -0
- package/dist/advanced/postman/generateExampleFromZod.d.ts.map +1 -0
- package/dist/advanced/postman/generateExampleFromZod.js +22 -0
- package/dist/advanced/postman/generateExampleFromZod.js.map +1 -0
- package/dist/advanced/postman/generateFieldExample.d.ts +2 -0
- package/dist/advanced/postman/generateFieldExample.d.ts.map +1 -0
- package/dist/advanced/postman/generateFieldExample.js +55 -0
- package/dist/advanced/postman/generateFieldExample.js.map +1 -0
- package/dist/advanced/postman/generateName.d.ts +3 -0
- package/dist/advanced/postman/generateName.d.ts.map +1 -0
- package/dist/advanced/postman/generateName.js +19 -0
- package/dist/advanced/postman/generateName.js.map +1 -0
- package/dist/advanced/postman/generateUUID.d.ts +2 -0
- package/dist/advanced/postman/generateUUID.d.ts.map +1 -0
- package/dist/advanced/postman/generateUUID.js +14 -0
- package/dist/advanced/postman/generateUUID.js.map +1 -0
- package/dist/advanced/postman/getTagFromPath.d.ts +2 -0
- package/dist/advanced/postman/getTagFromPath.d.ts.map +1 -0
- package/dist/advanced/postman/getTagFromPath.js +12 -0
- package/dist/advanced/postman/getTagFromPath.js.map +1 -0
- package/dist/advanced/postman/index.d.ts +28 -0
- package/dist/advanced/postman/index.d.ts.map +1 -0
- package/dist/advanced/postman/index.js +30 -0
- package/dist/advanced/postman/index.js.map +1 -0
- package/dist/advanced/postman/postman.d.ts +7 -0
- package/dist/advanced/postman/postman.d.ts.map +1 -0
- package/dist/advanced/postman/postman.js +138 -0
- package/dist/advanced/postman/postman.js.map +1 -0
- package/dist/advanced/postman/slugify.d.ts +2 -0
- package/dist/advanced/postman/slugify.d.ts.map +1 -0
- package/dist/advanced/postman/slugify.js +10 -0
- package/dist/advanced/postman/slugify.js.map +1 -0
- package/dist/advanced/postman/types.d.ts +133 -0
- package/dist/advanced/postman/types.d.ts.map +1 -0
- package/dist/advanced/postman/types.js +3 -0
- package/dist/advanced/postman/types.js.map +1 -0
- package/dist/advanced/realtime/index.d.ts +13 -0
- package/dist/advanced/realtime/index.d.ts.map +1 -0
- package/dist/advanced/realtime/index.js +17 -0
- package/dist/advanced/realtime/index.js.map +1 -0
- package/dist/advanced/realtime/websocket.d.ts +60 -0
- package/dist/advanced/realtime/websocket.d.ts.map +1 -0
- package/dist/advanced/realtime/websocket.js +197 -0
- package/dist/advanced/realtime/websocket.js.map +1 -0
- package/dist/advanced/sentry/index.d.ts +287 -0
- package/dist/advanced/sentry/index.d.ts.map +1 -0
- package/dist/advanced/sentry/index.js +1002 -0
- package/dist/advanced/sentry/index.js.map +1 -0
- package/dist/advanced/sentry/types.d.ts +298 -0
- package/dist/advanced/sentry/types.d.ts.map +1 -0
- package/dist/advanced/sentry/types.js +6 -0
- package/dist/advanced/sentry/types.js.map +1 -0
- package/dist/advanced/static/generateDirectoryListing.d.ts +5 -0
- package/dist/advanced/static/generateDirectoryListing.d.ts.map +1 -0
- package/dist/advanced/static/generateDirectoryListing.js +44 -0
- package/dist/advanced/static/generateDirectoryListing.js.map +1 -0
- package/dist/advanced/static/generateETag.d.ts +8 -0
- package/dist/advanced/static/generateETag.d.ts.map +1 -0
- package/dist/advanced/static/generateETag.js +10 -0
- package/dist/advanced/static/generateETag.js.map +1 -0
- package/dist/advanced/static/getMimeType.d.ts +5 -0
- package/dist/advanced/static/getMimeType.d.ts.map +1 -0
- package/dist/advanced/static/getMimeType.js +11 -0
- package/dist/advanced/static/getMimeType.js.map +1 -0
- package/dist/advanced/static/index.d.ts +30 -0
- package/dist/advanced/static/index.d.ts.map +1 -0
- package/dist/advanced/static/index.js +33 -0
- package/dist/advanced/static/index.js.map +1 -0
- package/dist/advanced/static/isSafePath.d.ts +5 -0
- package/dist/advanced/static/isSafePath.d.ts.map +1 -0
- package/dist/advanced/static/isSafePath.js +14 -0
- package/dist/advanced/static/isSafePath.js.map +1 -0
- package/dist/advanced/static/publicDir.d.ts +12 -0
- package/dist/advanced/static/publicDir.d.ts.map +1 -0
- package/dist/advanced/static/publicDir.js +22 -0
- package/dist/advanced/static/publicDir.js.map +1 -0
- package/dist/advanced/static/serveStatic.d.ts +7 -0
- package/dist/advanced/static/serveStatic.d.ts.map +1 -0
- package/dist/advanced/static/serveStatic.js +198 -0
- package/dist/advanced/static/serveStatic.js.map +1 -0
- package/dist/advanced/static/spa.d.ts +14 -0
- package/dist/advanced/static/spa.d.ts.map +1 -0
- package/dist/advanced/static/spa.js +23 -0
- package/dist/advanced/static/spa.js.map +1 -0
- package/dist/advanced/static/types.d.ts +78 -0
- package/dist/advanced/static/types.d.ts.map +1 -0
- package/dist/advanced/static/types.js +67 -0
- package/dist/advanced/static/types.js.map +1 -0
- package/dist/advanced/swagger/SwaggerGenerator.d.ts +19 -0
- package/dist/advanced/swagger/SwaggerGenerator.d.ts.map +1 -0
- package/dist/advanced/swagger/SwaggerGenerator.js +59 -0
- package/dist/advanced/swagger/SwaggerGenerator.js.map +1 -0
- package/dist/advanced/swagger/buildOperation.d.ts +6 -0
- package/dist/advanced/swagger/buildOperation.d.ts.map +1 -0
- package/dist/advanced/swagger/buildOperation.js +54 -0
- package/dist/advanced/swagger/buildOperation.js.map +1 -0
- package/dist/advanced/swagger/buildParameters.d.ts +6 -0
- package/dist/advanced/swagger/buildParameters.d.ts.map +1 -0
- package/dist/advanced/swagger/buildParameters.js +57 -0
- package/dist/advanced/swagger/buildParameters.js.map +1 -0
- package/dist/advanced/swagger/buildRequestBody.d.ts +7 -0
- package/dist/advanced/swagger/buildRequestBody.d.ts.map +1 -0
- package/dist/advanced/swagger/buildRequestBody.js +19 -0
- package/dist/advanced/swagger/buildRequestBody.js.map +1 -0
- package/dist/advanced/swagger/buildResponses.d.ts +7 -0
- package/dist/advanced/swagger/buildResponses.d.ts.map +1 -0
- package/dist/advanced/swagger/buildResponses.js +48 -0
- package/dist/advanced/swagger/buildResponses.js.map +1 -0
- package/dist/advanced/swagger/capitalize.d.ts +2 -0
- package/dist/advanced/swagger/capitalize.d.ts.map +1 -0
- package/dist/advanced/swagger/capitalize.js +7 -0
- package/dist/advanced/swagger/capitalize.js.map +1 -0
- package/dist/advanced/swagger/convertPath.d.ts +6 -0
- package/dist/advanced/swagger/convertPath.d.ts.map +1 -0
- package/dist/advanced/swagger/convertPath.js +11 -0
- package/dist/advanced/swagger/convertPath.js.map +1 -0
- package/dist/advanced/swagger/createSwagger.d.ts +8 -0
- package/dist/advanced/swagger/createSwagger.d.ts.map +1 -0
- package/dist/advanced/swagger/createSwagger.js +12 -0
- package/dist/advanced/swagger/createSwagger.js.map +1 -0
- package/dist/advanced/swagger/generateOperationId.d.ts +6 -0
- package/dist/advanced/swagger/generateOperationId.d.ts.map +1 -0
- package/dist/advanced/swagger/generateOperationId.js +20 -0
- package/dist/advanced/swagger/generateOperationId.js.map +1 -0
- package/dist/advanced/swagger/generateSpec.d.ts +6 -0
- package/dist/advanced/swagger/generateSpec.d.ts.map +1 -0
- package/dist/advanced/swagger/generateSpec.js +85 -0
- package/dist/advanced/swagger/generateSpec.js.map +1 -0
- package/dist/advanced/swagger/generateSummary.d.ts +6 -0
- package/dist/advanced/swagger/generateSummary.d.ts.map +1 -0
- package/dist/advanced/swagger/generateSummary.js +22 -0
- package/dist/advanced/swagger/generateSummary.js.map +1 -0
- package/dist/advanced/swagger/generateSwaggerUI.d.ts +6 -0
- package/dist/advanced/swagger/generateSwaggerUI.d.ts.map +1 -0
- package/dist/advanced/swagger/generateSwaggerUI.js +69 -0
- package/dist/advanced/swagger/generateSwaggerUI.js.map +1 -0
- package/dist/advanced/swagger/generateThemeCss.d.ts +6 -0
- package/dist/advanced/swagger/generateThemeCss.d.ts.map +1 -0
- package/dist/advanced/swagger/generateThemeCss.js +53 -0
- package/dist/advanced/swagger/generateThemeCss.js.map +1 -0
- package/dist/advanced/swagger/index.d.ts +23 -0
- package/dist/advanced/swagger/index.d.ts.map +1 -0
- package/dist/advanced/swagger/index.js +26 -0
- package/dist/advanced/swagger/index.js.map +1 -0
- package/dist/advanced/swagger/swagger.d.ts +36 -0
- package/dist/advanced/swagger/swagger.d.ts.map +1 -0
- package/dist/advanced/swagger/swagger.js +198 -0
- package/dist/advanced/swagger/swagger.js.map +1 -0
- package/dist/advanced/swagger/types.d.ts +210 -0
- package/dist/advanced/swagger/types.d.ts.map +1 -0
- package/dist/advanced/swagger/types.js +3 -0
- package/dist/advanced/swagger/types.js.map +1 -0
- package/dist/advanced/swagger/zodFieldToOpenAPI.d.ts +6 -0
- package/dist/advanced/swagger/zodFieldToOpenAPI.d.ts.map +1 -0
- package/dist/advanced/swagger/zodFieldToOpenAPI.js +86 -0
- package/dist/advanced/swagger/zodFieldToOpenAPI.js.map +1 -0
- package/dist/advanced/swagger/zodSchemaToOpenAPI.d.ts +6 -0
- package/dist/advanced/swagger/zodSchemaToOpenAPI.d.ts.map +1 -0
- package/dist/advanced/swagger/zodSchemaToOpenAPI.js +44 -0
- package/dist/advanced/swagger/zodSchemaToOpenAPI.js.map +1 -0
- package/dist/advanced/swagger/zodToOpenAPI.d.ts +6 -0
- package/dist/advanced/swagger/zodToOpenAPI.d.ts.map +1 -0
- package/dist/advanced/swagger/zodToOpenAPI.js +22 -0
- package/dist/advanced/swagger/zodToOpenAPI.js.map +1 -0
- package/dist/advanced/testing/factory.d.ts +206 -0
- package/dist/advanced/testing/factory.d.ts.map +1 -0
- package/dist/advanced/testing/factory.js +433 -0
- package/dist/advanced/testing/factory.js.map +1 -0
- package/dist/advanced/testing/harness.d.ts +181 -0
- package/dist/advanced/testing/harness.d.ts.map +1 -0
- package/dist/advanced/testing/harness.js +481 -0
- package/dist/advanced/testing/harness.js.map +1 -0
- package/dist/advanced/testing/index.d.ts +235 -0
- package/dist/advanced/testing/index.d.ts.map +1 -0
- package/dist/advanced/testing/index.js +306 -0
- package/dist/advanced/testing/index.js.map +1 -0
- package/dist/advanced/testing/load-test.d.ts +148 -0
- package/dist/advanced/testing/load-test.d.ts.map +1 -0
- package/dist/advanced/testing/load-test.js +490 -0
- package/dist/advanced/testing/load-test.js.map +1 -0
- package/dist/advanced/testing/mock-server.d.ts +166 -0
- package/dist/advanced/testing/mock-server.d.ts.map +1 -0
- package/dist/advanced/testing/mock-server.js +424 -0
- package/dist/advanced/testing/mock-server.js.map +1 -0
- package/dist/advanced/testing/mock.d.ts +248 -0
- package/dist/advanced/testing/mock.d.ts.map +1 -0
- package/dist/advanced/testing/mock.js +549 -0
- package/dist/advanced/testing/mock.js.map +1 -0
- package/dist/cli/bin.d.ts +3 -0
- package/dist/cli/bin.d.ts.map +1 -0
- package/dist/cli/bin.js +10 -0
- package/dist/cli/bin.js.map +1 -0
- package/dist/cli/cli.d.ts +24 -0
- package/dist/cli/cli.d.ts.map +1 -0
- package/dist/cli/cli.js +131 -0
- package/dist/cli/cli.js.map +1 -0
- package/dist/cli/commands/build.d.ts +20 -0
- package/dist/cli/commands/build.d.ts.map +1 -0
- package/dist/cli/commands/build.js +63 -0
- package/dist/cli/commands/build.js.map +1 -0
- package/dist/cli/commands/create.d.ts +13 -0
- package/dist/cli/commands/create.d.ts.map +1 -0
- package/dist/cli/commands/create.js +142 -0
- package/dist/cli/commands/create.js.map +1 -0
- package/dist/cli/commands/dev.d.ts +15 -0
- package/dist/cli/commands/dev.d.ts.map +1 -0
- package/dist/cli/commands/dev.js +77 -0
- package/dist/cli/commands/dev.js.map +1 -0
- package/dist/cli/commands/generate.d.ts +13 -0
- package/dist/cli/commands/generate.d.ts.map +1 -0
- package/dist/cli/commands/generate.js +80 -0
- package/dist/cli/commands/generate.js.map +1 -0
- package/dist/cli/commands/help.d.ts +13 -0
- package/dist/cli/commands/help.d.ts.map +1 -0
- package/dist/cli/commands/help.js +83 -0
- package/dist/cli/commands/help.js.map +1 -0
- package/dist/cli/commands/init.d.ts +11 -0
- package/dist/cli/commands/init.d.ts.map +1 -0
- package/dist/cli/commands/init.js +76 -0
- package/dist/cli/commands/init.js.map +1 -0
- package/dist/cli/commands/version.d.ts +9 -0
- package/dist/cli/commands/version.d.ts.map +1 -0
- package/dist/cli/commands/version.js +35 -0
- package/dist/cli/commands/version.js.map +1 -0
- package/dist/cli/index.d.ts +3 -0
- package/dist/cli/index.d.ts.map +1 -0
- package/dist/cli/index.js +7 -0
- package/dist/cli/index.js.map +1 -0
- package/dist/cli/templates/generators.d.ts +22 -0
- package/dist/cli/templates/generators.d.ts.map +1 -0
- package/dist/cli/templates/generators.js +282 -0
- package/dist/cli/templates/generators.js.map +1 -0
- package/dist/cli/templates/index.d.ts +27 -0
- package/dist/cli/templates/index.d.ts.map +1 -0
- package/dist/cli/templates/index.js +651 -0
- package/dist/cli/templates/index.js.map +1 -0
- package/dist/cli/utils/exec.d.ts +12 -0
- package/dist/cli/utils/exec.d.ts.map +1 -0
- package/dist/cli/utils/exec.js +37 -0
- package/dist/cli/utils/exec.js.map +1 -0
- package/dist/cli/utils/file-system.d.ts +15 -0
- package/dist/cli/utils/file-system.d.ts.map +1 -0
- package/dist/cli/utils/file-system.js +105 -0
- package/dist/cli/utils/file-system.js.map +1 -0
- package/dist/cli/utils/logger.d.ts +40 -0
- package/dist/cli/utils/logger.d.ts.map +1 -0
- package/dist/cli/utils/logger.js +100 -0
- package/dist/cli/utils/logger.js.map +1 -0
- package/dist/core/adapter.d.ts +73 -0
- package/dist/core/adapter.d.ts.map +1 -0
- package/dist/core/adapter.js +27 -0
- package/dist/core/adapter.js.map +1 -0
- package/dist/core/application.d.ts +540 -0
- package/dist/core/application.d.ts.map +1 -0
- package/dist/core/application.js +1111 -0
- package/dist/core/application.js.map +1 -0
- package/dist/core/context-pool.d.ts +52 -0
- package/dist/core/context-pool.d.ts.map +1 -0
- package/dist/core/context-pool.js +111 -0
- package/dist/core/context-pool.js.map +1 -0
- package/dist/core/context.d.ts +148 -0
- package/dist/core/context.d.ts.map +1 -0
- package/dist/core/context.js +367 -0
- package/dist/core/context.js.map +1 -0
- package/dist/core/index.d.ts +23 -0
- package/dist/core/index.d.ts.map +1 -0
- package/dist/core/index.js +77 -0
- package/dist/core/index.js.map +1 -0
- package/dist/core/middleware.d.ts +49 -0
- package/dist/core/middleware.d.ts.map +1 -0
- package/dist/core/middleware.js +215 -0
- package/dist/core/middleware.js.map +1 -0
- package/dist/core/performance/buffer-pool.d.ts +47 -0
- package/dist/core/performance/buffer-pool.d.ts.map +1 -0
- package/dist/core/performance/buffer-pool.js +97 -0
- package/dist/core/performance/buffer-pool.js.map +1 -0
- package/dist/core/performance/jit-compiler.d.ts +73 -0
- package/dist/core/performance/jit-compiler.d.ts.map +1 -0
- package/dist/core/performance/jit-compiler.js +145 -0
- package/dist/core/performance/jit-compiler.js.map +1 -0
- package/dist/core/performance/middleware-optimizer.d.ts +73 -0
- package/dist/core/performance/middleware-optimizer.d.ts.map +1 -0
- package/dist/core/performance/middleware-optimizer.js +138 -0
- package/dist/core/performance/middleware-optimizer.js.map +1 -0
- package/dist/core/plugin/PluginManager.d.ts +93 -0
- package/dist/core/plugin/PluginManager.d.ts.map +1 -0
- package/dist/core/plugin/PluginManager.js +351 -0
- package/dist/core/plugin/PluginManager.js.map +1 -0
- package/dist/core/plugin/builder.d.ts +192 -0
- package/dist/core/plugin/builder.d.ts.map +1 -0
- package/dist/core/plugin/builder.js +319 -0
- package/dist/core/plugin/builder.js.map +1 -0
- package/dist/core/plugin/index.d.ts +31 -0
- package/dist/core/plugin/index.d.ts.map +1 -0
- package/dist/core/plugin/index.js +41 -0
- package/dist/core/plugin/index.js.map +1 -0
- package/dist/core/plugin/types.d.ts +184 -0
- package/dist/core/plugin/types.d.ts.map +1 -0
- package/dist/core/plugin/types.js +17 -0
- package/dist/core/plugin/types.js.map +1 -0
- package/dist/core/router/file-router.d.ts +173 -0
- package/dist/core/router/file-router.d.ts.map +1 -0
- package/dist/core/router/file-router.js +498 -0
- package/dist/core/router/file-router.js.map +1 -0
- package/dist/core/router/index.d.ts +44 -0
- package/dist/core/router/index.d.ts.map +1 -0
- package/dist/core/router/index.js +145 -0
- package/dist/core/router/index.js.map +1 -0
- package/dist/core/router/radix-tree.d.ts +69 -0
- package/dist/core/router/radix-tree.d.ts.map +1 -0
- package/dist/core/router/radix-tree.js +196 -0
- package/dist/core/router/radix-tree.js.map +1 -0
- package/dist/core/store/index.d.ts +15 -0
- package/dist/core/store/index.d.ts.map +1 -0
- package/dist/core/store/index.js +23 -0
- package/dist/core/store/index.js.map +1 -0
- package/dist/core/store/registry.d.ts +80 -0
- package/dist/core/store/registry.d.ts.map +1 -0
- package/dist/core/store/registry.js +156 -0
- package/dist/core/store/registry.js.map +1 -0
- package/dist/core/store/request-store.d.ts +138 -0
- package/dist/core/store/request-store.d.ts.map +1 -0
- package/dist/core/store/request-store.js +209 -0
- package/dist/core/store/request-store.js.map +1 -0
- package/dist/core/store/types.d.ts +140 -0
- package/dist/core/store/types.d.ts.map +1 -0
- package/dist/core/store/types.js +176 -0
- package/dist/core/store/types.js.map +1 -0
- package/dist/core/types.d.ts +470 -0
- package/dist/core/types.d.ts.map +1 -0
- package/dist/core/types.js +106 -0
- package/dist/core/types.js.map +1 -0
- package/dist/database/adapter.d.ts +32 -0
- package/dist/database/adapter.d.ts.map +1 -0
- package/dist/database/adapter.js +3 -0
- package/dist/database/adapter.js.map +1 -0
- package/dist/database/adapters/index.d.ts +2 -0
- package/dist/database/adapters/index.d.ts.map +1 -0
- package/dist/database/adapters/index.js +18 -0
- package/dist/database/adapters/index.js.map +1 -0
- package/dist/database/adapters/mysql.d.ts +160 -0
- package/dist/database/adapters/mysql.d.ts.map +1 -0
- package/dist/database/adapters/mysql.js +501 -0
- package/dist/database/adapters/mysql.js.map +1 -0
- package/dist/database/database.d.ts +27 -0
- package/dist/database/database.d.ts.map +1 -0
- package/dist/database/database.js +59 -0
- package/dist/database/database.js.map +1 -0
- package/dist/database/dialect.d.ts +110 -0
- package/dist/database/dialect.d.ts.map +1 -0
- package/dist/database/dialect.js +269 -0
- package/dist/database/dialect.js.map +1 -0
- package/dist/database/index.d.ts +12 -0
- package/dist/database/index.d.ts.map +1 -0
- package/dist/database/index.js +28 -0
- package/dist/database/index.js.map +1 -0
- package/dist/database/migrations.d.ts +22 -0
- package/dist/database/migrations.d.ts.map +1 -0
- package/dist/database/migrations.js +73 -0
- package/dist/database/migrations.js.map +1 -0
- package/dist/database/optimizer.d.ts +25 -0
- package/dist/database/optimizer.d.ts.map +1 -0
- package/dist/database/optimizer.js +97 -0
- package/dist/database/optimizer.js.map +1 -0
- package/dist/database/query-builder.d.ts +49 -0
- package/dist/database/query-builder.d.ts.map +1 -0
- package/dist/database/query-builder.js +319 -0
- package/dist/database/query-builder.js.map +1 -0
- package/dist/database/realtime.d.ts +24 -0
- package/dist/database/realtime.d.ts.map +1 -0
- package/dist/database/realtime.js +38 -0
- package/dist/database/realtime.js.map +1 -0
- package/dist/database/schema.d.ts +27 -0
- package/dist/database/schema.d.ts.map +1 -0
- package/dist/database/schema.js +47 -0
- package/dist/database/schema.js.map +1 -0
- package/dist/database/transactions.d.ts +13 -0
- package/dist/database/transactions.d.ts.map +1 -0
- package/dist/database/transactions.js +51 -0
- package/dist/database/transactions.js.map +1 -0
- package/dist/database/types.d.ts +68 -0
- package/dist/database/types.d.ts.map +1 -0
- package/dist/database/types.js +3 -0
- package/dist/database/types.js.map +1 -0
- package/dist/deployment/cluster.d.ts +161 -0
- package/dist/deployment/cluster.d.ts.map +1 -0
- package/dist/deployment/cluster.js +336 -0
- package/dist/deployment/cluster.js.map +1 -0
- package/dist/deployment/config.d.ts +209 -0
- package/dist/deployment/config.d.ts.map +1 -0
- package/dist/deployment/config.js +263 -0
- package/dist/deployment/config.js.map +1 -0
- package/dist/deployment/docker.d.ts +168 -0
- package/dist/deployment/docker.d.ts.map +1 -0
- package/dist/deployment/docker.js +437 -0
- package/dist/deployment/docker.js.map +1 -0
- package/dist/deployment/graceful-shutdown.d.ts +130 -0
- package/dist/deployment/graceful-shutdown.d.ts.map +1 -0
- package/dist/deployment/graceful-shutdown.js +271 -0
- package/dist/deployment/graceful-shutdown.js.map +1 -0
- package/dist/deployment/index.d.ts +14 -0
- package/dist/deployment/index.d.ts.map +1 -0
- package/dist/deployment/index.js +33 -0
- package/dist/deployment/index.js.map +1 -0
- package/dist/index.d.ts +39 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +174 -0
- package/dist/index.js.map +1 -0
- package/dist/security/adapter.d.ts +144 -0
- package/dist/security/adapter.d.ts.map +1 -0
- package/dist/security/adapter.js +159 -0
- package/dist/security/adapter.js.map +1 -0
- package/dist/security/auth/JWTPlugin.d.ts +105 -0
- package/dist/security/auth/JWTPlugin.d.ts.map +1 -0
- package/dist/security/auth/JWTPlugin.js +146 -0
- package/dist/security/auth/JWTPlugin.js.map +1 -0
- package/dist/security/auth/JWTProvider.d.ts +104 -0
- package/dist/security/auth/JWTProvider.d.ts.map +1 -0
- package/dist/security/auth/JWTProvider.js +288 -0
- package/dist/security/auth/JWTProvider.js.map +1 -0
- package/dist/security/auth/adapter.d.ts +8 -0
- package/dist/security/auth/adapter.d.ts.map +1 -0
- package/dist/security/auth/adapter.js +29 -0
- package/dist/security/auth/adapter.js.map +1 -0
- package/dist/security/auth/jwt.d.ts +55 -0
- package/dist/security/auth/jwt.d.ts.map +1 -0
- package/dist/security/auth/jwt.js +198 -0
- package/dist/security/auth/jwt.js.map +1 -0
- package/dist/security/auth/middleware.d.ts +64 -0
- package/dist/security/auth/middleware.d.ts.map +1 -0
- package/dist/security/auth/middleware.js +161 -0
- package/dist/security/auth/middleware.js.map +1 -0
- package/dist/security/csrf.d.ts +41 -0
- package/dist/security/csrf.d.ts.map +1 -0
- package/dist/security/csrf.js +185 -0
- package/dist/security/csrf.js.map +1 -0
- package/dist/security/headers.d.ts +34 -0
- package/dist/security/headers.d.ts.map +1 -0
- package/dist/security/headers.js +95 -0
- package/dist/security/headers.js.map +1 -0
- package/dist/security/index.d.ts +19 -0
- package/dist/security/index.d.ts.map +1 -0
- package/dist/security/index.js +65 -0
- package/dist/security/index.js.map +1 -0
- package/dist/security/rate-limit/adapter.d.ts +7 -0
- package/dist/security/rate-limit/adapter.d.ts.map +1 -0
- package/dist/security/rate-limit/adapter.js +8 -0
- package/dist/security/rate-limit/adapter.js.map +1 -0
- package/dist/security/rate-limit/memory.d.ts +28 -0
- package/dist/security/rate-limit/memory.d.ts.map +1 -0
- package/dist/security/rate-limit/memory.js +85 -0
- package/dist/security/rate-limit/memory.js.map +1 -0
- package/dist/security/rate-limit/middleware.d.ts +32 -0
- package/dist/security/rate-limit/middleware.d.ts.map +1 -0
- package/dist/security/rate-limit/middleware.js +159 -0
- package/dist/security/rate-limit/middleware.js.map +1 -0
- package/dist/security/sanitization.d.ts +29 -0
- package/dist/security/sanitization.d.ts.map +1 -0
- package/dist/security/sanitization.js +66 -0
- package/dist/security/sanitization.js.map +1 -0
- package/dist/security/types.d.ts +205 -0
- package/dist/security/types.d.ts.map +1 -0
- package/dist/security/types.js +8 -0
- package/dist/security/types.js.map +1 -0
- package/dist/security/utils.d.ts +19 -0
- package/dist/security/utils.d.ts.map +1 -0
- package/dist/security/utils.js +43 -0
- package/dist/security/utils.js.map +1 -0
- package/documentation/01-getting-started.md +240 -0
- package/documentation/02-context.md +335 -0
- package/documentation/03-routing.md +397 -0
- package/documentation/04-middleware.md +483 -0
- package/documentation/05-validation.md +514 -0
- package/documentation/06-error-handling.md +465 -0
- package/documentation/07-performance.md +364 -0
- package/documentation/08-adapters.md +470 -0
- package/documentation/09-api-reference.md +548 -0
- package/documentation/10-examples.md +582 -0
- package/documentation/11-deployment.md +477 -0
- package/documentation/12-sentry.md +620 -0
- package/documentation/13-sentry-data-storage.md +996 -0
- package/documentation/14-sentry-data-reference.md +457 -0
- package/documentation/15-sentry-summary.md +409 -0
- package/documentation/16-alerts-system.md +745 -0
- package/documentation/17-alert-adapters.md +696 -0
- package/documentation/18-alerts-implementation-summary.md +385 -0
- package/documentation/19-class-based-routing.md +840 -0
- package/documentation/20-websocket-realtime.md +813 -0
- package/documentation/21-cache-system.md +510 -0
- package/documentation/22-job-queue.md +772 -0
- package/documentation/23-sentry-plugin.md +551 -0
- package/documentation/24-testing-utilities.md +1287 -0
- package/documentation/25-api-versioning.md +533 -0
- package/documentation/26-context-store.md +607 -0
- package/documentation/27-dependency-injection.md +329 -0
- package/documentation/28-lifecycle-hooks.md +521 -0
- package/documentation/29-package-structure.md +196 -0
- package/documentation/30-plugin-system.md +414 -0
- package/documentation/31-jwt-authentication.md +597 -0
- package/documentation/32-cli.md +268 -0
- package/documentation/ALERTS-COMPLETE-SUMMARY.md +429 -0
- package/documentation/ALERTS-INDEX.md +330 -0
- package/documentation/ALERTS-QUICK-REFERENCE.md +286 -0
- package/documentation/README.md +178 -0
- package/documentation/index.html +34 -0
- package/modern_framework_paper.md +1870 -0
- package/package.json +178 -0
- package/public/css/style.css +87 -0
- package/public/index.html +34 -0
- package/public/js/app.js +27 -0
- package/src/advanced/cache/InMemoryCacheStore.ts +68 -0
- package/src/advanced/cache/MultiTierCache.ts +194 -0
- package/src/advanced/cache/RedisCacheStore.ts +341 -0
- package/src/advanced/cache/index.ts +5 -0
- package/src/advanced/cache/types.ts +40 -0
- package/src/advanced/graphql/SimpleDataLoader.ts +42 -0
- package/src/advanced/graphql/index.ts +22 -0
- package/src/advanced/graphql/server.ts +252 -0
- package/src/advanced/graphql/types.ts +42 -0
- package/src/advanced/jobs/InMemoryQueueStore.ts +68 -0
- package/src/advanced/jobs/JobQueue.ts +556 -0
- package/src/advanced/jobs/RedisQueueStore.ts +367 -0
- package/src/advanced/jobs/index.ts +5 -0
- package/src/advanced/jobs/types.ts +70 -0
- package/src/advanced/observability/APMManager.ts +163 -0
- package/src/advanced/observability/AlertManager.ts +109 -0
- package/src/advanced/observability/MetricRegistry.ts +151 -0
- package/src/advanced/observability/ObservabilityCenter.ts +304 -0
- package/src/advanced/observability/StructuredLogger.ts +154 -0
- package/src/advanced/observability/TracingManager.ts +117 -0
- package/src/advanced/observability/adapters.ts +304 -0
- package/src/advanced/observability/createObservabilityMiddleware.ts +63 -0
- package/src/advanced/observability/index.ts +11 -0
- package/src/advanced/observability/types.ts +174 -0
- package/src/advanced/playground/extractPathParams.ts +6 -0
- package/src/advanced/playground/generateFieldExample.ts +31 -0
- package/src/advanced/playground/generatePlaygroundHTML.ts +1849 -0
- package/src/advanced/playground/generateSummary.ts +19 -0
- package/src/advanced/playground/getTagFromPath.ts +9 -0
- package/src/advanced/playground/index.ts +8 -0
- package/src/advanced/playground/playground.ts +170 -0
- package/src/advanced/playground/types.ts +20 -0
- package/src/advanced/playground/zodToExample.ts +16 -0
- package/src/advanced/playground/zodToParams.ts +15 -0
- package/src/advanced/postman/buildAuth.ts +31 -0
- package/src/advanced/postman/buildBody.ts +15 -0
- package/src/advanced/postman/buildQueryParams.ts +27 -0
- package/src/advanced/postman/buildRequestItem.ts +36 -0
- package/src/advanced/postman/buildResponses.ts +11 -0
- package/src/advanced/postman/buildUrl.ts +33 -0
- package/src/advanced/postman/capitalize.ts +4 -0
- package/src/advanced/postman/generateCollection.ts +59 -0
- package/src/advanced/postman/generateEnvironment.ts +34 -0
- package/src/advanced/postman/generateExampleFromZod.ts +21 -0
- package/src/advanced/postman/generateFieldExample.ts +45 -0
- package/src/advanced/postman/generateName.ts +20 -0
- package/src/advanced/postman/generateUUID.ts +11 -0
- package/src/advanced/postman/getTagFromPath.ts +10 -0
- package/src/advanced/postman/index.ts +28 -0
- package/src/advanced/postman/postman.ts +156 -0
- package/src/advanced/postman/slugify.ts +7 -0
- package/src/advanced/postman/types.ts +140 -0
- package/src/advanced/realtime/index.ts +18 -0
- package/src/advanced/realtime/websocket.ts +211 -0
- package/src/advanced/sentry/index.ts +1236 -0
- package/src/advanced/sentry/types.ts +355 -0
- package/src/advanced/static/generateDirectoryListing.ts +47 -0
- package/src/advanced/static/generateETag.ts +7 -0
- package/src/advanced/static/getMimeType.ts +9 -0
- package/src/advanced/static/index.ts +32 -0
- package/src/advanced/static/isSafePath.ts +13 -0
- package/src/advanced/static/publicDir.ts +21 -0
- package/src/advanced/static/serveStatic.ts +225 -0
- package/src/advanced/static/spa.ts +24 -0
- package/src/advanced/static/types.ts +159 -0
- package/src/advanced/swagger/SwaggerGenerator.ts +66 -0
- package/src/advanced/swagger/buildOperation.ts +61 -0
- package/src/advanced/swagger/buildParameters.ts +61 -0
- package/src/advanced/swagger/buildRequestBody.ts +21 -0
- package/src/advanced/swagger/buildResponses.ts +54 -0
- package/src/advanced/swagger/capitalize.ts +5 -0
- package/src/advanced/swagger/convertPath.ts +9 -0
- package/src/advanced/swagger/createSwagger.ts +12 -0
- package/src/advanced/swagger/generateOperationId.ts +21 -0
- package/src/advanced/swagger/generateSpec.ts +105 -0
- package/src/advanced/swagger/generateSummary.ts +24 -0
- package/src/advanced/swagger/generateSwaggerUI.ts +70 -0
- package/src/advanced/swagger/generateThemeCss.ts +53 -0
- package/src/advanced/swagger/index.ts +25 -0
- package/src/advanced/swagger/swagger.ts +237 -0
- package/src/advanced/swagger/types.ts +206 -0
- package/src/advanced/swagger/zodFieldToOpenAPI.ts +94 -0
- package/src/advanced/swagger/zodSchemaToOpenAPI.ts +50 -0
- package/src/advanced/swagger/zodToOpenAPI.ts +22 -0
- package/src/advanced/testing/factory.ts +509 -0
- package/src/advanced/testing/harness.ts +612 -0
- package/src/advanced/testing/index.ts +430 -0
- package/src/advanced/testing/load-test.ts +618 -0
- package/src/advanced/testing/mock-server.ts +498 -0
- package/src/advanced/testing/mock.ts +670 -0
- package/src/cli/bin.ts +9 -0
- package/src/cli/cli.ts +155 -0
- package/src/cli/commands/build.ts +73 -0
- package/src/cli/commands/create.ts +166 -0
- package/src/cli/commands/dev.ts +85 -0
- package/src/cli/commands/generate.ts +97 -0
- package/src/cli/commands/help.ts +95 -0
- package/src/cli/commands/init.ts +91 -0
- package/src/cli/commands/version.ts +38 -0
- package/src/cli/index.ts +6 -0
- package/src/cli/templates/generators.ts +309 -0
- package/src/cli/templates/index.ts +679 -0
- package/src/cli/utils/exec.ts +52 -0
- package/src/cli/utils/file-system.ts +78 -0
- package/src/cli/utils/logger.ts +111 -0
- package/src/core/adapter.ts +88 -0
- package/src/core/application.ts +1283 -0
- package/src/core/context-pool.ts +127 -0
- package/src/core/context.ts +412 -0
- package/src/core/index.ts +80 -0
- package/src/core/middleware.ts +262 -0
- package/src/core/performance/buffer-pool.ts +108 -0
- package/src/core/performance/middleware-optimizer.ts +162 -0
- package/src/core/plugin/PluginManager.ts +435 -0
- package/src/core/plugin/builder.ts +358 -0
- package/src/core/plugin/index.ts +50 -0
- package/src/core/plugin/types.ts +214 -0
- package/src/core/router/file-router.ts +594 -0
- package/src/core/router/index.ts +182 -0
- package/src/core/router/radix-tree.ts +226 -0
- package/src/core/store/index.ts +30 -0
- package/src/core/store/registry.ts +178 -0
- package/src/core/store/request-store.ts +240 -0
- package/src/core/store/types.ts +233 -0
- package/src/core/types.ts +574 -0
- package/src/database/adapter.ts +35 -0
- package/src/database/adapters/index.ts +1 -0
- package/src/database/adapters/mysql.ts +669 -0
- package/src/database/database.ts +70 -0
- package/src/database/dialect.ts +388 -0
- package/src/database/index.ts +12 -0
- package/src/database/migrations.ts +86 -0
- package/src/database/optimizer.ts +125 -0
- package/src/database/query-builder.ts +404 -0
- package/src/database/realtime.ts +53 -0
- package/src/database/schema.ts +71 -0
- package/src/database/transactions.ts +56 -0
- package/src/database/types.ts +87 -0
- package/src/deployment/cluster.ts +471 -0
- package/src/deployment/config.ts +454 -0
- package/src/deployment/docker.ts +599 -0
- package/src/deployment/graceful-shutdown.ts +373 -0
- package/src/deployment/index.ts +56 -0
- package/src/index.ts +264 -0
- package/src/security/adapter.ts +318 -0
- package/src/security/auth/JWTPlugin.ts +234 -0
- package/src/security/auth/JWTProvider.ts +316 -0
- package/src/security/auth/adapter.ts +12 -0
- package/src/security/auth/jwt.ts +234 -0
- package/src/security/auth/middleware.ts +188 -0
- package/src/security/csrf.ts +220 -0
- package/src/security/headers.ts +108 -0
- package/src/security/index.ts +60 -0
- package/src/security/rate-limit/adapter.ts +7 -0
- package/src/security/rate-limit/memory.ts +108 -0
- package/src/security/rate-limit/middleware.ts +181 -0
- package/src/security/sanitization.ts +75 -0
- package/src/security/types.ts +240 -0
- package/src/security/utils.ts +52 -0
- package/tsconfig.json +39 -0
|
@@ -0,0 +1,335 @@
|
|
|
1
|
+
# Context API
|
|
2
|
+
|
|
3
|
+
## Overview
|
|
4
|
+
|
|
5
|
+
The **Context** is the heart of Nexus Framework. It replaces the traditional `req` and `res` pattern with a single, unified, immutable object that contains all request and response data.
|
|
6
|
+
|
|
7
|
+
## Why Context?
|
|
8
|
+
|
|
9
|
+
### Traditional Express.js
|
|
10
|
+
```javascript
|
|
11
|
+
app.get('/user/:id', (req, res) => {
|
|
12
|
+
const id = req.params.id;
|
|
13
|
+
const user = getUser(id);
|
|
14
|
+
res.json({ user });
|
|
15
|
+
});
|
|
16
|
+
```
|
|
17
|
+
|
|
18
|
+
### Nexus Framework
|
|
19
|
+
```typescript
|
|
20
|
+
app.get('/user/:id', async (ctx) => {
|
|
21
|
+
const user = await getUser(ctx.params.id);
|
|
22
|
+
return { user }; // Auto-converted to JSON
|
|
23
|
+
});
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
**Benefits:**
|
|
27
|
+
- ✅ Single source of truth
|
|
28
|
+
- ✅ Immutability enables better testing
|
|
29
|
+
- ✅ Type inference works naturally
|
|
30
|
+
- ✅ Easier to extend with custom properties
|
|
31
|
+
|
|
32
|
+
## Context Properties
|
|
33
|
+
|
|
34
|
+
### Request Data
|
|
35
|
+
|
|
36
|
+
#### `ctx.method`
|
|
37
|
+
HTTP method of the request.
|
|
38
|
+
|
|
39
|
+
```typescript
|
|
40
|
+
app.get('/info', async (ctx) => {
|
|
41
|
+
return { method: ctx.method }; // "GET"
|
|
42
|
+
});
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
#### `ctx.path`
|
|
46
|
+
Path of the request (without query string).
|
|
47
|
+
|
|
48
|
+
```typescript
|
|
49
|
+
app.get('/api/users', async (ctx) => {
|
|
50
|
+
return { path: ctx.path }; // "/api/users"
|
|
51
|
+
});
|
|
52
|
+
```
|
|
53
|
+
|
|
54
|
+
#### `ctx.url`
|
|
55
|
+
Full URL object.
|
|
56
|
+
|
|
57
|
+
```typescript
|
|
58
|
+
app.get('/info', async (ctx) => {
|
|
59
|
+
return {
|
|
60
|
+
host: ctx.url.host,
|
|
61
|
+
protocol: ctx.url.protocol
|
|
62
|
+
};
|
|
63
|
+
});
|
|
64
|
+
```
|
|
65
|
+
|
|
66
|
+
#### `ctx.params`
|
|
67
|
+
Route parameters extracted from the path.
|
|
68
|
+
|
|
69
|
+
```typescript
|
|
70
|
+
app.get('/users/:id/posts/:postId', async (ctx) => {
|
|
71
|
+
const { id, postId } = ctx.params;
|
|
72
|
+
return { userId: id, postId };
|
|
73
|
+
});
|
|
74
|
+
```
|
|
75
|
+
|
|
76
|
+
#### `ctx.query`
|
|
77
|
+
Query string parameters.
|
|
78
|
+
|
|
79
|
+
```typescript
|
|
80
|
+
// GET /search?q=nexus&limit=10
|
|
81
|
+
app.get('/search', async (ctx) => {
|
|
82
|
+
const { q, limit } = ctx.query;
|
|
83
|
+
return { query: q, limit: parseInt(limit) };
|
|
84
|
+
});
|
|
85
|
+
```
|
|
86
|
+
|
|
87
|
+
#### `ctx.body`
|
|
88
|
+
Parsed request body (POST, PUT, PATCH).
|
|
89
|
+
|
|
90
|
+
```typescript
|
|
91
|
+
app.post('/users', async (ctx) => {
|
|
92
|
+
const { name, email } = ctx.body;
|
|
93
|
+
return { received: { name, email } };
|
|
94
|
+
});
|
|
95
|
+
```
|
|
96
|
+
|
|
97
|
+
**Automatic parsing for:**
|
|
98
|
+
- `application/json`
|
|
99
|
+
- `application/x-www-form-urlencoded`
|
|
100
|
+
- `text/*`
|
|
101
|
+
|
|
102
|
+
#### `ctx.headers`
|
|
103
|
+
Request headers.
|
|
104
|
+
|
|
105
|
+
```typescript
|
|
106
|
+
app.get('/auth', async (ctx) => {
|
|
107
|
+
const token = ctx.headers.authorization;
|
|
108
|
+
const userAgent = ctx.headers['user-agent'];
|
|
109
|
+
return { token, userAgent };
|
|
110
|
+
});
|
|
111
|
+
```
|
|
112
|
+
|
|
113
|
+
#### `ctx.cookies`
|
|
114
|
+
Cookie management.
|
|
115
|
+
|
|
116
|
+
```typescript
|
|
117
|
+
app.get('/profile', async (ctx) => {
|
|
118
|
+
// Get cookie
|
|
119
|
+
const sessionId = ctx.cookies.get('session');
|
|
120
|
+
|
|
121
|
+
// Set cookie
|
|
122
|
+
ctx.cookies.set('visited', 'true', {
|
|
123
|
+
maxAge: 86400, // 1 day in seconds
|
|
124
|
+
httpOnly: true,
|
|
125
|
+
secure: true,
|
|
126
|
+
sameSite: 'strict'
|
|
127
|
+
});
|
|
128
|
+
|
|
129
|
+
// Delete cookie
|
|
130
|
+
ctx.cookies.delete('old-cookie');
|
|
131
|
+
|
|
132
|
+
return { sessionId };
|
|
133
|
+
});
|
|
134
|
+
```
|
|
135
|
+
|
|
136
|
+
## Response Methods
|
|
137
|
+
|
|
138
|
+
### `ctx.json(data)`
|
|
139
|
+
Return JSON response.
|
|
140
|
+
|
|
141
|
+
```typescript
|
|
142
|
+
app.get('/user', async (ctx) => {
|
|
143
|
+
return ctx.json({
|
|
144
|
+
name: 'John',
|
|
145
|
+
email: 'john@example.com'
|
|
146
|
+
});
|
|
147
|
+
});
|
|
148
|
+
|
|
149
|
+
// Or simply return the object (auto-converted)
|
|
150
|
+
app.get('/user', async (ctx) => {
|
|
151
|
+
return { name: 'John', email: 'john@example.com' };
|
|
152
|
+
});
|
|
153
|
+
```
|
|
154
|
+
|
|
155
|
+
### `ctx.html(content)`
|
|
156
|
+
Return HTML response.
|
|
157
|
+
|
|
158
|
+
```typescript
|
|
159
|
+
app.get('/page', async (ctx) => {
|
|
160
|
+
return ctx.html(`
|
|
161
|
+
<!DOCTYPE html>
|
|
162
|
+
<html>
|
|
163
|
+
<head><title>My Page</title></head>
|
|
164
|
+
<body><h1>Welcome!</h1></body>
|
|
165
|
+
</html>
|
|
166
|
+
`);
|
|
167
|
+
});
|
|
168
|
+
```
|
|
169
|
+
|
|
170
|
+
### `ctx.text(content)`
|
|
171
|
+
Return plain text response.
|
|
172
|
+
|
|
173
|
+
```typescript
|
|
174
|
+
app.get('/robots.txt', async (ctx) => {
|
|
175
|
+
return ctx.text('User-agent: *\nDisallow: /admin/');
|
|
176
|
+
});
|
|
177
|
+
```
|
|
178
|
+
|
|
179
|
+
### `ctx.redirect(url, status?)`
|
|
180
|
+
Redirect to another URL.
|
|
181
|
+
|
|
182
|
+
```typescript
|
|
183
|
+
app.get('/old-page', async (ctx) => {
|
|
184
|
+
return ctx.redirect('/new-page', 301); // Permanent redirect
|
|
185
|
+
});
|
|
186
|
+
|
|
187
|
+
app.get('/login', async (ctx) => {
|
|
188
|
+
return ctx.redirect('/auth/login'); // Default 302
|
|
189
|
+
});
|
|
190
|
+
```
|
|
191
|
+
|
|
192
|
+
### `ctx.stream(readable)`
|
|
193
|
+
Stream a response (for large files).
|
|
194
|
+
|
|
195
|
+
```typescript
|
|
196
|
+
import { createReadStream } from 'fs';
|
|
197
|
+
|
|
198
|
+
app.get('/download', async (ctx) => {
|
|
199
|
+
const stream = createReadStream('./large-file.zip');
|
|
200
|
+
return ctx.stream(stream);
|
|
201
|
+
});
|
|
202
|
+
```
|
|
203
|
+
|
|
204
|
+
## Response Builder
|
|
205
|
+
|
|
206
|
+
Use the response builder for custom status codes and headers:
|
|
207
|
+
|
|
208
|
+
```typescript
|
|
209
|
+
app.get('/custom', async (ctx) => {
|
|
210
|
+
return ctx.response
|
|
211
|
+
.status(201)
|
|
212
|
+
.header('X-Custom-Header', 'value')
|
|
213
|
+
.json({ created: true });
|
|
214
|
+
});
|
|
215
|
+
```
|
|
216
|
+
|
|
217
|
+
## Raw Node.js Objects
|
|
218
|
+
|
|
219
|
+
Access raw Node.js objects when needed:
|
|
220
|
+
|
|
221
|
+
```typescript
|
|
222
|
+
app.get('/raw', async (ctx) => {
|
|
223
|
+
// Access raw request
|
|
224
|
+
const req = ctx.raw.req;
|
|
225
|
+
const contentLength = req.headers['content-length'];
|
|
226
|
+
|
|
227
|
+
// Access raw response
|
|
228
|
+
const res = ctx.raw.res;
|
|
229
|
+
res.setHeader('X-Custom', 'value');
|
|
230
|
+
|
|
231
|
+
return { contentLength };
|
|
232
|
+
});
|
|
233
|
+
```
|
|
234
|
+
|
|
235
|
+
## Custom Context Properties
|
|
236
|
+
|
|
237
|
+
Middleware can add custom properties to the context:
|
|
238
|
+
|
|
239
|
+
```typescript
|
|
240
|
+
// Middleware adds user
|
|
241
|
+
const auth = async (ctx: any, next: any) => {
|
|
242
|
+
ctx.user = await authenticateUser(ctx.headers.authorization);
|
|
243
|
+
return next(ctx);
|
|
244
|
+
};
|
|
245
|
+
|
|
246
|
+
app.get('/profile', {
|
|
247
|
+
middlewares: [auth],
|
|
248
|
+
handler: async (ctx: any) => {
|
|
249
|
+
// ctx.user is now available
|
|
250
|
+
return { user: ctx.user };
|
|
251
|
+
}
|
|
252
|
+
});
|
|
253
|
+
```
|
|
254
|
+
|
|
255
|
+
For type-safe custom properties, see [Middleware Documentation](./04-middleware.md).
|
|
256
|
+
|
|
257
|
+
## Context Pooling
|
|
258
|
+
|
|
259
|
+
Nexus automatically pools context objects for performance. You don't need to do anything - it's built-in!
|
|
260
|
+
|
|
261
|
+
**Performance benefit:** ~60-80% reduction in object allocations.
|
|
262
|
+
|
|
263
|
+
```typescript
|
|
264
|
+
// Get pool statistics
|
|
265
|
+
const app = createApp();
|
|
266
|
+
// ... after some requests
|
|
267
|
+
const stats = app.getPoolStats();
|
|
268
|
+
console.log(stats);
|
|
269
|
+
// {
|
|
270
|
+
// poolSize: 50,
|
|
271
|
+
// maxSize: 100,
|
|
272
|
+
// created: 150,
|
|
273
|
+
// reused: 100,
|
|
274
|
+
// hitRate: 0.67
|
|
275
|
+
// }
|
|
276
|
+
```
|
|
277
|
+
|
|
278
|
+
## Best Practices
|
|
279
|
+
|
|
280
|
+
### ✅ DO: Return data directly
|
|
281
|
+
|
|
282
|
+
```typescript
|
|
283
|
+
app.get('/users', async (ctx) => {
|
|
284
|
+
const users = await getUsers();
|
|
285
|
+
return { users };
|
|
286
|
+
});
|
|
287
|
+
```
|
|
288
|
+
|
|
289
|
+
### ❌ DON'T: Mutate the context
|
|
290
|
+
|
|
291
|
+
```typescript
|
|
292
|
+
// BAD - context is immutable
|
|
293
|
+
app.get('/bad', async (ctx) => {
|
|
294
|
+
ctx.path = '/new-path'; // Won't work!
|
|
295
|
+
});
|
|
296
|
+
```
|
|
297
|
+
|
|
298
|
+
### ✅ DO: Use typed custom properties
|
|
299
|
+
|
|
300
|
+
```typescript
|
|
301
|
+
interface AuthContext extends Context {
|
|
302
|
+
user: User;
|
|
303
|
+
}
|
|
304
|
+
|
|
305
|
+
const handler = async (ctx: AuthContext) => {
|
|
306
|
+
return { userId: ctx.user.id }; // Type-safe!
|
|
307
|
+
};
|
|
308
|
+
```
|
|
309
|
+
|
|
310
|
+
### ✅ DO: Use cookies for session management
|
|
311
|
+
|
|
312
|
+
```typescript
|
|
313
|
+
app.post('/login', async (ctx) => {
|
|
314
|
+
const user = await authenticate(ctx.body);
|
|
315
|
+
|
|
316
|
+
ctx.cookies.set('session', user.sessionId, {
|
|
317
|
+
httpOnly: true,
|
|
318
|
+
secure: true,
|
|
319
|
+
sameSite: 'strict',
|
|
320
|
+
maxAge: 86400
|
|
321
|
+
});
|
|
322
|
+
|
|
323
|
+
return { success: true };
|
|
324
|
+
});
|
|
325
|
+
```
|
|
326
|
+
|
|
327
|
+
## Next Steps
|
|
328
|
+
|
|
329
|
+
- 🛤️ [Routing Guide](./03-routing.md) - Learn about routing
|
|
330
|
+
- 🔌 [Middleware](./04-middleware.md) - Extend context with middleware
|
|
331
|
+
- ✅ [Validation](./05-validation.md) - Validate context data
|
|
332
|
+
|
|
333
|
+
---
|
|
334
|
+
|
|
335
|
+
[← Getting Started](./01-getting-started.md) | [API Reference →](./09-api-reference.md)
|
|
@@ -0,0 +1,397 @@
|
|
|
1
|
+
# Routing Guide
|
|
2
|
+
|
|
3
|
+
## Overview
|
|
4
|
+
|
|
5
|
+
Nexus uses a **Radix Tree** for routing, providing O(log n) lookup performance. The routing system supports static routes, dynamic parameters, and wildcards.
|
|
6
|
+
|
|
7
|
+
## Basic Routes
|
|
8
|
+
|
|
9
|
+
### Static Routes
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
app.get('/about', async (ctx) => {
|
|
13
|
+
return { page: 'about' };
|
|
14
|
+
});
|
|
15
|
+
|
|
16
|
+
app.get('/api/users', async (ctx) => {
|
|
17
|
+
return { users: [] };
|
|
18
|
+
});
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
### HTTP Methods
|
|
22
|
+
|
|
23
|
+
```typescript
|
|
24
|
+
app.get('/resource', async (ctx) => {
|
|
25
|
+
return { method: 'GET' };
|
|
26
|
+
});
|
|
27
|
+
|
|
28
|
+
app.post('/resource', async (ctx) => {
|
|
29
|
+
return { method: 'POST', body: ctx.body };
|
|
30
|
+
});
|
|
31
|
+
|
|
32
|
+
app.put('/resource/:id', async (ctx) => {
|
|
33
|
+
return { method: 'PUT', id: ctx.params.id };
|
|
34
|
+
});
|
|
35
|
+
|
|
36
|
+
app.patch('/resource/:id', async (ctx) => {
|
|
37
|
+
return { method: 'PATCH', id: ctx.params.id };
|
|
38
|
+
});
|
|
39
|
+
|
|
40
|
+
app.delete('/resource/:id', async (ctx) => {
|
|
41
|
+
return { method: 'DELETE', id: ctx.params.id };
|
|
42
|
+
});
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
## Dynamic Routes
|
|
46
|
+
|
|
47
|
+
### Single Parameter
|
|
48
|
+
|
|
49
|
+
```typescript
|
|
50
|
+
app.get('/users/:id', async (ctx) => {
|
|
51
|
+
const userId = ctx.params.id;
|
|
52
|
+
const user = await getUser(userId);
|
|
53
|
+
return { user };
|
|
54
|
+
});
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
### Multiple Parameters
|
|
58
|
+
|
|
59
|
+
```typescript
|
|
60
|
+
app.get('/users/:userId/posts/:postId', async (ctx) => {
|
|
61
|
+
const { userId, postId } = ctx.params;
|
|
62
|
+
const post = await getPost(userId, postId);
|
|
63
|
+
return { post };
|
|
64
|
+
});
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
### Parameter Naming
|
|
68
|
+
|
|
69
|
+
Use descriptive parameter names:
|
|
70
|
+
|
|
71
|
+
```typescript
|
|
72
|
+
// Good
|
|
73
|
+
app.get('/articles/:articleId/comments/:commentId', ...);
|
|
74
|
+
|
|
75
|
+
// Avoid
|
|
76
|
+
app.get('/articles/:id1/comments/:id2', ...);
|
|
77
|
+
```
|
|
78
|
+
|
|
79
|
+
## Wildcard Routes
|
|
80
|
+
|
|
81
|
+
Capture the remaining path with `*`:
|
|
82
|
+
|
|
83
|
+
```typescript
|
|
84
|
+
app.get('/files/*filepath', async (ctx) => {
|
|
85
|
+
const filepath = ctx.params.filepath;
|
|
86
|
+
// filepath = "docs/guide/intro.md" for /files/docs/guide/intro.md
|
|
87
|
+
return { filepath };
|
|
88
|
+
});
|
|
89
|
+
|
|
90
|
+
app.get('/proxy/*', async (ctx) => {
|
|
91
|
+
const path = ctx.params.wildcard; // default name
|
|
92
|
+
return { proxiedPath: path };
|
|
93
|
+
});
|
|
94
|
+
```
|
|
95
|
+
|
|
96
|
+
## Route Priority
|
|
97
|
+
|
|
98
|
+
Routes are matched in this order:
|
|
99
|
+
|
|
100
|
+
1. **Static** - Exact matches
|
|
101
|
+
2. **Parameters** - Dynamic segments (`:param`)
|
|
102
|
+
3. **Wildcards** - Catch-all (`*`)
|
|
103
|
+
|
|
104
|
+
```typescript
|
|
105
|
+
app.get('/users/active', ...); // 1. Matched first
|
|
106
|
+
app.get('/users/:id', ...); // 2. Matched second
|
|
107
|
+
app.get('/users/*', ...); // 3. Matched last
|
|
108
|
+
```
|
|
109
|
+
|
|
110
|
+
Example:
|
|
111
|
+
- `/users/active` → matches static route
|
|
112
|
+
- `/users/123` → matches parameter route
|
|
113
|
+
- `/users/admin/settings` → matches wildcard route
|
|
114
|
+
|
|
115
|
+
## Declarative Route Definition
|
|
116
|
+
|
|
117
|
+
Use the `route()` method for advanced configuration:
|
|
118
|
+
|
|
119
|
+
```typescript
|
|
120
|
+
import { z } from 'zod';
|
|
121
|
+
|
|
122
|
+
app.route({
|
|
123
|
+
method: 'POST',
|
|
124
|
+
path: '/api/users',
|
|
125
|
+
|
|
126
|
+
// Schema validation
|
|
127
|
+
schema: {
|
|
128
|
+
body: z.object({
|
|
129
|
+
name: z.string().min(2),
|
|
130
|
+
email: z.string().email()
|
|
131
|
+
})
|
|
132
|
+
},
|
|
133
|
+
|
|
134
|
+
// Middleware
|
|
135
|
+
middlewares: [authenticate, rateLimit],
|
|
136
|
+
|
|
137
|
+
// Handler
|
|
138
|
+
handler: async (ctx) => {
|
|
139
|
+
const user = await createUser(ctx.body);
|
|
140
|
+
return { user };
|
|
141
|
+
},
|
|
142
|
+
|
|
143
|
+
// Metadata (for documentation)
|
|
144
|
+
meta: {
|
|
145
|
+
description: 'Create a new user',
|
|
146
|
+
tags: ['users'],
|
|
147
|
+
responses: {
|
|
148
|
+
201: 'User created',
|
|
149
|
+
400: 'Validation error'
|
|
150
|
+
}
|
|
151
|
+
}
|
|
152
|
+
});
|
|
153
|
+
```
|
|
154
|
+
|
|
155
|
+
## Route Groups
|
|
156
|
+
|
|
157
|
+
Organize routes by creating separate router modules:
|
|
158
|
+
|
|
159
|
+
### `routes/users.ts`
|
|
160
|
+
|
|
161
|
+
```typescript
|
|
162
|
+
import { Router } from '../nexus';
|
|
163
|
+
|
|
164
|
+
export const userRoutes = (app: Application) => {
|
|
165
|
+
app.get('/users', async (ctx) => {
|
|
166
|
+
return { users: await getUsers() };
|
|
167
|
+
});
|
|
168
|
+
|
|
169
|
+
app.get('/users/:id', async (ctx) => {
|
|
170
|
+
return { user: await getUser(ctx.params.id) };
|
|
171
|
+
});
|
|
172
|
+
|
|
173
|
+
app.post('/users', {
|
|
174
|
+
schema: { /* ... */ },
|
|
175
|
+
handler: async (ctx) => { /* ... */ }
|
|
176
|
+
});
|
|
177
|
+
};
|
|
178
|
+
```
|
|
179
|
+
|
|
180
|
+
### `index.ts`
|
|
181
|
+
|
|
182
|
+
```typescript
|
|
183
|
+
import { createApp } from './nexus';
|
|
184
|
+
import { userRoutes } from './routes/users';
|
|
185
|
+
import { postRoutes } from './routes/posts';
|
|
186
|
+
|
|
187
|
+
const app = createApp();
|
|
188
|
+
|
|
189
|
+
userRoutes(app);
|
|
190
|
+
postRoutes(app);
|
|
191
|
+
|
|
192
|
+
app.listen(3000);
|
|
193
|
+
```
|
|
194
|
+
|
|
195
|
+
## Route Prefixes
|
|
196
|
+
|
|
197
|
+
Create prefixed route groups:
|
|
198
|
+
|
|
199
|
+
```typescript
|
|
200
|
+
const createAPIRoutes = (app: Application, prefix: string) => {
|
|
201
|
+
app.get(`${prefix}/users`, ...);
|
|
202
|
+
app.get(`${prefix}/posts`, ...);
|
|
203
|
+
app.get(`${prefix}/comments`, ...);
|
|
204
|
+
};
|
|
205
|
+
|
|
206
|
+
createAPIRoutes(app, '/api/v1');
|
|
207
|
+
createAPIRoutes(app, '/api/v2');
|
|
208
|
+
```
|
|
209
|
+
|
|
210
|
+
## Query Parameters
|
|
211
|
+
|
|
212
|
+
Access query parameters via `ctx.query`:
|
|
213
|
+
|
|
214
|
+
```typescript
|
|
215
|
+
// GET /search?q=nexus&page=2&limit=20
|
|
216
|
+
app.get('/search', async (ctx) => {
|
|
217
|
+
const query = ctx.query.q;
|
|
218
|
+
const page = parseInt(ctx.query.page) || 1;
|
|
219
|
+
const limit = parseInt(ctx.query.limit) || 10;
|
|
220
|
+
|
|
221
|
+
const results = await search(query, page, limit);
|
|
222
|
+
return { results, page, limit };
|
|
223
|
+
});
|
|
224
|
+
```
|
|
225
|
+
|
|
226
|
+
### Type-Safe Query Validation
|
|
227
|
+
|
|
228
|
+
```typescript
|
|
229
|
+
import { z } from 'zod';
|
|
230
|
+
|
|
231
|
+
app.get('/search', {
|
|
232
|
+
schema: {
|
|
233
|
+
query: z.object({
|
|
234
|
+
q: z.string().min(1),
|
|
235
|
+
page: z.string().regex(/^\d+$/).transform(Number).default('1'),
|
|
236
|
+
limit: z.string().regex(/^\d+$/).transform(Number).default('10')
|
|
237
|
+
})
|
|
238
|
+
},
|
|
239
|
+
handler: async (ctx) => {
|
|
240
|
+
// ctx.query is now typed and validated
|
|
241
|
+
const { q, page, limit } = ctx.query;
|
|
242
|
+
return await search(q, page, limit);
|
|
243
|
+
}
|
|
244
|
+
});
|
|
245
|
+
```
|
|
246
|
+
|
|
247
|
+
## 404 Not Found
|
|
248
|
+
|
|
249
|
+
Nexus automatically returns 404 for unmatched routes:
|
|
250
|
+
|
|
251
|
+
```json
|
|
252
|
+
{
|
|
253
|
+
"error": "Not Found"
|
|
254
|
+
}
|
|
255
|
+
```
|
|
256
|
+
|
|
257
|
+
Custom 404 handler:
|
|
258
|
+
|
|
259
|
+
```typescript
|
|
260
|
+
// Add a wildcard route at the end
|
|
261
|
+
app.get('/*', async (ctx) => {
|
|
262
|
+
return ctx.response.status(404).json({
|
|
263
|
+
error: 'Page not found',
|
|
264
|
+
path: ctx.path
|
|
265
|
+
});
|
|
266
|
+
});
|
|
267
|
+
```
|
|
268
|
+
|
|
269
|
+
## Route Introspection
|
|
270
|
+
|
|
271
|
+
Get all registered routes:
|
|
272
|
+
|
|
273
|
+
```typescript
|
|
274
|
+
const routes = app.getRoutes();
|
|
275
|
+
console.log(routes);
|
|
276
|
+
// [
|
|
277
|
+
// { method: 'GET', path: '/users' },
|
|
278
|
+
// { method: 'GET', path: '/users/:id' },
|
|
279
|
+
// { method: 'POST', path: '/users' }
|
|
280
|
+
// ]
|
|
281
|
+
```
|
|
282
|
+
|
|
283
|
+
Useful for:
|
|
284
|
+
- Generating API documentation
|
|
285
|
+
- Debugging route conflicts
|
|
286
|
+
- Creating route lists
|
|
287
|
+
|
|
288
|
+
## Best Practices
|
|
289
|
+
|
|
290
|
+
### ✅ DO: Use RESTful conventions
|
|
291
|
+
|
|
292
|
+
```typescript
|
|
293
|
+
app.get('/users', ...); // List users
|
|
294
|
+
app.get('/users/:id', ...); // Get user
|
|
295
|
+
app.post('/users', ...); // Create user
|
|
296
|
+
app.put('/users/:id', ...); // Update user (full)
|
|
297
|
+
app.patch('/users/:id', ...); // Update user (partial)
|
|
298
|
+
app.delete('/users/:id', ...); // Delete user
|
|
299
|
+
```
|
|
300
|
+
|
|
301
|
+
### ✅ DO: Version your API
|
|
302
|
+
|
|
303
|
+
```typescript
|
|
304
|
+
app.get('/api/v1/users', ...);
|
|
305
|
+
app.get('/api/v2/users', ...);
|
|
306
|
+
```
|
|
307
|
+
|
|
308
|
+
### ✅ DO: Use specific routes before wildcards
|
|
309
|
+
|
|
310
|
+
```typescript
|
|
311
|
+
// Correct order
|
|
312
|
+
app.get('/admin/dashboard', ...);
|
|
313
|
+
app.get('/admin/*', ...);
|
|
314
|
+
|
|
315
|
+
// Wrong order - dashboard will never be reached
|
|
316
|
+
app.get('/admin/*', ...);
|
|
317
|
+
app.get('/admin/dashboard', ...);
|
|
318
|
+
```
|
|
319
|
+
|
|
320
|
+
### ❌ DON'T: Create ambiguous routes
|
|
321
|
+
|
|
322
|
+
```typescript
|
|
323
|
+
// Ambiguous - which route matches /users/123?
|
|
324
|
+
app.get('/users/:id', ...);
|
|
325
|
+
app.get('/users/:userId', ...); // Same as above!
|
|
326
|
+
```
|
|
327
|
+
|
|
328
|
+
### ✅ DO: Use consistent naming
|
|
329
|
+
|
|
330
|
+
```typescript
|
|
331
|
+
// Good
|
|
332
|
+
app.get('/users/:userId', ...);
|
|
333
|
+
app.get('/users/:userId/posts/:postId', ...);
|
|
334
|
+
|
|
335
|
+
// Inconsistent
|
|
336
|
+
app.get('/users/:id', ...);
|
|
337
|
+
app.get('/users/:userId/posts/:pid', ...);
|
|
338
|
+
```
|
|
339
|
+
|
|
340
|
+
## Performance
|
|
341
|
+
|
|
342
|
+
### Route Matching
|
|
343
|
+
|
|
344
|
+
Nexus uses a **Radix Tree** for O(log n) route lookup:
|
|
345
|
+
|
|
346
|
+
```typescript
|
|
347
|
+
// Fast - even with 1000+ routes
|
|
348
|
+
app.get('/api/v1/users/:id', ...);
|
|
349
|
+
// Lookup time: ~0.001ms
|
|
350
|
+
```
|
|
351
|
+
|
|
352
|
+
### Route Compilation
|
|
353
|
+
|
|
354
|
+
Routes are compiled at startup for optimal performance:
|
|
355
|
+
|
|
356
|
+
```typescript
|
|
357
|
+
const app = createApp({
|
|
358
|
+
enableJIT: true // Enable JIT compilation (default)
|
|
359
|
+
});
|
|
360
|
+
```
|
|
361
|
+
|
|
362
|
+
## Advanced Patterns
|
|
363
|
+
|
|
364
|
+
### Optional Parameters
|
|
365
|
+
|
|
366
|
+
Use query parameters for optional data:
|
|
367
|
+
|
|
368
|
+
```typescript
|
|
369
|
+
// GET /users?role=admin&active=true
|
|
370
|
+
app.get('/users', async (ctx) => {
|
|
371
|
+
const filters = {
|
|
372
|
+
role: ctx.query.role,
|
|
373
|
+
active: ctx.query.active === 'true'
|
|
374
|
+
};
|
|
375
|
+
return await getUsers(filters);
|
|
376
|
+
});
|
|
377
|
+
```
|
|
378
|
+
|
|
379
|
+
### File Extensions
|
|
380
|
+
|
|
381
|
+
```typescript
|
|
382
|
+
app.get('/download/:filename', async (ctx) => {
|
|
383
|
+
const filename = ctx.params.filename;
|
|
384
|
+
// filename includes extension: "document.pdf"
|
|
385
|
+
return ctx.stream(createReadStream(filename));
|
|
386
|
+
});
|
|
387
|
+
```
|
|
388
|
+
|
|
389
|
+
## Next Steps
|
|
390
|
+
|
|
391
|
+
- ✅ [Schema Validation](./05-validation.md) - Validate route parameters
|
|
392
|
+
- 🔌 [Middleware](./04-middleware.md) - Add route-specific middleware
|
|
393
|
+
- 🔒 [Error Handling](./06-error-handling.md) - Handle route errors
|
|
394
|
+
|
|
395
|
+
---
|
|
396
|
+
|
|
397
|
+
[← Context API](./02-context.md) | [Middleware →](./04-middleware.md)
|