taxtank-core 0.30.127 → 0.30.129

package/lib/collections/bank-account.collection.d.ts

@@ -70,7 +70,10 @@ export declare class BankAccountCollection extends Collection<BankAccount> {
      * @TODO Alex not efficient, filter bankAccounts by property first
      */
     getPropertyBalanceAmount(propertyId: number): number;
-    getMonthlyRepaymentAmount(propertyId: number): number;
+    get propertiesBalanceAmount(): number;
+    get propertiesMonthlyRepaymentAmount(): number;
+    getPropertyMonthlyRepaymentAmount(propertyId: number): number;
     getLVR(property: Property): number;
     getOwn(): this;
+    getActiveLoanAccountsByProperties(ids: number[]): BankAccountCollection;
 }

package/lib/collections/collection-dictionary.d.ts

@@ -32,9 +32,9 @@ export declare class CollectionDictionary<Collection extends BaseCollection<Abst
      */
     get(key: string | number): Collection;
     /**
-     * Join several collections by ids
+     * Join several collections by ids, return collection of uniq models (skip duplicates)
      */
-    merge(keys: number[]): Collection;
+    merge(keys: number[] | string[]): Collection;
     /**
      * Create instance of collection
      */

package/lib/collections/property/property.collection.d.ts

@@ -1,8 +1,7 @@
 import { Collection } from '../collection';
-import { Property } from '../../models/property/property';
-import { PropertyCategory } from '../../models/property/property-category';
+import { Property, PropertyCategory } from '../../models';
 import { DepreciationCollection } from '../depreciation.collection';
-import { TransactionCollection } from '../transaction/transaction.collection';
+import { TransactionCollection } from '../transaction';
 export declare class PropertyCollection extends Collection<Property> {
     /**
      * Get new property collection filtered by category id
@@ -54,4 +53,5 @@ export declare class PropertyCollection extends Collection<Property> {
      * https://taxtank.atlassian.net/wiki/spaces/TAXTANK/pages/217677997/Property+Tank+Dashboard
      */
     sortByBestPerformance(transactions: TransactionCollection, depreciations: DepreciationCollection): this;
+    get netIncome(): number;
 }

package/lib/models/bank/bank-account.d.ts

@@ -74,6 +74,7 @@ export declare class BankAccount extends BankAccountBase {
      * @param propertyId Id of property
      */
     getPropertyBalanceAmount(propertyId: number): number;
+    getMonthlyRepaymentAmount(propertyId: number): number;
     /**
      * Check if bank account is active (has 'active' status or hasn't been paid out/refinanced)
      */

package/lib/models/property/borrowing-report.d.ts

@@ -1,9 +1,27 @@
 import { BorrowingReport as BorrowingReportBase } from '../../db/Models/property/borrowing-report';
 import { User } from '../user';
+import { AnnualClientDetails } from '../client';
+import { IncomeSourceForecast, SalaryForecast } from '../income-source';
+/**
+ * Borrowing power report, shows if u can afford new property loan
+ * https://taxtank.atlassian.net/wiki/spaces/TAXTANK/pages/4717608961/Borrowing+Power+Report+-+Property+Tank
+ */
 export declare class BorrowingReport extends BorrowingReportBase {
     user: User;
     netRentIncome: number;
     loanRepaymentAmount: number;
     otherLiabilities: number;
     livingExpenses: number;
+    /**
+     * some fields calculated automatically until user filled them manually
+     */
+    static calculate(salaryForecasts: SalaryForecast[], incomeSourceForecasts: IncomeSourceForecast[], clientDetails?: AnnualClientDetails, report?: BorrowingReport): BorrowingReport;
+    /**
+     * free money after expenses
+     */
+    getNetIncomeSurplus(profit: number, repaymentAmount: number): number;
+    /**
+     * surplus income to cover your debt obligations
+     */
+    getNetSurplusRatio(profit: number, repaymentAmount: number): number;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "taxtank-core",
-  "version": "0.30.127",
+  "version": "0.30.129",
   "private": false,
   "peerDependencies": {
     "@angular/compiler": "^15.1.5",