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

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+# [5.5.0](https://github.com/kvernon/realty-investor-timeline/compare/v5.4.0...v5.5.0) (2025-12-21)
+
+
+### Features
+
+* expose cache time ([#72](https://github.com/kvernon/realty-investor-timeline/issues/72)) ([5e1c35f](https://github.com/kvernon/realty-investor-timeline/commit/5e1c35f0d838c6bf7f11e5cd0b380bf4ff6a7203))
+
+# [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)
 
 

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,27 @@ 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))) {
+    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: issueUserHasNoMoneyToInvest.message,
-                date: (0, data_clone_date_1.cloneDateUtc)(timeline.endDate),
+                date: (0, data_clone_date_1.cloneDateUtc)(result.endDate),
                 additionalInfo: [{ name: 'balance', value: result.user.ledgerCollection.getBalance(result.endDate) }],
             });
         });
@@ -76,12 +76,12 @@ 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,
                 })));
             }
@@ -94,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);
             });
@@ -110,7 +110,7 @@ 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;
                     }
@@ -123,7 +123,7 @@ const looper = (options, timeline) => {
                     .forEach((r) => {
                     r.reasons.push({
                         reason: issueMetMinCostYetUserHasNoMoneyToInvest.message,
-                        date: (0, data_clone_date_1.cloneDateUtc)(timeline.endDate),
+                        date: (0, data_clone_date_1.cloneDateUtc)(result.endDate),
                         additionalInfo: issueMetMinCostYetUserHasNoMoneyToInvest.properties,
                     });
                 });

package/dist/src/time/simulate.d.ts

@@ -10,6 +10,10 @@ export interface IGenOptions extends IPropertyEntityOptions {
      * Used to provide an amount of Random properties
      */
     maxRentalOpportunities: number;
+    /**
+     * Used to say how long a property should be cached
+     */
+    maxMonthsToCache?: number;
 }
 export interface ISimulateOptions {
     /**

package/dist/src/time/simulate.js

@@ -76,14 +76,16 @@ function simulate(options = {
         lowestEquityCapturePercent: 7,
         highestEquityCapturePercent: 15,
         maxRentalOpportunities: 4,
+        maxMonthsToCache: 2,
     },
 }) {
     const formattedUtcDate = (0, data_clone_date_1.cloneDateUtc)(options.startDate ?? new Date());
     if (!options.generatorOptionsPassiveApartment && !options.generatorOptionsSingleFamily) {
         throw new Error('Invalid Argument: must declare at least 1, either generatorOptionsSingleFamily or generatorOptionsPassiveApartment');
     }
-    const propertyGeneratorSingleFamily = Object.assign(new rental_generator_1.RentalGenerator(new value_cache_1.ValueCache((0, data_clone_date_1.cloneDateUtc)(formattedUtcDate), [], 2), factory_single_family_1.generateSingleFamily), options.generatorOptionsSingleFamily);
-    const propertyGeneratorPassiveApartment = Object.assign(new rental_generator_1.RentalGenerator(new value_cache_1.ValueCache((0, data_clone_date_1.cloneDateUtc)(formattedUtcDate), [], 2), factory_passive_apartment_1.generateRentalPassiveApartment), options.generatorOptionsPassiveApartment);
+    const defaultMaxMonthsToCache = 2;
+    const propertyGeneratorSingleFamily = Object.assign(new rental_generator_1.RentalGenerator(new value_cache_1.ValueCache((0, data_clone_date_1.cloneDateUtc)(formattedUtcDate), [], options.generatorOptionsSingleFamily?.maxMonthsToCache || defaultMaxMonthsToCache), factory_single_family_1.generateSingleFamily), options.generatorOptionsSingleFamily);
+    const propertyGeneratorPassiveApartment = Object.assign(new rental_generator_1.RentalGenerator(new value_cache_1.ValueCache((0, data_clone_date_1.cloneDateUtc)(formattedUtcDate), [], options.generatorOptionsPassiveApartment?.maxMonthsToCache || defaultMaxMonthsToCache), factory_passive_apartment_1.generateRentalPassiveApartment), options.generatorOptionsPassiveApartment);
     const totalSavings = new ledger_1.LedgerItem();
     totalSavings.amount = options.amountInSavings;
     totalSavings.note = 'money saved up before you start';

package/package.json

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