@pega/custom-dx-components 0.242.34 → 0.242.36

package/src/tasks/import-comp/index.js

@@ -0,0 +1,320 @@
+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 {
+  sanitize,
+  checkPathAccess,
+  showVersion,
+  getDirectoryFiles,
+  addDebugLog,
+  checkLibraryAndArchives,
+  getConfigDefaults,
+  getComponents
+ } from '../../util.js';
+import { TASKS_CONFIG_JSON_FILENAME } from '../../constants.js';
+import { getFilePathQuestions, getFileNameQuestions  } from './helper.js';
+
+export const DXCB_CONFIG_INTERNAL_JSON_FILENAME = 'src/dxcb.config.json';
+const currentDirectory = process.cwd();
+const pegaConfigJsonPath = join(currentDirectory, TASKS_CONFIG_JSON_FILENAME);
+
+import {
+  convertIntoPascalCase,
+  getComponentDirectoryPath
+} from '../../util.js';
+
+
+const copy = promisify(ncp);
+
+let gFilePath = "";
+
+
+export const updateConfig = async (
+  {
+    oldComponentKey,
+    newComponentKey,
+    library,
+    version,
+    targetDirectory,
+    newLabel = "",
+  },
+  options,
+  onlyCompanion = false
+) => {
+
+addDebugLog("updateConfig", `oldComponentKey: ${oldComponentKey}, newComponentKey: ${newComponentKey}`, "");
+
+  let configData = fs.readFileSync(join(targetDirectory, "/config.json"), { encoding: 'utf8' });
+  configData = configData && JSON.parse(configData);
+
+  configData.name = newComponentKey;
+  if (configData.componentKey) configData.componentKey = newComponentKey;
+  configData.library = library;
+  configData.version = version;
+
+  if (newLabel != "") {
+    configData.label = newLabel;
+    configData.description = newLabel;
+  }
+
+  // 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,
+) => {
+
+addDebugLog("updateFile", `fileName: ${fileName}, oldComponentKeyPC: ${oldComponentKeyPC}, newComponentKeyPC: ${newComponentKeyPC}, targetDirectory: ${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' });
+  }
+
+};
+
+
+// rename the component
+export const renameComponent = async (
+    componentKey,
+    library,
+    version,
+    newName = "",
+    newLabel = "",
+    options
+) => {
+
+addDebugLog("renameComponent", `library: ${library}, componentKey: ${componentKey}`, "");
+
+  const componentName = newName != "" ? newName : componentKey.split("_")[2];
+  const newComponentKey = `${library}_${componentName}`;
+  const oldComponentKey = componentKey;
+  const newComponentKeyPC = convertIntoPascalCase(newComponentKey);
+  const oldComponentKeyPC = convertIntoPascalCase(oldComponentKey);
+
+  const currentDirectory = await getComponentDirectoryPath(componentKey);
+  const targetDirectory = await getComponentDirectoryPath(newComponentKey);
+
+  // 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,
+          library,
+          version,
+          targetDirectory,
+          newLabel
+        },
+        options
+      );
+    }
+    else {
+      await updateFile(
+          fileName,
+          oldComponentKeyPC,
+          newComponentKeyPC,
+          targetDirectory );
+
+    }
+
+  } // for
+
+
+  return newComponentKey;
+
+};
+
+
+export const importComp = async(filePath, fileName) => {
+addDebugLog("importComp", `filePath: ${filePath}, fileName: ${fileName}`, "");
+
+  const currentDirectory = process.cwd();
+  const compDirectory = join(currentDirectory, "src", "components");
+  const copyFilePath = join(filePath, fileName);
+
+  const configDef = getConfigDefaults();
+  const copyDir = join(compDirectory, fileName);
+
+  if (fs.existsSync(copyFilePath)) {
+    fs.cpSync(copyFilePath, copyDir, { recursive: true, force: true  });
+  }
+
+  let configData = fs.readFileSync(join(copyDir, "/config.json"), { encoding: 'utf8' });
+  configData = configData && JSON.parse(configData);
+
+  const compName = configData.componentKey.split("_")[2];
+  const potentialCompKey = `${configDef.currentOrgLib}_${compName}`;
+  const currentCompList = await getComponents();
+  let newName = "";
+  let newLabel = "";
+
+  if (currentCompList && currentCompList.includes(potentialCompKey)) {
+    console.log(`\nComponent ${chalk.yellow(`${potentialCompKey}`)} already exists.`);
+    const proceedAnswers = await inquirer.prompt([
+
+      {
+        name: 'proceedAs',
+        type: 'rawlist',
+        message: `Proceed as ?`,
+        default: 'No import',
+        choices: ['No import', 'Overwrite', 'New name']
+      },
+      {
+        name: 'componentName',
+        message: 'Enter component name (required)',
+        when(answers) {
+          return answers.proceedAs === 'New name';
+        },
+        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, no spaces.';
+        }
+      },
+      {
+        name: 'componentLabel',
+        message: 'Enter component label for display (required)',
+        when(answers) {
+          return answers.proceedAs === 'New name';
+        },
+        validate: value => {
+          if (value) {
+            return true;
+          }
+          return 'Please provide value for label';
+        }
+      }
+    ]);
+
+    switch (proceedAnswers.proceedAs) {
+      case 'No import':
+        // removed copied
+        fs.rmSync(copyDir, { recursive: true, force: true, maxRetries: 2 });
+        process.exit();
+        break;
+      case 'Overwrite':
+        // remove existing
+        const exitingComp = join(compDirectory, potentialCompKey);
+        fs.rmSync(exitingComp, { recursive: true, force: true, maxRetries: 2 });
+        break;
+      case 'New name':
+        newName = proceedAnswers.componentName;
+        newLabel = proceedAnswers.componentLabel;
+        break;
+    }
+
+  }
+
+  const newCompKey = await renameComponent(configData.componentKey, configDef.currentOrgLib, configDef.buildVersion, newName, newLabel, null);
+  console.log(`\n${chalk.green(`${fileName}`)} has been imported as ${chalk.green(`${newCompKey}`)}`);
+
+
+}
+
+
+export const getFolderList = async (filePath) => {
+addDebugLog("getFolderList", `filePath: ${filePath}`, "");
+  if (fs.existsSync(filePath)) {
+    return fs
+      .readdirSync(filePath, { withFileTypes: true })
+      .filter(dirent => dirent.isDirectory())
+      .map(dirent => dirent.name);
+  }
+  else {
+    console.log(chalk.red.bold(`File path: ${filePath} does not exist or no permissions.`));
+    process.exit(1);
+  }
+}
+
+export const hasConfig = (dir) => {
+  const configPath = join(gFilePath, dir, "config.json");
+  if (fs.existsSync(configPath)) {
+    return true;
+  }
+
+  return false;
+}
+
+export const getComponentList = async(filePath) => {
+addDebugLog("getComponentList", `filePath: ${filePath}`, "");
+  let compList = await getFolderList(filePath);
+
+  gFilePath = filePath;
+
+  if (compList.length > 0) {
+    return compList.filter(hasConfig);
+  }
+
+  return compList;
+
+}
+
+export default async options => {
+  await showVersion();
+  await checkLibraryAndArchives();
+  await checkPathAccess(pegaConfigJsonPath);
+
+addDebugLog("importComponent", "", "+");
+
+  if (options.params.length >= 5) {
+    const filePath = options.params[3];
+    const fileName = options.params[4];
+    await importComp( filePath, fileName);
+
+  }
+  else {
+
+    const filePathQuestions = await getFilePathQuestions();
+    const filePathAnswers = await inquirer.prompt(filePathQuestions);
+    const { filePath } = filePathAnswers;
+
+    const compFileList = await getComponentList(filePath);
+
+    if (!compFileList || compFileList.length === 0) {
+      console.log(chalk.red.bold(`No component files exist at path: ${filePath}`));
+      process.exit();
+    }
+
+    const fileNameQuestions = await getFileNameQuestions(compFileList);
+    const fileNameAnswers = await inquirer.prompt(fileNameQuestions);
+    const {fileName} = fileNameAnswers;
+
+    await importComp( filePath, fileName);
+
+  }
+
+addDebugLog("importComponent", "END", "-");
+
+};

package/src/tasks/index.js

@@ -18,6 +18,7 @@ export { default as moveComponent } from './move/index.js';
 export { default as renameComponent } from './rename/index.js';
 export { default as renameLibrary } from './rename-lib/index.js';
 export { default as revertWebPack } from './revert-webpack/index.js';
+export { default as quarantine } from './quarantine/index.js';
 export { default as listComponents } from './list/index.js';
 export { default as listLibrary } from './list-lib/index.js';
 export { default as listPublished } from './list-pub/index.js';
@@ -27,6 +28,7 @@ export { default as setPermanent } from './set-perm/index.js';
 export { default as storeComponents } from './store/index.js';
 export { default as importArchive } from './import-archive/index.js';
 export { default as exportArchive } from './export-archive/index.js';
+export { default as importComponent } from './import-comp/index.js';
 export { default as updateComponent } from './update/index.js';
 export { default as validate } from './validator/index.js';
 export { default as authenticate } from './authenticate/index.js';

package/src/tasks/init/template/package.json.mustache

@@ -19,6 +19,7 @@
     "update": "custom-dx-components update",
     "delete": "custom-dx-components delete",
     "deleteAll": "custom-dx-components deleteAll",
+    "importComponent": "custom-dx-components importComponent",
     "_***Component_mode_only***": "Component only commands",
     "publish": "custom-dx-components publish",
     "publishAll": "custom-dx-components publishAll",
@@ -34,7 +35,7 @@
     "deleteLib": "custom-dx-components deleteLibrary",
     "deletePublishedLib": "custom-dx-components deletePublished",
     "deleteLibVersion": "custom-dx-components deleteVersion",
-    "moveLibVersion": "custom-dx-components moveComponent",
+    "move": "custom-dx-components moveComponent",
     "publishLibVersion": "custom-dx-components publish",
     "storeLibVersion": "custom-dx-components storeComponents",
     "showStatus": "custom-dx-components showStatus",
@@ -47,11 +48,12 @@
     "_internal-test-coverage": "node --input-type=module  --experimental-vm-modules node_modules/jest/bin/jest.js --runInBand node_modules/@pega/custom-dx-component --ci --testResultsProcessor='jest-junit' --coverage",
     "_internal-test": "echo 'Running functional and unit tests will DELETE existing local components, proceed (y/n)?' && read proceed && if test \"$proceed\" = \"y\"; then npm run _internal-test-full; fi ",
     "_internal-test-full": "npm run _internal-test-functional && npm run _internal-test-unit",
-    "_internal-test-functional": "npm run test:functional:local --prefix node_modules/@pega/custom-dx-components",
+    "_internal-test-functional": "echo '\nMake sure you authenticate!!\n' && npm run test:functional:local --prefix node_modules/@pega/custom-dx-components",
     "_internal-test-unit": "npm run test:unit:local --prefix node_modules/@pega/custom-dx-components",
     "_internal-build-jest-assets": "custom-dx-components buildJestAssets",
     "_internal-buildLibrary": "custom-dx-components buildLibrary",
     "_internal-publishLibrary": "custom-dx-components publishLibrary",
+    "_internal-test-quarantine": "custom-dx-components quarantine",
     "_lint:styles": "stylelint \"./**/*.@(js|jsx|ts|tsx)\"",
     "_lint:format": "prettier -c .",
     "_lint:spelling": "cspell --no-progress **/*",
@@ -98,7 +100,7 @@
   },
   "devDependencies": {
     "@pega/configs": "^0.6.0",
-    "@pega/custom-dx-components": "0.242.34",
+    "@pega/custom-dx-components": "0.242.36",
     "@pega/pcore-pconnect-typedefs": "~3.0.0",
     "@storybook/addon-actions": "^7.6.7",
     "@storybook/addon-essentials": "^7.6.19",

package/src/tasks/list-lib/index.js

@@ -1,7 +1,7 @@
 import inquirer from 'inquirer';
 import chalk from 'chalk';
 
-import {showVersion, getLibraryBased, addDebugLog, checkLibraryAndArchives, getLibraryArchivesVersions, getConfigDefaults, getLocalArchivedLibrraryVersionData, getComponentsConfigs } from '../../util.js';
+import {showVersion, getLibraryBased, addDebugLog, checkLibraryAndArchives, getLibraryArchivesVersions, getConfigDefaults, getLocalArchivedLibrraryVersionData, getComponentsConfigs, cleanUpTemp } from '../../util.js';
 import { getArchiveLibraryQuestions } from './helper.js';
 
 export default async (options) => {
@@ -16,7 +16,8 @@ export default async (options) => {
   await checkLibraryAndArchives();
 addDebugLog("listLibrary", "", "+");
 
-  let sourceOfLibrary;
+  await cleanUpTemp();
+
   let organization;
   let library;
 
@@ -29,24 +30,28 @@ addDebugLog("listLibrary", "", "+");
   let libVersions = [];
 
   if (options.params.length >= 5) {
-    // sourceOfLibrary = options.params[3];
-    // selectedVersion = options.params[4];
+    libraryName = options.params[3];
+    selectedVersion = options.params[4];
 
-    // libVersions.push(selectedVersion);
+    try {
+      libVersions = await getLibraryArchivesVersions(libraryName, "");
+    }
+    catch (ex) {}
 
   }
+  else {
 
-  const questions = await getArchiveLibraryQuestions();
-  const answers = await inquirer.prompt(questions);
-  ({ libraryName } = answers);
+    const questions = await getArchiveLibraryQuestions();
+    const answers = await inquirer.prompt(questions);
+    ({ libraryName } = answers);
 
-  try {
-    libVersions = await getLibraryArchivesVersions(libraryName, "");
-  }
-  catch (ex) {}
+    try {
+      libVersions = await getLibraryArchivesVersions(libraryName, "");
+    }
+    catch (ex) {}
 
 
-  if (libVersions.length > 0) {
+    if (libVersions.length > 0) {
 
       if (selectedVersion === undefined) {
         const libAnswers = await inquirer.prompt([
@@ -61,10 +66,14 @@ addDebugLog("listLibrary", "", "+");
 
         selectedVersion = libAnswers.libVersion;
       }
+    }
+  }
+
+  let data;
+  // get built on from first component if exists
+  let builtOn = "(date unavailable)";
 
-      let data;
-      // get built on from first component if exists
-      let builtOn = "(date unavailable)";
+  if (libVersions.length > 0) {
 
       if (libraryName === compDef.currentOrgLib && selectedVersion === compDef.buildVersion) {
 

package/src/tasks/list-pub/index.js

@@ -1,7 +1,7 @@
 import inquirer from 'inquirer';
 import chalk from 'chalk';
 
-import {showVersion, getC11NB2STokenAndStaticServer, getLocalLibraries, getLocalLibraryVersions, getLocalLibraryVersionData, getLibraryBased, addDebugLog, checkLibraryAndArchives, getConfigDefaults } from '../../util.js';
+import {showVersion, getC11NB2STokenAndStaticServer, getLocalLibraries, getLocalLibraryVersions, getLocalLibraryVersionData, getLibraryBased, addDebugLog, checkLibraryAndArchives, getConfigDefaults, cleanUpTemp } from '../../util.js';
 
 import { listLibJSONResponse } from '@pega/constellation-dx-components-build-utils/index.js';
 
@@ -43,6 +43,7 @@ export default async (options) => {
   await showVersion();
   await checkLibraryAndArchives();
 addDebugLog("listPublished", "", "+");
+  await cleanUpTemp();
 
   let sourceOfLibrary;
   let organization;
@@ -51,13 +52,14 @@ addDebugLog("listPublished", "", "+");
   const compDef = getConfigDefaults();
   organization = compDef.organization;
   library = compDef.library;
-  let libraryName;
-  let selectedVersion;
+  let libraryName = "";
+  let selectedVersion = "";
   let libVersions = [];
 
   if (options.params.length >= 5) {
     sourceOfLibrary = options.params[3];
-    selectedVersion = options.params[4];
+    libraryName = options.params[4];
+    selectedVersion = options.params[5];
 
     libVersions.push(selectedVersion);
 
@@ -74,16 +76,18 @@ addDebugLog("listPublished", "", "+");
     // local
     const arLibs = await getLocalLibraries();
 
-    const libAnswers = await inquirer.prompt([
-      {
-        name: 'library',
-        type: 'rawlist',
-        message: 'Pick library',
-        choices: arLibs
-      }
-    ]);
+    if (libraryName === "") {
+      const libAnswers = await inquirer.prompt([
+        {
+          name: 'library',
+          type: 'rawlist',
+          message: 'Pick library',
+          choices: arLibs
+        }
+      ]);
 
-    libraryName = libAnswers.library;
+      libraryName = libAnswers.library;
+    }
 
     if (libVersions.length == 0) {
       try {
@@ -96,7 +100,7 @@ addDebugLog("listPublished", "", "+");
 
     if (libVersions.length > 0) {
 
-        if (selectedVersion === undefined) {
+        if (selectedVersion === "") {
           const libAnswers = await inquirer.prompt([
             {
               name: 'libVersion',

package/src/tasks/move/helper.js

@@ -36,21 +36,24 @@ addDebugLog("getLibraryQuestions", "", "");
   ];
 };
 
-export const getLibraryVersionQuestion = async (libraryName, libVersions) => {
+export const getLibraryVersionQuestion = async (libraryName, libVersions, copyOrMove) => {
 addDebugLog("getLibraryVersionQuestion", `libraryName: ${libraryName}`, "");
+  const configDef = getConfigDefaults();
 
   return [
     {
       name: 'version',
       type: 'rawlist',
-      message: `Select ${chalk.green.bold(`${libraryName}`)} library version to move to`,
+      message: `Select ${chalk.green.bold(`${libraryName}`)} library version to ${copyOrMove} to`,
       choices: libVersions
     },
     {
       name: 'copyShared',
       type: 'confirm',
       message: `Copy ${chalk.yellow.bold("/shared")} directory (same named files will be overridden) ?`,
-      default: true
+      default: true,
+      when: (answers) => (answers.version != configDef.buildVersion && libraryName != configDef.library)
+
     },
   ];
 };