feat: analytics dashboard lwc templates

@W-9191596@
forcedotcom · May 24, 2021 · 0db5d2f · 0db5d2f
1 parent 0648ff5
commit 0db5d2f
Show file tree

Hide file tree

Showing 7 changed files with 148 additions and 0 deletions.
diff --git a/packages/plugin-templates/test/commands/force/lightning/component/create.test.ts b/packages/plugin-templates/test/commands/force/lightning/component/create.test.ts
@@ -210,6 +210,82 @@ describe('Lightning component creation tests:', () => {
       );
   });
 
+  describe('Check analytics dashboard lwc creation', () => {
+    test
+      .withOrg()
+      .withProject()
+      .stdout()
+      .command([
+        'force:lightning:component:create',
+        '--componentname',
+        'foo',
+        '--outputdir',
+        'lwc',
+        '--type',
+        'lwc',
+        '--template',
+        'analyticsDashboard'
+      ])
+      .it(
+        'should create analyticsDashboard lwc files in the lwc output directory',
+        ctx => {
+          const jsFile = path.join('lwc', 'foo', 'foo.js');
+          const metaFile = path.join('lwc', 'foo', 'foo.js-meta.xml');
+          assert.file(metaFile);
+          assert.file(path.join('lwc', 'foo', 'foo.html'));
+          assert.file(jsFile);
+          assert.fileContent(metaFile, '<target>analytics__Dashboard</target>');
+          assert.fileContent(metaFile, 'targets="analytics__Dashboard"');
+          assert.fileContent(metaFile, '<hasStep>false</hasStep>');
+          assert.fileContent(
+            jsFile,
+            'export default class Foo extends LightningElement {'
+          );
+          assert.fileContent(jsFile, '@api getState;');
+          assert.fileContent(jsFile, '@api setState;');
+        }
+      );
+    test
+      .withOrg()
+      .withProject()
+      .stdout()
+      .command([
+        'force:lightning:component:create',
+        '--componentname',
+        'foo',
+        '--outputdir',
+        'lwc',
+        '--type',
+        'lwc',
+        '--template',
+        'analyticsDashboardWithStep'
+      ])
+      .it(
+        'should create analyticsDashboardWithStep lwc files in the lwc output directory',
+        ctx => {
+          const jsFile = path.join('lwc', 'foo', 'foo.js');
+          const metaFile = path.join('lwc', 'foo', 'foo.js-meta.xml');
+          assert.file(metaFile);
+          assert.file(path.join('lwc', 'foo', 'foo.html'));
+          assert.file(jsFile);
+          assert.fileContent(metaFile, '<target>analytics__Dashboard</target>');
+          assert.fileContent(metaFile, 'targets="analytics__Dashboard"');
+          assert.fileContent(metaFile, '<hasStep>true</hasStep>');
+          assert.fileContent(
+            jsFile,
+            'export default class Foo extends LightningElement {'
+          );
+          assert.fileContent(jsFile, '@api getState;');
+          assert.fileContent(jsFile, '@api setState;');
+          assert.fileContent(jsFile, '@api results;');
+          assert.fileContent(jsFile, '@api metadata;');
+          assert.fileContent(jsFile, '@api selection;');
+          assert.fileContent(jsFile, '@api setSelection;');
+          assert.fileContent(jsFile, '@api selectMode;');
+        }
+      );
+  });
+
   describe('lightning component failures', () => {
     test
       .withOrg()
@@ -261,5 +337,28 @@ describe('Lightning component creation tests:', () => {
       .it('should throw invalid template error', ctx => {
         expect(ctx.stderr).to.contain(messages.getMessage('InvalidTemplate'));
       });
+    test
+      .withOrg()
+      .withProject()
+      .stderr()
+      .command([
+        'force:lightning:component:create',
+        '--outputdir',
+        'aura',
+        '--componentname',
+        'foo',
+        '--type',
+        'aura',
+        '--template',
+        'analyticsDashboard'
+      ])
+      .it('should throw missing template error', ctx => {
+        expect(ctx.stderr).to.contain(
+          messages.getMessage('MissingLightningComponentTemplate', [
+            'analyticsDashboard',
+            'aura'
+          ])
+        );
+      });
   });
 });
diff --git a/...templates/src/templates/lightningcomponent/lwc/analyticsDashboard/analyticsDashboard.html b/...templates/src/templates/lightningcomponent/lwc/analyticsDashboard/analyticsDashboard.html
@@ -0,0 +1,3 @@
+<template>
+
+</template>
diff --git a/...s/templates/src/templates/lightningcomponent/lwc/analyticsDashboard/analyticsDashboard.js b/...s/templates/src/templates/lightningcomponent/lwc/analyticsDashboard/analyticsDashboard.js
@@ -0,0 +1,6 @@
+import { LightningElement, api } from 'lwc';
+
+export default class <%= className %> extends LightningElement {
+  @api getState;
+  @api setState;
+}
diff --git a/...es/src/templates/lightningcomponent/lwc/analyticsDashboard/analyticsDashboard.js-meta.xml b/...es/src/templates/lightningcomponent/lwc/analyticsDashboard/analyticsDashboard.js-meta.xml
@@ -0,0 +1,13 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<LightningComponentBundle xmlns="http://soap.sforce.com/2006/04/metadata">
+    <apiVersion><%= apiVersion %></apiVersion>
+    <isExposed>true</isExposed>
+    <targets>
+        <target>analytics__Dashboard</target>
+    </targets>
+    <targetConfigs>
+        <targetConfig targets="analytics__Dashboard">
+            <hasStep>false</hasStep>
+        </targetConfig>
+    </targetConfigs>
+</LightningComponentBundle>
diff --git a/...mplates/lightningcomponent/lwc/analyticsDashboardWithStep/analyticsDashboardWithStep.html b/...mplates/lightningcomponent/lwc/analyticsDashboardWithStep/analyticsDashboardWithStep.html
@@ -0,0 +1,3 @@
+<template>
+
+</template>
diff --git a/...templates/lightningcomponent/lwc/analyticsDashboardWithStep/analyticsDashboardWithStep.js b/...templates/lightningcomponent/lwc/analyticsDashboardWithStep/analyticsDashboardWithStep.js
@@ -0,0 +1,11 @@
+import { LightningElement, api } from 'lwc';
+
+export default class <%= className %> extends LightningElement {
+  @api results;
+  @api metadata;
+  @api selection;
+  @api setSelection;
+  @api selectMode;
+  @api getState;
+  @api setState;
+}
diff --git a/.../lightningcomponent/lwc/analyticsDashboardWithStep/analyticsDashboardWithStep.js-meta.xml b/.../lightningcomponent/lwc/analyticsDashboardWithStep/analyticsDashboardWithStep.js-meta.xml
@@ -0,0 +1,13 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<LightningComponentBundle xmlns="http://soap.sforce.com/2006/04/metadata">
+    <apiVersion><%= apiVersion %></apiVersion>
+    <isExposed>true</isExposed>
+    <targets>
+        <target>analytics__Dashboard</target>
+    </targets>
+    <targetConfigs>
+        <targetConfig targets="analytics__Dashboard">
+            <hasStep>true</hasStep>
+        </targetConfig>
+    </targetConfigs>
+</LightningComponentBundle>