@pega/dx-component-builder-sdk 0.1.5 → 0.1.7

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pega/dx-component-builder-sdk",
-  "version": "0.1.5",
+  "version": "0.1.7",
   "description": "Utility for building custom UI components",
   "bin": "./bin/index.js",
   "scripts": {

package/src/constants.js

@@ -22,6 +22,10 @@ export const COMPONENT_PREFIX_WIDGETS_PATH = "widgets/";
 export const COMPONENT_PREFIX_DSE_PATH = "designSystemExtensions/";
 export const COMPONENT_PREFIX_INFRA_PATH = "infra/";
 
+export const CATEGORY_CUSTOM = "custom";
+export const CATEGORY_OVERRIDE = "override";
+export const CATEGORY_CONSTELLATION = "constellation";
+
 /* REST end points */
 export const PUBLISH_COMPONENT_SERVICE_REST_ENDPOINT = 'PRRestService/dev/v1/publish_component';
 export const LIST_COMPONENT_SERVICE_REST_ENDPOINT = 'PRRestService/dev/v1/list_component';
@@ -225,7 +229,7 @@ export const COMPONENT_SCHEMA = {
       },
       {
         name: 'Radio Buttons',
-        value: 'RadioButons'
+        value: 'RadioButtons'
       },
       {
         name: 'Semantic Link',
@@ -312,8 +316,8 @@ export const COMPONENT_SCHEMA = {
         value: 'DeferLoad'
       },
       {
-        name: 'Error Boundry',
-        value: 'ErrorBoundry'
+        name: 'Error Boundary',
+        value: 'ErrorBoundary'
       },
       {
         name: 'Multi Step',
@@ -493,7 +497,7 @@ export const COMPONENT_SCHEMA = {
     widgets: [
       {
         name: 'App Announcement',
-        value: 'AppAnnoucement'
+        value: 'AppAnnouncement'
       },
       {
         name: 'Case History',

package/src/tasks/build/helper.js

@@ -12,31 +12,13 @@ import {
   getComponents,
   getComponentsObj,
   getPegaServerConfig,
-  validateRulesetVersion
+  validateRulesetVersion,
+  getOptionsCategory,
 } from '../../util.js';
-import { PUBLISH_COMPONENT_SERVICE_REST_ENDPOINT, TOKEN_PATH, COMPONENT_SCHEMA } from '../../constants.js';
+import { PUBLISH_COMPONENT_SERVICE_REST_ENDPOINT, TOKEN_PATH, COMPONENT_SCHEMA, CATEGORY_CUSTOM } from '../../constants.js';
 
-export const getOptionsCategory = (options) => {
-  let categoryType = null;
-  if (options.params[3]) {
-    let catType = options.params[3];
-
-    switch (catType.toLowerCase()) {
-      case "override" :
-      case "o" :
-        categoryType = "override";
-        break;
-      case "custom" :
-      case "c" :
-        categoryType = "custom";
-        break;
-      }
-  }
-  return categoryType;
-}
 
 export const getBuildCategory = async (options) => {
-  const defaultPegaServerConfig = await getPegaServerConfig();
   const categoryType = getOptionsCategory(options);
 
   return [
@@ -83,7 +65,7 @@ export const getBuildComponentQuestions = async (category) => {
   ];
 };
 
-export const zipComponent = async (componentKey, category = "custom") => {
+export const zipComponent = async (componentKey, category = CATEGORY_CUSTOM) => {
   const srcDirectory = await getComponentDirectoryPath(componentKey, category);
   const buildDirectory = await path.join(path.resolve(), 'dist/components', componentKey);
   const configJson = `${srcDirectory}/config.json`;

package/src/tasks/build/index.js

@@ -6,8 +6,10 @@ import validate from '../validator/index.js';
 
 import bundleComponent from '../bundle/index.js';
 import lintComponent from '../linter/index.js';
-import { getBuildComponentQuestions, getBuildCategory, getOptionsCategory } from './helper.js';
-import { getComponentDirectoryPath, showVersion } from '../../util.js';
+import { getBuildComponentQuestions, getBuildCategory } from './helper.js';
+import { getComponentDirectoryPath, showVersion, getOptionsCategory } from '../../util.js';
+
+import { CATEGORY_CUSTOM } from '../../constants.js';
 
 export default async options => {
   showVersion();
@@ -28,7 +30,45 @@ export default async options => {
     ...answers
   };
 
-  const tasks = new Listr(
+  const customTasks = new Listr(
+    [
+      {
+        title: 'Validate config schema',
+        task: async () => {
+          await validate(componentKey, category);
+        }
+      },
+      {
+        title: 'Lint component',
+        task: async () => {
+          const targetDirectory = await getComponentDirectoryPath(componentKey, category);
+          // console.log(`in buildComponent Lint component task: componentKey: ${componentKey} targetDirectory: ${targetDirectory}`);
+          await lintComponent(targetDirectory);
+        }
+      },
+      {
+        title: 'Bundle component',
+        task: async () => await bundleComponent(componentKey, sourceMap, devBuild, category),
+      },
+      {
+        title: 'Lint companion component',
+        task: async () => {
+          const targetDirectory = await getComponentDirectoryPath(componentKey, "constellation");
+          // console.log(`in buildComponent Lint component task: componentKey: ${componentKey} targetDirectory: ${targetDirectory}`);
+          await lintComponent(targetDirectory);
+        }
+      },
+      {
+        title: 'Bundle companion component',
+        task: async () => await bundleComponent(componentKey, sourceMap, devBuild, "constellation")
+      }
+    ],
+    {
+      exitOnError: true
+    }
+  );
+
+  const overrideTasks = new Listr(
     [
       {
         title: 'Validate config schema',
@@ -47,7 +87,6 @@ export default async options => {
       {
         title: 'Bundle Component',
         task: async () => await bundleComponent(componentKey, sourceMap, devBuild, category),
-        skip: () => (options.skipBundle ? 'Skipped bundling component' : undefined)
       }
     ],
     {
@@ -55,8 +94,16 @@ export default async options => {
     }
   );
 
-  await tasks.run().catch(err => {
-    console.log(chalk.bold.red(err.toString()));
-  });
+  if (category == CATEGORY_CUSTOM) {
+    await customTasks.run().catch(err => {
+      console.log(chalk.bold.red(err.toString()));
+    });
+  }
+  else {
+    await overrideTasks.run().catch(err => {
+      console.log(chalk.bold.red(err.toString()));
+    });
+  }
+
   return true;
 };

package/src/tasks/bundle/index.js

@@ -2,14 +2,14 @@ import path from 'path';
 import fs from 'fs';
 import { stat } from 'fs/promises';
 
-import { BUILD_CONFIG_JSON_FILENAME } from '../../constants.js';
+import { BUILD_CONFIG_JSON_FILENAME, CATEGORY_CUSTOM } from '../../constants.js';
 import { getComponentDirectoryPath } from '../../util.js';
 
 import buildComponent from './builder/index.js';
 
 const extensions = ['ts', 'tsx', 'js', 'jsx'];
 
-const bundleComponent = async (componentKey, sourceMap, devBuild, category = "custom") => {
+const bundleComponent = async (componentKey, sourceMap, devBuild, category = CATEGORY_CUSTOM) => {
   const componentDirectory = await getComponentDirectoryPath(componentKey, category);
 
   const idx = (

package/src/tasks/create/index.js

@@ -9,6 +9,7 @@ import ncp from 'ncp';
 import chalk from 'chalk';
 
 import { checkPathAccess, getTokenUrl, showVersion } from '../../util.js';
+import { CATEGORY_CONSTELLATION } from '../../constants.js';
 
 
 export const DXCB_CONFIG_JSON_FILENAME = 'dxcb.config.json';
@@ -31,12 +32,20 @@ import { COMPONENT_SCHEMA } from '../../constants.js';
 const copy = promisify(ncp);
 
 const copyComponentTemplate = async options => {
-  return copy(options.templateDirectory, options.targetDirectory, {
-    clobber: false
-  });
+  if (options.targetDirectory) {
+    return copy(options.templateDirectory, options.targetDirectory, {
+      clobber: false
+    });
+  }
+  else {
+    return copy(options.templateDirectoryConstellation, options.targetDirectoryConstellation, {
+      clobber: false
+    });
+  }
+
 };
 
-const compileMustacheTemplates = async (
+export const compileMustacheTemplates = async (
   componentDirectory,
   {
     componentKey,
@@ -151,17 +160,34 @@ const validateCompile = async (
   const templateDir = `./templates/${framework}/${type}/${sSubType}`;
   const templateDirectory = fileURLToPath(new URL(templateDir, import.meta.url));
 
+  const templateDirConstellation = `./templates/Constellation/${type}/${sSubType}`;
+  const templateDirectoryConstellation = fileURLToPath(new URL(templateDirConstellation, import.meta.url));
+
   const componentKey = `${organization}_${library}_${componentName}`;
 
   const typeLC = type.toLowerCase();
   const targetDirectory = await getComponentDirectoryPath(join(typeLC, "/",componentKey));
+  const targetDirectoryConstellation = await getComponentDirectoryPath(join(typeLC, "/",componentKey), CATEGORY_CONSTELLATION);
 
   const components = await getComponents(false);
   if (components.includes(componentKey)) {
     console.log(chalk.red(`${componentKey} component already exists in ${targetDirectory}`));
+
+    let componentsConstellation = await getComponents(false, CATEGORY_CONSTELLATION);
+    if (components.includes(componentKey)) {
+      console.log(chalk.red(`${componentKey} companion component already exists in ${targetDirectoryConstellation}`));
+    }
+
+    return;
+  }
+  // test for constellation
+  const componentsConstellation = await getComponents(false, CATEGORY_CONSTELLATION);
+  if (components.includes(componentKey)) {
+    console.log(chalk.red(`${componentKey} companion component already exists in ${targetDirectoryConstellation}`));
     return;
   }
 
+  // component
   await copyComponentTemplate({
     ...options,
     targetDirectory,
@@ -180,7 +206,27 @@ const validateCompile = async (
     allowedApplications
   });
 
+  // matching constellation
+  await copyComponentTemplate({
+    ...options,
+    targetDirectoryConstellation,
+    templateDirectoryConstellation
+  });
+  await compileMustacheTemplates(targetDirectoryConstellation, {
+    componentKey,
+    componentName,
+    componentLabel,
+    library,
+    version,
+    type,
+    subtype,
+    description,
+    organization,
+    allowedApplications
+  });
+
   console.log(chalk.green(`created ${componentKey} component in ${targetDirectory}`));
+  console.log(chalk.green(`created ${componentKey} companion component in ${targetDirectoryConstellation}`));
 
 };
 

package/src/tasks/create/templates/SDK-React/Field/Boolean/demo.stories.jsx.mustache

@@ -1,7 +1,9 @@
 import { useState } from 'react';
-import { withKnobs, text, boolean } from '@storybook/addon-knobs';
+import { withKnobs } from '@storybook/addon-knobs';
 
-import {{COMPONENT_CLASS_NAME}} from './index.jsx';
+import { configProps, stateProps } from './mock.stories';
+
+import {{COMPONENT_CLASS_NAME}} from './index.tsx';
 
 export default {
   title: '{{COMPONENT_CLASS_NAME}}',
@@ -10,30 +12,40 @@ export default {
 };
 
 export const Base{{COMPONENT_CLASS_NAME}} = () => {
-  const [value, setValue] = useState('test value');
+  const [value, setValue] = useState(configProps.value);
 
   const props = {
+    value,
+    label: configProps.label,
+    helperText: configProps.helperText,
+    caption: configProps.caption,
+    testId: configProps.testId,
+    trueLabel: configProps.trueLabel,
+    falseLabel: configProps.falseLabel,
+
     getPConnect: () => {
       return {
+        getStateProps: () => {
+          return stateProps;
+        },
+        getConfigProps: () => {
+          return configProps;
+        },
         getActionsApi: () => {
           return {
             updateFieldValue: (propName, theValue) => {
               setValue(theValue);
-            }
+            },
+            triggerFieldChange: () => { /* nothing */}
           };
         },
-        getStateProps: () => {
-          return { value: '.name' };
+        getValidationApi: () => {
+          return {
+            validate: () => { /* nothing */}
+          };
         }
       };
-    },
-    value,
-    placeholder: text('Placeholder', 'Test placeholder'),
-    disabled: boolean('Disabled', false),
-    readOnly: boolean('Disabled', false),
-    required: boolean('Disabled', false),
-    label: text('Label', 'Sample Label'),
-    testId: text('Test id', 'text-12344566')
+    }
   };
 
   return (

package/src/tasks/create/templates/SDK-React/Field/Boolean/mock.stories.js.mustache

@@ -0,0 +1,15 @@
+export const configProps = {
+  "caption": "Boolean Caption",
+  "value": false,
+  "trueLabel": "Yes",
+  "falseLabel": "No",
+  "label": "Boolean Sample",
+  "helperText": "Boolean Helper Text",
+  "testId": "boolean-12345678",
+  "hasSuggestions": false
+};
+
+export const stateProps = {
+  "value": ".BooleanSample",
+  "hasSuggestions": false
+};

package/src/tasks/create/templates/SDK-React/Field/Decimal/demo.stories.jsx.mustache

@@ -1,7 +1,8 @@
 import { useState } from 'react';
-import { withKnobs, text, boolean } from '@storybook/addon-knobs';
+import { withKnobs } from '@storybook/addon-knobs';
+import { configProps, fieldMetadata } from './mock.stories.js';
 
-import {{COMPONENT_CLASS_NAME}} from './index.jsx';
+import {{COMPONENT_CLASS_NAME}} from './index.tsx';
 
 export default {
   title: '{{COMPONENT_CLASS_NAME}}',
@@ -10,9 +11,15 @@ export default {
 };
 
 export const Base{{COMPONENT_CLASS_NAME}} = () => {
-  const [value, setValue] = useState('test value');
+  const [value, setValue] = useState(configProps.value);
 
   const props = {
+    value,
+    placeholder: configProps.placeholder,
+    label: configProps.label,
+    helperText: configProps.helperText,
+    testId: configProps.testId,
+    fieldMetadata,
     getPConnect: () => {
       return {
         getActionsApi: () => {
@@ -27,13 +34,12 @@ export const Base{{COMPONENT_CLASS_NAME}} = () => {
         }
       };
     },
-    value,
-    placeholder: text('Placeholder', 'Test placeholder'),
-    disabled: boolean('Disabled', false),
-    readOnly: boolean('Disabled', false),
-    required: boolean('Disabled', false),
-    label: text('Label', 'Sample Label'),
-    testId: text('Test id', 'text-12344566')
+    onChange: event => {
+      setValue(event.target.value);
+    },
+    onBlur: () => {
+      return configProps.value;
+    }
   };
 
   return (
@@ -42,3 +48,4 @@ export const Base{{COMPONENT_CLASS_NAME}} = () => {
     </>
   );
 };
+

package/src/tasks/create/templates/SDK-React/Field/Decimal/mock.stories.js.mustache

@@ -0,0 +1,14 @@
+export const configProps = {
+  value: '',
+  label: 'Decimal Sample',
+  placeholder: 'Decimal Placeholder',
+  helperText: 'Decimal Helper Text',
+  testId: 'decimal-12345678'
+};
+
+export const fieldMetadata = {
+  classID: 'DIXL-MediaCo-Work-NewService',
+  type: 'Decimal',
+  displayAs: 'pxNumber',
+  label: 'Decimal sample'
+};

package/src/tasks/create/templates/SDK-React/Field/Decimal-Currency/demo.stories.jsx.mustache

@@ -1,7 +1,8 @@
 import { useState } from 'react';
-import { withKnobs, text, boolean } from '@storybook/addon-knobs';
+import { withKnobs } from '@storybook/addon-knobs';
+import { configProps, fieldMetadata } from './mock.stories.js';
 
-import {{COMPONENT_CLASS_NAME}} from './index.jsx';
+import {{COMPONENT_CLASS_NAME}} from './index.tsx';
 
 export default {
   title: '{{COMPONENT_CLASS_NAME}}',
@@ -10,9 +11,15 @@ export default {
 };
 
 export const Base{{COMPONENT_CLASS_NAME}} = () => {
-  const [value, setValue] = useState('test value');
+  const [value, setValue] = useState(configProps.value);
 
   const props = {
+    value,
+    placeholder: configProps.placeholder,
+    label: configProps.label,
+    helperText: configProps.helperText,
+    testId: configProps.testId,
+    fieldMetadata,
     getPConnect: () => {
       return {
         getActionsApi: () => {
@@ -27,13 +34,12 @@ export const Base{{COMPONENT_CLASS_NAME}} = () => {
         }
       };
     },
-    value,
-    placeholder: text('Placeholder', 'Test placeholder'),
-    disabled: boolean('Disabled', false),
-    readOnly: boolean('Disabled', false),
-    required: boolean('Disabled', false),
-    label: text('Label', 'Sample Label'),
-    testId: text('Test id', 'text-12344566')
+    onChange: event => {
+      setValue(event.target.value);
+    },
+    onBlur: () => {
+      return configProps.value;
+    }
   };
 
   return (

package/src/tasks/create/templates/SDK-React/Field/Decimal-Currency/mock.stories.js.mustache

@@ -0,0 +1,14 @@
+export const configProps = {
+  value: '',
+  label: 'Currency Sample',
+  placeholder: 'Currency Placeholder',
+  helperText: 'Currency Helper Text',
+  testId: 'currency-12345678'
+};
+
+export const fieldMetadata = {
+  classID: 'DIXL-MediaCo-Work-NewService',
+  type: 'Decimal',
+  displayAs: 'pxCurrency',
+  label: 'Currency sample'
+};

package/src/tasks/create/templates/SDK-React/Field/Decimal-Percentage/demo.stories.jsx.mustache

@@ -1,7 +1,8 @@
 import { useState } from 'react';
-import { withKnobs, text, boolean } from '@storybook/addon-knobs';
+import { withKnobs } from '@storybook/addon-knobs';
+import { configProps, fieldMetadata } from './mock.stories.js';
 
-import {{COMPONENT_CLASS_NAME}} from './index.jsx';
+import {{COMPONENT_CLASS_NAME}} from './index.tsx';
 
 export default {
   title: '{{COMPONENT_CLASS_NAME}}',
@@ -10,9 +11,16 @@ export default {
 };
 
 export const Base{{COMPONENT_CLASS_NAME}} = () => {
-  const [value, setValue] = useState('test value');
+  const [value, setValue] = useState(configProps.value);
 
   const props = {
+    value,
+    placeholder: configProps.placeholder,
+    label: configProps.label,
+    helperText: configProps.helperText,
+    hasSuggestions: configProps.hasSuggestions,
+    testId: configProps.testId,
+    fieldMetadata,
     getPConnect: () => {
       return {
         getActionsApi: () => {
@@ -27,13 +35,12 @@ export const Base{{COMPONENT_CLASS_NAME}} = () => {
         }
       };
     },
-    value,
-    placeholder: text('Placeholder', 'Test placeholder'),
-    disabled: boolean('Disabled', false),
-    readOnly: boolean('Disabled', false),
-    required: boolean('Disabled', false),
-    label: text('Label', 'Sample Label'),
-    testId: text('Test id', 'text-12344566')
+    onChange: event => {
+      setValue(event.target.value);
+    },
+    onBlur: () => {
+      return configProps.value;
+    }
   };
 
   return (

package/src/tasks/create/templates/SDK-React/Field/Decimal-Percentage/mock.stories.js.mustache

@@ -0,0 +1,14 @@
+export const configProps = {
+  value: '',
+  label: 'Percentage Sample',
+  placeholder: 'Percentage Placeholder',
+  helperText: 'Percentage Helper Text',
+  testId: 'percentage-12345678'
+};
+
+export const fieldMetadata = {
+  classID: 'DIXL-MediaCo-Work-NewService',
+  type: 'Decimal',
+  displayAs: 'pxPercentage',
+  label: 'Percentage sample'
+};

package/src/tasks/create/templates/SDK-React/Field/Integer/demo.stories.jsx.mustache

@@ -1,7 +1,8 @@
 import { useState } from 'react';
-import { withKnobs, text, boolean } from '@storybook/addon-knobs';
+import { withKnobs } from '@storybook/addon-knobs';
+import { configProps, fieldMetadata } from './mock.stories.js';
 
-import {{COMPONENT_CLASS_NAME}} from './index.jsx';
+import {{COMPONENT_CLASS_NAME}} from './index.tsx';
 
 export default {
   title: '{{COMPONENT_CLASS_NAME}}',
@@ -10,9 +11,15 @@ export default {
 };
 
 export const Base{{COMPONENT_CLASS_NAME}} = () => {
-  const [value, setValue] = useState('test value');
+  const [value, setValue] = useState(configProps.value);
 
   const props = {
+    value,
+    placeholder: configProps.placeholder,
+    label: configProps.label,
+    helperText: configProps.helperText,
+    testId: configProps.testId,
+    fieldMetadata,
     getPConnect: () => {
       return {
         getActionsApi: () => {
@@ -27,13 +34,12 @@ export const Base{{COMPONENT_CLASS_NAME}} = () => {
         }
       };
     },
-    value,
-    placeholder: text('Placeholder', 'Test placeholder'),
-    disabled: boolean('Disabled', false),
-    readOnly: boolean('Disabled', false),
-    required: boolean('Disabled', false),
-    label: text('Label', 'Sample Label'),
-    testId: text('Test id', 'text-12344566')
+    onChange: event => {
+      setValue(event.target.value);
+    },
+    onBlur: () => {
+      return configProps.value;
+    }
   };
 
   return (

package/src/tasks/create/templates/SDK-React/Field/Integer/mock.stories.js.mustache

@@ -0,0 +1,14 @@
+export const configProps = {
+  value: '',
+  label: 'Integer Sample',
+  placeholder: 'Integer Placeholder',
+  helperText: 'Integer Helper Text',
+  testId: 'integer-12345678'
+};
+
+export const fieldMetadata = {
+  classID: 'DIXL-MediaCo-Work-NewService',
+  type: 'Integer',
+  displayAs: 'pxInteger',
+  label: 'Integer sample'
+};