- add connect and disconnect API in sharehub for hub reusin for reconnection

 - add `init-connect` option in `sharehub`
 - tweak doc / comment about data cloning - we now dont suggest clone data internally by default
 - bump version

Author: zbryikt

CHANGELOG.md

@@ -1,5 +1,12 @@
 # Change Logs
 
+## v0.5.2
+
+ - add `connect` and `disconnect` API in `sharehub` for hub reusin for reconnection
+ - add `init-connect` option in `sharehub`
+ - tweak doc / comment about data cloning - we now dont suggest clone data internally by default
+
+
 ## v0.5.1
 
  - fix bug: memhub and usrhub should not clone data to prevent data inconsistency

README.md

@@ -15,7 +15,7 @@ after including `datahub.bundle.min.js`:
     # this is our data source.
     src = new datahub.src do
       ops-out: (ops) -> # update data src by incoming ops
-      get: -> # return complete data. always return cloned data to prevent user from touching original data
+      get: -> # return complete data. raw data is returned, users should make their own copy if to use.
 
     # this is our view controller
     des = new datahub.des do
@@ -121,6 +121,17 @@ Sharehub provides a simple interface and implementation reference for adopting S
 
 Sharehub is in a standalone JS file. include `sharehub.js` / `sharehub.min.js` / `sharehub.bundle.min.js` if you want to use it.
 
+Constructor options:
+
+ - `id`: document to connect.  optional
+ - `init-connect`: default true. if true, auto connect to sharedb if `id` is given.
+
+
+APIs:
+
+ - `connect(id)`: connect to sharedb with doc id `id`. return Promise, resolved when connected.
+ - `disconnect()`: disconnect current doc from sharedb. return Promise, resolved when disconnected.
+
 
 ## Scoping
 
@@ -146,7 +157,7 @@ You can pipe data source to a hub that is scoped, and pipe this scoped hub to th
    - fields of `o`:
      - `ops-in(ops)`: a function to handle inward ops.
    - a destination hub is responsible to call `ops-out(ops)`  when there are data changes to source (outward ops)
- - `get()`: return a ( cloned ) snapshot of source data
+ - `get()`: return a snapshot of source data
  - `pipe(hub)`: pipe down events to `hub`.
  - `addon(ops)`: prepend `ops` to create node for ops accessing non-existed path
  - `cut(hub)`: remove `hub` from current object's subscriber list.

dist/sharehub.js

@@ -7,6 +7,7 @@
     this.evthdr = {};
     this.data = {};
     this.id = opt.id || '';
+    this._initConnect = opt.initConnect != null ? opt.initConnect : true;
     this._create = opt.create || null;
     this._watch = opt.watch || null;
     this.ews = opt.ews;
@@ -50,23 +51,14 @@
       }
       return this.opsIn(ops);
     },
-    init: function(){
-      var this$ = this;
-      return Promise.resolve().then(function(){
-        var sdb;
-        this$.sdb = sdb = new ews.sdbClient({
-          ws: this$.ews
-        });
-        sdb.on('error', function(e){
-          var ref$;
-          if (!((ref$ = this$.evthdr).error || (ref$.error = [])).length) {
-            return console.error(e.err);
-          } else {
-            return this$.fire('error', e.err);
-          }
-        });
-        return sdb.get({
-          id: this$.id,
+    connect: function(id){
+      var p, this$ = this;
+      p = this.sdb
+        ? Promise.resolve()
+        : this.init();
+      return p.then(function(){
+        return this$.sdb.get({
+          id: id || this$.id,
           create: this$._create
             ? function(){
               return this$._create();
@@ -85,8 +77,41 @@
           }
         });
       }).then(function(doc){
-        this$.doc = doc;
-        this$.data = doc.data;
+        return this$.doc = doc, this$.data = doc.data, this$;
+      });
+    },
+    disconnect: function(){
+      var this$ = this;
+      if (!this.doc) {
+        return Promise.resolve();
+      }
+      return new Promise(function(res, rej){
+        return this$.doc.destroy(function(){
+          this$.doc = null;
+          this$.data = null;
+          return res();
+        });
+      });
+    },
+    init: function(){
+      var this$ = this;
+      return Promise.resolve().then(function(){
+        var sdb;
+        this$.sdb = sdb = new ews.sdbClient({
+          ws: this$.ews
+        });
+        sdb.on('error', function(e){
+          var ref$;
+          if (!((ref$ = this$.evthdr).error || (ref$.error = [])).length) {
+            return console.error(e.err);
+          } else {
+            return this$.fire('error', e.err);
+          }
+        });
+        if (this$.id && this$._initConnect) {
+          return this$.connect();
+        }
+      }).then(function(){
         return {
           sdb: this$.sdb
         };

dist/sharehub.min.js

@@ -8,7 +8,7 @@
     "dist/**/*"
   ],
   "description": "access scoped data via piped operational transformation",
-  "version": "0.5.1",
+  "version": "0.5.2",
   "homepage": "https://github.com/plotdb/datahub",
   "repository": {
     "type": "git",

package-lock.json

@@ -114,7 +114,7 @@ srchub = (opt={}) ->
   datahub.call @, opt
   @as-src do
     ops-out: opt.ops-out or (->)
-    # should always return cloned data otherwise user might touch the original data
+    # raw data is returned. user should clone returned data if to use.
     get: opt.get or (->)
   @
 srchub.prototype = {} <<< datahub.prototype

package.json

@@ -4,6 +4,7 @@ sharehub = (opt={}) ->
   @evthdr = {}
   @data = {}
   @id = opt.id or ''
+  @_init-connect = if opt.init-connect? => opt.init-connect else true
   @_create = opt.create or null
   @_watch = opt.watch or null
   @ews = opt.ews
@@ -28,27 +29,40 @@ sharehub.prototype = {} <<< hub.src.prototype <<< do
     # this is necessary since we have to track origin hub by _id
     if @_watch => @_watch ops, src
     if src => return
-    # DATA: We have to apply if we clone data when init.
+    # DATA: We have to apply if we clone data when connecting.
     #if !src => @data = json0.type.apply @data, ops
     @ops-in ops
+
+  connect: (id) ->
+    p = if @sdb => Promise.resolve!
+    else @init!
+    p
+      .then ~>
+        @sdb.get do
+          id: id or @id
+          create: if @_create => (~> @_create!) else (->{})
+          watch: (...args) ~> @watch.apply @, args
+      .then (doc) ~>
+        # DATA: We pass raw data now, but if we want to clone:
+        # @data = JSON.parse(JSON.stringify(doc.data))
+        @ <<< doc: doc, data: doc.data
+
+  disconnect: ->
+    if !@doc => return Promise.resolve!
+    (res, rej) <~ new Promise _
+    <~ @doc.destroy _
+    @ <<< {doc: null, data: null}
+    res!
+
   init: ->
     Promise.resolve!
       .then ~>
         @sdb = sdb = new ews.sdb-client ws: @ews
-        #@sdb = sdb = new sharedb-wrapper url: window.location.protocol.replace(\:,''), window.location.domain
         sdb.on \error, (e) ~>
           if !@evthdr.[]error.length => console.error e.err
           else @fire \error, e.err
-        sdb.get do
-          id: @id
-          create: if @_create => (~> @_create!) else (->{})
-          watch: (...args) ~> @watch.apply @, args
-      .then (doc) ~>
-        @doc = doc
-        @data = doc.data
-        # DATA: we dont really need this, but this ensures that users cant alter our data
-        # @data = JSON.parse(JSON.stringify(@doc.data))
-        return {sdb: @sdb}
+        if @id and @_init-connect => @connect!
+      .then ~> {sdb: @sdb}
 
 if module? => module.exports = sharehub
 else if window? => window.sharehub = sharehub