prostgles-server 4.2.614 → 4.2.616

package/lib/TableHooks/TableHooks.ts

@@ -7,6 +7,7 @@ import type {
   AfterAllTsTrigger,
   AfterEachTsTrigger,
   BeforeEachTsTrigger,
+  TransactionCallbacks,
 } from "../PublishParser/PublishParser";
 
 export type TableHooks<S = void, Context = undefined> =
@@ -26,9 +27,15 @@ export type TableHooksDefinition<
   Context = undefined,
 > = {
   /**
-   * Runs sequentially before validation and SQL for each insert row, or once per update request.
+   * Runs sequentially before data validation and mutation SQL for each insert row,
+   * or once per update request, including requests with no matching rows.
+   * The update filter includes the publish forcedFilter.
+   * Also runs when generating SQL statements (including updateBatch).
+   * File inserts/updates reject SQL-only requests; file updates lock matching rows before hooks.
    * May replace the pending data and pass `hookContext` to the next hook.
-   * `onInserted` also runs for updates, is not awaited, and runs before the transaction commits.
+   * Register `onCommit`/`onRollback` before starting external work so cleanup also runs if the
+   * hook throws. These callbacks are awaited after the outer transaction finishes and receive
+   * the non-transactional `db` and `dbo` objects.
    */
   beforeEach?: BeforeEachTsTrigger<RowDataType, DBX, Context>[];
 
@@ -52,17 +59,20 @@ export type TableHooksDefinition<
   /**
    * Replaces the generated DELETE. Must perform the mutation and shape its return value using
    * the prepared filter and returning arguments. Delete `afterEach`/`afterAll` hooks do not run.
+   * Use `onCommit`/`onRollback` for external side effects after the outer transaction finishes.
    */
-  onInsteadOfDelete?: (args: {
-    context: Context;
-    dbx: DBX;
-    tx: pgPromise.ITask<{}>;
-    returningQuery: string;
-    isOneOrNone: boolean;
-    queryType: "any" | "none";
-    filterOpts: {
-      where: string;
-      filter: AnyObject;
-    };
-  }) => Promise<AnyObject[] | undefined>;
+  onInsteadOfDelete?: (
+    args: {
+      context: Context;
+      dbx: DBX;
+      tx: pgPromise.ITask<{}>;
+      returningQuery: string;
+      isOneOrNone: boolean;
+      queryType: "any" | "none";
+      filterOpts: {
+        where: string;
+        filter: AnyObject;
+      };
+    } & TransactionCallbacks<DBX>,
+  ) => Promise<AnyObject[] | undefined>;
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "prostgles-server",
-  "version": "4.2.614",
+  "version": "4.2.616",
   "description": "",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -57,7 +57,7 @@
     "pg": "^8.23.0",
     "pg-cursor": "^2.22.0",
     "pg-promise": "^12.7.1",
-    "prostgles-types": "^4.0.280"
+    "prostgles-types": "^4.0.281"
   },
   "devDependencies": {
     "@eslint/js": "^9.22.0",