@pega/custom-dx-components 0.242.22 → 0.242.24

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pega/custom-dx-components",
-  "version": "0.242.22",
+  "version": "0.242.24",
   "description": "Utility for building custom UI components",
   "bin": "./bin/index.js",
   "scripts": {
@@ -36,6 +36,7 @@
     "fs-extra": "^11.2.0",
     "gitignore": "^0.7.0",
     "inquirer": "^9.2.12",
+    "jwt-decode": "^4.0.0",
     "listr2": "^8.0.1",
     "mini-css-extract-plugin": "2.7.6",
     "mustache": "^4.2.0",
@@ -74,7 +75,6 @@
     "jest": "^29.7.0",
     "jest-environment-jsdom": "^29.7.0",
     "jest-junit": "^16.0.0",
-    "jwt-decode": "^4.0.0",
     "prettier": "3.1.1",
     "ts-jest": "^29.1.1"
   }

package/src/constants.js

@@ -11,6 +11,7 @@ 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 SHARED_DIRECTORY = 'shared';
+export const SHOW_DEBUG = 'showDebug';
 
 /* REST end points */
 export const PUBLISH_COMPONENT_SERVICE_REST_ENDPOINT = 'PRRestService/dev/v1/publish_component';

package/src/tasks/authenticate/index.js

@@ -156,7 +156,7 @@ const generateAccessToken = async config => {
 export default async options => {
   let authOK = false;
 
-  showVersion();
+  await showVersion();
 
   await checkPathAccess(pegaConfigJsonPath);
 

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

@@ -4,27 +4,12 @@ import path from 'path';
 import archiver from 'archiver';
 import chalk from 'chalk';
 
-import { getComponentDirectoryPath, getComponents, getPegaServerConfig } from '../../util.js';
-
-export const cleanUp = async () => {
-  if (fs.existsSync('dist/components')) {
-    fs.rm('dist/components', { recursive: true }, err => {
-      if (err) {
-        throw err;
-      }
-    });
-  }
+import { getComponentDirectoryPath, getComponents, getPegaServerConfig, addDebugLog } from '../../util.js';
 
-  if (fs.existsSync('lib')) {
-    fs.rm('lib', { recursive: true }, err => {
-      if (err) {
-        throw err;
-      }
-    });
-  }
-};
 
 export const getBuildComponentQuestions = async () => {
+addDebugLog("getBuildComponentQuestions", "", "");
+
   const components = await getComponents();
   const defaultPegaConfig = await getPegaServerConfig();
 
@@ -44,6 +29,8 @@ export const getBuildComponentQuestions = async () => {
 };
 
 export const zipComponent = async componentKey => {
+addDebugLog("zipComponent", `componentKey: ${componentKey}`, "");
+
   const srcDirectory = await getComponentDirectoryPath(componentKey);
   const buildDirectory = await path.join(path.resolve(), 'dist/components', componentKey);
   const configJson = `${srcDirectory}/config.json`;

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

@@ -5,11 +5,14 @@ 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 } from '../../util.js';
+import { getComponentDirectoryPath, showVersion, getComponents, addDebugLog, cleanUp, getLibraryBased } from '../../util.js';
 
-import { getBuildComponentQuestions, cleanUp } from './helper.js';
+import { getBuildComponentQuestions } from './helper.js';
+
+
+export function getCustomTasks(componentKey, sourceMap, devBuild, options, showStats, skipBuild) {
+addDebugLog("getCustomTasks", `componentKey: ${componentKey}, sourceMap: ${sourceMap}, devBuild: ${devBuild}, skipBuild: ${skipBuild}`, "");
 
-export function getCustomTasks(componentKey, sourceMap, devBuild, options) {
   const sDevBuild = devBuild ? '(dev build)' : '';
   return new Listr(
     [
@@ -29,8 +32,8 @@ export function getCustomTasks(componentKey, sourceMap, devBuild, options) {
       },
       {
         title: `Bundle component ${sDevBuild}`,
-        task: async () => bundleComponent(componentKey, sourceMap, devBuild),
-        skip: () => (options.skipBundle ? 'Skipped bundling component' : undefined)
+        task: async () => await bundleComponent(componentKey, sourceMap, devBuild, showStats),
+        enabled: () => !skipBuild
       }
     ],
     { concurrent: false, exitOnError: true }
@@ -38,25 +41,44 @@ export function getCustomTasks(componentKey, sourceMap, devBuild, options) {
 }
 
 export default async options => {
-  showVersion();
+  await showVersion();
+
+  const isLibraryBased = await getLibraryBased();
 
+addDebugLog("buildAllComponents", "", "+");
   const components = await getComponents();
   let sourceMap;
   let devBuild;
+  let showStats = false;
+  let skipBuild = true;
+  let firstComponent = null;
 
   if (options.params.length >= 4) {
     const dBuild = options.params[3];
     devBuild = !!(dBuild === 'Y' || dBuild === 'y' || dBuild === true || dBuild === 'true');
   } else {
-    const questions = await getBuildComponentQuestions();
-    const answers = await inquirer.prompt(questions);
-    ({ sourceMap, devBuild } = answers);
+    if (!isLibraryBased) {
+      const questions = await getBuildComponentQuestions();
+      const answers = await inquirer.prompt(questions);
+      ({ sourceMap, devBuild } = answers);
+      showStats = true;
+      skipBuild = false;
+    }
+    else {
+      devBuild = false;
+    }
+
   }
 
   for await (const componentKey of components) {
     console.log(chalk.bold.green(`Building ${componentKey}`));
 
-    const myCustomTasks = getCustomTasks(componentKey, sourceMap, devBuild, options);
+    // capture first component
+    if (firstComponent == null) {
+      firstComponent = componentKey;
+    }
+
+    const myCustomTasks = getCustomTasks(componentKey, sourceMap, devBuild, options, showStats, skipBuild);
 
     try {
       await myCustomTasks.run();
@@ -66,8 +88,19 @@ export default async options => {
     }
   }
 
+  // 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..."));
+    await bundleComponent(firstComponent, sourceMap, devBuild, showStats);
+  }
+
   // once done, remove leftover directories
   await cleanUp();
 
+  console.log();
+  console.log(chalk.bold.green("Done."));
+
+addDebugLog("buildAllComponents", "END", "-");
   return true;
 };

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

@@ -10,7 +10,8 @@ import {
   getComponentDirectoryPath,
   getComponents,
   getPegaServerConfig,
-  getHttpsAgent
+  getHttpsAgent,
+  getLibraryBased
 } from '../../util.js';
 import { PUBLISH_COMPONENT_SERVICE_REST_ENDPOINT, TOKEN_PATH } from '../../constants.js';
 
@@ -24,6 +25,8 @@ export const getPublishComponentQuestions = async componentKey => {
 
   const defaultPegaConfig = await getPegaServerConfig();
 
+  const isLibraryBased = await getLibraryBased();
+
   return [
     {
       name: 'componentKey',
@@ -44,7 +47,8 @@ export const getPublishComponentQuestions = async componentKey => {
       name: 'devBuild',
       type: 'confirm',
       message: 'Generate development build ?',
-      default: defaultPegaConfig.devBuild
+      default: defaultPegaConfig.devBuild,
+      when: () => !isLibraryBased
     }
   ];
 };

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

@@ -7,15 +7,18 @@ 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 } from '../../util.js';
+import { getComponentDirectoryPath, showVersion, addDebugLog, cleanUp, getLibraryBased } from '../../util.js';
 
 export default async options => {
-  showVersion();
+  await showVersion();
+
+addDebugLog("buildComponent", "", "+");
 
   let componentKey;
   let sourceMap;
   let devBuild;
   let content;
+  let showStats = true;
 
   if (options.params.length >= 6) {
     componentKey = options.params[3];
@@ -40,6 +43,13 @@ export default async options => {
     const answers = await inquirer.prompt(questions);
     ({ componentKey = paramComponentKey, sourceMap, devBuild } = answers);
 
+    const isLibraryBased = await getLibraryBased();
+
+    if (isLibraryBased) {
+      devBuild = false;
+      showStats = false;
+    }
+
     content = {
       ...answers
     };
@@ -67,7 +77,7 @@ export default async options => {
       {
         title: `Bundle Component ${sDevBuild}`,
         type: 'confirm',
-        task: async () => await bundleComponent(componentKey, sourceMap, devBuild),
+        task: async () => await bundleComponent(componentKey, sourceMap, devBuild, showStats),
         skip: () => (options.skipBundle ? 'Skipped bundling component' : undefined)
       }
     ],
@@ -80,5 +90,11 @@ export default async options => {
     console.log(chalk.bold.red(err.toString()));
     process.exit(1);
   });
+
+  // remove dist/lib stuff
+  await cleanUp();
+
+addDebugLog("buildComponent", "END", "-");
+
   return true;
 };

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

@@ -192,7 +192,7 @@ const createJestLibraryAssets = async(isLaunchPad = false) => {
 
 
 export default async options => {
-  showVersion();
+  await showVersion();
 
   const questions = await getBuildAssetsQuestions();
   const answers = await inquirer.prompt(questions);

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

@@ -7,13 +7,16 @@ import {
   getPegaServerConfig,
   checkPathAccess,
   getComponentDefaults,
-  validateSemver
+  validateSemver,
+  addDebugLog,
+  getLibraryBased
 } from '../../util.js';
 import { TASKS_CONFIG_JSON_FILENAME, COMPONENTS_DIRECTORY_PATH, COMPONENTS_PATH } 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);
@@ -35,14 +38,19 @@ export const getOrgLib = async () => {
   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();
+
 
   if (components.length == 0) {
     console.log(chalk.redBright("No components to build"));
@@ -64,7 +72,7 @@ export const getBuildComponentQuestions = async (defaultVersion)  => {
     {
       name: 'devBuild',
       type: 'confirm',
-      message: 'Generate development build ?',
+      message: 'When publish, make deletable ?',
       default: defaultPegaConfig.devBuild
     }
   ];

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

@@ -16,7 +16,9 @@ import {
   getLibraryBased,
   getC11NB2STokenAndStaticServer,
   updateComponentDefaultVersion,
-  getAboutData
+  getAboutData,
+  addDebugLog,
+  cleanUp
 } from '../../util.js';
 import bundleComponent from '../bundle/index.js';
 
@@ -25,6 +27,7 @@ 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';
 
@@ -93,6 +96,7 @@ export const updateConfigVersion = async (componentKey, buildVersion, currentOrg
 };
 
 export function getCustomTasks(componentKey, devBuild, buildVersion, currentOrgLib, token) {
+addDebugLog("getCustomTasks", `componentKey: ${componentKey}, devBuild: ${devBuild}, buildVersion: ${buildVersion}, currentOrgLib: ${currentOrgLib}`,"");
   return new Listr(
     [
       {
@@ -117,7 +121,7 @@ export function getCustomTasks(componentKey, devBuild, buildVersion, currentOrgL
 }
 
 export const localBuildLibrary = async(organization, library, version, devBuild) => {
-
+addDebugLog("localBuildLibrary", `organization: ${organization}, library: ${library}, version: ${version}, devBuild: ${devBuild}`, "");
   const components = await getComponents();
   const tokenAndStaticServer = await getC11NB2STokenAndStaticServer();
   const currentOrgLib = organization.concat('_').concat(library);
@@ -160,17 +164,22 @@ export const localBuildLibrary = async(organization, library, version, devBuild)
   await bundleComponent(components[0], null, devBuild, false);
   console.log('');
 
+  // remove dist/lib stuff
+  await cleanUp();
+
   console.log(chalk.green.bold('Building Library... '));
 
   // 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.
+addDebugLog("buildLib", "services call", "");
   buildLib(
     buildLibName,
     buildVersion,
     tokenAndStaticServer.C11NB2S,
     tokenAndStaticServer.appStaticContentServer
   );
+addDebugLog("buildLIb", "services end", "");
 
 }
 
@@ -180,7 +189,8 @@ export default async options => {
     process.exit();
   }
 
-  showVersion();
+  await showVersion();
+addDebugLog("buildLibrary", "", "+");
 
   const compDef = await getOrgLib();
   const organization = compDef.organization;
@@ -201,8 +211,10 @@ export default async options => {
     ({ version, devBuild } = answers);
   }
 
+
   await localBuildLibrary(organization, library, version, devBuild);
 
+addDebugLog("buildLibrary", "END", "-");
 
   return true;
 };

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

@@ -3,7 +3,7 @@ import fs from 'fs-extra';
 import webpack from 'webpack';
 import FileSizeReporter from 'react-dev-utils/FileSizeReporter.js';
 import printBuildError from 'react-dev-utils/printBuildError.js';
-import { getUseWebPackPromotion} from '../../../util.js';
+import { getUseWebPackPromotion, addDebugLog} from '../../../util.js';
 
 
 const usePromoted = await getUseWebPackPromotion();
@@ -48,8 +48,11 @@ let compilationErrors = null;
 
 // Create the build and print the deployment instructions.
 function build(config, previousFileSizes, showStats = true) {
-  console.log(`Creating a ${Env} build...`);
+addDebugLog("bundle build", `config: ${JSON.stringify(config)}, \npreviousFileSizes: ${JSON.stringify(previousFileSizes)}, showStats: ${showStats}`, "");
 
+  if (showStats) {
+    console.log(`Creating a ${Env} build...`);
+  }
 
 
   const compiler = webpack(config);
@@ -65,7 +68,9 @@ function build(config, previousFileSizes, showStats = true) {
        }
        if (stats != null & typeof(stats) == "object") {
         if (stats.errors != undefined) {
-          console.log("stats:" + stats);
+          if (showStats) {
+            console.log("stats:" + stats);
+          }
         }
         else if (stats.compilation != undefined && stats.compilation.errors != undefined) {
 
@@ -189,6 +194,9 @@ export default ({
               WARN_AFTER_CHUNK_GZIP_SIZE
             );
           }
+          else {
+
+          }
 
           resolve('done emitting');
         },

package/src/tasks/bundle/builder/webpack.config.js

@@ -354,7 +354,9 @@ export default (
       /* isEnvProduction && new CompressionPlugin(compressionGZConfObj) */
     ].filter(Boolean),
     performance: {
-      hints: 'warning'
+      hints: false,
+      maxEntrypointSize: 512000,
+      maxAssetSize: 512000
     },
     externals
   };

package/src/tasks/bundle/index.js

@@ -3,13 +3,15 @@ import fs from 'fs';
 import { stat } from 'fs/promises';
 
 import { BUILD_CONFIG_JSON_FILENAME } from '../../constants.js';
-import { getComponentDirectoryPath } from '../../util.js';
+import { getComponentDirectoryPath, addDebugLog } from '../../util.js';
 
 import buildComponent from './builder/index.js';
 
 const extensions = ['ts', 'tsx', 'js', 'jsx'];
 
 const bundleComponent = async (componentKey, sourceMap, devBuild, showStats = true) => {
+addDebugLog("bundleComponent", `componentKey: ${componentKey}, sourceMap: ${sourceMap}, devBuild: ${devBuild}, showStats: ${showStats}`, "");
+
   const componentDirectory = await getComponentDirectoryPath(componentKey);
 
   const idx = (

package/src/tasks/create/index.js

@@ -20,7 +20,8 @@ import {
   updateComponentDefaultLibrary,
   updateComponentDefaultVersion,
   copyFileToShared,
-  getLibraryBased
+  getLibraryBased,
+  addDebugLog
 } from '../../util.js';
 import { COMPONENT_SCHEMA, SHARED_FILE_NAMES } from '../../constants.js';
 
@@ -46,7 +47,7 @@ const compileMustacheTemplates = async (
     subtype,
     description,
     organization,
-    allowedApplications
+    allowedApplications = ''
   }
 ) => {
   const files = fs.readdirSync(componentDirectory);
@@ -258,7 +259,10 @@ const validateCompile = async (
 };
 
 export default async options => {
-  showVersion();
+  await showVersion();
+
+
+addDebugLog("create", "", "+");
 
   if (options.params.length >= 12) {
 
@@ -390,7 +394,8 @@ export default async options => {
       {
         name: 'allowedApplications',
         message: 'Please enter the application names to be supported (comma-separated). ',
-        suffix: 'Keep empty for all applications'
+        suffix: 'Keep empty for all applications',
+        when: () => !isLibraryBased
       },
       {
         name: 'description',
@@ -427,4 +432,6 @@ export default async options => {
       );
     });
   }
+
+  addDebugLog("create", "END", "-");
 };

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

@@ -21,7 +21,8 @@ import { checkPathAccess, showVersion ,
   updateComponentDefaultLibrary,
   updateComponentDefaultVersion,
   copyFileToShared,
-  getLibraryBased
+  getLibraryBased,
+  addDebugLog
 } from '../../util.js';
 
 import { COMPONENT_SCHEMA, COMPONENTS_DIRECTORY_PATH, TASKS_CONFIG_JSON_FILENAME, COMPONENTS_PATH, CATEGORY_CONSTELLATION, SHARED_FILE_NAMES } from '../../constants.js';
@@ -53,7 +54,7 @@ const copyComponentTemplate = async (options) => {
 
 export const compileMustacheTemplates = async (
   componentDirectory,
-  { componentKey, componentName, componentLabel, library, version, type, subtype, description, organization, allowedApplications }
+  { componentKey, componentName, componentLabel, library, version, type, subtype, description, organization, allowedApplications = '' }
 ) => {
   const files = fs.readdirSync(componentDirectory);
   const componentClassName = convertIntoPascalCase(componentKey);
@@ -352,7 +353,9 @@ export const validateCompileAll = async ({ prefix, library, version, allowedAppl
 
 
 export default async (options) => {
-  showVersion();
+  await showVersion();
+
+addDebugLog("createAll", "", "+");
 
   await checkPathAccess(pegaConfigJsonPath);
 
@@ -428,7 +431,8 @@ export default async (options) => {
       {
         name: 'allowedApplications',
         message: 'Please enter the application names to be supported (comma-separated). ',
-        suffix: 'Keep empty for all applications'
+        suffix: 'Keep empty for all applications',
+        when: () => !isLibraryBased
       }
     ];
 
@@ -449,4 +453,6 @@ export default async (options) => {
       );
     });
   }
+
+addDebugLog("createAll", "END", "-");
 };

package/src/tasks/delete/helper.js

@@ -13,7 +13,8 @@ import {
   getComponents,
   getPegaServerConfig,
   standardizeStr,
-  sanitize
+  sanitize,
+  addDebugLog
 } from '../../util.js';
 import { getComponentsFromServer } from '../list/helper.js';
 
@@ -29,6 +30,8 @@ let organization;
 
 
 export const getDeleteComponentsQuestions = async (options) => {
+addDebugLog("getDeleteComponentsQuestions", "", "");
+
   const defaultPegaServerConfig = await getPegaServerConfig();
 
   return [
@@ -46,6 +49,7 @@ export const getDeleteComponentsQuestions = async (options) => {
 };
 
 export const getLaunchPadFilterQuestions = async () => {
+addDebugLog("getLaunchPadFilterQuestions", "", "");
   const defaultPegaServerConfig = await getPegaServerConfig();
 
   const currentDirectory = process.cwd();
@@ -93,6 +97,7 @@ export const getLaunchPadFilterQuestions = async () => {
 }
 
 export const deleteLocalComponents = async (sourceOfComponents, options) => {
+addDebugLog("deleteLocalComponents", `sourceOfComponnents: ${sourceOfComponents}`, "" );
   const localComponents = await getComponents();
 
   if (localComponents.length > 0) {
@@ -128,7 +133,7 @@ export const deleteLocalComponents = async (sourceOfComponents, options) => {
 };
 
 export const deleteServerComponents = async (sourceOfComponents, answers) => {
-
+addDebugLog("deleteServerComponents", `sourceOfComponents: ${sourceOfComponents}`, "");
   const defaultPegaServerConfig = await getPegaServerConfig();
   const isLaunchpad = defaultPegaServerConfig.serverType === 'launchpad';
 

package/src/tasks/delete/index.js

@@ -1,12 +1,13 @@
 import inquirer from 'inquirer';
 
-import { showVersion, getLibraryBased } from '../../util.js';
+import { showVersion, getLibraryBased, addDebugLog } from '../../util.js';
 
 import { deleteLocalComponents, SOURCE_OF_COMPONENT_TYPES, deleteServerComponents, getDeleteComponentsQuestions } from './helper.js';
 
 const isLibraryBased = await getLibraryBased();
 
 const deleteComponentsFn = async (sourceOfComponents, answers, options) => {
+addDebugLog("deleteComponentsFn", `sourceOfComponents: ${sourceOfComponents}`, "");
   switch (sourceOfComponents) {
     case SOURCE_OF_COMPONENT_TYPES.LOCAL: {
       await deleteLocalComponents(sourceOfComponents, options);
@@ -24,7 +25,9 @@ const deleteComponentsFn = async (sourceOfComponents, answers, options) => {
 };
 
 export default async (options) => {
-  showVersion();
+  await showVersion();
+
+addDebugLog("delete", "", "+");
 
   let sourceOfComponentsOption = SOURCE_OF_COMPONENT_TYPES.LOCAL;
   if (isLibraryBased) {
@@ -45,4 +48,5 @@ export default async (options) => {
     const { sourceOfComponents } = answers;
     await deleteComponentsFn(sourceOfComponents, answers, options);
   }
+addDebugLog("delete", "END", "-");
 };