@tight-embedded/react 6.5.0 → 6.7.0

package/dist/index.d.ts

@@ -15,7 +15,7 @@ export declare type Anchor = AnchorFor<keyof PageAnchorMap>;
  *
  * @example
  * ```TypeScript
- * type BODAnchors = AnchorFor<"FinancialOverviewDashboard">;
+ * type BODAnchors = AnchorFor<"FinancialOverview">;
  * // = "conversations-section" | "transactions-section"
  * ```
  */
@@ -28,14 +28,12 @@ declare type AnchorFor<T extends keyof PageAnchorMap> = T extends keyof PageAnch
  * @see NavState
  */
 declare type AppProps = {
-    /** The current navigation target. Controls which page, anchor, and drawer are active. */
-    navState: NavState;
-    /** Called when the user triggers an internal navigation event. The host must update `navState` in response. */
-    onNavigate: (navState: NavState) => void;
-    /** Bearer token used to authenticate API requests. Obtain one from the Tight Authentication Endpoint. */
+    /** Bearer token used to authenticate API requests. Get one from the Tight Authentication Endpoint. */
     accessToken: string;
     /** Selects the Tight API environment. Defaults to `"PRODUCTION"`. Use `"SANDBOX"` for development and testing. */
     environment?: Environment;
+    /** The initial page of the TightApp that should open on the initial render. Defaults to the Financial Overview */
+    initialNav?: NavState;
 };
 
 declare function BankAccountForm({ bankAccountId }: BankAccountFormProps): JSX.Element;
@@ -73,14 +71,7 @@ declare type BankTransactionType = "EXPENSE" | "REVENUE" | "TRANSFER_IN" | "TRAN
  *
  * @see NavState
  */
-export declare type BasePage = "FinancialOverviewDashboard";
-
-export declare function BusinessOwnerDashboard(props: BusinessOwnerDashboardProps): JSX.Element;
-
-declare type BusinessOwnerDashboardProps = {
-    period?: Period;
-    onChangePeriod?: (period: Period) => void;
-};
+export declare type BasePage = "FinancialOverview";
 
 /**
  * A standalone drawer for rendering a conversation that is not attached to an entity.
@@ -113,6 +104,7 @@ declare type DrawerProps = {
     TransactionsFilterList: EmptyObject;
     RevenueFilterList: EmptyObject;
     ExpensesFilterList: EmptyObject;
+    TransactionSettingsDrawer: EmptyObject;
 };
 
 declare type DrawerRouteNames = keyof DrawerProps;
@@ -141,6 +133,15 @@ declare type ExternalOptions = {
     banksAndIntegrations?: BanksAndIntegrationsOptions;
 };
 
+export declare function FinancialOverview(props: FinancialOverviewDashboardProps): JSX.Element;
+
+declare type FinancialOverviewDashboardProps = {
+    period?: Period;
+    onChangePeriod?: (period: Period) => void;
+};
+
+declare type FinancialOverviewPageProps = Pick<FinancialOverviewDashboardProps, "period">;
+
 declare function FinancialSummaryDrawer({ summaryId, conversationId }: FinancialSummaryDrawerProps): JSX.Element;
 
 declare type FinancialSummaryDrawerProps = {
@@ -184,11 +185,11 @@ declare type MobileConversationDrawerProps = {
  * @example
  * ```TypeScript
  * // Navigate to a top-level page
- * const nav: NavState = { page: "FinancialOverviewDashboard" };
+ * const nav: NavState = { page: "FinancialOverview" };
  *
  * // Navigate to a specific anchor section
  * const navWithAnchor: NavState = {
- *   page: "FinancialOverviewDashboard",
+ *   page: "FinancialOverview",
  *   anchor: "conversations-section",
  * };
  *
@@ -210,6 +211,7 @@ export declare type NavState = {
         page: P;
         anchor?: P extends keyof PageAnchorMap ? AnchorFor<P> : never;
         drawer?: DrawerNavObject;
+        pageProps?: P extends keyof PagePropsMap ? PagePropsMap[P] : never;
     };
 }[BasePage];
 
@@ -236,7 +238,7 @@ declare type OptionSetter = (options: Partial<ExternalOptions>, replace?: boolea
  *
  */
 declare const PAGE_ANCHOR_MAP: {
-    readonly FinancialOverviewDashboard: {
+    readonly FinancialOverview: {
         readonly CONVERSATIONS: "conversations-section";
         readonly TRANSACTIONS: "transactions-section";
     };
@@ -244,6 +246,10 @@ declare const PAGE_ANCHOR_MAP: {
 
 declare type PageAnchorMap = typeof PAGE_ANCHOR_MAP;
 
+declare type PagePropsMap = {
+    FinancialOverview: FinancialOverviewPageProps;
+};
+
 /**
  * Parses a URL string into a `NavObject` for use as the `navObject` prop on `<App />`.
  *
@@ -255,13 +261,13 @@ declare type PageAnchorMap = typeof PAGE_ANCHOR_MAP;
  *
  * @example
  * ```TypeScript
- * const nav = parseNavUrl("https://app.example.com?bkPage=FinancialOverviewDashboard");
- * // nav = { page: "FinancialOverviewDashboard" }
+ * const nav = parseNavUrl("https://app.example.com?bkPage=FinancialOverview");
+ * // nav = { page: "FinancialOverview" }
  *
  * const navWithAnchor = parseNavUrl(
- *   "https://app.example.com?bkPage=FinancialOverviewDashboard&bkAnchor=conversations-section"
+ *   "https://app.example.com?bkPage=FinancialOverview&bkAnchor=conversations-section"
  * );
- * // navWithAnchor = { page: "FinancialOverviewDashboard", anchor: "conversations-section" }
+ * // navWithAnchor = { page: "FinancialOverview", anchor: "conversations-section" }
  * ```
  */
 export declare function parseNavUrl(url: string): NavState | undefined;
@@ -281,30 +287,27 @@ declare const PLAID_EVENTS: {
 
 declare type PlaidEvent = ValueOf<typeof PLAID_EVENTS>;
 
+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"];
 
 export declare function Tight({ children, environment, accessToken }: TightProps): JSX.Element;
 
 /**
- * The root component of the Tight application.
- *
- * Wraps all dashboard views in a shared `MemoryRouter` and navigation context.
- * Navigation state is driven externally via the `navState` prop, making the
- * component fully controlled — the host application owns navigation state.
+ * 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 navState - The current navigation target. Controls page, anchor, and open drawer.
- * @param onNavigate - Callback fired when the user triggers an internal navigation event.
+ * @param initialNav - The initial page of the TightApp that should open on the initial render. Defaults to the Financial Overview
  *
  * @example
  * ```TypeScript
- * const [nav, setNav] = useState<NavState>({ page: "FinancialOverviewDashboard" });
+ * const initialTightPage = { page: "FinancialOverview" };
  *
- * <TightApp accessToken={accessToken} navState={nav} onNavigate={setNav} />
+ * <TightApp accessToken={accessToken} initialNav={initialTightPage} />
  * ```
  */
-export declare function TightApp({ accessToken, environment, navState, onNavigate }: AppProps): JSX.Element;
+export declare function TightApp({ accessToken, environment, initialNav }: AppProps): JSX.Element;
 
 declare type TightProps = PropsWithChildren<{
     environment: Environment;
@@ -330,7 +333,7 @@ declare const TransactionTableColumns: {
     readonly DESCRIPTION: "description";
     readonly AMOUNT: "amount";
     readonly CATEGORY: "category";
-    readonly CLASS_SEGMENT: "classSegment";
+    readonly DIMENSION_VALUE: "dimensionValue";
     readonly REVIEW_STATUS: "reviewStatus";
     readonly COMMENTS: "comments";
 };