@atlaskit/collab-provider 10.3.4 → 10.4.1

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

@@ -19,7 +19,8 @@ export declare enum EVENT_ACTION {
     PROVIDER_INITIALIZED = "providerInitialized",// https://data-portal.internal.atlassian.com/analytics/registry/54714
     RECONNECTION = "providerReconnection",// https://data-portal.internal.atlassian.com/analytics/registry/73992
     PROVIDER_SETUP = "providerSetup",// https://data-portal.internal.atlassian.com/analytics/registry/54715
-    HAS_UNCONFIRMED_STEPS = "hasUnconfirmedSteps"
+    HAS_UNCONFIRMED_STEPS = "hasUnconfirmedSteps",// https://data-portal.internal.atlassian.com/analytics/registry/56141
+    OUT_OF_SYNC = "outOfSync"
 }
 export declare enum EVENT_STATUS {
     SUCCESS = "SUCCESS",
@@ -261,7 +262,20 @@ type ReconnectionAnalyticsEvent = {
         disconnectionPeriodSeconds: number;
     } & BaseActionAnalyticsEventAttributes;
 };
-export type ActionAnalyticsEvent = AddStepsSuccessAnalyticsEvent | AddStepsFailureAnalyticsEvent | ReInitDocFailAnalyticsEvent | ReInitDocSuccessAnalyticsEvent | ConnectionSuccessAnalyticsEvent | ConnectionFailureAnalyticsEvent | CatchUpSuccessAnalyticsEvent | CatchUpFailureAnalyticsEvent | DocumentInitSuccessAnalyticsEvent | UpdateParticipantsSuccessAnalyticsEvent | CommitUnconfirmedStepsSuccessAnalyticsEvent | CommitUnconfirmedStepsFailureAnalyticsEvent | PublishPageSuccessAnalyticsEvent | PublishPageFailureAnalyticsEvent | GetCurrentStateSuccessAnalyticsEvent | GetCurrentStateFailureAnalyticsEvent | InvalidateTokenAnalyticsEvent | SendStepsRetryAnalyticsEvent | CatchupAfterMaxSendStepsRetryAnalyticsEvent | CatchUpDroppedStepsEvent | WebsocketMessageVolumeMetricEvent | ProviderInitializedAnalyticsEvent | ProviderSetupAnalyticsEvent | ProviderHasUnconfirmedStepsAnalyticsEvent | UpdateDocumentAnalyticsEvent | ReconnectionAnalyticsEvent;
+type OutOfSyncAnalyticsEvent = {
+    eventAction: EVENT_ACTION.OUT_OF_SYNC;
+    attributes: {
+        eventStatus: EVENT_STATUS.FAILURE;
+        obfuscatedSteps: {
+            [key: string]: number;
+        }[];
+        obfuscatedDoc: {
+            [key: string]: number;
+        };
+        catchupReason: CatchupEventReason | undefined;
+    } & BaseActionAnalyticsEventAttributes;
+};
+export type ActionAnalyticsEvent = AddStepsSuccessAnalyticsEvent | AddStepsFailureAnalyticsEvent | ReInitDocFailAnalyticsEvent | ReInitDocSuccessAnalyticsEvent | ConnectionSuccessAnalyticsEvent | ConnectionFailureAnalyticsEvent | CatchUpSuccessAnalyticsEvent | CatchUpFailureAnalyticsEvent | DocumentInitSuccessAnalyticsEvent | UpdateParticipantsSuccessAnalyticsEvent | CommitUnconfirmedStepsSuccessAnalyticsEvent | CommitUnconfirmedStepsFailureAnalyticsEvent | PublishPageSuccessAnalyticsEvent | PublishPageFailureAnalyticsEvent | GetCurrentStateSuccessAnalyticsEvent | GetCurrentStateFailureAnalyticsEvent | InvalidateTokenAnalyticsEvent | SendStepsRetryAnalyticsEvent | CatchupAfterMaxSendStepsRetryAnalyticsEvent | CatchUpDroppedStepsEvent | WebsocketMessageVolumeMetricEvent | ProviderInitializedAnalyticsEvent | ProviderSetupAnalyticsEvent | ProviderHasUnconfirmedStepsAnalyticsEvent | UpdateDocumentAnalyticsEvent | ReconnectionAnalyticsEvent | OutOfSyncAnalyticsEvent;
 export declare const ACK_MAX_TRY = 60;
 export declare const CONFLUENCE = "confluence";
 /** Enumerable for attaching a reason to catchup (v2) call(s) */

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

@@ -1,5 +1,10 @@
+import { type ADFEntity } from '@atlaskit/adf-utils/types';
 import type { ProductInformation } from '../types';
 import type { Step as ProseMirrorStep } from '@atlaskit/editor-prosemirror/transform';
+import type { EditorState } from '@atlaskit/editor-prosemirror/state';
+import type { StepJson } from '@atlaskit/editor-common/collab';
+import { Node as ProseMirrorNode } from '@atlaskit/editor-prosemirror/model';
+import { CustomError } from '../errors/custom-errors';
 export declare const createLogger: (prefix: string, color?: string) => (msg: string, data?: any) => void;
 export declare function sleep(ms: number): Promise<unknown>;
 export declare const isAIProviderID: (id: string) => boolean;
@@ -11,3 +16,47 @@ export type UGCFreeStepDetails = {
     stepSizeInBytes?: number;
 };
 export declare const getStepUGCFreeDetails: (step: ProseMirrorStep) => UGCFreeStepDetails;
+export declare const getStepTypes: (stepJson: StepJson) => {
+    type: string;
+    contentTypes: string | null;
+};
+export declare const getStepsAdfWithObfuscation: (stepJson: StepJson) => ADFEntity[] | null;
+export declare const getDocAdfWithObfuscation: (doc: ProseMirrorNode) => ADFEntity | null;
+export declare const getStepPositions: (stepJson: StepJson) => {
+    pos?: number | undefined;
+    insert?: number | undefined;
+    gapFrom?: number | undefined;
+    gapTo?: number | undefined;
+    from?: number | undefined;
+    to?: number | undefined;
+};
+export declare const getObfuscatedSteps: (steps: StepJson[], endIndex?: number | undefined) => {
+    stepType: {
+        type: string;
+        contentTypes: string | null;
+    };
+    stepContent: ADFEntity[] | null;
+    stepPositions: {
+        pos?: number | undefined;
+        insert?: number | undefined;
+        gapFrom?: number | undefined;
+        gapTo?: number | undefined;
+        from?: number | undefined;
+        to?: number | undefined;
+    };
+    stepMetadata: {
+        source?: string | undefined;
+        stepId?: string | undefined;
+        prevStepId?: string | undefined;
+        rebased?: boolean | undefined;
+        traceId?: string | undefined;
+        reqId?: string | undefined;
+        schemaVersion?: string | undefined;
+        unconfirmedStepAfterRecovery?: boolean | undefined;
+    } | undefined;
+}[];
+export declare function logObfuscatedSteps(oldState: EditorState | null, newState: EditorState): Promise<CustomError | {
+    stepsFromOldState: string;
+    stepsFromNewState: string;
+}>;
+export declare function toObfuscatedSteps(steps: readonly ProseMirrorStep[]): Promise<string>;

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

@@ -1,4 +1,4 @@
 export { Provider } from './provider';
 export type { CollabEventDisconnectedData, Socket } from './types';
-export type { NewCollabSyncUpErrorAttributes, ResolvedEditorState, CollabMetadataPayload, CollabEventInitData, CollabInitPayload, CollabEventConnectionData, CollabConnectedPayload, CollabDisconnectedPayload, CollabDataPayload, CollabActivityData, CollabTelepointerPayload, CollabPresencePayload, CollabLocalStepsPayload, CollabPermissionEventPayload, CollabEventRemoteData, CollabEventPresenceData, CollabActivityJoinPayload, CollabActivityAckPayload, CollabEventConnectingData, CollabEventTelepointerData, CollabSendableSelection, CollabParticipant, CollabEvents, SyncUpErrorFunction, CollabEditProvider, ProviderError, ProviderParticipant, CollabEventLocalStepData, UserPermitType, } from '@atlaskit/editor-common/collab';
+export type { NewCollabSyncUpErrorAttributes, ResolvedEditorState, CollabMetadataPayload, CollabEventInitData, CollabInitPayload, CollabEventConnectionData, CollabConnectedPayload, CollabDisconnectedPayload, CollabDataPayload, CollabActivityData, CollabTelepointerPayload, CollabPresencePayload, CollabLocalStepsPayload, CollabPermissionEventPayload, CollabEventRemoteData, CollabEventPresenceData, CollabActivityJoinPayload, CollabActivityAckPayload, CollabEventConnectingData, CollabEventTelepointerData, CollabSendableSelection, CollabParticipant, CollabEvents, SyncUpErrorFunction, CollabEditProvider, ProviderError, ProviderParticipant, CollabEventLocalStepData, UserPermitType, CollabNamespaceLockCheckPayload, } from '@atlaskit/editor-common/collab';
 export { PROVIDER_ERROR_CODE } from '@atlaskit/editor-common/collab';

package/dist/types-ts4.5/provider/commit-step.d.ts

@@ -5,7 +5,7 @@ import type AnalyticsHelper from '../analytics/analytics-helper';
 import type { InternalError } from '../errors/internal-errors';
 export declare let readyToCommit: boolean;
 export declare const RESET_READYTOCOMMIT_INTERVAL_MS = 5000;
-export declare const commitStepQueue: ({ broadcast, steps, version, userId, clientId, onStepsAdded, onErrorHandled, analyticsHelper, emit, __livePage, }: {
+export declare const commitStepQueue: ({ broadcast, steps, version, userId, clientId, onStepsAdded, onErrorHandled, analyticsHelper, emit, __livePage, hasRecovered, }: {
     broadcast: <K extends keyof ChannelEvent>(type: K, data: Omit<ChannelEvent[K], 'timestamp'>, callback?: Function) => void;
     steps: readonly ProseMirrorStep[];
     version: number;
@@ -16,4 +16,5 @@ export declare const commitStepQueue: ({ broadcast, steps, version, userId, clie
     analyticsHelper?: AnalyticsHelper | undefined;
     emit: (evt: keyof CollabEvents, data: CollabCommitStatusEventPayload) => void;
     __livePage: boolean;
+    hasRecovered: boolean;
 }) => void;

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

@@ -1,4 +1,3 @@
-import type { Step } from '@atlaskit/editor-prosemirror/transform';
 import type { AnalyticsWebClient } from '@atlaskit/analytics-listeners';
 import type { Manager, Socket as SocketIOSocket } from 'socket.io-client';
 import type { InternalError } from './errors/internal-errors';
@@ -7,6 +6,7 @@ import type { GetUserType } from './participants/participants-helper';
 import type AnalyticsHelper from './analytics/analytics-helper';
 import type { StepJson, CollabSendableSelection, Metadata, UserPermitType, Activity, PresenceActivity } from '@atlaskit/editor-common/collab';
 import { type CatchupEventReason } from './helpers/const';
+import type { EditorState } from '@atlaskit/editor-prosemirror/state';
 export interface CollabEventDisconnectedData {
     sid: string;
     reason: 'CLIENT_DISCONNECT' | 'SERVER_DISCONNECT' | 'SOCKET_CLOSED' | 'SOCKET_ERROR' | 'SOCKET_TIMEOUT' | 'UNKNOWN_DISCONNECT';
@@ -199,7 +199,7 @@ export type ChannelEvent = {
     status: NamespaceStatus;
 };
 export interface Catchupv2Response {
-    steps?: Step[];
+    steps?: StepJson[];
     metadata?: Metadata;
 }
 export interface ReconcileResponse {
@@ -218,6 +218,7 @@ export interface Catchupv2Options {
     catchUpOutofSync: boolean;
     reason?: CatchupEventReason;
     onCatchupComplete?: (steps: StepJson[]) => void;
+    getState: (() => EditorState) | undefined;
 }
 export type ReconnectionMetadata = {
     unconfirmedStepsLength: number | undefined;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/collab-provider",
-	"version": "10.3.4",
+	"version": "10.4.1",
 	"description": "A provider for collaborative editing.",
 	"publishConfig": {
 		"registry": "https://registry.npmjs.org/"
@@ -32,14 +32,16 @@
 		"./version-wrapper": "./src/version-wrapper.ts"
 	},
 	"dependencies": {
+		"@atlaskit/adf-utils": "^19.17.0",
 		"@atlaskit/analytics-gas-types": "^5.1.0",
 		"@atlaskit/analytics-listeners": "^8.13.0",
-		"@atlaskit/editor-common": "^99.0.0",
+		"@atlaskit/editor-common": "^99.5.0",
 		"@atlaskit/editor-json-transformer": "^8.21.0",
 		"@atlaskit/editor-prosemirror": "6.2.1",
 		"@atlaskit/feature-gate-js-client": "^4.22.0",
 		"@atlaskit/platform-feature-flags": "^0.3.0",
 		"@atlaskit/prosemirror-collab": "^0.11.0",
+		"@atlaskit/react-ufo": "^2.12.0",
 		"@atlaskit/ufo": "^0.3.0",
 		"@atlaskit/util-service-support": "^6.2.0",
 		"@babel/runtime": "^7.0.0",
@@ -71,11 +73,23 @@
 		"platform.editor.live-pages-expand-divergence": {
 			"type": "boolean"
 		},
+		"platform_editor_log_obfuscated_steps": {
+			"type": "boolean"
+		},
 		"platform_editor_merge_unconfirmed_steps": {
 			"type": "boolean"
 		},
 		"restore_localstep_fallback_reconcile": {
 			"type": "boolean"
+		},
+		"tag_unconfirmed_steps_after_recovery": {
+			"type": "boolean"
+		},
+		"platform_collab_provider_tracingheaders": {
+			"type": "boolean"
+		},
+		"log_obfuscated_steps_for_view_only": {
+			"type": "boolean"
 		}
 	}
 }