@onedeskpro/chatbot-core 0.3.1 → 0.5.0

package/dist/index.d.cts

@@ -33,6 +33,14 @@ export declare class ApiClient {
     uploadAttachment(file: File, visitorToken: string): Promise<UploadAttachmentResponseData>;
     fetchConfig(): Promise<SdkConfigResponse>;
     requestHuman(visitorToken: string): Promise<TicketStatusData>;
+    /** Withdraws a pending human request; answers with the ticket's state afterwards. */
+    cancelHumanRequest(visitorToken: string): Promise<TicketStatusData>;
+    /**
+     * Ends the visitor's conversation so the next message starts a new one. Answers with the
+     * ended conversation (`closed`), or `ai` when there was none.
+     */
+    closeConversation(visitorToken: string): Promise<TicketStatusData>;
+    private postTicketAction;
     fetchTicketStatus(visitorToken: string): Promise<TicketStatusData>;
 }
 
@@ -72,6 +80,13 @@ export declare class ChatbotCore {
     private retryTimer;
     /** Server id of the last `message:receive` push rendered as an agent bubble. */
     private lastPushId;
+    /**
+     * The conversation `startNewConversation` just ended. Its `closed` status — the
+     * socket push the close triggers, or a restore on reconnect — would put the
+     * fresh chat back into closed mode, so it is ignored until the next message
+     * starts a new ticket on that conversation.
+     */
+    private endedConversationId;
     /**
      * Bumped by every init() and by destroy(). An async init compares the token it
      * started with against this before touching anything, so a superseded run — a
@@ -90,6 +105,8 @@ export declare class ChatbotCore {
     /** Derive ticket existence from status restore / socket pushes. */
     private syncHasActiveTicket;
     private syncWidgetMode;
+    /** True for the stale `closed` status of the conversation the visitor just ended. */
+    private isEndedConversation;
     init(options: ChatbotInitOptions): Promise<void>;
     /**
      * Asks `/sdk/config` whether the server is up and the agent can reply, and
@@ -130,6 +147,21 @@ export declare class ChatbotCore {
      * Escalate the open AI ticket to Unassigned. No-op unless the widget is in `ai` mode.
      */
     requestHuman(): Promise<void>;
+    /**
+     * Withdraws a pending human-agent request so the AI answers again. No-op unless the
+     * widget is in `waiting` mode. When an agent accepted the ticket in the meantime, the
+     * mode moves to `human` instead. Emits `human-request-cancelled` once the AI is back.
+     */
+    cancelHumanRequest(): Promise<void>;
+    /**
+     * Ends the current conversation and starts a fresh one: the API closes the open ticket
+     * and gives the AI a new memory, then the chat is cleared and returns to `ai` mode.
+     * Emits `session-reset`. No-op until the visitor has identified, or while a request is
+     * in flight. Unlike `resetSession`, it works in every mode.
+     */
+    startNewConversation(): Promise<void>;
+    /** Records a failed header/banner action: `state.error`, a visible notice, and `error`. */
+    private rejectAction;
     /** The visitor token every send needs; throws when the visitor has not identified. */
     private requireVisitorToken;
     /** Adds the visitor's own message optimistically and marks a send in flight. */

package/dist/index.d.ts

@@ -33,6 +33,14 @@ export declare class ApiClient {
     uploadAttachment(file: File, visitorToken: string): Promise<UploadAttachmentResponseData>;
     fetchConfig(): Promise<SdkConfigResponse>;
     requestHuman(visitorToken: string): Promise<TicketStatusData>;
+    /** Withdraws a pending human request; answers with the ticket's state afterwards. */
+    cancelHumanRequest(visitorToken: string): Promise<TicketStatusData>;
+    /**
+     * Ends the visitor's conversation so the next message starts a new one. Answers with the
+     * ended conversation (`closed`), or `ai` when there was none.
+     */
+    closeConversation(visitorToken: string): Promise<TicketStatusData>;
+    private postTicketAction;
     fetchTicketStatus(visitorToken: string): Promise<TicketStatusData>;
 }
 
@@ -72,6 +80,13 @@ export declare class ChatbotCore {
     private retryTimer;
     /** Server id of the last `message:receive` push rendered as an agent bubble. */
     private lastPushId;
+    /**
+     * The conversation `startNewConversation` just ended. Its `closed` status — the
+     * socket push the close triggers, or a restore on reconnect — would put the
+     * fresh chat back into closed mode, so it is ignored until the next message
+     * starts a new ticket on that conversation.
+     */
+    private endedConversationId;
     /**
      * Bumped by every init() and by destroy(). An async init compares the token it
      * started with against this before touching anything, so a superseded run — a
@@ -90,6 +105,8 @@ export declare class ChatbotCore {
     /** Derive ticket existence from status restore / socket pushes. */
     private syncHasActiveTicket;
     private syncWidgetMode;
+    /** True for the stale `closed` status of the conversation the visitor just ended. */
+    private isEndedConversation;
     init(options: ChatbotInitOptions): Promise<void>;
     /**
      * Asks `/sdk/config` whether the server is up and the agent can reply, and
@@ -130,6 +147,21 @@ export declare class ChatbotCore {
      * Escalate the open AI ticket to Unassigned. No-op unless the widget is in `ai` mode.
      */
     requestHuman(): Promise<void>;
+    /**
+     * Withdraws a pending human-agent request so the AI answers again. No-op unless the
+     * widget is in `waiting` mode. When an agent accepted the ticket in the meantime, the
+     * mode moves to `human` instead. Emits `human-request-cancelled` once the AI is back.
+     */
+    cancelHumanRequest(): Promise<void>;
+    /**
+     * Ends the current conversation and starts a fresh one: the API closes the open ticket
+     * and gives the AI a new memory, then the chat is cleared and returns to `ai` mode.
+     * Emits `session-reset`. No-op until the visitor has identified, or while a request is
+     * in flight. Unlike `resetSession`, it works in every mode.
+     */
+    startNewConversation(): Promise<void>;
+    /** Records a failed header/banner action: `state.error`, a visible notice, and `error`. */
+    private rejectAction;
     /** The visitor token every send needs; throws when the visitor has not identified. */
     private requireVisitorToken;
     /** Adds the visitor's own message optimistically and marks a send in flight. */