kysely 0.7.7 → 0.8.1

package/dist/esm/query-creator.js

@@ -215,11 +215,11 @@ export class QueryCreator {
      * Raw builder instances can be passed to pretty much anywhere: `select`, `where`,
      * `*Join`, `groupBy`, `orderBy` etc. Just try it. If the method accepts it, it works.
      *
-     * @param sql - The raw SQL. Special strings `?` and `??` can be used to provide
-     *    parameter bindings. `?` for values and `??` for identifiers such as column names
+     * @param sql - The raw SQL. Special strings `?` and `??` can be used as parameter
+     *    placeholders. `?` for values and `??` for identifiers such as column names
      *    or `column.table` references.
      *
-     * @param params - The parameters that will be bound to the `?` and `??` bindings in
+     * @param params - The parameters that will be bound to the `?` and `??` placeholders in
      *    the sql string.
      *
      * @example
@@ -257,7 +257,7 @@ export class QueryCreator {
      *     the output type. In this case you need to use the `castTo` method on the query
      *     to specify a return type for the query.
      *
-     * We could've also used `??` bindings to provide `first_name` and `last_name` like
+     * We could've also used a `??` placeholder to provide `first_name` and `last_name` like
      * this:
      *
      * ```ts
@@ -272,9 +272,9 @@ export class QueryCreator {
      *
      * But it's often cleaner to just write the column names in the SQL. Again remember to
      * never concatenate column names or any other untrusted user input to the SQL string or you
-     * are going to create an injection vulnerability. All user input should go to the bindings
+     * are going to create an injection vulnerability. All user input should go to the parameters
      * array, never to the SQL string directly. But if the column names or values are trusted
-     * and known at compile time, there is no reason to use bindings.
+     * and known at compile time, there is no reason to use parameters.
      *
      * @example
      * Example of using `raw` in `where`:
@@ -300,7 +300,7 @@ export class QueryCreator {
      *
      * The function in the above example returns people that are older than the given number of
      * years. The number of years in this example is an untrusted user input, and therefore we use
-     * a `?` binding for it.
+     * a `?` placeholder for it.
      *
      * @example
      * Example of creating a completely raw query from scratch:
@@ -314,11 +314,12 @@ export class QueryCreator {
      * The result of `execute()` method is always an array. In this case the type of
      * the `persons` variable is `Person[]`.
      */
-    raw(sql, params) {
+    raw(sql, parameters) {
         return new RawBuilder({
-            sql,
-            params,
+            queryId: createQueryId(),
             executor: this.#props.executor,
+            sql,
+            parameters,
         });
     }
 }

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

@@ -4,10 +4,18 @@ import { OperationNodeSource } from '../operation-node/operation-node-source.js'
 import { RawNode } from '../operation-node/raw-node.js';
 import { CompiledQuery } from '../query-compiler/compiled-query.js';
 import { QueryExecutor } from '../query-executor/query-executor.js';
+import { QueryId } from '../util/query-id.js';
 export declare class RawBuilder<O = unknown> implements OperationNodeSource {
     #private;
-    constructor(args: RawBuilderConstructorArgs);
+    constructor(props: RawBuilderProps);
     as<A extends string>(alias: A): AliasedRawBuilder<O, A>;
+    /**
+     * Change the output type of the raw expression.
+     *
+     * This doesn't produce any SQL. This methods simply returns a copy
+     * of this `RawBuilder` with a new output type.
+     */
+    castTo<T>(): RawBuilder<T>;
     toOperationNode(): RawNode;
     compile(): CompiledQuery;
     execute(): Promise<QueryResult<O>>;
@@ -29,8 +37,9 @@ export declare class AliasedRawBuilder<O = unknown, A extends string = never> im
     toOperationNode(): AliasNode;
     constructor(rawBuilder: RawBuilder<O>, alias: A);
 }
-export interface RawBuilderConstructorArgs {
-    sql: string;
-    params?: any;
-    executor: QueryExecutor;
+export interface RawBuilderProps {
+    readonly queryId: QueryId;
+    readonly executor: QueryExecutor;
+    readonly sql: string;
+    readonly parameters?: any;
 }

package/dist/esm/raw-builder/raw-builder.js

@@ -4,52 +4,57 @@ import { RawNode } from '../operation-node/raw-node.js';
 import { ValueNode } from '../operation-node/value-node.js';
 import { parseStringReference } from '../parser/reference-parser.js';
 import { preventAwait } from '../util/prevent-await.js';
-import { createQueryId } from '../util/query-id.js';
+import { freeze } from '../util/object-utils.js';
 export class RawBuilder {
-    #queryId;
-    #sql;
-    #params;
-    #executor;
-    constructor(args) {
-        this.#queryId = createQueryId();
-        this.#sql = args.sql;
-        this.#params = args.params;
-        this.#executor = args.executor;
+    #props;
+    constructor(props) {
+        this.#props = freeze(props);
     }
     as(alias) {
         return new AliasedRawBuilder(this, alias);
     }
+    /**
+     * Change the output type of the raw expression.
+     *
+     * This doesn't produce any SQL. This methods simply returns a copy
+     * of this `RawBuilder` with a new output type.
+     */
+    castTo() {
+        return new RawBuilder({
+            ...this.#props,
+        });
+    }
     toOperationNode() {
-        const bindingRegex = /(\?\??)/g;
-        const sql = this.#sql;
-        const params = this.#params ?? [];
+        const parameterPlaceholderRegex = /(\?\??)/g;
+        const sql = this.#props.sql;
+        const parameters = this.#props.parameters ?? [];
         const sqlFragments = [];
         const argNodes = [];
         let paramIdx = 0;
         let sqlIdx = 0;
         let match = null;
-        while ((match = bindingRegex.exec(sql))) {
+        while ((match = parameterPlaceholderRegex.exec(sql))) {
             const str = match[1];
-            if (paramIdx >= params.length) {
-                throw new Error(`value not provided for all bindings in string ${sql}`);
+            if (paramIdx >= parameters.length) {
+                throw new Error(`value not provided for all placeholders in string ${sql}`);
             }
             if (match.index > 0 && sql[match.index - 1] === '\\') {
                 continue;
             }
             sqlFragments.push(sql.slice(sqlIdx, match.index).replaceAll('\\?', '?'));
-            argNodes.push(parseRawArg(str, params[paramIdx]));
+            argNodes.push(parseRawArg(str, parameters[paramIdx]));
             sqlIdx = match.index + str.length;
             ++paramIdx;
         }
         sqlFragments.push(sql.slice(sqlIdx));
         const rawNode = RawNode.create(sqlFragments, argNodes);
-        return this.#executor.transformQuery(rawNode, this.#queryId);
+        return this.#props.executor.transformQuery(rawNode, this.#props.queryId);
     }
     compile() {
-        return this.#executor.compileQuery(this.toOperationNode(), this.#queryId);
+        return this.#props.executor.compileQuery(this.toOperationNode(), this.#props.queryId);
     }
     async execute() {
-        return this.#executor.executeQuery(this.compile(), this.#queryId);
+        return this.#props.executor.executeQuery(this.compile(), this.#props.queryId);
     }
 }
 preventAwait(RawBuilder, "don't await RawBuilder instances directly. To execute the query you need to call `execute`");

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

@@ -7,7 +7,7 @@ import { CompiledQuery } from '../query-compiler/compiled-query.js';
 import { Compilable } from '../util/compilable.js';
 import { PrimitiveValue } from '../util/object-utils.js';
 import { ColumnDefinitionBuilder, ColumnDefinitionBuilderInterface } from './column-definition-builder.js';
-import { AnyRawBuilder } from '../query-builder/type-utils.js';
+import { AnyRawBuilder } from '../util/type-utils.js';
 import { QueryId } from '../util/query-id.js';
 import { QueryExecutor } from '../query-executor/query-executor.js';
 import { DataTypeExpression } from '../parser/data-type-parser.js';

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

@@ -2,7 +2,7 @@ import { OperationNodeSource } from '../operation-node/operation-node-source.js'
 import { OnModifyForeignAction } from '../operation-node/references-node.js';
 import { PrimitiveValue } from '../util/object-utils.js';
 import { ColumnDefinitionNode } from '../operation-node/column-definition-node.js';
-import { AnyRawBuilder } from '../query-builder/type-utils.js';
+import { AnyRawBuilder } from '../util/type-utils.js';
 import { DefaultValueExpression } from '../parser/default-value-parser.js';
 export interface ColumnDefinitionBuilderInterface<R> {
     /**

package/dist/esm/util/generated-placeholder.d.ts

@@ -1,3 +1,3 @@
-import { GeneratedPlaceholder } from '../query-builder/type-utils.js';
-export declare const generatedPlaceholder: GeneratedPlaceholder;
+import { GeneratedPlaceholder } from './type-utils.js';
+export declare const GENERATED_PLACEHOLDER: GeneratedPlaceholder;
 export declare function isGeneratedPlaceholder(obj: unknown): obj is GeneratedPlaceholder;

package/dist/esm/util/generated-placeholder.js

@@ -1,5 +1,5 @@
 import { freeze, isObject } from './object-utils.js';
-export const generatedPlaceholder = freeze({
+export const GENERATED_PLACEHOLDER = freeze({
     __isGeneratedPlaceholder__: true,
 });
 export function isGeneratedPlaceholder(obj) {

package/dist/esm/util/random-string.js

@@ -1,8 +1,8 @@
 const CHARS = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789';
 export function randomString(length) {
-    let str = '';
+    let chars = new Array(length);
     for (let i = 0; i < length; ++i) {
-        str += CHARS[Math.floor(Math.random() * CHARS.length)];
+        chars[i] = CHARS[Math.floor(Math.random() * CHARS.length)];
     }
-    return str;
+    return chars.join('');
 }

package/dist/esm/{query-builder → util}/type-utils.d.ts

@@ -1,6 +1,9 @@
 import { AliasedRawBuilder, RawBuilder } from '../raw-builder/raw-builder.js';
-import { AliasedQueryBuilder, QueryBuilder } from './query-builder.js';
-import { ExpressionBuilder } from './expression-builder.js';
+import { AliasedQueryBuilder, QueryBuilder } from '../query-builder/query-builder.js';
+import { ExpressionBuilder } from '../query-builder/expression-builder.js';
+/**
+ * Given an object type, extracts the union of all value types.
+ */
 export declare type ValueType<T> = T[keyof T];
 /**
  * Given a database type and a union of table names returns the row type
@@ -38,7 +41,7 @@ export declare type RowType<DB, TB extends keyof DB> = UnionToIntersection<DB[TB
  * Evil typescript magic to convert a union type `A | B | C` into an
  * intersection type `A & B & C`.
  */
-export declare type UnionToIntersection<U> = (U extends any ? (k: U) => void : never) extends (k: infer I) => void ? I : never;
+declare type UnionToIntersection<U> = (U extends any ? (k: U) => void : never) extends (k: infer I) => void ? I : never;
 /**
  * Given a database type and a union of table names in that db, returns
  * a union type with all possible column names.
@@ -150,3 +153,8 @@ export interface GeneratedPlaceholder {
 export declare type ManyResultRowType<O> = O extends InsertResultTypeTag ? number | undefined : O extends DeleteResultTypeTag ? number : O extends UpdateResultTypeTag ? number : O;
 export declare type SingleResultRowType<O> = O extends InsertResultTypeTag ? number | undefined : O extends DeleteResultTypeTag ? number : O extends UpdateResultTypeTag ? number : O | undefined;
 export declare type NonEmptySingleResultRowType<O> = O extends InsertResultTypeTag ? number : O extends DeleteResultTypeTag ? number : O extends UpdateResultTypeTag ? number : O;
+export declare type UnknownRow = Record<string, unknown>;
+export declare type Nullable<T> = {
+    [P in keyof T]: T[P] | null;
+};
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "kysely",
-  "version": "0.7.7",
+  "version": "0.8.1",
   "description": "Type safe SQL query builder",
   "repository": {
     "type": "git",
@@ -15,7 +15,7 @@
     }
   },
   "scripts": {
-    "test:build": "rm -rf test/lib && tsc -p test",
+    "test:build": "rm -rf test/dist && tsc -p test",
     "clean": "rm -rf dist && rm -rf test/dist",
     "test": "npm run clean && npm run build:cjs && npm run test:build && npm run test:integration && npm run test:typings && npm run test:esmimports",
     "test:integration": "mocha --timeout 15000 test/dist/**/*.test.js",
@@ -32,7 +32,7 @@
   "author": "Sami Koskimäki <sami@jakso.me>",
   "license": "MIT",
   "dependencies": {
-    "@types/node": "^16.10.9"
+    "@types/node": "^16.11.9"
   },
   "devDependencies": {
     "@types/chai": "^4.2.22",
@@ -41,12 +41,12 @@
     "@types/pg": "^8.6.1",
     "chai": "^4.3.4",
     "chai-subset": "^1.6.0",
-    "mocha": "^9.1.2",
-    "mysql2": "^2.3.2",
+    "mocha": "^9.1.3",
+    "mysql2": "^2.3.3",
     "pg": "^8.7.1",
     "prettier": "^2.4.1",
-    "tsd": "^0.18.0",
-    "typedoc": "^0.22.5",
-    "typescript": "4.4.4"
+    "tsd": "^0.19.0",
+    "typedoc": "^0.22.9",
+    "typescript": "4.5.2"
   }
 }