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

package/src/tasks/override/index.js

@@ -44,15 +44,25 @@ const checkAndCreateConfigComponentKey = async (targetDirectory) => {
   const configFile = path.join(targetDirectory, "config-ext.json");
   try {
     const configData = fs.readFileSync(path.resolve(configFile), 'utf8');
-    const configObj = JSON.parse(configData);
+    let configObj = JSON.parse(configData);
 
-    if (!configObj.componentKey) {
+    let writeUpdate = false;
+    if (!configObj.componentKey || !configObj.label) {
       const name = configObj.name;
-      const componentKey = name;
-      const newConfigObj = { componentKey, ...configObj };
+
+      if (!configObj.componentKey) {
+        const componentKey = name;
+        configObj = { componentKey, ...configObj };
+      }
+
+      if (!configObj.label) {
+        const label = name;
+        configObj = { label, ...configObj };
+      }
+
 
       // stringify "4", makes the json string look like JSON in the file
-      const configContent = JSON.stringify(newConfigObj, null, 4);
+      const configContent = JSON.stringify(configObj, null, 4);
 
       // update file
       fs.writeFileSync(configFile, configContent, { encoding: 'utf8' });
@@ -73,13 +83,15 @@ const getListAvailableComponents = async (type) => {
   for (var el in fullList) {
 
     let listEl = fullList[el].value;
+
     if (listEl.indexOf("/") >=0) {
       const arKey = listEl.split("/");
       listEl = arKey[arKey.length - 1];
     }
 
     if (components.includes(listEl)) {
-      availList.push(new inquirer.Separator("** " + fullList[el].name));
+      // currently don't show, because too many separators inquirer flaky
+      //availList.push(new inquirer.Separator("** " + fullList[el].name));
     }
     else {
       availList.push(fullList[el]);
@@ -149,22 +161,22 @@ export default async options => {
     let inputType = options.params[3];
 
     switch (inputType.toLowerCase()) {
-      case "forms" :
+      case "field" :
       case "f" :
-        promptType = "forms";
+        promptType = "field";
         break;
-      case "templates" :
+      case "template" :
       case "t" :
-        promptType = "templates";
+        promptType = "template";
         break;
-      case "widgets" :
+      case "widget" :
       case "w" :
-        promptType = "widgets";
+        promptType = "widget";
         break;
-      case "designsystemextensions" :
+      case "designsystemextension" :
       case "des" :
       case "d" :
-        promptType = "designSystemExtensions";
+        promptType = "designSystemExtension";
         break;
       case "infra" :
       case "i" :
@@ -185,10 +197,10 @@ export default async options => {
   let componentDefaults = await getComponentDefaults();
   componentDefaults.library = library;
 
-  const formsList = await getListAvailableComponents("forms");
-  const desList = await getListAvailableComponents("designSystemExtensions");
-  const templateList = await getListAvailableComponents("templates");
-  const widgetList = await getListAvailableComponents("widgets");
+  const formsList = await getListAvailableComponents("field");
+  const desList = await getListAvailableComponents("designSystemExtension");
+  const templateList = await getListAvailableComponents("template");
+  const widgetList = await getListAvailableComponents("widget");
   const infraList = await getListAvailableComponents("infra");
 
   const questions = [
@@ -208,7 +220,7 @@ export default async options => {
       choices: formsList,
       pageSize: 15,
       when(answers) {
-        return answers.type === 'forms' || promptType === 'forms';
+        return answers.type === 'field' || promptType === 'field';
       }
     },
     {
@@ -218,7 +230,7 @@ export default async options => {
       choices: desList,
       pageSize: 15,
       when(answers) {
-        return answers.type === 'designSystemExtensions' || promptType === 'designSystemExtensions';
+        return answers.type === 'designSystemExtension' || promptType === 'designSystemExtension';
       }
     },
     {
@@ -238,7 +250,7 @@ export default async options => {
       choices: templateList,
       pageSize: 15,
       when(answers) {
-        return answers.type === 'templates' || promptType === 'templates';
+        return answers.type === 'template' || promptType === 'template';
       }
     },
     {
@@ -248,7 +260,7 @@ export default async options => {
       choices: widgetList,
       pageSize: 15,
       when(answers) {
-        return answers.type === 'widgets'  || promptType === 'widgets';
+        return answers.type === 'widget'  || promptType === 'widget';
       }
     },
 

package/src/tasks/publish/index.js

@@ -126,14 +126,14 @@ export default async options => {
         }
       },
       {
-        title: 'Zip component',
+        title: 'Zip component config',
         task: async () => {
           const output = await zipComponent(componentKey, category);
           content = { ...content, ...output };
         }
       },
       {
-        title: 'Publish component',
+        title: 'Publish component config',
         task: async () => {
           await publishComponentToServer(content);
         }

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

@@ -82,7 +82,7 @@ export default async options => {
         title: 'Zip companion component',
         task: async () => {
           const output = await zipComponent(componentKey, CATEGORY_CONSTELLATION);
-          content = { ...content, ...output };
+          content = { ...content, ...output, componentKey };
         }
       },
       {
@@ -114,25 +114,25 @@ export default async options => {
         }
       },
       {
-        title: 'Bundle Component',
+        title: 'Bundle component',
         task: async () => await bundleComponent(componentKey, sourceMap, devBuild, category),
         skip: () => (options.skipBundle ? 'Skipped bundling component' : undefined)
       },
       {
-        title: 'Update Component Map',
+        title: 'Update component map',
         task: async () => {
             await updateComponentMap(componentKey, category);
         }
       },
       {
-        title: 'Zip Component',
+        title: 'Zip component config',
         task: async () => {
           const output = await zipComponent(componentKey, category);
           content = { ...content, ...output, componentKey };
         }
       },
       {
-        title: 'Publish component',
+        title: 'Publish component config',
         task: async () => {
           await publishComponentToServer(content);
         }

package/src/tasks/validator/index.js

@@ -30,6 +30,15 @@ const allowedSubtypes = [
   ])
 ];
 
+// additional subtypes are manually added below
+const allowedOverrideSubtypes = [
+  ...new Set([
+    ...COMPONENT_SCHEMA.subtype.field.map(({ value }) => value),
+    ...COMPONENT_SCHEMA.subtype.template,
+    ...COMPONENT_SCHEMA.subtype.widget.map(({ value }) => value)
+  ]), "ACTION", "DATA_CAPTURE", "SUMMARY", "CASEVIEW", "DATAVIEW", "LIST"
+];
+
 const schema = {
   type: 'object',
   properties: {
@@ -183,7 +192,7 @@ const overrideSchema = {
     subtype: {
       anyOf: [{ type: 'string' }, { type: 'array' }],
 
-      enum: allowedSubtypes
+      enum: allowedOverrideSubtypes
     },
     icon: { type: 'string' },
     properties: {

package/src/util.js

@@ -22,22 +22,17 @@ import {
   FIELD_PATH,
   WIDGET_PATH,
   TEMPLATE_PATH,
-  FORMS_PATH,
-  TEMPLATES_PATH,
-  WIDGETS_PATH,
   DSE_PATH,
   INFRA_PATH,
   COMPONENT_PREFIX_FIELD_PATH,
   COMPONENT_PREFIX_TEMPLATE_PATH,
   COMPONENT_PREFIX_WIDGET_PATH,
-  COMPONENT_PREFIX_FORMS_PATH,
-  COMPONENT_PREFIX_TEMPLATES_PATH,
-  COMPONENT_PREFIX_WIDGETS_PATH,
   COMPONENT_PREFIX_DSE_PATH,
   COMPONENT_PREFIX_INFRA_PATH,
   CATEGORY_CUSTOM,
   CATEGORY_OVERRIDE,
-  CATEGORY_CONSTELLATION
+  CATEGORY_CONSTELLATION,
+  COMPONENT_DIRECTORY_PREFIX_CUSTOM
 } from './constants.js';
 
 
@@ -60,7 +55,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 categoryDirectory = join("/", category.toLowerCase());
+  const categoryDirectory = (category === CATEGORY_CONSTELLATION) ? join("/", COMPONENT_DIRECTORY_PREFIX_CUSTOM + category.toLowerCase()) : join("/", category.toLowerCase());
 
   await checkPathAccess(pegaConfigJsonPath);
 
@@ -172,7 +167,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 categoryDirectory = join("/", category.toLowerCase());
+  const categoryDirectory = (category === CATEGORY_CONSTELLATION) ? join("/", COMPONENT_DIRECTORY_PREFIX_CUSTOM + category.toLowerCase()) : join("/", category.toLowerCase());
 
   await checkPathAccess(pegaConfigJsonPath);
 
@@ -215,14 +210,14 @@ export const getComponents = async (showSeparator = false, category = CATEGORY_C
       }
       break;
     case CATEGORY_OVERRIDE:
-      const formsComps = await getSubComponents(directory, FORMS_PATH);
-      const templatesComps = await getSubComponents(directory, TEMPLATES_PATH);
-      const widgetsComps = await getSubComponents(directory, WIDGETS_PATH);
+      const formsComps = await getSubComponents(directory, FIELD_PATH);
+      const templatesComps = await getSubComponents(directory, TEMPLATE_PATH);
+      const widgetsComps = await getSubComponents(directory, WIDGET_PATH);
       const dseComps = await getSubComponents(directory, DSE_PATH);
       const infraComps = await getSubComponents(directory, INFRA_PATH);
 
       if (formsComps.length > 0) {
-        if (showSeparator) compList.push(new inquirer.Separator("---- forms (fields) ----"));
+        if (showSeparator) compList.push(new inquirer.Separator("---- fields  ----"));
         compList.push(...formsComps);
       }
 
@@ -291,7 +286,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 categoryDirectory = join("/", category.toLowerCase());
+  const categoryDirectory = (category === CATEGORY_CONSTELLATION) ? join("/", COMPONENT_DIRECTORY_PREFIX_CUSTOM + category.toLowerCase()) : join("/", category.toLowerCase());
 
   await checkPathAccess(pegaConfigJsonPath);
 
@@ -355,20 +350,20 @@ export const getComponentsObj = async (showSeparator = false, category = CATEGOR
       }
       break;
     case CATEGORY_OVERRIDE:
-      const formsComps = await getSubComponents(directory, FORMS_PATH);
-      const templatesComps = await getSubComponents(directory, TEMPLATES_PATH);
-      const widgetsComps = await getSubComponents(directory, WIDGETS_PATH);
+      const formsComps = await getSubComponents(directory, FIELD_PATH);
+      const templatesComps = await getSubComponents(directory, TEMPLATE_PATH);
+      const widgetsComps = await getSubComponents(directory, WIDGET_PATH);
       const dseComps = await getSubComponents(directory, DSE_PATH);
       const infraComps = await getSubComponents(directory, INFRA_PATH);
 
       if (formsComps.length > 0) {
-        if (showSeparator) compList.push(new inquirer.Separator("---- forms (fields) ----"));
+        if (showSeparator) compList.push(new inquirer.Separator("---- fields ----"));
 
         compList.push(...formsComps.map(
           name => {
             const container = {};
             container.name = name;
-            container.value = COMPONENT_PREFIX_FORMS_PATH + name;
+            container.value = COMPONENT_PREFIX_FIELD_PATH + name;
 
             return container;
           }
@@ -381,7 +376,7 @@ export const getComponentsObj = async (showSeparator = false, category = CATEGOR
           name => {
             const container = {};
             container.name = name;
-            container.value = COMPONENT_PREFIX_TEMPLATES_PATH + name;
+            container.value = COMPONENT_PREFIX_TEMPLATE_PATH + name;
 
             return container;
           }
@@ -394,7 +389,7 @@ export const getComponentsObj = async (showSeparator = false, category = CATEGOR
           name => {
             const container = {};
             container.name = name;
-            container.value = COMPONENT_PREFIX_WIDGETS_PATH + name;
+            container.value = COMPONENT_PREFIX_WIDGET_PATH + name;
 
             return container;
           }
@@ -451,7 +446,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 categoryDirectory = join("/", category.toLowerCase());
+  const categoryDirectory = (category === CATEGORY_CONSTELLATION) ? join("/", COMPONENT_DIRECTORY_PREFIX_CUSTOM + category.toLowerCase()) : join("/", category.toLowerCase());
 
   await checkPathAccess(pegaConfigJsonPath);
 
@@ -490,15 +485,6 @@ export const removeComponentPrefix = (componentName) => {
   else if (componentName.indexOf(COMPONENT_PREFIX_WIDGET_PATH) == 0) {
     componentName = componentName.substring(COMPONENT_PREFIX_WIDGET_PATH.length);
   }
-  else if (componentName.indexOf(COMPONENT_PREFIX_FORMS_PATH) == 0) {
-    componentName = componentName.substring(COMPONENT_PREFIX_FORMS_PATH.length);
-  }
-  else if (componentName.indexOf(COMPONENT_PREFIX_TEMPLATES_PATH) == 0) {
-    componentName = componentName.substring(COMPONENT_PREFIX_TEMPLATES_PATH.length);
-  }
-  else if (componentName.indexOf(COMPONENT_PREFIX_WIDGETS_PATH) == 0) {
-    componentName = componentName.substring(COMPONENT_PREFIX_WIDGETS_PATH.length);
-  }
   else if (componentName.indexOf(COMPONENT_PREFIX_DSE_PATH) == 0) {
     componentName = componentName.substring(COMPONENT_PREFIX_DSE_PATH.length);
   }
@@ -535,7 +521,7 @@ export const getComponentDefaults = async () => {
 export const getComponentDirectoryPath = async (componentKey, category = CATEGORY_CUSTOM) => {
   const currentDirectory = process.cwd();
   const pegaConfigJsonPath = join(currentDirectory, DXCB_CONFIG_JSON_FILENAME);
-  const categoryDirectory = join("/", category.toLowerCase());
+  const categoryDirectory = (category === CATEGORY_CONSTELLATION) ? join("/", COMPONENT_DIRECTORY_PREFIX_CUSTOM + category.toLowerCase()) : join("/", category.toLowerCase());
 
   await checkPathAccess(pegaConfigJsonPath);