ivl 0.2.5 → 0.2.7

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Oskar-V
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,11 +1,10 @@
 # Super lightweight input validation library
 This is a lightweight library for user input validation.
-Main focus is on speed and flexibility of the validation rules
+Main focus is on speed and flexibility of the validation rules.
 
-By default it automatically detects and supports async rules in your rule sets.
+By default `getInputErrors` and `getSchemaErrors` automatically detects and chooses the most performant checking method for your rule set.
 
-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.
+If your rule set and/or schema are very large or complex, you may want to directly 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. 
 
@@ -20,29 +19,23 @@ const my_rules = {
 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
+bun add ivl // bun.js
+yarn add ivl // yarn
+npm install ivl // npm
+pnpm install ivl // pnpm
 ```
 
-### yarn
-```typescript
-yarn add ivl
-```
+*deno coming soon*
 
-### npm
-```typescript
-npm install ivl
-```
 ---
 # Usage examples
 ## Frontend example
-```javascript
-// src/index.ts
-import { getInputErrorsSync, getInputErrors } from 'ivl';
+### `index.ts`
+```typescript
+import { getInputErrors } from 'ivl';
 import type { RULES } from 'ivl';
 import { matchesRegex, minLength, maxLength, isType } from 'ivl/helpers';
 
@@ -63,23 +56,23 @@ const EMAIL_REQUIREMENTS: RULES = {
 const PASSWORD_REQUIREMENTS: RULES = {
   "Must be string": isType('string'),
   "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])/),
+  "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 = {
   ...PASSWORD_REQUIREMENTS,
-  "Must contain at least one digit": matchesRegex(/(?=.*\d)/),
-  "Must contain at least one symbol": matchesRegex(/[^\w]/),
+  "Must contain at least one digit": matchesRegex(/\d/),
+  "Must contain at least one symbol": matchesRegex(/[^\w\s]/),
 };
 
 const email_value = "some-value";
 const pw_value = "Passesweakpw";
 
 const email_errors = getInputErrors(email_value, EMAIL_REQUIREMENTS);
-const pw_errors = getInputErrorsSync(pw_value, PASSWORD_REQUIREMENTS);
-const strong_pw_errors = getInputErrorsSync(pw_value, STRONG_PASSWORD_REQUIREMENTS);
+const pw_errors = getInputErrors(pw_value, PASSWORD_REQUIREMENTS);
+const strong_pw_errors = getInputErrors(pw_value, STRONG_PASSWORD_REQUIREMENTS);
 
 console.log({email_errors, pw_errors, strong_pw_errors});
 ```
@@ -87,10 +80,11 @@ console.log({email_errors, pw_errors, strong_pw_errors});
 
 ## Backend example with Hono & Bun.js
 
+### `rules.ts`
 ```typescript
-// rules.ts
-
 import { isType, minLength, maxLength, matchesRegex } from 'ivl/helpers';
+import { EMAIL_PATTERN } from 'ivl/patterns';
+import type { SCHEMA } from 'ivl';
 import { checkValueInDatabase } from 'my-database-controller';
 
 const existsInDatabase = (key: string, table: string, exists: boolean = true): RULE =>
@@ -106,10 +100,10 @@ const EMAIL_REQUIREMENTS = {
 const PASSWORD_REQUIREMENTS = {
   "Must be string": isType('string'),
   "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])/),
-  "Must contain at least one digit": matchesRegex(/(?=.*\d)/),
-  "Must contain at least one symbol": matchesRegex(/[^\w]/),
+  "Must contain at least one upper case character": matchesRegex(/[A-Z]/),
+  "Must contain at least one lower case character": matchesRegex(/[a-z]/),
+  "Must contain at least one digit": matchesRegex(/\d/),
+  "Must contain at least one symbol": matchesRegex(/[^\w\s]/),
 };
 
 export const LOGIN_SCHEMA: SCHEMA =  {
@@ -118,7 +112,9 @@ export const LOGIN_SCHEMA: SCHEMA =  {
 };
 
 export const REGISTER_SCHEMA: SCHEMA = {
-  organization_name: {} // Pass in an empty rule set, so the value can be whatever
+	// We can pass in an empty rule set to allow any value
+	// Or we can omit the argument entirely and set the strict flag to false when checking the schema
+  organization_name: {}
   email: {
     ...EMAIL_REQUIREMENTS,
     "Email already registered": existsInDatabase('email','users', false)
@@ -126,61 +122,55 @@ export const REGISTER_SCHEMA: SCHEMA = {
   password: PASSWORD_REQUIREMENTS
 };
 
+// Registering via invitation needs all the same values except organization name
+// inherit parts of rule sets, as opposed to extending the rule set as show in the
+// frontend example
+export const INVITE_REGISTER_SCHEMA = (({ organization_name, ...invite_schema }) => invite_schema)(REGISTRATION_SCHEMA)
+
 export const INVITATION_PARAM: SCHEMA = {
-  code: {
+  invitation_code: {
     "Not a valid invitation": existsInDatabase('code', 'invitation')
   }
 };
 
 ```
 
+### `index.ts`
 ```typescript
-// index.ts
 import { Hono } from 'hono';
-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, INVITE_REGISTER_SCHEMA, INVITATION_PARAM } from './rules.ts';
 
 // Wrapper for hono validator middleware
-const validateWrapper = (schema: SCHEMA, error: ClientErrorStatusCode | RedirectStatusCode = 400, strict = true) =>
-  async (value: any, c: Context) => {
-    const jwt = c.get('jwtPayload'); // Pass jwt to the validator so we could use its value when checking input validation rules
-    const errors = await getSchemaErrors(value, schema, {strict:true}, jwt);
+const validateWrapper = async (input_type:string, schema: SCHEMA) => 
+	validate(input_type, async (value: any, c: Context) => {
+    const errors = await getSchemaErrors(value, schema, { strict: true });
     if (Object.values(errors).filter((e) => e.length).length) {
       throw new HTTPException(error, {
         message: JSON.stringify(errors),
       });
     }
     return value;
-  }
+  })
 
 const app = new Hono();
 
-app.use(jwt({
-  secret: "some-secret-value",
-  cookie: 'token'
-}));
-
 app.post('/login',
-  validator('json', validateWrapper(LOGIN_SCHEMA)),
+	validateWrapper('json', LOGIN_SCHEMA),
   (c) => c.text("Success"));
 
 app.all('/logout', (c) => c.text("Success"));
 
 app.put('/register', 
-  validator('json', validateWrapper(REGISTER_SCHEMA)),
+  validateWrapper('json', REGISTER_SCHEMA),
   (c) => c.text("Success"));
 
 // This first validates the invitation parameter against our database
 // And then validates the body of the request
 app.put('/register/:invitation_code',
-  validator('param', validateWrapper(INVITATION_PARAM)),
-  validator('json', validateWrapper(
-    // Registering via invitation needs all the same values except organization name - inherit parts of rule sets, as opposed to extending the rule set as shown above
-    (({ organization_name, ...invite_schema }) => invite_schema)(REGISTRATION_SCHEMA)
-  )),
+  validateWrapper('param', INVITATION_PARAM),
+  validateWrapper('json', INVITE_REGISTER_SCHEMA ),
   (c)=> c.text("Success"));
 
 export default app;

package/lib/helpers/index.js

@@ -1 +1 @@
-var s=(n)=>n!==null&&typeof n==="object"&&("length"in n)&&typeof n.length==="number",p=(n)=>(e)=>typeof e===n,i=(n)=>(e)=>typeof e==="string"&&n.test(e),m=(n=1/0)=>(e)=>typeof e==="number"&&e<=n,f=(n=-1/0)=>(e)=>typeof e==="number"&&e>=n,w=(n=1/0)=>(e)=>s(e)&&e.length<=n,y=(n=1/0)=>(e)=>s(e)&&e.length>=n,a=(n=100,e=0)=>(t)=>typeof t==="string"&&t.length>=e&&t.length<n,L=(n=100,e=1)=>(t)=>typeof t==="number"&&t>=e&&t<n,h=(n=[])=>async(e,...t)=>(await Promise.all(n.map((o)=>o(void 0,e,...t)))).some((o)=>o),R=(n=[])=>(e,...t)=>n.map((o)=>o(void 0,e,...t)).some((o)=>o);var g=(n)=>Object.entries(n).reduce((e,[t,o])=>({...e,[t]:(r,...u)=>typeof r==="undefined"?!0:o(r,...u)}),{}),l=(n,e)=>Object.entries(e).reduce((t,[o,r])=>({...t,[o]:(u,...c)=>r(n(u),...c)}),{});export{a as stringBetween,l as preprocess,L as numberBetween,y as minLength,f as min,w as maxLength,m as max,i as matchesRegex,p as isType,g as allowUndefined,R as acceptAnySync,h as acceptAny};
+var s=(n)=>typeof n==="string"||n!==null&&typeof n==="object"&&("length"in n)&&typeof n.length==="number",c=(n)=>(e)=>typeof e===n,i=(n)=>(e)=>typeof e==="string"&&n.test(e),f=(n=1/0)=>(e)=>typeof e==="number"&&e<=n,m=(n=-1/0)=>(e)=>typeof e==="number"&&e>=n,y=(n=1/0)=>(e)=>s(e)&&e.length<=n,w=(n=0)=>(e)=>s(e)&&e.length>=n,a=(n=1/0,e=0)=>(t)=>typeof t==="string"&&t.length>=e&&t.length<=n,L=(n=1/0,e=-1/0)=>(t)=>typeof t==="number"&&t>=e&&t<=n,g=(n=[])=>async(e,...t)=>(await Promise.all(n.map((o)=>o(void 0,e,...t)))).some((o)=>o),h=(n=[])=>(e,...t)=>n.map((o)=>o(void 0,e,...t)).some((o)=>o);var l=(n)=>Object.entries(n).reduce((e,[t,o])=>({...e,[t]:(r,...u)=>typeof r==="undefined"?!0:o(r,...u)}),{}),x=(n,e)=>Object.entries(e).reduce((t,[o,r])=>({...t,[o]:(u,...p)=>r(n(u),...p)}),{});export{a as stringBetween,x as preprocess,L as numberBetween,w as minLength,m as min,y as maxLength,f as max,i as matchesRegex,c as isType,l as allowUndefined,h as acceptAnySync,g as acceptAny};

package/lib/patterns/index.d.ts

@@ -6,7 +6,6 @@ export declare const URL_PATTERN: RegExp;
 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;

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,}(\/[^ \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};
+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=/[a-z]/,m=/[A-Z]/,p=/\d/,q=/[^\w\s]/;export{d as URL_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,m as CONTAINS_UPPERCASE_CHARACTER_PATTERN,q as CONTAINS_SYMBOL_CHARACTER_PATTERN,l as CONTAINS_LOWERCASE_CHARACTER_PATTERN,p as CONTAINS_DIGIT_CHARACTER_PATTERN};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ivl",
-  "version": "0.2.5",
+  "version": "0.2.7",
   "author": {
     "name": "Oskar Voorel",
     "email": "oskar@voorel.com"