@pega/custom-dx-components 23.1.11 → 23.1.13

package/README.md

@@ -12,10 +12,10 @@ Ensure you have access to the following in your system:
 
 - Git version 2.30 or later
 
-- System node version 18
+- System node version 18, 20
 
-- System npm version 8
+- System npm version 8, 10 (9 is not supported)
 
 ## Latest Documentation
 
-Find the latest documentation on using **DX Component Builder** [here](https://docs.pega.com/bundle/constellation-dx-components/page/constellation-dx-components/custom-components/lifecycle-dx-cosmos-components.html)
+Find the latest documentation on using **DX Component Builder** [here](https://docs.pega.com/bundle/constellation-dx-components/page/constellation-dx-components/custom-components/whats-new-constellation-dx-components-pega-infinity-23.html)

package/SECURITY.md

@@ -0,0 +1,10 @@
+# Reporting Security Issues
+
+Pegasystems takes security seriously. We appreciate your efforts to responsibly disclose your findings, and will make every effort to acknowledge your contributions.
+
+To report a security issue, [email us](mailto:opensource@pega.com;security@pega.com) and include the word "SECURITY" in the subject line.
+
+The Pega team will send a response indicating the next steps in handling your report. We may ask for additional information or guidance.
+
+## Learning More About Security
+To learn more about securing a Pega application or our security capabilities, please see the [security article](https://community.pega.com/knowledgebase/capabilities/security) on Pega Community and the [Pega Trust Center](https://www.pega.com/products/cloud/pega-trust-center).

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pega/custom-dx-components",
-  "version": "23.1.11",
+  "version": "23.1.13",
   "description": "Utility for building custom UI components",
   "bin": "./bin/index.js",
   "scripts": {

package/src/cli.js

@@ -18,7 +18,8 @@ import {
   promoteWebPack,
   updateComponent,
   validate,
-  upgrade
+  upgrade,
+  buildJestAssets
 } from './tasks/index.js';
 
 const TASKS = {
@@ -36,9 +37,10 @@ const TASKS = {
   VALIDATE_SCHEMA: 'validateSchema',
   UPDATE: 'update',
   DELETE: 'delete',
-  DELETE_ALL: "deleteAll",
+  DELETE_ALL: 'deleteAll',
   AUTHENTICATE: 'authenticate',
-  UPGRADE: 'upgrade'
+  UPGRADE: 'upgrade',
+  BUILD_JEST_ASSETS: 'buildJestAssets'
 };
 
 const parseArgumentsIntoOptions = rawArgs => {
@@ -132,6 +134,10 @@ export default async (args = []) => {
       upgrade(options);
       break;
     }
+    case TASKS.BUILD_JEST_ASSETS: {
+      buildJestAssets(options);
+      break;
+    }
     default: {
       console.log(chalk.red(`No task matched with ${task}`));
       break;

package/src/constants.js

@@ -4,6 +4,7 @@ export const PACKAGE_JSON_FILENAME = 'package.json';
 export const BUILD_CONFIG_JSON_FILENAME = 'build.config.json';
 export const WEBPACK_CONFIG_JS_FILENAME = 'webpack.config.js';
 export const WEBPACK_PATHS_JS_FILENAME = 'paths.js';
+export const USE_PROMOTED_WEB_PACK = 'usePromotedWebPack';
 export const COMPONENTS_DIRECTORY_PATH = 'components-directory-path';
 export const COMPONENTS_PATH = 'component';
 export const TOKEN_PATH = 'node_modules/@pega/custom-dx-components/.access_token';
@@ -38,6 +39,11 @@ export const BUILDER_DIR_FILE_PATH = '../bundle/builder';
 
 export const CATEGORY_CONSTELLATION = 'constellation';
 
+export const JEST_ASSETS_PATH = 'node_modules/@pega/custom-dx-components/tests/assets/components/';
+export const JEST_CREATE_PATH = 'create/';
+export const JEST_CREATE_ALL_CONSTELLATION_PATH = 'createAll/Constellation/';
+export const JEST_CREATE_ALL_LAUNCHPAD_PATH = 'createAll/Launchpad';
+
 export const AUTHENTICATE_DEFAULTS = {
   serverType: 'infinity',
   server: 'https://localhost:1080/prweb',

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

@@ -9,9 +9,7 @@ import { getComponentDirectoryPath, showVersion, getComponents } from '../../uti
 
 import { getBuildComponentQuestions, cleanUp } from './helper.js';
 
-
 export function getCustomTasks(componentKey, sourceMap, devBuild, options) {
-
   const sDevBuild = devBuild ? '(dev build)' : '';
   return new Listr(
     [
@@ -35,50 +33,37 @@ export function getCustomTasks(componentKey, sourceMap, devBuild, options) {
         skip: () => (options.skipBundle ? 'Skipped bundling component' : undefined)
       }
     ],
-    {
-      exitOnError: true
-    }
+    { concurrent: false, exitOnError: true }
   );
-
-
 }
 
-
-
-
-export default async (options) => {
+export default async options => {
   showVersion();
 
-
   const components = await getComponents();
   let sourceMap;
   let devBuild;
 
   if (options.params.length >= 4) {
     const dBuild = options.params[3];
-    devBuild = (dBuild === 'Y' ||
-    dBuild === 'y' ||
-    dBuild === true ||
-    dBuild === 'true') ? true : false;
-  }
-  else {
+    devBuild = !!(dBuild === 'Y' || dBuild === 'y' || dBuild === true || dBuild === 'true');
+  } else {
     const questions = await getBuildComponentQuestions();
     const answers = await inquirer.prompt(questions);
     ({ sourceMap, devBuild } = answers);
   }
 
-
-  for (const componentKey of components) {
+  for await (const componentKey of components) {
     console.log(chalk.bold.green(`Building ${componentKey}`));
 
-    const myCustomTasks = getCustomTasks(componentKey, sourceMap, devBuild, options );
+    const myCustomTasks = getCustomTasks(componentKey, sourceMap, devBuild, options);
 
-    // eslint-disable-next-line no-await-in-loop
-    await myCustomTasks.run().catch(err => {
+    try {
+      await myCustomTasks.run();
+    } catch (err) {
       console.log(chalk.bold.red(err.toString()));
       process.exit(1);
-    });
-
+    }
   }
 
   // once done, remove leftover directories

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

@@ -71,6 +71,7 @@ export default async options => {
 
   await tasks.run().catch(err => {
     console.log(chalk.bold.red(err.toString()));
+    process.exit(1);
   });
   return true;
 };

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

@@ -0,0 +1,171 @@
+import fs from 'fs';
+import path from 'path';
+import { join } from 'path';
+import inquirer from 'inquirer';
+import { Listr } from 'listr2';
+import chalk from 'chalk';
+
+import { showVersion, getServerType, setServerType, getSubComponents, deleteLocalComponent, checkPathAccess, getComponents } from '../../util.js';
+import createAll from '../create-all/index.js';
+import create from '../create/index.js';
+
+import { JEST_ASSETS_PATH, JEST_CREATE_PATH, JEST_CREATE_ALL_CONSTELLATION_PATH, JEST_CREATE_ALL_LAUNCHPAD_PATH, TASKS_CONFIG_JSON_FILENAME, COMPONENTS_DIRECTORY_PATH } from '../../constants.js';
+
+
+const getBuildAssetsQuestions = async ()  => {
+  const message = "\n**IMPORTANT** Building Jest Assets will remove any local components in your components directory!\n";
+  console.log(`${chalk.green.bold(message)}`);
+
+  return [
+    {
+      name: 'buildAssets',
+      type: 'confirm',
+      message: 'Generate Jest Assets ?',
+      default: false
+    }
+  ];
+};
+
+const deleteTestComponent = async(path, componentKey) => {
+  const directory = join(path, componentKey);
+
+  try {
+    fs.rmSync(directory, { recursive: true });
+    console.log(`${chalk.red.bold(componentKey)} is deleted from assets`);
+  } catch (err) {
+    console.log('no file');
+    throw new Error(`No such file ${componentKey}`);
+  }
+}
+
+const copyAssets = async(destinationPath) => {
+  const currentDirectory = process.cwd();
+  const pegaConfigJsonPath = join(currentDirectory, TASKS_CONFIG_JSON_FILENAME);
+
+  await checkPathAccess(pegaConfigJsonPath);
+
+  let data = fs.readFileSync(pegaConfigJsonPath, { encoding: 'utf8' });
+  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 srcDir = join(currentDirectory, data[COMPONENTS_DIRECTORY_PATH]);
+
+  fs.cpSync(srcDir, destinationPath, { recursive: true});
+}
+
+const deleteAssets = async() => {
+  const currentDirectory = process.cwd();
+  const pegaConfigJsonPath = join(currentDirectory, TASKS_CONFIG_JSON_FILENAME);
+
+  await checkPathAccess(pegaConfigJsonPath);
+
+  let data = fs.readFileSync(pegaConfigJsonPath, { encoding: 'utf8' });
+  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 localComponents = await getComponents();
+
+  for (const index in localComponents) {
+    const componentToDelete = localComponents[index];
+    // console.log(chalk.bold.green("Deleting: " + componentToDelete));
+    // eslint-disable-next-line no-await-in-loop
+    const directory = join(currentDirectory, data[COMPONENTS_DIRECTORY_PATH], componentToDelete);
+
+    try {
+      fs.rmSync(directory, { recursive: true });
+      console.log(`${chalk.red.bold(componentToDelete)} is deleted from Local`);
+    } catch (err) {
+        console.log('no file');
+        throw new Error(`No such file ${componentToDelete}`);
+    }
+  }
+}
+
+const createJestAssets = async(isLaunchPad = false) => {
+
+  // initially delete local assets
+  await deleteAssets();
+
+  // const framework = await getFramework();
+  let args  = [ '','', '', 'My', '0.0.1', 'DXIL', '', 'Pega'];
+  let myOptions = {};
+  myOptions["params"] = args;
+
+  await createAll(myOptions);
+
+  const jestCreateAllPath = isLaunchPad ? JEST_CREATE_ALL_LAUNCHPAD_PATH : JEST_CREATE_ALL_CONSTELLATION_PATH;
+
+  // goto Constellation
+  // get current test assets and delete them
+  let createAllPath = path.join(path.resolve(), JEST_ASSETS_PATH, jestCreateAllPath);
+  const fileList = await getSubComponents(createAllPath, '');
+
+  for (const index in fileList) {
+    const componentToDelete = fileList[index];
+    // console.log(chalk.bold.green("Deleting: " + componentToDelete));
+    // eslint-disable-next-line no-await-in-loop
+    await deleteTestComponent(createAllPath, componentToDelete);
+  }
+
+  await copyAssets(createAllPath);
+  await deleteAssets();
+
+  args  = [ '','', '', 'Field', 'Text', 'MyTestText', 'My Test Text', '0.0.1','DXIL', '', 'My Test Text Description', 'Pega'];
+  myOptions = {};
+  myOptions["params"] = args;
+
+  await create(myOptions);
+
+  let createPath = path.join(path.resolve(), JEST_ASSETS_PATH, JEST_CREATE_PATH);
+  const myFileList = await getSubComponents(createPath, '');
+
+  for (const index in myFileList) {
+    const componentToDelete = myFileList[index];
+    // console.log(chalk.bold.green("Deleting: " + componentToDelete));
+    // eslint-disable-next-line no-await-in-loop
+    await deleteTestComponent(createPath, componentToDelete);
+  }
+
+  await copyAssets(createPath);
+  await deleteAssets();
+}
+
+
+export default async options => {
+  showVersion();
+
+  const questions = await getBuildAssetsQuestions();
+  const answers = await inquirer.prompt(questions);
+  const {  buildAssets } = answers;
+
+  if (buildAssets) {
+    // get current server type
+    const savedServerType = await getServerType();
+
+    // Constellation
+    await setServerType("infinity");
+    await createJestAssets(false);
+
+    //Launchpad
+    await setServerType("launchpad");
+    await createJestAssets(true);
+
+
+    // restore serverType
+    await setServerType(savedServerType);
+  }
+
+
+
+};

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

@@ -3,12 +3,15 @@ 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';
 
 
+const usePromoted = await getUseWebPackPromotion();
 // used by promote and revert webPack commands, do not change
-import configFactory from './webpack.config.js';
-// import configFactory from '../../../../../../../webpack.config.js';
-// do not change
+const configFactory = (
+  await import(`${usePromoted ? `../../../../../../../webpack.config.js` : `./webpack.config.js`}`)
+).default
+
 
 import paths from './paths.js';
 

package/src/tasks/create/templates/Constellation/Field/Boolean/Boolean.ts.mustache

@@ -0,0 +1,35 @@
+function Boolean(value: any, { allowEmpty = true, tick = '', cross = '' } = {}) {
+  if (
+    (!allowEmpty && !value) ||
+    value === false ||
+    value?.toString()?.toLowerCase() === 'false' ||
+    value === 0 ||
+    value === '0'
+  ) {
+    return cross || '';
+  }
+  if (
+    value === true ||
+    value?.toString()?.toLowerCase() === 'true' ||
+    value === 1 ||
+    value === '1'
+  ) {
+    return tick || '';
+  }
+  if (
+    allowEmpty &&
+    (value === 'null' || value === '' || value === null || typeof value === 'undefined')
+  ) {
+    return '––';
+  }
+  return value;
+}
+
+export default {
+  TrueFalse: (value: any, options: Object) =>
+    Boolean(value, {
+      ...options,
+      tick: 'True',
+      cross: 'False'
+    })
+};

package/src/tasks/create/templates/Constellation/Field/Boolean/demo.stories.tsx.mustache

@@ -2,19 +2,22 @@
 /* eslint-disable react/jsx-no-useless-fragment */
 // @ts-nocheck
 import { useState } from 'react';
-import { withKnobs } from '@storybook/addon-knobs';
+import type { Meta, StoryObj } from '@storybook/react';
 
 import { configProps, stateProps } from './mock';
 
 import {{COMPONENT_CLASS_NAME}} from './index';
 
-export default {
+const meta: Meta<typeof {{COMPONENT_CLASS_NAME}}> = {
   title: '{{COMPONENT_CLASS_NAME}}',
-  decorators: [withKnobs],
-  component: {{COMPONENT_CLASS_NAME}}
+  component: {{COMPONENT_CLASS_NAME}},
+  excludeStories: /.*Data$/
 };
 
-export const Base{{COMPONENT_CLASS_NAME}} = () => {
+export default meta;
+type Story = StoryObj<typeof {{COMPONENT_CLASS_NAME}}>;
+
+export const Base{{COMPONENT_CLASS_NAME}}: Story = args => {
 
   const [value, setValue] = useState(configProps.value);
 
@@ -58,7 +61,21 @@ export const Base{{COMPONENT_CLASS_NAME}} = () => {
 
   return (
     <>
-      <{{COMPONENT_CLASS_NAME}} {...props} />
+      <{{COMPONENT_CLASS_NAME}} {...props} {...args} />
     </>
   );
 };
+
+Base{{COMPONENT_CLASS_NAME}}.args = {
+  label: configProps.label,
+  helperText: configProps.helperText,
+  caption: configProps.caption,
+  testId: configProps.testId,
+  readOnly: configProps.readOnly,
+  disabled: configProps.disabled,
+  required: configProps.required,
+  status: configProps.status,
+  hideLabel: configProps.hideLabel,
+  displayMode: configProps.displayMode,
+  validatemessage: configProps.validatemessage
+};

package/src/tasks/create/templates/Constellation/Field/Boolean/index.tsx.mustache

@@ -2,10 +2,9 @@ import {
   Checkbox as CosmosCheckbox,
   CheckboxGroup,
   FieldValueList,
-  Text
+  Text,
+  withConfiguration
 } from "@pega/cosmos-react-core";
-import PropTypes from "prop-types";
-
 
 import type { PConnFieldProps } from './PConnProps';
 
@@ -40,19 +39,19 @@ interface ActionsProps {
 
 // props passed in combination of props from property panel (config.json) and run time props from Constellation
 // any default values in config.pros should be set in defaultProps at bottom of this file
-export default function {{COMPONENT_CLASS_NAME}}(props: {{COMPONENT_CLASS_NAME}}Props) {
+function {{COMPONENT_CLASS_NAME}}(props: {{COMPONENT_CLASS_NAME}}Props) {
   const {
     getPConnect,
-    value,
-    label,
-    helperText,
+    value = false,
+    label = '',
+    helperText = '',
     caption,
     validatemessage,
     hideLabel,
     testId,
-    additionalProps,
+    additionalProps = {},
     displayMode,
-    variant,
+    variant = 'inline',
     trueLabel,
     falseLabel
   } = props;
@@ -62,7 +61,7 @@ export default function {{COMPONENT_CLASS_NAME}}(props: {{COMPONENT_CLASS_NAME}}
   const stateProps = pConn.getStateProps() as StateProps;
   const propName: string = stateProps.value;
 
-  let { readOnly, required, disabled } = props;
+  let { readOnly = false, required = false, disabled = false } = props;
   [readOnly, required, disabled] = [readOnly, required, disabled].map(
     (prop) => prop === true || (typeof prop === 'string' && prop === 'true')
   );
@@ -105,7 +104,7 @@ export default function {{COMPONENT_CLASS_NAME}}(props: {{COMPONENT_CLASS_NAME}}
   }
 
   if (displayMode === 'DISPLAY_ONLY') {
-    return ( <Styled{{COMPONENT_CLASS_NAME}}Wrapper> displayComponent </Styled{{COMPONENT_CLASS_NAME}}Wrapper>);
+    return ( <Styled{{COMPONENT_CLASS_NAME}}Wrapper> {displayComponent} </Styled{{COMPONENT_CLASS_NAME}}Wrapper>);
   }
 
   if (displayMode === "LABELS_LEFT") {
@@ -161,40 +160,4 @@ export default function {{COMPONENT_CLASS_NAME}}(props: {{COMPONENT_CLASS_NAME}}
 };
 
 
-{{COMPONENT_CLASS_NAME}}.defaultProps = {
-  validatemessage: '',
-  value: false,
-  label: '',
-  hideLabel: false,
-  helperText: '',
-  disabled: false,
-  readOnly: false,
-  required: false,
-  testId: '',
-  additionalProps: {},
-  displayMode: null,
-  variant: 'inline',
-  displayValue: 'Yes/No',
-  trueLabel: '',
-  falseLabel: ''
-};
-
-{{COMPONENT_CLASS_NAME}}.propTypes = {
-  getPConnect: PropTypes.func.isRequired,
-  validatemessage: PropTypes.string,
-  label: PropTypes.string,
-  hideLabel: PropTypes.bool,
-  helperText: PropTypes.string,
-  value: PropTypes.bool,
-  caption: PropTypes.string.isRequired,
-  disabled: PropTypes.oneOfType([PropTypes.bool, PropTypes.string]),
-  readOnly: PropTypes.oneOfType([PropTypes.bool, PropTypes.string]),
-  required: PropTypes.oneOfType([PropTypes.bool, PropTypes.string]),
-  testId: PropTypes.string,
-  additionalProps: PropTypes.objectOf(PropTypes.any),
-  displayMode: PropTypes.string,
-  variant: PropTypes.string,
-  displayValue: PropTypes.string,
-  trueLabel: PropTypes.string,
-  falseLabel: PropTypes.string
-};
+export default withConfiguration({{COMPONENT_CLASS_NAME}});

package/src/tasks/create/templates/Constellation/Field/Boolean/mock.ts.mustache

@@ -14,7 +14,8 @@ export const configProps = {
   falseLabel: 'False',
   disabled: false,
   readOnly: false,
-  required: true
+  required: true,
+  status: ''
 };
 
 export const stateProps = {

package/src/tasks/create/templates/Constellation/Field/Boolean/styles.ts.mustache

@@ -1,15 +1,8 @@
-
-// utilizing theming, comment out, if want individual style
-import styled from 'styled-components';
-import { Configuration } from '@pega/cosmos-react-core';
-
-export default styled(Configuration)``;
-
 // individual style, comment out above, and uncomment here and add styles
-// import styled, { css } from 'styled-components';
-//
-// export default styled.div(() => {
-//  return css`
-//    margin: 0px 0;
-//  `;
-// });
+import styled, { css } from 'styled-components';
+
+export default styled.div(() => {
+  return css`
+    margin: 0px 0;
+  `;
+});

package/{tests/assets/components/createAll/Launchpad/Pega_DXIL_MyDate/DateFormatter.js → src/tasks/create/templates/Constellation/Field/Date/DateFormatter.ts.mustache}

@@ -15,8 +15,8 @@ const types = ['fromNow', 'customFormat'];
 
 // value should be in ISO 8601 format.
 function DateFormatter(
-  value,
-  { type = types[1], format = "DD/MM/YYYY", tzone } = {}
+  value: any,
+  { type = types[1], format = "DD/MM/YYYY", tzone = null } = {}
 ) {
   if (!value) return value;
   switch (type) {
@@ -31,7 +31,7 @@ function DateFormatter(
 }
 
 // value should be in hh:mm:ss format (00:00:00 - 23:59:59).
-function TimeFormatter(value, options) {
+function TimeFormatter(value: any, options: any) {
   if (!value) return value;
   const { locale = "en-US" } = options;
   const timeOnlyRegex = /^(?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d)$/;
@@ -49,10 +49,10 @@ function TimeFormatter(value, options) {
 }
 
 export default {
-  Date: (value, options) => DateFormatter(value, { type: 'customFormat', ...options }),
-  'Date-Time-Default': (value, options) =>
+  Date: (value: any, options: any) => DateFormatter(value, { type: 'customFormat', ...options }),
+  'Date-Time-Default': (value: any, options: any) =>
     DateFormatter(value, { ...options, type: 'customFormat', format: 'lll' }),
-  'Time-Default': (value, options) =>
+  'Time-Default': (value: any, options: any) =>
     TimeFormatter(value, {
       ...options,
       type: 'customFormat',

package/src/tasks/create/templates/Constellation/Field/Date/FormattedText.tsx.mustache

@@ -0,0 +1,20 @@
+import { FieldValueList } from '@pega/cosmos-react-core';
+
+import { format } from './date';
+
+export default function FormattedText(props: any) {
+  const { formatType = 'none', label, value, testId, hideLabel, variant = 'stacked', additionalProps = {} } = props;
+
+  let text = value;
+
+  text = format(text, formatType, additionalProps);
+
+  const fields = [
+    {
+      id: label.toLowerCase(),
+      name: hideLabel ? '' : label,
+      value: text
+    }
+  ];
+  return <FieldValueList variant={variant} fields={fields} data-testid={testId} />;
+}

package/{tests/assets/components/createAll/Constellation/Pega_DXIL_MyDate/date.js → src/tasks/create/templates/Constellation/Field/Date/date.ts.mustache}

@@ -1,6 +1,6 @@
-/* eslint-disable no-undef */
+// @ts-nocheck
 import dayjs from 'dayjs';
-import DateFormatter from './DateFormatter.js';
+import DateFormatter from './DateFormatter';
 
 import relativeTime from 'dayjs/plugin/relativeTime.js';
 import localizedFormat from 'dayjs/plugin/localizedFormat.js';