mapper-factory 3.0.0 → 3.0.1

package/README.md

@@ -213,179 +213,3 @@ let emp2: User = new User().from({ firstName: "Morty", lastName: "Smith" });
 
 let u = new User().from({ firstName: "Rick", lastName: "Sanchez", employees: [emp1.toMap(), emp2.toMap()], rolesToMap: ["CEO", "EMPLOYEE"] });
 ```
-
-## Usage V1
-
-### Mapping simple objects
-
-Your class must extends _MapperFactory_
-
-```
-class User extends MapperFactory {
-    ...
-}
-```
-
-After that, you can use _@MapField_ decorator over single property to specify the mapping:
-
-```
-class User extends MapperFactory {
-
-    @MapField({
-        src: 'firstName'
-    })
-    name: string;
-
-    @MapField({
-        src: 'obj.obj[0][1]',
-        transformer: (arr) => arr.map(role => role + " TEST TRASFORMER"),
-        reverser: (arr) => arr.map(role => role.replace(" TEST TRASFORMER", "")),
-    })
-    roles?: string[];
-
-    @MapField({
-        transformer: (user) => new User(user)
-    })
-    boss: User;
-}
-```
-
-Inside _@MapField_ you can use:
-
-- **_src_**: define a string of original field name (also using a path like _"obj.obj[0][1]"_)
-- **_transform_**: function to transform data input in _constructor_ of the class
-- **_reverse_**: function to transform data input in _toMap_ method of the class
-
-In this example:
-
-```
-class User extends MapperFactory {
-
-    id: string;
-    username: string;
-
-    @MapField({
-        src: 'firstName'
-    })
-    name: string;
-
-    @MapField({
-        src: 'lastName'
-    })
-    surname: string;
-
-    @MapField({
-        src: 'rolesToMap',
-        transformer: (arr) => arr.map(role => role + " TEST TRASFORMER"),
-        reverser: (arr) => arr.map(role => role.replace(" TEST TRASFORMER", "")),
-    })
-    roles?: string[];
-
-    @MapField({
-        transformer: (arr) => arr.map(user => new User(user))
-    })
-    employees?: User[];
-
-    @MapField({
-        transformer: (user) => new User(user)
-    })
-    boss: User;
-}
-```
-
-You can define a new User **_u_**:
-
-```
-let emp1: User = new User({ firstName: "Summer", lastName: "Smith" });
-let emp2: User = new User({ firstName: "Morty", lastName: "Smith" });
-
-let u = new User({ firstName: "Rick", lastName: "Sanchez", employees: [emp1, emp2], rolesToMap: ["CEO", "EMPLOYEE"] });
-```
-
-In that way you can create a new JS Object User passing a JSON object. Automatically constructor use _src_ and _transformer_ to obtain the correct object you want.
-
-In the specific case considered we have trasformed a JSON object:
-
-```
-{
-  firstName: 'Rick',
-  lastName: 'Sanchez',
-  employees: [
-    { firstName: 'Summer', lastName: 'Smith' },
-    { firstName: 'Morty', lastName: 'Smith' }
-  ],
-  rolesToMap: [ 'CEO', 'EMPLOYEE' ],
-  boss: { firstName: 'Jesus', lastName: 'Christ' }
-}
-```
-
-In this JS Object:
-
-```
-User {
-  name: 'Rick',
-  surname: 'Sanchez',
-  employees: [
-    User { name: 'Summer', surname: 'Smith' },
-    User { name: 'Morty', surname: 'Smith' }
-  ],
-  roles: [ 'CEO TEST TRASFORMER', 'EMPLOYEE TEST TRASFORMER' ],
-  boss: User { name: 'Jesus', surname: 'Christ' }
-}
-```
-
-Just using the constructor of _User_ class.
-
-If you want to return to the original JSON Object you can just call **_toMap()_** method, in that way:
-
-```
-u.toMap()
-```
-
-Obtaining the original JSON Object.
-
-You can also fill properties of an object from another (typically with same class) by using **_objToModel()_** method, in that way:
-
-```
-let uCopy = new User();
-uCopy.objToModel(u);
-```
-
-This method is meant to be used also when you have a JSON object but in the correct format, for example:
-
-```
-let uCopy = new User();
-uCopy.objToModel({ name: "Rick", surname: "Sanchez", employees: [emp1, emp2], roles: ["CEO", "EMPLOYEE"] })
-```
-
-Another utility method is **_empty()_** method, you can check if your object is empty or not in that way:
-
-```
-let user = new User();
-user.empty(); //TRUE
-
-user.name = "Rick";
-user.empty(); //FALSE
-```
-
-It is implemented also a GET/SET method whitch use the path. Using **_get(path: string)_** and **_set(path: string, value: any)_** you can access to the property you want and then GET or SET the value:
-
-```
-u.set("name", "Rick TEST-SET");
-console.log(u.get("name"));
-```
-
-With this mapper you can easily obtain a performant **_deep copy_** of your object doing:
-
-```
-let userDeepCopy = new User(u.toMap());
-```
-
-### Functions
-
-You can also use the following functions:
-
-- **_toMap(model: MapperFactory): Object_**: function to transform data input in _toMap_ method of the class
-- **_toModel\<T extends MapperFactory>(obj: Object)_**: T: function to transform data input (JSON) in the specified model _T_
-- **_objToModel\<T extends MapperFactory>(model: MapperFactory, obj: Object): T_**: T: function to get an instance of the object from a JSON representation without mapping it
-- **_copy\<T extends MapperFactory>(model: MapperFactory): T_**: T: function to get an instance of the object from a JSON representation without mapping it

package/dist/functions.js

@@ -161,7 +161,7 @@ function from(object) {
         return objCopy;
     };
     const setProperty = (metaKey, value, object) => {
-        const metaProp = metadataList[metaKey];
+        const metaProp = metadataList?.[metaKey];
         if (metaProp?.transformer) {
             this[metaKey] = metaProp.transformer(value, object);
         }
@@ -173,7 +173,7 @@ function from(object) {
         let metaKeys = metadataList && Object.keys(metadataList).filter(metadata => metadataList[metadata]?.src?.split('.')?.includes(propertyName));
         if (metaKeys?.length) {
             metaKeys.forEach(metaKey => {
-                const metaProp = metadataList[metaKey];
+                const metaProp = metadataList?.[metaKey];
                 if (metaProp) {
                     const props = metaProp.src.split('.');
                     const propsStereoid = props.map(prop => ({
@@ -189,7 +189,7 @@ function from(object) {
         else {
             let metaKey = metadataList && Object.keys(metadataList).find(metadata => metadataList[metadata]?.src == propertyName);
             if (metaKey) {
-                const src = metadataList[metaKey].src || propertyName;
+                const src = metadataList?.[metaKey].src || propertyName;
                 setProperty(metaKey, object[src], object);
             }
             else {

package/dist/index.d.ts

@@ -1,11 +1,10 @@
 import { MapClass, MapInterface } from "./class.decorator";
 import { MapField } from "./field.decorator";
-import { objToModel, toMap, toModel } from "./mapper-functions";
 import { ClassType } from "./types";
-export { ClassType, MapClass, MapField, MapInterface, objToModel, toMap, toModel };
+export { ClassType, MapClass, MapField, MapInterface };
 /**
  * npx tsc
  * npx ts-node src/example.ts
- * npm version patch
+ * npm version ( patch | minor | major )
  * npm publish
  */ 

package/dist/index.js

@@ -1,17 +1,13 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.toModel = exports.toMap = exports.objToModel = exports.MapField = exports.MapClass = void 0;
+exports.MapField = exports.MapClass = void 0;
 const class_decorator_1 = require("./class.decorator");
 Object.defineProperty(exports, "MapClass", { enumerable: true, get: function () { return class_decorator_1.MapClass; } });
 const field_decorator_1 = require("./field.decorator");
 Object.defineProperty(exports, "MapField", { enumerable: true, get: function () { return field_decorator_1.MapField; } });
-const mapper_functions_1 = require("./mapper-functions");
-Object.defineProperty(exports, "objToModel", { enumerable: true, get: function () { return mapper_functions_1.objToModel; } });
-Object.defineProperty(exports, "toMap", { enumerable: true, get: function () { return mapper_functions_1.toMap; } });
-Object.defineProperty(exports, "toModel", { enumerable: true, get: function () { return mapper_functions_1.toModel; } });
 /**
  * npx tsc
  * npx ts-node src/example.ts
- * npm version patch
+ * npm version ( patch | minor | major )
  * npm publish
  */ 

package/dist/test.js

@@ -108,10 +108,16 @@ User = User_1 = __decorate([
 ], User);
 const emp1 = new User().from({ firstName: "Summer", lastName: "Smith" });
 const emp2 = new User().from({ firstName: "Morty", lastName: "Smith" });
-const JSONObject = { firstName: "Rick", lastName: "Sanchez", employees: [emp1.toMap(), emp2.toMap()], rolesToMap: ["CEO", "EMPLOYEE"], boss: { firstName: "Nello", lastName: "Stanco" } };
+const JSONObject = { username: 'god', firstName: "Rick", lastName: "Sanchez", employees: [emp1.toMap(), emp2.toMap()], rolesToMap: ["CEO", "EMPLOYEE"], boss: { firstName: "Nello", lastName: "Stanco" } };
 //TEST constructor
 const u = new User().from(JSONObject);
-const constructorTest = u.name == JSONObject.firstName && u.surname == JSONObject.lastName && u.employees?.map(emp => emp.name == emp1.name) && u.roles?.map(role => role == "CEO") && u.boss.name == "Nello" && u.boss.surname == "Stanco";
+const constructorTest = u.username == JSONObject.username &&
+    u.name == JSONObject.firstName &&
+    u.surname == JSONObject.lastName &&
+    u.employees?.map(emp => emp.name == emp1.name) &&
+    u.roles?.map(role => role == "CEO") &&
+    u.boss.name == "Nello" &&
+    u.boss.surname == "Stanco";
 console.log("TEST CONSTRUCTOR", constructorTest ? '✅' : '❌');
 //TEST toModel method with JS Object
 const u1 = new User().toModel(u);
@@ -197,4 +203,17 @@ console.log("TEST FLAG1", (testFlag1.flTest && testFlag1Map.flTest == '1') ? '
 const testFlag2 = new TestFlag().from({ flTest: '0' });
 const testFlag2Map = testFlag2.toMap();
 console.log("TEST FLAG2", (!testFlag2.flTest && testFlag2Map.flTest == '0') ? '✅' : '❌');
+let TestWithoutMapField = class TestWithoutMapField {
+    id;
+    name;
+};
+TestWithoutMapField = __decorate([
+    (0, class_decorator_1.MapClass)()
+], TestWithoutMapField);
+const JSONObject2 = {
+    id: '1',
+    name: 'Supplier 1',
+};
+const supplier = new TestWithoutMapField().from(JSONObject2);
+console.log("TEST WITHOUT MAP FIELD", (supplier) ? '✅' : '❌');
 console.log("\n");

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mapper-factory",
-  "version": "3.0.0",
+  "version": "3.0.1",
   "description": "mapper for typescript object",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",