@dwtechs/antity 0.15.0 → 0.16.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,
@@ -145,9 +145,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 +156,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 +376,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

@@ -59,11 +59,11 @@ type Type =
 
 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 +80,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 +91,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

@@ -135,7 +135,7 @@ const Types = {
 };
 
 class Property {
-    constructor(key, type, min, max, send, need, typeCheck, sanitizer, normalizer, validator) {
+    constructor(key, type, min, max, isPrivate, requiredFor, isTypeChecked, sanitizer, normalizer, validator) {
         try {
             isString(key, "!0", null, true);
         }
@@ -148,13 +148,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 +162,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;
@@ -245,15 +245,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 (isIn(requiredFor, 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;
         }
@@ -319,20 +319,20 @@ class Entity {
         };
         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,7 +348,7 @@ class Entity {
     getPropsByMethod(method) {
         const props = [];
         for (const p of this.properties) {
-            if (isIn(p.need, method, 0))
+            if (isIn(p.requiredFor, method, 0))
                 props.push(p);
         }
         return props;

package/package.json

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