@pega/custom-dx-components 0.25.21 → 0.25.23

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pega/custom-dx-components",
-  "version": "0.25.21",
+  "version": "0.25.23",
   "description": "Utility for building custom UI components",
   "bin": "./bin/index.js",
   "scripts": {
@@ -19,7 +19,7 @@
     "@babel/plugin-transform-class-properties": "^7.25.9",
     "@babel/preset-react": "^7.26.3",
     "@pega/auth": "^0.2.23",
-    "@pega/constellation-dx-components-build-utils": "^2.0.2-dev",
+    "@pega/constellation-dx-components-build-utils": "^2.0.3-dev",
     "@pega/inquirer-fuzzy-path": "^3.0.0",
     "ajv": "^8.17.1",
     "ajv-keywords": "^5.1.0",

package/src/tasks/build-jest-assets/index.js

@@ -2,7 +2,6 @@ import fs from 'fs';
 import path from 'path';
 import { join } from 'path';
 import inquirer from 'inquirer';
-import { Listr } from 'listr2';
 import chalk from 'chalk';
 
 import { showVersion, getServerType, setServerType, getSubComponents, deleteLocalComponent, checkPathAccess, getComponents, getLibraryBasedCL, setLibraryBasedCL, forceDefaultsUpdate } from '../../util.js';

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

@@ -1,5 +1,3 @@
-import fs from 'fs';
-import path from 'path';
 import chalk from 'chalk';
 
 import {

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

@@ -106,9 +106,9 @@ addDebugLog("localBuildLibrary", `organization: ${organization}, library: ${libr
   // warnings are part of buildLib
 
   // for now
-  console.log(chalk.green.bold('Compile check...'));
-  await bundleComponent(components[0], null, devBuild, false);
-  console.log('');
+  // console.log(chalk.green.bold('Compile check...'));
+  // await bundleComponent(components[0], null, devBuild, false);
+  // console.log('');
 
   // remove dist/lib stuff
   await cleanUp();

package/src/tasks/delete/helper.js

@@ -13,7 +13,6 @@ import {
   getComponents,
   getPegaServerConfig,
   standardizeStr,
-  sanitize,
   addDebugLog,
   checkAccessTokenExpiration
 } from '../../util.js';

package/src/tasks/delete/index.js

@@ -2,7 +2,11 @@ import inquirer from 'inquirer';
 
 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) => {

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

@@ -1,4 +1,3 @@
-import path from 'path';
 import chalk from 'chalk';
 
 import { addDebugLog, getConfigDefaults, getLibraryArchiveDirectories } from '../../util.js';

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

@@ -1,9 +1,14 @@
 import fs from 'fs';
-import path from 'path';
 import chalk from 'chalk';
 import fetch from 'node-fetch';
 
-import { getPegaServerConfig, addDebugLog, getApplicationAndVersionFromToken, constructCompleteUrl, getHttpsAgent, validateRulesetVersion } from '../../util.js';
+import {
+  getPegaServerConfig,
+  addDebugLog,
+  getApplicationAndVersionFromToken,
+  constructCompleteUrl,
+  getHttpsAgent,
+  validateRulesetVersion } from '../../util.js';
 import { LIST_COMPONENT_LIBRARIES_SERVICE_REST_ENDPOINT, TOKEN_PATH } from '../../constants.js';
 
 export const SOURCE_OF_COMPONENT_TYPES = {

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

@@ -1,4 +1,3 @@
-import inquirer from 'inquirer';
 import chalk from 'chalk';
 
 import {

package/src/tasks/export-archive/helper.js

@@ -1,7 +1,13 @@
 import chalk from 'chalk';
 import path from 'path';
 import { join } from 'path';
-import { addDebugLog, getConfigDefaults, getLibraryArchiveDirectories, getLibraryArchivesVersions, setConfigExportRelativePath, forceDefaultsUpdate } from '../../util.js';
+import {
+  addDebugLog,
+  getConfigDefaults,
+  getLibraryArchiveDirectories,
+  getLibraryArchivesVersions,
+  setConfigExportRelativePath,
+  forceDefaultsUpdate } from '../../util.js';
 
 export const SOURCE_OF_COMPONENT_TYPES = {
   SERVER: 'Server',

package/src/tasks/export-archive/index.js

@@ -1,7 +1,6 @@
 import fs from 'fs';
 import { promisify } from 'util';
 import { join } from 'path';
-import path from 'path';
 
 import inquirer from 'inquirer';
 import ncp from 'ncp';
@@ -21,7 +20,7 @@ import {
   checkAccessTokenExpiration
  } from '../../util.js';
 import { TASKS_CONFIG_JSON_FILENAME, ARCHIVES_PATH, BIN_ARCHIVES_PATH } from '../../constants.js';
-import { getFilePathQuestions, getLibraryQuestion, getLibraryVersionQuestion, updateSavedExportFilePath, getFullArchiveQuestions, getServerOrDirectoryQuestion  } from './helper.js';
+import { getFilePathQuestions, getLibraryQuestion, getLibraryVersionQuestion, updateSavedExportFilePath, getServerOrDirectoryQuestion  } from './helper.js';
 import { localBuildLibrary } from '../build-lib/index.js';
 import publishArchive from '../publish-archive/index.js';
 
@@ -143,8 +142,6 @@ addDebugLog("exportCLArch", `exportPath: ${exportPath}, orgLibName: ${orgLibName
         }
       }
 
-
-
       // archive it
       output = await zipVersionAndArchiveCL(configDef.currentOrgLib, configDef.buildVersion);
 
@@ -163,9 +160,6 @@ addDebugLog("exportCLArch", `exportPath: ${exportPath}, orgLibName: ${orgLibName
 
 
 
-
-
-
 }
 
 
@@ -191,30 +185,6 @@ addDebugLog("exportArch", `exportPath: ${exportPath}, orgLibName: ${orgLibName},
 
   if (orgLibName === configDef.currentOrgLib && selectedVersion === configDef.buildVersion) {
 
-    /*
-    let currentOrStore = currentOrArchive;
-    if (currentOrArchive === "") {
-      console.log("\nYou've selected the current working library/version.");
-      console.log("Export store or the current.");
-      const archAnswers = await inquirer.prompt([
-        {
-          name: 'currentOrStore',
-          type: 'rawlist',
-          message: 'Select current or store',
-          default: "Current",
-          choices: ["Current", "Store"]
-        },
-      ]);
-
-      currentOrStore = archAnswers.currentOrStore;
-
-    }
-
-    if (currentOrStore === "Current") {
-      archiveBeforeStore = true;
-    }
-    */
-
     // We are just going to archive before store and not ask
     archiveBeforeStore = true;
 
@@ -262,6 +232,8 @@ addDebugLog("exportArch", `exportPath: ${exportPath}, orgLibName: ${orgLibName},
 
 
   if (archiveBeforeStore) {
+
+
     // archive it
     output = await zipVersionAndArchive(configDef.currentOrgLib, configDef.buildVersion);
 
@@ -386,7 +358,7 @@ export default async options => {
         ({ selectedVersion } = libraryVersionAnswer);
       }
 
-      /*  when we can export to server, un comment this out
+      //  when we can export to server, un comment this out
       if (isLibraryBasedCL) {
         if (exportTo === "") {
           const serverOrDirectoryQuestion = await getServerOrDirectoryQuestion();
@@ -397,8 +369,8 @@ export default async options => {
       else {
         exportTo = "Directory";
       }
-      */
-      exportTo = "Directory"; // remove this line when above is uncommented out
+
+      //exportTo = "Directory"; // remove this line when above is uncommented out
 
 
       if (exportTo === "Directory") {
@@ -422,6 +394,10 @@ export default async options => {
       else {
         await checkAccessTokenExpiration();
 
+        // archive it
+        await zipVersionAndArchive(orgLibName, selectedVersion);
+
+
         // publish to server
         await publishArchive(orgLibName, selectedVersion);
 

package/src/tasks/import-archive/helper.js

@@ -4,8 +4,25 @@ import path from 'path';
 import fetch from 'node-fetch';
 import { join } from 'path';
 import { Listr } from 'listr2';
-import { addDebugLog, getHttpsAgent, getConfigDefaults, getPegaServerConfig, convertIntoPascalCase, getComponents, getComponentDirectoryPath, getDirectoryFiles, setConfigImportRelativePath, forceDefaultsUpdate, constructCompleteUrl } from '../../util.js';
-import { TASKS_CONFIG_JSON_FILENAME, TEMP_PATH, PACKAGE_JSON_FILENAME, LIST_COMPONENT_LIBRARY_ARCHIVES_SERVICE_REST_ENDPOINT, COMPONENT_LIBRARY_ARCHIVE_SERVICE_REST_ENDPOINT, TOKEN_PATH} from '../../constants.js';
+import {
+  addDebugLog,
+  getHttpsAgent,
+  getConfigDefaults,
+  getPegaServerConfig,
+  convertIntoPascalCase,
+  getComponents,
+  getComponentDirectoryPath,
+  getDirectoryFiles,
+  setConfigImportRelativePath,
+  forceDefaultsUpdate,
+  constructCompleteUrl } from '../../util.js';
+import {
+  TASKS_CONFIG_JSON_FILENAME,
+  TEMP_PATH,
+  PACKAGE_JSON_FILENAME,
+  LIST_COMPONENT_LIBRARY_ARCHIVES_SERVICE_REST_ENDPOINT,
+  COMPONENT_LIBRARY_ARCHIVE_SERVICE_REST_ENDPOINT,
+  TOKEN_PATH} from '../../constants.js';
 
 
 
@@ -513,9 +530,6 @@ async function fetchComponentLibraryArchivesFromInfinity(apiUrl, headers) {
       );
 
       let urlParams = `/app-name/${appName}/file-name/${fileName}/file-type/${fileType}/rulesetname/${ruleSet}/rulesetversion/${ruleSetVersion}`;
-      //let urlParams = `&ApplicationName=${ApplicationName}&ApplicationVersion=${ApplicationVersion}&RulesetName=${rulesetName}&RulesetVersion=${rulesetVersion}`;
-      //urlParams = encodeURIComponent(urlParams);
-
 
       url = url.concat(urlParams);
 

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

@@ -6,7 +6,6 @@ import inquirer from 'inquirer';
 import ncp from 'ncp';
 import chalk from 'chalk';
 import { Listr } from 'listr2';
-import archiver from 'archiver';
 
 import StreamZip from 'node-stream-zip';
 
@@ -19,7 +18,6 @@ import {
   getDirectoryFiles,
   addDebugLog,
   checkAccessTokenExpiration,
-  checkLibraryAndArchives,
   getConfigDefaults,
   getLibraryBased,
   unZipFromArchive,
@@ -233,16 +231,193 @@ export const moveComp = async(componentKey, orgLibName, version, copyShared, opt
     fs.rmSync(tempDirectory, { recursive: true, force: true, maxRetries: 2  });
 }
 
+
 export const importArch = async(filePath, fileName, hadArchive) => {
+  addDebugLog("importArch", `filePath: ${filePath}, fileName: ${fileName}`, "");
+
+    const currentDirectory = process.cwd();
+    const tempDirectory = join(currentDirectory, TEMP_PATH);
+
+
+    const zipFilePath = join(filePath, fileName);
+
+
+    // we are going to use node stream zip to list contents of archive first,
+    // before we un archive to a temp directory.  If pass, then un archive
+    let passCount = 0;
+
+    // check to see if have a tasks.config.json  and package,json file, if not, archive not good
+    const tempTasksConfig = join(tempDirectory, "tasks.config.json");
+    const tempPackage = join(tempDirectory, "package.json");
+    const tasksConfig = "tasks.config.json";
+    const packageJson = "package.json";
+    try {
+      const testZip = new StreamZip.async({ file: zipFilePath});
+      const entries = await testZip.entries();
+
+      for (const entry of Object.values(entries)) {
+        if ( entry.name.indexOf(packageJson) >= 0 || entry.name.indexOf(tasksConfig) >= 0) {
+          passCount++;
+        }
+      }
+
+      // Do not forget to close the file once you're done
+      await testZip.close();
+    }
+    catch (ex) {
+      passCount = 0;
+    }
+
+
+    if (passCount < 2) {
+      console.log(chalk.red.bold(`Zip file: ${fileName} not a compatible DX Component archive.`));
+      process.exit(1);
+
+    }
+
+    await unZipFromArchive(zipFilePath);
+
+    // need to get info from tasks.config and package.json
+    // we won't rely on name of file, as owner can change it
+
+    let organization = await getPackgeOrg(tempPackage);
+    let localConfig = await getLocalConfigData(tempTasksConfig);
+
+    let libName = localConfig.library;
+    let orgLibName = `${organization}_${libName}`;
+    const version = localConfig.buildVersion;
+    const devBuild = localConfig.devBuild;
+
+    const configDef = getConfigDefaults();
+
+    if (organization !== configDef.organization) {
+      console.log(`\nImported ${chalk.yellow(`${orgLibName}/${version}`)} is not the same organization as your current organization: ${chalk.yellow(`${configDef.organization}`)}.`);
+      console.log(`\nTo import, the organization of the components will be changed to match your organization.`);
+      console.log(`\n\t>>> If you don't want this to happen, then end and create a new project with an organization`);
+      console.log(`\t    of ${chalk.yellow(`${organization}`)} and import there.\n`);
+
+      const proceedAnswers = await inquirer.prompt([
+
+        {
+          name: 'okToContinue',
+          type: 'confirm',
+          message: `Ok to proceed ?`,
+          default: true
+        }
+      ]);
+
+      if (proceedAnswers.okToContinue) {
+        // check if new version matches existing
+        // -dev is already on version, if present, so "false", for devBuild here
+        const alreadyExists = await hasLibraryAndVersion(libName, version, false);
+        if (alreadyExists) {
+          console.log(`${chalk.yellow(`${configDef.organization}_${libName}/${version}`)} already exists.`);
+          const archDirectories = await getLibraryArchiveDirectories();
+          const newLibNameAnswers = await inquirer.prompt([
+            {
+              name: 'libraryName',
+              message: 'Enter new libray 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)) {
+                  if (archDirectories && archDirectories.length > 0) {
+                    const newOrgLib = `${configDef.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.';
+                }
+              }
+            }
+          ]);
+
+          libName = newLibNameAnswers.libraryName;
+        }
+
+        // rename orgLibName
+        orgLibName = `${configDef.organization}_${libName}`;
+
+        // update temp with new info
+        await updateTempArchive(libName, version, devBuild);
+
+      }
+      else {
+        process.exit();
+      }
+
+
+    }
+
+    // rearchive temp directory
+    await zipVersionAndArchive(orgLibName, version, tempDirectory);
+
+    // delete temp directory
+    fs.rmSync(tempDirectory, { recursive: true, force: true, maxRetries: 2  });
+
+
+    if (hadArchive) {
+      console.log(`\n${chalk.green(`${fileName}`)} has been imported!`);
+      console.log(`You can switch to ${chalk.green(`${orgLibName}/${version}`)} via npm run switchLib.`);
+      console.log("");
+    }
+    else {
+      const switchToFileName = `${orgLibName}_${version}.arch.zip`;
+
+      const tasks = new Listr(
+        [
+          {
+            title: `Restoring ${orgLibName}/${version}`,
+            task: async () => {
+              await restoreFromArchive(switchToFileName, orgLibName, version);
+            }
+          }
+        ],
+        { concurrent: false, exitOnError: true }
+      );
+
+      console.log(`\n${chalk.green(`${fileName}`)} has been imported!`);
+
+      await tasks.run().catch(err => {
+        console.log(chalk.bold.red(err.toString()));
+        process.exit(1);
+      });
+
+      console.log(`${chalk.bold.green(`\nSwitched to ${orgLibName}/${version}!\n`)}`);
+
+      await forceDefaultsUpdate();
+      await showCurrentStatus();
+
+      console.log('\n***************************************************************');
+      console.log(chalk.bold.yellow('Dependencies have changed between versions, recommend updating.'));
+      console.log(`>>> PLEASE run ${chalk.bold.yellow("'npm update'")}.`);
+      console.log('***************************************************************\n');
+    }
+
+
+  }
+
+export const importArchServer = async(filePath, fileName, hadArchive) => {
 addDebugLog("importArch", `filePath: ${filePath}, fileName: ${fileName}`, "");
 
   const currentDirectory = process.cwd();
   const tempDirectory = join(currentDirectory, TEMP_PATH);
 
-
   const zipFilePath = join(filePath, fileName);
 
-
   // we are going to use node stream zip to list contents of archive first,
   // before we un archive to a temp directory.  If pass, then un archive
   let passCount = 0;
@@ -252,8 +427,9 @@ addDebugLog("importArch", `filePath: ${filePath}, fileName: ${fileName}`, "");
   const tempPackage = join(tempDirectory, "package.json");
   const tasksConfig = "tasks.config.json";
   const packageJson = "package.json";
+  let testZip;
   try {
-    const testZip = new StreamZip.async({ file: zipFilePath});
+    testZip = new StreamZip.async({ file: zipFilePath});
     const entries = await testZip.entries();
 
     for (const entry of Object.values(entries)) {
@@ -262,32 +438,34 @@ addDebugLog("importArch", `filePath: ${filePath}, fileName: ${fileName}`, "");
       }
     }
 
-    // Do not forget to close the file once you're done
-    await testZip.close();
   }
   catch (ex) {
     passCount = 0;
   }
 
-
   if (passCount < 2) {
     console.log(chalk.red.bold(`Zip file: ${fileName} not a compatible DX Component archive.`));
+    // Do not forget to close the file once you're done
+    await testZip.close();
+
     process.exit(1);
 
   }
 
-  await unZipFromArchive(zipFilePath);
+  // make directory in temp dir, can NOT be the same directory as the zip file is in
+  const dirName = fileName.replaceAll(".zip", "");
+  const newDirPath = join(TEMP_PATH, dirName);
+  fs.mkdirSync(newDirPath);
 
+  const count = await testZip.extract(null, newDirPath);
 
+  // Do not forget to close the file once you're done
+  await testZip.close();
 
-  // if (!fs.existsSync(tempTasksConfig) || !fs.existsSync(tempPackage)) {
-  //   console.log(chalk.red.bold(`Zip file: ${fileName} not a compatible DX Component archive.`));
-  //   console.log(chalk.red.bold("Cleaning up..."));
-  //   fs.rmSync(tempDirectory, { recursive: true, force: true, maxRetries: 5  });
-  //   console.log(chalk.red.bold("Done."));
-  //   process.exit(1);
+  // we want file contents to be in the TEMP_PATH (copying, but temp directory eventually will be deleted)
+  fs.cpSync(newDirPath, TEMP_PATH, {recursive: true});
 
-  // }
+  // await unZipFromArchive(zipFilePath);
 
   // need to get info from tasks.config and package.json
   // we won't rely on name of file, as owner can change it
@@ -383,7 +561,8 @@ addDebugLog("importArch", `filePath: ${filePath}, fileName: ${fileName}`, "");
 
   if (hadArchive) {
     console.log(`\n${chalk.green(`${fileName}`)} has been imported!`);
-    console.log(`You can switch to ${chalk.green(`${orgLibName}/${version}`)} via npm run switchLib.\n`);
+    console.log(`You can switch to ${chalk.green(`${orgLibName}/${version}`)} via npm run switchLib.`);
+    console.log("");
   }
   else {
     const switchToFileName = `${orgLibName}_${version}.arch.zip`;
@@ -451,19 +630,11 @@ export const writeZipBuffer = async(fileName, fileBuffer) => {
   const currentDirectory = process.cwd();
   const tempDirectory = join(currentDirectory, TEMP_PATH);
 
-  // have to decode it and then re-encode it.
-  let decodedString;
-  try {
-    decodedString = atob(fileBuffer);
-  } catch (error) {
-  }
-
   if (!fs.existsSync (tempDirectory)) {
     fs.mkdirSync(tempDirectory);
   }
 
   const filePath = join(tempDirectory, fileName);
-
   fs.writeFileSync(filePath, fileBuffer, 'base64');
 
 }
@@ -539,18 +710,39 @@ export default async options => {
 
           const arArchData = archiveData.split(",");
           let fileName = `${arArchData[1]}.${arArchData[2]}`;
+          let fileData;
+
+          console.log("");
 
-          // get archive
-          const fileData = await getServerLibraryArchive(arArchData[0],arArchData[1], arArchData[2], arArchData[3], arArchData[4]);
-          await writeZipBuffer(fileName, fileData.pyFileSource);
+          const tasks = new Listr(
+            [
+              {
+                title: 'Fetching archive from server',
+                task: async () => {
+                  // get archive
+                  fileData = await getServerLibraryArchive(arArchData[0],arArchData[1], arArchData[2], arArchData[3], arArchData[4]);
+                }
+              },
+              {
+                title: 'Saving archive in store',
+                task: async () => {
+                  await writeZipBuffer(fileName, fileData.pyFileSource);
+
+                  // import archive
+                  const currentDirectory = process.cwd();
+                  const tempDirectory = join(currentDirectory, TEMP_PATH);
 
-          // import archive
-          const currentDirectory = process.cwd();
-          const tempDirectory = join(currentDirectory, TEMP_PATH);
+                  await importArchServer( tempDirectory, fileName, hasArch);
+                }
+              }
+            ],
+            { concurrent: false, exitOnError: true }
+          );
 
-          await importArch( tempDirectory, fileName, hasArch);
-          // const zipFilePath = join(tempDirectory, fileName);
-          //await unZipFromArchive(zipFilePath);
+          await tasks.run().catch(err => {
+            console.log(chalk.bold.red(err.toString()));
+            process.exit(1);
+          });
 
         }
 
@@ -595,8 +787,28 @@ export default async options => {
       const fileNameAnswers = await inquirer.prompt(fileNameQuestions);
       const {fileName} = fileNameAnswers;
 
+      console.log("");
+
+      const tasks = new Listr(
+        [
+          {
+            title: `Importing archive`,
+            task: async () => {
+              await importArch( filePath, fileName, hasArch);
+            }
+          }
+        ],
+        { concurrent: false, exitOnError: true }
+      );
+
+
+      await tasks.run().catch(err => {
+        console.log(chalk.bold.red(err.toString()));
+        process.exit(1);
+      });
+
+      console.log("");
 
-      await importArch( filePath, fileName, hasArch);
 
       // reapply to save if changed, because imported task.config may have overriden and we want
       // to keep what was entered as the latest

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

@@ -1,5 +1,3 @@
-import chalk from 'chalk';
-import fs from 'fs';
 import path from 'path';
 import { join } from 'path';
 import { addDebugLog, getConfigDefaults, setConfigImportRelativePath, forceDefaultsUpdate } from '../../util.js';

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

@@ -107,7 +107,7 @@
     "@babel/preset-react": "^7.26.3",
     "@babel/preset-typescript": "^7.26.0",
     "@pega/configs": "^0.16.2",
-    "@pega/custom-dx-components": "~0.25.21",
+    "@pega/custom-dx-components": "~0.25.23",
     "@pega/pcore-pconnect-typedefs": "^4.1.0-alpha.1",
     "@storybook/addon-actions": "^7.6.19",
     "@storybook/addon-essentials": "^7.6.19",

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

@@ -38,6 +38,6 @@
     "icon": ""
   },
   "usePromotedWebPack": false,
-  "libraryMode": false,
+  "libraryModeCL": false,
   "showDebug": false
 }