@venizia/ignis-docs 0.0.3 → 0.0.4-1

package/wiki/references/base/services.md

@@ -1,3 +1,9 @@
+---
+title: Services Reference
+description: Technical reference for BaseService and business logic layer
+difficulty: beginner
+---
+
 # Deep Dive: Services
 
 Technical reference for `BaseService` - the foundation for business logic layers in Ignis.
@@ -68,17 +74,17 @@ export class UserService extends BaseService {
   // 2. Dependencies (like UserRepository) are injected
   constructor(
     @inject({ key: 'repositories.UserRepository' })
-    private userRepository: UserRepository,
+    private _userRepository: UserRepository,
   ) {
     super({ scope: UserService.name });
   }
 
   // 3. Method is called by a controller
-  async getUserProfile(userId: string): Promise<Partial<TUser>> {
-    this.logger.info(`Fetching profile for user ${userId}`);
+  async getUserProfile(opts: { userId: string }): Promise<Partial<TUser>> {
+    this.logger.info(`Fetching profile for user ${opts.userId}`);
 
     // 4. Orchestrates logic: calls the repository
-    const user = await this.userRepository.findById({ id: userId });
+    const user = await this._userRepository.findById({ id: opts.userId });
 
     if (!user) {
       throw getError({ message: 'User not found' });
@@ -95,3 +101,21 @@ 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
+
+- **Related References:**
+  - [Controllers](./controllers.md) - HTTP request handlers that call services
+  - [Repositories](./repositories/) - Data access layer used by services
+  - [Providers](./providers.md) - Factory pattern for runtime instantiation
+  - [Dependency Injection](./dependency-injection.md) - DI container and injection patterns
+
+- **Guides:**
+  - [Building Services](/guides/core-concepts/services.md)
+  - [Dependency Injection Guide](/guides/core-concepts/dependency-injection.md)
+
+- **Best Practices:**
+  - [Architectural Patterns](/best-practices/architectural-patterns)
+  - [Testing Guide](/guides/tutorials/testing)

package/wiki/references/components/authentication.md

@@ -242,7 +242,8 @@ import { Context } from 'hono';
 
 export class AuthenticationService extends BaseService implements IAuthService {
   constructor(
-    @inject({ key: 'services.JWTTokenService' }) private jwtService: JWTTokenService,
+    @inject({ key: 'services.JWTTokenService' })
+    private _jwtTokenService: JWTTokenService,
   ) {
     super({ scope: AuthenticationService.name });
   }
@@ -267,7 +268,7 @@ export class AuthenticationService extends BaseService implements IAuthService {
       // Add any other data you want in the token
     };
 
-    const token = await this.jwtService.generate({ payload });
+    const token = await this._jwtTokenService.generate({ payload });
     return { token };
   }
 
@@ -440,3 +441,22 @@ if (user) {
   console.log('User is not authenticated or not found in context.');
 }
 ```
+
+## See Also
+
+- **Related Concepts:**
+  - [Components Overview](/guides/core-concepts/components) - Component system basics
+  - [Controllers](/guides/core-concepts/controllers) - Protecting routes with auth
+
+- **Other Components:**
+  - [Components Index](./index) - All built-in components
+
+- **References:**
+  - [Middlewares](/references/base/middlewares) - Custom authentication middleware
+  - [Crypto Helper](/references/helpers/crypto) - Password hashing utilities
+
+- **Best Practices:**
+  - [Security Guidelines](/best-practices/security-guidelines) - Authentication best practices
+
+- **Tutorials:**
+  - [Building a CRUD API](/guides/tutorials/building-a-crud-api) - Adding authentication

package/wiki/references/components/health-check.md

@@ -188,3 +188,15 @@ import { HealthCheckComponent } from '@venizia/ignis';
     ```
 
 This component provides a simple and effective way to monitor the health of your `Ignis` application.
+
+## See Also
+
+- **Related Concepts:**
+  - [Components Overview](/guides/core-concepts/components) - Component system basics
+  - [Application](/guides/core-concepts/application/) - Registering components
+
+- **Other Components:**
+  - [Components Index](./index) - All built-in components
+
+- **Best Practices:**
+  - [Deployment Strategies](/best-practices/deployment-strategies) - Production monitoring

package/wiki/references/components/index.md

@@ -8,6 +8,7 @@ Reusable, pluggable modules that group together related features. A component ca
 |-----------|---------|--------------|
 | [Authentication](./authentication.md) | JWT-based auth | Token generation, protected routes, user payload |
 | [Health Check](./health-check.md) | Monitoring endpoint | `/health` endpoint, ping/pong functionality |
+| [Mail](./mail.md) | Email sending system | Multiple transports, templating, queue-based processing |
 | [Request Tracker](./request-tracker.md) | Request logging | Request ID generation, timing, structured logging |
 | [Socket.IO](./socket-io.md) | Real-time communication | WebSocket support, Redis adapter, event-based |
 | [Static Asset](./static-asset.md) | File management | Upload/download files, MinIO & local filesystem support |
@@ -61,3 +62,25 @@ import { MyCustomComponent } from './components/my-custom.component';
 When the application starts, it will automatically call the `binding()` method of the registered component, setting up all the resources it provides.
 
 Using components is a great way to organize your application's features into modular, reusable pieces of code, keeping your main application class clean and focused on high-level configuration.
+
+## See Also
+
+- **Component Guides:**
+  - [Components Overview](/guides/core-concepts/components) - What components are
+  - [Creating Components](/guides/core-concepts/components-guide) - Build your own components
+
+- **Built-in Components:**
+  - [Authentication](./authentication) - JWT authentication
+  - [Health Check](./health-check) - Health check endpoints
+  - [Swagger](./swagger) - API documentation
+  - [Socket.IO](./socket-io) - WebSocket support
+  - [Mail](./mail) - Email functionality
+  - [Request Tracker](./request-tracker) - Request tracking
+  - [Static Asset](./static-asset) - Static file serving
+
+- **References:**
+  - [BaseComponent API](/references/base/components) - Component base class
+  - [Application](/references/base/application) - Registering components
+
+- **Best Practices:**
+  - [Architectural Patterns](/best-practices/architectural-patterns) - Component design patterns