Uh oh!
There was an error while loading. Please reload this page.
fix(clerk-js): Hide CTA for <PricingTable forOrganization/> and orgId is null#6883
Uh oh!
There was an error while loading. Please reload this page.
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| --- | ||
| '@clerk/clerk-js': patch | ||
| --- | ||
| Hide CTA for `<PricingTable forOrganization/>` when the user is does not have an active organization selected. | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,126 @@ | ||
| import type { BillingPlanResource, BillingSubscriptionItemResource, BillingSubscriptionPlanPeriod } from '@clerk/types'; | ||
| import { describe, expect, it } from 'vitest'; | ||
| import { getPricingFooterState } from './pricing-footer-state'; | ||
| const basePlan: BillingPlanResource = { | ||
| id: 'plan_1', | ||
| name: 'Pro', | ||
| fee: { amount: 1000, amountFormatted: '10.00', currency: 'USD', currencySymbol: '$' }, | ||
| annualFee: { amount: 10000, amountFormatted: '100.00', currency: 'USD', currencySymbol: '$' }, | ||
| annualMonthlyFee: { amount: 833, amountFormatted: '8.33', currency: 'USD', currencySymbol: '$' }, | ||
| description: 'desc', | ||
| isDefault: false, | ||
| isRecurring: true, | ||
| hasBaseFee: true, | ||
| forPayerType: 'user', | ||
| publiclyVisible: true, | ||
| slug: 'pro', | ||
| avatarUrl: '', | ||
| features: [], | ||
| freeTrialDays: 14, | ||
| freeTrialEnabled: true, | ||
| pathRoot: '', | ||
| reload: async () => undefined as any, | ||
| }; | ||
| const makeSub = (overrides: Partial<BillingSubscriptionItemResource>): BillingSubscriptionItemResource => ({ | ||
| id: 'si_1', | ||
| plan: basePlan, | ||
| planPeriod: 'month', | ||
| status: 'active', | ||
| createdAt: new Date('2021-01-01'), | ||
| paymentSourceId: 'src_1', | ||
| pastDueAt: null, | ||
| periodStart: new Date('2021-01-01'), | ||
| periodEnd: new Date('2021-01-31'), | ||
| canceledAt: null, | ||
| isFreeTrial: false, | ||
| cancel: async () => undefined as any, | ||
| pathRoot: '', | ||
| reload: async () => undefined as any, | ||
| ...overrides, | ||
| }); | ||
| const run = (args: { | ||
| subscription?: BillingSubscriptionItemResource; | ||
| plan?: BillingPlanResource; | ||
| planPeriod?: BillingSubscriptionPlanPeriod; | ||
| forOrganizations?: boolean; | ||
| hasActiveOrganization?: boolean; | ||
| }) => | ||
| getPricingFooterState({ | ||
| subscription: args.subscription, | ||
| plan: args.plan ?? basePlan, | ||
| planPeriod: args.planPeriod ?? 'month', | ||
| forOrganizations: args.forOrganizations, | ||
| hasActiveOrganization: args.hasActiveOrganization ?? false, | ||
| }); | ||
| describe('usePricingFooterState', () => { | ||
| it('hides footer when org plans and no active org', () => { | ||
| const res = run({ subscription: undefined, forOrganizations: true, hasActiveOrganization: false }); | ||
| expect(res).toEqual({ shouldShowFooter: false, shouldShowFooterNotice: false }); | ||
| }); | ||
| it('shows footer when no subscription and user plans', () => { | ||
| const res = run({ subscription: undefined, forOrganizations: false }); | ||
| expect(res).toEqual({ shouldShowFooter: true, shouldShowFooterNotice: false }); | ||
| }); | ||
| it('shows notice when subscription is upcoming', () => { | ||
| const res = run({ subscription: makeSub({ status: 'upcoming' }) }); | ||
| expect(res).toEqual({ shouldShowFooter: true, shouldShowFooterNotice: true }); | ||
| }); | ||
| it('shows footer when active but canceled', () => { | ||
| const res = run({ subscription: makeSub({ status: 'active', canceledAt: new Date('2021-02-01') }) }); | ||
| expect(res).toEqual({ shouldShowFooter: true, shouldShowFooterNotice: false }); | ||
| }); | ||
| it('shows footer when switching period to paid annual', () => { | ||
| const res = run({ | ||
| subscription: makeSub({ status: 'active', planPeriod: 'month' }), | ||
| planPeriod: 'annual', | ||
| plan: basePlan, | ||
| }); | ||
| expect(res).toEqual({ shouldShowFooter: true, shouldShowFooterNotice: false }); | ||
| }); | ||
| it('shows notice when active free trial', () => { | ||
| const res = run({ subscription: makeSub({ status: 'active', isFreeTrial: true }) }); | ||
| expect(res).toEqual({ shouldShowFooter: true, shouldShowFooterNotice: true }); | ||
| }); | ||
| it('hides footer when active and matching period without trial', () => { | ||
| const res = run({ subscription: makeSub({ status: 'active', planPeriod: 'month', isFreeTrial: false }) }); | ||
| expect(res).toEqual({ shouldShowFooter: false, shouldShowFooterNotice: false }); | ||
| }); | ||
| it('shows footer when switching period to paid monthly', () => { | ||
| const res = run({ | ||
| subscription: makeSub({ status: 'active', planPeriod: 'annual' }), | ||
| planPeriod: 'month', | ||
| plan: basePlan, | ||
| }); | ||
| expect(res).toEqual({ shouldShowFooter: true, shouldShowFooterNotice: false }); | ||
| }); | ||
| it('does not show footer when switching period if annualMonthlyFee is 0', () => { | ||
| const freeAnnualPlan: BillingPlanResource = { | ||
| ...basePlan, | ||
| annualMonthlyFee: { ...basePlan.annualMonthlyFee, amount: 0, amountFormatted: '0.00' }, | ||
| }; | ||
| const res = run({ | ||
| subscription: makeSub({ status: 'active', planPeriod: 'month' }), | ||
| planPeriod: 'annual', | ||
| plan: freeAnnualPlan, | ||
| }); | ||
| expect(res).toEqual({ shouldShowFooter: false, shouldShowFooterNotice: false }); | ||
| }); | ||
| it('hides footer when subscription is past_due', () => { | ||
| const res = run({ subscription: makeSub({ status: 'past_due' }) }); | ||
| expect(res).toEqual({ shouldShowFooter: false, shouldShowFooterNotice: false }); | ||
| }); | ||
| }); |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,58 @@ | ||
| import type { BillingPlanResource, BillingSubscriptionItemResource, BillingSubscriptionPlanPeriod } from '@clerk/types'; | ||
| type UsePricingFooterStateParams = { | ||
| subscription: BillingSubscriptionItemResource | undefined; | ||
| plan: BillingPlanResource; | ||
| planPeriod: BillingSubscriptionPlanPeriod; | ||
| forOrganizations?: boolean; | ||
| hasActiveOrganization: boolean; | ||
| }; | ||
| /** | ||
| * Calculates the correct show/hide state for the footer of a card in the `<PricingTableDefault/>` component. | ||
| * @returns [shouldShowFooter, shouldShowFooterNotice] | ||
| */ | ||
| const valueResolution = (params: UsePricingFooterStateParams): [boolean, boolean] => { | ||
Contributor There was a problem hiding this comment. 🙃 Can we document the return type as JSDoc? So it's easier to read the tuples down in the code Contributor There was a problem hiding this comment. any specific reason to return [bool, bool] instead of an object? It's probably a pattern but asking as I'm not familliar with the SDK codebase ContributorAuthor There was a problem hiding this comment. Just saving on bytes. No other reason. | ||
| const { subscription, plan, planPeriod, forOrganizations, hasActiveOrganization } = params; | ||
| const show_with_notice: [boolean, boolean] = [true, true]; | ||
| const show_without_notice: [boolean, boolean] = [true, false]; | ||
| const hide: [boolean, boolean] = [false, false]; | ||
| // No subscription | ||
| if (!subscription) { | ||
| if (forOrganizations && !hasActiveOrganization) { | ||
| return hide; | ||
| } | ||
| return show_without_notice; | ||
| } | ||
| // Upcoming subscription | ||
| if (subscription.status === 'upcoming') { | ||
| return show_with_notice; | ||
| } | ||
| // Active subscription | ||
| if (subscription.status === 'active') { | ||
| const isCanceled = !!subscription.canceledAt; | ||
| const isSwitchingPaidPeriod = planPeriod !== subscription.planPeriod && plan.annualMonthlyFee.amount > 0; | ||
| const isActiveFreeTrial = plan.freeTrialEnabled && subscription.isFreeTrial; | ||
| if (isCanceled || isSwitchingPaidPeriod) { | ||
| return show_without_notice; | ||
| } | ||
| if (isActiveFreeTrial) { | ||
| return show_with_notice; | ||
| } | ||
| return hide; | ||
| } | ||
| return hide; | ||
| }; | ||
| export const getPricingFooterState = ( | ||
| params: UsePricingFooterStateParams, | ||
| ): { shouldShowFooter: boolean; shouldShowFooterNotice: boolean } => { | ||
| const [shouldShowFooter, shouldShowFooterNotice] = valueResolution(params); | ||
| return { shouldShowFooter, shouldShowFooterNotice }; | ||
| }; | ||
Oops, something went wrong.
Uh oh!
There was an error while loading. Please reload this page.
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fix grammar in the changeset entry.
Please drop the extra “is” so the sentence reads naturally.
📝 Committable suggestion
🤖 Prompt for AI Agents