@layerfi/components 0.1.26 → 0.1.28

package/dist/index.d.ts

@@ -836,9 +836,9 @@ declare module '@layerfi/components/components/BankTransactionRow/BankTransactio
   import { BankTransaction, Category } from '@layerfi/components/types';
   type Props = {
       index: number;
+      editable: boolean;
       dateFormat: string;
       bankTransaction: BankTransaction;
-      editable: boolean;
       removeTransaction: (id: string) => void;
       containerWidth?: number;
       initialLoad?: boolean;
@@ -848,7 +848,7 @@ declare module '@layerfi/components/components/BankTransactionRow/BankTransactio
   export type LastSubmittedForm = 'simple' | 'match' | 'split' | undefined;
   export const extractDescriptionForSplit: (category: Category) => string;
   export const getDefaultSelectedCategory: (bankTransaction: BankTransaction) => import("@layerfi/components/components/CategorySelect/CategorySelect").CategoryOption | undefined;
-  export const BankTransactionRow: ({ index, dateFormat, bankTransaction, editable, removeTransaction, containerWidth, initialLoad, showDescriptions, showReceiptUploads }: Props) => React.JSX.Element | null;
+  export const BankTransactionRow: ({ index, editable, dateFormat, bankTransaction, removeTransaction, containerWidth, initialLoad, showDescriptions, showReceiptUploads, }: Props) => React.JSX.Element | null;
   export {};
 
 }
@@ -879,6 +879,7 @@ declare module '@layerfi/components/components/BankTransactionRow/index' {
 }
 declare module '@layerfi/components/components/BankTransactions/BankTransactions' {
   import React from 'react';
+  import { BankTransactionFilters } from '@layerfi/components/hooks/useBankTransactions/types';
   import { MobileComponentType } from '@layerfi/components/components/BankTransactions/constants';
   export interface BankTransactionsProps {
       asWidget?: boolean;
@@ -887,20 +888,25 @@ declare module '@layerfi/components/components/BankTransactions/BankTransactions
       showDescriptions?: boolean;
       showReceiptUploads?: boolean;
       monthlyView?: boolean;
+      categorizeView?: boolean;
       mobileComponent?: MobileComponentType;
+      filters?: BankTransactionFilters;
+      hideHeader?: boolean;
   }
-  export const BankTransactions: ({ asWidget, pageSize, categorizedOnly, showDescriptions, showReceiptUploads, monthlyView, mobileComponent, }: BankTransactionsProps) => React.JSX.Element;
+  export const BankTransactions: ({ asWidget, pageSize, categorizedOnly, categorizeView, showDescriptions, showReceiptUploads, monthlyView, mobileComponent, filters: inputFilters, hideHeader, }: BankTransactionsProps) => React.JSX.Element;
 
 }
 declare module '@layerfi/components/components/BankTransactions/BankTransactionsHeader' {
   import React, { ChangeEvent } from 'react';
+  import { DisplayState } from '@layerfi/components/hooks/useBankTransactions/types';
   import { DateRange } from '@layerfi/components/types';
-  import { DisplayState, MobileComponentType } from '@layerfi/components/components/BankTransactions/constants';
+  import { MobileComponentType } from '@layerfi/components/components/BankTransactions/constants';
   export interface BankTransactionsHeaderProps {
       shiftStickyHeader: number;
       asWidget?: boolean;
       categorizedOnly?: boolean;
-      display: DisplayState;
+      categorizeView?: boolean;
+      display?: DisplayState;
       onCategorizationDisplayChange: (event: ChangeEvent<HTMLInputElement>) => void;
       mobileComponent?: MobileComponentType;
       withDatePicker?: boolean;
@@ -908,7 +914,7 @@ declare module '@layerfi/components/components/BankTransactions/BankTransactions
       dateRange?: DateRange;
       setDateRange?: (value: DateRange) => void;
   }
-  export const BankTransactionsHeader: ({ shiftStickyHeader, asWidget, categorizedOnly, display, onCategorizationDisplayChange, mobileComponent, withDatePicker, listView, dateRange, setDateRange, }: BankTransactionsHeaderProps) => React.JSX.Element;
+  export const BankTransactionsHeader: ({ shiftStickyHeader, asWidget, categorizedOnly, categorizeView, display, onCategorizationDisplayChange, mobileComponent, withDatePicker, listView, dateRange, setDateRange, }: BankTransactionsHeaderProps) => React.JSX.Element;
 
 }
 declare module '@layerfi/components/components/BankTransactions/DataStates' {
@@ -929,10 +935,6 @@ declare module '@layerfi/components/components/BankTransactions/DataStates' {
 declare module '@layerfi/components/components/BankTransactions/constants' {
   import { CategorizationStatus } from '@layerfi/components/types';
   export type MobileComponentType = 'regularList' | 'mobileList';
-  export enum DisplayState {
-      review = "review",
-      categorized = "categorized"
-  }
   export const CategorizedCategories: CategorizationStatus[];
   export const ReviewCategories: CategorizationStatus[];
 
@@ -942,9 +944,9 @@ declare module '@layerfi/components/components/BankTransactions/index' {
 
 }
 declare module '@layerfi/components/components/BankTransactions/utils' {
-  import { BankTransaction } from '@layerfi/components/types';
-  import { DisplayState } from '@layerfi/components/components/BankTransactions/constants';
-  export const filterVisibility: (display: DisplayState, bankTransaction: BankTransaction) => boolean;
+  import { BankTransaction, CategorizationScope } from '@layerfi/components/types';
+  export const filterVisibility: (scope: CategorizationScope, bankTransaction: BankTransaction) => boolean;
+  export const isCategorized: (bankTransaction: BankTransaction) => boolean;
 
 }
 declare module '@layerfi/components/components/BankTransactionsTable/BankTransactionsTable' {
@@ -953,6 +955,7 @@ declare module '@layerfi/components/components/BankTransactionsTable/BankTransac
   interface BankTransactionsTableProps {
       bankTransactions?: BankTransaction[];
       editable: boolean;
+      categorizeView?: boolean;
       isLoading?: boolean;
       initialLoad?: boolean;
       containerWidth: number;
@@ -960,7 +963,7 @@ declare module '@layerfi/components/components/BankTransactionsTable/BankTransac
       showDescriptions?: boolean;
       showReceiptUploads?: boolean;
   }
-  export const BankTransactionsTable: ({ editable, isLoading, bankTransactions, initialLoad, containerWidth, removeTransaction, showDescriptions, showReceiptUploads, }: BankTransactionsTableProps) => React.JSX.Element;
+  export const BankTransactionsTable: ({ categorizeView, editable, isLoading, bankTransactions, initialLoad, containerWidth, removeTransaction, showDescriptions, showReceiptUploads, }: BankTransactionsTableProps) => React.JSX.Element;
   export {};
 
 }
@@ -1375,7 +1378,7 @@ declare module '@layerfi/components/components/ExpandedBankTransactionRow/Expand
       asListItem?: boolean;
       submitBtnText?: string;
       containerWidth?: number;
-      editable?: boolean;
+      categorized?: boolean;
       showDescriptions: boolean;
       showReceiptUploads: boolean;
   };
@@ -1799,8 +1802,9 @@ declare module '@layerfi/components/components/Onboarding/ConnectAccount' {
   export interface ConnectAccountProps {
       onboardingStep: OnboardingStep;
       onTransactionsToReviewClick?: () => void;
+      currentMonthOnly?: boolean;
   }
-  export const ConnectAccount: ({ onboardingStep, onTransactionsToReviewClick, }: ConnectAccountProps) => React.JSX.Element;
+  export const ConnectAccount: ({ onboardingStep, onTransactionsToReviewClick, currentMonthOnly, }: ConnectAccountProps) => React.JSX.Element;
 
 }
 declare module '@layerfi/components/components/Onboarding/Onboarding' {
@@ -2399,8 +2403,9 @@ declare module '@layerfi/components/components/TransactionToReviewCard/Transacti
   import React from 'react';
   export interface TransactionToReviewCardProps {
       onClick?: () => void;
+      currentMonthOnly?: true;
   }
-  export const TransactionToReviewCard: ({ onClick, }: TransactionToReviewCardProps) => React.JSX.Element;
+  export const TransactionToReviewCard: ({ onClick, currentMonthOnly, }: TransactionToReviewCardProps) => React.JSX.Element;
 
 }
 declare module '@layerfi/components/components/TransactionToReviewCard/index' {
@@ -2572,6 +2577,51 @@ declare module '@layerfi/components/config/theme' {
       };
   };
 
+}
+declare module '@layerfi/components/contexts/BankTransactionsContext/BankTransactionsContext' {
+  /// <reference types="react" />
+  import { useBankTransactions } from '@layerfi/components/hooks/useBankTransactions/index';
+  import { DisplayState } from '@layerfi/components/hooks/useBankTransactions/types';
+  export type BankTransactionsContextType = ReturnType<typeof useBankTransactions>;
+  export const BankTransactionsContext: import("react").Context<{
+      data?: import("@layerfi/components/types").BankTransaction[] | undefined;
+      metadata: import("@layerfi/components/types").Metadata;
+      loadingStatus: import("@layerfi/components/types/general").LoadedStatus;
+      isLoading: boolean;
+      isValidating: boolean;
+      error: unknown;
+      filters?: import("@layerfi/components/hooks/useBankTransactions/types").BankTransactionFilters | undefined;
+      accountsList?: import("@layerfi/components/hooks/useBankTransactions/types").AccountItem[] | undefined;
+      display: DisplayState;
+      categorize: (id: string, newCategory: import("@layerfi/components/types").CategoryUpdate, notify?: boolean | undefined) => Promise<void>;
+      match: (id: string, matchId: string, notify?: boolean | undefined) => Promise<void>;
+      updateOneLocal: (bankTransaction: import("@layerfi/components/types").BankTransaction) => void;
+      refetch: () => void;
+      setFilters: (filters?: Partial<import("@layerfi/components/hooks/useBankTransactions/types").BankTransactionFilters> | undefined) => void;
+      activate: () => void;
+  }>;
+  export const useBankTransactionsContext: () => {
+      data?: import("@layerfi/components/types").BankTransaction[] | undefined;
+      metadata: import("@layerfi/components/types").Metadata;
+      loadingStatus: import("@layerfi/components/types/general").LoadedStatus;
+      isLoading: boolean;
+      isValidating: boolean;
+      error: unknown;
+      filters?: import("@layerfi/components/hooks/useBankTransactions/types").BankTransactionFilters | undefined;
+      accountsList?: import("@layerfi/components/hooks/useBankTransactions/types").AccountItem[] | undefined;
+      display: DisplayState;
+      categorize: (id: string, newCategory: import("@layerfi/components/types").CategoryUpdate, notify?: boolean | undefined) => Promise<void>;
+      match: (id: string, matchId: string, notify?: boolean | undefined) => Promise<void>;
+      updateOneLocal: (bankTransaction: import("@layerfi/components/types").BankTransaction) => void;
+      refetch: () => void;
+      setFilters: (filters?: Partial<import("@layerfi/components/hooks/useBankTransactions/types").BankTransactionFilters> | undefined) => void;
+      activate: () => void;
+  };
+
+}
+declare module '@layerfi/components/contexts/BankTransactionsContext/index' {
+  export { BankTransactionsContext, useBankTransactionsContext } from '@layerfi/components/contexts/BankTransactionsContext/BankTransactionsContext';
+
 }
 declare module '@layerfi/components/contexts/ChartOfAccountsContext/ChartOfAccountsContext' {
   /// <reference types="react" />
@@ -2662,10 +2712,13 @@ declare module '@layerfi/components/contexts/LayerContext/LayerContext' {
   export const LayerContext: import("react").Context<LayerContextValues & LayerContextHelpers & {
       setTheme: (theme: LayerThemeConfig) => void;
   }>;
+  export const useLayerContext: () => LayerContextValues & LayerContextHelpers & {
+      setTheme: (theme: LayerThemeConfig) => void;
+  };
 
 }
 declare module '@layerfi/components/contexts/LayerContext/index' {
-  export { LayerContext } from '@layerfi/components/contexts/LayerContext/LayerContext';
+  export { LayerContext, useLayerContext } from '@layerfi/components/contexts/LayerContext/LayerContext';
 
 }
 declare module '@layerfi/components/contexts/LedgerAccountsContext/LedgerAccountsContext' {
@@ -2758,23 +2811,61 @@ declare module '@layerfi/components/hooks/useBankTransactions/index' {
   export { useBankTransactions } from '@layerfi/components/hooks/useBankTransactions/useBankTransactions';
 
 }
-declare module '@layerfi/components/hooks/useBankTransactions/useBankTransactions' {
-  import { BankTransaction, CategoryUpdate, Metadata } from '@layerfi/components/types';
+declare module '@layerfi/components/hooks/useBankTransactions/types' {
+  import { BankTransaction, CategorizationScope, CategoryUpdate, DateRange, Direction, Metadata } from '@layerfi/components/types';
   import { LoadedStatus } from '@layerfi/components/types/general';
-  type UseBankTransactions = () => {
+  export interface NumericRangeFilter {
+      min?: number;
+      max?: number;
+  }
+  export interface AccountItem {
+      id: string;
+      name: string;
+  }
+  export enum DisplayState {
+      review = "review",
+      categorized = "categorized"
+  }
+  export interface BankTransactionFilters {
+      amount?: NumericRangeFilter;
+      account?: string[];
+      direction?: Direction[];
+      categorizationStatus?: CategorizationScope;
+      dateRange?: Partial<DateRange>;
+  }
+  export type UseBankTransactions = () => {
       data?: BankTransaction[];
       metadata: Metadata;
       loadingStatus: LoadedStatus;
       isLoading: boolean;
       isValidating: boolean;
       error: unknown;
+      filters?: BankTransactionFilters;
+      accountsList?: AccountItem[];
+      display: DisplayState;
       categorize: (id: BankTransaction['id'], newCategory: CategoryUpdate, notify?: boolean) => Promise<void>;
       match: (id: BankTransaction['id'], matchId: BankTransaction['id'], notify?: boolean) => Promise<void>;
       updateOneLocal: (bankTransaction: BankTransaction) => void;
       refetch: () => void;
+      setFilters: (filters?: Partial<BankTransactionFilters>) => void;
+      activate: () => void;
   };
+
+}
+declare module '@layerfi/components/hooks/useBankTransactions/useBankTransactions' {
+  import { UseBankTransactions } from '@layerfi/components/hooks/useBankTransactions/types';
   export const useBankTransactions: UseBankTransactions;
-  export {};
+
+}
+declare module '@layerfi/components/hooks/useBankTransactions/utils' {
+  import { BankTransaction, CategorizationScope, DateRange, Direction } from '@layerfi/components/types';
+  import { AccountItem, NumericRangeFilter } from '@layerfi/components/hooks/useBankTransactions/types';
+  export const collectAccounts: (transactions?: BankTransaction[]) => AccountItem[];
+  export const applyAmountFilter: (data?: BankTransaction[], filter?: NumericRangeFilter) => BankTransaction[] | undefined;
+  export const applyAccountFilter: (data?: BankTransaction[], filter?: string[]) => BankTransaction[] | undefined;
+  export const applyDirectionFilter: (data?: BankTransaction[], filter?: Direction[]) => BankTransaction[] | undefined;
+  export const applyCategorizationStatusFilter: (data?: BankTransaction[], filter?: CategorizationScope) => BankTransaction[] | undefined;
+  export const appplyDateRangeFilter: (data?: BankTransaction[], filter?: Partial<DateRange>) => BankTransaction[] | undefined;
 
 }
 declare module '@layerfi/components/hooks/useChartOfAccounts/index' {
@@ -2903,16 +2994,6 @@ declare module '@layerfi/components/hooks/useJournal/useJournal' {
   export const useJournal: UseJournal;
   export {};
 
-}
-declare module '@layerfi/components/hooks/useLayerContext/index' {
-  export { useLayerContext } from '@layerfi/components/hooks/useLayerContext/useLayerContext';
-
-}
-declare module '@layerfi/components/hooks/useLayerContext/useLayerContext' {
-  export const useLayerContext: () => import("@layerfi/components/types").LayerContextValues & import("../../types").LayerContextHelpers & {
-      setTheme: (theme: import("@layerfi/components/types/layer_context").LayerThemeConfig) => void;
-  };
-
 }
 declare module '@layerfi/components/hooks/useLedgerAccounts/index' {
   export { useLedgerAccounts } from '@layerfi/components/hooks/useLedgerAccounts/useLedgerAccounts';
@@ -3383,6 +3464,7 @@ declare module '@layerfi/components/icons/types' {
 
 }
 declare module '@layerfi/components/index' {
+  export { LayerProvider } from '@layerfi/components/providers/LayerProvider/index';
   export { BalanceSheet } from '@layerfi/components/components/BalanceSheet/index';
   export { BankTransactions } from '@layerfi/components/components/BankTransactions/index';
   export { Hello } from '@layerfi/components/components/Hello/index';
@@ -3390,8 +3472,6 @@ declare module '@layerfi/components/index' {
   export { ProfitAndLoss } from '@layerfi/components/components/ProfitAndLoss/index';
   export { ProfitAndLossView } from '@layerfi/components/components/ProfitAndLossView/index';
   export { ChartOfAccounts } from '@layerfi/components/components/ChartOfAccounts/index';
-  export { LayerProvider } from '@layerfi/components/providers/LayerProvider/index';
-  export { useLayerContext } from '@layerfi/components/hooks/useLayerContext/index';
   export { Journal } from '@layerfi/components/components/Journal/index';
   export { Onboarding } from '@layerfi/components/components/Onboarding/index';
   export { Tasks } from '@layerfi/components/components/Tasks/index';
@@ -3399,6 +3479,8 @@ declare module '@layerfi/components/index' {
   export { BankTransactionsWithLinkedAccounts } from '@layerfi/components/views/BankTransactionsWithLinkedAccounts/index';
   export { Reports } from '@layerfi/components/views/Reports/index';
   export { GeneralLedgerView } from '@layerfi/components/views/GeneralLedger/index';
+  export { useLayerContext } from '@layerfi/components/contexts/LayerContext/index';
+  export { useBankTransactionsContext } from '@layerfi/components/contexts/BankTransactionsContext/index';
 
 }
 declare module '@layerfi/components/models/APIError' {
@@ -3425,6 +3507,19 @@ declare module '@layerfi/components/models/Money' {
   };
   export default _default;
 
+}
+declare module '@layerfi/components/providers/BankTransactionsProvider/BankTransactionsProvider' {
+  import React, { ReactNode } from 'react';
+  interface BankTransactionsProviderProps {
+      children: ReactNode;
+  }
+  export const BankTransactionsProvider: ({ children, }: BankTransactionsProviderProps) => React.JSX.Element;
+  export {};
+
+}
+declare module '@layerfi/components/providers/BankTransactionsProvider/index' {
+  export { BankTransactionsProvider } from '@layerfi/components/providers/BankTransactionsProvider/BankTransactionsProvider';
+
 }
 declare module '@layerfi/components/providers/LayerProvider/LayerProvider' {
   import React, { PropsWithChildren } from 'react';
@@ -3589,6 +3684,10 @@ declare module '@layerfi/components/types/categories' {
       JOURNALING = "JOURNALING",
       MATCHED = "MATCHED"
   }
+  export enum CategorizationScope {
+      TO_REVIEW = "TO_REVIEW",
+      CATEGORIZED = "CATEGORIZED"
+  }
   export interface CategoryEntry {
       amount?: number;
       category: Category;
@@ -3617,17 +3716,21 @@ declare module '@layerfi/components/types/categories' {
       suggestions: Category[];
   }
   export type Categorization = AutoCategorization | SuggestedCategorization;
+  export type CategoryPayloadObject = {
+      type: 'StableName';
+      stable_name: string;
+  } | {
+      type: 'AccountId';
+      id: string;
+  };
   export type SingleCategoryUpdate = {
       type: 'Category';
-      category: {
-          type: 'StableName';
-          stable_name: string;
-      };
+      category: CategoryPayloadObject;
   };
   export type SplitCategoryUpdate = {
       type: 'Split';
       entries: {
-          category: string;
+          category: string | CategoryPayloadObject;
           amount: number;
       }[];
   };
@@ -3795,6 +3898,7 @@ declare module '@layerfi/components/types/layer_context' {
       getColor: (shade: number) => ColorsPaletteOption | undefined;
       setLightColor: (color?: ColorConfig) => void;
       setDarkColor: (color?: ColorConfig) => void;
+      setTextColor: (color?: ColorConfig) => void;
       setColors: (colors?: LayerThemeConfigColors) => void;
       setOnboardingStep: (value: OnboardingStep) => void;
       addToast: (toast: ToastProps) => void;
@@ -3833,6 +3937,7 @@ declare module '@layerfi/components/types/layer_context' {
   export interface LayerThemeConfigColors {
       dark?: ColorConfig;
       light?: ColorConfig;
+      text?: ColorConfig;
   }
   export interface LayerThemeConfig {
       colors?: LayerThemeConfigColors;
@@ -4107,7 +4212,7 @@ declare module '@layerfi/components/types' {
   export { LineItem } from '@layerfi/components/types/line_item';
   export { BalanceSheet } from '@layerfi/components/types/balance_sheet';
   export { Direction, BankTransaction } from '@layerfi/components/types/bank_transactions';
-  export { CategorizationStatus, Category, CategorizationType, AutoCategorization, SuggestedCategorization, SingleCategoryUpdate, SplitCategoryUpdate, CategoryUpdate, } from '@layerfi/components/types/categories';
+  export { CategorizationStatus, CategorizationScope, Category, CategorizationType, AutoCategorization, SuggestedCategorization, SingleCategoryUpdate, SplitCategoryUpdate, CategoryUpdate, } from '@layerfi/components/types/categories';
   export { ChartOfAccounts, Account, NewAccount, EditAccount, } from '@layerfi/components/types/chart_of_accounts';
   export { LedgerAccountLineItems as LedgerAccounts, LedgerAccountLineItem, LedgerAccountsAccount, LedgerAccountsEntry, } from '@layerfi/components/types/ledger_accounts';
   export { SortDirection } from '@layerfi/components/types/general';
@@ -4128,10 +4233,24 @@ declare module '@layerfi/components/types' {
 
 }
 declare module '@layerfi/components/utils/bankTransactions' {
+  import { CategoryOption } from '@layerfi/components/components/CategorySelect/CategorySelect';
   import { BankTransaction } from '@layerfi/components/types';
   export const hasMatch: (bankTransaction?: BankTransaction) => boolean;
   export const isCredit: ({ direction }: Pick<BankTransaction, 'direction'>) => boolean;
   export const isAlreadyMatched: (bankTransaction?: BankTransaction) => string | undefined;
+  export const countTransactionsToReview: ({ transactions, currentMonthOnly, }: {
+      transactions?: BankTransaction[] | undefined;
+      currentMonthOnly?: boolean | undefined;
+  }) => number;
+  export const getCategorizePayload: (category: CategoryOption) => {
+      type: "AccountId";
+      id: string;
+      stable_name?: undefined;
+  } | {
+      type: "StableName";
+      stable_name: string;
+      id?: undefined;
+  };
 
 }
 declare module '@layerfi/components/utils/business' {
@@ -4214,14 +4333,16 @@ declare module '@layerfi/components/views/AccountingOverview/index' {
 }
 declare module '@layerfi/components/views/BankTransactionsWithLinkedAccounts/BankTransactionsWithLinkedAccounts' {
   import React from 'react';
+  import { MobileComponentType } from "@layerfi/components/components/BankTransactions/constants";
   export interface BankTransactionsWithLinkedAccountsProps {
       title?: string;
       elevatedLinkedAccounts?: boolean;
       showLedgerBalance?: boolean;
       showDescriptions?: boolean;
       showReceiptUploads?: boolean;
+      mobileComponent?: MobileComponentType;
   }
-  export const BankTransactionsWithLinkedAccounts: ({ title, elevatedLinkedAccounts, showLedgerBalance, showDescriptions, showReceiptUploads, }: BankTransactionsWithLinkedAccountsProps) => React.JSX.Element;
+  export const BankTransactionsWithLinkedAccounts: ({ title, elevatedLinkedAccounts, showLedgerBalance, showDescriptions, showReceiptUploads, mobileComponent, }: BankTransactionsWithLinkedAccountsProps) => React.JSX.Element;
 
 }
 declare module '@layerfi/components/views/BankTransactionsWithLinkedAccounts/index' {