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

package/src/tasks/create/templates/SDK-Angular/widget/PAGE/demo.stories.tsx.mustache

@@ -4,37 +4,38 @@ import { configProps, worklistData } from './mock';
 
 import {{! pick new delimiters for mustache }}{{=<% %>=}}{<%={{ }}=%> {{COMPONENT_CLASS_NAME}}Component {{=<% %>=}}}<%={{ }}=%>{{! revert delimiters for mustache }} from './{{COMPONENT_CLASS_NAME_KEBAB}}.component';
 
-window.PCore = {
-  ...window.PCore,
-  getDataApiUtils: () => {
-    return {
-      getData: () => {
-        return Promise.resolve(worklistData);
-      }
-    } as any;
-  }
-};
-
 const meta: Meta<{{COMPONENT_CLASS_NAME}}Component> = {
   title: '{{COMPONENT_CLASS_NAME}}',
   component: {{COMPONENT_CLASS_NAME}}Component,
   excludeStories: /.*Data$/,
-  render: (args: {{COMPONENT_CLASS_NAME}}Component) => ({
-    props: {
-      ...args,
-      pConn$: {
-        getContextName: () => {
-          return 'app/primary_1';
-        },
-        getLocalizedValue: value => {
-          return value;
-        },
-        getConfigProps: () => {
-          return configProps;
-        }
-      } as any
+  render: (args: {{COMPONENT_CLASS_NAME}}Component) => {
+    window.PCore = {
+      ...window.PCore,
+      getDataApiUtils: () => {
+        return {
+          getData: () => {
+            return Promise.resolve(worklistData);
+          }
+        } as any;
+      }
+    };
+    return {
+      props: {
+        ...args,
+        pConn$: {
+          getContextName: () => {
+            return 'app/primary_1';
+          },
+          getLocalizedValue: value => {
+            return value;
+          },
+          getConfigProps: () => {
+            return configProps;
+          }
+        } as any
+      }
     }
-  })
+  }
 };
 
 export default meta;

package/src/tasks/create/templates/SDK-Angular/widget/PAGE-CASE/page-case.component.html.mustache

@@ -20,6 +20,4 @@
     </dl>
   </div>
 </div>
-
-
 <%={{ }}=%>     {{! revert delimiters for mustache }}

package/src/tasks/create/templates/SDK-React/field/Decimal-Currency/config.json.mustache

@@ -58,6 +58,34 @@
         }
       ]
     },
+    {
+      "label": "Column settings",
+      "format": "GROUP",
+      "visibility": "@VIEWTYPE == 'MultiRecordDisplayAsTable'",
+      "properties": [
+        {
+          "name": "columnWidth",
+          "label": "Column width",
+          "format": "SELECT",
+          "source": [
+            {
+              "key": "auto",
+              "value": "Auto"
+            },
+            {
+              "key": "custom",
+              "value": "Custom"
+            }
+          ]
+        },
+        {
+          "name": "width",
+          "label": "Width (px)",
+          "format": "NUMBER",
+          "visibility": "$this.columnWidth == 'custom'"
+        }
+      ]
+    },
     {
       "label": "Input settings",
       "format": "GROUP",
@@ -69,6 +97,12 @@
           "format": "BOOLEAN",
           "defaultValue": true
         },
+        {
+          "name": "alwaysShowISOCode",
+          "label": "Show ISO Code",
+          "format": "BOOLEAN",
+          "defaultValue": false
+        },
         {
           "name": "placeholder",
           "label": "Placeholder",
@@ -81,6 +115,138 @@
         }
       ]
     },
+    {
+      "label": "Read-only settings",
+      "format": "GROUP",
+      "properties": [
+        {
+          "format": "SELECT",
+          "name": "formatter",
+          "label": "Format",
+          "defaultValue": "defaultCurrency",
+          "source": [
+            {
+              "key": "defaultCurrency",
+              "value": "Default"
+            },
+            {
+              "key": "Integer",
+              "value": "Integer"
+            },
+            {
+              "key": "Decimal",
+              "value": "Decimal"
+            },
+            {
+              "key": "Percentage",
+              "value": "Percentage"
+            }
+          ]
+        }
+      ]
+    },
+    {
+      "format": "SELECT",
+      "name": "currencyDisplay",
+      "label": "Currency display",
+      "visibility": "(!formatter = Integer)&&(!formatter = Decimal)&&(!formatter = Percentage)",
+      "defaultValue": "symbol",
+      "source": [
+        {
+          "key": "symbol",
+          "value": "Auto"
+        },
+        {
+          "key": "code",
+          "value": "Code"
+        },
+        {
+          "key": "name",
+          "value": "Name"
+        }
+      ]
+    },
+    {
+      "format": "SELECT",
+      "name": "negative",
+      "label": "Negative number display",
+      "defaultValue": "minus-sign",
+      "visibility": "(!formatter = Integer)&&(!formatter = Decimal)&&(!formatter = Percentage)",
+      "source": [
+        {
+          "key": "minus-sign",
+          "value": "Standard"
+        },
+        {
+          "key": "parentheses",
+          "value": "Accounting"
+        }
+      ]
+    },
+    {
+      "format": "SELECT",
+      "name": "notation",
+      "label": "Notation",
+      "visibility": "(!negative = parentheses)&&(!formatter = Percentage)",
+      "defaultValue": "standard",
+      "source": [
+        {
+          "key": "standard",
+          "value": "Standard"
+        },
+        {
+          "key": "compact",
+          "value": "Compact"
+        }
+      ]
+    },
+    {
+      "format": "NUMBER",
+      "name": "decimalPrecision",
+      "label": "Decimal places",
+      "visibility": "(formatter = Decimal)||(formatter = Percentage)",
+      "min": 0,
+      "max": 20
+    },
+    {
+      "format": "SELECT",
+      "name": "currencyDecimalPrecision",
+      "label": "Decimal places shown",
+      "visibility": "(!formatter = Integer)&&(!formatter = Decimal)&&(!formatter = Percentage)",
+      "defaultValue": "auto",
+      "source": [
+        {
+          "key": "auto",
+          "value": "Auto"
+        },
+        {
+          "key": "0",
+          "value": "None"
+        },
+        {
+          "key": "1",
+          "value": "1"
+        },
+        {
+          "key": "2",
+          "value": "2"
+        },
+        {
+          "key": "3",
+          "value": "3"
+        },
+        {
+          "key": "4",
+          "value": "4"
+        }
+      ]
+    },
+    {
+      "name": "showGroupSeparators",
+      "label": "Show thousands separator",
+      "format": "BOOLEAN",
+      "visibility": "(formatter = Decimal)||(formatter = Integer)"
+    },
     {
       "label": "Conditions",
       "format": "GROUP",

package/src/tasks/create/templates/SDK-React/widget/PAGE/index.tsx.mustache

@@ -73,7 +73,7 @@ export default function {{COMPONENT_CLASS_NAME}}(props: {{COMPONENT_CLASS_NAME}}
   const [waitingForData, setWaitingForData] = useState<boolean>(true);
   const thePConn = getPConnect();
   const caseID = thePConn.getValue(PCore.getConstants().CASE_INFO.CASE_INFO_ID, ''); // 2nd arg empty string until typedef marked correctly
-  const dataViewName = 'D_pyWorkHistory';
+  const dataViewName = 'D_pyMyWorkList';
   const context = thePConn.getContextName();
 
   const rowData: any = useRef([]);

package/src/tasks/override/index.js

@@ -105,6 +105,11 @@ const getListAvailableComponents = async (type) => {
       listEl = arKey[arKey.length - 1];
     }
 
+    if (framework === "SDK-Angular") {
+      // need to convert to match in "includes"
+      listEl = convertIntoKebabCase(listEl);
+    }
+
     if (components.includes(listEl)) {
       // currently don't show, because too many separators inquirer flaky
       //availList.push(new inquirer.Separator("** " + fullList[el].name));
@@ -126,6 +131,10 @@ const adjustAngularComponentName = (componentName) => {
   return componentName;
 }
 
+const adjustAngularKebabCase = (componentName) => {
+  componentName = componentName.replaceAll("/-", "/");
+  return componentName;
+}
 
 const validateCompile = async (
   {
@@ -151,8 +160,9 @@ const validateCompile = async (
   switch (framework) {
     case "SDK-Angular":
       templateParentDir = OVERRIDE_ANGULAR_LIB_PATH;
-      componentName = adjustAngularComponentName(componentName);
+      // componentName = adjustAngularComponentName(componentName);
       componentName = convertIntoKebabCase(componentName);
+      componentName = adjustAngularKebabCase(componentName);
       break;
     case "SDK-React":
       templateParentDir = OVERRIDE_REACT_LIB_PATH;

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

@@ -122,11 +122,13 @@ const adjustAngularComponentName = (componentName) => {
     componentName = componentName.split("/")[1];
   }
 
- 
-
   return componentName;
 }
 
+const adjustAngularKebabCase = (componentName) => {
+  componentName = componentName.replaceAll("/-", "/");
+  return componentName;
+}
 
 const validateCompile = async (
   {
@@ -148,8 +150,9 @@ const validateCompile = async (
   switch (framework) {
     case "SDK-Angular":
       templateParentDir = OVERRIDE_ANGULAR_LIB_PATH;
-      componentName = adjustAngularComponentName(componentName);
+      // componentName = adjustAngularComponentName(componentName);
       componentName = convertIntoKebabCase(componentName);
+      componentName = adjustAngularKebabCase(componentName);
       break;
     case "SDK-React":
       templateParentDir = OVERRIDE_REACT_LIB_PATH;
@@ -206,7 +209,7 @@ const validateCompile = async (
 
 };
 
-const buildOverridComponents = async (type, compList, options) => {
+const buildOverrideComponents = async (type, compList, options) => {
   if (compList.length > 0) {
     for (var index in compList) {
       let componentName = compList[index].value;
@@ -255,11 +258,11 @@ export default async options => {
   const infraList = await getListAvailableComponents("infra");
 
  
-  await buildOverridComponents("field", fieldList, options);
-  await buildOverridComponents("template", templateList, options);
-  await buildOverridComponents("widget", widgetList, options);
-  await buildOverridComponents("designSystemExtension", desList, options);
-  await buildOverridComponents("infra", infraList, options);
+  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/tests/assets/sdk-a/components/create/_components.md

@@ -0,0 +1,6 @@
+# The **components** directory
+
+The **src/components** directory contains the code for the components you want to use with the **Angular SDK**.
+
+When you run the **npm run  create** or **npm run override** commands to create new components, the generated code that
+you can use as a starting point for your component development will be placed in component-specific folders inside **src/components**.

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

@@ -0,0 +1,5 @@
+// @ts-ignore
+if (window?.__webpack_nonce__) {
+  // @ts-ignore
+  __webpack_nonce__ = window.__webpack_nonce__;
+}

package/tests/assets/sdk-a/components/create/custom-constellation/field/Pega_DXIL_MyTestText/demo.stories.tsx

@@ -2,27 +2,27 @@
 /* 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 { stateProps, configProps } from './mock';
 
 import PegaDxilMyTestText from './index';
 
-export default {
+const meta: Meta<typeof PegaDxilMyTestText> = {
   title: 'PegaDxilMyTestText',
-  decorators: [withKnobs],
-  component: PegaDxilMyTestText
+  component: PegaDxilMyTestText,
+  excludeStories: /.*Data$/
 };
 
-export const BasePegaDxilMyTestText = () => {
+export default meta;
+type Story = StoryObj<typeof PegaDxilMyTestText>;
+
+export const BasePegaDxilMyTestText: Story = args => {
 
   const [value, setValue] = useState(configProps.value);
 
   const props = {
     value,
-    placeholder: configProps.placeholder,
-    label: configProps.label,
-    testId: configProps.testId,
     hasSuggestions: configProps.hasSuggestions,
 
     getPConnect: () => {
@@ -48,7 +48,21 @@ export const BasePegaDxilMyTestText = () => {
 
   return (
     <>
-      <PegaDxilMyTestText {...props} />
+      <PegaDxilMyTestText {...props} {...args} />
     </>
   );
 };
+
+BasePegaDxilMyTestText.args = {
+  label: configProps.label,
+  helperText: configProps.helperText,
+  placeholder: configProps.placeholder,
+  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/tests/assets/sdk-a/components/create/custom-constellation/field/Pega_DXIL_MyTestText/index.tsx

@@ -1,14 +1,24 @@
-import PropTypes from 'prop-types';
-import { Input } from '@pega/cosmos-react-core';
+import {
+  Input,
+  FieldValueList,
+  Text,
+  EmailDisplay,
+  PhoneDisplay,
+  URLDisplay,
+  withConfiguration
+} from '@pega/cosmos-react-core';
 
 import type { PConnFieldProps } from './PConnProps';
+import './create-nonce';
 
 import StyledPegaDxilMyTestTextWrapper from './styles';
 
 // interface for props
 interface PegaDxilMyTestTextProps extends PConnFieldProps {
   // If any, enter additional props that only exist on TextInput here
-
+  isTableFormatter?: boolean;
+  formatter: string;
+  variant?: any;
 }
 
 // interface for StateProps object
@@ -17,23 +27,103 @@ interface StateProps {
   hasSuggestions: boolean;
 }
 
-// Duplicated runtime code from Constellation Design System Component
+export const formatExists = (formatterVal: string) => {
+  const formatterValues = [
+    'TextInput',
+    'WorkStatus',
+    'RichText',
+    'Email',
+    'Phone',
+    'URL',
+    'Operator'
+  ];
+  let isformatter = false;
+  if (formatterValues.includes(formatterVal)) {
+    isformatter = true;
+  }
+  return isformatter;
+};
+
+export const textFormatter = (formatter: string, value: string) => {
+  let displayComponent: any = null;
+  switch (formatter) {
+    case 'TextInput': {
+      displayComponent = value;
+      break;
+    }
+    case 'Email': {
+      displayComponent = <EmailDisplay value={value} displayText={value} variant='link' />;
+      break;
+    }
+    case 'Phone': {
+      displayComponent = <PhoneDisplay value={value} variant='link' />;
+      break;
+    }
+    case 'URL': {
+      displayComponent = (
+        <URLDisplay target='_blank' value={value} displayText={value} variant='link' />
+      );
+      break;
+    }
+    // no default
+  }
+  return displayComponent;
+};
 
 // 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 PegaDxilMyTestText(props: PegaDxilMyTestTextProps) {
-  const { getPConnect, value, placeholder, disabled, readOnly, required, label, hideLabel, testId } = props;
+function PegaDxilMyTestText(props: PegaDxilMyTestTextProps) {
+  const { getPConnect, value, placeholder, disabled = false, displayMode, readOnly = false, required = false, label, hideLabel = false, testId, isTableFormatter = false, variant = 'inline' } = props;
 
   const pConn = getPConnect();
   const actions = pConn.getActionsApi();
   const stateProps = pConn.getStateProps() as StateProps;
   const propName: string = stateProps.value;
+  const { formatter } = props;
 
   const handleOnChange = (event: any) => {
     const { value: updatedValue } = event.target;
     actions.updateFieldValue(propName, updatedValue);
   };
 
+  if (displayMode === 'LABELS_LEFT' || displayMode === 'DISPLAY_ONLY') {
+    let displayComp = value || <span aria-hidden='true'>&ndash;&ndash;</span>;
+    if (isTableFormatter && formatExists(formatter)) {
+      displayComp = textFormatter(formatter, value);
+    }
+    return displayMode === 'DISPLAY_ONLY' ? (
+      <StyledPegaDxilMyTestTextWrapper> {displayComp} </StyledPegaDxilMyTestTextWrapper>
+    ) : (
+      <StyledPegaDxilMyTestTextWrapper>
+        <FieldValueList
+          variant={hideLabel ? 'stacked' : variant}
+          data-testid={testId}
+          fields={[{ id: '1', name: hideLabel ? '' : label, value: displayComp }]}
+        />
+      </StyledPegaDxilMyTestTextWrapper>
+    );
+  }
+
+  if (displayMode === 'STACKED_LARGE_VAL') {
+    const isValDefined = typeof value !== 'undefined' && value !== '';
+    const val = isValDefined ? (
+      <Text variant='h1' as='span'>
+        {value}
+      </Text>
+    ) : (
+      ''
+    );
+    return (
+      <StyledPegaDxilMyTestTextWrapper>
+        <FieldValueList
+          variant='stacked'
+          data-testid={testId}
+          fields={[{ id: '2', name: hideLabel ? '' : label, value: val }]}
+        />
+      </StyledPegaDxilMyTestTextWrapper>
+    );
+  }
+
   return (
     <StyledPegaDxilMyTestTextWrapper>
       <Input
@@ -52,22 +142,5 @@ export default function PegaDxilMyTestText(props: PegaDxilMyTestTextProps) {
   );
 };
 
-PegaDxilMyTestText.defaultProps = {
-  value: '',
-  placeholder: '',
-  disabled: false,
-  readOnly: false,
-  required: false,
-  testId: ''
-};
 
-PegaDxilMyTestText.propTypes = {
-  label: PropTypes.string,
-  value: PropTypes.string,
-  placeholder: PropTypes.string,
-  getPConnect: PropTypes.func.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
-};
+export default withConfiguration(PegaDxilMyTestText);

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

@@ -6,7 +6,14 @@ export const configProps = {
   placeholder: 'Text Placeholder',
   helperText: 'Text Helper Text',
   testId: 'Text-12345678',
-  hasSuggestions: false
+  hasSuggestions: false,
+  displayMode: '',
+  hideLabel: false,
+  readOnly: false,
+  required: false,
+  disabled: false,
+  status: '',
+  validatemessage: ''
 };
 
 export const stateProps = {

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

@@ -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/sdk-a/components/create/override-sdk/designSystemExtension/banner/banner.component.html

@@ -0,0 +1,28 @@
+<div style="margin-bottom: '2rem'">
+  <div class="background-image-style" [ngStyle]="{ 'background-image': getUrl() }">
+    <div class="background-style content">
+      <div>
+        <h1 class="title">{{ title }}</h1>
+        <p class="message">{{ message }}</p>
+      </div>
+    </div>
+  </div>
+  <div
+    [ngClass]="{
+      'psdk-grid-filter-1': this.layout$ === 'two-column',
+      'psdk-grid-filter-wide-narrow': this.layout$ === 'wide-narrow',
+      'psdk-grid-filter-narrow-wide': this.layout$ === 'narrow-wide'
+    }"
+  >
+    <component-mapper
+      [name]="arChildren$[0].getPConnect().getComponentName()"
+      [props]="{ pConn$: arChildren$[0].getPConnect(), formGroup$ }"
+      errorMsg="Region wants component not yet available: {{ arChildren$[0].getPConnect().getComponentName() }}"
+    ></component-mapper>
+    <component-mapper
+      [name]="arChildren$[1].getPConnect().getComponentName()"
+      [props]="{ pConn$: arChildren$[1].getPConnect(), formGroup$ }"
+      errorMsg="Region wants component not yet available: {{ arChildren$[1].getPConnect().getComponentName() }}"
+    ></component-mapper>
+  </div>
+</div>