@proteinjs/db-driver-knex 1.0.13 → 1.0.15

package/src/KnexSchemaOperations.ts

@@ -7,9 +7,7 @@ import { getColumnFactory } from './getColumnFactory';
 export class KnexSchemaOperations implements SchemaOperations {
   private logger = new Logger(this.constructor.name);
 
-  constructor(
-    private knexDriver: KnexDriver
-  ){}
+  constructor(private knexDriver: KnexDriver) {}
 
   async createTable(table: Table<any>) {
     let resolve: any;
@@ -18,113 +16,138 @@ export class KnexSchemaOperations implements SchemaOperations {
       resolve = rs;
       reject = rj;
     });
-  
-    await this.knexDriver.getKnex().schema.withSchema(this.knexDriver.getDbName()).createTable(table.name, (tableBuilder: knex.TableBuilder) => {
-      for (const columnPropertyName in table.columns) {
-        const column = table.columns[columnPropertyName];
-        this.createColumn(column, table, tableBuilder);
-        this.logger.info(`[${table.name}] Creating column: ${column.name}`);
-      }
-  
-      tableBuilder.primary(['id']);
-      this.logger.info(`[${table.name}] Creating primary key: id`);
-  
-      if (table.indexes) {
-        for (const index of table.indexes) {
-          const columnNames = index.columns.map((columnPropertyName) => table.columns[columnPropertyName as string].name)
-          tableBuilder.index(columnNames, index.name);
-          this.logger.info(`[${table.name}] Creating index: ${columnNames}`);
+
+    await this.knexDriver
+      .getKnex()
+      .schema.withSchema(this.knexDriver.getDbName())
+      .createTable(table.name, (tableBuilder: knex.TableBuilder) => {
+        for (const columnPropertyName in table.columns) {
+          const column = table.columns[columnPropertyName];
+          this.createColumn(column, table, tableBuilder);
+          this.logger.info(`[${table.name}] Creating column: ${column.name}`);
         }
-      }
-    }).catch((reason: any) => {
-      reject(`Failed to create table: ${table.name}. reason: ${reason}`);
-    }).then(() => {
-      resolve();
-    });
-  
+
+        tableBuilder.primary(['id']);
+        this.logger.info(`[${table.name}] Creating primary key: id`);
+
+        if (table.indexes) {
+          for (const index of table.indexes) {
+            const columnNames = index.columns.map(
+              (columnPropertyName) => table.columns[columnPropertyName as string].name
+            );
+            tableBuilder.index(columnNames, index.name);
+            this.logger.info(`[${table.name}] Creating index: ${columnNames}`);
+          }
+        }
+      })
+      .catch((reason: any) => {
+        reject(`Failed to create table: ${table.name}. reason: ${reason}`);
+      })
+      .then(() => {
+        resolve();
+      });
+
     return p;
   }
 
   async alterTable(table: Table<any>, tableChanges: TableChanges) {
-		let resolve: any;
-		let reject: any;
-		const p = new Promise<void>((rs, rj) => {
-			resolve = rs;
-			reject = rj;
-		});
-			
-		await this.knexDriver.getKnex().schema.withSchema(this.knexDriver.getDbName()).table(table.name, (tableBuilder: knex.TableBuilder) => {
-			for (const columnPropertyName of tableChanges.columnsToCreate) {
-				const column = table.columns[columnPropertyName];
-        this.logger.info(`[${table.name}] Creating column: ${column.name}`);
-				this.createColumn(column, table, tableBuilder, tableChanges);
-			}
-	
-			for (const column of tableChanges.columnsWithUniqueConstraintsToDrop) {
-				tableBuilder.dropUnique([column]);
-				this.logger.info(`[${table.name}.${column}] Dropping unique constraint`);
-			}
-	
-			for (const column of tableChanges.columnsWithForeignKeysToDrop) {
-				tableBuilder.dropForeign([column]);
-				this.logger.info(`[${table.name}.${column}] Dropping foreign key`);
-			}
-	
-			for (const index of tableChanges.indexesToDrop) {
-				tableBuilder.dropIndex(index.columns);
-				this.logger.info(`[${table.name}] Dropping index: ${JSON.stringify(index)}`);
-			}
-	
-			for (const columnPropertyName of tableChanges.columnsToAlter) {
-				const column = table.columns[columnPropertyName];
-        this.logger.info(`[${table.name}.${column.name}] Altering column type to: ${column.constructor.name}`);
-				this.createColumn(column, table, tableBuilder, tableChanges).alter();
-			}
-	
-			for (const columnPropertyName of tableChanges.columnsToRename) {
-				const column = table.columns[columnPropertyName];
-				if (!column.oldName)
-					continue;
-	
-				tableBuilder.renameColumn(column.oldName, column.name);
-				this.logger.info(`[${table.name}] Renaming column: ${column.oldName} -> ${column.name}`);
-			}
-	
-			for (const index of tableChanges.indexesToCreate) {
-				tableBuilder.index(index.columns);
-				this.logger.info(`[${table.name}] Creating index: ${JSON.stringify(index)}`);
-			}
-		}).catch((reason: any) => {
-			reject(`Failed to alter table: ${table.name}. reason: ${reason}`);
-		}).then(() => {
-      resolve();
+    let resolve: any;
+    let reject: any;
+    const p = new Promise<void>((rs, rj) => {
+      resolve = rs;
+      reject = rj;
     });
-	
-		return p;
-	}
 
-  private createColumn(column: Column<any, any>, table: Table<any>, tableBuilder: knex.TableBuilder, tableChanges?: TableChanges) {
+    await this.knexDriver
+      .getKnex()
+      .schema.withSchema(this.knexDriver.getDbName())
+      .table(table.name, (tableBuilder: knex.TableBuilder) => {
+        for (const columnPropertyName of tableChanges.columnsToCreate) {
+          const column = table.columns[columnPropertyName];
+          this.logger.info(`[${table.name}] Creating column: ${column.name}`);
+          this.createColumn(column, table, tableBuilder, tableChanges);
+        }
+
+        for (const column of tableChanges.columnsWithUniqueConstraintsToDrop) {
+          tableBuilder.dropUnique([column]);
+          this.logger.info(`[${table.name}.${column}] Dropping unique constraint`);
+        }
+
+        for (const column of tableChanges.columnsWithForeignKeysToDrop) {
+          tableBuilder.dropForeign([column]);
+          this.logger.info(`[${table.name}.${column}] Dropping foreign key`);
+        }
+
+        for (const index of tableChanges.indexesToDrop) {
+          tableBuilder.dropIndex(index.columns);
+          this.logger.info(`[${table.name}] Dropping index: ${JSON.stringify(index)}`);
+        }
+
+        for (const columnPropertyName of tableChanges.columnsToAlter) {
+          const column = table.columns[columnPropertyName];
+          this.logger.info(`[${table.name}.${column.name}] Altering column type to: ${column.constructor.name}`);
+          this.createColumn(column, table, tableBuilder, tableChanges).alter();
+        }
+
+        for (const columnPropertyName of tableChanges.columnsToRename) {
+          const column = table.columns[columnPropertyName];
+          if (!column.oldName) {
+            continue;
+          }
+
+          tableBuilder.renameColumn(column.oldName, column.name);
+          this.logger.info(`[${table.name}] Renaming column: ${column.oldName} -> ${column.name}`);
+        }
+
+        for (const index of tableChanges.indexesToCreate) {
+          tableBuilder.index(index.columns);
+          this.logger.info(`[${table.name}] Creating index: ${JSON.stringify(index)}`);
+        }
+      })
+      .catch((reason: any) => {
+        reject(`Failed to alter table: ${table.name}. reason: ${reason}`);
+      })
+      .then(() => {
+        resolve();
+      });
+
+    return p;
+  }
+
+  private createColumn(
+    column: Column<any, any>,
+    table: Table<any>,
+    tableBuilder: knex.TableBuilder,
+    tableChanges?: TableChanges
+  ) {
     const columnFactory = getColumnFactory(column);
     const columnBuilder = columnFactory.create(column, tableBuilder);
-    if (column.options?.unique?.unique && (!tableChanges || tableChanges.columnsWithUniqueConstraintsToCreate.includes(column.name))) {
+    if (
+      column.options?.unique?.unique &&
+      (!tableChanges || tableChanges.columnsWithUniqueConstraintsToCreate.includes(column.name))
+    ) {
       columnBuilder.unique(column.options.unique.indexName);
       this.logger.info(`[${table.name}.${column.name}] Adding unique constraint`);
     }
-  
-    if (column.options?.references && (!tableChanges || tableChanges.columnsWithForeignKeysToCreate.includes(column.name))) {
+
+    if (
+      column.options?.references &&
+      (!tableChanges || tableChanges.columnsWithForeignKeysToCreate.includes(column.name))
+    ) {
       columnBuilder.references('id').inTable(`${this.knexDriver.getDbName()}.${column.options.references.table}`);
       this.logger.info(`[${table.name}.${column.name}] Adding foreign key -> ${column.options.references.table}.id`);
     }
-  
+
     if (typeof column.options?.nullable !== 'undefined') {
-      if (column.options?.nullable)
+      if (column.options?.nullable) {
         columnBuilder.nullable();
-      else
+      } else {
         columnBuilder.notNullable();
-  
+      }
+
       this.logger.info(`[${table.name}.${column.name}] Adding constraint nullable: ${column.options?.nullable}`);
     }
-  
+
     return columnBuilder;
   }
-}
+}

package/src/getColumnFactory.ts

@@ -1,87 +1,105 @@
 import knex from 'knex';
 import { isInstanceOf } from '@proteinjs/util';
-import { BinaryColumn, BooleanColumn, Column, DateColumn, DateTimeColumn, DecimalColumn, FloatColumn, IntegerColumn, StringColumn, UuidColumn } from '@proteinjs/db';
+import {
+  BinaryColumn,
+  BooleanColumn,
+  Column,
+  DateColumn,
+  DateTimeColumn,
+  DecimalColumn,
+  FloatColumn,
+  IntegerColumn,
+  StringColumn,
+  UuidColumn,
+} from '@proteinjs/db';
 
 export const getColumnFactory = (column: Column<any, any>): ColumnFactory => {
-  if (isInstanceOf(column, IntegerColumn))
-		return new IntegerColumnFactory();
-	else if (isInstanceOf(column, UuidColumn))
-		return new UuidColumnFactory();
-	else if (isInstanceOf(column, StringColumn))
-		return new StringColumnFactory();
-	else if (isInstanceOf(column, FloatColumn))
-		return new FloatColumnFactory();
-	else if (isInstanceOf(column, DecimalColumn))
-		return new DecimalColumnFactory();
-	else if (isInstanceOf(column, BooleanColumn))
-		return new BooleanColumnFactory();
-	else if (isInstanceOf(column, DateColumn))
-		return new DateColumnFactory();
-	else if (isInstanceOf(column, DateTimeColumn))
-		return new DateTimeColumnFactory();
-	else if (isInstanceOf(column, BinaryColumn))
-		return new BinaryColumnFactory();
+  if (isInstanceOf(column, IntegerColumn)) {
+    return new IntegerColumnFactory();
+  } else if (isInstanceOf(column, UuidColumn)) {
+    return new UuidColumnFactory();
+  } else if (isInstanceOf(column, StringColumn)) {
+    return new StringColumnFactory();
+  } else if (isInstanceOf(column, FloatColumn)) {
+    return new FloatColumnFactory();
+  } else if (isInstanceOf(column, DecimalColumn)) {
+    return new DecimalColumnFactory();
+  } else if (isInstanceOf(column, BooleanColumn)) {
+    return new BooleanColumnFactory();
+  } else if (isInstanceOf(column, DateColumn)) {
+    return new DateColumnFactory();
+  } else if (isInstanceOf(column, DateTimeColumn)) {
+    return new DateTimeColumnFactory();
+  } else if (isInstanceOf(column, BinaryColumn)) {
+    return new BinaryColumnFactory();
+  }
 
-	throw new Error(`Invalid column type: ${column.constructor.name}, must extend a base column`);
-}
+  throw new Error(`Invalid column type: ${column.constructor.name}, must extend a base column`);
+};
 
 export interface ColumnFactory {
   create(column: Column<any, any>, tableBuilder: knex.TableBuilder): knex.ColumnBuilder;
 }
 
 export class IntegerColumnFactory implements ColumnFactory {
-	create(integerColumn: IntegerColumn, tableBuilder: knex.TableBuilder): knex.ColumnBuilder {
-		return integerColumn.large ? tableBuilder.bigInteger(integerColumn.name) : tableBuilder.integer(integerColumn.name);
-	}
+  create(integerColumn: IntegerColumn, tableBuilder: knex.TableBuilder): knex.ColumnBuilder {
+    return integerColumn.large ? tableBuilder.bigInteger(integerColumn.name) : tableBuilder.integer(integerColumn.name);
+  }
 }
 
 // max length of longtext is 4,294,967,295 bytes (~4 GiB)
 export class StringColumnFactory implements ColumnFactory {
-	create(stringColumn: StringColumn, tableBuilder: knex.TableBuilder): knex.ColumnBuilder {
-		return stringColumn.maxLength === 'MAX' ? tableBuilder.text(stringColumn.name, 'longtext') : tableBuilder.string(stringColumn.name, stringColumn.maxLength);
-	}
+  create(stringColumn: StringColumn, tableBuilder: knex.TableBuilder): knex.ColumnBuilder {
+    return stringColumn.maxLength === 'MAX'
+      ? tableBuilder.text(stringColumn.name, 'longtext')
+      : tableBuilder.string(stringColumn.name, stringColumn.maxLength);
+  }
 }
 
 export class FloatColumnFactory implements ColumnFactory {
-	create(floatColumn: FloatColumn, tableBuilder: knex.TableBuilder): knex.ColumnBuilder {
-		return tableBuilder.float(floatColumn.name);
-	}
+  create(floatColumn: FloatColumn, tableBuilder: knex.TableBuilder): knex.ColumnBuilder {
+    return tableBuilder.float(floatColumn.name);
+  }
 }
 
 export class DecimalColumnFactory implements ColumnFactory {
-	create(decimalColumn: DecimalColumn, tableBuilder: knex.TableBuilder): knex.ColumnBuilder {
-		return decimalColumn.large ? tableBuilder.decimal(decimalColumn.name, 38, 20) : tableBuilder.decimal(decimalColumn.name);
-	}
+  create(decimalColumn: DecimalColumn, tableBuilder: knex.TableBuilder): knex.ColumnBuilder {
+    return decimalColumn.large
+      ? tableBuilder.decimal(decimalColumn.name, 38, 20)
+      : tableBuilder.decimal(decimalColumn.name);
+  }
 }
 
 export class BooleanColumnFactory implements ColumnFactory {
-	create(booleanColumn: BooleanColumn, tableBuilder: knex.TableBuilder): knex.ColumnBuilder {
-		return tableBuilder.boolean(booleanColumn.name);
-	}
+  create(booleanColumn: BooleanColumn, tableBuilder: knex.TableBuilder): knex.ColumnBuilder {
+    return tableBuilder.boolean(booleanColumn.name);
+  }
 }
 
 export class DateColumnFactory implements ColumnFactory {
-	create(dateColumn: DateColumn, tableBuilder: knex.TableBuilder): knex.ColumnBuilder {
-		return tableBuilder.date(dateColumn.name);
-	}
+  create(dateColumn: DateColumn, tableBuilder: knex.TableBuilder): knex.ColumnBuilder {
+    return tableBuilder.date(dateColumn.name);
+  }
 }
 
 export class DateTimeColumnFactory implements ColumnFactory {
-	create(dateTimeColumn: DateTimeColumn, tableBuilder: knex.TableBuilder): knex.ColumnBuilder {
-		return tableBuilder.dateTime(dateTimeColumn.name);
-	}
+  create(dateTimeColumn: DateTimeColumn, tableBuilder: knex.TableBuilder): knex.ColumnBuilder {
+    return tableBuilder.dateTime(dateTimeColumn.name);
+  }
 }
 
 // max length of longblob is 4,294,967,295 bytes (~4 GiB)
 // max length when undefined (aka blob) is 65,535 bytes (~64 KiB)
 export class BinaryColumnFactory implements ColumnFactory {
-	create(binaryColumn: BinaryColumn, tableBuilder: knex.TableBuilder): knex.ColumnBuilder {
-		return binaryColumn.maxLength == 'MAX' ? tableBuilder.specificType(binaryColumn.name, 'longblob') : tableBuilder.binary(binaryColumn.name, binaryColumn.maxLength);
-	}
+  create(binaryColumn: BinaryColumn, tableBuilder: knex.TableBuilder): knex.ColumnBuilder {
+    return binaryColumn.maxLength == 'MAX'
+      ? tableBuilder.specificType(binaryColumn.name, 'longblob')
+      : tableBuilder.binary(binaryColumn.name, binaryColumn.maxLength);
+  }
 }
 
 export class UuidColumnFactory implements ColumnFactory {
-	create(uuidColumn: UuidColumn, tableBuilder: knex.TableBuilder): knex.ColumnBuilder {
-		return tableBuilder.uuid(uuidColumn.name);
-	}
-}
+  create(uuidColumn: UuidColumn, tableBuilder: knex.TableBuilder): knex.ColumnBuilder {
+    return tableBuilder.uuid(uuidColumn.name);
+  }
+}

package/test/Crud.test.ts

@@ -1,21 +1,16 @@
-import { Table, crudTests } from '@proteinjs/db'
-import { KnexDriver } from '../src/KnexDriver'
+import { Table, crudTests } from '@proteinjs/db';
+import { KnexDriver } from '../src/KnexDriver';
 
 const knexDriver = new KnexDriver({
-	host: 'localhost',
-	user: 'root',
-	password: '',
-	dbName: 'test',
+  host: 'localhost',
+  user: 'root',
+  password: '',
+  dbName: 'test',
 });
 const dropTable = async (table: Table<any>) => {
-  if (await knexDriver.getKnex().schema.withSchema(knexDriver.getDbName()).hasTable(table.name))
-		await knexDriver.getKnex().schema.withSchema(knexDriver.getDbName()).dropTable(table.name);
-}
+  if (await knexDriver.getKnex().schema.withSchema(knexDriver.getDbName()).hasTable(table.name)) {
+    await knexDriver.getKnex().schema.withSchema(knexDriver.getDbName()).dropTable(table.name);
+  }
+};
 
-describe(
-	'CRUD Tests',
-	crudTests(
-		knexDriver,
-		dropTable
-	)
-);
+describe('CRUD Tests', crudTests(knexDriver, dropTable));

package/test/TableManager.test.ts

@@ -1,23 +1,17 @@
-import { Table, tableManagerTests } from '@proteinjs/db'
-import { KnexDriver } from '../src/KnexDriver'
+import { Table, tableManagerTests } from '@proteinjs/db';
+import { KnexDriver } from '../src/KnexDriver';
 import { KnexColumnTypeFactory } from '../src/KnexColumnTypeFactory';
 
 const knexDriver = new KnexDriver({
-	host: 'localhost',
-	user: 'root',
-	password: '',
-	dbName: 'test',
+  host: 'localhost',
+  user: 'root',
+  password: '',
+  dbName: 'test',
 });
 const dropTable = async (table: Table<any>) => {
-  if (await knexDriver.getKnex().schema.withSchema(knexDriver.getDbName()).hasTable(table.name))
-		await knexDriver.getKnex().schema.withSchema(knexDriver.getDbName()).dropTable(table.name);
-}
+  if (await knexDriver.getKnex().schema.withSchema(knexDriver.getDbName()).hasTable(table.name)) {
+    await knexDriver.getKnex().schema.withSchema(knexDriver.getDbName()).dropTable(table.name);
+  }
+};
 
-describe(
-	'Table Manager Tests',
-	tableManagerTests(
-		knexDriver,
-		dropTable,
-		new KnexColumnTypeFactory().getType
-	)
-);
+describe('Table Manager Tests', tableManagerTests(knexDriver, dropTable, new KnexColumnTypeFactory().getType));

package/tsconfig.json

@@ -1,23 +1,19 @@
 {
-    "compilerOptions": {
-        "rootDir": "./",
-        "target": "es5",
-        "module": "commonjs",
-        "declaration": true,
-        "declarationMap": true,
-        "sourceMap": true,
-        "outDir": "./dist/",
-        "strict": true,
-        "noImplicitAny": true,
-        "esModuleInterop": true,
-        "skipLibCheck": true,
-        "forceConsistentCasingInFileNames": true,
-        "resolveJsonModule": true,
-        "typeRoots": [
-            "./node_modules/@types"
-        ],
-        "types": [
-            "node", "jest"
-        ]
-    }
-}
+  "compilerOptions": {
+    "rootDir": "./",
+    "target": "es5",
+    "module": "commonjs",
+    "declaration": true,
+    "declarationMap": true,
+    "sourceMap": true,
+    "outDir": "./dist/",
+    "strict": true,
+    "noImplicitAny": true,
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "forceConsistentCasingInFileNames": true,
+    "resolveJsonModule": true,
+    "typeRoots": ["./node_modules/@types"],
+    "types": ["node", "jest"]
+  }
+}