@atlaskit/help 7.1.24 → 7.1.26

package/dist/esm/components/contexts/navigationContext.js

@@ -4,13 +4,10 @@ import _toConsumableArray from "@babel/runtime/helpers/toConsumableArray";
 import _objectWithoutProperties from "@babel/runtime/helpers/objectWithoutProperties";
 import _slicedToArray from "@babel/runtime/helpers/slicedToArray";
 var _excluded = ["body", "relatedArticles"],
-    _excluded2 = ["description"];
+  _excluded2 = ["description"];
 import _regeneratorRuntime from "@babel/runtime/regenerator";
-
 function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
-
 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 React, { useReducer, useEffect, useCallback, useMemo } from 'react';
 import isEqual from 'lodash/isEqual';
 import { REQUEST_STATE } from '../../model/Requests';
@@ -26,14 +23,11 @@ var DEFAULT_ARTICLE_ID = {
   id: '',
   type: ARTICLE_TYPE.HELP_ARTICLE
 };
-
 var _createCtx = createCtx(),
-    _createCtx2 = _slicedToArray(_createCtx, 2),
-    useNavigationContext = _createCtx2[0],
-    CtxProvider = _createCtx2[1];
-
+  _createCtx2 = _slicedToArray(_createCtx, 2),
+  useNavigationContext = _createCtx2[0],
+  CtxProvider = _createCtx2[1];
 export { useNavigationContext, CtxProvider };
-
 var getNewHistoryItem = function getNewHistoryItem(id, type) {
   var uid = Math.floor(Math.random() * Math.pow(10, 17));
   var newHistoryItem = {
@@ -44,17 +38,16 @@ var getNewHistoryItem = function getNewHistoryItem(id, type) {
   };
   return newHistoryItem;
 };
+
 /**
  * Get a simplified version of the history. The items in this array should
  * have only the ID, UID and state === 'reload'
  */
-
-
 var getSimpleHistory = function getSimpleHistory(history) {
   return history.map(function (historyItem) {
     var id = historyItem.id,
-        uid = historyItem.uid,
-        type = historyItem.type;
+      uid = historyItem.uid,
+      type = historyItem.type;
     return {
       id: id,
       uid: uid,
@@ -63,62 +56,54 @@ var getSimpleHistory = function getSimpleHistory(history) {
     };
   });
 };
+
 /**
  * Get history data (list of IDs and UID)
  */
-
-
 var getHistoryData = function getHistoryData(history) {
   return history.map(function (historyItem) {
     var id = historyItem.id,
-        uid = historyItem.uid;
+      uid = historyItem.uid;
     return {
       id: id,
       uid: uid
     };
   });
 };
+
 /**
  * Get the last article in the history
  */
-
-
 var _getCurrentArticle2 = function getCurrentArticle(history) {
   return history[history.length - 1];
 };
+
 /**
  * Get an ArticleItem/WhatsNewArticleItem based on the last article in the history
  */
-
-
 var getCurrentArticleItemSlim = function getCurrentArticleItemSlim(history) {
   var _getCurrentArticle = _getCurrentArticle2(history),
-      article = _getCurrentArticle.article,
-      type = _getCurrentArticle.type;
-
+    article = _getCurrentArticle.article,
+    type = _getCurrentArticle.type;
   if (article) {
     if (type === ARTICLE_TYPE.HELP_ARTICLE) {
       var _ref = article,
-          body = _ref.body,
-          relatedArticles = _ref.relatedArticles,
-          articleItemData = _objectWithoutProperties(_ref, _excluded);
-
+        body = _ref.body,
+        relatedArticles = _ref.relatedArticles,
+        articleItemData = _objectWithoutProperties(_ref, _excluded);
       var currentArticleSlimData = articleItemData;
       return currentArticleSlimData;
     } else if (type === ARTICLE_TYPE.WHATS_NEW) {
       var _ref2 = article,
-          description = _ref2.description,
-          whatsNewArticleItemData = _objectWithoutProperties(_ref2, _excluded2);
-
+        description = _ref2.description,
+        whatsNewArticleItemData = _objectWithoutProperties(_ref2, _excluded2);
       var currentWhatsNewArticleSlimData = whatsNewArticleItemData;
       return currentWhatsNewArticleSlimData;
     }
   }
 };
-
 var getViewForArticleId = function getViewForArticleId(articleId) {
   var view = VIEW.DEFAULT_CONTENT;
-
   if (articleId.type === ARTICLE_TYPE.HELP_ARTICLE) {
     if (articleId.id) {
       view = VIEW.ARTICLE;
@@ -132,23 +117,19 @@ var getViewForArticleId = function getViewForArticleId(articleId) {
       view = VIEW.WHATS_NEW;
     }
   }
-
   return view;
 };
-
 var navigationReducer = function navigationReducer(_ref3, action) {
   var currentArticleId = _ref3.articleId,
-      currentHistory = _ref3.history,
-      currentView = _ref3.view;
+    currentHistory = _ref3.history,
+    currentView = _ref3.view;
   var newState = {
     articleId: currentArticleId,
     history: currentHistory,
     view: currentView
   };
-
   if (action.type === 'newArticle' && action.payload) {
     var newArticleId = action.payload;
-
     if (isEqual(newArticleId, DEFAULT_ARTICLE_ID)) {
       newState = {
         articleId: newArticleId,
@@ -174,10 +155,8 @@ var navigationReducer = function navigationReducer(_ref3, action) {
     var index = currentHistory.findIndex(function (historyItemTemp) {
       return historyItemTemp.uid === HistoryItemUpdate.uid;
     });
-
     if (index !== -1) {
       var newHistory = _toConsumableArray(currentHistory);
-
       newHistory[index] = _objectSpread({}, HistoryItemUpdate);
       newState = {
         articleId: currentArticleId,
@@ -187,11 +166,9 @@ var navigationReducer = function navigationReducer(_ref3, action) {
     }
   } else if (action.type === 'removeLastHistoryItem') {
     var _newHistory = currentHistory.length > 0 ? _toConsumableArray(currentHistory) : [];
-
     if (_newHistory.length > 0) {
       _newHistory.splice(-1);
     }
-
     newState = {
       articleId: currentArticleId,
       history: _newHistory,
@@ -219,52 +196,42 @@ var navigationReducer = function navigationReducer(_ref3, action) {
       view: newView
     };
   }
-
   return newState;
 };
-
 export var NavigationContextProvider = function NavigationContextProvider(_ref4) {
   var _ref4$navigationData = _ref4.navigationData,
-      navigationData = _ref4$navigationData === void 0 ? {
-    articleId: DEFAULT_ARTICLE_ID,
-    history: []
-  } : _ref4$navigationData,
-      setNavigationData = _ref4.setNavigationData,
-      children = _ref4.children;
-
+    navigationData = _ref4$navigationData === void 0 ? {
+      articleId: DEFAULT_ARTICLE_ID,
+      history: []
+    } : _ref4$navigationData,
+    setNavigationData = _ref4.setNavigationData,
+    children = _ref4.children;
   var _useHelpArticleContex = useHelpArticleContext(),
-      onGetHelpArticle = _useHelpArticleContex.onGetHelpArticle;
-
+    onGetHelpArticle = _useHelpArticleContex.onGetHelpArticle;
   var _useWhatsNewArticleCo = useWhatsNewArticleContext(),
-      onGetWhatsNewArticle = _useWhatsNewArticleCo.onGetWhatsNewArticle;
-
+    onGetWhatsNewArticle = _useWhatsNewArticleCo.onGetWhatsNewArticle;
   var _useHomeContext = useHomeContext(),
-      homeContent = _useHomeContext.homeContent,
-      homeOptions = _useHomeContext.homeOptions;
-
+    homeContent = _useHomeContext.homeContent,
+    homeOptions = _useHomeContext.homeOptions;
   var _useSearchContext = useSearchContext(),
-      onSearch = _useSearchContext.onSearch,
-      isSearchResultVisible = _useSearchContext.isSearchResultVisible,
-      searchValue = _useSearchContext.searchValue;
-
+    onSearch = _useSearchContext.onSearch,
+    isSearchResultVisible = _useSearchContext.isSearchResultVisible,
+    searchValue = _useSearchContext.searchValue;
   var _useHeaderContext = useHeaderContext(),
-      onCloseButtonClick = _useHeaderContext.onCloseButtonClick;
-
+    onCloseButtonClick = _useHeaderContext.onCloseButtonClick;
   var propsArticleId = navigationData.articleId,
-      propsHistory = navigationData.history;
-
+    propsHistory = navigationData.history;
   var _useReducer = useReducer(navigationReducer, {
-    articleId: propsArticleId,
-    history: !isEqual(propsArticleId, DEFAULT_ARTICLE_ID) && propsHistory.length === 0 ? [getNewHistoryItem(propsArticleId.id, propsArticleId.type)] : propsHistory,
-    view: VIEW.DEFAULT_CONTENT
-  }),
-      _useReducer2 = _slicedToArray(_useReducer, 2),
-      _useReducer2$ = _useReducer2[0],
-      currentArticleId = _useReducer2$.articleId,
-      currentHistory = _useReducer2$.history,
-      currentView = _useReducer2$.view,
-      dispatchNavigationAction = _useReducer2[1];
-
+      articleId: propsArticleId,
+      history: !isEqual(propsArticleId, DEFAULT_ARTICLE_ID) && propsHistory.length === 0 ? [getNewHistoryItem(propsArticleId.id, propsArticleId.type)] : propsHistory,
+      view: VIEW.DEFAULT_CONTENT
+    }),
+    _useReducer2 = _slicedToArray(_useReducer, 2),
+    _useReducer2$ = _useReducer2[0],
+    currentArticleId = _useReducer2$.articleId,
+    currentHistory = _useReducer2$.history,
+    currentView = _useReducer2$.view,
+    dispatchNavigationAction = _useReducer2[1];
   var isOverlayVisible = useMemo(function () {
     return currentView === VIEW.ARTICLE || currentView === VIEW.SEARCH || currentView === VIEW.WHATS_NEW || currentView === VIEW.WHATS_NEW_ARTICLE;
   }, [currentView]);
@@ -279,11 +246,10 @@ export var NavigationContextProvider = function NavigationContextProvider(_ref4)
     if (currentHistory.length === 1 && !isDefaultContentDefined || currentView === VIEW.WHATS_NEW && !isDefaultContentDefined) {
       return false;
     }
+
     /**
      * if an overlay is visible return true to display the back buton
      */
-
-
     return isOverlayVisible;
   }, [currentHistory.length, isDefaultContentDefined, isOverlayVisible, currentView]);
   var fetchArticleData = useCallback( /*#__PURE__*/function () {
@@ -297,70 +263,56 @@ export var NavigationContextProvider = function NavigationContextProvider(_ref4)
               _context.t0 = historyItem.type;
               _context.next = _context.t0 === ARTICLE_TYPE.HELP_ARTICLE ? 4 : _context.t0 === ARTICLE_TYPE.WHATS_NEW ? 10 : 18;
               break;
-
             case 4:
               if (onGetHelpArticle) {
                 _context.next = 6;
                 break;
               }
-
               throw new Error('onGetHelpArticle prop not defined');
-
             case 6:
               _context.next = 8;
               return onGetHelpArticle({
                 id: historyItem.id,
                 type: historyItem.type
               });
-
             case 8:
               article = _context.sent;
               return _context.abrupt("break", 20);
-
             case 10:
               if (onGetWhatsNewArticle) {
                 _context.next = 12;
                 break;
               }
-
               throw new Error('onGetWhatsNewArticle prop not defined');
-
             case 12:
               if (!(historyItem.id === '')) {
                 _context.next = 14;
                 break;
               }
-
               return _context.abrupt("break", 20);
-
             case 14:
               _context.next = 16;
               return onGetWhatsNewArticle({
                 id: historyItem.id,
                 type: historyItem.type
               });
-
             case 16:
               article = _context.sent;
               return _context.abrupt("break", 20);
-
             case 18:
               throw new Error('onGetHelpArticle prop not defined');
-
             case 20:
               return _context.abrupt("return", _objectSpread(_objectSpread(_objectSpread({}, historyItem), article && {
                 article: article
               }), {}, {
                 state: REQUEST_STATE.done
               }));
-
             case 23:
               _context.prev = 23;
               _context.t1 = _context["catch"](0);
               return _context.abrupt("return", _objectSpread(_objectSpread({}, historyItem), {}, {
                 state: REQUEST_STATE.error
               }));
-
             case 26:
             case "end":
               return _context.stop();
@@ -368,7 +320,6 @@ export var NavigationContextProvider = function NavigationContextProvider(_ref4)
         }
       }, _callee, null, [[0, 23]]);
     }));
-
     return function (_x) {
       return _ref5.apply(this, arguments);
     };
@@ -381,18 +332,15 @@ export var NavigationContextProvider = function NavigationContextProvider(_ref4)
           switch (_context2.prev = _context2.next) {
             case 0:
               historyItemToReload = _objectSpread({}, historyItem);
-
               if (historyItem.type === ARTICLE_TYPE.HELP_ARTICLE || historyItem.type === ARTICLE_TYPE.WHATS_NEW) {
                 historyItemToReload.state = REQUEST_STATE.loading;
               } else {
                 historyItemToReload.state = REQUEST_STATE.error;
               }
-
               dispatchNavigationAction({
                 type: 'updateHistoryItem',
                 payload: historyItemToReload
               });
-
             case 3:
             case "end":
               return _context2.stop();
@@ -400,7 +348,6 @@ export var NavigationContextProvider = function NavigationContextProvider(_ref4)
         }
       }, _callee2);
     }));
-
     return function (_x2) {
       return _ref6.apply(this, arguments);
     };
@@ -414,22 +361,18 @@ export var NavigationContextProvider = function NavigationContextProvider(_ref4)
               _context3.next = 8;
               break;
             }
-
             if (!(searchValue !== '')) {
               _context3.next = 6;
               break;
             }
-
             onSearch('');
             return _context3.abrupt("return");
-
           case 6:
             dispatchNavigationAction({
               type: 'updateView',
               payload: currentArticleId.type
             });
             return _context3.abrupt("return");
-
           case 8:
             //  if the history is not empty and ...
             if (currentHistory.length > 0) {
@@ -446,7 +389,6 @@ export var NavigationContextProvider = function NavigationContextProvider(_ref4)
                 });
               }
             }
-
           case 9:
           case "end":
             return _context3.stop();
@@ -478,10 +420,10 @@ export var NavigationContextProvider = function NavigationContextProvider(_ref4)
   }, [isSearchResultVisible]);
   useEffect(function () {
     var lastHistoryItem = currentHistory.length > 0 ? _getCurrentArticle2(currentHistory) : getNewHistoryItem(DEFAULT_ARTICLE_ID.id, DEFAULT_ARTICLE_ID.type);
+
     /**
      * If the propsArticleId.id (host articleId) is different from currentArticleId.id (internal articleId)
      * */
-
     if (!isEqual(propsArticleId, currentArticleId)) {
       /**
        * If propsArticleId and lastHistoryItem are the same, we just need to update the articleId
@@ -504,7 +446,6 @@ export var NavigationContextProvider = function NavigationContextProvider(_ref4)
     } else {
       if (setNavigationData) {
         var simpleHistory = getSimpleHistory(currentHistory);
-
         if (currentArticleId.id !== lastHistoryItem.id || currentArticleId.type !== lastHistoryItem.type) {
           /**
            * If the propsArticleId.id (host articleId) is equal to currentArticleId.id (internal articleId)
@@ -539,14 +480,12 @@ export var NavigationContextProvider = function NavigationContextProvider(_ref4)
               case 0:
                 _context4.next = 2;
                 return fetchArticleData(historyItem);
-
               case 2:
                 historyItemUpdate = _context4.sent;
                 dispatchNavigationAction({
                   type: 'updateHistoryItem',
                   payload: historyItemUpdate
                 });
-
               case 4:
               case "end":
                 return _context4.stop();
@@ -554,18 +493,15 @@ export var NavigationContextProvider = function NavigationContextProvider(_ref4)
           }
         }, _callee4);
       }));
-
       return function requestNewArticle(_x3) {
         return _ref8.apply(this, arguments);
       };
     }();
+
     /**
      * If the last history item state is "loading" or "reload", we need to request the article (fetch article from API)
      */
-
-
     var lastHistoryItem = _getCurrentArticle2(currentHistory);
-
     if ((lastHistoryItem === null || lastHistoryItem === void 0 ? void 0 : lastHistoryItem.state) === REQUEST_STATE.load || (lastHistoryItem === null || lastHistoryItem === void 0 ? void 0 : lastHistoryItem.state) === REQUEST_STATE.reload) {
       requestNewArticle(lastHistoryItem);
       dispatchNavigationAction({

package/dist/esm/components/contexts/relatedArticlesContext.js

@@ -1,20 +1,18 @@
 import _slicedToArray from "@babel/runtime/helpers/slicedToArray";
 import React from 'react';
 import { createCtx } from '../../util/hooks/ctx';
-
 var _createCtx = createCtx(),
-    _createCtx2 = _slicedToArray(_createCtx, 2),
-    useRelatedArticlesContext = _createCtx2[0],
-    CtxProvider = _createCtx2[1];
-
+  _createCtx2 = _slicedToArray(_createCtx, 2),
+  useRelatedArticlesContext = _createCtx2[0],
+  CtxProvider = _createCtx2[1];
 export { useRelatedArticlesContext, CtxProvider };
 export var RelatedArticlesContextProvider = function RelatedArticlesContextProvider(_ref) {
   var routeGroup = _ref.routeGroup,
-      routeName = _ref.routeName,
-      onGetRelatedArticles = _ref.onGetRelatedArticles,
-      onRelatedArticlesShowMoreClick = _ref.onRelatedArticlesShowMoreClick,
-      onRelatedArticlesListItemClick = _ref.onRelatedArticlesListItemClick,
-      children = _ref.children;
+    routeName = _ref.routeName,
+    onGetRelatedArticles = _ref.onGetRelatedArticles,
+    onRelatedArticlesShowMoreClick = _ref.onRelatedArticlesShowMoreClick,
+    onRelatedArticlesListItemClick = _ref.onRelatedArticlesListItemClick,
+    children = _ref.children;
   return /*#__PURE__*/React.createElement(CtxProvider, {
     value: {
       routeGroup: routeGroup,

package/dist/esm/components/contexts/searchContext.js

@@ -6,82 +6,68 @@ import debounce from 'lodash/debounce';
 import { REQUEST_STATE } from '../../model/Requests';
 import { createCtx } from '../../util/hooks/ctx';
 import { MIN_CHARACTERS_FOR_SEARCH } from '../constants';
-
 var _createCtx = createCtx(),
-    _createCtx2 = _slicedToArray(_createCtx, 2),
-    useSearchContext = _createCtx2[0],
-    CtxProvider = _createCtx2[1];
-
+  _createCtx2 = _slicedToArray(_createCtx, 2),
+  useSearchContext = _createCtx2[0],
+  CtxProvider = _createCtx2[1];
 export { useSearchContext, CtxProvider };
 export var SearchContextProvider = function SearchContextProvider(_ref) {
   var onSearch = _ref.onSearch,
-      onSearchInputChanged = _ref.onSearchInputChanged,
-      onSearchInputCleared = _ref.onSearchInputCleared,
-      onSearchResultItemClick = _ref.onSearchResultItemClick,
-      onSearchExternalUrlClick = _ref.onSearchExternalUrlClick,
-      searchExternalUrl = _ref.searchExternalUrl,
-      children = _ref.children;
-
+    onSearchInputChanged = _ref.onSearchInputChanged,
+    onSearchInputCleared = _ref.onSearchInputCleared,
+    onSearchResultItemClick = _ref.onSearchResultItemClick,
+    onSearchExternalUrlClick = _ref.onSearchExternalUrlClick,
+    searchExternalUrl = _ref.searchExternalUrl,
+    children = _ref.children;
   // Search
   var _useState = useState(''),
-      _useState2 = _slicedToArray(_useState, 2),
-      searchValue = _useState2[0],
-      setSearchValue = _useState2[1];
-
+    _useState2 = _slicedToArray(_useState, 2),
+    searchValue = _useState2[0],
+    setSearchValue = _useState2[1];
   var _useState3 = useState(null),
-      _useState4 = _slicedToArray(_useState3, 2),
-      searchResult = _useState4[0],
-      setSearchResult = _useState4[1];
-
+    _useState4 = _slicedToArray(_useState3, 2),
+    searchResult = _useState4[0],
+    setSearchResult = _useState4[1];
   var _useState5 = useState(REQUEST_STATE.done),
-      _useState6 = _slicedToArray(_useState5, 2),
-      searchState = _useState6[0],
-      setSearchState = _useState6[1];
-
+    _useState6 = _slicedToArray(_useState5, 2),
+    searchState = _useState6[0],
+    setSearchState = _useState6[1];
   var _useState7 = useState(false),
-      _useState8 = _slicedToArray(_useState7, 2),
-      searchResultsVisible = _useState8[0],
-      setSearchResultsVisible = _useState8[1];
-
+    _useState8 = _slicedToArray(_useState7, 2),
+    searchResultsVisible = _useState8[0],
+    setSearchResultsVisible = _useState8[1];
   var doSearch = useCallback( /*#__PURE__*/_asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee() {
     var value,
-        results,
-        _args = arguments;
+      results,
+      _args = arguments;
     return _regeneratorRuntime.wrap(function _callee$(_context) {
       while (1) {
         switch (_context.prev = _context.next) {
           case 0:
             value = _args.length > 0 && _args[0] !== undefined ? _args[0] : '';
-
             if (!onSearch) {
               _context.next = 16;
               break;
             }
-
             _context.prev = 2;
             _context.next = 5;
             return onSearch(value);
-
           case 5:
             results = _context.sent;
             setSearchResult(results);
             setSearchState(REQUEST_STATE.done);
             _context.next = 14;
             break;
-
           case 10:
             _context.prev = 10;
             _context.t0 = _context["catch"](2);
             setSearchResult([]);
             setSearchState(REQUEST_STATE.error);
-
           case 14:
             _context.next = 17;
             break;
-
           case 16:
             setSearchState(REQUEST_STATE.error);
-
           case 17:
           case "end":
             return _context.stop();
@@ -90,7 +76,6 @@ export var SearchContextProvider = function SearchContextProvider(_ref) {
     }, _callee, null, [[2, 10]]);
   })), [onSearch]);
   var debouncedDoSearch = debounce(doSearch, 500);
-
   var search = onSearch && function (newSearchValue) {
     if (newSearchValue !== searchValue) {
       if (newSearchValue.length >= MIN_CHARACTERS_FOR_SEARCH) {
@@ -101,7 +86,6 @@ export var SearchContextProvider = function SearchContextProvider(_ref) {
           setSearchState(REQUEST_STATE.error);
           setSearchResult([]);
         }
-
         setSearchResultsVisible(true);
       } else if (newSearchValue.length === 0) {
         // If the search input is empty, the search results should be empty and
@@ -109,7 +93,6 @@ export var SearchContextProvider = function SearchContextProvider(_ref) {
         setSearchResult(null);
         setSearchResultsVisible(false);
       }
-
       setSearchValue(newSearchValue);
     } else {
       setSearchState(REQUEST_STATE.loading);
@@ -117,15 +100,12 @@ export var SearchContextProvider = function SearchContextProvider(_ref) {
       setSearchResultsVisible(true);
     }
   };
-
   var searchResultItemClick = function searchResultItemClick(event, analyticsEvent, articleData) {
     if (onSearchResultItemClick) {
       onSearchResultItemClick(event, analyticsEvent, articleData);
     }
-
     setSearchResultsVisible(false);
   };
-
   return /*#__PURE__*/React.createElement(CtxProvider, {
     value: {
       onSearch: search,