db-bridge 1.1.7 → 1.2.0

package/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2025 Berke Erdoğan
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+MIT License
+
+Copyright (c) 2025 Berke Erdoğan
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 SOFTWARE.

package/README.md

@@ -149,13 +149,36 @@ export default {
   },
   migrations: {
     directory: './src/migrations',
+    tableName: 'db_migrations', // Optional: custom table name
+    prefix: 'auth', // Optional: filename prefix (e.g., auth_20250119_xxx.ts)
   },
   seeds: {
     directory: './src/seeds',
+    prefix: 'auth', // Optional: filename prefix (e.g., auth_users_seeder.ts)
   },
 };
 ```
 
+#### Migration Prefix (Multi-Service Support)
+
+The `prefix` option is useful for **microservice architectures** where multiple services share the same database. Each service can have its own migration prefix to avoid naming conflicts:
+
+```javascript
+// auth-service/dbbridge.config.ts
+migrations: {
+  directory: './src/migrations',
+  tableName: 'db_migrations_auth',  // Separate migration tracking table
+  prefix: 'auth',                    // Creates: auth_20250119120000_create_users.ts
+}
+
+// order-service/dbbridge.config.ts
+migrations: {
+  directory: './src/migrations',
+  tableName: 'db_migrations_order',
+  prefix: 'order',                   // Creates: order_20250119120000_create_orders.ts
+}
+```
+
 ### Commands
 
 ```bash
@@ -183,13 +206,158 @@ npx db-bridge migrate:fresh
 # Validate migration checksums
 npx db-bridge migrate:validate
 
+# Preview migrations without executing (dry-run)
+npx db-bridge migrate:latest --dry-run
+
 # Create a seeder
 npx db-bridge make:seeder users
 
 # Run seeders
 npx db-bridge db:seed
+
+# Generate TypeScript types from database schema
+npx db-bridge generate:types
+
+# Generate types with options
+npx db-bridge generate:types --output=./src/types/db.ts --camel-case
+```
+
+### Type Generation
+
+Generate TypeScript interfaces directly from your database schema:
+
+```bash
+npx db-bridge generate:types
+```
+
+This generates a file like:
+
+```typescript
+// src/types/database.ts (auto-generated)
+
+/**
+ * Users - users table
+ */
+export interface Users {
+  id: number;
+  name: string;
+  email: string;
+  password: string;
+  created_at: Date;
+  updated_at: Date | null;
+}
+
+/**
+ * Orders - orders table
+ */
+export interface Orders {
+  id: number;
+  user_id: number;
+  total: number;
+  status: string;
+  created_at: Date;
+}
+```
+
+#### Type Generation Options
+
+| Option             | Description                                           |
+| ------------------ | ----------------------------------------------------- |
+| `--output=<path>`  | Output file path (default: `./src/types/database.ts`) |
+| `--tables=<list>`  | Comma-separated list of tables to include             |
+| `--exclude=<list>` | Comma-separated list of tables to exclude             |
+| `--camel-case`     | Use camelCase for property names                      |
+| `--comments`       | Include JSDoc comments (default: true)                |
+
+You can also configure type generation in your config file:
+
+```javascript
+// db-bridge.config.mjs
+export default {
+  connection: {
+    /* ... */
+  },
+  types: {
+    output: './src/types/database.ts',
+    exclude: ['logs', 'sessions'],
+    camelCase: true,
+  },
+};
 ```
 
+### Seeder Ordering
+
+Seeders support priority and dependency-based ordering to ensure data is seeded in the correct order:
+
+```typescript
+// src/seeds/users_seeder.ts
+import type { Seeder, DatabaseAdapter } from '@db-bridge/core';
+
+export default {
+  // Lower priority runs first (default: 100)
+  priority: 10,
+
+  async run(adapter: DatabaseAdapter): Promise<void> {
+    await adapter.execute(`
+      INSERT INTO users (name, email) VALUES
+      ('Admin', 'admin@example.com')
+    `);
+  },
+} satisfies Seeder;
+```
+
+```typescript
+// src/seeds/orders_seeder.ts
+import type { Seeder, DatabaseAdapter } from '@db-bridge/core';
+
+export default {
+  // This seeder depends on users being seeded first
+  depends: ['users'],
+
+  async run(adapter: DatabaseAdapter): Promise<void> {
+    await adapter.execute(`
+      INSERT INTO orders (user_id, total) VALUES
+      (1, 99.99)
+    `);
+  },
+} satisfies Seeder;
+```
+
+**Ordering Rules:**
+
+1. Seeders with dependencies run after their dependencies
+2. Within the same dependency level, lower priority runs first
+3. Default priority is 100
+
+### Migration Dry-Run
+
+Preview SQL statements that would be executed without actually running them:
+
+```bash
+npx db-bridge migrate:latest --dry-run
+```
+
+Output:
+
+```
+ℹ Running: 20260118120000_create_users_table
+ℹ DRY RUN: UP 20260118120000_create_users_table
+ℹ SQL statements that would be executed:
+ℹ   CREATE TABLE `users` (
+      `id` INT UNSIGNED AUTO_INCREMENT PRIMARY KEY,
+      `name` VARCHAR(100) NOT NULL,
+      `email` VARCHAR(255) NOT NULL UNIQUE,
+      `created_at` TIMESTAMP DEFAULT CURRENT_TIMESTAMP,
+      `updated_at` TIMESTAMP DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP
+    )
+```
+
+This is useful for:
+
+- Reviewing SQL before executing on production
+- Debugging migration issues
+- Generating SQL scripts for manual execution
+
 ### Migration Example
 
 ```typescript

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "db-bridge",
-  "version": "1.1.7",
+  "version": "1.2.0",
   "type": "module",
   "description": "Unified database adapter for Node.js - All-in-one package with MySQL, PostgreSQL, and Redis support",
   "types": "./dist/index.d.ts",
@@ -18,10 +18,10 @@
     "prepublishOnly": "npm run clean && npm run build"
   },
   "dependencies": {
-    "@db-bridge/core": "^1.1.7",
-    "@db-bridge/mysql": "^1.1.7",
-    "@db-bridge/postgresql": "^1.1.7",
-    "@db-bridge/redis": "^1.1.7"
+    "@db-bridge/core": "^1.2.0",
+    "@db-bridge/mysql": "^1.2.0",
+    "@db-bridge/postgresql": "^1.2.0",
+    "@db-bridge/redis": "^1.2.0"
   },
   "devDependencies": {
     "@types/node": "^20.10.5",
@@ -66,5 +66,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "654018624e7e4f5fbef87aa7d423dcf172d04da3"
+  "gitHead": "bddce510748d76b76c57b1f1085ddf06ef167b82"
 }