@servicetitan/titan-chatbot-api 6.1.1 → 7.0.0

package/src/stores/chatbot-ui-backend.store.ts

@@ -19,6 +19,9 @@ import { InitializeStore } from './initialize.store';
 
 const DEFAULT_CHATBOT_ASK_BOT_TIMEOUT_MS = 31000; // 31 seconds
 
+const isAbortedError = (error: unknown): boolean =>
+    axios.isCancel(error) || (error as { name?: string } | null)?.name === 'AbortError';
+
 export const CHATBOT_UI_BACKEND_STORE_TOKEN = symbolToken<IChatbotUiBackendStore>(
     'CHATBOT_UI_BACKEND_STORE_TOKEN'
 );
@@ -140,24 +143,24 @@ export class ChatbotUiBackendStore extends InitializeStore implements IChatbotUi
     handleSessionFeedback: ChatUiEventListener<{
         state: Models.ChatbotFeedbackState;
         feedback?: Models.Feedback;
-    }> = async (resolve, _, feedback?: Models.Feedback) => {
+    }> = async (resolve, _, draft?: Models.IFeedback) => {
         let feedbackState: Models.ChatbotFeedbackState;
-        let feedbackResult = feedback;
+        let feedbackResult: Models.Feedback | undefined = draft
+            ? new Models.Feedback(draft)
+            : undefined;
         try {
-            if (!feedback) {
+            if (!draft) {
                 throw new ChatError('Session feedback is missing.', {
                     recoverStrategy: false,
                 });
             }
-            if (typeof feedback.messageId !== 'undefined') {
+            if (typeof draft.messageId !== 'undefined') {
                 throw new ChatError('Session feedback should not contain messageId.', {
                     recoverStrategy: false,
                 });
             }
             await this.startSession();
-            runInAction(() => {
-                feedback.sessionId = this.session!.id;
-            });
+            const feedback = new Models.Feedback({ ...draft, sessionId: this.session!.id! });
             feedbackResult = await this.api('postFeedback', feedback, this.abortController.signal);
             feedbackState = Models.ChatbotFeedbackState.Success;
         } catch (error: unknown) {
@@ -178,24 +181,24 @@ export class ChatbotUiBackendStore extends InitializeStore implements IChatbotUi
     handleMessageFeedback: ChatUiEventListener<{
         state: Models.ChatbotFeedbackState;
         feedback?: Models.Feedback;
-    }> = async (resolve, _, feedback?: Models.Feedback) => {
+    }> = async (resolve, _, draft?: Models.IFeedback) => {
         let feedbackState: Models.ChatbotFeedbackState;
-        let feedbackResult = feedback;
+        let feedbackResult: Models.Feedback | undefined = draft
+            ? new Models.Feedback(draft)
+            : undefined;
         try {
-            if (!feedback) {
+            if (!draft) {
                 throw new ChatError('Message feedback is missing.', {
                     recoverStrategy: false,
                 });
             }
-            if (!feedback.messageId) {
+            if (!draft.messageId) {
                 throw new ChatError('Message feedback is missing messageId.', {
                     recoverStrategy: false,
                 });
             }
             await this.startSession();
-            runInAction(() => {
-                feedback.sessionId = this.session!.id;
-            });
+            const feedback = new Models.Feedback({ ...draft, sessionId: this.session!.id! });
             feedbackResult = await this.api('postFeedback', feedback, this.abortController.signal);
             feedbackState = Models.ChatbotFeedbackState.Success;
         } catch (error: unknown) {
@@ -240,7 +243,7 @@ export class ChatbotUiBackendStore extends InitializeStore implements IChatbotUi
     }
 
     protected logError(code: string, message: string, error: any) {
-        if (axios.isCancel(error)) {
+        if (isAbortedError(error)) {
             return;
         }
         this.logService.error({
@@ -428,7 +431,7 @@ export class ChatbotUiBackendStore extends InitializeStore implements IChatbotUi
     }
 
     protected setError(code: string, title: string, message: string, error: any) {
-        if (axios.isCancel(error)) {
+        if (isAbortedError(error)) {
             return;
         }
         this.logError(code, message, error);

package/src/stores/chatbot-ui.store.ts

@@ -4,6 +4,7 @@ import { action, makeObservable } from 'mobx';
 import { Models } from '../api-client';
 import { ChatbotCustomizations } from '../models';
 import { FilterStore, IFilterStore, IFilterStoreInitOptions } from './filter.store';
+import { FeedbackDraft } from './message-feedback-base.store';
 
 export const CHATBOT_UI_STORE_TOKEN = symbolToken<IChatbotUiStore>('CHATBOT_UI_STORE_TOKEN');
 
@@ -22,12 +23,10 @@ export interface IChatbotUiStore extends IChatUiStore<ChatbotCustomizations> {
         sessionData?: Models.ISession['data'],
         forceRecreate?: boolean
     ): Promise<undefined | Models.Session>;
-    sendSessionFeedback(
-        feedback: Models.IFeedback
-    ): Promise<undefined | Models.ChatbotFeedbackState>;
+    sendSessionFeedback(feedback: FeedbackDraft): Promise<undefined | Models.ChatbotFeedbackState>;
     sendMessageFeedback(
         message: Models.IBotMessageWithFeedback,
-        messageFeedback: Models.IFeedback
+        messageFeedback: FeedbackDraft
     ): Promise<undefined | Models.ChatbotFeedbackState>;
 }
 
@@ -80,11 +79,10 @@ export class ChatbotUiStore extends ChatUiStore<ChatbotCustomizations> implement
     }
 
     @action
-    async sendSessionFeedback(feedback: Models.Feedback) {
-        feedback.messageId = undefined; // Ensure messageId is not set for session feedback
+    async sendSessionFeedback(feedback: FeedbackDraft) {
         const result = await this.emitAsync<Models.ChatbotFeedbackState>(
             ChatbotUiEvent.eventChatbotSessionFeedback,
-            feedback
+            { ...feedback, messageId: undefined }
         );
         return result;
     }
@@ -92,12 +90,11 @@ export class ChatbotUiStore extends ChatUiStore<ChatbotCustomizations> implement
     @action
     async sendMessageFeedback(
         message: Models.IBotMessageWithFeedback,
-        messageFeedback: Models.Feedback
+        messageFeedback: FeedbackDraft
     ) {
-        messageFeedback.messageId = message.id;
         const result = await this.emitAsync<Models.ChatbotFeedbackState>(
             ChatbotUiEvent.eventChatbotMessageFeedback,
-            messageFeedback
+            { ...messageFeedback, messageId: message.id }
         );
         return result;
     }

package/src/stores/index.ts

@@ -18,4 +18,4 @@ export { InitializeStore, InitializeStoreStatus } from './initialize.store';
 export { MessageFeedbackStore } from './message-feedback.store';
 export { MessageFeedbackGuardrailStore } from './message-feedback-guardrail.store';
 export { SessionFeedbackStore } from './session-feedback.store';
-export { IMessageFeedbackBaseStore } from './message-feedback-base.store';
+export { type FeedbackDraft, IMessageFeedbackBaseStore } from './message-feedback-base.store';

package/src/stores/message-feedback-base.store.ts

@@ -1,8 +1,14 @@
 import { FormState } from 'formstate';
 import { Models } from '../api-client';
 
+/*
+ * A Feedback being assembled by a form or thumbs-up gesture. sessionId is filled in later
+ * by ChatbotUiBackendStore once a session exists, so it's intentionally omitted here.
+ */
+export type FeedbackDraft = Omit<Models.IFeedback, 'sessionId'>;
+
 export interface IMessageFeedbackBaseStore<T extends FormState<{}> = FormState<{}>> {
     isValid: boolean;
     formState: T;
-    export(): Models.IFeedback;
+    export(): FeedbackDraft;
 }

package/src/stores/message-feedback-guardrail.store.ts

@@ -2,7 +2,7 @@ import { injectable } from '@servicetitan/react-ioc';
 import { FieldState, FormState } from 'formstate';
 import { action, computed, makeObservable, observable } from 'mobx';
 import { Models } from '../api-client';
-import { IMessageFeedbackBaseStore } from './message-feedback-base.store';
+import { FeedbackDraft, IMessageFeedbackBaseStore } from './message-feedback-base.store';
 
 export type FeedbackFormState = FormState<{
     linkUrl: FieldState<string>;
@@ -22,24 +22,18 @@ export class MessageFeedbackGuardrailStore implements IMessageFeedbackBaseStore<
         makeObservable(this);
     }
 
-    export(): Models.Feedback {
+    export(): FeedbackDraft {
         const fs = this.formState.$;
-        let feedback: Models.IFeedback = {
+        const feedback: FeedbackDraft = {
             rating: Models.FeedbackRatings.GuardrailFeedback,
         };
         if (fs.linkUrl.value) {
-            feedback = {
-                ...feedback,
-                linkUrl: fs.linkUrl.value,
-            };
+            feedback.linkUrl = fs.linkUrl.value;
         }
         if (fs.comment.value) {
-            feedback = {
-                ...feedback,
-                description: fs.comment.value,
-            };
+            feedback.description = fs.comment.value;
         }
-        return new Models.Feedback(feedback);
+        return feedback;
     }
 
     getFormErrors(): string[] {

package/src/stores/message-feedback.store.ts

@@ -3,7 +3,7 @@ import { FieldState, FormState } from 'formstate';
 import { action, computed, makeObservable, observable } from 'mobx';
 import { Models } from '../api-client';
 import { CHATBOT_UI_STORE_TOKEN, IChatbotUiStore } from './chatbot-ui.store';
-import { IMessageFeedbackBaseStore } from './message-feedback-base.store';
+import { FeedbackDraft, IMessageFeedbackBaseStore } from './message-feedback-base.store';
 
 export type MessageFeedbackFormState = FormState<{
     unrelated: FieldState<boolean>;
@@ -41,7 +41,7 @@ export class MessageFeedbackStore implements IMessageFeedbackBaseStore<MessageFe
         makeObservable(this);
     }
 
-    export(): Models.IFeedback {
+    export(): FeedbackDraft {
         const fs = this.formState.$;
         const options: Models.FeedbackOptions[] = [];
         if (fs.unrelated.value) {
@@ -59,17 +59,14 @@ export class MessageFeedbackStore implements IMessageFeedbackBaseStore<MessageFe
         if (fs.other.value) {
             options.push(Models.FeedbackOptions.Other);
         }
-        let feedback: Models.IFeedback = {
+        const feedback: FeedbackDraft = {
             rating: Models.FeedbackRatings.ThumbsDown,
             options,
         };
         if (fs.otherComment.value) {
-            feedback = {
-                ...feedback,
-                description: fs.otherComment.value,
-            };
+            feedback.description = fs.otherComment.value;
         }
-        return new Models.Feedback(feedback);
+        return feedback;
     }
 
     @action

package/src/stores/session-feedback.store.ts

@@ -2,6 +2,7 @@ import { injectable } from '@servicetitan/react-ioc';
 import { FieldState, FormState } from 'formstate';
 import { computed, makeObservable, observable } from 'mobx';
 import { Models } from '../api-client';
+import { FeedbackDraft } from './message-feedback-base.store';
 
 @injectable()
 export class SessionFeedbackStore {
@@ -17,14 +18,14 @@ export class SessionFeedbackStore {
     }
 
     @computed
-    get feedback(): Models.Feedback {
-        return new Models.Feedback({
+    get feedback(): FeedbackDraft {
+        return {
             rating:
                 this.formState.$.thumbs.value > 0
                     ? Models.FeedbackRatings.ThumbsUp
                     : Models.FeedbackRatings.ThumbsDown,
             description: this.formState.$.comment.value || undefined,
-        });
+        };
     }
 
     @computed