@pega/custom-dx-components 8.8.17 → 8.8.18

package/src/tasks/init/template/test/assets/components/createAll/Pega_DXIL_MyURL/demo.stories.jsx

@@ -0,0 +1,46 @@
+import { withKnobs } from '@storybook/addon-knobs';
+
+import PegaDxilMyUrl from './index.jsx';
+import { stateProps, configProps } from './mock.stories';
+
+export default {
+  title: 'PegaDxilMyUrl',
+  decorators: [withKnobs],
+  component: PegaDxilMyUrl
+};
+
+export const basePegaDxilMyUrl = () => {
+
+  const props = {
+    value: configProps.value,
+    placeholder: configProps.placeholder,
+    label: configProps.label,
+    helperText: configProps.helperText,
+    testId: configProps.testId,
+    hasSuggestions: configProps.hasSuggestions,
+
+    getPConnect: () => {
+      return {
+        getStateProps: () => {
+          return stateProps;
+        },
+        getActionsApi: () => {
+          return {
+            updateFieldValue: () => {/* nothing */},
+            triggerFieldChange: () => {/* nothing */}
+          };
+        },
+        ignoreSuggestion: () => {/* nothing */},
+        acceptSuggestion: () => {/* nothing */},
+        setInheritedProps: () => {/* nothing */},
+        resolveConfigProps: () => {/* nothing */}
+      };
+    }
+  };
+
+  return (
+    <>
+      <PegaDxilMyUrl {...props} />
+    </>
+  );
+};

package/src/tasks/init/template/test/assets/components/createAll/Pega_DXIL_MyURL/event-utils.js

@@ -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/init/template/test/assets/components/createAll/Pega_DXIL_MyURL/index.jsx

@@ -0,0 +1,232 @@
+import { useState, useEffect, useRef} from "react";
+import { Input, FieldValueList, Text } from "@pega/cosmos-react-core";
+import PropTypes from "prop-types";
+
+// includes in bundle
+import {formatExists,textFormatter, urlFormatter} from "./text-url.jsx";
+import handleEvent from "./event-utils";
+import { suggestionsHandler } from './suggestions-handler';
+
+import StyledPegaDxilMyUrlWrapper 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 PegaDxilMyUrl = props => {
+  const {
+    getPConnect,
+    value,
+    hideLabel,
+    placeholder,
+    validatemessage,
+    label,
+    helperText,
+    testId,
+    displayMode,
+    additionalProps,
+    variant,
+    isTableFormatter,
+    displayAs,
+    widthSel,
+    customWidth,
+    altText,
+    altTextOfImage,
+    propaltTextOfImage,
+    urlLabel,
+    propUrlLabel,
+    urlLabelSelection,
+    tableDisplayAs,
+    hasSuggestions
+  } = props;
+  const { formatter } = props;
+  const pConn = getPConnect();
+  const actions = pConn.getActionsApi();
+  const propName = pConn.getStateProps().value;
+  const hasValueChange = useRef(false);
+
+
+ // BUG-547602: Temporary type coercion for 8.5 until DXAPIs are enhanced to pass original pxViewMetadata JSON, respecting boolean primitives
+  let { readOnly, required, disabled } = props;
+  [readOnly, required, disabled] = [readOnly, required, disabled].map(
+    (prop) => prop === true || (typeof prop === 'string' && prop === 'true')
+  );
+
+  const [inputValue, setInputValue] = useState(value);
+  const [status, setStatus] = useState(hasSuggestions ? 'pending' : undefined);
+  useEffect(() => setInputValue(value), [value]);
+
+  useEffect(() => {
+    if (validatemessage !== '') {
+      setStatus('error');
+    }
+    if (hasSuggestions) {
+      setStatus('pending');
+    } else if (!hasSuggestions && status !== 'success') {
+      setStatus(validatemessage !== '' ? 'error' : undefined);
+    }
+  }, [validatemessage, hasSuggestions]);
+
+  let displayComp = null;
+  if (displayMode) {
+    displayComp = urlFormatter(value, {
+      displayAs,
+      tableDisplayAs,
+      isTableFormatter,
+      altText,
+      altTextOfImage,
+      propaltTextOfImage,
+      urlLabelSelection,
+      urlLabel,
+      propUrlLabel,
+      widthSel,
+      customWidth
+    });
+  }
+
+
+
+  if (displayMode === 'LABELS_LEFT' || displayMode === 'DISPLAY_ONLY') {
+    if (isTableFormatter && formatter !== 'URL' && formatExists(formatter)) {
+      displayComp = textFormatter(formatter, value);
+    }
+    return displayMode === 'DISPLAY_ONLY' ? (
+      displayComp
+    ) : (
+      <StyledPegaDxilMyUrlWrapper>
+      <FieldValueList
+        variant={hideLabel ? 'stacked' : variant}
+        data-testid={testId}
+        fields={[{ id: '1', name: hideLabel ? '' : label, value: displayComp }]}
+      />
+      </StyledPegaDxilMyUrlWrapper>
+    );
+  }
+
+  if (displayMode === 'STACKED_LARGE_VAL') {
+    return (
+      <StyledPegaDxilMyUrlWrapper>
+      <FieldValueList
+        variant='stacked'
+        data-testid={testId}
+        fields={[
+          {
+            id: '2',
+            name: hideLabel ? '' : label,
+            value: (
+              <Text variant='h1' as='span'>
+                {displayComp}
+              </Text>
+            )
+          }
+        ]}
+      />
+      </StyledPegaDxilMyUrlWrapper>
+    );
+  }
+
+  const onResolveSuggestionHandler = (accepted) => {
+    suggestionsHandler(accepted, pConn, setStatus);
+  };
+
+  return (
+    <StyledPegaDxilMyUrlWrapper>
+    <Input
+      {...additionalProps}
+      type='url'
+      label={label}
+      labelHidden={hideLabel}
+      info={validatemessage || helperText}
+      status={status}
+      value={inputValue}
+      placeholder={placeholder}
+      disabled={disabled}
+      readOnly={readOnly}
+      required={required}
+      data-testid={testId}
+      onChange={(event) => {
+        if (hasSuggestions) {
+          setStatus(undefined);
+        }
+        setInputValue(event.target.value);
+        if (value !== event.target.value) {
+          handleEvent(actions, 'change', propName, event.target.value);
+          hasValueChange.current = true;
+        }
+      }}
+      onBlur={(event) => {
+        if (!value || hasValueChange.current) {
+          handleEvent(actions, 'blur', propName, event.target.value);
+          if (hasSuggestions) {
+            pConn.ignoreSuggestion();
+          }
+          hasValueChange.current = false;
+        }
+      }}
+      onFocus={actions.onFocus}
+      onResolveSuggestion={onResolveSuggestionHandler}
+    />
+    </StyledPegaDxilMyUrlWrapper>
+  );
+}
+
+PegaDxilMyUrl.defaultProps = {
+  value: '',
+  placeholder: '',
+  validatemessage: '',
+  helperText: '',
+  hideLabel: false,
+  disabled: false,
+  readOnly: false,
+  required: false,
+  testId: null,
+  displayMode: null,
+  additionalProps: {},
+  variant: 'inline',
+  formatter: '',
+  isTableFormatter: false,
+  displayAs: 'defaultURL',
+  widthSel: 'defaultWidth',
+  customWidth: null,
+  altText: 'constant',
+  altTextOfImage: '',
+  propaltTextOfImage: '',
+  urlLabel: '',
+  propUrlLabel: '',
+  urlLabelSelection: 'constant',
+  tableDisplayAs: 'link',
+  hasSuggestions: false
+};
+
+PegaDxilMyUrl.propTypes = {
+  value: PropTypes.string,
+  placeholder: PropTypes.string,
+  label: PropTypes.string.isRequired,
+  hideLabel: PropTypes.bool,
+  getPConnect: PropTypes.func.isRequired,
+  validatemessage: PropTypes.string,
+  helperText: PropTypes.string,
+  disabled: PropTypes.oneOfType([PropTypes.bool, PropTypes.string]),
+  readOnly: PropTypes.oneOfType([PropTypes.bool, PropTypes.string]),
+  required: PropTypes.oneOfType([PropTypes.bool, PropTypes.string]),
+  testId: PropTypes.string,
+  displayMode: PropTypes.string,
+  additionalProps: PropTypes.objectOf(PropTypes.any),
+  variant: PropTypes.string,
+  formatter: PropTypes.string,
+  isTableFormatter: PropTypes.bool,
+  displayAs: PropTypes.string,
+  widthSel: PropTypes.string,
+  customWidth: PropTypes.number,
+  altText: PropTypes.string,
+  altTextOfImage: PropTypes.string,
+  propaltTextOfImage: PropTypes.string,
+  urlLabel: PropTypes.string,
+  propUrlLabel: PropTypes.string,
+  urlLabelSelection: PropTypes.string,
+  tableDisplayAs: PropTypes.string,
+  hasSuggestions: PropTypes.bool
+};
+
+export default PegaDxilMyUrl;

package/src/tasks/init/template/test/assets/components/createAll/Pega_DXIL_MyURL/mock.stories.js

@@ -0,0 +1,22 @@
+export const configProps = {
+  value: '',
+  label: 'URL Sample',
+  placeholder: 'URL Placeholder',
+  helperText: 'URL Helper Text',
+  testId: 'url-12345678',
+  hasSuggestions: false
+};
+
+export const fieldMetadata = {
+  classID: 'DIXL-MediaCo-Work-NewService',
+  type: 'Text',
+  maxLength: 256,
+  displayAs: 'pxURL',
+  label: 'URL sample',
+  validateAs: 'pxIsValidURL'
+};
+
+export const stateProps = {
+  value: '.URLSample',
+  hasSuggestions: false
+};

package/src/tasks/init/template/test/assets/components/createAll/Pega_DXIL_MyURL/styles.js

@@ -0,0 +1,14 @@
+// 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;
+//  `;
+// });

package/src/tasks/init/template/test/assets/components/createAll/Pega_DXIL_MyURL/suggestions-handler.js

@@ -0,0 +1,10 @@
+/* eslint-disable import/prefer-default-export */
+export const suggestionsHandler = (accepted, pConn, setStatus) => {
+  if (accepted) {
+    pConn.acceptSuggestion();
+    setStatus('success');
+  } else {
+    pConn.ignoreSuggestion();
+    setStatus(undefined);
+  }
+};

package/src/tasks/init/template/test/assets/components/createAll/Pega_DXIL_MyURL/text-url.jsx

@@ -0,0 +1,173 @@
+import { useState, useRef, React} from "react";
+import { EmailDisplay, PhoneDisplay, URLDisplay, Image, Button, Lightbox } from '@pega/cosmos-react-core';
+
+export const formatExists = (formatterVal) => {
+    const formatterValues = [
+      "TextInput",
+      "WorkStatus",
+      "RichText",
+      "Email",
+      "Phone",
+      "URL",
+      "Operator"
+    ];
+    let isformatter = false;
+    if (formatterValues.includes(formatterVal)) {
+      isformatter = true;
+    }
+    return isformatter;
+  };
+
+const urlLabelVal = (urlLabelSelection, btnVal, urlLabel, propUrlLabel) => {
+  if ((urlLabel !== '' || propUrlLabel !== '') && btnVal !== null) {
+    switch (urlLabelSelection) {
+      case 'constant': {
+        btnVal = urlLabel;
+        break;
+      }
+      case 'propertyRef': {
+        btnVal = propUrlLabel;
+        break;
+      }
+      // no default
+    }
+  }
+  return btnVal;
+};
+
+const isImage = (url) => /\.(jpg|jpeg|png|webp|avif|gif|svg)$/.test(url);
+
+const TableImage = (imageProps) => {
+  const { value, altText, altTextOfImage, propaltTextOfImage, urlLabelSelection, urlLabel, propUrlLabel } = imageProps;
+  const demoButtonRef = useRef(null);
+  let imageDisplayComp = null;
+  const [images, setImages] = useState(null);
+  const imgDescription = {
+    id: 'url',
+    name: urlLabelSelection === 'constant' ? urlLabel : propUrlLabel,
+    description: altText === 'constant' ? altTextOfImage : propaltTextOfImage,
+    src: value
+  };
+  const onClick = () => {
+    setImages([imgDescription]);
+  };
+  const onItemDownload = async (id) => {
+    const a = document.createElement('a');
+    a.href = await fetch(images[0].src)
+      .then((response) => {
+        return response.blob();
+      })
+      .then((blob) => {
+        return URL.createObjectURL(blob);
+      });
+    a.download = images?.find((image) => image.id === id)?.name ?? id;
+    document.body.appendChild(a);
+    a.click();
+    document.body.removeChild(a);
+  };
+  let btnVal = value;
+  btnVal = urlLabelVal(urlLabelSelection, btnVal, urlLabel, propUrlLabel);
+  imageDisplayComp = (
+    <React.Fragment>
+      {btnVal !== null && (
+        <Button ref={demoButtonRef} variant='link' compact={false} onClick={onClick} autoFocus>
+          {btnVal}
+        </Button>
+      )}
+      {images && (
+        <Lightbox
+          items={images}
+          cycle={false}
+          onAfterClose={() => {
+            setImages(null);
+            demoButtonRef.current?.focus();
+          }}
+          onItemDownload={isImage(images[0].src) ? onItemDownload : undefined}
+        />
+      )}
+    </React.Fragment>
+  );
+  return imageDisplayComp;
+};
+
+export const textFormatter = (formatter,value) => {
+  let displayComponent = 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;
+};
+
+/**
+ * Returns a URL display component based on the options
+ * @function urlFormatter
+ * @param {string} value value
+ * @param {object} options options for formatting
+ * { displayAs,tableDisplayAs,isTableFormatter,altText,altTextOfImage,propaltTextOfImage,urlLabelSelection, urlLabel,propUrlLabel, widthSel, customWidth}
+ */
+export const urlFormatter = (value, options) => {
+  const {
+    displayAs,
+    tableDisplayAs,
+    isTableFormatter,
+    altText,
+    altTextOfImage,
+    propaltTextOfImage,
+    urlLabelSelection,
+    urlLabel,
+    propUrlLabel,
+    widthSel,
+    customWidth
+  } = options;
+
+  let urlFormatComp = null;
+  if (
+    (displayAs === 'labelText' || (isTableFormatter && tableDisplayAs === 'link')) &&
+    (urlLabel !== '' || propUrlLabel !== '')
+  ) {
+    urlFormatComp = (
+      <URLDisplay
+        target='_blank'
+        value={value}
+        displayText={urlLabelSelection === 'constant' ? urlLabel : propUrlLabel}
+        variant='link'
+      />
+    );
+  } else if ((displayAs === 'Image' || tableDisplayAs === 'Image') && !!value) {
+    if (isTableFormatter) {
+      urlFormatComp = TableImage({
+        value,
+        altText,
+        altTextOfImage,
+        propaltTextOfImage,
+        urlLabelSelection,
+        urlLabel,
+        propUrlLabel
+      });
+    } else {
+      const width = widthSel === 'widthpx' ? customWidth : null;
+      urlFormatComp = (
+        <Image src={value} width={width} alt={altText === 'constant' ? altTextOfImage : propaltTextOfImage} />
+      );
+    }
+  } else {
+    urlFormatComp = <URLDisplay target='_blank' value={value} displayText={value} variant='link' />;
+  }
+  return urlFormatComp;
+};

package/src/tasks/init/template/test/functionTest/localCreateAllListDeleteAll.test.js

@@ -0,0 +1,157 @@
+// import { exec } from 'child_process';
+const path = require('path');
+const fs = require('fs');
+const util = require('node:util');
+const exec = util.promisify(require('node:child_process').exec);
+
+describe('createAll list and deleteAll local', () => {
+  it('initial delete/cleanup', async () => {
+    const script = `npm run deleteAll Local Y`;
+
+    const { stdout, stderr } = await exec(script);
+    // console.log(stdout);
+    expect(stdout).not.toBeNull();
+    expect(stderr).not.toBeNull();
+  });
+
+  it('npm run createAll Local', async () => {
+    const script = `npm run createAll "My" 0.0.1 DXIL "" Pega`;
+
+    const { stdout, stderr } = await exec(script);
+    // console.log(stdout);
+    expect(stdout).not.toBeNull();
+    expect(stderr).not.toBeNull();
+
+    // want message to contain component name
+    expect(stdout).toContain('created Pega_DXIL_My');
+
+    // don't want message with already exists
+    expect(stdout).not.toContain('already exists');
+
+    // check to see file exists
+
+    // pick one
+    const newFileName = 'Pega_DXIL_MyBoolean';
+
+    // const fileDir = path.resolve(`src/components/${newFileName}`);
+    const createFile = path.resolve(path.join(`src/components/${newFileName}`, 'index.jsx'));
+    const doesExist = fs.existsSync(createFile);
+    expect(doesExist).toBeTruthy();
+
+    // if (doesExist) {
+    //   // remove it
+    //   fs.rmdirSync(fileDir, { recursive: true });
+    // }
+  }, 10000);
+
+  it('npm run list Local', async () => {
+    const script = 'npm run list Local';
+    const { stdout, stderr } = await exec(script);
+
+    expect(stderr).not.toBeNull();
+
+    // console.log(stdout);
+    expect(stdout).not.toBeNull();
+    expect(stdout).toContain('Pega_DXIL_MyText');
+    expect(stdout).toContain('Pega_DXIL_MyTextInput');
+    expect(stdout).toContain('Pega_DXIL_MyParagraph');
+    expect(stdout).toContain('Pega_DXIL_MyEmail');
+    expect(stdout).toContain('Pega_DXIL_MyPhone');
+    expect(stdout).toContain('Pega_DXIL_MyURL');
+    expect(stdout).toContain('Pega_DXIL_MyInteger');
+    expect(stdout).toContain('Pega_DXIL_MyDecimal');
+    expect(stdout).toContain('Pega_DXIL_MyCurrency');
+    expect(stdout).toContain('Pega_DXIL_MyPercentage');
+    expect(stdout).toContain('Pega_DXIL_MyBoolean');
+    expect(stdout).toContain('Pega_DXIL_MyDate');
+    expect(stdout).toContain('Pega_DXIL_MyDateTime');
+    expect(stdout).toContain('Pega_DXIL_MyTimeOfDay');
+    expect(stdout).toContain('Pega_DXIL_MyPicklist');
+    expect(stdout).toContain('Pega_DXIL_MyDetails');
+    expect(stdout).toContain('Pega_DXIL_MyTwoColumnDetails');
+    expect(stdout).toContain('Pega_DXIL_MyForm');
+    expect(stdout).toContain('Pega_DXIL_MyTwoColumnForm');
+    expect(stdout).toContain('Pega_DXIL_MyPage');
+    expect(stdout).toContain('Pega_DXIL_MyCaseWidget');
+    expect(stdout).toContain('Pega_DXIL_MyPageWidget');
+    expect(stdout).toContain('Pega_DXIL_MyPageCaseWidget');
+    // done();
+  }, 10000);
+
+  it('compare created to default', async () => {
+    const compList = [
+      'Pega_DXIL_MyText',
+      'Pega_DXIL_MyTextInput',
+      'Pega_DXIL_MyParagraph',
+      'Pega_DXIL_MyEmail',
+      'Pega_DXIL_MyPhone',
+      'Pega_DXIL_MyURL',
+      'Pega_DXIL_MyInteger',
+      'Pega_DXIL_MyDecimal',
+      'Pega_DXIL_MyCurrency',
+      'Pega_DXIL_MyPercentage',
+      'Pega_DXIL_MyBoolean',
+      'Pega_DXIL_MyDate',
+      'Pega_DXIL_MyDateTime',
+      'Pega_DXIL_MyTimeOfDay',
+      'Pega_DXIL_MyPicklist',
+      'Pega_DXIL_MyDetails',
+      'Pega_DXIL_MyTwoColumnDetails',
+      'Pega_DXIL_MyForm',
+      'Pega_DXIL_MyTwoColumnForm',
+      'Pega_DXIL_MyPage',
+      'Pega_DXIL_MyCaseWidget',
+      'Pega_DXIL_MyPageWidget',
+      'Pega_DXIL_MyPageCaseWidget'
+    ];
+
+    compList.forEach(component => {
+      const componentDir = path.resolve(`src/components/${component}`);
+      const assetDir = path.resolve(`test/assets/components/createAll/${component}`);
+
+      // get files of directory
+      const componentFiles = fs.readdirSync(componentDir);
+
+      // get files of assets
+      // const assetFiles = fs.readdirSync(assetDir);
+
+      // compare
+      componentFiles.forEach(file => {
+        const componentFilePath = path.join(componentDir, file);
+        const assetFilePath = path.join(assetDir, file);
+
+        const componentFileData = fs.readFileSync(componentFilePath, { encoding: 'utf8' });
+        const assetFileData = fs.readFileSync(assetFilePath, { encoding: 'utf8' });
+
+        expect(componentFileData).toEqual(assetFileData);
+      });
+    });
+  }, 10000);
+
+  it('npm run deleteAll Local', async () => {
+    const script = `npm run deleteAll Local Y`;
+
+    const { stdout, stderr } = await exec(script);
+    // console.log(stdout);
+    expect(stdout).not.toBeNull();
+    expect(stderr).not.toBeNull();
+
+    // pick one
+    const newFileName = 'Pega_DXIL_MyBoolean';
+
+    // want message to contain component name
+    expect(stdout).toContain(newFileName);
+
+    // message deleted
+    expect(stdout).toContain('is deleted');
+
+    // check to see file exists
+
+    // I think run through a map of them here
+
+    // const fileDir = path.resolve(`src/components/${newFileName}`);
+    // const createFile = path.resolve(path.join(`src/components/${newFileName}`, 'index.jsx'));
+    // const doesExist = fs.existsSync(createFile);
+    // expect(doesExist).not.toBeTruthy();
+  }, 10000);
+});