@venizia/ignis-docs 0.0.7-2 → 0.0.8-0

package/wiki/guides/tutorials/complete-installation.md

@@ -239,14 +239,17 @@ export class Application extends BaseApplication {
 
 **Key takeaway:** You'll mostly work in `preConfigure()` when building your app. The other hooks are there when you need them.
 
-**Application Lifecycle Hooks:**
+**Application Lifecycle Hooks (execution order):**
 | Hook | Purpose | Usage |
 |------|---------|-------|
 | `getAppInfo()` | Application metadata | Required - used for API docs |
-| `staticConfigure()` | Static file serving | Optional |
-| `setupMiddlewares()` | Global middlewares | Optional |
-| `preConfigure()` | **Register resources** | **Main hook** - register controllers, services, etc. |
+| `staticConfigure()` | Static file serving | Optional - runs before DI registration |
+| `preConfigure()` | **Register resources** | **Main hook** - register controllers, services, components, etc. |
+| `registerDataSources()` | Configure datasources | Auto - discovers and configures bound datasources |
+| `registerComponents()` | Configure components | Auto - discovers and configures bound components |
+| `registerControllers()` | Configure controllers | Auto - mounts REST/gRPC routes |
 | `postConfigure()` | Post-initialization | Optional - seed data, background jobs |
+| `setupMiddlewares()` | Global middlewares | Optional - runs after `initialize()`, before server starts |
 
 > **Deep Dive:** See [Application Class Reference](../core-concepts/application/) for detailed lifecycle documentation.
 
@@ -256,7 +259,7 @@ Create `src/controllers/hello.controller.ts` - controllers handle HTTP requests
 
 ```typescript
 import {
-  BaseController,
+  BaseRestController,
   controller,
   api,
   jsonContent,
@@ -270,7 +273,7 @@ const BASE_PATH = '/hello';
 // The @controller decorator registers this class as a controller
 // All routes in this controller will be under /api/hello (remember path.base: '/api')
 @controller({ path: BASE_PATH })
-export class HelloController extends BaseController {
+export class HelloController extends BaseRestController {
   constructor() {
     super({ scope: HelloController.name, path: BASE_PATH });
   }
@@ -278,12 +281,12 @@ export class HelloController extends BaseController {
   // Required: Override binding() to register routes or dependencies
   override binding() {
     // Option 1: Use bindRoute() or defineRoute() for programmatic route registration
-    // this.bindRoute({ method: 'get', path: '/programmatic', handler: this.myHandler });
+    // this.bindRoute({ configs: { method: 'get', path: '/programmatic', responses: {...} } }).to({ handler: this.myHandler });
 
     // Option 2: Use @api decorator on methods (shown below) - recommended
   }
 
-  // The @api decorator defines a route (prefer @api with method over @get/@post)
+  // The @api decorator defines a route with explicit method. You can also use @get/@post shorthand decorators.
   @api({
     configs: {
       method: HTTP.Methods.GET,
@@ -303,8 +306,8 @@ export class HelloController extends BaseController {
     return c.json({ message: 'Hello, World!' }, HTTP.ResultCodes.RS_2.Ok);
   }
 
-  // For authenticated endpoints, add 'authStrategies':
-  // @api({ configs: { method: HTTP.Methods.GET, path: '/secure', authStrategies: [Authentication.STRATEGY_JWT] } })
+  // For authenticated endpoints, add 'authenticate':
+  // @api({ configs: { method: HTTP.Methods.GET, path: '/secure', authenticate: { strategies: [Authentication.STRATEGY_JWT] } } })
 }
 ```
 
@@ -312,13 +315,13 @@ export class HelloController extends BaseController {
 
 | Pattern | Description |
 |---------|-------------|
-| `@controller` | Registers the class as a controller with a base path |
-| `@api` | Defines a route with `method` specified (recommended) |
-| `@get`, `@post`, etc. | Shorthand decorators (also work) |
+| `@controller` | Registers the class as a controller with a base path. Supports optional `transport` field (`'rest'` default, `'grpc'`) |
+| `@api` | Defines a route with `method` specified in configs |
+| `@get`, `@post`, etc. | Shorthand decorators that auto-set the HTTP method (recommended) |
 | `binding()` | Required override — use `bindRoute()` or `defineRoute()` for programmatic routes |
 | Zod schemas | Provide automatic validation and OpenAPI docs |
 
-> **Deep Dive:** See [Controllers Reference](../core-concepts/controllers.md) for advanced routing patterns and validation.
+> **Deep Dive:** See [Controllers Reference](../core-concepts/rest-controllers.md) for advanced routing patterns and validation.
 
 ### Create Entry Point
 

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

@@ -490,7 +490,7 @@ import { getError } from '@venizia/ignis-helpers';
 @injectable()
 export class ProductService extends BaseService {
   constructor(
-    @inject('repositories.ProductRepository')
+    @inject({ key: 'repositories.ProductRepository' })
     private _productRepo: ProductRepository,
   ) {
     super({ scope: ProductService.name });
@@ -563,9 +563,9 @@ interface ICartItem {
 @injectable()
 export class CartService extends BaseService {
   constructor(
-    @inject('repositories.CartRepository')
+    @inject({ key: 'repositories.CartRepository' })
     private _cartRepo: CartRepository,
-    @inject('services.ProductService')
+    @inject({ key: 'services.ProductService' })
     private _productService: ProductService,
   ) {
     super({ scope: CartService.name });
@@ -715,13 +715,13 @@ interface ICreateOrderInput {
 @injectable()
 export class OrderService extends BaseService {
   constructor(
-    @inject('repositories.OrderRepository')
+    @inject({ key: 'repositories.OrderRepository' })
     private _orderRepo: OrderRepository,
-    @inject('services.CartService')
+    @inject({ key: 'services.CartService' })
     private _cartService: CartService,
-    @inject('services.ProductService')
+    @inject({ key: 'services.ProductService' })
     private _productService: ProductService,
-    @inject('services.PaymentService')
+    @inject({ key: 'services.PaymentService' })
     private _paymentService: PaymentService,
   ) {
     super({ scope: OrderService.name });
@@ -918,7 +918,7 @@ export class PaymentService extends BaseService {
 // src/controllers/product.controller.ts
 import { z } from '@hono/zod-openapi';
 import {
-  BaseController,
+  BaseRestController,
   controller,
   get,
   inject,
@@ -968,9 +968,9 @@ const ProductRoutes = {
 type ProductRoutes = typeof ProductRoutes;
 
 @controller({ path: '/products' })
-export class ProductController extends BaseController {
+export class ProductController extends BaseRestController {
   constructor(
-    @inject('services.ProductService')
+    @inject({ key: 'services.ProductService' })
     private _productService: ProductService,
   ) {
     super({ scope: ProductController.name, path: '/products' });
@@ -1006,7 +1006,7 @@ export class ProductController extends BaseController {
 // src/controllers/cart.controller.ts
 import { z } from '@hono/zod-openapi';
 import {
-  BaseController,
+  BaseRestController,
   controller,
   get,
   post,
@@ -1083,9 +1083,9 @@ const CartRoutes = {
 type CartRoutes = typeof CartRoutes;
 
 @controller({ path: '/cart' })
-export class CartController extends BaseController {
+export class CartController extends BaseRestController {
   constructor(
-    @inject('services.CartService')
+    @inject({ key: 'services.CartService' })
     private _cartService: CartService,
   ) {
     super({ scope: CartController.name, path: '/cart' });
@@ -1145,7 +1145,7 @@ export class CartController extends BaseController {
 // src/controllers/order.controller.ts
 import { z } from '@hono/zod-openapi';
 import {
-  BaseController,
+  BaseRestController,
   controller,
   get,
   post,
@@ -1223,9 +1223,9 @@ const OrderRoutes = {
 type OrderRoutes = typeof OrderRoutes;
 
 @controller({ path: '/orders' })
-export class OrderController extends BaseController {
+export class OrderController extends BaseRestController {
   constructor(
-    @inject('services.OrderService')
+    @inject({ key: 'services.OrderService' })
     private _orderService: OrderService,
   ) {
     super({ scope: OrderController.name, path: '/orders' });
@@ -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](/extensions/components/authentication/)
+- Add order notifications with [Mail Component](/extensions/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](/extensions/components/socket-io/)
+- Understanding of [Socket.IO Helper](/extensions/helpers/socket-io/)
 - Redis for pub/sub (required by `SocketIOServerHelper`)
 
 ## 1. Project Setup
@@ -928,7 +928,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](/extensions/components/socket-io/#step-3-use-in-servicescontrollers) for details.
 
 ## 6. Application Setup
 
@@ -1127,7 +1127,7 @@ Client connects → 'authenticate' event → authenticateFn() → 'authenticated
 // src/controllers/chat.controller.ts
 import { z } from '@hono/zod-openapi';
 import {
-  BaseController,
+  BaseRestController,
   controller,
   inject,
   jsonResponse,
@@ -1182,7 +1182,7 @@ const ChatRoutes = {
 } as const;
 
 @controller({ path: '/chat' })
-export class ChatController extends BaseController {
+export class ChatController extends BaseRestController {
   constructor(
     @inject({
       key: BindingKeys.build({
@@ -1513,7 +1513,7 @@ this.bind<RedisHelper>({
 
 ## Next Steps
 
-- Add file/image sharing with [Storage Helper](/references/helpers/storage/)
+- Add file/image sharing with [Storage Helper](/extensions/helpers/storage/)
 - Add push notifications
 - Implement read receipts
 - Add message reactions
@@ -1521,6 +1521,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](/extensions/components/socket-io/) — Component reference
+- [Socket.IO Helper](/extensions/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

@@ -27,7 +27,7 @@ Since Ignis is just a TypeScript/JavaScript application framework, you can test
 
 Before starting, ensure you have:
 - A working Ignis application (see [Building a CRUD API](./building-a-crud-api.md))
-- Basic understanding of [Controllers](../core-concepts/controllers.md) and [Repositories](../core-concepts/persistent/)
+- Basic understanding of [Controllers](../core-concepts/rest-controllers.md) and [Repositories](../core-concepts/persistent/)
 
 ## Quick Examples with Popular Frameworks
 
@@ -702,7 +702,7 @@ class CreateAndUpdateAndDeleteHandler extends TestCaseHandler {
 
 ## Next Steps
 
-- [Testing Reference](../../references/helpers/testing/) - Complete API documentation
+- [Testing Reference](../../extensions/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/index.md

@@ -37,7 +37,7 @@ features:
 
   - title: Auto-Generated Docs
     details: OpenAPI/Swagger from Zod schemas. Interactive API explorer included with zero config.
-    link: /references/components/swagger
+    link: /extensions/components/swagger
     linkText: View example
 
   - title: Type-Safe Database
@@ -64,13 +64,13 @@ bun add -d typescript @types/bun
 ```
 
 ```typescript
-import { BaseApplication, BaseController, controller, get, jsonContent, SwaggerComponent } from '@venizia/ignis';
+import { BaseApplication, BaseRestController, controller, get, jsonContent, SwaggerComponent } from '@venizia/ignis';
 import { HTTP } from '@venizia/ignis-helpers';
 import { z } from '@hono/zod-openapi';
 
 // 1. Define your controller
 @controller({ path: '/hello' })
-class HelloController extends BaseController {
+class HelloController extends BaseRestController {
   constructor() {
     super({ scope: 'HelloController', path: '/hello' });
   }
@@ -140,6 +140,7 @@ Ready for a step-by-step guide? Follow the [5-minute quickstart →](/guides/get
 <li><strong>Enterprise apps</strong> — Teams need clear patterns</li>
 <li><strong>Growing projects</strong> — 10+ endpoints that need structure</li>
 <li><strong>REST APIs</strong> — Full CRUD with validation & docs</li>
+<li><strong>gRPC APIs</strong> — ConnectRPC-based gRPC with decorator support</li>
 <li><strong>Real-time apps</strong> — WebSocket support built-in</li>
 </ul>
 </div>