feat(clerk-js, types): Update billing resources with trial properties #6492
Conversation
🦋 Changeset detectedLatest commit: 6b21c1e 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 ↗︎
|
…esources-for-free-trials
@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 introduces new properties related to trial status in commerce subscription resources across multiple packages. Specifically, optional and required boolean properties indicating eligibility for free trials and trial status are added to TypeScript interfaces and classes in both the core logic and type definitions. These properties are also reflected in the corresponding JSON interfaces and are initialized during deserialization from JSON. Additionally, a changeset file is included to specify minor version updates for the affected packages and document the billing resource changes. Estimated code review effort🎯 2 (Simple) | ⏱️ ~7 minutes Note 🔌 MCP (Model Context Protocol) integration is now available in Early Access!Pro users can now connect to remote MCP servers under the Integrations page to get reviews and chat conversations that understand additional development context. 🪧 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: 2
🧹 Nitpick comments (5)
packages/types/src/json.ts (1)
813-814: Add brief field-level JSDoc to clarify semantics of eligibility.Consider documenting when
eligible_for_free_trialis true (e.g., org/user has never consumed trial for this product/plan) and whether it can beundefinedvsfalse. This helps integrators reason about UI state..changeset/sour-lemons-talk.md (1)
1-6: Be explicit in the changeset about new fields and scope.Consider naming the fields and affected resources for clearer release notes, e.g.:
-Update billing resources with trial properties. +Billing (experimental): add trial properties + +- `CommerceSubscriptionItem`: `isFreeTrial` (JSON: `is_free_trial`) +- `CommerceSubscription`: `eligibleForFreeTrial?` (JSON: `eligible_for_free_trial?`) + +These power trial-state UI and logic; map from snake_case JSON to camelCase resource props.packages/types/src/commerce.ts (2)
1109-1117: Clarify semantics ofisFreeTrialand ensure runtime always provides a boolean.Docs are currently generic. Add a one-liner like “True when this item is currently in a free trial period.” Also ensure deserialization defaults to
falseif the field is missing to honor the required type.If you keep it required here (preferred), the runtime mapping should use
data.is_free_trial ?? false.
1228-1236: Clarify semantics ofeligibleForFreeTrial?.Add a brief note: e.g., “Indicates whether the payer (org/user) is eligible to start a free trial on a plan. May be
undefinedwhen unknown/not applicable.” This disambiguatesundefinedvsfalsefor consumers.packages/clerk-js/src/core/resources/CommerceSubscription.ts (1)
30-31: Property addition LGTM; consider adding concise JSDoc on runtime props.
eligibleForFreeTrialis optional by design. Add a short JSDoc to mirror the types package and clarify when it’sundefinedvsfalsefor consumers.Also applies to: 55-56
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (4)
.changeset/sour-lemons-talk.md(1 hunks)packages/clerk-js/src/core/resources/CommerceSubscription.ts(4 hunks)packages/types/src/commerce.ts(2 hunks)packages/types/src/json.ts(2 hunks)
🧰 Additional context used
📓 Path-based instructions (8)
.changeset/**
📄 CodeRabbit Inference Engine (.cursor/rules/monorepo.mdc)
Automated releases must use Changesets.
Files:
.changeset/sour-lemons-talk.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/types/src/json.tspackages/types/src/commerce.tspackages/clerk-js/src/core/resources/CommerceSubscription.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/types/src/json.tspackages/types/src/commerce.tspackages/clerk-js/src/core/resources/CommerceSubscription.ts
packages/**/*.{ts,tsx}
📄 CodeRabbit Inference Engine (.cursor/rules/development.mdc)
TypeScript is required for all packages
Files:
packages/types/src/json.tspackages/types/src/commerce.tspackages/clerk-js/src/core/resources/CommerceSubscription.ts
packages/**/*.{ts,tsx,d.ts}
📄 CodeRabbit Inference Engine (.cursor/rules/development.mdc)
Packages should export TypeScript types alongside runtime code
Files:
packages/types/src/json.tspackages/types/src/commerce.tspackages/clerk-js/src/core/resources/CommerceSubscription.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/types/src/json.tspackages/types/src/commerce.tspackages/clerk-js/src/core/resources/CommerceSubscription.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/types/src/json.tspackages/types/src/commerce.tspackages/clerk-js/src/core/resources/CommerceSubscription.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/types/src/json.tspackages/types/src/commerce.tspackages/clerk-js/src/core/resources/CommerceSubscription.ts
⏰ 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
| @@ -74,6 +76,7 @@ export class CommerceSubscriptionItem extends BaseResource implements CommerceSu | |||
| credit?: { | |||
| amount: CommerceMoney; | |||
| }; | |||
| isFreeTrial = false; | |||
There was a problem hiding this comment.
Do not overwrite default with undefined; preserve boolean by defaulting.
isFreeTrial is initialized to false (Line 79) but then overwritten unconditionally (Line 111). If the JSON omits the field, you end up with undefined at runtime despite the type being boolean.
Use nullish coalescing to preserve the default:
Apply this diff:
- this.isFreeTrial = data.is_free_trial;
+ this.isFreeTrial = data.is_free_trial ?? false;Also add a focused test covering:
- present:
is_free_trial: true→isFreeTrial === true - present:
is_free_trial: false→isFreeTrial === false - absent: no
is_free_trial→isFreeTrial === false
I can scaffold these tests if you want.
Also applies to: 110-111
🤖 Prompt for AI Agents
In packages/clerk-js/src/core/resources/CommerceSubscription.ts around lines 79
and 110-111, the boolean property isFreeTrial is initialized to false but then
overwritten unconditionally from JSON, which can set it to undefined if the
field is missing. Fix this by using nullish coalescing (??) when assigning
isFreeTrial from JSON to preserve the default false value when the field is
absent. Additionally, add focused tests to verify isFreeTrial is true when
is_free_trial is true, false when is_free_trial is false, and false when
is_free_trial is absent.
| is_free_trial: boolean; | ||
| } |
There was a problem hiding this comment.
💡 Verification agent
🧩 Analysis chain
Required JSON field may break backward-compat; ensure safe runtime default.
is_free_trial is required here. If older API responses omit it, runtime code will assign undefined over the initial default. Prefer keeping it required only if the backend guarantees presence across all records. Otherwise either:
- keep it required but default safely during deserialization, or
- make it optional in the JSON type.
Follow-up fix (in runtime mapping) to preserve a safe default:
Apply in packages/clerk-js/src/core/resources/CommerceSubscription.ts:
- this.isFreeTrial = data.is_free_trial;
+ this.isFreeTrial = data.is_free_trial ?? false;🏁 Script executed:
#!/bin/bash
# Locate CommerceSubscription.ts
echo "CommerceSubscription.ts files:"
rg -l "CommerceSubscription" -g "*.ts"
# Inspect JSON mapping references in clerk-js
echo -e "\nMapping of is_free_trial in clerk-js runtime:"
rg -n "is_free_trial" -C2 packages/clerk-js/src
echo -e "\nAssignment to isFreeTrial in clerk-js runtime:"
rg -n "isFreeTrial" -C2 packages/clerk-js/srcLength of output: 2519
Ensure safe default for isFreeTrial when deserializing JSON
To prevent legacy responses from clearing the default, update the runtime mapping in packages/clerk-js/src/core/resources/CommerceSubscription.ts:
- At line 110 (inside the constructor), change
- this.isFreeTrial = data.is_free_trial; + this.isFreeTrial = data.is_free_trial ?? false;
Optional: if the backend cannot guarantee is_free_trial is always present, also update the JSON type in packages/types/src/json.ts:
- interface CommerceSubscriptionItemJSON {
- is_free_trial: boolean;
+ interface CommerceSubscriptionItemJSON {
+ /** Indicates whether this subscription item started with a free trial */
+ is_free_trial?: boolean;This preserves backward compatibility while clarifying the field’s semantics.
Committable suggestion skipped: line range outside the PR's diff.
🤖 Prompt for AI Agents
In packages/types/src/json.ts at lines 783-784, ensure the isFreeTrial field has
a safe default when deserializing JSON by updating the runtime mapping in
packages/clerk-js/src/core/resources/CommerceSubscription.ts around line 110
inside the constructor. Modify the mapping to provide a default value for
is_free_trial if it is missing, and optionally update the JSON type definition
here to reflect that is_free_trial may be optional or have a default, preserving
backward compatibility and clarifying the field's semantics.
Description
Checklist
pnpm testruns as expected.pnpm buildruns as expected.Type of change
Summary by CodeRabbit
New Features
Chores