prostgles-server 4.2.553 → 4.2.555

package/lib/DboBuilder/TableHandler/runInsertUpdateQuery.ts

@@ -5,7 +5,7 @@ import type { LocalParams } from "../DboBuilder";
 import { rejectWithPGClientError, withUserRLS } from "../DboBuilder";
 import type { TableHandler } from "./TableHandler";
 import { getSelectItemQuery } from "./TableHandler";
-import { executeHooksCheckAndPostValidation } from "./executeHooksCheckAndPostValidation";
+import { executeAfterHooksCheckAndPostValidation } from "./executeAfterHooksCheckAndPostValidation";
 
 type RunInsertUpdateQueryArgs = {
   tableHandler: TableHandler;
@@ -126,7 +126,7 @@ export const runInsertUpdateQuery = async (args: RunInsertUpdateQueryArgs) => {
 
   const rows = result.modified ?? [];
 
-  await executeHooksCheckAndPostValidation({
+  await executeAfterHooksCheckAndPostValidation({
     tableHandler,
     operation: command === "insert" ? { name: "insert", rule } : { name: "update", rule },
     localParams,

package/lib/DboBuilder/TableHandler/update.ts

@@ -33,7 +33,7 @@ export async function update(
         ),
       );
     const rule = tableRules?.[ACTION];
-    if (this.shouldWrapInTx({ name: ACTION, rule }, localParams).shouldWrap) {
+    if (this.shouldWrapInTx({ name: ACTION, rule }, localParams, [_newData]).shouldWrap) {
       return wrapInTx();
     }
 
@@ -76,6 +76,9 @@ export async function update(
         );
     }
 
+    const beforeResult = await this.beforeEach(newData, localParams, "update");
+    newData = beforeResult.row;
+
     const { data, allowedCols } = prepareNewData({
       row: newData,
       forcedData,
@@ -205,6 +208,7 @@ export async function update(
       data: { filter, _newData, params },
       duration: Date.now() - start,
     });
+    beforeResult.successCallbacks.forEach((cb) => cb());
     return result;
   } catch (e) {
     await this._log({

package/lib/PublishParser/publishTypesAndUtils.ts

@@ -55,6 +55,12 @@ export type UpdateRequestData<R extends AnyObject = AnyObject> =
   | UpdateRequestDataOne<R>
   | UpdateRequestDataBatch<R>;
 
+export type ValidateBeforeRowArgsCommon<R = AnyObject, DBX = DBHandlerServer> = {
+  dbx: DBX;
+  tx: pgPromise.ITask<{}> | DB;
+  command: "insert" | "update";
+  data: Partial<R>;
+};
 export type ValidateRowArgsCommon<R = AnyObject, DBX = DBHandlerServer> = {
   row: R;
   dbx: DBX;
@@ -74,9 +80,25 @@ export type ValidateRowArgsCommon<R = AnyObject, DBX = DBHandlerServer> = {
     }
 );
 
+export type BeforeEachTsTrigger<R, DBX> = {
+  commands: Partial<Record<"insert" | "update", 1>>;
+  /**
+   * Will only run this trigger if the insert/update provides non null values for these fields.
+   */
+  changedFields?: (keyof R)[];
+  validate: (
+    params: ValidateBeforeRowArgsCommon<R, DBX> & {
+      localParams: undefined | LocalParams;
+    },
+  ) => Promise<void | { row: R; onInserted?: () => void }>;
+};
+
 export type AfterEachTsTrigger<R, DBX> = {
   commands: Partial<Record<"insert" | "update" | "delete", 1>>;
-  changedFields?: string[];
+  /**
+   * Will only run this trigger if the insert/update provides non null values for these fields.
+   */
+  changedFields?: (keyof R)[];
   validate: (
     params: ValidateRowArgsCommon<R, DBX> & {
       localParams: undefined | LocalParams;

package/lib/TableConfig/TableConfig.ts

@@ -16,10 +16,10 @@ import type { DB, DBHandlerServer, Prostgles } from "../Prostgles";
 import type {
   AfterAllTsTrigger,
   AfterEachTsTrigger,
+  BeforeEachTsTrigger,
   InsertRule,
   SyncConfig,
   ValidateRowArgsCommon,
-  ValidateRowsArgsCommon,
 } from "../PublishParser/PublishParser";
 import {
   DEFAULT_SYNC_BATCH_SIZE,
@@ -63,11 +63,12 @@ type BaseTableDefinition<R = AnyObject, DBX = DBHandlerServer> = {
   hooks?: {
     /**
      * Hook used to run custom logic before inserting a row.
-     * The returned row must satisfy the table schema
+     * The returned row must satisfy the table schema.
      */
     getPreInsertRow?: (
       args: GetPreInsertRowArgs,
     ) => Promise<{ row: AnyObject; onInserted: Promise<void> }>;
+    beforeEach?: BeforeEachTsTrigger<R, DBX>[];
     afterEach?: AfterEachTsTrigger<R, DBX>[];
     afterAll?: AfterAllTsTrigger<R, DBX>[];
   };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "prostgles-server",
-  "version": "4.2.553",
+  "version": "4.2.555",
   "description": "",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package/dist/DboBuilder/TableHandler/executeHooksCheckAndPostValidation.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"executeHooksCheckAndPostValidation.d.ts","sourceRoot":"","sources":["../../../lib/DboBuilder/TableHandler/executeHooksCheckAndPostValidation.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AACjD,OAAO,KAAK,EAAE,UAAU,EAAE,UAAU,EAAE,UAAU,EAAE,MAAM,mCAAmC,CAAC;AAE5F,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AACjD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAEnD,eAAO,MAAM,kCAAkC,GAAU,uDAMtD;IACD,YAAY,EAAE,YAAY,CAAC;IAC3B,SAAS,EACL;QAAE,IAAI,EAAE,QAAQ,CAAC;QAAC,IAAI,EAAE,SAAS,GAAG,UAAU,CAAA;KAAE,GAChD;QAAE,IAAI,EAAE,QAAQ,CAAC;QAAC,IAAI,EAAE,SAAS,GAAG,UAAU,CAAA;KAAE,GAChD;QAAE,IAAI,EAAE,QAAQ,CAAC;QAAC,IAAI,EAAE,SAAS,GAAG,UAAU,CAAA;KAAE,CAAC;IACrD,WAAW,EAAE,WAAW,GAAG,SAAS,CAAC;IACrC,IAAI,EAAE,SAAS,GAAG,SAAS,EAAE,CAAC;IAC9B,IAAI,EAAE,SAAS,EAAE,CAAC;CACnB,kBAkEA,CAAC"}

package/dist/DboBuilder/TableHandler/executeHooksCheckAndPostValidation.js

@@ -1,69 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.executeHooksCheckAndPostValidation = void 0;
-const utils_1 = require("../../utils/utils");
-const executeHooksCheckAndPostValidation = async ({ tableHandler, operation, data, localParams, rows, }) => {
-    const command = operation.name;
-    const transaction = tableHandler.getTransaction(localParams);
-    const hooks = tableHandler.getHooksAndChecks(operation, localParams);
-    let changedFieldsSet = undefined;
-    const getChangedFieldsSet = () => {
-        changedFieldsSet ??= new Set(((0, utils_1.isArray)(data) ? data : [data]).map((row) => Object.keys(row)).flat());
-        return changedFieldsSet;
-    };
-    const applicableHooks = hooks.filter((hook) => {
-        if (hook.type === "checkFilter")
-            return false;
-        if (hook.type === "postValidate")
-            return true;
-        const { commands, changedFields } = hook;
-        return (commands[command] &&
-            (!changedFields || changedFields.some((f) => getChangedFieldsSet().has(f))));
-    });
-    if (applicableHooks.length) {
-        if (!transaction) {
-            throw new Error("Unexpected: hooks/postValidate require a transaction dbo handler");
-        }
-        const txParams = {
-            tx: transaction.t,
-            dbx: transaction.dbTX,
-        };
-        for (const row of rows) {
-            const commonParams = {
-                row: row,
-                ...txParams,
-                command,
-                data,
-            };
-            for (const hook of applicableHooks) {
-                if (hook.type === "afterEach") {
-                    await hook.validate({
-                        ...commonParams,
-                        localParams,
-                    });
-                }
-                else if (hook.type === "postValidate") {
-                    if (!localParams)
-                        throw new Error("Unexpected: no localParams for postValidate");
-                    await hook.validate({
-                        ...commonParams,
-                        localParams,
-                    });
-                }
-            }
-        }
-        for (const hook of applicableHooks) {
-            if (hook.type === "afterAll") {
-                await hook.validate({
-                    ...txParams,
-                    command,
-                    data: Array.isArray(data) ? data : [data],
-                    rows,
-                    localParams,
-                });
-            }
-        }
-    }
-};
-exports.executeHooksCheckAndPostValidation = executeHooksCheckAndPostValidation;
-//# sourceMappingURL=executeHooksCheckAndPostValidation.js.map

package/dist/DboBuilder/TableHandler/executeHooksCheckAndPostValidation.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"executeHooksCheckAndPostValidation.js","sourceRoot":"","sources":["../../../lib/DboBuilder/TableHandler/executeHooksCheckAndPostValidation.ts"],"names":[],"mappings":";;;AAEA,6CAA4C;AAIrC,MAAM,kCAAkC,GAAG,KAAK,EAAE,EACvD,YAAY,EACZ,SAAS,EACT,IAAI,EACJ,WAAW,EACX,IAAI,GAUL,EAAE,EAAE;IACH,MAAM,OAAO,GAAG,SAAS,CAAC,IAAI,CAAC;IAC/B,MAAM,WAAW,GAAG,YAAY,CAAC,cAAc,CAAC,WAAW,CAAC,CAAC;IAC7D,MAAM,KAAK,GAAG,YAAY,CAAC,iBAAiB,CAAC,SAAS,EAAE,WAAW,CAAC,CAAC;IACrE,IAAI,gBAAgB,GAAG,SAAoC,CAAC;IAC5D,MAAM,mBAAmB,GAAG,GAAG,EAAE;QAC/B,gBAAgB,KAAK,IAAI,GAAG,CAC1B,CAAC,IAAA,eAAO,EAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,EAAE,CACtE,CAAC;QACF,OAAO,gBAAgB,CAAC;IAC1B,CAAC,CAAC;IACF,MAAM,eAAe,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE;QAC5C,IAAI,IAAI,CAAC,IAAI,KAAK,aAAa;YAAE,OAAO,KAAK,CAAC;QAC9C,IAAI,IAAI,CAAC,IAAI,KAAK,cAAc;YAAE,OAAO,IAAI,CAAC;QAC9C,MAAM,EAAE,QAAQ,EAAE,aAAa,EAAE,GAAG,IAAI,CAAC;QACzC,OAAO,CACL,QAAQ,CAAC,OAAO,CAAC;YACjB,CAAC,CAAC,aAAa,IAAI,aAAa,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,mBAAmB,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAC5E,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,IAAI,eAAe,CAAC,MAAM,EAAE,CAAC;QAC3B,IAAI,CAAC,WAAW,EAAE,CAAC;YACjB,MAAM,IAAI,KAAK,CAAC,kEAAkE,CAAC,CAAC;QACtF,CAAC;QAED,MAAM,QAAQ,GAAG;YACf,EAAE,EAAE,WAAW,CAAC,CAAC;YACjB,GAAG,EAAE,WAAW,CAAC,IAAI;SACtB,CAAC;QAEF,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;YACvB,MAAM,YAAY,GAAG;gBACnB,GAAG,EAAE,GAAG;gBACR,GAAG,QAAQ;gBACX,OAAO;gBACP,IAAI;aACI,CAAC;YACX,KAAK,MAAM,IAAI,IAAI,eAAe,EAAE,CAAC;gBACnC,IAAI,IAAI,CAAC,IAAI,KAAK,WAAW,EAAE,CAAC;oBAC9B,MAAM,IAAI,CAAC,QAAQ,CAAC;wBAClB,GAAG,YAAY;wBACf,WAAW;qBACZ,CAAC,CAAC;gBACL,CAAC;qBAAM,IAAI,IAAI,CAAC,IAAI,KAAK,cAAc,EAAE,CAAC;oBACxC,IAAI,CAAC,WAAW;wBAAE,MAAM,IAAI,KAAK,CAAC,6CAA6C,CAAC,CAAC;oBACjF,MAAM,IAAI,CAAC,QAAQ,CAAC;wBAClB,GAAG,YAAY;wBACf,WAAW;qBACZ,CAAC,CAAC;gBACL,CAAC;YACH,CAAC;QACH,CAAC;QAED,KAAK,MAAM,IAAI,IAAI,eAAe,EAAE,CAAC;YACnC,IAAI,IAAI,CAAC,IAAI,KAAK,UAAU,EAAE,CAAC;gBAC7B,MAAM,IAAI,CAAC,QAAQ,CAAC;oBAClB,GAAG,QAAQ;oBACX,OAAO;oBACP,IAAI,EAAE,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;oBACzC,IAAI;oBACJ,WAAW;iBACZ,CAAC,CAAC;YACL,CAAC;QACH,CAAC;IACH,CAAC;AACH,CAAC,CAAC;AAjFW,QAAA,kCAAkC,sCAiF7C"}

package/lib/DboBuilder/TableHandler/executeHooksCheckAndPostValidation.ts

@@ -1,88 +0,0 @@
-import type { AnyObject } from "prostgles-types";
-import type { DeleteRule, InsertRule, UpdateRule } from "../../PublishParser/PublishParser";
-import { isArray } from "../../utils/utils";
-import type { LocalParams } from "../DboBuilder";
-import type { TableHandler } from "./TableHandler";
-
-export const executeHooksCheckAndPostValidation = async ({
-  tableHandler,
-  operation,
-  data,
-  localParams,
-  rows,
-}: {
-  tableHandler: TableHandler;
-  operation:
-    | { name: "delete"; rule: undefined | DeleteRule }
-    | { name: "update"; rule: undefined | UpdateRule }
-    | { name: "insert"; rule: undefined | InsertRule };
-  localParams: LocalParams | undefined;
-  data: AnyObject | AnyObject[];
-  rows: AnyObject[];
-}) => {
-  const command = operation.name;
-  const transaction = tableHandler.getTransaction(localParams);
-  const hooks = tableHandler.getHooksAndChecks(operation, localParams);
-  let changedFieldsSet = undefined as undefined | Set<string>;
-  const getChangedFieldsSet = () => {
-    changedFieldsSet ??= new Set<string>(
-      (isArray(data) ? data : [data]).map((row) => Object.keys(row)).flat(),
-    );
-    return changedFieldsSet;
-  };
-  const applicableHooks = hooks.filter((hook) => {
-    if (hook.type === "checkFilter") return false;
-    if (hook.type === "postValidate") return true;
-    const { commands, changedFields } = hook;
-    return (
-      commands[command] &&
-      (!changedFields || changedFields.some((f) => getChangedFieldsSet().has(f)))
-    );
-  });
-
-  if (applicableHooks.length) {
-    if (!transaction) {
-      throw new Error("Unexpected: hooks/postValidate require a transaction dbo handler");
-    }
-
-    const txParams = {
-      tx: transaction.t,
-      dbx: transaction.dbTX,
-    };
-
-    for (const row of rows) {
-      const commonParams = {
-        row: row,
-        ...txParams,
-        command,
-        data,
-      } as const;
-      for (const hook of applicableHooks) {
-        if (hook.type === "afterEach") {
-          await hook.validate({
-            ...commonParams,
-            localParams,
-          });
-        } else if (hook.type === "postValidate") {
-          if (!localParams) throw new Error("Unexpected: no localParams for postValidate");
-          await hook.validate({
-            ...commonParams,
-            localParams,
-          });
-        }
-      }
-    }
-
-    for (const hook of applicableHooks) {
-      if (hook.type === "afterAll") {
-        await hook.validate({
-          ...txParams,
-          command,
-          data: Array.isArray(data) ? data : [data],
-          rows,
-          localParams,
-        });
-      }
-    }
-  }
-};