Merge pull request #119 from salesforcecli/ew/gen-ai-planner-bundle

W-18171905 Support genAiPlannerBundles for agent generate template

Author: shetzel

schemas/agent-generate-template.json

@@ -5,14 +5,14 @@
     "AgentGenerateTemplateResult": {
       "type": "object",
       "properties": {
-        "genAiPlannerPath": {
+        "genAiPlannerBundlePath": {
           "type": "string"
         },
         "botTemplatePath": {
           "type": "string"
         }
       },
-      "required": ["genAiPlannerPath", "botTemplatePath"],
+      "required": ["genAiPlannerBundlePath", "botTemplatePath"],
       "additionalProperties": false
     }
   }

src/commands/agent/generate/template.ts

@@ -20,8 +20,8 @@ import type {
   ConversationVariable,
 } from '@salesforce/types/metadata';
 
-export type GenAiPlannerExt = {
-  GenAiPlanner: GenAiPlanner & { botTemplate?: string };
+export type GenAiPlannerBundleExt = {
+  GenAiPlannerBundle: GenAiPlanner & { botTemplate?: string };
 };
 
 export type BotTemplateExt = {
@@ -46,7 +46,7 @@ Messages.importMessagesDirectoryFromMetaUrl(import.meta.url);
 const messages = Messages.loadMessages('@salesforce/plugin-agent', 'agent.generate.template');
 
 export type AgentGenerateTemplateResult = {
-  genAiPlannerPath: string;
+  genAiPlannerBundlePath: string;
   botTemplatePath: string;
 };
 export default class AgentGenerateTemplate extends SfCommand<AgentGenerateTemplateResult> {
@@ -82,41 +82,45 @@ export default class AgentGenerateTemplate extends SfCommand<AgentGenerateTempla
     const builder = new XMLBuilder({ format: true, ignoreAttributes: false, indentBy: '    ' });
 
     const botName = basename(agentFile, '.bot-meta.xml');
-    // Since we are cloning the GenAiPlanner, we need to use a different name than the Agent (Bot) we started with
+    // Since we are cloning the GenAiPlannerBundle, we need to use a different name than the Agent (Bot) we started with
     // We will use this name for the BotTemplate also to make it clear they are related
     const finalFilename = `${botName}_v${botVersion}_Template`;
 
     // Build the base dir from the AgentFile
     const basePath = resolve(dirname(agentFile), '..', '..');
     const botDir = join(basePath, 'bots', botName);
-    const genAiPlannerDir = join(basePath, 'genAiPlanners');
+    const genAiPlannerBundleDir = join(basePath, 'genAiPlannerBundles');
     const botTemplateDir = join(basePath, 'botTemplates');
 
     const botTemplateFilePath = join(botTemplateDir, `${finalFilename}.botTemplate-meta.xml`);
-    const clonedGenAiPlannerFilePath = join(genAiPlannerDir, `${finalFilename}.genAiPlanner-meta.xml`);
+    const clonedGenAiPlannerBundleFilePath = join(
+      genAiPlannerBundleDir,
+      finalFilename,
+      `${finalFilename}.genAiPlannerBundle`
+    );
 
     // Parse the metadata files as JSON
     const botJson = xmlToJson<BotExt>(join(botDir, `${botName}.bot-meta.xml`), parser);
     const botVersionJson = xmlToJson<BotVersionExt>(join(botDir, `v${botVersion}.botVersion-meta.xml`), parser);
-    const genAiPlannerMetaJson = xmlToJson<GenAiPlannerExt>(
-      join(genAiPlannerDir, `${botName}.genAiPlanner-meta.xml`),
+    const genAiPlannerBundleMetaJson = xmlToJson<GenAiPlannerBundleExt>(
+      join(genAiPlannerBundleDir, botName, `${botName}.genAiPlannerBundle`),
       parser
     );
 
     // Modify the metadata files for final output
     // TODO: Confirm this name (might be conversationDefinitionPlanners)
-    genAiPlannerMetaJson.GenAiPlanner.botTemplate = finalFilename;
+    genAiPlannerBundleMetaJson.GenAiPlannerBundle.botTemplate = finalFilename;
     const botTemplate = convertBotToBotTemplate(botJson, botVersionJson, finalFilename, botTemplateFilePath);
 
     // Build and save the metadata files
-    jsonToXml<GenAiPlannerExt>(clonedGenAiPlannerFilePath, genAiPlannerMetaJson, builder);
+    jsonToXml<GenAiPlannerBundleExt>(clonedGenAiPlannerBundleFilePath, genAiPlannerBundleMetaJson, builder);
     jsonToXml<BotTemplateExt>(botTemplateFilePath, botTemplate, builder);
 
     this.log(`\nSaved BotTemplate to:\n - ${botTemplateFilePath}`);
-    this.log(`Saved GenAiPlanner to:\n - ${clonedGenAiPlannerFilePath}`);
+    this.log(`Saved GenAiPlannerBundle to:\n - ${clonedGenAiPlannerBundleFilePath}`);
 
     return {
-      genAiPlannerPath: clonedGenAiPlannerFilePath,
+      genAiPlannerBundlePath: clonedGenAiPlannerBundleFilePath,
       botTemplatePath: botTemplateFilePath,
     };
   }

test/commands/agent/generate/template.nut.ts

@@ -12,7 +12,7 @@ import { expect } from 'chai';
 import {
   AgentGenerateTemplateResult,
   BotTemplateExt,
-  GenAiPlannerExt,
+  GenAiPlannerBundleExt,
 } from '../../../../src/commands/agent/generate/template.js';
 
 describe('agent generate template NUTs', () => {
@@ -42,7 +42,7 @@ describe('agent generate template NUTs', () => {
     );
   });
 
-  it('Converts an Agent into an BotTemplate and GenAiPlanner', async () => {
+  it('Converts an Agent into an BotTemplate and GenAiPlannerBundle', async () => {
     const agentVersion = 1;
     const agentFile = join(
       'force-app',
@@ -64,19 +64,20 @@ describe('agent generate template NUTs', () => {
       'botTemplates',
       'Guest_Experience_Agent_v1_Template.botTemplate-meta.xml'
     );
-    const genAiPlannerFilePath = join(
+    const genAiPlannerBundleFilePath = join(
       'force-app',
       'main',
       'default',
-      'genAiPlanners',
-      'Guest_Experience_Agent_v1_Template.genAiPlanner-meta.xml'
+      'genAiPlannerBundles',
+      'Guest_Experience_Agent_v1_Template',
+      'Guest_Experience_Agent_v1_Template.genAiPlannerBundle'
     );
 
     const generatedBotTemplateFilePath = resolve(session.project.dir, botTemplateFilePath);
-    const generatedGenAiPlannerFilePath = resolve(session.project.dir, genAiPlannerFilePath);
+    const generatedGenAiPlannerBundleFilePath = resolve(session.project.dir, genAiPlannerBundleFilePath);
     // Ensure it returns the paths to the generated files
     expect(output?.result.botTemplatePath).to.equal(generatedBotTemplateFilePath);
-    expect(output?.result.genAiPlannerPath).to.equal(generatedGenAiPlannerFilePath);
+    expect(output?.result.genAiPlannerBundlePath).to.equal(generatedGenAiPlannerBundleFilePath);
 
     // Compare generated files with mock files
     const mockBotTemplateFilePath = join(
@@ -86,12 +87,12 @@ describe('agent generate template NUTs', () => {
       'MOCK-XML',
       botTemplateFilePath
     );
-    const mockGenAiPlannerFilePath = join(
+    const mockGenAiPlannerBundleFilePath = join(
       'test',
       'mock-projects',
       'agent-generate-template',
       'MOCK-XML',
-      genAiPlannerFilePath
+      genAiPlannerBundleFilePath
     );
 
     const parser = new XMLParser({ ignoreAttributes: false });
@@ -103,10 +104,12 @@ describe('agent generate template NUTs', () => {
     const mockBotTemplateFile = parser.parse(readFileSync(mockBotTemplateFilePath, 'utf-8')) as BotTemplateExt;
     expect(generatedBotTemplateFile).to.deep.equal(mockBotTemplateFile);
 
-    const generatedGenAiPlannerFile = parser.parse(
-      readFileSync(generatedGenAiPlannerFilePath, 'utf-8')
-    ) as GenAiPlannerExt;
-    const mockGenAiPlannerFile = parser.parse(readFileSync(mockGenAiPlannerFilePath, 'utf-8')) as GenAiPlannerExt;
-    expect(generatedGenAiPlannerFile).to.deep.equal(mockGenAiPlannerFile);
+    const generatedGenAiPlannerBundleFile = parser.parse(
+      readFileSync(generatedGenAiPlannerBundleFilePath, 'utf-8')
+    ) as GenAiPlannerBundleExt;
+    const mockGenAiPlannerBundleFile = parser.parse(
+      readFileSync(mockGenAiPlannerBundleFilePath, 'utf-8')
+    ) as GenAiPlannerBundleExt;
+    expect(generatedGenAiPlannerBundleFile).to.deep.equal(mockGenAiPlannerBundleFile);
   });
 });

test/mock-projects/agent-generate-template/MOCK-XML/force-app/main/default/genAiPlanners/Guest_Experience_Agent_v1_Template.genAiPlanner-meta.xml renamed to test/mock-projects/agent-generate-template/MOCK-XML/force-app/main/default/genAiPlannerBundles/Guest_Experience_Agent_v1_Template/Guest_Experience_Agent_v1_Template.genAiPlannerBundle

@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<GenAiPlanner xmlns="http://soap.sforce.com/2006/04/metadata">
+<GenAiPlannerBundle xmlns="http://soap.sforce.com/2006/04/metadata">
     <description>Deliver personalized customer interactions with an autonomous AI agent. Agentforce Service Agent intelligently supports your customers with common inquiries and escalates complex issues.</description>
     <genAiFunctions>
         <genAiFunctionName>EmployeeCopilot__AnswerQuestionsWithKnowledge</genAiFunctionName>
@@ -16,4 +16,4 @@
     <masterLabel>Guest Experience Agent</masterLabel>
     <plannerType>AiCopilot__ReAct</plannerType>
     <botTemplate>Guest_Experience_Agent_v1_Template</botTemplate>
-</GenAiPlanner>
+</GenAiPlannerBundle>