@cubedelement.com/realty-investor-timeline 5.6.0 → 5.7.0

package/CHANGELOG.md

@@ -1,3 +1,10 @@
+# [5.7.0](https://github.com/kvernon/realty-investor-timeline/compare/v5.6.0...v5.7.0) (2026-01-15)
+
+
+### Features
+
+* quarterly summaries ([#75](https://github.com/kvernon/realty-investor-timeline/issues/75)) ([5401e78](https://github.com/kvernon/realty-investor-timeline/commit/5401e786d118bb9accb4fa7418fd05cddd481fea))
+
 # [5.6.0](https://github.com/kvernon/realty-investor-timeline/compare/v5.5.1...v5.6.0) (2026-01-13)
 
 

package/dist/src/ledger/i-ledger-summary.d.ts

@@ -6,3 +6,9 @@ export interface ILedgerSummary {
     purchases: number;
     equity: number;
 }
+export interface ILedgerDetailSummary extends ILedgerSummary {
+    /**
+     * a way to determine the average monthly cash flow using the quarterly totals
+     */
+    averageQuarterlyCashFlow: number;
+}

package/dist/src/ledger/ledger-collection.d.ts

@@ -1,5 +1,5 @@
 import { LedgerItem } from './ledger-item';
-import { ILedgerSummary } from './i-ledger-summary';
+import { ILedgerDetailSummary, ILedgerSummary } from './i-ledger-summary';
 import { LedgerItemType } from './ledger-item-type';
 import { IRentalPropertyEntity } from '../properties';
 export interface ILedgerCollection {
@@ -107,7 +107,7 @@ export declare class LedgerCollection implements ILedgerCollection {
     getCashFlowMonth(date?: Date): number;
     getAverageCashFlowMonthByQuarter(date?: Date): number;
     getCashFlowQuarter(date?: Date): number;
-    getSummaryMonth(date: Date): ILedgerSummary;
+    getSummaryMonth(date: Date): ILedgerDetailSummary;
     getSummaryAnnual(year?: number): ILedgerSummary;
     getSummariesAnnual(year?: number): ILedgerSummary[];
     /**

package/dist/src/ledger/ledger-collection.js

@@ -132,10 +132,9 @@ class LedgerCollection {
         if (!date) {
             date = this.collection.last().created;
         }
-        const quarter = Math.floor(date.getUTCMonth() / 3);
-        const year = date.getUTCFullYear();
+        const quarter = (0, get_date_quarter_1.getDateQuarter)(date);
         const boundary = this.filter((li) => {
-            return li.dateMatchesYearAndQuarter(year, quarter);
+            return li.dateLessThanOrEqualToAndQuarter(date, quarter);
         });
         if (boundary.length === 0) {
             return 0;
@@ -144,14 +143,11 @@ class LedgerCollection {
         if (cashFlowItems.length === 0) {
             return 0;
         }
-        if (cashFlowItems.length === 0) {
-            return 0;
-        }
         const firstMonth = cashFlowItems[0].created.getUTCMonth();
         const lastMonth = cashFlowItems[cashFlowItems.length - 1].created.getUTCMonth();
         const monthsWithData = lastMonth - firstMonth + 1;
         const totalCashFlow = this.getCashFlowQuarter(date);
-        return totalCashFlow / monthsWithData;
+        return (0, currency_1.default)(totalCashFlow / monthsWithData);
     }
     getCashFlowQuarter(date) {
         if (this.isEmpty()) {
@@ -161,9 +157,8 @@ class LedgerCollection {
             date = this.collection.last().created;
         }
         const quarter = (0, get_date_quarter_1.getDateQuarter)(date);
-        const year = date.getUTCFullYear();
         const boundary = this.filter((li) => {
-            return li.dateMatchesYearAndQuarter(year, quarter);
+            return li.dateLessThanOrEqualToAndQuarter(date, quarter);
         });
         return this.getSummaryByType(boundary, ledger_item_type_1.LedgerItemType.CashFlow);
     }
@@ -176,6 +171,7 @@ class LedgerCollection {
             balance: 0,
             cashFlow: 0,
             averageCashFlow: 0,
+            averageQuarterlyCashFlow: 0,
             equity: 0,
             purchases: 0,
         };
@@ -192,6 +188,7 @@ class LedgerCollection {
         result.equity = this.getSummaryByType(boundary, ledger_item_type_1.LedgerItemType.Equity);
         result.purchases = this.getSummaryByType(boundary, ledger_item_type_1.LedgerItemType.Purchase);
         result.balance = this.filter((li) => li.dateNotGreaterThan(date)).reduce((previousValue, currentValue) => previousValue + currentValue.amount, 0);
+        result.averageQuarterlyCashFlow = this.getAverageCashFlowMonthByQuarter(date);
         return result;
     }
     getSummaryAnnual(year) {
@@ -229,7 +226,6 @@ class LedgerCollection {
         }
         const collection = [];
         const lastLedgerItem = boundary[boundary.length - 1];
-        //need to determine monthDiff between boundary
         const totalMonths = (0, date_fns_1.differenceInMonths)(boundary[0].created, lastLedgerItem.created);
         if (totalMonths === 0) {
             collection.push(this.getSummaryMonth(boundary[0].created));

package/dist/src/ledger/ledger-item.d.ts

@@ -1,4 +1,5 @@
 import { LedgerItemType } from './ledger-item-type';
+import { QuarterType } from '../utils/get-date-quarter';
 /**
  * this is an entry into the account. Think of it as a checking account, and it's simply a transaction line.
  */
@@ -12,12 +13,23 @@ export declare class LedgerItem {
     /**
      * if one is found, a zero based quarter number, otherwise you'll get -1
      */
-    getQuarter(): number;
+    getQuarter(): -1 | QuarterType;
     isAmountGreaterThanZero(): boolean;
     dateMatchesYearAndMonth(today: Date): boolean;
     dateLessThanOrEqualTo(today: Date): boolean;
     dateNotGreaterThan(today: Date): boolean;
     dateMatchesYear(year: number): boolean;
+    /**
+     * returns true if the date is less than or equal to the date passed in and the quarter matches
+     * @param date
+     * @param quarter
+     */
+    dateLessThanOrEqualToAndQuarter(date: Date, quarter: QuarterType): boolean;
+    /**
+     * @deprecated, use {@link dateLessThanOrEqualToAndQuarter}
+     * @param year
+     * @param quarter
+     */
     dateMatchesYearAndQuarter(year: number, quarter: number): boolean;
     typeMatches(itemType: LedgerItemType): boolean;
     getYear(): number;

package/dist/src/ledger/ledger-item.js

@@ -70,6 +70,25 @@ class LedgerItem {
         }
         return year === this.created.getUTCFullYear();
     }
+    /**
+     * returns true if the date is less than or equal to the date passed in and the quarter matches
+     * @param date
+     * @param quarter
+     */
+    dateLessThanOrEqualToAndQuarter(date, quarter) {
+        if (!this.created) {
+            return false;
+        }
+        if (!this.dateLessThanOrEqualTo(date)) {
+            return false;
+        }
+        return this.getQuarter() === quarter;
+    }
+    /**
+     * @deprecated, use {@link dateLessThanOrEqualToAndQuarter}
+     * @param year
+     * @param quarter
+     */
     dateMatchesYearAndQuarter(year, quarter) {
         if (!this.created) {
             return false;

package/dist/src/utils/get-date-quarter.d.ts

@@ -1 +1,9 @@
-export declare const getDateQuarter: (date: Date) => number;
+/**
+ * zero based quarter numbers
+ */
+export type QuarterType = 0 | 1 | 2 | 3;
+/**
+ * takes a date and return the quarter it belongs to, which will be 0, 1, 2, or 3
+ * @param date
+ */
+export declare const getDateQuarter: (date: Date) => QuarterType;

package/dist/src/utils/get-date-quarter.js

@@ -1,5 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getDateQuarter = void 0;
+/**
+ * takes a date and return the quarter it belongs to, which will be 0, 1, 2, or 3
+ * @param date
+ */
 const getDateQuarter = (date) => Math.floor(date.getUTCMonth() / 3);
 exports.getDateQuarter = getDateQuarter;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cubedelement.com/realty-investor-timeline",
-  "version": "5.6.0",
+  "version": "5.7.0",
   "description": "A way to determine if and when your expenses would be covered",
   "main": "./dist/src/index.js",
   "types": "./dist/src/index.d.ts",