63 lines
3 KiB
Markdown
63 lines
3 KiB
Markdown
|
# Vendored libraries
|
||
|
|
|
||
|
|
Both engines are copied in rather than installed, because Theseus's own
|
||
|
|
`node_modules` is a build-time tree and an add-on has to be a self-contained
|
||
|
|
folder: it is copied to `<userData>/addons/pdf-editor/` on first run and
|
||
|
|
shipped as a tarball over the signed update channel, neither of which runs a
|
||
|
|
package manager.
|
||
|
|
|
||
|
|
| Path | Library | Version | Licence |
|
||
|
|
|---|---|---|---|
|
||
|
|
| `vendor/pdfjs/` | [pdf.js](https://mozilla.github.io/pdf.js/) (`pdfjs-dist`) | 6.3.289 | Apache-2.0 |
|
||
|
|
| `vendor/pdf-lib/` | [pdf-lib](https://pdf-lib.js.org/) | 1.17.1 | MIT |
|
||
|
|
|
||
|
|
Licence texts ship beside the code: `vendor/pdfjs/LICENSE`,
|
||
|
|
`vendor/pdfjs/wasm/LICENSE_*` and `vendor/pdf-lib/LICENSE.md`.
|
||
|
|
|
||
|
|
pdf.js reads; pdf-lib writes. They never look at each other's state — the
|
||
|
|
editor holds the document model in between, in PDF user-space coordinates,
|
||
|
|
which is the only vocabulary both of them speak.
|
||
|
|
|
||
|
|
## What was taken, and what was left behind
|
||
|
|
|
||
|
|
From `pdfjs-dist`:
|
||
|
|
|
||
|
|
- `build/pdf.min.mjs`, `build/pdf.worker.min.mjs` — the API and its worker.
|
||
|
|
- `web/pdf_viewer.mjs` + `web/pdf_viewer.css` + `web/images/` — the viewer
|
||
|
|
*components*, for `PDFPageView`, `PDFLinkService` and `EventBus`. Not the
|
||
|
|
full viewer application. There is no minified build of this file upstream.
|
||
|
|
- `standard_fonts/` — the base-14 metrics. A PDF that names Helvetica without
|
||
|
|
embedding it is extremely common, and without these it renders wrong.
|
||
|
|
- `wasm/*.wasm` — JPEG 2000, JBIG2 and colour management.
|
||
|
|
- `iccs/` — ICC profiles for the colour management above.
|
||
|
|
|
||
|
|
Left out on purpose:
|
||
|
|
|
||
|
|
- `cmaps/` (~1.5 MB) — needed only for CJK documents that use a non-embedded
|
||
|
|
CID font. Dropping it keeps the add-on at about 4 MB. If CJK support is
|
||
|
|
wanted, copy `cmaps/` in and pass `cMapUrl: "vendor/pdfjs/cmaps/"` to
|
||
|
|
`getDocument` in `editor.js`; nothing else changes.
|
||
|
|
- `wasm/*_nowasm_fallback.js` (~580 KB) — pure-JS fallbacks for engines
|
||
|
|
without WebAssembly. Electron always has it.
|
||
|
|
- `wasm/quickjs-eval.*` and `build/pdf.sandbox.*` (~525 KB) — the interpreter
|
||
|
|
for JavaScript embedded in a PDF. The editor loads documents with
|
||
|
|
`enableScripting: false`, so a document's own scripts never run.
|
||
|
|
- Every `.map` file, the TypeScript definitions, the CommonJS and `legacy`
|
||
|
|
builds, and `image_decoders/`.
|
||
|
|
|
||
|
|
From `pdf-lib`, only `dist/pdf-lib.esm.min.js`.
|
||
|
|
|
||
|
|
## Upgrading
|
||
|
|
|
||
|
|
Re-run the extraction against a fresh tarball, keeping the list above, then
|
||
|
|
run the verification suite in `scratchpad/verify-pdf-editor/`. Two things to
|
||
|
|
watch, because both have bitten this add-on already:
|
||
|
|
|
||
|
|
- `web/pdf_viewer.mjs` reads the core API off `globalThis.pdfjsLib` instead of
|
||
|
|
importing it, so `editor.js` must keep assigning that global *before* it
|
||
|
|
imports the components bundle.
|
||
|
|
- pdf.js's `AnnotationStorage` has no stable public shape. `getAll()`, which
|
||
|
|
older releases had, does not exist in 6.x — form values are read through
|
||
|
|
`has(id)` and `getRawValue(id)` against the ids from `getFieldObjects()`.
|
||
|
|
A silent change here looks like a form that saves nothing.
|