Merge pull request #874 from salesforcecli/sh/agent-project-template

feat: add support for creating agent project templates @W-21522177

Author: WillieRuemmele

messages/project.md

@@ -60,6 +60,8 @@ The analytics template provides similar files and the force-app/main/default/wav
 
 The reactb2e and reactb2x templates provide React-based project scaffolding for B2E and B2X web application use cases.
 
+The agent template provides project scaffolding for building Agentforce agents and includes a sample agent called Local Info Agent.
+
 # flags.namespace.summary
 
 Namespace associated with this project and any connected scratch orgs.

package.json

@@ -9,7 +9,7 @@
   "dependencies": {
     "@salesforce/core": "^8.27.0",
     "@salesforce/sf-plugins-core": "^12",
-    "@salesforce/templates": "^66.4.1"
+    "@salesforce/templates": "^66.5.0"
   },
   "devDependencies": {
     "@oclif/plugin-command-snapshot": "^5.3.12",

src/commands/template/generate/project/index.ts

@@ -33,7 +33,7 @@ export default class Project extends SfCommand<CreateOutput> {
       summary: messages.getMessage('flags.template.summary'),
       description: messages.getMessage('flags.template.description'),
       default: 'standard',
-      options: ['standard', 'empty', 'analytics', 'reactb2e', 'reactb2x'] as const,
+      options: ['standard', 'empty', 'analytics', 'reactb2e', 'reactb2x', 'agent'] as const,
     })(),
     'output-dir': outputDirFlag,
     namespace: Flags.string({

test/commands/template/generate/project/index.nut.ts

@@ -26,8 +26,19 @@ const standardfolderarray = [
   'triggers',
 ];
 const filestocopy = ['.forceignore', '.gitignore', '.prettierignore', '.prettierrc', 'jest.config.js', 'package.json'];
+const agentfilestocopy = filestocopy.filter((file) => file !== 'jest.config.js');
 const emptyfolderarray = ['aura', 'lwc'];
 const analyticsfolderarray = ['aura', 'classes', 'lwc', 'waveTemplates'];
+const agentfolderarray = [
+  'aiAuthoringBundles',
+  'bots',
+  'classes',
+  'flows',
+  'genAiPlannerBundles',
+  'genAiPromptTemplates',
+  'permissionsetgroups',
+  'permissionsets',
+];
 const huskyhookarray = ['pre-commit'];
 const vscodearray = ['extensions', 'launch', 'settings'];
 
@@ -275,10 +286,61 @@ describe('template generate project:', () => {
       assert.file([webappMetaPath]);
       assert.fileContent(webappMetaPath, alphanumericName);
     });
+
+    it('should create project with agent template', () => {
+      execCmd('template generate project --projectname agent1 --template agent --manifest', {
+        ensureExitCode: 0,
+      });
+      const projectDir = path.join(session.project.dir, 'agent1');
+      assert.file([path.join(projectDir, 'sfdx-project.json')]);
+      assert.fileContent(path.join(projectDir, 'sfdx-project.json'), '"path": "force-app",');
+      assert.fileContent(path.join(projectDir, 'sfdx-project.json'), 'sourceApiVersion');
+      assert.file([path.join(projectDir, 'config', 'project-scratch-def.json')]);
+      assert.fileContent(path.join(projectDir, 'config', 'project-scratch-def.json'), 'einsteinGptSettings');
+      assert.file([path.join(projectDir, 'README.md')]);
+      assert.fileContent(path.join(projectDir, 'README.md'), '# Agentforce Project');
+      assert.file([path.join(projectDir, 'manifest', 'package.xml')]);
+      assert.fileContent(path.join(projectDir, 'manifest', 'package.xml'), '<name>AiAuthoringBundle</name>');
+
+      const srcDir = path.join(projectDir, 'force-app', 'main', 'default');
+      for (const folder of agentfolderarray) {
+        const dir = path.join(srcDir, folder);
+        assert(fs.existsSync(dir), `Missing ${dir}`);
+      }
+
+      assert.file([
+        path.join(srcDir, 'aiAuthoringBundles', 'Local_Info_Agent', 'Local_Info_Agent.bundle-meta.xml'),
+        path.join(srcDir, 'aiAuthoringBundles', 'Local_Info_Agent', 'Local_Info_Agent.agent'),
+        path.join(srcDir, 'classes', 'CheckWeather.cls'),
+        path.join(srcDir, 'classes', 'CheckWeather.cls-meta.xml'),
+        path.join(srcDir, 'classes', 'CurrentDate.cls'),
+        path.join(srcDir, 'classes', 'CurrentDate.cls-meta.xml'),
+        path.join(srcDir, 'classes', 'CurrentDateTest.cls'),
+        path.join(srcDir, 'classes', 'CurrentDateTest.cls-meta.xml'),
+        path.join(srcDir, 'classes', 'WeatherService.cls'),
+        path.join(srcDir, 'classes', 'WeatherService.cls-meta.xml'),
+        path.join(srcDir, 'classes', 'WeatherServiceTest.cls'),
+        path.join(srcDir, 'classes', 'WeatherServiceTest.cls-meta.xml'),
+        path.join(srcDir, 'flows', 'Get_Resort_Hours.flow-meta.xml'),
+        path.join(srcDir, 'genAiPromptTemplates', 'Get_Event_Info.genAiPromptTemplate-meta.xml'),
+        path.join(srcDir, 'permissionsets', 'Resort_Agent.permissionset-meta.xml'),
+        path.join(srcDir, 'permissionsets', 'Resort_Admin.permissionset-meta.xml'),
+        path.join(srcDir, 'permissionsetgroups', 'AFDX_Agent_Perms.permissionsetgroup-meta.xml'),
+        path.join(srcDir, 'permissionsetgroups', 'AFDX_User_Perms.permissionsetgroup-meta.xml'),
+      ]);
+
+      for (const file of vscodearray) {
+        assert.file(path.join(projectDir, '.vscode', `${file}.json`));
+      }
+
+      for (const file of agentfilestocopy) {
+        assert.file([path.join(projectDir, file)]);
+      }
+    });
   });
 
   describe('project creation failures', () => {
-    it('should throw invalid template name error', () => {
+    it('should throw missing required flag error', () => {
       const stderr = execCmd('template generate project').shellOutput.stderr;
       expect(stderr).to.contain('Missing required flag');
     });

yarn.lock

@@ -1624,10 +1624,10 @@
     cli-progress "^3.12.0"
     terminal-link "^3.0.0"
 
-"@salesforce/templates@^66.4.1":
-  version "66.4.1"
-  resolved "https://registry.yarnpkg.com/@salesforce/templates/-/templates-66.4.1.tgz#0b7470efd33935333c76e102b69d602e95717304"
-  integrity sha512-7ImXvg80wOQojq1Bn3PJYuMmkBB9ypgMR4usP9rst+aX43ka/fA/4jIHcThayRELkem0e2C56ougkjKr8AusyQ==
+"@salesforce/templates@^66.5.0":
+  version "66.5.0"
+  resolved "https://registry.yarnpkg.com/@salesforce/templates/-/templates-66.5.0.tgz#77721c2b040b246c50c088d056a93909a8506dd8"
+  integrity sha512-lKnXEepqB775+hkZ0erZ+g+cLB2VA7sAirFnPjN/3PJJ/3sC9lSMB8DQfxCJOOinTFHh9fPhNfeFT/zPHTXppQ==
   dependencies:
     "@salesforce/kit" "^3.2.4"
     ejs "^3.1.10"