@atlaskit/help 7.1.24 → 7.1.26

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

@@ -1,72 +1,44 @@
 "use strict";
 
 var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
-
 var _typeof = require("@babel/runtime/helpers/typeof");
-
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.useNavigationContext = exports.NavigationContextProvider = exports.CtxProvider = void 0;
-
 var _regenerator = _interopRequireDefault(require("@babel/runtime/regenerator"));
-
 var _asyncToGenerator2 = _interopRequireDefault(require("@babel/runtime/helpers/asyncToGenerator"));
-
 var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
-
 var _toConsumableArray2 = _interopRequireDefault(require("@babel/runtime/helpers/toConsumableArray"));
-
 var _objectWithoutProperties2 = _interopRequireDefault(require("@babel/runtime/helpers/objectWithoutProperties"));
-
 var _slicedToArray2 = _interopRequireDefault(require("@babel/runtime/helpers/slicedToArray"));
-
 var _react = _interopRequireWildcard(require("react"));
-
 var _isEqual = _interopRequireDefault(require("lodash/isEqual"));
-
 var _Requests = require("../../model/Requests");
-
 var _Help = require("../../model/Help");
-
 var _ctx = require("../../util/hooks/ctx");
-
 var _constants = require("../constants");
-
 var _helpArticleContext = require("./helpArticleContext");
-
 var _whatsNewArticleContext = require("./whatsNewArticleContext");
-
 var _homeContext = require("./homeContext");
-
 var _searchContext = require("./searchContext");
-
 var _headerContext = require("./headerContext");
-
 var _excluded = ["body", "relatedArticles"],
-    _excluded2 = ["description"];
-
+  _excluded2 = ["description"];
 function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function _getRequireWildcardCache(nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
-
 function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || _typeof(obj) !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
-
 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) { (0, _defineProperty2.default)(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; }
-
 var DEFAULT_ARTICLE_ID = {
   id: '',
   type: _Help.ARTICLE_TYPE.HELP_ARTICLE
 };
-
 var _createCtx = (0, _ctx.createCtx)(),
-    _createCtx2 = (0, _slicedToArray2.default)(_createCtx, 2),
-    useNavigationContext = _createCtx2[0],
-    CtxProvider = _createCtx2[1];
-
+  _createCtx2 = (0, _slicedToArray2.default)(_createCtx, 2),
+  useNavigationContext = _createCtx2[0],
+  CtxProvider = _createCtx2[1];
 exports.CtxProvider = CtxProvider;
 exports.useNavigationContext = useNavigationContext;
-
 var getNewHistoryItem = function getNewHistoryItem(id, type) {
   var uid = Math.floor(Math.random() * Math.pow(10, 17));
   var newHistoryItem = {
@@ -77,17 +49,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,
@@ -96,60 +67,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 === _Help.ARTICLE_TYPE.HELP_ARTICLE) {
       var _ref = article,
-          body = _ref.body,
-          relatedArticles = _ref.relatedArticles,
-          articleItemData = (0, _objectWithoutProperties2.default)(_ref, _excluded);
+        body = _ref.body,
+        relatedArticles = _ref.relatedArticles,
+        articleItemData = (0, _objectWithoutProperties2.default)(_ref, _excluded);
       var currentArticleSlimData = articleItemData;
       return currentArticleSlimData;
     } else if (type === _Help.ARTICLE_TYPE.WHATS_NEW) {
       var _ref2 = article,
-          description = _ref2.description,
-          whatsNewArticleItemData = (0, _objectWithoutProperties2.default)(_ref2, _excluded2);
+        description = _ref2.description,
+        whatsNewArticleItemData = (0, _objectWithoutProperties2.default)(_ref2, _excluded2);
       var currentWhatsNewArticleSlimData = whatsNewArticleItemData;
       return currentWhatsNewArticleSlimData;
     }
   }
 };
-
 var getViewForArticleId = function getViewForArticleId(articleId) {
   var view = _constants.VIEW.DEFAULT_CONTENT;
-
   if (articleId.type === _Help.ARTICLE_TYPE.HELP_ARTICLE) {
     if (articleId.id) {
       view = _constants.VIEW.ARTICLE;
@@ -163,23 +128,19 @@ var getViewForArticleId = function getViewForArticleId(articleId) {
       view = _constants.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 ((0, _isEqual.default)(newArticleId, DEFAULT_ARTICLE_ID)) {
       newState = {
         articleId: newArticleId,
@@ -205,7 +166,6 @@ var navigationReducer = function navigationReducer(_ref3, action) {
     var index = currentHistory.findIndex(function (historyItemTemp) {
       return historyItemTemp.uid === HistoryItemUpdate.uid;
     });
-
     if (index !== -1) {
       var newHistory = (0, _toConsumableArray2.default)(currentHistory);
       newHistory[index] = _objectSpread({}, HistoryItemUpdate);
@@ -217,11 +177,9 @@ var navigationReducer = function navigationReducer(_ref3, action) {
     }
   } else if (action.type === 'removeLastHistoryItem') {
     var _newHistory = currentHistory.length > 0 ? (0, _toConsumableArray2.default)(currentHistory) : [];
-
     if (_newHistory.length > 0) {
       _newHistory.splice(-1);
     }
-
     newState = {
       articleId: currentArticleId,
       history: _newHistory,
@@ -249,52 +207,42 @@ var navigationReducer = function navigationReducer(_ref3, action) {
       view: newView
     };
   }
-
   return newState;
 };
-
 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 = (0, _helpArticleContext.useHelpArticleContext)(),
-      onGetHelpArticle = _useHelpArticleContex.onGetHelpArticle;
-
+    onGetHelpArticle = _useHelpArticleContex.onGetHelpArticle;
   var _useWhatsNewArticleCo = (0, _whatsNewArticleContext.useWhatsNewArticleContext)(),
-      onGetWhatsNewArticle = _useWhatsNewArticleCo.onGetWhatsNewArticle;
-
+    onGetWhatsNewArticle = _useWhatsNewArticleCo.onGetWhatsNewArticle;
   var _useHomeContext = (0, _homeContext.useHomeContext)(),
-      homeContent = _useHomeContext.homeContent,
-      homeOptions = _useHomeContext.homeOptions;
-
+    homeContent = _useHomeContext.homeContent,
+    homeOptions = _useHomeContext.homeOptions;
   var _useSearchContext = (0, _searchContext.useSearchContext)(),
-      onSearch = _useSearchContext.onSearch,
-      isSearchResultVisible = _useSearchContext.isSearchResultVisible,
-      searchValue = _useSearchContext.searchValue;
-
+    onSearch = _useSearchContext.onSearch,
+    isSearchResultVisible = _useSearchContext.isSearchResultVisible,
+    searchValue = _useSearchContext.searchValue;
   var _useHeaderContext = (0, _headerContext.useHeaderContext)(),
-      onCloseButtonClick = _useHeaderContext.onCloseButtonClick;
-
+    onCloseButtonClick = _useHeaderContext.onCloseButtonClick;
   var propsArticleId = navigationData.articleId,
-      propsHistory = navigationData.history;
-
+    propsHistory = navigationData.history;
   var _useReducer = (0, _react.useReducer)(navigationReducer, {
-    articleId: propsArticleId,
-    history: !(0, _isEqual.default)(propsArticleId, DEFAULT_ARTICLE_ID) && propsHistory.length === 0 ? [getNewHistoryItem(propsArticleId.id, propsArticleId.type)] : propsHistory,
-    view: _constants.VIEW.DEFAULT_CONTENT
-  }),
-      _useReducer2 = (0, _slicedToArray2.default)(_useReducer, 2),
-      _useReducer2$ = _useReducer2[0],
-      currentArticleId = _useReducer2$.articleId,
-      currentHistory = _useReducer2$.history,
-      currentView = _useReducer2$.view,
-      dispatchNavigationAction = _useReducer2[1];
-
+      articleId: propsArticleId,
+      history: !(0, _isEqual.default)(propsArticleId, DEFAULT_ARTICLE_ID) && propsHistory.length === 0 ? [getNewHistoryItem(propsArticleId.id, propsArticleId.type)] : propsHistory,
+      view: _constants.VIEW.DEFAULT_CONTENT
+    }),
+    _useReducer2 = (0, _slicedToArray2.default)(_useReducer, 2),
+    _useReducer2$ = _useReducer2[0],
+    currentArticleId = _useReducer2$.articleId,
+    currentHistory = _useReducer2$.history,
+    currentView = _useReducer2$.view,
+    dispatchNavigationAction = _useReducer2[1];
   var isOverlayVisible = (0, _react.useMemo)(function () {
     return currentView === _constants.VIEW.ARTICLE || currentView === _constants.VIEW.SEARCH || currentView === _constants.VIEW.WHATS_NEW || currentView === _constants.VIEW.WHATS_NEW_ARTICLE;
   }, [currentView]);
@@ -309,11 +257,10 @@ var NavigationContextProvider = function NavigationContextProvider(_ref4) {
     if (currentHistory.length === 1 && !isDefaultContentDefined || currentView === _constants.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 = (0, _react.useCallback)( /*#__PURE__*/function () {
@@ -327,70 +274,56 @@ var NavigationContextProvider = function NavigationContextProvider(_ref4) {
               _context.t0 = historyItem.type;
               _context.next = _context.t0 === _Help.ARTICLE_TYPE.HELP_ARTICLE ? 4 : _context.t0 === _Help.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: _Requests.REQUEST_STATE.done
               }));
-
             case 23:
               _context.prev = 23;
               _context.t1 = _context["catch"](0);
               return _context.abrupt("return", _objectSpread(_objectSpread({}, historyItem), {}, {
                 state: _Requests.REQUEST_STATE.error
               }));
-
             case 26:
             case "end":
               return _context.stop();
@@ -398,7 +331,6 @@ var NavigationContextProvider = function NavigationContextProvider(_ref4) {
         }
       }, _callee, null, [[0, 23]]);
     }));
-
     return function (_x) {
       return _ref5.apply(this, arguments);
     };
@@ -411,18 +343,15 @@ var NavigationContextProvider = function NavigationContextProvider(_ref4) {
           switch (_context2.prev = _context2.next) {
             case 0:
               historyItemToReload = _objectSpread({}, historyItem);
-
               if (historyItem.type === _Help.ARTICLE_TYPE.HELP_ARTICLE || historyItem.type === _Help.ARTICLE_TYPE.WHATS_NEW) {
                 historyItemToReload.state = _Requests.REQUEST_STATE.loading;
               } else {
                 historyItemToReload.state = _Requests.REQUEST_STATE.error;
               }
-
               dispatchNavigationAction({
                 type: 'updateHistoryItem',
                 payload: historyItemToReload
               });
-
             case 3:
             case "end":
               return _context2.stop();
@@ -430,7 +359,6 @@ var NavigationContextProvider = function NavigationContextProvider(_ref4) {
         }
       }, _callee2);
     }));
-
     return function (_x2) {
       return _ref6.apply(this, arguments);
     };
@@ -444,22 +372,18 @@ 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) {
@@ -476,7 +400,6 @@ var NavigationContextProvider = function NavigationContextProvider(_ref4) {
                 });
               }
             }
-
           case 9:
           case "end":
             return _context3.stop();
@@ -508,10 +431,10 @@ var NavigationContextProvider = function NavigationContextProvider(_ref4) {
   }, [isSearchResultVisible]);
   (0, _react.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 (!(0, _isEqual.default)(propsArticleId, currentArticleId)) {
       /**
        * If propsArticleId and lastHistoryItem are the same, we just need to update the articleId
@@ -534,7 +457,6 @@ 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)
@@ -569,14 +491,12 @@ 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();
@@ -584,18 +504,15 @@ 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) === _Requests.REQUEST_STATE.load || (lastHistoryItem === null || lastHistoryItem === void 0 ? void 0 : lastHistoryItem.state) === _Requests.REQUEST_STATE.reload) {
       requestNewArticle(lastHistoryItem);
       dispatchNavigationAction({
@@ -627,5 +544,4 @@ var NavigationContextProvider = function NavigationContextProvider(_ref4) {
     }
   }, children);
 };
-
 exports.NavigationContextProvider = NavigationContextProvider;

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

@@ -1,33 +1,26 @@
 "use strict";
 
 var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
-
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.useRelatedArticlesContext = exports.RelatedArticlesContextProvider = exports.CtxProvider = void 0;
-
 var _slicedToArray2 = _interopRequireDefault(require("@babel/runtime/helpers/slicedToArray"));
-
 var _react = _interopRequireDefault(require("react"));
-
 var _ctx = require("../../util/hooks/ctx");
-
 var _createCtx = (0, _ctx.createCtx)(),
-    _createCtx2 = (0, _slicedToArray2.default)(_createCtx, 2),
-    useRelatedArticlesContext = _createCtx2[0],
-    CtxProvider = _createCtx2[1];
-
+  _createCtx2 = (0, _slicedToArray2.default)(_createCtx, 2),
+  useRelatedArticlesContext = _createCtx2[0],
+  CtxProvider = _createCtx2[1];
 exports.CtxProvider = CtxProvider;
 exports.useRelatedArticlesContext = useRelatedArticlesContext;
-
 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.default.createElement(CtxProvider, {
     value: {
       routeGroup: routeGroup,
@@ -38,5 +31,4 @@ var RelatedArticlesContextProvider = function RelatedArticlesContextProvider(_re
     }
   }, children);
 };
-
 exports.RelatedArticlesContextProvider = RelatedArticlesContextProvider;