taxtank-core 2.0.6 → 2.0.8

package/src/lib/models/badge/badge-color.enum.d.ts

@@ -1,6 +0,0 @@
-export declare enum BadgeColorEnum {
-    DEFAULT = "default",
-    GREEN = "green",
-    GOLD = "gold",
-    GRAY = "gray"
-}

package/src/lib/models/badge/badge.d.ts

@@ -1,10 +0,0 @@
-import { BadgeColorEnum } from './badge-color.enum';
-import { AbstractModel } from '../../db/Models/abstract-model';
-/**
- * Class for UI element badge
- */
-export declare class Badge extends AbstractModel {
-    color: BadgeColorEnum;
-    text: string;
-    constructor(text: string, color?: BadgeColorEnum);
-}

package/src/lib/models/bank/allocation-group.d.ts

@@ -1,38 +0,0 @@
-import { SoleInvoice } from '../sole';
-import { Transaction } from '../transaction';
-import { AbstractModel } from '../../db/Models';
-import { TransactionOperationEnum } from '../../db/Enums/transaction-operation.enum';
-import { TankTypeEnum } from '../../db/Enums/tank-type.enum';
-import { BankTransactionCollection, TransactionAllocationCollection, TransactionCollection } from '../../collections';
-/**
- * User knows nothing about invoiceItem transaction/allocation, it's encapsulated. That's why we need an extra model to hide technical complication from user
- * @TODO Alex: we use category and invoice number in the same place: think about common name and unite 2 fields in 1
- * @TODO Alex: think: move check operation methods to some common class (with transaction)
- * @TODO Alex: isTransactionChangeable method's name is breaking abstraction
- */
-export declare class AllocationGroup extends AbstractModel {
-    operation: TransactionOperationEnum;
-    date: Date;
-    amount: number;
-    description: string;
-    category?: string;
-    tankType: TankTypeEnum;
-    childTransactions?: TransactionCollection;
-    invoiceNumber?: number;
-    allocations: TransactionAllocationCollection;
-    bankTransactions: BankTransactionCollection;
-    static fromInvoice(invoice: SoleInvoice, bankTransactions: BankTransactionCollection, allocations: TransactionAllocationCollection): AllocationGroup;
-    static fromTransaction(transaction: Transaction, bankTransactions: BankTransactionCollection, allocations: TransactionAllocationCollection): AllocationGroup;
-    isFindMatch(): boolean;
-    /**
-     * group can count as basiq if all transactions are basiq
-     */
-    isBasiq(): boolean;
-    isTransfer(): boolean;
-    isAllocate(): boolean;
-    /**
-     * user can edit/delete (via redo all) transaction only for allocate and find and match operations
-     */
-    isTransactionChangeable(): boolean;
-    get isAutoAllocated(): boolean;
-}

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

@@ -1,17 +0,0 @@
-import { BankAccount } from './bank-account';
-import { IChartData } from '../../interfaces/chart-data.interface';
-/**
- * bank account collection UI class with frontend specific data
- */
-export declare class BankAccountChartData {
-    private bankAccounts;
-    constructor(bankAccounts: BankAccount[]);
-    /**
-     * set value of pie chart data
-     */
-    getBalancePieChartData(): IChartData[];
-    /**
-     * set value of bar chart data
-     */
-    getBalanceBarChartData(): IChartData[];
-}

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

@@ -1,6 +0,0 @@
-import { BankAccountProperty as BankAccountPropertyBase } from '../../db/Models/bank/bank-account-property';
-import { Property } from '../property';
-export declare class BankAccountProperty extends BankAccountPropertyBase {
-    property: Property;
-    percent: number;
-}

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

@@ -1,94 +0,0 @@
-import { BankAccount as BankAccountBase } from '../../db/Models/bank/bank-account';
-import { Loan } from '../loan';
-import { BankAccountBalance } from '../../db/Models';
-import { BankAccountProperty } from './bank-account-property';
-import { BankConnection } from './bank-connection';
-import { SoleBusinessAllocation } from '../sole';
-import { Bank } from './bank';
-export declare class BankAccount extends BankAccountBase {
-    bankAccountProperties: BankAccountProperty[];
-    businessAllocations: SoleBusinessAllocation[];
-    balances: BankAccountBalance[];
-    loan: Loan;
-    bankConnection: BankConnection;
-    migrateFrom: Date;
-    migrateTo: Date;
-    get bank(): Bank;
-    get bsb(): string;
-    get number(): string;
-    /**
-     * Get last digits of account number
-     */
-    get partialAccountNumber(): string;
-    get balance(): number;
-    /**
-     * Get the current opening balance amount
-     */
-    getOpeningBalance(year?: number): number;
-    /**
-     * Get bank account balance for current financial year
-     */
-    getBalanceByYear(year: number): BankAccountBalance;
-    /**
-     * check if bank account type is one of savings accounts
-     */
-    isSavingsAccount(): boolean;
-    /**
-     * check if a bank account type is Loan
-     */
-    isLoan(): boolean;
-    /**
-     * check if bank account type is Credit card
-     */
-    isCreditCard(): boolean;
-    /**
-     * check if a bank account related to work tank
-     */
-    isWorkTank(): boolean;
-    /**
-     * check if a bank account related to work tank
-     */
-    isPropertyTank(): boolean;
-    /**
-     * check if a bank account related to sole tank
-     */
-    isSoleTank(): boolean;
-    /**
-     * Get Bank account property by id
-     * @param id Id of property
-     */
-    getPropertyById(id: number): BankAccountProperty;
-    /**
-     * check if a bank account is related with passed property by id
-     * @param propertyId Property id for checking
-     */
-    hasProperty(propertyId: number): boolean;
-    /**
-     * Get decimal percentage for property
-     * @param propertyId Id of property
-     */
-    getPropertyPercentage(propertyId: number): number;
-    /**
-     * Get balance amount for property by id
-     * @param propertyId Id of property
-     */
-    getPropertyBalanceAmount(propertyId: number): number;
-    getMonthlyRepaymentAmount(propertyId: number): number;
-    /**
-     * Check if bank account is active for current financial year (has 'active' status or hasn't been paid out/refinanced)
-     */
-    isActive(): boolean;
-    /**
-     * first import (transactions) of basiq accounts
-     */
-    isFirstImport(): boolean;
-    /**
-     * Check if passed user id is owner of bank account
-     */
-    isOwner(userId: number): boolean;
-    /**
-     * Loan is paid if it has no unallocated transactions and the bank balance is $0.
-     */
-    isLoanPaid(taxTankBalance: number): boolean;
-    isManual(): boolean;
-}

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

@@ -1,28 +0,0 @@
-import { BankConnection as BankConnectionBase } from '../../db/Models/bank/bank-connection';
-import { BasiqJob } from './basiq';
-import { Bank } from './bank';
-export declare class BankConnection extends BankConnectionBase {
-    /**
-     * reminder to extend connection agreement
-     */
-    static expiryReminderDays: number;
-    basiqJob: BasiqJob;
-    bank: Bank;
-    lastSuccessImportDate: Date;
-    expiryDate?: Date;
-    isPending(): boolean;
-    isInvalid(): boolean;
-    isActive(): boolean;
-    isReconnecting(): boolean;
-    setPending(): void;
-    isOpenBanking(): boolean;
-    isBasiq(): boolean;
-    isBasiqAvailable(): boolean;
-    isOpenBankingAvailable(): boolean;
-    isLoginSuccess(): boolean;
-    isAccountsRetrieved(): boolean;
-    isJobFailed(): boolean;
-    isTemporaryUnavailable(): boolean;
-    isExpiring(): boolean;
-    isExpired(): boolean;
-}

package/src/lib/models/bank/bank-external-stats.d.ts

@@ -1,12 +0,0 @@
-/**
- * @TODO not used for now
- * Bank subclass, average bank response time for some operations in milliseconds
- * Used for basiq banks functionality to improve bank login UI/UX (loading progress)
- */
-export declare class BankExternalStats {
-    retrieveAccounts: number;
-    retrieveMeta: number;
-    retrieveTransactions: number;
-    total: number;
-    verifyCredentials: number;
-}

package/src/lib/models/bank/bank-transaction-chart-data.d.ts

@@ -1,30 +0,0 @@
-import { BankTransaction } from './bank-transaction';
-import { IChartData } from '../../interfaces';
-import { MonthNumberEnum } from '../financial-year';
-/**
- * bank transactions collection UI class with frontend specific data
- */
-export declare class BankTransactionChartData {
-    private bankTransactions;
-    constructor(bankTransactions: BankTransaction[]);
-    /**
-     * get value of bar chart data
-     */
-    getCashInOutBarChartData(months?: MonthNumberEnum[]): IChartData[];
-    /**
-     * get value of line chart data
-     */
-    getBalanceLineChartData(months?: MonthNumberEnum[]): IChartData[];
-    /**
-     * set bar chart data
-     */
-    private calculateCashInOutBarChartData;
-    /**
-     * set line chart data
-     */
-    private calculateBalanceLineChartData;
-    /**
-     * filter chart data for passed months
-     */
-    private filterChartDataByMonths;
-}

package/src/lib/models/bank/bank-transaction-summary-fields.enum.d.ts

@@ -1,4 +0,0 @@
-export declare enum BankTransactionSummaryFieldsEnum {
-    AMOUNT = "amount",
-    ALLOCATED_AMOUNT = "allocatedAmount"
-}

package/src/lib/models/bank/bank-transaction.d.ts

@@ -1,38 +0,0 @@
-import { BankTransaction as BankTransactionBase } from '../../db/Models/bank/bank-transaction';
-import { TransactionOperationEnum } from '../../db/Enums/transaction-operation.enum';
-import { Transaction } from '../transaction';
-import { TransactionAllocationCollection } from '../../collections';
-export declare class BankTransaction extends BankTransactionBase {
-    allocatedAmount: number;
-    operation: TransactionOperationEnum;
-    date: Date;
-    amount: number;
-    /**
-     * get allocated amount value but with +/- sign
-     */
-    get balanceAmount(): number;
-    /**
-     * check if bank transaction is debit
-     */
-    isDebit(): boolean;
-    /**
-     * check if bank transaction is credit
-     */
-    isCredit(): boolean;
-    /**
-     * Create Transaction instance based on Bank Transaction
-     */
-    toTransaction(isGST?: boolean, allocations?: TransactionAllocationCollection): Transaction;
-    /**
-     * Check if bank transaction is completely allocated
-     */
-    isAllocated(allocations: TransactionAllocationCollection): boolean;
-    /**
-     * Get bank transaction allocated amount
-     */
-    getAllocatedAmount(allocations: TransactionAllocationCollection): number;
-    /**
-     * Get bank transaction unallocated amount
-     */
-    getUnallocatedAmount(allocations: TransactionAllocationCollection): number;
-}

package/src/lib/models/bank/bank.d.ts

@@ -1,15 +0,0 @@
-import { Bank as BankBase } from '../../db/Models/bank/bank';
-import { BankExternalStats } from './bank-external-stats';
-import { AppFile } from '../file';
-export declare class Bank extends BankBase {
-    logo: string;
-    isPopular: boolean;
-    externalStats: BankExternalStats;
-    file: AppFile;
-    isManual(): boolean;
-    isBasiq(): boolean;
-    /**
-     * some images come from basiq (starting http), the rest from assets
-     */
-    getPhoto(): string;
-}

package/src/lib/models/bank/basiq/basiq-config.d.ts

@@ -1,17 +0,0 @@
-/**
- * Class describe configuration options for basiq connect control
- * https://www.npmjs.com/package/@basiq/basiq-connect-control
- */
-export declare class BasiqConfig {
-    containerId: string;
-    token: string;
-    userID: string;
-    connectLinkId: string;
-    upload: boolean;
-    connect: boolean;
-    companyName: string;
-    regionOfInstitutions: string;
-    hideTestBanks: boolean;
-    hideBetaBanks: boolean;
-    constructor(options: object);
-}

package/src/lib/models/bank/basiq/basiq-connection-data.interface.d.ts

@@ -1,8 +0,0 @@
-/**
- * Interface contains data required for Basiq API.
- * Used for connect/reconnect banks
- */
-export interface BasiqConnectionData {
-    jobId: string;
-    connectionId?: string;
-}

package/src/lib/models/bank/basiq/basiq-connections-response.interface.d.ts

@@ -1,9 +0,0 @@
-/**
- * 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/src/lib/models/bank/basiq/basiq-job-response.d.ts

@@ -1,7 +0,0 @@
-import { BasiqJobStep } from './basiq-job-step';
-export declare class BasiqJobResponse {
-    id: string;
-    steps: BasiqJobStep[];
-    getVerifyCredentialsStep(): BasiqJobStep;
-    getRetrieveAccountsStep(): BasiqJobStep;
-}

package/src/lib/models/bank/basiq/basiq-job-step.d.ts

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

package/src/lib/models/bank/basiq/basiq-job.d.ts

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

package/src/lib/models/bank/basiq/basiq-token-response.interface.d.ts

@@ -1,9 +0,0 @@
-/**
- * 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/src/lib/models/bank/basiq/basiq-token.d.ts

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

package/src/lib/models/bank/basiq/index.d.ts

@@ -1,8 +0,0 @@
-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/src/lib/models/bank/index.d.ts

@@ -1,12 +0,0 @@
-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';

package/src/lib/models/bank/type-loan.const.d.ts

@@ -1,2 +0,0 @@
-import { BankAccountTypeEnum } from '../../db/Enums';
-export declare const TYPE_LOAN: BankAccountTypeEnum[];

package/src/lib/models/borrowing-expense/borrowing-expense-loan.d.ts

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

package/src/lib/models/borrowing-expense/borrowing-expense.d.ts

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

package/src/lib/models/borrowing-expense/index.d.ts

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

package/src/lib/models/budget/budget-rule.d.ts

@@ -1,7 +0,0 @@
-import { BudgetRule as BudgetRuleBase } from '../../db/Models/budget/budget-rule';
-import { Budget } from './budget';
-import { ChartAccounts } from '../chart-accounts';
-export declare class BudgetRule extends BudgetRuleBase {
-    budget: Budget;
-    chartAccounts: ChartAccounts;
-}

package/src/lib/models/budget/budget.d.ts

@@ -1,9 +0,0 @@
-import { Budget as BudgetBase } from '../../db/Models/budget/budget';
-import { BudgetRule } from './budget-rule';
-import { User } from '../user';
-import { Collection } from '../../collections';
-export declare class Budget extends BudgetBase {
-    rules: BudgetRule[];
-    user: User;
-    get rulesCollection(): Collection<BudgetRule>;
-}

package/src/lib/models/budget/index.d.ts

@@ -1,2 +0,0 @@
-export * from './budget';
-export * from './budget-rule';

package/src/lib/models/chart/chart-data.d.ts

@@ -1,9 +0,0 @@
-import { ChartSerie } from './chart-serie';
-/**
- * Chart data class
- * @TODO consider rename to ChartSerie
- */
-export declare class ChartData {
-    name: string;
-    data: ChartSerie[];
-}

package/src/lib/models/chart/chart-serie.d.ts

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

package/src/lib/models/chart-accounts/chart-accounts-categories.const.d.ts

@@ -1,8 +0,0 @@
-import { ChartAccountsCategoryEnum } from '../../db/Enums';
-/**
- * Grouped chart accounts categories for fast work
- * @TODO Alex: Clean up and/or remove some groups
- */
-export declare const CHART_ACCOUNTS_CATEGORIES: {
-    [key: string]: ChartAccountsCategoryEnum[];
-};

package/src/lib/models/chart-accounts/chart-accounts-category.e-collection.d.ts

@@ -1,16 +0,0 @@
-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 declare class ChartAccountsCategoryECollection {
-    items: ChartAccountsCategoryEnum[];
-    constructor(items?: ChartAccountsCategoryEnum[]);
-    getByType(types: ChartAccountsType | ChartAccountsType[]): ChartAccountsCategoryECollection;
-    getByTankType(tankTypes: ChartAccountsTankType | ChartAccountsTankType[]): ChartAccountsCategoryECollection;
-}

package/src/lib/models/chart-accounts/chart-accounts-depreciation.d.ts

@@ -1,7 +0,0 @@
-import { ChartAccountsDepreciation as ChartAccountsDepreciationBase } from '../../db/Models/chart-accounts/chart-accounts-depreciation';
-import { ChartAccounts } from './chart-accounts';
-export declare class ChartAccountsDepreciation extends ChartAccountsDepreciationBase {
-    chartAccounts: ChartAccounts;
-    maxClaim: number;
-    effectiveLife: number;
-}

package/src/lib/models/chart-accounts/chart-accounts-heading.d.ts

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

package/src/lib/models/chart-accounts/chart-accounts-meta-field.d.ts

@@ -1,10 +0,0 @@
-import { ChartAccountsMetaField as ChartAccountsMetaFieldBase } from '../../db/Models/chart-accounts/chart-accounts-meta-field';
-export declare class ChartAccountsMetaField extends ChartAccountsMetaFieldBase {
-    /**
-     * Check if meta field id is related to SHARE_PERCENTAGE value
-     */
-    isSharePercentage(): boolean;
-    isHours(): boolean;
-    isFranked(): boolean;
-    isFrankingCredit(): boolean;
-}

package/src/lib/models/chart-accounts/chart-accounts-tax-labels.enum.d.ts

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

package/src/lib/models/chart-accounts/chart-accounts-value.d.ts

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