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

package/package.json

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

package/src/tasks/create/index.js

@@ -31,9 +31,17 @@ 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 (
@@ -151,17 +159,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), "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, "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, "constellation");
+  if (components.includes(componentKey)) {
+    console.log(chalk.red(`${componentKey} companion component already exists in ${targetDirectoryConstellation}`));
     return;
   }
 
+  // component
   await copyComponentTemplate({
     ...options,
     targetDirectory,
@@ -180,7 +205,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'
+};

package/src/tasks/create/templates/SDK-React/Field/Picklist/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, stateProps } from './mock.stories';
 
-import {{COMPONENT_CLASS_NAME}} from './index.jsx';
+import {{COMPONENT_CLASS_NAME}} from './index.tsx';
 
 export default {
   title: '{{COMPONENT_CLASS_NAME}}',
@@ -10,30 +11,37 @@ 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,
+    datasource: configProps.datasource,
+    testId: configProps.testId,
+    hasSuggestions: configProps.hasSuggestions,
+    listType: configProps.listType,
     getPConnect: () => {
       return {
+        getDataObject: () => {
+          return undefined;
+        },
+        getStateProps: () => {
+          return stateProps;
+        },
         getActionsApi: () => {
           return {
-            updateFieldValue: (propName, theValue) => {
-              setValue(theValue);
+            updateFieldValue: (propName, val) => {
+              setValue(val);
+            },
+            triggerFieldChange: () => {
+              return undefined;
             }
           };
-        },
-        getStateProps: () => {
-          return { value: '.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')
+    }
   };
 
   return (
@@ -42,3 +50,4 @@ export const Base{{COMPONENT_CLASS_NAME}} = () => {
     </>
   );
 };
+

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

@@ -0,0 +1,30 @@
+export const configProps = {
+  value: '',
+  label: 'Picklist Sample',
+  placeholder: 'Select...',
+  listType: 'associated',
+  datasource: [
+    {
+      key: 'Option 1',
+      value: 'Option 1'
+    },
+    {
+      key: 'Option 2',
+      value: 'Option 2'
+    },
+    {
+      key: 'Option 3',
+      value: 'Option 3'
+    }
+  ],
+  helperText: 'Picklist Helper Text',
+  testId: 'picklist-12345678',
+  hasSuggestions: false
+};
+
+export const stateProps = {
+  value: '.PicklistSample',
+  placeholder: 'Select...',
+  datasource: '.PicklistSample',
+  hasSuggestions: false
+};

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

@@ -37,7 +37,9 @@ export const Base{{COMPONENT_CLASS_NAME}} = () => {
         }
       };
     },
-    onChange: (event) => { setValue(event.target.value); },
+    onChange: phone => {
+      setValue(phone.value);
+    },
     onBlur: () => { return configProps.value; }
   };
 

package/src/tasks/delete/helper.js

@@ -89,6 +89,9 @@ export const deleteLocalComponents = async (sourceOfComponents, category = "cust
     ]);
     if (answers.confirmDeletion) {
       await deleteLocalComponent(answers.componentKey, category);
+      if (category  === "custom") {
+        await deleteLocalComponent(answers.componentKey, "constellation");
+      }
 
       if (category === "override") {
         // need to remove the map as well

package/src/tasks/delete-all/helper.js

@@ -99,6 +99,9 @@ export const deleteLocalComponents = async (sourceOfComponents, category = "cust
         if (localComponents[index].type == undefined) {
           var componentToDelete = localComponents[index].value;
           await deleteLocalComponent(componentToDelete, category);
+          if (category  === "custom") {
+            await deleteLocalComponent(componentToDelete, "constellation");
+          }
 
           if (category === "override") {
             // need to remove the map as well

package/src/util.js

@@ -73,16 +73,22 @@ export const deleteLocalComponent = async (componentKey, category = "custom") =>
 
   const directory = join(currentDirectory, data[COMPONENTS_DIRECTORY_PATH], categoryDirectory, componentKey);
 
-  //fs.rmdir(directory, { recursive: true }, err => {
-  fs.rm(directory, { recursive: true }, err => {
-    if (err) {
-      throw err;
-    }
+  // test for the directory
+  if (fs.existsSync(directory)) {
+    //fs.rmdir(directory, { recursive: true }, err => {
+    fs.rm(directory, { recursive: true }, err => {
+      if (err) {
+        throw err;
+      }
 
-    console.log(`${chalk.red.bold(componentKey)} is deleted from Local`);
+      console.log(`${chalk.red.bold(componentKey)} is deleted from Local ${category} `);
 
 
-  });
+    });
+  }
+  else {
+    console.log(`${chalk.red.bold(componentKey)} is NOT FOUND from Local ${category} `);
+  }
 };
 
 export const deleteServerComponent = async componentKey => {