@dwtechs/antity 0.9.1 → 0.10.0

package/README.md

@@ -143,6 +143,7 @@ type Type =
   "array" |
   "jwt" |
   "symbol" |
+  "password" |
   "email" |
   "regex" |
   "json" |
@@ -203,7 +204,7 @@ class Entity {
    * Normalizes an array of records by applying sanitization and normalization
    * rules defined in the `properties` of the class.
    */
-  normalize(req: Request, _res: Response, next: NextFunction): void;
+  normalize: (req: Request, _res: Response, next: NextFunction) => void;
   
   /**
    * Validates a set of rows against the defined properties and operation/method.
@@ -211,7 +212,7 @@ class Entity {
    * If a property is required and missing, or if it fails the control checks, the function returns an error message.
    * Otherwise, it returns `null` indicating successful validation.
    */
-  validate(req: Request, _res: Response, next: NextFunction): void;
+  validate: (req: Request, _res: Response, next: NextFunction) => void;
 }
 
 ```
@@ -219,6 +220,35 @@ normalize() and validate() methods are made to be used as Express.js middlewares
 Each method will look for data to work on in the **req.body.rows** parameter.
 
 
+### Password validation
+
+Password validation will have the following options by default : 
+
+```javascript
+const PWD_MIN_LENGTH = 9;
+const PWD_MAX_LENGTH = 20;
+const PWD_NUMBERS = true; // password must contain a number
+const PWD_UPPERCASE = true; // password must contain an uppercase letter
+const PWD_LOWERCASE = true; // password must contain a lowercase letter
+const PWD_SYMBOLS = true; //  password must contain at least one of the following symbol character : !@#%*_-+=:?><./()
+```
+
+#### Environment variables
+
+You can update password default validator by setting the following environment variables :
+
+```javascript
+  PWD_MIN_LENGTH_POLICY,
+  PWD_MAX_LENGTH_POLICY,
+  PWD_NUMBERS_POLICY,
+  PWD_UPPERCASE_POLICY,
+  PWD_LOWERCASE_POLICY,
+  PWD_SYMBOLS_POLICY
+```
+
+Properties **min** and **max** of the password properties will override default and environement variable if set.
+
+
 ### Available options for a property
 
 Any of these can be passed into the options object for each function.

package/dist/antity.d.ts

@@ -42,6 +42,7 @@ type Type =
   "array" |
   "jwt" |
   "symbol" |
+  "password" |
   "email" |
   "regex" |
   "json" |
@@ -67,15 +68,15 @@ declare class Entity {
   set name(name: string);
   getProp(key: string): Property | undefined;
   getPropsByMethod(method: Method): Property[];
-  normalize(req: Request, _res: Response, next: NextFunction): void;
-  validate(req: Request, _res: Response, next: NextFunction): void;
+  normalize: (req: Request, _res: Response, next: NextFunction) => void;
+  validate: (req: Request, _res: Response, next: NextFunction) => void;
 }
 
 declare class Property {
   key: string;
   type: Type;
-  min: number | Date;
-  max: number | Date;
+  min: number | Date | null;
+  max: number | Date | null;
   required: boolean;
   safe: boolean;
   typeCheck: boolean;
@@ -89,8 +90,8 @@ declare class Property {
   constructor(
     key: string,
     type: Type,
-    min: number | Date,
-    max: number | Date,
+    min: number | Date | null,
+    max: number | Date | null,
     required: boolean,
     safe: boolean,
     typeCheck: boolean,

package/dist/antity.js

@@ -24,11 +24,18 @@ SOFTWARE.
 https://github.com/DWTechs/Antity.js
 */
 
-import { isBoolean, isStringOfLength, isValidNumber, isValidInteger, isValidFloat, isEven, isOdd, isPositive, isNegative, isPowerOfTwo, isAscii, isArrayOfLength, isEmail, isRegex, isJson, isJWT, isSymbol, isIpAddress, isSlug, isHexadecimal, isValidDate, isValidTimestamp, isFunction, isHtmlElement, isHtmlEventAttribute, isNode, isObject, isString, isProperty, isArray, isIn, isDate, isNumber, isInteger, isNil } from '@dwtechs/checkard';
+import { isBoolean, isStringOfLength, isValidNumber, isValidInteger, isValidFloat, isEven, isOdd, isPositive, isNegative, isPowerOfTwo, isAscii, isArrayOfLength, isValidPassword, isEmail, isRegex, isJson, isJWT, isSymbol, isIpAddress, isSlug, isHexadecimal, isValidDate, isValidTimestamp, isFunction, isHtmlElement, isHtmlEventAttribute, isNode, isObject, isString, isProperty, isArray, isIn, isDate, isNumber, isInteger, isNil } from '@dwtechs/checkard';
 import { log } from '@dwtechs/winstan';
 
 const Methods = ["GET", "PATCH", "PUT", "POST", "DELETE"];
 
+const { PWD_MIN_LENGTH_POLICY, PWD_MAX_LENGTH_POLICY, PWD_NUMBERS_POLICY, PWD_UPPERCASE_POLICY, PWD_LOWERCASE_POLICY, PWD_SYMBOLS_POLICY } = process.env;
+const PWD_MIN_LENGTH = PWD_MIN_LENGTH_POLICY ? +PWD_MIN_LENGTH_POLICY : 9;
+const PWD_MAX_LENGTH = PWD_MAX_LENGTH_POLICY ? +PWD_MAX_LENGTH_POLICY : 20;
+const PWD_NUMBERS = PWD_NUMBERS_POLICY ? true : false;
+const PWD_UPPERCASE = PWD_UPPERCASE_POLICY ? true : false;
+const PWD_LOWERCASE = PWD_LOWERCASE_POLICY ? true : false;
+const PWD_SYMBOLS = PWD_SYMBOLS_POLICY ? true : false;
 const Types = {
     boolean: {
         validate: (v, _min, _max, _typeCheck) => isBoolean(v)
@@ -66,6 +73,19 @@ const Types = {
     array: {
         validate: (v, min, max, _typeCheck) => isArrayOfLength(v, min || undefined, max || undefined)
     },
+    password: {
+        validate: (v, min, max, _typeCheck) => {
+            const o = {
+                minLength: min || PWD_MIN_LENGTH,
+                maxLength: max || PWD_MAX_LENGTH,
+                lowerCase: PWD_LOWERCASE,
+                upperCase: PWD_UPPERCASE,
+                number: PWD_NUMBERS,
+                specialCharacter: PWD_SYMBOLS,
+            };
+            return isValidPassword(v, o);
+        }
+    },
     email: {
         validate: (v, _min, _max, _typeCheck) => isEmail(v)
     },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dwtechs/antity",
-  "version": "0.9.1",
+  "version": "0.10.0",
   "description": "Open source library for easy entity management",
   "keywords": [
     "entities"
@@ -53,6 +53,6 @@
     "core-js": "3.33.0",
     "jest": "29.7.0",
     "rollup": "4.24.0",
-    "typescript": "5.6.3"
+    "typescript": "5.8.3"
   }
 }