@dwtechs/antity 0.15.0 → 0.17.0

package/README.md

@@ -51,9 +51,9 @@ const entity = new Entity("consumers", [
     type: "integer",
     min: 0,
     max: 120,
-    typeCheck: true,
-    need: ["PUT"],
-    safe: true,
+    isTypeChecked: true,
+    requiredFor: ["PUT"],
+    isPrivate: true,
     sanitizer: null,
     normalizer: null,
     validator: null,
@@ -63,9 +63,9 @@ const entity = new Entity("consumers", [
     type: "string",
     min: 0,
     max: 255,
-    typeCheck: true,
-    need: ["PUT"],
-    safe: true,
+    isTypeChecked: true,
+    requiredFor: ["PUT"],
+    isPrivate: true,
     sanitizer: null,
     normalizer: normalizeName,
     validator: null,
@@ -75,9 +75,9 @@ const entity = new Entity("consumers", [
     type: "string",
     min: 0,
     max: 255,
-    typeCheck: true,
-    need: ["PUT"],
-    safe: true,
+    isTypeChecked: true,
+    requiredFor: ["PUT"],
+    isPrivate: true,
     sanitizer: null,
     normalizer: normalizeName,
     validator: null,
@@ -87,9 +87,9 @@ const entity = new Entity("consumers", [
     type: "string",
     min: 0,
     max: 255,
-    typeCheck: true,
-    need: ["PUT"],
-    safe: true,
+    isTypeChecked: true,
+    requiredFor: ["PUT"],
+    isPrivate: true,
     sanitizer: null,
     normalizer: normalizeNickname,
     validator: null,
@@ -136,7 +136,10 @@ type Type =
   "htmlElement" |
   "htmlEventAttribute" |
   "node" |
-  "object";
+  "object" |
+  "ansiEscapeCode" |
+  "locale" |
+  "timeZone";
             
 type Method = "PATCH" | "PUT" | "POST";
 
@@ -145,9 +148,9 @@ class Property {
   type: Type;
   min: number | Date | null;
   max: number | Date | null;
-  need: Method[];
-  send: boolean;
-  typeCheck: boolean;
+  requiredFor: Method[];
+  isPrivate: boolean;
+  isTypeChecked: boolean;
   sanitizer: Function | null;
   normalizer: Function | null;
   validator: Function | null;
@@ -156,7 +159,7 @@ class Property {
 class Entity {
   constructor(name: string, properties: Property[]);
   get name(): string;
-  get unsafeProps(): string[];
+  get privateProps(): string[];
   get properties(): Property[];
   set name(name: string);
   
@@ -376,9 +379,9 @@ Any of these can be passed into the options object for each function.
 | type            | Type                     | Type of the property                             |
 | min             | number \| Date           | Minimum value if applicable                      | 0 \| 1900-01-01
 | max             | number \| Date           | Maximum value if applicable                      | 999999999 \| 2200-12-31
-| need            | Methods[]                | Property is required for the listed methods only | [ "POST", "PUT", "PATCH" ]
-| send            | boolean                  | Property is sent in the response                 | true
-| typeCheck       | boolean                  | Strict type check at validation                  | false
+| requiredFor     | Methods[]                | Property is required for the listed methods only | [ "POST", "PUT", "PATCH" ]
+| isPrivate       | boolean                  | Property should not be sent in the response      | false
+| isTypeChecked   | boolean                  | Strict type check at validation                  | false
 | sanitizer       | ((v:any) => any) \| null | Custom sanitizer function                        | null
 | normalizer      | ((v:any) => any) \| null | Custom Normalizer function                       | null
 | validator       | ((v:any, min:number, max:number, typeCheck:boolean) => any) \| null         | Custom validator | null

package/dist/antity.d.ts

@@ -55,15 +55,18 @@ type Type =
   "htmlElement" |
   "htmlEventAttribute" |
   "node" |
-  "object";
+  "object" |
+  "ansiEscapeCode" |
+  "locale" |
+  "timeZone";
 
 declare class Entity {
   private _name;
-  private _unsafeProps;
+  private _privateProps;
   private _properties;
   constructor(name: string, properties: Property[]);
   get name(): string;
-  get unsafeProps(): string[];
+  get privateProps(): string[];
   get properties(): Property[];
   set name(name: string);
   getProp(key: string): Property | undefined;
@@ -80,9 +83,9 @@ declare class Property {
   type: Type;
   min: number | Date | null;
   max: number | Date | null;
-  send: boolean;
-  need: Method[];
-  typeCheck: boolean;
+  isPrivate: boolean;
+  requiredFor: Method[];
+  isTypeChecked: boolean;
   sanitizer: ((v: any) => any) | null;
   normalizer: ((v: any) => any) | null;
   validator: ((v: any) => any) | null;
@@ -91,9 +94,9 @@ declare class Property {
     type: Type,
     min: number | Date | null,
     max: number | Date | null,
-    send: boolean,
-    need: Method[],
-    typeCheck: boolean,
+    isPrivate: boolean,
+    requiredFor: Method[],
+    isTypeChecked: boolean,
     sanitizer: ((v: any) => any) | null,
     normalizer: ((v: any) => any) | null,
     validator: ((v: any) => any) | null

package/dist/antity.js

@@ -24,7 +24,7 @@ SOFTWARE.
 https://github.com/DWTechs/Antity.js
 */
 
-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 { 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, isAnsiEscapeCode, isLocale, isTimeZone, isString, isProperty, isArray, isIn, isDate, isNumber, isInteger, isNil } from '@dwtechs/checkard';
 import { log } from '@dwtechs/winstan';
 
 const LOGS_PREFIX = "Antity: ";
@@ -48,7 +48,7 @@ const Types = {
         validate: (v, min, max, typeCheck) => isValidNumber(v, min || undefined, max || undefined, typeCheck || undefined, true)
     },
     integer: {
-        validate: (v, min, max, typeCheck) => isValidInteger(v, min !== null && min !== void 0 ? min : undefined, max !== null && max !== void 0 ? max : undefined, typeCheck || undefined, true)
+        validate: (v, min, max, typeCheck) => isValidInteger(v, min ?? undefined, max ?? undefined, typeCheck || undefined, true)
     },
     float: {
         validate: (v, min, max, typeCheck) => isValidFloat(v, min || undefined, max || undefined, typeCheck || undefined, true)
@@ -131,11 +131,30 @@ const Types = {
     },
     object: {
         validate: (v, _min, _max, _typeCheck) => isObject(v, true)
+    },
+    ansiEscapeCode: {
+        validate: (v, _min, _max, _typeCheck) => isAnsiEscapeCode(v, true)
+    },
+    locale: {
+        validate: (v, _min, _max, typeCheck) => isLocale(v, typeCheck || undefined, true)
+    },
+    timeZone: {
+        validate: (v, _min, _max, _typeCheck) => isTimeZone(v, true)
     }
 };
 
 class Property {
-    constructor(key, type, min, max, send, need, typeCheck, sanitizer, normalizer, validator) {
+    key;
+    type;
+    min;
+    max;
+    isPrivate;
+    requiredFor;
+    isTypeChecked;
+    sanitizer;
+    normalizer;
+    validator;
+    constructor(key, type, min, max, isPrivate, requiredFor, isTypeChecked, sanitizer, normalizer, validator) {
         try {
             isString(key, "!0", null, true);
         }
@@ -148,13 +167,13 @@ class Property {
         catch (err) {
             throw new Error(`${LOGS_PREFIX}Property "type" must be a valid type - caused by: ${err.message}`);
         }
-        if (isArray(need)) {
-            for (const m of need) {
+        if (isArray(requiredFor)) {
+            for (const m of requiredFor) {
                 try {
                     isIn(METHODS, m, 0, true);
                 }
                 catch (err) {
-                    throw new Error(`${LOGS_PREFIX}Property "need" must be an array of REST methods - caused by: ${err.message}`);
+                    throw new Error(`${LOGS_PREFIX}Property "requiredFor" must be an array of REST methods - caused by: ${err.message}`);
                 }
             }
         }
@@ -162,9 +181,9 @@ class Property {
         this.type = type;
         this.min = this.interval(min, type, 0, "1900-01-01T00:00:00Z");
         this.max = this.interval(max, type, 999999999, "2200-12-31T00:00:00Z");
-        this.need = isArray(need) ? need : [];
-        this.send = isBoolean(send) ? send : true;
-        this.typeCheck = isBoolean(typeCheck) ? typeCheck : false;
+        this.requiredFor = isArray(requiredFor) ? requiredFor : [];
+        this.isPrivate = isBoolean(isPrivate) ? isPrivate : false;
+        this.isTypeChecked = isBoolean(isTypeChecked) ? isTypeChecked : false;
         this.sanitizer = isFunction(sanitizer) ? sanitizer : null;
         this.normalizer = isFunction(normalizer) ? normalizer : null;
         this.validator = isFunction(validator) ? validator : null;
@@ -180,8 +199,8 @@ function sanitize(v, cb) {
     if (cb)
         return cb(v);
     if (isArray(v, null, null)) {
-        for (let d of v) {
-            d = trim(d);
+        for (let i = 0; i < v.length; i++) {
+            v[i] = trim(v[i]);
         }
         return v;
     }
@@ -191,11 +210,12 @@ function trim(v) {
     if (isString(v, "!0"))
         return v.trim();
     if (isObject(v, true)) {
-        for (const k in v) {
-            if (Object.prototype.hasOwnProperty.call(v, k)) {
-                let o = v[k];
+        const obj = v;
+        for (const k in obj) {
+            if (Object.prototype.hasOwnProperty.call(obj, k)) {
+                const o = obj[k];
                 if (isString(o, "!0", null))
-                    o = o.trim();
+                    obj[k] = o.trim();
             }
         }
     }
@@ -208,7 +228,7 @@ function normalize(record, properties) {
         if (v) {
             log.debug(`sanitize ${key}: ${type} = ${v}`);
             v = sanitize(v, sanitizer);
-            if (isFunction(normalizer)) {
+            if (normalizer) {
                 log.debug(`normalize ${key}: ${type} = ${v}`);
                 v = normalizer(v);
             }
@@ -245,15 +265,15 @@ function require(v, key, type) {
 }
 
 function validate(record, properties, method) {
-    for (const { key, type, min, max, need, typeCheck, validator } of properties) {
+    for (const { key, type, min, max, requiredFor, isTypeChecked, validator } of properties) {
         const v = record[key];
-        if (isIn(need, method)) {
+        if (requiredFor.includes(method)) {
             const rq = require(v, key, type);
             if (rq)
                 return rq;
         }
         if (v) {
-            const ct = control(v, key, type, min, max, typeCheck, validator);
+            const ct = control(v, key, type, min, max, isTypeChecked, validator);
             if (ct)
                 return ct;
         }
@@ -262,77 +282,26 @@ function validate(record, properties, method) {
 }
 
 class Entity {
+    _name;
+    _privateProps;
+    _properties;
     constructor(name, properties) {
-        this.normalizeArray = (req, _res, next) => {
-            var _a;
-            log.debug(`normalizeArray ${this.name}`);
-            const rows = (_a = req.body) === null || _a === void 0 ? void 0 : _a.rows;
-            if (!isArray(rows, ">", 0))
-                return next({ statusCode: 400, message: `${LOGS_PREFIX}Normalize: no rows found in request body` });
-            for (const r of rows) {
-                normalize(r, this._properties);
-            }
-            next();
-        };
-        this.normalizeOne = (req, _res, next) => {
-            log.debug(`normalizeOne ${this.name}`);
-            const r = req.body;
-            if (!isObject(r, true))
-                return next({ statusCode: 400, message: `${LOGS_PREFIX}Normalize: no data found in request body` });
-            normalize(r, this._properties);
-            next();
-        };
-        this.validateArray = (req, _res, next) => {
-            var _a;
-            log.debug(`validateArray ${this.name}`);
-            const rows = (_a = req.body) === null || _a === void 0 ? void 0 : _a.rows;
-            const method = req.method;
-            if (!isArray(rows, ">", 0))
-                return next({ statusCode: 400, message: `${LOGS_PREFIX}Validate: no rows found in request body` });
-            if (!isIn(METHODS, method))
-                return next({
-                    statusCode: 400,
-                    message: `${LOGS_PREFIX}Invalid REST method. Received: ${method}. Must be one of: ${METHODS.toString()}`
-                });
-            for (const r of rows) {
-                const error = validate(r, this._properties, method);
-                if (error)
-                    return next(error);
-            }
-            next();
-        };
-        this.validateOne = (req, _res, next) => {
-            log.debug(`validateOne ${this.name}`);
-            const record = req.body;
-            const method = req.method;
-            if (!isObject(record, true))
-                return next({ statusCode: 400, message: `${LOGS_PREFIX}Validate: no data found in request body` });
-            if (!isIn(METHODS, method))
-                return next({
-                    statusCode: 400,
-                    message: `${LOGS_PREFIX}Invalid REST method. Received: ${method}. Must be one of: ${METHODS.toString()}`
-                });
-            const error = validate(record, this._properties, method);
-            if (error)
-                return next(error);
-            next();
-        };
         this._name = name;
         this._properties = [];
-        this._unsafeProps = [];
+        this._privateProps = [];
         for (const p of properties) {
-            const prop = new Property(p.key, p.type, p.min, p.max, p.send, p.need, p.typeCheck, p.sanitizer, p.normalizer, p.validator);
+            const prop = new Property(p.key, p.type, p.min, p.max, p.isPrivate, p.requiredFor, p.isTypeChecked, p.sanitizer, p.normalizer, p.validator);
             Object.assign(prop, p);
             this._properties.push(prop);
-            if (!prop.safe)
-                this._unsafeProps.push(prop.key);
+            if (prop.isPrivate)
+                this._privateProps.push(prop.key);
         }
     }
     get name() {
         return this._name;
     }
-    get unsafeProps() {
-        return this._unsafeProps;
+    get privateProps() {
+        return this._privateProps;
     }
     get properties() {
         return this._properties;
@@ -348,11 +317,73 @@ class Entity {
     getPropsByMethod(method) {
         const props = [];
         for (const p of this.properties) {
-            if (isIn(p.need, method, 0))
+            if (p.requiredFor.includes(method))
                 props.push(p);
         }
         return props;
     }
+    normalizeArray = (req, _res, next) => {
+        log.debug(`normalizeArray ${this.name}`);
+        const rows = req.body?.rows;
+        if (!isArray(rows, ">", 0)) {
+            next({ statusCode: 400, message: `${LOGS_PREFIX}Normalize: no rows found in request body` });
+            return;
+        }
+        for (const r of rows) {
+            normalize(r, this._properties);
+        }
+        next();
+    };
+    normalizeOne = (req, _res, next) => {
+        log.debug(`normalizeOne ${this.name}`);
+        const r = req.body;
+        if (!isObject(r, true)) {
+            next({ statusCode: 400, message: `${LOGS_PREFIX}Normalize: no data found in request body` });
+            return;
+        }
+        normalize(r, this._properties);
+        next();
+    };
+    validateArray = (req, _res, next) => {
+        log.debug(`validateArray ${this.name}`);
+        const rows = req.body?.rows;
+        const method = req.method;
+        if (!isArray(rows, ">", 0)) {
+            next({ statusCode: 400, message: `${LOGS_PREFIX}Validate: no rows found in request body` });
+            return;
+        }
+        if (!METHODS.includes(method)) {
+            next({ statusCode: 400, message: `${LOGS_PREFIX}Invalid REST method. Received: ${method}. Must be one of: ${METHODS.toString()}` });
+            return;
+        }
+        for (const r of rows) {
+            const error = validate(r, this._properties, method);
+            if (error) {
+                next(error);
+                return;
+            }
+        }
+        next();
+    };
+    validateOne = (req, _res, next) => {
+        log.debug(`validateOne ${this.name}`);
+        const record = req.body;
+        const method = req.method;
+        if (!isObject(record, true)) {
+            next({ statusCode: 400, message: `${LOGS_PREFIX}Validate: no data found in request body` });
+            return;
+        }
+        if (!METHODS.includes(method)) {
+            next({ statusCode: 400, message: `${LOGS_PREFIX}Invalid REST method. Received: ${method}. Must be one of: ${METHODS.toString()}` });
+            return;
+        }
+        const error = validate(record, this._properties, method);
+        if (error) {
+            next(error);
+            return;
+        }
+        next();
+    };
 }
 
 export { Entity };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dwtechs/antity",
-  "version": "0.15.0",
+  "version": "0.17.0",
   "description": "Open source library for easy entity management",
   "keywords": [
     "entities"
@@ -13,8 +13,7 @@
     "url": "https://github.com/DWTechs/Antity.js"
   },
   "bugs": {
-    "url": "https://github.com/DWTechs/Antity.js/issues",
-    "email": ""
+    "url": "https://github.com/DWTechs/Antity.js/issues"
   },
   "license": "MIT",
   "author": {
@@ -22,36 +21,33 @@
     "email": "http://www.lcluber.com/contact",
     "url": "http://www.lcluber.com"
   },
-  "contributors": [],
   "scripts": {
-    "start": "",
     "prebuild": "npm install",
     "build": "node ./scripts/clear && tsc && npm run rollup && node ./scripts/copy && npm run test",
-    "rollup:mjs": "rollup --config rollup.config.mjs",
-    "rollup:cjs": "rollup --config rollup.config.cjs.mjs",
-    "rollup": "npm run rollup:mjs",
-    "test": "jest --coverage --config jest.config.js"
+    "rollup": "rollup --config rollup.config.mjs",
+    "test": "jest --coverage"
   },
   "files": [
     "dist/"
   ],
+    "engines": {
+    "node": ">= 22"
+  },
   "dependencies": {
-    "@dwtechs/checkard": "3.5.1",
-    "@dwtechs/winstan": "0.4.0",
-    "@dwtechs/sparray": "0.2.1"
+    "@dwtechs/checkard": "3.6.0",
+    "@dwtechs/sparray": "0.2.1",
+    "@dwtechs/winstan": "0.7.0"
   },
   "devDependencies": {
     "@babel/core": "7.26.0",
     "@babel/preset-env": "7.26.0",
-    "@rollup/plugin-commonjs": "28.0.1",
-    "@rollup/plugin-node-resolve": "15.3.0",
+    "@types/express": "5.0.6",
     "@types/jest": "29.5.14",
-    "@types/node": "22.10.1",
-    "@types/express": "5.0.0",
+    "@types/node": "25.6.0",
     "babel-jest": "29.7.0",
     "core-js": "3.33.0",
     "jest": "29.7.0",
     "rollup": "4.24.0",
-    "typescript": "5.8.3"
+    "typescript": "6.0.3"
   }
 }