Merge pull request #293 from devforth/interrupt-by-beforeSave

feat: support interrupting create/edit via beforeSave hook

Author: ivictbor

adminforth/index.ts

@@ -511,7 +511,7 @@ class AdminForth implements IAdminForth {
   async createResourceRecord(
     { resource, record, adminUser, extra }: 
     { resource: AdminForthResource, record: any, adminUser: AdminUser, extra?: HttpExtra }
-  ): Promise<{ error?: string, createdRecord?: any }> {
+  ): Promise<{ error?: string, createdRecord?: any, newRecordId?: any }> {
 
     const err = this.validateRecordValues(resource, record, 'create');
     if (err) {
@@ -528,8 +528,18 @@ class AdminForth implements IAdminForth {
         adminforth: this,
         extra,
       });
-      if (!resp || (!resp.ok && !resp.error)) {
-        throw new Error(`Hook beforeSave must return object with {ok: true} or { error: 'Error' } `);
+      if (!resp || (typeof resp.ok !== 'boolean' && (!resp.error && !resp.newRecordId))) {
+        throw new Error(
+          `Invalid return value from beforeSave hook. Expected: { ok: boolean, error?: string | null, newRecordId?: any }.\n` +
+          `Note: Return { ok: false, error: null, newRecordId } to stop creation and redirect to an existing record.`
+        );
+      }
+      if (resp.ok === false && !resp.error) {
+        const { error, ok, newRecordId } = resp;
+        return {
+          error: error ?? 'Operation aborted by hook',
+          newRecordId: newRecordId
+        };
       }
       if (resp.error) {
         return { error: resp.error };
@@ -605,8 +615,11 @@ class AdminForth implements IAdminForth {
         adminforth: this,
         extra,
       });
-      if (!resp || (!resp.ok && !resp.error)) {
-        throw new Error(`Hook beforeSave must return object with {ok: true} or { error: 'Error' } `);
+      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 };

adminforth/modules/restApi.ts

@@ -1119,7 +1119,7 @@ export default class AdminForthRestAPI implements IAdminForthRestAPI {
 
             const response = await this.adminforth.createResourceRecord({ resource, record, adminUser, extra: { body, query, headers, cookies, requestUrl } });
             if (response.error) {
-              return { error: response.error, ok: false };
+              return { error: response.error, ok: false, newRecordId: response.newRecordId };
             }
             const connector = this.adminforth.connectors[resource.dataSource];
 

adminforth/spa/src/views/CreateView.vue

@@ -154,7 +154,7 @@ async function saveRecord() {
       record: record.value,
     },
   });
-  if (response?.error) {
+  if (response?.error == true) {
     showErrorTost(response.error);
   }
   saving.value = false;

adminforth/types/Back.ts

@@ -336,7 +336,7 @@ export interface IAdminForth {
 
   createResourceRecord(
     params: { resource: AdminForthResource, record: any, adminUser: AdminUser, extra?: HttpExtra }
-  ): Promise<{ error?: string, createdRecord?: any }>;
+  ): Promise<{ error?: string, createdRecord?: any, newRecordId?: any }>;
 
   updateResourceRecord(
     params: { resource: AdminForthResource, recordId: any, record: any, oldRecord: any, adminUser: AdminUser, extra?: HttpExtra }
@@ -474,7 +474,7 @@ export type BeforeDataSourceRequestFunction = (params: {
     requestUrl: string,
   },
   adminforth: IAdminForth,
-}) => Promise<{ok: boolean, error?: string}>;
+}) => Promise<{ok: boolean, error?: string, newRecordId?: string}>;
 
 /**
  * Modify response to change how data is returned after fetching from database.
@@ -525,7 +525,7 @@ export type BeforeEditSaveFunction = (params: {
   oldRecord: any,
   adminforth: IAdminForth,
   extra?: HttpExtra,
-}) => Promise<{ok: boolean, error?: string}>;
+}) => Promise<{ok: boolean, error?: string | null}>;
 
 
 
@@ -535,7 +535,7 @@ export type BeforeCreateSaveFunction = (params: {
   record: any, 
   adminforth: IAdminForth,
   extra?: HttpExtra,
-}) => Promise<{ok: boolean, error?: string}>;
+}) => Promise<{ok: boolean, error?: string | null, newRecordId?: string}>;
 
 export type AfterCreateSaveFunction = (params: {
   resource: AdminForthResource,