@bdkinc/knex-ibmi 0.1.7 → 0.2.1

package/README.md

@@ -24,7 +24,7 @@ Currently, this dialect has limited functionality compared to the Knex built-in
 
 `npm install @bdkinc/knex-ibmi`
 
-Requires Node v14 or higher.
+Requires Node v16 or higher.
 
 ## Dependencies
 
@@ -34,7 +34,7 @@ Requires Node v14 or higher.
 
 ## Usage
 
-This library is written in typescript and compiled to both commonjs and esm.
+This library can be used as commonjs, esm or typescript.
 
 ```javascript
 const knex = require("knex");
@@ -105,7 +105,6 @@ try {
 ```
 
 or as Typescript
-note: you will probably need to add skipLibCheck: true in your tsconfig compilerOptions if not there already. I plan to clean up the types so this is not an issue. 
 
 ```typescript
 import { knex } from "knex";
@@ -143,33 +142,6 @@ try {
 }
 ```
 
-## Pooling
-
-Tarn Pooling Configuration
-
-```javascript
-const db = knex({
-  client: DB2Dialect,
-  connection: {
-    host: "localhost",
-    database: "knextest",
-    port: 50000,
-    user: "<user>",
-    password: "<password>",
-    driver: "IBM i Access ODBC Driver",
-    connectionStringParams: {
-      ALLOWPROCCALLS: 1,
-      CMT: 0,
-    },
-  },
-  pool: {
-    min: 2,
-    max: 10,
-    acquireConnectionTimeout: 6000,
-  },
-});
-```
-
 ## Configuring your driver
 
 If you don't know the name of your installed driver, then look in `odbcinst.ini`. You can find the full path of the file by running `odbcinst -j`.
@@ -195,5 +167,7 @@ DontDLClose=1
 UsageCount=1
 ```
 
-If that still doesn't work, then unixodbc is probably looking for the config files in the wrong directory. A common case is that the configs are in `/etc` but your system expects them to be somewhere else. In such case, override the path unixodbc looks in via the `ODBCSYSINI` and `ODBCINI` environment variables.
+If that still doesn't work, then unixodbc is probably looking for the config files in the wrong directory.
+A common case is that the configs are in `/etc` but your system expects them to be somewhere else.
+In such a case, override the path unixodbc looks in via the `ODBCSYSINI` and `ODBCINI` environment variables.
 E.g., `ODBCINI=/etc ODBCSYSINI=/etc`.

package/dist/index.d.ts

@@ -1,6 +1,5 @@
-import * as odbc from 'odbc';
-import { Connection } from 'odbc';
 import { knex, Knex } from 'knex';
+import odbc, { Connection } from 'odbc';
 import SchemaCompiler from 'knex/lib/schema/compiler';
 import TableCompiler from 'knex/lib/schema/tablecompiler';
 import ColumnCompiler from 'knex/lib/schema/columncompiler';
@@ -12,11 +11,17 @@ declare class IBMiSchemaCompiler extends SchemaCompiler {
 }
 
 declare class IBMiTableCompiler extends TableCompiler {
-    createQuery(columns: any, ifNot: any, like: any): void;
-    dropUnique(columns: any, indexName: any): void;
-    unique(columns: any, indexName: any): void;
+    createQuery(columns: {
+        sql: any[];
+    }, ifNot: any, like: any): void;
+    dropUnique(columns: string[], indexName: any): void;
+    unique(columns: string[], indexName: {
+        indexName: any;
+        deferrable: any;
+        predicate: any;
+    }): void;
     addColumns(columns: any, prefix: any): void;
-    commit(conn: any): Promise<any>;
+    commit(connection: Connection): Promise<void>;
 }
 
 declare class IBMiColumnCompiler extends ColumnCompiler {
@@ -30,32 +35,33 @@ declare class IBMiQueryCompiler extends QueryCompiler {
         sql: string;
         returning: any;
     };
-    _buildInsertData(insertValues: any, returningSql: any): string;
+    _buildInsertData(insertValues: string | any[], returningSql: string): string;
     _prepInsert(data: any): any;
     update(): {
         sql: string;
         returning: any;
         selectReturning: string;
     };
-    _returning(method: any, value: any, withTrigger: any): string | undefined;
-    columnizeWithPrefix(prefix: any, target: any): string;
+    _returning(method: string, value: any, withTrigger: undefined): string | undefined;
+    columnizeWithPrefix(prefix: string, target: any): string;
 }
 
 declare class DB2Client extends knex.Client {
     constructor(config: Knex.Config<DB2Config>);
     _driver(): typeof odbc;
+    wrapIdentifierImpl(value: any): any;
     printDebug(message: string): void;
     printError(message: string): void;
     printWarn(message: string): void;
     acquireRawConnection(): Promise<any>;
-    destroyRawConnection(connection: Connection): Promise<void>;
+    destroyRawConnection(connection: any): Promise<any>;
     _getConnectionString(connectionConfig: DB2ConnectionConfig): string;
     _query(connection: any, obj: any): Promise<any>;
     transaction(container: any, config: any, outerTx: any): Knex.Transaction;
-    schemaCompiler(): IBMiSchemaCompiler;
-    tableCompiler(): IBMiTableCompiler;
-    columnCompiler(): IBMiColumnCompiler;
-    queryCompiler(): IBMiQueryCompiler;
+    schemaCompiler(tableBuilder: any): IBMiSchemaCompiler;
+    tableCompiler(tableBuilder: any): IBMiTableCompiler;
+    columnCompiler(tableCompiler: any, columnCompiler: any): IBMiColumnCompiler;
+    queryCompiler(builder: Knex.QueryBuilder): IBMiQueryCompiler;
     processResponse(obj: any, runner: any): any;
 }
 interface DB2PoolConfig {
@@ -92,6 +98,8 @@ interface DB2Config {
     client: any;
     connection: DB2ConnectionConfig;
     pool?: DB2PoolConfig;
+    version?: string;
+    useNullAsDefault?: boolean;
 }
 declare const DB2Dialect: typeof DB2Client;
 

package/dist/index.js

@@ -1,4 +1,3 @@
-"use strict";
 var __create = Object.create;
 var __defProp = Object.defineProperty;
 var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
@@ -34,20 +33,17 @@ __export(src_exports, {
   default: () => src_default
 });
 module.exports = __toCommonJS(src_exports);
-var process = __toESM(require("process"));
+var import_node_process = __toESM(require("process"));
 var import_knex = require("knex");
-var odbc = __toESM(require("odbc"));
+var import_odbc = __toESM(require("odbc"));
 
 // src/schema/ibmi-compiler.ts
 var import_compiler = __toESM(require("knex/lib/schema/compiler"));
 var IBMiSchemaCompiler = class extends import_compiler.default {
   hasTable(tableName) {
     const formattedTable = this.client.parameter(
-      // @ts-ignore
       prefixedTableName(this.schema, tableName),
-      // @ts-ignore
       this.builder,
-      // @ts-ignore
       this.bindingsHolder
     );
     const bindings = [tableName];
@@ -87,11 +83,7 @@ var IBMiTableCompiler = class extends import_tablecompiler.default {
     if (like) {
       createStatement += `select * into ${this.tableName()} from ${this.tableNameLike()} WHERE 0=1`;
     } else {
-      createStatement += "create table " + // @ts-ignore
-      this.tableName() + // @ts-ignore
-      (this._formatting ? " (\n    " : " (") + // @ts-ignore
-      columns.sql.join(this._formatting ? ",\n    " : ", ") + // @ts-ignore
-      this._addChecks() + ")";
+      createStatement += "create table " + this.tableName() + (this._formatting ? " (\n    " : " (") + columns.sql.join(this._formatting ? ",\n    " : ", ") + this._addChecks() + ")";
     }
     this.pushQuery(createStatement);
     if (this.single.comment) {
@@ -106,13 +98,15 @@ var IBMiTableCompiler = class extends import_tablecompiler.default {
     this.pushQuery(`drop index ${indexName}`);
   }
   unique(columns, indexName) {
-    let deferrable;
+    let deferrable = "";
     let predicate;
     if ((0, import_isObject.default)(indexName)) {
-      ({ indexName, deferrable, predicate } = indexName);
+      deferrable = indexName.deferrable;
+      predicate = indexName.predicate;
+      indexName = indexName.indexName;
     }
     if (deferrable && deferrable !== "not deferrable") {
-      this.client.logger.warn(
+      this.client.logger.warn?.(
         `IBMi: unique index \`${indexName}\` will not be deferrable ${deferrable}.`
       );
     }
@@ -120,7 +114,6 @@ var IBMiTableCompiler = class extends import_tablecompiler.default {
     columns = this.formatter.columnize(columns);
     const predicateQuery = predicate ? " " + this.client.queryCompiler(predicate).where() : "";
     this.pushQuery(
-      // @ts-ignore
       `create unique index ${indexName} on ${this.tableName()} (${columns})${predicateQuery}`
     );
   }
@@ -132,17 +125,13 @@ var IBMiTableCompiler = class extends import_tablecompiler.default {
         return prefix + column;
       });
       this.pushQuery({
-        sql: (
-          // @ts-ignore
-          (this.lowerCase ? "alter table " : "ALTER TABLE ") + // @ts-ignore
-          this.tableName() + " " + columnSql.join(" ")
-        ),
+        sql: (this.lowerCase ? "alter table " : "ALTER TABLE ") + this.tableName() + " " + columnSql.join(" "),
         bindings: columns.bindings
       });
     }
   }
-  async commit(conn) {
-    return await conn.commit();
+  async commit(connection) {
+    return await connection.commit();
   }
 };
 var ibmi_tablecompiler_default = IBMiTableCompiler;
@@ -151,8 +140,7 @@ var ibmi_tablecompiler_default = IBMiTableCompiler;
 var import_columncompiler = __toESM(require("knex/lib/schema/columncompiler"));
 var IBMiColumnCompiler = class extends import_columncompiler.default {
   increments(options = { primaryKey: true }) {
-    return "int not null generated always as identity (start with 1, increment by 1)" + // @ts-ignore
-    (this.tableCompiler._canBeAddPrimaryKey(options) ? " primary key" : "");
+    return "int not null generated always as identity (start with 1, increment by 1)" + (this.tableCompiler._canBeAddPrimaryKey(options) ? " primary key" : "");
   }
 };
 var ibmi_columncompiler_default = IBMiColumnCompiler;
@@ -160,16 +148,16 @@ var ibmi_columncompiler_default = IBMiColumnCompiler;
 // src/execution/ibmi-transaction.ts
 var import_transaction = __toESM(require("knex/lib/execution/transaction"));
 var IBMiTransaction = class extends import_transaction.default {
-  async begin(connection) {
-    await connection.beginTransaction();
+  begin(connection) {
+    connection.beginTransaction();
     return connection;
   }
-  async rollback(connection) {
-    await connection.rollback();
+  rollback(connection) {
+    connection.rollback();
     return connection;
   }
-  async commit(connection) {
-    await connection.commit();
+  commit(connection) {
+    connection.commit();
     return connection;
   }
 };
@@ -184,24 +172,16 @@ var import_isEmpty = __toESM(require("lodash/isEmpty"));
 var IBMiQueryCompiler = class extends import_querycompiler.default {
   insert() {
     const insertValues = this.single.insert || [];
-    let sql = `select ${// @ts-ignore
-    this.single.returning ? (
-      // @ts-ignore
-      this.formatter.columnize(this.single.returning)
-    ) : "IDENTITY_VAL_LOCAL()"} from FINAL TABLE(`;
+    let sql = `select ${this.single.returning ? this.formatter.columnize(this.single.returning) : "IDENTITY_VAL_LOCAL()"} from FINAL TABLE(`;
     sql += this.with() + `insert into ${this.tableName} `;
     const { returning } = this.single;
-    const returningSql = returning ? (
-      // @ts-ignore
-      this._returning("insert", returning) + " "
-    ) : "";
+    const returningSql = returning ? this._returning("insert", returning, void 0) + " " : "";
     if (Array.isArray(insertValues)) {
       if (insertValues.length === 0) {
         return "";
       }
     } else if (typeof insertValues === "object" && (0, import_isEmpty.default)(insertValues)) {
       return {
-        // @ts-ignore
         sql: sql + returningSql + this._emptyInsertValue,
         returning
       };
@@ -221,8 +201,7 @@ var IBMiQueryCompiler = class extends import_querycompiler.default {
     } else {
       if (insertData.columns.length) {
         sql += `(${this.formatter.columnize(insertData.columns)}`;
-        sql += `) ${returningSql}values (` + // @ts-ignore
-        this._buildInsertValues(insertData) + ")";
+        sql += `) ${returningSql}values (` + this._buildInsertValues(insertData) + ")";
       } else if (insertValues.length === 1 && insertValues[0]) {
         sql += returningSql + this._emptyInsertValue;
       } else {
@@ -241,25 +220,26 @@ var IBMiQueryCompiler = class extends import_querycompiler.default {
     const isRaw = (0, import_wrappingFormatter.rawOrFn)(
       data,
       void 0,
-      // @ts-ignore
       this.builder,
-      // @ts-ignore
       this.client,
-      // @ts-ignore
       this.bindingsHolder
     );
-    if (isRaw)
+    if (isRaw) {
       return isRaw;
+    }
     let columns = [];
     const values = [];
-    if (!Array.isArray(data))
+    if (!Array.isArray(data)) {
       data = data ? [data] : [];
+    }
     let i = -1;
     while (++i < data.length) {
-      if (data[i] == null)
+      if (data[i] == null) {
         break;
-      if (i === 0)
+      }
+      if (i === 0) {
         columns = Object.keys(data[i]).sort();
+      }
       const row = new Array(columns.length);
       const keys = Object.keys(data[i]);
       let j = -1;
@@ -292,51 +272,34 @@ var IBMiQueryCompiler = class extends import_querycompiler.default {
     const limit = this.limit();
     const { returning } = this.single;
     const values = Object.values(this.single.update).map((a) => `${a}`).join(", ");
-    const moreWheres = (
-      // @ts-ignore
-      this.grouped.where && this.grouped.where.length > 0 ? (
-        // @ts-ignore
-        this.grouped.where.map((w) => {
-          if (this.single.update.hasOwnProperty(w.column))
-            return;
-          if (!w.value)
-            return;
-          return `"${w.column}" ${w.not ? "!" : ""}${w.operator} ${w.value}`;
-        })
-      ) : []
-    );
-    let selectReturning = returning ? `select ${returning.map((a) => `"${a}"`).join(", ")} from ${// @ts-ignore
-    this.tableName} where ${Object.entries(this.single.update).map(([key, value]) => `"${key}" = '${value}'`).join(" and ")}${moreWheres.length > 0 && " and "}${moreWheres.join(
+    const moreWheres = this.grouped.where && this.grouped.where.length > 0 ? this.grouped.where.map((w) => {
+      if (this.single.update.hasOwnProperty(w.column)) return;
+      if (!w.value) return;
+      return `"${w.column}" ${w.not ? "!" : ""}${w.operator} ${w.value}`;
+    }) : [];
+    let selectReturning = returning ? `select ${returning.map((a) => `"${a}"`).join(", ")} from ${this.tableName} where ${Object.entries(this.single.update).map(([key, value]) => `"${key}" = '${value}'`).join(" and ")}${moreWheres.length > 0 && " and "}${moreWheres.join(
       " and "
     )}` : "";
-    const sql = withSQL + // @ts-ignore
-    `update ${this.single.only ? "only " : ""}${this.tableName} set ` + // @ts-ignore
-    updates.join(", ") + (where ? ` ${where}` : "") + (order ? ` ${order}` : "") + (limit ? ` ${limit}` : "");
+    const sql = withSQL + `update ${this.single.only ? "only " : ""}${this.tableName} set ` + updates.join(", ") + (where ? ` ${where}` : "") + (order ? ` ${order}` : "") + (limit ? ` ${limit}` : "");
     return { sql, returning, selectReturning };
   }
   _returning(method, value, withTrigger) {
     switch (method) {
       case "update":
       case "insert":
-        return value ? (
-          // @ts-ignore
-          `${withTrigger ? " into #out" : ""}`
-        ) : "";
+        return value ? `${withTrigger ? " into #out" : ""}` : "";
       case "del":
-        return value ? (
-          // @ts-ignore
-          `${withTrigger ? " into #out" : ""}`
-        ) : "";
+        return value ? `${withTrigger ? " into #out" : ""}` : "";
       case "rowcount":
         return value ? "select @@rowcount" : "";
     }
   }
   columnizeWithPrefix(prefix, target) {
     const columns = typeof target === "string" ? [target] : target;
-    let str = "", i = -1;
+    let str = "";
+    let i = -1;
     while (++i < columns.length) {
-      if (i > 0)
-        str += ", ";
+      if (i > 0) str += ", ";
       str += prefix + this.wrap(columns[i]);
     }
     return str;
@@ -360,9 +323,6 @@ var DB2Client = class extends import_knex.knex.Client {
         `knex: Required configuration option 'client' is missing.`
       );
     }
-    if (config.version) {
-      this.version = config.version;
-    }
     if (this.driverName && config.connection) {
       this.initializeDriver();
       if (!config.pool || config.pool && config.pool.max !== 0) {
@@ -375,21 +335,30 @@ var DB2Client = class extends import_knex.knex.Client {
     }
   }
   _driver() {
-    return odbc;
+    return import_odbc.default;
+  }
+  wrapIdentifierImpl(value) {
+    return value;
   }
   printDebug(message) {
-    if (process.env.DEBUG === "true") {
-      this.logger.debug("knex-ibmi: " + message);
+    if (import_node_process.default.env.DEBUG === "true") {
+      if (this.logger.debug) {
+        this.logger.debug("knex-ibmi: " + message);
+      }
     }
   }
   printError(message) {
-    if (process.env.DEBUG === "true") {
-      this.logger.error("knex-ibmi: " + message);
+    if (import_node_process.default.env.DEBUG === "true") {
+      if (this.logger.error) {
+        this.logger.error("knex-ibmi: " + message);
+      }
     }
   }
   printWarn(message) {
-    if (process.env.DEBUG === "true") {
-      this.logger.warn("knex-ibmi: " + message);
+    if (import_node_process.default.env.DEBUG === "true") {
+      if (this.logger.warn) {
+        this.logger.warn("knex-ibmi: " + message);
+      }
     }
   }
   // Get a raw connection, called by the pool manager whenever a new
@@ -397,13 +366,14 @@ var DB2Client = class extends import_knex.knex.Client {
   async acquireRawConnection() {
     this.printDebug("acquiring raw connection");
     const connectionConfig = this.config.connection;
+    if (!connectionConfig) {
+      return this.printError("There is no connection config defined");
+    }
     this.printDebug(
-      // @ts-ignore
       "connection config: " + this._getConnectionString(connectionConfig)
     );
     if (this.config?.pool) {
       const poolConfig = {
-        // @ts-ignore
         connectionString: this._getConnectionString(connectionConfig),
         connectionTimeout: this.config?.acquireConnectionTimeout || 6e4,
         initialSize: this.config?.pool?.min || 2,
@@ -414,7 +384,6 @@ var DB2Client = class extends import_knex.knex.Client {
       return await pool.connect();
     }
     return await this.driver.connect(
-      // @ts-ignore
       this._getConnectionString(connectionConfig)
     );
   }
@@ -432,12 +401,13 @@ var DB2Client = class extends import_knex.knex.Client {
       const value = connectionStringParams[key];
       return `${result}${key}=${value};`;
     }, "");
-    return `${`DRIVER=${connectionConfig.driver};SYSTEM=${connectionConfig.host};HOSTNAME=${connectionConfig.host};PORT=${connectionConfig.port};DATABASE=${connectionConfig.database};UID=${connectionConfig.user};PWD=${connectionConfig.password};`}${connectionStringExtension}`;
+    return `${`DRIVER=${connectionConfig.driver};SYSTEM=${connectionConfig.host};HOSTNAME=${connectionConfig.host};PORT=${connectionConfig.port};DATABASE=${connectionConfig.database};UID=${connectionConfig.user};PWD=${connectionConfig.password};` + connectionStringExtension}`;
   }
   // Runs the query on the specified connection, providing the bindings
   async _query(connection, obj) {
-    if (!obj || typeof obj == "string")
+    if (!obj || typeof obj == "string") {
       obj = { sql: obj };
+    }
     const method = (obj.hasOwnProperty("method") && obj.method !== "raw" ? obj.method : obj.sql.split(" ")[0]).toLowerCase();
     obj.sqlMethod = method;
     if (method === "select" || method === "first" || method === "pluck") {
@@ -478,8 +448,7 @@ var DB2Client = class extends import_knex.knex.Client {
           obj.response = { rows: result, rowCount: result.count };
         }
       } catch (err) {
-        this.printDebug(err);
-        console.error(err);
+        this.printError(err);
         throw new Error(err);
       }
     }
@@ -487,31 +456,29 @@ var DB2Client = class extends import_knex.knex.Client {
     return obj;
   }
   transaction(container, config, outerTx) {
-    return new ibmi_transaction_default(this, ...arguments);
+    return new ibmi_transaction_default(this, container, config, outerTx);
   }
-  schemaCompiler() {
-    return new ibmi_compiler_default(this, ...arguments);
+  schemaCompiler(tableBuilder) {
+    return new ibmi_compiler_default(this, tableBuilder);
   }
-  tableCompiler() {
-    return new ibmi_tablecompiler_default(this, ...arguments);
+  tableCompiler(tableBuilder) {
+    return new ibmi_tablecompiler_default(this, tableBuilder);
   }
-  columnCompiler() {
-    return new ibmi_columncompiler_default(this, ...arguments);
+  columnCompiler(tableCompiler, columnCompiler) {
+    return new ibmi_columncompiler_default(this, tableCompiler, columnCompiler);
   }
-  queryCompiler() {
-    return new ibmi_querycompiler_default(this, ...arguments);
+  queryCompiler(builder) {
+    return new ibmi_querycompiler_default(this, builder);
   }
   processResponse(obj, runner) {
-    if (obj === null)
-      return null;
+    if (obj === null) return null;
     const resp = obj.response;
     const method = obj.sqlMethod;
     if (!resp) {
       this.printDebug("response undefined" + obj);
     }
     const { rows, rowCount } = resp;
-    if (obj.output)
-      return obj.output.call(runner, resp);
+    if (obj.output) return obj.output.call(runner, resp);
     switch (method) {
       case "select":
         return rows;

package/package.json

@@ -1,20 +1,20 @@
 {
   "name": "@bdkinc/knex-ibmi",
-  "version": "0.1.7",
+  "version": "0.2.1",
   "description": "Knex dialect for IBMi",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "files": [
-    "/dist",
-    "/src"
+    "/dist"
   ],
   "engines": {
     "node": ">=16"
   },
   "scripts": {
     "build": "tsup src/index.ts --dts",
-    "lint:scripts": "eslint . --ext .ts",
-    "format:scripts": "prettier . --write"
+    "test": "ts-mocha -p tsconfig.json --import=tsx test/**/*.spec.ts test/**/**/*.spec.ts --exit",
+    "lint": "eslint . --ext .ts",
+    "format": "prettier . --write"
   },
   "keywords": [
     "knex",
@@ -35,22 +35,26 @@
   },
   "license": "MIT",
   "devDependencies": {
-    "@faker-js/faker": "^8.3.1",
+    "@types/chai": "^4.3.17",
     "@types/knex": "^0.16.1",
-    "@typescript-eslint/eslint-plugin": "^6.14.0",
-    "@typescript-eslint/parser": "^6.14.0",
-    "debug": "^4.3.4",
-    "eslint": "^8.56.0",
+    "@types/lodash": "^4.17.7",
+    "@types/mocha": "^10.0.7",
+    "@types/node": "^22.1.0",
+    "@typescript-eslint/eslint-plugin": "^7.18.0",
+    "@typescript-eslint/parser": "^7.18.0",
+    "chai": "^5.1.1",
+    "debug": "^4.3.6",
+    "eslint": "^8.57.0",
     "eslint-config-prettier": "^9.1.0",
-    "eslint-plugin-prettier": "^5.0.1",
-    "prettier": "^3.1.1",
-    "ts-node": "^10.9.2",
-    "tslib": "^2.6.2",
-    "tsup": "^8.0.1",
-    "typescript": "^5.3.3"
+    "mocha": "^10.7.0",
+    "prettier": "^3.3.3",
+    "ts-mocha": "^10.0.0",
+    "tsup": "^8.2.4",
+    "tsx": "^4.16.5",
+    "typescript": "^5.5.4"
   },
   "dependencies": {
-    "date-fns": "^2.30.0",
+    "date-fns": "^3.6.0",
     "knex": "^3",
     "lodash": "^4.17.21",
     "odbc": "^2.4.8"