@stigg/react-sdk 4.4.0-beta.10 → 4.4.0-beta.12

package/dist/components/checkout/Checkout.d.ts

@@ -2,4 +2,4 @@
 import { CheckoutProviderProps } from './CheckoutProvider';
 import { CheckoutContainerProps } from './CheckoutContainer';
 export declare type CheckoutProps = CheckoutProviderProps & CheckoutContainerProps;
-export declare const Checkout: ({ textOverrides, theme, resourceId, planId, preferredBillingPeriod, billingCountryCode, billableFeatures, billingInformation, ...containerProps }: CheckoutProps) => JSX.Element;
+export declare const Checkout: ({ textOverrides, theme, resourceId, planId, preferredBillingPeriod, billingCountryCode, billableFeatures, billingInformation, onMockCheckoutState, ...containerProps }: CheckoutProps) => JSX.Element;

package/dist/components/checkout/CheckoutContainer.d.ts

@@ -1,5 +1,5 @@
 /// <reference types="react" />
-import { ApplySubscription, BillingAddress, CheckoutStatePlan } from '@stigg/js-client-sdk';
+import { BillingAddress, ApplySubscription, CheckoutStatePlan, PreviewSubscription, SubscriptionPreview } from '@stigg/js-client-sdk';
 export declare type CheckoutResult = {
     success: boolean;
     errorMessage?: string;
@@ -12,6 +12,7 @@ export declare type OnCheckoutCompletedParams = {
     success: boolean;
     error?: string;
 };
+export declare type OnMockCheckoutPreviewCallback = (params: PreviewSubscription) => SubscriptionPreview;
 export declare type CheckoutContainerProps = {
     onCheckout?: (params: OnCheckoutParams) => Promise<CheckoutResult>;
     onCheckoutCompleted: (params: OnCheckoutCompletedParams) => Promise<void>;
@@ -23,5 +24,6 @@ export declare type CheckoutContainerProps = {
     }) => Promise<void>;
     disablePromotionCode?: boolean;
     disableSuccessAnimation?: boolean;
+    onMockCheckoutPreview?: OnMockCheckoutPreviewCallback;
 };
-export declare function CheckoutContainer({ onCheckout, onCheckoutCompleted, onChangePlan, onBillingAddressChange, disablePromotionCode, disableSuccessAnimation, }: CheckoutContainerProps): JSX.Element;
+export declare function CheckoutContainer({ onCheckout, onCheckoutCompleted, onChangePlan, onBillingAddressChange, disablePromotionCode, disableSuccessAnimation, onMockCheckoutPreview, }: CheckoutContainerProps): JSX.Element;

package/dist/components/checkout/CheckoutProvider.d.ts

@@ -1,5 +1,5 @@
 import React from 'react';
-import { BillableFeature, BillingPeriod, GetCheckoutStateResults } from '@stigg/js-client-sdk';
+import { BillableFeature, BillingPeriod, GetCheckoutState, GetCheckoutStateResults } from '@stigg/js-client-sdk';
 import { DeepPartial } from '../../types';
 import { AddonsStepState, PaymentStepState, PlanStepState, ProgressBarState, WidgetState } from './hooks';
 import { CheckoutLocalization } from './textOverrides';
@@ -21,6 +21,7 @@ export interface CheckoutContextState {
 }
 export declare const CheckoutContext: React.Context<[CheckoutContextState, (updater: (state: CheckoutContextState) => void) => void] | null>;
 export declare const useCheckoutContext: () => [CheckoutContextState, (updater: (state: CheckoutContextState) => void) => void];
+export declare type MockCheckoutStateCallback = (params: GetCheckoutState) => GetCheckoutStateResults;
 export declare type CheckoutProviderProps = {
     textOverrides?: DeepPartial<CheckoutLocalization>;
     theme?: DeepPartial<CheckoutTheme>;
@@ -30,7 +31,8 @@ export declare type CheckoutProviderProps = {
     billingCountryCode?: string;
     billableFeatures?: BillableFeature[];
     billingInformation?: BillingInformation;
+    onMockCheckoutState?: MockCheckoutStateCallback;
 };
-export declare function CheckoutProvider({ children, textOverrides, theme, preferredBillingPeriod, billableFeatures, resourceId, planId, billingCountryCode, billingInformation, }: {
+export declare function CheckoutProvider({ children, textOverrides, theme, preferredBillingPeriod, billableFeatures, resourceId, planId, billingCountryCode, billingInformation, onMockCheckoutState, }: {
     children: React.ReactNode;
 } & CheckoutProviderProps): JSX.Element;

package/dist/components/checkout/components/DowngradeToFreeContainer.d.ts

@@ -1,7 +1,6 @@
 /// <reference types="@emotion/styled/macro" />
 import React from 'react';
 import { CheckoutStatePlan, Subscription } from '@stigg/js-client-sdk';
-import { Currency, BillingPeriod } from '@stigg/js-client-sdk';
 import { CheckoutLocalization } from '../textOverrides';
 import { CheckoutContainerProps } from '../CheckoutContainer';
 export declare const DowngradeToFreePlanBox: import("@emotion/styled/macro").StyledComponent<import("@mui/system").SystemProps<import("@mui/material").Theme> & {
@@ -14,13 +13,10 @@ export declare const DowngradeToFreePlanBox: import("@emotion/styled/macro").Sty
 }, "slot" | "title" | "translate" | "key" | "defaultChecked" | "defaultValue" | "suppressContentEditableWarning" | "suppressHydrationWarning" | "accessKey" | "contentEditable" | "contextMenu" | "dir" | "draggable" | "hidden" | "id" | "lang" | "placeholder" | "spellCheck" | "tabIndex" | "radioGroup" | "role" | "about" | "datatype" | "inlist" | "prefix" | "property" | "resource" | "typeof" | "vocab" | "autoCapitalize" | "autoCorrect" | "autoSave" | "itemProp" | "itemScope" | "itemType" | "itemID" | "itemRef" | "results" | "security" | "unselectable" | "inputMode" | "is" | "aria-activedescendant" | "aria-atomic" | "aria-autocomplete" | "aria-busy" | "aria-checked" | "aria-colcount" | "aria-colindex" | "aria-colspan" | "aria-controls" | "aria-current" | "aria-describedby" | "aria-details" | "aria-disabled" | "aria-dropeffect" | "aria-errormessage" | "aria-expanded" | "aria-flowto" | "aria-grabbed" | "aria-haspopup" | "aria-hidden" | "aria-invalid" | "aria-keyshortcuts" | "aria-label" | "aria-labelledby" | "aria-level" | "aria-live" | "aria-modal" | "aria-multiline" | "aria-multiselectable" | "aria-orientation" | "aria-owns" | "aria-placeholder" | "aria-posinset" | "aria-pressed" | "aria-readonly" | "aria-relevant" | "aria-required" | "aria-roledescription" | "aria-rowcount" | "aria-rowindex" | "aria-rowspan" | "aria-selected" | "aria-setsize" | "aria-sort" | "aria-valuemax" | "aria-valuemin" | "aria-valuenow" | "aria-valuetext" | "dangerouslySetInnerHTML" | "onCopy" | "onCopyCapture" | "onCut" | "onCutCapture" | "onPaste" | "onPasteCapture" | "onCompositionEnd" | "onCompositionEndCapture" | "onCompositionStart" | "onCompositionStartCapture" | "onCompositionUpdate" | "onCompositionUpdateCapture" | "onFocus" | "onFocusCapture" | "onBlur" | "onBlurCapture" | "onChange" | "onChangeCapture" | "onBeforeInput" | "onBeforeInputCapture" | "onInput" | "onInputCapture" | "onReset" | "onResetCapture" | "onSubmit" | "onSubmitCapture" | "onInvalid" | "onInvalidCapture" | "onLoad" | "onLoadCapture" | "onError" | "onErrorCapture" | "onKeyDown" | "onKeyDownCapture" | "onKeyPress" | "onKeyPressCapture" | "onKeyUp" | "onKeyUpCapture" | "onAbort" | "onAbortCapture" | "onCanPlay" | "onCanPlayCapture" | "onCanPlayThrough" | "onCanPlayThroughCapture" | "onDurationChange" | "onDurationChangeCapture" | "onEmptied" | "onEmptiedCapture" | "onEncrypted" | "onEncryptedCapture" | "onEnded" | "onEndedCapture" | "onLoadedData" | "onLoadedDataCapture" | "onLoadedMetadata" | "onLoadedMetadataCapture" | "onLoadStart" | "onLoadStartCapture" | "onPause" | "onPauseCapture" | "onPlay" | "onPlayCapture" | "onPlaying" | "onPlayingCapture" | "onProgress" | "onProgressCapture" | "onRateChange" | "onRateChangeCapture" | "onSeeked" | "onSeekedCapture" | "onSeeking" | "onSeekingCapture" | "onStalled" | "onStalledCapture" | "onSuspend" | "onSuspendCapture" | "onTimeUpdate" | "onTimeUpdateCapture" | "onVolumeChange" | "onVolumeChangeCapture" | "onWaiting" | "onWaitingCapture" | "onAuxClick" | "onAuxClickCapture" | "onClick" | "onClickCapture" | "onContextMenu" | "onContextMenuCapture" | "onDoubleClick" | "onDoubleClickCapture" | "onDrag" | "onDragCapture" | "onDragEnd" | "onDragEndCapture" | "onDragEnter" | "onDragEnterCapture" | "onDragExit" | "onDragExitCapture" | "onDragLeave" | "onDragLeaveCapture" | "onDragOver" | "onDragOverCapture" | "onDragStart" | "onDragStartCapture" | "onDrop" | "onDropCapture" | "onMouseDown" | "onMouseDownCapture" | "onMouseEnter" | "onMouseLeave" | "onMouseMove" | "onMouseMoveCapture" | "onMouseOut" | "onMouseOutCapture" | "onMouseOver" | "onMouseOverCapture" | "onMouseUp" | "onMouseUpCapture" | "onSelect" | "onSelectCapture" | "onTouchCancel" | "onTouchCancelCapture" | "onTouchEnd" | "onTouchEndCapture" | "onTouchMove" | "onTouchMoveCapture" | "onTouchStart" | "onTouchStartCapture" | "onPointerDown" | "onPointerDownCapture" | "onPointerMove" | "onPointerMoveCapture" | "onPointerUp" | "onPointerUpCapture" | "onPointerCancel" | "onPointerCancelCapture" | "onPointerEnter" | "onPointerEnterCapture" | "onPointerLeave" | "onPointerLeaveCapture" | "onPointerOver" | "onPointerOverCapture" | "onPointerOut" | "onPointerOutCapture" | "onGotPointerCapture" | "onGotPointerCaptureCapture" | "onLostPointerCapture" | "onLostPointerCaptureCapture" | "onScroll" | "onScrollCapture" | "onWheel" | "onWheelCapture" | "onAnimationStart" | "onAnimationStartCapture" | "onAnimationEnd" | "onAnimationEndCapture" | "onAnimationIteration" | "onAnimationIterationCapture" | "onTransitionEnd" | "onTransitionEndCapture"> & {
     theme?: import("@emotion/react").Theme | undefined;
 }, {}, {}>;
-export declare const DowngradeToFreeContent: ({ planName, totalPrice, billingPeriod, }: {
+export declare const DowngradeToFreeContent: ({ headerText, planName, priceText, }: {
+    headerText: string;
     planName: string;
-    totalPrice?: {
-        amount: number;
-        currency: Currency;
-    } | undefined;
-    billingPeriod?: BillingPeriod | undefined;
+    priceText: string;
 }) => JSX.Element;
 declare type DowngradeToFreePlanProps = {
     checkoutLocalization: CheckoutLocalization;

package/dist/components/checkout/components/StyledArrow.d.ts

@@ -0,0 +1,5 @@
+/// <reference types="react" />
+/// <reference types="@emotion/styled/macro" />
+export declare const StyledArrowRightIcon: import("@emotion/styled/macro").StyledComponent<import("react").SVGProps<SVGElement> & {
+    theme?: import("@emotion/react").Theme | undefined;
+}, {}, {}>;

package/dist/components/checkout/hooks/useLoadCheckout.d.ts

@@ -1,10 +1,12 @@
 import { GetCheckoutStateResults } from '@stigg/js-client-sdk';
+import { MockCheckoutStateCallback } from '../CheckoutProvider';
 declare type UseLoadCheckoutProps = {
     planId: string;
     resourceId?: string;
     billingCountryCode?: string;
+    onMockCheckoutState?: MockCheckoutStateCallback;
 };
-export declare function useLoadCheckout({ planId, resourceId, billingCountryCode }: UseLoadCheckoutProps): {
+export declare function useLoadCheckout({ planId, resourceId, billingCountryCode, onMockCheckoutState }: UseLoadCheckoutProps): {
     checkout: GetCheckoutStateResults | null | undefined;
     isLoading: boolean;
 };

package/dist/components/checkout/hooks/usePreviewSubscription.d.ts

@@ -1,22 +1,25 @@
 import { StiggClient, SubscriptionPreview } from '@stigg/js-client-sdk';
 import { SubscriptionState } from './useSubscriptionModel';
+import { OnMockCheckoutPreviewCallback } from '../CheckoutContainer';
+declare type UsePreviewSubscriptionProps = {
+    onMockCheckoutPreview?: OnMockCheckoutPreviewCallback;
+};
 export declare type PreviewSubscriptionProps = {
     customerId?: string;
     planId?: string;
     resourceId?: string;
     stigg: StiggClient;
-} & SubscriptionState;
-export declare const usePreviewSubscriptionAction: () => {
+} & SubscriptionState & UsePreviewSubscriptionProps;
+export declare const usePreviewSubscriptionAction: ({ onMockCheckoutPreview }?: UsePreviewSubscriptionProps) => {
     previewSubscriptionAction: ({ promotionCode }?: {
         promotionCode?: string | null | undefined;
     }) => Promise<{
         subscriptionPreview: SubscriptionPreview | null;
         errorMessage: string | null;
-    } | {
-        subscriptionPreview: null;
     }>;
 };
-export declare const usePreviewSubscription: () => {
+export declare const usePreviewSubscription: ({ onMockCheckoutPreview }?: UsePreviewSubscriptionProps) => {
     subscriptionPreview: SubscriptionPreview | null;
     isFetchingSubscriptionPreview: boolean;
 };
+export {};

package/dist/components/checkout/summary/CheckoutSummary.d.ts

@@ -13,6 +13,6 @@ export declare const SummaryCard: import("@emotion/styled/macro").StyledComponen
 }, "slot" | "title" | "ref" | "key" | "defaultChecked" | "defaultValue" | "suppressContentEditableWarning" | "suppressHydrationWarning" | "accessKey" | "contentEditable" | "contextMenu" | "dir" | "draggable" | "hidden" | "id" | "lang" | "placeholder" | "spellCheck" | "tabIndex" | "translate" | "radioGroup" | "role" | "about" | "datatype" | "inlist" | "prefix" | "property" | "resource" | "typeof" | "vocab" | "autoCapitalize" | "autoCorrect" | "autoSave" | "color" | "itemProp" | "itemScope" | "itemType" | "itemID" | "itemRef" | "results" | "security" | "unselectable" | "inputMode" | "is" | "aria-activedescendant" | "aria-atomic" | "aria-autocomplete" | "aria-busy" | "aria-checked" | "aria-colcount" | "aria-colindex" | "aria-colspan" | "aria-controls" | "aria-current" | "aria-describedby" | "aria-details" | "aria-disabled" | "aria-dropeffect" | "aria-errormessage" | "aria-expanded" | "aria-flowto" | "aria-grabbed" | "aria-haspopup" | "aria-hidden" | "aria-invalid" | "aria-keyshortcuts" | "aria-label" | "aria-labelledby" | "aria-level" | "aria-live" | "aria-modal" | "aria-multiline" | "aria-multiselectable" | "aria-orientation" | "aria-owns" | "aria-placeholder" | "aria-posinset" | "aria-pressed" | "aria-readonly" | "aria-relevant" | "aria-required" | "aria-roledescription" | "aria-rowcount" | "aria-rowindex" | "aria-rowspan" | "aria-selected" | "aria-setsize" | "aria-sort" | "aria-valuemax" | "aria-valuemin" | "aria-valuenow" | "aria-valuetext" | "dangerouslySetInnerHTML" | "onCopy" | "onCopyCapture" | "onCut" | "onCutCapture" | "onPaste" | "onPasteCapture" | "onCompositionEnd" | "onCompositionEndCapture" | "onCompositionStart" | "onCompositionStartCapture" | "onCompositionUpdate" | "onCompositionUpdateCapture" | "onFocus" | "onFocusCapture" | "onBlur" | "onBlurCapture" | "onChange" | "onChangeCapture" | "onBeforeInput" | "onBeforeInputCapture" | "onInput" | "onInputCapture" | "onReset" | "onResetCapture" | "onSubmit" | "onSubmitCapture" | "onInvalid" | "onInvalidCapture" | "onLoad" | "onLoadCapture" | "onError" | "onErrorCapture" | "onKeyDown" | "onKeyDownCapture" | "onKeyPress" | "onKeyPressCapture" | "onKeyUp" | "onKeyUpCapture" | "onAbort" | "onAbortCapture" | "onCanPlay" | "onCanPlayCapture" | "onCanPlayThrough" | "onCanPlayThroughCapture" | "onDurationChange" | "onDurationChangeCapture" | "onEmptied" | "onEmptiedCapture" | "onEncrypted" | "onEncryptedCapture" | "onEnded" | "onEndedCapture" | "onLoadedData" | "onLoadedDataCapture" | "onLoadedMetadata" | "onLoadedMetadataCapture" | "onLoadStart" | "onLoadStartCapture" | "onPause" | "onPauseCapture" | "onPlay" | "onPlayCapture" | "onPlaying" | "onPlayingCapture" | "onProgress" | "onProgressCapture" | "onRateChange" | "onRateChangeCapture" | "onSeeked" | "onSeekedCapture" | "onSeeking" | "onSeekingCapture" | "onStalled" | "onStalledCapture" | "onSuspend" | "onSuspendCapture" | "onTimeUpdate" | "onTimeUpdateCapture" | "onVolumeChange" | "onVolumeChangeCapture" | "onWaiting" | "onWaitingCapture" | "onAuxClick" | "onAuxClickCapture" | "onClick" | "onClickCapture" | "onContextMenu" | "onContextMenuCapture" | "onDoubleClick" | "onDoubleClickCapture" | "onDrag" | "onDragCapture" | "onDragEnd" | "onDragEndCapture" | "onDragEnter" | "onDragEnterCapture" | "onDragExit" | "onDragExitCapture" | "onDragLeave" | "onDragLeaveCapture" | "onDragOver" | "onDragOverCapture" | "onDragStart" | "onDragStartCapture" | "onDrop" | "onDropCapture" | "onMouseDown" | "onMouseDownCapture" | "onMouseEnter" | "onMouseLeave" | "onMouseMove" | "onMouseMoveCapture" | "onMouseOut" | "onMouseOutCapture" | "onMouseOver" | "onMouseOverCapture" | "onMouseUp" | "onMouseUpCapture" | "onSelect" | "onSelectCapture" | "onTouchCancel" | "onTouchCancelCapture" | "onTouchEnd" | "onTouchEndCapture" | "onTouchMove" | "onTouchMoveCapture" | "onTouchStart" | "onTouchStartCapture" | "onPointerDown" | "onPointerDownCapture" | "onPointerMove" | "onPointerMoveCapture" | "onPointerUp" | "onPointerUpCapture" | "onPointerCancel" | "onPointerCancelCapture" | "onPointerEnter" | "onPointerEnterCapture" | "onPointerLeave" | "onPointerLeaveCapture" | "onPointerOver" | "onPointerOverCapture" | "onPointerOut" | "onPointerOutCapture" | "onGotPointerCapture" | "onGotPointerCaptureCapture" | "onLostPointerCapture" | "onLostPointerCaptureCapture" | "onScroll" | "onScrollCapture" | "onWheel" | "onWheelCapture" | "onAnimationStart" | "onAnimationStartCapture" | "onAnimationEnd" | "onAnimationEndCapture" | "onAnimationIteration" | "onAnimationIterationCapture" | "onTransitionEnd" | "onTransitionEndCapture"> & {
     theme?: import("@emotion/react").Theme | undefined;
 }, {}, {}>;
-export declare const CheckoutSummary: ({ onCheckout, onCheckoutCompleted, disablePromotionCode, disableSuccessAnimation, isFreeDowngrade, }: CheckoutContainerProps & {
+export declare const CheckoutSummary: ({ onCheckout, onCheckoutCompleted, disablePromotionCode, disableSuccessAnimation, isFreeDowngrade, onMockCheckoutPreview, }: CheckoutContainerProps & {
     isFreeDowngrade: boolean;
 }) => JSX.Element;

package/dist/components/checkout/summary/components/LineItems.d.ts

@@ -21,16 +21,16 @@ export declare const BilledPriceLineItem: ({ label, quantity, price }: {
     price: Price;
 }) => JSX.Element;
 export declare const DiscountLineItem: ({ subscriptionPreview, isFetchingSubscriptionPreview, }: {
-    subscriptionPreview: SubscriptionPreview | null;
+    subscriptionPreview: SubscriptionPreview;
     isFetchingSubscriptionPreview: boolean;
-}) => JSX.Element | null;
+}) => JSX.Element;
 export declare const AppliedCreditsLineItem: ({ subscriptionPreview, isFetchingSubscriptionPreview, checkoutLocalization, }: {
-    subscriptionPreview: SubscriptionPreview | null;
+    subscriptionPreview: SubscriptionPreview;
     isFetchingSubscriptionPreview: boolean;
     checkoutLocalization: CheckoutLocalization;
-}) => JSX.Element | null;
+}) => JSX.Element;
 export declare const TaxLineItem: ({ subscriptionPreview, isFetchingSubscriptionPreview, checkoutLocalization, }: {
-    subscriptionPreview: SubscriptionPreview | null;
+    subscriptionPreview: SubscriptionPreview;
     isFetchingSubscriptionPreview: boolean;
     checkoutLocalization: CheckoutLocalization;
-}) => JSX.Element | null;
+}) => JSX.Element;

package/dist/components/checkout/textOverrides.d.ts

@@ -28,9 +28,30 @@ export declare type CheckoutLocalization = {
     taxTitle: (params: {
         taxDetails: SubscriptionPreviewTaxDetails;
     }) => string;
-    downgradeToFreeAlertText: (params: {
-        plan: Plan;
-    }) => string;
+    downgradeToFree: {
+        alertText: (params: {
+            plan: Plan;
+        }) => string;
+        freePlanHeader: (params: {
+            plan: Plan;
+        }) => string;
+        freePlanName: (params: {
+            plan: Plan;
+        }) => string;
+        freePlanPriceText: (params: {
+            plan: Plan;
+        }) => string;
+        paidPlanHeader: (params: {
+            plan: Plan;
+        }) => string;
+        paidPlanName: (params: {
+            plan: Plan;
+        }) => string;
+        paidPlanPriceText: (params: {
+            plan: Plan;
+            billingPeriod?: BillingPeriod;
+        }) => string;
+    };
     checkoutSuccessText: string;
 };
 export declare function getResolvedCheckoutLocalize(localizeOverride?: DeepPartial<CheckoutLocalization>): CheckoutLocalization;