Maintenance: fix `typedoc-plugin-zod` usage

[dreamorosi]

Summary

Currently we are using a Typedoc plugin called typedoc-plugin-zod which is expected to prettify the Zod schemas in our TypeDoc API docs.

This is working well enough, however when building the docs the plugin is causing thousands of warnings:

I was able to confirm that the plugin is the source of the warnings because commenting it out in the main typedoc.json config makes all the warnings immediately disappear.

We should investigate if this is: 1/ a bug with the plugin, 2/ a misconfiguration on our part, or 3/ a misuse of our typedoc annotations that causes the warnings.

Why is this needed?

So that we don't have thousands of warnings when generating the API docs.

Which area does this relate to?

Parser

Solution

In case of 2/ or 3/, we should fix it, in case of 1/ ideally we should open an issue on the plugin's repo to get it fixed. If none of the above is a viable option, we should look at alternatives or removing the plugin entirely.

The good thing is that the plugin is from the same author as Typedoc itself, so unless it's an issue with Zod itself I'm confident there will be a solution.

Acknowledgment

• This request meets Powertools for AWS Lambda (TypeScript) Tenets
• Should this be considered in other Powertools for AWS Lambda languages? i.e. Python, Java, and .NET

Future readers

Please react with 👍 and your use case to help us understand customer demand.

[am29d]

I was also super annoyed by the spam in the logs, hard to see other warnings and errors. I will investigate.

[dreamorosi]

Typedoc released a new version of their package as well as the Zod plugin. The new version was merged in #2949 and I was able to confirm that the warning logs are gone.

Thank you @am29d for opening the issue upstream and getting this fixed!

[github-actions]

⚠️ COMMENT VISIBILITY WARNING ⚠️

This issue is now closed. Please be mindful that future comments are hard for our team to see.

If you need more assistance, please either tag a team member or open a new issue that references this one.

If you wish to keep having a conversation with other community members under this issue feel free to do so.