@guidelytech/guide-runtime 0.8.0 → 0.10.0

package/dist/messenger.d.cts

@@ -1,6 +1,20 @@
-import { MessengerConversation, ConversationMessagesResponse, MessengerMessage, SdkArticlesResponse, ResourceCenterArticle, SdkHowTosResponse, SdkHowTo, MessengerPageContent, MessengerConfig, ResourceCenterConfig } from '@guidelytech/shared';
+import { MessengerConversation, ConversationMessagesResponse, MessengerMessage, SdkArticlesResponse, ResourceCenterArticle, SdkHowTosResponse, SdkHowTo, MessengerPageContent, FileComplaintResponse, MessengerConfig, ResourceCenterConfig } from '@guidelytech/shared';
 import { H as HelpGuideRef } from './help-view-B4oPbhpO.cjs';
 
+/** What the messenger sends to file a complaint (the transport adds the visitor and page). */
+interface ComplaintInput {
+    categoryId: string;
+    description: string;
+    answers: Record<string, string>;
+    email?: string | null;
+    /** File it in this conversation (Scout offered the form there). */
+    conversationId?: string | null;
+    attachment?: {
+        fileName: string;
+        data: string;
+    } | null;
+}
+
 /** Callbacks the transport invokes while a message is sent and Scout replies. */
 interface MessengerStreamHandlers {
     /** A new conversation was created (first message only). */
@@ -26,6 +40,8 @@ interface MessengerApi {
     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>;
+    /** Files a complaint (transports before complaints lack it; the messenger then hides the form). */
+    fileComplaint?(input: ComplaintInput): Promise<FileComplaintResponse>;
 }
 type MessengerTab = "home" | "messages" | "help" | "news";
 /** A guide the visitor started and didn't finish. */
@@ -59,6 +75,8 @@ interface MessengerNewsItem {
 /** What the SDK knows about the visitor right now, read each time the messenger renders. */
 interface MessengerVisitor {
     firstName: string | null;
+    /** The app identified the visitor (`identify()`); false for anonymous visitors. Unknown counts as identified. */
+    identified?: boolean;
     /** Current page path (no query or fragment); null when unknown. */
     path: string | null;
     /** Live guides targeted at this page that the visitor can start. */
@@ -108,6 +126,8 @@ interface MessengerWidget {
     /** Opens a new conversation, optionally pre-filling the composer. */
     showNewMessage(text?: string): void;
     openArticle(id: string): void;
+    /** Opens the complaint form, optionally with a category picked (when the project takes complaints). */
+    openComplaint(categoryId?: string): void;
     /** Re-reads the visitor (page changed, progress made) and re-renders what is showing. */
     refresh(): void;
     destroy(): void;

package/dist/messenger.d.ts

@@ -1,6 +1,20 @@
-import { MessengerConversation, ConversationMessagesResponse, MessengerMessage, SdkArticlesResponse, ResourceCenterArticle, SdkHowTosResponse, SdkHowTo, MessengerPageContent, MessengerConfig, ResourceCenterConfig } from '@guidelytech/shared';
+import { MessengerConversation, ConversationMessagesResponse, MessengerMessage, SdkArticlesResponse, ResourceCenterArticle, SdkHowTosResponse, SdkHowTo, MessengerPageContent, FileComplaintResponse, MessengerConfig, ResourceCenterConfig } from '@guidelytech/shared';
 import { H as HelpGuideRef } from './help-view-B4oPbhpO.js';
 
+/** What the messenger sends to file a complaint (the transport adds the visitor and page). */
+interface ComplaintInput {
+    categoryId: string;
+    description: string;
+    answers: Record<string, string>;
+    email?: string | null;
+    /** File it in this conversation (Scout offered the form there). */
+    conversationId?: string | null;
+    attachment?: {
+        fileName: string;
+        data: string;
+    } | null;
+}
+
 /** Callbacks the transport invokes while a message is sent and Scout replies. */
 interface MessengerStreamHandlers {
     /** A new conversation was created (first message only). */
@@ -26,6 +40,8 @@ interface MessengerApi {
     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>;
+    /** Files a complaint (transports before complaints lack it; the messenger then hides the form). */
+    fileComplaint?(input: ComplaintInput): Promise<FileComplaintResponse>;
 }
 type MessengerTab = "home" | "messages" | "help" | "news";
 /** A guide the visitor started and didn't finish. */
@@ -59,6 +75,8 @@ interface MessengerNewsItem {
 /** What the SDK knows about the visitor right now, read each time the messenger renders. */
 interface MessengerVisitor {
     firstName: string | null;
+    /** The app identified the visitor (`identify()`); false for anonymous visitors. Unknown counts as identified. */
+    identified?: boolean;
     /** Current page path (no query or fragment); null when unknown. */
     path: string | null;
     /** Live guides targeted at this page that the visitor can start. */
@@ -108,6 +126,8 @@ interface MessengerWidget {
     /** Opens a new conversation, optionally pre-filling the composer. */
     showNewMessage(text?: string): void;
     openArticle(id: string): void;
+    /** Opens the complaint form, optionally with a category picked (when the project takes complaints). */
+    openComplaint(categoryId?: string): void;
     /** Re-reads the visitor (page changed, progress made) and re-renders what is showing. */
     refresh(): void;
     destroy(): void;