Allow optional null in data

Author: andreas-aeschlimann

src/json2typescript/json-convert.ts

@@ -575,7 +575,7 @@ export class JsonConvert {
         let classInstancePropertyValue: any = instance[classPropertyName];
 
 
-        // Check if the json value exists
+        // Check if the class property value exists
         if (typeof (classInstancePropertyValue) === "undefined") {
 
             if (isOptional) return;
@@ -589,9 +589,13 @@ export class JsonConvert {
         }
 
 
+        // Check if the property is optional
+        // If the json value is null, we don't assign it in that case
+        if (isOptional && classInstancePropertyValue === null) return;
+
+
         // Map the property
         try {
-            // Each class property might have multiple decorators - only use the JSON property name as defined in the first one
             json[jsonPropertyName] = customConverter !== null ? customConverter.serialize(classInstancePropertyValue) : this.verifyProperty(expectedJsonType, classInstancePropertyValue, true);
         } catch (e) {
             throw new Error(
@@ -649,6 +653,11 @@ export class JsonConvert {
         }
 
 
+        // Check if the property is optional
+        // If the json value is null, we don't assign it in that case
+        if (isOptional && jsonValue === null) return;
+
+
         // Map the property
         try {
             instance[classPropertyName] = customConverter !== null ? customConverter.deserialize(jsonValue) : this.verifyProperty(expectedJsonType, jsonValue);

test/json2typescript.integration.ts

@@ -31,18 +31,14 @@ describe('Integration tests', () => {
         let dog1JsonObject: IDog = {
             name: "Barky",
             barking: true,
-            owner: null,
             birthdate: "2016-01-02",
             friends: [],
             other: 0
         };
         let cat2JsonObject: ICat = {
             catName: "Links",
             district: 50,
-            owner: human1JsonObject,
             birthdate: "2016-01-02",
-            //friends: [cat1JsonObject, dog1JsonObject],
-            friends: null,
             talky: true,
             other: ""
         };
@@ -64,16 +60,13 @@ describe('Integration tests', () => {
         let dog1 = new Dog();
         dog1.name = "Barky";
         dog1.isBarking = true;
-        dog1.owner = null;
         dog1.birthdate = new Date("2016-01-02");
         dog1.friends = [];
 
         let cat2 = new Cat();
         cat2.name = "Links";
         cat2.district = 50;
-        cat2.owner = human1;
         cat2.birthdate = new Date("2016-01-02");
-        //cat2.friends = [cat1, dog1];
         cat2.talky = true;
 
         let animals = [cat1, dog1];
@@ -83,7 +76,7 @@ describe('Integration tests', () => {
         // SERIALIZE INTEGRATION
         describe('serialize', () => {
 
-            jsonConvert.valueCheckingMode = ValueCheckingMode.ALLOW_NULL;
+            jsonConvert.valueCheckingMode = ValueCheckingMode.DISALLOW_NULL;
 
             it('should serialize a TypeScript object to a JSON object', () => {
                 expect(jsonConvert.serialize<Cat>(cat1)).toEqual(cat1JsonObject);
@@ -110,7 +103,7 @@ describe('Integration tests', () => {
         // DESERIALIZE INTEGRATION
         describe('deserialize', () => {
 
-            jsonConvert.valueCheckingMode = ValueCheckingMode.ALLOW_NULL;
+            jsonConvert.valueCheckingMode = ValueCheckingMode.DISALLOW_NULL;
 
             it('should deserialize a JSON object to a TypeScript object', () => {
                 expect(jsonConvert.deserialize<Cat>(cat1JsonObject, Cat)).toEqual(cat1);

test/json2typescript.unit.ts

@@ -30,13 +30,11 @@ describe('Unit tests', () => {
             owner: human1JsonObject,
             talky: true,
             other: "cute",
-            birthdate: null,
             friends: []
         };
         let cat2JsonObject: ICat = {
             catName: "Links",
             district: 50,
-            owner: human2JsonObject,
             talky: true,
             other: "sweet",
             birthdate: "2014-09-01",
@@ -45,7 +43,6 @@ describe('Unit tests', () => {
         let dog1JsonObject: IDog = {
             name: "Barky",
             barking: true,
-            owner: null,
             other: 1.1,
         };
 
@@ -69,7 +66,6 @@ describe('Unit tests', () => {
         let cat2 = new Cat();
         cat2.name = "Links";
         cat2.district = 50;
-        cat2.owner = human2;
         cat2.other = "sweet";
         cat2.birthdate = new Date("2014-09-01");
         cat2.friends = null;
@@ -179,11 +175,6 @@ describe('Unit tests', () => {
                 let t_cat = new Cat();
                 (<any>jsonConvert).deserializeObject_loopProperty(t_cat, "name", {"catName": "Meowy"});
                 expect(t_cat.name).toEqual("Meowy");
-
-                let t_dog = new Dog();
-                (<any>jsonConvert).deserializeObject_loopProperty(t_dog, "name", {"name": "Barky"});
-                expect(t_dog.name).toEqual("Barky");
-
                 (<any>jsonConvert).deserializeObject_loopProperty(t_cat, "district", {"district": 100});
                 expect(t_cat.district).toEqual(100);
                 (<any>jsonConvert).deserializeObject_loopProperty(t_cat, "owner", {
@@ -192,6 +183,11 @@ describe('Unit tests', () => {
                         lastName: "Muster"
                     }
                 });
+                expect(t_cat.owner!.lastname).toEqual("Muster");
+
+                let t_dog = new Dog();
+                (<any>jsonConvert).deserializeObject_loopProperty(t_dog, "name", {"name": "Barky"});
+                expect(t_dog.name).toEqual("Barky");
 
                 jsonConvert.propertyMatchingRule = PropertyMatchingRule.CASE_INSENSITIVE;
 
@@ -202,7 +198,23 @@ describe('Unit tests', () => {
                 expect(() => (<any>jsonConvert).deserializeObject_loopProperty(t_cat, "name", {"catNames": "Meowy"})).toThrow();
 
                 jsonConvert.propertyMatchingRule = PropertyMatchingRule.CASE_STRICT;
+
             });
+
+            jsonConvert.valueCheckingMode = ValueCheckingMode.DISALLOW_NULL;
+
+            it('serializeObject_loopProperty()', () => {
+                let t_cat = {};
+                (<any>jsonConvert).serializeObject_loopProperty(cat2, "owner", t_cat);
+                expect((<any>t_cat)["owner"]).toBe(undefined);
+            });
+            it('deserializeObject_loopProperty()', () => {
+                let t_cat = new Cat();
+                (<any>jsonConvert).deserializeObject_loopProperty(t_cat, "owner", { "owner": null });
+                expect(t_cat.owner).toBe(null);
+
+            });
+
         });
 
         // HELPER METHODS

test/model/json/i-cat.ts

@@ -1,6 +1,6 @@
 export interface ICat {
     catName: string;
-    owner?: object;
+    owner?: object | null;
     birthdate?: string | null;
     friends?: any[] | null;
     district: number;