@asyncapi/generator 2.4.0 → 2.5.0

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # @asyncapi/generator
 
+## 2.5.0
+
+### Minor Changes
+
+- 2d16234: - Package `@asyncapi/generator-hooks` is now part of `generator` repo and won't be released separately. Theource code is stored under `apps/hooks` but the `package/library` name stays as it was originally for backward compatibility,
+  - By default, the `@asyncapi/generator-hooks` package, known as **package** contains many different hooks used in templates and is available in the generator. You no longer have to configure it in your `package.json` in `dependencies`. The package, `@asyncapi/generator-hooks` will no longer be published to NPM separately and is deprecated. You can still have your own hooks, store them in a separate package, and configure them with your template.
+  - Remember that the fact that the hooks package is now included by default, doesn't mean all hooks from it are enabled by default. You still have to enable a given hook in the configuration file explicitly because some hooks can execute automatically without passing a specific parameter. Also, a hook's supported parameters need to be defined in your template's config.
+
+## 2.4.1
+
+### Patch Changes
+
+- 3a372c4: Removed the source-map-support package from the AsyncAPI Generator, as it is no longer required for version 2, which now supports Node.js version 18.12.0 and above.
+
 ## 2.4.0
 
 ### Minor Changes

package/docs/configuration-file.md

@@ -20,7 +20,7 @@ The `generator` property from `package.json` file must contain a JSON object tha
 |`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 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 you must pass an array of strings. 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
 
@@ -64,7 +64,8 @@ The `generator` property from `package.json` file must contain a JSON object tha
     "my-package-with-filters"
   ],
   "hooks": {
-    "@asyncapi/generator-hooks": "hookFunctionName"
+    "@asyncapi/generator-hooks": "hookFunctionName",
+    "my-custom-hooks-package": ["myHook", "andAnotherOne"]
   }
 }
 ```

package/docs/file-templates.md

@@ -3,7 +3,11 @@ title: "File templates"
 weight: 140
 ---
 
-It is possible to generate files for each specific object in your AsyncAPI documentation. For example, you can specify a filename like `$$channel$$.js` to generate a file for each channel defined in your AsyncAPI. The following file-template names and extra variables in them are available:
+## Generating files with the Nunjucks render engine
+
+> **Note**: This section applies only to the Nunjucks render engine. For information on using the React render engine, refer to the [Generating files with the React render engine](#generating-files-with-the-react-render-engine) section below.
+
+It is possible to generate files for each specific object in your AsyncAPI documentation using the Nunjucks render engine. For example, you can specify a filename like `$$channel$$.js` to generate a file for each channel defined in your AsyncAPI. The following file-template names and extra variables are available:
 
    - `$$channel$$`, within the template-file you have access to two variables [`channel`](https://github.com/asyncapi/parser-api/blob/master/docs/api.md#channel) and [`channelName`](https://github.com/asyncapi/parser-api/blob/master/docs/api.md#channels). Where the `channel` contains the current channel being rendered.
    - `$$message$$`, within the template-file you have access to two variables [`message`](https://github.com/asyncapi/parser-api/blob/master/docs/api.md#message) and [`messageName`](https://github.com/asyncapi/parser-api/blob/master/docs/api.md#message). Where `message` contains the current message being rendered.
@@ -25,7 +29,7 @@ Schema name is '{{schemaName}}' and properties are:
 {% endfor %}
 ```
 
-With following AsyncAPI:
+With the following AsyncAPI:
 ```
 components:
   schemas: 
@@ -53,15 +57,82 @@ Schema name is 'people' and properties are:
 - id
 ```
 
-### React
+> You can see an example of a file template that uses the Nunjucks render engine [here](https://github.com/asyncapi/template-for-generator-templates/tree/nunjucks/template/schemas).
+
+## Generating files with the React render engine
 
-The above way of rendering **file templates** works for both `nunjucks` and `react` render engines, but `react` also has another, more generic way to render multiple files. It is enough to return an array of `File` components in the rendering component. See the following example:
+The above method of rendering **file templates** only works for the Nunjucks render engine. To use the React render engine, you need to follow a different approach. The React render engine allows for a more generic way to render multiple files by returning an array of `File` components in the rendering component. This can be particularly useful for complex templates or when you need to generate a large number of files with varying content.
+
+### Example 1: Rendering hardcoded files
+
+The following is a simple hardcoded example of how to render multiple files using the React render engine:
 
 ```tsx
+import { File} from "@asyncapi/generator-react-sdk";
+
 export default function({ asyncapi }) {
   return [
     <File name={`file1.html`}>Content</File>,
     <File name={`file2.html`}>Content</File>
   ]
 }
-```
+```
+
+### Example 2: Rendering files based on the AsyncAPI Schema
+
+In practice, to render the multiple files, that are generated from the data defined in your AsyncAPI, you'll iterate over the array of schemas and generate a file for each schema as shown in the example below:
+
+```js
+import { File} from "@asyncapi/generator-react-sdk";
+
+/*
+ * To render multiple files, it is enough to return an array of `File` components in the rendering component, like in following example.
+ */
+export default function({ asyncapi }) {
+  const schemas = asyncapi.allSchemas();
+  const files = [];
+  // schemas is an instance of the Map
+  schemas.forEach((schema) => {
+    
+    files.push(
+      // We return a react file component and each time we do it, the name of the generated file will be a schema name
+      // Content of the file will be a variable representing schema
+      <File name={`${schema.id()}.js`}>
+        const { schema.id() } = { JSON.stringify(schema._json, null, 2) }
+      </File>
+    );
+  });
+  return files;
+}
+```
+
+### Example 3: Rendering files for each channel
+
+Additionally, you can generate multiple files for each channel defined in your AsyncAPI specification using the React render engine as shown in the example below:
+
+```js
+import { File, Text } from "@asyncapi/generator-react-sdk";
+
+
+export default function ({ asyncapi }) {
+  const files = [];
+
+  // Generate files for channels
+  asyncapi.channels().forEach((channel) => {
+    const channelName = channel.id();
+
+    files.push(
+      <File name={`${channelName}.md`}>
+        <Text newLines={2}># Channel: {channelName}</Text>
+        <Text>
+          {channel.hasDescription() && `${channel.description()}`}
+        </Text>
+      </File>
+    );
+  });
+  return files;
+}
+```
+The code snippet above uses the `Text` component to write file content to the `.md` markdown file. The `newline` property is used to ensure that the content isn't all rendered in one line in the markdown file. In summary, the code snippet above is a practical guide on generating properly formatted multiline Markdown files for each channel in an AsyncAPI document.
+
+> You can see an example of a file template that uses the React render engine [here](https://github.com/asyncapi/template-for-generator-templates/blob/master/template/schemas/schema.js).

package/docs/generator-template.md

@@ -159,7 +159,7 @@ To see this in action, navigate to the **python-mqtt-client-template** directory
 
 ``` cmd
 Generation in progress. Keep calm and wait a bit... done
-Check out your shiny new generated files at output.
+Check out your shiny new generated files at test/project.
 ```
 
 Navigating to the **test/project** directory. You should see a **client.py** file; the only content is `Temperature Service`.

package/docs/hooks.md

@@ -4,21 +4,26 @@ weight: 130
 ---
 
 Hooks are functions called by the generator on a specific moment in the generation process. Hooks can be anonymous functions but you can also add function names. These hooks can have arguments provided to them or being expected to return a value.
+
+## Types
+
 The following types of hooks are currently supported:
 
 |Hook type|Description| Return type | Arguments 
 |---|---|---|---|
-| `generate:before` | Called after registration of all filters and before the generator starts processing of the template. | void : Nothing is expected to be returned. | [The generator instance](https://github.com/asyncapi/generator/blob/master/docs/api.md)
-| `generate:after` | Called at the very end of the generation. | void : Nothing is expected to be returned. | [The generator instance](https://github.com/asyncapi/generator/blob/master/docs/api.md)
-| `setFileTemplateName ` | Called right before saving a new file generated by [file template](./file-templates.md). | string : a new filename for the generator to use for the file template. | [The generator instance](https://github.com/asyncapi/generator/blob/master/docs/api.md) and object in the form of `{ "originalFilename" : string }`
+| `generate:before` | Called after registration of all filters and before the generator starts processing of the template. | void : Nothing is expected to be returned. | [The generator instance](/api)
+| `generate:after` | Called at the very end of the generation. | void : Nothing is expected to be returned. | [The generator instance](/api)
+| `setFileTemplateName ` | Called right before saving a new file generated by [file template](./file-templates.md). | string : a new filename for the generator to use for the file template. | [The generator instance](/api) and object in the form of `{ "originalFilename" : string }`
+
+## Location
 
 The generator parses:
 - All the files in the `.hooks` directory inside the template.
-- All modules listed in the template configuration and triggers only hooks that names were added to the config. You can use the official AsyncAPI [hooks library](https://github.com/asyncapi/generator-hooks). To learn how to add hooks to configuration [read more about the configuration file](https://www.asyncapi.com/docs/tools/generator/configuration-file).
+- All modules listed in the template configuration and triggers only hooks whose names were added to the config. You can use an [official hooks library](#official-library) that is bundled together with the generator. To learn how to add hooks to configuration [read more about the configuration file](configuration-file).
 
-### Examples
+## Examples
 
-> Some of the examples have names of hook functions provided and some not. Keep in mind that hook functions kept in template in default location do not require a name. Name is required only if you keep hooks in non default location or in a separate library, because such hooks need to be explicitly configured in the configuration file. For more details on hooks configuration [read more about the configuration file](https://www.asyncapi.com/docs/tools/generator/configuration-file).
+> Some of the examples have names of hook functions provided and some not. Keep in mind that hook functions kept in template in default location do not require a name. Name is required only if you keep hooks in non default location or in a separate library, because such hooks need to be explicitly configured in the configuration file. For more details on hooks configuration [read more about the configuration file](configuration-file).
 
 Most basic modules with hooks look like this:
 ```js
@@ -79,3 +84,35 @@ module.exports = {
 	};
 };
 ```
+
+## Official library
+
+It is a library of reusable hooks that you can use in your templates. You only have to add its name to the configuration: `@asyncapi/generator-hooks` and specify which hook you want to enable.
+
+This library consists of the following hooks:
+|Hook name|Hook type|Description|
+|---|---|---|
+| `createAsyncapiFile` | `generate:after` | It creates an AsyncAPI file with the content of the spec file passed to the generator. By default, it creates the file in the root of the generation output directory. This hook also supports custom parameters that the user can pass to template generation. The parameter called `asyncapiFileDir` allows the user to specify the location where the spec file should be created. To make your template users use this parameter, you need to add it to the configuration of your template like other parameters |
+
+1. In your template configuration in `package.json` specify you want to use this library and what hook exactly:
+    ```json
+    {
+      "generator": {
+          "hooks": {
+              "@asyncapi/generator-hooks": "createAsyncapiFile"
+          }
+      }
+    }
+    ```
+1. Some hooks support custom parameters that template's user can use to specify different behaviour of the hook. To enable these, you need to also add them to the list of your template's parameters:
+    ```json
+    {
+      "generator": {
+          "parameters": {
+            "asyncapiFileDir": {
+                "description": "This template by default also outputs the AsyncAPI document that was passed as input. You can specify with this parameter what should be the location of this AsyncAPI document, relative to specified template output."
+            }
+        }
+      }
+    }
+    ```

package/lib/generator.js

@@ -27,7 +27,6 @@ const {
   fetchSpec,
   isReactTemplate,
   isJsFile,
-  registerSourceMap,
   getTemplateDetails,
   convertCollectionToObject,
 } = require('./utils');
@@ -57,8 +56,6 @@ const shouldIgnoreDir = dirPath =>
   dirPath === '.git'
   || dirPath.startsWith(`.git${path.sep}`);
 
-registerSourceMap();
-
 class Generator {
   /**
    * Instantiates a new Generator object.
@@ -137,7 +134,7 @@ class Generator {
       Object.defineProperty(this.templateParams, key, {
         enumerable: true,
         get() {
-          if (!self.templateConfig.parameters || !self.templateConfig.parameters[key]) {
+          if (!self.templateConfig.parameters?.[key]) {
             throw new Error(`Template parameter "${key}" has not been defined in the package.json file under generator property. Please make sure it's listed there before you use it in your template.`);
           }
           return templateParams[key];
@@ -565,8 +562,8 @@ class Generator {
 
       try {
         installedPkg = getTemplateDetails(this.templateName, PACKAGE_JSON_FILENAME);
-        pkgPath = installedPkg && installedPkg.pkgPath;
-        packageVersion = installedPkg && installedPkg.version;
+        pkgPath = installedPkg?.pkgPath;
+        packageVersion = installedPkg?.version;
         log.debug(logMessage.templateSource(pkgPath));
         if (packageVersion) log.debug(logMessage.templateVersion(packageVersion));
 
@@ -762,7 +759,7 @@ class Generator {
     // Check if the filename dictates it should be separated
     let wasSeparated = false;
     for (const prop in fileNamesForSeparation) {
-      if (Object.prototype.hasOwnProperty.call(fileNamesForSeparation, prop) && stats.name.includes(`$$${prop}$$`)) {
+      if (Object.hasOwn(fileNamesForSeparation, prop) && stats.name.includes(`$$${prop}$$`)) {
         await this.generateSeparateFiles(asyncapiDocument, fileNamesForSeparation[prop], prop, stats.name, root);
         const templateFilePath = path.relative(this.templateContentDir, path.resolve(root, stats.name));
         fs.unlink(path.resolve(this.targetDir, templateFilePath), next);
@@ -878,7 +875,7 @@ class Generator {
     const shouldOverwriteFile = await this.shouldOverwriteFile(relativeTargetFile);
     if (!shouldOverwriteFile) return;
 
-    if (this.templateConfig.conditionalFiles && this.templateConfig.conditionalFiles[relativeSourceFile]) {
+    if (this.templateConfig.conditionalFiles?.[relativeSourceFile]) {
       const server = this.templateParams.server && asyncapiDocument.servers().get(this.templateParams.server);
       const source = jmespath.search({
         ...asyncapiDocument.json(),

package/lib/logMessages.js

@@ -2,7 +2,7 @@ const TEMPLATE_INSTALL_FLAG_MSG = 'because you passed --install flag';
 
 const TEMPLATE_INSTALL_DISK_MSG = 'because the template cannot be found on disk';
 
-const NODE_MODULES_INSTALL ='Remember that your local template must have its own node_modules installed first, \"npm install\" is not triggered by the generator.';
+const NODE_MODULES_INSTALL = 'Remember that your local template must have its own node_modules installed first, "npm install" is not triggered by the generator.';
 
 const NPM_INSTALL_TRIGGER = 'Installation of template located on disk technically means symlink creation betweed node_modules of the generator and template sources. Your local template must have its own node_modules, "npm install" is not triggered.';
 
@@ -19,7 +19,7 @@ function templateNotFound(templateName) {
 }
 
 function packageNotAvailable(packageDetails) {
-  if (packageDetails && packageDetails.pkgPath) {
+  if (packageDetails?.pkgPath) {
     return `Unable to resolve template location at ${packageDetails.pkgPath}. Package is not available locally.`;
   }
 

package/lib/parser.js

@@ -63,7 +63,7 @@ function convertOldOptionsToNew(oldOptions, generator) {
   }
 
   const resolvers = [];
-  if (generator && generator.mapBaseUrlToFolder && generator.mapBaseUrlToFolder.url) {
+  if (generator?.mapBaseUrlToFolder?.url) {
     resolvers.push(...getMapBaseUrlToFolderResolvers(generator.mapBaseUrlToFolder));
   }
   if (oldOptions.resolve) {

package/lib/templateConfigValidator.js

@@ -97,7 +97,7 @@ function getParamSuggestion(wrongParam, configParams) {
  * @param {Object} templateParams All parameters provided to generator
  */
 function isProvidedParameterSupported(configParams, templateParams) {
-  const wrongParams = Object.keys(templateParams || {}).filter(key => !configParams || !configParams[key]);
+  const wrongParams = Object.keys(templateParams || {}).filter(key => !configParams?.[key]);
 
   if (!wrongParams.length) return;
   if (!configParams) throw new Error('This template doesn\'t have any params.');

package/lib/utils.js

@@ -131,17 +131,7 @@ utils.getGeneratorVersion = () => {
  * @returns {Boolean} is function asynchronous
  */
 utils.isAsyncFunction = (fn) => {
-  return fn && fn.constructor && fn.constructor.name === 'AsyncFunction';
-};
-
-/**
- * Register `source-map-support` package.
- * This package provides source map support for stack traces in Node - also for transpiled code from TS.
- *
- * @private
- */
-utils.registerSourceMap = () => {
-  require('source-map-support').install();
+  return fn?.constructor?.name === 'AsyncFunction';
 };
 
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@asyncapi/generator",
-  "version": "2.4.0",
+  "version": "2.5.0",
   "description": "The AsyncAPI generator. It can generate documentation, code, anything!",
   "main": "./lib/generator.js",
   "bin": {
@@ -49,9 +49,10 @@
   "license": "Apache-2.0",
   "homepage": "https://github.com/asyncapi/generator",
   "dependencies": {
-    "@asyncapi/generator-react-sdk": "^1.1.1",
+    "@asyncapi/generator-react-sdk": "^1.1.2",
     "@asyncapi/multi-parser": "^2.1.1",
     "@asyncapi/nunjucks-filters": "*",
+    "@asyncapi/generator-hooks": "*",
     "@asyncapi/parser": "^3.0.14",
     "@npmcli/arborist": "5.6.3",
     "@npmcli/config": "^8.0.2",
@@ -73,7 +74,6 @@
     "resolve-pkg": "^2.0.0",
     "semver": "^7.3.2",
     "simple-git": "^3.3.0",
-    "source-map-support": "^0.5.19",
     "ts-node": "^10.9.1",
     "typescript": "^4.9.3"
   },
@@ -82,11 +82,11 @@
     "eslint-plugin-jest": "^23.8.2",
     "eslint-plugin-react": "^7.34.1",
     "eslint-plugin-sonarjs": "^0.5.0",
+    "fs-extra": "9.1.0",
     "jest": "^27.3.1",
     "jsdoc-to-markdown": "^7.1.1",
     "markdown-toc": "^1.2.0",
     "rimraf": "^3.0.2",
-    "unixify": "^1.0.0",
-    "fs-extra": "9.1.0"
+    "unixify": "^1.0.0"
   }
 }

package/test/__snapshots__/integration.test.js.snap

@@ -14,6 +14,400 @@ Version v1 running on production mode
 "
 `;
 
+exports[`Integration testing generateFromFile() to make sure the result of the generation is not changend comparing to snapshot generate using React template 2`] = `
+"asyncapi: '2.3.0'
+
+externalDocs:
+  description: Find more info here
+  url: https://www.asyncapi.com
+
+info:
+  title: Dummy example with all spec features included
+  version: '0.0.1'
+  description: |
+    This is an example of AsyncAPI specification file that is suppose to include all possible features of the AsyncAPI specification. Do not use it on production.
+
+    It's goal is to support development of documentation and code generation with the [AsyncAPI Generator](https://github.com/asyncapi/generator/) and [Template projects](https://github.com/search?q=topic%3Aasyncapi+topic%3Agenerator+topic%3Atemplate)
+  license:
+    name: Apache 2.0
+    url: https://www.apache.org/licenses/LICENSE-2.0
+  contact:
+    name: API Support
+    url: http://www.asyncapi.com/support
+    email: info@asyncapi.io
+  x-twitter: '@AsyncAPISpec'
+
+tags:
+  - name: root-tag1
+    externalDocs:
+      description: External docs description 1
+      url: https://www.asyncapi.com/
+  - name: root-tag2
+    description: Description 2
+    externalDocs:
+      url: \\"https://www.asyncapi.com/\\"
+  - name: root-tag3
+  - name: root-tag4
+    description: Description 4
+  - name: root-tag5
+    externalDocs:
+      url: \\"https://www.asyncapi.com/\\"
+
+servers:
+  dummy-mqtt:
+    $ref: '#/components/servers/dummyMQTT'
+  dummy-amqp:
+    url: amqp://localhost:{port}
+    protocol: amqp
+    description: dummy AMQP broker
+    protocolVersion: \\"0.9.1\\"
+    variables:
+      port:
+        enum:
+          - '15672'
+          - '5672'
+    security:
+      - user-password: []
+  dummy-kafka:
+    url: http://localhost:{port}
+    protocol: kafka
+    description: dummy Kafka broker
+    variables:
+      port:
+        default: '9092'
+
+defaultContentType: application/json
+
+channels:
+  dummy/channel/with/{dummy}/parameter/create:
+    x-dummy-security:
+      $ref: '#/components/securitySchemes/supportedOauthFlows/flows/clientCredentials'
+    description: Dummy channel description.
+    parameters:
+      dummy:
+        $ref: '#/components/parameters/dummy'
+    publish:
+      summary: Inform whenever something dummy is created.
+      description: |
+        Longer description.
+
+        Still dummy though.
+      operationId: receiveNewDummyInfo
+      tags:
+        - name: oparation-tag1
+          externalDocs:
+            description: External docs description 1
+            url: https://www.asyncapi.com/
+        - name: oparation-tag2
+          description: Description 2
+          externalDocs:
+            url: \\"https://www.asyncapi.com/\\"
+        - name: oparation-tag3
+        - name: oparation-tag4
+          description: Description 4
+        - name: oparation-tag5
+          externalDocs:
+            url: \\"https://www.asyncapi.com/\\"
+      traits:
+        - $ref: '#/components/operationTraits/kafka'
+      message:
+        $ref: '#/components/messages/dummyCreated'
+
+  dummy/channel/without/parameter:
+    $ref: '#/components/channels/dummyChannel'
+components:
+  servers: 
+    dummyMQTT:
+      url: mqtt://localhost
+      protocol: mqtt
+      description: dummy MQTT broker
+      bindings:
+          mqtt:
+            clientId: guest
+            cleanSession: true
+  channels:
+    dummyChannel:
+      bindings:
+        amqp:
+          is: routingKey
+      subscribe:
+        operationId: receiveSystemInfo
+        bindings:
+          amqp:
+            expiration: 100000
+            userId: guest
+            cc: [ 'user.logs' ]
+            priority: 10
+            deliveryMode: 2
+            mandatory: false
+            bcc: [ 'external.audit' ]
+            replyTo: user.signedup
+            timestamp: true
+            ack: false
+            bindingVersion: 0.1.0
+        message:
+          $ref: '#/components/messages/dummyInfo'
+  messages:
+    dummyCreated:
+      name: dummyCreated
+      title: Dummy created message
+      summary: This is just a dummy create message
+      correlationId:
+        description: This is a dummy correlation ID.
+        location: $message.header#/correlationId
+      tags:
+        - name: message-tag1
+          externalDocs:
+            description: External docs description 1
+            url: https://www.asyncapi.com/
+        - name: message-tag2
+          description: Description 2
+          externalDocs:
+            url: \\"https://www.asyncapi.com/\\"
+        - name: message-tag3
+        - name: message-tag4
+          description: Description 4
+        - name: message-tag5
+          externalDocs:
+            url: \\"https://www.asyncapi.com/\\"
+      headers:
+        type: object
+        properties:
+          my-custom-app-header:
+            type: string
+          correlationId:
+            type: string
+      payload:
+        $ref: \\"#/components/schemas/dummyCreated\\"
+      bindings:
+        kafka:
+          key:
+            type: object
+            properties:
+              id:
+                type: string
+                format: uuid
+              type:
+                type: string
+                enum: [ 'type1', \\"type2\\" ]
+          bindingVersion: '0.1.0'
+        amqp:
+          contentEncoding: gzip
+          messageType: 'user.signup'
+          bindingVersion: 0.1.0
+      x-response:
+        $ref: \\"#/components/messages/dummyInfo\\"
+    dummyInfo:
+      name: dummyInfo
+      title: Dummy system info
+      summary: This is just a dummy info message
+      correlationId:
+        location: $message.header#/correlationId
+      description: |
+        More description for a dummy message.
+
+        It is a dummy system info message.
+      traits:
+        - $ref: '#/components/messageTraits/commonHeaders'
+      payload:
+        $ref: \\"#/components/schemas/dummyInfo\\"
+      examples:
+        - name: option1example
+          summary: this is dummy summary for option1example
+          headers:
+            my-app-header: 12
+          payload:
+            prop1: option1
+            sentAt: 2020-01-31T13:24:53Z
+        - name: headerExample
+          headers:
+            my-app-header: 13
+        - payload:
+            prop1: option2
+            sentAt: 2020-01-31T13:24:53Z
+
+
+  schemas:
+    dummyCreated:
+      type: object
+      required:
+        - prop2
+      x-schema-extensions-as-object:
+            type: object
+            properties:
+              prop1:
+                type: string
+              prop2:
+                type: integer
+                minimum: 0
+      x-schema-extensions-as-primitive: dummy
+      x-schema-extensions-as-array:
+        - \\"item1\\"
+        - \\"item2\\"
+      properties:
+        prop1:
+          type: integer
+          minimum: 0
+          description: Dummy prop1
+          x-prop1-dummy: dummy extension
+        prop2:
+          type: string
+          description: Dummy prop2
+        sentAt:
+          $ref: \\"#/components/schemas/sentAt\\"
+        dummyArrayWithObject:
+          $ref: \\"#/components/schemas/dummyArrayWithObject\\"
+        dummyArrayWithArray:
+          $ref: \\"#/components/schemas/dummyArrayWithArray\\"
+        dummyObject:
+          $ref: \\"#/components/schemas/dummyObject\\"
+        dummyArrayRank:
+          $ref: '#/components/schemas/dummyArrayRank'
+    dummyInfo:
+      type: object
+      required:
+        - prop1
+      properties:
+        prop1:
+          type: string
+          enum:
+            - option1
+            - option2
+          description: Dummy prop1
+        sentAt:
+          $ref: \\"#/components/schemas/sentAt\\"
+    dummyArrayWithObject:
+      type: array
+      items:
+        $ref: \\"#/components/schemas/dummyInfo\\"
+    dummyArrayWithArray:
+      type: array
+      items:
+        - $ref: \\"#/components/schemas/dummyInfo\\"
+        - type: string
+        - type: number
+    dummyObject:
+      type: object
+      properties:
+        dummyObjectProp1:
+          $ref: \\"#/components/schemas/sentAt\\"
+        dummyObjectProp2:
+          $ref: \\"#/components/schemas/dummyRecursiveObject\\"
+        dummyObjectProp3:
+          type: object
+          additionalProperties: true
+        dummyObjectProp4:
+          type: object
+          additionalProperties: false
+    dummyRecursiveObject:
+      type: object
+      properties:
+        dummyRecursiveProp1:
+          $ref: \\"#/components/schemas/dummyObject\\"
+        dummyRecursiveProp2:
+          type: string
+    sentAt:
+      type: string
+      format: date-time
+      description: Date and time when the message was sent.
+    dummyArrayRank:
+      type: object
+      properties:
+        dummyArrayValueRank: 
+          $ref: '#/components/schemas/dummyArrayValueRank'
+        dummyArrayDimensions: 
+          $ref: '#/components/schemas/dummyArrayArrayDimensions'
+    dummyArrayValueRank:
+      description: >
+        This Attribute indicates whether the val Attribute of the datapoint is an
+        array and how many dimensions the array has.
+      type: integer
+      default: -1
+      examples:
+        - 2
+      oneOf:
+        - const: -1
+          description: 'Scalar: The value is not an array.'
+        - const: 0
+          description: 'OneOrMoreDimensions: The value is an array with one or more dimensions.'
+        - const: 1
+          description: 'OneDimension: The value is an array with one dimension.'
+        - const: 2
+          description: 'The value is an array with two dimensions.'
+    dummyArrayArrayDimensions:
+      type: array
+      items:
+        type: integer
+        minimum: 0
+      examples:
+        - [3, 5]
+
+  securitySchemes:
+    user-password:
+      type: userPassword
+    apiKey:
+      type: apiKey
+      in: user
+      description: Provide your API key as the user and leave the password empty.
+    supportedOauthFlows:
+      type: oauth2
+      description: Flows to support OAuth 2.0
+      flows:
+        implicit:
+          authorizationUrl: 'https://authserver.example/auth'
+          scopes:
+            'dummy:created': Ability to create dummy message
+            'dymmy:read': Ability to read dummy info
+        password:
+          tokenUrl: 'https://authserver.example/token'
+          scopes:
+            'dummy:created': Ability to create dummy message
+            'dymmy:read': Ability to read dummy info
+        clientCredentials:
+          tokenUrl: 'https://authserver.example/token'
+          scopes:
+            'dummy:created': Ability to create dummy message
+            'dymmy:read': Ability to read dummy info
+        authorizationCode:
+          authorizationUrl: 'https://authserver.example/auth'
+          tokenUrl: 'https://authserver.example/token'
+          refreshUrl: 'https://authserver.example/refresh'
+          scopes:
+            'dummy:created': Ability to create dummy message
+            'dymmy:read': Ability to read dummy info
+    openIdConnectWellKnown:
+      type: openIdConnect
+      openIdConnectUrl: 'https://authserver.example/.well-known'
+
+  parameters:
+    dummy:
+      description: The ID of the new dummy message.
+      schema:
+        type: string
+        description: Description that not be rendered, as parameter has explicit description.
+
+  messageTraits:
+    commonHeaders:
+      headers:
+        type: object
+        properties:
+          my-app-header:
+            type: integer
+            minimum: 0
+            maximum: 100
+          correlationId:
+            type: string
+
+  operationTraits:
+    kafka:
+      bindings:
+        kafka:
+          groupId: my-app-group-id
+          clientId: my-app-client-id
+          bindingVersion: '0.1.0'
+"
+`;
+
 exports[`Integration testing generateFromFile() to make sure the result of the generation is not changend comparing to snapshot generated using Nunjucks template 1`] = `
 "This is a markdown file for my application.
 App name is: **Dummy example with all spec features included**

package/test/integration.test.js

@@ -62,8 +62,11 @@ describe('Integration testing generateFromFile() to make sure the result of the
       templateParams: { version: 'v1', mode: 'production' }
     });
     await generator.generateFromFile(dummySpecPath);
-    const file = await readFile(path.join(outputDir, testOutputFile), 'utf8');
-    expect(file).toMatchSnapshot();
+    const mdFile = await readFile(path.join(outputDir, testOutputFile), 'utf8');
+    //react template has hooks lib enabled and generation of asyncapi document that was passed as input should work out of the box without adding @asyncapi/generator-hooks to dependencies
+    const asyncAPIFile = await readFile(path.join(outputDir, 'asyncapi.yaml'), 'utf8');
+    expect(mdFile).toMatchSnapshot();
+    expect(asyncAPIFile).toMatchSnapshot();
   });
 
   it('generate json based api with referenced JSON Schema', async () => {

package/test/renderer.test.js

@@ -10,8 +10,8 @@ jest.mock('@asyncapi/generator-react-sdk');
 
 describe('React renderer', () => {
   describe('saveRenderedReactContent', () => {
-    let util = undefined;
-    let AsyncReactSDK = undefined;
+    let util;
+    let AsyncReactSDK;
     beforeAll(() => {
       util = require('../lib/utils');
       AsyncReactSDK = require('@asyncapi/generator-react-sdk');

package/test/test-templates/nunjucks-template/package-lock.json

@@ -8,7 +8,7 @@
             "name": "nunjucks-template",
             "version": "0.0.1",
             "dependencies": {
-                "@asyncapi/generator-react-sdk": "^1.1.1"
+                "@asyncapi/generator-react-sdk": "^1.1.2"
             }
         },
         "node_modules/@ampproject/remapping": {
@@ -25,9 +25,9 @@
             }
         },
         "node_modules/@asyncapi/generator-react-sdk": {
-            "version": "1.1.1",
-            "resolved": "https://registry.npmjs.org/@asyncapi/generator-react-sdk/-/generator-react-sdk-1.1.1.tgz",
-            "integrity": "sha512-R86Xa20wLtzI4fVf9HECR+UCSYvNE1B4WZs3eI5jAvGtONBTFOvkixd4SUL+uLP4DP96pU2DuKhih/PQbmMneQ==",
+            "version": "1.1.2",
+            "resolved": "https://registry.npmjs.org/@asyncapi/generator-react-sdk/-/generator-react-sdk-1.1.2.tgz",
+            "integrity": "sha512-hU9ux8hEMhXwQWWzySZlZ+L5SsM0r4uXdPFvYRTX5uVGeLKGoj4Ok8hY2gPhahKcvMELOIU2mw3O6h9h9AcskQ==",
             "dependencies": {
                 "@asyncapi/parser": "^3.1.0",
                 "@babel/core": "7.12.9",
@@ -3693,9 +3693,9 @@
             }
         },
         "node_modules/rollup": {
-            "version": "2.79.1",
-            "resolved": "https://registry.npmjs.org/rollup/-/rollup-2.79.1.tgz",
-            "integrity": "sha512-uKxbd0IhMZOhjAiD5oAFp7BqvkA4Dv47qpOCtaNvng4HBwdbWtdOh8f5nZNuk2rp51PMGk3bzfWu5oayNEuYnw==",
+            "version": "2.79.2",
+            "resolved": "https://registry.npmjs.org/rollup/-/rollup-2.79.2.tgz",
+            "integrity": "sha512-fS6iqSPZDs3dr/y7Od6y5nha8dW1YnbgtsyotCVvoFGKbERG++CVRFv1meyGDE1SNItQA8BrnCw7ScdAhRJ3XQ==",
             "bin": {
                 "rollup": "dist/bin/rollup"
             },

package/test/test-templates/nunjucks-template/package.json

@@ -16,6 +16,6 @@
         }
     },
     "dependencies": {
-        "@asyncapi/generator-react-sdk": "^1.1.1"
+        "@asyncapi/generator-react-sdk": "^1.1.2"
     }
 }

package/test/test-templates/react-template/package-lock.json

@@ -8,7 +8,7 @@
             "name": "react-template",
             "version": "0.0.1",
             "dependencies": {
-                "@asyncapi/generator-react-sdk": "^1.1.1"
+                "@asyncapi/generator-react-sdk": "^1.1.2"
             }
         },
         "node_modules/@ampproject/remapping": {
@@ -25,9 +25,9 @@
             }
         },
         "node_modules/@asyncapi/generator-react-sdk": {
-            "version": "1.1.1",
-            "resolved": "https://registry.npmjs.org/@asyncapi/generator-react-sdk/-/generator-react-sdk-1.1.1.tgz",
-            "integrity": "sha512-R86Xa20wLtzI4fVf9HECR+UCSYvNE1B4WZs3eI5jAvGtONBTFOvkixd4SUL+uLP4DP96pU2DuKhih/PQbmMneQ==",
+            "version": "1.1.2",
+            "resolved": "https://registry.npmjs.org/@asyncapi/generator-react-sdk/-/generator-react-sdk-1.1.2.tgz",
+            "integrity": "sha512-hU9ux8hEMhXwQWWzySZlZ+L5SsM0r4uXdPFvYRTX5uVGeLKGoj4Ok8hY2gPhahKcvMELOIU2mw3O6h9h9AcskQ==",
             "dependencies": {
                 "@asyncapi/parser": "^3.1.0",
                 "@babel/core": "7.12.9",
@@ -3693,9 +3693,9 @@
             }
         },
         "node_modules/rollup": {
-            "version": "2.79.1",
-            "resolved": "https://registry.npmjs.org/rollup/-/rollup-2.79.1.tgz",
-            "integrity": "sha512-uKxbd0IhMZOhjAiD5oAFp7BqvkA4Dv47qpOCtaNvng4HBwdbWtdOh8f5nZNuk2rp51PMGk3bzfWu5oayNEuYnw==",
+            "version": "2.79.2",
+            "resolved": "https://registry.npmjs.org/rollup/-/rollup-2.79.2.tgz",
+            "integrity": "sha512-fS6iqSPZDs3dr/y7Od6y5nha8dW1YnbgtsyotCVvoFGKbERG++CVRFv1meyGDE1SNItQA8BrnCw7ScdAhRJ3XQ==",
             "bin": {
                 "rollup": "dist/bin/rollup"
             },

package/test/test-templates/react-template/package.json

@@ -7,17 +7,23 @@
     },
     "generator": {
         "renderer": "react",
-        "api": "v3",
+        "apiVersion": "v3",
+        "hooks": {
+            "@asyncapi/generator-hooks": "createAsyncapiFile" 
+        },
         "parameters": {
             "version": {
                 "description": "Custom version to be used"
             },
             "mode": {
                 "description": "development or production"
+            },
+            "asyncapiFileDir": {
+                "description": "This template by default also outputs the AsyncAPI document that was passed as input. You can specify with this parameter what should be the location of this AsyncAPI document, relative to specified template output."
             }
         }
     },
     "dependencies": {
-        "@asyncapi/generator-react-sdk": "^1.1.1"
+        "@asyncapi/generator-react-sdk": "^1.1.2"
     }
 }