feat: mark form values as readonly closes #4282

logaretm · May 31, 2023 · 05d957e · 05d957e
1 parent 7ce9d67
commit 05d957e
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 1 deletion.
diff --git a/.changeset/small-ladybugs-relate.md b/.changeset/small-ladybugs-relate.md
@@ -0,0 +1,5 @@
+---
+'vee-validate': minor
+---
+
+feat: mark form values as readonly closes #4282
diff --git a/packages/vee-validate/src/types/forms.ts b/packages/vee-validate/src/types/forms.ts
@@ -1,4 +1,4 @@
-import { ComputedRef, Ref } from 'vue';
+import { ComputedRef, DeepReadonly, Ref } from 'vue';
 import { MapValuesPathsToRefs, MaybeRef, GenericObject, MaybeRefOrLazy } from './common';
 import { FieldValidationMetaInfo } from '../../../shared';
 import { Path, PathValue } from './paths';
@@ -320,7 +320,9 @@ export interface FormContext<TValues extends GenericObject = GenericObject, TOut
     | 'fieldArrays'
     | 'markForUnmount'
     | 'keepValuesOnUnmount'
+    | 'values'
   > {
+  values: DeepReadonly<TValues>;
   handleReset: () => void;
   submitForm: (e?: unknown) => Promise<void>;
   defineComponentBinds<

diff --git a/packages/vee-validate/src/useForm.ts b/packages/vee-validate/src/useForm.ts
@@ -12,6 +12,7 @@ import {
   warn,
   watchEffect,
   shallowRef,
+  readonly,
 } from 'vue';
 import { klona as deepCopy } from 'klona/full';
 import {
@@ -965,6 +966,7 @@ export function useForm<
 
   return {
     ...formCtx,
+    values: readonly(formValues),
     handleReset: () => resetForm(),
     submitForm,
     defineComponentBinds,