Bump typedoc to v0.23.x

[trivikr]

Describe the feature

Bump typedoc to v0.23.x or latest

Use Case

There are bunch of dependabot alerts due to transitive dependencies of typedoc@0.19.x:

• Inefficient Regular Expression Complexity in marked GHSA-5v2h-r2cx-5xgj
• Regular Expression Denial of Service (REDoS) in Marked GHSA-4r62-v4vq-hr96

We use typedoc for generating our docs, and it's not shipped in SDK artifacts. These issues won't impact our customers directly, and won't slow down our documents generation as we own the generation as well as source code. However, they appear in our security tickets and reviews.

The typedoc@0.19.2 is also officially compatible only with typescript "3.9.x || 4.0.x", while our source code is on typescript 4.6.3. This can create issues with generation of docs.

Proposed Solution

Bump typedoc to v0.23.x or latest

Other Information

Prior internal discussions in JS-3393

Acknowledgements

• I may be able to implement this feature request
• This feature might incur a breaking change

SDK version used

main

Environment details (OS name and version, etc.)

N/A

[trivikr]

cc @eduardomourar who offered help with bumping typedoc in smithy-lang/smithy-typescript#563 (comment)

[trivikr]

Previous attempt: #3712

The build had failed as PluginHost export was removed in TypeStrong/typedoc@22df574 which was released with v0.21.0. The plugins are now passed automatically.

[trivikr]

The plugin we use for lerna typedoc-plugin-lerna-packages itself doesn't support typedoc@0.20.0
Issue being discussed in marcj/typedoc-plugin-lerna-packages#34

Typedoc added preliminary support for monorepos though in v0.21.x which we may have to evaluate https://github.com/TypeStrong/typedoc#monorepos--workspaces

[eduardomourar]

Created #4139 to help drive the discussion and the implementation itself.

[eduardomourar]

We are leveraging the monorepo feature from typedoc as you mentioned. Find below the screenshots of the results:

• Root project

• Sample client

[eduardomourar]

Keep in mind that I have been unable to run typedoc into the whole project due to this out of memory issue: TypeStrong/typedoc#1606

[eduardomourar]

I believe the @aws-sdk/service-client-documentation-generator plugin (and possibly @aws-sdk/core-theme-documentation-generator) could be later removed by modifying the typescript codegen to include the categories tags.

[github-actions]

Greetings! We’re closing this issue because it has been open a long time and hasn’t been updated in a while and may not be getting the attention it deserves. We encourage you to check if this is still an issue in the latest release and if you find that this is still a problem, please feel free to comment or open a new issue.

[github-actions]

This thread has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs and link to relevant comments in this thread.