Merge pull request #312 from ParsePlatform/flow_typing

Flow typing

Author: andrewimm

src/.flowconfig

@@ -1,7 +1,8 @@
 [ignore]
-.*\/node_modules\/
+.*/node_modules/.*
 
 [include]
+../package.json
 
 [libs]
 interfaces/

src/CoreManager.js

@@ -10,12 +10,14 @@
  */
 
 import type { AttributeMap, ObjectCache, OpsMap, State } from './ObjectStateMutations';
+import type ParseFile from './ParseFile';
 import type { FileSource } from './ParseFile';
 import type { Op } from './ParseOp';
 import type ParseObject from './ParseObject';
 import type ParsePromise from './ParsePromise';
 import type { QueryJSON } from './ParseQuery';
-import type { ParseUser, AuthData } from './ParseUser';
+import type ParseUser from './ParseUser';
+import type { AuthData } from './ParseUser';
 import type { PushData } from './Push';
 
 type RequestOptions = {
@@ -41,9 +43,9 @@ type InstallationController = {
   currentInstallationId: () => ParsePromise;
 };
 type ObjectController = {
-  fetch: (object: ParseObject, forceFetch: boolean, options: RequestOptions) => ParsePromise;
-  save: (object: ParseObject, options: RequestOptions) => ParsePromise;
-  destroy: (object: ParseObject, options: RequestOptions) => ParsePromise;
+  fetch: (object: ParseObject | Array<ParseObject>, forceFetch: boolean, options: RequestOptions) => ParsePromise;
+  save: (object: ParseObject | Array<ParseObject | ParseFile>, options: RequestOptions) => ParsePromise;
+  destroy: (object: ParseObject | Array<ParseObject>, options: RequestOptions) => ParsePromise;
 };
 type ObjectStateController = {
   getState: (obj: any) => ?State;
@@ -62,6 +64,7 @@ type ObjectStateController = {
   commitServerChanges: (obj: any, changes: AttributeMap) => void;
   enqueueTask: (obj: any, task: () => ParsePromise) => ParsePromise;
   clearAllState: () => void;
+  duplicateState: (source: any, dest: any) => void;
 };
 type PushController = {
   send: (data: PushData, options: RequestOptions) => ParsePromise;
@@ -107,21 +110,39 @@ type UserController = {
   updateUserOnDisk: (user: ParseUser) => ParsePromise;
   upgradeToRevocableSession: (user: ParseUser, options: RequestOptions) => ParsePromise;
   linkWith: (user: ParseUser, authData: AuthData) => ParsePromise;
+  removeUserFromDisk: () => ParsePromise;
 };
 type HooksController = {
   get: (type: string, functionName?: string, triggerName?: string) => ParsePromise;
   create: (hook: mixed) => ParsePromise;
   delete: (hook: mixed) => ParsePromise;
   update: (hook: mixed) => ParsePromise;
   send: (method: string, path: string, body?: mixed) => ParsePromise;
-}
+};
+
+type Config = {
+  AnalyticsController?: AnalyticsController,
+  CloudController?: CloudController,
+  ConfigController?: ConfigController,
+  FileController?: FileController,
+  InstallationController?: InstallationController,
+  ObjectController?: ObjectController,
+  ObjectStateController?: ObjectStateController,
+  PushController?: PushController,
+  QueryController?: QueryController,
+  RESTController?: RESTController,
+  SessionController?: SessionController,
+  StorageController?: StorageController,
+  UserController?: UserController,
+  HooksController?: HooksController,
+};
 
-var config: { [key: string]: mixed } = {
+var config: Config & { [key: string]: mixed } = {
   // Defaults
   IS_NODE: (typeof process !== 'undefined' &&
             !!process.versions &&
             !!process.versions.node &&
-            !process.version.electron),
+            !process.versions.electron),
   REQUEST_ATTEMPT_LIMIT: 5,
   SERVER_URL: 'https://api.parse.com/1',
   LIVEQUERY_SERVER_URL: null,

src/ObjectStateMutations.js

@@ -87,16 +87,18 @@ export function mergeFirstPendingState(pendingOps: Array<OpsMap>) {
   }
 }
 
-export function estimateAttribute(serverData: AttributeMap, pendingOps: Array<OpsMap>, className: string, id: string, attr: string): mixed {
+export function estimateAttribute(serverData: AttributeMap, pendingOps: Array<OpsMap>, className: string, id: ?string, attr: string): mixed {
   let value = serverData[attr];
   for (let i = 0; i < pendingOps.length; i++) {
     if (pendingOps[i][attr]) {
       if (pendingOps[i][attr] instanceof RelationOp) {
-        value = pendingOps[i][attr].applyTo(
-          value,
-          { className: className, id: id },
-          attr
-        );
+        if (id) {
+          value = pendingOps[i][attr].applyTo(
+            value,
+            { className: className, id: id },
+            attr
+          );
+        }
       } else {
         value = pendingOps[i][attr].applyTo(value);
       }
@@ -105,7 +107,7 @@ export function estimateAttribute(serverData: AttributeMap, pendingOps: Array<Op
   return value;
 }
 
-export function estimateAttributes(serverData: AttributeMap, pendingOps: Array<OpsMap>, className: string, id: string): AttributeMap {
+export function estimateAttributes(serverData: AttributeMap, pendingOps: Array<OpsMap>, className: string, id: ?string): AttributeMap {
   let data = {};
   let attr;
   for (attr in serverData) {
@@ -114,11 +116,13 @@ export function estimateAttributes(serverData: AttributeMap, pendingOps: Array<O
   for (let i = 0; i < pendingOps.length; i++) {
     for (attr in pendingOps[i]) {
       if (pendingOps[i][attr] instanceof RelationOp) {
-        data[attr] = pendingOps[i][attr].applyTo(
-          data[attr],
-          { className: className, id: id },
-          attr
-        );
+        if (id) {
+          data[attr] = pendingOps[i][attr].applyTo(
+            data[attr],
+            { className: className, id: id },
+            attr
+          );
+        }
       } else {
         data[attr] = pendingOps[i][attr].applyTo(data[attr]);
       }

src/ParseACL.js

@@ -12,6 +12,9 @@
 import ParseRole from './ParseRole';
 import ParseUser from './ParseUser';
 
+type PermissionsMap = { [permission: string]: boolean };
+type ByIdMap = { [userId: string]: PermissionsMap };
+
 var PUBLIC_KEY = '*';
 
 /**
@@ -29,9 +32,9 @@ var PUBLIC_KEY = '*';
  * of your application.</p>
  */
 export default class ParseACL {
-  permissionsById: { [userId: string]: { [permission: string]: boolean } };
+  permissionsById: ByIdMap;
 
-  constructor(arg1: mixed) {
+  constructor(arg1: ParseUser | ByIdMap) {
     this.permissionsById = {};
     if (arg1 && typeof arg1 === 'object') {
       if (arg1 instanceof ParseUser) {
@@ -74,7 +77,7 @@ export default class ParseACL {
    * @method toJSON
    * @return {Object}
    */
-  toJSON(): { [key: string]: any } {
+  toJSON(): ByIdMap {
     var permissions = {};
     for (var p in this.permissionsById) {
       permissions[p] = this.permissionsById[p];
@@ -88,7 +91,7 @@ export default class ParseACL {
    * @param other The other object to compare to
    * @return {Boolean}
    */
-  equals(other: mixed): boolean {
+  equals(other: ParseACL): boolean {
     if (!(other instanceof ParseACL)) {
       return false;
     }
@@ -150,6 +153,9 @@ export default class ParseACL {
   ): boolean {
     if (userId instanceof ParseUser) {
       userId = userId.id;
+      if (!userId) {
+        throw new Error('Cannot get access for a ParseUser without an ID');
+      }
     } else if (userId instanceof ParseRole) {
       userId = 'role:' + userId.getName();
     }

src/ParseFile.js

@@ -12,7 +12,8 @@
 import CoreManager from './CoreManager';
 import ParsePromise from './ParsePromise';
 
-type FileData = Array<number> | { base64: string } | File;
+type Base64 = { base64: string };
+type FileData = Array<number> | Base64 | File;
 export type FileSource = {
   format: 'file';
   file: File;
@@ -86,38 +87,41 @@ export default class ParseFile {
 
     this._name = name;
 
-    if (Array.isArray(data)) {
-      this._source = {
-        format: 'base64',
-        base64: ParseFile.encodeBase64(data),
-        type: specifiedType
-      };
-    } else if (typeof File !== 'undefined' && data instanceof File) {
-      this._source = {
-        format: 'file',
-        file: data,
-        type: specifiedType
-      };
-    } else if (data && data.hasOwnProperty('base64')) {
-      var commaIndex = data.base64.indexOf(',');
-  
-      if (commaIndex !== -1) {
-        var matches = dataUriRegexp.exec(data.base64.slice(0, commaIndex + 1));
-        // if data URI with type and charset, there will be 4 matches.
+    if (data !== undefined) {
+      if (Array.isArray(data)) {
         this._source = {
           format: 'base64',
-          base64: data.base64.slice(commaIndex + 1),
-          type: matches[1]
+          base64: ParseFile.encodeBase64(data),
+          type: specifiedType
         };
-      } else {
+      } else if (typeof File !== 'undefined' && data instanceof File) {
         this._source = {
-          format: 'base64',
-          base64: data.base64,
+          format: 'file',
+          file: data,
           type: specifiedType
         };
+      } else if (data && typeof data.base64 !== 'undefined') {
+        const base64 = data.base64;
+        var commaIndex = base64.indexOf(',');
+
+        if (commaIndex !== -1) {
+          var matches = dataUriRegexp.exec(base64.slice(0, commaIndex + 1));
+          // if data URI with type and charset, there will be 4 matches.
+          this._source = {
+            format: 'base64',
+            base64: base64.slice(commaIndex + 1),
+            type: matches[1]
+          };
+        } else {
+          this._source = {
+            format: 'base64',
+            base64: base64,
+            type: specifiedType
+          };
+        }
+      } else {
+        throw new TypeError('Cannot create a Parse.File with that data.');
       }
-    } else if (typeof data !== 'undefined') {
-      throw new TypeError('Cannot create a Parse.File with that data.');
     }
   }
 

src/ParseObject.js

@@ -188,7 +188,7 @@ export default class ParseObject {
   /**
    * Returns a unique identifier used to pull data from the State Controller.
    */
-  _getStateIdentifier(): mixed {
+  _getStateIdentifier(): ParseObject | {id: string, className: string} {
     if (singleInstance) {
       let id = this.id;
       if (!id) {
@@ -354,7 +354,7 @@ export default class ParseObject {
     }
   }
 
-  _handleSaveResponse(response, status: number) {
+  _handleSaveResponse(response: AttributeMap, status: number) {
     var changes = {};
     var attr;
     var stateController = CoreManager.getObjectStateController();
@@ -410,7 +410,7 @@ export default class ParseObject {
    * @method toJSON
    * @return {Object}
    */
-  toJSON(seen: Array<any>): AttributeMap {
+  toJSON(seen: Array<any> | void): AttributeMap {
     var seenEntry = this.id ? this.className + ':' + this.id : this;
     var seen = seen || [seenEntry];
     var json = {};
@@ -646,7 +646,9 @@ export default class ParseObject {
       ) {
         newOps[k] = opFromJSON(changes[k]);
       } else if (k === 'objectId' || k === 'id') {
-        this.id = changes[k];
+        if (typeof changes[k] === 'string') {
+          this.id = changes[k];
+        }
       } else if (
         k === 'ACL' &&
         typeof changes[k] === 'object' &&
@@ -823,7 +825,9 @@ export default class ParseObject {
     }
 
     let stateController = CoreManager.getObjectStateController();
-    stateController.duplicateState(this._getStateIdentifier(), clone._getStateIdentifier());
+    if (stateController) {
+      stateController.duplicateState(this._getStateIdentifier(), clone._getStateIdentifier());
+    }
     return clone;
   }
 
@@ -1066,9 +1070,9 @@ export default class ParseObject {
     options = options || {};
     var saveOptions = {};
     if (options.hasOwnProperty('useMasterKey')) {
-      saveOptions.useMasterKey = options.useMasterKey;
+      saveOptions.useMasterKey = !!options.useMasterKey;
     }
-    if (options.hasOwnProperty('sessionToken')) {
+    if (options.hasOwnProperty('sessionToken') && typeof options.sessionToken === 'string') {
       saveOptions.sessionToken = options.sessionToken;
     }
 
@@ -1446,7 +1450,7 @@ export default class ParseObject {
    *     this method.
    * @return {Class} A new subclass of Parse.Object.
    */
-  static extend(className: string, protoProps, classProps) {
+  static extend(className: any, protoProps: any, classProps: any) {
     if (typeof className !== 'string') {
       if (className && typeof className.className === 'string') {
         return ParseObject.extend(className.className, className, protoProps);

src/ParseOp.js

@@ -311,7 +311,10 @@ export class RelationOp extends Op {
   relationsToAdd: Array<string>;
   relationsToRemove: Array<string>;
 
-  constructor(adds: Array<ParseObject>, removes: Array<ParseObject>) {
+  constructor(
+    adds: Array<ParseObject | string>,
+    removes: Array<ParseObject | string>
+  ) {
     super();
     this._targetClassName = null;
 
@@ -345,8 +348,11 @@ export class RelationOp extends Op {
     return obj.id;
   }
 
-  applyTo(value: mixed, object: { className: string, id: string }, key: string): ?ParseRelation {
+  applyTo(value: mixed, object?: { className: string, id: ?string }, key?: string): ?ParseRelation {
     if (!value) {
+      if (!object || !key) {
+        throw new Error('Cannot apply a RelationOp without either a previous value, or an object and a key');
+      }
       var parent = new ParseObject(object.className);
       if (object.id && object.id.indexOf('local') === 0) {
         parent._localId = object.id;