@layerfi/components 0.1.6 → 0.1.7

package/dist/index.d.ts

@@ -691,12 +691,30 @@ declare module '@layerfi/components/components/ProfitAndLoss/ProfitAndLoss' {
       Chart: () => React.JSX.Element;
       Context: React.Context<{
           data: import("@layerfi/components/types").ProfitAndLoss | undefined;
+          filteredData: import("@layerfi/components/types/line_item").LineBaseItem[];
+          filteredTotal?: number | undefined;
           isLoading: boolean;
           isValidating: boolean;
           error: unknown;
           dateRange: import("@layerfi/components/types").DateRange;
           changeDateRange: (dateRange: Partial<import("@layerfi/components/types").DateRange>) => void;
           refetch: () => void;
+          sidebarScope: import("@layerfi/components/hooks/useProfitAndLoss/useProfitAndLoss").SidebarScope;
+          setSidebarScope: (view: import("@layerfi/components/hooks/useProfitAndLoss/useProfitAndLoss").SidebarScope) => void;
+          filters: {
+              expenses: {
+                  sortBy?: string | undefined;
+                  sortDirection?: import("@layerfi/components/types").SortDirection | undefined;
+                  types?: string[] | undefined;
+              } | undefined;
+              revenue: {
+                  sortBy?: string | undefined;
+                  sortDirection?: import("@layerfi/components/types").SortDirection | undefined;
+                  types?: string[] | undefined;
+              } | undefined;
+          };
+          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;
       }>;
       DatePicker: () => React.JSX.Element;
       Summaries: ({ vertical, revenueLabel, }: {
@@ -742,6 +760,15 @@ declare module '@layerfi/components/components/ProfitAndLossDatePicker/ProfitAnd
 declare module '@layerfi/components/components/ProfitAndLossDatePicker/index' {
   export { ProfitAndLossDatePicker } from '@layerfi/components/components/ProfitAndLossDatePicker/ProfitAndLossDatePicker';
 
+}
+declare module '@layerfi/components/components/ProfitAndLossDetailedCharts/ProfitAndLossDetailedCharts' {
+  import React from 'react';
+  export const ProfitAndLossDetailedCharts: () => React.JSX.Element;
+
+}
+declare module '@layerfi/components/components/ProfitAndLossDetailedCharts/index' {
+  export { ProfitAndLossDetailedCharts } from '@layerfi/components/components/ProfitAndLossDetailedCharts/ProfitAndLossDetailedCharts';
+
 }
 declare module '@layerfi/components/components/ProfitAndLossRow/ProfitAndLossRow' {
   import React from 'react';
@@ -800,6 +827,7 @@ declare module '@layerfi/components/components/ProfitAndLossView/ProfitAndLossVi
   export interface ProfitAndLossViewProps {
       hideTable?: boolean;
       hideChart?: boolean;
+      showDetailedCharts?: boolean;
   }
   export const ProfitAndLossView: (props: ProfitAndLossViewProps) => React.JSX.Element;
 
@@ -1249,7 +1277,10 @@ declare module '@layerfi/components/hooks/useProfitAndLoss/index' {
 
 }
 declare module '@layerfi/components/hooks/useProfitAndLoss/useProfitAndLoss' {
-  import { ProfitAndLoss, DateRange, ReportingBasis } from '@layerfi/components/types';
+  import { ProfitAndLoss, DateRange, ReportingBasis, SortDirection } from '@layerfi/components/types';
+  import { LineBaseItem } from '@layerfi/components/types/line_item';
+  export type Scope = 'expenses' | 'revenue';
+  export type SidebarScope = Scope | undefined;
   type Props = {
       startDate?: Date;
       endDate?: Date;
@@ -1259,14 +1290,27 @@ declare module '@layerfi/components/hooks/useProfitAndLoss/useProfitAndLoss' {
       };
       reportingBasis?: ReportingBasis;
   };
+  type ProfitAndLossFilter = {
+      sortBy?: string;
+      sortDirection?: SortDirection;
+      types?: string[];
+  };
+  type ProfitAndLossFilters = Record<Scope, ProfitAndLossFilter | undefined>;
   type UseProfitAndLoss = (props?: Props) => {
       data: ProfitAndLoss | undefined;
+      filteredData: LineBaseItem[];
+      filteredTotal?: number;
       isLoading: boolean;
       isValidating: boolean;
       error: unknown;
       dateRange: DateRange;
       changeDateRange: (dateRange: Partial<DateRange>) => void;
       refetch: () => void;
+      sidebarScope: SidebarScope;
+      setSidebarScope: (view: SidebarScope) => void;
+      filters: ProfitAndLossFilters;
+      sortBy: (scope: Scope, field: string, direction?: SortDirection) => void;
+      setFilterTypes: (scope: Scope, types: string[]) => void;
   };
   export const useProfitAndLoss: UseProfitAndLoss;
   export {};
@@ -1383,6 +1427,13 @@ declare module '@layerfi/components/icons/ScissorsFullOpen' {
   const ScissorsFullOpen: ({ size, ...props }: IconSvgProps) => React.JSX.Element;
   export default ScissorsFullOpen;
 
+}
+declare module '@layerfi/components/icons/SortArrows' {
+  import * as React from 'react';
+  import { IconSvgProps } from '@layerfi/components/icons/types';
+  const SortArrows: ({ size, ...props }: IconSvgProps) => React.JSX.Element;
+  export default SortArrows;
+
 }
 declare module '@layerfi/components/icons/Trash' {
   import * as React from 'react';
@@ -1397,6 +1448,13 @@ declare module '@layerfi/components/icons/UploadCloud' {
   const UploadCloud: ({ size, ...props }: IconSvgProps) => React.JSX.Element;
   export default UploadCloud;
 
+}
+declare module '@layerfi/components/icons/X' {
+  import * as React from 'react';
+  import { IconSvgProps } from '@layerfi/components/icons/types';
+  const X: ({ size, ...props }: IconSvgProps) => React.JSX.Element;
+  export default X;
+
 }
 declare module '@layerfi/components/icons/types' {
   import { SVGProps } from 'react';
@@ -1658,6 +1716,10 @@ declare module '@layerfi/components/types/chart_of_accounts' {
       description: string;
   };
 
+}
+declare module '@layerfi/components/types/general' {
+  export type SortDirection = 'asc' | 'desc';
+
 }
 declare module '@layerfi/components/types/layer_context' {
   import { Category } from '@layerfi/components/types';
@@ -1738,6 +1800,15 @@ declare module '@layerfi/components/types/line_item' {
       display_name: string;
       value: number | undefined;
       line_items?: LineItem[] | null;
+      is_contra?: boolean;
+  }
+  export interface LineBaseItem {
+      name?: string;
+      display_name: string;
+      value: number;
+      type: string;
+      share?: number;
+      hidden?: boolean;
   }
 
 }
@@ -1779,6 +1850,7 @@ declare module '@layerfi/components/types' {
   export { Direction, BankTransaction } from '@layerfi/components/types/bank_transactions';
   export { CategorizationStatus, Category, CategorizationType, AutoCategorization, SuggestedCategorization, SingleCategoryUpdate, SplitCategoryUpdate, CategoryUpdate, } from '@layerfi/components/types/categories';
   export { AccountAlternate, ChartOfAccounts, Account, NewAccount, } from '@layerfi/components/types/chart_of_accounts';
+  export { SortDirection } from '@layerfi/components/types/general';
   export type DateRange<T = Date> = {
       startDate: T;
       endDate: T;
@@ -1805,6 +1877,15 @@ declare module '@layerfi/components/utils/format' {
    * Capitalize first letter of the given text.
    */
   export const capitalizeFirstLetter: (text: string) => string;
+  /**
+   * Convert number into percentage.
+   *
+   * @example
+   * 0.112 -> 11%
+   * 0.09843 -> 9.8%
+   * 0.00123 -> 0.12%
+   */
+  export const formatPercent: (value?: number, options?: Intl.NumberFormatOptions) => string | undefined;
 
 }
 declare module '@layerfi/components/utils/helpers' {
@@ -1812,6 +1893,16 @@ declare module '@layerfi/components/utils/helpers' {
   export const debounce: <F extends (...args: Parameters<F>) => ReturnType<F>>(fnc: F, timeout?: number) => (...args: Parameters<F>) => void;
   export const sleep: (time: number) => Promise<unknown>;
 
+}
+declare module '@layerfi/components/utils/profitAndLossUtils' {
+  import { SidebarScope } from '@layerfi/components/hooks/useProfitAndLoss/useProfitAndLoss';
+  import { LineBaseItem } from '@layerfi/components/types/line_item';
+  import { ProfitAndLoss } from '@layerfi/components/types/profit_and_loss';
+  export const collectExpensesItems: (data: ProfitAndLoss) => LineBaseItem[];
+  export const collectRevenueItems: (data: ProfitAndLoss) => LineBaseItem[];
+  export const humanizeTitle: (sidebarView: SidebarScope) => "Expenses" | "Revenue" | "Profit & Loss";
+  export const applyShare: (items: LineBaseItem[], total: number) => LineBaseItem[];
+
 }
 declare module '@layerfi/components' {
   import main = require('@layerfi/components/index');