@onedeskpro/chatbot-react 0.3.1 → 0.4.0

package/README.md

@@ -50,7 +50,8 @@ function SupportPanel() {
     sendMessage,
     submitIdentify,
     requestHuman,
-    resetSession,
+    cancelHumanRequest,
+    startNewConversation,
   } = useChatbot();
 
   if (!isReady) return null;
@@ -74,12 +75,18 @@ function SupportPanel() {
           {m.message.type}: {m.message.content}
         </p>
       ))}
-      {mode === 'waiting' && <p>Waiting for a human agent…</p>}
+      {mode === 'waiting' && (
+        <p>
+          Waiting for a human agent… <button onClick={cancelHumanRequest}>Cancel request</button>
+        </p>
+      )}
       <button onClick={() => sendMessage('Hello')} disabled={isLoading || mode === 'closed'}>
         Send
       </button>
       {mode === 'ai' && <button onClick={requestHuman}>Talk to a person</button>}
-      {mode === 'closed' && <button onClick={resetSession}>New conversation</button>}
+      <button onClick={startNewConversation} disabled={isLoading}>
+        New conversation
+      </button>
     </div>
   );
 }
@@ -100,6 +107,8 @@ function SupportPanel() {
 | `sendAttachments(files, text?)` | Sends up to 10 files (10 MB each) as one media message, with `text` as the caption. The message appears with `pending: true` and local previews until the uploads finish. |
 | `sendVoice(recording)` | Sends a voice note recorded with `VoiceRecorder` from `@onedeskpro/chatbot-core`. |
 | `requestHuman()` | Escalates to a human agent. Does nothing unless `mode` is `'ai'` and a conversation has started. |
+| `cancelHumanRequest()` | Withdraws a pending human request so the AI answers again. Does nothing unless `mode` is `'waiting'`. |
+| `startNewConversation()` | Ends the current conversation in any mode and starts a fresh one; `messages` is cleared and `mode` returns to `'ai'`. |
 | `resetSession()` | Clears a `closed` conversation. Does nothing in any other mode. |
 | `open()`, `close()`, `toggle()` | Control the built-in widget's panel. |
 | `sessionId` | Deprecated alias of `visitorToken`. |

package/dist/index.cjs

@@ -1 +1 @@
-Object.defineProperty(exports,Symbol.toStringTag,{value:`Module`});var e=Object.create,t=Object.defineProperty,n=Object.getOwnPropertyDescriptor,r=Object.getOwnPropertyNames,i=Object.getPrototypeOf,a=Object.prototype.hasOwnProperty,o=(e,i,o,s)=>{if(i&&typeof i==`object`||typeof i==`function`)for(var c=r(i),l=0,u=c.length,d;l<u;l++)d=c[l],!a.call(e,d)&&d!==o&&t(e,d,{get:(e=>i[e]).bind(null,d),enumerable:!(s=n(i,d))||s.enumerable});return e},s=(n,r,s)=>(s=n==null?{}:e(i(n)),o(r||!n||!n.__esModule||!a.call(n,`default`)?t(s,`default`,{value:n,enumerable:!0}):s,n));let c=require("react");c=s(c,1);let l=require("@onedeskpro/chatbot-core"),u=require("react/jsx-runtime");var d=(0,c.createContext)(null);function f(){let e=(0,c.useContext)(d);if(!e)throw Error(`useChatbot must be used inside <ChatbotProvider>.`);return e}function p({children:e,...t}){let n=(0,c.useRef)(null);return n.current||=new l.ChatbotCore,(0,c.useEffect)(()=>{let e=n.current;return e.init(t).catch(e=>{console.error(`[onedeskpro-chatbot] Failed to initialise:`,e)}),()=>e.destroy()},[]),(0,u.jsx)(d.Provider,{value:n.current,children:e})}function m(){let e=f(),[t,n]=(0,c.useState)(()=>e.getState());(0,c.useEffect)(()=>{let t=e.on(`state-change`,e=>n({...e}));return n({...e.getState()}),t},[e]);let r=(0,c.useCallback)(t=>e.sendMessage(t),[e]),i=(0,c.useCallback)((t,n)=>e.sendAttachments(t,n),[e]),a=(0,c.useCallback)(t=>e.sendVoice(t),[e]),o=(0,c.useCallback)(t=>e.submitIdentify(t),[e]),s=(0,c.useCallback)(()=>e.requestHuman(),[e]),l=(0,c.useCallback)(()=>e.open(),[e]),u=(0,c.useCallback)(()=>e.close(),[e]),d=(0,c.useCallback)(()=>e.toggle(),[e]),p=(0,c.useCallback)(()=>e.resetSession(),[e]);return{messages:t.messages,isOpen:t.isOpen,isLoading:t.isLoading,isReady:t.isReady,needsIdentify:t.needsIdentify,blockReason:t.blockReason,error:t.error,visitorToken:t.visitorToken,visitorName:t.visitorName,mode:t.mode,sessionId:t.visitorToken,sendMessage:r,sendAttachments:i,sendVoice:a,submitIdentify:o,requestHuman:s,open:l,close:u,toggle:d,resetSession:p}}function h(){let e=f();return(0,c.useEffect)(()=>{},[e]),(0,u.jsx)(`div`,{style:{display:`none`},"aria-hidden":`true`})}function g({renderLauncher:e,renderWindow:t}){let{isOpen:n,toggle:r,open:i,close:a,messages:o,sendMessage:s,sendAttachments:c,isLoading:l,error:d}=m();return(0,u.jsxs)(u.Fragment,{children:[e({isOpen:n,toggle:r,open:i,close:a}),t({isOpen:n,messages:o,sendMessage:s,sendAttachments:c,isLoading:l,error:d,close:a})]})}exports.ChatbotContext=d,exports.ChatbotHeadless=g,exports.ChatbotProvider=p,exports.ChatbotWidget=h,exports.useChatbot=m;
+Object.defineProperty(exports,Symbol.toStringTag,{value:`Module`});var e=Object.create,t=Object.defineProperty,n=Object.getOwnPropertyDescriptor,r=Object.getOwnPropertyNames,i=Object.getPrototypeOf,a=Object.prototype.hasOwnProperty,o=(e,i,o,s)=>{if(i&&typeof i==`object`||typeof i==`function`)for(var c=r(i),l=0,u=c.length,d;l<u;l++)d=c[l],!a.call(e,d)&&d!==o&&t(e,d,{get:(e=>i[e]).bind(null,d),enumerable:!(s=n(i,d))||s.enumerable});return e},s=(n,r,s)=>(s=n==null?{}:e(i(n)),o(r||!n||!n.__esModule||!a.call(n,`default`)?t(s,`default`,{value:n,enumerable:!0}):s,n));let c=require("react");c=s(c,1);let l=require("@onedeskpro/chatbot-core"),u=require("react/jsx-runtime");var d=(0,c.createContext)(null);function f(){let e=(0,c.useContext)(d);if(!e)throw Error(`useChatbot must be used inside <ChatbotProvider>.`);return e}function p({children:e,...t}){let n=(0,c.useRef)(null);return n.current||=new l.ChatbotCore,(0,c.useEffect)(()=>{let e=n.current;return e.init(t).catch(e=>{console.error(`[onedeskpro-chatbot] Failed to initialise:`,e)}),()=>e.destroy()},[]),(0,u.jsx)(d.Provider,{value:n.current,children:e})}function m(){let e=f(),[t,n]=(0,c.useState)(()=>e.getState());(0,c.useEffect)(()=>{let t=e.on(`state-change`,e=>n({...e}));return n({...e.getState()}),t},[e]);let r=(0,c.useCallback)(t=>e.sendMessage(t),[e]),i=(0,c.useCallback)((t,n)=>e.sendAttachments(t,n),[e]),a=(0,c.useCallback)(t=>e.sendVoice(t),[e]),o=(0,c.useCallback)(t=>e.submitIdentify(t),[e]),s=(0,c.useCallback)(()=>e.requestHuman(),[e]),l=(0,c.useCallback)(()=>e.cancelHumanRequest(),[e]),u=(0,c.useCallback)(()=>e.startNewConversation(),[e]),d=(0,c.useCallback)(()=>e.open(),[e]),p=(0,c.useCallback)(()=>e.close(),[e]),m=(0,c.useCallback)(()=>e.toggle(),[e]),h=(0,c.useCallback)(()=>e.resetSession(),[e]);return{messages:t.messages,isOpen:t.isOpen,isLoading:t.isLoading,isReady:t.isReady,needsIdentify:t.needsIdentify,blockReason:t.blockReason,error:t.error,visitorToken:t.visitorToken,visitorName:t.visitorName,mode:t.mode,sessionId:t.visitorToken,sendMessage:r,sendAttachments:i,sendVoice:a,submitIdentify:o,requestHuman:s,cancelHumanRequest:l,startNewConversation:u,open:d,close:p,toggle:m,resetSession:h}}function h(){let e=f();return(0,c.useEffect)(()=>{},[e]),(0,u.jsx)(`div`,{style:{display:`none`},"aria-hidden":`true`})}function g({renderLauncher:e,renderWindow:t}){let{isOpen:n,toggle:r,open:i,close:a,messages:o,sendMessage:s,sendAttachments:c,isLoading:l,error:d}=m();return(0,u.jsxs)(u.Fragment,{children:[e({isOpen:n,toggle:r,open:i,close:a}),t({isOpen:n,messages:o,sendMessage:s,sendAttachments:c,isLoading:l,error:d,close:a})]})}exports.ChatbotContext=d,exports.ChatbotHeadless=g,exports.ChatbotProvider=p,exports.ChatbotWidget=h,exports.useChatbot=m;

package/dist/index.d.cts

@@ -96,6 +96,10 @@ export declare interface UseChatbotReturn {
     }) => Promise<void>;
     /** Escalate the open AI ticket to a human agent (no-op unless mode is `ai`). */
     requestHuman: () => Promise<void>;
+    /** Withdraw a pending human request so the AI answers again (no-op unless mode is `waiting`). */
+    cancelHumanRequest: () => Promise<void>;
+    /** End the current conversation in any mode and start a fresh one (clears `messages`). */
+    startNewConversation: () => Promise<void>;
     open: () => void;
     close: () => void;
     toggle: () => void;

package/dist/index.d.ts

@@ -96,6 +96,10 @@ export declare interface UseChatbotReturn {
     }) => Promise<void>;
     /** Escalate the open AI ticket to a human agent (no-op unless mode is `ai`). */
     requestHuman: () => Promise<void>;
+    /** Withdraw a pending human request so the AI answers again (no-op unless mode is `waiting`). */
+    cancelHumanRequest: () => Promise<void>;
+    /** End the current conversation in any mode and start a fresh one (clears `messages`). */
+    startNewConversation: () => Promise<void>;
     open: () => void;
     close: () => void;
     toggle: () => void;

package/dist/index.js

@@ -28,7 +28,7 @@ function p() {
 		let t = e.on("state-change", (e) => i({ ...e }));
 		return i({ ...e.getState() }), t;
 	}, [e]);
-	let o = t((t) => e.sendMessage(t), [e]), s = t((t, n) => e.sendAttachments(t, n), [e]), c = t((t) => e.sendVoice(t), [e]), l = t((t) => e.submitIdentify(t), [e]), u = t(() => e.requestHuman(), [e]), f = t(() => e.open(), [e]), p = t(() => e.close(), [e]), m = t(() => e.toggle(), [e]), h = t(() => e.resetSession(), [e]);
+	let o = t((t) => e.sendMessage(t), [e]), s = t((t, n) => e.sendAttachments(t, n), [e]), c = t((t) => e.sendVoice(t), [e]), l = t((t) => e.submitIdentify(t), [e]), u = t(() => e.requestHuman(), [e]), f = t(() => e.cancelHumanRequest(), [e]), p = t(() => e.startNewConversation(), [e]), m = t(() => e.open(), [e]), h = t(() => e.close(), [e]), g = t(() => e.toggle(), [e]), _ = t(() => e.resetSession(), [e]);
 	return {
 		messages: n.messages,
 		isOpen: n.isOpen,
@@ -46,10 +46,12 @@ function p() {
 		sendVoice: c,
 		submitIdentify: l,
 		requestHuman: u,
-		open: f,
-		close: p,
-		toggle: m,
-		resetSession: h
+		cancelHumanRequest: f,
+		startNewConversation: p,
+		open: m,
+		close: h,
+		toggle: g,
+		resetSession: _
 	};
 }
 // src/chatbot-widget.tsx

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@onedeskpro/chatbot-react",
-  "version": "0.3.1",
+  "version": "0.4.0",
   "description": "React SDK for the Onedesk Pro Chatbot",
   "license": "MIT",
   "author": "Typetech IT <support@onedeskpro.com>",
@@ -50,11 +50,11 @@
     "react-dom": ">=18.0.0"
   },
   "dependencies": {
-    "@onedeskpro/chatbot-core": "0.3.1",
-    "@onedeskpro/chatbot-types": "0.3.1"
+    "@onedeskpro/chatbot-core": "0.4.0",
+    "@onedeskpro/chatbot-types": "0.4.0"
   },
   "devDependencies": {
-    "@microsoft/api-extractor": "^7.59.4",
+    "@microsoft/api-extractor": "^7.60.0",
     "@testing-library/dom": "^10.4.2",
     "@testing-library/jest-dom": "^7.0.1",
     "@testing-library/react": "^16.3.3",