@pega/custom-dx-components 24.2.16 → 25.1.10-alpha-0.2

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

@@ -1,9 +1,5 @@
-import fs from 'fs';
-import path from 'path';
-
 import chalk from 'chalk';
-
-import { showVersion, getLibraryBased } from '../../util.js';
+import { showVersion, getLibraryBased, getLibraryBasedCL } from '../../util.js';
 
 export const showCurrentStatus = async () => {
 
@@ -55,12 +51,18 @@ export const showHelpV1 = () => {
   console.log(`${chalk.cyan('npm run publishAll       ')}\tpublish ALL components to server`);
 
   console.log("");
+  console.log(`\n${chalk.underline(`Notes`)}`);
+  console.log(`Cannot publish a component with prefix (Org_Lib) that matches a Rule-UI-ComponentLibrary (libraryModeCL) in same ruleset.`);
+
+  console.log("");
 
 };
 
-export const showHelpV2 = () => {
+export const showHelpV2 = (isCL) => {
   console.log("");
-  console.log(chalk.yellow("**** Beta capability and subject to change.  Developer experimental.  Do not use in a Production Deployment. ***\n"));
+  if (!isCL) {
+    console.log(chalk.yellow("**** Beta capability and subject to change.  Developer experimental.  Do not use in a Production Deployment. ***\n"));
+  }
   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:`);
@@ -79,11 +81,19 @@ export const showHelpV2 = () => {
   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 deleteLibVersion')}\tdelete current version, move to another version, delete is permanent`);
+  console.log(`${chalk.cyan('npm run restoreLibVersion ')}\trestores to current version from local storage (current changes will be LOST)`);
   console.log(`${chalk.cyan('npm run storeLibVersion ')}\tstore current version to local storage (must SAVE components before)`);
-  console.log(`${chalk.cyan('npm run exportLibVersion')}\texport current version as a zip file to a given local path (must SAVE components before)`);
-  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`);
+  if (isCL) {
+    console.log(`${chalk.cyan('npm run exportLibVersion')}\texport current version as a zip file to a given local path or a server (must SAVE components before)`);
+    console.log(`${chalk.cyan('npm run importLibVersion')}\timport a zip file (created by export) from a given local path or a server`);
+  }
+  else {
+    console.log(`${chalk.cyan('npm run exportLibVersion')}\texport current version as a zip file to a given local path (must SAVE components before)`);
+    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 publish           ')}\tpublish current library/version to server (creates a local published library as well)`);
@@ -101,25 +111,36 @@ export const showHelpV2 = () => {
   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("");
   console.log(`${chalk.cyan('npm run startStorybook')}\t\tstorybook components for testing`);
+  console.log(`${chalk.cyan('npm run test')}\t\t\trun component unit tests`);
   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(`${chalk.cyan(`createLib, switchLib, createLibVersion, switchLibVersion, publishLibVersion, exportLibVersion, storeLibVersion`)}`);
   console.log(`\nWhen editing 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(`\nStoring is to LOCAL storage and is not backed up.  You should export your library/versions archives to ${chalk.yellow("git")}`);
+  if (isCL) {
+    console.log(`or export archives to ${chalk.yellow("server")} for backup storage.`);
+  }
+  else {
+    console.log(`for backup storage.`);
+  }
   console.log("");
 }
 
 
 export default async options => {
   const isLibraryBased =  getLibraryBased();
+  const isLibraryBasedCL = getLibraryBasedCL();
 
   await showVersion();
 
   if (isLibraryBased) {
-    await showHelpV2();
+    await showHelpV2(isLibraryBasedCL);
   }
   else {
     await showHelpV1();

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

@@ -1,14 +1,21 @@
-import fs from 'fs';
-import path from 'path';
-
 import chalk from 'chalk';
 
-import { showVersion, getLibraryBased, addDebugLog, getConfigDefaults, getComponents, checkLibraryAndArchives } from '../../util.js';
+import {
+  showVersion,
+  getLibraryBased,
+  getConfigDefaults,
+  getComponents,
+  checkLibraryAndArchives,
+  getPegaServerConfig,
+  getLibraryBasedCL } from '../../util.js';
 
 export const showCurrentStatus = async () => {
 
   const configDefaults = getConfigDefaults();
   const componentList = await getComponents();
+  const isLibraryBased = getLibraryBased();
+  const isLibraryBasedCL = getLibraryBasedCL();
+  const pegaServer = await getPegaServerConfig();
 
   console.log("");
   console.log("\tCurrent status");
@@ -16,17 +23,33 @@ export const showCurrentStatus = async () => {
   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}`)}`);
+  if (!isLibraryBasedCL) {
+    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("");
 
-}
+  if (isLibraryBased && !isLibraryBasedCL ) {
+    // no publishing for just libraryBased, that goes to App Static
+  }
+  else {
+
+    console.log(`\tPublish to:\t ${chalk.bold.green(`${pegaServer.server}`)} `);
+    // console.log("\t---------------------");
+    console.log(`\tRuleSet:\t ${chalk.bold.green(`${pegaServer.rulesetName}`)}`);
+    console.log(`\tRuleSet Version: ${chalk.bold.green(`${pegaServer.rulesetVersion}`)}`);
+    console.log("");
+  }
+
+
+};
 
 
 export default async options => {
@@ -42,4 +65,4 @@ export default async options => {
 
 
 
-}
+};

package/src/tasks/store/index.js

@@ -1,9 +1,9 @@
 
 import { Listr } from 'listr2';
 import chalk from 'chalk';
+import inquirer from 'inquirer';
 
 import {
-
   showVersion,
   addDebugLog,
   checkLibraryAndArchives,
@@ -26,30 +26,51 @@ addDebugLog("storeComponents", "", "+");
     console.log(`Command only supported for ${chalk.bold.green('library mode')} components.`)
     process.exit();
   }
+  const confDef = getConfigDefaults();
+
 
   console.log(chalk.bold.yellow('\nBe sure to SAVE all changes before storing, or changes will NOT be stored.'));
 
+  let answers = {};
 
-  console.log("");
-  const confDef = getConfigDefaults();
-  const tasks = new Listr(
-    [
+  if (options.params.length === 4) {
+    const optConfirm = options.params[3];
+    answers["confirmStore"] = optConfirm === 'Y' || optConfirm === 'y' || optConfirm === true || optConfirm === 'true' ? true : false;
+  }
+  else {
+
+    answers = await inquirer.prompt([
       {
-        title: `Store ${confDef.displayLibVersion}`,
-        task: async () => {
-          await zipVersionAndArchive(confDef.currentOrgLib, confDef.buildVersion);
-        }
+        name: 'confirmStore',
+        type: 'confirm',
+        message: `Storing ${chalk.green(`${confDef.currentOrgLib}/${confDef.buildVersion}`)} to local storage, proceed ?`,
+        default: true
       }
-    ],
-    { concurrent: false, exitOnError: true }
-  );
+    ]);
+  }
 
-  await tasks.run().catch(err => {
-    console.log(chalk.bold.red(err.toString()));
-addDebugLog("storeComponents", "", "-");
-    process.exit(1);
-  });
-  console.log(chalk.greenBright('\nComponents Stored'));
+  if (answers.confirmStore) {
+    console.log("");
+
+    const tasks = new Listr(
+      [
+        {
+          title: `Store ${confDef.displayLibVersion}`,
+          task: async () => {
+            await zipVersionAndArchive(confDef.currentOrgLib, confDef.buildVersion);
+          }
+        }
+      ],
+      { concurrent: false, exitOnError: true }
+    );
+
+    await tasks.run().catch(err => {
+      console.log(chalk.bold.red(err.toString()));
+  addDebugLog("storeComponents", "", "-");
+      process.exit(1);
+    });
+    console.log(chalk.greenBright('\nComponents Stored'));
+  }
 
 addDebugLog("storeComponents", "", "-");
 

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

@@ -8,7 +8,6 @@ import {
   getComponents,
   getPegaServerConfig,
   updateConfigVersion,
-  getLibraryArchiveDirectories,
   getLibraryArchivesVersions,
   addDebugLog,
   getConfigDefaults

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

@@ -21,7 +21,8 @@ import {
   getUseInputConfig,
   getInputConfigForCommand,
   convertYNToBoolean,
-  hasArchives
+  hasArchives,
+  getLibraryBasedCL
 } from '../../util.js';
 
 import { getSwitchLibraryComponentQuestions, getSwitchVersionComponentQuestions } from './helper.js';
@@ -31,6 +32,8 @@ import { arch } from 'os';
 
 export default async options => {
   const isLibraryBased =  getLibraryBased();
+  const isLibraryBasedCL = getLibraryBasedCL();
+
   const useInputConfig = getUseInputConfig();
 
   if (!isLibraryBased) {
@@ -53,11 +56,9 @@ addDebugLog("switchLibrary", "", "+");
 
   const currentDirectory = process.cwd();
   const componentDirectory = join (currentDirectory, "src", "components");
-
   const orgLib = getConfigDefaults();
 
-
-   // if we have choosen to use INPUT CONFIG FILE
+  // if we have choosen to use INPUT CONFIG FILE
   // process and no inputs
   if (useInputConfig) {
     const inputConfig = await getInputConfigForCommand("switchLib");
@@ -67,7 +68,12 @@ addDebugLog("switchLibrary", "", "+");
       newOrgLib = `${orgLib.organization}_${newLibraryName}`;
       version = inputConfig.libraryVersion;
       const isPermanent = inputConfig.isPermanent;
-      const permBuild = convertYNToBoolean(isPermanent);
+      let permBuild = convertYNToBoolean(isPermanent);
+
+      if (isLibraryBasedCL) {
+        // no -dev for PegaInfinity
+        permBuild = true;
+      }
 
       const hasArch = await hasArchives();
       if (hasArch) {
@@ -103,8 +109,7 @@ addDebugLog("switchLibrary", "", "+");
       okToContinue = !!(okToCont === 'Y' || okToCont === 'y' || okToCont === true || okToCont === 'true');
 
 
-    }
-    else {
+    } else {
 
       if (options.params.length >= 5) {
         inputOrgLib = options.params[3];
@@ -151,8 +156,7 @@ addDebugLog("switchLibrary", "", "+");
   const existingOrgLib = orgLib.currentOrgLib;
   let oldVersion = orgLib.buildVersion;
 
-
-  const switchToFileName = `${newOrgLib}_${newVersion}.zip`;
+  const switchToFileName = `${newOrgLib}_${newVersion}.arch.zip`;
 
   console.log("");
 

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

@@ -10,6 +10,7 @@ import {
   showVersion,
   getPegaServerConfig,
   getLibraryBased,
+  getLibraryBasedCL,
   addDebugLog,
   zipVersionAndArchive,
   restoreFromArchive,
@@ -32,8 +33,9 @@ import { showCurrentStatus } from '../show-status/index.js';
 
 export default async options => {
   const isLibraryBased =  getLibraryBased();
-  const useInputConfig = getUseInputConfig();
+  const isLibraryBasedCL = getLibraryBasedCL();
 
+  const useInputConfig = getUseInputConfig();
   if (!isLibraryBased) {
     console.log(`Command only supported for ${chalk.bold.green('library mode')} components.`);
     process.exit();
@@ -55,7 +57,8 @@ addDebugLog("switchVersion", "", "+");
   const componentDirectory = join (currentDirectory, "src", "components");
   const orgLib = getConfigDefaults();
 
- // if we have choosen to use INPUT CONFIG FILE
+
+   // if we have choosen to use INPUT CONFIG FILE
   // process and no inputs
   if (useInputConfig) {
     const inputConfig = await getInputConfigForCommand("switchLibVersion");
@@ -64,9 +67,12 @@ addDebugLog("switchVersion", "", "+");
     if (okToContinue) {
       version = inputConfig.libraryVersion;
       const isPermanent = inputConfig.isPermanent;
-      const permBuild = convertYNToBoolean(isPermanent);
-
+      let permBuild = convertYNToBoolean(isPermanent);
 
+      if (isLibraryBasedCL) {
+        // no -dev for PegaInfinity
+        permBuild = true;
+      }
 
       const hasArch = await hasArchives();
       const orgLib = getConfigDefaults();
@@ -121,7 +127,6 @@ addDebugLog("switchVersion", "", "+");
   }
 
 
-
   if (okToContinue) {
     // in this scenario, version contains "-dev", if appropriate
 
@@ -130,7 +135,7 @@ addDebugLog("switchVersion", "", "+");
     const existingOrgLib = orgLib.currentOrgLib;
     const oldVersion = orgLib.buildVersion;
 
-    const switchToFileName = `${existingOrgLib}_${newVersion}.zip`;
+    const switchToFileName = `${existingOrgLib}_${newVersion}.arch.zip`;
 
     console.log("");
 

package/src/tasks/validator/index.js

@@ -12,6 +12,7 @@ import {
   getComponentDirectoryPath,
   getComponents,
   getOOTBComponents,
+  isComponentValidLength,
   addDebugLog } from '../../util.js';
 
 const ajv = new Ajv({ allErrors: true });
@@ -315,7 +316,7 @@ const validateOverideSchema = ajv.compile(overrideSchema);
 
 
 export default async (option) => {
-  // addDebugLog("validate","", "");
+// addDebugLog("validate","", "");
 
   let componentToValidate = null;
   let throwTheError = false;
@@ -340,6 +341,10 @@ export default async (option) => {
     throwTheError = true;
   }
 
+  if (!isComponentValidLength(componentToValidate)) {
+    throw new Error(`Invalid: componentName is too long.`);
+  }
+
   const componentDirectory = await getComponentDirectoryPath(componentToValidate);
   let configFileName = "config.json";