@schematichq/schematic-components 0.3.6 → 0.3.8

package/dist/schematic-components.d.ts

@@ -1,3 +1,4 @@
+import { Component } from 'react';
 import { Context } from 'react';
 import * as Craft from '@craftjs/core';
 import { DetailedHTMLProps } from 'react';
@@ -61,61 +62,6 @@ declare class BaseAPI {
     private clone;
 }
 
-/**
- * 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 BillingPlan
- */
-declare interface BillingPlan {
-    /**
-     *
-     * @type {string}
-     * @memberof BillingPlan
-     */
-    description?: string | null;
-    /**
-     *
-     * @type {string}
-     * @memberof BillingPlan
-     */
-    id: string;
-    /**
-     *
-     * @type {string}
-     * @memberof BillingPlan
-     */
-    imageUrl?: string | null;
-    /**
-     *
-     * @type {string}
-     * @memberof BillingPlan
-     */
-    name: string;
-    /**
-     *
-     * @type {string}
-     * @memberof BillingPlan
-     */
-    planPeriod?: string | null;
-    /**
-     *
-     * @type {number}
-     * @memberof BillingPlan
-     */
-    planPrice?: number | null;
-}
-
 /**
  * Schematic API
  * Schematic API
@@ -522,6 +468,8 @@ declare class CheckoutApi extends runtime.BaseAPI {
     updatePaymentMethod(requestParameters: UpdatePaymentMethodRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UpdatePaymentMethodResponse>;
 }
 
+export declare const CheckoutDialog: () => JSX_2.Element;
+
 declare interface CheckoutRequest {
     changeSubscriptionRequestBody: ChangeSubscriptionRequestBody;
 }
@@ -567,10 +515,10 @@ export declare interface ColumnProps extends React.HTMLProps<HTMLDivElement> {
 declare interface CompanyDetailResponseData {
     /**
      *
-     * @type {Array<BillingPlan>}
+     * @type {Array<CompanyPlanWithBillingSubView>}
      * @memberof CompanyDetailResponseData
      */
-    addOns: Array<BillingPlan>;
+    addOns: Array<CompanyPlanWithBillingSubView>;
     /**
      *
      * @type {Array<BillingSubscriptionResponseData>}
@@ -627,16 +575,16 @@ declare interface CompanyDetailResponseData {
     name: string;
     /**
      *
-     * @type {BillingPlan}
+     * @type {CompanyPlanWithBillingSubView}
      * @memberof CompanyDetailResponseData
      */
-    plan?: BillingPlan;
+    plan?: CompanyPlanWithBillingSubView;
     /**
      *
-     * @type {Array<PreviewObject>}
+     * @type {Array<GenericPreviewObject>}
      * @memberof CompanyDetailResponseData
      */
-    plans: Array<PreviewObject>;
+    plans: Array<GenericPreviewObject>;
     /**
      * A map of trait names to trait values
      * @type {object}
@@ -767,6 +715,67 @@ declare interface CompanyPlanDetailResponseData {
     yearlyPrice?: BillingPriceResponseData;
 }
 
+/**
+ * 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 CompanyPlanWithBillingSubView
+ */
+declare interface CompanyPlanWithBillingSubView {
+    /**
+     *
+     * @type {string}
+     * @memberof CompanyPlanWithBillingSubView
+     */
+    billingProductId?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof CompanyPlanWithBillingSubView
+     */
+    description?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof CompanyPlanWithBillingSubView
+     */
+    id: string;
+    /**
+     *
+     * @type {string}
+     * @memberof CompanyPlanWithBillingSubView
+     */
+    imageUrl?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof CompanyPlanWithBillingSubView
+     */
+    name: string;
+    /**
+     *
+     * @type {string}
+     * @memberof CompanyPlanWithBillingSubView
+     */
+    planPeriod?: string | null;
+    /**
+     *
+     * @type {number}
+     * @memberof CompanyPlanWithBillingSubView
+     */
+    planPrice?: number | null;
+}
+
 /**
  *
  * @export
@@ -1094,27 +1103,21 @@ export declare const defaultTheme: EmbedThemeSettings;
 declare interface DesignProps {
     header: {
         isVisible: boolean;
-        title: {
-            fontStyle: FontStyle;
-        };
-        description: {
-            isVisible: boolean;
-            fontStyle: FontStyle;
-        };
-        price: {
-            isVisible: boolean;
-            fontStyle: FontStyle;
-        };
+        fontStyle: FontStyle;
+        text: string;
     };
-    addOns: {
+    icons: {
         isVisible: boolean;
         fontStyle: FontStyle;
-        showLabel: boolean;
+        style: "light" | "dark";
     };
-    callToAction: {
+    entitlement: {
         isVisible: boolean;
-        buttonSize: "sm" | "md" | "lg";
-        buttonStyle: "primary" | "secondary" | "tertiary";
+        fontStyle: FontStyle;
+    };
+    usage: {
+        isVisible: boolean;
+        fontStyle: FontStyle;
     };
 }
 
@@ -1122,18 +1125,20 @@ declare interface DesignProps_2 {
     header: {
         isVisible: boolean;
         fontStyle: FontStyle;
-        text: string;
     };
-    icons: {
+    date: {
         isVisible: boolean;
         fontStyle: FontStyle;
-        style: "light" | "dark";
     };
-    entitlement: {
+    amount: {
         isVisible: boolean;
         fontStyle: FontStyle;
     };
-    usage: {
+    limit: {
+        isVisible: boolean;
+        number: number;
+    };
+    collapse: {
         isVisible: boolean;
         fontStyle: FontStyle;
     };
@@ -1159,34 +1164,43 @@ declare interface DesignProps_3 {
         isVisible: boolean;
         fontStyle: FontStyle;
     };
-    visibleFeatures: string[];
 }
 
 declare interface DesignProps_4 {
     header: {
         isVisible: boolean;
         fontStyle: FontStyle;
-        prefix: string;
     };
-    price: {
-        isVisible: boolean;
-        fontStyle: FontStyle;
-    };
-    contractEndDate: {
-        isVisible: boolean;
-        fontStyle: FontStyle;
-        prefix: string;
+    functions: {
+        allowEdit: boolean;
+        showExpiration: boolean;
     };
 }
 
 declare interface DesignProps_5 {
     header: {
+        isVisible: boolean;
+        title: {
+            fontStyle: FontStyle;
+        };
+        description: {
+            isVisible: boolean;
+            fontStyle: FontStyle;
+        };
+        price: {
+            isVisible: boolean;
+            fontStyle: FontStyle;
+        };
+    };
+    addOns: {
         isVisible: boolean;
         fontStyle: FontStyle;
+        showLabel: boolean;
     };
-    functions: {
-        allowEdit: boolean;
-        showExpiration: boolean;
+    callToAction: {
+        isVisible: boolean;
+        buttonSize: "sm" | "md" | "lg";
+        buttonStyle: "primary" | "secondary" | "tertiary";
     };
 }
 
@@ -1194,22 +1208,16 @@ declare interface DesignProps_6 {
     header: {
         isVisible: boolean;
         fontStyle: FontStyle;
+        prefix: string;
     };
-    date: {
-        isVisible: boolean;
-        fontStyle: FontStyle;
-    };
-    amount: {
+    price: {
         isVisible: boolean;
         fontStyle: FontStyle;
     };
-    limit: {
-        isVisible: boolean;
-        number: number;
-    };
-    collapse: {
+    contractEndDate: {
         isVisible: boolean;
         fontStyle: FontStyle;
+        prefix: string;
     };
 }
 
@@ -1224,6 +1232,12 @@ declare interface ElementProps {
     style?: React.CSSProperties;
 }
 
+export declare const EmbedButton: IStyledComponentBase<"web", Substitute<ButtonProps, {
+$size?: "sm" | "md" | "lg";
+$color?: "primary" | "secondary" | "tertiary";
+$variant?: "outline" | "filled";
+}>> & string & Omit<({ color, size, variant, disabled, isLoading, children, ...props }: ButtonProps) => JSX_2.Element, keyof Component<any, {}, any>>;
+
 export declare const EmbedContext: Context<EmbedContextProps>;
 
 export declare interface EmbedContextProps {
@@ -1232,6 +1246,7 @@ export declare interface EmbedContextProps {
     nodes: SerializedNodeWithChildren[];
     settings: EmbedSettings;
     layout: EmbedLayout;
+    mode: EmbedMode;
     error?: Error;
     isPending: boolean;
     hydrate: () => void;
@@ -1242,19 +1257,22 @@ export declare interface EmbedContextProps {
 
 export declare type EmbedLayout = "portal" | "checkout" | "payment" | "success" | "disabled";
 
+export declare type EmbedMode = "edit" | "view";
+
 export declare interface EmbedProps {
     accessToken?: string;
     id?: string;
     apiConfig?: ConfigurationParameters;
 }
 
-export declare const EmbedProvider: ({ id, accessToken, apiConfig, children, }: EmbedProviderProps) => JSX_2.Element;
+export declare const EmbedProvider: ({ id, accessToken, apiConfig, children, mode, }: EmbedProviderProps) => JSX_2.Element;
 
 export declare interface EmbedProviderProps {
     id?: string;
     accessToken?: string;
     apiConfig?: ConfigurationParameters;
     children?: React.ReactNode;
+    mode?: EmbedMode;
 }
 
 export declare type EmbedSettings = {
@@ -1952,6 +1970,49 @@ ref?: ((instance: HTMLDivElement | null) => void | DO_NOT_USE_OR_YOU_WILL_BE_FIR
 
 export declare type FontStyle = keyof EmbedThemeSettings["typography"];
 
+/**
+ * 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 {
+    /**
+     *
+     * @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;
+}
+
 declare interface GetSetupIntentRequest {
     componentId: string;
 }
@@ -2036,9 +2097,9 @@ export declare interface IconRoundProps extends React.HTMLAttributes<HTMLElement
     colors?: [string, string];
 }
 
-export declare const IncludedFeatures: ForwardRefExoticComponent<ElementProps & RecursivePartial<DesignProps_2> & HTMLAttributes<HTMLDivElement> & RefAttributes<HTMLDivElement | null>>;
+export declare const IncludedFeatures: ForwardRefExoticComponent<ElementProps & RecursivePartial<DesignProps> & HTMLAttributes<HTMLDivElement> & RefAttributes<HTMLDivElement | null>>;
 
-export declare type IncludedFeaturesProps = DesignProps_2;
+export declare type IncludedFeaturesProps = DesignProps;
 
 declare type InitOverrideFunction = (requestContext: {
     init: HTTPRequestInit;
@@ -2166,11 +2227,11 @@ declare interface InvoiceResponseData {
     url?: string | null;
 }
 
-export declare const Invoices: ForwardRefExoticComponent<ElementProps & DesignProps_6 & {
+export declare const Invoices: ForwardRefExoticComponent<ElementProps & DesignProps_2 & {
 data?: ListInvoicesResponse["data"];
 } & HTMLAttributes<HTMLDivElement> & RefAttributes<HTMLDivElement | null>>;
 
-export declare type InvoicesProps = DesignProps_6 & {
+export declare type InvoicesProps = DesignProps_2 & {
     data?: ListInvoicesResponse["data"];
 };
 
@@ -2283,11 +2344,11 @@ declare interface PaymentFormProps {
     onConfirm?: (paymentMethodId: string) => void;
 }
 
-export declare const PaymentMethod: ForwardRefExoticComponent<ElementProps & RecursivePartial<DesignProps_5> & HTMLAttributes<HTMLDivElement> & {
+export declare const PaymentMethod: ForwardRefExoticComponent<ElementProps & RecursivePartial<DesignProps_4> & HTMLAttributes<HTMLDivElement> & {
 portal?: HTMLElement | null;
 } & RefAttributes<HTMLDivElement | null>>;
 
-export declare type PaymentMethodProps = DesignProps_5;
+export declare type PaymentMethodProps = DesignProps_4;
 
 /**
  * Schematic API
@@ -2514,11 +2575,11 @@ declare interface PlanEntitlementResponseData {
     valueType: string;
 }
 
-export declare const PlanManager: ForwardRefExoticComponent<ElementProps & RecursivePartial<DesignProps> & HTMLAttributes<HTMLDivElement> & {
+export declare const PlanManager: ForwardRefExoticComponent<ElementProps & RecursivePartial<DesignProps_5> & HTMLAttributes<HTMLDivElement> & {
 portal?: HTMLElement | null;
 } & RefAttributes<HTMLDivElement | null>>;
 
-export declare type PlanManagerProps = DesignProps;
+export declare type PlanManagerProps = DesignProps_5;
 
 /**
  * Schematic API
@@ -3170,6 +3231,8 @@ declare interface StripeEmbedInfo {
     setupIntentClientSecret?: string | null;
 }
 
+export declare const StyledCard: IStyledComponentBase<"web", FastOmit<DetailedHTMLProps<HTMLAttributes<HTMLDivElement>, HTMLDivElement>, never>> & string;
+
 declare const Text_2: IStyledComponentBase<"web", Substitute<FastOmit<Substitute<DetailedHTMLProps<HTMLAttributes<HTMLSpanElement>, HTMLSpanElement>, Omit<DetailedHTMLProps<HTMLAttributes<HTMLSpanElement>, HTMLSpanElement>, "ref"> & {
 ref?: ((instance: HTMLSpanElement | null) => void | DO_NOT_USE_OR_YOU_WILL_BE_FIRED_CALLBACK_REF_RETURN_VALUES[keyof DO_NOT_USE_OR_YOU_WILL_BE_FIRED_CALLBACK_REF_RETURN_VALUES]) | RefObject<HTMLSpanElement> | null | undefined;
 }>, never>, TextProps>> & string;
@@ -3190,6 +3253,13 @@ export declare interface TextProps extends ComponentProps {
     $lineHeight?: ComponentProps["$lineHeight"];
 }
 
+export declare const Tooltip: ({ label, description }: TooltipProps) => JSX_2.Element;
+
+declare interface TooltipProps {
+    label: string;
+    description: string;
+}
+
 declare type TransientCSSProperties = {
     [Property in keyof React.CSSProperties as `$${string & Property}`]: React.CSSProperties[Property];
 };
@@ -3201,9 +3271,9 @@ export declare interface TypographySettings {
     color: string;
 }
 
-export declare const UpcomingBill: ForwardRefExoticComponent<ElementProps & RecursivePartial<DesignProps_4> & HTMLAttributes<HTMLDivElement> & RefAttributes<HTMLDivElement | null>>;
+export declare const UpcomingBill: ForwardRefExoticComponent<ElementProps & RecursivePartial<DesignProps_6> & HTMLAttributes<HTMLDivElement> & RefAttributes<HTMLDivElement | null>>;
 
-export declare type UpcomingBillProps = DesignProps_4;
+export declare type UpcomingBillProps = DesignProps_6;
 
 declare interface UpdatePaymentMethodRequest {
     updatePaymentMethodRequestBody: UpdatePaymentMethodRequestBody;