@capitalos/react 0.2.1-rc2 → 1.0.0-rc.1

package/dist/_tsup-dts-rollup.d.mts

@@ -0,0 +1,713 @@
+import { IFrameComponent } from 'iframe-resizer';
+import { IFrameMessageData } from 'iframe-resizer';
+import { IFrameOptions } from 'iframe-resizer';
+import { IFrameResizedData } from 'iframe-resizer';
+import { IFrameScrollData } from 'iframe-resizer';
+import { default as React_2 } from 'react';
+import { ReactNode } from 'react';
+import { z } from 'zod';
+import * as z_2 from 'zod';
+
+export declare type Account = {
+    status: AccountStatus;
+};
+
+/**
+ * Renders the CapitalOS Account Actions experience.
+ */
+export declare function AccountActions(props: AccountActionsProps): JSX.Element;
+
+export declare type AccountActionsProps = CommonProps;
+
+/**
+ * Renders the CapitalOS Account Details experience.
+ */
+export declare function AccountDetails(props: AccountDetailsProps): JSX.Element;
+
+export declare type AccountDetailsProps = CommonProps;
+
+export declare type AccountStatus = z_2.infer<typeof accountStatusSchema>;
+
+declare const accountStatusSchema: z_2.ZodEnum<["eligible", "ineligible", "engaged", "onboarding", "approved", "processing", "pending", "declined", "closed", "waiting"]>;
+
+declare type AllowedExitPoints = {
+    welcome: 'application' | 'activation';
+    application: 'application' | 'activation';
+};
+
+/** @deprecated Use {@link CardsApp} instead */
+export declare const App: typeof CardsApp;
+
+/**
+ * Renders the CapitalOS Bill Payment Dashboard experience.
+ */
+export declare function BillPayApp(props: BillPayAppProps): JSX.Element;
+
+export declare type BillPayAppProps = CommonProps;
+
+/**
+ * The internal component that handles all the heavy lifting of connecting to the iframe and rendering the app.
+ * all user facing components are basically  a syntactic sugar on top of this.
+ */
+export declare function CapitalOS<T extends RenderingContext_2>(props: CapitalOsProps<T>): JSX.Element;
+
+/**
+ * Base class for all SDK errors
+ */
+export declare class CapitalOSError extends Error {
+    code: ErrorCode;
+    constructor({ message, code }: {
+        message: string;
+        code: ErrorCode;
+    });
+}
+
+declare type CapitalOsProps<T extends RenderingContext_2> = CommonProps & {
+    renderingContext: T;
+    methods?: Partial<IframeConnectionMethods>;
+};
+
+export declare type CardApiDto = z_2.infer<typeof cardApiDtoSchema>;
+
+declare const cardApiDtoSchema: z_2.ZodObject<{
+    accountUserId: z_2.ZodNullable<z_2.ZodString>;
+    status: z_2.ZodEnum<["active", "inactive", "canceled", "frozen"]>;
+    id: z_2.ZodString;
+    last4: z_2.ZodString;
+    platformId: z_2.ZodString;
+    cardholderFirstName: z_2.ZodString;
+    cardholderLastName: z_2.ZodString;
+    cardholderPhoneNumber: z_2.ZodEffects<z_2.ZodString, string, string>;
+    nickname: z_2.ZodOptional<z_2.ZodNullable<z_2.ZodString>>;
+    spend: z_2.ZodObject<{
+        daily: z_2.ZodObject<{
+            limit: z_2.ZodOptional<z_2.ZodNumber>;
+            amount: z_2.ZodNumber;
+        }, "strip", z_2.ZodTypeAny, {
+            amount: number;
+            limit?: number | undefined;
+        }, {
+            amount: number;
+            limit?: number | undefined;
+        }>;
+        weekly: z_2.ZodObject<{
+            limit: z_2.ZodOptional<z_2.ZodNumber>;
+            amount: z_2.ZodNumber;
+        }, "strip", z_2.ZodTypeAny, {
+            amount: number;
+            limit?: number | undefined;
+        }, {
+            amount: number;
+            limit?: number | undefined;
+        }>;
+        monthly: z_2.ZodObject<{
+            limit: z_2.ZodOptional<z_2.ZodNumber>;
+            amount: z_2.ZodNumber;
+        }, "strip", z_2.ZodTypeAny, {
+            amount: number;
+            limit?: number | undefined;
+        }, {
+            amount: number;
+            limit?: number | undefined;
+        }>;
+        lifetime: z_2.ZodObject<{
+            limit: z_2.ZodOptional<z_2.ZodNumber>;
+            amount: z_2.ZodNumber;
+        }, "strip", z_2.ZodTypeAny, {
+            amount: number;
+            limit?: number | undefined;
+        }, {
+            amount: number;
+            limit?: number | undefined;
+        }>;
+    }, "strip", z_2.ZodTypeAny, {
+        daily: {
+            amount: number;
+            limit?: number | undefined;
+        };
+        weekly: {
+            amount: number;
+            limit?: number | undefined;
+        };
+        monthly: {
+            amount: number;
+            limit?: number | undefined;
+        };
+        lifetime: {
+            amount: number;
+            limit?: number | undefined;
+        };
+    }, {
+        daily: {
+            amount: number;
+            limit?: number | undefined;
+        };
+        weekly: {
+            amount: number;
+            limit?: number | undefined;
+        };
+        monthly: {
+            amount: number;
+            limit?: number | undefined;
+        };
+        lifetime: {
+            amount: number;
+            limit?: number | undefined;
+        };
+    }>;
+    allowedSpendCategories: z_2.ZodArray<z_2.ZodEnum<["airlines", "carRental", "carService", "education", "electronics", "gasPump", "gasStation", "generalMerchandise", "government", "hardwareAndConstruction", "insurance", "legal", "lodging", "medical", "other", "parking", "phoneAndInternet", "professionalServices", "recreationAndEntertainment", "restaurants", "shipping", "software", "taxisAndRideshare", "transportation", "travelMisc", "utilities"]>, "many">;
+    allowedMerchants: z_2.ZodArray<z_2.ZodObject<{
+        id: z_2.ZodUnion<[z_2.ZodString, z_2.ZodString]>;
+        name: z_2.ZodString;
+        logoUrl: z_2.ZodNullable<z_2.ZodString>;
+    }, "strip", z_2.ZodTypeAny, {
+        id: string;
+        name: string;
+        logoUrl: string | null;
+    }, {
+        id: string;
+        name: string;
+        logoUrl: string | null;
+    }>, "many">;
+    physicalCard: z_2.ZodNullable<z_2.ZodObject<{
+        status: z_2.ZodEnum<["active", "disabled", "canceled"]>;
+        shipment: z_2.ZodObject<{
+            address: z_2.ZodObject<{
+                addressLine1: z_2.ZodString;
+                addressLine2: z_2.ZodOptional<z_2.ZodNullable<z_2.ZodString>>;
+                city: z_2.ZodString;
+                state: z_2.ZodEffects<z_2.ZodString, string, string>;
+                zipcode: z_2.ZodString;
+            }, "strip", z_2.ZodTypeAny, {
+                addressLine1: string;
+                city: string;
+                state: string;
+                zipcode: string;
+                addressLine2?: string | null | undefined;
+            }, {
+                addressLine1: string;
+                city: string;
+                state: string;
+                zipcode: string;
+                addressLine2?: string | null | undefined;
+            }>;
+            method: z_2.ZodEnum<["usps", "fedexPriorityOvernight", "fedexTwoDay"]>;
+            recipientName: z_2.ZodString;
+            returnReason: z_2.ZodNullable<z_2.ZodString>;
+            shippedAt: z_2.ZodNullable<z_2.ZodString>;
+            status: z_2.ZodEnum<["canceled", "pending", "rejected", "returned", "shipped"]>;
+            trackingNumber: z_2.ZodNullable<z_2.ZodString>;
+            trackingUrl: z_2.ZodNullable<z_2.ZodString>;
+        }, "strip", z_2.ZodTypeAny, {
+            status: "pending" | "canceled" | "rejected" | "returned" | "shipped";
+            method: "usps" | "fedexPriorityOvernight" | "fedexTwoDay";
+            address: {
+                addressLine1: string;
+                city: string;
+                state: string;
+                zipcode: string;
+                addressLine2?: string | null | undefined;
+            };
+            recipientName: string;
+            returnReason: string | null;
+            shippedAt: string | null;
+            trackingNumber: string | null;
+            trackingUrl: string | null;
+        }, {
+            status: "pending" | "canceled" | "rejected" | "returned" | "shipped";
+            method: "usps" | "fedexPriorityOvernight" | "fedexTwoDay";
+            address: {
+                addressLine1: string;
+                city: string;
+                state: string;
+                zipcode: string;
+                addressLine2?: string | null | undefined;
+            };
+            recipientName: string;
+            returnReason: string | null;
+            shippedAt: string | null;
+            trackingNumber: string | null;
+            trackingUrl: string | null;
+        }>;
+        id: z_2.ZodOptional<z_2.ZodNullable<z_2.ZodString>>;
+    }, "strip", z_2.ZodTypeAny, {
+        status: "active" | "canceled" | "disabled";
+        shipment: {
+            status: "pending" | "canceled" | "rejected" | "returned" | "shipped";
+            method: "usps" | "fedexPriorityOvernight" | "fedexTwoDay";
+            address: {
+                addressLine1: string;
+                city: string;
+                state: string;
+                zipcode: string;
+                addressLine2?: string | null | undefined;
+            };
+            recipientName: string;
+            returnReason: string | null;
+            shippedAt: string | null;
+            trackingNumber: string | null;
+            trackingUrl: string | null;
+        };
+        id?: string | null | undefined;
+    }, {
+        status: "active" | "canceled" | "disabled";
+        shipment: {
+            status: "pending" | "canceled" | "rejected" | "returned" | "shipped";
+            method: "usps" | "fedexPriorityOvernight" | "fedexTwoDay";
+            address: {
+                addressLine1: string;
+                city: string;
+                state: string;
+                zipcode: string;
+                addressLine2?: string | null | undefined;
+            };
+            recipientName: string;
+            returnReason: string | null;
+            shippedAt: string | null;
+            trackingNumber: string | null;
+            trackingUrl: string | null;
+        };
+        id?: string | null | undefined;
+    }>>;
+}, "strip", z_2.ZodTypeAny, {
+    status: "active" | "inactive" | "canceled" | "frozen";
+    id: string;
+    platformId: string;
+    accountUserId: string | null;
+    last4: string;
+    cardholderFirstName: string;
+    cardholderLastName: string;
+    cardholderPhoneNumber: string;
+    spend: {
+        daily: {
+            amount: number;
+            limit?: number | undefined;
+        };
+        weekly: {
+            amount: number;
+            limit?: number | undefined;
+        };
+        monthly: {
+            amount: number;
+            limit?: number | undefined;
+        };
+        lifetime: {
+            amount: number;
+            limit?: number | undefined;
+        };
+    };
+    allowedSpendCategories: ("airlines" | "carRental" | "carService" | "education" | "electronics" | "gasPump" | "gasStation" | "generalMerchandise" | "government" | "hardwareAndConstruction" | "insurance" | "legal" | "lodging" | "medical" | "other" | "parking" | "phoneAndInternet" | "professionalServices" | "recreationAndEntertainment" | "restaurants" | "shipping" | "software" | "taxisAndRideshare" | "transportation" | "travelMisc" | "utilities")[];
+    allowedMerchants: {
+        id: string;
+        name: string;
+        logoUrl: string | null;
+    }[];
+    physicalCard: {
+        status: "active" | "canceled" | "disabled";
+        shipment: {
+            status: "pending" | "canceled" | "rejected" | "returned" | "shipped";
+            method: "usps" | "fedexPriorityOvernight" | "fedexTwoDay";
+            address: {
+                addressLine1: string;
+                city: string;
+                state: string;
+                zipcode: string;
+                addressLine2?: string | null | undefined;
+            };
+            recipientName: string;
+            returnReason: string | null;
+            shippedAt: string | null;
+            trackingNumber: string | null;
+            trackingUrl: string | null;
+        };
+        id?: string | null | undefined;
+    } | null;
+    nickname?: string | null | undefined;
+}, {
+    status: "active" | "inactive" | "canceled" | "frozen";
+    id: string;
+    platformId: string;
+    accountUserId: string | null;
+    last4: string;
+    cardholderFirstName: string;
+    cardholderLastName: string;
+    cardholderPhoneNumber: string;
+    spend: {
+        daily: {
+            amount: number;
+            limit?: number | undefined;
+        };
+        weekly: {
+            amount: number;
+            limit?: number | undefined;
+        };
+        monthly: {
+            amount: number;
+            limit?: number | undefined;
+        };
+        lifetime: {
+            amount: number;
+            limit?: number | undefined;
+        };
+    };
+    allowedSpendCategories: ("airlines" | "carRental" | "carService" | "education" | "electronics" | "gasPump" | "gasStation" | "generalMerchandise" | "government" | "hardwareAndConstruction" | "insurance" | "legal" | "lodging" | "medical" | "other" | "parking" | "phoneAndInternet" | "professionalServices" | "recreationAndEntertainment" | "restaurants" | "shipping" | "software" | "taxisAndRideshare" | "transportation" | "travelMisc" | "utilities")[];
+    allowedMerchants: {
+        id: string;
+        name: string;
+        logoUrl: string | null;
+    }[];
+    physicalCard: {
+        status: "active" | "canceled" | "disabled";
+        shipment: {
+            status: "pending" | "canceled" | "rejected" | "returned" | "shipped";
+            method: "usps" | "fedexPriorityOvernight" | "fedexTwoDay";
+            address: {
+                addressLine1: string;
+                city: string;
+                state: string;
+                zipcode: string;
+                addressLine2?: string | null | undefined;
+            };
+            recipientName: string;
+            returnReason: string | null;
+            shippedAt: string | null;
+            trackingNumber: string | null;
+            trackingUrl: string | null;
+        };
+        id?: string | null | undefined;
+    } | null;
+    nickname?: string | null | undefined;
+}>;
+
+/**
+ * Renders the CapitalOS Manage Card experience.
+ */
+export declare function CardDetails(props: CardDetailsProps): JSX.Element;
+
+export declare type CardDetailsProps = CommonProps & {
+    /**
+     * The ID of the card to manage.
+     */
+    cardId: string;
+    cardOnly?: boolean | undefined;
+};
+
+/**
+ * Renders the CapitalOS CardsApp.
+ */
+export declare function CardsApp(props: CommonProps): JSX.Element;
+
+export declare type CommonProps = {
+    /**
+     * The token provided by initiate-login.
+     */
+    token: string;
+    /**
+     * Optional CSS class name for the component.
+     */
+    className?: string;
+    /**
+     * Optional flag indicating whether to log events to the console.
+     */
+    enableLogging?: boolean;
+    /**
+     * Optional callback for when the app encounters an error.
+     */
+    onError?: (error: Error) => void;
+    /**
+     * Optional component to render while the app is loading.
+     */
+    loadingComponent?: ReactNode;
+    /**
+     * Optional theme to apply to the app or component.
+     */
+    theme?: 'light' | 'dark' | 'system';
+};
+
+export declare function decodeToken(token: string): any;
+
+/**
+ * Renders the CapitalOS Dispute Transaction experience.
+ */
+export declare function DisputeTransaction({ transactionId, onDone, onCancel, ...restOfProps }: DisputeTransactionProps): JSX.Element;
+
+export declare type DisputeTransactionProps = CommonProps & {
+    /**
+     * The ID of the transaction to dispute.
+     */
+    transactionId: string;
+    /**
+     * Callback to invoke when the dispute was successfully submitted.
+     */
+    onDone: () => void;
+    /**
+     * Callback to invoke when the user cancels the dispute submission.
+     */
+    onCancel: () => void;
+};
+
+/**
+ * Encodes the rendering context as base64 and then URI encodes it.
+ */
+export declare function encodeRenderingContext<T>(renderingContext: NonNullable<T>): string;
+
+export declare type EntryPoint = RenderingContext_3['entryPoint'];
+
+export declare const ErrorCode: {
+    readonly unauthorized: "unauthorized";
+    readonly invalid_account_status: "invalid_account_status";
+    readonly unsupported_entry_point: "unsupported_entry_point";
+};
+
+export declare type ErrorCode = (typeof ErrorCode)[keyof typeof ErrorCode];
+
+export declare type IframeConnectionMethods = {
+    onLoad: () => void;
+    onError: (error: RawErrorDetails) => void;
+    createCard?: {
+        onDone?: () => void;
+        onCancel?: () => void;
+    };
+    createDispute?: {
+        onDone?: () => void;
+        onCancel?: () => void;
+    };
+    onboarding?: {
+        onDone?: (account: Account) => void;
+    };
+};
+
+export declare const IframeResizer: React_2.ForwardRefExoticComponent<Omit<IFrameOptions, "closedCallback" | "scrollCallback" | "resizedCallback" | "messageCallback" | "initCallback"> & {
+    onClosed?(iframeId: string): void;
+    onInit?(iframe: IFrameComponent): void;
+    onMessage?(data: IFrameMessageData): void;
+    onResized?(data: IFrameResizedData): void;
+    onScroll?(data: IFrameScrollData): boolean;
+} & React_2.IframeHTMLAttributes<HTMLIFrameElement> & React_2.RefAttributes<HTMLIFrameElement>>;
+
+/**
+ * Renders the CapitalOS Insights Dashboard experience
+ */
+export declare function InsightsDashboard(props: InsightsDashboardProps): JSX.Element;
+
+export declare type InsightsDashboardProps = CommonProps;
+
+/**
+ * Renders a specific CapitalOS Insights Widget
+ */
+export declare function InsightsWidget(props: InsightsWidgetProps): JSX.Element;
+
+export declare type InsightsWidgetProps = CommonProps & {
+    /**
+     * The specific widget to render.
+     */
+    widget: 'cards-by-month' | 'top-spenders';
+};
+
+/**
+ * Represents an error that occurs when an invalid token is encountered.
+ */
+export declare class InvalidTokenError extends CapitalOSError {
+    constructor();
+}
+
+/**
+ * Renders the CapitalOS Issue Card experience.
+ */
+export declare function IssueCard({ cardholder, onDone, onCancel, ...restOfProps }: IssueCardProps): JSX.Element;
+
+export declare type IssueCardDefaultValues = z.infer<typeof issueCardDefaultValuesSchema>;
+
+declare const issueCardDefaultValuesSchema: z.ZodUnion<[z.ZodObject<{
+    firstName: z.ZodString;
+    lastName: z.ZodString;
+    phone: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    firstName: string;
+    lastName: string;
+    phone: string;
+}, {
+    firstName: string;
+    lastName: string;
+    phone: string;
+}>, z.ZodObject<{
+    userId: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    userId: string;
+}, {
+    userId: string;
+}>]>;
+
+export declare type IssueCardProps = CommonProps & {
+    /**
+     * Default values to prefill the form with.
+     *
+     * Either provide a userId, in which case the default values will be taken from that user's profile, or provide the cardholder's details directly.
+     */
+    cardholder?: IssueCardDefaultValues;
+    /**
+     * Callback to invoke when the card was created successfully.
+     */
+    onDone: () => void;
+    /**
+     * Callback to invoke when the card creation was cancelled by the user.
+     */
+    onCancel: () => void;
+};
+
+export declare function Onboarding<T extends OnboardingEntryPoint>({ onDone, entryPoint: onboardingEntryPoint, exitPoint: onboardingExitPoint, ...restOfProps }: OnboardingProps<T>): JSX.Element;
+
+declare type OnboardingEntryPoint = keyof AllowedExitPoints;
+
+declare type OnboardingProps<T extends keyof AllowedExitPoints> = CommonProps & {
+    entryPoint?: T;
+    exitPoint?: AllowedExitPoints[T];
+    onDone: (account: Account) => void;
+};
+
+/**
+ * An error type providing a reason code and message.
+ * Penpal only passes plain objects, so this does not inherit from Error.
+ */
+export declare type RawErrorDetails = {
+    code: ErrorCode;
+    message: string;
+};
+
+declare type RenderingContext_2 = {
+    entryPoint?: EntryPoint;
+    referer?: string;
+};
+
+declare type RenderingContext_3 = z.infer<typeof renderingContextSchema>;
+
+declare const renderingContextSchema: z.ZodIntersection<z.ZodDiscriminatedUnion<"entryPoint", [z.ZodObject<{
+    entryPoint: z.ZodLiteral<"createCard">;
+    cardholder: z.ZodOptional<z.ZodNullable<z.ZodUnion<[z.ZodObject<{
+        firstName: z.ZodString;
+        lastName: z.ZodString;
+        phone: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        firstName: string;
+        lastName: string;
+        phone: string;
+    }, {
+        firstName: string;
+        lastName: string;
+        phone: string;
+    }>, z.ZodObject<{
+        userId: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        userId: string;
+    }, {
+        userId: string;
+    }>]>>>;
+}, "strip", z.ZodTypeAny, {
+    entryPoint: "createCard";
+    cardholder?: {
+        firstName: string;
+        lastName: string;
+        phone: string;
+    } | {
+        userId: string;
+    } | null | undefined;
+}, {
+    entryPoint: "createCard";
+    cardholder?: {
+        firstName: string;
+        lastName: string;
+        phone: string;
+    } | {
+        userId: string;
+    } | null | undefined;
+}>, z.ZodObject<{
+    entryPoint: z.ZodLiteral<"createDispute">;
+    transactionId: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    entryPoint: "createDispute";
+    transactionId: string;
+}, {
+    entryPoint: "createDispute";
+    transactionId: string;
+}>, z.ZodObject<{
+    entryPoint: z.ZodLiteral<"billPayApp">;
+}, "strip", z.ZodTypeAny, {
+    entryPoint: "billPayApp";
+}, {
+    entryPoint: "billPayApp";
+}>, z.ZodObject<{
+    entryPoint: z.ZodLiteral<"cardDetails">;
+    cardId: z.ZodString;
+    cardOnly: z.ZodOptional<z.ZodBoolean>;
+}, "strip", z.ZodTypeAny, {
+    cardId: string;
+    entryPoint: "cardDetails";
+    cardOnly?: boolean | undefined;
+}, {
+    cardId: string;
+    entryPoint: "cardDetails";
+    cardOnly?: boolean | undefined;
+}>, z.ZodObject<{
+    entryPoint: z.ZodLiteral<"accountDetails">;
+}, "strip", z.ZodTypeAny, {
+    entryPoint: "accountDetails";
+}, {
+    entryPoint: "accountDetails";
+}>, z.ZodObject<{
+    entryPoint: z.ZodLiteral<"accountActions">;
+}, "strip", z.ZodTypeAny, {
+    entryPoint: "accountActions";
+}, {
+    entryPoint: "accountActions";
+}>, z.ZodObject<{
+    entryPoint: z.ZodLiteral<"insightsDashboard">;
+}, "strip", z.ZodTypeAny, {
+    entryPoint: "insightsDashboard";
+}, {
+    entryPoint: "insightsDashboard";
+}>, z.ZodObject<{
+    entryPoint: z.ZodLiteral<"insightsWidget">;
+    widget: z.ZodEnum<["cards-by-month", "top-spenders"]>;
+}, "strip", z.ZodTypeAny, {
+    entryPoint: "insightsWidget";
+    widget: "cards-by-month" | "top-spenders";
+}, {
+    entryPoint: "insightsWidget";
+    widget: "cards-by-month" | "top-spenders";
+}>, z.ZodObject<{
+    entryPoint: z.ZodLiteral<"onboarding">;
+    onboardingEntryPoint: z.ZodDefault<z.ZodEnum<["welcome", "application"]>>;
+    onboardingExitPoint: z.ZodDefault<z.ZodEnum<["application", "activation"]>>;
+}, "strip", z.ZodTypeAny, {
+    entryPoint: "onboarding";
+    onboardingEntryPoint: "welcome" | "application";
+    onboardingExitPoint: "application" | "activation";
+}, {
+    entryPoint: "onboarding";
+    onboardingEntryPoint?: "welcome" | "application" | undefined;
+    onboardingExitPoint?: "application" | "activation" | undefined;
+}>, z.ZodObject<{
+    entryPoint: z.ZodLiteral<"cardsApp">;
+}, "strip", z.ZodTypeAny, {
+    entryPoint: "cardsApp";
+}, {
+    entryPoint: "cardsApp";
+}>]>, z.ZodObject<{
+    referer: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+}, "strip", z.ZodTypeAny, {
+    referer?: string | null | undefined;
+}, {
+    referer?: string | null | undefined;
+}>>;
+
+/**
+ * connects to child iframe and returns whether the iframe is loaded or not.
+ */
+export declare function useIframeConnection({ iframeRef, token, onError, methods, }: {
+    iframeRef: React.RefObject<HTMLIFrameElement>;
+    token: string;
+    onError: ((error: Error) => void) | undefined | null;
+    methods: IframeConnectionMethods;
+}): void;
+
+export { }