@speclynx/apidom-overlay 6.0.6 → 6.1.1

package/CHANGELOG.md

@@ -3,6 +3,21 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [6.1.1](https://github.com/speclynx/apidom/compare/v6.1.0...v6.1.1) (2026-10-29)
+
+### Bug Fixes
+
+- **overlay:** reject overlay versions below 1.1.0 in diff ([#707](https://github.com/speclynx/apidom/issues/707)) ([c9b3a08](https://github.com/speclynx/apidom/commit/c9b3a085600fdbb8e8bacbd5a18b80ab443338b2)), closes [#606](https://github.com/speclynx/apidom/issues/606)
+- parse empty YAML values as null elements ([#712](https://github.com/speclynx/apidom/issues/712)) ([388e842](https://github.com/speclynx/apidom/commit/388e842f3156fc94f46724f507cbf0dd92acae06)), closes [#655](https://github.com/speclynx/apidom/issues/655) [#709](https://github.com/speclynx/apidom/issues/709) [#694](https://github.com/speclynx/apidom/issues/694)
+
+# [6.1.0](https://github.com/speclynx/apidom/compare/v6.0.6...v6.1.0) (2026-10-17)
+
+### Bug Fixes
+
+- **core:** keep element style when merging with deepmerge ([#679](https://github.com/speclynx/apidom/issues/679)) ([8b6c334](https://github.com/speclynx/apidom/commit/8b6c334e92770999e341b9229cdfc8f502f8c8c1)), closes [#678](https://github.com/speclynx/apidom/issues/678)
+- **overlay:** keep YAML style of values added by an overlay ([#677](https://github.com/speclynx/apidom/issues/677)) ([ca38f38](https://github.com/speclynx/apidom/commit/ca38f388ae8505330d84cc6034faf9ffa03835b2)), closes [#675](https://github.com/speclynx/apidom/issues/675)
+- serialize empty YAML nodes to null ([#655](https://github.com/speclynx/apidom/issues/655)) ([da2365b](https://github.com/speclynx/apidom/commit/da2365b0fd3287756746837cea40ab986b9d1d1d)), closes [#631](https://github.com/speclynx/apidom/issues/631)
+
 ## [6.0.6](https://github.com/speclynx/apidom/compare/v6.0.5...v6.0.6) (2026-10-15)
 
 ### Bug Fixes

package/README.md

@@ -19,7 +19,9 @@ You can install this package via [npm CLI](https://docs.npmjs.com/cli) by runnin
 ### Applying from file/URL
 
 `applyOverlay` parses an overlay document, resolves the target (from `targetURI` or the overlay's `extends` field),
-and applies all actions. The target is parsed with style preservation for round-trip fidelity.
+and applies all actions. Both documents are parsed with style preservation for round-trip fidelity,
+so values added by the overlay are written as they're written in the overlay when both are in the same
+format. Anchors, aliases and comments in the overlay aren't written to the target.
 
 ```js
 import { applyOverlay } from '@speclynx/apidom-overlay';
@@ -184,7 +186,7 @@ const overlay = await diffOverlay(
 
 | Option | Type | Default | Description |
 |---|---|---|---|
-| `overlay` | `string` | `'1.2.0'` | Version string written to the `overlay` field. Generated overlays use no 1.2.0-only features, so pass `'1.1.0'` (or `'1.0.0'`) to target an older version. |
+| `overlay` | `string` | `'1.2.0'` | Version string written to the `overlay` field. Generated overlays use no 1.2.0-only features, so pass `'1.1.0'` to target an older version. Must be `>= 1.1.0` (a version known to `@speclynx/apidom-ns-overlay-1`), otherwise `OverlayError` is thrown: generated actions update primitive values and concatenate arrays, which Overlay 1.0.0 doesn't allow. |
 | `info.title` | `string` | `'API diff'` | Title for the generated overlay's `info` object. |
 | `info.version` | `string` | `'0.0.0'` | Version for the generated overlay's `info` object. |
 | `info.description` | `string` | — | Optional description for the overlay's `info` object. |