@osdlc/frontmatter-lossless 0.0.0-stage → 1.0.0

package/CHANGELOG.md

@@ -0,0 +1,33 @@
+# Changelog
+
+## 1.0.0
+
+### Major Changes
+
+- 727940a: The first release on npm, and the start of the stable 1.x line. Version 0.1.0 was used only during development and was never published, so this entry lists everything the package does. It splits a Markdown note into its YAML frontmatter and body, with offsets into the source, and puts it back together byte for byte: the byte-order mark, CRLF line endings and the exact fence bytes are kept. No dependencies. It is the TypeScript twin of the `frontmatter-lossless` Rust crate, held to it by a shared conformance corpus.
+  
+  - `split(src)` returns a `Split`: `yaml` (verbatim, without the `---` fences, or `null` when the note has no block), `body`, the offsets `yamlRange` (a `SourceRange`) and `bodyStart`, and a `shape` (`NoteShape`) that records the byte-order mark and the line endings of both fences (`OpenEol`, `CloseEol`). A missing or malformed closing fence is not an error: the whole note is body.
+  - `compose(frontmatter, body, shape)` rebuilds the note; passing back what `split` returned gives the original text byte for byte. New YAML written into a shape taken from an empty block gets its own line, and so does a new body written into a shape taken from a note that ended at its closing fence. Take `NoteShape` from `split` rather than building one: a minor release may add a field.
+  - `splitLenient(content)` reads hand-written input with leading blank lines or indentation before the opening fence, or trailing spaces on the fence lines. The closing fence must not be indented. It returns a `LenientSplit` (`yaml` and `body`), or `null` when there is no block. It is for reading only.
+  
+  All nine exports are stable. Node.js 22 or later, ESM only, shipped as compiled JavaScript with type declarations. Tested on Linux and macOS. Licensed `MIT OR Apache-2.0`.
+
+## History before the first public release
+
+This version was developed in a private repository before the package moved here, and was
+never published. It is rebuilt from the git history.
+
+### [0.1.0] - 2026-08-07 (unpublished)
+
+#### Added
+
+- `split(src)` splits a note into `yaml` (verbatim, without the `---` fences, or `null` when the
+  note has no block), `body`, the source offsets `yamlRange` and `bodyStart`, and a `shape` that
+  records the byte-order mark and the line endings of both fences.
+- `compose(frontmatter, body, shape)` rebuilds the note; passing back what `split` returned gives
+  the original text byte for byte.
+- `splitLenient(content)` reads a block from hand-written input that may have leading blank lines
+  or trailing spaces on the fence lines. It returns `{ yaml, body }`, or `null` when there is no
+  block. It is for reading only and does not round-trip.
+- Types `Split`, `LenientSplit`, `NoteShape`, `SourceRange`, `OpenEol` and `CloseEol`.
+- A missing or malformed closing fence is not an error: the whole note is treated as body.

package/CONTRIBUTING.md

@@ -0,0 +1,69 @@
+# Contributing
+
+Thanks for your interest in `@osdlc/frontmatter-lossless`.
+
+## 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, and the note text that
+misbehaves (escape a BOM or `\r` so it survives copying). 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/frontmatter-lossless`. Open pull requests there. They are
+reviewed and merged there.
+
+## 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.
+
+```sh
+pnpm install
+cd packages/ts/frontmatter-lossless
+pnpm run build
+pnpm test
+```
+
+`pnpm test` runs the Bun suite on the source, then
+`tests/corpus-node.mjs`, which runs the conformance corpus on the built
+package under Node. Build first.
+
+`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
+```
+
+## The conformance corpus
+
+`tests/fixtures/conformance.json` is shared with the `frontmatter-lossless`
+Rust crate. A change to how notes are split changes both implementations and
+the corpus together, and the copy here stays byte-identical to the crate's.
+See
+[D-07](https://github.com/osdlc/osdlc/blob/main/packages/ts/frontmatter-lossless/docs/planning/decisions/D-07-conformance-corpus.md).
+
+## 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,126 @@
-# Temporary Holding Version
+# @osdlc/frontmatter-lossless
 
-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.
+Split a Markdown note into its YAML frontmatter and its body, with offsets
+into the source, and put it back together byte for byte. The byte-order mark,
+CRLF line endings and the exact fence bytes are kept. No dependencies.
+
+## Why
+
+A program that edits a note's frontmatter has to take the note apart and put
+it back. The common tools parse the YAML and write it out again, so the
+result can differ from the input even when no value changed: a BOM is lost,
+`---\r\n` fences become `---\n`, or the YAML is reformatted. In version
+control every line of the note then shows as changed.
+
+This package does only the framing. It finds the `---` block, returns the YAML
+text exactly as written, and rebuilds the note from the parts. Hand it back
+what it gave you and you get the original text.
+
+It is for programs that read or rewrite notes that people also edit: note
+apps, static site generators, linters and sync tools.
+
+When not to use it:
+
+- To read the frontmatter's values. Pass the `yaml` string to a YAML parser,
+  or use `gray-matter`, which does both steps.
+- For `+++` TOML or `;;;` JSON frontmatter. Only `---` YAML blocks are found.
+- To parse the Markdown body. The body is returned as a string.
+
+## Install
+
+```sh
+npm install @osdlc/frontmatter-lossless
+```
+
+ESM only. Node.js 22 or later.
+
+## Quick start
+
+```ts
+import { compose, split } from '@osdlc/frontmatter-lossless'
+
+const note = '---\r\ntitle: Old\r\n---\r\n# Heading\r\n'
+
+const { yaml, body, shape } = split(note)
+yaml // 'title: Old\r'  (the YAML text, verbatim)
+body // '# Heading\r\n'
+
+// Change the YAML text however you like, then put the note back.
+const updated = compose(yaml!.replace('Old', 'New'), body, shape)
+updated // '---\r\ntitle: New\r\n---\r\n# Heading\r\n'  (the CRLF fences stay)
+
+compose(yaml, body, shape) === note // true
+```
+
+## API
+
+- `split(src)` returns a `Split`: `yaml` (the text between the fences,
+  without them, or `null` when the note has no block), `body`, the offsets
+  `yamlRange` (a `SourceRange`) and `bodyStart`, and a `shape`. A block is
+  found only when the note starts with `---` and a line break, after an
+  optional BOM, and is closed by `---` alone on a line. Anything else,
+  including a block with no closing fence, is body. It never throws.
+- `compose(frontmatter, body, shape)` rebuilds the note. `frontmatter` is
+  `null` for no block, `''` for an empty block, or the YAML text. Passing back
+  what `split` returned gives the original text.
+- `NoteShape` holds the framing: `bom`, `openEol` (an `OpenEol`, `'\n'` or
+  `'\r\n'`), `closeEol` (a `CloseEol`, which can also be `''` when the note
+  ends at the closing fence) and `closeSep`. Take it from `split` and pass it
+  to `compose`. Do not build one by hand: a minor release may add a field.
+- `splitLenient(content)` reads hand-written input that `split` rejects: blank lines or indentation
+  before the opening fence, and trailing spaces on the fence lines. The closing fence must not be
+  indented. It returns a `LenientSplit` (`yaml` and `body`), or `null` when there is no block. It
+  keeps no framing, so use it to read, not to rewrite.
+
+Offsets are JavaScript string indices (UTF-16 code units):
+`src.slice(yamlRange.start, yamlRange.end) === yaml` and
+`src.slice(bodyStart) === body`.
+
+```ts
+import { splitLenient } from '@osdlc/frontmatter-lossless'
+
+splitLenient('\n---  \ntitle: A\n---\nbody\n') // { yaml: 'title: A', body: 'body\n' }
+splitLenient('no frontmatter\n') // null
+```
+
+Each export has TSDoc in the source. Your editor shows it.
+
+## How it compares
+
+- [gray-matter](https://github.com/jonschlinkert/gray-matter) and
+  [front-matter](https://github.com/jxson/front-matter) parse the frontmatter
+  into data. gray-matter writes a note back by serializing the data again,
+  so comments, quoting and line endings can change. front-matter only reads.
+  Use them when you want values; use this package when the note must come
+  back unchanged.
+- [remark-frontmatter](https://github.com/remarkjs/remark-frontmatter),
+  micromark-extension-frontmatter and vfile-matter find frontmatter as part of
+  a Markdown syntax tree or a vfile. This package needs no Markdown parser and
+  works on a plain string.
+- To edit single YAML values in place, keeping comments and key order, use a
+  YAML editor on the `yaml` string, then `compose` the result. This package
+  is the layer under such an editor.
+
+The `frontmatter-lossless` Rust crate is this package's twin: the same
+algorithm and the same conformance corpus. Its offsets are UTF-8 byte offsets.
+
+## Stability
+
+Every export is stable from 1.0.0. A breaking change to any of them needs a
+new major version and is listed in the CHANGELOG under "Breaking".
+
+The experimental exports:
+
+- none
+
+## Runtimes and platforms
+
+Node.js 22 or later, ESM only. The built package is tested on Node.js 22 and
+24, and the test suite also runs under Bun. The code is plain ES2022 string
+handling with no imports, but other runtimes, such as Deno or a browser, are
+not tested. It has no file system or platform code, so it runs on any
+operating system. 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,137 @@
+/**
+ * Byte-exact Markdown frontmatter framing.
+ *
+ * A note is `---`-fenced YAML frontmatter followed by a body. This module
+ * splits the two and recomposes them without touching a single byte the
+ * author wrote: the YAML text comes back verbatim (fences excluded), and
+ * {@link compose} rebuilds the original file exactly — same BOM, same `\n` vs
+ * `\r\n` fences, same trailing state.
+ *
+ * No YAML parsing, no file system, no dependencies: plain ES2022 string
+ * handling. Reading the frontmatter's *values* is a job for a YAML parser; this
+ * module only finds where the block is and puts it back.
+ *
+ * It is the TypeScript twin of the `frontmatter-lossless` Rust crate. It
+ * follows the crate's algorithm function for function (`split`, `compose`,
+ * `split_lenient`), and both run one shared conformance corpus.
+ *
+ * Three tolerances, each one a bug someone has already hit:
+ *
+ * - **BOM.** Notes written by some Windows editors start `\uFEFF---`. The
+ *   split recognises and remembers it so a later write can restore it.
+ * - **CRLF.** The `\r` stays attached to the YAML slice, so callers see the
+ *   exact text and {@link compose} rebuilds `---\r\n` fences rather than
+ *   silently rewriting them to `---\n` and churning the whole file in a diff.
+ * - **A missing or malformed terminator is not an error.** An unterminated
+ *   block is simply body: a projection over thousands of notes must degrade,
+ *   never abort.
+ *
+ * @module @osdlc/frontmatter-lossless
+ */
+/**
+ * Line ending after the opening `---` fence. A closed set: a new member would
+ * be a major release, so an exhaustive `switch` over it is safe.
+ */
+export type OpenEol = '\n' | '\r\n';
+/**
+ * Line ending after the closing `---` fence. Empty when the file ended there.
+ * A closed set, like {@link OpenEol}.
+ */
+export type CloseEol = '' | '\n' | '\r\n';
+/**
+ * Everything about a note's framing that a writer has to put back exactly.
+ *
+ * It exists because reassembling a note is where byte fidelity quietly dies:
+ * the *values* survive a careful splice and then `---\n` gets written over a
+ * file whose fences were `---\r\n`, and now every line of the note shows as
+ * changed in git. The fences are data too.
+ *
+ * Take it from {@link split} and pass it back to {@link compose}; do not build
+ * one by hand. A minor release may add a field, which would break an object
+ * literal typed as `NoteShape`.
+ */
+export interface NoteShape {
+    /** The byte-order mark, if the file had one. */
+    readonly bom: boolean;
+    /** Line ending of the opening fence. */
+    readonly openEol: OpenEol;
+    /** Line ending of the closing fence, empty when the note ends at it. */
+    readonly closeEol: CloseEol;
+    /** Whether the `\n` separating the block's content from the closing `---`
+     *  is present. True for every block except the adjacent-fence empty one
+     *  (`---\n---`), where the closing fence directly follows the opener's
+     *  newline. It is a separate bit because {@link Split.yaml} alone cannot
+     *  distinguish that block from a blank-line-only one (`---\n\n---`): both
+     *  yield `""`, but only the latter has a separator byte to restore. */
+    readonly closeSep: boolean;
+}
+/** A half-open index range `[start, end)` into the source string. */
+export interface SourceRange {
+    readonly start: number;
+    readonly end: number;
+}
+/**
+ * A note split into its parts, with offsets into the original source.
+ *
+ * Offsets are JavaScript string indices (UTF-16 code units), so
+ * `src.slice(yamlRange.start, yamlRange.end) === yaml` and
+ * `src.slice(bodyStart) === body` hold on the string you passed in. (The Rust
+ * crate's offsets are UTF-8 byte offsets; each side indexes its own native
+ * representation — the *content* invariants are what the shared corpus pins.)
+ */
+export interface Split {
+    /** The frontmatter YAML, verbatim and without the `---` fences. `null`
+     *  when the note has no frontmatter block at all. */
+    readonly yaml: string | null;
+    /** Range of `yaml` within the source (empty when `yaml` is `null`). */
+    readonly yamlRange: SourceRange;
+    /** Everything after the closing fence. */
+    readonly body: string;
+    /** Offset of `body` within the source. */
+    readonly bodyStart: number;
+    /** The framing to restore when writing this note back. */
+    readonly shape: NoteShape;
+}
+/** The result of a tolerant read-only split: see {@link splitLenient}. */
+export interface LenientSplit {
+    /** The text between the fence lines, without the line break before the
+     *  closing fence. */
+    readonly yaml: string;
+    /** Everything after the closing fence line. */
+    readonly body: string;
+}
+/**
+ * Split a note into its frontmatter YAML and body.
+ *
+ * Frontmatter is recognised only when the document begins with `---\n` (or
+ * `---\r\n`, or either after a BOM) and is closed by `---` alone on a line.
+ * Anything else — including a missing terminator — is body. A leading BOM is
+ * framing: it is recorded in {@link Split.shape} and excluded from both
+ * `yaml` and `body`, never duplicated into the content.
+ */
+export declare function split(src: string): Split;
+/**
+ * Reassemble a note from a (possibly spliced) frontmatter block and a body —
+ * the exact inverse of {@link split}.
+ *
+ * `frontmatter` mirrors {@link Split.yaml}: `null` is a note with no block
+ * (just the body, after any BOM), `""` is an empty `---` / `---` block, and
+ * text is a block with content. Handing `split(src).yaml` straight back
+ * reproduces `src` byte for byte for every shape.
+ */
+export declare function compose(frontmatter: string | null, body: string, shape: NoteShape): string;
+/**
+ * A tolerant, read-only frontmatter read for possibly-sloppy input.
+ *
+ * {@link split} is strict and lossless — the basis of the write path. This
+ * accepts what hand-authored notes drift into and a *reader* can safely
+ * ignore: a leading BOM, blank lines or indentation before the opening
+ * fence, and trailing whitespace on the `---` fence lines. The closing fence
+ * must not be indented. It returns `{ yaml, body }`, or `null`
+ * when there is no block (where {@link split} gives a result with
+ * `yaml: null`). It tracks no framing, so it is not a round trip —
+ * parse with it, never rewrite. A fence still closes only on `---` alone on
+ * its line (trailing whitespace aside), so a `---heading` in the body does
+ * not end the block.
+ */
+export declare function splitLenient(content: string): LenientSplit | null;

package/dist/index.js

@@ -0,0 +1,216 @@
+/**
+ * Byte-exact Markdown frontmatter framing.
+ *
+ * A note is `---`-fenced YAML frontmatter followed by a body. This module
+ * splits the two and recomposes them without touching a single byte the
+ * author wrote: the YAML text comes back verbatim (fences excluded), and
+ * {@link compose} rebuilds the original file exactly — same BOM, same `\n` vs
+ * `\r\n` fences, same trailing state.
+ *
+ * No YAML parsing, no file system, no dependencies: plain ES2022 string
+ * handling. Reading the frontmatter's *values* is a job for a YAML parser; this
+ * module only finds where the block is and puts it back.
+ *
+ * It is the TypeScript twin of the `frontmatter-lossless` Rust crate. It
+ * follows the crate's algorithm function for function (`split`, `compose`,
+ * `split_lenient`), and both run one shared conformance corpus.
+ *
+ * Three tolerances, each one a bug someone has already hit:
+ *
+ * - **BOM.** Notes written by some Windows editors start `\uFEFF---`. The
+ *   split recognises and remembers it so a later write can restore it.
+ * - **CRLF.** The `\r` stays attached to the YAML slice, so callers see the
+ *   exact text and {@link compose} rebuilds `---\r\n` fences rather than
+ *   silently rewriting them to `---\n` and churning the whole file in a diff.
+ * - **A missing or malformed terminator is not an error.** An unterminated
+ *   block is simply body: a projection over thousands of notes must degrade,
+ *   never abort.
+ *
+ * @module @osdlc/frontmatter-lossless
+ */
+const BOM = '\uFEFF';
+/**
+ * Split a note into its frontmatter YAML and body.
+ *
+ * Frontmatter is recognised only when the document begins with `---\n` (or
+ * `---\r\n`, or either after a BOM) and is closed by `---` alone on a line.
+ * Anything else — including a missing terminator — is body. A leading BOM is
+ * framing: it is recorded in {@link Split.shape} and excluded from both
+ * `yaml` and `body`, never duplicated into the content.
+ */
+export function split(src) {
+    const bom = src.startsWith(BOM);
+    const rest = bom ? src.slice(BOM.length) : src;
+    const offset = bom ? BOM.length : 0;
+    const noFrontmatter = () => ({
+        yaml: null,
+        yamlRange: { start: 0, end: 0 },
+        body: rest,
+        bodyStart: offset,
+        shape: { bom, openEol: '\n', closeEol: '\n', closeSep: true },
+    });
+    let afterMarker;
+    let markerLen;
+    let openEol;
+    if (rest.startsWith('---\n')) {
+        afterMarker = rest.slice(4);
+        markerLen = 4;
+        openEol = '\n';
+    }
+    else if (rest.startsWith('---\r\n')) {
+        afterMarker = rest.slice(5);
+        markerLen = 5;
+        openEol = '\r\n';
+    }
+    else {
+        return noFrontmatter();
+    }
+    const yamlStart = offset + markerLen;
+    // Empty frontmatter: the closing fence sits directly after the opener.
+    for (const [fence, len, closeEol] of [
+        ['---\n', 4, '\n'],
+        ['---\r\n', 5, '\r\n'],
+    ]) {
+        if (afterMarker.startsWith(fence)) {
+            return {
+                yaml: '',
+                yamlRange: { start: yamlStart, end: yamlStart },
+                body: afterMarker.slice(len),
+                bodyStart: yamlStart + len,
+                shape: { bom, openEol, closeEol, closeSep: false },
+            };
+        }
+    }
+    if (afterMarker === '---') {
+        return {
+            yaml: '',
+            yamlRange: { start: yamlStart, end: yamlStart },
+            body: '',
+            bodyStart: src.length,
+            shape: { bom, openEol, closeEol: '', closeSep: false },
+        };
+    }
+    let searchStart = 0;
+    for (;;) {
+        const found = afterMarker.indexOf('\n---', searchStart);
+        if (found === -1)
+            return noFrontmatter();
+        const dashesStart = found + 1;
+        const afterDashes = dashesStart + 3;
+        const yamlLen = found;
+        let bodyRel;
+        let closeEol;
+        if (afterDashes >= afterMarker.length) {
+            bodyRel = afterMarker.length;
+            closeEol = '';
+        }
+        else if (afterMarker[afterDashes] === '\n') {
+            bodyRel = afterDashes + 1;
+            closeEol = '\n';
+        }
+        else if (afterMarker[afterDashes] === '\r' && afterMarker[afterDashes + 1] === '\n') {
+            bodyRel = afterDashes + 2;
+            closeEol = '\r\n';
+        }
+        else {
+            // `\n---foo` is not a terminator; keep looking.
+            searchStart = afterDashes;
+            continue;
+        }
+        return {
+            yaml: afterMarker.slice(0, yamlLen),
+            yamlRange: { start: yamlStart, end: yamlStart + yamlLen },
+            body: afterMarker.slice(bodyRel),
+            bodyStart: yamlStart + bodyRel,
+            shape: { bom, openEol, closeEol, closeSep: true },
+        };
+    }
+}
+/**
+ * Reassemble a note from a (possibly spliced) frontmatter block and a body —
+ * the exact inverse of {@link split}.
+ *
+ * `frontmatter` mirrors {@link Split.yaml}: `null` is a note with no block
+ * (just the body, after any BOM), `""` is an empty `---` / `---` block, and
+ * text is a block with content. Handing `split(src).yaml` straight back
+ * reproduces `src` byte for byte for every shape.
+ */
+export function compose(frontmatter, body, shape) {
+    let out = shape.bom ? BOM : '';
+    if (frontmatter === null) {
+        // No block: the document is just its body (which the BOM, if any, now
+        // prefixes exactly once).
+        return out + body;
+    }
+    out += '---' + shape.openEol;
+    out += frontmatter;
+    // Restore the separator the split consumed while finding the terminator —
+    // a single `\n` (under CRLF the block ends in a bare `\r`, so `\n`, not
+    // `openEol`, rebuilds the original text). It is driven by the recorded
+    // shape, never inferred from the yaml text: a block ENDING in a blank
+    // line legitimately ends with `\n` and still had a separator after it.
+    // Only empty YAML can omit it: text written into a shape taken from an
+    // empty `---\n---` block still needs its own line before the closing fence.
+    if (shape.closeSep || frontmatter !== '')
+        out += '\n';
+    // A shape from a file that ended at its closing fence has no line ending
+    // there; a new body still needs one, so borrow the opening fence's.
+    out += '---' + (shape.closeEol === '' && body !== '' ? shape.openEol : shape.closeEol) + body;
+    return out;
+}
+/**
+ * A tolerant, read-only frontmatter read for possibly-sloppy input.
+ *
+ * {@link split} is strict and lossless — the basis of the write path. This
+ * accepts what hand-authored notes drift into and a *reader* can safely
+ * ignore: a leading BOM, blank lines or indentation before the opening
+ * fence, and trailing whitespace on the `---` fence lines. The closing fence
+ * must not be indented. It returns `{ yaml, body }`, or `null`
+ * when there is no block (where {@link split} gives a result with
+ * `yaml: null`). It tracks no framing, so it is not a round trip —
+ * parse with it, never rewrite. A fence still closes only on `---` alone on
+ * its line (trailing whitespace aside), so a `---heading` in the body does
+ * not end the block.
+ */
+export function splitLenient(content) {
+    const afterBom = content.startsWith(BOM) ? content.slice(BOM.length) : content;
+    const start = trimStartWhitespace(afterBom);
+    const nl = start.indexOf('\n');
+    if (nl === -1)
+        return null;
+    if (trimEndWhitespace(start.slice(0, nl)) !== '---')
+        return null;
+    const rest = start.slice(nl + 1);
+    let offset = 0;
+    while (offset < rest.length) {
+        const lineNl = rest.indexOf('\n', offset);
+        const lineEnd = lineNl === -1 ? rest.length : lineNl + 1;
+        if (trimEndWhitespace(rest.slice(offset, lineEnd)) === '---') {
+            let yaml = rest.slice(0, offset);
+            if (yaml.endsWith('\n'))
+                yaml = yaml.slice(0, -1);
+            if (yaml.endsWith('\r'))
+                yaml = yaml.slice(0, -1);
+            return { yaml, body: rest.slice(lineEnd) };
+        }
+        offset = lineEnd;
+    }
+    return null;
+}
+// Rust's `str::trim_start`/`trim_end` trim exactly Unicode `White_Space`.
+// JavaScript's `trimStart`/`trimEnd` additionally strip U+FEFF (a BOM mid-way
+// through leading spaces would silently vanish) and miss U+0085 NEL, so the
+// port trims by the same character class the reference does.
+const WHITESPACE_RE = /[\t\n\v\f\r \u0085\u00a0\u1680\u2000-\u200a\u2028\u2029\u202f\u205f\u3000]/;
+function trimStartWhitespace(s) {
+    let i = 0;
+    while (i < s.length && WHITESPACE_RE.test(s[i]))
+        i++;
+    return s.slice(i);
+}
+function trimEndWhitespace(s) {
+    let end = s.length;
+    while (end > 0 && WHITESPACE_RE.test(s[end - 1]))
+        end--;
+    return s.slice(0, end);
+}

package/package.json

@@ -1,6 +1,71 @@
 {
   "name": "@osdlc/frontmatter-lossless",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
+  "version": "1.0.0",
+  "description": "Byte-exact Markdown frontmatter framing: split a note into verbatim YAML and body with source offsets, and put it back together byte for byte. BOM, CRLF and fence bytes are kept. No dependencies.",
+  "license": "MIT OR Apache-2.0",
+  "author": "sksizer",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/osdlc/osdlc.git",
+    "directory": "packages/ts/frontmatter-lossless"
+  },
+  "homepage": "https://github.com/osdlc/osdlc/tree/main/packages/ts/frontmatter-lossless#readme",
+  "bugs": "https://github.com/osdlc/osdlc/issues",
+  "keywords": [
+    "markdown",
+    "frontmatter",
+    "front-matter",
+    "yaml",
+    "split",
+    "lossless",
+    "round-trip",
+    "byte-identical",
+    "crlf",
+    "bom",
+    "typescript"
+  ],
+  "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",
+    "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"
+  }
 }