@pega/custom-dx-components 0.242.17 → 0.242.18

package/src/tasks/publish-lib/index.js

@@ -97,121 +97,134 @@ export default async (options) => {
   let devBuild;
 
   let libraryName;
+  let noRealPublish = false;
 
 
-  if (options.params.length >= 6) {
-    organization = options.params[3];
-    library = options.params[4];
-    version = options.params[5];
-    libraryName = organization.concat("_").concat(library);
+  if (options.params.length === 5) {
+    libraryName = options.params[3];
+    version = options.params[4];
+  }
+  else if (options.params.length === 6) {
+    libraryName = options.params[3];
+    version = options.params[4];
+    noRealPublish = true;
   }
-  else {
 
-    if (options.params.length == 5) {
-      libraryName = options.params[3];
-      version = options.params[4];
-    }
+  const tokenAndStaticServer = await getC11NB2STokenAndStaticServer();
 
-    const tokenAndStaticServer = await getC11NB2STokenAndStaticServer();
+  if (tokenAndStaticServer.C11NB2S === undefined) {
+    console.log(chalk.redBright("Need to authenticate, missing services token.\nPublishing a library requires authentication to acquire a token to publish."));
+    process.exit(1);
+  }
 
-    if (tokenAndStaticServer.C11NB2S === undefined) {
-      console.log(chalk.redBright("Need to authenticate, missing services token.\nPublishing a library requires authentication to acquire a token to publish."));
-      process.exit(1);
-    }
+  let libVersions = [];
+  if (!libraryName) {
+    const compDef = await getOrgLib();
+    organization = compDef.organization;
+    library = compDef.library;
 
-    let libVersions = [];
-    if (!libraryName) {
-      const compDef = await getOrgLib();
-      organization = compDef.organization;
-      library = compDef.library;
+    libraryName = organization.concat("_").concat(library);
 
-      libraryName = organization.concat("_").concat(library);
+    console.log(`\nLibrary ${chalk.bold.green(libraryName)} `)
 
-      console.log(`\nLibrary ${chalk.bold.green(libraryName)} `)
 
+    try {
+      libVersions = await getLocalLibraryVersions(libraryName);
+    }
+    catch (ex) {}
+  }
 
-      try {
-        libVersions = await getLocalLibraryVersions(libraryName);
-      }
-      catch (ex) {}
+  if (libVersions.length > 0 || version) {
+
+    if (!version) {
+      const versionQuestions = await getLibraryVersionQuestion(libVersions);
+      const versionAnswers = await inquirer.prompt(versionQuestions);
+
+      ({version} = versionAnswers);
     }
 
-    if (libVersions.length > 0 || version) {
 
-      if (!version) {
-        const versionQuestions = await getLibraryVersionQuestion(libVersions);
-        const versionAnswers = await inquirer.prompt(versionQuestions);
+    let okToPublish = true;
 
-        ({version} = versionAnswers);
-      }
+    // this check matches check below, but for JEST, we don't want to go any further, just verifying if will
+    // be caught
+    if (noRealPublish && !version.includes("-dev")) {
+      console.log("PRODUCTION, no publish");
+      return;
+    }
 
+    if (!version.includes("-dev")) {
+      okToPublish = false;
+      const publishAnswers = await inquirer.prompt([
 
-      let okToPublish = true;
-      if (!version.includes("-dev")) {
-        okToPublish = false;
-        const publishAnswers = await inquirer.prompt([
-
-          {
-            name: 'confirmPublish',
-            type: 'confirm',
-            message: 'You are about to publish a PRODUCTION version which can NOT be deleted, proceed ?',
-            default: false
-          }
-        ]);
-        if (publishAnswers.confirmPublish) {
-          okToPublish = true;
+        {
+          name: 'confirmPublish',
+          type: 'confirm',
+          message: `You are about to publish a ${chalk.bold.yellow('PRODUCTION')} version which can ${chalk.bold.yellow('NOT')} be deleted, proceed ?`,
+          default: false
         }
+      ]);
+      if (publishAnswers.confirmPublish) {
+        okToPublish = true;
       }
+    }
 
-      if (okToPublish) {
+    if (noRealPublish) {
+      // this is as far as JEST test can go since need server for rest and don't want to use server.
+      console.log("OK to publish.");
+      return;
+    }
 
-        let libVersionExists = await doesLibraryExist(libraryName, version);
-        let overrideExisting = false;
-        let checkDeleted = false;
+    if (okToPublish) {
 
-        await deletePublishExtras(libraryName, version);
+      let libVersionExists = await doesLibraryExist(libraryName, version);
+      let overrideExisting = false;
+      let checkDeleted = false;
 
-        if (libVersionExists) {
-            console.log("\nLibrary " + chalk.bold.yellow(`${libraryName}:${version}`) + " already exists.");
-            const questions = [
-              {
-                name: 'override',
-                type: 'confirm',
-                message: `Do you wish to overrite it`,
-                default: false
-              }
-            ];
+      await deletePublishExtras(libraryName, version);
 
-            await inquirer.prompt(questions).then(async answers => {
-              overrideExisting = answers.override;
-              });
-        }
 
-        if (libVersionExists) {
-          if (overrideExisting) {
-            console.log("\nDeleting existing library " + chalk.bold.yellow(`${libraryName}:${version}`) + " ...");
-            await deleteLibVersion(libraryName, version, tokenAndStaticServer.C11NB2S, tokenAndStaticServer.appStaticContentServer);
-
-            checkDeleted = true;
-          }
-          else {
-            // don't override, so end
-            console.log(chalk.yellow(`You will need to increment your library version to publish`));
-            return;
-          }
-        }
+      if (libVersionExists) {
+          console.log("\nLibrary " + chalk.bold.yellow(`${libraryName}:${version}`) + " already exists.");
+          const questions = [
+            {
+              name: 'override',
+              type: 'confirm',
+              message: `Do you wish to overrite it`,
+              default: false
+            }
+          ];
 
-        // need a timeout to give services time to delete the library
-        setTimeout( function(){ publishNewLibraryAsync(libraryName, version, checkDeleted)}, 700 );
+          await inquirer.prompt(questions).then(async answers => {
+            overrideExisting = answers.override;
+            });
+      }
+
+      if (libVersionExists) {
+        if (overrideExisting) {
+          console.log("\nDeleting existing library " + chalk.bold.yellow(`${libraryName}:${version}`) + " ...");
+          await deleteLibVersion(libraryName, version, tokenAndStaticServer.C11NB2S, tokenAndStaticServer.appStaticContentServer);
 
+          checkDeleted = true;
+        }
+        else {
+          // don't override, so end
+          console.log(chalk.yellow(`You will need to increment your library version to publish`));
+          return;
+        }
       }
 
-    }
-    else {
-      console.log(chalk.bold.redBright(`No library versions in ${libraryName}`));
+      // need a timeout to give services time to delete the library
+      setTimeout( function(){ publishNewLibraryAsync(libraryName, version, checkDeleted)}, 700 );
+
     }
 
   }
+  else {
+    console.log(chalk.bold.redBright(`No library versions in ${libraryName}`));
+  }
+
+
 
   return true;
 };

package/src/tasks/rename-lib/index.js

@@ -27,7 +27,7 @@ import {
   getComponents,
   sanitize
 } from '../../util.js';
-import { deleteLocalComponents } from '@pega/custom-dx-components/src/tasks/delete/helper.js';
+
 
 const copy = promisify(ncp);
 
@@ -132,6 +132,10 @@ export const renameLibrary = async ({library, organization}, options) => {
 
   // reaname all the components
   const components = await getComponents();
+
+
+
+
   for (const index in components) {
     const componentKey = components[index];
     const componentName = componentKey.split('_')[2];
@@ -144,6 +148,11 @@ export const renameLibrary = async ({library, organization}, options) => {
     const description = configData.description.substring(0, configData.description.indexOf("(")).concat(`(${newOrgLib})`);
     const version = configData.version;
     compVersion = version;
+
+    // can only rename "devBuilds", so if version doesn't have "-dev", add it and will create dev version
+    if (compVersion && compVersion.indexOf("-dev") === -1){
+      compVersion = compVersion.concat("-dev");
+    }
     const allowedApplications = configData.allowedApplications;
 
     await renameComponent({library, organization, componentKey, componentName, componentLabel,
@@ -168,7 +177,10 @@ export const renameLibrary = async ({library, organization}, options) => {
   // call constellation-dx-components-build-utils build library, which will create a directory of the "buildLibName"
   // with subdirectories for each version.
   // If "buildDev", we append to version "-dev".  Currently, only "-dev" versions, when published, can be deleted.
-  buildLib(newOrgLib, compVersion, tokenAndStaticServer.C11NB2S, tokenAndStaticServer.appStaticContentServer);
+  if(newOrgLib && compVersion) {
+    buildLib(newOrgLib, compVersion, tokenAndStaticServer.C11NB2S, tokenAndStaticServer.appStaticContentServer);
+  }
+
 
 
 
@@ -286,9 +298,9 @@ export default async options => {
   const localComponents = await getComponentsObj();
 
 
-  if (options.params.length >= 11) {
-    const organization = options.params[6];
-    const library = options.params[8];
+  if (options.params.length >= 5) {
+    const organization = options.params[3];
+    const library = options.params[4];
 
 
     await renameLibrary(

package/src/util.js

@@ -127,6 +127,34 @@ export const getLibraryBased = async () => {
   else return false;
 }
 
+export const setLibraryBased = async (isLibraryBased) => {
+  const currentDirectory = process.cwd();
+  const pegaConfigJsonPath = join(currentDirectory, TASKS_CONFIG_JSON_FILENAME);
+
+  try {
+    // force to throw error and not console log
+    await checkPathAccess(pegaConfigJsonPath, {}, true);
+  }
+  catch (ex) {
+    // when can't find it, always be false, assume no library based.
+    // This is IMPORTANT for init (npx install)
+    return false;
+  }
+
+  let data = fs.readFileSync(pegaConfigJsonPath, { encoding: 'utf8' });
+  data = JSON.parse(data);
+
+  if (data[LIBRARY_BASED] != undefined) {
+    data[LIBRARY_BASED] = isLibraryBased;
+
+    // update file
+    // stringify "4", makes the json string look like JSON in the file, formated instead of a single line
+    fs.writeFileSync(pegaConfigJsonPath, JSON.stringify(data, null, 4), { encoding: 'utf8' });
+  }
+
+}
+
+
 export const deleteLocalComponent = async componentKey => {
   const currentDirectory = process.cwd();
   const pegaConfigJsonPath = join(currentDirectory, TASKS_CONFIG_JSON_FILENAME);
@@ -790,24 +818,22 @@ export const deleteLocalLibrary = async (libraryName) => {
   // for some odd reason, it errors out with an error in "err", but it does delete
   // all the contents.  The try/catch then calls again to delete the top level
   try {
-    fs.rmSync(directory, { recursive: true, force: true, maxRetries: 2 }, err => {
-      if (err) {
-        throw err;
-      }
-      else {
-        console.log(`Library:${chalk.green.bold(libraryName)} is deleted from Local`);
-      }
-    });
+    if (fs.existsSync(directory)) {
+      fs.rmSync(directory, { recursive: true, force: true, maxRetries: 2 });
+      console.log(`Library: ${chalk.green.bold(libraryName)} is deleted from Local`);
+    }
+    else {
+      console.log(`Library: ${chalk.red.bold(libraryName)} does not exist.`);
+    }
   }
   catch (ex) {
-    fs.rmSync(directory, { recursive: true, force: true, maxRetries: 2 }, err => {
-      if (err) {
-        throw err;
-      }
-      else {
-        console.log(`Library:${chalk.green.bold(libraryName)} is deleted from Local`);
-      }
-    });
+    if (fs.existsSync(directory)) {
+      fs.rmSync(directory, { recursive: true, force: true, maxRetries: 2 });
+      console.log(`Library: ${chalk.green.bold(libraryName)} is deleted from Local`);
+    }
+    else {
+      console.log(`Library: ${chalk.red.bold(libraryName)} does not exist.`);
+    }
   }
 
 
@@ -818,14 +844,23 @@ export const deleteLocalLibraryVersion = async (libraryName, libraryVersion) =>
   const currentDirectory = process.cwd();
 
   const directory = join(currentDirectory, libraryName, libraryVersion);
-  fs.rmSync(directory, { recursive: true }, err => {
-    if (err) {
-      throw err;
+
+  try {
+    if (fs.existsSync(directory)) {
+      console.log(`Deleting library version: ${chalk.green.bold(libraryName)}:${chalk.green.bold(libraryVersion)}`);
+      fs.rmSync(directory, { recursive: true, force: true, maxRetries: 2  });
+      console.log(`Library version: ${chalk.green.bold(libraryName)}:${chalk.green.bold(libraryVersion)} is deleted from Local`);
     }
     else {
-      console.log(`Library version:${chalk.green.bold(libraryName)}:${chalk.green.bold(libraryVersion)} is deleted from Local`);
+      console.log(`Library version: ${chalk.red.bold(libraryName)}:${chalk.red.bold(libraryVersion)} does not exist.`);
     }
-  });
+
+  }
+  catch (error) {
+    throw error;
+  }
+
+
 }
 
 export const deletePublishExtras = async (libraryName, libraryVersion) => {

package/tests/assets/library/components/create/Pega_DXIL_MyTestText/config.json

@@ -0,0 +1,55 @@
+{
+  "name": "Pega_DXIL_MyTestText",
+  "label": "My Test Text (Pega_DXIL)",
+  "description": "My Test Text Description (Pega_DXIL)",
+  "organization": "Pega",
+  "version": "0.0.1",
+  "library": "DXIL",
+  "allowedApplications": [],
+  "componentKey": "Pega_DXIL_MyTestText",
+  "type": "Field",
+  "subtype": "Text",
+  "properties": [
+    {
+      "name": "label",
+      "label": "Label value",
+      "format": "TEXT"
+    },
+    {
+      "name": "placeholder",
+      "label": "Placeholder",
+      "format": "TEXT"
+    },
+    {
+      "name": "visibility",
+      "label": "Visible",
+      "format": "VISIBILITY"
+    },
+    {
+      "name": "disabled",
+      "label": "Disabled",
+      "format": "DISABLED"
+    },
+    {
+      "name": "required",
+      "label": "Required",
+      "format": "REQUIRED"
+    },
+    {
+      "label": "Advanced",
+      "format": "GROUP",
+      "collapsible": true,
+      "properties": [
+        {
+          "name": "testId",
+          "label": "Test ID",
+          "format": "TEXT",
+          "ignorePattern": "[^-_\\p{N}\\p{L}]",
+          "includeAnnotations": false
+        }
+      ]
+    }
+  ],
+  "defaultConfig": {
+  }
+}

package/tests/assets/library/components/create/Pega_DXIL_MyTestText/demo.stories.tsx

@@ -0,0 +1,67 @@
+
+/* eslint-disable react/jsx-no-useless-fragment */
+import { useState } from 'react';
+import type { Meta, StoryObj } from '@storybook/react';
+
+import { stateProps, configProps } from './mock';
+
+import PegaDxilMyTestText from './index';
+
+const meta: Meta<typeof PegaDxilMyTestText> = {
+  title: 'PegaDxilMyTestText',
+  component: PegaDxilMyTestText,
+  excludeStories: /.*Data$/
+};
+
+export default meta;
+type Story = StoryObj<typeof PegaDxilMyTestText>;
+
+export const BasePegaDxilMyTestText: Story = (args: any) => {
+
+  const [value, setValue] = useState(configProps.value);
+
+  const props = {
+    value,
+    hasSuggestions: configProps.hasSuggestions,
+
+    getPConnect: () => {
+      return {
+        getStateProps: () => {
+          return stateProps;
+        },
+        getActionsApi: () => {
+          return {
+            updateFieldValue: (propName: string, theValue: any) => {
+              setValue(theValue);
+            },
+            triggerFieldChange: () => {/* nothing */}
+          };
+        },
+        ignoreSuggestion: () => {/* nothing */},
+        acceptSuggestion: () => {/* nothing */},
+        setInheritedProps: () => {/* nothing */},
+        resolveConfigProps: () => {/* nothing */}
+      };
+    }
+  };
+
+  return (
+    <>
+      <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/library/components/create/Pega_DXIL_MyTestText/index.tsx

@@ -0,0 +1,145 @@
+import {
+  Input,
+  FieldValueList,
+  Text,
+  EmailDisplay,
+  PhoneDisplay,
+  URLDisplay,
+  withConfiguration
+} from '@pega/cosmos-react-core';
+
+import type { PConnFieldProps } from '../shared/PConnProps';
+
+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
+interface StateProps {
+  value: string;
+  hasSuggestions: boolean;
+}
+
+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
+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
+        type='text'
+        value={value}
+        label={label}
+        labelHidden={hideLabel}
+        placeholder={placeholder}
+        disabled={disabled}
+        readOnly={readOnly}
+        required={required}
+        onChange={handleOnChange}
+        testId={testId}
+      />
+    </StyledPegaDxilMyTestTextWrapper>
+  );
+};
+
+
+export default withConfiguration(PegaDxilMyTestText);

package/tests/assets/library/components/create/Pega_DXIL_MyTestText/mock.ts

@@ -0,0 +1,21 @@
+
+export const configProps = {
+  value: '',
+  label: 'Text Sample',
+  placeholder: 'Text Placeholder',
+  helperText: 'Text Helper Text',
+  testId: 'Text-12345678',
+  hasSuggestions: false,
+  displayMode: '',
+  hideLabel: false,
+  readOnly: false,
+  required: false,
+  disabled: false,
+  status: '',
+  validatemessage: ''
+};
+
+export const stateProps = {
+  value: '.TextSample',
+  hasSuggestions: false
+};