Merge pull request #591 from DevBrent/patch-1

Typo showNewMessage not showNewMessages

Author: devrnt

README.md

@@ -129,7 +129,7 @@ Used to retrieve all methods bundled with Intercom. These are based on the offic
 | hide            | () => void                                 | hides the Messenger, will call `onHide` if supplied to `IntercomProvider`                                                           |
 | show            | () => void                                 | shows the Messenger, will call `onShow` if supplied to `IntercomProvider`                                                           |
 | showMessages    | () => void                                 | shows the Messenger with the message list                                                                                           |
-| showNewMessages | (content?: string) => void                 | shows the Messenger as if a new conversation was just created. If `content` is passed, it will fill in the message composer         |
+| showNewMessage  | (content?: string) => void                 | shows the Messenger as if a new conversation was just created. If `content` is passed, it will fill in the message composer         |
 | getVisitorId    | () => string                               | gets the visitor id                                                                                                                 |
 | startTour       | (tourId: number) => void                   | starts a tour based on the `tourId`                                                                                                 |
 | trackEvent      | (event: string, metaData?: object) => void | submits an `event` with optional `metaData`      
@@ -158,7 +158,7 @@ const HomePage = () => {
     hide,
     show,
     showMessages,
-    showNewMessages,
+    showNewMessage,
     getVisitorId,
     startTour,
     trackEvent,
@@ -167,8 +167,8 @@ const HomePage = () => {
 
   const bootWithProps = () => boot({ name: 'Russo' });
   const updateWithProps = () => update({ name: 'Ossur' });
-  const handleNewMessages = () => showNewMessages();
-  const handleNewMessagesWithContent = () => showNewMessages('content');
+  const handleNewMessages = () => showNewMessage();
+  const handleNewMessagesWithContent = () => showNewMessage('content');
   const handleGetVisitorId = () => console.log(getVisitorId());
   const handleStartTour = () => startTour(123);
   const handleTrackEvent = () => trackEvent('invited-friend');

cypress/integration/show.ts

@@ -25,8 +25,8 @@ describe('showMessages', () => {
   });
 });
 
-describe('showNewMessages', () => {
-  it('should show new message `showNewMessages`', () => {
+describe('showNewMessage', () => {
+  it('should show new message `showNewMessage`', () => {
     cy.visit('/useIntercom');
 
     cy.get('[data-cy=boot]').click();
@@ -38,7 +38,7 @@ describe('showNewMessages', () => {
       .should('exist');
   });
 
-  it('should show new message with content when calling `showNewMessages`', () => {
+  it('should show new message with content when calling `showNewMessage`', () => {
     cy.visit('/useIntercom');
 
     cy.get('[data-cy=boot]').click();

playground/modules/useIntercom/useIntercom.tsx

@@ -31,7 +31,7 @@ const RawUseIntercomPage = () => {
     hide,
     show,
     showMessages,
-    showNewMessages,
+    showNewMessage,
     getVisitorId,
     trackEvent,
     showArticle,
@@ -111,13 +111,13 @@ const RawUseIntercomPage = () => {
     update({ name: 'ponas' });
   }, [update]);
 
-  const handleNewMessages = React.useCallback(() => showNewMessages(), [
-    showNewMessages,
+  const handleNewMessages = React.useCallback(() => showNewMessage(), [
+    showNewMessage,
   ]);
 
   const handleNewMessagesWithContent = React.useCallback(
-    () => showNewMessages('pre-definded-content'),
-    [showNewMessages],
+    () => showNewMessage('pre-definded-content'),
+    [showNewMessage],
   );
 
   const handleGetVisitorId = React.useCallback(() => {

src/provider.tsx

@@ -186,7 +186,7 @@ export const IntercomProvider: React.FC<React.PropsWithChildren<
     });
   }, [ensureIntercom]);
 
-  const showNewMessages = React.useCallback(
+  const showNewMessage = React.useCallback(
     (message?: string) => {
       ensureIntercom('showNewMessage', () => {
         if (!message) {
@@ -245,7 +245,7 @@ export const IntercomProvider: React.FC<React.PropsWithChildren<
       show,
       isOpen,
       showMessages,
-      showNewMessages,
+      showNewMessage,
       getVisitorId,
       startTour,
       trackEvent,
@@ -260,7 +260,7 @@ export const IntercomProvider: React.FC<React.PropsWithChildren<
     show,
     isOpen,
     showMessages,
-    showNewMessages,
+    showNewMessage,
     getVisitorId,
     startTour,
     trackEvent,

src/types.ts

@@ -338,7 +338,7 @@ export type IntercomContextValues = {
    * showMessages('pre-populated-content');
    * ```
    */
-  showNewMessages: (prePopulatedContent?: string) => void;
+  showNewMessage: (prePopulatedContent?: string) => void;
   /**
    * A visitor is someone who goes to your site but does not use the messenger.
    * You can track these visitors via the visitor `user_id`.