34 lines
4.5 KiB
Markdown
34 lines
4.5 KiB
Markdown
# Port provenance
|
|
|
|
The desktop `.one` reader adapts selected structures from the pinned
|
|
`onenote.rs` implementation. It is not a line-for-line or complete port.
|
|
|
|
| TypeScript module | Upstream path(s) | Revision | Port scope and deviations |
|
|
| ---------------------------------------- | ------------------------------------------------------------------------------------------------ | ----------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------ |
|
|
| `src/onenote/onestore/file-node.ts` | `onestore/desktop/file_structure/file_node_list_fragment.rs`, `file_node/*`, chunk references | `onenote.rs@5138a39a3f4e72b840932f9872fecde52fa9da60` | Selected; immutable byte input, strict range checks, fragment/child cycle detection, and depth/count limits |
|
|
| `src/onenote/onestore/property-set.ts` | `onestore/shared/{object_prop_set,prop_set,property,object_stream_header}.rs` | same | Substantial; bounded vectors/counts/nesting and serializable discriminated unions |
|
|
| `src/onenote/onestore/desktop-store.ts` | `onestore/desktop/{file_node,file_structure,objects}/*` | same | Selected desktop section path; explicit missing-reference errors; file-data/attachment payloads skipped with diagnostics |
|
|
| `src/onenote/one/{constants,section}.ts` | `one/property*`, `one/property_set/*`, `onenote/{section,page,page_series,outline,rich_text}.rs` | same | Page metadata, titles, and plain text only; bounded graph traversal; visual/embedded content diagnosed |
|
|
|
|
The browser-native package path has separate MIT provenance:
|
|
|
|
| TypeScript module | Upstream path(s) | Revision and selected licence | Port scope and deviations |
|
|
| -------------------------------------------------------- | ------------------------------------------------------ | --------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
| `src/onenote/onepkg/{cabinet,checksum}.ts` | rust-cab `src/{cabinet,folder,file,ctype,checksum}.rs` | `c5839f5fdfa4c4e7cc9b22f570c79c96af0560e2`, MIT | CAB reading/checksum adapted for immutable browser bytes, strict normalized paths, checked ranges/checksums, whole-folder extraction, explicit limits, and cancellation/yield hooks; writers and MSZIP are not ported |
|
|
| `src/onenote/onepkg/lzx/{bit-reader,huffman,decoder}.ts` | lzxd 0.2.5 `src/{bitstream,tree,block,window,lib}.rs` | `4748e43594e3e30cff2ace3a6ad7a376c9816fdd`, MIT option of MIT OR Apache-2.0 | Directly translated core with typed arrays, CAB CFDATA boundaries, persistent folder state, strict malformed-stream errors, and operation/window/cancellation limits; delta reference data is omitted |
|
|
|
|
The bounded binary readers, format detection, parser limits/error model, path
|
|
policy, worker protocol/DTOs, package-to-section boundary, and application UI
|
|
are original TypeScript implementations guided by the normative specifications
|
|
and project requirements.
|
|
|
|
Files adapted from `onenote.rs` carry an MPL-2.0 notice, SPDX identifier,
|
|
upstream path/revision, and deviations. Files adapted from rust-cab or lzxd
|
|
carry their MIT provenance, copyright notice, exact revision, and deviations.
|
|
Licence texts are reproduced in `LICENSES/` and included in the release ZIP.
|
|
|
|
Focused tests cover successful pinned fixtures plus malformed bounds,
|
|
references, checksums, paths, Huffman trees, compressed blocks, limits, and
|
|
cancellation. Fixture origins and redistribution terms are recorded separately
|
|
in `tests/fixtures/README.md`.
|