Merge pull request #1863 from Shopify/sle-c/convert-money-type

[Fix] Convert received Money.amount from string to number

.changeset/dry-onions-shout.md

@@ -0,0 +1,5 @@
+---
+'@shopify/shopify-api': patch
+---
+
+Convert all Money.amount returned from the Billing GraphQL API from string to number type

packages/apps/shopify-api/lib/billing/__tests__/responses.ts

@@ -353,7 +353,7 @@ export const APP_USAGE_RECORD = {
       pricingDetails: {
         balanceUsed: USAGE_RECORD_PRICE,
         cappedAmount: {
-          amount: '5.00',
+          amount: 5,
           currencyCode: 'USD',
         },
         terms: '1 dollar per usage',

packages/apps/shopify-api/lib/billing/check.ts

@@ -13,6 +13,7 @@ import {
   CurrentAppInstallations,
   OneTimePurchase,
 } from './types';
+import {convertLineItems} from './utils';
 
 interface SubscriptionMeetsCriteriaParams {
   subscription: AppSubscription;
@@ -87,6 +88,9 @@ export async function assessPayments({
     installation.activeSubscriptions.forEach((subscription) => {
       if (subscriptionMeetsCriteria({subscription, isTest, plans})) {
         returnValue.hasActivePayment = true;
+        if (subscription.lineItems) {
+          subscription.lineItems = convertLineItems(subscription.lineItems);
+        }
         returnValue.appSubscriptions.push(subscription);
       }
     });

packages/apps/shopify-api/lib/billing/create-usage-record.ts

@@ -11,7 +11,7 @@ import {
   Money,
 } from './types';
 import {assessPayments} from './check';
-
+import {convertAppRecurringPricingMoney, convertAppUsagePricingMoney} from './utils';
 interface InternalParams {
   client: GraphqlClient;
   isTest?: boolean;
@@ -108,7 +108,12 @@ export function createUsageRecord(
           errorData: response.data?.appUsageRecordCreate?.userErrors,
         });
       }
-      return response.data?.appUsageRecordCreate?.appUsageRecord!;
+
+      const appUsageRecord = response.data?.appUsageRecordCreate?.appUsageRecord!;
+      convertAppRecurringPricingMoney(appUsageRecord.price);
+      convertAppUsagePricingMoney(appUsageRecord.subscriptionLineItem.plan.pricingDetails);
+
+      return appUsageRecord;
     } catch (error) {
       if (error instanceof GraphqlQueryError) {
         throw new BillingError({

packages/apps/shopify-api/lib/billing/subscriptions.ts

@@ -8,6 +8,7 @@ import {
   BillingSubscriptions,
   SubscriptionResponse,
 } from './types';
+import {convertLineItems} from './utils';
 
 const SUBSCRIPTION_QUERY = `
 query appSubscription {
@@ -81,6 +82,20 @@ export function subscriptions(config: ConfigInterface): BillingSubscriptions {
     const response =
       await client.request<SubscriptionResponse>(SUBSCRIPTION_QUERY);
 
-    return response.data?.currentAppInstallation!;
+    if (!response.data?.currentAppInstallation?.activeSubscriptions) {
+      return {activeSubscriptions: []};
+    }
+
+    const activeSubscriptions =
+      response.data.currentAppInstallation.activeSubscriptions;
+    activeSubscriptions.forEach((subscription) => {
+      if (subscription.lineItems) {
+        subscription.lineItems = convertLineItems(subscription.lineItems);
+      }
+    });
+
+    return {
+      activeSubscriptions,
+    };
   };
 }

packages/apps/shopify-api/lib/billing/types.ts

@@ -556,6 +556,21 @@ export interface UsageRecord {
    * The idempotency key for this request.
    */
   idempotencyKey?: string;
+  /**
+   * The subscription line item associated with the usage record.
+   */
+  subscriptionLineItem: AppSubscriptionLineItem;
+}
+
+export interface AppSubscriptionLineItem {
+  /**
+   * The ID of the subscription line item.
+   */
+  id: string;
+  /**
+   * The plan associated with the subscription line item.
+   */
+  plan: AppPlan;
 }
 
 export interface BillingUpdateUsageCappedAmountParams {

packages/apps/shopify-api/lib/billing/update-usage-subscription-capped-amount.ts

@@ -8,6 +8,7 @@ import {
   BillingUpdateUsageCappedAmountResponse,
   UpdateCappedAmountConfirmation,
 } from './types';
+import {convertLineItems} from './utils';
 
 const UPDATE_USAGE_CAPPED_AMOUNT_MUTATION = `
 mutation appSubscriptionLineItemUpdate($cappedAmount: MoneyInput!, $id: ID!) {
@@ -88,11 +89,16 @@ export function updateUsageCappedAmount(
         });
       }
 
+      const appSubscription =
+        response.data?.appSubscriptionLineItemUpdate?.appSubscription!;
+      if (appSubscription && appSubscription.lineItems) {
+        appSubscription.lineItems = convertLineItems(appSubscription.lineItems);
+      }
+
       return {
         confirmationUrl:
           response.data?.appSubscriptionLineItemUpdate?.confirmationUrl!,
-        appSubscription:
-          response.data?.appSubscriptionLineItemUpdate?.appSubscription!,
+        appSubscription,
       };
     } catch (error) {
       if (error instanceof GraphqlQueryError) {

packages/apps/shopify-api/lib/billing/utils.ts

@@ -0,0 +1,71 @@
+import {ActiveSubscriptionLineItem} from './types';
+
+/**
+ * Converts string amounts to numbers in Money type objects
+ */
+export function convertMoneyAmount(data: any) {
+  if (!data) return data;
+
+  convertAppUsagePricingMoney(data);
+  convertAppRecurringPricingMoney(data);
+  convertAppDiscountMoney(data);
+
+  return data;
+}
+
+export function convertAppRecurringPricingMoney(data: any): void {
+  if (!data) return;
+
+  if (data.price?.amount && typeof data.price.amount === 'string') {
+    data.price.amount = parseFloat(data.price.amount);
+  }
+}
+
+export function convertAppDiscountMoney(data: any): void {
+  if (!data) return;
+
+  if (
+    data.discount?.priceAfterDiscount?.amount &&
+    typeof data.discount.priceAfterDiscount.amount === 'string'
+  ) {
+    data.discount.priceAfterDiscount.amount = parseFloat(
+      data.discount.priceAfterDiscount.amount,
+    );
+  }
+
+  if (
+    data.discount?.value?.amount?.amount &&
+    typeof data.discount.value.amount.amount === 'string'
+  ) {
+    data.discount.value.amount.amount = parseFloat(
+      data.discount.value.amount.amount,
+    );
+  }
+}
+
+export function convertAppUsagePricingMoney(data: any): void {
+  if (!data) return;
+
+  if (data.balanceUsed?.amount && typeof data.balanceUsed.amount === 'string') {
+    data.balanceUsed.amount = parseFloat(data.balanceUsed.amount);
+  }
+
+  if (
+    data.cappedAmount?.amount &&
+    typeof data.cappedAmount.amount === 'string'
+  ) {
+    data.cappedAmount.amount = parseFloat(data.cappedAmount.amount);
+  }
+}
+
+/**
+ * Converts Money amounts in line items
+ */
+export function convertLineItems(lineItems: ActiveSubscriptionLineItem[]) {
+  return lineItems.map((item) => {
+    if (item.plan?.pricingDetails) {
+      item.plan.pricingDetails = convertMoneyAmount(item.plan.pricingDetails);
+    }
+    return item;
+  });
+}

packages/apps/shopify-app-remix/src/server/authenticate/admin/billing/__tests__/mock-responses.ts

@@ -164,7 +164,7 @@ export const USAGE_RECORD = {
     plan: {
       pricingDetails: {
         balanceUsed: {amount: 1, currencyCode: 'USD'},
-        cappedAmount: {amount: '5.00', currencyCode: 'USD'},
+        cappedAmount: {amount: 5, currencyCode: 'USD'},
         terms: '1 dollar per usage',
       },
     },