docs(auth0-auth-js): add TypeDoc categories and Mintlify artifact

[gyaneshgouraw]

Summary

Groups the @auth0/auth0-auth-js API reference with TypeDoc categories and emits the Mintlify JSON artifact for docs-v2. No runtime changes.

Changes

• Added @category tags: Getting Started (AuthClient), Configuration, Sub-clients, Utilities, and Errors. AuthClient members are grouped by feature. Data and result types stay in Other.
• Added typedoc.cjs, which writes HTML to docs/ (gitignored) and mintlify/auth0-auth-js.json (committed).
• Added a docs script: npm run docs -w @auth0/auth0-auth-js.
• Added one-line summaries for symbols that had no JSDoc.

References

• #311 (auth0-server-js) and #302 (auth0-api-js)

Testing

• Package docs build: 0 errors, no new warnings (same 14 as main).
• Every category in the JSON is listed in categoryOrder, and all source links use main.
• Compared every doc summary against an untagged build: none lost.

🤖 Generated with Claude Code

Summary by CodeRabbit

• Documentation
  • Added generated API documentation for the Auth0 JavaScript SDK, organized by authentication features, sub-clients, configuration, utilities, and errors.
  • Expanded descriptions of database, MFA, passkey, passwordless, and telemetry capabilities to make their roles and available operations easier to understand.
  • Documentation is generated as part of the package’s post-release versioning workflow.

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

• Configuration used: defaults
• Review profile: CHILL
• Plan: Advanced
• Run ID: b5554ccb-c4e2-4ec4-adf9-b483a85ee071

📥 Commits

Reviewing files that changed from the base of the PR and between 8668469 and 7069767.

📒 Files selected for processing: 3

• packages/auth0-auth-js/.shiprc
• packages/auth0-auth-js/tsconfig.docs.json
• packages/auth0-auth-js/typedoc.cjs

Included review availability: This review used your included allowance. Your plan provides up to 1 included review per hour; 0 remain after this review.

📝 Walkthrough

The package adds TypeDoc generation for HTML and JSON outputs. JSDoc descriptions and category tags organize the Auth0 client API, sub-clients, configuration types, utilities, and errors. No runtime behavior or public declarations change.

Changes: API documentation

Layer / File(s)	Summary
TypeDoc generation setup packages/auth0-auth-js/package.json, packages/auth0-auth-js/typedoc.cjs, packages/auth0-auth-js/tsconfig.docs.json, packages/auth0-auth-js/.shiprc	A docs script invokes TypeDoc, and the post-bump command runs that script. The TypeDoc configuration defines HTML and JSON outputs, filtering, categories, navigation, and sorting. The documentation TypeScript configuration excludes spec files and test utilities.
Public API documentation packages/auth0-auth-js/src/auth-client.ts, packages/auth0-auth-js/src/*/…, packages/auth0-auth-js/src/types.ts, packages/auth0-auth-js/src/telemetry.ts, packages/auth0-auth-js/src/domain-discovery.ts	JSDoc categories and descriptions are added for AuthClient operations, sub-clients, configuration types, and utilities.
Error documentation packages/auth0-auth-js/src/*/errors.ts, packages/auth0-auth-js/src/errors.ts	Error response types, codes, and classes receive error-category tags. The isMfaRequiredError documentation receives a Utilities category.

Priority: ⬇️ Low

Estimated code review effort: 2 (Simple) | ~10 minutes

Merge Risk: ⚪ Minimal · up to 70697

The documentation changes have no established merge-blocking issue; proceed with normal checks.

Security architecture risk: 🔵 Low · up to 70697

The change adds documentation generation during version bumps without an observed change to authentication behavior or permissions. Remaining uncertainty concerns release ordering and recovery if documentation generation fails or is interrupted.

Retained concerns
No architecture-level concerns identified.

Security review details

Security Blast Radius

• observed — The configured new outputs are package documentation files. HTML is disposable ignored output, while the Mintlify JSON is tracked at the reviewed head. No tenant, service, or data-store authority expansion was established by the inspected change.

Trust Boundaries and Controls

• inferred — The hook adds execution of the documentation tool within the invoking release process, rather than defining a separate identity or sandbox. Its effective authority therefore depends on the existing release environment; the inspected configuration does not introduce a new credential or role.

Pre-merge checks: 5

Check name	Status	Explanation
Description Check		Check skipped - CodeRabbit’s high-level summary is enabled.
Title check		The title clearly and concisely describes the main changes: adding TypeDoc categories and a Mintlify artifact for auth0-auth-js.
Docstring Coverage		Docstring coverage is 100.00% which is sufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Analyzed 2 functions across 18 files. (2 skipped: 2…
Linked Issues check		Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check		Check skipped because no linked issues were found for this pull request.

Full details: Docstring Coverage

Explanation

Docstring coverage is 100.00% which is sufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Analyzed 2 functions across 18 files. (2 skipped: 2 unsupported.)

✨ Finishing Touches

📝 Generate docstrings

• Commit to this branch
• Create a new PR

🧪 Generate unit tests (beta)

• Commit to this branch
• Create a new PR

• Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

_{Comment @coderabbitai help to get the list of available commands.}