@atlaskit/editor-plugin-type-ahead 10.2.1 → 10.3.0

package/dist/esm/ui/hooks/build-sectioned-result.js

@@ -0,0 +1,124 @@
+import _toConsumableArray from "@babel/runtime/helpers/toConsumableArray";
+function _createForOfIteratorHelper(r, e) { var t = "undefined" != typeof Symbol && r[Symbol.iterator] || r["@@iterator"]; if (!t) { if (Array.isArray(r) || (t = _unsupportedIterableToArray(r)) || e && r && "number" == typeof r.length) { t && (r = t); var _n = 0, F = function F() {}; return { s: F, n: function n() { return _n >= r.length ? { done: !0 } : { done: !1, value: r[_n++] }; }, e: function e(r) { throw r; }, f: F }; } throw new TypeError("Invalid attempt to iterate non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); } var o, a = !0, u = !1; return { s: function s() { t = t.call(r); }, n: function n() { var r = t.next(); return a = r.done, r; }, e: function e(r) { u = !0, o = r; }, f: function f() { try { a || null == t.return || t.return(); } finally { if (u) throw o; } } }; }
+function _unsupportedIterableToArray(r, a) { if (r) { if ("string" == typeof r) return _arrayLikeToArray(r, a); var t = {}.toString.call(r).slice(8, -1); return "Object" === t && r.constructor && (t = r.constructor.name), "Map" === t || "Set" === t ? Array.from(r) : "Arguments" === t || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(t) ? _arrayLikeToArray(r, a) : void 0; } }
+function _arrayLikeToArray(r, a) { (null == a || a > r.length) && (a = r.length); for (var e = 0, n = Array(a); e < a; e++) n[e] = r[e]; return n; }
+import { editorExperiment } from '@atlaskit/tmp-editor-statsig/experiments';
+export var buildSectionedResult = function buildSectionedResult(_ref) {
+  var _triggerHandler$getSe;
+  var items = _ref.items,
+    triggerHandler = _ref.triggerHandler,
+    intl = _ref.intl;
+  if (!editorExperiment('platform_editor_agent_mentions', true) || !intl) {
+    return {
+      items: items,
+      sections: []
+    };
+  }
+  var sectionDefinitions = (_triggerHandler$getSe = triggerHandler.getSections) === null || _triggerHandler$getSe === void 0 ? void 0 : _triggerHandler$getSe.call(triggerHandler, {
+    intl: intl
+  });
+  if (!sectionDefinitions || sectionDefinitions.length === 0) {
+    return {
+      items: items,
+      sections: []
+    };
+  }
+
+  // Track which item indexes have been claimed by a section, or excluded (matched a section but
+  // cut by that section's limit). Items excluded by limit should not appear anywhere in the output.
+  var assignedToSection = new Set();
+  var excludedByLimit = new Set();
+  var groupedBySection = new Map();
+  var _iterator = _createForOfIteratorHelper(sectionDefinitions),
+    _step;
+  try {
+    for (_iterator.s(); !(_step = _iterator.n()).done;) {
+      var section = _step.value;
+      var matchingIndexes = [];
+      for (var _i = 0; _i < items.length; _i++) {
+        if (assignedToSection.has(_i) || excludedByLimit.has(_i)) {
+          continue;
+        }
+        if (section.filter(items[_i])) {
+          matchingIndexes.push(_i);
+        }
+      }
+      var acceptedIndexes = section.limit !== undefined ? matchingIndexes.slice(0, section.limit) : matchingIndexes;
+      var rejectedByLimit = matchingIndexes.slice(acceptedIndexes.length);
+      var _iterator3 = _createForOfIteratorHelper(acceptedIndexes),
+        _step3;
+      try {
+        for (_iterator3.s(); !(_step3 = _iterator3.n()).done;) {
+          var _i2 = _step3.value;
+          assignedToSection.add(_i2);
+        }
+      } catch (err) {
+        _iterator3.e(err);
+      } finally {
+        _iterator3.f();
+      }
+      var _iterator4 = _createForOfIteratorHelper(rejectedByLimit),
+        _step4;
+      try {
+        for (_iterator4.s(); !(_step4 = _iterator4.n()).done;) {
+          var _i3 = _step4.value;
+          excludedByLimit.add(_i3);
+        }
+      } catch (err) {
+        _iterator4.e(err);
+      } finally {
+        _iterator4.f();
+      }
+      if (acceptedIndexes.length === 0) {
+        continue;
+      }
+      groupedBySection.set(section.id, {
+        indexes: acceptedIndexes,
+        section: section
+      });
+    }
+  } catch (err) {
+    _iterator.e(err);
+  } finally {
+    _iterator.f();
+  }
+  var flattenedItems = [];
+  var sections = [];
+  var _iterator2 = _createForOfIteratorHelper(sectionDefinitions),
+    _step2;
+  try {
+    for (_iterator2.s(); !(_step2 = _iterator2.n()).done;) {
+      var _section = _step2.value;
+      var grouped = groupedBySection.get(_section.id);
+      if (!grouped) {
+        continue;
+      }
+      var startIndex = flattenedItems.length;
+      flattenedItems.push.apply(flattenedItems, _toConsumableArray(grouped.indexes.map(function (i) {
+        return items[i];
+      })));
+      var endIndex = flattenedItems.length - 1;
+      sections.push({
+        endIndex: endIndex,
+        id: _section.id,
+        startIndex: startIndex,
+        title: _section.title
+      });
+    }
+
+    // Append items not claimed by any section and not excluded by a limit
+  } catch (err) {
+    _iterator2.e(err);
+  } finally {
+    _iterator2.f();
+  }
+  for (var i = 0; i < items.length; i++) {
+    if (!assignedToSection.has(i) && !excludedByLimit.has(i)) {
+      flattenedItems.push(items[i]);
+    }
+  }
+  return {
+    items: flattenedItems,
+    sections: sections
+  };
+};

package/dist/esm/ui/hooks/use-load-items.js

@@ -5,8 +5,9 @@ import { editorExperiment } from '@atlaskit/tmp-editor-statsig/experiments';
 import { clearListError } from '../../pm-plugins/commands/clear-list-error';
 import { updateListError } from '../../pm-plugins/commands/update-list-error';
 import { updateListItem } from '../../pm-plugins/commands/update-list-items';
+import { buildSectionedResult } from './build-sectioned-result';
 var EMPTY_LIST_ITEM = [];
-export var useLoadItems = function useLoadItems(triggerHandler, editorView, query, showViewMore, api) {
+export var useLoadItems = function useLoadItems(triggerHandler, editorView, query, showViewMore, api, intl) {
   var _useState = useState(EMPTY_LIST_ITEM),
     _useState2 = _slicedToArray(_useState, 2),
     items = _useState2[0],
@@ -37,7 +38,14 @@ export var useLoadItems = function useLoadItems(triggerHandler, editorView, quer
       var emptyItem = result.length === 0 && expValEquals('platform_editor_insert_menu_ai', 'isEnabled', true) ? (_triggerHandler$getEm = triggerHandler.getEmptyItem) === null || _triggerHandler$getEm === void 0 ? void 0 : _triggerHandler$getEm.call(triggerHandler, {
         editorState: editorView.state
       }) : undefined;
-      var list = result.length > 0 ? result : emptyItem ? [emptyItem] : EMPTY_LIST_ITEM;
+      var rawList = result.length > 0 ? result : emptyItem ? [emptyItem] : EMPTY_LIST_ITEM;
+      var _buildSectionedResult = buildSectionedResult({
+          items: rawList,
+          triggerHandler: triggerHandler,
+          intl: intl !== null && intl !== void 0 ? intl : null
+        }),
+        list = _buildSectionedResult.items,
+        sections = _buildSectionedResult.sections;
       if (componentIsMounted.current) {
         setItems(list);
       }
@@ -47,7 +55,7 @@ export var useLoadItems = function useLoadItems(triggerHandler, editorView, quer
         title: 'View more'
       };
       queueMicrotask(function () {
-        updateListItem(showViewMore ? list.concat(viewMoreItem) : list)(view.state, view.dispatch);
+        updateListItem(showViewMore ? list.concat(viewMoreItem) : list, sections)(view.state, view.dispatch);
       });
     }).catch(function (e) {
       if (editorExperiment('platform_editor_offline_editing_web', true)) {
@@ -65,7 +73,7 @@ export var useLoadItems = function useLoadItems(triggerHandler, editorView, quer
     // ignore because EditorView is mutable but we don't want to
     // call loadItems when it changes, only when the query changes
     // eslint-disable-next-line react-hooks/exhaustive-deps
-  }, [triggerHandler, query]);
+  }, [triggerHandler, query, intl]);
   useEffect(function () {
     return function () {
       componentIsMounted.current = false;

package/dist/types/pm-plugins/commands/update-list-items.d.ts

@@ -1,2 +1,3 @@
 import type { Command, TypeAheadItem } from '@atlaskit/editor-common/types';
-export declare const updateListItem: (items: Array<TypeAheadItem>) => Command;
+import type { TypeAheadResolvedSection } from '../../types';
+export declare const updateListItem: (items: Array<TypeAheadItem>, sections?: Array<TypeAheadResolvedSection>) => Command;

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

@@ -35,11 +35,18 @@ export type TypeAheadPluginState = {
      * If true, removes the trigger character from query when typeahead is closed
      */
     removePrefixTriggerOnCancel?: boolean;
+    sections: Array<TypeAheadResolvedSection>;
     selectedIndex: number;
     stats: TypeAheadStatsSerializable | null;
     triggerHandler?: TypeAheadHandler;
     typeAheadHandlers: Array<TypeAheadHandler>;
 };
+export type TypeAheadResolvedSection = {
+    endIndex: number;
+    id: string;
+    startIndex: number;
+    title: string;
+};
 export type OnInsertSelectedItemProps = {
     index: number;
     mode: SelectItemMode;
@@ -88,6 +95,7 @@ export interface TypeAheadPluginSharedState {
     isOpen: boolean;
     items: Array<TypeAheadItem>;
     query: string;
+    sections: Array<TypeAheadResolvedSection>;
     selectedIndex: number;
     triggerHandler?: TypeAheadHandler;
 }

package/dist/types/ui/TypeAheadList.d.ts

@@ -9,7 +9,7 @@ import type { ExtractInjectionAPI, TypeAheadItem } from '@atlaskit/editor-common
 import type { EditorView } from '@atlaskit/editor-prosemirror/view';
 import type { InputMethodType } from '../pm-plugins/analytics';
 import type { TypeAheadPlugin } from '../typeAheadPluginType';
-import type { TypeAheadHandler } from '../types';
+import type { TypeAheadHandler, TypeAheadResolvedSection } from '../types';
 export declare const TypeAheadList: React.FC<WithIntlProps<{
     api: ExtractInjectionAPI<TypeAheadPlugin> | undefined;
     decorationElement: HTMLElement;
@@ -20,6 +20,7 @@ export declare const TypeAheadList: React.FC<WithIntlProps<{
     moreElementsInQuickInsertViewEnabled?: boolean;
     onItemClick: (mode: SelectItemMode, index: number, inputMethod?: InputMethodType) => void;
     onMoreOptionsClicked?: () => void;
+    sections?: Array<TypeAheadResolvedSection>;
     selectedIndex: number;
     showMoreOptionsButton?: boolean;
     triggerHandler?: TypeAheadHandler;
@@ -34,6 +35,7 @@ export declare const TypeAheadList: React.FC<WithIntlProps<{
         moreElementsInQuickInsertViewEnabled?: boolean;
         onItemClick: (mode: SelectItemMode, index: number, inputMethod?: InputMethodType) => void;
         onMoreOptionsClicked?: () => void;
+        sections?: Array<TypeAheadResolvedSection>;
         selectedIndex: number;
         showMoreOptionsButton?: boolean;
         triggerHandler?: TypeAheadHandler;

package/dist/types/ui/TypeAheadPopup.d.ts

@@ -5,11 +5,11 @@
 import React from 'react';
 import { jsx } from '@emotion/react';
 import type { SelectItemMode } from '@atlaskit/editor-common/type-ahead';
-import type { ExtractInjectionAPI, TypeAheadHandler, TypeAheadItem } from '@atlaskit/editor-common/types';
+import type { ExtractInjectionAPI, TypeAheadItem, TypeAheadHandler } from '@atlaskit/editor-common/types';
 import type { DecorationSet, EditorView } from '@atlaskit/editor-prosemirror/view';
 import { CloseSelectionOptions } from '../pm-plugins/constants';
 import type { TypeAheadPlugin } from '../typeAheadPluginType';
-import type { OnSelectItem, TypeAheadErrorInfo } from '../types';
+import type { OnSelectItem, TypeAheadErrorInfo, TypeAheadResolvedSection } from '../types';
 type TypeAheadPopupProps = {
     anchorElement: HTMLElement;
     api: ExtractInjectionAPI<TypeAheadPlugin> | undefined;
@@ -24,6 +24,7 @@ type TypeAheadPopupProps = {
     errorInfo: TypeAheadErrorInfo;
     isEmptyQuery: boolean;
     items: Array<TypeAheadItem>;
+    sections?: Array<TypeAheadResolvedSection>;
     onItemInsert: (mode: SelectItemMode, index: number) => void;
     popupsBoundariesElement?: HTMLElement;
     popupsMountPoint?: HTMLElement;

package/dist/types/ui/hooks/build-sectioned-result.d.ts

@@ -0,0 +1,11 @@
+import type { IntlShape } from 'react-intl';
+import type { TypeAheadHandler, TypeAheadItem } from '@atlaskit/editor-common/types';
+import type { TypeAheadResolvedSection } from '../../types';
+export declare const buildSectionedResult: ({ items, triggerHandler, intl, }: {
+    items: Array<TypeAheadItem>;
+    triggerHandler: TypeAheadHandler;
+    intl: IntlShape | null;
+}) => {
+    items: Array<TypeAheadItem>;
+    sections: Array<TypeAheadResolvedSection>;
+};

package/dist/types/ui/hooks/use-load-items.d.ts

@@ -1,4 +1,5 @@
+import type { IntlShape } from 'react-intl';
 import type { ExtractInjectionAPI, TypeAheadHandler, TypeAheadItem } from '@atlaskit/editor-common/types';
 import type { EditorView } from '@atlaskit/editor-prosemirror/view';
 import type { TypeAheadPlugin } from '../../typeAheadPluginType';
-export declare const useLoadItems: (triggerHandler: TypeAheadHandler, editorView: EditorView, query: string, showViewMore?: boolean, api?: ExtractInjectionAPI<TypeAheadPlugin> | undefined) => Array<TypeAheadItem>;
+export declare const useLoadItems: (triggerHandler: TypeAheadHandler, editorView: EditorView, query: string, showViewMore?: boolean, api?: ExtractInjectionAPI<TypeAheadPlugin> | undefined, intl?: IntlShape) => Array<TypeAheadItem>;

package/dist/types-ts4.5/pm-plugins/commands/update-list-items.d.ts

@@ -1,2 +1,3 @@
 import type { Command, TypeAheadItem } from '@atlaskit/editor-common/types';
-export declare const updateListItem: (items: Array<TypeAheadItem>) => Command;
+import type { TypeAheadResolvedSection } from '../../types';
+export declare const updateListItem: (items: Array<TypeAheadItem>, sections?: Array<TypeAheadResolvedSection>) => Command;

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

@@ -35,11 +35,18 @@ export type TypeAheadPluginState = {
      * If true, removes the trigger character from query when typeahead is closed
      */
     removePrefixTriggerOnCancel?: boolean;
+    sections: Array<TypeAheadResolvedSection>;
     selectedIndex: number;
     stats: TypeAheadStatsSerializable | null;
     triggerHandler?: TypeAheadHandler;
     typeAheadHandlers: Array<TypeAheadHandler>;
 };
+export type TypeAheadResolvedSection = {
+    endIndex: number;
+    id: string;
+    startIndex: number;
+    title: string;
+};
 export type OnInsertSelectedItemProps = {
     index: number;
     mode: SelectItemMode;
@@ -88,6 +95,7 @@ export interface TypeAheadPluginSharedState {
     isOpen: boolean;
     items: Array<TypeAheadItem>;
     query: string;
+    sections: Array<TypeAheadResolvedSection>;
     selectedIndex: number;
     triggerHandler?: TypeAheadHandler;
 }

package/dist/types-ts4.5/ui/TypeAheadList.d.ts

@@ -9,7 +9,7 @@ import type { ExtractInjectionAPI, TypeAheadItem } from '@atlaskit/editor-common
 import type { EditorView } from '@atlaskit/editor-prosemirror/view';
 import type { InputMethodType } from '../pm-plugins/analytics';
 import type { TypeAheadPlugin } from '../typeAheadPluginType';
-import type { TypeAheadHandler } from '../types';
+import type { TypeAheadHandler, TypeAheadResolvedSection } from '../types';
 export declare const TypeAheadList: React.FC<WithIntlProps<{
     api: ExtractInjectionAPI<TypeAheadPlugin> | undefined;
     decorationElement: HTMLElement;
@@ -20,6 +20,7 @@ export declare const TypeAheadList: React.FC<WithIntlProps<{
     moreElementsInQuickInsertViewEnabled?: boolean;
     onItemClick: (mode: SelectItemMode, index: number, inputMethod?: InputMethodType) => void;
     onMoreOptionsClicked?: () => void;
+    sections?: Array<TypeAheadResolvedSection>;
     selectedIndex: number;
     showMoreOptionsButton?: boolean;
     triggerHandler?: TypeAheadHandler;
@@ -34,6 +35,7 @@ export declare const TypeAheadList: React.FC<WithIntlProps<{
         moreElementsInQuickInsertViewEnabled?: boolean;
         onItemClick: (mode: SelectItemMode, index: number, inputMethod?: InputMethodType) => void;
         onMoreOptionsClicked?: () => void;
+        sections?: Array<TypeAheadResolvedSection>;
         selectedIndex: number;
         showMoreOptionsButton?: boolean;
         triggerHandler?: TypeAheadHandler;

package/dist/types-ts4.5/ui/TypeAheadPopup.d.ts

@@ -5,11 +5,11 @@
 import React from 'react';
 import { jsx } from '@emotion/react';
 import type { SelectItemMode } from '@atlaskit/editor-common/type-ahead';
-import type { ExtractInjectionAPI, TypeAheadHandler, TypeAheadItem } from '@atlaskit/editor-common/types';
+import type { ExtractInjectionAPI, TypeAheadItem, TypeAheadHandler } from '@atlaskit/editor-common/types';
 import type { DecorationSet, EditorView } from '@atlaskit/editor-prosemirror/view';
 import { CloseSelectionOptions } from '../pm-plugins/constants';
 import type { TypeAheadPlugin } from '../typeAheadPluginType';
-import type { OnSelectItem, TypeAheadErrorInfo } from '../types';
+import type { OnSelectItem, TypeAheadErrorInfo, TypeAheadResolvedSection } from '../types';
 type TypeAheadPopupProps = {
     anchorElement: HTMLElement;
     api: ExtractInjectionAPI<TypeAheadPlugin> | undefined;
@@ -24,6 +24,7 @@ type TypeAheadPopupProps = {
     errorInfo: TypeAheadErrorInfo;
     isEmptyQuery: boolean;
     items: Array<TypeAheadItem>;
+    sections?: Array<TypeAheadResolvedSection>;
     onItemInsert: (mode: SelectItemMode, index: number) => void;
     popupsBoundariesElement?: HTMLElement;
     popupsMountPoint?: HTMLElement;

package/dist/types-ts4.5/ui/hooks/build-sectioned-result.d.ts

@@ -0,0 +1,11 @@
+import type { IntlShape } from 'react-intl';
+import type { TypeAheadHandler, TypeAheadItem } from '@atlaskit/editor-common/types';
+import type { TypeAheadResolvedSection } from '../../types';
+export declare const buildSectionedResult: ({ items, triggerHandler, intl, }: {
+    items: Array<TypeAheadItem>;
+    triggerHandler: TypeAheadHandler;
+    intl: IntlShape | null;
+}) => {
+    items: Array<TypeAheadItem>;
+    sections: Array<TypeAheadResolvedSection>;
+};

package/dist/types-ts4.5/ui/hooks/use-load-items.d.ts

@@ -1,4 +1,5 @@
+import type { IntlShape } from 'react-intl';
 import type { ExtractInjectionAPI, TypeAheadHandler, TypeAheadItem } from '@atlaskit/editor-common/types';
 import type { EditorView } from '@atlaskit/editor-prosemirror/view';
 import type { TypeAheadPlugin } from '../../typeAheadPluginType';
-export declare const useLoadItems: (triggerHandler: TypeAheadHandler, editorView: EditorView, query: string, showViewMore?: boolean, api?: ExtractInjectionAPI<TypeAheadPlugin> | undefined) => Array<TypeAheadItem>;
+export declare const useLoadItems: (triggerHandler: TypeAheadHandler, editorView: EditorView, query: string, showViewMore?: boolean, api?: ExtractInjectionAPI<TypeAheadPlugin> | undefined, intl?: IntlShape) => Array<TypeAheadItem>;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-plugin-type-ahead",
-	"version": "10.2.1",
+	"version": "10.3.0",
 	"description": "Type-ahead plugin for @atlaskit/editor-core",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -29,7 +29,7 @@
 	],
 	"atlaskit:src": "src/index.ts",
 	"dependencies": {
-		"@atlaskit/adf-schema": "^52.14.0",
+		"@atlaskit/adf-schema": "^52.15.0",
 		"@atlaskit/editor-plugin-analytics": "^10.1.0",
 		"@atlaskit/editor-plugin-connectivity": "^10.1.0",
 		"@atlaskit/editor-plugin-context-panel": "^12.1.0",
@@ -44,7 +44,7 @@
 		"@atlaskit/primitives": "^19.0.0",
 		"@atlaskit/prosemirror-history": "^0.2.0",
 		"@atlaskit/prosemirror-input-rules": "^3.7.0",
-		"@atlaskit/tmp-editor-statsig": "^83.0.0",
+		"@atlaskit/tmp-editor-statsig": "^84.3.0",
 		"@atlaskit/tokens": "^13.0.0",
 		"@atlaskit/visually-hidden": "^3.1.0",
 		"@babel/runtime": "^7.0.0",
@@ -56,7 +56,7 @@
 		"w3c-keyname": "^2.1.8"
 	},
 	"peerDependencies": {
-		"@atlaskit/editor-common": "^114.46.0",
+		"@atlaskit/editor-common": "^114.50.0",
 		"react": "^18.2.0",
 		"react-dom": "^18.2.0",
 		"react-intl": "^5.25.1 || ^6.0.0 || ^7.0.0"