@osdlc/yaml-splice 0.0.0-stage → 0.1.4

package/CHANGELOG.md

@@ -0,0 +1,57 @@
+# Changelog
+
+## 0.1.4
+
+### Patch Changes
+
+- fa792c7: The first release on npm. Versions 0.1.0 to 0.1.3 were used only during development and were never published. It edits top-level fields of a YAML mapping in place, on bytes: set, remove or rename a field, and every byte outside the edited span stays as it was, including comments, key order, quoting, a BOM and line endings. It runs the `yaml-splice` Rust crate through WebAssembly, so it has no runtime dependencies and no native code.
+  
+  - `editYaml(source, edits)` applies a batch of `FieldEdit`s (`Set`, `Remove`, `Rename`) in order and returns an `EditOutcome` (`bytes` and `changed`). The batch is atomic: a refused edit throws an `EditError` with an `EditErrorCode` and, where known, an `EditSpan`, and nothing is returned.
+  - Keys match case-insensitively.
+  
+  Fixed since the last development version:
+  
+  - `Set` on a quoted value with a comment after it (`title: 'Draft'  # note`) no longer deletes the comment.
+  - `Set` on a block scalar (`|` or `>`) no longer joins the next key onto the new value's line, and `Remove` on one no longer deletes the next line too.
+  - A comment indented less than a block scalar is kept: `Set` no longer joins it onto the new value's line, and `Remove` no longer deletes it.
+  - An empty block scalar (`a: |`, also with a tag or an anchor) can now be set and removed. Both were refused.
+  - When a new value is written as a block, the old value's trailing comment moves to the block's header line instead of becoming part of the value.
+  - A keep-chomped (`|+`) value keeps its trailing line breaks: setting `"kept\n\n"` no longer writes `"kept\n"`.
+  - `editYaml` checks each edit against what it asked for. It throws `EditError('InvalidResult', …)` when an edit would change the value or order of a key it does not address, or when the addressed key would not read back as set, removed or renamed. Before, it returned that document. A `.nan` value in another key no longer counts as a change.
+  
+  All seven exports are stable. Node.js 22 or later and Bun; no browser or bundler build yet. Shipped as compiled JavaScript with type declarations. Tested on Linux and macOS. Licensed `MIT OR Apache-2.0`.
+
+## History before the first public release
+
+These versions were developed in a private repository before the package moved here, and
+were never published. They are rebuilt from the git history.
+
+### [0.1.3] - 2026-09-07 (unpublished)
+
+#### Fixed
+
+- `editYaml` refuses `NaN`, `Infinity` and `-Infinity` anywhere in a `Set` value, nested values
+  included, with `EditError('UnrenderableValue', …)` before any byte is written. Before, they
+  were written as YAML `null`.
+
+### [0.1.2] - 2026-09-06 (unpublished)
+
+#### Fixed
+
+- The built entry (`dist/`) loads under Node. It imported the WebAssembly glue from a path the
+  build did not create.
+
+### [0.1.1] - 2026-07-21 (unpublished)
+
+#### Fixed
+
+- `EditError.span` is a truly optional property, so it type-checks under a consumer's
+  `exactOptionalPropertyTypes`.
+
+### [0.1.0] - 2026-07-21 (unpublished)
+
+#### Added
+
+- `editYaml(source, edits)`: set, remove or rename top-level fields of a YAML mapping without
+  reserializing it, with the types `FieldEdit`, `EditValue`, `EditOutcome`, `EditError`,
+  `EditErrorCode` and `EditSpan`.

package/CONTRIBUTING.md

@@ -0,0 +1,90 @@
+# Contributing
+
+Thanks for your interest in `@osdlc/yaml-splice`.
+
+## Issues
+
+Report bugs and ask for features in the
+[issue tracker](https://github.com/osdlc/osdlc/issues). For a bug, include the
+library version, your runtime and its version, the YAML input (escape a BOM or
+`\r` so it survives copying), and the edits you passed. Report security
+problems privately. See [SECURITY.md](./SECURITY.md).
+
+## Pull requests
+
+This package lives in [osdlc/osdlc](https://github.com/osdlc/osdlc) under
+`packages/ts/yaml-splice`. Open pull requests there. They are reviewed and
+merged there.
+
+## Where a change goes
+
+The editing itself is the `yaml-splice` Rust crate, in `packages/rust/yaml-splice`.
+`packages/rust/yaml-splice-wasm` exposes it to JavaScript, and this package's
+`index.ts` is the typed wrapper over that. A change to how YAML is edited goes
+into the crate, with a fixture in its conformance corpus
+(`packages/rust/yaml-splice/tests/fixtures/conformance.json`), which both the
+crate's tests and this package's tests run.
+
+## Running the tests
+
+The repository is a pnpm workspace. Install from the repository root, then
+work in the package directory. The unit tests run under Bun, so install
+[Bun](https://bun.sh) as well as Node 22 or later. No Rust toolchain is needed:
+the built WebAssembly is committed in `wasm/`.
+
+```sh
+pnpm install
+cd packages/ts/yaml-splice
+pnpm test
+```
+
+`pnpm test` runs the Bun suite on the source, then builds the package and
+runs `tests/corpus-node.mjs`, which runs the conformance corpus on the built
+package under Node.
+
+`pnpm run smoke` runs `tests/smoke.mjs`, a short check of the built package
+under Node. It is not published.
+`pnpm run coverage` reports test coverage.
+
+Other checks:
+
+```sh
+pnpm run typecheck
+pnpm run lint
+pnpm run format:check
+```
+
+## Rebuilding the WebAssembly
+
+`wasm/` is built from the crates by `packages/rust/yaml-splice-wasm/build.sh`
+(`pnpm run build:wasm`). Rebuild it whenever either crate changes, and commit
+the result. The script needs:
+
+- the Rust toolchain pinned in `packages/rust/rust-toolchain.toml`, with the
+  `wasm32-unknown-unknown` target (`rustup target add wasm32-unknown-unknown`);
+- `wasm-bindgen` 0.2.126 (`cargo install wasm-bindgen-cli --version 0.2.126`);
+- `wasm-opt` from binaryen `version_131`.
+
+The `wasm` job in `.github/workflows/rust-ci.yml` rebuilds `wasm/` on every
+pull request that touches the crates or `wasm/`, and fails when the result
+differs from what is committed. When it fails, it uploads the rebuilt files
+as the `yaml-splice-wasm` artifact.
+
+A change that changes the WebAssembly changes what this package does, so it
+needs a changeset for `@osdlc/yaml-splice` (see below), even when no file in
+this directory other than `wasm/` changed.
+
+## Code style
+
+- TypeScript, ES modules, and explicit `.ts` import paths.
+- Prettier formats the code and oxlint checks it. Run `pnpm run format` and
+  `pnpm run lint` before you commit.
+- Add a test for each behaviour change or bug fix.
+- A new export gets TSDoc and a use in `examples/`, which imports the package
+  by name. A test fails if an export has no example.
+- An experimental export carries `@experimental` and is listed in the
+  README's Stability section. A test checks that the two agree.
+- For a change users can see, add a changeset: run `pnpm changeset` at the
+  repository root. Start a breaking change's summary with `**Breaking:**`.
+  Do not edit `CHANGELOG.md` or `version` by hand; the release writes them.
+  See [packages/README.md](https://github.com/osdlc/osdlc/blob/main/packages/README.md).

package/LICENSE-APACHE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 sksizer
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/LICENSE-MIT

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 sksizer
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,3 +1,154 @@
-# Temporary Holding Version
+# @osdlc/yaml-splice
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Edit top-level fields of a YAML mapping in place, on bytes. Set, remove or
+rename a field, and every byte outside the edited span stays as it was:
+comments, key order, quoting, a byte-order mark and line endings. It runs the
+`yaml-splice` Rust crate as WebAssembly, so it has no runtime dependencies and
+no native code.
+
+## Why
+
+A program that changes one value in a YAML file usually parses the file and
+writes it out again. The values come back right, but the text does not:
+comments move or vanish, quotes change, keys are reordered, and CRLF becomes
+LF. In version control the whole file shows as changed, and the person who
+wrote it loses their layout.
+
+This package changes only the bytes of the field you edit. Everything else is
+copied from the input. If an edit cannot be made that way, it refuses with a
+typed error instead of guessing.
+
+It is for programs that write YAML that people also edit by hand: Markdown
+frontmatter, config files, and tools that sync metadata into notes.
+
+When not to use it:
+
+- To read values. Use a YAML parser, such as `yaml`.
+- To edit nested values. Only top-level keys of a mapping are addressed; a
+  `Set` replaces a key's whole value.
+- In a browser or through a bundler such as Vite. This release loads under
+  Node.js and Bun only (see Runtimes and platforms).
+
+## Install
+
+```sh
+npm install @osdlc/yaml-splice
+```
+
+ESM only. Node.js 22 or later, or Bun.
+
+## Quick start
+
+```ts
+import { editYaml } from '@osdlc/yaml-splice'
+
+const source = new TextEncoder().encode("title: 'Draft'  # shown in the header\nstatus: draft\n")
+
+const out = editYaml(source, [
+  { Set: { key: 'status', value: 'done' } },
+  { Rename: { from: 'title', to: 'name' } },
+])
+
+new TextDecoder().decode(out.bytes) // "name: 'Draft'  # shown in the header\nstatus: done\n"
+out.changed // true
+```
+
+More in `examples/`: setting values, removing and renaming in one batch, and
+handling refusals.
+
+## API
+
+- `editYaml(source, edits)` takes the document as UTF-8 bytes (`Uint8Array`)
+  and a list of `FieldEdit`s, and returns an `EditOutcome`: the new `bytes` and
+  `changed`. It throws an `EditError` when it refuses.
+- `FieldEdit` is one edit: `{ Set: { key, value } }`,
+  `{ Remove: { key } }` or `{ Rename: { from, to } }`.
+- `EditValue` is the value a `Set` writes: any JSON-shaped value. Maps and
+  lists are written as block YAML under the key.
+- `EditOutcome` holds `bytes` and `changed`. When no value changed, `bytes`
+  equals the input and `changed` is `false`, so a caller can skip the write.
+- `EditError` is the refusal. Its `code` (an `EditErrorCode`) says why, and
+  `name` is the same code. `span`, an `EditSpan`, is the byte range
+  `[start, end)` in the input that the refusal is about, when there is one.
+- `EditErrorCode` is one of `InvalidUtf8`, `MalformedYaml`,
+  `UnsupportedDocument`, `RootNotMapping`, `AmbiguousKey`, `MissingKey`,
+  `KeyConflict`, `UnrenderableValue` and `InvalidResult`. A minor release may
+  add a code, so give a `switch` over it a `default` branch.
+- `EditSpan` is `{ start, end }`, in bytes. `RootNotMapping`, `AmbiguousKey`
+  and `KeyConflict` always carry one; `MalformedYaml` and
+  `UnsupportedDocument` carry one when the parser knows the location.
+
+Each export has TSDoc in the source. Your editor shows it.
+
+## Behaviour
+
+- The edits apply in order, and each one sees the result of the ones before
+  it. The batch is atomic: if any edit is refused, nothing is returned.
+- Keys match case-insensitively: `Title` and `title` are the same key. Both
+  sides are lowercased and nothing else is normalized. Two existing keys that
+  differ only in case make an edit of either one `AmbiguousKey`.
+- `Set` on a missing key appends it after the last top-level entry. `Remove`
+  of a missing key changes nothing. `Rename` of a missing key is
+  `MissingKey`; a rename onto an existing key is `KeyConflict`.
+- New lines use the document's first line ending (LF or CRLF). A BOM stays at
+  byte zero.
+- `NaN` and `±Infinity` anywhere in a `Set` value are refused as
+  `UnrenderableValue` before any byte is written.
+- Each edit is checked against what it asked for: the addressed key must read
+  back as set, removed or renamed, and no other key may change value or
+  order. If not, the batch is refused as `InvalidResult` instead of returning
+  a damaged document.
+
+## How it compares
+
+- [`yaml`](https://www.npmjs.com/package/yaml) keeps comments through its Document
+  API, but writes the whole document out again, so quoting, spacing and
+  line endings can change. Use it to read and to build YAML; use this package
+  to change a value in a file a person edits.
+- [`yaml-diff-patch`](https://www.npmjs.com/package/yaml-diff-patch) and
+  [`yawn-yaml`](https://www.npmjs.com/package/yawn-yaml) keep comments and most
+  formatting, but do not promise that the bytes outside the edit are
+  unchanged, and have no typed refusals.
+- [`@osdlc/frontmatter-lossless`](https://www.npmjs.com/package/@osdlc/frontmatter-lossless)
+  splits a Markdown note into its frontmatter and body. The two compose:
+  split the note, edit the YAML bytes here, and put the note back together.
+
+The Rust crate [`yaml-splice`](https://crates.io/crates/yaml-splice) is the
+implementation. This package runs it as WebAssembly, and its tests run the
+crate's conformance corpus.
+
+## Stability
+
+The package is 0.x, so any minor release may break the API. Within that, each
+export is stable or experimental. A breaking change to a stable export is
+listed in the CHANGELOG under "Breaking". Any release may change or remove an
+experimental export.
+
+The experimental exports:
+
+- none
+
+## Tested claims
+
+| Claim | Test |
+|---|---|
+| Comments, key order and quoting outside the edit are kept | corpus fixture `a_changed_value_keeps_comments_key_order_and_quoting` |
+| A BOM is kept | corpus fixture `a_bom_is_preserved_and_outside_every_span` |
+| CRLF and mixed line endings are kept | corpus fixtures `crlf_line_endings_survive_outside_the_edited_span`, `mixed_line_endings_are_not_normalized` |
+| An edit that changes no value returns the input bytes | `tests/index.test.ts`, "a semantic no-op …" |
+| Non-finite numbers are refused before any write | `tests/index.test.ts`, "a non-finite number in a Set value" |
+| `EditErrorCode` lists every refusal the crate has | `tests/index.test.ts`, "EditErrorCode" |
+
+## Runtimes and platforms
+
+Node.js 22 or later, and Bun. The WebAssembly glue is built for Node.js: it
+reads the `.wasm` file with `fs` from beside itself. So the package does not
+load in a browser, in Deno without Node compatibility, or through a bundler
+such as Vite. The built package is tested on Node.js 22 and 24, and the test
+suite also runs under Bun. It has no native code and no platform-specific
+code, so it runs on any operating system Node.js runs on. Its tests run on
+Linux and macOS.
+
+## License
+
+`MIT OR Apache-2.0`, at your option.

package/SECURITY.md

@@ -0,0 +1,23 @@
+# Security policy
+
+## Reporting a vulnerability
+
+Please report vulnerabilities privately. Do not open a public issue.
+
+Use GitHub private vulnerability reporting on the repository: open the
+[Security tab](https://github.com/osdlc/osdlc/security) and choose
+"Report a vulnerability".
+
+Include the version, a short description, and steps to reproduce. A minimal
+code sample helps.
+
+## Supported versions
+
+Only the latest release of the newest major version gets security fixes.
+Upgrade to it.
+
+## What to expect
+
+This is a small project. We aim to reply within a week. We will tell you
+whether we accept the report and keep you updated until a fix is released.
+We will credit you in the release notes if you want that.

package/dist/index.d.ts

@@ -0,0 +1,78 @@
+/**
+ * A JSON-shaped value a `Set` edit may write: the same shape a JavaScript value
+ * can take, matching the crate's `From<&serde_json::Value>` bridge. Object key
+ * order for NESTED maps is not load-bearing (see the crate's ordering caveat);
+ * the TOP-LEVEL key being edited is addressed by `key`, never rebuilt.
+ */
+export type EditValue = null | boolean | number | string | readonly EditValue[] | {
+    readonly [key: string]: EditValue;
+};
+/**
+ * One top-level field edit, externally tagged to match the crate's `FieldEdit`
+ * enum: exactly one of `Set`, `Remove` or `Rename`. A `Remove` of a key that is
+ * not there changes nothing.
+ */
+export type FieldEdit = {
+    readonly Set: {
+        readonly key: string;
+        readonly value: EditValue;
+    };
+} | {
+    readonly Remove: {
+        readonly key: string;
+    };
+} | {
+    readonly Rename: {
+        readonly from: string;
+        readonly to: string;
+    };
+};
+/** The result of an edit batch. */
+export interface EditOutcome {
+    /** The complete output bytes. On a semantic no-op, byte-identical to input. */
+    readonly bytes: Uint8Array;
+    /** Whether any edit changed a byte. `false` means `bytes` equals the input. */
+    readonly changed: boolean;
+}
+/**
+ * Why an edit was refused: one code per variant of the crate's `EditError`.
+ * A minor release may add a code, so a `switch` over it needs a `default`
+ * branch.
+ */
+export type EditErrorCode = 'InvalidUtf8' | 'MalformedYaml' | 'UnsupportedDocument' | 'RootNotMapping' | 'AmbiguousKey' | 'MissingKey' | 'KeyConflict' | 'UnrenderableValue' | 'InvalidResult';
+/**
+ * A byte span `[start, end)` into the input. `RootNotMapping`, `AmbiguousKey`
+ * and `KeyConflict` always carry one; `MalformedYaml` and `UnsupportedDocument`
+ * carry one when the parser knows the location.
+ */
+export interface EditSpan {
+    readonly start: number;
+    readonly end: number;
+}
+/**
+ * A typed, structured refusal from the Rust core. `name`/`code` is the variant
+ * and `span` carries the byte range where one is known. Thrown by
+ * {@link editYaml} in place of the raw bindgen error.
+ */
+export declare class EditError extends Error {
+    /** The refusal variant, mirrored onto `name` so `err.name` is the code. */
+    readonly code: EditErrorCode;
+    /** Where the refusal happened, when the variant carries a location. */
+    readonly span?: EditSpan;
+    constructor(code: EditErrorCode, message: string, span?: EditSpan);
+}
+/**
+ * Edit `source` (raw UTF-8 YAML bytes) with an ordered batch of `edits`,
+ * returning new bytes plus a `changed` flag, or throwing a typed
+ * {@link EditError}. Byte-identical to `yaml_splice::edit_yaml`.
+ *
+ * The edits apply in order, and each sees the result of the ones before it.
+ * The batch is atomic: if any edit is refused, nothing is returned and no
+ * partial edit is observable. A non-finite number (`NaN`, `±Infinity`) anywhere
+ * in a `Set` value is refused as `UnrenderableValue`.
+ *
+ * Keys match case-insensitively: `Title` and `title` are the same key. Both
+ * sides are lowercased and nothing else is normalized. Two existing keys that
+ * differ only in case make an edit of either one `AmbiguousKey`.
+ */
+export declare function editYaml(source: Uint8Array, edits: readonly FieldEdit[]): EditOutcome;

package/dist/index.js

@@ -0,0 +1,129 @@
+/**
+ * Edit top-level fields of a YAML mapping in place, on bytes: set, remove or
+ * rename a field, and every byte outside the edited span stays as it was.
+ *
+ * The editor is the `yaml-splice` Rust crate, built to WebAssembly. This file
+ * is a typed wrapper over the generated glue in `./wasm`, and it is the only
+ * thing callers import. It passes the edits across as JSON, copies the result
+ * into a plain `EditOutcome`, and frees the wasm-side handle, so no handle
+ * that points into wasm memory reaches a caller. A refused edit is thrown as
+ * an {@link EditError}.
+ *
+ * The behaviour is the crate's, byte for byte: an edit that changes no value
+ * returns the input bytes, and every byte outside an edited span is kept.
+ */
+import { editYaml as editYamlWasm, } from './wasm/yaml_splice_wasm.js';
+/**
+ * A typed, structured refusal from the Rust core. `name`/`code` is the variant
+ * and `span` carries the byte range where one is known. Thrown by
+ * {@link editYaml} in place of the raw bindgen error.
+ */
+export class EditError extends Error {
+    /** The refusal variant, mirrored onto `name` so `err.name` is the code. */
+    code;
+    /** Where the refusal happened, when the variant carries a location. */
+    span;
+    constructor(code, message, span) {
+        super(message);
+        this.name = code;
+        this.code = code;
+        // Assign only when present so `span` stays a truly-optional property under a
+        // consumer's `exactOptionalPropertyTypes` (an absent property still reads as
+        // `undefined`; assigning `undefined` outright would violate that flag).
+        if (span !== undefined)
+            this.span = span;
+    }
+}
+const ERROR_CODES = new Set([
+    'InvalidUtf8',
+    'MalformedYaml',
+    'UnsupportedDocument',
+    'RootNotMapping',
+    'AmbiguousKey',
+    'MissingKey',
+    'KeyConflict',
+    'UnrenderableValue',
+    'InvalidResult',
+]);
+/**
+ * Edit `source` (raw UTF-8 YAML bytes) with an ordered batch of `edits`,
+ * returning new bytes plus a `changed` flag, or throwing a typed
+ * {@link EditError}. Byte-identical to `yaml_splice::edit_yaml`.
+ *
+ * The edits apply in order, and each sees the result of the ones before it.
+ * The batch is atomic: if any edit is refused, nothing is returned and no
+ * partial edit is observable. A non-finite number (`NaN`, `±Infinity`) anywhere
+ * in a `Set` value is refused as `UnrenderableValue`.
+ *
+ * Keys match case-insensitively: `Title` and `title` are the same key. Both
+ * sides are lowercased and nothing else is normalized. Two existing keys that
+ * differ only in case make an edit of either one `AmbiguousKey`.
+ */
+export function editYaml(source, edits) {
+    assertFiniteNumbers(edits);
+    const editsJson = JSON.stringify(edits);
+    let result;
+    try {
+        result = editYamlWasm(source, editsJson);
+    }
+    catch (raw) {
+        throw toEditError(raw);
+    }
+    // Read both fields into a plain object, THEN free the handle. The glue's
+    // `bytes` getter returns an owned copy (`.slice()`), so it survives `free()`.
+    try {
+        return { bytes: result.bytes, changed: result.changed };
+    }
+    finally {
+        result.free();
+    }
+}
+/**
+ * Refuse non-finite numbers before the JSON boundary. `JSON.stringify` renders
+ * `NaN` and `±Infinity` as `null`, so without this guard a `Set` would silently
+ * write `null` over the field instead of refusing the value.
+ */
+function assertFiniteNumbers(edits) {
+    for (const edit of edits) {
+        if ('Set' in edit)
+            assertFiniteValue(edit.Set.value, edit.Set.key);
+    }
+}
+function assertFiniteValue(value, key) {
+    if (typeof value === 'number') {
+        if (!Number.isFinite(value)) {
+            throw new EditError('UnrenderableValue', `key '${key}': ${value} is not a finite number and has no YAML rendering`);
+        }
+        return;
+    }
+    if (Array.isArray(value)) {
+        for (const item of value)
+            assertFiniteValue(item, key);
+        return;
+    }
+    if (value !== null && typeof value === 'object') {
+        for (const item of Object.values(value))
+            assertFiniteValue(item, key);
+    }
+}
+/** Map a thrown bindgen `Error` (`.name` = variant, `.span`) to `EditError`. */
+function toEditError(raw) {
+    if (raw instanceof Error) {
+        const code = ERROR_CODES.has(raw.name)
+            ? raw.name
+            : 'InvalidResult';
+        const span = readSpan(raw.span);
+        return new EditError(code, raw.message, span);
+    }
+    return new EditError('InvalidResult', String(raw));
+}
+function readSpan(span) {
+    if (span !== null &&
+        typeof span === 'object' &&
+        typeof span.start === 'number' &&
+        typeof span.end === 'number') {
+        const { start, end } = span;
+        return { start, end };
+    }
+    return undefined;
+}

package/dist/wasm/package.json

@@ -0,0 +1,3 @@
+{
+  "type": "commonjs"
+}

package/dist/wasm/yaml_splice_wasm.d.ts

@@ -0,0 +1,31 @@
+/* tslint:disable */
+/* eslint-disable */
+
+/**
+ * The successful outcome of an edit batch. A wasm-bindgen class: the caller
+ * reads `.bytes` / `.changed` and should `.free()` it when done (it owns a
+ * slot in wasm linear memory). The TS façade reads both into a plain object
+ * and frees this handle, so callers never see the class.
+ */
+export class EditResult {
+    private constructor();
+    free(): void;
+    [Symbol.dispose](): void;
+    /**
+     * The complete output bytes. On a semantic no-op these are byte-identical
+     * to the input.
+     */
+    readonly bytes: Uint8Array;
+    /**
+     * Whether any edit changed a byte.
+     */
+    readonly changed: boolean;
+}
+
+/**
+ * Edit `source` (raw UTF-8 YAML bytes) with `edits_json`, an array of
+ * externally-tagged field edits, e.g.
+ * `[{"Set":{"key":"status","value":"done"}}]`,
+ * `[{"Remove":{"key":"draft"}}]`, `[{"Rename":{"from":"a","to":"b"}}]`.
+ */
+export function editYaml(source: Uint8Array, edits_json: string): EditResult;

package/dist/wasm/yaml_splice_wasm.js

@@ -0,0 +1,229 @@
+/* @ts-self-types="./yaml_splice_wasm.d.ts" */
+
+/**
+ * The successful outcome of an edit batch. A wasm-bindgen class: the caller
+ * reads `.bytes` / `.changed` and should `.free()` it when done (it owns a
+ * slot in wasm linear memory). The TS façade reads both into a plain object
+ * and frees this handle, so callers never see the class.
+ */
+class EditResult {
+    static __wrap(ptr) {
+        const obj = Object.create(EditResult.prototype);
+        obj.__wbg_ptr = ptr;
+        EditResultFinalization.register(obj, obj.__wbg_ptr, obj);
+        return obj;
+    }
+    __destroy_into_raw() {
+        const ptr = this.__wbg_ptr;
+        this.__wbg_ptr = 0;
+        EditResultFinalization.unregister(this);
+        return ptr;
+    }
+    free() {
+        const ptr = this.__destroy_into_raw();
+        wasm.__wbg_editresult_free(ptr, 0);
+    }
+    /**
+     * The complete output bytes. On a semantic no-op these are byte-identical
+     * to the input.
+     * @returns {Uint8Array}
+     */
+    get bytes() {
+        const ret = wasm.editresult_bytes(this.__wbg_ptr);
+        var v1 = getArrayU8FromWasm0(ret[0], ret[1]).slice();
+        wasm.__wbindgen_free(ret[0], ret[1] * 1, 1);
+        return v1;
+    }
+    /**
+     * Whether any edit changed a byte.
+     * @returns {boolean}
+     */
+    get changed() {
+        const ret = wasm.editresult_changed(this.__wbg_ptr);
+        return ret !== 0;
+    }
+}
+if (Symbol.dispose) EditResult.prototype[Symbol.dispose] = EditResult.prototype.free;
+exports.EditResult = EditResult;
+
+/**
+ * Edit `source` (raw UTF-8 YAML bytes) with `edits_json`, an array of
+ * externally-tagged field edits, e.g.
+ * `[{"Set":{"key":"status","value":"done"}}]`,
+ * `[{"Remove":{"key":"draft"}}]`, `[{"Rename":{"from":"a","to":"b"}}]`.
+ * @param {Uint8Array} source
+ * @param {string} edits_json
+ * @returns {EditResult}
+ */
+function editYaml(source, edits_json) {
+    const ptr0 = passArray8ToWasm0(source, wasm.__wbindgen_malloc);
+    const len0 = WASM_VECTOR_LEN;
+    const ptr1 = passStringToWasm0(edits_json, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
+    const len1 = WASM_VECTOR_LEN;
+    const ret = wasm.editYaml(ptr0, len0, ptr1, len1);
+    if (ret[2]) {
+        throw takeFromExternrefTable0(ret[1]);
+    }
+    return EditResult.__wrap(ret[0]);
+}
+exports.editYaml = editYaml;
+function __wbg_get_imports() {
+    const import0 = {
+        __proto__: null,
+        __wbg___wbindgen_throw_344f42d3211c4765: function(arg0, arg1) {
+            throw new Error(getStringFromWasm0(arg0, arg1));
+        },
+        __wbg_new_b667d279fd5aa943: function(arg0, arg1) {
+            const ret = new Error(getStringFromWasm0(arg0, arg1));
+            return ret;
+        },
+        __wbg_new_da52cf8fe3429cb2: function() {
+            const ret = new Object();
+            return ret;
+        },
+        __wbg_set_8535240470bf2500: function() { return handleError(function (arg0, arg1, arg2) {
+            const ret = Reflect.set(arg0, arg1, arg2);
+            return ret;
+        }, arguments); },
+        __wbg_set_name_3bbc583faefa4193: function(arg0, arg1, arg2) {
+            arg0.name = getStringFromWasm0(arg1, arg2);
+        },
+        __wbindgen_cast_0000000000000001: function(arg0) {
+            // Cast intrinsic for `F64 -> Externref`.
+            const ret = arg0;
+            return ret;
+        },
+        __wbindgen_cast_0000000000000002: function(arg0, arg1) {
+            // Cast intrinsic for `Ref(String) -> Externref`.
+            const ret = getStringFromWasm0(arg0, arg1);
+            return ret;
+        },
+        __wbindgen_init_externref_table: function() {
+            const table = wasm.__wbindgen_externrefs;
+            const offset = table.grow(4);
+            table.set(0, undefined);
+            table.set(offset + 0, undefined);
+            table.set(offset + 1, null);
+            table.set(offset + 2, true);
+            table.set(offset + 3, false);
+        },
+    };
+    return {
+        __proto__: null,
+        "./yaml_splice_wasm_bg.js": import0,
+    };
+}
+
+const EditResultFinalization = (typeof FinalizationRegistry === 'undefined')
+    ? { register: () => {}, unregister: () => {} }
+    : new FinalizationRegistry(ptr => wasm.__wbg_editresult_free(ptr, 1));
+
+function addToExternrefTable0(obj) {
+    const idx = wasm.__externref_table_alloc();
+    wasm.__wbindgen_externrefs.set(idx, obj);
+    return idx;
+}
+
+function getArrayU8FromWasm0(ptr, len) {
+    ptr = ptr >>> 0;
+    return getUint8ArrayMemory0().subarray(ptr / 1, ptr / 1 + len);
+}
+
+function getStringFromWasm0(ptr, len) {
+    return decodeText(ptr >>> 0, len);
+}
+
+let cachedUint8ArrayMemory0 = null;
+function getUint8ArrayMemory0() {
+    if (cachedUint8ArrayMemory0 === null || cachedUint8ArrayMemory0.byteLength === 0) {
+        cachedUint8ArrayMemory0 = new Uint8Array(wasm.memory.buffer);
+    }
+    return cachedUint8ArrayMemory0;
+}
+
+function handleError(f, args) {
+    try {
+        return f.apply(this, args);
+    } catch (e) {
+        const idx = addToExternrefTable0(e);
+        wasm.__wbindgen_exn_store(idx);
+    }
+}
+
+function passArray8ToWasm0(arg, malloc) {
+    const ptr = malloc(arg.length * 1, 1) >>> 0;
+    getUint8ArrayMemory0().set(arg, ptr / 1);
+    WASM_VECTOR_LEN = arg.length;
+    return ptr;
+}
+
+function passStringToWasm0(arg, malloc, realloc) {
+    if (realloc === undefined) {
+        const buf = cachedTextEncoder.encode(arg);
+        const ptr = malloc(buf.length, 1) >>> 0;
+        getUint8ArrayMemory0().subarray(ptr, ptr + buf.length).set(buf);
+        WASM_VECTOR_LEN = buf.length;
+        return ptr;
+    }
+
+    let len = arg.length;
+    let ptr = malloc(len, 1) >>> 0;
+
+    const mem = getUint8ArrayMemory0();
+
+    let offset = 0;
+
+    for (; offset < len; offset++) {
+        const code = arg.charCodeAt(offset);
+        if (code > 0x7F) break;
+        mem[ptr + offset] = code;
+    }
+    if (offset !== len) {
+        if (offset !== 0) {
+            arg = arg.slice(offset);
+        }
+        ptr = realloc(ptr, len, len = offset + arg.length * 3, 1) >>> 0;
+        const view = getUint8ArrayMemory0().subarray(ptr + offset, ptr + len);
+        const ret = cachedTextEncoder.encodeInto(arg, view);
+
+        offset += ret.written;
+        ptr = realloc(ptr, len, offset, 1) >>> 0;
+    }
+
+    WASM_VECTOR_LEN = offset;
+    return ptr;
+}
+
+function takeFromExternrefTable0(idx) {
+    const value = wasm.__wbindgen_externrefs.get(idx);
+    wasm.__externref_table_dealloc(idx);
+    return value;
+}
+
+let cachedTextDecoder = new TextDecoder('utf-8', { ignoreBOM: true, fatal: true });
+cachedTextDecoder.decode();
+function decodeText(ptr, len) {
+    return cachedTextDecoder.decode(getUint8ArrayMemory0().subarray(ptr, ptr + len));
+}
+
+const cachedTextEncoder = new TextEncoder();
+
+if (!('encodeInto' in cachedTextEncoder)) {
+    cachedTextEncoder.encodeInto = function (arg, view) {
+        const buf = cachedTextEncoder.encode(arg);
+        view.set(buf);
+        return {
+            read: arg.length,
+            written: buf.length
+        };
+    };
+}
+
+let WASM_VECTOR_LEN = 0;
+
+const wasmPath = `${__dirname}/yaml_splice_wasm_bg.wasm`;
+const wasmBytes = require('fs').readFileSync(wasmPath);
+const wasmModule = new WebAssembly.Module(wasmBytes);
+let wasmInstance = new WebAssembly.Instance(wasmModule, __wbg_get_imports());
+let wasm = wasmInstance.exports;
+wasm.__wbindgen_start();

package/dist/wasm/yaml_splice_wasm_bg.wasm.d.ts

@@ -0,0 +1,15 @@
+/* tslint:disable */
+/* eslint-disable */
+export const memory: WebAssembly.Memory;
+export const __wbg_editresult_free: (a: number, b: number) => void;
+export const editYaml: (a: number, b: number, c: number, d: number) => [number, number, number];
+export const editresult_bytes: (a: number) => [number, number];
+export const editresult_changed: (a: number) => number;
+export const __wbindgen_exn_store: (a: number) => void;
+export const __externref_table_alloc: () => number;
+export const __wbindgen_externrefs: WebAssembly.Table;
+export const __wbindgen_malloc: (a: number, b: number) => number;
+export const __wbindgen_realloc: (a: number, b: number, c: number, d: number) => number;
+export const __externref_table_dealloc: (a: number) => void;
+export const __wbindgen_free: (a: number, b: number, c: number) => void;
+export const __wbindgen_start: () => void;

package/package.json

@@ -1,6 +1,69 @@
 {
   "name": "@osdlc/yaml-splice",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
+  "version": "0.1.4",
+  "description": "Edit top-level fields of a YAML mapping in place, on bytes: set, remove or rename a field, and every byte outside the edited span stays as it was, including comments, key order, quoting, a BOM and line endings. The yaml-splice Rust crate, built to WebAssembly. Node.js and Bun.",
+  "license": "MIT OR Apache-2.0",
+  "author": "sksizer",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/osdlc/osdlc.git",
+    "directory": "packages/ts/yaml-splice"
+  },
+  "homepage": "https://github.com/osdlc/osdlc/tree/main/packages/ts/yaml-splice#readme",
+  "bugs": "https://github.com/osdlc/osdlc/issues",
+  "keywords": [
+    "yaml",
+    "frontmatter",
+    "edit",
+    "lossless",
+    "comments",
+    "byte-identical",
+    "wasm",
+    "webassembly"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "type": "module",
+  "sideEffects": false,
+  "engines": {
+    "node": ">=22"
+  },
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist/",
+    "README.md",
+    "CHANGELOG.md",
+    "LICENSE-MIT",
+    "LICENSE-APACHE",
+    "SECURITY.md",
+    "CONTRIBUTING.md"
+  ],
+  "devDependencies": {
+    "@types/bun": "^1.1.14",
+    "@types/node": "^26.1.0",
+    "oxlint": "^1.65.0",
+    "prettier": "3.9.6",
+    "typescript": "~6.0.3",
+    "@osdlc/prettier-config": "^0.2.3",
+    "@osdlc/tsconfig": "^0.3.3"
+  },
+  "scripts": {
+    "build": "tsc -p tsconfig.build.json && node -e \"const fs=require('node:fs');fs.rmSync('dist/wasm',{recursive:true,force:true});fs.cpSync('wasm','dist/wasm',{recursive:true})\"",
+    "build:wasm": "bash ../../rust/yaml-splice-wasm/build.sh",
+    "clean": "node -e \"require('node:fs').rmSync('dist', { recursive: true, force: true })\"",
+    "test": "bun test && npm run test:node",
+    "test:node": "pnpm run build && node --test tests/corpus-node.mjs",
+    "coverage": "bun test --coverage",
+    "smoke": "node tests/smoke.mjs",
+    "format": "prettier --write .",
+    "format:check": "prettier --check .",
+    "lint": "oxlint .",
+    "typecheck": "tsc --noEmit && tsc -p tsconfig.build.json --noEmit"
+  }
 }