@pega/dx-component-builder-sdk 0.25.6 → 0.26.1

package/package.json

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

package/src/constants.js

@@ -40,6 +40,8 @@ export const CATEGORY_CUSTOM = 'custom';
 export const CATEGORY_OVERRIDE = 'override';
 export const CATEGORY_CONSTELLATION = 'constellation';
 
+export const MAX_RFT_CHARS = 64;
+
 /* REST end points */
 export const PUBLISH_COMPONENT_SERVICE_REST_ENDPOINT = 'PRRestService/dev/v1/publish_component';
 export const LIST_COMPONENT_SERVICE_REST_ENDPOINT = 'PRRestService/dev/v1/list_component';
@@ -313,6 +315,10 @@ export const COMPONENT_SCHEMA = {
         name: 'Email',
         value: 'Email'
       },
+      {
+        name: 'EmbeddedData Multi',
+        value: 'EmbeddedDataMulti'
+      },
       {
         name: 'Field Group',
         value: 'Group'
@@ -864,14 +870,6 @@ export const COMPONENT_SCHEMA = {
         name: 'Material Case Summary',
         value: 'MaterialCaseSummary'
       },
-      {
-        name: 'Material Details',
-        value: 'MaterialDetails'
-      },
-      {
-        name: 'Material Details Fields',
-        value: 'MaterialDetailsFields'
-      },
       {
         name: 'Material Summary Item',
         value: 'MaterialSummaryItem'
@@ -1100,6 +1098,10 @@ export const COMPONENT_SCHEMA = {
         name: 'Repeating Structures',
         value: 'RepeatingStructures'
       },
+      {
+        name: 'Search Form',
+        value: 'DataReference/SearchForm'
+      },
       {
         name: 'Search Groups',
         value: 'AdvancedSearch/SearchGroups'

package/src/tasks/create/index.js

@@ -10,7 +10,10 @@ import chalk from 'chalk';
 
 import { checkPathAccess,
   showVersion,
-  getFramework} from '../../util.js';
+  getFramework,
+  updateComponentDefaultLibrary,
+  getStandaloneMaxComponentNameCount,
+  getStandaloneMaxLibraryCount} from '../../util.js';
 import { CATEGORY_CONSTELLATION, CATEGORY_CUSTOM,
   SDK_CONFIG_JSON_FILENAME,
   DXCB_CONFIG,
@@ -37,6 +40,7 @@ import {
   validateSemver
 } from '../../util.js';
 import { COMPONENT_SCHEMA } from '../../constants.js';
+import { getPrettierFormattedString } from '../map/map.js';
 
 const copy = promisify(ncp);
 
@@ -70,8 +74,7 @@ export const compileMustacheTemplates = async (
     type,
     subtype,
     description,
-    organization,
-    allowedApplications
+    organization
   }, componentType
 ) => {
   const files = fs.readdirSync(componentDirectory);
@@ -115,20 +118,20 @@ export const compileMustacheTemplates = async (
 
   const isPicklist = subtype === 'Picklist';
 
-  if (allowedApplications.trim() === '') {
-    allowedApplications = [];
-  } else {
-    if (allowedApplications.indexOf(',') !== -1) {
-      allowedApplications = allowedApplications.split(',');
-    }
-    allowedApplications = [].concat(allowedApplications);
-  }
+  // if (allowedApplications.trim() === '') {
+  //   allowedApplications = [];
+  // } else {
+  //   if (allowedApplications.indexOf(',') !== -1) {
+  //     allowedApplications = allowedApplications.split(',');
+  //   }
+  //   allowedApplications = [].concat(allowedApplications);
+  // }
 
   const componentKeyKebab = convertIntoKebabCase(convertIntoPascalCase(componentKey));
   const framework = await getFramework();
 
-  allowedApplications = allowedApplications.filter(el => !!el.trim()).map(el => el.trim());
-  files.forEach(file => {
+  // allowedApplications = allowedApplications.filter(el => !!el.trim()).map(el => el.trim());
+  for (const file of files) {
 
     const filePath = path.join(componentDirectory, file);
 
@@ -141,7 +144,6 @@ export const compileMustacheTemplates = async (
       ORGANIZATION: organization,
       VERSION: version,
       LIBRARY: library,
-      ALLOWEDAPPS: JSON.stringify(allowedApplications),
       TYPE: type,
       SUB_TYPE: JSON.stringify(mustacheSubType),
       DESCRIPTION: description || componentLabel,
@@ -150,7 +152,10 @@ export const compileMustacheTemplates = async (
       IS_BOOLEAN: isBool,
       IS_PHONE: isPhone
     });
-    fs.writeFileSync(filePath, output);
+
+    const formattedOutput = await getPrettierFormattedString(output, filePath.replace(/\.mustache$/, ''));
+
+    fs.writeFileSync(filePath, formattedOutput);
 
     switch (framework) {
       case "SDK-React":
@@ -170,8 +175,7 @@ export const compileMustacheTemplates = async (
         break;
     }
 
-
-  });
+  }
 };
 
 
@@ -188,8 +192,7 @@ export const validateCompile = async (
     framework,
     type,
     subtype,
-    description,
-    allowedApplications
+    description
   },
   options,
   onlyCompanion = false
@@ -200,6 +203,12 @@ export const validateCompile = async (
     sSubType = subtype.join("-");
   }
 
+  // update defaults when changes
+  const configDef = await getComponentDefaults();
+  if (configDef.library == null || configDef.library !== library) {
+    await updateComponentDefaultLibrary(library);
+  }
+
   const typeLC = type.toLowerCase();
 
   await checkPathAccess(pegaConfigInternalJsonPath);
@@ -285,8 +294,7 @@ export const validateCompile = async (
       type,
       subtype,
       description,
-      organization,
-      allowedApplications
+      organization
     }, "component");
   }
 
@@ -305,8 +313,7 @@ export const validateCompile = async (
     type,
     subtype,
     description,
-    organization,
-    allowedApplications
+    organization
   }, "associated");
 
   if (!onlyCompanion) {
@@ -322,6 +329,15 @@ export default async options => {
 
   const framework = await getFramework();
 
+  if (framework === 'SDK-React') {
+    console.log(
+      chalk.red(
+        'Custom-constellation are aligned with Pega constellation which is still on react 18.\n' +
+        'Please make sure any changes to custom-constellation should be aligned with React 18 development.'
+      )
+    );
+  }
+
   if (options.params.length >= 12) {
     const type = options.params[3];
     const subtype = options.params[4];
@@ -343,7 +359,6 @@ export default async options => {
         type,
         subtype,
         description,
-        allowedApplications,
         organization
       },
       options
@@ -369,6 +384,7 @@ export default async options => {
     let componentDefaults = await getComponentDefaults();
     componentDefaults.library = library;
 
+    const maxChars = await getStandaloneMaxComponentNameCount();
 
     const questions = [
       {
@@ -417,7 +433,7 @@ export default async options => {
       },
       {
         name: 'componentName',
-        message: 'Enter component name (required, no spaces)',
+        message: `Enter component name (required, no spaces) (${maxChars} max chars)`,
         validate: value => {
           /* value should not be empty
           It should not have spaces
@@ -425,6 +441,9 @@ export default async options => {
           Only case-insensitive alphanumeric values are allowed
         */
           if (value && !/^\d/.test(value) && value === sanitize(value)) {
+            if (value.length > maxChars) {
+              return `${value.length - maxChars} too many characters.`
+            }
             return true;
           }
           return 'Only alphanumeric values are allowed, starting with alphabets';
@@ -450,10 +469,16 @@ export default async options => {
           }
           return 'Please provide semver compatible version e.g 0.0.1';
         }
-      },
+      }
+    ];
+
+    const answers = await inquirer.prompt(questions);
+    const maxLibChars = await getStandaloneMaxLibraryCount(answers.componentName);
+
+    const libQuestions = [
       {
         name: 'library',
-        message: 'Enter library name (required)',
+        message: `Enter library name (required) (${maxLibChars} max chars)`,
         default: componentDefaults.library,
         validate: value => {
           /* value should not be empty
@@ -462,16 +487,14 @@ export default async options => {
             Only case-insensitive alphanumeric values are allowed
           */
           if (value && !/^\d/.test(value) && value === sanitize(value)) {
+            if (value.length > maxLibChars) {
+              return `${value.length - maxLibChars} too many characters.`
+            }
             return true;
           }
           return 'Only alphanumeric values are allowed, starting with alphabets';
         }
       },
-      {
-        name: 'allowedApplications',
-        message: 'Please enter the application names to be supported (comma-separated). ',
-        suffix: 'Keep empty for all applications'
-      },
       {
         name: 'description',
         message: 'Enter description for the component (defaults to label)',
@@ -481,33 +504,21 @@ export default async options => {
       }
     ];
 
-    await inquirer.prompt(questions).then(async answers => {
-      const {
-        componentName,
-        componentLabel,
-        library,
-        version,
-        framework,
-        type,
-        subtype,
-        description,
-        allowedApplications
-      } = answers;
-      await validateCompile(
+    const libAnswers = await inquirer.prompt(libQuestions);
+
+    await validateCompile(
         {
-          componentName,
-          componentLabel,
-          library,
-          version,
+          componentName : answers.componentName,
+          componentLabel : answers.componentLabel,
+          library: libAnswers.library,
+          version: answers.version,
           framework,
-          type,
-          subtype,
-          description,
-          allowedApplications,
+          type : answers.type,
+          subtype : answers.subtype,
+          description: libAnswers.descriptions,
           organization
         },
         options
-      );
-    });
+      );  
   }
 };

package/src/tasks/create/templates/Constellation/field/Boolean/Boolean.ts.mustache

@@ -1,25 +1,11 @@
 function Boolean(value: any, { allowEmpty = true, tick = '', cross = '' } = {}) {
-  if (
-    (!allowEmpty && !value) ||
-    value === false ||
-    value?.toString()?.toLowerCase() === 'false' ||
-    value === 0 ||
-    value === '0'
-  ) {
+  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'
-  ) {
+  if (value === true || value?.toString()?.toLowerCase() === 'true' || value === 1 || value === '1') {
     return tick || '';
   }
-  if (
-    allowEmpty &&
-    (value === 'null' || value === '' || value === null || typeof value === 'undefined')
-  ) {
+  if (allowEmpty && (value === 'null' || value === '' || value === null || typeof value === 'undefined')) {
     return '––';
   }
   return value;

package/src/tasks/create/templates/Constellation/field/Boolean/PConnProps.d.ts.mustache

@@ -1,4 +1,4 @@
-import  {PConnect } from '@pega/pcore-pconnect-typedefs';
+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
@@ -22,25 +22,24 @@ export interface PConnProps {
   // [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
+  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/Boolean/boolean-format.ts.mustache

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

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

@@ -5,7 +5,6 @@
   "organization": "{{ORGANIZATION}}",
   "version": "{{VERSION}}",
   "library": "{{LIBRARY}}",
-  "allowedApplications": {{{ALLOWEDAPPS}}},
   "componentKey": "{{COMPONENT_KEY}}",
   "type": "{{TYPE}}",
   "subtype": {{{SUB_TYPE}}},

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

@@ -1,5 +1,3 @@
-
-/* eslint-disable react/jsx-no-useless-fragment */
 import { useState } from 'react';
 import type { Meta, StoryObj } from '@storybook/react';
 
@@ -17,7 +15,6 @@ export default meta;
 type Story = StoryObj<typeof {{COMPONENT_CLASS_NAME}}>;
 
 export const Base{{COMPONENT_CLASS_NAME}}: Story = (args: any) => {
-
   const [value, setValue] = useState(configProps.value);
 
   const props = {
@@ -33,12 +30,16 @@ export const Base{{COMPONENT_CLASS_NAME}}: Story = (args: any) => {
             updateFieldValue: (propName: string, theValue: any) => {
               setValue(theValue);
             },
-            triggerFieldChange: () => { /* nothing */}
+            triggerFieldChange: () => {
+              /* nothing */
+            }
           };
         },
         getValidationApi: () => {
           return {
-            validate: () => { /* nothing */}
+            validate: () => {
+              /* nothing */
+            }
           };
         }
       };

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

@@ -1,17 +1,10 @@
-import {
-  Checkbox as CosmosCheckbox,
-  CheckboxGroup,
-  FieldValueList,
-  Text,
-  withConfiguration,
-  BooleanDisplay
-} from "@pega/cosmos-react-core";
+import { Checkbox as CosmosCheckbox, CheckboxGroup, FieldValueList, Text, withConfiguration, BooleanDisplay } from '@pega/cosmos-react-core';
 
 import type { PConnFieldProps } from './PConnProps';
 import './create-nonce';
 
 // includes in bundle
-import handleEvent from "./event-utils";
+import handleEvent from './event-utils';
 import Styled{{COMPONENT_CLASS_NAME}}Wrapper from './styles';
 
 // interface for props
@@ -64,29 +57,27 @@ function {{COMPONENT_CLASS_NAME}}(props: {{COMPONENT_CLASS_NAME}}Props) {
   const propName: string = stateProps.value;
 
   let { readOnly = false, required = false, disabled = false } = props;
-  [readOnly, required, disabled] = [readOnly, required, disabled].map(
-    (prop) => prop === true || (typeof prop === 'string' && prop === 'true')
-  );
+  [readOnly, required, disabled] = [readOnly, required, disabled].map(prop => prop === true || (typeof prop === 'string' && prop === 'true'));
 
-  let status: "error" | "success" | "warning" | "pending" | undefined;
-  if (validatemessage !== "") {
-    status = "error";
+  let status: 'error' | 'success' | 'warning' | 'pending' | undefined;
+  if (validatemessage !== '') {
+    status = 'error';
   }
 
   const aCosmosCheckbox = (
     <CosmosCheckbox
       {...additionalProps}
-      className="standard"
+      className='standard'
       checked={value}
       label={caption}
       disabled={disabled}
       readOnly={readOnly}
       required={required}
       onClick={actionsProps.onClick}
-      onChange={(event) => {
-        handleEvent(actions, "changeNblur", propName, event.target.checked);
+      onChange={event => {
+        handleEvent(actions, 'changeNblur', propName, event.target.checked);
       }}
-      onBlur={(event: { target: { checked: any; }; }) => {
+      onBlur={(event: { target: { checked: any } }) => {
         pConn.getValidationApi().validate(event.target.checked);
       }}
       data-testid={testId}
@@ -97,70 +88,54 @@ function {{COMPONENT_CLASS_NAME}}(props: {{COMPONENT_CLASS_NAME}}Props) {
 
   let displayComponent;
   if (displayMode) {
-    displayComponent = (
-      <BooleanDisplay value={value} trueLabel={trueLabel} falseLabel={falseLabel} />
-    );
+    displayComponent = <BooleanDisplay value={value} trueLabel={trueLabel} falseLabel={falseLabel} />;
   }
 
   if (displayMode === 'DISPLAY_ONLY') {
-    return (
-      <Styled{{COMPONENT_CLASS_NAME}}Wrapper>
-       {displayComponent}
-      </Styled{{COMPONENT_CLASS_NAME}}Wrapper>
-    );
+    return <Styled{{COMPONENT_CLASS_NAME}}Wrapper>{displayComponent}</Styled{{COMPONENT_CLASS_NAME}}Wrapper>;
   }
 
-  if (displayMode === "LABELS_LEFT") {
+  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>
+        <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") {
+  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>
-            )
-          }
-        ]}
-      />
+        <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>
+      <CheckboxGroup label={label} labelHidden={hideLabel} data-testid={parentTestId} info={validatemessage || helperText} status={status}>
+        {aCosmosCheckbox}
+      </CheckboxGroup>
     </Styled{{COMPONENT_CLASS_NAME}}Wrapper>
   );
-
-
-};
-
+}
 
 export default withConfiguration({{COMPONENT_CLASS_NAME}});

package/src/tasks/create/templates/Constellation/field/Date/DateFormatter.ts.mustache

@@ -11,13 +11,8 @@ dayjs.extend(timezone);
 
 const types = ['fromNow', 'customFormat'];
 
-
-
 // value should be in ISO 8601 format.
-function DateFormatter(
-  value: any,
-  { type = types[1], format = "DD/MM/YYYY", tzone = null } = {}
-) {
+function DateFormatter(value: any, { type = types[1], format = 'DD/MM/YYYY', tzone = null } = {}) {
   if (!value) return value;
   switch (type) {
     case types[1]:
@@ -33,7 +28,7 @@ function DateFormatter(
 // value should be in hh:mm:ss format (00:00:00 - 23:59:59).
 function TimeFormatter(value: any, options: any) {
   if (!value) return value;
-  const { locale = "en-US" } = options;
+  const { locale = 'en-US' } = options;
   const timeOnlyRegex = /^(?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d)$/;
   if (value.length === 8 && timeOnlyRegex.test(value)) {
     const tempDate = new Date();
@@ -50,8 +45,7 @@ function TimeFormatter(value: any, options: any) {
 
 export default {
   Date: (value: any, options: any) => DateFormatter(value, { type: 'customFormat', ...options }),
-  'Date-Time-Default': (value: any, options: any) =>
-    DateFormatter(value, { ...options, type: 'customFormat', format: 'lll' }),
+  'Date-Time-Default': (value: any, options: any) => DateFormatter(value, { ...options, type: 'customFormat', format: 'lll' }),
   'Time-Default': (value: any, options: any) =>
     TimeFormatter(value, {
       ...options,