kysely 0.23.5 → 0.24.0

package/dist/cjs/query-builder/on-conflict-builder.js

@@ -92,9 +92,12 @@ class OnConflictBuilder {
     whereRef(lhs, op, rhs) {
         return new OnConflictBuilder({
             ...this.#props,
-            onConflictNode: on_conflict_node_js_1.OnConflictNode.cloneWithIndexWhere(this.#props.onConflictNode, (0, binary_operation_parser_js_1.parseReferentialFilter)(lhs, op, rhs)),
+            onConflictNode: on_conflict_node_js_1.OnConflictNode.cloneWithIndexWhere(this.#props.onConflictNode, (0, binary_operation_parser_js_1.parseReferentialComparison)(lhs, op, rhs)),
         });
     }
+    /**
+     * @deprecated Follow [these](https://github.com/koskimas/kysely/releases/tag/0.24.0) instructions to migrate
+     */
     orWhere(...args) {
         return new OnConflictBuilder({
             ...this.#props,
@@ -102,20 +105,16 @@ class OnConflictBuilder {
         });
     }
     /**
-     * Specify an index predicate for the index target.
-     *
-     * See {@link WhereInterface.orWhereRef} for more info.
+     * @deprecated Follow [these](https://github.com/koskimas/kysely/releases/tag/0.24.0) instructions to migrate
      */
     orWhereRef(lhs, op, rhs) {
         return new OnConflictBuilder({
             ...this.#props,
-            onConflictNode: on_conflict_node_js_1.OnConflictNode.cloneWithIndexOrWhere(this.#props.onConflictNode, (0, binary_operation_parser_js_1.parseReferentialFilter)(lhs, op, rhs)),
+            onConflictNode: on_conflict_node_js_1.OnConflictNode.cloneWithIndexOrWhere(this.#props.onConflictNode, (0, binary_operation_parser_js_1.parseReferentialComparison)(lhs, op, rhs)),
         });
     }
     /**
-     * Specify an index predicate for the index target.
-     *
-     * See {@link WhereInterface.whereExists} for more info.
+     * @deprecated Follow [these](https://github.com/koskimas/kysely/releases/tag/0.24.0) instructions to migrate
      */
     whereExists(arg) {
         return new OnConflictBuilder({
@@ -124,9 +123,7 @@ class OnConflictBuilder {
         });
     }
     /**
-     * Specify an index predicate for the index target.
-     *
-     * See {@link WhereInterface.whereNotExists} for more info.
+     * @deprecated Follow [these](https://github.com/koskimas/kysely/releases/tag/0.24.0) instructions to migrate
      */
     whereNotExists(arg) {
         return new OnConflictBuilder({
@@ -135,9 +132,7 @@ class OnConflictBuilder {
         });
     }
     /**
-     * Specify an index predicate for the index target.
-     *
-     * See {@link WhereInterface.orWhereExists} for more info.
+     * @deprecated Follow [these](https://github.com/koskimas/kysely/releases/tag/0.24.0) instructions to migrate
      */
     orWhereExists(arg) {
         return new OnConflictBuilder({
@@ -146,9 +141,7 @@ class OnConflictBuilder {
         });
     }
     /**
-     * Specify an index predicate for the index target.
-     *
-     * See {@link WhereInterface.orWhereNotExists} for more info.
+     * @deprecated Follow [these](https://github.com/koskimas/kysely/releases/tag/0.24.0) instructions to migrate
      */
     orWhereNotExists(arg) {
         return new OnConflictBuilder({
@@ -216,15 +209,38 @@ class OnConflictBuilder {
      * on conflict ("pic")
      * do update set "first_name" = $3
      * ```
+     *
+     * In the next example we use the `ref` method to reference
+     * columns of the virtual table `excluded` in a type-safe way
+     * to create an upsert operation:
+     *
+     * ```ts
+     * db.insertInto('person')
+     *   .values(person)
+     *   .onConflict((oc) => oc
+     *     .column('id')
+     *     .doUpdateSet((eb) => ({
+     *       first_name: eb.ref('excluded.first_name'),
+     *       last_name: eb.ref('excluded.last_name')
+     *     }))
+     *   )
+     * ```
      */
-    doUpdateSet(updates) {
+    doUpdateSet(update) {
         return new OnConflictUpdateBuilder({
             ...this.#props,
             onConflictNode: on_conflict_node_js_1.OnConflictNode.cloneWith(this.#props.onConflictNode, {
-                updates: (0, update_set_parser_js_1.parseUpdateObject)(updates),
+                updates: (0, update_set_parser_js_1.parseUpdateExpression)(update),
             }),
         });
     }
+    /**
+     * Simply calls the provided function passing `this` as the only argument. `$call` returns
+     * what the provided function returns.
+     */
+    $call(func) {
+        return func(this);
+    }
 }
 exports.OnConflictBuilder = OnConflictBuilder;
 (0, prevent_await_js_1.preventAwait)(OnConflictBuilder, "don't await OnConflictBuilder instances.");
@@ -258,9 +274,12 @@ class OnConflictUpdateBuilder {
     whereRef(lhs, op, rhs) {
         return new OnConflictUpdateBuilder({
             ...this.#props,
-            onConflictNode: on_conflict_node_js_1.OnConflictNode.cloneWithUpdateWhere(this.#props.onConflictNode, (0, binary_operation_parser_js_1.parseReferentialFilter)(lhs, op, rhs)),
+            onConflictNode: on_conflict_node_js_1.OnConflictNode.cloneWithUpdateWhere(this.#props.onConflictNode, (0, binary_operation_parser_js_1.parseReferentialComparison)(lhs, op, rhs)),
         });
     }
+    /**
+     * @deprecated Follow [these](https://github.com/koskimas/kysely/releases/tag/0.24.0) instructions to migrate
+     */
     orWhere(...args) {
         return new OnConflictUpdateBuilder({
             ...this.#props,
@@ -268,20 +287,16 @@ class OnConflictUpdateBuilder {
         });
     }
     /**
-     * Specify a where condition for the update operation.
-     *
-     * See {@link WhereInterface.orWhereRef} for more info.
+     * @deprecated Follow [these](https://github.com/koskimas/kysely/releases/tag/0.24.0) instructions to migrate
      */
     orWhereRef(lhs, op, rhs) {
         return new OnConflictUpdateBuilder({
             ...this.#props,
-            onConflictNode: on_conflict_node_js_1.OnConflictNode.cloneWithUpdateOrWhere(this.#props.onConflictNode, (0, binary_operation_parser_js_1.parseReferentialFilter)(lhs, op, rhs)),
+            onConflictNode: on_conflict_node_js_1.OnConflictNode.cloneWithUpdateOrWhere(this.#props.onConflictNode, (0, binary_operation_parser_js_1.parseReferentialComparison)(lhs, op, rhs)),
         });
     }
     /**
-     * Specify a where condition for the update operation.
-     *
-     * See {@link WhereInterface.whereExists} for more info.
+     * @deprecated Follow [these](https://github.com/koskimas/kysely/releases/tag/0.24.0) instructions to migrate
      */
     whereExists(arg) {
         return new OnConflictUpdateBuilder({
@@ -290,9 +305,7 @@ class OnConflictUpdateBuilder {
         });
     }
     /**
-     * Specify a where condition for the update operation.
-     *
-     * See {@link WhereInterface.whereNotExists} for more info.
+     * @deprecated Follow [these](https://github.com/koskimas/kysely/releases/tag/0.24.0) instructions to migrate
      */
     whereNotExists(arg) {
         return new OnConflictUpdateBuilder({
@@ -301,9 +314,7 @@ class OnConflictUpdateBuilder {
         });
     }
     /**
-     * Specify a where condition for the update operation.
-     *
-     * See {@link WhereInterface.orWhereExists} for more info.
+     * @deprecated Follow [these](https://github.com/koskimas/kysely/releases/tag/0.24.0) instructions to migrate
      */
     orWhereExists(arg) {
         return new OnConflictUpdateBuilder({
@@ -312,9 +323,7 @@ class OnConflictUpdateBuilder {
         });
     }
     /**
-     * Specify a where condition for the update operation.
-     *
-     * See {@link WhereInterface.orWhereNotExists} for more info.
+     * @deprecated Follow [these](https://github.com/koskimas/kysely/releases/tag/0.24.0) instructions to migrate
      */
     orWhereNotExists(arg) {
         return new OnConflictUpdateBuilder({
@@ -328,6 +337,13 @@ class OnConflictUpdateBuilder {
             onConflictNode: on_conflict_node_js_1.OnConflictNode.cloneWithoutUpdateWhere(this.#props.onConflictNode),
         });
     }
+    /**
+     * Simply calls the provided function passing `this` as the only argument. `$call` returns
+     * what the provided function returns.
+     */
+    $call(func) {
+        return func(this);
+    }
     toOperationNode() {
         return this.#props.onConflictNode;
     }

package/dist/cjs/query-builder/over-builder.d.ts

@@ -52,6 +52,11 @@ export declare class OverBuilder<DB, TB extends keyof DB> implements OperationNo
      */
     partitionBy(partitionBy: ReadonlyArray<PartitionByExpression<DB, TB>>): OverBuilder<DB, TB>;
     partitionBy(partitionBy: PartitionByExpression<DB, TB>): OverBuilder<DB, TB>;
+    /**
+     * Simply calls the provided function passing `this` as the only argument. `$call` returns
+     * what the provided function returns.
+     */
+    $call<T>(func: (qb: this) => T): T;
     toOperationNode(): OverNode;
 }
 export interface OverBuilderProps {

package/dist/cjs/query-builder/over-builder.js

@@ -42,6 +42,13 @@ class OverBuilder {
             overNode: over_node_js_1.OverNode.cloneWithPartitionByItems(this.#props.overNode, (0, partition_by_parser_js_1.parsePartitionBy)(partitionBy)),
         });
     }
+    /**
+     * Simply calls the provided function passing `this` as the only argument. `$call` returns
+     * what the provided function returns.
+     */
+    $call(func) {
+        return func(this);
+    }
     toOperationNode() {
         return this.#props.overNode;
     }

package/dist/cjs/query-builder/returning-interface.d.ts

@@ -53,10 +53,10 @@ export interface ReturningInterface<DB, TB extends keyof DB, O> {
      *     first_name: 'Jennifer',
      *     last_name: 'Aniston'
      *   })
-     *   .returning([
+     *   .returning(eb => [
      *     'id as id',
      *     sql<string>`concat(first_name, ' ', last_name)`.as('full_name'),
-     *     (qb) => qb.selectFrom('pets').select('pet.id').limit(1).as('first_pet_id')
+     *     eb.selectFrom('pets').select('pet.id').limit(1).as('first_pet_id')
      *   ])
      *   .executeTakeFirst()
      * ```