@asyncapi/generator 1.14.2 → 1.15.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/docs/configuration-file.md +2 -2
  2. package/lib/templateConfigValidator.js +2 -1
  3. package/package.json +3 -4
package/docs/configuration-file.md CHANGED
@@ -8,7 +8,7 @@ The `generator` property from `package.json` file must contain a JSON object tha
8
8
  |Name|Type|Description|
9
9
  |---|---|---|
10
10
  |`renderer`| String | Its value can be either `react` or `nunjucks` (default).
11
- |`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 `v2` [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.
11
+ |`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.
12
12
  |`supportedProtocols`| [String] | A list with all the protocols this template supports.
13
13
  |`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`.
14
14
  |`parameters[param].description`| String | A user-friendly description about the parameter.
@@ -28,7 +28,7 @@ The `generator` property from `package.json` file must contain a JSON object tha
28
28
  "generator":
29
29
  {
30
30
  "renderer": "react",
31
- "apiVersion": "v2",
31
+ "apiVersion": "v3",
32
32
  "supportedProtocols": ["amqp", "mqtt"],
33
33
  "parameters": {
34
34
  "server": {
package/lib/templateConfigValidator.js CHANGED
@@ -11,7 +11,8 @@ const ajv = new Ajv({ allErrors: true });
11
11
  // See https://github.com/asyncapi/parser-api
12
12
  const supportedParserAPIMajorVersions = [
13
13
  'v1',
14
- 'v2'
14
+ 'v2',
15
+ 'v3'
15
16
  ];
16
17
 
17
18
  /**
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@asyncapi/generator",
3
- "version": "1.14.2",
3
+ "version": "1.15.0",
4
4
  "description": "The AsyncAPI generator. It can generate documentation, code, anything!",
5
5
  "main": "./lib/generator.js",
6
6
  "bin": {
@@ -48,10 +48,10 @@
48
48
  "license": "Apache-2.0",
49
49
  "homepage": "https://github.com/asyncapi/generator",
50
50
  "dependencies": {
51
- "@asyncapi/generator-react-sdk": "^0.2.23",
51
+ "@asyncapi/generator-react-sdk": "^1.0.2",
52
52
  "@asyncapi/parser": "^2.1.2",
53
53
  "@npmcli/arborist": "^2.2.4",
54
- "@smoya/multi-parser": "^4.0.0",
54
+ "@smoya/multi-parser": "^5.0.0",
55
55
  "ajv": "^8.12.0",
56
56
  "chokidar": "^3.4.0",
57
57
  "commander": "^6.1.0",
@@ -62,7 +62,6 @@
62
62
  "js-yaml": "^3.13.1",
63
63
  "levenshtein-edit-distance": "^2.0.5",
64
64
  "loglevel": "^1.6.8",
65
- "markdown-it": "^12.3.2",
66
65
  "minimatch": "^3.0.4",
67
66
  "node-fetch": "^2.6.0",
68
67
  "nunjucks": "^3.2.0",