@pega/custom-dx-components 0.242.19 → 0.242.21

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pega/custom-dx-components",
-  "version": "0.242.19",
+  "version": "0.242.21",
   "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.15",
+    "@pega/constellation-dx-components-build-utils": "^1.0.1-dev-0.16",
     "ajv": "^8.12.0",
     "ajv-keywords": "^5.1.0",
     "archiver": "^7.0.1",

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

@@ -4,6 +4,7 @@ import fs from 'fs';
 import inquirer from 'inquirer';
 import { Listr } from 'listr2';
 import chalk from 'chalk';
+
 import { buildLib } from '@pega/constellation-dx-components-build-utils/index.js';
 
 import validate from '../validator/index.js';
@@ -14,7 +15,8 @@ import {
   getComponents,
   getLibraryBased,
   getC11NB2STokenAndStaticServer,
-  updateComponentDefaultVersion
+  updateComponentDefaultVersion,
+  getAboutData
 } from '../../util.js';
 import bundleComponent from '../bundle/index.js';
 
@@ -22,7 +24,7 @@ import { getBuildComponentQuestions, getOrgLib } from './helper.js';
 
 const isLibraryBased = await getLibraryBased();
 
-export const updateConfigVersion = async (componentKey, buildVersion) => {
+export const updateConfigVersion = async (componentKey, buildVersion, currentOrgLib, token) => {
   const componentDirectory = await getComponentDirectoryPath(componentKey);
   const configFileName = 'config.json';
 
@@ -35,27 +37,68 @@ export const updateConfigVersion = async (componentKey, buildVersion) => {
     console.log(`${chalk.bold.yellow(`Config file not available for: ${componentKey}`)}`);
     return;
   }
+  const currentDate = new Date(Date.now());
+  const dateStamp = currentDate.toDateString();
+  const aboutData = await getAboutData(currentOrgLib, buildVersion, dateStamp);
 
   let data;
   try {
     data = JSON.parse(configData);
+
+    //find "About" and create or update
+    const properties = data.properties;
+    if (properties) {
+      let foundProp = null;
+
+      // check to see if PegaAboutData exists.  If customer decides to put
+      // data under PegaAboutData, we won't change the order
+      // otherise, will put at bottom
+      for (let i in properties) {
+        if (properties[i].name && properties[i].name === "PegaAboutData") {
+          foundProp = properties[i];
+          break;
+        }
+      }
+
+      if (foundProp) {
+        foundProp.label = aboutData;
+      }
+      else {
+        // don't have "About"
+        const aboutLabelJSON =  {
+          "format": "LABEL",
+          "label": "About",
+          "name": "PegaAboutLabel",
+          "variant": "h3"
+        };
+        const aboutDataJSON = {
+          "format": "LABEL",
+          "label": aboutData,
+          "name": "PegaAboutData",
+          "variant": "primary"
+        }
+        properties.push(aboutLabelJSON);
+        properties.push(aboutDataJSON);
+      }
+    }
   } catch (er) {
     throw new Error(`Invalid schema json in config.json: ${er}`);
   }
 
   data.version = buildVersion;
+  data.buildDate = dateStamp;
 
   // write back file
   fs.writeFileSync(configFile, JSON.stringify(data, null, 4), { encoding: 'utf8' });
 };
 
-export function getCustomTasks(componentKey, devBuild, buildVersion) {
+export function getCustomTasks(componentKey, devBuild, buildVersion, currentOrgLib, token) {
   return new Listr(
     [
       {
         title: 'Validate config schema',
         task: async () => {
-          await updateConfigVersion(componentKey, buildVersion);
+          await updateConfigVersion(componentKey, buildVersion, currentOrgLib, token);
           await validate(componentKey);
         },
         skip: () => componentKey === 'shared'
@@ -73,36 +116,11 @@ export function getCustomTasks(componentKey, devBuild, buildVersion) {
   );
 }
 
-export default async options => {
-  if (!isLibraryBased) {
-    console.log(`Command only supported for ${chalk.bold.green('library based')} components.`);
-    process.exit();
-  }
-
-  showVersion();
+export const localBuildLibrary = async(organization, library, version, devBuild) => {
 
   const components = await getComponents();
-
-  const compDef = await getOrgLib();
-  const organization = compDef.organization;
-  const library = compDef.library;
-  const currentOrgLib = organization.concat('_').concat(library);
-
-  let version;
-  let devBuild;
-
-  if (options.params.length >= 5) {
-    version = options.params[3];
-    const dBuild = options.params[4];
-    devBuild = !!(dBuild === 'Y' || dBuild === 'y' || dBuild === true || dBuild === 'true');
-  } else {
-    console.log(`\nLibrary ${chalk.bold.green(currentOrgLib)} `);
-    const questions = await getBuildComponentQuestions(compDef.version);
-    const answers = await inquirer.prompt(questions);
-    ({ version, devBuild } = answers);
-  }
-
   const tokenAndStaticServer = await getC11NB2STokenAndStaticServer();
+  const currentOrgLib = organization.concat('_').concat(library);
 
   if (tokenAndStaticServer.C11NB2S === undefined) {
     console.log(
@@ -123,7 +141,7 @@ export default async options => {
     console.log(chalk.bold.green(`Building ${componentKey}`));
 
     // eslint-disable-next-line sonarjs/no-extra-arguments
-    const myCustomTasks = getCustomTasks(componentKey, devBuild, buildVersion, options);
+    const myCustomTasks = getCustomTasks(componentKey, devBuild, buildVersion, currentOrgLib, tokenAndStaticServer.C11NB2S);
 
     try {
       await myCustomTasks.run();
@@ -154,5 +172,37 @@ export default async options => {
     tokenAndStaticServer.appStaticContentServer
   );
 
+}
+
+export default async options => {
+  if (!isLibraryBased) {
+    console.log(`Command only supported for ${chalk.bold.green('library based')} components.`);
+    process.exit();
+  }
+
+  showVersion();
+
+  const compDef = await getOrgLib();
+  const organization = compDef.organization;
+  const library = compDef.library;
+  const currentOrgLib = organization.concat('_').concat(library);
+
+  let version;
+  let devBuild;
+
+  if (options.params.length >= 5) {
+    version = options.params[3];
+    const dBuild = options.params[4];
+    devBuild = !!(dBuild === 'Y' || dBuild === 'y' || dBuild === true || dBuild === 'true');
+  } else {
+    console.log(`\nLibrary ${chalk.bold.green(currentOrgLib)} `);
+    const questions = await getBuildComponentQuestions(compDef.version);
+    const answers = await inquirer.prompt(questions);
+    ({ version, devBuild } = answers);
+  }
+
+  await localBuildLibrary(organization, library, version, devBuild);
+
+
   return true;
 };

package/src/tasks/create/index.js

@@ -96,10 +96,6 @@ const compileMustacheTemplates = async (
     allowedApplications = [].concat(allowedApplications);
   }
 
-  const orgLib = organization.concat("_").concat(library);
-  const componentLabelOrgLib = componentLabel.concat(` (${orgLib})`);
-  const desciptionOrgLib = description == null || description === "" ? componentLabelOrgLib : description.concat(` (${orgLib})`);
-
 
   allowedApplications = allowedApplications.filter(el => !!el.trim()).map(el => el.trim());
   files.forEach(file => {
@@ -108,7 +104,7 @@ const compileMustacheTemplates = async (
     const output = compileMustacheTemplate(filePath, {
       COMPONENT_KEY: componentKey,
       COMPONENT_NAME: componentName,
-      COMPONENT_LABEL: isLibraryBased ? componentLabelOrgLib : componentLabel,
+      COMPONENT_LABEL: componentLabel,
       COMPONENT_CLASS_NAME: componentClassName,
       ORGANIZATION: organization,
       VERSION: version,
@@ -116,7 +112,7 @@ const compileMustacheTemplates = async (
       ALLOWEDAPPS: JSON.stringify(allowedApplications),
       TYPE: type,
       SUB_TYPE: JSON.stringify(mustacheSubType),
-      DESCRIPTION: isLibraryBased ? desciptionOrgLib : description,
+      DESCRIPTION: description,
       IS_TEMPLATE: isTemplate,
       IS_PICKLIST: isPicklist,
       IS_BOOLEAN: isBool,

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

@@ -105,9 +105,6 @@ export const compileMustacheTemplates = async (
     allowedApplications = [].concat(allowedApplications);
   }
 
-  const orgLib = organization.concat("_").concat(library);
-  const componentLabelOrgLib = componentLabel.concat(` (${orgLib})`);
-  const desciptionOrgLib = description == null || description === "" ? componentLabelOrgLib : description.concat(` (${orgLib})`);
 
   allowedApplications = allowedApplications.filter((el) => !!el.trim()).map((el) => el.trim());
   files.forEach((file) => {
@@ -116,7 +113,7 @@ export const compileMustacheTemplates = async (
     const output = compileMustacheTemplate(filePath, {
       COMPONENT_KEY: componentKey,
       COMPONENT_NAME: componentName,
-      COMPONENT_LABEL: isLibraryBased ? componentLabelOrgLib : componentLabel,
+      COMPONENT_LABEL: componentLabel,
       COMPONENT_CLASS_NAME: componentClassName,
       ORGANIZATION: organization,
       VERSION: version,
@@ -124,7 +121,7 @@ export const compileMustacheTemplates = async (
       ALLOWEDAPPS: JSON.stringify(allowedApplications),
       TYPE: type,
       SUB_TYPE: JSON.stringify(mustacheSubType),
-      DESCRIPTION: isLibraryBased ? desciptionOrgLib : description,
+      DESCRIPTION: description,
       IS_TEMPLATE: isTemplate,
       IS_PICKLIST: isPicklist,
       IS_BOOLEAN: isBool,

package/src/tasks/delete/helper.js

@@ -140,9 +140,25 @@ export const deleteServerComponents = async (sourceOfComponents, answers) => {
     ({library, organization} = lpAnswers);
   }
 
-  const spinner = ora('Fetching components from server').start();
-  const data = await getComponentsFromServer(library, organization);
-  spinner.stop();
+  let spinner;
+  let data;
+  try {
+    spinner = ora('Fetching components from server').start();
+    data = await getComponentsFromServer(library, organization);
+    spinner.stop();
+  }
+  catch (error) {
+    spinner.stop();
+    if (error.indexOf("ECONNREFUSED") >= 0) {
+      console.log(`\n${chalk.bold.red('Error occurred in authentication. Please regenerate using authenticate')}`);
+    }
+    else {
+      console.log(`${chalk.bold.red(error)}`);
+    }
+
+    // spinner.stop();
+    process.exit(1);
+  }
 
 
   let serverComponents;

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

@@ -10,23 +10,24 @@
     "authenticate": "custom-dx-components authenticate",
     "buildComponent": "custom-dx-components buildComponent",
     "buildAllComponents": "custom-dx-components buildAllComponents",
-    "buildLibrary": "custom-dx-components buildLibrary",
     "create": "custom-dx-components create",
     "createAll": "custom-dx-components createAll",
     "publish": "custom-dx-components publish",
     "publishAll": "custom-dx-components publishAll",
-    "publishLibrary": "custom-dx-components publishLibrary",
     "rename": "custom-dx-components rename",
-    "renameLibrary": "custom-dx-components renameLibrary",
     "list": "custom-dx-components list",
-    "listLibrary": "custom-dx-components listLibrary",
     "validate-schema": "custom-dx-components validateSchema",
     "update": "custom-dx-components update",
     "delete": "custom-dx-components delete",
     "deleteAll": "custom-dx-components deleteAll",
-    "deleteLibrary": "custom-dx-components deleteLibrary",
     "promoteWebPack": "custom-dx-components promoteWebPack",
     "revertWebPack": "custom-dx-components revertWebPack",
+    "_library_comments": "library based commands",
+    "buildLibrary": "custom-dx-components buildLibrary",
+    "publishLibrary": "custom-dx-components publishLibrary",
+    "renameLibrary": "custom-dx-components renameLibrary",
+    "listLibrary": "custom-dx-components listLibrary",
+    "deleteLibrary": "custom-dx-components deleteLibrary",
     "_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",
@@ -80,7 +81,7 @@
   },
   "devDependencies": {
     "@pega/configs": "^0.6.0",
-    "@pega/custom-dx-components": "0.242.19",
+    "@pega/custom-dx-components": "0.242.21",
     "@pega/pcore-pconnect-typedefs": "~3.0.0",
     "@storybook/addon-actions": "^7.6.7",
     "@storybook/addon-essentials": "^7.6.19",
@@ -110,6 +111,7 @@
     "jest": "^29.7.0",
     "jest-environment-jsdom": "^29.7.0",
     "jest-junit": "^16.0.0",
+    "jwt-decode": "^4.0.0",
     "npm-run-all": "^4.1.5",
     "prettier": "3.1.1",
     "storybook": "^7.6.19",

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

@@ -95,14 +95,21 @@ export default async (options) => {
         let data = await getLocalLibraryVersionData(libraryName, selectedVersion);
         data = JSON.parse(data);
 
-        let libData = data.map((component) => ( {'Component': component.name, 'Version': component.version, 'Type': component.type, 'Sub Type' : component.subtype}));
-        console.log(chalk.bold.blueBright(`\nList of ${libraryName}:${selectedVersion} components`));
-        console.table(libData, ['Component', 'Version', 'Type', 'Sub Type']);
+        // get built on from first component if exists
+        let builtOn = "(date unavailable)";
+        if (data[0] && data[0].buildDate) {
+          builtOn = data[0].buildDate;
+        }
+
+        let libData = data.map((component) => ( {'Component': component.name, 'Label': component.label, 'Version': component.version, 'Type': component.type, 'Sub Type' : component.subtype}));
+        console.log(chalk.bold.blueBright(`\nList of ${libraryName}:${selectedVersion} components built on ${builtOn}.`));
+        console.table(libData, ['Component', 'Label', 'Version', 'Type', 'Sub Type']);
 
     }
     else {
       // No library with that name
       console.log(chalk.redBright(`No local library named: ${libraryName} exists.`));
+      console.log(chalk.redBright(`You need to build library: ${libraryName} first.`));
       process.exit(1);
 
     }
@@ -128,14 +135,21 @@ export default async (options) => {
       const versionData = libVersions[selectedVersion];
       const data = JSON.parse(versionData);
 
-      let libData = data.map((component) => ( {'Component': component.name, 'Version': component.version, 'Type': component.type, 'Sub Type' : component.subtype}));
-      console.log(chalk.bold.blueBright(`\nList of ${libraryName}:${selectedVersion} components`));
-      console.table(libData, ['Component', 'Version', 'Type', 'Sub Type']);
+      // get built on from first component if exists
+      let builtOn = "(date unavailable)";
+      if (data[0] && data[0].buildDate) {
+        builtOn = data[0].buildDate;
+      }
+
+      let libData = data.map((component) => ( {'Component': component.name, 'Label': component.label, 'Version': component.version, 'Type': component.type, 'Sub Type' : component.subtype}));
+      console.log(chalk.bold.blueBright(`\nList of ${libraryName}:${selectedVersion} components built on ${builtOn}.`));
+      console.table(libData, ['Component', 'Label', 'Version', 'Type', 'Sub Type']);
 
     }
     else {
       // No library with that name
-      console.log(chalk.redBright(`No local library named: ${libraryName} exists.`));
+      console.log(chalk.redBright(`No server library named: ${libraryName} exists.`));
+      console.log(chalk.redBright(`You need to build library: ${libraryName} and publish this library.`));
       process.exit(1);
 
     }

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

@@ -221,7 +221,8 @@ export default async (options) => {
 
   }
   else {
-    console.log(chalk.bold.redBright(`No library versions in ${libraryName}`));
+    console.log(chalk.bold.redBright(`No library versions named ${libraryName}.`));
+    console.log(chalk.bold.redBright(`You need to build library ${libraryName} first.`));
   }