@engjts/nexus 0.1.7 → 0.1.9

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (259) hide show
  1. package/dist/advanced/playground/generatePlaygroundHTML.d.ts.map +1 -1
  2. package/dist/advanced/playground/generatePlaygroundHTML.js +107 -0
  3. package/dist/advanced/playground/generatePlaygroundHTML.js.map +1 -1
  4. package/dist/advanced/playground/playground.d.ts +19 -0
  5. package/dist/advanced/playground/playground.d.ts.map +1 -1
  6. package/dist/advanced/playground/playground.js +70 -0
  7. package/dist/advanced/playground/playground.js.map +1 -1
  8. package/dist/advanced/playground/types.d.ts +20 -0
  9. package/dist/advanced/playground/types.d.ts.map +1 -1
  10. package/dist/core/application.d.ts +14 -0
  11. package/dist/core/application.d.ts.map +1 -1
  12. package/dist/core/application.js +173 -71
  13. package/dist/core/application.js.map +1 -1
  14. package/dist/core/context-pool.d.ts +2 -13
  15. package/dist/core/context-pool.d.ts.map +1 -1
  16. package/dist/core/context-pool.js +7 -45
  17. package/dist/core/context-pool.js.map +1 -1
  18. package/dist/core/context.d.ts +108 -5
  19. package/dist/core/context.d.ts.map +1 -1
  20. package/dist/core/context.js +449 -53
  21. package/dist/core/context.js.map +1 -1
  22. package/dist/core/index.d.ts +1 -0
  23. package/dist/core/index.d.ts.map +1 -1
  24. package/dist/core/index.js +9 -1
  25. package/dist/core/index.js.map +1 -1
  26. package/dist/core/middleware.d.ts +6 -0
  27. package/dist/core/middleware.d.ts.map +1 -1
  28. package/dist/core/middleware.js +83 -84
  29. package/dist/core/middleware.js.map +1 -1
  30. package/dist/core/performance/fast-json.d.ts +149 -0
  31. package/dist/core/performance/fast-json.d.ts.map +1 -0
  32. package/dist/core/performance/fast-json.js +473 -0
  33. package/dist/core/performance/fast-json.js.map +1 -0
  34. package/dist/core/router/file-router.d.ts +20 -7
  35. package/dist/core/router/file-router.d.ts.map +1 -1
  36. package/dist/core/router/file-router.js +41 -13
  37. package/dist/core/router/file-router.js.map +1 -1
  38. package/dist/core/router/index.d.ts +6 -0
  39. package/dist/core/router/index.d.ts.map +1 -1
  40. package/dist/core/router/index.js +33 -6
  41. package/dist/core/router/index.js.map +1 -1
  42. package/dist/core/router/radix-tree.d.ts +4 -1
  43. package/dist/core/router/radix-tree.d.ts.map +1 -1
  44. package/dist/core/router/radix-tree.js +7 -3
  45. package/dist/core/router/radix-tree.js.map +1 -1
  46. package/dist/core/serializer.d.ts +251 -0
  47. package/dist/core/serializer.d.ts.map +1 -0
  48. package/dist/core/serializer.js +290 -0
  49. package/dist/core/serializer.js.map +1 -0
  50. package/dist/core/types.d.ts +39 -1
  51. package/dist/core/types.d.ts.map +1 -1
  52. package/dist/core/types.js.map +1 -1
  53. package/dist/index.d.ts +1 -0
  54. package/dist/index.d.ts.map +1 -1
  55. package/dist/index.js +12 -2
  56. package/dist/index.js.map +1 -1
  57. package/package.json +3 -1
  58. package/documentation/01-getting-started.md +0 -240
  59. package/documentation/02-context.md +0 -335
  60. package/documentation/03-routing.md +0 -397
  61. package/documentation/04-middleware.md +0 -483
  62. package/documentation/05-validation.md +0 -514
  63. package/documentation/06-error-handling.md +0 -465
  64. package/documentation/07-performance.md +0 -364
  65. package/documentation/08-adapters.md +0 -470
  66. package/documentation/09-api-reference.md +0 -548
  67. package/documentation/10-examples.md +0 -582
  68. package/documentation/11-deployment.md +0 -477
  69. package/documentation/12-sentry.md +0 -620
  70. package/documentation/13-sentry-data-storage.md +0 -996
  71. package/documentation/14-sentry-data-reference.md +0 -457
  72. package/documentation/15-sentry-summary.md +0 -409
  73. package/documentation/16-alerts-system.md +0 -745
  74. package/documentation/17-alert-adapters.md +0 -696
  75. package/documentation/18-alerts-implementation-summary.md +0 -385
  76. package/documentation/19-class-based-routing.md +0 -840
  77. package/documentation/20-websocket-realtime.md +0 -813
  78. package/documentation/21-cache-system.md +0 -510
  79. package/documentation/22-job-queue.md +0 -772
  80. package/documentation/23-sentry-plugin.md +0 -551
  81. package/documentation/24-testing-utilities.md +0 -1287
  82. package/documentation/25-api-versioning.md +0 -533
  83. package/documentation/26-context-store.md +0 -607
  84. package/documentation/27-dependency-injection.md +0 -329
  85. package/documentation/28-lifecycle-hooks.md +0 -521
  86. package/documentation/29-package-structure.md +0 -196
  87. package/documentation/30-plugin-system.md +0 -414
  88. package/documentation/31-jwt-authentication.md +0 -597
  89. package/documentation/32-cli.md +0 -268
  90. package/documentation/ALERTS-COMPLETE-SUMMARY.md +0 -429
  91. package/documentation/ALERTS-INDEX.md +0 -330
  92. package/documentation/ALERTS-QUICK-REFERENCE.md +0 -286
  93. package/documentation/README.md +0 -178
  94. package/documentation/index.html +0 -34
  95. package/modern_framework_paper.md +0 -1870
  96. package/public/css/style.css +0 -87
  97. package/public/index.html +0 -34
  98. package/public/js/app.js +0 -27
  99. package/src/advanced/cache/InMemoryCacheStore.ts +0 -68
  100. package/src/advanced/cache/MultiTierCache.ts +0 -194
  101. package/src/advanced/cache/RedisCacheStore.ts +0 -341
  102. package/src/advanced/cache/index.ts +0 -5
  103. package/src/advanced/cache/types.ts +0 -40
  104. package/src/advanced/graphql/SimpleDataLoader.ts +0 -42
  105. package/src/advanced/graphql/index.ts +0 -22
  106. package/src/advanced/graphql/server.ts +0 -252
  107. package/src/advanced/graphql/types.ts +0 -42
  108. package/src/advanced/jobs/InMemoryQueueStore.ts +0 -68
  109. package/src/advanced/jobs/JobQueue.ts +0 -556
  110. package/src/advanced/jobs/RedisQueueStore.ts +0 -367
  111. package/src/advanced/jobs/index.ts +0 -5
  112. package/src/advanced/jobs/types.ts +0 -70
  113. package/src/advanced/observability/APMManager.ts +0 -163
  114. package/src/advanced/observability/AlertManager.ts +0 -109
  115. package/src/advanced/observability/MetricRegistry.ts +0 -151
  116. package/src/advanced/observability/ObservabilityCenter.ts +0 -304
  117. package/src/advanced/observability/StructuredLogger.ts +0 -154
  118. package/src/advanced/observability/TracingManager.ts +0 -117
  119. package/src/advanced/observability/adapters.ts +0 -304
  120. package/src/advanced/observability/createObservabilityMiddleware.ts +0 -63
  121. package/src/advanced/observability/index.ts +0 -11
  122. package/src/advanced/observability/types.ts +0 -174
  123. package/src/advanced/playground/extractPathParams.ts +0 -6
  124. package/src/advanced/playground/generateFieldExample.ts +0 -31
  125. package/src/advanced/playground/generatePlaygroundHTML.ts +0 -1849
  126. package/src/advanced/playground/generateSummary.ts +0 -19
  127. package/src/advanced/playground/getTagFromPath.ts +0 -9
  128. package/src/advanced/playground/index.ts +0 -8
  129. package/src/advanced/playground/playground.ts +0 -170
  130. package/src/advanced/playground/types.ts +0 -20
  131. package/src/advanced/playground/zodToExample.ts +0 -16
  132. package/src/advanced/playground/zodToParams.ts +0 -15
  133. package/src/advanced/postman/buildAuth.ts +0 -31
  134. package/src/advanced/postman/buildBody.ts +0 -15
  135. package/src/advanced/postman/buildQueryParams.ts +0 -27
  136. package/src/advanced/postman/buildRequestItem.ts +0 -36
  137. package/src/advanced/postman/buildResponses.ts +0 -11
  138. package/src/advanced/postman/buildUrl.ts +0 -33
  139. package/src/advanced/postman/capitalize.ts +0 -4
  140. package/src/advanced/postman/generateCollection.ts +0 -59
  141. package/src/advanced/postman/generateEnvironment.ts +0 -34
  142. package/src/advanced/postman/generateExampleFromZod.ts +0 -21
  143. package/src/advanced/postman/generateFieldExample.ts +0 -45
  144. package/src/advanced/postman/generateName.ts +0 -20
  145. package/src/advanced/postman/generateUUID.ts +0 -11
  146. package/src/advanced/postman/getTagFromPath.ts +0 -10
  147. package/src/advanced/postman/index.ts +0 -28
  148. package/src/advanced/postman/postman.ts +0 -156
  149. package/src/advanced/postman/slugify.ts +0 -7
  150. package/src/advanced/postman/types.ts +0 -140
  151. package/src/advanced/realtime/index.ts +0 -18
  152. package/src/advanced/realtime/websocket.ts +0 -231
  153. package/src/advanced/sentry/index.ts +0 -1236
  154. package/src/advanced/sentry/types.ts +0 -355
  155. package/src/advanced/static/generateDirectoryListing.ts +0 -47
  156. package/src/advanced/static/generateETag.ts +0 -7
  157. package/src/advanced/static/getMimeType.ts +0 -9
  158. package/src/advanced/static/index.ts +0 -32
  159. package/src/advanced/static/isSafePath.ts +0 -13
  160. package/src/advanced/static/publicDir.ts +0 -21
  161. package/src/advanced/static/serveStatic.ts +0 -225
  162. package/src/advanced/static/spa.ts +0 -24
  163. package/src/advanced/static/types.ts +0 -159
  164. package/src/advanced/swagger/SwaggerGenerator.ts +0 -66
  165. package/src/advanced/swagger/buildOperation.ts +0 -61
  166. package/src/advanced/swagger/buildParameters.ts +0 -61
  167. package/src/advanced/swagger/buildRequestBody.ts +0 -21
  168. package/src/advanced/swagger/buildResponses.ts +0 -54
  169. package/src/advanced/swagger/capitalize.ts +0 -5
  170. package/src/advanced/swagger/convertPath.ts +0 -9
  171. package/src/advanced/swagger/createSwagger.ts +0 -12
  172. package/src/advanced/swagger/generateOperationId.ts +0 -21
  173. package/src/advanced/swagger/generateSpec.ts +0 -105
  174. package/src/advanced/swagger/generateSummary.ts +0 -24
  175. package/src/advanced/swagger/generateSwaggerUI.ts +0 -70
  176. package/src/advanced/swagger/generateThemeCss.ts +0 -53
  177. package/src/advanced/swagger/index.ts +0 -25
  178. package/src/advanced/swagger/swagger.ts +0 -237
  179. package/src/advanced/swagger/types.ts +0 -206
  180. package/src/advanced/swagger/zodFieldToOpenAPI.ts +0 -94
  181. package/src/advanced/swagger/zodSchemaToOpenAPI.ts +0 -50
  182. package/src/advanced/swagger/zodToOpenAPI.ts +0 -22
  183. package/src/advanced/testing/factory.ts +0 -509
  184. package/src/advanced/testing/harness.ts +0 -612
  185. package/src/advanced/testing/index.ts +0 -430
  186. package/src/advanced/testing/load-test.ts +0 -618
  187. package/src/advanced/testing/mock-server.ts +0 -498
  188. package/src/advanced/testing/mock.ts +0 -670
  189. package/src/cli/bin.ts +0 -9
  190. package/src/cli/cli.ts +0 -158
  191. package/src/cli/commands/add.ts +0 -178
  192. package/src/cli/commands/build.ts +0 -73
  193. package/src/cli/commands/create.ts +0 -166
  194. package/src/cli/commands/dev.ts +0 -85
  195. package/src/cli/commands/generate.ts +0 -99
  196. package/src/cli/commands/help.ts +0 -95
  197. package/src/cli/commands/init.ts +0 -91
  198. package/src/cli/commands/version.ts +0 -38
  199. package/src/cli/index.ts +0 -6
  200. package/src/cli/templates/generators.ts +0 -359
  201. package/src/cli/templates/index.ts +0 -680
  202. package/src/cli/utils/exec.ts +0 -52
  203. package/src/cli/utils/file-system.ts +0 -78
  204. package/src/cli/utils/logger.ts +0 -111
  205. package/src/core/adapter.ts +0 -88
  206. package/src/core/application.ts +0 -1335
  207. package/src/core/context-pool.ts +0 -127
  208. package/src/core/context.ts +0 -412
  209. package/src/core/index.ts +0 -80
  210. package/src/core/middleware.ts +0 -262
  211. package/src/core/performance/buffer-pool.ts +0 -108
  212. package/src/core/performance/middleware-optimizer.ts +0 -162
  213. package/src/core/plugin/PluginManager.ts +0 -435
  214. package/src/core/plugin/builder.ts +0 -358
  215. package/src/core/plugin/index.ts +0 -50
  216. package/src/core/plugin/types.ts +0 -214
  217. package/src/core/router/file-router.ts +0 -594
  218. package/src/core/router/index.ts +0 -227
  219. package/src/core/router/radix-tree.ts +0 -226
  220. package/src/core/store/index.ts +0 -30
  221. package/src/core/store/registry.ts +0 -178
  222. package/src/core/store/request-store.ts +0 -240
  223. package/src/core/store/types.ts +0 -233
  224. package/src/core/types.ts +0 -574
  225. package/src/database/adapter.ts +0 -35
  226. package/src/database/adapters/index.ts +0 -1
  227. package/src/database/adapters/mysql.ts +0 -669
  228. package/src/database/database.ts +0 -70
  229. package/src/database/dialect.ts +0 -388
  230. package/src/database/index.ts +0 -12
  231. package/src/database/migrations.ts +0 -86
  232. package/src/database/optimizer.ts +0 -125
  233. package/src/database/query-builder.ts +0 -404
  234. package/src/database/realtime.ts +0 -53
  235. package/src/database/schema.ts +0 -71
  236. package/src/database/transactions.ts +0 -56
  237. package/src/database/types.ts +0 -87
  238. package/src/deployment/cluster.ts +0 -471
  239. package/src/deployment/config.ts +0 -454
  240. package/src/deployment/docker.ts +0 -599
  241. package/src/deployment/graceful-shutdown.ts +0 -373
  242. package/src/deployment/index.ts +0 -56
  243. package/src/index.ts +0 -264
  244. package/src/security/adapter.ts +0 -318
  245. package/src/security/auth/JWTPlugin.ts +0 -234
  246. package/src/security/auth/JWTProvider.ts +0 -316
  247. package/src/security/auth/adapter.ts +0 -12
  248. package/src/security/auth/jwt.ts +0 -234
  249. package/src/security/auth/middleware.ts +0 -188
  250. package/src/security/csrf.ts +0 -220
  251. package/src/security/headers.ts +0 -108
  252. package/src/security/index.ts +0 -60
  253. package/src/security/rate-limit/adapter.ts +0 -7
  254. package/src/security/rate-limit/memory.ts +0 -108
  255. package/src/security/rate-limit/middleware.ts +0 -181
  256. package/src/security/sanitization.ts +0 -75
  257. package/src/security/types.ts +0 -240
  258. package/src/security/utils.ts +0 -52
  259. package/tsconfig.json +0 -39
@@ -1,178 +0,0 @@
1
- # Nexus Framework Documentation
2
-
3
- Welcome to the comprehensive documentation for **Nexus Framework** - a modern, async-first web framework built with TypeScript, performance, and developer experience in mind.
4
-
5
- ## 📚 Documentation Structure
6
-
7
- ### Getting Started
8
- - **[01. Getting Started](./01-getting-started.md)** - Installation, first app, and core concepts
9
-
10
- ### Core Features
11
- - **[02. Context API](./02-context.md)** - Unified request/response context
12
- - **[03. Routing](./03-routing.md)** - Static, dynamic, and wildcard routes
13
- - **[04. Middleware](./04-middleware.md)** - Type-safe composable middleware
14
- - **[05. Validation](./05-validation.md)** - Schema validation with Zod
15
- - **[06. Error Handling](./06-error-handling.md)** - Automatic error handling
16
-
17
- ### Advanced Topics
18
- - **[07. Performance](./07-performance.md)** - Optimization features and benchmarking
19
- - **[08. Adapters](./08-adapters.md)** - Extensibility and plugin system
20
-
21
- ### Reference
22
- - **[09. API Reference](./09-api-reference.md)** - Complete API documentation
23
- - **[10. Examples](./10-examples.md)** - Real-world use cases
24
-
25
- ### Advanced Patterns
26
- - **[24. Testing Utilities](./24-testing-utilities.md)** - Testing your API
27
- - **[25. API Versioning](./25-api-versioning.md)** - Multiple API versions
28
-
29
- ## 🚀 Quick Links
30
-
31
- ### For Beginners
32
- 1. Start with [Getting Started](./01-getting-started.md)
33
- 2. Learn about [Context API](./02-context.md)
34
- 3. Explore [Routing](./03-routing.md)
35
-
36
- ### For Experienced Developers
37
- 1. Review [Middleware](./04-middleware.md) patterns
38
- 2. Implement [Validation](./05-validation.md)
39
- 3. Optimize with [Performance](./07-performance.md) features
40
-
41
- ### Common Tasks
42
-
43
- | Task | Documentation |
44
- |------|--------------|
45
- | Create a REST API | [Examples - REST API](./10-examples.md#rest-api) |
46
- | Add authentication | [Examples - Authentication](./10-examples.md#authentication) |
47
- | Validate input | [Validation Guide](./05-validation.md) |
48
- | Handle errors | [Error Handling](./06-error-handling.md) |
49
- | Optimize performance | [Performance Guide](./07-performance.md) |
50
- | Create plugins | [Adapters](./08-adapters.md) |
51
- | Version your API | [API Versioning](./25-api-versioning.md) |
52
-
53
- ## 🎯 Key Features
54
-
55
- ### ✨ **Unified Context**
56
- Single immutable object replacing `req` and `res`
57
- ```typescript
58
- app.get('/user/:id', async (ctx) => {
59
- return { user: await getUser(ctx.params.id) };
60
- });
61
- ```
62
-
63
- ### 🚀 **Async-First**
64
- Native async/await with automatic error handling
65
- ```typescript
66
- // No try-catch needed!
67
- app.get('/data', async (ctx) => {
68
- const data = await fetchData();
69
- return { data };
70
- });
71
- ```
72
-
73
- ### 🔒 **Type-Safe**
74
- Full TypeScript support with schema validation
75
- ```typescript
76
- app.post('/users', {
77
- schema: { body: z.object({ name: z.string() }) },
78
- handler: async (ctx) => {
79
- // ctx.body is typed!
80
- return await createUser(ctx.body);
81
- }
82
- });
83
- ```
84
-
85
- ### ⚡ **High Performance**
86
- - Context pooling reduces GC pressure by 60-80%
87
- - Radix tree routing for O(log n) lookup
88
- - JIT compilation for hot paths
89
- - Zero-copy buffer handling
90
-
91
- ### 🧩 **Extensible**
92
- Adapter pattern for plugins and custom implementations
93
- ```typescript
94
- app.adapter('logger', new PinoLogger());
95
- app.plugin(analyticsPlugin);
96
- ```
97
-
98
- ## 📖 Learning Path
99
-
100
- ### Beginner (< 1 hour)
101
- 1. [Getting Started](./01-getting-started.md) - 15 min
102
- 2. [Context API](./02-context.md) - 20 min
103
- 3. [Routing Basics](./03-routing.md) - 15 min
104
-
105
- ### Intermediate (1-2 hours)
106
- 4. [Middleware](./04-middleware.md) - 30 min
107
- 5. [Validation](./05-validation.md) - 30 min
108
- 6. [Error Handling](./06-error-handling.md) - 20 min
109
-
110
- ### Advanced (2+ hours)
111
- 7. [Performance](./07-performance.md) - 30 min
112
- 8. [Adapters](./08-adapters.md) - 45 min
113
- 9. Build a [complete application](./10-examples.md) - 1+ hour
114
-
115
- ## 💡 Example Application
116
-
117
- ```typescript
118
- import { createApp, z, logger, cors } from './nexus';
119
-
120
- const app = createApp();
121
-
122
- // Global middleware
123
- app.use(logger());
124
- app.use(cors());
125
-
126
- // Simple route
127
- app.get('/hello', async (ctx) => {
128
- return { message: 'Hello, Nexus!' };
129
- });
130
-
131
- // Validated route
132
- app.post('/users', {
133
- schema: {
134
- body: z.object({
135
- name: z.string().min(2),
136
- email: z.string().email()
137
- })
138
- },
139
- handler: async (ctx) => {
140
- const user = await createUser(ctx.body);
141
- return { user };
142
- }
143
- });
144
-
145
- // Error handling
146
- app.onError((error, ctx) => {
147
- console.error(error);
148
- return ctx.response.status(500).json({
149
- error: 'Internal Server Error'
150
- });
151
- });
152
-
153
- app.listen(3000, () => {
154
- console.log('Server running on port 3000');
155
- });
156
- ```
157
-
158
- ## 🔍 Search Tips
159
-
160
- Use your browser's search (Cmd/Ctrl + F) to find specific topics across documentation files:
161
-
162
- - Search "validation" for input validation
163
- - Search "middleware" for middleware examples
164
- - Search "error" for error handling
165
- - Search "performance" for optimization
166
- - Search "adapter" for extensibility
167
-
168
- ## 🤝 Contributing
169
-
170
- Found an issue or want to improve the documentation? Contributions are welcome!
171
-
172
- ## 📄 License
173
-
174
- MIT License - See LICENSE file for details
175
-
176
- ---
177
-
178
- **Ready to build?** Start with [Getting Started →](./01-getting-started.md)
@@ -1,34 +0,0 @@
1
- <!DOCTYPE html>
2
- <html lang="en">
3
- <head>
4
- <meta charset="UTF-8">
5
- <meta name="viewport" content="width=device-width, initial-scale=1.0">
6
- <title>Nexus Framework</title>
7
- <link rel="stylesheet" href="/css/style.css">
8
- </head>
9
- <body>
10
- <div class="container">
11
- <h1>🚀 Nexus Framework</h1>
12
- <p>Static files are working!</p>
13
-
14
- <div class="features">
15
- <div class="feature">
16
- <h3>📁 Static Files</h3>
17
- <p>This page is served from <code>./public/index.html</code></p>
18
- </div>
19
-
20
- <div class="feature">
21
- <h3>📚 API Docs</h3>
22
- <p><a href="/docs">View Swagger Documentation</a></p>
23
- </div>
24
-
25
- <div class="feature">
26
- <h3>🎮 Playground</h3>
27
- <p><a href="/playground">Try the API Playground</a></p>
28
- </div>
29
- </div>
30
- </div>
31
-
32
- <script src="/js/app.js"></script>
33
- </body>
34
- </html>