@pega/custom-dx-components 0.242.54 → 0.242.55

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pega/custom-dx-components",
-  "version": "0.242.54",
+  "version": "0.242.55",
   "description": "Utility for building custom UI components",
   "bin": "./bin/index.js",
   "scripts": {

package/src/constants.js

@@ -18,6 +18,8 @@ export const ARCHIVES_PATH = 'store';
 export const TEMP_PATH = 'store/temp';
 export const COMPONENTS_CONFIG_FILE_NAME = 'componentsconfig.json';
 
+
+
 /* REST end points */
 export const PUBLISH_COMPONENT_SERVICE_REST_ENDPOINT = 'PRRestService/dev/v1/publish_component';
 export const LIST_COMPONENT_SERVICE_REST_ENDPOINT = 'PRRestService/dev/v1/list_component';

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

@@ -26,6 +26,19 @@ addDebugLog("updateAllComponentsConfig", `newVersion: ${newVersion}`, "");
   }
 };
 
+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", "", "");

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

@@ -15,10 +15,12 @@ import {
   hasLibraryAndVersion,
   getConfigDefaults,
   forceDefaultsUpdate,
-  cleanUpTemp
+  cleanUpTemp,
+  restoreTopLevelConfigFilesFromTemplate,
+  getHaveDependencyDifference
 } from '../../util.js';
 
-import { getCreateLibComponentQuestions, getOkToProceedQuestion, updateAllComponentsConfig } from './helper.js';
+import { getCreateLibComponentQuestions, getOkToProceedQuestion, updateAllComponentsConfig, getCurrentOrOriginalQuestion } from './helper.js';
 import { showCurrentStatus } from '../show-status/index.js';
 
 export default async options => {
@@ -39,6 +41,8 @@ addDebugLog("createLibrary", "", "+");
   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.'))
@@ -52,10 +56,11 @@ addDebugLog("createLibrary", "", "+");
     }
   }
 
-  if (options.params.length >= 6) {
+  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 {
     const questions = await getCreateLibComponentQuestions();
@@ -93,6 +98,26 @@ addDebugLog("createLibrary", "", "+");
     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);
@@ -108,6 +133,17 @@ addDebugLog("createLibrary", "", "+");
   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/init/template/package.json.mustache

@@ -100,7 +100,7 @@
   },
   "devDependencies": {
     "@pega/configs": "^0.15.1",
-    "@pega/custom-dx-components": "~0.242.54",
+    "@pega/custom-dx-components": "~0.242.55",
     "@pega/pcore-pconnect-typedefs": "~3.2.0-alpha.1",
     "@storybook/addon-actions": "^7.6.19",
     "@storybook/addon-essentials": "^7.6.19",

package/src/util.js

@@ -539,6 +539,151 @@ if (showDebug) addDebugLog("getComponents", "", "");
     .map(dirent => dirent.name);
 };
 
+export const getTopLevelConfigFiles = async (directory) => {
+if (showDebug) addDebugLog("getTopLevelConfigFiles", `directory: ${directory}`, "");
+  if (fs.existsSync(directory)) {
+    return fs
+    .readdirSync(directory, { withFileTypes: true })
+    .filter(dirent => !dirent.isDirectory())
+    .map(dirent => dirent.name);
+  }
+  else {
+    return [];
+  }
+}
+
+export const removeTopLevelConfigFiles = async (directory) => {
+if (showDebug) addDebugLog("removeTopLevelConfigFiles", `directory: ${directory}`, "");
+  const configFiles = await getTopLevelConfigFiles(directory);
+
+  if (configFiles && configFiles.length > 0) {
+    for (const configF of configFiles) {
+      if (configF !== "package-lock.json" && configF !== "package.json" && configF !== "tasks.config.json" ) {
+        fs.rmSync( join(directory, configF), { recursive: true, force: true, maxRetries: 2 });
+      }
+    }
+  }
+}
+
+export const restoreTopLevelConfigFiles = async(directory) => {
+if (showDebug) addDebugLog("restoreTopLevelConfigFiles", `directory: ${directory}`, "");
+  const currentDirectory = process.cwd();
+  const tempDirectory = join(currentDirectory, TEMP_PATH);
+  const configFiles = await getTopLevelConfigFiles(tempDirectory);
+
+  if (configFiles && configFiles.length > 0) {
+    for (const configF of configFiles) {
+      if (configF !== "package-lock.json" && configF !== "package.json") {
+        fs.copyFileSync(join(tempDirectory, configF), join(directory, configF));
+      }
+    }
+  }
+}
+
+export const getTemplateConfigFiles = async () => {
+if (showDebug) addDebugLog("getTemplateConfigFiles", ``, "");
+  const currentDirectory = process.cwd();
+  const initDir = join(currentDirectory, "node_modules", "@pega", "custom-dx-components", "src", "tasks", "init");
+  const templateDir = join(initDir, "template");
+
+  if (fs.existsSync(templateDir)) {
+    return fs
+    .readdirSync(templateDir, { withFileTypes: true })
+    .filter(dirent => !dirent.isDirectory())
+    .map(dirent => dirent.name);
+  }
+  else {
+    return [];
+  }
+
+}
+
+export const restoreTopLevelConfigFilesFromTemplate = async() => {
+if (showDebug) addDebugLog("restoreTopLevelConfigFilesFromTemplate", ``, "");
+  // we can't loose devDep that is part of install, so go get the template mustache and push
+  // those in, replacing any changes there, but allowing additional, an keeping it updated
+  // so won't loose new function if an old archive
+  const currentDirectory = process.cwd();
+  const initDir = join(currentDirectory, "node_modules", "@pega", "custom-dx-components", "src", "tasks", "init");
+  const templateDir = join(initDir, "template");
+  const packageTemplateJsonPath = path.join(templateDir, 'package.json.mustache');
+
+  const currentPackagePath = join(currentDirectory, PACKAGE_JSON_FILENAME);
+  let currentPackageData;
+
+  // reset
+  haveDependencyDifference = false;
+
+  try {
+    currentPackageData = fs.readFileSync(currentPackagePath);
+  }
+  catch (ex) {
+    console.log($chalk.red(`\nUnable to retrieve current package.json.`))
+    process.exit(1);
+  }
+  let cData = JSON.parse(currentPackageData);
+
+  let retrievedTemplateData;
+  try {
+    retrievedTemplateData = fs.readFileSync(packageTemplateJsonPath);
+  }
+  catch (ex) {
+    console.log($chalk.red(`\nUnable to retrieve package.json.mustache from code.`))
+    process.exit(1);
+  }
+
+  // copy template dependecies and devDependencies
+  const tData = JSON.parse(retrievedTemplateData);
+
+
+  // check to see if any dependency changes
+  const sDep = JSON.stringify(tData.dependencies);
+  const sDevDep = JSON.stringify(tData.devDependencies);
+
+  const sCurDep = JSON.stringify(cData.dependencies);
+  const sCurDevDep = JSON.stringify(cData.devDependencies);
+
+  // any changes, update haveDependencyDifference variable
+  if (sDep != sCurDep) {
+    haveDependencyDifference = true;
+  }
+  else if (sDevDep != sCurDevDep) {
+    haveDependencyDifference = true;
+  }
+
+  await removeTopLevelConfigFiles(currentDirectory);
+
+
+  // clear out
+  cData.dependencies = {};
+  cData.devDependencies = {};
+
+
+
+  const tDep = tData.dependencies;
+  for (const [key, value] of Object.entries(tDep)) {
+    cData.dependencies[key] = value;
+  }
+  const tDevDep = tData.devDependencies;
+  for (const [key, value] of Object.entries(tDevDep)) {
+    cData.devDependencies[key] = value;
+  }
+
+  // update current package json file
+  fs.writeFileSync(currentPackagePath, JSON.stringify(cData, null, 4), { encoding: 'utf8',flag:'w' });
+
+  // restore from template
+  const templateFiles = await getTemplateConfigFiles();
+  if (templateFiles && templateFiles.length > 0) {
+    for (const tFile of templateFiles) {
+      if (tFile !== "package.json.mustache" && tFile !== "templateNPMRC.txt" && tFile !== "tasks.config.json") {
+        fs.copyFileSync(join(templateDir, tFile), join(currentDirectory, tFile));
+      }
+    }
+  }
+
+}
+
 export const getSubComponents = async (directory, type) => {
 if (showDebug) addDebugLog("getDirectoryFiles", `directory: ${directory}, type: ${type}`, "");
   const subDirectory = join(directory, type);
@@ -1466,16 +1611,29 @@ if (showDebug) addDebugLog("zipVersionAndArchive", `orgLibName: ${orgLibName}, v
   // Add src directory
   archive.directory(srcDirectoryPath, 'src');
 
-  // Add config.json file
-  if (fs.existsSync(tasksConfig)) {
-    archive.file(tasksConfig, { name: path.basename(tasksConfig) });
-  }
+  // grab all files (not directories and archive)
+  const configFiles = await getTopLevelConfigFiles(currentDirectory);
+  if (configFiles && configFiles.length > 0) {
+    for (const configF of configFiles) {
+      if (configF !== "package-lock.json") {
+        archive.file(
+          join(currentDirectory, configF), { name: configF });
+      }
 
-  // Add package.json file
-  if (fs.existsSync(packageJson)) {
-    archive.file(packageJson, { name: path.basename(packageJson) });
+    }
   }
 
+  // // Add config.json file
+  // if (fs.existsSync(tasksConfig)) {
+  //   archive.file(tasksConfig, { name: path.basename(tasksConfig) });
+  // }
+
+  // // Add package.json file
+  // if (fs.existsSync(packageJson)) {
+  //   archive.file(packageJson, { name: path.basename(packageJson) });
+  // }
+
+
   // pipe archive data to the file
   archive.pipe(output);
 
@@ -1517,6 +1675,7 @@ if (showDebug) addDebugLog("unZipFromArchive", `fileName: ${fileName}`, "");
 };
 
 
+
 export const updateComponentTaskConfig = async () => {
 if (showDebug) addDebugLog("updateComponentTaskConfig", "", "");
   const currentDirectory = process.cwd();
@@ -1570,7 +1729,7 @@ if (showDebug) addDebugLog("restoreDependenciesFromPackage", "", "");
   }
 
 
-  const rData = JSON.parse(retrievedPackageData);
+  let rData = JSON.parse(retrievedPackageData);
   let cData = JSON.parse(currentPackageData);
 
   // now keep current package.json, but replace devDependencies and dependencies.
@@ -1609,16 +1768,106 @@ if (showDebug) addDebugLog("restoreDependenciesFromPackage", "", "");
   const tData = JSON.parse(retrievedTemplateData);
   const tDevDep = tData.devDependencies;
   for (const [key, value] of Object.entries(tDevDep)) {
-    cData.devDependencies[key] = value;
+    rData.devDependencies[key] = value;
   }
 
+  // overwrite cData specifics
+  rData.name = cData.name;
+  rData.description = cData.description;
+  rData.organization = cData.organization;
+  rData.main = cData.main;
+  rData.type = cData.type;
+  rData.scripts = cData.scripts;
+  rData.scriptsComments = cData.scriptsComments;
+  rData.repository = cData.repository;
+  rData.keywords = cData.keywords;
+
 
   // update current package json file
-  fs.writeFileSync(currentPackagePath, JSON.stringify(cData, null, 4), { encoding: 'utf8',flag:'w' });
+  fs.writeFileSync(currentPackagePath, JSON.stringify(rData, null, 4), { encoding: 'utf8',flag:'w' });
 
 
 }
 
+export const restoreDependenciesFromPackage_old = async () => {
+  if (showDebug) addDebugLog("restoreDependenciesFromPackage", "", "");
+    const currentDirectory = process.cwd();
+    const tempDirectory = join(currentDirectory, TEMP_PATH);
+    const tempPackagePath = join (tempDirectory, PACKAGE_JSON_FILENAME);
+    const currentPackagePath = join(currentDirectory, PACKAGE_JSON_FILENAME);
+
+    let retrievedPackageData;
+    let currentPackageData;
+
+    // reset
+    haveDependencyDifference = false;
+
+    try {
+      retrievedPackageData = fs.readFileSync(tempPackagePath);
+    }
+    catch (ex) {
+      console.log($chalk.red(`\nUnable to retrieve package.json from store.`))
+      process.exit(1);
+    }
+
+    try {
+      currentPackageData = fs.readFileSync(currentPackagePath);
+    }
+    catch (ex) {
+      console.log($chalk.red(`\nUnable to retrieve current package.json.`))
+      process.exit(1);
+    }
+
+
+    const rData = JSON.parse(retrievedPackageData);
+    let cData = JSON.parse(currentPackageData);
+
+    // now keep current package.json, but replace devDependencies and dependencies.
+    const sDep = JSON.stringify(rData.dependencies);
+    const sDevDep = JSON.stringify(rData.devDependencies);
+
+    const sCurDep = JSON.stringify(cData.dependencies);
+    const sCurDevDep = JSON.stringify(cData.devDependencies);
+
+    // any changes, update haveDependencyDifference variable
+    if (sDep != sCurDep) {
+      haveDependencyDifference = true;
+    }
+    else if (sDevDep != sCurDevDep) {
+      haveDependencyDifference = true;
+    }
+
+
+    cData.dependencies = JSON.parse(sDep);
+    cData.devDependencies = JSON.parse(sDevDep);
+
+    // we can't loose devDep that is part of install, so go get the template mustache and push
+    // those in, replacing any changes there, but allowing additional, an keeping it updated
+    // so won't loose new function if an old archive
+    const initDir = join(currentDirectory, "node_modules", "@pega", "custom-dx-components", "src", "tasks", "init");
+    const templateDir = join(initDir, "template");
+    const packageTemplateJsonPath = path.join(templateDir, 'package.json.mustache');
+    let retrievedTemplateData;
+    try {
+      retrievedTemplateData = fs.readFileSync(packageTemplateJsonPath);
+    }
+    catch (ex) {
+      console.log($chalk.red(`\nUnable to retrieve package.json.mustache from code.`))
+      process.exit(1);
+    }
+    const tData = JSON.parse(retrievedTemplateData);
+    const tDevDep = tData.devDependencies;
+    for (const [key, value] of Object.entries(tDevDep)) {
+      cData.devDependencies[key] = value;
+    }
+
+
+    // update current package json file
+    fs.writeFileSync(currentPackagePath, JSON.stringify(cData, null, 4), { encoding: 'utf8',flag:'w' });
+
+
+  }
+
 export const getHaveDependencyDifference = () => {
 if (showDebug) addDebugLog("getHaveDependencyDifference", ``, "");
   return haveDependencyDifference;
@@ -1639,6 +1888,11 @@ if (showDebug) addDebugLog("restoreFromArchive", `fileName: ${fileName}, orgLibN
   const tempDirectoryComponents = join(tempDirectory, "src", "components");
   const currentComponentsPath = join(currentDirectory, "src", "components");
 
+  // remove all config files
+  await removeTopLevelConfigFiles(currentDirectory);
+
+  await restoreTopLevelConfigFiles(currentDirectory);
+
   // take your current tasks.config and update with component and devBuild from saved tasks.config
   await updateComponentTaskConfig();
 
@@ -1662,8 +1916,10 @@ if (showDebug) addDebugLog("restoreFromArchive", `fileName: ${fileName}, orgLibN
     }
   }
 
+
   // copy temp src/components
   if (fs.existsSync(tempDirectoryComponents)) {
+
     fs.cpSync(tempDirectoryComponents, currentComponentsPath, { recursive: true, force: true  });
    }
    else {