kysely 0.26.2 → 0.27.0

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

@@ -13,6 +13,8 @@ import { UniqueConstraintNode } from '../operation-node/unique-constraint-node.j
 import { CheckConstraintNode } from '../operation-node/check-constraint-node.js';
 import { parseTable } from '../parser/table-parser.js';
 import { parseOnCommitAction } from '../parser/on-commit-action-parse.js';
+import { UniqueConstraintNodeBuilder, } from './unique-constraint-builder.js';
+import { parseExpression } from '../parser/expression-parser.js';
 /**
  * This builder can be used to create a `create table` query.
  */
@@ -84,7 +86,7 @@ export class CreateTableBuilder {
      * ```
      *
      * With this method, it's once again good to remember that Kysely just builds the
-     * query and doesn't provide the same API for all databses. For example, some
+     * query and doesn't provide the same API for all databases. For example, some
      * databases like older MySQL don't support the `references` statement in the
      * column definition. Instead foreign key constraints need to be defined in the
      * `create table` query. See the next example:
@@ -143,11 +145,17 @@ export class CreateTableBuilder {
      * ```ts
      * addUniqueConstraint('first_name_last_name_unique', ['first_name', 'last_name'])
      * ```
+     *
+     * In dialects such as PostgreSQL you can specify `nulls not distinct` as follows:
+     * ```ts
+     * addUniqueConstraint('first_name_last_name_unique', ['first_name', 'last_name'], (builder) => builder.nullsNotDistinct())
+     * ```
      */
-    addUniqueConstraint(constraintName, columns) {
+    addUniqueConstraint(constraintName, columns, build = noop) {
+        const uniqueConstraintBuilder = build(new UniqueConstraintNodeBuilder(UniqueConstraintNode.create(columns, constraintName)));
         return new CreateTableBuilder({
             ...this.#props,
-            node: CreateTableNode.cloneWithConstraint(this.#props.node, UniqueConstraintNode.create(columns, constraintName)),
+            node: CreateTableNode.cloneWithConstraint(this.#props.node, uniqueConstraintBuilder.toOperationNode()),
         });
     }
     /**
@@ -270,6 +278,33 @@ export class CreateTableBuilder {
             node: CreateTableNode.cloneWithEndModifier(this.#props.node, modifier.toOperationNode()),
         });
     }
+    /**
+     * Allows to create table from `select` query.
+     *
+     * ### Examples
+     *
+     * ```ts
+     * db.schema.createTable('copy')
+     *   .temporary()
+     *   .as(db.selectFrom('person').select(['first_name', 'last_name']))
+     *   .execute()
+     * ```
+     *
+     * The generated SQL (PostgreSQL):
+     *
+     * ```sql
+     * create temporary table "copy" as
+     * select "first_name", "last_name" from "person"
+     * ```
+     */
+    as(expression) {
+        return new CreateTableBuilder({
+            ...this.#props,
+            node: CreateTableNode.cloneWith(this.#props.node, {
+                selectQuery: parseExpression(expression),
+            }),
+        });
+    }
     /**
      * Calls the given function passing `this` as the only argument.
      *

package/dist/esm/schema/create-view-builder.d.ts

@@ -4,8 +4,8 @@ import { Compilable } from '../util/compilable.js';
 import { QueryExecutor } from '../query-executor/query-executor.js';
 import { QueryId } from '../util/query-id.js';
 import { CreateViewNode } from '../operation-node/create-view-node.js';
-import { AnySelectQueryBuilder } from '../util/type-utils.js';
 import { RawBuilder } from '../raw-builder/raw-builder.js';
+import { SelectQueryBuilder } from '../query-builder/select-query-builder.js';
 export declare class CreateViewBuilder implements OperationNodeSource, Compilable {
     #private;
     constructor(props: CreateViewBuilderProps);
@@ -31,7 +31,7 @@ export declare class CreateViewBuilder implements OperationNodeSource, Compilabl
      * string opening an SQL injection vulnerability. DO NOT pass unchecked user input
      * into the query or raw expression passed to this method!
      */
-    as(query: AnySelectQueryBuilder | RawBuilder<any>): CreateViewBuilder;
+    as(query: SelectQueryBuilder<any, any, any> | RawBuilder<any>): CreateViewBuilder;
     /**
      * Simply calls the provided function passing `this` as the only argument. `$call` returns
      * what the provided function returns.

package/dist/esm/schema/unique-constraint-builder.d.ts

@@ -0,0 +1,14 @@
+import { OperationNodeSource } from '../operation-node/operation-node-source.js';
+import { UniqueConstraintNode } from '../operation-node/unique-constraint-node.js';
+export declare class UniqueConstraintNodeBuilder implements OperationNodeSource {
+    #private;
+    constructor(node: UniqueConstraintNode);
+    toOperationNode(): UniqueConstraintNode;
+    /**
+     * Adds `nulls not distinct` to the unique constraint definition
+     *
+     * Supported by PostgreSQL dialect only
+     */
+    nullsNotDistinct(): UniqueConstraintNodeBuilder;
+}
+export type UniqueConstraintNodeBuilderCallback = (builder: UniqueConstraintNodeBuilder) => UniqueConstraintNodeBuilder;

package/dist/esm/schema/unique-constraint-builder.js

@@ -0,0 +1,21 @@
+/// <reference types="./unique-constraint-builder.d.ts" />
+import { UniqueConstraintNode } from '../operation-node/unique-constraint-node.js';
+import { preventAwait } from '../util/prevent-await.js';
+export class UniqueConstraintNodeBuilder {
+    #node;
+    constructor(node) {
+        this.#node = node;
+    }
+    toOperationNode() {
+        return this.#node;
+    }
+    /**
+     * Adds `nulls not distinct` to the unique constraint definition
+     *
+     * Supported by PostgreSQL dialect only
+     */
+    nullsNotDistinct() {
+        return new UniqueConstraintNodeBuilder(UniqueConstraintNode.cloneWith(this.#node, { nullsNotDistinct: true }));
+    }
+}
+preventAwait(UniqueConstraintNodeBuilder, "don't await UniqueConstraintNodeBuilder instances directly.");

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

@@ -3,6 +3,7 @@ import { InsertResult } from '../query-builder/insert-result.js';
 import { UpdateResult } from '../query-builder/update-result.js';
 import { CompiledQuery } from '../query-compiler/compiled-query.js';
 import { Compilable } from './compilable.js';
+import { Simplify } from './type-utils.js';
 /**
  * A helper type that allows inferring a select/insert/update/delete query's result
  * type from a query builder or compiled query.
@@ -42,5 +43,5 @@ import { Compilable } from './compilable.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 : O[];
+type ResolveResult<O> = O extends InsertResult | UpdateResult | DeleteResult ? O : Simplify<O>[];
 export {};

package/dist/esm/util/log.js

@@ -44,7 +44,11 @@ function defaultLogger(event) {
             console.error(`kysely:error: ${event.error.stack ?? event.error.message}`);
         }
         else {
-            console.error(`kysely:error: ${event}`);
+            console.error(`kysely:error: ${JSON.stringify({
+                error: event.error,
+                query: event.query.sql,
+                queryDurationMillis: event.queryDurationMillis,
+            })}`);
         }
     }
 }

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

@@ -6,7 +6,7 @@ export declare function isNumber(obj: unknown): obj is number;
 export declare function isBoolean(obj: unknown): obj is boolean;
 export declare function isNull(obj: unknown): obj is null;
 export declare function isDate(obj: unknown): obj is Date;
-export declare function isBigInt(obj: unknown): obj is BigInt;
+export declare function isBigInt(obj: unknown): obj is bigint;
 export declare function isBuffer(obj: unknown): obj is {
     length: number;
 };

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

@@ -1,4 +1,3 @@
-import { SelectQueryBuilder } from '../query-builder/select-query-builder.js';
 import { InsertResult } from '../query-builder/insert-result.js';
 import { DeleteResult } from '../query-builder/delete-result.js';
 import { UpdateResult } from '../query-builder/update-result.js';
@@ -34,15 +33,15 @@ import { KyselyTypeError } from './type-error.js';
  * // Columns == 'id' | 'name' | 'species'
  * ```
  */
-export type AnyColumn<DB, TB extends keyof DB> = DrainOuterGeneric<{
+export type AnyColumn<DB, TB extends keyof DB> = {
     [T in TB]: keyof DB[T];
-}[TB] & string>;
+}[TB] & string;
 /**
  * Extracts a column type.
  */
-export type ExtractColumnType<DB, TB extends keyof DB, C> = DrainOuterGeneric<{
+export type ExtractColumnType<DB, TB extends keyof DB, C> = {
     [T in TB]: C extends keyof DB[T] ? DB[T][C] : never;
-}[TB]>;
+}[TB];
 /**
  * Given a database type and a union of table names in that db, returns
  * a union type with all possible `table`.`column` combinations.
@@ -74,29 +73,21 @@ export type ExtractColumnType<DB, TB extends keyof DB, C> = DrainOuterGeneric<{
  * // Columns == 'person.id' | 'pet.name' | 'pet.species'
  * ```
  */
-export type AnyColumnWithTable<DB, TB extends keyof DB> = DrainOuterGeneric<{
-    [T in TB]: T extends string ? keyof DB[T] extends string ? `${T}.${keyof DB[T]}` : never : never;
-}[TB]>;
+export type AnyColumnWithTable<DB, TB extends keyof DB> = {
+    [T in TB]: `${T & string}.${keyof DB[T] & string}`;
+}[TB];
 /**
  * Just like {@link AnyColumn} but with a ` as <string>` suffix.
  */
-export type AnyAliasedColumn<DB, TB extends keyof DB> = DrainOuterGeneric<{
-    [T in TB]: T extends string ? keyof DB[T] extends string ? `${keyof DB[T]} as ${string}` : never : never;
-}[TB]>;
+export type AnyAliasedColumn<DB, TB extends keyof DB> = `${AnyColumn<DB, TB>} as ${string}`;
 /**
  * Just like {@link AnyColumnWithTable} but with a ` as <string>` suffix.
  */
-export type AnyAliasedColumnWithTable<DB, TB extends keyof DB> = DrainOuterGeneric<{
-    [T in TB]: T extends string ? keyof DB[T] extends string ? `${T}.${keyof DB[T]} as ${string}` : never : never;
-}[TB]>;
+export type AnyAliasedColumnWithTable<DB, TB extends keyof DB> = `${AnyColumnWithTable<DB, TB>} as ${string}`;
 /**
  * Extracts the item type of an array.
  */
 export type ArrayItemType<T> = T extends ReadonlyArray<infer I> ? I : never;
-/**
- * Any select query builder.
- */
-export type AnySelectQueryBuilder = SelectQueryBuilder<any, any, any>;
 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 Simplify<T> = DrainOuterGeneric<{
@@ -124,9 +115,25 @@ 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 NarrowPartial<S, T> = DrainOuterGeneric<T extends object ? {
-    [K in keyof S & string]: K extends keyof T ? T[K] extends S[K] ? T[K] : KyselyTypeError<`$narrowType() call failed: passed type does not exist in '${K}'s type union`> : S[K];
+export type NarrowPartial<O, T> = DrainOuterGeneric<T extends object ? {
+    [K in keyof O & string]: K extends keyof T ? T[K] extends NotNull ? Exclude<O[K], null> : T[K] extends O[K] ? T[K] : KyselyTypeError<`$narrowType() call failed: passed type does not exist in '${K}'s type union`> : O[K];
 } : never>;
+/**
+ * A type constant for marking a column as not null. Can be used with `$narrowPartial`.
+ *
+ * Example:
+ *
+ * ```ts
+ * const person = await db.selectFrom('person')
+ *   .where('nullable_column', 'is not', null)
+ *   .selectAll()
+ *   .$narrowType<{ nullable_column: NotNull }>()
+ *   .executeTakeFirstOrThrow()
+ * ```
+ */
+export type NotNull = {
+    readonly __notNull__: unique symbol;
+};
 export type SqlBool = boolean | 0 | 1;
 /**
  * Utility to reduce depth of TypeScript's internal type instantiation stack.

package/helpers/mssql.d.ts

@@ -0,0 +1 @@
+export * from '../dist/cjs/helpers/mssql.js'

package/helpers/mssql.js

@@ -0,0 +1 @@
+module.exports = require('../dist/cjs/helpers/mssql.js')

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "kysely",
-  "version": "0.26.2",
+  "version": "0.27.0",
   "description": "Type safe SQL query builder",
   "repository": {
     "type": "git",
@@ -27,6 +27,11 @@
       "require": "./dist/cjs/helpers/mysql.js",
       "default": "./dist/cjs/helpers/mysql.js"
     },
+    "./helpers/mssql": {
+      "import": "./dist/esm/helpers/mssql.js",
+      "require": "./dist/cjs/helpers/mssql.js",
+      "default": "./dist/cjs/helpers/mssql.js"
+    },
     "./helpers/sqlite": {
       "import": "./dist/esm/helpers/sqlite.js",
       "require": "./dist/cjs/helpers/sqlite.js",
@@ -37,10 +42,11 @@
     "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 && concurrently -n node,typings,esmimports \"npm run test:node\" \"npm run test:typings\" \"npm run test:esmimports\"",
     "test:node:build": "tsc -p test/node",
-    "test:node": "concurrently -n postgres,mysql,sqlite \"npm run test:node:postgres\" \"npm run test:node:mysql\" \"npm run test:node:sqlite\"",
-    "test:node:postgres": "DIALECT=postgres npm run test:node:run",
-    "test:node:mysql": "DIALECT=mysql npm run test:node:run",
-    "test:node:sqlite": "DIALECT=sqlite npm run test:node:run",
+    "test:node": "concurrently -n postgres,mysql,mssql,sqlite \"npm run test:node:postgres\" \"npm run test:node:mysql\" \"npm run test:node:mssql\" \"npm run test:node:sqlite\"",
+    "test:node:postgres": "cross-env DIALECT=postgres npm run test:node:run",
+    "test:node:mysql": "cross-env DIALECT=mysql npm run test:node:run",
+    "test:node:mssql": "cross-env DIALECT=mssql npm run test:node:run",
+    "test:node:sqlite": "cross-env DIALECT=sqlite npm run test:node:run",
     "test:node:run": "mocha --reporter min --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",
@@ -63,6 +69,7 @@
   "author": "Sami Koskimäki <sami@jakso.me>",
   "license": "MIT",
   "contributors": [
+    "Sami Koskimäki <sami@jakso.me>",
     "Igal Klebanov <igalklebanov@gmail.com>"
   ],
   "devDependencies": {
@@ -75,11 +82,13 @@
     "@types/pg": "^8.10.2",
     "@types/pg-cursor": "^2.7.0",
     "@types/sinon": "^10.0.15",
+    "@types/tedious": "^4.0.9",
     "better-sqlite3": "^8.4.0",
     "chai": "^4.3.7",
     "chai-as-promised": "^7.1.1",
     "chai-subset": "^1.6.0",
     "concurrently": "^8.1.0",
+    "cross-env": "^7.0.3",
     "esbuild": "^0.17.19",
     "mocha": "^10.2.0",
     "mysql2": "^3.3.3",
@@ -88,7 +97,9 @@
     "playwright": "^1.34.3",
     "prettier": "^2.8.8",
     "sinon": "^15.1.0",
+    "tarn": "^3.0.2",
+    "tedious": "^16.4.0",
     "tsd": "^0.28.1",
-    "typescript": "^5.1.6"
+    "typescript": "^5.2.2"
   }
 }