pg-query-sdk 1.0.3 → 1.2.0

package/README.md

@@ -42,8 +42,6 @@ const db = new Database({
 });
 ```
 
----
-
 ## 🛠 Core Functionalities
 
 ### 1️⃣ QueryBuilder: Fluent SQL `SELECT` Query Construction
@@ -79,27 +77,27 @@ The `ConditionBuilder` facilitates the creation of complex conditional logic wit
 import {Database} from 'pg-query-sdk';
 
 const db = new Database({
-  connectionString: 'postgres://user:pass@localhost:5432/your_database',
+    connectionString: 'postgres://user:pass@localhost:5432/your_database',
 });
 
 async function complexWhereExample() {
-  const products = await db.table('products')
-    .select(['name', 'price'])
-    .where(conditions => {
-      conditions
-        .where({ category: 'electronics' })
-        .orGroup(group => {
-          group
-            .where({ price: { op: '<', value: 100 } })
-            .where({ stock: { op: '>', value: 0 } });
-        });
-    })
-    .execute();
 
-  console.log('Complex WHERE Products:', products);
+    const products = await db
+        .table('products')
+        .select(['name', 'price'])
+        .where(conditions => {
+            conditions
+                .where({category: 'electronics'})
+                .orGroup(group => {
+                    group.where({price: {op: '<', value: 100}})
+                        .where({stock: {op: '>', value: 0}})
+                })
+        }).execute()
+
+    console.log('Complex WHERE Products:', products)
 }
 
-complexWhereExample();
+complexWhereExample()
 ```
 
 ### 3️⃣ QueryExecutor: Direct Query Execution
@@ -138,8 +136,6 @@ const db = new Database({
 async function transactionExample() {
   try {
     const result = await db.transaction(async trxDb => {
-      // 'trxDb' is a Database instance bound to the current transaction.
-      // Use 'trxDb.executor.execute()' for DML operations within the transaction.
       await trxDb.executor.execute(
         'UPDATE accounts SET balance = balance - $1 WHERE id = $2',
         [100.00, 1]
@@ -183,9 +179,6 @@ class UserRepository extends Repository<User> {
       .where({ name })
       .execute();
   }
-
-  // Implement DML operations as needed.
-  // Example: async insert(data: Partial<User>): Promise<User> { /* ... */ }
 }
 
 const db = new Database({
@@ -214,7 +207,7 @@ The package provides support for both CommonJS and ES Modules environments.
 ### CommonJS
 
 ```javascript
-const Database = require('pg-query-sdk').default;
+const {Database} = require('pg-query-sdk');
 const db = new Database({ /* ... */ });
 ```
 
@@ -227,32 +220,6 @@ const db = new Database({ /* ... */ });
 
 ---
 
-## 🧱 Project Structure
-
-The project is organized into distinct modules, each responsible for a specific aspect of database interaction:
-
-```
-pg-query-sdk/
-  src/
-    core/
-      Database.ts           # Central database interface
-      ParamContext.ts       # Manages query parameters
-      QueryExecutor.ts      # Executes SQL queries
-      TransactionManager.ts # Handles database transactions
-    builders/
-      ConditionBuilder.ts   # Builds WHERE/HAVING clauses
-      QueryBuilder.ts       # Builds SELECT queries
-    orm/
-      EntityManager.ts      # (Planned) Entity management
-      Repository.ts         # Abstract base for data access
-    dialects/
-      Dialect.ts            # Interface for database dialects
-      PostgresDialect.ts    # PostgreSQL specific dialect implementation
-    index.ts                # Main entry point for module exports
-```
-
----
-
 ## 📌 Responsibilities of Layers
 
 | Layer                 | Responsibility                                                                                                 |

package/dist/cjs/query/ConditionBuilder.d.ts

@@ -1,9 +1,4 @@
 import ParamContext from '../core/ParamContext';
-type Operator = '=' | '>' | '<' | '>=' | '<=' | '!=' | '<>' | 'LIKE' | 'ILIKE' | 'IN' | 'NOT IN' | 'BETWEEN' | 'EXISTS';
-type ConditionValue = any | {
-    op: Operator;
-    value: any;
-};
 /**
  * A builder for constructing SQL WHERE and HAVING clauses.
  */
@@ -11,7 +6,7 @@ export default class ConditionBuilder {
     private ctx;
     private parts;
     constructor(ctx: ParamContext);
-    where(obj: Record<string, ConditionValue>): this;
+    where(obj: Record<string, any> | ((qb: ConditionBuilder) => void)): this;
     private handleOperator;
     private add;
     raw(expression: string): this;
@@ -20,4 +15,3 @@ export default class ConditionBuilder {
     clone(): ConditionBuilder;
     build(prefix?: string): string;
 }
-export {};

package/dist/cjs/query/ConditionBuilder.js

@@ -13,6 +13,15 @@ class ConditionBuilder {
         this.parts = [];
     }
     where(obj) {
+        if (typeof obj === 'function') {
+            const nested = new ConditionBuilder(this.ctx);
+            obj(nested);
+            const built = nested.build();
+            if (built) {
+                this.add(`(${built.replace(/^WHERE\s/, '')})`);
+            }
+            return this;
+        }
         Object.entries(obj).forEach(([key, condition]) => {
             if (condition === null) {
                 this.add(`${key} IS NULL`);

package/dist/esm/query/ConditionBuilder.d.ts

@@ -1,9 +1,4 @@
 import ParamContext from '../core/ParamContext';
-type Operator = '=' | '>' | '<' | '>=' | '<=' | '!=' | '<>' | 'LIKE' | 'ILIKE' | 'IN' | 'NOT IN' | 'BETWEEN' | 'EXISTS';
-type ConditionValue = any | {
-    op: Operator;
-    value: any;
-};
 /**
  * A builder for constructing SQL WHERE and HAVING clauses.
  */
@@ -11,7 +6,7 @@ export default class ConditionBuilder {
     private ctx;
     private parts;
     constructor(ctx: ParamContext);
-    where(obj: Record<string, ConditionValue>): this;
+    where(obj: Record<string, any> | ((qb: ConditionBuilder) => void)): this;
     private handleOperator;
     private add;
     raw(expression: string): this;
@@ -20,4 +15,3 @@ export default class ConditionBuilder {
     clone(): ConditionBuilder;
     build(prefix?: string): string;
 }
-export {};

package/dist/esm/query/ConditionBuilder.js

@@ -8,6 +8,15 @@ export default class ConditionBuilder {
         this.parts = [];
     }
     where(obj) {
+        if (typeof obj === 'function') {
+            const nested = new ConditionBuilder(this.ctx);
+            obj(nested);
+            const built = nested.build();
+            if (built) {
+                this.add(`(${built.replace(/^WHERE\s/, '')})`);
+            }
+            return this;
+        }
         Object.entries(obj).forEach(([key, condition]) => {
             if (condition === null) {
                 this.add(`${key} IS NULL`);

package/package.json

@@ -1,9 +1,14 @@
 {
   "name": "pg-query-sdk",
-  "version": "1.0.3",
-  "description": "PostgreSQL SDK with Query Builder and Executor",
+  "version": "1.2.0",
+  "description": "PostgreSQL SDK with Query Builder, Query Executor and Transaction Manager",
+  "type": "commonjs",
   "main": "dist/cjs/index.js",
   "types": "dist/esm/index.d.ts",
+  "sideEffects": false,
+  "engines": {
+    "node": ">=18"
+  },
   "exports": {
     ".": {
       "require": "./dist/cjs/index.js",
@@ -15,11 +20,29 @@
     "build:cjs": "tsc -p tsconfig.cjs.json",
     "build:esm": "tsc -p tsconfig.esm.json",
     "build": "npm run build:cjs && npm run build:esm",
+    "lint": "echo \"Add lint later\"",
+    "test": "echo \"Add tests\"",
     "prepublishOnly": "npm run build"
   },
   "files": [
     "dist"
   ],
+  "keywords": [
+    "postgresql",
+    "postgres",
+    "typescript",
+    "nodejs",
+    "database",
+    "sql",
+    "query-builder",
+    "sdk",
+    "orm",
+    "transaction",
+    "cte",
+    "repository-pattern",
+    "query-engine",
+    "prepared-statement"
+  ],
   "author": {
     "name": "Guilherme",
     "email": "sguii5147@gmail.com",
@@ -27,19 +50,21 @@
   },
   "repository": {
     "type": "git",
-    "url": "https://github.com/guio11221/pg-query-sdk.git"
+    "url": "git+https://github.com/guio11221/pg-query-sdk.git"
   },
   "bugs": {
     "url": "https://github.com/guio11221/pg-query-sdk/issues"
   },
   "homepage": "https://github.com/guio11221/pg-query-sdk#readme",
   "license": "MIT",
-  "dependencies": {
-    "pg": "^8.18.0"
+  "dependencies": {},
+  "peerDependencies": {
+    "pg": "^8.0.0"
   },
   "devDependencies": {
     "typescript": "^5.3.3",
     "@types/node": "^20.10.5",
-    "@types/pg": "^8.16.0"
+    "@types/pg": "^8.16.0",
+    "pg": "^8.18.0"
   }
-}
+}