Merge pull request #296 from salesforcecli/wr/refactor

Wr/refactor @W-20812411@

Author: WillieRuemmele

README.md

@@ -513,8 +513,6 @@ USAGE
     [--authoring-bundle <value>] [-d <value>] [-x] [--use-live-actions]
 
 FLAGS
-  -c, --client-app=<value>        Name of the linked client app to use for the connection to the published and active
-                                  agent.
   -d, --output-dir=<value>        Directory where conversation transcripts are saved.
   -n, --api-name=<value>          API name of the published and active agent you want to interact with.
   -o, --target-org=<value>        (required) Username or alias of the target org. Not required if the `target-org`
@@ -560,14 +558,6 @@ DESCRIPTION
   the files are saved to the "./temp/agent-preview" directory. Specify a new default directory with the --output-dir
   flag.
 
-  NOTE: You can also use this command to connect to a published and active agent, which are labeled "(Published)" if you
-  let this command provide the list of agents to preview. That use case, however, requires additional security and
-  configuration in both your org and your DX project. The examples in this help are for previewing an agent from its
-  Agent Script file in your DX project and require only simple authorization of your org, such as with the "org login
-  web" command. The --client-app and --api-name flags are used only for previewing published and active agents, they
-  don't apply to Agent Script agents. See "Connect to a Published Agent" in the "Agentforce Developer Guide" for
-  complete documentation: https://developer.salesforce.com/docs/einstein/genai/guide/agent-dx-preview.html.
-
 EXAMPLES
   Preview an agent in simulated mode by choosing from a list of authoring bundles provided by the command; use the org
   with alias "my-dev-org":

command-snapshot.json

@@ -79,13 +79,12 @@
     "alias": [],
     "command": "agent:preview",
     "flagAliases": [],
-    "flagChars": ["c", "d", "n", "o", "x"],
+    "flagChars": ["d", "n", "o", "x"],
     "flags": [
       "apex-debug",
       "api-name",
       "api-version",
       "authoring-bundle",
-      "client-app",
       "flags-dir",
       "output-dir",
       "target-org",

messages/agent.preview.md

@@ -17,8 +17,6 @@ The interface is simple: in the "Start typing..." prompt, enter a statement, que
 
 When the session concludes, the command asks if you want to save the API responses and chat transcripts. By default, the files are saved to the "./temp/agent-preview" directory. Specify a new default directory with the --output-dir flag.
 
-NOTE: You can also use this command to connect to a published and active agent, which are labeled "(Published)" if you let this command provide the list of agents to preview. That use case, however, requires additional security and configuration in both your org and your DX project. The examples in this help are for previewing an agent from its Agent Script file in your DX project and require only simple authorization of your org, such as with the "org login web" command. The --client-app and --api-name flags are used only for previewing published and active agents, they don't apply to Agent Script agents. See "Connect to a Published Agent" in the "Agentforce Developer Guide" for complete documentation: https://developer.salesforce.com/docs/einstein/genai/guide/agent-dx-preview.html.
-
 # flags.api-name.summary
 
 API name of the published and active agent you want to interact with.
@@ -27,10 +25,6 @@ API name of the published and active agent you want to interact with.
 
 API name of the authoring bundle metadata component that contains the agent's Agent Script file.
 
-# flags.client-app.summary
-
-Name of the linked client app to use for the connection to the published and active agent.
-
 # flags.output-dir.summary
 
 Directory where conversation transcripts are saved.

package.json

@@ -9,7 +9,7 @@
     "@inquirer/prompts": "^7.10.1",
     "@oclif/core": "^4",
     "@oclif/multi-stage-output": "^0.8.29",
-    "@salesforce/agents": "^0.20.0",
+    "@salesforce/agents": "^0.21.1",
     "@salesforce/core": "^8.24.3",
     "@salesforce/kit": "^3.2.3",
     "@salesforce/sf-plugins-core": "^12.2.6",

src/agentActivation.ts

@@ -14,8 +14,8 @@
  * limitations under the License.
  */
 
-import { Connection, Messages, Org, SfError } from '@salesforce/core';
-import { Agent, type BotMetadata } from '@salesforce/agents';
+import { Messages, Org, SfError, SfProject } from '@salesforce/core';
+import { Agent, type BotMetadata, ProductionAgent } from '@salesforce/agents';
 import { select } from '@inquirer/prompts';
 
 type Choice<Value> = {
@@ -67,16 +67,15 @@ export const getAgentChoices = (agents: BotMetadata[], status: 'Active' | 'Inact
   });
 
 export const getAgentForActivation = async (config: {
-  conn: Connection;
   targetOrg: Org;
   status: 'Active' | 'Inactive';
   apiNameFlag?: string;
-}): Promise<Agent> => {
-  const { conn, targetOrg, status, apiNameFlag } = config;
+}): Promise<ProductionAgent> => {
+  const { targetOrg, status, apiNameFlag } = config;
 
   let agentsInOrg: BotMetadata[] = [];
   try {
-    agentsInOrg = await Agent.listRemote(conn);
+    agentsInOrg = await Agent.listRemote(targetOrg.getConnection());
   } catch (error) {
     throw SfError.create({
       message: 'Error listing agents in org',
@@ -105,5 +104,9 @@ export const getAgentForActivation = async (config: {
     selectedAgent = agentsInOrg.find((agent) => agent.DeveloperName === agentChoice.DeveloperName);
   }
 
-  return new Agent({ connection: conn, nameOrId: selectedAgent!.Id });
+  return Agent.init({
+    connection: targetOrg.getConnection(),
+    apiNameOrId: selectedAgent!.Id,
+    project: SfProject.getInstance(),
+  });
 };

src/commands/agent/activate.ts

@@ -39,13 +39,12 @@ export default class AgentActivate extends SfCommand<void> {
 
     const apiNameFlag = flags['api-name'];
     const targetOrg = flags['target-org'];
-    const conn = targetOrg.getConnection(flags['api-version']);
 
     if (!apiNameFlag && this.jsonEnabled()) {
       throw messages.createError('error.missingRequiredFlags', ['api-name']);
     }
 
-    const agent = await getAgentForActivation({ conn, targetOrg, status: 'Active', apiNameFlag });
+    const agent = await getAgentForActivation({ targetOrg, status: 'Active', apiNameFlag });
     await agent.activate();
     const agentName = (await agent.getBotMetadata()).DeveloperName;
 

src/commands/agent/deactivate.ts

@@ -39,13 +39,12 @@ export default class AgentDeactivate extends SfCommand<void> {
 
     const apiNameFlag = flags['api-name'];
     const targetOrg = flags['target-org'];
-    const conn = targetOrg.getConnection(flags['api-version']);
 
     if (!apiNameFlag && this.jsonEnabled()) {
       throw messages.createError('error.missingRequiredFlags', ['api-name']);
     }
 
-    const agent = await getAgentForActivation({ conn, targetOrg, status: 'Inactive', apiNameFlag });
+    const agent = await getAgentForActivation({ targetOrg, status: 'Inactive', apiNameFlag });
     await agent.deactivate();
     const agentName = (await agent.getBotMetadata()).DeveloperName;
 

src/commands/agent/generate/authoring-bundle.ts

@@ -18,7 +18,7 @@ import { join, resolve } from 'node:path';
 import { readFileSync, existsSync } from 'node:fs';
 import { SfCommand, Flags } from '@salesforce/sf-plugins-core';
 import { generateApiName, Messages, SfError } from '@salesforce/core';
-import { Agent, AgentJobSpec } from '@salesforce/agents';
+import { AgentJobSpec, ScriptAgent } from '@salesforce/agents';
 import YAML from 'yaml';
 import { input as inquirerInput } from '@inquirer/prompts';
 import { theme } from '../../../inquirer-theme.js';
@@ -102,7 +102,7 @@ export default class AgentGenerateAuthoringBundle extends SfCommand<AgentGenerat
 
   public async run(): Promise<AgentGenerateAuthoringBundleResult> {
     const { flags } = await this.parse(AgentGenerateAuthoringBundle);
-    const { 'output-dir': outputDir, 'target-org': targetOrg } = flags;
+    const { 'output-dir': outputDir } = flags;
 
     // If we don't have a spec yet, prompt for it
     const spec = flags.spec ?? (await promptForYamlFile(AgentGenerateAuthoringBundle.FLAGGABLE_PROMPTS['spec']));
@@ -135,10 +135,8 @@ export default class AgentGenerateAuthoringBundle extends SfCommand<AgentGenerat
       const metaXmlPath = join(targetOutputDir, `${bundleApiName}.bundle-meta.xml`);
 
       // Write Agent file
-      const conn = targetOrg.getConnection(flags['api-version']);
       const specContents = YAML.parse(readFileSync(spec, 'utf8')) as AgentJobSpec;
-      await Agent.createAuthoringBundle({
-        connection: conn,
+      await ScriptAgent.createAuthoringBundle({
         agentSpec: { ...specContents, ...{ name, developerName: bundleApiName } },
         project: this.project!,
         bundleApiName,