@schematichq/schematic-components 2.5.1 → 2.6.0

package/dist/schematic-components.d.ts

@@ -293,6 +293,12 @@ declare interface BillingCreditResponseData {
      * @memberof BillingCreditResponseData
      */
     burnStrategy: BillingCreditBurnStrategy;
+    /**
+     *
+     * @type {boolean}
+     * @memberof BillingCreditResponseData
+     */
+    costEditable: boolean;
     /**
      *
      * @type {Date}
@@ -385,6 +391,12 @@ declare interface BillingCreditResponseData_2 {
      * @memberof BillingCreditResponseData
      */
     burnStrategy: BillingCreditBurnStrategy_2;
+    /**
+     *
+     * @type {boolean}
+     * @memberof BillingCreditResponseData
+     */
+    costEditable: boolean;
     /**
      *
      * @type {Date}
@@ -667,6 +679,12 @@ declare interface BillingPlanCreditGrantResponseData {
      * @memberof BillingPlanCreditGrantResponseData
      */
     id: string;
+    /**
+     *
+     * @type {PreviewObjectResponseData}
+     * @memberof BillingPlanCreditGrantResponseData
+     */
+    plan?: PreviewObjectResponseData;
     /**
      *
      * @type {string}
@@ -674,9 +692,10 @@ declare interface BillingPlanCreditGrantResponseData {
      */
     planId: string;
     /**
-     *
+     * Use plan.name from the nested plan object instead
      * @type {string}
      * @memberof BillingPlanCreditGrantResponseData
+     * @deprecated
      */
     planName: string;
     /**
@@ -2204,6 +2223,20 @@ portal?: HTMLElement | null;
 
 export declare type ButtonElementProps = DesignProps;
 
+export declare const ButtonGroup: ({ plan, isLoading, isSelected, onSelect, shouldTrial, }: ButtonGroupProps) => JSX.Element;
+
+export declare interface ButtonGroupProps {
+    plan: SelectedPlan;
+    isLoading: boolean;
+    isSelected: boolean;
+    onSelect: (updates: {
+        plan: SelectedPlan;
+        period?: string;
+        shouldTrial?: boolean;
+    }) => void;
+    shouldTrial?: boolean;
+}
+
 export declare interface ButtonProps {
     $color?: ButtonColor;
     $size?: ButtonSize;
@@ -2744,6 +2777,12 @@ declare interface CompanyDetailResponseData {
      * @memberof CompanyDetailResponseData
      */
     defaultPaymentMethod?: PaymentMethodResponseData;
+    /**
+     *
+     * @type {Array<FeatureEntitlement>}
+     * @memberof CompanyDetailResponseData
+     */
+    entitlements: Array<FeatureEntitlement>;
     /**
      *
      * @type {Array<EntityTraitDetailResponseData>}
@@ -3679,6 +3718,12 @@ declare interface ComponentDisplaySettings {
      * @memberof ComponentDisplaySettings
      */
     showCredits: boolean;
+    /**
+     *
+     * @type {boolean}
+     * @memberof ComponentDisplaySettings
+     */
+    showFeatureDescription: boolean;
     /**
      *
      * @type {boolean}
@@ -3722,6 +3767,12 @@ declare interface ComponentDisplaySettings_2 {
      * @memberof ComponentDisplaySettings
      */
     showCredits: boolean;
+    /**
+     *
+     * @type {boolean}
+     * @memberof ComponentDisplaySettings
+     */
+    showFeatureDescription: boolean;
     /**
      *
      * @type {boolean}
@@ -4084,9 +4135,9 @@ declare const ConditionConditionTypeEnum: {
     readonly BillingProduct: "billing_product";
     readonly Company: "company";
     readonly Credit: "credit";
-    readonly CrmProduct: "crm_product";
     readonly Metric: "metric";
     readonly Plan: "plan";
+    readonly PlanVersion: "plan_version";
     readonly Trait: "trait";
     readonly User: "user";
 };
@@ -4174,6 +4225,10 @@ export declare const ContainerStyle: RuleSet<object>;
 
 export declare const createActiveUsageBasedEntitlementsReducer: (entitlements: FeatureUsageResponseData[], period: string) => (acc: UsageBasedEntitlement[], entitlement: PlanEntitlementResponseData) => UsageBasedEntitlement[];
 
+declare type Credit = Omit<CreditWithCompanyContext, "companyId" | "companyName" | "bundleId" | "total" | "grants"> & {
+    period?: string;
+};
+
 declare type CreditBundle = BillingCreditBundleView & {
     count: number;
 };
@@ -4467,6 +4522,28 @@ declare interface CreditTransferView {
     relatedGrantId: string;
 }
 
+declare interface CreditWithCompanyContext {
+    id: CreditCompanyGrantView["billingCreditId"];
+    name: CreditCompanyGrantView["creditName"];
+    singularName: CreditCompanyGrantView["singularName"];
+    pluralName: CreditCompanyGrantView["pluralName"];
+    description: CreditCompanyGrantView["creditDescription"];
+    icon: CreditCompanyGrantView["creditIcon"];
+    grantReason: CreditCompanyGrantView["grantReason"];
+    quantity: CreditCompanyGrantView["quantity"];
+    companyId: CreditCompanyGrantView["companyId"];
+    companyName: CreditCompanyGrantView["companyName"];
+    planId: CreditCompanyGrantView["planId"];
+    planName: CreditCompanyGrantView["planName"];
+    bundleId: CreditCompanyGrantView["billingCreditBundleId"];
+    total: {
+        value: number;
+        remaining: number;
+        used: number;
+    };
+    grants: CreditCompanyGrantView[];
+}
+
 /**
  * Schematic API
  * Schematic API
@@ -4659,6 +4736,7 @@ declare interface DesignProps_10 {
 }
 
 declare interface DesignProps_2 {
+    visibleFeatures?: string[];
     header: {
         isVisible: boolean;
         fontStyle: FontStyle;
@@ -4669,7 +4747,7 @@ declare interface DesignProps_2 {
         fontStyle: FontStyle;
         style: "light" | "dark";
     };
-    entitlement: {
+    description: {
         isVisible: boolean;
         fontStyle: FontStyle;
     };
@@ -4677,11 +4755,14 @@ declare interface DesignProps_2 {
         isVisible: boolean;
         fontStyle: FontStyle;
     };
+    entitlement: {
+        isVisible: boolean;
+        fontStyle: FontStyle;
+    };
     usage: {
         isVisible: boolean;
         fontStyle: FontStyle;
     };
-    visibleFeatures?: string[];
 }
 
 declare interface DesignProps_3 {
@@ -4937,6 +5018,8 @@ export declare interface EmbedState {
     checkoutState?: CheckoutState;
 }
 
+export declare const Entitlement: ({ entitlement, period, credits, tooltipPortal, }: EntitlementProps) => JSX.Element;
+
 /**
  *
  * @export
@@ -4965,6 +5048,13 @@ declare const EntitlementPriceBehavior_2: {
 
 declare type EntitlementPriceBehavior_2 = (typeof EntitlementPriceBehavior_2)[keyof typeof EntitlementPriceBehavior_2];
 
+export declare interface EntitlementProps {
+    entitlement: PlanEntitlementResponseData;
+    period: string;
+    credits: Credit[];
+    tooltipPortal?: HTMLElement | null;
+}
+
 /**
  *
  * @export
@@ -5623,6 +5713,120 @@ declare interface FeatureDetailResponseData_2 {
     updatedAt: Date;
 }
 
+/**
+ *
+ * @export
+ * @interface FeatureEntitlement
+ */
+declare interface FeatureEntitlement {
+    /**
+     * If the company has a numeric entitlement for this feature, the allocated amount
+     * @type {number}
+     * @memberof FeatureEntitlement
+     */
+    allocation?: number | null;
+    /**
+     * If the company has a credit-based entitlement for this feature, the ID of the credit
+     * @type {string}
+     * @memberof FeatureEntitlement
+     */
+    creditId?: string | null;
+    /**
+     * If the company has a credit-based entitlement for this feature, the remaining credit amount
+     * @type {number}
+     * @memberof FeatureEntitlement
+     */
+    creditRemaining?: number | null;
+    /**
+     * If the company has a credit-based entitlement for this feature, the total credit amount
+     * @type {number}
+     * @memberof FeatureEntitlement
+     */
+    creditTotal?: number | null;
+    /**
+     * If the company has a credit-based entitlement for this feature, the amount of credit used
+     * @type {number}
+     * @memberof FeatureEntitlement
+     */
+    creditUsed?: number | null;
+    /**
+     * If the feature is event-based, the name of the event tracked for usage
+     * @type {string}
+     * @memberof FeatureEntitlement
+     */
+    eventName?: string | null;
+    /**
+     * The ID of the feature
+     * @type {string}
+     * @memberof FeatureEntitlement
+     */
+    featureId: string;
+    /**
+     * The key of the flag associated with the feature
+     * @type {string}
+     * @memberof FeatureEntitlement
+     */
+    featureKey: string;
+    /**
+     * For event-based feature entitlements, the period over which usage is tracked
+     * @type {string}
+     * @memberof FeatureEntitlement
+     */
+    metricPeriod?: FeatureEntitlementMetricPeriodEnum | null;
+    /**
+     * For event-based feature entitlements, when the usage period will reset
+     * @type {Date}
+     * @memberof FeatureEntitlement
+     */
+    metricResetAt?: Date | null;
+    /**
+     * For event-based feature entitlements that have a monthly period, whether that monthly reset is based on the calendar month or a billing cycle
+     * @type {string}
+     * @memberof FeatureEntitlement
+     */
+    monthReset?: FeatureEntitlementMonthResetEnum | null;
+    /**
+     * For usage-based pricing, the soft limit for overage charges or the next tier boundary
+     * @type {number}
+     * @memberof FeatureEntitlement
+     */
+    softLimit?: number | null;
+    /**
+     * If the company has a numeric entitlement for this feature, the current usage amount
+     * @type {number}
+     * @memberof FeatureEntitlement
+     */
+    usage?: number | null;
+    /**
+     *
+     * @type {EntitlementValueType}
+     * @memberof FeatureEntitlement
+     */
+    valueType: EntitlementValueType;
+}
+
+/**
+ * @export
+ */
+declare const FeatureEntitlementMetricPeriodEnum: {
+    readonly AllTime: "all_time";
+    readonly CurrentDay: "current_day";
+    readonly CurrentMonth: "current_month";
+    readonly CurrentWeek: "current_week";
+};
+
+declare type FeatureEntitlementMetricPeriodEnum = (typeof FeatureEntitlementMetricPeriodEnum)[keyof typeof FeatureEntitlementMetricPeriodEnum];
+
+/**
+ * @export
+ */
+declare const FeatureEntitlementMonthResetEnum: {
+    readonly FirstOfMonth: "first_of_month";
+    readonly BillingCycle: "billing_cycle";
+};
+
+declare type FeatureEntitlementMonthResetEnum = (typeof FeatureEntitlementMonthResetEnum)[keyof typeof FeatureEntitlementMonthResetEnum];
+
 /**
  *
  * @export
@@ -6413,6 +6617,49 @@ declare interface GenericPreviewObject {
     name: string;
 }
 
+/**
+ * Schematic API
+ * Schematic API
+ *
+ * The version of the OpenAPI document: 0.1
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface GenericPreviewObject
+ */
+declare interface GenericPreviewObject_2 {
+    /**
+     *
+     * @type {string}
+     * @memberof GenericPreviewObject
+     */
+    description?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof GenericPreviewObject
+     */
+    id: string;
+    /**
+     *
+     * @type {string}
+     * @memberof GenericPreviewObject
+     */
+    imageUrl?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof GenericPreviewObject
+     */
+    name: string;
+}
+
 /**
  *
  * @export
@@ -6648,6 +6895,19 @@ export declare type InvoicesProps = DesignProps_3 & {
     data?: InvoiceResponseData[];
 };
 
+export declare const LeadingLineHeightMap: Record<LeadingNameType, number>;
+
+export declare enum LeadingName {
+    None = "none",
+    Tight = "tight",
+    Snug = "snug",
+    Normal = "normal",
+    Relaxed = "relaxed",
+    Loose = "loose"
+}
+
+export declare type LeadingNameType = `${LeadingName}`;
+
 /**
  * Schematic API
  * Schematic API
@@ -7018,16 +7278,16 @@ declare interface PlanCreditGrantView {
     id: string;
     /**
      *
-     * @type {string}
+     * @type {GenericPreviewObject}
      * @memberof PlanCreditGrantView
      */
-    planId: string;
+    plan?: GenericPreviewObject;
     /**
      *
      * @type {string}
      * @memberof PlanCreditGrantView
      */
-    planName: string;
+    planId: string;
     /**
      *
      * @type {string}
@@ -7176,16 +7436,16 @@ declare interface PlanCreditGrantView_2 {
     id: string;
     /**
      *
-     * @type {string}
+     * @type {GenericPreviewObject}
      * @memberof PlanCreditGrantView
      */
-    planId: string;
+    plan?: GenericPreviewObject_2;
     /**
      *
      * @type {string}
      * @memberof PlanCreditGrantView
      */
-    planName: string;
+    planId: string;
     /**
      *
      * @type {string}
@@ -8681,7 +8941,7 @@ declare interface PublicPlansResponseData {
     showZeroPriceAsFree: boolean;
 }
 
-export declare const Quantity: ({ entitlements, updateQuantity, period, }: QuantityProps) => JSX.Element;
+export declare const Quantity: ({ entitlements, updateQuantity, period, tooltipPortal, }: QuantityProps) => JSX.Element;
 
 declare interface QuantityProps {
     isLoading: boolean;
@@ -8689,6 +8949,7 @@ declare interface QuantityProps {
     selectedPlan?: SelectedPlan;
     entitlements: UsageBasedEntitlement[];
     updateQuantity: (id: string, quantity: number) => void;
+    tooltipPortal?: HTMLElement | null;
 }
 
 declare interface RequestContext {
@@ -9320,10 +9581,17 @@ declare type RuleRuleTypeEnum = (typeof RuleRuleTypeEnum)[keyof typeof RuleRuleT
 
 export declare const SchematicEmbed: ({ id, accessToken }: EmbedProps) => JSX.Element;
 
+export declare const Selected: ({ isCurrent, isTrial, }: SelectedProps) => JSX.Element;
+
 declare type SelectedPlan = Plan_2 & {
     isSelected: boolean;
 };
 
+export declare interface SelectedProps {
+    isCurrent?: boolean;
+    isTrial?: boolean;
+}
+
 /**
  * Schematic API
  * Schematic API
@@ -9367,6 +9635,12 @@ declare interface SetupIntentResponseData {
     setupIntentClientSecret?: string | null;
 }
 
+declare type SharedEntitlementUsageProps = {
+    allocation: number;
+    usage: number;
+    quantity: number;
+};
+
 /**
  * Schematic API
  * Schematic API
@@ -9423,7 +9697,7 @@ portal?: HTMLElement | null;
 
 export declare type TextElementProps = DesignProps_8;
 
-export declare enum TextPropNames {
+export declare enum TextPropName {
     Font = "$font",
     Size = "$size",
     Weight = "$weight",
@@ -9432,7 +9706,7 @@ export declare enum TextPropNames {
     Align = "$align"
 }
 
-export declare type TextPropNameTypes = `${TextPropNames}`;
+export declare type TextPropNameType = `${TextPropName}`;
 
 export declare interface TextProps {
     display?: FontStyle;
@@ -9441,7 +9715,7 @@ export declare interface TextProps {
     $size?: ComponentProps["$fontSize"];
     $weight?: ComponentProps["$fontWeight"];
     $color?: ComponentProps["$color"];
-    $leading?: ComponentProps["$lineHeight"];
+    $leading?: LeadingNameType;
     $align?: ComponentProps["$textAlign"];
 }
 
@@ -9697,11 +9971,7 @@ declare interface UpdatePaymentMethodResponse {
     params: object;
 }
 
-declare interface UsageBasedEntitlement extends PlanEntitlementResponseData {
-    allocation: number;
-    usage: number;
-    quantity: number;
-}
+declare type UsageBasedEntitlement = PlanEntitlementResponseData & SharedEntitlementUsageProps;
 
 /**
  *