Skip to content

feat: doc flow; isOwner #54

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kvernon merged 3 commits into from
Feb 14, 2025
Merged

feat: doc flow; isOwner #54

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d14161e
feat: document flow
kvernon Feb 13, 2025
806c805
feat: document flow
kvernon Feb 13, 2025
6e0eaa9
feat: document flow; isOwner lock
kvernon Feb 14, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .nvmrc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
20
22
4 changes: 3 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,9 @@ Will be based on version 1
1. https://bitbucket.org/kellyvernon/realty-generator-core (a private repo by me).
2. version 1 live: http://cubedelement.com/realty/

Note: this above is buggy. I was racing to get the pieces together.
> Note: this above is buggy. I was racing to get the pieces together.

> Note 2: this is the new version, which isn't live

## Inspiration

Expand Down
6 changes: 3 additions & 3 deletions docs/account/i-user-goal/interfaces/IUserGoal.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

# Interface: IUserGoal

Defined in: [account/i-user-goal.ts:3](https://github.com/kvernon/realty-investor-timeline/blob/604db9c08bd36b2a48c8b342796ed6cd0d1401e0/src/account/i-user-goal.ts#L3)
Defined in: [account/i-user-goal.ts:3](https://github.com/kvernon/realty-investor-timeline/blob/806c805529d356deb12c125749ddea89a26850dd/src/account/i-user-goal.ts#L3)

## Extended by

Expand All @@ -18,7 +18,7 @@ Defined in: [account/i-user-goal.ts:3](https://github.com/kvernon/realty-investo

> **monthlyIncomeAmountGoal**: `number`

Defined in: [account/i-user-goal.ts:7](https://github.com/kvernon/realty-investor-timeline/blob/604db9c08bd36b2a48c8b342796ed6cd0d1401e0/src/account/i-user-goal.ts#L7)
Defined in: [account/i-user-goal.ts:7](https://github.com/kvernon/realty-investor-timeline/blob/806c805529d356deb12c125749ddea89a26850dd/src/account/i-user-goal.ts#L7)

used to determine how much you need want for monthly expenses

Expand All @@ -28,7 +28,7 @@ used to determine how much you need want for monthly expenses

> **metMonthlyGoal**(`today`, `properties`): `boolean`

Defined in: [account/i-user-goal.ts:13](https://github.com/kvernon/realty-investor-timeline/blob/604db9c08bd36b2a48c8b342796ed6cd0d1401e0/src/account/i-user-goal.ts#L13)
Defined in: [account/i-user-goal.ts:13](https://github.com/kvernon/realty-investor-timeline/blob/806c805529d356deb12c125749ddea89a26850dd/src/account/i-user-goal.ts#L13)

method used to help determine if you have met your expenses

Expand Down
30 changes: 18 additions & 12 deletions docs/account/i-user-investor-check/interfaces/IUserInvestorCheck.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

# Interface: IUserInvestorCheck

Defined in: [account/i-user-investor-check.ts:9](https://github.com/kvernon/realty-investor-timeline/blob/604db9c08bd36b2a48c8b342796ed6cd0d1401e0/src/account/i-user-investor-check.ts#L9)
Defined in: [account/i-user-investor-check.ts:9](https://github.com/kvernon/realty-investor-timeline/blob/806c805529d356deb12c125749ddea89a26850dd/src/account/i-user-investor-check.ts#L9)

## Extends

Expand All @@ -22,7 +22,7 @@ Defined in: [account/i-user-investor-check.ts:9](https://github.com/kvernon/real

> **holdRules**: [`IRuleEvaluation`](../../../rules/rule-evaluation/interfaces/IRuleEvaluation.md)\<[`HoldRuleTypes`](../../../rules/hold-rule-types/enumerations/HoldRuleTypes.md)\>[]

Defined in: [account/i-user-investor-check.ts:23](https://github.com/kvernon/realty-investor-timeline/blob/604db9c08bd36b2a48c8b342796ed6cd0d1401e0/src/account/i-user-investor-check.ts#L23)
Defined in: [account/i-user-investor-check.ts:23](https://github.com/kvernon/realty-investor-timeline/blob/806c805529d356deb12c125749ddea89a26850dd/src/account/i-user-investor-check.ts#L23)

a system to determine how to hold onto the properties the longest. This scenario says as long as it meets 1 rule

Expand All @@ -32,7 +32,7 @@ a system to determine how to hold onto the properties the longest. This scenario

> `readonly` **ledgerCollection**: [`ILedgerCollection`](../../../ledger/ledger-collection/interfaces/ILedgerCollection.md)

Defined in: [account/i-user-investor-check.ts:13](https://github.com/kvernon/realty-investor-timeline/blob/604db9c08bd36b2a48c8b342796ed6cd0d1401e0/src/account/i-user-investor-check.ts#L13)
Defined in: [account/i-user-investor-check.ts:13](https://github.com/kvernon/realty-investor-timeline/blob/806c805529d356deb12c125749ddea89a26850dd/src/account/i-user-investor-check.ts#L13)

the collection which is used to keep a balance sheet.

Expand All @@ -42,7 +42,7 @@ the collection which is used to keep a balance sheet.

> **loanSettings**: [`ILoanSetting`](../../../loans/i-loan-settings/interfaces/ILoanSetting.md)[]

Defined in: [account/i-user-investor-check.ts:18](https://github.com/kvernon/realty-investor-timeline/blob/604db9c08bd36b2a48c8b342796ed6cd0d1401e0/src/account/i-user-investor-check.ts#L18)
Defined in: [account/i-user-investor-check.ts:18](https://github.com/kvernon/realty-investor-timeline/blob/806c805529d356deb12c125749ddea89a26850dd/src/account/i-user-investor-check.ts#L18)

a collection of loan settings for how to get a loan for single family or some other kind of property

Expand All @@ -52,7 +52,7 @@ a collection of loan settings for how to get a loan for single family or some ot

> **monthlyIncomeAmountGoal**: `number`

Defined in: [account/i-user-goal.ts:7](https://github.com/kvernon/realty-investor-timeline/blob/604db9c08bd36b2a48c8b342796ed6cd0d1401e0/src/account/i-user-goal.ts#L7)
Defined in: [account/i-user-goal.ts:7](https://github.com/kvernon/realty-investor-timeline/blob/806c805529d356deb12c125749ddea89a26850dd/src/account/i-user-goal.ts#L7)

used to determine how much you need want for monthly expenses

Expand All @@ -66,7 +66,7 @@ used to determine how much you need want for monthly expenses

> **purchaseRules**: [`IRuleEvaluation`](../../../rules/rule-evaluation/interfaces/IRuleEvaluation.md)\<[`PurchaseRuleTypes`](../../../rules/purchase-rule-types/enumerations/PurchaseRuleTypes.md)\>[]

Defined in: [account/i-user-investor-check.ts:58](https://github.com/kvernon/realty-investor-timeline/blob/604db9c08bd36b2a48c8b342796ed6cd0d1401e0/src/account/i-user-investor-check.ts#L58)
Defined in: [account/i-user-investor-check.ts:60](https://github.com/kvernon/realty-investor-timeline/blob/806c805529d356deb12c125749ddea89a26850dd/src/account/i-user-investor-check.ts#L60)

a system to weed out the properties you don't want. This scenario says as long as it meets 1 rule

Expand All @@ -76,7 +76,7 @@ a system to weed out the properties you don't want. This scenario says as long a

> **getAvailableSavings**(`date`, `properties`): `number`

Defined in: [account/i-user-investor-check.ts:53](https://github.com/kvernon/realty-investor-timeline/blob/604db9c08bd36b2a48c8b342796ed6cd0d1401e0/src/account/i-user-investor-check.ts#L53)
Defined in: [account/i-user-investor-check.ts:55](https://github.com/kvernon/realty-investor-timeline/blob/806c805529d356deb12c125749ddea89a26850dd/src/account/i-user-investor-check.ts#L55)

should be the total balance - savings, using [getMinimumSavings](IUserInvestorCheck.md#getminimumsavings), for determining monthly cash to save for single family properties

Expand All @@ -100,7 +100,7 @@ should be the total balance - savings, using [getMinimumSavings](IUserInvestorCh

> **getMinimumSavings**(`date`, `properties`): `number`

Defined in: [account/i-user-investor-check.ts:46](https://github.com/kvernon/realty-investor-timeline/blob/604db9c08bd36b2a48c8b342796ed6cd0d1401e0/src/account/i-user-investor-check.ts#L46)
Defined in: [account/i-user-investor-check.ts:48](https://github.com/kvernon/realty-investor-timeline/blob/806c805529d356deb12c125749ddea89a26850dd/src/account/i-user-investor-check.ts#L48)

used to retrieve the amount required to keep in savings

Expand All @@ -124,7 +124,7 @@ used to retrieve the amount required to keep in savings

> **hasMinimumSavings**(`date`, `properties`): `boolean`

Defined in: [account/i-user-investor-check.ts:39](https://github.com/kvernon/realty-investor-timeline/blob/604db9c08bd36b2a48c8b342796ed6cd0d1401e0/src/account/i-user-investor-check.ts#L39)
Defined in: [account/i-user-investor-check.ts:41](https://github.com/kvernon/realty-investor-timeline/blob/806c805529d356deb12c125749ddea89a26850dd/src/account/i-user-investor-check.ts#L41)

a way to determine if the user has enough money. This is different because with
single family homes, you would have to save a certain amount of monthly mortgage
Expand All @@ -149,9 +149,9 @@ single family homes, you would have to save a certain amount of monthly mortgage

> **hasMoneyToInvest**(`date`, `properties`, `contribution`?): `boolean`

Defined in: [account/i-user-investor-check.ts:31](https://github.com/kvernon/realty-investor-timeline/blob/604db9c08bd36b2a48c8b342796ed6cd0d1401e0/src/account/i-user-investor-check.ts#L31)
Defined in: [account/i-user-investor-check.ts:33](https://github.com/kvernon/realty-investor-timeline/blob/806c805529d356deb12c125749ddea89a26850dd/src/account/i-user-investor-check.ts#L33)

based upon [getMinimumSavings](IUserInvestorCheck.md#getminimumsavings), it checks to see if there is an amount remaining that can be used.
based upon [getMinimumSavings](IUserInvestorCheck.md#getminimumsavings), it checks to see if there is an amount remaining that can be used along with the [contribution](IUserInvestorCheck.md#contribution).

#### Parameters

Expand All @@ -171,13 +171,19 @@ based upon [getMinimumSavings](IUserInvestorCheck.md#getminimumsavings), it chec

`boolean`

#### Example

```ts
availableSavings - contribution >= 0;
```

---

### metMonthlyGoal()

> **metMonthlyGoal**(`today`, `properties`): `boolean`

Defined in: [account/i-user-goal.ts:13](https://github.com/kvernon/realty-investor-timeline/blob/604db9c08bd36b2a48c8b342796ed6cd0d1401e0/src/account/i-user-goal.ts#L13)
Defined in: [account/i-user-goal.ts:13](https://github.com/kvernon/realty-investor-timeline/blob/806c805529d356deb12c125749ddea89a26850dd/src/account/i-user-goal.ts#L13)

method used to help determine if you have met your expenses

Expand Down
38 changes: 22 additions & 16 deletions docs/account/user/classes/User.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

# Class: User

Defined in: [account/user.ts:32](https://github.com/kvernon/realty-investor-timeline/blob/604db9c08bd36b2a48c8b342796ed6cd0d1401e0/src/account/user.ts#L32)
Defined in: [account/user.ts:32](https://github.com/kvernon/realty-investor-timeline/blob/806c805529d356deb12c125749ddea89a26850dd/src/account/user.ts#L32)

It's the user... as an interface!

Expand All @@ -20,7 +20,7 @@ It's the user... as an interface!

> **new User**(`ledgerCollection`): [`User`](User.md)

Defined in: [account/user.ts:75](https://github.com/kvernon/realty-investor-timeline/blob/604db9c08bd36b2a48c8b342796ed6cd0d1401e0/src/account/user.ts#L75)
Defined in: [account/user.ts:75](https://github.com/kvernon/realty-investor-timeline/blob/806c805529d356deb12c125749ddea89a26850dd/src/account/user.ts#L75)

#### Parameters

Expand All @@ -38,7 +38,7 @@ Defined in: [account/user.ts:75](https://github.com/kvernon/realty-investor-time

> **holdRules**: [`IRuleEvaluation`](../../../rules/rule-evaluation/interfaces/IRuleEvaluation.md)\<[`HoldRuleTypes`](../../../rules/hold-rule-types/enumerations/HoldRuleTypes.md)\>[]

Defined in: [account/user.ts:82](https://github.com/kvernon/realty-investor-timeline/blob/604db9c08bd36b2a48c8b342796ed6cd0d1401e0/src/account/user.ts#L82)
Defined in: [account/user.ts:82](https://github.com/kvernon/realty-investor-timeline/blob/806c805529d356deb12c125749ddea89a26850dd/src/account/user.ts#L82)

a system to determine how to hold onto the properties the longest. This scenario says as long as it meets 1 rule

Expand All @@ -52,7 +52,7 @@ a system to determine how to hold onto the properties the longest. This scenario

> `readonly` **ledgerCollection**: [`ILedgerCollection`](../../../ledger/ledger-collection/interfaces/ILedgerCollection.md)

Defined in: [account/user.ts:36](https://github.com/kvernon/realty-investor-timeline/blob/604db9c08bd36b2a48c8b342796ed6cd0d1401e0/src/account/user.ts#L36)
Defined in: [account/user.ts:36](https://github.com/kvernon/realty-investor-timeline/blob/806c805529d356deb12c125749ddea89a26850dd/src/account/user.ts#L36)

the collection which is used to keep a balance sheet.

Expand All @@ -66,7 +66,7 @@ the collection which is used to keep a balance sheet.

> **loanSettings**: [`ILoanSetting`](../../../loans/i-loan-settings/interfaces/ILoanSetting.md)[]

Defined in: [account/user.ts:41](https://github.com/kvernon/realty-investor-timeline/blob/604db9c08bd36b2a48c8b342796ed6cd0d1401e0/src/account/user.ts#L41)
Defined in: [account/user.ts:41](https://github.com/kvernon/realty-investor-timeline/blob/806c805529d356deb12c125749ddea89a26850dd/src/account/user.ts#L41)

a collection of loan settings for how to get a loan for single family or some other kind of property

Expand All @@ -80,7 +80,7 @@ a collection of loan settings for how to get a loan for single family or some ot

> **monthlyIncomeAmountGoal**: `number`

Defined in: [account/user.ts:46](https://github.com/kvernon/realty-investor-timeline/blob/604db9c08bd36b2a48c8b342796ed6cd0d1401e0/src/account/user.ts#L46)
Defined in: [account/user.ts:46](https://github.com/kvernon/realty-investor-timeline/blob/806c805529d356deb12c125749ddea89a26850dd/src/account/user.ts#L46)

used to determine how much you need want for monthly expenses

Expand All @@ -94,7 +94,7 @@ used to determine how much you need want for monthly expenses

> **monthlySavedAmount**: `number`

Defined in: [account/user.ts:73](https://github.com/kvernon/realty-investor-timeline/blob/604db9c08bd36b2a48c8b342796ed6cd0d1401e0/src/account/user.ts#L73)
Defined in: [account/user.ts:73](https://github.com/kvernon/realty-investor-timeline/blob/806c805529d356deb12c125749ddea89a26850dd/src/account/user.ts#L73)

an amount which the user can save per month after expenses, like, after my pay check I could put this amount into savings

Expand All @@ -108,7 +108,7 @@ an amount which the user can save per month after expenses, like, after my pay c

> **purchaseRules**: [`IRuleEvaluation`](../../../rules/rule-evaluation/interfaces/IRuleEvaluation.md)\<[`PurchaseRuleTypes`](../../../rules/purchase-rule-types/enumerations/PurchaseRuleTypes.md)\>[]

Defined in: [account/user.ts:87](https://github.com/kvernon/realty-investor-timeline/blob/604db9c08bd36b2a48c8b342796ed6cd0d1401e0/src/account/user.ts#L87)
Defined in: [account/user.ts:87](https://github.com/kvernon/realty-investor-timeline/blob/806c805529d356deb12c125749ddea89a26850dd/src/account/user.ts#L87)

a system to weed out the properties you don't want. This scenario says as long as it meets 1 rule

Expand All @@ -122,7 +122,7 @@ a system to weed out the properties you don't want. This scenario says as long a

> **clone**(): [`IUser`](../interfaces/IUser.md)

Defined in: [account/user.ts:169](https://github.com/kvernon/realty-investor-timeline/blob/604db9c08bd36b2a48c8b342796ed6cd0d1401e0/src/account/user.ts#L169)
Defined in: [account/user.ts:171](https://github.com/kvernon/realty-investor-timeline/blob/806c805529d356deb12c125749ddea89a26850dd/src/account/user.ts#L171)

#### Returns

Expand All @@ -138,7 +138,7 @@ Defined in: [account/user.ts:169](https://github.com/kvernon/realty-investor-tim

> **getAvailableSavings**(`date`, `properties`): `number`

Defined in: [account/user.ts:153](https://github.com/kvernon/realty-investor-timeline/blob/604db9c08bd36b2a48c8b342796ed6cd0d1401e0/src/account/user.ts#L153)
Defined in: [account/user.ts:155](https://github.com/kvernon/realty-investor-timeline/blob/806c805529d356deb12c125749ddea89a26850dd/src/account/user.ts#L155)

should be the total balance - savings, using [getMinimumSavings](User.md#getminimumsavings), for determining monthly cash to save for single family properties

Expand Down Expand Up @@ -166,7 +166,7 @@ should be the total balance - savings, using [getMinimumSavings](User.md#getmini

> **getEstimatedMonthlyCashFlow**(`today`, `properties`): `number`

Defined in: [account/user.ts:57](https://github.com/kvernon/realty-investor-timeline/blob/604db9c08bd36b2a48c8b342796ed6cd0d1401e0/src/account/user.ts#L57)
Defined in: [account/user.ts:57](https://github.com/kvernon/realty-investor-timeline/blob/806c805529d356deb12c125749ddea89a26850dd/src/account/user.ts#L57)

method used to help determine if you have met your expenses

Expand Down Expand Up @@ -194,7 +194,7 @@ method used to help determine if you have met your expenses

> **getMinimumSavings**(`date`, `properties`): `number`

Defined in: [account/user.ts:135](https://github.com/kvernon/realty-investor-timeline/blob/604db9c08bd36b2a48c8b342796ed6cd0d1401e0/src/account/user.ts#L135)
Defined in: [account/user.ts:137](https://github.com/kvernon/realty-investor-timeline/blob/806c805529d356deb12c125749ddea89a26850dd/src/account/user.ts#L137)

used to retrieve the amount required to keep in savings

Expand Down Expand Up @@ -222,7 +222,7 @@ used to retrieve the amount required to keep in savings

> **hasMinimumSavings**(`date`, `properties`): `boolean`

Defined in: [account/user.ts:117](https://github.com/kvernon/realty-investor-timeline/blob/604db9c08bd36b2a48c8b342796ed6cd0d1401e0/src/account/user.ts#L117)
Defined in: [account/user.ts:119](https://github.com/kvernon/realty-investor-timeline/blob/806c805529d356deb12c125749ddea89a26850dd/src/account/user.ts#L119)

a way to determine if the user has enough money. This is different because with
single family homes, you would have to save a certain amount of monthly mortgage
Expand Down Expand Up @@ -251,9 +251,9 @@ single family homes, you would have to save a certain amount of monthly mortgage

> **hasMoneyToInvest**(`date`, `properties`, `contribution`?): `boolean`

Defined in: [account/user.ts:95](https://github.com/kvernon/realty-investor-timeline/blob/604db9c08bd36b2a48c8b342796ed6cd0d1401e0/src/account/user.ts#L95)
Defined in: [account/user.ts:97](https://github.com/kvernon/realty-investor-timeline/blob/806c805529d356deb12c125749ddea89a26850dd/src/account/user.ts#L97)

based upon [getMinimumSavings](User.md#getminimumsavings), it checks to see if there is an amount remaining that can be used.
based upon [getMinimumSavings](User.md#getminimumsavings), it checks to see if there is an amount remaining that can be used along with the [contribution](User.md#contribution).

#### Parameters

Expand All @@ -273,6 +273,12 @@ based upon [getMinimumSavings](User.md#getminimumsavings), it checks to see if t

`boolean`

#### Example

```ts
availableSavings - contribution >= 0;
```

#### Implementation of

[`IUser`](../interfaces/IUser.md).[`hasMoneyToInvest`](../interfaces/IUser.md#hasmoneytoinvest)
Expand All @@ -283,7 +289,7 @@ based upon [getMinimumSavings](User.md#getminimumsavings), it checks to see if t

> **metMonthlyGoal**(`today`, `properties`): `boolean`

Defined in: [account/user.ts:53](https://github.com/kvernon/realty-investor-timeline/blob/604db9c08bd36b2a48c8b342796ed6cd0d1401e0/src/account/user.ts#L53)
Defined in: [account/user.ts:53](https://github.com/kvernon/realty-investor-timeline/blob/806c805529d356deb12c125749ddea89a26850dd/src/account/user.ts#L53)

method used to help determine if you have met your expenses

Expand Down
Loading