@atlaskit/editor-common 119.13.1 → 119.14.0

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # @atlaskit/editor-common
 
+## 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.13.1";
 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.13.1";
 var halfFocusRing = 1;
 var dropOffset = '0, 8';
 var fadeIn = (0, _react2.keyframes)({

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.13.1";
 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.13.1";
 const halfFocusRing = 1;
 const dropOffset = '0, 8';
 const fadeIn = keyframes({

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.13.1";
 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.13.1";
 var halfFocusRing = 1;
 var dropOffset = '0, 8';
 var fadeIn = keyframes({

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/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-common",
-	"version": "119.13.1",
+	"version": "119.14.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",

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"
+}