@stigg/react-sdk 4.13.1 → 4.14.0

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "4.13.1",
+  "version": "4.14.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.24.6",
+    "@stigg/js-client-sdk": "2.25.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,6 +1,6 @@
 import keyBy from 'lodash/keyBy';
 import compact from 'lodash/compact';
-import { BillableFeatureInput, BillingPeriod } from '@stigg/api-client-js/src/generated/sdk';
+import { BillableFeatureInput, BillingPeriod, TiersMode } 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';
@@ -73,9 +73,9 @@ function getBillableFeatures(
 
       quantity = getValidPriceQuantity(price, preconfiguredQuantity || 1);
 
-      if (price.isTieredPrice) {
+      if (price.isTieredPrice && price.tiersMode === TiersMode.Volume) {
         const tier = getTierByQuantity(price.tiers!, quantity);
-        quantity = tier!.upTo;
+        quantity = tier!.upTo!;
       }
 
       return {

package/src/components/checkout/steps/payment/stripe/stripe.utils.ts

@@ -6,6 +6,8 @@ type StripeElementsProps = {
   elements: StripeElements | null;
 };
 
+const FAILED_PAYMENT_COLLECTION_STATUSES = [PaymentCollection.Failed, PaymentCollection.Processing];
+
 export async function handleStripeFormValidations({ elements }: Pick<StripeElementsProps, 'elements'>) {
   if (!elements) {
     const errorMessage = 'Stripe elements not initialized';
@@ -30,19 +32,20 @@ export async function handleStripeNextAction({
   applySubscriptionResults: ApplySubscriptionResults;
   stripe: Stripe | null;
 }) {
-  const paymentIntentClientSecret = applySubscriptionResults?.subscription?.latestInvoice?.paymentSecret;
-  if (
-    stripe &&
-    paymentIntentClientSecret &&
-    applySubscriptionResults?.subscription?.paymentCollection === PaymentCollection.ActionRequired
-  ) {
+  const subscription = applySubscriptionResults?.subscription;
+  const paymentIntentClientSecret = subscription?.latestInvoice?.paymentSecret;
+  const paymentCollection = subscription?.paymentCollection;
+
+  if (stripe && paymentIntentClientSecret && paymentCollection === PaymentCollection.ActionRequired) {
     const { error: NextActionError } = await stripe.handleNextAction({ clientSecret: paymentIntentClientSecret });
     if (NextActionError) {
       return { errorMessage: NextActionError.message || '' };
     }
+  } else if (paymentCollection && FAILED_PAYMENT_COLLECTION_STATUSES.includes(paymentCollection)) {
+    return { errorMessage: subscription?.latestInvoice?.errorMessage || 'An error occurred - try again later' };
   }
 
-  return { subscription: applySubscriptionResults?.subscription };
+  return { subscription };
 }
 
 async function handleStripeSetup({

package/src/components/checkout/steps/plan/CheckoutChargeList.tsx

@@ -103,7 +103,7 @@ export function PlanCharge({
     if (isPayAsYouGo) {
       chargeRow += ' / unit';
     }
-  } else if (charge.isTieredPrice && featureId) {
+  } else if (charge.isTieredPrice && charge.tiersMode && featureId) {
     const tier = getTierByQuantity(charge.tiers!, billableFeature!.quantity || 1);
     chargeRow = (
       <TiersSelectContainer
@@ -111,8 +111,16 @@ export function PlanCharge({
         tiers={charge.tiers}
         selectedTier={tier}
         handleTierChange={(tier: PriceTierFragment) => {
-          setBillableFeature(featureId, tier.upTo);
+          if (tier.upTo) {
+            setBillableFeature(featureId, tier.upTo);
+          }
         }}
+        tiersMode={charge.tiersMode}
+        perUnitQuantity={billableFeature?.quantity}
+        handlePerUnitQuantityChange={(quantity: number) => {
+          setBillableFeature(featureId, quantity);
+        }}
+        width={120}
       />
     );
   } else {

package/src/components/common/TiersSelectContainer.tsx

@@ -1,78 +1,49 @@
-import { PriceTierFragment } from '@stigg/js-client-sdk';
-import MenuItem from '@mui/material/MenuItem';
-import OutlinedInput from '@mui/material/OutlinedInput';
-import Select, { SelectChangeEvent } from '@mui/material/Select';
-import { map } from 'lodash';
-import React, { ReactNode } from 'react';
+import { PriceTierFragment, TiersMode } from '@stigg/js-client-sdk';
+import React from 'react';
 import styled from '@emotion/styled/macro';
 import { getTierByQuantity } from '../utils/priceTierUtils';
 import { Typography } from './Typography';
+import { VolumePerUnitInput } from './VolumePerUnitInput';
+import { VolumeBulkSelect } from './VolumeBulkSelect';
 
-const TierSelect = styled(Select)`
-  border-radius: 10px;
-  min-height: 42px;
-  min-width: 120px;
-
-  &:hover .MuiOutlinedInput-notchedOutline {
-    border-color: ${({ theme }) => theme.stigg.palette.outlinedBorder};
-  }
-`;
-
-const TierInput = styled(OutlinedInput)`
-  & .MuiInputBase-input {
-    padding: 10px 12px;
-  }
-
-  &.Mui-focused .MuiOutlinedInput-notchedOutline {
-    border-color: ${({ theme }) => theme.stigg.palette.primary} !important;
-  }
-`;
-
-export function TiersSelectContainer({
-  componentId,
-  tiers,
-  tierUnits,
-  selectedTier,
-  handleTierChange,
-}: {
+export type TiersSelectContainerProps = {
   componentId: string;
   tiers?: PriceTierFragment[] | null;
   tierUnits?: string;
   selectedTier?: PriceTierFragment;
   handleTierChange: (tier: PriceTierFragment) => void;
-}) {
-  const handleChange = (event: SelectChangeEvent<unknown>, _: ReactNode) => {
+  tiersMode?: TiersMode | null;
+  handlePerUnitQuantityChange: (quantity: number) => void;
+  perUnitQuantity?: number;
+  width?: number;
+};
+
+const TiersSelectLayout = styled(Typography)`
+  min-height: 46px;
+`;
+
+export function TiersSelectContainer(props: TiersSelectContainerProps) {
+  const { tiers, tiersMode, handleTierChange } = props;
+  const handleChange = (quantity: number) => {
     if (!tiers) return;
 
-    handleTierChange(getTierByQuantity(tiers, event.target.value as number)!);
+    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 (
-    <Typography as="div" className="stigg-price-tier-select" style={{ minHeight: '46px' }}>
-      {tiers ? (
-        <TierSelect
-          value={selectedTier ? selectedTier.upTo.toString() : tiers[0].upTo.toString()}
-          fullWidth
-          onChange={handleChange}
-          id={componentId}
-          input={<TierInput />}
-          MenuProps={{
-            MenuListProps: { disablePadding: true },
-            PaperProps: {
-              sx: { marginTop: '4px', borderRadius: '10px' },
-            },
-          }}>
-          {map(tiers, (tier: PriceTierFragment) => (
-            <MenuItem className="stigg-price-tier-menu-item-text" key={tier.upTo} value={tier.upTo.toString()}>
-              <Typography variant="body1" color="primary" style={{ lineHeight: 'unset' }}>
-                {tier.upTo} {tierUnits}
-              </Typography>
-            </MenuItem>
-          ))}
-        </TierSelect>
-      ) : (
-        <div />
-      )}
-    </Typography>
+    <TiersSelectLayout as="div" className="stigg-price-tier-select">
+      {getContent()}
+    </TiersSelectLayout>
   );
 }

package/src/components/common/VolumeBulkSelect.tsx

@@ -0,0 +1,68 @@
+import { PriceTierFragment } from '@stigg/js-client-sdk';
+import styled from '@emotion/styled/macro';
+import OutlinedInput from '@mui/material/OutlinedInput';
+import Select from '@mui/material/Select';
+import MenuItem from '@mui/material/MenuItem';
+import { map } from 'lodash';
+import React from 'react';
+import { Typography } from './Typography';
+import { TiersSelectContainerProps } from './TiersSelectContainer';
+
+const TierSelect = styled(Select)`
+  border-radius: 10px;
+  min-height: 42px;
+  min-width: 120px;
+
+  &:hover .MuiOutlinedInput-notchedOutline {
+    border-color: ${({ theme }) => theme.stigg.palette.outlinedBorder};
+  }
+`;
+
+const TierInput = styled(OutlinedInput)`
+  & .MuiInputBase-input {
+    padding: 10px 12px;
+  }
+
+  &.Mui-focused .MuiOutlinedInput-notchedOutline {
+    border-color: ${({ theme }) => theme.stigg.palette.primary} !important;
+  }
+`;
+
+export function VolumeBulkSelect({
+  selectedTier,
+  componentId,
+  tierUnits,
+  tiers,
+  handleChange,
+}: Pick<TiersSelectContainerProps, 'selectedTier' | 'componentId' | 'tiers' | 'tierUnits'> & {
+  handleChange: (quantity: number) => void;
+}) {
+  if (!tiers) {
+    return null;
+  }
+
+  return (
+    <TierSelect
+      value={selectedTier ? selectedTier.upTo?.toString() : tiers[0].upTo?.toString()}
+      fullWidth
+      onChange={(event) => {
+        handleChange(event.target.value as number);
+      }}
+      id={componentId}
+      input={<TierInput />}
+      MenuProps={{
+        MenuListProps: { disablePadding: true },
+        PaperProps: {
+          sx: { marginTop: '4px', borderRadius: '10px' },
+        },
+      }}>
+      {map(tiers, (tier: PriceTierFragment) => (
+        <MenuItem className="stigg-price-tier-menu-item-text" key={tier.upTo} value={tier.upTo?.toString()}>
+          <Typography variant="body1" color="primary" style={{ lineHeight: 'unset' }}>
+            {tier.upTo} {tierUnits}
+          </Typography>
+        </MenuItem>
+      ))}
+    </TierSelect>
+  );
+}

package/src/components/common/VolumePerUnitInput.tsx

@@ -0,0 +1,40 @@
+import InputAdornment from '@mui/material/InputAdornment';
+import React from 'react';
+import { Typography } from './Typography';
+import { InputField } from '../checkout/components';
+import { TiersSelectContainerProps } from './TiersSelectContainer';
+
+export function VolumePerUnitInput({
+  width,
+  tierUnits,
+  perUnitQuantity,
+  handlePerUnitQuantityChange,
+  handleChange,
+}: Pick<TiersSelectContainerProps, 'width' | 'tierUnits' | 'perUnitQuantity' | 'handlePerUnitQuantityChange'> & {
+  handleChange: (quantity: number) => void;
+}) {
+  return (
+    <InputField
+      type="number"
+      fullWidth
+      sx={{ minHeight: '46px', width }}
+      InputProps={{
+        endAdornment: (
+          <InputAdornment position="end">
+            <Typography variant="body1" color="primary">
+              {tierUnits}
+            </Typography>
+          </InputAdornment>
+        ),
+      }}
+      value={perUnitQuantity || 1}
+      onChange={(event) => {
+        const quantity = event?.target?.value ? Number(event?.target?.value) : null;
+        if (quantity) {
+          handleChange(quantity);
+          handlePerUnitQuantityChange(quantity);
+        }
+      }}
+    />
+  );
+}

package/src/components/paywall/PlanOffering.tsx

@@ -1,4 +1,4 @@
-import React, { useEffect } from 'react';
+import React, { useEffect, useState } from 'react';
 import {
   BillableFeature,
   BillingPeriod,
@@ -18,7 +18,7 @@ import { flexLayoutMapper } from '../../theme/getResolvedTheme';
 import { Typography } from '../common/Typography';
 import MiniSchedule from '../../assets/mini-schedule.svg';
 import { PlanPrice } from './PlanPrice';
-import { getSelectedTier } from '../utils/priceTierUtils';
+import { getSelectedTier, getSelectedTierQuantityBeFeature } from '../utils/priceTierUtils';
 
 const PlanOfferingButtonHeight = '66px';
 
@@ -167,22 +167,28 @@ export function PlanOffering({
     );
   }
 
-  const [selectedTierByFeature, setSelectedTierByFeature] = React.useState<Record<string, PriceTierFragment>>(
+  const [perUnitQuantityByFeature, setPerUnitQuantityByFeature] = useState<Record<string, number>>({});
+  const [selectedTierByFeature, setSelectedTierByFeature] = useState<Record<string, PriceTierFragment>>(
     getSelectedTier(plan, billingPeriod, currentSubscription, {}, selectDefaultTierIndex),
   );
 
   useEffect(() => {
     setSelectedTierByFeature(getSelectedTier(plan, billingPeriod, currentSubscription, selectedTierByFeature));
+    setPerUnitQuantityByFeature(getSelectedTierQuantityBeFeature(plan, billingPeriod, currentSubscription));
     // eslint-disable-next-line react-hooks/exhaustive-deps
   }, [billingPeriod, currentSubscription, plan]);
 
   const onPlanButtonClick = (intentionType: SubscribeIntentionType) => {
-    const billableFeatures: BillableFeature[] = Object.keys(selectedTierByFeature).map((featureId) => ({
+    const tierBillableFeatures: BillableFeature[] = Object.keys(selectedTierByFeature).map((featureId) => ({
       featureId,
-      quantity: selectedTierByFeature[featureId].upTo,
+      quantity: selectedTierByFeature[featureId].upTo || 0,
+    }));
+    const perUnitBillableFeatures: BillableFeature[] = Object.keys(perUnitQuantityByFeature).map((featureId) => ({
+      featureId,
+      quantity: perUnitQuantityByFeature[featureId],
     }));
 
-    return onPlanSelected(intentionType, billableFeatures);
+    return onPlanSelected(intentionType, { ...tierBillableFeatures, ...perUnitBillableFeatures });
   };
 
   return (
@@ -218,6 +224,8 @@ export function PlanOffering({
           locale={locale}
           hasAnnuallyPrice={hasAnnuallyPrice}
           hasMonthlyPrice={hasMonthlyPrice}
+          setPerUnitQuantityByFeature={setPerUnitQuantityByFeature}
+          perUnitQuantityByFeature={perUnitQuantityByFeature}
         />
 
         {showCTAButton ? (
@@ -232,6 +240,7 @@ export function PlanOffering({
             paywallLocale={paywallLocale}
             withTrialLeftRow={withTrialLeftRow}
             selectedTierByFeature={selectedTierByFeature}
+            perUnitQuantityByFeature={perUnitQuantityByFeature}
           />
         ) : (
           <div style={{ height: PlanOfferingButtonHeight }} />

package/src/components/paywall/PlanOfferingButton.tsx

@@ -83,6 +83,7 @@ type PlanOfferingButtonProps = {
   onPlanSelected: (intentionType: SubscribeIntentionType) => void | Promise<void>;
   withTrialLeftRow: boolean;
   selectedTierByFeature: Record<string, PriceTierFragment>;
+  perUnitQuantityByFeature: Record<string, number>;
 };
 
 export function PlanOfferingButton({
@@ -96,6 +97,7 @@ export function PlanOfferingButton({
   withTrialLeftRow,
   currentSubscription,
   selectedTierByFeature,
+  perUnitQuantityByFeature,
 }: PlanOfferingButtonProps) {
   const theme = useTheme();
   const [isLoading, setIsLoading] = useState(false);
@@ -142,7 +144,11 @@ export function PlanOfferingButton({
       isSameBillingPeriod ||
       (plan.pricingType && [PricingType.Free, PricingType.Custom].includes(plan.pricingType))
     ) {
-      const planComparison = compareSelectedTierToCurrentTier(selectedTierByFeature, currentSubscription);
+      const planComparison = compareSelectedTierToCurrentTier(
+        selectedTierByFeature,
+        perUnitQuantityByFeature,
+        currentSubscription,
+      );
       switch (planComparison) {
         case PriceTierComparison.Lower:
           buttonProps.intentionType = SubscribeIntentionType.CHANGE_UNIT_QUANTITY;
@@ -163,7 +169,7 @@ export function PlanOfferingButton({
       buttonProps.intentionType = SubscribeIntentionType.CHANGE_BILLING_PERIOD;
     }
   } else if (isCustomPrice) {
-    buttonProps.title = custom;
+    buttonProps.title = typeof custom === 'function' ? custom({ plan, selectedBillingPeriod: billingPeriod }) : custom;
     buttonProps.intentionType = SubscribeIntentionType.REQUEST_CUSTOM_PLAN_ACCESS;
   }
 

package/src/components/paywall/PlanPrice.tsx

@@ -65,6 +65,8 @@ export const PlanPrice = ({
   locale,
   hasMonthlyPrice,
   hasAnnuallyPrice,
+  perUnitQuantityByFeature,
+  setPerUnitQuantityByFeature,
 }: {
   showStartingAt: boolean;
   withUnitPriceRow: boolean;
@@ -72,6 +74,8 @@ export const PlanPrice = ({
   withTiersRow: boolean;
   selectedTierByFeature: Record<string, PriceTierFragment>;
   setSelectedTierByFeature: React.Dispatch<React.SetStateAction<Record<string, PriceTierFragment>>>;
+  perUnitQuantityByFeature: Record<string, number>;
+  setPerUnitQuantityByFeature: React.Dispatch<React.SetStateAction<Record<string, number>>>;
   plan: PaywallPlan;
   billingPeriod: BillingPeriod;
   paywallLocale: PaywallLocalization;
@@ -86,6 +90,7 @@ export const PlanPrice = ({
     locale,
     hasMonthlyPrice,
     selectedTierByFeature,
+    perUnitQuantityByFeature,
   );
 
   // We currently only support prices with one tier - so we select the first one
@@ -94,6 +99,7 @@ export const PlanPrice = ({
   });
   const featureId = tieredPrice ? tieredPrice.feature!.featureId : undefined;
   const selectedTier = featureId ? selectedTierByFeature[featureId] : undefined;
+  const perUnitQuantity = featureId ? perUnitQuantityByFeature[featureId] : undefined;
 
   const handleTierChange = (tier: PriceTierFragment) => {
     if (!featureId) {
@@ -106,6 +112,17 @@ export const PlanPrice = ({
     }));
   };
 
+  const handlePerUnitQuantityChange = (quantity: number) => {
+    if (!featureId) {
+      return;
+    }
+
+    setPerUnitQuantityByFeature((prevState) => ({
+      ...prevState,
+      [featureId]: quantity,
+    }));
+  };
+
   return (
     <PlanPriceContainer as="div" className="stigg-price-text">
       <>
@@ -146,6 +163,9 @@ export const PlanPrice = ({
             tierUnits={tierUnits}
             selectedTier={selectedTier}
             handleTierChange={handleTierChange}
+            tiersMode={tieredPrice?.tiersMode}
+            handlePerUnitQuantityChange={handlePerUnitQuantityChange}
+            perUnitQuantity={perUnitQuantity}
           />
         ) : null}
       </>

package/src/components/paywall/index.ts

@@ -1,3 +1,3 @@
 export { PaywallContainer as Paywall, PaywallContainerProps as PaywallProps } from './PaywallContainer';
 export { PaywallPlan, OnPlanSelectedCallbackFn, SubscribeIntentionType } from './types';
-export { PaywallLocalization, PlanPriceText } from './paywallTextOverrides';
+export { PaywallLocalization, PlanPriceText, CurrentPlanParams } from './paywallTextOverrides';

package/src/components/paywall/paywallTextOverrides.ts

@@ -13,6 +13,11 @@ import { PaywallPlan } from './types';
 
 export { PlanPriceText } from '../utils/getPlanPrice';
 
+export type CurrentPlanParams = {
+  plan: Plan;
+  selectedBillingPeriod: BillingPeriod;
+};
+
 export type PaywallLocalization = {
   highlightChip: string;
   entitlementsTitle?: (plan: PaywallPlan) => string;
@@ -20,7 +25,7 @@ export type PaywallLocalization = {
     upgrade: string | ((plan: PaywallPlan) => string);
     downgrade: string | ((plan: PaywallPlan) => string);
     startTrial: (plan: PaywallPlan) => string;
-    custom: string;
+    custom: ((data: CurrentPlanParams) => string) | string;
     currentPlan: string;
     startNew: string;
     switchToBillingPeriod: (billingPeriod: BillingPeriod) => string;
@@ -30,7 +35,7 @@ export type PaywallLocalization = {
     startingAtCaption: string;
     billingPeriod?: (billingPeriod: BillingPeriod) => string;
     pricePeriod: (billingPeriod: BillingPeriod) => string;
-    custom: string;
+    custom: ((data: CurrentPlanParams) => string) | string;
     priceNotSet: string;
     free: PlanPriceText | ((currency?: PaywallCurrency) => PlanPriceText);
     paid?: (priceData: {

package/src/components/utils/getPaidPriceText.ts

@@ -18,6 +18,7 @@ type GetPaidPriceTextParams = {
   shouldShowMonthlyPriceAmount: boolean;
   selectedTierByFeature: Record<string, PriceTierFragment>;
   paywallLocale: PaywallLocalization;
+  perUnitQuantityByFeature?: Record<string, number>;
 };
 
 export function getPaidPriceText({
@@ -28,6 +29,7 @@ export function getPaidPriceText({
   shouldShowMonthlyPriceAmount,
   selectedTierByFeature,
   paywallLocale,
+  perUnitQuantityByFeature,
 }: GetPaidPriceTextParams): PlanPriceText {
   const { amount, currency } = paywallCalculatedPrice || planPrices[0];
   const priceAmount = amount || 0;
@@ -53,7 +55,13 @@ export function getPaidPriceText({
         tierUnits = getPriceFeatureUnit(price);
       }
 
-      priceNumber += calculateTierPrice(price, currentTier, selectedBillingPeriod, shouldShowMonthlyPriceAmount);
+      priceNumber += calculateTierPrice(
+        price,
+        currentTier,
+        selectedBillingPeriod,
+        shouldShowMonthlyPriceAmount,
+        perUnitQuantityByFeature?.[price.feature!.featureId],
+      );
     }
   }
 

package/src/components/utils/getPlanPrice.ts

@@ -16,6 +16,7 @@ export function getPlanPrice(
   locale: string,
   shouldShowMonthlyPriceAmount: boolean,
   selectedTierByFeature?: Record<string, PriceTierFragment>,
+  perUnitQuantityByFeature?: Record<string, number>,
 ): PlanPriceText {
   switch (plan.pricingType) {
     case PricingType.Free:
@@ -26,7 +27,10 @@ export function getPlanPrice(
       return paywallLocale.price.free;
     case PricingType.Custom:
       return {
-        price: paywallLocale.price.custom,
+        price:
+          typeof paywallLocale.price.custom === 'function'
+            ? paywallLocale.price.custom({ plan, selectedBillingPeriod: billingPeriod })
+            : paywallLocale.price.custom,
       };
     case PricingType.Paid: {
       const planPrices = plan.pricePoints.filter((pricePoint) => pricePoint.billingPeriod === billingPeriod);
@@ -45,6 +49,7 @@ export function getPlanPrice(
         paywallCalculatedPrice,
         selectedBillingPeriod: billingPeriod,
         selectedTierByFeature: selectedTierByFeature || {},
+        perUnitQuantityByFeature: perUnitQuantityByFeature || {},
       };
 
       return paywallLocale.price.paid