rake-db 2.14.5 → 2.15.0

package/dist/index.d.ts

@@ -1,6 +1,6 @@
 import * as pqb from 'pqb';
-import { ColumnsShape, Db as Db$1, ColumnType, EnumColumn, raw, Adapter, DbResult, TransactionAdapter, QueryLogObject, IndexColumnOptions, IndexOptions, ForeignKeyOptions, TextColumn, TableData, NoPrimaryKeyOption, SingleColumnIndexOptions, DefaultColumnTypes, QueryLogOptions, AdapterOptions } from 'pqb';
-import { EmptyObject, RawSQLBase, ColumnSchemaConfig, MaybeArray, ColumnTypeBase } from 'orchid-core';
+import { ColumnsShape, Db as Db$1, ColumnType, EnumColumn, raw, Adapter, IndexColumnOptions, IndexOptions, ForeignKeyOptions, DbResult, TransactionAdapter, QueryLogObject, TextColumn, TableData, NoPrimaryKeyOption, SingleColumnIndexOptions, DefaultColumnTypes, QueryLogOptions, AdapterOptions } from 'pqb';
+import { EmptyObject, RawSQLBase, ColumnSchemaConfig, MaybeArray, ColumnTypeBase, RecordString } from 'orchid-core';
 
 interface CreateTableResult<Table extends string, Shape extends ColumnsShape> {
     table: Db$1<Table, Shape>;
@@ -68,6 +68,26 @@ type SilentQueries = {
     silentQuery: Adapter['query'];
     silentArrays: Adapter['arrays'];
 };
+interface RakeDbColumnTypes {
+    index(columns: MaybeArray<string | IndexColumnOptions>, options?: IndexOptions): EmptyObject;
+    foreignKey(columns: [string, ...string[]], foreignTable: string, foreignColumns: [string, ...string[]], options?: ForeignKeyOptions): EmptyObject;
+    primaryKey(columns: string[], options?: {
+        name?: string;
+    }): EmptyObject;
+    check(check: RawSQLBase): EmptyObject;
+    constraint(arg: ConstraintArg): EmptyObject;
+}
+interface ConstraintArg {
+    name?: string;
+    references?: [
+        columns: [string, ...string[]],
+        table: string,
+        foreignColumn: [string, ...string[]],
+        options: Omit<ForeignKeyOptions, 'name' | 'dropMode'>
+    ];
+    check?: RawSQLBase;
+    dropMode?: DropMode;
+}
 type DbMigration<CT extends RakeDbColumnTypes> = DbResult<CT> & Migration<CT> & {
     adapter: SilentQueries;
 };
@@ -936,48 +956,13 @@ declare namespace RakeDbAst {
     }
 }
 
-interface RakeDbColumnTypes {
-    index(columns: MaybeArray<string | IndexColumnOptions>, options?: IndexOptions): EmptyObject;
-    foreignKey(columns: [string, ...string[]], foreignTable: string, foreignColumns: [string, ...string[]], options?: ForeignKeyOptions): EmptyObject;
-    primaryKey(columns: string[], options?: {
-        name?: string;
-    }): EmptyObject;
-    check(check: RawSQLBase): EmptyObject;
-    constraint(arg: ConstraintArg): EmptyObject;
-}
-interface ConstraintArg {
-    name?: string;
-    references?: [
-        columns: [string, ...string[]],
-        table: string,
-        foreignColumn: [string, ...string[]],
-        options: Omit<ForeignKeyOptions, 'name' | 'dropMode'>
-    ];
-    check?: RawSQLBase;
-    dropMode?: DropMode;
-}
-type Db = DbResult<RakeDbColumnTypes>;
-interface BaseTable<CT> {
-    exportAs: string;
-    getFilePath(): string;
-    nowSQL?: string;
-    new (): {
-        types: CT;
-        snakeCase?: boolean;
-        language?: string;
-    };
-}
-type InputRakeDbConfig<SchemaConfig extends ColumnSchemaConfig, CT> = Partial<Omit<RakeDbConfig<SchemaConfig, CT>, 'columnTypes'>> & ({
-    columnTypes?: CT | ((t: DefaultColumnTypes<ColumnSchemaConfig>) => CT);
-} | {
-    baseTable?: BaseTable<CT>;
-});
 interface RakeDbConfig<SchemaConfig extends ColumnSchemaConfig, CT = DefaultColumnTypes<ColumnSchemaConfig>> extends QueryLogOptions {
     schemaConfig: SchemaConfig;
     columnTypes: CT;
     basePath: string;
     dbScript: string;
     migrationsPath: string;
+    migrationId: RakeDbMigrationId;
     migrations?: ModuleExportsRecord;
     recurrentPath: string;
     migrationsTable: string;
@@ -985,7 +970,7 @@ interface RakeDbConfig<SchemaConfig extends ColumnSchemaConfig, CT = DefaultColu
     language?: string;
     commands: Record<string, (options: AdapterOptions[], config: RakeDbConfig<SchemaConfig, CT>, args: string[]) => void | Promise<void>>;
     noPrimaryKey?: NoPrimaryKeyOption;
-    baseTable?: BaseTable<CT>;
+    baseTable?: RakeDbBaseTable<CT>;
     appCodeUpdater?: AppCodeUpdater;
     useCodeUpdater?: boolean;
     forceDefaultExports?: boolean;
@@ -995,9 +980,27 @@ interface RakeDbConfig<SchemaConfig extends ColumnSchemaConfig, CT = DefaultColu
     beforeRollback?(db: Db): Promise<void>;
     afterRollback?(db: Db): Promise<void>;
 }
+type InputRakeDbConfig<SchemaConfig extends ColumnSchemaConfig, CT> = Partial<Omit<RakeDbConfig<SchemaConfig, CT>, 'columnTypes'>> & ({
+    columnTypes?: CT | ((t: DefaultColumnTypes<ColumnSchemaConfig>) => CT);
+} | {
+    baseTable?: RakeDbBaseTable<CT>;
+});
+type AnyRakeDbConfig = RakeDbConfig<any, any>;
+type Db = DbResult<RakeDbColumnTypes>;
+interface RakeDbBaseTable<CT> {
+    exportAs: string;
+    getFilePath(): string;
+    nowSQL?: string;
+    new (): {
+        types: CT;
+        snakeCase?: boolean;
+        language?: string;
+    };
+}
 interface ModuleExportsRecord {
     [K: string]: () => Promise<unknown>;
 }
+type RakeDbMigrationId = 'serial' | 'timestamp';
 interface AppCodeUpdaterParams {
     options: AdapterOptions;
     basePath: string;
@@ -1015,6 +1018,28 @@ interface AppCodeUpdater {
     }): Promise<void>;
     afterAll(params: AppCodeUpdaterParams): Promise<void>;
 }
+declare const migrationConfigDefaults: {
+    schemaConfig: pqb.DefaultSchemaConfig;
+    migrationsPath: string;
+    migrationId: "serial";
+    migrationsTable: string;
+    snakeCase: false;
+    commands: {};
+    import: (path: string) => Promise<any>;
+    log: true;
+    logger: Console;
+    useCodeUpdater: true;
+};
+declare const processRakeDbConfig: <SchemaConfig extends ColumnSchemaConfig, CT>(config: InputRakeDbConfig<SchemaConfig, CT>) => RakeDbConfig<SchemaConfig, CT>;
+declare const getDatabaseAndUserFromOptions: (options: AdapterOptions) => {
+    database: string;
+    user: string;
+};
+
+declare const createDb: <SchemaConfig extends ColumnSchemaConfig, CT>(arg: MaybeArray<AdapterOptions>, config: RakeDbConfig<SchemaConfig, CT>) => Promise<void>;
+declare const dropDb: <SchemaConfig extends ColumnSchemaConfig, CT>(arg: MaybeArray<AdapterOptions>, config: RakeDbConfig<SchemaConfig, CT>) => Promise<void>;
+declare const resetDb: <SchemaConfig extends ColumnSchemaConfig, CT extends RakeDbColumnTypes>(arg: MaybeArray<AdapterOptions>, config: RakeDbConfig<SchemaConfig, CT>) => Promise<void>;
+
 interface MigrationItem {
     path: string;
     version: string;
@@ -1025,19 +1050,24 @@ interface MigrationItem {
      */
     load(): Promise<unknown>;
 }
+interface MigrationsSet {
+    renameTo?: RakeDbMigrationId;
+    migrations: MigrationItem[];
+}
 
-declare const createDb: <SchemaConfig extends ColumnSchemaConfig, CT>(arg: MaybeArray<AdapterOptions>, config: RakeDbConfig<SchemaConfig, CT>) => Promise<void>;
-declare const dropDb: <SchemaConfig extends ColumnSchemaConfig, CT>(arg: MaybeArray<AdapterOptions>, config: RakeDbConfig<SchemaConfig, CT>) => Promise<void>;
-declare const resetDb: <SchemaConfig extends ColumnSchemaConfig, CT extends RakeDbColumnTypes>(arg: MaybeArray<AdapterOptions>, config: RakeDbConfig<SchemaConfig, CT>) => Promise<void>;
+interface RakeDbCtx {
+    migrationsPromise?: Promise<MigrationsSet>;
+}
 
 declare const writeMigrationFile: <SchemaConfig extends ColumnSchemaConfig, CT>(config: RakeDbConfig<SchemaConfig, CT>, version: string, name: string, content: (importPath: string, name: string) => string) => Promise<void>;
-declare const generate: <SchemaConfig extends ColumnSchemaConfig, CT>(config: RakeDbConfig<SchemaConfig, CT>, [name]: string[]) => Promise<void>;
-declare const makeFileTimeStamp: () => string;
+declare const generate: (config: AnyRakeDbConfig, [name]: string[]) => Promise<void>;
+declare const makeFileVersion: (ctx: RakeDbCtx, config: AnyRakeDbConfig) => Promise<string>;
+declare const generateTimeStamp: () => string;
 
 type ChangeCallback<CT extends RakeDbColumnTypes> = (db: DbMigration<CT>, up: boolean) => Promise<void>;
 
 declare const RAKE_DB_LOCK_KEY = "8582141715823621641";
-type MigrateFn = <SchemaConfig extends ColumnSchemaConfig, CT extends RakeDbColumnTypes>(options: MaybeArray<AdapterOptions>, config: RakeDbConfig<SchemaConfig, CT>, args?: string[]) => Promise<void>;
+type MigrateFn = <SchemaConfig extends ColumnSchemaConfig, CT extends RakeDbColumnTypes>(ctx: RakeDbCtx, options: MaybeArray<AdapterOptions>, config: RakeDbConfig<SchemaConfig, CT>, args?: string[]) => Promise<void>;
 /**
  * Will run all pending yet migrations, sequentially in order,
  * will apply `change` functions top-to-bottom.
@@ -1060,7 +1090,7 @@ declare const rollback: MigrateFn;
  * Takes the same options as {@link migrate}.
  */
 declare const redo: MigrateFn;
-declare const migrateOrRollback: (trx: TransactionAdapter, config: RakeDbConfig<ColumnSchemaConfig, RakeDbColumnTypes>, files: MigrationItem[], count: number, asts: RakeDbAst[], up: boolean, skipLock?: boolean) => Promise<void>;
+declare const migrateOrRollback: (ctx: RakeDbCtx, trx: TransactionAdapter, config: RakeDbConfig<ColumnSchemaConfig, RakeDbColumnTypes>, set: MigrationsSet, count: number, asts: RakeDbAst[], up: boolean, skipLock?: boolean) => Promise<void>;
 declare const changeCache: Record<string, ChangeCallback<RakeDbColumnTypes>[] | undefined>;
 
 /**
@@ -1101,10 +1131,10 @@ type RakeDbChangeFn<CT extends RakeDbColumnTypes> = (fn: ChangeCallback<CT>) =>
  */
 declare const rakeDb: RakeDbFn;
 
-declare const saveMigratedVersion: <SchemaConfig extends ColumnSchemaConfig, CT>(db: SilentQueries, version: string, config: RakeDbConfig<SchemaConfig, CT>) => Promise<void>;
-declare const removeMigratedVersion: <SchemaConfig extends ColumnSchemaConfig, CT>(db: SilentQueries, version: string, config: RakeDbConfig<SchemaConfig, CT>) => Promise<void>;
+declare const saveMigratedVersion: <SchemaConfig extends ColumnSchemaConfig, CT>(db: SilentQueries, version: string, name: string, config: RakeDbConfig<SchemaConfig, CT>) => Promise<void>;
+declare const removeMigratedVersion: <SchemaConfig extends ColumnSchemaConfig, CT>(db: SilentQueries, version: string, name: string, config: RakeDbConfig<SchemaConfig, CT>) => Promise<void>;
 declare class NoMigrationsTableError extends Error {
 }
-declare const getMigratedVersionsMap: <SchemaConfig extends ColumnSchemaConfig, CT>(adapter: Adapter | TransactionAdapter, config: RakeDbConfig<SchemaConfig, CT>) => Promise<Record<string, boolean>>;
+declare const getMigratedVersionsMap: <SchemaConfig extends ColumnSchemaConfig, CT>(ctx: RakeDbCtx, adapter: Adapter | TransactionAdapter, config: RakeDbConfig<SchemaConfig, CT>) => Promise<RecordString>;
 
-export { AppCodeUpdater, AppCodeUpdaterParams, ChangeTableCallback, ChangeTableOptions, ColumnComment, ColumnsShapeCallback, DbMigration, DropMode, Migration, MigrationColumnTypes, NoMigrationsTableError, RAKE_DB_LOCK_KEY, RakeDbAst, RakeDbConfig, SilentQueries, TableOptions, changeCache, createDb, createMigrationInterface, dropDb, generate, getMigratedVersionsMap, makeFileTimeStamp, migrate, migrateOrRollback, rakeDb, redo, removeMigratedVersion, resetDb, rollback, saveMigratedVersion, writeMigrationFile };
+export { AnyRakeDbConfig, AppCodeUpdater, AppCodeUpdaterParams, ChangeTableCallback, ChangeTableOptions, ColumnComment, ColumnsShapeCallback, ConstraintArg, DbMigration, DropMode, InputRakeDbConfig, Migration, MigrationColumnTypes, ModuleExportsRecord, NoMigrationsTableError, RAKE_DB_LOCK_KEY, RakeDbAst, RakeDbBaseTable, RakeDbColumnTypes, RakeDbConfig, RakeDbMigrationId, SilentQueries, TableOptions, changeCache, createDb, createMigrationInterface, dropDb, generate, generateTimeStamp, getDatabaseAndUserFromOptions, getMigratedVersionsMap, makeFileVersion, migrate, migrateOrRollback, migrationConfigDefaults, processRakeDbConfig, rakeDb, redo, removeMigratedVersion, resetDb, rollback, saveMigratedVersion, writeMigrationFile };