@cubedelement.com/realty-investor-timeline 5.2.0 → 5.4.0

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+# [5.4.0](https://github.com/kvernon/realty-investor-timeline/compare/v5.3.0...v5.4.0) (2025-12-19)
+
+
+### Features
+
+* update timeline enddate ([#71](https://github.com/kvernon/realty-investor-timeline/issues/71)) ([e74a6dd](https://github.com/kvernon/realty-investor-timeline/commit/e74a6dd4eaabc43ab593be38411310e470ab7158))
+
+# [5.3.0](https://github.com/kvernon/realty-investor-timeline/compare/v5.2.0...v5.3.0) (2025-12-19)
+
+
+### Features
+
+* more no money; expose properties ([#70](https://github.com/kvernon/realty-investor-timeline/issues/70)) ([52f0ee7](https://github.com/kvernon/realty-investor-timeline/commit/52f0ee718fccc33c4891add239bd50f4228661c8))
+
 # [5.2.0](https://github.com/kvernon/realty-investor-timeline/compare/v5.1.0...v5.2.0) (2025-12-19)
 
 

package/dist/src/calculations/can-invest-by-user.js

@@ -16,18 +16,20 @@ const get_min_cost_down_by_rule_1 = require("./get-min-cost-down-by-rule");
 function canInvestByUser(rental, user, date, properties) {
     const result = new rental_investor_validator_1.RentalInvestorValidator();
     if (rental.isOwned) {
-        result.results.push(new user_invest_result_1.UserInvestResult(investment_reasons_1.InvestmentReasons.PropertyIsAlreadyOwned));
+        result.results.push(new user_invest_result_1.UserInvestResult(investment_reasons_1.InvestmentReasons.PropertyIsAlreadyOwned, '', []));
         return result;
     }
     const minCostDownByRule = (0, get_min_cost_down_by_rule_1.getMinCostDownByRule)(rental, user.purchaseRules);
     if (!user.hasMoneyToInvest(date, properties, minCostDownByRule)) {
-        result.results.push(new user_invest_result_1.UserInvestResult(investment_reasons_1.InvestmentReasons.UserHasNoMoneyToInvest, `user balance: ${user.ledgerCollection.getBalance(date)}`));
+        result.results.push(new user_invest_result_1.UserInvestResult(investment_reasons_1.InvestmentReasons.UserHasNoMoneyToInvest, `user balance: ${user.ledgerCollection.getBalance(date)}`, [
+            { name: 'balance', value: user.ledgerCollection.getBalance(date) },
+        ]));
     }
     if (!user.hasMinimumSavings(date, properties)) {
-        result.results.push(new user_invest_result_1.UserInvestResult(investment_reasons_1.InvestmentReasons.UserHasNotSavedEnoughMoney, `user balance: ${user.ledgerCollection.getBalance(date)}, minimumSavings: ${user.getMinimumSavings(date, properties)}`));
+        result.results.push(new user_invest_result_1.UserInvestResult(investment_reasons_1.InvestmentReasons.UserHasNotSavedEnoughMoney, `user balance: ${user.ledgerCollection.getBalance(date)}, minimumSavings: ${user.getMinimumSavings(date, properties)}`, [{ name: 'balance', value: user.ledgerCollection.getBalance(date) }]));
     }
     if (!user.purchaseRules || user.purchaseRules.length === 0) {
-        result.results.push(new user_invest_result_1.UserInvestResult(investment_reasons_1.InvestmentReasons.NoRules, 'user has no purchase rules'));
+        result.results.push(new user_invest_result_1.UserInvestResult(investment_reasons_1.InvestmentReasons.NoRules, 'user has no purchase rules', []));
         return result;
     }
     if (!result.canInvest) {

package/dist/src/calculations/get-cost-down-user-investment-results.js

@@ -18,7 +18,10 @@ const getCostDownUserInvestmentResults = (rental, _holdRules, purchaseRules) =>
     }
     const userInvestResults = resultReasonToRule.values.map((v) => {
         if (!outOfPocket.evaluate(v)) {
-            return new user_invest_result_1.UserInvestResult(resultReasonToRule.investmentReason, `rule: ${outOfPocket.value} property: ${v}`);
+            return new user_invest_result_1.UserInvestResult(resultReasonToRule.investmentReason, `rule: ${outOfPocket.value} property: ${v}`, [
+                { value: outOfPocket.value, name: 'rule' },
+                { value: v, name: 'property' },
+            ]);
         }
         return null;
     });

package/dist/src/calculations/get-equity-capture-user-investment-results.js

@@ -31,7 +31,10 @@ const getEquityCaptureUserInvestmentResults = (rental, holdRules, purchaseRules,
         }
         const equityCaptureAmount = (0, get_equity_capture_amount_1.getEquityCaptureAmount)(investmentPercent, v, sellPriceEstimate);
         if (!maxCapGains.evaluate(equityCaptureAmount)) {
-            return new user_invest_result_1.UserInvestResult(resultReasonToRule.investmentReason, `rule: ${maxCapGains.value} property: ${equityCaptureAmount}`);
+            return new user_invest_result_1.UserInvestResult(resultReasonToRule.investmentReason, `rule: ${maxCapGains.value} property: ${equityCaptureAmount}`, [
+                { value: maxCapGains.value, name: 'rule' },
+                { value: equityCaptureAmount, name: 'property' },
+            ]);
         }
         return null;
     });

package/dist/src/investments/reason-to-rule.js

@@ -58,7 +58,10 @@ class ReasonToRule {
         }
         return this.values.map((v) => {
             if (!rule.evaluate(v)) {
-                return new user_invest_result_1.UserInvestResult(this.investmentReason, `rule: ${rule.value} property: ${v}`);
+                return new user_invest_result_1.UserInvestResult(this.investmentReason, `rule: ${rule.value} property: ${v}`, [
+                    { name: 'rule', value: rule.value },
+                    { name: 'property', value: v },
+                ]);
             }
         });
     }

package/dist/src/investments/user-invest-result.d.ts

@@ -2,10 +2,21 @@ import { InvestmentReasons } from './investment-reasons';
 export interface IUserInvestResult {
     message: string;
     investmentReason: InvestmentReasons;
+    properties: {
+        name: string;
+        value: number;
+    }[];
 }
 export declare class UserInvestResult implements IUserInvestResult {
     get message(): string;
     investmentReason: InvestmentReasons;
-    constructor(reason?: InvestmentReasons, message?: string);
+    properties: {
+        name: string;
+        value: number;
+    }[];
+    constructor(reason: InvestmentReasons, message: string, properties: {
+        name: string;
+        value: number;
+    }[]);
     private readonly _message;
 }

package/dist/src/investments/user-invest-result.js

@@ -8,9 +8,11 @@ class UserInvestResult {
         return `${investment_reasons_1.InvestmentReasons[this.investmentReason]}${theMessage}`;
     }
     investmentReason;
-    constructor(reason = investment_reasons_1.InvestmentReasons.Unknown, message = '') {
+    properties;
+    constructor(reason = investment_reasons_1.InvestmentReasons.Unknown, message, properties) {
         this.investmentReason = reason;
         this._message = message;
+        this.properties = properties;
     }
     _message;
 }

package/dist/src/time/i-historical-reason.d.ts

@@ -1,4 +1,8 @@
 export interface IHistoricalReason {
     reason: string;
     date: Date;
+    additionalInfo: {
+        name: string;
+        value: number;
+    }[];
 }

package/dist/src/time/looper.js

@@ -19,20 +19,20 @@ const looper = (options, timeline) => {
         const salary = new ledger_1.LedgerItem();
         salary.amount = result.user.monthlySavedAmount;
         salary.type = ledger_1.LedgerItemType.Salary;
-        salary.created = (0, data_clone_date_1.cloneDateUtc)(timeline.endDate, (date) => date.setUTCHours(1));
+        salary.created = (0, data_clone_date_1.cloneDateUtc)(result.endDate, (date) => date.setUTCHours(1));
         salary.note = 'saved for month';
         result.user.ledgerCollection.add(salary);
     }
-    result.rentals = (0, update_historical_rentals_1.updateHistoricalRentals)(properties_1.RentalSingleFamily, options.propertyGeneratorSingleFamily, result.rentals, timeline.endDate, result.user.loanSettings);
-    result.rentals = (0, update_historical_rentals_1.updateHistoricalRentals)(properties_1.RentalPassiveApartment, options.propertyGeneratorPassiveApartment, result.rentals, timeline.endDate, result.user.loanSettings);
+    result.rentals = (0, update_historical_rentals_1.updateHistoricalRentals)(properties_1.RentalSingleFamily, options.propertyGeneratorSingleFamily, result.rentals, result.endDate, result.user.loanSettings);
+    result.rentals = (0, update_historical_rentals_1.updateHistoricalRentals)(properties_1.RentalPassiveApartment, options.propertyGeneratorPassiveApartment, result.rentals, result.endDate, result.user.loanSettings);
     //step 2: get cash flow
     for (let index = 0; index < result.rentals.length; index++) {
         const pr = result.rentals[index];
         if (pr.property && pr.property.isOwned) {
             const cashFlow = new ledger_1.LedgerItem();
-            cashFlow.amount = pr.property.getCashFlowByDate(timeline.endDate);
+            cashFlow.amount = pr.property.getCashFlowByDate(result.endDate);
             cashFlow.type = ledger_1.LedgerItemType.CashFlow;
-            cashFlow.created = (0, data_clone_date_1.cloneDateUtc)(timeline.endDate, (date) => {
+            cashFlow.created = (0, data_clone_date_1.cloneDateUtc)(result.endDate, (date) => {
                 date.setUTCHours(2);
                 date.setUTCMinutes(index);
             });
@@ -47,27 +47,28 @@ const looper = (options, timeline) => {
     }
     //step 3: sell properties
     const forSaleProperties = result.rentals
-        .filter((r) => r.property && r.property.canSell(timeline.endDate))
+        .filter((r) => r.property && r.property.canSell(result.endDate))
         .sort((a, b) => (0, property_sort_1.default)(a.property, b.property, result.user.holdRules));
     for (let index = 0; index < forSaleProperties.length; index++) {
         const pr = forSaleProperties[index];
-        pr.property.soldDate = (0, data_clone_date_1.cloneDateUtc)(timeline.endDate);
+        pr.property.soldDate = (0, data_clone_date_1.cloneDateUtc)(result.endDate);
         const equityFromSell = new ledger_1.LedgerItem();
-        equityFromSell.amount = pr.property.getEquityFromSell(timeline.endDate);
+        equityFromSell.amount = pr.property.getEquityFromSell(result.endDate);
         equityFromSell.type = ledger_1.LedgerItemType.Equity;
-        equityFromSell.created = (0, data_clone_date_1.cloneDateUtc)(timeline.endDate, (date) => {
+        equityFromSell.created = (0, data_clone_date_1.cloneDateUtc)(result.endDate, (date) => {
             date.setUTCHours(3);
             date.setUTCMinutes(index);
         });
         equityFromSell.note = `for: ${pr.property.address}, id: ${pr.property.id} (${properties_1.PropertyType[pr.property.propertyType]})`;
         result.user.ledgerCollection.add(equityFromSell);
     }
-    if (!result.user.hasMoneyToInvest(timeline.endDate, result.rentals.map((x) => x.property).filter((x) => x.isOwned))) {
-        const issue = new investments_1.UserInvestResult(investments_1.InvestmentReasons.UserHasNoMoneyToInvest, `user balance: ${result.user.ledgerCollection.getBalance(result.endDate)}`);
+    if (!result.user.hasMoneyToInvest(result.endDate, result.rentals.map((x) => x.property).filter((x) => x.isOwned))) {
+        const issueUserHasNoMoneyToInvest = new investments_1.UserInvestResult(investments_1.InvestmentReasons.UserHasNoMoneyToInvest, `user balance: ${result.user.ledgerCollection.getBalance(result.endDate)}`, [{ name: 'balance', value: result.user.ledgerCollection.getBalance(result.endDate) }]);
         result.rentals.forEach((r) => {
             r.reasons.push({
-                reason: issue.message,
-                date: (0, data_clone_date_1.cloneDateUtc)(timeline.endDate),
+                reason: issueUserHasNoMoneyToInvest.message,
+                date: (0, data_clone_date_1.cloneDateUtc)(result.endDate),
+                additionalInfo: [{ name: 'balance', value: result.user.ledgerCollection.getBalance(result.endDate) }],
             });
         });
         return result;
@@ -75,12 +76,13 @@ const looper = (options, timeline) => {
     //step 4: buy new properties
     const purchaseRentals = result.rentals
         .map((r) => {
-        if (r.property && r.property.isAvailableByDate(timeline.endDate)) {
-            const validator = r.property.canInvestByUser(result.user, timeline.endDate, result.rentals.map((h) => h.property));
+        if (r.property && r.property.isAvailableByDate(result.endDate)) {
+            const validator = r.property.canInvestByUser(result.user, result.endDate, result.rentals.map((h) => h.property));
             if (!validator.canInvest) {
                 r.reasons = r.reasons.concat(validator.results.map((reasons) => ({
                     reason: reasons.message,
-                    date: (0, data_clone_date_1.cloneDateUtc)(timeline.endDate),
+                    date: (0, data_clone_date_1.cloneDateUtc)(result.endDate),
+                    additionalInfo: reasons.properties,
                 })));
             }
             return validator.canInvest ? r.property : null;
@@ -92,7 +94,7 @@ const looper = (options, timeline) => {
         const rentalProperty = purchaseRentals[index];
         if (rentalProperty) {
             // check cash
-            const purchaseCreated = (0, data_clone_date_1.cloneDateUtc)(timeline.endDate, (date) => {
+            const purchaseCreated = (0, data_clone_date_1.cloneDateUtc)(result.endDate, (date) => {
                 date.setUTCHours(4);
                 date.setUTCMinutes(index);
             });
@@ -108,12 +110,24 @@ const looper = (options, timeline) => {
                 if (!purchase.isAmountGreaterThanZero()) {
                     result.user.ledgerCollection.add(purchase);
                     // set to purchase
-                    rentalProperty.purchaseDate = (0, data_clone_date_1.cloneDateUtc)(timeline.endDate);
+                    rentalProperty.purchaseDate = (0, data_clone_date_1.cloneDateUtc)(result.endDate);
                     if (rentalProperty.propertyType === properties_1.PropertyType.PassiveApartment) {
                         rentalProperty.costDownPrice = minCostDownByRule;
                     }
                 }
             }
+            else {
+                const issueMetMinCostYetUserHasNoMoneyToInvest = new investments_1.UserInvestResult(investments_1.InvestmentReasons.UserHasNoMoneyToInvest, `user balance: ${result.user.ledgerCollection.getBalance(result.endDate)}`, [{ name: 'balance', value: result.user.ledgerCollection.getBalance(result.endDate) }]);
+                result.rentals
+                    .filter((x) => x.property.id === rentalProperty.id)
+                    .forEach((r) => {
+                    r.reasons.push({
+                        reason: issueMetMinCostYetUserHasNoMoneyToInvest.message,
+                        date: (0, data_clone_date_1.cloneDateUtc)(result.endDate),
+                        additionalInfo: issueMetMinCostYetUserHasNoMoneyToInvest.properties,
+                    });
+                });
+            }
         }
     }
     return result;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cubedelement.com/realty-investor-timeline",
-  "version": "5.2.0",
+  "version": "5.4.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",