taxtank-core 0.1.0 → 0.1.1

package/src/lib/db/Models/vehicle.ts

@@ -0,0 +1,9 @@
+import { User } from './user';
+import { VehicleLogbook } from './vehicle-logbook';
+
+export class Vehicle {
+  name?: string;
+  id?: number;
+  user?: User;
+  logbook?: VehicleLogbook[];
+}

package/src/lib/functions/array/index.ts

@@ -0,0 +1,3 @@
+export * from './replace';
+export * from './sort';
+export * from './sort-deep';

package/src/lib/functions/array/replace.ts

@@ -0,0 +1,5 @@
+// replace array element with the new one (only arrays of objects)
+export function replace(array: any[], item: any, matchField: string = 'id'): void {
+  const index: number = array.findIndex((i: any) => i[matchField] === item[matchField]);
+  array.splice(index, 1, item);
+}

package/src/lib/functions/array/sort-deep.ts

@@ -0,0 +1,19 @@
+// sort array of objects by field
+export function sortDeep(array: any[], fieldsQueue: string[] = ['id'], isDesc: boolean = true): void {
+  array.sort((a: any, b: any): number => {
+    const aValue: any = getValue(a, fieldsQueue);
+    const bValue: any = getValue(b, fieldsQueue);
+
+    if (aValue > bValue) { return !isDesc ? 1 : -1; }
+    if (aValue < bValue) { return !isDesc ? -1 : 1; }
+    return 0;
+  });
+}
+
+function getValue(obj: any, fields: string[]): any {
+  let value: any = obj;
+  fields.forEach((field: string) => {
+    value = value[field];
+  });
+  return value;
+}

package/src/lib/functions/array/sort.ts

@@ -0,0 +1,8 @@
+// sort array of objects by field
+export function sort(array: any[], field: string = 'id', isDesc: boolean = true): void {
+  array.sort((a: any, b: any): number => {
+    if (a[field] > b[field]) { return !isDesc ? 1 : -1; }
+    if (a[field] < b[field]) { return !isDesc ? -1 : 1; }
+    return 0;
+  });
+}

package/src/lib/functions/clone-deep.ts

@@ -0,0 +1,4 @@
+// deep clone for entity
+export function cloneDeep(array: any): any {
+  return JSON.parse(JSON.stringify(array));
+}

package/src/lib/functions/create-date.ts

@@ -0,0 +1,7 @@
+/**
+ * Create date from string entity (or return null if entity is not parsable)
+ * @param date
+ */
+export function createDate(date: string): Date {
+  return Date.parse(date) ? new Date(date) : null;
+}

package/src/lib/functions/enum-to-list.ts

@@ -0,0 +1,16 @@
+import { IOption } from '../interfaces/option.interface';
+
+export function enumToList(data: object): IOption[] {
+  const list: IOption[] = [];
+
+  for (const key in data) {
+    if (Number(key) >= 0) {
+      list.push({
+        label: data[key],
+        value: Number(key)
+      });
+    }
+  }
+
+  return list;
+}

package/src/lib/functions/get-doc-icon.ts

@@ -0,0 +1,21 @@
+import { IAsset } from '../interfaces/asset.interface';
+import { IconsFileEnum } from '../models/file/icons-file.enum';
+
+/**
+ * Function which returns icon depends on document extension
+ * @param document
+ */
+export function getDocIcon(document: IAsset): IconsFileEnum {
+  switch (document.mimeType) {
+    case 'image/gif':
+    case 'image/jpeg':
+    case 'image/png':
+      return IconsFileEnum.JPG;
+
+    case 'application/pdf':
+      return IconsFileEnum.PDF;
+
+    default:
+      return IconsFileEnum.DOC;
+  }
+}

package/src/lib/functions/mat-options-functions.ts

@@ -0,0 +1,11 @@
+export function compareMatOptions(option: any, value: any): boolean {
+  return option.id === value.id;
+}
+
+export function displayMatOptions(option: object): string {
+  if (!option) {
+    return '';
+  }
+
+  return option['name'];
+}

package/src/lib/functions/mat-sort-options.ts

@@ -0,0 +1,9 @@
+/**
+ * Compare function, that used for sortData method
+ * @param a: first comparison argument
+ * @param b: second comparison argument
+ * @param isAsc: is ascending sorting flag
+ */
+export function compare(a: number | string, b: number | string, isAsc: boolean): number {
+  return (a < b ? -1 : 1) * (isAsc ? 1 : -1);
+}

package/src/lib/functions/round-to.ts

@@ -0,0 +1,9 @@
+/**
+ * Function which round value to the provided decimals
+ * @param value to be rounded
+ * @param decimals: amount of decimals
+ */
+export function roundTo(value: number, decimals: number = 2): number {
+  const multiplier: number = Math.pow(10, decimals);
+  return Math.round((value * 100) * multiplier) / multiplier;
+}

package/src/lib/functions/tax-review-filter-predicate.ts

@@ -0,0 +1,11 @@
+import { TaxReview } from '../models/tax-review/tax-review';
+
+/**
+ * Filter predicate function to search inside TaxReview class fields
+ * @param data in which query will be searched
+ * @param filter: search query
+ */
+export function taxReviewFilterPredicate(data: TaxReview, filter: string): boolean {
+  return data.client.fullName.toLowerCase().includes(filter) ||
+    data.employee.fullName.toLowerCase().includes(filter);
+}

package/src/lib/interfaces/asset-entity-type.enum.ts

@@ -0,0 +1,10 @@
+/**
+ * Enum with asset entity types
+ */
+export enum AssetEntityTypeEnum {
+  PROPERTIES = 'properties',
+  FOLDERS = 'folders',
+  DEPRECIATIONS = 'depreciations',
+  TRANSACTIONS = 'transactions',
+  MESSAGES = 'messages'
+}

package/src/lib/interfaces/asset-type.enum.ts

@@ -0,0 +1,9 @@
+// @TODO this enum should come from backend
+/**
+ * Enum with asset types
+ */
+export enum AssetTypeEnum {
+  RECEIPTS = 'receipts',
+  DOCUMENTS = 'documents',
+  MESSAGE = 'message'
+}

package/src/lib/interfaces/asset.interface.ts

@@ -0,0 +1,18 @@
+import { AssetTypeEnum } from './asset-type.enum';
+import { AssetEntityTypeEnum } from './asset-entity-type.enum';
+import { User } from '../models/user/user';
+
+/**
+ * Interface for assets (documents, receipts, e.t.c.)
+ */
+export interface IAsset {
+  id?: number;
+  type: AssetTypeEnum;
+  entityType: AssetEntityTypeEnum;
+  name?: string;
+  originalName?: string;
+  size?: number;
+  mimeType?: string;
+  createdAt?: Date;
+  user?: User;
+}

package/src/lib/interfaces/chart-data.interface.ts

@@ -0,0 +1,11 @@
+import { IChartSerie } from './chart-serie.interface';
+
+/**
+ *  @deprecated Use {@link ChartData} class instead
+ */
+export interface IChartData {
+  id?: number | string;
+  name: string;
+  data: IChartSerie[] | any;
+  zones?: object[];
+}

package/src/lib/interfaces/chart-serie.interface.ts

@@ -0,0 +1,8 @@
+/**
+ *  @deprecated Use {@link ChartSerie} class instead
+ */
+export interface IChartSerie {
+  label: string;
+  value: number;
+  order?: any;
+}

package/src/lib/interfaces/document.interface.ts

@@ -0,0 +1,20 @@
+import { Documentable } from './documentable.interface';
+
+/**
+ * Interface for documents
+ */
+export interface IDocument {
+  id?: number;
+  originalName?: string;
+  size?: number;
+  updatedAt?: Date;
+  /**
+   * Get document parent entity
+   */
+  getEntity(): Documentable;
+
+  /**
+   * Get API url prefix
+   */
+  getApiUrlPrefix(): string;
+}

package/src/lib/interfaces/documentable.interface.ts

@@ -0,0 +1,9 @@
+import { IDocument } from './document.interface';
+
+/**
+ * Interface for entities with documents
+ */
+export interface Documentable {
+  id?: number;
+  documents?: IDocument[];
+}

package/src/lib/interfaces/event-listener.interface.ts

@@ -0,0 +1,9 @@
+/**
+ * Interface for classes that subscribes on Event Dispatcher service
+ */
+export interface IEventListener {
+  /**
+   * Event Dispatcher Service .on() method listeners
+   */
+  listenEvents(): void;
+}

package/src/lib/interfaces/income-source-forecast.interface.ts

@@ -0,0 +1,7 @@
+/**
+ * Interface for income source forecasts
+ */
+export interface IIncomeSourceForecast {
+  id: number;
+  tax: number;
+}

package/src/lib/interfaces/option.interface.ts

@@ -0,0 +1,4 @@
+export interface IOption {
+  label: string;
+  value: any;
+}

package/src/lib/interfaces/photoable.ts

@@ -0,0 +1,14 @@
+/**
+ * Interface that show if object has photo
+ */
+export interface Photoable {
+  /**
+   * Get link to object's photo
+   */
+  getPhoto(): string;
+
+  /**
+   * get object's initials for photo placeholder
+   */
+  getInitials(): string;
+}

package/src/lib/interfaces/receipt.interface.ts

@@ -0,0 +1,13 @@
+import { IAsset } from './asset.interface';
+import { ChartAccounts } from '../models/chart-accounts/chart-accounts';
+
+/**
+ * Interface that contains main fields for transaction-like classes
+ */
+export interface IReceipt {
+  id?: number;
+  amount?: number;
+  receipt: IAsset;
+  chartAccounts: ChartAccounts;
+  getDate(): Date;
+}

package/src/lib/interfaces/salary-forecast.interface.ts

@@ -0,0 +1,17 @@
+import { SalaryForecastFrequencyEnum } from '../db/Enums/salary-forecast-frequency.enum';
+import { IncomeSource } from '../models/income-source/income-source';
+
+/**
+ * Interface for income source forecasts that related to Salary category
+ */
+export interface ISalaryForecast {
+  id: number;
+  tax: number;
+  netPay: number;
+  grossAmount: number;
+  paygIncome: number;
+  financialYear: number;
+  frequency: SalaryForecastFrequencyEnum;
+  isTaxFree: boolean;
+  incomeSource: IncomeSource;
+}

package/src/lib/interfaces/tank.interface.ts

@@ -0,0 +1,9 @@
+/**
+ * Interface, which should be implemented for tank-type checking
+ */
+export interface ITank {
+  // Check if current tank is Property
+  isPropertyTank(): boolean;
+  // Check if current tank is Work
+  isWorkTank(): boolean;
+}

package/src/lib/models/address/address.ts

@@ -0,0 +1,24 @@
+import { Address as AddressBase } from '../../db/Models/address';
+import { Country } from './country';
+import { AddressTypeEnum } from '../../db/Enums/address-type.enum';
+import { Type } from 'class-transformer';
+
+export class Address extends AddressBase {
+  @Type((() => Country))
+  country: Country;
+
+  suggestion: string;
+  type: AddressTypeEnum = AddressTypeEnum.STREET;
+
+  toString(): string {
+    return [this.unitNumber, this.address, this.city, this.state, this.postcode].filter(Boolean).join(', ');
+  }
+
+  get name(): string {
+    return `${this.unitNumber ? this.unitNumber + '/' : ''}${this.address}`;
+  }
+
+  get nameLong(): string {
+    return `${this.name}, ${this.city}, ${this.state}`;
+  }
+}

package/src/lib/models/address/country.ts

@@ -0,0 +1,17 @@
+import { Country as CountryBase } from '../../db/Models/country';
+
+export class Country extends CountryBase {
+  /**
+   * Return country name with phone code
+   */
+  get countryWithCode(): string {
+    return `${this.name} (+${this.callingCode})`;
+  }
+
+  /**
+   * Check if country calling code is Australian or not
+   */
+  isAustralianCode(): boolean {
+    return this.callingCode === '61';
+  }
+}

package/src/lib/models/bank/bank-account-chart-data.ts

@@ -0,0 +1,42 @@
+import { BankAccount } from './bank-account';
+import { IChartData } from '../../interfaces/chart-data.interface';
+
+/**
+ * bank account collection UI class with frontend specific data
+ */
+export class BankAccountChartData {
+  private bankAccounts: BankAccount[];
+
+  constructor(
+    bankAccounts: BankAccount[]
+  ) {
+    this.bankAccounts = bankAccounts;
+  }
+
+  /**
+   * set value of pie chart data
+   */
+  getBalancePieChartData(): IChartData[] {
+    return this.bankAccounts.map((bankAccount: BankAccount) => {
+      return {
+        name: bankAccount.accountName,
+        data: Math.abs(bankAccount.currentBalance)
+      };
+    });
+  }
+
+  /**
+   * set value of bar chart data
+   */
+  getBalanceBarChartData(): IChartData[] {
+    return [{
+      name: 'Balance',
+      data: this.bankAccounts.map((bankAccount: BankAccount) => {
+        return {
+          label: bankAccount.accountName,
+          value: bankAccount.currentBalance
+        };
+      })
+    }];
+  }
+}

package/src/lib/models/bank/bank-account-property.ts

@@ -0,0 +1,8 @@
+import { BankAccountProperty as BankAccountPropertyBase } from '../../db/Models/bank-account-property';
+import { Type } from 'class-transformer';
+import { Property } from '../property/property';
+
+export class BankAccountProperty extends BankAccountPropertyBase {
+  @Type(() => Property)
+  property: Property;
+}

package/src/lib/models/bank/bank-account-types.const.ts

@@ -0,0 +1,15 @@
+import { BankAccountTypeEnum } from '../../db/Enums/bank-account-type.enum';
+
+/**
+ * Const which contains array of bank account types
+ */
+export const BANK_ACCOUNT_TYPES: {key: number, value: string}[] = [
+  {key: BankAccountTypeEnum.CREDIT_CARD, value: 'Credit Card Accounts'},
+  {key: BankAccountTypeEnum.TERM_DEPOSIT, value: 'Deposit Accounts'},
+  {key: BankAccountTypeEnum.INVESTMENT, value: 'Investment Accounts'},
+  {key: BankAccountTypeEnum.LOAN, value: 'Loan Accounts'},
+  {key: BankAccountTypeEnum.MORTGAGE, value: 'Mortgage Accounts'},
+  {key: BankAccountTypeEnum.OFFSET, value: 'Offset'},
+  {key: BankAccountTypeEnum.SAVINGS, value: 'Savings Accounts'},
+  {key: BankAccountTypeEnum.TRANSACTION, value: 'Transaction Accounts'},
+];

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

@@ -0,0 +1,136 @@
+import { BankAccount as BankAccountBase } from '../../db/Models/bank-account';
+import { BankAccountTypeEnum } from '../../db/Enums/bank-account-type.enum';
+import { BankAccountStatusEnum } from '../../db/Enums/bank-account-status.enum';
+import { Loan } from '../loan/loan';
+import { TankTypeEnum } from '../../db/Enums/tank-type.enum';
+import { BankAccountBalance } from '../../db/Models/bank-account-balance';
+import { FinancialYear } from '../financial-year/financial-year';
+import { BankAccountProperty } from './bank-account-property';
+import { BankConnection } from './bank-connection';
+import { Type } from 'class-transformer';
+
+export class BankAccount extends BankAccountBase {
+  // list of properties related with this bank account
+  @Type(() => BankAccountProperty)
+  bankAccountProperties: BankAccountProperty[];
+
+  @Type(() => BankAccountBalance)
+  balances: BankAccountBalance[];
+
+  // bank account's loan
+  @Type(() => Loan)
+  loan: Loan;
+
+  @Type(() => BankConnection)
+  bankConnection: BankConnection;
+
+  /**
+   * Get current opening balance amount
+   */
+  getOpeningBalance(): number {
+    return this.getCurrentYearBalance()?.openingBalance || 0;
+  }
+
+  /**
+   * Get bank account balance for current financial year
+   */
+  getCurrentYearBalance(): BankAccountBalance {
+    const currentFinYear: number = new FinancialYear().year;
+    return this.balances.find((balance: BankAccountBalance): boolean => balance.financialYear === currentFinYear);
+  }
+
+  /**
+   * check if bank account type is one of savings accounts
+   */
+  isSavingsAccount(): boolean {
+    return this.type === BankAccountTypeEnum.INVESTMENT ||
+      this.type === BankAccountTypeEnum.TERM_DEPOSIT ||
+      this.type === BankAccountTypeEnum.SAVINGS;
+  }
+
+  /**
+   * check if bank account type is Loan
+   * @TODO nicole check
+   */
+  isLoan(): boolean {
+    return [BankAccountTypeEnum.MORTGAGE, BankAccountTypeEnum.LOAN].includes(this.type);
+  }
+
+  /**
+   * check if bank account type is Credit card
+   */
+  isCreditCard(): boolean {
+    return this.type === BankAccountTypeEnum.CREDIT_CARD;
+  }
+
+  /**
+   * check if bank account related to work tank
+   */
+  isWorkTank(): boolean {
+    return this.tankType === TankTypeEnum.WORK;
+  }
+
+  /**
+   * check if bank account related to work tank
+   */
+  isPropertyTank(): boolean {
+    return this.tankType === TankTypeEnum.PROPERTY;
+  }
+
+  /**
+   * Get Bank account property by id
+   * @param id Id of property
+   */
+  getPropertyById(id: number): BankAccountProperty {
+    return this.bankAccountProperties.find((bankAccountProperty: BankAccountProperty): boolean => bankAccountProperty.property.id === id);
+  }
+
+  /**
+   * check if bank account is related with passed property by id
+   * @param propertyId Property id for checking
+   */
+  hasProperty(propertyId: number): boolean {
+    return !!this.getPropertyById(propertyId);
+  }
+
+  /**
+   * Get decimal percentage for property
+   * @param propertyId Id of property
+   */
+  getPropertyPercentage(propertyId: number): number {
+    if (!this.hasProperty(propertyId)) {
+      return 0;
+    }
+
+    return this.getPropertyById(propertyId).percent / 100;
+  }
+
+  /**
+   * Get balance amount for property by id
+   * @param propertyId Id of property
+   */
+  getPropertyBalanceAmount(propertyId: number): number {
+    return this.currentBalance * this.getPropertyPercentage(propertyId);
+  }
+
+  /**
+   * Check if bank account is active (has 'active' status or hasn't been paid out/refinanced)
+   */
+  isActive(): boolean {
+    return this.status === BankAccountStatusEnum.ACTIVE;
+  }
+
+  /**
+   * first import (transactions) of basiq accounts
+   */
+  isFirstImport(): boolean {
+    return !this.lastTransactionDate && !this.isManual;
+  }
+
+  /**
+   * Check if passed user id is owner of bank account
+   */
+  isOwner(userId: number): boolean {
+    return this.bankConnection.user.id === userId;
+  }
+}

package/src/lib/models/bank/bank-connection.ts

@@ -0,0 +1,12 @@
+import { BankConnection as BankConnectionBase } from '../../db/Models/bank-connection';
+import { BasiqJob } from './basiq-job';
+import { Bank } from './bank';
+import { Type } from 'class-transformer';
+
+export class BankConnection extends BankConnectionBase {
+  @Type(() => BasiqJob)
+  basiqJob: BasiqJob;
+
+  @Type(() => Bank)
+  bank: Bank;
+}