@speclynx/apidom-ns-asyncapi-2 1.12.2 → 2.1.0

package/CHANGELOG.md

@@ -3,6 +3,29 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [2.1.0](https://github.com/speclynx/apidom/compare/v2.0.1...v2.1.0) (2026-01-17)
+
+**Note:** Version bump only for package @speclynx/apidom-ns-asyncapi-2
+
+## [2.0.1](https://github.com/speclynx/apidom/compare/v2.0.0...v2.0.1) (2026-01-14)
+
+**Note:** Version bump only for package @speclynx/apidom-ns-asyncapi-2
+
+# [2.0.0](https://github.com/speclynx/apidom/compare/v1.12.2...v2.0.0) (2026-01-14)
+
+### Bug Fixes
+
+- limit source maps memory consuption ([#20](https://github.com/speclynx/apidom/issues/20)) ([4a0574f](https://github.com/speclynx/apidom/commit/4a0574fd6d466be7c33c8a5871baacd384918d22))
+
+### Features
+
+- apply innovations learned during last 3 years ([#11](https://github.com/speclynx/apidom/issues/11)) ([cfdbbfc](https://github.com/speclynx/apidom/commit/cfdbbfc2721b0dadc77eeba31dd4e8768c078d22))
+
+### BREAKING CHANGES
+
+- source maps have been completely rewritten
+- breaking changes introduced to every package public API
+
 ## [1.12.2](https://github.com/speclynx/apidom/compare/v1.12.1...v1.12.2) (2025-12-23)
 
 **Note:** Version bump only for package @speclynx/apidom-ns-asyncapi-2

package/NOTICE

@@ -5,11 +5,6 @@ This distribution includes modifications by SpecLynx.
 All such modifications are licensed under the Apache License, Version 2.0.
 A copy of the Apache 2.0 license can be found in `LICENSES/Apache-2.0.txt`.
 
-ApiDOM
-Copyright 2020 SmartBear Software Inc.
-ApiDOM is licensed under Apache 2.0 license.
-Copy of the Apache 2.0 license can be found in `LICENSES/Apache-2.0.txt` file.
-
 json-schema-ref-parser
 Copyright (c) 2015 James Messinger
 File packages/apidom-reference/src/util/url.ts (the file) was originally created under MIT license in https://github.com/APIDevTools/json-schema-ref-parser repository.
@@ -18,8 +13,8 @@ Copy of the MIT license can be found in `LICENSES/MIT.txt` file.
 
 graphql-js
 Copyright (c) GraphQL Contributors
-File packages/apidom-ast/src/traversal/visitor.ts (the file) was originally created under MIT license in https://github.com/graphql/graphql-js repository.
-The file has been copied into this project and modified. All modifications are licensed under Apache 2.0 License.
+File packages/apidom-traverse/src/traversal.ts (the file) was originally inspired by https://github.com/graphql/graphql-js repository.
+All modifications are licensed under Apache 2.0 License.
 Copy of the MIT license can be found in `LICENSES/MIT.txt` file.
 
 babel-plugin-add-import-extension
@@ -54,6 +49,20 @@ Copyright (c) 2012 James Halliday, Josh Duff, and other contributors
 Copy of the MIT license can be found in `LICENSES/MIT.txt` file.
 All modifications are licensed under Apache 2.0 License.
 
+ApiDOM
+Copyright 2020 SmartBear Software Inc.
+ApiDOM is licensed under Apache 2.0 license.
+Copy of the Apache 2.0 license can be found in `LICENSES/Apache-2.0.txt` file.
+
+minim
+Copyright (c) 2014 Stephen Mizell
+The apidom-datamodel package contains code originally created under the MIT
+License as part of the Minim project (https://github.com/refractproject/minim).
+This code has been copied into this project and modified.
+The original portions remain licensed under the MIT License. Our modifications
+to that code are licensed under the Apache License 2.0.
+Copy of the MIT license can be found in `LICENSES/MIT.txt` file.
+
 ---
 
 If the SPDX-FileCopyrightText and SPDX-License-Identifier tags are not present in the file,

package/README.md

@@ -22,20 +22,21 @@ You can install this package via [npm CLI](https://docs.npmjs.com/cli) by runnin
 ## AsyncApi 2.x.y namespace
 
 AsyncApi 2.x.y namespace consists of [number of elements](https://github.com/speclynx/apidom/tree/main/packages/apidom-ns-asyncapi-2/src/elements) implemented on top
-of [primitive ones](https://github.com/refractproject/minim/tree/main/lib/primitives).
+of [primitive ones](https://github.com/speclynx/apidom/tree/main/packages/apidom-datamodel/src/primitives).
 
 ```js
-import { createNamespace } from '@speclynx/apidom-core';
+import { Namespace } from '@speclynx/apidom-datamodel';
 import asyncApi2Namespace from '@speclynx/apidom-ns-asyncapi-2';
 
-const namespace = createNamespace(asyncApi2Namespace);
+const namespace = new Namespace();
+namespace.use(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.
+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.
 
@@ -61,23 +62,24 @@ 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](https://github.com/speclynx/apidom/blob/main/packages/apidom-ns-asyncapi-2/src/traversal/visitor.ts#L11) and [nodeTypeGetter](https://github.com/speclynx/apidom/blob/main/packages/apidom-ns-asyncapi-2/src/traversal/visitor.ts#L4).
-To learn more about these `visit` configuration options please refer to [@speclynx/apidom-ast documentation](https://github.com/speclynx/apidom/blob/main/packages/apidom-ast/README.md#visit).
+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`.
 
 ```js
-import { visit } from '@speclynx/apidom-core';
-import { AsyncApi2Element, keyMap, getNodeType } from '@speclynx/apidom-ns-asyncapi-2';
+import { traverse } from '@speclynx/apidom-traverse';
+import { AsyncApi2Element } from '@speclynx/apidom-ns-asyncapi-2';
 
 const element = new AsyncApi2Element();
 
 const visitor = {
-  AsyncApi2Element(asyncApiElement) {
+  AsyncApi2Element(path) {
+    const asyncApiElement = path.node;
     console.dir(asyncApiElement);
   },
 };
 
-visit(element, visitor, { keyMap, nodeTypeGetter: getNodeType });
+traverse(element, visitor);
 ```
 
 ## Refractors
@@ -88,7 +90,7 @@ or generic ApiDOM structures into structures built from elements of this namespa
 **Refracting JavaScript structures**:
 
 ```js
-import { InfoElement } from '@speclynx/apidom-ns-asyncapi-2';
+import { refractInfo } from '@speclynx/apidom-ns-asyncapi-2';
 
 const object = {
     title: 'my title',
@@ -96,14 +98,14 @@ const object = {
     version: '0.1.0',
 };
 
-InfoElement.refract(object); // => InfoElement({ title, description, version })
+refractInfo(object); // => InfoElement({ title, description, version })
 ```
 
 **Refracting generic ApiDOM structures**:
 
 ```js
-import { ObjectElement } from '@speclynx/apidom-core';
-import { InfoElement } from '@speclynx/apidom-ns-asyncapi-2';
+import { ObjectElement } from '@speclynx/apidom-datamodel';
+import { refractInfo } from '@speclynx/apidom-ns-asyncapi-2';
 
 const objectElement = new ObjectElement({
     title: 'my title',
@@ -111,16 +113,18 @@ const objectElement = new ObjectElement({
     version: '0.1.0',
 });
 
-InfoElement.refract(objectElement); // => InfoElement({ 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 static method.
+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`.
 
 ```js
-import { ObjectElement } from '@speclynx/apidom-core';
-import { InfoElement } from '@speclynx/apidom-ns-asyncapi-2';
+import { ObjectElement } from '@speclynx/apidom-datamodel';
+import { refractInfo } from '@speclynx/apidom-ns-asyncapi-2';
 
 const objectElement = new ObjectElement({
     title: 'my title',
@@ -134,7 +138,8 @@ const plugin = ({ predicates, namespace }) => ({
       console.dir('runs before traversal');
   },
   visitor: {
-    InfoElement(infoElement) {
+    InfoElement(path) {
+      const infoElement = path.node;
       infoElement.version = '2.6.0';
     },
   },
@@ -143,7 +148,7 @@ const plugin = ({ predicates, namespace }) => ({
   },
 });
 
-InfoElement.refract(objectElement, { plugins: [plugin] }); // => InfoElement({ title = 'my title', description = 'my description', version = '2.6.0' })
+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.
@@ -157,14 +162,14 @@ this missing value with the most appropriate semantic element type.
 
 ```js
 import { parse } from '@speclynx/apidom-parser-adapter-yaml-1-2';
-import { refractorPluginReplaceEmptyElement, AsyncApi2Element } from '@speclynx/apidom-ns-asyncapi-2';
+import { refractorPluginReplaceEmptyElement, refractAsyncApi2 } from '@speclynx/apidom-ns-asyncapi-2';
 
 const yamlDefinition = `
 asyncapi: 2.6.0
 info:
 `;
 const apiDOM = await parse(yamlDefinition);
-const asyncApiElement = AsyncApi2Element.refract(apiDOM.result, {
+const asyncApiElement = refractAsyncApi2(apiDOM.result, {
   plugins: [refractorPluginReplaceEmptyElement()],
 });