@asyncapi/generator 2.6.0 → 2.7.0

package/CHANGELOG.md

@@ -1,5 +1,141 @@
 # @asyncapi/generator
 
+## 2.7.0
+
+### Minor Changes
+
+- 802ad41: ### What's New
+
+  - Introduced a new `conditionalGeneration` configuration for templates.
+  - Supports conditional generation of both files and folders.
+  - Enables conditions based on values from the AsyncAPI document (`subject`) and custom template `parameters`.
+  - The **`parameter`** allows users to pass custom flags or values at generation time (via the CLI or programmatically) to control what parts of the template get rendered.
+  - **Addition of new config file `.ageneratorrc`**: Previously, generator configuration had to be defined in the `package.json` file. Now, you can define the configuration in a separate `.ageneratorrc` file. The configuration defined in the `.ageneratorrc` file will override any configuration defined in `package.json`. The generator will first check for the `.ageneratorrc` file in the template's root directory, and if not found, it will look for the generator config in `package.json`.
+
+  The `.ageneratorrc` file should be in YAML format.
+
+  Earlier, the `package.json` for the Python WebSocket client looked like this:
+
+  ```json
+  {
+    "name": "@asyncapi/template-python-websocket-client",
+    "version": "0.0.1",
+    "description": "This is a template generating Python websocket client",
+    // ...other configuration...
+    "generator": {
+      "renderer": "react",
+      "apiVersion": "v3",
+      "generator": ">=1.3.0 <3.0.0",
+      "parameters": {
+        "server": {
+          "description": "The name of the server described in AsyncAPI document",
+          "required": true
+        },
+        "clientFileName": {
+          "description": "The name of the generated client file",
+          "required": false,
+          "default": "client.py"
+        },
+        "appendClientSuffix": {
+          "description": "Add 'Client' suffix at the end of the class name. This option has no effect if 'customClientName' is specified.",
+          "required": false,
+          "default": false
+        },
+        "customClientName": {
+          "description": "The custom name for the generated client class",
+          "required": false
+        }
+      }
+    }
+  }
+  ```
+
+  Now after the introduction of the `.ageneratorrc` file, the `package.json` can be simplified by removing the generator configuration:
+
+  ```json
+  {
+    "name": "@asyncapi/template-python-websocket-client",
+    "version": "0.0.1",
+    "description": "This is a template generating Python websocket client",
+    "scripts": {
+      "test": "npm run test:cleanup && jest --coverage",
+      "test:update": "npm run test -- -u",
+      "test:cleanup": "rimraf \"test/temp\"",
+      "lint": "eslint --max-warnings 0 --config ../../../../../.eslintrc --ignore-path ../../../../../.eslintignore .",
+      "lint:fix": "eslint --fix --max-warnings 0 --config ../../../../../.eslintrc --ignore-path ../../../../../.eslintignore ."
+    },
+    "author": "Lukasz Gornicki <lpgornicki@gmail.com>",
+    "license": "Apache-2.0",
+    "dependencies": {
+      "@asyncapi/generator-react-sdk": "^1.1.2",
+      "@asyncapi/generator-helpers": "1.0.0"
+    },
+    "devDependencies": {
+      "@asyncapi/parser": "^3.0.14",
+      "@babel/cli": "^7.25.9",
+      "@babel/core": "^7.26.0",
+      "@babel/preset-env": "^7.26.0",
+      "@babel/preset-react": "^7.25.9",
+      "jest-esm-transformer": "^1.0.0",
+      "@asyncapi/generator": "*",
+      "eslint": "^6.8.0",
+      "eslint-plugin-jest": "^23.8.2",
+      "eslint-plugin-react": "^7.34.1",
+      "eslint-plugin-sonarjs": "^0.5.0",
+      "rimraf": "^3.0.2"
+    },
+    "jest": {
+      "moduleFileExtensions": ["js", "json", "jsx"],
+      "transform": {
+        "^.+\\.jsx?$": "babel-jest"
+      },
+      "moduleNameMapper": {
+        "^nimma/legacy$": "<rootDir>/../../../../../node_modules/nimma/dist/legacy/cjs/index.js",
+        "^nimma/(.*)": "<rootDir>/../../../../../node_modules/nimma/dist/cjs/$1"
+      }
+    },
+    "babel": {
+      "presets": [
+        "@babel/preset-env",
+        [
+          "@babel/preset-react",
+          {
+            "runtime": "automatic"
+          }
+        ]
+      ]
+    }
+  }
+  ```
+
+  And the equivalent `.ageneratorrc` file would be:
+
+  ```yaml
+  renderer: react
+  apiVersion: v3
+  generator: ">=1.3.0 <3.0.0"
+  parameters:
+    server:
+      description: The name of the server described in AsyncAPI document
+      required: true
+    clientFileName:
+      description: The name of the generated client file
+      required: false
+      default: client.py
+    appendClientSuffix:
+      description: Add 'Client' suffix at the end of the class name. This option has no effect if 'customClientName' is specified.
+      required: false
+      default: false
+    customClientName:
+      description: The custom name for the generated client class
+      required: false
+  ```
+
+  ### Deprecation notice
+
+  - The existing `conditionalFile` configuration is now deprecated and will be removed in a future release.
+  - To migrate, replace `conditionalFile` with `conditionalGeneration` in your template configuration.
+
 ## 2.6.0
 
 ### Minor Changes

package/Dockerfile

@@ -1,21 +1,20 @@
-ARG ASYNCAPI_GENERATOR_VERSION=1.10.9
-
 FROM node:18-alpine
 
+ARG ASYNCAPI_GENERATOR_VERSION=1.10.9
+
 WORKDIR /app
 
 # Since 0.14.0 release of html-template chromium is needed for pdf generation
-ENV PUPPETEER_EXECUTABLE_PATH /usr/bin/chromium-browser
-ENV PUPPETEER_SKIP_CHROMIUM_DOWNLOAD true
+ENV PUPPETEER_EXECUTABLE_PATH=/usr/bin/chromium-browser
+ENV PUPPETEER_SKIP_CHROMIUM_DOWNLOAD=true
 
 # Since 0.30.0 release Git is supported and required as a dependency
 # Since 0.14.0 release of html-template chromium is needed for pdf generation.
 # More custom packages for specific template should not be added to this dockerfile. Instead, we should come up with some extensibility solution.
+# Installing latest released npm package
 RUN apk --update add git chromium && \
-    rm -rf /var/lib/apt/lists/* && \
-    rm /var/cache/apk/*
+    rm /var/cache/apk/* && \
+    npm install --ignore-scripts -g "@asyncapi/generator@${ASYNCAPI_GENERATOR_VERSION}"
 
-# Installing latest released npm package
-RUN npm install -g @asyncapi/generator@$ASYNCAPI_GENERATOR_VERSION
 
 ENTRYPOINT [ "ag" ]

package/docs/asyncapi-document.md

@@ -68,9 +68,10 @@ function createAsyncapiFile(generator) {
 
   const outputFileName = `asyncapi.${extension}`;
 
-  const asyncapiOutputLocation = path.resolve('./'', outputFileName);
+  const asyncapiOutputLocation = path.resolve('./', outputFileName);
 
   fs.writeFileSync(asyncapiOutputLocation, asyncapi);
+}
 ```
 
 ### Method 2: `asyncapi` and template

package/docs/configuration-file.md

@@ -3,30 +3,76 @@ title: "Configuration file"
 weight: 90
 ---
 
-The `generator` property from `package.json` file must contain a JSON object that may have the following information:
+You can configure your AsyncAPI Generator template using either a dedicated `.ageneratorrc` YAML file or through the `generator` property in your `package.json` file. Previously, generator configuration had to be defined in the `package.json` file. Now, you can define the configuration in a separate `.ageneratorrc` file. The configuration defined in the `.ageneratorrc` file will override any configuration defined in `package.json`. The generator will first check for the `.ageneratorrc` file in the template's root directory, and if not found, it will look for the generator config in `package.json`.
 
-|Name|Type|Description|
-|---|---|---|
-|`renderer`| String | Its value can be either `react` or `nunjucks` (default).
-|`apiVersion`| String | Determines which **major** version of the [Parser-API](https://github.com/asyncapi/parser-api) the template uses. For example, `v2` for `v2.x.x`. If not specified, the Generator assumes the template is not compatible with the Parser-API so it will use the [Parser-JS v1 API](https://github.com/asyncapi/parser-js/tree/v1.18.1#api-documentation). For templates that need to support AsyncAPI specification v3 make sure to use `v3` [Parser-API](https://github.com/asyncapi/parser-api). If the template uses a version of the Parser-API that is not supported by the Generator, the Generator will throw an error.
-|`supportedProtocols`| [String] | A list with all the protocols this template supports.
-|`parameters`| Object[String, Object] | An object with all the parameters that can be passed when generating the template. When using the command line, it's done by indicating `--param name=value` or `-p name=value`.
-|`parameters[param].description`| String | A user-friendly description about the parameter.
-|`parameters[param].default`| Any | Default value of the parameter if not specified. Shouldn't be used for mandatory `required=true` parameters.
-|`parameters[param].required`| Boolean | Whether the parameter is required or not.
-|`conditionalFiles`| Object[String, Object] | An object containing all the file paths that should be conditionally rendered. Each key represents a file path and each value must be an object with the keys `subject` and `validation`. The file path should be relative to the `template` directory inside the template.
-|`conditionalFiles[filePath].subject`| String | The `subject` is a [JMESPath](http://jmespath.org/) query to grab the value you want to apply the condition to. It queries an object with the whole AsyncAPI document and, when specified, the given server. The object looks like this: `{ asyncapi: { ... }, server: { ... } }`. If the template supports `server` parameter, you can access server details like for example protocol this way: `server.protocol`. During validation with `conditionalFiles` only the server that template user selected is available in the specification file. For more information about `server` parameter [read about special parameters](#special-parameters).
-|`conditionalFiles[filePath].validation`| Object | The `validation` is a JSON Schema Draft 07 object. This JSON Schema definition will be applied to the JSON value resulting from the `subject` query. If validation doesn't have errors, the condition is met, and therefore the given file will be rendered. Otherwise, the file is ignored. Check [JSON Schema Validation](https://json-schema.org/draft-07/json-schema-validation.html#rfc.section.6) document for a list of all possible validation keywords.
-|`nonRenderableFiles`| [String] | A list of file paths or [globs](https://en.wikipedia.org/wiki/Glob_(programming)) that must be copied "as-is" to the target directory, i.e., without performing any rendering process. This is useful when you want to copy binary files.
-|`generator`| [String] | A string representing the generator version-range the template is compatible with. This value must follow the [semver](https://nodejs.dev/learn/semantic-versioning-using-npm) syntax. E.g., `>=1.0.0`, `>=1.0.0 <=2.0.0`, `~1.0.0`, `^1.0.0`, `1.0.0`, etc. [Read more about semver](https://docs.npmjs.com/about-semantic-versioning).
-|`filters`| [String] | A list of modules containing functions that can be used as Nunjucks filters. In case of external modules, remember they need to be added as a dependency in `package.json` of your template.
-|`hooks`| Object[String, String] or Object[String, Array[String]] | A list of modules containing hooks, except for the ones you keep locally in your template in the default location. For each module you must specify the exact name of the hook that should be used in the template. For a single hook, you can specify it as a string; for more hooks, you must pass an array of strings. In the case of external modules, remember they need to be added as a dependency in `package.json` of your template. There is also [an official hooks library](hooks#official-library) always included in the generator. As this is a library of multiple hooks, you still need to explicitly specify in the configuration which one you want to use. Use `@asyncapi/generator-hooks` as the library name.
 
-### Example
+## Configuration Methods
+
+### Option 1: Using `.ageneratorrc` file (Recommended)
+
+Create a `.ageneratorrc` file in the root of your template with YAML syntax. This approach keeps your template configuration separate from package metadata:
+
+```yaml
+renderer: react
+apiVersion: v3
+supportedProtocols:
+  - amqp
+  - mqtt
+
+parameters:
+  server:
+    description: The server you want to use in the code.
+    required: true
+  dummyParameter:
+    description: Example of parameter with default value.
+    default: just a string
+    required: false
+
+conditionalFiles:
+  path/to/file/that/is/relative/to/template/dir/test-amqp.js:
+    subject: server.protocol
+    validation:
+      const: amqp
+  path/to/file/that/is/relative/to/template/dir/support.html:
+    subject: info.contact
+    validation:
+      required:
+        - url
+
+conditionalGeneration:
+  conditionalOnFile.js:
+    parameter: singleFile
+    validation:
+      not:
+        const: true
+  conditionOnFolderInfo:
+    subject: info.contact.name
+    validation:
+      const: API Support
+
+nonRenderableFiles:
+  - src/api/middlewares/*.*
+  - lib/lib/config.js
+
+generator: "<2.0.0"
+
+filters:
+  - my-package-with-filters
+
+hooks:
+  '@asyncapi/generator-hooks': hookFunctionName
+  my-custom-hooks-package:
+    - myHook
+    - andAnotherOne
+
+```
+
+### Option 2: Using `package.json`
+
+Alternatively, you can include your configuration in the `generator` property of your `package.json` file:
 
 ```json
-"generator":
-{
+"generator": {
   "renderer": "react",
   "apiVersion": "v3",
   "supportedProtocols": ["amqp", "mqtt"],
@@ -41,26 +87,32 @@ The `generator` property from `package.json` file must contain a JSON object tha
       "required": false
     }
   },
-  "conditionalFiles": {
-    "path/to/file/that/is/relative/to/template/dir/test-amqp.js": {
-      "subject": "server.protocol",
-      "validation": {
-        "const": "amqp"
+  "conditionalGeneration": {
+     "conditionalOnFile.js": { 
+       "parameter": "singleFile", 
+       "validation": {
+          "not": { "const": "true" } 
+      }
+    },
+     "conditionOnFolder": {
+       "parameter": "singleFolder", 
+       "validation": {
+          "not": { "const": "true" } 
       }
     },
-    "path/to/file/that/is/relative/to/template/dir/support.html": {
-      "subject": "info.contact",
-        "validation": {
-          "required": ["url"]
+     "conditionOnFolderInfo": {
+       "subject": "info.contact.name",
+       "validation": {
+            "const": "API Support"
         }
-    }
+    },
   },
   "nonRenderableFiles": [
     "src/api/middlewares/*.*",
     "lib/lib/config.js"
   ],
   "generator": "<2.0.0",
-  "filters":[
+  "filters": [
     "my-package-with-filters"
   ],
   "hooks": {
@@ -70,12 +122,39 @@ The `generator` property from `package.json` file must contain a JSON object tha
 }
 ```
 
+> **Note:** If both `.ageneratorrc` file and the `generator` property in `package.json` exist, the configuration from `.ageneratorrc` will override the `package.json` configuration.
+
+The `generator` property from `package.json` file and must contain a JSON object and the `ageneratorrc` file must contain a YAML object that may have the following information:
+
+
+|Name|Type|Description|
+|---|---|---|
+|`renderer`| String | Its value can be either `react` or `nunjucks` (default).
+|`apiVersion`| String | Determines which **major** version of the [Parser-API](https://github.com/asyncapi/parser-api) the template uses. For example, `v2` for `v2.x.x`. If not specified, the Generator assumes the template is not compatible with the Parser-API so it will use the [Parser-JS v1 API](https://github.com/asyncapi/parser-js/tree/v1.18.1#api-documentation). For templates that need to support AsyncAPI specification v3 make sure to use `v3` [Parser-API](https://github.com/asyncapi/parser-api). If the template uses a version of the Parser-API that is not supported by the Generator, the Generator will throw an error.
+|`supportedProtocols`| [String] | A list with all the protocols this template supports.
+|`parameters`| Object[String, Object] | An object with all the parameters that can be passed when generating the template. When using the command line, it's done by indicating `--param name=value` or `-p name=value`.
+|`parameters[param].description`| String | A user-friendly description about the parameter.
+|`parameters[param].default`| Any | Default value of the parameter if not specified. Shouldn't be used for mandatory `required=true` parameters.
+|`parameters[param].required`| Boolean | Whether the parameter is required or not.
+| `conditionalFiles` | Object[String, Object] | An object containing all the file paths that should be conditionally rendered. Each key represents a file path and each value must be an object with the keys `subject` and `validation`. The file path should be relative to the `template` directory inside the template. **Note: It is deprecated and will be removed with future releases. Use `conditionalGeneration` instead.** |
+| `conditionalFiles[filePath].subject` | String | The `subject` is a [JMESPath](http://jmespath.org/) query to grab the value you want to apply the condition to. It queries an object with the whole AsyncAPI document and, when specified, the given server. The object looks like this: `{ asyncapi: { ... }, server: { ... } }`. If the template supports the `server` parameter, you can access server details, for example, `server.protocol`. During validation with `conditionalFiles`, only the server that the template user selected is available in the specification file. For more information about `server` parameter [read about special parameters](#special-parameters). **Note: It is deprecated and will be removed with future releases. Use `conditionalGeneration` instead.** |
+| `conditionalFiles[filePath].validation` | Object | The `validation` is a JSON Schema Draft 07 object. This JSON Schema definition will be applied to the JSON value resulting from the `subject` query. If validation doesn't have errors, the condition is met, and therefore the given file will be rendered. Otherwise, the file is ignored. Check [JSON Schema Validation](https://json-schema.org/draft-07/json-schema-validation.html#rfc.section.6) for a list of all possible validation keywords. **Note: It is deprecated and will be removed with future releases. Use `conditionalGeneration` instead.** |
+|`conditionalGeneration` | Object[String, { subject?: String, parameter?: String, validation: Object }] | An object containing all the file paths or directory names that should be conditionally rendered. Each key represents a file path or directory name and each value must be an object with the keys `subject`, `parameter` and `validation`. You can use either subject or parameter according to the use case. The path should be relative to the `template` directory inside the template. **Note: conditionalGeneration and conditionalFile are mutually exclusive, which means both cannot be configured at the same time in the template**. |
+|`conditionalGeneration[filePath/directoryName].subject`| String | The `subject` is a [JMESPath](http://jmespath.org/) query to grab the value you want to apply the condition to. It queries an object with the whole AsyncAPI document and, when specified, the given server. The object looks like this: `{ asyncapi: { ... }, server: { ... } }`. If the template supports the `server` parameter, you can access server details like, for example, protocol this way: `server.protocol`. During validation with `conditionalGeneration`, only the server that the template user selected is available in the specification file. For more information about the `server` parameter [read about special parameters](#special-parameters). |
+|`conditionalGeneration[filePath/directoryName].parameter`| String | The `parameter` is the name of a custom template parameter passed through `templateParams` that controls whether a specific file or folder should be included in the generated output. You must define a `validation` rule using a JSON Schema fragment to apply the condition. For example, if you define `"parameter": "includeDocs"` with `"validation": { "const": true }`, the corresponding folder (e.g., `docs/`) will only be generated when the user passes `{ includeDocs: true }`. If `includeDocs` is `false`, it will be skipped. |
+|`conditionalGeneration[filePath/directoryName].validation`| Object (JSON Schema fragment) | The validation defines the condition under which the file or directory will be generated. It must be a valid JSON Schema fragment that validates the value of the parameter. For example, if you want to include a folder only when includeDocs is true, use "validation": { "const": true }. You can also use more complex validation logic, like "enum": ["yes", "true"] or "type": "string" with a "pattern" constraint. If the parameter fails validation, the file or folder will not be included in the generated output. This allows for powerful and flexible control over template generation based on user input. |
+|`nonRenderableFiles`| [String] | A list of file paths or [globs](https://en.wikipedia.org/wiki/Glob_(programming)) that must be copied "as-is" to the target directory, i.e., without performing any rendering process. This is useful when you want to copy binary files.
+|`generator`| [String] | A string representing the generator version-range the template is compatible with. This value must follow the [semver](https://nodejs.dev/learn/semantic-versioning-using-npm) syntax. E.g., `>=1.0.0`, `>=1.0.0 <=2.0.0`, `~1.0.0`, `^1.0.0`, `1.0.0`, etc. [Read more about semver](https://docs.npmjs.com/about-semantic-versioning).
+|`filters`| [String] | A list of modules containing functions that can be used as Nunjucks filters. In case of external modules, remember they need to be added as a dependency in `package.json` of your template.
+|`hooks`| Object[String, String] or Object[String, Array[String]] | A list of modules containing hooks, except for the ones you keep locally in your template in the default location. For each module you must specify the exact name of the hook that should be used in the template. For a single hook, you can specify it as a string; for more hooks, you must pass an array of strings. In the case of external modules, remember they need to be added as a dependency in `package.json` of your template. There is also [an official hooks library](hooks#official-library) always included in the generator. As this is a library of multiple hooks, you still need to explicitly specify in the configuration which one you want to use. Use `@asyncapi/generator-hooks` as the library name.
+
+---
+
 ## Special parameters
 
 There are some template parameters that have a special meaning:
 
 |Name|Description|
 |---|---|
-|`server`| It is used to let the template know which server from the AsyncAPI specification file you want to use. In some cases, this may be required. For instance, when generating code that connects to a specific server. Use this parameter in case your template relies on users' information about what server from the specification file they want to use during generation. You also need this parameter if you want to use `server.protocol` notation within `conditionalFiles` configuration option. Once you decide to specify this parameter for your template, it is recommended you make it a mandatory parameter otherwise a feature like `conditionalFiles` is not going to work if your users do not use this parameter obligatory.
-
+|`server`| It is used to let the template know which server from the AsyncAPI specification file you want to use. In some cases, this may be required. For instance, when generating code that connects to a specific server. Use this parameter in case your template relies on users' information about what server from the specification file they want to use during generation. You also need this parameter if you want to use `server.protocol` notation within `conditionalGeneration` configuration option. Once you decide to specify this parameter for your template, it is recommended you make it a mandatory parameter otherwise a feature like `conditionalGeneration` is not going to work if your users do not use this parameter obligatory.