fix(clerk-js, shared, clerk-react): Make props of PlanDetails stricter #6472
Conversation
# Conflicts: # packages/clerk-js/src/ui/components/Plans/PlanDetails.tsx
🦋 Changeset detectedLatest commit: 19a0d02 The changes in this PR will be included in the next version bump. This PR includes changesets to release 22 packages
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 Git ↗︎
|
📝 WalkthroughWalkthroughThis change updates the Estimated code review effort🎯 2 (Simple) | ⏱️ ~8 minutes Note ⚡️ Unit Test Generation is now available in beta!Learn more here, or try it out under "Finishing Touches" below. 📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (2)
🚧 Files skipped from review as they are similar to previous changes (2)
⏰ 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). (11)
🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🔭 Outside diff range comments (3)
packages/clerk-js/src/ui/components/Plans/PlanDetails.tsx (1)
32-38: Flattening the union type removes the “plan or planId” compile-time guarantee
FlattenUnionType<__internal_PlanDetailsProps>converts the mutually-exclusive union into an object where bothplanIdandplanbecome optional.
As a result, external callers ofPlanDetailscan now omit both keys without a
type-error – exactly the opposite of the “stricter props” objective of this PR.-export const PlanDetails = (props: FlattenUnionType<__internal_PlanDetailsProps>) => { +// Keep the public surface strict … +export const PlanDetails = (props: __internal_PlanDetailsProps) => { + // …and only flatten internally if you really need to. + const internalProps = props as FlattenUnionType<__internal_PlanDetailsProps>; + return ( + <Drawer.Content> + <PlanDetailsInternal {...internalProps} /> + </Drawer.Content> + ); +}This preserves the mutual-exclusion contract for consumers while still letting the
implementation work with a flattened shape.packages/clerk-js/src/ui/Components.tsx (2)
111-120:openDrawer('planDetails', …)no longer enforces that eitherplanIdorplanis providedBy switching to
FlattenUnionType<__internal_PlanDetailsProps>the same
compile-time guard discussed earlier is lost for every caller ofopenDrawer.Restore the original union to keep the API self-documenting and type-safe:
- props: T extends 'checkout' - ? __internal_CheckoutProps - : T extends 'planDetails' - ? FlattenUnionType<__internal_PlanDetailsProps> + props: T extends 'checkout' + ? __internal_CheckoutProps + : T extends 'planDetails' + ? __internal_PlanDetailsProps
158-166: Revert planDetailsDrawer props to the strict union or add a runtime guardThe use of FlattenUnionType<__internal_PlanDetailsProps> turns both
planIdandplaninto optional keys, allowing{}as valid props. This means you can open the drawer with neither identifier, leading to an unrenderable state. You should either:
• Revert the state slice to use the original union type so TypeScript enforces at least one key at compile time
• Or add a runtime check in componentsControls.openDrawer('planDetails', …) to ensure exactly one ofplanIdorplanis providedLocations to update:
- packages/clerk-js/src/ui/Components.tsx (ComponentsState interface, around line 162)
- componentsControls.openDrawer implementation (around line 379)
Suggested diff for the state slice:
planDetailsDrawer: { open: false; - props: null | FlattenUnionType<__internal_PlanDetailsProps>; + props: null | __internal_PlanDetailsProps; };And, if you opt for runtime validation, wrap calls to:
componentsControls.openDrawer('planDetails', props);with a check such as:
if (!('planId' in props) === !('plan' in props)) { throw new Error('Must provide exactly one of planId or plan'); } componentsControls.openDrawer('planDetails', props);
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (7)
.changeset/shaky-sloths-unite.md(1 hunks)packages/clerk-js/src/ui/Components.tsx(3 hunks)packages/clerk-js/src/ui/components/Plans/PlanDetails.tsx(3 hunks)packages/clerk-js/src/ui/lazyModules/MountedPlanDetailDrawer.tsx(2 hunks)packages/clerk-js/src/ui/lazyModules/providers.tsx(1 hunks)packages/types/src/clerk.ts(2 hunks)packages/types/src/utils.ts(1 hunks)
🧰 Additional context used
📓 Path-based instructions (11)
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 always be camelCase
Use element descriptors in UI components to enable consistent theming and styling via appearance.elements
Element descriptors should generate unique, stable CSS classes for theming
Element descriptors should handle state classes (e.g., cl-loading, cl-active, cl-error, cl-open) automatically based on component state
Do not render hard-coded values; all user-facing strings must be localized using provided localization methods
Use the useLocalizations hook and localizationKeys utility for all text and error messages
Use the styled system (sx prop, theme tokens, responsive values) for custom component styling
Use useCardState for card-level state, useFormState for form-level state, and useLoadingStatus for loading states
Always use handleError utility for API errors and use translateError for localized error messages
Use useFormControl for form field state, implement proper validation, and handle loading and error states in forms
Use localization keys for all form labels and placeholders
Use element descriptors for consistent styling and follow the theme token system
Use the Card and FormContainer patterns for consistent UI structure
Files:
packages/clerk-js/src/ui/lazyModules/providers.tsxpackages/clerk-js/src/ui/lazyModules/MountedPlanDetailDrawer.tsxpackages/clerk-js/src/ui/Components.tsxpackages/clerk-js/src/ui/components/Plans/PlanDetails.tsx
**/*.{js,jsx,ts,tsx}
📄 CodeRabbit Inference Engine (.cursor/rules/development.mdc)
**/*.{js,jsx,ts,tsx}: All code must pass ESLint checks with the project's configuration
Follow established naming conventions (PascalCase for components, camelCase for variables)
Maintain comprehensive JSDoc comments for public APIs
Use dynamic imports for optional features
All public APIs must be documented with JSDoc
Provide meaningful error messages to developers
Include error recovery suggestions where applicable
Log errors appropriately for debugging
Lazy load components and features when possible
Implement proper caching strategies
Use efficient data structures and algorithms
Profile and optimize critical paths
Validate all inputs and sanitize outputs
Implement proper logging with different levels
Files:
packages/clerk-js/src/ui/lazyModules/providers.tsxpackages/clerk-js/src/ui/lazyModules/MountedPlanDetailDrawer.tsxpackages/clerk-js/src/ui/Components.tsxpackages/clerk-js/src/ui/components/Plans/PlanDetails.tsxpackages/types/src/clerk.tspackages/types/src/utils.ts
**/*.{js,jsx,ts,tsx,json,css,scss,md,yaml,yml}
📄 CodeRabbit Inference Engine (.cursor/rules/development.mdc)
Use Prettier for consistent code formatting
Files:
packages/clerk-js/src/ui/lazyModules/providers.tsxpackages/clerk-js/src/ui/lazyModules/MountedPlanDetailDrawer.tsxpackages/clerk-js/src/ui/Components.tsxpackages/clerk-js/src/ui/components/Plans/PlanDetails.tsxpackages/types/src/clerk.tspackages/types/src/utils.ts
packages/**/*.{ts,tsx}
📄 CodeRabbit Inference Engine (.cursor/rules/development.mdc)
TypeScript is required for all packages
Files:
packages/clerk-js/src/ui/lazyModules/providers.tsxpackages/clerk-js/src/ui/lazyModules/MountedPlanDetailDrawer.tsxpackages/clerk-js/src/ui/Components.tsxpackages/clerk-js/src/ui/components/Plans/PlanDetails.tsxpackages/types/src/clerk.tspackages/types/src/utils.ts
packages/**/*.{ts,tsx,d.ts}
📄 CodeRabbit Inference Engine (.cursor/rules/development.mdc)
Packages should export TypeScript types alongside runtime code
Files:
packages/clerk-js/src/ui/lazyModules/providers.tsxpackages/clerk-js/src/ui/lazyModules/MountedPlanDetailDrawer.tsxpackages/clerk-js/src/ui/Components.tsxpackages/clerk-js/src/ui/components/Plans/PlanDetails.tsxpackages/types/src/clerk.tspackages/types/src/utils.ts
**/*.{ts,tsx}
📄 CodeRabbit Inference Engine (.cursor/rules/development.mdc)
Use proper TypeScript error types
**/*.{ts,tsx}: Always define explicit return types for functions, especially public APIs
Use proper type annotations for variables and parameters where inference isn't clear
Avoidanytype - preferunknownwhen type is uncertain, then narrow with type guards
Useinterfacefor object shapes that might be extended
Usetypefor unions, primitives, and computed types
Preferreadonlyproperties for immutable data structures
Useprivatefor internal implementation details
Useprotectedfor inheritance hierarchies
Usepublicexplicitly for clarity in public APIs
Preferreadonlyfor properties that shouldn't change after construction
Prefer composition and interfaces over deep inheritance chains
Use mixins for shared behavior across unrelated classes
Implement dependency injection for loose coupling
Let TypeScript infer when types are obvious
Useconst assertionsfor literal types:as const
Usesatisfiesoperator for type checking without widening
Use mapped types for transforming object types
Use conditional types for type-level logic
Leverage template literal types for string manipulation
Use ES6 imports/exports consistently
Use default exports sparingly, prefer named exports
Use type-only imports:import type { ... } from ...
Noanytypes without justification
Proper error handling with typed errors
Consistent use ofreadonlyfor immutable data
Proper generic constraints
No unused type parameters
Proper use of utility types instead of manual type construction
Type-only imports where possible
Proper tree-shaking friendly exports
No circular dependencies
Efficient type computations (avoid deep recursion)
Files:
packages/clerk-js/src/ui/lazyModules/providers.tsxpackages/clerk-js/src/ui/lazyModules/MountedPlanDetailDrawer.tsxpackages/clerk-js/src/ui/Components.tsxpackages/clerk-js/src/ui/components/Plans/PlanDetails.tsxpackages/types/src/clerk.tspackages/types/src/utils.ts
**/*.{jsx,tsx}
📄 CodeRabbit Inference Engine (.cursor/rules/development.mdc)
**/*.{jsx,tsx}: Use error boundaries in React components
Minimize re-renders in React components
**/*.{jsx,tsx}: Always use functional components with hooks instead of class components
Follow PascalCase naming for components: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
Use useState for simple state management
Use useReducer for complex state logic
Implement proper state initialization
Use proper state updates with callbacks
Implement proper state cleanup
Use Context API for theme/authentication
Implement proper state selectors
Use proper state normalization
Implement proper state persistence
Use React.memo for expensive components
Implement proper useCallback for handlers
Use proper useMemo for expensive computations
Implement proper virtualization for lists
Use proper code splitting with React.lazy
Implement proper cleanup in useEffect
Use proper refs for DOM access
Implement proper event listener cleanup
Use proper abort controllers for fetch
Implement proper subscription cleanup
Use proper HTML elements
Implement proper ARIA attributes
Use proper heading hierarchy
Implement proper form labels
Use proper button types
Implement proper focus management
Use proper keyboard shortcuts
Implement proper tab order
Use proper skip links
Implement proper focus traps
Implement proper error boundaries
Use proper error logging
Implement proper error recovery
Use proper error messages
Implement proper error fallbacks
Use proper form validation
Implement proper error states
Use proper error messages
Implement proper form submission
Use proper form reset
Use proper component naming
Implement proper file naming
Use proper prop naming
Implement proper...
Files:
packages/clerk-js/src/ui/lazyModules/providers.tsxpackages/clerk-js/src/ui/lazyModules/MountedPlanDetailDrawer.tsxpackages/clerk-js/src/ui/Components.tsxpackages/clerk-js/src/ui/components/Plans/PlanDetails.tsx
**/*.{js,ts,tsx,jsx}
📄 CodeRabbit Inference Engine (.cursor/rules/monorepo.mdc)
Support multiple Clerk environment variables (CLERK_, NEXT_PUBLIC_CLERK_, etc.) for configuration.
Files:
packages/clerk-js/src/ui/lazyModules/providers.tsxpackages/clerk-js/src/ui/lazyModules/MountedPlanDetailDrawer.tsxpackages/clerk-js/src/ui/Components.tsxpackages/clerk-js/src/ui/components/Plans/PlanDetails.tsxpackages/types/src/clerk.tspackages/types/src/utils.ts
**/*.tsx
📄 CodeRabbit Inference Engine (.cursor/rules/react.mdc)
**/*.tsx: Use proper type definitions for props and state
Leverage TypeScript's type inference where possible
Use proper event types for handlers
Implement proper generic types for reusable components
Use proper type guards for conditional rendering
Files:
packages/clerk-js/src/ui/lazyModules/providers.tsxpackages/clerk-js/src/ui/lazyModules/MountedPlanDetailDrawer.tsxpackages/clerk-js/src/ui/Components.tsxpackages/clerk-js/src/ui/components/Plans/PlanDetails.tsx
**/*
⚙️ CodeRabbit Configuration File
If there are no tests added or modified as part of the PR, please suggest that tests be added to cover the changes.
Files:
packages/clerk-js/src/ui/lazyModules/providers.tsxpackages/clerk-js/src/ui/lazyModules/MountedPlanDetailDrawer.tsxpackages/clerk-js/src/ui/Components.tsxpackages/clerk-js/src/ui/components/Plans/PlanDetails.tsxpackages/types/src/clerk.tspackages/types/src/utils.ts
.changeset/**
📄 CodeRabbit Inference Engine (.cursor/rules/monorepo.mdc)
Automated releases must use Changesets.
Files:
.changeset/shaky-sloths-unite.md
🧬 Code Graph Analysis (4)
packages/clerk-js/src/ui/lazyModules/providers.tsx (1)
packages/clerk-js/src/ui/lazyModules/components.ts (1)
ClerkComponents(132-159)
packages/clerk-js/src/ui/lazyModules/MountedPlanDetailDrawer.tsx (2)
packages/types/src/utils.ts (1)
FlattenUnionType(147-147)packages/types/src/clerk.ts (1)
__internal_PlanDetailsProps(1889-1904)
packages/clerk-js/src/ui/Components.tsx (2)
packages/types/src/utils.ts (1)
FlattenUnionType(147-147)packages/types/src/clerk.ts (1)
__internal_PlanDetailsProps(1889-1904)
packages/clerk-js/src/ui/components/Plans/PlanDetails.tsx (3)
packages/clerk-js/src/ui/lazyModules/components.ts (1)
PlanDetails(112-114)packages/types/src/utils.ts (1)
FlattenUnionType(147-147)packages/types/src/clerk.ts (1)
__internal_PlanDetailsProps(1889-1904)
⏰ 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). (1)
- GitHub Check: semgrep-cloud-platform/scan
🔇 Additional comments (10)
packages/types/src/utils.ts (4)
117-119: LGTM! Standard TypeScript utility pattern.The
UnionToIntersectiontype implementation correctly uses the contravariant position pattern to convert union types to intersection types, which is a well-established TypeScript technique.
121-129: Excellent recursive type implementation.The
FlattenUnionTypeInternaltype correctly handles the complex logic of flattening union types:
- Preserves arrays as-is (line 123-124)
- Recursively processes nested objects (line 126)
- Properly marks properties as potentially undefined when they don't exist in all union members (line 128)
132-136: Perfect undefined-to-optional conversion logic.The
UndefinedToOptionaltype correctly separates properties into optional and required based on whether they includeundefinedin their type, and properly excludesundefinedfrom the optional property types.
138-147: Excellent documentation and implementation.The JSDoc documentation is comprehensive and the example clearly demonstrates the utility type's behavior. The final export properly chains together all the helper types to achieve the desired flattening behavior.
packages/types/src/clerk.ts (2)
1889-1904: Excellent type safety improvement.The conversion to a union type properly enforces that either
planIdorplanmust be provided, eliminating the ambiguous state where neither is specified. The intersection with additional optional properties maintains backward compatibility.
1916-1933: Consistent type design across experimental API.The
__experimental_PlanDetailsButtonPropsfollows the same union type pattern as__internal_PlanDetailsProps, ensuring consistency in the API design while maintaining the same type safety benefits..changeset/shaky-sloths-unite.md (1)
1-9: Appropriate changeset documentation.The changeset correctly identifies this as a minor version bump across all affected packages and accurately describes the core change to
PlanDetailsPropstype constraints.packages/clerk-js/src/ui/lazyModules/MountedPlanDetailDrawer.tsx (2)
2-2: Clean import addition.The addition of
FlattenUnionTypeto the existing import is necessary for the type update and maintains good import organization.
16-16: Correct adaptation to union type structure.Using
FlattenUnionType<__internal_PlanDetailsProps>properly handles the new union type structure, ensuring all properties are accessible with appropriate optionality while maintaining the null possibility for closed drawer state.packages/clerk-js/src/ui/components/Plans/PlanDetails.tsx (1)
73-89: Avoid@ts-expect-error– pass a non-nullable id togetPlansafely
clerk.billing.getPlanexpects{ id: string }, but the current code suppresses
type-checking and may still attempt anundefinedid if both props are empty
(contradiction introduced by the flattening above).-() => clerk.billing.getPlan({ id: planId || initialPlan?.id }), +() => clerk.billing.getPlan({ id: (planId ?? initialPlan!.id) }),• The non-null assertion is safe because this fetcher is only executed when the
SWR key is truthy (planId || initialPlan?.id).
• Removing the@ts-expect-errorretains full type safety.[ suggest_nitpick ]
@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: |
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (3)
packages/react/src/components/PlanDetailsButton.tsx (3)
1-1: Use type-only import for FlattenUnionType.Since
FlattenUnionTypeis only used for type casting and not at runtime, it should be imported as a type-only import for better tree-shaking.-import type { __experimental_PlanDetailsButtonProps, FlattenUnionType } from '@clerk/types'; +import type { __experimental_PlanDetailsButtonProps, type FlattenUnionType } from '@clerk/types';
38-39: Type casting approach is sound but consider runtime validation.The explicit casting to
FlattenUnionType<__experimental_PlanDetailsButtonProps>correctly handles the union type constraint, allowing for easier property access. This aligns well with the PR's objective to enforce stricter prop requirements.However, since TypeScript's type system is erased at runtime, consider adding runtime validation to ensure either
planIdorplanis provided, especially given this is an experimental API.Consider adding runtime validation:
const { plan, planId, initialPlanPeriod, planDetailsProps, ...rest } = props as FlattenUnionType<__experimental_PlanDetailsButtonProps>; if (!plan && !planId) { throw new Error('PlanDetailsButton: Either planId or plan must be provided'); }
36-68: Add tests to cover the stricter type constraints.Since this PR introduces stricter type requirements and uses type casting, tests should be added to ensure the component works correctly with both
planIdandplanproperties, and that the union type constraint is properly enforced.Consider adding tests for:
- Component renders correctly with
planIdprovided- Component renders correctly with
planobject provided- Component behavior when neither is provided (should ideally throw/fail gracefully)
- Click handler calls the correct internal API with proper parameters
Would you like me to generate test cases for these scenarios?
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
packages/react/src/components/PlanDetailsButton.tsx(3 hunks)
🧰 Additional context used
📓 Path-based instructions (9)
**/*.{js,jsx,ts,tsx}
📄 CodeRabbit Inference Engine (.cursor/rules/development.mdc)
**/*.{js,jsx,ts,tsx}: All code must pass ESLint checks with the project's configuration
Follow established naming conventions (PascalCase for components, camelCase for variables)
Maintain comprehensive JSDoc comments for public APIs
Use dynamic imports for optional features
All public APIs must be documented with JSDoc
Provide meaningful error messages to developers
Include error recovery suggestions where applicable
Log errors appropriately for debugging
Lazy load components and features when possible
Implement proper caching strategies
Use efficient data structures and algorithms
Profile and optimize critical paths
Validate all inputs and sanitize outputs
Implement proper logging with different levels
Files:
packages/react/src/components/PlanDetailsButton.tsx
**/*.{js,jsx,ts,tsx,json,css,scss,md,yaml,yml}
📄 CodeRabbit Inference Engine (.cursor/rules/development.mdc)
Use Prettier for consistent code formatting
Files:
packages/react/src/components/PlanDetailsButton.tsx
packages/**/*.{ts,tsx}
📄 CodeRabbit Inference Engine (.cursor/rules/development.mdc)
TypeScript is required for all packages
Files:
packages/react/src/components/PlanDetailsButton.tsx
packages/**/*.{ts,tsx,d.ts}
📄 CodeRabbit Inference Engine (.cursor/rules/development.mdc)
Packages should export TypeScript types alongside runtime code
Files:
packages/react/src/components/PlanDetailsButton.tsx
**/*.{ts,tsx}
📄 CodeRabbit Inference Engine (.cursor/rules/development.mdc)
Use proper TypeScript error types
**/*.{ts,tsx}: Always define explicit return types for functions, especially public APIs
Use proper type annotations for variables and parameters where inference isn't clear
Avoidanytype - preferunknownwhen type is uncertain, then narrow with type guards
Useinterfacefor object shapes that might be extended
Usetypefor unions, primitives, and computed types
Preferreadonlyproperties for immutable data structures
Useprivatefor internal implementation details
Useprotectedfor inheritance hierarchies
Usepublicexplicitly for clarity in public APIs
Preferreadonlyfor properties that shouldn't change after construction
Prefer composition and interfaces over deep inheritance chains
Use mixins for shared behavior across unrelated classes
Implement dependency injection for loose coupling
Let TypeScript infer when types are obvious
Useconst assertionsfor literal types:as const
Usesatisfiesoperator for type checking without widening
Use mapped types for transforming object types
Use conditional types for type-level logic
Leverage template literal types for string manipulation
Use ES6 imports/exports consistently
Use default exports sparingly, prefer named exports
Use type-only imports:import type { ... } from ...
Noanytypes without justification
Proper error handling with typed errors
Consistent use ofreadonlyfor immutable data
Proper generic constraints
No unused type parameters
Proper use of utility types instead of manual type construction
Type-only imports where possible
Proper tree-shaking friendly exports
No circular dependencies
Efficient type computations (avoid deep recursion)
Files:
packages/react/src/components/PlanDetailsButton.tsx
**/*.{jsx,tsx}
📄 CodeRabbit Inference Engine (.cursor/rules/development.mdc)
**/*.{jsx,tsx}: Use error boundaries in React components
Minimize re-renders in React components
**/*.{jsx,tsx}: Always use functional components with hooks instead of class components
Follow PascalCase naming for components: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
Use useState for simple state management
Use useReducer for complex state logic
Implement proper state initialization
Use proper state updates with callbacks
Implement proper state cleanup
Use Context API for theme/authentication
Implement proper state selectors
Use proper state normalization
Implement proper state persistence
Use React.memo for expensive components
Implement proper useCallback for handlers
Use proper useMemo for expensive computations
Implement proper virtualization for lists
Use proper code splitting with React.lazy
Implement proper cleanup in useEffect
Use proper refs for DOM access
Implement proper event listener cleanup
Use proper abort controllers for fetch
Implement proper subscription cleanup
Use proper HTML elements
Implement proper ARIA attributes
Use proper heading hierarchy
Implement proper form labels
Use proper button types
Implement proper focus management
Use proper keyboard shortcuts
Implement proper tab order
Use proper skip links
Implement proper focus traps
Implement proper error boundaries
Use proper error logging
Implement proper error recovery
Use proper error messages
Implement proper error fallbacks
Use proper form validation
Implement proper error states
Use proper error messages
Implement proper form submission
Use proper form reset
Use proper component naming
Implement proper file naming
Use proper prop naming
Implement proper...
Files:
packages/react/src/components/PlanDetailsButton.tsx
**/*.{js,ts,tsx,jsx}
📄 CodeRabbit Inference Engine (.cursor/rules/monorepo.mdc)
Support multiple Clerk environment variables (CLERK_, NEXT_PUBLIC_CLERK_, etc.) for configuration.
Files:
packages/react/src/components/PlanDetailsButton.tsx
**/*.tsx
📄 CodeRabbit Inference Engine (.cursor/rules/react.mdc)
**/*.tsx: Use proper type definitions for props and state
Leverage TypeScript's type inference where possible
Use proper event types for handlers
Implement proper generic types for reusable components
Use proper type guards for conditional rendering
Files:
packages/react/src/components/PlanDetailsButton.tsx
**/*
⚙️ CodeRabbit Configuration File
If there are no tests added or modified as part of the PR, please suggest that tests be added to cover the changes.
Files:
packages/react/src/components/PlanDetailsButton.tsx
🧬 Code Graph Analysis (1)
packages/react/src/components/PlanDetailsButton.tsx (4)
packages/types/src/utils.ts (1)
FlattenUnionType(147-147)packages/types/src/clerk.ts (1)
__experimental_PlanDetailsButtonProps(1916-1933)packages/nextjs/src/experimental.ts (1)
__experimental_PlanDetailsButtonProps(8-8)packages/react/src/experimental.ts (1)
__experimental_PlanDetailsButtonProps(8-8)
⏰ 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: Formatting | Dedupe | Changeset
- GitHub Check: Build Packages
- GitHub Check: semgrep/ci
- GitHub Check: Analyze (javascript-typescript)
panteliselef
force-pushed
the
elef/flatten-union-plan-details
branch
from
b328259 to
e0d398d
Compare
Description
Update
PlanDetailsPropsto reflect that eitherplanIdorplanis allowed.To support similar cases in the future, I've added a new Typescript utility type called
FlattenUnionTypethat accepts an union type of objects. All the shared properties are kept intact, the different properties are added to the output type as optional and undefined.Example
Checklist
pnpm testruns as expected.pnpm buildruns as expected.Type of change
Summary by CodeRabbit
New Features
Bug Fixes
Tests
Style