@atlaskit/collab-provider 7.1.1 → 7.1.5

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

@@ -1,57 +1,11 @@
 import { EditorState, Transaction } from 'prosemirror-state';
-import { Step } from 'prosemirror-transform';
 import { Emitter } from '../emitter';
-import { Metadata, StepJson } from '../channel';
-import { CollabEditProvider, CollabEventTelepointerData as EditorCollabTelepointerData, CollabEventConnectionData as EditorCollabConnetedData, CollabEventInitData as EditorCollabInitData, CollabEventRemoteData as EditorCollabData, CollabEventPresenceData as EditorCollabPresenceData } from '@atlaskit/editor-common/collab';
-import { Config } from '../types';
-import { DisconnectReason } from '../disconnected-reason-mapper';
+import { CollabEditProvider, ResolvedEditorState } from '@atlaskit/editor-common/collab';
+import type { Config, Metadata, CollabEvents } from '../types';
+import { SyncUpErrorFunction } from '@atlaskit/editor-common/types';
 export declare const CATCHUP_THROTTLE: number;
 export declare const MAX_STEP_REJECTED_ERROR = 15;
-export declare type CollabConnectedPayload = EditorCollabConnetedData;
-export interface CollabDisconnectedPayload {
-    reason: DisconnectReason;
-    sid: string;
-}
-export interface CollabErrorPayload {
-    status: number;
-    code: string;
-    message: string;
-}
-export interface CollabInitPayload extends EditorCollabInitData {
-    doc: any;
-    version: number;
-    userId?: string;
-    metadata?: Metadata;
-}
-export interface CollabDataPayload extends EditorCollabData {
-    version: number;
-    json: StepJson[];
-    userIds: string[];
-}
-export declare type CollabTelepointerPayload = EditorCollabTelepointerData;
-export declare type CollabPresencePayload = EditorCollabPresenceData;
-export declare type CollabMetadataPayload = Metadata;
-export declare type CollabLocalStepsPayload = {
-    steps: Step[];
-};
-export interface CollabEvents {
-    'metadata:changed': CollabMetadataPayload;
-    init: CollabInitPayload;
-    connected: CollabConnectedPayload;
-    disconnected: CollabDisconnectedPayload;
-    data: CollabDataPayload;
-    telepointer: CollabTelepointerPayload;
-    presence: CollabPresencePayload;
-    'local-steps': CollabLocalStepsPayload;
-    error: CollabErrorPayload;
-    entity: any;
-}
-declare type EditorStateGetter = () => EditorState;
-declare type InitializeOptions = {
-    getState: EditorStateGetter;
-    clientId: string;
-};
-declare type BaseEvents = Pick<CollabEditProvider<CollabEvents>, 'initialize' | 'send' | 'sendMessage'>;
+declare type BaseEvents = Pick<CollabEditProvider<CollabEvents>, 'setup' | 'send' | 'sendMessage'>;
 export declare class Provider extends Emitter<CollabEvents> implements BaseEvents {
     private participants;
     private channel;
@@ -60,6 +14,8 @@ export declare class Provider extends Emitter<CollabEvents> implements BaseEvent
     private metadata;
     private stepRejectCounter;
     private analyticsClient?;
+    private isChannelInitialized;
+    private onSyncUpError?;
     private sessionId?;
     private clientId?;
     private userId?;
@@ -67,12 +23,16 @@ export declare class Provider extends Emitter<CollabEvents> implements BaseEvent
     private presenceUpdateTimeout?;
     private disconnectedAt?;
     constructor(config: Config);
+    private initializeChannel;
     /**
      * Called by collab plugin in editor when it's ready to
      * initialize a collab session.
      */
-    initialize(getState: EditorStateGetter): this;
-    initialize(options: InitializeOptions): this;
+    initialize(getState: () => EditorState): this;
+    setup({ getState, onSyncUpError, }: {
+        getState: () => EditorState;
+        onSyncUpError?: SyncUpErrorFunction;
+    }): this;
     /**
      * We can use this function to throttle/delay
      * Any send steps operation
@@ -155,18 +115,7 @@ export declare class Provider extends Emitter<CollabEvents> implements BaseEvent
     setTitle(title: string, broadcast?: boolean): void;
     setEditorWidth(editorWidth: string, broadcast?: boolean): void;
     setMetadata(metadata: Metadata): void;
-    /**
-     * Get latest state.
-     *
-     * NOTE: Should this actually convert to ADF instead?
-     */
-    getFinalAcknowledgedState(): Promise<{
-        content: {
-            [key: string]: any;
-        };
-        title: string | number | boolean;
-        stepVersion: number;
-    }>;
+    getFinalAcknowledgedState: () => Promise<ResolvedEditorState>;
     /**
      * Unsubscribe from all events emitted by this provider.
      */

package/dist/types/types.d.ts

@@ -1,6 +1,9 @@
-import { CollabParticipant } from '@atlaskit/editor-common/collab';
-import { AnalyticsWebClient } from '@atlaskit/analytics-listeners';
-import { Manager } from 'socket.io-client';
+import type { Transaction } from 'prosemirror-state';
+import type { Step } from 'prosemirror-transform';
+import type { CollabParticipant, CollabEventTelepointerData as EditorCollabTelepointerData, CollabEventConnectionData as EditorCollabConnetedData, CollabEventInitData as EditorCollabInitData, CollabEventRemoteData as EditorCollabData, CollabEventPresenceData as EditorCollabPresenceData } 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';
 export interface Storage {
     get(key: string): Promise<string>;
     set(key: string, value: string): Promise<void>;
@@ -33,4 +36,125 @@ export declare type EventHandler = () => void;
 export interface Lifecycle {
     on(event: LifecycleEvents, handler: EventHandler): void;
 }
+export declare type CollabConnectedPayload = EditorCollabConnetedData;
+export interface CollabDisconnectedPayload {
+    reason: DisconnectReason;
+    sid: string;
+}
+export interface CollabErrorPayload {
+    status: number;
+    code: string;
+    message: string;
+}
+export interface CollabInitPayload extends EditorCollabInitData {
+    doc: any;
+    version: number;
+    userId?: string;
+    metadata?: Metadata;
+}
+export interface CollabDataPayload extends EditorCollabData {
+    version: number;
+    json: StepJson[];
+    userIds: string[];
+}
+export declare type CollabTelepointerPayload = EditorCollabTelepointerData;
+export declare type CollabPresencePayload = EditorCollabPresenceData;
+export declare type CollabMetadataPayload = Metadata;
+export declare type CollabLocalStepsPayload = {
+    steps: Step[];
+};
+export interface CollabEvents {
+    'metadata:changed': CollabMetadataPayload;
+    init: CollabInitPayload;
+    connected: CollabConnectedPayload;
+    disconnected: CollabDisconnectedPayload;
+    data: CollabDataPayload;
+    telepointer: CollabTelepointerPayload;
+    presence: CollabPresencePayload;
+    'local-steps': CollabLocalStepsPayload;
+    error: CollabErrorPayload;
+    entity: any;
+}
+export interface Metadata {
+    [key: string]: string | number | boolean;
+}
+export declare type InitPayload = {
+    doc: any;
+    version: number;
+    userId?: string;
+    metadata?: Metadata;
+};
+export declare type PresencePayload = {
+    sessionId: string;
+    userId: string;
+    clientId: string;
+    timestamp: number;
+};
+export declare type TelepointerPayload = PresencePayload & {
+    selection: {
+        type: 'textSelection' | 'nodeSelection';
+        anchor: number;
+        head: number;
+    };
+};
+export declare type StepJson = {
+    from?: number;
+    to?: number;
+    stepType?: string;
+    clientId: string;
+    userId: string;
+};
+export declare type StepsPayload = {
+    version: number;
+    steps: StepJson[];
+};
+export declare type ErrorPayload = {
+    message: string;
+    data?: {
+        status: number;
+        code?: string;
+        meta?: string;
+    };
+};
+export declare type ChannelEvent = {
+    connected: {
+        sid: string;
+        initialized: boolean;
+    };
+    init: InitPayload;
+    reconnected: null;
+    'presence:joined': PresencePayload;
+    presence: PresencePayload;
+    'participant:left': PresencePayload;
+    'participant:telepointer': TelepointerPayload;
+    'participant:updated': PresencePayload;
+    'steps:commit': StepsPayload & {
+        userId: string;
+    };
+    'steps:added': StepsPayload;
+    'metadata:changed': Metadata;
+    error: ErrorPayload;
+    disconnect: {
+        reason: string;
+    };
+};
+export interface CatchupResponse {
+    doc?: string;
+    version?: number;
+    stepMaps?: any[];
+    metadata?: Metadata;
+}
+export interface CatchupOptions {
+    getCurrentPmVersion: () => number;
+    fetchCatchup: (fromVersion: number) => Promise<CatchupResponse>;
+    fitlerQueue: (condition: (stepsPayload: StepsPayload) => boolean) => void;
+    getUnconfirmedSteps: () => {
+        version: number;
+        steps: Step<any>[];
+        clientID: string | number;
+        origins: Transaction<any>[];
+    } | null | undefined;
+    updateDocumentWithMetadata: ({ doc, version, metadata, reserveCursor, }: CollabInitPayload) => void;
+    applyLocalsteps: (steps: Step[]) => void;
+}
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/collab-provider",
-  "version": "7.1.1",
+  "version": "7.1.5",
   "description": "A provider for collaborative editing.",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
@@ -22,12 +22,13 @@
   },
   "dependencies": {
     "@atlaskit/analytics-gas-types": "5.0.5",
-    "@atlaskit/analytics-listeners": "^8.0.0",
-    "@atlaskit/editor-common": "^61.0.0",
-    "@atlaskit/util-service-support": "^6.0.0",
+    "@atlaskit/analytics-listeners": "^8.2.0",
+    "@atlaskit/editor-common": "^64.0.0",
+    "@atlaskit/editor-json-transformer": "^8.7.0",
+    "@atlaskit/util-service-support": "^6.1.0",
     "@babel/runtime": "^7.0.0",
     "eventemitter2": "^4.1.0",
-    "lodash": "^4.17.15",
+    "lodash": "^4.17.21",
     "prosemirror-collab": "^1.2.2",
     "prosemirror-state": "1.3.4",
     "prosemirror-transform": "1.3.2",
@@ -43,7 +44,7 @@
     }
   },
   "devDependencies": {
-    "@atlaskit/editor-test-helpers": "^15.6.0",
+    "@atlaskit/editor-test-helpers": "^16.1.0",
     "@atlassian/atlassian-frontend-prettier-config-1.0.1": "npm:@atlassian/atlassian-frontend-prettier-config@1.0.1",
     "@types/prosemirror-collab": "^1.1.1",
     "@types/prosemirror-model": "^1.11.0",
@@ -52,4 +53,4 @@
     "typescript": "3.9.6"
   },
   "prettier": "@atlassian/atlassian-frontend-prettier-config-1.0.1"
-}
+}