@asyncapi/converter 0.6.2 → 0.7.0

package/.github/workflows/add-good-first-issue-labels.yml

@@ -11,7 +11,7 @@ on:
 
 jobs:
   add-labels:
-    if: github.event.issue && github.event.issue.state != 'closed'
+    if: ${{!github.event.issue.pull_request && github.event.issue.state != 'closed' && github.actor != 'asyncapi-bot'}}
     runs-on: ubuntu-latest
     steps:
       - name: Add label
@@ -32,7 +32,7 @@ jobs:
                 values[1] = 'docs';
             }
             if(values.length != 2 || !areas.includes(values[1])){
-              const message = `Hey @${context.payload.sender.login}, something is wrong with your command please use \`/help\` for help.`
+              const message = `Hey @${context.payload.sender.login}, your message doesn't follow the requirements, you can try \`/help\`.`
 
               await github.rest.issues.createComment({
                 issue_number: context.issue.number,

package/.github/workflows/automerge-for-humans-merging.yml

@@ -27,6 +27,6 @@ jobs:
           GITHUB_TOKEN: "${{ secrets.GH_TOKEN }}"
           MERGE_LABELS: "!do-not-merge,ready-to-merge"
           MERGE_METHOD: "squash"
-          MERGE_COMMIT_MESSAGE: "pull-request-title"
+          MERGE_COMMIT_MESSAGE: "{pullRequest.title} (#{pullRequest.number})"
           MERGE_RETRIES: "20"
           MERGE_RETRY_SLEEP: "30000"

package/.github/workflows/automerge.yml

@@ -1,5 +1,5 @@
- # This action is centrally managed in https://github.com/asyncapi/.github/
- # Don't make changes to this file in this repo as they will be overwritten with changes made to the same file in above mentioned repo.
+# This action is centrally managed in https://github.com/asyncapi/.github/
+# Don't make changes to this file in this repo as they will be overwritten with changes made to the same file in above mentioned repo.
 
 name: Automerge release bump PR
 
@@ -19,9 +19,8 @@ on:
       - submitted
 
 jobs:
-
   autoapprove:
-    if: github.event.pull_request.draft == false && (github.event.pull_request.user.login == 'asyncapi-bot' || github.event.pull_request.user.login == 'dependabot[bot]' || github.event.pull_request.user.login == 'dependabot-preview[bot]') && !contains(github.event.pull_request.labels.*.name, 'released')
+    if: github.event.pull_request.draft == false && (github.actor == 'asyncapi-bot' || github.actor == 'dependabot[bot]' || github.actor == 'dependabot-preview[bot]') && !contains(github.event.pull_request.labels.*.name, 'released')
     runs-on: ubuntu-latest
     steps:
       - name: Autoapproving
@@ -39,8 +38,7 @@ jobs:
               owner: context.repo.owner,
               repo: context.repo.repo,
               labels: ['autoapproved']
-            }) 
-
+            })
 
   automerge:
     needs: [autoapprove]
@@ -54,6 +52,6 @@ jobs:
           GITHUB_LOGIN: asyncapi-bot
           MERGE_LABELS: ""
           MERGE_METHOD: "squash"
-          MERGE_COMMIT_MESSAGE: "pull-request-title"
+          MERGE_COMMIT_MESSAGE: "{pullRequest.title} (#{pullRequest.number})"
           MERGE_RETRIES: "20"
           MERGE_RETRY_SLEEP: "30000"

package/.github/workflows/autoupdate.yml

@@ -2,7 +2,7 @@
 #Don't make changes to this file in this repo as they will be overwritten with changes made to the same file in above mentioned repo
 
 #This workflow is designed to work with:
-# - autoapprove and automerge workflows for dependabot and asyncapibot. 
+# - autoapprove and automerge workflows for dependabot and asyncapibot.
 # - special release branches that we from time to time create in upstream repos. If we open up PRs for them from the very beginning of the release, the release branch will constantly update with new things from the destination branch they are opened against
 
 # It uses GitHub Action that auto-updates pull requests branches, whenever changes are pushed to their destination branch.
@@ -11,17 +11,21 @@
 name: autoupdate
 
 on:
-  push: {}
-  
-jobs:
+  push:
+    branches-ignore:  
+      - 'version-bump/**'
+      - 'dependabot/**'
+      - 'bot/**'
+      - 'all-contributors/**'
 
+jobs:
   autoupdate:
     runs-on: ubuntu-latest
     steps:
       - name: Autoupdating
         uses: docker://chinthakagodawita/autoupdate-action:v1
         env:
-          GITHUB_TOKEN: '${{ secrets.GITHUB_TOKEN }}'
+          GITHUB_TOKEN: '${{ secrets.GH_TOKEN }}'
           PR_FILTER: "labelled"
           PR_LABELS: "autoapproved"
           PR_READY_STATE: "ready_for_review"

package/.github/workflows/help-command.yml

@@ -10,7 +10,7 @@ on:
 
 jobs:
   create_help_comment_pr:
-    if: github.event.issue.pull_request && contains(github.event.comment.body, '/help') 
+    if: ${{ github.event.issue.pull_request && contains(github.event.comment.body, '/help') && github.actor != 'asyncapi-bot' }}
     runs-on: ubuntu-latest
     steps:
       - uses: actions-ecosystem/action-create-comment@v1
@@ -26,7 +26,7 @@ jobs:
             - `/ready-to-merge` or `/rtm` - This comment will trigger automerge of PR in case all required checks are green, approvals in place and do-not-merge label is not added
             - `/do-not-merge` or `/dnm` - This comment will block automerging even if all conditions are met and ready-to-merge label is added
   create_help_comment_issue:
-    if: ${{ !github.event.issue.pull_request && contains(github.event.comment.body, '/help') }}
+    if: ${{ !github.event.issue.pull_request && contains(github.event.comment.body, '/help') && github.actor != 'asyncapi-bot' }}
     runs-on: ubuntu-latest
     steps:
       - uses: actions-ecosystem/action-create-comment@v1

package/.github/workflows/if-nodejs-release.yml

@@ -10,7 +10,10 @@ on:
       # below lines are not enough to have release supported for these branches
       # make sure configuration of `semantic-release` package mentiones these branches
       - next
-      - '**-release'
+      - next-major
+      - beta
+      - alpha
+      - '**-release' # custom
 
 jobs:
 
@@ -47,7 +50,7 @@ jobs:
 
   release:
     needs: test
-    name: Publish to NPM and GitHub
+    name: Publish to any of NPM, Github, and Docker Hub
     runs-on: ubuntu-latest
     steps:
       - name: Set git to use LF #to once and for all finish neverending fight between Unix and Windows
@@ -68,11 +71,13 @@ jobs:
         name: Install dependencies
         run: npm install
       - if: steps.packagejson.outputs.exists == 'true'
-        name: Release to NPM and GitHub
+        name: Publish to any of NPM, Github, and Docker Hub
         id: release
         env:
           GITHUB_TOKEN: ${{ secrets.GH_TOKEN }}
           NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+          DOCKER_USERNAME: ${{ secrets.DOCKER_USERNAME }}
+          DOCKER_PASSWORD: ${{ secrets.DOCKER_PASSWORD }}
           GIT_AUTHOR_NAME: asyncapi-bot
           GIT_AUTHOR_EMAIL: info@asyncapi.io
           GIT_COMMITTER_NAME: asyncapi-bot

package/cli.js

@@ -32,7 +32,7 @@ if (!asyncapiFile) {
   program.help(); // This exits the process
 }
 if (!version) {
-  version = '2.2.0';
+  version = '2.3.0';
 }
 
 try {

package/lib/index.js

@@ -22,6 +22,7 @@ const conversions = {
   '2.0.0': from__2_0_0_rc2__to__2_0_0,
   '2.1.0': from__2_0_0__to__2_1_0,
   '2.2.0': from__2_1_0__to__2_2_0,
+  '2.3.0': from__2_2_0__to__2_3_0,
 }
 const conversionVersions = Object.keys(conversions);
 
@@ -192,14 +193,17 @@ function from__2_0_0_rc2__to__2_0_0(asyncapi2rc2, options) {
   return result;
 }
 
-function from__2_0_0__to__2_1_0(asyncapi2) {
-  const result = asyncapi2;
-  result.asyncapi = '2.1.0';
-  return result;
+function from__2_0_0__to__2_1_0(asyncapi) {
+  asyncapi.asyncapi = '2.1.0';
+  return asyncapi;
 }
 
-function from__2_1_0__to__2_2_0(asyncapi2) {
-  const result = asyncapi2;
-  result.asyncapi = '2.2.0';
-  return result;
+function from__2_1_0__to__2_2_0(asyncapi) {
+  asyncapi.asyncapi = '2.2.0';
+  return asyncapi;
 }
+
+function from__2_2_0__to__2_3_0(asyncapi) {
+  asyncapi.asyncapi = '2.3.0';
+  return asyncapi;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@asyncapi/converter",
-	"version": "0.6.2",
+	"version": "0.7.0",
 	"description": "Convert AsyncAPI documents from older to newer versions.",
 	"bin": {
 		"asyncapi-converter": "cli.js"

package/test/index.js

@@ -179,6 +179,20 @@ describe('#convert', () => {
         const result = convert(input, '2.2.0');
         assertResults(output, result);
     });
+
+    it('should convert from 2.1.0 to 2.3.0', () => {
+        const input = fs.readFileSync(path.resolve(__dirname, 'input', '2.1.0', 'streetlights.yml'), 'utf8');
+        const output = fs.readFileSync(path.resolve(__dirname, 'output', '2.3.0', 'streetlights.yml'), 'utf8');
+        const result = convert(input, '2.3.0');
+        assertResults(output, result);
+    });
+
+    it('should convert from 2.2.0 to 2.3.0', () => {
+        const input = fs.readFileSync(path.resolve(__dirname, 'input', '2.2.0', 'streetlights.yml'), 'utf8');
+        const output = fs.readFileSync(path.resolve(__dirname, 'output', '2.3.0', 'streetlights.yml'), 'utf8');
+        const result = convert(input, '2.3.0');
+        assertResults(output, result);
+    });
 });
 
 /*

package/test/input/2.2.0/streetlights.yml

@@ -0,0 +1,113 @@
+asyncapi: 2.2.0
+info:
+  title: Streetlights API
+  version: 1.0.0
+  description: "The Smartylighting Streetlights API allows you to remotely manage the city lights.\n\n### Check out its awesome features:\n\n* Turn a specific streetlight on/off \U0001F303\n* Dim a specific streetlight \U0001F60E\n* Receive real-time information about environmental lighting conditions \U0001F4C8\n"
+  license:
+    name: Apache 2.0
+    url: 'https://www.apache.org/licenses/LICENSE-2.0'
+servers:
+  default:
+    url: 'api.streetlights.smartylighting.com:{port}'
+    description: Test broker
+    variables:
+      port:
+        description: Secure connection (TLS) is available through port 8883.
+        default: '1883'
+        enum:
+          - '1883'
+          - '8883'
+    protocol: mqtt
+    security:
+      - apiKey: []
+components:
+  messages:
+    lightMeasured:
+      summary: >-
+        Inform about environmental lighting conditions for a particular
+        streetlight.
+      payload:
+        $ref: '#/components/schemas/lightMeasuredPayload'
+    turnOnOff:
+      summary: Command a particular streetlight to turn the lights on or off.
+      payload:
+        $ref: '#/components/schemas/turnOnOffPayload'
+    dimLight:
+      summary: Command a particular streetlight to dim the lights.
+      payload:
+        $ref: '#/components/schemas/dimLightPayload'
+  schemas:
+    lightMeasuredPayload:
+      type: object
+      properties:
+        lumens:
+          type: integer
+          minimum: 0
+          description: Light intensity measured in lumens.
+        sentAt:
+          $ref: '#/components/schemas/sentAt'
+    turnOnOffPayload:
+      type: object
+      properties:
+        command:
+          type: string
+          enum:
+            - 'on'
+            - 'off'
+          description: Whether to turn on or off the light.
+        sentAt:
+          $ref: '#/components/schemas/sentAt'
+    dimLightPayload:
+      type: object
+      properties:
+        percentage:
+          type: integer
+          description: Percentage to which the light should be dimmed to.
+          minimum: 0
+          maximum: 100
+        sentAt:
+          $ref: '#/components/schemas/sentAt'
+    sentAt:
+      type: string
+      format: date-time
+      description: Date and time when the message was sent.
+  securitySchemes:
+    apiKey:
+      type: apiKey
+      in: user
+      description: Provide your API key as the user and leave the password empty.
+  parameters:
+    streetlightId:
+      name: streetlightId
+      description: The ID of the streetlight.
+      schema:
+        type: string
+channels:
+  'smartylighting/streetlights/1/0/event/{streetlightId}/lighting/measured':
+    parameters:
+      streetlightId:
+        $ref: '#/components/parameters/streetlightId'
+    publish:
+      message:
+        $ref: '#/components/messages/lightMeasured'
+  'smartylighting/streetlights/1/0/action/{streetlightId}/turn/on':
+    parameters:
+      streetlightId:
+        $ref: '#/components/parameters/streetlightId'
+    subscribe:
+      message:
+        $ref: '#/components/messages/turnOnOff'
+  'smartylighting/streetlights/1/0/action/{streetlightId}/turn/off':
+    parameters:
+      streetlightId:
+        $ref: '#/components/parameters/streetlightId'
+    subscribe:
+      message:
+        $ref: '#/components/messages/turnOnOff'
+  'smartylighting/streetlights/1/0/action/{streetlightId}/dim':
+    parameters:
+      streetlightId:
+        $ref: '#/components/parameters/streetlightId'
+    subscribe:
+      message:
+        $ref: '#/components/messages/dimLight'

package/test/output/2.3.0/streetlights.yml

@@ -0,0 +1,113 @@
+asyncapi: 2.3.0
+info:
+  title: Streetlights API
+  version: 1.0.0
+  description: "The Smartylighting Streetlights API allows you to remotely manage the city lights.\n\n### Check out its awesome features:\n\n* Turn a specific streetlight on/off \U0001F303\n* Dim a specific streetlight \U0001F60E\n* Receive real-time information about environmental lighting conditions \U0001F4C8\n"
+  license:
+    name: Apache 2.0
+    url: 'https://www.apache.org/licenses/LICENSE-2.0'
+servers:
+  default:
+    url: 'api.streetlights.smartylighting.com:{port}'
+    description: Test broker
+    variables:
+      port:
+        description: Secure connection (TLS) is available through port 8883.
+        default: '1883'
+        enum:
+          - '1883'
+          - '8883'
+    protocol: mqtt
+    security:
+      - apiKey: []
+components:
+  messages:
+    lightMeasured:
+      summary: >-
+        Inform about environmental lighting conditions for a particular
+        streetlight.
+      payload:
+        $ref: '#/components/schemas/lightMeasuredPayload'
+    turnOnOff:
+      summary: Command a particular streetlight to turn the lights on or off.
+      payload:
+        $ref: '#/components/schemas/turnOnOffPayload'
+    dimLight:
+      summary: Command a particular streetlight to dim the lights.
+      payload:
+        $ref: '#/components/schemas/dimLightPayload'
+  schemas:
+    lightMeasuredPayload:
+      type: object
+      properties:
+        lumens:
+          type: integer
+          minimum: 0
+          description: Light intensity measured in lumens.
+        sentAt:
+          $ref: '#/components/schemas/sentAt'
+    turnOnOffPayload:
+      type: object
+      properties:
+        command:
+          type: string
+          enum:
+            - 'on'
+            - 'off'
+          description: Whether to turn on or off the light.
+        sentAt:
+          $ref: '#/components/schemas/sentAt'
+    dimLightPayload:
+      type: object
+      properties:
+        percentage:
+          type: integer
+          description: Percentage to which the light should be dimmed to.
+          minimum: 0
+          maximum: 100
+        sentAt:
+          $ref: '#/components/schemas/sentAt'
+    sentAt:
+      type: string
+      format: date-time
+      description: Date and time when the message was sent.
+  securitySchemes:
+    apiKey:
+      type: apiKey
+      in: user
+      description: Provide your API key as the user and leave the password empty.
+  parameters:
+    streetlightId:
+      name: streetlightId
+      description: The ID of the streetlight.
+      schema:
+        type: string
+channels:
+  'smartylighting/streetlights/1/0/event/{streetlightId}/lighting/measured':
+    parameters:
+      streetlightId:
+        $ref: '#/components/parameters/streetlightId'
+    publish:
+      message:
+        $ref: '#/components/messages/lightMeasured'
+  'smartylighting/streetlights/1/0/action/{streetlightId}/turn/on':
+    parameters:
+      streetlightId:
+        $ref: '#/components/parameters/streetlightId'
+    subscribe:
+      message:
+        $ref: '#/components/messages/turnOnOff'
+  'smartylighting/streetlights/1/0/action/{streetlightId}/turn/off':
+    parameters:
+      streetlightId:
+        $ref: '#/components/parameters/streetlightId'
+    subscribe:
+      message:
+        $ref: '#/components/messages/turnOnOff'
+  'smartylighting/streetlights/1/0/action/{streetlightId}/dim':
+    parameters:
+      streetlightId:
+        $ref: '#/components/parameters/streetlightId'
+    subscribe:
+      message:
+        $ref: '#/components/messages/dimLight'