@pega/dx-component-builder-sdk 23.1.15 → 24.1.10

package/README.md

@@ -8,13 +8,13 @@ This project provides you with an environment to extend SDK-R/SDK-A by giving yo
 
 Ensure you have access to the following in your system:
 
-- Pega Infinity Server version 23
+- Pega Infinity Server version 24.1
 
 - Git version 2.30 or later
 
-- System node version 18
+- System node version 18, 20
 
-- System npm version 8
+- System npm version 8, 10 (npm 9 not supported)
 
 - Installed SDK-R or SDK-A, as the below commands live in the package.json of the SDK-R/SDK-A an NOT in this npm module
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pega/dx-component-builder-sdk",
-  "version": "23.1.15",
+  "version": "24.1.10",
   "description": "Utility for building custom UI components",
   "bin": "./bin/index.js",
   "scripts": {

package/src/cli.js

@@ -41,7 +41,7 @@ const TASKS = {
   VALIDATE_SCHEMA: 'validateSchema',
   UPDATE: 'update',
   DELETE: 'delete',
-  DELETE_ALL: "deleteAll",
+  DELETE_ALL: 'deleteAll',
   AUTHENTICATE: 'authenticate',
   UPGRADE: 'upgrade',
   SCAN_AND_FIX: 'scanAndFix'

package/src/constants.js

@@ -164,6 +164,10 @@ export const COMPONENT_SCHEMA = {
         name: 'URL',
         value: 'Text-URL'
       },
+      {
+        name: 'Icon Button URL',
+        value: 'Icon-Button-URL'
+      },
       {
         name: 'Integer',
         value: 'Integer'

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

@@ -71,11 +71,17 @@ export const zipComponent = async (componentKey, category = CATEGORY_CUSTOM) =>
   const srcDirectory = await getComponentDirectoryPath(componentKey, category);
   const buildDirectory = await path.join(path.resolve(), 'dist/components', componentKey);
   const configJson = `${srcDirectory}/config.json`;
+  const localizationJson = `${srcDirectory}/localizations.json`;
 
   const zip = new AdmZip();
 
   zip.addLocalFolder(srcDirectory, 'src/');
   zip.addLocalFile(configJson);
+
+  if (fs.existsSync(localizationJson)) {
+    zip.addLocalFile(localizationJson);
+  }
+
   zip.addLocalFolder(buildDirectory);
   const zipContent = zip.toBuffer().toString('base64');
 

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

@@ -89,11 +89,17 @@ export const zipComponent = async (componentKey, category = CATEGORY_CUSTOM) =>
   const srcDirectory = await getComponentDirectoryPath(componentKey, category);
   const buildDirectory = await path.join(path.resolve(), 'dist/components', componentKey);
   const configJson = `${srcDirectory}/config.json`;
+  const localizationJson = `${srcDirectory}/localizations.json`;
 
   const zip = new AdmZip();
 
   zip.addLocalFolder(srcDirectory, 'src/');
   zip.addLocalFile(configJson);
+
+  if (fs.existsSync(localizationJson)) {
+    zip.addLocalFile(localizationJson);
+  }
+
   zip.addLocalFolder(buildDirectory);
   const zipContent = zip.toBuffer().toString('base64');
 

package/src/tasks/bundle/builderAngular/webpack.config.js

@@ -266,7 +266,7 @@ export default (
             {
               test: /\.(map)$/,    /* latest react-sdk-components needs to ignore compiling .d.ts and .map files */
               loader: 'null-loader',
-            }, 
+            },
             // "file" loader makes sure those assets get served by WebpackDevServer.
             // When you `import` an asset, you get its (virtual) filename.
             // In production, they would get copied to the `build` folder.
@@ -330,6 +330,19 @@ export default (
         contextRegExp: /@pega\\cosmos-react-core\\lib\\components\\Icon$/
       }),
 
+      /* cosmos 6.x and above */
+      /* Ignore cosmos icons */
+      new webpack.IgnorePlugin({
+        resourceRegExp: /^\.\/.*\/.*\.icon$/,
+        contextRegExp: /@pega\/cosmos-react-core\/lib\/components\/Icon$/
+      }),
+
+      /* Ignore cosmos icons - windows */
+      new webpack.IgnorePlugin({
+        resourceRegExp: /^\.\/.*\/.*\.icon$/,
+        contextRegExp: /@pega\\cosmos-react-core\\lib\\components\\Icon$/
+      }),
+
       new webpack.optimize.LimitChunkCountPlugin({
         maxChunks: 1
       }),

package/src/tasks/bundle/builderAssociated/webpack.config.js

@@ -318,6 +318,19 @@ export default (
         contextRegExp: /@pega\\cosmos-react-core\\lib\\components\\Icon$/
       }),
 
+      /* cosmos 6.x and above */
+      /* Ignore cosmos icons */
+      new webpack.IgnorePlugin({
+        resourceRegExp: /^\.\/.*\/.*\.icon$/,
+        contextRegExp: /@pega\/cosmos-react-core\/lib\/components\/Icon$/
+      }),
+
+      /* Ignore cosmos icons - windows */
+      new webpack.IgnorePlugin({
+        resourceRegExp: /^\.\/.*\/.*\.icon$/,
+        contextRegExp: /@pega\\cosmos-react-core\\lib\\components\\Icon$/
+      }),
+
       new webpack.optimize.LimitChunkCountPlugin({
         maxChunks: 1
       }),

package/src/tasks/bundle/builderReact/webpack.config.js

@@ -262,7 +262,7 @@ export default (
             {
               test: /\.(map)$/,    /* latest react-sdk-components needs to ignore compiling .d.ts and .map files */
               loader: 'null-loader',
-            }, 
+            },
             // "file" loader makes sure those assets get served by WebpackDevServer.
             // When you `import` an asset, you get its (virtual) filename.
             // In production, they would get copied to the `build` folder.
@@ -326,6 +326,19 @@ export default (
         contextRegExp: /@pega\\cosmos-react-core\\lib\\components\\Icon$/
       }),
 
+            /* cosmos 6.x and above */
+      /* Ignore cosmos icons */
+      new webpack.IgnorePlugin({
+        resourceRegExp: /^\.\/.*\/.*\.icon$/,
+        contextRegExp: /@pega\/cosmos-react-core\/lib\/components\/Icon$/
+      }),
+
+      /* Ignore cosmos icons - windows */
+      new webpack.IgnorePlugin({
+        resourceRegExp: /^\.\/.*\/.*\.icon$/,
+        contextRegExp: /@pega\\cosmos-react-core\\lib\\components\\Icon$/
+      }),
+
       new webpack.optimize.LimitChunkCountPlugin({
         maxChunks: 1
       }),

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

@@ -3,7 +3,8 @@ import {
   CheckboxGroup,
   FieldValueList,
   Text,
-  withConfiguration
+  withConfiguration,
+  BooleanDisplay
 } from "@pega/cosmos-react-core";
 
 import type { PConnFieldProps } from './PConnProps';
@@ -99,7 +100,7 @@ function {{COMPONENT_CLASS_NAME}}(props: {{COMPONENT_CLASS_NAME}}Props) {
     // @ts-ignore
     displayComponent = (
       // @ts-ignore
-      <{{COMPONENT_CLASS_NAME}} value={value} trueLabel={trueLabel} falseLabel={falseLabel} />
+      <BooleanDisplay value={value} trueLabel={trueLabel} falseLabel={falseLabel} />
     );
   }
 

package/src/tasks/create/templates/Constellation/field/Icon-Button-URL/PConnProps.d.ts.mustache

@@ -0,0 +1,46 @@
+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
+//  expected to have a getPConnect extend its props (from BaseProps)
+//  such that every component will be expected to have a getPConnect() function
+//  that returns a PConnect object. (new/better way of doing .propTypes).
+//  This PConnProps can be extended to include other props that we know are in every component
+export interface PConnProps {
+  // getPConnect should exist for every C11n component. (add @ts-ignore in special cases where it isn't)
+  getPConnect: () => typeof PConnect;
+
+  // Allow any/all other key/value pairs in the BaseProps for now
+  //  TODO: refine which other props are always expected for various component
+  //    types and consider further interface "subclassing". For example, we may
+  //    want to create a "BasePropsForm" that gives guidance on required, readonly, etc.
+  //    and any other props that every Form component expects.
+  //    For example, see the PConnFieldProps below.
+  // NOTE: if you uncomment the line below, the PConnProps type will allow
+  //  otherwise undefined types to appear. This can be helpful for debugging
+  //  or when adding new components whose types aren't yet known.
+  // [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
+}

package/src/tasks/create/templates/Constellation/field/Icon-Button-URL/config.json.mustache

@@ -0,0 +1,64 @@
+{
+  "name": "{{COMPONENT_KEY}}",
+  "label": "{{COMPONENT_LABEL}}",
+  "description": "{{DESCRIPTION}}",
+  "organization": "{{ORGANIZATION}}",
+  "version": "{{VERSION}}",
+  "library": "{{LIBRARY}}",
+  "allowedApplications": {{{ALLOWEDAPPS}}},
+  "componentKey": "{{COMPONENT_KEY}}",
+  "type": "{{TYPE}}",
+  "subtype": {{{SUB_TYPE}}},
+  "icon": "images/pz-url-active.svg",
+  "properties": [
+    {
+      "format": "SELECT",
+      "name": "countryCode",
+      "label": "Country code",
+      "defaultValue": "USA",
+      "source": [
+        {
+          "key": "USA",
+          "value": "United States"
+        },
+        {
+          "key": "CAN",
+          "value": "Canada"
+        },
+        {
+          "key": "AUS",
+          "value": "Australia"
+        },
+        {
+          "key": "JPN",
+          "value": "Japan"
+        },
+        {
+          "key": "IND",
+          "value": "India"
+        },
+        {
+          "key": "TUR",
+          "value": "Turkey"
+        }
+      ]
+    },
+    {
+      "label": "Advanced",
+      "format": "GROUP",
+      "collapsible": true,
+      "properties": [
+        {
+          "name": "testId",
+          "label": "Test ID",
+          "format": "TEXT",
+          "ignorePattern": "[^-_\\p{N}\\p{L}]",
+          "includeAnnotations": false
+        }
+      ]
+    }
+  ],
+  "defaultConfig": {
+    "label": "@L $this.label"
+  }
+}

package/src/tasks/create/templates/Constellation/field/Icon-Button-URL/demo.stories.tsx.mustache

@@ -0,0 +1,99 @@
+
+/* eslint-disable react/jsx-no-useless-fragment */
+// @ts-nocheck
+import type { Meta, StoryObj } from '@storybook/react';
+
+import {{COMPONENT_CLASS_NAME}} from './index';
+import { configProps } from './mock';
+
+const meta: Meta<typeof {{COMPONENT_CLASS_NAME}}> = {
+  title: '{{COMPONENT_CLASS_NAME}}',
+  component: {{COMPONENT_CLASS_NAME}},
+  excludeStories: /.*Data$/
+};
+
+export default meta;
+type Story = StoryObj<typeof {{COMPONENT_CLASS_NAME}}>;
+
+if (!window.PCore) {
+  window.PCore = {};
+}
+
+const statelistData = {
+  data: [
+    {
+      pyLabel: 'Massachusetts',
+      pyStateCode: 'MA'
+    },
+    {
+      pyLabel: 'Rhode Island',
+      pyStateCode: 'RI'
+    },
+    {
+      pyLabel: 'Connecticut',
+      pyStateCode: 'CT'
+    }
+  ]
+};
+
+window.PCore.getDataPageUtils = () => {
+  return {
+    getDataAsync: () => {
+      return new Promise(resolve => {
+        resolve(statelistData);
+      });
+    }
+  };
+};
+
+export const Base{{COMPONENT_CLASS_NAME}}: Story = args => {
+
+  const props = {
+    countryCode: configProps.countryCode,
+    getPConnect: () => {
+      return {
+        getValue: value => {
+          return value;
+        },
+        getContextName: () => {
+          return 'app/primary_1';
+        },
+        getLocalizedValue: value => {
+          return value;
+        },
+        getActionsApi: () => {
+          return {
+            updateFieldValue: () => {
+              /* nothing */
+            },
+            triggerFieldChange: () => {
+              /* nothing */
+            }
+          };
+        },
+        ignoreSuggestion: () => {
+          /* nothing */
+        },
+        acceptSuggestion: () => {
+          /* nothing */
+        },
+        setInheritedProps: () => {
+          /* nothing */
+        },
+        resolveConfigProps: () => {
+          /* nothing */
+        }
+      };
+    }
+  };
+
+  return (
+    <>
+      <{{COMPONENT_CLASS_NAME}} {...props} {...args} />
+    </>
+  );
+};
+
+Base{{COMPONENT_CLASS_NAME}}.args = {
+  countryCode: configProps.countryCode
+};

package/src/tasks/create/templates/Constellation/field/Icon-Button-URL/index.tsx.mustache

@@ -0,0 +1,204 @@
+import { useEffect, useState } from 'react';
+import {
+  Icon,
+  Button,
+  withConfiguration,
+  registerIcon,
+  Table,
+  Label,
+  Link,
+  URLDisplay
+} from '@pega/cosmos-react-core';
+import type { PConnFieldProps } from './PConnProps';
+
+// IMPORTANT
+// To use Icons, need to individually import the icon file form @pega/cosmos-react-core (see path below)
+// Icons filename is kabab case (file-name), where as the icon you import is camel case (fileName)
+// Icons need to be registered (camel case), and then used (kabab case)
+import * as listNumber from '@pega/cosmos-react-core/lib/components/Icon/icons/list-number.icon';
+import * as arrowRight from '@pega/cosmos-react-core/lib/components/Icon/icons/arrow-right.icon';
+import * as globe from '@pega/cosmos-react-core/lib/components/Icon/icons/globe.icon';
+
+import Styled{{COMPONENT_CLASS_NAME}}Wrapper from './styles';
+
+// interface for props
+interface {{COMPONENT_CLASS_NAME}}Props extends PConnFieldProps {
+  // If any, enter additional props that only exist on TextInput here
+  countryCode: string;
+}
+
+export const textFormatter = (value: string) => {
+  return <URLDisplay target='_blank' value={value} displayText={value} variant='link' />;
+};
+
+
+// *************
+// This component is meant to be an example of usage (Icon, Button, Link, etc.) and NOT meant to be
+// used "as is"
+//
+// In this example, Icon is shown on its own and inside a Button
+// Though an Icon can have an "onClick" event is it recommended if you want to click on it,
+// to put it in a Button (shown below), so you can have a tooltip and hover style or put it
+// in a Link (shown below) as a URL.
+//
+// For the button, the click will get a list of states for a given country and display in a
+// table below.  The table display will toggle with the click of the button icon. Example shows
+// how to handle click, retrieve data from PCore and display it.
+//
+// Globe icon is an icon placed in a Link element. The Link element to use an icon internally.  (NOTE: In general
+// the Link element shows the open icon to the left of the link text, but here we are using
+// another icon, so with "icon" specified in the Link element, the open icon doesn't show)
+// Link elements do not handle bad urls well, so we have a simple validator to prevent the Link element
+// from getting most bad urls.
+//
+// NOTE: because icons have to be imported and registered, you can NOT put the icon name
+// inside the config.json and let the user pick it, if it is not already part of your
+// import and registration (can't be done on the fly)
+// **************
+
+// 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
+function {{COMPONENT_CLASS_NAME}}(props: {{COMPONENT_CLASS_NAME}}Props) {
+  const { value, displayMode, countryCode = 'USA', getPConnect, testId } = props;
+  const [statelist, setStatelist] = useState([]);
+  const [showTable, setShowTable] = useState(false);
+  const [validUrl, setValidUrl] = useState('about:blank');
+  const PConnect = getPConnect();
+
+  // IMPORTANT: need to register icons used in camel case
+  registerIcon(listNumber, arrowRight, globe);
+
+
+   // setting up columns for the work list table
+  const columns = [
+    { renderer: 'stateName', label: PConnect.getLocalizedValue('State name', '', '') },
+    { renderer: 'stateCode', label: PConnect.getLocalizedValue('State code', '', '') }
+  ];
+
+  // toggle showing table and getting table data
+  function showHideTable() {
+    setShowTable(prevShowTable => !prevShowTable);
+  }
+
+  // check if url is valid (simple)
+  function validateUrl(href: string) {
+    return /^(?:(?:(?:https?|ftp):)?\/\/)(?:\S+(?::\S*)?@)?(?:(?!(?:10|127)(?:\.\d{1,3}){3})(?!(?:169\.254|192\.168)(?:\.\d{1,3}){2})(?!172\.(?:1[6-9]|2\d|3[0-1])(?:\.\d{1,3}){2})(?:[1-9]\d?|1\d\d|2[01]\d|22[0-3])(?:\.(?:1?\d{1,2}|2[0-4]\d|25[0-5])){2}(?:\.(?:[1-9]\d?|1\d\d|2[0-4]\d|25[0-4]))|(?:(?:[a-z\u00a1-\uffff0-9]-*)*[a-z\u00a1-\uffff0-9]+)(?:\.(?:[a-z\u00a1-\uffff0-9]-*)*[a-z\u00a1-\uffff0-9]+)*(?:\.(?:[a-z\u00a1-\uffff]{2,})))(?::\d{2,5})?(?:[/?#]\S*)?$/i.test(
+      href
+    );
+  }
+
+  // Testing to see if value entered is valid url, if not can't use it.
+  // Reason for this code is that you can NOT pass to Link component
+  // a bad url, or it will error out.
+  // For example: Since the value is the property field,
+  // it could be entered from another component and thus as it is
+  // entered (typed in), it won't be valid until it is all entered.
+  // NOTE: can't have a blank value for the url as the Link element will error out
+  // in App studio preview
+  useEffect(() => {
+    if (validateUrl(value)) {
+      setValidUrl(value);
+    } else {
+      setValidUrl('about:blank');
+    }
+  }, [value]);
+
+  // going to get data for worklist to put into a table
+  // data comes from calling a PCore function to get
+  // get data from a data page and a PConnect function
+  // to get getContextName
+  useEffect(() => {
+    const dataViewName = 'D_pyStateList';
+    const context = PConnect.getContextName();
+    const params = { pyCountry: countryCode };
+
+    // only retrieve table data if table is shown
+    if (showTable) {
+      PCore.getDataPageUtils()
+        .getDataAsync(dataViewName, context, params, null, null)
+        // @ts-ignore
+        .then((response: any) => {
+          // table requires an index or will get setExtraStackFrame error
+          setStatelist(
+            response.data.map((entry: any, index: number) => {
+              // mapping the data into the column names
+              // MUST have an id/index or will get a setExtraStackFrame error
+              // put a key in the table
+              return {
+                stateName: entry.pyLabel,
+                stateCode: entry.pyStateCode,
+                id: index
+              };
+            })
+          );
+        })
+        .catch((error: any) => {
+          console.log(error);
+        });
+    }
+  }, [PConnect, countryCode, showTable]);
+
+  // when DISPLAY_ONLY, in this example we will just show the URL.
+  if (displayMode === 'DISPLAY_ONLY') {
+    const displayComp = textFormatter(validUrl);
+    return (
+      <Styled{{COMPONENT_CLASS_NAME}}Wrapper> {displayComp} </Styled{{COMPONENT_CLASS_NAME}}Wrapper>
+    );
+  }
+
+  return (
+    <Styled{{COMPONENT_CLASS_NAME}}Wrapper>
+{{! pick new delimiters for mustache }}
+{{=<% %>=}}
+    <div style={{ display: 'flex' }} data-testid={testId}>
+      <Icon
+        style={{ height: '1.5rem', width: '1.5rem' }}
+        // icon name is kabab case
+        name='arrow-right'
+        role='img'
+        aria-label='arrow right'
+      />
+      <Label style={{ margin: '0.1rem' }}>
+        {' '}
+        {PConnect.getLocalizedValue('State list for', '', '')}{' '}
+        {PConnect.getLocalizedValue(`${countryCode}`, '', '')}{' '}
+      </Label>
+      <Button
+        icon
+        label={PConnect.getLocalizedValue('Click to show/hide state list', '', '')}
+        variant='link'
+        compact={false}
+        onClick={showHideTable}
+      >
+        <Icon
+          style={{ height: '1.5rem', width: '1.5rem' }}
+          // icon name is kabab case
+          name='list-number'
+          role='img'
+          aria-label='numbered list'
+        />
+      </Button>
+      <Link href={validUrl} variant='link' label={validUrl} icon>
+        <Icon
+          style={{ height: '1.5rem', width: '1.5rem' }}
+          // icon name is kabab case
+          name='globe'
+          role='img'
+          aria-label='open link'
+        />
+      </Link>
+    </div>
+      {showTable && (
+        <Table
+          title={PConnect.getLocalizedValue('State list', '', '')}
+          columns={columns}
+          data={statelist}
+        />
+      )}
+<%={{ }}=%>     {{! revert delimiters for mustache }}
+    </Styled{{COMPONENT_CLASS_NAME}}Wrapper>
+  );
+}
+
+
+export default withConfiguration({{COMPONENT_CLASS_NAME}});

package/src/tasks/create/templates/Constellation/field/Icon-Button-URL/mock.ts.mustache

@@ -0,0 +1,5 @@
+
+// @ts-nocheck
+export const configProps = {
+  countryCode: 'USA'
+};

package/src/tasks/create/templates/Constellation/field/Icon-Button-URL/styles.ts.mustache

@@ -0,0 +1,8 @@
+// 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;
+  `;
+});

package/src/tasks/create/templates/Constellation/field/Picklist/index.tsx.mustache

@@ -39,7 +39,6 @@ interface StateProps {
   hasSuggestions: boolean;
 }
 
-
 export const formatExists = (formatterVal: string) => {
     const formatterValues = [
       "TextInput",