@atlaskit/collab-provider 9.0.0 → 9.1.0

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

@@ -10,11 +10,15 @@ export declare enum EVENT_ACTION {
     ERROR = "error",
     PUBLISH_PAGE = "publishPage",
     GET_CURRENT_STATE = "getCurrentState",
-    INVALIDATE_TOKEN = "invalidateToken"
+    INVALIDATE_TOKEN = "invalidateToken",
+    SEND_STEPS_RETRY = "sendStepsRetry",
+    CATCHUP_AFTER_MAX_SEND_STEPS_RETRY = "catchupAfterMaxSendStepsRetry",
+    DROPPED_STEPS = "droppedStepInCatchup"
 }
 export declare enum EVENT_STATUS {
     SUCCESS = "SUCCESS",
-    FAILURE = "FAILURE"
+    FAILURE = "FAILURE",
+    INFO = "INFO"
 }
 export declare enum ADD_STEPS_TYPE {
     ACCEPTED = "ACCEPTED",
@@ -110,6 +114,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 +188,22 @@ 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;
+type SendStepsRetryAnalyticsEvent = {
+    eventAction: EVENT_ACTION.SEND_STEPS_RETRY;
+    attributes: {
+        documentAri: string;
+        eventStatus: EVENT_STATUS.SUCCESS;
+        count: number;
+    };
+};
+type CatchupAfterMaxSendStepsRetryAnalyticsEvent = {
+    eventAction: EVENT_ACTION.CATCHUP_AFTER_MAX_SEND_STEPS_RETRY;
+    attributes: {
+        documentAri: string;
+        eventStatus: EVENT_STATUS.SUCCESS;
+    };
+};
+export type ActionAnalyticsEvent = AddStepsSuccessAnalyticsEvent | AddStepsFailureAnalyticsEvent | ReInitDocFailAnalyticsEvent | ReInitDocSuccessAnalyticsEvent | ConnectionSuccessAnalyticsEvent | ConnectionFailureAnalyticsEvent | CatchUpSuccessAnalyticsEvent | CatchUpFailureAnalyticsEvent | DocumentInitSuccessAnalyticsEvent | UpdateParticipantsSuccessAnalyticsEvent | CommitUnconfirmedStepsSuccessAnalyticsEvent | CommitUnconfirmedStepsFailureAnalyticsEvent | PublishPageSuccessAnalyticsEvent | PublishPageFailureAnalyticsEvent | GetCurrentStateSuccessAnalyticsEvent | GetCurrentStateFailureAnalyticsEvent | InvalidateTokenAnalyticsEvent | SendStepsRetryAnalyticsEvent | CatchupAfterMaxSendStepsRetryAnalyticsEvent | CatchUpDroppedStepsEvent;
+export declare const ACK_MAX_TRY = 60;
 export declare const CONFLUENCE = "confluence";
 export {};

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

@@ -6,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,5 +1,5 @@
 import AnalyticsHelper from '../analytics/analytics-helper';
-import type { CollabEventDisconnectedData, CollabEventPresenceData, CollabTelepointerPayload, ChannelEvent, 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';
 /**
@@ -18,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 | CollabTelepointerPayload | 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/provider/commit-step.d.ts

@@ -1,9 +1,9 @@
 /// <reference types="lodash" />
-import { ChannelEvent, StepsPayload } from '../types';
+import { ChannelEvent, CollabCommitStatusEventPayload, CollabEvents, StepsPayload } from '../types';
 import type { Step as ProseMirrorStep } from 'prosemirror-transform';
 import AnalyticsHelper from '../analytics/analytics-helper';
 import type { InternalError } from '../errors/error-types';
-export declare const commitStep: ({ broadcast, steps, version, userId, clientId, onStepsAdded, onErrorHandled, analyticsHelper, }: {
+export declare const commitStep: ({ broadcast, steps, version, userId, clientId, onStepsAdded, onErrorHandled, analyticsHelper, emit, }: {
     broadcast: <K extends keyof ChannelEvent>(type: K, data: Omit<ChannelEvent[K], "timestamp">, callback?: Function) => void;
     steps: readonly ProseMirrorStep[];
     version: number;
@@ -12,8 +12,9 @@ export declare const commitStep: ({ broadcast, steps, version, userId, clientId,
     onStepsAdded: (data: StepsPayload) => void;
     onErrorHandled: (error: InternalError) => void;
     analyticsHelper?: AnalyticsHelper | undefined;
+    emit: (evt: keyof CollabEvents, data: CollabCommitStatusEventPayload) => void;
 }) => void;
-export declare const throttledCommitStep: import("lodash").DebouncedFunc<({ broadcast, steps, version, userId, clientId, onStepsAdded, onErrorHandled, analyticsHelper, }: {
+export declare const throttledCommitStep: import("lodash").DebouncedFunc<({ broadcast, steps, version, userId, clientId, onStepsAdded, onErrorHandled, analyticsHelper, emit, }: {
     broadcast: <K extends keyof ChannelEvent>(type: K, data: Omit<ChannelEvent[K], "timestamp">, callback?: Function) => void;
     steps: readonly ProseMirrorStep[];
     version: number;
@@ -22,4 +23,5 @@ export declare const throttledCommitStep: import("lodash").DebouncedFunc<({ broa
     onStepsAdded: (data: StepsPayload) => void;
     onErrorHandled: (error: InternalError) => void;
     analyticsHelper?: AnalyticsHelper | undefined;
+    emit: (evt: keyof CollabEvents, data: CollabCommitStatusEventPayload) => void;
 }) => void>;

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

@@ -33,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

package/dist/types/types.d.ts

@@ -7,6 +7,7 @@ import type { InternalError } from './errors/error-types';
 import type { ProviderError } from './errors/error-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;
@@ -89,6 +90,11 @@ export interface Config {
      */
     throwOnNotConnected?: boolean;
     initialDraft?: InitialDraft;
+    /**
+     * When a page is being published this number can control the number of failed steps until a catchup is triggered.
+     * The default value is MAX_STEP_REJECTED_ERROR (15).
+     */
+    failedStepLimitBeforeCatchupOnPublish?: number;
 }
 export interface InitAndAuthData {
     initialized: boolean;
@@ -134,6 +140,10 @@ export type CollabMetadataPayload = Metadata;
 export type CollabLocalStepsPayload = {
     steps: readonly Step[];
 };
+export type CollabCommitStatusEventPayload = {
+    status: 'attempt' | 'success' | 'failure';
+    version: number;
+};
 export interface CollabEvents {
     'metadata:changed': CollabMetadataPayload;
     init: CollabInitPayload;
@@ -146,6 +156,7 @@ export interface CollabEvents {
     error: ProviderError;
     entity: any;
     connecting: CollabConnectingPayload;
+    'commit-status': CollabCommitStatusEventPayload;
 }
 export interface Metadata {
     [key: string]: string | number | boolean;
@@ -167,10 +178,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 & {
@@ -270,6 +283,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;

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

@@ -16,10 +16,12 @@ export declare class DocumentService {
     private getUserId;
     private onErrorHandled;
     private metadataService;
+    private failedStepsBeforeCatchupOnPublish;
     private getState;
     private onSyncUpError?;
     private stepQueue;
     private stepRejectCounter;
+    private aggressiveCatchup;
     private clientId?;
     /**
      *
@@ -28,12 +30,13 @@ export declare class DocumentService {
      * @param analyticsHelper - Helper for analytics events
      * @param fetchCatchup - Function to fetch "catchup" data, data required to rebase current steps to the latest version.
      * @param providerEmitCallback - Callback for emitting events to listeners on the provider
-     * @param broadcastMetadata - Callback for broadcasting metadata changes to other clients
      * @param broadcast - Callback for broadcasting events to other clients
      * @param getUserId - Callback to fetch the current user's ID
      * @param onErrorHandled - Callback to handle
+     * @param metadataService
+     * @param failedStepsBeforeCatchupOnPublish - Control MAX_STEP_REJECTED_ERROR during page publishes.
      */
-    constructor(participantsService: ParticipantsService, analyticsHelper: AnalyticsHelper | undefined, fetchCatchup: (fromVersion: number) => Promise<CatchupResponse>, providerEmitCallback: (evt: keyof CollabEvents, data: any) => void, broadcast: <K extends keyof ChannelEvent>(type: K, data: Omit<ChannelEvent[K], 'timestamp'>, callback?: Function) => void, getUserId: () => string | undefined, onErrorHandled: (error: InternalError) => void, metadataService: MetadataService);
+    constructor(participantsService: ParticipantsService, analyticsHelper: AnalyticsHelper | undefined, fetchCatchup: (fromVersion: number) => Promise<CatchupResponse>, providerEmitCallback: (evt: keyof CollabEvents, data: any) => void, broadcast: <K extends keyof ChannelEvent>(type: K, data: Omit<ChannelEvent[K], 'timestamp'>, callback?: Function) => void, getUserId: () => string | undefined, onErrorHandled: (error: InternalError) => void, metadataService: MetadataService, failedStepsBeforeCatchupOnPublish?: number);
     /**
      * To prevent calling catchup to often, use lodash throttle to reduce the frequency
      */

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

@@ -10,11 +10,15 @@ export declare enum EVENT_ACTION {
     ERROR = "error",
     PUBLISH_PAGE = "publishPage",
     GET_CURRENT_STATE = "getCurrentState",
-    INVALIDATE_TOKEN = "invalidateToken"
+    INVALIDATE_TOKEN = "invalidateToken",
+    SEND_STEPS_RETRY = "sendStepsRetry",
+    CATCHUP_AFTER_MAX_SEND_STEPS_RETRY = "catchupAfterMaxSendStepsRetry",
+    DROPPED_STEPS = "droppedStepInCatchup"
 }
 export declare enum EVENT_STATUS {
     SUCCESS = "SUCCESS",
-    FAILURE = "FAILURE"
+    FAILURE = "FAILURE",
+    INFO = "INFO"
 }
 export declare enum ADD_STEPS_TYPE {
     ACCEPTED = "ACCEPTED",
@@ -110,6 +114,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 +188,22 @@ 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;
+type SendStepsRetryAnalyticsEvent = {
+    eventAction: EVENT_ACTION.SEND_STEPS_RETRY;
+    attributes: {
+        documentAri: string;
+        eventStatus: EVENT_STATUS.SUCCESS;
+        count: number;
+    };
+};
+type CatchupAfterMaxSendStepsRetryAnalyticsEvent = {
+    eventAction: EVENT_ACTION.CATCHUP_AFTER_MAX_SEND_STEPS_RETRY;
+    attributes: {
+        documentAri: string;
+        eventStatus: EVENT_STATUS.SUCCESS;
+    };
+};
+export type ActionAnalyticsEvent = AddStepsSuccessAnalyticsEvent | AddStepsFailureAnalyticsEvent | ReInitDocFailAnalyticsEvent | ReInitDocSuccessAnalyticsEvent | ConnectionSuccessAnalyticsEvent | ConnectionFailureAnalyticsEvent | CatchUpSuccessAnalyticsEvent | CatchUpFailureAnalyticsEvent | DocumentInitSuccessAnalyticsEvent | UpdateParticipantsSuccessAnalyticsEvent | CommitUnconfirmedStepsSuccessAnalyticsEvent | CommitUnconfirmedStepsFailureAnalyticsEvent | PublishPageSuccessAnalyticsEvent | PublishPageFailureAnalyticsEvent | GetCurrentStateSuccessAnalyticsEvent | GetCurrentStateFailureAnalyticsEvent | InvalidateTokenAnalyticsEvent | SendStepsRetryAnalyticsEvent | CatchupAfterMaxSendStepsRetryAnalyticsEvent | CatchUpDroppedStepsEvent;
+export declare const ACK_MAX_TRY = 60;
 export declare const CONFLUENCE = "confluence";
 export {};

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

@@ -6,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,5 +1,5 @@
 import AnalyticsHelper from '../analytics/analytics-helper';
-import type { CollabEventDisconnectedData, CollabEventPresenceData, CollabTelepointerPayload, ChannelEvent, 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';
 /**
@@ -18,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 | CollabTelepointerPayload | 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/provider/commit-step.d.ts

@@ -1,9 +1,9 @@
 /// <reference types="lodash" />
-import { ChannelEvent, StepsPayload } from '../types';
+import { ChannelEvent, CollabCommitStatusEventPayload, CollabEvents, StepsPayload } from '../types';
 import type { Step as ProseMirrorStep } from 'prosemirror-transform';
 import AnalyticsHelper from '../analytics/analytics-helper';
 import type { InternalError } from '../errors/error-types';
-export declare const commitStep: ({ broadcast, steps, version, userId, clientId, onStepsAdded, onErrorHandled, analyticsHelper, }: {
+export declare const commitStep: ({ broadcast, steps, version, userId, clientId, onStepsAdded, onErrorHandled, analyticsHelper, emit, }: {
     broadcast: <K extends keyof ChannelEvent>(type: K, data: Omit<ChannelEvent[K], "timestamp">, callback?: Function) => void;
     steps: readonly ProseMirrorStep[];
     version: number;
@@ -12,8 +12,9 @@ export declare const commitStep: ({ broadcast, steps, version, userId, clientId,
     onStepsAdded: (data: StepsPayload) => void;
     onErrorHandled: (error: InternalError) => void;
     analyticsHelper?: AnalyticsHelper | undefined;
+    emit: (evt: keyof CollabEvents, data: CollabCommitStatusEventPayload) => void;
 }) => void;
-export declare const throttledCommitStep: import("lodash").DebouncedFunc<({ broadcast, steps, version, userId, clientId, onStepsAdded, onErrorHandled, analyticsHelper, }: {
+export declare const throttledCommitStep: import("lodash").DebouncedFunc<({ broadcast, steps, version, userId, clientId, onStepsAdded, onErrorHandled, analyticsHelper, emit, }: {
     broadcast: <K extends keyof ChannelEvent>(type: K, data: Omit<ChannelEvent[K], "timestamp">, callback?: Function) => void;
     steps: readonly ProseMirrorStep[];
     version: number;
@@ -22,4 +23,5 @@ export declare const throttledCommitStep: import("lodash").DebouncedFunc<({ broa
     onStepsAdded: (data: StepsPayload) => void;
     onErrorHandled: (error: InternalError) => void;
     analyticsHelper?: AnalyticsHelper | undefined;
+    emit: (evt: keyof CollabEvents, data: CollabCommitStatusEventPayload) => void;
 }) => void>;

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

@@ -33,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

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

@@ -7,6 +7,7 @@ import type { InternalError } from './errors/error-types';
 import type { ProviderError } from './errors/error-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;
@@ -89,6 +90,11 @@ export interface Config {
      */
     throwOnNotConnected?: boolean;
     initialDraft?: InitialDraft;
+    /**
+     * When a page is being published this number can control the number of failed steps until a catchup is triggered.
+     * The default value is MAX_STEP_REJECTED_ERROR (15).
+     */
+    failedStepLimitBeforeCatchupOnPublish?: number;
 }
 export interface InitAndAuthData {
     initialized: boolean;
@@ -134,6 +140,10 @@ export type CollabMetadataPayload = Metadata;
 export type CollabLocalStepsPayload = {
     steps: readonly Step[];
 };
+export type CollabCommitStatusEventPayload = {
+    status: 'attempt' | 'success' | 'failure';
+    version: number;
+};
 export interface CollabEvents {
     'metadata:changed': CollabMetadataPayload;
     init: CollabInitPayload;
@@ -146,6 +156,7 @@ export interface CollabEvents {
     error: ProviderError;
     entity: any;
     connecting: CollabConnectingPayload;
+    'commit-status': CollabCommitStatusEventPayload;
 }
 export interface Metadata {
     [key: string]: string | number | boolean;
@@ -167,10 +178,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 & {
@@ -270,6 +283,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;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/collab-provider",
-  "version": "9.0.0",
+  "version": "9.1.0",
   "description": "A provider for collaborative editing.",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
@@ -61,9 +61,9 @@
     }
   },
   "devDependencies": {
-    "@atlaskit/adf-schema": "^25.7.0",
+    "@atlaskit/adf-schema": "^25.8.0",
     "@atlaskit/analytics-listeners": "^8.7.0",
-    "@atlaskit/editor-test-helpers": "^18.4.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

@@ -31,6 +31,12 @@ type BaseEvents = Pick<
   'send' | 'sendMessage' | 'setup'
 >;
 
+// @public (undocumented)
+type CollabCommitStatusEventPayload = {
+  status: 'attempt' | 'failure' | 'success';
+  version: number;
+};
+
 // @public (undocumented)
 export type CollabConnectedPayload = CollabEventConnectionData;
 
@@ -154,6 +160,8 @@ export interface CollabEventRemoteData {
 
 // @public (undocumented)
 export interface CollabEvents {
+  // (undocumented)
+  'commit-status': CollabCommitStatusEventPayload;
   // (undocumented)
   'local-steps': CollabLocalStepsPayload;
   // (undocumented)
@@ -251,6 +259,7 @@ interface Config {
   ) => Socket;
   // (undocumented)
   documentAri: string;
+  failedStepLimitBeforeCatchupOnPublish?: number;
   // (undocumented)
   featureFlags?: {
     [key: string]: boolean;