@atlaskit/editor-plugin-quick-insert 10.1.4 → 10.2.0

package/CHANGELOG.md

@@ -1,5 +1,59 @@
 # @atlaskit/editor-plugin-quick-insert
 
+## 10.2.0
+
+### Minor Changes
+
+- [`ef22af532ebfd`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/ef22af532ebfd) -
+  EDITOR-6558: Introduce a reusable Markdown Mode editor plugin and two consumer-supplied
+  insert-filter hooks.
+
+  ### `@atlassian/editor-plugin-markdown-mode` (new package — major)
+
+  A reusable editor plugin that owns the full Markdown Mode lifecycle: ProseMirror plugin state for
+  the active view, a 3-button view toggle (`MarkdownModeViewToggleBase`), a CodeMirror 6 source view
+  (`MarkdownSourceView`), ADF↔markdown conversion (`adfToMarkdown` / `markdownToAdf`), and the
+  snapshot/writeback orchestration (`MarkdownModeContentComponent`). The plugin is product-agnostic
+  — Confluence wraps it for the `cc-markdown-mode` experiment, but any consumer can adopt it.
+
+  The package also exports two allowlists used by the new insert-filter hooks below:
+  - `MARKDOWN_COMPATIBLE_QUICK_INSERT_ITEM_IDS` + `isMarkdownCompatibleQuickInsertItem` — items
+    whose underlying node has a clean GFM round-trip via `@atlassian/mdast-util-from-pm`.
+  - `MARKDOWN_COMPATIBLE_TOOLBAR_ITEM_NAMES` + `isMarkdownCompatibleToolbarItem` — same idea for the
+    main toolbar's `+` insert block.
+
+  ### `@atlaskit/editor-plugin-quick-insert` (minor)
+
+  Added an optional `itemFilter?: (item: QuickInsertItem) => boolean` to `QuickInsertOptions`. When
+  set, the filter is applied in both `getQuickInsertSuggestions` (the typeahead path) and the
+  `getSuggestions` action path before items are categorised or returned. Composes additively with
+  any caller-supplied filter via `&&`. No behavioural change for callers that don't set it.
+
+  ### `@atlaskit/editor-plugin-insert-block` (minor)
+
+  Added an optional `itemFilter?: (item: { value: { name: string } }) => boolean` to
+  `InsertBlockPluginOptions`. The filter is applied to the items list inside `createItems` before
+  it's split into toolbar buttons / overflow dropdown entries, so item counts stay correct
+  downstream. Wired through both legacy (`ToolbarInsertBlock`) and new (`useInsertButtonState`)
+  toolbar code paths. No behavioural change for callers that don't set it.
+
+  ### `@atlaskit/editor-common` (patch)
+
+  `UseSharedPluginStateWithSelector`-friendly types are unchanged; the only public change is a new
+  optional field on `QuickInsertOptions` and a corresponding plumbing field on the internal
+  `QuickInsertSearchOptions`.
+
+  ### `@atlassian/mdast-util-from-pm` (patch)
+
+  Added `undoEdgeWhitespaceEncoding()` post-processor that replaces the leading/trailing-edge entity
+  escapes ` ` and `	` produced by the upstream encoder with literal space and tab
+  characters. This is a readability + round-trip identity fix that benefits all consumers, not just
+  Markdown Mode.
+
+### Patch Changes
+
+- Updated dependencies
+
 ## 10.1.4
 
 ### Patch Changes

package/dist/cjs/quickInsertPlugin.js

@@ -45,7 +45,9 @@ var quickInsertPlugin = exports.quickInsertPlugin = function quickInsertPlugin(_
       return Promise.resolve((0, _search.getQuickInsertSuggestions)({
         query: query,
         disableDefaultItems: options === null || options === void 0 ? void 0 : options.disableDefaultItems,
-        prioritySortingFn: options === null || options === void 0 ? void 0 : options.prioritySortingFn
+        prioritySortingFn: options === null || options === void 0 ? void 0 : options.prioritySortingFn,
+        // EDITOR-6558: pass through consumer-supplied filter (e.g. Markdown Mode allowlist)
+        itemFilter: options === null || options === void 0 ? void 0 : options.itemFilter
       }, quickInsertState === null || quickInsertState === void 0 ? void 0 : quickInsertState.lazyDefaultItems, quickInsertState === null || quickInsertState === void 0 ? void 0 : quickInsertState.providedItems));
     },
     selectItem: function selectItem(state, item, insert) {
@@ -151,6 +153,18 @@ var quickInsertPlugin = exports.quickInsertPlugin = function quickInsertPlugin(_
             prioritySortingFn: options.prioritySortingFn
           });
         }
+
+        // EDITOR-6558: layer the consumer-supplied filter (e.g. Markdown Mode allowlist)
+        // over any caller-supplied filter so both apply.
+        if (options !== null && options !== void 0 && options.itemFilter) {
+          var consumerFilter = options.itemFilter;
+          var callerFilter = searchOptions.itemFilter;
+          searchOptions = _objectSpread(_objectSpread({}, searchOptions), {}, {
+            itemFilter: callerFilter ? function (item) {
+              return consumerFilter(item) && callerFilter(item);
+            } : consumerFilter
+          });
+        }
         return (0, _search.getQuickInsertSuggestions)(searchOptions, lazyDefaultItems, providedItems);
       }
     },

package/dist/cjs/ui/search.js

@@ -19,6 +19,7 @@ var getQuickInsertSuggestions = exports.getQuickInsertSuggestions = function get
     category = searchOptions.category,
     disableDefaultItems = searchOptions.disableDefaultItems,
     featuredItems = searchOptions.featuredItems,
+    itemFilter = searchOptions.itemFilter,
     prioritySortingFn = searchOptions.prioritySortingFn;
   var defaultItems = disableDefaultItems ? [] : lazyDefaultItems();
   var dedupeFn = function dedupeFn(item) {
@@ -26,6 +27,11 @@ var getQuickInsertSuggestions = exports.getQuickInsertSuggestions = function get
     return "".concat(item.title, "-").concat((_item$description = item.description) !== null && _item$description !== void 0 ? _item$description : '');
   };
   var items = providedItems ? (0, _utils.dedupe)([].concat((0, _toConsumableArray2.default)(defaultItems), (0, _toConsumableArray2.default)(providedItems)), dedupeFn) : defaultItems;
+
+  // EDITOR-6558: apply consumer-supplied filter (e.g. Markdown Mode allowlist).
+  if (itemFilter) {
+    items = items.filter(itemFilter);
+  }
   if (featuredItems) {
     return items.filter(function (item) {
       return item.featured;

package/dist/es2019/quickInsertPlugin.js

@@ -34,7 +34,9 @@ export const quickInsertPlugin = ({
       return Promise.resolve(getQuickInsertSuggestions({
         query: query,
         disableDefaultItems: options === null || options === void 0 ? void 0 : options.disableDefaultItems,
-        prioritySortingFn: options === null || options === void 0 ? void 0 : options.prioritySortingFn
+        prioritySortingFn: options === null || options === void 0 ? void 0 : options.prioritySortingFn,
+        // EDITOR-6558: pass through consumer-supplied filter (e.g. Markdown Mode allowlist)
+        itemFilter: options === null || options === void 0 ? void 0 : options.itemFilter
       }, quickInsertState === null || quickInsertState === void 0 ? void 0 : quickInsertState.lazyDefaultItems, quickInsertState === null || quickInsertState === void 0 ? void 0 : quickInsertState.providedItems));
     },
     selectItem: (state, item, insert) => {
@@ -141,6 +143,17 @@ export const quickInsertPlugin = ({
             prioritySortingFn: options.prioritySortingFn
           };
         }
+
+        // EDITOR-6558: layer the consumer-supplied filter (e.g. Markdown Mode allowlist)
+        // over any caller-supplied filter so both apply.
+        if (options !== null && options !== void 0 && options.itemFilter) {
+          const consumerFilter = options.itemFilter;
+          const callerFilter = searchOptions.itemFilter;
+          searchOptions = {
+            ...searchOptions,
+            itemFilter: callerFilter ? item => consumerFilter(item) && callerFilter(item) : consumerFilter
+          };
+        }
         return getQuickInsertSuggestions(searchOptions, lazyDefaultItems, providedItems);
       }
     },

package/dist/es2019/ui/search.js

@@ -8,6 +8,7 @@ export const getQuickInsertSuggestions = (searchOptions, lazyDefaultItems = () =
     category,
     disableDefaultItems,
     featuredItems,
+    itemFilter,
     prioritySortingFn
   } = searchOptions;
   const defaultItems = disableDefaultItems ? [] : lazyDefaultItems();
@@ -15,7 +16,12 @@ export const getQuickInsertSuggestions = (searchOptions, lazyDefaultItems = () =
     var _item$description;
     return `${item.title}-${(_item$description = item.description) !== null && _item$description !== void 0 ? _item$description : ''}`;
   };
-  const items = providedItems ? dedupe([...defaultItems, ...providedItems], dedupeFn) : defaultItems;
+  let items = providedItems ? dedupe([...defaultItems, ...providedItems], dedupeFn) : defaultItems;
+
+  // EDITOR-6558: apply consumer-supplied filter (e.g. Markdown Mode allowlist).
+  if (itemFilter) {
+    items = items.filter(itemFilter);
+  }
   if (featuredItems) {
     return items.filter(item => item.featured);
   }

package/dist/esm/quickInsertPlugin.js

@@ -38,7 +38,9 @@ export var quickInsertPlugin = function quickInsertPlugin(_ref) {
       return Promise.resolve(getQuickInsertSuggestions({
         query: query,
         disableDefaultItems: options === null || options === void 0 ? void 0 : options.disableDefaultItems,
-        prioritySortingFn: options === null || options === void 0 ? void 0 : options.prioritySortingFn
+        prioritySortingFn: options === null || options === void 0 ? void 0 : options.prioritySortingFn,
+        // EDITOR-6558: pass through consumer-supplied filter (e.g. Markdown Mode allowlist)
+        itemFilter: options === null || options === void 0 ? void 0 : options.itemFilter
       }, quickInsertState === null || quickInsertState === void 0 ? void 0 : quickInsertState.lazyDefaultItems, quickInsertState === null || quickInsertState === void 0 ? void 0 : quickInsertState.providedItems));
     },
     selectItem: function selectItem(state, item, insert) {
@@ -144,6 +146,18 @@ export var quickInsertPlugin = function quickInsertPlugin(_ref) {
             prioritySortingFn: options.prioritySortingFn
           });
         }
+
+        // EDITOR-6558: layer the consumer-supplied filter (e.g. Markdown Mode allowlist)
+        // over any caller-supplied filter so both apply.
+        if (options !== null && options !== void 0 && options.itemFilter) {
+          var consumerFilter = options.itemFilter;
+          var callerFilter = searchOptions.itemFilter;
+          searchOptions = _objectSpread(_objectSpread({}, searchOptions), {}, {
+            itemFilter: callerFilter ? function (item) {
+              return consumerFilter(item) && callerFilter(item);
+            } : consumerFilter
+          });
+        }
         return getQuickInsertSuggestions(searchOptions, lazyDefaultItems, providedItems);
       }
     },

package/dist/esm/ui/search.js

@@ -12,6 +12,7 @@ export var getQuickInsertSuggestions = function getQuickInsertSuggestions(search
     category = searchOptions.category,
     disableDefaultItems = searchOptions.disableDefaultItems,
     featuredItems = searchOptions.featuredItems,
+    itemFilter = searchOptions.itemFilter,
     prioritySortingFn = searchOptions.prioritySortingFn;
   var defaultItems = disableDefaultItems ? [] : lazyDefaultItems();
   var dedupeFn = function dedupeFn(item) {
@@ -19,6 +20,11 @@ export var getQuickInsertSuggestions = function getQuickInsertSuggestions(search
     return "".concat(item.title, "-").concat((_item$description = item.description) !== null && _item$description !== void 0 ? _item$description : '');
   };
   var items = providedItems ? dedupe([].concat(_toConsumableArray(defaultItems), _toConsumableArray(providedItems)), dedupeFn) : defaultItems;
+
+  // EDITOR-6558: apply consumer-supplied filter (e.g. Markdown Mode allowlist).
+  if (itemFilter) {
+    items = items.filter(itemFilter);
+  }
   if (featuredItems) {
     return items.filter(function (item) {
       return item.featured;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-plugin-quick-insert",
-	"version": "10.1.4",
+	"version": "10.2.0",
 	"description": "Quick insert plugin for @atlaskit/editor-core",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -38,13 +38,13 @@
 		"@atlaskit/icon": "^34.3.0",
 		"@atlaskit/modal-dialog": "^14.18.0",
 		"@atlaskit/platform-feature-flags": "^1.1.0",
-		"@atlaskit/tmp-editor-statsig": "^69.0.0",
+		"@atlaskit/tmp-editor-statsig": "^70.2.0",
 		"@atlaskit/tokens": "^13.0.0",
 		"@babel/runtime": "^7.0.0",
 		"@emotion/react": "^11.7.1"
 	},
 	"peerDependencies": {
-		"@atlaskit/editor-common": "^114.10.0",
+		"@atlaskit/editor-common": "^114.11.0",
 		"react": "^18.2.0",
 		"react-dom": "^18.2.0",
 		"react-intl": "^5.25.1 || ^6.0.0 || ^7.0.0"