@asyncapi/cli 1.2.10 → 1.2.13

package/assets/examples/websocket-gemini-asyncapi.yml

@@ -0,0 +1,301 @@
+asyncapi: 3.0.0
+info:
+  title: Gemini Market Data Websocket API
+  version: 1.0.0
+  description: >
+    Market data is a public API that streams all the market data on a given
+    symbol.
+
+
+    You can quickly play with the API using
+    [websocat](https://github.com/vi/websocat#installation) like this:
+
+    ```bash
+
+    websocat wss://api.gemini.com/v1/marketdata/btcusd?heartbeat=true -S
+
+    ```
+  contact:
+    name: Gemini
+    url: 'https://www.gemini.com/'
+  externalDocs:
+    url: 'https://docs.sandbox.gemini.com/websocket-api/#market-data'
+servers:
+  public:
+    host: api.gemini.com
+    protocol: wss
+channels:
+  marketDataV1:
+    address: '/v1/marketdata/{symbol}'
+    messages:
+      marketData:
+        $ref: '#/components/messages/marketData'
+    parameters:
+      symbol:
+        enum:
+          - btcusd
+          - ethbtc
+          - ethusd
+          - zecusd
+          - zecbtc
+          - zeceth
+          - zecbch
+          - zecltc
+          - bchusd
+          - bchbtc
+          - bcheth
+          - ltcusd
+          - ltcbtc
+          - ltceth
+          - ltcbch
+          - batusd
+          - daiusd
+          - linkusd
+          - oxtusd
+          - batbtc
+          - linkbtc
+          - oxtbtc
+          - bateth
+          - linketh
+          - oxteth
+          - ampusd
+          - compusd
+          - paxgusd
+          - mkrusd
+          - zrxusd
+          - kncusd
+          - manausd
+          - storjusd
+          - snxusd
+          - crvusd
+          - balusd
+          - uniusd
+          - renusd
+          - umausd
+          - yfiusd
+          - btcdai
+          - ethdai
+          - aaveusd
+          - filusd
+          - btceur
+          - btcgbp
+          - etheur
+          - ethgbp
+          - btcsgd
+          - ethsgd
+          - sklusd
+          - grtusd
+          - bntusd
+          - 1inchusd
+          - enjusd
+          - lrcusd
+          - sandusd
+          - cubeusd
+          - lptusd
+          - bondusd
+          - maticusd
+          - injusd
+          - sushiusd
+        description: >
+          Symbols are formatted as CCY1CCY2 where prices are in CCY2 and
+          quantities are in CCY1. To read more click
+          [here](https://docs.sandbox.gemini.com/websocket-api/#symbols-and-minimums).
+    bindings:
+      ws:
+        bindingVersion: 0.1.0
+        query:
+          type: object
+          description: >
+            The semantics of entry type filtering is:
+
+
+            If any entry type is specified as true or false, all of them must be
+            explicitly flagged true to show up in the response
+
+            If no entry types filtering parameters are included in the url, then
+            all entry types will appear in the response
+
+
+            NOTE: top_of_book has no meaning and initial book events are empty
+            when only trades is specified
+          properties:
+            heartbeat:
+              type: boolean
+              default: false
+              description: >-
+                Optionally add this parameter and set to true to receive a
+                heartbeat every 5 seconds
+            top_of_book:
+              type: boolean
+              default: false
+              description: >-
+                If absent or false, receive full order book depth; if present
+                and true, receive top of book only. Only applies to bids and
+                offers.
+            bids:
+              type: boolean
+              default: true
+              description: Include bids in change events
+            offers:
+              type: boolean
+              default: true
+              description: Include asks in change events
+            trades:
+              type: boolean
+              default: true
+              description: Include trade events
+            auctions:
+              type: boolean
+              default: true
+              description: Include auction events
+operations:
+  sendMarketData:
+    action: send
+    channel:
+      $ref: '#/channels/marketDataV1'
+    summary: Receive market updates on a given symbol
+    messages:
+      - $ref: '#/channels/marketDataV1/messages/marketData'
+components:
+  messages:
+    marketData:
+      summary: Message with marked data information.
+      description: >
+        The initial response message will show the existing state of the order
+        book. Subsequent messages will show all executed trades, as well as all
+        other changes to the order book from orders placed or canceled.
+      payload:
+        $ref: '#/components/schemas/market'
+      examples:
+        - name: updateMessage
+          summary: >-
+            Example of an update message that contains a change in price
+            information.
+          payload:
+            type: update
+            eventId: 36902233362
+            timestamp: 1619769673
+            timestampms: 1619769673527
+            socket_sequence: 661
+            events:
+              - type: change
+                side: bid
+                price: 54350.40
+                remaining: 0.002
+                delta: 0.002
+                reason: place
+        - name: heartbeatMessage
+          summary: Example of additional heartbeat message when you enable them.
+          payload:
+            type: heartbeat
+            socket_sequence: 1656
+  schemas:
+    market:
+      type: object
+      oneOf:
+        - $ref: '#/components/schemas/heartbeat'
+        - $ref: '#/components/schemas/update'
+    heartbeat:
+      allOf:
+        - properties:
+            type:
+              type: string
+              const: heartbeat
+          required:
+            - type
+        - $ref: '#/components/schemas/default'
+    update:
+      allOf:
+        - properties:
+            type:
+              type: string
+              const: update
+            eventId:
+              type: integer
+              description: >-
+                A monotonically increasing sequence number indicating when this
+                change occurred. These numbers are persistent and consistent
+                between market data connections.
+            events:
+              $ref: '#/components/schemas/events'
+            timestamp:
+              type: number
+              description: >-
+                The timestamp in seconds for this group of events (included for
+                compatibility reasons). We recommend using the timestampms field
+                instead.
+            timestampms:
+              type: number
+              description: The timestamp in milliseconds for this group of events.
+          required:
+            - type
+            - eventId
+            - events
+            - timestamp
+            - timestampms
+        - $ref: '#/components/schemas/default'
+    default:
+      type: object
+      description: >-
+        This object is always part of the payload. In case of type=heartbeat,
+        these are the only fields.
+      required:
+        - type
+        - socket_sequence
+      properties:
+        socket_sequence:
+          type: integer
+          description: >-
+            zero-indexed monotonic increasing sequence number attached to each
+            message sent - if there is a gap in this sequence, you have missed a
+            message. If you choose to enable heartbeats, then heartbeat and
+            update messages will share a single increasing sequence. See
+            [Sequence
+            Numbers](https://docs.sandbox.gemini.com/websocket-api/#sequence-numbers)
+            for more information.
+    events:
+      type: array
+      description: >-
+        Either a change to the order book, or the indication that a trade has
+        occurred.
+      items:
+        type: object
+        additionalProperties: false
+        properties:
+          type:
+            type: string
+            enum:
+              - trade
+              - change
+              - 'auction, block_trade'
+          price:
+            type: number
+            multipleOf: 0.01
+            description: The price of this order book entry.
+          side:
+            type: string
+            enum:
+              - bid
+              - side
+          reason:
+            type: string
+            enum:
+              - place
+              - trade
+              - cancel
+              - initial
+            description: >-
+              Indicates why the change has occurred. initial is for the initial
+              response message, which will show the entire existing state of the
+              order book.
+          remaining:
+            type: number
+            description: >-
+              The quantity remaining at that price level after this change
+              occurred. May be zero if all orders at this price level have been
+              filled or canceled.
+          delta:
+            type: number
+            description: >-
+              The quantity changed. May be negative, if an order is filled or
+              canceled. For initial messages, delta will equal remaining.

package/oclif.manifest.json

@@ -1,5 +1,5 @@
 {
-  "version": "1.2.10",
+  "version": "1.2.13",
   "commands": {
     "bundle": {
       "id": "bundle",
@@ -739,7 +739,7 @@
           "name": "example",
           "type": "option",
           "char": "e",
-          "description": "name of the example to use. Available examples are:\n\t - simple.yml\n\t - anyof.yml\n\t - application-headers.yml\n\t - correlation-id.yml\n\t - websocket-gemini.yml\n\t - gitter-streaming.yml\n\t - mercure.yml\n\t - not.yml\n\t - operation-security.yml\n\t - oneof.yml\n\t - rpc-client.yml\n\t - rpc-server.yml\n\t - slack-rtm.yml\n\t - tutorial.yml\n\t - streetlights-kafka.yml\n\t - streetlights-operation-security.yml\n\t - streetlights-mqtt.yml",
+          "description": "name of the example to use. Available examples are:\n\t - simple-asyncapi.yml\n\t - adeo-kafka-request-reply-asyncapi.yml\n\t - anyof-asyncapi.yml\n\t - application-headers-asyncapi.yml\n\t - correlation-id-asyncapi.yml\n\t - websocket-gemini-asyncapi.yml\n\t - gitter-streaming-asyncapi.yml\n\t - kraken-websocket-request-reply-message-filter-in-reply-asyncapi.yml\n\t - kraken-websocket-request-reply-multiple-channels-asyncapi.yml\n\t - mercure-asyncapi.yml\n\t - not-asyncapi.yml\n\t - operation-security-asyncapi.yml\n\t - oneof-asyncapi.yml\n\t - rpc-client-asyncapi.yml\n\t - rpc-server-asyncapi.yml\n\t - slack-rtm-asyncapi.yml\n\t - tutorial.yml\n\t - streetlights-kafka-asyncapi.yml\n\t - streetlights-operation-security-asyncapi.yml\n\t - streetlights-mqtt-asyncapi.yml",
           "multiple": false
         },
         "studio": {
@@ -831,7 +831,7 @@
           "name": "example",
           "type": "option",
           "char": "e",
-          "description": "name of the example to use. Available examples are:\n\t - simple.yml\n\t - anyof.yml\n\t - application-headers.yml\n\t - correlation-id.yml\n\t - websocket-gemini.yml\n\t - gitter-streaming.yml\n\t - mercure.yml\n\t - not.yml\n\t - operation-security.yml\n\t - oneof.yml\n\t - rpc-client.yml\n\t - rpc-server.yml\n\t - slack-rtm.yml\n\t - tutorial.yml\n\t - streetlights-kafka.yml\n\t - streetlights-operation-security.yml\n\t - streetlights-mqtt.yml",
+          "description": "name of the example to use. Available examples are:\n\t - simple-asyncapi.yml\n\t - adeo-kafka-request-reply-asyncapi.yml\n\t - anyof-asyncapi.yml\n\t - application-headers-asyncapi.yml\n\t - correlation-id-asyncapi.yml\n\t - websocket-gemini-asyncapi.yml\n\t - gitter-streaming-asyncapi.yml\n\t - kraken-websocket-request-reply-message-filter-in-reply-asyncapi.yml\n\t - kraken-websocket-request-reply-multiple-channels-asyncapi.yml\n\t - mercure-asyncapi.yml\n\t - not-asyncapi.yml\n\t - operation-security-asyncapi.yml\n\t - oneof-asyncapi.yml\n\t - rpc-client-asyncapi.yml\n\t - rpc-server-asyncapi.yml\n\t - slack-rtm-asyncapi.yml\n\t - tutorial.yml\n\t - streetlights-kafka-asyncapi.yml\n\t - streetlights-operation-security-asyncapi.yml\n\t - streetlights-mqtt-asyncapi.yml",
           "multiple": false
         },
         "studio": {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@asyncapi/cli",
   "description": "All in one CLI for all AsyncAPI tools",
-  "version": "1.2.10",
+  "version": "1.2.13",
   "author": "@asyncapi",
   "bin": {
     "asyncapi": "./bin/run"
@@ -9,13 +9,13 @@
   "bugs": "https://github.com/asyncapi/cli/issues",
   "dependencies": {
     "@asyncapi/avro-schema-parser": "^3.0.7",
-    "@asyncapi/bundler": "^0.3.8",
+    "@asyncapi/bundler": "^0.4.0",
     "@asyncapi/converter": "^1.4.5",
     "@asyncapi/diff": "^0.4.1",
     "@asyncapi/generator": "^1.15.5",
-    "@asyncapi/modelina": "^2.0.2",
+    "@asyncapi/modelina": "^2.0.9",
     "@asyncapi/openapi-schema-parser": "^3.0.5",
-    "@asyncapi/optimizer": "^0.2.4",
+    "@asyncapi/optimizer": "^0.2.5",
     "@asyncapi/parser": "^3.0.1",
     "@asyncapi/protobuf-schema-parser": "^3.0.4",
     "@asyncapi/raml-dt-schema-parser": "^4.0.6",

package/assets/examples/anyof.yml

@@ -1,31 +0,0 @@
-asyncapi: '2.6.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/gitter-streaming.yml

@@ -1,168 +0,0 @@
-asyncapi: '2.6.0'
-id: 'tag:stream.gitter.im,2022: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:
-          type: object
-          properties:
-            'Transfer-Encoding':
-              const: 'chunked'
-            Trailer:
-              const: '\r\n'

package/assets/examples/mercure.yml

@@ -1,49 +0,0 @@
-asyncapi: '2.6.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

@@ -1,24 +0,0 @@
-asyncapi: '2.6.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

@@ -1,46 +0,0 @@
-asyncapi: '2.6.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