@layerfi/components 0.1.55 → 0.1.56

package/dist/index.d.ts

@@ -308,13 +308,20 @@ declare module '@layerfi/components/api/layer/linked_accounts' {
 declare module '@layerfi/components/api/layer/profit_and_loss' {
   import { ProfitAndLoss } from '@layerfi/components/types';
   import { S3PresignedUrl } from '@layerfi/components/types/general';
-  import { ProfitAndLossSummaries } from '@layerfi/components/types/profit_and_loss';
+  import { ProfitAndLossComparison, ProfitAndLossSummaries } from '@layerfi/components/types/profit_and_loss';
   export const getProfitAndLoss: (baseUrl: string, accessToken: string | undefined, options?: {
       params?: Record<string, string | undefined> | undefined;
   } | undefined) => () => Promise<{
       data?: ProfitAndLoss | undefined;
       error?: unknown;
   }>;
+  export const compareProfitAndLoss: (baseUrl: string, accessToken: string | undefined, options?: {
+      params?: Record<string, string | undefined> | undefined;
+      body?: Record<string, unknown> | undefined;
+  } | undefined) => Promise<{
+      data?: ProfitAndLossComparison | undefined;
+      error?: unknown;
+  }>;
   export const getProfitAndLossSummaries: (baseUrl: string, accessToken: string | undefined, options?: {
       params?: Record<string, string | undefined> | undefined;
   } | undefined) => () => Promise<{
@@ -554,6 +561,13 @@ declare module '@layerfi/components/api/layer' {
       } | undefined) => () => Promise<{
           data: import("@layerfi/components/types").JournalEntry[];
       }>;
+      compareProfitAndLoss: (baseUrl: string, accessToken: string | undefined, options?: {
+          params?: Record<string, string | undefined> | undefined;
+          body?: Record<string, unknown> | undefined;
+      } | undefined) => Promise<{
+          data?: import("@layerfi/components/types/profit_and_loss").ProfitAndLossComparison | undefined;
+          error?: unknown;
+      }>;
       createJournalEntries: (baseUrl: string, accessToken: string | undefined, options?: {
           params?: Record<string, string | undefined> | undefined;
           body?: Record<string, unknown> | undefined;
@@ -744,6 +758,7 @@ declare module '@layerfi/components/components/Badge/Badge' {
   }
   export enum BadgeVariant {
       DEFAULT = "default",
+      INFO = "info",
       SUCCESS = "success",
       WARNING = "warning",
       ERROR = "error"
@@ -1342,6 +1357,20 @@ declare module '@layerfi/components/components/Button/SubmitButton' {
   }
   export const SubmitButton: ({ active, className, processing, disabled, error, children, action, noIcon, ...props }: SubmitButtonProps) => React.JSX.Element;
 
+}
+declare module '@layerfi/components/components/Button/SwitchButton' {
+  import React from 'react';
+  interface SwitchButtonProps {
+      children: string;
+      labelPosition?: 'left' | 'right';
+      checked?: boolean;
+      defaultChecked?: boolean;
+      onChange?: (checked: boolean) => void;
+      disabled?: boolean;
+  }
+  export const SwitchButton: React.FC<SwitchButtonProps>;
+  export {};
+
 }
 declare module '@layerfi/components/components/Button/TextButton' {
   import React, { ButtonHTMLAttributes } from 'react';
@@ -1358,6 +1387,7 @@ declare module '@layerfi/components/components/Button/index' {
   export { BackButton } from '@layerfi/components/components/Button/BackButton';
   export { CloseButton } from '@layerfi/components/components/Button/CloseButton';
   export { ExpandButton } from '@layerfi/components/components/Button/ExpandButton';
+  export { SwitchButton } from '@layerfi/components/components/Button/SwitchButton';
   export { Link } from '@layerfi/components/components/Button/Link';
 
 }
@@ -1411,6 +1441,7 @@ declare module '@layerfi/components/components/CategorySelect/CategorySelect' {
       payload: CategoryOptionPayload;
   }
   export const mapCategoryToOption: (category: Category) => CategoryOption;
+  export const mapCategoryToExclusionOption: (category: Category) => CategoryOption;
   export const mapSuggestedMatchToOption: (record: SuggestedMatch) => CategoryOption;
   export const CategorySelect: ({ bankTransaction, name, value, onChange, disabled, className, excludeMatches, asDrawer, }: Props) => React.JSX.Element;
   export {};
@@ -1869,6 +1900,25 @@ declare module '@layerfi/components/components/Input/InputWithBadge' {
   }
   export const InputWithBadge: ({ className, isInvalid, errorMessage, leftText, badge, variant, ...props }: InputWithBadgeProps) => React.JSX.Element;
 
+}
+declare module '@layerfi/components/components/Input/MultiSelect' {
+  import React from 'react';
+  import { GroupBase, MultiValue, OptionsOrGroups } from 'react-select';
+  export interface SelectProps<T> {
+      name?: string;
+      options?: OptionsOrGroups<T, GroupBase<T>>;
+      className?: string;
+      classNamePrefix?: string;
+      value?: T[];
+      defaultValue?: T[];
+      onChange: (selected: MultiValue<T>) => void;
+      disabled?: boolean;
+      placeholder?: string;
+      isInvalid?: boolean;
+      errorMessage?: string;
+  }
+  export const MultiSelect: <T>({ name, options, className, classNamePrefix, value, defaultValue, onChange, disabled, placeholder, isInvalid, errorMessage, }: SelectProps<T>) => React.JSX.Element;
+
 }
 declare module '@layerfi/components/components/Input/Select' {
   import React from 'react';
@@ -1894,6 +1944,7 @@ declare module '@layerfi/components/components/Input/index' {
   export { FileInput } from '@layerfi/components/components/Input/FileInput';
   export { Select } from '@layerfi/components/components/Input/Select';
   export { InputWithBadge } from '@layerfi/components/components/Input/InputWithBadge';
+  export { MultiSelect } from '@layerfi/components/components/Input/MultiSelect';
 
 }
 declare module '@layerfi/components/components/Journal/Journal' {
@@ -2378,7 +2429,21 @@ declare module '@layerfi/components/components/ProfitAndLoss/ProfitAndLoss' {
           sortBy: (scope: import("@layerfi/components/hooks/useProfitAndLoss/useProfitAndLoss").Scope, field: string, direction?: import("../../types").SortDirection | undefined) => void;
           setFilterTypes: (scope: import("@layerfi/components/hooks/useProfitAndLoss/useProfitAndLoss").Scope, types: string[]) => void;
       }>;
+      ComparisonContext: React.Context<{
+          data: import("@layerfi/components/types/profit_and_loss").ProfitAndLossComparisonItem[] | undefined;
+          isLoading: boolean;
+          isValidating: boolean;
+          error: unknown;
+          compareMode: boolean;
+          setCompareMode: (mode: boolean) => void;
+          compareMonths: number;
+          setCompareMonths: (months: number) => void;
+          compareOptions: import("@layerfi/components/components/ProfitAndLossCompareOptions/ProfitAndLossCompareOptions").TagComparisonOption[];
+          setCompareOptions: (options: import("@layerfi/components/components/ProfitAndLossCompareOptions/ProfitAndLossCompareOptions").TagComparisonOption[]) => void;
+          refetch: (dateRange: import("@layerfi/components/types").DateRange, actAsInitial?: boolean | undefined) => void;
+      }>;
       DatePicker: () => React.JSX.Element;
+      CompareOptions: ({ tagComparisonOptions, defaultTagFilter: defaultOption, }: import("@layerfi/components/components/ProfitAndLossCompareOptions/ProfitAndLossCompareOptions").ProfitAndLossCompareOptionsProps) => React.JSX.Element;
       Summaries: ({ vertical, actionable, revenueLabel, stringOverrides, }: {
           vertical?: boolean | undefined;
           actionable?: boolean | undefined;
@@ -2393,6 +2458,7 @@ declare module '@layerfi/components/components/ProfitAndLoss/ProfitAndLoss' {
           chartColorsList?: string[] | undefined;
           stringOverrides?: import("@layerfi/components/components/ProfitAndLossDetailedCharts/ProfitAndLossDetailedCharts").ProfitAndLossDetailedChartsStringOverrides | undefined;
       }) => React.JSX.Element;
+      Header: ({ text, className, headingClassName, withDatePicker, }: import("@layerfi/components/components/ProfitAndLossHeader/ProfitAndLossHeader").ProfitAndLossHeaderProps) => React.JSX.Element;
   };
   export { ProfitAndLoss };
 
@@ -2400,6 +2466,11 @@ declare module '@layerfi/components/components/ProfitAndLoss/ProfitAndLoss' {
 declare module '@layerfi/components/components/ProfitAndLoss/index' {
   export { ProfitAndLoss } from '@layerfi/components/components/ProfitAndLoss/ProfitAndLoss';
 
+}
+declare module '@layerfi/components/components/ProfitAndLossChart/ChartStateCard' {
+  import React from 'react';
+  export const ChartStateCard: () => React.JSX.Element;
+
 }
 declare module '@layerfi/components/components/ProfitAndLossChart/Indicator' {
   import React from 'react';
@@ -2428,6 +2499,31 @@ declare module '@layerfi/components/components/ProfitAndLossChart/ProfitAndLossC
 declare module '@layerfi/components/components/ProfitAndLossChart/index' {
   export { ProfitAndLossChart } from '@layerfi/components/components/ProfitAndLossChart/ProfitAndLossChart';
 
+}
+declare module '@layerfi/components/components/ProfitAndLossCompareOptions/ProfitAndLossCompareOptions' {
+  import React from 'react';
+  export interface ProfitAndLossCompareOptionsProps {
+      tagComparisonOptions: TagComparisonOption[];
+      defaultTagFilter: TagComparisonOption;
+  }
+  export interface TagComparisonOption {
+      displayName: string;
+      tagFilterConfig: TagViewConfig;
+  }
+  export type TagViewConfig = {
+      structure?: string;
+      tagFilters: TagFilterInput;
+  };
+  export type TagFilterInput = {
+      tagKey: string;
+      tagValues: string[];
+  } | 'None';
+  export const ProfitAndLossCompareOptions: ({ tagComparisonOptions, defaultTagFilter: defaultOption, }: ProfitAndLossCompareOptionsProps) => React.JSX.Element;
+
+}
+declare module '@layerfi/components/components/ProfitAndLossCompareOptions/index' {
+  export { ProfitAndLossCompareOptions } from '@layerfi/components/components/ProfitAndLossCompareOptions/ProfitAndLossCompareOptions';
+
 }
 declare module '@layerfi/components/components/ProfitAndLossDatePicker/ProfitAndLossDatePicker' {
   import React from 'react';
@@ -2516,6 +2612,21 @@ declare module '@layerfi/components/components/ProfitAndLossDetailedCharts/Profi
 declare module '@layerfi/components/components/ProfitAndLossDetailedCharts/index' {
   export { ProfitAndLossDetailedCharts } from '@layerfi/components/components/ProfitAndLossDetailedCharts/ProfitAndLossDetailedCharts';
 
+}
+declare module '@layerfi/components/components/ProfitAndLossHeader/ProfitAndLossHeader' {
+  import React from 'react';
+  export interface ProfitAndLossHeaderProps {
+      text?: string;
+      className?: string;
+      headingClassName?: string;
+      withDatePicker?: boolean;
+  }
+  export const ProfitAndLossHeader: ({ text, className, headingClassName, withDatePicker, }: ProfitAndLossHeaderProps) => React.JSX.Element;
+
+}
+declare module '@layerfi/components/components/ProfitAndLossHeader/index' {
+  export { ProfitAndLossHeader } from '@layerfi/components/components/ProfitAndLossHeader/ProfitAndLossHeader';
+
 }
 declare module '@layerfi/components/components/ProfitAndLossSummaries/MiniChart' {
   import React from 'react';
@@ -2546,6 +2657,16 @@ declare module '@layerfi/components/components/ProfitAndLossSummaries/ProfitAndL
 declare module '@layerfi/components/components/ProfitAndLossSummaries/index' {
   export { ProfitAndLossSummaries } from '@layerfi/components/components/ProfitAndLossSummaries/ProfitAndLossSummaries';
 
+}
+declare module '@layerfi/components/components/ProfitAndLossTable/ProfitAndLossCompareTable' {
+  import React from 'react';
+  import { ProfitAndLossTableStringOverrides } from '@layerfi/components/components/ProfitAndLossTable/ProfitAndLossTableComponent';
+  interface ProfilAndLostCompareTableProps {
+      stringOverrides?: ProfitAndLossTableStringOverrides;
+  }
+  export const ProfitAndLossCompareTable: ({ stringOverrides, }: ProfilAndLostCompareTableProps) => React.JSX.Element;
+  export {};
+
 }
 declare module '@layerfi/components/components/ProfitAndLossTable/ProfitAndLossTableComponent' {
   import React from 'react';
@@ -2701,6 +2822,15 @@ declare module '@layerfi/components/components/StatementOfCashFlowTable/Statemen
 declare module '@layerfi/components/components/StatementOfCashFlowTable/index' {
   export { StatementOfCashFlowTable } from '@layerfi/components/components/StatementOfCashFlowTable/StatementOfCashFlowTable';
 
+}
+declare module '@layerfi/components/components/SyncingBadge/SyncingBadge' {
+  import React from 'react';
+  export const SyncingBadge: () => React.JSX.Element;
+
+}
+declare module '@layerfi/components/components/SyncingBadge/index' {
+  export { SyncingBadge } from '@layerfi/components/components/SyncingBadge/SyncingBadge';
+
 }
 declare module '@layerfi/components/components/SyncingComponent/SyncingComponent' {
   import React from 'react';
@@ -3536,6 +3666,29 @@ declare module '@layerfi/components/contexts/LinkedAccountsContext/LinkedAccount
 declare module '@layerfi/components/contexts/LinkedAccountsContext/index' {
   export { LinkedAccountsContext } from '@layerfi/components/contexts/LinkedAccountsContext/LinkedAccountsContext';
 
+}
+declare module '@layerfi/components/contexts/ProfitAndLossComparisonContext/ProfitAndLossComparisonContext' {
+  /// <reference types="react" />
+  import { TagComparisonOption } from '@layerfi/components/components/ProfitAndLossCompareOptions/ProfitAndLossCompareOptions';
+  import { DateRange } from '@layerfi/components/types';
+  export const PNLComparisonContext: import("react").Context<{
+      data: import("@layerfi/components/types/profit_and_loss").ProfitAndLossComparisonItem[] | undefined;
+      isLoading: boolean;
+      isValidating: boolean;
+      error: unknown;
+      compareMode: boolean;
+      setCompareMode: (mode: boolean) => void;
+      compareMonths: number;
+      setCompareMonths: (months: number) => void;
+      compareOptions: TagComparisonOption[];
+      setCompareOptions: (options: TagComparisonOption[]) => void;
+      refetch: (dateRange: DateRange, actAsInitial?: boolean | undefined) => void;
+  }>;
+
+}
+declare module '@layerfi/components/contexts/ProfitAndLossComparisonContext/index' {
+  export { PNLComparisonContext } from '@layerfi/components/contexts/ProfitAndLossComparisonContext/ProfitAndLossComparisonContext';
+
 }
 declare module '@layerfi/components/contexts/StatementOfCashContext/StatementOfCashFlowContext' {
   /// <reference types="react" />
@@ -3656,12 +3809,13 @@ declare module '@layerfi/components/hooks/useBankTransactions/useBankTransaction
 
 }
 declare module '@layerfi/components/hooks/useBankTransactions/utils' {
-  import { BankTransaction } from '@layerfi/components/types';
+  import { BankTransaction, DisplayState } from '@layerfi/components/types';
   import { AccountItem, NumericRangeFilter } from '@layerfi/components/hooks/useBankTransactions/types';
   export const collectAccounts: (transactions?: BankTransaction[]) => AccountItem[];
   export const uniqAccountsList: (arr: AccountItem[], track?: Set<unknown>) => AccountItem[];
   export const applyAmountFilter: (data?: BankTransaction[], filter?: NumericRangeFilter) => BankTransaction[] | undefined;
   export const applyAccountFilter: (data?: BankTransaction[], filter?: string[]) => BankTransaction[] | undefined;
+  export const applyCategorizationStatusFilter: (data?: BankTransaction[], filter?: DisplayState) => BankTransaction[] | undefined;
 
 }
 declare module '@layerfi/components/hooks/useChartOfAccounts/index' {
@@ -3989,6 +4143,36 @@ declare module '@layerfi/components/hooks/useProfitAndLoss/useProfitAndLossQuery
   export const useProfitAndLossQuery: UseProfitAndLossQueryReturn;
   export {};
 
+}
+declare module '@layerfi/components/hooks/useProfitAndLossComparison/index' {
+  export { useProfitAndLossComparison } from '@layerfi/components/hooks/useProfitAndLossComparison/useProfitAndLossComparison';
+
+}
+declare module '@layerfi/components/hooks/useProfitAndLossComparison/useProfitAndLossComparison' {
+  import { TagComparisonOption } from '@layerfi/components/components/ProfitAndLossCompareOptions/ProfitAndLossCompareOptions';
+  import { DateRange, ReportingBasis } from '@layerfi/components/types';
+  import { ProfitAndLossComparisonItem } from '@layerfi/components/types/profit_and_loss';
+  export type Scope = 'expenses' | 'revenue';
+  export type SidebarScope = Scope | undefined;
+  type Props = {
+      reportingBasis?: ReportingBasis;
+  };
+  type UseProfitAndLossComparison = (props: Props) => {
+      data: ProfitAndLossComparisonItem[] | undefined;
+      isLoading: boolean;
+      isValidating: boolean;
+      error: unknown;
+      compareMode: boolean;
+      setCompareMode: (mode: boolean) => void;
+      compareMonths: number;
+      setCompareMonths: (months: number) => void;
+      compareOptions: TagComparisonOption[];
+      setCompareOptions: (options: TagComparisonOption[]) => void;
+      refetch: (dateRange: DateRange, actAsInitial?: boolean) => void;
+  };
+  export const useProfitAndLossComparison: UseProfitAndLossComparison;
+  export {};
+
 }
 declare module '@layerfi/components/hooks/useQuickbooks/index' {
   export { useQuickbooks } from '@layerfi/components/hooks/useQuickbooks/useQuickbooks';
@@ -4092,6 +4276,13 @@ declare module '@layerfi/components/icons/BackArrow' {
   const BackArrow: ({ size, ...props }: IconSvgProps) => React.JSX.Element;
   export default BackArrow;
 
+}
+declare module '@layerfi/components/icons/BarChart2' {
+  import * as React from 'react';
+  import { IconSvgProps } from '@layerfi/components/icons/types';
+  const BarChart2: ({ size, ...props }: IconSvgProps) => React.JSX.Element;
+  export default BarChart2;
+
 }
 declare module '@layerfi/components/icons/Bell' {
   import * as React from 'react';
@@ -4612,6 +4803,7 @@ declare module '@layerfi/components/types/categories' {
       MATCHED = "MATCHED"
   }
   export interface CategoryEntry {
+      type?: string;
       amount?: number;
       category: Category;
   }
@@ -5131,6 +5323,39 @@ declare module '@layerfi/components/types/profit_and_loss' {
       personal_expenses?: LineItem | null;
       fully_categorized: boolean;
   }
+  export interface ProfitAndLossComparison {
+      type: string;
+      pnls: ProfitAndLossComparisonItem[];
+  }
+  export interface ProfitAndLossComparisonPnl {
+      business_id: string;
+      start_date: string;
+      end_date: string;
+      income: LineItem;
+      cost_of_goods_sold: LineItem;
+      gross_profit: number;
+      expenses: LineItem;
+      profit_before_taxes: number;
+      taxes: LineItem;
+      net_profit: number;
+      other_outflows?: LineItem | null;
+      personal_expenses?: LineItem | null;
+      fully_categorized: boolean;
+  }
+  export interface ProfitAndLossComparisonItem {
+      period: {
+          type: string;
+          year?: number;
+          month?: number;
+          start_date?: string;
+          end_date?: string;
+      };
+      tag_filter?: {
+          key: string;
+          values: string[];
+      };
+      pnl: ProfitAndLossComparisonPnl;
+  }
   export interface ProfitAndLossSummary {
       year: number;
       month: number;
@@ -5355,6 +5580,13 @@ declare module '@layerfi/components/utils/journal' {
   import { JournalEntryLineItem } from '@layerfi/components/types/journal';
   export const getAccountIdentifierPayload: (journalLineItem: JournalEntryLineItem) => AccountIdentifierPayloadObject;
 
+}
+declare module '@layerfi/components/utils/profitAndLossComparisonUtils' {
+  import { LineItem } from '@layerfi/components/types';
+  export const generatComparisonMonths: (startDate: number | Date, numberOfMonths: number) => string[];
+  export const getComparisonValue: (name: string, depth: number, cellData: string | number | LineItem) => string | number;
+  export const mergeComparisonLineItemsAtDepth: (lineItems: LineItem[]) => LineItem[];
+
 }
 declare module '@layerfi/components/utils/profitAndLossUtils' {
   import { SidebarScope } from '@layerfi/components/hooks/useProfitAndLoss/useProfitAndLoss';
@@ -5471,6 +5703,7 @@ declare module '@layerfi/components/views/GeneralLedger/index' {
 declare module '@layerfi/components/views/Reports/Reports' {
   import React, { RefObject } from 'react';
   import { BalanceSheetStringOverrides } from '@layerfi/components/components/BalanceSheet/BalanceSheet';
+  import { ProfitAndLossCompareOptionsProps } from '@layerfi/components/components/ProfitAndLossCompareOptions/ProfitAndLossCompareOptions';
   import { ProfitAndLossDetailedChartsStringOverrides } from '@layerfi/components/components/ProfitAndLossDetailedCharts/ProfitAndLossDetailedCharts';
   import { ProfitAndLossTableStringOverrides } from '@layerfi/components/components/ProfitAndLossTable/index';
   import { StatementOfCashFlowStringOverrides } from '@layerfi/components/components/StatementOfCashFlow/StatementOfCashFlow';
@@ -5488,18 +5721,20 @@ declare module '@layerfi/components/views/Reports/Reports' {
       title?: string;
       stringOverrides?: ReportsStringOverrides;
       enabledReports?: ReportType[];
+      comparisonConfig: ProfitAndLossCompareOptionsProps;
   }
   type ReportType = 'profitAndLoss' | 'balanceSheet' | 'statementOfCashFlow';
   export interface ReportsPanelProps {
       containerRef: RefObject<HTMLDivElement>;
       openReport: ReportType;
       stringOverrides?: ReportsStringOverrides;
+      comparisonConfig: ProfitAndLossCompareOptionsProps;
   }
   interface DownloadButtonStringOverrides {
       downloadButtonText?: string;
       retryButtonText?: string;
   }
-  export const Reports: ({ title, stringOverrides, enabledReports, }: ReportsProps) => React.JSX.Element;
+  export const Reports: ({ title, stringOverrides, enabledReports, comparisonConfig, }: ReportsProps) => React.JSX.Element;
   export {};
 
 }