How to migrate from pdfjs-dist 3.11.174 to version 4 on a node.js project

[inventivejon]

I hope someone can help me with this issue.

I am using pdfjs-dist version 3.11.174 without any problems in my node.js 20.11.0 typescript project ("target": "esnext", "module": "commonjs", "moduleResolution": "node",)

Now I wanted to upgrade to version 4. But there are only mjs file now.
The problem is that even the documentation for node.js uses

import { getDocument } from 'pdfjs-dist/legacy/build/pdf.mjs';

But when I try to do it this way I get an error from typescript:
Error [ERR_REQUIRE_ESM]: require() of ES Module .../node_modules/pdfjs-dist/build/pdf.mjs not supported.
Instead change the require of .../node_modules/pdfjs-dist/build/pdf.mjs to a dynamic import() which is available in all CommonJS modules.

So then I tried that:
import('pdfjs-dist/legacy/build/pdf.mjs').then(pdfjsLib => {
const { getDocument } = pdfjsLib;
// use getDocument here
}).catch(error => {
console.error('Error loading the module', error);
});

But even then I get nearly the same error message. What do I need to change? Is there somewhere a migration document that explains how to migrate from 3 to 4 for a node.js project?

Thanks in advance.

[inventivejon]

Thanks for moving to correct position

[inventivejon]

Can nobody help?

[nicolo-ribaudo]

You need to set "module": "preserve" in your TS config, so that it doesn't transform your ESM imports to require() calls. You probably then also need to add "type": "module" to your package.json.

[djwlx]

I also want to ask, do I have to use the old version if I want to use it in CommonJs

[djwlx]

If not possible, I would like to know the latest version that supports commonjs

[SebTVisage]

I have the same error when trying to upgrade pdfjs. But my porject is a bit different.

I'm using "module": "commonjs" in my TS config, with node 20. I cannot change module resolution or use type: "module" in my package.json because the migration cost is huge, I get a lot of issues when trying.

So I tried to use a dynamic async import function call, like the error suggests. it compiles and works well locally with ts-node. But when the code is built by TS and runs, I get an error at runtime: "Promise.withResolvers is not a function"

And that is not surprising since this Promise.withResolvers is only available from node 22. And since this is a dynamic import, TS cannot transpile / polyfill it

I think pdfjs is the only package we use that does not export a commonjs build, and I can't find a way to make it work properly.

Any idea?

[nicolo-ribaudo]

For the Promise.withResolvers problem, you should use the legacy build as documented at https://github.com/mozilla/pdf.js/wiki/Frequently-Asked-Questions#which-browsersenvironments-are-supported

[SebTVisage]

Ah yes, I had missed this. Thank you!

[lfoppiano]

Thanks to a friend with knowledge in javascript jungle, I have finally a working version. My project is a streamlit application but you can find the useful information in the repository, https://github.com/lfoppiano/streamlit-pdf-viewer/tree/enable-text-content-2 in particular the important changes: lfoppiano/streamlit-pdf-viewer@5f09846