@servicetitan/titan-chatbot-api 7.1.0 → 7.1.2

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@servicetitan/titan-chatbot-api",
-    "version": "7.1.0",
+    "version": "7.1.2",
     "description": "Chatbot client API package",
     "repository": {
         "type": "git",
@@ -17,7 +17,7 @@
         "push:local": "yalc push"
     },
     "dependencies": {
-        "@servicetitan/titan-chat-ui-common": "^7.1.0",
+        "@servicetitan/titan-chat-ui-common": "^7.1.2",
         "lodash": "^4.18.1",
         "nanoid": "^5.1.5"
     },
@@ -42,5 +42,5 @@
     "cli": {
         "webpack": false
     },
-    "gitHead": "3850a8bab63c7fa6d23fcfb2a40fa1a1416a3b13"
+    "gitHead": "ddacea8f1d7e9ffce602d24554aeb306e61a40e2"
 }

package/src/api-client/models/__mocks__/models.mock.ts

@@ -257,10 +257,8 @@ export const mockWorkflowStep = (overrides?: Partial<Models.IWorkflowStep>): Mod
         ...overrides,
     });
 
-export const mockWorkflowConfirmation = (
-    overrides?: Partial<Models.IWorkflowConfirmation>
-): Models.WorkflowConfirmation =>
-    new Models.WorkflowConfirmation({
+export const mockWorkflowPlan = (overrides?: Partial<Models.IWorkflowPlan>): Models.WorkflowPlan =>
+    new Models.WorkflowPlan({
         displayName: 'Workflow Display Name',
         estimatedRuntimeSec: 60,
         inputs: [mockUserInput()],

package/src/api-client/models/index.ts

@@ -26,8 +26,8 @@ export {
     ExportHistoryMessage,
     AgentOption,
     IAgentOption,
-    WorkflowConfirmation,
-    IWorkflowConfirmation,
+    WorkflowPlan,
+    IWorkflowPlan,
     WorkflowStep,
     IWorkflowStep,
     UserInput,

package/src/api-client/titan-chat/native-client.ts

@@ -871,13 +871,13 @@ export class BotMessage extends Message implements IBotMessage {
     /** Ordered list of relevant Knowledge Base links. */
     declare scoredUrls?: ScoredUrl[] | undefined;
     /** A value indicating one of the conditions:
-- N - "none" or "normal", a successful response
-- A - "agent", user wants to talk to a support agent
-- C - "conversation", user attempted to continue a conversation in a single-turn message
-- OI - "offensive input"
-- AA - "agentic approval", the bot is waiting for the user to approve or cancel a pending action
-- BI - "bifurcation", the bot is offering the user a choice (see TitanChatbot.Host.API.Models.BotMessage.AgentOptions)
-Client may handle these conditions in different ways. */
+     - N - "none" or "normal", a successful response
+     - A - "agent", user wants to talk to a support agent
+     - C - "conversation", user attempted to continue a conversation in a single-turn message
+     - OI - "offensive input"
+     - AA - "agentic approval", the bot is waiting for the user to approve or cancel a pending action
+     - BI - "bifurcation", the bot is offering the user a choice (see TitanChatbot.Host.API.Models.BotMessage.AgentOptions)
+     Client may handle these conditions in different ways. */
     declare guardFlag: string;
     /** Whether the answer is guardrailed, meaning TitanChatbot.Host.API.Models.BotMessage.GuardFlag is anything but "N". */
     declare isGuardrailed: boolean;
@@ -891,7 +891,7 @@ Client may handle these conditions in different ways. */
     declare confidenceScore?: number | undefined;
     /** When the bot offers the user a discrete choice (e.g. "do it for me" vs "show me how"), the available options. */
     declare agentOptions?: AgentOption[] | undefined;
-    declare workflowConfirmation?: WorkflowConfirmation;
+    declare workflowPlan?: WorkflowPlan;
 
     constructor(data?: IBotMessage) {
         super(data);
@@ -917,8 +917,8 @@ Client may handle these conditions in different ways. */
                 for (let item of _data['agentOptions'])
                     this.agentOptions!.push(AgentOption.fromJS(item));
             }
-            this.workflowConfirmation = _data['workflowConfirmation']
-                ? WorkflowConfirmation.fromJS(_data['workflowConfirmation'])
+            this.workflowPlan = _data['workflowPlan']
+                ? WorkflowPlan.fromJS(_data['workflowPlan'])
                 : <any>undefined;
         }
     }
@@ -947,9 +947,7 @@ Client may handle these conditions in different ways. */
             data['agentOptions'] = [];
             for (let item of this.agentOptions) data['agentOptions'].push(item.toJSON());
         }
-        data['workflowConfirmation'] = this.workflowConfirmation
-            ? this.workflowConfirmation.toJSON()
-            : <any>undefined;
+        data['workflowPlan'] = this.workflowPlan ? this.workflowPlan.toJSON() : <any>undefined;
         super.toJSON(data);
         return data;
     }
@@ -962,13 +960,13 @@ export interface IBotMessage extends IMessage {
     /** Ordered list of relevant Knowledge Base links. */
     scoredUrls?: ScoredUrl[] | undefined;
     /** A value indicating one of the conditions:
-- N - "none" or "normal", a successful response
-- A - "agent", user wants to talk to a support agent
-- C - "conversation", user attempted to continue a conversation in a single-turn message
-- OI - "offensive input"
-- AA - "agentic approval", the bot is waiting for the user to approve or cancel a pending action
-- BI - "bifurcation", the bot is offering the user a choice (see TitanChatbot.Host.API.Models.BotMessage.AgentOptions)
-Client may handle these conditions in different ways. */
+     - N - "none" or "normal", a successful response
+     - A - "agent", user wants to talk to a support agent
+     - C - "conversation", user attempted to continue a conversation in a single-turn message
+     - OI - "offensive input"
+     - AA - "agentic approval", the bot is waiting for the user to approve or cancel a pending action
+     - BI - "bifurcation", the bot is offering the user a choice (see TitanChatbot.Host.API.Models.BotMessage.AgentOptions)
+     Client may handle these conditions in different ways. */
     guardFlag: string;
     /** Whether the answer is guardrailed, meaning TitanChatbot.Host.API.Models.BotMessage.GuardFlag is anything but "N". */
     isGuardrailed: boolean;
@@ -982,7 +980,7 @@ Client may handle these conditions in different ways. */
     confidenceScore?: number | undefined;
     /** When the bot offers the user a discrete choice (e.g. "do it for me" vs "show me how"), the available options. */
     agentOptions?: AgentOption[] | undefined;
-    workflowConfirmation?: WorkflowConfirmation;
+    workflowPlan?: WorkflowPlan;
 }
 
 export enum Experience {
@@ -1547,8 +1545,8 @@ export interface ISummarizeResponse {
 
 /** One user-provided input collected for the workflow. */
 export class UserInput implements IUserInput {
-    label?: string | undefined;
-    value?: string | undefined;
+    label!: string;
+    value!: string;
 
     constructor(data?: IUserInput) {
         if (data) {
@@ -1582,8 +1580,8 @@ export class UserInput implements IUserInput {
 
 /** One user-provided input collected for the workflow. */
 export interface IUserInput {
-    label?: string | undefined;
-    value?: string | undefined;
+    label: string;
+    value: string;
 }
 
 /** User request message. */
@@ -1653,18 +1651,21 @@ export interface IUserMessage extends IMessage {
 }
 
 /** Pre-execution plan for an agentic UI workflow. */
-export class WorkflowConfirmation implements IWorkflowConfirmation {
-    displayName?: string | undefined;
-    estimatedRuntimeSec?: number;
+export class WorkflowPlan implements IWorkflowPlan {
+    displayName!: string;
+    estimatedRuntimeSec!: number;
     inputs?: UserInput[] | undefined;
-    steps?: WorkflowStep[] | undefined;
+    steps!: WorkflowStep[];
 
-    constructor(data?: IWorkflowConfirmation) {
+    constructor(data?: IWorkflowPlan) {
         if (data) {
             for (var property in data) {
                 if (data.hasOwnProperty(property)) (<any>this)[property] = (<any>data)[property];
             }
         }
+        if (!data) {
+            this.steps = [];
+        }
     }
 
     init(_data?: any) {
@@ -1682,9 +1683,9 @@ export class WorkflowConfirmation implements IWorkflowConfirmation {
         }
     }
 
-    static fromJS(data: any): WorkflowConfirmation {
+    static fromJS(data: any): WorkflowPlan {
         data = typeof data === 'object' ? data : {};
-        let result = new WorkflowConfirmation();
+        let result = new WorkflowPlan();
         result.init(data);
         return result;
     }
@@ -1706,17 +1707,17 @@ export class WorkflowConfirmation implements IWorkflowConfirmation {
 }
 
 /** Pre-execution plan for an agentic UI workflow. */
-export interface IWorkflowConfirmation {
-    displayName?: string | undefined;
-    estimatedRuntimeSec?: number;
+export interface IWorkflowPlan {
+    displayName: string;
+    estimatedRuntimeSec: number;
     inputs?: UserInput[] | undefined;
-    steps?: WorkflowStep[] | undefined;
+    steps: WorkflowStep[];
 }
 
 /** One step in the workflow's execution plan. `PageUrl` is set on navigation steps only. */
 export class WorkflowStep implements IWorkflowStep {
-    number?: number;
-    description?: string | undefined;
+    number!: number;
+    description!: string;
     pageUrl?: string | undefined;
 
     constructor(data?: IWorkflowStep) {
@@ -1753,8 +1754,8 @@ export class WorkflowStep implements IWorkflowStep {
 
 /** One step in the workflow's execution plan. `PageUrl` is set on navigation steps only. */
 export interface IWorkflowStep {
-    number?: number;
-    description?: string | undefined;
+    number: number;
+    description: string;
     pageUrl?: string | undefined;
 }