@cubedelement.com/realty-investor-timeline 5.1.0 → 5.3.0

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+# [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)
+
+
+### Features
+
+* added error reason for no money ([#69](https://github.com/kvernon/realty-investor-timeline/issues/69)) ([2d17a48](https://github.com/kvernon/realty-investor-timeline/commit/2d17a486541d3a349c70f8cb962b57bf439b10e3))
+
 # [5.1.0](https://github.com/kvernon/realty-investor-timeline/compare/v5.0.0...v5.1.0) (2025-11-14)
 
 

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

@@ -10,6 +10,7 @@ const update_historical_rentals_1 = require("./update-historical-rentals");
 const properties_1 = require("../properties");
 const property_sort_1 = __importDefault(require("../properties/property-sort"));
 const get_min_cost_down_by_rule_1 = require("../calculations/get-min-cost-down-by-rule");
+const investments_1 = require("../investments");
 const looper = (options, timeline) => {
     const result = timeline.clone();
     result.endDate.setUTCMonth(result.endDate.getUTCMonth() + 1);
@@ -62,6 +63,14 @@ const looper = (options, timeline) => {
         result.user.ledgerCollection.add(equityFromSell);
     }
     if (!result.user.hasMoneyToInvest(timeline.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: issueUserHasNoMoneyToInvest.message,
+                date: (0, data_clone_date_1.cloneDateUtc)(timeline.endDate),
+                additionalInfo: [{ name: 'balance', value: result.user.ledgerCollection.getBalance(result.endDate) }],
+            });
+        });
         return result;
     }
     //step 4: buy new properties
@@ -73,6 +82,7 @@ const looper = (options, timeline) => {
                 r.reasons = r.reasons.concat(validator.results.map((reasons) => ({
                     reason: reasons.message,
                     date: (0, data_clone_date_1.cloneDateUtc)(timeline.endDate),
+                    additionalInfo: reasons.properties,
                 })));
             }
             return validator.canInvest ? r.property : null;
@@ -106,6 +116,18 @@ const looper = (options, timeline) => {
                     }
                 }
             }
+            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)(timeline.endDate),
+                        additionalInfo: issueMetMinCostYetUserHasNoMoneyToInvest.properties,
+                    });
+                });
+            }
         }
     }
     return result;

package/package.json

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