taxtank 0.1.0

package/projects/tt-core/src/lib/models/bank/basiq/basiq-connections-response.interface.ts

@@ -0,0 +1,9 @@
+/**
+ * Response from Basiq api with data to create a Bank Connection
+ * https://api.basiq.io/v2.0/docs/build-your-own-1#step-3-create-a-connection
+ */
+export interface BasiqConnectionsResponse {
+  id: string;
+  links: object;
+  type: string;
+}

package/projects/tt-core/src/lib/models/bank/basiq/basiq-job-response.ts

@@ -0,0 +1,17 @@
+import { Type } from 'class-transformer';
+import { BasiqJobStep } from './basiq-job-step';
+
+export class BasiqJobResponse {
+  id: string;
+
+  @Type(() => BasiqJobStep)
+    steps: BasiqJobStep[];
+
+  getVerifyCredentialsStep(): BasiqJobStep {
+    return this.steps.find((step: BasiqJobStep) => step.isVerifyCredentials());
+  }
+
+  getRetrieveAccountsStep(): BasiqJobStep {
+    return this.steps.find((step: BasiqJobStep) => step.isRetrieveAccounts());
+  }
+}

package/projects/tt-core/src/lib/models/bank/basiq/basiq-job-step.ts

@@ -0,0 +1,24 @@
+export class BasiqJobStep {
+  title: 'verify-credentials' | 'retrieve-accounts' | 'retrieve-transactions';
+  status: 'pending' | 'in-progress' | 'failed' | 'success';
+
+  isVerifyCredentials(): boolean {
+    return this.title === 'verify-credentials';
+  }
+
+  isRetrieveAccounts(): boolean {
+    return this.title === 'retrieve-accounts';
+  }
+
+  isInProgress(): boolean {
+    return this.status === 'in-progress';
+  }
+
+  isSuccess(): boolean {
+    return this.status === 'success';
+  }
+
+  isFailed(): boolean {
+    return this.status === 'failed';
+  }
+}

package/projects/tt-core/src/lib/models/bank/basiq/basiq-job.ts

@@ -0,0 +1,4 @@
+import { BasiqJob as BasiqJobBase } from '../../../db/Models/bank/basiq-job';
+
+export class BasiqJob extends BasiqJobBase {
+}

package/projects/tt-core/src/lib/models/bank/basiq/basiq-token-response.interface.ts

@@ -0,0 +1,9 @@
+/**
+ * Response contains Basiq token
+ * http://tt.service/api/doc (GET /api/basiq/tokens)
+ */
+export interface BasiqTokenResponse {
+  access_token: string;
+  expires_in: number;
+  token_type: string;
+}

package/projects/tt-core/src/lib/models/bank/basiq/basiq-token.ts

@@ -0,0 +1,22 @@
+import { AbstractModel } from '../../../db/Models';
+
+/**
+ * access token, needed to access basiq connect ui (https://github.com/basiqio/basiq-connect-ui)
+ */
+export class BasiqToken extends AbstractModel {
+  value: string;
+  expiresAt: Date;
+
+  constructor(
+    value: string,
+    expiresAt: Date
+  ) {
+    super();
+    this.value = value;
+    this.expiresAt = expiresAt;
+  }
+
+  isExpired(): boolean {
+    return this.expiresAt < new Date();
+  }
+}

package/projects/tt-core/src/lib/models/bank/basiq/index.ts

@@ -0,0 +1,8 @@
+export * from './basiq-config';
+export * from './basiq-connection-data.interface';
+export * from './basiq-connections-response.interface';
+export * from './basiq-job';
+export * from './basiq-job-response';
+export * from './basiq-job-step';
+export * from './basiq-token';
+export * from './basiq-token-response.interface';

package/projects/tt-core/src/lib/models/bank/index.ts

@@ -0,0 +1,14 @@
+export * from './basiq';
+
+export * from './allocation-group';
+export * from './bank';
+export * from './bank-account';
+export * from './bank-account-chart-data';
+export * from './bank-account-property';
+export * from './bank-connection';
+export * from './bank-external-stats';
+export * from './bank-transaction';
+export * from './bank-transaction-chart-data';
+export * from './bank-transaction-summary-fields.enum';
+export * from './type-loan.const';
+export * from './bank-transaction-comment';

package/projects/tt-core/src/lib/models/bank/type-loan.const.ts

@@ -0,0 +1,6 @@
+import { BankAccountTypeEnum } from '../../db/Enums';
+
+export const TYPE_LOAN: BankAccountTypeEnum[] = [
+  BankAccountTypeEnum.MORTGAGE,
+  BankAccountTypeEnum.LOAN,
+];

package/projects/tt-core/src/lib/models/borrowing-expense/borrowing-expense-loan.ts

@@ -0,0 +1,4 @@
+import { BorrowingExpenseLoan as BorrowingExpenseLoanBase } from '../../db/Models/loan/borrowing-expense-loan';
+
+export class BorrowingExpenseLoan extends BorrowingExpenseLoanBase {
+}

package/projects/tt-core/src/lib/models/borrowing-expense/borrowing-expense.ts

@@ -0,0 +1,4 @@
+import { BorrowingExpense as BorrowingExpenseBase } from '../../db/Models/loan/borrowing-expense';
+
+export class BorrowingExpense extends BorrowingExpenseBase {
+}

package/projects/tt-core/src/lib/models/borrowing-expense/index.ts

@@ -0,0 +1,2 @@
+export * from './borrowing-expense-loan';
+export * from './borrowing-expense';

package/projects/tt-core/src/lib/models/budget/budget-metadata.interface.ts

@@ -0,0 +1,11 @@
+import { YoutubeVideosEnum } from '../../db/Enums/youtube-videos.enum';
+import { ChartAccountsCategoryEnum } from '../../db/Enums';
+import { TankTypeEnum } from '../../db/Enums/tank-type.enum';
+
+export class BudgetMetadataInterface {
+  name: string;
+  description: string;
+  thumbnail: string;
+  videoId: YoutubeVideosEnum;
+  categories: Record<TankTypeEnum, ChartAccountsCategoryEnum[]>
+}

package/projects/tt-core/src/lib/models/budget/budget-rule/budget-rule.ts

@@ -0,0 +1,89 @@
+import { BudgetRule as BudgetRuleBase } from '../../../db/Models/budget/budget-rule';
+import { Type, plainToClass } from 'class-transformer';
+import { Budget } from '../budget';
+import { ChartAccounts } from '../../chart-accounts';
+import { BankAccount } from '../../bank';
+import { Property } from '../../property';
+import { SoleBusiness } from '../../sole';
+import { IncomeSource } from '../../income-source';
+import { MoneyCalendarEvent } from '../../fullcalendar';
+import { DailyFrequencyEnum } from '../../../db/Enums';
+import { recurringDates } from '../../../functions/date';
+import { CalendarEventProvider } from '../../../interfaces';
+import { FinancialYear } from '../../financial-year';
+import { MoneyCalendarEventCollection } from '../../../collections';
+
+export class BudgetRule extends BudgetRuleBase implements CalendarEventProvider {
+  @Type(() => Budget)
+  budget: Budget;
+
+  @Type(() => ChartAccounts)
+  chartAccounts: ChartAccounts;
+
+  @Type(() => Date)
+  startDate = new Date();
+
+  @Type(() => Date)
+  endDate?: Date;
+
+  inCalendar = false;
+
+  @Type(() => BankAccount)
+  bankAccount?: BankAccount;
+
+  @Type(() => Property)
+  property: Property;
+
+  @Type(() => SoleBusiness)
+  business: SoleBusiness;
+
+  @Type(() => IncomeSource)
+  incomeSource?: IncomeSource;
+
+  frequency?: DailyFrequencyEnum;
+
+  /**
+   * creates recurring calendar events based on frequency
+   */
+  getCalendarEvents(inCalendar = false): MoneyCalendarEventCollection {
+    if (inCalendar && !this.inCalendar) {
+      return new MoneyCalendarEventCollection([]);
+    }
+
+    const paymentDates = this.frequency
+      ? recurringDates(this.frequency, this.startDate, this.endDate)
+      : [this.startDate];
+
+    return new MoneyCalendarEventCollection(paymentDates.map((date: Date) => plainToClass(
+      MoneyCalendarEvent,
+      {
+        date: date,
+        title: this.chartAccounts.name,
+        extendedProps: {
+          id: this.id,
+          class: BudgetRule.className,
+          amount: this.amount,
+
+          chartAccounts: this.chartAccounts,
+          tankType: this.chartAccounts.tankType,
+          isIncome: this.chartAccounts.isIncome(),
+          isExpense: this.chartAccounts.isExpense(),
+
+          propertyId: this.property?.id,
+          businessId: this.business?.id,
+        }
+      }
+    )));
+  }
+
+  inMonth(month: number): boolean {
+    if (!this.endDate) {
+      return this.startDate.getMonth() === month;
+    }
+
+    // utc to match startDate/endDate time (from server)
+    const date = new Date(Date.UTC(new FinancialYear().getYearByMonth(month), month, this.startDate.getDate()));
+
+    return this.startDate <= date && this.endDate >= date;
+  }
+}

package/projects/tt-core/src/lib/models/budget/budget.ts

@@ -0,0 +1,46 @@
+import { Budget as BudgetBase } from '../../db/Models/budget/budget';
+import { Type } from 'class-transformer';
+import { BudgetRule } from './budget-rule/budget-rule';
+import { User } from '../user';
+import { BudgetRuleCollection } from '../../collections';
+import { EXPENSE_CATEGORY_BY_TYPE, INCOME_CATEGORY_BY_TYPE } from '../../db/Enums';
+import { YoutubeVideosEnum } from '../../db/Enums/youtube-videos.enum';
+import { BudgetMetadataInterface } from './budget-metadata.interface';
+import { FinancialYear } from '../financial-year';
+
+export class Budget extends BudgetBase {
+  @Type(() => BudgetRule)
+  rules: BudgetRule[];
+
+  @Type(() => User)
+  user: User;
+
+  financialYear = new FinancialYear().year;
+
+  static getMetadata(isIncome: boolean): BudgetMetadataInterface {
+    return isIncome ? {
+      name: 'Income',
+      thumbnail: 'income-budget.png',
+      videoId: YoutubeVideosEnum.BUDGET_INCOME,
+      description: 'Keep track of your income by creating budgets based on income categories!',
+      categories: INCOME_CATEGORY_BY_TYPE,
+    } : {
+      name: 'Expense',
+      thumbnail: 'expense-budget.png',
+      videoId: YoutubeVideosEnum.BUDGET_EXPENSE,
+      description: 'Effortlessly monitor your spending by setting budgets for selected expense categories!',
+      categories: EXPENSE_CATEGORY_BY_TYPE,
+    }
+  }
+
+  /**
+   * @TODO TT-4522 remove after release
+   */
+  get rulesCollection(): BudgetRuleCollection {
+    return new BudgetRuleCollection(this.rules);
+  }
+
+  get amount(): number {
+    return this.rulesCollection.sumBy('amount');
+  }
+}

package/projects/tt-core/src/lib/models/budget/index.ts

@@ -0,0 +1,3 @@
+export * from './budget';
+export * from './budget-metadata.interface';
+export * from './budget-rule/budget-rule';

package/projects/tt-core/src/lib/models/chart/chart-data.ts

@@ -0,0 +1,9 @@
+import { ChartSerie } from './chart-serie';
+import { Type } from 'class-transformer';
+
+export class ChartData {
+  name: string;
+
+  @Type(() => ChartSerie)
+  data: ChartSerie[];
+}

package/projects/tt-core/src/lib/models/chart/chart-serie.ts

@@ -0,0 +1,8 @@
+/**
+ * Chart serie class: chart data item
+ * @TODO consider rename to ChartSerieData
+ */
+export class ChartSerie {
+  label: string;
+  value: number;
+}

package/projects/tt-core/src/lib/models/chart-accounts/chart-accounts-categories.const.ts

@@ -0,0 +1,123 @@
+import { ChartAccountsCategoryEnum } from '../../db/Enums';
+
+/**
+ * Grouped chart accounts categories for fast work
+ * @TODO Alex: Clean up and/or remove some groups
+ */
+export const CHART_ACCOUNTS_CATEGORIES: {[key: string]: ChartAccountsCategoryEnum[]} = {
+  income: [
+    ChartAccountsCategoryEnum.PROPERTY_INCOME,
+    ChartAccountsCategoryEnum.WORK_INCOME,
+    ChartAccountsCategoryEnum.OTHER_INCOME,
+    ChartAccountsCategoryEnum.PERSONAL_INCOME,
+    ChartAccountsCategoryEnum.SOLE_INCOME,
+    ChartAccountsCategoryEnum.HOLDING_INCOME,
+  ],
+  expense: [
+    ChartAccountsCategoryEnum.PROPERTY_EXPENSE,
+    ChartAccountsCategoryEnum.PROPERTY_DEPRECIATION,
+    ChartAccountsCategoryEnum.PROPERTY_CAPITAL_WORKS,
+    ChartAccountsCategoryEnum.WORK_DEPRECIATION,
+    ChartAccountsCategoryEnum.WORK_EXPENSE,
+    ChartAccountsCategoryEnum.OTHER_EXPENSE,
+    ChartAccountsCategoryEnum.PERSONAL_EXPENSE,
+    ChartAccountsCategoryEnum.SOLE_EXPENSE,
+    ChartAccountsCategoryEnum.SOLE_DEPRECIATION,
+    ChartAccountsCategoryEnum.HOLDING_EXPENSE,
+  ],
+  property: [
+    ChartAccountsCategoryEnum.PROPERTY_EXPENSE,
+    ChartAccountsCategoryEnum.PROPERTY_DEPRECIATION,
+    ChartAccountsCategoryEnum.PROPERTY_CAPITAL_WORKS,
+    ChartAccountsCategoryEnum.PROPERTY_INCOME
+  ],
+  work: [
+    ChartAccountsCategoryEnum.WORK_EXPENSE,
+    ChartAccountsCategoryEnum.WORK_DEPRECIATION,
+    ChartAccountsCategoryEnum.WORK_INCOME,
+    ChartAccountsCategoryEnum.OTHER_EXPENSE,
+    ChartAccountsCategoryEnum.OTHER_INCOME
+  ],
+  sole: [
+    ChartAccountsCategoryEnum.SOLE_INCOME,
+    ChartAccountsCategoryEnum.SOLE_EXPENSE,
+    ChartAccountsCategoryEnum.SOLE_DEPRECIATION
+  ],
+  holding: [
+    ChartAccountsCategoryEnum.HOLDING_EXPENSE,
+    ChartAccountsCategoryEnum.HOLDING_INCOME,
+
+  ],
+  other: [
+    ChartAccountsCategoryEnum.OTHER_INCOME,
+    ChartAccountsCategoryEnum.OTHER_EXPENSE,
+  ],
+  personal: [
+    ChartAccountsCategoryEnum.PERSONAL_EXPENSE,
+    ChartAccountsCategoryEnum.PERSONAL_INCOME
+  ],
+  propertyExpense: [
+    ChartAccountsCategoryEnum.PROPERTY_EXPENSE
+  ],
+  propertyIncome: [
+    ChartAccountsCategoryEnum.PROPERTY_INCOME
+  ],
+  workExpense: [
+    ChartAccountsCategoryEnum.WORK_EXPENSE,
+    ChartAccountsCategoryEnum.OTHER_EXPENSE
+  ],
+  workIncome: [
+    ChartAccountsCategoryEnum.WORK_INCOME,
+    ChartAccountsCategoryEnum.OTHER_INCOME
+  ],
+  soleExpense: [
+    ChartAccountsCategoryEnum.SOLE_EXPENSE,
+  ],
+  soleIncome: [
+    ChartAccountsCategoryEnum.SOLE_INCOME,
+  ],
+  soleDepreciation: [
+    ChartAccountsCategoryEnum.SOLE_DEPRECIATION,
+  ],
+  holdingExpense: [
+    ChartAccountsCategoryEnum.HOLDING_EXPENSE,
+  ],
+  holdingIncome: [
+    ChartAccountsCategoryEnum.HOLDING_INCOME,
+  ],
+  workTankHeader: [
+    ChartAccountsCategoryEnum.WORK_INCOME,
+    ChartAccountsCategoryEnum.OTHER_INCOME,
+    ChartAccountsCategoryEnum.WORK_EXPENSE,
+    ChartAccountsCategoryEnum.OTHER_EXPENSE
+  ],
+  workTankHeaderIncome: [
+    ChartAccountsCategoryEnum.WORK_INCOME,
+    ChartAccountsCategoryEnum.OTHER_INCOME
+  ],
+  workTankHeaderExpenses: [
+    ChartAccountsCategoryEnum.WORK_EXPENSE,
+    ChartAccountsCategoryEnum.OTHER_EXPENSE
+  ],
+  depreciation: [
+    ChartAccountsCategoryEnum.PROPERTY_DEPRECIATION,
+    ChartAccountsCategoryEnum.WORK_DEPRECIATION,
+    ChartAccountsCategoryEnum.PROPERTY_CAPITAL_WORKS,
+    ChartAccountsCategoryEnum.SOLE_DEPRECIATION,
+  ],
+  all: [
+    ChartAccountsCategoryEnum.PROPERTY_INCOME,
+    ChartAccountsCategoryEnum.WORK_INCOME,
+    ChartAccountsCategoryEnum.OTHER_INCOME,
+    ChartAccountsCategoryEnum.HOLDING_INCOME,
+    ChartAccountsCategoryEnum.PERSONAL_INCOME,
+    ChartAccountsCategoryEnum.PROPERTY_EXPENSE,
+    ChartAccountsCategoryEnum.PROPERTY_DEPRECIATION,
+    ChartAccountsCategoryEnum.PROPERTY_CAPITAL_WORKS,
+    ChartAccountsCategoryEnum.WORK_DEPRECIATION,
+    ChartAccountsCategoryEnum.WORK_EXPENSE,
+    ChartAccountsCategoryEnum.OTHER_EXPENSE,
+    ChartAccountsCategoryEnum.HOLDING_EXPENSE,
+    ChartAccountsCategoryEnum.PERSONAL_EXPENSE
+  ]
+};

package/projects/tt-core/src/lib/models/chart-accounts/chart-accounts-category.e-collection.ts

@@ -0,0 +1,64 @@
+import { ChartAccountsCategoryEnum } from '../../db/Enums';
+
+/**
+ * @TODO Vik: we want to use enums from backend instead of declared types
+ */
+export declare type ChartAccountsType = 'income' | 'expense' | 'depreciation' | 'capital works';
+export declare type ChartAccountsTankType = 'property' | 'work' | 'sole' | 'personal' | 'other';
+
+/**
+ * @TODO Alex/Vik: think and create some new collection type
+ * @TODO Alex: research all constants and make the same structure
+ */
+export class ChartAccountsCategoryECollection {
+  items: ChartAccountsCategoryEnum[];
+
+  constructor(items?: ChartAccountsCategoryEnum[]) {
+    this.items = items || [
+      ChartAccountsCategoryEnum.PROPERTY_INCOME,
+      ChartAccountsCategoryEnum.PROPERTY_EXPENSE,
+      ChartAccountsCategoryEnum.PROPERTY_DEPRECIATION,
+      ChartAccountsCategoryEnum.PROPERTY_CAPITAL_WORKS,
+      ChartAccountsCategoryEnum.WORK_DEPRECIATION,
+      ChartAccountsCategoryEnum.WORK_INCOME,
+      ChartAccountsCategoryEnum.WORK_EXPENSE,
+      ChartAccountsCategoryEnum.OTHER_INCOME,
+      ChartAccountsCategoryEnum.OTHER_EXPENSE,
+      ChartAccountsCategoryEnum.PERSONAL_INCOME,
+      ChartAccountsCategoryEnum.PERSONAL_EXPENSE,
+      ChartAccountsCategoryEnum.SOLE_INCOME,
+      ChartAccountsCategoryEnum.SOLE_EXPENSE,
+      ChartAccountsCategoryEnum.SOLE_DEPRECIATION
+    ];
+  }
+
+  getByType(types: ChartAccountsType | ChartAccountsType[]): ChartAccountsCategoryECollection {
+    if (!Array.isArray(types)) {
+      types = [types];
+    }
+
+    const items: ChartAccountsCategoryEnum[] = [];
+
+    types.forEach((type: ChartAccountsType) => {
+      const filtered: ChartAccountsCategoryEnum[] = this.items.filter((item: ChartAccountsCategoryEnum) => ChartAccountsCategoryEnum[item].includes(type.toUpperCase()));
+      items.push(...filtered);
+    })
+
+    return new ChartAccountsCategoryECollection(items);
+  }
+
+  getByTankType(tankTypes: ChartAccountsTankType | ChartAccountsTankType[]): ChartAccountsCategoryECollection {
+    if (!Array.isArray(tankTypes)) {
+      tankTypes = [tankTypes];
+    }
+
+    const items: ChartAccountsCategoryEnum[] = [];
+
+    tankTypes.forEach((tankType: ChartAccountsTankType) => {
+      const filtered: ChartAccountsCategoryEnum[] = this.items.filter((item: ChartAccountsCategoryEnum) => ChartAccountsCategoryEnum[item].includes(tankType.toUpperCase()))
+      items.push(...filtered);
+    })
+
+    return new ChartAccountsCategoryECollection(items);
+  }
+}

package/projects/tt-core/src/lib/models/chart-accounts/chart-accounts-depreciation.ts

@@ -0,0 +1,16 @@
+import {
+  ChartAccountsDepreciation as ChartAccountsDepreciationBase
+} from '../../db/Models/chart-accounts/chart-accounts-depreciation';
+import { ChartAccounts } from './chart-accounts';
+import { Transform, Type } from 'class-transformer';
+
+export class ChartAccountsDepreciation extends ChartAccountsDepreciationBase {
+  @Type(() => ChartAccounts)
+  chartAccounts: ChartAccounts;
+
+  @Transform(({ value }) => +value)
+  maxClaim: number;
+
+  @Transform(({ value }) => +value)
+  effectiveLife: number;
+}

package/projects/tt-core/src/lib/models/chart-accounts/chart-accounts-heading.ts

@@ -0,0 +1,6 @@
+import { ChartAccountsHeading as ChartAccountsHeadingBase } from '../../db/Models/chart-accounts/chart-accounts-heading';
+import { ChartAccounts } from './chart-accounts';
+
+export class ChartAccountsHeading extends ChartAccountsHeadingBase {
+  chartAccounts: ChartAccounts[];
+}

package/projects/tt-core/src/lib/models/chart-accounts/chart-accounts-meta-field.ts

@@ -0,0 +1,23 @@
+import { ChartAccountsMetaField as ChartAccountsMetaFieldBase } from '../../db/Models/chart-accounts/chart-accounts-meta-field';
+import { ChartAccountsMetaFieldListEnum } from '../../db/Enums';
+
+export class ChartAccountsMetaField extends ChartAccountsMetaFieldBase {
+  /**
+   * Check if meta field id is related to SHARE_PERCENTAGE value
+   */
+  isSharePercentage(): boolean {
+    return this.id === ChartAccountsMetaFieldListEnum.SHARE_PERCENTAGE;
+  }
+
+  isHours(): boolean {
+    return this.id === ChartAccountsMetaFieldListEnum.HOURS;
+  }
+
+  isFranked(): boolean {
+    return this.id === ChartAccountsMetaFieldListEnum.FRANKED;
+  }
+
+  isFrankingCredit(): boolean {
+    return this.id === ChartAccountsMetaFieldListEnum.FRANKING_CREDIT;
+  }
+}

package/projects/tt-core/src/lib/models/chart-accounts/chart-accounts-tax-labels.enum.ts

@@ -0,0 +1,5 @@
+export enum ChartAccountsTaxLabelsEnum {
+  TAX_WITHHELD = 'Tax withheld',
+  TAX_PAID = 'Tax Paid',
+  TAX_DEDUCTED = 'Tax Deducted'
+}

package/projects/tt-core/src/lib/models/chart-accounts/chart-accounts-value.ts

@@ -0,0 +1,4 @@
+import { ChartAccountsValue as ChartAccountsValueBase } from '../../db/Models/chart-accounts/chart-accounts-value';
+
+export class ChartAccountsValue extends ChartAccountsValueBase {
+}