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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (186) hide show
  1. package/CHANGELOG.md +14 -0
  2. package/dist/src/account/i-user-goal.d.ts +5 -0
  3. package/dist/src/account/user.d.ts +20 -1
  4. package/dist/src/account/user.js +21 -0
  5. package/dist/src/ledger/i-ledger-summary.d.ts +6 -0
  6. package/dist/src/ledger/ledger-collection.d.ts +6 -2
  7. package/dist/src/ledger/ledger-collection.js +40 -1
  8. package/dist/src/ledger/ledger-item.d.ts +17 -0
  9. package/dist/src/ledger/ledger-item.js +38 -0
  10. package/dist/src/time/default-has-met-goal-or-max-time.js +1 -1
  11. package/dist/src/time/looper.js +1 -1
  12. package/dist/src/utils/get-date-quarter.d.ts +9 -0
  13. package/dist/src/utils/get-date-quarter.js +9 -0
  14. package/package.json +1 -1
  15. package/.github/dependabot.yml +0 -10
  16. package/docs/_media/badge.svg +0 -1
  17. package/docs/account/i-user-goal/index.md +0 -11
  18. package/docs/account/i-user-goal/interfaces/IUserGoal.md +0 -47
  19. package/docs/account/i-user-investor-check/index.md +0 -11
  20. package/docs/account/i-user-investor-check/interfaces/IUserInvestorCheck.md +0 -206
  21. package/docs/account/index.md +0 -31
  22. package/docs/account/user/classes/User.md +0 -312
  23. package/docs/account/user/index.md +0 -15
  24. package/docs/account/user/interfaces/IUser.md +0 -282
  25. package/docs/caching/index.md +0 -19
  26. package/docs/caching/value-cache/classes/ValueCache.md +0 -194
  27. package/docs/caching/value-cache/index.md +0 -15
  28. package/docs/caching/value-cache/interfaces/IValueCache.md +0 -104
  29. package/docs/calculations/can-invest-by-user/functions/canInvestByUser.md +0 -35
  30. package/docs/calculations/can-invest-by-user/index.md +0 -11
  31. package/docs/calculations/cash-on-cash-return/functions/cashOnCashReturn.md +0 -29
  32. package/docs/calculations/cash-on-cash-return/index.md +0 -11
  33. package/docs/calculations/get-cost-down/functions/getCostDown.md +0 -27
  34. package/docs/calculations/get-cost-down/index.md +0 -11
  35. package/docs/calculations/get-cost-down-user-investment-results/functions/getCostDownUserInvestmentResults.md +0 -33
  36. package/docs/calculations/get-cost-down-user-investment-results/index.md +0 -11
  37. package/docs/calculations/get-equity-capture-amount/functions/getEquityCaptureAmount.md +0 -31
  38. package/docs/calculations/get-equity-capture-amount/index.md +0 -11
  39. package/docs/calculations/get-equity-capture-user-investment-results/functions/getEquityCaptureUserInvestmentResults.md +0 -33
  40. package/docs/calculations/get-equity-capture-user-investment-results/index.md +0 -11
  41. package/docs/calculations/get-investment-percent/functions/getInvestmentPercent.md +0 -27
  42. package/docs/calculations/get-investment-percent/index.md +0 -11
  43. package/docs/calculations/get-min-cost-down-by-rule/functions/getMinCostDownByRule.md +0 -25
  44. package/docs/calculations/get-min-cost-down-by-rule/index.md +0 -11
  45. package/docs/calculations/get-monthly-mortgage/functions/getMonthlyMortgage.md +0 -43
  46. package/docs/calculations/get-monthly-mortgage/index.md +0 -11
  47. package/docs/calculations/get-monthly-principal-interest-tax-interest/functions/getMonthlyPrincipalInterestTaxInterest.md +0 -43
  48. package/docs/calculations/get-monthly-principal-interest-tax-interest/index.md +0 -11
  49. package/docs/calculations/get-sell-price-estimate/functions/getSellPriceEstimate.md +0 -33
  50. package/docs/calculations/get-sell-price-estimate/index.md +0 -11
  51. package/docs/calculations/index.md +0 -73
  52. package/docs/calculations/return-on-capital-gain/functions/returnOnCapitalGain.md +0 -31
  53. package/docs/calculations/return-on-capital-gain/index.md +0 -11
  54. package/docs/formatters/currency/functions/default.md +0 -21
  55. package/docs/formatters/currency/index.md +0 -11
  56. package/docs/formatters/index.md +0 -7
  57. package/docs/generators/factory-passive-apartment/functions/generateRentalPassiveApartment.md +0 -35
  58. package/docs/generators/factory-passive-apartment/index.md +0 -11
  59. package/docs/generators/factory-single-family/functions/generateSingleFamily.md +0 -35
  60. package/docs/generators/factory-single-family/index.md +0 -11
  61. package/docs/generators/generate-property/index.md +0 -11
  62. package/docs/generators/generate-property/type-aliases/GenerateProperty.md +0 -37
  63. package/docs/generators/generic-generate-property/functions/genericGenerateProperty.md +0 -35
  64. package/docs/generators/generic-generate-property/index.md +0 -11
  65. package/docs/generators/i-property-entity-options/index.md +0 -11
  66. package/docs/generators/i-property-entity-options/interfaces/IPropertyEntityOptions.md +0 -113
  67. package/docs/generators/index.md +0 -49
  68. package/docs/generators/rental-generator/classes/RentalGenerator.md +0 -248
  69. package/docs/generators/rental-generator/index.md +0 -15
  70. package/docs/generators/rental-generator/interfaces/IRentalGenerator.md +0 -65
  71. package/docs/index/index.md +0 -487
  72. package/docs/index.md +0 -258
  73. package/docs/investments/index.md +0 -85
  74. package/docs/investments/investment-reasons/enumerations/InvestmentReasons.md +0 -119
  75. package/docs/investments/investment-reasons/index.md +0 -11
  76. package/docs/investments/investment-reasons-decorator/functions/InvestmentReasonForHoldRuleTypes.md +0 -25
  77. package/docs/investments/investment-reasons-decorator/functions/InvestmentReasonForPurchaseRuleTypes.md +0 -25
  78. package/docs/investments/investment-reasons-decorator/functions/getInvestmentReasons.md +0 -33
  79. package/docs/investments/investment-reasons-decorator/functions/getInvestmentReasonsForPurchaseTypes.md +0 -25
  80. package/docs/investments/investment-reasons-decorator/index.md +0 -18
  81. package/docs/investments/investment-reasons-decorator/type-aliases/PropertyDecoratorType.md +0 -29
  82. package/docs/investments/reason-to-rule/classes/ReasonToRule.md +0 -263
  83. package/docs/investments/reason-to-rule/index.md +0 -16
  84. package/docs/investments/reason-to-rule/interfaces/IReasonToRule.md +0 -189
  85. package/docs/investments/reason-to-rule/interfaces/IReasonToRuleMeta.md +0 -33
  86. package/docs/investments/rental-investor-validator/classes/RentalInvestorValidator.md +0 -53
  87. package/docs/investments/rental-investor-validator/index.md +0 -15
  88. package/docs/investments/rental-investor-validator/interfaces/IRentalInvestorValidator.md +0 -25
  89. package/docs/investments/user-invest-result/classes/UserInvestResult.md +0 -65
  90. package/docs/investments/user-invest-result/index.md +0 -15
  91. package/docs/investments/user-invest-result/interfaces/IUserInvestResult.md +0 -25
  92. package/docs/investments/user-result-estimates/index.md +0 -11
  93. package/docs/investments/user-result-estimates/type-aliases/UserResultEstimates.md +0 -33
  94. package/docs/ledger/i-ledger-summary/index.md +0 -11
  95. package/docs/ledger/i-ledger-summary/interfaces/ILedgerSummary.md +0 -57
  96. package/docs/ledger/index.md +0 -43
  97. package/docs/ledger/ledger-collection/classes/LedgerCollection.md +0 -425
  98. package/docs/ledger/ledger-collection/index.md +0 -19
  99. package/docs/ledger/ledger-collection/interfaces/ILedgerCollection.md +0 -313
  100. package/docs/ledger/ledger-collection/type-aliases/LedgerItemPredicate.md +0 -25
  101. package/docs/ledger/ledger-item/classes/LedgerItem.md +0 -211
  102. package/docs/ledger/ledger-item/index.md +0 -11
  103. package/docs/ledger/ledger-item-type/enumerations/LedgerItemType.md +0 -57
  104. package/docs/ledger/ledger-item-type/index.md +0 -11
  105. package/docs/loans/i-loan-settings/index.md +0 -11
  106. package/docs/loans/i-loan-settings/interfaces/ILoanSetting.md +0 -33
  107. package/docs/loans/index.md +0 -19
  108. package/docs/loans/loan-settings/enumerations/LoanSettings.md +0 -41
  109. package/docs/loans/loan-settings/index.md +0 -11
  110. package/docs/modules.md +0 -88
  111. package/docs/properties/i-entity-existence/index.md +0 -11
  112. package/docs/properties/i-entity-existence/interfaces/IEntityExistence.md +0 -33
  113. package/docs/properties/i-property-entity/index.md +0 -11
  114. package/docs/properties/i-property-entity/interfaces/IPropertyEntity.md +0 -159
  115. package/docs/properties/i-rental-property-entity/index.md +0 -11
  116. package/docs/properties/i-rental-property-entity/interfaces/IRentalPropertyEntity.md +0 -416
  117. package/docs/properties/index.md +0 -43
  118. package/docs/properties/property-sort/functions/default.md +0 -35
  119. package/docs/properties/property-sort/index.md +0 -11
  120. package/docs/properties/property-type/enumerations/PropertyType.md +0 -33
  121. package/docs/properties/property-type/index.md +0 -11
  122. package/docs/properties/rental-passive-apartment/classes/RentalPassiveApartment.md +0 -558
  123. package/docs/properties/rental-passive-apartment/index.md +0 -11
  124. package/docs/properties/rental-single-family/classes/RentalSingleFamily.md +0 -639
  125. package/docs/properties/rental-single-family/index.md +0 -11
  126. package/docs/rules/eval-type/index.md +0 -11
  127. package/docs/rules/eval-type/type-aliases/EvalType.md +0 -25
  128. package/docs/rules/eval-types/functions/AtLeastOrMore.md +0 -25
  129. package/docs/rules/eval-types/functions/NoMoreThan.md +0 -25
  130. package/docs/rules/eval-types/index.md +0 -12
  131. package/docs/rules/get-enum-type-by-value/functions/getEnumTypeByValue.md +0 -23
  132. package/docs/rules/get-enum-type-by-value/index.md +0 -11
  133. package/docs/rules/get-rules/functions/getRules.md +0 -27
  134. package/docs/rules/get-rules/index.md +0 -11
  135. package/docs/rules/hold-rule-types/enumerations/HoldRuleTypes.md +0 -49
  136. package/docs/rules/hold-rule-types/index.md +0 -11
  137. package/docs/rules/i-rule/index.md +0 -11
  138. package/docs/rules/i-rule/interfaces/IRule.md +0 -41
  139. package/docs/rules/index.md +0 -67
  140. package/docs/rules/purchase-rule-types/enumerations/PurchaseRuleTypes.md +0 -78
  141. package/docs/rules/purchase-rule-types/index.md +0 -11
  142. package/docs/rules/rule-evaluation/classes/RuleEvaluation.md +0 -103
  143. package/docs/rules/rule-evaluation/index.md +0 -15
  144. package/docs/rules/rule-evaluation/interfaces/IRuleEvaluation.md +0 -73
  145. package/docs/time/default-has-met-goal-or-max-time/functions/defaultHasMetGoalOrMaxTime.md +0 -39
  146. package/docs/time/default-has-met-goal-or-max-time/index.md +0 -11
  147. package/docs/time/has-met-goal-or-max-time/index.md +0 -11
  148. package/docs/time/has-met-goal-or-max-time/type-aliases/HasMetGoalOrMaxTime.md +0 -39
  149. package/docs/time/i-historical-property/index.md +0 -11
  150. package/docs/time/i-historical-property/interfaces/IHistoricalProperty.md +0 -25
  151. package/docs/time/i-historical-reason/index.md +0 -11
  152. package/docs/time/i-historical-reason/interfaces/IHistoricalReason.md +0 -25
  153. package/docs/time/i-loop-options/index.md +0 -11
  154. package/docs/time/i-loop-options/interfaces/ILoopOptions.md +0 -71
  155. package/docs/time/i-loop-recursive-options/index.md +0 -11
  156. package/docs/time/i-loop-recursive-options/interfaces/ILoopRecursiveOptions.md +0 -33
  157. package/docs/time/index.md +0 -85
  158. package/docs/time/looper/functions/looper.md +0 -25
  159. package/docs/time/looper/index.md +0 -15
  160. package/docs/time/looper/type-aliases/LooperType.md +0 -25
  161. package/docs/time/movement/functions/movement.md +0 -27
  162. package/docs/time/movement/index.md +0 -11
  163. package/docs/time/simulate/functions/simulate.md +0 -23
  164. package/docs/time/simulate/index.md +0 -16
  165. package/docs/time/simulate/interfaces/IGenOptions.md +0 -163
  166. package/docs/time/simulate/interfaces/ISimulateOptions.md +0 -115
  167. package/docs/time/timeline/classes/Timeline.md +0 -175
  168. package/docs/time/timeline/index.md +0 -15
  169. package/docs/time/timeline/interfaces/ITimeline.md +0 -83
  170. package/docs/time/update-historical-rentals/functions/updateHistoricalRentals.md +0 -41
  171. package/docs/time/update-historical-rentals/index.md +0 -11
  172. package/docs/utils/data-are-same-date/functions/default.md +0 -25
  173. package/docs/utils/data-are-same-date/index.md +0 -11
  174. package/docs/utils/data-clone-date/functions/cloneDateUtc.md +0 -27
  175. package/docs/utils/data-clone-date/index.md +0 -11
  176. package/docs/utils/data-compare-date/functions/default.md +0 -28
  177. package/docs/utils/data-compare-date/index.md +0 -11
  178. package/docs/utils/data-number/functions/randomNumberBetween.md +0 -25
  179. package/docs/utils/data-number/index.md +0 -11
  180. package/docs/utils/data-property-entity/functions/randomPropertyEntity.md +0 -23
  181. package/docs/utils/data-property-entity/index.md +0 -15
  182. package/docs/utils/data-property-entity/type-aliases/RandomPropertyEntity.md +0 -21
  183. package/docs/utils/ensure/functions/ensureArray.md +0 -39
  184. package/docs/utils/ensure/index.md +0 -15
  185. package/docs/utils/ensure/type-aliases/EnsureArrayPredicate.md +0 -29
  186. package/docs/utils/index.md +0 -43
package/docs/utils/ensure/functions/ensureArray.md DELETED
@@ -1,39 +0,0 @@
1
- [**@cubedelement.com/realty-investor-timeline**](../../../index.md)
2
-
3
- ---
4
-
5
- [@cubedelement.com/realty-investor-timeline](../../../modules.md) / [utils/ensure](../index.md) / ensureArray
6
-
7
- # Function: ensureArray()
8
-
9
- > **ensureArray**\<`T`\>(`array`?, `options`?): `void`
10
-
11
- Defined in: [utils/ensure.ts:3](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/utils/ensure.ts#L3)
12
-
13
- ## Type Parameters
14
-
15
- • **T**
16
-
17
- ## Parameters
18
-
19
- ### array?
20
-
21
- `T`[]
22
-
23
- ### options?
24
-
25
- #### ignoreError?
26
-
27
- `boolean`
28
-
29
- #### message?
30
-
31
- `string`
32
-
33
- #### predicate?
34
-
35
- [`EnsureArrayPredicate`](../type-aliases/EnsureArrayPredicate.md)\<`T`\>
36
-
37
- ## Returns
38
-
39
- `void`
package/docs/utils/ensure/index.md DELETED
@@ -1,15 +0,0 @@
1
- [**@cubedelement.com/realty-investor-timeline**](../../index.md)
2
-
3
- ---
4
-
5
- [@cubedelement.com/realty-investor-timeline](../../modules.md) / utils/ensure
6
-
7
- # utils/ensure
8
-
9
- ## Type Aliases
10
-
11
- - [EnsureArrayPredicate](type-aliases/EnsureArrayPredicate.md)
12
-
13
- ## Functions
14
-
15
- - [ensureArray](functions/ensureArray.md)
package/docs/utils/ensure/type-aliases/EnsureArrayPredicate.md DELETED
@@ -1,29 +0,0 @@
1
- [**@cubedelement.com/realty-investor-timeline**](../../../index.md)
2
-
3
- ---
4
-
5
- [@cubedelement.com/realty-investor-timeline](../../../modules.md) / [utils/ensure](../index.md) / EnsureArrayPredicate
6
-
7
- # Type Alias: EnsureArrayPredicate()\<T\>
8
-
9
- > **EnsureArrayPredicate**\<`T`\>: (`item`, `index`?) => `boolean`
10
-
11
- Defined in: [utils/ensure.ts:1](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/utils/ensure.ts#L1)
12
-
13
- ## Type Parameters
14
-
15
- • **T**
16
-
17
- ## Parameters
18
-
19
- ### item
20
-
21
- `T`
22
-
23
- ### index?
24
-
25
- `number`
26
-
27
- ## Returns
28
-
29
- `boolean`
package/docs/utils/index.md DELETED
@@ -1,43 +0,0 @@
1
- [**@cubedelement.com/realty-investor-timeline**](../index.md)
2
-
3
- ---
4
-
5
- [@cubedelement.com/realty-investor-timeline](../modules.md) / utils
6
-
7
- # utils
8
-
9
- ## References
10
-
11
- ### cloneDateUtc
12
-
13
- Re-exports [cloneDateUtc](data-clone-date/functions/cloneDateUtc.md)
14
-
15
- ---
16
-
17
- ### ensureArray
18
-
19
- Re-exports [ensureArray](ensure/functions/ensureArray.md)
20
-
21
- ---
22
-
23
- ### EnsureArrayPredicate
24
-
25
- Re-exports [EnsureArrayPredicate](ensure/type-aliases/EnsureArrayPredicate.md)
26
-
27
- ---
28
-
29
- ### randomNumberBetween
30
-
31
- Re-exports [randomNumberBetween](data-number/functions/randomNumberBetween.md)
32
-
33
- ---
34
-
35
- ### randomPropertyEntity
36
-
37
- Re-exports [randomPropertyEntity](data-property-entity/functions/randomPropertyEntity.md)
38
-
39
- ---
40
-
41
- ### RandomPropertyEntity
42
-
43
- Re-exports [RandomPropertyEntity](data-property-entity/type-aliases/RandomPropertyEntity.md)