kysely 0.24.2 → 0.26.0

package/dist/esm/query-builder/case-builder.d.ts

@@ -0,0 +1,111 @@
+import { Expression } from '../expression/expression.js';
+import { ExpressionWrapper } from '../expression/expression-wrapper.js';
+import { ReferenceExpression } from '../parser/reference-parser.js';
+import { CaseNode } from '../operation-node/case-node.js';
+import { ComparisonOperatorExpression, OperandValueExpressionOrList } from '../parser/binary-operation-parser.js';
+import { KyselyTypeError } from '../util/type-error.js';
+export declare class CaseBuilder<DB, TB extends keyof DB, W = unknown, O = never> implements Whenable<DB, TB, W, O> {
+    #private;
+    constructor(props: CaseBuilderProps);
+    /**
+     * Adds a `when` clause to the case statement.
+     *
+     * A `when` call must be followed by a {@link CaseThenBuilder.then} call.
+     */
+    when<RE extends ReferenceExpression<DB, TB>>(lhs: unknown extends W ? RE : KyselyTypeError<'when(lhs, op, rhs) is not supported when using case(value)'>, op: ComparisonOperatorExpression, rhs: OperandValueExpressionOrList<DB, TB, RE>): CaseThenBuilder<DB, TB, W, O>;
+    when(expression: Expression<W>): CaseThenBuilder<DB, TB, W, O>;
+    when(value: unknown extends W ? KyselyTypeError<'when(value) is only supported when using case(value)'> : W): CaseThenBuilder<DB, TB, W, O>;
+}
+interface CaseBuilderProps {
+    readonly node: CaseNode;
+}
+export declare class CaseThenBuilder<DB, TB extends keyof DB, W, O> {
+    #private;
+    constructor(props: CaseBuilderProps);
+    /**
+     * Adds a `then` clause to the `case` statement.
+     *
+     * A `then` call can be followed by {@link Whenable.when}, {@link CaseWhenBuilder.else},
+     * {@link CaseWhenBuilder.end} or {@link CaseWhenBuilder.endCase} call.
+     */
+    then<O2>(expression: Expression<O2>): CaseWhenBuilder<DB, TB, W, O | O2>;
+    then<V>(value: V): CaseWhenBuilder<DB, TB, W, O | V>;
+}
+export declare class CaseWhenBuilder<DB, TB extends keyof DB, W, O> implements Whenable<DB, TB, W, O>, Endable<DB, TB, O | null> {
+    #private;
+    constructor(props: CaseBuilderProps);
+    /**
+     * Adds a `when` clause to the case statement.
+     *
+     * A `when` call must be followed by a {@link CaseThenBuilder.then} call.
+     */
+    when<RE extends ReferenceExpression<DB, TB>>(lhs: unknown extends W ? RE : KyselyTypeError<'when(lhs, op, rhs) is not supported when using case(value)'>, op: ComparisonOperatorExpression, rhs: OperandValueExpressionOrList<DB, TB, RE>): CaseThenBuilder<DB, TB, W, O>;
+    when(expression: Expression<W>): CaseThenBuilder<DB, TB, W, O>;
+    when(value: unknown extends W ? KyselyTypeError<'when(value) is only supported when using case(value)'> : W): CaseThenBuilder<DB, TB, W, O>;
+    /**
+     * Adds an `else` clause to the `case` statement.
+     *
+     * An `else` call must be followed by an {@link Endable.end} or {@link Endable.endCase} call.
+     */
+    else<O2>(expression: Expression<O2>): CaseEndBuilder<DB, TB, O | O2>;
+    else<V>(value: V): CaseEndBuilder<DB, TB, O | V>;
+    /**
+     * Adds an `end` keyword to the case operator.
+     *
+     * `case` operators can only be used as part of a query.
+     * For a `case` statement used as part of a stored program, use {@link endCase} instead.
+     */
+    end(): ExpressionWrapper<DB, TB, O | null>;
+    /**
+     * Adds `end case` keywords to the case statement.
+     *
+     * `case` statements can only be used for flow control in stored programs.
+     * For a `case` operator used as part of a query, use {@link end} instead.
+     */
+    endCase(): ExpressionWrapper<DB, TB, O | null>;
+}
+export declare class CaseEndBuilder<DB, TB extends keyof DB, O> implements Endable<DB, TB, O> {
+    #private;
+    constructor(props: CaseBuilderProps);
+    /**
+     * Adds an `end` keyword to the case operator.
+     *
+     * `case` operators can only be used as part of a query.
+     * For a `case` statement used as part of a stored program, use {@link endCase} instead.
+     */
+    end(): ExpressionWrapper<DB, TB, O>;
+    /**
+     * Adds `end case` keywords to the case statement.
+     *
+     * `case` statements can only be used for flow control in stored programs.
+     * For a `case` operator used as part of a query, use {@link end} instead.
+     */
+    endCase(): ExpressionWrapper<DB, TB, O>;
+}
+interface Whenable<DB, TB extends keyof DB, W, O> {
+    /**
+     * Adds a `when` clause to the case statement.
+     *
+     * A `when` call must be followed by a {@link CaseThenBuilder.then} call.
+     */
+    when<RE extends ReferenceExpression<DB, TB>>(lhs: unknown extends W ? RE : KyselyTypeError<'when(lhs, op, rhs) is not supported when using case(value)'>, op: ComparisonOperatorExpression, rhs: OperandValueExpressionOrList<DB, TB, RE>): CaseThenBuilder<DB, TB, W, O>;
+    when(expression: Expression<W>): CaseThenBuilder<DB, TB, W, O>;
+    when(value: unknown extends W ? KyselyTypeError<'when(value) is only supported when using case(value)'> : W): CaseThenBuilder<DB, TB, W, O>;
+}
+interface Endable<DB, TB extends keyof DB, O> {
+    /**
+     * Adds an `end` keyword to the case operator.
+     *
+     * `case` operators can only be used as part of a query.
+     * For a `case` statement used as part of a stored program, use {@link endCase} instead.
+     */
+    end(): ExpressionWrapper<DB, TB, O>;
+    /**
+     * Adds `end case` keywords to the case statement.
+     *
+     * `case` statements can only be used for flow control in stored programs.
+     * For a `case` operator used as part of a query, use {@link end} instead.
+     */
+    endCase(): ExpressionWrapper<DB, TB, O>;
+}
+export {};

package/dist/esm/query-builder/case-builder.js

@@ -0,0 +1,69 @@
+/// <reference types="./case-builder.d.ts" />
+import { ExpressionWrapper } from '../expression/expression-wrapper.js';
+import { freeze } from '../util/object-utils.js';
+import { CaseNode } from '../operation-node/case-node.js';
+import { WhenNode } from '../operation-node/when-node.js';
+import { parseFilter, } from '../parser/binary-operation-parser.js';
+import { parseValueExpression } from '../parser/value-parser.js';
+export class CaseBuilder {
+    #props;
+    constructor(props) {
+        this.#props = freeze(props);
+    }
+    when(...args) {
+        return new CaseThenBuilder({
+            ...this.#props,
+            node: CaseNode.cloneWithWhen(this.#props.node, WhenNode.create(parseFilter(args))),
+        });
+    }
+}
+export class CaseThenBuilder {
+    #props;
+    constructor(props) {
+        this.#props = freeze(props);
+    }
+    then(valueExpression) {
+        return new CaseWhenBuilder({
+            ...this.#props,
+            node: CaseNode.cloneWithThen(this.#props.node, parseValueExpression(valueExpression)),
+        });
+    }
+}
+export class CaseWhenBuilder {
+    #props;
+    constructor(props) {
+        this.#props = freeze(props);
+    }
+    when(...args) {
+        return new CaseThenBuilder({
+            ...this.#props,
+            node: CaseNode.cloneWithWhen(this.#props.node, WhenNode.create(parseFilter(args))),
+        });
+    }
+    else(valueExpression) {
+        return new CaseEndBuilder({
+            ...this.#props,
+            node: CaseNode.cloneWith(this.#props.node, {
+                else: parseValueExpression(valueExpression),
+            }),
+        });
+    }
+    end() {
+        return new ExpressionWrapper(CaseNode.cloneWith(this.#props.node, { isStatement: false }));
+    }
+    endCase() {
+        return new ExpressionWrapper(CaseNode.cloneWith(this.#props.node, { isStatement: true }));
+    }
+}
+export class CaseEndBuilder {
+    #props;
+    constructor(props) {
+        this.#props = freeze(props);
+    }
+    end() {
+        return new ExpressionWrapper(CaseNode.cloneWith(this.#props.node, { isStatement: false }));
+    }
+    endCase() {
+        return new ExpressionWrapper(CaseNode.cloneWith(this.#props.node, { isStatement: true }));
+    }
+}

package/dist/esm/query-builder/delete-query-builder.d.ts

@@ -6,7 +6,7 @@ import { SelectExpression, SelectArg } from '../parser/select-parser.js';
 import { ReturningAllRow, ReturningRow } from '../parser/returning-parser.js';
 import { ReferenceExpression } from '../parser/reference-parser.js';
 import { QueryNode } from '../operation-node/query-node.js';
-import { MergePartial, Nullable, SimplifyResult, SimplifySingleResult } from '../util/type-utils.js';
+import { DrainOuterGeneric, NarrowPartial, Nullable, ShallowRecord, SimplifyResult, SimplifySingleResult } from '../util/type-utils.js';
 import { Compilable } from '../util/compilable.js';
 import { QueryExecutor } from '../query-executor/query-executor.js';
 import { QueryId } from '../util/query-id.js';
@@ -20,7 +20,6 @@ import { OrderByDirectionExpression, OrderByExpression } from '../parser/order-b
 import { Explainable, ExplainFormat } from '../util/explainable.js';
 import { AliasedExpression, Expression } from '../expression/expression.js';
 import { ComparisonOperatorExpression, OperandValueExpressionOrList } from '../parser/binary-operation-parser.js';
-import { ExistsExpression } from '../parser/unary-operation-parser.js';
 import { KyselyTypeError } from '../util/type-error.js';
 import { Streamable } from '../util/streamable.js';
 export declare class DeleteQueryBuilder<DB, TB extends keyof DB, O> implements WhereInterface<DB, TB>, ReturningInterface<DB, TB, O>, OperationNodeSource, Compilable<O>, Explainable, Streamable<O> {
@@ -35,6 +34,10 @@ export declare class DeleteQueryBuilder<DB, TB extends keyof DB, O> implements W
      *
      * ### Examples
      *
+     * <!-- siteExample("where", "Simple where clause", 10) -->
+     *
+     * `where` method calls are combined with `AND`:
+     *
      * ```ts
      * const person = await db
      *   .selectFrom('person')
@@ -57,9 +60,65 @@ export declare class DeleteQueryBuilder<DB, TB extends keyof DB, O> implements W
      * sql`your operator`
      * ```
      *
+     * <!-- siteExample("where", "Where in", 20) -->
+     *
+     * Find multiple items using a list of identifiers:
+     *
+     * ```ts
+     * const persons = await db
+     *   .selectFrom('person')
+     *   .selectAll()
+     *   .where('id', 'in', ['1', '2', '3'])
+     *   .execute()
+     * ```
+     *
+     * The generated SQL (PostgreSQL):
+     *
+     * ```sql
+     * select * from "person" where "id" in ($1, $2, $3)
+     * ```
+     *
+     * <!-- siteExample("where", "OR where", 30) -->
+     *
+     * To combine conditions using `OR`, you can use the expression builder:
+     *
+     * ```ts
+     * const persons = await db
+     *   .selectFrom('person')
+     *   .selectAll()
+     *   .where(({ or, and, cmpr }) => or([
+     *     and([
+     *       cmpr('first_name', '=', 'Jennifer'),
+     *       cmpr('last_name', '=', 'Aniston')
+     *     ]),
+     *     and([
+     *       cmpr('first_name', '=', 'Sylvester'),
+     *       cmpr('last_name', '=', 'Stallone')
+     *     ])
+     *   ]))
+     *   .execute()
+     * ```
+     *
+     * The generated SQL (PostgreSQL):
+     *
+     * ```sql
+     * select *
+     * from "person"
+     * where (
+     *   ("first_name" = $1 AND "last_name" = $2)
+     *   OR
+     *   ("first_name" = $3 AND "last_name" = $4)
+     * )
+     * ```
+     *
+     * <!-- siteExample("where", "Conditional where calls", 40) -->
+     *
      * You can add expressions conditionally like this:
      *
      * ```ts
+     * const firstName: string | undefined = 'Jennifer'
+     * const lastName: string | undefined = 'Aniston'
+     *
      * let query = db
      *   .selectFrom('person')
      *   .selectAll()
@@ -126,22 +185,30 @@ export declare class DeleteQueryBuilder<DB, TB extends keyof DB, O> implements W
      * select * from "person" where "id" in ($1, $2, $3)
      * ```
      *
+     * <!-- siteExample("where", "Complex where clause", 50) -->
+     *
      * For complex `where` expressions you can pass in a single callback and
-     * use the {@link ExpressionBuilder} to build your expression:
+     * use the `ExpressionBuilder` to build your expression:
      *
      * ```ts
+     * const firstName = 'Jennifer'
+     * const maxAge = 60
+     *
      * const persons = await db
      *   .selectFrom('person')
      *   .selectAll('person')
-     *   .where(({ cmpr, or, and, not, exists, selectFrom, val }) => and([
+     *   .where(({ cmpr, or, and, not, exists, selectFrom }) => and([
      *     or([
      *       cmpr('first_name', '=', firstName),
      *       cmpr('age', '<', maxAge)
      *     ]),
      *     not(exists(
-     *       selectFrom('pet').select('pet.id').whereRef('pet.owner_id', '=', 'person.id')
+     *       selectFrom('pet')
+     *         .select('pet.id')
+     *         .whereRef('pet.owner_id', '=', 'person.id')
      *     ))
      *   ]))
+     *   .execute()
      * ```
      *
      * The generated SQL (PostgreSQL):
@@ -262,32 +329,6 @@ export declare class DeleteQueryBuilder<DB, TB extends keyof DB, O> implements W
      * from "person"
      */
     whereRef(lhs: ReferenceExpression<DB, TB>, op: ComparisonOperatorExpression, rhs: ReferenceExpression<DB, TB>): DeleteQueryBuilder<DB, TB, O>;
-    /**
-     * @deprecated Follow [these](https://github.com/koskimas/kysely/releases/tag/0.24.0) instructions to migrate
-     */
-    orWhere<RE extends ReferenceExpression<DB, TB>>(lhs: RE, op: ComparisonOperatorExpression, rhs: OperandValueExpressionOrList<DB, TB, RE>): DeleteQueryBuilder<DB, TB, O>;
-    orWhere(factory: WhereExpressionFactory<DB, TB>): DeleteQueryBuilder<DB, TB, O>;
-    orWhere(expression: Expression<any>): DeleteQueryBuilder<DB, TB, O>;
-    /**
-     * @deprecated Follow [these](https://github.com/koskimas/kysely/releases/tag/0.24.0) instructions to migrate
-     */
-    orWhereRef(lhs: ReferenceExpression<DB, TB>, op: ComparisonOperatorExpression, rhs: ReferenceExpression<DB, TB>): DeleteQueryBuilder<DB, TB, O>;
-    /**
-     * @deprecated Follow [these](https://github.com/koskimas/kysely/releases/tag/0.24.0) instructions to migrate
-     */
-    whereExists(arg: ExistsExpression<DB, TB>): DeleteQueryBuilder<DB, TB, O>;
-    /**
-     * @deprecated Follow [these](https://github.com/koskimas/kysely/releases/tag/0.24.0) instructions to migrate
-     */
-    whereNotExists(arg: ExistsExpression<DB, TB>): DeleteQueryBuilder<DB, TB, O>;
-    /**
-     * @deprecated Follow [these](https://github.com/koskimas/kysely/releases/tag/0.24.0) instructions to migrate
-     */
-    orWhereExists(arg: ExistsExpression<DB, TB>): DeleteQueryBuilder<DB, TB, O>;
-    /**
-     * @deprecated Follow [these](https://github.com/koskimas/kysely/releases/tag/0.24.0) instructions to migrate
-     */
-    orWhereNotExists(arg: ExistsExpression<DB, TB>): DeleteQueryBuilder<DB, TB, O>;
     /**
      * Clears all where expressions from the query.
      *
@@ -560,7 +601,7 @@ export declare class DeleteQueryBuilder<DB, TB extends keyof DB, O> implements W
      *     first_name: 'Jennifer',
      *     last_name: 'Aniston'
      *   })
-     *   .returning(eb => [
+     *   .returning((eb) => [
      *     'id as id',
      *     sql<string>`concat(first_name, ' ', last_name)`.as('full_name'),
      *     eb.selectFrom('pets').select('pet.id').limit(1).as('first_pet_id')
@@ -745,10 +786,6 @@ export declare class DeleteQueryBuilder<DB, TB extends keyof DB, O> implements W
      * ```
      */
     $call<T>(func: (qb: this) => T): T;
-    /**
-     * @deprecated Use `$call` instead
-     */
-    call<T>(func: (qb: this) => T): T;
     /**
      * Call `func(this)` if `condition` is true.
      *
@@ -784,11 +821,7 @@ export declare class DeleteQueryBuilder<DB, TB extends keyof DB, O> implements W
      * }
      * ```
      */
-    $if<O2>(condition: boolean, func: (qb: this) => DeleteQueryBuilder<DB, TB, O2>): DeleteQueryBuilder<DB, TB, O2 extends DeleteResult ? DeleteResult : O extends DeleteResult ? Partial<O2> : MergePartial<O, O2>>;
-    /**
-     * @deprecated Use `$if` instead
-     */
-    if<O2>(condition: boolean, func: (qb: this) => DeleteQueryBuilder<DB, TB, O2>): DeleteQueryBuilder<DB, TB, O2 extends DeleteResult ? DeleteResult : O extends DeleteResult ? Partial<O2> : MergePartial<O, O2>>;
+    $if<O2>(condition: boolean, func: (qb: this) => DeleteQueryBuilder<DB, TB, O2>): O2 extends DeleteResult ? DeleteQueryBuilder<DB, TB, DeleteResult> : O2 extends O & infer E ? DeleteQueryBuilder<DB, TB, O & Partial<E>> : DeleteQueryBuilder<DB, TB, Partial<O2>>;
     /**
      * Change the output type of the query.
      *
@@ -797,9 +830,47 @@ export declare class DeleteQueryBuilder<DB, TB extends keyof DB, O> implements W
      */
     $castTo<T>(): DeleteQueryBuilder<DB, TB, T>;
     /**
-     * @deprecated Use `$castTo` instead.
+     * Narrows (parts of) the output type of the query.
+     *
+     * Kysely tries to be as type-safe as possible, but in some cases we have to make
+     * compromises for better maintainability and compilation performance. At present,
+     * Kysely doesn't narrow the output type of the query when using {@link where} and {@link returning} or {@link returningAll}.
+     *
+     * This utility method is very useful for these situations, as it removes unncessary
+     * runtime assertion/guard code. Its input type is limited to the output type
+     * of the query, so you can't add a column that doesn't exist, or change a column's
+     * type to something that doesn't exist in its union type.
+     *
+     * ### Examples
+     *
+     * Turn this code:
+     *
+     * ```ts
+     * const person = await db.deleteFrom('person')
+     *   .where('id', '=', id)
+     *   .where('nullable_column', 'is not', null)
+     *   .returningAll()
+     *   .executeTakeFirstOrThrow()
+     *
+     * if (person.nullable_column) {
+     *   functionThatExpectsPersonWithNonNullValue(person)
+     * }
+     * ```
+     *
+     * Into this:
+     *
+     * ```ts
+     * const person = await db.deleteFrom('person')
+     *   .where('id', '=', id)
+     *   .where('nullable_column', 'is not', null)
+     *   .returningAll()
+     *   .$narrowType<{ nullable_column: string }>()
+     *   .executeTakeFirstOrThrow()
+     *
+     * functionThatExpectsPersonWithNonNullValue(person)
+     * ```
      */
-    castTo<T>(): DeleteQueryBuilder<DB, TB, T>;
+    $narrowType<T>(): DeleteQueryBuilder<DB, TB, NarrowPartial<O, T>>;
     /**
      * Asserts that query's output row type equals the given type `T`.
      *
@@ -842,10 +913,6 @@ export declare class DeleteQueryBuilder<DB, TB extends keyof DB, O> implements W
      * ```
      */
     $assertType<T extends O>(): O extends T ? DeleteQueryBuilder<DB, TB, T> : KyselyTypeError<`$assertType() call failed: The type passed in is not equal to the output type of the query.`>;
-    /**
-     * @deprecated Use `$assertType` instead.
-     */
-    assertType<T extends O>(): O extends T ? DeleteQueryBuilder<DB, TB, T> : KyselyTypeError<`assertType() call failed: The type passed in is not equal to the output type of the query.`>;
     /**
      * Returns a copy of this DeleteQueryBuilder instance with the given plugin installed.
      */
@@ -941,24 +1008,24 @@ export interface DeleteQueryBuilderProps {
     readonly queryNode: DeleteQueryNode;
     readonly executor: QueryExecutor;
 }
-export declare type DeleteQueryBuilderWithInnerJoin<DB, TB extends keyof DB, O, TE extends TableExpression<DB, TB>> = TE extends `${infer T} as ${infer A}` ? T extends keyof DB ? InnerJoinedBuilder<DB, TB, O, A, DB[T]> : never : TE extends keyof DB ? DeleteQueryBuilder<DB, TB | TE, O> : TE extends AliasedExpression<infer QO, infer QA> ? InnerJoinedBuilder<DB, TB, O, QA, QO> : TE extends (qb: any) => AliasedExpression<infer QO, infer QA> ? InnerJoinedBuilder<DB, TB, O, QA, QO> : never;
-declare type InnerJoinedBuilder<DB, TB extends keyof DB, O, A extends string, R> = A extends keyof DB ? DeleteQueryBuilder<InnerJoinedDB<DB, A, R>, TB | A, O> : DeleteQueryBuilder<DB & Record<A, R>, TB | A, O>;
-declare type InnerJoinedDB<DB, A extends string, R> = {
+export type DeleteQueryBuilderWithInnerJoin<DB, TB extends keyof DB, O, TE extends TableExpression<DB, TB>> = TE extends `${infer T} as ${infer A}` ? T extends keyof DB ? InnerJoinedBuilder<DB, TB, O, A, DB[T]> : never : TE extends keyof DB ? DeleteQueryBuilder<DB, TB | TE, O> : TE extends AliasedExpression<infer QO, infer QA> ? InnerJoinedBuilder<DB, TB, O, QA, QO> : TE extends (qb: any) => AliasedExpression<infer QO, infer QA> ? InnerJoinedBuilder<DB, TB, O, QA, QO> : never;
+type InnerJoinedBuilder<DB, TB extends keyof DB, O, A extends string, R> = A extends keyof DB ? DeleteQueryBuilder<InnerJoinedDB<DB, A, R>, TB | A, O> : DeleteQueryBuilder<DB & ShallowRecord<A, R>, TB | A, O>;
+type InnerJoinedDB<DB, A extends string, R> = DrainOuterGeneric<{
     [C in keyof DB | A]: C extends A ? R : C extends keyof DB ? DB[C] : never;
-};
-export declare type DeleteQueryBuilderWithLeftJoin<DB, TB extends keyof DB, O, TE extends TableExpression<DB, TB>> = TE extends `${infer T} as ${infer A}` ? T extends keyof DB ? LeftJoinedBuilder<DB, TB, O, A, DB[T]> : never : TE extends keyof DB ? LeftJoinedBuilder<DB, TB, O, TE, DB[TE]> : TE extends AliasedExpression<infer QO, infer QA> ? LeftJoinedBuilder<DB, TB, O, QA, QO> : TE extends (qb: any) => AliasedExpression<infer QO, infer QA> ? LeftJoinedBuilder<DB, TB, O, QA, QO> : never;
-declare type LeftJoinedBuilder<DB, TB extends keyof DB, O, A extends keyof any, R> = A extends keyof DB ? DeleteQueryBuilder<LeftJoinedDB<DB, A, R>, TB | A, O> : DeleteQueryBuilder<DB & Record<A, Nullable<R>>, TB | A, O>;
-declare type LeftJoinedDB<DB, A extends keyof any, R> = {
+}>;
+export type DeleteQueryBuilderWithLeftJoin<DB, TB extends keyof DB, O, TE extends TableExpression<DB, TB>> = TE extends `${infer T} as ${infer A}` ? T extends keyof DB ? LeftJoinedBuilder<DB, TB, O, A, DB[T]> : never : TE extends keyof DB ? LeftJoinedBuilder<DB, TB, O, TE, DB[TE]> : TE extends AliasedExpression<infer QO, infer QA> ? LeftJoinedBuilder<DB, TB, O, QA, QO> : TE extends (qb: any) => AliasedExpression<infer QO, infer QA> ? LeftJoinedBuilder<DB, TB, O, QA, QO> : never;
+type LeftJoinedBuilder<DB, TB extends keyof DB, O, A extends keyof any, R> = A extends keyof DB ? DeleteQueryBuilder<LeftJoinedDB<DB, A, R>, TB | A, O> : DeleteQueryBuilder<DB & ShallowRecord<A, Nullable<R>>, TB | A, O>;
+type LeftJoinedDB<DB, A extends keyof any, R> = DrainOuterGeneric<{
     [C in keyof DB | A]: C extends A ? Nullable<R> : C extends keyof DB ? DB[C] : never;
-};
-export declare type DeleteQueryBuilderWithRightJoin<DB, TB extends keyof DB, O, TE extends TableExpression<DB, TB>> = TE extends `${infer T} as ${infer A}` ? T extends keyof DB ? RightJoinedBuilder<DB, TB, O, A, DB[T]> : never : TE extends keyof DB ? RightJoinedBuilder<DB, TB, O, TE, DB[TE]> : TE extends AliasedExpression<infer QO, infer QA> ? RightJoinedBuilder<DB, TB, O, QA, QO> : TE extends (qb: any) => AliasedExpression<infer QO, infer QA> ? RightJoinedBuilder<DB, TB, O, QA, QO> : never;
-declare type RightJoinedBuilder<DB, TB extends keyof DB, O, A extends keyof any, R> = DeleteQueryBuilder<RightJoinedDB<DB, TB, A, R>, TB | A, O>;
-declare type RightJoinedDB<DB, TB extends keyof DB, A extends keyof any, R> = {
+}>;
+export type DeleteQueryBuilderWithRightJoin<DB, TB extends keyof DB, O, TE extends TableExpression<DB, TB>> = TE extends `${infer T} as ${infer A}` ? T extends keyof DB ? RightJoinedBuilder<DB, TB, O, A, DB[T]> : never : TE extends keyof DB ? RightJoinedBuilder<DB, TB, O, TE, DB[TE]> : TE extends AliasedExpression<infer QO, infer QA> ? RightJoinedBuilder<DB, TB, O, QA, QO> : TE extends (qb: any) => AliasedExpression<infer QO, infer QA> ? RightJoinedBuilder<DB, TB, O, QA, QO> : never;
+type RightJoinedBuilder<DB, TB extends keyof DB, O, A extends keyof any, R> = DeleteQueryBuilder<RightJoinedDB<DB, TB, A, R>, TB | A, O>;
+type RightJoinedDB<DB, TB extends keyof DB, A extends keyof any, R> = DrainOuterGeneric<{
     [C in keyof DB | A]: C extends A ? R : C extends TB ? Nullable<DB[C]> : C extends keyof DB ? DB[C] : never;
-};
-export declare type DeleteQueryBuilderWithFullJoin<DB, TB extends keyof DB, O, TE extends TableExpression<DB, TB>> = TE extends `${infer T} as ${infer A}` ? T extends keyof DB ? OuterJoinedBuilder<DB, TB, O, A, DB[T]> : never : TE extends keyof DB ? OuterJoinedBuilder<DB, TB, O, TE, DB[TE]> : TE extends AliasedExpression<infer QO, infer QA> ? OuterJoinedBuilder<DB, TB, O, QA, QO> : TE extends (qb: any) => AliasedExpression<infer QO, infer QA> ? OuterJoinedBuilder<DB, TB, O, QA, QO> : never;
-declare type OuterJoinedBuilder<DB, TB extends keyof DB, O, A extends keyof any, R> = DeleteQueryBuilder<OuterJoinedBuilderDB<DB, TB, A, R>, TB | A, O>;
-declare type OuterJoinedBuilderDB<DB, TB extends keyof DB, A extends keyof any, R> = {
+}>;
+export type DeleteQueryBuilderWithFullJoin<DB, TB extends keyof DB, O, TE extends TableExpression<DB, TB>> = TE extends `${infer T} as ${infer A}` ? T extends keyof DB ? OuterJoinedBuilder<DB, TB, O, A, DB[T]> : never : TE extends keyof DB ? OuterJoinedBuilder<DB, TB, O, TE, DB[TE]> : TE extends AliasedExpression<infer QO, infer QA> ? OuterJoinedBuilder<DB, TB, O, QA, QO> : TE extends (qb: any) => AliasedExpression<infer QO, infer QA> ? OuterJoinedBuilder<DB, TB, O, QA, QO> : never;
+type OuterJoinedBuilder<DB, TB extends keyof DB, O, A extends keyof any, R> = DeleteQueryBuilder<OuterJoinedBuilderDB<DB, TB, A, R>, TB | A, O>;
+type OuterJoinedBuilderDB<DB, TB extends keyof DB, A extends keyof any, R> = DrainOuterGeneric<{
     [C in keyof DB | A]: C extends A ? Nullable<R> : C extends TB ? Nullable<DB[C]> : C extends keyof DB ? DB[C] : never;
-};
+}>;
 export {};

package/dist/esm/query-builder/delete-query-builder.js

@@ -10,8 +10,7 @@ import { DeleteResult } from './delete-result.js';
 import { DeleteQueryNode } from '../operation-node/delete-query-node.js';
 import { LimitNode } from '../operation-node/limit-node.js';
 import { parseOrderBy, } from '../parser/order-by-parser.js';
-import { parseReferentialComparison, parseWhere, } from '../parser/binary-operation-parser.js';
-import { parseExists, parseNotExists, } from '../parser/unary-operation-parser.js';
+import { parseFilter, parseReferentialComparison, } from '../parser/binary-operation-parser.js';
 export class DeleteQueryBuilder {
     #props;
     constructor(props) {
@@ -20,7 +19,7 @@ export class DeleteQueryBuilder {
     where(...args) {
         return new DeleteQueryBuilder({
             ...this.#props,
-            queryNode: QueryNode.cloneWithWhere(this.#props.queryNode, parseWhere(args)),
+            queryNode: QueryNode.cloneWithWhere(this.#props.queryNode, parseFilter(args)),
         });
     }
     whereRef(lhs, op, rhs) {
@@ -29,42 +28,6 @@ export class DeleteQueryBuilder {
             queryNode: QueryNode.cloneWithWhere(this.#props.queryNode, parseReferentialComparison(lhs, op, rhs)),
         });
     }
-    orWhere(...args) {
-        return new DeleteQueryBuilder({
-            ...this.#props,
-            queryNode: QueryNode.cloneWithOrWhere(this.#props.queryNode, parseWhere(args)),
-        });
-    }
-    orWhereRef(lhs, op, rhs) {
-        return new DeleteQueryBuilder({
-            ...this.#props,
-            queryNode: QueryNode.cloneWithOrWhere(this.#props.queryNode, parseReferentialComparison(lhs, op, rhs)),
-        });
-    }
-    whereExists(arg) {
-        return new DeleteQueryBuilder({
-            ...this.#props,
-            queryNode: QueryNode.cloneWithWhere(this.#props.queryNode, parseExists(arg)),
-        });
-    }
-    whereNotExists(arg) {
-        return new DeleteQueryBuilder({
-            ...this.#props,
-            queryNode: QueryNode.cloneWithWhere(this.#props.queryNode, parseNotExists(arg)),
-        });
-    }
-    orWhereExists(arg) {
-        return new DeleteQueryBuilder({
-            ...this.#props,
-            queryNode: QueryNode.cloneWithOrWhere(this.#props.queryNode, parseExists(arg)),
-        });
-    }
-    orWhereNotExists(arg) {
-        return new DeleteQueryBuilder({
-            ...this.#props,
-            queryNode: QueryNode.cloneWithOrWhere(this.#props.queryNode, parseNotExists(arg)),
-        });
-    }
     clearWhere() {
         return new DeleteQueryBuilder({
             ...this.#props,
@@ -202,12 +165,6 @@ export class DeleteQueryBuilder {
     $call(func) {
         return func(this);
     }
-    /**
-     * @deprecated Use `$call` instead
-     */
-    call(func) {
-        return this.$call(func);
-    }
     /**
      * Call `func(this)` if `condition` is true.
      *
@@ -251,12 +208,6 @@ export class DeleteQueryBuilder {
             ...this.#props,
         });
     }
-    /**
-     * @deprecated Use `$if` instead
-     */
-    if(condition, func) {
-        return this.$if(condition, func);
-    }
     /**
      * Change the output type of the query.
      *
@@ -267,10 +218,48 @@ export class DeleteQueryBuilder {
         return new DeleteQueryBuilder(this.#props);
     }
     /**
-     * @deprecated Use `$castTo` instead.
+     * Narrows (parts of) the output type of the query.
+     *
+     * Kysely tries to be as type-safe as possible, but in some cases we have to make
+     * compromises for better maintainability and compilation performance. At present,
+     * Kysely doesn't narrow the output type of the query when using {@link where} and {@link returning} or {@link returningAll}.
+     *
+     * This utility method is very useful for these situations, as it removes unncessary
+     * runtime assertion/guard code. Its input type is limited to the output type
+     * of the query, so you can't add a column that doesn't exist, or change a column's
+     * type to something that doesn't exist in its union type.
+     *
+     * ### Examples
+     *
+     * Turn this code:
+     *
+     * ```ts
+     * const person = await db.deleteFrom('person')
+     *   .where('id', '=', id)
+     *   .where('nullable_column', 'is not', null)
+     *   .returningAll()
+     *   .executeTakeFirstOrThrow()
+     *
+     * if (person.nullable_column) {
+     *   functionThatExpectsPersonWithNonNullValue(person)
+     * }
+     * ```
+     *
+     * Into this:
+     *
+     * ```ts
+     * const person = await db.deleteFrom('person')
+     *   .where('id', '=', id)
+     *   .where('nullable_column', 'is not', null)
+     *   .returningAll()
+     *   .$narrowType<{ nullable_column: string }>()
+     *   .executeTakeFirstOrThrow()
+     *
+     * functionThatExpectsPersonWithNonNullValue(person)
+     * ```
      */
-    castTo() {
-        return this.$castTo();
+    $narrowType() {
+        return new DeleteQueryBuilder(this.#props);
     }
     /**
      * Asserts that query's output row type equals the given type `T`.
@@ -316,12 +305,6 @@ export class DeleteQueryBuilder {
     $assertType() {
         return new DeleteQueryBuilder(this.#props);
     }
-    /**
-     * @deprecated Use `$assertType` instead.
-     */
-    assertType() {
-        return new DeleteQueryBuilder(this.#props);
-    }
     /**
      * Returns a copy of this DeleteQueryBuilder instance with the given plugin installed.
      */

package/dist/esm/query-builder/delete-result.d.ts

@@ -1,5 +1,4 @@
 export declare class DeleteResult {
-    #private;
+    readonly numDeletedRows: bigint;
     constructor(numDeletedRows: bigint);
-    get numDeletedRows(): bigint;
 }

package/dist/esm/query-builder/delete-result.js

@@ -1,13 +1,7 @@
 /// <reference types="./delete-result.d.ts" />
 export class DeleteResult {
-    #numDeletedRows;
+    numDeletedRows;
     constructor(numDeletedRows) {
-        this.#numDeletedRows = numDeletedRows;
-    }
-    get numDeletedRows() {
-        return this.#numDeletedRows;
+        this.numDeletedRows = numDeletedRows;
     }
 }
-Object.defineProperty(DeleteResult.prototype, 'numDeletedRows', {
-    enumerable: true,
-});