fix: deprecate 'org open authoring-bundle' expand 'org open agent'

Author: WillieRuemmele

command-snapshot.json

@@ -150,7 +150,18 @@
     "command": "org:open:agent",
     "flagAliases": ["urlonly"],
     "flagChars": ["b", "n", "o", "r"],
-    "flags": ["api-name", "api-version", "browser", "flags-dir", "json", "private", "target-org", "url-only"],
+    "flags": [
+      "api-name",
+      "api-version",
+      "authoring-bundle",
+      "browser",
+      "flags-dir",
+      "json",
+      "private",
+      "target-org",
+      "url-only",
+      "version"
+    ],
     "plugin": "@salesforce/plugin-org"
   },
   {

messages/open.agent.md

@@ -4,11 +4,16 @@ Open an agent in your org's Agent Builder UI in a browser.
 
 # description
 
-Use the --api-name flag to open an agent using its API name in the Agent Builder UI of your org. To find the agent's API name, go to Setup in your org and navigate to the agent's details page.
+Use the --api-name flag to open an agent using its API name in the Agent Builder UI of your org. To find the agent's API
+name, go to Setup in your org and navigate to the agent's details page.
+
+Alternatively, use the --authoring-bundle flag to open an agent in Agentforce Builder. Optionally include --version to
+open a specific version of the agent. You'll specify the api name of the authoring bundle.
 
 To generate the URL but not launch it in your browser, specify --url-only.
 
-To open Agent Builder in a specific browser, use the --browser flag. Supported browsers are "chrome", "edge", and "firefox". If you don't specify --browser, the org opens in your default browser.
+To open Agent Builder in a specific browser, use the --browser flag. Supported browsers are "chrome", "edge", and "
+firefox". If you don't specify --browser, the org opens in your default browser.
 
 # examples
 
@@ -24,6 +29,14 @@ To open Agent Builder in a specific browser, use the --browser flag. Supported b
 
   $ <%= config.bin %> <%= command.id %> --target-org MyTestOrg1 --browser firefox --api-name Coral_Cloud_Agent
 
+- Open an agent in Agentforce Builder using its authoring bundle name:
+
+  $ <%= config.bin %> <%= command.id %> --authoring-bundle MyAgent
+
+- Open a specific version of an agent in Agentforce Builder:
+
+  $ <%= config.bin %> <%= command.id %> --authoring-bundle MyAgent --version 1
+
 # flags.api-name.summary
 
 API name, also known as developer name, of the agent you want to open in the org's Agent Builder UI.
@@ -39,3 +52,21 @@ Browser where the org opens.
 # flags.url-only.summary
 
 Display navigation URL, but don’t launch browser.
+
+# flags.authoring-bundle.summary
+
+API name of the agent to open in Agentforce Builder.
+
+# flags.authoring-bundle.description
+
+The API name of the agent to open directly in Agentforce Builder. Optionally specify --version to open a specific
+version.
+
+# flags.version.summary
+
+Version number of the agent to open in Agentforce Builder.
+
+# flags.version.description
+
+The version number of the agent to open directly in Agentforce Builder. Can only be used with the --authoring-bundle
+flag.

src/commands/org/open/agent.ts

@@ -34,7 +34,7 @@ export class OrgOpenAgent extends OrgOpenCommandBase<OrgOpenOutput> {
     'api-name': Flags.string({
       char: 'n',
       summary: messages.getMessage('flags.api-name.summary'),
-      required: true,
+      exactlyOne: ['api-name', 'authoring-bundle'],
     }),
     private: Flags.boolean({
       summary: messages.getMessage('flags.private.summary'),
@@ -52,16 +52,39 @@ export class OrgOpenAgent extends OrgOpenCommandBase<OrgOpenOutput> {
       aliases: ['urlonly'],
       deprecateAliases: true,
     }),
+    'authoring-bundle': Flags.string({
+      summary: messages.getMessage('flags.authoring-bundle.summary'),
+      description: messages.getMessage('flags.authoring-bundle.description'),
+      exactlyOne: ['api-name', 'authoring-bundle'],
+    }),
+    version: Flags.string({
+      summary: messages.getMessage('flags.version.summary'),
+      description: messages.getMessage('flags.version.description'),
+      dependsOn: ['authoring-bundle'],
+    }),
   };
 
   public async run(): Promise<OrgOpenOutput> {
     const { flags } = await this.parse(OrgOpenAgent);
     this.org = flags['target-org'];
     this.connection = this.org.getConnection(flags['api-version']);
 
-    const agentBuilderRedirect = await buildRetUrl(this.connection, flags['api-name']);
+    let path: string;
+    if (flags['api-name']) {
+      path = await buildRetUrl(this.connection, flags['api-name']);
+    } else {
+      // authoring-bundle is provided
+      const queryParams = new URLSearchParams({
+        // flags.authoring-bundle guaranteed by OCLIF definition
+        projectName: flags['authoring-bundle']!,
+      });
+      if (flags.version) {
+        queryParams.set('projectVersionNumber', flags.version);
+      }
+      path = `AgentAuthoring/agentAuthoringBuilder.app#/project?${queryParams.toString()}`;
+    }
 
-    return this.openOrgUI(flags, await this.org.getFrontDoorUrl(agentBuilderRedirect));
+    return this.openOrgUI(flags, await this.org.getFrontDoorUrl(path));
   }
 }
 

src/commands/org/open/authoring-bundle.ts

@@ -26,6 +26,8 @@ export class OrgOpenAuthoringBundle extends OrgOpenCommandBase<OrgOpenOutput> {
   public static readonly summary = messages.getMessage('summary');
   public static readonly description = messages.getMessage('description');
   public static readonly examples = messages.getMessages('examples');
+  public static readonly state = 'deprecated';
+  public static readonly deprecationOptions = { to: 'org open agent --authoring-bundle' };
 
   public static readonly flags = {
     ...OrgOpenCommandBase.flags,