durcno 1.0.0-alpha.2 → 1.0.0-alpha.3

package/dist/bin.cjs

@@ -8903,19 +8903,17 @@ function resolveConfigPath(argPath) {
   }
   return (0, import_node_path2.resolve)(process.cwd(), DURCNO_CONFIG_NAME);
 }
-async function getSetup(argPath) {
-  const absPath = resolveConfigPath(argPath);
+async function loadConfig(absPath) {
   const mod = await import(absPath);
-  const { default: setup } = mod;
-  return setup;
+  return mod.default;
 }
 
 // src/cli/commands/down.ts
 var { bgGreen, dim, cyan: cyan2, yellow: yellow2, red: red2 } = source_default;
 async function down(m, options) {
   const configPath = resolveConfigPath(options.config);
-  const { connector, config: config2 } = await getSetup(configPath);
-  config2.pool = { ...config2.pool, max: 1 };
+  const config2 = await loadConfig(configPath);
+  const { connector } = config2;
   const migrationsDir = (0, import_node_path3.resolve)(
     (0, import_node_path3.dirname)(configPath),
     config2.out || DEFAULT_MIGRATIONS_DIR
@@ -8925,7 +8923,7 @@ async function down(m, options) {
   const client = connector.getClient();
   await client.connect();
   if (await migrationsTableExists(client)) {
-    const db = (0, import_durcno2.database)({ Migrations: import_durcno2.Migrations }, { connector, config: config2 });
+    const db = (0, import_durcno2.database)({ Migrations: import_durcno2.Migrations }, config2);
     const migrations = await db.from(import_durcno2.Migrations).select();
     const migrationDirsReversed = migrationDirNames.sort().reverse();
     for (let i = 0; i < migrationDirsReversed.length; i++) {
@@ -8939,7 +8937,7 @@ async function down(m, options) {
           migrationDirName,
           isFirstMigration,
           migrationsDir,
-          { connector, config: config2 },
+          config2,
           client
         );
         if (migration.name === m) {
@@ -8954,7 +8952,7 @@ async function down(m, options) {
   await client.close();
   process.exit(0);
 }
-async function runDownMigration(migrationDirName, isFirstMigration, migrationsDirPath, setup, client) {
+async function runDownMigration(migrationDirName, isFirstMigration, migrationsDirPath, config2, client) {
   const migrationName = (0, import_node_path3.basename)(migrationDirName);
   const downPath = (0, import_node_path3.join)(migrationsDirPath, migrationName, "down.ts");
   try {
@@ -8987,7 +8985,9 @@ async function runDownMigration(migrationDirName, isFirstMigration, migrationsDi
       throw e;
     }
     if (!isFirstMigration) {
-      const db = (0, import_durcno2.database)({ Migrations: import_durcno2.Migrations }, setup);
+      config2.connector.pool = { ...config2.connector.pool, max: 1 };
+      config2.connector.logger = void 0;
+      const db = (0, import_durcno2.database)({ Migrations: import_durcno2.Migrations }, config2);
       await db.delete(import_durcno2.Migrations).where((0, import_durcno2.eq)(import_durcno2.Migrations.name, migrationName));
       await db.close();
     }
@@ -12234,7 +12234,7 @@ async function promptColumnRenames(prev, curr, renamedTables) {
 }
 async function generate(options) {
   const configPath = resolveConfigPath(options.config);
-  const { config: config2 } = await getSetup(configPath);
+  const config2 = await loadConfig(configPath);
   const migrationsDir = (0, import_node_path4.resolve)(
     (0, import_node_path4.dirname)(configPath),
     config2.out || DEFAULT_MIGRATIONS_DIR
@@ -12803,12 +12803,14 @@ function generateConfigFile(config2) {
   return `${envLoader}import { defineConfig } from "durcno";
 import { ${funcName} } from "durcno/connectors/${connector}";
 
-export default defineConfig(${funcName}(), {
+export default defineConfig({
   schema: "${schemaPath}",
   out: "${migrationsDir}",
-  dbCredentials: {
-    url: ${urlValue},
-  },
+  connector: ${funcName}({
+    dbCredentials: {
+      url: ${urlValue},
+    },
+  }),
 });
 `;
 }
@@ -12830,9 +12832,9 @@ function generateIndexFile(schemaPath) {
   const schemaImport = schemaPath.replace(/^db\//, "./");
   return `import { database } from "durcno";
 import * as schema from "${schemaImport}";
-import setup from "../durcno.config.ts";
+import config from "../durcno.config.ts";
 
-export const db = database(schema, setup);
+export const db = database(schema, config);
 `;
 }
 async function promptConfig() {
@@ -13001,8 +13003,8 @@ var import_durcno3 = require("durcno");
 var { bgGreen: bgGreen3, bgYellow, dim: dim3, gray: gray4, yellow: yellow5, green: green2, cyan: cyan5 } = source_default;
 async function migrate(options) {
   const configPath = resolveConfigPath(options.config);
-  const { connector, config: config2 } = await getSetup(configPath);
-  config2.pool = { ...config2.pool, max: 1 };
+  const config2 = await loadConfig(configPath);
+  const { connector } = config2;
   const migrationsDir = (0, import_node_path6.resolve)(
     (0, import_node_path6.dirname)(configPath),
     config2.out || DEFAULT_MIGRATIONS_DIR
@@ -13015,16 +13017,13 @@ async function migrate(options) {
   try {
     let previouslyApplied = [];
     if (await migrationsTableExists(client)) {
-      const db = (0, import_durcno3.database)({ Migrations: import_durcno3.Migrations }, { connector, config: config2 });
+      const db = (0, import_durcno3.database)({ Migrations: import_durcno3.Migrations }, config2);
       const records = await db.from(import_durcno3.Migrations).select();
       previouslyApplied = records.map((r) => r.name);
     }
     for (const migrationDirName of migrationDirNames.sort()) {
       if (!previouslyApplied.includes(migrationDirName)) {
-        await runUpMigration(migrationDirName, migrationsDir, client, {
-          connector,
-          config: config2
-        });
+        await runUpMigration(migrationDirName, migrationsDir, client, config2);
         appliedMigrations.push(migrationDirName);
       }
     }
@@ -13040,7 +13039,7 @@ async function migrate(options) {
           migrationFolder,
           isFirstMigration,
           migrationsDir,
-          { connector, config: config2 },
+          config2,
           client
         );
       }
@@ -13054,7 +13053,7 @@ async function migrate(options) {
   await client.close();
   process.exit(0);
 }
-async function runUpMigration(migrationDirName, migrationsDir, client, setup) {
+async function runUpMigration(migrationDirName, migrationsDir, client, config2) {
   const upPath = (0, import_node_path6.join)(migrationsDir, migrationDirName, "up.ts");
   const migrationModule = await import(upPath);
   const statements = migrationModule.statements;
@@ -13081,7 +13080,9 @@ async function runUpMigration(migrationDirName, migrationsDir, client, setup) {
     console.log(
       bgGreen3.white.bold("[APPLIED]") + " " + green2(`Migration ${cyan5(migrationDirName)}`) + dim3(".")
     );
-    const db = (0, import_durcno3.database)({ Migrations: import_durcno3.Migrations }, setup);
+    config2.connector.pool = { ...config2.connector.pool, max: 1 };
+    config2.connector.logger = void 0;
+    const db = (0, import_durcno3.database)({ Migrations: import_durcno3.Migrations }, config2);
     await db.insert(import_durcno3.Migrations).values({
       name: migrationDirName,
       createdAt: /* @__PURE__ */ new Date()
@@ -13106,7 +13107,7 @@ var import_node_readline = require("node:readline");
 var { cyan: cyan6, green: green3, red: red4, yellow: yellow6, gray: gray5, bgCyan, bold: bold2 } = source_default;
 async function shell(options) {
   const configPath = resolveConfigPath(options.config);
-  const { connector } = await getSetup(configPath);
+  const { connector } = await loadConfig(configPath);
   const client = connector.getClient();
   console.log(gray5("Connecting to database..."));
   await client.connect();
@@ -13352,7 +13353,7 @@ var import_migration3 = require("durcno/migration");
 var { bgGreen: bgGreen4, bgRed: bgRed2, yellow: yellow7, red: red5, green: green4, cyan: cyan7, gray: gray6 } = source_default;
 async function squash(start, end, options) {
   const configPath = resolveConfigPath(options.config);
-  const { config: config2 } = await getSetup(configPath);
+  const config2 = await loadConfig(configPath);
   const migrationsDir = (0, import_node_path7.resolve)(
     (0, import_node_path7.dirname)(configPath),
     config2.out || DEFAULT_MIGRATIONS_DIR
@@ -13459,8 +13460,8 @@ var import_durcno4 = require("durcno");
 var { dim: dim4, cyan: cyan8, yellow: yellow8, green: green5 } = source_default;
 async function status(options) {
   const configPath = resolveConfigPath(options.config);
-  const { connector, config: config2 } = await getSetup(configPath);
-  config2.pool = { ...config2.pool, max: 1 };
+  const config2 = await loadConfig(configPath);
+  const { connector } = config2;
   const migrationsDir = (0, import_node_path8.resolve)(
     (0, import_node_path8.dirname)(configPath),
     config2.out || DEFAULT_MIGRATIONS_DIR
@@ -13471,7 +13472,7 @@ async function status(options) {
     console.log(source_default.yellow("No migrations found."));
     process.exit(0);
   }
-  const db = (0, import_durcno4.database)({ Migrations: import_durcno4.Migrations }, { connector, config: config2 });
+  const db = (0, import_durcno4.database)({ Migrations: import_durcno4.Migrations }, config2);
   const migrationsQuery = db.from(import_durcno4.Migrations).select();
   let migrations;
   const client = connector.getClient();
@@ -13504,7 +13505,7 @@ async function status(options) {
 }
 
 // src/cli/index.ts
-program.version("1.0.0-alpha.1");
+program.version("1.0.0-alpha.2");
 var Options = {
   config: ["--config <path>", "Path to the config file"]
 };

package/dist/src/columns/common.d.mts

@@ -1,7 +1,7 @@
 import { Sql } from "../sql.mjs";
 import { entityType } from "../symbols.mjs";
-import { Arg } from "../query-builders/pre.mjs";
 import { StdTableColumn, TableColumn } from "../table.mjs";
+import { Arg } from "../query-builders/pre.mjs";
 import * as z from "zod";
 
 //#region src/columns/common.d.ts

package/dist/src/connectors/bun.d.mts

@@ -1,4 +1,4 @@
-import { Connector } from "./common.mjs";
+import { Connector, ConnectorOptions } from "./common.mjs";
 
 //#region src/connectors/bun.d.ts
 /**
@@ -15,6 +15,6 @@ declare class BunConnector extends Connector {
   getPool(): BunPool;
 }
 /** Creates a Bun SQL connector instance. */
-declare function bun(): BunConnector;
+declare function bun(options: ConnectorOptions): BunConnector;
 //#endregion
 export { BunConnector, bun };

package/dist/src/connectors/bun.mjs

@@ -1,5 +1,5 @@
-import { $Client, $Pool, Connector } from "./common.mjs";
-import { SQL } from "bun";
+import { $Client, $Pool, Connector, getUrlFromDbCredentials } from "./common.mjs";
+import Bun from "bun";
 //#region src/connectors/bun.ts
 /**
 * Connector implementation for the Bun built-in SQL client.
@@ -12,15 +12,15 @@ import { SQL } from "bun";
 */
 var BunConnector = class extends Connector {
 	getClient() {
-		return new BunClient(this.url);
+		return new BunClient(this.options);
 	}
 	getPool() {
-		return new BunPool(this.url, this.config.pool);
+		return new BunPool(this.options);
 	}
 };
 /** Creates a Bun SQL connector instance. */
-function bun() {
-	return new BunConnector();
+function bun(options) {
+	return new BunConnector(options);
 }
 /**
 * Single-connection client wrapper for Bun's SQL API.
@@ -32,9 +32,9 @@ function bun() {
 */
 var BunClient = class extends $Client {
 	#client;
-	constructor(connectionString) {
-		super();
-		this.#client = new SQL(connectionString, { max: 1 });
+	constructor(options) {
+		super(options);
+		this.#client = new Bun.SQL(getUrlFromDbCredentials(options.dbCredentials), { max: 1 });
 		this.query = this.#client.unsafe.bind(this.#client);
 	}
 	async connect() {
@@ -57,9 +57,9 @@ var BunClient = class extends $Client {
 */
 var BunPool = class extends $Pool {
 	#pool;
-	constructor(connectionString, pool) {
-		super();
-		this.#pool = new SQL(connectionString, { max: pool?.max ?? 10 });
+	constructor(options) {
+		super(options);
+		this.#pool = new Bun.SQL(getUrlFromDbCredentials(options.dbCredentials), { max: options.pool?.max ?? 10 });
 		this.query = this.#pool.unsafe.bind(this.#pool);
 	}
 	async connect() {
@@ -72,7 +72,7 @@ var BunPool = class extends $Pool {
 		await this.#pool.end();
 	}
 	async acquireClient() {
-		return new BunPoolClient(await this.#pool.reserve());
+		return new BunPoolClient(await this.#pool.reserve(), this.options);
 	}
 };
 /**
@@ -84,8 +84,8 @@ var BunPool = class extends $Pool {
 */
 var BunPoolClient = class extends $Client {
 	#sql;
-	constructor(sql) {
-		super();
+	constructor(sql, options) {
+		super(options);
 		this.#sql = sql;
 		this.query = this.#sql.unsafe.bind(this.#sql);
 	}

package/dist/src/connectors/common.d.mts

@@ -1,6 +1,49 @@
-import { Config } from "../index.mjs";
+import { DurcnoLogger } from "../logger.mjs";
+import { Query } from "../query-builders/query.mjs";
+import { ConnectionOptions } from "node:tls";
 
 //#region src/connectors/common.d.ts
+/**
+ * Options passed to connector constructors containing database connection
+ * credentials, pool settings, and an optional logger.
+ *
+ * These options were previously part of the top-level `Config` type and are
+ * now scoped to the connector so that `Config` only contains schema/migration
+ * settings.
+ */
+type ConnectorOptions = {
+  /**
+   * Database connection credentials — either a connection URL or individual
+   * host/user/password/database fields.
+   */
+  dbCredentials: ({
+    host: string;
+    port?: number;
+    user: string;
+    password?: string;
+    database: string;
+    ssl?: boolean | "require" | "allow" | "prefer" | "verify-full" | ConnectionOptions;
+  } & {}) | {
+    url: string;
+  };
+  /**
+   * Connection pool configuration.
+   */
+  pool?: {
+    /**
+     * Maximum number of connections in the pool.
+     * @default 10
+     */
+    max?: number;
+  };
+  /**
+   * Optional logger instance for query logging.
+   * Pass a Winston logger or any object with a compatible `info()` method.
+   * When set, all executed queries will be logged at the `info` level with
+   * structured `{ sql, arguments }` metadata.
+   */
+  logger?: DurcnoLogger;
+};
 /**
  * Abstract base class for all database connectors.
  *
@@ -12,12 +55,18 @@ import { Config } from "../index.mjs";
  * @abstract
  */
 declare abstract class Connector {
-  /** The configuration object containing file paths, database credentials, client configs etc. */
-  config: Config;
-  /** The PostgreSQL connection URL derived from the configuration. */
-  url: string;
-  /** Injects the configuration and derives the connection URL. Called by `defineConfig`. */
-  _init(config: Config): void;
+  /**
+   * The original options passed to the connector constructor.
+   * Provides full access to `dbCredentials`, `pool`, and `logger`.
+   * Note: `pool` and `logger` may be mutated on the connector instance after
+   * construction (e.g. by CLI commands); use the instance fields for current values.
+   */
+  options: ConnectorOptions;
+  /** Connection pool size override (can be mutated by CLI commands before `getPool()` is called). */
+  pool?: ConnectorOptions["pool"];
+  /** Optional logger instance for query logging. */
+  logger?: DurcnoLogger;
+  constructor(options: ConnectorOptions);
   /**
    * Creates a single-connection client.
    *
@@ -38,15 +87,19 @@ declare abstract class Connector {
   abstract getPool(): $Pool;
 }
 /**
- * Abstract base class for single-connection database clients.
+ * Abstract base class shared by {@link $Client} and {@link $Pool}.
  *
- * Implementations wrap specific PostgreSQL client libraries to provide
- * a unified interface for query execution, connection management, and
- * result parsing.
+ * Holds the common `options`, `logger`, `query`, and `execQuery` members so
+ * they only need to be defined once.
  *
  * @abstract
  */
-declare abstract class $Client {
+declare abstract class $QueryExecutor {
+  /** The connector options used to create this executor. */
+  options: ConnectorOptions;
+  /** Optional logger instance for query logging. */
+  logger?: DurcnoLogger;
+  constructor(options: ConnectorOptions);
   /**
    * Executes a SQL query with optional parameterized arguments.
    *
@@ -55,6 +108,25 @@ declare abstract class $Client {
    * @returns A promise that resolves with the query result.
    */
   query: (query: string, args?: (string | number | null)[]) => Promise<unknown>;
+  /**
+   * Executes a {@link Query} object by forwarding its sql and arguments to {@link query}.
+   * When a logger is configured, logs the SQL, arguments, and query duration after execution.
+   *
+   * @param q - The {@link Query} object to execute.
+   * @returns A promise that resolves with the raw query result.
+   */
+  execQuery(q: Query<any>): Promise<unknown>;
+}
+/**
+ * Abstract base class for single-connection database clients.
+ *
+ * Implementations wrap specific PostgreSQL client libraries to provide
+ * a unified interface for query execution, connection management, and
+ * result parsing.
+ *
+ * @abstract
+ */
+declare abstract class $Client extends $QueryExecutor {
   /**
    * Establishes a connection to the database.
    *
@@ -87,18 +159,7 @@ declare abstract class $Client {
  *
  * @abstract
  */
-declare abstract class $Pool {
-  /**
-   * Executes a SQL query with optional parameterized arguments.
-   *
-   * The pool automatically acquires a connection, executes the query,
-   * and returns the connection to the pool.
-   *
-   * @param query - The SQL query string to execute.
-   * @param args - Optional array of parameter values for parameterized queries.
-   * @returns A promise that resolves with the query result.
-   */
-  query: (query: string, args?: (string | number | null)[]) => Promise<unknown>;
+declare abstract class $Pool extends $QueryExecutor {
   /**
    * Initializes the connection pool.
    *
@@ -146,4 +207,4 @@ declare abstract class $Pool {
  */
 type QueryExecutor = $Client | $Pool;
 //#endregion
-export { $Pool, Connector, QueryExecutor };
+export { $Pool, Connector, ConnectorOptions, QueryExecutor };

package/dist/src/connectors/common.mjs

@@ -1,6 +1,25 @@
-import { getUrlFromDbCredentials } from "../cli/helpers.mjs";
 //#region src/connectors/common.ts
 /**
+* Derives a PostgreSQL connection URL string from `ConnectorOptions.dbCredentials`.
+*
+* Accepts either a plain `{ url }` object or an expanded
+* `{ host, port, user, password, database, ssl }` object and builds a
+* properly-encoded `postgresql://` URL.
+*/
+function getUrlFromDbCredentials(dbCredentials) {
+	if ("url" in dbCredentials) return dbCredentials.url;
+	const { host, port, user, password, database, ssl } = dbCredentials;
+	const url = `postgresql://${encodeURIComponent(user) + (password ? `:${encodeURIComponent(password)}` : "")}@${port !== void 0 ? `${host}:${port}` : host}/${encodeURIComponent(database)}`;
+	const params = {};
+	if (ssl !== void 0) {
+		if (typeof ssl === "boolean") {
+			if (ssl) params.ssl = "true";
+		} else if (typeof ssl === "string") params.sslmode = ssl;
+		else if (typeof ssl === "object") throw new Error("Cannot convert 'ssl' ConnectionOptions object into a URL. Provide dbCredentials.url or use a boolean/string ssl value (e.g. 'require').");
+	}
+	return `${url}${Object.keys(params).length ? `?${Object.entries(params).map(([k, v]) => `${k}=${encodeURIComponent(v)}`).join("&")}` : ""}`;
+}
+/**
 * Abstract base class for all database connectors.
 *
 * Connectors provide a unified interface for creating database clients
@@ -11,26 +30,40 @@ import { getUrlFromDbCredentials } from "../cli/helpers.mjs";
 * @abstract
 */
 var Connector = class {
-	/** The configuration object containing file paths, database credentials, client configs etc. */
-	config;
-	/** The PostgreSQL connection URL derived from the configuration. */
-	url;
-	/** Injects the configuration and derives the connection URL. Called by `defineConfig`. */
-	_init(config) {
-		this.config = config;
-		this.url = getUrlFromDbCredentials(config.dbCredentials);
+	/**
+	* The original options passed to the connector constructor.
+	* Provides full access to `dbCredentials`, `pool`, and `logger`.
+	* Note: `pool` and `logger` may be mutated on the connector instance after
+	* construction (e.g. by CLI commands); use the instance fields for current values.
+	*/
+	options;
+	/** Connection pool size override (can be mutated by CLI commands before `getPool()` is called). */
+	pool;
+	/** Optional logger instance for query logging. */
+	logger;
+	constructor(options) {
+		this.options = options;
+		this.pool = options.pool;
+		this.logger = options.logger;
 	}
 };
 /**
-* Abstract base class for single-connection database clients.
+* Abstract base class shared by {@link $Client} and {@link $Pool}.
 *
-* Implementations wrap specific PostgreSQL client libraries to provide
-* a unified interface for query execution, connection management, and
-* result parsing.
+* Holds the common `options`, `logger`, `query`, and `execQuery` members so
+* they only need to be defined once.
 *
 * @abstract
 */
-var $Client = class {
+var $QueryExecutor = class {
+	/** The connector options used to create this executor. */
+	options;
+	/** Optional logger instance for query logging. */
+	logger;
+	constructor(options) {
+		this.options = options;
+		this.logger = options.logger;
+	}
 	/**
 	* Executes a SQL query with optional parameterized arguments.
 	*
@@ -39,8 +72,35 @@ var $Client = class {
 	* @returns A promise that resolves with the query result.
 	*/
 	query;
+	/**
+	* Executes a {@link Query} object by forwarding its sql and arguments to {@link query}.
+	* When a logger is configured, logs the SQL, arguments, and query duration after execution.
+	*
+	* @param q - The {@link Query} object to execute.
+	* @returns A promise that resolves with the raw query result.
+	*/
+	async execQuery(q) {
+		const start = performance.now();
+		const result = await this.query(q.sql, q.arguments);
+		if (this.logger) this.logger.info("Query", {
+			sql: q.sql,
+			arguments: q.arguments,
+			durationMs: performance.now() - start
+		});
+		return result;
+	}
 };
 /**
+* Abstract base class for single-connection database clients.
+*
+* Implementations wrap specific PostgreSQL client libraries to provide
+* a unified interface for query execution, connection management, and
+* result parsing.
+*
+* @abstract
+*/
+var $Client = class extends $QueryExecutor {};
+/**
 * Abstract base class for database connection pools.
 *
 * Connection pools manage multiple reusable connections to improve
@@ -49,18 +109,6 @@ var $Client = class {
 *
 * @abstract
 */
-var $Pool = class {
-	/**
-	* Executes a SQL query with optional parameterized arguments.
-	*
-	* The pool automatically acquires a connection, executes the query,
-	* and returns the connection to the pool.
-	*
-	* @param query - The SQL query string to execute.
-	* @param args - Optional array of parameter values for parameterized queries.
-	* @returns A promise that resolves with the query result.
-	*/
-	query;
-};
+var $Pool = class extends $QueryExecutor {};
 //#endregion
-export { $Client, $Pool, Connector };
+export { $Client, $Pool, Connector, getUrlFromDbCredentials };

package/dist/src/connectors/pg.d.mts

@@ -1,4 +1,4 @@
-import { Connector } from "./common.mjs";
+import { Connector, ConnectorOptions } from "./common.mjs";
 
 //#region src/connectors/pg.d.ts
 /**
@@ -11,10 +11,11 @@ import { Connector } from "./common.mjs";
  * @see https://www.npmjs.com/package/pg
  */
 declare class PgConnector extends Connector {
+  constructor(options: ConnectorOptions);
   getClient(): PgClient;
   getPool(): PgPool;
 }
 /** Creates a pg (node-postgres) connector instance. */
-declare function pg(): PgConnector;
+declare function pg(options: ConnectorOptions): PgConnector;
 //#endregion
 export { PgConnector, pg };