taxtank-core 0.1.1 → 0.1.2

package/src/lib/models/property/ownership-filter-options.enum.ts

@@ -1,8 +0,0 @@
-/**
- * Enum with properties ownership filter options
- */
-export enum OwnershipFilterOptionsEnum {
-  ALL_PROPERTIES = 1,
-  OWN_PROPERTIES = 2,
-  SHARED_PROPERTIES = 3
-}

package/src/lib/models/property/property-capital-cost.ts

@@ -1,4 +0,0 @@
-import { PropertyCapitalCost as PropertyCapitalCostBase } from '../../db/Models/property-capital-cost';
-
-export class PropertyCapitalCost extends PropertyCapitalCostBase {
-}

package/src/lib/models/property/property-category-movement.ts

@@ -1,18 +0,0 @@
-import { PropertyCategoryMovement as PropertyCategoryMovementBase } from '../../db/Models/property-category-movement';
-import { Type } from 'class-transformer';
-import { PropertyValuation } from './property-valuation';
-import { PropertyCategory } from './property-category';
-
-export class PropertyCategoryMovement extends PropertyCategoryMovementBase {
-  @Type(() => PropertyValuation)
-  valuation: PropertyValuation;
-
-  @Type(() => PropertyCategory)
-  propertyCategory: PropertyCategory;
-
-  @Type(() => Date)
-  fromDate: Date;
-
-  @Type(() => Date)
-  toDate: Date;
-}

package/src/lib/models/property/property-category.ts

@@ -1,9 +0,0 @@
-import { PropertyCategory as PropertyCategoryBase } from '../../db/Models/property-category';
-
-export class PropertyCategory extends PropertyCategoryBase {
-
-  // @Todo check if category is Owner Occupied. If will be needed to check more categories - move the checking to the backend
-  isOwnerOccupied(): boolean {
-    return this.name === 'Owner Occupied';
-  }
-}

package/src/lib/models/property/property-document.ts

@@ -1,21 +0,0 @@
-import { PropertyDocument as PropertyDocumentBase } from '../../db/Models/property-document';
-import { IAsset } from '../../interfaces/asset.interface';
-import { IDocument } from '../../interfaces/document.interface';
-import { AssetTypeEnum } from '../../interfaces/asset-type.enum';
-import { AssetEntityTypeEnum } from '../../interfaces/asset-entity-type.enum';
-import { Documentable } from '../../interfaces/documentable.interface';
-import { Property } from './property';
-
-export class PropertyDocument extends PropertyDocumentBase implements IAsset, IDocument {
-  type: AssetTypeEnum = AssetTypeEnum.DOCUMENTS;
-  entityType: AssetEntityTypeEnum = AssetEntityTypeEnum.PROPERTIES;
-  property: Property;
-
-  getApiUrlPrefix(): string {
-    return '';
-  }
-
-  getEntity(): Documentable {
-    return this.property;
-  }
-}

package/src/lib/models/property/property-equity-chart-data.ts

@@ -1,188 +0,0 @@
-import first from 'lodash/first';
-import { PropertyEquityChartItem } from './property-equity-chart-item';
-import { PropertyCollection } from '../../collections/property.collection';
-import { BankAccountCollection } from '../../collections/bank-account.collection';
-import { LoanCollection } from '../../collections/loan.collection';
-import { FinancialYear } from '../financial-year/financial-year';
-import { PropertyEquityChartTypeEnum } from './property-equity-chart-type.enum';
-import { Property } from './property';
-import { BankAccount } from '../bank/bank-account';
-
-// count of years for future values
-const FORECAST_YEARS: number = 25;
-
-/**
- * class contain actual and forecasted market values and loan balances for passed properties
- * X axis - years from the first actual data year to the last forecasted year
- * Y axis - amounts of market values, loan balances
- * Also on hover appear equity positions point
- */
-export class PropertyEquityChartData {
-  // list of equity positions for all years range
-  list: PropertyEquityChartItem[];
-  // current financial year
-  currentYear: number;
-  // list of properties this collection based on
-  private properties: PropertyCollection;
-  private bankAccounts: BankAccountCollection;
-  private loans: LoanCollection;
-
-  constructor(
-    properties: PropertyCollection,
-    bankAccounts: BankAccountCollection,
-    loans: LoanCollection,
-    private registerDate: Date
-  ) {
-    this.properties = properties;
-    this.bankAccounts = bankAccounts.getLoanAccounts();
-    this.loans = loans;
-    this.currentYear = new FinancialYear(new Date()).year;
-    this.initItems();
-    this.buildHistoryItems();
-    this.buildActualItem();
-    this.buildForecastedItems();
-    this.checkZeroLoanBalance();
-  }
-
-  /**
-   * get items list in chart series format
-   * @param type
-   */
-  getChartSeries(type: PropertyEquityChartTypeEnum): number[][] {
-    return this.list.map((item: PropertyEquityChartItem) => item.getSerie(type));
-  }
-
-  /**
-   * get prepared chart data
-   */
-  getChartData(): object[] {
-    return [
-      {
-        id: 'marketValue',
-        name: 'Market Value',
-        series: this.getChartSeries(PropertyEquityChartTypeEnum.MARKET_VALUE),
-        // display future market value with dash line and past market value with solid line
-        zones: [{
-          // line style after current calendar year
-          value: this.currentYear,
-          dashStyle: 'Solid'
-        }, {
-          // default line style
-          dashStyle: 'Dash'
-        }]
-      },
-      {
-        // id used to add/remove serie to chart
-        id: 'loanBalance',
-        name: 'Loan Balance',
-        series: this.getChartSeries(PropertyEquityChartTypeEnum.LOAN_BALANCE)
-      }
-    ];
-  }
-
-  /**
-   * create empty equity position item for each year in collection
-   */
-  private initItems(): void {
-    this.list = [];
-    for (let year: number = new FinancialYear(this.registerDate).year - 1; year <= (this.currentYear + FORECAST_YEARS); year++) {
-      this.list.push(new PropertyEquityChartItem(year));
-    }
-  }
-
-  /**
-   * collect equity position items with past values from properties forecasts
-   */
-  private buildHistoryItems(): void {
-    // get items for past and current years
-    const items: PropertyEquityChartItem[] = this.list.filter((item: PropertyEquityChartItem) => item.year <= this.currentYear);
-    items.forEach((item: PropertyEquityChartItem) => {
-      // increase item values with property actual forecasts for item year
-      item.marketValue = this.properties.items.reduce((sum: number, property: Property): number => {
-        return sum + this.getMarketValueForPropertyByYear(property, item.year);
-      }, 0);
-
-      item.loanBalance = Math.abs(this.properties.items.reduce((sum: number, property: Property): number => {
-        return sum + this.getLoanBalanceForPropertyByYear(property, item.year);
-      }, 0));
-    });
-  }
-
-  /**
-   * set actual year's real data
-   * @private
-   */
-  private buildActualItem(): void {
-    const item: PropertyEquityChartItem = this.list.find((i: PropertyEquityChartItem) => i.year === this.currentYear);
-    item.marketValue = this.properties.marketValue;
-    item.loanBalance = this.properties.items.reduce((sum: number, property: Property): number => {
-      return sum + Math.abs(this.bankAccounts.getPropertyBalanceAmount(property.id));
-    }, 0);
-  }
-
-  /**
-   * collect equity position items with forecasted (future) calculated values
-   */
-  private buildForecastedItems(): void {
-    // calculate future values for all properties separately
-    this.properties.items.forEach((property: Property) => {
-      let forecastedMarketValue: number = (property.growthPercent / 100) * property.marketValue + property.marketValue;
-
-      // calculate future values for each future year for current handling property
-      this.list
-        .filter((item: PropertyEquityChartItem) => item.year > this.currentYear)
-        .forEach((item: PropertyEquityChartItem) => {
-          const propertyBankAccounts: BankAccountCollection = this.bankAccounts.getByPropertyId(property.id);
-          // increase loan balance amount for handling equity position item
-          item.loanBalance += this.getLoanBalanceByYear(property, item.year, propertyBankAccounts, this.loans.getByBankAccountsIds(propertyBankAccounts.getIds()));
-
-          // increase market value amount for handling equity position item
-          item.marketValue += forecastedMarketValue;
-
-          // increase current market value forecast for the next cycle iteration
-          forecastedMarketValue += forecastedMarketValue * (property.growthPercent / 100);
-        });
-    });
-  }
-
-  /**
-   * Get property loan balance by financial year
-   * @param property Property instance for filter
-   * @param year Financial year number
-   * @param bankAccounts List of bank accounts
-   * @param loans List of loans
-   * @private
-   */
-  private getLoanBalanceByYear(property: Property, year: number, bankAccounts: BankAccountCollection, loans: LoanCollection): number {
-    return bankAccounts.items.reduce((totalSum: number, bankAccount: BankAccount): number => {
-      return totalSum + (bankAccount.getPropertyPercentage(property.id) * (loans.getByBankAccountId(bankAccount.id)?.getLastPaymentByYear(year)?.totalOwed || 0));
-    }, 0);
-  }
-
-  getMarketValueForPropertyByYear(property: Property, year: number): number {
-    if (new FinancialYear(property.purchaseDate).year > year) {
-      return 0;
-    }
-
-    return (property.getForecastByYear(year) || first(property.forecasts)).marketValue;
-  }
-
-  getLoanBalanceForPropertyByYear(property: Property, year: number): number {
-    if (new FinancialYear(property.purchaseDate).year > year) {
-      return 0;
-    }
-
-    return property.getForecastByYear(year)?.loanBalance || this.bankAccounts.getPropertyBalanceAmount(property.id);
-  }
-
-  /**
-   * Check if loan balance is 0 and set it as null (to not to draw point on the chart)
-   */
-  private checkZeroLoanBalance(): void {
-    this.list.forEach((item: PropertyEquityChartItem) => {
-      if (item.loanBalance === 0) {
-        item.loanBalance = null;
-      }
-    });
-  }
-}

package/src/lib/models/property/property-equity-chart-item.ts

@@ -1,35 +0,0 @@
-import { PropertyEquityChartTypeEnum } from './property-equity-chart-type.enum';
-
-/**
- * class contains equity information for passed financial year
- */
-export class PropertyEquityChartItem {
-  year: number;
-  marketValue: number;
-  loanBalance: number;
-
-  constructor(
-    year: number,
-    marketValue?: number,
-    loanBalance?: number
-  ) {
-    this.year = year;
-    this.marketValue = marketValue || 0;
-    this.loanBalance = loanBalance || 0;
-  }
-
-  /**
-   * calculate equity position
-   */
-  get equityPosition(): number {
-    return this.marketValue - this.loanBalance;
-  }
-
-  /**
-   * return this equity position instance as chart serie
-   * @param type
-   */
-  getSerie(type: PropertyEquityChartTypeEnum): number[] {
-    return [this.year, this[type]];
-  }
-}

package/src/lib/models/property/property-equity-chart-type.enum.ts

@@ -1,4 +0,0 @@
-export enum PropertyEquityChartTypeEnum {
-  MARKET_VALUE = 'marketValue',
-  LOAN_BALANCE = 'loanBalance'
-}

package/src/lib/models/property/property-forecast.ts

@@ -1,55 +0,0 @@
-import { PropertyForecast as PropertyForecastBase } from '../../db/Models/property-forecast';
-import { FinancialYear } from '../financial-year/financial-year';
-import { Transform } from 'class-transformer';
-
-export class PropertyForecast extends PropertyForecastBase {
-  @Transform(({ value }) => +value)
-  income: number;
-
-  @Transform(({ value }) => -Math.abs(+value))
-  expense: number;
-
-  @Transform(({ value }) => -Math.abs(+value))
-  interest: number;
-
-  @Transform(({ value }) => -Math.abs(+value))
-  depreciation: number;
-
-  @Transform(({ value }) => +value)
-  loanBalance: number;
-
-  @Transform(({ value }) => +value)
-  marketValue: number;
-
-  /**
-   * Get cash position
-   * Cash Position = Income - Expense - Interest
-   */
-  get cashPosition(): number {
-    return this.income + this.expense + this.interest;
-  }
-
-
-  /**
-   * Get tax position
-   * Tax Position = Income - Expense - Interest - Depreciation
-   */
-  get taxPosition(): number {
-    return this.cashPosition + this.depreciation;
-  }
-
-  /**
-   * Get rental return percent
-   * Rental Return = Income / Market Value
-   */
-  get rentalReturn(): number {
-    return this.income / this.marketValue;
-  }
-
-  /**
-   * Check if forecast is for real current fin year (not selected in the sidebar)
-   */
-  isCurrentYear(): boolean {
-    return this.financialYear === new FinancialYear(new Date()).year;
-  }
-}

package/src/lib/models/property/property-owner.ts

@@ -1,50 +0,0 @@
-import { PropertyOwner as PropertyOwnerBase } from '../../db/Models/property-owner';
-import { PropertyOwnerStatusEnum } from '../../db/Enums/property-owner-status.enum';
-import { Transform, Type } from 'class-transformer';
-import { User } from '../user/user';
-import { RegistrationInvite } from '../registration-invite/registration-invite';
-import { Property } from './property';
-
-export class PropertyOwner extends PropertyOwnerBase {
-  @Type(() => Date)
-  fromDate: Date;
-
-  @Type(() => Date)
-  toDate: Date;
-
-  @Type(() => User)
-  user: User;
-
-  @Type(() => RegistrationInvite)
-  invite: RegistrationInvite;
-
-  @Type(() => Property)
-  property: Property;
-
-  @Transform(({obj}) => obj.user ? obj.user.email : obj.invite.email)
-  email: string;
-
-  isAccepted(): boolean {
-    return this.status === PropertyOwnerStatusEnum.APPROVED;
-  }
-
-  isPending(): boolean {
-    return this.status === PropertyOwnerStatusEnum.PENDING;
-  }
-
-  isRejected(): boolean {
-    return this.status === PropertyOwnerStatusEnum.REJECTED;
-  }
-
-  get statusName(): string {
-    return PropertyOwnerStatusEnum[this.status]?.toLowerCase();
-  }
-
-  /**
-   * Return full user name if user is already registered.
-   * Otherwise - return first name from invitation
-   */
-  get fullName(): string {
-    return this.user ? this.user.fullName : `${this.invite.firstName}`;
-  }
-}

package/src/lib/models/property/property-sold.ts

@@ -1,10 +0,0 @@
-import { PropertySold as PropertySoldBase } from '../../db/Models/property-sold';
-import { Type } from 'class-transformer';
-
-export class PropertySold extends PropertySoldBase {
-  @Type(() => Date)
-  date: Date;
-
-  @Type(() => Date)
-  contractDate: Date;
-}

package/src/lib/models/property/property-subscription.ts

@@ -1,11 +0,0 @@
-import { PropertySubscription as PropertySubscriptionBase } from '../../db/Models/property-subscription';
-import { Type } from 'class-transformer';
-import { User } from '../user/user';
-
-export class PropertySubscription extends PropertySubscriptionBase {
-  @Type(() => Date)
-  createdAt: Date;
-
-  @Type(() => User)
-  user: User;
-}

package/src/lib/models/property/property-valuation.ts

@@ -1,24 +0,0 @@
-import { PropertyValuation as PropertyValuationBase } from '../../db/Models/property-valuation';
-import { Exclude, Type } from 'class-transformer';
-import { PropertyDocument } from './property-document';
-import { FinancialYear } from '../financial-year/financial-year';
-
-export class PropertyValuation extends PropertyValuationBase {
-  @Type(() => Date)
-  date: Date;
-
-  @Type(() => PropertyDocument)
-  document: PropertyDocument;
-
-  // could be File when just added new image
-  @Exclude()
-  documentFile: File;
-
-  get financialYear(): number {
-    return new FinancialYear(this.date).year;
-  }
-
-  isCurrentYear(): boolean {
-    return this.financialYear === new FinancialYear(new Date()).year;
-  }
-}

package/src/lib/models/property/property.ts

@@ -1,157 +0,0 @@
-import { Property as PropertyBase } from '../../db/Models/property';
-import { CapitalCostProperty } from '../../db/Models/capital-cost-property';
-import { Documentable } from '../../interfaces/documentable.interface';
-import { IDocument } from '../../interfaces/document.interface';
-import { PropertyOwner } from '../../db/Models/property-owner';
-import { PropertySubscription } from './property-subscription';
-import { Exclude, Type } from 'class-transformer';
-import { Photoable } from '../../interfaces/photoable';
-import { Address } from '../address/address';
-import { PropertyCategory } from './property-category';
-import { PropertyValuation } from './property-valuation';
-import { PropertyForecast } from './property-forecast';
-import { PropertyCategoryMovement } from './property-category-movement';
-import { User } from '../user/user';
-import { FinancialYear } from '../financial-year/financial-year';
-
-export class Property extends PropertyBase implements Photoable, Documentable {
-  @Type(() => Date)
-  purchaseDate: Date;
-
-  @Type(() => Date)
-  settlementDate: Date;
-
-  @Type(() => Address)
-  address: Address;
-
-  @Type(() => PropertyCategory)
-  category: PropertyCategory;
-
-  @Type(() => PropertyValuation)
-  valuations: PropertyValuation[];
-
-  @Type(() => PropertyForecast)
-  forecasts: PropertyForecast[];
-
-  @Type(() => PropertyCategoryMovement)
-  categoryMovements: PropertyCategoryMovement[];
-
-  @Type(() => User)
-  user: User;
-
-  @Type(() => PropertySubscription)
-  subscriptions: PropertySubscription[];
-
-  // could be File when just added new image
-  @Exclude()
-  documentFile: File;
-
-  // @TODO refactor with spare tank
-  documents: IDocument[];
-
-  get name(): string {
-    return this.address.name;
-  }
-
-  get isActive(): boolean {
-    return !!this.subscriptions?.length;
-  }
-
-  isOwn(): boolean {
-    return this.user.id === +localStorage.getItem('userId');
-  }
-
-  /**
-   * Get initials of property. Required by Photoable interface
-   */
-  getInitials(): string {
-    return this.name.split(' ')[1].slice(0, 2);
-  }
-
-  /**
-   * Get property photo. Required by Photoable interface
-   */
-  getPhoto(): string {
-    return this.photo;
-  }
-
-  get capitalCostsTotalAmount(): number {
-    return this.capitalCosts.reduce((sum: number, capitalCost: CapitalCostProperty): number => sum + capitalCost.amount, 0);
-  }
-
-  get currentYearValuations(): PropertyValuation[] {
-    return this.valuations.filter((valuation: PropertyValuation): boolean => valuation.isCurrentYear());
-  }
-
-  get marketValue(): number {
-    return this.actualValuation?.marketValue || 0;
-  }
-
-  get currentYearForecast(): PropertyForecast {
-    return this.forecasts.find((forecast: PropertyForecast): boolean => forecast.isCurrentYear());
-  }
-
-  get forecastedRentalReturn(): number {
-    return this.currentYearForecast?.rentalReturn || 0;
-  }
-
-  get forecastedTaxPosition(): number {
-    return this.currentYearForecast?.taxPosition || 0;
-  }
-
-  get firstForecastYear(): number {
-    return this.forecasts.reduce((min: number, forecast: PropertyForecast): number => {
-      return min > forecast.financialYear ? forecast.financialYear : min;
-    }, new FinancialYear().year);
-  }
-
-  get marketValueGrowth(): number {
-    return (this.marketValue - this.purchasePrice) / this.marketValue;
-  }
-
-  get myShare(): PropertyOwner {
-    return this.owners.find((owner: PropertyOwner): boolean => owner.user.id === +localStorage.getItem('userId'));
-  }
-
-  /**
-   * exact claim percent includes ownership
-   */
-  get ownershipClaimPercent(): number {
-    return this.ownershipPercent * this.claimPercent / 100;
-  }
-
-  get actualValuation(): PropertyValuation {
-    return this.valuations.reduce((maxDateValuation: PropertyValuation, valuation: PropertyValuation) => {
-      return maxDateValuation.date > valuation.date ? maxDateValuation : valuation;
-    }, this.valuations[0]);
-  }
-
-  get ownershipPercent(): number {
-    return this.myShare.ownershipPercent;
-  }
-
-  get previousCategory(): PropertyCategory {
-    let previousCategory: PropertyCategory;
-
-    const movementsCount: number = this.categoryMovements.length;
-
-    if (movementsCount > 1) {
-      previousCategory = this.categoryMovements[movementsCount - 2].propertyCategory;
-    }
-
-    return previousCategory;
-  }
-
-  getCurrentSubscription(): PropertySubscription {
-    // always return first element because subscriptions array contains only one element
-    return this.subscriptions[0];
-  }
-
-  getForecastByYear(year: number): PropertyForecast {
-    return this.forecasts.find((forecast: PropertyForecast): boolean => forecast.financialYear === year);
-  }
-
-  get isShared(): boolean {
-    return this.owners.length > 1;
-  }
-}

package/src/lib/models/registration-invite/registration-invite.ts

@@ -1,12 +0,0 @@
-import { RegistrationInvite as RegistrationInviteBase } from '../../db/Models/registration-invite';
-import { Photoable } from '../../interfaces/photoable';
-
-export class RegistrationInvite extends RegistrationInviteBase implements Photoable {
-  getInitials(): string {
-    return `${this.firstName[0].toUpperCase()}${this.firstName[1]}`;
-  }
-
-  getPhoto(): string {
-    return null;
-  }
-}

package/src/lib/models/service-subscription/module-url-list.const.ts

@@ -1,11 +0,0 @@
-/**
- * Constant with list of URLs
- */
-export const MODULE_URL_LIST: { [key: string]: string } = {
-  dashboard: '/client/dashboard',
-  propertyTank: '/client/property-tank',
-  workTank: '/client/work-tank',
-  spareTank: '/client/spare-tank',
-  taxSummary: '/client/tax-summary',
-  myAccount: '/client/my-account/subscription'
-};

package/src/lib/models/service-subscription/service-payment.ts

@@ -1,8 +0,0 @@
-import { ServicePayment as BaseServicePayment } from '../../db/Models/service-payment';
-import { ServiceSubscription } from './service-subscription';
-import { Type } from 'class-transformer';
-
-export class ServicePayment extends BaseServicePayment {
-  @Type(() => ServiceSubscription)
-  subscription: ServiceSubscription;
-}

package/src/lib/models/service-subscription/service-price.ts

@@ -1,8 +0,0 @@
-import { ServicePrice as BaseServicePrice } from '../../db/Models/service-price';
-import { ServiceProduct } from './service-product';
-import { Type } from 'class-transformer';
-
-export class ServicePrice extends BaseServicePrice {
-  @Type(() => ServiceProduct)
-  product: ServiceProduct;
-}

package/src/lib/models/service-subscription/service-product.ts

@@ -1,11 +0,0 @@
-import { ServiceProduct as BaseServiceProduct } from '../../db/Models/service-product';
-
-export class ServiceProduct extends BaseServiceProduct {
-  isProperty(): boolean {
-    return this.title === 'Property';
-  }
-
-  isWork(): boolean {
-    return this.title === 'Work Tank';
-  }
-}

package/src/lib/models/service-subscription/service-subscription-item.ts

@@ -1,12 +0,0 @@
-import { ServiceSubscriptionItem as ServiceSubscriptionItemBase } from '../../db/Models/service-subscription-item';
-import { ServicePrice } from './service-price';
-import { Type } from 'class-transformer';
-
-export class ServiceSubscriptionItem extends ServiceSubscriptionItemBase {
-  @Type(() => ServicePrice)
-  price: ServicePrice;
-
-  get total(): number {
-    return this.price.amount * this.quantity;
-  }
-}