@dwtechs/antity-pgsql 0.6.1 → 0.8.0

package/README.md

@@ -2,7 +2,7 @@
 [![License: MIT](https://img.shields.io/npm/l/@dwtechs/antity-pgsql.svg?color=brightgreen)](https://opensource.org/licenses/MIT)
 [![npm version](https://badge.fury.io/js/%40dwtechs%2Fantity-pgsql.svg)](https://www.npmjs.com/package/@dwtechs/antity-pgsql)
 [![last version release date](https://img.shields.io/github/release-date/DWTechs/Antity-pgsql.js)](https://www.npmjs.com/package/@dwtechs/antity-pgsql)
-![Jest:coverage](https://img.shields.io/badge/Jest:coverage-100%25-brightgreen.svg)
+![Jest:coverage](https://img.shields.io/badge/Jest:coverage-54%25-brightgreen.svg)
 
 - [Synopsis](#synopsis)
 - [Support](#support)
@@ -123,7 +123,9 @@ const entity = new Entity("consumers", [
 router.get("/", ..., entity.get);
 router.post("/", entity.normalizeArray, entity.validateArray, ..., entity.add);
 router.put("/", entity.normalizeArray, entity.validateArray, ..., entity.update);
-router.put("/", ..., entity.archive);
+router.put("/archive", ..., entity.archive);
+router.delete("/", ..., entity.delete);
+router.delete("/archived", ..., entity.deleteArchive);
 
 ```
 
@@ -172,7 +174,6 @@ class SQLEntity {
 
   query: {
     select: (
-      paginate: boolean,
       first?: number,
       rows?: number | null,
       sortField?: string | null,
@@ -181,29 +182,34 @@ class SQLEntity {
         query: string;
         args: (Filter["value"])[];
       };
-      update: (
-        rows: Record<string, unknown>[],
-        consumerId?: number | string,
-        consumerName?: string) => {
-          query: string;
+    update: (
+      rows: Record<string, unknown>[],
+      consumerId?: number | string,
+      consumerName?: string) => {
+        query: string;
+        args: unknown[];
+    };
+    insert: (
+      rows: Record<string, unknown>[],
+      consumerId?: number | string,
+      consumerName?: string,
+      rtn?: string) => {
+        query: string;
           args: unknown[];
       };
-      insert: (
-        rows: Record<string, unknown>[],
-        consumerId?: number | string,
-        consumerName?: string,
-        rtn?: string) => {
-          query: string;
-            args: unknown[];
-        };
-        delete: () => string;
-        return: (prop: string) => string;
+    delete: (ids: number[]) => {
+      query: string;
+      args: number[];
+    };
+    deleteArchive: () => string;
+    return: (prop: string) => string;
   };
   get: (req: Request, res: Response, next: NextFunction) => void;
   add: (req: Request, res: Response, next: NextFunction) => Promise<void>;
   update: (req: Request, res: Response, next: NextFunction) => Promise<void>;
   archive: (req: Request, res: Response, next: NextFunction) => Promise<void>;
-  delete: (req: Request, res: Response, next: NextFunction) => void;
+  delete: (req: Request, res: Response, next: NextFunction) => Promise<void>;
+  deleteArchive: (req: Request, res: Response, next: NextFunction) => void;
 
 }
 
@@ -223,9 +229,13 @@ function execute(
 
 
 ```
-get(), add(), update(), archive() and delete() methods are made to be used as Express.js middlewares.
+get(), add(), update(), archive(), delete() and deleteArchive() methods are made to be used as Express.js middlewares.
 Each method will look for data to work on in the **req.body.rows** parameter.
 
+- **query.select()**: Generates a SELECT query. When the `rows` parameter is provided (not null), pagination is automatically enabled and the query includes `COUNT(*) OVER () AS total` to return the total number of rows. The total count is extracted from results and returned separately from the row data.
+- **delete()**: Deletes rows by their IDs. Expects `req.body.rows` to be an array of objects with `id` property: `[{id: 1}, {id: 2}]`
+- **deleteArchive()**: Deletes archived rows that were archived before a specific date. Expects `req.body.date` to be a Date object.
+
 
 ## Match modes
 

package/dist/antity-pgsql.d.ts

@@ -78,7 +78,6 @@ declare class SQLEntity extends Entity {
   set table(table: string);
   query: {
     select: (
-      paginate: boolean,
       first?: number,
       rows?: number | null,
       sortField?: string | null,
@@ -96,14 +95,19 @@ declare class SQLEntity extends Entity {
         query: string;
         args: unknown[];
     };
-    delete: () => string;
+    delete: (ids: number[]) => {
+      query: string;
+      args: number[];
+    };
+    deleteArchive: () => string;
     return: (prop: string) => string;
   };
   get: (req: Request, res: Response, next: NextFunction) => void;
   add: (req: Request, res: Response, next: NextFunction) => Promise<void>;
   update: (req: Request, res: Response, next: NextFunction) => Promise<void>;
   archive: (req: Request, res: Response, next: NextFunction) => Promise<void>;
-  delete: (req: Request, res: Response, next: NextFunction) => void;
+  delete: (req: Request, res: Response, next: NextFunction) => Promise<void>;
+  deleteArchive: (req: Request, res: Response, next: NextFunction) => void;
 }
 
 declare function filter(

package/dist/antity-pgsql.js

@@ -58,7 +58,7 @@ var perf = {
     end,
 };
 
-function execute$1(query, args, clt) {
+function execute(query, args, clt) {
     const time = perf.start(query, args);
     const client = clt || pool;
     return client
@@ -222,8 +222,8 @@ class Select {
     get props() {
         return this._cols;
     }
-    query(table, paginate, first = 0, rows = null, sortField = null, sortOrder = null, filters = null) {
-        const p = paginate ? this._count : '';
+    query(table, first = 0, rows = null, sortField = null, sortOrder = null, filters = null) {
+        const p = rows ? this._count : '';
         const c = this._cols ? this._cols : '*';
         const baseQuery = `SELECT ${c}${p} FROM ${quoteIfUppercase(table)}`;
         const { filterClause, args } = filter(first, rows, sortField, sortOrder, filters);
@@ -233,7 +233,7 @@ class Select {
         };
     }
     execute(query, args, client) {
-        return execute$1(query, args, client)
+        return execute(query, args, client)
             .then((r) => {
             if (!r.rowCount)
                 throw { status: 404, msg: "Resource not found" };
@@ -293,10 +293,10 @@ class Insert {
         return { query, args };
     }
     rtn(prop) {
-        return `RETURNING "${prop}"`;
+        return `RETURNING ${quoteIfUppercase(prop)}`;
     }
     execute(query, args, client) {
-        return execute$1(query, args, client);
+        return execute(query, args, client);
     }
 }
 
@@ -322,6 +322,7 @@ class Update {
         const propsToUse = [...this._props];
         if (consumerId !== undefined && consumerName !== undefined)
             propsToUse.push("consumerId", "consumerName");
+        log.debug(`${LOGS_PREFIX}Update query input rows: ${JSON.stringify(rows, null, 2)}`);
         const l = rows.length;
         const args = rows.map(row => row.id);
         let query = `UPDATE "${quoteIfUppercase(table)}" SET `;
@@ -342,7 +343,7 @@ class Update {
     }
     execute(query, args, client) {
         return __awaiter$2(this, void 0, void 0, function* () {
-            return execute$1(query, args, client);
+            return execute(query, args, client);
         });
     }
     addConsumer(rows, consumerId, consumerName) {
@@ -360,14 +361,20 @@ var __awaiter$1 = (undefined && undefined.__awaiter) || function (thisArg, _argu
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
-function query(table) {
+function queryById(table, ids) {
+    return {
+        query: `DELETE FROM ${quoteIfUppercase(table)} WHERE id = ANY($1)`,
+        args: [ids]
+    };
+}
+function queryArchived(table) {
     return `DELETE FROM ${quoteIfUppercase(table)} WHERE "archivedAt" < $1`;
 }
-function execute(date, query, client) {
+function executeArchived(date, query, client) {
     return __awaiter$1(this, void 0, void 0, function* () {
         let db;
         try {
-            db = yield execute$1(query, [date], client);
+            db = yield execute(query, [date], client);
         }
         catch (err) {
             throw err;
@@ -551,8 +558,8 @@ class SQLEntity extends Entity {
         this.ins = new Insert();
         this.upd = new Update();
         this.query = {
-            select: (paginate, first = 0, rows = null, sortField = null, sortOrder = null, filters = null) => {
-                return this.sel.query(this.table, paginate, first, rows, sortField, sortOrder, filters);
+            select: (first = 0, rows = null, sortField = null, sortOrder = null, filters = null) => {
+                return this.sel.query(this.table, first, rows, sortField, sortOrder, filters);
             },
             update: (rows, consumerId, consumerName) => {
                 return this.upd.query(this.table, rows, consumerId, consumerName);
@@ -560,8 +567,11 @@ class SQLEntity extends Entity {
             insert: (rows, consumerId, consumerName, rtn = "") => {
                 return this.ins.query(this.table, rows, consumerId, consumerName, rtn);
             },
-            delete: () => {
-                return query(this.table);
+            delete: (ids) => {
+                return queryById(this.table, ids);
+            },
+            deleteArchive: () => {
+                return queryArchived(this.table);
             },
             return: (prop) => {
                 return this.ins.rtn(prop);
@@ -581,7 +591,7 @@ class SQLEntity extends Entity {
             log.debug(`get(first='${first}', rows='${rows}', 
       sortOrder='${sortOrder}', sortField='${sortField}', 
       pagination=${pagination}, filters=${JSON.stringify(filters)}`);
-            const { query, args } = this.sel.query(this._table, pagination, first, rows, sortField, sortOrder, filters);
+            const { query, args } = this.sel.query(this._table, first, rows, sortField, sortOrder, filters);
             this.sel.execute(query, args, dbClient)
                 .then((r) => {
                 l.rows = r.rows;
@@ -603,7 +613,7 @@ class SQLEntity extends Entity {
                 const { query, args } = this.ins.query(this._table, c, cId, cName, rtn);
                 let db;
                 try {
-                    db = yield execute$1(query, args, dbClient);
+                    db = yield execute(query, args, dbClient);
                 }
                 catch (err) {
                     return next(err);
@@ -627,7 +637,7 @@ class SQLEntity extends Entity {
             for (const c of chunks) {
                 const { query, args } = this.upd.query(this._table, c, cId, cName);
                 try {
-                    yield execute$1(query, args, dbClient);
+                    yield execute(query, args, dbClient);
                 }
                 catch (err) {
                     return next(err);
@@ -647,7 +657,7 @@ class SQLEntity extends Entity {
             for (const c of chunks) {
                 const { query, args } = this.upd.query(this._table, c, cId, cName);
                 try {
-                    yield execute$1(query, args, dbClient);
+                    yield execute(query, args, dbClient);
                 }
                 catch (err) {
                     return next(err);
@@ -655,12 +665,26 @@ class SQLEntity extends Entity {
             }
             next();
         });
-        this.delete = (req, res, next) => {
+        this.delete = (req, res, next) => __awaiter(this, void 0, void 0, function* () {
+            const rows = req.body.rows;
+            const dbClient = res.locals.dbClient || null;
+            const ids = rows.map((row) => row.id);
+            log.debug(`${LOGS_PREFIX}delete ${rows.length} rows : (${ids.join(", ")})`);
+            const { query, args } = queryById(this._table, ids);
+            try {
+                yield execute(query, args, dbClient);
+            }
+            catch (err) {
+                return next(err);
+            }
+            next();
+        });
+        this.deleteArchive = (req, res, next) => {
             const date = req.body.date;
             const dbClient = res.locals.dbClient || null;
-            log.debug(`${LOGS_PREFIX}delete archived`);
-            const q = query(this._table);
-            execute(date, q, dbClient)
+            log.debug(`${LOGS_PREFIX}deleteArchive(date=${date})`);
+            const q = queryArchived(this._table);
+            executeArchived(date, q, dbClient)
                 .then(() => next())
                 .catch((err) => next(err));
         };
@@ -696,4 +720,4 @@ class SQLEntity extends Entity {
     }
 }
 
-export { SQLEntity, execute$1 as execute, filter };
+export { SQLEntity, execute, filter };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dwtechs/antity-pgsql",
-  "version": "0.6.1",
+  "version": "0.8.0",
   "description": "Open source library to add PostgreSQL support to @dwtechs/Antity entities.",
   "keywords": [
     "entities"