@pega/custom-dx-components 2.0.7 → 2.0.9

package/package.json

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

package/src/constants.js

@@ -13,6 +13,24 @@ export const DELETE_COMPONENT_SERVICE_REST_ENDPOINT = 'PRRestService/dev/v1/dele
 export const TOKEN_URL_V1 = 'PRRestService/oauth2/v1/token';
 
 export const COMPONENT_SCHEMA = {
+  framework: [
+    {
+      name: 'Constellation',
+      value: 'Constellation'
+    },
+    {
+      name: 'SDK Angular',
+      value: 'SDK-Angular'
+    },
+    {
+      name: 'SDK React',
+      value: 'SDK-React'
+    },
+    {
+      name: 'SDK Web Components',
+      value: 'SDK-WebComponents'
+    }
+  ],
   type: [
     {
       name: 'Field',
@@ -25,10 +43,6 @@ export const COMPONENT_SCHEMA = {
     {
       name: 'Widget',
       value: 'Widget'
-    },
-    {
-      name: 'Table',
-      value: 'Table'
     }
   ],
   subtype: {
@@ -37,6 +51,10 @@ export const COMPONENT_SCHEMA = {
         name: 'Text',
         value: 'Text'
       },
+      {
+        name: 'Text Input',
+        value: 'Text-Input'
+      },
       {
         name: 'Paragraph',
         value: 'Text-Paragraph'
@@ -82,34 +100,28 @@ export const COMPONENT_SCHEMA = {
         value: 'DateTime'
       },
       {
-        name: 'TimeofDay',
-        value: 'TimeofDay'
+        name: 'TimeOfDay',
+        value: 'TimeOfDay'
       },
       {
         name: 'Picklist',
         value: 'Picklist'
       }
     ],
-    template: ['DETAILS', 'FORM', 'PAGE'],
+    template: ['DETAILS', 'DETAILS-region', 'FORM', 'FORM-region', 'PAGE' ],
     widget: [
-      {
-        name: 'PAGE',
-        value: 'PAGE'
-      },
       {
         name: 'CASE',
         value: 'CASE'
       },
+      {
+        name: 'PAGE',
+        value: 'PAGE'
+      },
       {
         name: 'PAGE & CASE',
         value: ['PAGE', 'CASE']
       }
-    ],
-    table: [
-      {
-        name: 'Cell',
-        value: 'Cell'
-      }
     ]
   }
 };

package/src/tasks/create/index.js

@@ -53,6 +53,16 @@ const compileMustacheTemplates = async (
     subtype = subtype.toString();
   }
 
+  let mustacheSubType = subtype;
+  if (typeof(mustacheSubType) == "string") {
+    if (mustacheSubType == "FORM-region") {
+      mustacheSubType = "FORM";
+    }
+    else if (mustacheSubType == "DETAILS-region") {
+      mustacheSubType = "DETAILS";
+    }
+  }
+
   if (allowedApplications.trim() === '') {
     allowedApplications = [];
   } else {
@@ -76,7 +86,7 @@ const compileMustacheTemplates = async (
       LIBRARY: library,
       ALLOWEDAPPS: JSON.stringify(allowedApplications),
       TYPE: type,
-      SUB_TYPE: JSON.stringify(subtype),
+      SUB_TYPE: JSON.stringify(mustacheSubType),
       DESCRIPTION: description,
       IS_TEMPLATE: isTemplate,
       IS_PICKLIST: isPicklist,
@@ -94,6 +104,7 @@ const validateCompile = async (
     componentLabel,
     library,
     version,
+    framework,
     type,
     subtype,
     description,
@@ -101,8 +112,23 @@ const validateCompile = async (
   },
   options
 ) => {
-  const templateDirectory = fileURLToPath(new URL('./template', import.meta.url));
 
+  let sSubType = subtype;
+  if (Array.isArray(subtype)) {
+    sSubType = subtype.join("-");
+  }
+
+  // for now, until add question back in
+  if (framework == undefined || framework == "") {
+    framework = "Constellation";
+  }
+
+  const templateDir = `./templates/${framework}/${type}/${sSubType}`;
+  //const templateDirectory = fileURLToPath(new URL('./template', import.meta.url));
+  const templateDirectory = fileURLToPath(new URL(templateDir, import.meta.url));
+
+
+  //console.log("temp dir:" + templateDirectory);
   const { organization } = JSON.parse(fs.readFileSync(path.resolve('package.json'), 'utf8'));
 
   const componentKey = `${organization}_${library}_${componentName}`;
@@ -146,20 +172,23 @@ const validateCompile = async (
 };
 
 export default async options => {
-  if (options.params[9]) {
+  if (options.params[10]) {
     const componentName = options.params[3];
     const componentLabel = options.params[4];
     const library = options.params[5];
     const version = options.params[6];
-    const type = options.params[7];
-    const subtype = options.params[8];
-    const description = options.params[9];
+    const framework = options.params[7];
+    const type = options.params[8];
+    const subtype = options.params[9];
+    const description = options.params[10];
+
     await validateCompile(
       {
         componentName,
         componentLabel,
         library,
         version,
+        framework,
         type,
         subtype,
         description
@@ -225,6 +254,13 @@ export default async options => {
         message: 'Please enter the application names to be supported (comma-separated). ',
         suffix: 'Keep empty for all applications'
       },
+      // {
+      //   name: 'framework',
+      //   type: 'rawlist',
+      //   message: 'Enter framework a',
+      //   default: 'COSMOS_React',
+      //   choices: COMPONENT_SCHEMA.framework
+      // },
       {
         name: 'type',
         type: 'rawlist',
@@ -269,35 +305,21 @@ export default async options => {
           return 'Please select subtype';
         }
       },
-      {
-        name: 'subtype',
-        type: 'rawlist',
-        message: 'Enter subtype of component',
-        default: [componentDefaults.subtype || COMPONENT_SCHEMA.subtype.table[0]],
-        choices: COMPONENT_SCHEMA.subtype.table,
-        when(answers) {
-          return answers.type === 'Table';
-        },
-        validate: value => {
-          /* value should not be empty */
-          if (Array.isArray(value) && value.length) {
-            return true;
-          }
-          return 'Please select subtype';
-        }
-      },
       {
         name: 'description',
         message: 'Enter description for the component',
         default: componentDefaults.description
       }
     ];
+
+    console.log(chalk.green("DX Component Builder v2.0.9"));
     await inquirer.prompt(questions).then(async answers => {
       const {
         componentName,
         componentLabel,
         library,
         version,
+        framework,
         type,
         subtype,
         description,
@@ -309,6 +331,7 @@ export default async options => {
           componentLabel,
           library,
           version,
+          framework,
           type,
           subtype,
           description,

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

@@ -0,0 +1,38 @@
+function Boolean(value, { 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, options) =>
+    Boolean(value, {
+      ...options,
+      tick: "True",
+      cross: "False"
+    })
+};

package/src/tasks/create/templates/Constellation/Field/Boolean/boolean-format.js.mustache

@@ -0,0 +1,26 @@
+import Boolean from "./Boolean";
+
+
+export default {
+  ...Boolean
+};
+
+
+
+export function format(value, type, options) {
+  let formattedValue;
+
+  switch (type?.toLowerCase()) {
+
+
+    case "boolean":
+    case "checkbox": {
+      formattedValue = Boolean.TrueFalse(value, { allowEmpty: false });
+      break;
+    }
+
+    default:
+      formattedValue = value;
+  }
+  return formattedValue;
+}

package/src/tasks/create/templates/Constellation/Field/Boolean/config.json.mustache

@@ -0,0 +1,145 @@
+{
+  "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-checkbox-active.svg",
+  "properties": [
+    {
+      "name": "label",
+      "label": "Field label",
+      "format": "TEXT"
+    },
+    {
+      "name": "hideLabel",
+      "label": "Hide Label",
+      "format": "BOOLEAN"
+    },
+    {
+      "name": "readOnly",
+      "label": "Edit mode",
+      "format": "READONLY"
+    },
+    {
+      "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",
+      "visibility": "(!readOnly = true)",
+      "properties": [
+        {
+          "name": "caption",
+          "label": "Caption",
+          "format": "TEXT",
+          "useAsAuthoringLabel": true
+        },
+        {
+          "name": "helperText",
+          "label": "Helper text",
+          "format": "TEXT"
+        }
+      ]
+    },
+    {
+      "label": "Read-only settings",
+      "format": "GROUP",
+      "properties": [
+        {
+          "format": "SELECT",
+          "name": "displayValue",
+          "label": "Display Value",
+          "defaultValue": "Yes/No",
+          "localize": true,
+          "splitValues": {
+            "token": "/",
+            "propertyNames": ["trueLabel", "falseLabel"]
+          },
+          "source": [
+            {
+              "key": "Yes/No",
+              "value": "Yes/No"
+            },
+            {
+              "key": "True/False",
+              "value": "True/False"
+            }
+          ]
+        }
+      ]
+    },
+    {
+      "label": "Conditions",
+      "format": "GROUP",
+      "properties": [
+        {
+          "name": "required",
+          "label": "Required",
+          "format": "REQUIRED",
+          "visibility": "(!readOnly = true)"
+        },
+        {
+          "name": "disabled",
+          "label": "Disabled",
+          "format": "DISABLED",
+          "visibility": "(!readOnly = true)"
+        },
+        {
+          "name": "visibility",
+          "label": "Visibility",
+          "format": "VISIBILITY"
+        }
+      ]
+    },
+    {
+      "label": "Advanced",
+      "format": "GROUP",
+      "collapsible": true,
+      "properties": [
+        {
+          "name": "testId",
+          "label": "Test ID",
+          "format": "TEXT",
+          "ignorePattern": "[^-_\\p{N}\\p{L}]",
+          "includeAnnotations": false
+        }
+      ]
+    }
+  ],
+  "defaultConfig": {
+    "caption": "@L $this.label",
+    "trueLabel": "@L Yes",
+    "falseLabel": "@L No"
+  }
+}

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

@@ -0,0 +1,44 @@
+import { useState } from 'react';
+import { withKnobs, text, boolean } from '@storybook/addon-knobs';
+
+import {{COMPONENT_CLASS_NAME}} from './index.jsx';
+
+export default {
+  title: '{{COMPONENT_CLASS_NAME}}',
+  decorators: [withKnobs],
+  component: {{COMPONENT_CLASS_NAME}}
+};
+
+export const base{{COMPONENT_CLASS_NAME}} = () => {
+  const [value, setValue] = useState('test value');
+
+  const props = {
+    getPConnect: () => {
+      return {
+        getActionsApi: () => {
+          return {
+            updateFieldValue: (propName, value) => {
+              setValue(value);
+            }
+          };
+        },
+        getStateProps: () => {
+          return { value: '.name' };
+        }
+      };
+    },
+    value,
+    placeholder: text('Placeholder', 'Test placeholder'),
+    disabled: boolean('Disabled', false),
+    readOnly: boolean('Disabled', false),
+    required: boolean('Disabled', false),
+    label: text('Label', 'Sample Label'),
+    testId: text('Test id', 'text-12344566')
+  };
+
+  return (
+    <>
+      <{{COMPONENT_CLASS_NAME}} {...props} />
+    </>
+  );
+};

package/src/tasks/create/templates/Constellation/Field/Boolean/event-utils.js.mustache

@@ -0,0 +1,18 @@
+const handleEvent = (actions, eventType, propName, value) => {
+  switch (eventType) {
+    case "change":
+      actions.updateFieldValue(propName, value);
+      break;
+    case "blur":
+      actions.triggerFieldChange(propName, value);
+      break;
+    case "changeNblur":
+      actions.updateFieldValue(propName, value);
+      actions.triggerFieldChange(propName, value);
+      break;
+    default:
+      break;
+  }
+};
+
+export default handleEvent;

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

@@ -0,0 +1,171 @@
+import {
+  Checkbox as CosmosCheckbox,
+  CheckboxGroup,
+  FieldValueList,
+  Text
+} from "@pega/cosmos-react-core";
+import PropTypes from "prop-types";
+
+// includes in bundle
+import { format } from "./boolean-format";
+import handleEvent from "./event-utils";
+
+import Styled{{COMPONENT_CLASS_NAME}}Wrapper from './styles';
+
+// 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
+const {{COMPONENT_CLASS_NAME}} = props => {
+  const {
+    getPConnect,
+    value,
+    label,
+    helperText,
+    caption,
+    validatemessage,
+    hideLabel,
+    testId,
+    additionalProps,
+    displayMode,
+    variant,
+    trueLabel,
+    falseLabel
+  } = props;
+  const pConn = getPConnect();
+  const actions = pConn.getActionsApi();
+  const propName = pConn.getStateProps().value;
+
+  let { readOnly, required, disabled } = props;
+  [readOnly, required, disabled] = [readOnly, required, disabled].map(
+    (prop) => prop === true || (typeof prop === 'string' && prop === 'true')
+  );
+
+  let status = "";
+  if (validatemessage !== "") {
+    status = "error";
+  }
+
+  const aCosmosCheckbox = (
+    <CosmosCheckbox
+      {...additionalProps}
+      className="standard"
+      checked={value}
+      label={caption}
+      disabled={disabled}
+      readOnly={readOnly}
+      required={required}
+      onClick={actions.onClick}
+      onChange={(event) => {
+        handleEvent(actions, "changeNblur", propName, event.target.checked);
+      }}
+      onBlur={(event) => {
+        pConn.getValidationApi().validate(event.target.checked);
+      }}
+      data-testid={testId}
+    />
+  );
+
+  const parentTestId = testId ? `${testId}-parent` : testId;
+
+  let displayComponent;
+  if (displayMode) {
+    displayComponent = <BooleanDisplay value={value} trueLabel={trueLabel} falseLabel={falseLabel}></BooleanDisplay>;
+  }
+
+  if (displayMode === 'DISPLAY_ONLY') {
+    return ( <Styled{{COMPONENT_CLASS_NAME}}Wrapper> displayComponent </Styled{{COMPONENT_CLASS_NAME}}Wrapper>);
+  }
+
+  if (displayMode === "LABELS_LEFT") {
+    return (
+      <Styled{{COMPONENT_CLASS_NAME}}Wrapper>
+      <FieldValueList
+        variant={hideLabel ? 'stacked' : variant}
+        data-testid={testId}
+        fields={[{ id: '1', name: hideLabel ? '' : caption, value: displayComponent }]}
+      />
+     </Styled{{COMPONENT_CLASS_NAME}}Wrapper>
+    );
+  }
+
+  if (displayMode === "STACKED_LARGE_VAL") {
+    return (
+      <Styled{{COMPONENT_CLASS_NAME}}Wrapper>
+      <FieldValueList
+        variant='stacked'
+        data-testid={testId}
+        fields={[
+          {
+            id: '2',
+            name: hideLabel ? '' : caption,
+            value: (
+              <Text variant='h1' as='span'>
+                {displayComponent}
+              </Text>
+            )
+          }
+        ]}
+      />
+      </Styled{{COMPONENT_CLASS_NAME}}Wrapper>
+    );
+  }
+
+
+  return (
+    <Styled{{COMPONENT_CLASS_NAME}}Wrapper>
+    <CheckboxGroup
+      label={label}
+      labelHidden={hideLabel}
+      data-testid={parentTestId}
+      info={validatemessage || helperText}
+      status={status}
+    >
+      {aCosmosCheckbox}
+    </CheckboxGroup>
+    </Styled{{COMPONENT_CLASS_NAME}}Wrapper>
+  );
+
+
+};
+
+
+{{COMPONENT_CLASS_NAME}}.defaultProps = {
+  validatemessage: '',
+  value: false,
+  label: '',
+  hideLabel: false,
+  helperText: '',
+  disabled: false,
+  readOnly: false,
+  required: false,
+  testId: null,
+  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 {{COMPONENT_CLASS_NAME}};

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

@@ -0,0 +1,7 @@
+import styled, { css } from 'styled-components';
+
+export default styled.div(() => {
+  return css`
+    margin: 8px 0;
+  `;
+});