@venizia/ignis-docs 0.0.5 → 0.0.6-0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@venizia/ignis-docs",
-  "version": "0.0.5",
+  "version": "0.0.6-0",
   "description": "Documentation and MCP Server for Ignis Framework",
   "keywords": [
     "ignis",

package/wiki/best-practices/architecture-decisions.md

@@ -141,7 +141,6 @@ export class HealthController extends BaseController {
 | **Service** | Single app | Medium | Internal |
 | **Inline** | Single controller | None | None |
 
----
 
 ## 3. Repository Method Design
 
@@ -203,7 +202,6 @@ export class OrderRepository extends BaseRepository<Order> {
 }
 ```
 
----
 
 ## 4. Error Handling Strategy
 
@@ -277,7 +275,6 @@ Controller (catches, formats for API response)
 Client (receives formatted error)
 ```
 
----
 
 ## 5. Scaling Decisions
 
@@ -334,7 +331,6 @@ class NotificationService {
 | Data | Shared database OK | Need data isolation |
 | Complexity | Keep simple | Worth the overhead |
 
----
 
 ## 6. Data Access Patterns
 
@@ -384,7 +380,6 @@ const nearby = await db.execute(sql`
 `);
 ```
 
----
 
 ## 7. Configuration Strategy
 
@@ -429,7 +424,6 @@ this.component(SwaggerComponent, {
 });
 ```
 
----
 
 ## 8. Testing Strategy
 
@@ -454,7 +448,6 @@ this.component(SwaggerComponent, {
   --------------
 ```
 
----
 
 ## Quick Reference
 
@@ -479,7 +472,6 @@ this.component(SwaggerComponent, {
 | Premature optimization | Start simple, optimize when needed |
 | Over-engineering | YAGNI - build what you need now |
 
----
 
 ## See Also
 

package/wiki/best-practices/code-style-standards/control-flow.md

@@ -241,5 +241,5 @@ import { QueryBuilder } from '../query';
 ## See Also
 
 - [Error Handling](../error-handling) - Comprehensive error patterns
-- [Logging Reference](../../references/helpers/logger) - Logger API
+- [Logging Reference](../../references/helpers/logger/) - Logger API
 - [Function Patterns](./function-patterns) - Method organization

package/wiki/best-practices/performance-optimization.md

@@ -32,7 +32,7 @@ Prevent blocking the event loop with Worker Threads:
 - Large file/data processing
 - Any synchronous task > 5ms
 
-> **Deep Dive:** See [Worker Thread Helper](../references/helpers/worker-thread.md) for implementation guide.
+> **Deep Dive:** See [Worker Thread Helper](../references/helpers/worker-thread/) for implementation guide.
 
 ## 3. Optimize Database Queries
 
@@ -127,7 +127,7 @@ Reduce database load with caching:
 
 | Cache Type | Use Case | Implementation |
 |-----------|----------|----------------|
-| **Redis** | Distributed cache, session storage | [Redis Helper](../references/helpers/redis.md) |
+| **Redis** | Distributed cache, session storage | [Redis Helper](../references/helpers/redis/) |
 | **In-Memory** | Single-process cache | `MemoryStorageHelper` |
 
 **Example:**
@@ -390,7 +390,7 @@ logger.log('info', MSG_ORDER_FILLED);
 - Use background flushing to avoid I/O blocking
 - HfLogger uses a lock-free ring buffer (64K entries, 16MB)
 
-> **Deep Dive:** See [Logger Helper](../references/helpers/logger.md) for complete HfLogger API.
+> **Deep Dive:** See [Logger Helper](../references/helpers/logger/) for complete HfLogger API.
 
 ## Performance Checklist
 

package/wiki/best-practices/security-guidelines.md

@@ -68,7 +68,7 @@ const SecureRoute = {
 };
 ```
 
-> **Deep Dive:** See [Authentication Component](../references/components/authentication.md) for full setup guide.
+> **Deep Dive:** See [Authentication Component](../references/components/authentication/) for full setup guide.
 
 **Access user in protected routes:**
 ```typescript
@@ -462,6 +462,6 @@ Before deploying to production, verify:
 
 ## See Also
 
-- [Authentication Component](../references/components/authentication) - JWT setup and configuration
+- [Authentication Component](../references/components/authentication/) - JWT setup and configuration
 - [Common Pitfalls](./common-pitfalls) - Security-related mistakes to avoid
 - [Deployment Strategies](./deployment-strategies) - Secure deployment practices

package/wiki/best-practices/troubleshooting-tips.md

@@ -118,7 +118,7 @@ cat .env | grep APP_ENV
 - Use `try-catch` blocks to catch and log errors
 - Check database queries with Drizzle's logging: `{ logger: true }`
 
-> **Deep Dive:** See [Logger Helper](../references/helpers/logger.md) for advanced logging configuration.
+> **Deep Dive:** See [Logger Helper](../references/helpers/logger/) for advanced logging configuration.
 
 ## 6. Request ID Tracking
 

package/wiki/guides/core-concepts/components-guide.md

@@ -501,7 +501,7 @@ export class MyComponent extends BaseComponent {
 
 - **References:**
   - [BaseComponent API](/references/base/components) - Complete API reference
-  - [Authentication Component](/references/components/authentication) - Real-world component example
+  - [Authentication Component](/references/components/authentication/) - Real-world component example
   - [Health Check Component](/references/components/health-check) - Simple component example
 
 - **Best Practices:**

package/wiki/guides/core-concepts/components.md

@@ -113,10 +113,10 @@ export class Application extends BaseApplication {
 
 - **References:**
   - [BaseComponent API](/references/base/components) - Complete API reference
-  - [Authentication Component](/references/components/authentication) - JWT authentication
+  - [Authentication Component](/references/components/authentication/) - JWT authentication
   - [Health Check Component](/references/components/health-check) - Health endpoints
   - [Swagger Component](/references/components/swagger) - API documentation
-  - [Socket.IO Component](/references/components/socket-io) - WebSocket support
+  - [Socket.IO Component](/references/components/socket-io/) - WebSocket support
 
 - **Best Practices:**
   - [Architectural Patterns](/best-practices/architectural-patterns) - Component design patterns

package/wiki/guides/core-concepts/dependency-injection.md

@@ -258,7 +258,7 @@ The `Application` class extends `Container`, so all container methods (`bind`, `
 
 - **References:**
   - [Dependency Injection API](/references/base/dependency-injection) - Complete API reference
-  - [Inversion Helper](/references/helpers/inversion) - DI container utilities
+  - [Inversion Helper](/references/helpers/inversion/) - DI container utilities
   - [Glossary](/guides/reference/glossary#dependency-injection-di) - DI concepts explained
 
 - **Tutorials:**

package/wiki/guides/core-concepts/services.md

@@ -94,7 +94,7 @@ This layered architecture makes your application:
 - **References:**
   - [BaseService API](/references/base/services) - Complete API reference
   - [Providers](/references/base/providers) - Factory pattern for runtime instantiation
-  - [Logger Helper](/references/helpers/logger) - Logging in services
+  - [Logger Helper](/references/helpers/logger/) - Logging in services
 
 - **Best Practices:**
   - [Architectural Patterns](/best-practices/architectural-patterns) - Service layer design

package/wiki/guides/tutorials/building-a-crud-api.md

@@ -694,7 +694,7 @@ You now have a fully functional CRUD API! Here's what to explore next:
 3. [Components](../core-concepts/components.md) - Build reusable modules
 
 **Add Features:**
-1. [Authentication](/references/components/authentication) - Add JWT authentication
+1. [Authentication](/references/components/authentication/) - Add JWT authentication
 2. [Custom Routes](/best-practices/api-usage-examples.md) - Beyond CRUD operations
 3. [Relationships](../core-concepts/persistent/) - Link todos to users
 

package/wiki/guides/tutorials/ecommerce-api.md

@@ -1393,7 +1393,7 @@ You've built a complete e-commerce API with:
 
 ## Next Steps
 
-- Add user authentication with [Auth Component](/references/components/authentication)
-- Add order notifications with [Mail Component](/references/components/mail)
+- Add user authentication with [Auth Component](/references/components/authentication/)
+- Add order notifications with [Mail Component](/references/components/mail/)
 - Add real-time updates with [Socket.IO](./realtime-chat.md)
 - Deploy with [Deployment Guide](/best-practices/deployment-strategies)

package/wiki/guides/tutorials/realtime-chat.md

@@ -13,8 +13,8 @@ This tutorial shows you how to build a real-time chat application with rooms, di
 ## Prerequisites
 
 - Completed [Building a CRUD API](./building-a-crud-api.md)
-- Understanding of [Socket.IO Component](/references/components/socket-io)
-- Understanding of [Socket.IO Helper](/references/helpers/socket-io)
+- Understanding of [Socket.IO Component](/references/components/socket-io/)
+- Understanding of [Socket.IO Helper](/references/helpers/socket-io/)
 - Redis for pub/sub (required by `SocketIOServerHelper`)
 
 ## 1. Project Setup
@@ -929,7 +929,7 @@ export class ChatService extends BaseService {
 ```
 
 > [!IMPORTANT]
-> **Lazy getter pattern**: `SocketIOServerHelper` is bound via a post-start hook, so it's not available during DI construction. The `private get socketIOHelper()` getter resolves it lazily on first access. See [Socket.IO Component](/references/components/socket-io#step-3-use-in-servicescontrollers) for details.
+> **Lazy getter pattern**: `SocketIOServerHelper` is bound via a post-start hook, so it's not available during DI construction. The `private get socketIOHelper()` getter resolves it lazily on first access. See [Socket.IO Component](/references/components/socket-io/#step-3-use-in-servicescontrollers) for details.
 
 ## 6. Application Setup
 
@@ -1512,7 +1512,7 @@ this.bind<RedisHelper>({
 
 ## Next Steps
 
-- Add file/image sharing with [Storage Helper](/references/helpers/storage)
+- Add file/image sharing with [Storage Helper](/references/helpers/storage/)
 - Add push notifications
 - Implement read receipts
 - Add message reactions
@@ -1520,6 +1520,6 @@ this.bind<RedisHelper>({
 
 ## See Also
 
-- [Socket.IO Component](/references/components/socket-io) — Component reference
-- [Socket.IO Helper](/references/helpers/socket-io) — Server + Client helper API
+- [Socket.IO Component](/references/components/socket-io/) — Component reference
+- [Socket.IO Helper](/references/helpers/socket-io/) — Server + Client helper API
 - [Socket.IO Test Example](https://github.com/VENIZIA-AI/ignis/tree/main/examples/socket-io-test) — Working example with automated test client

package/wiki/guides/tutorials/testing.md

@@ -703,7 +703,7 @@ class CreateAndUpdateAndDeleteHandler extends TestCaseHandler {
 
 ## Next Steps
 
-- [Testing Reference](../../references/helpers/testing.md) - Complete API documentation
+- [Testing Reference](../../references/helpers/testing/) - Complete API documentation
 - [Best Practices](../../best-practices/code-style-standards/) - Code quality standards
 - [Troubleshooting](../../best-practices/troubleshooting-tips.md) - Common issues
 

package/wiki/references/base/bootstrapping.md

@@ -773,8 +773,6 @@ await app.boot();
 ```
 
 
----
-
 ## See Also
 
 - **Related References:**

package/wiki/references/base/components.md

@@ -589,10 +589,10 @@ export * from './controller';
   - [Dependency Injection](/guides/core-concepts/dependency-injection) - Component bindings
 
 - **Built-in Components:**
-  - [Authentication Component](/references/components/authentication) - JWT authentication
+  - [Authentication Component](/references/components/authentication/) - JWT authentication
   - [Health Check Component](/references/components/health-check) - Health endpoints
   - [Swagger Component](/references/components/swagger) - API documentation
-  - [Socket.IO Component](/references/components/socket-io) - WebSocket support
+  - [Socket.IO Component](/references/components/socket-io/) - WebSocket support
 
 - **Best Practices:**
   - [Architectural Patterns](/best-practices/architectural-patterns) - Component design patterns

package/wiki/references/base/controllers.md

@@ -632,7 +632,6 @@ export class ConfigurationController extends _Controller {
 }
 ```
 
----
 
 ## See Also
 

package/wiki/references/base/datasources.md

@@ -341,7 +341,7 @@ try {
 }
 ```
 
-> **Note:** For most use cases, prefer using `repository.beginTransaction()` which provides a higher-level API. See [Repositories Reference](./repositories/.md#transactions) for details.
+> **Note:** For most use cases, prefer using `repository.beginTransaction()` which provides a higher-level API. See [Repositories Reference](./repositories/#transactions) for details.
 
 This architecture ensures that datasources are configured consistently and that the fully-initialized Drizzle connector, aware of all schemas and relations, is available to repositories for querying.
 

package/wiki/references/base/dependency-injection.md

@@ -201,7 +201,7 @@ class UserController {
   - [Providers](/references/base/providers) - Factory pattern for dynamic injection
 
 - **References:**
-  - [Inversion Helper](/references/helpers/inversion) - DI container utilities
+  - [Inversion Helper](/references/helpers/inversion/) - DI container utilities
   - [Bootstrapping API](/references/base/bootstrapping) - Auto-discovery and DI
   - [Glossary](/guides/reference/glossary#dependency-injection-di) - DI concepts explained
 

package/wiki/references/base/filter-system/quick-reference.md

@@ -22,7 +22,6 @@ Complete single-page reference for all IGNIS filter operators. For detailed expl
 
 **See:** [Comparison Operators Guide](./comparison-operators.md)
 
----
 
 ## Range Operators
 
@@ -33,7 +32,6 @@ Complete single-page reference for all IGNIS filter operators. For detailed expl
 
 **See:** [Range Operators Guide](./range-operators.md)
 
----
 
 ## List Operators
 
@@ -44,7 +42,6 @@ Complete single-page reference for all IGNIS filter operators. For detailed expl
 
 **See:** [List Operators Guide](./list-operators.md)
 
----
 
 ## Pattern Matching Operators
 
@@ -65,7 +62,6 @@ Complete single-page reference for all IGNIS filter operators. For detailed expl
 
 **See:** [Pattern Matching Guide](./pattern-matching.md)
 
----
 
 ## Null Check Operators
 
@@ -83,7 +79,6 @@ Complete single-page reference for all IGNIS filter operators. For detailed expl
 
 **See:** [Null Operators Guide](./null-operators.md)
 
----
 
 ## Logical Operators
 
@@ -106,7 +101,6 @@ Complete single-page reference for all IGNIS filter operators. For detailed expl
 
 **See:** [Logical Operators Guide](./logical-operators.md)
 
----
 
 ## PostgreSQL Array Operators
 
@@ -122,7 +116,6 @@ These operators work with PostgreSQL array columns (`varchar[]`, `text[]`, `inte
 
 **See:** [Array Operators Guide](./array-operators.md)
 
----
 
 ## JSON/JSONB Operators (PostgreSQL)
 
@@ -166,7 +159,6 @@ All comparison operators work with JSON path queries:
 
 **See:** [JSON Filtering Guide](./json-filtering.md)
 
----
 
 ## Fields, Ordering & Pagination
 
@@ -211,7 +203,6 @@ const users = await userRepo.find({
 
 **See:** [Fields, Ordering & Pagination Guide](./fields-order-pagination.md)
 
----
 
 ## Default Filters
 
@@ -250,7 +241,6 @@ await userRepo.find({
 
 **See:** [Default Filter Guide](./default-filter.md)
 
----
 
 ## Common Filter Patterns
 
@@ -314,7 +304,6 @@ await userRepo.find({
 }
 ```
 
----
 
 ## Operator Precedence
 
@@ -339,7 +328,6 @@ Use explicit parentheses (via nested `and`/`or`) for clarity:
 }
 ```
 
----
 
 ## Type Safety
 
@@ -371,7 +359,6 @@ await userRepo.find({
 });
 ```
 
----
 
 ## Performance Tips
 
@@ -407,7 +394,6 @@ await userRepo.find({
    }
    ```
 
----
 
 ## See Also
 

package/wiki/references/base/middlewares.md

@@ -187,7 +187,6 @@ async getUser(c: TRouteContext) {
 }
 ```
 
----
 
 ### Not Found Handler (`notFoundHandler`)
 
@@ -233,7 +232,6 @@ app.notFound(notFoundHandler({
 
 **Returns:** `NotFoundHandler` - Hono not found handler function
 
----
 
 ### Request Spy (`RequestSpyMiddleware`)
 
@@ -319,7 +317,6 @@ async example(c: TRouteContext) {
 Request spy logs every request detail. Consider disabling or reducing verbosity in production environments with high traffic.
 :::
 
----
 
 ### Emoji Favicon
 
@@ -372,7 +369,6 @@ app.use(emojiFavicon({ icon: '🌟' })); // Star
 SVG favicons are supported in all modern browsers. Fallback to a traditional `.ico` file if you need to support legacy browsers.
 :::
 
----
 
 ## Creating Custom Middleware
 
@@ -450,7 +446,6 @@ const myMiddleware = app.get(MyMiddleware);
 app.use(myMiddleware.value());
 ```
 
----
 
 ## Middleware Order & Priority
 
@@ -505,7 +500,6 @@ app.notFound(notFoundHandler({ logger: app.logger }));
 Placing error handler before routes will prevent it from catching route errors. Always register error handlers last.
 :::
 
----
 
 ## Common Patterns
 
@@ -543,7 +537,6 @@ const apiMiddleware = (): MiddlewareHandler => {
 };
 ```
 
----
 
 ## Performance Considerations
 
@@ -568,7 +561,6 @@ Error handlers log every error. For high error rates, consider:
 - Error aggregation services (Sentry, Rollbar)
 - Rate-limited logging
 
----
 
 ## See Also
 

package/wiki/references/base/providers.md

@@ -49,7 +49,6 @@ A **Provider** is a class that implements the Factory pattern, responsible for c
 - **Multi-Tenant**: Provide tenant-specific instances
 - **Feature Flags**: Enable/disable features at runtime
 
----
 
 ## BaseProvider Class
 
@@ -99,7 +98,6 @@ The `value` method is where you implement your factory logic.
 - Create and configure instances based on logic
 - Return factories for deferred instantiation
 
----
 
 ## Provider vs Service
 
@@ -185,7 +183,6 @@ class OrderService extends BaseService {
 - **Need to implement business logic?** → Use a Service
 :::
 
----
 
 ## Creating Custom Providers
 
@@ -297,7 +294,6 @@ export class DatabaseProvider extends BaseProvider<Database> {
 }
 ```
 
----
 
 ## Provider Lifecycle
 
@@ -354,7 +350,6 @@ export class FactoryDatabaseProvider extends BaseProvider<Database> {
 }
 ```
 
----
 
 ## Real-World Examples
 
@@ -498,7 +493,6 @@ const requestSpy = new RequestSpyMiddleware();
 app.use(requestSpy.value());
 ```
 
----
 
 ## Common Patterns
 
@@ -589,7 +583,6 @@ export class CacheProvider extends BaseProvider<ICache> {
 }
 ```
 
----
 
 ## Common Pitfalls
 
@@ -664,7 +657,6 @@ value(container: Container): IMailTransport {
 }
 ```
 
----
 
 ## Performance Considerations
 
@@ -710,7 +702,6 @@ export class ConfigProvider extends BaseProvider<Config> {
 }
 ```
 
----
 
 ## See Also
 

package/wiki/references/base/services.md

@@ -102,7 +102,6 @@ export class UserService extends BaseService {
 
 By adhering to this pattern, you keep your code organized, testable, and maintainable. You can easily test `UserService` by providing a mock `UserRepository` without needing a real database connection.
 
----
 
 ## See Also