@guidelytech/guide-runtime 0.10.0 → 0.12.0

package/dist/messenger.d.cts

@@ -1,4 +1,4 @@
-import { MessengerConversation, ConversationMessagesResponse, MessengerMessage, SdkArticlesResponse, ResourceCenterArticle, SdkHowTosResponse, SdkHowTo, MessengerPageContent, FileComplaintResponse, MessengerConfig, ResourceCenterConfig } from '@guidelytech/shared';
+import { FeedbackPriority, FeedbackStatus, PublicFeedbackList, PublicFeedbackRequestDetail, PublicFeedbackRequest, FeedbackUpdatesResponse, MessengerConversation, ConversationMessagesResponse, MessengerMessage, SdkArticlesResponse, ResourceCenterArticle, SdkHowTosResponse, SdkHowTo, MessengerPageContent, FileComplaintResponse, MessengerConfig, ResourceCenterConfig, RuleGroup } 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). */
@@ -15,6 +15,56 @@ interface ComplaintInput {
     } | null;
 }
 
+type IdeaSort = "top" | "new" | "trending";
+type IdeaFilter = "open" | "all" | "mine" | "following";
+/** What the Ideas tab asks for (the transport adds the visitor). */
+interface IdeaListQuery {
+    q?: string;
+    sort: IdeaSort;
+    filter: IdeaFilter;
+    status?: FeedbackStatus;
+    productArea?: string;
+    page: number;
+}
+/** A new idea (the transport adds the visitor and the page). */
+interface IdeaInput {
+    title: string;
+    description: string;
+    productArea?: string | null;
+    priority: FeedbackPriority;
+    /** Suggested from this Scout conversation (Scout offered it). */
+    conversationId?: string | null;
+}
+interface IdeaVoteInput {
+    priority: FeedbackPriority;
+    note?: string;
+    conversationId?: string | null;
+}
+/** Server access for the Ideas tab. Every method is optional: transports before Ideas lack them. */
+interface IdeasApi {
+    listIdeas?(query: IdeaListQuery): Promise<PublicFeedbackList>;
+    /** Reads one idea with its comments (and counts the view). */
+    getIdea?(id: string): Promise<PublicFeedbackRequestDetail>;
+    submitIdea?(input: IdeaInput): Promise<PublicFeedbackRequestDetail>;
+    voteIdea?(id: string, vote: IdeaVoteInput): Promise<PublicFeedbackRequest>;
+    unvoteIdea?(id: string): Promise<PublicFeedbackRequest>;
+    followIdea?(id: string, follow: boolean): Promise<PublicFeedbackRequest>;
+    commentIdea?(id: string, body: string): Promise<PublicFeedbackRequestDetail>;
+    similarIdeas?(title: string): Promise<PublicFeedbackRequest[]>;
+    ideaUpdates?(): Promise<FeedbackUpdatesResponse>;
+    markIdeaUpdatesRead?(ids?: string[]): Promise<FeedbackUpdatesResponse>;
+    /** A short-lived link into the hosted feedback portal. */
+    ideaPortalLink?(): Promise<string>;
+}
+
+/** Where the visitor left the launcher. `y`: 0 = the default bottom spot, 1 = as high as it goes. */
+interface LauncherSpot {
+    side: "left" | "right";
+    y: number;
+}
+/** Reads a stored spot, ignoring anything malformed. */
+declare function parseLauncherSpot(raw: unknown): LauncherSpot | null;
+
 /** Callbacks the transport invokes while a message is sent and Scout replies. */
 interface MessengerStreamHandlers {
     /** A new conversation was created (first message only). */
@@ -24,8 +74,9 @@ interface MessengerStreamHandlers {
     onDone(message: MessengerMessage | null, conversation: MessengerConversation): void;
     onError(message: string): void;
 }
-/** Server access for the messenger; implemented by sdk-core over the public SDK API. */
-interface MessengerApi {
+
+/** Server access for the messenger; implemented by sdk-core over the public SDK API. The Ideas methods ({@link IdeasApi}) are optional. */
+interface MessengerApi extends IdeasApi {
     listConversations(): Promise<MessengerConversation[]>;
     loadMessages(conversationId: string, since?: string | null): Promise<ConversationMessagesResponse>;
     start(text: string, handlers: MessengerStreamHandlers): Promise<void>;
@@ -43,7 +94,7 @@ interface MessengerApi {
     /** 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";
+type MessengerTab = "home" | "messages" | "help" | "ideas" | "news";
 /** A guide the visitor started and didn't finish. */
 interface MessengerResumeGuide {
     id: string;
@@ -71,6 +122,9 @@ interface MessengerNewsItem {
     imageUrl: string | null;
     publishedAt: string;
     unread: boolean;
+    /** Resource-center "What's new" entries: open this help article, or this link, instead of starting a guide. */
+    articleId?: string | null;
+    url?: string | null;
 }
 /** What the SDK knows about the visitor right now, read each time the messenger renders. */
 interface MessengerVisitor {
@@ -108,9 +162,15 @@ interface MessengerOptions {
         name?: string | null;
     };
     onResumeGuide?: (guideId: string, stepId: string) => void;
+    /** Evaluates a resource-center section's targeting for the current visitor (absent = every section shows). */
+    evaluate?: (rules: RuleGroup) => boolean;
     /** The visitor saw these announcements (News tab opened). */
     onNewsSeen?: (ids: string[]) => void;
     hideLauncher?: boolean;
+    /** Where the visitor last dragged the launcher on this device (null = the configured corner). */
+    launcherSpot?: LauncherSpot | null;
+    /** The visitor dragged the launcher somewhere else (save it for next time). */
+    onLauncherMove?: (spot: LauncherSpot) => void;
     /** Poll intervals (ms): open thread, and unread badge while closed. */
     pollMs?: {
         thread: number;
@@ -128,6 +188,8 @@ interface MessengerWidget {
     openArticle(id: string): void;
     /** Opens the complaint form, optionally with a category picked (when the project takes complaints). */
     openComplaint(categoryId?: string): void;
+    /** Opens the Ideas tab, or one idea (when the project turned Ideas on). */
+    openIdeas(requestId?: string): void;
     /** Re-reads the visitor (page changed, progress made) and re-renders what is showing. */
     refresh(): void;
     destroy(): void;
@@ -138,4 +200,4 @@ 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 MessengerChecklistProgress, type MessengerNewsItem, type MessengerOptions, type MessengerResumeGuide, type MessengerStreamHandlers, type MessengerTab, type MessengerVisitor, type MessengerWidget, personalGreeting, relativeTime, renderMessenger };
+export { type IdeaInput, type IdeaListQuery, type IdeaVoteInput, type IdeasApi, type LauncherSpot, type MessengerApi, type MessengerChecklistProgress, type MessengerNewsItem, type MessengerOptions, type MessengerResumeGuide, type MessengerStreamHandlers, type MessengerTab, type MessengerVisitor, type MessengerWidget, parseLauncherSpot, personalGreeting, relativeTime, renderMessenger };

package/dist/messenger.d.ts

@@ -1,4 +1,4 @@
-import { MessengerConversation, ConversationMessagesResponse, MessengerMessage, SdkArticlesResponse, ResourceCenterArticle, SdkHowTosResponse, SdkHowTo, MessengerPageContent, FileComplaintResponse, MessengerConfig, ResourceCenterConfig } from '@guidelytech/shared';
+import { FeedbackPriority, FeedbackStatus, PublicFeedbackList, PublicFeedbackRequestDetail, PublicFeedbackRequest, FeedbackUpdatesResponse, MessengerConversation, ConversationMessagesResponse, MessengerMessage, SdkArticlesResponse, ResourceCenterArticle, SdkHowTosResponse, SdkHowTo, MessengerPageContent, FileComplaintResponse, MessengerConfig, ResourceCenterConfig, RuleGroup } 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). */
@@ -15,6 +15,56 @@ interface ComplaintInput {
     } | null;
 }
 
+type IdeaSort = "top" | "new" | "trending";
+type IdeaFilter = "open" | "all" | "mine" | "following";
+/** What the Ideas tab asks for (the transport adds the visitor). */
+interface IdeaListQuery {
+    q?: string;
+    sort: IdeaSort;
+    filter: IdeaFilter;
+    status?: FeedbackStatus;
+    productArea?: string;
+    page: number;
+}
+/** A new idea (the transport adds the visitor and the page). */
+interface IdeaInput {
+    title: string;
+    description: string;
+    productArea?: string | null;
+    priority: FeedbackPriority;
+    /** Suggested from this Scout conversation (Scout offered it). */
+    conversationId?: string | null;
+}
+interface IdeaVoteInput {
+    priority: FeedbackPriority;
+    note?: string;
+    conversationId?: string | null;
+}
+/** Server access for the Ideas tab. Every method is optional: transports before Ideas lack them. */
+interface IdeasApi {
+    listIdeas?(query: IdeaListQuery): Promise<PublicFeedbackList>;
+    /** Reads one idea with its comments (and counts the view). */
+    getIdea?(id: string): Promise<PublicFeedbackRequestDetail>;
+    submitIdea?(input: IdeaInput): Promise<PublicFeedbackRequestDetail>;
+    voteIdea?(id: string, vote: IdeaVoteInput): Promise<PublicFeedbackRequest>;
+    unvoteIdea?(id: string): Promise<PublicFeedbackRequest>;
+    followIdea?(id: string, follow: boolean): Promise<PublicFeedbackRequest>;
+    commentIdea?(id: string, body: string): Promise<PublicFeedbackRequestDetail>;
+    similarIdeas?(title: string): Promise<PublicFeedbackRequest[]>;
+    ideaUpdates?(): Promise<FeedbackUpdatesResponse>;
+    markIdeaUpdatesRead?(ids?: string[]): Promise<FeedbackUpdatesResponse>;
+    /** A short-lived link into the hosted feedback portal. */
+    ideaPortalLink?(): Promise<string>;
+}
+
+/** Where the visitor left the launcher. `y`: 0 = the default bottom spot, 1 = as high as it goes. */
+interface LauncherSpot {
+    side: "left" | "right";
+    y: number;
+}
+/** Reads a stored spot, ignoring anything malformed. */
+declare function parseLauncherSpot(raw: unknown): LauncherSpot | null;
+
 /** Callbacks the transport invokes while a message is sent and Scout replies. */
 interface MessengerStreamHandlers {
     /** A new conversation was created (first message only). */
@@ -24,8 +74,9 @@ interface MessengerStreamHandlers {
     onDone(message: MessengerMessage | null, conversation: MessengerConversation): void;
     onError(message: string): void;
 }
-/** Server access for the messenger; implemented by sdk-core over the public SDK API. */
-interface MessengerApi {
+
+/** Server access for the messenger; implemented by sdk-core over the public SDK API. The Ideas methods ({@link IdeasApi}) are optional. */
+interface MessengerApi extends IdeasApi {
     listConversations(): Promise<MessengerConversation[]>;
     loadMessages(conversationId: string, since?: string | null): Promise<ConversationMessagesResponse>;
     start(text: string, handlers: MessengerStreamHandlers): Promise<void>;
@@ -43,7 +94,7 @@ interface MessengerApi {
     /** 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";
+type MessengerTab = "home" | "messages" | "help" | "ideas" | "news";
 /** A guide the visitor started and didn't finish. */
 interface MessengerResumeGuide {
     id: string;
@@ -71,6 +122,9 @@ interface MessengerNewsItem {
     imageUrl: string | null;
     publishedAt: string;
     unread: boolean;
+    /** Resource-center "What's new" entries: open this help article, or this link, instead of starting a guide. */
+    articleId?: string | null;
+    url?: string | null;
 }
 /** What the SDK knows about the visitor right now, read each time the messenger renders. */
 interface MessengerVisitor {
@@ -108,9 +162,15 @@ interface MessengerOptions {
         name?: string | null;
     };
     onResumeGuide?: (guideId: string, stepId: string) => void;
+    /** Evaluates a resource-center section's targeting for the current visitor (absent = every section shows). */
+    evaluate?: (rules: RuleGroup) => boolean;
     /** The visitor saw these announcements (News tab opened). */
     onNewsSeen?: (ids: string[]) => void;
     hideLauncher?: boolean;
+    /** Where the visitor last dragged the launcher on this device (null = the configured corner). */
+    launcherSpot?: LauncherSpot | null;
+    /** The visitor dragged the launcher somewhere else (save it for next time). */
+    onLauncherMove?: (spot: LauncherSpot) => void;
     /** Poll intervals (ms): open thread, and unread badge while closed. */
     pollMs?: {
         thread: number;
@@ -128,6 +188,8 @@ interface MessengerWidget {
     openArticle(id: string): void;
     /** Opens the complaint form, optionally with a category picked (when the project takes complaints). */
     openComplaint(categoryId?: string): void;
+    /** Opens the Ideas tab, or one idea (when the project turned Ideas on). */
+    openIdeas(requestId?: string): void;
     /** Re-reads the visitor (page changed, progress made) and re-renders what is showing. */
     refresh(): void;
     destroy(): void;
@@ -138,4 +200,4 @@ 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 MessengerChecklistProgress, type MessengerNewsItem, type MessengerOptions, type MessengerResumeGuide, type MessengerStreamHandlers, type MessengerTab, type MessengerVisitor, type MessengerWidget, personalGreeting, relativeTime, renderMessenger };
+export { type IdeaInput, type IdeaListQuery, type IdeaVoteInput, type IdeasApi, type LauncherSpot, type MessengerApi, type MessengerChecklistProgress, type MessengerNewsItem, type MessengerOptions, type MessengerResumeGuide, type MessengerStreamHandlers, type MessengerTab, type MessengerVisitor, type MessengerWidget, parseLauncherSpot, personalGreeting, relativeTime, renderMessenger };