taxtank-core 2.0.66 → 2.0.68

package/fesm2022/taxtank-core.mjs

@@ -17,12 +17,12 @@ import uniqBy from 'lodash/uniqBy';
 import first from 'lodash/first';
 import last from 'lodash/last';
 import orderBy from 'lodash/orderBy';
+import round from 'lodash/round';
 import uniq from 'lodash/uniq';
 import moment from 'moment';
 import { DateRange as DateRange$1 } from 'moment-range';
 import * as i3 from 'taxtank-core/common';
 import { UserRolesEnum as UserRolesEnum$1, MixpanelService as MixpanelService$1 } from 'taxtank-core/common';
-import round from 'lodash/round';
 import range from 'lodash/range';
 import { Validators, FormGroup, FormArray, UntypedFormControl, UntypedFormArray, UntypedFormGroup, FormControl } from '@angular/forms';
 import compact from 'lodash/compact';
@@ -2469,6 +2469,22 @@ class PropertyCollection extends Collection {
         }
         return propertiesByCategory;
     }
+    getEquityPositionByProperty(bankAccounts) {
+        const loanAccounts = bankAccounts.getOwn().getLoanAndOffsetAccounts();
+        const equityPositionByProperty = new Dictionary([]);
+        this.items.forEach(property => {
+            equityPositionByProperty.add(property.id, property.getEquityPosition(loanAccounts.getByPropertyId(property.id)));
+        });
+        return equityPositionByProperty;
+    }
+    getLvrByProperty(bankAccounts) {
+        const loanAccounts = bankAccounts.getOwn().getLoanAndOffsetAccounts();
+        const lvrByProperty = new Dictionary([]);
+        this.items.forEach(property => {
+            lvrByProperty.add(property.id, property.getLvr(loanAccounts.getByPropertyId(property.id)));
+        });
+        return lvrByProperty;
+    }
 }
 
 class PropertyCategoryMovementCollection extends Collection {
@@ -6171,6 +6187,12 @@ class Property extends Property$1 {
     getGrowth() {
         return this.valuation.marketValue - this.purchasePrice;
     }
+    getEquityPosition(bankAccounts) {
+        return this.marketValue - Math.abs(bankAccounts.getLoanValue(this));
+    }
+    getLvr(bankAccounts) {
+        return bankAccounts.getActiveLoanAccountsByProperties([this.id]).propertiesBalanceAmount / this.marketValue * 100;
+    }
 }
 __decorate([
     Type(() => Number)
@@ -9477,6 +9499,9 @@ class BankAccountCollection extends Collection {
     getActiveLoanAccountsByProperties(ids) {
         return this.getActive().getLoanAccounts().getByPropertiesIds(ids);
     }
+    getLoanValue(property) {
+        return this.items.reduce((propertyAmount, bankAccount) => propertyAmount + bankAccount.getPropertyBalanceAmount(property.id), 0);
+    }
 }
 
 /**
@@ -9754,7 +9779,21 @@ class ClientPortfolioReportCollection extends Collection {
 
 class FinancialGoalCollection extends Collection {
     getActive() {
-        return this.filterBy('status', FinancialGoalStatusEnum.ACTIVE);
+        return this.filterBy('status', [FinancialGoalStatusEnum.ACTIVE, FinancialGoalStatusEnum.PAUSE]);
+    }
+    getPropertiesByGoal(properties) {
+        const propertiesByGoal = new CollectionDictionary(new PropertyCollection());
+        this.items.forEach(goal => {
+            propertiesByGoal.add(goal.id, properties.filterBy('id', goal.properties));
+        });
+        return propertiesByGoal;
+    }
+    getBankAccountsByGoal(bankAccounts) {
+        const bankAccountsByGoal = new CollectionDictionary(new BankAccountCollection());
+        this.items.forEach(goal => {
+            bankAccountsByGoal.add(goal.id, bankAccounts.filterBy('id', goal.bankAccount));
+        });
+        return bankAccountsByGoal;
     }
 }
 
@@ -10803,6 +10842,12 @@ class Dictionary {
     get(key) {
         return this.items[key] !== undefined ? this.items[key] : null;
     }
+    sum(keys) {
+        return round(keys.reduce((sum, key) => sum + (+this.get(key)), 0), 2);
+    }
+    avg(keys) {
+        return round(this.sum(keys) / keys.length, 2);
+    }
     merge(dictionary) {
         Object.assign(this.items, dictionary.items);
         return this;
@@ -11504,12 +11549,15 @@ class FinancialGoal extends AbstractModel {
     constructor() {
         super(...arguments);
         this.startDate = moment().startOf('day').toDate();
-        this.paymentFrequency = DailyFrequencyEnum.MONTHLY;
-        this.inCalendar = true;
+        this.inCalendar = false;
+        this.properties = [];
     }
     isCompleted() {
         return this.status === FinancialGoalStatusEnum.COMPLETE;
     }
+    isPropertyType() {
+        return [FinancialGoalTypeEnum.PROPERTY_EQUITY, FinancialGoalTypeEnum.PROPERTY_LVR].includes(this.type);
+    }
     /**
      * today's forecasted progress
      */
@@ -11523,6 +11571,9 @@ class FinancialGoal extends AbstractModel {
      *  How much user saved so far.
      */
     get progress() {
+        if (this.isPropertyType()) {
+            return 0;
+        }
         return this.isCompleted()
             ? Math.abs(this.finalValue - this.initialValue)
             : Math.abs(this.bankAccount.currentBalance - this.initialValue);
@@ -11585,6 +11636,9 @@ class FinancialGoal extends AbstractModel {
         }
         return payments;
     }
+    get propertyIds() {
+        return this.properties.map(property => property.id);
+    }
 }
 __decorate([
     Type(() => Date)
@@ -21043,6 +21097,10 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "20.3.10", ngImpo
  * Logic here works like collections methods but for several entities
  */
 class PropertyCalculationService {
+    constructor() {
+        this.propertyService = inject(PropertyService);
+        this.bankAccountService = inject(BankAccountService);
+    }
     getTaxPosition(transactions, depreciations) {
         // @TODO hack: math abs added because we have mismatching of real values signs
         return transactions.grossClaimAmount - Math.abs(depreciations.claimAmount);
@@ -21079,18 +21137,8 @@ class PropertyCalculationService {
         return properties.items.reduce((totalAmount, property) => totalAmount + bankAccounts.items
             .reduce((propertyAmount, bankAccount) => propertyAmount + bankAccount.getPropertyBalanceAmount(property.id), 0), 0);
     }
-    /**
-     * LVR
-     */
-    getLvr(properties, bankAccounts) {
-        // Math abs is required for correct percentage calculation
-        return bankAccounts.getActiveLoanAccountsByProperties(properties.getIds()).propertiesBalanceAmount / properties.marketValue;
-    }
     getLvr$(properties$, bankAccounts$) {
-        return combineLatest([
-            properties$,
-            bankAccounts$
-        ]).pipe(map(([properties, bankAccounts]) => this.getLvr(properties, bankAccounts)));
+        return combineLatest([properties$, bankAccounts$]).pipe(map(([properties, bankAccounts]) => this.getLvr(properties, bankAccounts)));
     }
     getLvrCommencement(properties, loans, bankAccounts) {
         // Math abs is required for correct percentage calculation
@@ -21118,6 +21166,14 @@ class PropertyCalculationService {
             loans$
         ]).pipe(map(([properties, bankAccounts, loans]) => this.getLvrGrowth(properties, bankAccounts, loans)));
     }
+    getEquityPosition$(propertyIds) {
+        return combineLatest([this.propertyService.getBy('id', propertyIds), this.bankAccountService.getActive()])
+            .pipe(map(([properties, bankAccounts]) => this.getEquityPosition(properties, bankAccounts.getOwn().getLoanAndOffsetAccounts().getByPropertiesIds(propertyIds))));
+    }
+    getLVR$(propertyIds) {
+        return combineLatest([this.propertyService.getBy('id', propertyIds), this.bankAccountService.getActive()])
+            .pipe(map(([properties, bankAccounts]) => this.getLvr(properties, bankAccounts.getOwn().getLoanAndOffsetAccounts().getByPropertiesIds(propertyIds))));
+    }
     /**
      * Equity position = Market value - current loan value
      */
@@ -21125,6 +21181,13 @@ class PropertyCalculationService {
         // Math abs is required for correct percentage calculation
         return properties.marketValue - Math.abs(this.getLoanValue(properties, bankAccounts));
     }
+    getLvr(properties, bankAccounts) {
+        if (!properties.marketValue) {
+            return 0;
+        }
+        // Math abs is required for correct percentage calculation
+        return bankAccounts.getActiveLoanAccountsByProperties(properties.getIds()).propertiesBalanceAmount / properties.marketValue;
+    }
     /**
      * Purchase Equity = Purchase price - initial loan value
      */
@@ -23256,7 +23319,7 @@ function greaterThanValidator(value) {
 /**
  * Validator that enforces the current control's value to be >= another control's value.
  */
-function greaterThanControlValidator(controlName) {
+function greaterThanControlValidator(controlName, alias) {
     return (control) => {
         // skip validation until control is attached to a parent FormGroup
         if (!control?.parent) {
@@ -23265,7 +23328,7 @@ function greaterThanControlValidator(controlName) {
         const group = control.parent;
         const fieldToCompare = group.get(controlName);
         const isLessThan = Number(fieldToCompare.value) > Number(control.value);
-        return isLessThan ? { min: { min: fieldToCompare.value, actual: control.value } } : null;
+        return isLessThan ? { greaterThanControl: `The value should be greater than ${alias}` } : null;
     };
 }
 
@@ -23451,38 +23514,57 @@ class LoanForm extends AbstractForm {
     }
 }
 
+/**
+ * Validator that enforces the current control's value to be >= another control's value.
+ */
+function lessThanControlValidator(controlName, alias) {
+    return (control) => {
+        // skip validation until control is attached to a parent FormGroup
+        if (!control?.parent) {
+            return null;
+        }
+        const group = control.parent;
+        const fieldToCompare = group.get(controlName);
+        const isLessThan = Number(fieldToCompare.value) > Number(control.value);
+        return isLessThan ? null : { lessThanControl: `The value should be less than ${alias}` };
+    };
+}
+
 const END_DATE_VALIDATION_ERROR = 'Target date must be more than start date';
 class FinancialGoalForm extends AbstractForm {
-    constructor(goal = plainToClass(FinancialGoal, {})) {
+    constructor(goal, equityByProperty, lvrByProperty) {
         super({
-            type: new FormControl({
-                value: goal.type ?? FinancialGoalTypeEnum.DEBIT,
-                disabled: !!goal.id
-            }, Validators.required),
+            type: new FormControl({ value: goal.type ?? FinancialGoalTypeEnum.DEBIT, disabled: !!goal.id }, Validators.required),
             name: new FormControl(goal.name, Validators.required),
             bankAccount: new FormControl({ value: goal.bankAccount, disabled: !!goal.id }, [
-                conditionalValidator(() => [FinancialGoalTypeEnum.CREDIT, FinancialGoalTypeEnum.DEBIT].includes(this.value.type), Validators.required),
+                conditionalValidator(() => !this.isPropertyType(), Validators.required),
             ]),
             targetValue: new FormControl(goal.targetValue, [
-                conditionalValidator(() => this.value.type === FinancialGoalTypeEnum.DEBIT, Validators.min(0)),
-                conditionalValidator(() => this.value.type === FinancialGoalTypeEnum.CREDIT, Validators.max(0)),
-                greaterThanControlValidator('initialValue'),
-                Validators.required
+                Validators.required,
+                conditionalValidator(() => this.isLvrType(), lessThanControlValidator('initialValue', 'Start Value')),
+                conditionalValidator(() => !this.isLvrType(), greaterThanControlValidator('initialValue', 'Start Value')),
             ]),
             initialValue: new FormControl({ value: goal.initialValue, disabled: true }, Validators.required),
             startDate: new FormControl({ value: goal.startDate, disabled: true }),
             endDate: new FormControl(goal.endDate, [Validators.required, minDateValidator(goal.startDate, END_DATE_VALIDATION_ERROR)]),
-            paymentFrequency: new FormControl(goal.paymentFrequency, Validators.required),
-            paymentAmount: new FormControl(goal.paymentAmount, Validators.required),
+            paymentFrequency: new FormControl(goal.paymentFrequency, [
+                conditionalValidator(() => !this.isPropertyType(), Validators.required),
+            ]),
+            paymentAmount: new FormControl(goal.paymentAmount, [
+                conditionalValidator(() => !this.isPropertyType(), Validators.required),
+            ]),
             inCalendar: new FormControl(goal.inCalendar),
             file: new FormControl(goal.file),
             description: new FormControl(goal.description),
+            properties: new FormControl({ value: goal.properties, disabled: !!goal.id }, [
+                conditionalValidator(() => this.isPropertyType(), Validators.required),
+            ]),
         }, goal);
+        this.equityByProperty = equityByProperty;
+        this.lvrByProperty = lvrByProperty;
         this.includeDisabledFields = true;
         this.bankAccountTypes = [];
-        this.isDebit = true;
         this.bankAccountTypes = this.getBankAccountTypes(goal.type);
-        this.isDebit = this.getIsDebit(goal.type);
         this.listenEvents();
     }
     listenEvents() {
@@ -23493,8 +23575,14 @@ class FinancialGoalForm extends AbstractForm {
     listenTypeChanges() {
         this.get('type').valueChanges.subscribe((type) => {
             this.get('bankAccount').setValue(null, { onlySelf: true });
+            this.get('properties').setValue([], { onlySelf: true, emitEvent: false });
+            this.get('initialValue').setValue(null, { onlySelf: true, emitEvent: false });
+            if (this.isPropertyType()) {
+                this.get('inCalendar').setValue(false, { onlySelf: true, emitEvent: false });
+                this.get('paymentFrequency').setValue(false, { onlySelf: true, emitEvent: false });
+                this.get('paymentAmount').setValue(false, { onlySelf: true, emitEvent: false });
+            }
             this.bankAccountTypes = this.getBankAccountTypes(type);
-            this.isDebit = this.getIsDebit(type);
         });
     }
     /**
@@ -23517,11 +23605,9 @@ class FinancialGoalForm extends AbstractForm {
             this.get('endDate').setValue(this.calculateEndDate(), { emitEvent: false });
         });
     }
-    /**
-     * keeps updated initialValue when bankAccount updated. only for add form
-     */
     listenBankAccountChanges() {
-        this.get('bankAccount').valueChanges.pipe(filter((bankAccount) => !!bankAccount))
+        this.get('bankAccount').valueChanges
+            .pipe(filter((bankAccount) => !!bankAccount))
             .subscribe(bankAccount => {
             this.get('initialValue').setValue(bankAccount.currentBalance);
         });
@@ -23563,12 +23649,17 @@ class FinancialGoalForm extends AbstractForm {
         switch (type) {
             case FinancialGoalTypeEnum.CREDIT:
                 return [BankAccountTypeEnum.MORTGAGE, BankAccountTypeEnum.LOAN, BankAccountTypeEnum.CREDIT_CARD];
-            default:
+            case FinancialGoalTypeEnum.DEBIT:
                 return [BankAccountTypeEnum.TRANSACTION, BankAccountTypeEnum.SAVINGS, BankAccountTypeEnum.OFFSET];
+            default:
+                return [];
         }
     }
-    getIsDebit(type) {
-        return type !== FinancialGoalTypeEnum.CREDIT;
+    isPropertyType() {
+        return [FinancialGoalTypeEnum.PROPERTY_EQUITY, FinancialGoalTypeEnum.PROPERTY_LVR].includes(this.value.type);
+    }
+    isLvrType() {
+        return this.value.type === FinancialGoalTypeEnum.PROPERTY_LVR;
     }
 }