@atlaskit/collab-provider 9.7.4 → 9.8.0

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @atlaskit/collab-provider
 
+## 9.8.0
+
+### Minor Changes
+
+- [`aceff84b101`](https://bitbucket.org/atlassian/atlassian-frontend/commits/aceff84b101) - initializing provider on setup if buffering is enabled
+
 ## 9.7.4
 
 ### Patch Changes

package/dist/cjs/provider/index.js

@@ -43,6 +43,10 @@ var Provider = /*#__PURE__*/function (_Emitter) {
     _this = _super.call(this);
     (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "isChannelInitialized", false);
     (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "isProviderInitialized", false);
+    // isBufferingEnabled is a boolean value passed to the config during provider creation.
+    // It determines if the provider should initialize immediately and will only be true if:
+    // the feature flag is enabled and the initial draft fetched from NCS is also passed in the config.
+    (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "isBufferingEnabled", false);
     // isPreinitializating acts as a feature flag to determine when the provider has been initialized early
     // and also contains the initial draft
     (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "isPreinitializing", false);
@@ -96,6 +100,13 @@ var Provider = /*#__PURE__*/function (_Emitter) {
         var sid = _ref2.sid,
           initialized = _ref2.initialized;
         _this.sessionId = sid;
+        // if buffering is enabled and the provider is initialized before connection, call catchup
+        // once setup resolves with the defined editor state
+        if (_this.isBufferingEnabled && _this.isProviderInitialized) {
+          _this.onSetupPromise.then(function () {
+            _this.documentService.sendStepsFromCurrentState();
+          });
+        }
         _this.emitCallback('connected', {
           sid: sid,
           initial: !initialized
@@ -271,6 +282,7 @@ var Provider = /*#__PURE__*/function (_Emitter) {
     _this.channel = new _channel.Channel(config, _this.analyticsHelper);
     _this.isChannelInitialized = false;
     _this.initialDraft = _this.config.initialDraft;
+    _this.isBufferingEnabled = Boolean(_this.config.isBufferingEnabled);
     _this.isProviderInitialized = false;
     _this.isPreinitializing = false;
     _this.participantsService = new _participantsService.ParticipantsService(_this.analyticsHelper, undefined, _this.emitCallback, _this.config.getUser, _this.channel.broadcast, _this.channel.sendPresenceJoined, _this.getPresenceData, _this.setUserId);
@@ -341,6 +353,17 @@ var Provider = /*#__PURE__*/function (_Emitter) {
           // a defined getState (ie editor state is ready) AND after documentService sets the editor state
           if (this.isPreinitializing) {
             this.resolveOnSetupPromise();
+            if (this.isBufferingEnabled && this.initialDraft && !this.isProviderInitialized) {
+              var _this$initialDraft2 = this.initialDraft,
+                document = _this$initialDraft2.document,
+                version = _this$initialDraft2.version,
+                metadata = _this$initialDraft2.metadata;
+              this.updateDocumentAndMetadata({
+                doc: document,
+                version: version,
+                metadata: metadata
+              });
+            }
           }
         }
         if (!this.isChannelInitialized) {
@@ -374,8 +397,8 @@ var Provider = /*#__PURE__*/function (_Emitter) {
   }, {
     key: "isDraftTimestampStale",
     value: function isDraftTimestampStale() {
-      var _this$initialDraft2;
-      if (!((_this$initialDraft2 = this.initialDraft) !== null && _this$initialDraft2 !== void 0 && _this$initialDraft2.timestamp)) {
+      var _this$initialDraft3;
+      if (!((_this$initialDraft3 = this.initialDraft) !== null && _this$initialDraft3 !== void 0 && _this$initialDraft3.timestamp)) {
         return false;
       }
       return Date.now() - this.initialDraft.timestamp >= PRELOAD_DRAFT_SYNC_PERIOD;

package/dist/cjs/version-wrapper.js

@@ -6,7 +6,7 @@ Object.defineProperty(exports, "__esModule", {
 exports.version = exports.nextMajorVersion = exports.name = void 0;
 var name = "@atlaskit/collab-provider";
 exports.name = name;
-var version = "9.7.4";
+var version = "9.8.0";
 exports.version = version;
 var nextMajorVersion = function nextMajorVersion() {
   return [Number(version.split('.')[0]) + 1, 0, 0].join('.');

package/dist/cjs/version.json

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

package/dist/es2019/provider/index.js

@@ -20,6 +20,10 @@ export class Provider extends Emitter {
     super();
     _defineProperty(this, "isChannelInitialized", false);
     _defineProperty(this, "isProviderInitialized", false);
+    // isBufferingEnabled is a boolean value passed to the config during provider creation.
+    // It determines if the provider should initialize immediately and will only be true if:
+    // the feature flag is enabled and the initial draft fetched from NCS is also passed in the config.
+    _defineProperty(this, "isBufferingEnabled", false);
     // isPreinitializating acts as a feature flag to determine when the provider has been initialized early
     // and also contains the initial draft
     _defineProperty(this, "isPreinitializing", false);
@@ -73,6 +77,13 @@ export class Provider extends Emitter {
         initialized
       }) => {
         this.sessionId = sid;
+        // if buffering is enabled and the provider is initialized before connection, call catchup
+        // once setup resolves with the defined editor state
+        if (this.isBufferingEnabled && this.isProviderInitialized) {
+          this.onSetupPromise.then(() => {
+            this.documentService.sendStepsFromCurrentState();
+          });
+        }
         this.emitCallback('connected', {
           sid,
           initial: !initialized
@@ -225,6 +236,7 @@ export class Provider extends Emitter {
     this.channel = new Channel(config, this.analyticsHelper);
     this.isChannelInitialized = false;
     this.initialDraft = this.config.initialDraft;
+    this.isBufferingEnabled = Boolean(this.config.isBufferingEnabled);
     this.isProviderInitialized = false;
     this.isPreinitializing = false;
     this.participantsService = new ParticipantsService(this.analyticsHelper, undefined, this.emitCallback, this.config.getUser, this.channel.broadcast, this.channel.sendPresenceJoined, this.getPresenceData, this.setUserId);
@@ -286,6 +298,18 @@ export class Provider extends Emitter {
         // a defined getState (ie editor state is ready) AND after documentService sets the editor state
         if (this.isPreinitializing) {
           this.resolveOnSetupPromise();
+          if (this.isBufferingEnabled && this.initialDraft && !this.isProviderInitialized) {
+            const {
+              document,
+              version,
+              metadata
+            } = this.initialDraft;
+            this.updateDocumentAndMetadata({
+              doc: document,
+              version,
+              metadata
+            });
+          }
         }
       }
       if (!this.isChannelInitialized) {

package/dist/es2019/version-wrapper.js

@@ -1,5 +1,5 @@
 export const name = "@atlaskit/collab-provider";
-export const version = "9.7.4";
+export const version = "9.8.0";
 export const nextMajorVersion = () => {
   return [Number(version.split('.')[0]) + 1, 0, 0].join('.');
 };

package/dist/es2019/version.json

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

package/dist/esm/provider/index.js

@@ -35,6 +35,10 @@ export var Provider = /*#__PURE__*/function (_Emitter) {
     _this = _super.call(this);
     _defineProperty(_assertThisInitialized(_this), "isChannelInitialized", false);
     _defineProperty(_assertThisInitialized(_this), "isProviderInitialized", false);
+    // isBufferingEnabled is a boolean value passed to the config during provider creation.
+    // It determines if the provider should initialize immediately and will only be true if:
+    // the feature flag is enabled and the initial draft fetched from NCS is also passed in the config.
+    _defineProperty(_assertThisInitialized(_this), "isBufferingEnabled", false);
     // isPreinitializating acts as a feature flag to determine when the provider has been initialized early
     // and also contains the initial draft
     _defineProperty(_assertThisInitialized(_this), "isPreinitializing", false);
@@ -88,6 +92,13 @@ export var Provider = /*#__PURE__*/function (_Emitter) {
         var sid = _ref2.sid,
           initialized = _ref2.initialized;
         _this.sessionId = sid;
+        // if buffering is enabled and the provider is initialized before connection, call catchup
+        // once setup resolves with the defined editor state
+        if (_this.isBufferingEnabled && _this.isProviderInitialized) {
+          _this.onSetupPromise.then(function () {
+            _this.documentService.sendStepsFromCurrentState();
+          });
+        }
         _this.emitCallback('connected', {
           sid: sid,
           initial: !initialized
@@ -263,6 +274,7 @@ export var Provider = /*#__PURE__*/function (_Emitter) {
     _this.channel = new Channel(config, _this.analyticsHelper);
     _this.isChannelInitialized = false;
     _this.initialDraft = _this.config.initialDraft;
+    _this.isBufferingEnabled = Boolean(_this.config.isBufferingEnabled);
     _this.isProviderInitialized = false;
     _this.isPreinitializing = false;
     _this.participantsService = new ParticipantsService(_this.analyticsHelper, undefined, _this.emitCallback, _this.config.getUser, _this.channel.broadcast, _this.channel.sendPresenceJoined, _this.getPresenceData, _this.setUserId);
@@ -333,6 +345,17 @@ export var Provider = /*#__PURE__*/function (_Emitter) {
           // a defined getState (ie editor state is ready) AND after documentService sets the editor state
           if (this.isPreinitializing) {
             this.resolveOnSetupPromise();
+            if (this.isBufferingEnabled && this.initialDraft && !this.isProviderInitialized) {
+              var _this$initialDraft2 = this.initialDraft,
+                document = _this$initialDraft2.document,
+                version = _this$initialDraft2.version,
+                metadata = _this$initialDraft2.metadata;
+              this.updateDocumentAndMetadata({
+                doc: document,
+                version: version,
+                metadata: metadata
+              });
+            }
           }
         }
         if (!this.isChannelInitialized) {
@@ -366,8 +389,8 @@ export var Provider = /*#__PURE__*/function (_Emitter) {
   }, {
     key: "isDraftTimestampStale",
     value: function isDraftTimestampStale() {
-      var _this$initialDraft2;
-      if (!((_this$initialDraft2 = this.initialDraft) !== null && _this$initialDraft2 !== void 0 && _this$initialDraft2.timestamp)) {
+      var _this$initialDraft3;
+      if (!((_this$initialDraft3 = this.initialDraft) !== null && _this$initialDraft3 !== void 0 && _this$initialDraft3.timestamp)) {
         return false;
       }
       return Date.now() - this.initialDraft.timestamp >= PRELOAD_DRAFT_SYNC_PERIOD;

package/dist/esm/version-wrapper.js

@@ -1,5 +1,5 @@
 export var name = "@atlaskit/collab-provider";
-export var version = "9.7.4";
+export var version = "9.8.0";
 export var nextMajorVersion = function nextMajorVersion() {
   return [Number(version.split('.')[0]) + 1, 0, 0].join('.');
 };

package/dist/esm/version.json

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

package/dist/types/provider/index.d.ts

@@ -12,6 +12,7 @@ export declare class Provider extends Emitter<CollabEvents> implements BaseEvent
     private isChannelInitialized;
     private initialDraft?;
     private isProviderInitialized;
+    private isBufferingEnabled;
     private isPreinitializing;
     private sessionId?;
     private clientId?;

package/dist/types/types.d.ts

@@ -53,6 +53,7 @@ export interface Config {
      */
     throwOnNotConnected?: boolean;
     initialDraft?: InitialDraft;
+    isBufferingEnabled?: boolean;
     /**
      * When a page is being published this number can control the number of failed steps until a catchup is triggered.
      * The default value is MAX_STEP_REJECTED_ERROR (15).

package/dist/types-ts4.5/provider/index.d.ts

@@ -12,6 +12,7 @@ export declare class Provider extends Emitter<CollabEvents> implements BaseEvent
     private isChannelInitialized;
     private initialDraft?;
     private isProviderInitialized;
+    private isBufferingEnabled;
     private isPreinitializing;
     private sessionId?;
     private clientId?;

package/dist/types-ts4.5/types.d.ts

@@ -53,6 +53,7 @@ export interface Config {
      */
     throwOnNotConnected?: boolean;
     initialDraft?: InitialDraft;
+    isBufferingEnabled?: boolean;
     /**
      * When a page is being published this number can control the number of failed steps until a catchup is triggered.
      * The default value is MAX_STEP_REJECTED_ERROR (15).

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/collab-provider",
-  "version": "9.7.4",
+  "version": "9.8.0",
   "description": "A provider for collaborative editing.",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
@@ -36,7 +36,7 @@
   "dependencies": {
     "@atlaskit/analytics-gas-types": "^5.1.0",
     "@atlaskit/analytics-listeners": "^8.7.0",
-    "@atlaskit/editor-common": "^74.29.0",
+    "@atlaskit/editor-common": "^74.35.0",
     "@atlaskit/editor-json-transformer": "^8.10.0",
     "@atlaskit/editor-prosemirror": "1.0.2",
     "@atlaskit/prosemirror-collab": "^0.2.0",

package/report.api.md

@@ -138,6 +138,8 @@ interface Config {
   // (undocumented)
   initialDraft?: InitialDraft;
   // (undocumented)
+  isBufferingEnabled?: boolean;
+  // (undocumented)
   lifecycle?: Lifecycle;
   // (undocumented)
   need404?: boolean;

package/tmp/api-report-tmp.d.ts

@@ -114,6 +114,8 @@ interface Config {
     // (undocumented)
     initialDraft?: InitialDraft;
     // (undocumented)
+    isBufferingEnabled?: boolean;
+    // (undocumented)
     lifecycle?: Lifecycle;
     // (undocumented)
     need404?: boolean;