feat: show list of changed fields in before create/edit views leave popup

https://web.tracklify.com/project/2b7ZVgE5/AdminForth/1280/cFz46RGr/is-it-possible-to-remove-this-

Author: yaroslav8765

adminforth/spa/src/components/AcceptModal.vue

@@ -14,7 +14,7 @@
                         <path stroke="currentColor" stroke-linecap="round" stroke-linejoin="round" stroke-width="2" d="M10 11V6m0 8h.01M19 10a9 9 0 1 1-18 0 9 9 0 0 1 18 0Z"/>
                     </svg>
                     <h3 class="afcl-confirmation-title mb-5 text-lg font-normal text-lightAcceptModalText dark:text-darkAcceptModalText">{{ modalStore?.modalContent?.content }}</h3>
-                    <h3 class="prose afcl-confirmation-title mb-5 text-lg font-normal text-lightAcceptModalText dark:text-darkAcceptModalText" v-html="modalStore?.modalContent?.contentHTML"></h3>
+                    <h3 class=" afcl-confirmation-title mb-5 text-lg font-normal text-lightAcceptModalText dark:text-darkAcceptModalText" v-html="modalStore?.modalContent?.contentHTML"></h3>
 
                     <button @click="()=>{ modalStore.onAcceptFunction(true);modalStore.togleModal()}" type="button" class="afcl-confirmation-accept-button text-lightAcceptModalConfirmButtonText bg-lightAcceptModalConfirmButtonBackground hover:bg-lightAcceptModalConfirmButtonBackgroundHover focus:ring-4 focus:outline-none focus:ring-lightAcceptModalConfirmButtonFocus font-medium rounded-lg text-sm inline-flex items-center px-5 py-2.5 text-center dark:text-darkAcceptModalConfirmButtonText dark:bg-darkAcceptModalConfirmButtonBackground dark:hover:bg-darkAcceptModalConfirmButtonBackgroundHover dark:focus:ring-darkAcceptModalConfirmButtonFocus">
                         {{ modalStore?.modalContent?.acceptText }}

adminforth/spa/src/utils/utils.ts

@@ -10,6 +10,7 @@ import sanitizeHtml  from 'sanitize-html'
 import debounce from 'debounce';
 import type { AdminForthResourceColumnInputCommon, Predicate } from '@/types/Common';
 import { i18nInstance } from '../i18n'
+import { useI18n } from 'vue-i18n';
 
 
 
@@ -524,9 +525,10 @@ export function atob_function(source: string): string {
   return atob(source);
 }
 
-export function compareOldAndNewRecord(oldRecord: Record<string, any>, newRecord: Record<string, any>): boolean {
+export function compareOldAndNewRecord(oldRecord: Record<string, any>, newRecord: Record<string, any>): {ok: boolean, changedFields: Record<string, {oldValue: any, newValue: any}>} {
   const newKeys = Object.keys(newRecord);
   const coreStore = useCoreStore();
+  const changedColumns: Record<string, { oldValue: any, newValue: any }> = {};
 
   for (const key of newKeys) {
     const oldValue = typeof oldRecord[key] === 'object' && oldRecord[key] !== null ? JSON.stringify(oldRecord[key]) : oldRecord[key];
@@ -537,30 +539,63 @@ export function compareOldAndNewRecord(oldRecord: Record<string, any>, newRecord
               oldValue === undefined || 
               oldValue === null || 
               oldValue === '' || 
-              (Array.isArray(oldValue) && oldValue.length === 0)
+              (Array.isArray(oldValue) && oldValue.length === 0) ||
+              oldValue === '[]' 
             ) 
               &&            
             ( 
               newValue === undefined || 
               newValue === null || 
               newValue === '' || 
-              (Array.isArray(newValue) && newValue.length === 0)
+              (Array.isArray(newValue) && newValue.length === 0) || 
+              newValue === '[]'
             )
       ) {
         // console.log(`Value for key ${key} is considered equal (empty)`)
         continue;
       }
 
-      const column = coreStore.resource.columns.find((c) => c.name === key);
+      const column = coreStore.resource?.columns.find((c) => c.name === key);
       if (column?.foreignResource) {
         if (newRecord[key] === oldRecord[key]?.pk) {
           // console.log(`Value for key ${key} is considered equal (foreign key)`)
           continue;
         }
       }
       // console.log(`Value for key ${key} is different`, { oldValue: oldValue, newValue: newValue });
-      return false;
+      changedColumns[key] = { oldValue, newValue };
     }
   }
-  return true;
+  return { ok: Object.keys(changedColumns).length !== 0, changedFields: changedColumns };
+}
+
+export function generateMessageHtmlForRecordChange(changedFields: Record<string, { oldValue: any, newValue: any }>, t: ReturnType<typeof useI18n>['t']): string {
+  const coreStore = useCoreStore();
+
+  const escapeHtml = (value: any) => {
+    if (value === null || value === undefined || value === '') return `<em>${t('empty')}</em>`;
+    let s: string;
+    if (typeof value === 'object') {
+      try {
+        s = JSON.stringify(value);
+      } catch (e) {
+        s = String(value);
+      }
+    } else {
+      s = String(value);
+    }
+    return s.replace(/&/g, '&amp;').replace(/</g, '&lt;').replace(/>/g, '&gt;').replace(/"/g, '&quot;').replace(/'/g, '&#039;');
+  };
+
+  const items = Object.keys(changedFields || {}).map(key => {
+    const column = coreStore.resource?.columns?.find((c: any) => c.name === key);
+    const label = column?.label || key;
+    const oldV = escapeHtml(changedFields[key].oldValue);
+    const newV = escapeHtml(changedFields[key].newValue);
+    return `<li class="truncate"><strong>${escapeHtml(label)}</strong>: <span class="af-old-value text-muted">${oldV}</span> &#8594; <span class="af-new-value">${newV}</span></li>`;
+  }).join('');
+
+  const listHtml = items ? `<ul class="mt-2 list-disc list-inside">${items}</ul>` : '';
+  const messageHtml = `<div>${escapeHtml(t('There are unsaved changes. Are you sure you want to leave this page?'))}${listHtml}</div>`;
+  return messageHtml; 
 }

adminforth/spa/src/views/CreateView.vue

@@ -79,7 +79,7 @@ import BreadcrumbsWithButtons from '@/components/BreadcrumbsWithButtons.vue';
 import ResourceForm from '@/components/ResourceForm.vue';
 import SingleSkeletLoader from '@/components/SingleSkeletLoader.vue';
 import { useCoreStore } from '@/stores/core';
-import { callAdminForthApi, getCustomComponent,checkAcessByAllowedActions, initThreeDotsDropdown, checkShowIf, compareOldAndNewRecord } from '@/utils';
+import { callAdminForthApi, getCustomComponent,checkAcessByAllowedActions, initThreeDotsDropdown, checkShowIf, compareOldAndNewRecord, generateMessageHtmlForRecordChange } from '@/utils';
 import { IconFloppyDiskSolid } from '@iconify-prerendered/vue-flowbite';
 import { onMounted, onBeforeMount, onBeforeUnmount, ref, watch, nextTick } from 'vue';
 import { useRoute, useRouter, onBeforeRouteLeave } from 'vue-router';
@@ -121,7 +121,7 @@ async function onUpdateRecord(newRecord: any) {
 }
 
 function checkIfWeCanLeavePage() {
-  return wasSaveSuccessful.value || cancelButtonClicked.value || compareOldAndNewRecord(initialValues.value, record.value);
+  return wasSaveSuccessful.value || cancelButtonClicked.value || compareOldAndNewRecord(initialValues.value, record.value).ok === false;
 }
 
 function onBeforeUnload(event: BeforeUnloadEvent) {
@@ -139,8 +139,12 @@ onBeforeUnmount(() => {
 
 onBeforeRouteLeave(async (to, from, next) => {
   if (!checkIfWeCanLeavePage()) {
-      const answer = await confirm({message: t('There are unsaved changes. Are you sure you want to leave this page?'), yes: 'Yes', no: 'No'});
-      if (!answer) return next(false);
+    const { changedFields } = compareOldAndNewRecord(initialValues.value, record.value);
+    
+    const messageHtml = generateMessageHtmlForRecordChange(changedFields, t);
+
+    const answer = await confirm({ messageHtml: messageHtml, yes: t('Yes'), no: t('No') });
+    if (!answer) return next(false);
   }
   next();
 });

adminforth/spa/src/views/EditView.vue

@@ -74,7 +74,7 @@ import BreadcrumbsWithButtons from '@/components/BreadcrumbsWithButtons.vue';
 import ResourceForm from '@/components/ResourceForm.vue';
 import SingleSkeletLoader from '@/components/SingleSkeletLoader.vue';
 import { useCoreStore } from '@/stores/core';
-import { callAdminForthApi, getCustomComponent,checkAcessByAllowedActions, initThreeDotsDropdown, compareOldAndNewRecord } from '@/utils';
+import { callAdminForthApi, getCustomComponent,checkAcessByAllowedActions, initThreeDotsDropdown, compareOldAndNewRecord, generateMessageHtmlForRecordChange } from '@/utils';
 import { IconFloppyDiskSolid } from '@iconify-prerendered/vue-flowbite';
 import { computed, onMounted, onBeforeMount, ref, type Ref, nextTick, watch, onBeforeUnmount } from 'vue';
 import { useRoute, useRouter, onBeforeRouteLeave } from 'vue-router';
@@ -113,7 +113,7 @@ function onBeforeUnload(event: BeforeUnloadEvent) {
 }
 
 function checkIfWeCanLeavePage() {
-  return wasSaveSuccessful.value || cancelButtonClicked.value || compareOldAndNewRecord(initialRecord.value, record.value);
+  return wasSaveSuccessful.value || cancelButtonClicked.value || compareOldAndNewRecord(initialRecord.value, record.value).ok === false;
 }
 
 window.addEventListener('beforeunload', onBeforeUnload);
@@ -124,8 +124,12 @@ onBeforeUnmount(() => {
 
 onBeforeRouteLeave(async (to, from, next) => {
   if (!checkIfWeCanLeavePage()) {
-      const answer = await confirm({message: t('There are unsaved changes. Are you sure you want to leave this page?'), yes: 'Yes', no: 'No'});
-      if (!answer) return next(false);
+    const { changedFields } = compareOldAndNewRecord(initialRecord.value, record.value);
+    
+    const messageHtml = generateMessageHtmlForRecordChange(changedFields, t);
+
+    const answer = await confirm({ messageHtml: messageHtml, yes: t('Yes'), no: t('No') });
+    if (!answer) return next(false);
   }
   next();
 });