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

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+## [5.5.1](https://github.com/kvernon/realty-investor-timeline/compare/v5.5.0...v5.5.1) (2026-01-02)
+
+
+### Bug Fixes
+
+* boundary, date ([#73](https://github.com/kvernon/realty-investor-timeline/issues/73)) ([1ce43db](https://github.com/kvernon/realty-investor-timeline/commit/1ce43db993397760d2e41e207481f7999158282a))
+
+# [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)
 
 

package/dist/src/caching/value-cache.js

@@ -5,7 +5,9 @@ const getNextExpire = (current, cacheExpireDate, advanceInMonths) => {
     if (!current) {
         return cacheExpireDate;
     }
-    return new Date(Date.UTC(current.getUTCFullYear(), current.getUTCMonth() + advanceInMonths, 1));
+    const date = new Date(Date.UTC(current.getUTCFullYear(), current.getUTCMonth(), 1));
+    date.setUTCMonth(date.getUTCMonth() + advanceInMonths);
+    return date;
 };
 class ValueCache {
     renewalInMonths;

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

@@ -181,7 +181,7 @@ class LedgerCollection {
             return [];
         }
         const boundary = year ? this.filter((li) => li.dateMatchesYear(year)) : this.filter();
-        if (!boundary) {
+        if (!boundary || boundary.length === 0) {
             return [];
         }
         const collection = [];

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/dist/src/utils/data-clone-date.js

@@ -7,7 +7,7 @@ exports.cloneDateUtc = void 0;
  * @param [datePredicate]
  */
 function cloneDateUtc(date, datePredicate) {
-    const result = new Date(Date.parse(date.toUTCString()));
+    const result = new Date(Date.UTC(date.getUTCFullYear(), date.getUTCMonth(), 1));
     result.setUTCDate(1);
     result.setUTCHours(0);
     result.setUTCMinutes(0);

package/package.json

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