fix(pkg): add a default fallback export (#733)

* fix(pkg): add a `default` fallback export

See octokit/core.js#665 octokit/core.js#667

* docs: add note on needed config changes for TypeScript

Author: wolfy1339

README.md

@@ -50,6 +50,12 @@ There is one method for each REST API endpoint documented at [https://developer.
 
 ## TypeScript
 
+> [!IMPORTANT]
+> As we use [conditional exports](https://nodejs.org/api/packages.html#conditional-exports), you will need to adapt your `tsconfig.json` by setting `"moduleResolution": "node16", "module": "node16"`.
+>
+> See the TypeScript docs on [package.json "exports"](https://www.typescriptlang.org/docs/handbook/modules/reference.html#packagejson-exports).<br>
+> See this [helpful guide on transitioning to ESM](https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c) from [@sindresorhus](https://github.com/sindresorhus)
+
 Parameter and response types for all endpoint methods exported as `{ RestEndpointMethodTypes }`.
 
 Example

scripts/build.mjs

@@ -53,12 +53,13 @@ async function main() {
       {
         ...pkg,
         files: ["dist-*/**"],
-        main: "./dist-src/index.js",
         types: "./dist-types/index.d.ts",
         exports: {
           ".": {
             import: "./dist-src/index.js",
             types: "./dist-types/index.d.ts",
+            // Tooling currently are having issues with the "exports" field when there is no "default", ex: TypeScript, eslint
+            default: "./dist-types/index.js",
           },
         },
         sideEffects: false,