feat: deprecate the 'required' flag

logaretm · May 11, 2020 · 283caa0 · 283caa0
1 parent 7af3ed2
commit 283caa0
Show file tree

Hide file tree

Showing 6 changed files with 12 additions and 10 deletions.
diff --git a/packages/core/src/Observer.ts b/packages/core/src/Observer.ts
@@ -1,7 +1,7 @@
 import { computed, provide, h, defineComponent } from 'vue';
 import { normalizeChildren } from './utils/vnode';
 import { useForm } from './useForm';
-import { ValidationFlags, SubmissionHandler } from './types';
+import { ValidationFlags, SubmissionHandler, Flag } from './types';
 
 export const ValidationObserver = defineComponent({
   name: 'ValidationObserver',
@@ -24,7 +24,7 @@ export const ValidationObserver = defineComponent({
     provide('$_veeObserver', form);
     const unwrappedMeta = computed(() =>
       Object.keys(meta).reduce((acc: ValidationFlags, key) => {
-        acc[key] = (meta as any)[key].value;
+        acc[key as Flag] = meta[key as Flag].value;
 
         return acc;
       }, {} as ValidationFlags)

diff --git a/packages/core/src/Provider.ts b/packages/core/src/Provider.ts
@@ -63,7 +63,7 @@ export const ValidationProvider = defineComponent({
 
     const unwrappedMeta = computed(() => {
       return Object.keys(meta).reduce((acc, key) => {
-        acc[key] = meta[key as Flag].value;
+        acc[key as Flag] = meta[key as Flag].value;
 
         return acc;
       }, {} as ValidationFlags);

diff --git a/packages/core/src/types.ts b/packages/core/src/types.ts
@@ -45,9 +45,7 @@ export interface ValidationFlags {
   failed: boolean;
   validated: boolean;
   pending: boolean;
-  required: boolean;
   changed: boolean;
-  [x: string]: boolean | undefined;
 }
 
 export interface VeeObserver {
@@ -74,7 +72,6 @@ export type Flag =
   | 'failed'
   | 'validated'
   | 'pending'
-  | 'required'
   | 'changed';
 
 export interface FieldComposite {

diff --git a/packages/core/src/useField.ts b/packages/core/src/useField.ts
@@ -1,6 +1,13 @@
 import { watch, ref, Ref, isRef, reactive, computed, onMounted, toRefs, watchEffect } from 'vue';
 import { validate } from './validate';
-import { FormController, ValidationResult, MaybeReactive, FieldComposite, GenericValidateFunction } from './types';
+import {
+  FormController,
+  ValidationResult,
+  MaybeReactive,
+  FieldComposite,
+  GenericValidateFunction,
+  Flag,
+} from './types';
 import { createFlags, normalizeRules, extractLocators } from './utils';
 import { normalizeEventValue } from './utils/events';
 import { unwrap } from './utils/refs';
@@ -222,7 +229,7 @@ function useMeta() {
         return;
       }
 
-      flags[key] = defaults[key];
+      flags[key as Flag] = defaults[key as Flag];
     });
   }
 

diff --git a/packages/core/src/useForm.ts b/packages/core/src/useForm.ts
@@ -14,7 +14,6 @@ const mergeStrategies: Record<Flag, 'every' | 'some'> = {
   changed: 'some',
   passed: 'every',
   failed: 'some',
-  required: 'some',
 };
 
 function computeMeta(fields: Ref<any[]>) {

diff --git a/packages/core/src/utils/factories.ts b/packages/core/src/utils/factories.ts
@@ -10,7 +10,6 @@ export function createFlags(): ValidationFlags {
     invalid: false,
     validated: false,
     pending: false,
-    required: false,
     changed: false,
     passed: false,
     failed: false,