@pega/custom-dx-components 25.1.10-alpha-0.12 → 25.1.10-alpha-0.13

package/README.md

@@ -4,6 +4,24 @@
 
 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).
+
+## 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/).
+
+## 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.
+
 ## Prerequisites
 
 Ensure you have access to the following in your system:

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pega/custom-dx-components",
-  "version": "25.1.10-alpha-0.12",
+  "version": "25.1.10-alpha-0.13",
   "description": "Utility for building custom UI components",
   "bin": "./bin/index.js",
   "keywords": [

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

@@ -45,6 +45,10 @@ export default async options => {
   // process and exit
   if (useInputConfig) {
     const inputConfig = await getInputConfigForCommand("createLib");
+    if (!inputConfig || Object.keys(inputConfig).length === 0) {
+      console.log(chalk.redBright("Configured for input config, but no input.config.json file found."));
+      process.exit(1);
+    }
 
     if (convertYNToBoolean(inputConfig.okToContinue)) {
       const libraryName = inputConfig.libraryName;

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

@@ -58,6 +58,10 @@ addDebugLog("createVersion", "", "+");
   // process and no inputs
   if (useInputConfig) {
     const inputConfig = await getInputConfigForCommand("createLibVersion");
+    if (!inputConfig || Object.keys(inputConfig).length === 0) {
+      console.log(chalk.redBright("Configured for input config, but no input.config.json file found."));
+      process.exit(1);
+    }
 
     if (convertYNToBoolean(inputConfig.okToContinue)) {
       version = inputConfig.libraryVersion;

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

@@ -236,7 +236,18 @@ addDebugLog("deleteLibrary", "", "+");
 
   if (useInputConfig) {
     const inputConfig = await getInputConfigForCommand("deleteLib");
+    if (!inputConfig || Object.keys(inputConfig).length === 0) {
+      console.log(chalk.redBright("Configured for input config, but no input.config.json file found."));
+      process.exit(1);
+    }
+
     libraryName = inputConfig.libraryName;
+    if (libraryName.indexOf("_") < 0) {
+      // need to add in organization
+      libraryName = `${compDef.organization}_${libraryName}`;
+    }
+
+
     version = inputConfig.libraryVersion;
     const isPermanent = inputConfig?.isPermanent || "N";
     let permBuild = convertYNToBoolean(isPermanent);

package/src/tasks/delete-version/index.js

@@ -41,6 +41,11 @@ addDebugLog("deleteVersion", "", "+");
 
   if (useInputConfig) {
     const inputConfig = await getInputConfigForCommand("deleteLibVersion");
+    if (!inputConfig || Object.keys(inputConfig).length === 0) {
+      console.log(chalk.redBright("Configured for input config, but no input.config.json file found."));
+      process.exit(1);
+    }
+
     version = inputConfig.libraryVersion;
     const isPermanent = inputConfig?.isPermanent || "N";
     let permBuild = convertYNToBoolean(isPermanent);

package/src/tasks/export-archive/index.js

@@ -5,6 +5,7 @@ import { join } from 'path';
 import inquirer from 'inquirer';
 import ncp from 'ncp';
 import chalk from 'chalk';
+import { Listr } from 'listr2';
 
 import {
   checkPathAccess,
@@ -145,6 +146,7 @@ addDebugLog("exportCLArch", `exportPath: ${exportPath}, orgLibName: ${orgLibName
       // archive it
       output = await zipVersionAndArchiveCL(configDef.currentOrgLib, configDef.buildVersion);
 
+
       // if archiving, need to wait before copying
       output.on('close', function() {
         fs.copyFileSync(archFileName, exportFile );
@@ -402,7 +404,26 @@ export default async options => {
       else {
         await checkAccessTokenExpiration();
 
-        // publish to server
+
+        const tasks = new Listr(
+          [
+            {
+              title: 'Saving local archive',
+              task: async () => {
+
+                // local archive so it will get stored
+                await zipVersionAndArchive(orgLibName, selectedVersion);
+              }
+            }
+          ],
+          { concurrent: false, exitOnError: true }
+        );
+
+        await tasks.run().catch(err => {
+          console.log(chalk.bold.red(err.toString()));
+          process.exit(1);
+        });
+
         await publishArchive(orgLibName, selectedVersion);
 
       }

package/src/tasks/import-archive/index.js

@@ -726,35 +726,103 @@ export default async options => {
 
     if (useInputConfig) {
       const inputConfig = await getInputConfigForCommand("importLibVersion");
+      if (!inputConfig || Object.keys(inputConfig).length === 0) {
+        console.log(chalk.redBright("Configured for input config, but no input.config.json file found."));
+        process.exit(1);
+      }
+
+      const serverOrDirectory = inputConfig.serverOrDirectory;
       const filePath = inputConfig.fileLocation;
       const fileName = inputConfig.fileName;
+      const serverAppName = "ComponentLibraryArchive";
+      const serverArchiveName = inputConfig.serverArchiveName;
+      const serverArchiveType = "zip";
+      const serverRulesetName = inputConfig.serverRulesetName;
+      const serverRulesetVersion = inputConfig.serverRulesetVersion;
 
 
       console.log("");
 
-      const tasks = new Listr(
-        [
-          {
-            title: `Importing archive`,
-            task: async () => {
-              await importArch( filePath, fileName, hasArch);
+      if (serverOrDirectory.toLowerCase() === "server") {
+        await checkAccessTokenExpiration();
+
+
+        if (serverArchiveName) {
+          // ALL option
+          const defaultPegaServerConfig = await getPegaServerConfig();
+
+          let fileName = `${serverArchiveName}.${serverArchiveType}`;
+          let fileData;
+
+          console.log("");
+
+          const tasks = new Listr(
+            [
+              {
+                title: 'Fetching archive from server',
+                task: async () => {
+                  // get archive
+                  fileData = await getServerLibraryArchive(serverAppName, serverArchiveName, serverArchiveType, serverRulesetName, serverRulesetVersion);
+                }
+              },
+              {
+                title: 'Saving archive in store',
+                task: async () => {
+                  await writeZipBuffer(fileName, fileData.pyFileSource);
+
+                  // import archive
+                  const currentDirectory = process.cwd();
+                  const tempDirectory = join(currentDirectory, TEMP_PATH);
+
+                  await importArchServer( tempDirectory, fileName, hasArch);
+                }
+              }
+            ],
+            { concurrent: false, exitOnError: true }
+          );
+
+          await tasks.run().catch(err => {
+            console.log(chalk.bold.red(err.toString()));
+            process.exit(1);
+          });
+
+
+
+        }
+        else {
+          // No library with that name
+          console.log(chalk.redBright(`No library archives exist on server.`));
+          process.exit();
+
+        }
+      }
+      else {
+        const tasks = new Listr(
+          [
+            {
+              title: `Importing archive`,
+              task: async () => {
+                await importArch( filePath, fileName, hasArch);
+              }
             }
-          }
-        ],
-        { concurrent: false, exitOnError: true }
-      );
+          ],
+          { concurrent: false, exitOnError: true }
+        );
 
 
-      await tasks.run().catch(err => {
-        console.log(chalk.bold.red(err.toString()));
-        process.exit(1);
-      });
+        await tasks.run().catch(err => {
+          console.log(chalk.bold.red(err.toString()));
+          process.exit(1);
+        });
+
+        console.log("");
+
+        // reapply to save if changed, because imported task.config may have overriden and we want
+        // to keep what was entered as the latest
+        await updateSavedFilePath(filePath);
+      }
 
-      console.log("");
 
-      // reapply to save if changed, because imported task.config may have overriden and we want
-      // to keep what was entered as the latest
-      await updateSavedFilePath(filePath);
 
     }
     else {

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

@@ -4,6 +4,24 @@
 
 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).
+
+## 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/).
+
+## 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.
+
 ## Prerequisites
 
 Ensure you have access to the following in your system:

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

@@ -107,7 +107,7 @@
     "@babel/preset-react": "^7.27.1",
     "@babel/preset-typescript": "^7.27.1",
     "@pega/configs": "^0.16.3",
-    "@pega/custom-dx-components": "~25.1.10-alpha-0.12",
+    "@pega/custom-dx-components": "~25.1.10-alpha-0.13",
     "@pega/pcore-pconnect-typedefs": "^4.1.0-alpha.1",
     "@storybook/addon-actions": "^8.6.14",
     "@storybook/addon-essentials": "^8.6.14",

package/src/tasks/publish/index.js

@@ -75,6 +75,10 @@ addDebugLog("publish", "", "+");
 
     if (useInputConfig) {
       const inputConfig = await getInputConfigForCommand("publish");
+      if (!inputConfig || Object.keys(inputConfig).length === 0) {
+        console.log(chalk.redBright("Configured for input config, but no input.config.json file found."));
+        process.exit(1);
+      }
 
       const okToPubPerm = inputConfig?.okToPublishPermanent || "Y";
       const okToPublishPerm = convertYNToBoolean(okToPubPerm);

package/src/tasks/restore/index.js

@@ -11,7 +11,10 @@ import {
   getLibraryBased,
   restoreFromArchive,
   cleanUpTemp,
-  forceDefaultsUpdate
+  forceDefaultsUpdate,
+  getUseInputConfig,
+  getInputConfigForCommand,
+  convertYNToBoolean
  } from '../../util.js';
 
  import { showCurrentStatus } from '../show-status/index.js';
@@ -19,6 +22,7 @@ import {
 export default async options => {
   await showVersion();
   await checkLibraryAndArchives();
+  const useInputConfig = getUseInputConfig();
 
 addDebugLog("restoreComponent", "", "+");
 
@@ -31,26 +35,43 @@ addDebugLog("restoreComponent", "", "+");
   }
   const confDef = getConfigDefaults();
 
-  console.log(chalk.bold.yellow('\nChanges not saved to local storage will be LOST, code will be restored from local storage.'));
-  console.log("");
 
   let restoreFromStore = {};
 
-  if (options.params.length === 4) {
-    const optConfirm = options.params[3];
-    restoreFromStore["confirmRestore"] = optConfirm === 'Y' || optConfirm === 'y' || optConfirm === true || optConfirm === 'true' ? true : false;
+  if (useInputConfig) {
+    const inputConfig = await getInputConfigForCommand("restoreLibVersion");
+    if (!inputConfig || Object.keys(inputConfig).length === 0) {
+      console.log(chalk.redBright("Configured for input config, but no input.config.json file found."));
+      process.exit(1);
+    }
+
+    const okToRestore = convertYNToBoolean(inputConfig.okToRestore);
+
+    restoreFromStore.confirmRestore = okToRestore;
+
   }
   else {
-    restoreFromStore = await inquirer.prompt([
-      {
-        name: 'confirmRestore',
-        type: 'confirm',
-        message: `Restoring ${chalk.bold.green(`${confDef.displayLibVersion}`)} from local storage, proceed ?`,
-        default: true
-      }
-    ]);
+    console.log(chalk.bold.yellow('\nChanges not saved to local storage will be LOST, code will be restored from local storage.'));
+    console.log("");
+
+    if (options.params.length === 4) {
+      const optConfirm = options.params[3];
+      restoreFromStore["confirmRestore"] = optConfirm === 'Y' || optConfirm === 'y' || optConfirm === true || optConfirm === 'true' ? true : false;
+    }
+    else {
+      restoreFromStore = await inquirer.prompt([
+        {
+          name: 'confirmRestore',
+          type: 'confirm',
+          message: `Restoring ${chalk.bold.green(`${confDef.displayLibVersion}`)} from local storage, proceed ?`,
+          default: true
+        }
+      ]);
+    }
   }
 
+
+
   if (restoreFromStore.confirmRestore) {
     const switchToFileName = `${confDef.currentOrgLib}_${confDef.version}.arch.zip`;
     const tasks = new Listr(

package/src/tasks/set-perm/index.js

@@ -141,6 +141,11 @@ addDebugLog("setPerm", "", "+");
 
   if (useInputConfig) {
     const inputConfig = await getInputConfigForCommand("setPermanent");
+    if (!inputConfig || Object.keys(inputConfig).length === 0) {
+      console.log(chalk.redBright("Configured for input config, but no input.config.json file found."));
+      process.exit(1);
+    }
+
     inputYN = inputConfig.makePermanent;
 
   }

package/src/tasks/store/index.js

@@ -10,12 +10,16 @@ import {
   getConfigDefaults,
   getLibraryBased,
   zipVersionAndArchive,
-  cleanUpTemp
+  cleanUpTemp,
+  getUseInputConfig,
+  getInputConfigForCommand,
+  convertYNToBoolean
  } from '../../util.js';
 
 export default async options => {
   await showVersion();
   await checkLibraryAndArchives();
+  const useInputConfig = getUseInputConfig();
 
 addDebugLog("storeComponents", "", "+");
 
@@ -29,26 +33,43 @@ addDebugLog("storeComponents", "", "+");
   const confDef = getConfigDefaults();
 
 
-  console.log(chalk.bold.yellow('\nBe sure to SAVE all changes before storing, or changes will NOT be stored.'));
 
   let answers = {};
 
-  if (options.params.length === 4) {
-    const optConfirm = options.params[3];
-    answers["confirmStore"] = optConfirm === 'Y' || optConfirm === 'y' || optConfirm === true || optConfirm === 'true' ? true : false;
+  if (useInputConfig) {
+    const inputConfig = await getInputConfigForCommand("storeLibVersion");
+    if (!inputConfig || Object.keys(inputConfig).length === 0) {
+      console.log(chalk.redBright("Configured for input config, but no input.config.json file found."));
+      process.exit(1);
+    }
+
+    const okToStore = convertYNToBoolean(inputConfig.okToStore);
+
+    answers.confirmStore = okToStore;
+
   }
   else {
+    console.log(chalk.bold.yellow('\nBe sure to SAVE all changes before storing, or changes will NOT be stored.'));
+
+    if (options.params.length === 4) {
+      const optConfirm = options.params[3];
+      answers["confirmStore"] = optConfirm === 'Y' || optConfirm === 'y' || optConfirm === true || optConfirm === 'true' ? true : false;
+    }
+    else {
 
-    answers = await inquirer.prompt([
-      {
-        name: 'confirmStore',
-        type: 'confirm',
-        message: `Storing ${chalk.green(`${confDef.currentOrgLib}/${confDef.buildVersion}`)} to local storage, proceed ?`,
-        default: true
-      }
-    ]);
+      answers = await inquirer.prompt([
+        {
+          name: 'confirmStore',
+          type: 'confirm',
+          message: `Storing ${chalk.green(`${confDef.currentOrgLib}/${confDef.buildVersion}`)} to local storage, proceed ?`,
+          default: true
+        }
+      ]);
+    }
   }
 
+
+
   if (answers.confirmStore) {
     console.log("");
 

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

@@ -62,6 +62,10 @@ addDebugLog("switchLibrary", "", "+");
   // process and no inputs
   if (useInputConfig) {
     const inputConfig = await getInputConfigForCommand("switchLib");
+    if (!inputConfig || Object.keys(inputConfig).length === 0) {
+      console.log(chalk.redBright("Configured for input config, but no input.config.json file found."));
+      process.exit(1);
+    }
 
     if (convertYNToBoolean(inputConfig.okToContinue)) {
       const newLibraryName = inputConfig.libraryName;

package/src/tasks/switch-version/index.js

@@ -62,6 +62,10 @@ addDebugLog("switchVersion", "", "+");
   // process and no inputs
   if (useInputConfig) {
     const inputConfig = await getInputConfigForCommand("switchLibVersion");
+    if (!inputConfig || Object.keys(inputConfig).length === 0) {
+      console.log(chalk.redBright("Configured for input config, but no input.config.json file found."));
+      process.exit(1);
+    }
 
     okToContinue = convertYNToBoolean(inputConfig.okToContinue);
     if (okToContinue) {