update to 1.1.5 👍

Author: olaferlandsen

README.md

@@ -9,23 +9,56 @@ This a simple package to mapping a json object.
 ```bash
 npm install --save typescript-json-object-mapper
 ```
+### Import
+```
+import { JsonProperty, JsonIgnore, JsonView, JsonObjectMapper } from 'typescript-json-object-mapper';
+```
+
 ### Create you own Views
-This an exaple with sub-views and recursive work.
+This example tries to show all possible cases in which you might need to use this utility.
 
 ```typescript
+import { JsonProperty, JsonIgnore, JsonView } from 'typescript-json-object-mapper';
+
+class DriverView extends JsonView {
+    @JsonProperty
+    public id: number;
+    @JsonProperty({
+        name: "fullname"
+    })
+    public name: number; // Rename property
+    @JsonProperty
+    public email: string;
+    @JsonIgnore
+    public password: string;
+}
 class WheelsView extends JsonView {
-    @JsonProperty({name: 'id',type: 'string'}) index: number;
-    @JsonProperty vendor: string;
-    @JsonProperty size: number;
-    @JsonProperty timestamp: Date;
+    @JsonProperty({
+        type: "string"
+    })
+    public index: number;// Convert int to string value
+    @JsonProperty
+    public vendor: string;
+    @JsonProperty
+    public size: number;
+    @JsonProperty
+    public timestamp: Date;
 }
 class CarView extends JsonView {
-    @JsonProperty name: string;
-    @JsonProperty vendor: string;
-    @JsonProperty model: string;
-    @JsonProperty engine: string;
-    @JsonProperty traction: string;
-    @JsonProperty({view: [WheelsView]}) wheels: WheelsView[];
+    @JsonProperty
+    public name: string;
+    @JsonProperty
+    public vendor: string;
+    @JsonProperty
+    public model: string;
+    @JsonIgnore
+    public engine: string; // Ignore property(don't show)
+    @JsonProperty
+    public traction: string;
+    @JsonProperty ([WheelsView])
+    public wheels: WheelsView[];// Sub-View Array
+    @JsonProperty (DriverView)
+    public driver: DriverView;// Sub-View Object
 }
 ```
 
@@ -62,7 +95,13 @@ const json: any = {
             size: 10,
             timestamp: "Tue, 28 Aug 2018 17:03:56 GMT"
         }
-    ]
+    ],
+    driver: {
+        id: 1,
+        name: "John Smith",
+        email: "john.smith@example.com",
+        password: "12345678"
+    }
 };
 ```
 ### Serilize
@@ -73,46 +112,109 @@ const serialized = JsonObjectMapper.serialize(json, CarView).toString();
 ### Result
 ```json
 {
-  "name": "cautito",
-  "vendor": "citroen",
-  "model": "lira",
-  "engine": "v8",
-  "traction": "4x4",
-  "wheels": [
-    {
-      "vendor": "pirelli",
-      "size": 26,
-      "timestamp": "2018-08-28T18:11:44.204Z",
-      "id": "0"
-    },
+    "name": "cautito",
+    "vendor": "citroen",
+    "model": "lira",
+    "engine": "v8",
+    "traction": "4x4",
+    "wheels": [
+        {
+            "vendor": "pirelli",
+            "size": 26,
+            "timestamp": "2018-08-28T18:11:44.204Z",
+            "index": "0"
+        },
+        {
+            "vendor": "firestone",
+            "size": 26,
+            "timestamp": "1970-01-18T18:31:05.061Z",
+            "index": "1"
+        },
+        {
+            "vendor": "pirelli",
+            "size": 26,
+            "timestamp": "2018-08-28T17:03:56.000Z",
+            "index": "2"
+        },
+        {
+            "vendor": "pirelli",
+            "size": 10,
+            "timestamp": "2018-08-28T17:03:56.000Z",
+            "index": "3"
+        }
+    ],
+    "driver": {
+        "id": "1",
+        "fullname": "John Smith",
+        "email": "john.smith@example.com"
+    }
+}
+```
+
+## Features
+* [x] No-Initiation(Using only reference to class)
+* [x] Renaming properties
+* [x] Convert data types
+    * [x] to Date
+        * [x] from String using `Date.parse`
+        * [x] from Integer using `Date`
+    * [x] to Integer
+        * [x] from String using `Number`
+    * [x] to Float
+        * [x] from String using `Number`
+    * [x] to Boolean
+* [x] Sub-Views(Recursivity)
+    * [x] Array sub-views
+    * [x] Single sub-view
+* [x] Date values
+* [x] Serialize from `Object Array`
+* [x] Serialize from `Object`
+
+## ToDo
+* [ ] Deserialize
+* [ ] Custom Regex validator
+* [ ] Custom format value
+* [ ] Default values
+* [ ] Enum values
+    * [ ] String
+    * [ ] Number
+    * [ ] Boolean
+
+
+## API:
+
+### JsonObjectMapper.serialize
+This function always return `Serialization` object.
+And can using it with data as `Array` or `Object`.
+
+##### Example
+```typescript
+// from Array
+JsonObjectMapper.serialize([
     {
-      "vendor": "firestone",
-      "size": 26,
-      "timestamp": "1970-01-18T18:31:05.061Z",
-      "id": "1"
+        email: "john.smith@example.com",
+        password: "123456"
     },
     {
-      "vendor": "pirelli",
-      "size": 26,
-      "timestamp": "2018-08-28T17:03:56.000Z",
-      "id": "2"
+        email: "john.smith@example.com",
+        password: "123456"
     },
     {
-      "vendor": "pirelli",
-      "size": 10,
-      "timestamp": "2018-08-28T17:03:56.000Z",
-      "id": "3"
+        email: "john.smith@example.com",
+        password: "123456"
     }
-  ]
-}
+], UserView);
+
+// from Object
+JsonObjectMapper.serialize({
+   email: "john.smith@example.com",
+   password: "123456"
+}, UserView);
 ```
 
-## To Do
-* [x] Recursive support
-* [x] No-Initiation support
-* [x] Renaming support
-* [x] Convert types support
-* [x] Annotation support
-* [ ] Format support
-* [ ] Enum support
-* [ ] Validator support
+### Serialization
+#### Serialization.toString(`spaces:number = 4`): `string`
+This method return a string representation of object.
+
+#### Serialization.toJson()
+This method return a json object representation.

package.json

@@ -1,6 +1,6 @@
 {
     "name": "typescript-json-object-mapper",
-    "version": "1.1.4",
+    "version": "1.1.5",
     "description": "Json Object mapper writing in TypeScript",
     "main": "dist/index.js",
     "typings": "dist/index.d.ts",

src/core/JsonObjectMapper.d.ts

@@ -1,17 +1,9 @@
 import { JsonView } from './JsonView';
-
-class Serialization {
-    public constructor (private serialized: any) {}
-    public toString (space = 4): string {
-        return JSON.stringify(this.serialized, null, space);
-    }
-    public toJson (): object {
-        return this.serialized;
-    }
-}
+import { Serialization } from './Serialization';
 
 export class JsonObjectMapper {
-    public static serialize(data: any, view: typeof JsonView): Serialization;
+    public static serialize (data: object[], view: typeof JsonView): Serialization;
+    public static serialize (data: object, view: typeof JsonView): Serialization;
     public static serialize (...args: any[]): Serialization {
         const filter: Function = (target: typeof JsonView, input: {[key: string]: any}): any => {
             const jsonProperties: { [key: string]: any} = Reflect.getMetadata("JSON:PROPERTY", target.prototype) || {};
@@ -20,7 +12,6 @@ export class JsonObjectMapper {
                     delete input[prop];
                     continue;
                 }
-                console.log("property", prop, jsonProperties[prop].type, input[prop]);
                 switch (jsonProperties[prop].type.toLowerCase()) {
                     case 'date':
                         if (typeof input[prop] === 'number') {
@@ -79,9 +70,11 @@ export class JsonObjectMapper {
             }
             return input;
         };
-        return new Serialization(filter(args[1], args[0]));
-    }
-    public static serializeArray(dataArray: any[], view: typeof JsonView): Serialization {
-        return new Serialization(dataArray.map(data => JsonObjectMapper.serialize(data, view).toJson()));
+        if (Array.isArray(args[0])) {
+            const elements: object[] = (args[0] as object[])
+                .map(data => JsonObjectMapper.serialize(data, args[1]).toJson());
+            return new Serialization(elements);
+        }
+        else return new Serialization(filter(args[1], args[0]));
     }
 }