chore(clerk-js,types): Split shared CommerceTotals (#5726)

Author: panteliselef

.changeset/nine-pets-learn.md

@@ -0,0 +1,6 @@
+---
+'@clerk/clerk-js': patch
+'@clerk/types': patch
+---
+
+Split `CommerceTotals` to `CommerceCheckoutTotals` and `CommerceInvoiceTotals`.

packages/clerk-js/src/core/resources/CommerceCheckout.ts

@@ -1,8 +1,8 @@
 import type {
   __experimental_CommerceCheckoutJSON,
   __experimental_CommerceCheckoutResource,
+  __experimental_CommerceCheckoutTotals,
   __experimental_CommerceSubscriptionPlanPeriod,
-  __experimental_CommerceTotals,
   __experimental_ConfirmCheckoutParams,
 } from '@clerk/types';
 
@@ -24,7 +24,7 @@ export class __experimental_CommerceCheckout extends BaseResource implements __e
   planPeriod!: __experimental_CommerceSubscriptionPlanPeriod;
   status!: string;
   subscription?: __experimental_CommerceSubscription;
-  totals!: __experimental_CommerceTotals;
+  totals!: __experimental_CommerceCheckoutTotals;
 
   constructor(data: __experimental_CommerceCheckoutJSON, orgId?: string) {
     super();

packages/clerk-js/src/core/resources/CommerceInvoice.ts

@@ -2,7 +2,7 @@ import type {
   __experimental_CommerceInvoiceJSON,
   __experimental_CommerceInvoiceResource,
   __experimental_CommerceInvoiceStatus,
-  __experimental_CommerceTotals,
+  __experimental_CommerceInvoiceTotals,
 } from '@clerk/types';
 
 import { commerceTotalsFromJSON } from '../../utils';
@@ -15,7 +15,7 @@ export class __experimental_CommerceInvoice extends BaseResource implements __ex
   paymentDueOn!: number;
   paidOn!: number;
   status!: __experimental_CommerceInvoiceStatus;
-  totals!: __experimental_CommerceTotals;
+  totals!: __experimental_CommerceInvoiceTotals;
 
   constructor(data: __experimental_CommerceInvoiceJSON) {
     super();

packages/clerk-js/src/utils/commerce.ts

@@ -1,8 +1,10 @@
 import type {
+  __experimental_CommerceCheckoutTotals,
+  __experimental_CommerceCheckoutTotalsJSON,
+  __experimental_CommerceInvoiceTotals,
+  __experimental_CommerceInvoiceTotalsJSON,
   __experimental_CommerceMoney,
   __experimental_CommerceMoneyJSON,
-  __experimental_CommerceTotals,
-  __experimental_CommerceTotalsJSON,
 } from '@clerk/types';
 
 export const commerceMoneyFromJSON = (data: __experimental_CommerceMoneyJSON): __experimental_CommerceMoney => {
@@ -14,11 +16,22 @@ export const commerceMoneyFromJSON = (data: __experimental_CommerceMoneyJSON): _
   };
 };
 
-export const commerceTotalsFromJSON = (data: __experimental_CommerceTotalsJSON): __experimental_CommerceTotals => {
-  return {
+export const commerceTotalsFromJSON = <
+  T extends __experimental_CommerceInvoiceTotalsJSON | __experimental_CommerceCheckoutTotalsJSON,
+>(
+  data: T,
+) => {
+  const totals = {
     grandTotal: commerceMoneyFromJSON(data.grand_total),
     subtotal: commerceMoneyFromJSON(data.subtotal),
     taxTotal: commerceMoneyFromJSON(data.tax_total),
-    totalDueNow: commerceMoneyFromJSON(data.total_due_now),
   };
+  if ('total_due_now' in data) {
+    // @ts-ignore
+    totals['totalDueNow'] = commerceMoneyFromJSON(data.total_due_now);
+  }
+
+  return totals as T extends { total_due_now: __experimental_CommerceMoneyJSON }
+    ? __experimental_CommerceCheckoutTotals
+    : __experimental_CommerceInvoiceTotals;
 };

packages/types/src/commerce.ts

@@ -114,7 +114,7 @@ export interface __experimental_CommerceInvoiceResource extends ClerkResource {
   id: string;
   planId: string;
   paymentSourceId: string;
-  totals: __experimental_CommerceTotals;
+  totals: __experimental_CommerceInvoiceTotals;
   paymentDueOn: number;
   paidOn: number;
   status: __experimental_CommerceInvoiceStatus;
@@ -142,13 +142,17 @@ export interface __experimental_CommerceMoney {
   currencySymbol: string;
 }
 
-export interface __experimental_CommerceTotals {
+export interface __experimental_CommerceCheckoutTotals {
   subtotal: __experimental_CommerceMoney;
   grandTotal: __experimental_CommerceMoney;
   taxTotal: __experimental_CommerceMoney;
   totalDueNow: __experimental_CommerceMoney;
 }
 
+// eslint-disable-next-line @typescript-eslint/no-empty-object-type
+export interface __experimental_CommerceInvoiceTotals
+  extends Omit<__experimental_CommerceCheckoutTotals, 'totalDueNow'> {}
+
 export type __experimental_CreateCheckoutParams = WithOptionalOrgType<{
   planId: string;
   planPeriod: __experimental_CommerceSubscriptionPlanPeriod;
@@ -167,7 +171,7 @@ export interface __experimental_CommerceCheckoutResource extends ClerkResource {
   plan: __experimental_CommercePlanResource;
   planPeriod: __experimental_CommerceSubscriptionPlanPeriod;
   status: string;
-  totals: __experimental_CommerceTotals;
+  totals: __experimental_CommerceCheckoutTotals;
   subscription?: __experimental_CommerceSubscriptionResource;
   confirm: (params: __experimental_ConfirmCheckoutParams) => Promise<__experimental_CommerceCheckoutResource>;
 }

packages/types/src/json.ts

@@ -648,7 +648,7 @@ export interface __experimental_CommerceInvoiceJSON extends ClerkResourceJSON {
   payment_source_id: string;
   plan_id: string;
   status: __experimental_CommerceInvoiceStatus;
-  totals: __experimental_CommerceTotalsJSON;
+  totals: __experimental_CommerceInvoiceTotalsJSON;
 }
 
 export interface __experimental_CommerceSubscriptionJSON extends ClerkResourceJSON {
@@ -670,13 +670,17 @@ export interface __experimental_CommerceMoneyJSON {
   currency_symbol: string;
 }
 
-export interface __experimental_CommerceTotalsJSON {
+export interface __experimental_CommerceCheckoutTotalsJSON {
   grand_total: __experimental_CommerceMoneyJSON;
   subtotal: __experimental_CommerceMoneyJSON;
   tax_total: __experimental_CommerceMoneyJSON;
   total_due_now: __experimental_CommerceMoneyJSON;
 }
 
+// eslint-disable-next-line @typescript-eslint/no-empty-object-type
+export interface __experimental_CommerceInvoiceTotalsJSON
+  extends Omit<__experimental_CommerceCheckoutTotalsJSON, 'total_due_now'> {}
+
 export interface __experimental_CommerceCheckoutJSON extends ClerkResourceJSON {
   object: 'commerce_checkout';
   id: string;
@@ -688,5 +692,5 @@ export interface __experimental_CommerceCheckoutJSON extends ClerkResourceJSON {
   plan_period: __experimental_CommerceSubscriptionPlanPeriod;
   status: string;
   subscription?: __experimental_CommerceSubscriptionJSON;
-  totals: __experimental_CommerceTotalsJSON;
+  totals: __experimental_CommerceCheckoutTotalsJSON;
 }