feat: add useSessionAuth method

Author: multivoltage

.changeset/huge-ducks-do.md

@@ -0,0 +1,5 @@
+---
+"react-use-zendesk": minor
+---
+
+add useSessionAuth method

README.md

@@ -43,8 +43,8 @@ const Home = () => {
   const { open, unreadMessages } = useZendesk();
 
   return <div>
-	  you have ${unreadMessages} messages!
-	 <button onClick={open}>Open chat now</button>
+    you have ${unreadMessages} messages!
+   <button onClick={open}>Open chat now</button>
   </div>;
 };
 ```
@@ -78,10 +78,10 @@ const App = () => {
   
   return (
     <ZendeskProvider
-		apiKey={process.env.KEY || ""}
-		onOpen={handleOpen}
-		onClose={handleClose}
-		onUnreadMessages={handleUnreadMessages}
+    apiKey={process.env.KEY || ""}
+    onOpen={handleOpen}
+    onClose={handleClose}
+    onUnreadMessages={handleUnreadMessages}
     >
       <p>fake child example</p>
     </ZendeskProvider>
@@ -112,6 +112,7 @@ Library add some useful fields.
 | setConversationFields            | (conversationFields: ZendeskConversationField[]) => void                                 | Allows values for conversation fields to be set in the client to add contextual data about the conversation.
 | setConversationTags            | (conversationTags: string[]) => void                                 | Allows custom conversation tags to be set in the client to add contextual data about the conversation
 | loginUser            | (jwtToken: string, loginCallback?: (error: null/LoginFailedError) => void) => void                                 | If your application has a login flow, or if a user needs to access the same conversation from multiple devices. See details on [Zendesk docs](https://developer.zendesk.com/api-reference/widget-messaging/web/authentication/). Error is mapped with the same error of official documentation.
+| useSessionAuth | () => void | See details on [Zendesk docs](https://developer.zendesk.com/api-reference/widget-messaging/web/authentication/).
 | logoutUser            | () => void                                 | Your app may have a logout function that brings users back to a login screen. In this case, revert the messaging Web Widget to a pre-login state
 | resetWidget            | () => void                                 | This method clears all widget local state, including user data, conversations, and connections.
 | isOpen            | boolean                                 | this flag indicates if chat is visible or hidden. Derivated from from `onOpen` and `onCLose`

apps/docs/app/components/ExampleList.tsx

@@ -260,6 +260,26 @@ export const ExampleList: React.FC = () => {
         resetWidget();
       },
     },
+    {
+      id: "useSessionAuth",
+      title: "useSessionAuth",
+      buttonText: "useSessionAuth",
+      description: (
+        <div>
+          For use when the Web Widget is embedded in a Zendesk help center. To
+          learn more about Reset Widget see{" "}
+          <a
+            href="https://developer.zendesk.com/api-reference/widget-messaging/web/authentication/#use-session-auth"
+            target="_blank"
+          >
+            useSessionAuth
+          </a>
+        </div>
+      ),
+      onClick({ useSessionAuth }) {
+        useSessionAuth();
+      },
+    },
   ];
   return (
     <>

packages/react-use-zendesk/README.md

@@ -112,6 +112,7 @@ Library add some useful fields.
 | setConversationFields            | (conversationFields: ZendeskConversationField[]) => void                                 | Allows values for conversation fields to be set in the client to add contextual data about the conversation.
 | setConversationTags            | (conversationTags: string[]) => void                                 | Allows custom conversation tags to be set in the client to add contextual data about the conversation
 | loginUser            | (jwtToken: string, loginCallback?: (error: null/LoginFailedError) => void) => void                                 | If your application has a login flow, or if a user needs to access the same conversation from multiple devices. See details on [Zendesk docs](https://developer.zendesk.com/api-reference/widget-messaging/web/authentication/). Error is mapped with the same error of official documentation.
+| useSessionAuth | () => void | See details on [Zendesk docs](https://developer.zendesk.com/api-reference/widget-messaging/web/authentication/).
 | logoutUser            | () => void                                 | Your app may have a logout function that brings users back to a login screen. In this case, revert the messaging Web Widget to a pre-login state
 | resetWidget            | () => void                                 | This method clears all widget local state, including user data, conversations, and connections.
 | isOpen            | boolean                                 | this flag indicates if chat is visible or hidden. Derivated from from `onOpen` and `onCLose`

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

@@ -62,7 +62,7 @@ export const ZendeskProvider: React.FC<
         setUnreadMessages(unreadMessages);
         !!onUnreadMessagesRef.current &&
           onUnreadMessagesRef.current(unreadMessages);
-      },
+      }
     );
 
     isRegisteredCb.current = true;
@@ -108,31 +108,31 @@ export const ZendeskProvider: React.FC<
     (conversationFields: Array<ZendeskConversationField>) => {
       ZendeskApi("messenger:set", "conversationFields", conversationFields);
     },
-    [],
+    []
   );
 
   const setConversationTags = React.useCallback(
     (conversationTags: Array<string>) => {
       ZendeskApi("messenger:set", "conversationTags", conversationTags);
     },
-    [],
+    []
   );
 
   const loginUser = React.useCallback(
     (
       jwtToken: string,
-      loginCallback?: (error: null | LoginFailedError) => void,
+      loginCallback?: (error: null | LoginFailedError) => void
     ) => {
       ZendeskApi(
         "messenger",
         "loginUser",
         (jwtTokenCb: (token: string) => void) => {
           jwtTokenCb(jwtToken);
         },
-        loginCallback,
+        loginCallback
       );
     },
-    [],
+    []
   );
 
   const logoutUser = React.useCallback(() => {
@@ -145,6 +145,10 @@ export const ZendeskProvider: React.FC<
     });
   }, []);
 
+  const useSessionAuth = React.useCallback(() => {
+    ZendeskApi("messenger", "useSessionAuth");
+  }, []);
+
   const initialProviderValue: ZendeskContextValues = {
     show,
     hide,
@@ -158,6 +162,7 @@ export const ZendeskProvider: React.FC<
     loginUser,
     logoutUser,
     resetWidget,
+    useSessionAuth,
     isOpen,
     unreadMessages,
   };

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

@@ -26,15 +26,16 @@ export type ZendeskContextValues = {
   setZIndex: (newZIndex: number) => void;
   setCookies: (isEnabled: boolean) => void;
   setConversationFields: (
-    conversationFields: Array<ZendeskConversationField>,
+    conversationFields: Array<ZendeskConversationField>
   ) => void;
   setConversationTags: (conversationTags: Array<string>) => void;
   loginUser: (
     jwtToken: string,
-    loginCallback?: (error: null | LoginFailedError) => void,
+    loginCallback?: (error: null | LoginFailedError) => void
   ) => void;
   logoutUser: () => void;
   resetWidget: () => void;
+  useSessionAuth: () => void;
   isOpen: boolean;
   unreadMessages: number | undefined;
 };
@@ -52,4 +53,5 @@ export type ZendeskMethod =
   | "conversationTags"
   | "loginUser"
   | "logoutUser"
-  | "resetWidget";
+  | "resetWidget"
+  | "useSessionAuth";