odf.js 5.0.4 → 5.0.6
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +16 -16
- package/package.json +4 -4
package/README.md
CHANGED
|
@@ -1,12 +1,12 @@
|
|
|
1
1
|
# odf.js
|
|
2
2
|
|
|
3
|
-
[](https://github.com/ExaDev/odf.js) [](https://www.npmjs.com/package/odf.js) [](https://github.com/ExaDev/documents.js/tree/main/packages/odf.js) [](https://www.npmjs.com/package/odf.js) [](https://www.npmjs.com/package/odf.js) [](https://github.com/ExaDev/documents.js/actions)
|
|
4
4
|
|
|
5
5
|
> A hand-written, dependency-minimal codec for the OpenDocument Format (ODF — OASIS/ISO 26300): `.odt`/`.ods`/`.odp`/`.odg`/`.odf`/`.odb`/`.odm` and their template variants, built on [Zod 4](https://zod.dev) codecs.
|
|
6
6
|
|
|
7
|
-
`odf.js` is the ODF sibling of [`ooxml.js`](
|
|
7
|
+
`odf.js` is the ODF sibling of [`ooxml.js`](../ooxml.js/README.md), mirroring its architecture: a lossless ZIP-of-XML core that round-trips any package byte-for-content-faithful, with typed readers layered on top. Two ODF-specific differences shape the design: ODF has no relationship mechanism (inter-part references are direct paths, with an exhaustive `META-INF/manifest.xml`), and ODF has no inline/direct formatting — every formatting difference must be a named "automatic style," so `odf.js` owns a style-interning subsystem (`src/styles/`) with no OOXML equivalent.
|
|
8
8
|
|
|
9
|
-
**This package does not depend on `ooxml.js`.** `ooxml.js`'s branding and SBOM are scoped to ECMA-376/OOXML; depending on it would be the wrong signal for an OASIS-standard codec and would force a breaking `ooxml.js` release for every ODF-only fix. The small generic ZIP/XML/`Package` layer is duplicated, kept structurally identical so TypeScript's structural typing makes both packages' values interchangeable for a shared consumer like `documents.js`. Both depend on [`document-schema.js`](
|
|
9
|
+
**This package does not depend on `ooxml.js`.** `ooxml.js`'s branding and SBOM are scoped to ECMA-376/OOXML; depending on it would be the wrong signal for an OASIS-standard codec and would force a breaking `ooxml.js` release for every ODF-only fix. The small generic ZIP/XML/`Package` layer is duplicated, kept structurally identical so TypeScript's structural typing makes both packages' values interchangeable for a shared consumer like `documents.js`. Both depend on [`document-schema.js`](../document-schema.js/README.md) for the genuinely identical `ContentDocument`/`DocumentPackage` content model.
|
|
10
10
|
|
|
11
11
|
```mermaid
|
|
12
12
|
graph TD
|
|
@@ -37,15 +37,15 @@ graph TD
|
|
|
37
37
|
odf --> cli
|
|
38
38
|
pdfcodec --> cli
|
|
39
39
|
|
|
40
|
-
click schema "https://github.com/ExaDev/document-schema.js" "document-schema.js"
|
|
41
|
-
click ooxml "https://github.com/ExaDev/ooxml.js" "ooxml.js"
|
|
42
|
-
click odf "https://github.com/ExaDev/odf.js" "odf.js"
|
|
43
|
-
click pdfcodec "https://github.com/ExaDev/pdf-codec" "pdf-codec"
|
|
44
|
-
click mdcodec "https://github.com/ExaDev/markdown-codec" "markdown-codec"
|
|
45
|
-
click bytecodec "https://github.com/ExaDev/byte-codec" "byte-codec"
|
|
40
|
+
click schema "https://github.com/ExaDev/documents.js/tree/main/packages/document-schema.js" "document-schema.js"
|
|
41
|
+
click ooxml "https://github.com/ExaDev/documents.js/tree/main/packages/ooxml.js" "ooxml.js"
|
|
42
|
+
click odf "https://github.com/ExaDev/documents.js/tree/main/packages/odf.js" "odf.js"
|
|
43
|
+
click pdfcodec "https://github.com/ExaDev/documents.js/tree/main/packages/pdf-codec" "pdf-codec"
|
|
44
|
+
click mdcodec "https://github.com/ExaDev/documents.js/tree/main/packages/markdown-codec" "markdown-codec"
|
|
45
|
+
click bytecodec "https://github.com/ExaDev/documents.js/tree/main/packages/byte-codec" "byte-codec"
|
|
46
46
|
click documents "https://github.com/ExaDev/documents.js" "documents.js"
|
|
47
|
-
click mcp "https://github.com/ExaDev/document-mcp" "document-mcp"
|
|
48
|
-
click cli "https://github.com/ExaDev/document-cli" "document-cli"
|
|
47
|
+
click mcp "https://github.com/ExaDev/documents.js/tree/main/packages/document-mcp" "document-mcp"
|
|
48
|
+
click cli "https://github.com/ExaDev/documents.js/tree/main/packages/document-cli" "document-cli"
|
|
49
49
|
|
|
50
50
|
style odf fill:#f9a825,stroke:#333,stroke-width:3px
|
|
51
51
|
```
|
|
@@ -99,7 +99,7 @@ To run a single test file: `pnpm vitest run src/path/to/file.test.ts`.
|
|
|
99
99
|
|
|
100
100
|
### Reading a document
|
|
101
101
|
|
|
102
|
-
A typed reader takes a `Package` (bytes go through `decodePackage`/`parsePackage` first) and returns a [`DocumentPackage`](
|
|
102
|
+
A typed reader takes a `Package` (bytes go through `decodePackage`/`parsePackage` first) and returns a [`DocumentPackage`](../document-schema.js/README.md#the-package-tree) — `document-schema.js`'s single hierarchical artefact, where structure, layout, and content are fused in one tree and a `styles` table has already been minted over it:
|
|
103
103
|
|
|
104
104
|
```ts
|
|
105
105
|
import { decodePackage, readOdt } from 'odf.js';
|
|
@@ -241,16 +241,16 @@ Layered from a lossless core outward, mirroring `ooxml.js`:
|
|
|
241
241
|
|
|
242
242
|
## Release and publishing
|
|
243
243
|
|
|
244
|
-
|
|
244
|
+
Release, CI, and commit-message conventions are all workspace-wide, not package-local — see the [monorepo root README](../../README.md#releases) for the mechanism (topological per-package `semantic-release` via `@exadev/semantic-release-workspace`, OIDC trusted npm publishing, automatic sibling dependency-range rewriting) and its [known gap](../../README.md#releases) note on GitHub Packages republishing and SBOM/provenance signing, both dropped in the migration to this monorepo and not yet restored.
|
|
245
245
|
|
|
246
246
|
## Contributing
|
|
247
247
|
|
|
248
|
-
Conventional Commits
|
|
248
|
+
Conventional Commits, enforced workspace-wide by commitlint through a root `commit-msg` hook. Work inside `packages/odf.js/`; see the [root README](../../README.md#contributing) for the shared git hooks and history conventions.
|
|
249
249
|
|
|
250
250
|
## References
|
|
251
251
|
|
|
252
|
-
- [ooxml.js](
|
|
253
|
-
- [document-schema.js](
|
|
252
|
+
- [ooxml.js](../ooxml.js/README.md) — the OOXML sibling; architecturally mirrored, deliberately not depended on.
|
|
253
|
+
- [document-schema.js](../document-schema.js/README.md) — the canonical `ContentDocument`/`DocumentPackage` schema both packages depend on, and the home of the `assemblePackage`/`flattenPackage`/`decompose`/`factorStyles` transform between the two encodings.
|
|
254
254
|
- [documents.js](https://github.com/ExaDev/documents.js) — the downstream consumer; its own `readOdtContent`/`readOdpContent`/`readOdsContent`/`readOdgContent` adapters wrap this package's flat `*Content` readers into `ContentDocument`s, adding the odt/odp formula, image, and vector detection passes those readers deliberately leave out.
|
|
255
255
|
|
|
256
256
|
## License
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "odf.js",
|
|
3
|
-
"version": "5.0.
|
|
3
|
+
"version": "5.0.6",
|
|
4
4
|
"description": "Type-safe, lossless round-trip conversion between OpenDocument Format packages (odt, ods, odp) and JSON, hand-written and dependency-minimal, built on Zod 4 codecs.",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"repository": {
|
|
@@ -8,9 +8,9 @@
|
|
|
8
8
|
"url": "git+https://github.com/ExaDev/documents.js.git",
|
|
9
9
|
"directory": "packages/odf.js"
|
|
10
10
|
},
|
|
11
|
-
"homepage": "https://github.com/ExaDev/odf.js
|
|
11
|
+
"homepage": "https://github.com/ExaDev/documents.js/tree/main/packages/odf.js",
|
|
12
12
|
"bugs": {
|
|
13
|
-
"url": "https://github.com/ExaDev/
|
|
13
|
+
"url": "https://github.com/ExaDev/documents.js/issues"
|
|
14
14
|
},
|
|
15
15
|
"exports": {
|
|
16
16
|
".": {
|
|
@@ -78,7 +78,7 @@
|
|
|
78
78
|
"license": "MIT",
|
|
79
79
|
"packageManager": "pnpm@11.6.0",
|
|
80
80
|
"dependencies": {
|
|
81
|
-
"document-schema.js": "^4.3.
|
|
81
|
+
"document-schema.js": "^4.3.6",
|
|
82
82
|
"fast-xml-parser": "^5.10.1",
|
|
83
83
|
"fflate": "^0.8.3",
|
|
84
84
|
"zod": "^4.4.3"
|