@pega/custom-dx-components 23.1.11 → 24.1.10

package/src/tasks/create/templates/Constellation/Widget/PAGE/index.tsx.mustache

@@ -1,4 +1,5 @@
-import PropTypes from 'prop-types';
+import { useEffect, useState } from 'react';
+import { withConfiguration, Table } from '@pega/cosmos-react-core';
 import { AppAnnouncement as PegaAppAnnouncement } from '@pega/cosmos-react-work';
 import type { PConnFieldProps } from './PConnProps';
 
@@ -14,14 +15,17 @@ interface {{COMPONENT_CLASS_NAME}}Props extends PConnFieldProps {
     image: string;
 }
 
-
-// Duplicated runtime code from Constellation Design System Component
-
 // 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 { header, description, datasource = [], whatsnewlink, image, getPConnect } = props;
+  const [worklist, setWorklist] = useState([]);
+  const [isLoading, setIsLoading] = useState(true);
+  const PConnect = getPConnect();
+  const dataViewName = 'D_pyMyWorkList';
+  const context = PConnect.getContextName();
 
-  const { header, description, datasource, whatsnewlink, image } = props;
   let details = [];
   // @ts-ignore
   if (datasource && datasource.source) {
@@ -30,6 +34,56 @@ export default function {{COMPONENT_CLASS_NAME}}(props: {{COMPONENT_CLASS_NAME}}
       return item.name;
     });
   }
+
+  // setting up columns for the work list table
+  const columns = [
+    { renderer: 'caseType', label: PConnect.getLocalizedValue('Case type', '', '') },
+    { renderer: 'insKey', label: PConnect.getLocalizedValue('Key', '', '') },
+    { renderer: 'status', label: PConnect.getLocalizedValue('Status', '', '') },
+    { renderer: 'stage', label: PConnect.getLocalizedValue('Stage', '', '') }
+  ];
+
+  // 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(() => {
+
+    PCore.getDataApiUtils()
+      .getData(dataViewName, {}, context)
+      // @ts-ignore
+      .then((response: any) => {
+        setIsLoading(false);
+        if (response.data.data !== null) {
+          // table requires an index or will get setExtraStackFrame error
+          setWorklist(
+            response.data.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 {
+                caseType: entry.pxProcessName,
+                insKey: entry.pxRefObjectInsName,
+                status: entry.pyAssignmentStatus,
+                stage: entry.pxTaskLabel,
+                id: index
+              };
+            })
+          );
+        }
+        else {
+          setWorklist([]);
+          setIsLoading(false);
+        }
+
+      })
+      .catch((error: any) => {
+        setWorklist([]);
+        setIsLoading(false);
+        console.log(error);
+      });
+  }, [context]);
+
   return (
     <Styled{{COMPONENT_CLASS_NAME}}Wrapper>
     <PegaAppAnnouncement
@@ -39,23 +93,17 @@ export default function {{COMPONENT_CLASS_NAME}}(props: {{COMPONENT_CLASS_NAME}}
       whatsNewLink={whatsnewlink}
       image={image.replace(/ /g, '+')}
     />
+    <br />
+    <Table
+      title={PConnect.getLocalizedValue('Work list', '', '')}
+      columns={columns}
+      data={worklist}
+      loading={isLoading}
+      loadingMessage={PConnect.getLocalizedValue('Loading Work list', '', '')}
+    />
     </Styled{{COMPONENT_CLASS_NAME}}Wrapper>
   );
 
 }
 
-{{COMPONENT_CLASS_NAME}}.defaultProps = {
-  header: '',
-  description: '',
-  image: '',
-  datasource: [],
-  whatsnewlink: ''
-};
-
-{{COMPONENT_CLASS_NAME}}.propTypes = {
-  header: PropTypes.string,
-  description: PropTypes.string,
-  datasource: PropTypes.instanceOf(Object),
-  whatsnewlink: PropTypes.string,
-  image: PropTypes.string
-};
+export default withConfiguration({{COMPONENT_CLASS_NAME}});

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

@@ -1,8 +1,7 @@
 /* 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 { Avatar as CosmosAvatar, withConfiguration } 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;
+export default withConfiguration(Avatar);

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

@@ -8,11 +8,11 @@ import {
   useElement,
   Progress,
   FormField,
-  useTheme
+  useTheme,
+  withConfiguration
 } 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';
 
@@ -31,7 +31,7 @@ interface {{COMPONENT_CLASS_NAME}}OperatorProps extends PConnFieldProps {
 
 let pTarget = null;
 
-export default function Operator(props: {{COMPONENT_CLASS_NAME}}OperatorProps) {
+function Operator(props: {{COMPONENT_CLASS_NAME}}OperatorProps) {
   const { id, name, label, testId, helperText, externalUser, metaObj } = props;
   const [isOpen, setIsOpen] = useState(false);
   const [isLoading, setIsLoading] = useState(true);
@@ -214,20 +214,5 @@ 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
-};
+export default withConfiguration(Operator);

package/src/tasks/create/templates/Constellation/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,17 +37,14 @@ window.PCore.getUserApi = () => {
   };
 };
 
-export const Base{{COMPONENT_CLASS_NAME}} = () => {
+export const Base{{COMPONENT_CLASS_NAME}}: Story = args => {
 
   const props = {
     label: configProps.label,
-    createLabel: configProps.createLabel,
-    updateLabel: configProps.updateLabel,
     createOperator: configProps.createOperator,
     updateOperator: configProps.updateOperator,
     createDateTime: configProps.createDateTime,
     updateDateTime: configProps.updateDateTime,
-    hideLabel: configProps.hideLabel,
 
     getPConnect: () => {
       return {
@@ -64,7 +64,13 @@ export const Base{{COMPONENT_CLASS_NAME}} = () => {
 
 return (
     <>
-      <{{COMPONENT_CLASS_NAME}} {...props} />
+      <{{COMPONENT_CLASS_NAME}} {...props} {...args} />
     </>
   );
 };
+
+Base{{COMPONENT_CLASS_NAME}}.args = {
+  createLabel: configProps.createLabel,
+  updateLabel: configProps.updateLabel,
+  hideLabel: configProps.hideLabel
+};

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

@@ -1,8 +1,8 @@
 
 /* eslint-disable no-nested-ternary */
 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
@@ -25,7 +25,6 @@ interface {{COMPONENT_CLASS_NAME}}Props extends PConnFieldProps {
   updateDateTime: string;
   resolveDateTime: string;
   hideLabel: boolean;
-
 }
 
 
@@ -33,12 +32,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,
     createOperator,
@@ -68,9 +67,22 @@ export default function {{COMPONENT_CLASS_NAME}}(props: {{COMPONENT_CLASS_NAME}}
       <CardContent>
 {{! pick new delimiters for mustache }} {{=<% %>=}}
       <Flex container={{ direction: 'row'}}>
-      <Operator label={hideLabel ? undefined : _label} name={user.userName} id={user.userId} getPConnect={getPConnect} value={undefined} validatemessage='' hideLabel={false} readOnly={false} required={false} disabled={false} externalUser={undefined} />
-
-
+            <Operator
+              label={hideLabel ? '' : _label}
+              name={user.userName}
+              id={user.userId}
+              getPConnect={getPConnect}
+              value={undefined}
+              validatemessage=''
+              hideLabel={false}
+              readOnly={false}
+              required={false}
+              disabled={false}
+              externalUser={undefined}
+              metaObj={undefined}
+              testId=''
+              helperText=''
+            />
 <%={{ }}=%>     {{! revert delimiters for mustache }}
       {dateTimeValue && (
         <Fragment>
@@ -93,36 +105,9 @@ export default function {{COMPONENT_CLASS_NAME}}(props: {{COMPONENT_CLASS_NAME}}
 
 }
 
-{{COMPONENT_CLASS_NAME}}.defaultProps = {
-  "label": "Create operator",
-  "title": "Create operator",
-  createLabel: null,
-  updateLabel: null,
-  createOperator: null,
-  updateOperator: null,
-  createDateTime: null,
-  updateDateTime: null,
-  resolveLabel: null,
-  resolveOperator: null,
-  resolveDateTime: null,
-  hideLabel: false
-};
-
-{{COMPONENT_CLASS_NAME}}.propTypes = {
-  getPConnect: PropTypes.func.isRequired,
-  label: PropTypes.string,
-  title: PropTypes.string,
-  createLabel: PropTypes.string,
-  updateLabel: PropTypes.string,
-  resolveLabel: PropTypes.string,
-  createOperator: PropTypes.objectOf(PropTypes.any),
-  updateOperator: PropTypes.objectOf(PropTypes.any),
-  resolveOperator: PropTypes.objectOf(PropTypes.any),
-  createDateTime: PropTypes.string,
-  updateDateTime: PropTypes.string,
-  resolveDateTime: PropTypes.string,
-  hideLabel: PropTypes.bool
-};
+
+
+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/Constellation/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/create/templates/Launchpad/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/Launchpad/Field/Icon-Button-URL/config.json.mustache

@@ -0,0 +1,32 @@
+{
+  "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": [
+    {
+      "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/Launchpad/Field/Icon-Button-URL/demo.stories.tsx.mustache

@@ -0,0 +1,103 @@
+
+/* eslint-disable react/jsx-no-useless-fragment */
+// @ts-nocheck
+import type { Meta, StoryObj } from '@storybook/react';
+
+import {{COMPONENT_CLASS_NAME}} from './index';
+import { stateProps, 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 countrylistData = {
+  data: [
+    {
+      Name: 'United States of America',
+      ShortName: 'USA'
+    },
+    {
+      Name: 'Canada',
+      ShortName: 'CAN'
+    },
+    {
+      Name: 'Mexico',
+      ShortName: 'MEX'
+    }
+  ]
+};
+
+window.PCore.getDataPageUtils = () => {
+  return {
+    getData: () => {
+      return new Promise(resolve => {
+        resolve(countrylistData);
+      });
+    },
+    getDataAsync: () => {
+      return new Promise(resolve => {
+        resolve(countrylistData);
+      });
+    }
+  };
+};
+
+export const Base{{COMPONENT_CLASS_NAME}}: Story = args => {
+
+  const props = {
+    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 = {
+
+};