ooxml.js 4.0.9 → 4.0.11

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.
Files changed (2) hide show
  1. package/README.md +13 -15
  2. package/package.json +4 -4
package/README.md CHANGED
@@ -1,6 +1,6 @@
1
1
  # ooxml.js
2
2
 
3
- [![GitHub](https://img.shields.io/badge/GitHub-181717?logo=github&logoColor=white)](https://github.com/ExaDev/ooxml.js) [![npm](https://img.shields.io/badge/npm-CB3837?logo=npm&logoColor=white)](https://www.npmjs.com/package/ooxml.js) [![Release](https://img.shields.io/github/v/release/ExaDev/ooxml.js)](https://github.com/ExaDev/ooxml.js/releases/latest) [![CI](https://img.shields.io/github/actions/workflow/status/ExaDev/ooxml.js/ci.yml?branch=main)](https://github.com/ExaDev/ooxml.js/actions)
3
+ [![GitHub](https://img.shields.io/badge/GitHub-181717?logo=github&logoColor=white)](https://github.com/ExaDev/documents.js/tree/main/packages/ooxml.js) [![npm](https://img.shields.io/badge/npm-CB3837?logo=npm&logoColor=white)](https://www.npmjs.com/package/ooxml.js) [![npm version](https://img.shields.io/npm/v/ooxml.js)](https://www.npmjs.com/package/ooxml.js) [![CI](https://img.shields.io/github/actions/workflow/status/ExaDev/documents.js/ci.yml?branch=main)](https://github.com/ExaDev/documents.js/actions)
4
4
 
5
5
  > Type-safe, lossless round-trip conversion between OOXML packages (`.docx`, `.pptx`, `.xlsx`) and a faithful JSON model, built on [Zod 4](https://zod.dev) codecs.
6
6
 
@@ -35,15 +35,15 @@ graph TD
35
35
  odf --> cli
36
36
  pdfcodec --> cli
37
37
 
38
- click schema "https://github.com/ExaDev/document-schema.js" "document-schema.js"
39
- click ooxml "https://github.com/ExaDev/ooxml.js" "ooxml.js"
40
- click odf "https://github.com/ExaDev/odf.js" "odf.js"
41
- click pdfcodec "https://github.com/ExaDev/pdf-codec" "pdf-codec"
42
- click mdcodec "https://github.com/ExaDev/markdown-codec" "markdown-codec"
43
- click bytecodec "https://github.com/ExaDev/byte-codec" "byte-codec"
38
+ click schema "https://github.com/ExaDev/documents.js/tree/main/packages/document-schema.js" "document-schema.js"
39
+ click ooxml "https://github.com/ExaDev/documents.js/tree/main/packages/ooxml.js" "ooxml.js"
40
+ click odf "https://github.com/ExaDev/documents.js/tree/main/packages/odf.js" "odf.js"
41
+ click pdfcodec "https://github.com/ExaDev/documents.js/tree/main/packages/pdf-codec" "pdf-codec"
42
+ click mdcodec "https://github.com/ExaDev/documents.js/tree/main/packages/markdown-codec" "markdown-codec"
43
+ click bytecodec "https://github.com/ExaDev/documents.js/tree/main/packages/byte-codec" "byte-codec"
44
44
  click documents "https://github.com/ExaDev/documents.js" "documents.js"
45
- click mcp "https://github.com/ExaDev/document-mcp" "document-mcp"
46
- click cli "https://github.com/ExaDev/document-cli" "document-cli"
45
+ click mcp "https://github.com/ExaDev/documents.js/tree/main/packages/document-mcp" "document-mcp"
46
+ click cli "https://github.com/ExaDev/documents.js/tree/main/packages/document-cli" "document-cli"
47
47
 
48
48
  style ooxml fill:#f9a825,stroke:#333,stroke-width:3px
49
49
  ```
@@ -310,18 +310,16 @@ Conversion is **part-content-faithful**: every XML part re-serialises to equival
310
310
 
311
311
  ## Release and publishing
312
312
 
313
- `.github/workflows/ci.yml` runs commitlint, lint, typecheck, unit, and smoke on every push/PR. On push to `main`, `release.config.ts` drives [semantic-release](https://semantic-release.gitbook.io/semantic-release): commit history decides the bump, `CHANGELOG.md`/`package.json` commit back to `main`, a GitHub Release is cut, and the package publishes to [npmjs.org](https://www.npmjs.com/package/ooxml.js) via OIDC trusted publishing (no `NPM_TOKEN`).
314
-
315
- Release success is detected by diffing `package.json`'s version before/after. Two further jobs gate on that: one republishes under `@exadev/ooxml.js` to GitHub Packages (via `GITHUB_TOKEN`), and one packs the release, generates an SPDX SBOM (`pnpm sbom`), and signs an SBOM and a build-provenance attestation — verifiable independently of the registry, and present even if the package is later unpublished.
313
+ 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.
316
314
 
317
315
  ## Contributing
318
316
 
319
- Commits follow Conventional Commits (`feat:`, `fix:`, `test:`, `chore:`, …), enforced by commitlint (`commitlint.config.ts`) via a husky `commit-msg` hook and a CI job — semantic-release's version bump depends on these being well-formed. A husky `pre-commit` runs `lint-staged` (`eslint --fix` on staged `*.ts`); `pre-push` runs the test suite. Single `main` branch; no open PR workflow established.
317
+ Conventional Commits, enforced workspace-wide by commitlint through a root `commit-msg` hook. Work inside `packages/ooxml.js/`; see the [root README](../../README.md#contributing) for the shared git hooks and history conventions.
320
318
 
321
319
  ## References
322
320
 
323
- - [document-schema.js](https://github.com/ExaDev/document-schema.js) — canonical `ContentBlock`/`ContentSection`/geometry/colour schemas and `ContentDocument`/`LayoutMetadata` types shared with `odf.js` and `documents.js`, plus the `DocumentPackage` tree and the `decompose`/`flattenPackage`/`assemblePackage`/`factorStyles` transform this package's primary readers and writers are built on.
324
- - [odf.js](https://github.com/ExaDev/odf.js) — sibling OpenDocument Format package, also on `document-schema.js`.
321
+ - [document-schema.js](../document-schema.js/README.md) — canonical `ContentBlock`/`ContentSection`/geometry/colour schemas and `ContentDocument`/`LayoutMetadata` types shared with `odf.js` and `documents.js`, plus the `DocumentPackage` tree and the `decompose`/`flattenPackage`/`assemblePackage`/`factorStyles` transform this package's primary readers and writers are built on.
322
+ - [odf.js](../odf.js/README.md) — sibling OpenDocument Format package, also on `document-schema.js`.
325
323
  - [documents.js](https://github.com/ExaDev/documents.js) — adds PDF conversion and a read-and-write docx/pptx editor on top of this package.
326
324
 
327
325
  ## License
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "ooxml.js",
3
- "version": "4.0.9",
3
+ "version": "4.0.11",
4
4
  "description": "Type-safe, lossless round-trip conversion between OOXML packages (docx, pptx, xlsx) and JSON, 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/ooxml.js"
10
10
  },
11
- "homepage": "https://github.com/ExaDev/ooxml.js#readme",
11
+ "homepage": "https://github.com/ExaDev/documents.js/tree/main/packages/ooxml.js",
12
12
  "bugs": {
13
- "url": "https://github.com/ExaDev/ooxml.js/issues"
13
+ "url": "https://github.com/ExaDev/documents.js/issues"
14
14
  },
15
15
  "exports": {
16
16
  ".": {
@@ -79,7 +79,7 @@
79
79
  "license": "MIT",
80
80
  "packageManager": "pnpm@11.6.0",
81
81
  "dependencies": {
82
- "document-schema.js": "^4.3.4",
82
+ "document-schema.js": "^4.3.6",
83
83
  "fast-xml-parser": "^5.10.1",
84
84
  "fflate": "^0.8.3",
85
85
  "zod": "^4.4.3"