@layerfi/components 0.1.11 → 0.1.13

package/dist/index.d.ts

@@ -92,12 +92,19 @@ declare module '@layerfi/components/api/layer/categories' {
 
 }
 declare module '@layerfi/components/api/layer/chart_of_accounts' {
-  import { Account, ChartOfAccounts, NewAccount, EditAccount, LedgerAccounts, LedgerAccountsEntry } from '@layerfi/components/types';
+  import { Account, ChartOfAccounts, NewAccount, EditAccount, LedgerAccountsEntry } from '@layerfi/components/types';
+  import { ChartWithBalances } from '@layerfi/components/types/chart_of_accounts';
+  import { LedgerAccountLineItems } from '@layerfi/components/types/ledger_accounts';
   export const getChartOfAccounts: (baseUrl: string, accessToken: string | undefined, options?: {
       params?: Record<string, string | undefined> | undefined;
   } | undefined) => () => Promise<{
       data: ChartOfAccounts;
   }>;
+  export const getLedgerAccountBalances: (baseUrl: string, accessToken: string | undefined, options?: {
+      params?: Record<string, string | undefined> | undefined;
+  } | undefined) => () => Promise<{
+      data: ChartWithBalances;
+  }>;
   export const createAccount: (baseUrl: string, accessToken: string | undefined, options?: {
       params?: Record<string, string | undefined> | undefined;
       body?: NewAccount | undefined;
@@ -113,7 +120,7 @@ declare module '@layerfi/components/api/layer/chart_of_accounts' {
   export const getLedgerAccountsLines: (baseUrl: string, accessToken: string | undefined, options?: {
       params?: Record<string, string | undefined> | undefined;
   } | undefined) => () => Promise<{
-      data: LedgerAccounts;
+      data: LedgerAccountLineItems;
   }>;
   export const getLedgerAccountsEntry: (baseUrl: string, accessToken: string | undefined, options?: {
       params?: Record<string, string | undefined> | undefined;
@@ -227,6 +234,11 @@ declare module '@layerfi/components/api/layer' {
       } | undefined) => () => Promise<{
           data: import("@layerfi/components/types").ChartOfAccounts;
       }>;
+      getLedgerAccountBalances: (baseUrl: string, accessToken: string | undefined, options?: {
+          params?: Record<string, string | undefined> | undefined;
+      } | undefined) => () => Promise<{
+          data: import("@layerfi/components/types/chart_of_accounts").ChartWithBalances;
+      }>;
       getLedgerAccountsLines: (baseUrl: string, accessToken: string | undefined, options?: {
           params?: Record<string, string | undefined> | undefined;
       } | undefined) => () => Promise<{
@@ -584,7 +596,7 @@ declare module '@layerfi/components/components/ChartOfAccounts/ChartOfAccounts'
   }
   export type ChartOfAccountsContextType = ReturnType<typeof useChartOfAccounts>;
   export const ChartOfAccountsContext: React.Context<{
-      data: import("@layerfi/components/types").ChartOfAccounts | undefined;
+      data: import("@layerfi/components/types/chart_of_accounts").ChartWithBalances | undefined;
       isLoading?: boolean | undefined;
       isValidating?: boolean | undefined;
       error?: unknown;
@@ -629,8 +641,18 @@ declare module '@layerfi/components/components/ChartOfAccountsForm/ChartOfAccoun
 
 }
 declare module '@layerfi/components/components/ChartOfAccountsForm/constants' {
+  import { Direction } from '@layerfi/components/types';
   import { BaseSelectOption } from '@layerfi/components/types/general';
-  export const SUB_TYPE_OPTIONS: BaseSelectOption[];
+  export const LEDGER_ACCOUNT_TYPES: BaseSelectOption[];
+  export const DEFAULT_ACCOUNT_TYPE_DIRECTION: Record<string, Direction>;
+  export const NORMALITY_OPTIONS: BaseSelectOption[];
+  export const ASSET_LEDGER_ACCOUNT_SUBTYPES: BaseSelectOption[];
+  export const LIABILITY_LEDGER_ACCOUNT_SUBTYPES: BaseSelectOption[];
+  export const EQUITY_LEDGER_ACCOUNT_SUBTYPES: BaseSelectOption[];
+  export const REVENUE_LEDGER_ACCOUNT_SUBTYPES: BaseSelectOption[];
+  export const EXPENSE_LEDGER_ACCOUNT_SUBTYPES: BaseSelectOption[];
+  export const LEDGER_ACCOUNT_SUBTYPES: BaseSelectOption[];
+  export const LEDGER_ACCOUNT_SUBTYPES_FOR_TYPE: Record<string, BaseSelectOption[]>;
 
 }
 declare module '@layerfi/components/components/ChartOfAccountsForm/index' {
@@ -638,17 +660,17 @@ declare module '@layerfi/components/components/ChartOfAccountsForm/index' {
 
 }
 declare module '@layerfi/components/components/ChartOfAccountsForm/useParentOptions' {
-  import { ChartOfAccounts } from '@layerfi/components/types';
+  import { ChartWithBalances } from '@layerfi/components/types/chart_of_accounts';
   import { BaseSelectOption } from '@layerfi/components/types/general';
-  export const useParentOptions: (data?: ChartOfAccounts) => BaseSelectOption[];
+  export const useParentOptions: (data?: ChartWithBalances) => BaseSelectOption[];
 
 }
 declare module '@layerfi/components/components/ChartOfAccountsRow/ChartOfAccountsRow' {
   import React from 'react';
-  import { Account } from '@layerfi/components/types';
+  import { LedgerAccountBalance } from '@layerfi/components/types/chart_of_accounts';
   import { View } from '@layerfi/components/components/ChartOfAccounts/ChartOfAccounts';
   type ChartOfAccountsRowProps = {
-      account: Account;
+      account: LedgerAccountBalance;
       depth?: number;
       index: number;
       cumulativeIndex?: number;
@@ -889,8 +911,10 @@ declare module '@layerfi/components/components/Input/Select' {
       onChange: (selected: T) => void;
       disabled?: boolean;
       placeholder?: string;
+      isInvalid?: boolean;
+      errorMessage?: string;
   }
-  export const Select: <T>({ name, options, className, classNamePrefix, value, onChange, disabled, placeholder, }: SelectProps<T>) => React.JSX.Element;
+  export const Select: <T>({ name, options, className, classNamePrefix, value, onChange, disabled, placeholder, isInvalid, errorMessage, }: SelectProps<T>) => React.JSX.Element;
 
 }
 declare module '@layerfi/components/components/Input/index' {
@@ -913,10 +937,10 @@ declare module '@layerfi/components/components/LedgerAccount/LedgerAccountIndex'
 }
 declare module '@layerfi/components/components/LedgerAccount/LedgerAccountRow' {
   import React from 'react';
-  import { LedgerAccountsLine } from '@layerfi/components/types';
+  import { LedgerAccountLineItem } from '@layerfi/components/types';
   import { View } from '@layerfi/components/components/ChartOfAccounts/ChartOfAccounts';
   export interface LedgerAccountRowProps {
-      row: LedgerAccountsLine;
+      row: LedgerAccountLineItem;
       index: number;
       initialLoad?: boolean;
       view: View;
@@ -1675,7 +1699,8 @@ declare module '@layerfi/components/hooks/useChartOfAccounts/index' {
 
 }
 declare module '@layerfi/components/hooks/useChartOfAccounts/useChartOfAccounts' {
-  import { Account, ChartOfAccounts, NewAccount } from '@layerfi/components/types';
+  import { NewAccount } from '@layerfi/components/types';
+  import { ChartWithBalances, LedgerAccountBalance } from '@layerfi/components/types/chart_of_accounts';
   import { BaseSelectOption } from '@layerfi/components/types/general';
   interface FormError {
       field: string;
@@ -1686,15 +1711,16 @@ declare module '@layerfi/components/hooks/useChartOfAccounts/useChartOfAccounts'
       accountId?: string;
       data: {
           parent?: BaseSelectOption;
+          stable_name?: string;
           name?: string;
           type?: BaseSelectOption;
           subType?: BaseSelectOption;
-          category?: BaseSelectOption;
+          normality?: BaseSelectOption;
       };
       errors?: FormError[];
   }
   type UseChartOfAccounts = () => {
-      data: ChartOfAccounts | undefined;
+      data: ChartWithBalances | undefined;
       isLoading?: boolean;
       isValidating?: boolean;
       error?: unknown;
@@ -1709,7 +1735,7 @@ declare module '@layerfi/components/hooks/useChartOfAccounts/useChartOfAccounts'
       changeFormData: (name: string, value: string | BaseSelectOption | undefined) => void;
       submitForm: () => void;
   };
-  export const flattenAccounts: (accounts: Account[]) => Account[];
+  export const flattenAccounts: (accounts: LedgerAccountBalance[]) => LedgerAccountBalance[];
   export const useChartOfAccounts: UseChartOfAccounts;
   export {};
 
@@ -2292,6 +2318,23 @@ declare module '@layerfi/components/types/chart_of_accounts' {
       selfOnlyBalance: number;
       entries?: AccountEntry[];
   }
+  export type ChartWithBalances = {
+      accounts: LedgerAccountBalance[];
+  };
+  export type ApiAccountType = {
+      value: string;
+      display_name: string;
+  };
+  export type LedgerAccountBalance = {
+      id: string;
+      name: string;
+      stable_name: string;
+      account_type: ApiAccountType;
+      account_subtype?: ApiAccountType;
+      normality: Direction;
+      balance: number;
+      sub_accounts: LedgerAccountBalance[];
+  };
   export type NewAccount = {
       name: string;
       normality: Direction;
@@ -2299,17 +2342,19 @@ declare module '@layerfi/components/types/chart_of_accounts' {
           type: 'AccountId';
           id: string;
       };
-      description: string;
+      account_type: string;
+      account_subtype?: string;
   };
   export type EditAccount = {
+      stable_name?: string;
       name: string;
-      stable_name: string;
       normality: Direction;
       parent_id?: {
           type: 'AccountId';
           id: string;
       };
-      description: string;
+      account_type: string;
+      account_subtype?: string;
   };
 
 }
@@ -2400,7 +2445,7 @@ declare module '@layerfi/components/types/layer_context' {
 }
 declare module '@layerfi/components/types/ledger_accounts' {
   import { BankTransaction, Direction } from '@layerfi/components/types/bank_transactions';
-  export type LedgerAccounts = LedgerAccountsLine[];
+  export type LedgerAccountLineItems = LedgerAccountLineItem[];
   export interface LedgerAccountsEntry {
       agent?: string;
       business_id: string;
@@ -2416,17 +2461,7 @@ declare module '@layerfi/components/types/ledger_accounts' {
       reversal_of_id?: string;
       type: string;
       transaction?: BankTransaction;
-  }
-  export interface LedgerAccountsLine {
-      type: string;
-      id: string;
-      entry_id: string;
-      account: LedgerAccountsAccount;
-      amount: number;
-      direction: Direction;
-      date: string;
-      transaction?: BankTransaction;
-      invoice: string | null;
+      source?: LedgerEntrySource;
   }
   export interface LedgerAccountsAccount {
       always_show_in_pnl?: boolean;
@@ -2437,13 +2472,63 @@ declare module '@layerfi/components/types/ledger_accounts' {
       stable_name: string;
   }
   export interface LedgerAccountLineItem {
-      account?: LedgerAccountsAccount;
+      id: string;
+      entry_id: string;
+      account: LedgerAccountsAccount;
       amount: number;
-      createdAt: string;
       direction: Direction;
-      entry_at: string;
-      entry_id: string;
-      id: string;
+      date: string;
+      source?: LedgerEntrySource;
+      running_balance: number;
+  }
+  export interface LedgerEntrySource {
+      display_description: string;
+      entity_name: string;
+      type: string;
+  }
+  export interface TransactionLedgerEntrySource extends LedgerEntrySource {
+      transaction_id: string;
+      external_id: string;
+      account_name: string;
+      date: string;
+      amount: number;
+      direction: Direction;
+      counterparty?: string;
+  }
+  export interface InvoiceLedgerEntrySource extends LedgerEntrySource {
+      invoice_id: string;
+      external_id: string;
+      invoice_number: string;
+      recipient_name: string;
+      date: string;
+      amount: number;
+  }
+  export interface ManualLedgerEntrySource extends LedgerEntrySource {
+      manual_entry_id: string;
+      memo: string;
+      created_by: string;
+  }
+  export interface InvoicePaymentLedgerEntrySource extends LedgerEntrySource {
+      external_id: string;
+      invoice_id: string;
+      invoice_number: string;
+      amount: number;
+  }
+  export interface RefundPaymentLedgerEntrySource extends LedgerEntrySource {
+      external_id: string;
+      refund_id: string;
+      refunded_to_customer_amount: number;
+      recipient_name: string;
+  }
+  export interface OpeningBalanceLedgerEntrySource extends LedgerEntrySource {
+      account_name: string;
+  }
+  export interface PayoutLedgerEntrySource extends LedgerEntrySource {
+      payout_id: string;
+      external_id: string;
+      paid_out_amount: number;
+      processor: string;
+      completed_at: string;
   }
 
 }
@@ -2488,6 +2573,8 @@ declare module '@layerfi/components/types/linked_accounts' {
           name: string;
           logo: string;
       };
+      mask?: string;
+      logo_base64?: string;
   }
   export type PublicToken = {
       public_token: string;
@@ -2525,7 +2612,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 { ChartOfAccounts, Account, NewAccount, EditAccount, } from '@layerfi/components/types/chart_of_accounts';
-  export { LedgerAccounts, LedgerAccountsLine, LedgerAccountsAccount, LedgerAccountsEntry, } from '@layerfi/components/types/ledger_accounts';
+  export { LedgerAccountLineItems as LedgerAccounts, LedgerAccountLineItem, LedgerAccountsAccount, LedgerAccountsEntry, } from '@layerfi/components/types/ledger_accounts';
   export { SortDirection } from '@layerfi/components/types/general';
   export type DateRange<T = Date> = {
       startDate: T;