@pega/custom-dx-components 26.1.11 → 26.1.12-alpha.0.2

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

@@ -20,14 +20,14 @@ import {
   getInputConfigForCommand,
   convertYNToBoolean,
   hasArchives,
-  getLibraryBasedCL
+  getLibraryBasedCL,
 } from '../../util.js';
 
 import { getSwitchLibraryComponentQuestions, getSwitchVersionComponentQuestions } from './helper.js';
 import { showCurrentStatus } from '../show-status/index.js';
 import { arch } from 'os';
 
-export default async options => {
+export default async (options) => {
   const isLibraryBased = getLibraryBased();
   const isLibraryBasedCL = getLibraryBasedCL();
 
@@ -154,19 +154,19 @@ export default async options => {
         title: `Storing ${orgLib.displayLibVersion}`,
         task: async () => {
           await zipVersionAndArchive(existingOrgLib, oldVersion);
-        }
+        },
       },
       {
         title: `Restoring ${newOrgLib}/${newVersion}`,
         task: async () => {
           await restoreFromArchive(switchToFileName, newOrgLib, newVersion);
-        }
-      }
+        },
+      },
     ],
-    { concurrent: false, exitOnError: true }
+    { concurrent: false, exitOnError: true },
   );
 
-  await tasks.run().catch(err => {
+  await tasks.run().catch((err) => {
     console.log(chalk.bold.red(err.toString()));
     process.exit(1);
   });

package/src/tasks/switch-version/helper.js

@@ -6,7 +6,7 @@ import { getComponents, updateConfigVersion, getLibraryArchivesVersions, addDebu
 
 const exec = promisify(LocalExec);
 
-export const updateAllComponentsConfig = async newVersion => {
+export const updateAllComponentsConfig = async (newVersion) => {
   addDebugLog('updateAllComponentsConfig', `newVersion: ${newVersion}`, '');
   const componentList = await getComponents();
   const orgLib = getConfigDefaults();
@@ -37,7 +37,7 @@ export const getSwitchVersionComponentQuestions = async () => {
       name: 'okToContinue',
       type: 'confirm',
       message: 'Ok to continue ?',
-      default: true
+      default: true,
     },
     {
       name: 'version',
@@ -46,8 +46,8 @@ export const getSwitchVersionComponentQuestions = async () => {
       choices: archVersionList,
       when(answers) {
         return answers.okToContinue;
-      }
-    }
+      },
+    },
   ];
 };
 
@@ -61,8 +61,8 @@ export const getRunNpmQuestions = async () => {
       name: 'updateNpm',
       type: 'confirm',
       message: 'Run npm update?',
-      default: true
-    }
+      default: true,
+    },
   ];
 };
 

package/src/tasks/switch-version/index.js

@@ -22,13 +22,13 @@ import {
   getInputConfigForCommand,
   convertYNToBoolean,
   hasArchives,
-  hasLibraryAndVersion
+  hasLibraryAndVersion,
 } from '../../util.js';
 
 import { getSwitchVersionComponentQuestions } from './helper.js';
 import { showCurrentStatus } from '../show-status/index.js';
 
-export default async options => {
+export default async (options) => {
   const isLibraryBased = getLibraryBased();
   const isLibraryBasedCL = getLibraryBasedCL();
 
@@ -135,19 +135,19 @@ export default async options => {
           title: `Storing ${orgLib.displayLibVersion}`,
           task: async () => {
             await zipVersionAndArchive(existingOrgLib, oldVersion);
-          }
+          },
         },
         {
           title: `Restoring ${existingOrgLib}/${newVersion}`,
           task: async () => {
             await restoreFromArchive(switchToFileName, existingOrgLib, newVersion);
-          }
-        }
+          },
+        },
       ],
-      { concurrent: false, exitOnError: true }
+      { concurrent: false, exitOnError: true },
     );
 
-    await tasks.run().catch(err => {
+    await tasks.run().catch((err) => {
       console.log(chalk.bold.red(err.toString()));
       process.exit(1);
     });

package/src/tasks/update/index.js

@@ -1,5 +1,5 @@
 import publishComponent from '../publish/index.js';
 
-export default options => {
+export default (options) => {
   return publishComponent(options);
 };

package/src/tasks/upgrade/index.js

@@ -5,7 +5,7 @@ import { Listr } from 'listr2';
 
 const execPromise = promisify(exec);
 
-export default async options => {
+export default async (options) => {
   const installDependenciesText = `Upgrading package to latest version.`;
 
   const tasks = new Listr(
@@ -14,17 +14,17 @@ export default async options => {
         title: installDependenciesText,
         task: async () => {
           await execPromise('npm uninstall --save-dev @pega/custom-dx-components', {
-            cwd: options.targetDirectory
+            cwd: options.targetDirectory,
           });
           await execPromise('npm install --save-dev @pega/custom-dx-components', {
-            cwd: options.targetDirectory
+            cwd: options.targetDirectory,
           });
-        }
-      }
+        },
+      },
     ],
     {
-      exitOnError: false
-    }
+      exitOnError: false,
+    },
   );
 
   await tasks.run();

package/src/tasks/validator/index.js

@@ -11,34 +11,16 @@ import { getComponentDirectoryPath, getComponents, isComponentValidLength, getCo
 
 const ajv = new Ajv({ allErrors: true });
 
-const combinationTypes = ['PAGE', 'CASE'];
-
 const configDef = getConfigDefaults();
 const isLibraryBasedCL = getLibraryBasedCL();
 
 const allowedSubtypes = [
-  ...new Set([
-    ...COMPONENT_SCHEMA.subtype.field.map(({ value }) => value),
-    ...COMPONENT_SCHEMA.subtype.template.map(({ value }) => value),
-    ...COMPONENT_SCHEMA.subtype.widget.map(({ value }) => value),
-    ...COMPONENT_SCHEMA.subtype.presentation.map(({ value }) => value)
-  ])
-];
-
-// additional subtypes are manually added below
-const allowedOverrideSubtypes = [
   ...new Set([
     ...COMPONENT_SCHEMA.subtype.field.map(({ value }) => value),
     ...COMPONENT_SCHEMA.subtype.template.map(({ value }) => value),
     ...COMPONENT_SCHEMA.subtype.widget.map(({ value }) => value),
     ...COMPONENT_SCHEMA.subtype.presentation.map(({ value }) => value),
-    'ACTION',
-    'DATA_CAPTURE',
-    'SUMMARY',
-    'CASEVIEW',
-    'DATAVIEW',
-    'LIST'
-  ])
+  ]),
 ];
 
 const schema = {
@@ -56,7 +38,7 @@ const schema = {
     subtype: {
       anyOf: [{ type: 'string' }, { type: 'array' }],
 
-      enum: allowedSubtypes
+      enum: allowedSubtypes,
     },
     icon: { type: 'string' },
     properties: {
@@ -69,9 +51,9 @@ const schema = {
             properties: {
               name: { type: 'string' },
               label: { type: 'string' },
-              format: { type: 'string' }
+              format: { type: 'string' },
             },
-            required: ['name', 'label', 'format']
+            required: ['name', 'label', 'format'],
           },
           {
             type: 'object',
@@ -82,9 +64,9 @@ const schema = {
                 properties: {
                   name: { type: 'string' },
                   label: { type: 'string' },
-                  format: { type: 'string' }
+                  format: { type: 'string' },
                 },
-                required: ['name', 'label', 'format']
+                required: ['name', 'label', 'format'],
               },
               cascadeElements: {
                 type: 'array',
@@ -97,150 +79,15 @@ const schema = {
                         key: { type: 'string' },
                         name: { type: 'string' },
                         label: { type: 'string' },
-                        format: { type: 'string' }
-                      },
-                      required: ['key', 'name', 'label', 'format']
-                    }
-                  ]
-                }
-              }
-            },
-            required: ['format']
-          },
-          {
-            type: 'object',
-            properties: {
-              label: { type: 'string' },
-              format: { type: 'string' },
-              properties: {
-                type: 'array',
-                uniqueItems: true,
-                items: {
-                  anyOf: [
-                    {
-                      type: 'object',
-                      properties: {
-                        name: { type: 'string' },
-                        label: { type: 'string' },
-                        format: { type: 'string' }
-                      },
-                      required: ['name', 'label', 'format']
-                    },
-                    {
-                      type: 'object',
-                      properties: {
-                        variant: { type: 'string' },
-                        label: { type: 'string' },
-                        format: { type: 'string' }
-                      },
-                      required: ['variant', 'label', 'format']
-                    },
-                    {
-                      type: 'object',
-                      properties: {
                         format: { type: 'string' },
-                        elements: {
-                          type: 'array',
-                          uniqueItems: true,
-                          items: {
-                            anyOf: [
-                              {
-                                type: 'object',
-                                properties: {
-                                  key: { type: 'string' },
-                                  name: { type: 'string' },
-                                  label: { type: 'string' },
-                                  format: { type: 'string' },
-                                  variant: { type: 'string' }
-                                },
-                                required: ['key', 'format', 'label']
-                              }
-                            ]
-                          }
-                        }
                       },
-                      required: ['format', 'elements']
-                    }
-                  ]
-                }
-              }
-            },
-            required: ['label', 'format']
-          }
-        ]
-      }
-    },
-    defaultConfig: { type: 'object' }
-  },
-  required: ['componentKey', 'name', 'description', 'type', 'subtype', 'properties'],
-  additionalProperties: true
-};
-
-const overrideSchema = {
-  type: 'object',
-  properties: {
-    baseComponentName: { type: 'string' },
-    componentKey: { type: 'string', pattern: '^[A-Za-z0-9]+$' },
-    name: { type: 'string', pattern: '^[A-Za-z0-9]+$' },
-    label: { type: 'string' },
-    description: { type: 'string' },
-    organization: { type: 'string' },
-    version: { type: 'string' },
-    library: { type: 'string' },
-    type: { type: 'string', enum: COMPONENT_SCHEMA.type.map(({ value }) => value) },
-    subtype: {
-      anyOf: [{ type: 'string' }, { type: 'array' }],
-
-      enum: allowedOverrideSubtypes
-    },
-    icon: { type: 'string' },
-    properties: {
-      type: 'array',
-      uniqueItems: true,
-      items: {
-        anyOf: [
-          {
-            type: 'object',
-            properties: {
-              name: { type: 'string' },
-              label: { type: 'string' },
-              format: { type: 'string' }
-            },
-            required: ['name', 'label', 'format']
-          },
-          {
-            type: 'object',
-            properties: {
-              format: { type: 'string' },
-              source: {
-                type: 'object',
-                properties: {
-                  name: { type: 'string' },
-                  label: { type: 'string' },
-                  format: { type: 'string' }
+                      required: ['key', 'name', 'label', 'format'],
+                    },
+                  ],
                 },
-                required: ['name', 'label', 'format']
               },
-              cascadeElements: {
-                type: 'array',
-                uniqueItems: true,
-                items: {
-                  anyOf: [
-                    {
-                      type: 'object',
-                      properties: {
-                        key: { type: 'string' },
-                        name: { type: 'string' },
-                        label: { type: 'string' },
-                        format: { type: 'string' }
-                      },
-                      required: ['key', 'name', 'label', 'format']
-                    }
-                  ]
-                }
-              }
             },
-            required: ['format']
+            required: ['format'],
           },
           {
             type: 'object',
@@ -257,18 +104,18 @@ const overrideSchema = {
                       properties: {
                         name: { type: 'string' },
                         label: { type: 'string' },
-                        format: { type: 'string' }
+                        format: { type: 'string' },
                       },
-                      required: ['name', 'label', 'format']
+                      required: ['name', 'label', 'format'],
                     },
                     {
                       type: 'object',
                       properties: {
                         variant: { type: 'string' },
                         label: { type: 'string' },
-                        format: { type: 'string' }
+                        format: { type: 'string' },
                       },
-                      required: ['variant', 'label', 'format']
+                      required: ['variant', 'label', 'format'],
                     },
                     {
                       type: 'object',
@@ -286,33 +133,32 @@ const overrideSchema = {
                                   name: { type: 'string' },
                                   label: { type: 'string' },
                                   format: { type: 'string' },
-                                  variant: { type: 'string' }
+                                  variant: { type: 'string' },
                                 },
-                                required: ['key', 'format', 'label']
-                              }
-                            ]
-                          }
-                        }
+                                required: ['key', 'format', 'label'],
+                              },
+                            ],
+                          },
+                        },
                       },
-                      required: ['format', 'elements']
-                    }
-                  ]
-                }
-              }
+                      required: ['format', 'elements'],
+                    },
+                  ],
+                },
+              },
             },
-            required: ['label', 'format']
-          }
-        ]
-      }
+            required: ['label', 'format'],
+          },
+        ],
+      },
     },
-    defaultConfig: { type: 'object' }
+    defaultConfig: { type: 'object' },
   },
-  required: ['name', 'type', 'subtype', 'properties', 'componentKey'],
-  additionalProperties: true
+  required: ['componentKey', 'name', 'description', 'type', 'subtype', 'properties'],
+  additionalProperties: true,
 };
 
 const validateSchema = ajv.compile(schema);
-const validateOverrideSchema = ajv.compile(overrideSchema);
 
 /**
  * Validates that a Presentation component uses only allowed subtypes, and that
@@ -323,20 +169,20 @@ export function validatePresentationSubtype(data) {
   const presentationSubtypes = COMPONENT_SCHEMA.subtype.presentation.map(({ value }) => value);
   if (data.type === 'Presentation' && !presentationSubtypes.includes(data.subtype)) {
     throw new Error(
-      `Error: Invalid subtype '${data.subtype}' for Presentation component '${data.name}'.\n --> Allowed subtypes for Presentation are: ${presentationSubtypes.join(', ')}.`
+      `Error: Invalid subtype '${data.subtype}' for Presentation component '${data.name}'.\n --> Allowed subtypes for Presentation are: ${presentationSubtypes.join(', ')}.`,
     );
   }
   if (data.type !== 'Presentation' && presentationSubtypes.includes(data.subtype)) {
     throw new Error(
-      `Error: Subtype '${data.subtype}' is only allowed for Presentation components. Component '${data.name}' has type '${data.type}'.`
+      `Error: Subtype '${data.subtype}' is only allowed for Presentation components. Component '${data.name}' has type '${data.type}'.`,
     );
   }
 }
 
-export default async option => {
+export default async (option) => {
   // addDebugLog("validate","", "");
 
-  let componentToValidate = null;
+  let componentToValidate;
   let throwTheError = false;
   if (option.params && option.params[3]) {
     componentToValidate = option.params[3];
@@ -347,7 +193,7 @@ export default async option => {
       name: 'component',
       type: 'rawlist',
       message: 'Select component to validate',
-      choices: localComponents
+      choices: localComponents,
     });
 
     componentToValidate = answer.component;
@@ -368,7 +214,7 @@ export default async option => {
       const arPrefix = componentToValidate.split('_');
       const sPrefix = `${arPrefix[0]}_${arPrefix[1]}`;
       throw new Error(
-        `Component: ${componentToValidate} prefix invalid.\n --> '${sPrefix}' prefix does not match configuration '${configDef.currentOrgLib}'. \n --> Org_Lib prefix of component must match Organization and Library values \n --> in package.json and tasks.config.json respectively.`
+        `Component: ${componentToValidate} prefix invalid.\n --> '${sPrefix}' prefix does not match configuration '${configDef.currentOrgLib}'. \n --> Org_Lib prefix of component must match Organization and Library values \n --> in package.json and tasks.config.json respectively.`,
       );
     }
   }
@@ -380,7 +226,7 @@ export default async option => {
   let configData;
   try {
     configData = fs.readFileSync(path.resolve(configFile), 'utf8');
-  } catch (err) {
+  } catch {
     // for now, if now file just end
     console.log(`${chalk.bold.yellow(`Config file not available for: ${componentToValidate}`)}`);
     return;
@@ -391,7 +237,7 @@ export default async option => {
   try {
     data = JSON.parse(configData);
   } catch (er) {
-    throw new Error(`Invalid schema json in config.json: ${er}`);
+    throw new Error(`Invalid schema json in config.json: ${er}`, { cause: er });
   }
 
   const valid = validateSchema(data);
@@ -406,11 +252,11 @@ export default async option => {
     if (componentToValidate && !/^[A-Za-z0-9]+_[A-Za-z0-9]+_[A-Za-z0-9]+$/.test(componentToValidate)) {
       if (throwTheError) {
         throw new Error(
-          `${chalk.redBright(`Error: Invalid name of component '${componentToValidate}' .\n Component name (and component folder) MUST be of the form: 'Org_Lib_ComponentName'.`)}`
+          `${chalk.redBright(`Error: Invalid name of component '${componentToValidate}' .\n Component name (and component folder) MUST be of the form: 'Org_Lib_ComponentName'.`)}`,
         );
       }
       console.log(
-        `${chalk.redBright(`Error: Invalid name of component '${componentToValidate}' .\n Component name (and component folder) MUST be of the form: 'Org_Lib_ComponentName'.`)}`
+        `${chalk.redBright(`Error: Invalid name of component '${componentToValidate}' .\n Component name (and component folder) MUST be of the form: 'Org_Lib_ComponentName'.`)}`,
       );
       process.exit(1);
     }
@@ -418,13 +264,13 @@ export default async option => {
     if (isLibraryBasedCL) {
       if (data.library !== configDef.library) {
         throw new Error(
-          `${chalk.redBright(`Error: Invalid library in config.json for component '${data.name}'.\n -->Library: '${data.library}' must match tasks.config library: '${configDef.library}'.`)}`
+          `${chalk.redBright(`Error: Invalid library in config.json for component '${data.name}'.\n -->Library: '${data.library}' must match tasks.config library: '${configDef.library}'.`)}`,
         );
       }
 
       if (data.organization !== configDef.organization) {
         throw new Error(
-          `${chalk.redBright(`Error: Invalid organization in config.json for component '${data.name}'.\n -->Organization: '${data.organization}' must match package.json organization: '${configDef.organization}'.`)}`
+          `${chalk.redBright(`Error: Invalid organization in config.json for component '${data.name}'.\n -->Organization: '${data.organization}' must match package.json organization: '${configDef.organization}'.`)}`,
         );
       }
 
@@ -432,31 +278,31 @@ export default async option => {
         const arPrefix = data.componentKey.split('_');
         const sPrefix = `${arPrefix[0]}_${arPrefix[1]}`;
         throw new Error(
-          `${chalk.redBright(`Error: Invalid componentKey in config.json for component '${data.name}'.\n --> Component prefix Org_Lib: '${sPrefix}' must match '${configDef.currentOrgLib}'. \n --> These represent organization and library values found in package.json and tasks.config.json respectively. `)}`
+          `${chalk.redBright(`Error: Invalid componentKey in config.json for component '${data.name}'.\n --> Component prefix Org_Lib: '${sPrefix}' must match '${configDef.currentOrgLib}'. \n --> These represent organization and library values found in package.json and tasks.config.json respectively. `)}`,
         );
       }
 
       if (data.componentKey !== componentToValidate) {
         throw new Error(
-          `${chalk.redBright(`Error: Invalid folder name or componentKey in config.json for component '${data.name}'.\n --> Component folder name: '${componentToValidate}' must match component key '${data.componentKey}'.\n --> NOTE: Values are case sensitve.`)}`
+          `${chalk.redBright(`Error: Invalid folder name or componentKey in config.json for component '${data.name}'.\n --> Component folder name: '${componentToValidate}' must match component key '${data.componentKey}'.\n --> NOTE: Values are case sensitive.`)}`,
         );
       }
 
       if (data.name !== componentToValidate) {
         throw new Error(
-          `${chalk.redBright(`Error: Invalid folder name or name in config.json for component '${data.name}'.\n --> Component folder name: '${componentToValidate}' must match name '${data.name}'.\n --> NOTE: Values are case sensitve.`)}`
+          `${chalk.redBright(`Error: Invalid folder name or name in config.json for component '${data.name}'.\n --> Component folder name: '${componentToValidate}' must match name '${data.name}'.\n --> NOTE: Values are case sensitive.`)}`,
         );
       }
     } else {
       if (data.componentKey !== componentToValidate) {
         throw new Error(
-          `${chalk.redBright(`Error: Invalid folder name or componentKey in config.json for component '${data.name}'.\n --> Component folder name: '${componentToValidate}' must match component key '${data.componentKey}'.\n --> NOTE: Values are case sensitve.`)}`
+          `${chalk.redBright(`Error: Invalid folder name or componentKey in config.json for component '${data.name}'.\n --> Component folder name: '${componentToValidate}' must match component key '${data.componentKey}'.\n --> NOTE: Values are case sensitive.`)}`,
         );
       }
 
       if (data.name !== componentToValidate) {
         throw new Error(
-          `${chalk.redBright(`Error: Invalid folder name or name in config.json for component '${data.name}'.\n --> Component folder name: '${componentToValidate}' must match name '${data.name}'.\n --> NOTE: Values are case sensitve.`)}`
+          `${chalk.redBright(`Error: Invalid folder name or name in config.json for component '${data.name}'.\n --> Component folder name: '${componentToValidate}' must match name '${data.name}'.\n --> NOTE: Values are case sensitive.`)}`,
         );
       }
     }