@meetelise/chat 1.55.2 → 1.56.0

package/dist/src/MyPubnub.d.ts

@@ -4,6 +4,7 @@ import LeadSourceClient from "./WebComponent/LeadSourceClient";
 import { WidgetType } from "./main/MEChat";
 import { BuildingWebchatView } from "./fetchBuildingWebchatView";
 import { LeadSourceMultitouchClient } from "./WebComponent/LeadSourceMultitouchClient";
+import { WebchatNavigation } from "./webchatNavigation";
 interface TokenResponse {
     auth: {
         result: {
@@ -18,7 +19,8 @@ interface TokenResponse {
 declare enum MessageType {
     noReply = "no-reply",
     text = "text",
-    media = "media"
+    media = "media",
+    navigation = "navigation"
 }
 interface RawPubnubMessage {
     channel: string;
@@ -31,6 +33,7 @@ interface RawPubnubMessage {
         order?: number;
         stream_id?: string;
         media?: ChatMediaFile[];
+        navigation?: unknown;
     };
     publisher: string;
     subscription: string;
@@ -58,12 +61,21 @@ export interface SimpleMediaChatMessage {
     isLeadMessage: boolean;
     type: SimpleMessageTypes.media;
 }
-export declare type SimpleChatMessage = SimpleTextChatMessage | SimpleMediaChatMessage;
+/** A "Take me to {label}" button the agent sends after a reply's text. */
+export interface SimpleNavigationChatMessage {
+    timestamp: number;
+    navigation: WebchatNavigation;
+    isLeadMessage: boolean;
+    type: SimpleMessageTypes.navigation;
+}
+export declare type SimpleChatMessage = SimpleTextChatMessage | SimpleMediaChatMessage | SimpleNavigationChatMessage;
 export declare const isSimpleTextChatMessage: (message: SimpleChatMessage) => message is SimpleTextChatMessage;
 export declare const isSimpleMediaChatMessage: (message: SimpleChatMessage) => message is SimpleMediaChatMessage;
+export declare const isSimpleNavigationChatMessage: (message: SimpleChatMessage) => message is SimpleNavigationChatMessage;
 export declare enum SimpleMessageTypes {
     text = "text",
-    media = "media"
+    media = "media",
+    navigation = "navigation"
 }
 declare class MyPubnub {
     private apiHost;
@@ -76,6 +88,19 @@ declare class MyPubnub {
     private isWaitingForStreamingMessages;
     private firedScheduledTourConfirmationIds;
     private widgetType;
+    /**
+     * Org-level webchat (`centralConvo: true`): the session is org-anchored, so it
+     * must come from /webchat/init and never from the per-lead v1 token fallback.
+     */
+    centralConvo: boolean;
+    /** The numeric id of the building the snippet names, sent as `declaredBuildingId`. */
+    declaredBuildingId: number | null;
+    /**
+     * The localStorage key the conversation (lead id) is saved under. It is the
+     * building slug, except in org-level webchat, where the conversation stays
+     * org-level even after the widget adopts the org's triage general building.
+     */
+    chatStorageSlug: string;
     pubnub: Pubnub | null;
     leadUserId: string;
     channel: string;
@@ -98,7 +123,17 @@ declare class MyPubnub {
         lead_id: string;
         channel: string;
         expires_in_seconds: number;
+        /**
+         * Org-level webchat only: the org's triage general building, which the
+         * widget then runs as.
+         */
+        building_slug?: string;
     } | null>;
+    /**
+     * Org-level webchat: run as the building /webchat/init resolved (the org's
+     * triage general building), so messages carry its id, slug and AI user.
+     */
+    adoptBuilding(buildingSlug: string, buildingDetails: BuildingWebchatView): void;
     private checkAndHandleDelayStreamingMessages;
     private isStreamComplete;
     private getStreamChunks;

package/dist/src/WebComponent/me-chat.d.ts

@@ -14,6 +14,18 @@ export declare class MEChat extends LitElement {
     private buildingSlug;
     private orgSlug;
     private centralConvo;
+    /**
+     * Org-level webchat only: the building the snippet names (`building` in
+     * `MEChat.start`). It doesn't change config or the conversation, which stay
+     * org-anchored; its id is sent with visitor messages as `declaredBuildingId`.
+     */
+    private declaredBuildingSlug;
+    /**
+     * Org-level webchat (`centralConvo` started without a building). Stays true
+     * after the widget adopts the org's triage general building from
+     * /webchat/init, which sets `buildingSlug`.
+     */
+    private orgLevel;
     launcherStyles: StyleInfo;
     mobileStyles: StyleInfo;
     isMinimized: boolean;
@@ -62,6 +74,27 @@ export declare class MEChat extends LitElement {
     private setupWebchat;
     setBuildingDerivedInfo: () => Promise<void>;
     private initializeChatVariables;
+    /**
+     * Org-level webchat with no building: config comes from the org, and there is
+     * no building slug for the per-building endpoints.
+     */
+    private isOrgMode;
+    /** Where the conversation is saved: org-level webchat keeps one per org. */
+    private chatStorageSlug;
+    /**
+     * Org-level webchat: /webchat/init chose the org's triage general building,
+     * so run as a widget for that building from here on (its config, and its
+     * slug for the per-building endpoints). The conversation stays the org-level
+     * one /webchat/init returned. If its config can't be loaded, stay in org mode.
+     */
+    private adoptBuilding;
+    /**
+     * Org-level webchat offers no Email or Text Us, and offers Call Us only with
+     * its building's number (the org's triage line).
+     */
+    private withOrgLevelContactOptions;
+    /** The numeric id of the snippet's building in org-level webchat, if it names one. */
+    private fetchDeclaredBuildingId;
     private shouldAutoOpenChat;
     private handleChatInitializeAnalytics;
     restartConversation(): Promise<void>;

package/dist/src/WebComponent/pubnub-chat.d.ts

@@ -2,6 +2,7 @@ import { LitElement, TemplateResult } from "lit";
 import MyPubnub, { SimpleChatMessage } from "../MyPubnub";
 import "./pubnub-message";
 import "./pubnub-media";
+import "./pubnub-navigation";
 import { WidgetType } from "../main/MEChat";
 import { BuildingWebchatView } from "../fetchBuildingWebchatView";
 export declare class PubnubChat extends LitElement {
@@ -17,6 +18,8 @@ export declare class PubnubChat extends LitElement {
     myPubnub: MyPubnub | undefined;
     orgSlug: string | undefined;
     buildingSlug: string | undefined;
+    /** Org-level webchat, which has no building slug. */
+    centralConvo: boolean;
     widgetType: WidgetType;
     building: BuildingWebchatView | undefined;
     primaryColor: string;

package/dist/src/WebComponent/pubnub-navigation.d.ts

@@ -0,0 +1,17 @@
+import { LitElement, TemplateResult } from "lit";
+import { SimpleNavigationChatMessage } from "../MyPubnub";
+/** The "Take me to {label}" button the agent sends after a reply. */
+export declare class PubnubNavigation extends LitElement {
+    static styles: import("lit").CSSResult[];
+    message: SimpleNavigationChatMessage | undefined;
+    onMount: () => void;
+    /** Overridable in tests; navigates the same tab by default. */
+    navigate: (url: string) => void;
+    updated(): void;
+    render(): TemplateResult;
+}
+declare global {
+    interface HTMLElementTagNameMap {
+        "pubnub-navigation": PubnubNavigation;
+    }
+}

package/dist/src/webchatNavigation.d.ts

@@ -0,0 +1,38 @@
+/**
+ * Org-level webchat navigation: the page context the widget sends with each
+ * visitor message, the "Take me there" navigation the agent can send back, and
+ * the per-tab flag that keeps the chat open across the page load that follows.
+ *
+ * The backend only acts on these for orgs in the org-level webchat rollout, so
+ * for every other customer the extra message fields are ignored.
+ */
+export interface WebchatNavigation {
+    url: string;
+    label: string;
+}
+export interface WebchatPageContext {
+    pageUrl: string;
+    pageTitle: string;
+    declaredBuildingId?: number;
+}
+/** sessionStorage key, so the flag is per tab and gone when the tab closes. */
+export declare const REOPEN_CHAT_AFTER_NAVIGATION_KEY = "com.elise.webchat.reopenAfterNavigation";
+/**
+ * Read a navigation from a PubNub message's `navigation` field.
+ * Returns null unless it has an http(s) url and a non-empty label, so a
+ * malformed or unsafe (e.g. `javascript:`) url is never rendered.
+ */
+export declare const parseWebchatNavigation: (raw: unknown) => WebchatNavigation | null;
+/**
+ * A page's address without its query string or fragment, which can carry a
+ * visitor's details (an email in a link, ad click ids) and aren't needed to
+ * tell which page they are on.
+ */
+export declare const pageAddress: (href: string) => string;
+/** The visitor's current page, sent with each visitor message. */
+export declare const getWebchatPageContext: (declaredBuildingId?: number | null) => WebchatPageContext;
+export declare const markReopenChatAfterNavigation: () => void;
+/** Whether the last page load came from a "Take me there" click. Clears the flag. */
+export declare const consumeReopenChatAfterNavigation: () => boolean;
+/** Same-tab navigation, after which the chat reopens on the new page. */
+export declare const takeMeThere: (navigation: WebchatNavigation, assign?: (url: string) => void) => void;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@meetelise/chat",
-  "version": "1.55.2",
+  "version": "1.56.0",
   "description": "",
   "keywords": [],
   "homepage": "https://github.com/MeetElise/chat-ui#readme",