@atlaskit/editor-plugin-collab-edit
Version:
Collab Edit plugin for @atlaskit/editor-core
15 lines (14 loc) • 1.38 kB
TypeScript
import type { AnalyticsEventPayload, EditorAnalyticsAPI } from '@atlaskit/editor-common/analytics';
import type { AgentEditShimmerNotShownReason } from '@atlaskit/editor-common/analytics/types/agent-edit-shimmer-events';
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;
/**
* Builds the `agentEditShimmerNotShown` operational event fired when an agent-authored edit applied
* instantly without the skeleton shimmer/telepointer. Success is the ABSENCE of this event; a
* neutral action + `reason` keeps expected degrades out of error dashboards. Attributes are non-PII:
* only the agent kind and a sanitised error name/message (never the raw Error or any doc content).
*/
export declare const getAgentEditShimmerNotShownPayload: (reason: AgentEditShimmerNotShownReason, agentType?: string, error?: Error) => AnalyticsEventPayload;
export type EntityEventType = 'error' | 'disconnected';
export declare const addSynchronyEntityAnalytics: (state: EditorState, tr: Transaction) => (type: EntityEventType, editorAnalyticsApi: EditorAnalyticsAPI | undefined) => Transaction;