@salesforce/plugin-agent 1.3.2

package/LICENSE.txt

@@ -0,0 +1,12 @@
+Copyright (c) 2024, Salesforce.com, Inc.
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+
+* Neither the name of Salesforce.com nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

package/README.md

@@ -0,0 +1,223 @@
+# plugin-agent - PREVIEW
+
+### THIS PLUGIN IS A PREVIEW VERSION AND IS NOT MEANT FOR PRODUCTION USAGE UNTIL ANNOUNCED.
+
+[![NPM](https://img.shields.io/npm/v/@salesforce/plugin-agent.svg?label=@salesforce/plugin-agent)](https://www.npmjs.com/package/@salesforce/plugin-agent) [![Downloads/week](https://img.shields.io/npm/dw/@salesforce/plugin-agent.svg)](https://npmjs.org/package/@salesforce/plugin-agent) [![License](https://img.shields.io/badge/License-BSD%203--Clause-brightgreen.svg)](https://raw.githubusercontent.com/salesforcecli/plugin-agent/main/LICENSE.txt)
+
+## Install
+
+```bash
+sf plugins install @salesforce/plugin-agent@x.y.z
+```
+
+## Contributing
+
+1. Please read our [Code of Conduct](CODE_OF_CONDUCT.md)
+2. Create a new issue before starting your project so that we can keep track of
+   what you are trying to add/fix. That way, we can also offer suggestions or
+   let you know if there is already an effort in progress.
+3. Fork this repository.
+4. [Build the plugin locally](#build)
+5. Create a _topic_ branch in your fork. Note, this step is recommended but technically not required if contributing using a fork.
+6. Edit the code in your fork.
+7. Write appropriate tests for your changes. Try to achieve at least 95% code coverage on any new code. No pull request will be accepted without unit tests.
+8. Sign CLA (see [CLA](#cla) below).
+9. Send us a pull request when you are done. We'll review your code, suggest any needed changes, and merge it in.
+
+### CLA
+
+External contributors will be required to sign a Contributor's License
+Agreement. You can do so by going to https://cla.salesforce.com/sign-cla.
+
+### Build
+
+To build the plugin locally, make sure to have yarn installed and run the following commands:
+
+```bash
+# Clone the repository
+git clone git@github.com:salesforcecli/plugin-agent
+
+# Install the dependencies and compile
+yarn && yarn build
+```
+
+To use your plugin, run using the local `./bin/dev.js` or `./bin/dev.cmd` file.
+
+```bash
+# Run using local run file.
+./bin/dev.js agent
+```
+
+There should be no differences when running via the Salesforce CLI or using the local run file. However, it can be useful to link the plugin to do some additional testing or run your commands from anywhere on your machine.
+
+```bash
+# Link your plugin to the sf cli
+sf plugins link .
+# To verify
+sf plugins
+```
+
+## Commands
+
+<!-- commands -->
+
+- [`sf agent create`](#sf-agent-create)
+- [`sf agent generate spec`](#sf-agent-generate-spec)
+- [`sf agent test cancel`](#sf-agent-test-cancel)
+- [`sf agent test run`](#sf-agent-test-run)
+
+## `sf agent create`
+
+Create an Agent from an agent spec.
+
+```
+USAGE
+  $ sf agent create -o <value> -f <value> -n <value> [--json] [--flags-dir <value>] [--api-version <value>]
+
+FLAGS
+  -f, --job-spec=<value>     (required) The path to an agent spec file.
+  -n, --name=<value>         (required) The name of the agent.
+  -o, --target-org=<value>   (required) Username or alias of the target org. Not required if the `target-org`
+                             configuration variable is already set.
+      --api-version=<value>  Override the api version used for api requests made by this command
+
+GLOBAL FLAGS
+  --flags-dir=<value>  Import flag values from a directory.
+  --json               Format output as json.
+
+DESCRIPTION
+  Create an Agent from an agent spec.
+
+  Create an Agent from an agent spec. Agent metadata is created in the target org and retrieved to the local project.
+
+EXAMPLES
+  Create an Agent:
+
+    $ sf agent create --spec ./agent-spec.json
+
+FLAG DESCRIPTIONS
+  -f, --job-spec=<value>  The path to an agent spec file.
+
+    The agent spec file defines job titles and descriptions for the agent and can be created using the `sf agent create
+    spec` command.
+```
+
+_See code: [src/commands/agent/create.ts](https://github.com/salesforcecli/plugin-agent/blob/1.3.2/src/commands/agent/create.ts)_
+
+## `sf agent generate spec`
+
+Create an Agent spec.
+
+```
+USAGE
+  $ sf agent generate spec -o <value> [--json] [--flags-dir <value>] [--api-version <value>] [-t
+    customer_facing|employee_facing] [--role <value>] [--company-name <value>] [--company-description <value>]
+    [--company-website <value>] [-d <value>] [-f <value>]
+
+FLAGS
+  -d, --output-dir=<value>           [default: config] The location within the project where the agent spec will be
+                                     written.
+  -f, --file-name=<value>            [default: agentSpec.json] The name of the file to write the agent spec to.
+  -o, --target-org=<value>           (required) Username or alias of the target org. Not required if the `target-org`
+                                     configuration variable is already set.
+  -t, --type=<option>                The type of agent to create.
+                                     <options: customer_facing|employee_facing>
+      --api-version=<value>          Override the api version used for api requests made by this command
+      --company-description=<value>  The description of the company, containing details to be used when generating agent
+                                     job descriptions.
+      --company-name=<value>         The name of the company.
+      --company-website=<value>      The website URL for the company.
+      --role=<value>                 The role of the agent.
+
+GLOBAL FLAGS
+  --flags-dir=<value>  Import flag values from a directory.
+  --json               Format output as json.
+
+DESCRIPTION
+  Create an Agent spec.
+
+  Create an Agent spec, which is a list of job titles and descriptions that the agent performs.
+
+EXAMPLES
+  Create an Agent spec in the default location:
+
+    $ sf agent generate spec --type customer_facing --role Support --company-name "Coral Cloud" \
+      --company-description "A meaningful description"
+```
+
+_See code: [src/commands/agent/generate/spec.ts](https://github.com/salesforcecli/plugin-agent/blob/1.3.2/src/commands/agent/generate/spec.ts)_
+
+## `sf agent test cancel`
+
+Cancel a running test for an Agent.
+
+```
+USAGE
+  $ sf agent test cancel -o <value> -i <value> [--json] [--flags-dir <value>] [-r]
+
+FLAGS
+  -i, --job-id=<value>      (required) The AiEvaluation ID.
+  -o, --target-org=<value>  (required) Username or alias of the target org. Not required if the `target-org`
+                            configuration variable is already set.
+  -r, --use-most-recent     Use the job ID of the most recent test evaluation.
+
+GLOBAL FLAGS
+  --flags-dir=<value>  Import flag values from a directory.
+  --json               Format output as json.
+
+DESCRIPTION
+  Cancel a running test for an Agent.
+
+  Cancel a running test for an Agent, providing the AiEvaluation ID.
+
+EXAMPLES
+  Cancel a test for an Agent:
+
+    $ sf agent test cancel --id AiEvalId
+```
+
+_See code: [src/commands/agent/test/cancel.ts](https://github.com/salesforcecli/plugin-agent/blob/1.3.2/src/commands/agent/test/cancel.ts)_
+
+## `sf agent test run`
+
+Start a test for an Agent.
+
+```
+USAGE
+  $ sf agent test run -o <value> -i <value> [--json] [--flags-dir <value>] [-w <value>] [-d <value>]
+
+FLAGS
+  -d, --output-dir=<value>  Directory in which to store test run files.
+  -i, --id=<value>          (required) The AiEvalDefinitionVersion ID.
+  -o, --target-org=<value>  (required) Username or alias of the target org. Not required if the `target-org`
+                            configuration variable is already set.
+  -w, --wait=<value>        Number of minutes to wait for the command to complete and display results to the terminal
+                            window.
+
+GLOBAL FLAGS
+  --flags-dir=<value>  Import flag values from a directory.
+  --json               Format output as json.
+
+DESCRIPTION
+  Start a test for an Agent.
+
+  Start a test for an Agent, providing the AiEvalDefinitionVersion ID. Returns the job ID.
+
+EXAMPLES
+  Start a test for an Agent:
+
+    $ sf agent test run --id AiEvalDefVerId
+
+FLAG DESCRIPTIONS
+  -i, --id=<value>  The AiEvalDefinitionVersion ID.
+
+    The AiEvalDefinitionVersion ID.
+
+  -w, --wait=<value>  Number of minutes to wait for the command to complete and display results to the terminal window.
+
+    If the command continues to run after the wait period, the CLI returns control of the terminal window to you.
+```
+
+_See code: [src/commands/agent/test/run.ts](https://github.com/salesforcecli/plugin-agent/blob/1.3.2/src/commands/agent/test/run.ts)_
+
+<!-- commandsstop -->

package/lib/commands/agent/create.d.ts

@@ -0,0 +1,17 @@
+import { SfCommand } from '@salesforce/sf-plugins-core';
+export type AgentCreateResult = {
+    isSuccess: boolean;
+    errorMessage?: string;
+};
+export default class AgentCreate extends SfCommand<AgentCreateResult> {
+    static readonly summary: string;
+    static readonly description: string;
+    static readonly examples: string[];
+    static readonly flags: {
+        'target-org': import("@oclif/core/interfaces").OptionFlag<import("@salesforce/core").Org, import("@oclif/core/interfaces").CustomOptions>;
+        'api-version': import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        'job-spec': import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
+        name: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
+    };
+    run(): Promise<AgentCreateResult>;
+}

package/lib/commands/agent/create.js

@@ -0,0 +1,65 @@
+/*
+ * Copyright (c) 2024, salesforce.com, inc.
+ * All rights reserved.
+ * Licensed under the BSD 3-Clause license.
+ * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+ */
+import { SfCommand, Flags } from '@salesforce/sf-plugins-core';
+import { Messages } from '@salesforce/core';
+import { Duration, sleep } from '@salesforce/kit';
+import { MultiStageOutput } from '@oclif/multi-stage-output';
+import { colorize } from '@oclif/core/ux';
+Messages.importMessagesDirectoryFromMetaUrl(import.meta.url);
+const messages = Messages.loadMessages('@salesforce/plugin-agent', 'agent.create');
+// There is no API for this yet. It's being planned/built by the Agent Creator team.
+// However, we could possibly use:
+//   /services/data/{api-version}/connect/attach-agent-topics
+export default class AgentCreate extends SfCommand {
+    static summary = messages.getMessage('summary');
+    static description = messages.getMessage('description');
+    static examples = messages.getMessages('examples');
+    static flags = {
+        'target-org': Flags.requiredOrg(),
+        'api-version': Flags.orgApiVersion(),
+        'job-spec': Flags.file({
+            char: 'f',
+            required: true,
+            summary: messages.getMessage('flags.job-spec.summary'),
+            description: messages.getMessage('flags.job-spec.description'),
+        }),
+        name: Flags.string({
+            char: 'n',
+            required: true,
+            summary: messages.getMessage('flags.name.summary'),
+        }),
+    };
+    async run() {
+        const { flags } = await this.parse(AgentCreate);
+        const jsonParsingStage = `Parsing ${flags['job-spec']}`;
+        const mso = new MultiStageOutput({
+            jsonEnabled: this.jsonEnabled(),
+            title: `Creating ${flags.name} Agent`,
+            stages: [
+                jsonParsingStage,
+                'Generating GenAiPlanner metadata',
+                'Creating agent in org',
+                'Retrieving agent metadata',
+            ],
+        });
+        mso.goto(jsonParsingStage);
+        await sleep(Duration.milliseconds(200));
+        mso.goto('Generating GenAiPlanner metadata');
+        await sleep(Duration.milliseconds(200));
+        mso.goto('Creating agent in org');
+        // POST to /services/data/{api-version}/connect/attach-agent-topics
+        // To simulate time spent on the server generating the spec.
+        await sleep(Duration.seconds(5));
+        mso.goto('Retrieving agent metadata');
+        await sleep(Duration.seconds(3));
+        mso.stop();
+        this.log(colorize('green', `Successfully created ${flags.name} in ${flags['target-org'].getUsername() ?? 'the target org'}.`));
+        this.log(`Use ${colorize('dim', `sf org open agent --name ${flags.name}`)} to view the agent in the browser.`);
+        return { isSuccess: true };
+    }
+}
+//# sourceMappingURL=create.js.map

package/lib/commands/agent/create.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"create.js","sourceRoot":"","sources":["../../../src/commands/agent/create.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EAAE,SAAS,EAAE,KAAK,EAAE,MAAM,6BAA6B,CAAC;AAC/D,OAAO,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAC5C,OAAO,EAAE,QAAQ,EAAE,KAAK,EAAE,MAAM,iBAAiB,CAAC;AAClD,OAAO,EAAE,gBAAgB,EAAE,MAAM,2BAA2B,CAAC;AAC7D,OAAO,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAE1C,QAAQ,CAAC,kCAAkC,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AAC7D,MAAM,QAAQ,GAAG,QAAQ,CAAC,YAAY,CAAC,0BAA0B,EAAE,cAAc,CAAC,CAAC;AAOnF,oFAAoF;AACpF,kCAAkC;AAClC,6DAA6D;AAE7D,MAAM,CAAC,OAAO,OAAO,WAAY,SAAQ,SAA4B;IAC5D,MAAM,CAAU,OAAO,GAAG,QAAQ,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC;IACzD,MAAM,CAAU,WAAW,GAAG,QAAQ,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC;IACjE,MAAM,CAAU,QAAQ,GAAG,QAAQ,CAAC,WAAW,CAAC,UAAU,CAAC,CAAC;IAE5D,MAAM,CAAU,KAAK,GAAG;QAC7B,YAAY,EAAE,KAAK,CAAC,WAAW,EAAE;QACjC,aAAa,EAAE,KAAK,CAAC,aAAa,EAAE;QACpC,UAAU,EAAE,KAAK,CAAC,IAAI,CAAC;YACrB,IAAI,EAAE,GAAG;YACT,QAAQ,EAAE,IAAI;YACd,OAAO,EAAE,QAAQ,CAAC,UAAU,CAAC,wBAAwB,CAAC;YACtD,WAAW,EAAE,QAAQ,CAAC,UAAU,CAAC,4BAA4B,CAAC;SAC/D,CAAC;QACF,IAAI,EAAE,KAAK,CAAC,MAAM,CAAC;YACjB,IAAI,EAAE,GAAG;YACT,QAAQ,EAAE,IAAI;YACd,OAAO,EAAE,QAAQ,CAAC,UAAU,CAAC,oBAAoB,CAAC;SACnD,CAAC;KACH,CAAC;IAEK,KAAK,CAAC,GAAG;QACd,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC;QAChD,MAAM,gBAAgB,GAAG,WAAW,KAAK,CAAC,UAAU,CAAC,EAAE,CAAC;QACxD,MAAM,GAAG,GAAG,IAAI,gBAAgB,CAAC;YAC/B,WAAW,EAAE,IAAI,CAAC,WAAW,EAAE;YAC/B,KAAK,EAAE,YAAY,KAAK,CAAC,IAAI,QAAQ;YACrC,MAAM,EAAE;gBACN,gBAAgB;gBAChB,kCAAkC;gBAClC,uBAAuB;gBACvB,2BAA2B;aAC5B;SACF,CAAC,CAAC;QAEH,GAAG,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;QAC3B,MAAM,KAAK,CAAC,QAAQ,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC,CAAC;QAExC,GAAG,CAAC,IAAI,CAAC,kCAAkC,CAAC,CAAC;QAC7C,MAAM,KAAK,CAAC,QAAQ,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC,CAAC;QAExC,GAAG,CAAC,IAAI,CAAC,uBAAuB,CAAC,CAAC;QAElC,mEAAmE;QAEnE,4DAA4D;QAC5D,MAAM,KAAK,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC;QAEjC,GAAG,CAAC,IAAI,CAAC,2BAA2B,CAAC,CAAC;QACtC,MAAM,KAAK,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC;QAEjC,GAAG,CAAC,IAAI,EAAE,CAAC;QAEX,IAAI,CAAC,GAAG,CACN,QAAQ,CACN,OAAO,EACP,wBAAwB,KAAK,CAAC,IAAI,OAAO,KAAK,CAAC,YAAY,CAAC,CAAC,WAAW,EAAE,IAAI,gBAAgB,GAAG,CAClG,CACF,CAAC;QACF,IAAI,CAAC,GAAG,CAAC,OAAO,QAAQ,CAAC,KAAK,EAAE,4BAA4B,KAAK,CAAC,IAAI,EAAE,CAAC,oCAAoC,CAAC,CAAC;QAE/G,OAAO,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC;IAC7B,CAAC"}

package/lib/commands/agent/generate/spec.d.ts

@@ -0,0 +1,41 @@
+import { SfCommand } from '@salesforce/sf-plugins-core';
+import { Interfaces } from '@oclif/core';
+export type AgentCreateSpecResult = {
+    isSuccess: boolean;
+    errorMessage?: string;
+    jobSpec?: string;
+};
+type FlaggablePrompt = {
+    message: string;
+    options?: readonly string[] | string[];
+    validate: (d: string) => boolean | string;
+    char?: Interfaces.AlphabetLowercase | Interfaces.AlphabetUppercase;
+    required?: boolean;
+};
+export default class AgentCreateSpec extends SfCommand<AgentCreateSpecResult> {
+    static readonly summary: string;
+    static readonly description: string;
+    static readonly examples: string[];
+    static readonly requiresProject = true;
+    static readonly flags: {
+        'output-dir': Interfaces.OptionFlag<string, Interfaces.CustomOptions>;
+        'file-name': Interfaces.OptionFlag<string, Interfaces.CustomOptions>;
+        type: Interfaces.OptionFlag<string | undefined, Interfaces.CustomOptions>;
+        role: Interfaces.OptionFlag<string | undefined, Interfaces.CustomOptions>;
+        "company-name": Interfaces.OptionFlag<string | undefined, Interfaces.CustomOptions>;
+        "company-description": Interfaces.OptionFlag<string | undefined, Interfaces.CustomOptions>;
+        "company-website": Interfaces.OptionFlag<string | undefined, Interfaces.CustomOptions>;
+        'target-org': Interfaces.OptionFlag<import("@salesforce/core").Org, Interfaces.CustomOptions>;
+        'api-version': Interfaces.OptionFlag<string | undefined, Interfaces.CustomOptions>;
+    };
+    run(): Promise<AgentCreateSpecResult>;
+    /**
+     * Get a flag value or prompt the user for a value.
+     *
+     * Resolution order:
+     * - Flag value provided by the user
+     * - Prompt the user for a value
+     */
+    getFlagOrPrompt(valueFromFlag: string | undefined, flagDef: FlaggablePrompt): Promise<string>;
+}
+export {};

package/lib/commands/agent/generate/spec.js

@@ -0,0 +1,170 @@
+/*
+ * Copyright (c) 2024, salesforce.com, inc.
+ * All rights reserved.
+ * Licensed under the BSD 3-Clause license.
+ * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+ */
+import { join } from 'node:path';
+import { writeFileSync } from 'node:fs';
+import { SfCommand, Flags } from '@salesforce/sf-plugins-core';
+import { Messages } from '@salesforce/core';
+import ansis from 'ansis';
+import select from '@inquirer/select';
+import inquirerInput from '@inquirer/input';
+import figures from '@inquirer/figures';
+import { Agent } from '@salesforce/agents';
+Messages.importMessagesDirectoryFromMetaUrl(import.meta.url);
+const messages = Messages.loadMessages('@salesforce/plugin-agent', 'agent.generate.spec');
+const FLAGGABLE_PROMPTS = {
+    type: {
+        message: messages.getMessage('flags.type.summary'),
+        validate: (d) => d.length > 0 || 'Type cannot be empty',
+        char: 't',
+        options: ['customer_facing', 'employee_facing'],
+        required: true,
+    },
+    role: {
+        message: messages.getMessage('flags.role.summary'),
+        validate: (d) => d.length > 0 || 'Role cannot be empty',
+        required: true,
+    },
+    'company-name': {
+        message: messages.getMessage('flags.company-name.summary'),
+        validate: (d) => d.length > 0 || 'Company name cannot be empty',
+        required: true,
+    },
+    'company-description': {
+        message: messages.getMessage('flags.company-description.summary'),
+        validate: (d) => d.length > 0 || 'Company description cannot be empty',
+        required: true,
+    },
+    'company-website': {
+        message: messages.getMessage('flags.company-website.summary'),
+        validate: (d) => {
+            // Allow empty string
+            if (d.length === 0)
+                return true;
+            try {
+                new URL(d);
+                return true;
+            }
+            catch (e) {
+                return 'Please enter a valid URL';
+            }
+        },
+    },
+};
+function validateInput(input, validate) {
+    const result = validate(input);
+    if (typeof result === 'string')
+        throw new Error(result);
+    return input;
+}
+function makeFlags(flaggablePrompts) {
+    return Object.fromEntries(Object.entries(flaggablePrompts).map(([key, value]) => [
+        key,
+        Flags.string({
+            summary: value.message,
+            options: value.options,
+            char: value.char,
+            // eslint-disable-next-line @typescript-eslint/require-await
+            async parse(input) {
+                return validateInput(input, value.validate);
+            },
+            // NOTE: we purposely omit the required property here because we want to allow the flag to be missing in interactive mode
+        }),
+    ]));
+}
+export default class AgentCreateSpec extends SfCommand {
+    static summary = messages.getMessage('summary');
+    static description = messages.getMessage('description');
+    static examples = messages.getMessages('examples');
+    static requiresProject = true;
+    static flags = {
+        'target-org': Flags.requiredOrg(),
+        'api-version': Flags.orgApiVersion(),
+        ...makeFlags(FLAGGABLE_PROMPTS),
+        'output-dir': Flags.directory({
+            char: 'd',
+            exists: true,
+            summary: messages.getMessage('flags.output-dir.summary'),
+            default: 'config',
+        }),
+        'file-name': Flags.string({
+            char: 'f',
+            summary: messages.getMessage('flags.file-name.summary'),
+            default: 'agentSpec.json',
+        }),
+    };
+    async run() {
+        const { flags } = await this.parse(AgentCreateSpec);
+        // throw error if --json is used and not all required flags are provided
+        if (this.jsonEnabled()) {
+            const missingFlags = Object.entries(FLAGGABLE_PROMPTS)
+                .filter(([key, prompt]) => 'required' in prompt && prompt.required && !(key in flags))
+                .map(([key]) => key);
+            if (missingFlags.length) {
+                throw new Error(`Missing required flags: ${missingFlags.join(', ')}`);
+            }
+        }
+        this.log();
+        this.styledHeader('Agent Details');
+        const type = (await this.getFlagOrPrompt(flags.type, FLAGGABLE_PROMPTS.type));
+        const role = await this.getFlagOrPrompt(flags.role, FLAGGABLE_PROMPTS.role);
+        const companyName = await this.getFlagOrPrompt(flags['company-name'], FLAGGABLE_PROMPTS['company-name']);
+        const companyDescription = await this.getFlagOrPrompt(flags['company-description'], FLAGGABLE_PROMPTS['company-description']);
+        const companyWebsite = await this.getFlagOrPrompt(flags['company-website'], FLAGGABLE_PROMPTS['company-website']);
+        this.log();
+        this.spinner.start('Creating agent spec');
+        const connection = flags['target-org'].getConnection(flags['api-version']);
+        const agent = new Agent(connection, this.project);
+        const agentSpec = await agent.createSpec({
+            name: flags['file-name'].split('.json')[0],
+            type,
+            role,
+            companyName,
+            companyDescription,
+            companyWebsite,
+        });
+        // Write a file with the returned job specs
+        const filePath = join(flags['output-dir'], flags['file-name']);
+        writeFileSync(filePath, JSON.stringify(agentSpec, null, 4));
+        this.spinner.stop();
+        this.log(`\nSaved agent spec: ${filePath}`);
+        return {
+            isSuccess: true,
+            jobSpec: filePath,
+        };
+    }
+    /**
+     * Get a flag value or prompt the user for a value.
+     *
+     * Resolution order:
+     * - Flag value provided by the user
+     * - Prompt the user for a value
+     */
+    async getFlagOrPrompt(valueFromFlag, flagDef) {
+        const message = flagDef.message.replace(/\.$/, '');
+        if (valueFromFlag) {
+            this.log(`${ansis.green(figures.tick)} ${ansis.bold(message)} ${ansis.cyan(valueFromFlag)}`);
+            return valueFromFlag;
+        }
+        if (flagDef.options) {
+            return select({
+                choices: flagDef.options.map((o) => ({ name: o, value: o })),
+                message,
+                theme: {
+                    prefix: { idle: ansis.blueBright('?') },
+                },
+            });
+        }
+        return inquirerInput({
+            message,
+            validate: flagDef.validate,
+            theme: {
+                prefix: { idle: ansis.blueBright('?') },
+            },
+        });
+    }
+}
+//# sourceMappingURL=spec.js.map

package/lib/commands/agent/generate/spec.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"spec.js","sourceRoot":"","sources":["../../../../src/commands/agent/generate/spec.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AACjC,OAAO,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AACxC,OAAO,EAAE,SAAS,EAAE,KAAK,EAAE,MAAM,6BAA6B,CAAC;AAC/D,OAAO,EAAE,QAAQ,EAAa,MAAM,kBAAkB,CAAC;AAEvD,OAAO,KAAK,MAAM,OAAO,CAAC;AAC1B,OAAO,MAAM,MAAM,kBAAkB,CAAC;AACtC,OAAO,aAAa,MAAM,iBAAiB,CAAC;AAC5C,OAAO,OAAO,MAAM,mBAAmB,CAAC;AACxC,OAAO,EAAE,KAAK,EAAW,MAAM,oBAAoB,CAAC;AAEpD,QAAQ,CAAC,kCAAkC,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AAC7D,MAAM,QAAQ,GAAG,QAAQ,CAAC,YAAY,CAAC,0BAA0B,EAAE,qBAAqB,CAAC,CAAC;AAuB1F,MAAM,iBAAiB,GAAG;IACxB,IAAI,EAAE;QACJ,OAAO,EAAE,QAAQ,CAAC,UAAU,CAAC,oBAAoB,CAAC;QAClD,QAAQ,EAAE,CAAC,CAAS,EAAoB,EAAE,CAAC,CAAC,CAAC,MAAM,GAAG,CAAC,IAAI,sBAAsB;QACjF,IAAI,EAAE,GAAG;QACT,OAAO,EAAE,CAAC,iBAAiB,EAAE,iBAAiB,CAAC;QAC/C,QAAQ,EAAE,IAAI;KACf;IACD,IAAI,EAAE;QACJ,OAAO,EAAE,QAAQ,CAAC,UAAU,CAAC,oBAAoB,CAAC;QAClD,QAAQ,EAAE,CAAC,CAAS,EAAoB,EAAE,CAAC,CAAC,CAAC,MAAM,GAAG,CAAC,IAAI,sBAAsB;QACjF,QAAQ,EAAE,IAAI;KACf;IACD,cAAc,EAAE;QACd,OAAO,EAAE,QAAQ,CAAC,UAAU,CAAC,4BAA4B,CAAC;QAC1D,QAAQ,EAAE,CAAC,CAAS,EAAoB,EAAE,CAAC,CAAC,CAAC,MAAM,GAAG,CAAC,IAAI,8BAA8B;QACzF,QAAQ,EAAE,IAAI;KACf;IACD,qBAAqB,EAAE;QACrB,OAAO,EAAE,QAAQ,CAAC,UAAU,CAAC,mCAAmC,CAAC;QACjE,QAAQ,EAAE,CAAC,CAAS,EAAoB,EAAE,CAAC,CAAC,CAAC,MAAM,GAAG,CAAC,IAAI,qCAAqC;QAChG,QAAQ,EAAE,IAAI;KACf;IACD,iBAAiB,EAAE;QACjB,OAAO,EAAE,QAAQ,CAAC,UAAU,CAAC,+BAA+B,CAAC;QAC7D,QAAQ,EAAE,CAAC,CAAS,EAAoB,EAAE;YACxC,qBAAqB;YACrB,IAAI,CAAC,CAAC,MAAM,KAAK,CAAC;gBAAE,OAAO,IAAI,CAAC;YAEhC,IAAI,CAAC;gBACH,IAAI,GAAG,CAAC,CAAC,CAAC,CAAC;gBACX,OAAO,IAAI,CAAC;YACd,CAAC;YAAC,OAAO,CAAC,EAAE,CAAC;gBACX,OAAO,0BAA0B,CAAC;YACpC,CAAC;QACH,CAAC;KACF;CACwC,CAAC;AAE5C,SAAS,aAAa,CAAC,KAAa,EAAE,QAA6C;IACjF,MAAM,MAAM,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC;IAC/B,IAAI,OAAO,MAAM,KAAK,QAAQ;QAAE,MAAM,IAAI,KAAK,CAAC,MAAM,CAAC,CAAC;IACxD,OAAO,KAAK,CAAC;AACf,CAAC;AAED,SAAS,SAAS,CAA4C,gBAAmB;IAC/E,OAAO,MAAM,CAAC,WAAW,CACvB,MAAM,CAAC,OAAO,CAAC,gBAAgB,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC;QACrD,GAAG;QACH,KAAK,CAAC,MAAM,CAAC;YACX,OAAO,EAAE,KAAK,CAAC,OAAO;YACtB,OAAO,EAAE,KAAK,CAAC,OAAO;YACtB,IAAI,EAAE,KAAK,CAAC,IAAI;YAChB,4DAA4D;YAC5D,KAAK,CAAC,KAAK,CAAC,KAAK;gBACf,OAAO,aAAa,CAAC,KAAK,EAAE,KAAK,CAAC,QAAQ,CAAC,CAAC;YAC9C,CAAC;YACD,yHAAyH;SAC1H,CAAC;KACH,CAAC,CACkB,CAAC;AACzB,CAAC;AAED,MAAM,CAAC,OAAO,OAAO,eAAgB,SAAQ,SAAgC;IACpE,MAAM,CAAU,OAAO,GAAG,QAAQ,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC;IACzD,MAAM,CAAU,WAAW,GAAG,QAAQ,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC;IACjE,MAAM,CAAU,QAAQ,GAAG,QAAQ,CAAC,WAAW,CAAC,UAAU,CAAC,CAAC;IAC5D,MAAM,CAAU,eAAe,GAAG,IAAI,CAAC;IAEvC,MAAM,CAAU,KAAK,GAAG;QAC7B,YAAY,EAAE,KAAK,CAAC,WAAW,EAAE;QACjC,aAAa,EAAE,KAAK,CAAC,aAAa,EAAE;QACpC,GAAG,SAAS,CAAC,iBAAiB,CAAC;QAC/B,YAAY,EAAE,KAAK,CAAC,SAAS,CAAC;YAC5B,IAAI,EAAE,GAAG;YACT,MAAM,EAAE,IAAI;YACZ,OAAO,EAAE,QAAQ,CAAC,UAAU,CAAC,0BAA0B,CAAC;YACxD,OAAO,EAAE,QAAQ;SAClB,CAAC;QACF,WAAW,EAAE,KAAK,CAAC,MAAM,CAAC;YACxB,IAAI,EAAE,GAAG;YACT,OAAO,EAAE,QAAQ,CAAC,UAAU,CAAC,yBAAyB,CAAC;YACvD,OAAO,EAAE,gBAAgB;SAC1B,CAAC;KACH,CAAC;IAEK,KAAK,CAAC,GAAG;QACd,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC;QAEpD,wEAAwE;QACxE,IAAI,IAAI,CAAC,WAAW,EAAE,EAAE,CAAC;YACvB,MAAM,YAAY,GAAG,MAAM,CAAC,OAAO,CAAC,iBAAiB,CAAC;iBACnD,MAAM,CAAC,CAAC,CAAC,GAAG,EAAE,MAAM,CAAC,EAAE,EAAE,CAAC,UAAU,IAAI,MAAM,IAAI,MAAM,CAAC,QAAQ,IAAI,CAAC,CAAC,GAAG,IAAI,KAAK,CAAC,CAAC;iBACrF,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC,GAAG,CAAC,CAAC;YAEvB,IAAI,YAAY,CAAC,MAAM,EAAE,CAAC;gBACxB,MAAM,IAAI,KAAK,CAAC,2BAA2B,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;YACxE,CAAC;QACH,CAAC;QAED,IAAI,CAAC,GAAG,EAAE,CAAC;QACX,IAAI,CAAC,YAAY,CAAC,eAAe,CAAC,CAAC;QACnC,MAAM,IAAI,GAAG,CAAC,MAAM,IAAI,CAAC,eAAe,CAAC,KAAK,CAAC,IAAI,EAAE,iBAAiB,CAAC,IAAI,CAAC,CAEvD,CAAC;QACtB,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,eAAe,CAAC,KAAK,CAAC,IAAI,EAAE,iBAAiB,CAAC,IAAI,CAAC,CAAC;QAC5E,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,eAAe,CAAC,KAAK,CAAC,cAAc,CAAC,EAAE,iBAAiB,CAAC,cAAc,CAAC,CAAC,CAAC;QACzG,MAAM,kBAAkB,GAAG,MAAM,IAAI,CAAC,eAAe,CACnD,KAAK,CAAC,qBAAqB,CAAC,EAC5B,iBAAiB,CAAC,qBAAqB,CAAC,CACzC,CAAC;QACF,MAAM,cAAc,GAAG,MAAM,IAAI,CAAC,eAAe,CAAC,KAAK,CAAC,iBAAiB,CAAC,EAAE,iBAAiB,CAAC,iBAAiB,CAAC,CAAC,CAAC;QAElH,IAAI,CAAC,GAAG,EAAE,CAAC;QACX,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,qBAAqB,CAAC,CAAC;QAE1C,MAAM,UAAU,GAAG,KAAK,CAAC,YAAY,CAAC,CAAC,aAAa,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC,CAAC;QAC3E,MAAM,KAAK,GAAG,IAAI,KAAK,CAAC,UAAU,EAAE,IAAI,CAAC,OAAoB,CAAY,CAAC;QAC1E,MAAM,SAAS,GAAG,MAAM,KAAK,CAAC,UAAU,CAAC;YACvC,IAAI,EAAE,KAAK,CAAC,WAAW,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;YAC1C,IAAI;YACJ,IAAI;YACJ,WAAW;YACX,kBAAkB;YAClB,cAAc;SACf,CAAC,CAAC;QAEH,2CAA2C;QAC3C,MAAM,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,EAAE,KAAK,CAAC,WAAW,CAAC,CAAC,CAAC;QAC/D,aAAa,CAAC,QAAQ,EAAE,IAAI,CAAC,SAAS,CAAC,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;QAE5D,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC;QAEpB,IAAI,CAAC,GAAG,CAAC,uBAAuB,QAAQ,EAAE,CAAC,CAAC;QAE5C,OAAO;YACL,SAAS,EAAE,IAAI;YACf,OAAO,EAAE,QAAQ;SAClB,CAAC;IACJ,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,eAAe,CAAC,aAAiC,EAAE,OAAwB;QACtF,MAAM,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;QAEnD,IAAI,aAAa,EAAE,CAAC;YAClB,IAAI,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,KAAK,CAAC,IAAI,CAAC,aAAa,CAAC,EAAE,CAAC,CAAC;YAE7F,OAAO,aAAa,CAAC;QACvB,CAAC;QAED,IAAI,OAAO,CAAC,OAAO,EAAE,CAAC;YACpB,OAAO,MAAM,CAAC;gBACZ,OAAO,EAAE,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,CAAC,CAAC;gBAC5D,OAAO;gBACP,KAAK,EAAE;oBACL,MAAM,EAAE,EAAE,IAAI,EAAE,KAAK,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE;iBACxC;aACF,CAAC,CAAC;QACL,CAAC;QAED,OAAO,aAAa,CAAC;YACnB,OAAO;YACP,QAAQ,EAAE,OAAO,CAAC,QAAQ;YAC1B,KAAK,EAAE;gBACL,MAAM,EAAE,EAAE,IAAI,EAAE,KAAK,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE;aACxC;SACF,CAAC,CAAC;IACL,CAAC"}

package/lib/commands/agent/test/cancel.d.ts

@@ -0,0 +1,18 @@
+import { SfCommand } from '@salesforce/sf-plugins-core';
+export type AgentTestCancelResult = {
+    jobId: string;
+    success: boolean;
+    errorCode?: string;
+    message?: string;
+};
+export default class AgentTestCancel extends SfCommand<AgentTestCancelResult> {
+    static readonly summary: string;
+    static readonly description: string;
+    static readonly examples: string[];
+    static readonly flags: {
+        'target-org': import("@oclif/core/interfaces").OptionFlag<import("@salesforce/core").Org, import("@oclif/core/interfaces").CustomOptions>;
+        'job-id': import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
+        'use-most-recent': import("@oclif/core/interfaces").BooleanFlag<boolean>;
+    };
+    run(): Promise<AgentTestCancelResult>;
+}

package/lib/commands/agent/test/cancel.js

@@ -0,0 +1,43 @@
+/*
+ * Copyright (c) 2024, salesforce.com, inc.
+ * All rights reserved.
+ * Licensed under the BSD 3-Clause license.
+ * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+ */
+import { SfCommand, Flags } from '@salesforce/sf-plugins-core';
+import { Messages } from '@salesforce/core';
+Messages.importMessagesDirectoryFromMetaUrl(import.meta.url);
+const messages = Messages.loadMessages('@salesforce/plugin-agent', 'agent.test.cancel');
+export default class AgentTestCancel extends SfCommand {
+    static summary = messages.getMessage('summary');
+    static description = messages.getMessage('description');
+    static examples = messages.getMessages('examples');
+    static flags = {
+        'target-org': Flags.requiredOrg(),
+        'job-id': Flags.string({
+            char: 'i',
+            required: true,
+            summary: messages.getMessage('flags.id.summary'),
+        }),
+        'use-most-recent': Flags.boolean({
+            char: 'r',
+            summary: messages.getMessage('flags.use-most-recent.summary'),
+            exactlyOne: ['use-most-recent', 'job-id'],
+        }),
+        //
+        // Future flags:
+        //   ??? api-version ???
+    };
+    async run() {
+        const { flags } = await this.parse(AgentTestCancel);
+        this.log(`Canceling tests for AiEvaluation Job: ${flags['job-id']}`);
+        // Call SF Eval Connect API passing AiEvaluation.Id
+        // POST to /einstein/ai-evaluations/{aiEvaluationId}/stop
+        // Returns: AiEvaluation.Id
+        return {
+            success: true,
+            jobId: '4KBSM000000003F4AQ', // AiEvaluation.Id
+        };
+    }
+}
+//# sourceMappingURL=cancel.js.map

package/lib/commands/agent/test/cancel.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cancel.js","sourceRoot":"","sources":["../../../../src/commands/agent/test/cancel.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EAAE,SAAS,EAAE,KAAK,EAAE,MAAM,6BAA6B,CAAC;AAC/D,OAAO,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAE5C,QAAQ,CAAC,kCAAkC,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AAC7D,MAAM,QAAQ,GAAG,QAAQ,CAAC,YAAY,CAAC,0BAA0B,EAAE,mBAAmB,CAAC,CAAC;AASxF,MAAM,CAAC,OAAO,OAAO,eAAgB,SAAQ,SAAgC;IACpE,MAAM,CAAU,OAAO,GAAG,QAAQ,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC;IACzD,MAAM,CAAU,WAAW,GAAG,QAAQ,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC;IACjE,MAAM,CAAU,QAAQ,GAAG,QAAQ,CAAC,WAAW,CAAC,UAAU,CAAC,CAAC;IAE5D,MAAM,CAAU,KAAK,GAAG;QAC7B,YAAY,EAAE,KAAK,CAAC,WAAW,EAAE;QACjC,QAAQ,EAAE,KAAK,CAAC,MAAM,CAAC;YACrB,IAAI,EAAE,GAAG;YACT,QAAQ,EAAE,IAAI;YACd,OAAO,EAAE,QAAQ,CAAC,UAAU,CAAC,kBAAkB,CAAC;SACjD,CAAC;QACF,iBAAiB,EAAE,KAAK,CAAC,OAAO,CAAC;YAC/B,IAAI,EAAE,GAAG;YACT,OAAO,EAAE,QAAQ,CAAC,UAAU,CAAC,+BAA+B,CAAC;YAC7D,UAAU,EAAE,CAAC,iBAAiB,EAAE,QAAQ,CAAC;SAC1C,CAAC;QACF,EAAE;QACF,gBAAgB;QAChB,wBAAwB;KACzB,CAAC;IAEK,KAAK,CAAC,GAAG;QACd,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC;QAEpD,IAAI,CAAC,GAAG,CAAC,yCAAyC,KAAK,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;QAErE,mDAAmD;QACnD,yDAAyD;QAEzD,2BAA2B;QAE3B,OAAO;YACL,OAAO,EAAE,IAAI;YACb,KAAK,EAAE,oBAAoB,EAAE,kBAAkB;SAChD,CAAC;IACJ,CAAC"}

package/lib/commands/agent/test/run.d.ts

@@ -0,0 +1,19 @@
+import { SfCommand } from '@salesforce/sf-plugins-core';
+export type AgentTestRunResult = {
+    jobId: string;
+    success: boolean;
+    errorCode?: string;
+    message?: string;
+};
+export default class AgentTestRun extends SfCommand<AgentTestRunResult> {
+    static readonly summary: string;
+    static readonly description: string;
+    static readonly examples: string[];
+    static readonly flags: {
+        'target-org': import("@oclif/core/interfaces").OptionFlag<import("@salesforce/core").Org, import("@oclif/core/interfaces").CustomOptions>;
+        id: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
+        wait: import("@oclif/core/interfaces").OptionFlag<import("@salesforce/kit").Duration, import("@oclif/core/interfaces").CustomOptions>;
+        'output-dir': import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+    };
+    run(): Promise<AgentTestRunResult>;
+}