@pega/custom-dx-components 0.242.33 → 0.242.34

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pega/custom-dx-components",
-  "version": "0.242.33",
+  "version": "0.242.34",
   "description": "Utility for building custom UI components",
   "bin": "./bin/index.js",
   "scripts": {
@@ -19,7 +19,7 @@
     "@babel/plugin-transform-class-properties": "^7.23.3",
     "@babel/preset-react": "^7.23.3",
     "@pega/auth": "^0.1.6",
-    "@pega/constellation-dx-components-build-utils": "^1.0.1-dev-0.16",
+    "@pega/constellation-dx-components-build-utils": "^1.0.1-dev-0.17",
     "ajv": "^8.12.0",
     "ajv-keywords": "^5.1.0",
     "archiver": "^7.0.1",

package/src/cli.js

@@ -32,6 +32,7 @@ import {
   revertWebPack,
   promoteWebPack,
   showStatus,
+  showHelp,
   setPermanent,
   storeComponents,
   updateComponent,
@@ -63,6 +64,7 @@ const TASKS = {
   LIST_LIB: 'listLibrary',
   LIST_PUB: 'listPublished',
   SHOW_STATUS: 'showStatus',
+  SHOW_HELP: 'showHelp',
   SET_PERM: 'setPermanent',
   STORE: 'storeComponents',
   VALIDATE_SCHEMA: 'validateSchema',
@@ -190,6 +192,10 @@ export default async (args = []) => {
       showStatus(options);
       break;
     }
+    case TASKS.SHOW_HELP: {
+      showHelp(options);
+      break;
+    }
     case TASKS.SET_PERM: {
       setPermanent(options);
       break;

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

@@ -67,7 +67,6 @@ addDebugLog("createLibrary", "", "+");
   // 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.`)}`);

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

@@ -35,12 +35,12 @@ addDebugLog("deleteLibraryVersion", "", "+");
     process.exit();
   }
 
-  if (version === "") {
-    try {
-      libVersions = await getLibraryArchivesVersions(libraryName, "");
-    }
-    catch (ex) {}
+  try {
+    libVersions = await getLibraryArchivesVersions(libraryName, "");
+  }
+  catch (ex) {}
 
+  if (version === "") {
 
     if (libVersions.length > 0) {
       // ALL option

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

@@ -148,6 +148,27 @@ addDebugLog("renameComponent", `library: ${library}, componentKey: ${componentKe
 
 };
 
+export const getPackgeOrg = async(packagePath) => {
+  const sPackData = fs.readFileSync(packagePath, { encoding: 'utf8' });
+  const packData = sPackData && JSON.parse(sPackData);
+
+  return packData.organization;
+}
+
+export const getLocalConfigData = async(tasksPath) => {
+  let configData = { library: "", version: "", buildVersion: "", devBuild: false};
+  const sTaskData = fs.readFileSync(tasksPath, { encoding: 'utf8' });
+  const taskData = sTaskData && JSON.parse(sTaskData);
+
+  const devBuild = taskData["server-config"].devBuild;
+  configData.library = taskData["component"].library;
+  configData.version = taskData["component"].version;
+  configData.devBuild = devBuild;
+
+  configData.buildVersion = devBuild ? configData.version.concat("-dev") : configData.version;
+
+  return configData;
+}
 
 export const moveComp = async(componentKey, orgLibName, version, copyShared, options) => {
 
@@ -203,7 +224,9 @@ addDebugLog("importArch", `filePath: ${filePath}, fileName: ${fileName}`, "");
 
   // check to see if have a tasks.config.json file, if not, archive not good
   const tempTasksConfig = join(tempDirectory, "tasks.config.json");
-  if (!fs.existsSync(tempTasksConfig)) {
+  const tempPackage = join(tempDirectory, "package.json");
+
+  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  });
@@ -212,20 +235,23 @@ addDebugLog("importArch", `filePath: ${filePath}, fileName: ${fileName}`, "");
 
   }
 
+  // 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 orgLibName = `${organization}_${localConfig.library}`;
+  const version = localConfig.buildVersion;
+  const devBuild = localConfig.devBuild;
 
-  const arFileData = fileName.split("_");
-  let orgLibName = `${arFileData[0]}_${arFileData[1]}`;
-  let libName = arFileData[1];
-  const version = arFileData[2].replace(".zip", "");
-  const devBuild = version.indexOf("-dev") > 0 ? true : false;
   const configDef = getConfigDefaults();
 
-  if (arFileData[0] !== configDef.organization) {
+  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(`${arFileData[0]}`)} and import there.\n`);
+    console.log(`\t    of ${chalk.yellow(`${organization}`)} and import there.\n`);
 
     const proceedAnswers = await inquirer.prompt([
 

package/src/tasks/index.js

@@ -22,6 +22,7 @@ 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';
 export { default as showStatus } from './show-status/index.js';
+export { default as showHelp } from './show-help/index.js';
 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';

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

@@ -43,6 +43,7 @@
     "exportLibVersion": "custom-dx-components exportArchive",
     "validate": "custom-dx-components buildComponent",
     "validateAll": "custom-dx-components buildAllComponents",
+    "help": "custom-dx-components showHelp",
     "_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",
@@ -97,7 +98,7 @@
   },
   "devDependencies": {
     "@pega/configs": "^0.6.0",
-    "@pega/custom-dx-components": "0.242.33",
+    "@pega/custom-dx-components": "0.242.34",
     "@pega/pcore-pconnect-typedefs": "~3.0.0",
     "@storybook/addon-actions": "^7.6.7",
     "@storybook/addon-essentials": "^7.6.19",

package/src/tasks/show-help/index.js

@@ -0,0 +1,128 @@
+import fs from 'fs';
+import path from 'path';
+
+import chalk from 'chalk';
+
+import { showVersion, getLibraryBased } from '../../util.js';
+
+export const showCurrentStatus = async () => {
+
+  const configDefaults = await getConfigDefaults();
+  const componentList = await getComponents();
+
+  console.log("");
+  console.log("\tCurrent status");
+  console.log("\t---------------------");
+  console.log(`\tOrganization:\t ${chalk.bold.green(`${configDefaults.organization}`)}`);
+  console.log(`\tLibrary:\t ${chalk.bold.green(`${configDefaults.library}`)}`);
+  console.log(`\tVersion:\t ${chalk.bold.green(`${configDefaults.buildVersion}`)}`);
+  if (!configDefaults.devBuild) {
+    console.log(`\tPermanent:\t ${chalk.bold.magentaBright(`${!configDefaults.devBuild}`)}`);
+  }
+  else {
+    console.log(`\tPermanent:\t ${chalk.bold.green(`${!configDefaults.devBuild}`)}`);
+  }
+  console.log(`\tComponent count: ${chalk.bold.green(`${componentList.length}`)}`);
+
+  console.log("");
+
+}
+
+export const showHelpV1 = () => {
+  console.log("");
+  console.log(`\nnpm run <command>`);
+  console.log(`\nUsage:`);
+
+  console.log(`\n${chalk.underline(`Authenticate (for Server commands)`)}`);
+  console.log(`${chalk.cyan('npm run authenticate')}\t\tauthenticate to a server`);
+
+  console.log(`\n${chalk.underline(`Components`)}`);
+  console.log(`${chalk.cyan('npm run create           ')}\tcreate a component`);
+  console.log(`${chalk.cyan('npm run createAll        ')}\tcreate components of all different types`);
+  console.log(`${chalk.cyan('npm run buildComponent   ')}\tvalidate a component before publishing, checking for errors`);
+  console.log(`${chalk.cyan('npm run buildAllComponents')}\tvalidate and build a component before publishing, checking for errors`);
+  console.log(`${chalk.cyan('npm run validateAll      ')}\tvalidate and build ALL components before publishing, checking for errors`);
+  console.log(`${chalk.cyan('npm run rename           ')}\trename a component`);
+  console.log(`${chalk.cyan('npm run startStorybook   ')}\tstorybook components for testing`);
+
+  console.log(`\n${chalk.underline(`Local and Server`)}`);
+  console.log(`${chalk.cyan('npm run list             ')}\tget list of components`);
+  console.log(`${chalk.cyan('npm run delete           ')}\tdelete a component`);
+  console.log(`${chalk.cyan('npm run deleteAll        ')}\tdelete ALL components`);
+
+  console.log(`\n${chalk.underline(`Server`)}`);
+  console.log(`${chalk.cyan('npm run publish          ')}\tpublish a component to server`);
+  console.log(`${chalk.cyan('npm run publishAll       ')}\tpublish ALL components to server`);
+
+  console.log("");
+
+};
+
+export const showHelpV2 = () => {
+  console.log("");
+  console.log(`All commands will not work until a library is created via ${chalk.cyan(`npm run createLib`)}.`);
+  console.log(`\nnpm run <command>`);
+  console.log(`\nUsage:`);
+
+
+  console.log(`\n${chalk.underline(`Authenticate`)}`);
+  console.log(`${chalk.cyan('npm run authenticate')}\t\tauthenticate to a server (required for publish commands)`);
+
+  console.log(`\n${chalk.underline(`Library`)}`);
+  console.log(`${chalk.cyan('npm run createLib' )}\t\tcreate a new library and version`);
+  console.log(`${chalk.cyan('npm run switchLib' )}\t\tswitch to different library and version`);
+  console.log(`${chalk.cyan('npm run listLib   ')}\t\tget contents of library and version`);
+  console.log(`${chalk.cyan('npm run deleteLib ')}\t\tdelete library, version or ALL versions`);
+  console.log(`${chalk.cyan('npm run showStatus')}\t\tshow state of current library`);
+
+  console.log(`\n${chalk.underline(`Library Versions`)}`);
+  console.log(`${chalk.cyan('npm run createLibVersion')}\tcreate a new version within the current library`);
+  console.log(`${chalk.cyan('npm run switchLibVersion')}\tswitch to different version within the current library`);
+  console.log(`${chalk.cyan('npm run deleteLibVersion')}\tdelete current version, move to another version`);
+  console.log(`${chalk.cyan('npm run moveLibVersion  ')}\tmove (or copy) single component or ALL in current version to another version or library`);
+  console.log(`${chalk.cyan('npm run storeLibVersion ')}\tstore current version to local storage`);
+  console.log(`${chalk.cyan('npm run exportLibVersion')}\texport currnet version as a zip file to a given local path`);
+  console.log(`${chalk.cyan('npm run importLibVersion')}\timport a zip file (created by export) from a given local path`);
+  console.log(`${chalk.cyan('npm run setPermanent    ')}\tmake current version permanent or non permanent upon publish`);
+
+  console.log(`\n${chalk.underline(`Published Versions (needs authentication)`)}`);
+  console.log(`${chalk.cyan('npm run publishLibVersion')}\tpublish current library/version to server (creates a local published library as well)`);
+  console.log(`${chalk.cyan('npm run listPublishedLib')}\tget contents of published library/version (local or server)`);
+  console.log(`${chalk.cyan('npm run deletePublishedLib')}\tdelete ALL contents of published libary/version (local or server)`);
+
+  console.log(`\n${chalk.underline(`Components (in current library/version context)`)}`);
+  console.log(`${chalk.cyan('npm run create     ')}\t\tcreate a component`);
+  console.log(`${chalk.cyan('npm run createAll  ')}\t\tcreate components of all different types`);
+  console.log(`${chalk.cyan('npm run validate   ')}\t\tvalidate a component before publishing, checking for errors`);
+  console.log(`${chalk.cyan('npm run validateAll')}\t\tvalidate ALL components before publishing, checking for errors`);
+  console.log(`${chalk.cyan('npm run rename     ')}\t\trename a component`);
+  console.log(`${chalk.cyan('npm run list       ')}\t\tget list of components`);
+  console.log(`${chalk.cyan('npm run delete     ')}\t\tdelete a component`);
+  console.log(`${chalk.cyan('npm run deleteAll  ')}\t\tdelete ALL components`);
+  console.log(`${chalk.cyan('npm run startStorybook')}\t\tstorybook components for testing`);
+  console.log("");
+
+  console.log(`\n${chalk.underline(`Notes`)}`);
+  console.log(`The following commands will store existing version in storage before executing the command:`);
+  console.log(`${chalk.cyan(`createLib, switchLib, createLibVersion, switchLibVersion, publishLibVersion, exportLibVersion`)}`);
+  console.log(`\nWhen in an IDE, always ${chalk.yellow("SAVE")} changes to components before doing a library/version context switch`);
+  console.log(`or changes will be lost.`);
+  console.log("");
+}
+
+
+export default async options => {
+  const isLibraryBased =  getLibraryBased();
+
+  await showVersion();
+
+  if (isLibraryBased) {
+    await showHelpV2();
+  }
+  else {
+    await showHelpV1();
+  }
+
+
+
+}