fix: allow all hooks return { ok: false }

Author: yaroslav8765

adminforth/index.ts

@@ -6,7 +6,7 @@ import SQLiteConnector from './dataConnectors/sqlite.js';
 import CodeInjector from './modules/codeInjector.js';
 import ExpressServer from './servers/express.js';
 // import FastifyServer from './servers/fastify.js';
-import { ADMINFORTH_VERSION, listify, suggestIfTypo, RateLimiter, RAMLock, getClientIp, isProbablyUUIDColumn, convertPeriodToSeconds } from './modules/utils.js';
+import { ADMINFORTH_VERSION, listify, suggestIfTypo, RateLimiter, RAMLock, getClientIp, isProbablyUUIDColumn, convertPeriodToSeconds, hookResponseError } from './modules/utils.js';
 import { 
   type AdminForthConfig, 
   type IAdminForth, 
@@ -643,12 +643,9 @@ class AdminForth implements IAdminForth {
         extra,
       });
 
-      if (!resp || (!resp.ok && !resp.error)) {
-        throw new Error(`Hook afterSave must return object with {ok: true} or { error: 'Error' } `);
-      }
-
-      if (resp.error) {
-        return { error: resp.error };
+      const hookRespError = hookResponseError(resp);
+      if (hookRespError) {
+        return hookRespError;
       }
     }
 
@@ -695,14 +692,9 @@ class AdminForth implements IAdminForth {
         response,
         extra,
       });
-      if (!resp || typeof resp.ok !== 'boolean') {
-        throw new Error(`Hook beforeSave must return { ok: boolean, error?: string | null }`);
-      }
-      if (resp.ok === false && !resp.error) {
-        return { error: resp.error ?? 'Operation aborted by hook' };
-      }
-      if (resp.error) {
-        return { error: resp.error };
+      const hookRespError = hookResponseError(resp);
+      if (hookRespError) {
+        return hookRespError;
       }
     }
 
@@ -740,11 +732,9 @@ class AdminForth implements IAdminForth {
         response,
         extra,
       });
-      if (!resp || (!resp.ok && !resp.error)) {
-        throw new Error(`Hook afterSave must return object with {ok: true} or { error: 'Error' } `);
-      }
-      if (resp.error) {
-        return { error: resp.error };
+      const hookRespError = hookResponseError(resp);
+      if (hookRespError) {
+        return hookRespError;
       }
     }
 
@@ -771,12 +761,9 @@ class AdminForth implements IAdminForth {
         response,
         extra,
       });
-      if (!resp || (!resp.ok && !resp.error)) {
-        throw new Error(`Hook beforeSave must return object with {ok: true} or { error: 'Error' } `);
-      }
-
-      if (resp.error) {
-        return { error: resp.error };
+      const hookRespError = hookResponseError(resp);
+      if (hookRespError) {
+        return hookRespError;
       }
     }
 
@@ -794,12 +781,9 @@ class AdminForth implements IAdminForth {
         response,
         extra,
       });
-      if (!resp || (!resp.ok && !resp.error)) {
-        throw new Error(`Hook afterSave must return object with {ok: true} or { error: 'Error' } `);
-      }
-
-      if (resp.error) {
-        return { error: resp.error };
+      const hookRespError = hookResponseError(resp);
+      if (hookRespError) {
+        return hookRespError;
       }
     }
 

adminforth/modules/restApi.ts

@@ -19,7 +19,7 @@ import {cascadeChildrenDelete} from './utils.js'
 
 import { afLogger } from "./logger.js";
 
-import { ADMINFORTH_VERSION, listify, md5hash, getLoginPromptHTML } from './utils.js';
+import { ADMINFORTH_VERSION, listify, md5hash, getLoginPromptHTML, hookResponseError } from './utils.js';
 
 import AdminForthAuth from "../auth.js";
 import { ActionCheckSource, AdminForthConfigMenuItem, AdminForthDataTypes, AdminForthFilterOperators, AdminForthResourceColumnInputCommon, AdminForthResourceCommon, AdminForthResourcePages,
@@ -748,14 +748,9 @@ export default class AdminForthRestAPI implements IAdminForthRestAPI {
             },
             adminforth: this.adminforth,
           });
-          if (!resp || typeof resp.ok !== 'boolean') {
-            throw new Error(`Hook beforeSave must return { ok: boolean, error?: string | null }`);
-          }
-          if (resp.ok === false && !resp.error) {
-            return { error: resp.error ?? 'Operation aborted by hook' };
-          }
-          if (resp.error) {
-            return { error: resp.error };
+          const hookRespError = hookResponseError(resp);
+          if (hookRespError) {
+            return hookRespError;
           }
         }
         const { limit, offset, filters, sort } = body;
@@ -954,13 +949,9 @@ export default class AdminForthRestAPI implements IAdminForthRestAPI {
             },
             adminforth: this.adminforth,
           });
-
-          if (!resp || (!resp.ok && !resp.error)) {
-            throw new Error(`Hook must return object with {ok: true} or { error: 'Error' } `);
-          }
-
-          if (resp.error) {
-            return { error: resp.error };
+          const hookRespError = hookResponseError(resp);
+          if (hookRespError) {
+            return hookRespError;
           }
         }
 

adminforth/modules/utils.ts

@@ -521,4 +521,17 @@ export async function cascadeChildrenDelete(resource: AdminForthResource, primar
     }
 
     return { error: null };
+  }
+
+  export function hookResponseError(hookResponse: {ok: boolean, error?: string | null}) {
+    if (!hookResponse || typeof hookResponse.ok !== 'boolean') {
+      throw new Error(`Hook beforeSave must return { ok: boolean, error?: string | null }`);
+    }
+    if (hookResponse.ok === false && !hookResponse.error) {
+      return { error: hookResponse.error ?? 'Operation aborted by hook' };
+    }
+    if (hookResponse.error) {
+      return { error: hookResponse.error };
+    }
+    return null;
   }