@xapp/stentor-chat-widget 1.49.5 → 1.51.0

package/lib/WidgetEnv.d.ts

@@ -1,4 +1,5 @@
 /*! Copyright (c) 2021, XAPPmedia */
+import { Response } from "stentor-models";
 import { WidgetTheme } from "./WidgetTheme";
 export interface CtaConfig {
     readonly message: string;
@@ -87,21 +88,46 @@ export interface WidgetEnv extends WidgetEnvDeprecated {
      */
     readonly theme?: WidgetTheme;
     /**
-     *
+     * Optional configurable message that appears
      */
     readonly cta?: CtaConfig;
+    /**
+     * Optional, configure the chat button tab index
+     */
     readonly chatButton?: WidgetChatButtonConfig;
+    /**
+     * Optional, custom header configuration including messages for the widget.
+     */
     readonly header?: WidgetHeaderConfig;
+    /**
+     * Optional, configure aspects of the footer.
+     */
     readonly footer?: WidgetFooterConfig;
+    /**
+     * Optional menu configuration, add items and configure location of toggle button.
+     */
     readonly menu?: WidgetMenuConfig;
+    /**
+     * Configure input field
+     */
     readonly input?: WidgetInputConfig;
     /**
      * When set, the widget will automatically open when the screen width is wider than what is provided.  This is useful if you want to open
      * on desktop widths automatically but not on mobile.
      */
     readonly autoOpenOnWidth?: string;
+    /**
+     * Configure how the URLs within suggestion chips, markdown and list items are opened.  You can choose same window, new window or new tab.
+     */
     readonly urls?: WidgetUrlsConfig;
+    /**
+     * Configurable error messages.
+     */
     readonly configurableMessages?: WidgetConfigurableMessagesConfig;
+    /**
+     * Optional set of hooks to register with the widget to receive events.
+     */
+    readonly hooks?: WidgetHooks;
 }
 export interface WidgetConfigurableMessagesConfig {
     readonly items?: WidgetConfigurableMessageConfig[];
@@ -157,12 +183,37 @@ export interface WidgetFooterConfig {
     readonly sendButton?: WidgetSendButtonConfig;
 }
 export interface WidgetBrandingConfig {
+    /**
+     * Enable display of the branding text
+     */
     readonly enabled?: boolean;
+    /**
+     * Configurable text for the branding
+     */
     readonly text?: string;
 }
-export declare type WidgetMenuItems = WidgetMenuItemConfig | WidgetMenuItemStaticImage | WidgetMenuItemStaticText;
+export declare type WidgetMenuItems = WidgetMenuItemConfig | WidgetMenuItemStaticImage | WidgetMenuItemStaticText | WidgetMenuItemOpenURL;
 export interface WidgetMenuConfig {
+    /**
+     * Set the location for the menu button.
+     *
+     * Defaults to "FOOTER" with a two bar icon.
+     *
+     * If set to "HEADER_LEFT" then the menu button will display in the header left position with a three bar icon.
+     */
+    readonly menuButtonLocation?: "HEADER_LEFT" | "FOOTER";
+    /**
+     * Menu items to be displayed.
+     */
     readonly items: readonly WidgetMenuItems[];
+    /**
+     * Tab index for menu items.
+     */
+    readonly itemsTabIndex?: string;
+    /**
+     * Menu button configuration
+     */
+    readonly button?: WidgetMenuButtonConfig;
 }
 export interface WidgetInputConfig {
     readonly placeholder?: string;
@@ -179,6 +230,20 @@ export interface WidgetMenuItemStaticText {
     readonly title: string;
     readonly body: string;
 }
+export interface WidgetMenuItemOpenURL {
+    /**
+     * URL to be opened
+     */
+    readonly url: string;
+    /**
+     * Display label for the URL
+     */
+    readonly text: string;
+    /**
+     * How the URL opens, defaults to defined behavior on URL opening config.
+     */
+    readonly behavior?: WidgetUrlBehavior;
+}
 export interface WidgetHeaderSubtitleConfig {
     readonly enabled?: boolean;
     readonly text?: string;
@@ -196,3 +261,16 @@ export interface WidgetChatButtonConfig {
 export interface WidgetClearButtonConfig {
     readonly tabIndex?: string;
 }
+export interface WidgetMenuButtonConfig {
+    readonly tabIndex?: string;
+}
+export interface WidgetHooks {
+    /**
+     * Optional callback when a response is received.
+     *
+     * This can be used to parse any part of the message, including additional instructions included in the response.data field.
+     *
+     * @param response
+     */
+    onResponse?(response: Response): void;
+}

package/lib/guards.d.ts

@@ -1,4 +1,5 @@
-import { WidgetMenuItems, WidgetMenuItemConfig, WidgetMenuItemStaticImage, WidgetMenuItemStaticText } from "./WidgetEnv";
+import { WidgetMenuItems, WidgetMenuItemConfig, WidgetMenuItemStaticImage, WidgetMenuItemStaticText, WidgetMenuItemOpenURL } from "./WidgetEnv";
 export declare function isStaticImageMenuItem(item: WidgetMenuItems): item is WidgetMenuItemStaticImage;
 export declare function isStaticTextMenuItem(item: WidgetMenuItems): item is WidgetMenuItemStaticText;
 export declare function isStandardMenuItem(item: WidgetMenuItems): item is WidgetMenuItemConfig;
+export declare function isOpenURLMenuItem(item: WidgetMenuItems): item is WidgetMenuItemOpenURL;

package/lib/guards.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isStandardMenuItem = exports.isStaticTextMenuItem = exports.isStaticImageMenuItem = void 0;
+exports.isOpenURLMenuItem = exports.isStandardMenuItem = exports.isStaticTextMenuItem = exports.isStaticImageMenuItem = void 0;
 function isStaticImageMenuItem(item) {
     return !!item && !!item.imageUrl;
 }
@@ -13,4 +13,8 @@ function isStandardMenuItem(item) {
     return !!item && !!item.label;
 }
 exports.isStandardMenuItem = isStandardMenuItem;
+function isOpenURLMenuItem(item) {
+    return !!item && !!item.url;
+}
+exports.isOpenURLMenuItem = isOpenURLMenuItem;
 //# sourceMappingURL=guards.js.map

package/lib/guards.js.map

@@ -1 +1 @@
-{"version":3,"file":"guards.js","sourceRoot":"","sources":["../src/guards.ts"],"names":[],"mappings":";;;AAEA,SAAgB,qBAAqB,CAAC,IAAqB;IACvD,OAAO,CAAC,CAAC,IAAI,IAAI,CAAC,CAAE,IAAkC,CAAC,QAAQ,CAAC;AACpE,CAAC;AAFD,sDAEC;AAED,SAAgB,oBAAoB,CAAC,IAAqB;IACtD,OAAO,CAAC,CAAC,IAAI,IAAI,CAAC,CAAE,IAAiC,CAAC,IAAI,CAAC;AAC/D,CAAC;AAFD,oDAEC;AAED,SAAgB,kBAAkB,CAAC,IAAqB;IACpD,OAAO,CAAC,CAAC,IAAI,IAAI,CAAC,CAAE,IAA6B,CAAC,KAAK,CAAC;AAC5D,CAAC;AAFD,gDAEC"}
+{"version":3,"file":"guards.js","sourceRoot":"","sources":["../src/guards.ts"],"names":[],"mappings":";;;AAEA,SAAgB,qBAAqB,CAAC,IAAqB;IACvD,OAAO,CAAC,CAAC,IAAI,IAAI,CAAC,CAAE,IAAkC,CAAC,QAAQ,CAAC;AACpE,CAAC;AAFD,sDAEC;AAED,SAAgB,oBAAoB,CAAC,IAAqB;IACtD,OAAO,CAAC,CAAC,IAAI,IAAI,CAAC,CAAE,IAAiC,CAAC,IAAI,CAAC;AAC/D,CAAC;AAFD,oDAEC;AAED,SAAgB,kBAAkB,CAAC,IAAqB;IACpD,OAAO,CAAC,CAAC,IAAI,IAAI,CAAC,CAAE,IAA6B,CAAC,KAAK,CAAC;AAC5D,CAAC;AAFD,gDAEC;AAED,SAAgB,iBAAiB,CAAC,IAAqB;IACnD,OAAO,CAAC,CAAC,IAAI,IAAI,CAAC,CAAE,IAA8B,CAAC,GAAG,CAAC;AAC3D,CAAC;AAFD,8CAEC"}

package/package.json

@@ -4,7 +4,7 @@
     "publishConfig": {
         "access": "public"
     },
-    "version": "1.49.5",
+    "version": "1.51.0",
     "description": "Chat Widget channel for stentor",
     "types": "lib/index",
     "main": "lib/index",
@@ -38,5 +38,5 @@
         "build": "tsc -d true -p .",
         "clean": "rm -rf ./lib/*"
     },
-    "gitHead": "737dcd08d0a289b006a41825a9016eb4c19f1f2e"
+    "gitHead": "d314fdeeef894c66ae6bcf577762374934d93028"
 }