@salesforce/plugin-agent 1.19.5 → 1.20.0

package/oclif.manifest.json

@@ -105,10 +105,10 @@
     "agent:preview": {
       "aliases": [],
       "args": {},
-      "description": "XXX",
+      "description": "Use this command to have a natural language conversation with an active agent in your org, as if you were an actual user. The interface is simple: in the \"Start typing...\" prompt, enter a statement, question, or command; when you're done, enter Return. Your utterance is posted on the right along with a timestamp. The agent then responds on the left. To exit the conversation, hit ESC or Control+C.\n\nThis command is useful to test if the agent responds to your utterances as you expect. For example, you can test that the agent uses a particular topic when asked a question, and then whether it invokes the correct action associated with that topic. This command is the CLI-equivalent of the Conversation Preview panel in your org's Agent Builder UI.\n\nWhen 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 by setting the environment variable \"SF_AGENT_PREVIEW_OUTPUT_DIR\" to the directory. Or you can pass the directory to the --output-dir flag.\n\nFind the agent's API name in its main details page in your org's Agent page in Setup.\n\nBefore you use this command, you must complete these steps:\n\n1. Create a connected app in your org as described in the \"Create a Connected App\" section here: https://developer.salesforce.com/docs/einstein/genai/guide/agent-api-get-started.html#create-a-connected-app. Do these additional steps:\n\n   1. When specifying the connected app's Callback URL, add this second callback URL on a new line: http://localhost:1717/OauthRedirect\n\n   2. Make note of the user that you specified as the \"Run As\" user when updating the Client Credentials Flow section.\n\n2. Add the connected app to your agent as described in the \"Add Connected App to Agent\" section here: https://developer.salesforce.com/docs/einstein/genai/guide/agent-api-get-started.html#add-connected-app-to-agent.\n\n3. Using the username of the user you specified as the \"Run As\" user above, authorize your org using the JWT flow, as described in this document: https://developer.salesforce.com/docs/atlas.en-us.sfdx_dev.meta/sfdx_dev/sfdx_dev_auth_jwt_flow.htm.\n\n4. When you run this command to interact with an agent, specify the username you authorized in the preceding step with the --connected-app-user (-a) flag.",
       "examples": [
-        "<%= config.bin %> <%= command.id %> --name HelpDeskAgent",
-        "<%= config.bin %> <%= command.id %> --name ConciergeAgent --target-org production"
+        "Interact with an agent with API name \"Resort_Manager\" in the org with alias \"my-org\". Connect to your agent using the alias \"my-jwt-user\"; this alias must point to the username who is authorized using JWT:\n<%= config.bin %> <%= command.id %> --api-name \"Resort_Manager\" --target-org my-org --connected-app-user my-jwt-user",
+        "Same as the preceding example, but this time save the conversation transcripts to the \"./transcripts/my-preview\" directory rather than the default \"./temp/agent-preview\":\n<%= config.bin %> <%= command.id %> --api-name \"Resort_Manager\" --target-org my-org --connected-app-user my-jwt-user --output-dir \"transcripts/my-preview\""
       ],
       "flags": {
         "flags-dir": {
@@ -136,12 +136,28 @@
           "multiple": false,
           "type": "option"
         },
-        "name": {
-          "char": "n",
-          "description": "the API name of the agent? (TBD based on agents library)",
-          "name": "name",
+        "connected-app-user": {
+          "char": "a",
+          "name": "connected-app-user",
+          "noCacheDefault": true,
           "required": true,
-          "summary": "The name of the agent you want to preview",
+          "summary": "Username or alias of the connected app user that's configured with JWT-based access tokens to the agent.",
+          "hasDynamicHelp": true,
+          "multiple": false,
+          "type": "option"
+        },
+        "api-name": {
+          "char": "n",
+          "name": "api-name",
+          "summary": "API name of the agent you want to interact with.",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "output-dir": {
+          "char": "d",
+          "name": "output-dir",
+          "summary": "Directory where conversation transcripts are saved.",
           "hasDynamicHelp": false,
           "multiple": false,
           "type": "option"
@@ -153,8 +169,9 @@
       "pluginAlias": "@salesforce/plugin-agent",
       "pluginName": "@salesforce/plugin-agent",
       "pluginType": "core",
+      "state": "preview",
       "strict": true,
-      "summary": "Interact with an active agent, as a user would, to preview responses",
+      "summary": "Interact with an active agent to preview how the agent responds to your statements, questions, and commands (utterances).",
       "enableJsonFlag": false,
       "requiresProject": true,
       "isESM": true,
@@ -1095,5 +1112,5 @@
       ]
     }
   },
-  "version": "1.19.5"
+  "version": "1.20.0"
 }

package/package.json

@@ -1,19 +1,18 @@
 {
     "name": "@salesforce/plugin-agent",
     "description": "Commands to interact with Salesforce agents",
-    "version": "1.19.5",
+    "version": "1.20.0",
     "author": "Salesforce",
     "bugs": "https://github.com/forcedotcom/cli/issues",
     "dependencies": {
         "@inquirer/core": "^10.1.6",
-        "@inquirer/figures": "^1.0.7",
         "@inquirer/prompts": "^7.2.0",
         "@oclif/core": "^4",
         "@oclif/multi-stage-output": "^0.7.12",
-        "@salesforce/agents": "0.12.0",
-        "@salesforce/core": "^8.8.0",
+        "@salesforce/agents": "0.12.9",
+        "@salesforce/core": "^8.8.3",
         "@salesforce/kit": "^3.2.1",
-        "@salesforce/sf-plugins-core": "^12.1.0",
+        "@salesforce/sf-plugins-core": "^12.2.0",
         "@salesforce/source-deploy-retrieve": "^12.14.0",
         "@salesforce/types": "^1.3.0",
         "ansis": "^3.3.2",
@@ -28,8 +27,9 @@
         "@oclif/plugin-command-snapshot": "^5.2.19",
         "@oclif/test": "^4.1.0",
         "@salesforce/cli-plugins-testkit": "^5.3.35",
-        "@salesforce/dev-scripts": "^10.2.10",
+        "@salesforce/dev-scripts": "^10.2.12",
         "@salesforce/plugin-command-reference": "^3.1.29",
+        "@types/inquirer": "^9.0.7",
         "@types/react": "^18.3.3",
         "eslint-config-xo": "^0.45.0",
         "eslint-config-xo-react": "^0.27.0",
@@ -217,7 +217,7 @@
             "output": []
         },
         "link-check": {
-            "command": "node -e \"process.exit(process.env.CI ? 0 : 1)\" || linkinator \"**/*.md\" --skip \"CHANGELOG.md|node_modules|test/|confluence.internal.salesforce.com|my.salesforce.com|%s\" --markdown --retry --directory-listing --verbosity error",
+            "command": "node -e \"process.exit(process.env.CI ? 0 : 1)\" || linkinator \"**/*.md\" --skip \"CHANGELOG.md|node_modules|test/|confluence.internal.salesforce.com|my.salesforce.com|localhost|%s\" --markdown --retry --directory-listing --verbosity error",
             "files": [
                 "./*.md",
                 "./!(CHANGELOG).md",
@@ -229,7 +229,7 @@
     "exports": "./lib/index.js",
     "type": "module",
     "sfdx": {
-        "publicKeyUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-agent/1.19.5.crt",
-        "signatureUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-agent/1.19.5.sig"
+        "publicKeyUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-agent/1.20.0.crt",
+        "signatureUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-agent/1.20.0.sig"
     }
 }