feat: change conditionalFile to conditionalGeneration and change its parameter

Author: AayushSaini101

apps/generator/lib/generator.js

@@ -876,30 +876,22 @@ class Generator {
     if (!shouldOverwriteFile) return;
 
     if (this.templateConfig.conditionalFiles?.[relativeSourceFile]) {
-      const parameter = this.templateConfig.conditionalFiles[relativeSourceFile].subject;
-      const value =  await this.getParameterValue(asyncapiDocument, parameter)
-     if (value !== undefined) {
-          const validation = this.templateConfig.conditionalFiles[relativeSourceFile].validation;
-          // Handle "const"
-          if (validation?.const !== undefined) {
-            const isValid = value === validation.const;
-            console.log(isValid)
-            if (!isValid) {
-              return log.debug(logMessage.conditionalFilesMatched(relativeSourceFile));
-            }
-          }
-      
-          // Handle "not"
-          if (validation?.not !== undefined) {
-            const isNotValid = value === validation.not;
-            if (isNotValid) {
-              return log.debug(logMessage.conditionalFilesMatched(relativeSourceFile));
-            }
-          }
-      
-          // You can keep adding more types like "enum", "pattern", etc.
-        }
+      const server = this.templateParams.server && asyncapiDocument.servers().get(this.templateParams.server);
+      const source = jmespath.search({
+        ...asyncapiDocument.json(),
+        ...{
+          server: server ? server.json() : undefined,
+        },
+      }, this.templateConfig.conditionalFiles[relativeSourceFile].subject);
+
+      if (!source) return log.debug(logMessage.relativeSourceFileNotGenerated(relativeSourceFile, this.templateConfig.conditionalFiles[relativeSourceFile].subject));
+
+      if (source) {
+        const validate = this.templateConfig.conditionalFiles[relativeSourceFile].validate;
+        const valid = validate(source);
+        if (!valid) return log.debug(logMessage.conditionalFilesMatched(relativeSourceFile));
       }
+    }
 
     if (this.isNonRenderableFile(relativeSourceFile)) return await copyFile(sourceFile, targetFile);
     await this.renderAndWriteToFile(asyncapiDocument, sourceFile, targetFile);
@@ -1092,4 +1084,4 @@ class Generator {
 Generator.DEFAULT_TEMPLATES_DIR = DEFAULT_TEMPLATES_DIR;
 Generator.TRANSPILED_TEMPLATE_LOCATION = TRANSPILED_TEMPLATE_LOCATION;
 
-module.exports = Generator;
+module.exports = Generator;

apps/generator/lib/templateConfigValidator.js

@@ -24,9 +24,9 @@ const supportedParserAPIMajorVersions = [
  * @return {Boolean}
  */
 module.exports.validateTemplateConfig = (templateConfig, templateParams, asyncapiDocument) => {
-  const { parameters, supportedProtocols, conditionalFiles, generator, apiVersion } = templateConfig;
+  const { parameters, supportedProtocols, conditionalGeneration, generator, apiVersion } = templateConfig;
 
-  validateConditionalFiles(conditionalFiles);
+  validateconditionalGeneration(conditionalGeneration);
   isTemplateCompatible(generator, apiVersion);
   isRequiredParamProvided(parameters, templateParams);
   isProvidedTemplateRendererSupported(templateConfig);
@@ -151,17 +151,17 @@ function isServerProvidedInDocument(server, paramsServerName) {
 /**
  * Checks if conditional files are specified properly in the template
  * @private
- * @param {Object} conditionalFiles conditions specified in the template config
+ * @param {Object} conditionalGeneration conditions specified in the template config
  */
-function validateConditionalFiles(conditionalFiles) {
-  if (typeof conditionalFiles === 'object') {
-    const fileNames = Object.keys(conditionalFiles);
+function validateconditionalGeneration(conditionalGeneration) {
+  if (typeof conditionalGeneration === 'object') {
+    const fileNames = Object.keys(conditionalGeneration);
 
     fileNames.forEach(fileName => {
-      const def = conditionalFiles[fileName];
-      if (typeof def.subject !== 'string') throw new Error(`Invalid conditional file subject for ${fileName}: ${def.subject}.`);
+      const def = conditionalGeneration[fileName];
+      if (typeof def.parameter !== 'string') throw new Error(`Invalid conditional file parameter for ${fileName}: ${def.parameter}.`);
       if (typeof def.validation !== 'object') throw new Error(`Invalid conditional file validation object for ${fileName}: ${def.validation}.`);
-      conditionalFiles[fileName].validate = ajv.compile(conditionalFiles[fileName].validation);
+      conditionalGeneration[fileName].validate = ajv.compile(conditionalGeneration[fileName].validation);
     });
   }
 }

apps/generator/test/templateConfigValidator.test.js

@@ -113,28 +113,28 @@ describe('Template Configuration Validator', () => {
 
     expect(() => validateTemplateConfig(templateConfig, templateParams, asyncapiDocument)).toThrow('This template doesn\'t have any params.');
   });
-  it('Validation throw error if subject in condition files is not string', () => {
+  it('Validation throw error if parameter in condition files is not string', () => {
     const templateParams = {};
     const templateConfig  = {
-      conditionalFiles: {
+      conditionalGeneration: {
         'my/path/to/file.js': {
-          subject: ['server.protocol'],
+          parameter: ['server.protocol'],
           validation: {
             const: 'myprotocol'
           }
         }
       }
     };
 
-    expect(() => validateTemplateConfig(templateConfig, templateParams)).toThrow('Invalid conditional file subject for my/path/to/file.js: server.protocol.');
+    expect(() => validateTemplateConfig(templateConfig, templateParams)).toThrow('Invalid conditional file parameter for my/path/to/file.js: server.protocol.');
   });
 
   it('Validation throw error if validation in condition files is not object', () => {
     const templateParams = {};
     const templateConfig  = {
-      conditionalFiles: {
+      conditionalGeneration: {
         'my/path/to/file.js': {
-          subject: 'server.url',
+          parameter: 'server.url',
           validation: 'http://example.com'
         }
       }
@@ -146,9 +146,9 @@ describe('Template Configuration Validator', () => {
   it('Validation enrich conditional files object with validate object', () => {
     const templateParams = {};
     const templateConfig  = {
-      conditionalFiles: {
+      conditionalGeneration: {
         'my/path/to/file.js': {
-          subject: 'server.protocol',
+          parameter: 'server.protocol',
           validation: {
             const: 'myprotocol'
           }
@@ -157,7 +157,7 @@ describe('Template Configuration Validator', () => {
     };
     validateTemplateConfig(templateConfig, templateParams);
 
-    expect(templateConfig.conditionalFiles['my/path/to/file.js']).toBeDefined();
+    expect(templateConfig.conditionalGeneration['my/path/to/file.js']).toBeDefined();
   });
 
   it('Validation throw error if specified server is not in asyncapi document', () => {

package-lock.json

@@ -43,5 +43,8 @@
   "workspaces": [
     "apps/*",
     "packages/**"
-  ]
+  ],
+  "dependencies": {
+    "ajv": "^8.17.1"
+  }
 }