Merge pull request #164 from forcedotcom/er/searchFileInMultipleDirectories

W-19838570: utility method to search for authoring bundles accepts array of directories

Author: EstebanRomero84

src/agent.ts

@@ -33,12 +33,12 @@ import {
   type BotActivationResponse,
   type BotMetadata,
   type BotVersionMetadata,
-  type CreateAfScriptResponse,
-  type CompileAfScriptResponse,
+  type CreateAgentResponse,
+  type CompileAgentResponse,
   type DraftAgentTopicsBody,
   type DraftAgentTopicsResponse,
   PublishAgentJsonResponse,
-  AfScript,
+  AgentString,
   PublishAgent,
 } from './types.js';
 import { MaybeMock } from './maybe-mock';
@@ -290,46 +290,46 @@ export class Agent {
   }
 
   /**
-   * Creates AF Script using agent job spec data.
+   * Creates Agent as string using agent job spec data.
    *
    * @param connection The connection to the org
    * @param agentJobSpec The agent specification data
-   * @returns Promise<AfScript> The generated AF Script as a string
+   * @returns Promise<AgentString> The generated Agent as a string
    * @beta
    */
-  public static async createAfScript(connection: Connection, agentJobSpec: AgentJobSpec): Promise<AfScript> {
+  public static async createAgent(connection: Connection, agentJobSpec: AgentJobSpec): Promise<AgentString> {
     const url = '/connect/ai-assist/create-af-script';
     const maybeMock = new MaybeMock(connection);
 
-    getLogger().debug(`Generating AF Script with agent spec data: ${JSON.stringify(agentJobSpec)}`);
+    getLogger().debug(`Generating Agent with spec data: ${JSON.stringify(agentJobSpec)}`);
 
-    const response = await maybeMock.request<CreateAfScriptResponse>('POST', url, agentJobSpec);
-    if (response.isSuccess && response.afScript) {
-      return response.afScript;
+    const response = await maybeMock.request<CreateAgentResponse>('POST', url, agentJobSpec);
+    if (response.isSuccess && response.agentString) {
+      return response.agentString;
     } else {
       throw SfError.create({
-        name: 'CreateAfScriptError',
+        name: 'CreateAgentError',
         message: response.errorMessage ?? 'unknown',
         data: response,
       });
     }
   }
 
   /**
-   * Creates agent JSON from compiling AF Script on the server.
+   * Creates agent JSON from compiling the Agent as a string on the server.
    *
    * @param connection The connection to the org
-   * @param afScript The agent AF Script as a string
+   * @param AgentString The agent Agent as a string
    * @returns Promise<string> The generated Agent JSON as a string
    * @beta
    */
-  public static async compileAfScript(connection: Connection, afScript: AfScript): Promise<AgentJson> {
+  public static async compileAgent(connection: Connection, agentString: AgentString): Promise<AgentJson> {
     const url = '/einstein/ai-agent/v1.1/authoring/compile';
     const maybeMock = new MaybeMock(connection);
 
-    getLogger().debug(`Generating Agent JSON with AF Script: ${afScript}`);
+    getLogger().debug(`Generating Agent JSON with: ${agentString}`);
 
-    const response = await maybeMock.request<CompileAfScriptResponse>('POST', url, { afScript });
+    const response = await maybeMock.request<CompileAgentResponse>('POST', url, { agentString });
     if (response.status === 'success') {
       return response.compiledArtifact;
     } else {
@@ -361,7 +361,7 @@ export class Agent {
     const maybeMock = new MaybeMock(connection);
     let developerName: string;
 
-    getLogger().debug('Publishing AfScript');
+    getLogger().debug('Publishing Agent');
 
     const url = '/einstein/ai-agent/v1.1/authoring/publish';
     const response = await maybeMock.request<PublishAgentJsonResponse>('POST', url, { agentJson });

src/index.ts

@@ -15,7 +15,7 @@
  */
 
 export {
-  type AfScript,
+  type AgentString,
   type AgentCreateConfig,
   type AgentCreateResponse,
   type AgentJobSpec,

src/types.ts

@@ -269,10 +269,10 @@ export type DraftAgentTopicsResponse = {
 /**
  * The response from the `create-af-script` API.
  */
-export type CreateAfScriptResponse = {
+export type CreateAgentResponse = {
   isSuccess: boolean;
   errorMessage?: string;
-  afScript?: AfScript;
+  agentString?: AgentString;
 };
 
 // ====================================================
@@ -604,7 +604,7 @@ export type AgentTraceResponse = {
   }>;
 };
 
-export type CompileAfScriptResponse = AgentCompilationSuccess | AgentCompilationError;
+export type CompileAgentResponse = AgentCompilationSuccess | AgentCompilationError;
 
 export type PublishAgentJsonResponse = {
   botVersionId: string;
@@ -708,4 +708,4 @@ export type AgentJson = {
   };
 };
 
-export type AfScript = string;
+export type AgentString = string;

src/utils.ts

@@ -78,13 +78,24 @@ export const decodeHtmlEntities = (str: string = ''): string => {
 };
 
 /**
- * Find the authoring bundle directory for a given bot name by recursively searching from a starting directory.
+ * Find the authoring bundle directory for a given bot name by recursively searching from a starting directory or directories.
  *
- * @param dir - The directory to start searching from
+ * @param dirOrDirs - The directory or array of directories to start searching from
  * @param botName - The name of the bot to find the authoring bundle directory for
  * @returns The path to the authoring bundle directory if found, undefined otherwise
  */
-export const findAuthoringBundle = (dir: string, botName: string): string | undefined => {
+export const findAuthoringBundle = (dirOrDirs: string | string[], botName: string): string | undefined => {
+  // If it's an array of directories, search in each one
+  if (Array.isArray(dirOrDirs)) {
+    for (const dir of dirOrDirs) {
+      const found = findAuthoringBundle(dir, botName);
+      if (found) return found;
+    }
+    return undefined;
+  }
+
+  // Single directory search logic
+  const dir = dirOrDirs;
   try {
     const files: string[] = readdirSync(dir);
 

test/agents.test.ts

@@ -58,11 +58,11 @@ describe('Agents', () => {
     expect(output.topics[0]).to.have.property('name', 'Guest_Experience_Enhancement');
   });
 
-  it('createAfScript (mock behavior) should return AF Script', async () => {
-    process.env.SF_MOCK_DIR = join('test', 'mocks', 'createAfScript');
+  it('createAgent (mock behavior) should return an Agent as a string', async () => {
+    process.env.SF_MOCK_DIR = join('test', 'mocks', 'createAgent');
     const agentType = 'customer';
     const companyName = 'Coral Cloud Enterprises';
-    const output = await Agent.createAfScript(connection, {
+    const output = await Agent.createAgent(connection, {
       agentType,
       role: 'answer questions about vacation_rentals',
       companyName,
@@ -83,7 +83,7 @@ describe('Agents', () => {
 
   it('createAgentJson (mock behavior) should return full agent json', async () => {
     process.env.SF_MOCK_DIR = join('test', 'mocks');
-    const output = await Agent.compileAfScript(connection, 'AF Script string');
+    const output = await Agent.compileAgent(connection, 'Agent string');
     expect(output).to.have.property('schemaVersion', '2.0');
     expect(output).to.have.property('globalConfiguration').and.be.an('object');
     expect(output).to.have.property('agentVersion').and.be.an('object');

test/mocks/connect_ai-assist_create-af-script.json

@@ -1,4 +1,133 @@
 {
   "isSuccess": true,
-  "afScript": "system:\n    @prompt:\n        You are a helpful AI assistant.\n\nconfig:\n    @agent_id: \"test_agent_001\"\n    @agent_name: \"Test_Agent\"\n    user_locale: en_US\n\ntrigger default:\n    initial_node: greeting\n\nvariables:\n    user_name: string = \"Guest\"\n    counter: int = 0\n\nblock greeting:\n    @prompt:\n        Hello! How can I help you today?\n\nblock help:\n    @prompt:\n        I'm here to assist you with any questions.\n\nfunctions:\n    test_function:\n        description: \"A simple test function\"\n"
+  "agentJson": {
+    "schemaVersion": "1.0",
+    "globalConfiguration": {
+      "developerName": "simple_response_agentV1",
+      "label": "Simple Response Agent",
+      "description": "A simple agent that responds to user queries.",
+      "enableEnhancedEventLogs": false,
+      "agentType": "AgentforceServiceAgent",
+      "templateName": null,
+      "defaultAgentUser": null,
+      "defaultOutboundRouting": null,
+      "contextVariables": [
+        {
+          "developerName": "some_id",
+          "label": "Some ID",
+          "description": "The some id",
+          "dataType": "string",
+          "fieldMapping": null
+        }
+      ]
+    },
+    "agentVersion": {
+      "developerName": "simple_response_agentV1",
+      "plannerType": "Atlas__ConcurrentMultiAgentOrchestration",
+      "systemMessages": [
+        {
+          "message": "Hello! I'm your SimpleResponseAgent. How can I help you today?",
+          "messageType": "Welcome"
+        },
+        {
+          "message": "I'm sorry, I'm having trouble processing your request. Please try again later.",
+          "messageType": "Error"
+        }
+      ],
+      "modalityParameters": {
+        "voice": null,
+        "language": {
+          "defaultLocale": "en-US",
+          "additionalLocales": null,
+          "allAdditionalLocales": false
+        }
+      },
+      "additional_parameters": null,
+      "company": "A simple company that responds to user queries.",
+      "role": "A simple agent that responds to user queries.",
+      "stateVariables": [
+        {
+          "developerName": "user_query",
+          "label": "User Query",
+          "description": "The user's query",
+          "dataType": "string",
+          "isList": false,
+          "default": "",
+          "visibility": "Internal"
+        },
+        {
+          "developerName": "response",
+          "label": "Response",
+          "description": "The response to the user",
+          "dataType": "string",
+          "isList": false,
+          "default": "",
+          "visibility": "Internal"
+        },
+        {
+          "developerName": "processing_complete",
+          "label": "Processing Complete",
+          "description": "Whether processing is complete",
+          "dataType": "boolean",
+          "isList": false,
+          "default": false,
+          "visibility": "Internal"
+        }
+      ],
+      "initialNode": "process_query",
+      "nodes": [
+        {
+          "type": "subagent",
+          "reasoningType": "salesforce.default",
+          "description": "Process the user's query",
+          "beforeReasoning": null,
+          "instructions": "\n  # CONTEXT\n  Name: {agentName:-\"Simple Agent\"}\n  Description: {agent_description:-\"You are an AI assistant developed by Salesforce\"}\n  Role: {agentLabel:-\"You are an AI assistant developed by Salesforce\"}\n  Tone: Maintain a {agent_plannerToneType:-\"NEUTRAL\"} tone while being clear and helpful.\n  Company: {agent_company:-\"Salesforce\"}\n  Locale: {agentLocale:-\"English (United States)\"}\n  Location: {agent_userLocation:-\"United States\"}\n  Current Date/Time: {current_dateTime:-\"\"}\n ",
+          "focusPrompt": null,
+          "tools": [
+            {
+              "type": "action",
+              "target": "set_response_action",
+              "boundInputs": {
+                "some_id": "context.some_id"
+              },
+              "llmInputs": null,
+              "enabled": null,
+              "stateUpdates": [
+                {
+                  "response": "result.response"
+                },
+                {
+                  "processingComplete": "true"
+                }
+              ],
+              "name": "set_response",
+              "description": null,
+              "inputParameters": null
+            }
+          ],
+          "preToolCall": null,
+          "postToolCall": null,
+          "afterReasoning": null,
+          "developerName": "process_query",
+          "label": "Process Query",
+          "onInit": null,
+          "transitions": [
+            {
+              "target": "exit",
+              "condition": "state.processing_complete == true",
+              "alias": null,
+              "enabled": null,
+              "instruction": null,
+              "type": "handoff",
+              "mode": "manual"
+            }
+          ],
+          "onExit": null,
+          "actionDefinitions": [],
+          "knowledgeDefinitions": null
+        }
+      ],
+      "knowledgeDefinitions": null
+    }
+  }
 }