@regle/schemas 1.2.0-beta.3 → 1.2.0-beta.4

package/README.md

@@ -27,7 +27,7 @@ It's heavily inspired by Vuelidate.
 - 🧰 Modular
 - 🔄 Async validation
 - 🌐 Plug any i18n library
-- 📗 Vuelidate compatible API
+- 📗 Vuelidate like API
 - Standard Schemas spec support
   - 🦸‍♂️ [Zod](https://zod.dev/)
   - 🤖 [Valibot](https://valibot.dev/)

package/dist/regle-schemas.d.ts

@@ -1,6 +1,7 @@
-import { Maybe, PrimitiveTypes, RegleShortcutDefinition, RegleCommonStatus, RegleRuleStatus, JoinDiscriminatedUnions, RegleCollectionErrors, RegleErrorTree, DeepReactiveState, NoInferLegacy, RegleBehaviourOptions } from '@regle/core';
+import * as _regle_core from '@regle/core';
+import { Maybe, PrimitiveTypes, RegleShortcutDefinition, RegleCommonStatus, RegleRuleStatus, JoinDiscriminatedUnions, RegleCollectionErrors, RegleErrorTree, DeepReactiveState, DeepMaybeRef, RegleBehaviourOptions, LocalRegleBehaviourOptions, NoInferLegacy, ScopedInstancesRecordLike, MergedScopedRegles } from '@regle/core';
 import { StandardSchemaV1 } from '@standard-schema/spec';
-import { Raw, MaybeRef, UnwrapNestedRefs } from 'vue';
+import { Raw, MaybeRef, UnwrapNestedRefs, MaybeRefOrGetter, Ref } from 'vue';
 
 /**
 Matches any [primitive value](https://developer.mozilla.org/en-US/docs/Glossary/Primitive).
@@ -729,15 +730,15 @@ type PartialObjectDeep<ObjectType extends object, Options extends Required<Parti
 		[KeyType in keyof ObjectType]?: _PartialDeep<ObjectType[KeyType], Options>
 	});
 
-interface RegleSchema<TState extends Record<string, any>, TSchema extends Record<string, any>, TShortcuts extends RegleShortcutDefinition = {}> {
+type RegleSchema<TState extends Record<string, any>, TSchema extends Record<string, any>, TShortcuts extends RegleShortcutDefinition = {}, TAdditionalReturnProperties extends Record<string, any> = {}> = {
     /**
      * r$ is a reactive object containing the values, errors, dirty state and all the necessary validations properties you'll need to display information.
      *
      * To see the list of properties: {@link https://reglejs.dev/core-concepts/validation-properties}
      */
     r$: Raw<RegleSchemaStatus<TState, TSchema, TShortcuts, true>>;
-}
-interface RegleSingleFieldSchema<TState extends Maybe<PrimitiveTypes>, TSchema extends unknown, TShortcuts extends RegleShortcutDefinition = {}> {
+} & TAdditionalReturnProperties;
+type RegleSingleFieldSchema<TState extends Maybe<PrimitiveTypes>, TSchema extends unknown, TShortcuts extends RegleShortcutDefinition = {}, TAdditionalReturnProperties extends Record<string, any> = {}> = {
     /**
      * r$ is a reactive object containing the values, errors, dirty state and all the necessary validations properties you'll need to display information.
      *
@@ -747,7 +748,7 @@ interface RegleSingleFieldSchema<TState extends Maybe<PrimitiveTypes>, TSchema e
         /** Sets all properties as dirty, triggering all rules. It returns a promise that will either resolve to false or a type safe copy of your form state. Values that had the required rule will be transformed into a non-nullable value (type only). */
         $validate: () => Promise<RegleSchemaResult<TSchema>>;
     }>;
-}
+} & TAdditionalReturnProperties;
 type RegleSchemaResult<TSchema extends unknown> = {
     valid: false;
     data: PartialDeep<TSchema>;
@@ -826,12 +827,28 @@ type RegleSchemaCollectionStatus<TSchema extends Record<string, any>, TState ext
     [K in keyof TShortcuts['collections']]: ReturnType<NonNullable<TShortcuts['collections']>[K]>;
 });
 
-interface useRegleSchemaFn<TShortcuts extends RegleShortcutDefinition<any> = never> {
+type RegleSchemaBehaviourOptions = {
+    /**
+     * Settings for applying transforms and default to the current state
+     */
+    syncState?: {
+        /**
+         * Applies every transform on every update to the state
+         */
+        onUpdate?: boolean;
+        /**
+         * Applies every transform only when calling `$validate`
+         */
+        onValidate?: boolean;
+    };
+};
+
+interface useRegleSchemaFn<TShortcuts extends RegleShortcutDefinition<any> = never, TAdditionalReturnProperties extends Record<string, any> = {}, TAdditionalOptions extends Record<string, any> = {}> {
     <TSchema extends StandardSchemaV1, TState extends StandardSchemaV1.InferInput<TSchema> | undefined>(state: MaybeRef<PartialDeep<TState, {
         recurseIntoArrays: true;
     }>> | DeepReactiveState<PartialDeep<TState, {
         recurseIntoArrays: true;
-    }>>, rulesFactory: MaybeRef<TSchema>): NonNullable<TState> extends PrimitiveTypes ? RegleSingleFieldSchema<NonNullable<TState>, StandardSchemaV1.InferInput<TSchema>, TShortcuts> : RegleSchema<UnwrapNestedRefs<NonNullable<TState>>, UnwrapNestedRefs<NonNullable<StandardSchemaV1.InferInput<TSchema>>>, TShortcuts>;
+    }>>, rulesFactory: MaybeRef<TSchema>, options?: Omit<Partial<DeepMaybeRef<RegleBehaviourOptions>> & LocalRegleBehaviourOptions<Record<string, any>, {}, never>, 'validationGroups' | 'lazy' | 'rewardEarly' | 'silent'> & RegleSchemaBehaviourOptions & TAdditionalOptions): NonNullable<TState> extends PrimitiveTypes ? RegleSingleFieldSchema<NonNullable<TState>, StandardSchemaV1.InferInput<TSchema>, TShortcuts, TAdditionalReturnProperties> : RegleSchema<UnwrapNestedRefs<NonNullable<TState>>, UnwrapNestedRefs<NonNullable<StandardSchemaV1.InferInput<TSchema>>>, TShortcuts, TAdditionalReturnProperties>;
 }
 /**
  * useRegle serves as the foundation for validation logic.
@@ -852,7 +869,7 @@ interface useRegleSchemaFn<TShortcuts extends RegleShortcutDefinition<any> = nev
  * ```
  * Docs: {@link https://reglejs.dev/integrations/valibot#usage}
  */
-declare const useRegleSchema: useRegleSchemaFn<RegleShortcutDefinition<any>>;
+declare const useRegleSchema: useRegleSchemaFn<RegleShortcutDefinition<any>, {}, {}>;
 
 /**
  *
@@ -906,4 +923,23 @@ declare function defineRegleSchemaConfig<TShortcuts extends RegleShortcutDefinit
     inferSchema: inferSchemaFn;
 };
 
-export { type InferRegleSchemaStatusType, type RegleSchema, type RegleSchemaCollectionStatus, type RegleSchemaFieldStatus, type RegleSchemaResult, type RegleSchemaStatus, type RegleSingleFieldSchema, defineRegleSchemaConfig, inferSchema, useRegleSchema, withDeps };
+declare const useCollectSchemaScope: <TValue extends Record<string, unknown>[] = Record<string, unknown>[]>(namespace?: MaybeRefOrGetter<string>) => {
+    r$: MergedScopedRegles<TValue>;
+};
+declare const useScopedRegleSchema: useRegleSchemaFn<_regle_core.RegleShortcutDefinition<any>, {}, {}>;
+declare const createScopedUseRegleSchema: <TCustomRegle extends useRegleSchemaFn = useRegleSchemaFn, TReturnedRegle extends useRegleSchemaFn = TCustomRegle extends useRegleSchemaFn<infer S> ? useRegleSchemaFn<S, {
+    dispose: () => void;
+    register: () => void;
+}, {
+    namespace?: MaybeRefOrGetter<string>;
+}> : useRegleSchemaFn>(options?: {
+    customUseRegle?: TCustomRegle;
+    customStore?: Ref<ScopedInstancesRecordLike>;
+}) => {
+    useScopedRegle: TReturnedRegle;
+    useCollectScope<TValue extends Record<string, unknown>[] = Record<string, unknown>[]>(namespace?: MaybeRefOrGetter<string>): {
+        r$: MergedScopedRegles<TValue>;
+    };
+};
+
+export { type InferRegleSchemaStatusType, type RegleSchema, type RegleSchemaBehaviourOptions, type RegleSchemaCollectionStatus, type RegleSchemaFieldStatus, type RegleSchemaResult, type RegleSchemaStatus, type RegleSingleFieldSchema, createScopedUseRegleSchema, defineRegleSchemaConfig, inferSchema, useCollectSchemaScope, useRegleSchema, useScopedRegleSchema, withDeps };

package/dist/regle-schemas.min.mjs

@@ -1 +1 @@
-import {useRootStorage}from'@regle/core';import {ref,computed,unref,isRef,watch}from'vue';function k(e){if(typeof e.source.flags=="string")return e.source.flags;{let t=[];return e.global&&t.push("g"),e.ignoreCase&&t.push("i"),e.multiline&&t.push("m"),e.sticky&&t.push("y"),e.unicode&&t.push("u"),t.join("")}}function f(e){let t=e,r={}.toString.call(e).slice(8,-1);if(r=="Set"&&(t=new Set([...e].map(a=>f(a)))),r=="Map"&&(t=new Map([...e].map(a=>[f(a[0]),f(a[1])]))),r=="Date"&&(t=new Date(e.getTime())),r=="RegExp"&&(t=RegExp(e.source,k(e))),r=="Array"||r=="Object"){t=Array.isArray(e)?[]:{};for(let a in e)t[a]=f(e[a]);}return t}function S(e){return e&&(e instanceof Date||e.constructor.name=="File"||e.constructor.name=="FileList")?false:typeof e=="object"&&e!==null&&!Array.isArray(e)}function v(e,t,r,a){var n,o;if(Array.isArray(t)&&(n=t.slice(0)),typeof t=="string"&&(n=t.split(".")),typeof t=="symbol"&&(n=[t]),!Array.isArray(n))throw new Error("props arg must be an array, a string or a symbol");if(o=n.pop(),!o)return  false;w(o);for(var s;s=n.shift();)if(w(s),isNaN(parseInt(s))?(typeof e[s]>"u"&&(e[s]={}),e=e[s]):((e.$each??=[])[s]={},e=e.$each[s]),!e||typeof e!="object")return  false;return a?e[o]?e[o].$self=(e[o].$self??=[]).concat(r):e[o]={...e[o],$self:r}:Array.isArray(e[o])?e[o]=e[o].concat(r):e[o]=r,true}function b(e,t,r){if(!e)return r;var a,n;if(Array.isArray(t)&&(a=t.slice(0)),typeof t=="string"&&(a=t.split(".")),typeof t=="symbol"&&(a=[t]),!Array.isArray(a))throw new Error("props arg must be an array, a string or a symbol");for(;a.length;)if(n=a.shift(),!e||!n||(e=e[n],e===void 0))return r;return e}function w(e){if(e=="__proto__"||e=="constructor"||e=="prototype")throw new Error("setting of prototype values not supported")}function g(e,t){let r={autoDirty:e?.autoDirty,lazy:e?.lazy,rewardEarly:e?.rewardEarly,silent:e?.silent,clearExternalErrorsOnChange:e?.clearExternalErrorsOnChange};function a(n,o,s){let I=ref({}),p=computed(()=>unref(o)),A={...r,...s},M=computed(()=>!S(l.value)),l=isRef(n)?n:ref(n),C=ref(S(l.value)?{...f(l.value)}:f(l.value)),y=ref({}),T;if(!p.value?.["~standard"])throw new Error('Only "standard-schema" compatible libraries are supported');function V(i){let u={};return i.issues&&i.issues.map(c=>{let x=c.path?.map(d=>typeof d=="object"?d.key:d.toString()).join(".")??"",h=c.path?.[c.path.length-1],B=(typeof h=="object"&&"value"in h?Array.isArray(h.value):false)||("type"in c?c.type==="array":false)||Array.isArray(b(l.value,x));return {path:x,message:c.message,isArray:B}}).forEach(c=>{v(u,c.path,[c.message],c.isArray);}),u}async function D(){let i=p.value["~standard"].validate(l.value);return i instanceof Promise&&(i=await i),M.value?y.value=i.issues?.map(u=>u.message)??[]:y.value=V(i),i}return watch([l,p],D,{deep:true,immediate:true}),T=async()=>{try{return {valid:!(await D()).issues?.length,data:l.value}}catch(i){return Promise.reject(i)}},{r$:useRootStorage({scopeRules:I,state:l,options:A,schemaErrors:y,initialState:C,shortcuts:t,schemaMode:true,onValidate:T}).regle}}return a}var P=g();function F(e,t){return e}function R(){function e(t,r){return r}return e}var E=R();function N({modifiers:e,shortcuts:t}){let r=g(e,t),a=R();return {useRegleSchema:r,inferSchema:a}}export{N as defineRegleSchemaConfig,E as inferSchema,P as useRegleSchema,F as withDeps};
+import {createScopedUseRegle,useRootStorage}from'@regle/core';import {computed,unref,ref,isRef,watch}from'vue';function q(e){if(typeof e.source.flags=="string")return e.source.flags;{let t=[];return e.global&&t.push("g"),e.ignoreCase&&t.push("i"),e.multiline&&t.push("m"),e.sticky&&t.push("y"),e.unicode&&t.push("u"),t.join("")}}function p(e){let t=e,r={}.toString.call(e).slice(8,-1);if(r=="Set"&&(t=new Set([...e].map(a=>p(a)))),r=="Map"&&(t=new Map([...e].map(a=>[p(a[0]),p(a[1])]))),r=="Date"&&(t=new Date(e.getTime())),r=="RegExp"&&(t=RegExp(e.source,q(e))),r=="Array"||r=="Object"){t=Array.isArray(e)?[]:{};for(let a in e)t[a]=p(e[a]);}return t}function g(e){return e&&(e instanceof Date||e.constructor.name=="File"||e.constructor.name=="FileList")?false:typeof e=="object"&&e!==null&&!Array.isArray(e)}function E(e,t,r,a){var n,o;if(Array.isArray(t)&&(n=t.slice(0)),typeof t=="string"&&(n=t.split(".")),typeof t=="symbol"&&(n=[t]),!Array.isArray(n))throw new Error("props arg must be an array, a string or a symbol");if(o=n.pop(),!o)return  false;P(o);for(var i;i=n.shift();)if(P(i),isNaN(parseInt(i))?(typeof e[i]>"u"&&(e[i]={}),e=e[i]):((e.$each??=[])[i]={},e=e.$each[i]),!e||typeof e!="object")return  false;return a?e[o]?e[o].$self=(e[o].$self??=[]).concat(r):e[o]={...e[o],$self:r}:Array.isArray(e[o])?e[o]=e[o].concat(r):e[o]=r,true}function I(e,t,r){if(!e)return r;var a,n;if(Array.isArray(t)&&(a=t.slice(0)),typeof t=="string"&&(a=t.split(".")),typeof t=="symbol"&&(a=[t]),!Array.isArray(a))throw new Error("props arg must be an array, a string or a symbol");for(;a.length;)if(n=a.shift(),!e||!n||(e=e[n],e===void 0))return r;return e}function P(e){if(e=="__proto__"||e=="constructor"||e=="prototype")throw new Error("setting of prototype values not supported")}function x(e,t){let r={autoDirty:e?.autoDirty,lazy:e?.lazy,rewardEarly:e?.rewardEarly,clearExternalErrorsOnChange:e?.clearExternalErrorsOnChange};function a(n,o,i){let m=computed(()=>unref(o)),{syncState:k={onUpdate:false,onValidate:false},...L}=i??{},{onUpdate:$=false,onValidate:z=false}=k,G={...r,...L},H=computed(()=>!g(c.value)),c=isRef(n)?n:ref(n),W=ref(g(c.value)?{...p(c.value)}:p(c.value)),y=ref({}),v;if(!m.value?.["~standard"])throw new Error('Only "standard-schema" compatible libraries are supported');function _(u){let s={};return u.issues&&u.issues.map(l=>{let F=l.path?.map(h=>typeof h=="object"?h.key:h.toString()).join(".")??"",S=l.path?.[l.path.length-1],J=(typeof S=="object"&&"value"in S?Array.isArray(S.value):false)||("type"in l?l.type==="array":false)||Array.isArray(I(c.value,F));return {path:F,message:l.message,isArray:J}}).forEach(l=>{E(s,l.path,[l.message],l.isArray);}),s}async function d(u=false){let s=m.value["~standard"].validate(c.value);return s instanceof Promise&&(s=await s),H.value?y.value=s.issues?.map(b=>b.message)??[]:y.value=_(s),s.issues||(u&&z||!u&&$)&&(w?.(),c.value=s.value,O()),s}let w;function O(){w=watch([c,m],()=>d(),{deep:true});}return O(),d(),v=async()=>{try{return {valid:!(await d(!0)).issues?.length,data:c.value}}catch(u){return Promise.reject(u)}},{r$:useRootStorage({scopeRules:computed(()=>({})),state:c,options:G,schemaErrors:y,initialState:W,shortcuts:t,schemaMode:true,onValidate:v}).regle}}return a}var f=x();function A(e,t){return e}function D(){function e(t,r){return r}return e}var C=D();function N({modifiers:e,shortcuts:t}){let r=x(e,t),a=D();return {useRegleSchema:r,inferSchema:a}}var {useCollectScope:U,useScopedRegle:B}=createScopedUseRegle({customUseRegle:f}),V=e=>{let{customStore:t,customUseRegle:r=f}=e??{};return createScopedUseRegle({customStore:t,customUseRegle:r})};export{V as createScopedUseRegleSchema,N as defineRegleSchemaConfig,C as inferSchema,U as useCollectSchemaScope,f as useRegleSchema,B as useScopedRegleSchema,A as withDeps};

package/dist/regle-schemas.mjs

@@ -1,5 +1,5 @@
-import { useRootStorage } from '@regle/core';
-import { ref, computed, unref, isRef, watch } from 'vue';
+import { createScopedUseRegle, useRootStorage } from '@regle/core';
+import { computed, unref, ref, isRef, watch } from 'vue';
 
 // src/core/useRegleSchema.ts
 
@@ -142,15 +142,15 @@ function createUseRegleSchemaComposable(options, shortcuts) {
     autoDirty: options?.autoDirty,
     lazy: options?.lazy,
     rewardEarly: options?.rewardEarly,
-    silent: options?.silent,
     clearExternalErrorsOnChange: options?.clearExternalErrorsOnChange
   };
   function useRegleSchema2(state, schema, options2) {
-    const convertedRules = ref({});
     const computedSchema = computed(() => unref(schema));
+    const { syncState = { onUpdate: false, onValidate: false }, ...defaultOptions } = options2 ?? {};
+    const { onUpdate: syncOnUpdate = false, onValidate: syncOnValidate = false } = syncState;
     const resolvedOptions = {
       ...globalOptions,
-      ...options2
+      ...defaultOptions
     };
     const isSingleField = computed(() => !isObject(processedState.value));
     const processedState = isRef(state) ? state : ref(state);
@@ -181,7 +181,7 @@ function createUseRegleSchemaComposable(options, shortcuts) {
       }
       return output;
     }
-    async function computeErrors() {
+    async function computeErrors(isValidate = false) {
       let result = computedSchema.value["~standard"].validate(processedState.value);
       if (result instanceof Promise) {
         result = await result;
@@ -191,12 +191,24 @@ function createUseRegleSchemaComposable(options, shortcuts) {
       } else {
         customErrors.value = issuesToRegleErrors(result);
       }
+      if (!result.issues) {
+        if (isValidate && syncOnValidate || !isValidate && syncOnUpdate) {
+          unWatchState?.();
+          processedState.value = result.value;
+          defineWatchState();
+        }
+      }
       return result;
     }
-    watch([processedState, computedSchema], computeErrors, { deep: true, immediate: true });
+    let unWatchState;
+    function defineWatchState() {
+      unWatchState = watch([processedState, computedSchema], () => computeErrors(), { deep: true });
+    }
+    defineWatchState();
+    computeErrors();
     onValidate = async () => {
       try {
-        const result = await computeErrors();
+        const result = await computeErrors(true);
         return {
           valid: !result.issues?.length,
           data: processedState.value
@@ -206,7 +218,7 @@ function createUseRegleSchemaComposable(options, shortcuts) {
       }
     };
     const regle = useRootStorage({
-      scopeRules: convertedRules,
+      scopeRules: computed(() => ({})),
       state: processedState,
       options: resolvedOptions,
       schemaErrors: customErrors,
@@ -242,5 +254,12 @@ function defineRegleSchemaConfig({
   const inferSchema2 = createInferSchemaHelper();
   return { useRegleSchema: useRegleSchema2, inferSchema: inferSchema2 };
 }
+var { useCollectScope: useCollectSchemaScope, useScopedRegle: useScopedRegleSchema } = createScopedUseRegle({
+  customUseRegle: useRegleSchema
+});
+var createScopedUseRegleSchema = (options) => {
+  const { customStore, customUseRegle = useRegleSchema } = options ?? {};
+  return createScopedUseRegle({ customStore, customUseRegle });
+};
 
-export { defineRegleSchemaConfig, inferSchema, useRegleSchema, withDeps };
+export { createScopedUseRegleSchema, defineRegleSchemaConfig, inferSchema, useCollectSchemaScope, useRegleSchema, useScopedRegleSchema, withDeps };

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "@regle/schemas",
-  "version": "1.2.0-beta.3",
+  "version": "1.2.0-beta.4",
   "description": "Schemas adapter for Regle",
   "dependencies": {
     "@standard-schema/spec": "1.0.0",
-    "@regle/core": "1.2.0-beta.3",
-    "@regle/rules": "1.2.0-beta.3"
+    "@regle/core": "1.2.0-beta.4",
+    "@regle/rules": "1.2.0-beta.4"
   },
   "peerDependencies": {
     "valibot": "^1.0.0",