chore(shared): Add experimental JSDoc for `org.getSubscriptions` #6318

panteliselef · 2025-07-15T12:59:03Z

Description

Checklist

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

Type of change

Summary by CodeRabbit

Documentation
- Added experimental JSDoc annotations to indicate that certain billing-related subscription APIs are in public beta and subject to change. No changes to functionality or behavior.

changeset-bot · 2025-07-15T12:59:07Z

🦋 Changeset detected

Latest commit: f30f478

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

This PR includes changesets to release 22 packages

Name	Type
@clerk/shared	Patch
@clerk/types	Patch
@clerk/agent-toolkit	Patch
@clerk/astro	Patch
@clerk/backend	Patch
@clerk/chrome-extension	Patch
@clerk/clerk-js	Patch
@clerk/elements	Patch
@clerk/expo-passkeys	Patch
@clerk/clerk-expo	Patch
@clerk/express	Patch
@clerk/fastify	Patch
@clerk/nextjs	Patch
@clerk/nuxt	Patch
@clerk/react-router	Patch
@clerk/clerk-react	Patch
@clerk/remix	Patch
@clerk/tanstack-react-start	Patch
@clerk/testing	Patch
@clerk/vue	Patch
@clerk/localizations	Patch
@clerk/themes	Patch

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

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

vercel · 2025-07-15T12:59:07Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
clerk-js-sandbox	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jul 15, 2025 8:32pm

coderabbitai · 2025-07-15T13:01:22Z

📝 Walkthrough

Walkthrough

This change adds experimental JSDoc annotations to the subscriptions property in TypeScript types and the getSubscriptions method within the billing beta feature. The updates are limited to documentation and do not alter any code logic or method signatures. The @experimental tags indicate that these APIs are part of a public beta for billing features and may change in the future. No functional changes or modifications to exported/public entity declarations were made beyond the addition of these documentation comments.

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Explain this complex logic.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai explain this code block.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and explain its main purpose.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

coderabbitai

Actionable comments posted: 0

🧹 Nitpick comments (1)

packages/types/src/organization.ts (1)
59-62: Consider enriching the JSDoc with @param and @returns tags

Nice call-out with @experimental. To make the comment complete and consistent with our guidelines (“Document public functions and APIs with JSDoc-style comments including @param, @returns…”), add parameter and return-value descriptions:
   /**
    * @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change.
+   * @param [params] Pagination/filter options (see `GetSubscriptionsParams`)
+   * @returns A paginated list of the organization’s subscriptions
    */

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between fd811c5 and 4b3d1e0.

📒 Files selected for processing (3)

.changeset/happy-apes-open.md (1 hunks)
packages/shared/src/react/hooks/useOrganization.tsx (2 hunks)
packages/types/src/organization.ts (1 hunks)

🧰 Additional context used

📓 Path-based instructions (8)

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

Instructions used from:

Sources:
📄 CodeRabbit Inference Engine

.cursor/rules/development.mdc

packages/**/*.ts

Instructions used from:

Sources:
📄 CodeRabbit Inference Engine

.cursor/rules/development.mdc

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

Instructions used from:

Sources:
📄 CodeRabbit Inference Engine

.cursor/rules/development.mdc

**/*.{ts,tsx}

Instructions used from:

Sources:
📄 CodeRabbit Inference Engine

.cursor/rules/development.mdc
.cursor/rules/typescript.mdc

**/*

Instructions used from:

Sources:
⚙️ CodeRabbit Configuration File

**/*.{tsx,jsx}

Instructions used from:

Sources:
📄 CodeRabbit Inference Engine

.cursor/rules/development.mdc

**/*.{jsx,tsx}

Instructions used from:

Sources:
📄 CodeRabbit Inference Engine

.cursor/rules/react.mdc

**/*.tsx

Instructions used from:

Sources:
📄 CodeRabbit Inference Engine

.cursor/rules/react.mdc

🧠 Learnings (4)

📓 Common learnings

Learnt from: dstaley
PR: clerk/javascript#6116
File: .changeset/tangy-garlics-say.md:1-2
Timestamp: 2025-06-13T16:09:53.061Z
Learning: In the Clerk JavaScript repository, contributors create intentionally empty changeset files (containing only the YAML delimiters) when a PR touches only non-published parts of the codebase (e.g., sandbox assets). This signals that no package release is required, so such changesets should not be flagged as missing content.

Learnt from: panteliselef
PR: clerk/javascript#6285
File: packages/types/src/commerce.ts:1305-1305
Timestamp: 2025-07-11T18:08:14.697Z
Learning: In the Clerk JavaScript repository, when there's a conflict between naming consistency (camelCase) and avoiding breaking changes, the team prioritizes maintaining backward compatibility over enforcing naming conventions, even for experimental APIs.

Learnt from: wobsoriano
PR: clerk/javascript#6229
File: packages/backend/src/api/endpoints/MachineTokensApi.ts:47-89
Timestamp: 2025-07-01T15:20:41.834Z
Learning: In the Clerk JavaScript repository, for the MachineTokensApi class (packages/backend/src/api/endpoints/MachineTokensApi.ts), the maintainers prefer to rely on TypeScript types and readable property names for API documentation rather than JSDoc comments.

Learnt from: CR
PR: clerk/javascript#0
File: .cursor/rules/development.mdc:0-0
Timestamp: 2025-06-30T10:29:42.997Z
Learning: Applies to **/*.{js,jsx,ts,tsx} : Maintain comprehensive JSDoc comments for public APIs

Learnt from: CR
PR: clerk/javascript#0
File: .cursor/rules/typescript.mdc:0-0
Timestamp: 2025-06-30T10:33:45.961Z
Learning: Applies to **/*.{ts,tsx} : Document public functions and APIs with JSDoc-style comments including @param, @returns, @throws, and @example

Learnt from: CR
PR: clerk/javascript#0
File: .cursor/rules/react.mdc:0-0
Timestamp: 2025-06-30T10:32:37.848Z
Learning: Applies to **/*.{jsx,tsx} : Implement proper subscription cleanup

Learnt from: CR
PR: clerk/javascript#0
File: .cursor/rules/development.mdc:0-0
Timestamp: 2025-06-30T10:29:42.997Z
Learning: Update documentation for API changes

Learnt from: CR
PR: clerk/javascript#0
File: .cursor/rules/development.mdc:0-0
Timestamp: 2025-06-30T10:29:42.997Z
Learning: Applies to **/*.{js,jsx,ts,tsx} : All public APIs must be documented with JSDoc

packages/types/src/organization.ts (4)

Learnt from: CR
PR: clerk/javascript#0
File: .cursor/rules/development.mdc:0-0
Timestamp: 2025-06-30T10:29:42.997Z
Learning: Applies to **/*.{js,jsx,ts,tsx} : Maintain comprehensive JSDoc comments for public APIs

Learnt from: CR
PR: clerk/javascript#0
File: .cursor/rules/typescript.mdc:0-0
Timestamp: 2025-06-30T10:33:45.961Z
Learning: Applies to **/*.{ts,tsx} : Document public functions and APIs with JSDoc-style comments including @param, @returns, @throws, and @example

Learnt from: wobsoriano
PR: clerk/javascript#6229
File: packages/backend/src/api/endpoints/MachineTokensApi.ts:47-89
Timestamp: 2025-07-01T15:20:41.834Z
Learning: In the Clerk JavaScript repository, for the MachineTokensApi class (packages/backend/src/api/endpoints/MachineTokensApi.ts), the maintainers prefer to rely on TypeScript types and readable property names for API documentation rather than JSDoc comments.

Learnt from: CR
PR: clerk/javascript#0
File: .cursor/rules/development.mdc:0-0
Timestamp: 2025-06-30T10:29:42.997Z
Learning: Update documentation for API changes

.changeset/happy-apes-open.md (8)

Learnt from: wobsoriano
PR: clerk/javascript#6229
File: packages/backend/src/api/endpoints/MachineTokensApi.ts:47-89
Timestamp: 2025-07-01T15:20:41.834Z
Learning: In the Clerk JavaScript repository, for the MachineTokensApi class (packages/backend/src/api/endpoints/MachineTokensApi.ts), the maintainers prefer to rely on TypeScript types and readable property names for API documentation rather than JSDoc comments.

Learnt from: CR
PR: clerk/javascript#0
File: .cursor/rules/development.mdc:0-0
Timestamp: 2025-06-30T10:29:42.997Z
Learning: Applies to **/*.{js,jsx,ts,tsx} : Maintain comprehensive JSDoc comments for public APIs

Learnt from: CR
PR: clerk/javascript#0
File: .cursor/rules/development.mdc:0-0
Timestamp: 2025-06-30T10:29:42.997Z
Learning: Update documentation for API changes

Learnt from: dstaley
PR: clerk/javascript#6116
File: .changeset/tangy-garlics-say.md:1-2
Timestamp: 2025-06-13T16:09:53.061Z
Learning: In the Clerk JavaScript repository, contributors create intentionally empty changeset files (containing only the YAML delimiters) when a PR touches only non-published parts of the codebase (e.g., sandbox assets). This signals that no package release is required, so such changesets should not be flagged as missing content.

Learnt from: CR
PR: clerk/javascript#0
File: .cursor/rules/typescript.mdc:0-0
Timestamp: 2025-06-30T10:33:45.961Z
Learning: Applies to **/*.{ts,tsx} : Document public functions and APIs with JSDoc-style comments including @param, @returns, @throws, and @example

Learnt from: panteliselef
PR: clerk/javascript#6285
File: packages/types/src/commerce.ts:1305-1305
Timestamp: 2025-07-11T18:08:14.697Z
Learning: In the Clerk JavaScript repository, when there's a conflict between naming consistency (camelCase) and avoiding breaking changes, the team prioritizes maintaining backward compatibility over enforcing naming conventions, even for experimental APIs.

Learnt from: CR
PR: clerk/javascript#0
File: .cursor/rules/development.mdc:0-0
Timestamp: 2025-06-30T10:29:42.997Z
Learning: Applies to **/*.{js,jsx,ts,tsx} : All public APIs must be documented with JSDoc

Learnt from: CR
PR: clerk/javascript#0
File: .cursor/rules/react.mdc:0-0
Timestamp: 2025-06-30T10:32:37.848Z
Learning: Applies to **/*.{jsx,tsx} : Implement proper subscription cleanup

packages/shared/src/react/hooks/useOrganization.tsx (10)

Learnt from: CR
PR: clerk/javascript#0
File: .cursor/rules/typescript.mdc:0-0
Timestamp: 2025-06-30T10:33:45.961Z
Learning: Applies to **/*.{ts,tsx} : Document public functions and APIs with JSDoc-style comments including @param, @returns, @throws, and @example

Learnt from: CR
PR: clerk/javascript#0
File: .cursor/rules/development.mdc:0-0
Timestamp: 2025-06-30T10:29:42.997Z
Learning: Applies to **/*.{js,jsx,ts,tsx} : Maintain comprehensive JSDoc comments for public APIs

Learnt from: CR
PR: clerk/javascript#0
File: .cursor/rules/react.mdc:0-0
Timestamp: 2025-06-30T10:32:37.848Z
Learning: Applies to **/*.{jsx,tsx} : Implement proper subscription cleanup

Learnt from: CR
PR: clerk/javascript#0
File: .cursor/rules/react.mdc:0-0
Timestamp: 2025-06-30T10:32:37.848Z
Learning: Applies to **/*.{jsx,tsx} : Use proper hook structure

Learnt from: CR
PR: clerk/javascript#0
File: .cursor/rules/react.mdc:0-0
Timestamp: 2025-06-30T10:32:37.848Z
Learning: Applies to **/*.tsx : Use proper type definitions for props and state

Learnt from: CR
PR: clerk/javascript#0
File: .cursor/rules/typescript.mdc:0-0
Timestamp: 2025-06-30T10:33:45.961Z
Learning: Applies to **/*.{ts,tsx} : Use `public` explicitly for clarity in public APIs

Learnt from: CR
PR: clerk/javascript#0
File: .cursor/rules/development.mdc:0-0
Timestamp: 2025-06-30T10:29:42.997Z
Learning: Applies to **/*.{js,jsx,ts,tsx} : All public APIs must be documented with JSDoc

Learnt from: CR
PR: clerk/javascript#0
File: .cursor/rules/development.mdc:0-0
Timestamp: 2025-06-30T10:29:42.997Z
Learning: Update documentation for API changes

Learnt from: CR
PR: clerk/javascript#0
File: .cursor/rules/typescript.mdc:0-0
Timestamp: 2025-06-30T10:33:45.961Z
Learning: Applies to **/*.{ts,tsx} : Use proper type annotations for variables and parameters where inference isn't clear

Learnt from: CR
PR: clerk/javascript#0
File: .cursor/rules/react.mdc:0-0
Timestamp: 2025-06-30T10:32:37.848Z
Learning: Applies to **/*.tsx : Use proper event types for handlers

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

GitHub Check: semgrep-cloud-platform/scan
GitHub Check: Build Packages
GitHub Check: Formatting | Dedupe | Changeset
GitHub Check: semgrep/ci
GitHub Check: Analyze (javascript-typescript)

🔇 Additional comments (3)

packages/shared/src/react/hooks/useOrganization.tsx (2)

70-78: Good addition – experimental status clearly flagged

The extra JSDoc aligns with the types file and keeps consumers informed that this hook field may change.
No further action needed.

115-118: Duplicate JSDoc block looks fine

Duplicating the @experimental note in the return-type union is helpful for IntelliSense; it does not bloat the bundle.

.changeset/happy-apes-open.md (1)

1-6: Changeset LGTM

The patch bumps for @clerk/shared and @clerk/types correctly reflect a docs-only change.

pkg-pr-new · 2025-07-15T13:08:02Z

Open in StackBlitz

@clerk/agent-toolkit

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

@clerk/astro

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

@clerk/backend

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

@clerk/chrome-extension

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

@clerk/clerk-js

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

@clerk/dev-cli

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

@clerk/elements

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

@clerk/clerk-expo

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

@clerk/expo-passkeys

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

@clerk/express

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

@clerk/fastify

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

@clerk/localizations

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

@clerk/nextjs

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

@clerk/nuxt

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

@clerk/clerk-react

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

@clerk/react-router

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

@clerk/remix

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

@clerk/shared

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

@clerk/tanstack-react-start

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

@clerk/testing

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

@clerk/themes

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

@clerk/types

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

@clerk/upgrade

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

@clerk/vue

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

commit: f30f478

chore(shared): Add experimental JSDoc for org.getSubscriptions

4b3d1e0

panteliselef requested a review from aeliox July 15, 2025 12:59

clerk-cookie added the types label Jul 15, 2025

vercel bot deployed to Preview July 15, 2025 13:00 View deployment

coderabbitai bot reviewed Jul 15, 2025

View reviewed changes

Merge branch 'main' into elef/handle-subscriptions-from-use-org

e5dd096

vercel bot deployed to Preview July 15, 2025 13:03 View deployment

tmilewski approved these changes Jul 15, 2025

View reviewed changes

panteliselef enabled auto-merge (squash) July 15, 2025 13:49

anagstef approved these changes Jul 15, 2025

View reviewed changes

nikosdouvlis approved these changes Jul 15, 2025

View reviewed changes

Merge branch 'main' into elef/handle-subscriptions-from-use-org

9bfb121

vercel bot deployed to Preview July 15, 2025 15:40 View deployment

aeliox approved these changes Jul 15, 2025

View reviewed changes

Merge branch 'main' into elef/handle-subscriptions-from-use-org

7196fe2

vercel bot deployed to Preview July 15, 2025 19:09 View deployment

Merge branch 'main' into elef/handle-subscriptions-from-use-org

f30f478

vercel bot deployed to Preview July 15, 2025 20:32 View deployment

panteliselef merged commit 8ee859c into main Jul 15, 2025
36 checks passed

panteliselef deleted the elef/handle-subscriptions-from-use-org branch July 15, 2025 20:44

clerk-cookie mentioned this pull request Jul 15, 2025

ci(repo): Version packages #6321

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

chore(shared): Add experimental JSDoc for `org.getSubscriptions` #6318

chore(shared): Add experimental JSDoc for `org.getSubscriptions` #6318

Uh oh!

panteliselef commented Jul 15, 2025 •

edited by l-armstrong

Loading

Uh oh!

changeset-bot bot commented Jul 15, 2025 •

edited

Loading

Uh oh!

vercel bot commented Jul 15, 2025 •

edited

Loading

Uh oh!

coderabbitai bot commented Jul 15, 2025

Walkthrough

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

coderabbitai bot left a comment

Uh oh!

pkg-pr-new bot commented Jul 15, 2025 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

chore(shared): Add experimental JSDoc for org.getSubscriptions #6318

chore(shared): Add experimental JSDoc for org.getSubscriptions #6318

Uh oh!

Conversation

panteliselef commented Jul 15, 2025 • edited by l-armstrong Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Checklist

Type of change

Summary by CodeRabbit

Uh oh!

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

Uh oh!

🦋 Changeset detected

Uh oh!

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

Uh oh!

Uh oh!

coderabbitai bot commented Jul 15, 2025

Walkthrough

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

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

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

chore(shared): Add experimental JSDoc for `org.getSubscriptions` #6318

chore(shared): Add experimental JSDoc for `org.getSubscriptions` #6318

panteliselef commented Jul 15, 2025 •

edited by l-armstrong

Loading

changeset-bot bot commented Jul 15, 2025 •

edited

Loading

vercel bot commented Jul 15, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)

pkg-pr-new bot commented Jul 15, 2025 •

edited

Loading