ivl 0.1.0 → 0.1.2

package/README.md

@@ -1,8 +1,154 @@
 # 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
 
+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. 
 # Main functionality
-## Example
-```typescript
+Write your own custom validators to exactly match your usecase using a simple object:
+```javascript
+const my_rules = {
+	"Input must be more than 4": (i) => i > 4,
+	"Input must be divisible by 10": (i) => i % 10
+}
+```
+The input will be checked against your rule set and return all failing rules names as a string array.
+
+
+## Frontend example
+```javascript
 // src/index.ts
+import { getInputErrorsSync, getInputErrors } from 'ivl';
+import type { RULES } from 'ivl';
+import { matchesRegex, stringBetween, type } from 'ivl/helpers';
+
+// This is also exportable from 'ivl/patterns'
+const EMAIL_PATTERN = /^[\w.%+-]+@[\w.-]+\.[a-zA-Z]{1,}$/;
+
+const EMAIL_REQUIREMENTS: RULES = {
+	"Must be string": type('string'),
+	"Must be less then 100 characters": stringBetween(),
+	"Not a valid email address": matchesRegex(EMAIL_PATTERN),
+	"That email is already in use": async (i) => {
+		// Fetch info from whatever backend and make a decision based on that asynchronously
+		const email_in_use = await fetch(`https://mybackend/email-exists/${i}`)
+		return !email_in_use // We will return true if the email is not already taken
+	}
+};
+
+const PASSWORD_REQUIREMENTS: RULES = {
+	"Must be string": type('string'),
+	"Must be at least 8 characters": stringBetween(Infinity, 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 = {
+	...PASSWORD_REQUIREMENTS,
+	"Must contain at least one digit": matchesRegex(/(?=.*\d)/),
+	"Must contain at least one symbol": matchesRegex(/[^\w]/),
+};
+
+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);
+
+console.log({email_errors, pw_errors, strong_pw_errors});
+```
+
+
+## Backend example with Hono & Bun.js
+
+```typescript
+// rules.ts
+const EMAIL_REQUIREMENTS = {
+	"Must be string": type('string'),
+	"Must be less then 100 characters": stringBetween(),
+	"Not a valid email address": matchesRegex(EMAIL_PATTERN),
+};
+
+const PASSWORD_REQUIREMENTS = {
+	"Must be string": type('string'),
+	"Must be at least 8 characters": stringBetween(Infinity, 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]/),
+};
+
+export const LOGIN_SCHEMA =  {
+	email: EMAIL_REQUIREMENTS,
+	password: PASSWORD_REQUIREMENTS
+}
+
+export const REGISTER_SCHEMA = {
+	organization_name: {} // Pass in an empty rule set, so the value can be whatever
+	email: {
+		...EMAIL_REQUIREMENTS,
+		"Email already registered": checkValueInDatabase('email','users', false)
+	},
+	password: PASSWORD_REQUIREMENTS
+}
+
+export const INVITATION_PARAM: SCHEMA = {
+	code: {
+		"Not a valid invitation": existsInDatabase('code', 'invitation')
+	}
+}
+
+```
+
+```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'
+
+// 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, jwt);
+		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)),
+	(c) => c.text("Success"));
+
+app.all('/logout', (c) => c.text("Success"));
+
+app.put('/register', 
+	validator('json', validateWrapper(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)
+)),
+	(c)=> c.text("Success")))
 
+export default app;
 ```

package/lib/helpers/index.js

@@ -0,0 +1 @@
+var p=(e)=>(n)=>typeof n===e,s=(e)=>(n)=>typeof n==="string"&&e.test(n),i=(e=100,n=0)=>(t)=>typeof t==="string"&&t.length>=n&&t.length<e,w=(e=100,n=1)=>(t)=>typeof t==="number"&&t>=n&&t<e,f=(e=[])=>async(n,...t)=>(await Promise.all(e.map((o)=>o.call(void 0,n,...t)))).some((o)=>o),d=(e)=>Object.entries(e).reduce((n,[t,o])=>({...n,[t]:(r,...c)=>typeof r==="undefined"?!0:o(r,...c)}),{}),k=(e,n)=>Object.entries(n).reduce((t,[o,r])=>({...t,[o]:(c,...u)=>r(e(c),...u)}),{});export{p as type,i as stringBetween,k as preprocess,w as numberBetween,s as matchesRegex,d as allowUndefined,f as acceptAny};

package/lib/index.d.ts

@@ -1,17 +1,7 @@
 // Generated by dts-bundle-generator v8.1.1
 
-export type RULE = (value: unknown, ...overload: unknown[]) => boolean | Promise<boolean>;
-export type RULES = {
-	[index: string]: RULE;
-};
-export type CHECKABLE_OBJECT = {
-	[index: string]: unknown;
-};
-export type SCHEMA = {
-	[index: string]: RULES;
-};
-export type CHECKED_SCHEMA = Promise<{
-	[index: string]: string[];
-}>;
+export declare const EMAIL_PATTERN: RegExp;
+export declare const TIMESTAMP_PATTERN: RegExp;
+export declare const URL_PATTERN: RegExp;
 
 export {};

package/lib/index.js

@@ -1 +1 @@
-var P=Object.create;var{defineProperty:R,getPrototypeOf:T,getOwnPropertyNames:f}=Object;var B=Object.prototype.hasOwnProperty;var A=(C,E,x)=>{for(let n of f(E))if(!B.call(C,n)&&n!=="default")R(C,n,{get:()=>E[n],enumerable:!0});if(x){for(let n of f(E))if(!B.call(x,n)&&n!=="default")R(x,n,{get:()=>E[n],enumerable:!0});return x}},M=(C,E,x)=>{x=C!=null?P(T(C)):{};const n=E||!C||!C.__esModule?R(x,"default",{value:C,enumerable:!0}):x;for(let p of f(C))if(!B.call(n,p))R(n,p,{get:()=>C[p],enumerable:!0});return n};var _=(C,E)=>()=>(E||C((E={exports:{}}).exports,E),E.exports);var d=(C,E)=>{for(var x in E)R(C,x,{get:E[x],enumerable:!0,configurable:!0,set:(n)=>E[x]=()=>n})};var K=_((J)=>{var D=async(C,E,...x)=>{const n={};return Object.entries(E).forEach(([p,H])=>{n[p]=Promise.resolve().then(()=>H(C,...x)).then((L)=>n[p]=L).catch(()=>{n[p]=!1})}),await Promise.allSettled(Object.values(n)),Object.entries(n).reduce((p,[H,L])=>L?p:[...p,H],[])},w=async(C,E,x=!1,...n)=>{const p={};if(Object.entries(E).forEach(([H,L])=>{p[H]=D(C[H],L,...n).then((S)=>{p[H]=S}).catch((S)=>{p[H]=S})}),x){const H=Object.keys(C),L=new Set(Object.keys(E));H.filter((U)=>!L.has(U)).forEach((U)=>{p[U]=["Key not allowed"]})}return await Promise.allSettled(Object.values(p)),p};J={getValueErrors:D,getSchemaErrors:w}});var i={};d(i,{ivl:()=>O,default:()=>q});var O=M(K(),1);A(i,M(K(),1));var g={};var q=O;export{O as ivl,q as default};
+var U=async(E,S,...L)=>{const p={};return Object.entries(S).forEach(([n,x])=>{p[n]=Promise.resolve().then(()=>x(E,...L)).then((C)=>p[n]=C).catch(()=>{p[n]=!1})}),await Promise.allSettled(Object.values(p)),Object.entries(p).reduce((n,[x,C])=>C?n:[...n,x],[])},N=async(E,S,L=!1,...p)=>{const n={};if(Object.entries(S).forEach(([x,C])=>{n[x]=U(E[x],C,...p).then((i)=>{n[x]=i}).catch((i)=>{n[x]=i})}),L){const x=Object.keys(E),C=new Set(Object.keys(S));x.filter((R)=>!C.has(R)).forEach((R)=>{n[R]=["Key not allowed"]})}return await Promise.allSettled(Object.values(n)),n},H=(E,S,...L)=>Object.entries(S).reduce((p,[n,x])=>x(E,...L)?p:[...p,n],[]),Y=(E,S,L=!1,...p)=>{const n=Object.entries(S).reduce((x,[C,i])=>({...x,[C]:H(E[C],i,...p)}),{});if(L){const x=Object.keys(E),C=new Set(Object.keys(S));x.filter((R)=>!C.has(R)).forEach((R)=>{n[R]=["Key not allowed"]})}return n};export{H as getValueErrorsSync,U as getValueErrors,Y as getSchemaErrorsSync,N as getSchemaErrors};

package/lib/patterns/index.js

@@ -0,0 +1 @@
+var T=/^[\w.%+-]+@[\w.-]+\.[a-zA-Z]{1,}$/,s=/^(\d{4})-(\d{2})-(\d{2}) (\d{2}):(\d{2}):(\d{2})$/,t=/^(https?:\/\/)?([^\s$.?#].[^\s]*)\.[a-z]{2,}(\/[^\s]*)?$/i;export{t as URL_PATTERN,s as TIMESTAMP_PATTERN,T as EMAIL_PATTERN};

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "ivl",
-	"version": "0.1.0",
+	"version": "0.1.2",
 	"main": "lib/index.js",
 	"types": "lib/index.d.ts",
 	"description": "Lightweight input validation",
@@ -8,6 +8,13 @@
 		"name": "Oskar Voorel",
 		"email": "oskar@voorel.com"
 	},
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/Oskar-V/validator.git"
+	},
+	"bugs": {
+		"url": "https://github.com/Oskar-V/validator/issues/new"
+	},
 	"scripts": {
 		"build": "bun run build.mjs",
 		"prepublishOnly": "bun run build"
@@ -25,6 +32,14 @@
 		".": {
 			"types": "./lib/index.d.ts",
 			"default": "./lib/index.js"
+		},
+		"./patterns": {
+			"types": "./lib/patterns/index.d.ts",
+			"default": "./lib/patterns/index.js"
+		},
+		"./helpers": {
+			"types": "./lib/helpers/index.d.ts",
+			"default": "./lib/helpers/index.js"
 		}
 	},
 	"sideEffects": "false",