@atlaskit/collab-provider 9.6.2 → 9.6.4

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @atlaskit/collab-provider
 
+## 9.6.4
+
+### Patch Changes
+
+- [`b7cd15f159b`](https://bitbucket.org/atlassian/atlassian-frontend/commits/b7cd15f159b) - ESS-3572 Fix getFinalAcknowledgedState and getCurrentState error handlers not catching errors. Add logs to track the title metadata property
+
+## 9.6.3
+
+### Patch Changes
+
+- [`857daf603b0`](https://bitbucket.org/atlassian/atlassian-frontend/commits/857daf603b0) - ESS-3718: change CollabEventPresenceData joined type to ProviderParticipant
+
 ## 9.6.2
 
 ### Patch Changes

package/dist/cjs/channel.js

@@ -144,19 +144,20 @@ var Channel = /*#__PURE__*/function (_Emitter) {
       logger('Session ID is', _this.socket.id);
       if (data.type === 'initial') {
         if (!_this.initialized) {
-          var _this$initExperience, _this$analyticsHelper6;
+          var _this$initExperience, _this$analyticsHelper6, _data$metadata;
+          var doc = data.doc,
+            version = data.version,
+            userId = data.userId,
+            metadata = data.metadata;
           var measure = (0, _performance.stopMeasure)(_performance.MEASURE_NAME.DOCUMENT_INIT, _this.analyticsHelper);
           (_this$initExperience = _this.initExperience) === null || _this$initExperience === void 0 ? void 0 : _this$initExperience.success();
           (_this$analyticsHelper6 = _this.analyticsHelper) === null || _this$analyticsHelper6 === void 0 ? void 0 : _this$analyticsHelper6.sendActionEvent(_const.EVENT_ACTION.DOCUMENT_INIT,
           // TODO: detect when document init fails and fire corresponding event for it
           _const.EVENT_STATUS.SUCCESS, {
             latency: measure === null || measure === void 0 ? void 0 : measure.duration,
-            resetReason: data === null || data === void 0 ? void 0 : data.resetReason
+            resetReason: data.resetReason,
+            hasTitle: !!((_data$metadata = data.metadata) !== null && _data$metadata !== void 0 && _data$metadata.title)
           });
-          var doc = data.doc,
-            version = data.version,
-            userId = data.userId,
-            metadata = data.metadata;
           _this.initialized = true;
           _this.emit('init', {
             doc: doc,

package/dist/cjs/document/document-service.js

@@ -263,7 +263,8 @@ var DocumentService = /*#__PURE__*/function () {
           _this.applyLocalSteps(unconfirmedSteps);
         }
         (_this$analyticsHelper11 = _this.analyticsHelper) === null || _this$analyticsHelper11 === void 0 ? void 0 : _this$analyticsHelper11.sendActionEvent(_const.EVENT_ACTION.REINITIALISE_DOCUMENT, _const.EVENT_STATUS.SUCCESS, {
-          numUnconfirmedSteps: unconfirmedSteps === null || unconfirmedSteps === void 0 ? void 0 : unconfirmedSteps.length
+          numUnconfirmedSteps: unconfirmedSteps === null || unconfirmedSteps === void 0 ? void 0 : unconfirmedSteps.length,
+          hasTitle: !!(metadata !== null && metadata !== void 0 && metadata.title)
         });
       } catch (restoreError) {
         var _this$analyticsHelper12, _this$analyticsHelper13;

package/dist/cjs/provider/index.js

@@ -192,17 +192,20 @@ var Provider = /*#__PURE__*/function (_Emitter) {
         while (1) switch (_context.prev = _context.next) {
           case 0:
             _context.prev = 0;
-            return _context.abrupt("return", _this.documentService.getCurrentState());
-          case 4:
-            _context.prev = 4;
+            _context.next = 3;
+            return _this.documentService.getCurrentState();
+          case 3:
+            return _context.abrupt("return", _context.sent);
+          case 6:
+            _context.prev = 6;
             _context.t0 = _context["catch"](0);
             (_this$analyticsHelper5 = _this.analyticsHelper) === null || _this$analyticsHelper5 === void 0 ? void 0 : _this$analyticsHelper5.sendErrorEvent(_context.t0, 'Error while returning ADF version of current draft document');
             throw new _errorTypes.GetCurrentStateError('Error while returning the current state of the draft document', _context.t0);
-          case 8:
+          case 10:
           case "end":
             return _context.stop();
         }
-      }, _callee, null, [[0, 4]]);
+      }, _callee, null, [[0, 6]]);
     })));
     /**
      * Return the final acknowledged (by NCS) ADF version of the current draft document, together with it's title and the current step version.

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.6.2";
+var version = "9.6.4";
 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.6.2",
+	"version": "9.6.4",
 	"sideEffects": false
 }

package/dist/es2019/channel.js

@@ -112,21 +112,22 @@ export class Channel extends Emitter {
       logger('Session ID is', this.socket.id);
       if (data.type === 'initial') {
         if (!this.initialized) {
-          var _this$initExperience, _this$analyticsHelper6;
+          var _this$initExperience, _this$analyticsHelper6, _data$metadata;
+          const {
+            doc,
+            version,
+            userId,
+            metadata
+          } = data;
           const measure = stopMeasure(MEASURE_NAME.DOCUMENT_INIT, this.analyticsHelper);
           (_this$initExperience = this.initExperience) === null || _this$initExperience === void 0 ? void 0 : _this$initExperience.success();
           (_this$analyticsHelper6 = this.analyticsHelper) === null || _this$analyticsHelper6 === void 0 ? void 0 : _this$analyticsHelper6.sendActionEvent(EVENT_ACTION.DOCUMENT_INIT,
           // TODO: detect when document init fails and fire corresponding event for it
           EVENT_STATUS.SUCCESS, {
             latency: measure === null || measure === void 0 ? void 0 : measure.duration,
-            resetReason: data === null || data === void 0 ? void 0 : data.resetReason
+            resetReason: data.resetReason,
+            hasTitle: !!((_data$metadata = data.metadata) !== null && _data$metadata !== void 0 && _data$metadata.title)
           });
-          const {
-            doc,
-            version,
-            userId,
-            metadata
-          } = data;
           this.initialized = true;
           this.emit('init', {
             doc,

package/dist/es2019/document/document-service.js

@@ -220,7 +220,8 @@ export class DocumentService {
           this.applyLocalSteps(unconfirmedSteps);
         }
         (_this$analyticsHelper11 = this.analyticsHelper) === null || _this$analyticsHelper11 === void 0 ? void 0 : _this$analyticsHelper11.sendActionEvent(EVENT_ACTION.REINITIALISE_DOCUMENT, EVENT_STATUS.SUCCESS, {
-          numUnconfirmedSteps: unconfirmedSteps === null || unconfirmedSteps === void 0 ? void 0 : unconfirmedSteps.length
+          numUnconfirmedSteps: unconfirmedSteps === null || unconfirmedSteps === void 0 ? void 0 : unconfirmedSteps.length,
+          hasTitle: !!(metadata !== null && metadata !== void 0 && metadata.title)
         });
       } catch (restoreError) {
         var _this$analyticsHelper12, _this$analyticsHelper13;

package/dist/es2019/provider/index.js

@@ -165,7 +165,7 @@ export class Provider extends Emitter {
      */
     _defineProperty(this, "getCurrentState", async () => {
       try {
-        return this.documentService.getCurrentState();
+        return await this.documentService.getCurrentState();
       } catch (error) {
         var _this$analyticsHelper5;
         (_this$analyticsHelper5 = this.analyticsHelper) === null || _this$analyticsHelper5 === void 0 ? void 0 : _this$analyticsHelper5.sendErrorEvent(error, 'Error while returning ADF version of current draft document');

package/dist/es2019/version-wrapper.js

@@ -1,5 +1,5 @@
 export const name = "@atlaskit/collab-provider";
-export const version = "9.6.2";
+export const version = "9.6.4";
 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.6.2",
+	"version": "9.6.4",
 	"sideEffects": false
 }

package/dist/esm/channel.js

@@ -137,19 +137,20 @@ export var Channel = /*#__PURE__*/function (_Emitter) {
       logger('Session ID is', _this.socket.id);
       if (data.type === 'initial') {
         if (!_this.initialized) {
-          var _this$initExperience, _this$analyticsHelper6;
+          var _this$initExperience, _this$analyticsHelper6, _data$metadata;
+          var doc = data.doc,
+            version = data.version,
+            userId = data.userId,
+            metadata = data.metadata;
           var measure = stopMeasure(MEASURE_NAME.DOCUMENT_INIT, _this.analyticsHelper);
           (_this$initExperience = _this.initExperience) === null || _this$initExperience === void 0 ? void 0 : _this$initExperience.success();
           (_this$analyticsHelper6 = _this.analyticsHelper) === null || _this$analyticsHelper6 === void 0 ? void 0 : _this$analyticsHelper6.sendActionEvent(EVENT_ACTION.DOCUMENT_INIT,
           // TODO: detect when document init fails and fire corresponding event for it
           EVENT_STATUS.SUCCESS, {
             latency: measure === null || measure === void 0 ? void 0 : measure.duration,
-            resetReason: data === null || data === void 0 ? void 0 : data.resetReason
+            resetReason: data.resetReason,
+            hasTitle: !!((_data$metadata = data.metadata) !== null && _data$metadata !== void 0 && _data$metadata.title)
           });
-          var doc = data.doc,
-            version = data.version,
-            userId = data.userId,
-            metadata = data.metadata;
           _this.initialized = true;
           _this.emit('init', {
             doc: doc,

package/dist/esm/document/document-service.js

@@ -256,7 +256,8 @@ export var DocumentService = /*#__PURE__*/function () {
           _this.applyLocalSteps(unconfirmedSteps);
         }
         (_this$analyticsHelper11 = _this.analyticsHelper) === null || _this$analyticsHelper11 === void 0 ? void 0 : _this$analyticsHelper11.sendActionEvent(EVENT_ACTION.REINITIALISE_DOCUMENT, EVENT_STATUS.SUCCESS, {
-          numUnconfirmedSteps: unconfirmedSteps === null || unconfirmedSteps === void 0 ? void 0 : unconfirmedSteps.length
+          numUnconfirmedSteps: unconfirmedSteps === null || unconfirmedSteps === void 0 ? void 0 : unconfirmedSteps.length,
+          hasTitle: !!(metadata !== null && metadata !== void 0 && metadata.title)
         });
       } catch (restoreError) {
         var _this$analyticsHelper12, _this$analyticsHelper13;

package/dist/esm/provider/index.js

@@ -184,17 +184,20 @@ export var Provider = /*#__PURE__*/function (_Emitter) {
         while (1) switch (_context.prev = _context.next) {
           case 0:
             _context.prev = 0;
-            return _context.abrupt("return", _this.documentService.getCurrentState());
-          case 4:
-            _context.prev = 4;
+            _context.next = 3;
+            return _this.documentService.getCurrentState();
+          case 3:
+            return _context.abrupt("return", _context.sent);
+          case 6:
+            _context.prev = 6;
             _context.t0 = _context["catch"](0);
             (_this$analyticsHelper5 = _this.analyticsHelper) === null || _this$analyticsHelper5 === void 0 ? void 0 : _this$analyticsHelper5.sendErrorEvent(_context.t0, 'Error while returning ADF version of current draft document');
             throw new GetCurrentStateError('Error while returning the current state of the draft document', _context.t0);
-          case 8:
+          case 10:
           case "end":
             return _context.stop();
         }
-      }, _callee, null, [[0, 4]]);
+      }, _callee, null, [[0, 6]]);
     })));
     /**
      * Return the final acknowledged (by NCS) ADF version of the current draft document, together with it's title and the current step version.

package/dist/esm/version-wrapper.js

@@ -1,5 +1,5 @@
 export var name = "@atlaskit/collab-provider";
-export var version = "9.6.2";
+export var version = "9.6.4";
 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.6.2",
+	"version": "9.6.4",
 	"sideEffects": false
 }

package/dist/types/helpers/const.d.ts

@@ -139,6 +139,7 @@ type DocumentInitSuccessAnalyticsEvent = {
         eventStatus: EVENT_STATUS.SUCCESS;
         latency?: number;
         resetReason?: string;
+        hasTitle: boolean;
     };
 };
 type UpdateParticipantsSuccessAnalyticsEvent = {

package/dist/types/types.d.ts

@@ -8,7 +8,8 @@ import type { ProviderError } from './errors/error-types';
 import { JSONDocNode } from '@atlaskit/editor-json-transformer';
 import { GetUserType } from './participants/participants-helper';
 import AnalyticsHelper from './analytics/analytics-helper';
-export type { ProviderParticipant } from './participants/participants-helper';
+import type { ProviderParticipant } from './participants/participants-helper';
+export { ProviderParticipant };
 export interface CollabParticipant {
     lastActive: number;
     sessionId: string;
@@ -40,7 +41,7 @@ export interface CollabEventDisconnectedData {
     reason: 'CLIENT_DISCONNECT' | 'SERVER_DISCONNECT' | 'SOCKET_CLOSED' | 'SOCKET_ERROR' | 'SOCKET_TIMEOUT' | 'UNKNOWN_DISCONNECT';
 }
 export interface CollabEventPresenceData {
-    joined?: CollabParticipant[];
+    joined?: ProviderParticipant[];
     left?: {
         sessionId: string;
     }[];

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

@@ -139,6 +139,7 @@ type DocumentInitSuccessAnalyticsEvent = {
         eventStatus: EVENT_STATUS.SUCCESS;
         latency?: number;
         resetReason?: string;
+        hasTitle: boolean;
     };
 };
 type UpdateParticipantsSuccessAnalyticsEvent = {

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

@@ -8,7 +8,8 @@ import type { ProviderError } from './errors/error-types';
 import { JSONDocNode } from '@atlaskit/editor-json-transformer';
 import { GetUserType } from './participants/participants-helper';
 import AnalyticsHelper from './analytics/analytics-helper';
-export type { ProviderParticipant } from './participants/participants-helper';
+import type { ProviderParticipant } from './participants/participants-helper';
+export { ProviderParticipant };
 export interface CollabParticipant {
     lastActive: number;
     sessionId: string;
@@ -40,7 +41,7 @@ export interface CollabEventDisconnectedData {
     reason: 'CLIENT_DISCONNECT' | 'SERVER_DISCONNECT' | 'SOCKET_CLOSED' | 'SOCKET_ERROR' | 'SOCKET_TIMEOUT' | 'UNKNOWN_DISCONNECT';
 }
 export interface CollabEventPresenceData {
-    joined?: CollabParticipant[];
+    joined?: ProviderParticipant[];
     left?: {
         sessionId: string;
     }[];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/collab-provider",
-  "version": "9.6.2",
+  "version": "9.6.4",
   "description": "A provider for collaborative editing.",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
@@ -61,7 +61,7 @@
     }
   },
   "devDependencies": {
-    "@atlaskit/adf-schema": "^26.1.0",
+    "@atlaskit/adf-schema": "^26.2.0",
     "@atlaskit/analytics-listeners": "^8.7.0",
     "@atlaskit/editor-test-helpers": "^18.10.0",
     "@atlassian/atlassian-frontend-prettier-config-1.0.1": "npm:@atlassian/atlassian-frontend-prettier-config@1.0.1",

package/report.api.md

@@ -141,7 +141,7 @@ export interface CollabEventLocalStepData {
 // @public (undocumented)
 export interface CollabEventPresenceData {
   // (undocumented)
-  joined?: CollabParticipant[];
+  joined?: ProviderParticipant[];
   // (undocumented)
   left?: {
     sessionId: string;

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

@@ -117,7 +117,7 @@ export interface CollabEventLocalStepData {
 // @public (undocumented)
 export interface CollabEventPresenceData {
     // (undocumented)
-    joined?: CollabParticipant[];
+    joined?: ProviderParticipant[];
     // (undocumented)
     left?: {
         sessionId: string;