Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions packages/clerk-js/src/core/resources/BillingCheckout.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,7 @@ import { retry } from '@clerk/shared/retry';
import type {
BillingCheckoutJSON,
BillingCheckoutResource,
BillingCheckoutTotals,
BillingTotals,
BillingPayerResource,
BillingPaymentMethodResource,
BillingSubscriptionPlanPeriod,
Expand DownExpand Up@@ -34,7 +34,7 @@ export class BillingCheckout extends BaseResource implements BillingCheckoutReso
planPeriod!: BillingSubscriptionPlanPeriod;
planPeriodStart!: number | undefined;
status!: 'needs_confirmation' | 'completed';
totals!: BillingCheckoutTotals;
totals!: BillingTotals;
isImmediatePlanChange!: boolean;
freeTrialEndsAt?: Date;
payer!: BillingPayerResource;
Expand Down
4 changes: 2 additions & 2 deletions packages/clerk-js/src/core/resources/BillingStatement.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,7 +6,7 @@ import type {
BillingStatementTotals,
} from '@clerk/shared/types';

import { billingTotalsFromJSON } from '../../utils';
import { billingStatementTotalsFromJSON } from '../../utils';
import { unixEpochToDate } from '../../utils/date';
import { BaseResource, BillingPayment } from './internal';

Expand All@@ -30,7 +30,7 @@ export class BillingStatement extends BaseResource implements BillingStatementRe
this.id = data.id;
this.status = data.status;
this.timestamp = unixEpochToDate(data.timestamp);
this.totals = billingTotalsFromJSON(data.totals);
this.totals = billingStatementTotalsFromJSON(data.totals);
this.groups = data.groups.map(group => new BillingStatementGroup(group));
return this;
}
Expand Down
33 changes: 22 additions & 11 deletions packages/clerk-js/src/core/resources/BillingSubscription.ts
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
import type {
BillingCredits,
BillingMoneyAmount,
BillingSubscriptionItemNextPayment,
BillingSubscriptionNextPayment,
BillingSubscriptionItemJSON,
BillingSubscriptionItemResource,
BillingSubscriptionItemSeats,
Expand All@@ -14,7 +16,12 @@ import type {

import { unixEpochToDate } from '@/utils/date';

import { billingCreditsFromJSON, billingMoneyAmountFromJSON, billingPerUnitTotalTierFromJSON } from '../../utils';
import {
billingCreditsFromJSON,
billingMoneyAmountFromJSON,
billingSubscriptionItemNextPaymentFromJSON,
billingSubscriptionNextPaymentFromJSON,
} from '../../utils';
import { Billing } from '../modules/billing/namespace';
import { BaseResource, BillingPlan, DeletedObject } from './internal';

Expand All@@ -25,10 +32,7 @@ export class BillingSubscription extends BaseResource implements BillingSubscrip
createdAt!: Date;
pastDueAt!: Date | null;
updatedAt!: Date | null;
nextPayment?: {
amount: BillingMoneyAmount;
date: Date;
};
nextPayment?: BillingSubscriptionNextPayment | null;
subscriptionItems!: BillingSubscriptionItemResource[];
eligibleForFreeTrial!: boolean;

Expand All@@ -49,12 +53,12 @@ export class BillingSubscription extends BaseResource implements BillingSubscrip
this.activeAt = unixEpochToDate(data.active_at);
this.pastDueAt = data.past_due_at ? unixEpochToDate(data.past_due_at) : null;

if (data.next_payment) {
this.nextPayment = {
amount: billingMoneyAmountFromJSON(data.next_payment.amount),
date: unixEpochToDate(data.next_payment.date),
};
}
this.nextPayment =
data.next_payment === undefined
? undefined
: data.next_payment === null
? null
: billingSubscriptionNextPaymentFromJSON(data.next_payment);

this.subscriptionItems = (data.subscription_items || []).map(item => new BillingSubscriptionItem(item));
this.eligibleForFreeTrial = this.withDefault(data.eligible_for_free_trial, false);
Expand All@@ -80,6 +84,7 @@ export class BillingSubscriptionItem extends BaseResource implements BillingSubs
};
seats?: BillingSubscriptionItemSeats;
credits?: BillingCredits;
nextPayment?: BillingSubscriptionItemNextPayment | null;
isFreeTrial!: boolean;

constructor(data: BillingSubscriptionItemJSON) {
Expand DownExpand Up@@ -116,6 +121,12 @@ export class BillingSubscriptionItem extends BaseResource implements BillingSubs
: undefined;

this.credits = data.credits ? billingCreditsFromJSON(data.credits) : undefined;
this.nextPayment =
data.next_payment === undefined
? undefined
: data.next_payment === null
? null
: billingSubscriptionItemNextPaymentFromJSON(data.next_payment);

this.isFreeTrial = this.withDefault(data.is_free_trial, false);
return this;
Expand Down
160 changes: 158 additions & 2 deletions packages/clerk-js/src/utils/__tests__/billing.test.ts
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,17 @@
import type { BillingMoneyAmountJSON, BillingPaymentTotalsJSON } from '@clerk/shared/types';
import type {
BillingMoneyAmountJSON,
BillingPaymentTotalsJSON,
BillingSubscriptionItemNextPaymentJSON,
BillingSubscriptionNextPaymentJSON,
BillingTotalsJSON,
} from '@clerk/shared/types';
import { describe, expect, it } from 'vitest';

import { billingPaymentTotalsFromJSON } from '../billing';
import {
billingPaymentTotalsFromJSON,
billingSubscriptionItemNextPaymentFromJSON,
billingSubscriptionNextPaymentFromJSON,
} from '../billing';

const moneyJSON = (amount: number): BillingMoneyAmountJSON => ({
amount,
Expand All@@ -10,6 +20,55 @@ const moneyJSON = (amount: number): BillingMoneyAmountJSON => ({
currency_symbol: '$',
});

const nextPaymentTotalsJSON = (): BillingTotalsJSON => ({
subtotal: moneyJSON(5000),
base_fee: moneyJSON(1000),
tax_total: moneyJSON(500),
grand_total: moneyJSON(5500),
credits: {
proration: null,
payer: {
remaining_balance: moneyJSON(2000),
applied_amount: moneyJSON(1000),
},
total: moneyJSON(1000),
},
discounts: {
proration: {
amount: moneyJSON(500),
cycle_days_passed: 15,
cycle_days_total: 30,
cycle_passed_percent: 50,
},
total: moneyJSON(500),
},
total_due_after_free_trial: null,
credit: null,
past_due: null,
total_due_now: moneyJSON(4500),
per_unit_totals: [
{
name: 'seats',
block_size: 1,
tiers: [{ quantity: 5, fee_per_block: moneyJSON(1000), total: moneyJSON(5000) }],
},
],
totals_due_per_period: {
subtotal: moneyJSON(10000),
base_fee: moneyJSON(1000),
tax_total: moneyJSON(1000),
grand_total: moneyJSON(11000),
per_unit_totals: [
{
name: 'seats',
block_size: 1,
tiers: [{ quantity: 10, fee_per_block: moneyJSON(1000), total: moneyJSON(10000) }],
},
],
},
total_due_per_period: moneyJSON(11000),
});

describe('billingPaymentTotalsFromJSON', () => {
it('maps subtotal, grand_total, and tax_total', () => {
const data: BillingPaymentTotalsJSON = {
Expand DownExpand Up@@ -68,3 +127,100 @@ describe('billingPaymentTotalsFromJSON', () => {
expect(totals.perUnitTotals?.[0].tiers[1].quantity).toBeNull();
});
});

describe('billingSubscriptionNextPaymentFromJSON', () => {
it('maps amount, date, and per_unit_totals', () => {
const data: BillingSubscriptionNextPaymentJSON = {
amount: moneyJSON(5000),
date: 1_609_459_200_000,
per_unit_totals: [
{
name: 'seats',
block_size: 1,
tiers: [{ quantity: 5, fee_per_block: moneyJSON(1000), total: moneyJSON(5000) }],
},
],
totals: nextPaymentTotalsJSON(),
};

const nextPayment = billingSubscriptionNextPaymentFromJSON(data);

expect(nextPayment.amount.amount).toBe(5000);
expect(nextPayment.date).toEqual(new Date('2021-01-01T00:00:00.000Z'));
expect(nextPayment.perUnitTotals?.[0]).toMatchObject({
name: 'seats',
blockSize: 1,
tiers: [{ quantity: 5, feePerBlock: { amount: 1000 }, total: { amount: 5000 } }],
});
expect(nextPayment.totals).toMatchObject({
subtotal: { amount: 5000 },
baseFee: { amount: 1000 },
taxTotal: { amount: 500 },
grandTotal: { amount: 5500 },
totalDueAfterFreeTrial: null,
credit: null,
pastDue: null,
totalDueNow: { amount: 4500 },
totalDuePerPeriod: { amount: 11000 },
credits: {
payer: {
remainingBalance: { amount: 2000 },
appliedAmount: { amount: 1000 },
},
total: { amount: 1000 },
},
discounts: {
proration: {
amount: { amount: 500 },
cycleDaysPassed: 15,
cycleDaysTotal: 30,
cyclePassedPercent: 50,
},
total: { amount: 500 },
},
perUnitTotals: [{ name: 'seats', blockSize: 1 }],
totalsDuePerPeriod: {
subtotal: { amount: 10000 },
baseFee: { amount: 1000 },
taxTotal: { amount: 1000 },
grandTotal: { amount: 11000 },
perUnitTotals: [{ name: 'seats', blockSize: 1 }],
},
});
});
});

describe('billingSubscriptionItemNextPaymentFromJSON', () => {
it('maps amount, date, and per_unit_totals', () => {
const data: BillingSubscriptionItemNextPaymentJSON = {
amount: moneyJSON(5000),
date: 1_609_459_200_000,
per_unit_totals: [
{
name: 'seats',
block_size: 1,
tiers: [{ quantity: 5, fee_per_block: moneyJSON(1000), total: moneyJSON(5000) }],
},
],
totals: nextPaymentTotalsJSON(),
};

const nextPayment = billingSubscriptionItemNextPaymentFromJSON(data);

expect(nextPayment.amount.amount).toBe(5000);
expect(nextPayment.date).toEqual(new Date('2021-01-01T00:00:00.000Z'));
expect(nextPayment.perUnitTotals?.[0]).toMatchObject({
name: 'seats',
blockSize: 1,
tiers: [{ quantity: 5, feePerBlock: { amount: 1000 }, total: { amount: 5000 } }],
});
expect(nextPayment.totals).toMatchObject({
subtotal: { amount: 5000 },
baseFee: { amount: 1000 },
totalDueNow: { amount: 4500 },
credits: { total: { amount: 1000 } },
discounts: { total: { amount: 500 } },
perUnitTotals: [{ name: 'seats', blockSize: 1 }],
});
});
});
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
fix(clerk-js,shared): Update type for next_payment by dstaley · Pull Request #8739 · clerk/javascript · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions packages/clerk-js/src/core/resources/BillingCheckout.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,7 @@ import { retry } from '@clerk/shared/retry';
import type {
BillingCheckoutJSON,
BillingCheckoutResource,
BillingCheckoutTotals,
BillingTotals,
BillingPayerResource,
BillingPaymentMethodResource,
BillingSubscriptionPlanPeriod,
Expand DownExpand Up@@ -34,7 +34,7 @@ export class BillingCheckout extends BaseResource implements BillingCheckoutReso
planPeriod!: BillingSubscriptionPlanPeriod;
planPeriodStart!: number | undefined;
status!: 'needs_confirmation' | 'completed';
totals!: BillingCheckoutTotals;
totals!: BillingTotals;
isImmediatePlanChange!: boolean;
freeTrialEndsAt?: Date;
payer!: BillingPayerResource;
Expand Down
4 changes: 2 additions & 2 deletions packages/clerk-js/src/core/resources/BillingStatement.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,7 +6,7 @@ import type {
BillingStatementTotals,
} from '@clerk/shared/types';

import { billingTotalsFromJSON } from '../../utils';
import { billingStatementTotalsFromJSON } from '../../utils';
import { unixEpochToDate } from '../../utils/date';
import { BaseResource, BillingPayment } from './internal';

Expand All@@ -30,7 +30,7 @@ export class BillingStatement extends BaseResource implements BillingStatementRe
this.id = data.id;
this.status = data.status;
this.timestamp = unixEpochToDate(data.timestamp);
this.totals = billingTotalsFromJSON(data.totals);
this.totals = billingStatementTotalsFromJSON(data.totals);
this.groups = data.groups.map(group => new BillingStatementGroup(group));
return this;
}
Expand Down
33 changes: 22 additions & 11 deletions packages/clerk-js/src/core/resources/BillingSubscription.ts
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
import type {
BillingCredits,
BillingMoneyAmount,
BillingSubscriptionItemNextPayment,
BillingSubscriptionNextPayment,
BillingSubscriptionItemJSON,
BillingSubscriptionItemResource,
BillingSubscriptionItemSeats,
Expand All@@ -14,7 +16,12 @@ import type {

import { unixEpochToDate } from '@/utils/date';

import { billingCreditsFromJSON, billingMoneyAmountFromJSON, billingPerUnitTotalTierFromJSON } from '../../utils';
import {
billingCreditsFromJSON,
billingMoneyAmountFromJSON,
billingSubscriptionItemNextPaymentFromJSON,
billingSubscriptionNextPaymentFromJSON,
} from '../../utils';
import { Billing } from '../modules/billing/namespace';
import { BaseResource, BillingPlan, DeletedObject } from './internal';

Expand All@@ -25,10 +32,7 @@ export class BillingSubscription extends BaseResource implements BillingSubscrip
createdAt!: Date;
pastDueAt!: Date | null;
updatedAt!: Date | null;
nextPayment?: {
amount: BillingMoneyAmount;
date: Date;
};
nextPayment?: BillingSubscriptionNextPayment | null;
subscriptionItems!: BillingSubscriptionItemResource[];
eligibleForFreeTrial!: boolean;

Expand All@@ -49,12 +53,12 @@ export class BillingSubscription extends BaseResource implements BillingSubscrip
this.activeAt = unixEpochToDate(data.active_at);
this.pastDueAt = data.past_due_at ? unixEpochToDate(data.past_due_at) : null;

if (data.next_payment) {
this.nextPayment = {
amount: billingMoneyAmountFromJSON(data.next_payment.amount),
date: unixEpochToDate(data.next_payment.date),
};
}
this.nextPayment =
data.next_payment === undefined
? undefined
: data.next_payment === null
? null
: billingSubscriptionNextPaymentFromJSON(data.next_payment);

this.subscriptionItems = (data.subscription_items || []).map(item => new BillingSubscriptionItem(item));
this.eligibleForFreeTrial = this.withDefault(data.eligible_for_free_trial, false);
Expand All@@ -80,6 +84,7 @@ export class BillingSubscriptionItem extends BaseResource implements BillingSubs
};
seats?: BillingSubscriptionItemSeats;
credits?: BillingCredits;
nextPayment?: BillingSubscriptionItemNextPayment | null;
isFreeTrial!: boolean;

constructor(data: BillingSubscriptionItemJSON) {
Expand DownExpand Up@@ -116,6 +121,12 @@ export class BillingSubscriptionItem extends BaseResource implements BillingSubs
: undefined;

this.credits = data.credits ? billingCreditsFromJSON(data.credits) : undefined;
this.nextPayment =
data.next_payment === undefined
? undefined
: data.next_payment === null
? null
: billingSubscriptionItemNextPaymentFromJSON(data.next_payment);

this.isFreeTrial = this.withDefault(data.is_free_trial, false);
return this;
Expand Down
160 changes: 158 additions & 2 deletions packages/clerk-js/src/utils/__tests__/billing.test.ts
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,17 @@
import type { BillingMoneyAmountJSON, BillingPaymentTotalsJSON } from '@clerk/shared/types';
import type {
BillingMoneyAmountJSON,
BillingPaymentTotalsJSON,
BillingSubscriptionItemNextPaymentJSON,
BillingSubscriptionNextPaymentJSON,
BillingTotalsJSON,
} from '@clerk/shared/types';
import { describe, expect, it } from 'vitest';

import { billingPaymentTotalsFromJSON } from '../billing';
import {
billingPaymentTotalsFromJSON,
billingSubscriptionItemNextPaymentFromJSON,
billingSubscriptionNextPaymentFromJSON,
} from '../billing';

const moneyJSON = (amount: number): BillingMoneyAmountJSON => ({
amount,
Expand All@@ -10,6 +20,55 @@ const moneyJSON = (amount: number): BillingMoneyAmountJSON => ({
currency_symbol: '$',
});

const nextPaymentTotalsJSON = (): BillingTotalsJSON => ({
subtotal: moneyJSON(5000),
base_fee: moneyJSON(1000),
tax_total: moneyJSON(500),
grand_total: moneyJSON(5500),
credits: {
proration: null,
payer: {
remaining_balance: moneyJSON(2000),
applied_amount: moneyJSON(1000),
},
total: moneyJSON(1000),
},
discounts: {
proration: {
amount: moneyJSON(500),
cycle_days_passed: 15,
cycle_days_total: 30,
cycle_passed_percent: 50,
},
total: moneyJSON(500),
},
total_due_after_free_trial: null,
credit: null,
past_due: null,
total_due_now: moneyJSON(4500),
per_unit_totals: [
{
name: 'seats',
block_size: 1,
tiers: [{ quantity: 5, fee_per_block: moneyJSON(1000), total: moneyJSON(5000) }],
},
],
totals_due_per_period: {
subtotal: moneyJSON(10000),
base_fee: moneyJSON(1000),
tax_total: moneyJSON(1000),
grand_total: moneyJSON(11000),
per_unit_totals: [
{
name: 'seats',
block_size: 1,
tiers: [{ quantity: 10, fee_per_block: moneyJSON(1000), total: moneyJSON(10000) }],
},
],
},
total_due_per_period: moneyJSON(11000),
});

describe('billingPaymentTotalsFromJSON', () => {
it('maps subtotal, grand_total, and tax_total', () => {
const data: BillingPaymentTotalsJSON = {
Expand DownExpand Up@@ -68,3 +127,100 @@ describe('billingPaymentTotalsFromJSON', () => {
expect(totals.perUnitTotals?.[0].tiers[1].quantity).toBeNull();
});
});

describe('billingSubscriptionNextPaymentFromJSON', () => {
it('maps amount, date, and per_unit_totals', () => {
const data: BillingSubscriptionNextPaymentJSON = {
amount: moneyJSON(5000),
date: 1_609_459_200_000,
per_unit_totals: [
{
name: 'seats',
block_size: 1,
tiers: [{ quantity: 5, fee_per_block: moneyJSON(1000), total: moneyJSON(5000) }],
},
],
totals: nextPaymentTotalsJSON(),
};

const nextPayment = billingSubscriptionNextPaymentFromJSON(data);

expect(nextPayment.amount.amount).toBe(5000);
expect(nextPayment.date).toEqual(new Date('2021-01-01T00:00:00.000Z'));
expect(nextPayment.perUnitTotals?.[0]).toMatchObject({
name: 'seats',
blockSize: 1,
tiers: [{ quantity: 5, feePerBlock: { amount: 1000 }, total: { amount: 5000 } }],
});
expect(nextPayment.totals).toMatchObject({
subtotal: { amount: 5000 },
baseFee: { amount: 1000 },
taxTotal: { amount: 500 },
grandTotal: { amount: 5500 },
totalDueAfterFreeTrial: null,
credit: null,
pastDue: null,
totalDueNow: { amount: 4500 },
totalDuePerPeriod: { amount: 11000 },
credits: {
payer: {
remainingBalance: { amount: 2000 },
appliedAmount: { amount: 1000 },
},
total: { amount: 1000 },
},
discounts: {
proration: {
amount: { amount: 500 },
cycleDaysPassed: 15,
cycleDaysTotal: 30,
cyclePassedPercent: 50,
},
total: { amount: 500 },
},
perUnitTotals: [{ name: 'seats', blockSize: 1 }],
totalsDuePerPeriod: {
subtotal: { amount: 10000 },
baseFee: { amount: 1000 },
taxTotal: { amount: 1000 },
grandTotal: { amount: 11000 },
perUnitTotals: [{ name: 'seats', blockSize: 1 }],
},
});
});
});

describe('billingSubscriptionItemNextPaymentFromJSON', () => {
it('maps amount, date, and per_unit_totals', () => {
const data: BillingSubscriptionItemNextPaymentJSON = {
amount: moneyJSON(5000),
date: 1_609_459_200_000,
per_unit_totals: [
{
name: 'seats',
block_size: 1,
tiers: [{ quantity: 5, fee_per_block: moneyJSON(1000), total: moneyJSON(5000) }],
},
],
totals: nextPaymentTotalsJSON(),
};

const nextPayment = billingSubscriptionItemNextPaymentFromJSON(data);

expect(nextPayment.amount.amount).toBe(5000);
expect(nextPayment.date).toEqual(new Date('2021-01-01T00:00:00.000Z'));
expect(nextPayment.perUnitTotals?.[0]).toMatchObject({
name: 'seats',
blockSize: 1,
tiers: [{ quantity: 5, feePerBlock: { amount: 1000 }, total: { amount: 5000 } }],
});
expect(nextPayment.totals).toMatchObject({
subtotal: { amount: 5000 },
baseFee: { amount: 1000 },
totalDueNow: { amount: 4500 },
credits: { total: { amount: 1000 } },
discounts: { total: { amount: 500 } },
perUnitTotals: [{ name: 'seats', blockSize: 1 }],
});
});
});
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Force GitHub README to respect dark mode (function() { var style = document.createElement('style'); style.textContent = ' .markdown-body { color-scheme: dark light; } .markdown-body pre { background: #161b22 !important; } .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; } .markdown-body table th, .markdown-body table td { border-color: #30363d !important; } .markdown-body img { background: #0d1117; } .markdown-body blockquote { border-left-color: #8b949e; } .markdown-body hr { border-color: #30363d; } '; document.head.appendChild(style); })(); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' fix(clerk-js,shared): Update type for next_payment by dstaley · Pull Request #8739 · clerk/javascript · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions packages/clerk-js/src/core/resources/BillingCheckout.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,7 @@ import { retry } from '@clerk/shared/retry';
import type {
BillingCheckoutJSON,
BillingCheckoutResource,
BillingCheckoutTotals,
BillingTotals,
BillingPayerResource,
BillingPaymentMethodResource,
BillingSubscriptionPlanPeriod,
Expand DownExpand Up@@ -34,7 +34,7 @@ export class BillingCheckout extends BaseResource implements BillingCheckoutReso
planPeriod!: BillingSubscriptionPlanPeriod;
planPeriodStart!: number | undefined;
status!: 'needs_confirmation' | 'completed';
totals!: BillingCheckoutTotals;
totals!: BillingTotals;
isImmediatePlanChange!: boolean;
freeTrialEndsAt?: Date;
payer!: BillingPayerResource;
Expand Down
4 changes: 2 additions & 2 deletions packages/clerk-js/src/core/resources/BillingStatement.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,7 +6,7 @@ import type {
BillingStatementTotals,
} from '@clerk/shared/types';

import { billingTotalsFromJSON } from '../../utils';
import { billingStatementTotalsFromJSON } from '../../utils';
import { unixEpochToDate } from '../../utils/date';
import { BaseResource, BillingPayment } from './internal';

Expand All@@ -30,7 +30,7 @@ export class BillingStatement extends BaseResource implements BillingStatementRe
this.id = data.id;
this.status = data.status;
this.timestamp = unixEpochToDate(data.timestamp);
this.totals = billingTotalsFromJSON(data.totals);
this.totals = billingStatementTotalsFromJSON(data.totals);
this.groups = data.groups.map(group => new BillingStatementGroup(group));
return this;
}
Expand Down
33 changes: 22 additions & 11 deletions packages/clerk-js/src/core/resources/BillingSubscription.ts
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
import type {
BillingCredits,
BillingMoneyAmount,
BillingSubscriptionItemNextPayment,
BillingSubscriptionNextPayment,
BillingSubscriptionItemJSON,
BillingSubscriptionItemResource,
BillingSubscriptionItemSeats,
Expand All@@ -14,7 +16,12 @@ import type {

import { unixEpochToDate } from '@/utils/date';

import { billingCreditsFromJSON, billingMoneyAmountFromJSON, billingPerUnitTotalTierFromJSON } from '../../utils';
import {
billingCreditsFromJSON,
billingMoneyAmountFromJSON,
billingSubscriptionItemNextPaymentFromJSON,
billingSubscriptionNextPaymentFromJSON,
} from '../../utils';
import { Billing } from '../modules/billing/namespace';
import { BaseResource, BillingPlan, DeletedObject } from './internal';

Expand All@@ -25,10 +32,7 @@ export class BillingSubscription extends BaseResource implements BillingSubscrip
createdAt!: Date;
pastDueAt!: Date | null;
updatedAt!: Date | null;
nextPayment?: {
amount: BillingMoneyAmount;
date: Date;
};
nextPayment?: BillingSubscriptionNextPayment | null;
subscriptionItems!: BillingSubscriptionItemResource[];
eligibleForFreeTrial!: boolean;

Expand All@@ -49,12 +53,12 @@ export class BillingSubscription extends BaseResource implements BillingSubscrip
this.activeAt = unixEpochToDate(data.active_at);
this.pastDueAt = data.past_due_at ? unixEpochToDate(data.past_due_at) : null;

if (data.next_payment) {
this.nextPayment = {
amount: billingMoneyAmountFromJSON(data.next_payment.amount),
date: unixEpochToDate(data.next_payment.date),
};
}
this.nextPayment =
data.next_payment === undefined
? undefined
: data.next_payment === null
? null
: billingSubscriptionNextPaymentFromJSON(data.next_payment);

this.subscriptionItems = (data.subscription_items || []).map(item => new BillingSubscriptionItem(item));
this.eligibleForFreeTrial = this.withDefault(data.eligible_for_free_trial, false);
Expand All@@ -80,6 +84,7 @@ export class BillingSubscriptionItem extends BaseResource implements BillingSubs
};
seats?: BillingSubscriptionItemSeats;
credits?: BillingCredits;
nextPayment?: BillingSubscriptionItemNextPayment | null;
isFreeTrial!: boolean;

constructor(data: BillingSubscriptionItemJSON) {
Expand DownExpand Up@@ -116,6 +121,12 @@ export class BillingSubscriptionItem extends BaseResource implements BillingSubs
: undefined;

this.credits = data.credits ? billingCreditsFromJSON(data.credits) : undefined;
this.nextPayment =
data.next_payment === undefined
? undefined
: data.next_payment === null
? null
: billingSubscriptionItemNextPaymentFromJSON(data.next_payment);

this.isFreeTrial = this.withDefault(data.is_free_trial, false);
return this;
Expand Down
160 changes: 158 additions & 2 deletions packages/clerk-js/src/utils/__tests__/billing.test.ts
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,17 @@
import type { BillingMoneyAmountJSON, BillingPaymentTotalsJSON } from '@clerk/shared/types';
import type {
BillingMoneyAmountJSON,
BillingPaymentTotalsJSON,
BillingSubscriptionItemNextPaymentJSON,
BillingSubscriptionNextPaymentJSON,
BillingTotalsJSON,
} from '@clerk/shared/types';
import { describe, expect, it } from 'vitest';

import { billingPaymentTotalsFromJSON } from '../billing';
import {
billingPaymentTotalsFromJSON,
billingSubscriptionItemNextPaymentFromJSON,
billingSubscriptionNextPaymentFromJSON,
} from '../billing';

const moneyJSON = (amount: number): BillingMoneyAmountJSON => ({
amount,
Expand All@@ -10,6 +20,55 @@ const moneyJSON = (amount: number): BillingMoneyAmountJSON => ({
currency_symbol: '$',
});

const nextPaymentTotalsJSON = (): BillingTotalsJSON => ({
subtotal: moneyJSON(5000),
base_fee: moneyJSON(1000),
tax_total: moneyJSON(500),
grand_total: moneyJSON(5500),
credits: {
proration: null,
payer: {
remaining_balance: moneyJSON(2000),
applied_amount: moneyJSON(1000),
},
total: moneyJSON(1000),
},
discounts: {
proration: {
amount: moneyJSON(500),
cycle_days_passed: 15,
cycle_days_total: 30,
cycle_passed_percent: 50,
},
total: moneyJSON(500),
},
total_due_after_free_trial: null,
credit: null,
past_due: null,
total_due_now: moneyJSON(4500),
per_unit_totals: [
{
name: 'seats',
block_size: 1,
tiers: [{ quantity: 5, fee_per_block: moneyJSON(1000), total: moneyJSON(5000) }],
},
],
totals_due_per_period: {
subtotal: moneyJSON(10000),
base_fee: moneyJSON(1000),
tax_total: moneyJSON(1000),
grand_total: moneyJSON(11000),
per_unit_totals: [
{
name: 'seats',
block_size: 1,
tiers: [{ quantity: 10, fee_per_block: moneyJSON(1000), total: moneyJSON(10000) }],
},
],
},
total_due_per_period: moneyJSON(11000),
});

describe('billingPaymentTotalsFromJSON', () => {
it('maps subtotal, grand_total, and tax_total', () => {
const data: BillingPaymentTotalsJSON = {
Expand DownExpand Up@@ -68,3 +127,100 @@ describe('billingPaymentTotalsFromJSON', () => {
expect(totals.perUnitTotals?.[0].tiers[1].quantity).toBeNull();
});
});

describe('billingSubscriptionNextPaymentFromJSON', () => {
it('maps amount, date, and per_unit_totals', () => {
const data: BillingSubscriptionNextPaymentJSON = {
amount: moneyJSON(5000),
date: 1_609_459_200_000,
per_unit_totals: [
{
name: 'seats',
block_size: 1,
tiers: [{ quantity: 5, fee_per_block: moneyJSON(1000), total: moneyJSON(5000) }],
},
],
totals: nextPaymentTotalsJSON(),
};

const nextPayment = billingSubscriptionNextPaymentFromJSON(data);

expect(nextPayment.amount.amount).toBe(5000);
expect(nextPayment.date).toEqual(new Date('2021-01-01T00:00:00.000Z'));
expect(nextPayment.perUnitTotals?.[0]).toMatchObject({
name: 'seats',
blockSize: 1,
tiers: [{ quantity: 5, feePerBlock: { amount: 1000 }, total: { amount: 5000 } }],
});
expect(nextPayment.totals).toMatchObject({
subtotal: { amount: 5000 },
baseFee: { amount: 1000 },
taxTotal: { amount: 500 },
grandTotal: { amount: 5500 },
totalDueAfterFreeTrial: null,
credit: null,
pastDue: null,
totalDueNow: { amount: 4500 },
totalDuePerPeriod: { amount: 11000 },
credits: {
payer: {
remainingBalance: { amount: 2000 },
appliedAmount: { amount: 1000 },
},
total: { amount: 1000 },
},
discounts: {
proration: {
amount: { amount: 500 },
cycleDaysPassed: 15,
cycleDaysTotal: 30,
cyclePassedPercent: 50,
},
total: { amount: 500 },
},
perUnitTotals: [{ name: 'seats', blockSize: 1 }],
totalsDuePerPeriod: {
subtotal: { amount: 10000 },
baseFee: { amount: 1000 },
taxTotal: { amount: 1000 },
grandTotal: { amount: 11000 },
perUnitTotals: [{ name: 'seats', blockSize: 1 }],
},
});
});
});

describe('billingSubscriptionItemNextPaymentFromJSON', () => {
it('maps amount, date, and per_unit_totals', () => {
const data: BillingSubscriptionItemNextPaymentJSON = {
amount: moneyJSON(5000),
date: 1_609_459_200_000,
per_unit_totals: [
{
name: 'seats',
block_size: 1,
tiers: [{ quantity: 5, fee_per_block: moneyJSON(1000), total: moneyJSON(5000) }],
},
],
totals: nextPaymentTotalsJSON(),
};

const nextPayment = billingSubscriptionItemNextPaymentFromJSON(data);

expect(nextPayment.amount.amount).toBe(5000);
expect(nextPayment.date).toEqual(new Date('2021-01-01T00:00:00.000Z'));
expect(nextPayment.perUnitTotals?.[0]).toMatchObject({
name: 'seats',
blockSize: 1,
tiers: [{ quantity: 5, feePerBlock: { amount: 1000 }, total: { amount: 5000 } }],
});
expect(nextPayment.totals).toMatchObject({
subtotal: { amount: 5000 },
baseFee: { amount: 1000 },
totalDueNow: { amount: 4500 },
credits: { total: { amount: 1000 } },
discounts: { total: { amount: 500 } },
perUnitTotals: [{ name: 'seats', blockSize: 1 }],
});
});
});
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Highlight search terms from Google/DuckDuckGo/Bing referrer (function() { var ref = document.referrer; var terms = []; if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) { var url = new URL(ref); var q = url.searchParams.get('q') || url.searchParams.get('p'); if (q) { terms = q.split(/\s+/).filter(function(t) { return t.length > 2; }); } } if (terms.length === 0) return; var style = document.createElement('style'); style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }'; document.head.appendChild(style); function highlight(node) { if (node.nodeType === 3) { // text node var text = node.textContent; var found = false; terms.forEach(function(term) { var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi'); if (regex.test(text)) { found = true; var frag = document.createDocumentFragment(); var parts = text.split(regex); parts.forEach(function(part, i) { if (i % 2 === 0) { frag.appendChild(document.createTextNode(part)); } else { var span = document.createElement('span'); span.className = 'userscript-highlight'; span.textContent = part; frag.appendChild(span); } }); node.parentNode.replaceChild(frag, node); } }); } else if (node.nodeType === 1 && node.childNodes) { // element var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT']; if (!skipTags.includes(node.tagName)) { Array.from(node.childNodes).forEach(highlight); } } } highlight(document.body); // Re-highlight on dynamic content var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1 || node.nodeType === 3) highlight(node); }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' fix(clerk-js,shared): Update type for next_payment by dstaley · Pull Request #8739 · clerk/javascript · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions packages/clerk-js/src/core/resources/BillingCheckout.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,7 @@ import { retry } from '@clerk/shared/retry';
import type {
BillingCheckoutJSON,
BillingCheckoutResource,
BillingCheckoutTotals,
BillingTotals,
BillingPayerResource,
BillingPaymentMethodResource,
BillingSubscriptionPlanPeriod,
Expand DownExpand Up@@ -34,7 +34,7 @@ export class BillingCheckout extends BaseResource implements BillingCheckoutReso
planPeriod!: BillingSubscriptionPlanPeriod;
planPeriodStart!: number | undefined;
status!: 'needs_confirmation' | 'completed';
totals!: BillingCheckoutTotals;
totals!: BillingTotals;
isImmediatePlanChange!: boolean;
freeTrialEndsAt?: Date;
payer!: BillingPayerResource;
Expand Down
4 changes: 2 additions & 2 deletions packages/clerk-js/src/core/resources/BillingStatement.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,7 +6,7 @@ import type {
BillingStatementTotals,
} from '@clerk/shared/types';

import { billingTotalsFromJSON } from '../../utils';
import { billingStatementTotalsFromJSON } from '../../utils';
import { unixEpochToDate } from '../../utils/date';
import { BaseResource, BillingPayment } from './internal';

Expand All@@ -30,7 +30,7 @@ export class BillingStatement extends BaseResource implements BillingStatementRe
this.id = data.id;
this.status = data.status;
this.timestamp = unixEpochToDate(data.timestamp);
this.totals = billingTotalsFromJSON(data.totals);
this.totals = billingStatementTotalsFromJSON(data.totals);
this.groups = data.groups.map(group => new BillingStatementGroup(group));
return this;
}
Expand Down
33 changes: 22 additions & 11 deletions packages/clerk-js/src/core/resources/BillingSubscription.ts
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
import type {
BillingCredits,
BillingMoneyAmount,
BillingSubscriptionItemNextPayment,
BillingSubscriptionNextPayment,
BillingSubscriptionItemJSON,
BillingSubscriptionItemResource,
BillingSubscriptionItemSeats,
Expand All@@ -14,7 +16,12 @@ import type {

import { unixEpochToDate } from '@/utils/date';

import { billingCreditsFromJSON, billingMoneyAmountFromJSON, billingPerUnitTotalTierFromJSON } from '../../utils';
import {
billingCreditsFromJSON,
billingMoneyAmountFromJSON,
billingSubscriptionItemNextPaymentFromJSON,
billingSubscriptionNextPaymentFromJSON,
} from '../../utils';
import { Billing } from '../modules/billing/namespace';
import { BaseResource, BillingPlan, DeletedObject } from './internal';

Expand All@@ -25,10 +32,7 @@ export class BillingSubscription extends BaseResource implements BillingSubscrip
createdAt!: Date;
pastDueAt!: Date | null;
updatedAt!: Date | null;
nextPayment?: {
amount: BillingMoneyAmount;
date: Date;
};
nextPayment?: BillingSubscriptionNextPayment | null;
subscriptionItems!: BillingSubscriptionItemResource[];
eligibleForFreeTrial!: boolean;

Expand All@@ -49,12 +53,12 @@ export class BillingSubscription extends BaseResource implements BillingSubscrip
this.activeAt = unixEpochToDate(data.active_at);
this.pastDueAt = data.past_due_at ? unixEpochToDate(data.past_due_at) : null;

if (data.next_payment) {
this.nextPayment = {
amount: billingMoneyAmountFromJSON(data.next_payment.amount),
date: unixEpochToDate(data.next_payment.date),
};
}
this.nextPayment =
data.next_payment === undefined
? undefined
: data.next_payment === null
? null
: billingSubscriptionNextPaymentFromJSON(data.next_payment);

this.subscriptionItems = (data.subscription_items || []).map(item => new BillingSubscriptionItem(item));
this.eligibleForFreeTrial = this.withDefault(data.eligible_for_free_trial, false);
Expand All@@ -80,6 +84,7 @@ export class BillingSubscriptionItem extends BaseResource implements BillingSubs
};
seats?: BillingSubscriptionItemSeats;
credits?: BillingCredits;
nextPayment?: BillingSubscriptionItemNextPayment | null;
isFreeTrial!: boolean;

constructor(data: BillingSubscriptionItemJSON) {
Expand DownExpand Up@@ -116,6 +121,12 @@ export class BillingSubscriptionItem extends BaseResource implements BillingSubs
: undefined;

this.credits = data.credits ? billingCreditsFromJSON(data.credits) : undefined;
this.nextPayment =
data.next_payment === undefined
? undefined
: data.next_payment === null
? null
: billingSubscriptionItemNextPaymentFromJSON(data.next_payment);

this.isFreeTrial = this.withDefault(data.is_free_trial, false);
return this;
Expand Down
160 changes: 158 additions & 2 deletions packages/clerk-js/src/utils/__tests__/billing.test.ts
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,17 @@
import type { BillingMoneyAmountJSON, BillingPaymentTotalsJSON } from '@clerk/shared/types';
import type {
BillingMoneyAmountJSON,
BillingPaymentTotalsJSON,
BillingSubscriptionItemNextPaymentJSON,
BillingSubscriptionNextPaymentJSON,
BillingTotalsJSON,
} from '@clerk/shared/types';
import { describe, expect, it } from 'vitest';

import { billingPaymentTotalsFromJSON } from '../billing';
import {
billingPaymentTotalsFromJSON,
billingSubscriptionItemNextPaymentFromJSON,
billingSubscriptionNextPaymentFromJSON,
} from '../billing';

const moneyJSON = (amount: number): BillingMoneyAmountJSON => ({
amount,
Expand All@@ -10,6 +20,55 @@ const moneyJSON = (amount: number): BillingMoneyAmountJSON => ({
currency_symbol: '$',
});

const nextPaymentTotalsJSON = (): BillingTotalsJSON => ({
subtotal: moneyJSON(5000),
base_fee: moneyJSON(1000),
tax_total: moneyJSON(500),
grand_total: moneyJSON(5500),
credits: {
proration: null,
payer: {
remaining_balance: moneyJSON(2000),
applied_amount: moneyJSON(1000),
},
total: moneyJSON(1000),
},
discounts: {
proration: {
amount: moneyJSON(500),
cycle_days_passed: 15,
cycle_days_total: 30,
cycle_passed_percent: 50,
},
total: moneyJSON(500),
},
total_due_after_free_trial: null,
credit: null,
past_due: null,
total_due_now: moneyJSON(4500),
per_unit_totals: [
{
name: 'seats',
block_size: 1,
tiers: [{ quantity: 5, fee_per_block: moneyJSON(1000), total: moneyJSON(5000) }],
},
],
totals_due_per_period: {
subtotal: moneyJSON(10000),
base_fee: moneyJSON(1000),
tax_total: moneyJSON(1000),
grand_total: moneyJSON(11000),
per_unit_totals: [
{
name: 'seats',
block_size: 1,
tiers: [{ quantity: 10, fee_per_block: moneyJSON(1000), total: moneyJSON(10000) }],
},
],
},
total_due_per_period: moneyJSON(11000),
});

describe('billingPaymentTotalsFromJSON', () => {
it('maps subtotal, grand_total, and tax_total', () => {
const data: BillingPaymentTotalsJSON = {
Expand DownExpand Up@@ -68,3 +127,100 @@ describe('billingPaymentTotalsFromJSON', () => {
expect(totals.perUnitTotals?.[0].tiers[1].quantity).toBeNull();
});
});

describe('billingSubscriptionNextPaymentFromJSON', () => {
it('maps amount, date, and per_unit_totals', () => {
const data: BillingSubscriptionNextPaymentJSON = {
amount: moneyJSON(5000),
date: 1_609_459_200_000,
per_unit_totals: [
{
name: 'seats',
block_size: 1,
tiers: [{ quantity: 5, fee_per_block: moneyJSON(1000), total: moneyJSON(5000) }],
},
],
totals: nextPaymentTotalsJSON(),
};

const nextPayment = billingSubscriptionNextPaymentFromJSON(data);

expect(nextPayment.amount.amount).toBe(5000);
expect(nextPayment.date).toEqual(new Date('2021-01-01T00:00:00.000Z'));
expect(nextPayment.perUnitTotals?.[0]).toMatchObject({
name: 'seats',
blockSize: 1,
tiers: [{ quantity: 5, feePerBlock: { amount: 1000 }, total: { amount: 5000 } }],
});
expect(nextPayment.totals).toMatchObject({
subtotal: { amount: 5000 },
baseFee: { amount: 1000 },
taxTotal: { amount: 500 },
grandTotal: { amount: 5500 },
totalDueAfterFreeTrial: null,
credit: null,
pastDue: null,
totalDueNow: { amount: 4500 },
totalDuePerPeriod: { amount: 11000 },
credits: {
payer: {
remainingBalance: { amount: 2000 },
appliedAmount: { amount: 1000 },
},
total: { amount: 1000 },
},
discounts: {
proration: {
amount: { amount: 500 },
cycleDaysPassed: 15,
cycleDaysTotal: 30,
cyclePassedPercent: 50,
},
total: { amount: 500 },
},
perUnitTotals: [{ name: 'seats', blockSize: 1 }],
totalsDuePerPeriod: {
subtotal: { amount: 10000 },
baseFee: { amount: 1000 },
taxTotal: { amount: 1000 },
grandTotal: { amount: 11000 },
perUnitTotals: [{ name: 'seats', blockSize: 1 }],
},
});
});
});

describe('billingSubscriptionItemNextPaymentFromJSON', () => {
it('maps amount, date, and per_unit_totals', () => {
const data: BillingSubscriptionItemNextPaymentJSON = {
amount: moneyJSON(5000),
date: 1_609_459_200_000,
per_unit_totals: [
{
name: 'seats',
block_size: 1,
tiers: [{ quantity: 5, fee_per_block: moneyJSON(1000), total: moneyJSON(5000) }],
},
],
totals: nextPaymentTotalsJSON(),
};

const nextPayment = billingSubscriptionItemNextPaymentFromJSON(data);

expect(nextPayment.amount.amount).toBe(5000);
expect(nextPayment.date).toEqual(new Date('2021-01-01T00:00:00.000Z'));
expect(nextPayment.perUnitTotals?.[0]).toMatchObject({
name: 'seats',
blockSize: 1,
tiers: [{ quantity: 5, feePerBlock: { amount: 1000 }, total: { amount: 5000 } }],
});
expect(nextPayment.totals).toMatchObject({
subtotal: { amount: 5000 },
baseFee: { amount: 1000 },
totalDueNow: { amount: 4500 },
credits: { total: { amount: 1000 } },
discounts: { total: { amount: 500 } },
perUnitTotals: [{ name: 'seats', blockSize: 1 }],
});
});
});
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Strip utm_, fbclid, gclid, etc. from all links on page (function() { var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content', 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid', 'ref', 'ref_src', 'source', 'medium', 'campaign']; function cleanUrl(url) { try { var u = new URL(url, window.location.origin); var changed = false; trackingParams.forEach(function(p) { if (u.searchParams.has(p)) { u.searchParams.delete(p); changed = true; } }); return changed ? u.toString() : url; } catch (e) { return url; } } function cleanLinks() { document.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } cleanLinks(); var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1) { if (node.tagName === 'A') cleanLinks(); node.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + ' fix(clerk-js,shared): Update type for next_payment by dstaley · Pull Request #8739 · clerk/javascript · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions packages/clerk-js/src/core/resources/BillingCheckout.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,7 @@ import { retry } from '@clerk/shared/retry';
import type {
BillingCheckoutJSON,
BillingCheckoutResource,
BillingCheckoutTotals,
BillingTotals,
BillingPayerResource,
BillingPaymentMethodResource,
BillingSubscriptionPlanPeriod,
Expand DownExpand Up@@ -34,7 +34,7 @@ export class BillingCheckout extends BaseResource implements BillingCheckoutReso
planPeriod!: BillingSubscriptionPlanPeriod;
planPeriodStart!: number | undefined;
status!: 'needs_confirmation' | 'completed';
totals!: BillingCheckoutTotals;
totals!: BillingTotals;
isImmediatePlanChange!: boolean;
freeTrialEndsAt?: Date;
payer!: BillingPayerResource;
Expand Down
4 changes: 2 additions & 2 deletions packages/clerk-js/src/core/resources/BillingStatement.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,7 +6,7 @@ import type {
BillingStatementTotals,
} from '@clerk/shared/types';

import { billingTotalsFromJSON } from '../../utils';
import { billingStatementTotalsFromJSON } from '../../utils';
import { unixEpochToDate } from '../../utils/date';
import { BaseResource, BillingPayment } from './internal';

Expand All@@ -30,7 +30,7 @@ export class BillingStatement extends BaseResource implements BillingStatementRe
this.id = data.id;
this.status = data.status;
this.timestamp = unixEpochToDate(data.timestamp);
this.totals = billingTotalsFromJSON(data.totals);
this.totals = billingStatementTotalsFromJSON(data.totals);
this.groups = data.groups.map(group => new BillingStatementGroup(group));
return this;
}
Expand Down
33 changes: 22 additions & 11 deletions packages/clerk-js/src/core/resources/BillingSubscription.ts
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
import type {
BillingCredits,
BillingMoneyAmount,
BillingSubscriptionItemNextPayment,
BillingSubscriptionNextPayment,
BillingSubscriptionItemJSON,
BillingSubscriptionItemResource,
BillingSubscriptionItemSeats,
Expand All@@ -14,7 +16,12 @@ import type {

import { unixEpochToDate } from '@/utils/date';

import { billingCreditsFromJSON, billingMoneyAmountFromJSON, billingPerUnitTotalTierFromJSON } from '../../utils';
import {
billingCreditsFromJSON,
billingMoneyAmountFromJSON,
billingSubscriptionItemNextPaymentFromJSON,
billingSubscriptionNextPaymentFromJSON,
} from '../../utils';
import { Billing } from '../modules/billing/namespace';
import { BaseResource, BillingPlan, DeletedObject } from './internal';

Expand All@@ -25,10 +32,7 @@ export class BillingSubscription extends BaseResource implements BillingSubscrip
createdAt!: Date;
pastDueAt!: Date | null;
updatedAt!: Date | null;
nextPayment?: {
amount: BillingMoneyAmount;
date: Date;
};
nextPayment?: BillingSubscriptionNextPayment | null;
subscriptionItems!: BillingSubscriptionItemResource[];
eligibleForFreeTrial!: boolean;

Expand All@@ -49,12 +53,12 @@ export class BillingSubscription extends BaseResource implements BillingSubscrip
this.activeAt = unixEpochToDate(data.active_at);
this.pastDueAt = data.past_due_at ? unixEpochToDate(data.past_due_at) : null;

if (data.next_payment) {
this.nextPayment = {
amount: billingMoneyAmountFromJSON(data.next_payment.amount),
date: unixEpochToDate(data.next_payment.date),
};
}
this.nextPayment =
data.next_payment === undefined
? undefined
: data.next_payment === null
? null
: billingSubscriptionNextPaymentFromJSON(data.next_payment);

this.subscriptionItems = (data.subscription_items || []).map(item => new BillingSubscriptionItem(item));
this.eligibleForFreeTrial = this.withDefault(data.eligible_for_free_trial, false);
Expand All@@ -80,6 +84,7 @@ export class BillingSubscriptionItem extends BaseResource implements BillingSubs
};
seats?: BillingSubscriptionItemSeats;
credits?: BillingCredits;
nextPayment?: BillingSubscriptionItemNextPayment | null;
isFreeTrial!: boolean;

constructor(data: BillingSubscriptionItemJSON) {
Expand DownExpand Up@@ -116,6 +121,12 @@ export class BillingSubscriptionItem extends BaseResource implements BillingSubs
: undefined;

this.credits = data.credits ? billingCreditsFromJSON(data.credits) : undefined;
this.nextPayment =
data.next_payment === undefined
? undefined
: data.next_payment === null
? null
: billingSubscriptionItemNextPaymentFromJSON(data.next_payment);

this.isFreeTrial = this.withDefault(data.is_free_trial, false);
return this;
Expand Down
160 changes: 158 additions & 2 deletions packages/clerk-js/src/utils/__tests__/billing.test.ts
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,17 @@
import type { BillingMoneyAmountJSON, BillingPaymentTotalsJSON } from '@clerk/shared/types';
import type {
BillingMoneyAmountJSON,
BillingPaymentTotalsJSON,
BillingSubscriptionItemNextPaymentJSON,
BillingSubscriptionNextPaymentJSON,
BillingTotalsJSON,
} from '@clerk/shared/types';
import { describe, expect, it } from 'vitest';

import { billingPaymentTotalsFromJSON } from '../billing';
import {
billingPaymentTotalsFromJSON,
billingSubscriptionItemNextPaymentFromJSON,
billingSubscriptionNextPaymentFromJSON,
} from '../billing';

const moneyJSON = (amount: number): BillingMoneyAmountJSON => ({
amount,
Expand All@@ -10,6 +20,55 @@ const moneyJSON = (amount: number): BillingMoneyAmountJSON => ({
currency_symbol: '$',
});

const nextPaymentTotalsJSON = (): BillingTotalsJSON => ({
subtotal: moneyJSON(5000),
base_fee: moneyJSON(1000),
tax_total: moneyJSON(500),
grand_total: moneyJSON(5500),
credits: {
proration: null,
payer: {
remaining_balance: moneyJSON(2000),
applied_amount: moneyJSON(1000),
},
total: moneyJSON(1000),
},
discounts: {
proration: {
amount: moneyJSON(500),
cycle_days_passed: 15,
cycle_days_total: 30,
cycle_passed_percent: 50,
},
total: moneyJSON(500),
},
total_due_after_free_trial: null,
credit: null,
past_due: null,
total_due_now: moneyJSON(4500),
per_unit_totals: [
{
name: 'seats',
block_size: 1,
tiers: [{ quantity: 5, fee_per_block: moneyJSON(1000), total: moneyJSON(5000) }],
},
],
totals_due_per_period: {
subtotal: moneyJSON(10000),
base_fee: moneyJSON(1000),
tax_total: moneyJSON(1000),
grand_total: moneyJSON(11000),
per_unit_totals: [
{
name: 'seats',
block_size: 1,
tiers: [{ quantity: 10, fee_per_block: moneyJSON(1000), total: moneyJSON(10000) }],
},
],
},
total_due_per_period: moneyJSON(11000),
});

describe('billingPaymentTotalsFromJSON', () => {
it('maps subtotal, grand_total, and tax_total', () => {
const data: BillingPaymentTotalsJSON = {
Expand DownExpand Up@@ -68,3 +127,100 @@ describe('billingPaymentTotalsFromJSON', () => {
expect(totals.perUnitTotals?.[0].tiers[1].quantity).toBeNull();
});
});

describe('billingSubscriptionNextPaymentFromJSON', () => {
it('maps amount, date, and per_unit_totals', () => {
const data: BillingSubscriptionNextPaymentJSON = {
amount: moneyJSON(5000),
date: 1_609_459_200_000,
per_unit_totals: [
{
name: 'seats',
block_size: 1,
tiers: [{ quantity: 5, fee_per_block: moneyJSON(1000), total: moneyJSON(5000) }],
},
],
totals: nextPaymentTotalsJSON(),
};

const nextPayment = billingSubscriptionNextPaymentFromJSON(data);

expect(nextPayment.amount.amount).toBe(5000);
expect(nextPayment.date).toEqual(new Date('2021-01-01T00:00:00.000Z'));
expect(nextPayment.perUnitTotals?.[0]).toMatchObject({
name: 'seats',
blockSize: 1,
tiers: [{ quantity: 5, feePerBlock: { amount: 1000 }, total: { amount: 5000 } }],
});
expect(nextPayment.totals).toMatchObject({
subtotal: { amount: 5000 },
baseFee: { amount: 1000 },
taxTotal: { amount: 500 },
grandTotal: { amount: 5500 },
totalDueAfterFreeTrial: null,
credit: null,
pastDue: null,
totalDueNow: { amount: 4500 },
totalDuePerPeriod: { amount: 11000 },
credits: {
payer: {
remainingBalance: { amount: 2000 },
appliedAmount: { amount: 1000 },
},
total: { amount: 1000 },
},
discounts: {
proration: {
amount: { amount: 500 },
cycleDaysPassed: 15,
cycleDaysTotal: 30,
cyclePassedPercent: 50,
},
total: { amount: 500 },
},
perUnitTotals: [{ name: 'seats', blockSize: 1 }],
totalsDuePerPeriod: {
subtotal: { amount: 10000 },
baseFee: { amount: 1000 },
taxTotal: { amount: 1000 },
grandTotal: { amount: 11000 },
perUnitTotals: [{ name: 'seats', blockSize: 1 }],
},
});
});
});

describe('billingSubscriptionItemNextPaymentFromJSON', () => {
it('maps amount, date, and per_unit_totals', () => {
const data: BillingSubscriptionItemNextPaymentJSON = {
amount: moneyJSON(5000),
date: 1_609_459_200_000,
per_unit_totals: [
{
name: 'seats',
block_size: 1,
tiers: [{ quantity: 5, fee_per_block: moneyJSON(1000), total: moneyJSON(5000) }],
},
],
totals: nextPaymentTotalsJSON(),
};

const nextPayment = billingSubscriptionItemNextPaymentFromJSON(data);

expect(nextPayment.amount.amount).toBe(5000);
expect(nextPayment.date).toEqual(new Date('2021-01-01T00:00:00.000Z'));
expect(nextPayment.perUnitTotals?.[0]).toMatchObject({
name: 'seats',
blockSize: 1,
tiers: [{ quantity: 5, feePerBlock: { amount: 1000 }, total: { amount: 5000 } }],
});
expect(nextPayment.totals).toMatchObject({
subtotal: { amount: 5000 },
baseFee: { amount: 1000 },
totalDueNow: { amount: 4500 },
credits: { total: { amount: 1000 } },
discounts: { total: { amount: 500 } },
perUnitTotals: [{ name: 'seats', blockSize: 1 }],
});
});
});
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Auto-enable theater mode on YouTube (function() { function tryTheater() { var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]'); if (btn && !btn.classList.contains('activated')) { btn.click(); } } // Try immediately tryTheater(); // Try after navigation (SPA) var lastUrl = location.href; setInterval(function() { if (location.href !== lastUrl) { lastUrl = location.href; setTimeout(tryTheater, 500); } }, 1000); // Also try on player load var observer = new MutationObserver(tryTheater); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' fix(clerk-js,shared): Update type for next_payment by dstaley · Pull Request #8739 · clerk/javascript · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions packages/clerk-js/src/core/resources/BillingCheckout.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,7 @@ import { retry } from '@clerk/shared/retry';
import type {
BillingCheckoutJSON,
BillingCheckoutResource,
BillingCheckoutTotals,
BillingTotals,
BillingPayerResource,
BillingPaymentMethodResource,
BillingSubscriptionPlanPeriod,
Expand DownExpand Up@@ -34,7 +34,7 @@ export class BillingCheckout extends BaseResource implements BillingCheckoutReso
planPeriod!: BillingSubscriptionPlanPeriod;
planPeriodStart!: number | undefined;
status!: 'needs_confirmation' | 'completed';
totals!: BillingCheckoutTotals;
totals!: BillingTotals;
isImmediatePlanChange!: boolean;
freeTrialEndsAt?: Date;
payer!: BillingPayerResource;
Expand Down
4 changes: 2 additions & 2 deletions packages/clerk-js/src/core/resources/BillingStatement.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,7 +6,7 @@ import type {
BillingStatementTotals,
} from '@clerk/shared/types';

import { billingTotalsFromJSON } from '../../utils';
import { billingStatementTotalsFromJSON } from '../../utils';
import { unixEpochToDate } from '../../utils/date';
import { BaseResource, BillingPayment } from './internal';

Expand All@@ -30,7 +30,7 @@ export class BillingStatement extends BaseResource implements BillingStatementRe
this.id = data.id;
this.status = data.status;
this.timestamp = unixEpochToDate(data.timestamp);
this.totals = billingTotalsFromJSON(data.totals);
this.totals = billingStatementTotalsFromJSON(data.totals);
this.groups = data.groups.map(group => new BillingStatementGroup(group));
return this;
}
Expand Down
33 changes: 22 additions & 11 deletions packages/clerk-js/src/core/resources/BillingSubscription.ts
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
import type {
BillingCredits,
BillingMoneyAmount,
BillingSubscriptionItemNextPayment,
BillingSubscriptionNextPayment,
BillingSubscriptionItemJSON,
BillingSubscriptionItemResource,
BillingSubscriptionItemSeats,
Expand All@@ -14,7 +16,12 @@ import type {

import { unixEpochToDate } from '@/utils/date';

import { billingCreditsFromJSON, billingMoneyAmountFromJSON, billingPerUnitTotalTierFromJSON } from '../../utils';
import {
billingCreditsFromJSON,
billingMoneyAmountFromJSON,
billingSubscriptionItemNextPaymentFromJSON,
billingSubscriptionNextPaymentFromJSON,
} from '../../utils';
import { Billing } from '../modules/billing/namespace';
import { BaseResource, BillingPlan, DeletedObject } from './internal';

Expand All@@ -25,10 +32,7 @@ export class BillingSubscription extends BaseResource implements BillingSubscrip
createdAt!: Date;
pastDueAt!: Date | null;
updatedAt!: Date | null;
nextPayment?: {
amount: BillingMoneyAmount;
date: Date;
};
nextPayment?: BillingSubscriptionNextPayment | null;
subscriptionItems!: BillingSubscriptionItemResource[];
eligibleForFreeTrial!: boolean;

Expand All@@ -49,12 +53,12 @@ export class BillingSubscription extends BaseResource implements BillingSubscrip
this.activeAt = unixEpochToDate(data.active_at);
this.pastDueAt = data.past_due_at ? unixEpochToDate(data.past_due_at) : null;

if (data.next_payment) {
this.nextPayment = {
amount: billingMoneyAmountFromJSON(data.next_payment.amount),
date: unixEpochToDate(data.next_payment.date),
};
}
this.nextPayment =
data.next_payment === undefined
? undefined
: data.next_payment === null
? null
: billingSubscriptionNextPaymentFromJSON(data.next_payment);

this.subscriptionItems = (data.subscription_items || []).map(item => new BillingSubscriptionItem(item));
this.eligibleForFreeTrial = this.withDefault(data.eligible_for_free_trial, false);
Expand All@@ -80,6 +84,7 @@ export class BillingSubscriptionItem extends BaseResource implements BillingSubs
};
seats?: BillingSubscriptionItemSeats;
credits?: BillingCredits;
nextPayment?: BillingSubscriptionItemNextPayment | null;
isFreeTrial!: boolean;

constructor(data: BillingSubscriptionItemJSON) {
Expand DownExpand Up@@ -116,6 +121,12 @@ export class BillingSubscriptionItem extends BaseResource implements BillingSubs
: undefined;

this.credits = data.credits ? billingCreditsFromJSON(data.credits) : undefined;
this.nextPayment =
data.next_payment === undefined
? undefined
: data.next_payment === null
? null
: billingSubscriptionItemNextPaymentFromJSON(data.next_payment);

this.isFreeTrial = this.withDefault(data.is_free_trial, false);
return this;
Expand Down
160 changes: 158 additions & 2 deletions packages/clerk-js/src/utils/__tests__/billing.test.ts
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,17 @@
import type { BillingMoneyAmountJSON, BillingPaymentTotalsJSON } from '@clerk/shared/types';
import type {
BillingMoneyAmountJSON,
BillingPaymentTotalsJSON,
BillingSubscriptionItemNextPaymentJSON,
BillingSubscriptionNextPaymentJSON,
BillingTotalsJSON,
} from '@clerk/shared/types';
import { describe, expect, it } from 'vitest';

import { billingPaymentTotalsFromJSON } from '../billing';
import {
billingPaymentTotalsFromJSON,
billingSubscriptionItemNextPaymentFromJSON,
billingSubscriptionNextPaymentFromJSON,
} from '../billing';

const moneyJSON = (amount: number): BillingMoneyAmountJSON => ({
amount,
Expand All@@ -10,6 +20,55 @@ const moneyJSON = (amount: number): BillingMoneyAmountJSON => ({
currency_symbol: '$',
});

const nextPaymentTotalsJSON = (): BillingTotalsJSON => ({
subtotal: moneyJSON(5000),
base_fee: moneyJSON(1000),
tax_total: moneyJSON(500),
grand_total: moneyJSON(5500),
credits: {
proration: null,
payer: {
remaining_balance: moneyJSON(2000),
applied_amount: moneyJSON(1000),
},
total: moneyJSON(1000),
},
discounts: {
proration: {
amount: moneyJSON(500),
cycle_days_passed: 15,
cycle_days_total: 30,
cycle_passed_percent: 50,
},
total: moneyJSON(500),
},
total_due_after_free_trial: null,
credit: null,
past_due: null,
total_due_now: moneyJSON(4500),
per_unit_totals: [
{
name: 'seats',
block_size: 1,
tiers: [{ quantity: 5, fee_per_block: moneyJSON(1000), total: moneyJSON(5000) }],
},
],
totals_due_per_period: {
subtotal: moneyJSON(10000),
base_fee: moneyJSON(1000),
tax_total: moneyJSON(1000),
grand_total: moneyJSON(11000),
per_unit_totals: [
{
name: 'seats',
block_size: 1,
tiers: [{ quantity: 10, fee_per_block: moneyJSON(1000), total: moneyJSON(10000) }],
},
],
},
total_due_per_period: moneyJSON(11000),
});

describe('billingPaymentTotalsFromJSON', () => {
it('maps subtotal, grand_total, and tax_total', () => {
const data: BillingPaymentTotalsJSON = {
Expand DownExpand Up@@ -68,3 +127,100 @@ describe('billingPaymentTotalsFromJSON', () => {
expect(totals.perUnitTotals?.[0].tiers[1].quantity).toBeNull();
});
});

describe('billingSubscriptionNextPaymentFromJSON', () => {
it('maps amount, date, and per_unit_totals', () => {
const data: BillingSubscriptionNextPaymentJSON = {
amount: moneyJSON(5000),
date: 1_609_459_200_000,
per_unit_totals: [
{
name: 'seats',
block_size: 1,
tiers: [{ quantity: 5, fee_per_block: moneyJSON(1000), total: moneyJSON(5000) }],
},
],
totals: nextPaymentTotalsJSON(),
};

const nextPayment = billingSubscriptionNextPaymentFromJSON(data);

expect(nextPayment.amount.amount).toBe(5000);
expect(nextPayment.date).toEqual(new Date('2021-01-01T00:00:00.000Z'));
expect(nextPayment.perUnitTotals?.[0]).toMatchObject({
name: 'seats',
blockSize: 1,
tiers: [{ quantity: 5, feePerBlock: { amount: 1000 }, total: { amount: 5000 } }],
});
expect(nextPayment.totals).toMatchObject({
subtotal: { amount: 5000 },
baseFee: { amount: 1000 },
taxTotal: { amount: 500 },
grandTotal: { amount: 5500 },
totalDueAfterFreeTrial: null,
credit: null,
pastDue: null,
totalDueNow: { amount: 4500 },
totalDuePerPeriod: { amount: 11000 },
credits: {
payer: {
remainingBalance: { amount: 2000 },
appliedAmount: { amount: 1000 },
},
total: { amount: 1000 },
},
discounts: {
proration: {
amount: { amount: 500 },
cycleDaysPassed: 15,
cycleDaysTotal: 30,
cyclePassedPercent: 50,
},
total: { amount: 500 },
},
perUnitTotals: [{ name: 'seats', blockSize: 1 }],
totalsDuePerPeriod: {
subtotal: { amount: 10000 },
baseFee: { amount: 1000 },
taxTotal: { amount: 1000 },
grandTotal: { amount: 11000 },
perUnitTotals: [{ name: 'seats', blockSize: 1 }],
},
});
});
});

describe('billingSubscriptionItemNextPaymentFromJSON', () => {
it('maps amount, date, and per_unit_totals', () => {
const data: BillingSubscriptionItemNextPaymentJSON = {
amount: moneyJSON(5000),
date: 1_609_459_200_000,
per_unit_totals: [
{
name: 'seats',
block_size: 1,
tiers: [{ quantity: 5, fee_per_block: moneyJSON(1000), total: moneyJSON(5000) }],
},
],
totals: nextPaymentTotalsJSON(),
};

const nextPayment = billingSubscriptionItemNextPaymentFromJSON(data);

expect(nextPayment.amount.amount).toBe(5000);
expect(nextPayment.date).toEqual(new Date('2021-01-01T00:00:00.000Z'));
expect(nextPayment.perUnitTotals?.[0]).toMatchObject({
name: 'seats',
blockSize: 1,
tiers: [{ quantity: 5, feePerBlock: { amount: 1000 }, total: { amount: 5000 } }],
});
expect(nextPayment.totals).toMatchObject({
subtotal: { amount: 5000 },
baseFee: { amount: 1000 },
totalDueNow: { amount: 4500 },
credits: { total: { amount: 1000 } },
discounts: { total: { amount: 500 } },
perUnitTotals: [{ name: 'seats', blockSize: 1 }],
});
});
});
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Remove or un-stick sticky/fixed headers that block content (function() { function unstick() { document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) { if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') { el.style.position = 'static'; el.style.top = 'auto'; el.style.zIndex = 'auto'; } }); } unstick(); var observer = new MutationObserver(unstick); observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] }); })(); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' fix(clerk-js,shared): Update type for next_payment by dstaley · Pull Request #8739 · clerk/javascript · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions packages/clerk-js/src/core/resources/BillingCheckout.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,7 @@ import { retry } from '@clerk/shared/retry';
import type {
BillingCheckoutJSON,
BillingCheckoutResource,
BillingCheckoutTotals,
BillingTotals,
BillingPayerResource,
BillingPaymentMethodResource,
BillingSubscriptionPlanPeriod,
Expand DownExpand Up@@ -34,7 +34,7 @@ export class BillingCheckout extends BaseResource implements BillingCheckoutReso
planPeriod!: BillingSubscriptionPlanPeriod;
planPeriodStart!: number | undefined;
status!: 'needs_confirmation' | 'completed';
totals!: BillingCheckoutTotals;
totals!: BillingTotals;
isImmediatePlanChange!: boolean;
freeTrialEndsAt?: Date;
payer!: BillingPayerResource;
Expand Down
4 changes: 2 additions & 2 deletions packages/clerk-js/src/core/resources/BillingStatement.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,7 +6,7 @@ import type {
BillingStatementTotals,
} from '@clerk/shared/types';

import { billingTotalsFromJSON } from '../../utils';
import { billingStatementTotalsFromJSON } from '../../utils';
import { unixEpochToDate } from '../../utils/date';
import { BaseResource, BillingPayment } from './internal';

Expand All@@ -30,7 +30,7 @@ export class BillingStatement extends BaseResource implements BillingStatementRe
this.id = data.id;
this.status = data.status;
this.timestamp = unixEpochToDate(data.timestamp);
this.totals = billingTotalsFromJSON(data.totals);
this.totals = billingStatementTotalsFromJSON(data.totals);
this.groups = data.groups.map(group => new BillingStatementGroup(group));
return this;
}
Expand Down
33 changes: 22 additions & 11 deletions packages/clerk-js/src/core/resources/BillingSubscription.ts
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
import type {
BillingCredits,
BillingMoneyAmount,
BillingSubscriptionItemNextPayment,
BillingSubscriptionNextPayment,
BillingSubscriptionItemJSON,
BillingSubscriptionItemResource,
BillingSubscriptionItemSeats,
Expand All@@ -14,7 +16,12 @@ import type {

import { unixEpochToDate } from '@/utils/date';

import { billingCreditsFromJSON, billingMoneyAmountFromJSON, billingPerUnitTotalTierFromJSON } from '../../utils';
import {
billingCreditsFromJSON,
billingMoneyAmountFromJSON,
billingSubscriptionItemNextPaymentFromJSON,
billingSubscriptionNextPaymentFromJSON,
} from '../../utils';
import { Billing } from '../modules/billing/namespace';
import { BaseResource, BillingPlan, DeletedObject } from './internal';

Expand All@@ -25,10 +32,7 @@ export class BillingSubscription extends BaseResource implements BillingSubscrip
createdAt!: Date;
pastDueAt!: Date | null;
updatedAt!: Date | null;
nextPayment?: {
amount: BillingMoneyAmount;
date: Date;
};
nextPayment?: BillingSubscriptionNextPayment | null;
subscriptionItems!: BillingSubscriptionItemResource[];
eligibleForFreeTrial!: boolean;

Expand All@@ -49,12 +53,12 @@ export class BillingSubscription extends BaseResource implements BillingSubscrip
this.activeAt = unixEpochToDate(data.active_at);
this.pastDueAt = data.past_due_at ? unixEpochToDate(data.past_due_at) : null;

if (data.next_payment) {
this.nextPayment = {
amount: billingMoneyAmountFromJSON(data.next_payment.amount),
date: unixEpochToDate(data.next_payment.date),
};
}
this.nextPayment =
data.next_payment === undefined
? undefined
: data.next_payment === null
? null
: billingSubscriptionNextPaymentFromJSON(data.next_payment);

this.subscriptionItems = (data.subscription_items || []).map(item => new BillingSubscriptionItem(item));
this.eligibleForFreeTrial = this.withDefault(data.eligible_for_free_trial, false);
Expand All@@ -80,6 +84,7 @@ export class BillingSubscriptionItem extends BaseResource implements BillingSubs
};
seats?: BillingSubscriptionItemSeats;
credits?: BillingCredits;
nextPayment?: BillingSubscriptionItemNextPayment | null;
isFreeTrial!: boolean;

constructor(data: BillingSubscriptionItemJSON) {
Expand DownExpand Up@@ -116,6 +121,12 @@ export class BillingSubscriptionItem extends BaseResource implements BillingSubs
: undefined;

this.credits = data.credits ? billingCreditsFromJSON(data.credits) : undefined;
this.nextPayment =
data.next_payment === undefined
? undefined
: data.next_payment === null
? null
: billingSubscriptionItemNextPaymentFromJSON(data.next_payment);

this.isFreeTrial = this.withDefault(data.is_free_trial, false);
return this;
Expand Down
160 changes: 158 additions & 2 deletions packages/clerk-js/src/utils/__tests__/billing.test.ts
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,17 @@
import type { BillingMoneyAmountJSON, BillingPaymentTotalsJSON } from '@clerk/shared/types';
import type {
BillingMoneyAmountJSON,
BillingPaymentTotalsJSON,
BillingSubscriptionItemNextPaymentJSON,
BillingSubscriptionNextPaymentJSON,
BillingTotalsJSON,
} from '@clerk/shared/types';
import { describe, expect, it } from 'vitest';

import { billingPaymentTotalsFromJSON } from '../billing';
import {
billingPaymentTotalsFromJSON,
billingSubscriptionItemNextPaymentFromJSON,
billingSubscriptionNextPaymentFromJSON,
} from '../billing';

const moneyJSON = (amount: number): BillingMoneyAmountJSON => ({
amount,
Expand All@@ -10,6 +20,55 @@ const moneyJSON = (amount: number): BillingMoneyAmountJSON => ({
currency_symbol: '$',
});

const nextPaymentTotalsJSON = (): BillingTotalsJSON => ({
subtotal: moneyJSON(5000),
base_fee: moneyJSON(1000),
tax_total: moneyJSON(500),
grand_total: moneyJSON(5500),
credits: {
proration: null,
payer: {
remaining_balance: moneyJSON(2000),
applied_amount: moneyJSON(1000),
},
total: moneyJSON(1000),
},
discounts: {
proration: {
amount: moneyJSON(500),
cycle_days_passed: 15,
cycle_days_total: 30,
cycle_passed_percent: 50,
},
total: moneyJSON(500),
},
total_due_after_free_trial: null,
credit: null,
past_due: null,
total_due_now: moneyJSON(4500),
per_unit_totals: [
{
name: 'seats',
block_size: 1,
tiers: [{ quantity: 5, fee_per_block: moneyJSON(1000), total: moneyJSON(5000) }],
},
],
totals_due_per_period: {
subtotal: moneyJSON(10000),
base_fee: moneyJSON(1000),
tax_total: moneyJSON(1000),
grand_total: moneyJSON(11000),
per_unit_totals: [
{
name: 'seats',
block_size: 1,
tiers: [{ quantity: 10, fee_per_block: moneyJSON(1000), total: moneyJSON(10000) }],
},
],
},
total_due_per_period: moneyJSON(11000),
});

describe('billingPaymentTotalsFromJSON', () => {
it('maps subtotal, grand_total, and tax_total', () => {
const data: BillingPaymentTotalsJSON = {
Expand DownExpand Up@@ -68,3 +127,100 @@ describe('billingPaymentTotalsFromJSON', () => {
expect(totals.perUnitTotals?.[0].tiers[1].quantity).toBeNull();
});
});

describe('billingSubscriptionNextPaymentFromJSON', () => {
it('maps amount, date, and per_unit_totals', () => {
const data: BillingSubscriptionNextPaymentJSON = {
amount: moneyJSON(5000),
date: 1_609_459_200_000,
per_unit_totals: [
{
name: 'seats',
block_size: 1,
tiers: [{ quantity: 5, fee_per_block: moneyJSON(1000), total: moneyJSON(5000) }],
},
],
totals: nextPaymentTotalsJSON(),
};

const nextPayment = billingSubscriptionNextPaymentFromJSON(data);

expect(nextPayment.amount.amount).toBe(5000);
expect(nextPayment.date).toEqual(new Date('2021-01-01T00:00:00.000Z'));
expect(nextPayment.perUnitTotals?.[0]).toMatchObject({
name: 'seats',
blockSize: 1,
tiers: [{ quantity: 5, feePerBlock: { amount: 1000 }, total: { amount: 5000 } }],
});
expect(nextPayment.totals).toMatchObject({
subtotal: { amount: 5000 },
baseFee: { amount: 1000 },
taxTotal: { amount: 500 },
grandTotal: { amount: 5500 },
totalDueAfterFreeTrial: null,
credit: null,
pastDue: null,
totalDueNow: { amount: 4500 },
totalDuePerPeriod: { amount: 11000 },
credits: {
payer: {
remainingBalance: { amount: 2000 },
appliedAmount: { amount: 1000 },
},
total: { amount: 1000 },
},
discounts: {
proration: {
amount: { amount: 500 },
cycleDaysPassed: 15,
cycleDaysTotal: 30,
cyclePassedPercent: 50,
},
total: { amount: 500 },
},
perUnitTotals: [{ name: 'seats', blockSize: 1 }],
totalsDuePerPeriod: {
subtotal: { amount: 10000 },
baseFee: { amount: 1000 },
taxTotal: { amount: 1000 },
grandTotal: { amount: 11000 },
perUnitTotals: [{ name: 'seats', blockSize: 1 }],
},
});
});
});

describe('billingSubscriptionItemNextPaymentFromJSON', () => {
it('maps amount, date, and per_unit_totals', () => {
const data: BillingSubscriptionItemNextPaymentJSON = {
amount: moneyJSON(5000),
date: 1_609_459_200_000,
per_unit_totals: [
{
name: 'seats',
block_size: 1,
tiers: [{ quantity: 5, fee_per_block: moneyJSON(1000), total: moneyJSON(5000) }],
},
],
totals: nextPaymentTotalsJSON(),
};

const nextPayment = billingSubscriptionItemNextPaymentFromJSON(data);

expect(nextPayment.amount.amount).toBe(5000);
expect(nextPayment.date).toEqual(new Date('2021-01-01T00:00:00.000Z'));
expect(nextPayment.perUnitTotals?.[0]).toMatchObject({
name: 'seats',
blockSize: 1,
tiers: [{ quantity: 5, feePerBlock: { amount: 1000 }, total: { amount: 5000 } }],
});
expect(nextPayment.totals).toMatchObject({
subtotal: { amount: 5000 },
baseFee: { amount: 1000 },
totalDueNow: { amount: 4500 },
credits: { total: { amount: 1000 } },
discounts: { total: { amount: 500 } },
perUnitTotals: [{ name: 'seats', blockSize: 1 }],
});
});
});
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Universal Dark Mode - works on any site (function() { var enabled = true; function applyDarkMode() { if (!enabled) return; // Create style element if it doesn't exist var style = document.getElementById('universal-dark-mode-style'); if (!style) { style = document.createElement('style'); style.id = 'universal-dark-mode-style'; document.head.appendChild(style); } // Dark mode CSS - inverts colors but preserves images/video style.textContent = ' /* Invert everything except media */ html { filter: invert(1) hue-rotate(180deg) !important; background: #1a1a2e !important; } /* Restore images, videos, iframes, canvas */ img, video, iframe, canvas, svg, picture, [style*="background-image"] { filter: invert(1) hue-rotate(180deg) !important; } /* Preserve specific elements that should not be inverted */ .no-dark-mode, .no-dark-mode *, [data-theme="light"], [data-theme="light"], .ace_editor, .ace_editor *, .CodeMirror, .CodeMirror *, .monaco-editor, .monaco-editor *, .markdown-body pre, .markdown-body pre *, .highlight, .highlight *, pre code, pre code * { filter: none !important; } /* Fix common UI elements */ .modal, .popup, .dropdown-menu, .tooltip, .popover { filter: invert(1) hue-rotate(180deg) !important; background: #2d2d44 !important; border-color: #444 !important; } /* Scrollbars */ ::-webkit-scrollbar { background: #1a1a2e !important; } ::-webkit-scrollbar-thumb { background: #444 !important; } ::-webkit-scrollbar-thumb:hover { background: #555 !important; } /* Selection */ ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; } ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; } '; } function removeDarkMode() { var style = document.getElementById('universal-dark-mode-style'); if (style) style.remove(); } // Toggle with Alt+Shift+D document.addEventListener('keydown', function(e) { if (e.altKey && e.shiftKey && e.key === 'D') { e.preventDefault(); enabled = !enabled; if (enabled) { applyDarkMode(); console.log('[Universal Dark Mode] Enabled'); } else { removeDarkMode(); console.log('[Universal Dark Mode] Disabled'); } } }); // Apply on load applyDarkMode(); // Re-apply on dynamic content var observer = new MutationObserver(function(mutations) { if (enabled && !document.getElementById('universal-dark-mode-style')) { applyDarkMode(); } }); observer.observe(document.head, { childList: true }); console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle'); })(); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })(); fix(clerk-js,shared): Update type for next_payment by dstaley · Pull Request #8739 · clerk/javascript · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions packages/clerk-js/src/core/resources/BillingCheckout.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,7 @@ import { retry } from '@clerk/shared/retry';
import type {
BillingCheckoutJSON,
BillingCheckoutResource,
BillingCheckoutTotals,
BillingTotals,
BillingPayerResource,
BillingPaymentMethodResource,
BillingSubscriptionPlanPeriod,
Expand DownExpand Up@@ -34,7 +34,7 @@ export class BillingCheckout extends BaseResource implements BillingCheckoutReso
planPeriod!: BillingSubscriptionPlanPeriod;
planPeriodStart!: number | undefined;
status!: 'needs_confirmation' | 'completed';
totals!: BillingCheckoutTotals;
totals!: BillingTotals;
isImmediatePlanChange!: boolean;
freeTrialEndsAt?: Date;
payer!: BillingPayerResource;
Expand Down
4 changes: 2 additions & 2 deletions packages/clerk-js/src/core/resources/BillingStatement.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,7 +6,7 @@ import type {
BillingStatementTotals,
} from '@clerk/shared/types';

import { billingTotalsFromJSON } from '../../utils';
import { billingStatementTotalsFromJSON } from '../../utils';
import { unixEpochToDate } from '../../utils/date';
import { BaseResource, BillingPayment } from './internal';

Expand All@@ -30,7 +30,7 @@ export class BillingStatement extends BaseResource implements BillingStatementRe
this.id = data.id;
this.status = data.status;
this.timestamp = unixEpochToDate(data.timestamp);
this.totals = billingTotalsFromJSON(data.totals);
this.totals = billingStatementTotalsFromJSON(data.totals);
this.groups = data.groups.map(group => new BillingStatementGroup(group));
return this;
}
Expand Down
33 changes: 22 additions & 11 deletions packages/clerk-js/src/core/resources/BillingSubscription.ts
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
import type {
BillingCredits,
BillingMoneyAmount,
BillingSubscriptionItemNextPayment,
BillingSubscriptionNextPayment,
BillingSubscriptionItemJSON,
BillingSubscriptionItemResource,
BillingSubscriptionItemSeats,
Expand All@@ -14,7 +16,12 @@ import type {

import { unixEpochToDate } from '@/utils/date';

import { billingCreditsFromJSON, billingMoneyAmountFromJSON, billingPerUnitTotalTierFromJSON } from '../../utils';
import {
billingCreditsFromJSON,
billingMoneyAmountFromJSON,
billingSubscriptionItemNextPaymentFromJSON,
billingSubscriptionNextPaymentFromJSON,
} from '../../utils';
import { Billing } from '../modules/billing/namespace';
import { BaseResource, BillingPlan, DeletedObject } from './internal';

Expand All@@ -25,10 +32,7 @@ export class BillingSubscription extends BaseResource implements BillingSubscrip
createdAt!: Date;
pastDueAt!: Date | null;
updatedAt!: Date | null;
nextPayment?: {
amount: BillingMoneyAmount;
date: Date;
};
nextPayment?: BillingSubscriptionNextPayment | null;
subscriptionItems!: BillingSubscriptionItemResource[];
eligibleForFreeTrial!: boolean;

Expand All@@ -49,12 +53,12 @@ export class BillingSubscription extends BaseResource implements BillingSubscrip
this.activeAt = unixEpochToDate(data.active_at);
this.pastDueAt = data.past_due_at ? unixEpochToDate(data.past_due_at) : null;

if (data.next_payment) {
this.nextPayment = {
amount: billingMoneyAmountFromJSON(data.next_payment.amount),
date: unixEpochToDate(data.next_payment.date),
};
}
this.nextPayment =
data.next_payment === undefined
? undefined
: data.next_payment === null
? null
: billingSubscriptionNextPaymentFromJSON(data.next_payment);

this.subscriptionItems = (data.subscription_items || []).map(item => new BillingSubscriptionItem(item));
this.eligibleForFreeTrial = this.withDefault(data.eligible_for_free_trial, false);
Expand All@@ -80,6 +84,7 @@ export class BillingSubscriptionItem extends BaseResource implements BillingSubs
};
seats?: BillingSubscriptionItemSeats;
credits?: BillingCredits;
nextPayment?: BillingSubscriptionItemNextPayment | null;
isFreeTrial!: boolean;

constructor(data: BillingSubscriptionItemJSON) {
Expand DownExpand Up@@ -116,6 +121,12 @@ export class BillingSubscriptionItem extends BaseResource implements BillingSubs
: undefined;

this.credits = data.credits ? billingCreditsFromJSON(data.credits) : undefined;
this.nextPayment =
data.next_payment === undefined
? undefined
: data.next_payment === null
? null
: billingSubscriptionItemNextPaymentFromJSON(data.next_payment);

this.isFreeTrial = this.withDefault(data.is_free_trial, false);
return this;
Expand Down
160 changes: 158 additions & 2 deletions packages/clerk-js/src/utils/__tests__/billing.test.ts
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,17 @@
import type { BillingMoneyAmountJSON, BillingPaymentTotalsJSON } from '@clerk/shared/types';
import type {
BillingMoneyAmountJSON,
BillingPaymentTotalsJSON,
BillingSubscriptionItemNextPaymentJSON,
BillingSubscriptionNextPaymentJSON,
BillingTotalsJSON,
} from '@clerk/shared/types';
import { describe, expect, it } from 'vitest';

import { billingPaymentTotalsFromJSON } from '../billing';
import {
billingPaymentTotalsFromJSON,
billingSubscriptionItemNextPaymentFromJSON,
billingSubscriptionNextPaymentFromJSON,
} from '../billing';

const moneyJSON = (amount: number): BillingMoneyAmountJSON => ({
amount,
Expand All@@ -10,6 +20,55 @@ const moneyJSON = (amount: number): BillingMoneyAmountJSON => ({
currency_symbol: '$',
});

const nextPaymentTotalsJSON = (): BillingTotalsJSON => ({
subtotal: moneyJSON(5000),
base_fee: moneyJSON(1000),
tax_total: moneyJSON(500),
grand_total: moneyJSON(5500),
credits: {
proration: null,
payer: {
remaining_balance: moneyJSON(2000),
applied_amount: moneyJSON(1000),
},
total: moneyJSON(1000),
},
discounts: {
proration: {
amount: moneyJSON(500),
cycle_days_passed: 15,
cycle_days_total: 30,
cycle_passed_percent: 50,
},
total: moneyJSON(500),
},
total_due_after_free_trial: null,
credit: null,
past_due: null,
total_due_now: moneyJSON(4500),
per_unit_totals: [
{
name: 'seats',
block_size: 1,
tiers: [{ quantity: 5, fee_per_block: moneyJSON(1000), total: moneyJSON(5000) }],
},
],
totals_due_per_period: {
subtotal: moneyJSON(10000),
base_fee: moneyJSON(1000),
tax_total: moneyJSON(1000),
grand_total: moneyJSON(11000),
per_unit_totals: [
{
name: 'seats',
block_size: 1,
tiers: [{ quantity: 10, fee_per_block: moneyJSON(1000), total: moneyJSON(10000) }],
},
],
},
total_due_per_period: moneyJSON(11000),
});

describe('billingPaymentTotalsFromJSON', () => {
it('maps subtotal, grand_total, and tax_total', () => {
const data: BillingPaymentTotalsJSON = {
Expand DownExpand Up@@ -68,3 +127,100 @@ describe('billingPaymentTotalsFromJSON', () => {
expect(totals.perUnitTotals?.[0].tiers[1].quantity).toBeNull();
});
});

describe('billingSubscriptionNextPaymentFromJSON', () => {
it('maps amount, date, and per_unit_totals', () => {
const data: BillingSubscriptionNextPaymentJSON = {
amount: moneyJSON(5000),
date: 1_609_459_200_000,
per_unit_totals: [
{
name: 'seats',
block_size: 1,
tiers: [{ quantity: 5, fee_per_block: moneyJSON(1000), total: moneyJSON(5000) }],
},
],
totals: nextPaymentTotalsJSON(),
};

const nextPayment = billingSubscriptionNextPaymentFromJSON(data);

expect(nextPayment.amount.amount).toBe(5000);
expect(nextPayment.date).toEqual(new Date('2021-01-01T00:00:00.000Z'));
expect(nextPayment.perUnitTotals?.[0]).toMatchObject({
name: 'seats',
blockSize: 1,
tiers: [{ quantity: 5, feePerBlock: { amount: 1000 }, total: { amount: 5000 } }],
});
expect(nextPayment.totals).toMatchObject({
subtotal: { amount: 5000 },
baseFee: { amount: 1000 },
taxTotal: { amount: 500 },
grandTotal: { amount: 5500 },
totalDueAfterFreeTrial: null,
credit: null,
pastDue: null,
totalDueNow: { amount: 4500 },
totalDuePerPeriod: { amount: 11000 },
credits: {
payer: {
remainingBalance: { amount: 2000 },
appliedAmount: { amount: 1000 },
},
total: { amount: 1000 },
},
discounts: {
proration: {
amount: { amount: 500 },
cycleDaysPassed: 15,
cycleDaysTotal: 30,
cyclePassedPercent: 50,
},
total: { amount: 500 },
},
perUnitTotals: [{ name: 'seats', blockSize: 1 }],
totalsDuePerPeriod: {
subtotal: { amount: 10000 },
baseFee: { amount: 1000 },
taxTotal: { amount: 1000 },
grandTotal: { amount: 11000 },
perUnitTotals: [{ name: 'seats', blockSize: 1 }],
},
});
});
});

describe('billingSubscriptionItemNextPaymentFromJSON', () => {
it('maps amount, date, and per_unit_totals', () => {
const data: BillingSubscriptionItemNextPaymentJSON = {
amount: moneyJSON(5000),
date: 1_609_459_200_000,
per_unit_totals: [
{
name: 'seats',
block_size: 1,
tiers: [{ quantity: 5, fee_per_block: moneyJSON(1000), total: moneyJSON(5000) }],
},
],
totals: nextPaymentTotalsJSON(),
};

const nextPayment = billingSubscriptionItemNextPaymentFromJSON(data);

expect(nextPayment.amount.amount).toBe(5000);
expect(nextPayment.date).toEqual(new Date('2021-01-01T00:00:00.000Z'));
expect(nextPayment.perUnitTotals?.[0]).toMatchObject({
name: 'seats',
blockSize: 1,
tiers: [{ quantity: 5, feePerBlock: { amount: 1000 }, total: { amount: 5000 } }],
});
expect(nextPayment.totals).toMatchObject({
subtotal: { amount: 5000 },
baseFee: { amount: 1000 },
totalDueNow: { amount: 4500 },
credits: { total: { amount: 1000 } },
discounts: { total: { amount: 500 } },
perUnitTotals: [{ name: 'seats', blockSize: 1 }],
});
});
});
Loading
Loading