@engjts/nexus 0.1.8 → 0.1.10

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 (221) hide show
  1. package/dist/advanced/playground/playground.js.map +1 -1
  2. package/dist/advanced/static/generateDirectoryListing.d.ts +1 -1
  3. package/dist/advanced/static/generateDirectoryListing.d.ts.map +1 -1
  4. package/dist/advanced/static/generateDirectoryListing.js +12 -6
  5. package/dist/advanced/static/generateDirectoryListing.js.map +1 -1
  6. package/dist/advanced/static/index.d.ts +2 -0
  7. package/dist/advanced/static/index.d.ts.map +1 -1
  8. package/dist/advanced/static/index.js +4 -1
  9. package/dist/advanced/static/index.js.map +1 -1
  10. package/dist/advanced/static/serveStatic.d.ts.map +1 -1
  11. package/dist/advanced/static/serveStatic.js +7 -1
  12. package/dist/advanced/static/serveStatic.js.map +1 -1
  13. package/dist/index.d.ts +1 -1
  14. package/dist/index.d.ts.map +1 -1
  15. package/dist/index.js +3 -1
  16. package/dist/index.js.map +1 -1
  17. package/package.json +1 -1
  18. package/BENCHMARK_REPORT.md +0 -343
  19. package/documentation/01-getting-started.md +0 -240
  20. package/documentation/02-context.md +0 -335
  21. package/documentation/03-routing.md +0 -397
  22. package/documentation/04-middleware.md +0 -483
  23. package/documentation/05-validation.md +0 -514
  24. package/documentation/06-error-handling.md +0 -465
  25. package/documentation/07-performance.md +0 -364
  26. package/documentation/08-adapters.md +0 -470
  27. package/documentation/09-api-reference.md +0 -548
  28. package/documentation/10-examples.md +0 -582
  29. package/documentation/11-deployment.md +0 -477
  30. package/documentation/12-sentry.md +0 -620
  31. package/documentation/13-sentry-data-storage.md +0 -996
  32. package/documentation/14-sentry-data-reference.md +0 -457
  33. package/documentation/15-sentry-summary.md +0 -409
  34. package/documentation/16-alerts-system.md +0 -745
  35. package/documentation/17-alert-adapters.md +0 -696
  36. package/documentation/18-alerts-implementation-summary.md +0 -385
  37. package/documentation/19-class-based-routing.md +0 -840
  38. package/documentation/20-websocket-realtime.md +0 -813
  39. package/documentation/21-cache-system.md +0 -510
  40. package/documentation/22-job-queue.md +0 -772
  41. package/documentation/23-sentry-plugin.md +0 -551
  42. package/documentation/24-testing-utilities.md +0 -1287
  43. package/documentation/25-api-versioning.md +0 -533
  44. package/documentation/26-context-store.md +0 -607
  45. package/documentation/27-dependency-injection.md +0 -329
  46. package/documentation/28-lifecycle-hooks.md +0 -521
  47. package/documentation/29-package-structure.md +0 -196
  48. package/documentation/30-plugin-system.md +0 -414
  49. package/documentation/31-jwt-authentication.md +0 -597
  50. package/documentation/32-cli.md +0 -268
  51. package/documentation/ALERTS-COMPLETE-SUMMARY.md +0 -429
  52. package/documentation/ALERTS-INDEX.md +0 -330
  53. package/documentation/ALERTS-QUICK-REFERENCE.md +0 -286
  54. package/documentation/README.md +0 -178
  55. package/documentation/index.html +0 -34
  56. package/modern_framework_paper.md +0 -1870
  57. package/public/css/style.css +0 -87
  58. package/public/index.html +0 -34
  59. package/public/js/app.js +0 -27
  60. package/src/advanced/cache/InMemoryCacheStore.ts +0 -68
  61. package/src/advanced/cache/MultiTierCache.ts +0 -194
  62. package/src/advanced/cache/RedisCacheStore.ts +0 -341
  63. package/src/advanced/cache/index.ts +0 -5
  64. package/src/advanced/cache/types.ts +0 -40
  65. package/src/advanced/graphql/SimpleDataLoader.ts +0 -42
  66. package/src/advanced/graphql/index.ts +0 -22
  67. package/src/advanced/graphql/server.ts +0 -252
  68. package/src/advanced/graphql/types.ts +0 -42
  69. package/src/advanced/jobs/InMemoryQueueStore.ts +0 -68
  70. package/src/advanced/jobs/JobQueue.ts +0 -556
  71. package/src/advanced/jobs/RedisQueueStore.ts +0 -367
  72. package/src/advanced/jobs/index.ts +0 -5
  73. package/src/advanced/jobs/types.ts +0 -70
  74. package/src/advanced/observability/APMManager.ts +0 -163
  75. package/src/advanced/observability/AlertManager.ts +0 -109
  76. package/src/advanced/observability/MetricRegistry.ts +0 -151
  77. package/src/advanced/observability/ObservabilityCenter.ts +0 -304
  78. package/src/advanced/observability/StructuredLogger.ts +0 -154
  79. package/src/advanced/observability/TracingManager.ts +0 -117
  80. package/src/advanced/observability/adapters.ts +0 -304
  81. package/src/advanced/observability/createObservabilityMiddleware.ts +0 -63
  82. package/src/advanced/observability/index.ts +0 -11
  83. package/src/advanced/observability/types.ts +0 -174
  84. package/src/advanced/playground/extractPathParams.ts +0 -6
  85. package/src/advanced/playground/generateFieldExample.ts +0 -31
  86. package/src/advanced/playground/generatePlaygroundHTML.ts +0 -1956
  87. package/src/advanced/playground/generateSummary.ts +0 -19
  88. package/src/advanced/playground/getTagFromPath.ts +0 -9
  89. package/src/advanced/playground/index.ts +0 -8
  90. package/src/advanced/playground/playground.ts +0 -250
  91. package/src/advanced/playground/types.ts +0 -49
  92. package/src/advanced/playground/zodToExample.ts +0 -16
  93. package/src/advanced/playground/zodToParams.ts +0 -15
  94. package/src/advanced/postman/buildAuth.ts +0 -31
  95. package/src/advanced/postman/buildBody.ts +0 -15
  96. package/src/advanced/postman/buildQueryParams.ts +0 -27
  97. package/src/advanced/postman/buildRequestItem.ts +0 -36
  98. package/src/advanced/postman/buildResponses.ts +0 -11
  99. package/src/advanced/postman/buildUrl.ts +0 -33
  100. package/src/advanced/postman/capitalize.ts +0 -4
  101. package/src/advanced/postman/generateCollection.ts +0 -59
  102. package/src/advanced/postman/generateEnvironment.ts +0 -34
  103. package/src/advanced/postman/generateExampleFromZod.ts +0 -21
  104. package/src/advanced/postman/generateFieldExample.ts +0 -45
  105. package/src/advanced/postman/generateName.ts +0 -20
  106. package/src/advanced/postman/generateUUID.ts +0 -11
  107. package/src/advanced/postman/getTagFromPath.ts +0 -10
  108. package/src/advanced/postman/index.ts +0 -28
  109. package/src/advanced/postman/postman.ts +0 -156
  110. package/src/advanced/postman/slugify.ts +0 -7
  111. package/src/advanced/postman/types.ts +0 -140
  112. package/src/advanced/realtime/index.ts +0 -18
  113. package/src/advanced/realtime/websocket.ts +0 -231
  114. package/src/advanced/sentry/index.ts +0 -1236
  115. package/src/advanced/sentry/types.ts +0 -355
  116. package/src/advanced/static/generateDirectoryListing.ts +0 -47
  117. package/src/advanced/static/generateETag.ts +0 -7
  118. package/src/advanced/static/getMimeType.ts +0 -9
  119. package/src/advanced/static/index.ts +0 -32
  120. package/src/advanced/static/isSafePath.ts +0 -13
  121. package/src/advanced/static/publicDir.ts +0 -21
  122. package/src/advanced/static/serveStatic.ts +0 -225
  123. package/src/advanced/static/spa.ts +0 -24
  124. package/src/advanced/static/types.ts +0 -159
  125. package/src/advanced/swagger/SwaggerGenerator.ts +0 -66
  126. package/src/advanced/swagger/buildOperation.ts +0 -61
  127. package/src/advanced/swagger/buildParameters.ts +0 -61
  128. package/src/advanced/swagger/buildRequestBody.ts +0 -21
  129. package/src/advanced/swagger/buildResponses.ts +0 -54
  130. package/src/advanced/swagger/capitalize.ts +0 -5
  131. package/src/advanced/swagger/convertPath.ts +0 -9
  132. package/src/advanced/swagger/createSwagger.ts +0 -12
  133. package/src/advanced/swagger/generateOperationId.ts +0 -21
  134. package/src/advanced/swagger/generateSpec.ts +0 -105
  135. package/src/advanced/swagger/generateSummary.ts +0 -24
  136. package/src/advanced/swagger/generateSwaggerUI.ts +0 -70
  137. package/src/advanced/swagger/generateThemeCss.ts +0 -53
  138. package/src/advanced/swagger/index.ts +0 -25
  139. package/src/advanced/swagger/swagger.ts +0 -237
  140. package/src/advanced/swagger/types.ts +0 -206
  141. package/src/advanced/swagger/zodFieldToOpenAPI.ts +0 -94
  142. package/src/advanced/swagger/zodSchemaToOpenAPI.ts +0 -50
  143. package/src/advanced/swagger/zodToOpenAPI.ts +0 -22
  144. package/src/advanced/testing/factory.ts +0 -509
  145. package/src/advanced/testing/harness.ts +0 -612
  146. package/src/advanced/testing/index.ts +0 -430
  147. package/src/advanced/testing/load-test.ts +0 -618
  148. package/src/advanced/testing/mock-server.ts +0 -498
  149. package/src/advanced/testing/mock.ts +0 -670
  150. package/src/cli/bin.ts +0 -9
  151. package/src/cli/cli.ts +0 -158
  152. package/src/cli/commands/add.ts +0 -178
  153. package/src/cli/commands/build.ts +0 -73
  154. package/src/cli/commands/create.ts +0 -166
  155. package/src/cli/commands/dev.ts +0 -85
  156. package/src/cli/commands/generate.ts +0 -99
  157. package/src/cli/commands/help.ts +0 -95
  158. package/src/cli/commands/init.ts +0 -91
  159. package/src/cli/commands/version.ts +0 -38
  160. package/src/cli/index.ts +0 -6
  161. package/src/cli/templates/generators.ts +0 -359
  162. package/src/cli/templates/index.ts +0 -680
  163. package/src/cli/utils/exec.ts +0 -52
  164. package/src/cli/utils/file-system.ts +0 -78
  165. package/src/cli/utils/logger.ts +0 -111
  166. package/src/core/adapter.ts +0 -88
  167. package/src/core/application.ts +0 -1453
  168. package/src/core/context-pool.ts +0 -79
  169. package/src/core/context.ts +0 -856
  170. package/src/core/index.ts +0 -94
  171. package/src/core/middleware.ts +0 -272
  172. package/src/core/performance/buffer-pool.ts +0 -108
  173. package/src/core/performance/middleware-optimizer.ts +0 -162
  174. package/src/core/plugin/PluginManager.ts +0 -435
  175. package/src/core/plugin/builder.ts +0 -358
  176. package/src/core/plugin/index.ts +0 -50
  177. package/src/core/plugin/types.ts +0 -214
  178. package/src/core/router/file-router.ts +0 -623
  179. package/src/core/router/index.ts +0 -260
  180. package/src/core/router/radix-tree.ts +0 -242
  181. package/src/core/serializer.ts +0 -397
  182. package/src/core/store/index.ts +0 -30
  183. package/src/core/store/registry.ts +0 -178
  184. package/src/core/store/request-store.ts +0 -240
  185. package/src/core/store/types.ts +0 -233
  186. package/src/core/types.ts +0 -616
  187. package/src/database/adapter.ts +0 -35
  188. package/src/database/adapters/index.ts +0 -1
  189. package/src/database/adapters/mysql.ts +0 -669
  190. package/src/database/database.ts +0 -70
  191. package/src/database/dialect.ts +0 -388
  192. package/src/database/index.ts +0 -12
  193. package/src/database/migrations.ts +0 -86
  194. package/src/database/optimizer.ts +0 -125
  195. package/src/database/query-builder.ts +0 -404
  196. package/src/database/realtime.ts +0 -53
  197. package/src/database/schema.ts +0 -71
  198. package/src/database/transactions.ts +0 -56
  199. package/src/database/types.ts +0 -87
  200. package/src/deployment/cluster.ts +0 -471
  201. package/src/deployment/config.ts +0 -454
  202. package/src/deployment/docker.ts +0 -599
  203. package/src/deployment/graceful-shutdown.ts +0 -373
  204. package/src/deployment/index.ts +0 -56
  205. package/src/index.ts +0 -281
  206. package/src/security/adapter.ts +0 -318
  207. package/src/security/auth/JWTPlugin.ts +0 -234
  208. package/src/security/auth/JWTProvider.ts +0 -316
  209. package/src/security/auth/adapter.ts +0 -12
  210. package/src/security/auth/jwt.ts +0 -234
  211. package/src/security/auth/middleware.ts +0 -188
  212. package/src/security/csrf.ts +0 -220
  213. package/src/security/headers.ts +0 -108
  214. package/src/security/index.ts +0 -60
  215. package/src/security/rate-limit/adapter.ts +0 -7
  216. package/src/security/rate-limit/memory.ts +0 -108
  217. package/src/security/rate-limit/middleware.ts +0 -181
  218. package/src/security/sanitization.ts +0 -75
  219. package/src/security/types.ts +0 -240
  220. package/src/security/utils.ts +0 -52
  221. package/tsconfig.json +0 -39
@@ -1,329 +0,0 @@
1
- # Dependency Injection
2
-
3
- Nexus Framework menyediakan sistem **Dependency Injection (DI)** yang type-safe untuk mengelola dependencies seperti database, cache, mailer, dan service lainnya.
4
-
5
- ## Quick Start
6
-
7
- ```typescript
8
- import { createApp } from 'nexus';
9
-
10
- // 1. Define dependencies
11
- const db = new Database();
12
- const cache = new RedisCache();
13
- const mailer = new Mailer();
14
-
15
- // 2. Create app dan provide dependencies
16
- const app = createApp()
17
- .provide({ db, cache, mailer });
18
-
19
- // 3. Gunakan di handler - auto-injected & fully typed!
20
- app.get('/users', async (ctx, { db, cache }) => {
21
- const cached = await cache.get('users');
22
- if (cached) return { users: cached, source: 'cache' };
23
-
24
- const users = await db.query('SELECT * FROM users');
25
- await cache.set('users', users);
26
- return { users, source: 'database' };
27
- });
28
- ```
29
-
30
- ## API Reference
31
-
32
- ### `app.provide(dependencies)`
33
-
34
- Register dependencies yang akan di-inject ke semua route handlers.
35
-
36
- ```typescript
37
- interface Dependencies {
38
- db: Database;
39
- cache: CacheService;
40
- mailer: MailerService;
41
- // ... tambahkan sesuai kebutuhan
42
- }
43
-
44
- const app = createApp().provide<Dependencies>({
45
- db: new Database(),
46
- cache: new RedisCache(),
47
- mailer: new Mailer()
48
- });
49
- ```
50
-
51
- **Returns:** `Application` (chainable)
52
-
53
- ## Usage Patterns
54
-
55
- ### Pattern 1: Simple Function Handler
56
-
57
- Paling simple - langsung destructure dependencies di parameter kedua:
58
-
59
- ```typescript
60
- app.get('/users', async (ctx, { db }) => {
61
- const users = await db.getUsers();
62
- return { users };
63
- });
64
-
65
- app.post('/send-email', async (ctx, { mailer }) => {
66
- await mailer.send({
67
- to: ctx.body.email,
68
- subject: 'Welcome!',
69
- body: 'Thanks for signing up.'
70
- });
71
- return { sent: true };
72
- });
73
- ```
74
-
75
- ### Pattern 2: Access All Dependencies
76
-
77
- Jika butuh akses ke semua dependencies:
78
-
79
- ```typescript
80
- app.post('/users', async (ctx, deps) => {
81
- // deps berisi semua: db, cache, mailer, dll
82
- const user = await deps.db.createUser(ctx.body);
83
- await deps.cache.invalidate('users');
84
- await deps.mailer.send({
85
- to: user.email,
86
- subject: 'Welcome!'
87
- });
88
- return { user };
89
- });
90
- ```
91
-
92
- ### Pattern 3: Config Object dengan Explicit Inject
93
-
94
- Untuk kontrol lebih detail, gunakan config object:
95
-
96
- ```typescript
97
- app.get('/users/:id', {
98
- inject: ['db', 'cache'], // Explicit specify dependencies
99
- handler: async (ctx, { db, cache }) => {
100
- const id = ctx.params.id;
101
-
102
- // Check cache first
103
- const cached = await cache.get(`user:${id}`);
104
- if (cached) return cached;
105
-
106
- // Fetch from DB
107
- const user = await db.getUserById(id);
108
- await cache.set(`user:${id}`, user, { ttl: 3600 });
109
-
110
- return { user };
111
- }
112
- });
113
- ```
114
-
115
- ## Type Safety
116
-
117
- Dependencies sepenuhnya type-safe. TypeScript akan:
118
- - Autocomplete nama dependency
119
- - Type-check penggunaan dependency
120
- - Error jika dependency tidak ada
121
-
122
- ```typescript
123
- interface AppDeps {
124
- db: {
125
- getUsers(): Promise<User[]>;
126
- getUserById(id: string): Promise<User>;
127
- };
128
- cache: {
129
- get<T>(key: string): Promise<T | null>;
130
- set(key: string, value: any): Promise<void>;
131
- };
132
- }
133
-
134
- const app = createApp().provide<AppDeps>({
135
- db: new PostgresDB(),
136
- cache: new Redis()
137
- });
138
-
139
- // ✅ TypeScript knows db.getUsers() returns Promise<User[]>
140
- app.get('/users', async (ctx, { db }) => {
141
- const users = await db.getUsers();
142
- return { users };
143
- });
144
-
145
- // ❌ TypeScript error: 'unknown' does not exist on AppDeps
146
- app.get('/test', async (ctx, { unknown }) => {
147
- // Error!
148
- });
149
- ```
150
-
151
- ## Real-World Example
152
-
153
- ```typescript
154
- import { createApp } from 'nexus';
155
- import { z } from 'zod';
156
-
157
- // === Services ===
158
- class Database {
159
- private users = [
160
- { id: 1, name: 'John', email: 'john@example.com' },
161
- { id: 2, name: 'Jane', email: 'jane@example.com' }
162
- ];
163
-
164
- async getUsers() { return this.users; }
165
- async getUserById(id: number) { return this.users.find(u => u.id === id); }
166
- async createUser(data: { name: string; email: string }) {
167
- const user = { id: this.users.length + 1, ...data };
168
- this.users.push(user);
169
- return user;
170
- }
171
- }
172
-
173
- class CacheService {
174
- private store = new Map<string, { data: any; expiry: number }>();
175
-
176
- async get<T>(key: string): Promise<T | null> {
177
- const item = this.store.get(key);
178
- if (!item || item.expiry < Date.now()) return null;
179
- return item.data;
180
- }
181
-
182
- async set(key: string, data: any, ttl = 60000) {
183
- this.store.set(key, { data, expiry: Date.now() + ttl });
184
- }
185
-
186
- async invalidate(pattern: string) {
187
- for (const key of this.store.keys()) {
188
- if (key.includes(pattern)) this.store.delete(key);
189
- }
190
- }
191
- }
192
-
193
- class MailerService {
194
- async send(opts: { to: string; subject: string; body?: string }) {
195
- console.log(`📧 Sending email to ${opts.to}: ${opts.subject}`);
196
- return true;
197
- }
198
- }
199
-
200
- // === App Setup ===
201
- const app = createApp()
202
- .provide({
203
- db: new Database(),
204
- cache: new CacheService(),
205
- mailer: new MailerService()
206
- });
207
-
208
- // === Routes ===
209
-
210
- // GET /users - with caching
211
- app.get('/users', async (ctx, { db, cache }) => {
212
- const cached = await cache.get<any[]>('users');
213
- if (cached) {
214
- return { users: cached, source: 'cache' };
215
- }
216
-
217
- const users = await db.getUsers();
218
- await cache.set('users', users);
219
- return { users, source: 'database' };
220
- });
221
-
222
- // GET /users/:id
223
- app.get('/users/:id', async (ctx, { db }) => {
224
- const user = await db.getUserById(parseInt(ctx.params.id));
225
- if (!user) {
226
- return ctx.response.status(404).json({ error: 'User not found' });
227
- }
228
- return { user };
229
- });
230
-
231
- // POST /users - create with email notification
232
- app.post('/users', async (ctx, { db, cache, mailer }) => {
233
- const user = await db.createUser(ctx.body);
234
- await cache.invalidate('users');
235
- await mailer.send({
236
- to: user.email,
237
- subject: 'Welcome!',
238
- body: 'Thanks for joining us.'
239
- });
240
- return { user, message: 'User created and welcome email sent' };
241
- });
242
-
243
- app.listen(3000);
244
- ```
245
-
246
- ## Best Practices
247
-
248
- ### 1. Define Interface untuk Dependencies
249
-
250
- ```typescript
251
- interface AppDependencies {
252
- db: DatabaseService;
253
- cache: CacheService;
254
- mailer: MailerService;
255
- logger: LoggerService;
256
- }
257
-
258
- const app = createApp().provide<AppDependencies>({ ... });
259
- ```
260
-
261
- ### 2. Gunakan Factory Functions
262
-
263
- ```typescript
264
- function createDependencies(config: Config): AppDependencies {
265
- return {
266
- db: new Database(config.database),
267
- cache: new Redis(config.redis),
268
- mailer: new Mailer(config.smtp),
269
- logger: new Logger(config.logging)
270
- };
271
- }
272
-
273
- const app = createApp().provide(createDependencies(config));
274
- ```
275
-
276
- ### 3. Lazy Initialization
277
-
278
- ```typescript
279
- class LazyDatabase {
280
- private _connection?: Connection;
281
-
282
- async getConnection() {
283
- if (!this._connection) {
284
- this._connection = await Database.connect();
285
- }
286
- return this._connection;
287
- }
288
- }
289
- ```
290
-
291
- ### 4. Testing dengan Mock Dependencies
292
-
293
- ```typescript
294
- // test/users.test.ts
295
- import { createApp } from 'nexus';
296
- import { TestClient } from 'nexus/testing';
297
-
298
- const mockDb = {
299
- getUsers: jest.fn().mockResolvedValue([{ id: 1, name: 'Test' }])
300
- };
301
-
302
- const app = createApp().provide({ db: mockDb });
303
- app.get('/users', async (ctx, { db }) => {
304
- return { users: await db.getUsers() };
305
- });
306
-
307
- const client = new TestClient(app);
308
-
309
- test('GET /users returns users', async () => {
310
- const res = await client.get('/users');
311
- expect(res.status).toBe(200);
312
- expect(mockDb.getUsers).toHaveBeenCalled();
313
- });
314
- ```
315
-
316
- ## Comparison dengan Framework Lain
317
-
318
- | Feature | Nexus | Express | Fastify | NestJS |
319
- |---------|-------|---------|---------|--------|
320
- | Built-in DI | ✅ | ❌ | ❌ | ✅ |
321
- | Type-safe | ✅ | ❌ | Partial | ✅ |
322
- | Zero config | ✅ | - | - | ❌ |
323
- | Decorator-free | ✅ | - | - | ❌ |
324
-
325
- ## See Also
326
-
327
- - [Lifecycle Hooks](./28-lifecycle-hooks.md) - Request lifecycle hooks
328
- - [Context Store](./26-context-store.md) - State management
329
- - [Testing](./24-testing-utilities.md) - Testing with mock dependencies