Upgrade knex(v2.4.2) and typescript(v5.0.4) to latest version

.gitignore

@@ -7,3 +7,6 @@
 /tmp
 node_modules
 /coverage
+
+# IDE settings
+.vscode

README.md

@@ -240,17 +240,17 @@ import { synchronize, loadConfig, resolveConnections } from '@leapfrogtechnology
 You can also pass your own database connection (eg: Knex connection) instead of resolving `connections.sync-db.json` file.
 
 ```ts
-import * as Knex from 'knex';
+import { knex } from 'knex';
 import { synchronize, loadConfig } from '@leapfrogtechnology/sync-db';
 
 (async () => {
   const config = await loadConfig(); // Load sync-db.yml
-  const connection = Knex({
+  const connection = knex({
     // Your Knex connection instance.
     client: 'mssql',
     connection: {
-      host: 'host',
-      user: 'userName',
+      server: 'host',
+      userName: 'userName',
       password: 'password',
       database: 'dbName'
     }

assets/templates/migration/create_ts.stub

@@ -1,4 +1,4 @@
-import * as Knex from 'knex';
+import { Knex } from 'knex';
 
 /**
  * Create {{table}} table.

assets/templates/migration/update_ts.stub

@@ -1,4 +1,4 @@
-import * as Knex from 'knex';
+import { Knex } from 'knex';
 
 /**
  * Alter {{table}} table.

examples/node-app-mssql-ts/src/index.js

@@ -9,7 +9,7 @@ const { connections } = require('../connections.sync-db.json');
     // Getting knex instance of mssql database with id db1.
     const db = knex({
       client: 'mssql',
-      connection: connections.find(({ id }) => id === 'testdb1').connection
+      connection: connections.find(({ id }) => id === 'db1').connection
     });
 
     const tasks = await db.raw('SELECT * FROM utils.vw_tasks');

package.json

@@ -62,7 +62,7 @@
     "debug": "^4.1.1",
     "esm": "^3.2.25",
     "globby": "^10.0.2",
-    "knex": "^0.20.11",
+    "knex": "^2.4.2",
     "ramda": "^0.26.1",
     "ts-node": "^8",
     "tslib": "^1",
@@ -90,7 +90,7 @@
     "prettier": "2.0.2",
     "tslint": "^6.1.3",
     "tslint-config-leapfrog": "^1.0.3",
-    "typescript": "^3.8.2"
+    "typescript": "^5.0.2"
   },
   "engines": {
     "node": ">= 14.15.0"

src/config.ts

@@ -58,7 +58,10 @@ export async function loadConfig(configFilename: string = CONFIG_FILENAME): Prom
 
   log('Resolved config file.');
 
-  const loaded = mergeDeepRight(DEFAULT_CONFIG, loadedConfig) as Configuration;
+  const loaded = (mergeDeepRight<Configuration, Configuration>(
+    DEFAULT_CONFIG,
+    loadedConfig
+  ) as unknown) as Configuration;
 
   validate(loaded);
 
@@ -131,6 +134,7 @@ export async function resolveConnections(config: Configuration, resolver?: strin
       client,
       connection: {
         host: (connection as any).host,
+        server: (connection as any).server,
         database: (connection as any).database
       }
     }))
@@ -214,7 +218,10 @@ export function resolveConnectionsFromEnv(): ConnectionConfig[] {
       database: process.env.DB_NAME,
       options: {
         encrypt: process.env.DB_ENCRYPTION === 'true'
-      }
+      },
+      // Knex config for mssql uses these keys in place of "host" and "user"
+      server: process.env.DB_SERVER,
+      userName: process.env.DB_USERNAME
     }
   } as ConnectionConfig;
 

src/domain/ConnectionConfig.ts

@@ -1,4 +1,4 @@
-import * as Knex from 'knex';
+import { Knex } from 'knex';
 
 /**
  * Database connection configuration.

src/domain/ConnectionReference.ts

@@ -1,4 +1,4 @@
-import * as Knex from 'knex';
+import { Knex } from 'knex';
 
 /**
  * Connection reference.

src/domain/MigrationContext.ts

@@ -1,4 +1,4 @@
-import * as Knex from 'knex';
+import { Knex } from 'knex';
 
 import OperationParams from './operation/OperationParams';
 import OperationContext from './operation/OperationContext';

src/domain/RawBingingParams.ts

@@ -1,4 +1,4 @@
-import * as Knex from 'knex';
+import { Knex } from 'knex';
 
 type Value = Date | string | number | boolean | Date[] | string[] | number[] | boolean[] | Buffer | Knex.Raw;
 

src/domain/SynchronizeContext.ts

@@ -1,4 +1,4 @@
-import * as Knex from 'knex';
+import { Knex } from 'knex';
 
 import SynchronizeParams from './SynchronizeParams';
 import OperationContext from './operation/OperationContext';

src/init.ts

@@ -1,4 +1,4 @@
-import * as Knex from 'knex';
+import { Knex } from 'knex';
 
 import { log } from './util/logger';
 import { validate, isCLI } from './config';
@@ -37,7 +37,7 @@ export async function prepare(config: Configuration, options: PrepareOptions): P
   return {
     knexMigrationConfig: (connectionId: string) => ({
       tableName: config.migration.tableName,
-      migrationSource: migrationContext ? new KnexMigrationSource(migrationContext.bind(connectionId)) : null
+      migrationSource: migrationContext ? new KnexMigrationSource(migrationContext.bind(connectionId)) : undefined
     })
   };
 }

src/migration/KnexMigrationSource.ts

@@ -1,4 +1,6 @@
+import { Knex } from 'knex';
 import { dbLogger } from '../util/logger';
+import MigrationRunner from './domain/MigrationRunner';
 import MigrationSourceContext from './domain/MigrationSourceContext';
 
 /**
@@ -7,7 +9,7 @@ import MigrationSourceContext from './domain/MigrationSourceContext';
  *
  * Reference: http://knexjs.org/#Migrations-API
  */
-class KnexMigrationSource {
+class KnexMigrationSource implements Knex.MigrationSource<string> {
   private migrationContext: MigrationSourceContext;
   private log: debug.Debugger;
 
@@ -47,15 +49,16 @@ class KnexMigrationSource {
   /**
    * Get the migration runner.
    *
-   * @param {SqlMigrationEntry} migration
+   * @param {string} name
+   * @returns {Promise<MigrationRunner>}
    */
-  getMigration(name: string) {
+  getMigration(name: string): Promise<MigrationRunner> {
     const migration = this.migrationContext.get(name);
 
     this.log(`getMigration - ${name}`);
     this.log(`getMigration - resolve: %o`, migration);
 
-    return migration;
+    return Promise.resolve(migration);
   }
 }
 

src/migration/domain/JavaScriptMigrationEntry.ts

@@ -1,4 +1,4 @@
-import Knex from 'knex';
+import { Knex } from 'knex';
 
 interface JavaScriptMigrationEntry {
   name: string;

src/migration/domain/MigrationRunner.ts

@@ -1,4 +1,4 @@
-import Knex from 'knex';
+import { Knex } from 'knex';
 
 /**
  * Contract for a migration runner.

src/migration/service/knexMigrator.ts

@@ -1,4 +1,4 @@
-import * as Knex from 'knex';
+import { Knex } from 'knex';
 import * as path from 'path';
 
 import { PrepareOptions } from '../../init';

src/migration/source-types/SqlMigrationSourceContext.ts

@@ -1,4 +1,4 @@
-import * as Knex from 'knex';
+import { Knex } from 'knex';
 
 import MigrationRunner from '../domain/MigrationRunner';
 import { dbLogger, log as logger } from '../../util/logger';

src/service/configInjection.ts

@@ -1,6 +1,6 @@
 import * as fs from 'fs';
 import * as path from 'path';
-import * as Knex from 'knex';
+import { Knex } from 'knex';
 
 import Mapping from '../domain/Mapping';
 import { dbLogger } from '../util/logger';
@@ -74,6 +74,12 @@ export async function setup(trx: Knex.Transaction, context: SynchronizeContext):
 
   const values = convertToKeyValuePairs(injectedConfig.vars);
 
+  if (!values.length) {
+    log(`Config not available. Skipping insertion on ${INJECTED_CONFIG_TABLE} table.`);
+
+    return;
+  }
+
   // Create table
   log(`Creating table ${INJECTED_CONFIG_TABLE}.`);
   await trx.schema.createTable(INJECTED_CONFIG_TABLE, table => {

src/service/sqlRunner.ts

@@ -1,4 +1,4 @@
-import * as Knex from 'knex';
+import { Knex } from 'knex';
 import * as path from 'path';
 import { reverse, keys } from 'ramda';
 

src/service/sync.ts

@@ -1,4 +1,4 @@
-import * as Knex from 'knex';
+import { Knex } from 'knex';
 
 import * as sqlRunner from './sqlRunner';
 import { dbLogger } from '../util/logger';

src/util/db.ts

@@ -1,4 +1,4 @@
-import * as Knex from 'knex';
+import { Knex, knex } from 'knex';
 import { dbLogger, log } from './logger';
 import { getConnectionId } from '../config';
 import ConnectionConfig from '../domain/ConnectionConfig';
@@ -48,11 +48,15 @@ export function createInstance(config: ConnectionConfig): Knex {
     throw new Error('The provided connection already contains a connection instance.');
   }
 
-  const { host, database } = config.connection as any;
+  const { host, server, database, userName } = config.connection as any;
 
-  log(`Connecting to database: ${host}/${database}`);
+  log(`Connecting to database: ${server ? server : host}/${database}`);
 
-  return Knex({
+  if (config.client === 'mssql' && (!server || !userName)) {
+    throw new Error(`Db client ${config.client} requires key "server" and "userName".`);
+  }
+
+  return knex({
     client: config.client,
     connection: config.connection
   });

test/cli/commands/make.test.ts

@@ -10,7 +10,7 @@ import { mkdir, mkdtemp, write, exists, glob, read } from '../../../src/util/fs'
 
 const MIGRATION_TEMPLATE_PATH = path.resolve(__dirname, '../../../assets/templates/migration');
 const CUSTOM_CREATE_TEMPLATE = `
-import * as Knex from "knex";
+import { Knex } from "knex";
 
 export function up(db: Knex) {
   return db.schema.createTable("{{table}}", table => {})

test/unit/migration/JavaScriptMigrationContext.test.ts

@@ -1,5 +1,5 @@
 import { expect } from 'chai';
-import * as Knex from 'knex';
+import { Knex } from 'knex';
 import { describe, it } from 'mocha';
 import JavaScriptMigrationEntry from '../../../src/migration/domain/JavaScriptMigrationEntry';
 import JavaScriptMigrationContext from '../../../src/migration/source-types/JavaScriptMigrationSourceContext';

test/unit/migration/KnexMigrationSource.test.ts

@@ -54,7 +54,7 @@ describe('MIGRATION: KnexMigrationSource', () => {
       const instance = await getInstance();
       const dbStub = {} as any;
 
-      const migration = instance.getMigration('mgr_002');
+      const migration = await instance.getMigration('mgr_002');
 
       const upResult = await migration.up(dbStub);
       const downResult = await migration.down(dbStub);

test/unit/util/config.test.ts

@@ -34,6 +34,7 @@ describe('CONFIG:', () => {
       process.env.DB_USERNAME = 'user';
       process.env.DB_PASSWORD = 'password';
       process.env.DB_NAME = 'database';
+      process.env.DB_SERVER = 'localhost';
 
       const connections = resolveConnectionsFromEnv();
 
@@ -46,6 +47,8 @@ describe('CONFIG:', () => {
           user: 'user',
           password: 'password',
           database: 'database',
+          server: 'localhost',
+          userName: 'user',
           options: {
             encrypt: false
           }
@@ -60,6 +63,7 @@ describe('CONFIG:', () => {
       process.env.DB_USERNAME = '';
       process.env.DB_PASSWORD = '';
       process.env.DB_NAME = '';
+      process.env.DB_SERVER = '';
     });
 
     it('should throw an error if the required env vars are not provided.', () => {

tsconfig.json

@@ -11,6 +11,7 @@
     "target": "es2017",
     "skipLibCheck": true,
     "allowSyntheticDefaultImports": true,
+    "useUnknownInCatchVariables": false,
     "typeRoots": ["src/@types"]
   },
   "include": ["src/**/*"],