[QoL] Fixed annoying TypeDoc errors that have been a distraction to PRs

[thehenrytsai]

1. Fixed annoying TypeDoc errors that have been a distraction to PRs
2. Also turned on fail-on-error for TypeDoc generation during CI so TypeDoc warnings only annoys the person who introduces it.

[changeset-bot]

⚠️ No Changeset found

Latest commit: afbbc5b

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

[github-actions]

TBDocs Report

✅ No errors or warnings

@web5/api

• Project entry file: packages/api/src/index.ts

@web5/crypto

• Project entry file: packages/crypto/src/index.ts

@web5/crypto-aws-kms

• Project entry file: packages/crypto-aws-kms/src/index.ts

@web5/dids

• Project entry file: packages/dids/src/index.ts

@web5/credentials

• Project entry file: packages/credentials/src/index.ts

---

TBDocs Report Updated at 2024-05-01T18:44:56Z afbbc5b

[codecov-commenter]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 90.81%. Comparing base (ac1e6f1) to head (afbbc5b).

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #506   +/-   ##
=======================================
  Coverage   90.80%   90.81%           
=======================================
  Files         116      116           
  Lines       29409    29425   +16     
  Branches     2156     2156           
=======================================
+ Hits        26706    26722   +16     
  Misses       2668     2668           
  Partials       35       35           

Components	Coverage Δ
agent	79.90% <ø> (ø)
api	97.91% <100.00%> (+<0.01%)	⬆️
common	98.68% <ø> (ø)
credentials	95.26% <100.00%> (+<0.01%)	⬆️
crypto	93.81% <ø> (ø)
dids	97.65% <ø> (ø)
identity-agent	96.70% <ø> (ø)
crypto-aws-kms	100.00% <100.00%> (ø)
proxy-agent	96.70% <ø> (ø)
user-agent	96.70% <ø> (ø)

[shamilovtim]

The typedocs message is still gigantic. Any reason it's doing this, can we fix?

@web5/api
Project entry file: packages/api/src/index.ts
@web5/crypto
Project entry file: packages/crypto/src/index.ts
@web5/crypto-aws-kms
Project entry file: packages/crypto-aws-kms/src/index.ts
@web5/dids
Project entry file: packages/dids/src/index.ts
@web5/credentials
Project entry file: packages/credentials/src/index.ts

[thehenrytsai]

@shamilovtim probably there is a way, but I have no desire to go beyond this right now, but feel free to take a stab at this, just consider RoI if you are at it.

I think this baby step is a good win already.

[shamilovtim]

some questions around how thorough we want the docs to be in the future and whether return types and param types are auto generated

[LiranCohen]

This is great!

Maybe we can include this also with the PR since we've been having issues with pnpm builds due to type inference.

#507

[LiranCohen]

@thehenrytsai don't forget to add a changeset to this PR.

https://github.com/TBD54566975/web5-js/blob/main/CONTRIBUTING.md#project-versioning-guidelines