@atlaskit/collab-provider 7.1.1 → 7.1.5

package/dist/cjs/socket-io-provider.js

@@ -5,8 +5,8 @@ var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefau
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.createSocketIOSocket = createSocketIOSocket;
 exports.createSocketIOCollabProvider = createSocketIOCollabProvider;
+exports.createSocketIOSocket = createSocketIOSocket;
 
 var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
 
@@ -16,9 +16,9 @@ var _socket = require("socket.io-client");
 
 var _urlParse2 = _interopRequireDefault(require("url-parse"));
 
-function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); if (enumerableOnly) { symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; }); } keys.push.apply(keys, symbols); } return keys; }
+function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
 
-function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i] != null ? arguments[i] : {}; if (i % 2) { ownKeys(Object(source), true).forEach(function (key) { (0, _defineProperty2.default)(target, key, source[key]); }); } else if (Object.getOwnPropertyDescriptors) { Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)); } else { ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } } return target; }
+function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { (0, _defineProperty2.default)(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
 
 function createSocketIOSocket(url, auth) {
   var _urlParse = (0, _urlParse2.default)(url),

package/dist/cjs/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/collab-provider",
-	"version": "7.1.1",
+	"version": "7.1.5",
 	"sideEffects": false
 }

package/dist/es2019/provider/index.js

@@ -21,6 +21,8 @@ export const CATCHUP_THROTTLE = 1 * 1000; // 1 second
 
 const OUT_OF_SYNC_PERIOD = 3 * 1000; // 3 seconds
 
+const noop = () => {};
+
 export const MAX_STEP_REJECTED_ERROR = 15;
 
 const commitStep = ({
@@ -55,6 +57,38 @@ export class Provider extends Emitter {
 
     _defineProperty(this, "stepRejectCounter", 0);
 
+    _defineProperty(this, "isChannelInitialized", false);
+
+    _defineProperty(this, "initializeChannel", () => {
+      this.channel.on('connected', ({
+        sid,
+        initialized
+      }) => {
+        this.sessionId = sid;
+        this.emit('connected', {
+          sid
+        }); // If already initialized, `connected` means reconnected
+
+        if (initialized && this.disconnectedAt && // Offline longer than `OUT_OF_SYNC_PERIOD`
+        Date.now() - this.disconnectedAt >= OUT_OF_SYNC_PERIOD) {
+          this.throttledCatchup();
+        }
+
+        this.disconnectedAt = undefined;
+      }).on('init', ({
+        doc,
+        version,
+        metadata
+      }) => {
+        // Initial document and version
+        this.updateDocumentWithMetadata({
+          doc,
+          version,
+          metadata
+        });
+      }).on('steps:added', this.onStepsAdded.bind(this)).on('participant:telepointer', this.onParticipantTelepointer.bind(this)).on('presence:joined', this.onPresenceJoined.bind(this)).on('presence', this.onPresence.bind(this)).on('participant:left', this.onParticipantLeft.bind(this)).on('participant:updated', this.onParticipantUpdated.bind(this)).on('metadata:changed', this.onMetadataChanged.bind(this)).on('disconnect', this.onDisconnected.bind(this)).on('error', this.onErrorHandled.bind(this)).connect();
+    });
+
     _defineProperty(this, "onStepsAdded", data => {
       logger(`Received steps`, {
         steps: data.steps,
@@ -216,6 +250,7 @@ export class Provider extends Emitter {
 
     _defineProperty(this, "onMetadataChanged", metadata => {
       if (metadata !== undefined && !isequal(this.metadata, metadata)) {
+        this.metadata = metadata;
         this.emit('metadata:changed', metadata);
       }
     });
@@ -388,50 +423,78 @@ export class Provider extends Emitter {
       }
     });
 
+    _defineProperty(this, "getFinalAcknowledgedState", async () => {
+      var _this$getUnconfirmedS, _this$metadata$title;
+
+      const maxAttemptsToSync = ACK_MAX_TRY;
+      let count = 0;
+      let unconfirmedSteps = (_this$getUnconfirmedS = this.getUnconfirmedSteps()) === null || _this$getUnconfirmedS === void 0 ? void 0 : _this$getUnconfirmedS.steps;
+
+      while (unconfirmedSteps && unconfirmedSteps.length) {
+        var _this$getUnconfirmedS2;
+
+        this.sendStepsFromCurrentState();
+        await sleep(500);
+        unconfirmedSteps = (_this$getUnconfirmedS2 = this.getUnconfirmedSteps()) === null || _this$getUnconfirmedS2 === void 0 ? void 0 : _this$getUnconfirmedS2.steps;
+
+        if (count++ >= maxAttemptsToSync) {
+          if (this.onSyncUpError) {
+            var _unconfirmedSteps;
+
+            const state = this.getState();
+            this.onSyncUpError({
+              lengthOfUnconfirmedSteps: (_unconfirmedSteps = unconfirmedSteps) === null || _unconfirmedSteps === void 0 ? void 0 : _unconfirmedSteps.length,
+              tries: count,
+              maxRetries: maxAttemptsToSync,
+              clientId: this.clientId,
+              version: getVersion(state)
+            });
+          }
+
+          throw new Error("Can't syncup with Collab Service");
+        }
+      }
+
+      const state = this.getState();
+      return {
+        content: state.doc.toJSON(),
+        title: (_this$metadata$title = this.metadata.title) === null || _this$metadata$title === void 0 ? void 0 : _this$metadata$title.toString(),
+        stepVersion: getVersion(state)
+      };
+    });
+
     this.config = config;
     this.channel = new Channel(config);
+    this.isChannelInitialized = false;
 
     if (config.analyticsClient) {
       this.analyticsClient = config.analyticsClient;
     }
   }
+
   /**
    * Called by collab plugin in editor when it's ready to
    * initialize a collab session.
    */
+  initialize(getState) {
+    return this.setup({
+      getState
+    });
+  }
 
+  setup({
+    getState,
+    onSyncUpError
+  }) {
+    this.getState = getState;
+    this.onSyncUpError = onSyncUpError || noop;
+    this.clientId = getState().plugins.find(p => p.key === 'collab$').spec.config.clientID;
+
+    if (!this.isChannelInitialized) {
+      this.initializeChannel();
+      this.isChannelInitialized = true;
+    }
 
-  initialize(optionsOrGetState) {
-    this.getState = typeof optionsOrGetState === 'function' ? optionsOrGetState : optionsOrGetState.getState;
-    this.clientId = typeof optionsOrGetState === 'function' ? // Quick-hack to get clientID from native collab-plugin.
-    this.getState().plugins.find(p => p.key === 'collab$').spec.config.clientID : optionsOrGetState.clientId;
-    this.channel.on('connected', ({
-      sid,
-      initialized
-    }) => {
-      this.sessionId = sid;
-      this.emit('connected', {
-        sid
-      }); // If already initialized, `connected` means reconnected
-
-      if (initialized && this.disconnectedAt && // Offline longer than `OUT_OF_SYNC_PERIOD`
-      Date.now() - this.disconnectedAt >= OUT_OF_SYNC_PERIOD) {
-        this.throttledCatchup();
-      }
-
-      this.disconnectedAt = undefined;
-    }).on('init', ({
-      doc,
-      version,
-      metadata
-    }) => {
-      // Initial document and version
-      this.updateDocumentWithMetadata({
-        doc,
-        version,
-        metadata
-      });
-    }).on('steps:added', this.onStepsAdded).on('participant:telepointer', this.onParticipantTelepointer).on('presence:joined', this.onPresenceJoined).on('presence', this.onPresence).on('participant:left', this.onParticipantLeft).on('participant:updated', this.onParticipantUpdated).on('metadata:changed', this.onMetadataChanged).on('disconnect', this.onDisconnected).on('error', this.onErrorHandled).connect();
     return this;
   }
   /**
@@ -644,43 +707,10 @@ export class Provider extends Emitter {
     this.channel.sendMetadata(metadata);
     Object.assign(this.metadata, metadata);
   }
-  /**
-   * Get latest state.
-   *
-   * NOTE: Should this actually convert to ADF instead?
-   */
-
-
-  async getFinalAcknowledgedState() {
-    var _this$getUnconfirmedS;
-
-    const state = this.getState();
-    let count = 0;
-    let unconfirmedSteps = this.getUnconfirmedSteps() && ((_this$getUnconfirmedS = this.getUnconfirmedSteps()) === null || _this$getUnconfirmedS === void 0 ? void 0 : _this$getUnconfirmedS.steps);
-
-    while (unconfirmedSteps && unconfirmedSteps.length) {
-      var _this$getUnconfirmedS2;
-
-      this.sendStepsFromCurrentState();
-      await sleep(500);
-      unconfirmedSteps = this.getUnconfirmedSteps() && ((_this$getUnconfirmedS2 = this.getUnconfirmedSteps()) === null || _this$getUnconfirmedS2 === void 0 ? void 0 : _this$getUnconfirmedS2.steps);
 
-      if (count++ >= ACK_MAX_TRY) {
-        throw new Error("Can't syncup with Collab Service");
-      }
-    }
-
-    return {
-      content: state.doc.toJSON(),
-      title: this.metadata.title,
-      stepVersion: getVersion(state)
-    };
-  }
   /**
    * Unsubscribe from all events emitted by this provider.
    */
-
-
   unsubscribeAll() {
     super.unsubscribeAll();
     this.channel.disconnect();

package/dist/es2019/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/collab-provider",
-	"version": "7.1.1",
+	"version": "7.1.5",
 	"sideEffects": false
 }

package/dist/esm/analytics/index.js

@@ -1,8 +1,8 @@
 import _defineProperty from "@babel/runtime/helpers/defineProperty";
 
-function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); if (enumerableOnly) { symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; }); } keys.push.apply(keys, symbols); } return keys; }
+function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
 
-function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i] != null ? arguments[i] : {}; if (i % 2) { ownKeys(Object(source), true).forEach(function (key) { _defineProperty(target, key, source[key]); }); } else if (Object.getOwnPropertyDescriptors) { Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)); } else { ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } } return target; }
+function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { _defineProperty(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
 
 import { ATTRIBUTES_PACKAGE, CATCHUP_FAILURE, CATCHUP_SUCCESS, STEPS_ADDED, STEPS_REJECTED } from '../helpers/const';
 export var buildAnalyticsPayload = function buildAnalyticsPayload(subject, payload) {

package/dist/esm/channel.js

@@ -8,9 +8,9 @@ import _possibleConstructorReturn from "@babel/runtime/helpers/possibleConstruct
 import _getPrototypeOf from "@babel/runtime/helpers/getPrototypeOf";
 import _defineProperty from "@babel/runtime/helpers/defineProperty";
 
-function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); if (enumerableOnly) { symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; }); } keys.push.apply(keys, symbols); } return keys; }
+function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
 
-function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i] != null ? arguments[i] : {}; if (i % 2) { ownKeys(Object(source), true).forEach(function (key) { _defineProperty(target, key, source[key]); }); } else if (Object.getOwnPropertyDescriptors) { Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)); } else { ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } } return target; }
+function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { _defineProperty(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
 
 function _createSuper(Derived) { var hasNativeReflectConstruct = _isNativeReflectConstruct(); return function _createSuperInternal() { var Super = _getPrototypeOf(Derived), result; if (hasNativeReflectConstruct) { var NewTarget = _getPrototypeOf(this).constructor; result = Reflect.construct(Super, arguments, NewTarget); } else { result = Super.apply(this, arguments); } return _possibleConstructorReturn(this, result); }; }