@swagger-api/apidom-ns-asyncapi-2

@swagger-api/apidom-ns-asyncapi-2

@swagger-api/apidom-ns-asyncapi-2 contains ApiDOM namespace supports following AsyncAPI specification versions:

• AsyncAPI 2.6.0 specification
• AsyncAPI 2.5.0 specification
• AsyncAPI 2.4.0 specification
• AsyncAPI 2.3.0 specification
• AsyncAPI 2.2.0 specification
• AsyncAPI 2.1.0 specification
• AsyncAPI 2.0.0 specification

Installation

You can install this package via npm CLI by running the following command:

 $ npm install @swagger-api/apidom-ns-asyncapi-2

AsyncApi 2.x.y namespace

AsyncApi 2.x.y namespace consists of number of elements implemented on top of primitive ones.

import { createNamespace } from '@swagger-api/apidom-core';
import asyncApi2Namespace from '@swagger-api/apidom-ns-asyncapi-2';

const namespace = createNamespace(asyncApi2Namespace);

const objectElement = new namespace.elements.Object();
const asyncApiElement = new namespace.elements.AsyncApi2();

When namespace instance is created in this way, it will extend the base namespace with the namespace provided as an argument.

Elements from the namespace can also be used directly by importing them.

import { AsyncApi2Element, InfoElement } from '@swagger-api/apidom-ns-asyncapi-2';

const infoElement = new InfoElement();
const asyncApiElement = new AsyncApi2Element();

Predicates

This package exposes predicates for all higher order elements that are part of this namespace.

import { isAsyncApi2Element, AsyncApi2Element } from '@swagger-api/apidom-ns-asyncapi-2';

const asyncApiElement = new AsyncApi2Element();

isAsyncApi2Element(asyncApiElement); // => true

Traversal

Traversing ApiDOM in this namespace is possible by using visit function from apidom package. This package comes with its own keyMap and nodeTypeGetter. To learn more about these visit configuration options please refer to @swagger-api/apidom-ast documentation.

import { visit } from '@swagger-api/apidom-core';
import { AsyncApi2Element, keyMap, getNodeType } from '@swagger-api/apidom-ns-asyncapi-2';

const element = new AsyncApi2Element();

const visitor = {
  AsyncApi2Element(asyncApiElement) {
    console.dir(asyncApiElement);
  },
};

visit(element, visitor, { keyMap, nodeTypeGetter: getNodeType });

Refractors

Refractor is a special layer inside the namespace that can transform either JavaScript structures or generic ApiDOM structures into structures built from elements of this namespace.

Refracting JavaScript structures:

import { InfoElement } from '@swagger-api/apidom-ns-asyncapi-2';

const object = {
    title: 'my title',
    description: 'my description',
    version: '0.1.0',
};

InfoElement.refract(object); // => InfoElement({ title, description, version })

Refracting generic ApiDOM structures:

import { ObjectElement } from '@swagger-api/apidom-core';
import { InfoElement } from '@swagger-api/apidom-ns-asyncapi-2';

const objectElement = new ObjectElement({
    title: 'my title',
    description: 'my description',
    version: '0.1.0',
});

InfoElement.refract(objectElement); // => InfoElement({ title = 'my title', description = 'my description', version = '0.1.0' })

Refractor plugins

Refractors can accept plugins as a second argument of refract static method.

import { ObjectElement } from '@swagger-api/apidom-core';
import { InfoElement } from '@swagger-api/apidom-ns-asyncapi-2';

const objectElement = new ObjectElement({
    title: 'my title',
    description: 'my description',
    version: '0.1.0',
});

const plugin = ({ predicates, namespace }) => ({
  name: 'plugin',
  pre() {
      console.dir('runs before traversal');
  },
  visitor: {
    InfoElement(infoElement) {
      infoElement.version = '2.6.0';
    },
  },
  post() {
      console.dir('runs after traversal');
  },
});

InfoElement.refract(objectElement, { plugins: [plugin] }); // => InfoElement({ title = 'my title', description = 'my description', version = '2.6.0' })

You can define as many plugins as needed to enhance the resulting namespaced ApiDOM structure. If multiple plugins with the same visitor method are defined, they run in parallel (just like in Babel).

Replace Empty Element plugin

This plugin is specific to YAML 1.2 format, which allows defining key-value pairs with empty key, empty value, or both. If the value is not provided in YAML format, this plugin compensates for this missing value with the most appropriate semantic element type.

import { parse } from '@swagger-api/apidom-parser-adapter-yaml-1-2';
import { refractorPluginReplaceEmptyElement, AsyncApi2Element } from '@swagger-api/apidom-ns-asyncapi-2';

const yamlDefinition = `
asyncapi: 2.6.0
info:
`;
const apiDOM = await parse(yamlDefinition);
const asyncApiElement = AsyncApi2Element.refract(apiDOM.result, {
  plugins: [refractorPluginReplaceEmptyElement()],
});

// =>
// (AsyncApi2Element
//   (MemberElement
//     (StringElement)
//     (AsyncApiVersionElement))
//   (MemberElement
//     (StringElement)
//     (InfoElement)))

// => without the plugin the result would be as follows:
// (AsyncApi2Element
//   (MemberElement
//     (StringElement)
//     (AsyncApiVersionElement))
//   (MemberElement
//     (StringElement)
//     (StringElement)))

Implementation progress

Only fully implemented specification objects should be checked here.

Specification Objects

• AsyncAPI Object
• AsyncAPI Version String
• Identifier
• Info Object
• Contact Object
• License Object
• Servers Object
• Server Object
• Server Variable Object
• Default Content Type
• Channels Object
• Channel Item Object
• Operation Object
• Operation Trait Object
• Message Object
• Message Trait Object
• Message Example Object
• Tags Object
• Tag Object
• External Documentation Object
• Components Object
• Reference Object
• Schema Object
• Security Scheme Object
• Security Requirement Object
• OAuth Flows Object
• OAuth Flow Object
• Server Bindings Object
• Parameters Object
• Parameter Object
• Channel Bindings Object
• Operation Bindings Object
• Message Bindings Object
• Correlation ID Object
• Specification Extension

Binding Objects

HTTP Bindings

• Server Binding Object
• Channel Binding Object
• Operation Binding Object
• Message Binding Object

WebSockets Bindings

• Server Binding Object
• Channel Binding Object
• Operation Binding Object
• Message Binding Object

Kafka Bindings

• Server Binding Object
• Channel Binding Object
• Operation Binding Object
• Message Binding Object

Anypoint MQ Bindings

• Server Binding Object
• Channel Binding Object
• Operation Binding Object
• Message Binding Object

AMQP 0-9-1 Bindings

• Server Binding Object
• Channel Binding Object
• Operation Binding Object
• Message Binding Object

AMQP 1.0 Bindings

• Server Binding Object
• Channel Binding Object
• Operation Binding Object
• Message Binding Object

MQTT Bindings

• Server Binding Object
• Channel Binding Object
• Operation Binding Object
• Message Binding Object

MQTT 5 Bindings

• Server Binding Object
• Channel Binding Object
• Operation Binding Object
• Message Binding Object

NATS

• Server Binding Object
• Channel Binding Object
• Operation Binding Object
• Message Binding Object

JMS

• Server Binding Object
• Channel Binding Object
• Operation Binding Object
• Message Binding Object

SNS

• Server Binding Object
• Channel Binding Object
• Operation Binding Object
• Message Binding Object

Solace

• Server Binding Object
• Channel Binding Object
• Operation Binding Object
• Message Binding Object

SQS

• Server Binding Object
• Channel Binding Object
• Operation Binding Object
• Message Binding Object

STOMP

• Server Binding Object
• Channel Binding Object
• Operation Binding Object
• Message Binding Object

Redis

• Server Binding Object
• Channel Binding Object
• Operation Binding Object
• Message Binding Object

Mercure

• Server Binding Object
• Channel Binding Object
• Operation Binding Object
• Message Binding Object

IBM MQ

• Server Binding Object
• Channel Binding Object
• Operation Binding Object
• Message Binding Object

Changelog

1.0.0-beta.3 (2024-11-25)

Bug Fixes

• loggin: include files needed by main entry point (ccf46f6), closes #4539
• parser-apadter-ads: include files needed by main entry point (9ca3749), closes #4539
• reference: use upper bound <1.0.0-rc.0 for all optional deps (#4556) (d5e6982), closes #4539