@schematichq/schematic-components 2.14.1 → 2.16.0

package/dist/schematic-components.d.ts

@@ -4,14 +4,13 @@ import { Context } from 'react';
 import { DetailedHTMLProps } from 'react';
 import { FastOmit } from 'styled-components';
 import { ForwardRefExoticComponent } from 'react';
-import { HTMLAttributeAnchorTarget } from 'react';
 import { HTMLAttributes } from 'react';
 import { IconNames } from '@schematichq/schematic-icons';
 import { IconProps as IconProps_2 } from '@schematichq/schematic-icons';
 import { iconsList } from '@schematichq/schematic-icons';
 import { InputHTMLAttributes } from 'react';
 import { IStyledComponentBase } from 'styled-components/dist/types';
-import { JSX } from 'react/jsx-runtime';
+import { JSX } from 'react';
 import { RefAttributes } from 'react';
 import { RuleSet } from 'styled-components';
 import type { Stripe } from '@stripe/stripe-js';
@@ -297,6 +296,7 @@ declare const BillingCreditGrantZeroedOutReason: {
     readonly Manual: "manual";
     readonly PlanChange: "plan_change";
     readonly PlanPeriodReset: "plan_period_reset";
+    readonly Reconciled: "reconciled";
 };
 
 declare type BillingCreditGrantZeroedOutReason = (typeof BillingCreditGrantZeroedOutReason)[keyof typeof BillingCreditGrantZeroedOutReason];
@@ -2882,6 +2882,25 @@ export declare interface BypassConfig {
      * is not eligible for a trial.
      */
     startTrialIfAvailable?: boolean;
+    /**
+     * Currency to pre-select (e.g. "EUR"). Case-insensitive.
+     *
+     * Useful for flows that skip the plan stage: the host can pin the checkout
+     * to a currency the customer never had a chance to choose. Ignored when the
+     * company already has an active subscription (its currency is locked), or
+     * when the value is not among the available currencies — in which case the
+     * checkout falls back to the first available currency.
+     */
+    currency?: string;
+    /**
+     * Whether to show the currency selector dropdown in checkout. Default: true.
+     *
+     * Set to false to hide the dropdown entirely — combine with `currency` to
+     * pin checkout to a single currency the customer cannot change. Has no
+     * effect when there is only one available currency or the subscription
+     * currency is locked (the selector is already hidden in those cases).
+     */
+    showCurrencySelector?: boolean;
 }
 
 export declare const Card: ForwardRefExoticComponent<CardProps & RefAttributes<HTMLDivElement | null>>;
@@ -2941,6 +2960,12 @@ declare interface ChangeSubscriptionRequestBody {
      * @memberof ChangeSubscriptionRequestBody
      */
     newPriceId: string;
+    /**
+     *
+     * @type {boolean}
+     * @memberof ChangeSubscriptionRequestBody
+     */
+    optInAccepted?: boolean | null;
     /**
      *
      * @type {Array<UpdatePayInAdvanceRequestBody>}
@@ -2993,7 +3018,9 @@ declare const ChargeType_2: {
 
 declare type ChargeType_2 = (typeof ChargeType_2)[keyof typeof ChargeType_2];
 
-export declare const Checkout: ({ isPaymentMethodRequired, setPaymentMethodId, updatePromoCode, confirmPaymentIntentProps, financeData, onPaymentMethodSaved, }: CheckoutProps) => JSX.Element | null;
+export declare const Checkbox: IStyledComponentBase<"web", FastOmit<FastOmit<DetailedHTMLProps<InputHTMLAttributes<HTMLInputElement>, HTMLInputElement>, keyof ClassAttributes<HTMLInputElement> | keyof InputHTMLAttributes<HTMLInputElement>> & ClassAttributes<HTMLInputElement> & InputHTMLAttributes<HTMLInputElement>, "type"> & Partial<Pick<FastOmit<DetailedHTMLProps<InputHTMLAttributes<HTMLInputElement>, HTMLInputElement>, keyof ClassAttributes<HTMLInputElement> | keyof InputHTMLAttributes<HTMLInputElement>> & ClassAttributes<HTMLInputElement> & InputHTMLAttributes<HTMLInputElement>, "type">>> & string;
+
+export declare const Checkout: ({ customCheckoutFields, customFieldValues, isPaymentMethodRequired, onCustomFieldChange, optInRequired, optInTitle, optInText, optInAccepted, setOptInAccepted, setPaymentMethodId, updatePromoCode, confirmPaymentIntentProps, financeData, onPaymentMethodSaved, }: CheckoutProps) => JSX.Element | null;
 
 /**
  * Host-provided initial values used to pre-populate the checkout payment form.
@@ -3120,7 +3147,15 @@ export declare interface CheckoutPrefill {
 }
 
 declare interface CheckoutProps {
+    customCheckoutFields?: CheckoutFieldWithValue[];
+    customFieldValues: Record<string, string>;
     isPaymentMethodRequired: boolean;
+    onCustomFieldChange: (fieldId: string, value: string) => void;
+    optInRequired: boolean;
+    optInTitle?: string | null;
+    optInText?: string | null;
+    optInAccepted: boolean;
+    setOptInAccepted: (accepted: boolean) => void;
     setPaymentMethodId: (id: string) => void;
     updatePromoCode: (code: string) => void;
     confirmPaymentIntentProps?: ConfirmPaymentIntentProps_2 | null | undefined;
@@ -3379,6 +3414,7 @@ export declare type CheckoutState = {
     addOnIds?: string[];
     hideSkippedStages?: boolean;
     selectedCurrency?: string;
+    showCurrencySelector?: boolean;
     startTrialIfAvailable?: boolean;
 };
 
@@ -6293,6 +6329,7 @@ export declare interface EmbedContextProps extends EmbedState {
     checkout: (changeSubscriptionRequestBody: ChangeSubscriptionRequestBody) => DebouncedApiPromise<CheckoutResponse>;
     finishCheckout: (changeSubscriptionRequestBody: CheckoutResponseData) => void;
     unsubscribe: () => DebouncedApiPromise<CheckoutUnsubscribeResponse>;
+    updateCustomFieldValues: (values: Record<string, string>) => Promise<void> | undefined;
     setAccessToken: (token: string) => void;
     setError: (error: Error) => void;
     setLayout: (layout: EmbedLayout) => void;
@@ -6913,11 +6950,23 @@ declare interface FeatureEntitlement {
      */
     creditId?: string | null;
     /**
-     * If the company has a credit-based entitlement for this feature, the remaining credit amount
+     * If the company has a credit-based entitlement for this feature, the credit available to fund new consumption or a new lease hold — open lease holds are excluded. Clients that hold a lease should gate on this plus their own unspent hold; clients with no lease awareness should use credit_settled instead
      * @type {number}
      * @memberof FeatureEntitlement
      */
     creditRemaining?: number | null;
+    /**
+     * If the company has a credit-based entitlement for this feature, the unspent amount held by an open credit lease. Returns to credit_remaining when the lease is released
+     * @type {number}
+     * @memberof FeatureEntitlement
+     */
+    creditReserved?: number | null;
+    /**
+     * If the company has a credit-based entitlement for this feature, the balance net of actual consumption, unaffected by open lease holds (credit_remaining plus credit_reserved). The number to display to end users
+     * @type {number}
+     * @memberof FeatureEntitlement
+     */
+    creditSettled?: number | null;
     /**
      * If the company has a credit-based entitlement for this feature, the total credit amount
      * @type {number}
@@ -8222,6 +8271,7 @@ export declare const initialContext: {
     previewCheckout: () => never;
     checkout: () => never;
     unsubscribe: () => never;
+    updateCustomFieldValues: () => never;
     setError: () => never;
     setAccessToken: () => never;
     setLayout: () => never;
@@ -8246,11 +8296,11 @@ export declare const initialContext: {
 
 export declare const initialState: EmbedState;
 
-export declare const Input: IStyledComponentBase<"web", FastOmit<FastOmit<DetailedHTMLProps<InputHTMLAttributes<HTMLInputElement>, HTMLInputElement>, "$color" | "$variant" | "$size"> & {
+export declare const Input: IStyledComponentBase<"web", FastOmit<FastOmit<DetailedHTMLProps<InputHTMLAttributes<HTMLInputElement>, HTMLInputElement>, "$color" | "$size" | "$variant"> & {
 $size?: "xs" | "sm" | "md" | "lg" | "full";
 $color?: "primary" | "secondary" | "danger";
 $variant?: "filled" | "outline" | "ghost" | "text";
-}, never> & Partial<Pick<FastOmit<DetailedHTMLProps<InputHTMLAttributes<HTMLInputElement>, HTMLInputElement>, "$color" | "$variant" | "$size"> & {
+}, never> & Partial<Pick<FastOmit<DetailedHTMLProps<InputHTMLAttributes<HTMLInputElement>, HTMLInputElement>, "$color" | "$size" | "$variant"> & {
 $size?: "xs" | "sm" | "md" | "lg" | "full";
 $color?: "primary" | "secondary" | "danger";
 $variant?: "filled" | "outline" | "ghost" | "text";
@@ -10753,6 +10803,24 @@ declare interface PreviewSubscriptionChangeResponseData {
      * @deprecated
      */
     newCharges: number;
+    /**
+     *
+     * @type {boolean}
+     * @memberof PreviewSubscriptionChangeResponseData
+     */
+    optInRequired: boolean;
+    /**
+     *
+     * @type {string}
+     * @memberof PreviewSubscriptionChangeResponseData
+     */
+    optInText?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof PreviewSubscriptionChangeResponseData
+     */
+    optInTitle?: string | null;
     /**
      *
      * @type {boolean}
@@ -10947,7 +11015,7 @@ export declare const PricingTable: ForwardRefExoticComponent<ElementProps & Deep
 
 export declare type PricingTableOptions = {
     callToActionUrl?: string;
-    callToActionTarget?: HTMLAttributeAnchorTarget;
+    callToActionTarget?: React.HTMLAttributeAnchorTarget;
     onCallToAction?: (plan: PlanViewPublicResponseData | CompanyPlanDetailResponseData) => unknown;
 };