Merge pull request #648 from stefanoCrmg/feat/showNews-method

feat: add showNews method

Author: devrnt

.changeset/giant-students-kneel.md

@@ -0,0 +1,5 @@
+---
+'react-use-intercom': minor
+---
+
+Add "showNews" method

README.md

@@ -148,6 +148,8 @@ Used to retrieve all methods bundled with Intercom. These are based on the offic
 | showArticle      | (articleId: string) => void | opens the Messenger with the specified article by `articleId`
 | startSurvey      | (surveyId: number) => void | Trigger a survey in the Messenger by `surveyId`
 | showSpace     | (spaceName: IntercomSpace) => void | Opens the Messenger with the specified space
+| showNews | (newsId: number) => void | Opens the Messenger with the specified news by `newsId`
+
 
 #### Example
 ```ts

apps/playground/src/modules/useIntercom/useIntercom.tsx

@@ -39,6 +39,7 @@ const RawUseIntercomPage = () => {
     showArticle,
     startSurvey,
     showSpace,
+    showNews,
   } = useIntercom();
   const handleBoot = React.useCallback(() => boot(), [boot]);
 
@@ -149,6 +150,10 @@ const RawUseIntercomPage = () => {
 
   const handleStartSurvey = () => startSurvey(29938254);
 
+  const handleShowNews = React.useCallback(() => {
+    showNews(33910172);
+  }, [showNews]);
+
   return (
     <Grid>
       <Item>
@@ -289,6 +294,12 @@ const RawUseIntercomPage = () => {
         </p>
         <Button label="Open space" onClick={handleShowSpace} />
       </Item>
+      <Item>
+        <p>
+          opens the Messenger with the given <code>newsId</code>
+        </p>
+        <Button label="Open news" onClick={handleShowNews} />
+      </Item>
     </Grid>
   );
 };

packages/react-use-intercom/src/provider.tsx

@@ -247,6 +247,14 @@ export const IntercomProvider: React.FC<
     [ensureIntercom],
   );
 
+  const showNews = React.useCallback(
+    (newsId: number) =>
+      ensureIntercom('showNews', () => {
+        IntercomAPI('showNews', newsId);
+      }),
+    [ensureIntercom],
+  );
+
   const providerValue = React.useMemo<IntercomContextValues>(() => {
     return {
       boot,
@@ -264,6 +272,7 @@ export const IntercomProvider: React.FC<
       showArticle,
       startSurvey,
       showSpace,
+      showNews,
     };
   }, [
     boot,
@@ -281,6 +290,7 @@ export const IntercomProvider: React.FC<
     showArticle,
     startSurvey,
     showSpace,
+    showNews,
   ]);
 
   return (

packages/react-use-intercom/src/types.ts

@@ -245,7 +245,8 @@ export type IntercomMethod =
   | 'getVisitorId'
   | 'startTour'
   | 'showArticle'
-  | 'showSpace';
+  | 'showSpace'
+  | 'showNews';
 
 export type RawIntercomProps = RawMessengerAttributes & RawDataAttributes;
 
@@ -418,6 +419,19 @@ export type IntercomContextValues = {
    * @example showSpace('tasks')
    */
   showSpace: (spaceName: IntercomSpace) => void;
+  /**
+   *
+   * Opens the messenger with the specified news
+   *
+   * @see {@link https://developers.intercom.com/installing-intercom/docs/intercom-javascript#intercomshownews-newsitemid}
+   *
+   * @remarks if a news with the given id doesn't exist, Messenger Home is opened instead
+   *
+   * @param newsId The id of the news
+   *
+   * @example showNews('tasks')
+   */
+  showNews: (newsId: number) => void;
 };
 
 export type IntercomProviderProps = {