@pega/custom-dx-components 24.1.12 → 24.2.11

package/src/tasks/build-comp/helper.js

@@ -2,17 +2,31 @@ import fs from 'fs';
 import path from 'path';
 
 import fetch from 'node-fetch';
-import AdmZip from 'adm-zip';
+import archiver from 'archiver';
 import chalk from 'chalk';
 
-import { constructCompleteUrl, getComponentDirectoryPath, getComponents, getPegaServerConfig, getHttpsAgent } from '../../util.js';
+import {
+  constructCompleteUrl,
+  getComponentDirectoryPath,
+  getComponents,
+  getPegaServerConfig,
+  getHttpsAgent,
+  getLibraryBased
+} from '../../util.js';
 import { PUBLISH_COMPONENT_SERVICE_REST_ENDPOINT, TOKEN_PATH } from '../../constants.js';
 
+
+
 export const getPublishComponentQuestions = async componentKey => {
+  const isLibraryBased = getLibraryBased();
+  // validate and validateAll will be called when libraryBased, but using same code
+  // so need different label
+  const buildLabel = isLibraryBased ? "validate" : "build";
+
   const components = await getComponents();
 
   if (components.length === 0) {
-    console.log(chalk.redBright('No components to build'));
+    console.log(chalk.redBright(`No components to ${buildLabel}`));
     process.exit();
   }
 
@@ -22,7 +36,7 @@ export const getPublishComponentQuestions = async componentKey => {
     {
       name: 'componentKey',
       type: 'rawlist',
-      message: 'Select component to build',
+      message: `Select component to ${buildLabel}`,
       choices: components,
       default: componentKey,
       when: () => !componentKey
@@ -38,32 +52,47 @@ export const getPublishComponentQuestions = async componentKey => {
       name: 'devBuild',
       type: 'confirm',
       message: 'Generate development build ?',
-      default: defaultPegaConfig.devBuild
+      default: defaultPegaConfig.devBuild,
+      when: () => !isLibraryBased
     }
   ];
 };
 
-export const zipComponent = async (componentKey) => {
+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 localizationJson = `${srcDirectory}/localizations.json`;
 
-  const zip = new AdmZip();
+  const archive = archiver('zip', { zlib: { level: 9 } });
+  const zipChunks = [];
+  archive.on('data', chunk => zipChunks.push(chunk));
+
+  // Add src directory
+  archive.directory(srcDirectory, 'src');
 
-  zip.addLocalFolder(srcDirectory, 'src/');
-  zip.addLocalFile(configJson);
+  // Add config.json file
+  if (fs.existsSync(configJson)) {
+    archive.file(configJson, { name: path.basename(configJson) });
+  }
 
+  // Add localizations.json file if it exists
   if (fs.existsSync(localizationJson)) {
-    zip.addLocalFile(localizationJson);
+    archive.file(localizationJson, { name: path.basename(localizationJson) });
   }
 
-  zip.addLocalFolder(buildDirectory);
-  const zipContent = zip.toBuffer().toString('base64');
+  // Add build directory
+  archive.directory(buildDirectory, false);
+
+  await archive.finalize();
 
+  const zipBuffer = Buffer.concat(zipChunks);
+  console.log(chalk.green(`component zipped with size: ${Math.ceil(zipBuffer.length / 1024)} KB`));
+  const zipContent = zipBuffer.toString('base64');
+
+  const configContent = Buffer.from(fs.readFileSync(configJson)).toString();
 
-  const configContent = Buffer.from(fs.readFileSync(`${srcDirectory}/config.json`)).toString();
   if (fs.existsSync('dist/components')) {
     fs.rm('dist/components', { recursive: true }, err => {
       if (err) {
@@ -79,10 +108,11 @@ export const zipComponent = async (componentKey) => {
       }
     });
   }
+
   return { zipContent, configContent };
 };
 
-export const publishComponentToServer = async (data) => {
+export const publishComponentToServer = async data => {
   const { configContent, zipContent, rulesetName, rulesetVersion } = data;
 
   const apiBody = {
@@ -95,7 +125,10 @@ export const publishComponentToServer = async (data) => {
     category: ''
   };
   const defaultPegaConfig = await getPegaServerConfig();
-  const url = constructCompleteUrl(defaultPegaConfig.server, PUBLISH_COMPONENT_SERVICE_REST_ENDPOINT);
+  const url = constructCompleteUrl(
+    defaultPegaConfig.server,
+    PUBLISH_COMPONENT_SERVICE_REST_ENDPOINT
+  );
   try {
     const OauthData = fs.readFileSync(TOKEN_PATH, 'utf8');
     if (OauthData) {
@@ -109,14 +142,16 @@ export const publishComponentToServer = async (data) => {
         },
         body: JSON.stringify(apiBody)
       })
-        .then((response) => {
+        .then(response => {
           status = response.status;
           return response.text();
         })
-        .then((resp) => {
+        .then(resp => {
           const respData = JSON.parse(resp);
           if (status === 401) {
-            throw new Error('Error occurred in authentication. Please regenerate using authenticate');
+            throw new Error(
+              'Error occurred in authentication. Please regenerate using authenticate'
+            );
             // console.log(accessTokenUri, refreshToken);
             /* TODO - Handle refresh_token */
           } else if (status === 200) {
@@ -126,7 +161,7 @@ export const publishComponentToServer = async (data) => {
           }
         })
         // eslint-disable-next-line prefer-promise-reject-errors
-        .catch((e) => Promise.reject(`${chalk.bold.red(e)}`));
+        .catch(e => Promise.reject(`${chalk.bold.red(e)}`));
     } else {
       throw new Error(`Error occurred in authentication. Please regenerate using authenticate`);
     }

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

@@ -7,15 +7,28 @@ import validate from '../validator/index.js';
 import bundleComponent from '../bundle/index.js';
 import lintComponent from '../linter/index.js';
 import { getPublishComponentQuestions } from './helper.js';
-import { getComponentDirectoryPath, showVersion } from '../../util.js';
+import {
+  getComponentDirectoryPath,
+  showVersion,
+  addDebugLog,
+  cleanUp,
+  getLibraryBased,
+  checkLibraryAndArchives,
+  getConfigDefaults,
+  zipVersionAndArchive } from '../../util.js';
+
 
 export default async options => {
-  showVersion();
+  await showVersion();
+  await checkLibraryAndArchives();
+
+addDebugLog("buildComponent", "", "+");
 
   let componentKey;
   let sourceMap;
   let devBuild;
   let content;
+  let showStats = true;
 
   if (options.params.length >= 6) {
     componentKey = options.params[3];
@@ -29,6 +42,7 @@ export default async options => {
     content = { componentKey, sourceMap, devBuild};
   }
   else {
+
     // VS Code pluggin would send in the component
     let paramComponentKey;
     if (options.params.length == 4) {
@@ -39,6 +53,13 @@ export default async options => {
     const answers = await inquirer.prompt(questions);
     ({ componentKey = paramComponentKey, sourceMap, devBuild } = answers);
 
+    const isLibraryBased =  getLibraryBased();
+
+    if (isLibraryBased) {
+      devBuild = false;
+      showStats = false;
+    }
+
     content = {
       ...answers
     };
@@ -66,7 +87,7 @@ export default async options => {
       {
         title: `Bundle Component ${sDevBuild}`,
         type: 'confirm',
-        task: async () => await bundleComponent(componentKey, sourceMap, devBuild),
+        task: async () => await bundleComponent(componentKey, sourceMap, devBuild, showStats),
         skip: () => (options.skipBundle ? 'Skipped bundling component' : undefined)
       }
     ],
@@ -79,5 +100,14 @@ export default async options => {
     console.log(chalk.bold.red(err.toString()));
     process.exit(1);
   });
+
+  const confDef = getConfigDefaults();
+  await zipVersionAndArchive(confDef.currentOrgLib, confDef.buildVersion);
+
+  // remove dist/lib stuff
+  await cleanUp();
+
+addDebugLog("buildComponent", "END", "-");
+
   return true;
 };

package/src/tasks/build-jest-assets/index.js

@@ -5,16 +5,19 @@ import inquirer from 'inquirer';
 import { Listr } from 'listr2';
 import chalk from 'chalk';
 
-import { showVersion, getServerType, setServerType, getSubComponents, deleteLocalComponent, checkPathAccess, getComponents } from '../../util.js';
+import { showVersion, getServerType, setServerType, getSubComponents, deleteLocalComponent, checkPathAccess, getComponents, getLibraryBased, setLibraryBased, forceDefaultsUpdate } from '../../util.js';
 import createAll from '../create-all/index.js';
 import create from '../create/index.js';
+import createLib from '../create-lib/index.js';
+import deleteLib from '../delete-lib/index.js';
 
-import { JEST_ASSETS_PATH, JEST_CREATE_PATH, JEST_CREATE_ALL_CONSTELLATION_PATH, JEST_CREATE_ALL_LAUNCHPAD_PATH, TASKS_CONFIG_JSON_FILENAME, COMPONENTS_DIRECTORY_PATH } from '../../constants.js';
+import { JEST_ASSETS_ORIGINAL_PATH, JEST_ASSETS_LIBRARY_PATH, JEST_CREATE_PATH, JEST_CREATE_ALL_CONSTELLATION_PATH, JEST_CREATE_ALL_LAUNCHPAD_PATH, TASKS_CONFIG_JSON_FILENAME, COMPONENTS_DIRECTORY_PATH } from '../../constants.js';
 
 
 const getBuildAssetsQuestions = async ()  => {
-  const message = "\n**IMPORTANT** Building Jest Assets will remove any local components in your components directory!\n";
-  console.log(`${chalk.green.bold(message)}`);
+  const message = "\n**IMPORTANT** Building Jest Assets will remove any local components in your /src/components directory\n\t      and will also delete ALL local archives in your /store and is not reversable!!\n";
+
+  console.log(`${chalk.yellow.bold(message)}`);
 
   return [
     {
@@ -90,9 +93,11 @@ const deleteAssets = async() => {
         throw new Error(`No such file ${componentToDelete}`);
     }
   }
+
+  // delete the store
 }
 
-const createJestAssets = async(isLaunchPad = false) => {
+const createJestOriginalAssets = async(isLaunchPad = false) => {
 
   // initially delete local assets
   await deleteAssets();
@@ -108,7 +113,7 @@ const createJestAssets = async(isLaunchPad = false) => {
 
   // goto Constellation
   // get current test assets and delete them
-  let createAllPath = path.join(path.resolve(), JEST_ASSETS_PATH, jestCreateAllPath);
+  let createAllPath = path.join(path.resolve(), JEST_ASSETS_ORIGINAL_PATH, jestCreateAllPath);
   const fileList = await getSubComponents(createAllPath, '');
 
   for (const index in fileList) {
@@ -127,7 +132,7 @@ const createJestAssets = async(isLaunchPad = false) => {
 
   await create(myOptions);
 
-  let createPath = path.join(path.resolve(), JEST_ASSETS_PATH, JEST_CREATE_PATH);
+  let createPath = path.join(path.resolve(), JEST_ASSETS_ORIGINAL_PATH, JEST_CREATE_PATH);
   const myFileList = await getSubComponents(createPath, '');
 
   for (const index in myFileList) {
@@ -141,9 +146,72 @@ const createJestAssets = async(isLaunchPad = false) => {
   await deleteAssets();
 }
 
+const createJestLibraryAssets = async(isLaunchPad = false) => {
+
+  // initially delete local assets
+  await deleteAssets();
+
+  let args  = ['', '', '', 'DXIL', '0.0.1', 'N'];
+  let myOptions = {};
+  myOptions["params"] = args;
+
+  await createLib(myOptions);
+
+  // const framework = await getFramework();
+  args  = [ '', '', '', 'My', '0.0.1', 'DXIL', '', 'Pega'];
+  myOptions = {};
+  myOptions["params"] = args;
+
+  await createAll(myOptions);
+
+  const jestCreateAllPath = isLaunchPad ? JEST_CREATE_ALL_LAUNCHPAD_PATH : JEST_CREATE_ALL_CONSTELLATION_PATH;
+
+  // goto Constellation
+  // get current test assets and delete them
+  let createAllPath = path.join(path.resolve(), JEST_ASSETS_LIBRARY_PATH, jestCreateAllPath);
+  const fileList = await getSubComponents(createAllPath, '');
+
+  for (const index in fileList) {
+    const componentToDelete = fileList[index];
+    // console.log(chalk.bold.green("Deleting: " + componentToDelete));
+    // eslint-disable-next-line no-await-in-loop
+    await deleteTestComponent(createAllPath, componentToDelete);
+  }
+
+  await copyAssets(createAllPath);
+  await deleteAssets();
+
+  args  = [ '','', '', 'Field', 'Text', 'MyTestText', 'My Test Text', '0.0.1','DXIL', '', 'My Test Text Description', 'Pega'];
+  myOptions = {};
+  myOptions["params"] = args;
+
+  await create(myOptions);
+
+  let createPath = path.join(path.resolve(), JEST_ASSETS_LIBRARY_PATH, JEST_CREATE_PATH);
+  const myFileList = await getSubComponents(createPath, '');
+
+  for (const index in myFileList) {
+    const componentToDelete = myFileList[index];
+    // console.log(chalk.bold.green("Deleting: " + componentToDelete));
+    // eslint-disable-next-line no-await-in-loop
+    await deleteTestComponent(createPath, componentToDelete);
+  }
+
+  await copyAssets(createPath);
+  await deleteAssets();
+
+  args  = [ '','', '', 'Pega_DXIL', '0.0.1-dev'];
+  myOptions = {};
+  myOptions["params"] = args;
+
+  await deleteLib(myOptions);
+
+
+}
+
 
 export default async options => {
-  showVersion();
+  await showVersion();
 
   const questions = await getBuildAssetsQuestions();
   const answers = await inquirer.prompt(questions);
@@ -152,18 +220,34 @@ export default async options => {
   if (buildAssets) {
     // get current server type
     const savedServerType = await getServerType();
+    const savedLibraryBased = getLibraryBased();
+
+    await setLibraryBased(false);
 
     // Constellation
     await setServerType("infinity");
-    await createJestAssets(false);
+    await createJestOriginalAssets(false);
 
     //Launchpad
     await setServerType("launchpad");
-    await createJestAssets(true);
+    await createJestOriginalAssets(true);
+
+    // Constellation Library
+    await setLibraryBased(true);
+    await setServerType("infinity");
+
+    await createJestLibraryAssets(false);
+
+    //Launchpad
+    // await setServerType("launchpad");
+    // await createJestLibraryAssets(true);
+
 
 
     // restore serverType
     await setServerType(savedServerType);
+    await setLibraryBased(savedLibraryBased);
+
   }
 
 

package/src/tasks/build-lib/helper.js

@@ -0,0 +1,46 @@
+import fs from 'fs';
+import path from 'path';
+import chalk from 'chalk';
+
+import {
+  getComponents,
+  getPegaServerConfig,
+  validateSemver,
+  addDebugLog,
+  getLibraryBased
+} from '../../util.js';
+
+
+export const getBuildComponentQuestions = async (defaultVersion)  => {
+addDebugLog("getBuildComoponentQuestions", `defaultVerion: ${defaultVersion}`, "");
+  const components = await getComponents();
+  const defaultPegaConfig = await getPegaServerConfig();
+
+  const isLibraryBased =  getLibraryBased();
+
+
+  if (components.length == 0) {
+    console.log(chalk.redBright("No components to build"));
+    process.exit(1);
+  }
+
+  return [
+    {
+      name: 'version',
+      message: 'Enter library version',
+      default: defaultVersion,
+      validate: (value) => {
+        if (validateSemver(value)) {
+          return true;
+        }
+        return 'Please provide semver compatible version e.g 0.0.1';
+      }
+    },
+    {
+      name: 'devBuild',
+      type: 'confirm',
+      message: 'When publish, make deletable ?',
+      default: defaultPegaConfig.devBuild
+    }
+  ];
+};

package/src/tasks/build-lib/index.js

@@ -0,0 +1,177 @@
+
+import inquirer from 'inquirer';
+import { Listr } from 'listr2';
+import chalk from 'chalk';
+
+import { buildLib } from '@pega/constellation-dx-components-build-utils/index.js';
+
+import validate from '../validator/index.js';
+import { lintComponent } from '../linter/index.js';
+import {
+  getComponentDirectoryPath,
+  showVersion,
+  getComponents,
+  getC11NB2STokenAndStaticServer,
+  updateComponentDefaultVersion,
+  updateConfigVersion,
+  addDebugLog,
+  cleanUp,
+  checkLibraryAndArchives,
+  getConfigDevBuild,
+  checkJWTExpiration,
+  getConfigDefaults,
+  getLibraryBased
+} from '../../util.js';
+import bundleComponent from '../bundle/index.js';
+
+import { getBuildComponentQuestions } from './helper.js';
+
+export function getCustomTasks(componentKey, devBuild, buildVersion, currentOrgLib, token) {
+addDebugLog("getCustomTasks", `componentKey: ${componentKey}, devBuild: ${devBuild}, buildVersion: ${buildVersion}, currentOrgLib: ${currentOrgLib}`,"");
+  return new Listr(
+    [
+      {
+        title: 'Validate config schema',
+        task: async () => {
+          await updateConfigVersion(componentKey, buildVersion, currentOrgLib, token);
+          await validate(componentKey);
+        },
+        skip: () => componentKey === 'shared'
+      },
+      {
+        title: 'Lint component',
+        task: async () => {
+          const targetDirectory = await getComponentDirectoryPath(componentKey);
+          // console.log(`in buildComponent Lint component task: componentKey: ${componentKey} targetDirectory: ${targetDirectory}`);
+          await lintComponent(targetDirectory);
+        }
+      }
+    ],
+    { concurrent: false, exitOnError: true }
+  );
+}
+
+export const localBuildLibrary = async(organization, library, version, devBuild) => {
+addDebugLog("localBuildLibrary", `organization: ${organization}, library: ${library}, version: ${version}, devBuild: ${devBuild}`, "");
+  const components = await getComponents();
+  const tokenAndStaticServer = await getC11NB2STokenAndStaticServer();
+  const currentOrgLib = organization.concat('_').concat(library);
+
+  if (tokenAndStaticServer.C11NB2S === undefined) {
+    console.log(
+      chalk.redBright(
+        'Need to authenticate, missing services token.\nBuilding a library requires authentication to acquire a token to build.'
+      )
+    );
+    process.exit(1);
+  }
+
+  if (!components || components.length === 0) {
+    console.log(
+      chalk.redBright(
+        'No components to build/publish.'
+      )
+    );
+    process.exit(1);
+  }
+
+  const buildLibName = organization.concat('_').concat(library);
+
+  await updateComponentDefaultVersion(version);
+
+  const buildVersion = devBuild && version.indexOf('-dev') < 0 ? version.concat('-dev') : version;
+
+
+
+  for await (const componentKey of components) {
+    console.log(chalk.bold.green(`Building ${componentKey}`));
+
+    // eslint-disable-next-line sonarjs/no-extra-arguments
+    const myCustomTasks = getCustomTasks(componentKey, devBuild, buildVersion, currentOrgLib, tokenAndStaticServer.C11NB2S);
+
+    try {
+      await myCustomTasks.run();
+    } catch (err) {
+      console.log(chalk.bold.red(err.toString()));
+      process.exit(1);
+    }
+    console.log(''); // line break
+  }
+
+  // bundling the first component will actually compile all.  We should
+  // compile to see if any errors, as buildLib doesn't catch all errors.
+  // Turning off stats (last param), so won't show warnings, as
+  // warnings are part of buildLib
+  console.log(chalk.green.bold('Compile check...'));
+  await bundleComponent(components[0], null, devBuild, false);
+  console.log('');
+
+  // remove dist/lib stuff
+  await cleanUp();
+
+  console.log(chalk.green.bold('Building Library... '));
+
+  // call constellation-dx-components-build-utils build library, which will create a directory of the "buildLibName"
+  // with subdirectories for each version.
+  // If "buildDev", we append to version "-dev".  Currently, only "-dev" versions, when published, can be deleted.
+addDebugLog("buildLib", "services call", "");
+  buildLib(
+    buildLibName,
+    buildVersion,
+    tokenAndStaticServer.C11NB2S,
+    tokenAndStaticServer.appStaticContentServer
+  );
+addDebugLog("buildLib", "services end", "");
+
+}
+
+export default async options => {
+  const isLibraryBased = getLibraryBased();
+  if (!isLibraryBased) {
+    console.log(`Command only supported for ${chalk.bold.green('library based')} components.`)
+    process.exit();
+  }
+
+  if (options.params.length != 4) {
+    // internal so already called
+    await showVersion();
+    await checkLibraryAndArchives();
+    await checkJWTExpiration();
+  }
+
+addDebugLog("buildLibrary", "", "+");
+
+  const compDef =  getConfigDefaults();
+  const organization = compDef.organization;
+  const library = compDef.library;
+  // const currentOrgLib = organization.concat('_').concat(library);
+  const currentOrgLib = compDef.currentOrgLib;
+
+  let version;
+  let devBuild;
+
+  if (options.params.length >= 5) {
+    version = options.params[3];
+    const dBuild = options.params[4];
+    devBuild = !!(dBuild === 'Y' || dBuild === 'y' || dBuild === true || dBuild === 'true');
+  }
+  else if (options.params.length === 4) {
+    // internally called from publish
+    const orgLib =  getConfigDefaults();
+    version = orgLib.version;
+    devBuild = await getConfigDevBuild();
+  }
+  else {
+    console.log(`\nLibrary ${chalk.bold.green(currentOrgLib)} `);
+    const questions = await getBuildComponentQuestions(compDef.version);
+    const answers = await inquirer.prompt(questions);
+    ({ version, devBuild } = answers);
+  }
+
+
+  await localBuildLibrary(organization, library, version, devBuild);
+
+addDebugLog("buildLibrary", "END", "-");
+
+  return true;
+};