@layerfi/components 0.1.0

package/dist/index.d.ts

@@ -0,0 +1,595 @@
+declare module '@layerfi/components/api/layer/authenticate' {
+  import { OAuthResponse } from '@layerfi/components/types';
+  export const authenticate: () => Promise<OAuthResponse>;
+
+}
+declare module '@layerfi/components/api/layer/authenticated_http' {
+  export const get: <Return = Record<string, string>, Params = Record<string, string>>(url: (params: Params) => string) => (accessToken: string | undefined, options?: {
+      params?: Params | undefined;
+  } | undefined) => () => Promise<Return>;
+  export const put: <Body_1 = Record<string, string>, Return = Record<string, string>, Params = Record<string, string>>(url: (params: Params) => string) => (accessToken: string | undefined, options?: {
+      params?: Params | undefined;
+      body?: Body_1 | undefined;
+  } | undefined) => Promise<Return>;
+
+}
+declare module '@layerfi/components/api/layer/bankTransactions' {
+  import { CategoryUpdate, BankTransaction, Metadata } from '@layerfi/components/types';
+  export const getBankTransactions: (accessToken: string | undefined, options?: {
+      params?: Record<string, string> | undefined;
+  } | undefined) => () => Promise<{
+      data?: BankTransaction[] | undefined;
+      meta?: Metadata | undefined;
+      error?: unknown;
+  }>;
+  export const categorizeBankTransaction: (accessToken: string | undefined, options?: {
+      params?: Record<string, string> | undefined;
+      body?: CategoryUpdate | undefined;
+  } | undefined) => Promise<{
+      data: BankTransaction;
+      error: unknown;
+  }>;
+
+}
+declare module '@layerfi/components/api/layer/categories' {
+  import { Category } from '@layerfi/components/types';
+  export const getCategories: (accessToken: string | undefined, options?: {
+      params?: Record<string, string> | undefined;
+  } | undefined) => () => Promise<{
+      data: {
+          type: 'Category_List';
+          categories: Category[];
+      };
+  }>;
+
+}
+declare module '@layerfi/components/api/layer/profit_and_loss' {
+  import { ProfitAndLoss } from '@layerfi/components/types';
+  export const getProfitAndLoss: (accessToken: string | undefined, options?: {
+      params?: Record<string, string> | undefined;
+  } | undefined) => () => Promise<{
+      data?: ProfitAndLoss | undefined;
+      error?: unknown;
+  }>;
+
+}
+declare module '@layerfi/components/api/layer' {
+  export const Layer: {
+      authenticate: () => Promise<import("@layerfi/components/types").OAuthResponse>;
+      getCategories: (accessToken: string | undefined, options?: {
+          params?: Record<string, string> | undefined;
+      } | undefined) => () => Promise<{
+          data: {
+              type: "Category_List";
+              categories: import("@layerfi/components/types").Category[];
+          };
+      }>;
+      getBankTransactions: (accessToken: string | undefined, options?: {
+          params?: Record<string, string> | undefined;
+      } | undefined) => () => Promise<{
+          data?: import("@layerfi/components/types").BankTransaction[] | undefined;
+          meta?: import("@layerfi/components/types").Metadata | undefined;
+          error?: unknown;
+      }>;
+      getProfitAndLoss: (accessToken: string | undefined, options?: {
+          params?: Record<string, string> | undefined;
+      } | undefined) => () => Promise<{
+          data?: import("@layerfi/components/types").ProfitAndLoss | undefined;
+          error?: unknown;
+      }>;
+      categorizeBankTransaction: (accessToken: string | undefined, options?: {
+          params?: Record<string, string> | undefined;
+          body?: import("@layerfi/components/types").CategoryUpdate | undefined;
+      } | undefined) => Promise<{
+          data: import("@layerfi/components/types").BankTransaction;
+          error: unknown;
+      }>;
+  };
+
+}
+declare module '@layerfi/components/api/util' {
+  export const formStringFromObject: (object: Object) => string;
+
+}
+declare module '@layerfi/components/components/BankTransactionRow/BankTransactionRow' {
+  import React from 'react';
+  import { BankTransaction } from '@layerfi/components/types';
+  type Props = {
+      dateFormat: string;
+      bankTransaction: BankTransaction;
+      isOpen: boolean;
+      toggleOpen: (id: string) => void;
+      editable: boolean;
+  };
+  export const BankTransactionRow: ({ dateFormat, bankTransaction, isOpen, toggleOpen, editable, }: Props) => React.JSX.Element;
+  export {};
+
+}
+declare module '@layerfi/components/components/BankTransactionRow/index' {
+  export { BankTransactionRow } from '@layerfi/components/components/BankTransactionRow/BankTransactionRow';
+
+}
+declare module '@layerfi/components/components/BankTransactions/BankTransactions' {
+  import React from 'react';
+  export const BankTransactions: () => React.JSX.Element;
+
+}
+declare module '@layerfi/components/components/BankTransactions/index' {
+  export { BankTransactions } from '@layerfi/components/components/BankTransactions/BankTransactions';
+
+}
+declare module '@layerfi/components/components/CategoryMenu/CategoryMenu' {
+  import React from 'react';
+  import { BankTransaction, Category } from '@layerfi/components/types';
+  type Props = {
+      name?: string;
+      bankTransaction: BankTransaction;
+      value: Category | undefined;
+      onChange: (newValue: Category) => void;
+  };
+  export const CategoryMenu: ({ bankTransaction, name, value, onChange, }: Props) => React.JSX.Element;
+  export {};
+
+}
+declare module '@layerfi/components/components/CategoryMenu/index' {
+  export { CategoryMenu } from '@layerfi/components/components/CategoryMenu/CategoryMenu';
+
+}
+declare module '@layerfi/components/components/ExpandedBankTransactionRow/ExpandedBankTransactionRow' {
+  import React from 'react';
+  import { BankTransaction } from '@layerfi/components/types';
+  type Props = {
+      bankTransaction: BankTransaction;
+      close?: () => void;
+  };
+  export const ExpandedBankTransactionRow: ({ bankTransaction, close, }: Props) => React.JSX.Element;
+  export {};
+
+}
+declare module '@layerfi/components/components/ExpandedBankTransactionRow/index' {
+  export { ExpandedBankTransactionRow } from '@layerfi/components/components/ExpandedBankTransactionRow/ExpandedBankTransactionRow';
+
+}
+declare module '@layerfi/components/components/Hello/Hello' {
+  import React from 'react';
+  type Props = {
+      user?: string | undefined;
+  };
+  export const Hello: ({ user }: Props) => React.JSX.Element;
+  export {};
+
+}
+declare module '@layerfi/components/components/Hello/index' {
+  export { Hello } from '@layerfi/components/components/Hello/Hello';
+
+}
+declare module '@layerfi/components/components/Pill/Pill' {
+  import React, { PropsWithChildren } from 'react';
+  export const Pill: ({ children }: PropsWithChildren) => React.JSX.Element;
+
+}
+declare module '@layerfi/components/components/Pill/index' {
+  export { Pill } from '@layerfi/components/components/Pill/Pill';
+
+}
+declare module '@layerfi/components/components/ProfitAndLoss/ProfitAndLoss' {
+  import React, { PropsWithChildren } from 'react';
+  import { useProfitAndLoss } from '@layerfi/components/hooks/useProfitAndLoss/index';
+  type PNLContextType = ReturnType<typeof useProfitAndLoss> & {
+      dimensions?: DOMRect;
+  };
+  const ProfitAndLoss: {
+      ({ children }: PropsWithChildren): React.JSX.Element;
+      Chart: () => React.JSX.Element;
+      Context: React.Context<PNLContextType>;
+      DatePicker: () => React.JSX.Element;
+      Summaries: () => React.JSX.Element | null;
+      Table: () => React.JSX.Element;
+  };
+  export { ProfitAndLoss };
+
+}
+declare module '@layerfi/components/components/ProfitAndLoss/index' {
+  export { ProfitAndLoss } from '@layerfi/components/components/ProfitAndLoss/ProfitAndLoss';
+
+}
+declare module '@layerfi/components/components/ProfitAndLossChart/ProfitAndLossChart' {
+  import React from 'react';
+  export const ProfitAndLossChart: () => React.JSX.Element;
+
+}
+declare module '@layerfi/components/components/ProfitAndLossChart/index' {
+  export { ProfitAndLossChart } from '@layerfi/components/components/ProfitAndLossChart/ProfitAndLossChart';
+
+}
+declare module '@layerfi/components/components/ProfitAndLossDatePicker/ProfitAndLossDatePicker' {
+  import React from 'react';
+  export const ProfitAndLossDatePicker: () => React.JSX.Element;
+
+}
+declare module '@layerfi/components/components/ProfitAndLossDatePicker/index' {
+  export { ProfitAndLossDatePicker } from '@layerfi/components/components/ProfitAndLossDatePicker/ProfitAndLossDatePicker';
+
+}
+declare module '@layerfi/components/components/ProfitAndLossRow/ProfitAndLossRow' {
+  import React from 'react';
+  import { Direction } from '@layerfi/components/types';
+  import { LineItem } from '@layerfi/components/types/profit_and_loss';
+  type Props = {
+      variant?: string;
+      depth?: number;
+      maxDepth?: number;
+      lineItem?: LineItem | null;
+      direction?: Direction;
+  };
+  export const ProfitAndLossRow: ({ variant, lineItem, depth, maxDepth, direction, }: Props) => React.JSX.Element | null;
+  export {};
+
+}
+declare module '@layerfi/components/components/ProfitAndLossRow/index' {
+  export { ProfitAndLossRow } from '@layerfi/components/components/ProfitAndLossRow/ProfitAndLossRow';
+
+}
+declare module '@layerfi/components/components/ProfitAndLossSummaries/ProfitAndLossSummaries' {
+  import React from 'react';
+  export const ProfitAndLossSummaries: () => React.JSX.Element | null;
+
+}
+declare module '@layerfi/components/components/ProfitAndLossSummaries/index' {
+  export { ProfitAndLossSummaries } from '@layerfi/components/components/ProfitAndLossSummaries/ProfitAndLossSummaries';
+
+}
+declare module '@layerfi/components/components/ProfitAndLossTable/ProfitAndLossTable' {
+  import React from 'react';
+  export const ProfitAndLossTable: () => React.JSX.Element;
+
+}
+declare module '@layerfi/components/components/ProfitAndLossTable/index' {
+  export { ProfitAndLossTable } from '@layerfi/components/components/ProfitAndLossTable/ProfitAndLossTable';
+
+}
+declare module '@layerfi/components/components/RadioButtonGroup/RadioButton' {
+  import React from 'react';
+  type Props = {
+      checked: boolean;
+      label: string;
+      name: string;
+      onChange: (event: React.ChangeEvent<HTMLInputElement>) => void;
+      value: string;
+      disabled?: boolean;
+      size: 'small' | 'large';
+  };
+  export const RadioButton: ({ checked, label, name, onChange, value, disabled, size, }: Props) => React.JSX.Element;
+  export {};
+
+}
+declare module '@layerfi/components/components/RadioButtonGroup/RadioButtonGroup' {
+  import React from 'react';
+  export type RadioButtonLabel = {
+      label: string;
+      value: string;
+      disabled?: boolean;
+  };
+  type Props = {
+      name: string;
+      size?: 'small' | 'large';
+      buttons: RadioButtonLabel[];
+      selected?: RadioButtonLabel['value'];
+      onChange: (event: React.ChangeEvent<HTMLInputElement>) => void;
+  };
+  export const RadioButtonGroup: ({ name, size, buttons, onChange, selected, }: Props) => React.JSX.Element;
+  export {};
+
+}
+declare module '@layerfi/components/components/RadioButtonGroup/index' {
+  export { RadioButtonGroup } from '@layerfi/components/components/RadioButtonGroup/RadioButtonGroup';
+
+}
+declare module '@layerfi/components/contexts/LayerContext/LayerContext' {
+  /// <reference types="react" />
+  import { LayerContextValues } from '@layerfi/components/types';
+  export const LayerContext: import("react").Context<LayerContextValues>;
+
+}
+declare module '@layerfi/components/contexts/LayerContext/index' {
+  export { LayerContext } from '@layerfi/components/contexts/LayerContext/LayerContext';
+
+}
+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';
+  type UseBankTransactionsReturn = {
+      data: BankTransaction[];
+      metadata: Metadata;
+      isLoading: boolean;
+      error: unknown;
+      categorize: (id: BankTransaction['id'], newCategory: CategoryUpdate) => Promise<void>;
+  };
+  export const useBankTransactions: () => UseBankTransactionsReturn;
+  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;
+
+}
+declare module '@layerfi/components/hooks/useProfitAndLoss/index' {
+  export { useProfitAndLoss } from '@layerfi/components/hooks/useProfitAndLoss/useProfitAndLoss';
+
+}
+declare module '@layerfi/components/hooks/useProfitAndLoss/useProfitAndLoss' {
+  import { ProfitAndLoss, DateRange } from '@layerfi/components/types';
+  type UseProfitAndLoss = {
+      data: ProfitAndLoss | undefined;
+      isLoading: boolean;
+      error: unknown;
+      dateRange: DateRange;
+      changeDateRange: (dateRange: Partial<DateRange>) => void;
+  };
+  type Props = DateRange;
+  export const useProfitAndLoss: ({ startDate: initialStartDate, endDate: initialEndDate }?: Props) => UseProfitAndLoss;
+  export {};
+
+}
+declare module '@layerfi/components/hooks/useWindowSize/useWindowSize' {
+  export function useWindowSize(): number[];
+
+}
+declare module '@layerfi/components/icons/CheckedCircle' {
+  import * as React from 'react';
+  import { SVGProps } from 'react';
+  type Props = SVGProps<SVGSVGElement> & {
+      size: SVGProps<SVGSVGElement>['width'];
+      fillColor: string;
+      strokeColor: string;
+  };
+  const CheckedCircle: ({ fillColor, strokeColor, size, ...props }: Props) => React.JSX.Element;
+  export default CheckedCircle;
+
+}
+declare module '@layerfi/components/icons/ChevronDown' {
+  import * as React from 'react';
+  import { SVGProps } from 'react';
+  const ChevronDown: (props: SVGProps<SVGSVGElement>) => React.JSX.Element;
+  export default ChevronDown;
+
+}
+declare module '@layerfi/components/icons/ChevronLeft' {
+  import * as React from 'react';
+  import { SVGProps } from 'react';
+  type Props = {
+      strokeColor?: string;
+      size?: number;
+  };
+  const ChevronLeft: ({ strokeColor, size, ...props }: Props & SVGProps<SVGSVGElement>) => React.JSX.Element;
+  export default ChevronLeft;
+
+}
+declare module '@layerfi/components/icons/ChevronRight' {
+  import * as React from 'react';
+  import { SVGProps } from 'react';
+  type Props = {
+      strokeColor?: string;
+      size?: number;
+  };
+  const ChavronRight: ({ strokeColor, size, ...props }: Props & SVGProps<SVGSVGElement>) => React.JSX.Element;
+  export default ChavronRight;
+
+}
+declare module '@layerfi/components/icons/ChevronUp' {
+  import * as React from 'react';
+  import { SVGProps } from 'react';
+  const ChevronUp: (props: SVGProps<SVGSVGElement>) => React.JSX.Element;
+  export default ChevronUp;
+
+}
+declare module '@layerfi/components/icons/Link' {
+  import * as React from 'react';
+  import { SVGProps } from 'react';
+  type Props = SVGProps<SVGSVGElement> & {
+      size: SVGProps<SVGSVGElement>['width'];
+  };
+  const Link: ({ size, ...props }: Props) => React.JSX.Element;
+  export default Link;
+
+}
+declare module '@layerfi/components/icons/LinkBroken' {
+  import * as React from 'react';
+  import { SVGProps } from 'react';
+  type Props = SVGProps<SVGSVGElement> & {
+      size: SVGProps<SVGSVGElement>['width'];
+  };
+  const LinkBroken: ({ size, ...props }: Props) => React.JSX.Element;
+  export default LinkBroken;
+
+}
+declare module '@layerfi/components/index' {
+  import { BankTransactions } from '@layerfi/components/components/BankTransactions/index';
+  import { Hello } from '@layerfi/components/components/Hello/index';
+  import { ProfitAndLoss } from '@layerfi/components/components/ProfitAndLoss/index';
+  import { LayerProvider } from '@layerfi/components/providers/LayerProvider/index';
+  export { Hello, BankTransactions, LayerProvider, ProfitAndLoss };
+
+}
+declare module '@layerfi/components/models/Money' {
+  export const centsToDollars: (cents: number) => string;
+  export const dollarsToCents: (dollars: string) => number;
+  const _default: {
+      centsToDollars: (cents: number) => string;
+      dollarsToCents: (dollars: string) => number;
+  };
+  export default _default;
+
+}
+declare module '@layerfi/components/providers/LayerProvider/LayerProvider' {
+  import React, { PropsWithChildren } from 'react';
+  type Props = {
+      businessId: string;
+  };
+  export const LayerProvider: ({ businessId, children, }: PropsWithChildren<Props>) => React.JSX.Element;
+  export {};
+
+}
+declare module '@layerfi/components/providers/LayerProvider/index' {
+  export { LayerProvider } from '@layerfi/components/providers/LayerProvider/LayerProvider';
+
+}
+declare module '@layerfi/components/types/api' {
+  export interface PaginationMetadata {
+      sort_by?: string;
+      sort_order: string;
+      cursor?: string;
+      has_more: boolean;
+  }
+  export type Metadata = {
+      pagination?: PaginationMetadata;
+  };
+
+}
+declare module '@layerfi/components/types/authentication' {
+  export type OAuthResponse = {
+      access_token: string;
+      token_type: string;
+      expires_in: number;
+  };
+
+}
+declare module '@layerfi/components/types/layer_context' {
+  import { Category } from '@layerfi/components/types';
+  import { OAuthResponse } from '@layerfi/components/types/authentication';
+  export type LayerContextValues = {
+      auth: OAuthResponse;
+      businessId: string;
+      categories: Category[];
+  };
+  export enum LayerContextActionName {
+      setAuth = "LayerContext.setAuth",
+      setCategories = "LayerContext.setCategories"
+  }
+  export type LayerContextAction = {
+      type: LayerContextActionName.setAuth;
+      payload: {
+          auth: LayerContextValues['auth'];
+      };
+  } | {
+      type: LayerContextActionName.setCategories;
+      payload: {
+          categories: LayerContextValues['categories'];
+      };
+  };
+
+}
+declare module '@layerfi/components/types/profit_and_loss' {
+  export interface ProfitAndLoss {
+      type: 'Profit_And_Loss';
+      business_id: string;
+      start_date: string;
+      end_date: string;
+      income: LineItem;
+      cost_of_goods_sold?: LineItem | null;
+      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 LineItem {
+      name?: String;
+      display_name: string;
+      value: number;
+      line_items?: LineItem[] | null;
+  }
+
+}
+declare module '@layerfi/components/types' {
+  export { OAuthResponse } from '@layerfi/components/types/authentication';
+  export { LayerContextValues, LayerContextActionName, LayerContextAction, } from '@layerfi/components/types/layer_context';
+  export { Metadata } from '@layerfi/components/types/api';
+  export { ProfitAndLoss, LineItem } from '@layerfi/components/types/profit_and_loss';
+  export enum CategorizationStatus {
+      PENDING = "PENDING",
+      READY_FOR_INPUT = "READY_FOR_INPUT",
+      LAYER_REVIEW = "LAYER_REVIEW",
+      CATEGORIZED = "CATEGORIZED",
+      SPLIT = "SPLIT",
+      JOURNALING = "JOURNALING"
+  }
+  export enum Direction {
+      CREDIT = "CREDIT",
+      DEBIT = "DEBIT"
+  }
+  export interface Category {
+      id: string;
+      type: string;
+      display_name: string;
+      category: string;
+      stable_name?: string;
+      subCategories?: Category[];
+  }
+  export enum CategorizationType {
+      AUTO = "AUTO",
+      ASK_FROM_SUGGESTIONS = "ASK_FROM_SUGGESTIONS",
+      MEALS = "MEALS",
+      BUSINESS_TRAVEL_TRANSPORTATION = "BUSINESS_TRAVEL_TRANSPORTATION"
+  }
+  export interface AutoCategorization {
+      type: CategorizationType.AUTO;
+      category: Category;
+  }
+  export interface SuggestedCategorization {
+      type: CategorizationType;
+      suggestions: Category[];
+  }
+  export interface BankTransaction extends Record<string, unknown> {
+      type: 'Bank_Transaction';
+      business_id: string;
+      id: string;
+      date: string;
+      source: string;
+      source_transaction_id: string;
+      source_account_id: string;
+      imported_at: string;
+      description: string | null;
+      amount: number;
+      direction: Direction;
+      counterparty_name: string;
+      category: Category;
+      categorization_status: CategorizationStatus;
+      categorization_flow: AutoCategorization | SuggestedCategorization;
+      categorization_method: string;
+  }
+  export type SingleCategoryUpdate = {
+      type: 'Category';
+      category: {
+          type: 'StableName';
+          stable_name: string;
+      };
+  };
+  export type SplitCategoryUpdate = {
+      type: 'Split';
+      entries: {
+          category: string;
+          amount: number;
+      }[];
+  };
+  export type CategoryUpdate = SingleCategoryUpdate | SplitCategoryUpdate;
+  export type DateRange<T = Date> = {
+      startDate: T;
+      endDate: T;
+  };
+
+}
+declare module '@layerfi/components' {
+  import main = require('@layerfi/components/src/index');
+  export = main;
+}