@stigg/react-sdk 4.4.0-beta.8 → 4.4.0

package/src/components/common/TiersSelectContainer.tsx

@@ -1,13 +1,15 @@
 import { PriceTierFragment } from '@stigg/js-client-sdk';
 import { MenuItem, OutlinedInput, Select, SelectChangeEvent } from '@mui/material';
-import { Typography } from '../common/Typography';
 import { map } from 'lodash';
 import React, { ReactNode } from 'react';
 import styled from '@emotion/styled/macro';
 import { getTierByQuantity } from '../utils/priceTierUtils';
+import { Typography } from './Typography';
 
 const TierSelect = styled(Select)`
   border-radius: 10px;
+  min-height: 42px;
+  min-width: 120px;
 
   &:hover .MuiOutlinedInput-notchedOutline {
     border-color: ${({ theme }) => theme.stigg.palette.outlinedBorder};
@@ -16,7 +18,7 @@ const TierSelect = styled(Select)`
 
 const TierInput = styled(OutlinedInput)`
   & .MuiInputBase-input {
-    padding: 7px 12px;
+    padding: 10px 12px;
   }
 
   &.Mui-focused .MuiOutlinedInput-notchedOutline {
@@ -27,13 +29,11 @@ const TierInput = styled(OutlinedInput)`
 export function TiersSelectContainer({
   componentId,
   tiers,
-  tierUnits,
   selectedTier,
   handleTierChange,
 }: {
   componentId: string;
   tiers?: PriceTierFragment[] | null;
-  tierUnits?: string;
   selectedTier?: PriceTierFragment;
   handleTierChange: (tier: PriceTierFragment) => void;
 }) {
@@ -57,12 +57,11 @@ export function TiersSelectContainer({
             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">
-                {tier.upTo} {tierUnits}
+              <Typography variant="body1" color="primary" style={{ lineHeight: 'unset' }}>
+                {tier.upTo}
               </Typography>
             </MenuItem>
           ))}

package/src/components/common/Typography.tsx

@@ -4,7 +4,15 @@ import { FontWeight as StyledFontWeight, Text, TypeProps } from 'styled-typograp
 import { Theme, useTheme } from '@emotion/react';
 import { FontWeight } from '../../theme/types';
 
-type Colors = 'primary' | 'primary.main' | 'secondary' | 'disabled' | 'white' | 'warning' | 'error';
+type Colors =
+  | 'primary'
+  | 'primary.main'
+  | 'primary.main.light'
+  | 'secondary'
+  | 'disabled'
+  | 'white'
+  | 'warning'
+  | 'error';
 
 export type TypographyProps = {
   children: React.ReactNode;
@@ -25,6 +33,8 @@ function getColor(theme: Theme, $color: Colors) {
       return 'white';
     case 'primary.main':
       return theme.stigg.palette.primary;
+    case 'primary.main.light':
+      return theme.stigg.palette.primaryLight;
     case 'warning':
       return theme.stigg.palette.warning;
     case 'error':
@@ -111,8 +121,7 @@ export const Typography = forwardRef((props: TypographyProps, ref) => {
       level={level}
       color={overrideColor || getColor(theme, color)}
       fontWeight={fontWeight ?? (bold ? StyledFontWeight.Bold : getFontWeight(theme, variant))}
-      $span={span}
-    >
+      $span={span}>
       {children}
     </StyledText>
   );

package/src/components/common/customIcons.ts

@@ -17,3 +17,5 @@ export { default as OutlinedCheckedCircleDisabled } from '../../assets/outlined-
 export { default as ArrowForward } from '../../assets/arrow-forward.svg';
 export { default as Close } from '../../assets/close.svg';
 export { default as Check } from '../../assets/check.svg';
+export { default as PayAsYouGoCharge } from '../../assets/pay-as-you-go-charge.svg';
+export { default as Coupon } from '../../assets/coupon.svg';

package/src/components/common/mapExternalTheme.ts

@@ -123,8 +123,7 @@ export function mapCheckoutConfiguration(configuration: CheckoutConfiguration):
       text: {
         primary: palette?.textColor || undefined,
       },
-      backgroundHighlight: palette?.selectionColor || undefined,
-      backgroundSection: palette?.summaryBackgroundColor || undefined,
+      backgroundHighlight: palette?.summaryBackgroundColor || undefined,
     },
     typography: mapTypography(typography),
   };

package/src/components/customerPortal/paywall/CustomerPortalPaywall.style.ts

@@ -13,14 +13,15 @@ export const CustomerPortalPaywallLayout = styled(SectionContainer)<{
   .stigg-paywall-layout {
     width: 100%;
   }
-  
+
   .stigg-paywall-plans-layout {
     flex-wrap: nowrap;
     width: 100%;
     overflow-x: auto;
     justify-content: unset;
-    padding: 0;
+    padding: 10px 0px 0px 0px;
   }
+
   .stigg-paywall-plans-layout .stigg-plan-offering-container:first-of-type {
     margin-left: auto;
   }
@@ -37,6 +38,6 @@ export const CustomerPortalPaywallLayout = styled(SectionContainer)<{
     `}
 
   .${STIGG_WATERMARK_CLASSNAME} {
-    display: none
+    display: none;
   }
 `;

package/src/components/paywall/PlanOfferingButton.tsx

@@ -1,14 +1,14 @@
 import React, { useState } from 'react';
 import { BillingPeriod, Customer, PriceTierFragment, PricingType, Subscription } from '@stigg/js-client-sdk';
+import { isFunction } from 'lodash';
+import ClipLoader from 'react-spinners/ClipLoader';
 import styled from '@emotion/styled/macro';
-import { css, Theme, useTheme } from '@emotion/react';
+import { css, useTheme } from '@emotion/react';
 import { PaywallPlan, SubscribeIntentionType } from './types';
 import { PaywallLocalization } from './paywallTextOverrides';
 import { flexLayoutMapper } from '../../theme/getResolvedTheme';
-import ClipLoader from 'react-spinners/ClipLoader';
 import { Typography } from '../common/Typography';
 import { getSubscriptionScheduleUpdateTexts } from '../utils/getSubscriptionScheduleUpdateTexts';
-import { isFunction } from 'lodash';
 import { compareSelectedTierToCurrentTier, PriceTierComparison } from '../utils/priceTierUtils';
 
 const LoadingIndicator = styled(ClipLoader)`
@@ -99,7 +99,7 @@ export function PlanOfferingButton({
   currentSubscription,
   selectedTierByFeature,
 }: PlanOfferingButtonProps) {
-  const theme = useTheme() as Theme;
+  const theme = useTheme();
   const [isLoading, setIsLoading] = useState(false);
   const {
     currentPlan,
@@ -187,8 +187,7 @@ export function PlanOfferingButton({
               onClick={() => {
                 setIsLoading(true);
                 Promise.resolve(onPlanSelected(buttonProps.intentionType)).finally(() => setIsLoading(false));
-              }}
-            >
+              }}>
               {buttonProps.title}
             </CancelScheduledUpdateButton>
           </ScheduledUpdateText>
@@ -202,8 +201,7 @@ export function PlanOfferingButton({
               onClick={() => {
                 setIsLoading(true);
                 Promise.resolve(onPlanSelected(buttonProps.intentionType)).finally(() => setIsLoading(false));
-              }}
-            >
+              }}>
               <ButtonText className="stigg-paywall-plan-button-text" variant="h6" color="primary.main">
                 {buttonProps.title}
               </ButtonText>

package/src/components/paywall/PlanPrice.tsx

@@ -1,10 +1,10 @@
+import React, { useEffect, useState } from 'react';
+import styled from '@emotion/styled/macro';
+import { BillingPeriod, PriceTierFragment } from '@stigg/js-client-sdk';
 import { PaywallPlan } from './types';
 import { PaywallLocalization } from './paywallTextOverrides';
 import { getPlanPrice } from '../utils/getPlanPrice';
 import { Typography } from '../common/Typography';
-import React, { useEffect, useState } from 'react';
-import styled from '@emotion/styled/macro';
-import { BillingPeriod, PriceTierFragment } from '@stigg/js-client-sdk';
 import { TiersSelectContainer } from '../common/TiersSelectContainer';
 
 const EMPTY_CHAR = '‎';
@@ -38,7 +38,7 @@ function PriceBillingPeriod({
   hasAnnuallyPrice,
   paywallLocale,
 }: PriceBillingPeriodProps) {
-  const hasPrice = plan.pricePoints.find(pricePoint => pricePoint.billingPeriod === billingPeriod);
+  const hasPrice = plan.pricePoints.find((pricePoint) => pricePoint.billingPeriod === billingPeriod);
 
   let content = EMPTY_CHAR;
   if (hasPrice && hasMonthlyPrice && hasAnnuallyPrice) {
@@ -79,7 +79,7 @@ export const PlanPrice = ({
   hasAnnuallyPrice: boolean;
   locale: string;
 }) => {
-  const { price, unit, tiers, tierUnits } = getPlanPrice(
+  const { price, unit, tiers } = getPlanPrice(
     plan,
     billingPeriod,
     paywallLocale,
@@ -87,18 +87,17 @@ export const PlanPrice = ({
     hasMonthlyPrice,
     selectedTierByFeature,
   );
-
   const [selectedTier, setSelectedTier] = useState<PriceTierFragment>();
 
-  useEffect(() => {
-    setSelectedTier(selectedTierByFeature[featureId!]);
-  }, [selectedTierByFeature]);
-
   // We currently only support prices with one tier - so we select the first one
-  const tieredPrice = plan.pricePoints.find(planPrice => {
+  const tieredPrice = plan.pricePoints.find((planPrice) => {
     return planPrice.billingPeriod === billingPeriod && planPrice.isTieredPrice;
   });
-  const featureId = tieredPrice ? tieredPrice!.feature!.featureId : undefined;
+  const featureId = tieredPrice ? tieredPrice.feature!.featureId : undefined;
+
+  useEffect(() => {
+    setSelectedTier(featureId ? selectedTierByFeature[featureId] : undefined);
+  }, [featureId, selectedTierByFeature]);
 
   const handleTierChange = (tier: PriceTierFragment) => {
     const updatedTierByFeature: Record<string, PriceTierFragment> = {};
@@ -121,8 +120,7 @@ export const PlanPrice = ({
             style={{ minHeight: '20px' }}
             className="stigg-starting-at-text"
             variant="body1"
-            color="secondary"
-          >
+            color="secondary">
             {showStartingAt ? paywallLocale.price.startingAtCaption : EMPTY_CHAR}
           </Typography>
         )}
@@ -145,15 +143,14 @@ export const PlanPrice = ({
           </Typography>
         )}
 
-        {withTiersRow && (
+        {withTiersRow ? (
           <TiersSelectContainer
             componentId={`${plan.id}_${featureId}_tier`}
             tiers={tiers}
-            tierUnits={tierUnits}
             selectedTier={selectedTier}
             handleTierChange={handleTierChange}
           />
-        )}
+        ) : null}
       </>
     </PlanPriceContainer>
   );

package/src/components/utils/currencyUtils.ts

@@ -6,17 +6,19 @@ export const currencyPriceFormatter = ({
   currency = Currency.Usd,
   locale,
   maximumFractionDigits = 5,
+  minimumFractionDigits = 0,
 }: {
   amount: number;
   currency?: Currency | string;
   locale?: string;
   maximumFractionDigits?: number;
+  minimumFractionDigits?: number;
 }) => {
   const currencyString = currency.toString();
   const currencySymbol = getSymbolFromCurrency(currencyString);
   let formattedPrice = new Intl.NumberFormat(locale, {
-    maximumFractionDigits: maximumFractionDigits,
-    minimumFractionDigits: 0,
+    maximumFractionDigits,
+    minimumFractionDigits,
     style: 'currency',
     currency: currencyString,
     ...(currencySymbol ? { currencyDisplay: 'code' } : {}),

package/src/components/utils/getFeatureName.ts

@@ -2,13 +2,21 @@ import { FeatureFragment } from '@stigg/api-client-js/src/generated/sdk';
 import lowercase from 'lodash/lowerCase';
 
 export function getFeatureDisplayName(feature: FeatureFragment) {
-  const displayNameLowerCase = lowercase(feature.displayName);
+  return getFeatureDisplayNameText(feature.displayName, feature.featureUnits, feature.featureUnitsPlural);
+}
+
+export function getFeatureDisplayNameText(featureDisplayName: string, featureUnits: string | undefined | null, featureUnitsPlural: string | undefined | null) {
+  if(!featureUnits && !featureUnitsPlural) {
+    return featureDisplayName;
+  }
+
+  const displayNameLowerCase = lowercase(featureDisplayName);
   if (
-    displayNameLowerCase === lowercase(feature.featureUnits || '') ||
-    displayNameLowerCase === lowercase(feature.featureUnitsPlural || '')
+    displayNameLowerCase === lowercase(featureUnits || '') ||
+    displayNameLowerCase === lowercase(featureUnitsPlural || '')
   ) {
-    return feature.displayName;
+    return featureDisplayName;
   }
 
-  return `${feature.displayName} (${feature.featureUnitsPlural})`;
+  return `${featureDisplayName} (${featureUnitsPlural})`;
 }

package/src/stories/Checkout.stories.tsx

@@ -4,6 +4,8 @@ import { ComponentMeta, ComponentStory } from '@storybook/react';
 import { Checkout } from '../components/checkout';
 import { StiggProvider } from '../components/StiggProvider';
 import { defaultArgsWithCustomer } from './baseArgs';
+import { mockCheckoutState } from './mocks/checkout/mockCheckoutState';
+import { mockPreviewSubscription } from './mocks/checkout/mockCheckoutPreview';
 
 export default {
   title: 'Stigg React SDK/Checkout',
@@ -21,6 +23,18 @@ export default {
       </StiggProvider>
     ),
   ],
+  parameters: {
+    controls: {
+      exclude: [
+        'onCheckout',
+        'onCheckoutCompleted',
+        'onChangePlan',
+        'onBillingAddressChange',
+        'onMockCheckoutState',
+        'onMockCheckoutPreview',
+      ],
+    },
+  },
 } as ComponentMeta<typeof Checkout>;
 
 const Wrapper = styled.div`
@@ -40,13 +54,34 @@ const Template: ComponentStory<any> = (args) => (
       }}
       onCheckout={async ({ checkoutParams, checkoutAction }) => {
         console.log('checkout started!', checkoutParams);
+        if (args.useMockData) {
+          console.log('returning mock checkout success response');
+          return { success: true };
+        }
+
         const { success, errorMessage } = await checkoutAction();
         return { success, errorMessage };
       }}
+      billableFeatures={[{ featureId: 'feature-seat', quantity: 30 }]}
       onChangePlan={({ currentPlan }) => {
         console.log('plan changed clicked!', { currentPlan });
       }}
-      // billingInformation={{ taxPercentage: 27 }}
+      onMockCheckoutState={
+        args.useMockData
+          ? (params) => {
+              console.log('mocking checkout state', params);
+              return mockCheckoutState(params);
+            }
+          : undefined
+      }
+      onMockCheckoutPreview={
+        args.useMockData
+          ? (params) => {
+              console.log('mocking checkout preview');
+              return mockPreviewSubscription(params);
+            }
+          : undefined
+      }
     />
   </Wrapper>
 );
@@ -55,8 +90,5 @@ export const DefaultCheckout = Template.bind({});
 DefaultCheckout.args = {
   ...defaultArgsWithCustomer,
   planId: 'plan-revvenu-essentials',
-  baseUri: 'http://localhost:4000',
-  apiKey: 'client-72b058a6-0f22-4c86-adce-bf266d12e12e:9f356ceb-c94c-42a4-9572-10b12824da81',
-  // baseUri: 'https://api-staging.stigg.io',
-  // apiKey: 'client-79584f52-7ef9-4c58-b9ac-5080acf492e4:71f2274c-100a-4fa4-8a43-48fa3b16c627',
+  useMockData: false,
 };

package/src/stories/CustomerPortal.stories.tsx

@@ -33,7 +33,7 @@ export default {
           }
         }
         baseUri={args.baseUri}
-        enableEdge={args.disableEdge}>
+        enableEdge={!args.disableEdge}>
         <Story />
       </StiggProvider>
     ),
@@ -70,7 +70,7 @@ const Template: ComponentStory<any> = (args) => {
             onPlanSelected={(...args) => {
               console.log('onPlanSelected', args);
             }}
-            highlightedPlanId="plan-revvenu-unity"
+            highlightedPlanId="plan-revvenu-essentials"
           />
         }
         theme={customerPortalTheme}

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

@@ -0,0 +1,15 @@
+export const BASE_FEE_MONTHLY = 200;
+export const BASE_FEE_YEARLY = 175 * 12;
+export const TIERS = [100, 500, 750];
+export const TIERS_PRICE_MONTHLY = [10, 49, 70];
+export const TIERS_PRICE_YEARLY = [8, 35, 50].map((p) => p * 12);
+
+export const PER_UNIT_PRICE_MONTHLY = 12;
+export const PER_UNIT_PRICE_YEARLY = 10 * 12;
+
+export const ADDON_PRICE_MONTHLY = 50;
+export const ADDON_PRICE_YEARLY = 35 * 12;
+
+export const STRIPE_MOCK_ACCOUNT_ID = 'acct_1NnHoQG6EyqgvTaj';
+export const STRIPE_MOCK_ACCOUNT_PK =
+  'pk_test_51NnHoQG6EyqgvTajznajopWC01AozNtq7zgySeQ1qx4PH9TAXvMj0TnbZvYT3yOt46jbQAcCDs1EU2QKcfG8eEoO00tlW0Jp3r';

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

@@ -0,0 +1,138 @@
+import moment from 'moment';
+import {
+  BillingPeriod,
+  BillingModel,
+  Currency,
+  BillableFeature,
+  DateRange,
+  Money,
+  Plan,
+  PreviewSubscription,
+  SubscriptionEstimationAddon,
+  SubscriptionPreviewV2,
+} from '@stigg/js-client-sdk';
+import { mockCheckoutState } from './mockCheckoutState';
+
+const mockBillingPeriod = (period?: BillingPeriod): DateRange => {
+  return {
+    start: moment().toDate(),
+    end: moment()
+      .add(1, period === BillingPeriod.Monthly ? 'month' : 'year')
+      .toDate(),
+  };
+};
+
+const defaultPreviewSubscription = (): SubscriptionPreviewV2 => {
+  const defaultCost: Money = {
+    amount: 0,
+    currency: Currency.Usd,
+  };
+
+  return {
+    subTotal: defaultCost,
+    total: defaultCost,
+    totalExcludingTax: defaultCost,
+    billingPeriodRange: mockBillingPeriod(),
+  };
+};
+
+const flatFeeCost = (plan: Plan, billingPeriod: BillingPeriod | undefined) => {
+  const filteredPrice = plan.pricePoints?.find(
+    (price) => price.billingPeriod === billingPeriod && price.pricingModel === BillingModel.FlatFee,
+  );
+
+  return filteredPrice?.amount || 0;
+};
+
+const addonCost = (plan: Plan, billingPeriod: BillingPeriod, addonId: string, quantity: number) => {
+  const addon = plan.compatibleAddons?.find((addon) => addon.id === addonId);
+
+  const price = addon?.pricePoints.find((price) => price.billingPeriod === billingPeriod);
+
+  return (price?.amount || 0) * quantity;
+};
+
+const billableFeatureCost = (plan: Plan, billingPeriod: BillingPeriod, featureId: string, quantity: number) => {
+  const price = plan.pricePoints.find(
+    (price) => price.feature?.featureId === featureId && price.billingPeriod === billingPeriod,
+  );
+
+  if (!price) return 0;
+
+  const { tiers } = price;
+
+  if (tiers) {
+    const quantityTier = tiers.find((tier) => tier.upTo >= quantity);
+    const priceTier = quantityTier || tiers[tiers.length - 1];
+    return quantity * priceTier.unitPrice.amount;
+  }
+
+  return (price?.amount || 0) * quantity;
+};
+
+const mockTotalPrice = (
+  plan: Plan,
+  billingPeriod: BillingPeriod,
+  addons: SubscriptionEstimationAddon[],
+  features: BillableFeature[],
+) => {
+  const currency = plan.pricePoints?.[0].currency || Currency.Usd;
+
+  const totalFlatFeeCost = flatFeeCost(plan, billingPeriod);
+  const totalFeaturesCost = features.reduce(
+    (total, feature) => total + billableFeatureCost(plan, billingPeriod, feature.featureId, feature.quantity || 0),
+    0,
+  );
+  const totalAddonsCost = addons.reduce(
+    (total, addon) => total + addonCost(plan, billingPeriod, addon.addonId, addon.quantity || 0),
+    0,
+  );
+
+  const cost: Money = {
+    amount: totalFlatFeeCost + totalFeaturesCost + totalAddonsCost,
+    currency: currency || Currency.Usd,
+  };
+
+  return {
+    subTotal: cost,
+    total: cost,
+    totalExcludingTax: cost,
+  };
+};
+
+export function mockPreviewSubscription(input: PreviewSubscription): SubscriptionPreviewV2 {
+  const {
+    planId,
+    billingPeriod = BillingPeriod.Monthly,
+    billableFeatures: features = [],
+    addons = [],
+    promotionCode,
+  } = input;
+
+  if (promotionCode) {
+    throw new Error('Error: Invalid promotion code');
+  }
+
+  const data = mockCheckoutState({ planId });
+
+  if (!data || !data.plan) {
+    return defaultPreviewSubscription();
+  }
+
+  const total = mockTotalPrice(data.plan, billingPeriod, addons, features);
+
+  if (!total) {
+    return defaultPreviewSubscription();
+  }
+
+  return {
+    ...total,
+    billingPeriodRange: mockBillingPeriod(billingPeriod),
+    proration: {
+      prorationDate: moment().toDate(),
+      credit: total.total,
+      debit: total.total,
+      netAmount: total.total,
+    },
+  };
+}