@creator.co/wapi 1.4.0-alpha4 → 1.4.0

package/dist/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@creator.co/wapi",
-    "version": "1.4.0-alpha4",
+    "version": "1.4.0",
     "description": "",
     "main": "dist/index.js",
     "types": "dist/index.d.ts",

package/dist/src/Database/integrations/kysely/KyselyDatabase.d.ts

@@ -26,7 +26,7 @@ export declare class KyselyDatabase<DBSchema> extends Database<KyselyTransaction
     /**
      * Represents a PostgreSQL client using the PostgresDialect.
      */
-    readonly pgClient: PostgresDialect;
+    private readonly pgClient;
     /**
      * Represents a client for querying the database with the specified schema.
      * @type {Kysely<DBSchema>} client - The client for querying the database.
@@ -35,7 +35,7 @@ export declare class KyselyDatabase<DBSchema> extends Database<KyselyTransaction
     /**
      * Optional property representing the Postgres dialect for reading in a database client.
      */
-    readonly pgReadClient?: PostgresDialect;
+    private readonly pgReadClient?;
     /**
      * Represents a client for reading from the database.
      * @type {Kysely<DBSchema> | undefined} - The client for reading from the database.
@@ -52,4 +52,16 @@ export declare class KyselyDatabase<DBSchema> extends Database<KyselyTransaction
      * @returns A Promise that resolves to a KyselyTransaction object for the specified database schema.
      */
     transaction(): Promise<KyselyTransaction<DBSchema>>;
+    /**
+     * Creates a database dialect based on the provided configuration.
+     * @param {DbBaseConfig} config - The configuration object for the database connection.
+     * @returns A database dialect instance based on the provided configuration.
+     */
+    private dialectFactory;
+    /**
+     * Creates a provider for interacting with a database using the specified Postgres dialect.
+     * @param {PostgresDialect} dialect - The Postgres dialect to use for the database connection.
+     * @returns A database provider for interacting with the database.
+     */
+    private providerFactory;
 }

package/dist/src/Database/integrations/kysely/KyselyDatabase.js

@@ -69,29 +69,11 @@ var KyselyDatabase = /** @class */ (function (_super) {
      */
     function KyselyDatabase(config) {
         var _this = _super.call(this, config) || this;
-        _this.pgClient = new KyselyDatabase.kyselyPgProvider({
-            pool: new KyselyDatabase.pgProvider({
-                host: config.host,
-                port: config.port,
-                user: config.username,
-                password: config.password,
-                database: config.database,
-                max: config.maxConnections,
-            }),
-        });
-        _this.client = new KyselyDatabase.kyselyProvider({ dialect: _this.pgClient });
+        _this.pgClient = _this.dialectFactory(config);
+        _this.client = _this.providerFactory(_this.pgClient);
         if (config.readReplica) {
-            _this.pgReadClient = new KyselyDatabase.kyselyPgProvider({
-                pool: new KyselyDatabase.pgProvider({
-                    host: config.readReplica.host,
-                    port: config.readReplica.port,
-                    user: config.readReplica.username,
-                    password: config.readReplica.password,
-                    database: config.readReplica.database,
-                    max: config.readReplica.maxConnections,
-                }),
-            });
-            _this.readClient = new KyselyDatabase.kyselyProvider({ dialect: _this.pgReadClient });
+            _this.pgReadClient = _this.dialectFactory(config.readReplica);
+            _this.readClient = _this.providerFactory(_this.pgReadClient);
         }
         return _this;
     }
@@ -106,6 +88,34 @@ var KyselyDatabase = /** @class */ (function (_super) {
             });
         });
     };
+    /**
+     * Creates a database dialect based on the provided configuration.
+     * @param {DbBaseConfig} config - The configuration object for the database connection.
+     * @returns A database dialect instance based on the provided configuration.
+     */
+    KyselyDatabase.prototype.dialectFactory = function (config) {
+        return new KyselyDatabase.kyselyPgProvider({
+            pool: new KyselyDatabase.pgProvider({
+                host: config.host,
+                port: config.port,
+                user: config.username,
+                password: config.password,
+                database: config.database,
+                max: config.maxConnections,
+            }),
+        });
+    };
+    /**
+     * Creates a provider for interacting with a database using the specified Postgres dialect.
+     * @param {PostgresDialect} dialect - The Postgres dialect to use for the database connection.
+     * @returns A database provider for interacting with the database.
+     */
+    KyselyDatabase.prototype.providerFactory = function (dialect) {
+        return new KyselyDatabase.kyselyProvider({
+            dialect: dialect,
+            plugins: [new kysely_1.CamelCasePlugin()],
+        });
+    };
     /**
      * Represents a PostgreSQL provider for querying data using the PostgresDialect.
      * @type {PostgresDialect}

package/dist/src/Database/integrations/kysely/KyselyDatabase.js.map

@@ -1 +1 @@
-{"version":3,"file":"KyselyDatabase.js","sourceRoot":"","sources":["../../../../../src/Database/integrations/kysely/KyselyDatabase.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,iCAAgD;AAChD,yBAAyB;AAEzB,yDAA8E;AAC9E,2CAAyC;AAGzC;;;GAGG;AACH;IAA8C,kCAAqC;IAmCjF;;;;OAIG;IACH,wBAAmB,MAA0B;QAC3C,YAAA,MAAK,YAAC,MAAM,CAAC,SAAA;QACb,KAAI,CAAC,QAAQ,GAAG,IAAI,cAAc,CAAC,gBAAgB,CAAC;YAClD,IAAI,EAAE,IAAI,cAAc,CAAC,UAAU,CAAC;gBAClC,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;gBACzB,GAAG,EAAE,MAAM,CAAC,cAAc;aAC3B,CAAC;SACH,CAAC,CAAA;QACF,KAAI,CAAC,MAAM,GAAG,IAAI,cAAc,CAAC,cAAc,CAAW,EAAE,OAAO,EAAE,KAAI,CAAC,QAAQ,EAAE,CAAC,CAAA;QACrF,IAAI,MAAM,CAAC,WAAW,EAAE,CAAC;YACvB,KAAI,CAAC,YAAY,GAAG,IAAI,cAAc,CAAC,gBAAgB,CAAC;gBACtD,IAAI,EAAE,IAAI,cAAc,CAAC,UAAU,CAAC;oBAClC,IAAI,EAAE,MAAM,CAAC,WAAW,CAAC,IAAI;oBAC7B,IAAI,EAAE,MAAM,CAAC,WAAW,CAAC,IAAI;oBAC7B,IAAI,EAAE,MAAM,CAAC,WAAW,CAAC,QAAQ;oBACjC,QAAQ,EAAE,MAAM,CAAC,WAAW,CAAC,QAAQ;oBACrC,QAAQ,EAAE,MAAM,CAAC,WAAW,CAAC,QAAQ;oBACrC,GAAG,EAAE,MAAM,CAAC,WAAW,CAAC,cAAc;iBACvC,CAAC;aACH,CAAC,CAAA;YACF,KAAI,CAAC,UAAU,GAAG,IAAI,cAAc,CAAC,cAAc,CAAW,EAAE,OAAO,EAAE,KAAI,CAAC,YAAY,EAAE,CAAC,CAAA;QAC/F,CAAC;;IACH,CAAC;IAED;;;OAGG;IACmB,oCAAW,GAAjC;;;gBACE,sBAAO,yCAAqB,CAAC,cAAc,CAAW,IAAI,CAAC,MAAM,EAAE,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,EAAA;;;KAC1F;IAzED;;;OAGG;IACW,+BAAgB,GAAG,wBAAe,CAAA;IAChD;;;OAGG;IACW,6BAAc,GAAG,eAAM,CAAA;IACrC;;;OAGG;IACW,yBAAU,GAAG,SAAI,CAAA;IA4DjC,qBAAC;CAAA,AA3ED,CAA8C,mBAAQ,GA2ErD;AA3EY,wCAAc"}
+{"version":3,"file":"KyselyDatabase.js","sourceRoot":"","sources":["../../../../../src/Database/integrations/kysely/KyselyDatabase.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,iCAAiE;AACjE,yBAAyB;AAEzB,yDAA8E;AAC9E,2CAAyC;AAGzC;;;GAGG;AACH;IAA8C,kCAAqC;IAmCjF;;;;OAIG;IACH,wBAAmB,MAA0B;QAC3C,YAAA,MAAK,YAAC,MAAM,CAAC,SAAA;QACb,KAAI,CAAC,QAAQ,GAAG,KAAI,CAAC,cAAc,CAAC,MAAM,CAAC,CAAA;QAC3C,KAAI,CAAC,MAAM,GAAG,KAAI,CAAC,eAAe,CAAC,KAAI,CAAC,QAAQ,CAAC,CAAA;QACjD,IAAI,MAAM,CAAC,WAAW,EAAE,CAAC;YACvB,KAAI,CAAC,YAAY,GAAG,KAAI,CAAC,cAAc,CAAC,MAAM,CAAC,WAAW,CAAC,CAAA;YAC3D,KAAI,CAAC,UAAU,GAAG,KAAI,CAAC,eAAe,CAAC,KAAI,CAAC,YAAY,CAAC,CAAA;QAC3D,CAAC;;IACH,CAAC;IAED;;;OAGG;IACmB,oCAAW,GAAjC;;;gBACE,sBAAO,yCAAqB,CAAC,cAAc,CAAW,IAAI,CAAC,MAAM,EAAE,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,EAAA;;;KAC1F;IACD;;;;OAIG;IACK,uCAAc,GAAtB,UAAuB,MAAoB;QACzC,OAAO,IAAI,cAAc,CAAC,gBAAgB,CAAC;YACzC,IAAI,EAAE,IAAI,cAAc,CAAC,UAAU,CAAC;gBAClC,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;gBACzB,GAAG,EAAE,MAAM,CAAC,cAAc;aAC3B,CAAC;SACH,CAAC,CAAA;IACJ,CAAC;IACD;;;;OAIG;IACK,wCAAe,GAAvB,UAAwB,OAAwB;QAC9C,OAAO,IAAI,cAAc,CAAC,cAAc,CAAW;YACjD,OAAO,SAAA;YACP,OAAO,EAAE,CAAC,IAAI,wBAAe,EAAE,CAAC;SACjC,CAAC,CAAA;IACJ,CAAC;IAnFD;;;OAGG;IACW,+BAAgB,GAAG,wBAAe,CAAA;IAChD;;;OAGG;IACW,6BAAc,GAAG,eAAM,CAAA;IACrC;;;OAGG;IACW,yBAAU,GAAG,SAAI,CAAA;IAsEjC,qBAAC;CAAA,AArFD,CAA8C,mBAAQ,GAqFrD;AArFY,wCAAc"}

package/dist/src/Database/integrations/pgsql/PostgresDatabase.d.ts

@@ -32,4 +32,5 @@ export declare class PostgresDatabase extends Database<PostgresTransaction> {
      * @returns {Promise<PostgresTransaction>} A promise that resolves to a new PostgresTransaction object.
      */
     transaction(): Promise<PostgresTransaction>;
+    private providerFactory;
 }

package/dist/src/Database/integrations/pgsql/PostgresDatabase.js

@@ -68,24 +68,9 @@ var PostgresDatabase = /** @class */ (function (_super) {
      */
     function PostgresDatabase(config) {
         var _this = _super.call(this, config) || this;
-        _this.client = new PostgresDatabase.pgProvider({
-            host: config.host,
-            port: config.port,
-            user: config.username,
-            password: config.password,
-            database: config.database,
-            max: config.maxConnections,
-        });
-        if (config.readReplica) {
-            _this.readClient = new PostgresDatabase.pgProvider({
-                host: config.readReplica.host,
-                port: config.readReplica.port,
-                user: config.readReplica.username,
-                password: config.readReplica.password,
-                database: config.readReplica.database,
-                max: config.readReplica.maxConnections,
-            });
-        }
+        _this.client = _this.providerFactory(config);
+        if (config.readReplica)
+            _this.readClient = _this.providerFactory(config.readReplica);
         return _this;
     }
     /**
@@ -99,6 +84,16 @@ var PostgresDatabase = /** @class */ (function (_super) {
             });
         });
     };
+    PostgresDatabase.prototype.providerFactory = function (config) {
+        return new PostgresDatabase.pgProvider({
+            host: config.host,
+            port: config.port,
+            user: config.username,
+            password: config.password,
+            database: config.database,
+            max: config.maxConnections,
+        });
+    };
     /**
      * A public static property that represents a connection pool for a PostgreSQL database.
      * This property is used to manage and provide connections to the PostgreSQL database.

package/dist/src/Database/integrations/pgsql/PostgresDatabase.js.map

@@ -1 +1 @@
-{"version":3,"file":"PostgresDatabase.js","sourceRoot":"","sources":["../../../../../src/Database/integrations/pgsql/PostgresDatabase.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,yBAAyB;AAEzB,6DAAoF;AACpF,2CAAyC;AAGzC;;;GAGG;AACH;IAAsC,oCAA6B;IAgBjE;;;;OAIG;IACH,0BAAmB,MAAsB;QACvC,YAAA,MAAK,YAAC,MAAM,CAAC,SAAA;QACb,KAAI,CAAC,MAAM,GAAG,IAAI,gBAAgB,CAAC,UAAU,CAAC;YAC5C,IAAI,EAAE,MAAM,CAAC,IAAI;YACjB,IAAI,EAAE,MAAM,CAAC,IAAI;YACjB,IAAI,EAAE,MAAM,CAAC,QAAQ;YACrB,QAAQ,EAAE,MAAM,CAAC,QAAQ;YACzB,QAAQ,EAAE,MAAM,CAAC,QAAQ;YACzB,GAAG,EAAE,MAAM,CAAC,cAAc;SAC3B,CAAC,CAAA;QACF,IAAI,MAAM,CAAC,WAAW,EAAE,CAAC;YACvB,KAAI,CAAC,UAAU,GAAG,IAAI,gBAAgB,CAAC,UAAU,CAAC;gBAChD,IAAI,EAAE,MAAM,CAAC,WAAW,CAAC,IAAI;gBAC7B,IAAI,EAAE,MAAM,CAAC,WAAW,CAAC,IAAI;gBAC7B,IAAI,EAAE,MAAM,CAAC,WAAW,CAAC,QAAQ;gBACjC,QAAQ,EAAE,MAAM,CAAC,WAAW,CAAC,QAAQ;gBACrC,QAAQ,EAAE,MAAM,CAAC,WAAW,CAAC,QAAQ;gBACrC,GAAG,EAAE,MAAM,CAAC,WAAW,CAAC,cAAc;aACvC,CAAC,CAAA;QACJ,CAAC;;IACH,CAAC;IAED;;;OAGG;IACmB,sCAAW,GAAjC;;;gBACE,sBAAO,6CAAuB,CAAC,cAAc,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,EAAA;;;KAClF;IAhDD;;;OAGG;IACW,2BAAU,GAAG,SAAI,CAAA;IA6CjC,uBAAC;CAAA,AAlDD,CAAsC,mBAAQ,GAkD7C;AAlDY,4CAAgB"}
+{"version":3,"file":"PostgresDatabase.js","sourceRoot":"","sources":["../../../../../src/Database/integrations/pgsql/PostgresDatabase.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,yBAAyB;AAEzB,6DAAoF;AACpF,2CAAyC;AAGzC;;;GAGG;AACH;IAAsC,oCAA6B;IAgBjE;;;;OAIG;IACH,0BAAmB,MAAsB;QACvC,YAAA,MAAK,YAAC,MAAM,CAAC,SAAA;QACb,KAAI,CAAC,MAAM,GAAG,KAAI,CAAC,eAAe,CAAC,MAAM,CAAC,CAAA;QAC1C,IAAI,MAAM,CAAC,WAAW;YAAE,KAAI,CAAC,UAAU,GAAG,KAAI,CAAC,eAAe,CAAC,MAAM,CAAC,WAAW,CAAC,CAAA;;IACpF,CAAC;IAED;;;OAGG;IACmB,sCAAW,GAAjC;;;gBACE,sBAAO,6CAAuB,CAAC,cAAc,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,EAAA;;;KAClF;IACO,0CAAe,GAAvB,UAAwB,MAAoB;QAC1C,OAAO,IAAI,gBAAgB,CAAC,UAAU,CAAC;YACrC,IAAI,EAAE,MAAM,CAAC,IAAI;YACjB,IAAI,EAAE,MAAM,CAAC,IAAI;YACjB,IAAI,EAAE,MAAM,CAAC,QAAQ;YACrB,QAAQ,EAAE,MAAM,CAAC,QAAQ;YACzB,QAAQ,EAAE,MAAM,CAAC,QAAQ;YACzB,GAAG,EAAE,MAAM,CAAC,cAAc;SAC3B,CAAC,CAAA;IACJ,CAAC;IA1CD;;;OAGG;IACW,2BAAU,GAAG,SAAI,CAAA;IAuCjC,uBAAC;CAAA,AA5CD,CAAsC,mBAAQ,GA4C7C;AA5CY,4CAAgB"}

package/dist/src/Database/types.d.ts

@@ -48,7 +48,7 @@ export type DatabaseTransactionType<Type extends DatabaseType, DBSchema> = Datab
  * @typedef {Object} DbConfig
  * @property {string} type - The type of
  */
-type DbBaseConfig = {
+export type DbBaseConfig = {
     host: string;
     port: number;
     username: string;
@@ -57,6 +57,16 @@ type DbBaseConfig = {
     autoCommit: boolean;
     maxConnections: number;
 };
+/**
+ * Defines the configuration options for different types of databases.
+ * @template S - The type of database (e.g., 'knex', 'pg', 'kysely')
+ * @typedef {Object} DbConfig
+ * @property {DbBaseConfig} DbBaseConfig - The base configuration for the database.
+ * @property {S} type - The type of the database.
+ * @property {string} [driver] - The driver for the 'knex' database type.
+ * @property {boolean} [convertCamelToSnake] - Whether to convert camel case to snake case for 'knex' database type.
+ * @property {DbBaseConfig} [readReplica] - The read replica configuration for '
+ */
 export type DbConfig<S extends DatabaseType> = DbBaseConfig & {
     type: S;
 } & (S extends 'knex' ? {
@@ -65,4 +75,3 @@ export type DbConfig<S extends DatabaseType> = DbBaseConfig & {
 } : unknown) & (S extends 'pg' | 'kysely' ? {
     readReplica?: DbBaseConfig;
 } : unknown);
-export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@creator.co/wapi",
-  "version": "1.4.0-alpha4",
+  "version": "1.4.0",
   "description": "",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package/src/Database/integrations/kysely/KyselyDatabase.ts

@@ -1,9 +1,9 @@
-import { Kysely, PostgresDialect } from 'kysely'
+import { CamelCasePlugin, Kysely, PostgresDialect } from 'kysely'
 import { Pool } from 'pg'
 
 import { KyselyTransaction, KyselyTransactionImpl } from './KyselyTransaction'
 import { Database } from '../../Database'
-import type { DbConfig } from '../../types'
+import type { DbBaseConfig, DbConfig } from '../../types'
 
 /**
  * Represents a database connection using the Kysely library with support for transactions.
@@ -28,7 +28,7 @@ export class KyselyDatabase<DBSchema> extends Database<KyselyTransaction<DBSchem
   /**
    * Represents a PostgreSQL client using the PostgresDialect.
    */
-  public readonly pgClient: PostgresDialect
+  private readonly pgClient: PostgresDialect
   /**
    * Represents a client for querying the database with the specified schema.
    * @type {Kysely<DBSchema>} client - The client for querying the database.
@@ -37,7 +37,7 @@ export class KyselyDatabase<DBSchema> extends Database<KyselyTransaction<DBSchem
   /**
    * Optional property representing the Postgres dialect for reading in a database client.
    */
-  public readonly pgReadClient?: PostgresDialect
+  private readonly pgReadClient?: PostgresDialect
   /**
    * Represents a client for reading from the database.
    * @type {Kysely<DBSchema> | undefined} - The client for reading from the database.
@@ -51,7 +51,28 @@ export class KyselyDatabase<DBSchema> extends Database<KyselyTransaction<DBSchem
    */
   public constructor(config: DbConfig<'kysely'>) {
     super(config)
-    this.pgClient = new KyselyDatabase.kyselyPgProvider({
+    this.pgClient = this.dialectFactory(config)
+    this.client = this.providerFactory(this.pgClient)
+    if (config.readReplica) {
+      this.pgReadClient = this.dialectFactory(config.readReplica)
+      this.readClient = this.providerFactory(this.pgReadClient)
+    }
+  }
+
+  /**
+   * Override method that starts a new transaction using the provided client and read client.
+   * @returns A Promise that resolves to a KyselyTransaction object for the specified database schema.
+   */
+  public override async transaction(): Promise<KyselyTransaction<DBSchema>> {
+    return KyselyTransactionImpl.newTransaction<DBSchema>(this.client, this, this.readClient)
+  }
+  /**
+   * Creates a database dialect based on the provided configuration.
+   * @param {DbBaseConfig} config - The configuration object for the database connection.
+   * @returns A database dialect instance based on the provided configuration.
+   */
+  private dialectFactory(config: DbBaseConfig) {
+    return new KyselyDatabase.kyselyPgProvider({
       pool: new KyselyDatabase.pgProvider({
         host: config.host,
         port: config.port,
@@ -61,27 +82,16 @@ export class KyselyDatabase<DBSchema> extends Database<KyselyTransaction<DBSchem
         max: config.maxConnections,
       }),
     })
-    this.client = new KyselyDatabase.kyselyProvider<DBSchema>({ dialect: this.pgClient })
-    if (config.readReplica) {
-      this.pgReadClient = new KyselyDatabase.kyselyPgProvider({
-        pool: new KyselyDatabase.pgProvider({
-          host: config.readReplica.host,
-          port: config.readReplica.port,
-          user: config.readReplica.username,
-          password: config.readReplica.password,
-          database: config.readReplica.database,
-          max: config.readReplica.maxConnections,
-        }),
-      })
-      this.readClient = new KyselyDatabase.kyselyProvider<DBSchema>({ dialect: this.pgReadClient })
-    }
   }
-
   /**
-   * Override method that starts a new transaction using the provided client and read client.
-   * @returns A Promise that resolves to a KyselyTransaction object for the specified database schema.
+   * Creates a provider for interacting with a database using the specified Postgres dialect.
+   * @param {PostgresDialect} dialect - The Postgres dialect to use for the database connection.
+   * @returns A database provider for interacting with the database.
    */
-  public override async transaction(): Promise<KyselyTransaction<DBSchema>> {
-    return KyselyTransactionImpl.newTransaction<DBSchema>(this.client, this, this.readClient)
+  private providerFactory(dialect: PostgresDialect) {
+    return new KyselyDatabase.kyselyProvider<DBSchema>({
+      dialect,
+      plugins: [new CamelCasePlugin()],
+    })
   }
 }

package/src/Database/integrations/pgsql/PostgresDatabase.ts

@@ -2,7 +2,7 @@ import { Pool } from 'pg'
 
 import { PostgresTransaction, PostgresTransactionImpl } from './PostgresTransaction'
 import { Database } from '../../Database'
-import type { DbConfig } from '../../types'
+import type { DbBaseConfig, DbConfig } from '../../types'
 
 /**
  * Represents a Postgres database connection that extends the Database class.
@@ -31,24 +31,8 @@ export class PostgresDatabase extends Database<PostgresTransaction> {
    */
   public constructor(config: DbConfig<'pg'>) {
     super(config)
-    this.client = new PostgresDatabase.pgProvider({
-      host: config.host,
-      port: config.port,
-      user: config.username,
-      password: config.password,
-      database: config.database,
-      max: config.maxConnections,
-    })
-    if (config.readReplica) {
-      this.readClient = new PostgresDatabase.pgProvider({
-        host: config.readReplica.host,
-        port: config.readReplica.port,
-        user: config.readReplica.username,
-        password: config.readReplica.password,
-        database: config.readReplica.database,
-        max: config.readReplica.maxConnections,
-      })
-    }
+    this.client = this.providerFactory(config)
+    if (config.readReplica) this.readClient = this.providerFactory(config.readReplica)
   }
 
   /**
@@ -58,4 +42,14 @@ export class PostgresDatabase extends Database<PostgresTransaction> {
   public override async transaction(): Promise<PostgresTransaction> {
     return PostgresTransactionImpl.newTransaction(this.client, this, this.readClient)
   }
+  private providerFactory(config: DbBaseConfig) {
+    return new PostgresDatabase.pgProvider({
+      host: config.host,
+      port: config.port,
+      user: config.username,
+      password: config.password,
+      database: config.database,
+      max: config.maxConnections,
+    })
+  }
 }

package/src/Database/types.ts

@@ -54,7 +54,7 @@ export type DatabaseTransactionType<Type extends DatabaseType, DBSchema> =
  * @typedef {Object} DbConfig
  * @property {string} type - The type of
  */
-type DbBaseConfig = {
+export type DbBaseConfig = {
   host: string
   port: number
   username: string
@@ -63,6 +63,16 @@ type DbBaseConfig = {
   autoCommit: boolean
   maxConnections: number
 }
+/**
+ * Defines the configuration options for different types of databases.
+ * @template S - The type of database (e.g., 'knex', 'pg', 'kysely')
+ * @typedef {Object} DbConfig
+ * @property {DbBaseConfig} DbBaseConfig - The base configuration for the database.
+ * @property {S} type - The type of the database.
+ * @property {string} [driver] - The driver for the 'knex' database type.
+ * @property {boolean} [convertCamelToSnake] - Whether to convert camel case to snake case for 'knex' database type.
+ * @property {DbBaseConfig} [readReplica] - The read replica configuration for '
+ */
 export type DbConfig<S extends DatabaseType> = DbBaseConfig & { type: S } & (S extends 'knex'
     ? {
         driver?: string