@speclynx/apidom-reference 4.14.0 → 4.16.0

package/CHANGELOG.md

@@ -3,6 +3,18 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [4.16.0](https://github.com/speclynx/apidom/compare/v4.15.0...v4.16.0) (2026-06-24)
+
+### Features
+
+- **reference:** add AsyncAPI 2 bundle strategy ([#368](https://github.com/speclynx/apidom/issues/368)) ([32acbe8](https://github.com/speclynx/apidom/commit/32acbe80604b26dcdf03292c2010e58ea74b81f8))
+
+# [4.15.0](https://github.com/speclynx/apidom/compare/v4.14.0...v4.15.0) (2026-06-24)
+
+### Features
+
+- **reference:** add Arazzo 1 bundle strategy ([#367](https://github.com/speclynx/apidom/issues/367)) ([c2bbf7f](https://github.com/speclynx/apidom/commit/c2bbf7f27214839d7288c6439ec482e4094756a3))
+
 # [4.14.0](https://github.com/speclynx/apidom/compare/v4.13.0...v4.14.0) (2026-06-23)
 
 ### Features

package/README.md

@@ -2707,7 +2707,7 @@ await bundle('https://raw.githubusercontent.com/OAI/OpenAPI-Specification/main/e
 #### [Bundle strategies](https://github.com/speclynx/apidom/tree/main/packages/apidom-reference/src/bundle/strategies)
 
 Bundle strategy determines how a document is bundled into a Compound Document. Depending on document `mediaType` option,
-every strategy differs significantly. `Bundle component` comes with three (3) default bundle strategies.
+every strategy differs significantly. `Bundle component` comes with five (5) default bundle strategies.
 
 ##### [openapi-2](https://github.com/speclynx/apidom/tree/main/packages/apidom-reference/src/bundle/strategies/openapi-2)
 
@@ -2925,6 +2925,136 @@ await bundle('/home/user/oas.json', {
 Hoisted components and embedded schema resources are annotated with a `ref-origin` meta field pointing at
 their source document. The bundling process is **immutable** by default (`bundle.immutable: true`).
 
+##### [arazzo-1](https://github.com/speclynx/apidom/tree/main/packages/apidom-reference/src/bundle/strategies/arazzo-1)
+
+Bundle strategy for bundling [Arazzo 1.x](https://spec.openapis.org/arazzo/latest.html) definitions.
+
+The only external references Arazzo defines are **JSON Schema Objects** — a
+[JSON Schema 2020-12](https://json-schema.org/draft/2020-12) dialect used by Input Objects and inline schemas.
+(Reusable Objects are internal-only runtime-expression references, and Source Descriptions point at whole
+external documents that are intentionally kept external — neither is bundled.) Schema Objects are therefore
+bundled per the [JSON Schema Compound Document](https://json-schema.org/blog/posts/bundling-json-schema-compound-documents)
+rules, exactly as in the `openapi-3-1` strategy: the external schema **resource** is embedded verbatim into
+`components.inputs` carrying its `$id` (one is assigned from the retrieval URI when absent), and the referencing
+`$ref` is left **unchanged** — it keeps resolving against the embedded resource's `$id`. The whole external
+resource is embedded once, keyed by its `$id`; references (including `$anchor`, `$dynamicRef`, and
+`$dynamicAnchor`) are never rewritten. Nested external schema resources are embedded flat into the top-level
+`components.inputs`, deduplicated by resource URI. Internal Schema Object references are preserved untouched.
+
+Supported media types:
+
+```js
+[
+  'application/vnd.oai.workflows;version=1.0.0',
+  'application/vnd.oai.workflows+json;version=1.0.0',
+  'application/vnd.oai.workflows+yaml;version=1.0.0',
+  'application/vnd.oai.workflows;version=1.0.1',
+  'application/vnd.oai.workflows+json;version=1.0.1',
+  'application/vnd.oai.workflows+yaml;version=1.0.1'
+]
+```
+
+This strategy's behavior is controlled by the same `bundle` options as the `openapi-3-1` strategy
+(`componentNamesStrategy`, `onComponentNameCollision`, `immutable`, `maxDepth`, `continueOnError`, `refSet`),
+documented above. Per-strategy overrides use the `arazzo-1` key in `bundle.strategyOpts`:
+
+```js
+import { bundle } from '@speclynx/apidom-reference';
+
+await bundle('/home/user/arazzo.json', {
+  parse: {
+    mediaType: 'application/vnd.oai.workflows+json;version=1.0.1',
+  },
+  bundle: {
+    strategyOpts: {
+      'arazzo-1': {
+        onComponentNameCollision: 'error',
+      },
+    },
+  },
+});
+```
+
+Embedded schema resources are annotated with a `ref-origin` meta field pointing at their source document.
+The bundling process is **immutable** by default (`bundle.immutable: true`).
+
+##### [asyncapi-2](https://github.com/speclynx/apidom/tree/main/packages/apidom-reference/src/bundle/strategies/asyncapi-2)
+
+Bundle strategy for bundling [AsyncAPI 2.x](https://www.asyncapi.com/docs/reference/specification/v2.6.0) definitions.
+
+It produces a self-contained, transferable Compound Document: every external reference is resolved and lifted
+into the appropriate `components` field, and the referencing `$ref` is rewritten to an internal JSON Pointer.
+**Reference Objects** are bundled exactly as in the `openapi-3-0` strategy, hoisted into the `components`
+field that matches their referencing context (Schema Objects → `components.schemas`, Message Objects →
+`components.messages`, Parameter Objects → `components.parameters`, and likewise for `servers`,
+`serverVariables`, `securitySchemes`, `correlationIds`, `operationTraits`, `messageTraits`, and the binding
+fields). Unlike OpenAPI, **Schema Objects** in AsyncAPI 2.0 are an [extended JSON Schema Draft 7](https://www.asyncapi.com/docs/reference/specification/v2.6.0#schemaObject)
+dialect that does **not** use `$id`-based resolution — a schema `$ref` is a plain Reference Object resolved by
+JSON Pointer, so schemas are hoisted into `components.schemas` like any other Reference Object rather than
+embedded as JSON Schema compound resources.
+
+**Channel Item Objects** have a `components.channels` field in AsyncAPI 2.0, so an external Channel Item is
+hoisted there (and its `$ref` rewritten to `#/components/channels/<name>`); sibling fields next to the `$ref`
+(e.g. `description`) are kept on the referencing element.
+
+Multiple references to the **same** external target (same document URI and JSON Pointer) are collapsed into a
+single component; distinct targets each get their own component, even when their content happens to be
+identical. Internal references are preserved untouched; only a self-file reference (e.g.
+`./root.json#/components/messages/UserSignedUp`) is normalized to a bare fragment
+(`#/components/messages/UserSignedUp`) so the bundled document remains transferable.
+
+Supported media types:
+
+```js
+[
+  'application/vnd.aai.asyncapi;version=2.0.0',
+  'application/vnd.aai.asyncapi+json;version=2.0.0',
+  'application/vnd.aai.asyncapi+yaml;version=2.0.0',
+  'application/vnd.aai.asyncapi;version=2.1.0',
+  'application/vnd.aai.asyncapi+json;version=2.1.0',
+  'application/vnd.aai.asyncapi+yaml;version=2.1.0',
+  'application/vnd.aai.asyncapi;version=2.2.0',
+  'application/vnd.aai.asyncapi+json;version=2.2.0',
+  'application/vnd.aai.asyncapi+yaml;version=2.2.0',
+  'application/vnd.aai.asyncapi;version=2.3.0',
+  'application/vnd.aai.asyncapi+json;version=2.3.0',
+  'application/vnd.aai.asyncapi+yaml;version=2.3.0',
+  'application/vnd.aai.asyncapi;version=2.4.0',
+  'application/vnd.aai.asyncapi+json;version=2.4.0',
+  'application/vnd.aai.asyncapi+yaml;version=2.4.0',
+  'application/vnd.aai.asyncapi;version=2.5.0',
+  'application/vnd.aai.asyncapi+json;version=2.5.0',
+  'application/vnd.aai.asyncapi+yaml;version=2.5.0',
+  'application/vnd.aai.asyncapi;version=2.6.0',
+  'application/vnd.aai.asyncapi+json;version=2.6.0',
+  'application/vnd.aai.asyncapi+yaml;version=2.6.0'
+]
+```
+
+This strategy's behavior is controlled by the same `bundle` options as the `openapi-3-0` strategy
+(`componentNamesStrategy`, `onComponentNameCollision`, `immutable`, `maxDepth`, `continueOnError`, `refSet`),
+documented above. Per-strategy overrides use the `asyncapi-2` key in `bundle.strategyOpts`:
+
+```js
+import { bundle } from '@speclynx/apidom-reference';
+
+await bundle('/home/user/asyncapi.json', {
+  parse: {
+    mediaType: 'application/vnd.aai.asyncapi+json;version=2.6.0',
+  },
+  bundle: {
+    strategyOpts: {
+      'asyncapi-2': {
+        onComponentNameCollision: 'error',
+      },
+    },
+  },
+});
+```
+
+Hoisted components are annotated with a `ref-origin` meta field pointing at their source document.
+The bundling process is **immutable** by default (`bundle.immutable: true`).
+
 ##### Bundle strategies execution order
 
 It's important to understand that default bundle strategies are run in specific order. The order is determined
@@ -2940,6 +3070,8 @@ returns `true` or until entire list of strategies is exhausted (throws error).
   new OpenAPI2BundleStrategy(),
   new OpenAPI3_0BundleStrategy(),
   new OpenAPI3_1BundleStrategy(),
+  new AsyncAPI2BundleStrategy(),
+  new Arazzo1BundleStrategy(),
 ]
 ```
 Most specific strategies are listed first, most generic are listed last.