@schematichq/schematic-react 0.2.0-rc.2 → 0.2.0-rc.3

package/dist/schematic-react.d.ts

@@ -28,6 +28,56 @@ import { Stripe } from '@stripe/stripe-js';
 import { Substitute } from 'styled-components/dist/types';
 import { Traits } from '@schematichq/schematic-js';
 
+declare interface ApiResponse<T> {
+    raw: Response;
+    value(): Promise<T>;
+}
+
+/**
+ * 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.
+ */
+declare const BASE_PATH: string;
+
+/**
+ * This is the base class for all generated API classes.
+ */
+declare class BaseAPI {
+    protected configuration: Configuration;
+    private static readonly jsonRegex;
+    private middleware;
+    constructor(configuration?: Configuration);
+    withMiddleware<T extends BaseAPI>(this: T, ...middlewares: Middleware[]): T;
+    withPreMiddleware<T extends BaseAPI>(this: T, ...preMiddlewares: Array<Middleware["pre"]>): T;
+    withPostMiddleware<T extends BaseAPI>(this: T, ...postMiddlewares: Array<Middleware["post"]>): T;
+    /**
+     * Check if the given MIME is a JSON MIME.
+     * JSON MIME examples:
+     *   application/json
+     *   application/json; charset=UTF8
+     *   APPLICATION/JSON
+     *   application/vnd.company+json
+     * @param mime - MIME (Multipurpose Internet Mail Extensions)
+     * @return True if the given MIME is JSON, false otherwise.
+     */
+    protected isJsonMime(mime: string | null | undefined): boolean;
+    protected request(context: RequestOpts, initOverrides?: RequestInit | InitOverrideFunction): Promise<Response>;
+    private createFetchParams;
+    private fetchApi;
+    /**
+     * Create a shallow clone of `this` by constructing a new instance
+     * and then shallow cloning data members.
+     */
+    private clone;
+}
+
 declare type BaseSchematicProviderProps = Omit<SchematicJS.SchematicOptions, "client" | "publishableKey"> & {
     children: React.ReactNode;
 };
@@ -295,6 +345,55 @@ declare interface BillingProductForSubscriptionResponseData {
     updatedAt: Date;
 }
 
+/**
+ * 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.
+ */
+/**
+ * The created resource
+ * @export
+ * @interface BillingSubscriptionResponseData
+ */
+declare interface BillingSubscriptionResponseData {
+    /**
+     *
+     * @type {Date}
+     * @memberof BillingSubscriptionResponseData
+     */
+    expiredAt?: Date | null;
+    /**
+     *
+     * @type {string}
+     * @memberof BillingSubscriptionResponseData
+     */
+    externalId: string;
+    /**
+     *
+     * @type {number}
+     * @memberof BillingSubscriptionResponseData
+     */
+    id: number;
+    /**
+     *
+     * @type {Date}
+     * @memberof BillingSubscriptionResponseData
+     */
+    updatedAt: Date;
+}
+
+declare class BlobApiResponse {
+    raw: Response;
+    constructor(raw: Response);
+    value(): Promise<Blob>;
+}
+
 export declare const Box: IStyledComponentBase<"web", Substitute<DetailedHTMLProps<HTMLAttributes<HTMLDivElement>, HTMLDivElement>, ComponentProps>> & string;
 
 export declare type BoxProps = ComponentProps;
@@ -313,6 +412,8 @@ export declare type ButtonStyleTypes = "blue" | "white" | "red" | "black";
 
 export declare type ButtonVariantTypes = "solid" | "outline" | "ghost" | "link";
 
+declare function canConsumeForm(consumes: Consume[]): boolean;
+
 export declare const Card: ForwardRefExoticComponent<CardProps & RefAttributes<HTMLDivElement | null>>;
 
 export declare interface CardProps {
@@ -320,6 +421,90 @@ export declare interface CardProps {
     className?: 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 ChangeSubscriptionRequestBody
+ */
+declare interface ChangeSubscriptionRequestBody {
+    /**
+     *
+     * @type {string}
+     * @memberof ChangeSubscriptionRequestBody
+     */
+    newPlanId: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ChangeSubscriptionRequestBody
+     */
+    newPriceId: string;
+}
+
+/**
+ *
+ */
+declare class CheckoutApi extends runtime.BaseAPI {
+    /**
+     * Checkout
+     */
+    checkoutRaw(requestParameters: CheckoutRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CheckoutResponse>>;
+    /**
+     * Checkout
+     */
+    checkout(requestParameters: CheckoutRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CheckoutResponse>;
+    /**
+     * Hydrate component
+     */
+    hydrateComponentRaw(requestParameters: HydrateComponentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<HydrateComponentResponse>>;
+    /**
+     * Hydrate component
+     */
+    hydrateComponent(requestParameters: HydrateComponentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<HydrateComponentResponse>;
+}
+
+declare interface CheckoutRequest {
+    changeSubscriptionRequestBody: ChangeSubscriptionRequestBody;
+}
+
+/**
+ *
+ * @export
+ * @interface CheckoutResponse
+ */
+declare interface CheckoutResponse {
+    /**
+     *
+     * @type {BillingSubscriptionResponseData}
+     * @memberof CheckoutResponse
+     */
+    data: BillingSubscriptionResponseData;
+    /**
+     * Input parameters
+     * @type {object}
+     * @memberof CheckoutResponse
+     */
+    params: object;
+}
+
+declare const COLLECTION_FORMATS: {
+    csv: string;
+    ssv: string;
+    tsv: string;
+    pipes: string;
+};
+
 export declare const Column: ForwardRefExoticComponent<Omit<ColumnProps, "ref"> & RefAttributes<HTMLDivElement | null>>;
 
 export declare interface ColumnProps extends React.HTMLProps<HTMLDivElement> {
@@ -619,6 +804,12 @@ declare interface ComponentHydrateResponseData {
      * @memberof ComponentHydrateResponseData
      */
     subscription?: CompanySubscriptionResponseData;
+    /**
+     *
+     * @type {InvoiceResponseData}
+     * @memberof ComponentHydrateResponseData
+     */
+    upcomingInvoice?: InvoiceResponseData;
 }
 
 declare interface ComponentProps extends TransientCSSProperties {
@@ -688,6 +879,22 @@ declare interface ComponentResponseData {
     updatedAt: Date;
 }
 
+declare class Configuration {
+    private configuration;
+    constructor(configuration?: ConfigurationParameters);
+    set config(configuration: Configuration);
+    get basePath(): string;
+    get fetchApi(): FetchAPI | undefined;
+    get middleware(): Middleware[];
+    get queryParamsStringify(): (params: HTTPQuery) => string;
+    get username(): string | undefined;
+    get password(): string | undefined;
+    get apiKey(): ((name: string) => string | Promise<string>) | undefined;
+    get accessToken(): ((name?: string, scopes?: string[]) => string | Promise<string>) | undefined;
+    get headers(): HTTPHeaders | undefined;
+    get credentials(): RequestCredentials | undefined;
+}
+
 declare interface ConfigurationParameters {
     basePath?: string;
     fetchApi?: FetchAPI;
@@ -701,6 +908,10 @@ declare interface ConfigurationParameters {
     credentials?: RequestCredentials;
 }
 
+declare interface Consume {
+    contentType: string;
+}
+
 declare const _default: {
     alarm: number;
     "arrow-curved": number;
@@ -801,6 +1012,8 @@ declare const _default: {
     wind: number;
 };
 
+declare const DefaultConfig: Configuration;
+
 export declare const defaultSettings: EmbedSettings;
 
 export declare const defaultTheme: EmbedThemeSettings;
@@ -939,7 +1152,8 @@ declare interface ElementProps {
 export declare const EmbedContext: Context<EmbedContextProps>;
 
 export declare interface EmbedContextProps {
-    data: RecursivePartial<ComponentHydrateResponseData>;
+    api: CheckoutApi | null;
+    data: ComponentHydrateResponseData;
     nodes: SerializedNodeWithChildren[];
     settings: EmbedSettings;
     stripe: Promise<Stripe | null> | null;
@@ -1570,6 +1784,12 @@ declare type FeatureUsageResponseDataAllocationTypeEnum = (typeof FeatureUsageRe
 
 declare type FetchAPI = WindowOrWorkerGlobalScope["fetch"];
 
+declare class FetchError extends Error {
+    cause: Error;
+    name: "FetchError";
+    constructor(cause: Error, msg?: string);
+}
+
 declare interface FetchParams {
     url: string;
     init: RequestInit;
@@ -1671,14 +1891,49 @@ ref?: ((instance: HTMLDivElement | null) => void | DO_NOT_USE_OR_YOU_WILL_BE_FIR
 
 declare type FontStyle = keyof EmbedThemeSettings["typography"];
 
+declare type HTTPBody = Json | FormData | URLSearchParams;
+
 declare type HTTPHeaders = {
     [key: string]: string;
 };
 
+declare type HTTPMethod = "GET" | "POST" | "PUT" | "PATCH" | "DELETE" | "OPTIONS" | "HEAD";
+
 declare type HTTPQuery = {
     [key: string]: string | number | null | boolean | Array<string | number | null | boolean> | Set<string | number | null | boolean> | HTTPQuery;
 };
 
+declare type HTTPRequestInit = {
+    headers?: HTTPHeaders;
+    method: HTTPMethod;
+    credentials?: RequestCredentials;
+    body?: HTTPBody;
+};
+
+declare interface HydrateComponentRequest {
+    componentId: string;
+}
+
+/**
+ *
+ * @export
+ * @interface HydrateComponentResponse
+ */
+declare interface HydrateComponentResponse {
+    /**
+     *
+     * @type {ComponentHydrateResponseData}
+     * @memberof HydrateComponentResponse
+     */
+    data: ComponentHydrateResponseData;
+    /**
+     * Input parameters
+     * @type {object}
+     * @memberof HydrateComponentResponse
+     */
+    params: object;
+}
+
 export declare const Icon: ({ name, className, ...props }: IconProps) => JSX_2.Element;
 
 export declare type IconNameTypes = keyof typeof _default;
@@ -1700,6 +1955,11 @@ export declare const IncludedFeatures: ForwardRefExoticComponent<ElementProps &
 
 export declare type IncludedFeaturesProps = DesignProps_2;
 
+declare type InitOverrideFunction = (requestContext: {
+    init: HTTPRequestInit;
+    context: RequestOpts;
+}) => Promise<RequestInit>;
+
 /**
  * Schematic API
  * Schematic API
@@ -1813,8 +2073,19 @@ export declare const Invoices: ForwardRefExoticComponent<ElementProps & Recursiv
 
 export declare type InvoicesProps = DesignProps_6;
 
+declare type Json = any;
+
+declare class JSONApiResponse<T> {
+    raw: Response;
+    private transformer;
+    constructor(raw: Response, transformer?: ResponseTransformer<T>);
+    value(): Promise<T>;
+}
+
 export { Keys }
 
+declare function mapValues(data: any, fn: (item: any) => any): {};
+
 export declare const MeteredFeatures: ForwardRefExoticComponent<ElementProps & RecursivePartial<DesignProps_3> & HTMLAttributes<HTMLDivElement> & RefAttributes<HTMLDivElement | null>>;
 
 export declare type MeteredFeaturesProps = DesignProps_3;
@@ -1825,14 +2096,20 @@ declare interface Middleware {
     onError?(context: ErrorContext): Promise<Response | void>;
 }
 
-export declare const OverlayHeader: ({ children }: {
+declare type ModelPropertyNaming = "camelCase" | "snake_case" | "PascalCase" | "original";
+
+export declare const OverlayHeader: ({ children, onClose, }: {
     children: ReactNode;
+    onClose?: () => void;
 }) => JSX_2.Element;
 
-export declare const OverlaySideBar: ({ pricePeriod, setPricePeriod, setCheckoutStage, }: {
+export declare const OverlaySideBar: ({ pricePeriod, setPricePeriod, checkoutStage, setCheckoutStage, currentPlan, selectedPlan, }: {
     pricePeriod: "month" | "year";
     setPricePeriod: Dispatch<SetStateAction<"month" | "year">>;
+    checkoutStage: "plan" | "checkout";
     setCheckoutStage: Dispatch<SetStateAction<"plan" | "checkout">>;
+    currentPlan?: BillingPlan;
+    selectedPlan?: CompanyPlanDetailResponseData;
 }) => JSX_2.Element;
 
 export declare const OverlayWrapper: ({ children, size, }: {
@@ -2173,6 +2450,8 @@ export declare interface ProgressBarProps extends React.ComponentPropsWithoutRef
     barWidth?: string | number;
 }
 
+declare function querystring(params: HTTPQuery, prefix?: string): string;
+
 declare type RecursivePartial<T> = {
     [P in keyof T]?: T[P] extends (infer U)[] ? RecursivePartial<U>[] : T[P] extends object | undefined ? RecursivePartial<T[P]> : T[P];
 };
@@ -2183,6 +2462,20 @@ declare interface RequestContext {
     init: RequestInit;
 }
 
+declare interface RequestOpts {
+    path: string;
+    method: HTTPMethod;
+    headers: HTTPHeaders;
+    query?: HTTPQuery;
+    body?: HTTPBody;
+}
+
+declare class RequiredError extends Error {
+    field: string;
+    name: "RequiredError";
+    constructor(field: string, msg?: string);
+}
+
 declare interface ResponseContext {
     fetch: FetchAPI;
     url: string;
@@ -2190,6 +2483,16 @@ declare interface ResponseContext {
     response: Response;
 }
 
+declare class ResponseError extends Error {
+    response: Response;
+    name: "ResponseError";
+    constructor(response: Response, msg?: string);
+}
+
+declare interface ResponseTransformer<T> {
+    (json: any): T;
+}
+
 export declare const Root: ForwardRefExoticComponent<Omit<RootProps, "ref"> & RefAttributes<HTMLDivElement | null>>;
 
 export declare interface RootProps extends React.HTMLProps<HTMLDivElement> {
@@ -2496,6 +2799,45 @@ declare interface RuleDetailResponseData {
     value: boolean;
 }
 
+declare namespace runtime {
+    export {
+        querystring,
+        mapValues,
+        canConsumeForm,
+        BASE_PATH,
+        ConfigurationParameters,
+        Configuration,
+        DefaultConfig,
+        BaseAPI,
+        ResponseError,
+        FetchError,
+        RequiredError,
+        COLLECTION_FORMATS,
+        FetchAPI,
+        Json,
+        HTTPMethod,
+        HTTPHeaders,
+        HTTPQuery,
+        HTTPBody,
+        HTTPRequestInit,
+        ModelPropertyNaming,
+        InitOverrideFunction,
+        FetchParams,
+        RequestOpts,
+        Consume,
+        RequestContext,
+        ResponseContext,
+        ErrorContext,
+        Middleware,
+        ApiResponse,
+        ResponseTransformer,
+        JSONApiResponse,
+        VoidApiResponse,
+        BlobApiResponse,
+        TextApiResponse
+    }
+}
+
 export { Schematic }
 
 export { SchematicContext }
@@ -2570,6 +2912,12 @@ declare interface StripeEmbedInfo {
 declare const Text_2: IStyledComponentBase<"web", Substitute<DetailedHTMLProps<HTMLAttributes<HTMLSpanElement>, HTMLSpanElement>, TextProps>> & string;
 export { Text_2 as Text }
 
+declare class TextApiResponse {
+    raw: Response;
+    constructor(raw: Response);
+    value(): Promise<string>;
+}
+
 export declare interface TextProps extends ComponentProps {
     $align?: ComponentProps["$textAlign"];
     $font?: ComponentProps["$fontFamily"];
@@ -2620,4 +2968,10 @@ export declare const Viewport: ForwardRefExoticComponent<Omit<ViewportProps, "re
 export declare interface ViewportProps extends React.HTMLProps<HTMLDivElement> {
 }
 
+declare class VoidApiResponse {
+    raw: Response;
+    constructor(raw: Response);
+    value(): Promise<void>;
+}
+
 export { }