@pega/custom-dx-components 0.24.16 → 0.25.1

package/src/tasks/import-comp/index.js

@@ -0,0 +1,366 @@
+import fs from 'fs';
+import { promisify } from 'util';
+import { join } from 'path';
+
+import inquirer from 'inquirer';
+import ncp from 'ncp';
+import chalk from 'chalk';
+
+import {
+  sanitize,
+  checkPathAccess,
+  showVersion,
+  getDirectoryFiles,
+  addDebugLog,
+  checkLibraryAndArchives,
+  getConfigDefaults,
+  getComponents
+ } from '../../util.js';
+import { TASKS_CONFIG_JSON_FILENAME } from '../../constants.js';
+import { getFilePathQuestions, getFileNameQuestions, updateSavedFilePath  } from './helper.js';
+
+import buildComponent from '../build-comp/index.js';
+
+export const DXCB_CONFIG_INTERNAL_JSON_FILENAME = 'src/dxcb.config.json';
+const currentDirectory = process.cwd();
+const pegaConfigJsonPath = join(currentDirectory, TASKS_CONFIG_JSON_FILENAME);
+
+import {
+  convertIntoPascalCase,
+  getComponentDirectoryPath
+} from '../../util.js';
+
+
+const copy = promisify(ncp);
+
+let gFilePath = "";
+
+
+export const updateConfig = async (
+  {
+    oldComponentKey,
+    newComponentKey,
+    library,
+    version,
+    targetDirectory,
+    newLabel = "",
+  },
+  options,
+  onlyCompanion = false
+) => {
+
+addDebugLog("updateConfig", `oldComponentKey: ${oldComponentKey}, newComponentKey: ${newComponentKey}`, "");
+
+  let configData = fs.readFileSync(join(targetDirectory, "/config.json"), { encoding: 'utf8' });
+  configData = configData && JSON.parse(configData);
+
+  configData.name = newComponentKey;
+  if (configData.componentKey) configData.componentKey = newComponentKey;
+  configData.library = library;
+  configData.version = version;
+
+  if (newLabel != "") {
+    configData.label = newLabel;
+    configData.description = newLabel;
+  }
+
+  // stringify "4", makes the json string look like JSON in the file, formated instead of a single line
+  fs.writeFileSync(join(targetDirectory, "/config.json"), JSON.stringify(configData, null, 4), { encoding: 'utf8' });
+
+};
+
+export const updateFile = async (
+    fileName,
+    oldComponentKeyPC,
+    newComponentKeyPC,
+    targetDirectory,
+) => {
+
+addDebugLog("updateFile", `fileName: ${fileName}, oldComponentKeyPC: ${oldComponentKeyPC}, newComponentKeyPC: ${newComponentKeyPC}, targetDirectory: ${targetDirectory}`, "");
+
+  let fileData = fs.readFileSync(join(targetDirectory, "/", fileName), { encoding: 'utf8' });
+
+  if (fileData.indexOf(oldComponentKeyPC) >= 0) {
+    fileData = fileData.replaceAll(oldComponentKeyPC, newComponentKeyPC);
+
+    fs.writeFileSync(join(targetDirectory, "/", fileName), fileData, { encoding: 'utf8' });
+  }
+
+};
+
+
+// rename the component
+export const renameComponent = async (
+    componentKey,
+    library,
+    version,
+    newName = "",
+    newLabel = "",
+    options
+) => {
+
+addDebugLog("renameComponent", `library: ${library}, componentKey: ${componentKey}`, "");
+
+  const componentName = newName != "" ? newName : componentKey.split("_")[2];
+  const newComponentKey = `${library}_${componentName}`;
+  const oldComponentKey = componentKey;
+  const newComponentKeyPC = convertIntoPascalCase(newComponentKey);
+  const oldComponentKeyPC = convertIntoPascalCase(oldComponentKey);
+
+  const currentDirectory = await getComponentDirectoryPath(componentKey);
+  const targetDirectory = await getComponentDirectoryPath(newComponentKey);
+
+  // custom component
+  try {
+    fs.renameSync(currentDirectory, targetDirectory);
+  } catch(err) {
+    console.log(err)
+  }
+
+  const targetFileList = await getDirectoryFiles(targetDirectory);
+
+  for (var fileIndex in targetFileList) {
+    const fileName = targetFileList[fileIndex];
+
+    if (fileName === "config.json") {
+      await updateConfig(
+        {
+          oldComponentKey,
+          newComponentKey,
+          componentName,
+          library,
+          version,
+          targetDirectory,
+          newLabel
+        },
+        options
+      );
+    }
+    else {
+      await updateFile(
+          fileName,
+          oldComponentKeyPC,
+          newComponentKeyPC,
+          targetDirectory );
+
+    }
+
+  } // for
+
+
+  return newComponentKey;
+
+};
+
+
+export const importComp = async(filePath, fileName, askValidate) => {
+addDebugLog("importComp", `filePath: ${filePath}, fileName: ${fileName}`, "");
+
+  const currentDirectory = process.cwd();
+  // const compDirectory = join(currentDirectory, "src", "components");
+
+  const copyFilePath = join(filePath, fileName);
+
+  const configDef = getConfigDefaults();
+  const copyDir = await getComponentDirectoryPath(fileName);
+  let configData;
+  let newName = "";
+  let newLabel = "";
+
+  if (fs.existsSync(copyDir)) {
+    configData = fs.readFileSync(join(copyDir, "/config.json"), { encoding: 'utf8' });
+    configData = configData && JSON.parse(configData);
+
+    const compName = configData.componentKey.split("_")[2];
+    const potentialCompKey = `${configDef.currentOrgLib}_${compName}`;
+    const currentCompList = await getComponents();
+
+
+    if (currentCompList && currentCompList.includes(potentialCompKey)) {
+      console.log(`\nComponent ${chalk.yellow(`${potentialCompKey}`)} already exists.`);
+      const proceedAnswers = await inquirer.prompt([
+
+        {
+          name: 'proceedAs',
+          type: 'rawlist',
+          message: `Proceed as ?`,
+          default: 'No import',
+          choices: ['No import', 'Overwrite', 'New name']
+        },
+        {
+          name: 'componentName',
+          message: 'Enter component name (required)',
+          when(answers) {
+            return answers.proceedAs === 'New name';
+          },
+          validate: value => {
+            /* value should not be empty
+            It should not have spaces
+            It should not start with a number
+            Only case-insensitive alphanumeric values are allowed
+          */
+            if (value && !/^\d/.test(value) && value === sanitize(value)) {
+              return true;
+            }
+            return 'Only alphanumeric values are allowed, starting with alphabets, no spaces.';
+          }
+        },
+        {
+          name: 'componentLabel',
+          message: 'Enter component label for display (required)',
+          when(answers) {
+            return answers.proceedAs === 'New name';
+          },
+          validate: value => {
+            if (value) {
+              return true;
+            }
+            return 'Please provide value for label';
+          }
+        }
+      ]);
+
+
+      switch (proceedAnswers.proceedAs) {
+        case 'No import':
+          // removed copied
+          // fs.rmSync(copyDir, { recursive: true, force: true, maxRetries: 2 });
+          process.exit();
+          break;
+        case 'Overwrite':
+          // remove existing
+          const existingComp = await getComponentDirectoryPath(potentialCompKey);
+          fs.rmSync(existingComp, { recursive: true, force: true, maxRetries: 2 });
+          break;
+        case 'New name':
+          newName = proceedAnswers.componentName;
+          newLabel = proceedAnswers.componentLabel;
+          break;
+      }
+
+    }
+  }
+
+  if (fs.existsSync(copyFilePath)) {
+    fs.cpSync(copyFilePath, copyDir, { recursive: true, force: true  });
+    configData = fs.readFileSync(join(copyDir, "/config.json"), { encoding: 'utf8' });
+
+    configData = configData && JSON.parse(configData);
+
+    const newCompKey = await renameComponent(configData.componentKey, configDef.currentOrgLib, configDef.buildVersion, newName, newLabel, null);
+    console.log(`\n${chalk.green(`${fileName}`)} has been imported as ${chalk.green(`${newCompKey}`)}\n`);
+
+    if (askValidate) {
+      const validateAnswers = await inquirer.prompt([
+        {
+          name: 'doValidate',
+          type: 'confirm',
+          message: `Validate ${chalk.yellow(`${newCompKey}`)}`,
+          default: true
+        }]);
+
+      if (validateAnswers.doValidate) {
+        const args  = [ '','', '', `${newCompKey}`];
+        let myOptions = {};
+        myOptions["params"] = args;
+
+        await buildComponent(myOptions);
+      }
+    }
+
+
+
+
+  }
+
+
+
+
+}
+
+
+export const getFolderList = async (filePath) => {
+addDebugLog("getFolderList", `filePath: ${filePath}`, "");
+  if (fs.existsSync(filePath)) {
+    return fs
+      .readdirSync(filePath, { withFileTypes: true })
+      .filter(dirent => dirent.isDirectory()  && !dirent.name.startsWith("."))
+      .map(dirent => dirent.name);
+  }
+  else {
+    console.log(chalk.red.bold(`File path: ${filePath} does not exist or no permissions.`));
+    process.exit(1);
+  }
+}
+
+export const hasConfig = (dir) => {
+  const configPath = join(gFilePath, dir, "config.json");
+  if (fs.existsSync(configPath)) {
+    return true;
+  }
+
+  return false;
+}
+
+export const getComponentList = async(filePath) => {
+addDebugLog("getComponentList", `filePath: ${filePath}`, "");
+  let compList = await getFolderList(filePath);
+
+  gFilePath = filePath;
+
+  if (compList.length > 0) {
+    return compList.filter(hasConfig);
+  }
+
+  return compList;
+
+}
+
+export default async options => {
+  await showVersion();
+  await checkLibraryAndArchives();
+  await checkPathAccess(pegaConfigJsonPath);
+
+addDebugLog("importComponent", "", "+");
+
+  if (options.params.length >= 5) {
+    const filePath = options.params[3];
+    const fileName = options.params[4];
+    let askValidate = true;
+
+    if (options.params.length >= 6) {
+      if (options.params[5] === "noAskValidate") {
+        askValidate = false;
+      }
+
+    }
+
+    await importComp( filePath, fileName, askValidate);
+
+  }
+  else {
+
+    const filePathQuestions = await getFilePathQuestions();
+    const filePathAnswers = await inquirer.prompt(filePathQuestions);
+    const { filePath } = filePathAnswers;
+
+    const compFileList = await getComponentList(filePath);
+
+    if (!compFileList || compFileList.length === 0) {
+      console.log(chalk.red.bold(`No component files exist at path: ${filePath}`));
+      process.exit();
+    }
+
+    await updateSavedFilePath(filePath);
+
+    const fileNameQuestions = await getFileNameQuestions(compFileList);
+    const fileNameAnswers = await inquirer.prompt(fileNameQuestions);
+    const {fileName} = fileNameAnswers;
+
+    await importComp( filePath, fileName, true);
+
+  }
+
+addDebugLog("importComponent", "END", "-");
+
+};

package/src/tasks/index.js

@@ -1,18 +1,40 @@
 export { default as createComponent } from './create/index.js';
 export { default as createAllComponents } from './create-all/index.js';
+export { default as createLibrary } from './create-lib/index.js';
+export { default as switchLibrary } from './switch-lib/index.js';
+export { default as createVersion } from './create-version/index.js';
+export { default as switchVersion } from './switch-version/index.js';
 export { default as deleteComponent } from './delete/index.js';
 export { default as deleteAllComponents } from './delete-all/index.js';
+export { default as deleteLibrary } from './delete-lib/index.js';
+export { default as deletePublished } from './delete-pub/index.js';
+export { default as deleteVersion } from './delete-version/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 publishLibrary } from './publish-lib/index.js';
+export { default as moveComponent } from './move/index.js';
 export { default as renameComponent } from './rename/index.js';
+export { default as renameLibrary } from './rename-lib/index.js';
 export { default as revertWebPack } from './revert-webpack/index.js';
+export { default as quarantine } from './quarantine/index.js';
 export { default as listComponents } from './list/index.js';
+export { default as listLibrary } from './list-lib/index.js';
+export { default as listPublished } from './list-pub/index.js';
+export { default as showStatus } from './show-status/index.js';
+export { default as showHelp } from './show-help/index.js';
+export { default as setPermanent } from './set-perm/index.js';
+export { default as storeComponents } from './store/index.js';
+export { default as importArchive } from './import-archive/index.js';
+export { default as exportArchive } from './export-archive/index.js';
+export { default as importComponent } from './import-comp/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-comp/index.js';
 export { default as buildAllComponents } from './build-all/index.js';
+export { default as buildLibrary } from './build-lib/index.js';
 export { default as buildJestAssets } from './build-jest-assets/index.js';
+export { default as restoreConfig } from './restore-config/index.js';

package/src/tasks/init/helper.js

@@ -32,27 +32,27 @@ export const getInitProjectQuestions = () => {
         return 'Only alphanumeric values are allowed, starting with alphabets';
       }
     },
-    {
-      name: 'version',
-      message: 'Version',
-      default: '1.0.0',
-      validate: value => {
-        if (validateSemver(value)) {
-          return true;
-        }
-        return 'Please provide semver compatible version e.g 0.0.1';
-      }
-    },
+    // {
+    //   name: 'version',
+    //   message: 'Version',
+    //   default: '1.0.0',
+    //   validate: value => {
+    //     if (validateSemver(value)) {
+    //       return true;
+    //     }
+    //     return 'Please provide semver compatible version e.g 0.0.1';
+    //   }
+    // },
     {
       name: 'description',
       message: 'Description',
       default: ''
     },
-    {
-      name: 'gitRepositoryUrl',
-      message: 'Git repository url (optional)',
-      default: ''
-    },
+    // {
+    //   name: 'gitRepositoryUrl',
+    //   message: 'Git repository url (optional)',
+    //   default: ''
+    // },
     {
       name: 'author',
       message: 'Author',

package/src/tasks/init/index.js

@@ -111,6 +111,10 @@ export default async options => {
       options.targetDirectory,
       'node_modules/@pega/custom-dx-components'
     );
+    options.componentLibraryUtilsDirectory = path.join(
+      options.targetDirectory,
+      'node_modules/@pega/constellation-dx-components-build-utils'
+    );
   });
 
   const installDependenciesText = `Installing dependencies. This will take a couple of minutes.`;
@@ -130,15 +134,35 @@ export default async options => {
         task: () => initGit(options),
         enabled: () => options.git
       },
+      /*
       {
         title: installDependenciesText,
         task: () =>
           execPromise('npm i --force --production=false', { cwd: options.targetDirectory })
       },
+      */
+      {
+        title: installDependenciesText,
+        task: () =>
+          execPromise('npm i --force --dev', { cwd: options.targetDirectory })
+      },
+      /*
       {
         title: 'Installing tasks dependencies',
         task: () =>
           execPromise('npm i --force --production=false', { cwd: options.componentDirectory })
+      },
+      {
+        title: 'Installing tasks library dependencies',
+        task: () =>
+          execPromise('npm i --force --production=false', {
+            cwd: options.componentLibraryUtilsDirectory
+          })
+      },
+      */
+      {
+        title: 'Updating',
+        task: () => execPromise('npm update --dev', { cwd: options.targetDirectory })
       }
       /* {
         title: 'Installing quick run',

package/src/tasks/init/template/.storybook/preview.tsx

@@ -0,0 +1,47 @@
+import type { Preview } from '@storybook/react';
+import {
+  Configuration,
+  LiveLog,
+  ModalManager,
+  PopoverManager,
+  ShortcutManager,
+  Toaster
+} from '@pega/cosmos-react-core';
+
+const preview: Preview = {
+  parameters: {
+    actions: { argTypesRegex: '^on[A-Z].*' },
+    controls: {
+      matchers: {
+        color: /(background|color)$/i,
+        date: /Date$/i
+      }
+    },
+    docs: {
+      source: { type: 'code' }
+    }
+  },
+
+  decorators: [
+    // Sets up contexts
+    (Story, context) => {
+      return (
+        <Configuration disableDefaultFontLoading id='Preview'>
+          <ShortcutManager>
+            <LiveLog maxLength={context.args.liveLogMaxLength || 50}>
+              <PopoverManager>
+                <Toaster dismissAfter={5000}>
+                  <ModalManager>
+                    <Story {...context} />
+                  </ModalManager>
+                </Toaster>
+              </PopoverManager>
+            </LiveLog>
+          </ShortcutManager>
+        </Configuration>
+      );
+    }
+  ]
+};
+
+export default preview;

package/src/tasks/init/template/README.md

@@ -8,7 +8,7 @@ This project provides you with an environment to extend Constellation by giving
 
 Ensure you have access to the following in your system:
 
-- Pega Infinity Server version 23 or later
+- Pega Infinity Server version 24.2 or later
 
 - Git version 2.30 or later
 
@@ -16,6 +16,8 @@ Ensure you have access to the following in your system:
 
 - System npm version 8, 10 (9 is not supported)
 
+- Recommended (node 20, npm 10)
+
 ## Latest Documentation
 
-Find the latest documentation on using **DX Component Builder** [here](https://docs.pega.com/bundle/constellation-dx-components/page/constellation-dx-components/custom-components/whats-new-constellation-dx-components-pega-infinity-23.html)
+Find the latest documentation on using **DX Component Builder** [here](https://docs.pega.com/bundle/constellation-dx-components/page/constellation-dx-components/custom-components/whats-new-constellation-dx-component-builder.html)