@xapp/stentor-chat-widget 1.50.0 → 1.52.0

package/lib/UserInfo.d.ts

@@ -1,5 +1,25 @@
+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;
+}
 export interface UserInfo {
+    /**
+     * URL to the user's avatar.
+     */
     readonly avatarPath?: string;
     readonly nick: string;
+    /**
+     * Display name
+     */
     readonly displayName?: string;
 }

package/lib/WidgetEnv.d.ts

@@ -1,6 +1,7 @@
 /*! Copyright (c) 2021, XAPPmedia */
 import { Response } from "stentor-models";
 import { WidgetTheme } from "./WidgetTheme";
+import { ChatUserInfo } from "./UserInfo";
 export interface CtaConfig {
     readonly message: string;
     readonly timeout: number;
@@ -54,6 +55,11 @@ export interface WidgetEnv extends WidgetEnvDeprecated {
      * The avatar URL
      */
     readonly avatarUrl?: string;
+    /**
+     * Optional default agent information.
+     * @beta
+     */
+    readonly agent?: ChatUserInfo;
     /**
      * Optional ID that will be used for the user.  If not prevent
      */
@@ -187,9 +193,12 @@ 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.
@@ -203,7 +212,13 @@ export interface WidgetMenuConfig {
      * 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 {
@@ -221,6 +236,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;

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.50.0",
+    "version": "1.52.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": "9c2936860632f34f43a7149343466e6e22c69138"
+    "gitHead": "17f4054da7560f3054cf84b9f3e7f2dc5c491acf"
 }