@pega/custom-dx-components 0.242.26 → 0.242.28

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pega/custom-dx-components",
-  "version": "0.242.26",
+  "version": "0.242.28",
   "description": "Utility for building custom UI components",
   "bin": "./bin/index.js",
   "scripts": {
@@ -56,6 +56,7 @@
     "terser-webpack-plugin": "5.3.10",
     "ts-loader": "^9.5.1",
     "typescript": "~5.2.2",
+    "unarchive": "^1.1.3",
     "url-loader": "4.1.1",
     "webpack": "5.89.0"
   },

package/src/cli.js

@@ -8,12 +8,18 @@ import {
   buildLibrary,
   createComponent,
   createAllComponents,
+  createLibrary,
+  switchLibrary,
+  createVersion,
+  switchVersion,
   deleteComponent,
   deleteAllComponents,
   deleteLibrary,
+  deletePublished,
   initProject,
   listComponents,
   listLibrary,
+  listPublished,
   publishComponent,
   publishAllComponents,
   publishLibrary,
@@ -21,6 +27,7 @@ import {
   renameLibrary,
   revertWebPack,
   promoteWebPack,
+  showStatus,
   updateComponent,
   validate,
   upgrade,
@@ -31,6 +38,10 @@ const TASKS = {
   INIT: 'init',
   CREATE: 'create',
   CREATE_ALL: 'createAll',
+  CREATE_LIB: 'createLibrary',
+  SWITCH_LIB: 'switchLibrary',
+  CREATE_VERSION: 'createVersion',
+  SWITCH_VERSION: 'switchVersion',
   BUILD: 'buildComponent',
   BUILD_ALL: 'buildAllComponents',
   BUILD_LIB: 'buildLibrary',
@@ -43,11 +54,14 @@ const TASKS = {
   RENAME_LIB: 'renameLibrary',
   LIST: 'list',
   LIST_LIB: 'listLibrary',
+  LIST_PUB: 'listPublished',
+  SHOW_STATUS: 'showStatus',
   VALIDATE_SCHEMA: 'validateSchema',
   UPDATE: 'update',
   DELETE: 'delete',
-  DELETE_ALL: "deleteAll",
-  DELETE_LIBRARY: "deleteLibrary",
+  DELETE_ALL: 'deleteAll',
+  DELETE_LIBRARY: 'deleteLibrary',
+  DELETE_PUB: 'deletePublished',
   AUTHENTICATE: 'authenticate',
   UPGRADE: 'upgrade',
   BUILD_JEST_ASSETS: 'buildJestAssets'
@@ -88,6 +102,22 @@ export default async (args = []) => {
       createAllComponents(options);
       break;
     }
+    case TASKS.CREATE_LIB: {
+      createLibrary(options);
+      break;
+    }
+    case TASKS.SWITCH_LIB: {
+      switchLibrary(options);
+      break;
+    }
+    case TASKS.CREATE_VERSION: {
+      createVersion(options);
+      break;
+    }
+    case TASKS.SWITCH_VERSION: {
+      switchVersion(options);
+      break;
+    }
     case TASKS.PROMOTE_WEBPACK: {
       promoteWebPack(options);
       break;
@@ -136,6 +166,14 @@ export default async (args = []) => {
       listLibrary(options);
       break;
     }
+    case TASKS.LIST_PUB: {
+      listPublished(options);
+      break;
+    }
+    case TASKS.SHOW_STATUS: {
+      showStatus(options);
+      break;
+    }
     case TASKS.VALIDATE_SCHEMA: {
       validate(options);
       break;
@@ -156,6 +194,10 @@ export default async (args = []) => {
       deleteLibrary(options);
       break;
     }
+    case TASKS.DELETE_PUB: {
+      deletePublished(options);
+      break;
+    }
     case TASKS.AUTHENTICATE: {
       authenticate(options);
       break;

package/src/constants.js

@@ -12,6 +12,8 @@ export const OOTB_COMPONENTS = 'node_modules/@pega/custom-dx-components/.ootb_co
 export const LIBRARY_BASED = 'libraryBased';
 export const SHARED_DIRECTORY = 'shared';
 export const SHOW_DEBUG = 'showDebug';
+export const ARCHIVES_PATH = 'archives';
+export const COMPONENTS_CONFIG_FILE_NAME = 'componentsconfig.json';
 
 /* REST end points */
 export const PUBLISH_COMPONENT_SERVICE_REST_ENDPOINT = 'PRRestService/dev/v1/publish_component';

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

@@ -15,7 +15,7 @@ addDebugLog("getBuildComponentQuestions", "", "");
 
   if (components.length == 0) {
     console.log(chalk.redBright('No components to build'));
-    process.exit(1);
+    process.exit();
   }
 
   return [

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

@@ -5,7 +5,16 @@ import chalk from 'chalk';
 import validate from '../validator/index.js';
 import bundleComponent from '../bundle/index.js';
 import { lintComponent } from '../linter/index.js';
-import { getComponentDirectoryPath, showVersion, getComponents, addDebugLog, cleanUp, getLibraryBased } from '../../util.js';
+import {
+  getComponentDirectoryPath,
+  showVersion,
+  getComponents,
+  addDebugLog,
+  cleanUp,
+  getLibraryBased,
+  checkLibraryAndArchives,
+  getConfigDefaults,
+  zipVersionAndArchive } from '../../util.js';
 
 import { getBuildComponentQuestions } from './helper.js';
 
@@ -42,8 +51,9 @@ addDebugLog("getCustomTasks", `componentKey: ${componentKey}, sourceMap: ${sourc
 
 export default async options => {
   await showVersion();
+  await checkLibraryAndArchives();
 
-  const isLibraryBased = await getLibraryBased();
+  const isLibraryBased = getLibraryBased();
 
 addDebugLog("buildAllComponents", "", "+");
   const components = await getComponents();
@@ -91,10 +101,14 @@ addDebugLog("buildAllComponents", "", "+");
   // if skipBuild, then do a build here as opposed to every step (v1 is every step, v2, just once)
   if (skipBuild && firstComponent) {
     console.log();
-    console.log(chalk.bold.green("Test compile..."));
+    console.log(chalk.bold.green("Validation compile..."));
     await bundleComponent(firstComponent, sourceMap, devBuild, showStats);
+    const confDef = getConfigDefaults();
+    await zipVersionAndArchive(confDef.currentOrgLib, confDef.buildVersion);
   }
 
+
+
   // once done, remove leftover directories
   await cleanUp();
 

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

@@ -15,23 +15,26 @@ 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 components = await getComponents();
 
   if (components.length === 0) {
-    console.log(chalk.redBright('No components to build'));
+    console.log(chalk.redBright(`No components to ${buildLabel}`));
     process.exit();
   }
 
   const defaultPegaConfig = await getPegaServerConfig();
 
-  const isLibraryBased = await getLibraryBased();
-
   return [
     {
       name: 'componentKey',
       type: 'rawlist',
-      message: 'Select component to build',
+      message: `Select component to ${buildLabel}`,
       choices: components,
       default: componentKey,
       when: () => !componentKey

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

@@ -7,10 +7,20 @@ import validate from '../validator/index.js';
 import bundleComponent from '../bundle/index.js';
 import lintComponent from '../linter/index.js';
 import { getPublishComponentQuestions } from './helper.js';
-import { getComponentDirectoryPath, showVersion, addDebugLog, cleanUp, getLibraryBased } from '../../util.js';
+import {
+  getComponentDirectoryPath,
+  showVersion,
+  addDebugLog,
+  cleanUp,
+  getLibraryBased,
+  checkLibraryAndArchives,
+  getConfigDefaults,
+  zipVersionAndArchive } from '../../util.js';
+
 
 export default async options => {
   await showVersion();
+  await checkLibraryAndArchives();
 
 addDebugLog("buildComponent", "", "+");
 
@@ -43,7 +53,7 @@ addDebugLog("buildComponent", "", "+");
     const answers = await inquirer.prompt(questions);
     ({ componentKey = paramComponentKey, sourceMap, devBuild } = answers);
 
-    const isLibraryBased = await getLibraryBased();
+    const isLibraryBased =  getLibraryBased();
 
     if (isLibraryBased) {
       devBuild = false;
@@ -91,6 +101,9 @@ addDebugLog("buildComponent", "", "+");
     process.exit(1);
   });
 
+  const confDef = getConfigDefaults();
+  await zipVersionAndArchive(confDef.currentOrgLib, confDef.buildVersion);
+
   // remove dist/lib stuff
   await cleanUp();
 

package/src/tasks/build-jest-assets/index.js

@@ -201,7 +201,7 @@ export default async options => {
   if (buildAssets) {
     // get current server type
     const savedServerType = await getServerType();
-    const savedLibraryBased = await getLibraryBased();
+    const savedLibraryBased = getLibraryBased();
 
     await setLibraryBased(false);
 

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

@@ -5,51 +5,19 @@ import chalk from 'chalk';
 import {
   getComponents,
   getPegaServerConfig,
-  checkPathAccess,
-  getComponentDefaults,
   validateSemver,
   addDebugLog,
   getLibraryBased
 } from '../../util.js';
-import { TASKS_CONFIG_JSON_FILENAME, COMPONENTS_DIRECTORY_PATH, COMPONENTS_PATH } from '../../constants.js';
+import { TASKS_CONFIG_JSON_FILENAME } from '../../constants.js';
 
-const pegaConfigJsonPath = path.join(path.resolve(), TASKS_CONFIG_JSON_FILENAME);
-
-export const getOrgLib = async () => {
-addDebugLog("getOrgLib", "", "+");
-  const defaultPegaConfig = await getPegaServerConfig();
-
-  await checkPathAccess(pegaConfigJsonPath);
-
-  let data = fs.readFileSync(pegaConfigJsonPath, { encoding: 'utf8' });
-  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`);
-    process.exit(1);
-  }
-
-  const componentData = data[COMPONENTS_PATH];
-
-  let library;
-  ({ library } = componentData);
-  let { organization } = JSON.parse(fs.readFileSync(path.resolve('package.json'), 'utf8'));
-
-  const componentDefaults = await getComponentDefaults();
-  componentDefaults.library = library;
-  componentDefaults.organization = organization;
-addDebugLog("getOrgLib", `componentsDefaults: ${JSON.stringify(componentDefaults)}`, "");
-addDebugLog("getOrgLib", "END", "-");
-
-  return componentDefaults;
-}
 
 export const getBuildComponentQuestions = async (defaultVersion)  => {
 addDebugLog("getBuildComoponentQuestions", `defaultVerion: ${defaultVersion}`, "");
   const components = await getComponents();
   const defaultPegaConfig = await getPegaServerConfig();
 
-  const isLibraryBased = await getLibraryBased();
+  const isLibraryBased =  getLibraryBased();
 
 
   if (components.length == 0) {

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

@@ -1,5 +1,3 @@
-import path from 'path';
-import fs from 'fs';
 
 import inquirer from 'inquirer';
 import { Listr } from 'listr2';
@@ -13,87 +11,19 @@ import {
   getComponentDirectoryPath,
   showVersion,
   getComponents,
-  getLibraryBased,
   getC11NB2STokenAndStaticServer,
   updateComponentDefaultVersion,
-  getAboutData,
+  updateConfigVersion,
   addDebugLog,
-  cleanUp
+  cleanUp,
+  checkLibraryAndArchives,
+  getConfigDevBuild,
+  checkJWTExpiration,
+  getConfigDefaults
 } from '../../util.js';
 import bundleComponent from '../bundle/index.js';
 
-import { getBuildComponentQuestions, getOrgLib } from './helper.js';
-
-const isLibraryBased = await getLibraryBased();
-
-export const updateConfigVersion = async (componentKey, buildVersion, currentOrgLib, token) => {
-addDebugLog("updateConfigVersion", `componentKey: ${componentKey}, buildVersion: ${buildVersion}, currentOrgLib: ${currentOrgLib}`, "");
-  const componentDirectory = await getComponentDirectoryPath(componentKey);
-  const configFileName = 'config.json';
-
-  const configFile = path.join(componentDirectory, configFileName);
-  let configData;
-  try {
-    configData = fs.readFileSync(path.resolve(configFile), 'utf8');
-  } catch (err) {
-    // for now, if now file just end
-    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' });
-};
+import { getBuildComponentQuestions } from './helper.js';
 
 export function getCustomTasks(componentKey, devBuild, buildVersion, currentOrgLib, token) {
 addDebugLog("getCustomTasks", `componentKey: ${componentKey}, devBuild: ${devBuild}, buildVersion: ${buildVersion}, currentOrgLib: ${currentOrgLib}`,"");
@@ -135,12 +65,23 @@ addDebugLog("localBuildLibrary", `organization: ${organization}, library: ${libr
     process.exit(1);
   }
 
+  if (!components || components.length === 0) {
+    console.log(
+      chalk.redBright(
+        'No components to build/publish.'
+      )
+    );
+    process.exit(1);
+  }
+
   const buildLibName = organization.concat('_').concat(library);
 
   await updateComponentDefaultVersion(version);
 
   const buildVersion = devBuild && version.indexOf('-dev') < 0 ? version.concat('-dev') : version;
 
+
+
   for await (const componentKey of components) {
     console.log(chalk.bold.green(`Building ${componentKey}`));
 
@@ -179,23 +120,26 @@ addDebugLog("buildLib", "services call", "");
     tokenAndStaticServer.C11NB2S,
     tokenAndStaticServer.appStaticContentServer
   );
-addDebugLog("buildLIb", "services end", "");
+addDebugLog("buildLib", "services end", "");
 
 }
 
 export default async options => {
-  if (!isLibraryBased) {
-    console.log(`Command only supported for ${chalk.bold.green('library based')} components.`);
-    process.exit();
+
+  if (options.params.length != 4) {
+    // internal so already called
+    await showVersion();
+    await checkLibraryAndArchives();
+    await checkJWTExpiration();
   }
 
-  await showVersion();
 addDebugLog("buildLibrary", "", "+");
 
-  const compDef = await getOrgLib();
+  const compDef =  getConfigDefaults();
   const organization = compDef.organization;
   const library = compDef.library;
-  const currentOrgLib = organization.concat('_').concat(library);
+  // const currentOrgLib = organization.concat('_').concat(library);
+  const currentOrgLib = compDef.currentOrgLib;
 
   let version;
   let devBuild;
@@ -204,7 +148,14 @@ addDebugLog("buildLibrary", "", "+");
     version = options.params[3];
     const dBuild = options.params[4];
     devBuild = !!(dBuild === 'Y' || dBuild === 'y' || dBuild === true || dBuild === 'true');
-  } else {
+  }
+  else if (options.params.length === 4) {
+    // internally called from publish
+    const orgLib =  getConfigDefaults();
+    version = orgLib.version;
+    devBuild = await getConfigDevBuild();
+  }
+  else {
     console.log(`\nLibrary ${chalk.bold.green(currentOrgLib)} `);
     const questions = await getBuildComponentQuestions(compDef.version);
     const answers = await inquirer.prompt(questions);

package/src/tasks/create/index.js

@@ -12,7 +12,6 @@ import {
   compileMustacheTemplate,
   getComponentDirectoryPath,
   getComponents,
-  getComponentDefaults,
   getPegaServerConfig,
   sanitize,
   validateSemver,
@@ -21,7 +20,9 @@ import {
   updateComponentDefaultVersion,
   copyFileToShared,
   getLibraryBased,
-  addDebugLog
+  addDebugLog,
+  checkLibraryAndArchives,
+  getConfigDefaults
 } from '../../util.js';
 import { COMPONENT_SCHEMA, SHARED_FILE_NAMES } from '../../constants.js';
 
@@ -33,7 +34,7 @@ const copyComponentTemplate = async options => {
   });
 };
 
-let isLibraryBased = await getLibraryBased();
+const isLibraryBased =  getLibraryBased();
 
 const compileMustacheTemplates = async (
   componentDirectory,
@@ -183,19 +184,30 @@ const validateCompile = async (
     framework = "Constellation";
   }
 
-  isLibraryBased = await getLibraryBased();
+  const orgLib = getConfigDefaults();
+  if (isLibraryBased) {
+    // library comes from config
+    library = orgLib.library;
+  }
 
   // check of library or version has changed from default, if so, update componentDefaults
-  const componentDefaults = await getComponentDefaults();
-  if (componentDefaults.library == null || componentDefaults.library !== library) {
+  const defaultPegaServerConfig = await getPegaServerConfig();
+
+  // update defaults when changes
+  if (orgLib.library == null || orgLib.library !== library) {
     await updateComponentDefaultLibrary(library);
   }
-  if (componentDefaults.version == null || componentDefaults.version !== version) {
-    await updateComponentDefaultVersion(version);
-  }
 
+  // library based, get version from defaults
+  if (isLibraryBased) {
+    version = orgLib.buildVersion;
+  }
+  else {
+    if (orgLib.version == null || orgLib.version !== version) {
+      await updateComponentDefaultVersion(version);
+    }
+  }
 
-  const defaultPegaServerConfig = await getPegaServerConfig();
   const isLaunchpad = defaultPegaServerConfig.serverType === 'launchpad';
   let originalFramework = framework;
 
@@ -219,15 +231,10 @@ const validateCompile = async (
 
   }
 
-
-
-
   if (organization == null) {
    ({ organization } = JSON.parse(fs.readFileSync(path.resolve('package.json'), 'utf8')));
   }
 
-
-
   const componentKey = `${organization}_${library}_${componentName}`;
   const targetDirectory = await getComponentDirectoryPath(componentKey);
 
@@ -261,6 +268,8 @@ const validateCompile = async (
 export default async options => {
   await showVersion();
 
+  await checkLibraryAndArchives();
+
 
 addDebugLog("create", "", "+");
 
@@ -293,7 +302,7 @@ addDebugLog("create", "", "+");
       options
     );
   } else {
-    const componentDefaults = await getComponentDefaults();
+    const componentDefaults = getConfigDefaults();
     const questions = [
       {
         name: 'type',
@@ -351,7 +360,7 @@ addDebugLog("create", "", "+");
           if (value && !/^\d/.test(value) && value === sanitize(value)) {
             return true;
           }
-          return 'Only alphanumeric values are allowed, starting with alphabets';
+          return 'Only alphanumeric values are allowed, starting with alphabets, no spaces.';
         }
       },
       {
@@ -373,7 +382,8 @@ addDebugLog("create", "", "+");
             return true;
           }
           return 'Please provide semver compatible version e.g 0.0.1';
-        }
+        },
+        when: () => !isLibraryBased
       },
       {
         name: 'library',
@@ -389,7 +399,9 @@ addDebugLog("create", "", "+");
             return true;
           }
           return 'Only alphanumeric values are allowed, starting with alphabets';
-        }
+        },
+        when: () => !isLibraryBased
+
       },
       {
         name: 'allowedApplications',