@atlaskit/editor-common 94.0.0 → 94.1.0

package/CHANGELOG.md

@@ -1,5 +1,14 @@
 # @atlaskit/editor-common
 
+## 94.1.0
+
+### Minor Changes
+
+- [#154398](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/154398)
+  [`ca1591355d790`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/ca1591355d790) -
+  [ux] Allows for passing functions to the quickInsert plugin that allow for capturing element
+  insertion metrics and then using that data to change the element sort order
+
 ## 94.0.0
 
 ### Major Changes

package/afm-jira/tsconfig.json

@@ -146,9 +146,6 @@
     {
       "path": "../../../design-system/tooltip/afm-jira/tsconfig.json"
     },
-    {
-      "path": "../../../data/ufo-external/afm-jira/tsconfig.json"
-    },
     {
       "path": "../../../design-system/width-detector/afm-jira/tsconfig.json"
     },

package/afm-post-office/tsconfig.json

@@ -146,9 +146,6 @@
     {
       "path": "../../../design-system/tooltip/afm-post-office/tsconfig.json"
     },
-    {
-      "path": "../../../data/ufo-external/afm-post-office/tsconfig.json"
-    },
     {
       "path": "../../../design-system/width-detector/afm-post-office/tsconfig.json"
     },

package/dist/cjs/monitoring/error.js

@@ -17,7 +17,7 @@ function _getRequireWildcardCache(e) { if ("function" != typeof WeakMap) return
 function _interopRequireWildcard(e, r) { if (!r && e && e.__esModule) return e; if (null === e || "object" != _typeof(e) && "function" != typeof e) return { default: e }; var t = _getRequireWildcardCache(r); if (t && t.has(e)) return t.get(e); var n = { __proto__: null }, a = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var u in e) if ("default" !== u && {}.hasOwnProperty.call(e, u)) { var i = a ? Object.getOwnPropertyDescriptor(e, u) : null; i && (i.get || i.set) ? Object.defineProperty(n, u, i) : n[u] = e[u]; } return n.default = e, t && t.set(e, n), n; }
 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 = "94.0.0";
+var packageVersion = "94.1.0";
 var sanitiseSentryEvents = function sanitiseSentryEvents(data, _hint) {
   // Remove URL as it has UGC
   // TODO: Sanitise the URL instead of just removing it

package/dist/cjs/quick-insert/utils.js

@@ -6,8 +6,11 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.find = find;
 exports.memoProcessQuickInsertItems = void 0;
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
 var _fuse = _interopRequireDefault(require("fuse.js"));
 var _memoizeOne = _interopRequireDefault(require("memoize-one"));
+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) { (0, _defineProperty2.default)(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 processQuickInsertItems = function processQuickInsertItems(items, intl) {
   return items.reduce(function (acc, item) {
     if (typeof item === 'function' &&
@@ -35,6 +38,7 @@ var memoProcessQuickInsertItems = exports.memoProcessQuickInsertItems = function
 };
 var options = {
   threshold: 0.3,
+  includeScore: true,
   keys: [{
     name: 'title',
     weight: 0.57
@@ -61,8 +65,12 @@ var options = {
  * @param {QuickInsertItem[]} items - An array of QuickInsertItems to be searched.
  * @returns {QuickInsertItem[]} - Returns a sorted array of QuickInsertItems based on the priority. If the query string is empty, it will return the array sorted by priority. If a query string is provided, it will return an array of QuickInsertItems that match the query string, sorted by relevance to the query.
  */
-function find(query, items) {
-  var fuse = new _fuse.default(items, options);
+function find(query, items, prioritySortingFn) {
+  var fuseOptions = _objectSpread({}, options);
+  if (prioritySortingFn) {
+    fuseOptions.sortFn = prioritySortingFn(items);
+  }
+  var fuse = new _fuse.default(items, fuseOptions);
   if (query === '') {
     // Copy and sort list by priority
     return items.slice(0).sort(function (a, b) {

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 = "94.0.0";
+var packageVersion = "94.1.0";
 var halfFocusRing = 1;
 var dropOffset = '0, 8';
 var DropList = /*#__PURE__*/function (_Component) {

package/dist/es2019/monitoring/error.js

@@ -1,7 +1,7 @@
 import { isFedRamp } from './environment';
 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 = "94.0.0";
+const packageVersion = "94.1.0";
 const sanitiseSentryEvents = (data, _hint) => {
   // Remove URL as it has UGC
   // TODO: Sanitise the URL instead of just removing it

package/dist/es2019/quick-insert/utils.js

@@ -23,6 +23,7 @@ export const memoProcessQuickInsertItems = (items, intl) => {
 };
 const options = {
   threshold: 0.3,
+  includeScore: true,
   keys: [{
     name: 'title',
     weight: 0.57
@@ -49,8 +50,14 @@ const options = {
  * @param {QuickInsertItem[]} items - An array of QuickInsertItems to be searched.
  * @returns {QuickInsertItem[]} - Returns a sorted array of QuickInsertItems based on the priority. If the query string is empty, it will return the array sorted by priority. If a query string is provided, it will return an array of QuickInsertItems that match the query string, sorted by relevance to the query.
  */
-export function find(query, items) {
-  const fuse = new Fuse(items, options);
+export function find(query, items, prioritySortingFn) {
+  const fuseOptions = {
+    ...options
+  };
+  if (prioritySortingFn) {
+    fuseOptions.sortFn = prioritySortingFn(items);
+  }
+  const fuse = new Fuse(items, fuseOptions);
   if (query === '') {
     // Copy and sort list by priority
     return items.slice(0).sort((a, b) => (a.priority || Number.POSITIVE_INFINITY) - (b.priority || Number.POSITIVE_INFINITY));

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

@@ -13,7 +13,7 @@ import withAnalyticsContext from '@atlaskit/analytics-next/withAnalyticsContext'
 import withAnalyticsEvents from '@atlaskit/analytics-next/withAnalyticsEvents';
 import Layer from '../Layer';
 const packageName = "@atlaskit/editor-common";
-const packageVersion = "94.0.0";
+const packageVersion = "94.1.0";
 const halfFocusRing = 1;
 const dropOffset = '0, 8';
 class DropList extends Component {

package/dist/esm/monitoring/error.js

@@ -7,7 +7,7 @@ function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t =
 import { isFedRamp } from './environment';
 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 = "94.0.0";
+var packageVersion = "94.1.0";
 var sanitiseSentryEvents = function sanitiseSentryEvents(data, _hint) {
   // Remove URL as it has UGC
   // TODO: Sanitise the URL instead of just removing it

package/dist/esm/quick-insert/utils.js

@@ -1,3 +1,6 @@
+import _defineProperty from "@babel/runtime/helpers/defineProperty";
+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; }
 import Fuse from 'fuse.js';
 import memoizeOne from 'memoize-one';
 var processQuickInsertItems = function processQuickInsertItems(items, intl) {
@@ -27,6 +30,7 @@ export var memoProcessQuickInsertItems = function memoProcessQuickInsertItems(it
 };
 var options = {
   threshold: 0.3,
+  includeScore: true,
   keys: [{
     name: 'title',
     weight: 0.57
@@ -53,8 +57,12 @@ var options = {
  * @param {QuickInsertItem[]} items - An array of QuickInsertItems to be searched.
  * @returns {QuickInsertItem[]} - Returns a sorted array of QuickInsertItems based on the priority. If the query string is empty, it will return the array sorted by priority. If a query string is provided, it will return an array of QuickInsertItems that match the query string, sorted by relevance to the query.
  */
-export function find(query, items) {
-  var fuse = new Fuse(items, options);
+export function find(query, items, prioritySortingFn) {
+  var fuseOptions = _objectSpread({}, options);
+  if (prioritySortingFn) {
+    fuseOptions.sortFn = prioritySortingFn(items);
+  }
+  var fuse = new Fuse(items, fuseOptions);
   if (query === '') {
     // Copy and sort list by priority
     return items.slice(0).sort(function (a, b) {

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

@@ -21,7 +21,7 @@ import withAnalyticsContext from '@atlaskit/analytics-next/withAnalyticsContext'
 import withAnalyticsEvents from '@atlaskit/analytics-next/withAnalyticsEvents';
 import Layer from '../Layer';
 var packageName = "@atlaskit/editor-common";
-var packageVersion = "94.0.0";
+var packageVersion = "94.1.0";
 var halfFocusRing = 1;
 var dropOffset = '0, 8';
 var DropList = /*#__PURE__*/function (_Component) {

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

@@ -1,3 +1,4 @@
+import Fuse from 'fuse.js';
 import type { IntlShape } from 'react-intl-next';
 import type { QuickInsertItem } from '../provider-factory';
 import type { QuickInsertHandler } from '../types';
@@ -10,4 +11,4 @@ export declare const memoProcessQuickInsertItems: (items: Array<QuickInsertHandl
  * @param {QuickInsertItem[]} items - An array of QuickInsertItems to be searched.
  * @returns {QuickInsertItem[]} - Returns a sorted array of QuickInsertItems based on the priority. If the query string is empty, it will return the array sorted by priority. If a query string is provided, it will return an array of QuickInsertItems that match the query string, sorted by relevance to the query.
  */
-export declare function find(query: string, items: QuickInsertItem[]): QuickInsertItem[];
+export declare function find(query: string, items: QuickInsertItem[], prioritySortingFn?: (items: QuickInsertItem[]) => Fuse.FuseSortFunction): QuickInsertItem[];

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

@@ -1,8 +1,11 @@
+import type Fuse from 'fuse.js';
 import type { IntlShape } from 'react-intl-next';
 import type { QuickInsertItem, QuickInsertProvider } from '../provider-factory';
 import type { EmptyStateHandler } from './empty-state-handler';
 export type QuickInsertOptions = boolean | {
-    provider: Promise<QuickInsertProvider>;
+    provider?: Promise<QuickInsertProvider>;
+    prioritySortingFn?: (items: QuickInsertItem[]) => Fuse.FuseSortFunction;
+    onInsert?: (item: QuickInsertItem) => void;
 };
 export type QuickInsertHandlerFn = ((intl: IntlShape) => Array<QuickInsertItem>) & {
     disableMemo?: boolean;
@@ -16,6 +19,7 @@ export type QuickInsertSearchOptions = {
     category?: string;
     disableDefaultItems?: boolean;
     featuredItems?: boolean;
+    prioritySortingFn?: (items: QuickInsertItem[]) => Fuse.FuseSortFunction;
 };
 export type QuickInsertPluginState = {
     isElementBrowserModalOpen: boolean;
@@ -32,6 +36,8 @@ export interface QuickInsertPluginOptions {
     enableElementBrowser?: boolean;
     elementBrowserHelpUrl?: string;
     emptyStateHandler?: EmptyStateHandler;
+    prioritySortingFn?: (items: QuickInsertItem[]) => Fuse.FuseSortFunction;
+    onInsert?: (item: QuickInsertItem) => void;
 }
 export type QuickInsertSharedState = {
     lazyDefaultItems: () => QuickInsertItem[];

package/dist/types-ts4.5/quick-insert/utils.d.ts

@@ -1,3 +1,4 @@
+import Fuse from 'fuse.js';
 import type { IntlShape } from 'react-intl-next';
 import type { QuickInsertItem } from '../provider-factory';
 import type { QuickInsertHandler } from '../types';
@@ -10,4 +11,4 @@ export declare const memoProcessQuickInsertItems: (items: Array<QuickInsertHandl
  * @param {QuickInsertItem[]} items - An array of QuickInsertItems to be searched.
  * @returns {QuickInsertItem[]} - Returns a sorted array of QuickInsertItems based on the priority. If the query string is empty, it will return the array sorted by priority. If a query string is provided, it will return an array of QuickInsertItems that match the query string, sorted by relevance to the query.
  */
-export declare function find(query: string, items: QuickInsertItem[]): QuickInsertItem[];
+export declare function find(query: string, items: QuickInsertItem[], prioritySortingFn?: (items: QuickInsertItem[]) => Fuse.FuseSortFunction): QuickInsertItem[];

package/dist/types-ts4.5/types/quick-insert.d.ts

@@ -1,8 +1,11 @@
+import type Fuse from 'fuse.js';
 import type { IntlShape } from 'react-intl-next';
 import type { QuickInsertItem, QuickInsertProvider } from '../provider-factory';
 import type { EmptyStateHandler } from './empty-state-handler';
 export type QuickInsertOptions = boolean | {
-    provider: Promise<QuickInsertProvider>;
+    provider?: Promise<QuickInsertProvider>;
+    prioritySortingFn?: (items: QuickInsertItem[]) => Fuse.FuseSortFunction;
+    onInsert?: (item: QuickInsertItem) => void;
 };
 export type QuickInsertHandlerFn = ((intl: IntlShape) => Array<QuickInsertItem>) & {
     disableMemo?: boolean;
@@ -16,6 +19,7 @@ export type QuickInsertSearchOptions = {
     category?: string;
     disableDefaultItems?: boolean;
     featuredItems?: boolean;
+    prioritySortingFn?: (items: QuickInsertItem[]) => Fuse.FuseSortFunction;
 };
 export type QuickInsertPluginState = {
     isElementBrowserModalOpen: boolean;
@@ -32,6 +36,8 @@ export interface QuickInsertPluginOptions {
     enableElementBrowser?: boolean;
     elementBrowserHelpUrl?: string;
     emptyStateHandler?: EmptyStateHandler;
+    prioritySortingFn?: (items: QuickInsertItem[]) => Fuse.FuseSortFunction;
+    onInsert?: (item: QuickInsertItem) => void;
 }
 export type QuickInsertSharedState = {
     lazyDefaultItems: () => QuickInsertItem[];

package/package.json

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