@atlaskit/editor-common 119.13.1 → 119.15.0

package/CHANGELOG.md

@@ -1,5 +1,39 @@
 # @atlaskit/editor-common
 
+## 119.15.0
+
+### Minor Changes
+
+- [`5ce0f8e29f818`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/5ce0f8e29f818) -
+  EDITOR-8535
+
+  Added `UnsupportedBlockNodeView` to `@atlaskit/editor-plugin-unsupported-content`, switching the
+  `unsupportedBlock` and `confluenceUnsupportedBlock` node views to vanilla DOM under the
+  `platform_editor_vanilla_node_views_phase1` experiment. Also added vanilla unsupported block CSS
+  to `@atlaskit/editor-core`'s `EditorContentContainer`.
+
+  `VanillaTooltip` accepts an optional `onShow` callback, called once the tooltip has become visible
+  after its delay has elapsed. It is not called when the pointer leaves beforehand, matching the
+  `onShow` semantics of `@atlaskit/tooltip`.
+
+  `VanillaTooltip.destroy()` now cancels any pending show/hide timeout. Previously a pending timeout
+  could run after destruction, writing styles to detached DOM and invoking callbacks for an owner
+  that no longer exists.
+
+## 119.14.0
+
+### Minor Changes
+
+- [`edcef04b6350e`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/edcef04b6350e) -
+  Add the Quick Insert recommendation resolver API and typed surface context support for the gated
+  `platform_editor_slash_command` Recommended menu. TypeAhead uses immutable surface context for
+  visibility and React context for registered Quick Insert rendering, while Quick Insert keeps one
+  recommendation snapshot per menu open. Fix Quick Insert declaration generation.
+
+### Patch Changes
+
+- Updated dependencies
+
 ## 119.13.1
 
 ### Patch Changes

package/dist/cjs/monitoring/error.js

@@ -28,7 +28,7 @@ var NETWORK_FAILURE_REGEX = /^network failure/i;
 var RESIZE_OBSERVER_LOOP_REGEX = /ResizeObserver loop completed with undelivered notifications/;
 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 = "119.13.0";
+var packageVersion = "119.14.0";
 var sanitiseSentryEvents = function sanitiseSentryEvents(data, _hint) {
   // Remove URL as it has UGC
   // Ignored via go/ees007

package/dist/cjs/quick-insert/is-recommended-item.js

@@ -0,0 +1,19 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.defaultIsRecommendedItem = void 0;
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
+var _keys = require("./keys");
+/** Resolves an item's recommendation rank, or excludes it with `null`. */
+
+var defaultRanks = (0, _defineProperty2.default)((0, _defineProperty2.default)((0, _defineProperty2.default)((0, _defineProperty2.default)((0, _defineProperty2.default)({}, _keys.ASK_ROVO_MENU_ITEM.key, 0), _keys.HYPERLINK_MENU_ITEM.key, 1), _keys.MEDIA_INSERT_MENU_ITEM.key, 2), _keys.EMOJI_MENU_ITEM.key, 3), _keys.MENTION_MENU_ITEM.key, 4);
+
+/** Default Quick Insert recommendations in their intended display order. */
+var defaultIsRecommendedItem = exports.defaultIsRecommendedItem = function defaultIsRecommendedItem(_ref) {
+  var _defaultRanks$itemKey;
+  var itemKey = _ref.itemKey;
+  return (_defaultRanks$itemKey = defaultRanks[itemKey]) !== null && _defaultRanks$itemKey !== void 0 ? _defaultRanks$itemKey : null;
+};

package/dist/cjs/type-ahead/TypeAheadSurfaceContext.js

@@ -0,0 +1,11 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.TYPE_AHEAD_SURFACE_CONTEXT = void 0;
+/**
+ * Immutable context used while resolving a TypeAhead surface.
+ */
+
+var TYPE_AHEAD_SURFACE_CONTEXT = exports.TYPE_AHEAD_SURFACE_CONTEXT = Symbol('type-ahead-surface-context');

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 = "119.13.0";
+var packageVersion = "119.14.0";
 var halfFocusRing = 1;
 var dropOffset = '0, 8';
 var fadeIn = (0, _react2.keyframes)({

package/dist/cjs/vanilla-tooltip/index.js

@@ -58,12 +58,20 @@ var VanillaTooltip = exports.VanillaTooltip = /*#__PURE__*/function () {
      * where ancestor CSS selectors cannot reach it.
      */
     styles = arguments.length > 5 ? arguments[5] : undefined;
+    var
+    /**
+     * Called when the tooltip has become visible, after `timeout` has elapsed.
+     * Not called when the pointer leaves before the tooltip is shown, matching
+     * the `onShow` semantics of "@atlaskit/tooltip".
+     */
+    onShow = arguments.length > 6 ? arguments[6] : undefined;
     (0, _classCallCheck2.default)(this, VanillaTooltip);
     (0, _defineProperty2.default)(this, "listeners", []);
     (0, _defineProperty2.default)(this, "shouldHidePopover", false);
     (0, _defineProperty2.default)(this, "isDisplayed", false);
     this.button = button;
     this.timeout = timeout;
+    this.onShow = onShow;
     var tooltip = document.createElement('span');
     tooltip.role = 'tooltip';
     tooltip.popover = 'hint';
@@ -126,6 +134,9 @@ var VanillaTooltip = exports.VanillaTooltip = /*#__PURE__*/function () {
     key: "destroy",
     value: function destroy() {
       var _this$popperInstance;
+      // Cancels any pending show/hide, which would otherwise run against detached DOM and
+      // invoke `onShow` after the owner has gone away.
+      clearTimeout(this.currentTimeoutId);
       (_this$popperInstance = this.popperInstance) === null || _this$popperInstance === void 0 || _this$popperInstance.destroy();
       this.listeners.forEach(function (listener) {
         listener();
@@ -180,7 +191,7 @@ var VanillaTooltip = exports.VanillaTooltip = /*#__PURE__*/function () {
 
       // Enable the event listeners
       this.currentTimeoutId = setTimeout(function () {
-        var _this3$popperInstance;
+        var _this3$popperInstance, _this3$onShow;
         _this3.tooltip.style.opacity = '1';
         _this3.tooltip.style.visibility = 'visible';
         (_this3$popperInstance = _this3.popperInstance) === null || _this3$popperInstance === void 0 || _this3$popperInstance.setOptions(function (options) {
@@ -192,6 +203,7 @@ var VanillaTooltip = exports.VanillaTooltip = /*#__PURE__*/function () {
           });
         });
         _this3.isDisplayed = true;
+        (_this3$onShow = _this3.onShow) === null || _this3$onShow === void 0 || _this3$onShow.call(_this3);
       }, this.timeout);
     }
   }]);

package/dist/es2019/monitoring/error.js

@@ -14,7 +14,7 @@ const NETWORK_FAILURE_REGEX = /^network failure/i;
 const RESIZE_OBSERVER_LOOP_REGEX = /ResizeObserver loop completed with undelivered notifications/;
 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 = "119.13.0";
+const packageVersion = "119.14.0";
 const sanitiseSentryEvents = (data, _hint) => {
   // Remove URL as it has UGC
   // Ignored via go/ees007

package/dist/es2019/quick-insert/is-recommended-item.js

@@ -0,0 +1,19 @@
+import { ASK_ROVO_MENU_ITEM, EMOJI_MENU_ITEM, HYPERLINK_MENU_ITEM, MEDIA_INSERT_MENU_ITEM, MENTION_MENU_ITEM } from './keys';
+
+/** Resolves an item's recommendation rank, or excludes it with `null`. */
+
+const defaultRanks = {
+  [ASK_ROVO_MENU_ITEM.key]: 0,
+  [HYPERLINK_MENU_ITEM.key]: 1,
+  [MEDIA_INSERT_MENU_ITEM.key]: 2,
+  [EMOJI_MENU_ITEM.key]: 3,
+  [MENTION_MENU_ITEM.key]: 4
+};
+
+/** Default Quick Insert recommendations in their intended display order. */
+export const defaultIsRecommendedItem = ({
+  itemKey
+}) => {
+  var _defaultRanks$itemKey;
+  return (_defaultRanks$itemKey = defaultRanks[itemKey]) !== null && _defaultRanks$itemKey !== void 0 ? _defaultRanks$itemKey : null;
+};

package/dist/es2019/type-ahead/TypeAheadSurfaceContext.js

@@ -0,0 +1,5 @@
+/**
+ * Immutable context used while resolving a TypeAhead surface.
+ */
+
+export const TYPE_AHEAD_SURFACE_CONTEXT = Symbol('type-ahead-surface-context');

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

@@ -14,7 +14,7 @@ import withAnalyticsEvents from '@atlaskit/analytics-next/withAnalyticsEvents';
 import { fg } from '@atlaskit/platform-feature-flags';
 import Layer from '../Layer';
 const packageName = "@atlaskit/editor-common";
-const packageVersion = "119.13.0";
+const packageVersion = "119.14.0";
 const halfFocusRing = 1;
 const dropOffset = '0, 8';
 const fadeIn = keyframes({

package/dist/es2019/vanilla-tooltip/index.js

@@ -43,12 +43,19 @@ export class VanillaTooltip {
    * Useful when the tooltip is rendered in the browser's top layer (via Popover API),
    * where ancestor CSS selectors cannot reach it.
    */
-  styles) {
+  styles,
+  /**
+   * Called when the tooltip has become visible, after `timeout` has elapsed.
+   * Not called when the pointer leaves before the tooltip is shown, matching
+   * the `onShow` semantics of "@atlaskit/tooltip".
+   */
+  onShow) {
     _defineProperty(this, "listeners", []);
     _defineProperty(this, "shouldHidePopover", false);
     _defineProperty(this, "isDisplayed", false);
     this.button = button;
     this.timeout = timeout;
+    this.onShow = onShow;
     const tooltip = document.createElement('span');
     tooltip.role = 'tooltip';
     tooltip.popover = 'hint';
@@ -103,6 +110,9 @@ export class VanillaTooltip {
   }
   destroy() {
     var _this$popperInstance;
+    // Cancels any pending show/hide, which would otherwise run against detached DOM and
+    // invoke `onShow` after the owner has gone away.
+    clearTimeout(this.currentTimeoutId);
     (_this$popperInstance = this.popperInstance) === null || _this$popperInstance === void 0 ? void 0 : _this$popperInstance.destroy();
     this.listeners.forEach(listener => {
       listener();
@@ -149,7 +159,7 @@ export class VanillaTooltip {
 
     // Enable the event listeners
     this.currentTimeoutId = setTimeout(() => {
-      var _this$popperInstance3;
+      var _this$popperInstance3, _this$onShow;
       this.tooltip.style.opacity = '1';
       this.tooltip.style.visibility = 'visible';
       (_this$popperInstance3 = this.popperInstance) === null || _this$popperInstance3 === void 0 ? void 0 : _this$popperInstance3.setOptions(options => ({
@@ -160,6 +170,7 @@ export class VanillaTooltip {
         }]
       }));
       this.isDisplayed = true;
+      (_this$onShow = this.onShow) === null || _this$onShow === void 0 ? void 0 : _this$onShow.call(this);
     }, this.timeout);
   }
 }

package/dist/esm/monitoring/error.js

@@ -20,7 +20,7 @@ var NETWORK_FAILURE_REGEX = /^network failure/i;
 var RESIZE_OBSERVER_LOOP_REGEX = /ResizeObserver loop completed with undelivered notifications/;
 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 = "119.13.0";
+var packageVersion = "119.14.0";
 var sanitiseSentryEvents = function sanitiseSentryEvents(data, _hint) {
   // Remove URL as it has UGC
   // Ignored via go/ees007

package/dist/esm/quick-insert/is-recommended-item.js

@@ -0,0 +1,13 @@
+import _defineProperty from "@babel/runtime/helpers/defineProperty";
+import { ASK_ROVO_MENU_ITEM, EMOJI_MENU_ITEM, HYPERLINK_MENU_ITEM, MEDIA_INSERT_MENU_ITEM, MENTION_MENU_ITEM } from './keys';
+
+/** Resolves an item's recommendation rank, or excludes it with `null`. */
+
+var defaultRanks = _defineProperty(_defineProperty(_defineProperty(_defineProperty(_defineProperty({}, ASK_ROVO_MENU_ITEM.key, 0), HYPERLINK_MENU_ITEM.key, 1), MEDIA_INSERT_MENU_ITEM.key, 2), EMOJI_MENU_ITEM.key, 3), MENTION_MENU_ITEM.key, 4);
+
+/** Default Quick Insert recommendations in their intended display order. */
+export var defaultIsRecommendedItem = function defaultIsRecommendedItem(_ref) {
+  var _defaultRanks$itemKey;
+  var itemKey = _ref.itemKey;
+  return (_defaultRanks$itemKey = defaultRanks[itemKey]) !== null && _defaultRanks$itemKey !== void 0 ? _defaultRanks$itemKey : null;
+};

package/dist/esm/type-ahead/TypeAheadSurfaceContext.js

@@ -0,0 +1,5 @@
+/**
+ * Immutable context used while resolving a TypeAhead surface.
+ */
+
+export var TYPE_AHEAD_SURFACE_CONTEXT = Symbol('type-ahead-surface-context');

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

@@ -21,7 +21,7 @@ import withAnalyticsEvents from '@atlaskit/analytics-next/withAnalyticsEvents';
 import { fg } from '@atlaskit/platform-feature-flags';
 import Layer from '../Layer';
 var packageName = "@atlaskit/editor-common";
-var packageVersion = "119.13.0";
+var packageVersion = "119.14.0";
 var halfFocusRing = 1;
 var dropOffset = '0, 8';
 var fadeIn = keyframes({

package/dist/esm/vanilla-tooltip/index.js

@@ -51,12 +51,20 @@ export var VanillaTooltip = /*#__PURE__*/function () {
      * where ancestor CSS selectors cannot reach it.
      */
     styles = arguments.length > 5 ? arguments[5] : undefined;
+    var
+    /**
+     * Called when the tooltip has become visible, after `timeout` has elapsed.
+     * Not called when the pointer leaves before the tooltip is shown, matching
+     * the `onShow` semantics of "@atlaskit/tooltip".
+     */
+    onShow = arguments.length > 6 ? arguments[6] : undefined;
     _classCallCheck(this, VanillaTooltip);
     _defineProperty(this, "listeners", []);
     _defineProperty(this, "shouldHidePopover", false);
     _defineProperty(this, "isDisplayed", false);
     this.button = button;
     this.timeout = timeout;
+    this.onShow = onShow;
     var tooltip = document.createElement('span');
     tooltip.role = 'tooltip';
     tooltip.popover = 'hint';
@@ -119,6 +127,9 @@ export var VanillaTooltip = /*#__PURE__*/function () {
     key: "destroy",
     value: function destroy() {
       var _this$popperInstance;
+      // Cancels any pending show/hide, which would otherwise run against detached DOM and
+      // invoke `onShow` after the owner has gone away.
+      clearTimeout(this.currentTimeoutId);
       (_this$popperInstance = this.popperInstance) === null || _this$popperInstance === void 0 || _this$popperInstance.destroy();
       this.listeners.forEach(function (listener) {
         listener();
@@ -173,7 +184,7 @@ export var VanillaTooltip = /*#__PURE__*/function () {
 
       // Enable the event listeners
       this.currentTimeoutId = setTimeout(function () {
-        var _this3$popperInstance;
+        var _this3$popperInstance, _this3$onShow;
         _this3.tooltip.style.opacity = '1';
         _this3.tooltip.style.visibility = 'visible';
         (_this3$popperInstance = _this3.popperInstance) === null || _this3$popperInstance === void 0 || _this3$popperInstance.setOptions(function (options) {
@@ -185,6 +196,7 @@ export var VanillaTooltip = /*#__PURE__*/function () {
           });
         });
         _this3.isDisplayed = true;
+        (_this3$onShow = _this3.onShow) === null || _this3$onShow === void 0 || _this3$onShow.call(_this3);
       }, this.timeout);
     }
   }]);

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

@@ -1,6 +1,7 @@
 import type { Context } from 'react';
 import type { Transaction } from '@atlaskit/editor-prosemirror/state';
 import type { EditorView } from '@atlaskit/editor-prosemirror/view';
+import type { SurfaceContext } from '@atlaskit/editor-ui-control-model/types';
 import type { INPUT_METHOD } from '../analytics';
 import type { TypeAheadInsert } from '../types';
 export type QuickInsertSelectionHandler = (context: {
@@ -14,6 +15,8 @@ export type QuickInsertContextValue = {
         id: string;
         isSelected: boolean;
     };
+    menuOpenId?: symbol;
     select: (selectionHandler: QuickInsertSelectionHandler) => void;
+    surfaceContext?: SurfaceContext;
 };
 export declare const QuickInsertContext: Context<QuickInsertContextValue | null>;

package/dist/types/quick-insert/is-recommended-item.d.ts

@@ -0,0 +1,8 @@
+export type IsRecommendedItemOptions = {
+    itemKey: string;
+};
+/** Resolves an item's recommendation rank, or excludes it with `null`. */
+export type IsRecommendedItemResult = number | null;
+export type IsRecommendedItem = (options: IsRecommendedItemOptions) => IsRecommendedItemResult;
+/** Default Quick Insert recommendations in their intended display order. */
+export declare const defaultIsRecommendedItem: IsRecommendedItem;

package/dist/types/type-ahead/TypeAheadSurfaceContext.d.ts

@@ -0,0 +1,8 @@
+import type { ContextToken } from '@atlaskit/editor-ui-control-model/types';
+/**
+ * Immutable context used while resolving a TypeAhead surface.
+ */
+export type TypeAheadSurfaceContext = {
+    readonly menuOpenId: symbol;
+};
+export declare const TYPE_AHEAD_SURFACE_CONTEXT: ContextToken<TypeAheadSurfaceContext>;

package/dist/types/type-ahead/index.d.ts

@@ -10,3 +10,4 @@ export declare enum SelectItemMode {
     SELECTED = "selected"
 }
 export { typeAheadListMessages } from './messages';
+export type { TypeAheadSurfaceContext } from './TypeAheadSurfaceContext';

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

@@ -1,6 +1,7 @@
 import type Fuse from 'fuse.js';
 import type { IntlShape } from 'react-intl';
 import type { QuickInsertItem, QuickInsertProvider } from '../provider-factory';
+import type { IsRecommendedItem } from '../quick-insert/is-recommended-item';
 import type { EmptyStateHandler } from './empty-state-handler';
 export type QuickInsertOptions = boolean | {
     disableDefaultItems?: boolean;
@@ -61,6 +62,7 @@ export interface QuickInsertPluginOptions {
      * `/` menu. Used by Markdown Mode to allowlist only items whose
      * underlying node/mark has a clean GFM round-trip.
      */
+    isRecommendedItem?: IsRecommendedItem;
     itemFilter?: (item: QuickInsertItem) => boolean;
     onInsert?: (item: QuickInsertItem) => void;
     prioritySortingFn?: (items: QuickInsertItem[]) => Fuse.FuseSortFunction | undefined;

package/dist/types/vanilla-tooltip/index.d.ts

@@ -7,6 +7,12 @@
 export declare class VanillaTooltip {
     private button;
     private timeout;
+    /**
+     * Called when the tooltip has become visible, after `timeout` has elapsed.
+     * Not called when the pointer leaves before the tooltip is shown, matching
+     * the `onShow` semantics of "@atlaskit/tooltip".
+     */
+    private onShow?;
     private popperInstance;
     private listeners;
     private currentTimeoutId;
@@ -27,7 +33,13 @@ export declare class VanillaTooltip {
      * Useful when the tooltip is rendered in the browser's top layer (via Popover API),
      * where ancestor CSS selectors cannot reach it.
      */
-    styles?: Record<string, string>);
+    styles?: Record<string, string>, 
+    /**
+     * Called when the tooltip has become visible, after `timeout` has elapsed.
+     * Not called when the pointer leaves before the tooltip is shown, matching
+     * the `onShow` semantics of "@atlaskit/tooltip".
+     */
+    onShow?: (() => void) | undefined);
     private createPopperInstance;
     destroy(): void;
     private hide;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-common",
-	"version": "119.13.1",
+	"version": "119.15.0",
 	"description": "A package that contains common classes and components for editor and renderer",
 	"publishConfig": {
 		"registry": "https://registry.npmjs.org/"
@@ -49,7 +49,7 @@
 		"@atlaskit/editor-tables": "^3.0.0",
 		"@atlaskit/editor-toolbar": "^2.6.0",
 		"@atlaskit/editor-toolbar-model": "^1.2.0",
-		"@atlaskit/editor-ui-control-model": "^2.7.0",
+		"@atlaskit/editor-ui-control-model": "^2.8.0",
 		"@atlaskit/emoji": "^72.1.0",
 		"@atlaskit/feature-gate-js-client": "^6.0.0",
 		"@atlaskit/icon": "^37.5.0",
@@ -62,7 +62,7 @@
 		"@atlaskit/media-common": "^14.5.0",
 		"@atlaskit/media-file-preview": "^1.2.0",
 		"@atlaskit/media-picker": "^72.3.0",
-		"@atlaskit/media-ui": "^30.12.0",
+		"@atlaskit/media-ui": "^30.13.0",
 		"@atlaskit/media-viewer": "^54.6.0",
 		"@atlaskit/mention": "^27.18.0",
 		"@atlaskit/menu": "^10.1.0",

package/quick-insert/is-recommended-item/package.json

@@ -0,0 +1,10 @@
+{
+  "name": "@atlaskit/editor-common/quick-insert/is-recommended-item",
+  "main": "../../dist/cjs/quick-insert/is-recommended-item.js",
+  "module": "../../dist/esm/quick-insert/is-recommended-item.js",
+  "module:es2019": "../../dist/es2019/quick-insert/is-recommended-item.js",
+  "sideEffects": [
+    "**/*.compiled.css"
+  ],
+  "types": "../../dist/types/quick-insert/is-recommended-item.d.ts"
+}

package/type-ahead-surface-context/package.json

@@ -0,0 +1,10 @@
+{
+  "name": "@atlaskit/editor-common/type-ahead-surface-context",
+  "main": "../dist/cjs/type-ahead/TypeAheadSurfaceContext.js",
+  "module": "../dist/esm/type-ahead/TypeAheadSurfaceContext.js",
+  "module:es2019": "../dist/es2019/type-ahead/TypeAheadSurfaceContext.js",
+  "sideEffects": [
+    "**/*.compiled.css"
+  ],
+  "types": "../dist/types/type-ahead/TypeAheadSurfaceContext.d.ts"
+}