@dwtechs/antity 0.12.0 → 0.13.0

package/README.md

@@ -2,7 +2,7 @@
 [![License: MIT](https://img.shields.io/npm/l/@dwtechs/antity.svg?color=brightgreen)](https://opensource.org/licenses/MIT)
 [![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)
+![Jest:coverage](https://img.shields.io/badge/Jest:coverage-72%25-brightgreen.svg)
 
 - [Synopsis](#synopsis)
 - [Support](#support)
@@ -364,15 +364,15 @@ Any of these can be passed into the options object for each function.
 | type            |  Type                     | Type of the property                              |
 | min             |  number \| Date           | Minimum value                                     | 0 \| 1900-01-01
 | max             |  number \| Date           | Maximum value                                     | 999999999 \| 2200-12-31
-| required        |  boolean                  | Is this property required on insert               | false
-| safe            |  boolean                  | Is this property safe to send to the client       | true
-| typeCheck       |  boolean                  | Type is checked if true                           | false
-| methods         |  Method[]                 | SQL DML operations concerned by the property      | [ "select", "insert", "update", "merge", "delete" ]
+| required        |  boolean                  | Property is required during validation            | false
+| safe            |  boolean                  | Property is sent in the response                  | true
+| typeCheck       |  boolean                  | Type is checked during validation                 | false
+| methods         |  Method[]                 | property is validated for the listed methods only | [ "GET", "POST", "PUT", "DELETE" ]
 | sanitize        |  boolean                  | Sanitize the property if true                     | true
 | normalize       |  boolean                  | Normalize the property if true                    | false
 | validate        |  boolean                  | validate the property if true                     | true
-| sanitizer       |  ((v:any) => any) \| null | Sanitizer function if sanitize is true            | null
-| normalizer      |  ((v:any) => any) \| null | Normalizer function if normalize is true          | null
+| sanitizer       |  ((v:any) => any) \| null | Custom sanitizer function if sanitize is true     | null
+| normalizer      |  ((v:any) => any) \| null | Custop Normalizer function if normalize is true   | null
 | validator       |  ((v:any, min:number, max:number, typeCheck:boolean) => any) \| null  | validator function if validate is true            | null
 
 * *Min and max parameters are not used for boolean type*

package/dist/antity.d.ts

@@ -74,6 +74,7 @@ declare class Entity {
 }
 
 declare class Property {
+  [key: string]: unknown;
   key: string;
   type: Type;
   min: number | Date | null;

package/dist/antity.js

@@ -348,6 +348,7 @@ class Entity {
         this._unsafeProps = [];
         for (const p of properties) {
             const prop = new Property(p.key, p.type, p.min, p.max, p.required, p.safe, p.typeCheck, p.methods, p.sanitize, p.normalize, p.validate, p.sanitizer, p.normalizer, p.validator);
+            Object.assign(prop, p);
             this._properties.push(prop);
             if (!prop.safe)
                 this._unsafeProps.push(prop.key);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dwtechs/antity",
-  "version": "0.12.0",
+  "version": "0.13.0",
   "description": "Open source library for easy entity management",
   "keywords": [
     "entities"