@atlaskit/collab-provider 28.1.0 → 28.2.0

package/CHANGELOG.md

@@ -1,5 +1,18 @@
 # @atlaskit/collab-provider
 
+## 28.2.0
+
+### Minor Changes
+
+- [`9461b21b24472`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/9461b21b24472) -
+  Add the recovery:required provider event with a reason payload so Confluence can reset an NCS
+  document on request. NCS sends the event to the document's current socket. Rollout is controlled
+  by NCS emitting the event.
+
+### Patch Changes
+
+- Updated dependencies
+
 ## 28.1.0
 
 ### Minor Changes

package/dist/cjs/channel.js

@@ -637,6 +637,9 @@ var Channel = exports.Channel = /*#__PURE__*/function (_Emitter) {
       this.socket.on('steps:added', function (data) {
         _this2.emit('steps:added', data);
       });
+      this.socket.on('recovery:required', function (data) {
+        _this2.emit('recovery:required', data);
+      });
       this.socket.on('participant:telepointer', function (_ref7) {
         var timestamp = _ref7.timestamp,
           data = _ref7.data;

package/dist/cjs/provider/index.js

@@ -194,7 +194,11 @@ var Provider = exports.Provider = /*#__PURE__*/function (_Emitter) {
       }).on('restore', _this.documentService.onRestore).on('permission', function (permit) {
         _this.permit = Object.assign(_this.permit, permit);
         _this.emit('permission', permit);
-      }).on('steps:added', _this.documentService.onStepsAdded).on('metadata:changed', _this.metadataService.onMetadataChanged).on('participant:telepointer', function (payload) {
+      }).on('steps:added', _this.documentService.onStepsAdded).on('recovery:required', function (payload) {
+        if (typeof (payload === null || payload === void 0 ? void 0 : payload.reason) === 'string') {
+          _this.emit('recovery:required', payload);
+        }
+      }).on('metadata:changed', _this.metadataService.onMetadataChanged).on('participant:telepointer', function (payload) {
         return _this.participantsService.onParticipantTelepointer(payload, _this.sessionId);
       }).on('presence:joined', _this.participantsService.onPresenceJoined).on('presence', _this.participantsService.onPresence).on('participant:left', _this.participantsService.onParticipantLeft).on('participant:updated', _this.participantsService.onParticipantUpdated).on('disconnect', _this.onDisconnected.bind(_this)).on('error', _this.onErrorHandled).on('status', /*#__PURE__*/function () {
         var _ref4 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee(status) {

package/dist/cjs/version-wrapper.js

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

package/dist/es2019/channel.js

@@ -459,6 +459,9 @@ export class Channel extends Emitter {
     this.socket.on('steps:added', data => {
       this.emit('steps:added', data);
     });
+    this.socket.on('recovery:required', data => {
+      this.emit('recovery:required', data);
+    });
     this.socket.on('participant:telepointer', ({
       timestamp,
       data

package/dist/es2019/provider/index.js

@@ -175,7 +175,11 @@ export class Provider extends Emitter {
       }).on('restore', this.documentService.onRestore).on('permission', permit => {
         this.permit = Object.assign(this.permit, permit);
         this.emit('permission', permit);
-      }).on('steps:added', this.documentService.onStepsAdded).on('metadata:changed', this.metadataService.onMetadataChanged).on('participant:telepointer', payload => this.participantsService.onParticipantTelepointer(payload, this.sessionId)).on('presence:joined', this.participantsService.onPresenceJoined).on('presence', this.participantsService.onPresence).on('participant:left', this.participantsService.onParticipantLeft).on('participant:updated', this.participantsService.onParticipantUpdated).on('disconnect', this.onDisconnected.bind(this)).on('error', this.onErrorHandled).on('status', async status => {
+      }).on('steps:added', this.documentService.onStepsAdded).on('recovery:required', payload => {
+        if (typeof (payload === null || payload === void 0 ? void 0 : payload.reason) === 'string') {
+          this.emit('recovery:required', payload);
+        }
+      }).on('metadata:changed', this.metadataService.onMetadataChanged).on('participant:telepointer', payload => this.participantsService.onParticipantTelepointer(payload, this.sessionId)).on('presence:joined', this.participantsService.onPresenceJoined).on('presence', this.participantsService.onPresence).on('participant:left', this.participantsService.onParticipantLeft).on('participant:updated', this.participantsService.onParticipantUpdated).on('disconnect', this.onDisconnected.bind(this)).on('error', this.onErrorHandled).on('status', async status => {
         await this.namespaceService.onNamespaceStatusChanged(status);
         const isLocked = this.namespaceService.getIsNamespaceLocked();
         this.emit('namespace-lock:check', {

package/dist/es2019/version-wrapper.js

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

package/dist/esm/channel.js

@@ -630,6 +630,9 @@ export var Channel = /*#__PURE__*/function (_Emitter) {
       this.socket.on('steps:added', function (data) {
         _this2.emit('steps:added', data);
       });
+      this.socket.on('recovery:required', function (data) {
+        _this2.emit('recovery:required', data);
+      });
       this.socket.on('participant:telepointer', function (_ref7) {
         var timestamp = _ref7.timestamp,
           data = _ref7.data;

package/dist/esm/provider/index.js

@@ -188,7 +188,11 @@ export var Provider = /*#__PURE__*/function (_Emitter) {
       }).on('restore', _this.documentService.onRestore).on('permission', function (permit) {
         _this.permit = Object.assign(_this.permit, permit);
         _this.emit('permission', permit);
-      }).on('steps:added', _this.documentService.onStepsAdded).on('metadata:changed', _this.metadataService.onMetadataChanged).on('participant:telepointer', function (payload) {
+      }).on('steps:added', _this.documentService.onStepsAdded).on('recovery:required', function (payload) {
+        if (typeof (payload === null || payload === void 0 ? void 0 : payload.reason) === 'string') {
+          _this.emit('recovery:required', payload);
+        }
+      }).on('metadata:changed', _this.metadataService.onMetadataChanged).on('participant:telepointer', function (payload) {
         return _this.participantsService.onParticipantTelepointer(payload, _this.sessionId);
       }).on('presence:joined', _this.participantsService.onPresenceJoined).on('presence', _this.participantsService.onPresence).on('participant:left', _this.participantsService.onParticipantLeft).on('participant:updated', _this.participantsService.onParticipantUpdated).on('disconnect', _this.onDisconnected.bind(_this)).on('error', _this.onErrorHandled).on('status', /*#__PURE__*/function () {
         var _ref4 = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee(status) {

package/dist/esm/version-wrapper.js

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

package/dist/types/types.d.ts

@@ -5,7 +5,7 @@ import type { InternalError } from './errors/internal-errors';
 import type { JSONDocNode } from '@atlaskit/editor-json-transformer/types';
 import type { BatchProps, GetUserType } from './participants/participants-helper';
 import type AnalyticsHelper from './analytics/analytics-helper';
-import type { StepJson, CollabSendableSelection, Metadata, UserPermitType, PresenceActivity } from '@atlaskit/editor-common/collab';
+import type { StepJson, CollabSendableSelection, Metadata, UserPermitType, PresenceActivity, CollabRecoveryRequiredPayload } from '@atlaskit/editor-common/collab';
 import type { CatchupEventReason } from './helpers/const';
 import type { EditorState } from '@atlaskit/editor-prosemirror/state';
 export interface CollabEventDisconnectedData {
@@ -244,6 +244,7 @@ export type ChannelEvent = {
     presence: PresencePayload;
     'presence:joined': PresencePayload;
     reconnected: null;
+    'recovery:required': CollabRecoveryRequiredPayload;
     restore: InitPayload;
     status: NamespaceStatus;
     'steps:added': StepsPayload;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/collab-provider",
-	"version": "28.1.0",
+	"version": "28.2.0",
 	"description": "A provider for collaborative editing.",
 	"publishConfig": {
 		"registry": "https://registry.npmjs.org/"
@@ -75,6 +75,6 @@
 		}
 	},
 	"peerDependencies": {
-		"@atlaskit/editor-common": "^123.0.0"
+		"@atlaskit/editor-common": "^123.1.0"
 	}
 }