@mx-cartographer/experiences 6.3.13 → 6.3.14

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -8,25 +8,82 @@ export declare class RecurringTransactionsStore {
8
8
  selectedDay: Date | undefined;
9
9
  isDataLoaded: boolean;
10
10
  constructor(globalStore: GlobalStore);
11
+ /**
12
+ * Returns all recurrences built from repeating transactions and filtered by accounts.
13
+ */
11
14
  get recurrences(): Recurrence[];
15
+ /**
16
+ * Returns all recurrences that have been paid.
17
+ */
12
18
  get paidRecurrences(): Recurrence[];
19
+ /**
20
+ * Returns all recurrences that are expected to occur in the next 30 days or should have occurred
21
+ * is the last 3 days.
22
+ */
13
23
  get upcomingRecurrences(): Recurrence[];
24
+ /**
25
+ * Returns all expense recurrences.
26
+ */
14
27
  get expenses(): Recurrence[];
15
- get paidExpenses(): Recurrence[];
16
- get missedExpenses(): Recurrence[];
28
+ /**
29
+ * Returns all income recurrences.
30
+ */
17
31
  get income(): Recurrence[];
18
- get paidIncome(): Recurrence[];
19
- get upcomingIncome(): Recurrence[];
32
+ /**
33
+ * Returns the expense recurrences for the current month.
34
+ */
35
+ get currentMonthExpenses(): Recurrence[];
36
+ /**
37
+ * Returns the income recurrences for the current month.
38
+ */
39
+ get currentMonthIncome(): Recurrence[];
40
+ /**
41
+ * Calculates the total amount of all expenses for the current month.
42
+ */
20
43
  get expenseTotal(): number;
44
+ /**
45
+ * Calculates the total amount of all paid expenses for the current month.
46
+ */
21
47
  get paidExpenseTotal(): number;
48
+ /**
49
+ * Calculates the total amount of all missed expenses for the current month.
50
+ */
22
51
  get missedExpenseTotal(): number;
52
+ /**
53
+ * Calculates the total amount of all income for the current month.
54
+ */
23
55
  get incomeTotal(): number;
56
+ /**
57
+ * Calculates the total amount of all paid income for the current month.
58
+ */
24
59
  get paidIncomeTotal(): number;
25
- get projectedIncome(): number;
60
+ /**
61
+ * Get the recurrences for the currently selected day.
62
+ */
26
63
  get selectedDayRecurrences(): Recurrence[] | undefined;
64
+ /**
65
+ * Set the currently selected day.
66
+ * @param day - The day to select.
67
+ */
27
68
  setSelectedDay: (day: Date) => void;
69
+ /**
70
+ * Load repeating transactions and augment them with additional data.
71
+ */
28
72
  loadRepeatingTransactions: () => Promise<void>;
73
+ /**
74
+ * Add a new repeating transaction and link it to the associated transaction.
75
+ * @param repeatingTransaction - The repeating transaction to add.
76
+ * @param transaction - The transaction associated with the repeating transaction.
77
+ */
29
78
  addRepeatingTransaction: (repeatingTransaction: RepeatingTransaction, transaction: Transaction) => Promise<void>;
79
+ /**
80
+ * Delete a repeating transaction by its GUID.
81
+ * @param guid - The GUID of the repeating transaction to delete.
82
+ */
30
83
  deleteRepeatingTransaction: (guid: string) => Promise<void>;
84
+ /**
85
+ * Update an existing repeating transaction.
86
+ * @param transaction - The repeating transaction to update.
87
+ */
31
88
  updateRepeatingTransaction: (transaction: RepeatingTransaction) => Promise<void>;
32
89
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@mx-cartographer/experiences",
3
- "version": "6.3.13",
3
+ "version": "6.3.14",
4
4
  "description": "Library containing experience widgets",
5
5
  "main": "dist/index.es.js",
6
6
  "types": "dist/index.d.ts",