Strange type issue

[johnf]

Describe the bug

When type checking with tsc I get an error in this module

Expected behavior

No type issues

Current behavior

I see the following type error

node_modules/docusaurus-plugin-openapi-docs/src/types.ts:8:32 - error TS2307: Cannot find module '@docusaurus/plugin-content-docs/src/sidebars/types' or its corresponding type declarations.

8 import { SidebarItemDoc } from "@docusaurus/plugin-content-docs/src/sidebars/types";
                                 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

node_modules/docusaurus-plugin-openapi-docs/src/types.ts:24:8 - error TS2307: Cannot find module '@docusaurus/plugin-content-docs-types' or its corresponding type declarations.

24 } from "@docusaurus/plugin-content-docs-types";
          ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~


Found 2 errors in the same file, starting at: node_modules/docusaurus-plugin-openapi-docs/src/types.ts:8

Possible solution

Steps to reproduce

1. Check out this repository
2. cd demo
3. yarn
4. yarn run tsc

You will see other errors but also the ones above.

Context

I like clean types :)

Your Environment

• Version used: 4.2.0
• Environment name and version (e.g. Chrome 59, node.js 5.4, python 3.7.3): node 22
• Operating System and version (desktop or mobile): Ubuntu
• Link to your project: https://github.com/johnf/ro-crate-api/

[paulohenriqgoes]

I have the same issue using npm

[joelsrubin]

same here

[sserrata]

Hi @johnf, can you provide more context around why you believe this should work?

For this project, we perform typescript compilation for docusaurus-plugin-openapi-docs and docusaurus-theme-openapi-docs. The demo is a standalone example that is used to build our documentation site, i.e. it is not a package.

[johnf]

@sserrata I'm getting this error in my own project. I only pointed at the demo directory as a way to easily reproduce the issue I'm facing.

In the projects that use this library, the type issues exist.

I tried adding exclude: "node_modules" to the tsconfig.json but it still seems to pick up these files..

[Eandalf-Bigstack]

It turned out that we need to add the following to tsconfig.json of our own project, to pull the type infos from the declared module "@docusaurus/plugin-content-docs-types" in ./src/plugin-content-docs-types.d.ts.

{
  "include": [
    "./node_modules/docusaurus-plugin-openapi-docs/src/plugin-content-docs-types.d.ts"
  ]
}

Maybe we need to add this part to the documentation for projects using TypeScript?

[zendamacf]

I'm also having the same issue with 4.3.4. @Eandalf-Bigstack's suggestion has solved the issue for now.

[emertechie]

Unfortunately the solution from @Eandalf-Bigstack means only that type file is included, so when I run tsc it doesn't pick up any type errors in my files anymore.

According to TS docs, the default value is **/* so I tried adding that back:

  "include": [
    "**/*",
    "./node_modules/docusaurus-plugin-openapi-docs/src/plugin-content-docs-types.d.ts",
  ]

But then I still get the error below, and haven't been able to figure out a fix. I tried installing the @docusaurus/plugin-content-docs package (even though it shouldn't be needed) but that didn't help.

Cannot find module '@docusaurus/plugin-content-docs/src/sidebars/types' or its corresponding type declarations.

[ChrisSargent]

FYI, for us this problem got worse as we switched to ESM. It happens when you have an import of

import type { Options } from 'docusaurus-plugin-openapi-docs';

Which in turn does:

export type Options = Partial<import("./types").APIOptions>;

Which imports the problem file doing

import { SidebarItemDoc } from "@docusaurus/plugin-content-docs/src/sidebars/types";

However, src/sidebars/types is not defined as an export so node fails to see it.

See: https://github.com/facebook/docusaurus/blob/main/packages/docusaurus-plugin-content-docs/package.json

In our case, we simply stopped using the import (it was doing satisfies Options) and all was good.

[omonk]

Just revisited type checking a docusaurus project and came across this error again, I suspect it might be to do with this?

#974

[tawago]

I've just created #1216.
Would love to hear any feedbacks.