chore(clerk-js, types): Cleanup naming inconsistencies in billing dates #6513
Conversation
🦋 Changeset detectedLatest commit: c07fbc6 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 ↗︎
|
@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: |
📝 WalkthroughWalkthroughThis change renames and consolidates subscription date fields across types, core resources, UI, and tests: periodStartDate → periodStart (Date), periodEndDate → periodEnd (Date | null), and canceledAtDate → canceledAt (Date | null). Numeric alias fields were removed and JSON parsing updated (period_end is now number | null and converted to Date). UI components (PricingTable, SubscriptionDetails, SubscriptionsList, Plans) and tests were updated to use the new names. A new internal SubscriptionCard component was added to centralize subscription-detail rendering. Estimated code review effort🎯 3 (Moderate) | ⏱️ ~25 minutes Possibly related PRs
Suggested reviewers
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous 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). (5)
🪧 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: 4
🔭 Outside diff range comments (1)
packages/types/src/commerce.ts (1)
1041-1059: Update remaining legacy field referencesThe grep results show leftover mentions of the old
*Dateproperties in your CHANGELOGs and UI code. Please update these to the new field names:• packages/types/CHANGELOG.md (lines 209–211)
- Change
subscription.periodStartDate→subscription.periodStart- Change
subscription.periodEndDate→subscription.periodEnd- Change
subscription.canceledAtDate→subscription.canceledAt• packages/clerk-js/CHANGELOG.md (lines 361–363)
- Same replacements as above
• packages/clerk-js/src/ui/contexts/components/Plans.tsx (line 274)
- // @ts-expect-error `periodEndDate` is always defined when `canceledAtDate` exists + // @ts-expect-error `periodEnd` is always defined when `canceledAt` exists(Also update any code references to
subscription.periodEndDateandsubscription.canceledAtDateto usesubscription.periodEndandsubscription.canceledAt.)Once these are updated, the migration will be complete. Consider adding the suggested JSDoc comments on
periodStart,periodEnd, andcanceledAtto document their nullability and semantics.
🧹 Nitpick comments (1)
packages/clerk-js/src/ui/components/SubscriptionDetails/index.tsx (1)
342-344: Cancellation/re-subscription gating: verify invariantsLogic now keys off
canceledAt(Date | null). This looks correct given the model, but please verify:
- Is a subscription ever reactivated while
canceledAtremains non-null?- Should
isReSubscribablealso considerstatus(e.g., only after term ends)?- Add tests covering active-but-canceled (pending end-of-term) vs fully ended.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (10)
.changeset/brown-news-unite.md(1 hunks)packages/clerk-js/src/core/resources/CommerceSubscription.ts(2 hunks)packages/clerk-js/src/ui/components/PricingTable/PricingTable.tsx(1 hunks)packages/clerk-js/src/ui/components/PricingTable/PricingTableDefault.tsx(2 hunks)packages/clerk-js/src/ui/components/SubscriptionDetails/__tests__/SubscriptionDetails.test.tsx(11 hunks)packages/clerk-js/src/ui/components/SubscriptionDetails/index.tsx(4 hunks)packages/clerk-js/src/ui/components/Subscriptions/SubscriptionsList.tsx(1 hunks)packages/clerk-js/src/ui/contexts/components/Plans.tsx(5 hunks)packages/types/src/commerce.ts(3 hunks)packages/types/src/json.ts(1 hunks)
🧰 Additional context used
📓 Path-based instructions (15)
.changeset/**
📄 CodeRabbit Inference Engine (.cursor/rules/monorepo.mdc)
Automated releases must use Changesets.
Files:
.changeset/brown-news-unite.md
**/*.{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/core/resources/CommerceSubscription.tspackages/clerk-js/src/ui/components/SubscriptionDetails/__tests__/SubscriptionDetails.test.tsxpackages/clerk-js/src/ui/components/SubscriptionDetails/index.tsxpackages/clerk-js/src/ui/components/Subscriptions/SubscriptionsList.tsxpackages/types/src/json.tspackages/clerk-js/src/ui/components/PricingTable/PricingTable.tsxpackages/clerk-js/src/ui/contexts/components/Plans.tsxpackages/clerk-js/src/ui/components/PricingTable/PricingTableDefault.tsxpackages/types/src/commerce.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/core/resources/CommerceSubscription.tspackages/clerk-js/src/ui/components/SubscriptionDetails/__tests__/SubscriptionDetails.test.tsxpackages/clerk-js/src/ui/components/SubscriptionDetails/index.tsxpackages/clerk-js/src/ui/components/Subscriptions/SubscriptionsList.tsxpackages/types/src/json.tspackages/clerk-js/src/ui/components/PricingTable/PricingTable.tsxpackages/clerk-js/src/ui/contexts/components/Plans.tsxpackages/clerk-js/src/ui/components/PricingTable/PricingTableDefault.tsxpackages/types/src/commerce.ts
packages/**/*.{ts,tsx}
📄 CodeRabbit Inference Engine (.cursor/rules/development.mdc)
TypeScript is required for all packages
Files:
packages/clerk-js/src/core/resources/CommerceSubscription.tspackages/clerk-js/src/ui/components/SubscriptionDetails/__tests__/SubscriptionDetails.test.tsxpackages/clerk-js/src/ui/components/SubscriptionDetails/index.tsxpackages/clerk-js/src/ui/components/Subscriptions/SubscriptionsList.tsxpackages/types/src/json.tspackages/clerk-js/src/ui/components/PricingTable/PricingTable.tsxpackages/clerk-js/src/ui/contexts/components/Plans.tsxpackages/clerk-js/src/ui/components/PricingTable/PricingTableDefault.tsxpackages/types/src/commerce.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/core/resources/CommerceSubscription.tspackages/clerk-js/src/ui/components/SubscriptionDetails/__tests__/SubscriptionDetails.test.tsxpackages/clerk-js/src/ui/components/SubscriptionDetails/index.tsxpackages/clerk-js/src/ui/components/Subscriptions/SubscriptionsList.tsxpackages/types/src/json.tspackages/clerk-js/src/ui/components/PricingTable/PricingTable.tsxpackages/clerk-js/src/ui/contexts/components/Plans.tsxpackages/clerk-js/src/ui/components/PricingTable/PricingTableDefault.tsxpackages/types/src/commerce.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/core/resources/CommerceSubscription.tspackages/clerk-js/src/ui/components/SubscriptionDetails/__tests__/SubscriptionDetails.test.tsxpackages/clerk-js/src/ui/components/SubscriptionDetails/index.tsxpackages/clerk-js/src/ui/components/Subscriptions/SubscriptionsList.tsxpackages/types/src/json.tspackages/clerk-js/src/ui/components/PricingTable/PricingTable.tsxpackages/clerk-js/src/ui/contexts/components/Plans.tsxpackages/clerk-js/src/ui/components/PricingTable/PricingTableDefault.tsxpackages/types/src/commerce.ts
**/*.{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/core/resources/CommerceSubscription.tspackages/clerk-js/src/ui/components/SubscriptionDetails/__tests__/SubscriptionDetails.test.tsxpackages/clerk-js/src/ui/components/SubscriptionDetails/index.tsxpackages/clerk-js/src/ui/components/Subscriptions/SubscriptionsList.tsxpackages/types/src/json.tspackages/clerk-js/src/ui/components/PricingTable/PricingTable.tsxpackages/clerk-js/src/ui/contexts/components/Plans.tsxpackages/clerk-js/src/ui/components/PricingTable/PricingTableDefault.tsxpackages/types/src/commerce.ts
**/*
⚙️ 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/core/resources/CommerceSubscription.tspackages/clerk-js/src/ui/components/SubscriptionDetails/__tests__/SubscriptionDetails.test.tsxpackages/clerk-js/src/ui/components/SubscriptionDetails/index.tsxpackages/clerk-js/src/ui/components/Subscriptions/SubscriptionsList.tsxpackages/types/src/json.tspackages/clerk-js/src/ui/components/PricingTable/PricingTable.tsxpackages/clerk-js/src/ui/contexts/components/Plans.tsxpackages/clerk-js/src/ui/components/PricingTable/PricingTableDefault.tsxpackages/types/src/commerce.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 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/components/SubscriptionDetails/__tests__/SubscriptionDetails.test.tsxpackages/clerk-js/src/ui/components/SubscriptionDetails/index.tsxpackages/clerk-js/src/ui/components/Subscriptions/SubscriptionsList.tsxpackages/clerk-js/src/ui/components/PricingTable/PricingTable.tsxpackages/clerk-js/src/ui/contexts/components/Plans.tsxpackages/clerk-js/src/ui/components/PricingTable/PricingTableDefault.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/clerk-js/src/ui/components/SubscriptionDetails/__tests__/SubscriptionDetails.test.tsxpackages/clerk-js/src/ui/components/SubscriptionDetails/index.tsxpackages/clerk-js/src/ui/components/Subscriptions/SubscriptionsList.tsxpackages/clerk-js/src/ui/components/PricingTable/PricingTable.tsxpackages/clerk-js/src/ui/contexts/components/Plans.tsxpackages/clerk-js/src/ui/components/PricingTable/PricingTableDefault.tsx
packages/**/*.{test,spec}.{js,jsx,ts,tsx}
📄 CodeRabbit Inference Engine (.cursor/rules/monorepo.mdc)
Unit tests should use Jest or Vitest as the test runner.
Files:
packages/clerk-js/src/ui/components/SubscriptionDetails/__tests__/SubscriptionDetails.test.tsx
packages/{clerk-js,elements,themes}/**/*.{test,spec}.{js,jsx,ts,tsx}
📄 CodeRabbit Inference Engine (.cursor/rules/monorepo.mdc)
Visual regression testing should be performed for UI components.
Files:
packages/clerk-js/src/ui/components/SubscriptionDetails/__tests__/SubscriptionDetails.test.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/clerk-js/src/ui/components/SubscriptionDetails/__tests__/SubscriptionDetails.test.tsxpackages/clerk-js/src/ui/components/SubscriptionDetails/index.tsxpackages/clerk-js/src/ui/components/Subscriptions/SubscriptionsList.tsxpackages/clerk-js/src/ui/components/PricingTable/PricingTable.tsxpackages/clerk-js/src/ui/contexts/components/Plans.tsxpackages/clerk-js/src/ui/components/PricingTable/PricingTableDefault.tsx
**/*.test.{jsx,tsx}
📄 CodeRabbit Inference Engine (.cursor/rules/react.mdc)
**/*.test.{jsx,tsx}: Use React Testing Library
Test component behavior, not implementation
Use proper test queries
Implement proper test isolation
Use proper test coverage
Test component interactions
Use proper test data
Implement proper test setup
Use proper test cleanup
Implement proper test assertions
Use proper test structure
Files:
packages/clerk-js/src/ui/components/SubscriptionDetails/__tests__/SubscriptionDetails.test.tsx
**/__tests__/**/*.{ts,tsx}
📄 CodeRabbit Inference Engine (.cursor/rules/typescript.mdc)
**/__tests__/**/*.{ts,tsx}: Create type-safe test builders/factories
Use branded types for test isolation
Implement proper mock types that match interfaces
Files:
packages/clerk-js/src/ui/components/SubscriptionDetails/__tests__/SubscriptionDetails.test.tsx
🧬 Code Graph Analysis (1)
packages/clerk-js/src/ui/components/SubscriptionDetails/index.tsx (1)
packages/clerk-js/src/ui/utils/formatDate.ts (1)
formatDate(1-13)
⏰ 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: Formatting | Dedupe | Changeset
- GitHub Check: Build Packages
- GitHub Check: semgrep/ci
- GitHub Check: Analyze (javascript-typescript)
- GitHub Check: semgrep-cloud-platform/scan
🔇 Additional comments (12)
packages/types/src/json.ts (1)
780-784: Audit and update backend JSON types for nullable datesThe DTO now allows
period_end,canceled_at, andpast_due_atto benull. Please adjust the corresponding definitions and mappings, and verify UI/tests guard againstnull.• In
packages/backend/src/api/resources/JSON.ts, update the JSON shape:- period_end?: number; - canceled_at?: number; - past_due_at?: number; + period_end: number | null; + canceled_at: number | null; + past_due_at: number | null;• Confirm resource mapping in
packages/clerk-js/src/core/resources/CommerceSubscription.tshandlesnullexplicitly (consider usingdata.period_end != nullrather than a truthy check).
• Audit all UI components and tests that display “renews at”/“ends on” to ensure they correctly handlenulldates.Likely an incorrect or invalid review comment.
packages/clerk-js/src/ui/components/Subscriptions/SubscriptionsList.tsx (1)
123-125: Switched to canceledAt: looks correctUsing
subscription.canceledAtfor badge visibility aligns with the new types and preserves the original behavior.packages/clerk-js/src/ui/components/PricingTable/PricingTable.tsx (1)
28-29: Active selection predicate updated: LGTMFiltering out canceled active subscriptions via
!sub.canceledAtis correct and consistent with the new field shape.packages/clerk-js/src/ui/components/PricingTable/PricingTableDefault.tsx (2)
144-154: Footer visibility logic: updated to canceledAt — goodSwitching to
subscription.canceledAtkeeps the intent intact for active subscriptions.
231-237: Starts-at badge uses periodStart — goodUsing
subscription.periodStartfor the “starts at” notice is consistent with the new date fields.packages/clerk-js/src/ui/components/SubscriptionDetails/__tests__/SubscriptionDetails.test.tsx (1)
71-74: Tests migrated to new field names — solid coverageFixtures consistently use
periodStart,periodEnd, andcanceledAt. Scenarios exercise active/upcoming/free/past-due plus cancel/resubscribe. Looks good.Also applies to: 164-167, 249-252, 357-371, 368-371, 489-492, 585-588, 671-674, 759-761, 865-868
packages/clerk-js/src/ui/contexts/components/Plans.tsx (3)
132-133: Default-plan implicit activity check updated — OKUsing
!subscription.canceledAtto detect any non-canceled subscriptions is consistent with the new field shape.
181-182: canManageSubscription predicate updated — OKReturning false when
subscription.canceledAtis set matches the previous intent.
215-229: CTA labeling logic updated to canceledAt — OKLabel derivation using
subscription.canceledAtfor re-subscribe/switch flows aligns with the new types.packages/clerk-js/src/ui/components/SubscriptionDetails/index.tsx (3)
526-534: LGTM: end-of-term labeling and date source are correctCorrectly switches label between endsOn/renewsAt and uses
periodEndguarded by null. Matches the new Date-based model.
542-543: LGTM: upcoming subscription beginsOn uses periodStartUses
periodStartwith formatDate; aligns with model and localized rendering.
274-275: Avoid unsafe cast for nullable date; add a runtime guard
selectedSubscription.periodEnd as Dateassumes non-null. Even if currently guaranteed by state, a defensive guard prevents runtime crashes if upstream data changes.Minimal local change:
- date: selectedSubscription.periodEnd as Date, + date: selectedSubscription.periodEnd!,Additionally, add a guard before rendering the confirmation text (outside this hunk), for example:
const endDate = selectedSubscription?.periodEnd; if (selectedSubscription?.status !== 'upcoming' && !endDate) { // Unexpected; log and avoid rendering broken state handleError(new Error('Missing periodEnd for cancellation confirmation'), [], setError); return null; }If you prefer not to early-return, consider a localized fallback string when
endDateis missing.
| periodStart!: Date; | ||
| periodEnd!: Date | null; | ||
| canceledAt!: Date | null; |
There was a problem hiding this comment.
💡 Verification agent
🧩 Analysis chain
Public API rename: add JSDoc, confirm breaking-change handling
Great move consolidating to Date-based fields. Since these are public properties, please:
- Add JSDoc to clarify semantics and nullability.
- Confirm this is tracked as a breaking change in the changeset and docs.
- Optional: consider temporary runtime getters for the old names to ease migration (types would still be removed).
Apply JSDoc locally:
createdAt!: Date;
- periodStart!: Date;
- periodEnd!: Date | null;
- canceledAt!: Date | null;
+ /**
+ * Start of the current billing period.
+ */
+ periodStart!: Date;
+ /**
+ * End of the current billing period (null for free plans or when not applicable).
+ */
+ periodEnd!: Date | null;
+ /**
+ * Timestamp when cancellation was requested/effective (null if not canceled).
+ */
+ canceledAt!: Date | null;If you want temporary runtime back-compat, add in this class (types remain removed):
// Deprecated runtime aliases (optional)
/** @deprecated Use periodStart */
get periodStartDate(): Date { return this.periodStart }
/** @deprecated Use periodEnd */
get periodEndDate(): Date | null { return this.periodEnd }
/** @deprecated Use canceledAt */
get canceledAtDate(): Date | null { return this.canceledAt }🏁 Script executed:
#!/usr/bin/env bash
set -e
printf "1) CommerceSubscription class definition:\n"
rg -n "class CommerceSubscription" -n packages/clerk-js/src/core/resources/CommerceSubscription.ts || echo "Not found"
printf "\n2) Date fields in CommerceSubscription:\n"
rg -nE "periodStart|periodEnd|canceledAt" -n packages/clerk-js/src/core/resources/CommerceSubscription.ts || echo "No matching fields"
printf "\n3) Changesets mentioning subscription:\n"
if [ -d ".changeset" ]; then
rg -i "subscription" -n .changeset || echo "No references in .changeset"
else
echo "No .changeset directory found"
fi
printf "\n4) Documentation mentions:\n"
if [ -d "docs" ]; then
rg -i "CommerceSubscription" -n docs || echo "No docs references"
else
echo "No docs directory found"
fiLength of output: 1125
Add JSDoc, update changeset, and docs for renamed subscription fields
Please apply the following to fully cover this public-API change:
• In packages/clerk-js/src/core/resources/CommerceSubscription.ts (around lines 65–67), add JSDoc to the new Date fields:
createdAt!: Date;
+ /**
+ * Start of the current billing period.
+ */
periodStart!: Date;
+ /**
+ * End of the current billing period (null when not applicable, e.g., free plan).
+ */
periodEnd!: Date | null;
+ /**
+ * Timestamp when cancellation was requested or effective (null if not canceled).
+ */
canceledAt!: Date | null;• Ensure you’ve created or updated a .changeset/…md entry under packages/clerk-js that calls out the breaking-change of these property renames and type updates.
• Update any public documentation or API reference to use periodStart, periodEnd, and canceledAt instead of the old fields.
Optional, for smoother migration you can add deprecated runtime getters:
/** @deprecated Use periodStart */
get periodStartDate(): Date { return this.periodStart }
/** @deprecated Use periodEnd */
get periodEndDate(): Date | null { return this.periodEnd }
/** @deprecated Use canceledAt */
get canceledAtDate(): Date | null { return this.canceledAt }🤖 Prompt for AI Agents
In packages/clerk-js/src/core/resources/CommerceSubscription.ts around lines
65–67, the newly renamed Date fields (periodStart, periodEnd, canceledAt) lack
JSDoc and the repo is missing a changeset and documentation updates for this
public-API break; add concise JSDoc comments above each field describing the
value and types (e.g., periodStart: subscription period start Date, periodEnd:
nullable subscription period end Date, canceledAt: nullable cancellation Date),
create or update a .changeset/*.md under packages/clerk-js documenting the
breaking change and migration notes, update public docs/API reference to use
periodStart/periodEnd/canceledAt instead of the old names, and optionally add
deprecated runtime getters (periodStartDate, periodEndDate, canceledAtDate) that
return the new fields to smooth migration.
| return localizationKeys('badge__startsAt', { date: subscription.periodStart }); | ||
| } | ||
| if (subscription.canceledAtDate) { | ||
| if (subscription.canceledAt) { | ||
| // @ts-expect-error `periodEndDate` is always defined when `canceledAtDate` exists | ||
| return localizationKeys('badge__canceledEndsAt', { date: subscription.periodEndDate }); | ||
| return localizationKeys('badge__canceledEndsAt', { date: subscription.periodEnd }); | ||
| } | ||
| if (subscription.periodEndDate) { | ||
| return localizationKeys('badge__renewsAt', { date: subscription.periodEndDate }); | ||
| if (subscription.periodEnd) { | ||
| return localizationKeys('badge__renewsAt', { date: subscription.periodEnd }); | ||
| } |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Remove stale ts-expect-error and add a type-safe guard
The @ts-expect-error comment references old names and hides a legitimate nullable type. Guard on periodEnd instead of suppressing types.
Apply:
- if (subscription.canceledAt) {
- // @ts-expect-error `periodEndDate` is always defined when `canceledAtDate` exists
- return localizationKeys('badge__canceledEndsAt', { date: subscription.periodEnd });
- }
+ if (subscription.canceledAt && subscription.periodEnd) {
+ return localizationKeys('badge__canceledEndsAt', { date: subscription.periodEnd });
+ }This reflects the new invariant and keeps the code type-safe.
📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| return localizationKeys('badge__startsAt', { date: subscription.periodStart }); | |
| } | |
| if (subscription.canceledAtDate) { | |
| if (subscription.canceledAt) { | |
| // @ts-expect-error `periodEndDate` is always defined when `canceledAtDate` exists | |
| return localizationKeys('badge__canceledEndsAt', { date: subscription.periodEndDate }); | |
| return localizationKeys('badge__canceledEndsAt', { date: subscription.periodEnd }); | |
| } | |
| if (subscription.periodEndDate) { | |
| return localizationKeys('badge__renewsAt', { date: subscription.periodEndDate }); | |
| if (subscription.periodEnd) { | |
| return localizationKeys('badge__renewsAt', { date: subscription.periodEnd }); | |
| } | |
| return localizationKeys('badge__startsAt', { date: subscription.periodStart }); | |
| } | |
| if (subscription.canceledAt && subscription.periodEnd) { | |
| return localizationKeys('badge__canceledEndsAt', { date: subscription.periodEnd }); | |
| } | |
| if (subscription.periodEnd) { | |
| return localizationKeys('badge__renewsAt', { date: subscription.periodEnd }); | |
| } |
🤖 Prompt for AI Agents
In packages/clerk-js/src/ui/contexts/components/Plans.tsx around lines 271 to
279, remove the stale "@ts-expect-error" and make the branch type-safe by
guarding on subscription.periodEnd (e.g. change the canceled branch to if
(subscription.canceledAt && subscription.periodEnd)) so you only access
periodEnd when it's defined; update the localization call to use the existing
periodEnd property and delete the obsolete comment.
Description
Checklist
pnpm testruns as expected.pnpm buildruns as expected.Type of change
Summary by CodeRabbit
New Features
Refactor
Bug Fixes
Chores