@dwtechs/antity-pgsql 0.17.1 → 0.17.2

package/README.md

@@ -123,6 +123,24 @@ router.get("/:id/history", ..., entity.getHistory);
 
 ```
 
+### Expected table structure
+
+```sql
+CREATE TABLE IF NOT EXISTS "service" (
+  id SERIAL PRIMARY KEY,
+  name varchar(20) NOT NULL,
+  pattern TEXT,
+  archived BOOLEAN DEFAULT FALSE,
+  "archivedAt" TIMESTAMP,
+  "creatorId" INT,
+  "creatorName" TEXT,
+  "updaterId" INT,
+  "updaterName" TEXT,
+  "createdAt" TIMESTAMP DEFAULT NOW(),
+  "updatedAt" TIMESTAMP NULL
+);
+```
+
 ## API Reference
 
 
@@ -311,10 +329,10 @@ 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.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 `name` 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 `name` 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 `name` for audit tracking. Supports `RETURNING` clause via the `rtn` parameter.
-- **query.archive()**: Generates a simplified `UPDATE ... SET archived = true WHERE id IN (...)` query. Accepts an array of `Row` objects with `id` property. Optionally appends `consumer.id` as `updaterId` and `consumer.nickname` as `name` for audit tracking. Does not require an `archived` field in the rows — it is set directly in the SQL.
+- **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.
+- **query.archive()**: Generates a simplified `UPDATE ... SET archived = true WHERE id IN (...)` query. Accepts an array of `Row` objects with `id` property. Optionally appends `consumer.id` as `updaterId` and `consumer.nickname` as `updaterName` for audit tracking. Does not require an `archived` field in the rows — it is set directly in the SQL.
 - **sync()**: Atomically synchronises the table with the provided rows inside a single PostgreSQL transaction. Missing rows are inserted, existing rows are updated, and rows absent from the list are deleted. Accepts optional `idField` (default `'id'`) and `filters` to restrict the scope of managed rows. Stores the result in `res.locals.rows` and a summary `{ inserted, updated, deleted }` in `res.locals.sync`.
 - **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 using a PostgreSQL SECURITY DEFINER function. Expects `req.body.date` to be a Date object.
@@ -376,7 +394,7 @@ res.locals.sync  // { inserted: 1, updated: 1, deleted: 1 }
 - **Atomic**: All insert / update / delete operations are wrapped in a single transaction.
 - **Filter scope**: When `filters` are provided, only rows matching the filter are considered "managed". Rows outside the filter are never touched.
 - **Property selection**: Insert uses `INSERT` properties; update uses `UPDATE` properties — same as the standalone `add` and `update` middlewares.
-- **Consumer tracking**: `consumer.id` and `consumer.nickname` from `res.locals.consumer` are forwarded to inserts as `creatorId`/`name` and to updates as `updaterId`/`name` for audit tracking.
+- **Consumer tracking**: `consumer.id` and `consumer.nickname` from `res.locals.consumer` are forwarded to inserts as `creatorId`/`creatorName` and to updates as `updaterId`/`updaterName` for audit tracking.
 
 ### Upsert (Insert or Update)
 

package/dist/antity-pgsql.js

@@ -305,7 +305,7 @@ class Insert {
         if (consumerId !== undefined && consumerName !== undefined) {
             propsToUse.push("consumerId", "consumerName");
             nbProps += 2;
-            cols += `, creatorId, name`;
+            cols += `, "creatorId", "creatorName"`;
         }
         let query = `INSERT INTO ${quoteIfUppercase(schema)}.${quoteIfUppercase(table)} (${cols}) VALUES `;
         const args = [];
@@ -365,7 +365,7 @@ class Update {
         for (const p of propsToUse) {
             if (rows[0][p] === undefined)
                 continue;
-            const colName = p === "consumerId" ? "updaterId" : p === "consumerName" ? "name" : quoteIfUppercase(p);
+            const colName = p === "consumerId" ? '"updaterId"' : p === "consumerName" ? '"updaterName"' : quoteIfUppercase(p);
             query += `${colName} = CASE `;
             for (let j = 0; j < l; j++) {
                 const row = rows[j];
@@ -413,9 +413,9 @@ class Upsert {
         let cols = this._cols;
         if (consumerId !== undefined && consumerName !== undefined) {
             propsToUse.push("consumerId", "consumerName");
-            quotedPropsToUse.push(`creatorId`, `name`);
+            quotedPropsToUse.push(`"creatorId"`, `"creatorName"`);
             nbProps += 2;
-            cols += `, creatorId, name`;
+            cols += `, "creatorId", "creatorName"`;
         }
         const conflictColumns = Array.isArray(conflictTarget)
             ? conflictTarget.map(col => quoteIfUppercase(col)).join(", ")
@@ -472,7 +472,7 @@ class Archive {
         const args = rows.map(row => row.id);
         let query = `UPDATE ${quoteIfUppercase(schema)}.${quoteIfUppercase(table)} SET archived = true`;
         if (consumerId !== undefined && consumerName !== undefined) {
-            query += `, updaterId = $${l + 1}, name = $${l + 2}`;
+            query += `, "updaterId" = $${l + 1}, "updaterName" = $${l + 2}`;
             args.push(consumerId, consumerName);
         }
         query += ` WHERE id IN ${$i(l, 0)}`;

package/package.json

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