Skip to content

Conversation

@wobsoriano
Copy link
Member

@wobsoriano wobsoriano commented Nov 12, 2025

Description

The type parameter is for internal use (right now we use it for API keys and M2M tokens) and doesn't need to be exposed.

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

  • Refactor
    • Simplified API key creation interface by removing the type parameter
    • Updated default API keys pagination from 5 to 10 items per page
    • Removed type-based filtering option for API keys

@changeset-bot
Copy link

changeset-bot bot commented Nov 12, 2025

🦋 Changeset detected

Latest commit: de3dee8

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

This PR includes changesets to release 22 packages
Name Type
@clerk/backend Minor
@clerk/clerk-js Minor
@clerk/shared 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
@clerk/chrome-extension Patch
@clerk/clerk-expo Patch
@clerk/elements Patch
@clerk/expo-passkeys Patch
@clerk/clerk-react Patch
@clerk/themes Patch
@clerk/types Patch
@clerk/vue Patch
@clerk/localizations 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
Copy link

vercel bot commented Nov 12, 2025

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

Project Deployment Preview Comments Updated (UTC)
clerk-js-sandbox Ready Ready Preview Comment Nov 12, 2025 5:17pm

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Nov 12, 2025

Walkthrough

A changeset file was added documenting version bumps for @clerk/backend and @clerk/clerk-js (minor), and @clerk/shared (patch). The optional type?: 'api_key' parameter was removed from API key creation across multiple files, and its value is now hardcoded. The API Keys component default page size increased from 5 to 10.

Changes

Cohort / File(s) Summary
Release documentation
.changeset/fifty-elephants-judge.md
Added changeset documenting version bumps and internal API key type parameter removal.
Type definitions
packages/backend/src/api/endpoints/APIKeysApi.ts, packages/shared/src/types/clerk.ts
Removed optional type?: 'api_key' field from CreateAPIKeyParams. Removed type?: 'api_key' from APIKeysProps. Updated APIKeysProps page size default from 5 to 10.
Implementation
packages/clerk-js/src/core/modules/apiKeys/index.ts
Modified APIKeys.create to always set type to 'api_key' in request payload, removing parameter override capability.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

  • Consistent removal pattern applied across all affected files
  • Type parameter now hardcoded rather than optional
  • Single default value update (perPage)

Poem

🐰✨ The type parameter hops away so free,
API keys now know their destiny,
Always 'api_key', no more disguise,
Simplicity in every try,
Ten pages shown instead of five, I see! 🎉

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and accurately summarizes the main change: removing an internal parameter (type?: 'api_key') from API keys creation across the codebase.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
✨ Finishing touches
  • 📝 Generate docstrings
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch rob/api-keys-remove-type

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

@wobsoriano wobsoriano changed the title chore(clerk-js): Remove internal API keys creation parameter chore(clerk-js,backend): Remove internal API keys creation parameter Nov 12, 2025
@pkg-pr-new
Copy link

pkg-pr-new bot commented Nov 12, 2025

Open in StackBlitz

@clerk/agent-toolkit

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

@clerk/astro

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

@clerk/backend

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

@clerk/chrome-extension

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

@clerk/clerk-js

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

@clerk/dev-cli

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

@clerk/elements

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

@clerk/clerk-expo

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

@clerk/expo-passkeys

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

@clerk/express

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

@clerk/fastify

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

@clerk/localizations

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

@clerk/nextjs

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

@clerk/nuxt

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

@clerk/clerk-react

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

@clerk/react-router

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

@clerk/remix

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

@clerk/shared

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

@clerk/tanstack-react-start

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

@clerk/testing

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

@clerk/themes

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

@clerk/types

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

@clerk/upgrade

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

@clerk/vue

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

commit: de3dee8

@wobsoriano wobsoriano merged commit b944ff3 into main Nov 12, 2025
47 checks passed
@wobsoriano wobsoriano deleted the rob/api-keys-remove-type branch November 12, 2025 17:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants