velocious 1.0.108 → 1.0.110

package/dist/src/database/record/relationships/has-one.js

@@ -0,0 +1,30 @@
+// @ts-check
+import BaseRelationship from "./base.js";
+import * as inflection from "inflection";
+export default class VelociousDatabaseRecordHasOneRelationship extends BaseRelationship {
+    /** @returns {string} */
+    getForeignKey() {
+        if (!this.foreignKey) {
+            this.foreignKey = `${inflection.underscore(this.modelClass.name)}_id`;
+        }
+        return this.foreignKey;
+    }
+    /** @returns {string | undefined} */
+    getInverseOf() {
+        if (!this._inverseOf && !this._autoGenerateInverseOfAttempted) {
+            this._autoGenerateInverseOfAttempted = true;
+            // Only make auto-inverse-of if the relationships name matches the target model class's name
+            const targetClassSimpleName = `${this.getRelationshipName().substring(0, 1).toUpperCase()}${this.getRelationshipName().substring(1, this.getRelationshipName().length)}`;
+            const targetModelClass = this.getTargetModelClass();
+            if (targetModelClass && targetClassSimpleName == targetModelClass.name) {
+                // Only make auto-inverse-of if the expected relationship exist in a has-one or has-many form
+                const targetClassRelationshipNames = targetModelClass.getRelationshipNames();
+                const autoGeneratedBelongsToInverseOfName = `${this.modelClass.name.substring(0, 1).toLowerCase()}${this.modelClass.name.substring(1, this.modelClass.name.length)}`;
+                if (targetClassRelationshipNames.includes(autoGeneratedBelongsToInverseOfName)) {
+                    this._inverseOf = autoGeneratedBelongsToInverseOfName;
+                }
+            }
+        }
+        return this._inverseOf;
+    }
+}

package/dist/src/database/record/user-module.d.ts

@@ -0,0 +1,15 @@
+export default class UserModule {
+    /**
+     * @param {object} args
+     * @param {string} args.secretKey
+     */
+    constructor({ secretKey, ...restArgs }: {
+        secretKey: string;
+    });
+    secretKey: string;
+    /**
+     * @param {typeof import("./index.js").default} UserClass
+     */
+    attachTo(UserClass: typeof import("./index.js").default): void;
+}
+//# sourceMappingURL=user-module.d.ts.map

package/dist/src/database/record/user-module.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"user-module.d.ts","sourceRoot":"","sources":["../../../../src/database/record/user-module.js"],"names":[],"mappings":"AAKA;IACE;;;OAGG;IACH,wCAFG;QAAqB,SAAS,EAAtB,MAAM;KAChB,EAOA;IADC,kBAA0B;IAG5B;;OAEG;IACH,oBAFW,cAAc,YAAY,EAAE,OAAO,QAoB7C;CACF"}

package/dist/src/database/record/user-module.js

@@ -0,0 +1,34 @@
+// @ts-check
+import bcryptjs from "bcryptjs";
+import restArgsError from "../../utils/rest-args-error.js";
+export default class UserModule {
+    /**
+     * @param {object} args
+     * @param {string} args.secretKey
+     */
+    constructor({ secretKey, ...restArgs }) {
+        restArgsError(restArgs);
+        if (!secretKey)
+            throw new Error(`Invalid secret key given: ${secretKey}`);
+        this.secretKey = secretKey;
+    }
+    /**
+     * @param {typeof import("./index.js").default} UserClass
+     */
+    attachTo(UserClass) {
+        // @ts-expect-error
+        UserClass.prototype.setPassword = function (newPassword) {
+            const salt = bcryptjs.genSaltSync(10);
+            const encryptedPassword = bcryptjs.hashSync(newPassword, salt);
+            // @ts-expect-error
+            this.setEncryptedPassword(encryptedPassword);
+        };
+        // @ts-expect-error
+        UserClass.prototype.setPasswordConfirmation = function (newPasswordConfirmation) {
+            const salt = bcryptjs.genSaltSync(10);
+            const encryptedPassword = bcryptjs.hashSync(newPasswordConfirmation, salt);
+            // @ts-expect-error
+            this._encryptedPasswordConfirmation = encryptedPassword;
+        };
+    }
+}

package/dist/src/database/record/validators/base.d.ts

@@ -0,0 +1,25 @@
+export default class VelociousDatabaseRecordValidatorsBase {
+    /**
+     * @param {object} args
+     * @param {string} args.attributeName
+     * @param {Record<string, any>} args.args
+     */
+    constructor({ attributeName, args }: {
+        attributeName: string;
+        args: Record<string, any>;
+    });
+    attributeName: string;
+    args: Record<string, any>;
+    /**
+     * @abstract
+     * @param {object} args
+     * @param {import("../index.js").default} args.model
+     * @param {string} args.attributeName
+     * @returns {Promise<void>}
+     */
+    validate({ model, attributeName }: {
+        model: import("../index.js").default;
+        attributeName: string;
+    }): Promise<void>;
+}
+//# sourceMappingURL=base.d.ts.map

package/dist/src/database/record/validators/base.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"base.d.ts","sourceRoot":"","sources":["../../../../../src/database/record/validators/base.js"],"names":[],"mappings":"AAEA;IACE;;;;OAIG;IACH,qCAHG;QAAqB,aAAa,EAA1B,MAAM;QACoB,IAAI,EAA9B,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;KAC7B,EAIA;IAFC,sBAAkC;IAClC,0BAAgB;IAGlB;;;;;;OAMG;IACH,mCAJG;QAA4C,KAAK,EAAzC,OAAO,aAAa,EAAE,OAAO;QAChB,aAAa,EAA1B,MAAM;KACd,GAAU,OAAO,CAAC,IAAI,CAAC,CAIzB;CACF"}

package/dist/src/database/record/validators/base.js

@@ -0,0 +1,22 @@
+// @ts-check
+export default class VelociousDatabaseRecordValidatorsBase {
+    /**
+     * @param {object} args
+     * @param {string} args.attributeName
+     * @param {Record<string, any>} args.args
+     */
+    constructor({ attributeName, args }) {
+        this.attributeName = attributeName;
+        this.args = args;
+    }
+    /**
+     * @abstract
+     * @param {object} args
+     * @param {import("../index.js").default} args.model
+     * @param {string} args.attributeName
+     * @returns {Promise<void>}
+     */
+    async validate({ model, attributeName }) {
+        throw new Error("validate not implemented");
+    }
+}

package/dist/src/database/record/validators/presence.d.ts

@@ -0,0 +1,4 @@
+export default class VelociousDatabaseRecordValidatorsPresence extends Base {
+}
+import Base from "./base.js";
+//# sourceMappingURL=presence.d.ts.map

package/dist/src/database/record/validators/presence.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"presence.d.ts","sourceRoot":"","sources":["../../../../../src/database/record/validators/presence.js"],"names":[],"mappings":"AAIA;CAeC;iBAjBgB,WAAW"}

package/dist/src/database/record/validators/presence.js

@@ -0,0 +1,17 @@
+// @ts-check
+import Base from "./base.js";
+export default class VelociousDatabaseRecordValidatorsPresence extends Base {
+    /**
+     * @param {object} args
+     * @param {import("../index.js").default} args.model
+     * @param {string} args.attributeName
+     */
+    async validate({ model, attributeName }) {
+        const attributeValue = model.readAttribute(attributeName)?.trim();
+        if (!attributeValue) {
+            if (!(attributeName in model._validationErrors))
+                model._validationErrors[attributeName] = [];
+            model._validationErrors[attributeName].push({ type: "presence", message: "can't be blank" });
+        }
+    }
+}

package/dist/src/database/record/validators/uniqueness.d.ts

@@ -0,0 +1,4 @@
+export default class VelociousDatabaseRecordValidatorsUniqueness extends Base {
+}
+import Base from "./base.js";
+//# sourceMappingURL=uniqueness.d.ts.map

package/dist/src/database/record/validators/uniqueness.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"uniqueness.d.ts","sourceRoot":"","sources":["../../../../../src/database/record/validators/uniqueness.js"],"names":[],"mappings":"AAKA;CAoCC;iBAvCgB,WAAW"}

package/dist/src/database/record/validators/uniqueness.js

@@ -0,0 +1,33 @@
+// @ts-check
+import Base from "./base.js";
+import * as inflection from "inflection";
+export default class VelociousDatabaseRecordValidatorsUniqueness extends Base {
+    /**
+     * @param {object} args
+     * @param {import("../index.js").default} args.model
+     * @param {string} args.attributeName
+     * @returns {Promise<void>}
+     */
+    async validate({ model, attributeName }) {
+        const modelClass = /** @type {typeof import("../index.js").default} */ (model.constructor);
+        const connection = modelClass.connection();
+        const tableName = modelClass._getTable().getName();
+        const attributeValue = model.readAttribute(attributeName);
+        const attributeNameUnderscore = inflection.underscore(attributeName);
+        /** @type {Record<string, any>} */
+        const whereArgs = {};
+        whereArgs[attributeNameUnderscore] = attributeValue;
+        let existingRecordQuery = modelClass
+            .select(modelClass.primaryKey())
+            .where(whereArgs);
+        if (model.isPersisted()) {
+            existingRecordQuery.where(`${connection.quoteTable(tableName)}.${connection.quoteColumn(modelClass.primaryKey())} != ${connection.quote(model.id())}`);
+        }
+        const existingRecord = await existingRecordQuery.first();
+        if (existingRecord) {
+            if (!(attributeName in model._validationErrors))
+                model._validationErrors[attributeName] = [];
+            model._validationErrors[attributeName].push({ type: "uniqueness", message: "has already been taken" });
+        }
+    }
+}

package/dist/src/database/table-data/index.d.ts

@@ -0,0 +1,141 @@
+/**
+ * @typedef {object} TableDataArgsType
+ * @property {boolean} ifNotExists
+ */
+export default class TableData {
+    /**
+     * @param {string} name
+     * @param {TableDataArgsType} [args]
+     */
+    constructor(name: string, args?: TableDataArgsType);
+    /** @type {TableColumn[]} */
+    _columns: TableColumn[];
+    /** @type {import("./table-foreign-key.js").default[]} */
+    _foreignKeys: import("./table-foreign-key.js").default[];
+    /** @type {TableIndex[]} */
+    _indexes: TableIndex[];
+    /** @type {TableReference[]} */
+    _references: TableReference[];
+    args: TableDataArgsType;
+    _name: string;
+    /**
+     * @param {string|TableColumn} name
+     * @param {import("./table-column.js").TableColumnArgsType} [args]
+     */
+    addColumn(name: string | TableColumn, args?: import("./table-column.js").TableColumnArgsType): void;
+    /**
+     * @returns {TableColumn[]}
+     */
+    getColumns(): TableColumn[];
+    /**
+     * @param {import("./table-foreign-key.js").default} foreignKey
+     */
+    addForeignKey(foreignKey: import("./table-foreign-key.js").default): void;
+    /**
+     * @returns {import("./table-foreign-key.js").default[]}
+     */
+    getForeignKeys(): import("./table-foreign-key.js").default[];
+    /**
+     * @param {TableIndex} index
+     */
+    addIndex(index: TableIndex): void;
+    /**
+     * @returns {TableIndex[]}
+     */
+    getIndexes(): TableIndex[];
+    /**
+     * @returns {string}
+     */
+    getName(): string;
+    /**
+     * @param {string} newName
+     * @returns {void}
+     */
+    setName(newName: string): void;
+    /**
+     * @returns {boolean}
+     */
+    getIfNotExists(): boolean;
+    /**
+     * @returns {TableReference[]}
+     */
+    getReferences(): TableReference[];
+    /**
+     * @param {string} name
+     * @param {import("./table-column.js").TableColumnArgsType} args
+     * @returns {void}
+     */
+    bigint(name: string, args: import("./table-column.js").TableColumnArgsType): void;
+    /**
+     * @param {string} name
+     * @param {import("./table-column.js").TableColumnArgsType} args
+     * @returns {void}
+     */
+    blob(name: string, args: import("./table-column.js").TableColumnArgsType): void;
+    /**
+     * @param {string} name
+     * @param {import("./table-column.js").TableColumnArgsType} args
+     * @returns {void}
+     */
+    boolean(name: string, args: import("./table-column.js").TableColumnArgsType): void;
+    /**
+     * @param {string} name
+     * @param {import("./table-column.js").TableColumnArgsType} args
+     * @returns {void}
+     */
+    datetime(name: string, args: import("./table-column.js").TableColumnArgsType): void;
+    /**
+     * @param {string} name
+     * @param {import("./table-column.js").TableColumnArgsType} args
+     * @returns {void}
+     */
+    integer(name: string, args: import("./table-column.js").TableColumnArgsType): void;
+    /**
+     * @param {string} name
+     * @param {import("./table-column.js").TableColumnArgsType} args
+     * @returns {void}
+     */
+    json(name: string, args: import("./table-column.js").TableColumnArgsType): void;
+    /**
+     * @param {string} name
+     * @param {import("./table-column.js").TableColumnArgsType} args
+     * @returns {void}
+     */
+    tinyint(name: string, args: import("./table-column.js").TableColumnArgsType): void;
+    /**
+     * @param {string} name
+     * @param {import("./table-column.js").TableColumnArgsType} args
+     * @returns {void}
+     */
+    references(name: string, args: import("./table-column.js").TableColumnArgsType): void;
+    /**
+     * @param {string} name
+     * @param {import("./table-column.js").TableColumnArgsType} args
+     * @returns {void}
+     */
+    string(name: string, args: import("./table-column.js").TableColumnArgsType): void;
+    /**
+     * @param {string} name
+     * @param {import("./table-column.js").TableColumnArgsType} args
+     * @returns {void}
+     */
+    text(name: string, args: import("./table-column.js").TableColumnArgsType): void;
+    /**
+     * @param {import("./table-column.js").TableColumnArgsType} args
+     * @returns {void}
+     */
+    timestamps(args: import("./table-column.js").TableColumnArgsType): void;
+    /**
+     * @param {string} name
+     * @param {import("./table-column.js").TableColumnArgsType} args
+     * @returns {void}
+     */
+    uuid(name: string, args: import("./table-column.js").TableColumnArgsType): void;
+}
+export type TableDataArgsType = {
+    ifNotExists: boolean;
+};
+import TableColumn from "./table-column.js";
+import TableIndex from "./table-index.js";
+import TableReference from "./table-reference.js";
+//# sourceMappingURL=index.d.ts.map

package/dist/src/database/table-data/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/database/table-data/index.js"],"names":[],"mappings":"AAMA;;;GAGG;AAEH;IAaE;;;OAGG;IACH,kBAHW,MAAM,SACN,iBAAiB,EAO3B;IArBD,4BAA4B;IAC5B,UADW,WAAW,EAAE,CACX;IAEb,yDAAyD;IACzD,cADW,OAAO,wBAAwB,EAAE,OAAO,EAAE,CACpC;IAEjB,2BAA2B;IAC3B,UADW,UAAU,EAAE,CACV;IAEb,+BAA+B;IAC/B,aADW,cAAc,EAAE,CACX;IASd,wBAAgB;IAChB,cAAiB;IAGnB;;;OAGG;IACH,gBAHW,MAAM,GAAC,WAAW,SAClB,OAAO,mBAAmB,EAAE,mBAAmB,QAUzD;IAED;;OAEG;IACH,cAFa,WAAW,EAAE,CAEW;IAErC;;OAEG;IACH,0BAFW,OAAO,wBAAwB,EAAE,OAAO,QAEa;IAEhE;;OAEG;IACH,kBAFa,OAAO,wBAAwB,EAAE,OAAO,EAAE,CAEV;IAE7C;;OAEG;IACH,gBAFW,UAAU,QAEwB;IAE7C;;OAEG;IACH,cAFa,UAAU,EAAE,CAEY;IAErC;;OAEG;IACH,WAFa,MAAM,CAEY;IAE/B;;;OAGG;IACH,iBAHW,MAAM,GACJ,IAAI,CAEwB;IAEzC;;OAEG;IACH,kBAFa,OAAO,CAEuC;IAE3D;;OAEG;IACH,iBAFa,cAAc,EAAE,CAEc;IAE3C;;;;OAIG;IACH,aAJW,MAAM,QACN,OAAO,mBAAmB,EAAE,mBAAmB,GAC7C,IAAI,CAEoF;IAErG;;;;OAIG;IACH,WAJW,MAAM,QACN,OAAO,mBAAmB,EAAE,mBAAmB,GAC7C,IAAI,CAEgF;IAEjG;;;;OAIG;IACH,cAJW,MAAM,QACN,OAAO,mBAAmB,EAAE,mBAAmB,GAC7C,IAAI,CAEsF;IAEvG;;;;OAIG;IACH,eAJW,MAAM,QACN,OAAO,mBAAmB,EAAE,mBAAmB,GAC7C,IAAI,CAEwF;IAEzG;;;;OAIG;IACH,cAJW,MAAM,QACN,OAAO,mBAAmB,EAAE,mBAAmB,GAC7C,IAAI,CAEsF;IAEvG;;;;OAIG;IACH,WAJW,MAAM,QACN,OAAO,mBAAmB,EAAE,mBAAmB,GAC7C,IAAI,CAEgF;IAEjG;;;;OAIG;IACH,cAJW,MAAM,QACN,OAAO,mBAAmB,EAAE,mBAAmB,GAC7C,IAAI,CAEsF;IAEvG;;;;OAIG;IACH,iBAJW,MAAM,QACN,OAAO,mBAAmB,EAAE,mBAAmB,GAC7C,IAAI,CAoBhB;IAED;;;;OAIG;IACH,aAJW,MAAM,QACN,OAAO,mBAAmB,EAAE,mBAAmB,GAC7C,IAAI,CAEoF;IAErG;;;;OAIG;IACH,WAJW,MAAM,QACN,OAAO,mBAAmB,EAAE,mBAAmB,GAC7C,IAAI,CAEgF;IAEjG;;;OAGG;IACH,iBAHW,OAAO,mBAAmB,EAAE,mBAAmB,GAC7C,IAAI,CAKhB;IAED;;;;OAIG;IACH,WAJW,MAAM,QACN,OAAO,mBAAmB,EAAE,mBAAmB,GAC7C,IAAI,CAEgF;CAClG;;iBA9La,OAAO;;wBANG,mBAAmB;uBACpB,kBAAkB;2BACd,sBAAsB"}

package/dist/src/database/table-data/index.js

@@ -0,0 +1,167 @@
+// @ts-check
+import TableColumn from "./table-column.js";
+import TableIndex from "./table-index.js";
+import TableReference from "./table-reference.js";
+/**
+ * @typedef {object} TableDataArgsType
+ * @property {boolean} ifNotExists
+ */
+export default class TableData {
+    /** @type {TableColumn[]} */
+    _columns = [];
+    /** @type {import("./table-foreign-key.js").default[]} */
+    _foreignKeys = [];
+    /** @type {TableIndex[]} */
+    _indexes = [];
+    /** @type {TableReference[]} */
+    _references = [];
+    /**
+     * @param {string} name
+     * @param {TableDataArgsType} [args]
+     */
+    constructor(name, args) {
+        if (!name)
+            throw new Error(`Invalid table name: ${name}`);
+        this.args = args;
+        this._name = name;
+    }
+    /**
+     * @param {string|TableColumn} name
+     * @param {import("./table-column.js").TableColumnArgsType} [args]
+     */
+    addColumn(name, args) {
+        if (name instanceof TableColumn) {
+            this.getColumns().push(name);
+        }
+        else {
+            const column = new TableColumn(name, args);
+            this.getColumns().push(column);
+        }
+    }
+    /**
+     * @returns {TableColumn[]}
+     */
+    getColumns() { return this._columns; }
+    /**
+     * @param {import("./table-foreign-key.js").default} foreignKey
+     */
+    addForeignKey(foreignKey) { this._foreignKeys.push(foreignKey); }
+    /**
+     * @returns {import("./table-foreign-key.js").default[]}
+     */
+    getForeignKeys() { return this._foreignKeys; }
+    /**
+     * @param {TableIndex} index
+     */
+    addIndex(index) { this._indexes.push(index); }
+    /**
+     * @returns {TableIndex[]}
+     */
+    getIndexes() { return this._indexes; }
+    /**
+     * @returns {string}
+     */
+    getName() { return this._name; }
+    /**
+     * @param {string} newName
+     * @returns {void}
+     */
+    setName(newName) { this._name = newName; }
+    /**
+     * @returns {boolean}
+     */
+    getIfNotExists() { return this.args?.ifNotExists || false; }
+    /**
+     * @returns {TableReference[]}
+     */
+    getReferences() { return this._references; }
+    /**
+     * @param {string} name
+     * @param {import("./table-column.js").TableColumnArgsType} args
+     * @returns {void}
+     */
+    bigint(name, args) { this.addColumn(name, Object.assign({ isNewColumn: true, type: "bigint" }, args)); }
+    /**
+     * @param {string} name
+     * @param {import("./table-column.js").TableColumnArgsType} args
+     * @returns {void}
+     */
+    blob(name, args) { this.addColumn(name, Object.assign({ isNewColumn: true, type: "blob" }, args)); }
+    /**
+     * @param {string} name
+     * @param {import("./table-column.js").TableColumnArgsType} args
+     * @returns {void}
+     */
+    boolean(name, args) { this.addColumn(name, Object.assign({ isNewColumn: true, type: "boolean" }, args)); }
+    /**
+     * @param {string} name
+     * @param {import("./table-column.js").TableColumnArgsType} args
+     * @returns {void}
+     */
+    datetime(name, args) { this.addColumn(name, Object.assign({ isNewColumn: true, type: "datetime" }, args)); }
+    /**
+     * @param {string} name
+     * @param {import("./table-column.js").TableColumnArgsType} args
+     * @returns {void}
+     */
+    integer(name, args) { this.addColumn(name, Object.assign({ isNewColumn: true, type: "integer" }, args)); }
+    /**
+     * @param {string} name
+     * @param {import("./table-column.js").TableColumnArgsType} args
+     * @returns {void}
+     */
+    json(name, args) { this.addColumn(name, Object.assign({ isNewColumn: true, type: "json" }, args)); }
+    /**
+     * @param {string} name
+     * @param {import("./table-column.js").TableColumnArgsType} args
+     * @returns {void}
+     */
+    tinyint(name, args) { this.addColumn(name, Object.assign({ isNewColumn: true, type: "tinyint" }, args)); }
+    /**
+     * @param {string} name
+     * @param {import("./table-column.js").TableColumnArgsType} args
+     * @returns {void}
+     */
+    references(name, args) {
+        const columnName = `${name}_id`;
+        const reference = new TableReference(name, args);
+        const { polymorphic, ...restArgs } = args;
+        const columnArgs = Object.assign({ isNewColumn: true, type: "bigint" }, restArgs);
+        const column = new TableColumn(columnName, columnArgs);
+        const index = new TableIndex([column]);
+        this.getColumns().push(column);
+        this.getIndexes().push(index);
+        this.getReferences().push(reference);
+        if (polymorphic) {
+            const typeColumnName = `${name}_type`;
+            const typeColumn = new TableColumn(typeColumnName, { isNewColumn: true, type: "string" });
+            this.getColumns().push(typeColumn);
+        }
+    }
+    /**
+     * @param {string} name
+     * @param {import("./table-column.js").TableColumnArgsType} args
+     * @returns {void}
+     */
+    string(name, args) { this.addColumn(name, Object.assign({ isNewColumn: true, type: "string" }, args)); }
+    /**
+     * @param {string} name
+     * @param {import("./table-column.js").TableColumnArgsType} args
+     * @returns {void}
+     */
+    text(name, args) { this.addColumn(name, Object.assign({ isNewColumn: true, type: "text" }, args)); }
+    /**
+     * @param {import("./table-column.js").TableColumnArgsType} args
+     * @returns {void}
+     */
+    timestamps(args) {
+        this.datetime("created_at", args);
+        this.datetime("updated_at", args);
+    }
+    /**
+     * @param {string} name
+     * @param {import("./table-column.js").TableColumnArgsType} args
+     * @returns {void}
+     */
+    uuid(name, args) { this.addColumn(name, Object.assign({ isNewColumn: true, type: "uuid" }, args)); }
+}

package/dist/src/database/table-data/table-column.d.ts

@@ -0,0 +1,153 @@
+/**
+ * @typedef {object} TableColumnArgsType
+ * @property {boolean} [autoIncrement]
+ * @property {any} [default]
+ * @property {boolean} [dropColumn]
+ * @property {boolean|object} [foreignKey]
+ * @property {boolean|IndexArgType} [index]
+ * @property {boolean} [isNewColumn]
+ * @property {number} [maxLength]
+ * @property {boolean} [null]
+ * @property {boolean} [polymorphic]
+ * @property {boolean} [primaryKey]
+ * @property {string} [type]
+ */
+export default class TableColumn {
+    /**
+     * @param {string} name
+     * @param {TableColumnArgsType} [args]
+     */
+    constructor(name: string, args?: TableColumnArgsType);
+    args: TableColumnArgsType;
+    name: string;
+    /**
+     * @returns {string} name
+     */
+    getName(): string;
+    /**
+     * @returns {string | undefined}
+     */
+    getNewName(): string | undefined;
+    /**
+     * @param {string} newName
+     * @returns {void}
+     */
+    setNewName(newName: string): void;
+    _newName: string;
+    /**
+     * @returns {string}
+     */
+    getActualName(): string;
+    /**
+     * @returns {boolean}
+     */
+    getAutoIncrement(): boolean;
+    /**
+     * @param {boolean} newAutoIncrement
+     * @returns {void}
+     */
+    setAutoIncrement(newAutoIncrement: boolean): void;
+    /**
+     * @returns {any}
+     */
+    getDefault(): any;
+    /**
+     * @param {any} newDefault
+     * @returns {void}
+     */
+    setDefault(newDefault: any): void;
+    /**
+     * @returns {boolean}
+     */
+    getDropColumn(): boolean;
+    /**
+     * @returns {boolean | object | undefined}
+     */
+    getForeignKey(): boolean | object | undefined;
+    /**
+     * @param {boolean | object | undefined} newForeignKey
+     * @returns {void}
+     */
+    setForeignKey(newForeignKey: boolean | object | undefined): void;
+    /**
+     * @returns {boolean|IndexArgType}
+     */
+    getIndex(): boolean | IndexArgType;
+    /**
+     * @returns {IndexArgType}
+     */
+    getIndexArgs(): IndexArgType;
+    getIndexUnique(): boolean;
+    /**
+     * @param {boolean|IndexArgType} newIndex
+     * @returns {void}
+     */
+    setIndex(newIndex: boolean | IndexArgType): void;
+    /**
+     * @returns {number | undefined}
+     */
+    getMaxLength(): number | undefined;
+    /**
+     * @param {number | undefined} newMaxLength
+     * @returns {void}
+     */
+    setMaxLength(newMaxLength: number | undefined): void;
+    /**
+     * @returns {boolean | undefined}
+     */
+    getNull(): boolean | undefined;
+    /**
+     * @param {boolean} nullable
+     * @returns {void}
+     */
+    setNull(nullable: boolean): void;
+    /**
+     * @returns {boolean}
+     */
+    getPrimaryKey(): boolean;
+    /**
+     * @param {boolean} newPrimaryKey
+     * @returns {void}
+     */
+    setPrimaryKey(newPrimaryKey: boolean): void;
+    /**
+     * @returns {string | undefined}
+     */
+    getType(): string | undefined;
+    /**
+     * @param {string | undefined} newType
+     * @returns {void}
+     */
+    setType(newType: string | undefined): void;
+    /**
+     * @returns {boolean}
+     */
+    isNewColumn(): boolean;
+    /**
+     * @param {object} args
+     * @param {boolean} args.forAlterTable
+     * @param {import("../drivers/base.js").default} args.driver
+     * @returns {string}
+     */
+    getSQL({ forAlterTable, driver, ...restArgs }: {
+        forAlterTable: boolean;
+        driver: import("../drivers/base.js").default;
+    }): string;
+}
+export type IndexArgType = {
+    unique: boolean;
+};
+export type TableColumnArgsType = {
+    autoIncrement?: boolean;
+    default?: any;
+    dropColumn?: boolean;
+    foreignKey?: boolean | object;
+    index?: boolean | IndexArgType;
+    isNewColumn?: boolean;
+    maxLength?: number;
+    null?: boolean;
+    polymorphic?: boolean;
+    primaryKey?: boolean;
+    type?: string;
+};
+//# sourceMappingURL=table-column.d.ts.map