@atlaskit/editor-plugin-quick-insert 15.1.4 → 16.0.0

package/dist/esm/ui/RegistryElementBrowser/model.js

@@ -0,0 +1,122 @@
+import _defineProperty from "@babel/runtime/helpers/defineProperty";
+import _toConsumableArray from "@babel/runtime/helpers/toConsumableArray";
+function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
+function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { _defineProperty(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
+var compareRanks = function compareRanks(left, right) {
+  for (var index = 0; index < Math.max(left.length, right.length); index++) {
+    var _left$index, _right$index;
+    var difference = ((_left$index = left[index]) !== null && _left$index !== void 0 ? _left$index : 0) - ((_right$index = right[index]) !== null && _right$index !== void 0 ? _right$index : 0);
+    if (difference !== 0) {
+      return difference;
+    }
+  }
+  return 0;
+};
+var isVisible = function isVisible(registration) {
+  var _registration$isHidde;
+  return ((_registration$isHidde = registration.isHidden) === null || _registration$isHidde === void 0 ? void 0 : _registration$isHidde.call(registration)) !== true;
+};
+var getChildren = function getChildren(components, parentKey) {
+  return components.filter(function (component) {
+    var _component$parents;
+    return isVisible(component) && ((_component$parents = component.parents) === null || _component$parents === void 0 ? void 0 : _component$parents.some(function (parent) {
+      return parent.key === parentKey;
+    }));
+  });
+};
+var getParentRank = function getParentRank(registration, parentKey) {
+  var _registration$parents, _registration$parents2;
+  return (_registration$parents = (_registration$parents2 = registration.parents) === null || _registration$parents2 === void 0 || (_registration$parents2 = _registration$parents2.find(function (parent) {
+    return parent.key === parentKey;
+  })) === null || _registration$parents2 === void 0 ? void 0 : _registration$parents2.rank) !== null && _registration$parents !== void 0 ? _registration$parents : Number.MAX_SAFE_INTEGER;
+};
+var _getDescendantItems = function getDescendantItems(components, parentKey, ancestorRanks, sectionKey) {
+  return getChildren(components, parentKey).flatMap(function (component) {
+    var ranks = [].concat(_toConsumableArray(ancestorRanks), [getParentRank(component, parentKey)]);
+    if (component.type === 'menu-item') {
+      return component.component ? [{
+        ranks: ranks,
+        registration: component,
+        sectionKeys: [sectionKey]
+      }] : [];
+    }
+    return _getDescendantItems(components, component.key, ranks, sectionKey);
+  });
+};
+
+/**
+ * Builds the Element Browser's immutable open-time view of the Quick Insert registry.
+ * The caller provides only components rooted at the Quick Insert menu surface.
+ */
+export var createRegistryElementBrowserModel = function createRegistryElementBrowserModel(components, _ref) {
+  var footerKey = _ref.footerKey,
+    overflowKeys = _ref.overflowKeys,
+    recommendedSectionKey = _ref.recommendedSectionKey,
+    rootKey = _ref.rootKey;
+  var excludedKeys = new Set([footerKey, recommendedSectionKey].concat(_toConsumableArray(overflowKeys)));
+  var visibleComponents = components.filter(function (component) {
+    return isVisible(component) && !excludedKeys.has(component.key);
+  });
+  var sections = getChildren(visibleComponents, rootKey).filter(function (component) {
+    return component.type === 'menu-section';
+  }).map(function (section) {
+    return {
+      key: section.key,
+      rank: getParentRank(section, rootKey)
+    };
+  }).sort(function (left, right) {
+    return left.rank - right.rank;
+  });
+  var itemByKey = new Map();
+  sections.forEach(function (section) {
+    _getDescendantItems(visibleComponents, section.key, [section.rank], section.key).forEach(function (item) {
+      var existing = itemByKey.get(item.registration.key);
+      if (!existing) {
+        itemByKey.set(item.registration.key, item);
+        return;
+      }
+      var sectionKeys = _toConsumableArray(new Set([].concat(_toConsumableArray(existing.sectionKeys), _toConsumableArray(item.sectionKeys))));
+      itemByKey.set(item.registration.key, compareRanks(item.ranks, existing.ranks) < 0 ? _objectSpread(_objectSpread({}, item), {}, {
+        sectionKeys: sectionKeys
+      }) : _objectSpread(_objectSpread({}, existing), {}, {
+        sectionKeys: sectionKeys
+      }));
+    });
+  });
+  return {
+    items: _toConsumableArray(itemByKey.values()).sort(function (left, right) {
+      return compareRanks(left.ranks, right.ranks);
+    }),
+    sections: sections
+  };
+};
+export var getInitialRegistryElementBrowserSection = function getInitialRegistryElementBrowserSection(model, requestedSection) {
+  return model.sections.some(function (section) {
+    return section.key === requestedSection;
+  }) ? requestedSection : undefined;
+};
+export var getRegistryElementBrowserItems = function getRegistryElementBrowserItems(_ref2) {
+  var formatMessage = _ref2.formatMessage,
+    model = _ref2.model,
+    query = _ref2.query,
+    section = _ref2.section;
+  var normalizedQuery = query.trim();
+  var items = section ? model.items.filter(function (item) {
+    return item.sectionKeys.includes(section);
+  }) : model.items;
+  if (!normalizedQuery) {
+    return items;
+  }
+  return items.flatMap(function (item) {
+    var _item$registration$ma, _item$registration;
+    var result = (_item$registration$ma = (_item$registration = item.registration).match) === null || _item$registration$ma === void 0 ? void 0 : _item$registration$ma.call(_item$registration, {
+      formatMessage: formatMessage,
+      query: normalizedQuery
+    });
+    return result ? [_objectSpread(_objectSpread({}, item), {}, {
+      score: Math.min(1, Math.max(0, result.score))
+    })] : [];
+  }).sort(function (left, right) {
+    return left.score - right.score || compareRanks(left.ranks, right.ranks) || left.registration.key.localeCompare(right.registration.key);
+  });
+};

package/dist/types/entry-points/registry-element-browser.d.ts

@@ -0,0 +1 @@
+export { RegistryElementBrowser } from '../ui/RegistryElementBrowser/RegistryElementBrowser';

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

@@ -0,0 +1,25 @@
+/**
+ * @jsxRuntime classic
+ * @jsx jsx
+ */
+import React from 'react';
+import type { QuickInsertSelectionHandler } from '@atlaskit/editor-common/quick-insert/context';
+import type { EmptyStateHandler } from '@atlaskit/editor-common/types';
+import type { EditorView } from '@atlaskit/editor-prosemirror/view';
+import type { RegisterComponent } from '@atlaskit/editor-ui-control-model/types';
+type Props = {
+    components: RegisterComponent[];
+    defaultSection?: string;
+    editorView: EditorView;
+    emptyStateHandler?: EmptyStateHandler;
+    helpUrl?: string;
+    isOffline: boolean;
+    isOpen: boolean;
+    onClearSelection: () => void;
+    onClose: () => void;
+    onCloseComplete: () => void;
+    onConfirmInsert: () => void;
+    onSelect: (handler: QuickInsertSelectionHandler) => void;
+};
+export declare const RegistryElementBrowser: ({ components, emptyStateHandler, defaultSection, helpUrl, editorView, isOffline, isOpen, onClearSelection, onClose, onCloseComplete, onConfirmInsert, onSelect, }: Props) => React.JSX.Element | null;
+export {};

package/dist/types/ui/RegistryElementBrowser/RegistryElementBrowserCategories.d.ts

@@ -0,0 +1,14 @@
+/**
+ * @jsxRuntime classic
+ * @jsx jsx
+ */
+import React from 'react';
+import type { RegistryElementBrowserSection } from './model';
+type Props = {
+    onSectionClick: (event: React.MouseEvent<HTMLButtonElement>) => void;
+    query: string;
+    section?: string;
+    sections: RegistryElementBrowserSection[];
+};
+export declare const RegistryElementBrowserCategories: ({ query, section, sections, onSectionClick, }: Props) => React.JSX.Element;
+export {};

package/dist/types/ui/RegistryElementBrowser/RegistryElementBrowserFooter.d.ts

@@ -0,0 +1,9 @@
+import React from 'react';
+type Props = {
+    helpUrl?: string;
+    isInsertEnabled: boolean;
+    onClose: () => void;
+    onConfirmInsert: () => void;
+};
+export declare const RegistryElementBrowserFooter: ({ helpUrl, isInsertEnabled, onClose, onConfirmInsert, }: Props) => React.JSX.Element;
+export {};

package/dist/types/ui/RegistryElementBrowser/RegistryElementBrowserSearchResults.d.ts

@@ -0,0 +1,31 @@
+/**
+ * @jsxRuntime classic
+ * @jsx jsx
+ */
+import React from 'react';
+import type { QuickInsertSelectionHandler } from '@atlaskit/editor-common/quick-insert/context';
+import type { EmptyStateHandler } from '@atlaskit/editor-common/types';
+import type { EditorView } from '@atlaskit/editor-prosemirror/view';
+import type { RegistryElementBrowserItem } from './model';
+type Props = {
+    editorView: EditorView;
+    emptyStateHandler?: EmptyStateHandler;
+    isOffline: boolean;
+    items: RegistryElementBrowserItem[];
+    onKeyDown: (event: React.KeyboardEvent) => void;
+    onSearchChange: (event: React.ChangeEvent<HTMLInputElement>) => void;
+    onSelect: (key: string, handler: QuickInsertSelectionHandler) => void;
+    query: string;
+    resultsId: string;
+    section?: string;
+    selectedKey?: string;
+};
+declare const RegistryElementBrowserItem: ({ editorView, isOffline, isSelected, item, onSelect, }: {
+    editorView: EditorView;
+    isOffline: boolean;
+    isSelected: boolean;
+    item: RegistryElementBrowserItem;
+    onSelect: (key: string, handler: QuickInsertSelectionHandler) => void;
+}) => React.JSX.Element | null;
+export declare const RegistryElementBrowserSearchResults: ({ editorView, emptyStateHandler, isOffline, items, query, resultsId, section, selectedKey, onKeyDown, onSearchChange, onSelect, }: Props) => React.JSX.Element;
+export {};

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

@@ -0,0 +1,9 @@
+import React from 'react';
+import type { ExtractInjectionAPI } from '@atlaskit/editor-common/types';
+import type { EditorView } from '@atlaskit/editor-prosemirror/view';
+import type { QuickInsertPlugin } from '../../quickInsertPluginType';
+export declare const RegistryElementBrowserContainer: ({ editorView, pluginInjectionAPI, helpUrl, }: {
+    editorView: EditorView;
+    helpUrl?: string;
+    pluginInjectionAPI: ExtractInjectionAPI<QuickInsertPlugin> | undefined;
+}) => React.JSX.Element;

package/dist/types/ui/RegistryElementBrowser/model.d.ts

@@ -0,0 +1,31 @@
+import type { MenuItemMatchContext, RegisterComponent, RegisterMenuItem } from '@atlaskit/editor-ui-control-model/types';
+export type RegistryElementBrowserSection = {
+    key: string;
+    rank: number;
+};
+export type RegistryElementBrowserItem = {
+    ranks: number[];
+    registration: RegisterMenuItem;
+    sectionKeys: string[];
+};
+export type RegistryElementBrowserModel = {
+    items: RegistryElementBrowserItem[];
+    sections: RegistryElementBrowserSection[];
+};
+/**
+ * Builds the Element Browser's immutable open-time view of the Quick Insert registry.
+ * The caller provides only components rooted at the Quick Insert menu surface.
+ */
+export declare const createRegistryElementBrowserModel: (components: RegisterComponent[], { footerKey, overflowKeys, recommendedSectionKey, rootKey, }: {
+    footerKey: string;
+    overflowKeys: Set<string>;
+    recommendedSectionKey: string;
+    rootKey: string;
+}) => RegistryElementBrowserModel;
+export declare const getInitialRegistryElementBrowserSection: (model: RegistryElementBrowserModel, requestedSection?: string) => string | undefined;
+export declare const getRegistryElementBrowserItems: ({ formatMessage, model, query, section, }: {
+    formatMessage: MenuItemMatchContext['formatMessage'];
+    model: RegistryElementBrowserModel;
+    query: string;
+    section?: string;
+}) => RegistryElementBrowserItem[];

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-plugin-quick-insert",
-	"version": "15.1.4",
+	"version": "16.0.0",
 	"description": "Quick insert plugin for @atlaskit/editor-core",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -22,24 +22,29 @@
 	"atlaskit:src": "src/index.ts",
 	"dependencies": {
 		"@atlaskit/button": "^25.2.0",
-		"@atlaskit/editor-plugin-analytics": "^15.0.0",
-		"@atlaskit/editor-plugin-connectivity": "^15.0.0",
-		"@atlaskit/editor-plugin-metrics": "^16.0.0",
-		"@atlaskit/editor-plugin-type-ahead": "^16.1.0",
-		"@atlaskit/editor-plugin-ui-control-registry": "^9.0.0",
+		"@atlaskit/css": "^1.0.0",
+		"@atlaskit/editor-plugin-analytics": "^16.0.0",
+		"@atlaskit/editor-plugin-connectivity": "^16.0.0",
+		"@atlaskit/editor-plugin-metrics": "^17.0.0",
+		"@atlaskit/editor-plugin-type-ahead": "^17.0.0",
+		"@atlaskit/editor-plugin-ui-control-registry": "^10.0.0",
 		"@atlaskit/editor-prosemirror": "^8.0.0",
 		"@atlaskit/editor-ui-control-model": "^2.8.0",
+		"@atlaskit/heading": "^7.1.0",
 		"@atlaskit/icon": "^37.5.0",
 		"@atlaskit/modal-dialog": "^16.5.0",
 		"@atlaskit/platform-feature-experiments": "^0.3.0",
 		"@atlaskit/platform-feature-flags": "^2.1.0",
+		"@atlaskit/primitives": "^22.4.0",
+		"@atlaskit/textfield": "^10.1.0",
 		"@atlaskit/tmp-editor-statsig": "^160.0.0",
 		"@atlaskit/tokens": "^16.8.0",
 		"@babel/runtime": "^7.0.0",
+		"@compiled/react": "^1.0.2",
 		"@emotion/react": "^11.7.1"
 	},
 	"peerDependencies": {
-		"@atlaskit/editor-common": "^119.16.0",
+		"@atlaskit/editor-common": "^120.0.0",
 		"react": "^18.2.0 || ^19.2.0",
 		"react-dom": "^18.2.0 || ^19.2.0",
 		"react-intl": "^5.25.1 || ^6.0.0 || ^7.0.0"

package/registry-element-browser/package.json

@@ -0,0 +1,10 @@
+{
+  "name": "@atlaskit/editor-plugin-quick-insert/registry-element-browser",
+  "main": "../dist/cjs/entry-points/registry-element-browser.js",
+  "module": "../dist/esm/entry-points/registry-element-browser.js",
+  "module:es2019": "../dist/es2019/entry-points/registry-element-browser.js",
+  "sideEffects": [
+    "*.compiled.css"
+  ],
+  "types": "../dist/types/entry-points/registry-element-browser.d.ts"
+}