@pega/custom-dx-components 23.1.11 → 23.1.12

package/src/tasks/create/templates/Launchpad/Widget/CASE/index.tsx.mustache

@@ -1,6 +1,5 @@
 import { useState, useEffect } from 'react';
-import PropTypes from 'prop-types';
-import { Table, Text } from '@pega/cosmos-react-core';
+import { Table, Text, withConfiguration } from '@pega/cosmos-react-core';
 import type { PConnFieldProps } from './PConnProps';
 
 import Styled{{COMPONENT_CLASS_NAME}}Wrapper from './styles';
@@ -15,7 +14,7 @@ interface {{COMPONENT_CLASS_NAME}}Props extends PConnFieldProps {
 
 // 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, label } = props;
   const pConn = getPConnect();
   const [history, setHistory] = useState([]);
@@ -75,10 +74,5 @@ export default function {{COMPONENT_CLASS_NAME}}(props: {{COMPONENT_CLASS_NAME}}
 
 }
 
-{{COMPONENT_CLASS_NAME}}.defaultProps = {
 
-};
-
-{{COMPONENT_CLASS_NAME}}.propTypes = {
-  getPConnect: PropTypes.func.isRequired
-};
+export default withConfiguration({{COMPONENT_CLASS_NAME}});

package/src/tasks/create/templates/Launchpad/Widget/CASE/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/src/tasks/create/templates/Launchpad/Widget/PAGE-CASE/Avatar.tsx.mustache

@@ -1,7 +1,6 @@
 /* eslint-disable react-hooks/rules-of-hooks */
 import React from 'react';
 import { useEffect, useState } from 'react';
-import PropTypes from 'prop-types';
 import { Avatar as CosmosAvatar } from '@pega/cosmos-react-core';
 import type { PConnFieldProps } from './PConnProps';
 
@@ -15,7 +14,7 @@ interface {{COMPONENT_CLASS_NAME}}AvatarProps extends PConnFieldProps {
 }
 
 function Avatar(props: {{COMPONENT_CLASS_NAME}}AvatarProps) {
-  const { metaObj, showStatus } = props;
+  const { metaObj, showStatus = false } = props;
   const [imageBlobUrl, setImageBlobUrl] = useState(null);
   let userName: string;
   let userIdentifier: string;
@@ -75,14 +74,5 @@ function Avatar(props: {{COMPONENT_CLASS_NAME}}AvatarProps) {
   return <CosmosAvatar name={userName} imageSrc={imageBlobUrl as React.SetStateAction<any>} />;
 }
 
-Avatar.propTypes = {
-  metaObj: PropTypes.objectOf(PropTypes.any),
-  showStatus: PropTypes.bool
-};
-
-Avatar.defaultProps = {
-  metaObj: null,
-  showStatus: false
-};
 
 export default Avatar;

package/src/tasks/create/templates/Launchpad/Widget/PAGE-CASE/Operator.tsx.mustache

@@ -12,12 +12,12 @@ import {
 } from '@pega/cosmos-react-core';
 import { Glimpse } from '@pega/cosmos-react-work';
 import { EmailDisplay } from '@pega/cosmos-react-core';
-import PropTypes from 'prop-types';
 
 import type { PConnFieldProps } from './PConnProps';
 
 import Avatar from './Avatar';
 
+
 // interface for props
 interface {{COMPONENT_CLASS_NAME}}OperatorProps extends PConnFieldProps {
   // If any, enter additional props that only exist on TextInput here
@@ -36,7 +36,7 @@ export default function Operator(props: {{COMPONENT_CLASS_NAME}}OperatorProps) {
   const [isLoading, setIsLoading] = useState(true);
   const [popoverEl, setPopoverEl] = useElement(null);
   const [popoverContent, setpopoverContent] = useState(null);
-  const theme = useTheme();
+  const theme: any = useTheme();
 
   /* If the id has changed, we need to reset the popover */
   useEffect(() => {
@@ -48,8 +48,8 @@ export default function Operator(props: {{COMPONENT_CLASS_NAME}}OperatorProps) {
   {{=<% %>=}}
 
   const OperatorPreview = () => {
-    let localizedVal = PCore.getLocaleUtils().getLocaleValue;
-    let localeCategory = 'Operator';
+    const localizedVal = PCore.getLocaleUtils().getLocaleValue;
+    const localeCategory = 'Operator';
     setpopoverContent(
       <Progress variant='ring' message={localizedVal('Loading operator...', localeCategory)} placement='local' />
     );
@@ -89,56 +89,55 @@ export default function Operator(props: {{COMPONENT_CLASS_NAME}}OperatorProps) {
         />
       );
     } else {
-      localizedVal = PCore.getLocaleUtils().getLocaleValue;
-      localeCategory = 'Operator';
       return PCore.getUserApi()
         .getOperatorDetails(id, true)
         .then(res => {
           if (res.data?.data && res.data.data[0].BusinessID && res.data.data[0].Name) {
             const fields = [];
-            if (res.data.data[0].Name)
+            if (res.data.data[0].Name) {
               fields.push({
                 id: 'Name',
                 name: localizedVal('Name', localeCategory),
                 value: res.data.data[0].Name
               });
-            if (res.data.data[0].BusinessID)
+            }
+            if (res.data.data[0].BusinessID) {
               fields.push({
                 id: 'Email',
                 name: localizedVal('Email address', localeCategory),
                 value: <EmailDisplay value={res.data.data[0].BusinessID} />
               });
-
-              setIsLoading(false);
-              setpopoverContent(
-                <Glimpse
-                  heading={{
-                    primary: res.data.data[0].Name,
-                    secondary: res.data.data[0].BusinessID,
-                    visual: (
-                      <Avatar
-                        metaObj={{
-                          image: '',
-                          name: res.data.data[0].Name
-                        }}
-                      />
-                    )
-                  }}
-                  fields={fields}
-                  target={pTarget}
-                  onDismiss={() => {pTarget = null;})}
-                />
-              );
-
+            }
+            const opAvatar = (
+              <Avatar
+                metaObj={{
+                  image: '',
+                  name: res.data.data[0].Name
+                }}
+              />
+            );
+
+            setIsLoading(false);
+            setpopoverContent(
+              <Glimpse
+                heading={{
+                  primary: res.data.data[0].Name,
+                  secondary: res.data.data[0].BusinessID,
+                  visual: opAvatar
+                }}
+                fields={fields}
+                target={pTarget}
+                onDismiss={() => {pTarget = null;}}
+              />
+            );
           }
         });
-
     }
   };
 
   <%={{ }}=%>     {{! revert delimiters for mustache }}
 
-  const clickAction = (e: any) =>
+  const clickAction = (e: any) => {
 
     setIsOpen(!isOpen);
     if (pTarget === null) {
@@ -154,6 +153,7 @@ export default function Operator(props: {{COMPONENT_CLASS_NAME}}OperatorProps) {
   };
 
   useOuterEvent('mousedown', [popoverEl], hidePopover); // Call the method on clicking outside these elements
+
   const hideOnEscape = (e: any) => {
     if (e.key === 'Escape') hidePopover(); // Call the method when Escape key is pressed
   };
@@ -170,7 +170,7 @@ export default function Operator(props: {{COMPONENT_CLASS_NAME}}OperatorProps) {
           data-test-id={testId}
           style={label !== null ? { width: 'max-content', height: theme.components.input.height } : undefined}
         >
-          <Avatar {...props}></Avatar>
+          <Avatar {...props} />
         </Button>
       ) : (
         <Button
@@ -211,21 +211,3 @@ export default function Operator(props: {{COMPONENT_CLASS_NAME}}OperatorProps) {
 
   return comp;
 };
-
-Operator.propTypes = {
-  name: PropTypes.string,
-  id: PropTypes.string,
-  label: PropTypes.string,
-  testId: PropTypes.string,
-  helperText: PropTypes.string,
-  metaObj: PropTypes.object
-};
-
-Operator.defaultProps = {
-  name: '',
-  id: '',
-  label: null,
-  testId: null,
-  helperText: null,
-  metaObj: null
-};

package/src/tasks/create/templates/Launchpad/Widget/PAGE-CASE/demo.stories.tsx.mustache

@@ -1,17 +1,20 @@
 /* eslint-disable react/jsx-no-useless-fragment */
 // @ts-nocheck
-import { withKnobs } from '@storybook/addon-knobs';
+import type { Meta, StoryObj } from '@storybook/react';
 
 import {{COMPONENT_CLASS_NAME}} from './index';
 
 import { configProps, operatorDetails } from './mock';
 
-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 default meta;
+type Story = StoryObj<typeof {{COMPONENT_CLASS_NAME}}>;
+
 if (!window.PCore) {
   window.PCore = {};
 }
@@ -34,7 +37,7 @@ window.PCore.getUserApi = () => {
   };
 };
 
-export const Base{{COMPONENT_CLASS_NAME}} = () => {
+export const Base{{COMPONENT_CLASS_NAME}}: Story = args => {
 
   const props = {
     label: configProps.label,
@@ -70,7 +73,9 @@ export const Base{{COMPONENT_CLASS_NAME}} = () => {
 
 return (
     <>
-      <{{COMPONENT_CLASS_NAME}} {...props} />
+      <{{COMPONENT_CLASS_NAME}} {...props} {...args} />
     </>
   );
 };
+
+Base{{COMPONENT_CLASS_NAME}}.args = {};

package/src/tasks/create/templates/Launchpad/Widget/PAGE-CASE/index.tsx.mustache

@@ -1,6 +1,5 @@
 import { Fragment } from 'react';
-import { DateTimeDisplay, Card, CardHeader, CardContent, Flex } from '@pega/cosmos-react-core';
-import PropTypes from 'prop-types';
+import { DateTimeDisplay, Card, CardHeader, CardContent, Flex, withConfiguration } from '@pega/cosmos-react-core';
 import type { PConnFieldProps } from './PConnProps';
 
 // includes in bundle
@@ -21,12 +20,12 @@ interface {{COMPONENT_CLASS_NAME}}Props extends PConnFieldProps {
 
 // 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,
-    title,
-    label,
+    title = 'Create operator',
+    label = 'Create operator',
     createLabel,
     updateLabel
   } = props;
@@ -48,8 +47,22 @@ export default function {{COMPONENT_CLASS_NAME}}(props: {{COMPONENT_CLASS_NAME}}
       <CardContent>
 {{! pick new delimiters for mustache }} {{=<% %>=}}
       <Flex container={{ direction: 'row'}}>
-      <Operator label={_label} name={user} id={user} getPConnect={getPConnect} value={undefined} validatemessage='' hideLabel={false} readOnly={false} required={false} disabled={false} externalUser={undefined} />
-<%={{ }}=%>     {{! revert delimiters for mustache }}
+           <Operator
+              label={_label}
+              name={user}
+              id={user}
+              getPConnect={getPConnect}
+              value={undefined}
+              validatemessage=''
+              hideLabel={false}
+              readOnly={false}
+              required={false}
+              disabled={false}
+              externalUser={undefined}
+              testId=''
+              helperText=''
+              metaObj={undefined}
+            /><%={{ }}=%>     {{! revert delimiters for mustache }}
       {dateTimeValue && (
         <Fragment>
           {' '}
@@ -67,20 +80,8 @@ export default function {{COMPONENT_CLASS_NAME}}(props: {{COMPONENT_CLASS_NAME}}
 
 }
 
-{{COMPONENT_CLASS_NAME}}.defaultProps = {
-  "label": "Create operator",
-  "title": "Create operator",
-  createLabel: null,
-  updateLabel: null
-};
-
-{{COMPONENT_CLASS_NAME}}.propTypes = {
-  getPConnect: PropTypes.func.isRequired,
-  label: PropTypes.string,
-  title: PropTypes.string,
-  createLabel: PropTypes.string,
-  updateLabel: PropTypes.string
-};
+
+export default withConfiguration({{COMPONENT_CLASS_NAME}});
 
 // as objects are there in props, shallow comparision fails & re-rendering of comp happens even with
 // same key value pairs in obj. hence using custom comparison function on when to re-render

package/src/tasks/create/templates/Launchpad/Widget/PAGE-CASE/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/src/tasks/delete-all/helper.js

@@ -143,9 +143,26 @@ export const deleteServerComponents = async (sourceOfComponents, answers) => {
     ({library, organization} = lpAnswers);
   }
 
-  const spinner = ora('Fetching components from server').start();
-  const data = await getComponentsFromServer(library, organization);
-  spinner.stop();
+
+  let spinner;
+  let data;
+  try {
+    spinner = ora('Fetching components from server').start();
+    data = await getComponentsFromServer(library, organization);
+    spinner.stop();
+  }
+  catch (error) {
+    spinner.stop();
+    if (error.indexOf("ECONNREFUSED") >= 0) {
+      console.log(`\n${chalk.bold.red('Error occurred in authentication. Please regenerate using authenticate')}`);
+    }
+    else {
+      console.log(`${chalk.bold.red(error)}`);
+    }
+
+    // spinner.stop();
+    process.exit(1);
+  }
 
 
   // const serverComponents = isLaunchpad ? data : data.pxResults;
@@ -185,7 +202,13 @@ export const deleteServerComponents = async (sourceOfComponents, answers) => {
         const componentsList = serverComponents.map((component) => `${component.name}~|~`);
         for (const componentToDelete of componentsList) {
           // eslint-disable-next-line no-await-in-loop
-          await deleteLaunchpadServerComponent(componentToDelete);
+          try {
+            await deleteLaunchpadServerComponent(componentToDelete);
+          }
+          catch (err) {
+            console.log(chalk.bold.red(err.toString()));
+            process.exit(1);
+          }
         }
       }
     } else {
@@ -253,7 +276,16 @@ export const deleteServerComponents = async (sourceOfComponents, answers) => {
           const [name, rulesetName, rulesetVersion] = componentToDelete.split('~|~');
           if (rulesetName === selectedComp.rulesetName && rulesetVersion === selectedComp.rulesetVersion) {
             // eslint-disable-next-line no-await-in-loop
-            await deleteInfinityServerComponent(componentToDelete);
+
+            try {
+              await deleteInfinityServerComponent(componentToDelete);
+            }
+            catch (err) {
+              console.log(chalk.bold.red(err.toString()));
+              process.exit(1);
+            }
+
+
           }
         }
       }

package/src/tasks/init/template/.eslintignore

@@ -6,3 +6,9 @@ src/helpers/config_access.js
 *.md
 *.svg
 *.zip
+*.d.ts
+*.storybook/*
+*.cjs
+paths.js
+dist/*
+lib/*

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

@@ -8,14 +8,14 @@ This project provides you with an environment to extend Constellation by giving
 
 Ensure you have access to the following in your system:
 
-- Pega Infinity Server version 8.7 or later
+- Pega Infinity Server version 23 or later
 
 - 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-88/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/src/tasks/init/template/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/src/tasks/init/template/package.json.mustache

@@ -7,7 +7,7 @@
   "type": "module",
   "scripts": {
     "startStorybook": "storybook dev --port 6040 --quiet",
-    "lint": "run-p -cl lint:*",
+    "lint": "eslint .",
     "authenticate": "custom-dx-components authenticate",
     "buildComponent": "custom-dx-components buildComponent",
     "buildAllComponents": "custom-dx-components buildAllComponents",
@@ -23,16 +23,15 @@
     "deleteAll": "custom-dx-components deleteAll",
     "promoteWebPack": "custom-dx-components promoteWebPack",
     "revertWebPack": "custom-dx-components revertWebPack",
-    "lint:types": "tsc --noEmit",
-    "lint:es": "eslint .",
-    "lint:styles": "stylelint \"./**/*.@(js|jsx|ts|tsx)\"",
-    "lint:format": "prettier -c .",
-    "lint:spelling": "cspell --no-progress **/*",
-    "test": "echo 'Running functional and unit tests will DELETE existing local components, proceed (y/n)?' && read proceed && if test \"$proceed\" = \"y\"; then npm run test:full; fi ",
-    "test:full": "npm run test:functional && npm run test:unit",
-    "test:functional": "npm run test:functional:local --prefix node_modules/@pega/custom-dx-components",
-    "test-coverage": "node --input-type=module  --experimental-vm-modules node_modules/jest/bin/jest.js --runInBand node_modules/@pega/custom-dx-component --ci --testResultsProcessor='jest-junit' --coverage",
-    "test:unit": "npm run test:unit:local --prefix node_modules/@pega/custom-dx-components"
+    "_internal-test-coverage": "node --input-type=module  --experimental-vm-modules node_modules/jest/bin/jest.js --runInBand node_modules/@pega/custom-dx-component --ci --testResultsProcessor='jest-junit' --coverage",
+    "_internal-test": "echo 'Running functional and unit tests will DELETE existing local components, proceed (y/n)?' && read proceed && if test \"$proceed\" = \"y\"; then npm run _internal-test-full; fi ",
+    "_internal-test-full": "npm run _internal-test-functional && npm run _internal-test-unit",
+    "_internal-test-functional": "npm run test:functional:local --prefix node_modules/@pega/custom-dx-components",
+    "_internal-test-unit": "npm run test:unit:local --prefix node_modules/@pega/custom-dx-components",
+    "_lint:styles": "stylelint \"./**/*.@(js|jsx|ts|tsx)\"",
+    "_lint:format": "prettier -c .",
+    "_lint:spelling": "cspell --no-progress **/*",
+    "_lint:types": "tsc --noEmit"
   },
     "scriptsComments": {
     "build": "tsc -b tsconfig.build.json",
@@ -69,11 +68,10 @@
   },
   "devDependencies": {
     "@pega/configs": "^0.6.0",
-    "@pega/custom-dx-components": "23.1.11",
-    "@pega/pcore-pconnect-typedefs": "2.0.0",
+    "@pega/custom-dx-components": "23.1.12",
+    "@pega/pcore-pconnect-typedefs": "~2.1.1",
     "@storybook/addon-actions": "^7.6.7",
     "@storybook/addon-essentials": "^7.6.7",
-    "@storybook/addon-knobs": "^7.0.2",
     "@storybook/addon-links": "^7.6.7",
     "@storybook/addon-storysource": "^7.6.7",
     "@storybook/react": "^7.6.7",

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

@@ -34,5 +34,6 @@
     "subtype": "",
     "description": "",
     "icon": ""
-  }
+  },
+  "usePromotedWebPack": false
 }

package/src/tasks/linter/index.js

@@ -15,12 +15,15 @@ export const lintComponent = async (dirToLint) => {
   const formatter = await eslint.loadFormatter("stylish");
   const resultText = formatter.format(results);
 
-  // 4. Output it.
-  // console.log(`lint resultText: ${resultText}`);
-  console.log(resultText);
-
   // Indicate linting is complete
   console.log(chalk.green(` linting complete...`));
+
+  if (resultText.length > 0 && resultText.indexOf("error") >= 0) {
+    throw new Error( "Lint:\n" + resultText );
+  }
+  else {
+    console.log(resultText);
+  }
 };
 
 // inpsired by https://eslint.org/docs/latest/developer-guide/nodejs-api

package/src/tasks/list/helper.js

@@ -102,6 +102,15 @@ async function fetchComponentsFromInfinity(apiUrl, headers) {
     })
       .then((response) => {
         status = response.status;
+        if (status === 404){
+          throw new Error('404: Server resource not found');
+        }
+        else if (status === 405){
+          throw new Error('405: Server method not allowed');
+        }
+        else if (status === 408){
+          throw new Error('408: Server timed out');
+        }
         return response.json();
       })
       .then((resp) => {
@@ -122,6 +131,7 @@ async function fetchComponentsFromInfinity(apiUrl, headers) {
 }
 
 async function fetchComponentsFromLaunchpad(apiUrl, headers) {
+
   const serverConfig = await getPegaServerConfig();
   // constructing urls for all type of components
   const urls = COMPONENT_SCHEMA.type.map((type) => apiUrl.replace('{type}', type.value));

package/src/tasks/list/index.js

@@ -1,5 +1,6 @@
 import inquirer from 'inquirer';
 import ora from 'ora';
+import chalk from 'chalk';
 
 import { showVersion, getPegaServerConfig } from '../../util.js';
 
@@ -35,9 +36,25 @@ const getList = async (sourceOfComponents, answers) => {
 
 
       const spinner = ora('Fetching components from server\n').start();
-      const data = await getComponentsFromServer(library, organization);
-      spinner.stop();
-      await displayServerComponents(data, answers);
+
+      try {
+        const data = await getComponentsFromServer(library, organization);
+        spinner.stop();
+        await displayServerComponents(data, answers);
+      }
+      catch (error) {
+
+        if (error.indexOf("ECONNREFUSED") >= 0) {
+          console.log(`\n${chalk.bold.red('Error occurred in authentication. Please regenerate using authenticate')}`);
+        }
+        else {
+          console.log(`${chalk.bold.red(error)}`);
+        }
+
+        // spinner.stop();
+        process.exit(1);
+      }
+
 
       break;
     }