@atlaskit/editor-plugin-insert-block 8.4.5 → 8.5.1

package/CHANGELOG.md

@@ -1,5 +1,22 @@
 # @atlaskit/editor-plugin-insert-block
 
+## 8.5.1
+
+### Patch Changes
+
+- Updated dependencies
+
+## 8.5.0
+
+### Minor Changes
+
+- [`fcc51e510981b`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/fcc51e510981b) -
+  [ux] Add logic to filter and pin create database menu item to editor toolbar for experiment.
+
+### Patch Changes
+
+- Updated dependencies
+
 ## 8.4.5
 
 ### Patch Changes

package/dist/cjs/ui/ElementBrowser/InsertMenu.js

@@ -4,7 +4,7 @@ var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefau
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.filterForPinWhiteboards = exports.default = exports.DEFAULT_HEIGHT = void 0;
+exports.sortPrioritizedElements = exports.default = exports.DEFAULT_HEIGHT = void 0;
 var _extends2 = _interopRequireDefault(require("@babel/runtime/helpers/extends"));
 var _objectWithoutProperties2 = _interopRequireDefault(require("@babel/runtime/helpers/objectWithoutProperties"));
 var _slicedToArray2 = _interopRequireDefault(require("@babel/runtime/helpers/slicedToArray"));
@@ -21,6 +21,7 @@ var _quickInsert = require("@atlaskit/editor-common/quick-insert");
 var _uiReact = require("@atlaskit/editor-common/ui-react");
 var _editorPluginConnectivity = require("@atlaskit/editor-plugin-connectivity");
 var _colors = require("@atlaskit/theme/colors");
+var _expVal = require("@atlaskit/tmp-editor-statsig/expVal");
 var _excluded = ["children"];
 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; } /**
@@ -30,12 +31,24 @@ function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t =
 var DEFAULT_HEIGHT = exports.DEFAULT_HEIGHT = 560;
 
 /**
- * Exported helper to allow testing of InsertMenu whiteboard pinning logic. NOTE: this is
+ * Exported helper to allow testing of InsertMenu pinning logic. NOTE: this is
    *not* the ideal way to approach this, quickinsert plugin provides a `getSuggestions`
    method that can be used to get suggestions -> once all experiments are cleaned up,
    they should be unified through `pluginInjectionApi?.quickInsert?.actions.getSuggestions`
+
+   `cc_fd_db_top_editor_toolbar` experiment adds new logic to sort elements by `priority`
+   this newer implementation matches how the "quick insert menu" sorts elements
  */
-var filterForPinWhiteboards = exports.filterForPinWhiteboards = function filterForPinWhiteboards(featuredItems, formatMessage) {
+var sortPrioritizedElements = exports.sortPrioritizedElements = function sortPrioritizedElements(featuredItems, formatMessage) {
+  if (['new-description', 'orig-description'].includes((0, _expVal.expVal)('cc_fd_db_top_editor_toolbar', 'cohort', 'control'))) {
+    // Sort by priority (lower first) on the concatenated list so items
+    // with "priority" are at the top (e.g. Whiteboard before Database)
+    return featuredItems.slice(0).sort(function (a, b) {
+      return (a.priority || Number.POSITIVE_INFINITY) - (b.priority || Number.POSITIVE_INFINITY);
+    });
+  }
+
+  // old logic sort whiteboards to top
   var DIAGRAM_KEY = 'whiteboard-extension:create-diagram';
   var isDiagram = function isDiagram(item) {
     return item.key === DIAGRAM_KEY;
@@ -170,8 +183,8 @@ var InsertMenu = function InsertMenu(_ref) {
         }) : item;
       })) !== null && _pluginInjectionApi$q4 !== void 0 ? _pluginInjectionApi$q4 : [];
       var unfilteredResult = quickInsertDropdownItems.concat(featuredQuickInsertSuggestions);
-      // need to filter on the concatenated list so whiteboards are at the top
-      result = filterForPinWhiteboards(unfilteredResult, formatMessage);
+      // need to sort on the concatenated list so desired elements are at the top
+      result = sortPrioritizedElements(unfilteredResult, formatMessage);
     }
     setItemCount(result.length);
     return result;

package/dist/es2019/ui/ElementBrowser/InsertMenu.js

@@ -17,15 +17,26 @@ import { messages, IconCode, IconDate, IconDecision, IconDivider, IconExpand, Ic
 import { OutsideClickTargetRefContext, withReactEditorViewOuterListeners as withOuterListeners } from '@atlaskit/editor-common/ui-react';
 import { isOfflineMode } from '@atlaskit/editor-plugin-connectivity';
 import { N0, N30A, N60A } from '@atlaskit/theme/colors';
+import { expVal } from '@atlaskit/tmp-editor-statsig/expVal';
 export const DEFAULT_HEIGHT = 560;
 
 /**
- * Exported helper to allow testing of InsertMenu whiteboard pinning logic. NOTE: this is
+ * Exported helper to allow testing of InsertMenu pinning logic. NOTE: this is
    *not* the ideal way to approach this, quickinsert plugin provides a `getSuggestions`
    method that can be used to get suggestions -> once all experiments are cleaned up,
    they should be unified through `pluginInjectionApi?.quickInsert?.actions.getSuggestions`
+
+   `cc_fd_db_top_editor_toolbar` experiment adds new logic to sort elements by `priority`
+   this newer implementation matches how the "quick insert menu" sorts elements
  */
-export const filterForPinWhiteboards = (featuredItems, formatMessage) => {
+export const sortPrioritizedElements = (featuredItems, formatMessage) => {
+  if (['new-description', 'orig-description'].includes(expVal('cc_fd_db_top_editor_toolbar', 'cohort', 'control'))) {
+    // Sort by priority (lower first) on the concatenated list so items
+    // with "priority" are at the top (e.g. Whiteboard before Database)
+    return featuredItems.slice(0).sort((a, b) => (a.priority || Number.POSITIVE_INFINITY) - (b.priority || Number.POSITIVE_INFINITY));
+  }
+
+  // old logic sort whiteboards to top
   const DIAGRAM_KEY = 'whiteboard-extension:create-diagram';
   const isDiagram = item => item.key === DIAGRAM_KEY;
   const featuredWhiteboardsPresent = featuredItems.some(isDiagram);
@@ -142,8 +153,8 @@ const InsertMenu = ({
         isDisabled: true
       } : item)) !== null && _pluginInjectionApi$q5 !== void 0 ? _pluginInjectionApi$q5 : [];
       const unfilteredResult = quickInsertDropdownItems.concat(featuredQuickInsertSuggestions);
-      // need to filter on the concatenated list so whiteboards are at the top
-      result = filterForPinWhiteboards(unfilteredResult, formatMessage);
+      // need to sort on the concatenated list so desired elements are at the top
+      result = sortPrioritizedElements(unfilteredResult, formatMessage);
     }
     setItemCount(result.length);
     return result;

package/dist/esm/ui/ElementBrowser/InsertMenu.js

@@ -24,15 +24,28 @@ import { messages, IconCode, IconDate, IconDecision, IconDivider, IconExpand, Ic
 import { OutsideClickTargetRefContext, withReactEditorViewOuterListeners as withOuterListeners } from '@atlaskit/editor-common/ui-react';
 import { isOfflineMode } from '@atlaskit/editor-plugin-connectivity';
 import { N0, N30A, N60A } from '@atlaskit/theme/colors';
+import { expVal } from '@atlaskit/tmp-editor-statsig/expVal';
 export var DEFAULT_HEIGHT = 560;
 
 /**
- * Exported helper to allow testing of InsertMenu whiteboard pinning logic. NOTE: this is
+ * Exported helper to allow testing of InsertMenu pinning logic. NOTE: this is
    *not* the ideal way to approach this, quickinsert plugin provides a `getSuggestions`
    method that can be used to get suggestions -> once all experiments are cleaned up,
    they should be unified through `pluginInjectionApi?.quickInsert?.actions.getSuggestions`
+
+   `cc_fd_db_top_editor_toolbar` experiment adds new logic to sort elements by `priority`
+   this newer implementation matches how the "quick insert menu" sorts elements
  */
-export var filterForPinWhiteboards = function filterForPinWhiteboards(featuredItems, formatMessage) {
+export var sortPrioritizedElements = function sortPrioritizedElements(featuredItems, formatMessage) {
+  if (['new-description', 'orig-description'].includes(expVal('cc_fd_db_top_editor_toolbar', 'cohort', 'control'))) {
+    // Sort by priority (lower first) on the concatenated list so items
+    // with "priority" are at the top (e.g. Whiteboard before Database)
+    return featuredItems.slice(0).sort(function (a, b) {
+      return (a.priority || Number.POSITIVE_INFINITY) - (b.priority || Number.POSITIVE_INFINITY);
+    });
+  }
+
+  // old logic sort whiteboards to top
   var DIAGRAM_KEY = 'whiteboard-extension:create-diagram';
   var isDiagram = function isDiagram(item) {
     return item.key === DIAGRAM_KEY;
@@ -167,8 +180,8 @@ var InsertMenu = function InsertMenu(_ref) {
         }) : item;
       })) !== null && _pluginInjectionApi$q4 !== void 0 ? _pluginInjectionApi$q4 : [];
       var unfilteredResult = quickInsertDropdownItems.concat(featuredQuickInsertSuggestions);
-      // need to filter on the concatenated list so whiteboards are at the top
-      result = filterForPinWhiteboards(unfilteredResult, formatMessage);
+      // need to sort on the concatenated list so desired elements are at the top
+      result = sortPrioritizedElements(unfilteredResult, formatMessage);
     }
     setItemCount(result.length);
     return result;

package/dist/types/ui/ElementBrowser/InsertMenu.d.ts

@@ -4,11 +4,14 @@ import type { QuickInsertItem } from '@atlaskit/editor-common/provider-factory';
 import type { InsertMenuProps } from './types';
 export declare const DEFAULT_HEIGHT = 560;
 /**
- * Exported helper to allow testing of InsertMenu whiteboard pinning logic. NOTE: this is
+ * Exported helper to allow testing of InsertMenu pinning logic. NOTE: this is
    *not* the ideal way to approach this, quickinsert plugin provides a `getSuggestions`
    method that can be used to get suggestions -> once all experiments are cleaned up,
    they should be unified through `pluginInjectionApi?.quickInsert?.actions.getSuggestions`
+
+   `cc_fd_db_top_editor_toolbar` experiment adds new logic to sort elements by `priority`
+   this newer implementation matches how the "quick insert menu" sorts elements
  */
-export declare const filterForPinWhiteboards: (featuredItems: QuickInsertItem[], formatMessage: (msg: MessageDescriptor) => string) => QuickInsertItem[];
+export declare const sortPrioritizedElements: (featuredItems: QuickInsertItem[], formatMessage: (msg: MessageDescriptor) => string) => QuickInsertItem[];
 declare const InsertMenu: ({ editorView, dropdownItems, showElementBrowserLink, onInsert, toggleVisiblity, pluginInjectionApi, }: InsertMenuProps) => jsx.JSX.Element;
 export default InsertMenu;

package/dist/types-ts4.5/ui/ElementBrowser/InsertMenu.d.ts

@@ -4,11 +4,14 @@ import type { QuickInsertItem } from '@atlaskit/editor-common/provider-factory';
 import type { InsertMenuProps } from './types';
 export declare const DEFAULT_HEIGHT = 560;
 /**
- * Exported helper to allow testing of InsertMenu whiteboard pinning logic. NOTE: this is
+ * Exported helper to allow testing of InsertMenu pinning logic. NOTE: this is
    *not* the ideal way to approach this, quickinsert plugin provides a `getSuggestions`
    method that can be used to get suggestions -> once all experiments are cleaned up,
    they should be unified through `pluginInjectionApi?.quickInsert?.actions.getSuggestions`
+
+   `cc_fd_db_top_editor_toolbar` experiment adds new logic to sort elements by `priority`
+   this newer implementation matches how the "quick insert menu" sorts elements
  */
-export declare const filterForPinWhiteboards: (featuredItems: QuickInsertItem[], formatMessage: (msg: MessageDescriptor) => string) => QuickInsertItem[];
+export declare const sortPrioritizedElements: (featuredItems: QuickInsertItem[], formatMessage: (msg: MessageDescriptor) => string) => QuickInsertItem[];
 declare const InsertMenu: ({ editorView, dropdownItems, showElementBrowserLink, onInsert, toggleVisiblity, pluginInjectionApi, }: InsertMenuProps) => jsx.JSX.Element;
 export default InsertMenu;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-plugin-insert-block",
-	"version": "8.4.5",
+	"version": "8.5.1",
 	"description": "Insert block plugin for @atlaskit/editor-core",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -65,7 +65,7 @@
 		"@atlaskit/icon-lab": "^5.15.0",
 		"@atlaskit/platform-feature-flags": "^1.1.0",
 		"@atlaskit/theme": "^21.0.0",
-		"@atlaskit/tmp-editor-statsig": "^23.0.0",
+		"@atlaskit/tmp-editor-statsig": "^24.0.0",
 		"@atlaskit/tokens": "^11.0.0",
 		"@babel/runtime": "^7.0.0",
 		"@emotion/react": "^11.7.1",