@koziatek/pgsql 1.0.1

package/.env.example

@@ -0,0 +1,3 @@
+PGSQL_DATABASE_CONNECTION_STRING=postgres://postgres:<password>@<ip>:5432/<database_name>
+PGSQL_USE_SSL=true
+PGSQL_POOL_MAX=10

package/env.js

@@ -0,0 +1,7 @@
+module.exports = {
+    PGSQL_DATABASE_CONNECTION_STRING: process?.env?.PGSQL_DATABASE_CONNECTION_STRING || false,
+    PGSQL_POOL_MAX: process?.env?.PGSQL_POOL_MAX || 1,
+    PGSQL_POOL_IDLE_MS: process?.env?.PGSQL_POOL_IDLE_MS || 30_000,
+    PGSQL_POOL_CONN_TIMEOUT_MS: process?.env?.PGSQL_POOL_CONN_TIMEOUT_MS || 5_000,
+    PGSQL_POOL_MAX_USES: process?.env?.PGSQL_POOL_MAX_USES || 5_000,
+};

package/index.js

@@ -0,0 +1,77 @@
+const { Pool } = require('pg');
+const env = require('./env');
+
+let POOL;
+let POOL_PROMISE;
+
+class PgSQL {
+
+    static async GetPool() {
+        if (POOL) return POOL;
+        if (POOL_PROMISE) return POOL_PROMISE;
+        POOL_PROMISE = PgSQL.Open();
+        POOL = await POOL_PROMISE;
+        POOL_PROMISE = null;
+        return POOL;
+    }
+
+    static async Close() {
+        let pool = await PgSQL.GetPool();
+        await pool.end();
+    }
+
+    static async Open(config=env) {
+        if(POOL) return POOL;
+
+        if(!config?.PGSQL_DATABASE_CONNECTION_STRING) throw new Error('Missing Connection String: PGSQL_DATABASE_CONNECTION_STRING')
+
+        return POOL = new Pool({
+            connectionString: config.PGSQL_DATABASE_CONNECTION_STRING,
+            max: Number(config.PGSQL_POOL_MAX || 1),
+            idleTimeoutMillis: Number(config.PGSQL_POOL_IDLE_MS || 30_000),
+            connectionTimeoutMillis: Number(config.PGSQL_POOL_CONN_TIMEOUT_MS || 5_000),
+            maxUses: Number(config.PGSQL_POOL_MAX_USES || 5_000),
+        });
+    }
+
+    /**
+     * Runs a SQL query with optional parameters.
+     * @param {string} sql - The SQL statement with placeholders (e.g. 'SELECT * FROM users WHERE id = $1')
+     * @param {Array} params - The values to safely inject in place of placeholders.
+     * @returns {Promise} Resolves with query result rows or rejects with error.
+     */
+    static async Query(sql, params = []) {
+        try {
+            let pool = await PgSQL.GetPool();
+            const result = await pool.query(sql, params);
+            return result.rows;
+        } catch (err) {
+            console.error('Database query error:', err);
+            throw err;
+        }
+    }
+
+    static async Exec(sql, params = []) {
+        const pool = await PgSQL.GetPool();
+        return pool.query(sql, params);
+    }
+
+    /**
+     * Checks if the database connection is healthy.
+     * @returns {Promise<boolean>}
+     */
+        static async CheckConnection() {
+            try {
+                let pool = await PgSQL.GetPool();
+                await pool.query('SELECT 1');
+                return true;
+            } catch (err) {
+                console.error('Database connection check failed:', err);
+                return false;
+            }
+        }
+}
+
+module.exports = {
+    PgSQL
+};

package/package.json

@@ -0,0 +1,22 @@
+{
+  "name": "@koziatek/pgsql",
+  "version": "1.0.1",
+  "description": "",
+  "main": "index.js",
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "test": "jest"
+  },
+  "keywords": [],
+  "author": "",
+  "license": "ISC",
+  "dependencies": {
+    "dotenv": "^16.5.0",
+    "pg": "^8.15.6"
+  },
+  "devDependencies": {
+    "jest": "^29.7.0"
+  }
+}

package/tests/Connection.test.js

@@ -0,0 +1,11 @@
+const { PgSQL } = require("..");
+
+
+
+describe('PgSQL Connection', ()=>{
+    it('- can connect to database.', async () => {
+        const connected = await PgSQL.CheckConnection();
+        expect(connected).toBe(true);
+    });
+
+});