@mx-cartographer/experiences 3.13.4-alpha.mm3 → 3.13.5-alpha.mm.0

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,4 +1,5 @@
 import { default as React, CSSProperties } from 'react';
+import { MarkHandlers } from './linechart/CustomMark';
 interface LineChartProps {
     baseline?: string;
     colors: (string | undefined)[];
@@ -6,10 +7,10 @@ interface LineChartProps {
         x: string;
         y: number;
     }[][];
-    onMarkClick?: (event: React.MouseEvent<SVGPathElement, MouseEvent>, dataIndex: number) => void;
     height?: number;
-    getMarkStyles?: (markIndex: number) => CSSProperties;
     labels: string[];
+    markHandlers?: MarkHandlers;
+    markStyles?: (markIndex: number) => CSSProperties;
     showArea?: boolean;
     showAverage?: boolean;
     showBars?: boolean;

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

@@ -1,7 +1,12 @@
 import { default as React } from 'react';
 import { MarkElementProps } from '@mui/x-charts';
-interface CustomMarkProps extends MarkElementProps {
+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[];
 }

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

@@ -1,2 +1 @@
 export { default as Dialog } from './Dialog';
-export { default as ErrorDialog } from './ErrorDialog';

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/index.d.ts

@@ -6,7 +6,7 @@ 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';

package/dist/common/utils/Categories.d.ts

@@ -1,3 +1,6 @@
-import { Category, CategoryTotal, DateRangeCategoryTotals } from '../types';
+import { Category, CategoryTotal, DateRangeCategoryTotals, DetailedCategory } from '../types';
 export declare const getCategory: (categories: Category[], categoryGuid: string | undefined) => Category | undefined;
+export declare const getDetailedCategory: (detailedCategories: DetailedCategory[], guid: string | undefined) => DetailedCategory | undefined;
+export declare const getDetailedSubCategory: (detailedCategories: DetailedCategory[], guid: string | undefined) => DetailedCategory | undefined;
 export declare const getCategoryTotalsByParent: (categories: Category[], dateRangeTotals: DateRangeCategoryTotals[]) => CategoryTotal[];
+export declare const isIncome: (categories: Category[], guid: string) => boolean;

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

@@ -1,5 +1,5 @@
 export { analyticsSession } from './Analytics';
-export { getCategory, getCategoryTotalsByParent } from './Categories';
+export { getCategory, getDetailedCategory, getDetailedSubCategory, getCategoryTotalsByParent, isIncome, } from './Categories';
 export { Fetch } from './Fetch';
 export { buildDynamicCopy, buildPluralCopy, getLocale } from './Localization';
 export { formatCurrency, formatOrdinal, formatPercentage, getCurrencyCodes, isValidNumber, } from './NumberFormatting';