taxtank-core 0.1.1 → 0.1.2

package/src/lib/collections/income-source.collection.ts

@@ -1,44 +0,0 @@
-import { AbstractCollection } from './abstract.collection';
-import { IncomeSource } from '../models/income-source/income-source';
-import { TankTypeEnum } from '../db/Enums/tank-type.enum';
-import { IncomeSourceTypeEnum } from '../db/Enums/income-source-type.enum';
-import { ISalaryForecast } from '../interfaces/salary-forecast.interface';
-
-/**
- * Collection of income sources
- */
-export class IncomeSourceCollection extends AbstractCollection<IncomeSource> {
-  filterByTank(tank: TankTypeEnum): IncomeSource[] {
-    return this.items.filter((incomeSource: IncomeSource) => {
-      switch (tank) {
-        case TankTypeEnum.OTHER:
-          return incomeSource.isOtherIncome();
-        default:
-          return incomeSource.isSalaryIncome() || incomeSource.isWorkIncome();
-      }
-    });
-  }
-
-  /**
-   * Filter income sources by provided tyoes
-   * @param types
-   */
-  filterByTypes(types: IncomeSourceTypeEnum[]): IncomeSource[] {
-    return this.items.filter((incomeSource: IncomeSource) => types.includes(incomeSource.type));
-  }
-
-  /**
-   * Get income source by provided Id
-   * @param id
-   */
-  getById(id: number): IncomeSource {
-    return this.items.find((incomeSource: IncomeSource) => incomeSource.id === id);
-  }
-
-  /**
-   * Get income sources list of forecasts
-   */
-  get forecasts(): ISalaryForecast[] {
-    return this.items.map((incomeSource: IncomeSource) => incomeSource.forecasts).flat();
-  }
-}

package/src/lib/collections/loan.collection.ts

@@ -1,22 +0,0 @@
-import { AbstractCollection } from './abstract.collection';
-import { Loan } from '../models/loan/loan';
-
-export class LoanCollection extends AbstractCollection<Loan> {
-  /**
-   * Get new collection of loans filtered by bank accounts ids
-   * @param ids list of bank accounts ids for filter
-   */
-  getByBankAccountsIds(ids: number[]): LoanCollection {
-    return new LoanCollection(
-      this.items.filter((loan: Loan): boolean => ids.includes(loan.bankAccount?.id))
-    );
-  }
-
-  /**
-   * Get single loan by bank account id
-   * @param id id of bank account
-   */
-  getByBankAccountId(id: number): Loan {
-    return this.items.find((loan: Loan): boolean => loan.bankAccount?.id === id);
-  }
-}

package/src/lib/collections/logbook.collection.ts

@@ -1,129 +0,0 @@
-import { VehicleLogbook } from '../models/logbook/vehicle-logbook';
-import { FinancialYear } from '../models/financial-year/financial-year';
-import { LogbookPeriod } from '../models/logbook/logbook-period';
-import { Vehicle } from '../models/logbook/vehicle';
-import { plainToClass } from 'class-transformer';
-
-// Class contain array of vehicle logbooks and calculate the best period for logbook claim method
-export class LogbookCollection {
-  // array of all trips
-  trips: VehicleLogbook[];
-  // 12 weeks in milliseconds to check logbooks range
-  logbookClaimRange: number = 12 * 7 * 24 * 3600 * 1000;
-  // current financial year object
-  financialYear: FinancialYear;
-  // default best period used for comparison in calculation
-  private _bestPeriod: LogbookPeriod;
-
-  constructor(
-    vehicles: Vehicle[]
-  ) {
-    this.trips = vehicles.map((vehicle: Vehicle) => vehicle.logbook).flat();
-    this.financialYear = new FinancialYear();
-    this.setInitialBestPeriod();
-  }
-
-  // check if summary logbooks date range less than 84 days (12 weeks)
-  get isAutomaticLogbookCalculationAllowed(): boolean {
-    // forbid automatic logbook calculation if no logbook trips exist
-    if (!this.trips.length) {
-      return false;
-    }
-
-    // forbid automatic logbook calculation if logbook trips summary date range less than 12 weeks
-    return this.trips.slice(-1)[0].date.getTime() - this.trips[0].date.getTime() >= this.logbookClaimRange;
-  }
-
-  get bestPeriod(): LogbookPeriod {
-    // don't calculate if not allowed
-    if (!this.isAutomaticLogbookCalculationAllowed) {
-      return null;
-    }
-
-    this.calculateBestPeriod();
-
-    return this._bestPeriod;
-  }
-
-  private get workTrips(): VehicleLogbook[] {
-    return this.trips.filter((logbook: VehicleLogbook) => logbook.isWork);
-  }
-
-  // calculate best period for logbook claim method
-  private calculateBestPeriod(): void {
-
-    // set default best period values for real values comparison
-    this.setInitialBestPeriod();
-
-    // get best period with each trip date as start date
-    this.workTrips.forEach((logbook: VehicleLogbook) => {
-      const dateRange: {from: Date, to: Date} = this.getDateRange(logbook.date);
-
-      // get all trips included in current 12 weeks period
-      const tripsInRange: VehicleLogbook[] = this.trips.filter((l: VehicleLogbook) => {
-        return l.date >= dateRange.from && l.date <= dateRange.to;
-      });
-
-      // get work trips included in current 12 weeks period
-      const workTripsInRange: VehicleLogbook[] = tripsInRange.filter((l: VehicleLogbook) => l.isWork);
-
-      // calculate sum of work kilometers in current 12 weeks range
-      const currentRangeKilometers: number = this.getKilometersAmount(workTripsInRange);
-
-      // overwrite best period with current 12 weeks range if amount of kilometers is bigger
-      if (currentRangeKilometers > this._bestPeriod.kilometers) {
-        this._bestPeriod = {
-          from: dateRange.from,
-          to: dateRange.to,
-          kilometers: currentRangeKilometers,
-          workUsage: this.getLogbooksWorkUsage(tripsInRange, workTripsInRange)
-        };
-      }
-    });
-  }
-
-  private getDateRange(from: Date): {from: Date, to: Date} {
-    // set end date after 12 weeks after start date
-    let to: Date = new Date(from.getTime() + this.logbookClaimRange);
-
-    // set as period last 12 weeks of current year if period end date after end of current year
-    if (to > this.financialYear.endDate) {
-      to = this.financialYear.endDate;
-      from = new Date(to.getTime() - this.logbookClaimRange);
-    }
-
-    return {from, to};
-  }
-
-  // calculate kilometers amount for passed trips
-  private getKilometersAmount(logbooks: VehicleLogbook[]): number {
-    if (!logbooks.length) {
-      return 0;
-    }
-
-    return logbooks.map((logbook: VehicleLogbook) => logbook.odometerEnd - logbook.odometerStart)
-      .reduce((prev: number, next: number) => prev + Number(next));
-  }
-
-  // calculate work usage for passed trips
-  private getLogbooksWorkUsage(logbooks: VehicleLogbook[], workLogbooks: VehicleLogbook[]): number {
-    const kilometers: number = this.getKilometersAmount(logbooks);
-    const workKilometers: number = this.getKilometersAmount(workLogbooks);
-    return Math.round(workKilometers / kilometers * 100);
-  }
-
-  // set default best period with zero values and fin year start date for comparison in calculation
-  private setInitialBestPeriod(): void {
-    // set 1st of July of current year as default start date for best period
-    const startDate: Date = this.financialYear.startDate;
-    // set end custom-date after 12 weeks from start date
-    const endDate: Date = new Date(startDate.getTime() + this.logbookClaimRange);
-
-    this._bestPeriod = plainToClass(LogbookPeriod, {
-      from: startDate,
-      to: endDate,
-      kilometers: 0,
-      workUsage: 0
-    });
-  }
-}

package/src/lib/collections/message-document.collection.ts

@@ -1,16 +0,0 @@
-import { AbstractCollection } from './abstract.collection';
-import { MessageDocument } from '../models/chat/message-document';
-
-/**
- * Collection of MessageDocument instances
- */
-export class MessageDocumentCollection extends AbstractCollection<MessageDocument> {
-  /**
-   * get list of documents which are not attached to any message
-   */
-  getUnattached(): MessageDocumentCollection {
-    return new MessageDocumentCollection(
-      this.items.filter((doc: MessageDocument): boolean => !doc.message)
-    );
-  }
-}

package/src/lib/collections/message.collection.ts

@@ -1,27 +0,0 @@
-import { AbstractCollection } from './abstract.collection';
-import { Message } from '../models/chat/message';
-import { User } from '../models/user/user';
-
-
-export class MessageCollection extends AbstractCollection<Message> {
-  getFirstUnreadMessage(user: User): Message {
-    return this.items.find((message: Message): boolean => {
-        return !message.isRead() && message.isFromEmployee() !== user.isEmployee();
-      }
-    );
-  }
-
-  /**
-   * Get List of unread chats
-   */
-  getUnread(): Message[] {
-    return this.items.filter((message: Message): boolean => !message.readAt);
-  }
-
-  /**
-   * Check if chat has unread chats
-   */
-  hasUnread(): boolean {
-    return !!this.getUnread().length;
-  }
-}

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

@@ -1,88 +0,0 @@
-import { AbstractCollection } from './abstract.collection';
-import { Property } from '../models/property/property';
-import { FinancialYear } from '../models/financial-year/financial-year';
-
-export class PropertyCollection extends AbstractCollection<Property> {
-  /**
-   * Get new property collection filtered by category id
-   * @param id id of category for filter
-   */
-  getByCategoryId(id: number): PropertyCollection {
-    return new PropertyCollection(
-      this.items.filter((property: Property): boolean => property.category.id === id)
-    );
-  }
-
-  /**
-   * Get new property collection filtered by active status
-   */
-  getActiveProperties(): PropertyCollection {
-    return new PropertyCollection(
-      this.items.filter((property: Property): boolean => property.isActive)
-    );
-  }
-
-  /**
-   * Get new property collection filtered by owner
-   */
-  getOwnProperties(): PropertyCollection {
-    return new PropertyCollection(
-      this.items.filter((property: Property): boolean => property.isOwn())
-    );
-  }
-
-  /**
-   * Get new property collection filtered by shared
-   */
-  getSharedProperties(): PropertyCollection {
-    return new PropertyCollection(
-      this.items.filter((property: Property): boolean => !property.isOwn())
-    );
-  }
-
-  /**
-   * Get total purchase price for all properties in the collection
-   */
-  get purchasePrice(): number {
-    return this.sumBy('purchasePrice');
-  }
-
-  get growthPercent(): number {
-    return this.sumBy('growthPercent');
-  }
-
-  get marketValue(): number {
-    return this.sumBy('marketValue');
-  }
-
-  get forecastedRentalReturn(): number {
-    return this.sumBy('forecastedRentalReturn');
-  }
-
-  get forecastedTaxPosition(): number {
-    return this.sumBy('forecastedTaxPosition');
-  }
-
-  get firstForecastYear(): number {
-    return this.items.reduce((min: number, property: Property): number => {
-      const current: number = property.firstForecastYear;
-      return min > current ? current : min;
-    }, new FinancialYear().year);
-  }
-
-  get marketValueGrowth(): number {
-    return this.sumBy('marketValueGrowth');
-  }
-
-  getOwnerOccupiedProperties(): PropertyCollection {
-    return new PropertyCollection(
-      this.items.filter((property: Property): boolean => property.category.isOwnerOccupied())
-    );
-  }
-
-  get earliestPurchaseDate(): Date {
-    return this.items.reduce((min: Date, property: Property): Date => {
-      return min < property.purchaseDate ? min : property.purchaseDate;
-    }, new FinancialYear(new Date()).startDate);
-  }
-}

package/src/lib/collections/service-price.collection.ts

@@ -1,13 +0,0 @@
-import { AbstractCollection } from './abstract.collection';
-import { ServicePrice } from '../models/service-subscription/service-price';
-
-
-export class ServicePriceCollection extends AbstractCollection<ServicePrice> {
-  get work(): ServicePrice {
-    return this.items.filter((price: ServicePrice) => price.product.isWork())[0];
-  }
-
-  get property(): ServicePrice {
-    return this.items.filter((price: ServicePrice) => price.product.isProperty())[0];
-  }
-}

package/src/lib/collections/service-subscription.collection.ts

@@ -1,20 +0,0 @@
-import { AbstractCollection } from './abstract.collection';
-import { ServiceSubscription } from '../models/service-subscription/service-subscription';
-
-export class ServiceSubscriptionCollection extends AbstractCollection<ServiceSubscription> {
-  get individual(): ServiceSubscription {
-    return this.items.filter((subscription: ServiceSubscription) => subscription.isIndividual())[0];
-  }
-
-  get investor(): ServiceSubscription {
-    return this.items.filter((subscription: ServiceSubscription) => subscription.isInvestor())[0];
-  }
-
-  get investorPlus(): ServiceSubscription {
-    return this.items.filter((subscription: ServiceSubscription) => subscription.isInvestorPlus())[0];
-  }
-
-  getRecommended(properties: number): ServiceSubscription {
-    return this.items.filter((subscription: ServiceSubscription) => subscription.propertyQuantity === properties)[0] ?? this.investor;
-  }
-}

package/src/lib/collections/tax-return-category-item.collection.ts

@@ -1,148 +0,0 @@
-import { AbstractCollection } from './abstract.collection';
-import { TaxReturnCategoryItem } from '../models/tax-summary/tax-return-category-item';
-import { TaxReturnCategoryListEnum } from '../db/Enums/tax-return-category-list.enum';
-import { TaxReturnCategorySectionEnum } from '../db/Enums/tax-return-category-section.enum';
-import { TaxReturnCategoryItemDetails } from '../models/tax-summary/tax-return-category-item-details';
-
-/**
- * collection for tax return category items
- */
-export class TaxReturnCategoryItemCollection extends AbstractCollection<TaxReturnCategoryItem> {
-  /**
-   * Work income
-   */
-  get salary(): number {
-    return this.getByCategory(TaxReturnCategoryListEnum.SALARY)?.amount || 0;
-  }
-
-  /**
-   * Work expenses
-   */
-  get workExpenses(): number {
-    return this.getByCategory(TaxReturnCategoryListEnum.WORK_EXPENSES)?.amount || 0;
-  }
-
-  /**
-   * Property income
-   */
-  get rentalIncome(): number {
-    return this.getByCategory(TaxReturnCategoryListEnum.GROSS_RENT)?.amount || 0;
-  }
-
-  /**
-   * Property rental deductions
-   */
-  get rentalDeductions(): number {
-    return this.getByCategory(TaxReturnCategoryListEnum.OTHER_RENTAL_DEDUCTIONS)?.amount || 0;
-  }
-
-  /**
-   * Property expenses
-   */
-  get propertyExpenses(): number {
-    return this.rentalDeductions + this.borrowingExpenses;
-  }
-
-  /**
-   * Property interest
-   */
-  get interestDeductions(): number {
-    return this.getByCategory(TaxReturnCategoryListEnum.INTEREST_DEDUCTIONS)?.amount || 0;
-  }
-
-  /**
-   * Property capital works depreciations
-   */
-  get capitalWorks(): number {
-    return this.getByCategory(TaxReturnCategoryListEnum.CAPITAL_WORKS)?.amount || 0;
-  }
-
-  /**
-   * Property plant & equipment depreciations
-   */
-  get plantEquipment(): number {
-    return this.getByCategory(TaxReturnCategoryListEnum.DEPRECIATION)?.amount || 0;
-  }
-
-  /**
-   * Total property depreciaions
-   */
-  get propertyDepreciations(): number {
-    return this.capitalWorks + this.plantEquipment;
-  }
-
-  get partnershipsAndTrusts(): number {
-    return this.getByCategory(TaxReturnCategoryListEnum.PARTNERSHIPS_TRUSTS)?.amount || 0;
-  }
-
-  get pciAndSbeIncome(): number {
-    return this.getByCategory(TaxReturnCategoryListEnum.PCI_SBE_INCOME)?.amount || 0;
-  }
-
-  get capitalGains(): number {
-    return this.getByCategory(TaxReturnCategoryListEnum.CAPITAL_GAINS)?.amount || 0;
-  }
-
-  get foreignSourceIncome(): number {
-    return this.getByCategory(TaxReturnCategoryListEnum.FOREIGN_SOURCE_INCOME)?.amount || 0;
-  }
-
-  /**
-   * Other income
-   */
-  get otherIncome(): number {
-    return (this.getByCategory(TaxReturnCategoryListEnum.OTHER_INCOME)?.amount || 0) +
-      this.partnershipsAndTrusts +
-      this.pciAndSbeIncome +
-      this.capitalGains +
-      this.foreignSourceIncome;
-  }
-
-  /**
-   * Other expenses
-   */
-  get otherDeductions(): number {
-    return this.getByCategory(TaxReturnCategoryListEnum.OTHER_DEDUCTIONS)?.amount || 0;
-  }
-
-  get taxInstalments(): number {
-    return this.getTaxCreditsCollection().getByCategory(TaxReturnCategoryListEnum.TAX_INSTALMENTS)?.amount || 0;
-  }
-
-  get frankingCredits(): number {
-    return this.getTaxCreditsCollection().getByCategory(TaxReturnCategoryListEnum.FRANKING_CREDITS)?.amount || 0;
-  }
-
-  get taxOffsets(): number {
-    return this.getByCategory(TaxReturnCategoryListEnum.TAX_OFFSETS)?.amount || 0;
-  }
-
-  get borrowingExpenses(): number {
-    return this.getByCategory(TaxReturnCategoryListEnum.BORROWING_EXPENSES)?.amount || 0;
-  }
-
-  get grossTaxPayable(): number {
-    return this.getByCategory(TaxReturnCategoryListEnum.GROSS_TAX_PAYABLE)?.amount || 0;
-  }
-
-  /**
-   * taxWithheld by section (work or other)
-   */
-  getTaxWithheld(section: TaxReturnCategorySectionEnum = TaxReturnCategorySectionEnum.WORK_TANK): number {
-    return this.getTaxCreditsCollection().getByCategory(TaxReturnCategoryListEnum.TAX_WITHHELD)?.details
-      .filter((details: TaxReturnCategoryItemDetails) => details.section === section)
-      .reduce((sum: number, details: TaxReturnCategoryItemDetails): number => sum + details.amount, 0) || 0;
-  }
-
-  getTaxCreditsCollection(): TaxReturnCategoryItemCollection {
-    return new TaxReturnCategoryItemCollection(this.getByCategory(TaxReturnCategoryListEnum.TAX_CREDITS)?.items || []);
-  }
-
-  getTotalAmountByIncomeSourceName(name: string): number {
-    return this.items.reduce(((sum: number, item: TaxReturnCategoryItem): number => sum + item.getAmountByIncomeSourceName(name)), 0);
-  }
-
-  private getByCategory(category: TaxReturnCategoryListEnum): TaxReturnCategoryItem {
-    return this.items.find((item: TaxReturnCategoryItem): boolean => item.taxReturnCategory.id === category);
-  }
-}

package/src/lib/collections/tax-review.collection.ts

@@ -1,64 +0,0 @@
-import { AbstractCollection } from './abstract.collection';
-import { TaxReview } from '../models/tax-review/tax-review';
-import { TaxReviewStatusEnum } from '../db/Enums/tax-review-status.enum';
-import { User } from '../models/user/user';
-import uniqBy from 'lodash/uniqBy'
-
-/**
- * Collection of tax review
- */
-export class TaxReviewCollection extends AbstractCollection<TaxReview> {
-  /**
-   * Get tax reviews items with SENT & COMPLETED statuses
-   */
-  getCompleted(): TaxReview[] {
-    return this.items
-      .filter((taxReview: TaxReview) => taxReview.isSent() || taxReview.isCompleted());
-  }
-
-  /**
-   * Get tax reviews items with WAITING_FOR_APPROVAL status
-   */
-  getReadyForReview(): TaxReview[] {
-    return this.items.filter((taxReview: TaxReview) => taxReview.isNew());
-  }
-
-  /**
-   * Get tax reviews items in work (In progress, Waiting for client, Waiting for Approval, Is approved)
-   */
-  getInWork(): TaxReview[] {
-    return this.items
-      .filter((taxReview: TaxReview) => {
-        return taxReview.isInProgress() ||
-          taxReview.isWaitingForClient() ||
-          taxReview.isWaitingForApproval() ||
-          taxReview.isApproved();
-      });
-  }
-
-  /**
-   * Get percentage of completed reviews of the total review amount
-   */
-  getCompletedPercentage(): number {
-    return 100 * this.getCompleted().length / this.items.length || 0;
-  }
-
-  /**
-   * get list of items filtered by status
-   * @param status
-   */
-  getByStatus(status: TaxReviewStatusEnum): TaxReview[] {
-    return this.items.filter((item: TaxReview): boolean => item.status === status);
-  }
-
-  /**
-   * get list of items by firm id
-   */
-  getByEmployeeId(employeeId: number): TaxReview[] {
-    return this.items.filter((item: TaxReview): boolean => item.employee.id === employeeId);
-  }
-
-  getEmployees(): User[] {
-    return uniqBy(this.items.map((review: TaxReview): User => review.employee), 'id');
-  }
-}

package/src/lib/collections/transaction-allocation.collection.ts

@@ -1,54 +0,0 @@
-import { AbstractCollection } from './abstract.collection';
-import { TransactionAllocation } from '../models/transaction/transaction-allocation';
-import { BankTransactionCollection } from './bank-transaction.collection';
-import { CollectionDictionary } from './collection-dictionary';
-import { Transaction } from '../models/transaction/transaction';
-import { BankTransaction } from '../models/bank/bank-transaction';
-
-
-export class TransactionAllocationCollection extends AbstractCollection<TransactionAllocation> {
-  get amount(): number {
-    return this.sumBy('amount');
-  }
-
-  getByTransactionsIds(ids: number[]): TransactionAllocationCollection {
-    return new TransactionAllocationCollection(
-      this.items.filter((allocation: TransactionAllocation): boolean => ids.includes(allocation.transaction.id))
-    );
-  }
-
-  getByBankTransactionsIds(ids: number[]): TransactionAllocationCollection {
-    return new TransactionAllocationCollection(
-      this.items.filter((allocation: TransactionAllocation): boolean => ids.includes(allocation.bankTransaction.id))
-    );
-  }
-
-  /**
-   * Group allocations by bank account via bank transactions collection
-   */
-  groupByBankAccount(bankTransactions: BankTransactionCollection): CollectionDictionary<TransactionAllocationCollection> {
-    // Group bank transactions by bank account id
-    const bankTransactionsByBankAccount: CollectionDictionary<BankTransactionCollection> = new CollectionDictionary(bankTransactions, 'bankAccount');
-    // Create empty dictionary of transaction allocations
-    const allocationsByBankAccount: CollectionDictionary<TransactionAllocationCollection> = new CollectionDictionary(new TransactionAllocationCollection([]));
-    // Fill allocations dictionary with bank transactions dictionary keys and allocations related with each bank transaction collection
-    bankTransactionsByBankAccount.keys.forEach((key: string): void => {
-      allocationsByBankAccount.add(key, this.getByBankTransactionsIds(bankTransactionsByBankAccount.get(key).getIds()));
-    });
-    return allocationsByBankAccount;
-  }
-
-  /**
-   * check if collection includes allocation of passed transaction
-   */
-  hasTransaction(transaction: Transaction): boolean {
-    return !!this.items.find((allocation: TransactionAllocation): boolean => allocation.transaction.id === transaction.id);
-  }
-
-  /**
-   * Check if bank transaction is related with current allocations
-   */
-  hasBankTransaction(bankTransaction: BankTransaction): boolean {
-    return !!this.items.find((allocation: TransactionAllocation): boolean => allocation.bankTransaction.id === bankTransaction.id);
-  }
-}