@pega/custom-dx-components 0.242.23 → 0.242.25

package/src/tasks/rename/index.js

@@ -7,7 +7,7 @@ import inquirer from 'inquirer';
 import ncp from 'ncp';
 import chalk from 'chalk';
 
-import { checkPathAccess, showVersion, getComponentsObj, getDirectoryFiles } from '../../util.js';
+import { checkPathAccess, showVersion, getComponentsObj, getDirectoryFiles, addDebugLog } from '../../util.js';
 import { TASKS_CONFIG_JSON_FILENAME, COMPONENTS_DIRECTORY_PATH, COMPONENTS_PATH } from '../../constants.js';
 
 
@@ -47,6 +47,8 @@ export const updateConfig = async (
   onlyCompanion = false
 ) => {
 
+addDebugLog("updateConfig", `oldComponentKey: ${oldComponentKey}, newComponentKey: ${newComponentKey}`, "");
+
   let configData = fs.readFileSync(join(targetDirectory, "/config.json"), { encoding: 'utf8' });
   configData = configData && JSON.parse(configData);
 
@@ -83,6 +85,8 @@ export const updateFile = async (
     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) {
@@ -109,6 +113,7 @@ export const renameComponent = async (
   onlyCompanion = false
 ) => {
 
+addDebugLog("renameComponent", `library: ${library}, organization: ${organization}, componentKey: ${componentKey}`, "");
 
   let pegaConfig = await getPegaConfig();
 
@@ -174,7 +179,9 @@ export const renameComponent = async (
 
 
 export default async options => {
-  showVersion();
+  await showVersion();
+
+addDebugLog("rename", "", "+");
 
   await checkPathAccess(pegaConfigJsonPath);
 
@@ -347,6 +354,6 @@ export default async options => {
     });
   }
 
-
+addDebugLog("rename", "END", "-");
 
 };

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

@@ -17,7 +17,8 @@ import {
   deleteLocalLibrary,
   getC11NB2STokenAndStaticServer,
   updateComponentDefaultLibrary,
-  updateDefaultOrganization
+  updateDefaultOrganization,
+  addDebugLog
 } from '../../util.js';
 import {
   TASKS_CONFIG_JSON_FILENAME,
@@ -39,13 +40,15 @@ import {
   getPegaConfig,
   getComponentDefaults,
   getComponents,
-  getAboutData,
   sanitize
 } from '../../util.js';
 
 const copy = promisify(ncp);
 
 export const getOrgLib = async () => {
+
+addDebugLog("getOrgLib", "", "+");
+
   const defaultPegaConfig = await getPegaServerConfig();
 
   await checkPathAccess(pegaConfigJsonPath);
@@ -70,6 +73,9 @@ export const getOrgLib = async () => {
   componentDefaults.library = library;
   componentDefaults.organization = organization;
 
+addDebugLog("getOrgLib", `componentsDefaults: ${JSON.stringify(componentDefaults)}`, "");
+addDebugLog("getOrgLib", "END", "-");
+
   return componentDefaults;
 };
 
@@ -89,6 +95,9 @@ export const updateConfig = async (
   options,
   onlyCompanion = false
 ) => {
+
+addDebugLog("updateConfig", "", "");
+
   let configData = fs.readFileSync(join(targetDirectory, '/config.json'), { encoding: 'utf8' });
   configData = configData && JSON.parse(configData);
 
@@ -114,6 +123,8 @@ export const updateFile = async (
   newComponentKeyPC,
   targetDirectory
 ) => {
+
+addDebugLog("updateFile", "", "");
   let fileData = fs.readFileSync(join(targetDirectory, '/', fileName), { encoding: 'utf8' });
 
   if (fileData.indexOf(oldComponentKeyPC) >= 0) {
@@ -124,6 +135,7 @@ export const updateFile = async (
 };
 
 export const renameLibrary = async ({ library, organization }, options) => {
+addDebugLog("renameLibrary", `library: ${library}, organization: ${organization}`, "");
   const compDef = await getOrgLib();
   const currentOrganization = compDef.organization;
   const currentLibrary = compDef.library;
@@ -145,7 +157,7 @@ export const renameLibrary = async ({ library, organization }, options) => {
   const currentOrgLib = currentOrganization.concat('_').concat(currentLibrary);
   const newOrgLib = organization.concat('_').concat(library);
 
-  // reaname all the components
+  // rename all the components
   const components = await getComponents();
 
   let wasDevBuild = false;
@@ -197,7 +209,7 @@ export const renameLibrary = async ({ library, organization }, options) => {
   // with subdirectories for each version.
   // If "buildDev", we append to version "-dev".  Currently, only "-dev" versions, when published, can be deleted.
   if (newOrgLib && compVersion) {
-    localBuildLibrary(organization, library, currentVersion, wasDevBuild);
+    await localBuildLibrary(organization, library, currentVersion, wasDevBuild);
   }
 };
 
@@ -215,6 +227,9 @@ export const renameComponent = async (
   options,
   onlyCompanion = false
 ) => {
+
+addDebugLog("renameComponent", `library: ${library}, organization: ${organization}, componentKey: ${componentKey}`, "");
+
   let pegaConfig = await getPegaConfig();
 
   const newComponentKey = `${organization}_${library}_${componentName}`;
@@ -268,7 +283,8 @@ export default async options => {
     process.exit();
   }
 
-  showVersion();
+  await showVersion();
+addDebugLog("renameLibrary", "", "+");
 
   await checkPathAccess(pegaConfigJsonPath);
 
@@ -346,4 +362,6 @@ export default async options => {
       );
     });
   }
+
+addDebugLog("renameLibrary", "END", "-");
 };

package/src/tasks/revert-webpack/index.js

@@ -3,12 +3,13 @@ import path from 'path';
 
 import chalk from 'chalk';
 
-import { showVersion, updateUseWebPackPromotion, getLibraryBased } from '../../util.js';
+import { showVersion, updateUseWebPackPromotion, getLibraryBased, addDebugLog } from '../../util.js';
 import { WEBPACK_CONFIG_JS_FILENAME } from '../../constants.js';
 
 const isLibraryBased = await getLibraryBased();
 
 export const renamePromotedWebPack = async () => {
+addDebugLog("renamePromotedWebPack","", "");
   // call this function from top level
   // fs.copyFileSync("./webpack.config.js", "webpack.config.js")
 
@@ -32,8 +33,10 @@ export default async () => {
     process.exit();
   }
 
-  showVersion();
+  await showVersion();
+addDebugLog("revertWebPack","", "+");
 
   await renamePromotedWebPack();
   await updateUseWebPackPromotion(false);
+addDebugLog("revertWebPack","END", "-");
 };

package/src/tasks/validator/index.js

@@ -11,7 +11,8 @@ import {
 import {
   getComponentDirectoryPath,
   getComponents,
-  getOOTBComponents } from '../../util.js';
+  getOOTBComponents,
+  addDebugLog } from '../../util.js';
 
 const ajv = new Ajv({ allErrors: true });
 
@@ -314,6 +315,8 @@ const validateOverideSchema = ajv.compile(overrideSchema);
 
 
 export default async (option) => {
+// addDebugLog("validate","", "");
+
   let componentToValidate = null;
   if (option.params && option.params[3]) {
     componentToValidate = option.params[3];

package/src/util.js

@@ -25,24 +25,62 @@ import {
   USE_PROMOTED_WEB_PACK,
   BOOTSTRAP_CONFIG,
   LIBRARY_BASED,
-  SHARED_DIRECTORY
+  SHARED_DIRECTORY,
+  SHOW_DEBUG
 } from './constants.js';
 
 const access = promisify(fs.access);
 
+let showDebug = false;
+let debugLevel = 1;
+
+
+export const addDebugLog = (sFunctionName, sLogData, sIncDec) => {
+
+  let sLog;
+  if (showDebug) {
+      if (sIncDec === "-") {
+          debugLevel--;
+      }
+
+      sLog = `>> log ${debugLevel} `;
+
+      for (let i =0; i < debugLevel; i++) {
+          sLog = sLog.concat("-");
+      }
+
+      sLog = sLog.concat(sFunctionName).concat(": ").concat(sLogData);
+
+      console.log(`${chalk.hex('#A0522D')(sLog)}`);
+
+      if (sIncDec === "+") {
+          debugLevel++;
+      }
+
+  }
+}
+
 export const checkPathAccess = async (path, options = {}, throwError = false) => {
+
+
   const { errorMessage } = options;
 
   try {
     await access(path, fs.constants.R_OK);
   } catch (err) {
     if (throwError) {
+addDebugLog("checkPathAccess", "path: ".concat(path), "+");
+addDebugLog("checkPathAccess", "Error: ".concat(err), "");
+addDebugLog("checkPathAccess", "END", "-");
       throw new Error(err);
+
     }
     else {
+addDebugLog("checkPathAccess", "path: ".concat(path), "+");
       const message =
         errorMessage || `${chalk.red.bold('ERROR')} Could not able to access path - ${path}`;
       console.error(message);
+addDebugLog("checkPathAccess", "END", "-");
       process.exit(1);
     }
 
@@ -106,6 +144,7 @@ export const updateUseWebPackPromotion = async ( useValue = false ) => {
 }
 
 export const getAboutData = async (currentOrgLib, buildVersion, dateStamp) => {
+addDebugLog("getAboutData", `currentOrgLib: ${currentOrgLib}, buildVersion: ${buildVersion}, dateStamp: ${dateStamp}`)
   const tokenAndStaticServer = await getC11NB2STokenAndStaticServer();
 
   if (tokenAndStaticServer.C11NB2S === undefined) {
@@ -121,6 +160,7 @@ export const getAboutData = async (currentOrgLib, buildVersion, dateStamp) => {
 }
 
 export const getLibraryBased = async () => {
+addDebugLog("getLibraryBased", "", "+");
   const currentDirectory = process.cwd();
   const pegaConfigJsonPath = join(currentDirectory, TASKS_CONFIG_JSON_FILENAME);
 
@@ -138,9 +178,14 @@ export const getLibraryBased = async () => {
   data = JSON.parse(data);
 
   if (data[LIBRARY_BASED]) {
+addDebugLog("getLibraryBased", `based: ${data[LIBRARY_BASED]}`, "");
+addDebugLog("getLibraryBased", "END", "-");
     return data[LIBRARY_BASED];
   }
-  else return false;
+  else {
+addDebugLog("getLibraryBased", "END", "-");
+    return false;
+  }
 }
 
 export const setLibraryBased = async (isLibraryBased) => {
@@ -170,8 +215,32 @@ export const setLibraryBased = async (isLibraryBased) => {
 
 }
 
+export const getShowDebug = async () => {
+  const currentDirectory = process.cwd();
+  const pegaConfigJsonPath = join(currentDirectory, TASKS_CONFIG_JSON_FILENAME);
+
+  try {
+    // force to throw error and not console log
+    await checkPathAccess(pegaConfigJsonPath, {}, true);
+  }
+  catch (ex) {
+    // when can't find it, always be false, assume no library based.
+    // This is IMPORTANT for init (npx install)
+    return false;
+  }
+
+  let data = fs.readFileSync(pegaConfigJsonPath, { encoding: 'utf8' });
+  data = JSON.parse(data);
+
+  if (data[SHOW_DEBUG]) {
+    return data[SHOW_DEBUG];
+  }
+  else return false;
+}
+
 
 export const deleteLocalComponent = async componentKey => {
+addDebugLog("deleteLocalComponent", `componentKey: ${componentKey}`, "");
   const currentDirectory = process.cwd();
   const pegaConfigJsonPath = join(currentDirectory, TASKS_CONFIG_JSON_FILENAME);
 
@@ -207,6 +276,7 @@ export const getHttpsAgent = serverConfig => {
 };
 
 export const deleteServerComponent = async componentKey => {
+addDebugLog("deleteServerComponent", `componentKey: ${componentKey}`, "");
   const serverConfig = await getPegaServerConfig();
   const { server, user, password } = serverConfig;
   const url = constructCompleteUrl(server, DELETE_COMPONENT_SERVICE_REST_ENDPOINT);
@@ -252,6 +322,7 @@ export const deleteServerComponent = async componentKey => {
 };
 
 export const copyFileToShared = async ( fileName, fileContents) => {
+addDebugLog("copyFileToShared", `fileName: ${fileName}`, "");
   const currentDirectory = process.cwd();
   const pegaConfigJsonPath = join(currentDirectory, TASKS_CONFIG_JSON_FILENAME);
 
@@ -285,6 +356,7 @@ export const copyFileToShared = async ( fileName, fileContents) => {
 };
 
 export const getComponents = async () => {
+addDebugLog("getComponents", "", "");
   const currentDirectory = process.cwd();
   const pegaConfigJsonPath = join(currentDirectory, TASKS_CONFIG_JSON_FILENAME);
 
@@ -309,6 +381,7 @@ export const getComponents = async () => {
 };
 
 export const getSubComponents = async (directory, type) => {
+addDebugLog("getDirectoryFiles", `directory: ${directory}, type: ${type}`, "");
   const subDirectory = join(directory, type);
   return fs
     .readdirSync(subDirectory, { withFileTypes: true })
@@ -317,6 +390,7 @@ export const getSubComponents = async (directory, type) => {
 };
 
 export const getDirectoryFiles = async directory => {
+addDebugLog("getDirectoryFiles", `directory: ${directory}`, "");
   return fs
     .readdirSync(directory, { withFileTypes: true })
     .filter(dirent => !dirent.isDirectory())
@@ -324,6 +398,7 @@ export const getDirectoryFiles = async directory => {
 };
 
 export const getComponentsObj = async () => {
+addDebugLog("getComponentsObj", "", "+");
   const compList = [];
 
   // const componentList = await getDirectoryFiles(directory);
@@ -336,15 +411,18 @@ export const getComponentsObj = async () => {
         container.name = name;
         container.value = name;
 
+addDebugLog("getComponentsObj", "container: " + JSON.stringify(container), "");
         return container;
       })
     );
   }
 
+addDebugLog("getComponentsObj", "END", "-");
   return compList;
 };
 
 export const getPegaConfig = async () => {
+addDebugLog("getPegaConfig", "", "+");
   const currentDirectory = process.cwd();
   const pegaConfigJsonPath = join(currentDirectory, TASKS_CONFIG_JSON_FILENAME);
 
@@ -353,20 +431,31 @@ export const getPegaConfig = async () => {
   let data = fs.readFileSync(pegaConfigJsonPath, { encoding: 'utf8' });
   data = JSON.parse(data);
 
+addDebugLog("getPegaConfig", "data: " + JSON.stringify(data), "");
+addDebugLog("getPegaConfig", "END", "-");
+
   return data;
 };
 
 export const getPegaServerConfig = async () => {
+addDebugLog("getPegaServerConfig", "", "+");
   const config = await getPegaConfig();
+addDebugLog("getPegaServerConfig", "server config:" + JSON.stringify(config['server-config']), "");
+addDebugLog("getPegaServerConfig", "END", "-");
   return config['server-config'];
 };
 
 export const getComponentDefaults = async () => {
+addDebugLog("getComponentDefaults", "", "+");
   const config = await getPegaConfig();
+addDebugLog("getComponentDefaults", "config:" + JSON.stringify(config), "");
+
+addDebugLog("getComponentDefaults", "END", "-");
   return config.component;
 };
 
 export const updateComponentDefaultLibrary = async (library) => {
+addDebugLog("updateComponentDefaultLibrary", `library: ${library}`, "");
   const currentDirectory = process.cwd();
   const pegaConfigJsonPath = join(currentDirectory, TASKS_CONFIG_JSON_FILENAME);
 
@@ -382,6 +471,7 @@ export const updateComponentDefaultLibrary = async (library) => {
 }
 
 export const updateComponentDefaultVersion = async (version) => {
+addDebugLog("updateComponentDefaultVersion", `version: ${version}`, "");
   const currentDirectory = process.cwd();
   const pegaConfigJsonPath = join(currentDirectory, TASKS_CONFIG_JSON_FILENAME);
 
@@ -397,6 +487,7 @@ export const updateComponentDefaultVersion = async (version) => {
 }
 
 export const updateDefaultOrganization = async (organization) => {
+addDebugLog("updateDefaultOrganization", `organization: ${organization}`, "");
   let packageData = JSON.parse(fs.readFileSync(path.resolve('package.json'), 'utf-8'));
 
   packageData.organization = organization;
@@ -406,11 +497,15 @@ export const updateDefaultOrganization = async (organization) => {
 }
 
 export const getServerType = async () => {
+addDebugLog("getServerType", "", "+");
   const defaultPegaServerConfig = await getPegaServerConfig();
+addDebugLog("getServerType", "serverType:" + defaultPegaServerConfig.serverType, "");
+addDebugLog("getServerType", "END", "-");
   return defaultPegaServerConfig.serverType;
 }
 
 export const setServerType = async(serverType) => {
+addDebugLog("setServerType", `serverType: ${serverType}`, "");
   const currentDirectory = process.cwd();
   const pegaConfigJsonPath = join(currentDirectory, TASKS_CONFIG_JSON_FILENAME);
   let configData = await getPegaConfig();
@@ -424,6 +519,7 @@ export const setServerType = async(serverType) => {
 }
 
 export const getComponentDirectoryPath = async componentKey => {
+addDebugLog("getComponentDirectoryPath", "", "+");
   const currentDirectory = process.cwd();
   const pegaConfigJsonPath = join(currentDirectory, TASKS_CONFIG_JSON_FILENAME);
 
@@ -438,11 +534,13 @@ export const getComponentDirectoryPath = async componentKey => {
     );
     process.exit(1);
   }
-
+addDebugLog("getComponentDirectoryPath", "path: " + join(currentDirectory, data[COMPONENTS_DIRECTORY_PATH], componentKey), "");
+addDebugLog("getComponentDirectoryPath", "END", "-");
   return join(currentDirectory, data[COMPONENTS_DIRECTORY_PATH], componentKey);
 };
 
 export const compileMustacheTemplate = (file, data) => {
+addDebugLog("compileMustacheTemplate", `file: ${file}`, "");
   const content = fs.readFileSync(file, 'utf8');
   return mustache.render(content, data);
 };
@@ -456,6 +554,7 @@ export const convertIntoPascalCase = string => {
 };
 
 export const constructCompleteUrl = (baseServer, endPoint) => {
+addDebugLog("constructCompleteUrl", "url: " + baseServer.endsWith('/') ? `${baseServer}${endPoint}` : `${baseServer}/${endPoint}`, "");
   return baseServer.endsWith('/') ? `${baseServer}${endPoint}` : `${baseServer}/${endPoint}`;
 };
 
@@ -487,7 +586,7 @@ export const standardizeStr = (str, length) => {
   return str.padEnd(length);
 };
 
-export const showVersion = () => {
+export const showVersion = async () => {
   // get package version, so can display at start
   // const require = createRequire(import.meta.url);
   const require = createRequire(currentPath.default);
@@ -495,6 +594,7 @@ export const showVersion = () => {
   const pData = require('@pega/custom-dx-components/package.json');
 
   console.log(chalk.green(`DX Component Builder v${pData.version}`));
+  showDebug = await getShowDebug();
 
   // do a check of node version, it should be 18 or greater
   const arNodeVersion = process.versions.node.split('.');
@@ -517,9 +617,12 @@ export const showVersion = () => {
     console.log(chalk.redBright('DX Component Builder - Git needs to be installed.'));
     process.exit(1);
   }
+
+
 };
 
 export const getOOTBComponents = async () => {
+addDebugLog("getOOTBComponents", "", "");
   return new Promise(resolve => {
     fs.readFile(OOTB_COMPONENTS, 'utf-8', async (error, ootbComponentsData) => {
       if (error) {
@@ -572,6 +675,7 @@ export const getOOTBComponents = async () => {
 };
 
 export const deleteInfinityServerComponent = async componentKey => {
+addDebugLog("deleteInfinityServerComponent", `componentKey: ${componentKey}`, "");
   const serverConfig = await getPegaServerConfig();
   const { server } = serverConfig;
   const url = constructCompleteUrl(server, DELETE_COMPONENT_SERVICE_REST_ENDPOINT);
@@ -650,6 +754,7 @@ export const deleteInfinityServerComponent = async componentKey => {
 };
 
 export const deleteLaunchpadServerComponent = async componentKey => {
+addDebugLog("deleteLaunchpadServerComponent", `componentKey: ${componentKey}`, "");
   const { server, isolationId } = await getPegaServerConfig();
   const deleteUrl = constructCompleteUrl(
     server,
@@ -737,7 +842,7 @@ export const deleteLaunchpadServerComponent = async componentKey => {
 };
 
 export const getBootstrapConfig = async (restServerUrl, authorizationHeader) => {
-
+addDebugLog("getBootstrapConfig", `restServerUrl: ${restServerUrl}`, "");
   const serverConfig = await getPegaServerConfig();
 
   return fetch(`${restServerUrl}/${BOOTSTRAP_CONFIG}`, {
@@ -755,6 +860,7 @@ export const getBootstrapConfig = async (restServerUrl, authorizationHeader) =>
 };
 
 export const updateC11NB2SForInfinity = async () => {
+addDebugLog("updateC11NB2SForInfinity", "", "");
   const serverConfig = await getPegaServerConfig();
   const { server } = serverConfig;
   const OAuthData = fs.readFileSync(TOKEN_PATH, 'utf8');
@@ -785,6 +891,7 @@ export const updateC11NB2SForLaunchpad = async () => {
 };
 
 export const getC11NB2STokenAndStaticServer = async () => {
+addDebugLog("getC11NB2STokenAndStaticServer", "", "");
   const serverConfig = await getPegaServerConfig();
   const { server } = serverConfig;
   let OAuthData;
@@ -807,6 +914,7 @@ export const getC11NB2STokenAndStaticServer = async () => {
 }
 
 export const getLocalLibraryVersions = async (libraryName) => {
+addDebugLog("getLocalLibraryVersions", `libraryName: ${libraryName}` , "");
   const currentDirectory = process.cwd();
 
   const directory = join(currentDirectory, libraryName);
@@ -817,6 +925,7 @@ export const getLocalLibraryVersions = async (libraryName) => {
 };
 
 export const getLocalLibraryVersionData = async (libraryName, libraryVersion) => {
+addDebugLog("getLocalLibraryVersionDate", `libraryName: ${libraryName}, libraryVersion: ${libraryVersion}` , "");
     const currentDirectory = process.cwd();
     const libDir = join(currentDirectory, libraryName, libraryVersion);
     const libDataFile = join(libDir, 'componentsconfig.json');
@@ -827,6 +936,7 @@ export const getLocalLibraryVersionData = async (libraryName, libraryVersion) =>
 }
 
 export const deleteLocalLibrary = async (libraryName) => {
+addDebugLog("deleteLocalLibrary", `libraryName: ${libraryName}` , "");
   const currentDirectory = process.cwd();
 
   const directory = join(currentDirectory, libraryName);
@@ -857,6 +967,7 @@ export const deleteLocalLibrary = async (libraryName) => {
 }
 
 export const deleteLocalLibraryVersion = async (libraryName, libraryVersion) => {
+addDebugLog("getLocalLibraryVersions", `libraryName: ${libraryName}, libraryVersion: ${libraryVersion}` , "");
   const currentDirectory = process.cwd();
 
   const directory = join(currentDirectory, libraryName, libraryVersion);
@@ -880,6 +991,7 @@ export const deleteLocalLibraryVersion = async (libraryName, libraryVersion) =>
 }
 
 export const deletePublishExtras = async (libraryName, libraryVersion) => {
+addDebugLog("deletePublishExtras", `libraryName: ${libraryName}, libraryVersion: ${libraryVersion}` , "");
   // this function will delete LibraryName.zip file, so new one created by publish
   // check if .DS_store file exists in Library, if so delete it because causes issue with services
 
@@ -901,3 +1013,21 @@ export const deletePublishExtras = async (libraryName, libraryVersion) => {
 
 
 }
+
+
+
+
+export const cleanUp = async () => {
+  addDebugLog("cleanUp", "", "");
+    fs.rm('dist/components', { recursive: true }, err => {
+      if (err) {
+        throw err;
+      }
+    });
+
+    fs.rm('lib', { recursive: true }, err => {
+      if (err) {
+        throw err;
+      }
+    });
+  };