@dwtechs/antity-pgsql 0.17.4 → 0.17.6

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-87%25-brightgreen.svg)
+![Jest:coverage](https://img.shields.io/badge/Jest:coverage-89%25-brightgreen.svg)
 
 - [Synopsis](#synopsis)
 - [Support](#support)
@@ -152,7 +152,7 @@ type Row = Record<string, string | number | boolean | Date | number[]>;
 
 type Comparator =
   "=" | "<" | ">" | "<=" | ">=" | "<>" |
-  "IS" | "IS NOT" | "IN" | "NOT IN" | "LIKE" | "NOT LIKE";
+  "IS" | "IS NOT" | "IN" | "NOT IN" | "LIKE" | "NOT LIKE" | "&&";
 
 type MatchMode =  
   "startsWith" | 
@@ -164,6 +164,7 @@ type MatchMode =
   "between" |
   "in" |
   "notIn" |
+  "&&" | // array overlap — use with array-typed columns; generates: column && ARRAY[$1,$2]
   "lt" |
   "lte" |
   "gt" |
@@ -333,7 +334,7 @@ Using substacks simplifies your route definitions and ensures consistent data pr
 
 ### Query Methods
 
-- **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.
+- **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. The `sortField` parameter is validated against the entity's known properties; an unrecognised value is silently dropped.
 - **query.insert()**: Generates an INSERT query. Accepts an array of `Row` objects with properties matching the entity definition. Consumer fields are appended directly to the query arguments — row objects are **not mutated**. Optionally appends `consumer.id` as `creatorId` and `consumer.nickname` as `creatorName` for audit tracking. Supports `RETURNING` clause via the `rtn` parameter.
 - **query.update()**: Generates an UPDATE query using CASE statements. Accepts an array of `Row` objects with `id` property. Optionally appends `consumer.id` as `updaterId` and `consumer.nickname` as `updaterName` for audit tracking.
 - **query.upsert()**: Generates an INSERT ... ON CONFLICT ... DO UPDATE query. (See [Upsert](#upsert-insert-or-update) section below.) Accepts an array of `Row` objects and a `conflictTarget` (single column name or array of column names) that defines uniqueness. If a conflict occurs on the specified column(s), the row is updated; otherwise, it is inserted. Properties are automatically included if they have both INSERT and UPDATE operations. Consumer fields are appended directly to the query arguments — row objects are **not mutated**. Optionally appends `consumer.id` as `creatorId` and `consumer.nickname` as `creatorName` for audit tracking. Supports `RETURNING` clause via the `rtn` parameter.

package/dist/antity-pgsql.d.ts

@@ -60,9 +60,9 @@ export declare class Property extends BaseProperty {
 }
 
 export type LogicalOperator = "AND" | "OR";
-export type Comparator = "=" | "<" | ">" | "<=" | ">=" | "<>" | "IS" | "IS NOT" | "IN" | "NOT IN" | "LIKE" | "NOT LIKE";
-export type MatchMode = "startsWith" | "endsWith" | "contains" | "notContains" | "equals" | "notEquals" | "between" | "in" | "notIn" | "lt" | "lte" | "gt" | "gte" | "is" | "isNot" | "before" | "after" | "st_contains" | "st_dwithin" | Comparator;
-export type MappedType = "string" | "number" | "date";
+export type Comparator = "=" | "<" | ">" | "<=" | ">=" | "<>" | "IS" | "IS NOT" | "IN" | "NOT IN" | "LIKE" | "NOT LIKE" | "&&";
+export type MatchMode = "startsWith" | "endsWith" | "contains" | "notContains" | "equals" | "notEquals" | "between" | "in" | "notIn" | "&&" | "lt" | "lte" | "gt" | "gte" | "is" | "isNot" | "before" | "after" | "st_contains" | "st_dwithin" | Comparator;
+export type MappedType = "string" | "number" | "date" | "array";
 export type Geometry = {
   lng: number;
   lat: number;

package/dist/antity-pgsql.js

@@ -100,7 +100,7 @@ const reserved = new Set([
 ]);
 function quoteIfUppercase(word) {
     if (/[A-Z]/.test(word) || reserved.has(word.toLowerCase()))
-        return `"${word}"`;
+        return `"${word.replace(/"/g, '""')}"`;
     return word;
 }
 
@@ -112,12 +112,14 @@ function index(index, matchMode) {
         case "IN":
         case "NOT IN":
             return `(${i})`;
+        case "&&":
+            return `ARRAY[${i}]`;
         default:
             return `${i}`;
     }
 }
 
-const COMPARATORS = new Set(["=", "<", ">", "<=", ">=", "<>", "IS", "IS NOT", "IN", "NOT IN", "LIKE", "NOT LIKE"]);
+const COMPARATORS = new Set(["=", "<", ">", "<=", ">=", "<>", "IS", "IS NOT", "IN", "NOT IN", "LIKE", "NOT LIKE", "&&"]);
 function comparator(matchMode) {
     if (matchMode && COMPARATORS.has(matchMode))
         return matchMode;
@@ -154,6 +156,8 @@ function comparator(matchMode) {
             return "<";
         case "after":
             return ">";
+        case "&&":
+            return "&&";
         default:
             return null;
     }
@@ -307,11 +311,11 @@ class Insert {
             nbProps += 2;
             cols += `, "creatorId", "creatorName"`;
         }
-        let query = `INSERT INTO ${quoteIfUppercase(schema)}.${quoteIfUppercase(table)} (${cols}) VALUES `;
         const args = [];
+        const valueParts = [];
         let i = 0;
         for (const row of rows) {
-            query += `${$i(nbProps, i)}, `;
+            valueParts.push($i(nbProps, i));
             for (const prop of propsToUse) {
                 if (prop === "consumerId")
                     args.push(consumerId);
@@ -322,7 +326,7 @@ class Insert {
             }
             i += nbProps;
         }
-        query = query.slice(0, -2);
+        let query = `INSERT INTO ${quoteIfUppercase(schema)}.${quoteIfUppercase(table)} (${cols}) VALUES ${valueParts.join(", ")}`;
         if (rtn)
             query += ` ${rtn}`;
         return { query, args };
@@ -348,8 +352,8 @@ class Update {
         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(schema)}.${quoteIfUppercase(table)} SET `;
         let i = args.length + 1;
+        const setClauses = [];
         for (const p of propsToUse) {
             const isConsumerId = p === "consumerId";
             const isConsumerName = p === "consumerName";
@@ -357,9 +361,9 @@ class Update {
             if (!isConsumerProp && rows[0][p] === undefined)
                 continue;
             const colName = isConsumerId ? '"updaterId"' : isConsumerName ? '"updaterName"' : quoteIfUppercase(p);
-            query += `${colName} = CASE `;
+            const whenParts = [];
             for (let j = 0; j < l; j++) {
-                query += `WHEN id = $${j + 1} THEN $${i++} `;
+                whenParts.push(`WHEN id = $${j + 1} THEN $${i++}`);
                 if (isConsumerId)
                     args.push(consumerId);
                 else if (isConsumerName)
@@ -367,9 +371,9 @@ class Update {
                 else
                     args.push(rows[j][p]);
             }
-            query += `ELSE ${colName} END, `;
+            setClauses.push(`${colName} = CASE ${whenParts.join(" ")} ELSE ${colName} END`);
         }
-        query = `${query.slice(0, -2)} WHERE id IN ${$i(l, 0)}`;
+        const query = `UPDATE ${quoteIfUppercase(schema)}.${quoteIfUppercase(table)} SET ${setClauses.join(", ")} WHERE id IN ${$i(l, 0)}`;
         return { query, args };
     }
     async execute(query, args, client) {
@@ -421,16 +425,13 @@ class Upsert {
             i += nbProps;
         }
         query = query.slice(0, -2);
-        query += ` ON CONFLICT (${conflictColumns}) DO UPDATE SET `;
         const conflictTargetArray = Array.isArray(conflictTarget) ? conflictTarget : [conflictTarget];
         const updateCols = quotedPropsToUse.filter((_, idx) => {
             const propName = propsToUse[idx];
             return !conflictTargetArray.includes(propName);
         });
-        for (const col of updateCols) {
-            query += `${col} = EXCLUDED.${col}, `;
-        }
-        query = query.slice(0, -2);
+        const updateSetClause = updateCols.map(col => `${col} = EXCLUDED.${col}`).join(", ");
+        query += ` ON CONFLICT (${conflictColumns}) DO UPDATE SET ${updateSetClause}`;
         if (rtn)
             query += ` ${rtn}`;
         return { query, args };
@@ -471,14 +472,7 @@ function queryByDate() {
     return `SELECT hard_delete($1, $2, $3)`;
 }
 async function executeArchived(schema, table, date, query, client) {
-    let db;
-    try {
-        db = await execute(query, [schema, table, date], client);
-    }
-    catch (err) {
-        throw err;
-    }
-    return db;
+    return execute(query, [schema, table, date], client);
 }
 
 function type(type) {
@@ -534,6 +528,8 @@ function type(type) {
             return s;
         case "object":
             return s;
+        case "array":
+            return "array";
         default:
             return s;
     }
@@ -543,6 +539,7 @@ const matchModes = {
     string: new Set(["startsWith", "contains", "endsWith", "notContains", "equals", "notEquals", "lt", "lte", "gt", "gte", "in", "notIn"]),
     number: new Set(["equals", "notEquals", "lt", "lte", "gt", "gte", "in", "notIn"]),
     date: new Set(["is", "isNot", "dateAfter"]),
+    array: new Set(["&&"]),
 };
 function matchMode(type, matchMode) {
     return COMPARATORS.has(matchMode) || matchModes[type].has(matchMode);
@@ -565,6 +562,12 @@ function cleanFilters(filters, properties) {
             const type$1 = type(prop.type);
             const filterValue = filters[k];
             const filterArray = isArray(filterValue) ? filterValue : [filterValue];
+            if (type$1 === "array") {
+                for (const f of filterArray) {
+                    if (f.matchMode === "in")
+                        f.matchMode = "&&";
+                }
+            }
             const validFilters = filterArray.filter((f) => {
                 const { matchMode: matchMode$1 } = f;
                 if (!matchMode$1 || !matchMode(type$1, matchMode$1)) {
@@ -706,7 +709,8 @@ class SQLEntity extends Entity {
     }
     query = {
         select: (first = 0, rows = null, sortField = null, sortOrder = null, filters = null) => {
-            return this.sel.query(this.schema, this.table, first, rows, sortField, sortOrder, filters);
+            const validatedSortField = sortField && this.properties.some(p => p.key === sortField) ? sortField : null;
+            return this.sel.query(this.schema, this.table, first, rows, validatedSortField, sortOrder, filters);
         },
         update: (rows, consumer) => {
             return this.upd.query(this.schema, this.table, rows, consumer?.id, consumer?.nickname);
@@ -735,7 +739,8 @@ class SQLEntity extends Entity {
         const b = req.body;
         const first = b?.first ?? 0;
         const rows = b.rows || null;
-        const sortField = b.sortField || null;
+        const rawSortField = b.sortField || null;
+        const sortField = rawSortField && this.properties.some(p => p.key === rawSortField) ? rawSortField : null;
         const sortOrder = b.sortOrder === -1 || b.sortOrder === "DESC" ? "DESC" : "ASC";
         const filters = cleanFilters(b.filters, this.properties) || null;
         const pagination = b.pagination || false;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dwtechs/antity-pgsql",
-  "version": "0.17.4",
+  "version": "0.17.6",
   "description": "Open source library to add PostgreSQL support to @dwtechs/Antity entities.",
   "keywords": [
     "entities"
@@ -36,7 +36,7 @@
   "dependencies": {
     "@dwtechs/checkard": "3.6.0",
     "@dwtechs/winstan": "0.7.0",
-    "@dwtechs/antity": "0.17.0",
+    "@dwtechs/antity": "0.18.0",
     "@dwtechs/sparray": "0.2.1",
     "pg": "8.20.0"
   },