rake-db 2.25.12 → 2.25.13

package/dist/index.d.ts

@@ -1,7 +1,7 @@
 import * as orchid_core from 'orchid-core';
 import { MaybeArray, RawSQLBase, ColumnDataCheckBase, RecordString, ColumnTypeBase, EmptyObject, ColumnSchemaConfig, QueryLogObject, QueryLogOptions, MaybePromise, RecordOptionalString, ForeignKeyTable, SingleSql } from 'orchid-core';
 import * as pqb from 'pqb';
-import { TableData, ColumnsShape, NoPrimaryKeyOption, ColumnType, EnumColumn, raw, Adapter, DbResult, TransactionAdapter, TableDataFn, TableDataItem, DbDomainArg, Db as Db$1, QueryArraysResult, AdapterOptions, DefaultColumnTypes, DefaultSchemaConfig, SearchWeight, ColumnsByType, DbStructureDomainsMap } from 'pqb';
+import { TableData, ColumnsShape, NoPrimaryKeyOption, ColumnType, EnumColumn, raw, Adapter, DbResult, TransactionAdapter, TableDataFn, TableDataItem, DbDomainArg, Db, QueryArraysResult, AdapterOptions, DefaultColumnTypes, DefaultSchemaConfig, SearchWeight, ColumnsByType, DbStructureDomainsMap } from 'pqb';
 
 type RakeDbAst = RakeDbAst.Table | RakeDbAst.ChangeTable | RakeDbAst.RenameType | RakeDbAst.Schema | RakeDbAst.RenameSchema | RakeDbAst.Extension | RakeDbAst.Enum | RakeDbAst.EnumValues | RakeDbAst.RenameEnumValues | RakeDbAst.ChangeEnumValues | RakeDbAst.Domain | RakeDbAst.Collation | RakeDbAst.Constraint | RakeDbAst.RenameTableItem | RakeDbAst.View;
 declare namespace RakeDbAst {
@@ -1229,7 +1229,7 @@ interface TableQuery {
     then?(result: QueryArraysResult): void;
 }
 interface CreateTableResult<Table extends string, Shape extends ColumnsShape> {
-    table: Db$1<Table, Shape>;
+    table: Db<Table, Shape>;
 }
 
 interface RakeDbCtx {
@@ -1285,17 +1285,15 @@ interface MigrationsSet {
     migrations: MigrationItem[];
 }
 
-type CommandFn<SchemaConfig extends ColumnSchemaConfig, CT> = (options: AdapterOptions[], config: RakeDbConfig<SchemaConfig, CT>, args: string[]) => void | Promise<void>;
-interface RakeDbConfig<SchemaConfig extends ColumnSchemaConfig, CT = DefaultColumnTypes<DefaultSchemaConfig>> extends QueryLogOptions {
+interface CommandFn<SchemaConfig extends ColumnSchemaConfig, CT> {
+    (options: AdapterOptions[], config: RakeDbConfig<SchemaConfig, CT>, args: string[]): void | Promise<void>;
+}
+interface RakeDbBaseConfig<SchemaConfig extends ColumnSchemaConfig, CT = DefaultColumnTypes<DefaultSchemaConfig>> extends QueryLogOptions {
     schemaConfig: SchemaConfig;
-    columnTypes: CT;
-    basePath: string;
-    dbScript: string;
     migrationsPath: string;
     migrationId: RakeDbMigrationId;
     migrations?: ModuleExportsRecord;
     renameMigrations?: RakeDbRenameMigrationsInput;
-    recurrentPath: string;
     migrationsTable: string;
     snakeCase: boolean;
     language?: string;
@@ -1312,6 +1310,12 @@ interface RakeDbConfig<SchemaConfig extends ColumnSchemaConfig, CT = DefaultColu
     beforeRollback?: MigrationCallback;
     afterRollback?: MigrationCallback;
 }
+interface RakeDbConfig<SchemaConfig extends ColumnSchemaConfig, CT = DefaultColumnTypes<DefaultSchemaConfig>> extends RakeDbBaseConfig<SchemaConfig, CT> {
+    columnTypes: CT;
+    basePath: string;
+    dbScript: string;
+    recurrentPath: string;
+}
 interface InputRakeDbConfigBase<SchemaConfig extends ColumnSchemaConfig, CT> extends QueryLogOptions {
     columnTypes?: CT | ((t: DefaultColumnTypes<DefaultSchemaConfig>) => CT);
     baseTable?: RakeDbBaseTable<CT>;
@@ -1324,7 +1328,7 @@ interface InputRakeDbConfigBase<SchemaConfig extends ColumnSchemaConfig, CT> ext
     migrationsTable?: string;
     snakeCase?: boolean;
     language?: string;
-    commands?: Record<string, (options: AdapterOptions[], config: RakeDbConfig<SchemaConfig, CT extends undefined ? DefaultColumnTypes<DefaultSchemaConfig> : CT>, args: string[]) => void | Promise<void>>;
+    commands?: Record<string, (options: AdapterOptions[], config: RakeDbConfig<SchemaConfig, CT>, args: string[]) => void | Promise<void>>;
     noPrimaryKey?: NoPrimaryKeyOption;
     forceDefaultExports?: boolean;
     /**
@@ -1385,12 +1389,13 @@ interface InputRakeDbConfigBase<SchemaConfig extends ColumnSchemaConfig, CT> ext
      */
     afterRollback?: MigrationCallback;
 }
-type InputRakeDbConfig<SchemaConfig extends ColumnSchemaConfig, CT> = InputRakeDbConfigBase<SchemaConfig, CT> & ({
+interface InputRakeDbConfigFileBased<SchemaConfig extends ColumnSchemaConfig, CT> extends InputRakeDbConfigBase<SchemaConfig, CT> {
     /**
      * It may look odd, but it's required for `tsx` and other bundlers to have such `import` config specified explicitly.
      */
     import(path: string): Promise<unknown>;
-} | {
+}
+interface InputRakeDbConfigCodeBased<SchemaConfig extends ColumnSchemaConfig, CT> extends InputRakeDbConfigBase<SchemaConfig, CT> {
     /**
      * To specify array of migrations explicitly, without loading them from files.
      */
@@ -1400,24 +1405,30 @@ type InputRakeDbConfig<SchemaConfig extends ColumnSchemaConfig, CT> = InputRakeD
      * It may look odd, but it's required for `tsx` and other bundlers to have such `import` config specified explicitly.
      */
     import?(path: string): Promise<unknown>;
-});
-type ChangeCallback$1 = (arg: {
-    db: Db;
-    up: boolean;
-    redo: boolean;
-    migrations: MigrationItem[];
-}) => void | Promise<void>;
-type ChangeCommitCallback = (arg: {
-    options: AdapterOptions;
-    up: boolean;
-    migrations: MigrationItem[];
-}) => void | Promise<void>;
-type MigrationCallback = (arg: {
-    db: Db;
-    migrations: MigrationItem[];
-}) => void | Promise<void>;
+}
+type InputRakeDbConfig<SchemaConfig extends ColumnSchemaConfig, CT> = InputRakeDbConfigFileBased<SchemaConfig, CT> | InputRakeDbConfigCodeBased<SchemaConfig, CT>;
+interface ChangeCallback$1 {
+    (arg: {
+        db: DbResult<unknown>;
+        up: boolean;
+        redo: boolean;
+        migrations: MigrationItem[];
+    }): void | Promise<void>;
+}
+interface ChangeCommitCallback {
+    (arg: {
+        options: AdapterOptions;
+        up: boolean;
+        migrations: MigrationItem[];
+    }): void | Promise<void>;
+}
+interface MigrationCallback {
+    (arg: {
+        db: DbResult<unknown>;
+        migrations: MigrationItem[];
+    }): void | Promise<void>;
+}
 type AnyRakeDbConfig = RakeDbConfig<any, any>;
-type Db = DbResult<unknown>;
 interface RakeDbBaseTable<CT> {
     exportAs: string;
     getFilePath(): string;
@@ -1445,19 +1456,7 @@ interface RakeDbRenameMigrationsInput {
     to: RakeDbMigrationId;
     map: RakeDbRenameMigrationsMap;
 }
-declare const migrationConfigDefaults: {
-    schemaConfig: DefaultSchemaConfig;
-    migrationsPath: string;
-    migrationId: {
-        serial: number;
-    };
-    migrationsTable: string;
-    snakeCase: false;
-    commands: {};
-    log: true;
-    logger: Console;
-    import(): never;
-};
+declare const migrationConfigDefaults: RakeDbBaseConfig<ColumnSchemaConfig>;
 declare const processRakeDbConfig: <SchemaConfig extends ColumnSchemaConfig<orchid_core.ColumnTypeBase<orchid_core.ColumnTypeSchemaArg, unknown, any, any, unknown, unknown, any, unknown, any, orchid_core.ColumnDataBase>>, CT>(config: InputRakeDbConfig<SchemaConfig, CT>) => RakeDbConfig<SchemaConfig, CT>;
 declare const getDatabaseAndUserFromOptions: (options: AdapterOptions) => {
     database: string;
@@ -1765,7 +1764,8 @@ declare const cmpRawSql: (a: RawSQLBase, b: RawSQLBase) => boolean;
 /**
  * Type of {@link rakeDb} function
  */
-type RakeDbFn = (<SchemaConfig extends ColumnSchemaConfig, CT = undefined>(options: MaybeArray<AdapterOptions>, partialConfig: InputRakeDbConfig<SchemaConfig, CT>, args?: string[]) => RakeDbFnReturns<CT>) & {
+interface RakeDbFn {
+    <SchemaConfig extends ColumnSchemaConfig, CT = DefaultColumnTypes<DefaultSchemaConfig>>(options: MaybeArray<AdapterOptions>, partialConfig: InputRakeDbConfig<SchemaConfig, CT>, args?: string[]): RakeDbChangeFnWithPromise<CT>;
     /**
      * Unlike the original `rakeDb` that executes immediately,
      * `rakeDb.lazy` returns the `run` function to be later called programmatically.
@@ -1774,29 +1774,27 @@ type RakeDbFn = (<SchemaConfig extends ColumnSchemaConfig, CT = undefined>(optio
      * @param config - {@link RakeDbConfig}
      * @returns `change` is to be used in migrations, `run` takes an array cli args to execute a command
      */
-    lazy: RakeDbLazyFn;
-};
-type RakeDbFnReturns<CT> = RakeDbChangeFn<CT extends undefined ? DefaultColumnTypes<DefaultSchemaConfig> : CT> & {
-    promise: Promise<RakeDbResult>;
-};
+    lazy<SchemaConfig extends ColumnSchemaConfig, CT = DefaultColumnTypes<DefaultSchemaConfig>>(options: MaybeArray<AdapterOptions>, config: InputRakeDbConfig<SchemaConfig, CT>): {
+        change: RakeDbChangeFn<CT>;
+        run(args: string[], config?: Partial<RakeDbConfig<SchemaConfig, CT>>): Promise<RakeDbResult>;
+    };
+}
 interface RakeDbResult {
     options: AdapterOptions[];
     config: AnyRakeDbConfig;
     args: string[];
 }
-/**
- * Type of {@link rakeDb.lazy} function
- */
-type RakeDbLazyFn = <SchemaConfig extends ColumnSchemaConfig, CT>(options: MaybeArray<AdapterOptions>, partialConfig: InputRakeDbConfig<SchemaConfig, CT>) => {
-    change: RakeDbChangeFn<CT>;
-    run(args: string[], config?: Partial<RakeDbConfig<SchemaConfig, CT>>): Promise<RakeDbResult>;
-};
 /**
  * Function to use in migrations to wrap database changes
  * Saves the given callback to an internal queue,
  * and also returns the callback in case you want to export it from migration.
  */
-type RakeDbChangeFn<CT> = (fn: ChangeCallback<CT>) => ChangeCallback<CT>;
+interface RakeDbChangeFn<CT> {
+    (fn: ChangeCallback<CT>): ChangeCallback<CT>;
+}
+interface RakeDbChangeFnWithPromise<CT> extends RakeDbChangeFn<CT> {
+    promise: Promise<RakeDbResult>;
+}
 /**
  * Function to configure and run `rakeDb`.
  *
@@ -1846,4 +1844,4 @@ declare const promptText: ({ message, default: def, password, min, }: {
     min?: number;
 }) => Promise<string>;
 
-export { type AnyRakeDbConfig, type ChangeCallback, type ChangeTableCallback, type ChangeTableOptions, type ColumnChecks, type ColumnComment, type ColumnNamedCheck, type ColumnsShapeCallback, type CommandFn, type DbMigration, DbStructure, type DropMode, type GetIndexOrExcludeName, type InputRakeDbConfig, type InputRakeDbConfigBase, type IntrospectedStructure, Migration, type MigrationAdapter, type MigrationColumnTypes, type ModuleExportsRecord, NoMigrationsTableError, RAKE_DB_LOCK_KEY, type RakeDbAppliedVersions, RakeDbAst, type RakeDbBaseTable, type RakeDbChangeFn, type RakeDbConfig, type RakeDbCtx, type RakeDbFn, type RakeDbFnReturns, type RakeDbLazyFn, type RakeDbMigrationId, type RakeDbRenameMigrations, type RakeDbRenameMigrationsInput, type RakeDbRenameMigrationsMap, type RakeDbResult, type SilentQueries, type StructureToAstCtx, type StructureToAstTableData, type TableOptions, addColumnComment, addColumnExclude, addColumnIndex, addOrDropEnumValues, astToMigration, changeCache, changeEnumValues, clearChanges, cmpRawSql, colors, columnToSql, columnTypeToSql, commentsToQuery, concatSchemaAndName, constraintToSql, createDb, createMigrationInterface, dbColumnToAst, deleteMigratedVersion, dropDb, encodeColumnDefault, excludesToQuery, exhaustive, generateTimeStamp, getColumnName, getConstraintName, getCurrentChanges, getDatabaseAndUserFromOptions, getDbStructureTableData, getDbTableColumnsChecks, getExcludeName, getFirstWordAndRest, getForeignKeyTable, getIndexName, getMigratedVersionsMap, getSchemaAndTableFromName, getTextAfterFrom, getTextAfterTo, identityToSql, indexesToQuery, instantiateDbColumn, interpolateSqlValues, introspectDbSchema, joinColumns, joinWords, makeDbStructureColumnsShape, makeDomainsMap, makeFileVersion, makePopulateEnumQuery, makeStructureToAstCtx, migrate, migrateOrRollback, migrationConfigDefaults, nameColumnChecks, newMigration, pluralize, primaryKeyToSql, processRakeDbConfig, promptConfirm, promptSelect, promptText, pushChange, queryLock, quoteCustomType, quoteNameFromString, quoteSchemaTable, quoteTable, quoteWithSchema, rakeDb, rakeDbAliases, rakeDbCommands, redo, referencesToSql, renameType, resetDb, rollback, saveMigratedVersion, structureToAst, tableToAst, transaction, versionToString, writeMigrationFile };
+export { type AnyRakeDbConfig, type ChangeCallback, type ChangeTableCallback, type ChangeTableOptions, type ColumnChecks, type ColumnComment, type ColumnNamedCheck, type ColumnsShapeCallback, type CommandFn, type DbMigration, DbStructure, type DropMode, type GetIndexOrExcludeName, type InputRakeDbConfig, type InputRakeDbConfigBase, type IntrospectedStructure, Migration, type MigrationAdapter, type MigrationColumnTypes, type ModuleExportsRecord, NoMigrationsTableError, RAKE_DB_LOCK_KEY, type RakeDbAppliedVersions, RakeDbAst, type RakeDbBaseTable, type RakeDbConfig, type RakeDbCtx, type RakeDbFn, type RakeDbMigrationId, type RakeDbRenameMigrations, type RakeDbRenameMigrationsInput, type RakeDbRenameMigrationsMap, type RakeDbResult, type SilentQueries, type StructureToAstCtx, type StructureToAstTableData, type TableOptions, addColumnComment, addColumnExclude, addColumnIndex, addOrDropEnumValues, astToMigration, changeCache, changeEnumValues, clearChanges, cmpRawSql, colors, columnToSql, columnTypeToSql, commentsToQuery, concatSchemaAndName, constraintToSql, createDb, createMigrationInterface, dbColumnToAst, deleteMigratedVersion, dropDb, encodeColumnDefault, excludesToQuery, exhaustive, generateTimeStamp, getColumnName, getConstraintName, getCurrentChanges, getDatabaseAndUserFromOptions, getDbStructureTableData, getDbTableColumnsChecks, getExcludeName, getFirstWordAndRest, getForeignKeyTable, getIndexName, getMigratedVersionsMap, getSchemaAndTableFromName, getTextAfterFrom, getTextAfterTo, identityToSql, indexesToQuery, instantiateDbColumn, interpolateSqlValues, introspectDbSchema, joinColumns, joinWords, makeDbStructureColumnsShape, makeDomainsMap, makeFileVersion, makePopulateEnumQuery, makeStructureToAstCtx, migrate, migrateOrRollback, migrationConfigDefaults, nameColumnChecks, newMigration, pluralize, primaryKeyToSql, processRakeDbConfig, promptConfirm, promptSelect, promptText, pushChange, queryLock, quoteCustomType, quoteNameFromString, quoteSchemaTable, quoteTable, quoteWithSchema, rakeDb, rakeDbAliases, rakeDbCommands, redo, referencesToSql, renameType, resetDb, rollback, saveMigratedVersion, structureToAst, tableToAst, transaction, versionToString, writeMigrationFile };