drizzle-multitenant 1.0.3 → 1.0.5

package/.claude/settings.local.json

@@ -10,7 +10,9 @@
       "Bash(mkdir:*)",
       "Bash(node ./bin/drizzle-multitenant.js:*)",
       "Bash(ls:*)",
-      "Bash(npm run test:*)"
+      "Bash(npm run test:*)",
+      "Bash(node ./dist/cli/index.js:*)",
+      "Bash(npx tsc:*)"
     ]
   }
 }

package/README.md

@@ -56,6 +56,15 @@ export default defineConfig({
     tenant: tenantSchema,
     shared: sharedSchema,
   },
+  // Optional: CLI migrations config
+  migrations: {
+    tenantFolder: './drizzle/tenant',
+    migrationsTable: '__drizzle_migrations', // Custom table name
+    tenantDiscovery: async () => {
+      // Return list of tenant IDs for migrations
+      return ['tenant-1', 'tenant-2'];
+    },
+  },
 });
 ```
 
@@ -200,12 +209,18 @@ expect(tenantDb.__tenantId).toBe('expected-tenant');
 ## CLI Commands
 
 ```bash
+# Initialize configuration (interactive wizard)
+npx drizzle-multitenant init
+
 # Generate a new migration
 npx drizzle-multitenant generate --name=add-users-table
 
-# Apply migrations to all tenants
+# Apply migrations to all tenants (with progress bar)
 npx drizzle-multitenant migrate --all --concurrency=10
 
+# Interactive tenant selection
+npx drizzle-multitenant migrate  # Shows checkbox to select tenants
+
 # Check migration status
 npx drizzle-multitenant status
 
@@ -214,18 +229,114 @@ npx drizzle-multitenant tenant:create --id=new-tenant
 
 # Drop a tenant schema
 npx drizzle-multitenant tenant:drop --id=old-tenant --force
+
+# Convert migration table format
+npx drizzle-multitenant convert-format --to=name --dry-run
+
+# Generate shell completions
+npx drizzle-multitenant completion bash >> ~/.bashrc
+npx drizzle-multitenant completion zsh >> ~/.zshrc
+```
+
+### Global Options
+
+```bash
+--json       # Output as JSON (for scripts/CI)
+--verbose    # Show detailed output
+--quiet      # Only show errors
+--no-color   # Disable colored output
+```
+
+### JSON Output
+
+```bash
+# Get status as JSON for scripting
+npx drizzle-multitenant status --json | jq '.tenants[] | select(.pending > 0)'
+
+# Parse migration results
+npx drizzle-multitenant migrate --all --json | jq '.summary'
 ```
 
 ### Status Output
 
 ```
-┌─────────────────────┬─────────┬─────────┬──────────┐
-│ Tenant              │ Applied │ Pending │ Status   │
-├─────────────────────┼─────────┼─────────┼──────────┤
-│ tenant_abc123       │ 15      │ 0       │ OK       │
-│ tenant_def456       │ 15      │ 0       │ OK       │
-│ tenant_ghi789       │ 14      │ 1       │ Behind   │
-└─────────────────────┴─────────┴─────────┴──────────┘
+┌──────────────────┬──────────────┬────────────┬─────────┬─────────┬──────────┐
+│ Tenant           │ Schema       │ Format     │ Applied │ Pending │ Status   │
+├──────────────────┼──────────────┼────────────┼─────────┼─────────┼──────────┤
+│ abc-123          │ tenant_abc   │ drizzle-kit│ 45      │ 3       │ Behind   │
+│ def-456          │ tenant_def   │ name       │ 48      │ 0       │ OK       │
+│ ghi-789          │ tenant_ghi   │ (new)      │ 0       │ 48      │ Behind   │
+└──────────────────┴──────────────┴────────────┴─────────┴─────────┴──────────┘
+```
+
+## Migration Table Formats
+
+`drizzle-multitenant` supports multiple migration table formats for compatibility with existing databases:
+
+### Supported Formats
+
+| Format | Identifier | Timestamp | Compatible With |
+|--------|------------|-----------|-----------------|
+| `name` | Filename | `applied_at` (timestamp) | drizzle-multitenant native |
+| `hash` | SHA-256 | `created_at` (timestamp) | Custom scripts |
+| `drizzle-kit` | SHA-256 | `created_at` (bigint) | drizzle-kit migrate |
+
+### Configuration
+
+```typescript
+// tenant.config.ts
+export default defineConfig({
+  // ...
+  migrations: {
+    tenantFolder: './drizzle/tenant',
+    tenantDiscovery: async () => getTenantIds(),
+
+    /**
+     * Table format for tracking migrations
+     * - "auto": Auto-detect existing format (default)
+     * - "name": Filename-based (drizzle-multitenant native)
+     * - "hash": SHA-256 hash
+     * - "drizzle-kit": Exact drizzle-kit format
+     */
+    tableFormat: 'auto',
+
+    /**
+     * Format to use when creating new tables (only for "auto" mode)
+     * @default "name"
+     */
+    defaultFormat: 'name',
+  },
+});
+```
+
+### Migrating from drizzle-kit
+
+If you have existing databases with migrations applied via `drizzle-kit migrate`, the CLI will automatically detect the format:
+
+```bash
+# Check current format for all tenants
+npx drizzle-multitenant status
+
+# Apply new migrations (works with any format)
+npx drizzle-multitenant migrate --all
+```
+
+### Converting Between Formats
+
+Use the `convert-format` command to standardize all tenants to a single format:
+
+```bash
+# Preview conversion (dry-run)
+npx drizzle-multitenant convert-format --to=name --dry-run
+
+# Convert all tenants to name format
+npx drizzle-multitenant convert-format --to=name
+
+# Convert specific tenant
+npx drizzle-multitenant convert-format --to=name --tenant=abc-123
+
+# Convert to drizzle-kit format (for compatibility)
+npx drizzle-multitenant convert-format --to=drizzle-kit
 ```
 
 ## Cross-Schema Queries
@@ -310,6 +421,8 @@ const result = await query
 | `chalk` | Terminal styling |
 | `ora` | Loading spinners |
 | `cli-table3` | Table formatting |
+| `cli-progress` | Progress bars |
+| `@inquirer/prompts` | Interactive prompts |
 
 ## Comparison