@venizia/ignis-docs 0.0.7 → 0.0.8-1

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

@@ -28,7 +28,7 @@ cd ecommerce-api
 bun init -y
 
 # Install dependencies
-bun add hono @hono/zod-openapi @venizia/ignis dotenv-flow
+bun add hono @hono/zod-openapi @venizia/ignis @venizia/ignis-helpers
 bun add drizzle-orm drizzle-zod pg stripe
 bun add -d typescript @types/bun @venizia/dev-configs drizzle-kit @types/pg
 ```
@@ -57,9 +57,19 @@ ecommerce-api/
 │   │   ├── order.service.ts
 │   │   └── payment.service.ts
 │   ├── controllers/
-│   │   ├── product.controller.ts
-│   │   ├── cart.controller.ts
-│   │   └── order.controller.ts
+│   │   ├── product/
+│   │   │   ├── definitions.ts
+│   │   │   ├── product.controller.ts
+│   │   │   └── index.ts
+│   │   ├── cart/
+│   │   │   ├── definitions.ts
+│   │   │   ├── cart.controller.ts
+│   │   │   └── index.ts
+│   │   ├── order/
+│   │   │   ├── definitions.ts
+│   │   │   ├── order.controller.ts
+│   │   │   └── index.ts
+│   │   └── index.ts
 │   └── datasources/
 │       └── postgres.datasource.ts
 └── package.json
@@ -314,7 +324,6 @@ export * from './order.model';
 import {
   BaseDataSource,
   datasource,
-  TNodePostgresConnector,
   ValueOrPromise,
 } from '@venizia/ignis';
 import { drizzle } from 'drizzle-orm/node-postgres';
@@ -329,7 +338,7 @@ interface IDSConfigs {
 }
 
 @datasource({ driver: 'node-postgres' })
-export class PostgresDataSource extends BaseDataSource<TNodePostgresConnector, IDSConfigs> {
+export class PostgresDataSource extends BaseDataSource<IDSConfigs> {
   constructor() {
     super({
       name: PostgresDataSource.name,
@@ -490,7 +499,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 +572,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 +724,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 });
@@ -915,10 +924,10 @@ export class PaymentService extends BaseService {
 ### Product Controller
 
 ```typescript
-// src/controllers/product.controller.ts
+// src/controllers/product/product.controller.ts
 import { z } from '@hono/zod-openapi';
 import {
-  BaseController,
+  BaseRestController,
   controller,
   get,
   inject,
@@ -968,9 +977,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' });
@@ -1003,10 +1012,10 @@ export class ProductController extends BaseController {
 ### Cart Controller
 
 ```typescript
-// src/controllers/cart.controller.ts
+// src/controllers/cart/cart.controller.ts
 import { z } from '@hono/zod-openapi';
 import {
-  BaseController,
+  BaseRestController,
   controller,
   get,
   post,
@@ -1083,9 +1092,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' });
@@ -1142,10 +1151,10 @@ export class CartController extends BaseController {
 ### Order Controller
 
 ```typescript
-// src/controllers/order.controller.ts
+// src/controllers/order/order.controller.ts
 import { z } from '@hono/zod-openapi';
 import {
-  BaseController,
+  BaseRestController,
   controller,
   get,
   post,
@@ -1223,9 +1232,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' });
@@ -1265,9 +1274,9 @@ export class OrderController extends BaseController {
 import { BaseApplication, IApplicationInfo } from '@venizia/ignis';
 import { HealthCheckComponent, SwaggerComponent } from '@venizia/ignis';
 
-import { ProductController } from './controllers/product.controller';
-import { CartController } from './controllers/cart.controller';
-import { OrderController } from './controllers/order.controller';
+import { ProductController } from './controllers/product';
+import { CartController } from './controllers/cart';
+import { OrderController } from './controllers/order';
 
 import { ProductService } from './services/product.service';
 import { CartService } from './services/cart.service';
@@ -1393,7 +1402,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
@@ -25,7 +25,7 @@ cd chat-api
 bun init -y
 
 # Install dependencies
-bun add hono @hono/zod-openapi @venizia/ignis dotenv-flow
+bun add hono @hono/zod-openapi @venizia/ignis @venizia/ignis-helpers
 bun add drizzle-orm drizzle-zod pg
 bun add -d typescript @types/bun @venizia/dev-configs drizzle-kit @types/pg
 
@@ -241,7 +241,6 @@ export * from './message.model';
 import {
   BaseDataSource,
   datasource,
-  TNodePostgresConnector,
   ValueOrPromise,
 } from '@venizia/ignis';
 import { drizzle } from 'drizzle-orm/node-postgres';
@@ -256,7 +255,7 @@ interface IDSConfigs {
 }
 
 @datasource({ driver: 'node-postgres' })
-export class PostgresDataSource extends BaseDataSource<TNodePostgresConnector, IDSConfigs> {
+export class PostgresDataSource extends BaseDataSource<IDSConfigs> {
   constructor() {
     super({
       name: PostgresDataSource.name,
@@ -928,7 +927,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
 
@@ -953,7 +952,7 @@ import {
   SocketIOServerHelper,
 } from '@venizia/ignis-helpers';
 import { ChatService } from './services/chat.service';
-import { ChatController } from './controllers/chat.controller';
+import { ChatController } from './controllers/chat';
 import { UserRepository } from './repositories/user.repository';
 import { RoomRepository, RoomMemberRepository } from './repositories/room.repository';
 import { MessageRepository, DirectMessageRepository } from './repositories/message.repository';
@@ -1124,10 +1123,10 @@ Client connects → 'authenticate' event → authenticateFn() → 'authenticated
 ## 7. REST API for Chat History
 
 ```typescript
-// src/controllers/chat.controller.ts
+// src/controllers/chat/chat.controller.ts
 import { z } from '@hono/zod-openapi';
 import {
-  BaseController,
+  BaseRestController,
   controller,
   inject,
   jsonResponse,
@@ -1182,7 +1181,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 +1512,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 +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](/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>