@schematichq/schematic-components 2.8.4 → 2.9.0-rc.1

package/dist/schematic-components.d.ts

@@ -17,13 +17,14 @@ import { RuleSet } from 'styled-components';
 import type { Stripe } from '@stripe/stripe-js';
 import { Substitute } from 'styled-components/dist/types';
 
-export declare const AddOns: ({ addOns, toggle, isLoading, period }: AddOnsProps) => JSX.Element;
+export declare const AddOns: ({ addOns, toggle, isLoading, period, currency, }: AddOnsProps) => JSX.Element;
 
 declare interface AddOnsProps {
     addOns: SelectedPlan[];
     toggle: (id: string) => void;
     isLoading: boolean;
     period: string;
+    currency?: string;
 }
 
 declare interface AvailablePlanOptions {
@@ -260,6 +261,7 @@ declare type BillingCreditExpiryUnit_2 = (typeof BillingCreditExpiryUnit_2)[keyo
  * @export
  */
 declare const BillingCreditGrantReason: {
+    readonly Adjustment: "adjustment";
     readonly BillingCreditAutoTopup: "billing_credit_auto_topup";
     readonly Free: "free";
     readonly Plan: "plan";
@@ -2974,6 +2976,7 @@ export declare type CheckoutState = {
     bypassCreditsSelection?: boolean;
     addOnIds?: string[];
     hideSkippedStages?: boolean;
+    selectedCurrency?: string;
 };
 
 /**
@@ -4850,12 +4853,13 @@ declare interface CreditGrantDetail {
     quantity: number;
 }
 
-export declare const Credits: ({ bundles, updateCount }: CreditsProps) => JSX.Element;
+export declare const Credits: ({ bundles, updateCount, currency }: CreditsProps) => JSX.Element;
 
 declare interface CreditsProps {
     isLoading: boolean;
     bundles: CreditBundle[];
     updateCount: (id: string, count: number) => void;
+    currency?: string;
 }
 
 /**
@@ -5285,6 +5289,7 @@ declare interface DesignProps_6 {
 
 declare interface DesignProps_7 {
     showPeriodToggle: boolean;
+    showCurrencySelector: boolean;
     showDiscount: boolean;
     header: {
         isVisible: boolean;
@@ -5458,7 +5463,7 @@ export declare interface EmbedState {
     checkoutState?: CheckoutState;
 }
 
-export declare const Entitlement: ({ entitlement, period, credits, tooltipPortal, }: EntitlementProps) => JSX.Element;
+export declare const Entitlement: ({ entitlement, period, credits, tooltipPortal, currency: selectedCurrency, }: EntitlementProps) => JSX.Element;
 
 /**
  *
@@ -5545,6 +5550,7 @@ export declare interface EntitlementProps {
     period: string;
     credits: Credit[];
     tooltipPortal?: HTMLElement | null;
+    currency?: string;
 }
 
 /**
@@ -7622,7 +7628,7 @@ declare interface PaymentMethodResponseData {
     updatedAt: Date;
 }
 
-export declare const Plan: ({ isLoading, plans, selectedPlan, period, selectPlan, shouldTrial, tooltipPortal, }: PlanProps) => JSX.Element;
+export declare const Plan: ({ isLoading, plans, selectedPlan, period, selectPlan, shouldTrial, tooltipPortal, currency, }: PlanProps) => JSX.Element;
 
 declare type Plan_2 = CompanyPlanDetailResponseData;
 
@@ -8568,6 +8574,7 @@ declare interface PlanProps {
     }) => void;
     shouldTrial: boolean;
     tooltipPortal?: HTMLElement | null;
+    currency?: string;
 }
 
 /**
@@ -9581,7 +9588,7 @@ declare interface PublicPlansResponseData {
     showZeroPriceAsFree: boolean;
 }
 
-export declare const Quantity: ({ entitlements, updateQuantity, period, tooltipPortal, }: QuantityProps) => JSX.Element;
+export declare const Quantity: ({ entitlements, updateQuantity, period, tooltipPortal, currency: selectedCurrency, }: QuantityProps) => JSX.Element;
 
 declare interface QuantityProps {
     isLoading: boolean;
@@ -9590,6 +9597,7 @@ declare interface QuantityProps {
     entitlements: UsageBasedEntitlement[];
     updateQuantity: (id: string, quantity: number) => void;
     tooltipPortal?: HTMLElement | null;
+    currency?: string;
 }
 
 declare interface RequestContext {
@@ -10788,6 +10796,8 @@ declare interface UsageBasedEntitlementResponseData {
     yearlyUsageBasedPrice?: BillingPriceView;
 }
 
+export declare function useAvailableCurrencies(): string[];
+
 export declare function useAvailablePlans(activePeriod: string, options?: AvailablePlanOptions): {
     plans: SelectedPlan[];
     addOns: SelectedPlan[];
@@ -10820,6 +10830,13 @@ export declare function useRequest<TData>(fn: () => Promise<{
     data: TData;
 }> | undefined): [RequestState<TData>, () => Promise<void>];
 
+/**
+ * Returns the currency of the company's active subscription, if any.
+ * Stripe does not allow mixing currencies on a subscription, so when
+ * this is set the currency selector should be locked.
+ */
+export declare function useSubscriptionCurrency(): string | undefined;
+
 export declare function useTrialEnd(): {
     endDate: Date | undefined;
     amount: number | undefined;