@ooneex/module 0.17.0 → 1.0.0

package/README.md

@@ -1 +1,116 @@
-# @ooneex/router
+# @ooneex/module
+
+Module system for organizing application features into cohesive units -- groups controllers, entities, services, and middleware by domain.
+
+![Bun](https://img.shields.io/badge/Bun-Compatible-orange?style=flat-square&logo=bun)
+![TypeScript](https://img.shields.io/badge/TypeScript-Ready-blue?style=flat-square&logo=typescript)
+![MIT License](https://img.shields.io/badge/License-MIT-yellow?style=flat-square)
+
+## Features
+
+✅ **Domain Grouping** - Organize controllers, entities, middleware, and more by feature domain
+
+✅ **Controller Registration** - Bundle related controllers into a single module
+
+✅ **Entity Binding** - Associate database entities with their owning module
+
+✅ **Middleware Scoping** - Attach middleware to specific modules
+
+✅ **Permission Support** - Optional per-module permission classes
+
+✅ **Cron Jobs** - Optional cron job classes scoped to a module
+
+✅ **Event Handling** - Optional pub/sub event classes per module
+
+## Installation
+
+```bash
+bun add @ooneex/module
+```
+
+## Usage
+
+### Defining a Module
+
+```typescript
+import type { ModuleType } from '@ooneex/module';
+import { UserCreateController, UserListController } from './controllers';
+import { UserEntity } from './entities';
+import { AuthMiddleware } from './middleware';
+
+const UserModule: ModuleType = {
+  controllers: [UserCreateController, UserListController],
+  entities: [UserEntity],
+  middlewares: [AuthMiddleware],
+};
+
+export { UserModule };
+```
+
+### Module with All Options
+
+```typescript
+import type { ModuleType } from '@ooneex/module';
+
+const OrderModule: ModuleType = {
+  controllers: [OrderCreateController, OrderListController],
+  entities: [OrderEntity, OrderItemEntity],
+  permissions: [OrderPermission],
+  middlewares: [OrderValidationMiddleware],
+  cronJobs: [OrderCleanupCron],
+  events: [OrderCreatedEvent, OrderShippedEvent],
+};
+```
+
+## API Reference
+
+### Types
+
+#### `ModuleType`
+
+```typescript
+type ModuleType = {
+  controllers: ControllerClassType[];
+  entities: EntityClassType[];
+  permissions?: PermissionClassType[];
+  middlewares?: MiddlewareClassType[];
+  cronJobs?: CronClassType[];
+  events?: PubSubClassType[];
+};
+```
+
+**Required fields:**
+- `controllers` - Array of controller classes belonging to this module
+- `entities` - Array of entity classes belonging to this module
+
+**Optional fields:**
+- `permissions` - Permission classes for access control
+- `middlewares` - Middleware classes to apply to this module
+- `cronJobs` - Cron job classes scoped to this module
+- `events` - Pub/sub event classes for this module
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](./LICENSE) file for details.
+
+## Contributing
+
+Contributions are welcome! Please feel free to submit a Pull Request. For major changes, please open an issue first to discuss what you would like to change.
+
+### Development Setup
+
+1. Clone the repository
+2. Install dependencies: `bun install`
+3. Run tests: `bun run test`
+4. Build the project: `bun run build`
+
+### Guidelines
+
+- Write tests for new features
+- Follow the existing code style
+- Update documentation for API changes
+- Ensure all tests pass before submitting PR
+
+---
+
+Made with ❤️ by the Ooneex team

package/dist/index.d.ts

@@ -1,7 +1,15 @@
 import { ControllerClassType } from "@ooneex/controller";
+import { CronClassType } from "@ooneex/cron";
 import { EntityClassType } from "@ooneex/entity";
+import { MiddlewareClassType } from "@ooneex/middleware";
+import { PermissionClassType } from "@ooneex/permission";
+import { PubSubClassType } from "@ooneex/pub-sub";
 type ModuleType = {
 	controllers: ControllerClassType[];
 	entities: EntityClassType[];
+	permissions?: PermissionClassType[];
+	middlewares?: MiddlewareClassType[];
+	cronJobs?: CronClassType[];
+	events?: PubSubClassType[];
 };
 export { ModuleType };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@ooneex/module",
-  "description": "Module system for organizing application features by grouping controllers, entities, and related components",
-  "version": "0.17.0",
+  "description": "Module system for organizing application features into cohesive units — groups controllers, entities, services, and middleware by domain",
+  "version": "1.0.0",
   "type": "module",
   "files": [
     "dist",
@@ -27,8 +27,12 @@
     "npm:publish": "bun publish --tolerate-republish --access public"
   },
   "devDependencies": {
-    "@ooneex/controller": "0.16.1",
-    "@ooneex/entity": "0.0.17"
+    "@ooneex/middleware": "0.17.1",
+    "@ooneex/controller": "0.17.1",
+    "@ooneex/permission": "0.0.19",
+    "@ooneex/pub-sub": "0.0.20",
+    "@ooneex/cron": "0.0.18",
+    "@ooneex/entity": "0.0.18"
   },
   "keywords": [
     "bun",