@atlaskit/collab-provider 8.9.0 → 9.0.0

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @atlaskit/collab-provider
 
+## 9.0.0
+
+### Major Changes
+
+- [`b7086232a7c`](https://bitbucket.org/atlassian/atlassian-frontend/commits/b7086232a7c) - ESS-3135: move collab provider types into @atlaskit/collab-provider
+
+## 8.9.1
+
+### Patch Changes
+
+- [`9d00501a414`](https://bitbucket.org/atlassian/atlassian-frontend/commits/9d00501a414) - Ensure legacy types are published for TS 4.5-4.8
+
 ## 8.9.0
 
 ### Minor Changes

package/dist/cjs/provider/index.js

@@ -332,7 +332,7 @@ 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/cjs/types.js

@@ -4,10 +4,9 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.AcknowledgementResponseTypes = void 0;
+// types from editor common
+// types from editor common end
 // Initial draft
-/**
- * @deprecated Use ProviderError type instead
- */
 // Channel
 /**
  * @description Incoming payload type from the `broadcast` route in NCS

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

package/dist/es2019/provider/index.js

@@ -275,7 +275,7 @@ export class Provider extends 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/es2019/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/es2019/version-wrapper.js

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

package/dist/esm/provider/index.js

@@ -324,7 +324,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.0";
+export var version = "9.0.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": "8.9.0",
+	"version": "9.0.0",
 	"sideEffects": false
 }

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/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;

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, PresencePayload, StepJson, TelepointerPayload } from '../types';
 import { GetUserType } from './participants-helper';
 import { ParticipantsState } from './participants-state';
 /**
@@ -21,7 +20,7 @@ export declare class ParticipantsService {
     private sendPresenceJoined;
     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);
     /**
      * 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 {
@@ -73,12 +72,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,56 @@
 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';
+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 +117,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 +143,7 @@ export interface CollabEvents {
     telepointer: CollabTelepointerPayload;
     presence: CollabPresencePayload;
     'local-steps': CollabLocalStepsPayload;
-    error: CollabErrorPayload;
+    error: ProviderError;
     entity: any;
     connecting: CollabConnectingPayload;
 }
@@ -262,4 +300,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/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/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;

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, PresencePayload, StepJson, TelepointerPayload } from '../types';
 import { GetUserType } from './participants-helper';
 import { ParticipantsState } from './participants-state';
 /**
@@ -21,7 +20,7 @@ export declare class ParticipantsService {
     private sendPresenceJoined;
     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);
     /**
      * 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 {
@@ -73,12 +72,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,56 @@
 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';
+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 +117,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 +143,7 @@ export interface CollabEvents {
     telepointer: CollabTelepointerPayload;
     presence: CollabPresencePayload;
     'local-steps': CollabLocalStepsPayload;
-    error: CollabErrorPayload;
+    error: ProviderError;
     entity: any;
     connecting: CollabConnectingPayload;
 }
@@ -262,4 +300,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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/collab-provider",
-  "version": "8.9.0",
+  "version": "9.0.0",
   "description": "A provider for collaborative editing.",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
@@ -36,7 +36,6 @@
   "dependencies": {
     "@atlaskit/analytics-gas-types": "^5.1.0",
     "@atlaskit/analytics-listeners": "^8.7.0",
-    "@atlaskit/editor-common": "^74.1.0",
     "@atlaskit/editor-json-transformer": "^8.9.0",
     "@atlaskit/prosemirror-collab": "^0.2.0",
     "@atlaskit/ufo": "^0.2.0",
@@ -62,9 +61,9 @@
     }
   },
   "devDependencies": {
-    "@atlaskit/adf-schema": "^25.6.0",
+    "@atlaskit/adf-schema": "^25.7.0",
     "@atlaskit/analytics-listeners": "^8.7.0",
-    "@atlaskit/editor-test-helpers": "^18.3.0",
+    "@atlaskit/editor-test-helpers": "^18.4.0",
     "@atlassian/atlassian-frontend-prettier-config-1.0.1": "npm:@atlassian/atlassian-frontend-prettier-config@1.0.1",
     "@types/prosemirror-model": "^1.11.0",
     "@types/prosemirror-state": "^1.2.0",

package/report.api.md

@@ -16,18 +16,10 @@
 
 ```ts
 import type { AnalyticsWebClient } from '@atlaskit/analytics-listeners';
-import type { CollabEventConnectingData } from '@atlaskit/editor-common/collab';
-import type { CollabEventConnectionData } from '@atlaskit/editor-common/collab';
-import type { CollabEventInitData } from '@atlaskit/editor-common/collab';
-import type { CollabEventPresenceData } from '@atlaskit/editor-common/collab';
-import type { CollabEventRemoteData } from '@atlaskit/editor-common/collab';
-import type { CollabParticipant } from '@atlaskit/editor-common/collab';
 import type { EditorState } from 'prosemirror-state';
 import { JSONDocNode } from '@atlaskit/editor-json-transformer';
 import type { Manager } from 'socket.io-client';
-import type { ResolvedEditorState } from '@atlaskit/editor-common/collab';
 import type { Step } from 'prosemirror-transform';
-import type { SyncUpErrorFunction } from '@atlaskit/editor-common/types';
 import type { Transaction } from 'prosemirror-state';
 
 // @public (undocumented)
@@ -92,8 +84,73 @@ export interface CollabEditProvider<
   unsubscribeAll(evt: keyof Events): this;
 }
 
-// @public @deprecated (undocumented)
-export type CollabErrorPayload = ProviderError;
+// @public (undocumented)
+export interface CollabEventConnectingData {
+  // (undocumented)
+  initial: boolean;
+}
+
+// @public (undocumented)
+export interface CollabEventConnectionData {
+  // (undocumented)
+  initial: boolean;
+  // (undocumented)
+  sid: string;
+}
+
+// @public (undocumented)
+export interface CollabEventDisconnectedData {
+  // (undocumented)
+  reason:
+    | 'CLIENT_DISCONNECT'
+    | 'SERVER_DISCONNECT'
+    | 'SOCKET_CLOSED'
+    | 'SOCKET_ERROR'
+    | 'SOCKET_TIMEOUT'
+    | 'UNKNOWN_DISCONNECT';
+  // (undocumented)
+  sid: string;
+}
+
+// @public (undocumented)
+export interface CollabEventInitData {
+  // (undocumented)
+  doc?: any;
+  // (undocumented)
+  json?: any;
+  // (undocumented)
+  reserveCursor?: boolean;
+  // (undocumented)
+  sid?: string;
+  // (undocumented)
+  version?: number;
+}
+
+// @public (undocumented)
+export interface CollabEventLocalStepData {
+  // (undocumented)
+  steps: Array<Step>;
+}
+
+// @public (undocumented)
+export interface CollabEventPresenceData {
+  // (undocumented)
+  joined?: CollabParticipant[];
+  // (undocumented)
+  left?: {
+    sessionId: string;
+  }[];
+}
+
+// @public (undocumented)
+export interface CollabEventRemoteData {
+  // (undocumented)
+  json?: any;
+  // (undocumented)
+  newState?: EditorState;
+  // (undocumented)
+  userIds?: (number | string)[];
+}
 
 // @public (undocumented)
 export interface CollabEvents {
@@ -112,7 +169,7 @@ export interface CollabEvents {
   // (undocumented)
   entity: any;
   // (undocumented)
-  error: CollabErrorPayload;
+  error: ProviderError;
   // (undocumented)
   init: CollabInitPayload;
   // (undocumented)
@@ -122,7 +179,7 @@ export interface CollabEvents {
 }
 
 // @public (undocumented)
-interface CollabEventTelepointerData {
+export interface CollabEventTelepointerData {
   // (undocumented)
   selection: CollabSendableSelection;
   // (undocumented)
@@ -151,6 +208,20 @@ export type CollabLocalStepsPayload = {
 // @public (undocumented)
 export type CollabMetadataPayload = Metadata_2;
 
+// @public (undocumented)
+export interface CollabParticipant {
+  // (undocumented)
+  avatar: string;
+  // (undocumented)
+  cursorPos?: number;
+  // (undocumented)
+  lastActive: number;
+  // (undocumented)
+  name: string;
+  // (undocumented)
+  sessionId: string;
+}
+
 // @public (undocumented)
 export type CollabPresencePayload = CollabEventPresenceData;
 
@@ -359,6 +430,15 @@ type NetworkIssue = {
   status?: number;
 };
 
+// @public (undocumented)
+export type NewCollabSyncUpErrorAttributes = {
+  lengthOfUnconfirmedSteps?: number;
+  tries: number;
+  maxRetries: number;
+  clientId?: number | string;
+  version: number;
+};
+
 // @public (undocumented)
 type NodeJson = {
   type: string;
@@ -396,7 +476,7 @@ export class Provider extends Emitter<CollabEvents> implements BaseEvents {
     _oldState: EditorState | null,
     newState: EditorState,
   ): void;
-  sendMessage(data: CollabEventTelepointerData): void;
+  sendMessage(data: CollabTelepointerPayload): void;
   // @deprecated
   setEditorWidth(editorWidth: string, broadcast?: boolean): void;
   setMetadata(metadata: Metadata_2): void;
@@ -456,6 +536,13 @@ type ProviderParticipant = CollabParticipant & {
   clientId: number | string;
 };
 
+// @public (undocumented)
+export type ResolvedEditorState<T = any> = {
+  content: JSONDocNode | T;
+  title: null | string;
+  stepVersion: number;
+};
+
 // @public (undocumented)
 interface SimpleEventEmitter {
   // (undocumented)
@@ -505,6 +592,11 @@ interface Storage_2 {
   set(key: string, value: string): Promise<void>;
 }
 
+// @public (undocumented)
+export type SyncUpErrorFunction = (
+  attributes: NewCollabSyncUpErrorAttributes,
+) => void;
+
 // (No @packageDocumentation comment for this package)
 ```