@pega/custom-dx-components 0.25.58 → 0.25.60

package/README.md

@@ -5,23 +5,30 @@
 This project provides you with an environment to extend Constellation by giving you tools to create and publish custom components that are not available from the Constellation installation.
 
 ## Before you begin
+
 Review the following checklist before you create a Constellation DX component:
 
 ## Design considerations
-Involve an Experience Designer in your process. This will help you determine the exact issue to be resolved. For more information on the role of an Experience Designer, see **Experience Designer**[here](https://community.pega.com/roles/experience-designer).
+
+Involve an Experience Designer in your process. This will help you determine the exact issue to be resolved. For more information on the role of an Experience Designer, see **Experience Designer** [here](https://community.pega.com/roles/experience-designer).
 
 ## The Experience Designer must meet the following requirements:
+
 Must have a background in UI and UX design.
-Must understand Pega's best practices for design. For more information, see **Best practices for designing with the Constellation design system**[here](https://design.pega.com/design/getting-started/).
+Must understand Pega's best practices for design. For more information, see **Best practices for designing with the Constellation design system** [here](https://design.pega.com/design/getting-started/).
 
 ## Functionality considerations
+
 Check if an existing component in App Studio contains the features you need. If not, check for existing components that contain similar features.
 Connect with Pega Support to find out if a component containing a similar feature will be included in the next release. If yes, assess if you can wait for the next release.
 
 ## Maintenance considerations
+
 Ensure you have the bandwidth to maintain the Constellation DX component and keep it up-to-date with every release of Pega Infinity. Evaluate if doing this might prevent you from upgrading to future releases of Pega Infinity.
 Evaluate if you are able to meet the compliance standards for data privacy and accessibility for Constellation DX components. Note that not meeting these standards might lead to legal compliance issues.
 
+For more info [here](https://pega-dev.zoominsoftware.io/bundle/constellation-dx-components/page/constellation-dx-components/custom-components/design-requirements-constellation-dx-components.html).
+
 ## Prerequisites
 
 Ensure you have access to the following in your system:

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pega/custom-dx-components",
-  "version": "0.25.58",
+  "version": "0.25.60",
   "description": "Utility for building custom UI components",
   "bin": "./bin/index.js",
   "keywords": [
@@ -24,8 +24,8 @@
     "@babel/core": "^7.28.0",
     "@babel/plugin-transform-class-properties": "^7.27.1",
     "@babel/preset-react": "^7.27.1",
-    "@pega/auth": "^0.2.27",
-    "@pega/constellation-dx-components-build-utils": "^2.0.8-dev",
+    "@pega/auth": "^0.2.31",
+    "@pega/constellation-dx-components-build-utils": "^2.0.11",
     "@pega/inquirer-fuzzy-path": "^3.0.0",
     "ajv": "^8.17.1",
     "ajv-keywords": "^5.1.0",
@@ -66,7 +66,7 @@
     "typescript": "~5.8.3",
     "unarchive": "^1.1.3",
     "url-loader": "4.1.1",
-    "webpack": "5.100.2",
+    "webpack": "5.101.0",
     "webpack-cli": "^6.0.1"
   },
   "devDependencies": {

package/src/tasks/init/template/README.md

@@ -5,23 +5,30 @@
 This project provides you with an environment to extend Constellation by giving you tools to create and publish custom components that are not available from the Constellation installation.
 
 ## Before you begin
+
 Review the following checklist before you create a Constellation DX component:
 
 ## Design considerations
-Involve an Experience Designer in your process. This will help you determine the exact issue to be resolved. For more information on the role of an Experience Designer, see **Experience Designer**[here](https://community.pega.com/roles/experience-designer).
+
+Involve an Experience Designer in your process. This will help you determine the exact issue to be resolved. For more information on the role of an Experience Designer, see **Experience Designer** [here](https://community.pega.com/roles/experience-designer).
 
 ## The Experience Designer must meet the following requirements:
+
 Must have a background in UI and UX design.
-Must understand Pega's best practices for design. For more information, see **Best practices for designing with the Constellation design system**[here](https://design.pega.com/design/getting-started/).
+Must understand Pega's best practices for design. For more information, see **Best practices for designing with the Constellation design system** [here](https://design.pega.com/design/getting-started/).
 
 ## Functionality considerations
+
 Check if an existing component in App Studio contains the features you need. If not, check for existing components that contain similar features.
 Connect with Pega Support to find out if a component containing a similar feature will be included in the next release. If yes, assess if you can wait for the next release.
 
 ## Maintenance considerations
+
 Ensure you have the bandwidth to maintain the Constellation DX component and keep it up-to-date with every release of Pega Infinity. Evaluate if doing this might prevent you from upgrading to future releases of Pega Infinity.
 Evaluate if you are able to meet the compliance standards for data privacy and accessibility for Constellation DX components. Note that not meeting these standards might lead to legal compliance issues.
 
+For more info [here](https://pega-dev.zoominsoftware.io/bundle/constellation-dx-components/page/constellation-dx-components/custom-components/design-requirements-constellation-dx-components.html).
+
 ## Prerequisites
 
 Ensure you have access to the following in your system:

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

@@ -82,9 +82,9 @@
     "pega"
   ],
   "dependencies": {
-    "@pega/cosmos-react-condition-builder": "^8.1.0",
-    "@pega/cosmos-react-core": "^8.1.0",
-    "@pega/cosmos-react-work": "^8.1.0",
+    "@pega/cosmos-react-condition-builder": "^8.4.1",
+    "@pega/cosmos-react-core": "^8.4.1",
+    "@pega/cosmos-react-work": "^8.4.1",
     "@pega/eslint-config": "^0.16.3",
     "@pega/tsconfig": "^0.16.3",
     "babel-loader": "^10.0.0",
@@ -107,8 +107,8 @@
     "@babel/preset-react": "^7.27.1",
     "@babel/preset-typescript": "^7.27.1",
     "@pega/configs": "^0.16.3",
-    "@pega/custom-dx-components": "~0.25.58",
-    "@pega/pcore-pconnect-typedefs": "^4.0.0-alpha.0",
+    "@pega/custom-dx-components": "~0.25.60",
+    "@pega/pcore-pconnect-typedefs": "^4.1.0",
     "@storybook/addon-actions": "^8.6.14",
     "@storybook/addon-essentials": "^8.6.14",
     "@storybook/addon-links": "^8.6.14",

package/src/tasks/publish/index.js

@@ -24,6 +24,7 @@ import {
   convertYNToBoolean,
   checkForBranch,
   getApplicationAndVersionFromToken,
+  zipVersionAndArchive,
   applyPegaData } from '../../util.js';
 
 import { getPublishComponentQuestions, publishComponentToServer, zipComponent } from './helper.js';
@@ -166,9 +167,15 @@ addDebugLog("publish", "", "+");
       options.params.push("internal");
 
 
-      await buildLibrary(options);
-      await publishLibrary(options);
-
+      try {
+        await buildLibrary(options);
+        await zipVersionAndArchive(orgLib.currentOrgLib, orgLib.buildVersion);
+        await publishLibrary(options);
+      }
+      catch (err) {
+        console.log(chalk.redBright(err));
+        process.exit(1);
+      }
 
     }
 
@@ -287,6 +294,7 @@ addDebugLog("publish", "", "+");
 
   await tasks.run().catch(err => {
     console.log(chalk.bold.red(err.toString()));
+    process.exit(1);
   });
 
 

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

@@ -258,6 +258,7 @@ addDebugLog("publishUILibraryComponentToInfinity", `content: ${content}`, "");
     // strip all Error:
     sErr = sErr.replaceAll("Error: ", "");
     console.log(chalk.bold.red("Error: " + sErr));
+    process.exit(1);
   }
 
 }
@@ -398,6 +399,7 @@ addDebugLog("publishLibrary", "", "+");
       return;
     }
 
+    // This is for 24.2 version of libraryMode, libraryModeCL doesn't do "permanent"
     if (!version.includes("-dev") && !internalPublish && !isLibraryBasedCL) {
       okToPublish = false;
       const publishAnswers = await inquirer.prompt([
@@ -421,16 +423,20 @@ addDebugLog("publishLibrary", "", "+");
     }
 
 
-    const isLibraryBasedCL =  getLibraryBasedCL();
     if (okToPublish) {
       if (isLibraryBasedCL) {
-        // developer test
 
+        // for Library Mode CL (25.1 and greater), this is the default
         let content = { libraryName, version, rulesetName, rulesetVersion };
         await publishUILibraryComponentToInfinity(content);
 
       }
       else {
+        //
+        // This is 24.2 library mode with App Static (old)
+        // at some point need to deprecate and remove this code
+        //
+
         let libVersionExists = await doesLibraryExist(libraryName, version);
         let overrideExisting = false;
         let checkDeleted = false;
@@ -483,6 +489,7 @@ addDebugLog("publishLibrary", "", "+");
   else {
     console.log(chalk.bold.redBright(`No library versions named ${libraryName}.`));
     console.log(chalk.bold.redBright(`You need to build library ${libraryName} first.`));
+    process.exit(1);
   }
 
 

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

@@ -39,19 +39,23 @@ export const showHelpV1 = () => {
   console.log(`${chalk.cyan('npm run buildAllComponents')}\tvalidate and build ALL components before publishing, checking for errors`);
   console.log(`${chalk.cyan('npm run rename           ')}\trename a component`);
   console.log(`${chalk.cyan('npm run importComponent  ')}\timport a component from a path`);
+  console.log("");
   console.log(`${chalk.cyan('npm run startStorybook   ')}\tstorybook components for testing`);
+  console.log(`${chalk.cyan('npm run test')}\t\t\trun component unit tests`);
 
-  console.log(`\n${chalk.underline(`Local and Server(needs authentication)`)}`);
+  console.log(`\n${chalk.underline(`Local and Server (needs authentication)`)}`);
   console.log(`${chalk.cyan('npm run list             ')}\tget list of components`);
   console.log(`${chalk.cyan('npm run delete           ')}\tdelete a component`);
   console.log(`${chalk.cyan('npm run deleteAll        ')}\tdelete ALL components`);
 
-  console.log(`\n${chalk.underline(`Server(needs authentication)`)}`);
+  console.log(`\n${chalk.underline(`Server (needs authentication)`)}`);
   console.log(`${chalk.cyan('npm run publish          ')}\tpublish a component to server`);
   console.log(`${chalk.cyan('npm run publishAll       ')}\tpublish ALL components to server`);
 
   console.log("");
   console.log(`\n${chalk.underline(`Notes`)}`);
+  console.log(`${chalk.yellow('>> By choosing to create and use custom components, you agree to keep them up-to-date with every release of Pega Infinity,')}`);
+  console.log(`${chalk.yellow('>> as well as meeting compliance standards for data privacy and accessibility.')}\n`);
   console.log(`Cannot publish a component with prefix (Org_Lib) that matches a Rule-UI-ComponentLibrary (libraryModeCL) in same ruleset.`);
 
   console.log("");
@@ -68,7 +72,7 @@ export const showHelpV2 = (isCL) => {
   console.log(`\nUsage:`);
 
 
-  console.log(`\n${chalk.underline(`Authenticate`)}`);
+  console.log(`\n${chalk.underline(`Authenticate (for Server commands)`)}`);
   console.log(`${chalk.cyan('npm run authenticate')}\t\tauthenticate to a server (required for publish commands)`);
 
   console.log(`\n${chalk.underline(`Library`)}`);
@@ -122,8 +126,10 @@ export const showHelpV2 = (isCL) => {
   console.log("");
 
   console.log(`\n${chalk.underline(`Notes`)}`);
+  console.log(`${chalk.yellow('>> By choosing to create and use custom components, you agree to keep them up-to-date with every release of Pega Infinity,')}`);
+  console.log(`${chalk.yellow('>> as well as meeting compliance standards for data privacy and accessibility.')}\n`);
   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, storeLibVersion`)}`);
+  console.log(`${chalk.cyan(`createLib, switchLib, createLibVersion, switchLibVersion, publish, 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")}`);
@@ -133,7 +139,7 @@ export const showHelpV2 = (isCL) => {
   else {
     console.log(`for backup storage.`);
   }
-  console.log(`\nIn tasks.config.json, set ${chalk.yellow("libraryModeCL")} to ${chalk.yellow("false")} for original single components or for ${chalk.yellow("Launchpad")} components.`);
+  console.log(`\nIn tasks.config.json, set ${chalk.yellow("libraryModeCL")} to ${chalk.yellow("false")} for original stand alone components or for ${chalk.yellow("Launchpad")} components.`);
   console.log("");
 }
 

package/src/util.js

@@ -1962,6 +1962,11 @@ if (showDebug) addDebugLog("zipVersionAndArchive", `orgLibName: ${orgLibName}, v
   const packageJson = join(currentDirectory, PACKAGE_JSON_FILENAME);
   const archiveFileName = `${orgLibName}_${version}.arch.zip`;
 
+  // check if components directory exists and if not, create a blank one
+  const componentsDirectory = join(srcDirectoryPath, "components");
+  if (!fs.existsSync(componentsDirectory)) {
+    fs.mkdirSync(componentsDirectory, { recursive: true });
+  }
 
   // const configContent = Buffer.from(fs.readFileSync(configJson)).toString();
   const mainDirectory = process.cwd();