@guidelytech/guide-runtime 0.5.0 → 0.6.2

package/dist/messenger.d.cts

@@ -1,4 +1,4 @@
-import { MessengerConversation, ConversationMessagesResponse, MessengerMessage, SdkArticlesResponse, ResourceCenterArticle, MessengerConfig, ResourceCenterConfig } from '@guidelytech/shared';
+import { MessengerConversation, ConversationMessagesResponse, MessengerMessage, SdkArticlesResponse, ResourceCenterArticle, SdkHowTosResponse, SdkHowTo, MessengerPageContent, MessengerConfig, ResourceCenterConfig } from '@guidelytech/shared';
 import { H as HelpGuideRef } from './help-view-B4oPbhpO.cjs';
 
 /** Callbacks the transport invokes while a message is sent and Scout replies. */
@@ -21,8 +21,52 @@ interface MessengerApi {
     listArticles(): Promise<SdkArticlesResponse>;
     getArticle(id: string): Promise<ResourceCenterArticle | null>;
     searchArticles(q: string): Promise<ResourceCenterArticle[]>;
+    /** How-tos available in the app, and the ones for the page the user is on (optional: older transports). */
+    listHowTos?(): Promise<SdkHowTosResponse>;
+    getHowTo?(id: string): Promise<SdkHowTo | null>;
+    /** Page-matched how-tos, articles and common questions (servers before the personalised home lack it). */
+    pageContent?(path: string): Promise<MessengerPageContent>;
+}
+type MessengerTab = "home" | "messages" | "help" | "news";
+/** A guide the visitor started and didn't finish. */
+interface MessengerResumeGuide {
+    id: string;
+    name: string;
+    stepId: string;
+    /** Zero-based index of the step they reached. */
+    stepIndex: number;
+    stepCount: number;
+}
+interface MessengerChecklistProgress {
+    id: string;
+    name: string;
+    done: number;
+    total: number;
+    /** Title of the first unfinished task. */
+    nextTask: string | null;
+}
+/** A live announcement, shown on Home and in the News tab. */
+interface MessengerNewsItem {
+    id: string;
+    key: string;
+    title: string;
+    /** Plain text. */
+    body: string;
+    imageUrl: string | null;
+    publishedAt: string;
+    unread: boolean;
+}
+/** What the SDK knows about the visitor right now, read each time the messenger renders. */
+interface MessengerVisitor {
+    firstName: string | null;
+    /** Current page path (no query or fragment); null when unknown. */
+    path: string | null;
+    /** Live guides targeted at this page that the visitor can start. */
+    pageGuides: HelpGuideRef[];
+    resumeGuide: MessengerResumeGuide | null;
+    checklist: MessengerChecklistProgress | null;
+    news: MessengerNewsItem[];
 }
-type MessengerTab = "home" | "messages" | "help";
 interface MessengerOptions {
     scope: HTMLElement;
     config: MessengerConfig;
@@ -38,6 +82,16 @@ interface MessengerOptions {
     onOpen?: () => void;
     onClose?: () => void;
     onMessage?: (message: MessengerMessage, conversation: MessengerConversation) => void;
+    /** Personalisation: name, page, progress and announcements. Without it the home screen is generic. */
+    visitor?: () => MessengerVisitor;
+    /** Logo and name shown at the top of the home screen (project theme). */
+    brand?: {
+        logoUrl?: string | null;
+        name?: string | null;
+    };
+    onResumeGuide?: (guideId: string, stepId: string) => void;
+    /** The visitor saw these announcements (News tab opened). */
+    onNewsSeen?: (ids: string[]) => void;
     hideLauncher?: boolean;
     /** Poll intervals (ms): open thread, and unread badge while closed. */
     pollMs?: {
@@ -54,10 +108,14 @@ interface MessengerWidget {
     /** Opens a new conversation, optionally pre-filling the composer. */
     showNewMessage(text?: string): void;
     openArticle(id: string): void;
+    /** Re-reads the visitor (page changed, progress made) and re-renders what is showing. */
+    refresh(): void;
     destroy(): void;
 }
+/** The greeting with a leading "Hi!" swapped for the visitor's name ("Hi! I'm Scout." → "Hi Maya! I'm Scout."). */
+declare function personalGreeting(greeting: string, firstName: string | null): string;
 declare function relativeTime(iso: string, now?: number): string;
 /** Intercom-style messenger: launcher + panel with Home, Messages (chat with Scout / the team) and Help tabs. */
 declare function renderMessenger(options: MessengerOptions): MessengerWidget;
 
-export { type MessengerApi, type MessengerOptions, type MessengerStreamHandlers, type MessengerTab, type MessengerWidget, relativeTime, renderMessenger };
+export { type MessengerApi, type MessengerChecklistProgress, type MessengerNewsItem, type MessengerOptions, type MessengerResumeGuide, type MessengerStreamHandlers, type MessengerTab, type MessengerVisitor, type MessengerWidget, personalGreeting, relativeTime, renderMessenger };

package/dist/messenger.d.ts

@@ -1,4 +1,4 @@
-import { MessengerConversation, ConversationMessagesResponse, MessengerMessage, SdkArticlesResponse, ResourceCenterArticle, MessengerConfig, ResourceCenterConfig } from '@guidelytech/shared';
+import { MessengerConversation, ConversationMessagesResponse, MessengerMessage, SdkArticlesResponse, ResourceCenterArticle, SdkHowTosResponse, SdkHowTo, MessengerPageContent, MessengerConfig, ResourceCenterConfig } from '@guidelytech/shared';
 import { H as HelpGuideRef } from './help-view-B4oPbhpO.js';
 
 /** Callbacks the transport invokes while a message is sent and Scout replies. */
@@ -21,8 +21,52 @@ interface MessengerApi {
     listArticles(): Promise<SdkArticlesResponse>;
     getArticle(id: string): Promise<ResourceCenterArticle | null>;
     searchArticles(q: string): Promise<ResourceCenterArticle[]>;
+    /** How-tos available in the app, and the ones for the page the user is on (optional: older transports). */
+    listHowTos?(): Promise<SdkHowTosResponse>;
+    getHowTo?(id: string): Promise<SdkHowTo | null>;
+    /** Page-matched how-tos, articles and common questions (servers before the personalised home lack it). */
+    pageContent?(path: string): Promise<MessengerPageContent>;
+}
+type MessengerTab = "home" | "messages" | "help" | "news";
+/** A guide the visitor started and didn't finish. */
+interface MessengerResumeGuide {
+    id: string;
+    name: string;
+    stepId: string;
+    /** Zero-based index of the step they reached. */
+    stepIndex: number;
+    stepCount: number;
+}
+interface MessengerChecklistProgress {
+    id: string;
+    name: string;
+    done: number;
+    total: number;
+    /** Title of the first unfinished task. */
+    nextTask: string | null;
+}
+/** A live announcement, shown on Home and in the News tab. */
+interface MessengerNewsItem {
+    id: string;
+    key: string;
+    title: string;
+    /** Plain text. */
+    body: string;
+    imageUrl: string | null;
+    publishedAt: string;
+    unread: boolean;
+}
+/** What the SDK knows about the visitor right now, read each time the messenger renders. */
+interface MessengerVisitor {
+    firstName: string | null;
+    /** Current page path (no query or fragment); null when unknown. */
+    path: string | null;
+    /** Live guides targeted at this page that the visitor can start. */
+    pageGuides: HelpGuideRef[];
+    resumeGuide: MessengerResumeGuide | null;
+    checklist: MessengerChecklistProgress | null;
+    news: MessengerNewsItem[];
 }
-type MessengerTab = "home" | "messages" | "help";
 interface MessengerOptions {
     scope: HTMLElement;
     config: MessengerConfig;
@@ -38,6 +82,16 @@ interface MessengerOptions {
     onOpen?: () => void;
     onClose?: () => void;
     onMessage?: (message: MessengerMessage, conversation: MessengerConversation) => void;
+    /** Personalisation: name, page, progress and announcements. Without it the home screen is generic. */
+    visitor?: () => MessengerVisitor;
+    /** Logo and name shown at the top of the home screen (project theme). */
+    brand?: {
+        logoUrl?: string | null;
+        name?: string | null;
+    };
+    onResumeGuide?: (guideId: string, stepId: string) => void;
+    /** The visitor saw these announcements (News tab opened). */
+    onNewsSeen?: (ids: string[]) => void;
     hideLauncher?: boolean;
     /** Poll intervals (ms): open thread, and unread badge while closed. */
     pollMs?: {
@@ -54,10 +108,14 @@ interface MessengerWidget {
     /** Opens a new conversation, optionally pre-filling the composer. */
     showNewMessage(text?: string): void;
     openArticle(id: string): void;
+    /** Re-reads the visitor (page changed, progress made) and re-renders what is showing. */
+    refresh(): void;
     destroy(): void;
 }
+/** The greeting with a leading "Hi!" swapped for the visitor's name ("Hi! I'm Scout." → "Hi Maya! I'm Scout."). */
+declare function personalGreeting(greeting: string, firstName: string | null): string;
 declare function relativeTime(iso: string, now?: number): string;
 /** Intercom-style messenger: launcher + panel with Home, Messages (chat with Scout / the team) and Help tabs. */
 declare function renderMessenger(options: MessengerOptions): MessengerWidget;
 
-export { type MessengerApi, type MessengerOptions, type MessengerStreamHandlers, type MessengerTab, type MessengerWidget, relativeTime, renderMessenger };
+export { type MessengerApi, type MessengerChecklistProgress, type MessengerNewsItem, type MessengerOptions, type MessengerResumeGuide, type MessengerStreamHandlers, type MessengerTab, type MessengerVisitor, type MessengerWidget, personalGreeting, relativeTime, renderMessenger };