@pega/dx-component-builder-sdk 0.1.33 → 0.1.35

package/package.json

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

package/src/cli.js

@@ -16,6 +16,7 @@ import {
   overrideAllComponents,
   publishComponent,
   publishAllComponents,
+  renameComponent,
   updateComponent,
   validate,
   upgrade
@@ -31,6 +32,7 @@ const TASKS = {
   MAP_ALL: "mapAll",
   PUBLISH: 'publish',
   PUBLISH_ALL: 'publishAll',
+  RENAME: 'rename',
   LIST: 'list',
   VALIDATE_SCHEMA: 'validateSchema',
   UPDATE: 'update',
@@ -92,6 +94,10 @@ export default async (args = []) => {
       publishAllComponents(options);
       break;
     }
+    case TASKS.RENAME: {
+      renameComponent(options);
+      break;
+    }
     case TASKS.BUILD: {
       buildComponent(options);
       break;

package/src/tasks/build/helper.js

@@ -19,7 +19,7 @@ import { PUBLISH_COMPONENT_SERVICE_REST_ENDPOINT, TOKEN_PATH, COMPONENT_SCHEMA,
 
 
 export const cleanUp = async () => {
-  fs.rm('dist', { recursive: true }, err => {
+  fs.rm('dist/components', { recursive: true }, err => {
     if (err) {
       throw err;
     }
@@ -92,10 +92,10 @@ export const zipComponent = async (componentKey, category = CATEGORY_CUSTOM) =>
   const zipContent = zip.toBuffer().toString('base64');
 
   const configContent = Buffer.from(fs.readFileSync(`${srcDirectory}/config.json`)).toString();
-  fs.rmd('dist', { recursive: true }, err => {
-    if (err) {
-      throw err;
-    }
-  });
+  // fs.rmd('dist/components', { recursive: true }, err => {
+  //   if (err) {
+  //     throw err;
+  //   }
+  // });
   return { zipContent, configContent };
 };

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

@@ -13,7 +13,7 @@ import {
 import { COMPONENT_SCHEMA, CATEGORY_CUSTOM } from '../../constants.js';
 
 export const cleanUp = async () => {
-  fs.rm('dist', { recursive: true }, err => {
+  fs.rm('dist/components', { recursive: true }, err => {
     if (err) {
       throw err;
     }
@@ -75,10 +75,10 @@ export const zipComponent = async (componentKey, category = CATEGORY_CUSTOM) =>
   const zipContent = zip.toBuffer().toString('base64');
 
   const configContent = Buffer.from(fs.readFileSync(`${srcDirectory}/config.json`)).toString();
-  fs.rmd('dist', { recursive: true }, err => {
-    if (err) {
-      throw err;
-    }
-  });
+  // fs.rmd('dist/components', { recursive: true }, err => {
+  //   if (err) {
+  //     throw err;
+  //   }
+  // });
   return { zipContent, configContent };
 };

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

@@ -11,27 +11,7 @@ import { getComponentDirectoryPath, showVersion, getOptionsCategory, getComponen
 
 import { CATEGORY_CUSTOM } from '../../constants.js';
 
-export default async options => {
-  showVersion();
-
-  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 getBuildComponentQuestions(category);
-  const answers = await inquirer.prompt(questions);
-  const { sourceMap, devBuild } = answers;
-
-  let content = {
-    ...answers
-  };
-
-  var componentKey;
+export function getCustomTasks(componentKey, category, sourceMap, devBuild, content, options) {
 
   const customTasks = new Listr(
     [
@@ -71,6 +51,12 @@ export default async options => {
     }
   );
 
+  return customTasks;
+}
+
+
+export function getOverrideTasks(componentKey, category, sourceMap, devBuild, content, options) {
+
   const overrideTasks = new Listr(
     [
       {
@@ -97,12 +83,40 @@ export default async options => {
     }
   );
 
+  return overrideTasks;
+}
+
+export default async options => {
+  showVersion();
+
+  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 getBuildComponentQuestions(category);
+  const answers = await inquirer.prompt(questions);
+  const { sourceMap, devBuild } = answers;
+
+  let content = {
+    ...answers
+  };
+
+  var componentKey;
+
 
   if (category === CATEGORY_CUSTOM) {
     for (var index in components) {
       componentKey = components[index].value;
       console.log(chalk.bold.green("Building: " + components[index].name));
-      await customTasks.run().catch(err => {
+
+      let myCustomTasks = getCustomTasks(componentKey, category, sourceMap, devBuild, content, options);
+
+      await myCustomTasks.run().catch(err => {
          console.log(chalk.bold.red(err.toString()));
       });
     }
@@ -111,7 +125,10 @@ export default async options => {
     for (var index in components) {
       componentKey = components[index].value;
       console.log(chalk.bold.green("Building: " + components[index].name));
-      await overrideTasks.run().catch(err => {
+
+      let myOverrideTasks = getOverrideTasks(componentKey, category, sourceMap, devBuild, content, options);
+
+      await mOverrideTasks.run().catch(err => {
          console.log(chalk.bold.red(err.toString()));
       });
     }

package/src/tasks/index.js

@@ -7,6 +7,7 @@ export { default as deleteAllComponents } from './delete-all/index.js';
 export { default as mapAllComponents } from './map-all/index.js';
 export { default as publishComponent } from './publish/index.js';
 export { default as publishAllComponents } from './publish-all/index.js';
+export { default as renameComponent } from './rename/index.js';
 export { default as listComponents } from './list/index.js';
 export { default as updateComponent } from './update/index.js';
 export { default as validate } from './validator/index.js';

package/src/tasks/map/map.js

@@ -33,9 +33,6 @@ export const updateComponentMap = async (componentKey, category = CATEGORY_CUSTO
 
   let mapData = fs.readFileSync(pegaLocalComponentMapPath, { encoding: 'utf8' });
 
-  let data = fs.readFileSync(pegaConfigJsonPath, { encoding: 'utf8' });
-  data = JSON.parse(data);
-
   let importComponent = join(COMPONENTS_DIRECTORY_PATH, categoryDirectory, componentKey);
   importComponent = "./".concat(importComponent);
 
@@ -77,9 +74,6 @@ export const deleteFromComponentMap = async (componentKey, category = CATEGORY_C
 
   let mapData = fs.readFileSync(pegaLocalComponentMapPath, { encoding: 'utf8' });
 
-  let data = fs.readFileSync(pegaConfigJsonPath, { encoding: 'utf8' });
-  data = JSON.parse(data);
-
   let importComponent = join(COMPONENTS_DIRECTORY_PATH, categoryDirectory, componentKey);
   importComponent = "./".concat(importComponent);
 
@@ -101,3 +95,23 @@ export const deleteFromComponentMap = async (componentKey, category = CATEGORY_C
 
 
 };
+
+export const renameComponentInMap = async (oldComponentKey, newComponentKey) =>  {
+  const pegaLocalComponentMapPath = path.join(path.resolve(), SDK_LOCAL_COMPONENT_MAP_FILENAME);
+
+  const oldComponentNameNoPrefix = removeComponentPrefix(oldComponentKey);
+  const oldComponentName = convertIntoPascalCase(oldComponentNameNoPrefix);
+
+  const newComponentNameNoPrefix = removeComponentPrefix(newComponentKey);
+  const newComponentName = convertIntoPascalCase(newComponentNameNoPrefix);
+
+  let mapData = fs.readFileSync(pegaLocalComponentMapPath, { encoding: 'utf8' });
+
+  if (mapData.indexOf(oldComponentName) >= 0) {
+    mapData = mapData.replaceAll(oldComponentName, newComponentName);
+    mapData = mapData.replaceAll(oldComponentNameNoPrefix, newComponentNameNoPrefix);
+    fs.writeFileSync(pegaLocalComponentMapPath, mapData, { encoding: 'utf8' });
+
+  }
+}
+

package/src/tasks/publish/helper.js

@@ -138,7 +138,7 @@ export const zipComponent = async (componentKey, category = CATEGORY_CUSTOM) =>
   let configContent = "{ }";
   if (category === CATEGORY_CUSTOM || category === CATEGORY_CONSTELLATION) {
     configContent = Buffer.from(fs.readFileSync(`${srcDirectory}/config.json`)).toString();
-    fs.rmdir('dist', { recursive: true }, err => {
+    fs.rmdir('dist/components', { recursive: true }, err => {
       if (err) {
         throw err;
       }
@@ -152,7 +152,7 @@ export const zipComponent = async (componentKey, category = CATEGORY_CUSTOM) =>
   else {
     if (fs.existsSync(configExtJson)) {
       configContent = Buffer.from(fs.readFileSync(`${srcDirectory}/config-ext.json`)).toString();
-      fs.rmdir('dist', { recursive: true }, err => {
+      fs.rmdir('dist/components', { recursive: true }, err => {
         if (err) {
           throw err;
         }

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

@@ -162,7 +162,7 @@ export const zipComponent = async (componentKey, category = CATEGORY_CUSTOM) =>
 };
 
 export const cleanUp = async () => {
-  fs.rm('dist', { recursive: true }, err => {
+  fs.rm('dist/components', { recursive: true }, err => {
     if (err) {
       throw err;
     }

package/src/tasks/rename/index.js

@@ -0,0 +1,333 @@
+import path from 'path';
+import { URL, fileURLToPath } from 'url';
+import fs from 'fs';
+import { promisify } from 'util';
+import { join } from 'path';
+
+import inquirer from 'inquirer';
+import ncp from 'ncp';
+import chalk from 'chalk';
+
+import { checkPathAccess, showVersion, getComponentsObj, getDirectoryFiles } from '../../util.js';
+import { CATEGORY_CONSTELLATION, 
+  CATEGORY_CUSTOM,
+  SDK_CONFIG_JSON_FILENAME,
+  DXCB_CONFIG, 
+  DXCB_COMPONENT_DEFAULTS } from '../../constants.js';
+
+  import { renameComponentInMap  } from '../map/map.js';
+
+
+export const DXCB_CONFIG_INTERNAL_JSON_FILENAME = 'src/dxcb.config.json';
+
+const pegaConfigJsonPath = path.join(path.resolve(), SDK_CONFIG_JSON_FILENAME);
+
+
+import {
+  convertIntoPascalCase,
+  getComponentDirectoryPath,
+  getPegaConfig,
+  getComponentDefaults,
+  sanitize,
+  validateSemver
+} from '../../util.js';
+import { COMPONENT_SCHEMA } from '../../constants.js';
+
+const copy = promisify(ncp);
+
+
+export const updateConfig = async (
+  {
+    oldComponentKey,
+    newComponentKey,
+    library,
+    organization,
+    componentName,
+    componentLabel,
+    version,
+    description,
+    allowedApplications,
+    targetDirectory,
+  },
+  options,
+  onlyCompanion = false
+) => {
+  
+  let configData = fs.readFileSync(join(targetDirectory, "/config.json"), { encoding: 'utf8' });
+  configData = configData && JSON.parse(configData);
+
+  configData.name = newComponentKey;
+  configData.label = componentLabel;
+  configData.organization = organization;
+  if (configData.componentKey) configData.componentKey = newComponentKey;
+  configData.library = library;
+  configData.version = version;
+  configData.description = (description != '') ? description : componentLabel;
+  configData.allowedApplications = allowedApplications;
+
+  // stringify "4", makes the json string look like JSON in the file, formated instead of a single line
+  fs.writeFileSync(join(targetDirectory, "/config.json"), JSON.stringify(configData, null, 4), { encoding: 'utf8' });
+
+};
+
+export const updateFile = async (
+    fileName,
+    oldComponentKeyPC,
+    newComponentKeyPC,
+    targetDirectory,
+) => {
+
+  let fileData = fs.readFileSync(join(targetDirectory, "/", fileName), { encoding: 'utf8' });
+
+  if (fileData.indexOf(oldComponentKeyPC) >= 0) {
+    fileData = fileData.replaceAll(oldComponentKeyPC, newComponentKeyPC);
+
+    fs.writeFileSync(join(targetDirectory, "/", fileName), fileData, { encoding: 'utf8' });
+  }
+  
+};
+
+
+export const renameComponent = async (
+  {
+    library,
+    organization,
+    componentKey,
+    componentName,
+    componentLabel,
+    version,
+    description,
+    allowedApplications
+  },
+  options,
+  onlyCompanion = false
+) => {
+
+
+  let pegaConfig = await getPegaConfig();
+
+  const newComponentKey = `${organization}_${library}_${componentName}`;
+  const typeLC = componentKey.split("/")[0];
+  const oldComponentKey = componentKey.split("/")[1];
+  const newComponentKeyPC = convertIntoPascalCase(newComponentKey);
+  const oldComponentKeyPC = convertIntoPascalCase(oldComponentKey);
+
+  const currentDirectory = await getComponentDirectoryPath(componentKey);
+  const currentDirectoryConstellation = await getComponentDirectoryPath(componentKey, CATEGORY_CONSTELLATION);
+
+  const targetDirectory = await getComponentDirectoryPath(join(typeLC, "/",newComponentKey));
+  const targetDirectoryConstellation = await getComponentDirectoryPath(join(typeLC, "/",newComponentKey), CATEGORY_CONSTELLATION);
+
+  
+
+  // custom component
+  try {
+    fs.renameSync(currentDirectory, targetDirectory);
+  } catch(err) {
+    console.log(err)
+  }
+
+  const targetFileList = await getDirectoryFiles(targetDirectory);
+
+  for (var fileIndex in targetFileList) {
+    const fileName = targetFileList[fileIndex];
+
+    if (fileName === "config.json") {
+      await updateConfig(
+        { 
+          oldComponentKey,
+          newComponentKey,
+          componentName,
+          componentLabel,
+          library,
+          version,
+          description,
+          allowedApplications,
+          organization,
+          targetDirectory,
+        },
+        options
+      );
+    }
+    else {
+      await updateFile(
+          fileName, 
+          oldComponentKeyPC, 
+          newComponentKeyPC, 
+          targetDirectory );
+
+    }
+
+  } // for
+
+  // associated component
+  try {
+    fs.renameSync(currentDirectoryConstellation, targetDirectoryConstellation);
+  } catch(err) {
+    console.log(err)
+  }
+
+  const targetConstellationFileList = await getDirectoryFiles(targetDirectoryConstellation);
+
+  for (var fileIndex in targetConstellationFileList) {
+    const fileName = targetConstellationFileList[fileIndex];
+
+    await updateFile(
+        fileName, 
+        oldComponentKeyPC, 
+        newComponentKeyPC, 
+        targetDirectoryConstellation 
+    );
+
+  } // for
+
+  // update map
+  renameComponentInMap(oldComponentKey, newComponentKey);
+
+  console.log(chalk.green(`Component ${oldComponentKey} renamed to ${newComponentKey}`));
+
+};
+
+
+
+
+
+export default async options => {
+  showVersion();
+
+  await checkPathAccess(pegaConfigJsonPath);
+
+  let data = fs.readFileSync(pegaConfigJsonPath, { encoding: 'utf8' });
+  data = data && JSON.parse(data);
+
+  if (!data[DXCB_CONFIG] || !data[DXCB_CONFIG][DXCB_COMPONENT_DEFAULTS]) {
+    console.error(
+      `${chalk.red.bold('ERROR')} Could not able find component defaults in config.json`
+    );
+    process.exit(1);
+  }
+
+  const componentData = data[DXCB_CONFIG][DXCB_COMPONENT_DEFAULTS];
+
+  const { organization, library} = componentData;
+
+  let componentDefaults = await getComponentDefaults();
+  componentDefaults.library = library;
+
+  const localComponents = await getComponentsObj(true, CATEGORY_CUSTOM);
+
+
+  const questions = [
+    {
+      name: 'componentKey',
+      type: 'rawlist',
+      pageSize: 15,
+      message: 'Select component to rename',
+      choices: localComponents
+    },
+    {
+      name: 'componentName',
+      message: 'Enter new component name (required, no spaces)',
+      validate: value => {
+        /* value should not be empty
+        It should not have spaces
+        It should not start with a number
+        Only case-insensitive alphanumeric values are allowed
+      */
+        if (value && !/^\d/.test(value) && value === sanitize(value)) {
+          return true;
+        }
+        return 'Only alphanumeric values are allowed, starting with alphabets';
+      }
+    },
+    {
+      name: 'componentLabel',
+      message: 'Enter new component label for display (required)',
+      validate: value => {
+        if (value) {
+          return true;
+        }
+        return 'Please provide value for label';
+      }
+    },
+    {
+      name: 'organization',
+      message: 'Enter new component organization',
+      default: componentDefaults.organization,
+      validate: value => {
+        if (value) {
+          return true;
+        }
+        return 'Please provide value for organization';
+      }
+    },
+    {
+      name: 'version',
+      message: 'Enter new component version',
+      default: componentDefaults.version,
+      validate: value => {
+        if (validateSemver(value)) {
+          return true;
+        }
+        return 'Please provide semver compatible version e.g 0.0.1';
+      }
+    },
+    {
+      name: 'library',
+      message: 'Enter new library name (required)',
+      default: componentDefaults.library,
+      validate: value => {
+        /* value should not be empty
+          It should not have spaces
+          It should not start with a number
+          Only case-insensitive alphanumeric values are allowed
+        */
+        if (value && !/^\d/.test(value) && value === sanitize(value)) {
+          return true;
+        }
+        return 'Only alphanumeric values are allowed, starting with alphabets';
+      }
+    },
+    {
+      name: 'allowedApplications',
+      message: 'Please enter the application names to be supported (comma-separated). ',
+      suffix: 'Keep empty for all applications'
+    },
+    {
+      name: 'description',
+      message: 'Enter new description for the component (defaults to new label)',
+      default: componentDefaults.description,
+      /* if left blank and no defaults, mustache will use componentLabel, because description is used in app studio and
+      shouldn't be blank */
+    }
+  ];
+
+  await inquirer.prompt(questions).then(async answers => {
+    const {
+      componentKey,
+      componentName,
+      componentLabel,
+      organization,
+      library,
+      version,
+      description,
+      allowedApplications
+    } = answers;
+
+    await renameComponent(
+      { 
+        componentKey,
+        componentName,
+        componentLabel,
+        library,
+        version,
+        description,
+        allowedApplications,
+        organization
+      },
+      options
+    );
+    
+  });
+  
+};