JSONDiff updates flow types for change utils (#63)

* Uses es6 modules syntax in jsondiff and dmp

* Adds flowtipe definitions to change utils and jsondiff

- jsondiff is only imported by change utils
- jsondiff exports a single configured instance
- jsondiff flowtype definitions are added in .flow.js file since jsondiff itself is a bit of a mess

* Updates to package configurations

Author: beaucollins

.eslintignore

@@ -3,3 +3,4 @@ src/simperium/jsondiff
 lib/
 sample/
 examples/
+flow-typed/

flow-typed/npm/uuid_v3.x.x.js

@@ -0,0 +1,81 @@
+// flow-typed signature: 615e568e95029d58f116dd157e320137
+// flow-typed version: 2b95c0dfc1/uuid_v3.x.x/flow_>=v0.32.x
+
+declare module "uuid" {
+  declare class uuid {
+    static (
+      options?: {|
+        random?: number[],
+        rng?: () => number[] | Buffer
+      |},
+      buffer?: number[] | Buffer,
+      offset?: number
+    ): string,
+
+    static v1(
+      options?: {|
+        node?: number[],
+        clockseq?: number,
+        msecs?: number | Date,
+        nsecs?: number
+      |},
+      buffer?: number[] | Buffer,
+      offset?: number
+    ): string,
+
+    static v4(
+      options?: {|
+        random?: number[],
+        rng?: () => number[] | Buffer
+      |},
+      buffer?: number[] | Buffer,
+      offset?: number
+    ): string
+  }
+  declare module.exports: Class<uuid>;
+}
+
+declare module "uuid/v1" {
+  declare class v1 {
+    static (
+      options?: {|
+        node?: number[],
+        clockseq?: number,
+        msecs?: number | Date,
+        nsecs?: number
+      |},
+      buffer?: number[] | Buffer,
+      offset?: number
+    ): string
+  }
+
+  declare module.exports: Class<v1>;
+}
+
+declare module "uuid/v4" {
+  declare class v4 {
+    static (
+      options?: {|
+        random?: number[],
+        rng?: () => number[] | Buffer
+      |},
+      buffer?: number[] | Buffer,
+      offset?: number
+    ): string
+  }
+
+  declare module.exports: Class<v4>;
+}
+
+declare module "uuid/v5" {
+  declare class v5 {
+    static (
+      name?: string | number[],
+      namespace?: string | number[],
+      buffer?: number[] | Buffer,
+      offset?: number
+    ): string
+  }
+
+  declare module.exports: Class<v5>;
+}

package-lock.json

@@ -32,6 +32,7 @@
     "babel-preset-env": "^1.6.1",
     "babel-preset-flow": "^6.23.0",
     "eslint": "^4.17.0",
+    "flow-bin": "^0.66.0",
     "mocha": "^5.0.0",
     "nyc": "^11.4.1"
   }

package.json

@@ -2,11 +2,8 @@
 import { format, inherits } from 'util'
 import { EventEmitter } from 'events'
 import { parseMessage, parseVersionMessage, change as change_util } from './util'
-import JSONDiff from './jsondiff'
 import { v4 as uuid } from 'uuid'
 
-const jsondiff = new JSONDiff( {list_diff: false} );
-
 const UNKNOWN_CV = '?';
 const CODE_INVALID_VERSION = 405;
 const CODE_EMPTY_RESPONSE = 412;
@@ -128,7 +125,7 @@ internal.updateObjectVersion = function( id, version, data, original, patch, ack
 		// apply the transformed patch and emit the update
 		if ( transformed ) {
 			patch = transformed;
-			update = jsondiff.apply_object_diff( data, transformed );
+			update = change_util.apply( transformed, data );
 			// queue up the new change
 			change = change_util.modify( id, version, patch );
 			this.localQueue.queue( change );
@@ -218,7 +215,7 @@ internal.applyChange = function( change, ghost ) {
 
 		original = ghost.data;
 		patch = change.v;
-		modified = jsondiff.apply_object_diff( original, patch );
+		modified = change_util.apply( patch, original );
 		return internal.updateObjectVersion.call( this, change.id, change.ev, modified, original, patch, acknowledged )
 			.then( updateChangeVersion );
 	} else if ( change.o === operation.REMOVE ) {
@@ -842,7 +839,7 @@ LocalQueue.prototype.compressAndSend = function( id, ghost ) {
 			break;
 		}
 
-		target = jsondiff.apply_object_diff( target, c.v );
+		target = change_util.apply( c.v, target );
 	}
 
 	type = target === null ? change_util.type.REMOVE : change_util.type.MODIFY;

src/simperium/channel.js

@@ -1,4 +1,3 @@
-module.exports = diff_match_patch;
 
 /**
  * Diff Match and Patch
@@ -29,7 +28,7 @@ module.exports = diff_match_patch;
  * Class containing the diff, match and patch methods.
  * @constructor
  */
-function diff_match_patch() {
+export default function diff_match_patch() {
 
   // Defaults.
   // Redefine these in your program to override the defaults.
@@ -65,9 +64,9 @@ function diff_match_patch() {
  * [[DIFF_DELETE, 'Hello'], [DIFF_INSERT, 'Goodbye'], [DIFF_EQUAL, ' world.']]
  * which means: delete 'Hello', add 'Goodbye' and keep ' world.'
  */
-var DIFF_DELETE = -1;
-var DIFF_INSERT = 1;
-var DIFF_EQUAL = 0;
+export const DIFF_DELETE = -1;
+export const DIFF_INSERT = 1;
+export const DIFF_EQUAL = 0;
 
 /** @typedef {{0: number, 1: string}} */
 diff_match_patch.Diff;
@@ -2183,13 +2182,3 @@ diff_match_patch.patch_obj.prototype.toString = function() {
   }
   return text.join('').replace(/%20/g, ' ');
 };
-
-
-// Export these global variables so that they survive Google's JS compiler.
-// In a browser, 'this' will be 'window'.
-// Users of node.js should 'require' the uncompressed version since Google's
-// JS compiler may break the following exports for non-browser environments.
-module.exports['diff_match_patch'] = diff_match_patch;
-module.exports['DIFF_DELETE'] = DIFF_DELETE;
-module.exports['DIFF_INSERT'] = DIFF_INSERT;
-module.exports['DIFF_EQUAL'] = DIFF_EQUAL;

src/simperium/jsondiff/diff_match_patch.js

@@ -1,8 +1,9 @@
-import JSONDiff from './jsondiff'
-import diff_match_patch from './diff_match_patch'
+// @flow
+import { JSONDiff } from './jsondiff'
+import type { ObjectOperationSet } from './jsondiff';
 
-export { JSONDiff as jsondiff, diff_match_patch }
+export type { ObjectOperationSet }
 
-export default function init( options ) {
-	return new JSONDiff( options );
-}
+const jsondiff = new JSONDiff( { list_diff: false } );
+
+export { jsondiff as default };

src/simperium/jsondiff/index.js

@@ -1,14 +1,12 @@
-var diff_match_patch = require('./diff_match_patch');
+import diff_match_patch, { DIFF_DELETE, DIFF_EQUAL, DIFF_INSERT } from './diff_match_patch';
 
-// stolen from https://raw.github.com/Simperium/jsondiff/master/src/jsondiff.js
-(function() {
-  var jsondiff,
-    __bind = function(fn, me){ return function(){ return fn.apply(me, arguments); }; },
-    __hasProp = Object.prototype.hasOwnProperty;
+export { jsondiff as JSONDiff };
 
-  jsondiff = (function() {
+// stolen from https://raw.github.com/Simperium/jsondiff/master/src/jsondiff.js
+const __hasProp = Object.prototype.hasOwnProperty;
+const __bind = function(fn, me){ return function(){ return fn.apply(me, arguments); }; };
 
-    function jsondiff(options) {
+    function jsondiff(options: ?{ list_diff: boolean } ) {
       this.options = options || {list_diff: true};
       this.patch_apply_with_offsets = __bind(this.patch_apply_with_offsets, this);
       this.transform_object_diff = __bind(this.transform_object_diff, this);
@@ -611,11 +609,3 @@ var diff_match_patch = require('./diff_match_patch');
     text = text.substring(nullPadding.length, text.length - nullPadding.length);
     return text;
   };
-
-    return jsondiff;
-
-  })();
-
-  module.exports = jsondiff;
-
-}).call();