feat(react, core, docs-api): added typedoc to generate documentation for component references

[rax7389]

📋 Summary

Introduces TypeDoc for automated API documentation, a GitHub Actions pipeline for auto-deployment to GitHub Pages, and JSDoc ESLint validation to ensure documentation quality.

TypeDoc Integration

• Added typedoc.json configuration
• Added docs-api.yml GitHub workflow (triggers on push to main, manual, or after npm publish)
• New scripts: pnpm docs:api and pnpm docs:api:watch

ESLint JSDoc Validation

• Replaced eslint-plugin-tsdoc with eslint-plugin-jsdoc
• check-param-names (error) - Fails if @param doesn't match actual function parameters // will be set to error once we are resolved with existing 358 issues
• require-param, require-returns, require-jsdoc (warn) - Encourages complete documentation

Documentation Fixes

• Fixed JSDoc mismatches in api-error.ts, theme-utils.ts, token-manager.ts, toast.tsx, theme-provider.tsx
• Added complete JSDoc to user-mfa-management.tsx // other components will be done as part of separate task
• Added FactorConfig type with documentation

Testing

pnpm lint # 0 errors, ~358 warnings // will be taken care as part of separate task
pnpm docs:api # Generate API docs

• This change adds unit test coverage
• This change has been tested on the latest version of the platform/language or why not

Checklist

• I have read the Auth0 general contribution guidelines
• I have read the Auth0 Code of Conduct
• All existing and new tests complete without errors

[github-actions]

🚀 Preview deployment

Branch: refs/pull/57/merge
Commit: c0be5c7

📝 Preview URL: https://auth0-universal-components-6cklfwv1i-okta.vercel.app

---

Updated at 2026-01-29T13:12:58.302Z

[codecov-commenter]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 84.99%. Comparing base (124c7a6) to head (2c2a056).
⚠️ Report is 3 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff            @@
##             main      #57    +/-   ##
========================================
  Coverage   84.99%   84.99%            
========================================
  Files         126      126            
  Lines       10569    10569            
  Branches     1352     1157   -195     
========================================
  Hits         8983     8983            
  Misses       1586     1586            

☔ 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.