kysely 0.20.0 → 0.21.1

package/dist/esm/plugin/with-schema/with-schema-transformer.js

@@ -1,119 +1,111 @@
 /// <reference types="./with-schema-transformer.d.ts" />
 import { AliasNode } from '../../operation-node/alias-node.js';
+import { IdentifierNode } from '../../operation-node/identifier-node.js';
 import { OperationNodeTransformer } from '../../operation-node/operation-node-transformer.js';
+import { SchemableIdentifierNode } from '../../operation-node/schemable-identifier-node.js';
 import { TableNode } from '../../operation-node/table-node.js';
+import { freeze } from '../../util/object-utils.js';
+// This object exist only so that we get a type error when a new RootOperationNode
+// is added. If you get a type error here, make sure to add the new root node and
+// handle it correctly in the transformer.
+//
+// DO NOT REFACTOR THIS EVEN IF IT SEEMS USELESS TO YOU!
+const ROOT_OPERATION_NODES = freeze({
+    AlterTableNode: true,
+    CreateIndexNode: true,
+    CreateSchemaNode: true,
+    CreateTableNode: true,
+    CreateTypeNode: true,
+    CreateViewNode: true,
+    DeleteQueryNode: true,
+    DropIndexNode: true,
+    DropSchemaNode: true,
+    DropTableNode: true,
+    DropTypeNode: true,
+    DropViewNode: true,
+    InsertQueryNode: true,
+    RawNode: true,
+    SelectQueryNode: true,
+    UpdateQueryNode: true,
+});
 export class WithSchemaTransformer extends OperationNodeTransformer {
     #schema;
-    #tables = new Set();
+    #schemableIds = new Set();
     constructor(schema) {
         super();
         this.#schema = schema;
     }
-    transformSelectQuery(node) {
-        return this.#transformRoot(node, (node) => super.transformSelectQuery(node));
-    }
-    transformInsertQuery(node) {
-        return this.#transformRoot(node, (node) => super.transformInsertQuery(node));
-    }
-    transformUpdateQuery(node) {
-        return this.#transformRoot(node, (node) => super.transformUpdateQuery(node));
-    }
-    transformDeleteQuery(node) {
-        return this.#transformRoot(node, (node) => super.transformDeleteQuery(node));
-    }
-    transformCreateTable(node) {
-        return this.#transformRoot(node, (node) => super.transformCreateTable(node));
-    }
-    transformDropTable(node) {
-        return this.#transformRoot(node, (node) => super.transformDropTable(node));
-    }
-    transformCreateIndex(node) {
-        return this.#transformRoot(node, (node) => super.transformCreateIndex(node));
-    }
-    transformDropIndex(node) {
-        return this.#transformRoot(node, (node) => super.transformDropIndex(node));
-    }
-    transformCreateView(node) {
-        return this.#transformRoot(node, (node) => super.transformCreateView(node));
-    }
-    transformDropView(node) {
-        return this.#transformRoot(node, (node) => super.transformDropView(node));
-    }
-    transformCreateType(node) {
-        return this.#transformRoot(node, (node) => super.transformCreateType(node));
-    }
-    transformDropType(node) {
-        return this.#transformRoot(node, (node) => super.transformDropType(node));
-    }
-    transformAlterTable(node) {
-        return this.#transformRoot(node, (node) => super.transformAlterTable(node));
+    transformNodeImpl(node) {
+        if (!this.#isRootOperationNode(node)) {
+            return super.transformNodeImpl(node);
+        }
+        const tables = this.#collectSchemableIds(node);
+        for (const table of tables) {
+            this.#schemableIds.add(table);
+        }
+        const transformed = super.transformNodeImpl(node);
+        for (const table of tables) {
+            this.#schemableIds.delete(table);
+        }
+        return transformed;
     }
-    transformTable(node) {
-        const transformed = super.transformTable(node);
-        if (transformed.schema || !this.#tables.has(node.table.identifier)) {
+    transformSchemableIdentifier(node) {
+        const transformed = super.transformSchemableIdentifier(node);
+        if (transformed.schema || !this.#schemableIds.has(node.identifier.name)) {
             return transformed;
         }
         return {
             ...transformed,
-            schema: {
-                kind: 'IdentifierNode',
-                identifier: this.#schema,
-            },
+            schema: IdentifierNode.create(this.#schema),
         };
     }
-    #transformRoot(node, transform) {
-        const tables = this.#collectTables(node);
-        for (const table of tables) {
-            this.#tables.add(table);
-        }
-        const transformed = transform(node);
-        for (const table of tables) {
-            this.#tables.delete(table);
-        }
-        return transformed;
+    #isRootOperationNode(node) {
+        return node.kind in ROOT_OPERATION_NODES;
     }
-    #collectTables(node) {
-        const tables = new Set();
+    #collectSchemableIds(node) {
+        const schemableIds = new Set();
+        if ('name' in node && node.name && SchemableIdentifierNode.is(node.name)) {
+            this.#collectSchemableId(node.name, schemableIds);
+        }
         if ('from' in node && node.from) {
-            this.#collectTablesFromTableExpressionNodes(node.from.froms, tables);
+            for (const from of node.from.froms) {
+                this.#collectSchemableIdsFromTableExpr(from, schemableIds);
+            }
         }
         if ('into' in node && node.into) {
-            this.#collectTablesFromTableExpressionNode(node.into, tables);
+            this.#collectSchemableIdsFromTableExpr(node.into, schemableIds);
         }
         if ('table' in node && node.table) {
-            this.#collectTablesFromTableExpressionNode(node.table, tables);
+            this.#collectSchemableIdsFromTableExpr(node.table, schemableIds);
         }
         if ('joins' in node && node.joins) {
-            this.#collectTablesFromJoins(node.joins, tables);
+            for (const join of node.joins) {
+                this.#collectSchemableIdsFromTableExpr(join.table, schemableIds);
+            }
         }
         if ('with' in node && node.with) {
-            this.#removeCommonTableExpressionTables(node.with, tables);
-        }
-        return tables;
-    }
-    #collectTablesFromTableExpressionNodes(nodes, tables) {
-        for (const node of nodes) {
-            this.#collectTablesFromTableExpressionNode(node, tables);
+            this.#removeCommonTableExpressionTables(node.with, schemableIds);
         }
+        return schemableIds;
     }
-    #collectTablesFromJoins(nodes, tables) {
-        for (const node of nodes) {
-            this.#collectTablesFromTableExpressionNode(node.table, tables);
-        }
-    }
-    #collectTablesFromTableExpressionNode(node, tables) {
+    #collectSchemableIdsFromTableExpr(node, schemableIds) {
         const table = TableNode.is(node)
             ? node
             : AliasNode.is(node) && TableNode.is(node.node)
                 ? node.node
                 : null;
-        if (table && !this.#tables.has(table.table.identifier)) {
-            tables.add(table.table.identifier);
+        if (table) {
+            this.#collectSchemableId(table.table, schemableIds);
+        }
+    }
+    #collectSchemableId(node, schemableIds) {
+        if (!this.#schemableIds.has(node.identifier.name)) {
+            schemableIds.add(node.identifier.name);
         }
     }
-    #removeCommonTableExpressionTables(node, tables) {
+    #removeCommonTableExpressionTables(node, schemableIds) {
         for (const expr of node.expressions) {
-            tables.delete(expr.name.table.table.identifier);
+            schemableIds.delete(expr.name.table.table.identifier.name);
         }
     }
 }

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

@@ -12,6 +12,7 @@ import { OrderByDirectionExpression, OrderByExpression } from '../parser/order-b
 import { Compilable } from '../util/compilable.js';
 import { QueryExecutor } from '../query-executor/query-executor.js';
 import { QueryId } from '../util/query-id.js';
+import { GroupByExpression } from '../parser/group-by-parser.js';
 import { UnionExpression } from '../parser/union-parser.js';
 import { KyselyPlugin } from '../plugin/kysely-plugin.js';
 import { WhereInterface } from './where-interface.js';
@@ -1144,8 +1145,8 @@ export declare class SelectQueryBuilder<DB, TB extends keyof DB, O> implements W
      * group by "first_name"
      * ```
      */
-    groupBy(groupBy: ReadonlyArray<ReferenceExpression<DB, TB>>): SelectQueryBuilder<DB, TB, O>;
-    groupBy(groupBy: ReferenceExpression<DB, TB>): SelectQueryBuilder<DB, TB, O>;
+    groupBy(groupBy: ReadonlyArray<GroupByExpression<DB, TB, O>>): SelectQueryBuilder<DB, TB, O>;
+    groupBy(groupBy: GroupByExpression<DB, TB, O>): SelectQueryBuilder<DB, TB, O>;
     /**
      * Adds a limit clause to the query.
      *

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

@@ -11,7 +11,7 @@ import { preventAwait } from '../util/prevent-await.js';
 import { LimitNode } from '../operation-node/limit-node.js';
 import { OffsetNode } from '../operation-node/offset-node.js';
 import { freeze } from '../util/object-utils.js';
-import { parseGroupBy } from '../parser/group-by-parser.js';
+import { parseGroupBy, } from '../parser/group-by-parser.js';
 import { parseUnion } from '../parser/union-parser.js';
 import { NoResultError } from './no-result-error.js';
 import { IdentifierNode } from '../operation-node/identifier-node.js';

package/dist/esm/query-compiler/default-query-compiler.d.ts

@@ -72,6 +72,7 @@ import { SelectModifierNode } from '../operation-node/select-modifier-node.js';
 import { CreateTypeNode } from '../operation-node/create-type-node.js';
 import { DropTypeNode } from '../operation-node/drop-type-node.js';
 import { ExplainNode } from '../operation-node/explain-node.js';
+import { SchemableIdentifierNode } from '../operation-node/schemable-identifier-node.js';
 export declare class DefaultQueryCompiler extends OperationNodeVisitor implements QueryCompiler {
     #private;
     protected get numParameters(): number;
@@ -106,6 +107,7 @@ export declare class DefaultQueryCompiler extends OperationNodeVisitor implement
     protected visitRaw(node: RawNode): void;
     protected visitOperator(node: OperatorNode): void;
     protected visitTable(node: TableNode): void;
+    protected visitSchemableIdentifier(node: SchemableIdentifierNode): void;
     protected visitCreateTable(node: CreateTableNode): void;
     protected visitColumnDefinition(node: ColumnDefinitionNode): void;
     protected getAutoIncrement(): string;

package/dist/esm/query-compiler/default-query-compiler.js

@@ -237,10 +237,10 @@ export class DefaultQueryCompiler extends OperationNodeVisitor {
         this.append(this.getRightIdentifierWrapper());
     }
     compileUnwrappedIdentifier(node) {
-        if (!isString(node.identifier)) {
+        if (!isString(node.name)) {
             throw new Error('a non-string identifier was passed to compileUnwrappedIdentifier.');
         }
-        this.append(this.sanitizeIdentifier(node.identifier));
+        this.append(this.sanitizeIdentifier(node.name));
     }
     visitFilter(node) {
         if (node.left) {
@@ -316,11 +316,14 @@ export class DefaultQueryCompiler extends OperationNodeVisitor {
         this.append(node.operator);
     }
     visitTable(node) {
+        this.visitNode(node.table);
+    }
+    visitSchemableIdentifier(node) {
         if (node.schema) {
             this.visitNode(node.schema);
             this.append('.');
         }
-        this.visitNode(node.table);
+        this.visitNode(node.identifier);
     }
     visitCreateTable(node) {
         this.append('create ');

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

@@ -92,7 +92,7 @@ export declare class AlterTableAddColumnBuilder implements ColumnDefinitionBuild
      * Makes the column the primary key.
      *
      * If you want to specify a composite primary key use the
-     * {@link TableBuilder.addPrimaryKeyConstraint} method.
+     * {@link CreateTableBuilder.addPrimaryKeyConstraint} method.
      */
     primaryKey(): AlterTableAddColumnBuilder;
     /**
@@ -100,7 +100,7 @@ export declare class AlterTableAddColumnBuilder implements ColumnDefinitionBuild
      *
      * If your database engine doesn't support foreign key constraints in the
      * column definition (like MySQL 5) you need to call the table level
-     * {@link TableBuilder.addForeignKeyConstraint} method instead.
+     * {@link CreateTableBuilder.addForeignKeyConstraint} method instead.
      *
      * ### Examples
      *
@@ -114,7 +114,7 @@ export declare class AlterTableAddColumnBuilder implements ColumnDefinitionBuild
      *
      * If your database engine doesn't support foreign key constraints in the
      * column definition (like MySQL 5) you need to call the table level
-     * {@link TableBuilder.addForeignKeyConstraint} method instead.
+     * {@link CreateTableBuilder.addForeignKeyConstraint} method instead.
      *
      * ### Examples
      *
@@ -258,7 +258,7 @@ export declare class AlterTableModifyColumnBuilder implements ColumnDefinitionBu
      * Makes the column the primary key.
      *
      * If you want to specify a composite primary key use the
-     * {@link TableBuilder.addPrimaryKeyConstraint} method.
+     * {@link CreateTableBuilder.addPrimaryKeyConstraint} method.
      */
     primaryKey(): AlterTableModifyColumnBuilder;
     /**
@@ -266,7 +266,7 @@ export declare class AlterTableModifyColumnBuilder implements ColumnDefinitionBu
      *
      * If your database engine doesn't support foreign key constraints in the
      * column definition (like MySQL 5) you need to call the table level
-     * {@link TableBuilder.addForeignKeyConstraint} method instead.
+     * {@link CreateTableBuilder.addForeignKeyConstraint} method instead.
      *
      * ### Examples
      *
@@ -280,7 +280,7 @@ export declare class AlterTableModifyColumnBuilder implements ColumnDefinitionBu
      *
      * If your database engine doesn't support foreign key constraints in the
      * column definition (like MySQL 5) you need to call the table level
-     * {@link TableBuilder.addForeignKeyConstraint} method instead.
+     * {@link CreateTableBuilder.addForeignKeyConstraint} method instead.
      *
      * ### Examples
      *

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

@@ -16,7 +16,7 @@ export interface ColumnDefinitionBuilderInterface {
      * Makes the column the primary key.
      *
      * If you want to specify a composite primary key use the
-     * {@link TableBuilder.addPrimaryKeyConstraint} method.
+     * {@link CreateTableBuilder.addPrimaryKeyConstraint} method.
      */
     primaryKey(): ColumnDefinitionBuilderInterface;
     /**
@@ -24,7 +24,7 @@ export interface ColumnDefinitionBuilderInterface {
      *
      * If your database engine doesn't support foreign key constraints in the
      * column definition (like MySQL 5) you need to call the table level
-     * {@link TableBuilder.addForeignKeyConstraint} method instead.
+     * {@link CreateTableBuilder.addForeignKeyConstraint} method instead.
      *
      * ### Examples
      *
@@ -38,7 +38,7 @@ export interface ColumnDefinitionBuilderInterface {
      *
      * If your database engine doesn't support foreign key constraints in the
      * column definition (like MySQL 5) you need to call the table level
-     * {@link TableBuilder.addForeignKeyConstraint} method instead.
+     * {@link CreateTableBuilder.addForeignKeyConstraint} method instead.
      *
      * ### Examples
      *
@@ -175,7 +175,7 @@ export declare class ColumnDefinitionBuilder implements ColumnDefinitionBuilderI
      * Makes the column the primary key.
      *
      * If you want to specify a composite primary key use the
-     * {@link TableBuilder.addPrimaryKeyConstraint} method.
+     * {@link CreateTableBuilder.addPrimaryKeyConstraint} method.
      */
     primaryKey(): ColumnDefinitionBuilder;
     /**
@@ -183,7 +183,7 @@ export declare class ColumnDefinitionBuilder implements ColumnDefinitionBuilderI
      *
      * If your database engine doesn't support foreign key constraints in the
      * column definition (like MySQL 5) you need to call the table level
-     * {@link TableBuilder.addForeignKeyConstraint} method instead.
+     * {@link CreateTableBuilder.addForeignKeyConstraint} method instead.
      *
      * ### Examples
      *
@@ -197,7 +197,7 @@ export declare class ColumnDefinitionBuilder implements ColumnDefinitionBuilderI
      *
      * If your database engine doesn't support foreign key constraints in the
      * column definition (like MySQL 5) you need to call the table level
-     * {@link TableBuilder.addForeignKeyConstraint} method instead.
+     * {@link CreateTableBuilder.addForeignKeyConstraint} method instead.
      *
      * ### Examples
      *

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "kysely",
-  "version": "0.20.0",
+  "version": "0.21.1",
   "description": "Type safe SQL query builder",
   "repository": {
     "type": "git",
@@ -48,6 +48,7 @@
     "@types/chai-subset": "^1.3.3",
     "@types/mocha": "^9.1.1",
     "@types/pg": "^8.6.5",
+    "@types/pg-cursor": "^2.7.0",
     "@types/sinon": "^10.0.13",
     "better-sqlite3": "^7.5.3",
     "chai": "^4.3.6",