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

Merged
kduprey merged 2 commits into
mainfrom
kenton/user-4021-fix-typescript-return-type-for-clerkclient-waitlistentries
Nov 21, 2025
Merged

fix(backend): Correct WaitlistEntryAPI list return type and export WaitlistEntry#7280
kduprey merged 2 commits into
mainfrom
kenton/user-4021-fix-typescript-return-type-for-clerkclient-waitlistentries

Conversation

@kduprey

@kdupreykduprey commented Nov 21, 2025•
edited by coderabbitai Bot
Loading

Copy link
Copy Markdown
Contributor

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

  • 🐛 Bug fix
  • 🌟 New feature
  • 🔨 Breaking change
  • 📖 Refactoring / dependency upgrade / documentation
  • other:

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.

@kduprey
kduprey requested a review from dstaleyNovember 21, 2025 03:35
@kdupreykduprey self-assigned this Nov 21, 2025
@changeset-bot

changeset-botBot commented Nov 21, 2025•
edited
Loading

Copy link
Copy Markdown

🦋 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
NameType
@clerk/backendMinor
@clerk/agent-toolkitPatch
@clerk/astroPatch
@clerk/expressPatch
@clerk/fastifyPatch
@clerk/nextjsPatch
@clerk/nuxtPatch
@clerk/react-routerPatch
@clerk/remixPatch
@clerk/tanstack-react-startPatch
@clerk/testingPatch

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

vercelBot commented Nov 21, 2025•
edited
Loading

Copy link
Copy Markdown

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

ProjectDeploymentPreviewCommentsUpdated (UTC)
clerk-js-sandboxReadyReadyPreviewCommentNov 21, 2025 10:18pm

@coderabbitai

coderabbitaiBot commented Nov 21, 2025•
edited
Loading

Copy link
Copy Markdown
Contributor

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 nameStatusExplanation
Description Check✅ PassedCheck skipped - CodeRabbit’s high-level summary is enabled.
Title check✅ PassedThe title clearly summarizes the main changes: correcting the WaitlistEntryAPI list return type and exporting the WaitlistEntry type.
Linked Issues check✅ PassedThe 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✅ PassedAll changes are directly related to the linked issue objectives: the changeset, API return type fix, and type exports are all within scope.
Docstring Coverage✅ PassedNo 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:

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

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

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

@kdupreykduprey changed the title fix(backend,shared): Correct WaitlistEntryAPI list return typeWIP: fix(backend,shared): Correct WaitlistEntryAPI list return typeNov 21, 2025
dstaley
dstaley reviewed Nov 21, 2025
View reviewed changes
Comment threadpackages/shared/src/types/waitlist.ts Outdated
/**
* The email address associated with the `WaitlistResource`.
*/
emailAddress: string;

@dstaleydstaleyNov 21, 2025

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

pkg-pr-newBot commented Nov 21, 2025•
edited
Loading

Copy link
Copy Markdown

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

@kduprey
kdupreyforce-pushed the kenton/user-4021-fix-typescript-return-type-for-clerkclient-waitlistentries branch from 578f72f to 5d52b88CompareNovember 21, 2025 20:52
@kdupreykduprey changed the title WIP: fix(backend,shared): Correct WaitlistEntryAPI list return typefix(backend): Correct WaitlistEntryAPI list return type and export WaitlistEntryNov 21, 2025
@kduprey
kduprey requested a review from dstaleyNovember 21, 2025 20:57
Kenton Duprey
fix(backend): Correct WaitlistEntryAPI list return type and export Wa…
dd3dd61
…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
kdupreyforce-pushed the kenton/user-4021-fix-typescript-return-type-for-clerkclient-waitlistentries branch from 5d52b88 to dd3dd61CompareNovember 21, 2025 21:18
@kduprey
kduprey merged commit 337430b into mainNov 21, 2025
44 of 46 checks passed
@kduprey
kduprey deleted the kenton/user-4021-fix-typescript-return-type-for-clerkclient-waitlistentries branch November 21, 2025 22:34
@clerk-cookieclerk-cookie mentioned this pull request Nov 21, 2025
Merged
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@dstaleydstaleydstaley approved these changes

Assignees

@kdupreykduprey

Labels

backenddo not merge

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@kduprey@dstaley@clerk-cookie
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
fix(backend): Correct WaitlistEntryAPI list return type and export WaitlistEntry - #7280
Merged
kduprey merged 2 commits into
mainfrom 
kenton/user-4021-fix-typescript-return-type-for-clerkclient-waitlistentries
Nov 21, 2025
Merged
fix(backend): Correct WaitlistEntryAPI list return type and export WaitlistEntry#7280
kduprey merged 2 commits into
mainfrom 
kenton/user-4021-fix-typescript-return-type-for-clerkclient-waitlistentries
Conversation
@kduprey
@kdupreykduprey
commented
Nov 21, 2025•

edited by coderabbitai
Bot
Loading

Copy link


Copy Markdown

Contributor
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
  •  🐛 Bug fix
  •  🌟 New feature
  •  🔨 Breaking change
  •  📖 Refactoring / dependency upgrade / documentation
  •  other:
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.
@kduprey
kduprey
requested a review
from dstaleyNovember 21, 2025 03:35
@kdupreykduprey
self-assigned this
Nov 21, 2025
@changeset-bot
changeset-botBot
commented
Nov 21, 2025•

edited

Loading

Copy link


Copy Markdown

🦋 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
NameType
@clerk/backendMinor
@clerk/agent-toolkitPatch
@clerk/astroPatch
@clerk/expressPatch
@clerk/fastifyPatch
@clerk/nextjsPatch
@clerk/nuxtPatch
@clerk/react-routerPatch
@clerk/remixPatch
@clerk/tanstack-react-startPatch
@clerk/testingPatch
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
vercelBot
commented
Nov 21, 2025•

edited

Loading

Copy link


Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.
ProjectDeploymentPreviewCommentsUpdated (UTC)
clerk-js-sandboxReadyReadyPreviewCommentNov 21, 2025 10:18pm
@coderabbitai
coderabbitaiBot
commented
Nov 21, 2025•

edited

Loading

Copy link


Copy Markdown

Contributor
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 nameStatusExplanation
Description Check✅ PassedCheck skipped - CodeRabbit’s high-level summary is enabled.
Title check✅ PassedThe title clearly summarizes the main changes: correcting the WaitlistEntryAPI list return type and exporting the WaitlistEntry type.
Linked Issues check✅ PassedThe 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✅ PassedAll changes are directly related to the linked issue objectives: the changeset, API return type fix, and type exports are all within scope.
Docstring Coverage✅ PassedNo 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:
  1. 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.
  2. 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.
  3. 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.
@kdupreykduprey
changed the title
fix(backend,shared): Correct WaitlistEntryAPI list return typeWIP: fix(backend,shared): Correct WaitlistEntryAPI list return typeNov 21, 2025
dstaley
dstaley
reviewed
Nov 21, 2025
View reviewed changes
Comment threadpackages/shared/src/types/waitlist.ts
Outdated

 /**
 * The email address associated with the `WaitlistResource`.
 */
 emailAddress: string;
@dstaleydstaleyNov 21, 2025

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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
pkg-pr-newBot
commented
Nov 21, 2025•

edited

Loading

Copy link


Copy Markdown

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
@kduprey
kdupreyforce-pushed
the
kenton/user-4021-fix-typescript-return-type-for-clerkclient-waitlistentries
branch
from
578f72f to
5d52b88CompareNovember 21, 2025 20:52
@kdupreykduprey
changed the title
WIP: fix(backend,shared): Correct WaitlistEntryAPI list return typefix(backend): Correct WaitlistEntryAPI list return type and export WaitlistEntryNov 21, 2025
@kduprey
kduprey
requested a review
from dstaleyNovember 21, 2025 20:57
Kenton Duprey
fix(backend): Correct WaitlistEntryAPI list return type and export Wa…
dd3dd61
…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
kdupreyforce-pushed
the
kenton/user-4021-fix-typescript-return-type-for-clerkclient-waitlistentries
branch
from
5d52b88 to
dd3dd61CompareNovember 21, 2025 21:18
@kduprey
kduprey
merged commit 337430b
into
mainNov 21, 2025

44 of 46 checks passed

@kduprey
kduprey
deleted the

kenton/user-4021-fix-typescript-return-type-for-clerkclient-waitlistentries

branch
November 21, 2025 22:34
@clerk-cookieclerk-cookie
mentioned this pull request
Nov 21, 2025
 Merged

Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers

@dstaleydstaleydstaley approved these changes

Assignees

@kdupreykduprey

Labels

backenddo not merge

Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

3 participants

@kduprey@dstaley@clerk-cookie

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
fix(backend): Correct WaitlistEntryAPI list return type and export WaitlistEntry - #7280
Merged
kduprey merged 2 commits into
mainfrom 
kenton/user-4021-fix-typescript-return-type-for-clerkclient-waitlistentries
Nov 21, 2025
Merged
fix(backend): Correct WaitlistEntryAPI list return type and export WaitlistEntry#7280
kduprey merged 2 commits into
mainfrom 
kenton/user-4021-fix-typescript-return-type-for-clerkclient-waitlistentries
Conversation
@kduprey
@kdupreykduprey
commented
Nov 21, 2025•

edited by coderabbitai
Bot
Loading

Copy link


Copy Markdown

Contributor
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
  •  🐛 Bug fix
  •  🌟 New feature
  •  🔨 Breaking change
  •  📖 Refactoring / dependency upgrade / documentation
  •  other:
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.
@kduprey
kduprey
requested a review
from dstaleyNovember 21, 2025 03:35
@kdupreykduprey
self-assigned this
Nov 21, 2025
@changeset-bot
changeset-botBot
commented
Nov 21, 2025•

edited

Loading

Copy link


Copy Markdown

🦋 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
NameType
@clerk/backendMinor
@clerk/agent-toolkitPatch
@clerk/astroPatch
@clerk/expressPatch
@clerk/fastifyPatch
@clerk/nextjsPatch
@clerk/nuxtPatch
@clerk/react-routerPatch
@clerk/remixPatch
@clerk/tanstack-react-startPatch
@clerk/testingPatch
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
vercelBot
commented
Nov 21, 2025•

edited

Loading

Copy link


Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.
ProjectDeploymentPreviewCommentsUpdated (UTC)
clerk-js-sandboxReadyReadyPreviewCommentNov 21, 2025 10:18pm
@coderabbitai
coderabbitaiBot
commented
Nov 21, 2025•

edited

Loading

Copy link


Copy Markdown

Contributor
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 nameStatusExplanation
Description Check✅ PassedCheck skipped - CodeRabbit’s high-level summary is enabled.
Title check✅ PassedThe title clearly summarizes the main changes: correcting the WaitlistEntryAPI list return type and exporting the WaitlistEntry type.
Linked Issues check✅ PassedThe 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✅ PassedAll changes are directly related to the linked issue objectives: the changeset, API return type fix, and type exports are all within scope.
Docstring Coverage✅ PassedNo 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:
  1. 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.
  2. 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.
  3. 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.
@kdupreykduprey
changed the title
fix(backend,shared): Correct WaitlistEntryAPI list return typeWIP: fix(backend,shared): Correct WaitlistEntryAPI list return typeNov 21, 2025
dstaley
dstaley
reviewed
Nov 21, 2025
View reviewed changes
Comment threadpackages/shared/src/types/waitlist.ts
Outdated

 /**
 * The email address associated with the `WaitlistResource`.
 */
 emailAddress: string;
@dstaleydstaleyNov 21, 2025

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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
pkg-pr-newBot
commented
Nov 21, 2025•

edited

Loading

Copy link


Copy Markdown

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
@kduprey
kdupreyforce-pushed
the
kenton/user-4021-fix-typescript-return-type-for-clerkclient-waitlistentries
branch
from
578f72f to
5d52b88CompareNovember 21, 2025 20:52
@kdupreykduprey
changed the title
WIP: fix(backend,shared): Correct WaitlistEntryAPI list return typefix(backend): Correct WaitlistEntryAPI list return type and export WaitlistEntryNov 21, 2025
@kduprey
kduprey
requested a review
from dstaleyNovember 21, 2025 20:57
Kenton Duprey
fix(backend): Correct WaitlistEntryAPI list return type and export Wa…
dd3dd61
…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
kdupreyforce-pushed
the
kenton/user-4021-fix-typescript-return-type-for-clerkclient-waitlistentries
branch
from
5d52b88 to
dd3dd61CompareNovember 21, 2025 21:18
@kduprey
kduprey
merged commit 337430b
into
mainNov 21, 2025

44 of 46 checks passed

@kduprey
kduprey
deleted the

kenton/user-4021-fix-typescript-return-type-for-clerkclient-waitlistentries

branch
November 21, 2025 22:34
@clerk-cookieclerk-cookie
mentioned this pull request
Nov 21, 2025
 Merged

Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers

@dstaleydstaleydstaley approved these changes

Assignees

@kdupreykduprey

Labels

backenddo not merge

Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

3 participants

@kduprey@dstaley@clerk-cookie

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms");
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
fix(backend): Correct WaitlistEntryAPI list return type and export WaitlistEntry - #7280
Merged
kduprey merged 2 commits into
mainfrom 
kenton/user-4021-fix-typescript-return-type-for-clerkclient-waitlistentries
Nov 21, 2025
Merged
fix(backend): Correct WaitlistEntryAPI list return type and export WaitlistEntry#7280
kduprey merged 2 commits into
mainfrom 
kenton/user-4021-fix-typescript-return-type-for-clerkclient-waitlistentries
Conversation
@kduprey
@kdupreykduprey
commented
Nov 21, 2025•

edited by coderabbitai
Bot
Loading

Copy link


Copy Markdown

Contributor
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
  •  🐛 Bug fix
  •  🌟 New feature
  •  🔨 Breaking change
  •  📖 Refactoring / dependency upgrade / documentation
  •  other:
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.
@kduprey
kduprey
requested a review
from dstaleyNovember 21, 2025 03:35
@kdupreykduprey
self-assigned this
Nov 21, 2025
@changeset-bot
changeset-botBot
commented
Nov 21, 2025•

edited

Loading

Copy link


Copy Markdown

🦋 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
NameType
@clerk/backendMinor
@clerk/agent-toolkitPatch
@clerk/astroPatch
@clerk/expressPatch
@clerk/fastifyPatch
@clerk/nextjsPatch
@clerk/nuxtPatch
@clerk/react-routerPatch
@clerk/remixPatch
@clerk/tanstack-react-startPatch
@clerk/testingPatch
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
vercelBot
commented
Nov 21, 2025•

edited

Loading

Copy link


Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.
ProjectDeploymentPreviewCommentsUpdated (UTC)
clerk-js-sandboxReadyReadyPreviewCommentNov 21, 2025 10:18pm
@coderabbitai
coderabbitaiBot
commented
Nov 21, 2025•

edited

Loading

Copy link


Copy Markdown

Contributor
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 nameStatusExplanation
Description Check✅ PassedCheck skipped - CodeRabbit’s high-level summary is enabled.
Title check✅ PassedThe title clearly summarizes the main changes: correcting the WaitlistEntryAPI list return type and exporting the WaitlistEntry type.
Linked Issues check✅ PassedThe 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✅ PassedAll changes are directly related to the linked issue objectives: the changeset, API return type fix, and type exports are all within scope.
Docstring Coverage✅ PassedNo 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:
  1. 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.
  2. 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.
  3. 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.
@kdupreykduprey
changed the title
fix(backend,shared): Correct WaitlistEntryAPI list return typeWIP: fix(backend,shared): Correct WaitlistEntryAPI list return typeNov 21, 2025
dstaley
dstaley
reviewed
Nov 21, 2025
View reviewed changes
Comment threadpackages/shared/src/types/waitlist.ts
Outdated

 /**
 * The email address associated with the `WaitlistResource`.
 */
 emailAddress: string;
@dstaleydstaleyNov 21, 2025

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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
pkg-pr-newBot
commented
Nov 21, 2025•

edited

Loading

Copy link


Copy Markdown

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
@kduprey
kdupreyforce-pushed
the
kenton/user-4021-fix-typescript-return-type-for-clerkclient-waitlistentries
branch
from
578f72f to
5d52b88CompareNovember 21, 2025 20:52
@kdupreykduprey
changed the title
WIP: fix(backend,shared): Correct WaitlistEntryAPI list return typefix(backend): Correct WaitlistEntryAPI list return type and export WaitlistEntryNov 21, 2025
@kduprey
kduprey
requested a review
from dstaleyNovember 21, 2025 20:57
Kenton Duprey
fix(backend): Correct WaitlistEntryAPI list return type and export Wa…
dd3dd61
…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
kdupreyforce-pushed
the
kenton/user-4021-fix-typescript-return-type-for-clerkclient-waitlistentries
branch
from
5d52b88 to
dd3dd61CompareNovember 21, 2025 21:18
@kduprey
kduprey
merged commit 337430b
into
mainNov 21, 2025

44 of 46 checks passed

@kduprey
kduprey
deleted the

kenton/user-4021-fix-typescript-return-type-for-clerkclient-waitlistentries

branch
November 21, 2025 22:34
@clerk-cookieclerk-cookie
mentioned this pull request
Nov 21, 2025
 Merged

Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers

@dstaleydstaleydstaley approved these changes

Assignees

@kdupreykduprey

Labels

backenddo not merge

Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

3 participants

@kduprey@dstaley@clerk-cookie

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links");
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
fix(backend): Correct WaitlistEntryAPI list return type and export WaitlistEntry - #7280
Merged
kduprey merged 2 commits into
mainfrom 
kenton/user-4021-fix-typescript-return-type-for-clerkclient-waitlistentries
Nov 21, 2025
Merged
fix(backend): Correct WaitlistEntryAPI list return type and export WaitlistEntry#7280
kduprey merged 2 commits into
mainfrom 
kenton/user-4021-fix-typescript-return-type-for-clerkclient-waitlistentries
Conversation
@kduprey
@kdupreykduprey
commented
Nov 21, 2025•

edited by coderabbitai
Bot
Loading

Copy link


Copy Markdown

Contributor
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
  •  🐛 Bug fix
  •  🌟 New feature
  •  🔨 Breaking change
  •  📖 Refactoring / dependency upgrade / documentation
  •  other:
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.
@kduprey
kduprey
requested a review
from dstaleyNovember 21, 2025 03:35
@kdupreykduprey
self-assigned this
Nov 21, 2025
@changeset-bot
changeset-botBot
commented
Nov 21, 2025•

edited

Loading

Copy link


Copy Markdown

🦋 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
NameType
@clerk/backendMinor
@clerk/agent-toolkitPatch
@clerk/astroPatch
@clerk/expressPatch
@clerk/fastifyPatch
@clerk/nextjsPatch
@clerk/nuxtPatch
@clerk/react-routerPatch
@clerk/remixPatch
@clerk/tanstack-react-startPatch
@clerk/testingPatch
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
vercelBot
commented
Nov 21, 2025•

edited

Loading

Copy link


Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.
ProjectDeploymentPreviewCommentsUpdated (UTC)
clerk-js-sandboxReadyReadyPreviewCommentNov 21, 2025 10:18pm
@coderabbitai
coderabbitaiBot
commented
Nov 21, 2025•

edited

Loading

Copy link


Copy Markdown

Contributor
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 nameStatusExplanation
Description Check✅ PassedCheck skipped - CodeRabbit’s high-level summary is enabled.
Title check✅ PassedThe title clearly summarizes the main changes: correcting the WaitlistEntryAPI list return type and exporting the WaitlistEntry type.
Linked Issues check✅ PassedThe 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✅ PassedAll changes are directly related to the linked issue objectives: the changeset, API return type fix, and type exports are all within scope.
Docstring Coverage✅ PassedNo 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:
  1. 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.
  2. 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.
  3. 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.
@kdupreykduprey
changed the title
fix(backend,shared): Correct WaitlistEntryAPI list return typeWIP: fix(backend,shared): Correct WaitlistEntryAPI list return typeNov 21, 2025
dstaley
dstaley
reviewed
Nov 21, 2025
View reviewed changes
Comment threadpackages/shared/src/types/waitlist.ts
Outdated

 /**
 * The email address associated with the `WaitlistResource`.
 */
 emailAddress: string;
@dstaleydstaleyNov 21, 2025

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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
pkg-pr-newBot
commented
Nov 21, 2025•

edited

Loading

Copy link


Copy Markdown

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
@kduprey
kdupreyforce-pushed
the
kenton/user-4021-fix-typescript-return-type-for-clerkclient-waitlistentries
branch
from
578f72f to
5d52b88CompareNovember 21, 2025 20:52
@kdupreykduprey
changed the title
WIP: fix(backend,shared): Correct WaitlistEntryAPI list return typefix(backend): Correct WaitlistEntryAPI list return type and export WaitlistEntryNov 21, 2025
@kduprey
kduprey
requested a review
from dstaleyNovember 21, 2025 20:57
Kenton Duprey
fix(backend): Correct WaitlistEntryAPI list return type and export Wa…
dd3dd61
…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
kdupreyforce-pushed
the
kenton/user-4021-fix-typescript-return-type-for-clerkclient-waitlistentries
branch
from
5d52b88 to
dd3dd61CompareNovember 21, 2025 21:18
@kduprey
kduprey
merged commit 337430b
into
mainNov 21, 2025

44 of 46 checks passed

@kduprey
kduprey
deleted the

kenton/user-4021-fix-typescript-return-type-for-clerkclient-waitlistentries

branch
November 21, 2025 22:34
@clerk-cookieclerk-cookie
mentioned this pull request
Nov 21, 2025
 Merged

Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers

@dstaleydstaleydstaley approved these changes

Assignees

@kdupreykduprey

Labels

backenddo not merge

Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

3 participants

@kduprey@dstaley@clerk-cookie

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
fix(backend): Correct WaitlistEntryAPI list return type and export WaitlistEntry - #7280
Merged
kduprey merged 2 commits into
mainfrom 
kenton/user-4021-fix-typescript-return-type-for-clerkclient-waitlistentries
Nov 21, 2025
Merged
fix(backend): Correct WaitlistEntryAPI list return type and export WaitlistEntry#7280
kduprey merged 2 commits into
mainfrom 
kenton/user-4021-fix-typescript-return-type-for-clerkclient-waitlistentries
Conversation
@kduprey
@kdupreykduprey
commented
Nov 21, 2025•

edited by coderabbitai
Bot
Loading

Copy link


Copy Markdown

Contributor
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
  •  🐛 Bug fix
  •  🌟 New feature
  •  🔨 Breaking change
  •  📖 Refactoring / dependency upgrade / documentation
  •  other:
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.
@kduprey
kduprey
requested a review
from dstaleyNovember 21, 2025 03:35
@kdupreykduprey
self-assigned this
Nov 21, 2025
@changeset-bot
changeset-botBot
commented
Nov 21, 2025•

edited

Loading

Copy link


Copy Markdown

🦋 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
NameType
@clerk/backendMinor
@clerk/agent-toolkitPatch
@clerk/astroPatch
@clerk/expressPatch
@clerk/fastifyPatch
@clerk/nextjsPatch
@clerk/nuxtPatch
@clerk/react-routerPatch
@clerk/remixPatch
@clerk/tanstack-react-startPatch
@clerk/testingPatch
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
vercelBot
commented
Nov 21, 2025•

edited

Loading

Copy link


Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.
ProjectDeploymentPreviewCommentsUpdated (UTC)
clerk-js-sandboxReadyReadyPreviewCommentNov 21, 2025 10:18pm
@coderabbitai
coderabbitaiBot
commented
Nov 21, 2025•

edited

Loading

Copy link


Copy Markdown

Contributor
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 nameStatusExplanation
Description Check✅ PassedCheck skipped - CodeRabbit’s high-level summary is enabled.
Title check✅ PassedThe title clearly summarizes the main changes: correcting the WaitlistEntryAPI list return type and exporting the WaitlistEntry type.
Linked Issues check✅ PassedThe 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✅ PassedAll changes are directly related to the linked issue objectives: the changeset, API return type fix, and type exports are all within scope.
Docstring Coverage✅ PassedNo 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:
  1. 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.
  2. 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.
  3. 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.
@kdupreykduprey
changed the title
fix(backend,shared): Correct WaitlistEntryAPI list return typeWIP: fix(backend,shared): Correct WaitlistEntryAPI list return typeNov 21, 2025
dstaley
dstaley
reviewed
Nov 21, 2025
View reviewed changes
Comment threadpackages/shared/src/types/waitlist.ts
Outdated

 /**
 * The email address associated with the `WaitlistResource`.
 */
 emailAddress: string;
@dstaleydstaleyNov 21, 2025

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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
pkg-pr-newBot
commented
Nov 21, 2025•

edited

Loading

Copy link


Copy Markdown

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
@kduprey
kdupreyforce-pushed
the
kenton/user-4021-fix-typescript-return-type-for-clerkclient-waitlistentries
branch
from
578f72f to
5d52b88CompareNovember 21, 2025 20:52
@kdupreykduprey
changed the title
WIP: fix(backend,shared): Correct WaitlistEntryAPI list return typefix(backend): Correct WaitlistEntryAPI list return type and export WaitlistEntryNov 21, 2025
@kduprey
kduprey
requested a review
from dstaleyNovember 21, 2025 20:57
Kenton Duprey
fix(backend): Correct WaitlistEntryAPI list return type and export Wa…
dd3dd61
…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
kdupreyforce-pushed
the
kenton/user-4021-fix-typescript-return-type-for-clerkclient-waitlistentries
branch
from
5d52b88 to
dd3dd61CompareNovember 21, 2025 21:18
@kduprey
kduprey
merged commit 337430b
into
mainNov 21, 2025

44 of 46 checks passed

@kduprey
kduprey
deleted the

kenton/user-4021-fix-typescript-return-type-for-clerkclient-waitlistentries

branch
November 21, 2025 22:34
@clerk-cookieclerk-cookie
mentioned this pull request
Nov 21, 2025
 Merged

Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers

@dstaleydstaleydstaley approved these changes

Assignees

@kdupreykduprey

Labels

backenddo not merge

Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

3 participants

@kduprey@dstaley@clerk-cookie

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
fix(backend): Correct WaitlistEntryAPI list return type and export WaitlistEntry - #7280
Merged
kduprey merged 2 commits into
mainfrom 
kenton/user-4021-fix-typescript-return-type-for-clerkclient-waitlistentries
Nov 21, 2025
Merged
fix(backend): Correct WaitlistEntryAPI list return type and export WaitlistEntry#7280
kduprey merged 2 commits into
mainfrom 
kenton/user-4021-fix-typescript-return-type-for-clerkclient-waitlistentries
Conversation
@kduprey
@kdupreykduprey
commented
Nov 21, 2025•

edited by coderabbitai
Bot
Loading

Copy link


Copy Markdown

Contributor
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
  •  🐛 Bug fix
  •  🌟 New feature
  •  🔨 Breaking change
  •  📖 Refactoring / dependency upgrade / documentation
  •  other:
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.
@kduprey
kduprey
requested a review
from dstaleyNovember 21, 2025 03:35
@kdupreykduprey
self-assigned this
Nov 21, 2025
@changeset-bot
changeset-botBot
commented
Nov 21, 2025•

edited

Loading

Copy link


Copy Markdown

🦋 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
NameType
@clerk/backendMinor
@clerk/agent-toolkitPatch
@clerk/astroPatch
@clerk/expressPatch
@clerk/fastifyPatch
@clerk/nextjsPatch
@clerk/nuxtPatch
@clerk/react-routerPatch
@clerk/remixPatch
@clerk/tanstack-react-startPatch
@clerk/testingPatch
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
vercelBot
commented
Nov 21, 2025•

edited

Loading

Copy link


Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.
ProjectDeploymentPreviewCommentsUpdated (UTC)
clerk-js-sandboxReadyReadyPreviewCommentNov 21, 2025 10:18pm
@coderabbitai
coderabbitaiBot
commented
Nov 21, 2025•

edited

Loading

Copy link


Copy Markdown

Contributor
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 nameStatusExplanation
Description Check✅ PassedCheck skipped - CodeRabbit’s high-level summary is enabled.
Title check✅ PassedThe title clearly summarizes the main changes: correcting the WaitlistEntryAPI list return type and exporting the WaitlistEntry type.
Linked Issues check✅ PassedThe 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✅ PassedAll changes are directly related to the linked issue objectives: the changeset, API return type fix, and type exports are all within scope.
Docstring Coverage✅ PassedNo 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:
  1. 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.
  2. 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.
  3. 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.
@kdupreykduprey
changed the title
fix(backend,shared): Correct WaitlistEntryAPI list return typeWIP: fix(backend,shared): Correct WaitlistEntryAPI list return typeNov 21, 2025
dstaley
dstaley
reviewed
Nov 21, 2025
View reviewed changes
Comment threadpackages/shared/src/types/waitlist.ts
Outdated

 /**
 * The email address associated with the `WaitlistResource`.
 */
 emailAddress: string;
@dstaleydstaleyNov 21, 2025

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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
pkg-pr-newBot
commented
Nov 21, 2025•

edited

Loading

Copy link


Copy Markdown

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
@kduprey
kdupreyforce-pushed
the
kenton/user-4021-fix-typescript-return-type-for-clerkclient-waitlistentries
branch
from
578f72f to
5d52b88CompareNovember 21, 2025 20:52
@kdupreykduprey
changed the title
WIP: fix(backend,shared): Correct WaitlistEntryAPI list return typefix(backend): Correct WaitlistEntryAPI list return type and export WaitlistEntryNov 21, 2025
@kduprey
kduprey
requested a review
from dstaleyNovember 21, 2025 20:57
Kenton Duprey
fix(backend): Correct WaitlistEntryAPI list return type and export Wa…
dd3dd61
…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
kdupreyforce-pushed
the
kenton/user-4021-fix-typescript-return-type-for-clerkclient-waitlistentries
branch
from
5d52b88 to
dd3dd61CompareNovember 21, 2025 21:18
@kduprey
kduprey
merged commit 337430b
into
mainNov 21, 2025

44 of 46 checks passed

@kduprey
kduprey
deleted the

kenton/user-4021-fix-typescript-return-type-for-clerkclient-waitlistentries

branch
November 21, 2025 22:34
@clerk-cookieclerk-cookie
mentioned this pull request
Nov 21, 2025
 Merged

Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers

@dstaleydstaleydstaley approved these changes

Assignees

@kdupreykduprey

Labels

backenddo not merge

Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

3 participants

@kduprey@dstaley@clerk-cookie

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode");
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
fix(backend): Correct WaitlistEntryAPI list return type and export WaitlistEntry - #7280
Merged
kduprey merged 2 commits into
mainfrom 
kenton/user-4021-fix-typescript-return-type-for-clerkclient-waitlistentries
Nov 21, 2025
Merged
fix(backend): Correct WaitlistEntryAPI list return type and export WaitlistEntry#7280
kduprey merged 2 commits into
mainfrom 
kenton/user-4021-fix-typescript-return-type-for-clerkclient-waitlistentries
Conversation
@kduprey
@kdupreykduprey
commented
Nov 21, 2025•

edited by coderabbitai
Bot
Loading

Copy link


Copy Markdown

Contributor
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
  •  🐛 Bug fix
  •  🌟 New feature
  •  🔨 Breaking change
  •  📖 Refactoring / dependency upgrade / documentation
  •  other:
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.
@kduprey
kduprey
requested a review
from dstaleyNovember 21, 2025 03:35
@kdupreykduprey
self-assigned this
Nov 21, 2025
@changeset-bot
changeset-botBot
commented
Nov 21, 2025•

edited

Loading

Copy link


Copy Markdown

🦋 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
NameType
@clerk/backendMinor
@clerk/agent-toolkitPatch
@clerk/astroPatch
@clerk/expressPatch
@clerk/fastifyPatch
@clerk/nextjsPatch
@clerk/nuxtPatch
@clerk/react-routerPatch
@clerk/remixPatch
@clerk/tanstack-react-startPatch
@clerk/testingPatch
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
vercelBot
commented
Nov 21, 2025•

edited

Loading

Copy link


Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.
ProjectDeploymentPreviewCommentsUpdated (UTC)
clerk-js-sandboxReadyReadyPreviewCommentNov 21, 2025 10:18pm
@coderabbitai
coderabbitaiBot
commented
Nov 21, 2025•

edited

Loading

Copy link


Copy Markdown

Contributor
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 nameStatusExplanation
Description Check✅ PassedCheck skipped - CodeRabbit’s high-level summary is enabled.
Title check✅ PassedThe title clearly summarizes the main changes: correcting the WaitlistEntryAPI list return type and exporting the WaitlistEntry type.
Linked Issues check✅ PassedThe 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✅ PassedAll changes are directly related to the linked issue objectives: the changeset, API return type fix, and type exports are all within scope.
Docstring Coverage✅ PassedNo 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:
  1. 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.
  2. 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.
  3. 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.
@kdupreykduprey
changed the title
fix(backend,shared): Correct WaitlistEntryAPI list return typeWIP: fix(backend,shared): Correct WaitlistEntryAPI list return typeNov 21, 2025
dstaley
dstaley
reviewed
Nov 21, 2025
View reviewed changes
Comment threadpackages/shared/src/types/waitlist.ts
Outdated

 /**
 * The email address associated with the `WaitlistResource`.
 */
 emailAddress: string;
@dstaleydstaleyNov 21, 2025

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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
pkg-pr-newBot
commented
Nov 21, 2025•

edited

Loading

Copy link


Copy Markdown

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
@kduprey
kdupreyforce-pushed
the
kenton/user-4021-fix-typescript-return-type-for-clerkclient-waitlistentries
branch
from
578f72f to
5d52b88CompareNovember 21, 2025 20:52
@kdupreykduprey
changed the title
WIP: fix(backend,shared): Correct WaitlistEntryAPI list return typefix(backend): Correct WaitlistEntryAPI list return type and export WaitlistEntryNov 21, 2025
@kduprey
kduprey
requested a review
from dstaleyNovember 21, 2025 20:57
Kenton Duprey
fix(backend): Correct WaitlistEntryAPI list return type and export Wa…
dd3dd61
…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
kdupreyforce-pushed
the
kenton/user-4021-fix-typescript-return-type-for-clerkclient-waitlistentries
branch
from
5d52b88 to
dd3dd61CompareNovember 21, 2025 21:18
@kduprey
kduprey
merged commit 337430b
into
mainNov 21, 2025

44 of 46 checks passed

@kduprey
kduprey
deleted the

kenton/user-4021-fix-typescript-return-type-for-clerkclient-waitlistentries

branch
November 21, 2025 22:34
@clerk-cookieclerk-cookie
mentioned this pull request
Nov 21, 2025
 Merged

Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers

@dstaleydstaleydstaley approved these changes

Assignees

@kdupreykduprey

Labels

backenddo not merge

Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

3 participants

@kduprey@dstaley@clerk-cookie