@atlaskit/editor-plugin-type-ahead 3.0.0 → 3.0.2

package/CHANGELOG.md

@@ -1,5 +1,21 @@
 # @atlaskit/editor-plugin-type-ahead
 
+## 3.0.2
+
+### Patch Changes
+
+- Updated dependencies
+
+## 3.0.1
+
+### Patch Changes
+
+- [#181781](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/pull-requests/181781)
+  [`e0060cc2c2eb7`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/e0060cc2c2eb7) -
+  ED-28417 Offline Editing: Update the type ahead error to clear on new requests, and make error
+  more generic.
+- Updated dependencies
+
 ## 3.0.0
 
 ### Major Changes

package/dist/cjs/pm-plugins/actions.js

@@ -12,6 +12,7 @@ var ACTIONS = exports.ACTIONS = /*#__PURE__*/function (ACTIONS) {
   ACTIONS["INSERT_RAW_QUERY"] = "INSERT_RAW_QUERY";
   ACTIONS["UPDATE_LIST_ITEMS"] = "UPDATE_LIST_ITEMS";
   ACTIONS["UPDATE_LIST_ERROR"] = "UPDATE_LIST_ERROR";
+  ACTIONS["CLEAR_LIST_ERROR"] = "CLEAR_LIST_ERROR";
   ACTIONS["UPDATE_SELECTED_INDEX"] = "UPDATE_SELECTED_INDEX";
   return ACTIONS;
 }({});

package/dist/cjs/pm-plugins/commands/clear-list-error.js

@@ -0,0 +1,20 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.clearListError = void 0;
+var _actions = require("../actions");
+var _key = require("../key");
+var clearListError = exports.clearListError = function clearListError() {
+  return function (_ref) {
+    var tr = _ref.tr;
+    tr.setMeta(_key.pluginKey, {
+      action: _actions.ACTIONS.CLEAR_LIST_ERROR,
+      params: {
+        errorInfo: null
+      }
+    });
+    return tr;
+  };
+};

package/dist/cjs/pm-plugins/reducer.js

@@ -114,6 +114,7 @@ var createReducer = exports.createReducer = function createReducer(_ref) {
     var shouldUpdateListItems = action === _actions.ACTIONS.UPDATE_LIST_ITEMS;
     var shouldUpdateListError = action === _actions.ACTIONS.UPDATE_LIST_ERROR;
     var shouldUpdateSelectedIndex = action === _actions.ACTIONS.UPDATE_SELECTED_INDEX;
+    var shouldClearListError = action === _actions.ACTIONS.CLEAR_LIST_ERROR;
     if (shouldOpenMenu) {
       return openMenu(currentPluginState, {
         tr: tr,
@@ -146,6 +147,10 @@ var createReducer = exports.createReducer = function createReducer(_ref) {
       return _objectSpread(_objectSpread({}, currentPluginState), {}, {
         selectedIndex: params.selectedIndex
       });
+    } else if (shouldClearListError) {
+      return _objectSpread(_objectSpread({}, currentPluginState), {}, {
+        errorInfo: null
+      });
     }
     if (tr.docChanged) {
       var decorationSet = currentPluginState.decorationSet;

package/dist/cjs/ui/TypeAheadErrorFallback/index.js

@@ -23,10 +23,10 @@ var minHeightComponentStyles = (0, _react.css)({
 });
 var TypeAheadErrorFallback = exports.TypeAheadErrorFallback = function TypeAheadErrorFallback() {
   var intl = (0, _reactIntlNext.useIntl)();
-  var header = intl.formatMessage(_typeAhead.typeAheadListMessages.offlineErrorFallbackHeading);
-  var description = intl.formatMessage(_typeAhead.typeAheadListMessages.offlineErrorFallbackDesc);
+  var header = intl.formatMessage(_typeAhead.typeAheadListMessages.typeAheadErrorFallbackHeading);
+  var description = intl.formatMessage(_typeAhead.typeAheadListMessages.typeAheadErrorFallbackDesc);
   return (0, _react.jsx)("div", {
-    "data-testid": "mentions-typeahead-error-boundary-ui",
+    "data-testid": "typeahead-error-boundary-ui",
     css: minHeightComponentStyles
   }, (0, _react.jsx)(_EmptyState.EmptyState, {
     header: header,

package/dist/cjs/ui/WrapperTypeAhead.js

@@ -50,7 +50,7 @@ var WrapperTypeAhead = exports.WrapperTypeAhead = /*#__PURE__*/_react.default.me
     setQuery = _useState4[1];
   var queryRef = (0, _react.useRef)(query);
   var editorViewRef = (0, _react.useRef)(editorView);
-  var items = (0, _useLoadItems.useLoadItems)(triggerHandler, editorView, query, showMoreOptionsButton);
+  var items = (0, _useLoadItems.useLoadItems)(triggerHandler, editorView, query, showMoreOptionsButton, api);
   (0, _react.useEffect)(function () {
     if (!closed && (0, _platformFeatureFlags.fg)('platform_editor_ease_of_use_metrics')) {
       var _api$metrics;

package/dist/cjs/ui/hooks/use-load-items.js

@@ -8,10 +8,11 @@ exports.useLoadItems = void 0;
 var _slicedToArray2 = _interopRequireDefault(require("@babel/runtime/helpers/slicedToArray"));
 var _react = require("react");
 var _experiments = require("@atlaskit/tmp-editor-statsig/experiments");
+var _clearListError = require("../../pm-plugins/commands/clear-list-error");
 var _updateListError = require("../../pm-plugins/commands/update-list-error");
 var _updateListItems = require("../../pm-plugins/commands/update-list-items");
 var EMPTY_LIST_ITEM = [];
-var useLoadItems = exports.useLoadItems = function useLoadItems(triggerHandler, editorView, query, showViewMore) {
+var useLoadItems = exports.useLoadItems = function useLoadItems(triggerHandler, editorView, query, showViewMore, api) {
   var _useState = (0, _react.useState)(EMPTY_LIST_ITEM),
     _useState2 = (0, _slicedToArray2.default)(_useState, 2),
     items = _useState2[0],
@@ -29,6 +30,12 @@ var useLoadItems = exports.useLoadItems = function useLoadItems(triggerHandler,
       editorState: editorView.state
     };
     var view = editorViewRef.current;
+    if ((0, _experiments.editorExperiment)('platform_editor_offline_editing_web', true)) {
+      // Clear any existing error state before making a new request
+      queueMicrotask(function () {
+        api === null || api === void 0 || api.core.actions.execute((0, _clearListError.clearListError)());
+      });
+    }
     getItems(options).then(function (result) {
       var list = result.length > 0 ? result : EMPTY_LIST_ITEM;
       if (componentIsMounted.current) {

package/dist/es2019/pm-plugins/actions.js

@@ -6,6 +6,7 @@ export let ACTIONS = /*#__PURE__*/function (ACTIONS) {
   ACTIONS["INSERT_RAW_QUERY"] = "INSERT_RAW_QUERY";
   ACTIONS["UPDATE_LIST_ITEMS"] = "UPDATE_LIST_ITEMS";
   ACTIONS["UPDATE_LIST_ERROR"] = "UPDATE_LIST_ERROR";
+  ACTIONS["CLEAR_LIST_ERROR"] = "CLEAR_LIST_ERROR";
   ACTIONS["UPDATE_SELECTED_INDEX"] = "UPDATE_SELECTED_INDEX";
   return ACTIONS;
 }({});

package/dist/es2019/pm-plugins/commands/clear-list-error.js

@@ -0,0 +1,15 @@
+import { ACTIONS } from '../actions';
+import { pluginKey as typeAheadPluginKey } from '../key';
+export const clearListError = () => {
+  return ({
+    tr
+  }) => {
+    tr.setMeta(typeAheadPluginKey, {
+      action: ACTIONS.CLEAR_LIST_ERROR,
+      params: {
+        errorInfo: null
+      }
+    });
+    return tr;
+  };
+};

package/dist/es2019/pm-plugins/reducer.js

@@ -106,6 +106,7 @@ export const createReducer = ({
     const shouldUpdateListItems = action === ACTIONS.UPDATE_LIST_ITEMS;
     const shouldUpdateListError = action === ACTIONS.UPDATE_LIST_ERROR;
     const shouldUpdateSelectedIndex = action === ACTIONS.UPDATE_SELECTED_INDEX;
+    const shouldClearListError = action === ACTIONS.CLEAR_LIST_ERROR;
     if (shouldOpenMenu) {
       return openMenu(currentPluginState, {
         tr,
@@ -148,6 +149,11 @@ export const createReducer = ({
         ...currentPluginState,
         selectedIndex: params.selectedIndex
       };
+    } else if (shouldClearListError) {
+      return {
+        ...currentPluginState,
+        errorInfo: null
+      };
     }
     if (tr.docChanged) {
       const {

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

@@ -16,10 +16,10 @@ const minHeightComponentStyles = css({
 });
 export const TypeAheadErrorFallback = () => {
   const intl = useIntl();
-  const header = intl.formatMessage(messages.offlineErrorFallbackHeading);
-  const description = intl.formatMessage(messages.offlineErrorFallbackDesc);
+  const header = intl.formatMessage(messages.typeAheadErrorFallbackHeading);
+  const description = intl.formatMessage(messages.typeAheadErrorFallbackDesc);
   return jsx("div", {
-    "data-testid": "mentions-typeahead-error-boundary-ui",
+    "data-testid": "typeahead-error-boundary-ui",
     css: minHeightComponentStyles
   }, jsx(EmptyState, {
     header: header,

package/dist/es2019/ui/WrapperTypeAhead.js

@@ -35,7 +35,7 @@ export const WrapperTypeAhead = /*#__PURE__*/React.memo(({
   const [query, setQuery] = useState(reopenQuery || '');
   const queryRef = useRef(query);
   const editorViewRef = useRef(editorView);
-  const items = useLoadItems(triggerHandler, editorView, query, showMoreOptionsButton);
+  const items = useLoadItems(triggerHandler, editorView, query, showMoreOptionsButton, api);
   useEffect(() => {
     if (!closed && fg('platform_editor_ease_of_use_metrics')) {
       var _api$metrics;

package/dist/es2019/ui/hooks/use-load-items.js

@@ -1,9 +1,10 @@
 import { useEffect, useRef, useState } from 'react';
 import { editorExperiment } from '@atlaskit/tmp-editor-statsig/experiments';
+import { clearListError } from '../../pm-plugins/commands/clear-list-error';
 import { updateListError } from '../../pm-plugins/commands/update-list-error';
 import { updateListItem } from '../../pm-plugins/commands/update-list-items';
 const EMPTY_LIST_ITEM = [];
-export const useLoadItems = (triggerHandler, editorView, query, showViewMore) => {
+export const useLoadItems = (triggerHandler, editorView, query, showViewMore, api) => {
   const [items, setItems] = useState(EMPTY_LIST_ITEM);
   const componentIsMounted = useRef(true);
   const editorViewRef = useRef(editorView);
@@ -20,6 +21,12 @@ export const useLoadItems = (triggerHandler, editorView, query, showViewMore) =>
     const {
       current: view
     } = editorViewRef;
+    if (editorExperiment('platform_editor_offline_editing_web', true)) {
+      // Clear any existing error state before making a new request
+      queueMicrotask(() => {
+        api === null || api === void 0 ? void 0 : api.core.actions.execute(clearListError());
+      });
+    }
     getItems(options).then(result => {
       const list = result.length > 0 ? result : EMPTY_LIST_ITEM;
       if (componentIsMounted.current) {

package/dist/esm/pm-plugins/actions.js

@@ -6,6 +6,7 @@ export var ACTIONS = /*#__PURE__*/function (ACTIONS) {
   ACTIONS["INSERT_RAW_QUERY"] = "INSERT_RAW_QUERY";
   ACTIONS["UPDATE_LIST_ITEMS"] = "UPDATE_LIST_ITEMS";
   ACTIONS["UPDATE_LIST_ERROR"] = "UPDATE_LIST_ERROR";
+  ACTIONS["CLEAR_LIST_ERROR"] = "CLEAR_LIST_ERROR";
   ACTIONS["UPDATE_SELECTED_INDEX"] = "UPDATE_SELECTED_INDEX";
   return ACTIONS;
 }({});

package/dist/esm/pm-plugins/commands/clear-list-error.js

@@ -0,0 +1,14 @@
+import { ACTIONS } from '../actions';
+import { pluginKey as typeAheadPluginKey } from '../key';
+export var clearListError = function clearListError() {
+  return function (_ref) {
+    var tr = _ref.tr;
+    tr.setMeta(typeAheadPluginKey, {
+      action: ACTIONS.CLEAR_LIST_ERROR,
+      params: {
+        errorInfo: null
+      }
+    });
+    return tr;
+  };
+};

package/dist/esm/pm-plugins/reducer.js

@@ -107,6 +107,7 @@ export var createReducer = function createReducer(_ref) {
     var shouldUpdateListItems = action === ACTIONS.UPDATE_LIST_ITEMS;
     var shouldUpdateListError = action === ACTIONS.UPDATE_LIST_ERROR;
     var shouldUpdateSelectedIndex = action === ACTIONS.UPDATE_SELECTED_INDEX;
+    var shouldClearListError = action === ACTIONS.CLEAR_LIST_ERROR;
     if (shouldOpenMenu) {
       return openMenu(currentPluginState, {
         tr: tr,
@@ -139,6 +140,10 @@ export var createReducer = function createReducer(_ref) {
       return _objectSpread(_objectSpread({}, currentPluginState), {}, {
         selectedIndex: params.selectedIndex
       });
+    } else if (shouldClearListError) {
+      return _objectSpread(_objectSpread({}, currentPluginState), {}, {
+        errorInfo: null
+      });
     }
     if (tr.docChanged) {
       var decorationSet = currentPluginState.decorationSet;

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

@@ -16,10 +16,10 @@ var minHeightComponentStyles = css({
 });
 export var TypeAheadErrorFallback = function TypeAheadErrorFallback() {
   var intl = useIntl();
-  var header = intl.formatMessage(messages.offlineErrorFallbackHeading);
-  var description = intl.formatMessage(messages.offlineErrorFallbackDesc);
+  var header = intl.formatMessage(messages.typeAheadErrorFallbackHeading);
+  var description = intl.formatMessage(messages.typeAheadErrorFallbackDesc);
   return jsx("div", {
-    "data-testid": "mentions-typeahead-error-boundary-ui",
+    "data-testid": "typeahead-error-boundary-ui",
     css: minHeightComponentStyles
   }, jsx(EmptyState, {
     header: header,

package/dist/esm/ui/WrapperTypeAhead.js

@@ -41,7 +41,7 @@ export var WrapperTypeAhead = /*#__PURE__*/React.memo(function (_ref) {
     setQuery = _useState4[1];
   var queryRef = useRef(query);
   var editorViewRef = useRef(editorView);
-  var items = useLoadItems(triggerHandler, editorView, query, showMoreOptionsButton);
+  var items = useLoadItems(triggerHandler, editorView, query, showMoreOptionsButton, api);
   useEffect(function () {
     if (!closed && fg('platform_editor_ease_of_use_metrics')) {
       var _api$metrics;

package/dist/esm/ui/hooks/use-load-items.js

@@ -1,10 +1,11 @@
 import _slicedToArray from "@babel/runtime/helpers/slicedToArray";
 import { useEffect, useRef, useState } from 'react';
 import { editorExperiment } from '@atlaskit/tmp-editor-statsig/experiments';
+import { clearListError } from '../../pm-plugins/commands/clear-list-error';
 import { updateListError } from '../../pm-plugins/commands/update-list-error';
 import { updateListItem } from '../../pm-plugins/commands/update-list-items';
 var EMPTY_LIST_ITEM = [];
-export var useLoadItems = function useLoadItems(triggerHandler, editorView, query, showViewMore) {
+export var useLoadItems = function useLoadItems(triggerHandler, editorView, query, showViewMore, api) {
   var _useState = useState(EMPTY_LIST_ITEM),
     _useState2 = _slicedToArray(_useState, 2),
     items = _useState2[0],
@@ -22,6 +23,12 @@ export var useLoadItems = function useLoadItems(triggerHandler, editorView, quer
       editorState: editorView.state
     };
     var view = editorViewRef.current;
+    if (editorExperiment('platform_editor_offline_editing_web', true)) {
+      // Clear any existing error state before making a new request
+      queueMicrotask(function () {
+        api === null || api === void 0 || api.core.actions.execute(clearListError());
+      });
+    }
     getItems(options).then(function (result) {
       var list = result.length > 0 ? result : EMPTY_LIST_ITEM;
       if (componentIsMounted.current) {

package/dist/types/pm-plugins/actions.d.ts

@@ -6,5 +6,6 @@ export declare enum ACTIONS {
     INSERT_RAW_QUERY = "INSERT_RAW_QUERY",
     UPDATE_LIST_ITEMS = "UPDATE_LIST_ITEMS",
     UPDATE_LIST_ERROR = "UPDATE_LIST_ERROR",
+    CLEAR_LIST_ERROR = "CLEAR_LIST_ERROR",
     UPDATE_SELECTED_INDEX = "UPDATE_SELECTED_INDEX"
 }

package/dist/types/pm-plugins/commands/clear-list-error.d.ts

@@ -0,0 +1,2 @@
+import type { EditorCommand } from '@atlaskit/editor-common/types';
+export declare const clearListError: () => EditorCommand;

package/dist/types/ui/hooks/use-load-items.d.ts

@@ -1,3 +1,4 @@
-import type { TypeAheadHandler, TypeAheadItem } from '@atlaskit/editor-common/types';
+import type { ExtractInjectionAPI, TypeAheadHandler, TypeAheadItem } from '@atlaskit/editor-common/types';
 import type { EditorView } from '@atlaskit/editor-prosemirror/view';
-export declare const useLoadItems: (triggerHandler: TypeAheadHandler, editorView: EditorView, query: string, showViewMore?: boolean) => Array<TypeAheadItem>;
+import type { TypeAheadPlugin } from '../../typeAheadPluginType';
+export declare const useLoadItems: (triggerHandler: TypeAheadHandler, editorView: EditorView, query: string, showViewMore?: boolean, api?: ExtractInjectionAPI<TypeAheadPlugin> | undefined) => Array<TypeAheadItem>;

package/dist/types-ts4.5/pm-plugins/actions.d.ts

@@ -6,5 +6,6 @@ export declare enum ACTIONS {
     INSERT_RAW_QUERY = "INSERT_RAW_QUERY",
     UPDATE_LIST_ITEMS = "UPDATE_LIST_ITEMS",
     UPDATE_LIST_ERROR = "UPDATE_LIST_ERROR",
+    CLEAR_LIST_ERROR = "CLEAR_LIST_ERROR",
     UPDATE_SELECTED_INDEX = "UPDATE_SELECTED_INDEX"
 }

package/dist/types-ts4.5/pm-plugins/commands/clear-list-error.d.ts

@@ -0,0 +1,2 @@
+import type { EditorCommand } from '@atlaskit/editor-common/types';
+export declare const clearListError: () => EditorCommand;

package/dist/types-ts4.5/ui/hooks/use-load-items.d.ts

@@ -1,3 +1,4 @@
-import type { TypeAheadHandler, TypeAheadItem } from '@atlaskit/editor-common/types';
+import type { ExtractInjectionAPI, TypeAheadHandler, TypeAheadItem } from '@atlaskit/editor-common/types';
 import type { EditorView } from '@atlaskit/editor-prosemirror/view';
-export declare const useLoadItems: (triggerHandler: TypeAheadHandler, editorView: EditorView, query: string, showViewMore?: boolean) => Array<TypeAheadItem>;
+import type { TypeAheadPlugin } from '../../typeAheadPluginType';
+export declare const useLoadItems: (triggerHandler: TypeAheadHandler, editorView: EditorView, query: string, showViewMore?: boolean, api?: ExtractInjectionAPI<TypeAheadPlugin> | undefined) => Array<TypeAheadItem>;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-plugin-type-ahead",
-	"version": "3.0.0",
+	"version": "3.0.2",
 	"description": "Type-ahead plugin for @atlaskit/editor-core",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -41,13 +41,13 @@
 		"@atlaskit/editor-prosemirror": "7.0.0",
 		"@atlaskit/editor-shared-styles": "^3.4.0",
 		"@atlaskit/heading": "^5.2.0",
-		"@atlaskit/icon": "^27.2.0",
+		"@atlaskit/icon": "^27.3.0",
 		"@atlaskit/menu": "^8.0.0",
 		"@atlaskit/platform-feature-flags": "^1.1.0",
 		"@atlaskit/primitives": "^14.10.0",
 		"@atlaskit/prosemirror-input-rules": "^3.3.0",
 		"@atlaskit/theme": "^18.0.0",
-		"@atlaskit/tmp-editor-statsig": "^8.7.0",
+		"@atlaskit/tmp-editor-statsig": "^9.0.0",
 		"@atlaskit/tokens": "^5.4.0",
 		"@babel/runtime": "^7.0.0",
 		"@emotion/react": "^11.7.1",
@@ -58,7 +58,7 @@
 		"w3c-keyname": "^2.1.8"
 	},
 	"peerDependencies": {
-		"@atlaskit/editor-common": "^107.6.0",
+		"@atlaskit/editor-common": "^107.7.0",
 		"react": "^18.2.0",
 		"react-dom": "^18.2.0",
 		"react-intl-next": "npm:react-intl@^5.18.1"