kysely 0.10.1 → 0.11.3

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

@@ -26,7 +26,7 @@ export declare class ExpressionBuilder<DB, TB extends keyof DB> {
      *   .execute()
      * ```
      *
-     * The generated SQL (postgresql):
+     * The generated SQL (PostgreSQL):
      *
      * ```sql
      * select "person"."id", count("pet"."id") as "pet_count"
@@ -62,7 +62,7 @@ export declare class ExpressionBuilder<DB, TB extends keyof DB> {
      * console.log(result[0].owner_name)
      * ```
      *
-     * The generated SQL (postgresql):
+     * The generated SQL (PostgreSQL):
      *
      * ```sql
      * select

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

@@ -31,7 +31,7 @@ export class ExpressionBuilder {
      *   .execute()
      * ```
      *
-     * The generated SQL (postgresql):
+     * The generated SQL (PostgreSQL):
      *
      * ```sql
      * select "person"."id", count("pet"."id") as "pet_count"

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

@@ -19,7 +19,7 @@ import { RawBuilder } from '../raw-builder/raw-builder.js';
  *   .execute()
  * ```
  *
- * The generated SQL (postgresql):
+ * The generated SQL (PostgreSQL):
  *
  * ```sql
  * select "person"."id", count("pet"."id") as "pet_count"
@@ -66,7 +66,7 @@ export declare class FunctionBuilder<DB, TB extends keyof DB> {
      * Calls the `sum` function for the column given as the argument.
      *
      * If this is used in a `select` statement the type of the selected expression
-     * will be `number | string | BigInt` by default. This is because Kysely can't
+     * will be `number | string | bigint` by default. This is because Kysely can't
      * know the type the db driver outputs. Sometimes the output can be larger than
      * the largest javascript number and a string is returned instead. Most drivers
      * allow you to configure the output type of large numbers and Kysely can't
@@ -83,12 +83,12 @@ export declare class FunctionBuilder<DB, TB extends keyof DB> {
      *   .execute()
      * ```
      */
-    sum<O extends number | string | BigInt, C extends StringReference<DB, TB> = any>(column: C): RawBuilder<O>;
+    sum<O extends number | string | bigint, C extends StringReference<DB, TB> = any>(column: C): RawBuilder<O>;
     /**
      * Calls the `count` function for the column given as the argument.
      *
      * If this is used in a `select` statement the type of the selected expression
-     * will be `number | string | BigInt` by default. This is because Kysely can't
+     * will be `number | string |bigint` by default. This is because Kysely can't
      * know the type the db driver outputs. Sometimes the output can be larger than
      * the largest javascript number and a string is returned instead. Most drivers
      * allow you to configure the output type of large numbers and Kysely can't
@@ -105,7 +105,7 @@ export declare class FunctionBuilder<DB, TB extends keyof DB> {
      *   .execute()
      * ```
      */
-    count<O extends number | string | BigInt, C extends StringReference<DB, TB> = any>(column: C): RawBuilder<O>;
+    count<O extends number | string | bigint, C extends StringReference<DB, TB> = any>(column: C): RawBuilder<O>;
 }
 export interface FunctionBuilderProps {
     readonly executor: QueryExecutor;

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

@@ -19,7 +19,7 @@ import { createQueryId } from '../util/query-id.js';
  *   .execute()
  * ```
  *
- * The generated SQL (postgresql):
+ * The generated SQL (PostgreSQL):
  *
  * ```sql
  * select "person"."id", count("pet"."id") as "pet_count"
@@ -79,7 +79,7 @@ export class FunctionBuilder {
      * Calls the `sum` function for the column given as the argument.
      *
      * If this is used in a `select` statement the type of the selected expression
-     * will be `number | string | BigInt` by default. This is because Kysely can't
+     * will be `number | string | bigint` by default. This is because Kysely can't
      * know the type the db driver outputs. Sometimes the output can be larger than
      * the largest javascript number and a string is returned instead. Most drivers
      * allow you to configure the output type of large numbers and Kysely can't
@@ -103,7 +103,7 @@ export class FunctionBuilder {
      * Calls the `count` function for the column given as the argument.
      *
      * If this is used in a `select` statement the type of the selected expression
-     * will be `number | string | BigInt` by default. This is because Kysely can't
+     * will be `number | string |bigint` by default. This is because Kysely can't
      * know the type the db driver outputs. Sometimes the output can be larger than
      * the largest javascript number and a string is returned instead. Most drivers
      * allow you to configure the output type of large numbers and Kysely can't

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

@@ -0,0 +1,27 @@
+/**
+ * The result of an insert query.
+ *
+ * If the table has an auto incrementing primary key {@link insertId} will hold
+ * the generated id on dialects that support it. For example PostgreSQL doesn't
+ * return the id by default and {@link insertId} is undefined. On PostgreSQL you
+ * need to use {@link QueryBuilder.returning} or {@link QueryBuilder.returningAll}
+ * to get out the inserted id.
+ *
+ * @example
+ * ```ts
+ * const result = await db
+ *   .insertInto('person')
+ *   .values(person)
+ *   .executeTakeFirst()
+ *
+ * console.log(result.insertId)
+ * ```
+ */
+export declare class InsertResult {
+    #private;
+    constructor(insertId: bigint | undefined);
+    /**
+     * The auto incrementing primary key
+     */
+    get insertId(): bigint | undefined;
+}

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

@@ -0,0 +1,31 @@
+/**
+ * The result of an insert query.
+ *
+ * If the table has an auto incrementing primary key {@link insertId} will hold
+ * the generated id on dialects that support it. For example PostgreSQL doesn't
+ * return the id by default and {@link insertId} is undefined. On PostgreSQL you
+ * need to use {@link QueryBuilder.returning} or {@link QueryBuilder.returningAll}
+ * to get out the inserted id.
+ *
+ * @example
+ * ```ts
+ * const result = await db
+ *   .insertInto('person')
+ *   .values(person)
+ *   .executeTakeFirst()
+ *
+ * console.log(result.insertId)
+ * ```
+ */
+export class InsertResult {
+    #insertId;
+    constructor(insertId) {
+        this.#insertId = insertId;
+    }
+    /**
+     * The auto incrementing primary key
+     */
+    get insertId() {
+        return this.#insertId;
+    }
+}

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

@@ -4,6 +4,7 @@ import { ExistsExpression, FilterOperator } from '../parser/filter-parser.js';
 import { ParseContext } from '../parser/parse-context.js';
 import { ReferenceExpression } from '../parser/reference-parser.js';
 import { ValueExpressionOrList } from '../parser/value-parser.js';
+import { AnyRawBuilder } from '../util/type-utils.js';
 export declare class JoinBuilder<DB, TB extends keyof DB> implements OperationNodeSource {
     #private;
     constructor(props: JoinBuilderProps);
@@ -15,6 +16,7 @@ export declare class JoinBuilder<DB, TB extends keyof DB> implements OperationNo
      */
     on<RE extends ReferenceExpression<DB, TB>>(lhs: RE, op: FilterOperator, rhs: ValueExpressionOrList<DB, TB, RE>): JoinBuilder<DB, TB>;
     on(grouper: (qb: JoinBuilder<DB, TB>) => JoinBuilder<DB, TB>): JoinBuilder<DB, TB>;
+    on(raw: AnyRawBuilder): JoinBuilder<DB, TB>;
     /**
      * Just like {@link QueryBuilder.orWhere} but adds an item to the join's
      * `on` clause instead.
@@ -23,6 +25,7 @@ export declare class JoinBuilder<DB, TB extends keyof DB> implements OperationNo
      */
     orOn<RE extends ReferenceExpression<DB, TB>>(lhs: RE, op: FilterOperator, rhs: ValueExpressionOrList<DB, TB, RE>): JoinBuilder<DB, TB>;
     orOn(grouper: (qb: JoinBuilder<DB, TB>) => JoinBuilder<DB, TB>): JoinBuilder<DB, TB>;
+    orOn(raw: AnyRawBuilder): JoinBuilder<DB, TB>;
     /**
      * Just like {@link QueryBuilder.whereRef} but adds an item to the join's
      * `on` clause instead.