@mx-cartographer/experiences 3.14.0-alpha.mm5 → 3.15.0

package/dist/accounts/stores/AccountStore.d.ts

@@ -11,6 +11,7 @@ export declare class AccountStore {
     constructor(globalStore: GlobalStore);
     initialize: (endpoint: string, token: string) => Promise<void>;
     get cashAccounts(): Account[];
+    get debtAccounts(): Account[];
     get cashBalance(): number;
     addAccount: (account: Account) => Promise<void>;
     augmentAccounts: (accounts?: Account[]) => Account[];

package/dist/budgets/api/BudgetsApi.d.ts

@@ -1,8 +1,8 @@
-import { Budget, Fetch } from '../../common';
+import { Budget, Category, Fetch } from '../../common';
 export declare class BudgetsApi {
     fetchInstance: Fetch;
     constructor(endpoint: string, token: string);
-    addBudget: (budget: Budget) => Promise<any>;
+    addBudget: (category: Category, amount: number, parentGuid?: string | null) => Promise<any>;
     deleteBudget: (guid: string) => Promise<any>;
     generateBudgets: () => Promise<any>;
     getBudgets: () => Promise<any>;

package/dist/budgets/components/AddBudgets.d.ts

@@ -0,0 +1,3 @@
+export declare const AddBudgets: (() => import("react/jsx-runtime").JSX.Element) & {
+    displayName: string;
+};

package/dist/budgets/components/BubbleBudgets.d.ts

@@ -1,10 +1,8 @@
 import { default as React } from 'react';
-import { DetailedBudget } from '../../common';
 interface BubbleBudgetsProps {
+    height: number;
     isDraggable?: boolean;
-    onClick?: (budget: DetailedBudget) => void;
     shouldShowZeroState: boolean;
-    unavailableHeight?: number;
     unavailableWidth?: number;
 }
 export declare const BubbleBudgets: React.FC<BubbleBudgetsProps>;

package/dist/budgets/components/BubbleChart.d.ts

@@ -1,16 +1,15 @@
 import { default as React } from 'react';
 import { SimulationNodeDatum } from 'd3-force';
-import { DetailedBudget } from '../../common/types/Budget';
+import { DetailedBudget } from '../../common';
 export interface BubbleData extends SimulationNodeDatum {
-    budget: DetailedBudget;
+    budget_guid: string;
     radius: number;
 }
 interface BubbleChartProps {
-    data: BubbleData[];
     height: number;
     width: number;
     isDraggable?: boolean;
     onClick?: (budget: DetailedBudget) => void;
 }
-declare const BubbleChart: React.FC<BubbleChartProps>;
-export default BubbleChart;
+declare const _default: React.FunctionComponent<BubbleChartProps>;
+export default _default;

package/dist/budgets/components/BudgetDetailsDrawer.d.ts

@@ -0,0 +1,3 @@
+export declare const BudgetDetailsDrawer: (() => import("react/jsx-runtime").JSX.Element | undefined) & {
+    displayName: string;
+};

package/dist/budgets/components/BudgetList.d.ts

@@ -1,7 +1,3 @@
-import { default as React } from 'react';
-import { DetailedBudget } from '../../common/types/Budget';
-interface BudgetListProps {
-    onClick?: (budget: DetailedBudget) => void;
-}
-export declare const BudgetList: React.FC<BudgetListProps>;
-export {};
+export declare const BudgetList: (() => import("react/jsx-runtime").JSX.Element) & {
+    displayName: string;
+};

package/dist/budgets/components/addbudget/Header.d.ts

@@ -0,0 +1,3 @@
+export declare const Header: (() => import("react/jsx-runtime").JSX.Element) & {
+    displayName: string;
+};

package/dist/budgets/components/addbudget/RecalculateBudgetRow.d.ts

@@ -0,0 +1,7 @@
+import { default as React } from 'react';
+import { DetailedCategory } from '../../../common';
+interface RecalculateBudgetRowProps {
+    category: DetailedCategory;
+}
+export declare const RecalculateBudgetRow: React.FC<RecalculateBudgetRowProps>;
+export {};

package/dist/budgets/components/addbudget/RecalculateBudgets.d.ts

@@ -0,0 +1 @@
+export declare const RecalculateBudgets: () => import("react/jsx-runtime").JSX.Element;

package/dist/budgets/components/addbudget/UnbudgetedRow.d.ts

@@ -0,0 +1,8 @@
+import { default as React } from 'react';
+import { DetailedCategory } from '../../../common';
+interface UnbudgetedRowProps {
+    category: DetailedCategory;
+    onAddBudget: (category: DetailedCategory, amount: number) => void;
+}
+export declare const UnbudgetedRow: React.FC<UnbudgetedRowProps>;
+export {};

package/dist/budgets/components/bubblechart/Bubble.d.ts

@@ -1,6 +1,6 @@
 import { default as React } from 'react';
 import { BubbleData } from '../BubbleChart';
-import { DetailedBudget } from '../../../common/types/Budget';
+import { DetailedBudget } from '../../../common';
 interface BubbleProps {
     bubble: BubbleData;
     isDraggable: boolean;

package/dist/budgets/components/bubblechart/Mercury.d.ts

@@ -1,7 +1,9 @@
 import { default as React } from 'react';
 import { BubbleData } from '../BubbleChart';
+import { DetailedBudget } from '../../../common';
 interface MercuryProps {
     bubble: BubbleData;
+    budget: DetailedBudget;
 }
 export declare const Mercury: React.FC<MercuryProps>;
 export {};

package/dist/budgets/components/budgetdetails/AddSubBudget.d.ts

@@ -0,0 +1,8 @@
+import { default as React } from 'react';
+import { DetailedBudget, DetailedCategory } from '../../../common';
+interface AddSubBudgetProps {
+    category: DetailedCategory;
+    parentBudget: DetailedBudget;
+}
+export declare const AddSubBudget: React.FC<AddSubBudgetProps>;
+export {};

package/dist/budgets/components/{BudgetDetails.d.ts → budgetdetails/BudgetDetails.d.ts}

@@ -1,5 +1,5 @@
 import { default as React } from 'react';
-import { DetailedBudget } from '../../common';
+import { DetailedBudget } from '../../../common';
 interface BudgetDetailsProps {
     budget: DetailedBudget;
 }

package/dist/budgets/components/budgetdetails/Header.d.ts

@@ -0,0 +1,7 @@
+import { default as React } from 'react';
+import { DetailedBudget } from '../../../common';
+interface HeaderProps {
+    budget: DetailedBudget;
+}
+export declare const Header: React.FC<HeaderProps>;
+export {};

package/dist/budgets/components/budgetdetails/SubBudgetList.d.ts

@@ -0,0 +1,7 @@
+import { default as React } from 'react';
+import { DetailedBudget } from '../../../common';
+interface SubBudgetListProps {
+    budget: DetailedBudget;
+}
+export declare const SubBudgetList: React.FC<SubBudgetListProps>;
+export {};

package/dist/budgets/components/budgetlist/BudgetRow.d.ts

@@ -1,5 +1,5 @@
 import { default as React } from 'react';
-import { DetailedBudget } from '../../../common/types/Budget';
+import { DetailedBudget } from '../../../common';
 interface BudgetRowProps {
     budget: DetailedBudget;
     onClick?: (budget: DetailedBudget) => void;

package/dist/budgets/components/budgetlist/SubBudgetRow.d.ts

@@ -1,5 +1,5 @@
 import { default as React } from 'react';
-import { DetailedBudget } from '../../../common/types/Budget';
+import { DetailedBudget } from '../../../common';
 interface SubBudgetRowProps {
     budget: DetailedBudget;
 }

package/dist/budgets/components/budgetlist/SubBudgetZeroState.d.ts

@@ -1 +1,3 @@
-export declare const SubBudgetZeroState: () => import("react/jsx-runtime").JSX.Element;
+export declare const SubBudgetZeroState: (() => import("react/jsx-runtime").JSX.Element) & {
+    displayName: string;
+};

package/dist/budgets/components/shared/BudgetAmount.d.ts

@@ -0,0 +1,8 @@
+import { default as React } from 'react';
+interface BudgetAmountProps {
+    amount: string;
+    categoryName: string;
+    onAmountChanged: (amount: string) => void;
+}
+export declare const BudgetAmount: React.FC<BudgetAmountProps>;
+export {};

package/dist/budgets/store/BudgetsStore.d.ts

@@ -1,5 +1,5 @@
 import { Theme } from '@mui/system';
-import { Account, Budget, CategoryTotal, DateRange, DetailedBudget, CategoryApi, GlobalStore } from '../../common';
+import { Account, Budget, Category, CategoryTotal, DateRange, DetailedBudget, DetailedCategory, CategoryApi, GlobalStore } from '../../common';
 import { BudgetsApi } from '../api/BudgetsApi';
 export declare class BudgetsStore {
     api: BudgetsApi;
@@ -8,16 +8,22 @@ export declare class BudgetsStore {
     dateRange: DateRange;
     budgets: Budget[];
     categoryTotals: CategoryTotal[];
+    selectedBudget: DetailedBudget | undefined;
+    selectedSubBudget: DetailedBudget | undefined;
     theme: Theme;
     constructor(globalStore: GlobalStore);
     initialize: (endpoint: string, token: string) => Promise<void>;
     get detailedBudgets(): DetailedBudget[];
-    addBudget: (budget: Budget) => Promise<void>;
+    get unbudgetedCategories(): DetailedCategory[];
+    get totalBudgeted(): number;
+    addBudget: (category: Category, amount: number, parentGuid?: string | null) => Promise<void>;
     deleteBudget: (guid: string) => Promise<void>;
     generateBudgets: () => Promise<void>;
     loadBudgets: () => Promise<void>;
     loadCategoryTotals: (accounts: Account[], dateRange: DateRange) => Promise<void>;
     setDateRange: (dateRange: DateRange) => DateRange;
+    setSelectedBudget: (budget: DetailedBudget | undefined) => DetailedBudget | undefined;
+    setSelectedSubBudget: (budget: DetailedBudget | undefined) => DetailedBudget | undefined;
     setTheme: (theme: Theme) => Theme;
     updateBudget: (budget: Budget) => Promise<void>;
 }

package/dist/budgets/utils/BubblesSVG.d.ts

@@ -1,8 +1,9 @@
 import { Simulation } from 'd3';
 import { SimulationNodeDatum } from 'd3-force';
 import { BubbleData } from '../components/BubbleChart';
+import { DetailedBudget } from '../../common';
 import * as d3 from 'd3';
-type SimulationType = Simulation<SimulationNodeDatum, undefined>;
+export type SimulationType = Simulation<SimulationNodeDatum, undefined>;
 /**
  * Enables dragging of bubbles
  * @param simulation D3 Simulation
@@ -10,9 +11,10 @@ type SimulationType = Simulation<SimulationNodeDatum, undefined>;
 export declare const drag: (simulation: SimulationType) => d3.DragBehavior<Element, unknown, unknown>;
 /**
  * Provide d values for the arc between the start and end radius based on time
+ * @param budget Budget data
  * @param data Bubble data
  */
-export declare const arcTween: (data: BubbleData) => (t: number) => string;
+export declare const arcTween: (budget: DetailedBudget, data: BubbleData) => (t: number) => string;
 /**
  * Enable drag
  * @param simulation D3 Simulation
@@ -25,9 +27,9 @@ export declare const enableDrag: (simulation: SimulationType) => void;
  * @param width New width
  */
 export declare const resize: (simulation: SimulationType, height: number, width: number) => void;
+export declare const getScale: (min: number, max: number) => d3.ScaleLinear<number, number, never>;
 /**
  * Simulates the chart
  * @param data All Bubble data for the chart
  */
 export declare const simulate: (data: BubbleData[]) => d3.Simulation<d3.SimulationNodeDatum, undefined>;
-export {};

package/dist/budgets/utils/BudgetUtil.d.ts

@@ -1,6 +1,8 @@
 import { Theme } from '@mui/system';
-import { Budget, BudgetColors, BudgetsCopy, Category, CategoryTotal, DetailedBudget } from '../../common';
-export declare const getBudgetPercentage: (budget: Budget) => number;
-export declare const getBudgetColors: (budget: Budget, theme: Theme) => BudgetColors;
+import { Budget, BudgetColors, BudgetsCopy, DetailedCategory, DetailedBudget } from '../../common';
+export declare const getBudgetPercentage: (budgetAmount: number, totalAmount: number) => number;
+export declare const getBudgetColors: (percentage: number, theme: Theme) => BudgetColors;
 export declare const useGetBudgetDifference: () => number;
-export declare const augmentBudgets: (budgets: Budget[], categories: Category[], categoryTotals: CategoryTotal[], copy: BudgetsCopy, theme: Theme) => DetailedBudget[];
+export declare const augmentBudgets: (budgets: Budget[], categories: DetailedCategory[], copy: BudgetsCopy, theme: Theme) => DetailedBudget[];
+export declare const findBudget: (budgets: DetailedBudget[], guid: string) => DetailedBudget | undefined;
+export declare const findSubBudget: (budgets: DetailedBudget[], guid: string, parentGuid: string) => DetailedBudget | undefined;

package/dist/categories/index.d.ts

@@ -1,4 +1,5 @@
 export { default as CategorySelector } from './components/CategorySelector';
 export { default as CategorySelectorDrawer } from './components/CategorySelectorDrawer';
+export { default as CategoryRow } from './components/CategoryRow';
 export { CategoryStore } from './stores/CategoryStore';
 export { useCategoryUiStore } from './context/hooks';

package/dist/categories/stores/CategoryStore.d.ts

@@ -1,51 +1,20 @@
-import { Account, CategoryApi, Category, DateRangeCategoryTotals, GlobalStore, MonthlyCategoryTotals } from '../../common';
+import { Account, CategoryApi, Category, DetailedCategory, DateRangeCategoryTotals, GlobalStore, MonthlyCategoryTotals } from '../../common';
 import { UiStore } from './UiStore';
-import { DetailedCategory } from '../../common/types/Category';
 export declare class CategoryStore {
     api: CategoryApi;
     globalStore: GlobalStore;
     uiStore: UiStore;
     categories: Category[];
-    detailedCategories: DetailedCategory[];
     dateRangeCategoryTotals: DateRangeCategoryTotals[];
     monthlyCategoryTotals: MonthlyCategoryTotals[];
     isLoadingCategoryTotals: boolean;
     constructor(globalStore: GlobalStore);
     initialize: (endpoint: string, token: string) => Promise<void>;
+    get detailedCategories(): DetailedCategory[];
+    get incomeCategories(): DetailedCategory[];
+    get spendCategories(): DetailedCategory[];
+    get transferCategories(): DetailedCategory[];
     addCategory: (name: string, parentGuid: string) => Promise<void>;
-    augmentCategories(): {
-        average: number;
-        color: string;
-        generalHistory: {
-            timestamp: number;
-            label: string;
-            total: number;
-        }[];
-        history: {
-            timestamp: number;
-            label: string;
-            total: number;
-        }[];
-        icon: string;
-        isTransfer: boolean;
-        monthlyTotals: MonthlyCategoryTotals[];
-        total: number;
-        value: number;
-        guid: string;
-        income: boolean;
-        is_default: boolean;
-        is_income: boolean;
-        metadata?: string;
-        name: string;
-        parent_guid?: string;
-        revision?: number;
-        user_guid?: string;
-    }[];
-    getHistory: (totals: MonthlyCategoryTotals[], startDate?: number, monthsBack?: number) => {
-        timestamp: number;
-        label: string;
-        total: number;
-    }[];
     loadCategories: () => Promise<void>;
     loadDateRangeCategoryTotals: (accounts: Account[], startDate: Date, endDate: Date) => Promise<void>;
     loadMonthlyCategoryTotals: (accounts?: Account[], startDate?: Date, endDate?: Date) => Promise<void>;

package/dist/categories/util/CategoryUtil.d.ts

@@ -0,0 +1,8 @@
+import { Category, DateRangeCategoryTotals, DetailedCategory, MonthlyCategoryTotals } from '../../common';
+/**
+ * Augment categories
+ * @param categories - Categories to augment
+ * @param monthlyCategoryTotals - Monthly category totals
+ * @param currentCategoryTotals - Current month category totals
+ */
+export declare const augmentCategories: (categories: Category[], currentCategoryTotals: DateRangeCategoryTotals[], monthlyCategoryTotals: MonthlyCategoryTotals[]) => DetailedCategory[];

package/dist/common/components/charts/LineChart.d.ts

@@ -1,5 +1,7 @@
-import { default as React } from 'react';
+import { default as React, CSSProperties } from 'react';
+import { MarkHandlers } from './linechart/CustomMark';
 interface LineChartProps {
+    baseline?: string;
     colors: (string | undefined)[];
     datasets: {
         x: string;
@@ -7,10 +9,14 @@ interface LineChartProps {
     }[][];
     height?: number;
     labels: string[];
+    markHandlers?: MarkHandlers;
+    markStyles?: (markIndex: number) => CSSProperties;
     showArea?: boolean;
     showAverage?: boolean;
     showBars?: boolean;
     showMarkLabel?: boolean;
+    useCustomMark?: boolean;
+    valueFormatterString?: string;
     width?: number;
 }
 export declare const LineChart: React.FC<LineChartProps>;

package/dist/common/components/charts/linechart/CustomMark.d.ts

@@ -1,6 +1,13 @@
 import { default as React } from 'react';
 import { MarkElementProps } from '@mui/x-charts';
+export type MarkHandlers = {
+    onMarkClick?: (event: React.MouseEvent<SVGPathElement, MouseEvent>, dataIndex: number) => void;
+    onMouseEnter?: (dataIndex: number) => void;
+    onMouseLeave?: () => void;
+};
 interface CustomMarkProps extends MarkElementProps {
+    handlers?: MarkHandlers;
+    showLabel: boolean;
     yData: number[];
 }
 export declare const CustomMark: React.FC<CustomMarkProps>;

package/dist/common/components/dialog/Dialog.d.ts

@@ -12,7 +12,9 @@ export interface DialogProps extends Omit<MuiDialogProps, 'open'> {
     onClose: () => void;
     onPrimaryAction?: () => void;
     onSecondaryAction?: () => void;
+    primaryColor?: 'primary' | 'inherit' | 'secondary' | 'success' | 'error' | 'info' | 'warning';
     primaryText?: string;
+    secondaryColor?: 'primary' | 'inherit' | 'secondary' | 'success' | 'error' | 'info' | 'warning';
     secondaryText?: string;
 }
 declare const Dialog: React.FC<React.PropsWithChildren<DialogProps>>;

package/dist/common/components/drawer/Drawer.d.ts

@@ -11,9 +11,13 @@ interface DrawerProps {
     isPrimaryDisabled?: boolean;
     onClose: () => void;
     onPrimaryAction?: () => void;
+    onSecondaryAction?: () => void;
+    primaryColor?: 'primary' | 'inherit' | 'secondary' | 'success' | 'error' | 'info' | 'warning';
     primaryText?: string;
+    secondaryColor?: 'primary' | 'inherit' | 'secondary' | 'success' | 'error' | 'info' | 'warning';
     secondaryText?: string;
     shouldShowHeaderBorders?: boolean;
+    shouldShowHeaderShadow?: boolean;
     sx?: SxProps;
     title: string;
 }

package/dist/common/components/drawer/Header.d.ts

@@ -3,6 +3,7 @@ interface DrawerHeaderProps {
     ariaLabelClose: string;
     onClose: () => void;
     shouldShowBorders: boolean;
+    shouldShowShadow?: boolean;
     title: string;
 }
 declare const DrawerHeader: React.FC<DrawerHeaderProps>;

package/dist/common/components/index.d.ts

@@ -18,4 +18,5 @@ export { default as TabContentContainer } from './TabContentContainer';
 export { default as IconBacking } from './IconBacking';
 export { default as DataRow } from './DataRow';
 export { default as InformationTooltip } from './InformationTooltip';
+export { CurrencyText } from './CurrencyText';
 export { ListItemWrapper } from './ListItemWrapper';

package/dist/common/constants/Analytics.d.ts

@@ -9,6 +9,11 @@ export declare const ANALYTICS_EVENTS: {
     ACCOUNT_DETAILS_CLICK_TRANSACTION: string;
     ACCOUNT_DETAILS_VIEW: string;
     ACCOUNT_DETAILS_VIEW_TRANSACTIONS: string;
+    BUDGETS_CLICK_FILTER: string;
+    BUDGETS_CLICK_ADD: string;
+    BUDGETS_CLICK_EDIT_INCOME: string;
+    BUDGETS_CLICK_BUDGET_CATEGORY: string;
+    BUDGETS_VIEW: string;
     CASH_FLOW_CLICK_SETTINGS: string;
     CASH_FLOW_CLICK_FILTER: string;
     RECURRING_ACTIVITY_CLICK_SETTINGS: string;

package/dist/common/context/hooks.d.ts

@@ -4,11 +4,13 @@ export declare const useBudgetsStore: () => import('../../budgets/store/BudgetsS
 export declare const useCashflowStore: () => import('../..').CashflowStore;
 export declare const useCategoryStore: () => import('../..').CategoryStore;
 export declare const useConnectStore: () => import('../stores/ConnectStore').ConnectStore;
+export declare const useDebtStore: () => import('../..').DebtsStore;
 export declare const useGlobalStore: () => import('..').GlobalStore;
 export declare const useGlobalUiStore: () => import('../stores/GlobalUiStore').GlobalUiStore;
 export declare const useGlobalCopyStore: () => import('..').GlobalCopy;
-export declare const useGoalStore: () => import('..').GlobalStore;
+export declare const useGoalStore: () => import('../..').GoalStore;
 export declare const useMerchantStore: () => import('../..').MerchantStore;
+export declare const useNetWorthStore: () => import('../..').NetWorthStore;
 export declare const useNotificationStore: () => import('../..').NotificationStore;
 export declare const useRecurringActivityStore: () => import('../..').RecurringActivityStore;
 export declare const useTransactionStore: () => import('../..').TransactionStore;

package/dist/common/context/index.d.ts

@@ -1,3 +1,3 @@
-export { useAccountStore, useBudgetsStore, useCashflowStore, useCategoryStore, useEvent, useGlobalStore, useGlobalUiStore, useGlobalCopyStore, useMerchantStore, useNotificationStore, usePageView, useRecurringActivityStore, useTransactionStore, useUserStore, useWidgetContainerProvider, } from './hooks';
+export { useAccountStore, useBudgetsStore, useCashflowStore, useCategoryStore, useDebtStore, useEvent, useGlobalStore, useGlobalUiStore, useGlobalCopyStore, useGoalStore, useMerchantStore, useNetWorthStore, useNotificationStore, usePageView, useRecurringActivityStore, useTransactionStore, useUserStore, useWidgetContainerProvider, } from './hooks';
 export { GlobalDataContext, GlobalDataProvider } from './GlobalDataProvider';
 export { WidgetContainerContext, WidgetContainerProvider } from './WidgetContainerProvider';

package/dist/common/stores/GlobalStore.d.ts

@@ -4,7 +4,9 @@ import { BudgetsStore } from '../../budgets/store/BudgetsStore';
 import { CashflowStore } from '../../cashflow';
 import { CategoryStore } from '../../categories';
 import { ConnectStore } from './ConnectStore';
+import { DebtsStore } from '../../debts/index';
 import { GlobalUiStore } from './GlobalUiStore';
+import { GoalStore } from '../../goals';
 import { MerchantStore } from '../../merchants';
 import { NetWorthStore } from '../../networth';
 import { NotificationStore } from '../../notifications';
@@ -20,6 +22,8 @@ export declare class GlobalStore {
     categoryStore: CategoryStore;
     connectStore: ConnectStore;
     copyStore: GlobalCopyStore;
+    goalStore: GoalStore;
+    debtsStore: DebtsStore;
     merchantStore: MerchantStore;
     netWorthStore: NetWorthStore;
     notificationStore: NotificationStore;

package/dist/common/types/Account.d.ts

@@ -287,5 +287,6 @@ export declare enum ConnectionStatus {
 export declare const StatusName: any;
 export declare const AccountTypeName: any;
 export declare const AccountIcon: any;
+export declare const AccountIconVariants: any;
 export declare const PropertyTypeName: any;
 export declare const PropertyIcon: any;

package/dist/common/types/Budget.d.ts

@@ -1,4 +1,4 @@
-import { Category } from './Category';
+import { DetailedCategory } from './Category';
 export type BudgetColors = {
     background: string;
     mercury: string;
@@ -19,10 +19,8 @@ export interface Budget {
 }
 export interface DetailedBudget extends Budget {
     budgetColors: BudgetColors;
-    category: Category;
+    category: DetailedCategory;
     description: string;
-    icon: string;
-    label: string;
     percentage: number;
     subBudgets: DetailedBudget[];
 }

package/dist/common/types/Category.d.ts

@@ -25,21 +25,34 @@ export interface MonthlyCategoryTotals {
     year: number;
     year_month: number;
 }
-export interface CategoryHistory {
-    timestamp: number;
+export interface MonthlyAmount {
+    amount: number;
+    isoDate: string;
     label: string;
-    total: number;
 }
+/**
+ * @averageAmount - The average amount for this category
+ * @color - Color to represent this category
+ * @currentAmount - The amount of this category for the current month
+ * @monthlyAmounts - The past 12 monthly amounts for this category
+ * @icon - Icon to represent this category
+ * @isTransfer - Is this category for transfers
+ * @subCategories - Detailed subcategories for this category
+ * @totalAmount - The total amount (including subcategories) for the current month
+ * @totalAverageAmount - The total average amount (including subcategories) for this category
+ * @totalMonthlyAmounts - The past 12 total monthly amounts (including subcategories)
+ */
 export interface DetailedCategory extends Category {
-    average: number;
+    averageAmount: number;
     color: string;
-    generalHistory: CategoryHistory[];
-    history: CategoryHistory[];
+    currentAmount: number;
+    monthlyAmounts: MonthlyAmount[];
     icon: string;
     isTransfer: boolean;
-    monthlyTotals: MonthlyCategoryTotals[];
-    total: number;
-    value: number;
+    subCategories: DetailedCategory[];
+    totalAmount: number;
+    totalAverageAmount: number;
+    totalMonthlyAmounts: MonthlyAmount[];
 }
 export interface CategoryTotal {
     amount: number;

package/dist/common/types/Debt.d.ts

@@ -0,0 +1,15 @@
+import { Account } from './Account';
+import { Goal } from './Goal';
+export type Debt = {
+    account: Account;
+    goal?: Goal;
+    balance: number;
+    guid?: string;
+    hasPaymentDueAt: boolean;
+    interestRate?: number;
+    isExcludedFromDebts: boolean;
+    isPaidOff: boolean;
+    isPayoffImpossible?: boolean;
+    minimumPayment: number;
+    paymentDate: number;
+};

package/dist/common/types/index.d.ts

@@ -1,17 +1,18 @@
 export type { Account, DetailedAccount, Member, MonthlyAccountBalance } from './Account';
-export { AccountIcon, AccountSubType, AccountType, AccountTypeName, ConnectionStatus, ConnectionStatusEnums, ErrorStatuses, MfaStatuses, NonConnectedStatuses, ProcessingStatuses, PropertyType, PropertyTypeName, StatusName, } from './Account';
+export { AccountIcon, AccountIconVariants, AccountSubType, AccountType, AccountTypeName, ConnectionStatus, ConnectionStatusEnums, ErrorStatuses, MfaStatuses, NonConnectedStatuses, ProcessingStatuses, PropertyType, PropertyTypeName, StatusName, } from './Account';
 export { type Activity, ActivityStatus, ActivityType } from './Activity';
 export type { AnalyticsEvent, AnalyticsPageview, BasicAnalyticsEvent, BasicAnalyticsPageview, AnalyticsSession, AnalyticEventFunction, AnalyticPageviewFunction, } from './Analytics';
 export type { Beat, DataSeries } from './Beat';
 export { UserVerification } from './Beat';
 export type { Budget, BudgetColors, DetailedBudget } from './Budget';
 export type { CashflowEvent, CashflowSequence, RepeatDay, RepeatInterval, RepeatMonth, RepeatWeekday, } from './Cashflow';
-export type { Category, CategoryTotal, DateRangeCategoryTotals, MonthlyCategoryTotals, } from './Category';
+export type { Category, CategoryTotal, DateRangeCategoryTotals, DetailedCategory, MonthlyAmount, MonthlyCategoryTotals, } from './Category';
 export type { DateType, DateRange } from './Date';
 export type { Expense } from './Expense';
 export { ExpenseStatus, ScheduledPaymentTypes } from './Expense';
 export type { DynamicCopyElement, GlobalCopy } from './GlobalCopy';
 export type { Goal } from './Goal';
+export type { Debt } from './Debt';
 export type { Institution } from './Institution';
 export * from './localization';
 export type { LocalizedContent } from './LocalizedContent';