@pega/custom-dx-components 0.0.1 → 0.8.1

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

@@ -0,0 +1,265 @@
+import fs from 'fs';
+import chalk from 'chalk';
+import inquirer from 'inquirer';
+import ora from 'ora';
+
+import path from 'path';
+import { join } from 'path';
+
+import {
+  deleteInfinityServerComponent,
+  deleteLaunchpadServerComponent,
+  deleteLocalComponent,
+  getComponents,
+  getPegaServerConfig,
+  standardizeStr,
+  validateRulesetVersion,
+  sanitize
+} from '../../util.js';
+import { getComponentsFromServer } from '../list/helper.js';
+
+import { TASKS_CONFIG_JSON_FILENAME, COMPONENTS_DIRECTORY_PATH, COMPONENTS_PATH } from '../../constants.js';
+
+export const SOURCE_OF_COMPONENT_TYPES = {
+  SERVER: 'Server',
+  LOCAL: 'Local'
+};
+
+const currentDirectory = process.cwd();
+const pegaConfigJsonPath = join(currentDirectory, TASKS_CONFIG_JSON_FILENAME);
+
+let data = fs.readFileSync(pegaConfigJsonPath, { encoding: 'utf8' });
+data = data && JSON.parse(data);
+
+if (!data[COMPONENTS_DIRECTORY_PATH]) {
+  console.error(
+    `${chalk.red.bold('ERROR')} Could not able find components directory path in config.json`
+  );
+  process.exit(1);
+}
+
+const componentData = data[COMPONENTS_PATH];
+
+let { library } = componentData;
+let { organization } = JSON.parse(fs.readFileSync(path.resolve('package.json'), 'utf8'));
+
+export const getDeleteComponentsQuestions = async (options) => {
+  const defaultPegaServerConfig = await getPegaServerConfig();
+
+  return [
+    {
+      name: 'sourceOfComponents',
+      type: 'rawlist',
+      message: 'Delete components from Server or Local ?',
+      choices: Object.values(SOURCE_OF_COMPONENT_TYPES),
+      default: defaultPegaServerConfig.sourceOfComponents,
+      when() {
+        return !options.params[3];
+      }
+    }
+  ];
+};
+
+export const getLaunchPadFilterQuestions = async () => {
+  const defaultPegaServerConfig = await getPegaServerConfig();
+
+  return [
+    {
+      name: 'organization',
+      message: 'Enter component organization (required)',
+      default: organization,
+      validate: value => {
+        if (value) {
+          return true;
+        }
+        return 'Please provide value for organization';
+      }
+    },
+    {
+      name: 'library',
+      message: 'Enter library name (required)',
+      default: library,
+      validate: value => {
+        if (value) {
+          return true;
+        }
+        return 'Please provide value for library';
+      }
+    }
+  ];
+}
+
+export const deleteLocalComponents = async (sourceOfComponents, options) => {
+  const localComponents = await getComponents();
+
+  // eslint-disable-next-line no-restricted-syntax, guard-for-in
+  for (const index in localComponents) {
+    console.log(chalk.bold.green(localComponents[index]));
+  }
+
+  if (localComponents.length > 0) {
+    if (options.params.length >= 5) {
+      const sDeletion = options.params[4];
+      const confirmDeletion = sDeletion === 'Y' || sDeletion === 'y' || sDeletion === true || sDeletion === 'true';
+      if (confirmDeletion) {
+        // eslint-disable-next-line no-restricted-syntax, guard-for-in
+        for (const index in localComponents) {
+          const componentToDelete = localComponents[index];
+          // console.log(chalk.bold.green("Deleting: " + componentToDelete));
+          // eslint-disable-next-line no-await-in-loop
+          await deleteLocalComponent(componentToDelete);
+        }
+      }
+    } else {
+      const answers = await inquirer.prompt([
+        {
+          name: 'confirmDeletion',
+          type: 'confirm',
+          message: 'Delete all local ?',
+          default: false
+        }
+      ]);
+      if (answers.confirmDeletion) {
+        for (const component of localComponents) {
+          // console.log(chalk.bold.green("Deleting: " + componentToDelete));
+          // eslint-disable-next-line no-await-in-loop
+          await deleteLocalComponent(component);
+        }
+      }
+    }
+  } else {
+    console.log(chalk.bold.redBright(`No custom components in ${sourceOfComponents}`));
+  }
+};
+
+export const deleteServerComponents = async (sourceOfComponents, answers) => {
+
+  const defaultPegaServerConfig = await getPegaServerConfig();
+  const isLaunchpad = defaultPegaServerConfig.serverType === 'launchpad';
+
+  if (isLaunchpad) {
+    const questions = await getLaunchPadFilterQuestions();
+    const lpAnswers = await inquirer.prompt(questions);
+
+    ({library, organization} = lpAnswers);
+  }
+
+  const spinner = ora('Fetching components from server').start();
+  const data = await getComponentsFromServer(library, organization);
+  spinner.stop();
+
+
+  // const serverComponents = isLaunchpad ? data : data.pxResults;
+  let serverComponents;
+  if (isLaunchpad) {
+    serverComponents = data;
+  } else {
+    try {
+      if (typeof data === 'object') {
+        serverComponents = data.pxResults;
+      } else {
+        serverComponents = JSON.parse(data).pxResults;
+      }
+    } catch (ex) {
+      /* empty */
+    }
+  }
+
+
+
+  if (serverComponents && serverComponents?.length > 0) {
+    if (isLaunchpad) {
+      serverComponents.forEach((component) => {
+        console.log(chalk.bold.green(component.name));
+      });
+
+      const confirmDeletionAnswers = await inquirer.prompt([
+        {
+          name: 'confirmDeletion',
+          type: 'confirm',
+          message: 'All custom components for the tenant would be deleted. Do you want to proceed ?',
+          default: false
+        }
+      ]);
+
+      if (confirmDeletionAnswers.confirmDeletion) {
+        const componentsList = serverComponents.map((component) => `${component.name}~|~`);
+        for (const componentToDelete of componentsList) {
+          // eslint-disable-next-line no-await-in-loop
+          await deleteLaunchpadServerComponent(componentToDelete);
+        }
+      }
+    } else {
+      const choicesArr = serverComponents.map(({ label, pyRuleSet, pyRuleSetVersion }) => {
+        const name = `${standardizeStr(label, 45)} ${standardizeStr(pyRuleSet, 30)} ${standardizeStr(pyRuleSetVersion, 20)}`;
+
+        const value = `${label}~|~${pyRuleSet}~|~${pyRuleSetVersion}`;
+        const short = `\n Selected component : ${chalk.redBright(`${label} ${pyRuleSet} : ${pyRuleSetVersion}`)}`;
+
+        return { name, value, short };
+      });
+
+      const selectedComp = await inquirer.prompt([
+        {
+          name: 'rulesetName',
+          message: 'Enter ruleset name',
+          default: defaultPegaServerConfig.rulesetName,
+          validate: (value) => {
+            if (value.trim()) {
+              return true;
+            }
+            return 'Ruleset name cannot be empty';
+          }
+        },
+        {
+          name: 'rulesetVersion',
+          message: 'Enter ruleset version',
+          default: defaultPegaServerConfig.rulesetVersion,
+          validate: (value) => {
+            if (validateRulesetVersion(value)) {
+              return true;
+            }
+            return 'Please provide compatible version e.g 01-01-01';
+          }
+        }
+      ]);
+
+      let bHasAtLeastOneComponent = false;
+      for (const choice of choicesArr) {
+        const componentToDelete = choice.value;
+        const [name, rulesetName, rulesetVersion] = componentToDelete.split('~|~');
+        if (rulesetName === selectedComp.rulesetName && rulesetVersion === selectedComp.rulesetVersion) {
+          console.log(chalk.bold.green(name));
+          bHasAtLeastOneComponent = true;
+        }
+      }
+
+      if (!bHasAtLeastOneComponent) {
+        console.log(chalk.bold.redBright(`No custom components in ${sourceOfComponents} that match ruleSet:${selectedComp.rulesetName}.`));
+        process.exit();
+      }
+
+      const confirmDeletionAnswers = await inquirer.prompt([
+        {
+          name: 'confirmDeletion',
+          type: 'confirm',
+          message: 'Do you want to delete these components ?',
+          default: false
+        }
+      ]);
+      if (confirmDeletionAnswers.confirmDeletion) {
+        for (const choice of choicesArr) {
+          const componentToDelete = choice.value;
+          // eslint-disable-next-line no-unused-vars
+          const [name, rulesetName, rulesetVersion] = componentToDelete.split('~|~');
+          if (rulesetName === selectedComp.rulesetName && rulesetVersion === selectedComp.rulesetVersion) {
+            // eslint-disable-next-line no-await-in-loop
+            await deleteInfinityServerComponent(componentToDelete);
+          }
+        }
+      }
+    }
+  } else {
+    console.log(chalk.bold.redBright(`No custom components in ${sourceOfComponents}`));
+  }
+};

package/src/tasks/delete-all/index.js

@@ -0,0 +1,42 @@
+import inquirer from 'inquirer';
+
+import { showVersion } from '../../util.js';
+
+import { deleteLocalComponents, SOURCE_OF_COMPONENT_TYPES, deleteServerComponents, getDeleteComponentsQuestions } from './helper.js';
+
+const deleteComponentsFn = async (sourceOfComponents, answers, options) => {
+  switch (sourceOfComponents) {
+    case SOURCE_OF_COMPONENT_TYPES.LOCAL: {
+      await deleteLocalComponents(sourceOfComponents, options);
+      break;
+    }
+    case SOURCE_OF_COMPONENT_TYPES.SERVER: {
+      await deleteServerComponents(sourceOfComponents, answers);
+      break;
+    }
+    default: {
+      console.log('Source of components needs to be either Local or Server');
+      break;
+    }
+  }
+};
+
+export default async (options) => {
+  showVersion();
+
+  let sourceOfComponentsOption = SOURCE_OF_COMPONENT_TYPES.LOCAL;
+  if (options.params[3] === SOURCE_OF_COMPONENT_TYPES.LOCAL) {
+    sourceOfComponentsOption = options.params[3];
+    await deleteComponentsFn(sourceOfComponentsOption, null, options);
+  } else if (options.params[3] === SOURCE_OF_COMPONENT_TYPES.SERVER) {
+    sourceOfComponentsOption = options.params[3];
+    const questions = await getDeleteComponentsQuestions(options, sourceOfComponentsOption);
+    const answers = await inquirer.prompt(questions);
+    await deleteComponentsFn(sourceOfComponentsOption, answers, options);
+  } else {
+    const questions = await getDeleteComponentsQuestions(options);
+    const answers = await inquirer.prompt(questions);
+    const { sourceOfComponents } = answers;
+    await deleteComponentsFn(sourceOfComponents, answers, options);
+  }
+};

package/src/tasks/index.js

@@ -1,9 +1,17 @@
 export { default as createComponent } from './create/index.js';
+export { default as createAllComponents } from './create-all/index.js';
 export { default as deleteComponent } from './delete/index.js';
+export { default as deleteAllComponents } from './delete-all/index.js';
 export { default as initProject } from './init/index.js';
+export { default as promoteWebPack } from './promote-webpack/index.js';
 export { default as publishComponent } from './publish/index.js';
+export { default as publishAllComponents } from './publish-all/index.js';
+export { default as renameComponent } from './rename/index.js';
+export { default as revertWebPack } from './revert-webpack/index.js';
 export { default as listComponents } from './list/index.js';
 export { default as updateComponent } from './update/index.js';
 export { default as validate } from './validator/index.js';
 export { default as authenticate } from './authenticate/index.js';
 export { default as upgrade } from './upgrade/index.js';
+export { default as buildComponent } from './build/index.js';
+export { default as buildAllComponents } from './build-all/index.js';

package/src/tasks/init/index.js

@@ -11,12 +11,7 @@ import Listr from 'listr';
 import gitignore from 'gitignore';
 import inquirer from 'inquirer';
 
-import {
-  compileMustacheTemplate,
-  isPascalCase,
-  convertIntoPascalCase,
-  sanitize
-} from '../../util.js';
+import { compileMustacheTemplate, isPascalCase, convertIntoPascalCase, sanitize } from '../../util.js';
 
 import { getInitProjectQuestions } from './helper.js';
 
@@ -26,7 +21,7 @@ const copy = promisify(ncp);
 const writeGitignore = promisify(gitignore.writeFile);
 const writeFile = promisify(fs.writeFile);
 
-const createGitignore = async options => {
+const createGitignore = async (options) => {
   const file = fs.createWriteStream(path.join(options.targetDirectory, '.gitignore'), {
     flags: 'a'
   });
@@ -36,17 +31,18 @@ const createGitignore = async options => {
   });
 };
 
-const createLicense = async options => {
+const createLicense = async (options) => {
   const targetPath = path.join(options.targetDirectory, 'LICENSE');
   const licenseContent = 'Enter license text here';
   return writeFile(targetPath, licenseContent, 'utf8');
 };
 
-const copyProjectTemplate = async options => {
+const copyProjectTemplate = async (options) => {
   await copy(options.templateDirectory, options.targetDirectory, {
     clobber: false
   });
   const packageJsonPath = path.join(options.targetDirectory, 'package.json.mustache');
+  const templateNPMRCPath = path.join(options.targetDirectory, 'templateNPMRC.txt');
 
   let { organization, projectName } = options;
 
@@ -65,10 +61,14 @@ const copyProjectTemplate = async options => {
   const output = compileMustacheTemplate(packageJsonPath, options);
   fs.writeFileSync(packageJsonPath, output);
   fs.renameSync(packageJsonPath, packageJsonPath.replace('.mustache', ''));
+
+  // rename template NPMRC to .npmrc, need to do this because npmjs won't publish an .npmrc file
+  fs.renameSync(templateNPMRCPath, templateNPMRCPath.replace('templateNPMRC.txt', '.npmrc'));
+
   await createLicense(options);
 };
 
-const initGit = async options => {
+const initGit = async (options) => {
   const result = await execa('git', ['init'], {
     cwd: options.targetDirectory
   });
@@ -77,16 +77,13 @@ const initGit = async options => {
   }
 };
 
-export default async options => {
-  options.templateDirectory = path.resolve(
-    path.dirname(fileURLToPath(import.meta.url)),
-    'template'
-  );
+export default async (options) => {
+  options.templateDirectory = path.resolve(path.dirname(fileURLToPath(import.meta.url)), 'template');
   let projectName = 'test';
 
   const questions = getInitProjectQuestions();
 
-  await inquirer.prompt(questions).then(async answers => {
+  await inquirer.prompt(questions).then(async (answers) => {
     projectName = answers.projectName;
     projectName = sanitize(projectName).toLowerCase();
     options = { ...options, ...answers };
@@ -97,11 +94,12 @@ export default async options => {
       fs.mkdirSync(projectDirectory);
     } else {
       console.log(chalk.bold.red(`A project with name ${projectName} already exists. Exiting...`));
-      process.exit(1);
+      process.exit();
     }
 
     const targetDirectory = options.targetDirectory || process.cwd();
     options.targetDirectory = path.join(targetDirectory, projectName);
+    options.componentDirectory = path.join(options.targetDirectory, 'node_modules/@pega/custom-dx-components');
   });
 
   const installDependenciesText = `Installing dependencies. This will take a couple of minutes.`;
@@ -123,7 +121,15 @@ export default async options => {
       },
       {
         title: installDependenciesText,
-        task: () => execPromise('npm i --production=false', { cwd: options.targetDirectory })
+        task: () => execPromise('npm i --force --production=false', { cwd: options.targetDirectory })
+      },
+      {
+        title: 'Installing tasks dependencies',
+        task: () => execPromise('npm i --force --production=false', { cwd: options.componentDirectory })
+      },
+      {
+        title: 'Installing quick run',
+        task: () => execPromise('npm i -g npm-quick-run', { cwd: options.targetDirectory })
       }
     ],
     {
@@ -133,14 +139,12 @@ export default async options => {
 
   await tasks.run();
   console.log('\n');
-  console.log(
-    `${chalk.green('Success!!')} Project created at ${chalk.blueBright(options.targetDirectory)}`
-  );
+  console.log(`${chalk.green('Success!!')} Project created at ${chalk.blueBright(options.targetDirectory)}`);
   console.log(
     '\n',
     `Inside that directory, you can run several commands:`,
     '\n\n',
-    `${chalk.blueBright('npm start')}`,
+    `${chalk.blueBright('npm run startStorybook')}`,
     `\n  Start Storybook in development mode`,
     '\n\n',
     `${chalk.blueBright('npm run create')}`,
@@ -158,7 +162,7 @@ export default async options => {
     '\n\n',
     `${chalk.blueBright('cd')} ${chalk.bold(projectName)}`,
     '\n',
-    `${chalk.blueBright('npm start')}`,
+    `${chalk.blueBright('npm run startStorybook')}`,
     '\n'
   );
   return true;

package/src/tasks/init/template/.eslintignore

@@ -0,0 +1,8 @@
+webpack.config.js
+src/helpers/config_access.js
+*.html
+*.css
+*.json
+*.md
+*.svg
+*.zip

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

@@ -1,10 +1,191 @@
 {
-  "extends": ["@pega"],
-  "parserOptions": { "project": "tsconfig.json" },
   "root": true,
-  "ignorePatterns": ["node_modules", "lib", "!.storybook", ".storybook/public"],
+  "extends": ["@pega"],
+  "parserOptions": {
+    "project": "tsconfig.json",
+    "ecmaVersion": 13
+  },
+  "settings": {
+    "import/resolver": {
+      "typescript": {},
+      "node": {
+        "extensions": [".js", ".jsx"]
+      }
+    },
+    "react": {
+      "version": "detect"
+    }
+  },
+  "ignorePatterns": ["node_modules", "packages/*/lib", "!.storybook", ".storybook/public"],
   "rules": {
+    // Prettier recommends running separately from a linter.
+    // https://prettier.io/docs/en/integrating-with-linters.html#notes
     "prettier/prettier": "off",
-    "react/react-in-jsx-scope": "off"
-  }
+
+    // Disable rules from shared configs we're not ready for yet.
+    "sonarjs/cognitive-complexity": "off",
+    "sonarjs/no-identical-functions": "off",
+    "sonarjs/no-duplicate-string": "off",
+    "sonarjs/no-nested-template-literals": "off",
+
+    //
+    // JA - Override some default lint handling here
+    "@typescript-eslint/array-type": ["error", { "default": "generic" }],
+    // "import/extensions": ["warn", "never"],    // Turning off for now (see below)
+
+    //
+    // Initial release: turning these off; phase in to "warn" or "error" over time
+    //  For "quotes" and "@typescript-eslint/quotes", see override below for .ts/.tsx files
+    "import/extensions": ["off", "never"],
+    "import/named": "off",
+    "import/no-cycle": "off",
+    "import/no-duplicates": "off",
+    "import/no-extraneous-dependencies": "off",
+    "import/no-named-as-default": "off",
+    "import/no-named-as-default-member": "off",
+    "import/no-self-import": "off",
+    "import/no-unresolved": "off",
+    "import/no-useless-path-segments": "off",
+    "import/order": "off",
+
+    "no-else-return": "off",
+    "no-restricted-syntax": "off",
+    "no-underscore-dangle": "off",
+
+    "jsx-a11y/alt-text": "off",
+    "jsx-a11y/anchor-is-valid": "off",
+    "jsx-a11y/click-events-have-key-events": "off",
+    "jsx-a11y/label-has-associated-control": "off",
+    "jsx-a11y/no-static-element-interactions": "off",
+
+    "react/jsx-fragments": "off",
+    "react/jsx-no-bind": "off",
+    "react/self-closing-comp": "off",
+
+    "sonarjs/prefer-immediate-return": "off",
+
+    "@typescript-eslint/dot-notation": "off", // prefer warn but needs different parserOptions
+    "@typescript-eslint/naming-convention": "off", // prefer warn but needs different parserOptions
+    "@typescript-eslint/ban-types": "off", // also, see override below
+
+    //
+    // Initial release: set to error
+    "@typescript-eslint/no-inferrable-types": "error",
+    "eqeqeq": "error",
+    "no-alert": "error",
+    "no-console": "error",
+    "no-fallthrough": "error",
+    "no-undef": "error",
+    "no-unused-vars": "error",
+    "no-var": "error",
+    "prefer-const": "error",
+    "yoda": "error",
+
+    "import/no-mutable-exports": "error",
+    "sonarjs/max-switch-cases": "error",
+    "sonarjs/no-collapsible-if": "error",
+    "sonarjs/no-all-duplicated-branches": "error",
+    "sonarjs/no-duplicated-branches": "error",
+    "sonarjs/no-gratuitous-expressions": "error",
+    "sonarjs/no-ignored-return": "error",
+    "sonarjs/no-small-switch": "error",
+    "sonarjs/prefer-object-literal": "error",
+    "sonarjs/prefer-single-boolean-return": "error",
+    "@typescript-eslint/no-shadow": "error",
+    "react/default-props-match-prop-types": "error",
+    "react/no-unescaped-entities": "error",
+    "react/no-unused-prop-types": "error",
+    "react/static-property-placement": "error",
+    "array-callback-return": "error",
+    "camelcase": "error",
+    "default-case": "error",
+    "func-names": "error",
+    "no-case-declarations": "error",
+    "no-lonely-if": "error",
+    "no-nested-ternary": "error",
+    "no-plusplus": "error",
+    "no-restricted-globals": "error",
+    "no-restricted-properties": "error",
+    "no-shadow": "error",
+    "radix": "error",
+    "spaced-comment": "error",
+
+    "import/newline-after-import": "error",
+    "sonarjs/no-nested-switch": "error",
+    "@typescript-eslint/no-array-constructor": "error",
+    "@typescript-eslint/no-empty-function": "error",
+    "@typescript-eslint/no-unused-vars": "error",
+    "@typescript-eslint/no-useless-constructor": "error",
+    "react/button-has-type": "error",
+    "react/jsx-curly-brace-presence": "error",
+    "react/jsx-boolean-value": "error",
+    "react/no-array-index-key": "error",
+    "class-methods-use-this": "error",
+    "guard-for-in": "error",
+    "no-unneeded-ternary": "error",
+    "no-unused-expressions": "error",
+    "operator-assignment": "error",
+    "prefer-template": "error",
+    "vars-on-top": "error",
+
+    "no-use-before-define": "off", // doc for @typescript-eslint/no-use-before-define says to turn off the base implementation
+    "@typescript-eslint/no-use-before-define": "error"
+  },
+  "overrides": [
+    {
+      "files": "*.@(ts|tsx)",
+      "rules": {
+        "@typescript-eslint/method-signature-style": ["error", "property"],
+        // "@typescript-eslint/ban-types": [
+        //   "warn",
+        //   {
+        //     "types": {
+        //       "Omit": "Please use the 'OmitStrict' type from 'src/types/' instead.",
+        //       "object": false,
+        //       "Function": false
+        //     },
+        //     "extendDefaults": true
+        //   }
+        // ],
+
+        "quotes": "off",
+        "@typescript-eslint/quotes": "off"
+        // [
+        //   "error",
+        //   "single",
+        //   {
+        //     "avoidEscape": true,
+        //     "allowTemplateLiterals": false
+        //   }
+        // ]
+      }
+    },
+    {
+      "files": "*.@(jsx|tsx|mdx)",
+      "rules": {
+        "react/react-in-jsx-scope": "off",
+        // Set up configuration for future sweep
+        "react-hooks/exhaustive-deps": [
+          "off",
+          {
+            "additionalHooks": "useAfterInitialEffect"
+          }
+        ]
+      }
+    },
+    {
+      "files": "*.@(js|jsx|ts|tsx|mdx)",
+      "rules": {}
+    },
+    {
+      "files": ".storybook/*.js",
+      "extends": ["@pega/eslint-config/script"]
+    },
+    {
+      "files": "*/**/mocks/**.@(mocks|styles).@(tsx|ts)",
+      "rules": {
+        "import/prefer-default-export": ["off"]
+      }
+    }
+  ]
 }

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

@@ -0,0 +1 @@
+{}

package/src/tasks/init/template/.vscode/extensions.json

@@ -4,6 +4,6 @@
     "esbenp.prettier-vscode",
     "stylelint.vscode-stylelint",
     "streetsidesoftware.code-spell-checker",
-    "jpoissonnier.vscode-styled-components"
+    "styled-components.vscode-styled-components"
   ]
 }