@stigg/react-sdk 5.28.4 → 5.30.0

package/dist/components/paywall/Paywall.d.ts

@@ -1,11 +1,12 @@
 /// <reference types="react" />
 import { BillingPeriod, Customer, Subscription } from '@stigg/js-client-sdk';
-import { ShouldHidePlanFn, OnPlanSelectedCallbackFn, PaywallPlan, SelectDefaultTierIndexFn } from './types';
+import { ShouldHidePlanFn, OnPlanSelectedCallbackFn, PaywallPlan, SelectDefaultTierIndexFn, CurrentSubscriptionOverride } from './types';
 import { PaywallLocalization } from './paywallTextOverrides';
 declare type PaywallProps = {
     plans: PaywallPlan[];
     customer: Customer | null;
     currentSubscription: Subscription | null;
+    currentSubscriptionOverride?: CurrentSubscriptionOverride | null;
     selectedBillingPeriod: BillingPeriod;
     highlightedPlanId?: string;
     onBillingPeriodChanged: (billingPeriod: BillingPeriod) => void;
@@ -17,5 +18,5 @@ declare type PaywallProps = {
     shouldHidePlan?: ShouldHidePlanFn;
     selectDefaultTierIndex?: SelectDefaultTierIndexFn;
 };
-export declare const Paywall: ({ plans, customer, currentSubscription, highlightedPlanId, selectedBillingPeriod, onBillingPeriodChanged, availableBillingPeriods, isCustomerOnTrial, onPlanSelected, paywallLocale, locale, shouldHidePlan, selectDefaultTierIndex, }: PaywallProps) => JSX.Element;
+export declare const Paywall: ({ plans, customer, currentSubscription, highlightedPlanId, selectedBillingPeriod, onBillingPeriodChanged, availableBillingPeriods, isCustomerOnTrial, onPlanSelected, paywallLocale, locale, shouldHidePlan, selectDefaultTierIndex, currentSubscriptionOverride, }: PaywallProps) => JSX.Element;
 export {};

package/dist/components/paywall/PaywallContainer.d.ts

@@ -1,6 +1,6 @@
 /// <reference types="react" />
 import { BillingPeriod } from '@stigg/js-client-sdk';
-import { ShouldHidePlanFn, OnPlanSelectedCallbackFn, SelectDefaultTierIndexFn } from './types';
+import { ShouldHidePlanFn, OnPlanSelectedCallbackFn, SelectDefaultTierIndexFn, CurrentSubscriptionOverrideFn } from './types';
 import { PaywallLocalization } from './paywallTextOverrides';
 import { DeepPartial } from '../../types';
 export declare type PaywallContainerProps = {
@@ -15,5 +15,6 @@ export declare type PaywallContainerProps = {
     billingCountryCode?: string;
     shouldHidePlan?: ShouldHidePlanFn;
     selectDefaultTierIndex?: SelectDefaultTierIndexFn;
+    currentSubscriptionOverride?: CurrentSubscriptionOverrideFn;
 };
-export declare const PaywallContainer: ({ productId, resourceId, highlightedPlanId, showOnlyEligiblePlans, textOverrides, onPlanSelected, preferredBillingPeriod, onBillingPeriodChange, billingCountryCode, shouldHidePlan, selectDefaultTierIndex, }: PaywallContainerProps) => JSX.Element;
+export declare const PaywallContainer: ({ productId, resourceId, highlightedPlanId, showOnlyEligiblePlans, textOverrides, onPlanSelected, preferredBillingPeriod, onBillingPeriodChange, billingCountryCode, shouldHidePlan, selectDefaultTierIndex, currentSubscriptionOverride: currentSubscriptionOverrideFn, }: PaywallContainerProps) => JSX.Element;

package/dist/components/paywall/PlanOffering.d.ts

@@ -1,6 +1,6 @@
 /// <reference types="react" />
 import { BillableFeature, BillingPeriod, Customer, Subscription } from '@stigg/js-client-sdk';
-import { PaywallPlan, SelectDefaultTierIndexFn, SubscribeIntentionType } from './types';
+import { CurrentSubscriptionOverride, PaywallPlan, SelectDefaultTierIndexFn, SubscribeIntentionType } from './types';
 import { PaywallLocalization } from './paywallTextOverrides';
 declare type PlanOfferingProps = {
     withUnitPriceRow: boolean;
@@ -10,6 +10,7 @@ declare type PlanOfferingProps = {
     plan: PaywallPlan;
     billingPeriod: BillingPeriod;
     currentSubscription: Subscription | null;
+    currentSubscriptionOverride?: CurrentSubscriptionOverride | null;
     isHighlighted: boolean;
     shouldShowDescriptionSection: boolean;
     hasAnnuallyPrice: boolean;
@@ -22,5 +23,5 @@ declare type PlanOfferingProps = {
     isCustomerInCustomPlan: boolean;
     selectDefaultTierIndex?: SelectDefaultTierIndexFn;
 };
-export declare function PlanOffering({ withUnitPriceRow, withTiersRow, withTrialLeftRow, customer, plan, billingPeriod, isHighlighted, currentSubscription, shouldShowDescriptionSection, hasMonthlyPrice, hasAnnuallyPrice, isCustomerOnTrial, onPlanSelected, paywallLocale, locale, withStartingAtRow, isCustomerInCustomPlan, selectDefaultTierIndex, }: PlanOfferingProps): JSX.Element;
+export declare function PlanOffering({ withUnitPriceRow, withTiersRow, withTrialLeftRow, customer, plan, billingPeriod, isHighlighted, currentSubscription, currentSubscriptionOverride, shouldShowDescriptionSection, hasMonthlyPrice, hasAnnuallyPrice, isCustomerOnTrial, onPlanSelected, paywallLocale, locale, withStartingAtRow, isCustomerInCustomPlan, selectDefaultTierIndex, }: PlanOfferingProps): JSX.Element;
 export {};

package/dist/components/paywall/PlanOfferingButton.d.ts

@@ -1,12 +1,13 @@
 /// <reference types="react" />
 import { BillingPeriod, Customer, Subscription } from '@stigg/js-client-sdk';
-import { PaywallPlan, SubscribeIntentionType } from './types';
+import { CurrentSubscriptionOverride, PaywallPlan, SubscribeIntentionType } from './types';
 import { PaywallLocalization } from './paywallTextOverrides';
 declare type PlanOfferingButtonProps = {
     isNextPlan?: boolean;
     customer: Customer | null;
     plan: PaywallPlan;
     currentSubscription: Subscription | null;
+    currentSubscriptionOverride?: CurrentSubscriptionOverride | null;
     billingPeriod: BillingPeriod;
     isCustomerOnTrial: boolean;
     paywallLocale: PaywallLocalization;
@@ -14,5 +15,5 @@ declare type PlanOfferingButtonProps = {
     withTrialLeftRow: boolean;
     perUnitQuantityByFeature: Record<string, number>;
 };
-export declare function PlanOfferingButton({ isNextPlan, customer, plan, billingPeriod, isCustomerOnTrial, onPlanSelected, paywallLocale, withTrialLeftRow, currentSubscription, perUnitQuantityByFeature, }: PlanOfferingButtonProps): JSX.Element;
+export declare function PlanOfferingButton({ isNextPlan, customer, plan, billingPeriod, isCustomerOnTrial, onPlanSelected, paywallLocale, withTrialLeftRow, currentSubscription, currentSubscriptionOverride, perUnitQuantityByFeature, }: PlanOfferingButtonProps): JSX.Element;
 export {};

package/dist/components/paywall/hooks/useLoadPaywallData.d.ts

@@ -1,11 +1,12 @@
 import { BillingPeriod } from '@stigg/js-client-sdk';
-import { PaywallData } from '../types';
+import { CurrentSubscriptionOverrideFn, PaywallData } from '../types';
 declare type UseLoadPaywallDataProps = {
     productId?: string;
     resourceId?: string;
     showOnlyEligiblePlans?: boolean;
     billingCountryCode?: string;
     preferredBillingPeriod?: BillingPeriod;
+    currentSubscriptionOverrideFn?: CurrentSubscriptionOverrideFn;
 };
-export declare function useLoadPaywallData({ productId, resourceId, showOnlyEligiblePlans, billingCountryCode, preferredBillingPeriod, }: UseLoadPaywallDataProps): PaywallData;
+export declare function useLoadPaywallData({ productId, resourceId, showOnlyEligiblePlans, billingCountryCode, preferredBillingPeriod, currentSubscriptionOverrideFn, }: UseLoadPaywallDataProps): PaywallData;
 export {};

package/dist/components/paywall/types.d.ts

@@ -4,6 +4,7 @@ export declare type PaywallData = {
     plans: PaywallPlan[] | null;
     customer: Customer | null;
     currentSubscription: Subscription | null;
+    currentSubscriptionOverride?: CurrentSubscriptionOverride | null;
     isCustomerOnTrial: boolean;
     isLoading: boolean;
     selectedBillingPeriod: BillingPeriod;
@@ -12,6 +13,10 @@ export declare type PaywallData = {
     locale: string;
     configuration?: CustomizedTheme;
 };
+export declare type CurrentSubscriptionOverride = {
+    planId: string;
+    billableFeatures: BillableFeature[];
+};
 export declare enum SubscribeIntentionType {
     START_TRIAL = "START_TRIAL",
     UPGRADE_TRIAL_TO_PAID = "UPGRADE_TRIAL_TO_PAID",
@@ -44,6 +49,9 @@ export declare type OnPlanSelectedCallbackFn = ({ plan, customer, subscription,
 export declare type ShouldHidePlanFn = ({ plan }: {
     plan: PaywallPlan;
 }) => boolean | Promise<boolean>;
+export declare type CurrentSubscriptionOverrideFn = ({ currentSubscription, }: {
+    currentSubscription: Subscription | null;
+}) => CurrentSubscriptionOverride | null | undefined;
 export declare type SelectDefaultTierIndexFn = ({ plan }: {
     plan: PaywallPlan;
 }) => number;

package/dist/components/paywall/utils/mapPaywallData.d.ts

@@ -1,13 +1,14 @@
 import { Paywall, Plan, Subscription } from '@stigg/js-client-sdk';
-import { PaywallPlan } from '../types';
+import { CurrentSubscriptionOverride, CurrentSubscriptionOverrideFn, PaywallPlan } from '../types';
 import { DeepPartial } from '../../../types';
 import { StiggTheme } from '../../../theme/types';
 declare type PaywallData = {
     currentPlan?: Plan;
     currentSubscription: Subscription | null;
+    currentSubscriptionOverride: CurrentSubscriptionOverride | null | undefined;
     isCustomerOnTrial: boolean;
     plans: PaywallPlan[];
     paywallConfiguration?: DeepPartial<StiggTheme>;
 };
-export declare function mapPaywallData(paywall: Paywall | null, showOnlyEligiblePlans?: boolean): PaywallData;
+export declare function mapPaywallData(paywall: Paywall | null, showOnlyEligiblePlans?: boolean, currentSubscriptionOverrideFn?: CurrentSubscriptionOverrideFn): PaywallData;
 export {};

package/dist/components/utils/priceTierUtils.d.ts

@@ -1,6 +1,6 @@
 import { BillingPeriod, Price, PriceTierFragment, Subscription } from '@stigg/js-client-sdk';
 import { PaywallPlan } from '../paywall';
-import { SelectDefaultTierIndexFn } from '../paywall/types';
+import { CurrentSubscriptionOverride, SelectDefaultTierIndexFn } from '../paywall/types';
 export declare function getPriceFeatureUnit(price: Price): string;
 export declare function getTierByQuantity(tiers: PriceTierFragment[], quantity: number): PriceTierFragment;
 export declare function calculateTierPriceGraduated(tiers: PriceTierFragment[], unitQuantity: number, selectedBillingPeriod?: BillingPeriod, shouldShowMonthlyPriceAmount?: boolean): {
@@ -14,10 +14,21 @@ export declare function calculateTierPrice(price: Pick<Price, 'tiers' | 'tiersMo
 export declare function hasTierWithUnitPrice(tiers: PriceTierFragment[] | null | undefined): boolean | undefined;
 export declare function isBulkTiers(tiers: PriceTierFragment[] | null | undefined): boolean | undefined;
 export declare function isQuantityInFirstTier(tiers: PriceTierFragment[] | null | undefined, quantity: number): boolean | 0 | null | undefined;
-export declare function getTiersPerUnitQuantities(plan: PaywallPlan, billingPeriod: BillingPeriod, currentSubscription: Subscription | null, selectDefaultTierIndex?: SelectDefaultTierIndexFn): Record<string, number>;
+export declare function getTiersPerUnitQuantities({ plan, billingPeriod, currentSubscription, currentSubscriptionOverride, selectDefaultTierIndex, }: {
+    plan: PaywallPlan;
+    billingPeriod: BillingPeriod;
+    currentSubscription: Subscription | null;
+    currentSubscriptionOverride?: CurrentSubscriptionOverride | null;
+    selectDefaultTierIndex?: SelectDefaultTierIndexFn;
+}): Record<string, number>;
 export declare enum PriceTierComparison {
     Lower = -1,
     Equal = 0,
     Higher = 1
 }
-export declare function compareSelectedTierToCurrentTier(perUnitQuantityByFeature: Record<string, number>, currentSubscription: Subscription | null): PriceTierComparison;
+export declare function compareSelectedTierToCurrentTier({ perUnitQuantityByFeature, plan, currentSubscription, currentSubscriptionOverride, }: {
+    perUnitQuantityByFeature: Record<string, number>;
+    plan: PaywallPlan;
+    currentSubscription: Subscription | null;
+    currentSubscriptionOverride?: CurrentSubscriptionOverride | null;
+}): PriceTierComparison;