@atlaskit/collab-provider 8.9.1 → 9.0.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/collab-provider",
-  "version": "8.9.1",
+  "version": "9.0.1",
   "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.5.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)
 ```