pdfEmbeddedFile

Embedded file stream — ISO 32000-2 §7.11.4.

Module pdfEmbeddedFile | Source packages/front/office/pdf/src/embedded/embeddedFile.js | Deps pdfErrors, pdfParser | Worker-safe yes

Types the stream pointed at by a file spec's /EF entry. The stream dict carries /Type /EmbeddedFile, an optional /Subtype (MIME type as a name), and an optional /Params sub-dictionary (/Size, /CreationDate, /ModDate, /CheckSum). The binary content is the stream's raw (pre-filter) bytes.

Resolve

const ef = runtime.resolve('pdfEmbeddedFile');
// Returns: { typeEmbeddedFile }

API

Shape EmbeddedFile

{
    subtype: string | undefined,     // MIME, e.g. 'application/pdf'
    params: Params | undefined,
    bytes: Uint8Array,                // raw stream (pre-filter)
    raw: PdfStream,
    _extras
}

Params (the decoded /Params sub-dict):

{
    size: number | undefined,
    creationDate: string | undefined,  // raw PDF date string, not parsed
    modDate: string | undefined,       // raw PDF date string, not parsed
    checkSum: string | undefined,      // 16-byte MD5, as the string bytes
    raw, _extras
}

Examples

Extraction

const ef = runtime.resolve('pdfEmbeddedFile').typeEmbeddedFile(stream);
const dispatch = runtime.resolve('pdfFilterDispatch');
const plain = dispatch.decode(ef.raw);

Metadata

ef.subtype;                // 'application/json'
ef.params?.size;           // original byte size
ef.params?.checkSum;       // MD5, as raw string bytes

Errors

See also

• pdfFileSpec · pdfCollection
• pdfFilterDispatch