Return ComponentApi from the test register function

[ianmacartney]

This lets convex-test's defineTestApp infer the component's API when the
test module is passed directly in its components map.

[ianmacartney]

• Return ComponentApi from the test register function #120 👈 (View in Graphite)
• main

This stack of pull requests is managed by Graphite. Learn more about stacking.

[pkg-pr-new]

Open in StackBlitz

npm i https://pkg.pr.new/@convex-dev/resend@120

commit: a1c013f

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

• Configuration used: Repository: get-convex/coderabbit/.coderabbit.yaml
• Review profile: CHILL
• Plan: Advanced
• Run ID: 56a9703c-9371-47d1-bdaf-e5139d2e232c

---

📥 Commits

Reviewing files that changed from the base of the PR and between 400a05b and a1c013f.

---

📒 Files selected for processing (1)

• src/test.ts

---

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

Walkthrough

The register function now returns the API for the registered component, typed as ComponentApi. Its documentation describes the return value and its use with ctx.runMutation or thick-client code.

---

Priority: ⬇️ Low

Change: Feature

Merge Risk: ⚪ Minimal · up to a1c01

No concrete failure in the current repository workflow is established, so no actionable merge risk remains.

🚥 Pre-merge checks | ✅ 4

✅ Passed checks (4 passed)

Check name	Status	Explanation
Title check		The title clearly and concisely states the main change: register now returns ComponentApi.
Description check		The description explains how the change lets defineTestApp infer the component API. It directly relates to the changeset.
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.

---

---

✨ 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

Warning

Some tools did not complete. Review the errors below.

🔧 ESLint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

src/test.ts

ESLint skipped: missing config or dependency (missing-dependency). The ESLint configuration references a package that is not available in the sandbox.

---

---

---

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