@asyncapi/generator 1.10.7 → 1.10.9

package/docs/asyncapi-document.md

@@ -5,24 +5,25 @@ weight: 40
 
 The **AsyncAPI document** defines a standard, protocol-agnostic interface that describes message-based or event-driven APIs. The AsyncAPI document allows people or machines communicating with one another, to understand the capabilities of an event-driven API without requiring access to the source code, documentation, or inspecting the network traffic.
 
-This document allows you to define your API structures and formats, including channels the end user can subscribe to and the message formats they receive. 
+This document allows you to define your API structures and formats, including channels the end user can subscribe to and the message formats they receive.
 
 The documents describing the message-driven API under the AsyncAPI specification are represented as JSON objects and conform to JSON standards. YAML, a superset of JSON, can also be used to represent an API.
 
-> - To learn how to create an AsyncAPI document or refresh your knowledge about the syntax and structure of the AsyncAPI document, check out our [latest specification documentation](https://www.asyncapi.com/docs/reference/specification/latest). 
+> - To learn how to create an AsyncAPI document or refresh your knowledge about the syntax and structure of the AsyncAPI document, check out our [latest specification documentation](https://www.asyncapi.com/docs/reference/specification/latest).
 > - You can develop, validate, and convert the AsyncAPI document to the latest version or preview your AsyncAPI document in a more readable way using the [AsyncAPI Studio](https://studio.asyncapi.com/).
 
 In the following sections, you'll learn about the inner working of the generator, what happens once the AsyncAPI document is fed to the generator, and how you can access the content of the document in your template.
 
 ## AsyncAPI document generation process
-1. The **Generator** receives the **AsyncAPI Document** as input. 
+
+1. The **Generator** receives the **AsyncAPI Document** as input.
 2. The **Generator** sends to the **[Parser](parser)** the **asyncapiString** is a stringified version of the original **AsyncAPI Document** to validate and parse it.
-3. The **Parser** validates the **AsyncAPI Document** using additional schema-related plugins, either the OpenAPI schema, RAML data types, or Avro schema. 
-4. If the **Parser** determines that the **AsyncAPI Document** is valid, it manipulates the original JSON/YAML document and provides a set of helper functions in return, bundling them together into an **asyncapi** variable that is an instance of [**AsyncAPIDocument**](https://github.com/asyncapi/parser-js/blob/master/API.md#module_@asyncapi/parser+AsyncAPIDocument). 
-5. At this point, the **Generator** passes the **originalAsyncAPI** and the **asyncapi** which make up part of the **[Template Context](asyncapi-context)** to the **Render Engine**. 
+3. The **Parser** validates the **AsyncAPI Document** using additional schema-related plugins, either the OpenAPI schema, RAML data types, or Avro schema.
+4. If the **Parser** determines that the **AsyncAPI Document** is valid, it manipulates the original JSON/YAML document and provides a set of helper functions in return, bundling them together into an **asyncapi** variable that is an instance of [**AsyncAPIDocument**](https://github.com/asyncapi/parser-js/blob/master/API.md#module_@asyncapi/parser+AsyncAPIDocument).
+5. At this point, the **Generator** passes the **originalAsyncAPI** and the **asyncapi** which make up part of the **[Template Context](template-context)** to the **Render Engine**.
 6. The **Template Context** is accessible to the template files that are passed to either the [react](react-render-engine) or [nunjucks](nunjucks-render-engine) **Render Engines**.
-   
-``` mermaid
+
+```mermaid
 graph LR
     A[Template Context]
     B{Generator}
@@ -35,14 +36,17 @@ graph LR
     B--> | originalAsyncAPI -> Stringified document | A
     A --> D
   end
-  ```
+```
+
 The AsyncAPI document's content is accessible to you while writing your template in two distinct ways:
-* The `originalAsyncAPI`, which is a stringified version of the AsyncAPI document provided as input, without any modifications.
-* The `asyncapi` (`AsyncAPIDocument`) which is an object with a set of helper functions, that comes as a result of the `Parser` manipulating the `originalAyncAPI` .The `asyncapi` functions make it easier to access the contents of AsyncAPI documents in your templates.
+
+- The `originalAsyncAPI`, which is a stringified version of the AsyncAPI document provided as input, without any modifications.
+- The `asyncapi` (`AsyncAPIDocument`) which is an object with a set of helper functions, that comes as a result of the `Parser` manipulating the `originalAyncAPI` .The `asyncapi` functions make it easier to access the contents of AsyncAPI documents in your templates.
 
 In the following sections, you will learn how to use either the **originalAsyncAPI** or the **asyncapi** in your template.
 
-### Method 1: `originalAsyncAPI` and template 
+### Method 1: `originalAsyncAPI` and template
+
 One way of using the contents of the AsyncAPI document inside your template files is by using its stringified version that reflects the same contents as the AsyncAPI document provided as input to the generator. You can access it directly in your templates using the `originalAsyncAPI` variable. You also access it via the [hooks](hooks) `generator.originalAsyncAPI` because `originalAsyncAPI` is also a part of the generator instance that is passed to hooks.
 
 ```js
@@ -54,7 +58,7 @@ const path = require('path');
 function createAsyncapiFile(generator) {
   const asyncapi = generator.originalAsyncAPI;
   let extension;
-  
+
   try {
     JSON.parse(asyncapi);
     extension = 'json';
@@ -69,9 +73,9 @@ function createAsyncapiFile(generator) {
   fs.writeFileSync(asyncapiOutputLocation, asyncapi);
 ```
 
-
 ### Method 2: `asyncapi` and template
-A major advantage of using `asyncapi` (which is an instance of `AsyncAPIDocument`) is that it enables the developer to easily access the AsyncAPI documents' content by simply invoking a function. 
+
+A major advantage of using `asyncapi` (which is an instance of `AsyncAPIDocument`) is that it enables the developer to easily access the AsyncAPI documents' content by simply invoking a function.
 
 Once the specification YAML or JSON document is passed as input to the generator, it is passed on to the [Parser](parser) library, which then manipulates the asyncAPI document to a more structured document called the `AsyncAPIDocument`. Once the parser returns the document to the generator, the generator passes it to the render engine. The render engine makes the `AsyncAPIDocument` object accessible to your template through the `asyncapi` variable.
 
@@ -80,8 +84,8 @@ For example, if you want to extract the version of your API from AsyncAPI docume
 In the sample code snippet below, notice how you can access the contents of the AsyncAPI document in your template using `asyncapi` variable from the context:
 
 ```js
-  const apiName = asyncapi.info().title();
-  const channels = asyncapi.channels();
+const apiName = asyncapi.info().title();
+const channels = asyncapi.channels();
 ```
 
 > To learn about the various instances you can use to access the documents' content, look at the API of the AsyncAPI JavaScript Parser and the structure of [AsyncAPIDocument](https://github.com/asyncapi/parser-js/blob/master/API.md#module_@asyncapi/parser+AsyncAPIDocument)

package/docs/parser.md

@@ -5,9 +5,9 @@ weight: 60
 
 ## Parser
 
-The AsyncAPI Parser is a package used to parse and validate the [AsyncAPI documents](asyncapi-document.md) in your Node.js or browser application. These documents can be either in YAML or JSON format.
+The AsyncAPI Parser is a package used to parse and validate the [AsyncAPI documents](asyncapi-document) in your Node.js or browser application. These documents can be either in YAML or JSON format.
 
-The Parser validates these documents using dedicated schema-supported plugins. 
+The Parser validates these documents using dedicated schema-supported plugins.
 
 Supported schemas:
 
@@ -19,15 +19,15 @@ Supported schemas:
 
 The Parser allows the template developer to easily access schemas provided in the above supported formats. This is because the JavaScript parser converts all of them into JSON schema.
 
-If the document is valid, the Parser returns an `AsyncAPIDocument instance` with a set of helper functions that enable easier access to the contents of the AsyncAPI document. The parser provides dereferenced output. During the dereference process, the AsyncAPI parser substitutes a reference with a full definition. The dereferenced output is always in JSON format. The parser provides a message listing all errors if a document is invalid. The original AsyncAPI document is part of the [Template Context](template-context.md) as the generator also passes the original AsyncAPI document to the template context.	
+If the document is valid, the Parser returns an `AsyncAPIDocument instance` with a set of helper functions that enable easier access to the contents of the AsyncAPI document. The parser provides dereferenced output. During the dereference process, the AsyncAPI parser substitutes a reference with a full definition. The dereferenced output is always in JSON format. The parser provides a message listing all errors if a document is invalid. The original AsyncAPI document is part of the [Template Context](template-context) as the generator also passes the original AsyncAPI document to the template context.
 
 The following AsyncAPI document example has two channels: `channelOne` and `channelTwo`. Each channel has one operation and a single message:
 
 ```yaml
-asyncapi: '2.5.0'
+asyncapi: "2.5.0"
 info:
   title: Demo API
-  version: '1.0.0'
+  version: "1.0.0"
 channels:
   channelOne:
     publish:
@@ -36,14 +36,14 @@ channels:
       message:
         name: FirstMessage
         payload:
-            id:
-              type: integer
-              minimum: 0
-              description: Id of the channel
-            sentAt:
-              type: string
-              format: date-time
-              description: Date and time when the message was sent.
+          id:
+            type: integer
+            minimum: 0
+            description: Id of the channel
+          sentAt:
+            type: string
+            format: date-time
+            description: Date and time when the message was sent.
   channelTwo:
     publish:
       summary: This is the second sample channel
@@ -51,36 +51,37 @@ channels:
       message:
         name: SecondMessage
         payload:
-            id:
-              type: integer
-              minimum: 0
-              description: Id of the channel
-            sentAt:
-              type: string
-              format: date-time
-              description: Date and time when the message was sent.
+          id:
+            type: integer
+            minimum: 0
+            description: Id of the channel
+          sentAt:
+            type: string
+            format: date-time
+            description: Date and time when the message was sent.
 ```
+
 We can use helper functions provided by the Parser to operate on the above JSON file. For example, we can use the helper method `asyncAPIDocument.channelNames()`, which returns an array of all channel names currently present in the AsyncAPI document. Another example where you can use a helper function is to list out messages present in your JSON file. Instead of fetching a single message one at a time, you can use the function `asyncAPIDocument.allMessages()` that returns the map of all messages in your AsyncAPI document.
 
 ```js
-  const channelNames = asyncAPIDocument.channelNames();
-  const messages = asyncAPIDocument.allMessages();
+const channelNames = asyncAPIDocument.channelNames();
+const messages = asyncAPIDocument.allMessages();
 ```
 
-> The Parser gives you access to a number of these [helper functions](https://github.com/asyncapi/parser-js/blob/master/API.md) that you can implement to access the contents of your AsyncAPI document. 
+> The Parser gives you access to a number of these [helper functions](https://github.com/asyncapi/parser-js/blob/master/API.md) that you can implement to access the contents of your AsyncAPI document.
 
 ## AsyncAPI document validation process
 
 1. **AsyncAPI document** is fed as an input to the Generator.
 1. Generator sends the AsyncAPI document to the Parser as **asyncapiString**; the stringified version of the original AsyncAPI document.
 1. The Parser uses additional plugins such as the OpenAPI, RAML, or Avro schemas to validate custom schemas of message payloads defined in the AsyncAPI document.
-1. If the AsyncAPI document is invalid, it throws an error based on the encountered failure type. For example, if the AsyncAPI document is not a string nor a JavaScript object, the Parser throws an `invalid-document-type` error. 
+1. If the AsyncAPI document is invalid, it throws an error based on the encountered failure type. For example, if the AsyncAPI document is not a string nor a JavaScript object, the Parser throws an `invalid-document-type` error.
    Similarly, you may encounter errors such as:
-      - `invalid-json`
-      - `invalid-yaml`
-      - `impossible-to-convert-to-json`
+   - `invalid-json`
+   - `invalid-yaml`
+   - `impossible-to-convert-to-json`
 1. If the document is valid, the Parser modifies the AsyncAPI document, returns a set of helper functions, and bundles them together into the **asyncapi** variable. These helper functions in the form of an **asyncapi** variable are passed to the **Template Context**.
-1. The Template Context passes all of these values to the [**Render Engine**](react-render-engine.md) of your choice. Finally, the Render Engine generates whatever output you may have specified in your template. (i.e. code, documentation, diagrams, pdfs, applications, etc.)
+1. The Template Context passes all of these values to the [**Render Engine**](react-render-engine) of your choice. Finally, the Render Engine generates whatever output you may have specified in your template. (i.e. code, documentation, diagrams, pdfs, applications, etc.)
 
 ```mermaid
 graph TD
@@ -93,4 +94,3 @@ graph TD
 ```
 
 > To learn more about the Parser and access all of its features, check out the AsyncAPI [Parser’s GitHub repository](https://github.com/asyncapi/parser-js).
-

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@asyncapi/generator",
-  "version": "1.10.7",
+  "version": "1.10.9",
   "description": "The AsyncAPI generator. It can generate documentation, code, anything!",
   "main": "./lib/generator.js",
   "bin": {
@@ -48,11 +48,11 @@
   "license": "Apache-2.0",
   "homepage": "https://github.com/asyncapi/generator",
   "dependencies": {
-    "@asyncapi/avro-schema-parser": "^3.0.0",
+    "@asyncapi/avro-schema-parser": "^3.0.2",
     "@asyncapi/generator-react-sdk": "^0.2.23",
-    "@asyncapi/openapi-schema-parser": "^3.0.2",
+    "@asyncapi/openapi-schema-parser": "^3.0.3",
     "@asyncapi/parser": "^2.0.3",
-    "@asyncapi/raml-dt-schema-parser": "^4.0.1",
+    "@asyncapi/raml-dt-schema-parser": "^4.0.3",
     "@npmcli/arborist": "^2.2.4",
     "ajv": "^8.12.0",
     "chokidar": "^3.4.0",