@asyncapi/cli 0.8.0 → 0.9.2

package/README.md

@@ -59,57 +59,19 @@ We have well-documented help commands so just run:
 asyncapi --help 
 ```
 
+It should print something like:
 
-
-
-## API Reference
-
-### `validate`
-
-**USAGE**
-
-```
-asyncapi validate <spcPath | context-name> [options]
-```
-
-If you already have your current context set, run the following command:
-
-```
-asyncapi validate
-```
-
-**OPTIONS** 
-
-```
--h, --help Display help for command
--w, --watch Enable watch mode (not implemented yet)
-```
-
-
-### `context`
-
-**Context** makes it easier for you to work with multiple AsyncAPI Files. You can add multiple different files to a context so that you don't have to pass the file as an input every time you use any command. You can also set a default context so that you don't have to pass in either file paths or context names as an input.
-
-**USAGE**
-
-```
-asyncapi context [options] [command]
 ```
+All in one CLI for all AsyncAPI tools
 
-**COMMANDS**
+USAGE
+  $ asyncapi [COMMAND]
 
-|command|arguments|description|example|
-|-------|---------|-----------|-------|
-|`list`|`none` |lists all saved context|`asyncapi context list`|
-|`current`|`none`|set current context|`asyncapi context current`|
-|`use` | `<context-name>`| set any context from the list as current|`asyncapi context use test`|
-|`add`|`<context-name> <spec-file-path>`|add/update a context|`asyncapi context add root ./asyncapi.yml`|
-|`remove`|`<context-name>`|remove a context from the list|`asyncapi context remove root`|
-
-**OPTIONS**
-
-```
--h, --help display help for command
+COMMANDS
+  config    access configs
+  help      display help for asyncapi
+  new       creates a new asyncapi file
+  validate  validate asyncapi file
 ```
 
 

package/assets/examples/anyof.yml

@@ -0,0 +1,31 @@
+asyncapi: '2.2.0'
+info:
+  title: AnyOf example
+  version: '1.0.0'
+
+channels:
+  test:
+    publish:
+      message:
+        $ref: '#/components/messages/testMessages'
+
+components:
+  messages:
+    testMessages:
+      payload:
+        anyOf: # anyOf in payload schema
+          - $ref: "#/components/schemas/objectWithKey"
+          - $ref: "#/components/schemas/objectWithKey2"
+
+  schemas:
+    objectWithKey:
+      type: object
+      properties:
+        key:
+          type: string
+          additionalProperties: false
+    objectWithKey2:
+      type: object
+      properties:
+        key2:
+          type: string

package/assets/examples/application-headers.yml

@@ -0,0 +1,83 @@
+asyncapi: '2.2.0'
+info:
+  title: Application Headers example
+  version: '1.0.0'
+  description: A cut of the Streetlights API to test application header changes supporting #112
+  license:
+    name: Apache 2.0
+    url: https://www.apache.org/licenses/LICENSE-2.0
+
+servers:
+  production:
+    url: test.mosquitto.org:{port}
+    protocol: mqtt
+    description: Test broker
+    variables:
+      port:
+        description: Secure connection (TLS) is available through port 8883.
+        default: '1883'
+        enum:
+          - '1883'
+          - '8883'
+
+defaultContentType: application/json
+
+channels:
+  smartylighting/streetlights/1/0/event/{streetlightId}/lighting/measured:
+    parameters:
+      streetlightId:
+        $ref: '#/components/parameters/streetlightId'
+    publish:
+      summary: Inform about environmental lighting conditions of a particular streetlight.
+      operationId: receiveLightMeasurement
+      message:
+        $ref: '#/components/messages/lightMeasured'
+
+components:
+  messages:
+    lightMeasured:
+      name: lightMeasured
+      title: Light measured
+      summary: Inform about environmental lighting conditions of a particular streetlight.
+      correlationId:
+        location: "$message.header#/MQMD/CorrelId"
+      contentType: application/json
+      headers:
+        type: object
+        properties:
+          MQMD:
+            type: object
+            properties:
+              CorrelId:
+                type: string
+                minLength: 24
+                maxLength: 24
+                format: binary
+          applicationInstanceId:
+            $ref: "#/components/schemas/applicationInstanceId"
+      payload:
+        $ref: "#/components/schemas/lightMeasuredPayload"
+
+  schemas:
+    lightMeasuredPayload:
+      type: object
+      properties:
+        lumens:
+          type: integer
+          minimum: 0
+          description: Light intensity measured in lumens.
+        sentAt:
+          $ref: "#/components/schemas/sentAt"
+    sentAt:
+      type: string
+      format: date-time
+      description: Date and time when the message was sent.
+    applicationInstanceId:
+      description: Unique identifier for a given instance of the publishing application
+      type: string
+
+  parameters:
+    streetlightId:
+      description: The ID of the streetlight.
+      schema:
+        type: string

package/assets/examples/correlation-id.yml

@@ -0,0 +1,144 @@
+asyncapi: '2.2.0'
+info:
+  title: Correlation ID Example
+  version: '1.0.0'
+  description: A cut of the Streetlights API to test Correlation ID
+  license:
+    name: Apache 2.0
+    url: https://www.apache.org/licenses/LICENSE-2.0
+
+servers:
+  production:
+    url: test.mosquitto.org:{port}
+    protocol: mqtt
+    description: Test broker
+    variables:
+      port:
+        description: Secure connection (TLS) is available through port 8883.
+        default: '1883'
+        enum:
+          - '1883'
+          - '8883'
+    security:
+      - apiKey: []
+      - supportedOauthFlows:
+        - streetlights:on
+        - streetlights:off
+        - streetlights:dim
+      - openIdConnectWellKnown: []
+
+defaultContentType: application/json
+
+channels:
+  smartylighting/streetlights/1/0/event/{streetlightId}/lighting/measured:
+    parameters:
+      streetlightId:
+        $ref: '#/components/parameters/streetlightId'
+    publish:
+      summary: Inform about environmental lighting conditions of a particular streetlight.
+      operationId: receiveLightMeasurement
+      message:
+        $ref: '#/components/messages/lightMeasured'
+
+  smartylighting/streetlights/1/0/action/{streetlightId}/dim:
+    parameters:
+      streetlightId:
+        $ref: '#/components/parameters/streetlightId'
+    subscribe:
+      operationId: dimLight
+      message:
+        $ref: '#/components/messages/dimLight'
+
+components:
+  messages:
+    lightMeasured:
+      name: lightMeasured
+      title: Light measured
+      summary: Inform about environmental lighting conditions of a particular streetlight.
+      correlationId:
+        location: "$message.header#/MQMD/CorrelId"
+      contentType: application/json
+      payload:
+        $ref: "#/components/schemas/lightMeasuredPayload"
+    dimLight:
+      name: dimLight
+      title: Dim light
+      summary: Command a particular streetlight to dim the lights.
+      correlationId:
+        $ref: "#/components/correlationIds/sentAtCorrelator"
+      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"
+    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.
+
+  parameters:
+    streetlightId:
+      description: The ID of the streetlight.
+      schema:
+        type: string
+
+  correlationIds:
+    sentAtCorrelator:
+      description: Data from message payload used as correlation ID
+      location: $message.payload#/sentAt
+  securitySchemes:
+    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:
+            'streetlights:on': Ability to switch lights on
+            'streetlights:off': Ability to switch lights off
+            'streetlights:dim': Ability to dim the lights
+        password:
+          tokenUrl: 'https://authserver.example/token'
+          scopes:
+            'streetlights:on': Ability to switch lights on
+            'streetlights:off': Ability to switch lights off
+            'streetlights:dim': Ability to dim the lights
+        clientCredentials:
+          tokenUrl: 'https://authserver.example/token'
+          scopes:
+            'streetlights:on': Ability to switch lights on
+            'streetlights:off': Ability to switch lights off
+            'streetlights:dim': Ability to dim the lights
+        authorizationCode:
+          authorizationUrl: 'https://authserver.example/auth'
+          tokenUrl: 'https://authserver.example/token'
+          refreshUrl: 'https://authserver.example/refresh'
+          scopes:
+            'streetlights:on': Ability to switch lights on
+            'streetlights:off': Ability to switch lights off
+            'streetlights:dim': Ability to dim the lights
+    openIdConnectWellKnown:
+      type: openIdConnect
+      openIdConnectUrl: 'https://authserver.example/.well-known'

package/assets/examples/default-example.yaml

@@ -0,0 +1,23 @@
+asyncapi: '2.2.0'
+info:
+  title: Account Service
+  version: 1.0.0
+  description: This service is in charge of processing user signups
+channels:
+  user/signedup:
+    subscribe:
+      message:
+        $ref: '#/components/messages/UserSignedUp'
+components:
+  messages:
+    UserSignedUp:
+      payload:
+        type: object
+        properties:
+          displayName:
+            type: string
+            description: Name of the user
+          email:
+            type: string
+            format: email
+            description: Email of the user

package/assets/examples/examples.json

@@ -0,0 +1,58 @@
+[
+    {
+        "name": "Account Service",
+        "value": "simple.yml"
+    },
+    {
+        "name": "AnyOf example",
+        "value": "anyof.yml"
+    },
+    {
+        "name": "Application Headers example - (protocols: mqtt)",
+        "value": "application-headers.yml"
+    },
+    {
+        "name": "Correlation ID Example - (protocols: mqtt)",
+        "value": "correlation-id.yml"
+    },
+    {
+        "name": "Gemini Market Data Websocket API - (protocols: wss)",
+        "value": "websocket-gemini.yml"
+    },
+    {
+        "name": "Gitter Streaming API - (protocols: https)",
+        "value": "gitter-streaming.yml"
+    },
+    {
+        "name": "Mercure Hub Example - (protocols: mercure)",
+        "value": "mercure.yml"
+    },
+    {
+        "name": "Not example",
+        "value": "not.yml"
+    },
+    {
+        "name": "OneOf example",
+        "value": "oneof.yml"
+    },
+    {
+        "name": "RPC Client Example - (protocols: amqp)",
+        "value": "rpc-client.yml"
+    },
+    {
+        "name": "RPC Server Example - (protocols: amqp)",
+        "value": "rpc-server.yml"
+    },
+    {
+        "name": "Slack Real Time Messaging API - (protocols: https)",
+        "value": "slack-rtm.yml"
+    },
+    {
+        "name": "Streetlights Kafka API - (protocols: kafka-secure)",
+        "value": "streetlights-kafka.yml"
+    },
+    {
+        "name": "Streetlights MQTT API - (protocols: mqtt)",
+        "value": "streetlights-mqtt.yml"
+    }
+]

package/assets/examples/gitter-streaming.yml

@@ -0,0 +1,164 @@
+asyncapi: '2.2.0'
+id: 'urn:com:gitter:streaming:api'
+info:
+  title: Gitter Streaming API
+  version: '1.0.0'
+
+servers:
+  production:
+    url: https://stream.gitter.im/v1
+    protocol: https
+    protocolVersion: '1.1'
+    security:
+      - httpBearerToken: []
+
+channels:
+  /rooms/{roomId}/{resource}:
+    parameters:
+      roomId:
+        description: Id of the Gitter room.
+        schema:
+          type: string
+          examples:
+            - 53307860c3599d1de448e19d
+      resource:
+        description: The resource to consume.
+        schema:
+          type: string
+          enum:
+            - chatMessages
+            - events
+    subscribe:
+      bindings:
+        http:
+          type: response
+      message:
+        oneOf:
+          - $ref: '#/components/messages/chatMessage'
+          - $ref: '#/components/messages/heartbeat'
+
+components:
+  securitySchemes:
+    httpBearerToken:
+      type: http
+      scheme: bearer
+  messages:
+    chatMessage:
+      schemaFormat: 'application/schema+yaml;version=draft-07'
+      summary: >-
+        A message represents an individual chat message sent to a room.
+        They are a sub-resource of a room.
+      payload:
+        type: object
+        properties:
+          id:
+            type: string
+            description: ID of the message.
+          text:
+            type: string
+            description: Original message in plain-text/markdown.
+          html:
+            type: string
+            description: HTML formatted message.
+          sent:
+            type: string
+            format: date-time
+            description: ISO formatted date of the message.
+          fromUser:
+            type: object
+            description: User that sent the message.
+            properties:
+              id:
+                type: string
+                description: Gitter User ID.
+              username:
+                type: string
+                description: Gitter/GitHub username.
+              displayName:
+                type: string
+                description: Gitter/GitHub user real name.
+              url:
+                type: string
+                description: Path to the user on Gitter.
+              avatarUrl:
+                type: string
+                format: uri
+                description: User avatar URI.
+              avatarUrlSmall:
+                type: string
+                format: uri
+                description: User avatar URI (small).
+              avatarUrlMedium:
+                type: string
+                format: uri
+                description: User avatar URI (medium).
+              v:
+                type: number
+                description: Version.
+              gv:
+                type: string
+                description: Stands for "Gravatar version" and is used for cache busting.
+          unread:
+            type: boolean
+            description: Boolean that indicates if the current user has read the message.
+          readBy:
+            type: number
+            description: Number of users that have read the message.
+          urls:
+            type: array
+            description: List of URLs present in the message.
+            items:
+              type: string
+              format: uri
+          mentions:
+            type: array
+            description: List of @Mentions in the message.
+            items:
+              type: object
+              properties:
+                screenName:
+                  type: string
+                userId:
+                  type: string
+                userIds:
+                  type: array
+                  items:
+                    type: string
+          issues:
+            type: array
+            description: 'List of #Issues referenced in the message.'
+            items:
+              type: object
+              properties:
+                number:
+                  type: string
+          meta:
+            type: array
+            description: Metadata. This is currently not used for anything.
+            items: {}
+          v:
+            type: number
+            description: Version.
+          gv:
+            type: string
+            description: Stands for "Gravatar version" and is used for cache busting.
+      bindings:
+        http:
+          $ref: '#/components/messageBindings/streamingHeaders'
+
+    heartbeat:
+      schemaFormat: 'application/schema+yaml;version=draft-07'
+      summary: Its purpose is to keep the connection alive.
+      payload:
+        type: string
+        enum: ["\r\n"]
+      bindings:
+        http:
+          $ref: '#/components/messageBindings/streamingHeaders'
+  
+  messageBindings:
+    streamingHeaders:
+      http:
+        headers:
+          'Transfer-Encoding': 'chunked'
+          Trailer: '\r\n'

package/assets/examples/mercure.yml

@@ -0,0 +1,49 @@
+asyncapi: '2.2.0'
+info:
+  title: Mercure Hub Example
+  version: '1.0.0'
+  description: This example demonstrates how to define a Mercure hub.
+
+# While not mandatory, it's a best practice to use formats with hypermedia capabilities such as JSON-LD, Atom or HTML with the Mercure protocol
+defaultContentType: application/ld+json
+
+servers:
+  production:
+    url: https://demo.mercure.rocks/.well-known/mercure
+    protocol: mercure
+
+channels:
+  'https://example.com/books/{id}':
+    description: Every time a resource of type `http://schema.org/Book` is created or modified, a JSON-LD representation of the new version of this resource must be pushed in this Mercure topic.
+    parameters:
+      id:
+        schema:
+          type: integer
+    subscribe:
+      message:
+        $ref: '#/components/messages/book'      
+    publish:
+      message:
+        $ref: '#/components/messages/book'
+
+components:
+  messages:
+    book:
+      summary: The content of a book resource.
+      externalDocs:
+        url: https://schema.org/Book
+      payload:
+        type: object
+        properties:
+          '@id':
+            type: string
+            format: iri-reference
+          '@type':
+            type: string
+            format: iri-reference
+          name:
+            type: string
+          isbn:
+            type: string
+          abstract:
+            type: string

package/assets/examples/not.yml

@@ -0,0 +1,24 @@
+asyncapi: '2.2.0'
+info:
+  title: Not example
+  version: '1.0.0'
+
+channels:
+  test:
+    publish:
+      message:
+        $ref: '#/components/messages/testMessages'
+
+components:
+  messages:
+    testMessages:
+      payload:
+        $ref: "#/components/schemas/testSchema"
+
+  schemas:
+    testSchema:
+      type: object
+      properties:
+        key:
+          not:
+            type: integer

package/assets/examples/oneof.yml

@@ -0,0 +1,46 @@
+asyncapi: '2.2.0'
+info:
+  title: OneOf example
+  version: '1.0.0'
+
+channels:
+  test:
+    publish:
+      message:
+        $ref: '#/components/messages/testMessages'
+
+  test2:
+    subscribe:
+      message:
+        # Use oneOf here if different messages are published on test2 topic.
+        oneOf:
+          - payload:
+              $ref: "#/components/schemas/objectWithKey"
+          - payload:
+              $ref: "#/components/schemas/objectWithKey2"
+
+components:
+  messages:
+    testMessages:
+      payload:
+        oneOf: # oneOf in payload schema
+          - $ref: "#/components/schemas/objectWithKey"
+          - $ref: "#/components/schemas/objectWithKey2"
+    testMessage1:
+      payload:
+        $ref: "#/components/schemas/objectWithKey"
+    testMessage2:
+      payload:
+        $ref: "#/components/schemas/objectWithKey2"
+
+  schemas:
+    objectWithKey:
+      type: object
+      properties:
+        key:
+          type: string
+    objectWithKey2:
+      type: object
+      properties:
+        key2:
+          type: string