@regle/core 0.6.1 → 0.7.0

package/dist/regle-core.mjs

@@ -2,7 +2,7 @@ import { toValue, version, ref, getCurrentScope, onScopeDispose, reactive, shall
 
 // ../shared/utils/isEmpty.ts
 function isEmpty(value) {
-  if (value === void 0 || value === null) {
+  if (value === undefined || value === null) {
     return true;
   }
   if (value instanceof Date) {
@@ -308,7 +308,7 @@ function useStorage() {
   }
   function checkRuleDeclEntry($path, newRules) {
     const storedRulesDefs = ruleDeclStorage.value.get($path);
-    if (!storedRulesDefs) return void 0;
+    if (!storedRulesDefs) return undefined;
     const storedRules = storedRulesDefs;
     const isValidCache = areRulesChanged(newRules, storedRules);
     if (!isValidCache) return { valid: false };
@@ -403,7 +403,7 @@ function debounce(func, wait, immediate) {
   const debouncedFn = (...args) => new Promise((resolve) => {
     clearTimeout(timeout);
     timeout = setTimeout(() => {
-      timeout = void 0;
+      timeout = undefined;
       {
         Promise.resolve(func.apply(this, [...args])).then(resolve);
       }
@@ -411,7 +411,7 @@ function debounce(func, wait, immediate) {
   });
   debouncedFn.cancel = () => {
     clearTimeout(timeout);
-    timeout = void 0;
+    timeout = undefined;
   };
   return debouncedFn;
 }
@@ -473,10 +473,10 @@ function extractRulesErrors({
   field,
   silent = false
 }) {
-  return Object.entries(field.$rules ?? {}).map(([ruleKey, rule]) => {
+  return Object.entries(field.$rules ?? {}).map(([_, rule]) => {
     if (silent) {
       return rule.$message;
-    } else if (!rule.$valid && field.$dirty && !rule.$validating) {
+    } else if (!rule.$valid && field.$error && !rule.$validating) {
       return rule.$message;
     }
     return null;
@@ -486,10 +486,10 @@ function extractRulesErrors({
     } else {
       return acc?.concat(value);
     }
-  }, []).concat(field.$dirty ? field.$externalErrors ?? [] : []);
+  }, []).concat(field.$error ? field.$externalErrors ?? [] : []).concat(field.$error ? field.$schemaErrors ?? [] : []);
 }
 function extractRulesTooltips({ field }) {
-  return Object.entries(field.$rules ?? {}).map(([ruleKey, rule]) => rule.$tooltip).filter((tooltip) => !!tooltip).reduce((acc, value) => {
+  return Object.entries(field.$rules ?? {}).map(([_, rule]) => rule.$tooltip).filter((tooltip) => !!tooltip).reduce((acc, value) => {
     if (typeof value === "string") {
       return acc?.concat([value]);
     } else {
@@ -544,7 +544,7 @@ function createReactiveRuleStatus({
       });
       function computeRuleProcessor(key) {
         let result = "";
-        const customProcessor = customMessages ? customMessages[ruleKey]?.[key] : void 0;
+        const customProcessor = customMessages ? customMessages[ruleKey]?.[key] : undefined;
         if (customProcessor) {
           if (typeof customProcessor === "function") {
             result = customProcessor($defaultMetadata.value);
@@ -718,6 +718,8 @@ function createReactiveFieldStatus({
   storage,
   options,
   externalErrors,
+  schemaErrors,
+  schemaMode,
   onUnwatch,
   $isArray,
   initialState,
@@ -810,7 +812,7 @@ function createReactiveFieldStatus({
     }
     scopeState = scope.run(() => {
       const $dirty = ref(false);
-      const triggerPunishment = ref(false);
+      const triggerPunishment2 = ref(false);
       const $anyDirty = computed(() => $dirty.value);
       const $debounce2 = computed(() => {
         return $localOptions.value.$debounce;
@@ -866,16 +868,25 @@ function createReactiveFieldStatus({
         return $invalid.value && !$pending.value && $dirty.value;
       });
       const $errors = computed(() => {
-        if ($error.value) {
-          return extractRulesErrors({
-            field: {
-              $dirty: $dirty.value,
-              $externalErrors: externalErrors?.value,
-              $rules: $rules.value
-            }
-          });
-        }
-        return [];
+        return extractRulesErrors({
+          field: {
+            $error: $error.value,
+            $externalErrors: externalErrors?.value,
+            $schemaErrors: schemaErrors?.value,
+            $rules: $rules.value
+          }
+        });
+      });
+      const $silentErrors = computed(() => {
+        return extractRulesErrors({
+          field: {
+            $error: true,
+            $externalErrors: externalErrors?.value,
+            $schemaErrors: schemaErrors?.value,
+            $rules: $rules.value
+          },
+          silent: true
+        });
       });
       const $edited = computed(() => {
         if ($dirty.value) {
@@ -900,16 +911,6 @@ function createReactiveFieldStatus({
           }
         });
       });
-      const $silentErrors = computed(() => {
-        return extractRulesErrors({
-          field: {
-            $dirty: $dirty.value,
-            $externalErrors: externalErrors?.value,
-            $rules: $rules.value
-          },
-          silent: true
-        });
-      });
       const $ready = computed(() => {
         if (!$autoDirty2.value) {
           return !($invalid.value || $pending.value);
@@ -917,7 +918,7 @@ function createReactiveFieldStatus({
         return $anyDirty.value && !($invalid.value || $pending.value);
       });
       const $pending = computed(() => {
-        if (triggerPunishment.value || !$rewardEarly2.value) {
+        if (triggerPunishment2.value || !$rewardEarly2.value) {
           return Object.entries($rules.value).some(([key, ruleResult]) => {
             return ruleResult.$pending;
           });
@@ -925,11 +926,11 @@ function createReactiveFieldStatus({
         return false;
       });
       const $invalid = computed(() => {
-        if (externalErrors?.value?.length) {
+        if (externalErrors?.value?.length || schemaErrors?.value?.length) {
           return true;
-        } else if (isEmpty($rules.value)) {
+        } else if ($inactive.value) {
           return false;
-        } else if (!$rewardEarly2.value || $rewardEarly2.value && triggerPunishment.value) {
+        } else if (!$rewardEarly2.value || $rewardEarly2.value && triggerPunishment2.value) {
           return Object.entries($rules.value).some(([_, ruleResult]) => {
             return !ruleResult.$valid;
           });
@@ -938,7 +939,7 @@ function createReactiveFieldStatus({
       });
       const $name = computed(() => fieldName);
       const $inactive = computed(() => {
-        if (isEmpty($rules.value)) {
+        if (isEmpty($rules.value) && !schemaMode) {
           return true;
         }
         return false;
@@ -949,9 +950,13 @@ function createReactiveFieldStatus({
         } else if ($inactive.value) {
           return false;
         } else if ($dirty.value && !isEmpty(state.value) && !$validating2.value) {
-          return Object.values($rules.value).every((ruleResult) => {
-            return ruleResult.$valid && ruleResult.$active;
-          });
+          if (schemaMode) {
+            return !schemaErrors?.value?.length;
+          } else {
+            return Object.values($rules.value).every((ruleResult) => {
+              return ruleResult.$valid && ruleResult.$active;
+            });
+          }
         }
         return false;
       });
@@ -999,7 +1004,7 @@ function createReactiveFieldStatus({
       const $shortcuts2 = {};
       watch($invalid, (value) => {
         if (!value) {
-          triggerPunishment.value = false;
+          triggerPunishment2.value = false;
         }
       });
       return {
@@ -1024,7 +1029,7 @@ function createReactiveFieldStatus({
         $validating: $validating2,
         $tooltips,
         $dirty,
-        triggerPunishment,
+        triggerPunishment: triggerPunishment2,
         processShortcuts,
         $silentValue,
         $inactive
@@ -1107,7 +1112,9 @@ function createReactiveFieldStatus({
       } else if (scopeState.$autoDirty.value && scopeState.$dirty.value && !scopeState.$pending.value) {
         return { result: !scopeState.$error.value, data };
       }
-      if (isEmpty($rules.value)) {
+      if (schemaMode) {
+        return { result: !schemaErrors?.value?.length, data };
+      } else if (isEmpty($rules.value)) {
         return { result: true, data };
       }
       const results = await Promise.allSettled(
@@ -1158,6 +1165,7 @@ function createReactiveFieldStatus({
     $haveAnyAsyncRule,
     $debounce,
     $lazy,
+    triggerPunishment,
     ...restScope
   } = scopeState;
   return reactive({
@@ -1186,9 +1194,11 @@ function createCollectionElement({
   customMessages,
   rules,
   externalErrors,
+  schemaErrors,
   initialState,
   shortcuts,
-  fieldName
+  fieldName,
+  schemaMode
 }) {
   const $fieldId = rules.$key ? rules.$key : randomId();
   let $path = `${path}.${String($fieldId)}`;
@@ -1206,6 +1216,8 @@ function createCollectionElement({
       $path = `${path}.${stateValue.value.$id}`;
     }
   }
+  const $externalErrors = toRef(externalErrors?.value ?? [], index);
+  const $schemaErrors = computed(() => schemaErrors?.value?.[index]);
   const $status = createReactiveChildrenStatus({
     state: stateValue,
     rulesDef: toRef(() => rules),
@@ -1213,10 +1225,12 @@ function createCollectionElement({
     path: $path,
     storage,
     options,
-    externalErrors: toRef(externalErrors?.value ?? [], index),
+    externalErrors: $externalErrors,
+    schemaErrors: $schemaErrors,
     initialState,
     shortcuts,
-    fieldName
+    fieldName,
+    schemaMode
   });
   if ($status) {
     const valueId = stateValue.value?.$id;
@@ -1235,6 +1249,8 @@ function createReactiveCollectionStatus({
   storage,
   options,
   externalErrors,
+  schemaErrors,
+  schemaMode,
   initialState,
   shortcuts,
   fieldName
@@ -1245,7 +1261,7 @@ function createReactiveCollectionStatus({
   let immediateScopeState;
   let collectionScopes = [];
   if (!Array.isArray(state.value) && !rulesDef.value.$each) {
-    return void 0;
+    return undefined;
   }
   const $id = ref();
   const $value = ref(state.value);
@@ -1298,6 +1314,8 @@ function createReactiveCollectionStatus({
           collectionScopes.push(scope2);
         }
         const initialStateRef = toRef(initialState.value ?? [], index);
+        const $externalErrors = toRef(externalErrors?.value ?? {}, `$each`);
+        const $schemaErrors = computed(() => schemaErrors?.value?.$each);
         const element = createCollectionElement({
           $id: $id.value,
           path,
@@ -1307,10 +1325,12 @@ function createReactiveCollectionStatus({
           index,
           options,
           storage,
-          externalErrors: toRef(externalErrors?.value ?? {}, `$each`),
+          externalErrors: $externalErrors,
+          schemaErrors: $schemaErrors,
           initialState: initialStateRef,
           shortcuts,
-          fieldName
+          fieldName,
+          schemaMode
         });
         if (element) {
           return element;
@@ -1328,10 +1348,12 @@ function createReactiveCollectionStatus({
       storage,
       options,
       externalErrors: toRef(externalErrors?.value ?? {}, `$self`),
+      schemaErrors: computed(() => schemaErrors?.value?.$self),
       $isArray: true,
       initialState,
       shortcuts,
-      fieldName
+      fieldName,
+      schemaMode
     });
   }
   function updateStatus() {
@@ -1351,26 +1373,28 @@ function createReactiveCollectionStatus({
           if (scope2) {
             collectionScopes.push(scope2);
           }
-          if (unwrapped) {
-            const element = createCollectionElement({
-              $id: $id.value,
-              path,
-              customMessages,
-              rules: unwrapped,
-              stateValue: currentValue,
-              index,
-              options,
-              storage,
-              externalErrors: toRef(externalErrors?.value ?? {}, `$each`),
-              initialState: toRef(initialState.value ?? [], index),
-              shortcuts,
-              fieldName
-            });
-            if (element) {
-              return element;
-            }
-            return null;
+          const $externalErrors = toRef(externalErrors?.value ?? {}, `$each`);
+          const $schemaErrors = computed(() => schemaErrors?.value?.$each ?? []);
+          const element = createCollectionElement({
+            $id: $id.value,
+            path,
+            customMessages,
+            rules: unwrapped ?? {},
+            stateValue: currentValue,
+            index,
+            options,
+            storage,
+            externalErrors: $externalErrors,
+            schemaErrors: $schemaErrors,
+            initialState: toRef(initialState.value ?? [], index),
+            shortcuts,
+            fieldName,
+            schemaMode
+          });
+          if (element) {
+            return element;
           }
+          return null;
         }
       }).filter((each) => !!each);
       previousStatus.filter(($each) => !state.value?.find((f) => $each.$id === f.$id)).forEach((_, index) => {
@@ -1626,6 +1650,8 @@ function createReactiveNestedStatus({
   path = "",
   rootRules,
   externalErrors,
+  schemaErrors,
+  rootSchemaErrors,
   validationGroups,
   initialState,
   fieldName,
@@ -1635,6 +1661,7 @@ function createReactiveNestedStatus({
   let scopeState;
   let nestedScopes = [];
   let $unwatchRules = null;
+  let $unwatchSchemaErrors = null;
   let $unwatchExternalErrors = null;
   let $unwatchState = null;
   async function createReactiveFieldsStatus(watchSources = true) {
@@ -1645,6 +1672,7 @@ function createReactiveNestedStatus({
           const stateRef = toRef(state.value ?? {}, statePropKey);
           const statePropRulesRef = toRef(() => statePropRules);
           const $externalErrors = toRef(externalErrors?.value ?? {}, statePropKey);
+          const $schemaErrors = computed(() => schemaErrors?.value?.[statePropKey]);
           const initialStateRef = toRef(initialState?.value ?? {}, statePropKey);
           return [
             statePropKey,
@@ -1653,6 +1681,7 @@ function createReactiveNestedStatus({
               rulesDef: statePropRulesRef,
               path: path ? `${path}.${statePropKey}` : statePropKey,
               externalErrors: $externalErrors,
+              schemaErrors: $schemaErrors,
               initialState: initialStateRef,
               fieldName: statePropKey,
               ...commonArgs
@@ -1665,6 +1694,8 @@ function createReactiveNestedStatus({
     const externalRulesStatus = Object.fromEntries(
       Object.entries(unref(externalErrors) ?? {}).filter(([key, errors]) => !(key in rulesDef.value) && !!errors).map(([key]) => {
         const stateRef = toRef(state.value ?? {}, key);
+        const $externalErrors = toRef(externalErrors?.value ?? {}, key);
+        const $schemaErrors = computed(() => schemaErrors?.value?.[key]);
         const initialStateRef = toRef(initialState?.value ?? {}, key);
         return [
           key,
@@ -1672,7 +1703,29 @@ function createReactiveNestedStatus({
             state: stateRef,
             rulesDef: computed(() => ({})),
             path: path ? `${path}.${key}` : key,
-            externalErrors: toRef(externalErrors?.value ?? {}, key),
+            externalErrors: $externalErrors,
+            schemaErrors: $schemaErrors,
+            initialState: initialStateRef,
+            fieldName: key,
+            ...commonArgs
+          })
+        ];
+      })
+    );
+    const schemasRulesStatus = Object.fromEntries(
+      Object.entries(unref(schemaErrors) ?? {}).map(([key]) => {
+        const stateRef = toRef(state.value ?? {}, key);
+        const $externalErrors = toRef(externalErrors?.value ?? {}, key);
+        const $schemaErrors = computed(() => schemaErrors?.value?.[key]);
+        const initialStateRef = toRef(initialState?.value ?? {}, key);
+        return [
+          key,
+          createReactiveChildrenStatus({
+            state: stateRef,
+            rulesDef: computed(() => ({})),
+            path: path ? `${path}.${key}` : key,
+            externalErrors: $externalErrors,
+            schemaErrors: $schemaErrors,
             initialState: initialStateRef,
             fieldName: key,
             ...commonArgs
@@ -1681,8 +1734,12 @@ function createReactiveNestedStatus({
       })
     );
     const statesWithNoRules = Object.fromEntries(
-      Object.entries(state.value ?? {}).filter(([key]) => !(key in rulesDef.value) && !(key in (externalRulesStatus.value ?? {}))).map(([key]) => {
+      Object.entries(state.value ?? {}).filter(
+        ([key]) => !(key in rulesDef.value) && !(key in (externalRulesStatus ?? {})) && !(key in (schemasRulesStatus ?? {}))
+      ).map(([key]) => {
         const stateRef = toRef(state.value ?? {}, key);
+        const $externalErrors = toRef(externalErrors?.value ?? {}, key);
+        const $schemaErrors = computed(() => schemaErrors?.value?.[key]);
         const initialStateRef = toRef(initialState?.value ?? {}, key);
         return [
           key,
@@ -1690,7 +1747,8 @@ function createReactiveNestedStatus({
             state: stateRef,
             rulesDef: computed(() => ({})),
             path: path ? `${path}.${key}` : key,
-            externalErrors: toRef(externalErrors?.value ?? {}, key),
+            externalErrors: $externalErrors,
+            schemaErrors: $schemaErrors,
             initialState: initialStateRef,
             fieldName: key,
             ...commonArgs
@@ -1701,6 +1759,7 @@ function createReactiveNestedStatus({
     $fields.value = {
       ...scopedRulesStatus,
       ...externalRulesStatus,
+      ...schemasRulesStatus,
       ...statesWithNoRules
     };
     if (watchSources) {
@@ -1723,7 +1782,7 @@ function createReactiveNestedStatus({
     });
   }
   function define$WatchExternalErrors() {
-    if (externalErrors?.value) {
+    if (externalErrors) {
       $unwatchExternalErrors = watch(
         externalErrors,
         () => {
@@ -1758,6 +1817,17 @@ function createReactiveNestedStatus({
       );
       define$WatchExternalErrors();
     }
+    if (rootSchemaErrors) {
+      $unwatchSchemaErrors?.();
+      $unwatchSchemaErrors = watch(
+        rootSchemaErrors,
+        () => {
+          $unwatch();
+          createReactiveFieldsStatus();
+        },
+        { deep: true, flush: "post" }
+      );
+    }
     define$watchState();
     scope = effectScope();
     scopeState = scope.run(() => {
@@ -1819,8 +1889,9 @@ function createReactiveNestedStatus({
         }
         return $anyDirty.value && !($invalid.value || $pending.value);
       });
+      const $localPending2 = ref(false);
       const $pending = computed(() => {
-        return Object.entries($fields.value).some(([key, statusOrField]) => {
+        return $localPending2.value || Object.entries($fields.value).some(([key, statusOrField]) => {
           return statusOrField?.$pending;
         });
       });
@@ -1932,7 +2003,8 @@ function createReactiveNestedStatus({
         $groups,
         $silentValue,
         $edited,
-        $anyEdited
+        $anyEdited,
+        $localPending: $localPending2
       };
     });
   }
@@ -1982,25 +2054,37 @@ function createReactiveNestedStatus({
   }
   async function $validate() {
     try {
-      const data = state.value;
-      const results = await Promise.allSettled(
-        Object.values($fields.value).map((statusOrField) => {
-          return statusOrField.$validate();
-        })
-      );
-      const validationResults = results.every((value) => {
-        if (value.status === "fulfilled") {
-          return value.value.result === true;
+      if (commonArgs.schemaMode) {
+        if (commonArgs.onValidate) {
+          $touch(false);
+          scopeState.$localPending.value = true;
+          return commonArgs.onValidate();
         } else {
-          return false;
+          return { result: false, data: state.value };
         }
-      });
-      return { result: validationResults, data };
+      } else {
+        const data = state.value;
+        const results = await Promise.allSettled(
+          Object.values($fields.value).map((statusOrField) => {
+            return statusOrField.$validate();
+          })
+        );
+        const validationResults = results.every((value) => {
+          if (value.status === "fulfilled") {
+            return value.value.result === true;
+          } else {
+            return false;
+          }
+        });
+        return { result: validationResults, data };
+      }
     } catch (e) {
       return { result: false, data: state.value };
+    } finally {
+      scopeState.$localPending.value = false;
     }
   }
-  const { $shortcuts, ...restScopeState } = scopeState;
+  const { $shortcuts, $localPending, ...restScopeState } = scopeState;
   return reactive({
     ...restScopeState,
     ...$shortcuts,
@@ -2018,20 +2102,17 @@ function createReactiveNestedStatus({
 }
 function createReactiveChildrenStatus({
   rulesDef,
-  externalErrors,
   ...properties
 }) {
   if (isCollectionRulesDef(rulesDef, properties.state)) {
     return createReactiveCollectionStatus({
       rulesDef,
-      externalErrors,
       ...properties
     });
   } else if (isNestedRulesDef(properties.state, rulesDef)) {
     if (isRefObject(properties.state)) {
       return createReactiveNestedStatus({
         rulesDef,
-        externalErrors,
         ...properties
       });
     } else {
@@ -2057,7 +2138,6 @@ function createReactiveChildrenStatus({
       const { state, ...restProperties } = properties;
       return createReactiveNestedStatus({
         rulesDef,
-        externalErrors,
         ...restProperties,
         state: scopeState.fakeState
       });
@@ -2065,11 +2145,10 @@ function createReactiveChildrenStatus({
   } else if (isValidatorRulesDef(rulesDef)) {
     return createReactiveFieldStatus({
       rulesDef,
-      externalErrors,
       ...properties
     });
   }
-  return void 0;
+  return undefined;
 }
 
 // src/core/useRegle/root/useRootStorage.ts
@@ -2079,7 +2158,10 @@ function useRootStorage({
   scopeRules,
   state,
   customRules,
-  shortcuts
+  shortcuts,
+  schemaErrors,
+  schemaMode = false,
+  onValidate
 }) {
   const storage = useStorage();
   const regle = ref();
@@ -2095,7 +2177,11 @@ function useRootStorage({
     initialState,
     shortcuts,
     fieldName: "root",
-    path: ""
+    path: "",
+    schemaErrors,
+    rootSchemaErrors: schemaErrors,
+    schemaMode,
+    onValidate
   });
   if (getCurrentScope()) {
     onScopeDispose(() => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@regle/core",
-  "version": "0.6.1",
+  "version": "0.7.0",
   "description": "Type safe form validation library for Vue 3",
   "peerDependencies": {
     "vue": "^3.3.0"
@@ -89,6 +89,7 @@
   "scripts": {
     "typecheck": "tsc --noEmit",
     "build": "tsup",
+    "build:dev": "tsup --config=tsup.dev.ts",
     "build:sourcemaps": "tsup --config=tsup.sourcemap.ts",
     "dev": "tsup --config=tsup.dev.ts --watch",
     "test": "echo 'no tests'"