ivl 0.2.0 → 0.2.5

package/lib/helpers/index.d.ts

@@ -1,4 +1,4 @@
-// Generated by dts-bundle-generator v8.1.1
+// Generated by dts-bundle-generator v9.5.1
 
 export type RULE_SYNC = (value: unknown, ...overload: unknown[]) => boolean;
 export type RULE = (value: unknown, ...overload: unknown[]) => boolean | Promise<boolean>;

package/lib/index.d.ts

@@ -1,4 +1,4 @@
-// Generated by dts-bundle-generator v8.1.1
+// Generated by dts-bundle-generator v9.5.1
 
 export type RULE_SYNC = (value: unknown, ...overload: unknown[]) => boolean;
 export type RULE = (value: unknown, ...overload: unknown[]) => boolean | Promise<boolean>;
@@ -19,7 +19,6 @@ export type CHECKABLE_OBJECT = {
 };
 /**
  * @arg {boolean} strict --- Don't allow object to have keys not included in the schema
- * @arg {boolean} break_early --- Return the first error found
  */
 export type SCHEMA_OPTIONS = {
 	strict?: boolean;
@@ -28,12 +27,67 @@ export type CHECKED_SCHEMA_SYNC = {
 	[index: string]: string[];
 };
 export type CHECKED_SCHEMA = Promise<CHECKED_SCHEMA_SYNC>;
-export declare const hasAsyncFunction: (obj: Record<string, unknown>) => boolean;
+/**
+ * Detect if a RULES object has any async rules in it
+ *
+ * @param {Record<string, RULE>} rules a rules object
+ * @returns {boolean} true if any of the rules is an async function otherwise false
+ */
+export declare const hasAsyncFunction: (rules: Record<string, RULE>) => boolean;
+/**
+ * Check the input against all provided validation rules asynchronously
+ *
+ * @param {unknown} value the value to check
+ * @param {RULES} rules rules object to use for validating the provided value
+ * @param {unknown[]} overload array of extra values the validator rules might need to properly validate the value
+ * @returns {string[]} a list of rule names which failed validation
+ */
 export declare const getValueErrorsAsync: (value: unknown, rules: RULES, ...overload: unknown[]) => Promise<string[]>;
+/**
+ * Check a schema against all provided validation rules asynchronously
+ *
+ * @param {CHECKABLE_OBJECT} object object to be validated
+ * @param {SCHEMA} schema schema to validate against
+ * @param {SCHEMA_OPTIONS} options options affecting how the rules are run
+ * @param {unknown[]} overload array of extra values the validator rules might need to properly validate the value
+ * @returns {CHECKED_SCHEMA} an object containing keys and their respective lists of failed rule names
+ */
 export declare const getSchemaErrorsAsync: (object: CHECKABLE_OBJECT, schema: SCHEMA, options?: SCHEMA_OPTIONS, ...overload: unknown[]) => CHECKED_SCHEMA;
+/**
+ *
+ * @param {unknown} value the value to check
+ * @param {RULES_SYNC} rules rules object to use for validating the provided value
+ * @param {unknown[]} overload array of extra values the validator rules might need to properly validate the value
+ * @returns {string[]} a list of rule names which failed validation
+ */
 export declare const getValueErrorsSync: (value: unknown, rules: RULES_SYNC, ...overload: unknown[]) => string[];
+/**
+* Check a schema against all provided validation rules asynchronously
+*
+* @param {CHECKABLE_OBJECT} object object to be validated
+* @param {SCHEMA} schema schema to validate against
+* @param {SCHEMA_OPTIONS} options options affecting how the rules are run
+* @param {unknown[]} overload array of extra values the validator rules might need to properly validate the value
+* @returns {CHECKED_SCHEMA} an object containing keys and their respective lists of failed rule names
+*/
 export declare const getSchemaErrorsSync: (object: CHECKABLE_OBJECT, schema: SCHEMA_SYNC, options?: SCHEMA_OPTIONS, ...overload: unknown[]) => CHECKED_SCHEMA_SYNC;
+/**
+ *
+ * @param {unknown} value the value to check
+ * @param {RULES|RULES_SYNC} rules rules object to use for validating the provided value
+ * @param {unknown[]} overload array of extra values the validator rules might need to properly validate the value
+ * @returns {string[]} a list of rule names which failed validation
+ */
 export declare const getValueErrors: (value: unknown, rules: RULES | RULES_SYNC, ...overload: unknown[]) => string[] | Promise<string[]>;
+/**
+ * Check a schema against all provided validation rules
+ *
+ * @param {CHECKABLE_OBJECT} object object to be validated
+ * @param {SCHEMA} schema schema to validate against
+ * @param {SCHEMA_OPTIONS} options options affecting how the rules are run
+ * @param {unknown[]} overload array of extra values the validator rules might need to properly validate the value
+ * @returns {CHECKED_SCHEMA} an object containing keys and their respective lists of failed rule names
+ */
 export declare const getSchemaErrors: (object: CHECKABLE_OBJECT, schema: SCHEMA_SYNC | SCHEMA, options?: SCHEMA_OPTIONS, ...overload: unknown[]) => CHECKED_SCHEMA_SYNC | CHECKED_SCHEMA;
 
 export {};

package/lib/index.js

@@ -1 +1 @@
-var W={strict:!1},X=(q)=>Object.values(q).some((x)=>typeof x==="function"&&x.constructor.name==="AsyncFunction"),Y=async(q,x,...G)=>{const z={};return Object.entries(x).forEach(([f,B])=>{z[f]=Promise.resolve(!1).then(()=>B(q,...G)).then((J)=>z[f]=J).catch(()=>z[f]=!1)}),await Promise.allSettled(Object.values(z)),Object.entries(z).reduce((f,[B,J])=>J?f:[...f,B],[])},$=async(q,x,G=W,...z)=>{const f={};if(Object.entries(x).forEach(([B,J])=>{f[B]=Y(q[B],J,...z).then((K)=>{f[B]=K}).catch((K)=>{f[B]=K})}),G.strict){const B=Object.keys(q),J=new Set(Object.keys(x));B.filter((Q)=>!J.has(Q)).forEach((Q)=>{f[Q]=["Key not allowed"]})}return await Promise.allSettled(Object.values(f)),f},Z=(q,x,...G)=>Object.entries(x).reduce((z,[f,B])=>{try{return B(q,...G)?z:[...z,f]}catch(J){return[...z,f]}},[]),R=(q,x,G=W,...z)=>{const f=Object.entries(x).reduce((B,[J,K])=>({...B,[J]:Z(q[J],K,...z)}),{});if(G.strict){const B=Object.keys(q),J=new Set(Object.keys(x));B.filter((Q)=>!J.has(Q)).forEach((Q)=>{f[Q]=["Key not allowed"]})}return f},C=(q,x,...G)=>{if(X(x))return Y(q,x,...G);return Z(q,x,...G)},H=(q,x,G=W,...z)=>{if(Object.values(x).some(X))return $(q,x,G,...z);return R(q,x,G,...z)};export{X as hasAsyncFunction,Z as getValueErrorsSync,Y as getValueErrorsAsync,C as getValueErrors,R as getSchemaErrorsSync,$ as getSchemaErrorsAsync,H as getSchemaErrors};
+var Z={strict:!1},$=(z)=>Object.values(z).some((q)=>typeof q==="function"&&q.constructor.name==="AsyncFunction"),J=async(z,q,...W)=>{const G={};return Object.entries(q).forEach(([x,Q])=>{G[x]=Promise.resolve(!1).then(()=>Q(z,...W)).then((R)=>G[x]=R).catch((R)=>{return console.warn(`Rule validation functions for "${x}" didn't exit cleanly`,R),G[x]=!1})}),await Promise.allSettled(Object.values(G)),Object.entries(G).reduce((x,[Q,R])=>R?x:[...x,Q],[])},K=async(z,q,W=Z,...G)=>{const x={};if(Object.entries(q).forEach(([Q,R])=>{x[Q]=J(z[Q],R,...G).then((X)=>{x[Q]=X}).catch((X)=>{x[Q]=X})}),W.strict){const Q=Object.keys(z),R=new Set(Object.keys(q));Q.filter((Y)=>!R.has(Y)).forEach((Y)=>{x[Y]=["Key not allowed"]})}return await Promise.allSettled(Object.values(x)),x},B=(z,q,...W)=>Object.entries(q).reduce((G,[x,Q])=>{try{return Q(z,...W)?G:[...G,x]}catch(R){return console.warn(`Rule validation function for "${x}" didn't exit cleanly`,R),[...G,x]}},[]),f=(z,q,W=Z,...G)=>{const x=Object.entries(q).reduce((Q,[R,X])=>({...Q,[R]:B(z[R],X,...G)}),{});if(W.strict){const Q=Object.keys(z),R=new Set(Object.keys(q));Q.filter((Y)=>!R.has(Y)).forEach((Y)=>{x[Y]=["Key not allowed"]})}return x},U=(z,q,...W)=>{if($(q))return J(z,q,...W);return B(z,q,...W)},I=(z,q,W=Z,...G)=>{if(Object.values(q).some($))return K(z,q,W,...G);return f(z,q,W,...G)};export{$ as hasAsyncFunction,B as getValueErrorsSync,J as getValueErrorsAsync,U as getValueErrors,f as getSchemaErrorsSync,K as getSchemaErrorsAsync,I as getSchemaErrors};

package/lib/patterns/index.d.ts

@@ -1,4 +1,4 @@
-// Generated by dts-bundle-generator v8.1.1
+// Generated by dts-bundle-generator v9.5.1
 
 export declare const EMAIL_PATTERN: RegExp;
 export declare const MYSQL_TIMESTAMP_PATTERN: RegExp;

package/lib/patterns/index.js

@@ -1 +1 @@
-var x=/^[\w.%+-]+@[\w.-]+\.[a-zA-Z]{1,}$/,c=/^(\d{4})-(\d{2})-(\d{2}) (\d{2}):(\d{2}):(\d{2})$/,d=/^(https?:\/\/)?([^\s$.?#].[^\s]*)\.[a-z]{2,}(\/[^\s]*)?$/i,f=/^(\d{4}-[01]\d-[0-3]\dT[0-2]\d:[0-5]\d:[0-5]\d\.\d+([+-][0-2]\d:[0-5]\d|Z))|(\d{4}-[01]\d-[0-3]\dT[0-2]\d:[0-5]\d:[0-5]\d([+-][0-2]\d:[0-5]\d|Z))|(\d{4}-[01]\d-[0-3]\dT[0-2]\d:[0-5]\d([+-][0-2]\d:[0-5]\d|Z))$/,j=/^(\d{4}-[01]\d-[0-3]\dT[0-2]\d:[0-5]\d:[0-5]\d\.\d+)|(\d{4}-[01]\d-[0-3]\dT[0-2]\d:[0-5]\d:[0-5]\d)|(\d{4}-[01]\d-[0-3]\dT[0-2]\d:[0-5]\d)$/,k=/^(2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])(Z|[+-](?:2[0-3]|[01][0-9])(?::?(?:[0-5][0-9]))?)$/,l=/^(?:(Sun|Mon|Tue|Wed|Thu|Fri|Sat),\s+)?(0[1-9]|[1-2]?[0-9]|3[01])\s+(Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec)\s+(19[0-9]{2}|[2-9][0-9]{3})\s+(2[0-3]|[0-1][0-9]):([0-5][0-9])(?::(60|[0-5][0-9]))?\s+([-\+][0-9]{2}[0-5][0-9]|(?:UT|GMT|(?:E|C|M|P)(?:ST|DT)|[A-IK-Z]))(\s+|\(([^\(\)]+|\\\(|\\\))*\))*$/,m=/(?=.*[a-z])/,p=/(?=.*[A-Z])/,q=/(?=.*\d)/,r=/[^\w]/;export{d as URL_PATTERN,l as RFC_2822_TIMESTAMP_PATTERN,c as MYSQL_TIMESTAMP_PATTERN,k as ISO_8601_TIME_PATTERN,f as ISO_8601_DATETIME_PATTERN_STRICT,j as ISO_8601_DATETIME_PATTERN,x as EMAIL_PATTERN,p as CONTAINS_UPPERCASE_CHARACTER_PATTERN,r as CONTAINS_SYMBOL_CHARACTER_PATTERN,m as CONTAINS_LOWERCASE_CHARACTER_PATTERN,q as CONTAINS_DIGIT_CHARACTER_PATTERN};
+var x=/^[\w.%+-]+@[\w.-]+\.[a-zA-Z]{1,}$/,c=/^(\d{4})-(\d{2})-(\d{2}) (\d{2}):(\d{2}):(\d{2})$/,d=/^(https?:\/\/)?([^\s$.?#].[^\s]*)\.[a-z]{2,}(\/[^ \t\r\n\v\f]*)?$/i,f=/^(\d{4}-[01]\d-[0-3]\dT[0-2]\d:[0-5]\d:[0-5]\d(?:\.\d+)?(?:[+-][0-2]\d:[0-5]\d|Z)?)$/,j=/^(\d{4}-[01]\d-[0-3]\dT[0-2]\d:[0-5]\d(?::[0-5]\d(?:\.\d+)?)?)$/,k=/^(2[0-3]|[01][0-9]):([0-5][0-9]):([0-5][0-9])(Z|[+-](?:2[0-3]|[01][0-9]):([0-5][0-9]))?$/,l=/^(?:(Sun|Mon|Tue|Wed|Thu|Fri|Sat),\s)?(0[1-9]|[1-2]?[0-9]|3[01])\s(Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec)\s(19[0-9]{2}|[2-9][0-9]{3})\s(2[0-3]|[0-1][0-9]):([0-5][0-9])(?::(60|[0-5][0-9]))?\s([-\+][0-9]{2}[0-5][0-9]|(?:UT|GMT|(?:E|C|M|P)(?:ST|DT)|[A-IK-Z]))(?:\s|\((?:[^()\\]+|\\.)*?\))*$/,m=/[a-z]/,p=/[A-Z]/,q=/\d/,r=/[^\w\s]/;export{d as URL_PATTERN,l as RFC_2822_TIMESTAMP_PATTERN,c as MYSQL_TIMESTAMP_PATTERN,k as ISO_8601_TIME_PATTERN,f as ISO_8601_DATETIME_PATTERN_STRICT,j as ISO_8601_DATETIME_PATTERN,x as EMAIL_PATTERN,p as CONTAINS_UPPERCASE_CHARACTER_PATTERN,r as CONTAINS_SYMBOL_CHARACTER_PATTERN,m as CONTAINS_LOWERCASE_CHARACTER_PATTERN,q as CONTAINS_DIGIT_CHARACTER_PATTERN};

package/package.json

@@ -1,13 +1,13 @@
 {
   "name": "ivl",
-  "version": "0.2.0",
+  "version": "0.2.5",
   "author": {
     "name": "Oskar Voorel",
     "email": "oskar@voorel.com"
   },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/Oskar-V/validator.git"
+    "url": "git+https://github.com/Oskar-V/ivl.git"
   },
   "main": "lib/index.js",
   "devDependencies": {
@@ -33,13 +33,13 @@
     }
   },
   "bugs": {
-    "url": "https://github.com/Oskar-V/validator/issues/new"
+    "url": "https://github.com/Oskar-V/ivl/issues/new"
   },
   "description": "Lightweight input validation",
   "files": [
     "lib"
   ],
-  "homepage": "https://github.com/Oskar-V/validator",
+  "homepage": "https://github.com/Oskar-V/ivl",
   "keywords": [
     "validation",
     "typescript",