@xapp/chat-widget 1.36.8 → 1.37.2

package/dist/store/ChatState.d.ts

@@ -37,7 +37,14 @@ export interface ChatState {
      * Users access token for making authenticated API calls.
      */
     accessToken?: string;
+    /**
+     * Current active contexts
+     */
     activeContexts?: readonly string[];
+    /**
+     * Attributes to be sent on every request.
+     */
+    attributes?: Record<string, unknown>;
 }
 export interface ConnectionState {
     readonly token: string | null;

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

@@ -9,3 +9,4 @@ 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 reset } from "./resetAction";

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

@@ -1,2 +1,2 @@
 import { ResetAction } from "../ChatAction";
-export declare function reset(): ResetAction;
+export default function reset(): ResetAction;

package/dist/xapp/ChatServer.d.ts

@@ -7,6 +7,16 @@ export interface ChatServer {
     sendChatMsg(message: ChatServerMessage, cb: (err?: Error) => void): void;
     sendChatMsgRequest(message: ChatMessageRequest, cb: (err?: Error) => void): void;
     sendTyping(isTyping: boolean): void;
+    /**
+     * Sets who the visitor is (userId, accessToken, attributes)
+     *
+     * This data is then used on the requests to the server.
+     *
+     * Developer Note: This same information can be found on the redux state, it is only pulled from there once in the beginning.
+     *
+     * @param visitorInfo
+     * @param cb
+     */
     setVisitorInfo(visitorInfo: VisitorInfoMessage, cb: (error?: Error) => void): void;
     sendChatRating(rating?: "bad" | "good"): void;
     sendFile(file: File, cb: (err?: Error) => void): void;
@@ -23,8 +33,17 @@ export interface OfflineMessage {
     readonly email: string;
     readonly message: string;
 }
+/**
+ * The visitor is on person on the browser, talking to either the bot or the live agent.
+ */
 export interface VisitorInfoMessage {
+    /**
+     * Visitors name
+     */
     readonly name?: string;
+    /**
+     * Visitor's display name
+     */
     readonly displayName?: string;
     /**
      * The email of the visitor
@@ -34,8 +53,18 @@ export interface VisitorInfoMessage {
      * Visitors access token
      */
     readonly accessToken?: string;
+    /**
+     * User ID of the visitor
+     */
+    readonly userId?: string;
     /**
      * Visitor's ID, can also be userId
+     *
+     * @deprecated - Use userId
      */
     readonly visitorId?: string;
+    /**
+     * Optional request attributes.
+     */
+    readonly attributes?: Record<string, any>;
 }

package/dist/xapp/ChatServerMessage.d.ts

@@ -24,6 +24,10 @@ export interface ChatMessageRequest {
     endSession?: boolean;
     handoffMessage?: string;
     handoffTarget?: string;
+    /**
+     * Optional, open ended, attributes to append to each request.
+     */
+    attributes?: Record<string, unknown>;
 }
 export declare type PermissionRequestType = "EMAIL" | "PHONE_NUMBER" | "LOCATION_PRECISE";
 export interface PermissionRequest {
@@ -47,6 +51,10 @@ export interface ChatServerMessage {
     location?: ChatServerLocation;
     displays?: readonly Display[];
     context?: readonly string[];
+    /**
+     * Optional, open ended, attributes to append to each request.
+     */
+    attributes?: Record<string, unknown>;
 }
 export interface ChatServerLocation {
     readonly latitude: number;

package/dist/xapp/StentorDirectChat.d.ts

@@ -9,6 +9,7 @@ export declare class StentorDirectChat implements ChatServer {
     private _userId;
     private _sessionId;
     private _accessToken;
+    private _attributes;
     private dispatch;
     private visitorInfo;
     private isNewSession;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@xapp/chat-widget",
-    "version": "1.36.8",
+    "version": "1.37.2",
     "description": "XAPP Chat Widget",
     "scripts": {
         "clean": "rm -rf ./lib/* && rm -rf ./dist/*",
@@ -39,7 +39,7 @@
     "homepage": "https://github.com/XappMedia/chat-widget#readme",
     "devDependencies": {
         "@babel/core": "7.16.5",
-        "@rollup/plugin-commonjs": "21.0.1",
+        "@rollup/plugin-commonjs": "21.0.2",
         "@rollup/plugin-node-resolve": "13.1.3",
         "@storybook/addon-actions": "6.4.9",
         "@storybook/addon-essentials": "6.4.9",
@@ -49,8 +49,8 @@
         "@types/enzyme": "3.10.11",
         "@types/enzyme-adapter-react-16": "1.0.6",
         "@types/jest": "27.0.3",
-        "@types/react": "17.0.39",
-        "@types/react-redux": "7.1.20",
+        "@types/react": "17.0.41",
+        "@types/react-redux": "7.1.23",
         "@types/react-transition-group": "4.4.4",
         "@types/socket.io-client": "1.4.36",
         "@types/store": "2.0.2",
@@ -84,7 +84,7 @@
         "rollup-plugin-typescript2": "0.31.2",
         "sass": "1.45.0",
         "sass-loader": "10.2.1",
-        "stentor-models": "1.52.27",
+        "stentor-models": "1.54.3",
         "ts-jest": "27.1.1",
         "typescript": "4.5.4"
     },
@@ -101,12 +101,12 @@
     },
     "dependencies": {
         "@rollup/plugin-replace": "^3.0.0",
-        "@xapp/chat-widget-core": "1.36.2",
-        "@xapp/stentor-chat-widget": "1.36.8",
+        "@xapp/chat-widget-core": "1.37.0",
+        "@xapp/stentor-chat-widget": "1.37.2",
         "react-transition-group": "4.4.2",
         "socket.io-client": "4.4.0",
         "store": "2.0.12",
         "tslib": "2.3.1"
     },
-    "gitHead": "70572aef716e9261f51e05f80a2efa50d155293c"
+    "gitHead": "4b1a7f9e86e0490e7a0bd32de020d85d8613968c"
 }

package/dist/components/IconButton/IconButton.d.ts

@@ -1,9 +0,0 @@
-import { FC, MouseEvent, VFC } from "react";
-import "./IconButton.scss";
-export interface IconButtonProps {
-    readonly type?: "button" | "submit";
-    readonly className?: string;
-    readonly icon: VFC;
-    onClick?(ev: MouseEvent<HTMLButtonElement>): void;
-}
-export declare const IconButton: FC<IconButtonProps>;

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

@@ -1 +0,0 @@
-export { IconButton } from "./IconButton";

package/dist/components/Storybook/messages.d.ts

@@ -1,5 +0,0 @@
-import { ChatDetail } from "../../store/ChatAction";
-import { ChatServerMessage } from "../../xapp/ChatServerMessage";
-export declare const carouselMessage: ChatServerMessage;
-export declare const listMessage: ChatServerMessage;
-export declare const messages: readonly ChatDetail[];

package/dist/components/Suggestions/SuggestionsGroupItem.d.ts

@@ -1,16 +0,0 @@
-import { FC } from "react";
-import { SuggestionItemData, SuggestionType } from "./data";
-import "./SuggestionsGroupItem.scss";
-export interface SuggestionsGroupItemProps {
-    readonly group: SuggestionsGroupItemData;
-    readonly currentIndex: number;
-    onItemClick(data: SuggestionItemData): void;
-    onItemUse(data: SuggestionItemData): void;
-    onItemHover?(data: SuggestionItemData): void;
-}
-export interface SuggestionsGroupItemData {
-    readonly type: SuggestionType;
-    readonly items: SuggestionItemData[];
-    readonly startIndex: number;
-}
-export declare const SuggestionsGroupItem: FC<SuggestionsGroupItemProps>;

package/dist/components/Suggestions/SuggestionsItem.d.ts

@@ -1,11 +0,0 @@
-import { FC } from "react";
-import { SuggestionItemData } from "./data";
-import "./SuggestionsItem.scss";
-export interface SuggestionsItemProps {
-    readonly data: SuggestionItemData;
-    readonly current: boolean;
-    onClick(data: SuggestionItemData): void;
-    onUse(data: SuggestionItemData): void;
-    onHover(data: SuggestionItemData): void;
-}
-export declare const SuggestionsItem: FC<SuggestionsItemProps>;

package/dist/components/Suggestions/data.test.d.ts

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

package/dist/store/Reset.d.ts

@@ -1 +0,0 @@
-export declare function resetChatWidget(): void;

package/dist/utils/__tests__/url-utils.test.d.ts

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

package/dist/utils/url-utils.d.ts

@@ -1,8 +0,0 @@
-/**
- * Append the provided query params to the URL
- *
- * It will overwrite existing params on the URL if there are conflicts
- * @param url
- * @param params
- */
-export declare function addQueryParametersToURL(url: string, params: URLSearchParams): URL;

package/dist/utils/useJsonFetch.d.ts

@@ -1,20 +0,0 @@
-export interface JsonFetchOptions {
-    readonly pause?: boolean;
-}
-export declare type JsonFetchResponse<T> = JsonFetchSuccessResponse<T> | JsonFetchErrorResponse | JsonFetchFetchingResponse;
-export interface JsonFetchSuccessResponse<T> {
-    readonly fetching: false;
-    readonly success: true;
-    readonly data: T;
-}
-export interface JsonFetchErrorResponse {
-    readonly fetching: false;
-    readonly success: false;
-    readonly error: {
-        readonly httpStatus: number;
-    };
-}
-export interface JsonFetchFetchingResponse {
-    readonly fetching: true;
-}
-export declare function useJsonFetch<T>(url: string, options?: JsonFetchOptions): JsonFetchResponse<T>;

package/dist/utils/uuid.d.ts

@@ -1,7 +0,0 @@
-/**
- * Quicker configurable uuid
- *
- * @export
- * @returns {string}
- */
-export declare function uuid(): string;

package/dist/utils/uuid.test.d.ts

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