@capitalos/react 1.4.6 → 1.5.0

package/README.md

@@ -50,11 +50,3 @@ function MyComponent() {
 ## TypeScript support
 
 TypeScript definitions for `@capitalos/react` are built into the npm package and should be automatically picked up by your editor.
-
-## Error Handling
-
-For details on how errors are managed within the SDK and how to handle them as a consumer or a maintainer, please see our [Error Handling Guidelines](./ERROR_HANDLING.md).
-
-## Navigation Patterns
-
-For guidance on modal dismissal, back button behavior, and callback semantics when integrating SDK components into your application, please see our [Navigation and Closing Patterns](./NAVIGATION_PATTERNS.md).

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

@@ -69,6 +69,76 @@ declare type AllowedExitPoints = {
 /** @deprecated Use {@link CardsApp} instead */
 export declare const App: typeof CardsApp;
 
+/**
+ * Application status indicating the account's onboarding state.
+ * - `ineligible`: Account cannot onboard to CapitalOS
+ * - `eligible`: Account is eligible to apply (may have already started the application)
+ * - `preapproved`: Account has completed underwriting and is either approved or just needs to sign documents
+ */
+export declare type ApplicationStatus = 'ineligible' | 'eligible' | 'preapproved';
+
+/**
+ * Application status indicating the account's onboarding state.
+ * - `ineligible`: Account cannot onboard to CapitalOS
+ * - `eligible`: Account is eligible to apply (may have already started the application)
+ * - `preapproved`: Account has completed underwriting and is either approved or just needs to sign documents
+ */
+export declare type ApplicationStatus_alias_1 = 'ineligible' | 'eligible' | 'preapproved';
+
+/**
+ * Bank account information returned from ConnectBankAccounts.
+ * Field names align with Platform API (LinkedBankAccountDto) for consistency.
+ */
+export declare type BankAccount = {
+    /**
+     * The unique identifier for the external account in CapitalOS
+     */
+    id: string;
+    /**
+     * The name of the bank (e.g., "Chase", "Bank of America")
+     */
+    bankName: string;
+    /**
+     * The account name (e.g., "Checking Account")
+     */
+    accountName: string;
+    /**
+     * Last 4 digits of the account number
+     */
+    accountNumberMask: string;
+    /**
+     * Full account number
+     */
+    accountNumber: string;
+    /**
+     * Bank routing number
+     */
+    routingNumber: string;
+    /**
+     * The account type (e.g., "checking", "savings")
+     */
+    type: string;
+    /**
+     * Account status
+     */
+    status: 'enabled' | 'disabled';
+};
+
+/**
+ * Bank account information returned from ConnectBankAccounts.
+ * Field names align with Platform API (LinkedBankAccountDto) for consistency.
+ */
+export declare type BankAccount_alias_1 = {
+    id: string;
+    bankName: string;
+    accountName: string;
+    accountNumberMask: string;
+    accountNumber: string;
+    routingNumber: string;
+    type: string;
+    status: 'enabled' | 'disabled';
+};
+
 /**
  * Renders the CapitalOS Bill Payment Dashboard experience.
  */
@@ -298,7 +368,6 @@ declare const cardApiDtoSchema: z_2.ZodObject<{
             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;
@@ -306,6 +375,7 @@ declare const cardApiDtoSchema: z_2.ZodObject<{
                 zipcode: string;
                 addressLine2?: string | null | undefined;
             };
+            method: "usps" | "fedexPriorityOvernight" | "fedexTwoDay";
             recipientName: string;
             returnReason: string | null;
             shippedAt: string | null;
@@ -321,7 +391,6 @@ declare const cardApiDtoSchema: z_2.ZodObject<{
             trackingUrl: string | null;
         }, {
             status: "pending" | "canceled" | "rejected" | "returned" | "shipped";
-            method: "usps" | "fedexPriorityOvernight" | "fedexTwoDay";
             address: {
                 addressLine1: string;
                 city: string;
@@ -329,6 +398,7 @@ declare const cardApiDtoSchema: z_2.ZodObject<{
                 zipcode: string;
                 addressLine2?: string | null | undefined;
             };
+            method: "usps" | "fedexPriorityOvernight" | "fedexTwoDay";
             recipientName: string;
             returnReason: string | null;
             shippedAt: string | null;
@@ -349,7 +419,6 @@ declare const cardApiDtoSchema: z_2.ZodObject<{
         status: "active" | "canceled" | "disabled";
         shipment: {
             status: "pending" | "canceled" | "rejected" | "returned" | "shipped";
-            method: "usps" | "fedexPriorityOvernight" | "fedexTwoDay";
             address: {
                 addressLine1: string;
                 city: string;
@@ -357,6 +426,7 @@ declare const cardApiDtoSchema: z_2.ZodObject<{
                 zipcode: string;
                 addressLine2?: string | null | undefined;
             };
+            method: "usps" | "fedexPriorityOvernight" | "fedexTwoDay";
             recipientName: string;
             returnReason: string | null;
             shippedAt: string | null;
@@ -376,7 +446,6 @@ declare const cardApiDtoSchema: z_2.ZodObject<{
         status: "active" | "canceled" | "disabled";
         shipment: {
             status: "pending" | "canceled" | "rejected" | "returned" | "shipped";
-            method: "usps" | "fedexPriorityOvernight" | "fedexTwoDay";
             address: {
                 addressLine1: string;
                 city: string;
@@ -384,6 +453,7 @@ declare const cardApiDtoSchema: z_2.ZodObject<{
                 zipcode: string;
                 addressLine2?: string | null | undefined;
             };
+            method: "usps" | "fedexPriorityOvernight" | "fedexTwoDay";
             recipientName: string;
             returnReason: string | null;
             shippedAt: string | null;
@@ -438,7 +508,6 @@ declare const cardApiDtoSchema: z_2.ZodObject<{
         status: "active" | "canceled" | "disabled";
         shipment: {
             status: "pending" | "canceled" | "rejected" | "returned" | "shipped";
-            method: "usps" | "fedexPriorityOvernight" | "fedexTwoDay";
             address: {
                 addressLine1: string;
                 city: string;
@@ -446,6 +515,7 @@ declare const cardApiDtoSchema: z_2.ZodObject<{
                 zipcode: string;
                 addressLine2?: string | null | undefined;
             };
+            method: "usps" | "fedexPriorityOvernight" | "fedexTwoDay";
             recipientName: string;
             returnReason: string | null;
             shippedAt: string | null;
@@ -501,7 +571,6 @@ declare const cardApiDtoSchema: z_2.ZodObject<{
         status: "active" | "canceled" | "disabled";
         shipment: {
             status: "pending" | "canceled" | "rejected" | "returned" | "shipped";
-            method: "usps" | "fedexPriorityOvernight" | "fedexTwoDay";
             address: {
                 addressLine1: string;
                 city: string;
@@ -509,6 +578,7 @@ declare const cardApiDtoSchema: z_2.ZodObject<{
                 zipcode: string;
                 addressLine2?: string | null | undefined;
             };
+            method: "usps" | "fedexPriorityOvernight" | "fedexTwoDay";
             recipientName: string;
             returnReason: string | null;
             shippedAt: string | null;
@@ -642,6 +712,47 @@ export declare type ConfigureAutoPayProps = CommonProps & {
     onClose: () => void;
 };
 
+/**
+ * Renders the CapitalOS Connect Bank Accounts experience.
+ * This component guides users through connecting their bank account via Plaid
+ * and returns all connected accounts along with the application status.
+ */
+export declare function ConnectBankAccounts({ onClose, onDone, ...restOfProps }: ConnectBankAccountsProps): JSX.Element;
+
+export declare type ConnectBankAccountsProps = CommonProps & {
+    /**
+     * Callback to invoke when the user closes the bank account connection screen.
+     */
+    onClose: () => void;
+    /**
+     * Callback to invoke when the bank account connection is completed successfully.
+     *
+     * @param result - Object containing the connected accounts and application status
+     * @param result.accounts - Array of connected bank accounts
+     * @param result.applicationStatus - The account's onboarding state
+     */
+    onDone: (result: ConnectBankAccountsResult) => void;
+};
+
+export declare type ConnectBankAccountsResult = {
+    /**
+     * Array of connected bank accounts
+     */
+    accounts: BankAccount[];
+    /**
+     * The application status indicating the account's onboarding state
+     */
+    applicationStatus: ApplicationStatus;
+};
+
+/**
+ * Result from ConnectBankAccounts component.
+ */
+export declare type ConnectBankAccountsResult_alias_1 = {
+    accounts: BankAccount_alias_1[];
+    applicationStatus: ApplicationStatus_alias_1;
+};
+
 /**
  * Renders the CapitalOS Connect To Vendors experience.
  */
@@ -672,13 +783,6 @@ export declare type ContactSupportProps = CommonProps & {
 
 export declare function decodeOneTimeToken(token: string): any;
 
-/**
- * Renders the CapitalOS Demo Bill Payment Dashboard experience.
- */
-export declare function DemoBillPayApp(props: DemoBillPayAppProps): JSX.Element;
-
-export declare type DemoBillPayAppProps = CommonProps;
-
 /**
  * Renders the CapitalOS Dev Tools experience.
  * Allows for simulating transactions, etc.
@@ -1072,6 +1176,10 @@ export declare type ParentFunctions = {
     policySettings?: {
         onClose?: () => void;
     };
+    connectBankAccounts?: {
+        onClose?: () => void;
+        onDone?: (result: ConnectBankAccountsResult_alias_1) => void;
+    };
     connectToVendors?: {
         onClose?: () => void;
     };
@@ -1200,12 +1308,6 @@ declare const renderingContextSchema: z.ZodIntersection<z.ZodDiscriminatedUnion<
     entryPoint: "billPayApp";
 }, {
     entryPoint: "billPayApp";
-}>, z.ZodObject<{
-    entryPoint: z.ZodLiteral<"demoBillPayApp">;
-}, "strip", z.ZodTypeAny, {
-    entryPoint: "demoBillPayApp";
-}, {
-    entryPoint: "demoBillPayApp";
 }>, z.ZodObject<{
     entryPoint: z.ZodLiteral<"cardDetails">;
     cardId: z.ZodString;
@@ -1266,6 +1368,12 @@ declare const renderingContextSchema: z.ZodIntersection<z.ZodDiscriminatedUnion<
     entryPoint: "connectToVendors";
     cardId?: string | undefined;
     inlineCardOnFile?: boolean | undefined;
+}>, z.ZodObject<{
+    entryPoint: z.ZodLiteral<"connectBankAccounts">;
+}, "strip", z.ZodTypeAny, {
+    entryPoint: "connectBankAccounts";
+}, {
+    entryPoint: "connectBankAccounts";
 }>, z.ZodObject<{
     entryPoint: z.ZodLiteral<"insightsDashboard">;
 }, "strip", z.ZodTypeAny, {

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

@@ -69,6 +69,76 @@ declare type AllowedExitPoints = {
 /** @deprecated Use {@link CardsApp} instead */
 export declare const App: typeof CardsApp;
 
+/**
+ * Application status indicating the account's onboarding state.
+ * - `ineligible`: Account cannot onboard to CapitalOS
+ * - `eligible`: Account is eligible to apply (may have already started the application)
+ * - `preapproved`: Account has completed underwriting and is either approved or just needs to sign documents
+ */
+export declare type ApplicationStatus = 'ineligible' | 'eligible' | 'preapproved';
+
+/**
+ * Application status indicating the account's onboarding state.
+ * - `ineligible`: Account cannot onboard to CapitalOS
+ * - `eligible`: Account is eligible to apply (may have already started the application)
+ * - `preapproved`: Account has completed underwriting and is either approved or just needs to sign documents
+ */
+export declare type ApplicationStatus_alias_1 = 'ineligible' | 'eligible' | 'preapproved';
+
+/**
+ * Bank account information returned from ConnectBankAccounts.
+ * Field names align with Platform API (LinkedBankAccountDto) for consistency.
+ */
+export declare type BankAccount = {
+    /**
+     * The unique identifier for the external account in CapitalOS
+     */
+    id: string;
+    /**
+     * The name of the bank (e.g., "Chase", "Bank of America")
+     */
+    bankName: string;
+    /**
+     * The account name (e.g., "Checking Account")
+     */
+    accountName: string;
+    /**
+     * Last 4 digits of the account number
+     */
+    accountNumberMask: string;
+    /**
+     * Full account number
+     */
+    accountNumber: string;
+    /**
+     * Bank routing number
+     */
+    routingNumber: string;
+    /**
+     * The account type (e.g., "checking", "savings")
+     */
+    type: string;
+    /**
+     * Account status
+     */
+    status: 'enabled' | 'disabled';
+};
+
+/**
+ * Bank account information returned from ConnectBankAccounts.
+ * Field names align with Platform API (LinkedBankAccountDto) for consistency.
+ */
+export declare type BankAccount_alias_1 = {
+    id: string;
+    bankName: string;
+    accountName: string;
+    accountNumberMask: string;
+    accountNumber: string;
+    routingNumber: string;
+    type: string;
+    status: 'enabled' | 'disabled';
+};
+
 /**
  * Renders the CapitalOS Bill Payment Dashboard experience.
  */
@@ -298,7 +368,6 @@ declare const cardApiDtoSchema: z_2.ZodObject<{
             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;
@@ -306,6 +375,7 @@ declare const cardApiDtoSchema: z_2.ZodObject<{
                 zipcode: string;
                 addressLine2?: string | null | undefined;
             };
+            method: "usps" | "fedexPriorityOvernight" | "fedexTwoDay";
             recipientName: string;
             returnReason: string | null;
             shippedAt: string | null;
@@ -321,7 +391,6 @@ declare const cardApiDtoSchema: z_2.ZodObject<{
             trackingUrl: string | null;
         }, {
             status: "pending" | "canceled" | "rejected" | "returned" | "shipped";
-            method: "usps" | "fedexPriorityOvernight" | "fedexTwoDay";
             address: {
                 addressLine1: string;
                 city: string;
@@ -329,6 +398,7 @@ declare const cardApiDtoSchema: z_2.ZodObject<{
                 zipcode: string;
                 addressLine2?: string | null | undefined;
             };
+            method: "usps" | "fedexPriorityOvernight" | "fedexTwoDay";
             recipientName: string;
             returnReason: string | null;
             shippedAt: string | null;
@@ -349,7 +419,6 @@ declare const cardApiDtoSchema: z_2.ZodObject<{
         status: "active" | "canceled" | "disabled";
         shipment: {
             status: "pending" | "canceled" | "rejected" | "returned" | "shipped";
-            method: "usps" | "fedexPriorityOvernight" | "fedexTwoDay";
             address: {
                 addressLine1: string;
                 city: string;
@@ -357,6 +426,7 @@ declare const cardApiDtoSchema: z_2.ZodObject<{
                 zipcode: string;
                 addressLine2?: string | null | undefined;
             };
+            method: "usps" | "fedexPriorityOvernight" | "fedexTwoDay";
             recipientName: string;
             returnReason: string | null;
             shippedAt: string | null;
@@ -376,7 +446,6 @@ declare const cardApiDtoSchema: z_2.ZodObject<{
         status: "active" | "canceled" | "disabled";
         shipment: {
             status: "pending" | "canceled" | "rejected" | "returned" | "shipped";
-            method: "usps" | "fedexPriorityOvernight" | "fedexTwoDay";
             address: {
                 addressLine1: string;
                 city: string;
@@ -384,6 +453,7 @@ declare const cardApiDtoSchema: z_2.ZodObject<{
                 zipcode: string;
                 addressLine2?: string | null | undefined;
             };
+            method: "usps" | "fedexPriorityOvernight" | "fedexTwoDay";
             recipientName: string;
             returnReason: string | null;
             shippedAt: string | null;
@@ -438,7 +508,6 @@ declare const cardApiDtoSchema: z_2.ZodObject<{
         status: "active" | "canceled" | "disabled";
         shipment: {
             status: "pending" | "canceled" | "rejected" | "returned" | "shipped";
-            method: "usps" | "fedexPriorityOvernight" | "fedexTwoDay";
             address: {
                 addressLine1: string;
                 city: string;
@@ -446,6 +515,7 @@ declare const cardApiDtoSchema: z_2.ZodObject<{
                 zipcode: string;
                 addressLine2?: string | null | undefined;
             };
+            method: "usps" | "fedexPriorityOvernight" | "fedexTwoDay";
             recipientName: string;
             returnReason: string | null;
             shippedAt: string | null;
@@ -501,7 +571,6 @@ declare const cardApiDtoSchema: z_2.ZodObject<{
         status: "active" | "canceled" | "disabled";
         shipment: {
             status: "pending" | "canceled" | "rejected" | "returned" | "shipped";
-            method: "usps" | "fedexPriorityOvernight" | "fedexTwoDay";
             address: {
                 addressLine1: string;
                 city: string;
@@ -509,6 +578,7 @@ declare const cardApiDtoSchema: z_2.ZodObject<{
                 zipcode: string;
                 addressLine2?: string | null | undefined;
             };
+            method: "usps" | "fedexPriorityOvernight" | "fedexTwoDay";
             recipientName: string;
             returnReason: string | null;
             shippedAt: string | null;
@@ -642,6 +712,47 @@ export declare type ConfigureAutoPayProps = CommonProps & {
     onClose: () => void;
 };
 
+/**
+ * Renders the CapitalOS Connect Bank Accounts experience.
+ * This component guides users through connecting their bank account via Plaid
+ * and returns all connected accounts along with the application status.
+ */
+export declare function ConnectBankAccounts({ onClose, onDone, ...restOfProps }: ConnectBankAccountsProps): JSX.Element;
+
+export declare type ConnectBankAccountsProps = CommonProps & {
+    /**
+     * Callback to invoke when the user closes the bank account connection screen.
+     */
+    onClose: () => void;
+    /**
+     * Callback to invoke when the bank account connection is completed successfully.
+     *
+     * @param result - Object containing the connected accounts and application status
+     * @param result.accounts - Array of connected bank accounts
+     * @param result.applicationStatus - The account's onboarding state
+     */
+    onDone: (result: ConnectBankAccountsResult) => void;
+};
+
+export declare type ConnectBankAccountsResult = {
+    /**
+     * Array of connected bank accounts
+     */
+    accounts: BankAccount[];
+    /**
+     * The application status indicating the account's onboarding state
+     */
+    applicationStatus: ApplicationStatus;
+};
+
+/**
+ * Result from ConnectBankAccounts component.
+ */
+export declare type ConnectBankAccountsResult_alias_1 = {
+    accounts: BankAccount_alias_1[];
+    applicationStatus: ApplicationStatus_alias_1;
+};
+
 /**
  * Renders the CapitalOS Connect To Vendors experience.
  */
@@ -672,13 +783,6 @@ export declare type ContactSupportProps = CommonProps & {
 
 export declare function decodeOneTimeToken(token: string): any;
 
-/**
- * Renders the CapitalOS Demo Bill Payment Dashboard experience.
- */
-export declare function DemoBillPayApp(props: DemoBillPayAppProps): JSX.Element;
-
-export declare type DemoBillPayAppProps = CommonProps;
-
 /**
  * Renders the CapitalOS Dev Tools experience.
  * Allows for simulating transactions, etc.
@@ -1072,6 +1176,10 @@ export declare type ParentFunctions = {
     policySettings?: {
         onClose?: () => void;
     };
+    connectBankAccounts?: {
+        onClose?: () => void;
+        onDone?: (result: ConnectBankAccountsResult_alias_1) => void;
+    };
     connectToVendors?: {
         onClose?: () => void;
     };
@@ -1200,12 +1308,6 @@ declare const renderingContextSchema: z.ZodIntersection<z.ZodDiscriminatedUnion<
     entryPoint: "billPayApp";
 }, {
     entryPoint: "billPayApp";
-}>, z.ZodObject<{
-    entryPoint: z.ZodLiteral<"demoBillPayApp">;
-}, "strip", z.ZodTypeAny, {
-    entryPoint: "demoBillPayApp";
-}, {
-    entryPoint: "demoBillPayApp";
 }>, z.ZodObject<{
     entryPoint: z.ZodLiteral<"cardDetails">;
     cardId: z.ZodString;
@@ -1266,6 +1368,12 @@ declare const renderingContextSchema: z.ZodIntersection<z.ZodDiscriminatedUnion<
     entryPoint: "connectToVendors";
     cardId?: string | undefined;
     inlineCardOnFile?: boolean | undefined;
+}>, z.ZodObject<{
+    entryPoint: z.ZodLiteral<"connectBankAccounts">;
+}, "strip", z.ZodTypeAny, {
+    entryPoint: "connectBankAccounts";
+}, {
+    entryPoint: "connectBankAccounts";
 }>, z.ZodObject<{
     entryPoint: z.ZodLiteral<"insightsDashboard">;
 }, "strip", z.ZodTypeAny, {