taxtank-core 0.1.1 → 0.1.5

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

@@ -1,151 +0,0 @@
-import { ServiceSubscription as ServiceSubscriptionBase } from '../../db/Models/service-subscription';
-import { ServiceSubscriptionItem } from './service-subscription-item';
-import { SubscriptionTypeEnum } from './subscription-type.enum';
-import { SUBSCRIPTION_TITLE } from './subscription-title.const';
-import { SUBSCRIPTION_DESCRIPTION } from './subscription-description.const';
-import { UserRolesEnum } from '../../db/Enums/user-roles.enum';
-import { Type } from 'class-transformer';
-
-const PROPERTY_INVESTOR_MAX_PROPERTIES = 2;
-
-export class ServiceSubscription extends ServiceSubscriptionBase {
-  @Type(() => Date)
-  startDate: Date;
-
-  @Type(() => Date)
-  endDate: Date;
-
-  @Type(() => ServiceSubscriptionItem)
-  items: ServiceSubscriptionItem[];
-
-  // Number of days after which the trial time will be expired
-  lastTrialDays: number = 4;
-
-  get isTrial(): boolean {
-    return !this.stripeId;
-  }
-
-  get price(): number {
-    return this.items.reduce((sum: number, item: ServiceSubscriptionItem) => sum + item.total, 0);
-  }
-
-  get propertyQuantity(): number {
-    return this.propertyTankItem ? this.propertyTankItem.quantity : 0;
-  }
-
-  /**
-   * get type of subscription
-   */
-  get type(): SubscriptionTypeEnum {
-    const workTankProduct: ServiceSubscriptionItem = this.items.find((item: ServiceSubscriptionItem): boolean => {
-      return item.price.product.isWork();
-    });
-
-    if (!this.workTankItem || !this.isActive) {
-      return SubscriptionTypeEnum.WITHOUT_SUBSCRIPTION;
-    }
-
-    if (this.items.length === 1 && !!workTankProduct) {
-      return SubscriptionTypeEnum.INDIVIDUAL;
-    }
-
-    const propertyTankProduct: ServiceSubscriptionItem = this.items.find((item: ServiceSubscriptionItem): boolean => {
-      return item.price.product.isProperty();
-    });
-
-    if (!!this.propertyTankItem && propertyTankProduct.quantity === PROPERTY_INVESTOR_MAX_PROPERTIES) {
-      return SubscriptionTypeEnum.INVESTOR;
-    }
-
-    return SubscriptionTypeEnum.INVESTOR_PLUS;
-  }
-
-  /**
-   * get title of subscription
-   */
-  get title(): string {
-    return SUBSCRIPTION_TITLE[this.type];
-  }
-
-  /**
-   * get description of subscription
-   */
-  get description(): string {
-    return SUBSCRIPTION_DESCRIPTION[this.type];
-  }
-
-  get workTankItem(): ServiceSubscriptionItem {
-    return this.items.find((item: ServiceSubscriptionItem): boolean => item.price.product.isWork());
-  }
-
-  get propertyTankItem(): ServiceSubscriptionItem {
-    return this.items.find((item: ServiceSubscriptionItem): boolean => item.price.product.isProperty());
-  }
-
-  /**
-   * This check on getIsActive need for firm. Accountant has a endDate, but user has not endDate
-   * and for user we add check for endDate
-   */
-  get isActive(): boolean {
-    return this.endDate ? new Date(this.endDate).getTime() > new Date().getTime() : true;
-  }
-
-  get daysRemain(): number {
-    const daysRemains: number = Math.round(
-      (new Date(this.endDate).getTime() - new Date().getTime()) / (1000 * 3600 * 24)
-    );
-
-    return daysRemains > 0 ? daysRemains : 0;
-  }
-
-  getTitle(): string {
-    return this.isTrial ? 'Trial period' : this.title;
-  }
-
-  /**
-   * Check if subscription is Individual
-   * Subscription is individual when user have only one product and only work tank
-   */
-  isIndividual(): boolean {
-    return this.type === SubscriptionTypeEnum.INDIVIDUAL;
-  }
-
-  /**
-   * Check if subscription is Investor
-   * Subscription is investor when user have property tank product and max count of properties is 2
-   */
-  isInvestor(): boolean {
-    return this.type === SubscriptionTypeEnum.INVESTOR;
-  }
-
-  /**
-   * Check if subscription is Investor Plus
-   * Subscription is investor when user have property tank product and max count of properties more than 2
-   */
-  isInvestorPlus(): boolean {
-    return this.type === SubscriptionTypeEnum.INVESTOR_PLUS;
-  }
-
-  /**
-   * Check if trial expired
-   */
-  isTrialExpired(): boolean {
-    return this.daysRemain && this.daysRemain <= 0;
-  }
-
-  isTrialExpiring(): boolean {
-    return this.daysRemain > 0 && this.daysRemain <= this.lastTrialDays;
-  }
-
-  hasPropertyTank(): boolean {
-    return !!this.items.find((subscriptionItem: ServiceSubscriptionItem) => {
-      return subscriptionItem.price.product.role.includes(UserRolesEnum.PROPERTY_TANK);
-    });
-  }
-
-  hasWorkTank() {
-    return !!this.items.find((subscriptionItem: ServiceSubscriptionItem) => {
-      return subscriptionItem.price.product.role.includes(UserRolesEnum.WORK_TANK);
-    });
-  }
-}

package/src/lib/models/service-subscription/subscription-description.const.ts

@@ -1,8 +0,0 @@
-import { SubscriptionTypeEnum } from './subscription-type.enum';
-
-export const SUBSCRIPTION_DESCRIPTION: {[key: number]: string} = {
-  [SubscriptionTypeEnum.WITHOUT_SUBSCRIPTION]: 'Without subscription',
-  [SubscriptionTypeEnum.INDIVIDUAL]: 'Manage income and expenses via live bank feeds. Keep receipts safe, maximise deductions & minimise tax.',
-  [SubscriptionTypeEnum.INVESTOR]: 'Property made easy with smart tax tools and real-time information to help control how much tax you pay.',
-  [SubscriptionTypeEnum.INVESTOR_PLUS]: 'Add your whole portfolio, including investment properties, home and properties in trusts. For 3+ properties an extra $6 will be charged per property.'
-};

package/src/lib/models/service-subscription/subscription-title.const.ts

@@ -1,8 +0,0 @@
-import { SubscriptionTypeEnum } from './subscription-type.enum';
-
-export const SUBSCRIPTION_TITLE: {[key: number]: string} = {
-  [SubscriptionTypeEnum.WITHOUT_SUBSCRIPTION]: 'Without subscription',
-  [SubscriptionTypeEnum.INDIVIDUAL]: 'Individual',
-  [SubscriptionTypeEnum.INVESTOR]: 'Investor',
-  [SubscriptionTypeEnum.INVESTOR_PLUS]: 'Investor plus'
-};

package/src/lib/models/service-subscription/subscription-type.enum.ts

@@ -1,6 +0,0 @@
-export enum SubscriptionTypeEnum {
-  WITHOUT_SUBSCRIPTION = 0,
-  INDIVIDUAL = 1,
-  INVESTOR = 2,
-  INVESTOR_PLUS = 3
-}

package/src/lib/models/tax-review/tax-review.ts

@@ -1,96 +0,0 @@
-import { TaxReview as TaxReviewBase } from '../../db/Models/tax-review';
-import { TaxReviewStatusEnum } from '../../db/Enums/tax-review-status.enum';
-import { User } from '../user/user';
-import { Type } from 'class-transformer';
-
-export class TaxReview extends TaxReviewBase {
-  @Type(() => User)
-  client: User;
-
-  @Type(() => User)
-  employee: User;
-  status: TaxReviewStatusEnum;
-
-  /**
-   * if tax review status is 'Cancelled'
-   */
-  isCancelled(): boolean {
-    return this.status === TaxReviewStatusEnum.CANCELLED;
-  }
-
-  /**
-   * if tax review status is 'New'
-   */
-  isNew(): boolean {
-    return this.status === TaxReviewStatusEnum.NEW;
-  }
-
-  /**
-   * if tax review status is 'In progress'
-   */
-  isInProgress(): boolean {
-    return this.status === TaxReviewStatusEnum.IN_PROGRESS;
-  }
-
-  /**
-   * if tax review status is 'Waiting for client'
-   */
-  isWaitingForClient(): boolean {
-    return this.status === TaxReviewStatusEnum.WAITING_FOR_CLIENT;
-  }
-
-  /**
-   * if tax review status is 'Waiting for approval'
-   */
-  isWaitingForApproval(): boolean {
-    return this.status === TaxReviewStatusEnum.WAITING_FOR_APPROVAL;
-  }
-
-  /**
-   * if tax review status is 'Approved'
-   */
-  isApproved(): boolean {
-    return this.status === TaxReviewStatusEnum.APPROVED;
-  }
-
-  /**
-   * if tax review status is 'Completed'
-   */
-  isCompleted(): boolean {
-    return this.status === TaxReviewStatusEnum.COMPLETED;
-  }
-
-  /**
-   * if tax review status is 'Sent'
-   */
-  isSent(): boolean {
-    return this.status === TaxReviewStatusEnum.SENT;
-  }
-
-  /**
-   * if tax review status is 'Amend'
-   */
-  isAmend(): boolean {
-    return this.status === TaxReviewStatusEnum.AMEND;
-  }
-
-  /**
-   * If tax review is inactive
-   */
-  isInactive(): boolean {
-    return this.isCancelled() || this.isCompleted();
-  }
-
-  /**
-   * If tax review is active
-   */
-  isActive(): boolean {
-    return this.isNew() ||
-      this.isInProgress() ||
-      this.isWaitingForClient() ||
-      this.isWaitingForApproval() ||
-      this.isApproved() ||
-      this.isSent() ||
-      this.isAmend();
-  }
-}

package/src/lib/models/tax-summary/tax-return-category-item-details.ts

@@ -1,14 +0,0 @@
-import { TaxReturnCategorySectionEnum } from '../../db/Enums/tax-return-category-section.enum';
-
-/**
- * Used in tax summary reports to show specific details relating to an amount in the report.
- * See structure in TaxReturnCategoryItem class.
- * Example an amount of $550 for property income could be comprised of 2 different property amounts of $300 and $250.
- * This is useful in providing drill-down information for the tax summary report.
- */
-export class TaxReturnCategoryItemDetails {
-  amount: number;
-  name: string;
-  type: number;
-  section: TaxReturnCategorySectionEnum;
-}

package/src/lib/models/tax-summary/tax-return-category-item.ts

@@ -1,22 +0,0 @@
-import { TaxReturnCategory } from '../../db/Models/tax-return-category';
-import { TaxReturnCategoryItemDetails } from './tax-return-category-item-details';
-
-/**
- * Used in tax summary reports to show amounts relating to a tax return category entity and details of what this
- * amount is comprised of. Example here shows an amount of $951.96 and also details of what this amount is comprised of:
- */
-export class TaxReturnCategoryItem {
-  amount: number;
-  details: TaxReturnCategoryItemDetails[];
-  items: TaxReturnCategoryItem[];
-  taxReturnCategory: TaxReturnCategory;
-  taxWithheld: number;
-
-  /**
-   * Get amount for one income source
-   * @param name Name of income source for filter
-   */
-  getAmountByIncomeSourceName(name: string): number {
-    return this.details.find((detail: TaxReturnCategoryItemDetails): boolean => detail.name === name)?.amount || 0;
-  }
-}

package/src/lib/models/tax-summary/tax-summary-section.ts

@@ -1,32 +0,0 @@
-import { TaxSummarySectionEnum } from '../../db/Enums/tax-summary-section.enum';
-import { TaxReturnCategoryItem } from './tax-return-category-item';
-import { TaxReturnCategoryItemCollection } from '../../collections/tax-return-category-item.collection';
-import { Transform, Type } from 'class-transformer';
-
-/**
- * Base class for each sections of Tax Summary report, contains common properties/methods
- * See also TaxSummary model
- */
-export class TaxSummarySection {
-  section: TaxSummarySectionEnum;
-  netAmount: number;
-
-  @Type(() => TaxReturnCategoryItem)
-  @Transform(({value}) => new TaxReturnCategoryItemCollection(value))
-  items: TaxReturnCategoryItemCollection;
-
-  // id that will be added as HTML Id
-  @Transform(({obj}) => {
-    switch (obj.section) {
-      case TaxSummarySectionEnum.WORK_TANK:
-        return 'taxSummaryWorkTank';
-      case TaxSummarySectionEnum.PROPERTY_TANK:
-        return 'taxSummaryPropertyTank';
-      case TaxSummarySectionEnum.OTHER_INCOME:
-        return 'taxSummaryOtherIncome';
-      default:
-        return 'taxSummaryTotal';
-    }
-  })
-  id?: string;
-}

package/src/lib/models/tax-summary/tax-summary-type.enum.ts

@@ -1,7 +0,0 @@
-/**
- * Enum for tax summary types
- */
-export enum TaxSummaryTypeEnum {
-  ACTUALS = 'actuals',
-  FORECASTS = 'forecasts'
-}

package/src/lib/models/tax-summary/tax-summary.ts

@@ -1,79 +0,0 @@
-import { TaxReturnCategorySectionEnum } from '../../db/Enums/tax-return-category-section.enum';
-import { TaxSummarySection } from './tax-summary-section';
-import { Type } from 'class-transformer';
-
-/**
- * @Todo refactor with base model when it will be provided
- * Tax summary report structure
- */
-export class TaxSummary {
-  @Type(() => TaxSummarySection)
-  work: TaxSummarySection;
-
-  @Type(() => TaxSummarySection)
-  property: TaxSummarySection;
-
-  @Type(() => TaxSummarySection)
-  otherIncome: TaxSummarySection;
-
-  @Type(() => TaxSummarySection)
-  summary: TaxSummarySection;
-
-  projectedTaxPosition: number;
-
-  get sections(): TaxSummarySection[] {
-    return [this.work, this.property, this.otherIncome, this.summary];
-  }
-
-  get taxPercent(): number {
-    return this.summary.items.grossTaxPayable / this.summary.netAmount;
-  }
-
-  /**
-   * Work Net Cash = Income - tax withheld - expenses - interest
-   * https://taxtank.atlassian.net/wiki/spaces/TAXTANK/pages/217677990/Dashboard+Main
-   */
-  get workNetCash(): number {
-    return this.workNetTotal - Math.abs(this.summary.items.getTaxWithheld(TaxReturnCategorySectionEnum.WORK_TANK));
-  }
-
-  /**
-   * Work Net Total = Income - expenses - interest
-   * https://taxtank.atlassian.net/wiki/spaces/TAXTANK/pages/217677990/Dashboard+Main
-   */
-  get workNetTotal(): number {
-    return this.work.items.salary - Math.abs(this.work.items.workExpenses);
-  }
-
-  /**
-   * Property Net Cash (Cash Position) = Rental Income - expenses - interest
-   * https://taxtank.atlassian.net/wiki/spaces/TAXTANK/pages/217677990/Dashboard+Main
-   */
-  get propertyNetCash(): number {
-    return this.property.items.rentalIncome - Math.abs(this.property.items.rentalDeductions) - Math.abs(this.property.items.interestDeductions);
-  }
-
-  /**
-   * Property Net Total (Tax Position) = Rental Income - expenses - interest - depreciation
-   * https://taxtank.atlassian.net/wiki/spaces/TAXTANK/pages/217677990/Dashboard+Main
-   */
-  get propertyNetTotal(): number {
-    return this.propertyNetCash - Math.abs(this.property.items.propertyDepreciations);
-  }
-
-  /**
-   * Other Net Cash = gross income – expenses – tax withheld - tax instalments
-   * https://taxtank.atlassian.net/wiki/spaces/TAXTANK/pages/217677990/Dashboard+Main
-   */
-  get otherNetCash(): number {
-    return this.otherIncome.items.otherIncome - Math.abs(this.otherIncome.items.otherDeductions) - Math.abs(this.summary.items.getTaxWithheld(TaxReturnCategorySectionEnum.OTHER_INCOME)) - Math.abs(this.summary.items.taxInstalments);
-  }
-
-  /**
-   * Other Net Total = Gross income - expenses + tax offsets + tax instalments + franking credits
-   * https://taxtank.atlassian.net/wiki/spaces/TAXTANK/pages/217677990/Dashboard+Main
-   */
-  get otherNetTotal(): number {
-    return this.otherIncome.items.otherIncome - Math.abs(this.otherIncome.items.otherDeductions) + Math.abs(this.summary.items.taxOffsets) + Math.abs(this.summary.items.taxInstalments) + Math.abs(this.summary.items.frankingCredits);
-  }
-}

package/src/lib/models/transaction/income-amount-type.enum.ts

@@ -1,7 +0,0 @@
-/**
- * Enum with income amount types (Net or Gross)
- */
-export enum IncomeAmountTypeEnum {
-  NET,
-  GROSS
-}

package/src/lib/models/transaction/transaction-allocation.ts

@@ -1,20 +0,0 @@
-import { TransactionAllocation as TransactionAllocationBase } from '../../db/Models/transaction-allocation';
-import { BankTransaction } from '../bank/bank-transaction';
-import { Transaction } from './transaction';
-import { plainToClass, Type } from 'class-transformer';
-
-export class TransactionAllocation extends TransactionAllocationBase {
-  @Type(() => BankTransaction)
-  bankTransaction: BankTransaction;
-
-  @Type(() => Transaction)
-  transaction: Transaction;
-
-  /**
-   * Create a new instance of transaction allocation
-   * transaction could be empty since we can POST allocation inside a new transaction
-   */
-  static create(amount: number, bankTransaction: BankTransaction, transaction?: Transaction): TransactionAllocation {
-    return plainToClass(TransactionAllocation, {amount, transaction, bankTransaction});
-  }
-}

package/src/lib/models/transaction/transaction-metadata.ts

@@ -1,8 +0,0 @@
-import { TransactionMetadata as TransactionMetadataBase } from '../../db/Models/transaction-metadata';
-import { Type } from 'class-transformer';
-import { ChartAccountsMetadata } from '../chart-accounts/chart-accounts-metadata';
-
-export class TransactionMetadata extends TransactionMetadataBase {
-  @Type(() => ChartAccountsMetadata)
-  metadata: ChartAccountsMetadata;
-}

package/src/lib/models/transaction/transaction-receipt.ts

@@ -1,9 +0,0 @@
-import { TransactionReceipt as TransactionReceiptBase } from '../../db/Models/transaction-receipt';
-import { IAsset } from '../../interfaces/asset.interface';
-import { AssetTypeEnum } from '../../interfaces/asset-type.enum';
-import { AssetEntityTypeEnum } from '../../interfaces/asset-entity-type.enum';
-
-export class TransactionReceipt extends TransactionReceiptBase implements IAsset {
-  type: AssetTypeEnum = AssetTypeEnum.RECEIPTS;
-  entityType: AssetEntityTypeEnum = AssetEntityTypeEnum.TRANSACTIONS;
-}