@atlaskit/editor-common 133.2.0 → 133.4.0

package/CHANGELOG.md

@@ -1,5 +1,28 @@
 # @atlaskit/editor-common
 
+## 133.4.0
+
+### Minor Changes
+
+- [`f268dee2526f7`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/f268dee2526f7) -
+  Migrate Smart Card registration and removal from transactions to editor actions behind
+  `platform_editor_reduce_forced_layout_2`. Remove unused card overlay registration behind
+  `platform_editor_reduce_forced_layout_2`.
+
+## 133.3.0
+
+### Minor Changes
+
+- [`53facf8e5239c`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/53facf8e5239c) -
+  Add comment target attribution to editor thread opens and toolbar screen events behind
+  cc_maui_annotations_on_extensions.
+
+  Add a shared analytics payload type for the inline comment toolbar screen event.
+
+### Patch Changes
+
+- Updated dependencies
+
 ## 133.2.0
 
 ### Minor Changes

package/dist/cjs/analytics/types/enums.js

@@ -366,6 +366,7 @@ var ACTION_SUBJECT = exports.ACTION_SUBJECT = /*#__PURE__*/function (ACTION_SUBJ
   ACTION_SUBJECT["TYPEAHEAD"] = "typeAhead";
   ACTION_SUBJECT["TYPEAHEAD_ITEM"] = "typeAheadItem";
   ACTION_SUBJECT["ANNOTATION"] = "annotation";
+  ACTION_SUBJECT["INLINE_COMMENT_TOOLBAR"] = "inlineCommentToolbar";
   ACTION_SUBJECT["SEARCH_RESULT"] = "searchResult";
   ACTION_SUBJECT["CREATE_LINK_INLINE_DIALOG"] = "createLinkInlineDialog";
   ACTION_SUBJECT["CODE_BLOCK"] = "codeBlock";

package/dist/cjs/monitoring/error.js

@@ -27,7 +27,7 @@ var NETWORK_FAILURE_REGEX = /^network failure/i;
 var RESIZE_OBSERVER_LOOP_REGEX = /ResizeObserver loop completed with undelivered notifications/;
 var SENTRY_DSN = 'https://0b10c8e02fb44d8796c047b102c9bee8@o55978.ingest.sentry.io/4505129224110080';
 var packageName = 'editor-common'; // Sentry doesn't accept '/' in its releases https://docs.sentry.io/platforms/javascript/configuration/releases/
-var packageVersion = "133.1.1";
+var packageVersion = "133.4.0";
 var sanitiseSentryEvents = function sanitiseSentryEvents(data, _hint) {
   // Remove URL as it has UGC
   // Ignored via go/ees007

package/dist/cjs/ui/DropList/index.js

@@ -23,7 +23,7 @@ function _isNativeReflectConstruct() { try { var t = !Boolean.prototype.valueOf.
  * @jsx jsx
  */ // eslint-disable-next-line @atlaskit/ui-styling-standard/use-compiled -- Ignored via go/DSP-18766
 var packageName = "@atlaskit/editor-common";
-var packageVersion = "133.1.1";
+var packageVersion = "133.4.0";
 var halfFocusRing = 1;
 var dropOffset = '0, 8';
 // Ignored via go/ees005

package/dist/es2019/analytics/types/enums.js

@@ -372,6 +372,7 @@ export let ACTION_SUBJECT = /*#__PURE__*/function (ACTION_SUBJECT) {
   ACTION_SUBJECT["TYPEAHEAD"] = "typeAhead";
   ACTION_SUBJECT["TYPEAHEAD_ITEM"] = "typeAheadItem";
   ACTION_SUBJECT["ANNOTATION"] = "annotation";
+  ACTION_SUBJECT["INLINE_COMMENT_TOOLBAR"] = "inlineCommentToolbar";
   ACTION_SUBJECT["SEARCH_RESULT"] = "searchResult";
   ACTION_SUBJECT["CREATE_LINK_INLINE_DIALOG"] = "createLinkInlineDialog";
   ACTION_SUBJECT["CODE_BLOCK"] = "codeBlock";

package/dist/es2019/monitoring/error.js

@@ -13,7 +13,7 @@ const NETWORK_FAILURE_REGEX = /^network failure/i;
 const RESIZE_OBSERVER_LOOP_REGEX = /ResizeObserver loop completed with undelivered notifications/;
 const SENTRY_DSN = 'https://0b10c8e02fb44d8796c047b102c9bee8@o55978.ingest.sentry.io/4505129224110080';
 const packageName = 'editor-common'; // Sentry doesn't accept '/' in its releases https://docs.sentry.io/platforms/javascript/configuration/releases/
-const packageVersion = "133.1.1";
+const packageVersion = "133.4.0";
 const sanitiseSentryEvents = (data, _hint) => {
   // Remove URL as it has UGC
   // Ignored via go/ees007

package/dist/es2019/ui/DropList/index.js

@@ -13,7 +13,7 @@ import withAnalyticsContext from '@atlaskit/analytics-next/withAnalyticsContext'
 import withAnalyticsEvents from '@atlaskit/analytics-next/withAnalyticsEvents';
 import Layer from '../Layer';
 const packageName = "@atlaskit/editor-common";
-const packageVersion = "133.1.1";
+const packageVersion = "133.4.0";
 const halfFocusRing = 1;
 const dropOffset = '0, 8';
 // Ignored via go/ees005

package/dist/esm/analytics/types/enums.js

@@ -372,6 +372,7 @@ export var ACTION_SUBJECT = /*#__PURE__*/function (ACTION_SUBJECT) {
   ACTION_SUBJECT["TYPEAHEAD"] = "typeAhead";
   ACTION_SUBJECT["TYPEAHEAD_ITEM"] = "typeAheadItem";
   ACTION_SUBJECT["ANNOTATION"] = "annotation";
+  ACTION_SUBJECT["INLINE_COMMENT_TOOLBAR"] = "inlineCommentToolbar";
   ACTION_SUBJECT["SEARCH_RESULT"] = "searchResult";
   ACTION_SUBJECT["CREATE_LINK_INLINE_DIALOG"] = "createLinkInlineDialog";
   ACTION_SUBJECT["CODE_BLOCK"] = "codeBlock";

package/dist/esm/monitoring/error.js

@@ -19,7 +19,7 @@ var NETWORK_FAILURE_REGEX = /^network failure/i;
 var RESIZE_OBSERVER_LOOP_REGEX = /ResizeObserver loop completed with undelivered notifications/;
 var SENTRY_DSN = 'https://0b10c8e02fb44d8796c047b102c9bee8@o55978.ingest.sentry.io/4505129224110080';
 var packageName = 'editor-common'; // Sentry doesn't accept '/' in its releases https://docs.sentry.io/platforms/javascript/configuration/releases/
-var packageVersion = "133.1.1";
+var packageVersion = "133.4.0";
 var sanitiseSentryEvents = function sanitiseSentryEvents(data, _hint) {
   // Remove URL as it has UGC
   // Ignored via go/ees007

package/dist/esm/ui/DropList/index.js

@@ -20,7 +20,7 @@ import withAnalyticsContext from '@atlaskit/analytics-next/withAnalyticsContext'
 import withAnalyticsEvents from '@atlaskit/analytics-next/withAnalyticsEvents';
 import Layer from '../Layer';
 var packageName = "@atlaskit/editor-common";
-var packageVersion = "133.1.1";
+var packageVersion = "133.4.0";
 var halfFocusRing = 1;
 var dropOffset = '0, 8';
 // Ignored via go/ees005

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

@@ -350,6 +350,7 @@ export declare enum ACTION_SUBJECT {
     TYPEAHEAD = "typeAhead",
     TYPEAHEAD_ITEM = "typeAheadItem",
     ANNOTATION = "annotation",
+    INLINE_COMMENT_TOOLBAR = "inlineCommentToolbar",
     SEARCH_RESULT = "searchResult",
     CREATE_LINK_INLINE_DIALOG = "createLinkInlineDialog",
     CODE_BLOCK = "codeBlock",

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

@@ -39,6 +39,7 @@ import type { FormatEventPayload } from './format-events';
 import type { GeneralEventPayload } from './general-events';
 import type { HighlightActionsEventPayload } from './highlight-actions-menu-events';
 import type { HighlightEventPayload } from './highlight-events';
+import type { InlineCommentToolbarViewedAEP } from './inline-comment-events';
 import type { InsertEventPayload } from './insert-events';
 import type { VisitedLinkAEP } from './link-events';
 import type { CreateLinkInlineDialogEventPayload, EditLinkToolbarAEP, OpenLinkToolbarAEP, PreviewItemClickedAEP, OpenSettingsToolbarAEP, UnlinkToolbarAEP } from './link-tool-bar-events';
@@ -74,7 +75,7 @@ export type SimplifiedNode = {
     pos: number;
     type: string;
 };
-export type AnalyticsEventPayload<T = void> = AvatarEventPayload | GeneralEventPayload<T> | FormatEventPayload | SubstituteEventPayload | InsertEventPayload | NodeEventPayload | MoveContentEventPayload | MediaEventPayload | TableEventPayload | PasteEventPayload | PasteActionsMenuEventPayload | QuickInsertInformationEventPayload | QuickInsertSearchOutcomeEventPayload | CutCopyEventPayload | ErrorEventPayload | TextColorEventPayload | FindReplaceEventPayload | DateEventPayload | SelectionEventPayload | ListEventPayload | ConfigPanelEventPayload | ElementBrowserEventPayload | CreateLinkInlineDialogEventPayload | HighlightActionsEventPayload | UnsupportedContentPayload | ExtensionEventPayload | TypeAheadPayload | UnlinkToolbarAEP | EditLinkToolbarAEP | PreviewItemClickedAEP | OpenLinkToolbarAEP | OpenSettingsToolbarAEP | CustomPanelEventPayload | FeatureExposureAEP | NewCollabSyncUpErrorAEP | UnsupportedContentTooltipPayload | ReferentialityEventPayload | LoomEventPayload | MBEEventPayload | HighlightEventPayload | DatasourceClickedPayload | ElementEventPayload | VisitedLinkAEP | ViewEventPayload | MediaUploadEventPayload | MentionEventPayload | EngagementPlatformEventPayload | NestedTableActionsEventPayload | ContainerNodeActionsEventPayload | AICommandPaletteEventPayload | AIDefinitionsEventPayload | AIEventPayload | AIStreamingEventPayload | AIProactiveEventPayload | AiAutocompleteEventPayload | AiSuggestionsEventPayload | ContextualTypeaheadEventPayload | AIQuickPromptEventPayload | AIUnifiedEventPayload | BreakoutEventPayload | BlockMenuEventPayload | ActiveSessionEventPayload | AIInlineSuggestionPayload | SelectionExtensionEventPayload | TelepointerClickPayload | SelectionToolbarEventPayload | ExperienceEventPayload | AlignmentEventPayload | UndoRedoAEP | OfflineEditingEventPayload | AgentEditShimmerNotShownAEP | FloatingToolbarOverflowEventPayload | SyncBlockEventPayload | NumberedHeadingsEventPayload | FloatingToolbarEventPayload;
+export type AnalyticsEventPayload<T = void> = InlineCommentToolbarViewedAEP | AvatarEventPayload | GeneralEventPayload<T> | FormatEventPayload | SubstituteEventPayload | InsertEventPayload | NodeEventPayload | MoveContentEventPayload | MediaEventPayload | TableEventPayload | PasteEventPayload | PasteActionsMenuEventPayload | QuickInsertInformationEventPayload | QuickInsertSearchOutcomeEventPayload | CutCopyEventPayload | ErrorEventPayload | TextColorEventPayload | FindReplaceEventPayload | DateEventPayload | SelectionEventPayload | ListEventPayload | ConfigPanelEventPayload | ElementBrowserEventPayload | CreateLinkInlineDialogEventPayload | HighlightActionsEventPayload | UnsupportedContentPayload | ExtensionEventPayload | TypeAheadPayload | UnlinkToolbarAEP | EditLinkToolbarAEP | PreviewItemClickedAEP | OpenLinkToolbarAEP | OpenSettingsToolbarAEP | CustomPanelEventPayload | FeatureExposureAEP | NewCollabSyncUpErrorAEP | UnsupportedContentTooltipPayload | ReferentialityEventPayload | LoomEventPayload | MBEEventPayload | HighlightEventPayload | DatasourceClickedPayload | ElementEventPayload | VisitedLinkAEP | ViewEventPayload | MediaUploadEventPayload | MentionEventPayload | EngagementPlatformEventPayload | NestedTableActionsEventPayload | ContainerNodeActionsEventPayload | AICommandPaletteEventPayload | AIDefinitionsEventPayload | AIEventPayload | AIStreamingEventPayload | AIProactiveEventPayload | AiAutocompleteEventPayload | AiSuggestionsEventPayload | ContextualTypeaheadEventPayload | AIQuickPromptEventPayload | AIUnifiedEventPayload | BreakoutEventPayload | BlockMenuEventPayload | ActiveSessionEventPayload | AIInlineSuggestionPayload | SelectionExtensionEventPayload | TelepointerClickPayload | SelectionToolbarEventPayload | ExperienceEventPayload | AlignmentEventPayload | UndoRedoAEP | OfflineEditingEventPayload | AgentEditShimmerNotShownAEP | FloatingToolbarOverflowEventPayload | SyncBlockEventPayload | NumberedHeadingsEventPayload | FloatingToolbarEventPayload;
 type CustomPanelEventPayload = TrackAEP<ACTION.CHANGED_BACKGROUND_COLOR | ACTION.CHANGED_ICON | ACTION.REMOVE_ICON, ACTION_SUBJECT.PANEL, ACTION_SUBJECT_ID.PANEL, {
     newColor: string;
     previousColor: string;

package/dist/types/analytics/types/inline-comment-events.d.ts

@@ -1,5 +1,12 @@
 import type { ACTION, ACTION_SUBJECT, ACTION_SUBJECT_ID, INPUT_METHOD } from './enums';
-import type { OperationalAEP, TrackAEP } from './utils';
+import type { OperationalAEP, ScreenAEP, TrackAEP } from './utils';
+export type InlineCommentToolbarViewedAEP = ScreenAEP<ACTION.VIEWED, ACTION_SUBJECT.INLINE_COMMENT_TOOLBAR, undefined, {
+    commentTargetType: string | undefined;
+    hasExistingComments: boolean;
+    isCommentButtonEnabled: boolean;
+}, undefined> & {
+    name: 'inlineCommentToolbar';
+};
 export type AnnotationActionType = ACTION.INSERTED | ACTION.CLOSED | ACTION.EDITED | ACTION.DELETED | ACTION.OPENED | ACTION.RESOLVED | ACTION.VIEWED;
 export type AnnotationErrorAEP = OperationalAEP<ACTION.ERROR, ACTION_SUBJECT.ANNOTATION, ACTION_SUBJECT_ID.INLINE_COMMENT, {
     errorReason?: string;

package/dist/types/card/types.d.ts

@@ -79,7 +79,19 @@ export interface EmbedCardTransformers {
     createEmbedCardTransformCommand: CreateEmbedCardTransformCommand;
     embedCardNodeTransformer: EmbedCardNodeTransformer;
 }
+/** Resolved card metadata and its live node-view position getter. */
+export type CardRegistration = {
+    /** Read the node view's current position after document edits. */
+    getPos: () => number | undefined;
+    id: string;
+    title?: string;
+    url?: string;
+};
+/** Immutable registrations keyed by card ID. */
+export type CardRegistrations = Readonly<Record<string, Readonly<CardRegistration>>>;
 export type CardPluginActions = {
+    /** Returns current registrations keyed by card ID. */
+    getCardRegistrations: () => CardRegistrations;
     getEndingToolbarItems: GetEndingToolbarItems;
     getStartingToolbarItems: GetStartingToolbarItems;
     hideLinkToolbar: HideLinkToolbarAction;
@@ -94,7 +106,9 @@ export type CardPluginActions = {
      * `queueCardsFromChangedTr` when unavailable.
      */
     queueCardsFromRange?: QueueCardsFromRangeAction;
+    registerCard: (info: CardRegistration) => void;
     registerEmbedCardTransformer: (transformers: EmbedCardTransformers) => void;
+    removeRegisteredCard: (id: string) => void;
     /**
      * Resolves a URL via the Object Resolver Service and returns the canonical
      * expanded URL. Useful for expanding Confluence short-link URLs
@@ -105,4 +119,5 @@ export type CardPluginActions = {
      */
     resolveShortLinkUrl: (url: string) => Promise<string | undefined>;
     setProvider: (provider: Promise<CardProvider>) => Promise<boolean>;
+    subscribeToCardRegistry: (listener: () => void) => () => void;
 };

package/dist/types/types/floating-toolbar.d.ts

@@ -142,6 +142,8 @@ export type FloatingToolbarButton<T extends object> = {
     confirmDialog?: ConfirmDialogOptions | (() => ConfirmDialogOptions);
     disabled?: boolean;
     focusEditoronEnter?: boolean;
+    /** Keep the tooltip open when the button is pressed. Set it when a press changes the tooltip content. */
+    hasNewContentOnTriggerClick?: boolean;
     hidden?: boolean;
     hideTooltipOnClick?: boolean;
     href?: string;
@@ -164,8 +166,6 @@ export type FloatingToolbarButton<T extends object> = {
     /** If true, the component will have pulse onboarding effect around it. */
     pulse?: boolean;
     selected?: boolean;
-    /** Keep the tooltip open when the button is pressed. Set it when a press changes the tooltip content. */
-    hasNewContentOnTriggerClick?: boolean;
     showTitle?: boolean;
     supportsViewMode?: boolean;
     tabIndex?: number | null | undefined;
@@ -340,6 +340,11 @@ export interface FloatingToolbarConfig {
      * behind it. Defaults to `'default'` (the wrapper's surface, as today).
      */
     containerSurface?: 'default' | 'none';
+    /** Refresh items when data outside EditorState changes. Snapshots must be stable between updates. */
+    externalStore?: {
+        getSnapshot: () => unknown;
+        subscribe: (listener: () => void) => () => void;
+    };
     /**
      * Enable Popup component's focus trap
      */

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-common",
-	"version": "133.2.0",
+	"version": "133.4.0",
 	"description": "A package that contains common classes and components for editor and renderer",
 	"publishConfig": {
 		"registry": "https://registry.npmjs.org/"
@@ -45,7 +45,7 @@
 		"@atlaskit/editor-json-transformer": "^10.0.0",
 		"@atlaskit/editor-palette": "^3.5.0",
 		"@atlaskit/editor-prosemirror": "^9.0.0",
-		"@atlaskit/editor-shared-styles": "^4.5.0",
+		"@atlaskit/editor-shared-styles": "^4.6.0",
 		"@atlaskit/editor-tables": "^3.2.0",
 		"@atlaskit/editor-toolbar": "^2.8.0",
 		"@atlaskit/editor-toolbar-model": "^1.2.0",