fix(backend): Correct WaitlistEntryAPI list return type and export WaitlistEntry #7280

kduprey · 2025-11-21T03:35:13Z

Description

Fixes TypeScript return type for WaitlistEntryAPI.list() to properly reflect that it returns an array of WaitlistEntry objects within the paginated response, and exports the WaitlistEntry type from the backend package.

Changes

Fix WaitlistEntryAPI.list() return type from PaginatedResourceResponse<WaitlistEntry> to PaginatedResourceResponse<WaitlistEntry[]>
Export WaitlistEntry type from @clerk/backend package index

Fixes USER-4021

Checklist

pnpm test runs as expected.
pnpm build runs as expected.
(If applicable) JSDoc comments have been added or updated for any package exports
(If applicable) Documentation has been updated

Type of change

Summary by CodeRabbit

Bug Fixes
- Fixed the waitlist listing to return an array of entries within the paginated response.
New Features
- Exposed the WaitlistEntry type from the backend package for public use.
Chores
- Bumped minor version for the backend package.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

changeset-bot · 2025-11-21T03:35:17Z

🦋 Changeset detected

Latest commit: c2a2071

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 11 packages

Name	Type
@clerk/backend	Minor
@clerk/agent-toolkit	Patch
@clerk/astro	Patch
@clerk/express	Patch
@clerk/fastify	Patch
@clerk/nextjs	Patch
@clerk/nuxt	Patch
@clerk/react-router	Patch
@clerk/remix	Patch
@clerk/tanstack-react-start	Patch
@clerk/testing	Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

vercel · 2025-11-21T03:35:18Z

The latest updates on your projects. Learn more about Vercel for GitHub.

Project	Deployment	Preview	Comments	Updated (UTC)
clerk-js-sandbox	Ready	Preview	Comment	Nov 21, 2025 10:18pm

coderabbitai · 2025-11-21T03:35:25Z

Walkthrough

Corrects the TypeScript return type of WaitlistEntryAPI.list() to return a paginated array (WaitlistEntry[]) and adds WaitlistEntry to the backend package's public exports; updates the changeset metadata accordingly.

Changes

Cohort / File(s)	Change Summary
Version & Changelog `\.changeset/open-streets-drum.md`	Bumps `@clerk/backend` minor; documents the WaitlistEntry API return type fix and export change.
API Endpoint Type Fix `packages/backend/src/api/endpoints/WaitlistEntryApi.ts`	Changed `WaitlistEntryAPI.list()` return type from `PaginatedResourceResponse<WaitlistEntry>` to `PaginatedResourceResponse<WaitlistEntry[]>`.
Package Exports `packages/backend/src/index.ts`	Added `WaitlistEntry` to top-level exports and to the `./api/resources` export block for public consumption.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Pay attention to:
- Ensuring the updated return type aligns with runtime response shape (array vs single item).
- Verifying WaitlistEntry is the correct type and is exported without name collisions.
- Confirming downstream consumers/import paths still resolve after the export change.

Poem

🐰 I nudged a type from one to many,
The list now dances, light as any.
An export opened, tidy and neat,
Waitlist entries march in proper beat.
Hooray — the types hop on their feet! 🎉

Pre-merge checks and finishing touches

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title clearly summarizes the main changes: correcting the WaitlistEntryAPI list return type and exporting the WaitlistEntry type.
Linked Issues check	✅ Passed	The pull request fulfills both objectives from USER-4021: corrects the return type to PaginatedResourceResponse<WaitlistEntry[]> and exports the WaitlistEntry type.
Out of Scope Changes check	✅ Passed	All changes are directly related to the linked issue objectives: the changeset, API return type fix, and type exports are all within scope.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✨ Finishing touches

🧪 Generate unit tests (beta)

Create PR with unit tests
Post copyable unit tests in a comment
Commit unit tests in branch kenton/user-4021-fix-typescript-return-type-for-clerkclient-waitlistentries

📜 Recent review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Disabled knowledge base sources:

Linear integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

📥 Commits

Reviewing files that changed from the base of the PR and between dd3dd61 and c2a2071.

📒 Files selected for processing (1)

.changeset/open-streets-drum.md (1 hunks)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (35)

GitHub Check: Integration Tests (machine, chrome)
GitHub Check: Integration Tests (nextjs, chrome, 14)
GitHub Check: Integration Tests (quickstart, chrome, 15)
GitHub Check: Integration Tests (quickstart, chrome, 16)
GitHub Check: Integration Tests (generic, chrome)
GitHub Check: Integration Tests (expo-web, chrome)
GitHub Check: Integration Tests (billing, chrome)
GitHub Check: Integration Tests (express, chrome)
GitHub Check: Integration Tests (machine, chrome, RQ)
GitHub Check: Integration Tests (nextjs, chrome, 15)
GitHub Check: Integration Tests (custom, chrome)
GitHub Check: Integration Tests (billing, chrome, RQ)
GitHub Check: Integration Tests (nuxt, chrome)
GitHub Check: Integration Tests (nextjs, chrome, 15, RQ)
GitHub Check: Integration Tests (nextjs, chrome, 16)
GitHub Check: Integration Tests (astro, chrome)
GitHub Check: Integration Tests (tanstack-react-start, chrome)
GitHub Check: Integration Tests (vue, chrome)
GitHub Check: Integration Tests (react-router, chrome)
GitHub Check: Integration Tests (sessions, chrome)
GitHub Check: Integration Tests (ap-flows, chrome)
GitHub Check: Integration Tests (handshake:staging, chrome)
GitHub Check: Integration Tests (handshake, chrome)
GitHub Check: Integration Tests (localhost, chrome)
GitHub Check: Integration Tests (elements, chrome)
GitHub Check: Integration Tests (sessions:staging, chrome)
GitHub Check: Publish with pkg-pr-new
GitHub Check: Unit Tests (22, **)
GitHub Check: Unit Tests (22, shared, clerk-js, RQ)
GitHub Check: Static analysis
GitHub Check: Formatting | Dedupe | Changeset
GitHub Check: triage
GitHub Check: Analyze (javascript-typescript)
GitHub Check: semgrep-cloud-platform/scan
GitHub Check: semgrep-cloud-platform/scan

🔇 Additional comments (1)

.changeset/open-streets-drum.md (1)

1-5: Changeset description is clear, but implementation files are missing from this review.

The changeset correctly documents a minor version bump with clear descriptions of the TypeScript return type fix and WaitlistEntry export. However, the PR objectives reference specific implementation changes in packages/backend/src/api/endpoints/WaitlistEntryApi.ts and packages/backend/src/index.ts, but these files are not included in this review.

To verify this changeset is accurate:

Confirm implementation changes: The PR should modify WaitlistEntryAPI.list() return type from PaginatedResourceResponse<WaitlistEntry> to PaginatedResourceResponse<WaitlistEntry[]> and export WaitlistEntry from the backend package index. Please provide these files for review or confirm these changes have been made.

Run tests: The PR checklist shows pnpm test is not confirmed. Please run the test suite to ensure the return type change doesn't break existing tests and that type exports are correctly recognized by consumers.

Validate JSDoc alignment: Per the checklist, JSDoc updates should be applied where applicable—ensure any documentation for WaitlistEntryAPI.list() reflects the new return type.

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

dstaley · 2025-11-21T14:49:32Z

packages/shared/src/types/waitlist.ts

+  /**
+   * The email address associated with the `WaitlistResource`.
+   */
+  emailAddress: string;


This file is the FAPI representation of a WaitlistEntry, which is just

{ "object": "waitlist_entry", "id": "wle_35nCTK0zjvUt181oXWwlVvd3aTO" }

I think the fields you've added here are from the BAPI representation? backend uses https://github.com/clerk/javascript/blob/69833fefe7a2f2eb0eb72d94617fe39a208ed310/packages/backend/src/api/resources/WaitlistEntry.ts which has these fields (albeit without the comments)

pkg-pr-new · 2025-11-21T18:04:59Z

Open in StackBlitz

@clerk/agent-toolkit

npm i https://pkg.pr.new/@clerk/agent-toolkit@7280

@clerk/astro

npm i https://pkg.pr.new/@clerk/astro@7280

@clerk/backend

npm i https://pkg.pr.new/@clerk/backend@7280

@clerk/chrome-extension

npm i https://pkg.pr.new/@clerk/chrome-extension@7280

@clerk/clerk-js

npm i https://pkg.pr.new/@clerk/clerk-js@7280

@clerk/dev-cli

npm i https://pkg.pr.new/@clerk/dev-cli@7280

@clerk/elements

npm i https://pkg.pr.new/@clerk/elements@7280

@clerk/clerk-expo

npm i https://pkg.pr.new/@clerk/clerk-expo@7280

@clerk/expo-passkeys

npm i https://pkg.pr.new/@clerk/expo-passkeys@7280

@clerk/express

npm i https://pkg.pr.new/@clerk/express@7280

@clerk/fastify

npm i https://pkg.pr.new/@clerk/fastify@7280

@clerk/localizations

npm i https://pkg.pr.new/@clerk/localizations@7280

@clerk/nextjs

npm i https://pkg.pr.new/@clerk/nextjs@7280

@clerk/nuxt

npm i https://pkg.pr.new/@clerk/nuxt@7280

@clerk/clerk-react

npm i https://pkg.pr.new/@clerk/clerk-react@7280

@clerk/react-router

npm i https://pkg.pr.new/@clerk/react-router@7280

@clerk/remix

npm i https://pkg.pr.new/@clerk/remix@7280

@clerk/shared

npm i https://pkg.pr.new/@clerk/shared@7280

@clerk/tanstack-react-start

npm i https://pkg.pr.new/@clerk/tanstack-react-start@7280

@clerk/testing

npm i https://pkg.pr.new/@clerk/testing@7280

@clerk/themes

npm i https://pkg.pr.new/@clerk/themes@7280

@clerk/types

npm i https://pkg.pr.new/@clerk/types@7280

@clerk/upgrade

npm i https://pkg.pr.new/@clerk/upgrade@7280

@clerk/vue

npm i https://pkg.pr.new/@clerk/vue@7280

commit: c2a2071

…itlistEntry Fixes TypeScript return type for `WaitlistEntryAPI.list()` to properly reflect that it returns an array of `WaitlistEntry` objects within the paginated response, and exports the `WaitlistEntry` type from the backend package. ## Changes - Fix `WaitlistEntryAPI.list()` return type from `PaginatedResourceResponse<WaitlistEntry>` to `PaginatedResourceResponse<WaitlistEntry[]>` - Export `WaitlistEntry` type from `@clerk/backend` package index Signed-off-by: Kenton Duprey <kenton@clerk.dev>

kduprey requested a review from dstaley November 21, 2025 03:35

kduprey self-assigned this Nov 21, 2025

clerk-cookie added the backend label Nov 21, 2025

kduprey added the do not merge label Nov 21, 2025

kduprey changed the title ~~fix(backend,shared): Correct WaitlistEntryAPI list return type~~ WIP: fix(backend,shared): Correct WaitlistEntryAPI list return type Nov 21, 2025

dstaley reviewed Nov 21, 2025

View reviewed changes

vercel bot deployed to Preview November 21, 2025 18:01 View deployment

kduprey force-pushed the kenton/user-4021-fix-typescript-return-type-for-clerkclient-waitlistentries branch from 578f72f to 5d52b88 Compare November 21, 2025 20:52

kduprey changed the title ~~WIP: fix(backend,shared): Correct WaitlistEntryAPI list return type~~ fix(backend): Correct WaitlistEntryAPI list return type and export WaitlistEntry Nov 21, 2025

vercel bot deployed to Preview November 21, 2025 20:53 View deployment

kduprey requested a review from dstaley November 21, 2025 20:57

kduprey force-pushed the kenton/user-4021-fix-typescript-return-type-for-clerkclient-waitlistentries branch from 5d52b88 to dd3dd61 Compare November 21, 2025 21:18

vercel bot deployed to Preview November 21, 2025 21:19 View deployment

chore(repo): Update changeset

c2a2071

dstaley approved these changes Nov 21, 2025

View reviewed changes

vercel bot deployed to Preview November 21, 2025 22:18 View deployment

kduprey merged commit 337430b into main Nov 21, 2025
44 of 46 checks passed

kduprey deleted the kenton/user-4021-fix-typescript-return-type-for-clerkclient-waitlistentries branch November 21, 2025 22:34

clerk-cookie mentioned this pull request Nov 21, 2025

ci(repo): Version packages #7286

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

fix(backend): Correct WaitlistEntryAPI list return type and export WaitlistEntry #7280

fix(backend): Correct WaitlistEntryAPI list return type and export WaitlistEntry #7280

Uh oh!

kduprey commented Nov 21, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

changeset-bot bot commented Nov 21, 2025 •

edited

Loading

Uh oh!

vercel bot commented Nov 21, 2025 •

edited

Loading

Uh oh!

coderabbitai bot commented Nov 21, 2025 •

edited

Loading

Uh oh!

dstaley Nov 21, 2025

Uh oh!

pkg-pr-new bot commented Nov 21, 2025 •

edited

Loading

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

fix(backend): Correct WaitlistEntryAPI list return type and export WaitlistEntry #7280

fix(backend): Correct WaitlistEntryAPI list return type and export WaitlistEntry #7280

Uh oh!

Conversation

kduprey commented Nov 21, 2025 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Changes

Checklist

Type of change

Summary by CodeRabbit

Uh oh!

changeset-bot bot commented Nov 21, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🦋 Changeset detected

Uh oh!

vercel bot commented Nov 21, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

coderabbitai bot commented Nov 21, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Estimated code review effort

Poem

Pre-merge checks and finishing touches

Uh oh!

dstaley Nov 21, 2025

Choose a reason for hiding this comment

Uh oh!

pkg-pr-new bot commented Nov 21, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

kduprey commented Nov 21, 2025 •

edited by coderabbitai bot

Loading

changeset-bot bot commented Nov 21, 2025 •

edited

Loading

vercel bot commented Nov 21, 2025 •

edited

Loading

coderabbitai bot commented Nov 21, 2025 •

edited

Loading

pkg-pr-new bot commented Nov 21, 2025 •

edited

Loading