@pega/custom-dx-components 2.0.16 → 2.0.17

package/src/tasks/init/template/package.json.mustache

@@ -10,12 +10,15 @@
     "lint": "run-p -cl lint:*",
     "fix": "run-p -cl fix:*",
     "authenticate": "custom-dx-components authenticate",
+    "buildComponent": "custom-dx-components buildComponent",
     "create": "custom-dx-components create",
     "publish": "custom-dx-components publish",
+    "publishAll": "custom-dx-components publishAll",
     "list": "custom-dx-components list",
     "validate-schema": "custom-dx-components validateSchema",
     "update": "custom-dx-components update",
     "delete": "custom-dx-components delete",
+    "deleteAll": "custom-dx-components deleteAll",
     "lint:types": "tsc --noEmit",
     "lint:es": "eslint .",
     "lint:styles": "stylelint \"./**/*.@(js|jsx|ts|tsx)\"",
@@ -35,8 +38,8 @@
   "license": "Enter License",
   "sideEffects": false,
   "dependencies": {
-    "@pega/cosmos-react-core": "^3.0.0-rc.4",
-    "@pega/cosmos-react-work": "3.0.0-rc.4",
+    "@pega/cosmos-react-core": "^3.0.1",
+    "@pega/cosmos-react-work": "3.0.1",
     "@storybook/addon-knobs": "^6.3.1",
     "dayjs": "^1.11.5",
     "jest": "^29.3.1",
@@ -52,7 +55,8 @@
   },
   "devDependencies": {
     "@pega/configs": "^0.3.4",
-    "@pega/custom-dx-components": "^2.0.16",
+    "@pega/custom-dx-components": "^2.0.17",
+    "@pega/eslint-config": "^0.3.2",
     "@storybook/addon-actions": "^6.5.12",
     "@storybook/addon-essentials": "^6.5.12",
     "@storybook/addon-links": "^6.5.12",
@@ -65,7 +69,18 @@
     "@types/react-color": "^3.0.6",
     "@types/react-dom": "^17.0.11",
     "@types/styled-components": "^5.1.26",
-    "eslint": "^8.23.1",
+    "@typescript-eslint/eslint-plugin": "^5.6.0",
+    "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",
+    "jest": "^29.3.1",
+    "jest-environment-jsdom": "^29.3.1",
     "npm-run-all": "^4.1.5",
     "prettier": "2.7.1",
     "stylelint": "^14.11.0",

package/src/tasks/init/template/tasks.config.json

@@ -14,6 +14,7 @@
   "component": {
     "library": "",
     "type": "",
+    "version": "",
     "subtype": "",
     "description": "",
     "icon": ""

package/src/tasks/linter/index.js

@@ -0,0 +1,46 @@
+import { ESLint } from 'eslint';
+import chalk from 'chalk';
+
+export const lintComponent = async (dirToLint) => {
+  // console.log("in dx-component-builder-sdk: lintComponent - dirToLint: " + dirToLint);
+  console.log(chalk.green(` linting ${dirToLint}`));
+
+  // 1. Create an instance.
+  const eslint = new ESLint();
+
+  // 2. Lint files.
+  const results = await eslint.lintFiles([dirToLint]);
+
+  // 3. Format the results.
+  const formatter = await eslint.loadFormatter("stylish");
+  const resultText = formatter.format(results);
+
+  // 4. Output it.
+  // console.log(`lint resultText: ${resultText}`);
+  console.log(resultText);
+
+  // Indicate linting is complete
+  console.log(chalk.green(` linting complete...`));
+};
+
+// inpsired by https://eslint.org/docs/latest/developer-guide/nodejs-api
+
+// (async function main() {
+//   // 1. Create an instance.
+//   const eslint = new ESLint();
+
+//   // 2. Lint files.
+//   const results = await eslint.lintFiles(["lib/**/*.js"]);
+
+//   // 3. Format the results.
+//   const formatter = await eslint.loadFormatter("stylish");
+//   const resultText = formatter.format(results);
+
+//   // 4. Output it.
+//   console.log(resultText);
+// })().catch((error) => {
+//   process.exitCode = 1;
+//   console.error(error);
+// });
+
+export default lintComponent;

package/src/tasks/list/index.js

@@ -10,6 +10,8 @@ import {
   getListComponentsQuestions
 } from './helper.js';
 
+import { showVersion } from '../../util.js';
+
 const getList = async (sourceOfComponents, answers) => {
   switch (sourceOfComponents) {
     case SOURCE_OF_COMPONENT_TYPES.LOCAL: {
@@ -32,6 +34,8 @@ const getList = async (sourceOfComponents, answers) => {
 };
 
 export default async options => {
+  showVersion();
+
   let sourceOfComponentsOption = SOURCE_OF_COMPONENT_TYPES.LOCAL;
 
   if (options.params[3] === SOURCE_OF_COMPONENT_TYPES.LOCAL) {

package/src/tasks/publish/index.js

@@ -4,10 +4,15 @@ import chalk from 'chalk';
 
 import validate from '../validator/index.js';
 
-import bundleComponent from './bundle/index.js';
+import bundleComponent from '../bundle/index.js';
+import { lintComponent } from '../linter/index.js';
+
+import { getComponentDirectoryPath, showVersion } from '../../util.js';
 import { getPublishComponentQuestions, publishComponentToServer, zipComponent } from './helper.js';
 
 export default async options => {
+  showVersion();
+
   const questions = await getPublishComponentQuestions();
   const answers = await inquirer.prompt(questions);
   const { componentKey, sourceMap, devBuild } = answers;
@@ -24,6 +29,14 @@ export default async options => {
           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),

package/src/tasks/publish-all/helper.js

@@ -0,0 +1,139 @@
+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: 'rulesetName',
+      message: 'Enter ruleset name',
+      default: defaultPegaConfig.rulesetName,
+      validate: value => {
+        if (value.trim()) {
+          return true;
+        }
+        return 'Ruleset name cannot be empty';
+      }
+    },
+    {
+      name: 'rulesetVersion',
+      message: 'Enter ruleset version',
+      default: defaultPegaConfig.rulesetVersion,
+      validate: value => {
+        if (validateRulesetVersion(value)) {
+          return true;
+        }
+        return 'Please provide compatible version e.g 01-01-01';
+      }
+    },
+    {
+      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/publish-all/index.js

@@ -0,0 +1,84 @@
+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 {
+  getComponents,
+  getComponentDirectoryPath,
+  showVersion
+} from '../../util.js';
+
+export default async options => {
+  showVersion();
+
+  const components = await getComponents();
+  const questions = await getPublishComponentQuestions();
+  const answers = await inquirer.prompt(questions);
+  const {sourceMap, devBuild } = answers;
+
+  let content = {
+    ...answers
+  };
+
+  var componentKey;
+
+  const tasks = new Listr(
+    [
+      {
+        title: 'Validate config schema',
+        task: async () => {
+          await validate(componentKey);
+        }
+      },
+      {
+        title: 'Bundle Component',
+        task: async () => await bundleComponent(componentKey, sourceMap, devBuild),
+        skip: () => (options.skipBundle ? 'Skipped bundling component' : undefined)
+      },
+      {
+        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: 'Zip Component',
+        task: async () => {
+          const output = await zipComponent(componentKey);
+          content = { ...content, ...output };
+        }
+      },
+      {
+        title: 'Publish Component',
+        task: async () => {
+          await publishComponentToServer(content);
+        }
+      }
+    ],
+    {
+      exitOnError: true
+    }
+  );
+
+  for (var index in components) {
+    componentKey = components[index];
+    console.log(chalk.bold.green("Publishing: " + componentKey));
+    await tasks.run().catch(err => {
+       console.log(chalk.bold.red(err.toString()));
+    });
+  }
+
+ // await tasks.run().catch(err => {
+ //   console.log(chalk.bold.red(err.toString()));
+//  });
+  return true;
+};

package/src/util.js

@@ -7,6 +7,8 @@ import chalk from 'chalk';
 import mustache from 'mustache';
 import pascalCase from 'pascalcase';
 import fetch from 'node-fetch';
+import { createRequire } from 'module';
+
 
 import {
   COMPONENTS_DIRECTORY_PATH,
@@ -218,6 +220,14 @@ export const validateRulesetVersion = str => {
   return regex.test(str);
 };
 
+export const showVersion = () => {
+  // get package version, so can display at start
+  const require = createRequire(import.meta.url);
+  const pData = require("@pega/custom-dx-components/package.json");
+
+  console.log(chalk.green("DX Component Builder v" + pData.version));
+}
+
 export const getOOTBComponents = async () => {
   return new Promise((resolve, reject) => {
     fs.readFile(OOTB_COMPONENTS, 'utf-8', async (err, data) => {

package/src/tasks/create/templates/Constellation/Field/Picklist/picklist.js.mustache

@@ -1,43 +0,0 @@
-import {EmailDisplay, PhoneDisplay, URLDisplay } 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;
-  };
-
-
-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;
-};

package/src/tasks/create/templates/Constellation/Field/Text-Email/text-email.js.mustache

@@ -1,43 +0,0 @@
-import {EmailDisplay, PhoneDisplay, URLDisplay } 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;
-  };
-
-
-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;
-};

package/src/tasks/create/templates/Constellation/Field/Text-Input/text-input.js.mustache

@@ -1,43 +0,0 @@
-import {EmailDisplay, PhoneDisplay, URLDisplay } 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;
-  };
-
-
-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;
-};

package/src/tasks/create/templates/Constellation/Field/Text-Paragraph/text-paragraph.js.mustache

@@ -1,43 +0,0 @@
-import {EmailDisplay, PhoneDisplay, URLDisplay } 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;
-  };
-
-
-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;
-};

package/src/tasks/create/templates/Constellation/Field/Text-Phone/text-phone.js.mustache

@@ -1,43 +0,0 @@
-import {EmailDisplay, PhoneDisplay, URLDisplay } 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;
-  };
-
-
-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;
-};