@atlaskit/editor-common 128.1.0 → 128.3.0

package/dist/esm/styles/shared/table.js

@@ -39,12 +39,10 @@ var firstNodeWithNotMarginTop = function firstNodeWithNotMarginTop() {
  *
  * If you are updating this, please also update the above files.
  *
- * @deprecated This Emotion-based style function is being phased out as part of the
- * `platform_editor_core_static_css` experiment migration to Compiled CSS. While the experiment
- * is running, any changes here MUST also be reflected in `EditorContentContainer-compiled.tsx`
+ * @deprecated This Emotion-based style function is being phased out in favor of Compiled CSS.
+ * Any changes here MUST also be reflected in `EditorContentContainer-compiled.tsx`
  * (look for `tableSharedStyle`, `tableSharedStyle_with_*`, `tableSharedStyle_without_*` entries
- * in the `editorContentStyles` cssMap). Failure to do so will cause visual regressions when the
- * compiled version is active.
+ * in the `editorContentStyles` cssMap) to keep the shared styles consistent.
  */
 var tableSharedStyle = function tableSharedStyle() {
   var browser = getBrowserInfo();

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

@@ -21,7 +21,7 @@ import withAnalyticsEvents from '@atlaskit/analytics-next/withAnalyticsEvents';
 import { fg } from '@atlaskit/platform-feature-flags/fg';
 import Layer from '../Layer';
 var packageName = "@atlaskit/editor-common";
-var packageVersion = "128.0.1";
+var packageVersion = "128.2.0";
 var halfFocusRing = 1;
 var dropOffset = '0, 8';
 var fadeIn = keyframes({

package/dist/types/annotation/index.d.ts

@@ -41,11 +41,17 @@ export type AnnotationDraftStartedData = {
      */
     inlineNodeTypes: string[];
     targetElement: HTMLElement | undefined;
+    /** The type of the node the draft targets, e.g. `'media'`. Undefined for an inline text draft. */
+    targetNodeType?: string;
 };
 export type AnnotationSelectedChangeData = {
     annotationId: AnnotationId;
     inlineNodeTypes: string[];
     isSelected: boolean;
+    /** The type of the node the annotation is on, e.g. `'media'`. Undefined for inline text. */
+    targetNodeType?: string;
+    /** How the annotation came to be selected, for analytics parity with the surface events. */
+    viewMethod?: string;
 };
 export type AnnotationManagerEvents = {
     data: AnnotationDraftStartedData;
@@ -58,7 +64,7 @@ export type AnnotationManagerEvents = {
 };
 export type ManagerFailureReasons = 'manager-not-initialized' | 'hook-execution-error';
 export type StartDraftResult = {
-    reason: ManagerFailureReasons | 'invalid-range' | 'draft-in-progress';
+    reason: ManagerFailureReasons | 'invalid-range' | 'draft-in-progress' | 'invalid-localId';
     success: false;
 } | ({
     success: true;
@@ -108,6 +114,20 @@ export type HoverAnnotationResult = {
     isHovered: boolean;
     success: true;
 };
+export type ClearSelectedAnnotationResult = {
+    reason: ManagerFailureReasons | 'draft-in-progress';
+    success: false;
+} | {
+    annotationId: AnnotationId | undefined;
+    success: true;
+};
+export type ClearHoveredAnnotationResult = {
+    reason: ManagerFailureReasons;
+    success: false;
+} | {
+    annotationId: AnnotationId | undefined;
+    success: true;
+};
 /**
  * This is the list of methods which exist on the Manager interface. These are the methods that can be hooked into.
  */
@@ -126,6 +146,17 @@ export type AnnotationManagerMethods = {
     applyDraft: (id: AnnotationId) => ApplyDraftResult;
     clearAnnotation: (id: AnnotationId) => ClearAnnotationResult;
     clearDraft: () => ClearDraftResult;
+    /**
+     * Clears the hover state without needing to know which annotation is hovered.
+     * @returns The annotation that was hovered, or undefined when nothing was.
+     */
+    clearHoveredAnnotation: () => ClearHoveredAnnotationResult;
+    /**
+     * Deselects the selected annotation without needing to know which one it is, for surfaces
+     * outside the document (the comments panel, the comment button) that only want to clear it.
+     * @returns The annotation that was selected, or undefined when nothing was.
+     */
+    clearSelectedAnnotation: () => ClearSelectedAnnotationResult;
     /**
      * This can be used to inspect the current active draft.
      * @returns The current draft data. If the draft is not started, it will return an error.
@@ -133,7 +164,14 @@ export type AnnotationManagerMethods = {
     getDraft: () => GetDraftResult;
     setIsAnnotationHovered: (id: AnnotationId, isHovered: boolean) => HoverAnnotationResult;
     setIsAnnotationSelected: (id: AnnotationId, isSelected: boolean) => SelectAnnotationResult;
-    startDraft: () => StartDraftResult;
+    /**
+     * Starts a draft annotation.
+     *
+     * @param localId Targets the block node with this `localId`, resolving to its closest
+     * annotatable ancestor when the node itself does not accept annotations. Without it the draft
+     * targets the current text selection.
+     */
+    startDraft: (localId?: string) => StartDraftResult;
 };
 export type AnnotationManager = AnnotationManagerMethods & {
     /**
@@ -163,8 +201,11 @@ export type AnnotationManager = AnnotationManagerMethods & {
      */
     hook: <H extends keyof AnnotationManagerMethods>(method: H, handler: AnnotationManagerMethods[H]) => AnnotationManager;
     offAnnotationSelectionChange: (handler: (data: AnnotationSelectedChangeData) => void) => AnnotationManager;
+    offDraftAnnotationCleared: (handler: () => void) => AnnotationManager;
     offDraftAnnotationStarted: (handler: (data: AnnotationDraftStartedData) => void) => AnnotationManager;
     onAnnotationSelectionChange: (handler: (data: AnnotationSelectedChangeData) => void) => AnnotationManager;
+    /** Subscribe to `draftAnnotationCleared`, fired when an in-progress draft is discarded. */
+    onDraftAnnotationCleared: (handler: () => void) => AnnotationManager;
     onDraftAnnotationStarted: (handler: (data: AnnotationDraftStartedData) => void) => AnnotationManager;
     /**
      * This method is used to set a preemptive gate. A preemptive gate is a function that will be called

package/dist/types/annotation/manager.d.ts

@@ -1,5 +1,5 @@
 import type { AnnotationId } from '@atlaskit/adf-schema/annotation';
-import type { AnnotationDraftStartedData, AnnotationManager, AnnotationManagerEvents, AnnotationManagerMethods, AnnotationSelectedChangeData, ApplyDraftResult, ClearAnnotationResult, ClearDraftResult, GetDraftResult, HoverAnnotationResult, SelectAnnotationResult, StartDraftResult } from './index';
+import type { AnnotationDraftStartedData, AnnotationManager, AnnotationManagerEvents, AnnotationManagerMethods, AnnotationSelectedChangeData, ApplyDraftResult, ClearAnnotationResult, ClearDraftResult, ClearHoveredAnnotationResult, ClearSelectedAnnotationResult, GetDraftResult, HoverAnnotationResult, SelectAnnotationResult, StartDraftResult } from './index';
 export declare class SharedAnnotationManager implements AnnotationManager {
     /**
      * This is the event emitter that is used to emit events from the manager. It is used to communicate with
@@ -19,15 +19,19 @@ export declare class SharedAnnotationManager implements AnnotationManager {
     offDraftAnnotationStarted(handler: (data: AnnotationDraftStartedData) => void): AnnotationManager;
     onAnnotationSelectionChange(handler: (data: AnnotationSelectedChangeData) => void): AnnotationManager;
     offAnnotationSelectionChange(handler: (data: AnnotationSelectedChangeData) => void): AnnotationManager;
+    onDraftAnnotationCleared(handler: () => void): AnnotationManager;
+    offDraftAnnotationCleared(handler: () => void): AnnotationManager;
     emit(event: AnnotationManagerEvents): AnnotationManager;
     hook<H extends keyof AnnotationManagerMethods>(method: H, handler: AnnotationManagerMethods[H]): AnnotationManager;
     unhook<H extends keyof AnnotationManagerMethods>(method: H, handler: AnnotationManagerMethods[H]): AnnotationManager;
     allowAnnotation(): boolean;
-    startDraft(): StartDraftResult;
+    startDraft(localId?: string): StartDraftResult;
     clearDraft(): ClearDraftResult;
     applyDraft(id: AnnotationId): ApplyDraftResult;
     getDraft(): GetDraftResult;
     setIsAnnotationSelected(id: string, isSelected: boolean): SelectAnnotationResult;
     setIsAnnotationHovered(id: string, isHovered: boolean): HoverAnnotationResult;
     clearAnnotation(id: AnnotationId): ClearAnnotationResult;
+    clearSelectedAnnotation(): ClearSelectedAnnotationResult;
+    clearHoveredAnnotation(): ClearHoveredAnnotationResult;
 }

package/dist/types/extensions/types/utils.d.ts

@@ -15,6 +15,7 @@ export type MenuItem = {
     key: string;
     keywords: string[];
     lozenge?: ReactNode;
+    moduleKey?: string;
     node: ADFEntity | ExtensionModuleActionHandler;
     preview?: QuickInsertPreview;
     priority?: number;

package/dist/types/quick-insert/CompactQuickInsertMenuItem.d.ts

@@ -1,3 +1,3 @@
 import React from 'react';
 import type { QuickInsertMenuItemProps } from './QuickInsertMenuItem';
-export declare const CompactQuickInsertMenuItem: ({ ariaLabel, description, iconBefore, isDisabled, onSelect, preview, previewImageUrls, shortcut, shouldShowPreview, shouldWrapIcon, title, }: QuickInsertMenuItemProps) => React.JSX.Element;
+export declare const CompactQuickInsertMenuItem: ({ ariaLabel, description, iconBefore, isDisabled, onSelect, preview, previewIcon, previewImageUrls, shortcut, titleContent, shouldShowPreview, shouldClampPreview, shouldWrapIcon, title, }: QuickInsertMenuItemProps) => React.JSX.Element;

package/dist/types/quick-insert/ElementBrowserQuickInsertMenuItem.d.ts

@@ -4,4 +4,4 @@
  */
 import React from 'react';
 import type { QuickInsertMenuItemProps } from './QuickInsertMenuItem';
-export declare const ElementBrowserQuickInsertMenuItem: ({ ariaLabel, description, iconBefore, isDisabled, onSelect, shortcut, shouldWrapIcon, title, }: QuickInsertMenuItemProps) => React.JSX.Element;
+export declare const ElementBrowserQuickInsertMenuItem: ({ ariaLabel, description, iconBefore, isDisabled, onSelect, shortcut, titleContent, shouldWrapIcon, title, }: QuickInsertMenuItemProps) => React.JSX.Element;

package/dist/types/quick-insert/QuickInsertHoverPreview.d.ts

@@ -1,10 +1,18 @@
+/**
+ * @jsxRuntime classic
+ * @jsx jsx
+ * @jsxFrag React.Fragment
+ */
+import React, { type ReactNode } from 'react';
 import type { QuickInsertPreview } from './preview';
 /** The selected item's description and attribution are announced through its aria-describedby. */
-export declare const QuickInsertHoverPreview: ({ description, id, preview, popupsMountPoint, referenceElement, title, }: {
+export declare const QuickInsertHoverPreview: ({ description, icon, id, preview, popupsMountPoint, referenceElement, shouldClampText, title, }: {
     description?: string;
+    icon?: ReactNode;
     id: string;
     preview: QuickInsertPreview;
     popupsMountPoint?: HTMLElement;
     referenceElement: HTMLElement;
+    shouldClampText?: boolean;
     title: string;
 }) => React.JSX.Element;

package/dist/types/quick-insert/QuickInsertMenuItem.d.ts

@@ -17,15 +17,21 @@ export type QuickInsertMenuItemProps = {
     onSelect: (context: OnSelectContext) => Transaction | false | void;
     /** Structured preview content for the selected item. */
     preview?: QuickInsertPreview;
+    /** Icon displayed beside the preview title. */
+    previewIcon?: React.ReactNode;
     /** Retained for existing callers; new callers should pass `preview.image`. */
     previewImageUrls?: {
         dark?: string;
         light: string;
     } | null;
     shortcut?: string;
+    /** Whether preview title and description are clamped to a fixed number of lines. */
+    shouldClampPreview?: boolean;
     /** Disable previews for navigation actions rather than insertable items. */
     shouldShowPreview?: boolean;
     shouldWrapIcon?: boolean;
     title: string;
+    /** Rich title content rendered in place of the menu item title. */
+    titleContent?: React.ReactNode;
 };
-export declare const QuickInsertMenuItem: ({ ariaLabel, description, iconBefore, isDisabled, onSelect, preview, previewImageUrls, shortcut, shouldShowPreview, shouldWrapIcon, title, }: QuickInsertMenuItemProps) => React.JSX.Element;
+export declare const QuickInsertMenuItem: ({ ariaLabel, description, iconBefore, isDisabled, onSelect, preview, previewIcon, previewImageUrls, shortcut, titleContent, shouldShowPreview, shouldClampPreview, shouldWrapIcon, title, }: QuickInsertMenuItemProps) => React.JSX.Element;

package/dist/types/quick-insert/SkillTag.d.ts

@@ -0,0 +1,6 @@
+import React from 'react';
+export type SkillTagProps = {
+    isDisabled?: boolean;
+    slug: string;
+};
+export declare const SkillTag: ({ slug, isDisabled }: SkillTagProps) => React.JSX.Element;

package/dist/types/styles/shared/table.d.ts

@@ -17,12 +17,10 @@ export declare const tableControlsSpacing: number;
  *
  * If you are updating this, please also update the above files.
  *
- * @deprecated This Emotion-based style function is being phased out as part of the
- * `platform_editor_core_static_css` experiment migration to Compiled CSS. While the experiment
- * is running, any changes here MUST also be reflected in `EditorContentContainer-compiled.tsx`
+ * @deprecated This Emotion-based style function is being phased out in favor of Compiled CSS.
+ * Any changes here MUST also be reflected in `EditorContentContainer-compiled.tsx`
  * (look for `tableSharedStyle`, `tableSharedStyle_with_*`, `tableSharedStyle_without_*` entries
- * in the `editorContentStyles` cssMap). Failure to do so will cause visual regressions when the
- * compiled version is active.
+ * in the `editorContentStyles` cssMap) to keep the shared styles consistent.
  */
 declare const tableSharedStyle: () => SerializedStyles;
 export { tableSharedStyle };

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-common",
-	"version": "128.1.0",
+	"version": "128.3.0",
 	"description": "A package that contains common classes and components for editor and renderer",
 	"publishConfig": {
 		"registry": "https://registry.npmjs.org/"
@@ -31,7 +31,7 @@
 		"@atlaskit/activity-provider": "^3.1.0",
 		"@atlaskit/adf-schema": "^57.6.0",
 		"@atlaskit/adf-utils": "^20.9.0",
-		"@atlaskit/afm-i18n-platform-editor-editor-common": "2.249.0",
+		"@atlaskit/afm-i18n-platform-editor-editor-common": "2.270.0",
 		"@atlaskit/analytics-listeners": "^11.4.0",
 		"@atlaskit/analytics-namespaced-context": "^8.2.0",
 		"@atlaskit/analytics-next": "^12.5.0",
@@ -50,7 +50,7 @@
 		"@atlaskit/editor-toolbar": "^2.8.0",
 		"@atlaskit/editor-toolbar-model": "^1.2.0",
 		"@atlaskit/editor-ui-control-model": "^2.10.0",
-		"@atlaskit/emoji": "^72.4.0",
+		"@atlaskit/emoji": "^72.5.0",
 		"@atlaskit/feature-gate-js-client": "^7.0.0",
 		"@atlaskit/icon": "^38.0.0",
 		"@atlaskit/link": "^5.1.0",
@@ -58,14 +58,14 @@
 		"@atlaskit/link-picker": "^6.11.0",
 		"@atlaskit/logo": "^23.3.0",
 		"@atlaskit/media-card": "^82.1.0",
-		"@atlaskit/media-client": "^39.0.0",
+		"@atlaskit/media-client": "^39.1.0",
 		"@atlaskit/media-client-react": "^7.0.0",
 		"@atlaskit/media-common": "^14.6.0",
 		"@atlaskit/media-file-preview": "^2.0.0",
 		"@atlaskit/media-picker": "^73.0.0",
-		"@atlaskit/media-ui": "^31.0.0",
-		"@atlaskit/media-viewer": "^54.10.0",
-		"@atlaskit/mention": "^30.0.0",
+		"@atlaskit/media-ui": "^31.2.0",
+		"@atlaskit/media-viewer": "^54.11.0",
+		"@atlaskit/mention": "^30.1.0",
 		"@atlaskit/menu": "^11.0.0",
 		"@atlaskit/object": "^2.3.0",
 		"@atlaskit/onboarding": "^15.4.0",
@@ -82,11 +82,11 @@
 		"@atlaskit/smart-card": "^46.4.0",
 		"@atlaskit/smart-user-picker": "^12.2.0",
 		"@atlaskit/spinner": "^20.4.0",
-		"@atlaskit/task-decision": "^21.11.0",
+		"@atlaskit/task-decision": "^21.12.0",
 		"@atlaskit/teams-app-config": "^3.1.0",
 		"@atlaskit/textfield": "^10.2.0",
-		"@atlaskit/tmp-editor-statsig": "^221.0.0",
-		"@atlaskit/tokens": "^20.1.0",
+		"@atlaskit/tmp-editor-statsig": "^222.0.0",
+		"@atlaskit/tokens": "^20.3.0",
 		"@atlaskit/tooltip": "^24.4.0",
 		"@atlaskit/width-detector": "^7.2.0",
 		"@babel/runtime": "^7.0.0",

package/quick-insert/skill-tag/package.json

@@ -0,0 +1,10 @@
+{
+  "name": "@atlaskit/editor-common/quick-insert/skill-tag",
+  "main": "../../dist/cjs/quick-insert/SkillTag.js",
+  "module": "../../dist/esm/quick-insert/SkillTag.js",
+  "module:es2019": "../../dist/es2019/quick-insert/SkillTag.js",
+  "sideEffects": [
+    "**/*.compiled.css"
+  ],
+  "types": "../../dist/types/quick-insert/SkillTag.d.ts"
+}