@dwtechs/antity 0.10.0 → 0.11.1

package/README.md

@@ -3,13 +3,11 @@
 [![npm version](https://badge.fury.io/js/%40dwtechs%2Fantity.svg)](https://www.npmjs.com/package/@dwtechs/antity)
 [![last version release date](https://img.shields.io/github/release-date/DWTechs/Antity.js)](https://www.npmjs.com/package/@dwtechs/antity)
 ![Jest:coverage](https://img.shields.io/badge/Jest:coverage-100%25-brightgreen.svg)
-[![minified size](https://img.shields.io/bundlephobia/min/@dwtechs/antity?color=brightgreen)](https://www.npmjs.com/package/@dwtechs/antity)
 
 - [Synopsis](#synopsis)
 - [Support](#support)
 - [Installation](#installation)
 - [Usage](#usage)
-  - [ES6](#es6)
 - [API Reference](#api-reference)
 - [Contributors](#contributors)
 - [Stack](#stack)
@@ -19,12 +17,10 @@
 
 **[Antity.js](https://github.com/DWTechs/Antity.js)** is an Open source library for easy entity management.
 
-- Only 1 small dependency to check inputs variables
-- Very lightweight
-- Thoroughly tested
-- Works in Javascript, Typescript
-- Can be used as EcmaScrypt module
-- Written in Typescript
+- 🪶 Very lightweight
+- 🧪 Thoroughly tested
+- 🚚 Shipped as EcmaScrypt module
+- 📝 Written in Typescript
 
 
 ## Support
@@ -44,8 +40,6 @@ $ npm i @dwtechs/antity
 ## Usage
 
 
-### ES6 / TypeScript
-
 ```javascript
 
 import { Entity } from "@dwtechs/antity";
@@ -120,6 +114,8 @@ const entity = new Entity("consumers", [
 
 // add a consumer. Used when loggin in from user service
 router.post("/", entity.normalize, entity.validate, ...);
+// or use check method to both normalize and validate at once
+router.put("/", entity.check, ...);
 
 ```
 
@@ -163,8 +159,8 @@ type Method = "GET" | "PATCH" | "PUT" | "POST" | "DELETE";
 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;
@@ -185,34 +181,143 @@ class Entity {
   set name(name: string);
   
   /**
-   * Retrieves a property from the `properties` array that matches the specified key.
+   * Returns a single property object matching the given key.
+   *
+   * - Searches the entity's properties for a property with the specified key
+   * - Useful for dynamic validation, normalization, or documentation
+   *
+   * @param {string} key - The property key to look up
+   * @returns {Property | undefined} The Property object if found, otherwise undefined
+   *
+   * **Input Properties Required:**
+   * - `key` (string) - Property key to look up
    *
-   * @param {string} key - The key of the property to retrieve.
-   * @returns {Property | undefined} - The property object if found, otherwise `undefined`.
+   * **Output Properties:**
+   * - Property object matching the key, or undefined if not found
+   *
+   * @example
+   * ```typescript
+   * const prop = entity.getProp('firstName');
+   * // prop contains the Property object for 'firstName' or undefined
+   * ```
    */
   getProp(key: string): Property | undefined;
 
   /**
-   * Retrieves a list of properties associated with a specific method.
+   * Returns all properties configured for a given REST method.
+   *
+   * - Filters the entity's properties by the specified method (e.g., 'POST', 'GET')
+   * - Useful for dynamic validation, normalization, or documentation
+   *
+   * @param {Method} method - The REST method to filter properties by (e.g., 'POST', 'GET')
+   * @returns {Property[]} Array of Property objects associated with the method
+   *
+   * **Input Properties Required:**
+   * - `method` (string) - REST method to filter by
    *
-   * @param {Method} method - The method to filter properties by.
-   * @returns {Property[]} An array of properties that are associated with the specified method.
+   * **Output Properties:**
+   * - Array of Property objects matching the method
+   *
+   * @example
+   * ```typescript
+   * const postProps = entity.getPropsByMethod('POST');
+   * // postProps contains all properties relevant for POST requests
+   * ```
    */
   getPropsByMethod(method: Method): Property[];
   
   /**
-   * Normalizes an array of records by applying sanitization and normalization
-   * rules defined in the `properties` of the class.
+   * Normalizes each row in req.body.rows according to property config and HTTP method.
+   *
+   * - Applies sanitization if `sanitize: true` and method matches
+   * - Applies normalization if `normalize: true` and method matches
+   * - Mutates req.body.rows with sanitized/normalized values
+   * - Calls next(error) on failure, next() on success
+   *
+   * @param {Request} req - Express request object containing rows
+   * @param {Response} _res - Express response object (not used)
+   * @param {NextFunction} next - Express next function
+   *
+   * @returns {void}
+   *
+   * **Input Properties Required:**
+   * - `req.body.rows` (array) - Array of objects to normalize
+   * - Each property config can specify sanitize, normalize, etc.
+   *
+   * **Output Properties:**
+   * - Mutates `req.body.rows` with sanitized/normalized values
+   * - Calls next(error) if any row fails normalization, next() if all pass
+   *
+   * @example
+   * ```typescript
+   * router.post('/entity', entity.normalize, (req, res) => {
+   *   // req.body.rows are now sanitized and normalized
+   *   res.json({ success: true });
+   * });
+   * ```
    */
   normalize: (req: Request, _res: Response, next: NextFunction) => void;
   
   /**
-   * Validates a set of rows against the defined properties and operation/method.
+   * Validates each row in req.body.rows according to property config and HTTP method.
    *
-   * 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.
+   * - Checks required properties and validates values
+   * - Calls next(error) on failure, next() on success
+   *
+   * @param {Request} req - Express request object containing rows
+   * @param {Response} _res - Express response object (not used)
+   * @param {NextFunction} next - Express next function
+   *
+   * @returns {void}
+   *
+   * **Input Properties Required:**
+   * - `req.body.rows` (array) - Array of objects to validate
+   * - Each property config can specify validate, required, etc.
+   *
+   * **Output Properties:**
+   * - Calls next(error) if any row fails validation, next() if all pass
+   *
+   * @example
+   * ```typescript
+   * router.post('/entity', entity.validate, (req, res) => {
+   *   // req.body.rows are now validated
+   *   res.json({ success: true });
+   * });
+   * ```
    */
   validate: (req: Request, _res: Response, next: NextFunction) => void;
+
+  /**
+   * Checks, sanitizes, normalizes, and validates each row in req.body.rows according to property config and HTTP method.
+   *
+   * - Applies sanitization if `sanitize: true` and method matches
+   * - Applies normalization if `normalize: true` and method matches
+   * - Checks required properties and validates values
+   * - Calls next(error) on failure, next() on success
+   *
+   * @param {Request} req - Express request object containing rows
+   * @param {Response} _res - Express response object (not used)
+   * @param {NextFunction} next - Express next function
+   *
+   * @returns {void}
+   *
+   * **Input Properties Required:**
+   * - `req.body.rows` (array) - Array of objects to check
+   * - Each property config can specify sanitize, normalize, validate, required, etc.
+   *
+   * **Output Properties:**
+   * - Mutates `req.body.rows` with sanitized/normalized values
+   * - Calls next(error) if any row fails checks, next() if all pass
+   *
+   * @example
+   * ```typescript
+   * router.post('/entity', entity.check, (req, res) => {
+   *   // req.body.rows are now sanitized, normalized, and validated
+   *   res.json({ success: true });
+   * });
+   * ```
+   */
+  check: (req: Request, _res: Response, next: NextFunction) => void;
 }
 
 ```

package/dist/antity.d.ts

@@ -70,6 +70,7 @@ declare class Entity {
   getPropsByMethod(method: Method): Property[];
   normalize: (req: Request, _res: Response, next: NextFunction) => void;
   validate: (req: Request, _res: Response, next: NextFunction) => void;
+  check: (req: Request, _res: Response, next: NextFunction) => void;
 }
 
 declare class Property {

package/dist/antity.js

@@ -205,12 +205,12 @@ function control(v, key, type, min, max, typeCheck, cb) {
         c += ` and >= ${min}`;
     if (!isNil(max))
         c += ` and <= ${max}`;
-    return val ? null : { status: 400, msg: `Invalid ${key}, must be of type ${type}${c}` };
+    return val ? null : { statusCode: 400, message: `Invalid ${key}, must be of type ${type}${c}` };
 }
 
 function require(v, key, type) {
     log.debug(`require ${key}: ${type} = ${v}`);
-    return isNil(v) ? { status: 400, msg: `Missing ${key} of type ${type}` } : null;
+    return isNil(v) ? { statusCode: 400, message: `Missing ${key} of type ${type}` } : null;
 }
 
 class Entity {
@@ -218,8 +218,9 @@ class Entity {
         this.normalize = (req, _res, next) => {
             var _a;
             const rows = (_a = req.body) === null || _a === void 0 ? void 0 : _a.rows;
+            log.debug(`normalize ${this.name}`);
             if (!isArray(rows, "!0"))
-                return next({ status: 400, msg: "Normalize: no rows found in request body" });
+                return next({ statusCode: 400, message: "Normalize: no rows found in request body" });
             for (const r of rows) {
                 for (const { key, type, sanitize: sanitize$1, normalize, sanitizer, normalizer, } of this._properties) {
                     let v = r[key];
@@ -242,12 +243,13 @@ class Entity {
             var _a;
             const rows = (_a = req.body) === null || _a === void 0 ? void 0 : _a.rows;
             const method = req.method;
+            log.debug(`validate ${this.name}`);
             if (!isArray(rows, "!0"))
-                return next({ status: 400, msg: "Sanitize: no rows found in request body" });
+                return next({ statusCode: 400, message: "Validate: no rows found in request body" });
             if (!isIn(Methods, method))
                 return next({
-                    status: 400,
-                    msg: `Invalid REST method. Received: ${method}. Must be one of: ${Methods.toString()}`
+                    statusCode: 400,
+                    message: `Invalid REST method. Received: ${method}. Must be one of: ${Methods.toString()}`
                 });
             for (const r of rows) {
                 for (const { key, type, min, max, required, typeCheck, methods, validate, validator } of this._properties) {
@@ -268,6 +270,48 @@ class Entity {
             }
             next();
         };
+        this.check = (req, _res, next) => {
+            var _a;
+            const rows = (_a = req.body) === null || _a === void 0 ? void 0 : _a.rows;
+            const method = req.method;
+            log.debug(`check ${this.name}`);
+            if (!isArray(rows, "!0"))
+                return next({ statusCode: 400, message: "Check: no rows found in request body" });
+            if (!isIn(Methods, method))
+                return next({
+                    statusCode: 400,
+                    message: `Invalid REST method. Received: ${method}. Must be one of: ${Methods.toString()}`
+                });
+            for (const r of rows) {
+                for (const { key, type, min, max, required, typeCheck, methods, validate, sanitize: sanitize$1, normalize, sanitizer, normalizer, validator } of this._properties) {
+                    let v = r[key];
+                    if (isIn(methods, method)) {
+                        if (v) {
+                            if (sanitize$1) {
+                                log.debug(`sanitize ${key}: ${type} = ${v}`);
+                                v = sanitize(v, sanitizer);
+                            }
+                            if (normalize && isFunction(normalizer)) {
+                                log.debug(`normalize ${key}: ${type} = ${v}`);
+                                v = normalizer(v);
+                            }
+                            r[key] = v;
+                            if (validate) {
+                                const ct = control(v, key, type, min, max, typeCheck, validator);
+                                if (ct)
+                                    return next(ct);
+                            }
+                        }
+                        if (required) {
+                            const rq = require(v, key, type);
+                            if (rq)
+                                return next(rq);
+                        }
+                    }
+                }
+            }
+            next();
+        };
         this._name = name;
         this._properties = [];
         this._unsafeProps = [];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dwtechs/antity",
-  "version": "0.10.0",
+  "version": "0.11.1",
   "description": "Open source library for easy entity management",
   "keywords": [
     "entities"
@@ -38,8 +38,7 @@
   "dependencies": {
     "@dwtechs/checkard": "3.2.3",
     "@dwtechs/winstan": "0.4.0",
-    "@dwtechs/sparray": "0.1.1",
-    "pg": "8.13.1"
+    "@dwtechs/sparray": "0.1.1"
   },
   "devDependencies": {
     "@babel/core": "7.26.0",