feat(backend): add orderBy support to InvitationAPI.getInvitationList

[mario-jerkovic]

Description

• Add orderBy to InvitationAPI.getInvitationList to control sorting direction and field to follow semantics of REST api

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

• New Features

  • Invitation listings can now be sorted by creation date, email address, or expiration date. Use a leading '+' (or no sign) for ascending and '-' for descending.

• Chores

  • Patch-level update recorded for the backend invitation API.

[changeset-bot]

🦋 Changeset detected

Latest commit: 3831714

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

This PR includes changesets to release 11 packages

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

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

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

[vercel]

@mario-jerkovic is attempting to deploy a commit to the Clerk Production Team on Vercel.

A member of the Team first needs to authorize it.

[coderabbitai]

Walkthrough

A patch-level update adds an optional orderBy parameter to GetInvitationListParams, allowing sorting by created_at, email_address, or expires_at with ascending/descending control via leading + or -. Also includes a changeset entry and updated JSDoc.

Changes

Cohort / File(s)	Summary
Changeset documentation .changeset/nasty-insects-follow.md	Patch-level changeset entry noting getInvitationList now accepts an orderBy argument with +/- prefix support for sort direction.
Invitation API update packages/backend/src/api/endpoints/InvitationApi.ts	Imported WithSign type and added optional orderBy to GetInvitationListParams with JSDoc listing supported fields (created_at, email_address, expires_at), examples, and prefix semantics (- descending, +/no sign ascending).

Sequence Diagram(s)

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

• Check WithSign type usage and consistency with prefix semantics.
• Verify JSDoc examples match implemented parsing/validation.
• Ensure omission of orderBy preserves existing default sort behavior.

Poem

🐰 I hopped through lines of code today,
Added a sort to make invites play,
Plus or minus sets the way,
Neat lists march—hip hip hooray! 🥕

Pre-merge checks and finishing touches

✅ Passed checks (2 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The PR title accurately describes the main change: adding orderBy support to InvitationAPI.getInvitationList, which is directly confirmed by the raw summary showing the new optional orderBy parameter addition.

✨ Finishing touches

• 📝 Generate docstrings

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment

---

📜 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 3633652 and 3831714.

📒 Files selected for processing (1)

• packages/backend/src/api/endpoints/InvitationApi.ts (2 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

• packages/backend/src/api/endpoints/InvitationApi.ts

⏰ 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). (2)

• GitHub Check: semgrep-cloud-platform/scan
• GitHub Check: semgrep-cloud-platform/scan

---

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

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

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

[coderabbitai]

Actionable comments posted: 1

📜 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 d9d0e88 and 3633652.

📒 Files selected for processing (2)

• .changeset/nasty-insects-follow.md (1 hunks)
• packages/backend/src/api/endpoints/InvitationApi.ts (2 hunks)

🧰 Additional context used

📓 Path-based instructions (7)

**/*.{js,jsx,ts,tsx}

📄 CodeRabbit inference engine (.cursor/rules/development.mdc)

**/*.{js,jsx,ts,tsx}: All code must pass ESLint checks with the project's configuration
Follow established naming conventions (PascalCase for components, camelCase for variables)
Maintain comprehensive JSDoc comments for public APIs
Use dynamic imports for optional features
All public APIs must be documented with JSDoc
Provide meaningful error messages to developers
Include error recovery suggestions where applicable
Log errors appropriately for debugging
Lazy load components and features when possible
Implement proper caching strategies
Use efficient data structures and algorithms
Profile and optimize critical paths
Validate all inputs and sanitize outputs
Implement proper logging with different levels

Files:

• packages/backend/src/api/endpoints/InvitationApi.ts

**/*.{js,jsx,ts,tsx,json,css,scss,md,yaml,yml}

📄 CodeRabbit inference engine (.cursor/rules/development.mdc)

Use Prettier for consistent code formatting

Files:

• packages/backend/src/api/endpoints/InvitationApi.ts

packages/**/*.{ts,tsx}

📄 CodeRabbit inference engine (.cursor/rules/development.mdc)

TypeScript is required for all packages

Files:

• packages/backend/src/api/endpoints/InvitationApi.ts

packages/**/*.{ts,tsx,d.ts}

📄 CodeRabbit inference engine (.cursor/rules/development.mdc)

Packages should export TypeScript types alongside runtime code

Files:

• packages/backend/src/api/endpoints/InvitationApi.ts

**/*.{ts,tsx}

📄 CodeRabbit inference engine (.cursor/rules/development.mdc)

Use proper TypeScript error types

**/*.{ts,tsx}: Always define explicit return types for functions, especially public APIs
Use proper type annotations for variables and parameters where inference isn't clear
Avoid any type - prefer unknown when type is uncertain, then narrow with type guards
Use interface for object shapes that might be extended
Use type for unions, primitives, and computed types
Prefer readonly properties for immutable data structures
Use private for internal implementation details
Use protected for inheritance hierarchies
Use public explicitly for clarity in public APIs
Prefer readonly for properties that shouldn't change after construction
Prefer composition and interfaces over deep inheritance chains
Use mixins for shared behavior across unrelated classes
Implement dependency injection for loose coupling
Let TypeScript infer when types are obvious
Use const assertions for literal types: as const
Use satisfies operator for type checking without widening
Use mapped types for transforming object types
Use conditional types for type-level logic
Leverage template literal types for string manipulation
Use ES6 imports/exports consistently
Use default exports sparingly, prefer named exports
Use type-only imports: import type { ... } from ...
No any types without justification
Proper error handling with typed errors
Consistent use of readonly for immutable data
Proper generic constraints
No unused type parameters
Proper use of utility types instead of manual type construction
Type-only imports where possible
Proper tree-shaking friendly exports
No circular dependencies
Efficient type computations (avoid deep recursion)

Files:

• packages/backend/src/api/endpoints/InvitationApi.ts

**/*.{js,ts,tsx,jsx}

📄 CodeRabbit inference engine (.cursor/rules/monorepo.mdc)

Support multiple Clerk environment variables (CLERK_, NEXT_PUBLIC_CLERK_, etc.) for configuration.

Files:

• packages/backend/src/api/endpoints/InvitationApi.ts

.changeset/**

📄 CodeRabbit inference engine (.cursor/rules/monorepo.mdc)

Automated releases must use Changesets.

Files:

• .changeset/nasty-insects-follow.md

⏰ 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). (2)

• GitHub Check: semgrep-cloud-platform/scan
• GitHub Check: semgrep-cloud-platform/scan

🔇 Additional comments (3)

packages/backend/src/api/endpoints/InvitationApi.ts (2)

8-8: LGTM! Type-only import correctly used.

The import statement properly uses import type syntax for the WithSign utility type, which aligns with the coding guidelines for type-only imports.

---

74-80: LGTM! Implementation correctly handles the new parameter.

The method implementation properly passes the new optional orderBy parameter through to the request as a query parameter, maintaining consistency with the existing pattern. The change is backward compatible since the parameter is optional.

.changeset/nasty-insects-follow.md (1)

1-5: LGTM! Changeset correctly documents the feature.

The changeset follows the standard format, correctly marks this as a patch-level change (appropriate for adding an optional parameter), and provides a clear description of the new orderBy functionality.