@schematichq/schematic-components 2.22.2 → 2.24.0

package/dist/schematic-components.d.ts

@@ -1,7 +1,6 @@
 import { ButtonHTMLAttributes } from 'react';
 import { Context } from 'react';
 import { CSSProperties } from 'react';
-import { CSSProperties as CSSProperties_2 } from 'styled-components';
 import { CSSPropertiesWithVars } from 'styled-components/dist/types';
 import { DetailedHTMLProps } from 'react';
 import { FastOmit } from 'styled-components';
@@ -109,6 +108,12 @@ declare interface BillingCreditBundleView {
      * @memberof BillingCreditBundleView
      */
     bundleType: BillingCreditBundleType;
+    /**
+     *
+     * @type {Array<string>}
+     * @memberof BillingCreditBundleView
+     */
+    compatiblePlanIds: Array<string>;
     /**
      *
      * @type {Date}
@@ -1052,9 +1057,10 @@ declare interface BillingPlanCreditGrantResponseData {
      */
     autoTopupThresholdPercent?: number | null;
     /**
-     * Whether buyers can purchase one-time credit bundles on this grant, independent of auto top-up availability.
+     * Deprecated: bundle availability is a per-bundle plan compatibility set now; use compatible_plan_ids on credit bundles instead.
      * @type {boolean}
      * @memberof BillingPlanCreditGrantResponseData
+     * @deprecated
      */
     canBuyBundles: boolean;
     /**
@@ -3079,6 +3085,16 @@ export declare interface BypassConfig {
      * currency is locked (the selector is already hidden in those cases).
      */
     showCurrencySelector?: boolean;
+    /**
+     * Whether to show the recurring billing disclaimer beneath the checkout
+     * totals (e.g. "You will be billed $0.00 for this subscription every month
+     * on the 17th unless you unsubscribe."). Default: true.
+     *
+     * Set to false to hide that sentence when the host presents its own billing
+     * terms. The scheduled-downgrade notice, which occupies the same spot, is
+     * unaffected.
+     */
+    showBillingDisclaimer?: boolean;
     /**
      * Pre-fill pay-in-advance quantities, keyed by feature id.
      *
@@ -3228,11 +3244,11 @@ declare const ChargeType_2: {
 
 declare type ChargeType_2 = (typeof ChargeType_2)[keyof typeof ChargeType_2];
 
-export declare const Checkbox: IStyledComponentBase<"web", FastOmit<Merged<Omit<DetailedHTMLProps<InputHTMLAttributes<HTMLInputElement>, HTMLInputElement>, "style"> & {
+export declare const Checkbox: IStyledComponentBase<"web", Omit<Omit<DetailedHTMLProps<InputHTMLAttributes<HTMLInputElement>, HTMLInputElement>, "style"> & {
 style?: CSSProperties | CSSPropertiesWithVars | undefined;
-}, DetailedHTMLProps<InputHTMLAttributes<HTMLInputElement>, HTMLInputElement>>, "type"> & Partial<Pick<Merged<Omit<DetailedHTMLProps<InputHTMLAttributes<HTMLInputElement>, HTMLInputElement>, "style"> & {
+}, "type"> & Partial<Pick<Omit<DetailedHTMLProps<InputHTMLAttributes<HTMLInputElement>, HTMLInputElement>, "style"> & {
 style?: CSSProperties | CSSPropertiesWithVars | undefined;
-}, DetailedHTMLProps<InputHTMLAttributes<HTMLInputElement>, HTMLInputElement>>, "type">>> & string;
+}, "type">>> & string;
 
 export declare const Checkout: ({ collectTaxId, customCheckoutFields, customFieldValues, isPaymentMethodRequired, onCustomFieldChange, taxIdValues, onTaxIdChange, onTaxIdBlur, taxIdError, optInRequired, optInTitle, optInText, optInAccepted, setOptInAccepted, setPaymentMethodId, promoCode, updatePromoCode, confirmPaymentIntentProps, financeData, onPaymentMethodSaved, }: CheckoutProps) => JSX.Element | null;
 
@@ -3249,6 +3265,17 @@ export declare interface CheckoutBillingDetails {
     name?: string;
 }
 
+/**
+ *
+ * @export
+ */
+declare const CheckoutBundlePurchaseBehavior: {
+    readonly Individual: "individual";
+    readonly Quantity: "quantity";
+};
+
+declare type CheckoutBundlePurchaseBehavior = (typeof CheckoutBundlePurchaseBehavior)[keyof typeof CheckoutBundlePurchaseBehavior];
+
 export declare const CheckoutDialog: ({ top }: CheckoutDialogProps) => JSX.Element | null;
 
 declare interface CheckoutDialogProps {
@@ -3651,6 +3678,7 @@ export declare type CheckoutState = {
     hideSkippedStages?: boolean;
     selectedCurrency?: string;
     showCurrencySelector?: boolean;
+    showBillingDisclaimer?: boolean;
     startTrialIfAvailable?: boolean;
     payInAdvanceQuantities?: Record<string, number>;
     promoCode?: string;
@@ -5031,6 +5059,12 @@ declare interface ComponentCapabilities_2 {
  * @interface ComponentCheckoutSettings
  */
 declare interface ComponentCheckoutSettings {
+    /**
+     *
+     * @type {CheckoutBundlePurchaseBehavior}
+     * @memberof ComponentCheckoutSettings
+     */
+    bundlePurchaseBehavior: CheckoutBundlePurchaseBehavior;
     /**
      *
      * @type {boolean}
@@ -5620,6 +5654,10 @@ export declare const createActiveUsageBasedEntitlementsReducer: (entitlements: F
 
 declare type Credit = Omit<CreditWithCompanyContext, "companyId" | "companyName" | "bundleId" | "total" | "grants"> & {
     period?: string;
+    /** flat (company-level) portion of the plan's grants on this credit */
+    fixedQuantity: number;
+    /** per-license portions; effective amount = amount × license quantity */
+    perLicenseGrants: PerLicenseCreditGrant[];
 };
 
 declare type CreditBundle = BillingCreditBundleView & {
@@ -5988,12 +6026,14 @@ declare interface CreditGrantDetail {
     quantity: number;
 }
 
-export declare const Credits: ({ bundles, updateCount, currency }: CreditsProps) => JSX.Element;
+export declare const Credits: ({ isLoading, bundles, isIndividualPurchase, updateCount, toggle, currency, }: CreditsProps) => JSX.Element;
 
 declare interface CreditsProps {
     isLoading: boolean;
     bundles: CreditBundle[];
+    isIndividualPurchase: boolean;
     updateCount: (id: string, count: number) => void;
+    toggle: (id: string) => void;
     currency?: string;
 }
 
@@ -6171,6 +6211,12 @@ declare interface CustomPlanBillingResponseData {
      * @memberof CustomPlanBillingResponseData
      */
     activationStrategy: CustomPlanActivationStrategy;
+    /**
+     * The billing period renewal date pinned when the subscription started, when one was set. When no invoice exists yet, the first invoice is raised on this date.
+     * @type {Date}
+     * @memberof CustomPlanBillingResponseData
+     */
+    billingCycleAnchor?: Date | null;
     /**
      *
      * @type {string}
@@ -6641,7 +6687,7 @@ style?: CSSProperties | CSSPropertiesWithVars | undefined;
 as?: WebTarget | undefined;
 forwardedAs?: WebTarget | undefined;
 }, "style"> & {
-style?: CSSProperties | CSSPropertiesWithVars | (CSSProperties_2 & {
+style?: CSSProperties | CSSPropertiesWithVars | (CSSProperties & {
 [key: `--${string}`]: string | number | undefined;
 }) | undefined;
 }> & string;
@@ -8378,7 +8424,7 @@ style?: CSSProperties | CSSPropertiesWithVars | undefined;
 as?: WebTarget | undefined;
 forwardedAs?: WebTarget | undefined;
 }, "style"> & {
-style?: CSSProperties | CSSPropertiesWithVars | (CSSProperties_2 & {
+style?: CSSProperties | CSSPropertiesWithVars | (CSSProperties & {
 [key: `--${string}`]: string | number | undefined;
 }) | undefined;
 }> & string;
@@ -8402,14 +8448,14 @@ style?: CSSProperties | CSSPropertiesWithVars | undefined;
 as?: WebTarget | undefined;
 forwardedAs?: WebTarget | undefined;
 }, "style"> & {
-style?: CSSProperties | CSSPropertiesWithVars | (CSSProperties_2 & {
+style?: CSSProperties | CSSPropertiesWithVars | (CSSProperties & {
 [key: `--${string}`]: string | number | undefined;
 }) | undefined;
 }, "as" | "forwardedAs"> & {
 as?: WebTarget | undefined;
 forwardedAs?: WebTarget | undefined;
 }, "style"> & {
-style?: CSSProperties | CSSPropertiesWithVars | (CSSProperties_2 & {
+style?: CSSProperties | CSSPropertiesWithVars | (CSSProperties & {
 [key: `--${string}`]: string | number | undefined;
 }) | undefined;
 }> & string;
@@ -8936,7 +8982,7 @@ style?: CSSProperties | CSSPropertiesWithVars | undefined;
 as?: WebTarget | undefined;
 forwardedAs?: WebTarget | undefined;
 }, "style"> & {
-style?: CSSProperties | CSSPropertiesWithVars | (CSSProperties_2 & {
+style?: CSSProperties | CSSPropertiesWithVars | (CSSProperties & {
 [key: `--${string}`]: string | number | undefined;
 }) | undefined;
 }> & string;
@@ -8947,14 +8993,14 @@ style?: CSSProperties | CSSPropertiesWithVars | undefined;
 as?: WebTarget | undefined;
 forwardedAs?: WebTarget | undefined;
 }, "style"> & {
-style?: CSSProperties | CSSPropertiesWithVars | (CSSProperties_2 & {
+style?: CSSProperties | CSSPropertiesWithVars | (CSSProperties & {
 [key: `--${string}`]: string | number | undefined;
 }) | undefined;
 }, "as" | "forwardedAs"> & {
 as?: WebTarget | undefined;
 forwardedAs?: WebTarget | undefined;
 }, "style"> & {
-style?: CSSProperties | CSSPropertiesWithVars | (CSSProperties_2 & {
+style?: CSSProperties | CSSPropertiesWithVars | (CSSProperties & {
 [key: `--${string}`]: string | number | undefined;
 }) | undefined;
 }> & string;
@@ -9100,6 +9146,13 @@ declare interface PaymentMethodResponseData {
     updatedAt: Date;
 }
 
+declare interface PerLicenseCreditGrant {
+    /** credits granted per unit of the license */
+    amount: number;
+    /** the license whose quantity scales the grant */
+    licenseId: string;
+}
+
 export declare const Plan: ({ portal, isLoading, plans, selectedPlan, period, selectPlan, shouldTrial, currency, }: PlanProps) => JSX.Element;
 
 declare type Plan_2 = CompanyPlanDetailResponseData;
@@ -11659,7 +11712,7 @@ declare interface PublicPlansResponseData {
     showZeroPriceAsFree: boolean;
 }
 
-export declare const Quantity: ({ portal, entitlements, updateQuantity, period, currency: selectedCurrency, }: QuantityProps) => JSX.Element;
+export declare const Quantity: ({ portal, entitlements, updateQuantity, period, selectedPlan, currency: selectedCurrency, }: QuantityProps) => JSX.Element;
 
 declare interface QuantityProps {
     portal?: HTMLElement | null;
@@ -12602,11 +12655,11 @@ declare type TaxIdValues = {
     value: string;
 };
 
-declare const Text_2: IStyledComponentBase<"web", FastOmit<Merged<Merged<Omit<DetailedHTMLProps<HTMLAttributes<HTMLSpanElement>, HTMLSpanElement>, "style"> & {
+declare const Text_2: IStyledComponentBase<"web", Omit<Merged<Omit<DetailedHTMLProps<HTMLAttributes<HTMLSpanElement>, HTMLSpanElement>, "style"> & {
 style?: CSSProperties | CSSPropertiesWithVars | undefined;
-}, DetailedHTMLProps<HTMLAttributes<HTMLSpanElement>, HTMLSpanElement>>, TextProps>, "tabIndex"> & Partial<Pick<Merged<Merged<Omit<DetailedHTMLProps<HTMLAttributes<HTMLSpanElement>, HTMLSpanElement>, "style"> & {
+}, TextProps>, "tabIndex"> & Partial<Pick<Merged<Omit<DetailedHTMLProps<HTMLAttributes<HTMLSpanElement>, HTMLSpanElement>, "style"> & {
 style?: CSSProperties | CSSPropertiesWithVars | undefined;
-}, DetailedHTMLProps<HTMLAttributes<HTMLSpanElement>, HTMLSpanElement>>, TextProps>, "tabIndex">>> & string;
+}, TextProps>, "tabIndex">>> & string;
 export { Text_2 as Text }
 
 export declare const TextElement: ForwardRefExoticComponent<ElementProps & DeepPartial<DesignProps_8> & HTMLAttributes<HTMLDivElement> & {
@@ -12662,11 +12715,11 @@ export declare interface ThemeSettings {
     };
 }
 
-export declare const Toggle: IStyledComponentBase<"web", FastOmit<Merged<Omit<DetailedHTMLProps<InputHTMLAttributes<HTMLInputElement>, HTMLInputElement>, "style"> & {
+export declare const Toggle: IStyledComponentBase<"web", Omit<Omit<DetailedHTMLProps<InputHTMLAttributes<HTMLInputElement>, HTMLInputElement>, "style"> & {
 style?: CSSProperties | CSSPropertiesWithVars | undefined;
-}, DetailedHTMLProps<InputHTMLAttributes<HTMLInputElement>, HTMLInputElement>>, "type"> & Partial<Pick<Merged<Omit<DetailedHTMLProps<InputHTMLAttributes<HTMLInputElement>, HTMLInputElement>, "style"> & {
+}, "type"> & Partial<Pick<Omit<DetailedHTMLProps<InputHTMLAttributes<HTMLInputElement>, HTMLInputElement>, "style"> & {
 style?: CSSProperties | CSSPropertiesWithVars | undefined;
-}, DetailedHTMLProps<InputHTMLAttributes<HTMLInputElement>, HTMLInputElement>>, "type">>> & string;
+}, "type">>> & string;
 
 export declare const Tooltip: ({ children, portal, trigger, content, position, ...rest }: TooltipProps) => JSX.Element;
 
@@ -12755,7 +12808,7 @@ style?: CSSProperties | CSSPropertiesWithVars | undefined;
 as?: WebTarget | undefined;
 forwardedAs?: WebTarget | undefined;
 }, "style"> & {
-style?: CSSProperties | CSSPropertiesWithVars | (CSSProperties_2 & {
+style?: CSSProperties | CSSPropertiesWithVars | (CSSProperties & {
 [key: `--${string}`]: string | number | undefined;
 }) | undefined;
 }, TransitionBoxProps>> & string;
@@ -12764,6 +12817,21 @@ declare interface TransitionBoxProps {
     $isExpanded?: boolean;
 }
 
+export declare interface TruncatedList<T> {
+    /** The first `limit` items while collapsed, every item while expanded. */
+    items: T[];
+    /** Total number of items before truncation. */
+    total: number;
+    /** How many items the current state hides — always `0` while expanded. */
+    hiddenCount: number;
+    /** Only render an expand affordance when this is `true`. */
+    canExpand: boolean;
+    isExpanded: boolean;
+    toggle: () => void;
+    expand: () => void;
+    collapse: () => void;
+}
+
 export declare interface TypographySettings {
     fontFamily: string;
     fontSize: number;
@@ -13129,6 +13197,19 @@ export declare function useTrialEnd(): {
     units: string | undefined;
 };
 
+/**
+ * Headless truncation state for long lists.
+ *
+ * Returns a slice rather than rendering anything, so it composes with any
+ * layout — including CSS-table rows, where an extra wrapper element would
+ * break the anonymous table box.
+ */
+export declare function useTruncatedList<T>(items: T[], { limit }: UseTruncatedListOptions): TruncatedList<T>;
+
+export declare interface UseTruncatedListOptions {
+    limit: number;
+}
+
 export declare function useWrapChildren(ref: React.RefObject<HTMLElement[]>): boolean;
 
 export declare const Viewport: ForwardRefExoticComponent<Omit<ViewportProps, "ref"> & RefAttributes<HTMLDivElement | null>>;