@atlaskit/editor-plugin-collab-edit 12.0.15 → 12.0.16

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @atlaskit/editor-plugin-collab-edit
 
+## 12.0.16
+
+### Patch Changes
+
+- Updated dependencies
+
 ## 12.0.15
 
 ### Patch Changes

package/collabEditPlugin/package.json

@@ -4,12 +4,5 @@
   "module": "../dist/esm/entry-points/collabEditPlugin.js",
   "module:es2019": "../dist/es2019/entry-points/collabEditPlugin.js",
   "sideEffects": false,
-  "types": "../dist/types/entry-points/collabEditPlugin.d.ts",
-  "typesVersions": {
-    ">=4.5 <5.9": {
-      "*": [
-        "../dist/types-ts4.5/entry-points/collabEditPlugin.d.ts"
-      ]
-    }
-  }
+  "types": "../dist/types/entry-points/collabEditPlugin.d.ts"
 }

package/collabEditPluginType/package.json

@@ -4,12 +4,5 @@
   "module": "../dist/esm/entry-points/collabEditPluginType.js",
   "module:es2019": "../dist/es2019/entry-points/collabEditPluginType.js",
   "sideEffects": false,
-  "types": "../dist/types/entry-points/collabEditPluginType.d.ts",
-  "typesVersions": {
-    ">=4.5 <5.9": {
-      "*": [
-        "../dist/types-ts4.5/entry-points/collabEditPluginType.d.ts"
-      ]
-    }
-  }
+  "types": "../dist/types/entry-points/collabEditPluginType.d.ts"
 }

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-plugin-collab-edit",
-	"version": "12.0.15",
+	"version": "12.0.16",
 	"description": "Collab Edit plugin for @atlaskit/editor-core",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -39,7 +39,7 @@
 		"@atlaskit/frontend-utilities": "^3.4.0",
 		"@atlaskit/platform-feature-flags": "^1.1.0",
 		"@atlaskit/prosemirror-collab": "^0.22.0",
-		"@atlaskit/tmp-editor-statsig": "^102.0.0",
+		"@atlaskit/tmp-editor-statsig": "^103.0.0",
 		"@atlaskit/tokens": "^13.4.0",
 		"@babel/runtime": "^7.0.0",
 		"memoize-one": "^6.0.0"

package/types/package.json

@@ -4,12 +4,5 @@
   "module": "../dist/esm/entry-points/types.js",
   "module:es2019": "../dist/es2019/entry-points/types.js",
   "sideEffects": false,
-  "types": "../dist/types/entry-points/types.d.ts",
-  "typesVersions": {
-    ">=4.5 <5.9": {
-      "*": [
-        "../dist/types-ts4.5/entry-points/types.d.ts"
-      ]
-    }
-  }
+  "types": "../dist/types/entry-points/types.d.ts"
 }

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

@@ -1,2 +0,0 @@
-import type { CollabEditPlugin } from './collabEditPluginType';
-export declare const collabEditPlugin: CollabEditPlugin;

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

@@ -1,47 +0,0 @@
-import type { EditorCommand, NextEditorPlugin, OptionalPlugin } from '@atlaskit/editor-common/types';
-import type { JSONNode } from '@atlaskit/editor-json-transformer';
-import type { AnalyticsPlugin } from '@atlaskit/editor-plugin-analytics';
-import type { ConnectivityPlugin } from '@atlaskit/editor-plugin-connectivity';
-import type { EditorViewModePlugin } from '@atlaskit/editor-plugin-editor-viewmode';
-import type { FeatureFlagsPlugin } from '@atlaskit/editor-plugin-feature-flags';
-import type { Mark } from '@atlaskit/editor-prosemirror/model';
-import type { Transaction } from '@atlaskit/editor-prosemirror/state';
-import type { CollabEditPluginSharedState, CollabSendableSteps, PrivateCollabEditOptions } from './types';
-export type CollabEditPluginDependencies = [
-    OptionalPlugin<FeatureFlagsPlugin>,
-    OptionalPlugin<AnalyticsPlugin>,
-    OptionalPlugin<EditorViewModePlugin>,
-    OptionalPlugin<ConnectivityPlugin>
-];
-export type CollabEditPluginOptions = PrivateCollabEditOptions;
-export type CollabEditPlugin = NextEditorPlugin<'collabEdit', {
-    actions: {
-        addInlineCommentMark: (props: {
-            from: number;
-            mark: Mark;
-            to: number;
-        }) => boolean;
-        addInlineCommentNodeMark: (props: {
-            mark: Mark;
-            pos: number;
-        }) => boolean;
-        getAvatarColor: (str: string) => {
-            backgroundColor: string;
-            index: number;
-            textColor: string;
-        };
-        getCurrentCollabState: () => {
-            content: JSONNode | undefined;
-            sendableSteps: CollabSendableSteps | undefined | null;
-            version: number | undefined;
-        };
-        isRemoteReplaceDocumentTransaction: (tr: Transaction) => boolean;
-        validatePMJSONDocument: (doc: any) => boolean;
-    };
-    commands: {
-        nudgeTelepointer: (sessionId: string) => EditorCommand;
-    };
-    dependencies: CollabEditPluginDependencies;
-    pluginConfiguration: CollabEditPluginOptions;
-    sharedState: CollabEditPluginSharedState;
-}>;

package/dist/types-ts4.5/entry-points/collabEditPlugin.d.ts

@@ -1 +0,0 @@
-export { collabEditPlugin } from '../collabEditPlugin';

package/dist/types-ts4.5/entry-points/collabEditPluginType.d.ts

@@ -1 +0,0 @@
-export type { CollabEditPlugin, CollabEditPluginOptions, CollabEditPluginDependencies, } from '../collabEditPluginType';

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

@@ -1 +0,0 @@
-export type { CollabInitializedMetadata, LastOrganicChangeMetadata, CollabEditPluginSharedState, ReadOnlyParticipants, PrivateCollabEditOptions, CollabSendableSteps, } from '../types/index';

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

@@ -1,3 +0,0 @@
-export { collabEditPlugin } from './collabEditPlugin';
-export type { CollabEditPlugin, CollabEditPluginOptions, CollabEditPluginDependencies, } from './collabEditPluginType';
-export type { CollabInitializedMetadata, LastOrganicChangeMetadata, CollabEditPluginSharedState, ReadOnlyParticipants, PrivateCollabEditOptions, CollabSendableSteps, } from './types';

package/dist/types-ts4.5/pm-plugins/actions.d.ts

@@ -1,13 +0,0 @@
-import type { EditorAnalyticsAPI } from '@atlaskit/editor-common/analytics';
-import type { CollabEventConnectionData, CollabEventInitData, CollabEventPresenceData, CollabEventRemoteData, CollabSendableSelection, CollabTelepointerPayload } from '@atlaskit/editor-common/collab';
-import type { Selection } from '@atlaskit/editor-prosemirror/state';
-import type { EditorView } from '@atlaskit/editor-prosemirror/view';
-import type { PrivateCollabEditOptions } from '../types';
-export declare const registerAllCustomSteps: () => void;
-export declare const handleInit: (initData: CollabEventInitData, view: EditorView, options?: PrivateCollabEditOptions, editorAnalyticsApi?: EditorAnalyticsAPI) => void;
-export declare const handleConnection: (connectionData: CollabEventConnectionData, view: EditorView) => void;
-export declare const handlePresence: (presenceData: CollabEventPresenceData, view: EditorView) => void;
-export declare const applyRemoteData: (remoteData: CollabEventRemoteData, view: EditorView, options: PrivateCollabEditOptions) => void;
-export declare const applyRemoteSteps: (json: any[], view: EditorView, userIds?: (number | string)[], options?: PrivateCollabEditOptions) => void;
-export declare const handleTelePointer: (telepointerData: CollabTelepointerPayload, view: EditorView) => void;
-export declare const getSendableSelection: (selection: Selection) => CollabSendableSelection;

package/dist/types-ts4.5/pm-plugins/analytics.d.ts

@@ -1,6 +0,0 @@
-import type { EditorAnalyticsAPI } from '@atlaskit/editor-common/analytics';
-import type { FeatureFlags } from '@atlaskit/editor-common/types';
-import type { EditorState, Transaction } from '@atlaskit/editor-prosemirror/state';
-export declare const addSynchronyErrorAnalytics: (state: EditorState, tr: Transaction, featureFlags: FeatureFlags, editorAnalyticsApi: EditorAnalyticsAPI | undefined) => (error: Error) => Transaction;
-export type EntityEventType = 'error' | 'disconnected';
-export declare const addSynchronyEntityAnalytics: (state: EditorState, tr: Transaction) => (type: EntityEventType, editorAnalyticsApi: EditorAnalyticsAPI | undefined) => Transaction;

package/dist/types-ts4.5/pm-plugins/events/handlers.d.ts

@@ -1,25 +0,0 @@
-import type { EditorAnalyticsAPI } from '@atlaskit/editor-common/analytics';
-import type { CollabEditProvider, CollabEventConflictPayload, CollabEventConnectionData, CollabEventInitData, CollabEventLocalStepData, CollabEventPresenceData, CollabEventRemoteData, CollabEvents, CollabTelepointerPayload } from '@atlaskit/editor-common/collab';
-import type { ProviderFactory } from '@atlaskit/editor-common/provider-factory';
-import type { FeatureFlags } from '@atlaskit/editor-common/types';
-import type { EditorView } from '@atlaskit/editor-prosemirror/view';
-import type { PrivateCollabEditOptions } from '../../types';
-export type SynchronyEntity = {
-    off: (evt: 'disconnected' | 'error', handler: (...args: any) => void) => void;
-    on: (evt: 'disconnected' | 'error', handler: (...args: any) => void) => void;
-};
-export interface CollabHandlers {
-    connectedHandler: (data: CollabEventConnectionData) => void;
-    dataConflictHandler: (data: CollabEventConflictPayload) => void;
-    dataHandler: (data: CollabEventRemoteData) => void;
-    entityHandler: ({ entity }: {
-        entity: SynchronyEntity;
-    }) => void;
-    errorHandler: (error: any) => void;
-    initHandler: (data: CollabEventInitData) => void;
-    localStepsHandler: (data: CollabEventLocalStepData) => void;
-    presenceHandler: (data: CollabEventPresenceData) => void;
-    telepointerHandler: (data: CollabTelepointerPayload) => void;
-}
-export type Cleanup = () => void;
-export declare const subscribe: (currentDeps_0: EditorView, currentDeps_1: CollabEditProvider<CollabEvents>, currentDeps_2: PrivateCollabEditOptions, currentDeps_3: FeatureFlags, currentDeps_4?: ProviderFactory | undefined, currentDeps_5?: EditorAnalyticsAPI | undefined) => Cleanup;

package/dist/types-ts4.5/pm-plugins/events/initialize.d.ts

@@ -1,18 +0,0 @@
-import type { EditorAnalyticsAPI } from '@atlaskit/editor-common/analytics';
-import type { CollabEditProvider } from '@atlaskit/editor-common/collab';
-import type { ProviderFactory } from '@atlaskit/editor-common/provider-factory';
-import type { ExtractInjectionAPI, FeatureFlags } from '@atlaskit/editor-common/types';
-import type { EditorView } from '@atlaskit/editor-prosemirror/view';
-import type { CollabEditPlugin } from '../../collabEditPluginType';
-import type { PrivateCollabEditOptions } from '../../types';
-import type { Cleanup } from './handlers';
-type Props = {
-    editorAnalyticsApi: EditorAnalyticsAPI | undefined;
-    featureFlags: FeatureFlags;
-    options: PrivateCollabEditOptions;
-    pluginInjectionApi?: ExtractInjectionAPI<CollabEditPlugin> | undefined;
-    providerFactory: ProviderFactory;
-    view: EditorView;
-};
-export declare const initialize: ({ options, providerFactory, view, featureFlags, editorAnalyticsApi, pluginInjectionApi, }: Props) => (provider: CollabEditProvider) => Cleanup;
-export {};

package/dist/types-ts4.5/pm-plugins/events/send-transaction.d.ts

@@ -1,14 +0,0 @@
-import type { CollabEditProvider } from '@atlaskit/editor-common/collab';
-import type { ViewMode } from '@atlaskit/editor-plugin-editor-viewmode';
-import type { EditorState, Transaction } from '@atlaskit/editor-prosemirror/state';
-type Props = {
-    hideTelecursorOnLoad: boolean;
-    newEditorState: EditorState;
-    oldEditorState: EditorState;
-    originalTransaction: Readonly<Transaction>;
-    transactions: readonly Transaction[];
-    useNativePlugin: boolean;
-    viewMode?: ViewMode;
-};
-export declare const sendTransaction: ({ originalTransaction, transactions, oldEditorState, newEditorState, useNativePlugin, viewMode, hideTelecursorOnLoad, }: Props) => (provider: CollabEditProvider) => void;
-export {};

package/dist/types-ts4.5/pm-plugins/filterAnalytics.d.ts

@@ -1,9 +0,0 @@
-import { Rebaseable } from '@atlaskit/prosemirror-collab';
-/**
- * Filter out AnalyticsStep from the steps.
- *
- * @param steps Rebaseable steps
- * @returns Rebaseable steps
- * @example
- */
-export declare function filterAnalyticsSteps(steps: Rebaseable[]): Rebaseable[];

package/dist/types-ts4.5/pm-plugins/main/index.d.ts

@@ -1,9 +0,0 @@
-import type { CollabEditProvider } from '@atlaskit/editor-common/collab';
-import type { Dispatch } from '@atlaskit/editor-common/event-dispatcher';
-import type { ProviderFactory } from '@atlaskit/editor-common/provider-factory';
-import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
-import type { ExtractInjectionAPI, FeatureFlags } from '@atlaskit/editor-common/types';
-import type { CollabEditPlugin } from '../../collabEditPluginType';
-import type { PrivateCollabEditOptions, ProviderCallback } from '../../types';
-import { PluginState } from './plugin-state';
-export declare const createPlugin: (dispatch: Dispatch, providerFactory: ProviderFactory, providerResolver: (value: CollabEditProvider) => void, collabProviderCallback: ProviderCallback, options: PrivateCollabEditOptions, featureFlags: FeatureFlags, pluginInjectionApi: ExtractInjectionAPI<CollabEditPlugin> | undefined) => SafePlugin<PluginState>;

package/dist/types-ts4.5/pm-plugins/main/plugin-key.d.ts

@@ -1,3 +0,0 @@
-import { PluginKey } from '@atlaskit/editor-prosemirror/state';
-import type { PluginState as CollabPluginState } from './plugin-state';
-export declare const pluginKey: PluginKey<CollabPluginState>;

package/dist/types-ts4.5/pm-plugins/main/plugin-state.d.ts

@@ -1,27 +0,0 @@
-import type { ReadonlyTransaction } from '@atlaskit/editor-prosemirror/state';
-import { DecorationSet } from '@atlaskit/editor-prosemirror/view';
-import type { ReadOnlyParticipants } from '../../types';
-import { Participants } from '../participants';
-import type { NudgeAnimationsMap } from '../utils';
-/**
- * Returns position where it's possible to place a decoration.
- */
-export declare const getValidPos: (tr: ReadonlyTransaction, pos: number) => number;
-export declare class PluginState {
-    private decorationSet;
-    private participants;
-    private nudgeAnimations;
-    private onError;
-    private sid?;
-    isReady: boolean;
-    get decorations(): DecorationSet;
-    get activeParticipants(): ReadOnlyParticipants;
-    get sessionId(): string | undefined;
-    constructor(decorations: DecorationSet, participants: Participants, sessionId?: string, collabInitalised?: boolean, onError?: (err: Error) => void, nudgeAnimations?: NudgeAnimationsMap);
-    getFullName(sessionId: string): string;
-    getInitial(sessionId: string): string;
-    getPresenceId(sessionId: string): string;
-    apply(tr: ReadonlyTransaction): PluginState;
-    static eq(a: PluginState, b: PluginState): boolean;
-    static init(config: any): PluginState;
-}

package/dist/types-ts4.5/pm-plugins/mergeUnconfirmed.d.ts

@@ -1,14 +0,0 @@
-import type { ExtractInjectionAPI } from '@atlaskit/editor-common/types';
-import { Rebaseable } from '@atlaskit/prosemirror-collab';
-import type { CollabEditPlugin } from '../collabEditPluginType';
-/**
- * Merge a set of steps together to reduce the total number of steps stored in memory.
- *
- * All steps passing through here should be "lockable" (ie. can be locked by the document service)
- * so that it can be indicated they have already been sent (or are about to be sent) to the backend
- * and cannot be merged.
- *
- * @param steps Rebaseable steps
- * @returns Rebaseable steps
- */
-export declare function mergeUnconfirmedSteps(steps: Rebaseable[], api: ExtractInjectionAPI<CollabEditPlugin> | undefined): Rebaseable[];

package/dist/types-ts4.5/pm-plugins/monitor-organic-changes.d.ts

@@ -1,39 +0,0 @@
-import type { ExtractInjectionAPI } from '@atlaskit/editor-common/types';
-import type { EditorState, Transaction } from '@atlaskit/editor-prosemirror/state';
-import type { CollabEditPlugin } from '../collabEditPluginType';
-export type OrganicMetadataAnalytics = {
-    endedAt: number;
-    isFirstChange: boolean;
-    startedAt: number;
-    stepTypesAmount: {
-        [key: string]: number;
-    };
-    transactions: number;
-};
-type TrackProps = {
-    api: ExtractInjectionAPI<CollabEditPlugin> | undefined;
-    newEditorState: EditorState;
-    oldEditorState: EditorState;
-    onDataProcessed: (data: OrganicMetadataAnalytics[]) => void;
-    transactions: Readonly<Transaction[]>;
-};
-type Scheduler = {
-    postTask: (cb: () => void, options: {
-        delay: number;
-        priority: 'background';
-    }) => Promise<unknown>;
-};
-export declare const getScheduler: (obj: any) => Scheduler | null;
-/**
- * Tracks the steps sent by the client by storing them in a cache and scheduling a task to process them. Once the steps are processed, the onDataProcessed callabck will be called.
- *
- * This is a non-critical code. If the browser doesn't support the Scheduler API https://developer.mozilla.org/en-US/docs/Web/API/Scheduler/
- *
- * @param {TrackProps} props - The properties required for tracking steps.
- * @param {ExtractInjectionAPI<CollabEditPlugin> | undefined} props.api - The API for the CollabEdit plugin.
- * @param {EditorState} props.newEditorState - The new editor state.
- * @param {Readonly<Transaction[]>} props.transactions - The transactions that contain the steps.
- * @param {(data: OrganicMetadataAnalytics[]) => void} props.onDataProcessed - Callback function to be called with the processed data.
- */
-export declare const monitorOrganic: ({ newEditorState, oldEditorState, transactions, onDataProcessed, }: TrackProps) => void;
-export {};

package/dist/types-ts4.5/pm-plugins/native-collab-provider-plugin.d.ts

@@ -1,7 +0,0 @@
-import type { CollabEditProvider, CollabEvents } from '@atlaskit/editor-common/collab';
-import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
-import type { EditorState } from '@atlaskit/editor-prosemirror/state';
-export declare const nativeCollabProviderPlugin: ({ providerPromise, }: {
-    providerPromise: Promise<CollabEditProvider>;
-}) => SafePlugin<CollabEditProvider<CollabEvents> | null>;
-export declare const getCollabProvider: (editorState: EditorState) => CollabEditProvider | null;

package/dist/types-ts4.5/pm-plugins/participants.d.ts

@@ -1,14 +0,0 @@
-import type { CollabParticipant } from '@atlaskit/editor-common/collab';
-import type { ReadOnlyParticipants } from '../types';
-export declare class Participants implements ReadOnlyParticipants {
-    private participants;
-    constructor(participants?: Map<string, CollabParticipant>);
-    add(data: CollabParticipant[]): Participants;
-    remove(sessionIds: string[]): Participants;
-    update(sessionId: string, lastActive: number): Participants;
-    updateCursorPos(sessionId: string, cursorPos: number): Participants;
-    toArray(): CollabParticipant[];
-    get(sessionId: string): CollabParticipant | undefined;
-    size(): number;
-    eq(other: ReadOnlyParticipants): boolean;
-}

package/dist/types-ts4.5/pm-plugins/preserve-node-identity.d.ts

@@ -1,28 +0,0 @@
-import { Fragment } from '@atlaskit/editor-prosemirror/model';
-/**
- * Walk two Fragments (old and new) and return a Fragment that reuses old node
- * references wherever structurally equal (`node.eq()` returns true).
- *
- * This preserves referential identity (`===`) for unchanged subtrees, which is
- * critical for ProseMirror's view reconciliation performance. The `preMatch`
- * optimisation in `prosemirror-view/src/viewdesc.ts` uses `===` to fast-match
- * nodes against existing view descriptors. When all nodes are fresh objects
- * (e.g. after `Node.fromJSON` in `replaceDocument`), `preMatch` fails for
- * everything, and the fallback scan in `syncToMarks` is limited to 3
- * positions — causing mark wrappers to be destroyed and recreated when widget
- * decorations (gap cursor, telepointers, block controls) shift indices beyond
- * that window. The destroyed mark wrappers take their React nodeviews with
- * them, causing visible flicker.
- *
- * By preserving identity here, we ensure `preMatch` succeeds for unchanged
- * subtrees, preventing unnecessary mark wrapper destruction and React nodeview
- * re-mounting.
- *
- * @param oldFragment - Fragment from the current editor state (holds existing node references)
- * @param newFragment - Fragment parsed from incoming document (fresh node objects)
- * @returns A Fragment that reuses old node references where possible
- *
- * @see https://hello.jira.atlassian.cloud/browse/EDITOR-5277
- * @see https://hello.jira.atlassian.cloud/browse/EDITOR-4424
- */
-export declare function preserveNodeIdentity(oldFragment: Fragment, newFragment: Fragment): Fragment;

package/dist/types-ts4.5/pm-plugins/track-and-filter-spamming-steps.d.ts

@@ -1,36 +0,0 @@
-import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
-import { PluginKey } from '@atlaskit/editor-prosemirror/state';
-import type { Transaction } from '@atlaskit/editor-prosemirror/state';
-import type { Step } from '@atlaskit/editor-prosemirror/transform';
-import type { TrackSpammingStepsMetadata } from '../types';
-export type RecentTransactionTimestamp = {
-    steps: Step[];
-    timestamp: number;
-};
-export type RecentTransactionTimestamps = Map<string, RecentTransactionTimestamp>;
-export type TrackFilteredTransaction = (tr: Transaction) => void;
-export type SanitizedFilteredStep = {
-    attr?: string;
-    markType?: string;
-    stepInstance?: string;
-    stepType: string;
-};
-/**
- * Sanitizes a given ProseMirror step by extracting its type and non-UCG relevant attributes.
- *
- * @param {Step} step - The ProseMirror step to be sanitized.
- * @returns {SanitizedFilteredStep} - The sanitized step with only necessary information.
- *
- * @example
- * ```
- * const step = new AttrStep(10, 'colwidth', [123, 451] );
- * const sanitized = sanitizeFilteredStep(step);
- *
- * // Output: { stepType: 'attr', stepInstance: 'AttrStep', attr: 'example' }
- * ```
- */
-export declare const sanitizeFilteredStep: (step: Step) => SanitizedFilteredStep;
-export declare const createFilterTransaction: (recentTransactionsTimestamps: RecentTransactionTimestamps, trackFilteredTransaction: TrackFilteredTransaction) => (tr: Transaction) => boolean;
-export declare function generateTransactionKey(tr: Transaction): string;
-export declare const trackSpammingStepsPluginKey: PluginKey<TrackSpammingStepsMetadata>;
-export declare const createPlugin: (trackFilteredTransaction: TrackFilteredTransaction) => SafePlugin<TrackSpammingStepsMetadata>;

package/dist/types-ts4.5/pm-plugins/track-last-organic-change.d.ts

@@ -1,5 +0,0 @@
-import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
-import { PluginKey } from '@atlaskit/editor-prosemirror/state';
-import type { LastOrganicChangeMetadata } from '../types';
-export declare const trackLastOrganicChangePluginKey: PluginKey<LastOrganicChangeMetadata>;
-export declare const createPlugin: () => SafePlugin<LastOrganicChangeMetadata>;

package/dist/types-ts4.5/pm-plugins/track-ncs-initialization.d.ts

@@ -1,5 +0,0 @@
-import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
-import { PluginKey } from '@atlaskit/editor-prosemirror/state';
-import type { CollabInitializedMetadata } from '../types';
-export declare const trackNCSInitializationPluginKey: PluginKey<CollabInitializedMetadata>;
-export declare const createPlugin: () => SafePlugin<CollabInitializedMetadata>;

package/dist/types-ts4.5/pm-plugins/track-reconnection-conflict.d.ts

@@ -1,5 +0,0 @@
-import type { CollabEventConflictPayload } from '@atlaskit/editor-common/collab';
-import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
-import { PluginKey } from '@atlaskit/editor-prosemirror/state';
-export declare const trackLastRemoteConflictPluginKey: PluginKey<CollabEventConflictPayload>;
-export declare const createPlugin: () => SafePlugin<CollabEventConflictPayload | undefined>;

package/dist/types-ts4.5/pm-plugins/track-step-metrics.d.ts

@@ -1,48 +0,0 @@
-import type { ExtractInjectionAPI } from '@atlaskit/editor-common/types';
-import type { Step } from '@atlaskit/editor-prosemirror/transform';
-import type { CollabEditPlugin } from '../collabEditPluginType';
-type StepSessionMetrics = {
-    maxStepSize: number;
-    numberOfSteps: number;
-    stepSizeSumForP90: number[];
-    totalStepSize: number;
-};
-/**
- * Gets the current step session metrics for a given session ID
- * If the session ID does not exist, it initializes a new metrics object.
- * It calculates the total size of the steps, the number of steps,
- * the maximum step size, and the sum of step sizes for P90 calculation.
- *
- * @param metrics - The existing metrics object from local storage.
- * @param sessionId - The session ID for which to get the metrics.
- * @param steps - The steps to calculate the metrics from.
- * @returns The updated step session metrics for the given session ID.
- */
-export declare const getNcsSessionStepMetrics: (metrics: {
-    [sessionId: string]: StepSessionMetrics;
-}, sessionId: string, steps: Step[]) => StepSessionMetrics;
-/**
- * Gets the current active sessions from local storage
- * If the session ID does not exist, it initializes a new active session.
- *
- * This is used in the ncsStepMetricsPlugin to determine if the session is still active
- * before sending the ncs steps analytics event.
- *
- * @param sessionId - The session ID to check or update in local storage.
- * @returns void
- */
-export declare const updateNcsActiveSessions: (sessionId: string) => void;
-type UpdateNcsSessionStepMetricProps = {
-    api: ExtractInjectionAPI<CollabEditPlugin> | undefined;
-    steps: Step[];
-};
-/**
- * Updates the step session metrics in local storage for a given session ID.
- * It calculates the metrics based on the provided steps and updates the storage.
- *
- * @param api - The API to access the collab edit plugin.
- * @param steps - The steps to calculate the metrics from.
- * @return void
- */
-export declare const updateNcsSessionStepMetrics: ({ api, steps, }: UpdateNcsSessionStepMetricProps) => void;
-export {};

package/dist/types-ts4.5/pm-plugins/track-steps.d.ts

@@ -1,81 +0,0 @@
-import type { ExtractInjectionAPI } from '@atlaskit/editor-common/types';
-import type { EditorState, Transaction } from '@atlaskit/editor-prosemirror/state';
-import type { Step } from '@atlaskit/editor-prosemirror/transform';
-import type { CollabEditPlugin } from '../collabEditPluginType';
-export type SanitizedStep = {
-    attr?: string;
-    markType?: string;
-    stepType: string;
-};
-export type StepMetadataAnalytics = {
-    endedAt: number;
-    startedAt: number;
-    stepTypesAmount: {
-        [key: string]: number;
-    };
-};
-/**
- * Sanitizes a given ProseMirror step by extracting its type and non-UCG relevant attributes.
- *
- * @param {Step} step - The ProseMirror step to be sanitized.
- * @returns {SanitizedStep} - The sanitized step with only necessary information.
- *
- * @example
- * ```
- * const step = new AttrStep(10, 'colwidth', [123, 451] );
- * const sanitized = sanitizeStep(step);
- *
- * // Output: { stepType: 'attr', attr: 'example' }
- * ```
- */
-export declare const sanitizeStep: (step: Step) => SanitizedStep;
-/**
- * Groups sanitized steps by their type and counts their occurrences.
- *
- * @param {SanitizedStep[]} sanitizedSteps - An array of sanitized steps.
- * @returns {Record<string, number>} - An object where keys are step types and values are their counts.
- *
- * @example
- * ```
- * const input = [
- *   { stepType: 'attr', attr: 'colwidth' },
- *   { stepType: 'mark', markType: 'bold' },
- *   { stepType: 'attr', attr: 'colwidth' }
- * ];
- *
- * const grouped = groupSteps(input);
- * // Output: { 'attr_example': 2, 'mark_bold': 1 }
- * ```
- */
-export declare const groupSteps: (sanitizedSteps: SanitizedStep[]) => Record<string, number>;
-/**
- * Processes the steps metadata from the cache and calls the callback function with the processed data.
- *
- * @param {CacheType} cache - A cache containing steps metadata.
- * @param {(data: StepMetadataAnalytics[]) => void} onTrackDataProcessed - Callback function to be called with the processed data.
- */
-export declare const task: (cache: CacheType, onTrackDataProcessed: (data: StepMetadataAnalytics[]) => void) => void;
-export type CacheType = Map<number, {
-    endedAt: number;
-    startedAt: number;
-    steps: ReadonlyArray<Step>;
-}>;
-type TrackProps = {
-    api: ExtractInjectionAPI<CollabEditPlugin> | undefined;
-    newEditorState: EditorState;
-    onTrackDataProcessed: (data: StepMetadataAnalytics[]) => void;
-    transactions: Readonly<Transaction[]>;
-};
-/**
- * Tracks the steps sent by the client by storing them in a cache and scheduling a task to process them. Once the steps are processed, the onTrackDataProcessed callabck will be called.
- *
- * This is a non-critical code. If the browser doesn't support the Scheduler API https://developer.mozilla.org/en-US/docs/Web/API/Scheduler/
- *
- * @param {TrackProps} props - The properties required for tracking steps.
- * @param {ExtractInjectionAPI<CollabEditPlugin> | undefined} props.api - The API for the CollabEdit plugin.
- * @param {EditorState} props.newEditorState - The new editor state.
- * @param {Readonly<Transaction[]>} props.transactions - The transactions that contain the steps.
- * @param {(data: StepMetadataAnalytics[]) => void} props.onTrackDataProcessed - Callback function to be called with the processed data.
- */
-export declare const track: ({ api, newEditorState, transactions, onTrackDataProcessed, }: TrackProps) => void;
-export {};

package/dist/types-ts4.5/pm-plugins/utils.d.ts

@@ -1,28 +0,0 @@
-import type { EditorAnalyticsAPI } from '@atlaskit/editor-common/analytics';
-import type { CollabEditOptions, CollabParticipant } from '@atlaskit/editor-common/collab';
-import { Transaction } from '@atlaskit/editor-prosemirror/state';
-import type { EditorState, ReadonlyTransaction } from '@atlaskit/editor-prosemirror/state';
-import { ReplaceStep } from '@atlaskit/editor-prosemirror/transform';
-import type { Step } from '@atlaskit/editor-prosemirror/transform';
-import type { DecorationSet, EditorView } from '@atlaskit/editor-prosemirror/view';
-import { Decoration } from '@atlaskit/editor-prosemirror/view';
-export declare const findPointers: (id: string, decorations: DecorationSet) => Decoration[];
-export declare function getAvatarColor(str: string): {
-    backgroundColor: string;
-    index: number;
-    textColor: string;
-};
-export declare const createTelepointers: (from: number, to: number, sessionId: string, isSelection: boolean, initial: string, presenceId: string, fullName: string, isNudged: boolean) => Decoration[];
-export declare const replaceDocument: (doc: any, state: EditorState, version?: number, options?: CollabEditOptions, reserveCursor?: boolean, editorAnalyticsAPI?: EditorAnalyticsAPI) => Transaction;
-export declare const scrollToCollabCursor: (editorView: EditorView, participants: CollabParticipant[], sessionId: string | undefined, index: number, editorAnalyticsAPI: EditorAnalyticsAPI | undefined) => void;
-export declare const getPositionOfTelepointer: (sessionId: string, decorationSet: DecorationSet) => undefined | number;
-export declare const isReplaceStep: (step: Step) => step is ReplaceStep;
-export declare const originalTransactionHasMeta: (transaction: Transaction | ReadonlyTransaction, metaTag: string) => boolean;
-/**
- * Takes the transaction and editor state and checks if the transaction is considered organic change
- * @param tr Transaction
- * @returns boolean
- */
-export declare const isOrganicChange: (tr: ReadonlyTransaction) => boolean;
-export type NudgeAnimationsMap = Map<string, number>;
-export declare const hasExistingNudge: (sessionId: string, nudgeAnimations: NudgeAnimationsMap) => boolean;

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

@@ -1,44 +0,0 @@
-import type { CollabEditOptions, CollabEditProvider, CollabEventConflictPayload, CollabParticipant, SyncUpErrorFunction } from '@atlaskit/editor-common/collab';
-import type { Transaction } from '@atlaskit/editor-prosemirror/state';
-import type { Step } from '@atlaskit/editor-prosemirror/transform';
-export type PrivateCollabEditOptions = CollabEditOptions & {
-    hideTelecursorOnLoad?: boolean;
-    onSyncUpError?: SyncUpErrorFunction;
-    sanitizePrivateContent?: boolean;
-};
-export type ProviderCallback = <ReturnType>(codeToExecute: (provider: CollabEditProvider) => ReturnType | undefined, onError?: (err: Error) => void) => Promise<ReturnType | undefined> | undefined;
-export type ProviderBuilder = (collabEditProviderPromise: Promise<CollabEditProvider>) => ProviderCallback;
-export interface ReadOnlyParticipants {
-    eq: (other: ReadOnlyParticipants) => boolean;
-    get: (sessionId: string) => CollabParticipant | undefined;
-    toArray: () => ReadonlyArray<CollabParticipant>;
-}
-export type CollabInitializedMetadata = {
-    collabInitialisedAt: null | number;
-    firstChangeAfterInitAt: null | number;
-    firstContentBodyChangeAfterInitAt: null | number;
-};
-export type LastOrganicChangeMetadata = {
-    lastLocalOrganicBodyChangeAt: null | number;
-    lastLocalOrganicChangeAt: null | number;
-    lastRemoteOrganicBodyChangeAt: null | number;
-    lastRemoteOrganicChangeAt: null | number;
-};
-export type TrackSpammingStepsMetadata = {
-    recentTransactionsTimestemps: Map<string, {
-        steps: Step[];
-        timestamp: number;
-    }>;
-};
-export type CollabSendableSteps = {
-    clientID: number | string;
-    origins: readonly Transaction[];
-    steps: readonly Step[];
-    version: number;
-};
-export type CollabEditPluginSharedState = {
-    activeParticipants: ReadOnlyParticipants | undefined;
-    initialised: CollabInitializedMetadata & LastOrganicChangeMetadata;
-    lastReconnectionConflictMetadata: CollabEventConflictPayload | undefined;
-    sessionId: string | undefined;
-};