feat: add custom validation functionality for resource columns[4]

Author: yaroslav8765

adminforth/modules/restApi.ts

@@ -606,7 +606,7 @@ export default class AdminForthRestAPI implements IAdminForthRestAPI {
                         col.validation.map(async (val, index) => {
                           return  {
                             ...val,
-                            customValidator: inCol.validation[index].validator ? true: false,
+                            validator: inCol.validation[index].validator ? true: false,
                             message: await tr(val.message, `resource.${resource.resourceId}`),
                           }
                         })
@@ -1603,7 +1603,7 @@ export default class AdminForthRestAPI implements IAdminForthRestAPI {
             for (const val of columnConfig.validation) {
               if (val.validator) {
                 const result = await val.validator(col.value, record, this.adminforth);
-                if (result.isValid === false) {
+                if (typeof result === 'object' && result.isValid === false) {
                   validationResults[col.name] = {
                     isValid: result.isValid,
                     message: result.message,

adminforth/spa/src/components/ColumnValueInputWrapper.vue

@@ -53,7 +53,7 @@
     @update:inValidity="$emit('update:inValidity', { name: column.name, value: $event })"
     @update:emptiness="$emit('update:emptiness', { name: column.name, value: $event })"
   />
-  <Spinner v-if="shouldWeShowSpinner" class="w-4 absolute top-1 left-2"/>
+  <Spinner v-if="shouldWeShowSpinner" class="w-3 absolute top-1.5 left-3.5"/>
 </template>
 
 <script setup lang="ts">

adminforth/spa/src/components/GroupsTable.vue

@@ -30,7 +30,7 @@
                 <Tooltip v-if="column.required[mode]">
 
                   <IconExclamationCircleSolid v-if="column.required[mode]" class="w-4 h-4" 
-                    :class="(columnsWithErrors[column.name] && validating) ? 'text-lightInputErrorColor dark:text-darkInputErrorColor' : 'text-lightRequiredIconColor dark:text-darkRequiredIconColor'"
+                    :class="(columnsWithErrors[column.name] && validatingMode && !isValidating) ? 'text-lightInputErrorColor dark:text-darkInputErrorColor' : 'text-lightRequiredIconColor dark:text-darkRequiredIconColor'"
                   />
 
                   <template #tooltip>
@@ -59,7 +59,7 @@
               :columnsWithErrors="columnsWithErrors"
               :isValidating="isValidating"
             />
-            <div v-if="columnsWithErrors[column.name] && validating" class="af-invalid-field-message mt-1 text-xs text-lightInputErrorColor dark:text-darkInputErrorColor">{{ columnsWithErrors[column.name] }}</div>
+            <div v-if="columnsWithErrors[column.name] && validatingMode && !isValidating" class="af-invalid-field-message mt-1 text-xs text-lightInputErrorColor dark:text-darkInputErrorColor">{{ columnsWithErrors[column.name] }}</div>
             <div v-if="column.editingNote && column.editingNote[mode]" class="mt-1 text-xs text-lightFormFieldTextColor dark:text-darkFormFieldTextColor">{{ column.editingNote[mode] }}</div>
           </td>
         </tr>
@@ -82,7 +82,7 @@
     source: 'create' | 'edit',
     group: any,
     mode: string,
-    validating: boolean,
+    validatingMode: boolean,
     currentValues: any,
     unmasked: any,
     columnError: (column: any) => string,

adminforth/spa/src/components/ResourceForm.vue

@@ -13,7 +13,7 @@
         :mode="mode"
         :unmasked="unmasked"
         :columnOptions="columnOptions"
-        :validating="validating"
+        :validatingMode="validatingMode"
         :columnError="columnError"
         :setCurrentValue="setCurrentValue"
         @update:customComponentsInValidity="(data) => customComponentsInValidity = { ...customComponentsInValidity, ...data }"
@@ -33,7 +33,7 @@
           :mode="mode"
           :unmasked="unmasked"
           :columnOptions="columnOptions"
-          :validating="validating"
+          :validatingMode="validatingMode"
           :columnError="columnError"
           :setCurrentValue="setCurrentValue"
           @update:customComponentsInValidity="(data) => customComponentsInValidity = { ...customComponentsInValidity, ...data }"
@@ -52,7 +52,7 @@
           :mode="mode"
           :unmasked="unmasked"
           :columnOptions="columnOptions"
-          :validating="validating"
+          :validatingMode="validatingMode"
           :columnError="columnError"
           :setCurrentValue="setCurrentValue"
           @update:customComponentsInValidity="(data) => customComponentsInValidity = { ...customComponentsInValidity, ...data }"
@@ -91,7 +91,7 @@ const route = useRoute();
 const props = defineProps<{
   resource: AdminForthResourceCommon,
   record: any,
-  validating: boolean,
+  validatingMode: boolean,
   source: 'create' | 'edit',
   readonlyColumns?: string[],
 }>();
@@ -364,13 +364,14 @@ const debouncedValidation = debounce(async (columns: AdminForthResourceColumnCom
   isValid.value = checkIfAnyColumnHasErrors();
 }, 500);
 
-watch(() => [editableColumns.value, props.validating], async () => {
+watch(() => [editableColumns.value, props.validatingMode], async () => {
+  isValidating.value = true;
+  
   editableColumns.value?.forEach(column => {
     checkIfColumnHasError(column);
   });
 
-  isValidating.value = true;
-  if (props.validating) {
+  if (props.validatingMode) {
     //Here I need to add debounce 
     debouncedValidation(editableColumns.value);
   } else {
@@ -424,12 +425,11 @@ provide('onSearchInput', onSearchInput);
 provide('loadMoreOptions', loadMoreOptions);
 
 watch(() => isValid.value, async (value) => {
-  const resolvedValue = value instanceof Promise ? await value : value;
-  emit('update:isValid', resolvedValue);
+  emit('update:isValid', value);
 });
 
 async function validateUsingUserValidationFunction(editableColumnsInner: AdminForthResourceColumnCommon[]): Promise<void> {
-  const doesUserHaveCustomValidation = props.resource.columns.some(column => column.validation && column.validation.some((val: any) => val.customValidator));
+  const doesUserHaveCustomValidation = props.resource.columns.some(column => column.validation && column.validation.some((val) => val.validator));
   if (doesUserHaveCustomValidation) {
     try {
       const res = await callAdminForthApi({

adminforth/spa/src/utils.ts

@@ -1,2 +1,3 @@
 export * from './utils/utils';
-export * from './utils/listUtils';
+export * from './utils/listUtils';
+export * from './utils/createEditUtils';

adminforth/spa/src/utils/createEditUtils.ts

@@ -0,0 +1,65 @@
+import type { AdminForthResourceColumn } from '@/types/Back';
+import { useAdminforth } from '@/adminforth';
+import { type Ref, nextTick } from 'vue';
+
+export function scrollToInvalidField(resourceFormRef: any, t: (key: string) => string) {
+  const { alert } = useAdminforth();
+  let columnsWithErrors: {column: AdminForthResourceColumn, error: string}[] = [];
+  for (const column of resourceFormRef.value?.editableColumns || []) {
+    if (resourceFormRef.value?.columnsWithErrors[column.name]) {
+      columnsWithErrors.push({
+        column,
+        error: resourceFormRef.value?.columnsWithErrors[column.name]
+      });
+    }
+  }
+  const errorMessage = t('Failed to save. Please fix errors for the following fields:') + '<ul class="mt-2 list-disc list-inside">' + columnsWithErrors.map(c => `<li><strong>${c.column.label || c.column.name}</strong>: ${c.error}</li>`).join('') + '</ul>';
+  alert({
+    messageHtml: errorMessage,
+    variant: 'danger'
+  });
+  const firstInvalidElement = document.querySelector('.af-invalid-field-message');
+  if (firstInvalidElement) {
+    firstInvalidElement.scrollIntoView({ behavior: 'smooth', block: 'center' });
+  }
+}
+
+export async function saveRecordPreparations(
+  viewMode: 'create' | 'edit',
+  validatingMode: Ref<boolean>, 
+  resourceFormRef: Ref<any>, 
+  isValid: Ref<boolean>, 
+  t: (key: string) => string, 
+  saving: Ref<boolean>, 
+  runSaveInterceptors: any, 
+  record: Ref<Record<string, any>>, 
+  coreStore: any, 
+  route: any
+) {
+  validatingMode.value = true;
+  await nextTick();
+  //wait for response for the user validation function if it exists
+  while (1) {
+    if (resourceFormRef.value?.isValidating) {
+      await new Promise(resolve => setTimeout(resolve, 100));
+    } else {
+      break;
+    }
+  }
+  if (!isValid.value) {
+    await nextTick();
+    scrollToInvalidField(resourceFormRef, t);
+    return;
+  } else {
+    validatingMode.value = false;
+  }
+
+  saving.value = true;
+  const interceptorsResult = await runSaveInterceptors({
+    action: viewMode,
+    values: record.value,
+    resource: coreStore.resource,
+    resourceId: route.params.resourceId as string,
+  });
+  return interceptorsResult;
+}

adminforth/spa/src/utils/index.ts

@@ -1,2 +1,3 @@
 export * from './utils';
-export * from './listUtils';
+export * from './listUtils';
+export * from './createEditUtils';

adminforth/spa/src/views/CreateView.vue

@@ -20,7 +20,7 @@
       <button  
         @click="() => saveRecord()"
         class="af-save-button flex items-center py-1 px-3 text-sm font-medium rounded-default text-lightCreateViewSaveButtonText focus:outline-none bg-lightCreateViewButtonBackground rounded border border-lightCreateViewButtonBorder hover:bg-lightCreateViewButtonBackgroundHover hover:text-lightCreateViewSaveButtonTextHover focus:z-10 focus:ring-4 focus:ring-lightCreateViewButtonFocusRing dark:focus:ring-darkCreateViewButtonFocusRing dark:bg-darkCreateViewButtonBackground dark:text-darkCreateViewSaveButtonText dark:border-darkCreateViewButtonBorder dark:hover:text-darkCreateViewSaveButtonTextHover dark:hover:bg-darkCreateViewButtonBackgroundHover disabled:opacity-50 gap-1"
-        :disabled="saving || (validating && !isValid)"
+        :disabled="saving || (validatingMode && !isValid) || resourceFormRef?.isValidating"
       > 
         <svg v-if="saving"
          aria-hidden="true" class="w-4 h-4 mr-1 text-gray-200 animate-spin dark:text-gray-600 fill-lightCreateViewSaveButtonText" viewBox="0 0 100 101" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M100 50.5908C100 78.2051 77.6142 100.591 50 100.591C22.3858 100.591 0 78.2051 0 50.5908C0 22.9766 22.3858 0.59082 50 0.59082C77.6142 0.59082 100 22.9766 100 50.5908ZM9.08144 50.5908C9.08144 73.1895 27.4013 91.5094 50 91.5094C72.5987 91.5094 90.9186 73.1895 90.9186 50.5908C90.9186 27.9921 72.5987 9.67226 50 9.67226C27.4013 9.67226 9.08144 27.9921 9.08144 50.5908Z" fill="currentColor"/><path d="M93.9676 39.0409C96.393 38.4038 97.8624 35.9116 97.0079 33.5539C95.2932 28.8227 92.871 24.3692 89.8167 20.348C85.8452 15.1192 80.8826 10.7238 75.2124 7.41289C69.5422 4.10194 63.2754 1.94025 56.7698 1.05124C51.7666 0.367541 46.6976 0.446843 41.7345 1.27873C39.2613 1.69328 37.813 4.19778 38.4501 6.62326C39.0873 9.04874 41.5694 10.4717 44.0505 10.1071C47.8511 9.54855 51.7191 9.52689 55.5402 10.0491C60.8642 10.7766 65.9928 12.5457 70.6331 15.2552C75.2735 17.9648 79.3347 21.5619 82.5849 25.841C84.9175 28.9121 86.7997 32.2913 88.1811 35.8758C89.083 38.2158 91.5421 39.6781 93.9676 39.0409Z" fill="currentFill"/></svg>
@@ -54,7 +54,7 @@
       :resource="coreStore.resource!"
       @update:record="onUpdateRecord"
       @update:isValid="isValid = $event"
-      :validating="validating"
+      :validatingMode="validatingMode"
       :source="'create'"
       :readonlyColumns="readonlyColumns"
     >
@@ -90,9 +90,10 @@ import { useAdminforth } from '@/adminforth';
 import { useI18n } from 'vue-i18n';
 import { type AdminForthComponentDeclarationFull } from '@/types/Common.js';
 import type { AdminForthResourceColumn } from '@/types/Back';
+import { scrollToInvalidField, saveRecordPreparations } from '@/utils';
 
 const isValid = ref(false);
-const validating = ref(false);
+const validatingMode = ref(false);
 
 const loading = ref(true);
 const saving = ref(false);
@@ -195,28 +196,23 @@ onMounted(async () => {
 });
 
 async function saveRecord() {
-  if (!isValid.value) {
-    validating.value = true;
-    await nextTick();
-    scrollToInvalidField();
-    return;
-  } else {
-    validating.value = false;
-  }
   const requiredColumns = coreStore.resource?.columns.filter(c => c.required?.create === true) || [];
   const requiredColumnsToSkip = requiredColumns.filter(c => checkShowIf(c, record.value, coreStore.resource?.columns || []) === false);  
   saving.value = true;
-  const interceptorsResult = await runSaveInterceptors({
-    action: 'create',
-    values: record.value,
-    resource: coreStore.resource,
-    resourceId: route.params.resourceId as string,
-  });
-  if (!interceptorsResult.ok) {
-    saving.value = false;
-    if (interceptorsResult.error) showErrorTost(interceptorsResult.error);
-    return;
-  }
+
+  const interceptorsResult = await saveRecordPreparations(
+    'create', 
+    validatingMode, 
+    resourceFormRef, 
+    isValid, 
+    t, 
+    saving, 
+    runSaveInterceptors, 
+    record, 
+    coreStore, 
+    route
+  );
+
   const interceptorConfirmationResult = (interceptorsResult.extra as Record<string, any>)?.confirmationResult;
   const response = await callAdminForthApi({
     method: 'POST',
@@ -254,23 +250,4 @@ async function saveRecord() {
   saving.value = false;
 }
 
-function scrollToInvalidField() {
-  let columnsWithErrors: {column: AdminForthResourceColumn, error: string}[] = [];
-  for (const column of resourceFormRef.value?.editableColumns || []) {
-    const error = resourceFormRef.value?.columnError(column);
-    if (error) {
-      columnsWithErrors.push({column, error});
-    }
-  }
-  const errorMessage = t('Failed to save. Please fix errors for the following fields:') + '<ul class="mt-2 list-disc list-inside">' + columnsWithErrors.map(c => `<li><strong>${c.column.label || c.column.name}</strong>: ${c.error}</li>`).join('') + '</ul>';
-  alert({
-    messageHtml: errorMessage,
-    variant: 'danger'
-  });
-  const firstInvalidElement = document.querySelector('.af-invalid-field-message');
-  if (firstInvalidElement) {
-    firstInvalidElement.scrollIntoView({ behavior: 'smooth', block: 'center' });
-  }
-}
-
 </script>

adminforth/spa/src/views/EditView.vue

@@ -19,7 +19,7 @@
       <button
         @click="() => saveRecord()"
         class="flex items-center py-1 px-3 text-sm font-medium  rounded-default text-lightEditViewSaveButtonText focus:outline-none bg-lightEditViewButtonBackground rounded border border-lightEditViewButtonBorder hover:bg-lightEditViewButtonBackgroundHover hover:text-lightEditViewSaveButtonTextHover focus:z-10 focus:ring-4 focus:ring-lightEditViewButtonFocusRing dark:focus:ring-darkEditViewButtonFocusRing dark:bg-darkEditViewButtonBackground dark:text-darkEditViewSaveButtonText dark:border-darkEditViewButtonBorder dark:hover:text-darkEditViewSaveButtonTextHover dark:hover:bg-darkEditViewButtonBackgroundHover disabled:opacity-50 gap-1"
-        :disabled="saving || (validatingMode && !isValid)"
+        :disabled="saving || (validatingMode && !isValid) || resourceFormRef?.isValidating"
       >
         <IconFloppyDiskSolid class="w-4 h-4" />
         {{ $t('Save') }}
@@ -50,7 +50,7 @@
       :adminUser="coreStore.adminUser"
       @update:record="onUpdateRecord"
       @update:isValid="isValid = $event"
-      :validating="validatingMode"
+      :validatingMode="validatingMode"
       :source="'edit'"
     >
     </ResourceForm>
@@ -84,6 +84,7 @@ import { useAdminforth } from '@/adminforth';
 import { useI18n } from 'vue-i18n';
 import { type AdminForthComponentDeclarationFull } from '@/types/Common.js';
 import type { AdminForthResourceColumn } from '@/types/Back';
+import { scrollToInvalidField, saveRecordPreparations } from '@/utils';
 
 const { t } = useI18n();
 const coreStore = useCoreStore();
@@ -179,31 +180,20 @@ onMounted(async () => {
 });
 
 async function saveRecord() {
-  validatingMode.value = true;
-  await nextTick();
-  //wait for response for the user validation function if it exists
-  while (1) {
-    if (resourceFormRef.value?.isValidating) {
-      await new Promise(resolve => setTimeout(resolve, 100));
-    } else {
-      break;
-    }
-  }
-  if (!isValid.value) {
-    await nextTick();
-    scrollToInvalidField();
-    return;
-  } else {
-    validatingMode.value = false;
-  }
 
-  saving.value = true;
-  const interceptorsResult = await runSaveInterceptors({
-    action: 'edit',
-    values: record.value,
-    resource: coreStore.resource,
-    resourceId: route.params.resourceId as string,
-  });
+  const interceptorsResult = await saveRecordPreparations(
+    'edit', 
+    validatingMode, 
+    resourceFormRef, 
+    isValid, 
+    t, 
+    saving, 
+    runSaveInterceptors, 
+    record, 
+    coreStore, 
+    route
+  );
+
   if (!interceptorsResult.ok) {
     saving.value = false;
     if (interceptorsResult.error) showErrorTost(interceptorsResult.error);
@@ -264,25 +254,4 @@ async function saveRecord() {
   saving.value = false;
 }
 
-function scrollToInvalidField() {
-  let columnsWithErrors: {column: AdminForthResourceColumn, error: string}[] = [];
-  for (const column of resourceFormRef.value?.editableColumns || []) {
-    if (resourceFormRef.value?.columnsWithErrors[column.name]) {
-      columnsWithErrors.push({
-        column,
-        error: resourceFormRef.value?.columnsWithErrors[column.name]
-      });
-    }
-  }
-  const errorMessage = t('Failed to save. Please fix errors for the following fields:') + '<ul class="mt-2 list-disc list-inside">' + columnsWithErrors.map(c => `<li><strong>${c.column.label || c.column.name}</strong>: ${c.error}</li>`).join('') + '</ul>';
-  alert({
-    messageHtml: errorMessage,
-    variant: 'danger'
-  });
-  const firstInvalidElement = document.querySelector('.af-invalid-field-message');
-  if (firstInvalidElement) {
-    firstInvalidElement.scrollIntoView({ behavior: 'smooth', block: 'center' });
-  }
-}
-
 </script>