TypeScript issues with `moduleResolution: "nodenext"` and `declaration: true`

[eugene1g]

Guidelines

• Please search other issues to make sure this bug has not already been reported.

Describe the bug

When using TypeScript with "moduleResolution: "nodenext" and "declaration": true", it fails to compile the example from README

Steps to reproduce

main.ts

import ModernError from 'modern-errors'
export const BaseError = ModernError.subclass('BaseError')

tsconfig.json

{
  "compilerOptions": {
    "target": "esnext",
    "module": "esnext",
    "moduleResolution": "nodenext",
    "declaration": true
  }
}

error:

main.ts:3:14 - error TS2742: The inferred type of 'BaseError' cannot be named without a reference to './node_modules/modern-errors/build/src/subclass/create.js'. This is likely not portable. A type annotation is necessary.

3 export const BaseError = ModernError.subclass('BaseError')
               ~~~~~~~~~

main.ts:3:14 - error TS2742: The inferred type of 'BaseError' cannot be named without a reference to './node_modules/modern-errors/build/src/subclass/custom.js'. This is likely not portable. A type annotation is necessary.

3 export const BaseError = ModernError.subclass('BaseError')
               ~~~~~~~~~


Found 2 errors in the same file, starting at: main.ts:3

I can make it work in two ways -

1. Disable declaration. However, this means my library cannot publish types and that's not great.
2. Change to "moduleResolution": "node". However, this means I cannot use the exports settings in my dependencies.

With "moduleResolution":"node" it generates these types for main.d.ts:

export declare const BaseError: import("modern-errors/build/src/subclass/create").ErrorSubclassCore<[], {}, import("modern-errors/build/src/subclass/custom").CustomClass>;

Which hints at the reason for failure: TypeScript has to tap into internal files to reference un-exported types to get ErrorSubclassCore (and, in my real project, CustomClass). With "moduleResolution":"node", this deep linking is not possible, so the TS compiler gives up.

Environment

  System:
    OS: macOS 13.1
    CPU: (8) arm64 Apple M1
    Memory: 64.61 MB / 8.00 GB
    Shell: 5.8.1 - /bin/zsh
  Binaries:
    Node: 18.14.0 - ~/.asdf/installs/nodejs/18.14.0/bin/node
    Yarn: 1.22.19 - ~/.asdf/shims/yarn
    npm: 9.3.1 - ~/.asdf/plugins/nodejs/shims/npm

Pull request (optional)

• I can submit a pull request.

[ehmicky]

Hi @eugene1g,

Thank for reaching out.

I am having issues reproducing this. Which version of TypeScript are you using?

Also, would switching compilerOptions.module from esnext to nodenext fix your problem?

[eugene1g]

Hi @ehmicky

I forgot to say "thank you!" for the awesome library.

Changing module to nodenext still has the same result. I'm trying this with the latest TypeScript 4.9.5 and modern-errors 5.5.1. Here's a test repo https://github.com/eugene1g/modern-terrors

[eugene1g]

The core issue here is when the application uses moduleResolution: nodenext (or node16), TypeScript (and Node) is not allowed to tap into any arbitrary files inside the library packages. Under modeResolution: node, this is allowed because it's just referencing a file on the filesystem. With modeResolution: node16, the boundary of the library is respected and the application can import only what is specifically exported by the library. modern-errors needs to export types of CustomClass and ErrorSubclassCore so they are accessible by TS from the user's application.

This patch will do that - it tweaks modern-errors to export the two missing types, and solves the issue:

diff --git a/src/main.d.ts b/src/main.d.ts
index 2da7b22..1ce8f22 100644
--- a/src/main.d.ts
+++ b/src/main.d.ts
@@ -7,6 +7,8 @@ export type { InstanceOptions } from './options/instance.js'
 export type { MethodOptions } from './options/method.js'
 export type { Info } from './plugins/info/main.js'
 export type { Plugin } from './plugins/shape/main.js'
+export type { CustomClass } from './subclass/custom.js'
+export type { ErrorSubclassCore } from './subclass/create.js'
 export type { ErrorClass }
 
 /**
diff --git a/src/subclass/create.d.ts b/src/subclass/create.d.ts
index 3d6a65e..02712a0 100644
--- a/src/subclass/create.d.ts
+++ b/src/subclass/create.d.ts
@@ -20,7 +20,7 @@ import type { NormalizeError } from './normalize.js'
 /**
  * `ErrorClass.subclass()`
  */
-type CreateSubclass<
+export type CreateSubclass<
   PluginsArg extends Plugins,
   ErrorPropsArg extends ErrorProps,
   CustomClassArg extends CustomClass,

[ehmicky]

Hi @eugene1g,

Sorry for the late reply.
Thank you so much for hinting at the solution, this really helped me out! This should be now fixed in 5.5.2.

@all-contributors Please add @eugene1g for code, bug.

[allcontributors]

@ehmicky

I couldn't determine any contributions to add, did you specify any contributions?
Please make sure to use valid contribution names.

I couldn't determine any contributions to add, did you specify any contributions?
Please make sure to use valid contribution names.

I've put up a pull request to add @eugene1g! 🎉

[eugene1g]

Hi @ehmicky ,
Thank you for fixing this with 5.5.2 - the original thing works well now.

I started using Modern Error plugins, and discovered that we need one more type, CommonInfo. I updated the test repo to show the issue when using Plugins at https://github.com/eugene1g/modern-terrors

The fix would be to export CommonInfo from src/plugins/info/main.d.ts and expose it publically in src/main.d.ts:

// https://github.com/ehmicky/modern-errors/blob/516a73948a8eb31cb21c449d226fbf3baf6f3965/src/main.d.ts#L12
 export type { CommonInfo, Info } from './plugins/info/main.js'

[ehmicky]

Hi again @eugene1g,

Thanks for reporting this too! 👍
This should be fixed in 5.5.4.

[jmchambers]

Hi, it might just be something weird about my setup but I'm getting the same TS2742 error when using the custom option:

export const UserError = BaseError.subclass('UserError', {
  custom: class extends BaseError {
    constructor(message: string, options?: InstanceOptions & UserErrorOptions) {
      // do stuff...
      super(message, options)
    }
  },
})

Exporting a couple more types, CreateSubclass and NormalizeError, fixes the issue. Here's the pnpm patch I'm using:

diff --git a/build/src/main.d.ts b/build/src/main.d.ts
index a17f0e34534a9a5c1a8fe2c55bc2ef964f65ef8b..63413eab64ab41b933a6f39f731b00a12e86efc4 100644
--- a/build/src/main.d.ts
+++ b/build/src/main.d.ts
@@ -2,6 +2,7 @@ import type {
   ErrorClass,
   SpecificErrorClass,
   ErrorSubclassCore,
+  CreateSubclass,
 } from './subclass/create.js'
 import type { CustomClass } from './subclass/custom.js'
 
@@ -22,7 +23,9 @@ export type {
   // https://github.com/ehmicky/modern-errors/issues/18
   CustomClass,
   ErrorSubclassCore,
+  CreateSubclass,
 }
+export type { NormalizeError } from './subclass/normalize.js'
 
 /**
  * Top-level `ErrorClass`.
diff --git a/build/src/subclass/create.d.ts b/build/src/subclass/create.d.ts
index 3d6a65eebd807c761e23bb0e5065b0c6c6063fa6..02712a03c1e41a4aa8aa9d687a8b981cb9b2a92d 100644
--- a/build/src/subclass/create.d.ts
+++ b/build/src/subclass/create.d.ts
@@ -20,7 +20,7 @@ import type { NormalizeError } from './normalize.js'
 /**
  * `ErrorClass.subclass()`
  */
-type CreateSubclass<
+export type CreateSubclass<
   PluginsArg extends Plugins,
   ErrorPropsArg extends ErrorProps,
   CustomClassArg extends CustomClass,

Please let me know if you want me to create a new issue with a reproduction and/or create a pull request. Thanks.

[ehmicky]

Hi @eugene1g,

Thanks for reaching out.
Could you please create a reproduction in the TypeScript playground please?

[jmchambers]

Sure, @ehmicky, here's the repro link. Please note, however, that the link doesn't recreate the error when I first visit it, which is weird, I have to restore the config shown in the pics below, and toggle declarations on and off, then the lint error eventually appears:

---

UPDATE: this stackblitz link shows the problem more reliably:

Seems to be the same issue, whereby declaration: true + modern module resolution, throws TS2742 for any types used in type inference that aren't explicitly exported by modern-errors main.d.ts.

Great library BTW, my errors have never been so nicely organised!