@asyncapi/generator 2.4.1 → 2.6.0

package/lib/renderer/nunjucks.js

@@ -3,7 +3,7 @@ const nunjucksExport = module.exports;
 
 /**
  * Configures Nunjucks templating system
- * 
+ * @deprecated This method is deprecated. For more details, see the release notes: https://github.com/asyncapi/generator/releases/tag/%40asyncapi%2Fgenerator%402.6.0
  * @private
  * @param {boolean} debug flag
  * @param {string} templateDir path
@@ -17,7 +17,7 @@ nunjucksExport.configureNunjucks = (debug, templateDir) => {
 
 /**
  * Renders the template with nunjucks and returns a string.
- * 
+ * @deprecated This method is deprecated. For more details, see the release notes: https://github.com/asyncapi/generator/releases/tag/%40asyncapi%2Fgenerator%402.6.0
  * @param {import('@asyncapi/parser').AsyncAPIDocument} asyncapiDocument 
  * @param {string} templateString template filecontent to be rendered with nunjucks
  * @param {string} filePath path to the template file

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,7 +131,7 @@ utils.getGeneratorVersion = () => {
  * @returns {Boolean} is function asynchronous
  */
 utils.isAsyncFunction = (fn) => {
-  return fn && fn.constructor && fn.constructor.name === 'AsyncFunction';
+  return fn?.constructor?.name === 'AsyncFunction';
 };
 
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@asyncapi/generator",
-  "version": "2.4.1",
+  "version": "2.6.0",
   "description": "The AsyncAPI generator. It can generate documentation, code, anything!",
   "main": "./lib/generator.js",
   "bin": {
@@ -12,12 +12,11 @@
     "npm": ">=8.19.0"
   },
   "scripts": {
-    "test": "npm run test:unit && npm run test:integration && npm run test:cli",
+    "test": "npm run test:unit && npm run test:integration",
     "test:unit": "jest --coverage --testPathIgnorePatterns=integration --testPathIgnorePatterns=test-project",
     "test:dev": "npm run test:unit -- --watchAll",
     "test:integration": "npm run test:cleanup && jest --testPathPattern=integration --modulePathIgnorePatterns='./__mocks__(?!\\/loglevel\\.js$)'",
     "test:integration:update": "jest --updateSnapshot --testPathPattern=integration --modulePathIgnorePatterns='./__mocks__(?!\\/loglevel\\.js$)'",
-    "test:cli": "node cli.js ./test/docs/dummy.yml ./test/test-templates/react-template -o test/output --force-write --debug && test -e test/output/test-file.md",
     "test:cleanup": "rimraf \"test/temp\"",
     "docs": "jsdoc2md --partial docs/jsdoc2md-handlebars/custom-sig-name.hbs docs/jsdoc2md-handlebars/main.hbs docs/jsdoc2md-handlebars/docs.hbs docs/jsdoc2md-handlebars/header.hbs docs/jsdoc2md-handlebars/defaultvalue.hbs docs/jsdoc2md-handlebars/link.hbs docs/jsdoc2md-handlebars/params-table.hbs --files lib/generator.js > docs/api.md",
     "docker:build": "docker build -t asyncapi/generator:latest .",
@@ -49,9 +48,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",
@@ -81,11 +81,11 @@
     "eslint-plugin-jest": "^23.8.2",
     "eslint-plugin-react": "^7.34.1",
     "eslint-plugin-sonarjs": "^0.5.0",
+    "fs-extra": "11.2.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

@@ -10,11 +10,11 @@ const dummySpecPath = path.resolve(__dirname, './docs/dummy.yml');
 const refSpecPath = path.resolve(__dirname, './docs/apiwithref.json');
 const refSpecFolder = path.resolve(__dirname, './docs/');
 const crypto = require('crypto');
-const mainTestResultPath = 'test/temp/integrationTestResult';
-const reactTemplate = 'test/test-templates/react-template';
-const nunjucksTemplate = 'test/test-templates/nunjucks-template';
+const mainTestResultPath = path.resolve(__dirname, './temp/integrationTestResult');
+const reactTemplate = path.resolve(__dirname, './test-templates/react-template');
+const nunjucksTemplate = path.resolve(__dirname, './test-templates/nunjucks-template');
 //temp location where react template is copied for each test that does some mutation on template files
-const copyOfReactTemplate = 'test/temp/reactTemplate';
+const copyOfReactTemplate = path.resolve(__dirname, './temp/reactTemplate');
 
 describe('Integration testing generateFromFile() to make sure the result of the generation is not changend comparing to snapshot', () => {
   const generateFolderName = () => {
@@ -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-project/package.json

@@ -11,7 +11,6 @@
         "test:cleanup": "rimraf \"../temp\""
     },
     "devDependencies": {
-        "fs-extra": "9.1.0",
         "jest": "28.1.3",
         "rimraf": "3.0.2"
     },

package/test/test-project/test.sh

@@ -71,6 +71,11 @@ Publish test template to local npm-verdaccio
 npm config set -- //verdaccio:4873/:_auth=YWRtaW46bmltZGE=
 npm config set registry http://verdaccio:4873
 
+echo "##########
+Publish @asyncapi/generator-components to local npm-verdaccio
+##########"
+npm publish ../../../../packages/components
+
 echo "##########
 Publishing the correct template as 0.0.1
 ##########"

package/test/test-project/verdaccio/config.yaml

@@ -10,7 +10,13 @@ packages:
   "react-template":
     access: admin
     publish: admin
+  "@asyncapi/generator-components":
+    access: admin
+    publish: admin
   "!react-template":
     access: admin
     proxy: npmjs
+  "!@asyncapi/generator-components":
+    access: admin
+    proxy: npmjs
 log: { type: stdout, format: pretty, level: error }