@pega/dx-component-builder-sdk 26.1.10 → 26.1.11

package/src/tasks/override/index.js

@@ -6,7 +6,7 @@ import { join } from 'path';
 import inquirer from 'inquirer';
 import ncp from 'ncp';
 import chalk from 'chalk';
-import { updateComponentMap  } from '../map/map.js';
+import { getPrettierFormattedString, updateComponentMap } from '../map/map.js';
 
 import {
   checkPathAccess,
@@ -19,7 +19,8 @@ import {
   getComponentDefaults
 } from '../../util.js';
 
-import { COMPONENT_SCHEMA,
+import {
+  COMPONENT_SCHEMA,
   CATEGORY_OVERRIDE,
   SDK_CONFIG_JSON_FILENAME,
   DXCB_CONFIG,
@@ -27,7 +28,8 @@ import { COMPONENT_SCHEMA,
   CUSTOM_TEMPLATES,
   OVERRIDE_TEMPLATE_PATH,
   OVERRIDE_REACT_LIB_PATH,
-  OVERRIDE_ANGULAR_LIB_PATH } from '../../constants.js';
+  OVERRIDE_ANGULAR_LIB_PATH
+} from '../../constants.js';
 
 const pegaConfigJsonPath = path.join(path.resolve(), SDK_CONFIG_JSON_FILENAME);
 
@@ -65,15 +67,17 @@ const checkAndCreateConfigComponentKey = async (targetDirectory) => {
       // stringify "4", makes the json string look like JSON in the file, formated instead of a single line
       const configContent = JSON.stringify(configObj, null, 4);
 
+      const configContentFormatted = await getPrettierFormattedString(configContent, configFile);
+
       // update file
-      fs.writeFileSync(configFile, configContent, { encoding: 'utf8' });
+      fs.writeFileSync(configFile, configContentFormatted, { encoding: 'utf8' });
     }
 
   }
   catch (err) {
     // no config-ext.json file, so no update, which is ok
     const arPaths = targetDirectory.split("/");
-    const compName = arPaths[arPaths.length-1] ;
+    const compName = arPaths[arPaths.length - 1];
     console.log(chalk.yellow(`Component ${compName} has no config file for extension.`));
   }
 }
@@ -100,7 +104,7 @@ const getListAvailableComponents = async (type) => {
 
     let listEl = fullList[el].value;
 
-    if (listEl.indexOf("/") >=0) {
+    if (listEl.indexOf("/") >= 0) {
       const arKey = listEl.split("/");
       listEl = arKey[arKey.length - 1];
     }
@@ -190,7 +194,7 @@ const validateCompile = async (
     componentKey = componentKey.split("/")[1];
   }
   const typeLC = type.toLowerCase();
-  const targetDirectory = await getComponentDirectoryPath(join(typeLC, "/",componentKey), CATEGORY_OVERRIDE);
+  const targetDirectory = await getComponentDirectoryPath(join(typeLC, "/", componentKey), CATEGORY_OVERRIDE);
 
   const components = await getComponents(false, CATEGORY_OVERRIDE);
   if (components.includes(componentKey)) {
@@ -224,28 +228,28 @@ export default async options => {
     let inputType = options.params[3];
 
     switch (inputType.toLowerCase()) {
-      case "field" :
-      case "f" :
+      case "field":
+      case "f":
         promptType = "field";
         break;
-      case "template" :
-      case "t" :
+      case "template":
+      case "t":
         promptType = "template";
         break;
-      case "widget" :
-      case "w" :
+      case "widget":
+      case "w":
         promptType = "widget";
         break;
-      case "designsystemextension" :
-      case "des" :
-      case "d" :
+      case "designsystemextension":
+      case "des":
+      case "d":
         promptType = "designSystemExtension";
         break;
-      case "infra" :
-      case "i" :
+      case "infra":
+      case "i":
         promptType = "infra";
         break;
-      }
+    }
   }
 
   await checkPathAccess(pegaConfigJsonPath);
@@ -262,7 +266,7 @@ export default async options => {
 
   const componentData = data[DXCB_CONFIG][DXCB_COMPONENT_DEFAULTS];
 
-  const { organization, library} = componentData;
+  const { organization, library } = componentData;
 
   let componentDefaults = await getComponentDefaults();
   componentDefaults.library = library;
@@ -294,7 +298,7 @@ export default async options => {
         type: 'rawlist',
         message: 'Enter type of component',
         choices: COMPONENT_SCHEMA.overrideType,
-        when (propmtType) {
+        when(propmtType) {
           return promptType === null;
         }
       },
@@ -325,7 +329,7 @@ export default async options => {
         choices: infraList,
         pageSize: 15,
         when(answers) {
-          return infraList.length > 0 && (answers.type === 'infra'  || promptType === 'infra');
+          return infraList.length > 0 && (answers.type === 'infra' || promptType === 'infra');
         }
       },
       {
@@ -345,7 +349,7 @@ export default async options => {
         choices: widgetList,
         pageSize: 15,
         when(answers) {
-          return widgetList.length > 0 && (answers.type === 'widget'  || promptType === 'widget');
+          return widgetList.length > 0 && (answers.type === 'widget' || promptType === 'widget');
         }
       },
 

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

@@ -6,11 +6,11 @@ import { join } from 'path';
 import inquirer from 'inquirer';
 import ncp from 'ncp';
 import chalk from 'chalk';
-import { updateComponentMap  } from '../map/map.js';
+import { getPrettierFormattedString, updateComponentMap } from '../map/map.js';
 
 import {
-  checkPathAccess, 
-  showVersion, 
+  checkPathAccess,
+  showVersion,
   getFramework,
   getPegaConfig,
   getComponentDirectoryPath,
@@ -19,15 +19,17 @@ import {
   convertIntoKebabCase
 } from '../../util.js';
 
-import { COMPONENT_SCHEMA, 
-  CATEGORY_OVERRIDE, 
-  SDK_CONFIG_JSON_FILENAME, 
-  DXCB_CONFIG, 
+import {
+  COMPONENT_SCHEMA,
+  CATEGORY_OVERRIDE,
+  SDK_CONFIG_JSON_FILENAME,
+  DXCB_CONFIG,
   DXCB_COMPONENT_DEFAULTS,
   CUSTOM_TEMPLATES,
   OVERRIDE_TEMPLATE_PATH,
   OVERRIDE_REACT_LIB_PATH,
-  OVERRIDE_ANGULAR_LIB_PATH } from '../../constants.js';
+  OVERRIDE_ANGULAR_LIB_PATH
+} from '../../constants.js';
 import { compileMustacheTemplates } from '@pega/dx-component-builder-sdk/src/tasks/create/index.js';
 
 const pegaConfigJsonPath = path.join(path.resolve(), SDK_CONFIG_JSON_FILENAME);
@@ -66,15 +68,17 @@ const checkAndCreateConfigComponentKey = async (targetDirectory) => {
       // stringify "4", makes the json string look like JSON in the file, formated instead of a single line
       const configContent = JSON.stringify(configObj, null, 4);
 
+      const configContentFormatted = await getPrettierFormattedString(configContent, configFile);
+
       // update file
-      fs.writeFileSync(configFile, configContent, { encoding: 'utf8' });
+      fs.writeFileSync(configFile, configContentFormatted, { encoding: 'utf8' });
     }
 
   }
   catch (err) {
     // no config-ext.json file, so no update, which is ok
     const arPaths = targetDirectory.split("/");
-    const compName = arPaths[arPaths.length-1] ;
+    const compName = arPaths[arPaths.length - 1];
     console.log(chalk.yellow(`Component ${compName} has no config file for extension.`));
   }
 }
@@ -100,7 +104,7 @@ const getListAvailableComponents = async (type) => {
 
     let listEl = fullList[el].value;
 
-    if (listEl.indexOf("/") >=0) {
+    if (listEl.indexOf("/") >= 0) {
       const arKey = listEl.split("/");
       listEl = arKey[arKey.length - 1];
     }
@@ -132,14 +136,14 @@ const adjustAngularKebabCase = (componentName) => {
 
 const validateCompile = async (
   {
-    componentName, 
+    componentName,
     type
   },
   options
 ) => {
 
   let pegaConfig =
-  await getPegaConfig();
+    await getPegaConfig();
 
   // will need to put a case statement here checking framework
   const framework = await getFramework();
@@ -168,7 +172,7 @@ const validateCompile = async (
 
   if (pegaConfig[DXCB_CONFIG] &&
     pegaConfig[DXCB_CONFIG][CUSTOM_TEMPLATES] &&
-    pegaConfig[DXCB_CONFIG][CUSTOM_TEMPLATES][OVERRIDE_TEMPLATE_PATH] && 
+    pegaConfig[DXCB_CONFIG][CUSTOM_TEMPLATES][OVERRIDE_TEMPLATE_PATH] &&
     pegaConfig[DXCB_CONFIG][CUSTOM_TEMPLATES][OVERRIDE_TEMPLATE_PATH] != "") {
     templateParentDir = pegaConfig[DXCB_CONFIG][CUSTOM_TEMPLATES][OVERRIDE_TEMPLATE_PATH];
   }
@@ -183,7 +187,7 @@ const validateCompile = async (
     componentKey = componentKey.split("/")[1];
   }
   const typeLC = type.toLowerCase();
-  const targetDirectory = await getComponentDirectoryPath(join(typeLC, "/",componentKey), CATEGORY_OVERRIDE);
+  const targetDirectory = await getComponentDirectoryPath(join(typeLC, "/", componentKey), CATEGORY_OVERRIDE);
 
   const components = await getComponents(false, CATEGORY_OVERRIDE);
   if (components.includes(componentKey)) {
@@ -246,7 +250,7 @@ export default async options => {
 
   const componentData = data[DXCB_CONFIG][DXCB_COMPONENT_DEFAULTS];
 
-  const { organization, library} = componentData;
+  const { organization, library } = componentData;
 
   let componentDefaults = await getComponentDefaults();
   componentDefaults.library = library;
@@ -257,14 +261,14 @@ export default async options => {
   const widgetList = await getListAvailableComponents("widget");
   const infraList = await getListAvailableComponents("infra");
 
- 
+
   await buildOverrideComponents("field", fieldList, options);
   await buildOverrideComponents("template", templateList, options);
   await buildOverrideComponents("widget", widgetList, options);
   await buildOverrideComponents("designSystemExtension", desList, options);
   await buildOverrideComponents("infra", infraList, options);
 
- 
+
 
 };
 

package/src/util.js

@@ -44,6 +44,7 @@ import {
   JEST_TESTS_FUNCTIONAL_PATH,
   MAX_RFT_CHARS
 } from './constants.js';
+import { getPrettierFormattedString } from './tasks/map/map.js';
 
 export const DXCB_CONFIG_INTERNAL_JSON_FILENAME = 'src/dxcb.config.json';
 
@@ -97,21 +98,22 @@ export const updateComponentDefaultLibrary = async (library) => {
   let data = fs.readFileSync(pegaConfigJsonPath, { encoding: 'utf8' });
   data = JSON.parse(data);
 
-  let componentsDefault = data.dxcbConfig.componentDefaults;
+  const componentsDefault = data.dxcbConfig.componentDefaults;
   componentsDefault.library = library;
 
+  const configJSON = await getPrettierFormattedString(JSON.stringify(data, null, 4), pegaConfigJsonPath)
 
-  fs.writeFileSync(pegaConfigJsonPath, JSON.stringify(data, null, 4),  { encoding: 'utf8',flag:'w' });
+  fs.writeFileSync(pegaConfigJsonPath, configJSON, { encoding: 'utf8', flag: 'w' });
 
 }
 
 export const visualLCCategory = (category) => {
 
   switch (category) {
-    case CATEGORY_CONSTELLATION :
+    case CATEGORY_CONSTELLATION:
       return "custom-".concat(category.toLowerCase());
-    case CATEGORY_CUSTOM :
-    case CATEGORY_OVERRIDE :
+    case CATEGORY_CUSTOM:
+    case CATEGORY_OVERRIDE:
       return category.toLowerCase().concat("-sdk");
   }
 
@@ -122,7 +124,7 @@ let componentFramework = "";
 
 export const getFramework = async () => {
 
-  if ( componentFramework === "") {
+  if (componentFramework === "") {
     const pegaConfigInternalJsonPath = path.join(path.resolve(), DXCB_CONFIG_INTERNAL_JSON_FILENAME);
 
     let internalData = fs.readFileSync(pegaConfigInternalJsonPath, { encoding: 'utf8' });
@@ -160,7 +162,7 @@ export const getLocalComponentConfig = async (componentKey, category = CATEGORY_
     const configJsonPath = join(directory, "config.json");
 
     if (fs.existsSync(configJsonPath)) {
-      let data = fs.readFileSync(configJsonPath, { encoding: 'utf8'});
+      let data = fs.readFileSync(configJsonPath, { encoding: 'utf8' });
       configJSON = JSON.parse(data);
     }
 
@@ -172,7 +174,7 @@ export const getLocalComponentConfig = async (componentKey, category = CATEGORY_
 export const getLocalComponentKeyFromConfig = async (folderName, category) => {
 
   const configJSON = await getLocalComponentConfig(folderName, category);
-  if (typeof(configJSON) == 'object') {
+  if (typeof (configJSON) == 'object') {
     return configJSON.componentKey;
   }
   else {
@@ -256,13 +258,13 @@ export const deleteServerComponent = async componentKey => {
             // console.log(accessTokenUri, refreshToken);
             /* TODO - Handle refresh_token */
           }
-          else if (status === 404){
+          else if (status === 404) {
             throw new Error('404: Server resource not found');
           }
-          else if (status === 405){
+          else if (status === 405) {
             throw new Error('405: Server method not allowed');
           }
-          else if (status === 408){
+          else if (status === 408) {
             throw new Error('408: Server timed out');
           }
 
@@ -303,15 +305,15 @@ export const getOptionsCategory = (options) => {
     let catType = options.params[3];
 
     switch (catType.toLowerCase()) {
-      case "override" :
-      case "o" :
+      case "override":
+      case "o":
         categoryType = "override";
         break;
-      case "custom" :
-        case "c" :
-          categoryType = "custom";
-          break;
-      }
+      case "custom":
+      case "c":
+        categoryType = "custom";
+        break;
+    }
   }
   return categoryType;
 }
@@ -322,15 +324,15 @@ export const getOptionsSource = (options) => {
     let srcType = options.params[3];
 
     switch (srcType.toLowerCase()) {
-      case "server" :
-      case "s" :
+      case "server":
+      case "s":
         sourceType = "Server";
         break;
-      case "local" :
-      case "l" :
+      case "local":
+      case "l":
         sourceType = "Local";
         break;
-      }
+    }
   }
   return sourceType;
 }
@@ -431,20 +433,20 @@ export const getSubComponents = async (directory, type) => {
 
   const subDirectory = join(directory, type);
   return fs
-  .readdirSync(subDirectory, { withFileTypes: true })
-  .filter(dirent => dirent.isDirectory())
-  .map(dirent => dirent.name);
+    .readdirSync(subDirectory, { withFileTypes: true })
+    .filter(dirent => dirent.isDirectory())
+    .map(dirent => dirent.name);
 }
 
 export const getSubComponentsName = async (directory, type) => {
 
   const subDirectory = join(directory, type);
   const directoryList = fs.readdirSync(subDirectory, { withFileTypes: true })
-  .filter(dirent => dirent.isDirectory());
+    .filter(dirent => dirent.isDirectory());
 
   let componentList = new Array();
 
-  for ( let i =0; i < directoryList.length; i++) {
+  for (let i = 0; i < directoryList.length; i++) {
     const directoryObj = directoryList[i];
     const configJSON = await getLocalComponentConfig(join(type, directoryObj.name));
     componentList.push(configJSON['componentKey']);
@@ -457,16 +459,16 @@ export const getSubComponentsName = async (directory, type) => {
 
 export const getDirectoryFiles = async (directory) => {
   return fs
-  .readdirSync(directory, { withFileTypes: true })
-  .filter(dirent => !dirent.isDirectory())
-  .map(dirent => dirent.name);
+    .readdirSync(directory, { withFileTypes: true })
+    .filter(dirent => !dirent.isDirectory())
+    .map(dirent => dirent.name);
 }
 
 export const getListOfDirectories = async (directory) => {
   return fs
-  .readdirSync(directory, { withFileTypes: true })
-  .filter(dirent => dirent.isDirectory())
-  .map(dirent => dirent.name);
+    .readdirSync(directory, { withFileTypes: true })
+    .filter(dirent => dirent.isDirectory())
+    .map(dirent => dirent.name);
 }
 
 
@@ -616,9 +618,9 @@ export const getSubComponentsAndDir = async (directory, type) => {
   const prefix = type.replace("/", "") + "/";
 
   return fs
-  .readdirSync(subDirectory, { withFileTypes: true })
-  .filter(dirent => dirent.isDirectory())
-  .map(dirent => prefix + dirent.name);
+    .readdirSync(subDirectory, { withFileTypes: true })
+    .filter(dirent => dirent.isDirectory())
+    .map(dirent => prefix + dirent.name);
 }
 
 
@@ -768,73 +770,73 @@ export const validateRulesetVersion = str => {
 };
 
 export const showVersion = () => {
-    // get package version, so can display at start
-    const require = createRequire(import.meta.url);
-    const pData = require("@pega/dx-component-builder-sdk/package.json");
-
-    console.log(chalk.green("DX Component Builder - SDK v" + pData.version));
-
-    // do a check of node version, it should be 18 or greater
-    const arNodeVersion  = process.versions.node.split(".");
-
-    const nodeMajorVersion = parseInt(arNodeVersion[0]);
-    const nodeMinorVersion = parseInt(arNodeVersion[1]);
-    const nodePatchVersion = parseInt(arNodeVersion[2]);
-
-    if (nodeMajorVersion < 24) {
-      console.log(
-        chalk.redBright(
-          `DX Component Builder SDK - requires node v24.4.1 or greater, current version: ${process.version}`
-        )
-      );
-      process.exit(1);
-    }
-    else if ( nodeMajorVersion == 24 && nodeMinorVersion < 4) {
-      console.log(
-        chalk.redBright(
-          `DX Component Builder SDK - requires node v24.4.1 or greater, current version: ${process.version}`
-        )
-      );
-      process.exit(1);
-    }
-    else if (nodeMajorVersion == 24 && nodeMinorVersion == 4 && nodePatchVersion < 1 ) {
-      console.log(
-        chalk.redBright(
-          `DX Component Builder SDK - requires node v24.4.1 or greater, current version: ${process.version}`
-        )
-      );
-      process.exit(1);
-    }
+  // get package version, so can display at start
+  const require = createRequire(import.meta.url);
+  const pData = require("@pega/dx-component-builder-sdk/package.json");
+
+  console.log(chalk.green("DX Component Builder - SDK v" + pData.version));
+
+  // do a check of node version, it should be 18 or greater
+  const arNodeVersion = process.versions.node.split(".");
+
+  const nodeMajorVersion = parseInt(arNodeVersion[0]);
+  const nodeMinorVersion = parseInt(arNodeVersion[1]);
+  const nodePatchVersion = parseInt(arNodeVersion[2]);
+
+  if (nodeMajorVersion < 24) {
+    console.log(
+      chalk.redBright(
+        `DX Component Builder SDK - requires node v24.4.1 or greater, current version: ${process.version}`
+      )
+    );
+    process.exit(1);
+  }
+  else if (nodeMajorVersion == 24 && nodeMinorVersion < 4) {
+    console.log(
+      chalk.redBright(
+        `DX Component Builder SDK - requires node v24.4.1 or greater, current version: ${process.version}`
+      )
+    );
+    process.exit(1);
+  }
+  else if (nodeMajorVersion == 24 && nodeMinorVersion == 4 && nodePatchVersion < 1) {
+    console.log(
+      chalk.redBright(
+        `DX Component Builder SDK - requires node v24.4.1 or greater, current version: ${process.version}`
+      )
+    );
+    process.exit(1);
+  }
 };
 
-export const getJestFunctionalTestList = async(whichTests) => {
+export const getJestFunctionalTestList = async (whichTests) => {
   const frameWork = await getFramework();
   const SDK_PATH = frameWork === "SDK-Angular" ? "sdk-a" : "sdk-r";
   const functionalDir = join(path.resolve(), JEST_TESTS_FUNCTIONAL_PATH, SDK_PATH);
   const libFilter = "localLib";
 
   switch (whichTests) {
-    case "ALL" :
+    case "ALL":
       return fs
-      .readdirSync(functionalDir, { withFileTypes: true })
-      .filter(dirent => !dirent.isDirectory() )
-      .map(dirent => dirent.name);
+        .readdirSync(functionalDir, { withFileTypes: true })
+        .filter(dirent => !dirent.isDirectory())
+        .map(dirent => dirent.name);
     case "Original":
       return fs
-      .readdirSync(functionalDir, { withFileTypes: true })
-      .filter(dirent => !dirent.isDirectory() && !dirent.name.startsWith(libFilter))
-      .map(dirent => dirent.name);
-    case "Library" :
+        .readdirSync(functionalDir, { withFileTypes: true })
+        .filter(dirent => !dirent.isDirectory() && !dirent.name.startsWith(libFilter))
+        .map(dirent => dirent.name);
+    case "Library":
       return fs
-      .readdirSync(functionalDir, { withFileTypes: true })
-      .filter(dirent => !dirent.isDirectory() && dirent.name.startsWith(libFilter))
-      .map(dirent => dirent.name);
+        .readdirSync(functionalDir, { withFileTypes: true })
+        .filter(dirent => !dirent.isDirectory() && dirent.name.startsWith(libFilter))
+        .map(dirent => dirent.name);
   }
 
 
 }
 
-export const getStandaloneMaxComponentNameCount = async() => {
+export const getStandaloneMaxComponentNameCount = async () => {
   let count = MAX_RFT_CHARS;
   const configDef = await getComponentDefaults();
   const currentOrgLib = `${configDef.organization}_${configDef.library}`;
@@ -846,7 +848,7 @@ export const getStandaloneMaxComponentNameCount = async() => {
 
 }
 
-export const getStandaloneMaxLibraryCount = async(componentName) => {
+export const getStandaloneMaxLibraryCount = async (componentName) => {
 
   let count = MAX_RFT_CHARS;
   const configDef = await getComponentDefaults();
@@ -860,12 +862,12 @@ export const getStandaloneMaxLibraryCount = async(componentName) => {
 }
 
 
-export const getStandaloneMaxPrefixCount = async() => {
+export const getStandaloneMaxPrefixCount = async () => {
   // TwoColumnDetails is 16 chars
   return (await getStandaloneMaxComponentNameCount() - 16);
 }
 
-export const getStandaloneMaxLibraryFromPrefixCount = async(componentName) => {
+export const getStandaloneMaxLibraryFromPrefixCount = async (componentName) => {
   return (await getStandaloneMaxLibraryCount(componentName) - 16);
 }
 

package/tests/assets/sdk-a/components/create/custom-constellation/field/Pega_DXIL_MyTestText/PConnProps.d.ts

@@ -1,4 +1,4 @@
-import  {PConnect } from '@pega/pcore-pconnect-typedefs';
+import { PConnect } from '@pega/pcore-pconnect-typedefs';
 
 // PConnProps.d.ts
 // This gives us a place to have each component (which is most DX Components) that is
@@ -22,25 +22,24 @@ export interface PConnProps {
   // [key: string]: any;
 }
 
-
 // PConnFieldProps extends PConnProps to bring in the common properties that are
 // associated with most field components (ex: Dropdown, TextInput, etc.) in the
 //  components/field directory
 export interface PConnFieldProps extends PConnProps {
-  label: string,
-  required: boolean,
-  disabled: boolean,
-  value: any,
-  validatemessage: string,
-  status?: string,
-  onChange?: any,
-  onBlur?: any,
-  readOnly: boolean,
-  testId: string,
-  helperText: string,
-  displayMode?: string,
-  hideLabel: boolean,
-  placeholder?: string,
-  fieldMetadata?: any,
-  additionalProps?: any
+  label: string;
+  required: boolean;
+  disabled: boolean;
+  value: any;
+  validatemessage: string;
+  status?: string;
+  onChange?: any;
+  onBlur?: any;
+  readOnly: boolean;
+  testId: string;
+  helperText: string;
+  displayMode?: string;
+  hideLabel: boolean;
+  placeholder?: string;
+  fieldMetadata?: any;
+  additionalProps?: any;
 }