@atlaskit/editor-common 114.49.0 → 114.50.0

package/CHANGELOG.md

@@ -1,5 +1,25 @@
 # @atlaskit/editor-common
 
+## 114.50.0
+
+### Minor Changes
+
+- [`beab4fffee103`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/beab4fffee103) -
+  EDITOR-7318: Add type-ahead sections support with getSections handler API.
+
+  Adds `TypeAheadSection` and `TypeAheadSectionUpdate` types and an optional `getSections()` method
+  to `TypeAheadHandler` in `editor-common`. Implements section grouping in
+  `editor-plugin-type-ahead` via `buildSectionedResult`. Adds People/Agents section split to
+  `editor-plugin-mentions`.
+
+  Removes the `updateSection` action and associated `sectionOverrides`/`sectionsRefreshKey`
+  pm-plugin state — section definitions are now derived directly from `getSections()` at load time
+  rather than being mutated at runtime.
+
+### Patch Changes
+
+- Updated dependencies
+
 ## 114.49.0
 
 ### Minor Changes

package/dist/cjs/messages/mentions.js

@@ -45,5 +45,15 @@ var mentionMessages = exports.mentionMessages = (0, _reactIntl.defineMessages)({
     id: 'fabric.editor.inviteItem.inviteButton',
     defaultMessage: 'Invite',
     description: 'Label for the invite button shown in the mention typeahead invite item.'
+  },
+  typeAheadSectionPeople: {
+    id: 'fabric.editor.typeAhead.mentionSection.people',
+    defaultMessage: 'People',
+    description: 'Section header for people (non-agent) results in the mention type-ahead menu'
+  },
+  typeAheadSectionAgents: {
+    id: 'fabric.editor.typeAhead.mentionSection.agents',
+    defaultMessage: 'Agents',
+    description: 'Section header for agent results in the mention type-ahead menu'
   }
 });

package/dist/cjs/monitoring/error.js

@@ -19,7 +19,7 @@ function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t =
 function _interopRequireWildcard(e, t) { if ("function" == typeof WeakMap) var r = new WeakMap(), n = new WeakMap(); return (_interopRequireWildcard = function _interopRequireWildcard(e, t) { if (!t && e && e.__esModule) return e; var o, i, f = { __proto__: null, default: e }; if (null === e || "object" != _typeof(e) && "function" != typeof e) return f; if (o = t ? n : r) { if (o.has(e)) return o.get(e); o.set(e, f); } for (var _t2 in e) "default" !== _t2 && {}.hasOwnProperty.call(e, _t2) && ((i = (o = Object.defineProperty) && Object.getOwnPropertyDescriptor(e, _t2)) && (i.get || i.set) ? o(f, _t2, i) : f[_t2] = e[_t2]); return f; })(e, t); }
 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 = "114.48.1";
+var packageVersion = "114.49.0";
 var sanitiseSentryEvents = function sanitiseSentryEvents(data, _hint) {
   // Remove URL as it has UGC
   // Ignored via go/ees007

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

@@ -24,7 +24,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 = "114.48.1";
+var packageVersion = "114.49.0";
 var halfFocusRing = 1;
 var dropOffset = '0, 8';
 var fadeIn = (0, _react2.keyframes)({

package/dist/es2019/messages/mentions.js

@@ -39,5 +39,15 @@ export const mentionMessages = defineMessages({
     id: 'fabric.editor.inviteItem.inviteButton',
     defaultMessage: 'Invite',
     description: 'Label for the invite button shown in the mention typeahead invite item.'
+  },
+  typeAheadSectionPeople: {
+    id: 'fabric.editor.typeAhead.mentionSection.people',
+    defaultMessage: 'People',
+    description: 'Section header for people (non-agent) results in the mention type-ahead menu'
+  },
+  typeAheadSectionAgents: {
+    id: 'fabric.editor.typeAhead.mentionSection.agents',
+    defaultMessage: 'Agents',
+    description: 'Section header for agent results in the mention type-ahead menu'
   }
 });

package/dist/es2019/monitoring/error.js

@@ -4,7 +4,7 @@ import { isFedRamp } from './environment';
 import { normaliseSentryBreadcrumbs, SERIALIZABLE_ATTRIBUTES } from './normalise-sentry-breadcrumbs';
 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 = "114.48.1";
+const packageVersion = "114.49.0";
 const sanitiseSentryEvents = (data, _hint) => {
   // Remove URL as it has UGC
   // Ignored via go/ees007

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

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

package/dist/esm/messages/mentions.js

@@ -39,5 +39,15 @@ export var mentionMessages = defineMessages({
     id: 'fabric.editor.inviteItem.inviteButton',
     defaultMessage: 'Invite',
     description: 'Label for the invite button shown in the mention typeahead invite item.'
+  },
+  typeAheadSectionPeople: {
+    id: 'fabric.editor.typeAhead.mentionSection.people',
+    defaultMessage: 'People',
+    description: 'Section header for people (non-agent) results in the mention type-ahead menu'
+  },
+  typeAheadSectionAgents: {
+    id: 'fabric.editor.typeAhead.mentionSection.agents',
+    defaultMessage: 'Agents',
+    description: 'Section header for agent results in the mention type-ahead menu'
   }
 });

package/dist/esm/monitoring/error.js

@@ -10,7 +10,7 @@ import { isFedRamp } from './environment';
 import { normaliseSentryBreadcrumbs, SERIALIZABLE_ATTRIBUTES } from './normalise-sentry-breadcrumbs';
 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 = "114.48.1";
+var packageVersion = "114.49.0";
 var sanitiseSentryEvents = function sanitiseSentryEvents(data, _hint) {
   // Remove URL as it has UGC
   // Ignored via go/ees007

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';
 import Layer from '../Layer';
 var packageName = "@atlaskit/editor-common";
-var packageVersion = "114.48.1";
+var packageVersion = "114.49.0";
 var halfFocusRing = 1;
 var dropOffset = '0, 8';
 var fadeIn = keyframes({

package/dist/types/messages/mentions.d.ts

@@ -39,4 +39,14 @@ export declare const mentionMessages: {
         description: string;
         id: string;
     };
+    typeAheadSectionPeople: {
+        defaultMessage: string;
+        description: string;
+        id: string;
+    };
+    typeAheadSectionAgents: {
+        defaultMessage: string;
+        description: string;
+        id: string;
+    };
 };

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

@@ -7,7 +7,7 @@ export { AnnotationUpdateEmitter, AnnotationUpdateEvent } from './annotation/emi
 export type { AnnotationState, AnnotationUpdateEventPayloads, OnAnnotationClickPayload, } from './annotation/emitter';
 export type { AnnotationProviders, InlineCommentSelectionComponentProps, InlineCommentHoverComponentProps, InlineCommentViewComponentProps, InlineCommentAnnotationProvider, AnnotationByMatches, AnnotationActionResult, } from './annotation';
 export type { ContextUpdateHandler, EditorActionsOptions, ReplaceRawValue, GetResolvedEditorStateReason, } from './editor-actions';
-export type { TypeAheadStats, TypeAheadItemRenderProps, TypeAheadInsert, TypeAheadSelectItem, TypeAheadItem, TypeAheadForceSelect, TypeAheadHandler, } from './type-ahead';
+export type { TypeAheadStats, TypeAheadItemRenderProps, TypeAheadInsert, TypeAheadSelectItem, TypeAheadItem, TypeAheadForceSelect, TypeAheadHandler, TypeAheadSection, } from './type-ahead';
 export type { CommandDispatch, Command, HigherOrderCommand, Predicate } from './command';
 export type { FeatureFlags, FeatureFlagKey, GetEditorFeatureFlags } from './feature-flags';
 export type { Browsers, Range, DisableSpellcheckByBrowser } from './supported-browsers';

package/dist/types/types/type-ahead.d.ts

@@ -45,6 +45,12 @@ export type TypeAheadItem = {
     testId?: string;
     title: string;
 };
+export type TypeAheadSection = {
+    filter: (item: TypeAheadItem) => boolean;
+    id: string;
+    limit?: number;
+    title: string;
+};
 export type TypeAheadForceSelect = (props: TypeAheadForceSelectProps) => TypeAheadItem | undefined;
 export type MoreOptionsButtonConfig = {
     ariaLabel?: string;
@@ -78,6 +84,10 @@ export type TypeAheadHandler = {
         editorState: EditorState;
         query: string;
     }) => Promise<Array<TypeAheadItem>>;
+    /** Optional section definitions used by type-ahead menu to group items */
+    getSections?: (props: {
+        intl: IntlShape;
+    }) => Array<TypeAheadSection>;
     getMoreOptionsButtonConfig?: (intl: IntlShape) => MoreOptionsButtonConfig;
     headless?: boolean;
     id: TypeAheadAvailableNodes;

package/dist/types-ts4.5/messages/mentions.d.ts

@@ -39,4 +39,14 @@ export declare const mentionMessages: {
         description: string;
         id: string;
     };
+    typeAheadSectionPeople: {
+        defaultMessage: string;
+        description: string;
+        id: string;
+    };
+    typeAheadSectionAgents: {
+        defaultMessage: string;
+        description: string;
+        id: string;
+    };
 };

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

@@ -7,7 +7,7 @@ export { AnnotationUpdateEmitter, AnnotationUpdateEvent } from './annotation/emi
 export type { AnnotationState, AnnotationUpdateEventPayloads, OnAnnotationClickPayload, } from './annotation/emitter';
 export type { AnnotationProviders, InlineCommentSelectionComponentProps, InlineCommentHoverComponentProps, InlineCommentViewComponentProps, InlineCommentAnnotationProvider, AnnotationByMatches, AnnotationActionResult, } from './annotation';
 export type { ContextUpdateHandler, EditorActionsOptions, ReplaceRawValue, GetResolvedEditorStateReason, } from './editor-actions';
-export type { TypeAheadStats, TypeAheadItemRenderProps, TypeAheadInsert, TypeAheadSelectItem, TypeAheadItem, TypeAheadForceSelect, TypeAheadHandler, } from './type-ahead';
+export type { TypeAheadStats, TypeAheadItemRenderProps, TypeAheadInsert, TypeAheadSelectItem, TypeAheadItem, TypeAheadForceSelect, TypeAheadHandler, TypeAheadSection, } from './type-ahead';
 export type { CommandDispatch, Command, HigherOrderCommand, Predicate } from './command';
 export type { FeatureFlags, FeatureFlagKey, GetEditorFeatureFlags } from './feature-flags';
 export type { Browsers, Range, DisableSpellcheckByBrowser } from './supported-browsers';

package/dist/types-ts4.5/types/type-ahead.d.ts

@@ -45,6 +45,12 @@ export type TypeAheadItem = {
     testId?: string;
     title: string;
 };
+export type TypeAheadSection = {
+    filter: (item: TypeAheadItem) => boolean;
+    id: string;
+    limit?: number;
+    title: string;
+};
 export type TypeAheadForceSelect = (props: TypeAheadForceSelectProps) => TypeAheadItem | undefined;
 export type MoreOptionsButtonConfig = {
     ariaLabel?: string;
@@ -78,6 +84,10 @@ export type TypeAheadHandler = {
         editorState: EditorState;
         query: string;
     }) => Promise<Array<TypeAheadItem>>;
+    /** Optional section definitions used by type-ahead menu to group items */
+    getSections?: (props: {
+        intl: IntlShape;
+    }) => Array<TypeAheadSection>;
     getMoreOptionsButtonConfig?: (intl: IntlShape) => MoreOptionsButtonConfig;
     headless?: boolean;
     id: TypeAheadAvailableNodes;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-common",
-	"version": "114.49.0",
+	"version": "114.50.0",
 	"description": "A package that contains common classes and components for editor and renderer",
 	"publishConfig": {
 		"registry": "https://registry.npmjs.org/"