refactor!: cleanup type definitions (#1351)

src/db.ts

@@ -1,6 +1,3 @@
-/*
- This file just manages the database connection and provides a query method
- */
 import { inspect } from 'node:util';
 import type {
   Client,
@@ -12,7 +9,31 @@ import type {
   QueryResult,
 } from 'pg';
 import pg from 'pg';
-import type { DB, Logger } from './types';
+import type { Logger } from './logger';
+
+// This file just manages the database connection and provides a query method
+
+// see ClientBase in @types/pg
+export interface DB {
+  /* eslint-disable @typescript-eslint/no-explicit-any */
+  query(
+    queryConfig: QueryArrayConfig,
+    values?: any[]
+  ): Promise<QueryArrayResult>;
+  query(queryConfig: QueryConfig): Promise<QueryResult>;
+  query(
+    queryTextOrConfig: string | QueryConfig,
+    values?: any[]
+  ): Promise<QueryResult>;
+
+  select(queryConfig: QueryArrayConfig, values?: any[]): Promise<any[]>;
+  select(queryConfig: QueryConfig): Promise<any[]>;
+  select(
+    queryTextOrConfig: string | QueryConfig,
+    values?: any[]
+  ): Promise<any[]>;
+  /* eslint-enable @typescript-eslint/no-explicit-any */
+}
 
 /* eslint-disable @typescript-eslint/no-explicit-any */
 export interface DBConnection extends DB {

src/index.ts

@@ -1,4 +1,5 @@
 export { Migration } from './migration';
+export type { default as MigrationBuilder } from './migrationBuilder';
 export type {
   CreateCast,
   CreateCastFn,
@@ -261,8 +262,8 @@ export type {
   RenameViewFn,
   ViewOptions,
 } from './operations/views';
+export { PgType } from './pgType';
 export { runner as default, runner } from './runner';
-export { PgType } from './types';
-export type { MigrationBuilder, RunnerOption } from './types';
+export type { RunnerOption } from './runner';
 export { PgLiteral, isPgLiteral } from './utils';
 export type { PgLiteralValue } from './utils';

src/logger.ts

@@ -0,0 +1,8 @@
+export type LogFn = (msg: string) => void;
+
+export type Logger = {
+  debug?: LogFn;
+  info: LogFn;
+  warn: LogFn;
+  error: LogFn;
+};

src/migration.ts

@@ -1,29 +1,29 @@
-/*
- A new Migration is instantiated for each migration file.
-
- It is responsible for storing the name of the file and knowing how to execute
- the up and down migrations defined in the file.
-
- */
-
 import { glob } from 'glob';
 import { createReadStream, createWriteStream } from 'node:fs';
 import { mkdir, readdir } from 'node:fs/promises';
 import { basename, extname, join, resolve } from 'node:path';
 import { cwd } from 'node:process';
 import type { QueryResult } from 'pg';
 import type { DBConnection } from './db';
+import type { Logger } from './logger';
 import MigrationBuilder from './migrationBuilder';
 import type { ColumnDefinitions } from './operations/tables';
-import type {
-  Logger,
-  MigrationAction,
-  MigrationBuilderActions,
-  MigrationDirection,
-  RunnerOption,
-} from './types';
+import type { MigrationDirection, RunnerOption } from './runner';
+import type { MigrationBuilderActions } from './sqlMigration';
 import { getMigrationTableSchema } from './utils';
 
+/*
+ * A new Migration is instantiated for each migration file.
+ *
+ * It is responsible for storing the name of the file and knowing how to execute
+ * the up and down migrations defined in the file.
+ */
+
+export type MigrationAction = (
+  pgm: MigrationBuilder,
+  run?: () => void
+) => Promise<void> | void;
+
 export interface RunMigration {
   readonly path: string;
   readonly name: string;