Skip to content

Conversation

@kduprey
Copy link
Contributor

@kduprey kduprey commented Sep 29, 2025

Description

  • Adding status = 'accepted'; to OrganizationInvitationAcceptedJSON for clarity and stronger types
  • Changeset included in PR-6887

USER-3577

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

    • Invitation acceptance responses now include a required status value of "accepted," removing ambiguity for integrators and ensuring consistent downstream handling.
  • Chores

    • Updated public API typings to reflect the required status field; type-checked integrations may need minor updates.
    • Added a metadata changeset file (non-functional) for release tracking.

@kduprey kduprey requested a review from tmilewski September 29, 2025 23:53
@kduprey kduprey self-assigned this Sep 29, 2025
Copilot AI review requested due to automatic review settings September 29, 2025 23:53
@changeset-bot
Copy link

changeset-bot bot commented Sep 29, 2025

🦋 Changeset detected

Latest commit: ff9cbe0

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

This PR includes changesets to release 0 packages

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

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

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Sep 29, 2025

Walkthrough

Adds a required literal property status: 'accepted' to OrganizationInvitationAcceptedJSON in the API JSON interfaces and adds a new empty changeset file (two lines of ---).

Changes

Cohort / File(s) Summary
API JSON interfaces
packages/backend/src/api/resources/JSON.ts
Updated exported interface OrganizationInvitationAcceptedJSON to include a required property status: 'accepted', while still extending OrganizationInvitationJSON.
Changeset metadata
.changeset/sharp-parents-vanish.md
Added a new changeset file containing two lines with --- and no code changes.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

I twitch my whiskers, stamp approval bright,
A status set to "accepted"—typed just right.
Hops through the types, tidy and neat,
No more unsure paths beneath our feet.
Carrot cheers! 🥕 The invite's complete.

Pre-merge checks and finishing touches

❌ Failed checks (2 warnings)
Check name Status Explanation Resolution
Linked Issues Check ⚠️ Warning The linked issue USER-3577 calls for updating the OrganizationInvitationJSON interface to include a user_id field on accepted invitations, but the changeset only adds a status property and does not introduce a user_id field, so it fails to meet the specified issue requirements. Add the missing user_id property to the OrganizationInvitationAcceptedJSON interface as required by USER-3577 or adjust the linked issue to reflect the actual changes being implemented.
Out of Scope Changes Check ⚠️ Warning The pull request introduces changes unrelated to the linked issue, including adding a status field that was not requested by USER-3577 and an extraneous changeset file containing only delimiter lines, which are outside the scope of updating the interface to include a user_id field. Remove or relocate the unrelated status addition and the placeholder changeset file from this PR or clearly justify these modifications in the linked issue to align the pull request with its intended scope.
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title Check ✅ Passed The title succinctly describes the primary change by specifying that the status field is being added to the OrganizationInvitationAcceptedJSON interface, matching the core code modification in the pull request.
Docstring Coverage ✅ Passed No functions found in the changes. Docstring coverage check skipped.
✨ Finishing touches
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch kenton/user-3577-update-organizationinvitationjson-interface-to-include

📜 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 189c37e and ff9cbe0.

📒 Files selected for processing (1)
  • .changeset/sharp-parents-vanish.md (1 hunks)
✅ Files skipped from review due to trivial changes (1)
  • .changeset/sharp-parents-vanish.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). (6)
  • GitHub Check: Build Packages
  • GitHub Check: Formatting | Dedupe | Changeset
  • GitHub Check: semgrep/ci
  • GitHub Check: Analyze (javascript-typescript)
  • GitHub Check: semgrep-cloud-platform/scan
  • GitHub Check: semgrep-cloud-platform/scan

Warning

Review ran into problems

🔥 Problems

Errors were encountered while retrieving linked issues.

Errors (1)
  • PR-6887: Entity not found: Issue - Could not find referenced Issue.

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

@vercel
Copy link

vercel bot commented Sep 29, 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 Sep 29, 2025 11:57pm

Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR fixes the OrganizationInvitationAcceptedJSON interface by adding a required status field with a literal type of 'accepted'. This provides stronger type safety and clarity by explicitly requiring that accepted invitations have their status field set to the expected value.

  • Adds status: 'accepted' field to the OrganizationInvitationAcceptedJSON interface

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

@pkg-pr-new
Copy link

pkg-pr-new bot commented Sep 30, 2025

Open in StackBlitz

@clerk/agent-toolkit

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

@clerk/astro

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

@clerk/backend

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

@clerk/chrome-extension

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

@clerk/clerk-js

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

@clerk/dev-cli

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

@clerk/elements

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

@clerk/clerk-expo

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

@clerk/expo-passkeys

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

@clerk/express

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

@clerk/fastify

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

@clerk/localizations

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

@clerk/nextjs

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

@clerk/nuxt

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

@clerk/clerk-react

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

@clerk/react-router

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

@clerk/remix

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

@clerk/shared

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

@clerk/tanstack-react-start

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

@clerk/testing

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

@clerk/themes

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

@clerk/types

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

@clerk/upgrade

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

@clerk/vue

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

commit: ff9cbe0

@kduprey kduprey merged commit 85f8b27 into main Sep 30, 2025
71 of 72 checks passed
@kduprey kduprey deleted the kenton/user-3577-update-organizationinvitationjson-interface-to-include branch September 30, 2025 00:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants