@atlaskit/link-picker 1.5.1 → 1.7.0

package/dist/es2019/ui/error-boundary-fallback/index.js

@@ -2,7 +2,7 @@
 import { jsx } from '@emotion/react';
 import EmptyState from '@atlaskit/empty-state';
 import { defineMessages, useIntl } from 'react-intl-next';
-import GenericErrorSVG from './generic-error-svg';
+import GenericErrorSVG from '../../common/generic-error-svg';
 import { rootContainerStyles } from '../link-picker/styled';
 const messages = defineMessages({
   heading: {

package/dist/es2019/ui/link-picker/index.js

@@ -1,7 +1,7 @@
 import _extends from "@babel/runtime/helpers/extends";
 
 /** @jsx jsx */
-import { useCallback, useReducer } from 'react';
+import { Fragment, useCallback, useLayoutEffect, useReducer } from 'react';
 import { jsx } from '@emotion/react';
 import { useIntl, FormattedMessage } from 'react-intl-next';
 import Button, { ButtonGroup } from '@atlaskit/button';
@@ -9,17 +9,20 @@ import { FormFooter } from '@atlaskit/form';
 import EditorSearchIcon from '@atlaskit/icon/glyph/editor/search';
 import Tabs, { Tab, TabList } from '@atlaskit/tabs';
 import VisuallyHidden from '@atlaskit/visually-hidden';
+import { usePlugins } from '../../services/use-plugins';
+import { useSearchQuery } from '../../services/use-search-query';
 import { messages } from './messages';
 import PanelTextInput from './text-input';
 import LinkSearchList from './link-search-list';
 import { normalizeUrl, isSafeUrl } from './url';
 import { rootContainerStyles, searchIconStyles, listTitleStyles, tabsWrapperStyles } from './styled';
 import { browser } from './browser';
-import { transformTimeStamp } from './transformTimeStamp';
 import Announcer from './announcer';
 import LinkSearchNoResults from './link-search-no-results';
-import { usePlugins } from '../../services/use-plugins';
+import { transformTimeStamp } from './transformTimeStamp';
+import LinkSearchError from './link-search-error';
 export const RECENT_SEARCH_LIST_SIZE = 5;
+export const CONTACT_SUPPORT_LINK = 'https://support.atlassian.com/contact/';
 export const testIds = {
   linkPicker: 'link-picker',
   urlInputField: 'link-url',
@@ -35,7 +38,8 @@ export const testIds = {
   searchResultLoadingIndicator: 'link-picker.results-loading-indicator',
   urlError: 'link-error',
   tabList: 'link-picker-tabs',
-  tabItem: 'link-picker-tab'
+  tabItem: 'link-picker-tab',
+  searchError: 'link-search-error'
 };
 const initState = {
   url: '',
@@ -63,10 +67,13 @@ function reducer(state, payload) {
 function LinkPicker({
   onSubmit,
   onCancel,
+  onContentResize,
   plugins,
   url: initUrl,
   displayText: initDisplayText
 }) {
+  var _queryState$query, _items$length, _errorFallback;
+
   const [state, dispatch] = useReducer(reducer, { ...initState,
     url: normalizeUrl(initUrl) || '',
     displayText: initDisplayText || ''
@@ -76,17 +83,28 @@ function LinkPicker({
     selectedIndex,
     url,
     displayText,
-    invalidUrl
+    invalidUrl,
+    activeTab
   } = state;
-  const isEditing = !!initUrl;
   const intl = useIntl();
+  const queryState = useSearchQuery(state);
   const {
     items,
     isLoading,
-    isSelectedItem,
     isActivePlugin,
-    tabs
-  } = usePlugins(state, plugins);
+    tabs,
+    error,
+    retry,
+    errorFallback
+  } = usePlugins(queryState, activeTab, plugins);
+  const isEditing = !!initUrl;
+  const selectedItem = items === null || items === void 0 ? void 0 : items[selectedIndex];
+  const isSelectedItem = (selectedItem === null || selectedItem === void 0 ? void 0 : selectedItem.url) === url;
+  useLayoutEffect(() => {
+    if (onContentResize) {
+      onContentResize();
+    }
+  }, [onContentResize, items, isLoading, isActivePlugin, tabs]);
   const handleChangeUrl = useCallback(url => {
     dispatch({
       url
@@ -139,13 +157,13 @@ function LinkPicker({
     });
   }, []);
   const handleMouseEnterResultItem = useCallback(objectId => {
-    const index = findIndex(items, item => item.objectId === objectId);
+    const index = items === null || items === void 0 ? void 0 : items.findIndex(item => item.objectId === objectId);
     dispatch({
-      activeIndex: index
+      activeIndex: index !== null && index !== void 0 ? index : -1
     });
   }, [items]);
   const handleMouseLeaveResultItem = useCallback(objectId => {
-    const index = findIndex(items, item => item.objectId === objectId); // This is to avoid updating index that was set by other mouseenter event
+    const index = items === null || items === void 0 ? void 0 : items.findIndex(item => item.objectId === objectId); // This is to avoid updating index that was set by other mouseenter event
 
     if (activeIndex === index) {
       dispatch({
@@ -167,7 +185,7 @@ function LinkPicker({
     });
   }, [displayText, onSubmit, state.url]);
   const handleSelected = useCallback(objectId => {
-    const selectedItem = items.find(item => item.objectId === objectId);
+    const selectedItem = items === null || items === void 0 ? void 0 : items.find(item => item.objectId === objectId);
 
     if (selectedItem) {
       const {
@@ -178,9 +196,7 @@ function LinkPicker({
     }
   }, [handleInsert, items]);
   const handleSubmit = useCallback(() => {
-    const selectedItem = items[selectedIndex];
-
-    if (isSelectedItem) {
+    if (isSelectedItem && selectedItem) {
       return handleInsert(selectedItem.url, selectedItem.name, 'typeAhead');
     }
 
@@ -193,18 +209,18 @@ function LinkPicker({
     return dispatch({
       invalidUrl: true
     });
-  }, [handleInsert, isSelectedItem, items, selectedIndex, url]);
+  }, [handleInsert, isSelectedItem, selectedItem, url]);
   const linkPlaceHolder = isActivePlugin ? messages.placeholder : messages.linkPlaceholder;
-  const linkListTitle = url ? messages.titleResults : messages.titleRecentlyViewed;
+  const linkListTitle = (queryState === null || queryState === void 0 ? void 0 : (_queryState$query = queryState.query) === null || _queryState$query === void 0 ? void 0 : _queryState$query.length) !== 0 ? messages.titleResults : messages.titleRecentlyViewed;
   const insertButtonMsg = isEditing ? messages.saveButton : messages.insertButton;
-  const noResults = isActivePlugin && !isLoading && !items.length && !isSafeUrl(url);
+  const noResults = (items === null || items === void 0 ? void 0 : items.length) === 0 && !error;
   const screenReaderDescriptionId = 'search-recent-links-field-description';
   const linkSearchListId = 'link-picker-search-list';
   const ariaActiveDescendant = selectedIndex > -1 ? `link-search-list-item-${selectedIndex}` : ''; // Added workaround with a screen reader Announcer specifically for VoiceOver + Safari
   // as the Aria design pattern for combobox does not work in this case
   // for details: https://a11y-internal.atlassian.net/browse/AK-740
 
-  const screenReaderText = browser.safari && getScreenReaderText(items, selectedIndex, intl);
+  const screenReaderText = browser.safari && getScreenReaderText(items !== null && items !== void 0 ? items : [], selectedIndex, intl);
   const searchIcon = isActivePlugin && jsx("span", {
     css: searchIconStyles,
     "data-testid": testIds.searchIcon
@@ -256,7 +272,7 @@ function LinkPicker({
     onSubmit: handleSubmit,
     onKeyDown: handleKeyDown,
     onChange: handleChangeText
-  }), tabs.length > 0 && jsx("div", {
+  }), queryState && jsx(Fragment, null, tabs.length > 0 && jsx("div", {
     css: tabsWrapperStyles
   }, jsx(Tabs, {
     id: testIds.tabList,
@@ -270,7 +286,7 @@ function LinkPicker({
   }, jsx(TabList, null, tabs.map(tab => jsx(Tab, {
     key: tab.tabTitle,
     testId: testIds.tabItem
-  }, tab.tabTitle))))), !!items.length && jsx("div", {
+  }, tab.tabTitle))))), !!(items !== null && items !== void 0 && items.length) && jsx("div", {
     css: listTitleStyles,
     id: testIds.resultListTitle,
     "data-testid": testIds.resultListTitle
@@ -278,7 +294,7 @@ function LinkPicker({
     id: "fabric.smartcard.linkpicker.suggested.results"
   }, url && jsx(FormattedMessage, _extends({}, messages.searchLinkResults, {
     values: {
-      count: items.length
+      count: (_items$length = items === null || items === void 0 ? void 0 : items.length) !== null && _items$length !== void 0 ? _items$length : 0
     },
     "aria-live": "polite",
     "aria-atomic": "true"
@@ -287,18 +303,32 @@ function LinkPicker({
     ariaControls: "fabric.smartcard.linkpicker.suggested.results",
     id: linkSearchListId,
     role: "listbox",
-    items: items,
+    items: items !== null && items !== void 0 ? items : [],
     isLoading: isLoading,
     selectedIndex: selectedIndex,
     activeIndex: activeIndex,
     onSelect: handleSelected,
     onMouseEnter: handleMouseEnterResultItem,
     onMouseLeave: handleMouseLeaveResultItem
-  }), noResults && jsx(LinkSearchNoResults, {
+  }), error && ((_errorFallback = errorFallback === null || errorFallback === void 0 ? void 0 : errorFallback(error, retry)) !== null && _errorFallback !== void 0 ? _errorFallback : jsx(LinkSearchError, {
+    testId: testIds.searchError,
+    header: intl.formatMessage(messages.searchErrorHeader),
+    description: jsx(FormattedMessage, _extends({}, messages.searchErrorDescription, {
+      values: {
+        a: label => jsx(Button, {
+          appearance: "link",
+          spacing: "none",
+          href: CONTACT_SUPPORT_LINK,
+          target: "_blank",
+          rel: "noopener noreferrer"
+        }, label)
+      }
+    }))
+  })), noResults && jsx(LinkSearchNoResults, {
     testId: testIds.emptyResultPage,
     header: intl.formatMessage(messages.noResults),
     description: intl.formatMessage(messages.noResultsDescription)
-  }), jsx(FormFooter, {
+  })), jsx(FormFooter, {
     align: "end"
   }, jsx(ButtonGroup, null, jsx(Button, {
     appearance: "default",
@@ -326,17 +356,4 @@ function getScreenReaderText(items, selectedIndex, intl) {
     const formattedDate = [date === null || date === void 0 ? void 0 : date.pageAction, date === null || date === void 0 ? void 0 : date.dateString, date === null || date === void 0 ? void 0 : date.timeSince].filter(Boolean).join(' ');
     return [name, container, formattedDate].filter(Boolean).join(', ');
   }
-}
-
-function findIndex(array, predicate) {
-  let index = -1;
-  array.some((item, i) => {
-    if (predicate(item)) {
-      index = i;
-      return true;
-    }
-
-    return false;
-  });
-  return index;
 }

package/dist/es2019/ui/link-picker/link-search-error/index.js

@@ -0,0 +1,10 @@
+import _extends from "@babel/runtime/helpers/extends";
+import React from 'react';
+import EmptyState from '@atlaskit/empty-state';
+import GenericErrorSVG from '../../../common/generic-error-svg';
+
+const LinkSearchError = props => /*#__PURE__*/React.createElement(EmptyState, _extends({}, props, {
+  renderImage: () => /*#__PURE__*/React.createElement(GenericErrorSVG, null)
+}));
+
+export default LinkSearchError;

package/dist/es2019/ui/link-picker/messages.js

@@ -104,5 +104,15 @@ export const messages = defineMessages({
     id: 'fabric.linkPicker.button.save',
     defaultMessage: 'Save',
     description: 'Button to save edited link'
+  },
+  searchErrorHeader: {
+    id: 'fabric.linkPicker.search.error.heading',
+    defaultMessage: 'We’re having trouble loading data.',
+    description: 'Heading message shown when a search throws an error'
+  },
+  searchErrorDescription: {
+    id: 'fabric.linkPicker.search.error.description',
+    defaultMessage: 'Refresh the page, or contact <a>Atlassian Support</a> if this keeps happening.',
+    description: 'Describes possible actions when search throws an error'
   }
 });

package/dist/es2019/ui/link-picker/url.js

@@ -64,11 +64,6 @@ const linkifyMatch = text => {
 
 export const isSafeUrl = url => {
   const urlTrimmed = url.trim();
-
-  if (urlTrimmed.length === 0) {
-    return true;
-  }
-
   return whitelistedURLPatterns.some(p => p.test(urlTrimmed));
 };
 /**

package/dist/es2019/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/link-picker",
-	"version": "1.5.1",
+	"version": "1.7.0",
 	"sideEffects": false
 }

package/dist/esm/services/use-plugins/index.js

@@ -7,64 +7,53 @@ function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (O
 
 function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { _defineProperty(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
 
-import { useEffect, useRef, useReducer, useMemo } from 'react';
+import { useEffect, useReducer, useMemo, useRef, useState, useCallback } from 'react';
 import { RECENT_SEARCH_LIST_SIZE } from '../../ui/link-picker';
-import { isSafeUrl } from '../../ui/link-picker/url';
 
 function reducer(state, payload) {
   return _objectSpread(_objectSpread({}, state), payload);
 }
 
-export function usePlugins(state, plugins) {
+export function usePlugins(state, activeTab, plugins) {
+  var _useState = useState(0),
+      _useState2 = _slicedToArray(_useState, 2),
+      retries = _useState2[0],
+      setRetries = _useState2[1];
+
   var _useReducer = useReducer(reducer, {
-    items: [],
+    items: null,
+    error: null,
     isLoading: false
   }),
       _useReducer2 = _slicedToArray(_useReducer, 2),
       pluginState = _useReducer2[0],
       dispatch = _useReducer2[1];
 
-  var url = state.url,
-      selectedIndex = state.selectedIndex;
   var items = pluginState.items,
-      isLoading = pluginState.isLoading;
-  var activePlugin = !plugins || plugins.length === 0 ? null : plugins[state.activeTab];
+      isLoading = pluginState.isLoading,
+      error = pluginState.error;
   var queryVersion = useRef(0);
-  var pluginRef = useRef(activePlugin);
-  var selectedItem = items[selectedIndex];
-  var isSelectedItem = (selectedItem === null || selectedItem === void 0 ? void 0 : selectedItem.url) === url;
+  var activePlugin = plugins === null || plugins === void 0 ? void 0 : plugins[activeTab];
   useEffect(function () {
     if (!activePlugin) {
       return;
     }
 
-    if (isSelectedItem) {
-      return;
-    }
-
-    if (isSafeUrl(url) && url.length) {
+    if (!state) {
       dispatch({
-        items: [],
-        isLoading: false
+        items: null,
+        isLoading: false,
+        error: null
       });
       return;
     }
 
-    var updates = activePlugin.resolve({
-      query: url
+    var updates = activePlugin.resolve(state);
+    dispatch({
+      items: null,
+      isLoading: true,
+      error: null
     });
-
-    if (pluginRef.current !== activePlugin) {
-      dispatch({
-        items: [],
-        isLoading: true
-      });
-    } else {
-      dispatch({
-        isLoading: true
-      });
-    }
-
     var newQuery = ++queryVersion.current;
 
     var updateResults = /*#__PURE__*/function () {
@@ -142,6 +131,8 @@ export function usePlugins(state, plugins) {
                 _context.prev = 25;
                 _context.t0 = _context["catch"](0);
                 dispatch({
+                  error: _context.t0,
+                  items: null,
                   isLoading: false
                 });
 
@@ -159,7 +150,7 @@ export function usePlugins(state, plugins) {
     }();
 
     updateResults();
-  }, [activePlugin, queryVersion, url, isSelectedItem]);
+  }, [activePlugin, queryVersion, state, retries]);
   var tabs = useMemo(function () {
     if (!plugins || plugins.length <= 1) {
       return [];
@@ -173,12 +164,19 @@ export function usePlugins(state, plugins) {
       };
     });
   }, [plugins]);
+  var handleRetry = useCallback(function () {
+    setRetries(function (prev) {
+      return ++prev;
+    });
+  }, []);
   return {
     tabs: tabs,
     items: items,
     isLoading: isLoading,
-    isSelectedItem: isSelectedItem,
-    isActivePlugin: !!activePlugin
+    isActivePlugin: !!activePlugin,
+    error: error,
+    retry: handleRetry,
+    errorFallback: activePlugin === null || activePlugin === void 0 ? void 0 : activePlugin.errorFallback
   };
 }
 

package/dist/esm/services/use-search-query/index.js

@@ -0,0 +1,32 @@
+import { useRef } from 'react';
+import { isSafeUrl } from '../../ui/link-picker/url';
+export function useSearchQuery(state) {
+  var _queryState$current;
+
+  var queryState = useRef(null);
+  /*
+   * When state contains a valid url AND is NOT selected from results
+   * queryState should be null to clear the items in plugin state
+   */
+
+  if (isSafeUrl(state.url) && state.selectedIndex === -1) {
+    queryState.current = null;
+  }
+  /*
+   * When state contains a search term e.g. Not a valid url return a query
+   */
+
+
+  if (((_queryState$current = queryState.current) === null || _queryState$current === void 0 ? void 0 : _queryState$current.query) !== state.url && !isSafeUrl(state.url)) {
+    queryState.current = {
+      query: state.url
+    };
+  }
+  /*
+   * When state contains a valid url and is selected from the list
+   * return current state to prevent triger a new plugin search
+   */
+
+
+  return queryState.current;
+}

package/dist/esm/ui/error-boundary-fallback/index.js

@@ -2,7 +2,7 @@
 import { jsx } from '@emotion/react';
 import EmptyState from '@atlaskit/empty-state';
 import { defineMessages, useIntl } from 'react-intl-next';
-import GenericErrorSVG from './generic-error-svg';
+import GenericErrorSVG from '../../common/generic-error-svg';
 import { rootContainerStyles } from '../link-picker/styled';
 var messages = defineMessages({
   heading: {