vuelidify 2.1.1 → 2.2.0

package/README.md

@@ -377,28 +377,37 @@ Note, your properties may show up in the intellisense for `state`, but they are
 Here are the validators that Vuelidify provides by default:
 
 - 	```ts
-	required()
+	required(message?: string)
+	```
+-	```ts
+	notEmpty(message?: string)
 	```
 - 	```ts
-	minLength(min: number)
+	minLength(min: number, message?: string)
 	```
 - 	```ts
-	maxLength(max: number)
+	maxLength(max: number, message?: string)
+	```
+-	```ts
+	minNumber(min: number, message?: string)
+	```
+-	```ts
+	exclusiveMinNumber(min: number, message?: string)
 	```
 -	```ts
-	minNumber(min: number)
+	maxNumber(max: number, message?: string)
 	```
 -	```ts
-	maxNumber(max: number)
+	exclusiveMaxNumber(max: number, message?: string)
 	```
 -	```ts
-	must(fn: (params) => boolean, errorMessage: string)
+	must(fn: (params) => boolean, message: string)
 	```
 -	```ts
 	validateIf(predicate: (params) => boolean | Promise<boolean>, validators: Validator[])
 	```
 -	```ts
-	isEmailSync()
+	isEmailSync(message?: string)
 	```
 
 There aren't many validators provided by this library on purpose. If you feel a validator would be useful for everyone to have, give us feedback on our GitHub repository. However, we highly encourage you to understand how to make your own!
@@ -406,12 +415,13 @@ There aren't many validators provided by this library on purpose. If you feel a
 # Custom Validators
 This section guides you to create your own generic validators. Validators were designed to be easy to create and easier to use.
 
-Here is a breakdown of one of the built-in validators (expanded to make comments more readable):
+Here is a breakdown of one of the provided validators (expanded to make comments more readable):
 
 ```ts
 // always provide a header comment to explain what the validator does!
 /**
  * Checks if the string value is a valid looking email using RegEx.
+ * @param message sets the error message returned.
  */
 export function isEmailSync<
 	// The type of the property you want to support validation for.
@@ -430,7 +440,8 @@ export function isEmailSync<
 	// Generally you don't put constraints on this.
 	A
 >(
-// Specify any parameters you need here. This can be configuration (like a max length) or reactive variables.
+	// Specify any parameters here.
+	message?: string
 ): SyncValidator<T, K, V, R, A> // Explicitly type the validator you'll be returning
 {
 	// Return a validator function
@@ -438,12 +449,14 @@ export function isEmailSync<
 		// Strongly type the expected params object to have intellisense
 		params: ValidatorParams<T, K, V, A>
 	) => {
-		// you can do whatever you want a normal validator can in here.
-		// Return undefined, an array of validators, or a validation result.
-		// In this case, we're checking the value of the property against an email regex.
+		/**
+		 * You can do whatever here, but you must return undefined,
+		 * an array of validators, or a validation result.
+		 * In this case, we're checking the value against an email regex.
+		 */
 		return {
 			isValid: params.value ? RegExp(/^(([^<>()[\]\\.,;:\s@"]+(\.[^<>()[\]\\.,;:\s@"]+)*)|(".+"))@((\[[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}])|(([a-zA-Z\-0-9]+\.)+[a-zA-Z]{2,}))$/).test(params.value) : false,
-			message: "Invalid email format"
+			message: message ?? "Invalid email format"
 		}
 	};
 }
@@ -454,11 +467,14 @@ Because every generic has a default value in `SyncValidator`, we can greatly sim
 ```ts
 /**
  * Validates a string is a valid looking email using RegEx.
+ * @param message sets the error message returned.
  */
-export function isEmailSync<T extends string | undefined | null>(): SyncValidator<T> {
+export function isEmailSync<T extends string | undefined | null>(
+	message?: string
+): SyncValidator<T> {
 	return (params: ValidatorParams<T>) => ({
 		isValid: params.value ? RegExp(/^(([^<>()[\]\\.,;:\s@"]+(\.[^<>()[\]\\.,;:\s@"]+)*)|(".+"))@((\[[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}])|(([a-zA-Z\-0-9]+\.)+[a-zA-Z]{2,}))$/).test(params.value) : false,
-		message: "Invalid email format"
+		message: message ?? "Invalid email format"
 	});
 }
 ```
@@ -471,17 +487,17 @@ Vuelidify provides several throttling functions for limiting how often a functio
 - 	```ts
 	bufferAsync<F extends (...args: any[]) => any>(
 		func: F,
-	): (...params: Parameters<F>) => Promise<Awaited<ReturnType<F>> | typeof IGNORE_RESULT>
+	): (...params: Parameters<F>) => Promise<Awaited<ReturnType<F>> | typeof V$_IGNORE>
 	```
-	`bufferAsync` ensures that the provided function has only one instance executing at a time. Calls to the buffered function will return a promise to execute when the current instance returns. Only the latest promise will execute the function next, all other promises will resolve to `IGNORE_RESULT` once the current instance returns. This function is very useful for only invoking resource-heavy functions while guaranteeing each execution uses the most up-to-date parameters.
+	`bufferAsync` ensures that the provided function has only one instance executing at a time. Calls to the buffered function will return a promise to execute when the current instance returns. Only the latest promise will execute the function next, all other promises will resolve to `V$_IGNORE` once the current instance returns. This function is very useful for only invoking resource-heavy functions while guaranteeing each execution uses the most up-to-date parameters.
 
 -	```ts
 	throttleBufferAsync<F extends (...args: any[]) => any>(
 		func: F,
 		delayMs: number,
-	): (...params: Parameters<F>) => Promise<Awaited<ReturnType<F>> | typeof IGNORE_RESULT>
+	): (...params: Parameters<F>) => Promise<Awaited<ReturnType<F>> | typeof V$_IGNORE>
 	```
-	`throttleBufferAsync` behaves very similarly to `bufferAsync`, but instead of waiting for the current instance to return, it waits for a throttle duration to expire. Once the throttle expires the latest buffered promise will execute the function and all others will resolve to `IGNORE_RESULT`. This means multiple instances of the function could be running at the same time, depending on the throttle and how long the function takes to return.
+	`throttleBufferAsync` behaves very similarly to `bufferAsync`, but instead of waiting for the current instance to return, it waits for a throttle duration to expire. Once the throttle expires the latest buffered promise will execute the function and all others will resolve to `V$_IGNORE`. This means multiple instances of the function could be running at the same time, depending on the throttle and how long the function takes to return.
 
 - 	```ts
 	throttleAsync<F extends (...args: any) => any>(
@@ -489,20 +505,20 @@ Vuelidify provides several throttling functions for limiting how often a functio
 		delayMs: number,
 	): {
 		isThrottled: Ref<boolean>;
-		throttledFunc: (...params: Parameters<F>) => ReturnType<F> | typeof IGNORE_RESULT;
+		throttledFunc: (...params: Parameters<F>) => ReturnType<F> | typeof V$_IGNORE;
 	}
 	```
-	`throttleAsync` ensures a function can only be invoked once every throttle period. Does not use buffering. Returns two objects, a ref indicating if the function is in its throttle period and the throttled function. Useful for hard limiting invocation of a function (e.g. forgot password form submission). Calls during the throttle period return `IGNORE_RESULT`.
+	`throttleAsync` ensures a function can only be invoked once every throttle period. Does not use buffering. Returns two objects, a ref indicating if the function is in its throttle period and the throttled function. Useful for hard limiting invocation of a function (e.g. forgot password form submission). Calls during the throttle period return `V$_IGNORE`.
 
 - 	```ts
 	trailingDebounceAsync<F extends (...args: any) => any>(
 		func: F,
 		delayMs: number,
-	): (...params: Parameters<F>) => Promise<Awaited<ReturnType<F>> | typeof IGNORE_RESULT>
+	): (...params: Parameters<F>) => Promise<Awaited<ReturnType<F>> | typeof V$_IGNORE>
 	```
-	`trailingDebounceAsync` ensures a function will only be invoked after a delay has passed since the last call. Guarantees the latest parameters will be executed. All calls prior to the latest will return `IGNORE_RESULT`.
+	`trailingDebounceAsync` ensures a function will only be invoked after a delay has passed since the last call. Guarantees the latest parameters will be executed. All calls prior to the latest will return `V$_IGNORE`.
 
-`IGNORE_RESULT` is a constant unique symbol exported by Vuelidify that helps you to identify when invocations are ignored by a throttle function. This was done to make sure this unique state doesn't conflict with possible returns from your own functions.
+`V$_IGNORE` is a constant unique symbol exported by Vuelidify that helps you to identify when invocations are ignored by a throttle function. This was done to make sure this unique state doesn't conflict with possible returns from your own functions.
 
 ## Utility Functions
 Vuelidify provides a utility function you are free to use as well. 

package/dist/index.d.ts

@@ -76,6 +76,10 @@ type ArrayValidation<U, T = U[], KModel = unknown, Args = unknown, Return = any,
         [key in NLevel]: ArrayAncestor<U, T>;
     }, Increment<NLevel>>;
 };
+/**
+ * Represents an element in {@link ValidatorParams.arrayAncestors | arrayAncestors} which
+ * holds context about the ancestor along with the ancestor itself.
+ */
 type ArrayAncestor<U = unknown, // the type of T's elements
 T = unknown> = Readonly<{
     /** The index this ancestor is at in `array` */
@@ -88,11 +92,11 @@ T = unknown> = Readonly<{
 /** A synchronous or asynchronous validator. */
 type Validator<T = unknown, KModel = unknown, Args = unknown, Return = any, Ancestors = unknown> = SyncValidator<T, KModel, Args, Return, Ancestors> | AsyncValidator<T, KModel, Args, Return, Ancestors>;
 /** Defines a validator function */
-type BaseValidator<T, Parent, Args, Return, Ancestors> = (input: ValidatorParams<T, Parent, Args, Ancestors>) => Return;
+type BaseValidator<T, KModel, Args, Return, Ancestors> = (input: ValidatorParams<T, KModel, Args, Ancestors>) => Return;
 /** Defines a validator which always runs synchronously */
-type SyncValidator<T = unknown, Parent = unknown, Args = unknown, Return = any, Ancestors = unknown> = BaseValidator<T, Parent, Args, BaseValidationReturn<Return> | Array<Validator<T, Parent, Args, Return, Ancestors>> | undefined, Ancestors>;
+type SyncValidator<T = unknown, KModel = unknown, Args = unknown, Return = any, Ancestors = unknown> = BaseValidator<T, KModel, Args, BaseValidationReturn<Return> | Array<Validator<T, KModel, Args, Return, Ancestors>> | undefined, Ancestors>;
 /** Defines a validator which returns a promise */
-type AsyncValidator<T = unknown, Parent = unknown, Args = unknown, Return = any, Ancestors = unknown> = BaseValidator<T, Parent, Args, Promise<BaseValidationReturn<Return> | Array<Validator<T, Parent, Args, Return, Ancestors>> | undefined>, Ancestors>;
+type AsyncValidator<T = unknown, KModel = unknown, Args = unknown, Return = any, Ancestors = unknown> = BaseValidator<T, KModel, Args, Promise<BaseValidationReturn<Return> | Array<Validator<T, KModel, Args, Return, Ancestors>> | undefined>, Ancestors>;
 /** Defines the return value of validators */
 type BaseValidationReturn<F = unknown> = {
     /**
@@ -191,76 +195,170 @@ type Increment<N extends number> = [
     ...number[]
 ][N];
 
+/** Vuelidify's constant Symbol used for identifying when a throttle function returned early. */
+declare const V$_IGNORE: unique symbol;
 /**
- * Returns a function that will execute the provided function
- * with the latest params only if a previously created promise does not exist.
- * ```ts
- * async function test(): Promise<boolean> {}
- * // Call this constant instead of the function to get the buffer benefits
- * const bufferedTest = bufferAsync<
- * 		typeof test, // this type makes the return the same signature as test()
- * 		Awaited<ReturnType<typeof test>> // this type makes the returned function have the same return type
- * >(test);
- * ```
+ * Buffers a function such that only one instance of the function executes at a time.
+ *
+ * Calls during execution return a promise to execute the function after current execution finishes.
+ * Only the latest buffered call will execute the function; the rest resolve to {@link V$_IGNORE}.
+ *
+ * @param func The function to apply a buffer to.
+ *
+ * @example
+ * const buffered = bufferAsync(someAsyncFn);
+ * buffered('a'); // executes
+ * buffered('b'); // queued but will resolve to undefined
+ * buffered('c'); // queued and will executed after first completes
+ */
+declare function bufferAsync<F extends (...args: any[]) => any>(func: F): (...params: Parameters<F>) => Promise<Awaited<ReturnType<F>> | typeof V$_IGNORE>;
+/**
+ * Throttles and buffers a function such that it is only called once per delay period.
+ *
+ * Calls during the throttle return a promise to execute the function after the throttle.
+ * Only the latest buffered call will execute; the rest resolve to {@link V$_IGNORE}.
+ *
+ * Useful when you want to avoid spamming a resource and using the latest parameters is important.
+ *
+ * @param func - The function to throttle.
+ * @param delayMs - Time between invocations.
+ * @returns A throttled version of the function.
+ *
+ * @example
+ * async function saveInput(input: string) { ... }
+ * const throttledSave = throttleBufferAsync(saveInput, 1000);
+ *
+ * throttledSave("a"); // Executes immediately
+ * throttledSave("b"); // Queued but will resolve to IGNORE_RESULT
+ * throttledSave("c"); // Replaces "b", starts after 1s
+ *
+ * // Only "a" and "c" will be processed
+ */
+declare function throttleBufferAsync<F extends (...args: any[]) => any>(func: F, delayMs: number): (...params: Parameters<F>) => Promise<Awaited<ReturnType<F>> | typeof V$_IGNORE>;
+/**
+ * Adds trailing debounce behavior to a function.
+ *
+ * Waits for the specified delay after the last call before executing.
+ * All previous calls during the delay resolve to {@link V$_IGNORE}. Guarantees the call will have the latest parameters.
+ *
+ * @param func - The async function to debounce.
+ * @param delay - Delay in milliseconds after the last call before execution.
+ * @returns A debounced version of the function.
+ *
+ * @example
+ * async function fetchResults(query: string) { ... }
+ * const debouncedFetch = trailingDebounceAsync(fetchResults, 500);
+ *
+ * debouncedFetch("a"); // resolves to IGNORE_RESULT
+ * debouncedFetch("ab"); // resolves to IGNORE_RESULT
+ * debouncedFetch("abc"); // Only this call will be executed after 500ms
  */
-declare function bufferAsync<F extends (...args: any[]) => any, K>(func: (...params: Parameters<F>) => K | Promise<K>): (...params: Parameters<typeof func>) => Promise<K | undefined>;
+declare function trailingDebounceAsync<F extends (...args: any) => any>(func: F, delayMs: number): (...params: Parameters<F>) => Promise<Awaited<ReturnType<F>> | typeof V$_IGNORE>;
 /**
- * Guarantees delay between invocations of the given function.
+ * Throttles a function, ensuring it's called once per delay period.
  *
- * Invocations of the throttled function after the given interval has passed will execute instantly.
+ * Calls during the delay are ignored, and the first call after the delay executes immediately.
  *
- * Subsequent invocations during the cool down return a promise to invoke the function after the remaining delay has passed.
+ * Useful for hard limiting actions (e.g. form submissions or API calls).
+ *
+ * @param func - The function to throttle.
+ * @param delayMs - The minimum time (in milliseconds) between calls.
+ * @returns A ref indicating throttle state and the throttled function.
+ *
+ * @example
+ * async function fetchResults(query: string) { ... }
+ * const { throttledFunc } = throttleAsync(fetchResults, 500);
+ *
+ * throttledFunc("a"); // executes immediately
+ * throttledFunc("ab"); // ignored
+ * // ... 500 ms later ...
+ * throttledFunc("abc"); // executes immediately
+ */
+declare function throttleAsync<F extends (...args: any) => any>(func: F, delayMs: number): {
+    isThrottled: Ref<boolean>;
+    throttledFunc: (...params: Parameters<F>) => ReturnType<F> | typeof V$_IGNORE;
+};
+
+/**
+ * Accepts an array and uses the provided getter to get any value from each element
+ * and ignoring any undefined or null values returned.
  *
- * Once the interval has passed, all queued promises are executed, but only the latest promise will execute the function. The others will return undefined.
  * ```ts
- * async function test(): Promise<boolean> {}
- * // Call this constant instead of the function to get the throttle benefits
- * const throttledTest = throttleQueueAsync<
- * 		typeof test, // this type makes the return the same signature as test()
- * 		Awaited<ReturnType<typeof test>> // this type makes the returned function have the same return type
- * >(test);
+ * const array = [{ id: 123, name: "Foo"}, { id: 456, name: undefined }]
+ * const validNames = reduceUndefined(array, v => v.name) // ["Foo"]
  * ```
- * @param func the function to throttle
- * @param delay milliseconds required between invocations of the function.
+ * @param array the array to map values from
+ * @param getter a function executed with each element which can perform any kind of custom mapping.
+ * @returns an array of the getter's return value invoked with each source element, with undefined values omitted.
  */
-declare function throttleQueueAsync<F extends (...args: any[]) => any, K>(func: (...params: Parameters<F>) => K | Promise<K>, delay: number): (...params: Parameters<typeof func>) => Promise<K | undefined>;
+declare function reduceUndefined<T, K = NonNullable<T>>(array: T[], getter?: (value: T) => K | undefined | null): K[];
 
 /**
  * Validates the object is not loosely undefined.
+ * This does allow for empty strings. If you need a non-empty value, use {@link notEmpty()}.
+ * @param message sets the error message returned.
  */
-declare function required(): SyncValidator;
+declare function required(message?: string): SyncValidator;
+/**
+ * Validates the object is not loosely undefined and is not an empty string.
+ * @param message sets the error message returned.
+ */
+declare function notEmpty(message?: string): SyncValidator;
 /**
  * Validates a string or number has a length >= to the provided length. Undefined and null are 0 length.
- * @param minLength
+ * @param min the minimum length of the string or number.
+ * @param message sets the error message returned.
  */
-declare function minLength<T extends string | number | undefined | null>(minLength: number): SyncValidator<T>;
+declare function minLength<T extends string | number | undefined | null>(min: number, message?: string): SyncValidator<T>;
 /**
  * Validates a string or number's length. Undefined and null are 0 length.
- * @param maxLength the maximum length of the string or number
+ * @param max the maximum length of the string or number.
+ * @param message sets the error message returned.
+ */
+declare function maxLength<T extends string | number | undefined | null>(max: number, message?: string): SyncValidator<T>;
+/**
+ * Validates a number is defined and is at least some value.
+ * @param min the minimum number the value can be.
+ * @param message sets the error message returned.
  */
-declare function maxLength<T extends string | number | undefined | null>(maxLength: number): SyncValidator<T>;
+declare function minNumber<T extends number | undefined | null>(min: number, message?: string): SyncValidator<T>;
 /**
  * Validates a number is defined and is at least some value.
- * @param minNumber the minimum number the value can be
+ * @param min the minimum number the value can be.
+ * @param message sets the error message returned.
+ */
+declare function exclusiveMinNumber<T extends number | undefined | null>(min: number, message?: string): SyncValidator<T>;
+/**
+ * Validates a number is defined and is at most some value.
+ * @param max the maximum number the value can be.
+ * @param message sets the error message returned.
  */
-declare function minNumber<T extends number | undefined | null>(minNumber: number): SyncValidator<T>;
+declare function maxNumber<T extends number | undefined | null>(max: number, message?: string): SyncValidator<T>;
 /**
  * Validates a number is defined and is at most some value.
- * @param maxNumber the maximum number the value can be
+ * @param max the maximum number the value can be.
+ * @param message sets the error message returned.
  */
-declare function maxNumber<T extends number | undefined | null>(maxNumber: number): SyncValidator<T>;
+declare function exclusiveMaxNumber<T extends number | undefined | null>(max: number, message?: string): SyncValidator<T>;
 /**
  * Validate the provided predicate function.
  * @param fn predicate that returns true if the value is valid.
- * @param errorMessage the message to display when the values are not equal.
+ * @param message sets the error message returned.
  */
-declare function must<T, K, V, R, A>(fn: (params: ValidatorParams<T, K, V, A>) => boolean, errorMessage: string): SyncValidator<T, K, V, R, A>;
+declare function must<T, K, V, R, A>(fn: (params: ValidatorParams<T, K, V, A>) => boolean, message: string): SyncValidator<T, K, V, R, A>;
+/**
+ * Execute a set of validators only if the provided predicate is true.
+ * @param predicate determines if the set of validators should be returned.
+ * @param validators The set of validators to execute if the predicate returns true.
+ */
+declare function validateIf<T, K, V, R, A, Validators extends Validator<T, K, V, R, A>[]>(predicate: (params: ValidatorParams<T, K, V, A>) => boolean | Promise<boolean>, validators: Validators): AsyncValidator<T, K, V, R, A>;
 /**
  * Validates a string is a valid looking email using RegEx.
  *
  * The RegEx was taken from https://stackoverflow.com/questions/46155/how-can-i-validate-an-email-address-in-javascript, and may be updated in the future.
-s */
-declare function isEmailSync<T extends string | undefined | null>(): SyncValidator<T>;
+ * @param message sets the error message returned.
+ */
+declare function isEmailSync<T extends string | undefined | null>(message?: string): SyncValidator<T>;
 
 type UseValidationReturn<T = unknown, Return = any> = {
     hasValidated: Ref<boolean>;
@@ -280,6 +378,10 @@ type UseValidationReturn<T = unknown, Return = any> = {
      * The reference state can be changed using {@link setReference()}.
      */
     isDirty: ComputedRef<boolean>;
+    /**
+     * Resets the internal state of the composable back to its starting state.
+     */
+    reset: () => void;
 };
 /**
  * The starting point for validation with Vuelidify.
@@ -288,4 +390,4 @@ type UseValidationReturn<T = unknown, Return = any> = {
  */
 declare function useValidation<T, Args = unknown, Return = any>(validationConfig: ValidationConfig<T, Args, Return>): Reactive<UseValidationReturn<T, Return>>;
 
-export { ArrayAncestor, ArrayValidation, ArrayValidationState, AsyncValidator, BaseValidation, BaseValidationReturn, BaseValidationState, BaseValidator, ObjectValidationTypes, Primitive, PrimitiveValidationState, RecursiveValidation, RecursiveValidationState, SyncValidator, Validation, ValidationConfig, ValidationState, Validator, ValidatorParams, bufferAsync, isEmailSync, maxLength, maxNumber, minLength, minNumber, must, required, throttleQueueAsync, useValidation };
+export { ArrayAncestor, ArrayValidation, ArrayValidationState, AsyncValidator, BaseValidation, BaseValidationReturn, BaseValidationState, BaseValidator, ObjectValidationTypes, Primitive, PrimitiveValidationState, RecursiveValidation, RecursiveValidationState, SyncValidator, V$_IGNORE, Validation, ValidationConfig, ValidationState, Validator, ValidatorParams, bufferAsync, exclusiveMaxNumber, exclusiveMinNumber, isEmailSync, maxLength, maxNumber, minLength, minNumber, must, notEmpty, reduceUndefined, required, throttleAsync, throttleBufferAsync, trailingDebounceAsync, useValidation, validateIf };

package/dist/index.mjs

@@ -1 +1 @@
-function x(e){let t=0,i;return(...r)=>{let o=++t;return i=(i==null?void 0:i.then(()=>{if(t===o)return i=new Promise(n=>n(e(...r))).then(n=>(i=void 0,n)),i}))??new Promise(n=>n(e(...r))).then(n=>(i=void 0,n)),i}}function S(e,t){let i=0,r;return(...o)=>new Promise(n=>{let l=++i,f=new Date().getTime();r??(r=f-t);let d=f-r-t;d<0?new Promise(u=>setTimeout(u,-1*d)).then(()=>{r=new Date().getTime(),l===i&&n(e(...o)),n(void 0)}):(r=f,n(e(...o)))})}function I(e,t=i=>i){return e.reduce((i,r)=>{if(r!==void 0){let o=t(r);o!==void 0&&i.push(o)}return i},[])}function X(){return e=>({isValid:e.value!=null,message:"This field is required"})}function Y(e){return t=>{let i=String(t.value??"");return{isValid:i.length>=e,message:`Too short (${i.length} / ${e})`}}}function _(e){return t=>{let i=String(t.value??"");return{isValid:i.length<=e,message:`Too long (${i.length} / ${e})`}}}function ee(e){return t=>({isValid:t.value!=null&&t.value>=e,message:`The minimum value is ${e}`})}function ae(e){return t=>({isValid:t.value!=null&&t.value<=e,message:`The maximum value is ${e}`})}function te(e,t){return i=>({isValid:e(i),message:t})}function ie(){return e=>({isValid:e.value?RegExp(/^(([^<>()[\]\\.,;:\s@"]+(\.[^<>()[\]\\.,;:\s@"]+)*)|(".+"))@((\[[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}])|(([a-zA-Z\-0-9]+\.)+[a-zA-Z]{2,}))$/).test(e.value):!1,message:"Invalid email format"})}import{computed as b,reactive as q,ref as N,watch as Z}from"vue";import{computed as U,toValue as G}from"vue";import{computed as R,reactive as O,ref as P,toValue as M}from"vue";function L(){return`${Date.now()}-${Math.floor(Math.random()*1e3)}`}function C(e,t){return D(e,t)}function A(e,t,i){let r=[],o=()=>`${t?"reactive":"lazy"}-${L()}`;i!=null&&(o=n=>`${i}-${n}`);for(let[n,l]of e.entries())r.push({validatorId:o(n),validator:l,optimized:!1,isReactive:t,previouslyReturnedValidators:!1,previouslySpawnedValidators:{},spawnedValidators:{}});return r}function K(e,t,i=[]){var u;let r=O({$state:{isValid:R(()=>{let s=d.isLazyValid.value??!1,c=d.isReactiveValid.value??!1;return s&&c}),isValidating:R(()=>d.isValidatingReactive.value||d.isValidatingLazy.value),isErrored:R(()=>{var s;return((s=r.$state)==null?void 0:s.resultsArray.some(c=>c.isValid===!1))??!1}),errorMessages:R(()=>{var s;return I(((s=r.$state)==null?void 0:s.resultsArray)??[],c=>c.isValid?void 0:c.message)}),results:R(()=>d.namedValidationResults.value),resultsArray:R(()=>d.validationResults.value)},$arrayState:R(()=>{if(Array.isArray(e.value)===!1||d.elementValidation===void 0)return[];let s=e.value,c=d.elementValidation,a=d.arrayConfigMap,v=[],m={},y,V=[];for(let p=0;p<s.length;p++){let T=s[p]!==void 0&&typeof s[p]=="object";if(T?(s[p].$ffId===void 0&&Object.defineProperty(s[p],"$ffId",{value:`${d.id}-${d.elementId++}`,writable:!1,configurable:!1,enumerable:!1}),y=s[p].$ffId):s[p]!==void 0&&(y=p),V.push(y),a[y]){v.push(a[y].validationState),m[y]=a[y];continue}let h=R(()=>s[p]),z=[...d.arrayAncestors];T&&z.push({ancestor:h,array:s,index:p});let k=D(h,c,z);a[y]={validationConfigs:k.validationConfigs,validationState:k.state},v.push(a[y].validationState),m[y]=a[y]}return d.arrayConfigMap=m,v})}),o=!0,n=!0,l=[],f=[];t.$reactive&&t.$reactive.length>0&&(n=!1,l=A(t.$reactive,!0)),t.$lazy&&((u=t.$lazy)==null?void 0:u.length)>0&&(o=!1,f=A(t.$lazy,!1));let d={id:L(),reactiveIterationId:0,lazyIterationId:0,isReactiveValid:P(n),isValidatingReactive:P(!1),reactiveProcessedValidators:l,isLazyValid:P(o),isValidatingLazy:P(!1),lazyProcessedValidators:f,target:e,validation:t,validationState:r,validationResults:P([]),namedValidationResults:P({}),arrayConfigMap:{},elementId:0,elementValidation:t.$each,arrayAncestors:O(i)};return d}function D(e,t,i=[]){let r=[],o={};if(j(t)){let l=R(()=>M(e)),f=K(l,t,i);r.push(f),o=f.validationState}t!=null&&n(e,t,o);function n(l,f,d){if($(f)!==!1)for(let u in f){if(u==="$reactive"||u==="$lazy"||u==="$each")continue;let s=R(()=>{let a=M(l);return $(a)?a[u]:(console.error(`Vuelidify Error: validation could not be setup correctly on ${a} because ${l} is not enumerable.`),null)}),c=f[u];if(j(c)){let a=K(s,c,i);r.push(a),d[u]=a.validationState}if($(c)){let a=d[u]??{};d[u]=a,n(s,c,a)}}}return{validationConfigs:r,state:o}}function j(e){return Array.isArray(e==null?void 0:e.$reactive)||Array.isArray(e==null?void 0:e.$lazy)||(e==null?void 0:e.$each)!==void 0}function $(e){return typeof e=="object"&&e!==null&&!Array.isArray(e)}var w=250;async function B(e,t,i,r,o,n){let l=!0,f=(s,c,a)=>{if(r!==G(o))return;a.isValid===!1&&(l=!1),a.id=c.validatorId;let v=s.validationResults.value.find(m=>m.id===a.id);v!==void 0?(Object.assign(v,a),a.name!==void 0&&s.namedValidationResults.value[a.name]!==void 0&&Object.assign(s.namedValidationResults.value[a.name],a)):(s.validationResults.value.push(a),a.name!==void 0&&(s.namedValidationResults.value[a.name]=a))},{asyncPromises:d,validatorsWhichPreviouslyReturnedValidators:u}=F(e,t,i,r,n,f,!0,1);if(await Promise.all(d),r===G(o)){for(let s of u)for(let c of Object.keys(s.previouslySpawnedValidators))if(s.spawnedValidators[c]==null){let a=e.validationResults.value.findIndex(v=>v.id===c);a!==-1&&e.validationResults.value.splice(a)}}return l}function F(e,t,i,r,o,n,l,f){let d=e.target.value,u=[],s=[],c=[];for(let a of o){let v=!1;a.previouslyReturnedValidators&&(a.previouslySpawnedValidators=a.spawnedValidators,a.spawnedValidators={},v=!0),a.previouslyReturnedValidators=!1;let m;if(a.computedValidator===void 0){let y={value:d,model:t,args:i,arrayAncestors:e.arrayAncestors};m=a.validator(y)}else m=a.computedValidator.value;if(m instanceof Promise){let y=Date.now();u.push(m.then(async V=>{if(V===void 0){v&&c.push(a);return}let p=Date.now()-y;if(l&&p>w&&a.optimized===!1&&(a.optimized=!0,p>w&&p<2*w?a.validator=S(a.validator,w):a.validator=x(a.validator)),Array.isArray(V)){let{asyncPromises:T,syncResults:h}=E(e,t,i,r,n,a,V,f);s.push(...h),await Promise.all(T);return}else v&&c.push(a);n(e,a,V)}))}else if(Array.isArray(m)){let{asyncPromises:y,syncResults:V}=E(e,t,i,r,n,a,m,f);u.push(...y),s.push(...V)}else if(v&&c.push(a),m!==void 0){if(l&&a.optimized===!1){let y=a.validator;a.computedValidator=U(()=>{let V={value:e.target.value,model:t,args:i,arrayAncestors:e.arrayAncestors};return y(V)}),a.optimized=!0,a.validator=()=>{var V;return(V=a.computedValidator)==null?void 0:V.value}}s.push(m),n(e,a,m)}}return{asyncPromises:u,syncResults:s,validatorsWhichPreviouslyReturnedValidators:c}}function E(e,t,i,r,o,n,l,f){let d=A(l,n.isReactive,n.validatorId),u=F(e,t,i,r,d,o,!1,++f),s={};for(let c of d)s[c.validatorId]=c;return n.spawnedValidators=s,n.previouslyReturnedValidators=!0,u}async function J(e,t,i,r,o){e.isValidatingReactive.value=!0;let n=await B(e,t,i,r,o,e.reactiveProcessedValidators);return r===G(o)&&(e.isReactiveValid.value=n,e.isValidatingReactive.value=!1),e.isReactiveValid.value??!1}async function Q(e,t,i,r,o){e.isValidatingLazy.value=!0;let n=await B(e,t,i,r,o,e.lazyProcessedValidators);return r===G(o)&&(e.isLazyValid.value=n,e.isValidatingLazy.value=!1),e.isLazyValid.value??!1}function g(e,t,i,r,o){let n=[];for(let l of e)if(r&&l.reactiveProcessedValidators.length>0&&n.push(J(l,t.value,i,++l.reactiveIterationId,()=>l.reactiveIterationId)),o&&l.lazyProcessedValidators.length>0&&n.push(Q(l,t.value,i,++l.lazyIterationId,()=>l.lazyIterationId)),Array.isArray(l.validationState.$arrayState)){let f=[];for(let d in l.arrayConfigMap)f.push(...l.arrayConfigMap[d].validationConfigs);n.push(g(f,t,i,r,o))}return Promise.all(n).then(l=>l.every(f=>f===!0))}function W(e){e.delayReactiveValidation??(e.delayReactiveValidation=!0);let{model:t,validation:i,delayReactiveValidation:r,args:o}=e,n=N(!1),l=b(()=>u.some(V=>V.isValidatingLazy.value||V.isValidatingReactive.value)),f=b(()=>u.some(V=>V.validationResults.value.some(p=>p.isValid===!1))),d=b(()=>u.every(p=>p.isReactiveValid.value&&p.isLazyValid.value)),u=[],s=N(JSON.stringify(e.model.value)),c=b(()=>s.value!==JSON.stringify(e.model.value)),a=C(t,i),v=a.state;u=a.validationConfigs,Z(e.model,()=>{r?n.value===!0&&g(u,t,o,!0,!1):g(u,t,o,!0,!1)},{deep:!0});async function m(){let V=await g(u,t,o,!0,!0);return n.value=!0,V}function y(V){s.value=JSON.stringify(V)}return q({hasValidated:n,validate:m,isValidating:l,state:b(()=>v),isValid:d,isErrored:f,setReference:y,isDirty:c})}export{x as bufferAsync,ie as isEmailSync,_ as maxLength,ae as maxNumber,Y as minLength,ee as minNumber,te as must,X as required,S as throttleQueueAsync,W as useValidation};
+import{ref as K}from"vue";var x=Symbol("Throttled function call was ignored");function H(e){let a=0,t;return(...n)=>{let r=++a;return(t??Promise.resolve()).then(()=>r!==a?x:e(...n)).finally(()=>{r===a&&(t=void 0)})}}function Q(e,a){let t=0,n=0;return async(...r)=>{let s=++t,f=Date.now()-n;return f<a&&(await new Promise(u=>setTimeout(u,a-f)),s!==t)?x:(n=Date.now(),await e(...r))}}function X(e,a){let t=0;return(...n)=>new Promise(r=>{let s=++t;setTimeout(async()=>{s==t?r(await e(...n)):r(x)},a)})}function Y(e,a){let t=K(!1);return{isThrottled:t,throttledFunc:(...r)=>t.value?x:(t.value=!0,setTimeout(()=>t.value=!1,a),e(...r))}}function O(e,a=t=>t){return e.reduce((t,n)=>{let r=a(n);return r!=null&&t.push(r),t},[])}function ae(e){return a=>({isValid:a.value!=null,message:e??"This field is required"})}function te(e){return a=>({isValid:a.value!=null&&a.value!==""&&String(a.value).trim().length>0,message:e??"Must not be empty"})}function ie(e,a){return t=>{let n=String(t.value??"");return{isValid:n.length>=e,message:a??`Too short (${n.length} / ${e})`}}}function ne(e,a){return t=>{let n=String(t.value??"");return{isValid:n.length<=e,message:a??`Too long (${n.length} / ${e})`}}}function re(e,a){return t=>({isValid:t.value!=null&&t.value>=e&&String(t.value)!=="",message:a??`The minimum value is ${e}`})}function oe(e,a){return t=>({isValid:t.value!=null&&t.value>e&&String(t.value)!=="",message:a??`The minimum value is ${e}`})}function se(e,a){return t=>({isValid:t.value!=null&&t.value<=e&&String(t.value)!=="",message:a??`The maximum value is ${e}`})}function le(e,a){return t=>({isValid:t.value!=null&&t.value<e&&String(t.value)!=="",message:a??`The maximum value is ${e}`})}function de(e,a){return t=>({isValid:e(t),message:a})}function ue(e,a){return async t=>{if(await e(t))return a}}function ce(e){return a=>({isValid:a.value?RegExp(/^(([^<>()[\]\\.,;:\s@"]+(\.[^<>()[\]\\.,;:\s@"]+)*)|(".+"))@((\[[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}])|(([a-zA-Z\-0-9]+\.)+[a-zA-Z]{2,}))$/).test(a.value):!1,message:e??"Invalid email format"})}import{computed as h,reactive as U,ref as E,watch as q}from"vue";import{computed as D,toValue as G}from"vue";import{computed as b,reactive as k,ref as T,toValue as F}from"vue";function L(){return`${Date.now()}-${Math.floor(Math.random()*1e3)}`}function z(e,a){return C(e,a)}function w(e,a,t){let n=[],r=()=>`${a?"reactive":"lazy"}-${L()}`;t!=null&&(r=s=>`${t}-${s}`);for(let[s,d]of e.entries())n.push({validatorId:r(s),validator:d,optimized:!1,isReactive:a,previouslyReturnedValidators:!1,previouslySpawnedValidators:{},spawnedValidators:{}});return n}function M(e,a,t=[]){let n=k({$state:{isValid:b(()=>{let l=u.isLazyValid.value??!1,g=u.isReactiveValid.value??!1;return l&&g}),isValidating:b(()=>u.isValidatingReactive.value||u.isValidatingLazy.value),isErrored:b(()=>n.$state?.resultsArray.some(l=>l.isValid===!1)??!1),errorMessages:b(()=>O(n.$state?.resultsArray??[],l=>l.isValid?void 0:l.message)),results:b(()=>u.namedValidationResults.value),resultsArray:b(()=>u.validationResults.value)},$arrayState:b(()=>{if(Array.isArray(e.value)===!1||u.elementValidation===void 0)return[];let l=e.value,g=u.elementValidation,m=u.arrayConfigMap,i=[],V={},o,p=[];for(let c=0;c<l.length;c++){let v=l[c]!==void 0&&typeof l[c]=="object";if(v?(l[c].$ffId===void 0&&Object.defineProperty(l[c],"$ffId",{value:`${u.id}-${u.elementId++}`,writable:!1,configurable:!1,enumerable:!1}),o=l[c].$ffId):l[c]!==void 0&&(o=c),p.push(o),m[o]){i.push(m[o].validationState),V[o]=m[o];continue}let y=b(()=>l[c]),R=[...u.arrayAncestors];v&&R.push({ancestor:y,array:l,index:c});let P=C(y,g,R);m[o]={validationConfigs:P.validationConfigs,validationState:P.state},i.push(m[o].validationState),V[o]=m[o]}return u.arrayConfigMap=V,i})}),r=!0,s=!0,d=[],f=[];a.$reactive&&a.$reactive.length>0&&(s=!1,d=w(a.$reactive,!0)),a.$lazy&&a.$lazy?.length>0&&(r=!1,f=w(a.$lazy,!1));let u={id:L(),reactiveIterationId:0,lazyIterationId:0,isReactiveValid:T(s),isValidatingReactive:T(!1),reactiveProcessedValidators:d,isLazyValid:T(r),isValidatingLazy:T(!1),lazyProcessedValidators:f,target:e,validation:a,validationState:n,validationResults:T([]),namedValidationResults:T({}),arrayConfigMap:{},elementId:0,elementValidation:a.$each,arrayAncestors:k(t)};return u}function C(e,a,t=[]){let n=[],r={};if(N(a)){let d=b(()=>F(e)),f=M(d,a,t);n.push(f),r=f.validationState}a!=null&&s(e,a,r);function s(d,f,u){if(I(f)!==!1)for(let l in f){if(l==="$reactive"||l==="$lazy"||l==="$each")continue;let g=b(()=>{let i=F(d);return I(i)?i[l]:(console.error(`Vuelidify Error: validation could not be setup correctly on ${i} because ${d} is not enumerable.`),null)}),m=f[l];if(N(m)){let i=M(g,m,t);n.push(i),u[l]=i.validationState}if(I(m)){let i=u[l]??{};u[l]=i,s(g,m,i)}}}return{validationConfigs:n,state:r}}function N(e){return Array.isArray(e?.$reactive)||Array.isArray(e?.$lazy)||e?.$each!==void 0}function I(e){return typeof e=="object"&&e!==null&&!Array.isArray(e)}async function j(e,a,t,n,r,s){let d=!0,f=(i,V,o)=>{if(n!==G(r))return;o.isValid===!1&&(d=!1),o.id=V.validatorId;let p=i.validationResults.value.find(c=>c.id===o.id);p!==void 0?(Object.assign(p,o),o.name!==void 0&&i.namedValidationResults.value[o.name]!==void 0&&Object.assign(i.namedValidationResults.value[o.name],o)):(i.validationResults.value.push(o),o.name!==void 0&&(i.namedValidationResults.value[o.name]=o))},u=[];for(let i of s){let V=(i.activeValidation??Promise.resolve()).then(async()=>n!==G(r)?[]:await g(i,!0));i.activeValidation=V,u.push(V)}return await Promise.all(u),d;function l(i,V){let o=[];for(let p of i)o.push(g(p,!1,V));return o}async function g(i,V,o=i){let p=[],c=i.previouslyReturnedValidators;c&&(i.previouslySpawnedValidators=i.spawnedValidators,i.spawnedValidators={}),i.previouslyReturnedValidators=!1;let v={value:e.target.value,model:a,args:t,arrayAncestors:e.arrayAncestors},y=i.validator(v);if(y instanceof Promise){let R=await y;if(Array.isArray(R)){let P=m(i,R,o),$=await Promise.all(P);p.push(...$.flat()),c&&S(e,i)}else c&&S(e,i),R!=null&&(p.push(R),f(e,i,R))}else if(Array.isArray(y)){let R=m(i,y,o),P=await Promise.all(R);p.push(...P.flat()),c&&S(e,i)}else if(c&&S(e,i),y!=null){if(V&&i.optimized===!1){let R=i.validator,P=D(()=>{let $={value:e.target.value,model:a,args:t,arrayAncestors:e.arrayAncestors};return R($)});i.optimized=!0,i.validator=()=>P.value}p.push(y),f(e,i,y)}return p}function m(i,V,o){let p=w(V,i.isReactive,i.validatorId),c=l(p,o),v=o.spawnedValidators;for(let y of p)v[y.validatorId]!=null&&console.error(`Unable to keep track of nested validators. Validator ID: ${y.validatorId} was not unique.`),v[y.validatorId]=y;return i.spawnedValidators=v,i.previouslyReturnedValidators=!0,c}}function S(e,a){for(let t in a.previouslySpawnedValidators){if(a.spawnedValidators[t]!=null)continue;let n=e.validationResults.value.findIndex(r=>r.id===t);n!==-1&&e.validationResults.value.splice(n,1)}}async function B(e,a,t,n,r){e.isValidatingReactive.value=!0;let s=await j(e,a,t,n,r,e.reactiveProcessedValidators);return n===G(r)&&(e.isReactiveValid.value=s,e.isValidatingReactive.value=!1),e.isReactiveValid.value??!1}async function _(e,a,t,n,r){e.isValidatingLazy.value=!0;let s=await j(e,a,t,n,r,e.lazyProcessedValidators);return n===G(r)&&(e.isLazyValid.value=s,e.isValidatingLazy.value=!1),e.isLazyValid.value??!1}function A(e,a,t,n,r){let s=[];for(let d of e)if(n&&d.reactiveProcessedValidators.length>0&&s.push(B(d,a.value,t,++d.reactiveIterationId,()=>d.reactiveIterationId)),r&&d.lazyProcessedValidators.length>0&&s.push(_(d,a.value,t,++d.lazyIterationId,()=>d.lazyIterationId)),Array.isArray(d.validationState.$arrayState)){let f=[];for(let u in d.arrayConfigMap)f.push(...d.arrayConfigMap[u].validationConfigs);s.push(A(f,a,t,n,r))}return Promise.all(s).then(d=>d.every(f=>f===!0))}function J(e){e.delayReactiveValidation??=!0;let{model:a,validation:t,delayReactiveValidation:n,args:r}=e,s=E(!1),d=h(()=>V.some(v=>v.isValidatingLazy.value||v.isValidatingReactive.value)),f=h(()=>V.some(v=>v.validationResults.value.some(y=>y.isValid===!1))),u=h(()=>V.every(y=>y.isReactiveValid.value&&y.isLazyValid.value)),l=E(JSON.stringify(e.model.value)),g=h(()=>l.value!==JSON.stringify(e.model.value)),m=z(a,t),i=m.state,V=m.validationConfigs;q(e.model,()=>{n?s.value===!0&&A(V,a,r,!0,!1):A(V,a,r,!0,!1)},{deep:!0});async function o(){let v=await A(V,a,r,!0,!0);return s.value=!0,v}function p(v){l.value=JSON.stringify(v)}function c(){s.value=!1,m=z(a,t),V=m.validationConfigs,i=m.state}return U({hasValidated:s,validate:o,isValidating:d,state:h(()=>i),isValid:u,isErrored:f,setReference:p,isDirty:g,reset:c})}export{x as V$_IGNORE,H as bufferAsync,le as exclusiveMaxNumber,oe as exclusiveMinNumber,ce as isEmailSync,ne as maxLength,se as maxNumber,ie as minLength,re as minNumber,de as must,te as notEmpty,O as reduceUndefined,ae as required,Y as throttleAsync,Q as throttleBufferAsync,X as trailingDebounceAsync,J as useValidation,ue as validateIf};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "vuelidify",
-  "version": "2.1.1",
+  "version": "2.2.0",
   "author": "Daniel Walbolt",
   "private": false,
   "main": "./dist/index.js",