@servicetitan/titan-chatbot-api 8.0.0 → 9.0.0

package/src/api-client/help-center/__tests__/converter-from-models.test.ts

@@ -1,41 +0,0 @@
-import { expect } from '@jest/globals';
-import { Models } from '../..';
-import { ConverterFromModels } from '../converter-from-models';
-
-describe('ConverterFromModels', () => {
-    test('convertFilters', () => {
-        expect(ConverterFromModels.convertFilters()).toBeUndefined();
-        expect(ConverterFromModels.convertFilters({})).toBeUndefined();
-        expect(
-            ConverterFromModels.convertFilters({
-                subOptions: {
-                    ProductAreas: { values: [] },
-                },
-            } as unknown as Models.ISelections)
-        ).toEqual({
-            productAreas: [],
-        });
-        expect(
-            ConverterFromModels.convertFilters({
-                subOptions: {
-                    ProductAreas: { values: ['area1', 'area2'] },
-                },
-            } as unknown as Models.ISelections)
-        ).toEqual({
-            productAreas: ['area1', 'area2'],
-        });
-        expect(
-            ConverterFromModels.convertFilters({
-                subOptions: {
-                    Sources: { values: ['source1', 'source2'] },
-                    ContentTypes: { values: ['type1'] },
-                    ProductAreas: { values: ['area1', 'area2'] },
-                },
-            } as unknown as Models.ISelections)
-        ).toEqual({
-            sources: ['source1', 'source2'],
-            contentTypes: ['type1'],
-            productAreas: ['area1', 'area2'],
-        });
-    });
-});

package/src/api-client/help-center/__tests__/converter-to-models.test.ts

@@ -1,89 +0,0 @@
-import { expect } from '@jest/globals';
-import { Models } from '../..';
-import { ConverterToModels } from '../converter-to-models';
-// eslint-disable-next-line no-restricted-imports
-import * as HelpCenterClient from '../native-client';
-
-describe('ConverterToModels', () => {
-    test('convertFilterOptions', () => {
-        expect(ConverterToModels.convertFilterOptions({})).toEqual(
-            new Models.FrontendModel({
-                options: new Models.Option({
-                    key: 'help-center-filters-root',
-                    displayName: 'help-center-filters-root',
-                    type: Models.OptionType.Group,
-                    subOptions: [],
-                }),
-            })
-        );
-
-        expect(
-            ConverterToModels.convertFilterOptions({
-                sources: [
-                    new HelpCenterClient.FilterOption({
-                        id: 'source1',
-                        displayName: 'Source 1',
-                    }),
-                    new HelpCenterClient.FilterOption({
-                        id: 'source2',
-                        displayName: 'Source 2',
-                    }),
-                ],
-                productAreas: [
-                    new HelpCenterClient.FilterOption({
-                        id: 'area1',
-                        displayName: 'Area 1',
-                    }),
-                    new HelpCenterClient.FilterOption({
-                        id: 'area2',
-                        displayName: 'Area 2',
-                    }),
-                ],
-            })
-        ).toEqual(
-            new Models.FrontendModel({
-                options: new Models.Option({
-                    key: 'help-center-filters-root',
-                    displayName: 'help-center-filters-root',
-                    type: Models.OptionType.Group,
-                    subOptions: [
-                        new Models.Option({
-                            key: 'Sources',
-                            displayName: 'Sources',
-                            type: Models.OptionType.Group,
-                            subOptions: [
-                                new Models.Option({
-                                    key: 'source1',
-                                    displayName: 'Source 1',
-                                    type: Models.OptionType.Selectable,
-                                }),
-                                new Models.Option({
-                                    key: 'source2',
-                                    displayName: 'Source 2',
-                                    type: Models.OptionType.Selectable,
-                                }),
-                            ],
-                        }),
-                        new Models.Option({
-                            key: 'ProductAreas',
-                            displayName: 'Product Areas',
-                            type: Models.OptionType.Group,
-                            subOptions: [
-                                new Models.Option({
-                                    key: 'area1',
-                                    displayName: 'Area 1',
-                                    type: Models.OptionType.Selectable,
-                                }),
-                                new Models.Option({
-                                    key: 'area2',
-                                    displayName: 'Area 2',
-                                    type: Models.OptionType.Selectable,
-                                }),
-                            ],
-                        }),
-                    ],
-                }),
-            })
-        );
-    });
-});

package/src/api-client/help-center/chatbot-api-client.ts

@@ -1,122 +0,0 @@
-import { inject, injectable } from '@servicetitan/react-ioc';
-import { Models } from '..';
-import {
-    CHATBOT_CLIENT_SETTINGS,
-    FirstParameterType,
-    IChatbotApiClient,
-    IChatbotClientSettings,
-    SecondParameterType,
-} from '../base/chatbot-api-client';
-import { ConverterFromModels } from './converter-from-models';
-import { ConverterToModels } from './converter-to-models';
-// eslint-disable-next-line no-restricted-imports
-import { ChatClient } from './native-client';
-
-/**
- * Settings for the chatbot client, which includes a factory for constructor parameters, and additional settings
- * like instance and area which are used in the API calls.
- */
-export interface IChatbotClientSettingsHelpCenter extends IChatbotClientSettings {
-    constructorParametersFactory: () => {
-        baseUrl?: FirstParameterType<typeof ChatClient>;
-        axiosInstance?: SecondParameterType<typeof ChatClient>;
-    };
-    instance: string;
-    area: string;
-}
-
-/**
- * Client adapter adopts the generated titan chatbot client to the generic IChatbotApiClient interface.
- */
-@injectable()
-export class ChatbotApiClient implements IChatbotApiClient {
-    private readonly client: ChatClient;
-
-    constructor(
-        @inject(CHATBOT_CLIENT_SETTINGS)
-        private readonly chatbotApiClientSettings: IChatbotClientSettingsHelpCenter
-    ) {
-        const { axiosInstance, baseUrl } =
-            this.chatbotApiClientSettings.constructorParametersFactory();
-        this.client = new ChatClient(baseUrl, axiosInstance);
-    }
-
-    async postFeedback(body: Models.Feedback, abortSignal?: AbortSignal) {
-        if (body?.messageId) {
-            await this.client.sendBotMessageFeedback(
-                body.sessionId,
-                body.messageId,
-                ConverterFromModels.convertMessageFeedback(body),
-                abortSignal
-            );
-            return body;
-        } else if (body?.sessionId) {
-            await this.client.sendSessionFeedback(
-                body.sessionId,
-                ConverterFromModels.convertSessionFeedback(body),
-                abortSignal
-            );
-            return body;
-        }
-        throw new Error('Feedback must contain either messageId or sessionId');
-    }
-
-    async postMessage(body: Models.UserMessage, abortSignal?: AbortSignal) {
-        const hcMessage = ConverterFromModels.convertUserMessage(
-            body,
-            this.chatbotApiClientSettings.area
-        );
-        const botMessage = await this.client.sendUserMessage(hcMessage, abortSignal);
-        return ConverterToModels.convertBotMessage(botMessage);
-    }
-
-    postFollowUpEmail(
-        // eslint-disable-next-line @typescript-eslint/no-unused-vars
-        body: Models.UserMessage,
-        // eslint-disable-next-line @typescript-eslint/no-unused-vars
-        abortSignal?: AbortSignal
-    ): Promise<Models.BotMessage> {
-        throw new Error('Method not implemented for Help Center chatbot API.');
-    }
-
-    async getOptions(abortSignal?: AbortSignal): Promise<Models.FrontendModel> {
-        const filterOptions = await this.client.getFilterOptions(abortSignal);
-        return ConverterToModels.convertFilterOptions(filterOptions);
-    }
-
-    async postSession(body: Models.Session, abortSignal?: AbortSignal) {
-        body.data = body.data ?? {};
-        body.data.instance ??= this.chatbotApiClientSettings.instance;
-        const hcSession = ConverterFromModels.convertSession(body);
-        const newSession = await this.client.createSession(hcSession.source!, abortSignal);
-        return ConverterToModels.convertSession(newSession);
-    }
-
-    async patchSession(body: Models.Session, abortSignal?: AbortSignal) {
-        const session = ConverterFromModels.convertSession(body);
-        await this.client.updateSessionCategory(
-            session.source?.category,
-            session.source?.subCategory,
-            session.id,
-            abortSignal
-        );
-        return body;
-    }
-
-    async deleteSession(body: Models.Session, abortSignal?: AbortSignal) {
-        const session = ConverterFromModels.convertSession(body);
-        await this.client.closeSession(session.id, abortSignal);
-        return body;
-    }
-
-    getTranscripts(
-        // eslint-disable-next-line @typescript-eslint/no-unused-vars
-        start?: Date,
-        // eslint-disable-next-line @typescript-eslint/no-unused-vars
-        end?: Date,
-        // eslint-disable-next-line @typescript-eslint/no-unused-vars
-        signal?: AbortSignal
-    ): Promise<Models.ExportHistoryMessage[]> {
-        throw new Error('Method not implemented for Help Center chatbot API.');
-    }
-}

package/src/api-client/help-center/converter-from-models.ts

@@ -1,133 +0,0 @@
-import { Models } from '..';
-// eslint-disable-next-line no-restricted-imports
-import * as HelpCenterModels from './native-client';
-
-export class ConverterFromModels {
-    static convertSession(session: Models.ISession): HelpCenterModels.ChatbotSession {
-        const data = session.data;
-        return new HelpCenterModels.ChatbotSession({
-            id: session.id,
-            createdUtc: data?.createdUtc ? new Date(data.createdUtc) : undefined,
-            closedUtc: data?.closedUtc ? new Date(data.closedUtc) : undefined,
-            botId: data?.botId,
-            source: new HelpCenterModels.SessionSource({
-                instance: data?.instance,
-                category: data?.category,
-                subCategory: data?.subCategory,
-                fullstorySessionId: data?.fullstorySessionId,
-            }),
-        });
-    }
-
-    static convertUserMessage(
-        userMessage: Models.IUserMessage,
-        area: string
-    ): HelpCenterModels.UserMessage {
-        const filters =
-            ConverterFromModels.convertFilters(userMessage.selections) ??
-            new HelpCenterModels.FilterSelections({});
-        const data: HelpCenterModels.IUserMessage = {
-            sessionId: userMessage.sessionId,
-            text: userMessage.question,
-            source: new HelpCenterModels.MessageSource({
-                area,
-            }),
-            ...(filters ? { filters } : undefined),
-        };
-        return HelpCenterModels.UserMessage.fromJS(data);
-    }
-
-    static convertFilters(
-        selections?: Models.ISelections
-    ): HelpCenterModels.FilterSelections | undefined {
-        if (!selections?.subOptions || !Object.keys(selections.subOptions).length) {
-            return;
-        }
-        const data: HelpCenterModels.IFilterSelections = {};
-        const sources = selections.subOptions.Sources;
-        const contentTypes = selections.subOptions.ContentTypes;
-        const productAreas = selections.subOptions.ProductAreas;
-        if (sources?.values) {
-            data.sources = sources.values;
-        }
-        if (contentTypes?.values) {
-            data.contentTypes = contentTypes.values;
-        }
-        if (productAreas?.values) {
-            data.productAreas = productAreas.values;
-        }
-        return new HelpCenterModels.FilterSelections(data);
-    }
-
-    static convertSessionFeedback(feedback: Models.IFeedback): HelpCenterModels.SessionFeedback {
-        return new HelpCenterModels.SessionFeedback({
-            description: feedback.description,
-            rating: ConverterFromModels.convertSessionFeedbackRating(feedback.rating),
-        });
-    }
-
-    static convertMessageFeedback(feedback: Models.IFeedback): HelpCenterModels.MessageFeedback {
-        return new HelpCenterModels.MessageFeedback({
-            linkUrl: feedback.linkUrl,
-            description: feedback.description,
-            rating: ConverterFromModels.convertMessageFeedbackRating(feedback.rating),
-            options: ConverterFromModels.convertFeedbackOptions(feedback.options),
-        });
-    }
-
-    static convertFeedbackOptions(
-        feedbackOptions?: Models.FeedbackOptions[]
-    ): HelpCenterModels.FeedbackOptions[] | undefined {
-        if (feedbackOptions === undefined) {
-            return;
-        }
-        return feedbackOptions.map(feedbackOption => {
-            switch (feedbackOption) {
-                case Models.FeedbackOptions.Incomplete:
-                    return HelpCenterModels.FeedbackOptions.Incomplete;
-                case Models.FeedbackOptions.Incorrect:
-                    return HelpCenterModels.FeedbackOptions.Incorrect;
-                case Models.FeedbackOptions.Other:
-                    return HelpCenterModels.FeedbackOptions.Other;
-                case Models.FeedbackOptions.Unclear:
-                    return HelpCenterModels.FeedbackOptions.Unclear;
-                case Models.FeedbackOptions.Unrelated:
-                    return HelpCenterModels.FeedbackOptions.Unrelated;
-                default:
-                    return HelpCenterModels.FeedbackOptions.Other;
-            }
-        });
-    }
-
-    static convertMessageFeedbackRating(
-        feedbackRatings?: Models.FeedbackRatings
-    ): HelpCenterModels.MessageFeedbackRatings | undefined {
-        if (feedbackRatings === undefined) {
-            return;
-        }
-        switch (feedbackRatings) {
-            case Models.FeedbackRatings.ThumbsDown:
-                return HelpCenterModels.MessageFeedbackRatings.ThumbsDown;
-            case Models.FeedbackRatings.GuardrailFeedback:
-                return HelpCenterModels.MessageFeedbackRatings.GuardrailFeedback;
-            case Models.FeedbackRatings.ThumbsUp:
-                return HelpCenterModels.MessageFeedbackRatings.ThumbsUp;
-        }
-    }
-
-    static convertSessionFeedbackRating(
-        feedbackRatings?: Models.FeedbackRatings
-    ): HelpCenterModels.SessionFeedbackRatings | undefined {
-        if (feedbackRatings === undefined) {
-            return;
-        }
-        switch (feedbackRatings) {
-            case Models.FeedbackRatings.ThumbsDown:
-                return HelpCenterModels.SessionFeedbackRatings.ThumbsDown;
-            case Models.FeedbackRatings.ThumbsUp:
-                return HelpCenterModels.SessionFeedbackRatings.ThumbsUp;
-            default:
-                return HelpCenterModels.SessionFeedbackRatings.ThumbsDown;
-        }
-    }
-}

package/src/api-client/help-center/converter-to-models.ts

@@ -1,127 +0,0 @@
-import { Models } from '..';
-// eslint-disable-next-line no-restricted-imports
-import * as HelpCenterClient from './native-client';
-
-export class ConverterToModels {
-    static convertSession(session: HelpCenterClient.IChatbotSession): Models.Session {
-        return new Models.Session({
-            id: session.id,
-            data: ConverterToModels.convertSessionData(session),
-        });
-    }
-
-    static convertSessionData(session: HelpCenterClient.IChatbotSession): Models.Session['data'] {
-        const data: Models.Session['data'] = {};
-        if (session.createdUtc) {
-            data.createdUtc = session.createdUtc.toISOString();
-        }
-        if (session.closedUtc) {
-            data.closedUtc = session.closedUtc.toISOString();
-        }
-        if (session.botId) {
-            data.botId = session.botId;
-        }
-        if (session.source) {
-            if (session.source.instance) {
-                data.instance = session.source.instance;
-            }
-            if (session.source.category) {
-                data.category = session.source.category;
-            }
-            if (session.source.subCategory) {
-                data.subCategory = session.source.subCategory;
-            }
-            if (session.source.fullstorySessionId) {
-                data.fullstorySessionId = session.source.fullstorySessionId;
-            }
-        }
-        return Object.keys(data).length > 0 ? data : undefined;
-    }
-
-    /**
-     * Convert HC filters into single-level frontend model.
-     */
-    static convertFilterOptions(options: HelpCenterClient.IFilterOptions): Models.FrontendModel {
-        const createFilterOption = (key: string, displayName?: string): Models.Option => {
-            return new Models.Option({
-                key,
-                displayName: displayName ?? key,
-                type: Models.OptionType.Selectable,
-            });
-        };
-        const createFilterOptions = (options?: HelpCenterClient.IFilterOption[]) =>
-            options?.map(x => createFilterOption(x.id ?? '', x.displayName));
-        const createFilter = (
-            key: string,
-            displayName?: string,
-            subOptions?: Models.Option[]
-        ): Models.Option => {
-            return new Models.Option({
-                key,
-                displayName: displayName ?? key,
-                type: Models.OptionType.Group,
-                subOptions,
-            });
-        };
-
-        const subOptions: Models.Option[] = [];
-        if (options.sources?.length) {
-            subOptions.push(
-                createFilter('Sources', 'Sources', createFilterOptions(options.sources))
-            );
-        }
-        if (options.contentTypes?.length) {
-            subOptions.push(
-                createFilter(
-                    'ContentTypes',
-                    'Content Types',
-                    createFilterOptions(options.contentTypes)
-                )
-            );
-        }
-        if (options.productAreas?.length) {
-            subOptions.push(
-                createFilter(
-                    'ProductAreas',
-                    'Product Areas',
-                    createFilterOptions(options.productAreas)
-                )
-            );
-        }
-        return new Models.FrontendModel({
-            options: new Models.Option({
-                key: 'help-center-filters-root',
-                displayName: 'help-center-filters-root',
-                type: Models.OptionType.Group,
-                subOptions,
-            }),
-        });
-    }
-
-    static convertBotMessage(botMessage: HelpCenterClient.IBotMessage): Models.BotMessage {
-        return new Models.BotMessage({
-            id: botMessage.id ?? 0,
-            answer: botMessage.text ?? '',
-            isGuardrailed: botMessage.isGuardrailed ?? false,
-            guardFlag: botMessage.guardFlag ?? 'N',
-            sessionId: botMessage.sessionId ?? 0,
-            scoredUrls: ConverterToModels.convertScoredUrls(botMessage.scoredUrls),
-        });
-    }
-
-    static convertScoredUrls(
-        scoredUrls?: HelpCenterClient.IScoredUrl[]
-    ): Models.ScoredUrl[] | undefined {
-        if (scoredUrls === undefined) {
-            return;
-        }
-        return scoredUrls.map(
-            url =>
-                new Models.ScoredUrl({
-                    url: url.url,
-                    score: url.score,
-                    title: url.title,
-                })
-        );
-    }
-}

package/src/api-client/help-center/index.ts

@@ -1,2 +0,0 @@
-export type { IChatbotClientSettingsHelpCenter } from './chatbot-api-client';
-export { ChatbotApiClient } from './chatbot-api-client';