kysely 0.27.5 → 0.28.0

package/dist/esm/schema/refresh-materialized-view-builder.d.ts

@@ -0,0 +1,47 @@
+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 { RefreshMaterializedViewNode } from '../operation-node/refresh-materialized-view-node.js';
+export declare class RefreshMaterializedViewBuilder implements OperationNodeSource, Compilable {
+    #private;
+    constructor(props: RefreshMaterializedViewBuilderProps);
+    /**
+     * Adds the "concurrently" modifier.
+     *
+     * Use this to refresh the view without locking out concurrent selects on the materialized view.
+     *
+     * WARNING!
+     * This cannot be used with the "with no data" modifier.
+     */
+    concurrently(): RefreshMaterializedViewBuilder;
+    /**
+     * Adds the "with data" modifier.
+     *
+     * If specified (or defaults) the backing query is executed to provide the new data, and the materialized view is left in a scannable state
+     */
+    withData(): RefreshMaterializedViewBuilder;
+    /**
+     * Adds the "with no data" modifier.
+     *
+     * If specified, no new data is generated and the materialized view is left in an unscannable state.
+     *
+     * WARNING!
+     * This cannot be used with the "concurrently" modifier.
+     */
+    withNoData(): RefreshMaterializedViewBuilder;
+    /**
+     * 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(): RefreshMaterializedViewNode;
+    compile(): CompiledQuery;
+    execute(): Promise<void>;
+}
+export interface RefreshMaterializedViewBuilderProps {
+    readonly queryId: QueryId;
+    readonly executor: QueryExecutor;
+    readonly node: RefreshMaterializedViewNode;
+}

package/dist/esm/schema/refresh-materialized-view-builder.js

@@ -0,0 +1,72 @@
+/// <reference types="./refresh-materialized-view-builder.d.ts" />
+import { freeze } from '../util/object-utils.js';
+import { RefreshMaterializedViewNode } from '../operation-node/refresh-materialized-view-node.js';
+export class RefreshMaterializedViewBuilder {
+    #props;
+    constructor(props) {
+        this.#props = freeze(props);
+    }
+    /**
+     * Adds the "concurrently" modifier.
+     *
+     * Use this to refresh the view without locking out concurrent selects on the materialized view.
+     *
+     * WARNING!
+     * This cannot be used with the "with no data" modifier.
+     */
+    concurrently() {
+        return new RefreshMaterializedViewBuilder({
+            ...this.#props,
+            node: RefreshMaterializedViewNode.cloneWith(this.#props.node, {
+                concurrently: true,
+                withNoData: false,
+            }),
+        });
+    }
+    /**
+     * Adds the "with data" modifier.
+     *
+     * If specified (or defaults) the backing query is executed to provide the new data, and the materialized view is left in a scannable state
+     */
+    withData() {
+        return new RefreshMaterializedViewBuilder({
+            ...this.#props,
+            node: RefreshMaterializedViewNode.cloneWith(this.#props.node, {
+                withNoData: false,
+            }),
+        });
+    }
+    /**
+     * Adds the "with no data" modifier.
+     *
+     * If specified, no new data is generated and the materialized view is left in an unscannable state.
+     *
+     * WARNING!
+     * This cannot be used with the "concurrently" modifier.
+     */
+    withNoData() {
+        return new RefreshMaterializedViewBuilder({
+            ...this.#props,
+            node: RefreshMaterializedViewNode.cloneWith(this.#props.node, {
+                withNoData: true,
+                concurrently: false,
+            }),
+        });
+    }
+    /**
+     * 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.executor.transformQuery(this.#props.node, 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);
+    }
+}

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

@@ -11,6 +11,7 @@ import { DropViewBuilder } from './drop-view-builder.js';
 import { KyselyPlugin } from '../plugin/kysely-plugin.js';
 import { CreateTypeBuilder } from './create-type-builder.js';
 import { DropTypeBuilder } from './drop-type-builder.js';
+import { RefreshMaterializedViewBuilder } from './refresh-materialized-view-builder.js';
 /**
  * Provides methods for building database schema.
  */
@@ -158,6 +159,19 @@ export declare class SchemaModule {
      * ```
      */
     createView(viewName: string): CreateViewBuilder;
+    /**
+     * Refresh a materialized view.
+     *
+     * ### Examples
+     *
+     * ```ts
+     * await db.schema
+     *   .refreshMaterializedView('my_view')
+     *   .concurrently()
+     *   .execute()
+     * ```
+     */
+    refreshMaterializedView(viewName: string): RefreshMaterializedViewBuilder;
     /**
      * Drop a view.
      *

package/dist/esm/schema/schema.js

@@ -25,6 +25,8 @@ import { DropTypeBuilder } from './drop-type-builder.js';
 import { CreateTypeNode } from '../operation-node/create-type-node.js';
 import { DropTypeNode } from '../operation-node/drop-type-node.js';
 import { parseSchemableIdentifier } from '../parser/identifier-parser.js';
+import { RefreshMaterializedViewBuilder } from './refresh-materialized-view-builder.js';
+import { RefreshMaterializedViewNode } from '../operation-node/refresh-materialized-view-node.js';
 /**
  * Provides methods for building database schema.
  */
@@ -222,6 +224,25 @@ export class SchemaModule {
             node: CreateViewNode.create(viewName),
         });
     }
+    /**
+     * Refresh a materialized view.
+     *
+     * ### Examples
+     *
+     * ```ts
+     * await db.schema
+     *   .refreshMaterializedView('my_view')
+     *   .concurrently()
+     *   .execute()
+     * ```
+     */
+    refreshMaterializedView(viewName) {
+        return new RefreshMaterializedViewBuilder({
+            queryId: createQueryId(),
+            executor: this.#executor,
+            node: RefreshMaterializedViewNode.create(viewName),
+        });
+    }
     /**
      * Drop a view.
      *

package/dist/esm/schema/unique-constraint-builder.d.ts

@@ -3,12 +3,21 @@ import { UniqueConstraintNode } from '../operation-node/unique-constraint-node.j
 export declare class UniqueConstraintNodeBuilder implements OperationNodeSource {
     #private;
     constructor(node: UniqueConstraintNode);
-    toOperationNode(): UniqueConstraintNode;
     /**
      * Adds `nulls not distinct` to the unique constraint definition
      *
      * Supported by PostgreSQL dialect only
      */
     nullsNotDistinct(): UniqueConstraintNodeBuilder;
+    deferrable(): UniqueConstraintNodeBuilder;
+    notDeferrable(): UniqueConstraintNodeBuilder;
+    initiallyDeferred(): UniqueConstraintNodeBuilder;
+    initiallyImmediate(): UniqueConstraintNodeBuilder;
+    /**
+     * 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(): UniqueConstraintNode;
 }
 export type UniqueConstraintNodeBuilderCallback = (builder: UniqueConstraintNodeBuilder) => UniqueConstraintNodeBuilder;

package/dist/esm/schema/unique-constraint-builder.js

@@ -1,14 +1,10 @@
 /// <reference types="./unique-constraint-builder.d.ts" />
 import { UniqueConstraintNode } from '../operation-node/unique-constraint-node.js';
-import { preventAwait } from '../util/prevent-await.js';
 export class UniqueConstraintNodeBuilder {
     #node;
     constructor(node) {
         this.#node = node;
     }
-    toOperationNode() {
-        return this.#node;
-    }
     /**
      * Adds `nulls not distinct` to the unique constraint definition
      *
@@ -17,5 +13,30 @@ export class UniqueConstraintNodeBuilder {
     nullsNotDistinct() {
         return new UniqueConstraintNodeBuilder(UniqueConstraintNode.cloneWith(this.#node, { nullsNotDistinct: true }));
     }
+    deferrable() {
+        return new UniqueConstraintNodeBuilder(UniqueConstraintNode.cloneWith(this.#node, { deferrable: true }));
+    }
+    notDeferrable() {
+        return new UniqueConstraintNodeBuilder(UniqueConstraintNode.cloneWith(this.#node, { deferrable: false }));
+    }
+    initiallyDeferred() {
+        return new UniqueConstraintNodeBuilder(UniqueConstraintNode.cloneWith(this.#node, {
+            initiallyDeferred: true,
+        }));
+    }
+    initiallyImmediate() {
+        return new UniqueConstraintNodeBuilder(UniqueConstraintNode.cloneWith(this.#node, {
+            initiallyDeferred: false,
+        }));
+    }
+    /**
+     * 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.#node;
+    }
 }
-preventAwait(UniqueConstraintNodeBuilder, "don't await UniqueConstraintNodeBuilder instances directly.");

package/dist/esm/util/infer-result.d.ts

@@ -44,5 +44,5 @@ import { Simplify } from './type-utils.js';
  * ```
  */
 export type InferResult<C extends Compilable<any> | CompiledQuery<any>> = C extends Compilable<infer O> ? ResolveResult<O> : C extends CompiledQuery<infer O> ? ResolveResult<O> : never;
-type ResolveResult<O> = O extends InsertResult | UpdateResult | DeleteResult | MergeResult ? O : Simplify<O>[];
+type ResolveResult<O> = O extends InsertResult | UpdateResult | DeleteResult | MergeResult ? O[] : Simplify<O>[];
 export {};

package/dist/esm/util/log.d.ts

@@ -4,6 +4,7 @@ export declare const LOG_LEVELS: readonly ["query", "error"];
 export type LogLevel = ArrayItemType<typeof LOG_LEVELS>;
 export interface QueryLogEvent {
     readonly level: 'query';
+    readonly isStream?: boolean;
     readonly query: CompiledQuery;
     readonly queryDurationMillis: number;
 }

package/dist/esm/util/log.js

@@ -36,8 +36,9 @@ export class Log {
 }
 function defaultLogger(event) {
     if (event.level === 'query') {
-        console.log(`kysely:query: ${event.query.sql}`);
-        console.log(`kysely:query: duration: ${event.queryDurationMillis.toFixed(1)}ms`);
+        const prefix = `kysely:query:${event.isStream ? 'stream:' : ''}`;
+        console.log(`${prefix} ${event.query.sql}`);
+        console.log(`${prefix} duration: ${event.queryDurationMillis.toFixed(1)}ms`);
     }
     else if (event.level === 'error') {
         if (event.error instanceof Error) {

package/dist/esm/util/provide-controlled-connection.d.ts

@@ -0,0 +1,7 @@
+import { ConnectionProvider } from '../driver/connection-provider.js';
+import { DatabaseConnection } from '../driver/database-connection.js';
+export interface ControlledConnection {
+    readonly connection: DatabaseConnection;
+    readonly release: () => void;
+}
+export declare function provideControlledConnection(connectionProvider: ConnectionProvider): Promise<ControlledConnection>;

package/dist/esm/util/provide-controlled-connection.js

@@ -0,0 +1,22 @@
+/// <reference types="./provide-controlled-connection.d.ts" />
+import { Deferred } from './deferred.js';
+import { freeze } from './object-utils.js';
+export async function provideControlledConnection(connectionProvider) {
+    const connectionDefer = new Deferred();
+    const connectionReleaseDefer = new Deferred();
+    connectionProvider
+        .provideConnection(async (connection) => {
+        connectionDefer.resolve(connection);
+        return await connectionReleaseDefer.promise;
+    })
+        .catch((ex) => connectionDefer.reject(ex));
+    // Create composite of the connection and the release method instead of
+    // modifying the connection or creating a new nesting `DatabaseConnection`.
+    // This way we don't accidentally override any methods of 3rd party
+    // connections and don't return wrapped connections to drivers that
+    // expect a certain specific connection class.
+    return freeze({
+        connection: await connectionDefer.promise,
+        release: connectionReleaseDefer.resolve,
+    });
+}

package/outdated-typescript.d.ts

@@ -0,0 +1,5 @@
+import type { KyselyTypeError } from './dist/cjs/util/type-error'
+
+declare const Kysely: KyselyTypeError<'The installed TypeScript version is outdated and cannot guarantee type-safety with Kysely. Please upgrade to version 4.6 or newer.'>
+declare const RawBuilder: KyselyTypeError<'The installed TypeScript version is outdated and cannot guarantee type-safety with Kysely. Please upgrade to version 4.6 or newer.'>
+declare const sql: KyselyTypeError<'The installed TypeScript version is outdated and cannot guarantee type-safety with Kysely. Please upgrade to version 4.6 or newer.'>

package/package.json

@@ -1,16 +1,23 @@
 {
   "name": "kysely",
-  "version": "0.27.5",
+  "version": "0.28.0",
   "description": "Type safe SQL query builder",
   "repository": {
     "type": "git",
     "url": "git://github.com/kysely-org/kysely.git"
   },
   "engines": {
-    "node": ">=14.0.0"
+    "node": ">=18.0.0"
   },
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",
+  "typesVersions": {
+    "<4.6": {
+      "*": [
+        "outdated-typescript.d.ts"
+      ]
+    }
+  },
   "exports": {
     ".": {
       "import": "./dist/esm/index.js",
@@ -40,6 +47,7 @@
   },
   "scripts": {
     "clean": "rm -rf dist & rm -rf test/node/dist & rm -rf test/browser/bundle.js & rm -rf helpers",
+    "bench:ts": "npm run build && cd ./test/ts-benchmarks && tsx ./index.ts",
     "test": "npm run build && npm run test:node:build && npm run test:node:run && npm run test:typings && npm run test:esmimports && npm run test:exports",
     "test:node:build": "tsc -p test/node",
     "test:node": "npm run build && npm run test:node:build && npm run test:node:run",
@@ -54,6 +62,7 @@
     "test:esbuild": "esbuild --bundle --platform=node --external:pg-native dist/esm/index.js --outfile=/dev/null",
     "test:exports": "attw --pack . && node scripts/check-exports.js",
     "test:jsdocs": "deno check --doc-only --no-lock --unstable-sloppy-imports --config=\"deno.check.json\" ./src",
+    "test:outdatedts": "npm run build && cd test/outdated-ts && npm ci && npm test",
     "prettier": "prettier --write 'src/**/*.ts' 'test/**/*.ts'",
     "build": "npm run clean && (npm run build:esm & npm run build:cjs) && npm run script:module-fixup && npm run script:copy-interface-doc",
     "build:esm": "tsc -p tsconfig.json && npm run script:add-deno-type-references",
@@ -74,6 +83,7 @@
   ],
   "devDependencies": {
     "@arethetypeswrong/cli": "^0.17.0",
+    "@ark/attest": "^0.36.0",
     "@types/better-sqlite3": "^7.6.11",
     "@types/chai": "^4.3.17",
     "@types/chai-as-promised": "^7.1.8",
@@ -82,6 +92,7 @@
     "@types/node": "^22.5.0",
     "@types/pg": "^8.11.6",
     "@types/pg-cursor": "^2.7.2",
+    "@types/semver": "^7.5.8",
     "@types/sinon": "^17.0.2",
     "@types/tedious": "^4.0.9",
     "better-sqlite3": "^11.2.1",
@@ -92,15 +103,18 @@
     "lodash": "^4.17.21",
     "mocha": "^10.7.3",
     "mysql2": "^3.11.0",
+    "pathe": "^1.1.2",
     "pg": "^8.12.0",
     "pg-cursor": "^2.11.0",
     "pkg-pr-new": "^0.0.30",
     "playwright": "^1.46.1",
     "prettier": "^3.3.3",
+    "semver": "^7.6.3",
     "sinon": "^19.0.2",
     "tarn": "^3.0.2",
     "tedious": "^19.0.0",
     "tsd": "^0.31.1",
+    "tsx": "^4.19.1",
     "typescript": "^5.6.3"
   }
 }

package/CONTRIBUTING.md

@@ -1,70 +0,0 @@
-Would love to contribute to Kysely?
-
-Awesome! We are not very organized yet. We don't have a plan or a roadmap.
-
-Probably the best way to get going is to watch the issue list.
-An issue with a `greenlit` label, has been acknowledged by the team and is ready for development.
-Find such an issue you'd like to tackle and ask to be assigned to it in the comment section.
-Feel free to open an issue if you found a bug or a missing feature you'd like to work on,
-and there aren't any issues mentioning it.
-
-If you start working on something larger, it's a good idea to create a draft (WIP) PR at 
-an early stage so that we can guide you to the right direction.
-
-There are quite a few guidelines to keep in mind:
-
-* Kysely should have zero dependencies.
-
-* Kysely should work in all JavaScript environments (node.js, deno & modern browsers), 
-even though the main focus is node.js.
-
-* Everything is immutable.
-
-* The API should be as close to writing raw SQL as possible while still providing 
-type safety.
-
-* Everything outside of dialect implementations is dialect-agnostic.
-
-* Everything is tested.
-
-    * Functionality - No mocks. Everything is tested against real database instances.
-    No partial testing. If a sql "thing" is supported by some databases, test it
-    against all of them.
-
-    * Types - We're a type-safe package, you get the idea.
-
-* Everything consumer-facing should be documented.
-
-* Everything is type-safe. Things that cannot be implemented in a way that is safe 
-for all cases, are best left for consumers to implement.
-
-* Most features should have escape hatches.
-
-# Getting started
-
-1. fork kysely.
-
-2. clone your fork.
-
-3. install node.js (preferable latest LTS).
-
-4. run `npm i` in your terminal to install dev dependencies.
-
-5. create a branch.
-
-6. create a draft pull request. link the relevant issue by referring to it in the 
-PR's description. E.g. `closes #123` will link the PR to issue/pull request #123.
-
-7. implement your changes.
-
-# Testing
-
-1. write functionality tests in `test/node`.
-
-2. write typings tests in `test/typings/test-d`
-
-3. install docker.
-
-4. run `docker-compose up` in your terminal to spin up database instances.
-
-5. run `npm test` in your terminal to run tests.

package/dist/cjs/operation-node/primary-constraint-node.d.ts

@@ -1,15 +0,0 @@
-import { ColumnNode } from './column-node.js';
-import { IdentifierNode } from './identifier-node.js';
-import { OperationNode } from './operation-node.js';
-export interface PrimaryKeyConstraintNode extends OperationNode {
-    readonly kind: 'PrimaryKeyConstraintNode';
-    readonly columns: ReadonlyArray<ColumnNode>;
-    readonly name?: IdentifierNode;
-}
-/**
- * @internal
- */
-export declare const PrimaryConstraintNode: Readonly<{
-    is(node: OperationNode): node is PrimaryKeyConstraintNode;
-    create(columns: string[], constraintName?: string): PrimaryKeyConstraintNode;
-}>;

package/dist/cjs/util/prevent-await.d.ts

@@ -1 +0,0 @@
-export declare function preventAwait(clazz: Function, message: string): void;

package/dist/cjs/util/prevent-await.js

@@ -1,13 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.preventAwait = preventAwait;
-function preventAwait(clazz, message) {
-    Object.defineProperties(clazz.prototype, {
-        then: {
-            enumerable: false,
-            value: () => {
-                throw new Error(message);
-            },
-        },
-    });
-}

package/dist/esm/operation-node/primary-constraint-node.d.ts

@@ -1,15 +0,0 @@
-import { ColumnNode } from './column-node.js';
-import { IdentifierNode } from './identifier-node.js';
-import { OperationNode } from './operation-node.js';
-export interface PrimaryKeyConstraintNode extends OperationNode {
-    readonly kind: 'PrimaryKeyConstraintNode';
-    readonly columns: ReadonlyArray<ColumnNode>;
-    readonly name?: IdentifierNode;
-}
-/**
- * @internal
- */
-export declare const PrimaryConstraintNode: Readonly<{
-    is(node: OperationNode): node is PrimaryKeyConstraintNode;
-    create(columns: string[], constraintName?: string): PrimaryKeyConstraintNode;
-}>;

package/dist/esm/util/prevent-await.d.ts

@@ -1 +0,0 @@
-export declare function preventAwait(clazz: Function, message: string): void;

package/dist/esm/util/prevent-await.js

@@ -1,11 +0,0 @@
-/// <reference types="./prevent-await.d.ts" />
-export function preventAwait(clazz, message) {
-    Object.defineProperties(clazz.prototype, {
-        then: {
-            enumerable: false,
-            value: () => {
-                throw new Error(message);
-            },
-        },
-    });
-}