srcdev-nuxt-forms 3.0.0 → 4.1.0

package/composables/useFormControl.ts

@@ -0,0 +1,248 @@
+import type { IFormData, IFieldsInitialState, IFormFieldC12, IApiErrorMessages, ICustomErrorMessage, IErrorMessagesArr } from '@/types/types.forms';
+import { formFieldC12 } from '@/components/forms/c12/utils';
+
+// export function useFormControl(name: string = '') {
+export function useFormControl(name: string = '') {
+  let savedInitialState = {};
+
+  const formData = ref<IFormData>({
+    data: {} as IFieldsInitialState,
+    validityState: {},
+    dirtyFields: {},
+    focusedField: '',
+    isPending: false,
+    errorCount: 0,
+    errorMessages: {},
+    formFieldsC12: {},
+    hasCustomErrorMessages: false,
+    formIsValid: false,
+    submitAttempted: false,
+    submitDisabled: false,
+    submitSuccess: false,
+    displayErrorMessages: false,
+  });
+
+  const initValidationState = async (fieldsInitialState: IFieldsInitialState | Ref<IFieldsInitialState | null>) => {
+    const fields = Object.keys(fieldsInitialState.value || {});
+    const state = fields.reduce((accumulatedFields, field) => {
+      accumulatedFields[field] = false;
+      return accumulatedFields;
+    }, {} as Record<string, boolean>);
+    formData.value.validityState = state;
+  };
+
+  const initFormData = async (fieldsInitialState: IFieldsInitialState | Ref<IFieldsInitialState | null>) => {
+    initValidationState(fieldsInitialState);
+
+    if (fieldsInitialState !== null) {
+      savedInitialState = toRaw(fieldsInitialState.value) as IFieldsInitialState;
+      formData.value.data = fieldsInitialState as IFieldsInitialState;
+    }
+    return;
+  };
+
+  const initFormFieldsC12 = (name: string, formFieldC12: IFormFieldC12) => {
+    formData.value.formFieldsC12[name] = formFieldC12;
+    return;
+  };
+
+  const updatePreviousValues = () => {
+    console.log(`useFormControl | updatePreviousValues`);
+
+    Object.keys(formData.value.data).forEach((key) => {
+      formData.value.formFieldsC12[key].previousValue = formData.value.data[key];
+    });
+  };
+
+  const getErrorCount = async (updateState: boolean = false) => {
+    await nextTick();
+
+    const errorCount = Object.values(formData.value.validityState).filter((value) => !value).length;
+    formData.value.errorCount = errorCount;
+    formData.value.formIsValid = errorCount === 0;
+
+    if (updateState) {
+      formData.value.submitDisabled = true;
+      formData.value.displayErrorMessages = formData.value.errorCount > 0;
+      formData.value.submitAttempted = true;
+    }
+
+    if (formData.value.submitDisabled) {
+      formData.value.submitDisabled = !formData.value.formIsValid;
+    }
+
+    // update fieldHasError ref
+    // if (typeof formData.value!.formFieldsC12[name] !== 'undefined') {
+    //   fieldHasError.value = formData.value!.submitAttempted && !formData.value!.formFieldsC12[name].isValid;
+    // } else {
+    //   fieldHasError.value = false;
+    // }
+
+    return formData.value.errorCount;
+  };
+
+  // Function to count items with "useCustomError" set to true
+  const countItemsWithCustomError = (obj: IErrorMessagesArr) => {
+    let count = 0;
+
+    for (const key in obj) {
+      if (obj.hasOwnProperty(key) && obj[key].useCustomError === true) {
+        count++;
+      }
+    }
+
+    return count;
+  };
+
+  /*
+   *   Useage:
+   *
+   *   const { updateErrorMessages } = useFormControl();
+   *
+   *   Add/Update entry
+   *   const sampleCustomErrorEmail = {
+   *     useCustomError: true,
+   *     message: "This is a sample custom error for error EMAIL",
+   *   };
+   *   updateErrorMessages("email", sampleCustomErrorEmail);
+   */
+  const updateErrorMessages = async (name: string, message: string = '', valid: boolean = false) => {
+    if (!valid) {
+      // formData.value.validityState[name] = valid;
+      // formData.value.errorMessages[name] = {
+      //   useCustomError: true,
+      //   message,
+      // };
+
+      formData.value.formFieldsC12[name].useCustomError = true;
+
+      // if (typeof message === 'string') {
+      //   formData.value.formFieldsC12[name].customErrors = message;
+      // } else if (typeof message === 'object') {
+      //   formData.value.formFieldsC12[name].customErrors = message;
+      // }
+
+      formData.value.formFieldsC12[name].customErrors = message;
+      formData.value.formFieldsC12[name].isValid = valid;
+
+      // formData.value.errorMessages[name].useCustomError = true;
+      // formData.value.errorMessages[name].message = message;
+    }
+    formData.value.hasCustomErrorMessages = countItemsWithCustomError(formData.value.errorMessages) > 0;
+  };
+
+  const useApiErrors = async (errors: IApiErrorMessages) => {
+    // Object.keys(errors).forEach((key) => {
+    //   updateErrorMessages(key, errors[key]);
+    // });
+
+    for (const [key, message] of Object.entries(errors)) {
+      // console.log(`${key}: ${message}`);
+      updateErrorMessages(key, message);
+    }
+  };
+
+  // const resetForm = () => {
+  //   console.log('resetForm()');
+  //   formData.value.data = toRaw(fieldsInitialState.value) as IFieldsInitialState;
+  //   formData.value.validityState = {};
+  //   formData.value.errorCount = 0;
+  //   formData.value.isPending = false;
+  //   formData.value.errorMessages = {};
+  //   formData.value.formIsValid = false;
+  // };
+
+  const fieldIsDirty = (name: string) => {
+    if (typeof formData.value.formFieldsC12[name] !== 'undefined') {
+      return formData.value.formFieldsC12[name].isDirty;
+    } else {
+      return false;
+    }
+  };
+
+  // const fieldHasError = (name: string) => {
+  //   const currentValidityState = formData.value.validityState[name];
+
+  //   if (formData.value.submitAttempted) {
+  //     return currentValidityState;
+  //   }
+  //   return false;
+  // };
+
+  // const fieldHasError = computed({
+  //   // getter
+  //   get() {
+  //     console.log(`fieldHasError getter: ${name}`);
+  //     if (typeof formData.value!.formFieldsC12[name] !== 'undefined') {
+  //       return !formData.value!.formFieldsC12[name].isValid;
+  //     }
+  //     return formData.value.validityState[name];
+  //   },
+  //   // setter
+  //   set(newValue) {
+  //     if (formData.value.submitAttempted) {
+  //       return newValue;
+  //     }
+  //     return false;
+  //   },
+  // });
+
+  // const fieldHasError = ref(false);
+
+  const formIsValid = computed(() => {
+    return formData.value.formIsValid;
+  });
+
+  const submitDisabled = computed(() => {
+    return formData.value.submitDisabled;
+  });
+
+  // Keep an eye on this for performance issue
+
+  // const updateFieldValidity = (name: string, valid: boolean) => {
+  //   console.log(`updateFieldValidity: name:${name} - valid:${valid}`);
+  //   console.log(formData.value);
+  //   // formData.value.formFieldsC12[name].isValid = valid;
+  //   formData.value.validityState[name] = valid;
+  // };
+
+  watch(
+    () => formData.value.validityState,
+    () => {
+      getErrorCount();
+    },
+    { deep: true }
+  );
+
+  watch(
+    () => formData.value.formFieldsC12,
+    () => {
+      formData.value.formFieldsC12;
+    },
+    { deep: true }
+  );
+
+  watch(
+    () => formData.value.isPending,
+    (newValue, oldValue) => {
+      if (newValue) {
+        updatePreviousValues();
+      }
+    }
+  );
+
+  return {
+    formData,
+    initFormData,
+    initFormFieldsC12,
+    getErrorCount,
+    updateErrorMessages,
+    // resetForm,
+    formIsValid,
+    submitDisabled,
+    useApiErrors,
+    // fieldHasError,
+    fieldIsDirty,
+    // updateFieldValidity,
+  };
+}

package/composables/useSleep.ts

@@ -0,0 +1,5 @@
+async function useSleep(ms: number) {
+  return new Promise((resolve) => setTimeout(resolve, ms));
+}
+
+export default useSleep;

package/composables/useStyleClassPassthrough.ts

@@ -0,0 +1,30 @@
+export const useStyleClassPassthrough = (styleClassPassthrough: string[]) => {
+  const styleClassPassthroughRef = ref(styleClassPassthrough);
+
+  const elementClasses = computed(() => {
+    return styleClassPassthroughRef.value.join(' ');
+  });
+
+  const updateElementClasses = (cssClass: string | string[]) => {
+    let cssClasses = [] as string[];
+    if (typeof cssClass === 'string') {
+      cssClasses = [cssClass];
+    } else if (Array.isArray(cssClass)) {
+      cssClasses = cssClass;
+    }
+
+    cssClasses.forEach((cssClass) => {
+      if (styleClassPassthroughRef.value.includes(cssClass)) {
+        styleClassPassthroughRef.value = styleClassPassthroughRef.value.filter((className) => className !== cssClass);
+      } else {
+        styleClassPassthroughRef.value.push(cssClass);
+      }
+    });
+  };
+
+  return {
+    elementClasses,
+    updateElementClasses,
+    styleClassPassthroughRef,
+  };
+};

package/composables/useZodValidation.ts

@@ -0,0 +1,148 @@
+import { ref, reactive, toRaw, type Ref } from 'vue';
+import { z, ZodError } from 'zod';
+import type { ApiErrorResponse } from '../types/types.forms';
+
+const useZodValidation = (formSchema: any, formRef: Ref<HTMLFormElement | null>) => {
+  const zodFormControl = reactive({
+    errorCount: 0,
+    displayLoader: false,
+    submitDisabled: false,
+    submitAttempted: false,
+    submitSuccessful: false,
+    formIsValid: false,
+    isPending: false,
+    isDisabled: false,
+    previousState: {} as Record<string, any>,
+  });
+
+  type formSchema = z.infer<typeof formSchema>;
+  const zodErrorObj = ref<z.ZodFormattedError<formSchema> | null>(null);
+
+  const resetPreviousValues = () => {
+    for (const [field] of Object.entries(formSchema.shape)) {
+      const previousValue = {
+        value: null,
+        message: '',
+      };
+
+      zodFormControl.previousState[field] = previousValue;
+    }
+  };
+
+  const initZodForm = () => {
+    resetPreviousValues();
+  };
+
+  const getErrorCount = (zodErrorObj: Ref<z.ZodFormattedError<formSchema> | null>) => {
+    const zodCountErrors = zodErrorObj.value ?? [];
+    // @ts-ignore
+    delete zodCountErrors._errors;
+    const errorCount = Object.keys(zodCountErrors ?? []).length;
+    return errorCount;
+  };
+
+  const transformErrorMessages = (errors: any) => {
+    const apiErrors = ref({}) as any;
+    for (const [key, value] of Object.entries(errors)) {
+      const fieldPath = key.split('.').map((key: string) => key.charAt(0).toLowerCase() + key.slice(1));
+      apiErrors.value[fieldPath.join('.')] = value;
+    }
+
+    return apiErrors.value;
+  };
+
+  const updatePreviousValue = async (field: string, message: string, state: Record<string, any>) => {
+    const previousValue = {
+      value: state[field],
+      message: message,
+    };
+    zodFormControl.previousState[field] = previousValue;
+  };
+
+  const pushCustomErrors = async (apiErrorResponse: ApiErrorResponse, state: Record<string, any>) => {
+    const apiErrors = transformErrorMessages(apiErrorResponse.data.errors);
+
+    // 1: Create a ZodError object to hold the issues
+    const zodError = new ZodError([]);
+
+    // 2: Reset previous state values
+    resetPreviousValues();
+
+    // 3: Add issues to the ZodError object
+    for (const [path, message] of Object.entries(apiErrors)) {
+      zodError.addIssue({
+        path: path.split('.'),
+        message: message as string,
+        code: z.ZodIssueCode.custom,
+      });
+      await updatePreviousValue(path, message as string, state);
+    }
+
+    zodErrorObj.value = zodError.format();
+    zodFormControl.errorCount = getErrorCount(zodErrorObj);
+    zodFormControl.formIsValid = zodFormControl.errorCount === 0;
+    zodFormControl.displayLoader = false;
+    zodFormControl.submitAttempted = true;
+    scrollToFirstError();
+    return zodErrorObj.value;
+  };
+
+  const doZodValidate = async (state: Record<string, any>) => {
+    const valid = formSchema.safeParse(toRaw(state));
+    if (!valid.success) {
+      zodErrorObj.value = valid.error.format();
+    } else {
+      zodErrorObj.value = null;
+    }
+
+    zodFormControl.errorCount = getErrorCount(zodErrorObj);
+    zodFormControl.formIsValid = valid.success;
+
+    return valid.success;
+  };
+
+  const fieldMaxLength = (name: string) => {
+    const fieldSchema = formSchema.shape[name];
+    if (fieldSchema instanceof z.ZodString) {
+      return fieldSchema._def.checks.find((check) => check.kind === 'max')?.value;
+    }
+  };
+
+  const scrollToFirstError = async () => {
+    if (formRef.value) {
+      const firstErrorElement = formRef.value.querySelector('[aria-invalid=true]');
+
+      if (firstErrorElement) {
+        window.scrollTo({
+          top: firstErrorElement?.getBoundingClientRect().y + window.scrollY,
+          left: 0,
+          behavior: 'smooth',
+        });
+      }
+    }
+  };
+
+  const scrollToFormHead = () => {
+    if (formRef.value) {
+      const formHead = formRef.value.getBoundingClientRect().top;
+      window.scrollTo({
+        top: formHead,
+        left: 0,
+        behavior: 'smooth',
+      });
+    }
+  };
+
+  return {
+    initZodForm,
+    zodFormControl,
+    zodErrorObj,
+    pushCustomErrors,
+    doZodValidate,
+    fieldMaxLength,
+    scrollToFirstError,
+    scrollToFormHead,
+  };
+};
+
+export default useZodValidation;

package/nuxt.config.ts

@@ -1,9 +1,6 @@
 // https://nuxt.com/docs/api/configuration/nuxt-config
 
 export default defineNuxtConfig({
-  future: {
-    compatibilityVersion: 4,
-  },
   devtools: { enabled: true },
   css: ['modern-normalize', './assets/styles/main.css'],
   modules: ['@nuxt/icon', '@nuxt/test-utils/module'],

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "srcdev-nuxt-forms",
   "type": "module",
-  "version": "3.0.0",
+  "version": "4.1.0",
   "main": "nuxt.config.ts",
   "scripts": {
     "clean": "rm -rf .nuxt && rm -rf .output && rm -rf .playground/.nuxt && rm -rf .playground/.output",

package/types/types.forms.ts

@@ -0,0 +1,217 @@
+export interface IValidationPatterns {
+  pattern: string;
+  minlength: string;
+  maxlength: string;
+  hint: string;
+}
+
+export interface IOptionsConfig {
+  id: string;
+  name: string;
+  value: string;
+  label: string;
+  icon?: string;
+}
+
+export interface IFormMultipleOptions {
+  data: IOptionsConfig[];
+  total: number;
+  skip: number;
+  limit: number;
+}
+
+export interface IOptionsValueArr {
+  [key: string]: string | boolean | number | URL | object;
+}
+
+export interface IFieldsInitialState {
+  [key: string]: null | string | boolean | number | URL | object | IOptionsValueArr[];
+}
+
+export type TFieldsInitialState = {
+  [key: string]: null | string | boolean | number | URL | object | IOptionsValueArr[];
+};
+
+export interface IValidityState {
+  badInput: boolean;
+  customError: boolean;
+  patternMismatch: boolean;
+  rangeOverflow: boolean;
+  rangeUnderflow: boolean;
+  stepMismatch: boolean;
+  tooLong: boolean;
+  tooShort: boolean;
+  typeMismatch: boolean;
+  valid: boolean;
+  valueMissing: boolean;
+}
+
+export interface IValidityStateArr {
+  [key: string]: {
+    badInput: boolean;
+    customError: boolean;
+    patternMismatch: boolean;
+    rangeOverflow: boolean;
+    rangeUnderflow: boolean;
+    stepMismatch: boolean;
+    tooLong: boolean;
+    tooShort: boolean;
+    typeMismatch: boolean;
+    valid: boolean;
+    valueMissing: boolean;
+  };
+}
+
+export interface IFormFieldsState {
+  [key: string]: boolean;
+}
+
+export interface ICustomErrorMessage {
+  useCustomError: boolean;
+  message: string;
+}
+
+export interface InpuTextC12 {
+  label: string;
+  placeholder: string;
+  errorMessage: string;
+}
+
+export interface IErrorMessagesArr {
+  [x: string]: ICustomErrorMessage;
+}
+
+export interface IFormFieldC12 {
+  label: string;
+  placeholder: string;
+  errorMessage: string;
+  useCustomError: boolean;
+  customErrors: null | string | string[];
+  isValid: boolean;
+  isDirty: boolean;
+  type: string;
+  previousValue: null | string | boolean | number | URL | object;
+}
+
+export interface IFormFieldsC12 {
+  [x: string]: IFormFieldC12;
+}
+
+export interface IFormFieldState {
+  isValid: boolean;
+  isDirty: boolean;
+  previousValue: null | string | boolean | number | URL | object;
+}
+
+export interface IFormFieldStateObj {
+  [x: string]: IFormFieldState;
+}
+
+export interface IFormData {
+  [x: string]: string | boolean | number | URL | object;
+  data: IFieldsInitialState;
+  validityState: IFormFieldsState;
+  dirtyFields: IFormFieldsState;
+  focusedField: string;
+  isPending: boolean;
+  errorCount: number;
+  errorMessages: IErrorMessagesArr;
+  formFieldsC12: IFormFieldsC12;
+  formIsValid: boolean;
+  submitAttempted: boolean;
+  submitDisabled: boolean;
+  submitSuccess: boolean;
+  displayErrorMessages: boolean;
+}
+
+export interface IApiErrorMessages {
+  [x: string]: string;
+}
+
+// New types
+
+export interface C12nInputText {
+  type: string;
+  id: string;
+  name: string;
+  label: string;
+  placeholder: string;
+  errorMessage: string;
+  fieldHasError: boolean;
+  required: boolean;
+  styleClassPassthrough: string[];
+}
+
+export interface C12nMultipleCheckboxes {
+  id: string;
+  name: string;
+  label: string;
+  legend: string;
+  placeholder: string;
+  errorMessage: string;
+  fieldHasError: boolean;
+  required: boolean;
+  styleClassPassthrough: string[];
+}
+
+export interface C12nInputCheckboxWithLabel {
+  id: string;
+  name: string;
+  required: string;
+  label: string;
+  placeholder: string;
+  errorMessage: string | string[];
+  fieldHasError: boolean;
+  styleClassPassthrough: string[];
+}
+
+export interface C12nInputRange {
+  id: string;
+  name: string;
+  label: string;
+  min: number;
+  max: number;
+  step: number;
+  placeholder: string;
+  errorMessage: string;
+  fieldHasError: boolean;
+  required: boolean;
+  styleClassPassthrough: string[];
+}
+
+export interface C12nInputTextCore {
+  type: string;
+  id: string;
+  name: string;
+  label: string;
+  placeholder: string;
+  errorMessage: string;
+  fieldHasError: boolean;
+  required: boolean;
+}
+
+export interface InputTextWithLabel {
+  type: string;
+  id: string;
+  name: string;
+  label: string;
+  placeholder: string;
+  errorMessage: string;
+  fieldHasError: boolean;
+  required: boolean;
+  styleClassPassthrough: string[];
+  deepCssClassPassthrough: string[];
+}
+
+export interface ApiErrorResponse {
+  url: string;
+  statusCode: number;
+  statusMessage: string;
+  message: string;
+  stack: string;
+  data: {
+    errors: {
+      [key: string]: string | string[]; // Index signature for dynamic keys
+    };
+  };
+}

package/types/types.zodFormControl.ts

@@ -0,0 +1,21 @@
+import type { IFieldsInitialState, IFormFieldsState, IFormFieldsC12, IFormFieldC12, IApiErrorMessages, ICustomErrorMessage, IErrorMessagesArr } from '@/types/types.forms';
+
+export interface IZodeFormControl {
+  [x: string]: string | boolean | number | URL | object;
+  data: IFieldsInitialState;
+  validityState: IFormFieldsState;
+  dirtyFields: IFormFieldsState;
+  focusedField: string;
+  isDisabled: boolean;
+  isPending: boolean;
+  errorCount: number;
+  errorMessages: IErrorMessagesArr;
+  formFieldsC12: IFormFieldsC12;
+  formIsValid: boolean;
+  submitAttempted: boolean;
+  submitDisabled: boolean;
+  submitSuccess: boolean;
+  displayErrorMessages: boolean;
+  displayLoader: boolean;
+  submitSuccessful: boolean;
+}