pdfLegacyBundle

pdfFullBundle + the PDF 1.7 legacy readers.

Module pdfLegacyBundle | Source packages/front/office/pdf/src/bundles/pdf-legacy.js | Deps pdf + the 31 extras enumerated under Extras wired (32 names total, listed literally in the frontmatter dependencies; the @awacloud/fw lzw binding is a further transitive requirement of pdfLegacyDeprecatedFilters, not a direct entry) | Worker-safe yes

A module descriptor that adds the legacy-* extras on top of pdfFullBundle:

• legacy-xfa-read — accepts /XFA on read, surfaces it as opaque XML.
• legacy-rc4-read — RC4 v2/v3 password validation + stream decrypt.
• legacy-deprecated-filters — LZWDecode (via the @awacloud/fw lzw factory), CCITTFaxDecode (a full ITU-T T.4 / T.6 decoder, through pdfCcittFaxDecoder), DCT/JPX passthrough. These decoders are called through the extra's own API; they are not registered into pdfFilterDispatch, so read does not apply them to streams by itself.
• legacy-deprecated-annots — Sound/Movie/Screen typing (read-only; no conversion to RichMedia).

pdfInfoDictDeprecated (Info dict lint) is already wired by pdf-full; pdf-legacy re-lists it idempotently.

Writing PDF 1.7 is never supported — write always emits a %PDF-2.0 header. It does not convert legacy content: it re-emits the objects of the model it is given, so an /XFA entry, an RC4 /Encrypt dictionary, an LZW-filtered stream or a Sound/Movie annotation read from a 1.7 file is written back as it was. Converting it is the caller's work.

Resolve

import { ModuleRuntime } from '@awacloud/fw/core/runtime.js';
import { fw_require, pkg_require, modules, extras, bundle } from '@awacloud/pdf';

const rt = new ModuleRuntime();
for (const m of fw_require)  rt.register(m);   // provides the real `lzw` fw binding
for (const m of pkg_require) rt.register(m);
for (const m of modules)     rt.register(m);
for (const m of extras)      rt.register(m);
for (const m of bundle)      rt.register(m);

const api = rt.resolve('pdfLegacyBundle');
const doc = api.read(oldPdfBytes);   // PDF 1.7 OK
const out = api.write(doc);          // always PDF 2.0

The extras and bundle descriptors are not re-exported from the package root by binding name — import { pdfLegacyBundle } from '@awacloud/pdf' is undefined. Register the arrays as above, or import the single descriptor from its own subpath export (import { pdfLegacyBundle } from '@awacloud/pdf/pdf-legacy';). Unlike pdf-large and pdf-full, pdf-legacy cannot be resolved without fw_require registered: omitting it throws Module not found: lzw.

pdfLegacyDeprecatedFilters validates its lzw dependency eagerly at construction time — if a stub/invalid binding is registered under the name lzw instead of the real @awacloud/fw/io/compress/lzw.js export, resolving the bundle throws pdf/filters/missing-lzw immediately (not lazily on first decode).

API

The resolved instance is the core pdf object (src/pdf.js) with the extras merged in — it carries pdf's own 5 members plus one property per wired extra name:

Extras wired

Items 1-27 are pdf-full's extras, re-listed here so every member of the resolved instance is documented on this page; items 28-31 are pdf-legacy's own additions.

pdfCcittFaxDecoder (the CCITT Fax decode helper legacy-deprecated-filters depends on) is a separate, 32nd module in the package's overall extras manifest array, but it is a private sub-dependency here — it is resolved transitively, not wired onto the bundle's own namespace via a .use() call, so there is no api.pdfCcittFaxDecoder.

When to choose

• pdf-large — strict PDF 2.0 production minimal.
• pdf-full — strict PDF 2.0 complete.
• pdf-legacy — mixed legacy corpus (1.7 + 2.0). Choose it when ingesting older PDFs (XFA, RC4, LZW, Sound/Movie); conversion to PDF 2.0 equivalents is left to the caller.

Examples

Reading an RC4-encrypted PDF 1.7 file

read refuses an encrypted file (pdf/document/encrypted); opt in to the raw container, then decrypt with the extra's helpers (see pdfLegacyRc4Read for the params shape):

const api = rt.resolve('pdfLegacyBundle');
const doc = api.read(pdf17Bytes, { allowEncrypted: true });   // strings and streams still ciphertext
const r = api.pdfLegacyRc4Read.validateUserPassword('', params);
if (r.ok) {
    const plain = api.pdfLegacyRc4Read.decryptStream(r.fileKey, objNum, gen, streamBytes);
}

Reading an XFA form

const api = rt.resolve('pdfLegacyBundle');
const doc = api.read(xfaFormBytes);
const xfa = api.pdfLegacyXfaRead.readXfa(acroFormDict.entries.XFA);
// xfa._legacy.xfa: the XDP payload, opaque; api.write(doc) keeps /XFA as it was

Legacy filter

const plain = api.pdfLegacyDeprecatedFilters.lzwDecode(streamBytes, { EarlyChange: 1 });

Header only

api.header(pdf17Bytes);   // { version: '1.7', end: <offset> } — no xref/catalog walk

Checking a wired extra

api.usedExtension('pdfLegacyRc4Read');  // true — wired by the bundle factory
api.usedExtension('not-a-real-extra');  // false

Errors

See also

• pdf-large
• pdf-full
• Bundles index
• Extras index