drizzle-multitenant 1.2.0 → 1.3.1

package/dist/migrator/index.d.ts

@@ -1,8 +1,8 @@
-import { m as DetectedFormat, S as SeedFunction, k as TenantSeedResult, j as SeedOptions, l as SeedResults, n as SyncStatus, b as MigrationFile, o as TenantSyncStatus, p as TenantSyncResult, q as SyncOptions, r as SyncResults, d as MigrateOptions, e as MigrationResults, g as MigrationHooks, h as MigrationProgressCallback, i as MigrationErrorHandler, T as TenantMigrationResult, f as TenantMigrationStatus, s as ClonerConfig, t as ClonerDependencies, u as CloneTenantOptions, v as CloneTenantResult } from '../migrator-BDgFzSh8.js';
-export { V as AnonymizeOptions, W as AnonymizeRules, X as AnonymizeValue, A as AppliedMigration, R as CloneProgressCallback, U as CloneProgressStatus, J as ColumnDrift, E as ColumnInfo, L as ConstraintDrift, F as ConstraintInfo, C as CreateTenantOptions, y as DEFAULT_FORMAT, z as DRIZZLE_KIT_FORMAT, D as DropTenantOptions, K as IndexDrift, I as IndexInfo, M as Migrator, a as MigratorConfig, Q as SchemaDriftOptions, P as SchemaDriftStatus, N as TableDrift, B as TableFormat, G as TableSchema, H as TenantSchema, O as TenantSchemaDrift, c as createMigrator, w as detectTableFormat, x as getFormatConfig } from '../migrator-BDgFzSh8.js';
+import { o as DetectedFormat, S as SeedFunction, k as TenantSeedResult, j as SeedOptions, l as SeedResults, p as SyncStatus, b as MigrationFile, q as TenantSyncStatus, r as TenantSyncResult, s as SyncOptions, t as SyncResults, d as MigrateOptions, e as MigrationResults, g as MigrationHooks, h as MigrationProgressCallback, i as MigrationErrorHandler, T as TenantMigrationResult, f as TenantMigrationStatus, u as ClonerConfig, v as ClonerDependencies, w as CloneTenantOptions, x as CloneTenantResult, y as SharedMigrateOptions, z as SharedMigrationResult, B as SharedMigrationStatus } from '../migrator-C7FtsZ0H.js';
+export { _ as AnonymizeOptions, $ as AnonymizeRules, a0 as AnonymizeValue, A as AppliedMigration, Y as CloneProgressCallback, Z as CloneProgressStatus, P as ColumnDrift, J as ColumnInfo, R as ConstraintDrift, L as ConstraintInfo, C as CreateTenantOptions, G as DEFAULT_FORMAT, H as DRIZZLE_KIT_FORMAT, D as DropTenantOptions, Q as IndexDrift, K as IndexInfo, M as Migrator, a as MigratorConfig, X as SchemaDriftOptions, W as SchemaDriftStatus, a2 as SharedMigrationHooks, a1 as SharedMigratorConfig, m as SharedSeedFunction, n as SharedSeedResult, U as TableDrift, I as TableFormat, N as TableSchema, O as TenantSchema, V as TenantSchemaDrift, c as createMigrator, E as detectTableFormat, F as getFormatConfig } from '../migrator-C7FtsZ0H.js';
 import * as pg from 'pg';
 import { Pool } from 'pg';
-import { C as Config } from '../types-BhK96FPC.js';
+import { C as Config } from '../types-CGqsPe2Q.js';
 import 'drizzle-orm/postgres-js';
 import 'drizzle-orm/node-postgres';
 
@@ -1106,4 +1106,116 @@ declare class Cloner {
  */
 declare function createCloner(config: ClonerConfig, dependencies: ClonerDependencies): Cloner;
 
-export { BatchExecutor, type BatchExecutorConfig, type BatchMigrateOptions, CloneTenantOptions, CloneTenantResult, Cloner, ClonerConfig, ClonerDependencies, type CreateSchemaOptions, DetectedFormat, type DropSchemaOptions, MigrateOptions, type MigrateTenantOptions, MigrationErrorHandler, MigrationExecutor, type MigrationExecutorConfig, type MigrationExecutorDependencies, MigrationFile, MigrationHooks, MigrationProgressCallback, MigrationResults, SchemaManager, SeedFunction, SeedOptions, SeedResults, Seeder, type SeederConfig, type SeederDependencies, SyncManager, type SyncManagerConfig, type SyncManagerDependencies, SyncOptions, SyncResults, SyncStatus, TenantMigrationResult, TenantMigrationStatus, TenantSeedResult, TenantSyncResult, TenantSyncStatus, createBatchExecutor, createCloner, createMigrationExecutor, createSchemaManager, createSeeder, createSyncManager };
+/**
+ * Configuration for SharedMigrationExecutor
+ */
+interface SharedMigrationExecutorConfig {
+    /** Schema name for shared tables (default: 'public') */
+    schemaName?: string;
+    /** Table name for tracking migrations */
+    migrationsTable: string;
+    /** Hooks for migration events */
+    hooks?: {
+        beforeMigration?: () => void | Promise<void>;
+        afterMigration?: (migrationName: string, durationMs: number) => void | Promise<void>;
+    };
+}
+/**
+ * Dependencies for SharedMigrationExecutor
+ */
+interface SharedMigrationExecutorDependencies {
+    /** Create a database pool for the shared schema */
+    createPool: () => Promise<Pool>;
+    /** Check if migrations table exists */
+    migrationsTableExists: (pool: Pool, schemaName: string) => Promise<boolean>;
+    /** Ensure migrations table exists with correct format */
+    ensureMigrationsTable: (pool: Pool, schemaName: string, format: DetectedFormat) => Promise<void>;
+    /** Get or detect migration table format */
+    getOrDetectFormat: (pool: Pool, schemaName: string) => Promise<DetectedFormat>;
+    /** Load migrations from disk */
+    loadMigrations: () => Promise<MigrationFile[]>;
+}
+
+/**
+ * Executor for shared schema migrations
+ *
+ * Handles migrations for the shared/public schema, separate from tenant schemas.
+ * Used for tables that are shared across all tenants (e.g., plans, roles, permissions).
+ *
+ * @example
+ * ```typescript
+ * const executor = new SharedMigrationExecutor(config, dependencies);
+ *
+ * // Get status
+ * const status = await executor.getStatus();
+ * console.log(`Pending: ${status.pendingCount}`);
+ *
+ * // Apply migrations
+ * const result = await executor.migrate();
+ * console.log(`Applied: ${result.appliedMigrations.length}`);
+ * ```
+ */
+declare class SharedMigrationExecutor {
+    private readonly config;
+    private readonly deps;
+    private readonly schemaName;
+    constructor(config: SharedMigrationExecutorConfig, deps: SharedMigrationExecutorDependencies);
+    /**
+     * Apply pending migrations to the shared schema
+     *
+     * @param options - Migration options (dryRun, onProgress)
+     * @returns Migration result with applied migrations
+     *
+     * @example
+     * ```typescript
+     * const result = await executor.migrate({
+     *   dryRun: false,
+     *   onProgress: (status, name) => console.log(`${status}: ${name}`),
+     * });
+     *
+     * if (result.success) {
+     *   console.log(`Applied ${result.appliedMigrations.length} migrations`);
+     * }
+     * ```
+     */
+    migrate(options?: SharedMigrateOptions): Promise<SharedMigrationResult>;
+    /**
+     * Mark migrations as applied without executing SQL
+     *
+     * Useful for syncing tracking state with already-applied migrations.
+     *
+     * @param options - Options with progress callback
+     * @returns Result with list of marked migrations
+     */
+    markAsApplied(options?: {
+        onProgress?: SharedMigrateOptions['onProgress'];
+    }): Promise<SharedMigrationResult>;
+    /**
+     * Get migration status for the shared schema
+     *
+     * @returns Status with applied/pending counts
+     */
+    getStatus(): Promise<SharedMigrationStatus>;
+    /**
+     * Get list of applied migrations
+     */
+    private getAppliedMigrations;
+    /**
+     * Check if a migration has been applied
+     */
+    private isMigrationApplied;
+    /**
+     * Apply a migration (execute SQL + record)
+     */
+    private applyMigration;
+    /**
+     * Record a migration as applied without executing SQL
+     */
+    private recordMigration;
+}
+/**
+ * Factory function to create a SharedMigrationExecutor
+ */
+declare function createSharedMigrationExecutor(config: SharedMigrationExecutorConfig, dependencies: SharedMigrationExecutorDependencies): SharedMigrationExecutor;
+
+export { BatchExecutor, type BatchExecutorConfig, type BatchMigrateOptions, CloneTenantOptions, CloneTenantResult, Cloner, ClonerConfig, ClonerDependencies, type CreateSchemaOptions, DetectedFormat, type DropSchemaOptions, MigrateOptions, type MigrateTenantOptions, MigrationErrorHandler, MigrationExecutor, type MigrationExecutorConfig, type MigrationExecutorDependencies, MigrationFile, MigrationHooks, MigrationProgressCallback, MigrationResults, SchemaManager, SeedFunction, SeedOptions, SeedResults, Seeder, type SeederConfig, type SeederDependencies, SharedMigrateOptions, SharedMigrationExecutor, type SharedMigrationExecutorConfig, type SharedMigrationExecutorDependencies, SharedMigrationResult, SharedMigrationStatus, SyncManager, type SyncManagerConfig, type SyncManagerDependencies, SyncOptions, SyncResults, SyncStatus, TenantMigrationResult, TenantMigrationStatus, TenantSeedResult, TenantSyncResult, TenantSyncStatus, createBatchExecutor, createCloner, createMigrationExecutor, createSchemaManager, createSeeder, createSharedMigrationExecutor, createSyncManager };