kysely 0.29.2 → 0.29.4

package/README.md

@@ -1,7 +1,7 @@
 [![Stand With Ukraine](https://raw.githubusercontent.com/vshymanskyy/StandWithUkraine/main/banner2-direct.svg)](https://stand-with-ukraine.pp.ua)
 
 [![NPM Version](https://img.shields.io/npm/v/kysely?style=flat&label=latest)](https://github.com/kysely-org/kysely/releases/latest)
-[![Socket Badge](https://badge.socket.dev/npm/package/kysely/0.29.2)](https://socket.dev/npm/package/kysely/overview/0.29.2)
+[![Socket Badge](https://badge.socket.dev/npm/package/kysely/0.29.4)](https://socket.dev/npm/package/kysely/overview/0.29.4)
 [![Tests](https://github.com/kysely-org/kysely/actions/workflows/test.yml/badge.svg)](https://github.com/kysely-org/kysely)
 [![License](https://img.shields.io/github/license/kysely-org/kysely?style=flat)](https://github.com/kysely-org/kysely/blob/master/LICENSE)
 [![Issues](https://img.shields.io/github/issues-closed/kysely-org/kysely?logo=github)](https://github.com/kysely-org/kysely/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc)

package/dist/dialect/mssql/mssql-adapter.d.ts

@@ -1,5 +1,6 @@
 import type { Kysely } from '../../kysely.js';
 import { DialectAdapterBase } from '../dialect-adapter-base.js';
+import type { MigrationLockOptions } from '../dialect-adapter.js';
 export declare class MssqlAdapter extends DialectAdapterBase {
     get supportsCreateIfNotExists(): boolean;
     get supportsTransactionalDdl(): boolean;
@@ -58,7 +59,7 @@ export declare class MssqlAdapter extends DialectAdapterBase {
      * `db` is a single connection (session) that will be used to execute the
      * migrations.
      */
-    acquireMigrationLock(db: Kysely<any>): Promise<void>;
+    acquireMigrationLock(db: Kysely<any>, _opt: MigrationLockOptions): Promise<void>;
     /**
      * Releases the migration lock. See {@link acquireMigrationLock}.
      *
@@ -67,5 +68,5 @@ export declare class MssqlAdapter extends DialectAdapterBase {
      * is a single connection (session) that was used to execute the migrations
      * and the `acquireMigrationLock` call.
      */
-    releaseMigrationLock(): Promise<void>;
+    releaseMigrationLock(db: Kysely<any>, _opt: MigrationLockOptions): Promise<void>;
 }

package/dist/dialect/mssql/mssql-adapter.js

@@ -2,6 +2,7 @@
 import { DEFAULT_MIGRATION_TABLE } from '../../migration/migrator.js';
 import { sql } from '../../raw-builder/sql.js';
 import { DialectAdapterBase } from '../dialect-adapter-base.js';
+const LOCK_PRINCIPAL = 'dbo';
 export class MssqlAdapter extends DialectAdapterBase {
     get supportsCreateIfNotExists() {
         return false;
@@ -12,14 +13,19 @@ export class MssqlAdapter extends DialectAdapterBase {
     get supportsOutput() {
         return true;
     }
-    async acquireMigrationLock(db) {
-        // Acquire a transaction-level exclusive lock on the migrations table.
+    async acquireMigrationLock(db, _opt) {
+        // Acquire a session-level exclusive lock on the migrations table. A
+        // session-level lock (as opposed to the default transaction-level lock)
+        // stays held after the migration transaction commits and until we release
+        // it explicitly in `releaseMigrationLock` OR the session ends. This way we
+        // know the lock is either released by us after successful or failed
+        // migrations OR it's released by SQL Server if the connection dies.
         // https://learn.microsoft.com/en-us/sql/relational-databases/system-stored-procedures/sp-getapplock-transact-sql?view=sql-server-ver16
-        await sql `exec sp_getapplock @DbPrincipal = ${sql.lit('dbo')}, @Resource = ${sql.lit(DEFAULT_MIGRATION_TABLE)}, @LockMode = ${sql.lit('Exclusive')}`.execute(db);
+        await sql `exec sp_getapplock @DbPrincipal = ${sql.lit(LOCK_PRINCIPAL)}, @Resource = ${sql.lit(DEFAULT_MIGRATION_TABLE)}, @LockMode = ${sql.lit('Exclusive')}, @LockOwner = ${sql.lit('Session')}`.execute(db);
     }
-    async releaseMigrationLock() {
-        // Nothing to do here. `sp_getapplock` is automatically released at the
-        // end of the transaction and since `supportsTransactionalDdl` true, we know
-        // the `db` instance passed to acquireMigrationLock is actually a transaction.
+    async releaseMigrationLock(db, _opt) {
+        // Release the session-level lock acquired in `acquireMigrationLock`.
+        // https://learn.microsoft.com/en-us/sql/relational-databases/system-stored-procedures/sp-releaseapplock-transact-sql?view=sql-server-ver16
+        await sql `exec sp_releaseapplock @DbPrincipal = ${sql.lit(LOCK_PRINCIPAL)}, @Resource = ${sql.lit(DEFAULT_MIGRATION_TABLE)}, @LockOwner = ${sql.lit('Session')}`.execute(db);
     }
 }

package/dist/dialect/mysql/mysql-dialect-config.d.ts

@@ -10,7 +10,10 @@ export interface MysqlDialectConfig {
      *
      * This is useful for cancelling queries on the database side.
      */
-    controlConnection?: (config: object) => MysqlConnection;
+    controlConnection?: {
+        (connectionUri: string): MysqlConnection;
+        (config: object): MysqlConnection;
+    };
     /**
      * A mysql2 Pool instance or a function that returns one.
      *
@@ -44,10 +47,9 @@ export interface MysqlConnection {
     config: object;
     connect(callback?: (error: unknown) => void): void;
     destroy(): void;
-    query(sql: string, parameters: Array<unknown>): {
-        stream: <T>(options: MysqlStreamOptions) => MysqlStream<T>;
+    query(sql: string, parameters: any, callback?: (error: unknown, result: MysqlQueryResult) => void): {
+        stream: (options: MysqlStreamOptions) => MysqlStream;
     };
-    query(sql: string, parameters: Array<unknown>, callback: (error: unknown, result: MysqlQueryResult) => void): void;
     threadId: number;
 }
 export type MysqlConectionConstructor = new (opts?: object) => MysqlConnection;
@@ -58,8 +60,8 @@ export interface MysqlStreamOptions {
     highWaterMark?: number;
     objectMode?: true;
 }
-export interface MysqlStream<T> {
-    [Symbol.asyncIterator](): AsyncIterableIterator<T>;
+export interface MysqlStream {
+    [Symbol.asyncIterator](): any;
 }
 export interface MysqlOkPacket {
     affectedRows: number;

package/dist/dialect/postgres/postgres-adapter.d.ts

@@ -67,5 +67,5 @@ export declare class PostgresAdapter extends DialectAdapterBase {
      * is a single connection (session) that was used to execute the migrations
      * and the `acquireMigrationLock` call.
      */
-    releaseMigrationLock(_db: Kysely<any>, _opt: MigrationLockOptions): Promise<void>;
+    releaseMigrationLock(db: Kysely<any>, _opt: MigrationLockOptions): Promise<void>;
 }

package/dist/dialect/postgres/postgres-adapter.js

@@ -1,8 +1,8 @@
 /// <reference types="./postgres-adapter.d.ts" />
 import { sql } from '../../raw-builder/sql.js';
 import { DialectAdapterBase } from '../dialect-adapter-base.js';
-// Random id for our transaction lock.
 const LOCK_ID = BigInt('3853314791062309107');
+const LOCK_TIMEOUT_MILLISECONDS = 60 * 60 * 1_000;
 export class PostgresAdapter extends DialectAdapterBase {
     get supportsTransactionalDdl() {
         return true;
@@ -11,12 +11,18 @@ export class PostgresAdapter extends DialectAdapterBase {
         return true;
     }
     async acquireMigrationLock(db, _opt) {
-        // Acquire a transaction level advisory lock.
-        await sql `select pg_advisory_xact_lock(${sql.lit(LOCK_ID)})`.execute(db);
+        // in 1 RTT, acquire a session-level advisory lock with a timeout.
+        //
+        // if ever this runs inside a transaction, niche edge case we support - the
+        // user is responsible to set a different timeout value or disable (`0` value).
+        await sql `
+    with set_timeout as (
+      select set_config('lock_timeout', '${sql.lit(LOCK_TIMEOUT_MILLISECONDS)}', true) as config_val
+    )
+    select pg_advisory_lock(${sql.lit(LOCK_ID)})
+    from set_timeout`.execute(db);
     }
-    async releaseMigrationLock(_db, _opt) {
-        // Nothing to do here. `pg_advisory_xact_lock` is automatically released at the
-        // end of the transaction and since `supportsTransactionalDdl` true, we know
-        // the `db` instance passed to acquireMigrationLock is actually a transaction.
+    async releaseMigrationLock(db, _opt) {
+        await sql `select pg_advisory_unlock(${sql.lit(LOCK_ID)})`.execute(db);
     }
 }

package/dist/dialect/postgres/postgres-driver.js

@@ -177,7 +177,11 @@ class PostgresConnection {
                 }
             });
         }
-        const controlClient = new Client({ ...poolOptions });
+        const controlClient = new Client({
+            ...poolOptions,
+            // `password` is not enumerable, so we have to explicitly set it after the spread.
+            password: 'password' in poolOptions ? poolOptions.password : undefined,
+        });
         try {
             await controlClient.connect();
             // by the time we get the connection, another query might have been executed.

package/dist/driver/driver.d.ts

@@ -55,8 +55,8 @@ export interface TransactionSettings {
     readonly accessMode?: AccessMode;
     readonly isolationLevel?: IsolationLevel;
 }
-export declare const TRANSACTION_ACCESS_MODES: readonly ["read only", "read write"];
+export declare const TRANSACTION_ACCESS_MODES: readonly ['read only', 'read write'];
 export type AccessMode = ArrayItemType<typeof TRANSACTION_ACCESS_MODES>;
-export declare const TRANSACTION_ISOLATION_LEVELS: readonly ["read uncommitted", "read committed", "repeatable read", "serializable", "snapshot"];
+export declare const TRANSACTION_ISOLATION_LEVELS: readonly ['read uncommitted', 'read committed', 'repeatable read', 'serializable', 'snapshot'];
 export type IsolationLevel = ArrayItemType<typeof TRANSACTION_ISOLATION_LEVELS>;
 export declare function validateTransactionSettings(settings: TransactionSettings): void;

package/dist/migration/migrator.js

@@ -404,23 +404,26 @@ export class Migrator {
             lockTableSchema: this.#props.migrationTableSchema,
         });
         const run = async (db) => {
+            const state = await this.#getState(db);
+            if (state.migrations.length === 0) {
+                return { results: [] };
+            }
+            const { direction, step } = getMigrationDirectionAndStep(state);
+            if (step <= 0) {
+                return { results: [] };
+            }
+            if (direction === 'Down') {
+                return await this.#migrateDown(db, state, step);
+            }
+            else if (direction === 'Up') {
+                return await this.#migrateUp(db, state, step);
+            }
+            return { results: [] };
+        };
+        const runWithLock = async (db, cb) => {
             try {
                 await adapter.acquireMigrationLock(db, lockOptions);
-                const state = await this.#getState(db);
-                if (state.migrations.length === 0) {
-                    return { results: [] };
-                }
-                const { direction, step } = getMigrationDirectionAndStep(state);
-                if (step <= 0) {
-                    return { results: [] };
-                }
-                if (direction === 'Down') {
-                    return await this.#migrateDown(db, state, step);
-                }
-                else if (direction === 'Up') {
-                    return await this.#migrateUp(db, state, step);
-                }
-                return { results: [] };
+                return await cb(db);
             }
             finally {
                 await adapter.releaseMigrationLock(db, lockOptions);
@@ -434,12 +437,14 @@ export class Migrator {
             if (disableTransactions) {
                 throw new Error('`disableTransactions` is true but the migrator was given a transaction. Passing a transaction to this migrator would result in failure or unexpected behavior.');
             }
-            return run(this.#props.db);
+            return runWithLock(this.#props.db, run);
         }
         if (adapter.supportsTransactionalDdl && !disableTransactions) {
-            return this.#props.db.transaction().execute(run);
+            return this.#props.db
+                .connection()
+                .execute((db) => runWithLock(db, (db) => db.transaction().execute((trx) => run(trx))));
         }
-        return this.#props.db.connection().execute(run);
+        return this.#props.db.connection().execute((db) => runWithLock(db, run));
     }
     async #getState(db) {
         const migrations = await this.#resolveMigrations();

package/dist/plugin/camel-case/camel-case.d.ts

@@ -3,9 +3,9 @@ export type StringMapper = (str: string) => string;
  * Creates a function that transforms camel case strings to snake case.
  */
 export declare function createSnakeCaseMapper({ upperCase, underscoreBeforeDigits, underscoreBetweenUppercaseLetters, }?: {
-    upperCase?: boolean | undefined;
     underscoreBeforeDigits?: boolean | undefined;
     underscoreBetweenUppercaseLetters?: boolean | undefined;
+    upperCase?: boolean | undefined;
 }): StringMapper;
 /**
  * Creates a function that transforms snake case strings to camel case.

package/dist/query-builder/json-path-builder.d.ts

@@ -73,7 +73,7 @@ export declare class JSONPathBuilder<S, O = S> {
      * select "nicknames"->>'$[#-1]' as `last_nickname` from `person`
      * ```
      */
-    at<I extends any[] extends O ? number | 'last' | `#-${number}` : never, O2 = null | NonNullable<NonNullable<O>[keyof NonNullable<O> & number]>>(index: `${I}` extends `${any}.${any}` | `#--${any}` ? never : I): TraversedJSONPathBuilder<S, O2>;
+    at<I extends (any[] extends O ? number | 'last' | `#-${number}` : never), O2 = null | NonNullable<NonNullable<O>[keyof NonNullable<O> & number]>>(index: `${I}` extends `${any}.${any}` | `#--${any}` ? never : I): TraversedJSONPathBuilder<S, O2>;
     /**
      * Access a property of a JSON object.
      *
@@ -123,7 +123,7 @@ export declare class JSONPathBuilder<S, O = S> {
      * select "profile"->'addresses'->0->'city' as "city" from "person"
      * ```
      */
-    key<K extends any[] extends O ? never : O extends object ? keyof NonNullable<O> & string : never, O2 = undefined extends O ? null | NonNullable<NonNullable<O>[K]> : null extends O ? null | NonNullable<NonNullable<O>[K]> : string extends keyof NonNullable<O> ? null | NonNullable<NonNullable<O>[K]> : NonNullable<O>[K]>(key: K): TraversedJSONPathBuilder<S, O2>;
+    key<K extends (any[] extends O ? never : O extends object ? keyof NonNullable<O> & string : never), O2 = undefined extends O ? null | NonNullable<NonNullable<O>[K]> : null extends O ? null | NonNullable<NonNullable<O>[K]> : string extends keyof NonNullable<O> ? null | NonNullable<NonNullable<O>[K]> : NonNullable<O>[K]>(key: K): TraversedJSONPathBuilder<S, O2>;
 }
 export declare class TraversedJSONPathBuilder<S, O> extends JSONPathBuilder<S, O> implements AliasableExpression<O> {
     #private;

package/dist/query-compiler/default-query-compiler.js

@@ -254,6 +254,10 @@ export class DefaultQueryCompiler extends OperationNodeVisitor {
             this.append(' ');
             this.visitNode(node.where);
         }
+        if (node.returning) {
+            this.append(' ');
+            this.visitNode(node.returning);
+        }
         if (node.orderBy) {
             this.append(' ');
             this.visitNode(node.orderBy);
@@ -262,10 +266,6 @@ export class DefaultQueryCompiler extends OperationNodeVisitor {
             this.append(' ');
             this.visitNode(node.limit);
         }
-        if (node.returning) {
-            this.append(' ');
-            this.visitNode(node.returning);
-        }
         if (wrapInParens) {
             this.append(')');
         }

package/dist/util/log.d.ts

@@ -1,6 +1,6 @@
 import type { CompiledQuery } from '../query-compiler/compiled-query.js';
 import type { ArrayItemType } from './type-utils.js';
-declare const logLevels: readonly ["query", "error"];
+declare const logLevels: readonly ['query', 'error'];
 export declare const LOG_LEVELS: Readonly<typeof logLevels>;
 export type LogLevel = ArrayItemType<typeof LOG_LEVELS>;
 export interface QueryLogEvent {

package/dist/util/type-utils.d.ts

@@ -119,7 +119,7 @@ export type IsAny<T> = 0 extends T & 1 ? true : false;
 /**
  * Evaluates to `true` if the types `T` and `U` are equal.
  */
-export type Equals<T, U> = (<G>() => G extends T ? 1 : 2) extends <G>() => G extends U ? 1 : 2 ? true : false;
+export type Equals<T, U> = (<G>() => G extends T ? 1 : 2) extends <G>() => (G extends U ? 1 : 2) ? true : false;
 export type NarrowPartial<O, T> = T extends object ? DrainOuterGeneric<{
     [K in keyof O & string]: K extends keyof T ? T[K] extends NotNull ? Exclude<O[K], null> : T[K] extends O[K] ? T[K] : T[K] extends object ? SimplifyDeep<O[K] & NarrowPartial<O[K], T[K]>> : KyselyTypeError<`$narrowType() call failed: passed type does not exist in '${K}'s type union`> : O[K];
 }> : never;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "kysely",
-  "version": "0.29.2",
+  "version": "0.29.4",
   "description": "Type safe SQL query builder",
   "repository": {
     "type": "git",
@@ -61,41 +61,41 @@
     "Igal Klebanov <igalklebanov@gmail.com>"
   ],
   "devDependencies": {
-    "@arethetypeswrong/cli": "0.18.2",
-    "@ark/attest": "0.56.0",
-    "@electric-sql/pglite": "0.4.5",
+    "@arethetypeswrong/cli": "0.18.5",
+    "@electric-sql/pglite": "0.5.4",
     "@types/better-sqlite3": "7.6.13",
     "@types/chai": "5.2.3",
     "@types/chai-as-promised": "8.0.2",
     "@types/mocha": "10.0.10",
-    "@types/node": "25.8.0",
+    "@types/node": "26.1.1",
     "@types/pg": "8.20.0",
     "@types/pg-cursor": "2.7.2",
     "@types/prototype-pollution-vulnerable-lodash.merge-dont-upgrade": "npm:@types/lodash.merge@4.6.1",
     "@types/semver": "7.7.1",
-    "@types/sinon": "21.0.1",
-    "better-sqlite3": "12.10.0",
+    "@types/sinon": "22.0.0",
+    "better-sqlite3": "12.11.1",
     "chai": "6.2.2",
     "chai-as-promised": "8.0.2",
-    "esbuild": "0.28.0",
+    "esbuild": "0.28.1",
     "jsr": "0.14.3",
-    "mocha": "11.7.5",
-    "mysql2": "3.22.3",
+    "mocha": "11.7.6",
+    "mysql2": "3.23.0",
     "pathe": "2.0.3",
-    "pg": "8.20.0",
-    "pg-cursor": "2.19.0",
-    "playwright": "1.60.0",
-    "prettier": "3.8.3",
+    "pg": "8.22.0",
+    "pg-cursor": "2.21.0",
+    "playwright": "1.61.1",
+    "prettier": "3.9.5",
     "prototype-pollution-vulnerable-lodash.merge-dont-upgrade": "npm:lodash.merge@4.6.1",
-    "remeda": "2.34.1",
-    "semver": "7.8.0",
+    "remeda": "2.39.0",
+    "semver": "7.8.5",
     "sinon": "22.0.0",
-    "std-env": "4.1.0",
-    "tarn": "3.0.2",
-    "tedious": "19.2.1",
+    "std-env": "4.2.0",
+    "tarn": "3.1.2",
+    "tedious": "20.0.0",
     "tsd": "0.33.0",
-    "tsx": "4.22.0",
-    "typescript": "6.0.3"
+    "tsx": "4.23.1",
+    "typescript": "7.0.2",
+    "typescript-6": "npm:typescript@6.0.3"
   },
   "scripts": {
     "clean": "rm -rf dist & rm -rf test/node/dist & rm -rf test/browser/bundle.js",