feat(Object): make toJSON result contains included pointers (#453)

add AV.parseJSON
add Object#toFullJSON
add File#toFullJSON
extend prototypes (rather than replace them) to fix wrong instance constructors

Author: leeyeh

src/av.js

@@ -205,34 +205,28 @@ AV._getValue = function(object, prop) {
  * is set, then none of the AV Objects that are serialized can be dirty.
  * @private
  */
-AV._encode = function(value, seenObjects, disallowObjects) {
+AV._encode = function(value, seenObjects, disallowObjects, full) {
   if (value instanceof AV.Object) {
     if (disallowObjects) {
       throw new Error("AV.Objects not allowed here");
     }
     if (!seenObjects || _.include(seenObjects, value) || !value._hasData) {
       return value._toPointer();
     }
-    if (!value.dirty()) {
-      seenObjects = seenObjects.concat(value);
-      return AV._encode(value._toFullJSON(seenObjects),
-                           seenObjects,
-                           disallowObjects);
-    }
-    throw new Error("Tried to save an object with a pointer to a new, unsaved object.");
+    return value._toFullJSON(seenObjects.concat(value), full);
   }
   if (value instanceof AV.ACL) {
     return value.toJSON();
   }
   if (_.isDate(value)) {
-    return { "__type": "Date", "iso": value.toJSON() };
+    return full ? { "__type": "Date", "iso": value.toJSON() } : value.toJSON();
   }
   if (value instanceof AV.GeoPoint) {
     return value.toJSON();
   }
   if (_.isArray(value)) {
     return _.map(value, function(x) {
-      return AV._encode(x, seenObjects, disallowObjects);
+      return AV._encode(x, seenObjects, disallowObjects, full);
     });
   }
   if (_.isRegExp(value)) {
@@ -248,10 +242,10 @@ AV._encode = function(value, seenObjects, disallowObjects) {
     if (!value.url() && !value.id) {
       throw new Error("Tried to save an object containing an unsaved file.");
     }
-    return value._toFullJSON();
+    return value._toFullJSON(seenObjects, full);
   }
   if (_.isObject(value)) {
-    return _.mapObject(value, (v, k) => AV._encode(v, seenObjects, disallowObjects));
+    return _.mapObject(value, (v, k) => AV._encode(v, seenObjects, disallowObjects, full));
   }
   return value;
 };
@@ -337,6 +331,14 @@ AV._decode = function(value, key) {
   return _.mapObject(value, AV._decode);
 };
 
+/**
+ * The inverse function of {@link AV.Object#toFullJSON}.
+ * @since 2.0.0
+ * @param {Object}
+ * return {AV.Object|AV.File|any}
+ */
+AV.parseJSON = AV._decode;
+
 AV._encodeObjectOrArray = function(value) {
   var encodeAVObject = function(object) {
     if (object && object._toFullJSON){

src/file.js

@@ -198,13 +198,13 @@ module.exports = function(AV) {
     return file;
   };
 
-  AV.File.prototype = {
+  _.extend(AV.File.prototype, /** @lends AV.File.prototype */ {
     className: '_File',
 
-    _toFullJSON(seenObjects) {
+    _toFullJSON(seenObjects, full = true) {
       var json = _.clone(this.attributes);
       AV._objectEach(json, function(val, key) {
-        json[key] = AV._encode(val, seenObjects);
+        json[key] = AV._encode(val, seenObjects, undefined, full);
       });
       AV._objectEach(this._operations, function(val, key) {
         json[key] = val;
@@ -219,17 +219,28 @@ module.exports = function(AV) {
           json[key] = _.isDate(val) ? val.toJSON() : val;
         }
       });
-      json.__type = "File";
+      if (full) {
+        json.__type = "File";
+      }
       return json;
     },
 
-    toJSON() {
-      const json = this._toFullJSON();
-      // add id and keep __type for backward compatible
-      if (_.has(this, 'id')) {
-        json.id = this.id;
-      }
-      return json;
+    /**
+     * Returns a JSON version of the file with meta data.
+     * Inverse to {@link AV.parseJSON}
+     * @since 2.0.0
+     * @return {Object}
+     */
+    toFullJSON(seenObjects = []) {
+      return this._toFullJSON(seenObjects);
+    },
+
+    /**
+     * Returns a JSON version of the object.
+     * @return {Object}
+     */
+    toJSON: function(key, holder, seenObjects = [this]) {
+      return this._toFullJSON(seenObjects, false);
     },
 
     /**
@@ -545,5 +556,5 @@ module.exports = function(AV) {
       _.extend(this, value);
       return this;
     }
-  };
+  });
 };

src/geopoint.js

@@ -107,7 +107,7 @@ module.exports = function(AV) {
     }, reject);
   });
 
-  AV.GeoPoint.prototype = {
+  _.extend(AV.GeoPoint.prototype, /** @lends AV.GeoPoint.prototype */ {
     /**
      * Returns a JSON representation of the GeoPoint, suitable for AV.
      * @return {Object}
@@ -161,5 +161,5 @@ module.exports = function(AV) {
     milesTo: function(point) {
       return this.radiansTo(point) * 3958.8;
     }
-  };
+  });
 };

src/insight.js

@@ -77,7 +77,7 @@ module.exports = function(AV) {
     this._limit = 100;
   };
 
-  AV.Insight.JobQuery.prototype = {
+  _.extend(AV.Insight.JobQuery.prototype, /** @lends AV.Insight.JobQuery.prototype */ {
 
     /**
      * Sets the number of results to skip before returning any results.
@@ -129,6 +129,6 @@ module.exports = function(AV) {
       });
     }
 
-  };
+  });
 
 };

src/object.js

@@ -189,20 +189,30 @@ module.exports = function(AV) {
     },
 
     /**
-     * Returns a JSON version of the object suitable for saving to AV.
+     * Returns a JSON version of the object.
      * @return {Object}
      */
-    toJSON: function() {
-      var json = this._toFullJSON();
-      AV._arrayEach(["__type", "className"],
-                       function(key) { delete json[key]; });
-      return json;
+    toJSON: function(key, holder, seenObjects = []) {
+      return this._toFullJSON(seenObjects, false);
+    },
+
+    /**
+     * Returns a JSON version of the object with meta data.
+     * Inverse to {@link AV.parseJSON}
+     * @since 2.0.0
+     * @return {Object}
+     */
+    toFullJSON(seenObjects = []) {
+      return this._toFullJSON(seenObjects);
     },
 
-    _toFullJSON: function(seenObjects) {
+    _toFullJSON: function(seenObjects, full = true) {
       var json = _.clone(this.attributes);
+      if (_.isArray(seenObjects)) {
+        var newSeenObjects = seenObjects.concat(this);
+      }
       AV._objectEach(json, function(val, key) {
-        json[key] = AV._encode(val, seenObjects);
+        json[key] = AV._encode(val, newSeenObjects, undefined, full);
       });
       AV._objectEach(this._operations, function(val, key) {
         json[key] = val;
@@ -217,8 +227,11 @@ module.exports = function(AV) {
           json[key] = _.isDate(val) ? val.toJSON() : val;
         }
       });
-      json.__type = "Object";
-      json.className = this.className;
+      if (full) {
+        json.__type = "Object";
+        if (_.isArray(seenObjects) && seenObjects.length) json.__type = "Pointer";
+        json.className = this.className;
+      }
       return json;
     },
 

src/op.js

@@ -19,9 +19,9 @@ module.exports = function(AV) {
     this._initialize.apply(this, arguments);
   };
 
-  AV.Op.prototype = {
+  _.extend(AV.Op.prototype, /** @lends AV.Op.prototype */ {
     _initialize: function() {}
-  };
+  });
 
   _.extend(AV.Op, {
     /**

src/query.js

@@ -166,7 +166,7 @@ module.exports = function(AV) {
 
   AV.Query._extend = AV._extend;
 
-  AV.Query.prototype = {
+  _.extend(AV.Query.prototype, /** @lends AV.Query.prototype */ {
      //hook to iterate result. Added by dennis<[email protected]>.
      _processResult: function(obj){
         return obj;
@@ -791,21 +791,21 @@ module.exports = function(AV) {
       return this;
     },
 
-  /**
-   * Also sorts the results in ascending order by the given key. The previous sort keys have
-   * precedence over this key.
-   *
-   * @param {String} key The key to order by
-   * @return {AV.Query} Returns the query so you can chain this call.
-   */
-   addAscending: function(key){
-     requires(key, 'undefined is not a valid key');
-     if(this._order)
-       this._order +=  ','  + key;
-    else
-       this._order = key;
-    return this;
-   },
+    /**
+     * Also sorts the results in ascending order by the given key. The previous sort keys have
+     * precedence over this key.
+     *
+     * @param {String} key The key to order by
+     * @return {AV.Query} Returns the query so you can chain this call.
+     */
+    addAscending: function(key){
+      requires(key, 'undefined is not a valid key');
+      if(this._order)
+        this._order +=  ','  + key;
+      else
+        this._order = key;
+      return this;
+    },
 
     /**
      * Sorts the results in descending order by the given key.
@@ -819,21 +819,21 @@ module.exports = function(AV) {
       return this;
     },
 
-     /**
-   * Also sorts the results in descending order by the given key. The previous sort keys have
-   * precedence over this key.
-   *
-   * @param {String} key The key to order by
-   * @return {AV.Query} Returns the query so you can chain this call.
-   */
-   addDescending: function(key){
-     requires(key, 'undefined is not a valid key');
-     if(this._order)
-       this._order += ',-' + key;
-     else
-       this._order = '-' + key;
-     return this;
-   },
+    /**
+     * Also sorts the results in descending order by the given key. The previous sort keys have
+     * precedence over this key.
+     *
+     * @param {String} key The key to order by
+     * @return {AV.Query} Returns the query so you can chain this call.
+     */
+    addDescending: function(key){
+      requires(key, 'undefined is not a valid key');
+      if(this._order)
+        this._order += ',-' + key;
+      else
+        this._order = '-' + key;
+      return this;
+    },
 
     /**
      * Add a proximity based constraint for finding objects with key point
@@ -996,7 +996,7 @@ module.exports = function(AV) {
         });
       });
     }
-  };
+  });
 
    AV.FriendShipQuery = AV.Query._extend({
      _objectClass: AV.User,

src/relation.js

@@ -38,7 +38,7 @@ module.exports = function(AV) {
     return query;
   };
 
-  AV.Relation.prototype = {
+  _.extend(AV.Relation.prototype, /** @lends AV.Relation.prototype */ {
     /**
      * Makes sure that this relation has the right parent and key.
      * @private
@@ -111,5 +111,5 @@ module.exports = function(AV) {
 
       return query;
     }
-  };
+  });
 };

src/search.js

@@ -17,7 +17,7 @@ module.exports = function(AV) {
     this._sortFields = [];
   };
 
-  AV.SearchSortBuilder.prototype = {
+  _.extend(AV.SearchSortBuilder.prototype, /** @lends AV.SearchSortBuilder.prototype */ {
     _addField: function(key, order, mode, missing) {
       var field = {};
       field[key] = {
@@ -92,7 +92,7 @@ module.exports = function(AV) {
     build: function() {
       return JSON.stringify(AV._encode(this._sortFields));
     }
-  };
+  });
 
   /**
    * App searching query.Use just like AV.Query:

src/status.js

@@ -29,7 +29,7 @@ module.exports = function(AV) {
     return this;
   };
 
-  AV.Status.prototype = {
+  _.extend(AV.Status.prototype, /** @lends AV.Status.prototype */ {
     /**
      * Gets the value of an attribute in status data.
      * @param {String} attr The string name of an attribute.
@@ -127,7 +127,7 @@ module.exports = function(AV) {
         delete serverData.updatedAt;
         this.data = AV._decode(serverData);
     }
-  };
+  });
 
   /**
    * Send a status to current signined user's followers.