@atlaskit/editor-plugin-quick-insert
Version:
Quick insert plugin for @atlaskit/editor-core
335 lines (332 loc) • 16.1 kB
JavaScript
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; }
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 { ASK_ROVO_MENU_ITEM, MENU, RECOMMENDED_SECTION, SEARCH_RESULTS_SECTION } from '@atlaskit/editor-common/quick-insert/keys';
import { applyRegisteredItemRanks } from '@atlaskit/editor-common/registered-menu/item-rank';
import { isMenuFooterSectionKey } from '@atlaskit/editor-common/type-ahead-is-menu-footer-section-key';
import { isSectionOverflowItemKey } from '@atlaskit/editor-common/type-ahead-is-section-overflow-item-key';
import { getComponentIdentity, resolveSurface, willComponentRender } from '@atlaskit/editor-ui-control-model/surface-renderer';
import { normalizeQuickInsertMatchResult } from '../normalizeQuickInsertMatchResult';
import { QuickInsertSearchResultsSection } from './QuickInsertSearchResultsSection';
var SEARCH_TOP_MATCH_LIMIT = 5;
var SEARCH_RESULTS_HEADING = {
key: SEARCH_RESULTS_SECTION.key,
type: SEARCH_RESULTS_SECTION.type,
component: QuickInsertSearchResultsSection,
parents: [{
key: MENU.key,
type: MENU.type,
rank: 0
}]
};
var getParentRank = function getParentRank(component, parentKey) {
var _component$parents$fi, _component$parents;
return (_component$parents$fi = (_component$parents = component.parents) === null || _component$parents === void 0 || (_component$parents = _component$parents.find(function (parent) {
return parent.key === parentKey;
})) === null || _component$parents === void 0 ? void 0 : _component$parents.rank) !== null && _component$parents$fi !== void 0 ? _component$parents$fi : Number.MAX_SAFE_INTEGER;
};
var compareMatchedItems = function compareMatchedItems(a, b) {
return a.sectionRank - b.sectionRank || a.score - b.score || a.itemRank - b.itemRank || a.sourceIndex - b.sourceIndex || a.identity.localeCompare(b.identity);
};
var compareSearchResults = function compareSearchResults(a, b) {
return a.score - b.score || a.sectionRank - b.sectionRank || a.itemRank - b.itemRank || a.sourceIndex - b.sourceIndex || a.identity.localeCompare(b.identity);
};
var comparePrioritizedSearchResults = function comparePrioritizedSearchResults(a, b) {
var _b$priorityGroup, _a$priorityGroup;
return ((_b$priorityGroup = b.priorityGroup) !== null && _b$priorityGroup !== void 0 ? _b$priorityGroup : 0) - ((_a$priorityGroup = a.priorityGroup) !== null && _a$priorityGroup !== void 0 ? _a$priorityGroup : 0) || compareSearchResults(a, b);
};
var getSearchResults = function getSearchResults(matches) {
var topMatches = Array.from(matches).sort(compareSearchResults).slice(0, SEARCH_TOP_MATCH_LIMIT);
var topMatchIdentities = new Set(topMatches.map(function (_ref) {
var identity = _ref.identity;
return identity;
}));
return [].concat(_toConsumableArray(topMatches), _toConsumableArray(matches.filter(function (_ref2) {
var identity = _ref2.identity;
return !topMatchIdentities.has(identity);
})));
};
/** Recommended uses resolved items rather than registered children. */
var readMenuSections = function readMenuSections(_ref3) {
var childrenMap = _ref3.childrenMap,
_ref3$recommendedItem = _ref3.recommendedItems,
recommendedItems = _ref3$recommendedItem === void 0 ? [] : _ref3$recommendedItem,
sections = _ref3.sections,
surfaceContext = _ref3.surfaceContext;
var renderedSections = [];
var _iterator = _createForOfIteratorHelper(sections),
_step;
try {
for (_iterator.s(); !(_step = _iterator.n()).done;) {
var _section$isHidden, _section$isHidden2, _childrenMap$get;
var section = _step.value;
if (section.type !== 'menu-section') {
continue;
}
if (surfaceContext ? (_section$isHidden = section.isHidden) === null || _section$isHidden === void 0 ? void 0 : _section$isHidden.call(section, {
surfaceContext: surfaceContext
}) : (_section$isHidden2 = section.isHidden) === null || _section$isHidden2 === void 0 ? void 0 : _section$isHidden2.call(section)) {
continue;
}
if (section.key === RECOMMENDED_SECTION.key) {
renderedSections.push({
section: section,
items: recommendedItems
});
continue;
}
var children = (_childrenMap$get = childrenMap.get(getComponentIdentity(section))) !== null && _childrenMap$get !== void 0 ? _childrenMap$get : [];
var items = [];
var viewMoreItem = void 0;
var _iterator2 = _createForOfIteratorHelper(children),
_step2;
try {
for (_iterator2.s(); !(_step2 = _iterator2.n()).done;) {
var child = _step2.value;
if (child.type !== 'menu-item' || !willComponentRender(child, childrenMap, surfaceContext)) {
continue;
}
if (isSectionOverflowItemKey(child.key)) {
viewMoreItem !== null && viewMoreItem !== void 0 ? viewMoreItem : viewMoreItem = child;
} else {
items.push(child);
}
}
// Empty registrations are visible leaves; containers need a visible child.
} catch (err) {
_iterator2.e(err);
} finally {
_iterator2.f();
}
if (children.length === 0 || items.length > 0 || viewMoreItem) {
renderedSections.push({
section: section,
items: items,
viewMoreItem: viewMoreItem
});
}
}
} catch (err) {
_iterator.e(err);
} finally {
_iterator.f();
}
return renderedSections;
};
var getOwnerSectionKey = function getOwnerSectionKey(item, isRecommendedItem) {
var _item$parents$;
return isRecommendedItem(item) ? RECOMMENDED_SECTION.key : (_item$parents$ = item.parents[0]) === null || _item$parents$ === void 0 ? void 0 : _item$parents$.key;
};
var buildBrowseSections = function buildBrowseSections(_ref4) {
var contentSections = _ref4.contentSections,
isRecommendedItem = _ref4.isRecommendedItem,
selectCategoryItems = _ref4.selectCategoryItems;
var sections = [];
var _iterator3 = _createForOfIteratorHelper(contentSections),
_step3;
try {
var _loop = function _loop() {
var _step3$value = _step3.value,
items = _step3$value.items,
section = _step3$value.section,
viewMoreItem = _step3$value.viewMoreItem;
var ownedItems = items.filter(function (item) {
return getOwnerSectionKey(item, isRecommendedItem) === section.key;
});
if (ownedItems.length === 0) {
return 1; // continue
}
var selectedItems = viewMoreItem && selectCategoryItems ? selectCategoryItems(ownedItems) : ownedItems;
sections.push([section].concat(_toConsumableArray(selectedItems), _toConsumableArray(viewMoreItem && selectedItems.length < ownedItems.length ? [viewMoreItem] : [])));
};
for (_iterator3.s(); !(_step3 = _iterator3.n()).done;) {
if (_loop()) continue;
}
} catch (err) {
_iterator3.e(err);
} finally {
_iterator3.f();
}
return {
fallbackItems: [],
sections: sections
};
};
var buildSearchSections = function buildSearchSections(_ref5) {
var components = _ref5.components,
contentSections = _ref5.contentSections,
formatMessage = _ref5.formatMessage,
isRecommendedItem = _ref5.isRecommendedItem,
query = _ref5.query,
root = _ref5.root;
var sourceIndexByComponent = new Map(components.map(function (component, index) {
return [component, index];
}));
var matches = new Map();
var fallbackItem;
var _iterator4 = _createForOfIteratorHelper(contentSections),
_step4;
try {
for (_iterator4.s(); !(_step4 = _iterator4.n()).done;) {
var _step4$value = _step4.value,
items = _step4$value.items,
section = _step4$value.section;
var sectionRank = getParentRank(section, root.key);
var _iterator5 = _createForOfIteratorHelper(items),
_step5;
try {
for (_iterator5.s(); !(_step5 = _iterator5.n()).done;) {
var _item$match, _sourceIndexByCompone;
var item = _step5.value;
if (item.key === ASK_ROVO_MENU_ITEM.key) {
fallbackItem !== null && fallbackItem !== void 0 ? fallbackItem : fallbackItem = item;
}
var match = (_item$match = item.match) === null || _item$match === void 0 ? void 0 : _item$match.call(item, {
formatMessage: formatMessage,
itemKey: item.key,
query: query
});
if (item.match && match === null || getOwnerSectionKey(item, isRecommendedItem) !== section.key) {
continue;
}
var normalizedMatch = normalizeQuickInsertMatchResult(match);
var candidate = _objectSpread(_objectSpread({
identity: getComponentIdentity(item),
item: item,
itemRank: getParentRank(item, section.key)
}, normalizedMatch), {}, {
sectionRank: sectionRank,
sourceIndex: (_sourceIndexByCompone = sourceIndexByComponent.get(item)) !== null && _sourceIndexByCompone !== void 0 ? _sourceIndexByCompone : Number.MAX_SAFE_INTEGER
});
var existing = matches.get(candidate.identity);
if (!existing || compareMatchedItems(candidate, existing) < 0) {
matches.set(candidate.identity, candidate);
}
}
} catch (err) {
_iterator5.e(err);
} finally {
_iterator5.f();
}
}
} catch (err) {
_iterator4.e(err);
} finally {
_iterator4.f();
}
var uniqueMatches = Array.from(matches.values()).sort(compareMatchedItems);
var prioritizedMatches = uniqueMatches.filter(function (_ref6) {
var priorityGroup = _ref6.priorityGroup;
return priorityGroup !== undefined;
});
var unprioritizedMatches = uniqueMatches.filter(function (_ref7) {
var priorityGroup = _ref7.priorityGroup;
return priorityGroup === undefined;
});
var orderedSearchResults = [].concat(_toConsumableArray(prioritizedMatches.sort(comparePrioritizedSearchResults).map(function (_ref8) {
var item = _ref8.item;
return item;
})), _toConsumableArray(getSearchResults(unprioritizedMatches).map(function (_ref9) {
var item = _ref9.item;
return item;
})));
if (orderedSearchResults.length > 0) {
return {
fallbackItems: [],
sections: [[SEARCH_RESULTS_HEADING].concat(_toConsumableArray(orderedSearchResults))]
};
}
return {
fallbackItems: fallbackItem ? [fallbackItem] : [],
sections: []
};
};
/**
* Resolves the Recommended items for a browse. Receives the unranked components so a resolver
* can look recommendations up by their registered keys.
*/
/**
* Builds the registered quick-insert menu model. An empty query browses every
* category; a non-empty query returns ranked matches. The footer is shared by both.
*/
export var getQuickInsertMenuModel = function getQuickInsertMenuModel(_ref0) {
var _root$isHidden, _root$isHidden2, _contentSections$find;
var components = _ref0.components,
formatMessage = _ref0.formatMessage,
getItemRank = _ref0.getItemRank,
getRecommendedItems = _ref0.getRecommendedItems,
query = _ref0.query,
rootComponent = _ref0.rootComponent,
selectCategoryItems = _ref0.selectCategoryItems,
surfaceContext = _ref0.surfaceContext;
var rankedComponents = applyRegisteredItemRanks(components, getItemRank);
var _resolveSurface = resolveSurface(rankedComponents, rootComponent),
childrenMap = _resolveSurface.childrenMap,
root = _resolveSurface.root,
_resolveSurface$topLe = _resolveSurface.topLevelChildren,
topLevelChildren = _resolveSurface$topLe === void 0 ? [] : _resolveSurface$topLe;
if (!root || (surfaceContext ? (_root$isHidden = root.isHidden) === null || _root$isHidden === void 0 ? void 0 : _root$isHidden.call(root, {
surfaceContext: surfaceContext
}) : (_root$isHidden2 = root.isHidden) === null || _root$isHidden2 === void 0 ? void 0 : _root$isHidden2.call(root))) {
return {
fallbackItems: [],
footer: undefined,
root: undefined,
sections: []
};
}
var isBrowse = query === '';
var renderedSections = readMenuSections({
sections: topLevelChildren,
childrenMap: childrenMap,
surfaceContext: surfaceContext,
recommendedItems: isBrowse ? getRecommendedItems === null || getRecommendedItems === void 0 ? void 0 : getRecommendedItems({
components: components,
surfaceContext: surfaceContext
}) : undefined
});
if (topLevelChildren.length > 0 && renderedSections.length === 0) {
return {
fallbackItems: [],
footer: undefined,
root: undefined,
sections: []
};
}
var footerSection = renderedSections.find(function (_ref1) {
var section = _ref1.section;
return isMenuFooterSectionKey(section.key);
});
var contentSections = renderedSections.filter(function (_ref10) {
var section = _ref10.section;
return !isMenuFooterSectionKey(section.key) && (isBrowse || section.key !== RECOMMENDED_SECTION.key);
});
var recommendedIdentities = new Set((_contentSections$find = contentSections.find(function (_ref11) {
var section = _ref11.section;
return section.key === RECOMMENDED_SECTION.key;
})) === null || _contentSections$find === void 0 ? void 0 : _contentSections$find.items.map(getComponentIdentity));
var isRecommendedItem = function isRecommendedItem(item) {
return recommendedIdentities.has(getComponentIdentity(item));
};
var content = isBrowse ? buildBrowseSections({
contentSections: contentSections,
isRecommendedItem: isRecommendedItem,
selectCategoryItems: selectCategoryItems
}) : buildSearchSections({
components: rankedComponents,
contentSections: contentSections,
formatMessage: formatMessage,
isRecommendedItem: isRecommendedItem,
query: query,
root: root
});
var footer = footerSection === null || footerSection === void 0 ? void 0 : footerSection.items[0];
return _objectSpread(_objectSpread({}, content), {}, {
footer: footer,
root: root
});
};