@atlaskit/help 7.1.24 → 7.1.26

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

@@ -14,7 +14,6 @@ const DEFAULT_ARTICLE_ID = {
   type: ARTICLE_TYPE.HELP_ARTICLE
 };
 export const [useNavigationContext, CtxProvider] = createCtx();
-
 const getNewHistoryItem = (id, type) => {
   let uid = Math.floor(Math.random() * Math.pow(10, 17));
   const newHistoryItem = {
@@ -25,12 +24,11 @@ const 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'
  */
-
-
 const getSimpleHistory = history => history.map(historyItem => {
   const {
     id,
@@ -44,11 +42,10 @@ const getSimpleHistory = history => history.map(historyItem => {
     type
   };
 });
+
 /**
  * Get history data (list of IDs and UID)
  */
-
-
 const getHistoryData = history => history.map(historyItem => {
   const {
     id,
@@ -59,23 +56,20 @@ const getHistoryData = history => history.map(historyItem => {
     uid
   };
 });
+
 /**
  * Get the last article in the history
  */
-
-
 const getCurrentArticle = history => history[history.length - 1];
+
 /**
  * Get an ArticleItem/WhatsNewArticleItem based on the last article in the history
  */
-
-
 const getCurrentArticleItemSlim = history => {
   const {
     article,
     type
   } = getCurrentArticle(history);
-
   if (article) {
     if (type === ARTICLE_TYPE.HELP_ARTICLE) {
       const {
@@ -95,10 +89,8 @@ const getCurrentArticleItemSlim = history => {
     }
   }
 };
-
 const getViewForArticleId = articleId => {
   let view = VIEW.DEFAULT_CONTENT;
-
   if (articleId.type === ARTICLE_TYPE.HELP_ARTICLE) {
     if (articleId.id) {
       view = VIEW.ARTICLE;
@@ -112,10 +104,8 @@ const getViewForArticleId = articleId => {
       view = VIEW.WHATS_NEW;
     }
   }
-
   return view;
 };
-
 const navigationReducer = ({
   articleId: currentArticleId,
   history: currentHistory,
@@ -126,12 +116,10 @@ const navigationReducer = ({
     history: currentHistory,
     view: currentView
   };
-
   if (action.type === 'newArticle' && action.payload) {
     const {
       payload: newArticleId
     } = action;
-
     if (isEqual(newArticleId, DEFAULT_ARTICLE_ID)) {
       newState = {
         articleId: newArticleId,
@@ -159,10 +147,10 @@ const navigationReducer = ({
       payload: HistoryItemUpdate
     } = action;
     const index = currentHistory.findIndex(historyItemTemp => historyItemTemp.uid === HistoryItemUpdate.uid);
-
     if (index !== -1) {
       const newHistory = [...currentHistory];
-      newHistory[index] = { ...HistoryItemUpdate
+      newHistory[index] = {
+        ...HistoryItemUpdate
       };
       newState = {
         articleId: currentArticleId,
@@ -172,11 +160,9 @@ const navigationReducer = ({
     }
   } else if (action.type === 'removeLastHistoryItem') {
     const newHistory = currentHistory.length > 0 ? [...currentHistory] : [];
-
     if (newHistory.length > 0) {
       newHistory.splice(-1);
     }
-
     newState = {
       articleId: currentArticleId,
       history: newHistory,
@@ -208,10 +194,8 @@ const navigationReducer = ({
       view: newView
     };
   }
-
   return newState;
 };
-
 export const NavigationContextProvider = ({
   navigationData = {
     articleId: DEFAULT_ARTICLE_ID,
@@ -265,71 +249,64 @@ export const NavigationContextProvider = ({
     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]);
   const fetchArticleData = useCallback(async historyItem => {
     try {
       let article;
-
       switch (historyItem.type) {
         case ARTICLE_TYPE.HELP_ARTICLE:
           if (!onGetHelpArticle) {
             throw new Error('onGetHelpArticle prop not defined');
           }
-
           article = await onGetHelpArticle({
             id: historyItem.id,
             type: historyItem.type
           });
           break;
-
         case ARTICLE_TYPE.WHATS_NEW:
           if (!onGetWhatsNewArticle) {
             throw new Error('onGetWhatsNewArticle prop not defined');
           }
-
           if (historyItem.id === '') {
             break;
           }
-
           article = await onGetWhatsNewArticle({
             id: historyItem.id,
             type: historyItem.type
           });
           break;
-
         default:
           throw new Error('onGetHelpArticle prop not defined');
           break;
       }
-
-      return { ...historyItem,
+      return {
+        ...historyItem,
         ...(article && {
           article
         }),
         state: REQUEST_STATE.done
       };
     } catch (error) {
-      return { ...historyItem,
+      return {
+        ...historyItem,
         state: REQUEST_STATE.error
       };
     }
   }, [onGetHelpArticle, onGetWhatsNewArticle]);
   const reloadArticle = useCallback(async historyItem => {
-    let historyItemToReload = { ...historyItem
+    let historyItemToReload = {
+      ...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
@@ -351,9 +328,9 @@ export const NavigationContextProvider = ({
         });
         return;
       }
-    } //  if the history is not empty and ...
-
+    }
 
+    //  if the history is not empty and ...
     if (currentHistory.length > 0) {
       // the history has more than one article, navigate back through the history
       if (currentHistory.length > 1) {
@@ -393,10 +370,10 @@ export const NavigationContextProvider = ({
   }, [isSearchResultVisible]);
   useEffect(() => {
     const lastHistoryItem = currentHistory.length > 0 ? getCurrentArticle(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
@@ -419,7 +396,6 @@ export const NavigationContextProvider = ({
     } else {
       if (setNavigationData) {
         const 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)
@@ -452,18 +428,17 @@ export const NavigationContextProvider = ({
         payload: historyItemUpdate
       });
     };
+
     /**
      * If the last history item state is "loading" or "reload", we need to request the article (fetch article from API)
      */
-
-
     const lastHistoryItem = getCurrentArticle(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({
         type: 'updateHistoryItem',
-        payload: { ...lastHistoryItem,
+        payload: {
+          ...lastHistoryItem,
           state: REQUEST_STATE.loading
         }
       });

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

@@ -33,7 +33,6 @@ export const SearchContextProvider = ({
     }
   }, [onSearch]);
   const debouncedDoSearch = debounce(doSearch, 500);
-
   const search = onSearch && (newSearchValue => {
     if (newSearchValue !== searchValue) {
       if (newSearchValue.length >= MIN_CHARACTERS_FOR_SEARCH) {
@@ -44,7 +43,6 @@ export const SearchContextProvider = ({
           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
@@ -52,7 +50,6 @@ export const SearchContextProvider = ({
         setSearchResult(null);
         setSearchResultsVisible(false);
       }
-
       setSearchValue(newSearchValue);
     } else {
       setSearchState(REQUEST_STATE.loading);
@@ -60,15 +57,12 @@ export const SearchContextProvider = ({
       setSearchResultsVisible(true);
     }
   });
-
   const searchResultItemClick = (event, analyticsEvent, articleData) => {
     if (onSearchResultItemClick) {
       onSearchResultItemClick(event, analyticsEvent, articleData);
     }
-
     setSearchResultsVisible(false);
   };
-
   return /*#__PURE__*/React.createElement(CtxProvider, {
     value: {
       onSearch: search,

package/dist/es2019/components/contexts/whatsNewArticleContext.js

@@ -19,11 +19,10 @@ export const WhatsNewArticleProvider = ({
   const [searchWhatsNewArticlesState, setSearchWhatsNewArticlesState] = useState(REQUEST_STATE.done);
   const searchWhatsNew = useCallback(async (filter = '', numberOfItems = NUMBER_OF_WHATS_NEW_ITEMS_PER_PAGE, page = '') => {
     setWhatsNewSearchType(filter);
-
     if (onSearchWhatsNewArticles) {
       try {
-        setSearchWhatsNewArticlesState(REQUEST_STATE.loading); // If the filter type hasn't change, then we are loading an extra page
-
+        setSearchWhatsNewArticlesState(REQUEST_STATE.loading);
+        // If the filter type hasn't change, then we are loading an extra page
         if (filter === whatsNewSearchType && page !== '') {
           const results = await onSearchWhatsNewArticles(filter, numberOfItems, page);
           setSearchWhatsNewArticlesResult({
@@ -37,7 +36,6 @@ export const WhatsNewArticleProvider = ({
           const results = await onSearchWhatsNewArticles(filter, numberOfItems, page);
           setSearchWhatsNewArticlesResult(results);
         }
-
         setSearchWhatsNewArticlesState(REQUEST_STATE.done);
       } catch (error) {
         setSearchWhatsNewArticlesResult(null);

package/dist/es2019/components/styled.js

@@ -1,4 +1,5 @@
 /** @jsx jsx */
+
 import styled from '@emotion/styled';
 import { gridSize } from '@atlaskit/theme/constants';
 export const HelpBodyContainer = styled.div`

package/dist/es2019/model/Article.js

@@ -1,6 +1,5 @@
 // TODO - Check if we need to delete this
 export let ARTICLE_ITEM_TYPES;
-
 (function (ARTICLE_ITEM_TYPES) {
   ARTICLE_ITEM_TYPES["topicInProduct"] = "topicInProduct";
 })(ARTICLE_ITEM_TYPES || (ARTICLE_ITEM_TYPES = {}));

package/dist/es2019/model/Help.js

@@ -1,6 +1,5 @@
 import { ArticleItem } from './Article';
 export let ARTICLE_TYPE;
-
 (function (ARTICLE_TYPE) {
   ARTICLE_TYPE["HELP_ARTICLE"] = "HELP_ARTICLE";
   ARTICLE_TYPE["WHATS_NEW"] = "WHATS_NEW";

package/dist/es2019/model/Requests.js

@@ -1,5 +1,4 @@
 export let REQUEST_STATE;
-
 (function (REQUEST_STATE) {
   REQUEST_STATE["done"] = "done";
   REQUEST_STATE["loading"] = "loading";

package/dist/es2019/model/WhatsNew.js

@@ -1,5 +1,4 @@
 export let WHATS_NEW_ITEM_TYPES;
-
 (function (WHATS_NEW_ITEM_TYPES) {
   WHATS_NEW_ITEM_TYPES["NEW_FEATURE"] = "Announcement";
   WHATS_NEW_ITEM_TYPES["IMPROVEMENT"] = "Improvement";

package/dist/es2019/util/hooks/cancellablePromise.js

@@ -6,20 +6,18 @@ export function makeCancelable(promise) {
   });
   return {
     promise: wrappedPromise,
-
     cancel() {
       isCanceled = true;
     }
-
   };
 }
 export default function useCancellablePromise(cancelable = makeCancelable) {
-  const emptyPromise = Promise.resolve(true); // check if the input argument is a cancelable promise generator
+  const emptyPromise = Promise.resolve(true);
 
+  // check if the input argument is a cancelable promise generator
   if (cancelable(emptyPromise).cancel === undefined) {
     throw new Error('promise wrapper argument must provide a cancel() function');
   }
-
   const promises = useRef([]);
   useEffect(() => {
     promises.current = promises.current;
@@ -28,13 +26,11 @@ export default function useCancellablePromise(cancelable = makeCancelable) {
       promises.current = [];
     };
   }, []);
-
   const cancellablePromise = p => {
     const cPromise = cancelable(p);
     promises.current.push(cPromise);
     return cPromise.promise;
   };
-
   return {
     cancellablePromise
   };

package/dist/es2019/util/hooks/ctx.js

@@ -1,16 +1,12 @@
 import { createContext, useContext } from 'react';
 export function createCtx() {
   const ctx = /*#__PURE__*/createContext(undefined);
-
   function useCtx() {
     const c = useContext(ctx);
-
     if (!c) {
       throw new Error('useCtx must be inside a Provider with a value');
     }
-
     return c;
   }
-
   return [useCtx, ctx.Provider];
 }

package/dist/es2019/util/hooks/previous.js

@@ -1,14 +1,16 @@
-import { useRef, useEffect } from 'react'; // Hook
+import { useRef, useEffect } from 'react';
 
+// Hook
 export function usePrevious(value) {
   // The ref object is a generic container whose current property is mutable ...
   // ... and can hold any value, similar to an instance property on a class
-  const ref = useRef(); // Store current value in ref
+  const ref = useRef();
 
+  // Store current value in ref
   useEffect(() => {
     ref.current = value;
   }, [value]); // Only re-run if value changes
-  // Return previous value (happens before update in useEffect above)
 
+  // Return previous value (happens before update in useEffect above)
   return ref.current;
 }

package/dist/es2019/util/i18n-util.js

@@ -28,6 +28,7 @@ const localesMessagesMap = {
   sv,
   zh
 };
+
 /**
  * Tries to get the most specific messages bundle for a given locale.
  *
@@ -38,18 +39,14 @@ const localesMessagesMap = {
  *
  * @param locale string specifying the locale like 'en_GB', or 'fr'.
  */
-
 export const getMessagesForLocale = locale => {
   let messages = localesMessagesMap[locale];
-
   if (!messages) {
     const parentLocale = locale.split(/[-_]/)[0];
     messages = localesMessagesMap[parentLocale];
   }
-
   if (!messages) {
     messages = en;
   }
-
   return messages;
 };

package/dist/es2019/util/index.js

@@ -9,19 +9,14 @@ export const getTypeIcon = itemType => {
   switch (itemType) {
     case WHATS_NEW_ITEM_TYPES.NEW_FEATURE:
       return WhatsNewIconNew();
-
     case WHATS_NEW_ITEM_TYPES.EXPERIMENT:
       return WhatsNewIconExperiment();
-
     case WHATS_NEW_ITEM_TYPES.FIX:
       return WhatsNewIconFix();
-
     case WHATS_NEW_ITEM_TYPES.IMPROVEMENT:
       return WhatsNewIconImprovement();
-
     case WHATS_NEW_ITEM_TYPES.REMOVED:
       return WhatsNewIconRemoved();
-
     default:
       return '';
   }
@@ -30,16 +25,12 @@ export const getTypeTitle = itemType => {
   switch (itemType) {
     case WHATS_NEW_ITEM_TYPES.NEW_FEATURE:
       return messages.help_whats_new_filter_select_option_new;
-
     case WHATS_NEW_ITEM_TYPES.EXPERIMENT:
       return messages.help_whats_new_filter_select_option_experiment;
-
     case WHATS_NEW_ITEM_TYPES.FIX:
       return messages.help_whats_new_filter_select_option_fix;
-
     case WHATS_NEW_ITEM_TYPES.IMPROVEMENT:
       return messages.help_whats_new_filter_select_option_improvement;
-
     case WHATS_NEW_ITEM_TYPES.REMOVED:
       return messages.help_whats_new_filter_select_option_removed;
   }

package/dist/es2019/util/styled.js

@@ -1,4 +1,5 @@
 /** @jsx jsx */
+
 import styled from '@emotion/styled';
 import { gridSize } from '@atlaskit/theme/constants';
 import * as colors from '@atlaskit/theme/colors';
@@ -12,6 +13,7 @@ export const DividerLine = styled.div`
   margin-top: ${gridSize() * 2}px;
   box-sizing: border-box;
 `;
+
 /**
  * Loading container
  */
@@ -46,6 +48,7 @@ export const LoadingRectangle = styled.div`
   );
   background-repeat: no-repeat;
 `;
+
 /**
  * Loading Circle
  */
@@ -72,6 +75,7 @@ export const LoadingCircle = styled.div`
   );
   background-repeat: no-repeat;
 `;
+
 /**
  * What's new icon
  */
@@ -89,19 +93,14 @@ export const WhatsNewTypeIcon = styled.div`
   switch (type) {
     case WHATS_NEW_ITEM_TYPES.IMPROVEMENT:
       return `var(--ds-icon-warning, ${colors.Y200})`;
-
     case WHATS_NEW_ITEM_TYPES.NEW_FEATURE:
       return `var(--ds-icon-success, ${colors.G300})`;
-
     case WHATS_NEW_ITEM_TYPES.FIX:
       return `var(--ds-icon-information, ${colors.B500})`;
-
     case WHATS_NEW_ITEM_TYPES.EXPERIMENT:
       return `var(--ds-icon-discovery, ${colors.P500})`;
-
     case WHATS_NEW_ITEM_TYPES.REMOVED:
       return `var(--ds-icon-disabled, ${colors.N700})`;
-
     default:
       return `var(--ds-icon, ${colors.N400})`;
   }

package/dist/es2019/util/testing/mock.js

@@ -36,14 +36,13 @@ export const getMockArticleItem = (id, routeName = '', routeGroup = '', productN
 };
 export const getMockArticleItemList = numberOfItems => {
   const articleItemList = [];
-
   for (var i = 0; i < numberOfItems; i++) {
     articleItemList.push(getMockArticleItem(i.toString()));
   }
-
   return articleItemList;
-}; // What's New article data
+};
 
+// What's New article data
 export const getMockWhatsNewArticle = (id, routeName = '', routeGroup = '', productName = '', href = '') => {
   return {
     description: 'mock article description',
@@ -75,10 +74,8 @@ export const getMockWhatsNewArticleItem = (id, type, title = `Mock What's New ar
 };
 export const getMockWhatsNewArticleItemList = numberOfItems => {
   const articleItemList = [];
-
   for (var i = 0; i < numberOfItems; i++) {
     articleItemList.push(getMockWhatsNewArticleItem(i.toString()));
   }
-
   return articleItemList;
 };

package/dist/es2019/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/help",
-	"version": "7.1.24",
+	"version": "7.1.26",
 	"sideEffects": false
 }

package/dist/esm/components/Article/ArticleContent/index.js

@@ -6,13 +6,11 @@ import ArticleLoadingFail from '../ArticleLoadingFail';
 import WhatsNewArticle from '../WhatsNewArticle';
 export var ArticleContent = function ArticleContent(_ref) {
   var currentArticle = _ref.currentArticle,
-      onHelpArticleLoadingFailTryAgainButtonClick = _ref.onHelpArticleLoadingFailTryAgainButtonClick,
-      onWhatsNewArticleLoadingFailTryAgainButtonClick = _ref.onWhatsNewArticleLoadingFailTryAgainButtonClick;
-
+    onHelpArticleLoadingFailTryAgainButtonClick = _ref.onHelpArticleLoadingFailTryAgainButtonClick,
+    onWhatsNewArticleLoadingFailTryAgainButtonClick = _ref.onWhatsNewArticleLoadingFailTryAgainButtonClick;
   if (currentArticle && currentArticle.id) {
     if (currentArticle.type === ARTICLE_TYPE.HELP_ARTICLE) {
       var article = currentArticle.article;
-
       if (article && currentArticle.state === REQUEST_STATE.done) {
         return /*#__PURE__*/React.createElement(HelpArticle, {
           article: article
@@ -27,10 +25,8 @@ export var ArticleContent = function ArticleContent(_ref) {
         });
       }
     }
-
     if (currentArticle.type === ARTICLE_TYPE.WHATS_NEW) {
       var _article = currentArticle.article;
-
       if (_article && currentArticle.state === REQUEST_STATE.done) {
         return /*#__PURE__*/React.createElement(WhatsNewArticle, {
           article: _article
@@ -46,7 +42,6 @@ export var ArticleContent = function ArticleContent(_ref) {
       }
     }
   }
-
   return null;
 };
 export default ArticleContent;

package/dist/esm/components/Article/ArticleLoadingFail/index.js

@@ -13,27 +13,22 @@ var ANALYTICS_CONTEXT_DATA = {
 };
 export var ArticleLoadingFail = function ArticleLoadingFail(_ref) {
   var onTryAgainButtonClick = _ref.onTryAgainButtonClick,
-      formatMessage = _ref.intl.formatMessage;
-
+    formatMessage = _ref.intl.formatMessage;
   var _useAnalyticsEvents = useAnalyticsEvents(),
-      createAnalyticsEvent = _useAnalyticsEvents.createAnalyticsEvent;
-
+    createAnalyticsEvent = _useAnalyticsEvents.createAnalyticsEvent;
   var handleOnTryAgainButtonClick = onTryAgainButtonClick && function (event) {
     var analyticsEvent = createAnalyticsEvent({
       action: 'clicked'
     });
     onTryAgainButtonClick(event, analyticsEvent);
   };
-
   return /*#__PURE__*/React.createElement(LoadingErrorMessage, null, /*#__PURE__*/React.createElement(SomethingWrongImage, null), /*#__PURE__*/React.createElement("h2", null, formatMessage(messages.help_article_error_title)), /*#__PURE__*/React.createElement("p", null, formatMessage(messages.help_article_error_text)), /*#__PURE__*/React.createElement(LoadingErrorButtonContainer, null, handleOnTryAgainButtonClick && /*#__PURE__*/React.createElement(Button, {
     onClick: handleOnTryAgainButtonClick
   }, formatMessage(messages.help_article_error_button_label))));
 };
-
 var ArticleLoadingFailWithContext = function ArticleLoadingFailWithContext(props) {
   return /*#__PURE__*/React.createElement(AnalyticsContext, {
     data: ANALYTICS_CONTEXT_DATA
   }, /*#__PURE__*/React.createElement(ArticleLoadingFail, props));
 };
-
 export default injectIntl(ArticleLoadingFailWithContext);

package/dist/esm/components/Article/ArticleLoadingFail/styled.js

@@ -1,7 +1,5 @@
 import _taggedTemplateLiteral from "@babel/runtime/helpers/taggedTemplateLiteral";
-
 var _templateObject, _templateObject2;
-
 /** @jsx jsx */
 import styled from '@emotion/styled';
 import { gridSize } from '@atlaskit/theme/constants';