@pega/custom-dx-components 24.1.12 → 24.2.10

package/src/tasks/create-lib/helper.js

@@ -0,0 +1,112 @@
+
+import chalk from 'chalk';
+
+import {
+  sanitize,
+  validateSemver,
+  getLibraryArchiveDirectories,
+  addDebugLog,
+  getConfigDefaults,
+  getComponents,
+  updateConfigVersion
+} from '../../util.js';
+
+
+export const updateAllComponentsConfig = async( newVersion ) => {
+addDebugLog("updateAllComponentsConfig", `newVersion: ${newVersion}`, "");
+  const componentList = await getComponents();
+  const orgLib =  getConfigDefaults();
+  // const currentOrgLib = `${orgLib.organization}_${orgLib.library}`;
+  const currentOrgLib = orgLib.currentOrgLib;
+
+  for (const index in componentList) {
+    const componentKey = componentList[index];
+    await updateConfigVersion(componentKey, newVersion, currentOrgLib);
+
+  }
+};
+
+export const getCurrentOrOriginalQuestion = async () => {
+addDebugLog("getCurrentOrOriginal", "", "");
+
+  return [
+    {
+      name: 'currentOrOriginal',
+      type: 'rawlist',
+      message: 'Current config changes or original defaults ?',
+      default: 'Original',
+      choices: ['Current', 'Original']
+    }
+  ];
+}
+
+export const getOkToProceedQuestion = async () => {
+addDebugLog("getCreateLibComponentQuestions", "", "");
+
+  return [
+    {
+      name: 'okToContinue',
+      type: 'confirm',
+      message: 'Ok to continue ?',
+      default: true
+    }
+  ];
+
+}
+
+export const getCreateLibComponentQuestions = async (libraryName = "") => {
+addDebugLog("getCreateLibComponentQuestions", "", "");
+  const archDirectories = await getLibraryArchiveDirectories();
+  const orgLib = getConfigDefaults();
+
+
+  return [
+    {
+      name: 'libraryName',
+      message: 'Enter libray name',
+      default: libraryName,
+      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)) {
+          if (archDirectories && archDirectories.length > 0) {
+            const newOrgLib = `${orgLib.organization}_${value}`;
+            if (archDirectories.includes(newOrgLib)) {
+              return `Library ${value} already exists.`;
+            }
+            else {
+              return true;
+            }
+          }
+          else {
+            return true;
+          }
+
+        }
+        else {
+          return 'Only alphanumeric values are allowed, starting with alphabets, no spaces.';
+        }
+      }
+    },
+    {
+      name: 'version',
+      message: 'Enter version ',
+      default: '0.0.1',
+      validate: value => {
+        if (validateSemver(value)) {
+          return true;
+        }
+        return 'Please provide semver compatible version e.g 0.0.1';
+      }
+    },
+    {
+      name: 'permBuild',
+      type: 'confirm',
+      message: `Version to be ${chalk.bold.yellow('PERMANENT')} upon publish `,
+      default: false
+    }
+  ];
+};

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

@@ -0,0 +1,157 @@
+import inquirer from 'inquirer';
+import chalk from 'chalk';
+
+
+// eslint-disable-next-line import/order
+import {
+  showVersion,
+  updateComponentDefaultLibrary,
+  updateComponentDefaultVersion,
+  getLibraryBased,
+  addDebugLog,
+  zipVersionAndArchive,
+  hasArchives,
+  clearSrcComponentsDirectory,
+  hasLibraryAndVersion,
+  getConfigDefaults,
+  forceDefaultsUpdate,
+  cleanUpTemp,
+  restoreTopLevelConfigFilesFromTemplate,
+  getHaveDependencyDifference
+} from '../../util.js';
+
+import { getCreateLibComponentQuestions, getOkToProceedQuestion, updateAllComponentsConfig, getCurrentOrOriginalQuestion } from './helper.js';
+import { showCurrentStatus } from '../show-status/index.js';
+
+export default async options => {
+  const isLibraryBased =  getLibraryBased();
+  if (!isLibraryBased) {
+    console.log(`Command only supported for ${chalk.bold.green('library based')} components.`);
+    process.exit();
+  }
+
+  await showVersion();
+  await cleanUpTemp();
+
+addDebugLog("createLibrary", "", "+");
+  let libraryName = "";
+  let version;
+  // permBuild is the opposite of devBuild
+  let permBuild;
+  const orgLib = getConfigDefaults();
+  const hasArch = await hasArchives();
+
+  let currentOrOriginal = "";
+
+  if (hasArch && options.params.length < 6) {
+    console.log(chalk.bold.yellow('\nBe sure to SAVE all changes before creating a new library, unsaved changes will be LOST.'))
+    console.log(chalk.bold.yellow('Current library/version will be stored and the newly created library/version will be your default.'))
+
+    const okQuestion = await getOkToProceedQuestion();
+    const okAnswers = await inquirer.prompt(okQuestion);
+    const { okToContinue } = okAnswers;
+
+    if (!okToContinue) {
+      return true;
+    }
+  }
+
+
+  if (options.params.length >= 7) {
+    libraryName = options.params[3];
+    version = options.params[4];
+    const dPerm = options.params[5];
+    currentOrOriginal = options.params[6];
+    permBuild = !!(dPerm === 'Y' || dPerm === 'y' || dPerm === true || dPerm === 'true');
+  } else {
+
+    if (!hasArch) {
+      // if no archives, get library name from tasks.config as default
+      libraryName = orgLib.library;
+    }
+
+    const questions = await getCreateLibComponentQuestions(libraryName);
+    const answers = await inquirer.prompt(questions);
+    ({ libraryName, version, permBuild } = answers);
+  }
+
+
+
+  // if have store, then that means there is a current library, so
+  // store it before clearing out /src/components
+
+  if (hasArch) {
+    const hasLib = await hasLibraryAndVersion(libraryName, version, !permBuild);
+    if (hasLib) {
+      console.log(`${chalk.bold.red(`Library ${orgLib.organization}_${libraryName} already exists.`)}`);
+      console.log("You can switch to that library by entering 'npm run switchLib'.\n")
+      process.exit();
+    }
+
+    const currentOrgLib = orgLib.currentOrgLib;
+    const currentVersion = orgLib.buildVersion;
+    await zipVersionAndArchive(currentOrgLib, currentVersion);
+    await clearSrcComponentsDirectory();
+
+  }
+
+  const newOrgLib = `${orgLib.organization}_${libraryName}`;
+
+  if (orgLib.version == null || orgLib.version !== version) {
+    await updateComponentDefaultVersion(version);
+  }
+
+  if (!permBuild) {
+    version = version.concat("-dev");
+  }
+
+  if (hasArch && currentOrOriginal === "") {
+
+    console.log(`\n${chalk.yellow(`You may have updated package.json, and other config files.`)}`);
+    console.log(`${chalk.yellow(`Do you wish to keep those CURRENT changes OR revert back to ORIGINAL install configs.`)}\n`);
+
+    // need to ask the question
+    const curOrgQuestion = await getCurrentOrOriginalQuestion();
+    const currAnswers = await inquirer.prompt(curOrgQuestion);
+    ({ currentOrOriginal } = currAnswers);
+  }
+  else {
+    currentOrOriginal = 'Original';
+  }
+
+  if (currentOrOriginal === 'Original') {
+    await restoreTopLevelConfigFilesFromTemplate();
+  }
+
+
+
+  // update library name in config and create a blank archive
+  await updateComponentDefaultLibrary(libraryName);
+  await zipVersionAndArchive(newOrgLib, version);
+
+  // if didn't have an archive, in case you currently have components there
+  // update the config jsons
+  if (!hasArch) {
+    await updateAllComponentsConfig(version);
+  }
+
+  console.log(`${chalk.bold.green(`\nLibrary ${newOrgLib}/${version} has been created!\n`)}`);
+
+  await forceDefaultsUpdate();
+  await showCurrentStatus();
+
+  if (currentOrOriginal === 'Original') {
+    if (getHaveDependencyDifference()) {
+
+      console.log('\n***************************************************************');
+      console.log(chalk.bold.yellow('Dependencies have changed between libraries, recommend updating.'));
+      console.log(`>>> PLEASE run ${chalk.bold.yellow("'npm update'")}.`);
+      console.log('***************************************************************\n');
+
+    }
+  }
+
+addDebugLog("createLibrary", "END", "-");
+
+  return true;
+};

package/src/tasks/create-version/helper.js

@@ -0,0 +1,82 @@
+import chalk from 'chalk';
+
+import {
+  getComponents,
+  validateSemver,
+  updateConfigVersion,
+  addDebugLog,
+  getLibraryArchivesVersions,
+  getConfigDefaults
+} from '../../util.js';
+
+export const updateAllComponentsConfig = async( newVersion ) => {
+addDebugLog("updateAllComponentsConfig", `newVersion: ${newVersion}`, "");
+  const componentList = await getComponents();
+  const orgLib =  getConfigDefaults();
+  // const currentOrgLib = `${orgLib.organization}_${orgLib.library}`;
+  const currentOrgLib = orgLib.currentOrgLib;
+
+  for (const index in componentList) {
+    const componentKey = componentList[index];
+    await updateConfigVersion(componentKey, newVersion, currentOrgLib);
+
+  }
+};
+
+export const getNextVersion = async () => {
+addDebugLog("getNextVersion", "", "");
+  const orgLib =  getConfigDefaults();
+  const currentOrgLib = orgLib.currentOrgLib;
+  const archiveVersionList = await getLibraryArchivesVersions(currentOrgLib);
+
+  if (archiveVersionList && archiveVersionList.length > 0) {
+    let lastVersion = archiveVersionList[archiveVersionList.length - 1];
+    lastVersion = lastVersion.replaceAll("-dev", "");
+
+    const arVer = lastVersion.split(".");
+    arVer[2] = (parseInt(arVer[2]) + 1).toString();
+    const incrVersion = arVer.join(".");
+
+    return incrVersion;
+  }
+  else {
+    return "0.0.1";
+  }
+
+
+}
+
+export const getCreateVersionComponentQuestions = async () => {
+addDebugLog("getCreateVersionComponentQuestions", "", "");
+  const componentDefaults =  getConfigDefaults();
+
+  // increment the version
+  const incrVersion = await getNextVersion();
+  console.log(`\nCurrent library: ${chalk.green(`${componentDefaults.currentOrgLib}`)}`);
+
+  return [
+    {
+      name: 'version',
+      message: 'Enter version ',
+      default: incrVersion,
+      validate: value => {
+        if (validateSemver(value)) {
+          return true;
+        }
+        return 'Please provide semver compatible version e.g 0.0.1';
+      }
+    },
+    {
+      name: 'permBuild',
+      type: 'confirm',
+      message: `Version ${chalk.bold.yellow('PERMANENT')} upon publish ?`,
+      default: !componentDefaults.devBuild
+    },
+    {
+      name: 'copyExisting',
+      type: 'confirm',
+      message: 'Copy current components to new version ?',
+      default: true
+    },
+  ];
+};

package/src/tasks/create-version/index.js

@@ -0,0 +1,123 @@
+import { join } from 'path';
+import fs from 'fs';
+
+import inquirer from 'inquirer';
+import chalk from 'chalk';
+
+
+// eslint-disable-next-line import/order
+import {
+  showVersion,
+  updateComponentDefaultVersion,
+  getLibraryBased,
+  addDebugLog,
+  zipVersionAndArchive,
+  setConfigDevBuild,
+  checkLibraryAndArchives,
+  getConfigDefaults,
+  forceDefaultsUpdate,
+  modAddAboutData,
+  cleanUpTemp
+} from '../../util.js';
+
+import { getCreateVersionComponentQuestions, updateAllComponentsConfig } from './helper.js';
+import { showCurrentStatus } from '../show-status/index.js';
+
+export default async options => {
+  const isLibraryBased =  getLibraryBased();
+  if (!isLibraryBased) {
+    console.log(`Command only supported for ${chalk.bold.green('library mode')} components.`);
+    process.exit();
+  }
+
+  await showVersion();
+  await checkLibraryAndArchives();
+  await cleanUpTemp();
+
+addDebugLog("createVersion", "", "+");
+  let libraryName;
+  let version;
+  // permBuild is the opposite of devBuild
+  let permBuild;
+  let copyExisting;
+
+  const componentDefaults =  getConfigDefaults();
+  const currentDirectory = process.cwd();
+  const componentDirectory = join (currentDirectory, "src", "components");
+
+
+  if (options.params.length >= 6) {
+    version = options.params[3];
+    const dPerm = options.params[4];
+    const copyExist = options.params[5]
+
+    // if have [6] will be "NoAbout" from Jest, to turn off build date
+    if (options.params.length >= 7 ) {
+      if (options.params[6] === "NoAbout") {
+        modAddAboutData(false);
+      }
+    }
+
+    permBuild = !!(dPerm === 'Y' || dPerm === 'y' || dPerm === true || dPerm === 'true');
+    copyExisting = !!(copyExist === 'Y' || copyExist === 'y' || copyExist === true || copyExist === 'true');
+
+  } else {
+    const questions = await getCreateVersionComponentQuestions();
+    const answers = await inquirer.prompt(questions);
+    ({ version, permBuild, copyExisting } = answers);
+  }
+
+  const orgLib =  getConfigDefaults();
+  const savedNewVersion = version;
+  const existingOrgLib = orgLib.currentOrgLib;
+  let oldVersion = componentDefaults.version;
+  if (componentDefaults.devBuild) {
+    oldVersion = oldVersion.concat("-dev");
+  }
+
+  if (!permBuild) {
+    version = version.concat("-dev");
+  }
+
+  // store existing
+  await zipVersionAndArchive(existingOrgLib, oldVersion);
+
+  if (copyExisting) {
+    // change all existing config to new version
+    await updateAllComponentsConfig(version);
+  }
+  else {
+    // wipe out /src/components
+    try {
+      fs.rmSync(componentDirectory, { recursive: true });
+addDebugLog("createVersion", `clear out: ${componentDirectory}`, "");
+    } catch (err) {
+      console.log(`No such directory: ${componentDirectory} `);
+      throw new Error(`No such file ${componentDirectory}`);
+    }
+
+    // create a blank directory
+addDebugLog("createVersion", `make new directory: ${componentDirectory}`, "");
+    fs.mkdirSync(componentDirectory, { recursive: true });
+  }
+
+  // update config with new version
+  await updateComponentDefaultVersion(savedNewVersion);
+  await setConfigDevBuild(!permBuild);
+
+  // create archive of new
+  await zipVersionAndArchive(existingOrgLib, version);
+
+
+
+  console.log(`${chalk.bold.green(`\nLibrary ${existingOrgLib}/${oldVersion} has been stored.`)}`);
+  console.log(`${chalk.bold.green(`Library ${existingOrgLib}/${version} has been created!\n`)}`);
+
+  await forceDefaultsUpdate();
+  await showCurrentStatus();
+
+
+addDebugLog("createVersion", "END", "-");
+
+  return true;
+};

package/src/tasks/delete/helper.js

@@ -13,7 +13,8 @@ import {
   getComponents,
   getPegaServerConfig,
   standardizeStr,
-  sanitize
+  sanitize,
+  addDebugLog
 } from '../../util.js';
 import { getComponentsFromServer } from '../list/helper.js';
 
@@ -29,6 +30,8 @@ let organization;
 
 
 export const getDeleteComponentsQuestions = async (options) => {
+addDebugLog("getDeleteComponentsQuestions", "", "");
+
   const defaultPegaServerConfig = await getPegaServerConfig();
 
   return [
@@ -46,6 +49,7 @@ export const getDeleteComponentsQuestions = async (options) => {
 };
 
 export const getLaunchPadFilterQuestions = async () => {
+addDebugLog("getLaunchPadFilterQuestions", "", "");
   const defaultPegaServerConfig = await getPegaServerConfig();
 
   const currentDirectory = process.cwd();
@@ -93,6 +97,7 @@ export const getLaunchPadFilterQuestions = async () => {
 }
 
 export const deleteLocalComponents = async (sourceOfComponents, options) => {
+addDebugLog("deleteLocalComponents", `sourceOfComponnents: ${sourceOfComponents}`, "" );
   const localComponents = await getComponents();
 
   if (localComponents.length > 0) {
@@ -128,7 +133,7 @@ export const deleteLocalComponents = async (sourceOfComponents, options) => {
 };
 
 export const deleteServerComponents = async (sourceOfComponents, answers) => {
-
+addDebugLog("deleteServerComponents", `sourceOfComponents: ${sourceOfComponents}`, "");
   const defaultPegaServerConfig = await getPegaServerConfig();
   const isLaunchpad = defaultPegaServerConfig.serverType === 'launchpad';
 
@@ -146,15 +151,13 @@ export const deleteServerComponents = async (sourceOfComponents, answers) => {
     spinner = ora('Fetching components from server').start();
     data = await getComponentsFromServer(library, organization);
     spinner.stop();
-  } catch (error) {
+  }
+  catch (error) {
     spinner.stop();
-    if (error.indexOf('ECONNREFUSED') >= 0) {
-      console.log(
-        `\n${chalk.bold.red(
-          'Error occurred in authentication. Please regenerate using authenticate'
-        )}`
-      );
-    } else {
+    if (error.indexOf("ECONNREFUSED") >= 0) {
+      console.log(`\n${chalk.bold.red('Error occurred in authentication. Please regenerate using authenticate')}`);
+    }
+    else {
       console.log(`${chalk.bold.red(error)}`);
     }
 

package/src/tasks/delete/index.js

@@ -1,10 +1,12 @@
 import inquirer from 'inquirer';
 
-import { showVersion } from '../../util.js';
+import { showVersion, getLibraryBased, addDebugLog, checkLibraryAndArchives } from '../../util.js';
 
 import { deleteLocalComponents, SOURCE_OF_COMPONENT_TYPES, deleteServerComponents, getDeleteComponentsQuestions } from './helper.js';
 
+
 const deleteComponentsFn = async (sourceOfComponents, answers, options) => {
+addDebugLog("deleteComponentsFn", `sourceOfComponents: ${sourceOfComponents}`, "");
   switch (sourceOfComponents) {
     case SOURCE_OF_COMPONENT_TYPES.LOCAL: {
       await deleteLocalComponents(sourceOfComponents, options);
@@ -22,21 +24,32 @@ const deleteComponentsFn = async (sourceOfComponents, answers, options) => {
 };
 
 export default async (options) => {
-  showVersion();
+  await showVersion();
+  await checkLibraryAndArchives();
+  const isLibraryBased = getLibraryBased();
+
+addDebugLog("delete", "", "+");
 
   let sourceOfComponentsOption = SOURCE_OF_COMPONENT_TYPES.LOCAL;
-  if (options.params[3] === SOURCE_OF_COMPONENT_TYPES.LOCAL) {
+  if (isLibraryBased) {
+    sourceOfComponentsOption = SOURCE_OF_COMPONENT_TYPES.LOCAL;
+    await deleteComponentsFn(sourceOfComponentsOption, null, options);
+  }
+  else if (options.params[3] === SOURCE_OF_COMPONENT_TYPES.LOCAL) {
     sourceOfComponentsOption = options.params[3];
     await deleteComponentsFn(sourceOfComponentsOption, null, options);
-  } else if (options.params[3] === SOURCE_OF_COMPONENT_TYPES.SERVER) {
+  }
+  else if (options.params[3] === SOURCE_OF_COMPONENT_TYPES.SERVER) {
     sourceOfComponentsOption = options.params[3];
     const questions = await getDeleteComponentsQuestions(options, sourceOfComponentsOption);
     const answers = await inquirer.prompt(questions);
     await deleteComponentsFn(sourceOfComponentsOption, answers, options);
-  } else {
+  }
+  else {
     const questions = await getDeleteComponentsQuestions(options);
     const answers = await inquirer.prompt(questions);
     const { sourceOfComponents } = answers;
     await deleteComponentsFn(sourceOfComponents, answers, options);
   }
+addDebugLog("delete", "END", "-");
 };

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

@@ -12,7 +12,8 @@ import {
   getComponents,
   getPegaServerConfig,
   standardizeStr,
-  validateRulesetVersion
+  validateRulesetVersion,
+  addDebugLog
 } from '../../util.js';
 import { getComponentsFromServer } from '../list/helper.js';
 import { TASKS_CONFIG_JSON_FILENAME, COMPONENTS_DIRECTORY_PATH, COMPONENTS_PATH } from '../../constants.js';
@@ -27,6 +28,7 @@ let organization;
 
 
 export const getDeleteComponentsQuestions = async (options) => {
+addDebugLog("getDeleteComponentsQuestions", "", "");
   const defaultPegaServerConfig = await getPegaServerConfig();
 
   return [
@@ -44,6 +46,7 @@ export const getDeleteComponentsQuestions = async (options) => {
 };
 
 export const getLaunchPadFilterQuestions = async () => {
+addDebugLog("getLaunchPadFilterQuestions", "", "");
   const currentDirectory = process.cwd();
   const pegaConfigJsonPath = join(currentDirectory, TASKS_CONFIG_JSON_FILENAME);
 
@@ -89,6 +92,7 @@ export const getLaunchPadFilterQuestions = async () => {
 }
 
 export const deleteLocalComponents = async (sourceOfComponents, options) => {
+addDebugLog("deleteLocalComponents", `sourceOfCompnents: ${sourceOfComponents}`, "");
   const localComponents = await getComponents();
 
   // eslint-disable-next-line no-restricted-syntax, guard-for-in
@@ -132,7 +136,7 @@ export const deleteLocalComponents = async (sourceOfComponents, options) => {
 };
 
 export const deleteServerComponents = async (sourceOfComponents, answers) => {
-
+addDebugLog("deleteServerComponents", `sourceOfCompnents: ${sourceOfComponents}`, "");
   const defaultPegaServerConfig = await getPegaServerConfig();
   const isLaunchpad = defaultPegaServerConfig.serverType === 'launchpad';
 

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

@@ -1,10 +1,17 @@
 import inquirer from 'inquirer';
 
-import { showVersion } from '../../util.js';
+import { showVersion, getLibraryBased, addDebugLog, checkLibraryAndArchives } from '../../util.js';
+
+import {
+  deleteLocalComponents,
+  SOURCE_OF_COMPONENT_TYPES,
+  deleteServerComponents,
+  getDeleteComponentsQuestions
+} from './helper.js';
 
-import { deleteLocalComponents, SOURCE_OF_COMPONENT_TYPES, deleteServerComponents, getDeleteComponentsQuestions } from './helper.js';
 
 const deleteComponentsFn = async (sourceOfComponents, answers, options) => {
+  addDebugLog('deleteComponentsFn', `sourceOfComponents: ${sourceOfComponents}`, '');
   switch (sourceOfComponents) {
     case SOURCE_OF_COMPONENT_TYPES.LOCAL: {
       await deleteLocalComponents(sourceOfComponents, options);
@@ -21,11 +28,18 @@ const deleteComponentsFn = async (sourceOfComponents, answers, options) => {
   }
 };
 
-export default async (options) => {
-  showVersion();
+export default async options => {
+  await showVersion();
+  await checkLibraryAndArchives();
+  const isLibraryBased = getLibraryBased();
+
+  addDebugLog('deleteAll', '', '+');
 
   let sourceOfComponentsOption = SOURCE_OF_COMPONENT_TYPES.LOCAL;
-  if (options.params[3] === SOURCE_OF_COMPONENT_TYPES.LOCAL) {
+  if (isLibraryBased) {
+    sourceOfComponentsOption = SOURCE_OF_COMPONENT_TYPES.LOCAL;
+    await deleteComponentsFn(sourceOfComponentsOption, null, options);
+  } else if (options.params[3] === SOURCE_OF_COMPONENT_TYPES.LOCAL) {
     sourceOfComponentsOption = options.params[3];
     await deleteComponentsFn(sourceOfComponentsOption, null, options);
   } else if (options.params[3] === SOURCE_OF_COMPONENT_TYPES.SERVER) {
@@ -39,4 +53,6 @@ export default async (options) => {
     const { sourceOfComponents } = answers;
     await deleteComponentsFn(sourceOfComponents, answers, options);
   }
+
+  addDebugLog('deleteAll', 'END', '-');
 };