@swagger-api/apidom-ns-asyncapi-2
Advanced tools
@swagger-api/apidom-ns-asyncapi-2 contains ApiDOM namespace supports following AsyncAPI specification versions:
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 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();
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
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 });
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' })
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).
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)))
Only fully implemented specification objects should be checked here.
FAQs
AsyncAPI 2.x.y namespace for ApiDOM.
The npm package @swagger-api/apidom-ns-asyncapi-2 receives a total of 377,018 weekly downloads. As such, @swagger-api/apidom-ns-asyncapi-2 popularity was classified as popular.
We found that @swagger-api/apidom-ns-asyncapi-2 demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Research
The Socket Research Team breaks down a malicious wrapper package that uses obfuscation to harvest credentials and exfiltrate sensitive data.
Research
Security News
Attackers used a malicious npm package typosquatting a popular ESLint plugin to steal sensitive data, execute commands, and exploit developer systems.
Security News
The Ultralytics' PyPI Package was compromised four times in one weekend through GitHub Actions cache poisoning and failure to rotate previously compromised API tokens.