[BUG]: Octokit 4 can't be imported or required

[s100]

What happened?

This should work:

a.mjs:

import * as octokit from 'octokit'

However this fails with a module loading error (see later).

Note that octokit@4.0.1 ships with "type": "module" in its package.json, indicating a pure ESM package, but "main" points to dist-node/index.js, which is clearly a CJS module making use of module.exports and require. Something's gone wrong here.

Versions

Octokit 4.0.1, Node.js 18.17.1

Relevant log output

C:\...>node a.mjs
file:///C:/.../node_modules/octokit/dist-node/index.js:29
module.exports = __toCommonJS(dist_src_exports);
^

ReferenceError: module is not defined in ES module scope
    at file:///C:/.../node_modules/octokit/dist-node/index.js:29:1
    at ModuleJob.run (node:internal/modules/esm/module_job:194:25)

Node.js v18.17.1

Code of Conduct

• I agree to follow this project's Code of Conduct

[github-actions]

👋 Hi! Thank you for this contribution! Just to let you know, our GitHub SDK team does a round of issue and PR reviews twice a week, every Monday and Friday! We have a process in place for prioritizing and responding to your input. Because you are a part of this community please feel free to comment, add to, or pick up any issues/PRs that are labled with Status: Up for grabs. You & others like you are the reason all of this works! So thank you & happy coding! 🚀

[s100]

I'm finding that CJS can't use Octokit 4 either:

a.js:

require('octokit')

C:\...>node a.js
C:\...\a.js:1
require('octokit')
^

Error [ERR_REQUIRE_ESM]: require() of ES Module C:\...\node_modules\octokit\dist-node\index.js from C:\...\a.js not supported.
index.js is treated as an ES module file as it is a .js file whose nearest parent package.json contains "type": "module" which declares all .js files in that package scope as ES modules.
Instead rename index.js to end in .cjs, change the requiring code to use dynamic import() which is available in all CommonJS modules, or change "type": "module" to "type": "commonjs" in C:\...\node_modules\octokit\package.json to treat all .js files as CommonJS (using .mjs for all ES modules instead).

    at Object.<anonymous> (C:\...\a.js:1:1) {
  code: 'ERR_REQUIRE_ESM'
}

Node.js v18.17.1

[wolfy1339]

Sorry that is my fault.

I forgot to change the build script

[github-actions]

🎉 This issue has been resolved in version 4.0.2 🎉

The release is available on:

• GitHub release
• npm package (@latest dist-tag)

Your semantic-release bot 📦🚀

[gr2m]

I confirmed that this works now:

// test.mjs
import { Octokit } from "octokit";
console.log(Octokit.VERSION);
// 6.1.2

[rolwin100]

I'm still facing the issue with nestjs. I solved it by downgrading it to version 3. This solved my issue

[wolfy1339]

NestJS can't do ESM only packages.

There is a new NodeJS feature that can allow you to use require() in order to import ESM packages.
However support is limited to 23 currently, and is going to be backported to 22 soon.

You can also use await import().

If you are stuck on a version of Node that is older, and require CJS stick to v3 of Octokit.
We will support bug fixes for it for the time being

Please open a new issue with proper information if ever you encounter an issue like this again