@ooneex/seeds 0.16.0 → 1.0.0

package/README.md

@@ -1 +1,185 @@
 # @ooneex/seeds
+
+Database seeding framework for populating initial data, fixtures, and test datasets with execution logging and idempotent operations.
+
+![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
+
+✅ **Seed Decorator** - Register seed classes with the DI container using `@decorator.seed()`
+
+✅ **ISeed Interface** - Standard interface with `run()`, `isActive()`, and `getDependencies()` methods
+
+✅ **Dependency Resolution** - Define and automatically resolve seed dependencies before execution
+
+✅ **Active/Inactive Control** - Enable or disable individual seeds via the `isActive()` method
+
+✅ **Seed Runner** - Execute all active seeds in order with terminal logging via `seedRun()`
+
+✅ **Seed Scaffolding** - Generate new seed files from a template with `seedCreate()`
+
+✅ **Execution Logging** - Built-in terminal logging for seed progress, success, and failure
+
+✅ **Container Integration** - Automatic registration with `@ooneex/container` for dependency injection
+
+## Installation
+
+```bash
+bun add @ooneex/seeds
+```
+
+## Usage
+
+### Basic Seed
+
+```typescript
+import { decorator, type ISeed, type SeedClassType } from '@ooneex/seeds';
+
+@decorator.seed()
+export class UserSeed implements ISeed {
+  public async run<T>(data?: unknown[]): Promise<T> {
+    // Insert initial users into the database
+    return data as T;
+  }
+
+  public isActive(): boolean {
+    return true;
+  }
+
+  public async getDependencies(): Promise<SeedClassType[]> {
+    return [];
+  }
+}
+```
+
+### Seed with Dependencies
+
+```typescript
+import { decorator, type ISeed, type SeedClassType } from '@ooneex/seeds';
+
+@decorator.seed()
+export class RoleSeed implements ISeed {
+  public async run<T>(data?: unknown[]): Promise<T> {
+    // Insert roles first
+    return data as T;
+  }
+
+  public isActive(): boolean {
+    return true;
+  }
+
+  public async getDependencies(): Promise<SeedClassType[]> {
+    return [];
+  }
+}
+
+@decorator.seed()
+export class UserSeed implements ISeed {
+  public async run<T>(data?: unknown[]): Promise<T> {
+    // Roles are available in data from resolved dependencies
+    return data as T;
+  }
+
+  public isActive(): boolean {
+    return true;
+  }
+
+  public async getDependencies(): Promise<SeedClassType[]> {
+    return [RoleSeed];
+  }
+}
+```
+
+### Running Seeds
+
+```typescript
+import { seedRun } from '@ooneex/seeds';
+
+await seedRun();
+```
+
+### Creating a New Seed
+
+```typescript
+import { seedCreate } from '@ooneex/seeds';
+
+const filePath = await seedCreate({ name: 'product', dir: 'seeds' });
+// Creates seeds/ProductSeed.ts from the built-in template
+```
+
+## API Reference
+
+### Decorators
+
+#### `@decorator.seed(scope?)`
+
+Decorator to register a seed class with the DI container.
+
+**Parameters:**
+- `scope` - Container scope (default: `EContainerScope.Singleton`)
+
+### Interfaces
+
+#### `ISeed`
+
+Interface for seed implementations.
+
+```typescript
+interface ISeed {
+  run: <T = unknown>(data?: unknown[]) => Promise<T> | T;
+  isActive: () => Promise<boolean> | boolean;
+  getDependencies: () => Promise<SeedClassType[]> | SeedClassType[];
+}
+```
+
+### Functions
+
+#### `seedRun(): Promise<void>`
+
+Execute all active seeds with dependency resolution and terminal logging.
+
+#### `seedCreate(config: { name: string; dir?: string }): Promise<string>`
+
+Generate a new seed file from the built-in template. Returns the path of the created file.
+
+#### `getSeeds(): ISeed[]`
+
+Retrieve all registered and active seed instances from the container.
+
+### Types
+
+#### `SeedClassType`
+
+Type for seed class constructors.
+
+```typescript
+type SeedClassType = new (...args: any[]) => ISeed;
+```
+
+## 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/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@ooneex/seeds",
-  "description": "Database seeding utilities for populating initial and test data with logging support",
-  "version": "0.16.0",
+  "description": "Database seeding framework for populating initial data, fixtures, and test datasets with execution logging and idempotent operations",
+  "version": "1.0.0",
   "type": "module",
   "files": [
     "dist",
@@ -28,12 +28,12 @@
     "npm:publish": "bun publish --tolerate-republish --access public"
   },
   "dependencies": {
-    "@ooneex/container": "0.0.17",
-    "@ooneex/logger": "0.15.0",
-    "@ooneex/utils": "0.1.0"
+    "@ooneex/container": "0.0.19",
+    "@ooneex/logger": "0.17.2",
+    "@ooneex/utils": "0.1.1"
   },
   "devDependencies": {
-    "@ooneex/exception": "0.0.16"
+    "@ooneex/exception": "0.0.18"
   },
   "keywords": [
     "bun",