@m2k-5f/pgtx 1.0.0 → 1.0.2

package/README.md

@@ -16,10 +16,22 @@ Experience ORM-like convenience (auto-inserts, updates, recursive fragments) wit
 
 ---
 
+## 📦 Installation
+
+```bash
+npm install @m2k-5f/pgtx
+# or
+yarn add @m2k-5f/pgtx
+# or
+pnpm add @m2k-5f/pgtx
+```
+
+---
+
 ## 🚀 Quick Start
 
 ```typescript
-import { sql, Pool } from 'pgtx';
+import { sql, Pool } from "@m2k-5f/pgtx";
 
 const pool = new Pool({ /* pg.PoolConfig */ })
 

package/dist/index.d.ts

@@ -1,92 +1,2 @@
-import { arrayClause } from "./clauses/array.clause";
-import { fragmentClause } from "./clauses/fragment.clause";
-import { identClause } from "./clauses/iden.caluse";
-import { Pool as PgtxPool } from "./pool";
-import { staticClause } from "./clauses/static.clause";
-import { updateClause } from "./clauses/update.clause";
-import { valueClause } from "./clauses/values.clause";
-/**
- * Core SQL tagging utility for Pgtx.
- * Provides type-safe helpers for building dynamic queries with recursive support.
- */
-export declare const sql: {
-    /**
-     * Creates a VALUES clause for INSERT queries.
-     * Supports single objects and arrays of objects.
-     *
-     * @example
-     * sql.insert({ name: 'Ivan', age: 25 })
-     * // Result: (name, age) VALUES ($1, $2)
-     *
-     * @example
-     * sql.insert([{ id: 1 }, { id: 2 }])
-     * // Result: (id) VALUES ($1), ($2)
-     */
-    insert: typeof valueClause;
-    /**
-     * Generates a SET clause for UPDATE queries from a JavaScript object.
-     *
-     * @example
-     * sql.update({ status: 'active', updated_at: new Date() })
-     * // Result: status = $1, updated_at = $2
-     */
-    update: typeof updateClause;
-    /**
-     * Safely escapes SQL identifiers (table or column names) using double quotes.
-     *
-     * @example
-     * sql.ident('users')
-     * // Result: "users"
-     *
-     * @example
-     * sql.ident('table.column')
-     * // Result: "table.column"
-     */
-    ident: typeof identClause;
-    /**
-     * Injects raw, unescaped SQL strings.
-     * ⚠️ Use with caution to prevent SQL injection!
-     *
-     * @example
-     * sql.literal('DESC')
-     * // Result: DESC
-     */
-    literal: typeof staticClause;
-    /**
-     * Creates a reusable, recursive SQL fragment.
-     * Fragments can be nested within each other; argument numbering is handled automatically.
-     *
-     * @example
-     * const filter = sql.fragment`age > ${18}`;
-     * sql`SELECT * FROM users WHERE ${filter} AND status = ${'active'}`
-     * // Result: SELECT * FROM users WHERE age > $1 AND status = $2
-     */
-    fragment: typeof fragmentClause;
-    /**
-     * Formats an array for dynamic lists (IN clauses, column lists, or joined conditions).
-     * Supports recursive Clauses (fragments, idents) within the array.
-     *
-     * @example
-     * // Case A: IN clause (manual brackets)
-     * sql`WHERE id IN (${sql.array([1, 2])})`
-     * // Result: WHERE id IN ($1, $2)
-     *
-     * @example
-     * // Case B: Dynamic WHERE conditions
-     * const conds = [sql.fragment`a = 1`, sql.fragment`b = ${2}`];
-     * sql`WHERE ${sql.array(conds, ' AND ')}`
-     * // Result: WHERE a = 1 AND b = $1
-     *
-     * @example
-     * // Case C: Column list
-     * sql`SELECT ${sql.array([sql.ident('id'), sql.ident('name')])}`
-     * // Result: SELECT "id", "name"
-     */
-    array: typeof arrayClause;
-};
-/**
- * Main Pgtx Connection Pool.
- * Manages connections, transactions (including SAVEPOINTs), and prepared statements.
- */
-export declare const Pool: typeof PgtxPool;
+export {};
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AACrD,OAAO,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAC;AAC3D,OAAO,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAC;AACpD,OAAO,EAAE,IAAI,IAAI,QAAQ,EAAE,MAAM,QAAQ,CAAC;AAC1C,OAAO,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AACvD,OAAO,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AACvD,OAAO,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAC;AAEtD;;;GAGG;AACH,eAAO,MAAM,GAAG;IACZ;;;;;;;;;;;OAWG;;IAGH;;;;;;OAMG;;IAGH;;;;;;;;;;OAUG;;IAGH;;;;;;;OAOG;;IAGH;;;;;;;;OAQG;;IAGH;;;;;;;;;;;;;;;;;;;OAmBG;;CAEN,CAAA;AAED;;;GAGG;AACH,eAAO,MAAM,IAAI,iBAAW,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":""}

package/dist/index.js

@@ -1,6 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Pool = exports.sql = void 0;
 const array_clause_1 = require("./clauses/array.clause");
 const fragment_clause_1 = require("./clauses/fragment.clause");
 const iden_caluse_1 = require("./clauses/iden.caluse");
@@ -12,7 +11,7 @@ const values_clause_1 = require("./clauses/values.clause");
  * Core SQL tagging utility for Pgtx.
  * Provides type-safe helpers for building dynamic queries with recursive support.
  */
-exports.sql = {
+const sql = {
     /**
      * Creates a VALUES clause for INSERT queries.
      * Supports single objects and arrays of objects.
@@ -91,4 +90,5 @@ exports.sql = {
  * Main Pgtx Connection Pool.
  * Manages connections, transactions (including SAVEPOINTs), and prepared statements.
  */
-exports.Pool = pool_1.Pool;
+const Pool = pool_1.Pool;
+module.exports = [Pool, sql];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@m2k-5f/pgtx", 
-  "version": "1.0.0",
+  "version": "1.0.2",
   "description": "Lightweight, high-performance SQL toolkit for node-postgres",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",