docs: generate TypeDoc without missing-type warnings

[mcansh]

Summary

Expand helper types referenced in public API signatures using TypeDoc @inline annotations. Include the response matcher JSON value type in the generated signatures. Add schema declarations to package TypeDoc configs so editors validate their options.

public signature → expanded helper type → usable API documentation

These changes only alter comments and documentation configuration.

Evidence

• Before: documentation generation reported eight missing-type warnings.
  After: typedoc --treatWarningsAsErrors generates HTML and JSON for all five packages with zero errors and zero warnings.

• Inspected generated API JSON to confirm helper type references were expanded.

• git diff --check, warning-free TypeDoc generation, and GitHub build/test and HIBP runtime workflows pass on the final head.

• Remaining external failure: Cloudflare Workers Builds is still failing. Its build-log API returns 403 with the existing local credential, so the deployment cause is unverified.

Merge Danger

Door: two-way

Revert this layer to restore the prior generated documentation shape.

Blast Radius: documentation

Inlining expands repeated type definitions and can increase generated documentation size. No runtime code or exports change in this layer.

Stack: #150 → #151 → #152 → #153. Merge from the bottom after checks pass.

_{Stack created with GitHub Stacks CLI}

[coderabbitai]

Important

Draft PR not reviewed

Draft PRs are not automatically reviewed by default.

• Trigger a manual review

To automatically review draft PRs, update your CodeRabbit configuration:

reviews:
  auto_review:
    drafts: true

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

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

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

[changeset-bot]

⚠️ No Changeset found

Latest commit: 7103786

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

[cloudflare-workers-and-pages]

Deploying with    Cloudflare Workers

The latest updates on your project. Learn more about integrating Git with Workers.

Status	Name	Latest Commit	Updated (UTC)
❌ Deployment failed View logs	packages	7103786	Oct 06 2026, 09:03 PM

[chatgpt-codex-connector]

Codex Review Summary

This comment shows the latest Codex review activity on this pull request.

Review	Status	Commit	Review trigger
📝 Code Review	✅ Completed 2026-10-06T21:05:39.855699Z	7103786	New commits

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

• Open a pull request for review
• Mark a draft as ready
• Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

[Copilot]

Copilot review overview

🟢 Approval recommended

The documentation-only changes consistently address missing helper-type references without affecting runtime behavior.

Review effort: Balanced
Findings: None

What changed in this PR

Improves TypeDoc output by expanding internal helper types in public signatures and enabling configuration validation.

Changes:

• Adds @inline annotations to documentation-only helper types.
• Adds TypeDoc schema declarations to package configurations.

File	Description
packages/​vitest-response-matchers/​typedoc.json	Adds TypeDoc schema validation.
packages/​url/​typedoc.json	Adds TypeDoc schema validation.
packages/​http-helmet/​typedoc.json	Adds TypeDoc schema validation.
packages/​http-helmet/​src/​utils.ts	Inlines source-related helper types.
packages/​http-helmet/​src/​rules/​permissions.ts	Inlines permission key types.
packages/​http-helmet/​src/​rules/​content-security-policy.ts	Inlines CSP helper types.
packages/​http-helmet/​src/​react.tsx	Inlines provider props.
packages/​http-helmet/​src/​helmet.ts	Inlines secure-header base properties.
packages/​create-temporary-files/​typedoc.json	Adds TypeDoc schema validation.
packages/​create-temporary-files/​src/​lib.ts	Inlines temporary-file parameters.

---

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

[pullfrog]

✅ No new issues found.

Reviewed changes

This review covers PR #153: "docs: generate TypeDoc without missing-type warnings". The changes add @inline annotations to TypeDoc so helper types referenced in public API signatures are expanded inline, and add $schema to package typedoc.json configs. No runtime code, exports, or public API shapes are changed.

• TypeDoc inline annotations (8 files in http-helmet/create-temporary-files): added /** @inline */ to internal helper types that appear in public signatures so TypeDoc expands them rather than emitting missing-type warnings.
• typedoc.json schema (5 packages): added $schema: "https://typedoc.org/schema.json" to improve editor validation; configs otherwise unchanged.

  ^{｜ View workflow run ｜ Using big-pickle (free) ｜ 𝕏}

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 93.12%. Comparing base (bc040b4) to head (7103786).
✅ All tests successful. No failed tests found.

Additional details and impacted files

@@             Coverage Diff             @@
##           logan/hibp     #153   +/-   ##
===========================================
  Coverage       93.12%   93.12%           
===========================================
  Files              23       23           
  Lines             378      378           
  Branches           97       97           
===========================================
  Hits              352      352           
  Misses             26       26           

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

🚀 New features to boost your workflow:

• 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.