@pega/dx-component-builder-sdk 0.1.18 → 0.1.20

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pega/dx-component-builder-sdk",
-  "version": "0.1.18",
+  "version": "0.1.20",
   "description": "Utility for building custom UI components",
   "bin": "./bin/index.js",
   "scripts": {

package/src/constants.js

@@ -1,7 +1,10 @@
 // cSpell:ignore words timeofday caseview casepreview objectview
-export const DXCB_CONFIG_JSON_FILENAME = 'dxcb.config.json';
+export const SDK_CONFIG_JSON_FILENAME = 'sdk-config.json';
 export const BUILD_CONFIG_JSON_FILENAME = 'build.config.json';
 export const SDK_LOCAL_COMPONENT_MAP_FILENAME = "sdk-local-component-map.js";
+export const DXCB_CONFIG = 'dxcbConfig';
+export const DXCB_PUBLISH_ACCESS = 'publishAccess';
+export const DXCB_COMPONENT_DEFAULTS = 'componentDefaults';
 export const COMPONENTS_DIRECTORY_PATH = 'components-directory-path';
 export const TOKEN_PATH = '../.access_token';
 export const OOTB_COMPONENTS = '../.ootb_components';
@@ -16,6 +19,10 @@ export const COMPONENT_PREFIX_WIDGET_PATH = "widget/";
 export const COMPONENT_PREFIX_DSE_PATH = "designSystemExtension/";
 export const COMPONENT_PREFIX_INFRA_PATH = "infra/";
 
+export const CUSTOM_TEMPLATE_PATH = 'customTemplatesPath';
+export const OVERRIDE_TEMPLATE_PATH = 'overrideTemplatesPath';
+export const OVERRIDE_LIB_PATH = 'node_modules/@pega/react-sdk-overrides/lib';
+
 export const COMPONENT_DIRECTORY_PREFIX_CUSTOM = "/custom-";
 
 export const CATEGORY_CUSTOM = "custom";

package/src/tasks/authenticate/index.js

@@ -7,13 +7,12 @@ import inquirer from 'inquirer';
 import fetch from 'node-fetch';
 
 import { checkPathAccess, getTokenUrl, showVersion } from '../../util.js';
-import { TOKEN_PATH } from '../../constants.js';
+import { TOKEN_PATH, SDK_CONFIG_JSON_FILENAME, DXCB_CONFIG, DXCB_PUBLISH_ACCESS } from '../../constants.js';
 
 import { getAuthQuestions } from './helper.js';
 
-export const DXCB_CONFIG_JSON_FILENAME = 'dxcb.config.json';
 
-const pegaConfigJsonPath = path.join(path.resolve(), DXCB_CONFIG_JSON_FILENAME);
+const pegaConfigJsonPath = path.join(path.resolve(), SDK_CONFIG_JSON_FILENAME);
 
 const generateAccessToken = async config => {
   const formData = new URLSearchParams();
@@ -64,7 +63,14 @@ export default async options => {
   let data = fs.readFileSync(pegaConfigJsonPath, { encoding: 'utf8' });
   data = data && JSON.parse(data);
 
-  const serverConfig = data['server-config'];
+  if (!data[DXCB_CONFIG] || !data[DXCB_CONFIG][DXCB_PUBLISH_ACCESS]) {
+    console.error(
+      `${chalk.red.bold('ERROR')} Could not able find publish access path in config.json`
+    );
+    process.exit(1);
+  }
+
+  const serverConfig = data[DXCB_CONFIG][DXCB_PUBLISH_ACCESS];
   const params = options.params;
 
   const questions = await getAuthQuestions(params);

package/src/tasks/create/index.js

@@ -9,13 +9,18 @@ import ncp from 'ncp';
 import chalk from 'chalk';
 
 import { checkPathAccess, getTokenUrl, showVersion } from '../../util.js';
-import { CATEGORY_CONSTELLATION } from '../../constants.js';
+import { CATEGORY_CONSTELLATION, 
+  SDK_CONFIG_JSON_FILENAME,
+  DXCB_CONFIG, 
+  DXCB_COMPONENT_DEFAULTS,
+  CUSTOM_TEMPLATE_PATH,
+  OVERRIDE_TEMPLATE_PATH } from '../../constants.js';
+
 
 
-export const DXCB_CONFIG_JSON_FILENAME = 'dxcb.config.json';
 export const DXCB_CONFIG_INTERNAL_JSON_FILENAME = 'src/dxcb.config.json';
 
-const pegaConfigJsonPath = path.join(path.resolve(), DXCB_CONFIG_JSON_FILENAME);
+const pegaConfigJsonPath = path.join(path.resolve(), SDK_CONFIG_JSON_FILENAME);
 const pegaConfigInternalJsonPath = path.join(path.resolve(), DXCB_CONFIG_INTERNAL_JSON_FILENAME);
 
 import {
@@ -152,6 +157,8 @@ export const validateCompile = async (
     sSubType = subtype.join("-");
   }
 
+  const typeLC = type.toLowerCase();
+
   await checkPathAccess(pegaConfigInternalJsonPath);
 
   let internalData = fs.readFileSync(pegaConfigInternalJsonPath, { encoding: 'utf8' });
@@ -161,19 +168,21 @@ export const validateCompile = async (
 
   let pegaConfig = await getPegaConfig();
   let templateParentDir = `./templates/${framework}`;
-  if (pegaConfig['custom-templates-path'] && pegaConfig['custom-templates-path'] != "") {
-    templateParentDir = pegaConfig['custom-templates-path'];
+  if (pegaConfig[DXCB_CONFIG] &&
+      pegaConfig[DXCB_CONFIG][CUSTOM_TEMPLATE_PATH] && 
+      pegaConfig[DXCB_CONFIG][CUSTOM_TEMPLATE_PATH] != "") {
+    templateParentDir = pegaConfig[DXCB_CONFIG][CUSTOM_TEMPLATE_PATH];
   }
 
-  const templateDir = `${templateParentDir}/${type}/${sSubType}`;
+  const templateDir = `${templateParentDir}/${typeLC}/${sSubType}`;
   const templateDirectory = fileURLToPath(new URL(templateDir, import.meta.url));
 
-  const templateDirConstellation = `./templates/Constellation/${type}/${sSubType}`;
+  const templateDirConstellation = `./templates/Constellation/${typeLC}/${sSubType}`;
   const templateDirectoryConstellation = fileURLToPath(new URL(templateDirConstellation, import.meta.url));
 
   const componentKey = `${organization}_${library}_${componentName}`;
 
-  const typeLC = type.toLowerCase();
+ 
   const targetDirectory = await getComponentDirectoryPath(join(typeLC, "/",componentKey));
   const targetDirectoryConstellation = await getComponentDirectoryPath(join(typeLC, "/",componentKey), CATEGORY_CONSTELLATION);
 
@@ -288,7 +297,14 @@ export default async options => {
     let data = fs.readFileSync(pegaConfigJsonPath, { encoding: 'utf8' });
     data = data && JSON.parse(data);
 
-    const componentData = data['component'];
+    if (!data[DXCB_CONFIG] || !data[DXCB_CONFIG][DXCB_COMPONENT_DEFAULTS]) {
+      console.error(
+        `${chalk.red.bold('ERROR')} Could not able find component defaults in config.json`
+      );
+      process.exit(1);
+    }
+
+    const componentData = data[DXCB_CONFIG][DXCB_COMPONENT_DEFAULTS];
 
     const { organization, library} = componentData;
 

package/src/tasks/map/map.js

@@ -10,10 +10,11 @@ import {
 
 import {
   COMPONENTS_DIRECTORY_PATH,
-  DXCB_CONFIG_JSON_FILENAME,
+  SDK_CONFIG_JSON_FILENAME,
   CATEGORY_CUSTOM,
   CATEGORY_CONSTELLATION,
-  COMPONENT_DIRECTORY_PREFIX_CUSTOM
+  COMPONENT_DIRECTORY_PREFIX_CUSTOM,
+  DXCB_CONFIG
 } from '../../constants.js';
 
 export const SDK_LOCAL_COMPONENT_MAP_FILENAME = "sdk-local-component-map.js";
@@ -22,7 +23,7 @@ export const MAP_END_TAG = "/*map end";
 
 export const updateComponentMap = async (componentKey, category = CATEGORY_CUSTOM) => {
 
-  const pegaConfigJsonPath = path.join(path.resolve(), DXCB_CONFIG_JSON_FILENAME);
+  const pegaConfigJsonPath = path.join(path.resolve(), SDK_CONFIG_JSON_FILENAME);
   const pegaLocalComponentMapPath = path.join(path.resolve(), SDK_LOCAL_COMPONENT_MAP_FILENAME);
   const categoryDirectory = (category === CATEGORY_CONSTELLATION) ? join("/", COMPONENT_DIRECTORY_PREFIX_CUSTOM + category.toLowerCase()) : join("/", category.toLowerCase());
 
@@ -34,14 +35,14 @@ export const updateComponentMap = async (componentKey, category = CATEGORY_CUSTO
   let data = fs.readFileSync(pegaConfigJsonPath, { encoding: 'utf8' });
   data = JSON.parse(data);
 
-  if (!data[COMPONENTS_DIRECTORY_PATH]) {
+  if (!data[DXCB_CONFIG] || !data[DXCB_CONFIG][COMPONENTS_DIRECTORY_PATH]) {
     console.error(
       `${chalk.red.bold('ERROR')} Could not able find components directory path in config.json`
     );
     process.exit(1);
   }
 
-  let importComponent = join(data[COMPONENTS_DIRECTORY_PATH], categoryDirectory, componentKey);
+  let importComponent = join(data[DXCB_CONFIG][COMPONENTS_DIRECTORY_PATH], categoryDirectory, componentKey);
   importComponent = "./".concat(importComponent);
 
   let importFull = "import ".concat(componentName).concat(" from '").concat(importComponent).concat("/';");
@@ -75,7 +76,7 @@ export const updateComponentMap = async (componentKey, category = CATEGORY_CUSTO
 export const deleteFromComponentMap = async (componentKey, category = CATEGORY_CUSTOM) =>  {
   const pegaLocalComponentMapPath = path.join(path.resolve(), SDK_LOCAL_COMPONENT_MAP_FILENAME);
   const categoryDirectory = (category === CATEGORY_CONSTELLATION) ? join("/", COMPONENT_DIRECTORY_PREFIX_CUSTOM + category.toLowerCase()) : join("/", category.toLowerCase());
-  const pegaConfigJsonPath = path.join(path.resolve(), DXCB_CONFIG_JSON_FILENAME);
+  const pegaConfigJsonPath = path.join(path.resolve(), SDK_CONFIG_JSON_FILENAME);
 
   const componentNameNoPrefix = removeComponentPrefix(componentKey);
   const componentName = convertIntoPascalCase(componentNameNoPrefix);
@@ -85,14 +86,14 @@ export const deleteFromComponentMap = async (componentKey, category = CATEGORY_C
   let data = fs.readFileSync(pegaConfigJsonPath, { encoding: 'utf8' });
   data = JSON.parse(data);
 
-  if (!data[COMPONENTS_DIRECTORY_PATH]) {
+  if (!data[DXCB_CONFIG] || !data[DXCB_CONFIG][COMPONENTS_DIRECTORY_PATH]) {
     console.error(
       `${chalk.red.bold('ERROR')} Could not able find components directory path in config.json`
     );
     process.exit(1);
   }
 
-  let importComponent = join(data[COMPONENTS_DIRECTORY_PATH], categoryDirectory, componentKey);
+  let importComponent = join(data[DXCB_CONFIG][COMPONENTS_DIRECTORY_PATH], categoryDirectory, componentKey);
   importComponent = "./".concat(importComponent);
 
   let importFull = "import ".concat(componentName).concat(" from '").concat(importComponent).concat("/';");

package/src/tasks/override/index.js

@@ -19,16 +19,16 @@ import {
   getComponentDefaults,
   sanitize,
   validateSemver
-} from '@pega/dx-component-builder-sdk/src/util.js';
-import { COMPONENT_SCHEMA, CATEGORY_OVERRIDE } from '../../constants.js';
-
-export const DXCB_CONFIG_JSON_FILENAME = 'dxcb.config.json';
-export const DXCB_CONFIG_INTERNAL_JSON_FILENAME = 'src/dxcb.config.json';
-
-const pegaConfigJsonPath = path.join(path.resolve(), DXCB_CONFIG_JSON_FILENAME);
-const pegaConfigInternalJsonPath = path.join(path.resolve(), DXCB_CONFIG_INTERNAL_JSON_FILENAME);
-
+} from '../../util.js';
+import { COMPONENT_SCHEMA, 
+  CATEGORY_OVERRIDE, 
+  SDK_CONFIG_JSON_FILENAME, 
+  DXCB_CONFIG, 
+  DXCB_COMPONENT_DEFAULTS,
+  OVERRIDE_TEMPLATE_PATH,
+  OVERRIDE_LIB_PATH } from '../../constants.js';
 
+const pegaConfigJsonPath = path.join(path.resolve(), SDK_CONFIG_JSON_FILENAME);
 
 const copy = promisify(ncp);
 
@@ -112,11 +112,16 @@ const validateCompile = async (
 
   let pegaConfig =
   await getPegaConfig();
-  let templateParentDir = "node_modules/@pega/react-sdk-overrides/lib";
-  if (pegaConfig['override-templates-path'] && pegaConfig['override-templates-path'] != "") {
-    templateParentDir = pegaConfig['override-templates-path'];
+  let templateParentDir = OVERRIDE_LIB_PATH;
+
+  if (pegaConfig[DXCB_CONFIG] &&
+    pegaConfig[DXCB_CONFIG][OVERRIDE_TEMPLATE_PATH] && 
+    pegaConfig[DXCB_CONFIG][OVERRIDE_TEMPLATE_PATH] != "") {
+    templateParentDir = pegaConfig[DXCB_CONFIG][OVERRIDE_TEMPLATE_PATH];
   }
 
+
+
   // componentName has sub directory if components are in a sub directory of main "type"
   const overrideDirectory = `${templateParentDir}/${type}/${componentName}`;
 
@@ -190,7 +195,14 @@ export default async options => {
   let data = fs.readFileSync(pegaConfigJsonPath, { encoding: 'utf8' });
   data = data && JSON.parse(data);
 
-  const componentData = data['component'];
+  if (!data[DXCB_CONFIG] || !data[DXCB_CONFIG][DXCB_COMPONENT_DEFAULTS]) {
+    console.error(
+      `${chalk.red.bold('ERROR')} Could not able find components defaults path in config.json`
+    );
+    process.exit(1);
+  }
+
+  const componentData = data[DXCB_CONFIG][DXCB_COMPONENT_DEFAULTS];
 
   const { organization, library} = componentData;
 

package/src/util.js

@@ -13,7 +13,9 @@ import fetch from 'node-fetch';
 
 import {
   COMPONENTS_DIRECTORY_PATH,
-  DXCB_CONFIG_JSON_FILENAME,
+  SDK_CONFIG_JSON_FILENAME,
+  DXCB_CONFIG,
+  DXCB_PUBLISH_ACCESS,
   TOKEN_PATH,
   OOTB_COMPONENT_SERVICE_REST_ENDPOINT,
   DELETE_COMPONENT_SERVICE_REST_ENDPOINT,
@@ -32,7 +34,8 @@ import {
   CATEGORY_CUSTOM,
   CATEGORY_OVERRIDE,
   CATEGORY_CONSTELLATION,
-  COMPONENT_DIRECTORY_PREFIX_CUSTOM
+  COMPONENT_DIRECTORY_PREFIX_CUSTOM,
+  DXCB_COMPONENT_DEFAULTS
 } from './constants.js';
 
 
@@ -54,7 +57,7 @@ export const checkPathAccess = async (path, options = {}) => {
 
 export const deleteLocalComponent = async (componentKey, category = CATEGORY_CUSTOM) => {
   const currentDirectory = process.cwd();
-  const pegaConfigJsonPath = join(currentDirectory, DXCB_CONFIG_JSON_FILENAME);
+  const pegaConfigJsonPath = join(currentDirectory, SDK_CONFIG_JSON_FILENAME);
   const categoryDirectory = (category === CATEGORY_CONSTELLATION) ? join("/", COMPONENT_DIRECTORY_PREFIX_CUSTOM + category.toLowerCase()) : join("/", category.toLowerCase());
 
   await checkPathAccess(pegaConfigJsonPath);
@@ -62,14 +65,14 @@ export const deleteLocalComponent = async (componentKey, category = CATEGORY_CUS
   let data = fs.readFileSync(pegaConfigJsonPath, { encoding: 'utf8' });
   data = JSON.parse(data);
 
-  if (!data[COMPONENTS_DIRECTORY_PATH]) {
+  if (!data[DXCB_CONFIG] || !data[DXCB_CONFIG][COMPONENTS_DIRECTORY_PATH]) {
     console.error(
       `${chalk.red.bold('ERROR')} Could not able find components directory path in config.json`
     );
     process.exit(1);
   }
 
-  const directory = join(currentDirectory, data[COMPONENTS_DIRECTORY_PATH], categoryDirectory, componentKey);
+  const directory = join(currentDirectory, data[DXCB_CONFIG][COMPONENTS_DIRECTORY_PATH], categoryDirectory, componentKey);
 
   // test for the directory
   if (fs.existsSync(directory)) {
@@ -166,7 +169,7 @@ export const getOptionsSource = (options) => {
 
 export const getComponents = async (showSeparator = false, category = CATEGORY_CUSTOM) => {
   const currentDirectory = process.cwd();
-  const pegaConfigJsonPath = join(currentDirectory, DXCB_CONFIG_JSON_FILENAME);
+  const pegaConfigJsonPath = join(currentDirectory, SDK_CONFIG_JSON_FILENAME);
   const categoryDirectory = (category === CATEGORY_CONSTELLATION) ? join("/", COMPONENT_DIRECTORY_PREFIX_CUSTOM + category.toLowerCase()) : join("/", category.toLowerCase());
 
   await checkPathAccess(pegaConfigJsonPath);
@@ -174,7 +177,7 @@ export const getComponents = async (showSeparator = false, category = CATEGORY_C
   let data = fs.readFileSync(pegaConfigJsonPath, { encoding: 'utf8' });
   data = JSON.parse(data);
 
-  if (!data[COMPONENTS_DIRECTORY_PATH]) {
+  if (!data[DXCB_CONFIG] || !data[DXCB_CONFIG][COMPONENTS_DIRECTORY_PATH]) {
     console.error(
       `${chalk.red.bold('ERROR')} Could not able find components directory path in config.json`
     );
@@ -182,7 +185,7 @@ export const getComponents = async (showSeparator = false, category = CATEGORY_C
   }
 
 
-  const directory = join(currentDirectory, data[COMPONENTS_DIRECTORY_PATH], categoryDirectory);
+  const directory = join(currentDirectory, data[DXCB_CONFIG][COMPONENTS_DIRECTORY_PATH], categoryDirectory);
   let compList = new Array();
 
   switch (category) {
@@ -285,7 +288,7 @@ export const createBlankConfigExt = async (directory, name) => {
 
 export const getComponentsObj = async (showSeparator = false, category = CATEGORY_CUSTOM) => {
   const currentDirectory = process.cwd();
-  const pegaConfigJsonPath = join(currentDirectory, DXCB_CONFIG_JSON_FILENAME);
+  const pegaConfigJsonPath = join(currentDirectory, SDK_CONFIG_JSON_FILENAME);
   const categoryDirectory = (category === CATEGORY_CONSTELLATION) ? join("/", COMPONENT_DIRECTORY_PREFIX_CUSTOM + category.toLowerCase()) : join("/", category.toLowerCase());
 
   await checkPathAccess(pegaConfigJsonPath);
@@ -293,14 +296,14 @@ export const getComponentsObj = async (showSeparator = false, category = CATEGOR
   let data = fs.readFileSync(pegaConfigJsonPath, { encoding: 'utf8' });
   data = JSON.parse(data);
 
-  if (!data[COMPONENTS_DIRECTORY_PATH]) {
+  if (!data[DXCB_CONFIG] || !data[DXCB_CONFIG][COMPONENTS_DIRECTORY_PATH]) {
     console.error(
       `${chalk.red.bold('ERROR')} Could not able find components directory path in config.json`
     );
     process.exit(1);
   }
 
-  const directory = join(currentDirectory, data[COMPONENTS_DIRECTORY_PATH], categoryDirectory);
+  const directory = join(currentDirectory, data[DXCB_CONFIG][COMPONENTS_DIRECTORY_PATH], categoryDirectory);
   let compList = new Array();
 
   switch (category) {
@@ -445,7 +448,7 @@ export const getSubComponentsAndDir = async (directory, type) => {
 
 export const getComponentsAndSubDirectory = async (category = CATEGORY_CUSTOM) => {
   const currentDirectory = process.cwd();
-  const pegaConfigJsonPath = join(currentDirectory, DXCB_CONFIG_JSON_FILENAME);
+  const pegaConfigJsonPath = join(currentDirectory, SDK_CONFIG_JSON_FILENAME);
   const categoryDirectory = (category === CATEGORY_CONSTELLATION) ? join("/", COMPONENT_DIRECTORY_PREFIX_CUSTOM + category.toLowerCase()) : join("/", category.toLowerCase());
 
   await checkPathAccess(pegaConfigJsonPath);
@@ -453,14 +456,14 @@ export const getComponentsAndSubDirectory = async (category = CATEGORY_CUSTOM) =
   let data = fs.readFileSync(pegaConfigJsonPath, { encoding: 'utf8' });
   data = JSON.parse(data);
 
-  if (!data[COMPONENTS_DIRECTORY_PATH]) {
+  if (!data[DXCB_CONFIG] || !data[DXCB_CONFIG][COMPONENTS_DIRECTORY_PATH]) {
     console.error(
       `${chalk.red.bold('ERROR')} Could not able find components directory path in config.json`
     );
     process.exit(1);
   }
 
-  const directory = join(currentDirectory, data[COMPONENTS_DIRECTORY_PATH], categoryDirectory);
+  const directory = join(currentDirectory, data[DXCB_CONFIG][COMPONENTS_DIRECTORY_PATH], categoryDirectory);
 
   const fieldComps = await getSubComponentsAndDir(directory, FIELD_PATH);
   const templateComps = await getSubComponentsAndDir(directory, TEMPLATE_PATH);
@@ -498,7 +501,7 @@ export const removeComponentPrefix = (componentName) => {
 
 export const getPegaConfig = async () => {
   const currentDirectory = process.cwd();
-  const pegaConfigJsonPath = join(currentDirectory, DXCB_CONFIG_JSON_FILENAME);
+  const pegaConfigJsonPath = join(currentDirectory, SDK_CONFIG_JSON_FILENAME);
 
   await checkPathAccess(pegaConfigJsonPath);
 
@@ -510,17 +513,17 @@ export const getPegaConfig = async () => {
 
 export const getPegaServerConfig = async () => {
   const config = await getPegaConfig();
-  return config['server-config'];
+  return config[DXCB_CONFIG][DXCB_PUBLISH_ACCESS];
 };
 
 export const getComponentDefaults = async () => {
   const config = await getPegaConfig();
-  return config.component;
+  return config[DXCB_CONFIG][DXCB_COMPONENT_DEFAULTS];
 };
 
 export const getComponentDirectoryPath = async (componentKey, category = CATEGORY_CUSTOM) => {
   const currentDirectory = process.cwd();
-  const pegaConfigJsonPath = join(currentDirectory, DXCB_CONFIG_JSON_FILENAME);
+  const pegaConfigJsonPath = join(currentDirectory, SDK_CONFIG_JSON_FILENAME);
   const categoryDirectory = (category === CATEGORY_CONSTELLATION) ? join("/", COMPONENT_DIRECTORY_PREFIX_CUSTOM + category.toLowerCase()) : join("/", category.toLowerCase());
 
   await checkPathAccess(pegaConfigJsonPath);
@@ -528,14 +531,14 @@ export const getComponentDirectoryPath = async (componentKey, category = CATEGOR
   let data = fs.readFileSync(pegaConfigJsonPath, { encoding: 'utf8' });
   data = JSON.parse(data);
 
-  if (!data[COMPONENTS_DIRECTORY_PATH]) {
+  if (!data[DXCB_CONFIG] || !data[DXCB_CONFIG][COMPONENTS_DIRECTORY_PATH]) {
     console.error(
       `${chalk.red.bold('ERROR')} Could not able find components directory path in config.json`
     );
     process.exit(1);
   }
 
-  return join(currentDirectory, data[COMPONENTS_DIRECTORY_PATH], categoryDirectory, componentKey);
+  return join(currentDirectory, data[DXCB_CONFIG][COMPONENTS_DIRECTORY_PATH], categoryDirectory, componentKey);
 };