@pega/custom-dx-components 2.0.11 → 2.0.13

package/README.md

@@ -22,12 +22,12 @@ Initialize the project by performing the following procedure in a terminal:
 
 1. Enter the following command to initialize the project.
 
-    Pega 8.7 - `npx @pega/custom-dx-components@1 init`
+   Pega 8.7 - `npx @pega/custom-dx-components@1 init`
 
-    Pega 8.8 - `npx @pega/custom-dx-components@2 init`
+   Pega 8.8 - `npx @pega/custom-dx-components@2 init`
 
 2. If prompted, enter `y` to install the Custom UI Components package.
-You will then be asked to set up the project by entering the required details.
+   You will then be asked to set up the project by entering the required details.
 
 3. Enter the following details:
     - Name of the project (required)
@@ -41,7 +41,7 @@ Example - `This project is intended to create and publish a custom component.`
     - Git repository URL (optional)
 Example - `https://git.custom-components.io/custom-cc.git`
     - Author (optional)
-Example - `Michelle`
+   Example - `Michelle`
 
 The workspace is now set up to create custom components and publish them to the server.
 
@@ -50,7 +50,7 @@ The workspace is now set up to create custom components and publish them to the
 Create custom components using the following procedure:
 
 1. Enter the following command to create a component:
-`npm run create`
+    `npm run create`
 You will then be asked to enter or review the following details of the component:
     - Name of the component (required)
 Example - `customcomp0`
@@ -65,21 +65,22 @@ Example - `Field`
     - Sub-type of component (required)
 Example - `Text`
     - Description of the component (optional)
-Example - `This is a customized searchbox that filters data.`
+    Example - `This is a customized searchbox that filters data.`
 The component is created in the following path:  _/Users/your_user_name/project_name/src/components/component_name_
-You can also pre-configure the values for the above options in a tasks.config.json file as shown below.
-
-    ```json
-    {
-        "component": {
-            "library": "basic",
-            "type": "field",
-            "subtype": "text",
-            "description": "basic field for capturing textual data",
-            "icon": "basic-field-text.svg"
+    You can also pre-configure the values for the above options in a tasks.config.json file as shown below.
+
+        ```json
+        {
+            "component": {
+                "library": "basic",
+                "version": "0.0.1",
+                "type": "field",
+                "subtype": "text",
+                "description": "basic field for capturing textual data",
+                "icon": "basic-field-text.svg"
+            }
         }
-    }
-    ```
+        ```
 >**Note**:
 Alternatively, you can enter the following command to skip entering the details of the component now and can manually enter the details in the config.json file after the component is created:
 `npm run create <enter_component_name>`
@@ -102,13 +103,19 @@ The *config.json* file contains the mapping of properties for configuring the au
 
 
 2. Enter the following command to start the storybook to view the demo.
-`npm start`
+   `npm start`
 
 3. Modify the source files to build your own component. You can also install and import third-party libraries if required for your component.
 
 The custom component is now created. We use the information provided to create uniquely namespaced components in this convention - `<organization>_<library>_<component name>`.
 
+4. local build, you can build the component locally to check for config validation and component validation. Enter
+   `npm buildComponent`
+
+   buildComponent will do the same first 2 steps as publish, but will not publish to the server. This allows you to compile your component locally and fix errors before publish.
+
 ## Authenticate the user
+
 Before we publish the custom component to the Pega Infinity Server, authenticate the user to access the resources in the Pega Infinity Server.
 
 >**Note**:
@@ -116,53 +123,57 @@ It is required that you configure a value for clientId, clientSecret, and access
 1. Login to Pega Infinity Server, navigate to Records / Security / OAuth 2.0 Client Registration landing page and open the *DX-CustomComponents* record.
 2. Click **Regenerate Client Secret**, download the Client Credentials (as the Client ID, Client Secret, and Access token endpoint will be needed), and save the record.
 3. Update the the task.config.json file with these downloaded values:
-    ```json
-    "server-config": {
-        "server": "https://127.0.0.1:8080/prweb",
-        "user": "customcomponentoperator",
-        "password": "pwd",
-        "clientId": "<mention client ID here>",
-        "clientSecret": "<mention client secret here>",
-        "accessTokenUri": "https://127.0.0.1:8080/prweb/PRRestService/oauth2/v1/token"
-    },
-    ```
+   ```json
+   "server-config": {
+       "server": "https://127.0.0.1:8080/prweb",
+       "user": "customcomponentoperator",
+       "password": "pwd",
+       "clientId": "<mention client ID here>",
+       "clientSecret": "<mention client secret here>",
+       "accessTokenUri": "https://127.0.0.1:8080/prweb/PRRestService/oauth2/v1/token"
+   },
+   ```
 4. Enter the following command to initiate authentication.
-`npm run authenticate`
+   `npm run authenticate`
 
 The user is now authenticated and can proceed to either publish or list the components.
 
 ## Publish custom components
 Enter the following command to publish custom components to Pega Infinity Server:
 `npm run publish`
+`npm run publishAll`
 Publish the finalized custom components changes to Pega Infinity Server so that it can be discoverable in authoring (design palette).
 You will then be asked to enter the following details:
 
 - The component to be published to Pega Infinity Server. It will be updated if the component exists.
+  - If publishAll, then you won't get a list
 - The name of the ruleset where the component must be published.
 - The version of the ruleset where the component must be published.
 - Specify if the development build should be generated for debugging.
-You can also pre-configure the values for the above options in a tasks.config.json file as shown below. The server, user name, and password must be pre-configured.
-
-    ```json
-    {
-        "components-server-config": {
-            "server": "http://127.0.0.1:8080/prweb",
-            "user": "customcomponentoperator",
-            "password": "pwd"
-            "rulesetName": "TestPega-C11nGall",
-            "rulesetVersion": "01-01-03",
-            "sourceOfComponents": "Server",
-            "devBuild": false,
-        }
-    }
-    ```
-    When the component is successfully published, you can use the newly published component in App Studio's view authoring.
 
+  - If publishAll, will sequentiall go through the list of local components and publish them
+    You can also pre-configure the values for the above options in a tasks.config.json file as shown below. The server, user name, and password must be pre-configured.
+
+        ```json
+        {
+            "components-server-config": {
+                "server": "http://127.0.0.1:8080/prweb",
+                "user": "customcomponentoperator",
+                "password": "pwd"
+                "rulesetName": "TestPega-C11nGall",
+                "rulesetVersion": "01-01-03",
+                "sourceOfComponents": "Server",
+                "devBuild": false,
+            }
+        }
+        ```
+        When the component is successfully published, you can use the newly published component in App Studio's view authoring.
 
->**Note**:
-The Rule-UI-Component instance (with component name) is created on the Pega Infinity Server after publishing the component.
+> **Note**:
+> The Rule-UI-Component instance (with component name) is created on the Pega Infinity Server after publishing the component.
 
 ## List custom components
+
 View the available components in the local machine or the server.
 
 Enter the following command to list custom components:
@@ -171,37 +182,42 @@ Enter the following command to list custom components:
 You will then be asked to enter the following details:
 
 - List components from Server or Local?
-Example - `Server`
+  Example - `Server`
 
 The custom components will now be listed in the terminal.
 
 ## Delete custom components
+
 Delete the available or published components in the local machine or the server.
 
 Enter the following command to delete custom components:
 `npm run delete`
+`npm run deleteAll`
 
 You will then be asked to enter the following details:
 
 - Delete components from Server or Local?
-Example - `Local`
+  Example - `Local`
 
 - Select component to delete
-The list of available components in the following path will be displayed:  _/Users/your_user_name/project_name/src/components
-Select the component to be deleted from this list.
+  The list of available components in the following path will be displayed: \_/Users/your_user_name/project_name/src/components
+  Select the component to be deleted from this list.
+- For deleteAll you will see the full list and asked if you want to delete them all.
 
 - Are you sure?
-Example - `yes`
+  Example - `yes`
 
->**Note**:
-If you choose to delete components from the server, the successfully published components along with their ruleset name and ruleset version from the Pega Infinity Server will be displayed. Select the component to be deleted from this list.
+> **Note**:
+> If you choose to delete components from the server, the successfully published components along with their ruleset name and ruleset version from the Pega Infinity Server will be displayed. Select the component to be deleted from this list.
 
 ## View existing custom components in storybook
+
 View custom components in a storybook by performing the following procedure:
+
 1. Enter the following command to open the project.
-`cd <enter your project's name>`
+   `cd <enter your project's name>`
 
 2. Enter the following command to start the storybook in development mode.
-`npm start`
+   `npm start`
 
 The storybook is launched in a browser where you can view the components working in isolation.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pega/custom-dx-components",
-  "version": "2.0.11",
+  "version": "2.0.13",
   "description": "Utility for building custom UI components",
   "bin": "./bin/index.js",
   "scripts": {
@@ -61,7 +61,15 @@
   "devDependencies": {
     "@pega/configs": "^0.3.3",
     "cspell": "^6.9.0",
-    "eslint": "^8.23.1",
+    "eslint": "^8.4.1",
+    "eslint-plugin-import": "^2.25.3",
+    "eslint-plugin-jest": "^25.3.0",
+    "eslint-plugin-jsx-a11y": "^6.5.1",
+    "eslint-plugin-mdx": "^2.0.5",
+    "eslint-plugin-prettier": "^4.0.0",
+    "eslint-plugin-react": "^7.27.1",
+    "eslint-plugin-react-hooks": "^4.3.0",
+    "eslint-plugin-sonarjs": "^0.11.0",
     "prettier": "2.7.1"
   }
 }

package/src/cli.js

@@ -3,11 +3,14 @@ import chalk from 'chalk';
 
 import {
   authenticate,
+  buildComponent,
   createComponent,
   deleteComponent,
+  deleteAllComponents,
   initProject,
   listComponents,
   publishComponent,
+  publishAllComponents,
   updateComponent,
   validate,
   upgrade
@@ -16,11 +19,14 @@ import {
 const TASKS = {
   INIT: 'init',
   CREATE: 'create',
+  BUILD: 'buildComponent',
   PUBLISH: 'publish',
+  PUBLISH_All: 'publishAll',
   LIST: 'list',
   VALIDATE_SCHEMA: 'validateSchema',
   UPDATE: 'update',
   DELETE: 'delete',
+  DELETE_ALL: "deleteAll",
   AUTHENTICATE: 'authenticate',
   UPGRADE: 'upgrade'
 };
@@ -60,6 +66,14 @@ export default async (args = []) => {
       publishComponent(options);
       break;
     }
+    case TASKS.PUBLISH_All: {
+      publishAllComponents(options);
+      break;
+    }
+    case TASKS.BUILD: {
+      buildComponent(options);
+      break;
+    }
     case TASKS.LIST: {
       listComponents(options);
       break;
@@ -76,6 +90,10 @@ export default async (args = []) => {
       deleteComponent(options);
       break;
     }
+    case TASKS.DELETE_ALL: {
+      deleteAllComponents(options);
+      break;
+    }
     case TASKS.AUTHENTICATE: {
       authenticate(options);
       break;

package/src/tasks/authenticate/index.js

@@ -6,7 +6,7 @@ import chalk from 'chalk';
 import inquirer from 'inquirer';
 import fetch from 'node-fetch';
 
-import { checkPathAccess, getTokenUrl } from '../../util.js';
+import { checkPathAccess, getTokenUrl, showVersion } from '../../util.js';
 import { TOKEN_PATH } from '../../constants.js';
 
 import { getAuthQuestions } from './helper.js';
@@ -57,6 +57,8 @@ const generateAccessToken = async config => {
 };
 
 export default async options => {
+  showVersion();
+
   await checkPathAccess(pegaConfigJsonPath);
 
   let data = fs.readFileSync(pegaConfigJsonPath, { encoding: 'utf8' });

package/src/tasks/build/helper.js

@@ -0,0 +1,123 @@
+import fs from 'fs';
+import path from 'path';
+import https from 'https';
+
+import fetch from 'node-fetch';
+import AdmZip from 'adm-zip';
+import chalk from 'chalk';
+
+import {
+  constructCompleteUrl,
+  getComponentDirectoryPath,
+  getComponents,
+  getPegaServerConfig,
+  validateRulesetVersion
+} from '../../util.js';
+import { PUBLISH_COMPONENT_SERVICE_REST_ENDPOINT, TOKEN_PATH } from '../../constants.js';
+
+export const getPublishComponentQuestions = async () => {
+  const components = await getComponents();
+  const defaultPegaConfig = await getPegaServerConfig();
+
+  return [
+    {
+      name: 'componentKey',
+      type: 'rawlist',
+      message: 'Select component to build',
+      choices: components
+    },
+    {
+      name: 'sourceMap',
+      message: 'Generate source map ?',
+      default: defaultPegaConfig.sourceMap,
+      when: () => false && !process.env.SOURCE_MAP
+    },
+    {
+      name: 'devBuild',
+      message: 'Generate development build ?',
+      default: defaultPegaConfig.devBuild
+    }
+  ];
+};
+
+export const zipComponent = async componentKey => {
+  const srcDirectory = await getComponentDirectoryPath(componentKey);
+  const buildDirectory = await path.join(path.resolve(), 'dist/components', componentKey);
+  const configJson = `${srcDirectory}/config.json`;
+
+  const zip = new AdmZip();
+
+  zip.addLocalFolder(srcDirectory, 'src/');
+  zip.addLocalFile(configJson);
+  zip.addLocalFolder(buildDirectory);
+  const zipContent = zip.toBuffer().toString('base64');
+
+  const configContent = Buffer.from(fs.readFileSync(`${srcDirectory}/config.json`)).toString();
+  fs.rmdir('dist', { recursive: true }, err => {
+    if (err) {
+      throw err;
+    }
+  });
+  return { zipContent, configContent };
+};
+
+export const publishComponentToServer = async data => {
+  const { configContent, zipContent, componentKey, rulesetName, rulesetVersion } = data;
+
+  const apiBody = {
+    configContent,
+    zipContent,
+    componentKey: JSON.parse(configContent).componentKey,
+    publishFor: 'constellation',
+    rulesetName,
+    rulesetVersion,
+    category: ''
+  };
+  const defaultPegaConfig = await getPegaServerConfig();
+  const url = constructCompleteUrl(
+    defaultPegaConfig.server,
+    PUBLISH_COMPONENT_SERVICE_REST_ENDPOINT
+  );
+  try {
+    const OauthData = fs.readFileSync(TOKEN_PATH, 'utf8');
+    if (OauthData) {
+      const {
+        access_token: accessToken,
+        token_type: tokenType,
+        refresh_token: refreshToken
+      } = JSON.parse(OauthData);
+      let status = 500;
+      fetch(url, {
+        method: 'POST',
+        agent: new https.Agent({ rejectUnauthorized: false }),
+        headers: {
+          Authorization: `${tokenType} ${accessToken}`
+        },
+        body: JSON.stringify(apiBody)
+      })
+        .then(response => {
+          status = response.status;
+          return response.text();
+        })
+        .then(resp => {
+          const respData = JSON.parse(resp);
+          if (status === 401) {
+            throw new Error(
+              'Error occured in authentication. Please regenerate using authenticate'
+            );
+            // console.log(accessTokenUri, refreshToken);
+            /* TODO - Handle refresh_token */
+          } else if (status == 200) {
+            console.log(chalk.bold.green(`Success : ${respData.message}`));
+          } else {
+            throw new Error(`${respData.message}`);
+          }
+        })
+        .catch(e => Promise.reject(`${chalk.bold.red(e)}`));
+    } else {
+      throw new Error(`Error occured in authentication. Please regenerate using authenticate`);
+    }
+  } catch (err) {
+    throw new Error(`Error occured in authentication. Please regenerate using authenticate`);
+  }
+};

package/src/tasks/build/index.js

@@ -0,0 +1,54 @@
+import inquirer from 'inquirer';
+import Listr from 'listr';
+import chalk from 'chalk';
+
+import validate from '../validator/index.js';
+
+import bundleComponent from '../bundle/index.js';
+import lintComponent from '../linter/index.js';
+import { getPublishComponentQuestions, publishComponentToServer, zipComponent } from './helper.js';
+import { getComponentDirectoryPath, showVersion } from '../../util.js';
+
+export default async options => {
+  showVersion();
+
+  const questions = await getPublishComponentQuestions();
+  const answers = await inquirer.prompt(questions);
+  const { componentKey, sourceMap, devBuild } = answers;
+
+  let content = {
+    ...answers
+  };
+
+  const tasks = new Listr(
+    [
+      {
+        title: 'Validate config schema',
+        task: async () => {
+          await validate(componentKey);
+        }
+      },
+      {
+        title: 'Lint component',
+        task: async () => {
+          const targetDirectory = await getComponentDirectoryPath(componentKey);
+          // console.log(`in buildComponent Lint component task: componentKey: ${componentKey} targetDirectory: ${targetDirectory}`);
+          await lintComponent(targetDirectory);
+        }
+      },
+      {
+        title: 'Bundle Component',
+        task: async () => await bundleComponent(componentKey, sourceMap, devBuild),
+        skip: () => (options.skipBundle ? 'Skipped bundling component' : undefined)
+      }
+    ],
+    {
+      exitOnError: true
+    }
+  );
+
+  await tasks.run().catch(err => {
+    console.log(chalk.bold.red(err.toString()));
+  });
+  return true;
+};

package/src/tasks/{publish/bundle → bundle}/builder/webpack.config.js

@@ -306,14 +306,12 @@ export default (
         contextRegExp: /moment$/
       }),
       /* Ignore cosmos icons */
-
       new webpack.IgnorePlugin({
         resourceRegExp: /^\.\/icons$/,
         contextRegExp: /@pega\/cosmos-react-core\/lib\/components\/Icon$/
       }),
 
       /* Ignore cosmos icons - windows */
-
       new webpack.IgnorePlugin({
         resourceRegExp: /^\.\/icons$/,
         contextRegExp: /@pega\\cosmos-react-core\\lib\\components\\Icon$/

package/src/tasks/{publish/bundle → bundle}/index.js

@@ -2,8 +2,8 @@ import path from 'path';
 import fs from 'fs';
 import { stat } from 'fs/promises';
 
-import { BUILD_CONFIG_JSON_FILENAME } from '../../../constants.js';
-import { getComponentDirectoryPath } from '../../../util.js';
+import { BUILD_CONFIG_JSON_FILENAME } from '../../constants.js';
+import { getComponentDirectoryPath } from '../../util.js';
 
 import buildComponent from './builder/index.js';
 

package/src/tasks/create/index.js

@@ -14,7 +14,8 @@ import {
   getComponents,
   getComponentDefaults,
   sanitize,
-  validateSemver
+  validateSemver,
+  showVersion
 } from '../../util.js';
 import { COMPONENT_SCHEMA } from '../../constants.js';
 
@@ -87,7 +88,7 @@ const compileMustacheTemplates = async (
       ALLOWEDAPPS: JSON.stringify(allowedApplications),
       TYPE: type,
       SUB_TYPE: JSON.stringify(mustacheSubType),
-      DESCRIPTION: description,
+      DESCRIPTION: description || componentLabel,
       IS_TEMPLATE: isTemplate,
       IS_PICKLIST: isPicklist,
       IS_BOOLEAN: isBool,
@@ -172,6 +173,8 @@ const validateCompile = async (
 };
 
 export default async options => {
+  showVersion();
+
   if (options.params[10]) {
     const componentName = options.params[3];
     const componentLabel = options.params[4];
@@ -226,6 +229,7 @@ export default async options => {
       {
         name: 'version',
         message: 'Enter component version',
+        default: componentDefaults.version,
         validate: value => {
           if (validateSemver(value)) {
             return true;
@@ -312,7 +316,6 @@ export default async options => {
       }
     ];
 
-    console.log(chalk.green("DX Component Builder v2.0.11"));
     await inquirer.prompt(questions).then(async answers => {
       const {
         componentName,

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

@@ -7,7 +7,7 @@ export default {
 
 
 
-export function format(value, type, options) {
+export function format(value, type) {
   let formattedValue;
 
   switch (type?.toLowerCase()) {

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

@@ -1,7 +1,8 @@
-import { useState } from 'react';
-import { withKnobs, text, boolean } from '@storybook/addon-knobs';
+import { withKnobs } from '@storybook/addon-knobs';
 
-import {{COMPONENT_CLASS_NAME}} from './index.jsx';
+import { configProps, stateProps } from './mock.stories';
+
+import {{COMPONENT_CLASS_NAME}} from './index';
 
 export default {
   title: '{{COMPONENT_CLASS_NAME}}',
@@ -10,30 +11,40 @@ export default {
 };
 
 export const base{{COMPONENT_CLASS_NAME}} = () => {
-  const [value, setValue] = useState('test value');
-
   const props = {
+    value: configProps.value,
+    label: configProps.label,
+    helperText: configProps.helperText,
+    caption: configProps.caption,
+    validatemessage: configProps.validatemessage,
+    hideLabel: configProps.hideLabel,
+    testId: configProps.testId,
+    additionalProps: configProps.additionalProps,
+    displayMode: configProps.displayMode,
+    variant: configProps.variant,
+    trueLabel: configProps.trueLabel,
+    falseLabel: configProps.falseLabel,
+    disabled: configProps.disabled,
+    readOnly: configProps.readOnly,
+    required: configProps.required,
     getPConnect: () => {
       return {
+        getStateProps: () => {
+          return stateProps;
+        },
         getActionsApi: () => {
           return {
-            updateFieldValue: (propName, value) => {
-              setValue(value);
-            }
+            updateFieldValue: () => { /* nothing */},
+            triggerFieldChange: () => { /* nothing */}
           };
         },
-        getStateProps: () => {
-          return { value: '.name' };
+        getValidationApi: () => {
+          return {
+            validate: () => { /* nothing */}
+          };
         }
       };
-    },
-    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 (

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

@@ -7,7 +7,6 @@ import {
 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';
@@ -70,7 +69,7 @@ const {{COMPONENT_CLASS_NAME}} = props => {
 
   let displayComponent;
   if (displayMode) {
-    displayComponent = <BooleanDisplay value={value} trueLabel={trueLabel} falseLabel={falseLabel}></BooleanDisplay>;
+    displayComponent = <{{COMPONENT_CLASS_NAME}}  value={value} trueLabel={trueLabel} falseLabel={falseLabel} />;
   }
 
   if (displayMode === 'DISPLAY_ONLY') {