@xapp/chat-widget 1.38.1 → 1.40.2

package/dist/store/ChatAction.d.ts

@@ -42,6 +42,14 @@ export interface ChatFileDetail extends ChatActionDetail<"chat.file"> {
 export interface ChatMsgDetail extends ChatActionDetail<"chat.msg"> {
     msg: ChatServerMessage;
 }
+export interface ChatFailureMsgDetail extends ChatActionDetail<"chat.failureMsg"> {
+    failureMsg: FailureMessageDetail;
+}
+export interface FailureMessageDetail {
+    readonly retry: number;
+    readonly delay: number;
+    readonly text: string;
+}
 export interface ChatTypingDetail extends ChatActionDetail<"chat.typing"> {
     typing: boolean;
 }
@@ -106,4 +114,4 @@ 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 | ChatTypingDetail | ChatOfflineDetail | ChatPrechatDetail;
+export declare type ChatDetail = ChatMemberJoinDetail | ChatMemberLeaveDetail | ChatMemberPositionDetail | ChatRequestRatingDetail | ChatRatingDetail | ChatFileDetail | ChatMsgDetail | ChatFailureMsgDetail | ChatTypingDetail | ChatOfflineDetail | ChatPrechatDetail;

package/dist/store/ChatState.d.ts

@@ -11,6 +11,11 @@ export interface ChatAgentInfo {
     readonly typing: boolean;
     readonly user: ChatUserInfo;
     readonly joined: boolean;
+    readonly requestFailed?: boolean;
+}
+export interface ChatFailureMsgDetail {
+    delay: number;
+    text: string;
 }
 export interface ChatState {
     readonly connection: ConnectionState;
@@ -24,6 +29,7 @@ export interface ChatState {
     hasRating: boolean;
     isChatting: boolean;
     queuePosition: number;
+    failureMsg: ChatFailureMsgDetail;
     chips: (string | ChatServerActionLink)[];
     /**
      * @deprecated Use userId

package/dist/utils/compiler/compileSlotValues.d.ts

@@ -0,0 +1,19 @@
+import { RequestSlotMap, ResponseOutput } from "./models";
+/**
+ * Compiles a templated response with slot values from the
+ * provided slot map.
+ *
+ * For example, when passed "What date do you want your ${flowers}?"
+ * and the slot map contains a slot with name `flowers` it will replace
+ * it with the value.
+ *
+ * It will handle the different potential value types for slots such as
+ * strings, numbers, dates and durations.
+ *
+ * By default, if the slot value does not exist, the template value is left untouched.
+ *
+ * @param responseOutput
+ * @param slots
+ * @param replaceWhenUndefined - When set to true, it will replace the value with 'undefined' if it doesn't exist, default behavior is to leave the template as is.
+ */
+export declare function compileSlotValues(responseOutput: string | ResponseOutput, slots: RequestSlotMap, replaceWhenUndefined?: boolean): string | ResponseOutput;

package/dist/utils/compiler/models.d.ts

@@ -0,0 +1,172 @@
+export declare type RequestSlotValues = string | number | object | DateTimeRange | DateTime | Duration | (string)[];
+/**
+ * Information for a slot coming in on the request.
+ */
+export interface RequestSlot<T = RequestSlotValues> {
+    /**
+     * The name of the slot, also used as the key in the RequestSlotMap.
+     *
+     * For example, "FIRST_TEAM" or "Podcast", this is typically user defined.
+     */
+    name: string;
+    /**
+     * The slot normalized value.
+     *
+     * When leveraging synonyms, this will be the canonical value.  If not then it is
+     * the same as the rawValue.
+     *
+     * For example, "University of Virginia" or "Red Wine".
+     */
+    value?: T;
+    /**
+     * The original value provided by the NLU before normalization.
+     */
+    original?: any;
+    /**
+     * The raw spoken value.
+     *
+     * For example, "cavaliers" or "red"
+     */
+    rawValue?: string;
+    /**
+     * ID of the slot, if applicable.
+     *
+     * For example, "UVA"
+     */
+    id?: string;
+    /**
+     * Confidence on the slot match.  Range is between 0 - 1 where 1 is the highest confidence.
+     */
+    matchConfidence?: number;
+    /**
+     * If the entity resolution was successful or not.
+     *
+     * See {@link https://developer.amazon.com/docs/custom-skills/define-synonyms-and-ids-for-slot-type-values-entity-resolution.html#er-built-in-types}
+     */
+    successfulMatch?: boolean;
+}
+/**
+ * Map of slots where the key is the name of the slot.
+ */
+export interface RequestSlotMap {
+    /**
+     * Each key is the slot name and the corresponding value is the slot.
+     */
+    [slotName: string]: RequestSlot;
+}
+export interface ResponseOutput extends Localizable<LocaleSpecificResponseOutput> {
+    /**
+     * The SSML
+     */
+    ssml?: string;
+    /**
+     * Text to speech
+     *
+     * @deprecated Do not use, instead use both ssml and displayText
+     */
+    textToSpeech?: string;
+    /**
+     * Used only display/chat capable surfaces
+     */
+    displayText?: string;
+    /**
+     * Sanitized HTML, suitable for displaying within a web environment.
+     *
+     * This is typically generated from the displayText based on markdown found within.
+     *
+     * @beta
+     */
+    html?: string;
+    /**
+     * Used where suggestions can be displayed to the user.
+     *
+     * Note: These only apply to prompts, not reprompts.
+     */
+    suggestions?: SuggestionTypes[];
+    /**
+     * The locale for the response, defaults to "en"
+     */
+    defaultLocale?: Locale;
+    /**
+     * The language code for the response output.
+     */
+    locales?: Partial<Record<Locale, LocaleSpecificResponseOutput>>;
+}
+export declare type SuggestionTypes = SimpleSuggestion | SuggestionObjectTypes;
+export declare type SuggestionObjectTypes = Suggestion | LinkOutSuggestion;
+export declare type SimpleSuggestion = string;
+/**
+ * Suggested responses that a user can tap.
+ *
+ * The title has a limit of 25 characters.
+ *
+ * Only Google Assistant at the moment.
+ */
+export interface Suggestion {
+    title: string;
+}
+/**
+ * Suggestion chip that links out to an App or Website.  Ownership of the
+ * URL must be validated in the Actions on Google developer console or the suggestion will not
+ * be shown.
+ *
+ * The title has a limit of 20 characters, note this is different from when
+ * it is a normal suggestion
+ *
+ * Only Google Assistant at the moment.
+ */
+export interface LinkOutSuggestion extends Suggestion {
+    url: string;
+}
+export declare type LocaleSpecificResponseOutput = Partial<Pick<ResponseOutput, "displayText" | "ssml" | "textToSpeech" | "suggestions">>;
+export interface DateTime {
+    /**
+     * ISO-8601 for time, in the format HH:mm:ss
+     */
+    time?: string;
+    /**
+     * ISO-8601 for the date, in the format YYYY-MM-dd
+     */
+    date?: string;
+    /**
+     * ISO-8601 timezone offset string in the format -05:00 or Z
+     */
+    tz?: string;
+}
+export interface DateTimeRange {
+    /**
+     * Start of the range
+     */
+    start: DateTime;
+    /**
+     * End of the range.
+     */
+    end: DateTime;
+}
+/**
+ * Text that describes the format of a duration, for example "years" or "M" for months.
+ *
+ * This is the same as the moment.js duration format.
+ */
+export declare type DurationFormat = "year" | "years" | "y" | "quarter" | "quarters" | "Q" | "month" | "months" | "M" | "week" | "weeks" | "w" | "day" | "days" | "d" | "hour" | "hours" | "h" | "minute" | "minutes" | "m" | "second" | "seconds" | "s" | "millisecond" | "milliseconds" | "ms";
+/**
+ * Duration, amount and format.
+ */
+export interface Duration {
+    readonly amount: number;
+    readonly format: DurationFormat;
+}
+export declare type LocaleObject = object;
+/**
+ * An object that has a default locale and separate localalized versions.
+ */
+export interface Localizable<O extends LocaleObject> {
+    defaultLocale?: Locale;
+    locales?: Partial<Record<Locale, Partial<O>>>;
+}
+export declare type LanguageTag = "de-DE" | "en-AU" | "en-CA" | "en-GB" | "en-IN" | "en-US" | "es-419" | "es-ES" | "es-MX" | "fr-CA" | "fr-FR" | "it-IT" | "ja-JP" | "pt-BR" | "zh-CH" | "zh-HK" | "zh-TW";
+export declare type Language = "da" | "de" | "en" | "es" | "fr" | "it" | "ja" | "nl" | "no" | "pt" | "ru" | "sv" | "th" | "tr" | "uk" | "zh";
+/**
+ * The different kinds of locales that can be assigned in Stentor.
+ */
+export declare type Locale = LanguageTag | Language;

package/dist/utils/compiler/response.d.ts

@@ -0,0 +1,75 @@
+import { DateTime, DateTimeRange, Duration, DurationFormat, RequestSlotValues } from "./models";
+export declare enum ListDelimiter {
+    or = 0,
+    and = 1
+}
+/**
+ * Based on the provided slot value, it will return the appropriate <say-as> tag.
+ *
+ * {@link https://cloud.google.com/text-to-speech/docs/ssml#say%E2%80%91as}
+ * {@link https://developer.amazon.com/en-US/docs/alexa/custom-skills/speech-synthesis-markup-language-ssml-reference.html#say-as}
+ * {@link https://docs.aws.amazon.com/polly/latest/dg/supportedtags.html#say-as-tag}
+ *
+ * @param value
+ * @returns
+ */
+export declare function slotValueToSpeech(value: RequestSlotValues, type?: "ssml" | "displayText"): string;
+/**
+ * Determine if the request slot value is a DateTime
+ *
+ * @public
+ * @param slotValue - Slot value to check
+ */
+export declare function isDateTime(slotValue: RequestSlotValues): slotValue is DateTime;
+/**
+ * Determine if the request slot value is a DateTimeRange
+ *
+ * @public
+ * @param slotValue - Slot value to check
+ */
+export declare function isDateTimeRange(slotValue: RequestSlotValues): slotValue is DateTimeRange;
+/**
+ * Determine if the request slot value is a Duration
+ *
+ * @public
+ * @param slotValue - Slot value to check
+ */
+export declare function isDuration(slotValue: RequestSlotValues): slotValue is Duration;
+/**
+ * Converts a date time object to a string that can be used in either SSML or display text.
+ *
+ * @privateRemarks
+ * We will want to consider how we tackle localization of dates.  date-fns
+ * can handle it we just need to pass in the locale.  Additionally, when generating
+ * a response for display, we may want to support a short and long form.
+ *
+ * @beta
+ * @param value
+ * @param type
+ */
+export declare function dateTimeToSpeech(value: DateTime, type?: "ssml" | "displayText"): string;
+export declare function dateTimeRangeToSpeech(value: DateTimeRange, type?: "ssml" | "displayText"): string;
+export declare function durationToSpeech(duration: Duration, type?: "ssml" | "displayText"): string;
+/**
+ * Converts a date time object to a string.
+ *
+ * Either a single date (2020-07-19T23:59:59) or a range (2019-07-19T00:00:00 --> 2020-07-19T23:59:59).
+ *
+ * @param dateTime - Either DateTime or DateTimeRange to convert to a string
+ */
+export declare function dateTimeToString(dateTime: DateTime | DateTimeRange): string;
+export declare type DurationFormatToMSMultiplier = Record<DurationFormat, number>;
+/**
+ * Lookup table to convert a duration format to a multiplier that will convert it to milliseconds
+ */
+export declare const DURATION_FORMAT_TO_MS_MULTIPLIER: DurationFormatToMSMultiplier;
+/**
+ * Builds a speakable and readable list from a set of items.
+ *
+ * For example, ["one", "two", "three", "four"] will be transformed
+ * to "one, two, three or four".
+ *
+ * @param {string[]} items
+ * @param {ListisizeDelimiter} [delimiter]
+ */
+export declare function listisize(items: string[], preferredDelimiter?: ListDelimiter): string;

package/dist/utils/configurableMessages.d.ts

@@ -0,0 +1,8 @@
+import { WidgetConfigurableMessagesConfig } from "@xapp/stentor-chat-widget";
+export interface ConfigurableMessagesItems {
+    retry: number;
+    delay: number;
+    text: string;
+}
+export declare function getConfigurableMessages(): WidgetConfigurableMessagesConfig;
+export declare function getConfigurableMessagesConfig(messages: WidgetConfigurableMessagesConfig): ConfigurableMessagesItems[];

package/dist/utils/index.d.ts

@@ -7,3 +7,4 @@ export { default as insertSorted } from "./insertSorted";
 export * from "./nick-utils";
 export * from "./PersistentStorage";
 export * from "./useIsMounted";
+export * from "./retryRequest";

package/dist/utils/retryRequest.d.ts

@@ -0,0 +1,13 @@
+export declare class RetryOptions {
+    retries?: number;
+    timeout?: number;
+    log?: boolean;
+}
+export declare class RetryRequest {
+    private attempts;
+    private options;
+    private lastError;
+    constructor(options?: RetryOptions);
+    retry<T>(executor: Promise<T>): Promise<T>;
+    private log;
+}

package/dist/xapp/ChatServer.d.ts

@@ -1,4 +1,4 @@
-import { UserInfo } from "@xapp/stentor-chat-widget";
+import { UserInfo, WidgetConfigurableMessagesConfig } from "@xapp/stentor-chat-widget";
 import { ActionType } from "../store/ChatAction";
 import { ChatMessageRequest, ChatServerMessage } from "./ChatServerMessage";
 export interface ChatServer {
@@ -27,6 +27,7 @@ export interface ChatServer {
 export interface ChatServerOptions {
     readonly token?: string;
     readonly bot?: UserInfo;
+    readonly configurableMessages?: WidgetConfigurableMessagesConfig;
 }
 export interface OfflineMessage {
     readonly name: string;

package/dist/xapp/ChatServerMessage.d.ts

@@ -10,7 +10,7 @@ export interface ChatMessageRequest {
     /**
      * Type of message
      */
-    type: "rating" | "ratingRequest" | "comment" | "msg" | "custom" | "startTyping" | "stopTyping" | "userJoined" | "userLeft" | "handOff" | "handBack" | "permissionRequest" | "permissionGrant";
+    type: "rating" | "ratingRequest" | "comment" | "msg" | "failureMsg" | "custom" | "startTyping" | "stopTyping" | "userJoined" | "userLeft" | "handOff" | "handBack" | "permissionRequest" | "permissionGrant";
     timestamp: number;
     msg?: ChatServerMessage;
     /**

package/dist/xapp/StentorDirectChat.d.ts

@@ -13,6 +13,7 @@ export declare class StentorDirectChat implements ChatServer {
     private dispatch;
     private visitorInfo;
     private isNewSession;
+    private readonly configurableMessages;
     private readonly config;
     private readonly options;
     constructor(config: StentorDirectChatConfig, options?: ChatServerOptions);
@@ -23,6 +24,7 @@ export declare class StentorDirectChat implements ChatServer {
     private userJoined;
     private typing;
     private stopTyping;
+    private sendFailureMessage;
     sendOfflineMsg(_: OfflineMessage, cb: (error?: Error) => void): void;
     sendChatMsg(message: ChatServerMessage, cb: (err?: Error) => void): Promise<void>;
     private getBot;

package/package.json

@@ -1,11 +1,11 @@
 {
     "name": "@xapp/chat-widget",
-    "version": "1.38.1",
+    "version": "1.40.2",
     "description": "XAPP Chat Widget",
     "scripts": {
         "clean": "rm -rf ./lib/* && rm -rf ./dist/*",
         "lint": "eslint src/**/* --ext .ts,.tsx --fix",
-        "test": "jest",
+        "test": "jest --maxWorkers=50%",
         "prebuild": "tsc -d false",
         "build": "rollup -c",
         "start": "rollup -c -w && npm run prettier-watch",
@@ -38,75 +38,77 @@
     },
     "homepage": "https://github.com/XappMedia/chat-widget#readme",
     "devDependencies": {
-        "@babel/core": "7.16.5",
-        "@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",
-        "@storybook/addon-links": "6.4.9",
-        "@storybook/react": "6.4.9",
-        "@testing-library/jest-dom": "5.16.3",
-        "@types/enzyme": "3.10.11",
+        "@babel/core": "7.17.9",
+        "@rollup/plugin-commonjs": "21.1.0",
+        "@rollup/plugin-json": "4.1.0",
+        "@rollup/plugin-node-resolve": "13.2.1",
+        "@storybook/addon-actions": "6.4.22",
+        "@storybook/addon-essentials": "6.4.22",
+        "@storybook/addon-links": "6.4.22",
+        "@storybook/react": "6.4.22",
+        "@testing-library/jest-dom": "5.16.4",
+        "@types/enzyme": "3.10.12",
         "@types/enzyme-adapter-react-16": "1.0.6",
-        "@types/jest": "27.0.3",
-        "@types/react": "17.0.42",
-        "@types/react-redux": "7.1.23",
+        "@types/jest": "27.4.1",
+        "@types/react": "17.0.44",
+        "@types/react-redux": "7.1.24",
         "@types/react-transition-group": "4.4.4",
         "@types/socket.io-client": "1.4.36",
         "@types/store": "2.0.2",
-        "@typescript-eslint/eslint-plugin": "5.10.2",
-        "@typescript-eslint/parser": "5.10.2",
+        "@typescript-eslint/eslint-plugin": "5.20.0",
+        "@typescript-eslint/parser": "5.20.0",
         "babel-eslint": "10.1.0",
-        "babel-jest": "27.4.5",
-        "babel-loader": "8.2.3",
+        "babel-jest": "27.5.1",
+        "babel-loader": "8.2.5",
         "enzyme": "3.11.0",
         "enzyme-adapter-react-16": "1.15.6",
-        "eslint": "8.8.0",
+        "eslint": "8.14.0",
         "eslint-config-prettier": "7.2.0",
         "eslint-config-react-app": "6.0.0",
         "eslint-plugin-flowtype": "8.0.3",
-        "eslint-plugin-import": "2.25.4",
+        "eslint-plugin-import": "2.26.0",
         "eslint-plugin-jsx-a11y": "6.5.1",
-        "eslint-plugin-react": "7.27.1",
-        "eslint-plugin-react-hooks": "4.3.0",
-        "jest": "27.4.5",
-        "prettier": "2.4.1",
-        "react": "16.14.0",
-        "react-dom": "16.14.0",
-        "react-redux": "7.2.6",
-        "redux": "4.1.2",
+        "eslint-plugin-react": "7.29.4",
+        "eslint-plugin-react-hooks": "4.5.0",
+        "jest": "27.5.1",
+        "prettier": "2.6.2",
+        "react": "17.0.2",
+        "react-dom": "17.0.2",
+        "react-redux": "7.2.8",
+        "redux": "4.2.0",
         "redux-thunk": "2.4.1",
-        "rollup": "2.61.1",
+        "rollup": "2.70.2",
         "rollup-plugin-inject-process-env": "1.3.1",
         "rollup-plugin-peer-deps-external": "2.2.4",
         "rollup-plugin-scss": "3.0.0",
         "rollup-plugin-terser": "7.0.2",
         "rollup-plugin-typescript2": "0.31.2",
-        "sass": "1.45.0",
+        "sass": "1.50.1",
         "sass-loader": "10.2.1",
-        "stentor-models": "1.54.7",
-        "ts-jest": "27.1.3",
-        "typescript": "4.5.4"
+        "stentor-models": "1.55.10",
+        "ts-jest": "27.1.4",
+        "typescript": "4.6.3"
     },
     "files": [
         "dist"
     ],
     "peerDependencies": {
-        "react": "16.X",
-        "react-dom": "16.X",
+        "react": "17.X",
+        "react-dom": "17.X",
         "react-redux": "7.X",
         "redux": "4.X",
         "redux-thunk": "2.X",
         "stentor-models": "1.X"
     },
     "dependencies": {
-        "@rollup/plugin-replace": "^3.0.0",
-        "@xapp/chat-widget-core": "1.38.1",
-        "@xapp/stentor-chat-widget": "1.38.0",
+        "@rollup/plugin-replace": "^4.0.0",
+        "@xapp/chat-widget-core": "1.40.2",
+        "@xapp/stentor-chat-widget": "1.40.2",
+        "date-fns": "2.28.0",
         "react-transition-group": "4.4.2",
-        "socket.io-client": "4.4.0",
+        "socket.io-client": "4.4.1",
         "store": "2.0.12",
         "tslib": "2.3.1"
     },
-    "gitHead": "a3c3a5d4d0eddb1e45c6493d15e3cd38d5aeaf0c"
+    "gitHead": "c2add5f5b25f69959d08e5b6ffa7547d79c992e7"
 }