docs(backend,shared): Update typedoc comments#7115
Conversation
🦋 Changeset detectedLatest commit: 938da44 The changes in this PR will be included in the next version bump. This PR includes changesets to release 0 packagesWhen 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 |
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
WalkthroughStandardized JSDoc and inline documentation capitalization across many packages; added a new public field Changes
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes
Poem
Pre-merge checks and finishing touches❌ Failed checks (1 warning)
✅ Passed checks (2 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
📜 Recent review detailsConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Disabled knowledge base sources:
📒 Files selected for processing (1)
✅ Files skipped from review due to trivial changes (1)
⏰ 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). (34)
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. Comment |
@clerk/agent-toolkit
@clerk/astro
@clerk/backend
@clerk/chrome-extension
@clerk/clerk-js
@clerk/dev-cli
@clerk/elements
@clerk/clerk-expo
@clerk/expo-passkeys
@clerk/express
@clerk/fastify
@clerk/localizations
@clerk/nextjs
@clerk/nuxt
@clerk/clerk-react
@clerk/react-router
@clerk/remix
@clerk/shared
@clerk/tanstack-react-start
@clerk/testing
@clerk/themes
@clerk/types
@clerk/upgrade
@clerk/vue
commit: |
|
Found 22 test failures on Blacksmith runners:
|
|
@alexisintech have updated the links after they got changed in the |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Nitpick comments (8)
packages/clerk-js/src/ui/components/CreateOrganization/CreateOrganizationForm.tsx (1)
37-43: Deprecation notice is clear but consider future migration path.While the deprecation comment properly guides users to the Dashboard setting, there's no indication of a replacement pattern or timeline. The prop is still actively used in the logic (line 73), which is appropriate during a deprecation period, but ensure a migration guide is available in documentation.
packages/localizations/README.md (1)
68-70: Verify formatting aligns with Prettier conventions.A blank line has been inserted before the first bullet point. Per coding guidelines, Markdown files should use Prettier for consistent formatting. Prettier typically normalizes whitespace between introductory text and list items. Please verify that running Prettier on this file preserves this formatting or confirms it as the intended output.
packages/backend/src/api/resources/User.ts (1)
132-138: Doc capitalization aligns with terminology; optional phrasing polishThe capitalization updates for “Organization creation” / “Organizations” look consistent with the rest of the docs and don’t affect behavior. If you want to tighten wording while you’re here, consider something like:
- “Whether Organization creation is enabled for the user.”
- “How many Organizations the user can create.
0means unlimited;nulluses the instance default.”Purely optional; current text is already clear enough for this PR’s scope.
packages/astro/src/stores/external.ts (1)
59-59: Consider consistent capitalization of resource names in documentation.The capitalization of "Active Organization" differs from similar descriptions elsewhere in this file (e.g., "authenticated user" on line 39, "session" on line 49, "clerk client" on line 69). If "Organization" is being treated as a proper noun or Clerk resource type, consider applying the same capitalization pattern to other Clerk resources (User, Session, Client) for consistency.
Optional: Fix pre-existing typos
While reviewing, I noticed two pre-existing typos (not introduced in this PR):
- Line 78: "instanciated" should be "instantiated"
- Line 93: "sessino.id" should be "session.id"
Would you like me to generate a fix for these typos or open a separate issue to track them?
packages/shared/src/react/billing/payment-element.tsx (1)
220-239: Consider??instead of||for amount fallbackHere:
amount: checkout.totals.totalDueNow?.amount || checkout.totals.grandTotal.amount,If
totalDueNow?.amountcan legitimately be0,||will treat it as falsy and fall back tograndTotal.amount. If the goal is only to fall back whentotalDueNowisnull/undefined, consider:amount: checkout.totals.totalDueNow?.amount ?? checkout.totals.grandTotal.amount,This preserves
0while still handling missing values.packages/backend/src/api/endpoints/SamlConnectionApi.ts (1)
24-29: Optional: clarify SAML organizationId filter wordingThe behavior is clear, but the phrase “associated Organization ID to the given Organizations” is a bit awkward. Consider tightening it for readability:
- /** - * Returns SAML connections that have an associated Organization ID to the given Organizations. - * For each Organization ID, the + and - can be prepended to the ID, which denote whether the - * respective Organization should be included or excluded from the result set. Accepts up to 100 Organization IDs. - */ + /** + * Returns SAML connections whose associated Organization ID matches the given Organizations. + * For each Organization ID, a `+` or `-` prefix denotes whether the respective Organization + * should be included in or excluded from the result set. Accepts up to 100 Organization IDs. + */packages/shared/src/types/clerk.ts (1)
493-547: Fix misleading @param on__experimental_prefetchOrganizationSwitcherThe function signature takes no arguments, but the JSDoc still documents a
propsparameter, which can confuse consumers reading generated docs. You can safely drop that line:/** * Prefetches the data displayed by an Organization switcher. * It can be used when `mountOrganizationSwitcher({ asStandalone: true})`, to avoid unwanted loading states. * * @experimental This experimental API is subject to change. - * - * @param props - Optional user verification configuration parameters. */ __experimental_prefetchOrganizationSwitcher: () => void;packages/backend/src/api/endpoints/OrganizationApi.ts (1)
1-1: Optional: consider migrating from@clerk/typesalias to shared typesNot directly related to this PR, but when you next touch this file, you may want to import
ClerkPaginationRequestandOrganizationEnrollmentModefrom@clerk/shared/typesinstead of the deprecated@clerk/typesalias to align with the repo guidelines.
📜 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.
📒 Files selected for processing (52)
integration/README.md(1 hunks)packages/agent-toolkit/src/lib/tools/index.ts(1 hunks)packages/astro/src/stores/external.ts(1 hunks)packages/backend/src/api/endpoints/APIKeysApi.ts(2 hunks)packages/backend/src/api/endpoints/InstanceApi.ts(1 hunks)packages/backend/src/api/endpoints/OrganizationApi.ts(3 hunks)packages/backend/src/api/endpoints/SamlConnectionApi.ts(1 hunks)packages/backend/src/api/endpoints/UserApi.ts(1 hunks)packages/backend/src/api/resources/CommercePlan.ts(1 hunks)packages/backend/src/api/resources/CommerceSubscriptionItem.ts(2 hunks)packages/backend/src/api/resources/Feature.ts(1 hunks)packages/backend/src/api/resources/JSON.ts(1 hunks)packages/backend/src/api/resources/Organization.ts(3 hunks)packages/backend/src/api/resources/OrganizationInvitation.ts(3 hunks)packages/backend/src/api/resources/OrganizationMembership.ts(3 hunks)packages/backend/src/api/resources/SamlConnection.ts(1 hunks)packages/backend/src/api/resources/Session.ts(1 hunks)packages/backend/src/api/resources/User.ts(1 hunks)packages/backend/src/tokens/authObjects.ts(1 hunks)packages/backend/src/tokens/types.ts(4 hunks)packages/clerk-js/src/ui/components/CreateOrganization/CreateOrganizationForm.tsx(1 hunks)packages/clerk-js/src/ui/components/OrganizationProfile/InviteMembersForm.tsx(1 hunks)packages/clerk-js/src/ui/components/OrganizationProfile/MembersSearch.tsx(1 hunks)packages/clerk-js/src/ui/hooks/useFetchRoles.ts(1 hunks)packages/clerk-js/src/utils/organization.ts(1 hunks)packages/localizations/README.md(1 hunks)packages/react-router/src/server/types.ts(1 hunks)packages/react/src/components/SubscriptionDetailsButton.tsx(2 hunks)packages/react/src/hooks/useAuth.ts(1 hunks)packages/remix/README.md(1 hunks)packages/shared/src/authorization.ts(1 hunks)packages/shared/src/compiled/path-to-regexp/index.js(6 hunks)packages/shared/src/organization.ts(1 hunks)packages/shared/src/react/billing/payment-element.tsx(1 hunks)packages/shared/src/react/contexts.tsx(1 hunks)packages/shared/src/react/hooks/createBillingPaginatedHook.tsx(2 hunks)packages/shared/src/react/hooks/useOrganization.tsx(5 hunks)packages/shared/src/react/hooks/useOrganizationList.tsx(2 hunks)packages/shared/src/react/hooks/useSubscription.types.ts(1 hunks)packages/shared/src/types/authObject.ts(1 hunks)packages/shared/src/types/billing.ts(15 hunks)packages/shared/src/types/clerk.ts(22 hunks)packages/shared/src/types/hooks.ts(2 hunks)packages/shared/src/types/jwt.ts(1 hunks)packages/shared/src/types/jwtv2.ts(2 hunks)packages/shared/src/types/localization.ts(1 hunks)packages/shared/src/types/organization.ts(2 hunks)packages/shared/src/types/organizationDomain.ts(1 hunks)packages/shared/src/types/organizationInvitation.ts(2 hunks)packages/shared/src/types/organizationMembership.ts(4 hunks)packages/shared/src/types/protect.ts(1 hunks)packages/shared/src/types/session.ts(4 hunks)
🧰 Additional context used
📓 Path-based instructions (15)
**/*.{js,jsx,ts,tsx}
📄 CodeRabbit inference engine (.cursor/rules/development.mdc)
All code must pass ESLint checks with the project's configuration
Files:
packages/backend/src/api/endpoints/SamlConnectionApi.tspackages/shared/src/types/organizationDomain.tspackages/backend/src/api/resources/SamlConnection.tspackages/shared/src/types/hooks.tspackages/backend/src/api/resources/Session.tspackages/backend/src/tokens/authObjects.tspackages/shared/src/react/hooks/useOrganizationList.tsxpackages/backend/src/api/resources/User.tspackages/clerk-js/src/utils/organization.tspackages/backend/src/api/resources/Feature.tspackages/shared/src/types/session.tspackages/react-router/src/server/types.tspackages/backend/src/api/resources/OrganizationMembership.tspackages/backend/src/api/endpoints/UserApi.tspackages/agent-toolkit/src/lib/tools/index.tspackages/shared/src/react/hooks/useSubscription.types.tspackages/clerk-js/src/ui/components/OrganizationProfile/InviteMembersForm.tsxpackages/shared/src/types/protect.tspackages/backend/src/tokens/types.tspackages/shared/src/types/organizationInvitation.tspackages/shared/src/types/organization.tspackages/shared/src/react/hooks/createBillingPaginatedHook.tsxpackages/astro/src/stores/external.tspackages/backend/src/api/endpoints/InstanceApi.tspackages/shared/src/types/clerk.tspackages/backend/src/api/endpoints/APIKeysApi.tspackages/clerk-js/src/ui/components/CreateOrganization/CreateOrganizationForm.tsxpackages/shared/src/compiled/path-to-regexp/index.jspackages/backend/src/api/endpoints/OrganizationApi.tspackages/backend/src/api/resources/OrganizationInvitation.tspackages/react/src/components/SubscriptionDetailsButton.tsxpackages/clerk-js/src/ui/components/OrganizationProfile/MembersSearch.tsxpackages/shared/src/organization.tspackages/backend/src/api/resources/JSON.tspackages/shared/src/types/jwtv2.tspackages/backend/src/api/resources/CommerceSubscriptionItem.tspackages/backend/src/api/resources/CommercePlan.tspackages/shared/src/types/organizationMembership.tspackages/shared/src/authorization.tspackages/react/src/hooks/useAuth.tspackages/clerk-js/src/ui/hooks/useFetchRoles.tspackages/shared/src/types/authObject.tspackages/shared/src/react/hooks/useOrganization.tsxpackages/shared/src/react/contexts.tsxpackages/shared/src/react/billing/payment-element.tsxpackages/shared/src/types/billing.tspackages/shared/src/types/jwt.tspackages/shared/src/types/localization.tspackages/backend/src/api/resources/Organization.ts
**/*.{js,jsx,ts,tsx,json,md,yml,yaml}
📄 CodeRabbit inference engine (.cursor/rules/development.mdc)
Use Prettier for consistent code formatting
Files:
packages/backend/src/api/endpoints/SamlConnectionApi.tspackages/shared/src/types/organizationDomain.tspackages/backend/src/api/resources/SamlConnection.tspackages/remix/README.mdpackages/shared/src/types/hooks.tspackages/backend/src/api/resources/Session.tspackages/backend/src/tokens/authObjects.tspackages/shared/src/react/hooks/useOrganizationList.tsxpackages/backend/src/api/resources/User.tspackages/clerk-js/src/utils/organization.tspackages/backend/src/api/resources/Feature.tspackages/shared/src/types/session.tspackages/react-router/src/server/types.tspackages/backend/src/api/resources/OrganizationMembership.tspackages/backend/src/api/endpoints/UserApi.tspackages/agent-toolkit/src/lib/tools/index.tspackages/shared/src/react/hooks/useSubscription.types.tspackages/clerk-js/src/ui/components/OrganizationProfile/InviteMembersForm.tsxpackages/shared/src/types/protect.tspackages/backend/src/tokens/types.tspackages/shared/src/types/organizationInvitation.tspackages/shared/src/types/organization.tspackages/shared/src/react/hooks/createBillingPaginatedHook.tsxpackages/astro/src/stores/external.tspackages/backend/src/api/endpoints/InstanceApi.tspackages/shared/src/types/clerk.tspackages/backend/src/api/endpoints/APIKeysApi.tspackages/clerk-js/src/ui/components/CreateOrganization/CreateOrganizationForm.tsxpackages/shared/src/compiled/path-to-regexp/index.jspackages/backend/src/api/endpoints/OrganizationApi.tspackages/backend/src/api/resources/OrganizationInvitation.tspackages/react/src/components/SubscriptionDetailsButton.tsxpackages/clerk-js/src/ui/components/OrganizationProfile/MembersSearch.tsxpackages/shared/src/organization.tspackages/backend/src/api/resources/JSON.tspackages/shared/src/types/jwtv2.tsintegration/README.mdpackages/backend/src/api/resources/CommerceSubscriptionItem.tspackages/backend/src/api/resources/CommercePlan.tspackages/shared/src/types/organizationMembership.tspackages/shared/src/authorization.tspackages/react/src/hooks/useAuth.tspackages/clerk-js/src/ui/hooks/useFetchRoles.tspackages/shared/src/types/authObject.tspackages/shared/src/react/hooks/useOrganization.tsxpackages/shared/src/react/contexts.tsxpackages/shared/src/react/billing/payment-element.tsxpackages/shared/src/types/billing.tspackages/shared/src/types/jwt.tspackages/shared/src/types/localization.tspackages/localizations/README.mdpackages/backend/src/api/resources/Organization.ts
packages/**/src/**/*.{ts,tsx}
📄 CodeRabbit inference engine (.cursor/rules/development.mdc)
TypeScript is required for all packages
Files:
packages/backend/src/api/endpoints/SamlConnectionApi.tspackages/shared/src/types/organizationDomain.tspackages/backend/src/api/resources/SamlConnection.tspackages/shared/src/types/hooks.tspackages/backend/src/api/resources/Session.tspackages/backend/src/tokens/authObjects.tspackages/shared/src/react/hooks/useOrganizationList.tsxpackages/backend/src/api/resources/User.tspackages/clerk-js/src/utils/organization.tspackages/backend/src/api/resources/Feature.tspackages/shared/src/types/session.tspackages/react-router/src/server/types.tspackages/backend/src/api/resources/OrganizationMembership.tspackages/backend/src/api/endpoints/UserApi.tspackages/agent-toolkit/src/lib/tools/index.tspackages/shared/src/react/hooks/useSubscription.types.tspackages/clerk-js/src/ui/components/OrganizationProfile/InviteMembersForm.tsxpackages/shared/src/types/protect.tspackages/backend/src/tokens/types.tspackages/shared/src/types/organizationInvitation.tspackages/shared/src/types/organization.tspackages/shared/src/react/hooks/createBillingPaginatedHook.tsxpackages/astro/src/stores/external.tspackages/backend/src/api/endpoints/InstanceApi.tspackages/shared/src/types/clerk.tspackages/backend/src/api/endpoints/APIKeysApi.tspackages/clerk-js/src/ui/components/CreateOrganization/CreateOrganizationForm.tsxpackages/backend/src/api/endpoints/OrganizationApi.tspackages/backend/src/api/resources/OrganizationInvitation.tspackages/react/src/components/SubscriptionDetailsButton.tsxpackages/clerk-js/src/ui/components/OrganizationProfile/MembersSearch.tsxpackages/shared/src/organization.tspackages/backend/src/api/resources/JSON.tspackages/shared/src/types/jwtv2.tspackages/backend/src/api/resources/CommerceSubscriptionItem.tspackages/backend/src/api/resources/CommercePlan.tspackages/shared/src/types/organizationMembership.tspackages/shared/src/authorization.tspackages/react/src/hooks/useAuth.tspackages/clerk-js/src/ui/hooks/useFetchRoles.tspackages/shared/src/types/authObject.tspackages/shared/src/react/hooks/useOrganization.tsxpackages/shared/src/react/contexts.tsxpackages/shared/src/react/billing/payment-element.tsxpackages/shared/src/types/billing.tspackages/shared/src/types/jwt.tspackages/shared/src/types/localization.tspackages/backend/src/api/resources/Organization.ts
**/*.{ts,tsx,js,jsx}
📄 CodeRabbit inference engine (.cursor/rules/development.mdc)
Follow established naming conventions (PascalCase for components, camelCase for variables)
Prefer importing types from
@clerk/shared/typesinstead of the deprecated@clerk/typesalias
Files:
packages/backend/src/api/endpoints/SamlConnectionApi.tspackages/shared/src/types/organizationDomain.tspackages/backend/src/api/resources/SamlConnection.tspackages/shared/src/types/hooks.tspackages/backend/src/api/resources/Session.tspackages/backend/src/tokens/authObjects.tspackages/shared/src/react/hooks/useOrganizationList.tsxpackages/backend/src/api/resources/User.tspackages/clerk-js/src/utils/organization.tspackages/backend/src/api/resources/Feature.tspackages/shared/src/types/session.tspackages/react-router/src/server/types.tspackages/backend/src/api/resources/OrganizationMembership.tspackages/backend/src/api/endpoints/UserApi.tspackages/agent-toolkit/src/lib/tools/index.tspackages/shared/src/react/hooks/useSubscription.types.tspackages/clerk-js/src/ui/components/OrganizationProfile/InviteMembersForm.tsxpackages/shared/src/types/protect.tspackages/backend/src/tokens/types.tspackages/shared/src/types/organizationInvitation.tspackages/shared/src/types/organization.tspackages/shared/src/react/hooks/createBillingPaginatedHook.tsxpackages/astro/src/stores/external.tspackages/backend/src/api/endpoints/InstanceApi.tspackages/shared/src/types/clerk.tspackages/backend/src/api/endpoints/APIKeysApi.tspackages/clerk-js/src/ui/components/CreateOrganization/CreateOrganizationForm.tsxpackages/shared/src/compiled/path-to-regexp/index.jspackages/backend/src/api/endpoints/OrganizationApi.tspackages/backend/src/api/resources/OrganizationInvitation.tspackages/react/src/components/SubscriptionDetailsButton.tsxpackages/clerk-js/src/ui/components/OrganizationProfile/MembersSearch.tsxpackages/shared/src/organization.tspackages/backend/src/api/resources/JSON.tspackages/shared/src/types/jwtv2.tspackages/backend/src/api/resources/CommerceSubscriptionItem.tspackages/backend/src/api/resources/CommercePlan.tspackages/shared/src/types/organizationMembership.tspackages/shared/src/authorization.tspackages/react/src/hooks/useAuth.tspackages/clerk-js/src/ui/hooks/useFetchRoles.tspackages/shared/src/types/authObject.tspackages/shared/src/react/hooks/useOrganization.tsxpackages/shared/src/react/contexts.tsxpackages/shared/src/react/billing/payment-element.tsxpackages/shared/src/types/billing.tspackages/shared/src/types/jwt.tspackages/shared/src/types/localization.tspackages/backend/src/api/resources/Organization.ts
packages/**/src/**/*.{ts,tsx,js,jsx}
📄 CodeRabbit inference engine (.cursor/rules/development.mdc)
packages/**/src/**/*.{ts,tsx,js,jsx}: Maintain comprehensive JSDoc comments for public APIs
Use tree-shaking friendly exports
Validate all inputs and sanitize outputs
All public APIs must be documented with JSDoc
Use dynamic imports for optional features
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
Implement proper logging with different levels
Files:
packages/backend/src/api/endpoints/SamlConnectionApi.tspackages/shared/src/types/organizationDomain.tspackages/backend/src/api/resources/SamlConnection.tspackages/shared/src/types/hooks.tspackages/backend/src/api/resources/Session.tspackages/backend/src/tokens/authObjects.tspackages/shared/src/react/hooks/useOrganizationList.tsxpackages/backend/src/api/resources/User.tspackages/clerk-js/src/utils/organization.tspackages/backend/src/api/resources/Feature.tspackages/shared/src/types/session.tspackages/react-router/src/server/types.tspackages/backend/src/api/resources/OrganizationMembership.tspackages/backend/src/api/endpoints/UserApi.tspackages/agent-toolkit/src/lib/tools/index.tspackages/shared/src/react/hooks/useSubscription.types.tspackages/clerk-js/src/ui/components/OrganizationProfile/InviteMembersForm.tsxpackages/shared/src/types/protect.tspackages/backend/src/tokens/types.tspackages/shared/src/types/organizationInvitation.tspackages/shared/src/types/organization.tspackages/shared/src/react/hooks/createBillingPaginatedHook.tsxpackages/astro/src/stores/external.tspackages/backend/src/api/endpoints/InstanceApi.tspackages/shared/src/types/clerk.tspackages/backend/src/api/endpoints/APIKeysApi.tspackages/clerk-js/src/ui/components/CreateOrganization/CreateOrganizationForm.tsxpackages/shared/src/compiled/path-to-regexp/index.jspackages/backend/src/api/endpoints/OrganizationApi.tspackages/backend/src/api/resources/OrganizationInvitation.tspackages/react/src/components/SubscriptionDetailsButton.tsxpackages/clerk-js/src/ui/components/OrganizationProfile/MembersSearch.tsxpackages/shared/src/organization.tspackages/backend/src/api/resources/JSON.tspackages/shared/src/types/jwtv2.tspackages/backend/src/api/resources/CommerceSubscriptionItem.tspackages/backend/src/api/resources/CommercePlan.tspackages/shared/src/types/organizationMembership.tspackages/shared/src/authorization.tspackages/react/src/hooks/useAuth.tspackages/clerk-js/src/ui/hooks/useFetchRoles.tspackages/shared/src/types/authObject.tspackages/shared/src/react/hooks/useOrganization.tsxpackages/shared/src/react/contexts.tsxpackages/shared/src/react/billing/payment-element.tsxpackages/shared/src/types/billing.tspackages/shared/src/types/jwt.tspackages/shared/src/types/localization.tspackages/backend/src/api/resources/Organization.ts
**/*.ts?(x)
📄 CodeRabbit inference engine (.cursor/rules/development.mdc)
Use proper TypeScript error types
Files:
packages/backend/src/api/endpoints/SamlConnectionApi.tspackages/shared/src/types/organizationDomain.tspackages/backend/src/api/resources/SamlConnection.tspackages/shared/src/types/hooks.tspackages/backend/src/api/resources/Session.tspackages/backend/src/tokens/authObjects.tspackages/shared/src/react/hooks/useOrganizationList.tsxpackages/backend/src/api/resources/User.tspackages/clerk-js/src/utils/organization.tspackages/backend/src/api/resources/Feature.tspackages/shared/src/types/session.tspackages/react-router/src/server/types.tspackages/backend/src/api/resources/OrganizationMembership.tspackages/backend/src/api/endpoints/UserApi.tspackages/agent-toolkit/src/lib/tools/index.tspackages/shared/src/react/hooks/useSubscription.types.tspackages/clerk-js/src/ui/components/OrganizationProfile/InviteMembersForm.tsxpackages/shared/src/types/protect.tspackages/backend/src/tokens/types.tspackages/shared/src/types/organizationInvitation.tspackages/shared/src/types/organization.tspackages/shared/src/react/hooks/createBillingPaginatedHook.tsxpackages/astro/src/stores/external.tspackages/backend/src/api/endpoints/InstanceApi.tspackages/shared/src/types/clerk.tspackages/backend/src/api/endpoints/APIKeysApi.tspackages/clerk-js/src/ui/components/CreateOrganization/CreateOrganizationForm.tsxpackages/backend/src/api/endpoints/OrganizationApi.tspackages/backend/src/api/resources/OrganizationInvitation.tspackages/react/src/components/SubscriptionDetailsButton.tsxpackages/clerk-js/src/ui/components/OrganizationProfile/MembersSearch.tsxpackages/shared/src/organization.tspackages/backend/src/api/resources/JSON.tspackages/shared/src/types/jwtv2.tspackages/backend/src/api/resources/CommerceSubscriptionItem.tspackages/backend/src/api/resources/CommercePlan.tspackages/shared/src/types/organizationMembership.tspackages/shared/src/authorization.tspackages/react/src/hooks/useAuth.tspackages/clerk-js/src/ui/hooks/useFetchRoles.tspackages/shared/src/types/authObject.tspackages/shared/src/react/hooks/useOrganization.tsxpackages/shared/src/react/contexts.tsxpackages/shared/src/react/billing/payment-element.tsxpackages/shared/src/types/billing.tspackages/shared/src/types/jwt.tspackages/shared/src/types/localization.tspackages/backend/src/api/resources/Organization.ts
**/*.{ts,tsx}
📄 CodeRabbit inference engine (.cursor/rules/typescript.mdc)
**/*.{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
Avoidanytype - preferunknownwhen type is uncertain, then narrow with type guards
Implement type guards forunknowntypes using the patternfunction isType(value: unknown): value is Type
Useinterfacefor object shapes that might be extended
Usetypefor unions, primitives, and computed types
Preferreadonlyproperties for immutable data structures
Useprivatefor internal implementation details in classes
Useprotectedfor inheritance hierarchies
Usepublicexplicitly for clarity in public APIs
Use mixins for shared behavior across unrelated classes in TypeScript
Use generic constraints with bounded type parameters like<T extends { id: string }>
Use utility types likeOmit,Partial, andPickfor data transformation instead of manual type construction
Use discriminated unions instead of boolean flags for state management and API responses
Use mapped types for transforming object types
Use conditional types for type-level logic
Leverage template literal types for string manipulation at the type level
Use ES6 imports/exports consistently
Use default exports sparingly, prefer named exports
Document functions with JSDoc comments including @param, @returns, @throws, and @example tags
Create custom error classes that extend Error for specific error types
Use the Result pattern for error handling instead of throwing exceptions
Use optional chaining (?.) and nullish coalescing (??) operators for safe property access
Let TypeScript infer obvious types to reduce verbosity
Useconst assertionswithas constfor literal types
Usesatisfiesoperator for type checking without widening types
Declare readonly arrays and objects for immutable data structures
Use spread operator and array spread for immutable updates instead of mutations
Use lazy loading for large types...
Files:
packages/backend/src/api/endpoints/SamlConnectionApi.tspackages/shared/src/types/organizationDomain.tspackages/backend/src/api/resources/SamlConnection.tspackages/shared/src/types/hooks.tspackages/backend/src/api/resources/Session.tspackages/backend/src/tokens/authObjects.tspackages/shared/src/react/hooks/useOrganizationList.tsxpackages/backend/src/api/resources/User.tspackages/clerk-js/src/utils/organization.tspackages/backend/src/api/resources/Feature.tspackages/shared/src/types/session.tspackages/react-router/src/server/types.tspackages/backend/src/api/resources/OrganizationMembership.tspackages/backend/src/api/endpoints/UserApi.tspackages/agent-toolkit/src/lib/tools/index.tspackages/shared/src/react/hooks/useSubscription.types.tspackages/clerk-js/src/ui/components/OrganizationProfile/InviteMembersForm.tsxpackages/shared/src/types/protect.tspackages/backend/src/tokens/types.tspackages/shared/src/types/organizationInvitation.tspackages/shared/src/types/organization.tspackages/shared/src/react/hooks/createBillingPaginatedHook.tsxpackages/astro/src/stores/external.tspackages/backend/src/api/endpoints/InstanceApi.tspackages/shared/src/types/clerk.tspackages/backend/src/api/endpoints/APIKeysApi.tspackages/clerk-js/src/ui/components/CreateOrganization/CreateOrganizationForm.tsxpackages/backend/src/api/endpoints/OrganizationApi.tspackages/backend/src/api/resources/OrganizationInvitation.tspackages/react/src/components/SubscriptionDetailsButton.tsxpackages/clerk-js/src/ui/components/OrganizationProfile/MembersSearch.tsxpackages/shared/src/organization.tspackages/backend/src/api/resources/JSON.tspackages/shared/src/types/jwtv2.tspackages/backend/src/api/resources/CommerceSubscriptionItem.tspackages/backend/src/api/resources/CommercePlan.tspackages/shared/src/types/organizationMembership.tspackages/shared/src/authorization.tspackages/react/src/hooks/useAuth.tspackages/clerk-js/src/ui/hooks/useFetchRoles.tspackages/shared/src/types/authObject.tspackages/shared/src/react/hooks/useOrganization.tsxpackages/shared/src/react/contexts.tsxpackages/shared/src/react/billing/payment-element.tsxpackages/shared/src/types/billing.tspackages/shared/src/types/jwt.tspackages/shared/src/types/localization.tspackages/backend/src/api/resources/Organization.ts
**/README.md
📄 CodeRabbit inference engine (.cursor/rules/development.mdc)
Provide usage examples in documentation
Files:
packages/remix/README.mdintegration/README.mdpackages/localizations/README.md
packages/*/README.md
📄 CodeRabbit inference engine (.cursor/rules/development.mdc)
packages/*/README.md: Maintain up-to-date README files for each package
Maintain compatibility matrices for supported versions
Files:
packages/remix/README.mdpackages/localizations/README.md
**/*.{md,tsx}
📄 CodeRabbit inference engine (.cursor/rules/development.mdc)
Update documentation for API changes
Files:
packages/remix/README.mdpackages/shared/src/react/hooks/useOrganizationList.tsxpackages/clerk-js/src/ui/components/OrganizationProfile/InviteMembersForm.tsxpackages/shared/src/react/hooks/createBillingPaginatedHook.tsxpackages/clerk-js/src/ui/components/CreateOrganization/CreateOrganizationForm.tsxpackages/react/src/components/SubscriptionDetailsButton.tsxpackages/clerk-js/src/ui/components/OrganizationProfile/MembersSearch.tsxintegration/README.mdpackages/shared/src/react/hooks/useOrganization.tsxpackages/shared/src/react/contexts.tsxpackages/shared/src/react/billing/payment-element.tsxpackages/localizations/README.md
**/*.tsx
📄 CodeRabbit inference engine (.cursor/rules/development.mdc)
**/*.tsx: Use error boundaries in React components
Minimize re-renders in React components
**/*.tsx: Use proper type definitions for props and state in React components
Leverage TypeScript's type inference where possible in React components
Use proper event types for handlers in React components
Implement proper generic types for reusable React components
Use proper type guards for conditional rendering in React components
Files:
packages/shared/src/react/hooks/useOrganizationList.tsxpackages/clerk-js/src/ui/components/OrganizationProfile/InviteMembersForm.tsxpackages/shared/src/react/hooks/createBillingPaginatedHook.tsxpackages/clerk-js/src/ui/components/CreateOrganization/CreateOrganizationForm.tsxpackages/react/src/components/SubscriptionDetailsButton.tsxpackages/clerk-js/src/ui/components/OrganizationProfile/MembersSearch.tsxpackages/shared/src/react/hooks/useOrganization.tsxpackages/shared/src/react/contexts.tsxpackages/shared/src/react/billing/payment-element.tsx
**/*.{jsx,tsx}
📄 CodeRabbit inference engine (.cursor/rules/react.mdc)
**/*.{jsx,tsx}: Always use functional components with hooks instead of class components
Follow PascalCase naming for components (e.g.,UserProfile,NavigationMenu)
Keep components focused on a single responsibility - split large components
Limit component size to 150-200 lines; extract logic into custom hooks
Use composition over inheritance - prefer smaller, composable components
Export components as named exports for better tree-shaking
One component per file with matching filename and component name
Separate UI components from business logic components
Use useState for simple state management in React components
Use useReducer for complex state logic in React components
Implement proper state initialization in React components
Use proper state updates with callbacks in React components
Implement proper state cleanup in React components
Use Context API for theme/authentication state management
Implement proper state persistence in React applications
Use React.memo for expensive components
Implement proper useCallback for handlers in React components
Use proper useMemo for expensive computations in React components
Implement proper virtualization for lists in React components
Use proper code splitting with React.lazy in React applications
Implement proper cleanup in useEffect hooks
Use proper refs for DOM access in React components
Implement proper event listener cleanup in React components
Use proper abort controllers for fetch in React components
Implement proper subscription cleanup in React components
Use proper HTML elements for semantic HTML in React components
Implement proper ARIA attributes for accessibility in React components
Use proper heading hierarchy in React components
Implement proper form labels in React components
Use proper button types in React components
Implement proper focus management for keyboard navigation in React components
Use proper keyboard shortcuts in React components
Implement proper tab order in React components
Use proper ...
Files:
packages/shared/src/react/hooks/useOrganizationList.tsxpackages/clerk-js/src/ui/components/OrganizationProfile/InviteMembersForm.tsxpackages/shared/src/react/hooks/createBillingPaginatedHook.tsxpackages/clerk-js/src/ui/components/CreateOrganization/CreateOrganizationForm.tsxpackages/react/src/components/SubscriptionDetailsButton.tsxpackages/clerk-js/src/ui/components/OrganizationProfile/MembersSearch.tsxpackages/shared/src/react/hooks/useOrganization.tsxpackages/shared/src/react/contexts.tsxpackages/shared/src/react/billing/payment-element.tsx
**/index.ts
📄 CodeRabbit inference engine (.cursor/rules/typescript.mdc)
Avoid barrel files (index.ts re-exports) as they can cause circular dependencies
Files:
packages/agent-toolkit/src/lib/tools/index.ts
packages/clerk-js/src/ui/**/*.{ts,tsx}
📄 CodeRabbit inference engine (.cursor/rules/clerk-js-ui.mdc)
packages/clerk-js/src/ui/**/*.{ts,tsx}: Element descriptors should be written in camelCase
Use useCardState for card-level state management
Use useFormState for form-level state management
Use useLoadingStatus for managing loading states
Use useFormControl hook for form field state management with validation and localization support
All rendered values must be localized using useLocalizations hook - hard coded values are not allowed
Use localizationKeys for translating UI text with support for parameters and error messages
Use handleError utility for API error handling and provide field states for proper error mapping
Use the styled system sx prop with theme tokens for custom styling instead of inline styles
Use the Card component pattern with Card.Root, Card.Header, Card.Title, Card.Content, and Card.Footer for consistent card layouts
Use FormContainer with headerTitle and headerSubtitle localization keys combined with Form.Root and FormButtons for consistent form layouts
When form submission occurs, manage loading and error states by calling status.setLoading(), card.setLoading(), and card.setError() appropriately
Files:
packages/clerk-js/src/ui/components/OrganizationProfile/InviteMembersForm.tsxpackages/clerk-js/src/ui/components/CreateOrganization/CreateOrganizationForm.tsxpackages/clerk-js/src/ui/components/OrganizationProfile/MembersSearch.tsxpackages/clerk-js/src/ui/hooks/useFetchRoles.ts
packages/localizations/**
📄 CodeRabbit inference engine (.cursor/rules/monorepo.mdc)
packages/localizations/**: Localization support must include translations for 30+ languages using a modular localization system
Support RTL languages in the localization system
Files:
packages/localizations/README.md
🧬 Code graph analysis (9)
packages/shared/src/types/session.ts (1)
packages/shared/src/types/organizationMembership.ts (1)
OrganizationCustomRoleKey(77-81)
packages/backend/src/api/resources/OrganizationMembership.ts (2)
packages/backend/src/api/resources/Enums.ts (1)
OrganizationMembershipRole(35-35)packages/backend/src/api/resources/index.ts (1)
OrganizationMembershipRole(19-19)
packages/shared/src/types/clerk.ts (4)
packages/upgrade/src/app.js (1)
props(27-27)packages/clerk-js/src/ui/types.ts (3)
OrganizationProfileProps(35-35)OrganizationSwitcherProps(36-36)OrganizationListProps(34-34)packages/shared/src/types/organization.ts (1)
OrganizationResource(38-69)packages/react/src/isomorphicClerk.ts (1)
organization(719-725)
packages/backend/src/api/resources/OrganizationInvitation.ts (2)
packages/backend/src/api/resources/Enums.ts (1)
OrganizationMembershipRole(35-35)packages/backend/src/api/resources/index.ts (1)
OrganizationMembershipRole(19-19)
packages/shared/src/types/jwtv2.ts (1)
packages/shared/src/types/organizationMembership.ts (2)
OrganizationCustomPermissionKey(64-68)OrganizationCustomRoleKey(77-81)
packages/backend/src/api/resources/CommercePlan.ts (2)
packages/clerk-js/src/core/resources/BillingPlan.ts (1)
BillingPlan(12-59)packages/shared/src/types/billing.ts (1)
BillingMoneyAmount(629-646)
packages/shared/src/types/authObject.ts (1)
packages/shared/src/types/organizationMembership.ts (1)
OrganizationCustomRoleKey(77-81)
packages/shared/src/react/hooks/useOrganization.tsx (3)
packages/shared/src/react/types.ts (1)
PaginatedResourcesWithDefault(82-84)packages/shared/src/types/organizationDomain.ts (1)
OrganizationDomainResource(24-40)packages/shared/src/types/organizationMembership.ts (1)
OrganizationMembershipResource(46-62)
packages/shared/src/react/contexts.tsx (1)
packages/shared/src/types/billing.ts (2)
ForPayerType(69-69)BillingSubscriptionPlanPeriod(83-83)
🔇 Additional comments (64)
packages/clerk-js/src/utils/organization.ts (1)
2-2: Documentation update aligns with PR objectives.The capitalization of "organization ID" to "Organization ID" in the JSDoc comment maintains consistency with the standardized documentation terminology across the codebase, as outlined in the PR objectives. The function maintains proper TypeScript typing (explicit return type and parameter types) and comprehensive JSDoc documentation.
packages/react-router/src/server/types.ts (1)
40-42: Documentation update is well-formatted and consistent.The JSDoc comment improvements enhance clarity through standardized capitalization of organizational terms ("Organization", "Personal Account", "Active Organization") and updated links to the Clerk docs. The comment remains accurate and helpful for developers using
organizationSyncOptions.Please verify that the external documentation links (https://clerk.com/docs/guides/organizations/overview and https://clerk.com/docs/guides/dashboard/overview) are accessible and match the updates made in the clerk-docs PR #2758.
packages/backend/src/api/endpoints/UserApi.ts (1)
160-164: Documentation terminology aligned with official docs.The capitalization updates to "Organizations" in the JSDoc comments for
createOrganizationEnabledandcreateOrganizationsLimitalign with the standardized terminology across the documentation. The comments remain clear and well-formatted for API consumers.packages/shared/src/types/localization.ts (1)
71-75: Documentation terminology standardization looks good.The capitalization update from "role" to "Role" in the JSDoc comment aligns with the PR's objective to standardize terminology across typedoc comments and documentation. The change maintains consistency with broader documentation conventions.
packages/clerk-js/src/ui/hooks/useFetchRoles.ts (1)
11-12: Documentation capitalization update approved.The changes properly capitalize "Roles" in the JSDoc comments, aligning with the PR's objective to standardize terminology across documentation. These are documentation-only changes with no impact on runtime behavior or the public API.
packages/remix/README.md (1)
28-28: Excellent use of GitHub callout syntax for the deprecation warning.The reformatted warning block uses modern GFM callout syntax (
> [!WARNING]), which improves visual hierarchy and readability on GitHub. The deprecation message is clear and directs users to the recommended replacement SDK (@clerk/react-router). The formatting aligns well with modern documentation standards and the coding guidelines.packages/agent-toolkit/src/lib/tools/index.ts (1)
13-17: JSDoc capitalization update looks good.The capitalization change from "organizations" to "Organizations" properly reflects the resource type as a proper noun and aligns with the PR's standardization of terminology across documentation. The comment maintains proper JSDoc syntax and provides meaningful context for the exported tool.
packages/backend/src/api/resources/JSON.ts (1)
407-422: PublicOrganizationDataJSON JSDoc capitalization is consistent and clearThe updated descriptions correctly standardize “Organization” capitalization and keep the existing link and wording clear. No type or behavior impact; this is good to merge as-is.
packages/clerk-js/src/ui/components/CreateOrganization/CreateOrganizationForm.tsx (1)
40-40: JSDoc capitalization update aligns with documentation standards.The deprecation notice for the
hideSlugprop now consistently capitalizes "Organization" and "Organization Settings" to align with Clerk's official terminology. The message remains clear and actionable for developers.packages/backend/src/api/resources/Feature.ts (1)
3-30: JSDoc capitalization update looks goodThe updated comments consistently use
Featureas a domain term and remain accurate with the current constructor andFeatureJSONmapping. No behavioral or typing impact; nothing else to change here.packages/shared/src/compiled/path-to-regexp/index.js (1)
1-331: Verify this file's inclusion in a documentation-focused PR.This compiled vendored library file contains only formatting changes (line-break adjustments to minified code) with no logic modifications. However, its presence in a PR focused on updating typedoc comments seems out of scope. Confirm that these formatting changes are intentional and were not inadvertently included—for instance, via an automated formatter run.
packages/clerk-js/src/ui/components/OrganizationProfile/MembersSearch.tsx (1)
23-25: Terminology standardization looks good.The capitalization of "Organization" in the JSDoc comment aligns with the PR's documentation standardization objectives and maintains consistency with the codebase terminology.
packages/react/src/components/SubscriptionDetailsButton.tsx (3)
24-34: Documentation terminology capitalization is consistent.The example update correctly capitalizes "Organization" in the comment, aligning with standardized terminology across the codebase. The example code itself remains well-structured and demonstrates proper usage patterns.
37-38: Error documentation terminology is properly updated.The @throws documentation now consistently capitalizes "Active Organization context," making the terminology uniform with the rest of the codebase. The error condition remains clear and actionable for developers.
42-88: Component implementation is solid and well-structured.The component correctly:
- Validates required context (SignedIn and organization when needed)
- Implements proper error handling with developer-friendly error messages
- Uses TypeScript for type safety throughout
- Follows React functional component patterns
- Exports as a named export for tree-shaking compatibility
No changes required in this segment.
packages/shared/src/react/hooks/useOrganization.tsx (4)
34-34: Verify the updated documentation link path.The verified domains feature is accessible through the Clerk documentation, and the link has been updated to
https://clerk.com/docs/guides/organizations/add-members/verified-domains#enable-verified-domains. Please verify that this path aligns with the current documentation structure following the changes in the referenced Clerk docs PR.
79-100: Documentation capitalization updates are consistent and well-executed.All JSDoc comment updates properly capitalize "Organization" and "Organization's" throughout the type union, maintaining consistency with the PR's documentation standardization goals. The terminology is now consistently treated as a proper noun across all property descriptions.
153-153: Hook documentation capitalization is consistent with updates throughout the file.The main hook description now correctly capitalizes "currently Active Organization," aligning with the broader terminology standardization across the codebase.
188-188: Example descriptions consistently use updated terminology.Both the infinite pagination and simple pagination example descriptions now properly reference "Organization's memberships," maintaining consistency with the capitalization standardization established elsewhere in the hook documentation.
Also applies to: 232-232
packages/shared/src/authorization.ts (1)
76-78: LGTM! Documentation terminology standardized.The capitalization updates ("Organization-level", "Role", "Permission") improve consistency and align with the broader documentation standardization effort across the codebase.
packages/backend/src/tokens/types.ts (3)
56-58: LGTM!The capitalization of "Organization" and "Personal Account" as proper nouns is consistent with Clerk's documentation terminology standards. The linked documentation paths appear correct.
82-100: LGTM!Terminology updates are consistent. The capitalization of "Organization" and "Personal Account" aligns with Clerk's documentation conventions, and code examples correctly remain unchanged.
152-157: LGTM!The documentation correctly capitalizes "Organization" and "Personal Account" as Clerk concepts, while the type definition values (
'personalAccount','organization') appropriately remain lowercase as string literals.packages/shared/src/react/billing/payment-element.tsx (1)
96-118: JSDoc wording update forforprop looks goodThe updated description (“current user or Organization”) matches the capitalized Organization resource naming used elsewhere and clarifies the intent without affecting types or behavior.
packages/backend/src/api/resources/SamlConnection.ts (1)
17-23: LGTM! Documentation capitalization improved.The capitalization of "Organization" in the JSDoc comments improves consistency with standard terminology conventions.
packages/shared/src/organization.ts (1)
3-8: LGTM! Consistent documentation capitalization.The capitalization updates in the JSDoc comments improve consistency and readability.
integration/README.md (1)
370-376: LGTM! Minor formatting improvement.The additional blank line improves readability by better separating the introductory text from the bullet list.
packages/backend/src/tokens/authObjects.ts (1)
53-56: LGTM! Documentation terminology standardized.The capitalization of "Organization Role" and "Custom Permission" aligns with terminology conventions across the codebase.
packages/shared/src/react/hooks/useSubscription.types.ts (1)
7-12: LGTM! Documentation capitalization improved.The capitalization updates enhance consistency with terminology standards across the API documentation.
packages/backend/src/api/resources/OrganizationMembership.ts (1)
5-52: LGTM! Documentation terminology consistently capitalized.The capitalization updates across the class and property descriptions improve consistency and align with terminology standards used throughout the codebase.
packages/backend/src/api/resources/CommerceSubscriptionItem.ts (1)
22-56: LGTM! Plan terminology standardized.The capitalization of "Plan" in the JSDoc comments improves consistency with the broader terminology standards applied across the codebase.
packages/shared/src/types/organizationInvitation.ts (1)
5-23: LGTM! Interface documentation capitalized correctly.The capitalization of "OrganizationInvitation" in the JSDoc comments properly reflects the TypeScript interface name and improves documentation clarity.
packages/react/src/hooks/useAuth.ts (1)
136-137: LGTM!The capitalization of "Organization Roles" is consistent with the documentation terminology standardization across the codebase.
packages/shared/src/types/protect.ts (1)
8-22: LGTM!The capitalization updates for Role, Permission, and Feature terminology are consistent with the documentation standardization effort.
packages/shared/src/react/hooks/createBillingPaginatedHook.tsx (1)
53-64: LGTM!The "Organization" capitalization in the JSDoc descriptions is consistent with the terminology standardization across the Clerk documentation.
packages/shared/src/types/billing.ts (9)
5-10: LGTM!The "Organization" capitalization in the
orgIdfield description is consistent with the terminology standardization.
78-186: LGTM!The comprehensive capitalization updates for "Plan" and "Feature" terminology throughout
BillingPlanResourceand related types maintain consistency with the documentation standards.
189-214: LGTM!The "Feature" capitalization in
FeatureResourcedocumentation is consistent with the standardization effort.
325-343: LGTM!The "Organization" capitalization in payment method documentation is consistent.
379-382: LGTM!The "Organization" capitalization in
BillingPaymentResourcedescription is consistent.
441-444: LGTM!The "Organization" capitalization in
BillingStatementResourcedescription is consistent.
506-560: LGTM!The "Plan" and "Organization" capitalization in
BillingSubscriptionItemResourcedocumentation is consistent.
653-717: LGTM!The "Plan" capitalization throughout the checkout-related types documentation is consistent.
779-865: LGTM!The "Plan" and "Organization" capitalization in
BillingCheckoutResourceandBillingPayerResourcedocumentation is consistent with the standardization effort.packages/backend/src/api/resources/CommercePlan.ts (1)
6-65: LGTM!The "Plan" capitalization throughout the
BillingPlanclass documentation is consistent with the terminology standardization applied toBillingPlanResourceinpackages/shared/src/types/billing.tsand aligns with the broader documentation updates across the codebase.packages/shared/src/types/jwtv2.ts (1)
110-110: LGTM! Consistent capitalization improves documentation clarity.The capitalization of "Organization" terms in JSDoc comments is consistent and aligns with the PR's objective to standardize documentation terminology.
Also applies to: 115-115, 120-120, 125-125, 148-148, 154-154, 159-159, 164-164, 169-169
packages/shared/src/types/authObject.ts (1)
29-29: LGTM! Documentation improvements enhance clarity.The capitalization updates for "Active Organization", "Role", and "Organization Permissions" are consistent and improve the professional appearance of the documentation.
Also applies to: 33-33, 37-37, 41-41
packages/shared/src/react/contexts.tsx (1)
33-33: LGTM! Terminology standardization applied correctly.The capitalization of "Organization", "Plan", and "Subscription Plan" in the
UseCheckoutOptionsinterface documentation is consistent with the PR's standardization effort.Also applies to: 39-39, 43-43
packages/clerk-js/src/ui/components/OrganizationProfile/InviteMembersForm.tsx (1)
227-228: LGTM! Documentation capitalization is consistent.The capitalization of "Role" and "Organization" in the JSDoc comment for
useDefaultRolealigns with the standardization effort across the codebase.packages/backend/src/api/resources/OrganizationInvitation.ts (1)
5-5: LGTM! Backend API documentation improvements are consistent.The capitalization of "Organization" and "Role" throughout the
OrganizationInvitationclass documentation maintains consistency with the Frontend API documentation style.Also applies to: 24-24, 28-28, 64-64
packages/shared/src/types/jwt.ts (1)
85-85: LGTM! Deprecated types documentation updated for consistency.Even though these are deprecated types, updating the documentation capitalization maintains consistency across the codebase and helps developers who may still reference these interfaces.
Also applies to: 90-90, 95-95
packages/backend/src/api/resources/Session.ts (1)
98-98: LGTM! Documentation capitalization is consistent.The capitalization of "Organization" in the
lastActiveOrganizationIdproperty documentation aligns with standardization across other resource documentation.packages/shared/src/types/organization.ts (1)
15-15: LGTM! Capitalization updates are consistent.The capitalization of "Organization" throughout the type definitions and JSDoc comments maintains consistency with the broader documentation standardization effort.
Also applies to: 24-24, 32-32
packages/shared/src/react/hooks/useOrganizationList.tsx (1)
73-101: Docs capitalization & wording updates look goodThe updated descriptions for
setActive,userMemberships,userInvitations, anduserSuggestions(including the infinite pagination example) are consistent with the existing hook behavior and types; no runtime or typing impact.Also applies to: 157-189
packages/shared/src/types/hooks.ts (1)
53-67: Auth hook docs now aligned with Organization terminologyThe updated descriptions for
orgId,orgRole,orgSlug,has, andUseSessionListReturn.setActivecorrectly reflect current Organization semantics without changing the types.Also applies to: 211-219
packages/shared/src/types/organizationMembership.ts (1)
22-40: Organization membership docs are consistent with existing typesThe updated comments for metadata globals,
OrganizationMembershipResource,OrganizationCustomRoleKey, andOrganizationPermissionKeycorrectly describe current behavior and link to the right concepts; no functional changes introduced.Also applies to: 42-47, 70-75, 93-100
packages/backend/src/api/endpoints/InstanceApi.ts (1)
55-68: Organization settings docs updates are accurateThe revised descriptions for
domainsEnrollmentModes,creatorRoleId, anddomainsDefaultRoleIdcorrectly describe how Organization Domains and default Roles behave; no runtime impact.packages/shared/src/types/clerk.ts (1)
696-702: Organization- and billing-related JSDoc updates align with existing APIsThe expanded and capitalized documentation for:
Clerk.setActiveandSetActiveParams(session vs Organization behavior),OrganizationProfileProps,CreateOrganizationProps,OrganizationSwitcherProps, andOrganizationListProps,- pricing/subscription props that distinguish user vs Organization payers,
- and
CreateOrganizationParams,all accurately describe the current type signatures and runtime behavior, and improve clarity around the “Active Organization” concept without changing the public API.
Also applies to: 1292-1331, 1608-1681, 1775-1917, 1947-1967, 2075-2101, 2117-2145, 2268-2277
packages/shared/src/types/session.ts (1)
64-101: Authorization docs now match roles/permissions/billing modelThe updated descriptions for authorization params (
role,permission,feature,plan) and the note about System Permissions inCheckAuthorizationFromSessionClaimsare consistent with the existing types and server-side constraints; no behavior changes.Also applies to: 104-143, 144-149, 156-194
packages/backend/src/api/resources/Organization.ts (1)
13-66: NewpublicMetadatafield wiring is correctly implemented with no breaking changesThe new
publicMetadataconstructor parameter has been properly integrated at line 76 in thefromJSONmethod, passingdata.public_metadatabetweenupdated_atandprivate_metadata. The parameter order matches the constructor signature, and this is the only directnew Organization(...)instantiation in the backend package, so no other call sites require updating.packages/backend/src/api/endpoints/APIKeysApi.ts (1)
11-22: Organization subject JSDoc capitalization looks consistentThe updated wording for
subjectnow consistently treats Organization as a proper noun in both list and create params; no behavioral or typing impact.Also applies to: 24-41
packages/shared/src/types/organizationDomain.ts (1)
20-24: OrganizationDomain resource description aligned with capitalization conventionThe sentence now correctly reflects Organization as a capitalized domain concept while leaving the type surface unchanged.
packages/backend/src/api/endpoints/OrganizationApi.ts (2)
57-65: Membership sorting JSDoc capitalization is consistent and clearThe updated comments for
orderByin both membership list params correctly capitalize Organization and keep the behavior description unchanged.Also applies to: 140-146
85-86: Roles filter JSDoc matches Role capitalization conventionThe Roles filter description now aligns with the capitalized Role concept while preserving the existing API contract.
4 participants
Description
Updating links in typedoc comments, related to this docs PR: clerk/clerk-docs#2758
Checklist
pnpm testruns as expected.pnpm buildruns as expected.Type of change
Summary by CodeRabbit
New Features
Documentation
✏️ Tip: You can customize this high-level summary in your review settings.