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

package/src/tasks/publish/helper.js

@@ -13,12 +13,39 @@ import {
   getComponentsObj,
   getComponentsAndSubDirectory,
   getPegaServerConfig,
-  validateRulesetVersion
+  validateRulesetVersion,
+  getOptionsCategory
 } from '../../util.js';
-import { PUBLISH_COMPONENT_SERVICE_REST_ENDPOINT, TOKEN_PATH } from '../../constants.js';
+import { PUBLISH_COMPONENT_SERVICE_REST_ENDPOINT, TOKEN_PATH, COMPONENT_SCHEMA, CATEGORY_CONSTELLATION, CATEGORY_CUSTOM } from '../../constants.js';
 
-export const getPublishComponentQuestions = async () => {
-  const components = await getComponentsObj(true);
+
+export const mapConfigJsonToCompanion = async ( componentKey ) => {
+  const srcDirectory = await getComponentDirectoryPath(componentKey, CATEGORY_CUSTOM);
+  const companionDirectory = await getComponentDirectoryPath(componentKey, CATEGORY_CONSTELLATION);
+  let configContent = fs.readFileSync(`${srcDirectory}/config.json`, { encoding: 'utf8' });
+
+  fs.writeFileSync(`${companionDirectory}/config.json`, configContent, { encoding: 'utf8' });
+
+}
+
+export const getBuildCategory = async (options) => {
+  const categoryType = getOptionsCategory(options);
+
+  return [
+    {
+      name: 'category',
+      type: 'rawlist',
+      message: 'Category of components ?',
+      choices: COMPONENT_SCHEMA.category,
+      when() {
+        return !options.params[4] && categoryType == null;
+      }
+    }
+  ];
+};
+
+export const getPublishComponentQuestions = async (category) => {
+  const components = await getComponentsObj(true, category);
   const defaultPegaConfig = await getPegaServerConfig();
 
   return [
@@ -64,24 +91,59 @@ export const getPublishComponentQuestions = async () => {
   ];
 };
 
-export const zipComponent = async componentKey => {
-  const srcDirectory = await getComponentDirectoryPath(componentKey);
+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`;
+  const configExtJson = `${srcDirectory}/config-ext.json`;
 
   const zip = new AdmZip();
 
   zip.addLocalFolder(srcDirectory, 'src/');
-  zip.addLocalFile(configJson);
+  if (category === CATEGORY_CUSTOM || category == CATEGORY_CONSTELLATION) {
+    zip.addLocalFile(configJson);
+  }
+  else {
+    // check to see if have file
+    if (fs.existsSync(configExtJson)) {
+      zip.addLocalFile(configExtJson);
+    }
+
+  }
+
   zip.addLocalFolder(buildDirectory);
   const zipContent = zip.toBuffer().toString('base64');
 
-  const configContent = Buffer.from(fs.readFileSync(`${srcDirectory}/config.json`)).toString();
-  fs.rmdir('dist', { recursive: true }, err => {
-    if (err) {
-      throw err;
+  let configContent = "{ }";
+  if (category === CATEGORY_CUSTOM || category === CATEGORY_CONSTELLATION) {
+    configContent = Buffer.from(fs.readFileSync(`${srcDirectory}/config.json`)).toString();
+    fs.rmdir('dist', { recursive: true }, err => {
+      if (err) {
+        throw err;
+      }
+    });
+  }
+  else {
+    if (fs.existsSync(configExtJson)) {
+      configContent = Buffer.from(fs.readFileSync(`${srcDirectory}/config-ext.json`)).toString();
+      fs.rmdir('dist', { recursive: true }, err => {
+        if (err) {
+          throw err;
+        }
+      });
     }
-  });
+    else {
+      const tempConfig = { "componentKey" : ""};
+      if (componentKey.indexOf("/") >= 0) {
+        componentKey = componentKey.split("/")[1];
+      }
+      tempConfig.componentKey = `${componentKey}`;
+
+      configContent = JSON.stringify(tempConfig);
+    }
+
+  }
+
   return { zipContent, configContent };
 };
 
@@ -127,7 +189,7 @@ export const publishComponentToServer = async data => {
           const respData = JSON.parse(resp);
           if (status === 401) {
             throw new Error(
-              'Error occured in authentication. Please regenerate using authenticate'
+              'Error occurred in authentication. Please regenerate using authenticate'
             );
             // console.log(accessTokenUri, refreshToken);
             /* TODO - Handle refresh_token */
@@ -139,9 +201,9 @@ export const publishComponentToServer = async data => {
         })
         .catch(e => Promise.reject(`${chalk.bold.red(e)}`));
     } else {
-      throw new Error(`Error occured in authentication. Please regenerate using authenticate`);
+      throw new Error(`Error occurred in authentication. Please regenerate using authenticate`);
     }
   } catch (err) {
-    throw new Error(`Error occured in authentication. Please regenerate using authenticate`);
+    throw new Error(`Error occurred in authentication. Please regenerate using authenticate`);
   }
 };

package/src/tasks/publish/index.js

@@ -3,17 +3,28 @@ import Listr from 'listr';
 import chalk from 'chalk';
 
 import validate from '../validator/index.js';
-import { getComponentDirectoryPath, showVersion } from '../../util.js';
+import { getComponentDirectoryPath, showVersion, getOptionsCategory } from '../../util.js';
 import bundleComponent from '../bundle/index.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';
 
-import { getPublishComponentQuestions, publishComponentToServer, zipComponent } from './helper.js';
 
 export default async options => {
   showVersion();
 
-  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 questions = await getPublishComponentQuestions(category);
   const answers = await inquirer.prompt(questions);
   const { componentKey, sourceMap, devBuild } = answers;
 
@@ -21,54 +32,131 @@ export default async options => {
     ...answers
   };
 
-  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: 'Bundle Component',
-        task: async () => await bundleComponent(componentKey, sourceMap, devBuild),
+        title: 'Bundle component',
+        task: async () => await bundleComponent(componentKey, sourceMap, devBuild, category),
         skip: () => (options.skipBundle ? 'Skipped bundling component' : undefined)
       },
       {
-        title: 'Update Component Map',
+        title: 'Update component map',
         task: async () => {
             await updateComponentMap(componentKey);
         }
       },
       {
-        title: 'Zip Component',
+        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, category),
+        skip: () => (options.skipBundle ? 'Skipped bundling component' : undefined)
+      },
+      {
+        title: 'Update component map',
         task: async () => {
-          const output = await zipComponent(componentKey);
+            await updateComponentMap(componentKey, category);
+        }
+      },
+      {
+        title: 'Zip component',
+        task: async () => {
+          const output = await zipComponent(componentKey, category);
           content = { ...content, ...output };
         }
       },
+      /*
       {
-        title: 'Publish Component',
+        title: 'Publish component',
         task: async () => {
           await publishComponentToServer(content);
         }
       }
+      */
     ],
     {
       exitOnError: true
     }
   );
 
-  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/publish-all/helper.js

@@ -9,11 +9,40 @@ import chalk from 'chalk';
 import {
   constructCompleteUrl,
   getComponentDirectoryPath,
+  getComponents,
   getComponentsObj,
+  getComponentsAndSubDirectory,
   getPegaServerConfig,
-  validateRulesetVersion
+  validateRulesetVersion,
+  getOptionsCategory
 } from '../../util.js';
-import { PUBLISH_COMPONENT_SERVICE_REST_ENDPOINT, TOKEN_PATH } from '../../constants.js';
+import { PUBLISH_COMPONENT_SERVICE_REST_ENDPOINT, TOKEN_PATH, COMPONENT_SCHEMA, CATEGORY_CONSTELLATION, CATEGORY_CUSTOM } from '../../constants.js';
+
+
+export const mapConfigJsonToCompanion = async ( componentKey ) => {
+  const srcDirectory = await getComponentDirectoryPath(componentKey, CATEGORY_CUSTOM);
+  const companionDirectory = await getComponentDirectoryPath(componentKey, CATEGORY_CONSTELLATION);
+  let configContent = fs.readFileSync(`${srcDirectory}/config.json`, { encoding: 'utf8' });
+
+  fs.writeFileSync(`${companionDirectory}/config.json`, configContent, { encoding: 'utf8' });
+
+}
+
+export const getBuildCategory = async (options) => {
+  const categoryType = getOptionsCategory(options);
+
+  return [
+    {
+      name: 'category',
+      type: 'rawlist',
+      message: 'Category of components ?',
+      choices: COMPONENT_SCHEMA.category,
+      when() {
+        return !options.params[4] && categoryType == null;
+      }
+    }
+  ];
+};
 
 export const getPublishComponentQuestions = async () => {
   const components = await getComponentsObj();
@@ -56,24 +85,59 @@ export const getPublishComponentQuestions = async () => {
   ];
 };
 
-export const zipComponent = async componentKey => {
-  const srcDirectory = await getComponentDirectoryPath(componentKey);
+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`;
+  const configExtJson = `${srcDirectory}/config-ext.json`;
 
   const zip = new AdmZip();
 
   zip.addLocalFolder(srcDirectory, 'src/');
-  zip.addLocalFile(configJson);
+  if (category === CATEGORY_CUSTOM || category == CATEGORY_CONSTELLATION) {
+    zip.addLocalFile(configJson);
+  }
+  else {
+    // check to see if have file
+    if (fs.existsSync(configExtJson)) {
+      zip.addLocalFile(configExtJson);
+    }
+
+  }
+
   zip.addLocalFolder(buildDirectory);
   const zipContent = zip.toBuffer().toString('base64');
 
-  const configContent = Buffer.from(fs.readFileSync(`${srcDirectory}/config.json`)).toString();
-  fs.rmdir('dist', { recursive: true }, err => {
-    if (err) {
-      throw err;
+  let configContent = "{ }";
+  if (category === CATEGORY_CUSTOM || category === CATEGORY_CONSTELLATION) {
+    configContent = Buffer.from(fs.readFileSync(`${srcDirectory}/config.json`)).toString();
+    fs.rm('dist', { recursive: true }, err => {
+      if (err) {
+        throw err;
+      }
+    });
+  }
+  else {
+    if (fs.existsSync(configExtJson)) {
+      configContent = Buffer.from(fs.readFileSync(`${srcDirectory}/config-ext.json`)).toString();
+      fs.rm('dist', { recursive: true }, err => {
+        if (err) {
+          throw err;
+        }
+      });
     }
-  });
+    else {
+      const tempConfig = { "componentKey" : ""};
+      if (componentKey.indexOf("/") >= 0) {
+        componentKey = componentKey.split("/")[1];
+      }
+      tempConfig.componentKey = `${componentKey}`;
+
+      configContent = JSON.stringify(tempConfig);
+    }
+
+  }
+
   return { zipContent, configContent };
 };
 
@@ -119,7 +183,7 @@ export const publishComponentToServer = async data => {
           const respData = JSON.parse(resp);
           if (status === 401) {
             throw new Error(
-              'Error occured in authentication. Please regenerate using authenticate'
+              'Error occurred in authentication. Please regenerate using authenticate'
             );
             // console.log(accessTokenUri, refreshToken);
             /* TODO - Handle refresh_token */
@@ -131,9 +195,9 @@ export const publishComponentToServer = async data => {
         })
         .catch(e => Promise.reject(`${chalk.bold.red(e)}`));
     } else {
-      throw new Error(`Error occured in authentication. Please regenerate using authenticate`);
+      throw new Error(`Error occurred in authentication. Please regenerate using authenticate`);
     }
   } catch (err) {
-    throw new Error(`Error occured in authentication. Please regenerate using authenticate`);
+    throw new Error(`Error occurred in authentication. Please regenerate using authenticate`);
   }
 };

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}`);
       }
     }