@creator.co/wapi 1.2.11 → 1.2.12

package/dist/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@creator.co/wapi",
-    "version": "1.2.11",
+    "version": "1.2.12",
     "description": "",
     "main": "dist/index.js",
     "types": "dist/index.d.ts",
@@ -34,6 +34,7 @@
         "json-stringify-safe": "^5.0.1",
         "jsonwebtoken": "^9.0.2",
         "knex": "^3.0.1",
+        "knex-stringcase": "^1.4.6",
         "node-cache": "^5.1.2",
         "object-hash": "^3.0.0",
         "parse-duration": "^1.1.0",

package/dist/src/Database/integrations/knex/KnexDatabase.d.ts

@@ -14,6 +14,7 @@ export declare class KnexDatabase extends Database<KnexTransaction> {
      * @returns None
      */
     constructor(config: DbConfig<'knex'>);
+    private constructConfig;
     /**
      * Initiates a transaction using the underlying database client.
      * @returns {Promise<KnexTransaction>} A promise that resolves to a KnexTransaction object representing the transaction.

package/dist/src/Database/integrations/knex/KnexDatabase.js

@@ -53,6 +53,7 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.KnexDatabase = void 0;
 var knex_1 = require("knex");
+var knexStringcase = require("knex-stringcase");
 var KnexTransaction_1 = require("./KnexTransaction");
 var Database_1 = require("../../Database");
 /**
@@ -68,7 +69,11 @@ var KnexDatabase = /** @class */ (function (_super) {
      */
     function KnexDatabase(config) {
         var _this = _super.call(this, config) || this;
-        _this.client = KnexDatabase.knexProvider({
+        _this.client = KnexDatabase.knexProvider(_this.constructConfig(config));
+        return _this;
+    }
+    KnexDatabase.prototype.constructConfig = function (config) {
+        var knexConfig = {
             client: config.driver,
             connection: {
                 host: config.host,
@@ -81,9 +86,9 @@ var KnexDatabase = /** @class */ (function (_super) {
                 min: 1,
                 max: config.maxConnections,
             },
-        });
-        return _this;
-    }
+        };
+        return config.convertCamelToSnake ? knexStringcase(knexConfig) : knexConfig;
+    };
     /**
      * Initiates a transaction using the underlying database client.
      * @returns {Promise<KnexTransaction>} A promise that resolves to a KnexTransaction object representing the transaction.

package/dist/src/Database/integrations/knex/KnexDatabase.js.map

@@ -1 +1 @@
-{"version":3,"file":"KnexDatabase.js","sourceRoot":"","sources":["../../../../../src/Database/integrations/knex/KnexDatabase.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,6BAAiC;AAEjC,qDAAwE;AACxE,2CAAyC;AAGzC;;;GAGG;AACH;IAAkC,gCAAyB;IAKzD;;;;OAIG;IACH,sBAAmB,MAAwB;QAA3C,YACE,kBAAM,MAAM,CAAC,SAed;QAdC,KAAI,CAAC,MAAM,GAAG,YAAY,CAAC,YAAY,CAAC;YACtC,MAAM,EAAE,MAAM,CAAC,MAAM;YACrB,UAAU,EAAE;gBACV,IAAI,EAAE,MAAM,CAAC,IAAI;gBACjB,IAAI,EAAE,MAAM,CAAC,IAAI;gBACjB,IAAI,EAAE,MAAM,CAAC,QAAQ;gBACrB,QAAQ,EAAE,MAAM,CAAC,QAAQ;gBACzB,QAAQ,EAAE,MAAM,CAAC,QAAQ;aAC1B;YACD,IAAI,EAAE;gBACJ,GAAG,EAAE,CAAC;gBACN,GAAG,EAAE,MAAM,CAAC,cAAc;aAC3B;SACF,CAAC,CAAA;;IACJ,CAAC;IAED;;;OAGG;IACmB,kCAAW,GAAjC;;;;;4BACmB,qBAAM,IAAI,CAAC,MAAM,CAAC,WAAW,EAAE,EAAA;;wBAA1C,QAAQ,GAAG,SAA+B;wBAChD,sBAAO,qCAAmB,CAAC,YAAY,CAAC,QAAQ,EAAE,IAAI,CAAC,EAAA;;;;KACxD;IAlCc,yBAAY,GAAiE,cAAI,CAAA;IAmClG,mBAAC;CAAA,AApCD,CAAkC,mBAAQ,GAoCzC;AApCY,oCAAY"}
+{"version":3,"file":"KnexDatabase.js","sourceRoot":"","sources":["../../../../../src/Database/integrations/knex/KnexDatabase.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,6BAAiC;AACjC,gDAAiD;AAEjD,qDAAwE;AACxE,2CAAyC;AAGzC;;;GAGG;AACH;IAAkC,gCAAyB;IAKzD;;;;OAIG;IACH,sBAAmB,MAAwB;QAA3C,YACE,kBAAM,MAAM,CAAC,SAGd;QADC,KAAI,CAAC,MAAM,GAAG,YAAY,CAAC,YAAY,CAAC,KAAI,CAAC,eAAe,CAAC,MAAM,CAAC,CAAC,CAAA;;IACvE,CAAC;IAEO,sCAAe,GAAvB,UAAwB,MAAwB;QAC9C,IAAM,UAAU,GAAG;YACjB,MAAM,EAAE,MAAM,CAAC,MAAM;YACrB,UAAU,EAAE;gBACV,IAAI,EAAE,MAAM,CAAC,IAAI;gBACjB,IAAI,EAAE,MAAM,CAAC,IAAI;gBACjB,IAAI,EAAE,MAAM,CAAC,QAAQ;gBACrB,QAAQ,EAAE,MAAM,CAAC,QAAQ;gBACzB,QAAQ,EAAE,MAAM,CAAC,QAAQ;aAC1B;YACD,IAAI,EAAE;gBACJ,GAAG,EAAE,CAAC;gBACN,GAAG,EAAE,MAAM,CAAC,cAAc;aAC3B;SACF,CAAA;QAED,OAAO,MAAM,CAAC,mBAAmB,CAAC,CAAC,CAAC,cAAc,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,UAAU,CAAA;IAC7E,CAAC;IAED;;;OAGG;IACmB,kCAAW,GAAjC;;;;;4BACmB,qBAAM,IAAI,CAAC,MAAM,CAAC,WAAW,EAAE,EAAA;;wBAA1C,QAAQ,GAAG,SAA+B;wBAChD,sBAAO,qCAAmB,CAAC,YAAY,CAAC,QAAQ,EAAE,IAAI,CAAC,EAAA;;;;KACxD;IAzCc,yBAAY,GAAiE,cAAI,CAAA;IA0ClG,mBAAC;CAAA,AA3CD,CAAkC,mBAAQ,GA2CzC;AA3CY,oCAAY"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@creator.co/wapi",
-  "version": "1.2.11",
+  "version": "1.2.12",
   "description": "",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -34,6 +34,7 @@
     "json-stringify-safe": "^5.0.1",
     "jsonwebtoken": "^9.0.2",
     "knex": "^3.0.1",
+    "knex-stringcase": "^1.4.6",
     "node-cache": "^5.1.2",
     "object-hash": "^3.0.0",
     "parse-duration": "^1.1.0",

package/src/Database/integrations/knex/KnexDatabase.ts

@@ -1,4 +1,5 @@
 import knex, { Knex } from 'knex'
+import * as knexStringcase from 'knex-stringcase'
 
 import { KnexTransaction, KnexTransactionImpl } from './KnexTransaction'
 import { Database } from '../../Database'
@@ -20,7 +21,12 @@ export class KnexDatabase extends Database<KnexTransaction> {
    */
   public constructor(config: DbConfig<'knex'>) {
     super(config)
-    this.client = KnexDatabase.knexProvider({
+
+    this.client = KnexDatabase.knexProvider(this.constructConfig(config))
+  }
+
+  private constructConfig(config: DbConfig<'knex'>) {
+    const knexConfig = {
       client: config.driver,
       connection: {
         host: config.host,
@@ -33,7 +39,9 @@ export class KnexDatabase extends Database<KnexTransaction> {
         min: 1,
         max: config.maxConnections,
       },
-    })
+    }
+
+    return config.convertCamelToSnake ? knexStringcase(knexConfig) : knexConfig
   }
 
   /**

package/src/Database/types.d.ts

@@ -34,9 +34,10 @@ export type DatabaseTransactionType<Type extends DatabaseType> =
  * @property {string} database - The name of the database to connect to.
  * @property {boolean} autoCommit - Whether or not to automatically commit transactions.
  * @property {number} maxConnections - The maximum number of connections to the database.
+ * @property {boolean} [convertCamelToSnake] - Whether or not to convert camel case to snake case for column names.
  * @returns The transaction type associated with the specified database type.
  */
-export interface DbConfig<S extends DatabaseType> {
+export type DbConfig<S extends DatabaseType> = {
   type: S
   driver: string
   host: string
@@ -46,4 +47,8 @@ export interface DbConfig<S extends DatabaseType> {
   database: string
   autoCommit: boolean
   maxConnections: number
-}
+} & (S extends 'knex'
+  ? {
+      convertCamelToSnake?: boolean
+    }
+  : any)

package/tests/Database/integrations/knex/KnexDatabase.test.ts

@@ -50,4 +50,27 @@ describe('KnexDatabase', () => {
     expect(trans).toBeInstanceOf(KnexTransactionImpl)
     expect(trans['delegate']).toBe(mockTrans)
   })
+
+  test('KnexDatabase - convert camel to snake', async () => {
+    const mockTrans = { a: 'b' } as any
+    const mockClient = jest.fn(
+      () =>
+        ({
+          transaction: async () => mockTrans,
+        }) as Knex
+    )
+    KnexDatabase['knexProvider'] = mockClient
+
+    const underTest = new KnexDatabase({ ...config, convertCamelToSnake: true })
+    expect(mockClient).toBeCalledWith({
+      ...expectedImplConfig,
+      postProcessResponse: expect.any(Function),
+      wrapIdentifier: expect.any(Function),
+    })
+
+    const trans = await underTest.transaction()
+
+    expect(trans).toBeInstanceOf(KnexTransactionImpl)
+    expect(trans['delegate']).toBe(mockTrans)
+  })
 })