@atlaskit/editor-common 93.4.2 → 93.4.4

package/dist/types/analytics/types/enums.d.ts

@@ -81,6 +81,7 @@ export declare enum ACTION {
     PASTED = "pasted",
     PASTED_AS_PLAIN = "pastedAsPlain",
     PASTED_TIMED = "pastedTimed",
+    PRESSED = "pressed",
     PROSEMIRROR_RENDERED = "proseMirrorRendered",
     REACT_NODEVIEW_RENDERED = "reactNodeViewRendered",
     REPLACED_ALL = "replacedAll",
@@ -218,11 +219,13 @@ export declare enum ACTION_SUBJECT {
     FLOATING_CONTEXTUAL_BUTTON = "floatingContextualButton",
     FLOATING_TOOLBAR_PLUGIN = "floatingToolbarPlugin",
     HELP = "help",
+    INVITE_ITEM = "inviteItem",
     LAYOUT = "layout",
     LIST = "list",
     MEDIA = "media",
     MEDIA_SINGLE = "mediaSingle",
     MENTION = "mention",
+    MENTION_TYPEAHEAD = "mentionTypeahead",
     NESTED_EXPAND = "nestedExpand",
     PANEL = "panel",
     PICKER = "picker",
@@ -235,6 +238,7 @@ export declare enum ACTION_SUBJECT {
     HYPERLINK = "hyperlink",
     TABLE = "table",
     TABLES_PLUGIN = "tablesPlugin",
+    TEAM_MENTION_TYPEAHEAD = "teamMentionTypeahead",
     TEXT = "text",
     TOOLBAR = "toolbar",
     TYPEAHEAD = "typeAhead",

package/dist/types/analytics/types/events.d.ts

@@ -26,6 +26,7 @@ import type { CreateLinkInlineDialogEventPayload, EditLinkToolbarAEP, OpenSettin
 import type { ListEventPayload } from './list-events';
 import type { LoomEventPayload } from './loom-events';
 import type { MediaEventPayload } from './media-events';
+import { type MentionEventPayload } from './mention-events';
 import type { MoveContentEventPayload } from './move-content-events';
 import type { NodeEventPayload } from './node-events';
 import type { PasteEventPayload } from './paste-events';
@@ -45,7 +46,7 @@ export type SimplifiedNode = {
     marks?: string[];
     content?: SimplifiedNode[];
 };
-export type AnalyticsEventPayload<T = void> = AvatarEventPayload | GeneralEventPayload<T> | FormatEventPayload | SubstituteEventPayload | InsertEventPayload | NodeEventPayload | MoveContentEventPayload | MediaEventPayload | TableEventPayload | PasteEventPayload | CutCopyEventPayload | ErrorEventPayload | ExperimentalEventPayload | FindReplaceEventPayload | DateEventPayload | SelectionEventPayload | ListEventPayload | ConfigPanelEventPayload | ElementBrowserEventPayload | CreateLinkInlineDialogEventPayload | HighlightActionsEventPayload | UnsupportedContentPayload | ExtensionEventPayload | TransactionEventPayload | TypeAheadPayload | UnlinkToolbarAEP | EditLinkToolbarAEP | OpenSettingsToolbarAEP | CustomPanelEventPayload | FeatureExposureAEP | NewCollabSyncUpErrorAEP | UnsupportedContentTooltipPayload | ReferentialityEventPayload | LoomEventPayload | MBEEventPayload | HighlightEventPayload | DatasourceClickedPayload | ElementEventPayload | ContextMenuEventPayload | VisitedLinkAEP | ViewEventPayload | MediaUploadEventPayload | EngagementPlatformEventPayload;
+export type AnalyticsEventPayload<T = void> = AvatarEventPayload | GeneralEventPayload<T> | FormatEventPayload | SubstituteEventPayload | InsertEventPayload | NodeEventPayload | MoveContentEventPayload | MediaEventPayload | TableEventPayload | PasteEventPayload | CutCopyEventPayload | ErrorEventPayload | ExperimentalEventPayload | FindReplaceEventPayload | DateEventPayload | SelectionEventPayload | ListEventPayload | ConfigPanelEventPayload | ElementBrowserEventPayload | CreateLinkInlineDialogEventPayload | HighlightActionsEventPayload | UnsupportedContentPayload | ExtensionEventPayload | TransactionEventPayload | TypeAheadPayload | UnlinkToolbarAEP | EditLinkToolbarAEP | OpenSettingsToolbarAEP | CustomPanelEventPayload | FeatureExposureAEP | NewCollabSyncUpErrorAEP | UnsupportedContentTooltipPayload | ReferentialityEventPayload | LoomEventPayload | MBEEventPayload | HighlightEventPayload | DatasourceClickedPayload | ElementEventPayload | ContextMenuEventPayload | VisitedLinkAEP | ViewEventPayload | MediaUploadEventPayload | MentionEventPayload | EngagementPlatformEventPayload;
 type CustomPanelEventPayload = TrackAEP<ACTION.CHANGED_BACKGROUND_COLOR | ACTION.CHANGED_ICON | ACTION.REMOVE_ICON, ACTION_SUBJECT.PANEL, ACTION_SUBJECT_ID.PANEL, {
     previousColor: string;
     newColor: string;

package/dist/types/analytics/types/mention-events.d.ts

@@ -0,0 +1,80 @@
+import { type ComponentNames, type Actions as MentionActions, type SliNames } from '@atlaskit/mention/types';
+import { type ACTION, type ACTION_SUBJECT, type ACTION_SUBJECT_ID } from './enums';
+import { type OperationalAEP, type UIAEP } from './utils';
+type MentionTypeaheadCancelledEventPayload = UIAEP<ACTION.CANCELLED, ACTION_SUBJECT.MENTION_TYPEAHEAD, undefined, {
+    componentName: string;
+    duration: number;
+    queryLength?: number;
+    spaceInQuery?: boolean;
+    upKeyCount: number;
+    downKeyCount: number;
+    sessionId: string;
+}, undefined>;
+type MentionTypeaheadInviteItemViewedPayload = UIAEP<ACTION.RENDERED, ACTION_SUBJECT.INVITE_ITEM, undefined, {
+    componentName: string;
+    containerId: string;
+    objectId: string;
+    childObjectId?: string;
+    userRole?: string;
+    sessionId: string;
+}, undefined>;
+type MentionTypeaheadInviteItemClickedPayload = UIAEP<ACTION.CLICKED | ACTION.PRESSED, ACTION_SUBJECT.INVITE_ITEM, undefined, {
+    componentName: string;
+    duration: number;
+    queryLength?: number;
+    spaceInQuery?: boolean;
+    upKeyCount: number;
+    downKeyCount: number;
+    containerId: string;
+    objectId: string;
+    childObjectId?: string;
+    userRole?: string;
+    sessionId: string;
+    keyboardKey?: string;
+}, undefined>;
+type MentionTypeaheadInsertedPayload = UIAEP<ACTION.CLICKED | ACTION.PRESSED, ACTION_SUBJECT.MENTION_TYPEAHEAD, undefined, {
+    sessionId: string;
+    duration: number;
+    position?: number;
+    keyboardKey?: string;
+    source?: string;
+    queryLength?: number;
+    spaceInQuery?: boolean;
+    isSpecial: boolean;
+    accessLevel: string;
+    userType?: string;
+    userId: string;
+    upKeyCount: number;
+    downKeyCount: number;
+    memberCount?: number | null;
+    includesYou?: boolean | null;
+    taskListId?: string;
+    taskItemId?: string;
+    localId?: string;
+    containerId?: string;
+    objectId?: string;
+    childObjectId?: string;
+}, undefined>;
+type MentionTypeaheadRenderedPayload = OperationalAEP<ACTION.RENDERED, ACTION_SUBJECT.MENTION_TYPEAHEAD | ACTION_SUBJECT.TEAM_MENTION_TYPEAHEAD, undefined, {
+    componentName: string;
+    duration: number;
+    userIds: Array<string> | null;
+    teams: Array<{
+        teamId: string;
+        includesYou: boolean;
+        memberCount: number;
+    }> | null;
+    queryLength?: number;
+    spaceInQuery?: boolean;
+}>;
+type MentionProviderErroredPayload = OperationalAEP<ACTION.ERRORED, ACTION_SUBJECT.MENTION, ACTION_SUBJECT_ID.MENTION_PROVIDER, {
+    reason: string;
+}>;
+export type MentionAttributes = {
+    [key: string]: string;
+};
+type MentionSliEventPayload = OperationalAEP<MentionActions, ComponentNames | SliNames, undefined, {
+    componentName: string;
+} & MentionAttributes>;
+export type MentionEventPayload = MentionTypeaheadCancelledEventPayload | MentionTypeaheadInviteItemViewedPayload | MentionTypeaheadInviteItemClickedPayload | MentionTypeaheadInsertedPayload | MentionTypeaheadRenderedPayload | MentionProviderErroredPayload | MentionSliEventPayload;
+export {};

package/dist/types/ui/EditorContext/index.d.ts

@@ -0,0 +1,2 @@
+import React from "react";
+export declare const EditorContext: React.Context<{}>;

package/dist/types/with-plugin-state/index.d.ts

@@ -73,7 +73,41 @@ export interface Props<P extends NamedPluginKeys> {
  * ```
  *
  */
-declare class WithPluginState<P extends NamedPluginKeys> extends React.Component<Props<P>, State> {
+declare class WithPluginState<P extends NamedPluginKeys> extends React.Component<WithPluginStateInnerProps<P>, State> {
+    constructor(props: WithPluginStateInnerProps<P>);
+    render(): JSX.Element;
+}
+type WithPluginStateInnerProps<P extends NamedPluginKeys> = Props<P> & {
+    editorActions?: EditorActionsPrivateAccess;
+};
+export declare class WithPluginStateInner<P extends NamedPluginKeys> extends React.Component<WithPluginStateInnerProps<P>, State> {
+    static displayName: string;
+    private listeners;
+    private debounce;
+    private notAppliedState;
+    private isSubscribed;
+    private callsCount;
+    state: NamedPluginStates<P>;
+    constructor(props: Props<P>);
+    private getEditorView;
+    private getEventDispatcher;
+    private handlePluginStateChange;
+    /**
+     * Debounces setState calls in order to reduce number of re-renders caused by several plugin state changes.
+     */
+    private updateState;
+    private dispatchAnalyticsEvent;
+    private getPluginsStates;
+    private subscribe;
+    private unsubscribe;
+    private subscribeToContextUpdates;
+    private unsubscribeFromContextUpdates;
+    componentDidMount(): void;
+    UNSAFE_componentWillReceiveProps(nextProps: Props<P>): void;
+    componentWillUnmount(): void;
+    render(): React.ReactElement<any, string | React.JSXElementConstructor<any>> | null;
+}
+export declare class WithPluginStateOld<P extends NamedPluginKeys> extends React.Component<Props<P>, State> {
     static displayName: string;
     private listeners;
     private debounce;

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

@@ -81,6 +81,7 @@ export declare enum ACTION {
     PASTED = "pasted",
     PASTED_AS_PLAIN = "pastedAsPlain",
     PASTED_TIMED = "pastedTimed",
+    PRESSED = "pressed",
     PROSEMIRROR_RENDERED = "proseMirrorRendered",
     REACT_NODEVIEW_RENDERED = "reactNodeViewRendered",
     REPLACED_ALL = "replacedAll",
@@ -218,11 +219,13 @@ export declare enum ACTION_SUBJECT {
     FLOATING_CONTEXTUAL_BUTTON = "floatingContextualButton",
     FLOATING_TOOLBAR_PLUGIN = "floatingToolbarPlugin",
     HELP = "help",
+    INVITE_ITEM = "inviteItem",
     LAYOUT = "layout",
     LIST = "list",
     MEDIA = "media",
     MEDIA_SINGLE = "mediaSingle",
     MENTION = "mention",
+    MENTION_TYPEAHEAD = "mentionTypeahead",
     NESTED_EXPAND = "nestedExpand",
     PANEL = "panel",
     PICKER = "picker",
@@ -235,6 +238,7 @@ export declare enum ACTION_SUBJECT {
     HYPERLINK = "hyperlink",
     TABLE = "table",
     TABLES_PLUGIN = "tablesPlugin",
+    TEAM_MENTION_TYPEAHEAD = "teamMentionTypeahead",
     TEXT = "text",
     TOOLBAR = "toolbar",
     TYPEAHEAD = "typeAhead",

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

@@ -26,6 +26,7 @@ import type { CreateLinkInlineDialogEventPayload, EditLinkToolbarAEP, OpenSettin
 import type { ListEventPayload } from './list-events';
 import type { LoomEventPayload } from './loom-events';
 import type { MediaEventPayload } from './media-events';
+import { type MentionEventPayload } from './mention-events';
 import type { MoveContentEventPayload } from './move-content-events';
 import type { NodeEventPayload } from './node-events';
 import type { PasteEventPayload } from './paste-events';
@@ -45,7 +46,7 @@ export type SimplifiedNode = {
     marks?: string[];
     content?: SimplifiedNode[];
 };
-export type AnalyticsEventPayload<T = void> = AvatarEventPayload | GeneralEventPayload<T> | FormatEventPayload | SubstituteEventPayload | InsertEventPayload | NodeEventPayload | MoveContentEventPayload | MediaEventPayload | TableEventPayload | PasteEventPayload | CutCopyEventPayload | ErrorEventPayload | ExperimentalEventPayload | FindReplaceEventPayload | DateEventPayload | SelectionEventPayload | ListEventPayload | ConfigPanelEventPayload | ElementBrowserEventPayload | CreateLinkInlineDialogEventPayload | HighlightActionsEventPayload | UnsupportedContentPayload | ExtensionEventPayload | TransactionEventPayload | TypeAheadPayload | UnlinkToolbarAEP | EditLinkToolbarAEP | OpenSettingsToolbarAEP | CustomPanelEventPayload | FeatureExposureAEP | NewCollabSyncUpErrorAEP | UnsupportedContentTooltipPayload | ReferentialityEventPayload | LoomEventPayload | MBEEventPayload | HighlightEventPayload | DatasourceClickedPayload | ElementEventPayload | ContextMenuEventPayload | VisitedLinkAEP | ViewEventPayload | MediaUploadEventPayload | EngagementPlatformEventPayload;
+export type AnalyticsEventPayload<T = void> = AvatarEventPayload | GeneralEventPayload<T> | FormatEventPayload | SubstituteEventPayload | InsertEventPayload | NodeEventPayload | MoveContentEventPayload | MediaEventPayload | TableEventPayload | PasteEventPayload | CutCopyEventPayload | ErrorEventPayload | ExperimentalEventPayload | FindReplaceEventPayload | DateEventPayload | SelectionEventPayload | ListEventPayload | ConfigPanelEventPayload | ElementBrowserEventPayload | CreateLinkInlineDialogEventPayload | HighlightActionsEventPayload | UnsupportedContentPayload | ExtensionEventPayload | TransactionEventPayload | TypeAheadPayload | UnlinkToolbarAEP | EditLinkToolbarAEP | OpenSettingsToolbarAEP | CustomPanelEventPayload | FeatureExposureAEP | NewCollabSyncUpErrorAEP | UnsupportedContentTooltipPayload | ReferentialityEventPayload | LoomEventPayload | MBEEventPayload | HighlightEventPayload | DatasourceClickedPayload | ElementEventPayload | ContextMenuEventPayload | VisitedLinkAEP | ViewEventPayload | MediaUploadEventPayload | MentionEventPayload | EngagementPlatformEventPayload;
 type CustomPanelEventPayload = TrackAEP<ACTION.CHANGED_BACKGROUND_COLOR | ACTION.CHANGED_ICON | ACTION.REMOVE_ICON, ACTION_SUBJECT.PANEL, ACTION_SUBJECT_ID.PANEL, {
     previousColor: string;
     newColor: string;

package/dist/types-ts4.5/analytics/types/mention-events.d.ts

@@ -0,0 +1,80 @@
+import { type ComponentNames, type Actions as MentionActions, type SliNames } from '@atlaskit/mention/types';
+import { type ACTION, type ACTION_SUBJECT, type ACTION_SUBJECT_ID } from './enums';
+import { type OperationalAEP, type UIAEP } from './utils';
+type MentionTypeaheadCancelledEventPayload = UIAEP<ACTION.CANCELLED, ACTION_SUBJECT.MENTION_TYPEAHEAD, undefined, {
+    componentName: string;
+    duration: number;
+    queryLength?: number;
+    spaceInQuery?: boolean;
+    upKeyCount: number;
+    downKeyCount: number;
+    sessionId: string;
+}, undefined>;
+type MentionTypeaheadInviteItemViewedPayload = UIAEP<ACTION.RENDERED, ACTION_SUBJECT.INVITE_ITEM, undefined, {
+    componentName: string;
+    containerId: string;
+    objectId: string;
+    childObjectId?: string;
+    userRole?: string;
+    sessionId: string;
+}, undefined>;
+type MentionTypeaheadInviteItemClickedPayload = UIAEP<ACTION.CLICKED | ACTION.PRESSED, ACTION_SUBJECT.INVITE_ITEM, undefined, {
+    componentName: string;
+    duration: number;
+    queryLength?: number;
+    spaceInQuery?: boolean;
+    upKeyCount: number;
+    downKeyCount: number;
+    containerId: string;
+    objectId: string;
+    childObjectId?: string;
+    userRole?: string;
+    sessionId: string;
+    keyboardKey?: string;
+}, undefined>;
+type MentionTypeaheadInsertedPayload = UIAEP<ACTION.CLICKED | ACTION.PRESSED, ACTION_SUBJECT.MENTION_TYPEAHEAD, undefined, {
+    sessionId: string;
+    duration: number;
+    position?: number;
+    keyboardKey?: string;
+    source?: string;
+    queryLength?: number;
+    spaceInQuery?: boolean;
+    isSpecial: boolean;
+    accessLevel: string;
+    userType?: string;
+    userId: string;
+    upKeyCount: number;
+    downKeyCount: number;
+    memberCount?: number | null;
+    includesYou?: boolean | null;
+    taskListId?: string;
+    taskItemId?: string;
+    localId?: string;
+    containerId?: string;
+    objectId?: string;
+    childObjectId?: string;
+}, undefined>;
+type MentionTypeaheadRenderedPayload = OperationalAEP<ACTION.RENDERED, ACTION_SUBJECT.MENTION_TYPEAHEAD | ACTION_SUBJECT.TEAM_MENTION_TYPEAHEAD, undefined, {
+    componentName: string;
+    duration: number;
+    userIds: Array<string> | null;
+    teams: Array<{
+        teamId: string;
+        includesYou: boolean;
+        memberCount: number;
+    }> | null;
+    queryLength?: number;
+    spaceInQuery?: boolean;
+}>;
+type MentionProviderErroredPayload = OperationalAEP<ACTION.ERRORED, ACTION_SUBJECT.MENTION, ACTION_SUBJECT_ID.MENTION_PROVIDER, {
+    reason: string;
+}>;
+export type MentionAttributes = {
+    [key: string]: string;
+};
+type MentionSliEventPayload = OperationalAEP<MentionActions, ComponentNames | SliNames, undefined, {
+    componentName: string;
+} & MentionAttributes>;
+export type MentionEventPayload = MentionTypeaheadCancelledEventPayload | MentionTypeaheadInviteItemViewedPayload | MentionTypeaheadInviteItemClickedPayload | MentionTypeaheadInsertedPayload | MentionTypeaheadRenderedPayload | MentionProviderErroredPayload | MentionSliEventPayload;
+export {};

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

@@ -0,0 +1,2 @@
+import React from "react";
+export declare const EditorContext: React.Context<{}>;

package/dist/types-ts4.5/with-plugin-state/index.d.ts

@@ -73,7 +73,41 @@ export interface Props<P extends NamedPluginKeys> {
  * ```
  *
  */
-declare class WithPluginState<P extends NamedPluginKeys> extends React.Component<Props<P>, State> {
+declare class WithPluginState<P extends NamedPluginKeys> extends React.Component<WithPluginStateInnerProps<P>, State> {
+    constructor(props: WithPluginStateInnerProps<P>);
+    render(): JSX.Element;
+}
+type WithPluginStateInnerProps<P extends NamedPluginKeys> = Props<P> & {
+    editorActions?: EditorActionsPrivateAccess;
+};
+export declare class WithPluginStateInner<P extends NamedPluginKeys> extends React.Component<WithPluginStateInnerProps<P>, State> {
+    static displayName: string;
+    private listeners;
+    private debounce;
+    private notAppliedState;
+    private isSubscribed;
+    private callsCount;
+    state: NamedPluginStates<P>;
+    constructor(props: Props<P>);
+    private getEditorView;
+    private getEventDispatcher;
+    private handlePluginStateChange;
+    /**
+     * Debounces setState calls in order to reduce number of re-renders caused by several plugin state changes.
+     */
+    private updateState;
+    private dispatchAnalyticsEvent;
+    private getPluginsStates;
+    private subscribe;
+    private unsubscribe;
+    private subscribeToContextUpdates;
+    private unsubscribeFromContextUpdates;
+    componentDidMount(): void;
+    UNSAFE_componentWillReceiveProps(nextProps: Props<P>): void;
+    componentWillUnmount(): void;
+    render(): React.ReactElement<any, string | React.JSXElementConstructor<any>> | null;
+}
+export declare class WithPluginStateOld<P extends NamedPluginKeys> extends React.Component<Props<P>, State> {
     static displayName: string;
     private listeners;
     private debounce;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-common",
-	"version": "93.4.2",
+	"version": "93.4.4",
 	"description": "A package that contains common classes and components for editor and renderer",
 	"publishConfig": {
 		"registry": "https://registry.npmjs.org/"
@@ -105,7 +105,8 @@
 		"./intl-error-boundary": "./src/ui/IntlErrorBoundary/index.tsx",
 		"./code-block": "./src/code-block/index.ts",
 		"./table": "./src/table/index.ts",
-		"./lazy-node-view": "./src/lazy-node-view/index.ts"
+		"./lazy-node-view": "./src/lazy-node-view/index.ts",
+		"./UNSAFE_do_not_use_editor_context": "./src/ui/EditorContext/index.ts"
 	},
 	"dependencies": {
 		"@atlaskit/activity-provider": "^2.4.0",