@pega/custom-dx-components 0.242.28 → 0.242.30

package/package.json

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

package/src/cli.js

@@ -16,6 +16,9 @@ import {
   deleteAllComponents,
   deleteLibrary,
   deletePublished,
+  deleteVersion,
+  importArchive,
+  exportArchive,
   initProject,
   listComponents,
   listLibrary,
@@ -24,10 +27,12 @@ import {
   publishAllComponents,
   publishLibrary,
   renameComponent,
+  moveComponent,
   renameLibrary,
   revertWebPack,
   promoteWebPack,
   showStatus,
+  storeComponents,
   updateComponent,
   validate,
   upgrade,
@@ -52,16 +57,21 @@ const TASKS = {
   PUBLISH_LIB: 'publishLibrary',
   RENAME: 'rename',
   RENAME_LIB: 'renameLibrary',
+  MOVE: 'moveComponent',
   LIST: 'list',
   LIST_LIB: 'listLibrary',
   LIST_PUB: 'listPublished',
   SHOW_STATUS: 'showStatus',
+  STORE: 'storeComponents',
   VALIDATE_SCHEMA: 'validateSchema',
   UPDATE: 'update',
   DELETE: 'delete',
   DELETE_ALL: 'deleteAll',
   DELETE_LIBRARY: 'deleteLibrary',
   DELETE_PUB: 'deletePublished',
+  DELETE_VERSION: 'deleteVersion',
+  IMPORT_ARCHIVE: 'importArchive',
+  EXPORT_ARCHIVE: 'exportArchive',
   AUTHENTICATE: 'authenticate',
   UPGRADE: 'upgrade',
   BUILD_JEST_ASSETS: 'buildJestAssets'
@@ -146,6 +156,10 @@ export default async (args = []) => {
       renameLibrary(options);
       break;
     }
+    case TASKS.MOVE: {
+      moveComponent(options);
+      break;
+    }
     case TASKS.BUILD: {
       buildComponent(options);
       break;
@@ -174,6 +188,18 @@ export default async (args = []) => {
       showStatus(options);
       break;
     }
+    case TASKS.STORE: {
+      storeComponents(options);
+      break;
+    }
+    case TASKS.IMPORT_ARCHIVE: {
+      importArchive(options);
+      break;
+    }
+    case TASKS.EXPORT_ARCHIVE: {
+      exportArchive(options);
+      break;
+    }
     case TASKS.VALIDATE_SCHEMA: {
       validate(options);
       break;
@@ -198,6 +224,10 @@ export default async (args = []) => {
       deletePublished(options);
       break;
     }
+    case TASKS.DELETE_VERSION: {
+      deleteVersion(options);
+      break;
+    }
     case TASKS.AUTHENTICATE: {
       authenticate(options);
       break;

package/src/constants.js

@@ -9,10 +9,11 @@ export const COMPONENTS_DIRECTORY_PATH = 'components-directory-path';
 export const COMPONENTS_PATH = 'component';
 export const TOKEN_PATH = 'node_modules/@pega/custom-dx-components/.access_token';
 export const OOTB_COMPONENTS = 'node_modules/@pega/custom-dx-components/.ootb_components';
-export const LIBRARY_BASED = 'libraryBased';
+export const LIBRARY_BASED = 'libraryMode';
 export const SHARED_DIRECTORY = 'shared';
 export const SHOW_DEBUG = 'showDebug';
-export const ARCHIVES_PATH = 'archives';
+export const ARCHIVES_PATH = 'store';
+export const TEMP_PATH = 'store/temp';
 export const COMPONENTS_CONFIG_FILE_NAME = 'componentsconfig.json';
 
 /* REST end points */

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

@@ -15,12 +15,14 @@ import {
 } from '../../util.js';
 import { PUBLISH_COMPONENT_SERVICE_REST_ENDPOINT, TOKEN_PATH } from '../../constants.js';
 
-const isLibraryBased = getLibraryBased();
-// validate and validateAll will be called when libraryBased, but using same code
-// so need different label
-const buildLabel = isLibraryBased ? "validate" : "build";
+
 
 export const getPublishComponentQuestions = async componentKey => {
+  const isLibraryBased = getLibraryBased();
+  // validate and validateAll will be called when libraryBased, but using same code
+  // so need different label
+  const buildLabel = isLibraryBased ? "validate" : "build";
+
   const components = await getComponents();
 
   if (components.length === 0) {

package/src/tasks/bundle/builder/index.js

@@ -6,11 +6,7 @@ import printBuildError from 'react-dev-utils/printBuildError.js';
 import { getUseWebPackPromotion, addDebugLog} from '../../../util.js';
 
 
-const usePromoted = await getUseWebPackPromotion();
-// used by promote and revert webPack commands, do not change
-const configFactory = (
-  await import(`${usePromoted ? `../../../../../../../webpack.config.js` : `./webpack.config.js`}`)
-).default
+
 
 
 import paths from './paths.js';
@@ -138,7 +134,7 @@ addDebugLog("bundle build", `config: ${JSON.stringify(config)}, \npreviousFileSi
   });
 }
 
-export default ({
+export default async ({
   inputFile,
   outputFile,
   componentKey,
@@ -148,6 +144,12 @@ export default ({
   devBuild,
   showStats
 }) => {
+  const usePromoted = await getUseWebPackPromotion();
+  // used by promote and revert webPack commands, do not change
+  const configFactory = (
+    await import(`${usePromoted ? `../../../../../../../webpack.config.js` : `./webpack.config.js`}`)
+  ).default
+
   // Generate configuration
   const config = configFactory(Env, {
     inputFile,

package/src/tasks/create/index.js

@@ -34,7 +34,6 @@ const copyComponentTemplate = async options => {
   });
 };
 
-const isLibraryBased =  getLibraryBased();
 
 const compileMustacheTemplates = async (
   componentDirectory,
@@ -53,6 +52,7 @@ const compileMustacheTemplates = async (
 ) => {
   const files = fs.readdirSync(componentDirectory);
   const componentClassName = convertIntoPascalCase(componentKey);
+  const isLibraryBased =  getLibraryBased();
 
   const isTemplate = type === 'Template';
   const isBool = subtype === 'Boolean';
@@ -174,6 +174,7 @@ const validateCompile = async (
   options
 ) => {
 
+  const isLibraryBased =  getLibraryBased();
   let sSubType = subtype;
   if (Array.isArray(subtype)) {
     sSubType = subtype.join("-");
@@ -269,6 +270,7 @@ export default async options => {
   await showVersion();
 
   await checkLibraryAndArchives();
+  const isLibraryBased =  getLibraryBased();
 
 
 addDebugLog("create", "", "+");
@@ -411,7 +413,7 @@ addDebugLog("create", "", "+");
       },
       {
         name: 'description',
-        message: 'Enter description for the component',
+        message: 'Enter description for the component (default is label)',
         default: componentDefaults.description
       }
     ];

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

@@ -34,7 +34,7 @@ const pegaConfigJsonPath = path.join(path.resolve(), TASKS_CONFIG_JSON_FILENAME)
 
 const copy = promisify(ncp);
 
-const isLibraryBased =  getLibraryBased();
+
 
 const copyComponentTemplate = async (options) => {
   if (options.targetDirectory) {
@@ -59,6 +59,7 @@ export const compileMustacheTemplates = async (
 ) => {
   const files = fs.readdirSync(componentDirectory);
   const componentClassName = convertIntoPascalCase(componentKey);
+  const isLibraryBased =  getLibraryBased();
 
   const isTemplate = type === 'Template';
 
@@ -175,7 +176,7 @@ export const validateCompile = async (
     sSubType = subtype.join('-');
   }
 
-
+  const isLibraryBased =  getLibraryBased();
   framework = convertIntoPascalCase(CATEGORY_CONSTELLATION);
 
   const templateParentDir = `./templates/${framework}`;
@@ -358,9 +359,10 @@ export const validateCompileAll = async ({ prefix, library, version, allowedAppl
 
 export default async (options) => {
   await showVersion();
-
   await checkLibraryAndArchives();
 
+  const isLibraryBased =  getLibraryBased();
+
 addDebugLog("createAll", "", "+");
 
   await checkPathAccess(pegaConfigJsonPath);

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

@@ -73,7 +73,7 @@ addDebugLog("getCreateLibComponentQuestions", "", "");
     {
       name: 'permBuild',
       type: 'confirm',
-      message: `Version to be ${chalk.bold.yellow('PERMENANT')} upon publish `,
+      message: `Version to be ${chalk.bold.yellow('PERMANENT')} upon publish `,
       default: false
     }
   ];

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

@@ -20,10 +20,8 @@ import {
 import { getCreateLibComponentQuestions, getOkToProceedQuestion } from './helper.js';
 import { showCurrentStatus } from '../show-status/index.js';
 
-
-const isLibraryBased =  getLibraryBased();
-
 export default async options => {
+  const isLibraryBased =  getLibraryBased();
   if (!isLibraryBased) {
     console.log(`Command only supported for ${chalk.bold.green('library based')} components.`);
     process.exit();
@@ -41,7 +39,7 @@ addDebugLog("createLibrary", "", "+");
 
   if (hasArch) {
     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 archived and the newly created library/version will be your default.'))
+    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);
@@ -65,8 +63,8 @@ addDebugLog("createLibrary", "", "+");
 
 
 
-  // if have archives, then that means there is a current library, so
-  // archive it before clearing out /src/components
+  // if have store, then that means there is a current library, so
+  // store it before clearing out /src/components
 
   if (hasArch) {
 

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

@@ -52,6 +52,7 @@ addDebugLog("getCreateVersionComponentQuestions", "", "");
 
   // increment the version
   const incrVersion = await getNextVersion();
+  console.log(`\nCurrent library: ${chalk.green(`${componentDefaults.currentOrgLib}`)}`);
 
   return [
     {
@@ -68,7 +69,7 @@ addDebugLog("getCreateVersionComponentQuestions", "", "");
     {
       name: 'permBuild',
       type: 'confirm',
-      message: `Version ${chalk.bold.yellow('PERMENANT')} upon publish ?`,
+      message: `Version ${chalk.bold.yellow('PERMANENT')} upon publish ?`,
       default: !componentDefaults.devBuild
     },
     {

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

@@ -14,16 +14,17 @@ import {
   zipVersionAndArchive,
   setConfigDevBuild,
   checkLibraryAndArchives,
-  getConfigDefaults
+  getConfigDefaults,
+  forceDefaultsUpdate
 } from '../../util.js';
 
 import { getCreateVersionComponentQuestions, updateAllComponentsConfig } from './helper.js';
-
-const isLibraryBased =  getLibraryBased();
+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.`);
+    console.log(`Command only supported for ${chalk.bold.green('library mode')} components.`);
     process.exit();
   }
 
@@ -67,7 +68,7 @@ addDebugLog("createVersion", "", "+");
     version = version.concat("-dev");
   }
 
-  // archive existing
+  // store existing
   await zipVersionAndArchive(existingOrgLib, oldVersion);
 
   if (copyExisting) {
@@ -98,9 +99,12 @@ addDebugLog("createVersion", `make new directory: ${componentDirectory}`, "");
 
 
 
-  console.log(`${chalk.bold.green(`\nLibrary ${existingOrgLib}/${oldVersion} has been archived.`)}`);
+  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", "-");
 

package/src/tasks/delete/index.js

@@ -4,7 +4,6 @@ import { showVersion, getLibraryBased, addDebugLog, checkLibraryAndArchives } fr
 
 import { deleteLocalComponents, SOURCE_OF_COMPONENT_TYPES, deleteServerComponents, getDeleteComponentsQuestions } from './helper.js';
 
-const isLibraryBased = getLibraryBased();
 
 const deleteComponentsFn = async (sourceOfComponents, answers, options) => {
 addDebugLog("deleteComponentsFn", `sourceOfComponents: ${sourceOfComponents}`, "");
@@ -27,6 +26,7 @@ addDebugLog("deleteComponentsFn", `sourceOfComponents: ${sourceOfComponents}`, "
 export default async (options) => {
   await showVersion();
   await checkLibraryAndArchives();
+  const isLibraryBased = getLibraryBased();
 
 addDebugLog("delete", "", "+");
 

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

@@ -9,7 +9,6 @@ import {
   getDeleteComponentsQuestions
 } from './helper.js';
 
-const isLibraryBased = getLibraryBased();
 
 const deleteComponentsFn = async (sourceOfComponents, answers, options) => {
   addDebugLog('deleteComponentsFn', `sourceOfComponents: ${sourceOfComponents}`, '');
@@ -32,6 +31,7 @@ const deleteComponentsFn = async (sourceOfComponents, answers, options) => {
 export default async options => {
   await showVersion();
   await checkLibraryAndArchives();
+  const isLibraryBased = getLibraryBased();
 
   addDebugLog('deleteAll', '', '+');
 

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

@@ -20,41 +20,22 @@ import {
 import { getDeleteLibraryQuestions, getLibraryVersionQuestion } from './helper.js';
 import { showCurrentStatus } from '../show-status/index.js';
 
-const isLibraryBased = getLibraryBased();
 
-export default async (options) => {
-  if (!isLibraryBased) {
-    console.log(`Command only supported for ${chalk.bold.green('library based')} components.`)
-    process.exit();
-  }
 
-  await showVersion();
-  await checkLibraryAndArchives();
-
-addDebugLog("deleteLibrary", "", "+");
-
-  let sourceOfLibrary;
-  let organization;
-  let library;
-  let version;
-  let devBuild;
+export const deleteLibraryVersion = async (libraryName, version = "") => {
+addDebugLog("deleteLibraryVersion", "", "+");
 
+  const isLibraryBased = getLibraryBased();
   const compDef = getConfigDefaults();
-  let libraryName;
   let libVersions = [];
   let confirmDeletion;
 
-  if (options.params.length >= 5) {
-    libraryName = options.params[3];
-    version = options.params[4];
-
+  if (!isLibraryBased) {
+    console.log(`Command only supported for ${chalk.bold.green('library mode')} components.`);
+    process.exit();
   }
-  else {
-
-    const questions = await getDeleteLibraryQuestions();
-    const answers = await inquirer.prompt(questions);
-    ({ libraryName } = answers);
 
+  if (version === "") {
     try {
       libVersions = await getLibraryArchivesVersions(libraryName, "");
     }
@@ -99,10 +80,10 @@ addDebugLog("deleteLibrary", "", "+");
 
     }
     else {
-      // No library with that name
-      console.log(chalk.redBright(`No local library named: ${libraryName} exists.`));
-addDebugLog("deleteLibrary", "END", "-");
-      process.exit();
+        // No library with that name
+        console.log(chalk.redBright(`No local library named: ${libraryName} exists.`));
+addDebugLog("deleteLibraryVersion", "END", "-");
+        process.exit();
 
     }
 
@@ -125,7 +106,7 @@ addDebugLog("deleteLibrary", "END", "-");
       await deleteLocalComponent(component);
     }
 
-    // switch to another version, if no versions to switch to then delete /archives so will be back to state of nothing
+    // switch to another version, if no versions to switch to then delete /store so will be back to state of nothing
     const archiveLibraries = await getLibraryArchiveDirectories("");
     if (archiveLibraries && archiveLibraries.length > 0) {
       if (archiveLibraries.includes(libraryName)) {
@@ -135,6 +116,8 @@ addDebugLog("deleteLibrary", "END", "-");
         await restoreFromArchive(switchToFileName, libraryName, lastVersion);
 
         await forceDefaultsUpdate();
+        const configDef = getConfigDefaults();
+        console.log(`\nSwitched to ${chalk.green(`${configDef.displayLibVersion}`)}`);
         await showCurrentStatus();
 
       }
@@ -146,18 +129,58 @@ addDebugLog("deleteLibrary", "END", "-");
         const switchToFileName = `${newLib}_${lastVersion}.zip`;
         await restoreFromArchive(switchToFileName, newLib, lastVersion);
 
+
         await forceDefaultsUpdate();
+        const configDef = getConfigDefaults();
+        console.log(`\nSwitched to ${chalk.green(`${configDef.displayLibVersion}`)}`);
         await showCurrentStatus();
 
       }
     }
     else {
-      // no libraries, so remove "/archives"
+      // no libraries, so remove "/store"
       await deleteArchives();
     }
 
   }
 
+addDebugLog("deleteLibraryVersion", "END", "-");
+
+}
+
+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 checkLibraryAndArchives();
+
+addDebugLog("deleteLibrary", "", "+");
+
+
+  let version = "";
+
+  const compDef = getConfigDefaults();
+  let libraryName;
+
+  if (options.params.length >= 5) {
+    libraryName = options.params[3];
+    version = options.params[4];
+
+  }
+  else {
+
+    const questions = await getDeleteLibraryQuestions();
+    const answers = await inquirer.prompt(questions);
+    ({ libraryName } = answers);
+
+  }
+
+  await deleteLibraryVersion(libraryName, version);
+
 
 
 addDebugLog("deleteLibrary", "END", "-");

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

@@ -7,11 +7,12 @@ import { deleteLib } from '@pega/constellation-dx-components-build-utils/index.j
 
 import { getDeleteLibraryQuestions, getLibraryVersionQuestion, SOURCE_OF_COMPONENT_TYPES } from './helper.js';
 
-const isLibraryBased = getLibraryBased();
+
 
 export default async (options) => {
+  const isLibraryBased = getLibraryBased();
   if (!isLibraryBased) {
-    console.log(`Command only supported for ${chalk.bold.green('library based')} components.`)
+    console.log(`Command only supported for ${chalk.bold.green('library mode')} components.`)
     process.exit();
   }
 

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

@@ -0,0 +1,45 @@
+import inquirer from 'inquirer';
+import chalk from 'chalk';
+
+import {
+  showVersion,
+  getLibraryBased,
+  checkLibraryAndArchives,
+  getConfigDefaults,
+  addDebugLog
+} from '../../util.js';
+
+import { deleteLibraryVersion } from '../delete-lib/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();
+
+addDebugLog("deleteVersion", "", "+");
+
+
+  let version = "";
+
+  const configDef = getConfigDefaults();
+  let libraryName;
+
+  if (options.params.length >= 4) {
+    version = options.params[3];
+
+  }
+
+await deleteLibraryVersion(configDef.currentOrgLib, version);
+
+
+
+addDebugLog("deleteVersion", "END", "-");
+
+  return true;
+};

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

@@ -0,0 +1,85 @@
+import chalk from 'chalk';
+import path from 'path';
+import { join } from 'path';
+import { addDebugLog, getConfigDefaults, getLibraryArchiveDirectories, getLibraryArchivesVersions } from '../../util.js';
+
+export const SOURCE_OF_COMPONENT_TYPES = {
+  SERVER: 'Server',
+  LOCAL: 'Local'
+};
+
+
+export const getFilePathQuestions = async () => {
+addDebugLog("getFilePathQuestions", "", "");
+
+  console.log("\nFile path examples:");
+  if (path.sep === "/") {
+    console.log("\tMac OS/Unix:\t/Users/name/...");
+  }
+  else {
+    console.log("\tWindows:\tC:\\Users\\name\\...\n");
+  }
+
+  const currentDirectory = process.cwd();
+  const arPathParts = currentDirectory.split(path.sep);
+  let defaultPath = join(arPathParts[0], arPathParts[1], arPathParts[2], "Downloads");
+  if (path.sep === "/") {
+    defaultPath = "/".concat(defaultPath);
+  }
+
+
+  return [
+    {
+      name: 'filePath',
+      message: 'Enter full file path of zip file location:',
+      default: defaultPath
+    }
+  ];
+};
+
+export const getFileNameQuestions = async (zipFileList) => {
+addDebugLog("getFileNameQuestions", "", "");
+
+  return [
+    {
+      name: 'fileName',
+      type: 'rawlist',
+      message: `Select zip file`,
+      choices: zipFileList
+    },
+  ];
+};
+
+export const getLibraryQuestion = async () => {
+addDebugLog("getLibraryQuestion", "", "");
+  const componentDefaults = getConfigDefaults();
+  const orgLib = getConfigDefaults();
+  const currentOrgLib = `${orgLib.organization}_${orgLib.library}`;
+
+  const archVersionList = await getLibraryArchiveDirectories("");
+
+
+  return [
+    {
+      name: 'orgLibName',
+      type: 'rawlist',
+      message: `Select a library (current library is ${chalk.bold.green(`${currentOrgLib}`)}) `,
+      choices: archVersionList
+    }
+  ];
+};
+
+export const getLibraryVersionQuestion = async (newOrgLib) => {
+addDebugLog("getLibraryVersionQuestion", "", "");
+
+  const archVersionList = await getLibraryArchivesVersions(newOrgLib, "0.0.0");
+
+  return [
+    {
+      name: 'selectedVersion',
+      type: 'rawlist',
+      message: `Select a version  `,
+      choices: archVersionList
+    }
+  ];
+};