kysely 0.16.6 → 0.16.10

package/dist/cjs/util/object-utils.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.noop = exports.isReadonlyArray = exports.asReadonlyArray = exports.asArray = exports.freeze = exports.getLast = exports.isObject = exports.isFunction = exports.isBuffer = exports.isBigInt = exports.isDate = exports.isNull = exports.isBoolean = exports.isNumber = exports.isString = exports.isEmpty = void 0;
+exports.compare = exports.noop = exports.isReadonlyArray = exports.asReadonlyArray = exports.asArray = exports.freeze = exports.getLast = exports.isObject = exports.isFunction = exports.isBuffer = exports.isBigInt = exports.isDate = exports.isNull = exports.isBoolean = exports.isNumber = exports.isString = exports.isEmpty = void 0;
 function isEmpty(obj) {
     if (Array.isArray(obj) || isString(obj) || isBuffer(obj)) {
         return obj.length === 0;
@@ -83,3 +83,52 @@ function noop(obj) {
     return obj;
 }
 exports.noop = noop;
+function compare(obj1, obj2) {
+    if (isReadonlyArray(obj1) && isReadonlyArray(obj2)) {
+        return compareArrays(obj1, obj2);
+    }
+    else if (isObject(obj1) && isObject(obj2)) {
+        return compareObjects(obj1, obj2);
+    }
+    return obj1 === obj2;
+}
+exports.compare = compare;
+function compareArrays(arr1, arr2) {
+    if (arr1.length !== arr2.length) {
+        return false;
+    }
+    for (let i = 0; i < arr1.length; ++i) {
+        if (!compare(arr1[i], arr2[i])) {
+            return false;
+        }
+    }
+    return true;
+}
+function compareObjects(obj1, obj2) {
+    if (isBuffer(obj1) && isBuffer(obj2)) {
+        return compareBuffers(obj1, obj2);
+    }
+    else if (isDate(obj1) && isDate(obj2)) {
+        return compareDates(obj1, obj2);
+    }
+    return compareGenericObjects(obj1, obj2);
+}
+function compareBuffers(buf1, buf2) {
+    return Buffer.compare(buf1, buf2) === 0;
+}
+function compareDates(date1, date2) {
+    return date1.getTime() === date2.getTime();
+}
+function compareGenericObjects(obj1, obj2) {
+    const keys1 = Object.keys(obj1);
+    const keys2 = Object.keys(obj2);
+    if (keys1.length !== keys2.length) {
+        return false;
+    }
+    for (const key of keys1) {
+        if (!compare(obj1[key], obj2[key])) {
+            return false;
+        }
+    }
+    return true;
+}

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

@@ -111,3 +111,24 @@ export declare type UnknownRow = Record<string, unknown>;
 export declare type Nullable<T> = {
     [P in keyof T]: T[P] | null;
 };
+/**
+ * Takes all properties from T1 and merges all properties from T2
+ * that don't exist in T1 as optional properties.
+ *
+ * Example:
+ *
+ * interface Person {
+ *   name: string
+ *   age: number
+ * }
+ *
+ * interface Pet {
+ *   name: string
+ *   species: 'cat' | 'dog'
+ * }
+ *
+ * type Merged = MergePartial<Person, Pet>
+ *
+ * // { name: string, age: number, species?: 'cat' | 'dog' }
+ */
+export declare type MergePartial<T1, T2> = T1 & Partial<Omit<T2, keyof T1>>;

package/dist/esm/dialect/mysql/mysql-dialect.js

@@ -3,6 +3,7 @@ import { MysqlDriver } from './mysql-driver.js';
 import { MysqlQueryCompiler } from './mysql-query-compiler.js';
 import { MysqlIntrospector } from './mysql-introspector.js';
 import { MysqlAdapter } from './mysql-adapter.js';
+import { freeze } from '../../util/object-utils.js';
 /**
  * MySQL dialect that uses the [mysql2](https://github.com/sidorares/node-mysql2#readme) library.
  *
@@ -13,7 +14,7 @@ import { MysqlAdapter } from './mysql-adapter.js';
 export class MysqlDialect {
     #config;
     constructor(config) {
-        this.#config = config;
+        this.#config = freeze({ ...config });
     }
     createDriver() {
         return new MysqlDriver(this.#config);

package/dist/esm/dialect/mysql/mysql-driver.js

@@ -1,13 +1,13 @@
 /// <reference types="./mysql-driver.d.ts" />
 import { CompiledQuery } from '../../query-compiler/compiled-query.js';
-import { isFunction, isObject } from '../../util/object-utils.js';
+import { isFunction, isObject, freeze } from '../../util/object-utils.js';
 const PRIVATE_RELEASE_METHOD = Symbol();
 export class MysqlDriver {
     #config;
     #connections = new WeakMap();
     #pool;
     constructor(config) {
-        this.#config = config;
+        this.#config = freeze({ ...config });
     }
     async init() {
         // Import the `mysql2` module here instead at the top of the file

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

@@ -3,6 +3,7 @@ import { PostgresDriver } from './postgres-driver.js';
 import { PostgresIntrospector } from './postgres-introspector.js';
 import { PostgresQueryCompiler } from './postgres-query-compiler.js';
 import { PostgresAdapter } from './postgres-adapter.js';
+import { freeze } from '../../util/object-utils.js';
 /**
  * PostgreSQL dialect that uses the [pg](https://node-postgres.com/) library.
  *
@@ -16,7 +17,7 @@ import { PostgresAdapter } from './postgres-adapter.js';
 export class PostgresDialect {
     #config;
     constructor(config) {
-        this.#config = config;
+        this.#config = freeze({ ...config });
     }
     createDriver() {
         return new PostgresDriver(this.#config);

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

@@ -1,13 +1,13 @@
 /// <reference types="./postgres-driver.d.ts" />
 import { CompiledQuery } from '../../query-compiler/compiled-query.js';
-import { isFunction } from '../../util/object-utils.js';
+import { isFunction, freeze } from '../../util/object-utils.js';
 const PRIVATE_RELEASE_METHOD = Symbol();
 export class PostgresDriver {
     #config;
     #connections = new WeakMap();
     #pool = null;
     constructor(config) {
-        this.#config = config;
+        this.#config = freeze({ ...config });
     }
     async init() {
         // Import the `pg` module here instead at the top of the file

package/dist/esm/dialect/sqlite/sqlite-dialect.js

@@ -3,6 +3,7 @@ import { SqliteDriver } from './sqlite-driver.js';
 import { SqliteQueryCompiler } from './sqlite-query-compiler.js';
 import { SqliteIntrospector } from './sqlite-introspector.js';
 import { SqliteAdapter } from './sqlite-adapter.js';
+import { freeze } from '../../util/object-utils.js';
 /**
  * SQLite dialect that uses the [better-sqlite3](https://github.com/JoshuaWise/better-sqlite3) library.
  *
@@ -13,7 +14,7 @@ import { SqliteAdapter } from './sqlite-adapter.js';
 export class SqliteDialect {
     #config;
     constructor(config) {
-        this.#config = config;
+        this.#config = freeze({ ...config });
     }
     createDriver() {
         return new SqliteDriver(this.#config);

package/dist/esm/dialect/sqlite/sqlite-driver.js

@@ -1,13 +1,13 @@
 /// <reference types="./sqlite-driver.d.ts" />
 import { CompiledQuery } from '../../query-compiler/compiled-query.js';
-import { isBoolean, isFunction, isNumber } from '../../util/object-utils.js';
+import { freeze, isBoolean, isFunction, isNumber, } from '../../util/object-utils.js';
 export class SqliteDriver {
     #config;
     #connectionMutex = new ConnectionMutex();
     #db;
     #connection;
     constructor(config) {
-        this.#config = config;
+        this.#config = freeze({ ...config });
     }
     async init() {
         // Import the `better-sqlite3` module here instead at the top of the file

package/dist/esm/driver/dummy-driver.d.ts

@@ -1,5 +1,33 @@
 import { DatabaseConnection } from './database-connection.js';
 import { Driver } from './driver.js';
+/**
+ * A driver that does absolutely nothing.
+ *
+ * You can use this to create Kysely instances solely for building queries
+ *
+ * ### Examples
+ *
+ * This example creates a Kysely instance for building postgres queries:
+ *
+ * ```ts
+ * const db = new Kysely<Database>({
+ *   dialect: {
+ *     createAdapter() {
+ *       return new PostgresAdapter()
+ *     },
+ *     createDriver() {
+ *       return new DummyDriver()
+ *     },
+ *     createIntrospector(db: Kysely<any>) {
+ *       return new PostgresIntrospector(db)
+ *     },
+ *     createQueryCompiler() {
+ *       return new PostgresQueryCompiler()
+ *     },
+ *   },
+ * })
+ * ```
+ */
 export declare class DummyDriver implements Driver {
     /**
      * Initializes the driver.

package/dist/esm/driver/dummy-driver.js

@@ -1,7 +1,35 @@
 /// <reference types="./dummy-driver.d.ts" />
+/**
+ * A driver that does absolutely nothing.
+ *
+ * You can use this to create Kysely instances solely for building queries
+ *
+ * ### Examples
+ *
+ * This example creates a Kysely instance for building postgres queries:
+ *
+ * ```ts
+ * const db = new Kysely<Database>({
+ *   dialect: {
+ *     createAdapter() {
+ *       return new PostgresAdapter()
+ *     },
+ *     createDriver() {
+ *       return new DummyDriver()
+ *     },
+ *     createIntrospector(db: Kysely<any>) {
+ *       return new PostgresIntrospector(db)
+ *     },
+ *     createQueryCompiler() {
+ *       return new PostgresQueryCompiler()
+ *     },
+ *   },
+ * })
+ * ```
+ */
 export class DummyDriver {
-    init() {
-        throw new Error('Method not implemented.');
+    async init() {
+        // Nothing to do here.
     }
     async acquireConnection() {
         return new DummyConnection();
@@ -23,7 +51,7 @@ export class DummyDriver {
     }
 }
 class DummyConnection {
-    async executeQuery(compiledQuery) {
+    async executeQuery() {
         return {
             rows: [],
         };

package/dist/esm/index-nodeless.d.ts

@@ -59,6 +59,7 @@ export * from './query-compiler/query-compiler.js';
 export * from './migration/migrator.js';
 export * from './plugin/kysely-plugin.js';
 export * from './plugin/camel-case/camel-case-plugin.js';
+export * from './plugin/deduplicate-joins/deduplicate-joins-plugin.js';
 export * from './operation-node/add-column-node.js';
 export * from './operation-node/add-constraint-node.js';
 export * from './operation-node/alias-node.js';

package/dist/esm/index-nodeless.js

@@ -60,6 +60,7 @@ export * from './query-compiler/query-compiler.js';
 export * from './migration/migrator.js';
 export * from './plugin/kysely-plugin.js';
 export * from './plugin/camel-case/camel-case-plugin.js';
+export * from './plugin/deduplicate-joins/deduplicate-joins-plugin.js';
 export * from './operation-node/add-column-node.js';
 export * from './operation-node/add-constraint-node.js';
 export * from './operation-node/alias-node.js';

package/dist/esm/kysely.d.ts

@@ -22,22 +22,24 @@ import { DialectAdapter } from './dialect/dialect-adapter.js';
  * This example assumes your database has tables `person` and `pet`:
  *
  * ```ts
- * interface Person {
- *   id: number
+ * import { Kysely, Generated, PostgresDialect } from 'kysely'
+ *
+ * interface PersonTable {
+ *   id: Generated<number>
  *   first_name: string
  *   last_name: string
  * }
  *
- * interface Pet {
- *   id: number
+ * interface PetTable {
+ *   id: Generated<number>
  *   owner_id: number
  *   name: string
  *   species 'cat' | 'dog'
  * }
  *
  * interface Database {
- *   person: Person,
- *   pet: Pet
+ *   person: PersonTable,
+ *   pet: PetTable
  * }
  *
  * const db = new Kysely<Database>({

package/dist/esm/kysely.js

@@ -24,22 +24,24 @@ import { PRIVATE_ADAPTER } from './util/private-symbols.js';
  * This example assumes your database has tables `person` and `pet`:
  *
  * ```ts
- * interface Person {
- *   id: number
+ * import { Kysely, Generated, PostgresDialect } from 'kysely'
+ *
+ * interface PersonTable {
+ *   id: Generated<number>
  *   first_name: string
  *   last_name: string
  * }
  *
- * interface Pet {
- *   id: number
+ * interface PetTable {
+ *   id: Generated<number>
  *   owner_id: number
  *   name: string
  *   species 'cat' | 'dog'
  * }
  *
  * interface Database {
- *   person: Person,
- *   pet: Pet
+ *   person: PersonTable,
+ *   pet: PetTable
  * }
  *
  * const db = new Kysely<Database>({
@@ -338,12 +340,12 @@ export class ConnectionBuilder {
     async execute(callback) {
         const connection = await this.#props.driver.acquireConnection();
         const connectionProvider = new SingleConnectionProvider(connection);
-        const transaction = new Kysely({
+        const db = new Kysely({
             ...this.#props,
             executor: this.#props.executor.withConnectionProvider(connectionProvider),
         });
         try {
-            return await callback(transaction);
+            return await callback(db);
         }
         finally {
             await this.#props.driver.releaseConnection(connection);

package/dist/esm/migration/migrator.d.ts

@@ -36,6 +36,12 @@ export interface Migration {
 export declare class Migrator {
     #private;
     constructor(props: MigratorProps);
+    /**
+     * Returns a {@link MigrationInfo} object for each migration.
+     *
+     * The returned array is sorted by migration name.
+     */
+    getMigrations(): Promise<ReadonlyArray<MigrationInfo>>;
     /**
      * Runs all migrations that have not yet been run.
      *
@@ -219,3 +225,19 @@ export interface MigrationProvider {
 export interface NoMigrations {
     readonly __noMigrations__: true;
 }
+export interface MigrationInfo {
+    /**
+     * Name of the migration.
+     */
+    name: string;
+    /**
+     * The actual migration.
+     */
+    migration: Migration;
+    /**
+     * When was the migration executed.
+     *
+     * If this is undefined, the migration hasn't been executed yet.
+     */
+    executedAt?: Date;
+}

package/dist/esm/migration/migrator.js

@@ -30,6 +30,28 @@ export class Migrator {
     constructor(props) {
         this.#props = freeze(props);
     }
+    /**
+     * Returns a {@link MigrationInfo} object for each migration.
+     *
+     * The returned array is sorted by migration name.
+     */
+    async getMigrations() {
+        const executedMigrations = (await this.#doesTableExists(MIGRATION_TABLE))
+            ? await this.#props.db
+                .selectFrom(MIGRATION_TABLE)
+                .select(['name', 'timestamp'])
+                .execute()
+            : [];
+        const migrations = await this.#resolveMigrations();
+        return migrations.map(({ name, ...migration }) => {
+            const executed = executedMigrations.find((it) => it.name === name);
+            return {
+                name,
+                migration,
+                executedAt: executed ? new Date(executed.timestamp) : undefined,
+            };
+        });
+    }
     /**
      * Runs all migrations that have not yet been run.
      *
@@ -213,7 +235,7 @@ export class Migrator {
             try {
                 await this.#props.db
                     .insertInto(MIGRATION_LOCK_TABLE)
-                    .values({ id: MIGRATION_LOCK_ID })
+                    .values({ id: MIGRATION_LOCK_ID, is_locked: 0 })
                     .execute();
             }
             catch (error) {

package/dist/esm/plugin/deduplicate-joins/deduplicate-joins-plugin.d.ts

@@ -0,0 +1,48 @@
+import { QueryResult } from '../../driver/database-connection.js';
+import { RootOperationNode } from '../../query-compiler/query-compiler.js';
+import { UnknownRow } from '../../util/type-utils.js';
+import { KyselyPlugin, PluginTransformQueryArgs, PluginTransformResultArgs } from '../kysely-plugin.js';
+/**
+ * Plugin that removes duplicate joins from queries.
+ *
+ * See [this recipe](https://github.com/koskimas/kysely/tree/master/recipes/deduplicate-joins.md)
+ */
+export declare class DeduplicateJoinsPlugin implements KyselyPlugin {
+    #private;
+    /**
+     * This is called for each query before it is executed. You can modify the query by
+     * transforming its {@link OperationNode} tree provided in {@link PluginTransformQueryArgs.node | args.node}
+     * and returning the transformed tree. You'd usually want to use an {@link OperationNodeTransformer}
+     * for this.
+     *
+     * If you need to pass some query-related data between this method and `transformResult` you
+     * can use a `WeakMap` with {@link PluginTransformQueryArgs.queryId | args.queryId} as the key:
+     *
+     * ```ts
+     * const plugin = {
+     *   data: new WeakMap<QueryId, SomeData>(),
+     *
+     *   transformQuery(args: PluginTransformQueryArgs): RootOperationNode {
+     *     this.data.set(args.queryId, something)
+     *     return args.node
+     *   },
+     *
+     *   transformResult(args: PluginTransformResultArgs): QueryResult<UnknownRow> {
+     *     const data = this.data.get(args.queryId)
+     *     return args.result
+     *   }
+     * }
+     * ```
+     *
+     * You should use a `WeakMap` instead of a `Map` or some other strong references because `transformQuery`
+     * is not always matched by a call to `transformResult` which would leave orphaned items in the map
+     * and cause a memory leak.
+     */
+    transformQuery(args: PluginTransformQueryArgs): RootOperationNode;
+    /**
+     * This method is called for each query after it has been executed. The result
+     * of the query can be accessed through {@link PluginTransformResultArgs.result | args.result}.
+     * You can modify the result and return the modifier result.
+     */
+    transformResult(args: PluginTransformResultArgs): Promise<QueryResult<UnknownRow>>;
+}

package/dist/esm/plugin/deduplicate-joins/deduplicate-joins-plugin.js

@@ -0,0 +1,16 @@
+/// <reference types="./deduplicate-joins-plugin.d.ts" />
+import { DeduplicateJoinsTransformer } from './deduplicate-joins-transformer.js';
+/**
+ * Plugin that removes duplicate joins from queries.
+ *
+ * See [this recipe](https://github.com/koskimas/kysely/tree/master/recipes/deduplicate-joins.md)
+ */
+export class DeduplicateJoinsPlugin {
+    #transformer = new DeduplicateJoinsTransformer();
+    transformQuery(args) {
+        return this.#transformer.transformNode(args.node);
+    }
+    transformResult(args) {
+        return Promise.resolve(args.result);
+    }
+}

package/dist/esm/plugin/deduplicate-joins/deduplicate-joins-transformer.d.ts

@@ -0,0 +1,9 @@
+import { DeleteQueryNode, UpdateQueryNode } from '../../index-nodeless.js';
+import { OperationNodeTransformer } from '../../operation-node/operation-node-transformer.js';
+import { SelectQueryNode } from '../../operation-node/select-query-node.js';
+export declare class DeduplicateJoinsTransformer extends OperationNodeTransformer {
+    #private;
+    protected transformSelectQuery(node: SelectQueryNode): SelectQueryNode;
+    protected transformUpdateQuery(node: UpdateQueryNode): UpdateQueryNode;
+    protected transformDeleteQuery(node: DeleteQueryNode): DeleteQueryNode;
+}

package/dist/esm/plugin/deduplicate-joins/deduplicate-joins-transformer.js

@@ -0,0 +1,39 @@
+/// <reference types="./deduplicate-joins-transformer.d.ts" />
+import { OperationNodeTransformer } from '../../operation-node/operation-node-transformer.js';
+import { compare, freeze } from '../../util/object-utils.js';
+export class DeduplicateJoinsTransformer extends OperationNodeTransformer {
+    transformSelectQuery(node) {
+        return this.#transformQuery(super.transformSelectQuery(node));
+    }
+    transformUpdateQuery(node) {
+        return this.#transformQuery(super.transformUpdateQuery(node));
+    }
+    transformDeleteQuery(node) {
+        return this.#transformQuery(super.transformDeleteQuery(node));
+    }
+    #transformQuery(node) {
+        if (!node.joins || node.joins.length === 0) {
+            return node;
+        }
+        return freeze({
+            ...node,
+            joins: this.#deduplicateJoins(node.joins),
+        });
+    }
+    #deduplicateJoins(joins) {
+        const out = [];
+        for (let i = 0; i < joins.length; ++i) {
+            let foundDuplicate = false;
+            for (let j = i + 1; j < joins.length; ++j) {
+                if (compare(joins[i], joins[j])) {
+                    foundDuplicate = true;
+                    break;
+                }
+            }
+            if (!foundDuplicate) {
+                out.push(joins[i]);
+            }
+        }
+        return freeze(out);
+    }
+}