@pega/dx-component-builder-sdk 0.1.19 → 0.1.21

package/package.json

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

package/src/constants.js

@@ -19,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/build-all/helper.js

@@ -1,21 +1,16 @@
 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,
   getComponentsObj,
   getPegaServerConfig,
-  validateRulesetVersion,
   getOptionsCategory,
 } from '../../util.js';
-import { PUBLISH_COMPONENT_SERVICE_REST_ENDPOINT, TOKEN_PATH, COMPONENT_SCHEMA, CATEGORY_CUSTOM } from '../../constants.js';
+import { COMPONENT_SCHEMA, CATEGORY_CUSTOM } from '../../constants.js';
 
 
 export const getBuildCategory = async (options) => {

package/src/tasks/create/index.js

@@ -8,8 +8,12 @@ import inquirer from 'inquirer';
 import ncp from 'ncp';
 import chalk from 'chalk';
 
-import { checkPathAccess, getTokenUrl, showVersion } from '../../util.js';
-import { CATEGORY_CONSTELLATION, SDK_CONFIG_JSON_FILENAME, DXCB_CONFIG, DXCB_COMPONENT_DEFAULTS } from '../../constants.js';
+import { checkPathAccess, showVersion } from '../../util.js';
+import { CATEGORY_CONSTELLATION, 
+  SDK_CONFIG_JSON_FILENAME,
+  DXCB_CONFIG, 
+  DXCB_COMPONENT_DEFAULTS,
+  CUSTOM_TEMPLATE_PATH } from '../../constants.js';
 
 
 
@@ -152,6 +156,8 @@ export const validateCompile = async (
     sSubType = subtype.join("-");
   }
 
+  const typeLC = type.toLowerCase();
+
   await checkPathAccess(pegaConfigInternalJsonPath);
 
   let internalData = fs.readFileSync(pegaConfigInternalJsonPath, { encoding: 'utf8' });
@@ -161,19 +167,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);
 

package/src/tasks/delete/helper.js

@@ -5,13 +5,10 @@ import ora from 'ora';
 
 import { LIST_COMPONENT_SERVICE_REST_ENDPOINT, COMPONENT_SCHEMA, CATEGORY_CONSTELLATION, CATEGORY_CUSTOM, CATEGORY_OVERRIDE } from '../../constants.js';
 import {
-  constructCompleteUrl,
   deleteLocalComponent,
   deleteServerComponent,
   getComponentsObj,
-  getPegaServerConfig,
-  nodeFetch,
-  getOptionsCategory
+  getPegaServerConfig
 } from '../../util.js';
 import { getComponentsFromServer } from '../list/helper.js';
 

package/src/tasks/delete/index.js

@@ -1,6 +1,4 @@
 import inquirer from 'inquirer';
-import ora from 'ora';
-import chalk from 'chalk';
 import { showVersion, getOptionsCategory } from '../../util.js';
 
 import {

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

@@ -2,16 +2,13 @@ import chalk from 'chalk';
 import inquirer from 'inquirer';
 import ora from 'ora';
 
-import { LIST_COMPONENT_SERVICE_REST_ENDPOINT, COMPONENT_SCHEMA, CATEGORY_CONSTELLATION, CATEGORY_CUSTOM, CATEGORY_OVERRIDE } from '../..//constants.js';
+import { COMPONENT_SCHEMA, CATEGORY_CONSTELLATION, CATEGORY_CUSTOM, CATEGORY_OVERRIDE } from '../..//constants.js';
 import {
-  constructCompleteUrl,
   deleteLocalComponent,
   deleteServerComponent,
-  getComponents,
   getComponentsObj,
   getPegaServerConfig,
   validateRulesetVersion,
-  nodeFetch,
   getOptionsCategory
 } from '../../util.js';
 import { getComponentsFromServer } from '../list/helper.js';

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

@@ -1,6 +1,4 @@
 import inquirer from 'inquirer';
-import ora from 'ora';
-import chalk from 'chalk';
 
 import {
   deleteLocalComponents,

package/src/tasks/generate-missing-companions/index.js

@@ -5,12 +5,10 @@ import chalk from 'chalk';
 import { validateCompile } from '../create/index.js';
 import {
   showVersion,
-  getComponents,
-  getComponentsObj,
   getComponentDirectoryPath,
   getComponentsAndSubDirectory
 } from '../../util.js';
-import {CATEGORY_CONSTELLATION, CATEGORY_CUSTOM, CATEGORY_OVERRIDE } from '../..//constants.js';
+import {CATEGORY_CONSTELLATION, CATEGORY_CUSTOM } from '../..//constants.js';
 import { or } from 'ajv/dist/compile/codegen/index.js';
 
 export const DXCB_CONFIG_INTERNAL_JSON_FILENAME = 'src/dxcb.config.json';

package/src/tasks/list/helper.js

@@ -5,7 +5,7 @@ import chalk from 'chalk';
 import fetch from 'node-fetch';
 
 import { LIST_COMPONENT_SERVICE_REST_ENDPOINT, TOKEN_PATH, COMPONENT_SCHEMA, CATEGORY_CUSTOM } from '../../constants.js';
-import { constructCompleteUrl, getComponents, getPegaServerConfig, getOptionsCategory } from '../../util.js';
+import { constructCompleteUrl, getComponents, getPegaServerConfig } from '../../util.js';
 
 
 export const SOURCE_OF_COMPONENT_TYPES = {

package/src/tasks/list/index.js

@@ -1,6 +1,5 @@
 import inquirer from 'inquirer';
 import ora from 'ora';
-import chalk from 'chalk';
 
 import {
   listLocalComponents,

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

@@ -1,13 +1,5 @@
-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 {
-  getComponentDirectoryPath,
   getOptionsCategory
 } from '../../util.js';
 import { COMPONENT_SCHEMA, CATEGORY_CONSTELLATION, CATEGORY_CUSTOM } from '../../constants.js';

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

@@ -2,12 +2,8 @@ import inquirer from 'inquirer';
 import Listr from 'listr';
 import chalk from 'chalk';
 
-import validate from '../validator/index.js';
 import { showVersion, getOptionsCategory, getComponentsObj } from '../../util.js';
 import { updateComponentMap  } from '../map/map.js';
-import { CATEGORY_CUSTOM } from '../../constants.js';
-
-
 import { getBuildCategory } from './helper.js';
 
 

package/src/tasks/override/index.js

@@ -1,8 +1,6 @@
 import path from 'path';
-import { URL, fileURLToPath } from 'url';
 import fs from 'fs';
 import { promisify } from 'util';
-import { createRequire } from "module";
 import { join } from 'path';
 
 import inquirer from 'inquirer';
@@ -10,17 +8,20 @@ import ncp from 'ncp';
 import chalk from 'chalk';
 import { updateComponentMap  } from '../map/map.js';
 
-import { checkPathAccess, getTokenUrl, showVersion, getDirectoryFiles, getPegaConfig } from '../../util.js';
+import { checkPathAccess, showVersion, getPegaConfig } from '../../util.js';
 import {
-  convertIntoPascalCase,
-  compileMustacheTemplate,
   getComponentDirectoryPath,
   getComponents,
-  getComponentDefaults,
-  sanitize,
-  validateSemver
+  getComponentDefaults
 } from '../../util.js';
-import { COMPONENT_SCHEMA, CATEGORY_OVERRIDE, SDK_CONFIG_JSON_FILENAME, DXCB_CONFIG, DXCB_COMPONENT_DEFAULTS } from '../../constants.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);
 
@@ -106,11 +107,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}`;
 

package/src/tasks/publish/helper.js

@@ -9,14 +9,17 @@ import chalk from 'chalk';
 import {
   constructCompleteUrl,
   getComponentDirectoryPath,
-  getComponents,
   getComponentsObj,
-  getComponentsAndSubDirectory,
   getPegaServerConfig,
   validateRulesetVersion,
   getOptionsCategory
 } from '../../util.js';
-import { PUBLISH_COMPONENT_SERVICE_REST_ENDPOINT, TOKEN_PATH, COMPONENT_SCHEMA, CATEGORY_CONSTELLATION, CATEGORY_CUSTOM } from '../../constants.js';
+
+import { PUBLISH_COMPONENT_SERVICE_REST_ENDPOINT, 
+  TOKEN_PATH, 
+  COMPONENT_SCHEMA, 
+  CATEGORY_CONSTELLATION, 
+  CATEGORY_CUSTOM } from '../../constants.js';
 
 
 export const mapConfigJsonToCompanion = async ( componentKey ) => {

package/src/tasks/publish/index.js

@@ -10,7 +10,11 @@ import { lintComponent } from '../linter/index.js';
 import { CATEGORY_CONSTELLATION, CATEGORY_CUSTOM } from '../../constants.js';
 
 
-import { getPublishComponentQuestions, publishComponentToServer, zipComponent, getBuildCategory, mapConfigJsonToCompanion } from './helper.js';
+import { getPublishComponentQuestions, 
+  publishComponentToServer, 
+  zipComponent, 
+  getBuildCategory, 
+  mapConfigJsonToCompanion } from './helper.js';
 
 
 export default async options => {

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

@@ -9,14 +9,17 @@ import chalk from 'chalk';
 import {
   constructCompleteUrl,
   getComponentDirectoryPath,
-  getComponents,
   getComponentsObj,
-  getComponentsAndSubDirectory,
-  getPegaServerConfig,
   validateRulesetVersion,
+  getPegaServerConfig,
   getOptionsCategory
 } from '../../util.js';
-import { PUBLISH_COMPONENT_SERVICE_REST_ENDPOINT, TOKEN_PATH, COMPONENT_SCHEMA, CATEGORY_CONSTELLATION, CATEGORY_CUSTOM } from '../../constants.js';
+
+import { PUBLISH_COMPONENT_SERVICE_REST_ENDPOINT, 
+  TOKEN_PATH, 
+  COMPONENT_SCHEMA, 
+  CATEGORY_CONSTELLATION, 
+  CATEGORY_CUSTOM } from '../../constants.js';
 
 
 export const mapConfigJsonToCompanion = async ( componentKey ) => {

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

@@ -10,7 +10,11 @@ import { lintComponent } from '../linter/index.js';
 import { CATEGORY_CONSTELLATION, CATEGORY_CUSTOM } from '../../constants.js';
 
 
-import { getPublishComponentQuestions, publishComponentToServer, zipComponent, getBuildCategory, mapConfigJsonToCompanion } from './helper.js';
+import { getPublishComponentQuestions, 
+  publishComponentToServer, 
+  zipComponent, 
+  getBuildCategory, 
+  mapConfigJsonToCompanion } from './helper.js';
 
 
 

package/src/tasks/validator/index.js

@@ -7,11 +7,9 @@ import Ajv from 'ajv';
 
 import {
   COMPONENT_SCHEMA,
-  COMPONENT_PREFIX_FIELD_PATH,
-  COMPONENT_PREFIX_TEMPLATE_PATH,
-  COMPONENT_PREFIX_WIDGET_PATH,
   CATEGORY_CUSTOM,
   CATEGORY_OVERRIDE } from '../../constants.js';
+  
 import {
   getComponentDirectoryPath,
   getComponents,

package/src/util.js

@@ -4,7 +4,6 @@ import { promisify } from 'util';
 import https from 'https';
 import inquirer from 'inquirer';
 import { createRequire } from "module";
-import { URL, fileURLToPath } from 'url';
 
 import chalk from 'chalk';
 import mustache from 'mustache';
@@ -271,20 +270,6 @@ export const getDirectoryFiles = async (directory) => {
   .map(dirent => dirent.name);
 }
 
-/*
-export const createBlankConfigExt = async (directory, name) => {
-
-  let fileData = "{";
-  fileData = fileData.concat("\n\t");
-  fileData = fileData.concat("\"name\" : \"");
-  fileData = fileData.concat(`${name}`);
-  fileData = fileData.concat("\", \n\t");
-  fileData = fileData.concat("\"properties\" : [ ] \n");
-  fileData = fileData.concat("}");
-  return fs.writeFileSync( join(directory, "/config-ext.json"), fileData, { encoding: 'utf8' });
-}
-*/
-
 
 export const getComponentsObj = async (showSeparator = false, category = CATEGORY_CUSTOM) => {
   const currentDirectory = process.cwd();