@atlaskit/collab-provider 9.22.8 → 9.23.0

package/CHANGELOG.md

@@ -1,5 +1,21 @@
 # @atlaskit/collab-provider
 
+## 9.23.0
+
+### Minor Changes
+
+- [#73460](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/73460) [`5bd301383865`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/5bd301383865) - Add support for PermitOnlyPermissions to determine the user type in PresencePayload
+
+### Patch Changes
+
+- Updated dependencies
+
+## 9.22.9
+
+### Patch Changes
+
+- Updated dependencies
+
 ## 9.22.8
 
 ### Patch Changes

package/dist/cjs/participants/participants-helper.js

@@ -13,11 +13,11 @@ var PARTICIPANT_UPDATE_INTERVAL = exports.PARTICIPANT_UPDATE_INTERVAL = 300 * 10
 
 var createParticipantFromPayload = exports.createParticipantFromPayload = /*#__PURE__*/function () {
   var _ref = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee(payload, getUser) {
-    var sessionId, timestamp, clientId, userId, user, participant;
+    var sessionId, timestamp, clientId, userId, permit, user, participant;
     return _regenerator.default.wrap(function _callee$(_context) {
       while (1) switch (_context.prev = _context.next) {
         case 0:
-          sessionId = payload.sessionId, timestamp = payload.timestamp, clientId = payload.clientId, userId = payload.userId;
+          sessionId = payload.sessionId, timestamp = payload.timestamp, clientId = payload.clientId, userId = payload.userId, permit = payload.permit;
           _context.next = 3;
           return getUser === null || getUser === void 0 ? void 0 : getUser(userId);
         case 3:
@@ -29,7 +29,8 @@ var createParticipantFromPayload = exports.createParticipantFromPayload = /*#__P
             sessionId: sessionId,
             lastActive: timestamp,
             userId: userId,
-            clientId: clientId
+            clientId: clientId,
+            permit: permit
           };
           return _context.abrupt("return", participant);
         case 6:

package/dist/cjs/provider/index.js

@@ -48,11 +48,17 @@ var Provider = exports.Provider = /*#__PURE__*/function (_Emitter) {
     (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "isChannelInitialized", false);
     (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "isProviderInitialized", false);
     (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "isBuffered", false);
+    // User permit is used to determine if the user is allowed to view, comment or edit the document
+    // Therefore, the initial value is false for all three
+    (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "permit", {
+      isPermittedToView: false,
+      isPermittedToComment: false,
+      isPermittedToEdit: 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);
-    (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "permit", {});
     /**
      * Wrapper for this.emit, it binds scope for callbacks and waits for initialising of the editor before emitting events.
      * Waiting for the collab provider to become connected to the editor ensures the editor doesn't miss any events.
@@ -151,7 +157,8 @@ var Provider = exports.Provider = /*#__PURE__*/function (_Emitter) {
       return {
         sessionId: _this.sessionId,
         userId: _this.userId,
-        clientId: _this.clientId
+        clientId: _this.clientId,
+        permit: _this.permit
       };
     });
     /**
@@ -416,7 +423,8 @@ var Provider = exports.Provider = /*#__PURE__*/function (_Emitter) {
             userId: this.userId,
             sessionId: this.sessionId,
             clientId: this.clientId,
-            selection: data.selection
+            selection: data.selection,
+            permit: this.permit
           };
           var callback = (0, _telepointersHelper.telepointerCallback)(this.config.documentAri);
           this.channel.broadcast('participant:telepointer', payload, callback);

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 = "9.22.8";
+var version = exports.version = "9.23.0";
 var nextMajorVersion = exports.nextMajorVersion = function nextMajorVersion() {
   return [Number(version.split('.')[0]) + 1, 0, 0].join('.');
 };

package/dist/es2019/participants/participants-helper.js

@@ -7,7 +7,8 @@ export const createParticipantFromPayload = async (payload, getUser) => {
     sessionId,
     timestamp,
     clientId,
-    userId
+    userId,
+    permit
   } = payload;
   const user = await (getUser === null || getUser === void 0 ? void 0 : getUser(userId));
   const participant = {
@@ -17,7 +18,8 @@ export const createParticipantFromPayload = async (payload, getUser) => {
     sessionId,
     lastActive: timestamp,
     userId,
-    clientId
+    clientId,
+    permit
   };
   return participant;
 };

package/dist/es2019/provider/index.js

@@ -26,11 +26,17 @@ export class Provider extends Emitter {
     _defineProperty(this, "isChannelInitialized", false);
     _defineProperty(this, "isProviderInitialized", false);
     _defineProperty(this, "isBuffered", false);
+    // User permit is used to determine if the user is allowed to view, comment or edit the document
+    // Therefore, the initial value is false for all three
+    _defineProperty(this, "permit", {
+      isPermittedToView: false,
+      isPermittedToComment: false,
+      isPermittedToEdit: 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);
-    _defineProperty(this, "permit", {});
     /**
      * Wrapper for this.emit, it binds scope for callbacks and waits for initialising of the editor before emitting events.
      * Waiting for the collab provider to become connected to the editor ensures the editor doesn't miss any events.
@@ -129,7 +135,8 @@ export class Provider extends Emitter {
       return {
         sessionId: this.sessionId,
         userId: this.userId,
-        clientId: this.clientId
+        clientId: this.clientId,
+        permit: this.permit
       };
     });
     /**
@@ -355,7 +362,8 @@ export class Provider extends Emitter {
           userId: this.userId,
           sessionId: this.sessionId,
           clientId: this.clientId,
-          selection: data.selection
+          selection: data.selection,
+          permit: this.permit
         };
         const callback = telepointerCallback(this.config.documentAri);
         this.channel.broadcast('participant:telepointer', payload, callback);

package/dist/es2019/version-wrapper.js

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

package/dist/esm/participants/participants-helper.js

@@ -6,11 +6,11 @@ export var PARTICIPANT_UPDATE_INTERVAL = 300 * 1000; // 300 seconds
 
 export var createParticipantFromPayload = /*#__PURE__*/function () {
   var _ref = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee(payload, getUser) {
-    var sessionId, timestamp, clientId, userId, user, participant;
+    var sessionId, timestamp, clientId, userId, permit, user, participant;
     return _regeneratorRuntime.wrap(function _callee$(_context) {
       while (1) switch (_context.prev = _context.next) {
         case 0:
-          sessionId = payload.sessionId, timestamp = payload.timestamp, clientId = payload.clientId, userId = payload.userId;
+          sessionId = payload.sessionId, timestamp = payload.timestamp, clientId = payload.clientId, userId = payload.userId, permit = payload.permit;
           _context.next = 3;
           return getUser === null || getUser === void 0 ? void 0 : getUser(userId);
         case 3:
@@ -22,7 +22,8 @@ export var createParticipantFromPayload = /*#__PURE__*/function () {
             sessionId: sessionId,
             lastActive: timestamp,
             userId: userId,
-            clientId: clientId
+            clientId: clientId,
+            permit: permit
           };
           return _context.abrupt("return", participant);
         case 6:

package/dist/esm/provider/index.js

@@ -41,11 +41,17 @@ export var Provider = /*#__PURE__*/function (_Emitter) {
     _defineProperty(_assertThisInitialized(_this), "isChannelInitialized", false);
     _defineProperty(_assertThisInitialized(_this), "isProviderInitialized", false);
     _defineProperty(_assertThisInitialized(_this), "isBuffered", false);
+    // User permit is used to determine if the user is allowed to view, comment or edit the document
+    // Therefore, the initial value is false for all three
+    _defineProperty(_assertThisInitialized(_this), "permit", {
+      isPermittedToView: false,
+      isPermittedToComment: false,
+      isPermittedToEdit: 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);
-    _defineProperty(_assertThisInitialized(_this), "permit", {});
     /**
      * Wrapper for this.emit, it binds scope for callbacks and waits for initialising of the editor before emitting events.
      * Waiting for the collab provider to become connected to the editor ensures the editor doesn't miss any events.
@@ -144,7 +150,8 @@ export var Provider = /*#__PURE__*/function (_Emitter) {
       return {
         sessionId: _this.sessionId,
         userId: _this.userId,
-        clientId: _this.clientId
+        clientId: _this.clientId,
+        permit: _this.permit
       };
     });
     /**
@@ -409,7 +416,8 @@ export var Provider = /*#__PURE__*/function (_Emitter) {
             userId: this.userId,
             sessionId: this.sessionId,
             clientId: this.clientId,
-            selection: data.selection
+            selection: data.selection,
+            permit: this.permit
           };
           var callback = telepointerCallback(this.config.documentAri);
           this.channel.broadcast('participant:telepointer', payload, callback);

package/dist/esm/version-wrapper.js

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

package/dist/types/participants/participants-service.d.ts

@@ -1,6 +1,6 @@
 import type AnalyticsHelper from '../analytics/analytics-helper';
 import type { CollabEventDisconnectedData, ChannelEvent, PresenceData, PresencePayload, TelepointerPayload } from '../types';
-import type { CollabEventPresenceData, CollabTelepointerPayload, StepJson } from '@atlaskit/editor-common/collab';
+import type { CollabEventPresenceData, CollabTelepointerPayload, ProviderParticipant, StepJson } from '@atlaskit/editor-common/collab';
 import type { GetUserType } from './participants-helper';
 import { ParticipantsState } from './participants-state';
 /**
@@ -96,5 +96,5 @@ export declare class ParticipantsService {
     /**
      *
      */
-    getParticipants: () => import("@atlaskit/editor-common/collab").ProviderParticipant[];
+    getParticipants: () => ProviderParticipant[];
 }

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

@@ -16,8 +16,8 @@ export declare class Provider extends Emitter<CollabEvents> implements BaseEvent
     private initialDraft?;
     private isProviderInitialized;
     private isBuffered;
-    private isBufferingEnabled;
     private permit;
+    private isBufferingEnabled;
     private sessionId?;
     private clientId?;
     private userId?;

package/dist/types/types.d.ts

@@ -108,10 +108,16 @@ export type BroadcastIncomingPayload = {
     timestamp?: number;
     data: PresencePayload | TelepointerPayload | StepsPayload | any;
 };
+export type UserPermitType = {
+    isPermittedToView: boolean;
+    isPermittedToComment: boolean;
+    isPermittedToEdit: boolean;
+};
 export type PresenceData = {
     sessionId: string;
     userId: string | undefined;
     clientId: number | string;
+    permit?: UserPermitType;
 };
 export type PresencePayload = PresenceData & {
     timestamp: number;
@@ -145,13 +151,6 @@ export type NamespaceStatus = {
     timestamp: number;
     waitTimeInMs?: number;
 };
-export type Permit = {
-    reason?: string;
-    isPermittedToView?: boolean;
-    isPermittedToComment?: boolean;
-    isPermittedToEdit?: boolean;
-    maintenanceMode?: boolean;
-};
 export type ChannelEvent = {
     connected: {
         sid: string;
@@ -170,7 +169,7 @@ export type ChannelEvent = {
     };
     'steps:added': StepsPayload;
     'metadata:changed': Metadata;
-    permission: Permit;
+    permission: UserPermitType;
     error: InternalError;
     disconnect: {
         reason: string;

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

@@ -1,6 +1,6 @@
 import type AnalyticsHelper from '../analytics/analytics-helper';
 import type { CollabEventDisconnectedData, ChannelEvent, PresenceData, PresencePayload, TelepointerPayload } from '../types';
-import type { CollabEventPresenceData, CollabTelepointerPayload, StepJson } from '@atlaskit/editor-common/collab';
+import type { CollabEventPresenceData, CollabTelepointerPayload, ProviderParticipant, StepJson } from '@atlaskit/editor-common/collab';
 import type { GetUserType } from './participants-helper';
 import { ParticipantsState } from './participants-state';
 /**
@@ -96,5 +96,5 @@ export declare class ParticipantsService {
     /**
      *
      */
-    getParticipants: () => import("@atlaskit/editor-common/collab").ProviderParticipant[];
+    getParticipants: () => ProviderParticipant[];
 }

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

@@ -16,8 +16,8 @@ export declare class Provider extends Emitter<CollabEvents> implements BaseEvent
     private initialDraft?;
     private isProviderInitialized;
     private isBuffered;
-    private isBufferingEnabled;
     private permit;
+    private isBufferingEnabled;
     private sessionId?;
     private clientId?;
     private userId?;

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

@@ -108,10 +108,16 @@ export type BroadcastIncomingPayload = {
     timestamp?: number;
     data: PresencePayload | TelepointerPayload | StepsPayload | any;
 };
+export type UserPermitType = {
+    isPermittedToView: boolean;
+    isPermittedToComment: boolean;
+    isPermittedToEdit: boolean;
+};
 export type PresenceData = {
     sessionId: string;
     userId: string | undefined;
     clientId: number | string;
+    permit?: UserPermitType;
 };
 export type PresencePayload = PresenceData & {
     timestamp: number;
@@ -145,13 +151,6 @@ export type NamespaceStatus = {
     timestamp: number;
     waitTimeInMs?: number;
 };
-export type Permit = {
-    reason?: string;
-    isPermittedToView?: boolean;
-    isPermittedToComment?: boolean;
-    isPermittedToEdit?: boolean;
-    maintenanceMode?: boolean;
-};
 export type ChannelEvent = {
     connected: {
         sid: string;
@@ -170,7 +169,7 @@ export type ChannelEvent = {
     };
     'steps:added': StepsPayload;
     'metadata:changed': Metadata;
-    permission: Permit;
+    permission: UserPermitType;
     error: InternalError;
     disconnect: {
         reason: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/collab-provider",
-  "version": "9.22.8",
+  "version": "9.23.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.9.0",
-    "@atlaskit/editor-common": "^77.5.0",
+    "@atlaskit/editor-common": "^78.1.0",
     "@atlaskit/editor-json-transformer": "^8.10.0",
     "@atlaskit/editor-prosemirror": "3.0.0",
     "@atlaskit/prosemirror-collab": "^0.2.0",