@atlaskit/collab-provider 9.8.0 → 9.9.0

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

@@ -1,6 +1,6 @@
 /// <reference types="lodash" />
 import AnalyticsHelper from '../analytics/analytics-helper';
-import { CatchupResponse, ChannelEvent, StepsPayload } from '../types';
+import { CatchupResponse, ReconcileResponse, ChannelEvent, StepsPayload } from '../types';
 import type { SyncUpErrorFunction, ResolvedEditorState } from '@atlaskit/editor-common/collab';
 import type { Step as ProseMirrorStep } from '@atlaskit/editor-prosemirror/transform';
 import type { MetadataService } from '../metadata/metadata-service';
@@ -12,6 +12,7 @@ export declare class DocumentService {
     private participantsService;
     private analyticsHelper;
     private fetchCatchup;
+    private fetchReconcile;
     private providerEmitCallback;
     private broadcast;
     private getUserId;
@@ -19,6 +20,7 @@ export declare class DocumentService {
     private metadataService;
     private failedStepsBeforeCatchupOnPublish;
     private enableErrorOnFailedDocumentApply;
+    private featureFlags;
     private getState;
     private onSyncUpError?;
     private stepQueue;
@@ -31,6 +33,7 @@ export declare class DocumentService {
      * and to emit their telepointers from steps they add
      * @param analyticsHelper - Helper for analytics events
      * @param fetchCatchup - Function to fetch "catchup" data, data required to rebase current steps to the latest version.
+     * @param fetchReconcile - Function to call "reconcile" from NCS backend
      * @param providerEmitCallback - Callback for emitting events to listeners on the provider
      * @param broadcast - Callback for broadcasting events to other clients
      * @param getUserId - Callback to fetch the current user's ID
@@ -38,8 +41,11 @@ export declare class DocumentService {
      * @param metadataService
      * @param failedStepsBeforeCatchupOnPublish - Control MAX_STEP_REJECTED_ERROR during page publishes.
      * @param enableErrorOnFailedDocumentApply - Enable failed document update exceptions.
+     * @param featureFlags - Feature flag config
      */
-    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, enableErrorOnFailedDocumentApply?: boolean);
+    constructor(participantsService: ParticipantsService, analyticsHelper: AnalyticsHelper | undefined, fetchCatchup: (fromVersion: number) => Promise<CatchupResponse>, fetchReconcile: (currentStateDoc: string) => Promise<ReconcileResponse>, 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, enableErrorOnFailedDocumentApply: boolean, featureFlags: {
+        [key: string]: boolean;
+    } | undefined);
     /**
      * To prevent calling catchup to often, use lodash throttle to reduce the frequency
      */

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

@@ -1,6 +1,7 @@
 export interface NCSFeatureFlags {
     testFF?: boolean;
     socketMessageMetricsFF?: boolean;
+    enableFallbackToReconcile?: boolean;
 }
 export interface WithNCSFeatureFlags {
     featureFlags?: NCSFeatureFlags;

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

@@ -179,6 +179,12 @@ export interface CatchupResponse {
     stepMaps?: any[];
     metadata?: Metadata;
 }
+export interface ReconcileResponse {
+    document: string;
+    version: number;
+    ari?: string;
+    metadata?: Metadata;
+}
 export interface CatchupOptions {
     getCurrentPmVersion: () => number;
     fetchCatchup: (fromVersion: number) => Promise<CatchupResponse>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/collab-provider",
-  "version": "9.8.0",
+  "version": "9.9.0",
   "description": "A provider for collaborative editing.",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
@@ -36,7 +36,7 @@
   "dependencies": {
     "@atlaskit/analytics-gas-types": "^5.1.0",
     "@atlaskit/analytics-listeners": "^8.7.0",
-    "@atlaskit/editor-common": "^74.35.0",
+    "@atlaskit/editor-common": "^74.36.0",
     "@atlaskit/editor-json-transformer": "^8.10.0",
     "@atlaskit/editor-prosemirror": "1.0.2",
     "@atlaskit/prosemirror-collab": "^0.2.0",