@xapp/chat-widget 1.53.1 → 1.54.0

package/dist/store/ChatAction.d.ts

@@ -4,7 +4,7 @@ import { Attachment } from "../xapp/Attachment";
 import { ChatServerMessage } from "../xapp/ChatServerMessage";
 export declare type CONNECTION_STATUS_TYPE = "online" | "pending" | "offline";
 export declare type ACCOUNT_STATUS_TYPE = "offline" | "online";
-export declare type ACTION_TYPE = "chat" | "account_status" | "connection_update" | "department_update" | "visitor_update" | "agent_update" | "error" | "reset";
+export declare type ACTION_TYPE = "chat" | "account_status" | "connection_update" | "department_update" | "visitor_update" | "agent_update" | "error" | "reset" | "sendGreeting";
 export interface ActionDetail {
     timestamp: number;
 }
@@ -15,14 +15,18 @@ export interface ChatActionDetail<T> extends ActionDetail {
 export interface ChatAction extends Action<"chat"> {
     detail: ChatDetail;
 }
-export interface ChatSendGreetingDetail extends Action<"sendGreeting"> {
+export interface ChatSendGreetingDetail extends ChatActionDetail<"sendGreeting"> {
     detail: undefined;
 }
-export interface ConnectionReceiveTokenDetail extends Action<"receiveToken"> {
-    readonly detail: {
-        readonly token: string;
-        readonly timestamp: number;
-    };
+export interface SendGreetingAction extends Action<"sendGreeting"> {
+    detail: ChatSendGreetingDetail;
+}
+export interface ConnectionReceiveTokenAction extends Action<"receiveToken"> {
+    readonly detail: ChatConnectionReceiveTokenDetail;
+}
+export interface ChatConnectionReceiveTokenDetail extends ChatActionDetail<"receiveToken"> {
+    readonly token: string;
+    readonly timestamp: number;
 }
 export interface ChatMemberJoinDetail extends ChatActionDetail<"chat.memberjoin"> {
 }
@@ -113,5 +117,5 @@ export interface SyntheticFileDetail extends ChatActionDetail<"visitor.send.file
 }
 export interface ResetAction extends Action<"reset"> {
 }
-export declare type ActionType = ChatAction | ConnectionUpdateAction | AccountStatusAction | DepartmentUpdateAction | VisitorUpdateAction | AgentUpdateAction | SyntheticAction | ChatSendGreetingDetail | ConnectionReceiveTokenDetail | ResetAction;
-export declare type ChatDetail = ChatMemberJoinDetail | ChatMemberLeaveDetail | ChatMemberPositionDetail | ChatRequestRatingDetail | ChatRatingDetail | ChatFileDetail | ChatMsgDetail | ChatFailureMsgDetail | ChatTypingDetail | ChatOfflineDetail | ChatPrechatDetail;
+export declare type ActionType = ChatAction | ConnectionUpdateAction | AccountStatusAction | DepartmentUpdateAction | VisitorUpdateAction | AgentUpdateAction | SyntheticAction | ConnectionReceiveTokenAction | ResetAction | SendGreetingAction;
+export declare type ChatDetail = ChatMemberJoinDetail | ChatMemberLeaveDetail | ChatMemberPositionDetail | ChatRequestRatingDetail | ChatRatingDetail | ChatFileDetail | ChatMsgDetail | ChatFailureMsgDetail | ChatTypingDetail | ChatOfflineDetail | ChatPrechatDetail | ChatSendGreetingDetail | ChatConnectionReceiveTokenDetail;

package/dist/store/actions/index.d.ts

@@ -9,4 +9,6 @@ export { default as sendTyping } from "./sendTyping";
 export { default as sendVisitorInfo } from "./sendVisitorInfo";
 export { default as setAccountStatus } from "./setAccountStatus";
 export { default as setConnectionStatus } from "./setConnectionStatus";
+export { default as sendBargeIn } from "./sendBargeIn";
+export { default as sendBargeOut } from "./sendBargeOut";
 export { default as reset } from "./resetAction";

package/dist/store/actions/receiveToken.d.ts

@@ -1,2 +1,8 @@
 import { ActionType } from "../ChatAction";
+/**
+ * This is not used anymore. It was part of the handshake with the legacy "chat server"
+ *
+ * @param token
+ * @returns
+ */
 export default function receiveToken(token: string): ActionType;

package/dist/store/actions/sendBargeIn.d.ts

@@ -0,0 +1,2 @@
+import { ChatServerAsyncActionType } from "../../utils/useChatServerDispatch";
+export default function sendBargeIn(agentName: string): ChatServerAsyncActionType;

package/dist/store/actions/sendBargeOut.d.ts

@@ -0,0 +1,2 @@
+import { ChatServerAsyncActionType } from "../../utils/useChatServerDispatch";
+export default function sendBargeOut(): ChatServerAsyncActionType;

package/dist/utils/requestFromMessage.d.ts

@@ -1,4 +1,5 @@
 /*! Copyright (c) 2022, XAPPmedia */
 import { ChatMessageRequest } from "../xapp/ChatServerMessage";
 import { StentorRequest } from "./http-utils";
-export declare function requestFromMessage(message: ChatMessageRequest, userId: string, isNewSession: boolean, sessionId: string, accessToken: string, attributes: Record<string, unknown>): StentorRequest;
+import { VisitorInfo } from "../xapp/StentorRouterChat";
+export declare function requestFromMessage(message: ChatMessageRequest, userId: string, isNewSession: boolean, sessionId: string, accessToken: string, attributes: Record<string, unknown>, visitorInfo: VisitorInfo): StentorRequest;

package/dist/xapp/ChatServer.d.ts

@@ -27,6 +27,8 @@ export interface ChatServer {
     markAsRead(): void;
     flush(): void;
     dispose(): void;
+    bargeOut(arg0: (err?: Error) => void): unknown;
+    bargeIn(agentName: string, arg1: (err?: Error) => void): unknown;
 }
 export interface ChatServerOptions {
     readonly token?: string;
@@ -43,6 +45,10 @@ export interface OfflineMessage {
  * The visitor is on person on the browser, talking to either the bot or the live agent.
  */
 export interface VisitorInfoMessage {
+    /**
+     * Admin i.e. human agent watching type
+     */
+    readonly isAdmin?: boolean;
     /**
      * Visitors name
      */

package/dist/xapp/LogChat.d.ts

@@ -4,6 +4,8 @@ import { ChatMessageRequest, ChatServerMessage } from "./ChatServerMessage";
 export declare class LogChat implements ChatServer {
     private readonly inner;
     constructor(inner: ChatServer);
+    bargeOut(cb: (err?: Error) => void): void;
+    bargeIn(agentName: string, cb: (err?: Error) => void): void;
     init(dispatch: (action: ActionType) => void): void;
     sendOfflineMsg(message: OfflineMessage, cb: (error?: Error) => void): void;
     sendChatMsg(message: ChatServerMessage, cb: (err?: Error) => void): void;

package/dist/xapp/StentorDirectChat.d.ts

@@ -28,6 +28,8 @@ export declare class StentorDirectChat implements ChatServer {
     private sendFailureMessage;
     sendOfflineMsg(_: OfflineMessage, cb: (error?: Error) => void): void;
     sendChatMsg(message: ChatServerMessage, cb: (err?: Error) => void): Promise<void>;
+    bargeOut(_cb: (err?: Error) => void): Promise<void>;
+    bargeIn(_agentName: string, _cb: (err?: Error) => void): Promise<void>;
     private getBot;
     sendChatMsgRequest(serviceRequest: ChatMessageRequest, cb: (err?: Error) => void): Promise<void>;
     sendTyping(): void;

package/dist/xapp/StentorLocalChat.d.ts

@@ -11,4 +11,6 @@ export declare class StentorLocalChat implements ChatServer {
     markAsRead(): void;
     flush(): void;
     dispose(): void;
+    bargeOut(): void;
+    bargeIn(): void;
 }

package/dist/xapp/StentorRouterChat.d.ts

@@ -5,11 +5,23 @@ import { ChatMessageRequest, ChatServerMessage } from "./ChatServerMessage";
 export interface StentorRouterChatConfig {
     readonly url: string;
 }
-export declare type StentorMessage = Request | Response | undefined;
+export interface FailureData {
+    readonly type: "BOT";
+    readonly tries: number;
+    readonly delay: number;
+    readonly error: string;
+}
+export declare type MessageData = Request | Response | ConnectionStatus | FailureData | undefined;
+export interface ConnectionStatus {
+    sessionCreated: boolean;
+    errorMessage?: string;
+}
+export declare type EventType = "account status" | "connection update" | "new message" | "user joined" | "user left" | "typing" | "stop typing" | "disconnect" | "reconnect" | "reconnect failed" | "reconnect error" | "barge in" | "barge out" | "failure";
 export interface RouterMessage {
-    event: string;
-    data: StentorMessage;
+    event: EventType;
+    data: MessageData;
     sender: VisitorInfo;
+    sessionId: string;
 }
 export interface VisitorInfo {
     deviceId: "Widget" | "Bot";
@@ -21,13 +33,13 @@ export interface VisitorInfo {
     urlAttributes: {
         path?: string[];
         query?: {
-            (name: string): string;
+            [name: string]: string;
         };
     };
 }
-export interface HandlerStore {
-    (event: string): (data: StentorMessage, sender: VisitorInfo) => void;
-}
+export declare type HandlerStore = {
+    [event in EventType]: (data: MessageData, sender: VisitorInfo) => void;
+};
 export declare class StentorRouterChat implements ChatServer {
     private dispatch;
     private _userId;
@@ -40,27 +52,46 @@ export declare class StentorRouterChat implements ChatServer {
     private urlAttributes;
     private readonly config;
     private readonly options;
+    private readonly configurableMessages;
     private serverUrl;
     private ws;
     private handlers;
+    private sessionCreated;
     constructor(config: StentorRouterChatConfig, options?: ChatServerOptions);
     init(dispatch: (action: ActionType) => void): void;
     private autoReconnect;
     private wsCreate;
+    private checkConnection;
     private emit;
     private setAccountStatus;
+    private setConnectionStatus;
     sendOfflineMsg(_: OfflineMessage, cb: (error?: Error) => void): void;
     sendChatMsg(message: ChatServerMessage, cb: (err?: Error) => void): Promise<void>;
+    private sendFailureMessage;
+    private checkSession;
     sendChatMsgRequest(serviceRequest: ChatMessageRequest, cb: (err?: Error) => void): Promise<void>;
-    sendTyping(isTyping: boolean): void;
+    sendTyping(_isTyping: boolean): void;
     setVisitorInfo(visitorInfoMessage: VisitorInfoMessage, cb: (error?: Error) => void): void;
     sendChatRating(): void;
     sendFile(_: File, cb: (err?: Error) => void): void;
     markAsRead(): void;
     flush(): void;
     dispose(): void;
+    bargeOut(_cb: (err?: Error) => void): Promise<void>;
+    bargeIn(agentName: string, _cb: (err?: Error) => void): Promise<void>;
+    private postVisitorInfo;
     private postMessage;
     private startSession;
-    get userId(): string;
-    get sessionId(): string;
 }
+/**
+ *
+ * @param check Function that return true/false if the resource is available
+ * @param stepMs check period in ms
+ * @param timeoutMs max wait in ms
+ * @param resource optional resource name. you will see a log message for every check (step)
+ *
+ * @returns the elapsed time in ms (both resolve/reject)
+ */
+export declare function waitFor(check: {
+    (): boolean;
+}, stepMs: number, timeoutMs: number, resource?: string): Promise<unknown>;

package/dist/xapp/StentorServerChat.d.ts

@@ -23,4 +23,6 @@ export declare class StentorServerChat implements ChatServer {
     markAsRead(): void;
     flush(): void;
     dispose(): void;
+    bargeOut(_cb: (err?: Error) => void): Promise<void>;
+    bargeIn(_agentName: string, _cb: (err?: Error) => void): Promise<void>;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@xapp/chat-widget",
-    "version": "1.53.1",
+    "version": "1.54.0",
     "description": "XAPP Chat Widget",
     "scripts": {
         "clean": "rm -rf ./lib/* && rm -rf ./dist/*",
@@ -38,20 +38,20 @@
     },
     "homepage": "https://github.com/XappMedia/chat-widget#readme",
     "devDependencies": {
-        "@babel/core": "7.18.13",
+        "@babel/core": "7.20.12",
         "@rollup/plugin-commonjs": "22.0.2",
         "@rollup/plugin-json": "4.1.0",
         "@rollup/plugin-node-resolve": "13.3.0",
-        "@storybook/addon-actions": "6.5.10",
-        "@storybook/addon-essentials": "6.5.10",
-        "@storybook/addon-links": "6.5.10",
-        "@storybook/react": "6.5.10",
+        "@storybook/addon-actions": "6.5.16",
+        "@storybook/addon-essentials": "6.5.16",
+        "@storybook/addon-links": "6.5.16",
+        "@storybook/react": "6.5.16",
         "@testing-library/jest-dom": "5.16.5",
         "@types/enzyme": "3.10.12",
         "@types/enzyme-adapter-react-16": "1.0.6",
         "@types/jest": "27.5.2",
-        "@types/react": "17.0.52",
-        "@types/react-redux": "7.1.24",
+        "@types/react": "17.0.53",
+        "@types/react-redux": "7.1.25",
         "@types/react-transition-group": "4.4.5",
         "@types/socket.io-client": "1.4.36",
         "@types/store": "2.0.2",
@@ -59,24 +59,24 @@
         "@typescript-eslint/parser": "5.30.6",
         "babel-eslint": "10.1.0",
         "babel-jest": "27.5.1",
-        "babel-loader": "8.2.5",
+        "babel-loader": "8.3.0",
         "enzyme": "3.11.0",
-        "enzyme-adapter-react-16": "1.15.6",
-        "eslint": "8.22.0",
+        "enzyme-adapter-react-16": "1.15.7",
+        "eslint": "8.34.0",
         "eslint-config-prettier": "7.2.0",
         "eslint-config-react-app": "6.0.0",
         "eslint-plugin-flowtype": "8.0.3",
-        "eslint-plugin-import": "2.26.0",
-        "eslint-plugin-jsx-a11y": "6.6.1",
+        "eslint-plugin-import": "2.27.5",
+        "eslint-plugin-jsx-a11y": "6.7.1",
         "eslint-plugin-react": "7.31.0",
         "eslint-plugin-react-hooks": "4.6.0",
         "jest": "27.5.1",
         "prettier": "2.7.1",
         "react": "17.0.2",
         "react-dom": "17.0.2",
-        "react-redux": "7.2.8",
-        "redux": "4.2.0",
-        "redux-thunk": "2.4.1",
+        "react-redux": "7.2.9",
+        "redux": "4.2.1",
+        "redux-thunk": "2.4.2",
         "rollup": "2.78.1",
         "rollup-plugin-inject-process-env": "1.3.1",
         "rollup-plugin-peer-deps-external": "2.2.4",
@@ -85,7 +85,7 @@
         "rollup-plugin-typescript2": "0.34.1",
         "sass": "1.53.0",
         "sass-loader": "10.3.1",
-        "stentor-models": "1.57.39",
+        "stentor-models": "1.57.73",
         "ts-jest": "27.1.5",
         "typescript": "4.7.4"
     },
@@ -102,13 +102,13 @@
     },
     "dependencies": {
         "@rollup/plugin-replace": "^4.0.0",
-        "@xapp/chat-widget-core": "1.53.0",
-        "@xapp/stentor-chat-widget": "1.53.1",
+        "@xapp/chat-widget-core": "1.54.0",
+        "@xapp/stentor-chat-widget": "1.54.0",
         "date-fns": "2.28.0",
         "react-transition-group": "4.4.5",
         "socket.io-client": "4.5.1",
         "store": "2.0.12",
         "tslib": "2.4.0"
     },
-    "gitHead": "3669605713dc997df1c8d10a3453bf779075f252"
+    "gitHead": "9dfa1e53eb0adead746c8172b818ba980a4dde64"
 }

package/dist/components/StatusContainer/StatusContainer.d.ts

@@ -1,17 +0,0 @@
-import { WidgetHeaderConfig } from "@xapp/stentor-chat-widget";
-import React, { FC } from "react";
-import { ChatUserInfo } from "../../xapp/UserInfo";
-import "./StatusContainer.scss";
-export interface Props {
-    accountStatus: string;
-    readonly canRefresh: boolean;
-    readonly canMinimize: boolean;
-    readonly canCancel: boolean;
-    readonly agent: ChatUserInfo;
-    readonly config?: WidgetHeaderConfig;
-    refreshOnClick: () => void;
-    minimizeOnClick: () => void;
-    cancelOnClick: () => void;
-}
-declare const StatusContainer: FC<React.PropsWithChildren<Props>>;
-export default StatusContainer;

package/dist/components/StatusContainer/StatusContainer.stories.d.ts

@@ -1,8 +0,0 @@
-import { Meta } from "@storybook/react/types-6-0";
-import { VFC } from "react";
-declare const _default: Meta<import("@storybook/react/types-6-0").Args>;
-export default _default;
-export declare const Online: VFC;
-export declare const Offline: VFC;
-export declare const Away: VFC;
-export declare const WithLongStatus: VFC;

package/dist/components/StatusContainer/StatusContainer.test.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/components/StatusContainer/index.d.ts

@@ -1 +0,0 @@
-export { default as StatusContainer } from "./StatusContainer";

package/dist/xapp/UserInfo.d.ts

@@ -1,15 +0,0 @@
-import { UserInfo } from "@xapp/stentor-chat-widget";
-export interface ChatUserInfo extends UserInfo {
-    /**
-     * Users name
-     */
-    readonly display_name?: string;
-    /**
-     * The token that is received after a login
-     */
-    token?: string;
-    /**
-     * If the user is typing or not
-     */
-    typing?: boolean;
-}