docs: Enable typedoc for snaps-sdk

[Mrtenz]

This enables typedoc for the snaps-sdk, and updates some files to categorise entries.

---

Note

Medium Risk
Adds new CI publishing steps that write to the gh-pages branch on main pushes and SDK releases; misconfiguration could overwrite published docs or publish incorrect versions, but no runtime product logic changes.

Overview
Adds TypeDoc-based API documentation generation for @metamask/snaps-sdk (build:docs, new typedoc.jsonc with typedoc-theme-fresh, favicon asset, and docs output ignored in git), and updates JSDoc across the SDK and JSX entrypoints/components to provide TypeDoc modules/categories and better @see linking.

Introduces GitHub Actions automation to publish generated docs to gh-pages: a new publish-main-docs.yml workflow deploys main-branch docs to docs/staging, and the release workflow now detects SDK version bumps to publish docs to docs/<sdkVersion> and update docs/latest. Also includes minor CI/support tweaks (ESLint allows TypeDoc tags; LavaMoat policy updated for dependency graph changes; lockfile updated for new tooling deps).

^{Written by Cursor Bugbot for commit 0c6b683. This will update automatically on new commits. Configure here.}

[socket-security]

Review the following changes in direct dependencies. Learn more about Socket for GitHub.

Diff	Package	Supply Chain Security	Vulnerability	Quality	Maintenance	License
	typedoc-theme-fresh@​0.2.3
	typedoc@​0.28.16

View full report

[socket-security]

All alerts resolved. Learn more about Socket for GitHub.

This PR previously contained dependency changes with security issues that have been resolved, removed, or ignored.

Ignoring alerts on:

• @shikijs/langs@3.22.0
• linkify-it@5.0.0
• markdown-it@14.1.0
• mdurl@2.0.0
• typedoc@0.28.16
• yaml@2.8.2

View full report

[Mrtenz]

@metamaskbot update-pr

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 98.59%. Comparing base (ce80114) to head (0c6b683).
⚠️ Report is 4 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #3840      +/-   ##
==========================================
+ Coverage   98.47%   98.59%   +0.12%     
==========================================
  Files         429      429              
  Lines       12421    12417       -4     
  Branches     1924     1928       +4     
==========================================
+ Hits        12231    12242      +11     
+ Misses        190      175      -15     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
• 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

[Mrtenz]

@SocketSecurity ignore npm/markdown-it@14.1.0
@SocketSecurity ignore npm/@shikijs/langs@3.22.0
@SocketSecurity ignore npm/linkify-it@5.0.0
False positive.

@SocketSecurity ignore npm/typedoc@0.28.16
Network access used to validate links (if enabled).

[Mrtenz]

@SocketSecurity ignore npm/yaml@2.8.2
@SocketSecurity ignore npm/mdurl@2.0.0
Doesn't seem to be any vulnerability according to the description of the Socket warnings.

[cursor]

Cursor Bugbot has reviewed your changes and found 1 potential issue.

[FrederikBolding]

Hmm, it's not obvious to me from the yarn.lock diff why this changed 🤔

[Mrtenz]

Unsure, but the change seems fine 🤔

[FrederikBolding]

Yeah, the node_modules shape must have changed a bit for whatever reason. So now it is using a more local version to the package 🤔