@atlaskit/collab-provider 8.9.1 → 9.0.1

package/dist/esm/provider/index.js

@@ -107,6 +107,16 @@ export var Provider = /*#__PURE__*/function (_Emitter) {
         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(_assertThisInitialized(_this))).on('error', _this.onErrorHandled).on('status', _this.namespaceService.onNamespaceStatusChanged).connect(shouldInitialize);
     });
+    _defineProperty(_assertThisInitialized(_this), "setUserId", function (id) {
+      _this.userId = id;
+    });
+    _defineProperty(_assertThisInitialized(_this), "getPresenceData", function () {
+      return {
+        sessionId: _this.sessionId,
+        userId: _this.userId,
+        clientId: _this.clientId
+      };
+    });
     /**
      * @param {InternalError} error The error to handle
      */
@@ -175,17 +185,20 @@ export var Provider = /*#__PURE__*/function (_Emitter) {
         while (1) switch (_context2.prev = _context2.next) {
           case 0:
             _context2.prev = 0;
-            return _context2.abrupt("return", _this.documentService.getFinalAcknowledgedState());
-          case 4:
-            _context2.prev = 4;
+            _context2.next = 3;
+            return _this.documentService.getFinalAcknowledgedState();
+          case 3:
+            return _context2.abrupt("return", _context2.sent);
+          case 6:
+            _context2.prev = 6;
             _context2.t0 = _context2["catch"](0);
             (_this$analyticsHelper4 = _this.analyticsHelper) === null || _this$analyticsHelper4 === void 0 ? void 0 : _this$analyticsHelper4.sendErrorEvent(_context2.t0, 'Error while returning ADF version of the final draft document');
             throw new GetFinalAcknowledgedStateError('Error while returning the final acknowledged state of the draft document', _context2.t0);
-          case 8:
+          case 10:
           case "end":
             return _context2.stop();
         }
-      }, _callee2, null, [[0, 4]]);
+      }, _callee2, null, [[0, 6]]);
     })));
     _defineProperty(_assertThisInitialized(_this), "getUnconfirmedSteps", function () {
       return _this.documentService.getUnconfirmedSteps();
@@ -204,7 +217,7 @@ export var Provider = /*#__PURE__*/function (_Emitter) {
     _this.initialDraft = _this.config.initialDraft;
     _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.participantsService = new ParticipantsService(_this.analyticsHelper, undefined, _this.emitCallback, _this.config.getUser, _this.channel.broadcast, _this.channel.sendPresenceJoined, _this.getPresenceData, _this.setUserId);
     _this.metadataService = new MetadataService(_this.emitCallback, _this.channel.sendMetadata);
     _this.documentService = new DocumentService(_this.participantsService, _this.analyticsHelper, _this.channel.fetchCatchup, _this.emitCallback, _this.channel.broadcast, function () {
       return _this.userId;
@@ -324,7 +337,7 @@ export var Provider = /*#__PURE__*/function (_Emitter) {
     /**
      * Send messages, such as telepointers, to NCS and other participants. Only used for telepointer data (text and node selections) in the editor and JWM. JWM does some weird serialisation stuff on the node selections.
      * Silently fails if an error occurs, since Presence isn't a critical functionality and self-restores over time.
-     * @param {CollabEventTelepointerData} data Data you want to send to NCS / the other participants
+     * @param {CollabTelepointerPayload} data Data you want to send to NCS / the other participants
      * @param {string} data.type Can only be 'telepointer' for now, we don't support anything else yet
      * @param {CollabSendableSelection} data.selection Object representing the selected element
      * @param {string} data.sessionId Identifier identifying the session

package/dist/esm/types.js

@@ -1,8 +1,8 @@
-// Initial draft
+// types from editor common
 
-/**
- * @deprecated Use ProviderError type instead
- */
+// types from editor common end
+
+// Initial draft
 
 // Channel
 

package/dist/esm/version-wrapper.js

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

package/dist/types/channel.d.ts

@@ -41,7 +41,7 @@ export declare class Channel extends Emitter<ChannelEvent> {
      * @throws {NotConnectedError} Channel not connected
      */
     sendMetadata: (metadata: Metadata) => void;
-    sendPresenceJoined(): void;
+    sendPresenceJoined: () => void;
     onOnlineHandler: () => void;
     disconnect(): void;
 }

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

@@ -1,11 +1,10 @@
 /// <reference types="lodash" />
 import AnalyticsHelper from '../analytics/analytics-helper';
-import { CatchupResponse, ChannelEvent, CollabEvents, CollabInitPayload, StepsPayload } from '../types';
+import { CatchupResponse, ChannelEvent, CollabEvents, CollabInitPayload, ResolvedEditorState, StepsPayload } from '../types';
 import type { Step as ProseMirrorStep } from 'prosemirror-transform';
 import type { MetadataService } from '../metadata/metadata-service';
-import { SyncUpErrorFunction } from '@atlaskit/editor-common/types';
+import { SyncUpErrorFunction } from '../types';
 import type { EditorState, Transaction } from 'prosemirror-state';
-import { ResolvedEditorState } from '@atlaskit/editor-common/collab';
 import { ParticipantsService } from '../participants/participants-service';
 import type { InternalError } from '../errors/error-types';
 export declare class DocumentService {

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

@@ -10,7 +10,8 @@ export declare enum EVENT_ACTION {
     ERROR = "error",
     PUBLISH_PAGE = "publishPage",
     GET_CURRENT_STATE = "getCurrentState",
-    INVALIDATE_TOKEN = "invalidateToken"
+    INVALIDATE_TOKEN = "invalidateToken",
+    DROPPED_STEPS = "droppedStepInCatchup"
 }
 export declare enum EVENT_STATUS {
     SUCCESS = "SUCCESS",
@@ -110,6 +111,13 @@ type CatchUpFailureAnalyticsEvent = {
         latency?: number;
     };
 };
+type CatchUpDroppedStepsEvent = {
+    eventAction: EVENT_ACTION.DROPPED_STEPS;
+    attributes: {
+        documentAri: string;
+        numOfDroppedSteps: number;
+    };
+};
 type DocumentInitSuccessAnalyticsEvent = {
     eventAction: EVENT_ACTION.DOCUMENT_INIT;
     attributes: {
@@ -177,7 +185,7 @@ type GetCurrentStateFailureAnalyticsEvent = {
         latency?: number;
     };
 };
-export type ActionAnalyticsEvent = AddStepsSuccessAnalyticsEvent | AddStepsFailureAnalyticsEvent | ReInitDocFailAnalyticsEvent | ReInitDocSuccessAnalyticsEvent | ConnectionSuccessAnalyticsEvent | ConnectionFailureAnalyticsEvent | CatchUpSuccessAnalyticsEvent | CatchUpFailureAnalyticsEvent | DocumentInitSuccessAnalyticsEvent | UpdateParticipantsSuccessAnalyticsEvent | CommitUnconfirmedStepsSuccessAnalyticsEvent | CommitUnconfirmedStepsFailureAnalyticsEvent | PublishPageSuccessAnalyticsEvent | PublishPageFailureAnalyticsEvent | GetCurrentStateSuccessAnalyticsEvent | GetCurrentStateFailureAnalyticsEvent | InvalidateTokenAnalyticsEvent;
-export declare const ACK_MAX_TRY = 30;
+export type ActionAnalyticsEvent = AddStepsSuccessAnalyticsEvent | AddStepsFailureAnalyticsEvent | ReInitDocFailAnalyticsEvent | ReInitDocSuccessAnalyticsEvent | ConnectionSuccessAnalyticsEvent | ConnectionFailureAnalyticsEvent | CatchUpSuccessAnalyticsEvent | CatchUpFailureAnalyticsEvent | DocumentInitSuccessAnalyticsEvent | UpdateParticipantsSuccessAnalyticsEvent | CommitUnconfirmedStepsSuccessAnalyticsEvent | CommitUnconfirmedStepsFailureAnalyticsEvent | PublishPageSuccessAnalyticsEvent | PublishPageFailureAnalyticsEvent | GetCurrentStateSuccessAnalyticsEvent | GetCurrentStateFailureAnalyticsEvent | InvalidateTokenAnalyticsEvent | CatchUpDroppedStepsEvent;
+export declare const ACK_MAX_TRY = 60;
 export declare const CONFLUENCE = "confluence";
 export {};

package/dist/types/index.d.ts

@@ -1,4 +1,4 @@
 export { Provider } from './provider';
-export type { CollabConnectedPayload, CollabDisconnectedPayload, CollabErrorPayload, CollabInitPayload, CollabDataPayload, CollabTelepointerPayload, CollabPresencePayload, CollabMetadataPayload, CollabLocalStepsPayload, CollabEvents, CollabSendableSelection, CollabEditProvider, Socket, } from './types';
+export type { CollabParticipant, CollabEventInitData, CollabEventRemoteData, CollabEventConnectionData, CollabEventConnectingData, CollabEventDisconnectedData, CollabEventPresenceData, CollabEventTelepointerData, CollabEventLocalStepData, ResolvedEditorState, CollabConnectedPayload, CollabDisconnectedPayload, CollabInitPayload, CollabDataPayload, CollabTelepointerPayload, CollabPresencePayload, CollabMetadataPayload, CollabLocalStepsPayload, CollabEvents, CollabSendableSelection, CollabEditProvider, SyncUpErrorFunction, NewCollabSyncUpErrorAttributes, Socket, } from './types';
 export type { ProviderError } from './errors/error-types';
 export { PROVIDER_ERROR_CODE } from './errors/error-types';

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

@@ -1,5 +1,4 @@
-import type { CollabParticipant } from '@atlaskit/editor-common/collab';
-import type { PresencePayload } from '../types';
+import type { CollabParticipant, PresencePayload } from '../types';
 export declare const PARTICIPANT_UPDATE_INTERVAL: number;
 export type ProviderParticipant = CollabParticipant & {
     userId: string;
@@ -7,6 +6,8 @@ export type ProviderParticipant = CollabParticipant & {
 };
 export type ParticipantsMap = Map<string, ProviderParticipant>;
 export type GetUserType = ((userId: string) => Promise<Pick<ProviderParticipant, 'name' | 'avatar' | 'userId'>>) | undefined;
-export declare const createParticipantFromPayload: (payload: PresencePayload & {
+export declare const createParticipantFromPayload: (payload: import("../types").PresenceData & {
+    timestamp: number;
+} & {
     userId: string;
 }, getUser: GetUserType) => Promise<ProviderParticipant>;

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

@@ -1,6 +1,5 @@
-import type { CollabEventPresenceData, CollabEventDisconnectedData } from '@atlaskit/editor-common/collab';
 import AnalyticsHelper from '../analytics/analytics-helper';
-import type { ChannelEvent, CollabEventTelepointerData, PresencePayload, StepJson, TelepointerPayload } from '../types';
+import type { CollabEventDisconnectedData, CollabEventPresenceData, CollabTelepointerPayload, ChannelEvent, PresenceData, PresencePayload, StepJson, TelepointerPayload } from '../types';
 import { GetUserType } from './participants-helper';
 import { ParticipantsState } from './participants-state';
 /**
@@ -19,9 +18,11 @@ export declare class ParticipantsService {
     private getUser;
     private channelBroadcast;
     private sendPresenceJoined;
+    private getPresenceData;
+    private setUserId;
     private participantUpdateTimeout;
     private presenceUpdateTimeout;
-    constructor(analyticsHelper: AnalyticsHelper | undefined, participantsState: ParticipantsState, emit: (evt: 'presence' | 'telepointer' | 'disconnected', data: CollabEventPresenceData | CollabEventTelepointerData | CollabEventDisconnectedData) => void, getUser: GetUserType, channelBroadcast: <K extends keyof ChannelEvent>(type: K, data: Omit<ChannelEvent[K], 'timestamp'>, callback?: Function) => void, sendPresenceJoined: () => void);
+    constructor(analyticsHelper: AnalyticsHelper | undefined, participantsState: ParticipantsState, emit: (evt: 'presence' | 'telepointer' | 'disconnected', data: CollabEventPresenceData | CollabTelepointerPayload | CollabEventDisconnectedData) => void, getUser: GetUserType, channelBroadcast: <K extends keyof ChannelEvent>(type: K, data: Omit<ChannelEvent[K], 'timestamp'>, callback?: Function) => void, sendPresenceJoined: () => void, getPresenceData: () => PresenceData, setUserId: (id: string) => void);
     /**
      * Carries out 3 things: 1) enriches the participant with user data, 2) updates the participantsState, 3) emits the presence event
      * @param payload Payload from incoming socket event

package/dist/types/participants/telepointers-helper.d.ts

@@ -1,4 +1,4 @@
-import type { AcknowledgementPayload, CollabEventTelepointerData, StepJson } from '../types';
+import type { AcknowledgementPayload, CollabTelepointerPayload, StepJson } from '../types';
 import { ProviderParticipant } from './participants-helper';
-export declare const telepointerFromStep: (participants: ProviderParticipant[], step: StepJson) => CollabEventTelepointerData | undefined;
+export declare const telepointerFromStep: (participants: ProviderParticipant[], step: StepJson) => CollabTelepointerPayload | undefined;
 export declare const telepointerCallback: (documentAri: string) => (response: AcknowledgementPayload) => void;

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

@@ -1,9 +1,8 @@
 import type { EditorState, Transaction } from 'prosemirror-state';
 import type { Step as ProseMirrorStep } from 'prosemirror-transform';
 import { Emitter } from '../emitter';
-import type { ResolvedEditorState } from '@atlaskit/editor-common/collab';
-import type { CollabEditProvider, CollabEvents, CollabEventTelepointerData, Config, Metadata } from '../types';
-import type { SyncUpErrorFunction } from '@atlaskit/editor-common/types';
+import type { CollabEditProvider, CollabEvents, CollabTelepointerPayload, Config, Metadata, ResolvedEditorState } from '../types';
+import type { SyncUpErrorFunction } from '../types';
 export declare const MAX_STEP_REJECTED_ERROR = 15;
 type BaseEvents = Pick<CollabEditProvider<CollabEvents>, 'setup' | 'send' | 'sendMessage'>;
 export declare class Provider extends Emitter<CollabEvents> implements BaseEvents {
@@ -34,6 +33,8 @@ export declare class Provider extends Emitter<CollabEvents> implements BaseEvent
     getStatePromiseResolve: (value: void | PromiseLike<void>) => void;
     constructor(config: Config);
     private initializeChannel;
+    private setUserId;
+    private getPresenceData;
     /**
      * Initialisation logic, called by Jira with a dummy getState function, deprecated in favour of the setup method which allows more configuration
      * @param {Function} getState Function that returns the editor state, used to retrieve collab-edit properties and to interact with prosemirror-collab
@@ -73,12 +74,12 @@ export declare class Provider extends Emitter<CollabEvents> implements BaseEvent
     /**
      * Send messages, such as telepointers, to NCS and other participants. Only used for telepointer data (text and node selections) in the editor and JWM. JWM does some weird serialisation stuff on the node selections.
      * Silently fails if an error occurs, since Presence isn't a critical functionality and self-restores over time.
-     * @param {CollabEventTelepointerData} data Data you want to send to NCS / the other participants
+     * @param {CollabTelepointerPayload} data Data you want to send to NCS / the other participants
      * @param {string} data.type Can only be 'telepointer' for now, we don't support anything else yet
      * @param {CollabSendableSelection} data.selection Object representing the selected element
      * @param {string} data.sessionId Identifier identifying the session
      */
-    sendMessage(data: CollabEventTelepointerData): void;
+    sendMessage(data: CollabTelepointerPayload): void;
     private onDisconnected;
     /**
      * "Destroy" the provider, disconnect it's connection to the back-end service and unsubscribe all event listeners on the provider.

package/dist/types/types.d.ts

@@ -1,14 +1,57 @@
 import type { Step } from 'prosemirror-transform';
 import type { EditorState, Transaction } from 'prosemirror-state';
-import type { CollabEventConnectionData, CollabEventInitData, CollabEventRemoteData, CollabEventPresenceData, CollabEventConnectingData, ResolvedEditorState } from '@atlaskit/editor-common/collab';
 import type { AnalyticsWebClient } from '@atlaskit/analytics-listeners';
 import type { Manager } from 'socket.io-client';
 import type { DisconnectReason } from './disconnected-reason-mapper';
 import type { InternalError } from './errors/error-types';
 import type { ProviderError } from './errors/error-types';
-import type { SyncUpErrorFunction } from '@atlaskit/editor-common/types';
 import { JSONDocNode } from '@atlaskit/editor-json-transformer';
 import { ProviderParticipant } from './participants/participants-helper';
+import AnalyticsHelper from './analytics/analytics-helper';
+export interface CollabParticipant {
+    lastActive: number;
+    sessionId: string;
+    avatar: string;
+    name: string;
+    cursorPos?: number;
+}
+export interface CollabEventInitData {
+    doc?: any;
+    json?: any;
+    version?: number;
+    sid?: string;
+    reserveCursor?: boolean;
+}
+export interface CollabEventRemoteData {
+    json?: any;
+    newState?: EditorState;
+    userIds?: (number | string)[];
+}
+export interface CollabEventConnectionData {
+    sid: string;
+    initial: boolean;
+}
+export interface CollabEventConnectingData {
+    initial: boolean;
+}
+export interface CollabEventDisconnectedData {
+    sid: string;
+    reason: 'CLIENT_DISCONNECT' | 'SERVER_DISCONNECT' | 'SOCKET_CLOSED' | 'SOCKET_ERROR' | 'SOCKET_TIMEOUT' | 'UNKNOWN_DISCONNECT';
+}
+export interface CollabEventPresenceData {
+    joined?: CollabParticipant[];
+    left?: {
+        sessionId: string;
+    }[];
+}
+export interface CollabEventLocalStepData {
+    steps: Array<Step>;
+}
+export type ResolvedEditorState<T = any> = {
+    content: JSONDocNode | T;
+    title: string | null;
+    stepVersion: number;
+};
 export interface Storage {
     get(key: string): Promise<string>;
     set(key: string, value: string): Promise<void>;
@@ -75,10 +118,6 @@ export interface CollabDisconnectedPayload {
     reason: DisconnectReason;
     sid: string;
 }
-/**
- * @deprecated Use ProviderError type instead
- */
-export type CollabErrorPayload = ProviderError;
 export interface CollabInitPayload extends CollabEventInitData {
     doc: any;
     version: number;
@@ -105,7 +144,7 @@ export interface CollabEvents {
     telepointer: CollabTelepointerPayload;
     presence: CollabPresencePayload;
     'local-steps': CollabLocalStepsPayload;
-    error: CollabErrorPayload;
+    error: ProviderError;
     entity: any;
     connecting: CollabConnectingPayload;
 }
@@ -129,10 +168,12 @@ export type BroadcastIncomingPayload = {
     timestamp?: number;
     data: PresencePayload | TelepointerPayload | StepsPayload | any;
 };
-export type PresencePayload = {
+export type PresenceData = {
     sessionId: string;
     userId: string | undefined;
     clientId: number | string;
+};
+export type PresencePayload = PresenceData & {
     timestamp: number;
 };
 export type TelepointerPayload = PresencePayload & {
@@ -232,6 +273,7 @@ export interface CatchupOptions {
     applyLocalSteps: (steps: Step[]) => void;
     updateDocument: ({ doc, version, metadata, reserveCursor, }: CollabInitPayload) => void;
     updateMetadata: (metadata: Metadata | undefined) => void;
+    analyticsHelper: AnalyticsHelper | undefined;
 }
 export type ProductInformation = {
     product: string;
@@ -262,4 +304,12 @@ export interface CollabEditProvider<Events extends CollabEvents = CollabEvents>
     } & Events[K]): void;
     getFinalAcknowledgedState(): Promise<ResolvedEditorState>;
 }
+export type NewCollabSyncUpErrorAttributes = {
+    lengthOfUnconfirmedSteps?: number;
+    tries: number;
+    maxRetries: number;
+    clientId?: number | string;
+    version: number;
+};
+export type SyncUpErrorFunction = (attributes: NewCollabSyncUpErrorAttributes) => void;
 export {};

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

@@ -41,7 +41,7 @@ export declare class Channel extends Emitter<ChannelEvent> {
      * @throws {NotConnectedError} Channel not connected
      */
     sendMetadata: (metadata: Metadata) => void;
-    sendPresenceJoined(): void;
+    sendPresenceJoined: () => void;
     onOnlineHandler: () => void;
     disconnect(): void;
 }

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

@@ -1,11 +1,10 @@
 /// <reference types="lodash" />
 import AnalyticsHelper from '../analytics/analytics-helper';
-import { CatchupResponse, ChannelEvent, CollabEvents, CollabInitPayload, StepsPayload } from '../types';
+import { CatchupResponse, ChannelEvent, CollabEvents, CollabInitPayload, ResolvedEditorState, StepsPayload } from '../types';
 import type { Step as ProseMirrorStep } from 'prosemirror-transform';
 import type { MetadataService } from '../metadata/metadata-service';
-import { SyncUpErrorFunction } from '@atlaskit/editor-common/types';
+import { SyncUpErrorFunction } from '../types';
 import type { EditorState, Transaction } from 'prosemirror-state';
-import { ResolvedEditorState } from '@atlaskit/editor-common/collab';
 import { ParticipantsService } from '../participants/participants-service';
 import type { InternalError } from '../errors/error-types';
 export declare class DocumentService {

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

@@ -10,7 +10,8 @@ export declare enum EVENT_ACTION {
     ERROR = "error",
     PUBLISH_PAGE = "publishPage",
     GET_CURRENT_STATE = "getCurrentState",
-    INVALIDATE_TOKEN = "invalidateToken"
+    INVALIDATE_TOKEN = "invalidateToken",
+    DROPPED_STEPS = "droppedStepInCatchup"
 }
 export declare enum EVENT_STATUS {
     SUCCESS = "SUCCESS",
@@ -110,6 +111,13 @@ type CatchUpFailureAnalyticsEvent = {
         latency?: number;
     };
 };
+type CatchUpDroppedStepsEvent = {
+    eventAction: EVENT_ACTION.DROPPED_STEPS;
+    attributes: {
+        documentAri: string;
+        numOfDroppedSteps: number;
+    };
+};
 type DocumentInitSuccessAnalyticsEvent = {
     eventAction: EVENT_ACTION.DOCUMENT_INIT;
     attributes: {
@@ -177,7 +185,7 @@ type GetCurrentStateFailureAnalyticsEvent = {
         latency?: number;
     };
 };
-export type ActionAnalyticsEvent = AddStepsSuccessAnalyticsEvent | AddStepsFailureAnalyticsEvent | ReInitDocFailAnalyticsEvent | ReInitDocSuccessAnalyticsEvent | ConnectionSuccessAnalyticsEvent | ConnectionFailureAnalyticsEvent | CatchUpSuccessAnalyticsEvent | CatchUpFailureAnalyticsEvent | DocumentInitSuccessAnalyticsEvent | UpdateParticipantsSuccessAnalyticsEvent | CommitUnconfirmedStepsSuccessAnalyticsEvent | CommitUnconfirmedStepsFailureAnalyticsEvent | PublishPageSuccessAnalyticsEvent | PublishPageFailureAnalyticsEvent | GetCurrentStateSuccessAnalyticsEvent | GetCurrentStateFailureAnalyticsEvent | InvalidateTokenAnalyticsEvent;
-export declare const ACK_MAX_TRY = 30;
+export type ActionAnalyticsEvent = AddStepsSuccessAnalyticsEvent | AddStepsFailureAnalyticsEvent | ReInitDocFailAnalyticsEvent | ReInitDocSuccessAnalyticsEvent | ConnectionSuccessAnalyticsEvent | ConnectionFailureAnalyticsEvent | CatchUpSuccessAnalyticsEvent | CatchUpFailureAnalyticsEvent | DocumentInitSuccessAnalyticsEvent | UpdateParticipantsSuccessAnalyticsEvent | CommitUnconfirmedStepsSuccessAnalyticsEvent | CommitUnconfirmedStepsFailureAnalyticsEvent | PublishPageSuccessAnalyticsEvent | PublishPageFailureAnalyticsEvent | GetCurrentStateSuccessAnalyticsEvent | GetCurrentStateFailureAnalyticsEvent | InvalidateTokenAnalyticsEvent | CatchUpDroppedStepsEvent;
+export declare const ACK_MAX_TRY = 60;
 export declare const CONFLUENCE = "confluence";
 export {};

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

@@ -1,4 +1,4 @@
 export { Provider } from './provider';
-export type { CollabConnectedPayload, CollabDisconnectedPayload, CollabErrorPayload, CollabInitPayload, CollabDataPayload, CollabTelepointerPayload, CollabPresencePayload, CollabMetadataPayload, CollabLocalStepsPayload, CollabEvents, CollabSendableSelection, CollabEditProvider, Socket, } from './types';
+export type { CollabParticipant, CollabEventInitData, CollabEventRemoteData, CollabEventConnectionData, CollabEventConnectingData, CollabEventDisconnectedData, CollabEventPresenceData, CollabEventTelepointerData, CollabEventLocalStepData, ResolvedEditorState, CollabConnectedPayload, CollabDisconnectedPayload, CollabInitPayload, CollabDataPayload, CollabTelepointerPayload, CollabPresencePayload, CollabMetadataPayload, CollabLocalStepsPayload, CollabEvents, CollabSendableSelection, CollabEditProvider, SyncUpErrorFunction, NewCollabSyncUpErrorAttributes, Socket, } from './types';
 export type { ProviderError } from './errors/error-types';
 export { PROVIDER_ERROR_CODE } from './errors/error-types';

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

@@ -1,5 +1,4 @@
-import type { CollabParticipant } from '@atlaskit/editor-common/collab';
-import type { PresencePayload } from '../types';
+import type { CollabParticipant, PresencePayload } from '../types';
 export declare const PARTICIPANT_UPDATE_INTERVAL: number;
 export type ProviderParticipant = CollabParticipant & {
     userId: string;
@@ -7,6 +6,8 @@ export type ProviderParticipant = CollabParticipant & {
 };
 export type ParticipantsMap = Map<string, ProviderParticipant>;
 export type GetUserType = ((userId: string) => Promise<Pick<ProviderParticipant, 'name' | 'avatar' | 'userId'>>) | undefined;
-export declare const createParticipantFromPayload: (payload: PresencePayload & {
+export declare const createParticipantFromPayload: (payload: import("../types").PresenceData & {
+    timestamp: number;
+} & {
     userId: string;
 }, getUser: GetUserType) => Promise<ProviderParticipant>;

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

@@ -1,6 +1,5 @@
-import type { CollabEventPresenceData, CollabEventDisconnectedData } from '@atlaskit/editor-common/collab';
 import AnalyticsHelper from '../analytics/analytics-helper';
-import type { ChannelEvent, CollabEventTelepointerData, PresencePayload, StepJson, TelepointerPayload } from '../types';
+import type { CollabEventDisconnectedData, CollabEventPresenceData, CollabTelepointerPayload, ChannelEvent, PresenceData, PresencePayload, StepJson, TelepointerPayload } from '../types';
 import { GetUserType } from './participants-helper';
 import { ParticipantsState } from './participants-state';
 /**
@@ -19,9 +18,11 @@ export declare class ParticipantsService {
     private getUser;
     private channelBroadcast;
     private sendPresenceJoined;
+    private getPresenceData;
+    private setUserId;
     private participantUpdateTimeout;
     private presenceUpdateTimeout;
-    constructor(analyticsHelper: AnalyticsHelper | undefined, participantsState: ParticipantsState, emit: (evt: 'presence' | 'telepointer' | 'disconnected', data: CollabEventPresenceData | CollabEventTelepointerData | CollabEventDisconnectedData) => void, getUser: GetUserType, channelBroadcast: <K extends keyof ChannelEvent>(type: K, data: Omit<ChannelEvent[K], 'timestamp'>, callback?: Function) => void, sendPresenceJoined: () => void);
+    constructor(analyticsHelper: AnalyticsHelper | undefined, participantsState: ParticipantsState, emit: (evt: 'presence' | 'telepointer' | 'disconnected', data: CollabEventPresenceData | CollabTelepointerPayload | CollabEventDisconnectedData) => void, getUser: GetUserType, channelBroadcast: <K extends keyof ChannelEvent>(type: K, data: Omit<ChannelEvent[K], 'timestamp'>, callback?: Function) => void, sendPresenceJoined: () => void, getPresenceData: () => PresenceData, setUserId: (id: string) => void);
     /**
      * Carries out 3 things: 1) enriches the participant with user data, 2) updates the participantsState, 3) emits the presence event
      * @param payload Payload from incoming socket event

package/dist/types-ts4.5/participants/telepointers-helper.d.ts

@@ -1,4 +1,4 @@
-import type { AcknowledgementPayload, CollabEventTelepointerData, StepJson } from '../types';
+import type { AcknowledgementPayload, CollabTelepointerPayload, StepJson } from '../types';
 import { ProviderParticipant } from './participants-helper';
-export declare const telepointerFromStep: (participants: ProviderParticipant[], step: StepJson) => CollabEventTelepointerData | undefined;
+export declare const telepointerFromStep: (participants: ProviderParticipant[], step: StepJson) => CollabTelepointerPayload | undefined;
 export declare const telepointerCallback: (documentAri: string) => (response: AcknowledgementPayload) => void;

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

@@ -1,9 +1,8 @@
 import type { EditorState, Transaction } from 'prosemirror-state';
 import type { Step as ProseMirrorStep } from 'prosemirror-transform';
 import { Emitter } from '../emitter';
-import type { ResolvedEditorState } from '@atlaskit/editor-common/collab';
-import type { CollabEditProvider, CollabEvents, CollabEventTelepointerData, Config, Metadata } from '../types';
-import type { SyncUpErrorFunction } from '@atlaskit/editor-common/types';
+import type { CollabEditProvider, CollabEvents, CollabTelepointerPayload, Config, Metadata, ResolvedEditorState } from '../types';
+import type { SyncUpErrorFunction } from '../types';
 export declare const MAX_STEP_REJECTED_ERROR = 15;
 type BaseEvents = Pick<CollabEditProvider<CollabEvents>, 'setup' | 'send' | 'sendMessage'>;
 export declare class Provider extends Emitter<CollabEvents> implements BaseEvents {
@@ -34,6 +33,8 @@ export declare class Provider extends Emitter<CollabEvents> implements BaseEvent
     getStatePromiseResolve: (value: void | PromiseLike<void>) => void;
     constructor(config: Config);
     private initializeChannel;
+    private setUserId;
+    private getPresenceData;
     /**
      * Initialisation logic, called by Jira with a dummy getState function, deprecated in favour of the setup method which allows more configuration
      * @param {Function} getState Function that returns the editor state, used to retrieve collab-edit properties and to interact with prosemirror-collab
@@ -73,12 +74,12 @@ export declare class Provider extends Emitter<CollabEvents> implements BaseEvent
     /**
      * Send messages, such as telepointers, to NCS and other participants. Only used for telepointer data (text and node selections) in the editor and JWM. JWM does some weird serialisation stuff on the node selections.
      * Silently fails if an error occurs, since Presence isn't a critical functionality and self-restores over time.
-     * @param {CollabEventTelepointerData} data Data you want to send to NCS / the other participants
+     * @param {CollabTelepointerPayload} data Data you want to send to NCS / the other participants
      * @param {string} data.type Can only be 'telepointer' for now, we don't support anything else yet
      * @param {CollabSendableSelection} data.selection Object representing the selected element
      * @param {string} data.sessionId Identifier identifying the session
      */
-    sendMessage(data: CollabEventTelepointerData): void;
+    sendMessage(data: CollabTelepointerPayload): void;
     private onDisconnected;
     /**
      * "Destroy" the provider, disconnect it's connection to the back-end service and unsubscribe all event listeners on the provider.

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

@@ -1,14 +1,57 @@
 import type { Step } from 'prosemirror-transform';
 import type { EditorState, Transaction } from 'prosemirror-state';
-import type { CollabEventConnectionData, CollabEventInitData, CollabEventRemoteData, CollabEventPresenceData, CollabEventConnectingData, ResolvedEditorState } from '@atlaskit/editor-common/collab';
 import type { AnalyticsWebClient } from '@atlaskit/analytics-listeners';
 import type { Manager } from 'socket.io-client';
 import type { DisconnectReason } from './disconnected-reason-mapper';
 import type { InternalError } from './errors/error-types';
 import type { ProviderError } from './errors/error-types';
-import type { SyncUpErrorFunction } from '@atlaskit/editor-common/types';
 import { JSONDocNode } from '@atlaskit/editor-json-transformer';
 import { ProviderParticipant } from './participants/participants-helper';
+import AnalyticsHelper from './analytics/analytics-helper';
+export interface CollabParticipant {
+    lastActive: number;
+    sessionId: string;
+    avatar: string;
+    name: string;
+    cursorPos?: number;
+}
+export interface CollabEventInitData {
+    doc?: any;
+    json?: any;
+    version?: number;
+    sid?: string;
+    reserveCursor?: boolean;
+}
+export interface CollabEventRemoteData {
+    json?: any;
+    newState?: EditorState;
+    userIds?: (number | string)[];
+}
+export interface CollabEventConnectionData {
+    sid: string;
+    initial: boolean;
+}
+export interface CollabEventConnectingData {
+    initial: boolean;
+}
+export interface CollabEventDisconnectedData {
+    sid: string;
+    reason: 'CLIENT_DISCONNECT' | 'SERVER_DISCONNECT' | 'SOCKET_CLOSED' | 'SOCKET_ERROR' | 'SOCKET_TIMEOUT' | 'UNKNOWN_DISCONNECT';
+}
+export interface CollabEventPresenceData {
+    joined?: CollabParticipant[];
+    left?: {
+        sessionId: string;
+    }[];
+}
+export interface CollabEventLocalStepData {
+    steps: Array<Step>;
+}
+export type ResolvedEditorState<T = any> = {
+    content: JSONDocNode | T;
+    title: string | null;
+    stepVersion: number;
+};
 export interface Storage {
     get(key: string): Promise<string>;
     set(key: string, value: string): Promise<void>;
@@ -75,10 +118,6 @@ export interface CollabDisconnectedPayload {
     reason: DisconnectReason;
     sid: string;
 }
-/**
- * @deprecated Use ProviderError type instead
- */
-export type CollabErrorPayload = ProviderError;
 export interface CollabInitPayload extends CollabEventInitData {
     doc: any;
     version: number;
@@ -105,7 +144,7 @@ export interface CollabEvents {
     telepointer: CollabTelepointerPayload;
     presence: CollabPresencePayload;
     'local-steps': CollabLocalStepsPayload;
-    error: CollabErrorPayload;
+    error: ProviderError;
     entity: any;
     connecting: CollabConnectingPayload;
 }
@@ -129,10 +168,12 @@ export type BroadcastIncomingPayload = {
     timestamp?: number;
     data: PresencePayload | TelepointerPayload | StepsPayload | any;
 };
-export type PresencePayload = {
+export type PresenceData = {
     sessionId: string;
     userId: string | undefined;
     clientId: number | string;
+};
+export type PresencePayload = PresenceData & {
     timestamp: number;
 };
 export type TelepointerPayload = PresencePayload & {
@@ -232,6 +273,7 @@ export interface CatchupOptions {
     applyLocalSteps: (steps: Step[]) => void;
     updateDocument: ({ doc, version, metadata, reserveCursor, }: CollabInitPayload) => void;
     updateMetadata: (metadata: Metadata | undefined) => void;
+    analyticsHelper: AnalyticsHelper | undefined;
 }
 export type ProductInformation = {
     product: string;
@@ -262,4 +304,12 @@ export interface CollabEditProvider<Events extends CollabEvents = CollabEvents>
     } & Events[K]): void;
     getFinalAcknowledgedState(): Promise<ResolvedEditorState>;
 }
+export type NewCollabSyncUpErrorAttributes = {
+    lengthOfUnconfirmedSteps?: number;
+    tries: number;
+    maxRetries: number;
+    clientId?: number | string;
+    version: number;
+};
+export type SyncUpErrorFunction = (attributes: NewCollabSyncUpErrorAttributes) => void;
 export {};