@stigg/react-sdk 4.15.0 → 5.0.0

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "4.15.0",
+  "version": "5.0.0",
   "license": "MIT",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",
@@ -112,7 +112,7 @@
     "@emotion/react": "^11.10.5",
     "@emotion/styled": "^11.10.5",
     "@mui/material": "^5.12.0",
-    "@stigg/js-client-sdk": "2.25.0",
+    "@stigg/js-client-sdk": "3.0.0",
     "@stripe/react-stripe-js": "^2.1.1",
     "@stripe/stripe-js": "^1.54.1",
     "@types/styled-components": "^5.1.26",

package/src/components/checkout/hooks/usePlanStepModel.ts

@@ -1,9 +1,9 @@
 import keyBy from 'lodash/keyBy';
 import compact from 'lodash/compact';
-import { BillableFeatureInput, BillingPeriod, TiersMode } from '@stigg/api-client-js/src/generated/sdk';
+import { BillableFeatureInput, BillingPeriod } from '@stigg/api-client-js/src/generated/sdk';
 import { BillableFeature, BillingModel, Plan, Price, Subscription } from '@stigg/js-client-sdk';
 import { useCheckoutContext } from '../CheckoutProvider';
-import { getTierByQuantity } from '../../utils/priceTierUtils';
+import { getTierByQuantity, hasTierWithUnitPrice } from '../../utils/priceTierUtils';
 import { getValidPriceQuantity } from '../../utils/priceUtils';
 
 export type PlanStepState = {
@@ -73,7 +73,7 @@ function getBillableFeatures(
 
       quantity = getValidPriceQuantity(price, preconfiguredQuantity || 1);
 
-      if (price.isTieredPrice && price.tiersMode === TiersMode.Volume) {
+      if (price.isTieredPrice && !hasTierWithUnitPrice(price.tiers)) {
         const tier = getTierByQuantity(price.tiers!, quantity);
         quantity = tier!.upTo!;
       }

package/src/components/checkout/summary/components/LineItems.tsx

@@ -10,7 +10,7 @@ import {
 } from '@stigg/js-client-sdk';
 import { Typography } from '../../../common/Typography';
 import { currencyPriceFormatter } from '../../../utils/currencyUtils';
-import { getTierByQuantity } from '../../../utils/priceTierUtils';
+import { calculateTierPriceVolume, getTierByQuantity } from '../../../utils/priceTierUtils';
 import { WithSkeleton } from './WithSkeleton';
 import { Skeleton } from '../../components/Skeletons.style';
 import { CheckoutLocalization } from '../../configurations/textOverrides';
@@ -33,6 +33,10 @@ export const getPriceString = ({ amount, price, quantity }: { amount: number; pr
   const { billingPeriod } = price;
   let billingPeriodString = null;
 
+  if (quantity) {
+    amount /= quantity;
+  }
+
   if (billingPeriod === BillingPeriod.Annually) {
     amount /= 12;
     billingPeriodString = '12 months';
@@ -71,7 +75,7 @@ export const BilledPriceLineItem = ({
   let amount;
   if (price.isTieredPrice) {
     const tier = getTierByQuantity(price.tiers!, quantity);
-    amount = tier!.unitPrice.amount!;
+    amount = calculateTierPriceVolume(tier!, quantity);
   } else {
     amount = price.amount!;
   }
@@ -92,7 +96,7 @@ export const BilledPriceLineItem = ({
         <Grid item display="flex" gap={1} alignItems="center">
           {isPayAsYouGo && <PayAsYouGoPriceTooltip checkoutLocalization={checkoutLocalization} />}
           <Typography variant="body1" color="secondary" style={{ wordBreak: 'break-word' }}>
-            {currencyPriceFormatter({ amount: quantity * amount, currency: price.currency, minimumFractionDigits: 2 })}
+            {currencyPriceFormatter({ amount, currency: price.currency, minimumFractionDigits: 2 })}
             {isPayAsYouGo && ' / unit'}
           </Typography>
         </Grid>

package/src/components/common/TiersSelectContainer.tsx

@@ -1,7 +1,7 @@
 import { PriceTierFragment, TiersMode } from '@stigg/js-client-sdk';
 import React from 'react';
 import styled from '@emotion/styled/macro';
-import { getTierByQuantity } from '../utils/priceTierUtils';
+import { getTierByQuantity, hasTierWithUnitPrice } from '../utils/priceTierUtils';
 import { Typography } from './Typography';
 import { VolumePerUnitInput } from './VolumePerUnitInput';
 import { VolumeBulkSelect } from './VolumeBulkSelect';
@@ -23,27 +23,20 @@ const TiersSelectLayout = styled(Typography)`
 `;
 
 export function TiersSelectContainer(props: TiersSelectContainerProps) {
-  const { tiers, tiersMode, handleTierChange } = props;
+  const { tiers, handleTierChange } = props;
   const handleChange = (quantity: number) => {
     if (!tiers) return;
 
     handleTierChange(getTierByQuantity(tiers, quantity)!);
   };
 
-  const getContent = () => {
-    switch (tiersMode) {
-      case TiersMode.VolumePerUnit:
-        return <VolumePerUnitInput handleChange={handleChange} {...props} />;
-      case TiersMode.Volume:
-        return <VolumeBulkSelect handleChange={handleChange} {...props} />;
-      default:
-        return <div />;
-    }
-  };
-
   return (
     <TiersSelectLayout as="div" className="stigg-price-tier-select">
-      {getContent()}
+      {hasTierWithUnitPrice(tiers) ? (
+        <VolumePerUnitInput handleChange={handleChange} {...props} />
+      ) : (
+        <VolumeBulkSelect handleChange={handleChange} {...props} />
+      )}
     </TiersSelectLayout>
   );
 }

package/src/components/utils/calculateDiscountRate.ts

@@ -1,6 +1,7 @@
 import { BillingPeriod, PaywallCalculatedPricePoint, Price } from '@stigg/js-client-sdk';
 import isNil from 'lodash/isNil';
 import { PaywallPlan } from '../paywall';
+import { calculateTierPriceVolume } from './priceTierUtils';
 
 export function calculateDiscountRate(monthlyPrice?: number | null, annuallyPrice?: number | null) {
   if (!isNil(monthlyPrice) && !isNil(annuallyPrice)) {
@@ -26,7 +27,7 @@ function getPlanBillingPeriodAmount(plan: PaywallPlan, billingPeriod: BillingPer
     });
 
     if (tieredPrice) {
-      return tieredPrice.tiers![0].unitPrice.amount;
+      return calculateTierPriceVolume(tieredPrice.tiers![0], 1);
     }
   }
 

package/src/components/utils/getPaidPriceText.ts

@@ -60,7 +60,7 @@ export function getPaidPriceText({
         currentTier,
         selectedBillingPeriod,
         shouldShowMonthlyPriceAmount,
-        perUnitQuantityByFeature?.[price.feature!.featureId],
+        perUnitQuantityByFeature?.[price.feature!.featureId] || 1,
       );
     }
   }

package/src/components/utils/priceTierUtils.ts

@@ -1,4 +1,5 @@
 import { BillingModel, TiersMode, BillingPeriod, Price, PriceTierFragment, Subscription } from '@stigg/js-client-sdk';
+import isNil from 'lodash/isNil';
 import { PaywallPlan } from '../paywall';
 import { SelectDefaultTierIndexFn } from '../paywall/types';
 
@@ -27,23 +28,45 @@ export function getTierByQuantity(tiers: PriceTierFragment[], quantity: number)
   return ascendingTiers[ascendingTiers.length - 1];
 }
 
+function getAmount(amount: number, selectedBillingPeriod?: BillingPeriod, shouldShowMonthlyPriceAmount?: boolean) {
+  return selectedBillingPeriod === BillingPeriod.Annually && shouldShowMonthlyPriceAmount ? amount / 12 : amount;
+}
+
+export function calculateTierPriceVolume(
+  currentTier: PriceTierFragment,
+  perUnitQuantity: number,
+  selectedBillingPeriod?: BillingPeriod,
+  shouldShowMonthlyPriceAmount?: boolean,
+): number {
+  let amount = 0;
+
+  if (currentTier.unitPrice) {
+    const unitPrice = getAmount(currentTier.unitPrice.amount, selectedBillingPeriod, shouldShowMonthlyPriceAmount);
+    amount += unitPrice * perUnitQuantity;
+  }
+
+  if (currentTier.flatPrice) {
+    amount += getAmount(currentTier.flatPrice.amount, selectedBillingPeriod, shouldShowMonthlyPriceAmount);
+  }
+
+  return amount;
+}
+
 export function calculateTierPrice(
   price: Price,
   currentTier: PriceTierFragment,
   selectedBillingPeriod: BillingPeriod,
   shouldShowMonthlyPriceAmount: boolean,
-  perUnitQuantity?: number,
+  perUnitQuantity: number,
 ): number {
-  const unitPrice =
-    selectedBillingPeriod === BillingPeriod.Annually && shouldShowMonthlyPriceAmount
-      ? currentTier.unitPrice.amount / 12
-      : currentTier.unitPrice.amount;
   switch (price.tiersMode) {
     case TiersMode.Volume: {
-      return unitPrice * (currentTier.upTo || 1);
-    }
-    case TiersMode.VolumePerUnit: {
-      return unitPrice * (perUnitQuantity || 1);
+      return calculateTierPriceVolume(
+        currentTier,
+        perUnitQuantity,
+        selectedBillingPeriod,
+        shouldShowMonthlyPriceAmount,
+      );
     }
     default:
       return 0;
@@ -78,6 +101,10 @@ export function getSelectedTierQuantityBeFeature(
   return result;
 }
 
+export function hasTierWithUnitPrice(tiers: PriceTierFragment[] | null | undefined) {
+  return tiers?.some(({ unitPrice, upTo }) => unitPrice && !isNil(upTo));
+}
+
 export function getSelectedTier(
   plan: PaywallPlan,
   billingPeriod: BillingPeriod,
@@ -142,7 +169,7 @@ export function compareSelectedTierToCurrentTier(
   }
 
   const { featureId, unitQuantity } = currentTierPrice.feature!;
-  const { tiersMode } = currentTierPrice;
+  const { tiers } = currentTierPrice;
 
   if (!unitQuantity) {
     return PriceTierComparison.Equal;
@@ -154,20 +181,13 @@ export function compareSelectedTierToCurrentTier(
     return PriceTierComparison.Equal;
   }
 
-  if (tiersMode === TiersMode.Volume) {
-    if (selectedTier.upTo && selectedTier.upTo < unitQuantity) {
-      return PriceTierComparison.Lower;
-    }
+  const effectiveQuantity = hasTierWithUnitPrice(tiers) ? selectedQuantity : selectedTier.upTo;
 
-    if (selectedTier.upTo && selectedTier.upTo > unitQuantity) {
-      return PriceTierComparison.Higher;
-    }
-  } else if (tiersMode === TiersMode.VolumePerUnit) {
-    if (selectedQuantity && selectedQuantity < unitQuantity) {
+  if (!isNil(effectiveQuantity)) {
+    if (effectiveQuantity < unitQuantity) {
       return PriceTierComparison.Lower;
     }
-
-    if (selectedQuantity && selectedQuantity > unitQuantity) {
+    if (effectiveQuantity > unitQuantity) {
       return PriceTierComparison.Higher;
     }
   }

package/src/stories/mocks/checkout/mockCheckoutState.ts

@@ -116,8 +116,8 @@ function tieredPricing(): Price[] {
       tiersMode: TiersMode.Volume,
       tiers: TIERS.map((tier, index) => ({
         upTo: tier,
-        unitPrice: {
-          amount: TIERS_PRICE_MONTHLY[index] / tier,
+        flatPrice: {
+          amount: TIERS_PRICE_MONTHLY[index],
           currency: Currency.Usd,
         },
       })),
@@ -131,8 +131,8 @@ function tieredPricing(): Price[] {
       tiersMode: TiersMode.Volume,
       tiers: TIERS.map((tier, index) => ({
         upTo: tier,
-        unitPrice: {
-          amount: TIERS_PRICE_YEARLY[index] / tier,
+        flatPrice: {
+          amount: TIERS_PRICE_YEARLY[index],
           currency: Currency.Usd,
         },
       })),