@pega/custom-dx-components 0.242.20 → 0.242.21

package/package.json

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

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/init/template/package.json.mustache

@@ -81,7 +81,7 @@
   },
   "devDependencies": {
     "@pega/configs": "^0.6.0",
-    "@pega/custom-dx-components": "0.242.20",
+    "@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",
@@ -111,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.`));
   }
 
 

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

@@ -7,10 +7,25 @@ import inquirer from 'inquirer';
 import ncp from 'ncp';
 import chalk from 'chalk';
 
-import { checkPathAccess, showVersion, getComponentsObj, getDirectoryFiles, getPegaServerConfig, getLibraryBased, deleteLocalLibrary, getC11NB2STokenAndStaticServer, updateComponentDefaultLibrary, updateDefaultOrganization } from '../../util.js';
-import { TASKS_CONFIG_JSON_FILENAME, COMPONENTS_DIRECTORY_PATH, COMPONENTS_PATH } from '../../constants.js';
+import {
+  checkPathAccess,
+  showVersion,
+  getComponentsObj,
+  getDirectoryFiles,
+  getPegaServerConfig,
+  getLibraryBased,
+  deleteLocalLibrary,
+  getC11NB2STokenAndStaticServer,
+  updateComponentDefaultLibrary,
+  updateDefaultOrganization
+} from '../../util.js';
+import {
+  TASKS_CONFIG_JSON_FILENAME,
+  COMPONENTS_DIRECTORY_PATH,
+  COMPONENTS_PATH
+} from '../../constants.js';
 
-import { buildLib } from '@pega/constellation-dx-components-build-utils/index.js';
+import { localBuildLibrary } from '@pega/custom-dx-components/src/tasks/build-lib/index.js';
 
 export const DXCB_CONFIG_INTERNAL_JSON_FILENAME = 'src/dxcb.config.json';
 const currentDirectory = process.cwd();
@@ -18,20 +33,18 @@ const pegaConfigJsonPath = join(currentDirectory, TASKS_CONFIG_JSON_FILENAME);
 
 const isLibraryBased = await getLibraryBased();
 
-
 import {
   convertIntoPascalCase,
   getComponentDirectoryPath,
   getPegaConfig,
   getComponentDefaults,
   getComponents,
+  getAboutData,
   sanitize
 } from '../../util.js';
 
-
 const copy = promisify(ncp);
 
-
 export const getOrgLib = async () => {
   const defaultPegaConfig = await getPegaServerConfig();
 
@@ -41,7 +54,9 @@ export const getOrgLib = async () => {
   data = data && JSON.parse(data);
 
   if (!data[COMPONENTS_DIRECTORY_PATH]) {
-    console.error(`${chalk.red.bold('ERROR')} Could not able find components directory path in config.json`);
+    console.error(
+      `${chalk.red.bold('ERROR')} Could not able find components directory path in config.json`
+    );
     process.exit(1);
   }
 
@@ -56,7 +71,7 @@ export const getOrgLib = async () => {
   componentDefaults.organization = organization;
 
   return componentDefaults;
-}
+};
 
 export const updateConfig = async (
   {
@@ -69,13 +84,12 @@ export const updateConfig = async (
     version,
     description,
     allowedApplications,
-    targetDirectory,
+    targetDirectory
   },
   options,
   onlyCompanion = false
 ) => {
-
-  let configData = fs.readFileSync(join(targetDirectory, "/config.json"), { encoding: 'utf8' });
+  let configData = fs.readFileSync(join(targetDirectory, '/config.json'), { encoding: 'utf8' });
   configData = configData && JSON.parse(configData);
 
   configData.name = newComponentKey;
@@ -84,34 +98,32 @@ export const updateConfig = async (
   if (configData.componentKey) configData.componentKey = newComponentKey;
   configData.library = library;
   configData.version = version;
-  configData.description = (description != '') ? description : componentLabel;
+  configData.description = description != '' ? description : componentLabel;
 
   configData.allowedApplications = allowedApplications;
 
   // stringify "4", makes the json string look like JSON in the file, formated instead of a single line
-  fs.writeFileSync(join(targetDirectory, "/config.json"), JSON.stringify(configData, null, 4), { encoding: 'utf8' });
-
+  fs.writeFileSync(join(targetDirectory, '/config.json'), JSON.stringify(configData, null, 4), {
+    encoding: 'utf8'
+  });
 };
 
 export const updateFile = async (
-    fileName,
-    oldComponentKeyPC,
-    newComponentKeyPC,
-    targetDirectory,
+  fileName,
+  oldComponentKeyPC,
+  newComponentKeyPC,
+  targetDirectory
 ) => {
-
-  let fileData = fs.readFileSync(join(targetDirectory, "/", fileName), { encoding: 'utf8' });
+  let fileData = fs.readFileSync(join(targetDirectory, '/', fileName), { encoding: 'utf8' });
 
   if (fileData.indexOf(oldComponentKeyPC) >= 0) {
     fileData = fileData.replaceAll(oldComponentKeyPC, newComponentKeyPC);
 
-    fs.writeFileSync(join(targetDirectory, "/", fileName), fileData, { encoding: 'utf8' });
+    fs.writeFileSync(join(targetDirectory, '/', fileName), fileData, { encoding: 'utf8' });
   }
-
 };
 
-export const renameLibrary = async ({library, organization}, options) => {
-
+export const renameLibrary = async ({ library, organization }, options) => {
   const compDef = await getOrgLib();
   const currentOrganization = compDef.organization;
   const currentLibrary = compDef.library;
@@ -122,53 +134,60 @@ export const renameLibrary = async ({library, organization}, options) => {
   const tokenAndStaticServer = await getC11NB2STokenAndStaticServer();
 
   if (tokenAndStaticServer.C11NB2S === undefined) {
-    console.log(chalk.redBright("Need to authenticate, missing services token.\nBuilding a library requires authentication to acquire a token to build."));
+    console.log(
+      chalk.redBright(
+        'Need to authenticate, missing services token.\nBuilding a library requires authentication to acquire a token to build.'
+      )
+    );
     process.exit(1);
-
   }
 
-  const currentOrgLib = currentOrganization.concat("_").concat(currentLibrary);
-  const newOrgLib = organization.concat("_").concat(library);
+  const currentOrgLib = currentOrganization.concat('_').concat(currentLibrary);
+  const newOrgLib = organization.concat('_').concat(library);
 
   // reaname all the components
   const components = await getComponents();
 
-
-
+  let wasDevBuild = false;
 
   for (const index in components) {
     const componentKey = components[index];
     const componentName = componentKey.split('_')[2];
     const currentDirectory = await getComponentDirectoryPath(componentKey);
 
-    let configData = fs.readFileSync(join(currentDirectory, "/config.json"), { encoding: 'utf8' });
+    let configData = fs.readFileSync(join(currentDirectory, '/config.json'), { encoding: 'utf8' });
     configData = configData && JSON.parse(configData);
 
-    const componentLabel = configData.label.substring(0, configData.label.indexOf("(")).concat(`(${newOrgLib})`);
-    const description = configData.description.substring(0, configData.description.indexOf("(")).concat(`(${newOrgLib})`);
+    const componentLabel = configData.label;
+    const description = configData.description;
     const version = configData.version;
     compVersion = version;
 
     // can only rename "devBuilds", so if version doesn't have "-dev", add it and will create dev version
-    if (compVersion && compVersion.indexOf("-dev") === -1){
-      compVersion = compVersion.concat("-dev");
+    if (compVersion && compVersion.indexOf('-dev') != -1) {
+      wasDevBuild = true;
     }
     const allowedApplications = configData.allowedApplications;
 
-    await renameComponent({library, organization, componentKey, componentName, componentLabel,
-      version, description, allowedApplications}, options);
-
-
-
+    await renameComponent(
+      {
+        library,
+        organization,
+        componentKey,
+        componentName,
+        componentLabel,
+        version,
+        description,
+        allowedApplications
+      },
+      options
+    );
   }
 
-
   // delete and rebuild library
   try {
     await deleteLocalLibrary(currentOrgLib);
-  }
-  catch (ex) {}
-
+  } catch (ex) {}
 
   // update config
   await updateComponentDefaultLibrary(library);
@@ -177,16 +196,10 @@ export const renameLibrary = async ({library, organization}, options) => {
   // call constellation-dx-components-build-utils build library, which will create a directory of the "buildLibName"
   // with subdirectories for each version.
   // If "buildDev", we append to version "-dev".  Currently, only "-dev" versions, when published, can be deleted.
-  if(newOrgLib && compVersion) {
-    buildLib(newOrgLib, compVersion, tokenAndStaticServer.C11NB2S, tokenAndStaticServer.appStaticContentServer);
+  if (newOrgLib && compVersion) {
+    localBuildLibrary(organization, library, currentVersion, wasDevBuild);
   }
-
-
-
-
-
-}
-
+};
 
 export const renameComponent = async (
   {
@@ -202,8 +215,6 @@ export const renameComponent = async (
   options,
   onlyCompanion = false
 ) => {
-
-
   let pegaConfig = await getPegaConfig();
 
   const newComponentKey = `${organization}_${library}_${componentName}`;
@@ -215,14 +226,11 @@ export const renameComponent = async (
   const currentDirectory = await getComponentDirectoryPath(componentKey);
   const targetDirectory = await getComponentDirectoryPath(newComponentKey);
 
-
-
-
   // custom component
   try {
     fs.renameSync(currentDirectory, targetDirectory);
-  } catch(err) {
-    console.log(err)
+  } catch (err) {
+    console.log(err);
   }
 
   const targetFileList = await getDirectoryFiles(targetDirectory);
@@ -230,7 +238,7 @@ export const renameComponent = async (
   for (var fileIndex in targetFileList) {
     const fileName = targetFileList[fileIndex];
 
-    if (fileName === "config.json") {
+    if (fileName === 'config.json') {
       await updateConfig(
         {
           oldComponentKey,
@@ -242,34 +250,21 @@ export const renameComponent = async (
           description,
           allowedApplications,
           organization,
-          targetDirectory,
+          targetDirectory
         },
         options
       );
+    } else {
+      await updateFile(fileName, oldComponentKeyPC, newComponentKeyPC, targetDirectory);
     }
-    else {
-      await updateFile(
-          fileName,
-          oldComponentKeyPC,
-          newComponentKeyPC,
-          targetDirectory );
-
-    }
-
   } // for
 
-
   console.log(chalk.green(`Component ${oldComponentKey} renamed to ${newComponentKey}`));
-
 };
 
-
-
-
-
 export default async options => {
   if (!isLibraryBased) {
-    console.log(`Command only supported for ${chalk.bold.green('library based')} components.`)
+    console.log(`Command only supported for ${chalk.bold.green('library based')} components.`);
     process.exit();
   }
 
@@ -297,12 +292,10 @@ export default async options => {
 
   const localComponents = await getComponentsObj();
 
-
   if (options.params.length >= 5) {
     const organization = options.params[3];
     const library = options.params[4];
 
-
     await renameLibrary(
       {
         library,
@@ -310,9 +303,7 @@ export default async options => {
       },
       options
     );
-
-  }
-  else {
+  } else {
     const questions = [
       {
         name: 'organization',
@@ -344,10 +335,7 @@ export default async options => {
     ];
 
     await inquirer.prompt(questions).then(async answers => {
-      const {
-        organization,
-        library
-      } = answers;
+      const { organization, library } = answers;
 
       await renameLibrary(
         {
@@ -356,10 +344,6 @@ export default async options => {
         },
         options
       );
-
     });
   }
-
-
-
 };