taxtank-core 0.4.0 → 0.5.2

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

@@ -1,52 +1,52 @@
-import { TaxReview as TaxReviewBase } from '../../db/Models/tax-review';
-import { TaxReviewStatusEnum } from '../../db/Enums/tax-review-status.enum';
-import { User } from '../user/user';
-export declare class TaxReview extends TaxReviewBase {
-    client: User;
-    employee: User;
-    status: TaxReviewStatusEnum;
-    /**
-     * if tax review status is 'Cancelled'
-     */
-    isCancelled(): boolean;
-    /**
-     * if tax review status is 'New'
-     */
-    isNew(): boolean;
-    /**
-     * if tax review status is 'In progress'
-     */
-    isInProgress(): boolean;
-    /**
-     * if tax review status is 'Waiting for client'
-     */
-    isWaitingForClient(): boolean;
-    /**
-     * if tax review status is 'Waiting for approval'
-     */
-    isWaitingForApproval(): boolean;
-    /**
-     * if tax review status is 'Approved'
-     */
-    isApproved(): boolean;
-    /**
-     * if tax review status is 'Completed'
-     */
-    isCompleted(): boolean;
-    /**
-     * if tax review status is 'Sent'
-     */
-    isSent(): boolean;
-    /**
-     * if tax review status is 'Amend'
-     */
-    isAmend(): boolean;
-    /**
-     * If tax review is inactive
-     */
-    isInactive(): boolean;
-    /**
-     * If tax review is active
-     */
-    isActive(): boolean;
-}
+import { TaxReview as TaxReviewBase } from '../../db/Models/tax-review';
+import { TaxReviewStatusEnum } from '../../db/Enums/tax-review-status.enum';
+import { User } from '../user/user';
+export declare class TaxReview extends TaxReviewBase {
+    client: User;
+    employee: User;
+    status: TaxReviewStatusEnum;
+    /**
+     * if tax review status is 'Cancelled'
+     */
+    isCancelled(): boolean;
+    /**
+     * if tax review status is 'New'
+     */
+    isNew(): boolean;
+    /**
+     * if tax review status is 'In progress'
+     */
+    isInProgress(): boolean;
+    /**
+     * if tax review status is 'Waiting for client'
+     */
+    isWaitingForClient(): boolean;
+    /**
+     * if tax review status is 'Waiting for approval'
+     */
+    isWaitingForApproval(): boolean;
+    /**
+     * if tax review status is 'Approved'
+     */
+    isApproved(): boolean;
+    /**
+     * if tax review status is 'Completed'
+     */
+    isCompleted(): boolean;
+    /**
+     * if tax review status is 'Sent'
+     */
+    isSent(): boolean;
+    /**
+     * if tax review status is 'Amend'
+     */
+    isAmend(): boolean;
+    /**
+     * If tax review is inactive
+     */
+    isInactive(): boolean;
+    /**
+     * If tax review is active
+     */
+    isActive(): boolean;
+}

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

@@ -1,13 +1,13 @@
-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 declare class TaxReturnCategoryItemDetails {
-    amount: number;
-    name: string;
-    type: number;
-    section: TaxReturnCategorySectionEnum;
-}
+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 declare class TaxReturnCategoryItemDetails {
+    amount: number;
+    name: string;
+    type: number;
+    section: TaxReturnCategorySectionEnum;
+}

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

@@ -1,18 +1,18 @@
-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 declare 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;
-}
+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 declare 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;
+}

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

@@ -1,12 +1,12 @@
-import { TaxSummarySectionEnum } from '../../db/Enums/tax-summary-section.enum';
-import { TaxReturnCategoryItemCollection } from '../../collections/tax-return-category-item.collection';
-/**
- * Base class for each sections of Tax Summary report, contains common properties/methods
- * See also TaxSummary model
- */
-export declare class TaxSummarySection {
-    section: TaxSummarySectionEnum;
-    netAmount: number;
-    items: TaxReturnCategoryItemCollection;
-    id?: string;
-}
+import { TaxSummarySectionEnum } from '../../db/Enums/tax-summary-section.enum';
+import { TaxReturnCategoryItemCollection } from '../../collections/tax-return-category-item.collection';
+/**
+ * Base class for each sections of Tax Summary report, contains common properties/methods
+ * See also TaxSummary model
+ */
+export declare class TaxSummarySection {
+    section: TaxSummarySectionEnum;
+    netAmount: number;
+    items: TaxReturnCategoryItemCollection;
+    id?: string;
+}

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

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

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

@@ -1,44 +1,44 @@
-import { TaxSummarySection } from './tax-summary-section';
-/**
- * @Todo refactor with base model when it will be provided
- * Tax summary report structure
- */
-export declare class TaxSummary {
-    work: TaxSummarySection;
-    property: TaxSummarySection;
-    otherIncome: TaxSummarySection;
-    summary: TaxSummarySection;
-    projectedTaxPosition: number;
-    get sections(): TaxSummarySection[];
-    get taxPercent(): number;
-    /**
-     * Work Net Cash = Income - tax withheld - expenses - interest
-     * https://taxtank.atlassian.net/wiki/spaces/TAXTANK/pages/217677990/Dashboard+Main
-     */
-    get workNetCash(): number;
-    /**
-     * Work Net Total = Income - expenses - interest
-     * https://taxtank.atlassian.net/wiki/spaces/TAXTANK/pages/217677990/Dashboard+Main
-     */
-    get workNetTotal(): number;
-    /**
-     * Property Net Cash (Cash Position) = Rental Income - expenses - interest
-     * https://taxtank.atlassian.net/wiki/spaces/TAXTANK/pages/217677990/Dashboard+Main
-     */
-    get propertyNetCash(): number;
-    /**
-     * Property Net Total (Tax Position) = Rental Income - expenses - interest - depreciation
-     * https://taxtank.atlassian.net/wiki/spaces/TAXTANK/pages/217677990/Dashboard+Main
-     */
-    get propertyNetTotal(): number;
-    /**
-     * Other Net Cash = gross income – expenses – tax withheld - tax instalments
-     * https://taxtank.atlassian.net/wiki/spaces/TAXTANK/pages/217677990/Dashboard+Main
-     */
-    get otherNetCash(): number;
-    /**
-     * 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;
-}
+import { TaxSummarySection } from './tax-summary-section';
+/**
+ * @Todo refactor with base model when it will be provided
+ * Tax summary report structure
+ */
+export declare class TaxSummary {
+    work: TaxSummarySection;
+    property: TaxSummarySection;
+    otherIncome: TaxSummarySection;
+    summary: TaxSummarySection;
+    projectedTaxPosition: number;
+    get sections(): TaxSummarySection[];
+    get taxPercent(): number;
+    /**
+     * Work Net Cash = Income - tax withheld - expenses - interest
+     * https://taxtank.atlassian.net/wiki/spaces/TAXTANK/pages/217677990/Dashboard+Main
+     */
+    get workNetCash(): number;
+    /**
+     * Work Net Total = Income - expenses - interest
+     * https://taxtank.atlassian.net/wiki/spaces/TAXTANK/pages/217677990/Dashboard+Main
+     */
+    get workNetTotal(): number;
+    /**
+     * Property Net Cash (Cash Position) = Rental Income - expenses - interest
+     * https://taxtank.atlassian.net/wiki/spaces/TAXTANK/pages/217677990/Dashboard+Main
+     */
+    get propertyNetCash(): number;
+    /**
+     * Property Net Total (Tax Position) = Rental Income - expenses - interest - depreciation
+     * https://taxtank.atlassian.net/wiki/spaces/TAXTANK/pages/217677990/Dashboard+Main
+     */
+    get propertyNetTotal(): number;
+    /**
+     * Other Net Cash = gross income – expenses – tax withheld - tax instalments
+     * https://taxtank.atlassian.net/wiki/spaces/TAXTANK/pages/217677990/Dashboard+Main
+     */
+    get otherNetCash(): number;
+    /**
+     * 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;
+}

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

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

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

@@ -1,12 +1,12 @@
-import { TransactionAllocation as TransactionAllocationBase } from '../../db/Models/transaction-allocation';
-import { BankTransaction } from '../bank/bank-transaction';
-import { Transaction } from './transaction';
-export declare class TransactionAllocation extends TransactionAllocationBase {
-    bankTransaction: BankTransaction;
-    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;
-}
+import { TransactionAllocation as TransactionAllocationBase } from '../../db/Models/transaction-allocation';
+import { BankTransaction } from '../bank/bank-transaction';
+import { Transaction } from './transaction';
+export declare class TransactionAllocation extends TransactionAllocationBase {
+    bankTransaction: BankTransaction;
+    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;
+}

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

@@ -1,5 +1,5 @@
-import { TransactionMetadata as TransactionMetadataBase } from '../../db/Models/transaction-metadata';
-import { ChartAccountsMetadata } from '../chart-accounts/chart-accounts-metadata';
-export declare class TransactionMetadata extends TransactionMetadataBase {
-    metadata: ChartAccountsMetadata;
-}
+import { TransactionMetadata as TransactionMetadataBase } from '../../db/Models/transaction-metadata';
+import { ChartAccountsMetadata } from '../chart-accounts/chart-accounts-metadata';
+export declare class TransactionMetadata extends TransactionMetadataBase {
+    metadata: ChartAccountsMetadata;
+}

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

@@ -1,8 +1,8 @@
-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 declare class TransactionReceipt extends TransactionReceiptBase implements IAsset {
-    type: AssetTypeEnum;
-    entityType: AssetEntityTypeEnum;
-}
+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 declare class TransactionReceipt extends TransactionReceiptBase implements IAsset {
+    type: AssetTypeEnum;
+    entityType: AssetEntityTypeEnum;
+}

package/lib/models/transaction/transaction.d.ts

@@ -1,99 +1,99 @@
-import { Transaction as TransactionBase } from '../../db/Models/transaction';
-import { ChartAccountsCategoryEnum } from '../../db/Enums/chart-accounts-category.enum';
-import { TransactionOperationEnum } from '../../db/Enums/transaction-operation.enum';
-import { Property } from '../property/property';
-import { TransactionReceipt } from './transaction-receipt';
-import { ChartAccounts } from '../chart-accounts/chart-accounts';
-import { IncomeSource } from '../income-source/income-source';
-import { TransactionMetadata } from './transaction-metadata';
-import { Loan } from '../loan/loan';
-import { TransactionAllocation } from './transaction-allocation';
-import { IReceipt } from '../../interfaces/receipt.interface';
-import { ITank } from '../../interfaces/tank.interface';
-import { TransactionAllocationCollection } from '../../collections/transaction-allocation.collection';
-import { Depreciation } from '../depreciation/depreciation';
-export declare class Transaction extends TransactionBase implements IReceipt, ITank {
-    transactions: Transaction[];
-    property: Property;
-    receipt: TransactionReceipt;
-    chartAccounts: ChartAccounts;
-    incomeSource: IncomeSource;
-    metadata: TransactionMetadata[];
-    transfer: Transaction;
-    loan: Loan;
-    date: Date;
-    allocations: TransactionAllocation[];
-    file: File;
-    tax: number;
-    operation: TransactionOperationEnum;
-    allocatedAmount: number;
-    unallocatedAmount: number;
-    isSelected: boolean;
-    claimPercent: number;
-    amount: number;
-    isDebit(): boolean;
-    isCredit(): boolean;
-    isIncome(): boolean;
-    isExpense(): boolean;
-    isPersonal(): boolean;
-    get chartAccountsCategories(): ChartAccountsCategoryEnum[];
-    /**
-     * Check if transaction has 'Klms travelled for work' chart accounts category
-     */
-    get isKlmsChartAccountsCategory(): boolean;
-    /**
-     * Get transaction date
-     */
-    getDate(): Date;
-    /**
-     * Check if transaction type is vehicle
-     */
-    isVehicleTransaction(): boolean;
-    /**
-     * Get net amount (clean amount after all deductions)
-     */
-    getNetAmount(): number;
-    /**
-     * Get gross income amount
-     */
-    getGrossIncome(): number;
-    get taxFreeComponent(): number;
-    get frankingCredit(): number;
-    get eligibleForReduction(): number;
-    get untaxedElement(): number;
-    /**
-     * Check if transaction reconcile operation if TRANSFER
-     * @TODO bad usage of get (and all is* methods), getter should sound like a noun
-     */
-    get isTransfer(): boolean;
-    get debit(): number;
-    get credit(): number;
-    /**
-     * Get value of transaction metadata field
-     * @param field for which value should be returned
-     */
-    private getMetadataFieldValue;
-    /**
-     * Returns Net or Gross income amount based on provided income type
-     * @param incomeType by which amount should be returned
-     */
-    private getIncomeAmountByType;
-    isInterest(): boolean;
-    isCash(): boolean;
-    /**
-     * Create Depreciation instance based on Transaction
-     */
-    toDepreciation(): Depreciation;
-    /**
-     * Check if transaction is completely allocated
-     */
-    isAllocated(allocations: TransactionAllocationCollection): boolean;
-    /**
-     * Get transaction allocated amount
-     */
-    getAllocatedAmount(allocations: TransactionAllocationCollection): number;
-    /**
-     * Get transaction unallocated amount
-     */
-    getUnallocatedAmount(allocations: TransactionAllocationCollection): number;
-}
+import { Transaction as TransactionBase } from '../../db/Models/transaction';
+import { ChartAccountsCategoryEnum } from '../../db/Enums/chart-accounts-category.enum';
+import { TransactionOperationEnum } from '../../db/Enums/transaction-operation.enum';
+import { Property } from '../property/property';
+import { TransactionReceipt } from './transaction-receipt';
+import { ChartAccounts } from '../chart-accounts/chart-accounts';
+import { IncomeSource } from '../income-source/income-source';
+import { TransactionMetadata } from './transaction-metadata';
+import { Loan } from '../loan/loan';
+import { TransactionAllocation } from './transaction-allocation';
+import { IReceipt } from '../../interfaces/receipt.interface';
+import { ITank } from '../../interfaces/tank.interface';
+import { TransactionAllocationCollection } from '../../collections/transaction-allocation.collection';
+import { Depreciation } from '../depreciation/depreciation';
+export declare class Transaction extends TransactionBase implements IReceipt, ITank {
+    transactions: Transaction[];
+    property: Property;
+    receipt: TransactionReceipt;
+    chartAccounts: ChartAccounts;
+    incomeSource: IncomeSource;
+    metadata: TransactionMetadata[];
+    transfer: Transaction;
+    loan: Loan;
+    date: Date;
+    allocations: TransactionAllocation[];
+    file: File;
+    tax: number;
+    operation: TransactionOperationEnum;
+    allocatedAmount: number;
+    unallocatedAmount: number;
+    isSelected: boolean;
+    claimPercent: number;
+    amount: number;
+    isDebit(): boolean;
+    isCredit(): boolean;
+    isIncome(): boolean;
+    isExpense(): boolean;
+    isPersonal(): boolean;
+    get chartAccountsCategories(): ChartAccountsCategoryEnum[];
+    /**
+     * Check if transaction has 'Klms travelled for work' chart accounts category
+     */
+    get isKlmsChartAccountsCategory(): boolean;
+    /**
+     * Get transaction date
+     */
+    getDate(): Date;
+    /**
+     * Check if transaction type is vehicle
+     */
+    isVehicleTransaction(): boolean;
+    /**
+     * Get net amount (clean amount after all deductions)
+     */
+    getNetAmount(): number;
+    /**
+     * Get gross income amount
+     */
+    getGrossIncome(): number;
+    get taxFreeComponent(): number;
+    get frankingCredit(): number;
+    get eligibleForReduction(): number;
+    get untaxedElement(): number;
+    /**
+     * Check if transaction reconcile operation if TRANSFER
+     * @TODO bad usage of get (and all is* methods), getter should sound like a noun
+     */
+    get isTransfer(): boolean;
+    get debit(): number;
+    get credit(): number;
+    /**
+     * Get value of transaction metadata field
+     * @param field for which value should be returned
+     */
+    private getMetadataFieldValue;
+    /**
+     * Returns Net or Gross income amount based on provided income type
+     * @param incomeType by which amount should be returned
+     */
+    private getIncomeAmountByType;
+    isInterest(): boolean;
+    isCash(): boolean;
+    /**
+     * Create Depreciation instance based on Transaction
+     */
+    toDepreciation(): Depreciation;
+    /**
+     * Check if transaction is completely allocated
+     */
+    isAllocated(allocations: TransactionAllocationCollection): boolean;
+    /**
+     * Get transaction allocated amount
+     */
+    getAllocatedAmount(allocations: TransactionAllocationCollection): number;
+    /**
+     * Get transaction unallocated amount
+     */
+    getUnallocatedAmount(allocations: TransactionAllocationCollection): number;
+}

package/lib/models/user/my-account-history-initiated-by.enum.d.ts

@@ -1,4 +1,4 @@
-export declare enum MyAccountHistoryInitiatedByEnum {
-    OWNER = 0,
-    ACCOUNTANT = 1
-}
+export declare enum MyAccountHistoryInitiatedByEnum {
+    OWNER = 0,
+    ACCOUNTANT = 1
+}

package/lib/models/user/my-account-history-status.enum.d.ts

@@ -1,4 +1,4 @@
-export declare enum MyAccountHistoryStatusEnum {
-    SUCCESS = 0,
-    ERROR = 1
-}
+export declare enum MyAccountHistoryStatusEnum {
+    SUCCESS = 0,
+    ERROR = 1
+}

package/lib/models/user/my-account-history-type.enum.d.ts

@@ -1,5 +1,5 @@
-export declare enum MyAccountHistoryTypeEnum {
-    REVIEW = 0,
-    UPGRADE_PLAN = 1,
-    UPLOAD_DOCUMENT = 2
-}
+export declare enum MyAccountHistoryTypeEnum {
+    REVIEW = 0,
+    UPGRADE_PLAN = 1,
+    UPLOAD_DOCUMENT = 2
+}

package/lib/models/user/my-account-history.d.ts

@@ -1,11 +1,11 @@
-import { MyAccountHistoryTypeEnum } from './my-account-history-type.enum';
-import { MyAccountHistoryInitiatedByEnum } from './my-account-history-initiated-by.enum';
-import { MyAccountHistoryStatusEnum } from './my-account-history-status.enum';
-export declare class MyAccountHistory {
-    id: number;
-    name: string;
-    type: MyAccountHistoryTypeEnum;
-    initiatedBy: MyAccountHistoryInitiatedByEnum;
-    date: Date;
-    status: MyAccountHistoryStatusEnum;
-}
+import { MyAccountHistoryTypeEnum } from './my-account-history-type.enum';
+import { MyAccountHistoryInitiatedByEnum } from './my-account-history-initiated-by.enum';
+import { MyAccountHistoryStatusEnum } from './my-account-history-status.enum';
+export declare class MyAccountHistory {
+    id: number;
+    name: string;
+    type: MyAccountHistoryTypeEnum;
+    initiatedBy: MyAccountHistoryInitiatedByEnum;
+    date: Date;
+    status: MyAccountHistoryStatusEnum;
+}

package/lib/models/user/occupation.d.ts

@@ -1,3 +1,3 @@
-import { Occupation as OccupationBase } from '../../db/Models/occupation';
-export declare class Occupation extends OccupationBase {
-}
+import { Occupation as OccupationBase } from '../../db/Models/occupation';
+export declare class Occupation extends OccupationBase {
+}

package/lib/models/user/user-roles.const.d.ts

@@ -1,4 +1,4 @@
-import { UserRolesEnum } from '../../db/Enums/user-roles.enum';
-export declare const USER_ROLES: {
-    [key: string]: UserRolesEnum[];
-};
+import { UserRolesEnum } from '../../db/Enums/user-roles.enum';
+export declare const USER_ROLES: {
+    [key: string]: UserRolesEnum[];
+};