@venizia/ignis-docs 0.0.5-0 → 0.0.6-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.
Files changed (99) hide show
  1. package/package.json +2 -2
  2. package/wiki/best-practices/architecture-decisions.md +0 -8
  3. package/wiki/best-practices/code-style-standards/control-flow.md +1 -1
  4. package/wiki/best-practices/performance-optimization.md +3 -3
  5. package/wiki/best-practices/security-guidelines.md +2 -2
  6. package/wiki/best-practices/troubleshooting-tips.md +1 -1
  7. package/wiki/guides/core-concepts/components-guide.md +1 -1
  8. package/wiki/guides/core-concepts/components.md +2 -2
  9. package/wiki/guides/core-concepts/dependency-injection.md +1 -1
  10. package/wiki/guides/core-concepts/services.md +1 -1
  11. package/wiki/guides/tutorials/building-a-crud-api.md +1 -1
  12. package/wiki/guides/tutorials/ecommerce-api.md +2 -2
  13. package/wiki/guides/tutorials/realtime-chat.md +725 -461
  14. package/wiki/guides/tutorials/testing.md +1 -1
  15. package/wiki/references/base/bootstrapping.md +0 -2
  16. package/wiki/references/base/components.md +2 -2
  17. package/wiki/references/base/controllers.md +0 -1
  18. package/wiki/references/base/datasources.md +1 -1
  19. package/wiki/references/base/dependency-injection.md +1 -1
  20. package/wiki/references/base/filter-system/quick-reference.md +0 -14
  21. package/wiki/references/base/middlewares.md +24 -80
  22. package/wiki/references/base/providers.md +0 -9
  23. package/wiki/references/base/services.md +0 -1
  24. package/wiki/references/components/authentication/api.md +444 -0
  25. package/wiki/references/components/authentication/errors.md +177 -0
  26. package/wiki/references/components/authentication/index.md +571 -0
  27. package/wiki/references/components/authentication/usage.md +781 -0
  28. package/wiki/references/components/health-check.md +292 -103
  29. package/wiki/references/components/index.md +14 -12
  30. package/wiki/references/components/mail/api.md +505 -0
  31. package/wiki/references/components/mail/errors.md +176 -0
  32. package/wiki/references/components/mail/index.md +535 -0
  33. package/wiki/references/components/mail/usage.md +404 -0
  34. package/wiki/references/components/request-tracker.md +229 -25
  35. package/wiki/references/components/socket-io/api.md +1051 -0
  36. package/wiki/references/components/socket-io/errors.md +119 -0
  37. package/wiki/references/components/socket-io/index.md +410 -0
  38. package/wiki/references/components/socket-io/usage.md +322 -0
  39. package/wiki/references/components/static-asset/api.md +261 -0
  40. package/wiki/references/components/static-asset/errors.md +89 -0
  41. package/wiki/references/components/static-asset/index.md +617 -0
  42. package/wiki/references/components/static-asset/usage.md +364 -0
  43. package/wiki/references/components/swagger.md +390 -110
  44. package/wiki/references/components/template/api-page.md +125 -0
  45. package/wiki/references/components/template/errors-page.md +100 -0
  46. package/wiki/references/components/template/index.md +104 -0
  47. package/wiki/references/components/template/setup-page.md +134 -0
  48. package/wiki/references/components/template/single-page.md +132 -0
  49. package/wiki/references/components/template/usage-page.md +127 -0
  50. package/wiki/references/components/websocket/api.md +508 -0
  51. package/wiki/references/components/websocket/errors.md +123 -0
  52. package/wiki/references/components/websocket/index.md +453 -0
  53. package/wiki/references/components/websocket/usage.md +475 -0
  54. package/wiki/references/helpers/cron/index.md +224 -0
  55. package/wiki/references/helpers/crypto/index.md +537 -0
  56. package/wiki/references/helpers/env/index.md +214 -0
  57. package/wiki/references/helpers/error/index.md +232 -0
  58. package/wiki/references/helpers/index.md +16 -15
  59. package/wiki/references/helpers/inversion/index.md +608 -0
  60. package/wiki/references/helpers/logger/index.md +600 -0
  61. package/wiki/references/helpers/network/api.md +986 -0
  62. package/wiki/references/helpers/network/index.md +620 -0
  63. package/wiki/references/helpers/queue/index.md +589 -0
  64. package/wiki/references/helpers/redis/index.md +495 -0
  65. package/wiki/references/helpers/socket-io/api.md +497 -0
  66. package/wiki/references/helpers/socket-io/index.md +513 -0
  67. package/wiki/references/helpers/storage/api.md +705 -0
  68. package/wiki/references/helpers/storage/index.md +583 -0
  69. package/wiki/references/helpers/template/index.md +66 -0
  70. package/wiki/references/helpers/template/single-page.md +126 -0
  71. package/wiki/references/helpers/testing/index.md +510 -0
  72. package/wiki/references/helpers/types/index.md +512 -0
  73. package/wiki/references/helpers/uid/index.md +272 -0
  74. package/wiki/references/helpers/websocket/api.md +736 -0
  75. package/wiki/references/helpers/websocket/index.md +574 -0
  76. package/wiki/references/helpers/worker-thread/index.md +470 -0
  77. package/wiki/references/quick-reference.md +6 -23
  78. package/wiki/references/src-details/core.md +1 -2
  79. package/wiki/references/utilities/jsx.md +1 -8
  80. package/wiki/references/utilities/statuses.md +4 -9
  81. package/wiki/references/components/authentication.md +0 -476
  82. package/wiki/references/components/mail.md +0 -687
  83. package/wiki/references/components/socket-io.md +0 -145
  84. package/wiki/references/components/static-asset.md +0 -1277
  85. package/wiki/references/helpers/cron.md +0 -108
  86. package/wiki/references/helpers/crypto.md +0 -132
  87. package/wiki/references/helpers/env.md +0 -83
  88. package/wiki/references/helpers/error.md +0 -97
  89. package/wiki/references/helpers/inversion.md +0 -176
  90. package/wiki/references/helpers/logger.md +0 -296
  91. package/wiki/references/helpers/network.md +0 -396
  92. package/wiki/references/helpers/queue.md +0 -150
  93. package/wiki/references/helpers/redis.md +0 -142
  94. package/wiki/references/helpers/socket-io.md +0 -122
  95. package/wiki/references/helpers/storage.md +0 -665
  96. package/wiki/references/helpers/testing.md +0 -133
  97. package/wiki/references/helpers/types.md +0 -167
  98. package/wiki/references/helpers/uid.md +0 -167
  99. package/wiki/references/helpers/worker-thread.md +0 -178
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@venizia/ignis-docs",
3
- "version": "0.0.5-0",
3
+ "version": "0.0.6-0",
4
4
  "description": "Documentation and MCP Server for Ignis Framework",
5
5
  "keywords": [
6
6
  "ignis",
@@ -114,7 +114,7 @@
114
114
  "@braintree/sanitize-url": "^7.1.1",
115
115
  "@types/bun": "^1.3.4",
116
116
  "@types/glob": "^8.1.0",
117
- "@venizia/dev-configs": "^0.0.5-0",
117
+ "@venizia/dev-configs": "^0.0.6",
118
118
  "eslint": "^9.36.0",
119
119
  "glob": "^10.4.2",
120
120
  "prettier": "^3.6.2",
@@ -141,7 +141,6 @@ export class HealthController extends BaseController {
141
141
  | **Service** | Single app | Medium | Internal |
142
142
  | **Inline** | Single controller | None | None |
143
143
 
144
- ---
145
144
 
146
145
  ## 3. Repository Method Design
147
146
 
@@ -203,7 +202,6 @@ export class OrderRepository extends BaseRepository<Order> {
203
202
  }
204
203
  ```
205
204
 
206
- ---
207
205
 
208
206
  ## 4. Error Handling Strategy
209
207
 
@@ -277,7 +275,6 @@ Controller (catches, formats for API response)
277
275
  Client (receives formatted error)
278
276
  ```
279
277
 
280
- ---
281
278
 
282
279
  ## 5. Scaling Decisions
283
280
 
@@ -334,7 +331,6 @@ class NotificationService {
334
331
  | Data | Shared database OK | Need data isolation |
335
332
  | Complexity | Keep simple | Worth the overhead |
336
333
 
337
- ---
338
334
 
339
335
  ## 6. Data Access Patterns
340
336
 
@@ -384,7 +380,6 @@ const nearby = await db.execute(sql`
384
380
  `);
385
381
  ```
386
382
 
387
- ---
388
383
 
389
384
  ## 7. Configuration Strategy
390
385
 
@@ -429,7 +424,6 @@ this.component(SwaggerComponent, {
429
424
  });
430
425
  ```
431
426
 
432
- ---
433
427
 
434
428
  ## 8. Testing Strategy
435
429
 
@@ -454,7 +448,6 @@ this.component(SwaggerComponent, {
454
448
  --------------
455
449
  ```
456
450
 
457
- ---
458
451
 
459
452
  ## Quick Reference
460
453
 
@@ -479,7 +472,6 @@ this.component(SwaggerComponent, {
479
472
  | Premature optimization | Start simple, optimize when needed |
480
473
  | Over-engineering | YAGNI - build what you need now |
481
474
 
482
- ---
483
475
 
484
476
  ## See Also
485
477
 
@@ -241,5 +241,5 @@ import { QueryBuilder } from '../query';
241
241
  ## See Also
242
242
 
243
243
  - [Error Handling](../error-handling) - Comprehensive error patterns
244
- - [Logging Reference](../../references/helpers/logger) - Logger API
244
+ - [Logging Reference](../../references/helpers/logger/) - Logger API
245
245
  - [Function Patterns](./function-patterns) - Method organization
@@ -32,7 +32,7 @@ Prevent blocking the event loop with Worker Threads:
32
32
  - Large file/data processing
33
33
  - Any synchronous task > 5ms
34
34
 
35
- > **Deep Dive:** See [Worker Thread Helper](../references/helpers/worker-thread.md) for implementation guide.
35
+ > **Deep Dive:** See [Worker Thread Helper](../references/helpers/worker-thread/) for implementation guide.
36
36
 
37
37
  ## 3. Optimize Database Queries
38
38
 
@@ -127,7 +127,7 @@ Reduce database load with caching:
127
127
 
128
128
  | Cache Type | Use Case | Implementation |
129
129
  |-----------|----------|----------------|
130
- | **Redis** | Distributed cache, session storage | [Redis Helper](../references/helpers/redis.md) |
130
+ | **Redis** | Distributed cache, session storage | [Redis Helper](../references/helpers/redis/) |
131
131
  | **In-Memory** | Single-process cache | `MemoryStorageHelper` |
132
132
 
133
133
  **Example:**
@@ -390,7 +390,7 @@ logger.log('info', MSG_ORDER_FILLED);
390
390
  - Use background flushing to avoid I/O blocking
391
391
  - HfLogger uses a lock-free ring buffer (64K entries, 16MB)
392
392
 
393
- > **Deep Dive:** See [Logger Helper](../references/helpers/logger.md) for complete HfLogger API.
393
+ > **Deep Dive:** See [Logger Helper](../references/helpers/logger/) for complete HfLogger API.
394
394
 
395
395
  ## Performance Checklist
396
396
 
@@ -68,7 +68,7 @@ const SecureRoute = {
68
68
  };
69
69
  ```
70
70
 
71
- > **Deep Dive:** See [Authentication Component](../references/components/authentication.md) for full setup guide.
71
+ > **Deep Dive:** See [Authentication Component](../references/components/authentication/) for full setup guide.
72
72
 
73
73
  **Access user in protected routes:**
74
74
  ```typescript
@@ -462,6 +462,6 @@ Before deploying to production, verify:
462
462
 
463
463
  ## See Also
464
464
 
465
- - [Authentication Component](../references/components/authentication) - JWT setup and configuration
465
+ - [Authentication Component](../references/components/authentication/) - JWT setup and configuration
466
466
  - [Common Pitfalls](./common-pitfalls) - Security-related mistakes to avoid
467
467
  - [Deployment Strategies](./deployment-strategies) - Secure deployment practices
@@ -118,7 +118,7 @@ cat .env | grep APP_ENV
118
118
  - Use `try-catch` blocks to catch and log errors
119
119
  - Check database queries with Drizzle's logging: `{ logger: true }`
120
120
 
121
- > **Deep Dive:** See [Logger Helper](../references/helpers/logger.md) for advanced logging configuration.
121
+ > **Deep Dive:** See [Logger Helper](../references/helpers/logger/) for advanced logging configuration.
122
122
 
123
123
  ## 6. Request ID Tracking
124
124
 
@@ -501,7 +501,7 @@ export class MyComponent extends BaseComponent {
501
501
 
502
502
  - **References:**
503
503
  - [BaseComponent API](/references/base/components) - Complete API reference
504
- - [Authentication Component](/references/components/authentication) - Real-world component example
504
+ - [Authentication Component](/references/components/authentication/) - Real-world component example
505
505
  - [Health Check Component](/references/components/health-check) - Simple component example
506
506
 
507
507
  - **Best Practices:**
@@ -113,10 +113,10 @@ export class Application extends BaseApplication {
113
113
 
114
114
  - **References:**
115
115
  - [BaseComponent API](/references/base/components) - Complete API reference
116
- - [Authentication Component](/references/components/authentication) - JWT authentication
116
+ - [Authentication Component](/references/components/authentication/) - JWT authentication
117
117
  - [Health Check Component](/references/components/health-check) - Health endpoints
118
118
  - [Swagger Component](/references/components/swagger) - API documentation
119
- - [Socket.IO Component](/references/components/socket-io) - WebSocket support
119
+ - [Socket.IO Component](/references/components/socket-io/) - WebSocket support
120
120
 
121
121
  - **Best Practices:**
122
122
  - [Architectural Patterns](/best-practices/architectural-patterns) - Component design patterns
@@ -258,7 +258,7 @@ The `Application` class extends `Container`, so all container methods (`bind`, `
258
258
 
259
259
  - **References:**
260
260
  - [Dependency Injection API](/references/base/dependency-injection) - Complete API reference
261
- - [Inversion Helper](/references/helpers/inversion) - DI container utilities
261
+ - [Inversion Helper](/references/helpers/inversion/) - DI container utilities
262
262
  - [Glossary](/guides/reference/glossary#dependency-injection-di) - DI concepts explained
263
263
 
264
264
  - **Tutorials:**
@@ -94,7 +94,7 @@ This layered architecture makes your application:
94
94
  - **References:**
95
95
  - [BaseService API](/references/base/services) - Complete API reference
96
96
  - [Providers](/references/base/providers) - Factory pattern for runtime instantiation
97
- - [Logger Helper](/references/helpers/logger) - Logging in services
97
+ - [Logger Helper](/references/helpers/logger/) - Logging in services
98
98
 
99
99
  - **Best Practices:**
100
100
  - [Architectural Patterns](/best-practices/architectural-patterns) - Service layer design
@@ -694,7 +694,7 @@ You now have a fully functional CRUD API! Here's what to explore next:
694
694
  3. [Components](../core-concepts/components.md) - Build reusable modules
695
695
 
696
696
  **Add Features:**
697
- 1. [Authentication](/references/components/authentication) - Add JWT authentication
697
+ 1. [Authentication](/references/components/authentication/) - Add JWT authentication
698
698
  2. [Custom Routes](/best-practices/api-usage-examples.md) - Beyond CRUD operations
699
699
  3. [Relationships](../core-concepts/persistent/) - Link todos to users
700
700
 
@@ -1393,7 +1393,7 @@ You've built a complete e-commerce API with:
1393
1393
 
1394
1394
  ## Next Steps
1395
1395
 
1396
- - Add user authentication with [Auth Component](/references/components/authentication)
1397
- - Add order notifications with [Mail Component](/references/components/mail)
1396
+ - Add user authentication with [Auth Component](/references/components/authentication/)
1397
+ - Add order notifications with [Mail Component](/references/components/mail/)
1398
1398
  - Add real-time updates with [Socket.IO](./realtime-chat.md)
1399
1399
  - Deploy with [Deployment Guide](/best-practices/deployment-strategies)