taxtank-core 0.21.0 → 0.21.3

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

@@ -42,4 +42,9 @@ export declare class PropertyCollection extends Collection<Property> {
      * Get property with the lowest tax position
      */
     getBestPerformanceTaxProperty(transactions: TransactionCollection, depreciations: DepreciationCollection): Property;
+    /**
+     * Show best performance properties first
+     * https://taxtank.atlassian.net/wiki/spaces/TAXTANK/pages/217677997/Property+Tank+Dashboard
+     */
+    sortByBestPerformance(transactions: TransactionCollection, depreciations: DepreciationCollection): this;
 }

package/lib/forms/register/register-client.form.d.ts

@@ -1,5 +1,6 @@
 import { AbstractForm } from '../abstract.form';
-export declare class RegisterClientForm extends AbstractForm<object> {
+import { User } from '../../models/user/user';
+export declare class RegisterClientForm extends AbstractForm<User> {
     constructor(referenceCode?: string);
-    submit(): object;
+    submit(data?: object): User;
 }

package/lib/forms/register/register-firm.form.d.ts

@@ -4,4 +4,5 @@ import { Firm } from '../../models/firm/firm';
 export declare class RegisterFirmForm extends AbstractForm<Firm> {
     private firmType;
     constructor(firmType: FirmTypeEnum, referenceCode?: string);
+    submit(data?: object): Firm;
 }

package/lib/models/badge/badge-color.enum.d.ts

@@ -0,0 +1,6 @@
+export declare enum BadgeColorEnum {
+    DEFAULT = "default",
+    GREEN = "green",
+    GOLD = "gold",
+    GRAY = "gray"
+}

package/lib/models/badge/badge.d.ts

@@ -0,0 +1,10 @@
+import { BadgeColorEnum } from './badge-color.enum';
+import { AbstractModel } from '../../db/Models/abstract-model';
+/**
+ * Class for UI element badge
+ */
+export declare class Badge extends AbstractModel {
+    color: BadgeColorEnum;
+    text: string;
+    constructor(text: string, color?: BadgeColorEnum);
+}

package/lib/models/property/property.d.ts

@@ -86,5 +86,10 @@ export declare class Property extends PropertyBase implements Photoable, Documen
      * ownership duration from purchase till sale
      */
     getOwnershipDuration(sale: PropertySale, unitOfTime?: unitOfTime.Diff): number;
+    /**
+     * Tax Position = Income - Expense - Interest - Depreciation
+     * Where (Income - Expense - Interest) is cash position.
+     * https://taxtank.atlassian.net/wiki/spaces/TAXTANK/pages/217415928/Dashboard+Property
+     */
     getTaxPosition(transactions: TransactionCollection, depreciations: DepreciationCollection): number;
 }

package/lib/services/property/property-calculation/property-calculation.service.d.ts

@@ -4,6 +4,8 @@ import { DepreciationCollection } from '../../../collections/depreciation.collec
 import { LoanCollection } from '../../../collections/loan/loan.collection';
 import { PropertyCollection } from '../../../collections/property/property.collection';
 import { TransactionCollection } from '../../../collections/transaction/transaction.collection';
+import { Dictionary } from '../../../models/dictionary/dictionary';
+import { Badge } from '../../../models/badge/badge';
 import * as i0 from "@angular/core";
 /**
  * Service with calculations methods for properties related with other entities.
@@ -28,6 +30,14 @@ export declare class PropertyCalculationService {
     getLvrGrowth$(properties$: Observable<PropertyCollection>, bankAccounts$: Observable<BankAccountCollection>, loans$: Observable<LoanCollection>): Observable<number>;
     getEquityPosition(properties: PropertyCollection, bankAccounts: BankAccountCollection): number;
     getPurchaseEquity(properties: PropertyCollection, bankAccounts: BankAccountCollection, loans: LoanCollection): number;
+    /**
+     * Get dictionary of badges for each property in collection
+     */
+    getBadgesByProperty(properties: PropertyCollection, transactions: TransactionCollection, depreciations: DepreciationCollection): Dictionary<Badge>;
+    /**
+     * Get Badge for single property in collection
+     */
+    private getBadge;
     static ɵfac: i0.ɵɵFactoryDeclaration<PropertyCalculationService, never>;
     static ɵprov: i0.ɵɵInjectableDeclaration<PropertyCalculationService>;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "taxtank-core",
-  "version": "0.21.0",
+  "version": "0.21.3",
   "private": false,
   "peerDependencies": {
     "@angular/common": "^12.2.3 || ~13.0.0",

package/public-api.d.ts

@@ -138,6 +138,8 @@ export * from './lib/db/Enums/property/property-sale/tax-exemption-metadata.enum
 export * from './lib/models/account-setup/account-setup-item';
 export * from './lib/models/address/address';
 export * from './lib/models/address/country';
+export * from './lib/models/badge/badge';
+export * from './lib/models/badge/badge-color.enum';
 export * from './lib/models/bank/bank';
 export * from './lib/models/bank/bank-account';
 export * from './lib/models/bank/bank-account-chart-data';
@@ -174,6 +176,7 @@ export * from './lib/models/client/client-movement';
 export * from './lib/models/client/client-portfolio-chart-data';
 export * from './lib/models/client/client-portfolio-report';
 export * from './lib/models/color/alphabet-colors.enum';
+export * from './lib/models/dictionary/dictionary';
 export * from './lib/models/depreciation/depreciation';
 export * from './lib/models/depreciation/depreciation-capital-project';
 export * from './lib/models/depreciation/depreciation-forecast';