kysely 0.2.2 → 0.2.6

package/lib/schema/drop-index-builder.js

@@ -6,9 +6,9 @@ const prevent_await_1 = require("../util/prevent-await");
 class DropIndexBuilder {
     #dropIndexNode;
     #executor;
-    constructor({ dropIndexNode, executor }) {
-        this.#dropIndexNode = dropIndexNode;
-        this.#executor = executor;
+    constructor(args) {
+        this.#dropIndexNode = args.dropIndexNode;
+        this.#executor = args.executor;
     }
     ifExists() {
         return new DropIndexBuilder({

package/lib/schema/drop-schema-builder.d.ts

@@ -2,10 +2,10 @@ import { DropSchemaNode } from '../operation-node/drop-schema-node';
 import { OperationNodeSource } from '../operation-node/operation-node-source';
 import { CompiledQuery } from '../query-compiler/compiled-query';
 import { Compilable } from '../util/compilable';
-import { QueryExecutor } from '../util/query-executor';
+import { QueryExecutor } from '../query-executor/query-executor';
 export declare class DropSchemaBuilder implements OperationNodeSource, Compilable {
     #private;
-    constructor({ dropSchemaNode, executor }: DropSchemaBuilderConstructorArgs);
+    constructor(args: DropSchemaBuilderConstructorArgs);
     ifExists(): DropSchemaBuilder;
     toOperationNode(): DropSchemaNode;
     compile(): CompiledQuery;

package/lib/schema/drop-schema-builder.js

@@ -6,9 +6,9 @@ const prevent_await_1 = require("../util/prevent-await");
 class DropSchemaBuilder {
     #dropSchemaNode;
     #executor;
-    constructor({ dropSchemaNode, executor }) {
-        this.#dropSchemaNode = dropSchemaNode;
-        this.#executor = executor;
+    constructor(args) {
+        this.#dropSchemaNode = args.dropSchemaNode;
+        this.#executor = args.executor;
     }
     ifExists() {
         return new DropSchemaBuilder({

package/lib/schema/drop-table-builder.d.ts

@@ -2,10 +2,10 @@ import { DropTableNode } from '../operation-node/drop-table-node';
 import { OperationNodeSource } from '../operation-node/operation-node-source';
 import { CompiledQuery } from '../query-compiler/compiled-query';
 import { Compilable } from '../util/compilable';
-import { QueryExecutor } from '../util/query-executor';
+import { QueryExecutor } from '../query-executor/query-executor';
 export declare class DropTableBuilder implements OperationNodeSource, Compilable {
     #private;
-    constructor({ dropTableNode, executor }: DropTableBuilderConstructorArgs);
+    constructor(args: DropTableBuilderConstructorArgs);
     ifExists(): DropTableBuilder;
     toOperationNode(): DropTableNode;
     compile(): CompiledQuery;

package/lib/schema/drop-table-builder.js

@@ -6,9 +6,9 @@ const prevent_await_1 = require("../util/prevent-await");
 class DropTableBuilder {
     #dropTableNode;
     #executor;
-    constructor({ dropTableNode, executor }) {
-        this.#dropTableNode = dropTableNode;
-        this.#executor = executor;
+    constructor(args) {
+        this.#dropTableNode = args.dropTableNode;
+        this.#executor = args.executor;
     }
     ifExists() {
         return new DropTableBuilder({

package/lib/schema/schema.d.ts

@@ -1,4 +1,5 @@
-import { QueryExecutor } from '../util/query-executor';
+import { QueryExecutor } from '../query-executor/query-executor';
+import { AlterTableBuilder } from './alter-table-builder';
 import { CreateIndexBuilder } from './create-index-builder';
 import { CreateSchemaBuilder } from './create-schema-builder';
 import { CreateTableBuilder } from './create-table-builder';
@@ -21,10 +22,10 @@ export declare class SchemaModule {
      * ```ts
      * await db.schema
      *   .createTable('person')
-     *   .addColumn('int', 'id', col => col.primaryKey().increments())
-     *   .addColumn('varchar', 'first_name', col => col.notNullable())
-     *   .addColumn('varchar', 'last_name', col => col.notNullable())
-     *   .addColumn('varchar', 'gender')
+     *   .addColumn('id', 'int', col => col.primaryKey().increments())
+     *   .addColumn('first_name', 'varchar', col => col.notNull())
+     *   .addColumn('last_name', 'varchar', col => col.notNull())
+     *   .addColumn('gender', 'varchar')
      *   .execute()
      * ```
      */
@@ -86,6 +87,19 @@ export declare class SchemaModule {
      * ```
      */
     dropSchema(schema: string): DropSchemaBuilder;
+    /**
+     * Alter a table.
+     *
+     * @example
+     * ```ts
+     * await db.schema
+     *   .alterTable('person')
+     *   .alterColumn('first_name')
+     *   .setDataType('text')
+     *   .execute()
+     * ```
+     */
+    alterTable(table: string): AlterTableBuilder;
     /**
      * See {@link QueryCreator.withSchema}
      */

package/lib/schema/schema.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SchemaModule = void 0;
+const alter_table_node_1 = require("../operation-node/alter-table-node");
 const create_index_node_1 = require("../operation-node/create-index-node");
 const create_schema_node_1 = require("../operation-node/create-schema-node");
 const create_table_node_1 = require("../operation-node/create-table-node");
@@ -9,6 +10,7 @@ const drop_schema_node_1 = require("../operation-node/drop-schema-node");
 const drop_table_node_1 = require("../operation-node/drop-table-node");
 const table_parser_1 = require("../parser/table-parser");
 const with_schema_transformer_1 = require("../transformers/with-schema-transformer");
+const alter_table_builder_1 = require("./alter-table-builder");
 const create_index_builder_1 = require("./create-index-builder");
 const create_schema_builder_1 = require("./create-schema-builder");
 const create_table_builder_1 = require("./create-table-builder");
@@ -33,10 +35,10 @@ class SchemaModule {
      * ```ts
      * await db.schema
      *   .createTable('person')
-     *   .addColumn('int', 'id', col => col.primaryKey().increments())
-     *   .addColumn('varchar', 'first_name', col => col.notNullable())
-     *   .addColumn('varchar', 'last_name', col => col.notNullable())
-     *   .addColumn('varchar', 'gender')
+     *   .addColumn('id', 'int', col => col.primaryKey().increments())
+     *   .addColumn('first_name', 'varchar', col => col.notNull())
+     *   .addColumn('last_name', 'varchar', col => col.notNull())
+     *   .addColumn('gender', 'varchar')
      *   .execute()
      * ```
      */
@@ -128,6 +130,24 @@ class SchemaModule {
             dropSchemaNode: drop_schema_node_1.dropSchemaNode.create(schema),
         });
     }
+    /**
+     * Alter a table.
+     *
+     * @example
+     * ```ts
+     * await db.schema
+     *   .alterTable('person')
+     *   .alterColumn('first_name')
+     *   .setDataType('text')
+     *   .execute()
+     * ```
+     */
+    alterTable(table) {
+        return new alter_table_builder_1.AlterTableBuilder({
+            executor: this.#executor,
+            alterTableNode: alter_table_node_1.alterTableNode.create(table),
+        });
+    }
     /**
      * See {@link QueryCreator.withSchema}
      */

package/lib/transformers/with-schema-transformer.d.ts

@@ -1,3 +1,4 @@
+import { AlterTableNode } from '../operation-node/alter-table-node';
 import { CreateIndexNode } from '../operation-node/create-index-node';
 import { CreateTableNode } from '../operation-node/create-table-node';
 import { DeleteQueryNode } from '../operation-node/delete-query-node';
@@ -19,6 +20,7 @@ export declare class WithSchemaTransformer extends OperationNodeTransformer {
     protected transformDropTable(node: DropTableNode): DropTableNode;
     protected transformCreateIndex(node: CreateIndexNode): CreateIndexNode;
     protected transformDropIndex(node: DropIndexNode): DropIndexNode;
+    protected transformAlterTable(node: AlterTableNode): AlterTableNode;
     protected transformTable(node: TableNode): TableNode;
     private transformEntryPoint;
     private collectTables;

package/lib/transformers/with-schema-transformer.js

@@ -35,6 +35,9 @@ class WithSchemaTransformer extends operation_node_transformer_1.OperationNodeTr
     transformDropIndex(node) {
         return this.transformEntryPoint(node, (node) => super.transformDropIndex(node));
     }
+    transformAlterTable(node) {
+        return this.transformEntryPoint(node, (node) => super.transformAlterTable(node));
+    }
     transformTable(node) {
         const transformed = super.transformTable(node);
         if (transformed.schema || !this.#tables.has(node.table.identifier)) {

package/lib/util/object-utils.d.ts

@@ -14,3 +14,4 @@ export declare function isObject(obj: any): obj is Record<string, any>;
 export declare function getLast<T>(arr: ArrayLike<T>): T | undefined;
 export declare function freeze<T>(obj: T): Readonly<T>;
 export declare function asArray<T>(arg: T | T[]): T[];
+export declare function asReadonlyArray<T>(arg: T | ReadonlyArray<T>): ReadonlyArray<T>;

package/lib/util/object-utils.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.asArray = exports.freeze = exports.getLast = exports.isObject = exports.isFunction = exports.isPrimitive = exports.isBigInt = exports.isBuffer = exports.isDate = exports.isNull = exports.isBoolean = exports.isNumber = exports.isString = exports.isEmpty = void 0;
+exports.asReadonlyArray = exports.asArray = exports.freeze = exports.getLast = exports.isObject = exports.isFunction = exports.isPrimitive = exports.isBigInt = exports.isBuffer = exports.isDate = exports.isNull = exports.isBoolean = exports.isNumber = exports.isString = exports.isEmpty = void 0;
 function isEmpty(obj) {
     if (Array.isArray(obj) || isString(obj) || Buffer.isBuffer(obj)) {
         return obj.length === 0;
@@ -74,3 +74,15 @@ function asArray(arg) {
     }
 }
 exports.asArray = asArray;
+function asReadonlyArray(arg) {
+    if (isReadonlyArray(arg)) {
+        return arg;
+    }
+    else {
+        return freeze([arg]);
+    }
+}
+exports.asReadonlyArray = asReadonlyArray;
+function isReadonlyArray(arg) {
+    return Array.isArray(arg);
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "kysely",
-  "version": "0.2.2",
+  "version": "0.2.6",
   "description": "Type safe SQL query builder",
   "main": "./lib/index.js",
   "types": "./lib/index.d.ts",
@@ -10,7 +10,7 @@
     "test:typings": "npm run build && tsd test/typings",
     "prettier": "prettier --write src/**/*.ts test/**/*.ts",
     "build": "rm -rf lib && tsc",
-    "docs:build": "typedoc  --disableSources --excludePrivate --excludeInternal src/index.ts && npm run docs:postprocess",
+    "docs:build": "typedoc --excludePrivate --excludeInternal src/index.ts && npm run docs:postprocess",
     "docs:postprocess": "node post-process-docs.js",
     "prepublish": "npm run build"
   },

package/lib/operation-node/table-primary-constraint-node.d.ts

@@ -1,10 +0,0 @@
-import { ColumnNode } from './column-node';
-import { OperationNode } from './operation-node';
-export interface TablePrimaryConstraintNode extends OperationNode {
-    readonly kind: 'TablePrimaryConstraintNode';
-    readonly columns: ReadonlyArray<ColumnNode>;
-}
-export declare const tablePrimaryConstraintNode: Readonly<{
-    is(node: OperationNode): node is TablePrimaryConstraintNode;
-    create(columns: string[]): TablePrimaryConstraintNode;
-}>;

package/lib/operation-node/table-primary-constraint-node.js

@@ -1,16 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.tablePrimaryConstraintNode = void 0;
-const object_utils_1 = require("../util/object-utils");
-const column_node_1 = require("./column-node");
-exports.tablePrimaryConstraintNode = object_utils_1.freeze({
-    is(node) {
-        return node.kind === 'TablePrimaryConstraintNode';
-    },
-    create(columns) {
-        return {
-            kind: 'TablePrimaryConstraintNode',
-            columns: columns.map(column_node_1.columnNode.create),
-        };
-    },
-});

package/lib/operation-node/table-unique-constraint-node.d.ts

@@ -1,10 +0,0 @@
-import { ColumnNode } from './column-node';
-import { OperationNode } from './operation-node';
-export interface TableUniqueConstraintNode extends OperationNode {
-    readonly kind: 'TableUniqueConstraintNode';
-    readonly columns: ReadonlyArray<ColumnNode>;
-}
-export declare const tableUniqueConstraintNode: Readonly<{
-    is(node: OperationNode): node is TableUniqueConstraintNode;
-    create(columns: string[]): TableUniqueConstraintNode;
-}>;

package/lib/operation-node/table-unique-constraint-node.js

@@ -1,16 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.tableUniqueConstraintNode = void 0;
-const object_utils_1 = require("../util/object-utils");
-const column_node_1 = require("./column-node");
-exports.tableUniqueConstraintNode = object_utils_1.freeze({
-    is(node) {
-        return node.kind === 'TableUniqueConstraintNode';
-    },
-    create(columns) {
-        return {
-            kind: 'TableUniqueConstraintNode',
-            columns: columns.map(column_node_1.columnNode.create),
-        };
-    },
-});

package/lib/schema/add-column-builder.js

@@ -1,116 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.AddColumnBuilder = void 0;
-const check_constraint_node_1 = require("../operation-node/check-constraint-node");
-const add_column_node_1 = require("../operation-node/add-column-node");
-const operation_node_source_1 = require("../operation-node/operation-node-source");
-const reference_node_1 = require("../operation-node/reference-node");
-const references_node_1 = require("../operation-node/references-node");
-const select_all_node_1 = require("../operation-node/select-all-node");
-const value_node_1 = require("../operation-node/value-node");
-const reference_parser_1 = require("../parser/reference-parser");
-const prevent_await_1 = require("../util/prevent-await");
-class AddColumnBuilder {
-    #node;
-    constructor(node) {
-        this.#node = node;
-    }
-    /**
-     * Makes the column automatically incrementing.
-     *
-     * On some dialects this may change the column type as well. For example
-     * on postgres this sets the column type to `serial` no matter what you
-     * have specified before.
-     */
-    increments() {
-        return new AddColumnBuilder(add_column_node_1.addColumnNode.cloneWith(this.#node, { isAutoIncrementing: true }));
-    }
-    /**
-     * Makes the column the primary key.
-     *
-     * If you want to specify a composite primary key use the
-     * {@link TableBuilder.addPrimaryKeyConstraint} method.
-     */
-    primaryKey() {
-        return new AddColumnBuilder(add_column_node_1.addColumnNode.cloneWith(this.#node, { isPrimaryKey: true }));
-    }
-    /**
-     * Adds a foreign key constraint for the column.
-     *
-     * @example
-     * ```ts
-     * col.references('person.id')
-     * ```
-     */
-    references(ref) {
-        const references = reference_parser_1.parseStringReference(ref);
-        if (!reference_node_1.referenceNode.is(references) || select_all_node_1.selectAllNode.is(references.column)) {
-            throw new Error(`invalid call references('${ref}'). The reference must have format table.column or schema.table.column`);
-        }
-        return new AddColumnBuilder(add_column_node_1.addColumnNode.cloneWith(this.#node, {
-            references: references_node_1.referencesNode.create(references.table, references.column),
-        }));
-    }
-    /**
-     * Adds an `on delete` constraint for the foreign key column.
-     */
-    onDelete(onDelete) {
-        if (!this.#node.references) {
-            throw new Error('on delete constraint can only be added for foreign keys');
-        }
-        return new AddColumnBuilder(add_column_node_1.addColumnNode.cloneWith(this.#node, {
-            references: references_node_1.referencesNode.cloneWithOnDelete(this.#node.references, onDelete),
-        }));
-    }
-    /**
-     * Adds a unique constraint for the column.
-     */
-    unique() {
-        return new AddColumnBuilder(add_column_node_1.addColumnNode.cloneWith(this.#node, { isUnique: true }));
-    }
-    /**
-     * Adds a `not null` constraint for the column.
-     */
-    notNullable() {
-        return new AddColumnBuilder(add_column_node_1.addColumnNode.cloneWith(this.#node, { isNullable: false }));
-    }
-    /**
-     * Adds a default value constraint for the column.
-     *
-     * @example
-     * ```ts
-     * db.schema
-     *   .createTable('pet')
-     *   .addColumn('integer', 'number_of_legs', (col) => col.defaultTo(4))
-     *   .execute()
-     * ```
-     */
-    defaultTo(value) {
-        return new AddColumnBuilder(add_column_node_1.addColumnNode.cloneWith(this.#node, {
-            defaultTo: operation_node_source_1.isOperationNodeSource(value)
-                ? value.toOperationNode()
-                : value_node_1.valueNode.createImmediate(value),
-        }));
-    }
-    /**
-     * Adds a check constraint for the column.
-     *
-     * @example
-     * ```ts
-     * db.schema
-     *   .createTable('pet')
-     *   .addColumn('integer', 'number_of_legs', (col) => col.check('number_of_legs < 5'))
-     *   .execute()
-     * ```
-     */
-    check(sql) {
-        return new AddColumnBuilder(add_column_node_1.addColumnNode.cloneWith(this.#node, {
-            check: check_constraint_node_1.checkConstraintNode.create(sql),
-        }));
-    }
-    toOperationNode() {
-        return this.#node;
-    }
-}
-exports.AddColumnBuilder = AddColumnBuilder;
-prevent_await_1.preventAwait(AddColumnBuilder, "don't await ColumnBuilder instances directly.");