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

package/src/tasks/publish-all/index.js

@@ -3,23 +3,30 @@ import Listr from 'listr';
 import chalk from 'chalk';
 
 import validate from '../validator/index.js';
-
+import { getComponentDirectoryPath, showVersion, getOptionsCategory, getComponentsObj } from '../../util.js';
 import bundleComponent from '../bundle/index.js';
-import { updateComponentMap } from '../map/map.js';
-
-import { getPublishComponentQuestions, publishComponentToServer, zipComponent } from './helper.js';
-import {
-  getComponentsObj,
-  getComponentDirectoryPath,
-  showVersion
-} from '../../util.js';
+import { updateComponentMap  } from '../map/map.js';
 import { lintComponent } from '../linter/index.js';
+import { CATEGORY_CONSTELLATION, CATEGORY_CUSTOM } from '../../constants.js';
+
+
+import { getPublishComponentQuestions, publishComponentToServer, zipComponent, getBuildCategory, mapConfigJsonToCompanion } from './helper.js';
+
+
 
 export default async options => {
   showVersion();
 
-  const components = await getComponentsObj();
-  const questions = await getPublishComponentQuestions();
+  const catQuestion = await getBuildCategory(options);
+  const catAnwers = await inquirer.prompt(catQuestion);
+
+  let category = catAnwers.category;
+  if (category == null) {
+    category = getOptionsCategory(options);
+  }
+
+  const components = await getComponentsObj(false, category);
+  const questions = await getPublishComponentQuestions(category);
   const answers = await inquirer.prompt(questions);
   const {sourceMap, devBuild } = answers;
 
@@ -29,59 +36,136 @@ export default async options => {
 
   var componentKey;
 
-  const tasks = new Listr(
+  const customTasks = new Listr(
     [
+
       {
         title: 'Validate config schema',
         task: async () => {
-          await validate(componentKey);
+          await validate(componentKey, category);
         }
       },
       {
         title: 'Lint component',
         task: async () => {
-          const targetDirectory = await getComponentDirectoryPath(componentKey);
+          const targetDirectory = await getComponentDirectoryPath(componentKey, category);
+          // console.log(`in buildComponent Lint component task: componentKey: ${componentKey} targetDirectory: ${targetDirectory}`);
+          await lintComponent(targetDirectory);
+        }
+      },
+      {
+        title: 'Update component map',
+        task: async () => {
+            await updateComponentMap(componentKey);
+        }
+      },
+      {
+        title: 'Lint companion component',
+        task: async () => {
+          const targetDirectory = await getComponentDirectoryPath(componentKey, CATEGORY_CONSTELLATION);
+          // console.log(`in buildComponent Lint component task: componentKey: ${componentKey} targetDirectory: ${targetDirectory}`);
+          await lintComponent(targetDirectory);
+        }
+      },
+      {
+        title: 'Map config to companion component',
+        task: async () => {
+          mapConfigJsonToCompanion(componentKey);
+        }
+      },
+      {
+        title: 'Bundle companion component',
+        task: async () => await bundleComponent(componentKey, sourceMap, devBuild, CATEGORY_CONSTELLATION),
+        skip: () => (options.skipBundle ? 'Skipped bundling component' : undefined)
+      },
+      {
+        title: 'Zip companion component',
+        task: async () => {
+          const output = await zipComponent(componentKey, CATEGORY_CONSTELLATION);
+          content = { ...content, ...output };
+        }
+      },
+      {
+        title: 'Publish companion component',
+        task: async () => {
+          await publishComponentToServer(content);
+        }
+      }
+    ],
+    {
+      exitOnError: true
+    }
+  );
+
+  const overrideTasks = 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),
+        task: async () => await bundleComponent(componentKey, sourceMap, devBuild, category),
         skip: () => (options.skipBundle ? 'Skipped bundling component' : undefined)
       },
       {
         title: 'Update Component Map',
         task: async () => {
-            await updateComponentMap(componentKey);
+            await updateComponentMap(componentKey, category);
         }
       },
       {
         title: 'Zip Component',
         task: async () => {
-          const output = await zipComponent(componentKey);
+          const output = await zipComponent(componentKey, category);
           content = { ...content, ...output };
         }
-      },
+      }
+      /*
       {
-        title: 'Publish Component',
+        title: 'Publish component',
         task: async () => {
           await publishComponentToServer(content);
         }
       }
+      */
     ],
     {
       exitOnError: true
     }
   );
 
-  for (var index in components) {
-    componentKey = components[index].value;
-    console.log(chalk.bold.green("Publishing: " + components[index].name));
-    await tasks.run().catch(err => {
-       console.log(chalk.bold.red(err.toString()));
-    });
+
+  if (category === CATEGORY_CUSTOM) {
+    for (var index in components) {
+      componentKey = components[index].value;
+      console.log(chalk.bold.green("Publishing: " + components[index].name));
+      await customTasks.run().catch(err => {
+         console.log(chalk.bold.red(err.toString()));
+      });
+    }
   }
+  else {
+    for (var index in components) {
+      componentKey = components[index].value;
+      console.log(chalk.bold.green("Publishing: " + components[index].name));
+      await overrideTasks.run().catch(err => {
+         console.log(chalk.bold.red(err.toString()));
+      });
+    }
+  }
+
+
 
   return true;
 };

package/src/tasks/validator/index.js

@@ -9,7 +9,9 @@ import {
   COMPONENT_SCHEMA,
   COMPONENT_PREFIX_FIELD_PATH,
   COMPONENT_PREFIX_TEMPLATE_PATH,
-  COMPONENT_PREFIX_WIDGET_PATH } from '../../constants.js';
+  COMPONENT_PREFIX_WIDGET_PATH,
+  CATEGORY_CUSTOM,
+  CATEGORY_OVERRIDE } from '../../constants.js';
 import {
   getComponentDirectoryPath,
   getComponents,
@@ -169,7 +171,7 @@ const validateSchema = ajv.compile(schema);
 
 
 
-export default async (option, category = "custom") => {
+export default async (option, category = CATEGORY_CUSTOM) => {
   let componentToValidate = null;
   if (option.params && option.params[3]) {
     componentToValidate = option.params[3];
@@ -196,10 +198,10 @@ export default async (option, category = "custom") => {
     configData = fs.readFileSync(path.resolve(configFile), 'utf8');
   }
   catch (err) {
-    if (category == "custom") {
+    if (category === CATEGORY_CUSTOM) {
       throw new Error(`Missing config file for: ${componentToValidate}`);
     }
-    else if (category == "override") {
+    else if (category === CATEGORY_OVERRIDE) {
       // for now, if now file just end
       console.log(`${chalk.bold.yellow('config file not availabe for: ' + componentToValidate)}`);
       return;
@@ -222,7 +224,7 @@ export default async (option, category = "custom") => {
     ) {
       const ootbComponents = await getOOTBComponents();
       if (ootbComponents.includes(componentToValidate)) {
-        throw new Error(`Invalid: Error occured in validating ${componentToValidate}`);
+        throw new Error(`Invalid: Error occurred in validating ${componentToValidate}`);
       }
     }
 

package/src/util.js

@@ -34,7 +34,9 @@ import {
   COMPONENT_PREFIX_TEMPLATES_PATH,
   COMPONENT_PREFIX_WIDGETS_PATH,
   COMPONENT_PREFIX_DSE_PATH,
-  COMPONENT_PREFIX_INFRA_PATH
+  COMPONENT_PREFIX_INFRA_PATH,
+  CATEGORY_CUSTOM,
+  CATEGORY_OVERRIDE
 } from './constants.js';
 
 
@@ -54,7 +56,7 @@ export const checkPathAccess = async (path, options = {}) => {
   }
 };
 
-export const deleteLocalComponent = async (componentKey, category = "custom") => {
+export const deleteLocalComponent = async (componentKey, category = CATEGORY_CUSTOM) => {
   const currentDirectory = process.cwd();
   const pegaConfigJsonPath = join(currentDirectory, DXCB_CONFIG_JSON_FILENAME);
   const categoryDirectory = join("/", category.toLowerCase());
@@ -128,7 +130,26 @@ export const deleteServerComponent = async componentKey => {
   }
 };
 
-export const getComponents = async (showSeparator = false, category = "custom") => {
+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 getComponents = async (showSeparator = false, category = CATEGORY_CUSTOM) => {
   const currentDirectory = process.cwd();
   const pegaConfigJsonPath = join(currentDirectory, DXCB_CONFIG_JSON_FILENAME);
   const categoryDirectory = join("/", category.toLowerCase());
@@ -150,7 +171,7 @@ export const getComponents = async (showSeparator = false, category = "custom")
   let compList = new Array();
 
   switch (category) {
-    case "custom":
+    case CATEGORY_CUSTOM:
       const fieldComps = await getSubComponents(directory, FIELD_PATH);
       const templateComps = await getSubComponents(directory, TEMPLATE_PATH);
       const widgetComps = await getSubComponents(directory, WIDGET_PATH);
@@ -172,7 +193,7 @@ export const getComponents = async (showSeparator = false, category = "custom")
         compList.push(...widgetComps);
       }
       break;
-    case "override":
+    case CATEGORY_OVERRIDE:
       const formsComps = await getSubComponents(directory, FORMS_PATH);
       const templatesComps = await getSubComponents(directory, TEMPLATES_PATH);
       const widgetsComps = await getSubComponents(directory, WIDGETS_PATH);
@@ -223,7 +244,30 @@ export const getSubComponents = async (directory, type) => {
   .map(dirent => dirent.name);
 }
 
-export const getComponentsObj = async (showSeparator = false, category = "custom") => {
+
+export const getDirectoryFiles = async (directory) => {
+  return fs
+  .readdirSync(directory, { withFileTypes: true })
+  .filter(dirent => !dirent.isDirectory())
+  .map(dirent => dirent.name);
+}
+
+/*
+export const createBlankConfigExt = async (directory, name) => {
+
+  let fileData = "{";
+  fileData = fileData.concat("\n\t");
+  fileData = fileData.concat("\"name\" : \"");
+  fileData = fileData.concat(`${name}`);
+  fileData = fileData.concat("\", \n\t");
+  fileData = fileData.concat("\"properties\" : [ ] \n");
+  fileData = fileData.concat("}");
+  return fs.writeFileSync( join(directory, "/config-ext.json"), fileData, { encoding: 'utf8' });
+}
+*/
+
+
+export const getComponentsObj = async (showSeparator = false, category = CATEGORY_CUSTOM) => {
   const currentDirectory = process.cwd();
   const pegaConfigJsonPath = join(currentDirectory, DXCB_CONFIG_JSON_FILENAME);
   const categoryDirectory = join("/", category.toLowerCase());
@@ -244,7 +288,7 @@ export const getComponentsObj = async (showSeparator = false, category = "custom
   let compList = new Array();
 
   switch (category) {
-    case "custom":
+    case CATEGORY_CUSTOM:
       const fieldComps = await getSubComponents(directory, FIELD_PATH);
       const templateComps = await getSubComponents(directory, TEMPLATE_PATH);
       const widgetComps = await getSubComponents(directory, WIDGET_PATH);
@@ -289,7 +333,7 @@ export const getComponentsObj = async (showSeparator = false, category = "custom
         ));
       }
       break;
-    case "override":
+    case CATEGORY_OVERRIDE:
       const formsComps = await getSubComponents(directory, FORMS_PATH);
       const templatesComps = await getSubComponents(directory, TEMPLATES_PATH);
       const widgetsComps = await getSubComponents(directory, WIDGETS_PATH);
@@ -381,7 +425,9 @@ export const getSubComponentsAndDir = async (directory, type) => {
   .map(dirent => prefix + dirent.name);
 }
 
-export const getComponentsAndSubDirectory = async (category = "custom") => {
+
+
+export const getComponentsAndSubDirectory = async (category = CATEGORY_CUSTOM) => {
   const currentDirectory = process.cwd();
   const pegaConfigJsonPath = join(currentDirectory, DXCB_CONFIG_JSON_FILENAME);
   const categoryDirectory = join("/", category.toLowerCase());
@@ -465,7 +511,7 @@ export const getComponentDefaults = async () => {
   return config.component;
 };
 
-export const getComponentDirectoryPath = async (componentKey, category = "custom") => {
+export const getComponentDirectoryPath = async (componentKey, category = CATEGORY_CUSTOM) => {
   const currentDirectory = process.cwd();
   const pegaConfigJsonPath = join(currentDirectory, DXCB_CONFIG_JSON_FILENAME);
   const categoryDirectory = join("/", category.toLowerCase());