@tight-embedded/react 6.7.1 → 6.9.0

package/dist/index.d.ts

@@ -1,6 +1,12 @@
 import { ComponentPropsWithoutRef } from 'react';
+import { EventRegistration } from './types/events.ts';
 import { JSX } from 'react/jsx-runtime';
+import { PlaidLinkEvent } from './types/events.ts';
 import { PropsWithChildren } from 'react';
+import { TightEvent } from './types/events.ts';
+import { TightEventListener } from './types/events.ts';
+import { TightEvents } from './types/events.ts';
+import { UseEmbeddedEventListenersResult } from './types/events.ts';
 
 /**
  * A valid anchor target string across all pages that define anchor sections.
@@ -71,7 +77,7 @@ declare type BankTransactionType = "EXPENSE" | "REVENUE" | "TRANSFER_IN" | "TRAN
  *
  * @see NavState
  */
-export declare type BasePage = "FinancialOverview";
+export declare type BasePage = "FinancialOverview" | "TransactionsDashboard" | "BanksAndIntegrations" | "ExpenseDashboard" | "IncomeDashboard" | "ReportDashboard" | "GeneralLedger";
 
 /**
  * A standalone drawer for rendering a conversation that is not attached to an entity.
@@ -105,6 +111,7 @@ declare type DrawerProps = {
     RevenueFilterList: EmptyObject;
     ExpensesFilterList: EmptyObject;
     TransactionSettingsDrawer: EmptyObject;
+    NavMenu: EmptyObject;
 };
 
 declare type DrawerRouteNames = keyof DrawerProps;
@@ -118,6 +125,8 @@ declare const Environments: {
     readonly SANDBOX: "SANDBOX";
 };
 
+export { EventRegistration }
+
 export declare const ExpenseDashboard: (props: ExpenseDashboardProps) => JSX.Element;
 
 declare type ExpenseDashboardProps = {
@@ -287,6 +296,8 @@ declare const PLAID_EVENTS: {
 
 declare type PlaidEvent = ValueOf<typeof PLAID_EVENTS>;
 
+export { PlaidLinkEvent }
+
 export declare function ReportDashboard(): JSX.Element;
 
 declare const SUPPORTED_INTEGRATION_IDENTIFIERS: readonly ["UNIT", "STRIPE", "GUSTO", "SHOPIFY", "SQUARE", "RUTTER", "UBER", "MOOV", "QUALPAY", "MANUAL_ENTRY", "PARTNER_IMPLEMENTATION", "QBO", "XERO", "FRESHBOOKS"];
@@ -296,9 +307,10 @@ export declare function Tight({ children, environment, accessToken }: TightProps
 /**
  * All-in-one component that provides simple and easy consumption of Tight Embedded Components.
  *
- * @param accessToken - Bearer token used to authenticate API requests.
- * @param environment - Selects the Tight API environment (`"PRODUCTION"` or `"SANDBOX"`). Defaults to `"PRODUCTION"`.
- * @param initialNav - The initial page of the TightApp that should open on the initial render. Defaults to the Financial Overview
+ * @param props - Props for the `<TightApp />` component.
+ * @param props.accessToken - Bearer token used to authenticate API requests.
+ * @param props.environment - Selects the Tight API environment (`"PRODUCTION"` or `"SANDBOX"`). Defaults to `"PRODUCTION"`.
+ * @param props.initialNav - The initial page of the TightApp that should open on the initial render. Defaults to the Financial Overview
  *
  * @example
  * ```TypeScript
@@ -307,7 +319,15 @@ export declare function Tight({ children, environment, accessToken }: TightProps
  * <TightApp accessToken={accessToken} initialNav={initialTightPage} />
  * ```
  */
-export declare function TightApp({ accessToken, environment, initialNav }: AppProps): JSX.Element;
+export declare function TightApp(props: AppProps): JSX.Element;
+
+export { TightEvent }
+
+export { TightEventListener }
+
+export { TightEvents }
+
+export declare type TightEventSource = "TransactionsDashboard" | "ExpenseDashboard" | "IncomeDashboard" | "FinancialOverview" | "BanksAndIntegrations";
 
 declare type TightProps = PropsWithChildren<{
     environment: Environment;
@@ -351,6 +371,16 @@ declare type UploadedAttachmentInfo = {
     publicFileUrl: Nullable<string>;
 };
 
+export declare function useEmbeddedEventListeners(initialEventListeners?: Partial<TightEvents>): [TightEvents, (partial: Partial<TightEvents>) => void];
+
+export { UseEmbeddedEventListenersResult }
+
+/**
+ * Returns the dashboard this component is rendered in, or null when rendered
+ * outside any dashboard (e.g. global Drawers, standalone tiles).
+ */
+export declare function useEventSource(): TightEventSource | null;
+
 /**
  * Set library-wide options for various components.
  *