kysely 0.9.8 → 0.11.0

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

@@ -0,0 +1,28 @@
+import { OperationNodeSource } from '../operation-node/operation-node-source.js';
+import { CompiledQuery } from '../query-compiler/compiled-query.js';
+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 { AnyQueryBuilder } from '../index.js';
+import { AnyRawBuilder } from '../util/type-utils.js';
+export declare class CreateViewBuilder implements OperationNodeSource, Compilable {
+    #private;
+    constructor(props: CreateViewBuilderProps);
+    materialized(): CreateViewBuilder;
+    /**
+     * Only implemented on some dialects like SQLite. On most dialects, use {@link orReplace}.
+     */
+    ifNotExists(): CreateViewBuilder;
+    orReplace(): CreateViewBuilder;
+    columns(columns: string[]): CreateViewBuilder;
+    as(query: AnyQueryBuilder | AnyRawBuilder): CreateViewBuilder;
+    toOperationNode(): CreateViewNode;
+    compile(): CompiledQuery;
+    execute(): Promise<void>;
+}
+export interface CreateViewBuilderProps {
+    readonly queryId: QueryId;
+    readonly executor: QueryExecutor;
+    readonly createViewNode: CreateViewNode;
+}

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

@@ -0,0 +1,80 @@
+import { preventAwait } from '../util/prevent-await.js';
+import { freeze } from '../util/object-utils.js';
+import { CreateViewNode } from '../operation-node/create-view-node.js';
+import { parseColumnName } from '../parser/reference-parser.js';
+import { QueryNode } from '../index.js';
+import { ImmediateValuePlugin } from '../plugin/immediate-value.ts/immediate-value-plugin.js';
+export class CreateViewBuilder {
+    #props;
+    constructor(props) {
+        this.#props = freeze({
+            ...props,
+            // The select statement (defined using the `as` method) can't have parameters on some
+            // dialects. We add the `ImmediateValuePlugin` to make all parameters "immediate"
+            // meaning they are interpolated into the SQL instead of added as parameters.
+            //
+            // The values are therefore not escaped at all, which leads to SQL injection
+            // vulnerabilities if user input is passed into the query. However, the use
+            // case where user input is passed into a `create view` statement is a weird
+            // one, and we can pretty safely just ignore it.
+            executor: props.executor.withPlugin(new ImmediateValuePlugin()),
+        });
+    }
+    materialized() {
+        return new CreateViewBuilder({
+            ...this.#props,
+            createViewNode: CreateViewNode.cloneWith(this.#props.createViewNode, {
+                materialized: true,
+            }),
+        });
+    }
+    /**
+     * Only implemented on some dialects like SQLite. On most dialects, use {@link orReplace}.
+     */
+    ifNotExists() {
+        return new CreateViewBuilder({
+            ...this.#props,
+            createViewNode: CreateViewNode.cloneWith(this.#props.createViewNode, {
+                ifNotExists: true,
+            }),
+        });
+    }
+    orReplace() {
+        return new CreateViewBuilder({
+            ...this.#props,
+            createViewNode: CreateViewNode.cloneWith(this.#props.createViewNode, {
+                orReplace: true,
+            }),
+        });
+    }
+    columns(columns) {
+        return new CreateViewBuilder({
+            ...this.#props,
+            createViewNode: CreateViewNode.cloneWith(this.#props.createViewNode, {
+                columns: columns.map(parseColumnName),
+            }),
+        });
+    }
+    as(query) {
+        const queryNode = query.toOperationNode();
+        if (QueryNode.isMutating(queryNode)) {
+            throw new Error('only select statements are allowd in views');
+        }
+        return new CreateViewBuilder({
+            ...this.#props,
+            createViewNode: CreateViewNode.cloneWith(this.#props.createViewNode, {
+                as: queryNode,
+            }),
+        });
+    }
+    toOperationNode() {
+        return this.#props.executor.transformQuery(this.#props.createViewNode, this.#props.queryId);
+    }
+    compile() {
+        return this.#props.executor.compileQuery(this.toOperationNode(), this.#props.queryId);
+    }
+    async execute() {
+        await this.#props.executor.executeQuery(this.compile(), this.#props.queryId);
+    }
+}
+preventAwait(CreateViewBuilder, "don't await CreateViewBuilder instances directly. To execute the query you need to call `execute`");

package/dist/esm/schema/drop-index-builder.js

@@ -23,7 +23,7 @@ export class DropIndexBuilder {
         return new DropIndexBuilder({
             ...this.#props,
             dropIndexNode: DropIndexNode.cloneWith(this.#props.dropIndexNode, {
-                modifier: 'IfExists',
+                ifExists: true,
             }),
         });
     }

package/dist/esm/schema/drop-schema-builder.js

@@ -9,7 +9,9 @@ export class DropSchemaBuilder {
     ifExists() {
         return new DropSchemaBuilder({
             ...this.#props,
-            dropSchemaNode: DropSchemaNode.cloneWithModifier(this.#props.dropSchemaNode, 'IfExists'),
+            dropSchemaNode: DropSchemaNode.cloneWith(this.#props.dropSchemaNode, {
+                ifExists: true,
+            }),
         });
     }
     toOperationNode() {

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

@@ -9,7 +9,9 @@ export class DropTableBuilder {
     ifExists() {
         return new DropTableBuilder({
             ...this.#props,
-            dropTableNode: DropTableNode.cloneWithModifier(this.#props.dropTableNode, 'IfExists'),
+            dropTableNode: DropTableNode.cloneWith(this.#props.dropTableNode, {
+                ifExists: true,
+            }),
         });
     }
     toOperationNode() {

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

@@ -0,0 +1,20 @@
+import { OperationNodeSource } from '../operation-node/operation-node-source.js';
+import { CompiledQuery } from '../query-compiler/compiled-query.js';
+import { Compilable } from '../util/compilable.js';
+import { QueryExecutor } from '../query-executor/query-executor.js';
+import { QueryId } from '../util/query-id.js';
+import { DropViewNode } from '../operation-node/drop-view-node.js';
+export declare class DropViewBuilder implements OperationNodeSource, Compilable {
+    #private;
+    constructor(props: DropViewBuilderProps);
+    materialized(): DropViewBuilder;
+    ifExists(): DropViewBuilder;
+    toOperationNode(): DropViewNode;
+    compile(): CompiledQuery;
+    execute(): Promise<void>;
+}
+export interface DropViewBuilderProps {
+    readonly queryId: QueryId;
+    readonly executor: QueryExecutor;
+    readonly dropViewNode: DropViewNode;
+}

package/dist/esm/schema/drop-view-builder.js

@@ -0,0 +1,35 @@
+import { preventAwait } from '../util/prevent-await.js';
+import { freeze } from '../util/object-utils.js';
+import { DropViewNode } from '../operation-node/drop-view-node.js';
+export class DropViewBuilder {
+    #props;
+    constructor(props) {
+        this.#props = freeze(props);
+    }
+    materialized() {
+        return new DropViewBuilder({
+            ...this.#props,
+            dropViewNode: DropViewNode.cloneWith(this.#props.dropViewNode, {
+                materialized: true,
+            }),
+        });
+    }
+    ifExists() {
+        return new DropViewBuilder({
+            ...this.#props,
+            dropViewNode: DropViewNode.cloneWith(this.#props.dropViewNode, {
+                ifExists: true,
+            }),
+        });
+    }
+    toOperationNode() {
+        return this.#props.executor.transformQuery(this.#props.dropViewNode, this.#props.queryId);
+    }
+    compile() {
+        return this.#props.executor.compileQuery(this.toOperationNode(), this.#props.queryId);
+    }
+    async execute() {
+        await this.#props.executor.executeQuery(this.compile(), this.#props.queryId);
+    }
+}
+preventAwait(DropViewBuilder, "don't await DropViewBuilder instances directly. To execute the query you need to call `execute`");

package/dist/esm/schema/schema.d.ts

@@ -6,6 +6,8 @@ import { CreateTableBuilder } from './create-table-builder.js';
 import { DropIndexBuilder } from './drop-index-builder.js';
 import { DropSchemaBuilder } from './drop-schema-builder.js';
 import { DropTableBuilder } from './drop-table-builder.js';
+import { CreateViewBuilder } from './create-view-builder.js';
+import { DropViewBuilder } from './drop-view-builder.js';
 /**
  * Provides methods for building database schema.
  */
@@ -22,7 +24,7 @@ export declare class SchemaModule {
      * ```ts
      * await db.schema
      *   .createTable('person')
-     *   .addColumn('id', 'integer', col => col.primaryKey().increments())
+     *   .addColumn('id', 'integer', col => col.primaryKey().autoIncrement())
      *   .addColumn('first_name', 'varchar', col => col.notNull())
      *   .addColumn('last_name', 'varchar', col => col.notNull())
      *   .addColumn('gender', 'varchar')
@@ -38,7 +40,7 @@ export declare class SchemaModule {
      * ```ts
      * await db.schema
      *   .createTable('pet')
-     *   .addColumn('id', 'integer', col => col.primaryKey().increments())
+     *   .addColumn('id', 'integer', col => col.primaryKey().autoIncrement())
      *   .addColumn('owner_id', 'integer', col => col
      *     .references('person.id')
      *     .onDelete('cascade')
@@ -55,7 +57,7 @@ export declare class SchemaModule {
      * ```ts
      * await db.schema
      *   .createTable('pet')
-     *   .addColumn('id', 'integer', col => col.primaryKey().increments())
+     *   .addColumn('id', 'integer', col => col.primaryKey().autoIncrement())
      *   .addColumn('owner_id', 'integer')
      *   .addForeignKeyConstraint(
      *     'pet_owner_id_foreign', ['owner_id'], 'person', ['id'],
@@ -135,6 +137,31 @@ export declare class SchemaModule {
      * ```
      */
     alterTable(table: string): AlterTableBuilder;
+    /**
+     * Create a new view.
+     *
+     * @example
+     * ```ts
+     * await db.schema
+     *   .createView('dogs')
+     *   .orReplace()
+     *   .as(db.selectFrom('pet').selectAll().where('species', '=', 'dog'))
+     *   .execute()
+     * ```
+     */
+    createView(viewName: string): CreateViewBuilder;
+    /**
+     * Drop a view.
+     *
+     * @example
+     * ```ts
+     * await db.schema
+     *   .dropView('dogs')
+     *   .ifExists()
+     *   .execute()
+     * ```
+     */
+    dropView(viewName: string): DropViewBuilder;
     /**
      * See {@link QueryCreator.withSchema}
      */

package/dist/esm/schema/schema.js

@@ -15,6 +15,10 @@ import { DropSchemaBuilder } from './drop-schema-builder.js';
 import { DropTableBuilder } from './drop-table-builder.js';
 import { createQueryId } from '../util/query-id.js';
 import { WithSchemaPlugin } from '../plugin/with-schema/with-schema-plugin.js';
+import { CreateViewBuilder } from './create-view-builder.js';
+import { CreateViewNode } from '../operation-node/create-view-node.js';
+import { DropViewBuilder } from './drop-view-builder.js';
+import { DropViewNode } from '../operation-node/drop-view-node.js';
 /**
  * Provides methods for building database schema.
  */
@@ -33,7 +37,7 @@ export class SchemaModule {
      * ```ts
      * await db.schema
      *   .createTable('person')
-     *   .addColumn('id', 'integer', col => col.primaryKey().increments())
+     *   .addColumn('id', 'integer', col => col.primaryKey().autoIncrement())
      *   .addColumn('first_name', 'varchar', col => col.notNull())
      *   .addColumn('last_name', 'varchar', col => col.notNull())
      *   .addColumn('gender', 'varchar')
@@ -49,7 +53,7 @@ export class SchemaModule {
      * ```ts
      * await db.schema
      *   .createTable('pet')
-     *   .addColumn('id', 'integer', col => col.primaryKey().increments())
+     *   .addColumn('id', 'integer', col => col.primaryKey().autoIncrement())
      *   .addColumn('owner_id', 'integer', col => col
      *     .references('person.id')
      *     .onDelete('cascade')
@@ -66,7 +70,7 @@ export class SchemaModule {
      * ```ts
      * await db.schema
      *   .createTable('pet')
-     *   .addColumn('id', 'integer', col => col.primaryKey().increments())
+     *   .addColumn('id', 'integer', col => col.primaryKey().autoIncrement())
      *   .addColumn('owner_id', 'integer')
      *   .addForeignKeyConstraint(
      *     'pet_owner_id_foreign', ['owner_id'], 'person', ['id'],
@@ -188,6 +192,43 @@ export class SchemaModule {
             alterTableNode: AlterTableNode.create(table),
         });
     }
+    /**
+     * Create a new view.
+     *
+     * @example
+     * ```ts
+     * await db.schema
+     *   .createView('dogs')
+     *   .orReplace()
+     *   .as(db.selectFrom('pet').selectAll().where('species', '=', 'dog'))
+     *   .execute()
+     * ```
+     */
+    createView(viewName) {
+        return new CreateViewBuilder({
+            queryId: createQueryId(),
+            executor: this.#executor,
+            createViewNode: CreateViewNode.create(viewName),
+        });
+    }
+    /**
+     * Drop a view.
+     *
+     * @example
+     * ```ts
+     * await db.schema
+     *   .dropView('dogs')
+     *   .ifExists()
+     *   .execute()
+     * ```
+     */
+    dropView(viewName) {
+        return new DropViewBuilder({
+            queryId: createQueryId(),
+            executor: this.#executor,
+            dropViewNode: DropViewNode.create(viewName),
+        });
+    }
     /**
      * See {@link QueryCreator.withSchema}
      */

package/dist/esm/util/dynamic-import.d.ts

@@ -0,0 +1,2 @@
+export declare function importFunction<T extends Function>(modulePath: string): Promise<T>;
+export declare function importNamedFunction<T extends Function>(modulePath: string, exportName: string): Promise<T>;

package/dist/esm/util/dynamic-import.js

@@ -0,0 +1,27 @@
+import { isFunction, isObject } from './object-utils.js';
+export async function importFunction(modulePath) {
+    const module = await import(modulePath);
+    const errorMessage = `module "${modulePath}" doesn export a function`;
+    if (isFunction(module)) {
+        return module;
+    }
+    else if (isObject(module) && isFunction(module.default)) {
+        return module.default;
+    }
+    throw new Error(errorMessage);
+}
+export async function importNamedFunction(modulePath, exportName) {
+    const module = await import(modulePath);
+    const errorMessage = `no function export named "${exportName}" found in module "${modulePath}"`;
+    if (!isObject(module)) {
+        throw new Error(errorMessage);
+    }
+    if (isFunction(module[exportName])) {
+        return module[exportName];
+    }
+    else if (isObject(module.default) &&
+        isFunction(module.default[exportName])) {
+        return module.default[exportName];
+    }
+    throw new Error(errorMessage);
+}

package/dist/esm/util/performance-now.d.ts

@@ -0,0 +1 @@
+export declare function performanceNow(): number;

package/dist/esm/util/performance-now.js

@@ -0,0 +1,9 @@
+import { isFunction } from './object-utils.js';
+export function performanceNow() {
+    if (typeof performance !== 'undefined' && isFunction(performance.now)) {
+        return performance.now();
+    }
+    else {
+        return Date.now();
+    }
+}

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

@@ -1,6 +1,9 @@
 import { AliasedRawBuilder, RawBuilder } from '../raw-builder/raw-builder.js';
 import { AliasedQueryBuilder, QueryBuilder } from '../query-builder/query-builder.js';
 import { ExpressionBuilder } from '../query-builder/expression-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';
 /**
  * Given an object type, extracts the union of all value types.
  */
@@ -134,25 +137,11 @@ export declare type QueryBuilderFactory<DB, TB extends keyof DB> = (qb: Expressi
 export declare type AliasedQueryBuilderFactory<DB, TB extends keyof DB> = (qb: ExpressionBuilder<DB, TB>) => AnyAliasedQueryBuilder;
 export declare type RawBuilderFactory<DB, TB extends keyof DB> = (qb: ExpressionBuilder<DB, TB>) => AnyRawBuilder;
 export declare type AliasedRawBuilderFactory<DB, TB extends keyof DB> = (qb: ExpressionBuilder<DB, TB>) => AnyAliasedRawBuilder;
-export interface InsertResultTypeTag {
-    /** @internal */
-    readonly __isInsertResultTypeTag__: true;
-}
-export interface DeleteResultTypeTag {
-    /** @internal */
-    readonly __isDeleteResultTypeTag__: true;
-}
-export interface UpdateResultTypeTag {
-    /** @internal */
-    readonly __isUpdateResultTypeTag__: true;
-}
 export interface GeneratedPlaceholder {
     /** @internal */
     readonly __isGeneratedPlaceholder__: true;
 }
-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 SingleResultType<O> = O extends InsertResult ? O : O extends DeleteResult ? O : O extends UpdateResult ? O : O | undefined;
 export declare type UnknownRow = Record<string, unknown>;
 export declare type Nullable<T> = {
     [P in keyof T]: T[P] | null;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "kysely",
-  "version": "0.9.8",
+  "version": "0.11.0",
   "description": "Type safe SQL query builder",
   "repository": {
     "type": "git",
@@ -38,18 +38,20 @@
     "@types/node": "^16.11.9"
   },
   "devDependencies": {
+    "@types/better-sqlite3": "^7.4.1",
     "@types/chai": "^4.2.22",
     "@types/chai-subset": "^1.3.3",
     "@types/mocha": "^9.0.0",
     "@types/pg": "^8.6.1",
+    "better-sqlite3": "^7.4.5",
     "chai": "^4.3.4",
     "chai-subset": "^1.6.0",
     "mocha": "^9.1.3",
     "mysql2": "^2.3.3",
     "pg": "^8.7.1",
-    "prettier": "^2.4.1",
+    "prettier": "^2.5.1",
     "tsd": "^0.19.0",
-    "typedoc": "^0.22.9",
+    "typedoc": "^0.22.10",
     "typescript": "4.5.2"
   }
 }