kysely 0.27.2 → 0.27.4

package/dist/esm/query-creator.js

@@ -7,13 +7,15 @@ import { DeleteQueryNode } from './operation-node/delete-query-node.js';
 import { InsertQueryNode } from './operation-node/insert-query-node.js';
 import { SelectQueryNode } from './operation-node/select-query-node.js';
 import { UpdateQueryNode } from './operation-node/update-query-node.js';
-import { parseTable, parseTableExpression, parseTableExpressionOrList, } from './parser/table-parser.js';
+import { parseTable, parseTableExpression, parseTableExpressionOrList, parseAliasedTable, } from './parser/table-parser.js';
 import { parseCommonTableExpression, } from './parser/with-parser.js';
 import { WithNode } from './operation-node/with-node.js';
 import { createQueryId } from './util/query-id.js';
 import { WithSchemaPlugin } from './plugin/with-schema/with-schema-plugin.js';
 import { freeze } from './util/object-utils.js';
 import { parseSelectArg, } from './parser/select-parser.js';
+import { MergeQueryBuilder } from './query-builder/merge-query-builder.js';
+import { MergeQueryNode } from './operation-node/merge-query-node.js';
 export class QueryCreator {
     #props;
     constructor(props) {
@@ -125,29 +127,89 @@ export class QueryCreator {
             queryNode: UpdateQueryNode.create(parseTableExpression(table), this.#props.withNode),
         });
     }
+    mergeInto(targetTable) {
+        return new MergeQueryBuilder({
+            queryId: createQueryId(),
+            executor: this.#props.executor,
+            queryNode: MergeQueryNode.create(parseAliasedTable(targetTable), this.#props.withNode),
+        });
+    }
     /**
      * Creates a `with` query (Common Table Expression).
      *
      * ### Examples
      *
+     * <!-- siteExample("cte", "Simple selects", 10) -->
+     *
+     * Common table expressions (CTE) are a great way to modularize complex queries.
+     * Essentially they allow you to run multiple separate queries within a
+     * single roundtrip to the DB.
+     *
+     * Since CTEs are a part of the main query, query optimizers inside DB
+     * engines are able to optimize the overall query. For example, postgres
+     * is able to inline the CTEs inside the using queries if it decides it's
+     * faster.
+     *
      * ```ts
-     * await db
+     * const result = await db
+     *   // Create a CTE called `jennifers` that selects all
+     *   // persons named 'Jennifer'.
      *   .with('jennifers', (db) => db
      *     .selectFrom('person')
      *     .where('first_name', '=', 'Jennifer')
      *     .select(['id', 'age'])
      *   )
+     *   // Select all rows from the `jennifers` CTE and
+     *   // further filter it.
      *   .with('adult_jennifers', (db) => db
      *     .selectFrom('jennifers')
      *     .where('age', '>', 18)
      *     .select(['id', 'age'])
      *   )
+     *   // Finally select all adult jennifers that are
+     *   // also younger than 60.
      *   .selectFrom('adult_jennifers')
      *   .where('age', '<', 60)
      *   .selectAll()
      *   .execute()
      * ```
      *
+     * <!-- siteExample("cte", "Inserts, updates and deletions", 20) -->
+     *
+     * Some databases like postgres also allow you to run other queries than selects
+     * in CTEs. On these databases CTEs are extremely powerful:
+     *
+     * ```ts
+     * const result = await db
+     *   .with('new_person', (db) => db
+     *     .insertInto('person')
+     *     .values({
+     *       first_name: 'Jennifer',
+     *       age: 35,
+     *     })
+     *     .returning('id')
+     *   )
+     *   .with('new_pet', (db) => db
+     *     .insertInto('pet')
+     *     .values({
+     *       name: 'Doggo',
+     *       species: 'dog',
+     *       is_favorite: true,
+     *       // Use the id of the person we just inserted.
+     *       owner_id: db
+     *         .selectFrom('new_person')
+     *         .select('id')
+     *     })
+     *     .returning('id')
+     *   )
+     *   .selectFrom(['new_person', 'new_pet'])
+     *   .select([
+     *     'new_person.id as person_id',
+     *     'new_pet.id as pet_id'
+     *   ])
+     *   .execute()
+     * ```
+     *
      * The CTE name can optionally specify column names in addition to
      * a name. In that case Kysely requires the expression to retun
      * rows with the same columns.

package/dist/esm/raw-builder/sql.d.ts

@@ -33,12 +33,12 @@ export interface Sql {
      *     // method to give it an alias.
      *     sql<string>`concat(first_name, ' ', last_name)`.as('full_name')
      *   )
-     *   .where(sql`birthdate between ${date1} and ${date2}`)
+     *   .where(sql<boolean>`birthdate between ${date1} and ${date2}`)
      *   // Here we assume we have list of nicknames for the person
      *   // (a list of strings) and we use the PostgreSQL `@>` operator
      *   // to test if all of them are valid nicknames for the user.
-     *   .where('nicknames', '@>', sql`ARRAY[${sql.join(nicknames)}]`)
-     *   .orderBy(sql`concat(first_name, ' ', last_name)`)
+     *   .where('nicknames', '@>', sql<string[]>`ARRAY[${sql.join(nicknames)}]`)
+     *   .orderBy(sql<string>`concat(first_name, ' ', last_name)`)
      *   .execute()
      * ```
      *
@@ -63,7 +63,7 @@ export interface Sql {
      *
      * ```ts
      * const petName = db.selectFrom('pet').select('name').limit(1)
-     * const fullName = sql`concat(first_name, ' ', last_name)`
+     * const fullName = sql<string>`concat(first_name, ' ', last_name)`
      *
      * sql`
      *   select ${fullName} as full_name, ${petName} as pet_name
@@ -301,7 +301,7 @@ export interface Sql {
      *   return db
      *     .selectFrom('person')
      *     .selectAll()
-     *     .where('nicknames', '@>', sql`ARRAY[${sql.join(nicknames)}]`)
+     *     .where('nicknames', '@>', sql<string[]>`ARRAY[${sql.join(nicknames)}]`)
      *     .execute()
      * }
      * ```

package/dist/esm/schema/alter-column-builder.js

@@ -2,6 +2,7 @@
 import { AlterColumnNode } from '../operation-node/alter-column-node.js';
 import { parseDataTypeExpression, } from '../parser/data-type-parser.js';
 import { parseDefaultValueExpression, } from '../parser/default-value-parser.js';
+import { preventAwait } from '../util/prevent-await.js';
 export class AlterColumnBuilder {
     #column;
     constructor(column) {
@@ -30,6 +31,7 @@ export class AlterColumnBuilder {
         return func(this);
     }
 }
+preventAwait(AlterColumnBuilder, "don't await AlterColumnBuilder instances");
 /**
  * Allows us to force consumers to do exactly one alteration to a column.
  *
@@ -54,3 +56,4 @@ export class AlteredColumnBuilder {
         return this.#alterColumnNode;
     }
 }
+preventAwait(AlteredColumnBuilder, "don't await AlteredColumnBuilder instances");

package/dist/esm/schema/alter-table-add-index-builder.d.ts

@@ -72,7 +72,7 @@ export declare class AlterTableAddIndexBuilder implements OperationNodeSource, C
      * await db.schema
      *   .alterTable('person')
      *   .addIndex('person_first_name_index')
-     *   .expression(sql`(first_name < 'Sami')`)
+     *   .expression(sql<boolean>`(first_name < 'Sami')`)
      *   .execute()
      * ```
      *

package/dist/esm/schema/alter-table-add-index-builder.js

@@ -2,7 +2,7 @@
 import { AddIndexNode } from '../operation-node/add-index-node.js';
 import { AlterTableNode } from '../operation-node/alter-table-node.js';
 import { RawNode } from '../operation-node/raw-node.js';
-import { parseOrderedColumnName } from '../parser/reference-parser.js';
+import { parseOrderedColumnName, } from '../parser/reference-parser.js';
 import { freeze } from '../util/object-utils.js';
 import { preventAwait } from '../util/prevent-await.js';
 export class AlterTableAddIndexBuilder {
@@ -50,7 +50,9 @@ export class AlterTableAddIndexBuilder {
         return new AlterTableAddIndexBuilder({
             ...this.#props,
             node: AlterTableNode.cloneWithTableProps(this.#props.node, {
-                addIndex: AddIndexNode.cloneWithColumns(this.#props.node.addIndex, [parseOrderedColumnName(column)]),
+                addIndex: AddIndexNode.cloneWithColumns(this.#props.node.addIndex, [
+                    parseOrderedColumnName(column),
+                ]),
             }),
         });
     }
@@ -95,7 +97,7 @@ export class AlterTableAddIndexBuilder {
      * await db.schema
      *   .alterTable('person')
      *   .addIndex('person_first_name_index')
-     *   .expression(sql`(first_name < 'Sami')`)
+     *   .expression(sql<boolean>`(first_name < 'Sami')`)
      *   .execute()
      * ```
      *
@@ -109,7 +111,9 @@ export class AlterTableAddIndexBuilder {
         return new AlterTableAddIndexBuilder({
             ...this.#props,
             node: AlterTableNode.cloneWithTableProps(this.#props.node, {
-                addIndex: AddIndexNode.cloneWithColumns(this.#props.node.addIndex, [expression.toOperationNode()]),
+                addIndex: AddIndexNode.cloneWithColumns(this.#props.node.addIndex, [
+                    expression.toOperationNode(),
+                ]),
             }),
         });
     }

package/dist/esm/schema/alter-table-builder.js

@@ -200,6 +200,7 @@ export class AlterTableBuilder {
         return func(this);
     }
 }
+preventAwait(AlterTableBuilder, "don't await AlterTableBuilder instances");
 export class AlterTableColumnAlteringBuilder {
     #props;
     constructor(props) {
@@ -248,6 +249,4 @@ export class AlterTableColumnAlteringBuilder {
         await this.#props.executor.executeQuery(this.compile(), this.#props.queryId);
     }
 }
-preventAwait(AlterTableBuilder, "don't await AlterTableBuilder instances");
-preventAwait(AlterColumnBuilder, "don't await AlterColumnBuilder instances");
 preventAwait(AlterTableColumnAlteringBuilder, "don't await AlterTableColumnAlteringBuilder instances directly. To execute the query you need to call `execute`");

package/dist/esm/schema/column-definition-builder.d.ts

@@ -14,6 +14,14 @@ export declare class ColumnDefinitionBuilder implements OperationNodeSource {
      * you can use the `serial` or `bigserial` data type instead.
      */
     autoIncrement(): ColumnDefinitionBuilder;
+    /**
+     * Makes the column an identity column.
+     *
+     * This only works on some dialects like MS SQL Server (MSSQL).
+     *
+     * For PostgreSQL's `generated always as identity` use {@link generatedAlwaysAsIdentity}.
+     */
+    identity(): ColumnDefinitionBuilder;
     /**
      * Makes the column the primary key.
      *
@@ -137,7 +145,11 @@ export declare class ColumnDefinitionBuilder implements OperationNodeSource {
      */
     generatedAlwaysAs(expression: Expression<any>): ColumnDefinitionBuilder;
     /**
-     * Adds the `generated always as identity` specifier on supported dialects.
+     * Adds the `generated always as identity` specifier.
+     *
+     * This only works on some dialects like PostgreSQL.
+     *
+     * For MS SQL Server (MSSQL)'s identity column use {@link identity}.
      */
     generatedAlwaysAsIdentity(): ColumnDefinitionBuilder;
     /**
@@ -208,6 +220,11 @@ export declare class ColumnDefinitionBuilder implements OperationNodeSource {
      * ```
      */
     nullsNotDistinct(): ColumnDefinitionBuilder;
+    /**
+     * Adds `if not exists` specifier.
+     * This only works for PostgreSQL.
+     */
+    ifNotExists(): ColumnDefinitionBuilder;
     /**
      * This can be used to add any additional SQL to the end of the column definition.
      *

package/dist/esm/schema/column-definition-builder.js

@@ -24,6 +24,16 @@ export class ColumnDefinitionBuilder {
     autoIncrement() {
         return new ColumnDefinitionBuilder(ColumnDefinitionNode.cloneWith(this.#node, { autoIncrement: true }));
     }
+    /**
+     * Makes the column an identity column.
+     *
+     * This only works on some dialects like MS SQL Server (MSSQL).
+     *
+     * For PostgreSQL's `generated always as identity` use {@link generatedAlwaysAsIdentity}.
+     */
+    identity() {
+        return new ColumnDefinitionBuilder(ColumnDefinitionNode.cloneWith(this.#node, { identity: true }));
+    }
     /**
      * Makes the column the primary key.
      *
@@ -191,7 +201,11 @@ export class ColumnDefinitionBuilder {
         }));
     }
     /**
-     * Adds the `generated always as identity` specifier on supported dialects.
+     * Adds the `generated always as identity` specifier.
+     *
+     * This only works on some dialects like PostgreSQL.
+     *
+     * For MS SQL Server (MSSQL)'s identity column use {@link identity}.
      */
     generatedAlwaysAsIdentity() {
         return new ColumnDefinitionBuilder(ColumnDefinitionNode.cloneWith(this.#node, {
@@ -283,6 +297,13 @@ export class ColumnDefinitionBuilder {
     nullsNotDistinct() {
         return new ColumnDefinitionBuilder(ColumnDefinitionNode.cloneWith(this.#node, { nullsNotDistinct: true }));
     }
+    /**
+     * Adds `if not exists` specifier.
+     * This only works for PostgreSQL.
+     */
+    ifNotExists() {
+        return new ColumnDefinitionBuilder(ColumnDefinitionNode.cloneWith(this.#node, { ifNotExists: true }));
+    }
     /**
      * This can be used to add any additional SQL to the end of the column definition.
      *

package/dist/esm/util/infer-result.d.ts

@@ -1,5 +1,6 @@
 import { DeleteResult } from '../query-builder/delete-result.js';
 import { InsertResult } from '../query-builder/insert-result.js';
+import { MergeResult } from '../query-builder/merge-result.js';
 import { UpdateResult } from '../query-builder/update-result.js';
 import { CompiledQuery } from '../query-compiler/compiled-query.js';
 import { Compilable } from './compilable.js';
@@ -43,5 +44,5 @@ import { Simplify } from './type-utils.js';
  * ```
  */
 export type InferResult<C extends Compilable<any> | CompiledQuery<any>> = C extends Compilable<infer O> ? ResolveResult<O> : C extends CompiledQuery<infer O> ? ResolveResult<O> : never;
-type ResolveResult<O> = O extends InsertResult | UpdateResult | DeleteResult ? O : Simplify<O>[];
+type ResolveResult<O> = O extends InsertResult | UpdateResult | DeleteResult | MergeResult ? O : Simplify<O>[];
 export {};

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

@@ -44,11 +44,17 @@ export function isArrayBufferOrView(obj) {
     return obj instanceof ArrayBuffer || ArrayBuffer.isView(obj);
 }
 export function isPlainObject(obj) {
-    return (isObject(obj) &&
-        !Array.isArray(obj) &&
-        !isDate(obj) &&
-        !isBuffer(obj) &&
-        !isArrayBufferOrView(obj));
+    if (!isObject(obj) || getTag(obj) !== '[object Object]') {
+        return false;
+    }
+    if (Object.getPrototypeOf(obj) === null) {
+        return true;
+    }
+    let proto = obj;
+    while (Object.getPrototypeOf(proto) !== null) {
+        proto = Object.getPrototypeOf(proto);
+    }
+    return Object.getPrototypeOf(obj) === proto;
 }
 export function getLast(arr) {
     return arr[arr.length - 1];
@@ -126,3 +132,10 @@ function compareGenericObjects(obj1, obj2) {
     }
     return true;
 }
+const toString = Object.prototype.toString;
+function getTag(value) {
+    if (value == null) {
+        return value === undefined ? '[object Undefined]' : '[object Null]';
+    }
+    return toString.call(value);
+}

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

@@ -2,6 +2,7 @@ import { InsertResult } from '../query-builder/insert-result.js';
 import { DeleteResult } from '../query-builder/delete-result.js';
 import { UpdateResult } from '../query-builder/update-result.js';
 import { KyselyTypeError } from './type-error.js';
+import { MergeResult } from '../query-builder/merge-result.js';
 /**
  * Given a database type and a union of table names in that db, returns
  * a union type with all possible column names.
@@ -88,8 +89,8 @@ export type AnyAliasedColumnWithTable<DB, TB extends keyof DB> = `${AnyColumnWit
  * Extracts the item type of an array.
  */
 export type ArrayItemType<T> = T extends ReadonlyArray<infer I> ? I : never;
-export type SimplifySingleResult<O> = O extends InsertResult ? O : O extends DeleteResult ? O : O extends UpdateResult ? O : Simplify<O> | undefined;
-export type SimplifyResult<O> = O extends InsertResult ? O : O extends DeleteResult ? O : O extends UpdateResult ? O : Simplify<O>;
+export type SimplifySingleResult<O> = O extends InsertResult ? O : O extends DeleteResult ? O : O extends UpdateResult ? O : O extends MergeResult ? O : Simplify<O> | undefined;
+export type SimplifyResult<O> = O extends InsertResult ? O : O extends DeleteResult ? O : O extends UpdateResult ? O : O extends MergeResult ? O : Simplify<O>;
 export type Simplify<T> = DrainOuterGeneric<{
     [K in keyof T]: T[K];
 } & {}>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "kysely",
-  "version": "0.27.2",
+  "version": "0.27.4",
   "description": "Type safe SQL query builder",
   "repository": {
     "type": "git",
@@ -40,20 +40,21 @@
   },
   "scripts": {
     "clean": "rm -rf dist & rm -rf test/node/dist & rm -rf test/browser/bundle.js & rm -rf helpers",
-    "test": "npm run build && npm run test:node:build && npm run test:node:run && npm run test:typings && npm run test:esmimports",
+    "test": "npm run build && npm run test:node:build && npm run test:node:run && npm run test:typings && npm run test:esmimports && npm run test:exports",
     "test:node:build": "tsc -p test/node",
     "test:node": "npm run build && npm run test:node:build && npm run test:node:run",
     "test:node:run": "mocha --timeout 15000 test/node/dist/**/*.test.js",
     "test:browser:build": "rm -rf test/browser/bundle.js && esbuild test/browser/main.ts --bundle --outfile=test/browser/bundle.js",
     "test:browser": "npm run build && npm run test:browser:build && node test/browser/test.js",
-    "test:bun": "npm run build && cd test/bun && bun install && bun run test",
+    "test:bun": "npm run build && bun link && cd test/bun && bun install && bun run test",
     "test:cloudflare-workers": "npm run build && cd test/cloudflare-workers && npm ci && npm test",
     "test:deno": "npm run build && deno run --allow-env --allow-read --allow-net test/deno/local.test.ts && deno run --allow-env --allow-read --allow-net test/deno/cdn.test.ts",
     "test:typings": "tsd test/typings",
     "test:esmimports": "node scripts/check-esm-imports.js",
     "test:esbuild": "esbuild --bundle --platform=node --external:pg-native dist/esm/index.js --outfile=/dev/null",
+    "test:exports": "node scripts/check-exports.js",
     "prettier": "prettier --write 'src/**/*.ts' 'test/**/*.ts'",
-    "build": "npm run clean && npm run build:esm && npm run build:cjs && npm run script:module-fixup && npm run script:copy-interface-doc",
+    "build": "npm run clean && (npm run build:esm & npm run build:cjs) && npm run script:module-fixup && npm run script:copy-interface-doc",
     "build:esm": "tsc -p tsconfig.json && npm run script:add-deno-type-references",
     "build:cjs": "tsc -p tsconfig-cjs.json",
     "script:module-fixup": "node scripts/module-fixup.js",
@@ -69,31 +70,32 @@
     "Igal Klebanov <igalklebanov@gmail.com>"
   ],
   "devDependencies": {
-    "@types/better-sqlite3": "^7.6.4",
-    "@types/chai": "^4.3.5",
-    "@types/chai-as-promised": "^7.1.5",
-    "@types/chai-subset": "^1.3.3",
-    "@types/mocha": "^10.0.1",
+    "@types/better-sqlite3": "^7.6.8",
+    "@types/chai": "^4.3.11",
+    "@types/chai-as-promised": "^7.1.8",
+    "@types/chai-subset": "^1.3.5",
+    "@types/mocha": "^10.0.6",
     "@types/node": "^18.15.11",
-    "@types/pg": "^8.10.2",
-    "@types/pg-cursor": "^2.7.0",
-    "@types/sinon": "^10.0.15",
+    "@types/pg": "^8.10.9",
+    "@types/pg-cursor": "^2.7.2",
+    "@types/sinon": "^17.0.2",
     "@types/tedious": "^4.0.9",
-    "better-sqlite3": "^8.4.0",
-    "chai": "^4.3.7",
+    "better-sqlite3": "^9.6.0",
+    "chai": "^4.4.0",
     "chai-as-promised": "^7.1.1",
     "chai-subset": "^1.6.0",
-    "esbuild": "^0.17.19",
+    "esbuild": "^0.19.11",
+    "lodash": "^4.17.21",
     "mocha": "^10.2.0",
-    "mysql2": "^3.3.3",
-    "pg": "^8.11.0",
-    "pg-cursor": "^2.10.0",
-    "playwright": "^1.34.3",
-    "prettier": "^2.8.8",
-    "sinon": "^15.1.0",
+    "mysql2": "^3.6.5",
+    "pg": "^8.11.3",
+    "pg-cursor": "^2.10.3",
+    "playwright": "^1.40.1",
+    "prettier": "^3.1.1",
+    "sinon": "^17.0.1",
     "tarn": "^3.0.2",
-    "tedious": "^16.4.0",
-    "tsd": "^0.28.1",
-    "typescript": "^5.2.2"
+    "tedious": "^18.2.0",
+    "tsd": "^0.30.3",
+    "typescript": "^5.5.2"
   }
 }