ivl 0.1.6 → 0.2.5

package/README.md

@@ -2,7 +2,14 @@
 This is a lightweight library for user input validation.
 Main focus is on speed and flexibility of the validation rules
 
-Supports asynchronous rule validation by default. Use `getInputErrorsSync` and `getSchemaErrorsSync` for better performance if you don't need to support asynchronous checks on your inputs. 
+By default it automatically detects and supports async rules in your rule sets.
+
+If your rule set and/or object are very large or complex, you may want to use 
+`getInputErrorsSync`/`getSchemaErrorsSync` or `getInputErrorsAsync`/`getSchemaErrorsAsync` for improved performance on synchronous and asynchronous rule sets respectively.
+
+Use synchronous versions of the functions for better performance if you don't need to support asynchronous checks on your inputs. 
+
+
 # Main functionality
 Write your own custom validators to exactly match your use case using a simple object:
 ```javascript
@@ -14,8 +21,24 @@ console.log(getInputErrors(50, my_rules)); // []
 console.log(getInputErrors(11, my_rules)); // ["Input must be more than 40", "Input must be divisible by 10"]
 console.log(getInputErrors(30, my_rules)) // ["Input must be more than 40"]
 
+```
+# Installing
+### Bun.js
+```typescript
+bun add ivl
+```
+
+### yarn
+```typescript
+yarn add ivl
 ```
 
+### npm
+```typescript
+npm install ivl
+```
+---
+# Usage examples
 ## Frontend example
 ```javascript
 // src/index.ts
@@ -39,10 +62,10 @@ const EMAIL_REQUIREMENTS: RULES = {
 
 const PASSWORD_REQUIREMENTS: RULES = {
   "Must be string": isType('string'),
-  "Must be at least 8 characters": minLength(Infinity, 8),
+  "Must be at least 8 characters": minLength(8),
   "Must contain at least one upper case character": matchesRegex(/(?=.*[A-Z])/),
   "Must contain at least one lower case character": matchesRegex(/(?=.*[a-z])/),
-}
+};
 
 // You can of course expand on your existing rules: 
 const STRONG_PASSWORD_REQUIREMENTS: RULES = {
@@ -92,7 +115,7 @@ const PASSWORD_REQUIREMENTS = {
 export const LOGIN_SCHEMA: SCHEMA =  {
   email: EMAIL_REQUIREMENTS,
   password: PASSWORD_REQUIREMENTS
-}
+};
 
 export const REGISTER_SCHEMA: SCHEMA = {
   organization_name: {} // Pass in an empty rule set, so the value can be whatever
@@ -101,13 +124,13 @@ export const REGISTER_SCHEMA: SCHEMA = {
     "Email already registered": existsInDatabase('email','users', false)
   },
   password: PASSWORD_REQUIREMENTS
-}
+};
 
 export const INVITATION_PARAM: SCHEMA = {
   code: {
     "Not a valid invitation": existsInDatabase('code', 'invitation')
   }
-}
+};
 
 ```
 
@@ -118,7 +141,7 @@ import { jwt } from 'hono/jwt';
 import { validator } from 'hono/validator';
 import { getSchemaErrors } from 'ivl';
 import type { SCHEMA } from 'ivl';
-import { LOGIN_SCHEMA, REGISTER_SCHEMA, INVITATION_PARAM } from './rules.ts'
+import { LOGIN_SCHEMA, REGISTER_SCHEMA, INVITATION_PARAM } from './rules.ts';
 
 // Wrapper for hono validator middleware
 const validateWrapper = (schema: SCHEMA, error: ClientErrorStatusCode | RedirectStatusCode = 400, strict = true) =>

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,9 +27,67 @@ export type CHECKED_SCHEMA_SYNC = {
 	[index: string]: string[];
 };
 export type CHECKED_SCHEMA = Promise<CHECKED_SCHEMA_SYNC>;
-export declare const getValueErrors: (value: unknown, rules: RULES, ...overload: unknown[]) => Promise<string[]>;
-export declare const getSchemaErrors: (object: CHECKABLE_OBJECT, schema: SCHEMA, options?: SCHEMA_OPTIONS, ...overload: unknown[]) => CHECKED_SCHEMA;
+/**
+ * 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=async(B,G,...J)=>{const q={};return Object.entries(G).forEach(([x,f])=>{q[x]=Promise.resolve(!1).then(()=>f(B,...J)).then((z)=>q[x]=z).catch(()=>q[x]=!1)}),await Promise.allSettled(Object.values(q)),Object.entries(q).reduce((x,[f,z])=>z?x:[...x,f],[])},Z=async(B,G,J=W,...q)=>{const x={};if(Object.entries(G).forEach(([f,z])=>{x[f]=X(B[f],z,...q).then((K)=>{x[f]=K}).catch((K)=>{x[f]=K})}),J.strict){const f=Object.keys(B),z=new Set(Object.keys(G));f.filter((Q)=>!z.has(Q)).forEach((Q)=>{x[Q]=["Key not allowed"]})}return await Promise.allSettled(Object.values(x)),x},Y=(B,G,...J)=>Object.entries(G).reduce((q,[x,f])=>{try{return f(B,...J)?q:[...q,x]}catch(z){return[...q,x]}},[]),$=(B,G,J=W,...q)=>{const x=Object.entries(G).reduce((f,[z,K])=>({...f,[z]:Y(B[z],K,...q)}),{});if(J.strict){const f=Object.keys(B),z=new Set(Object.keys(G));f.filter((Q)=>!z.has(Q)).forEach((Q)=>{x[Q]=["Key not allowed"]})}return x};export{Y as getValueErrorsSync,X as getValueErrors,$ as getSchemaErrorsSync,Z 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;
@@ -7,5 +7,9 @@ export declare const ISO_8601_DATETIME_PATTERN_STRICT: RegExp;
 export declare const ISO_8601_DATETIME_PATTERN: RegExp;
 export declare const ISO_8601_TIME_PATTERN: RegExp;
 export declare const RFC_2822_TIMESTAMP_PATTERN: RegExp;
+export declare const CONTAINS_LOWERCASE_CHARACTER_PATTERN: RegExp;
+export declare const CONTAINS_UPPERCASE_CHARACTER_PATTERN: RegExp;
+export declare const CONTAINS_DIGIT_CHARACTER_PATTERN: RegExp;
+export declare const CONTAINS_SYMBOL_CHARACTER_PATTERN: RegExp;
 
 export {};

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+|\(([^\(\)]+|\\\(|\\\))*\))*$/;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};
+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,17 +1,17 @@
 {
   "name": "ivl",
-  "version": "0.1.6",
+  "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": {
-    "@types/bun": "^1.0.0",
+    "@types/bun": "latest",
     "bun-plugin-dts": "^0.2.1",
     "mitata": "^0.1.11",
     "typescript": "^5.2.2",
@@ -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",