Package Exports

@speclynx/apidom-ns-asyncapi-2

Readme

@speclynx/apidom-ns-asyncapi-2

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

Installation

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

 $ npm install @speclynx/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 { Namespace } from '@speclynx/apidom-datamodel';
import asyncApi2Namespace from '@speclynx/apidom-ns-asyncapi-2';

const namespace = new Namespace();
namespace.use(asyncApi2Namespace);

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

When a namespace instance is created in this way, calling use() with the namespace plugin will extend the base namespace with the AsyncAPI 2.x elements.

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

import { AsyncApi2Element, InfoElement } from '@speclynx/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 '@speclynx/apidom-ns-asyncapi-2';

const asyncApiElement = new AsyncApi2Element();

isAsyncApi2Element(asyncApiElement); // => true

Traversal

Traversing ApiDOM in this namespace is possible by using traverse function from @speclynx/apidom-traverse package. traverse uses a Path-based visitor API where visitor methods receive a Path object, and the actual element is accessed via path.node.

import { traverse } from '@speclynx/apidom-traverse';
import { AsyncApi2Element } from '@speclynx/apidom-ns-asyncapi-2';

const element = new AsyncApi2Element();

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

traverse(element, visitor);

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 { refractInfo } from '@speclynx/apidom-ns-asyncapi-2';

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

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

Refracting generic ApiDOM structures:

import { ObjectElement } from '@speclynx/apidom-datamodel';
import { refractInfo } from '@speclynx/apidom-ns-asyncapi-2';

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

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

Refractor plugins

Refractors can accept plugins as a second argument of refract function. Plugin visitors use the Path-based API where visitor methods receive a Path object, and the actual element is accessed via path.node.

import { ObjectElement } from '@speclynx/apidom-datamodel';
import { refractInfo } from '@speclynx/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(path) {
      const infoElement = path.node;
      infoElement.version = '2.6.0';
    },
  },
  post() {
      console.dir('runs after traversal');
  },
});

refractInfo(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 '@speclynx/apidom-parser-adapter-yaml-1-2';
import { refractorPluginReplaceEmptyElement, refractAsyncApi2 } from '@speclynx/apidom-ns-asyncapi-2';

const yamlDefinition = `
asyncapi: 2.6.0
info:
`;
const apiDOM = await parse(yamlDefinition);
const asyncApiElement = refractAsyncApi2(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)))

JSPM