taxtank-core 0.4.1 → 0.5.0

package/lib/collections/bank-account.collection.d.ts

@@ -1,67 +1,67 @@
-import { Collection } from './collection';
-import { BankAccountTypeEnum } from '../db/Enums/bank-account-type.enum';
-import { TankTypeEnum } from '../db/Enums/tank-type.enum';
-import { BankAccount } from '../models/bank/bank-account';
-import { BankAccountProperty } from '../models/bank/bank-account-property';
-import { Property } from '../models/property/property';
-/**
- * Collection of bank accounts.
- */
-export declare class BankAccountCollection extends Collection<BankAccount> {
-    /**
-     * get list of bank accounts with passed types
-     */
-    getByType(types: BankAccountTypeEnum | BankAccountTypeEnum[], isExclude?: boolean): BankAccount[];
-    /**
-     * get amount of initial loans
-     */
-    getInitialLoanAmount(): number;
-    /**
-     * get amount of current loans
-     */
-    getCurrentLoanAmount(): number;
-    /**
-     * get collection filtered by property id
-     */
-    getByPropertyId(id: number): BankAccountCollection;
-    /**
-     * get collection filtered by properties ids
-     */
-    getByPropertiesIds(ids: number[]): BankAccountCollection;
-    /**
-     * get collection of active bank accounts
-     */
-    getActiveBankAccounts(): BankAccountCollection;
-    /**
-     * get reduction of loan (reduction of principle) percentage
-     */
-    getPrincipleReductionPercent(): number;
-    /**
-     * Get collection of loan bank accounts
-     */
-    getLoanAccounts(): BankAccountCollection;
-    getSavingsAccounts(): BankAccountCollection;
-    getOpeningBalance(): number;
-    get currentBalance(): number;
-    /**
-     * Get Collection of bank accounts with property tank type
-     */
-    getPropertyBankAccounts(): BankAccountCollection;
-    /**
-     * Get Collection of bank accounts with work tank type
-     */
-    getWorkBankAccounts(): BankAccountCollection;
-    /**
-     * Get Collection of bank accounts by tank type
-     */
-    getByTankType(tankType: TankTypeEnum): BankAccountCollection;
-    /**
-     * Get list of all bank account properties
-     */
-    getBankAccountPropertiesList(): BankAccountProperty[];
-    /**
-     * Get lis of unique properties from all bank accounts properties
-     */
-    getProperties(): Property[];
-    getPropertyBalanceAmount(propertyId: number): number;
-}
+import { Collection } from './collection';
+import { BankAccountTypeEnum } from '../db/Enums/bank-account-type.enum';
+import { TankTypeEnum } from '../db/Enums/tank-type.enum';
+import { BankAccount } from '../models/bank/bank-account';
+import { BankAccountProperty } from '../models/bank/bank-account-property';
+import { Property } from '../models/property/property';
+/**
+ * Collection of bank accounts.
+ */
+export declare class BankAccountCollection extends Collection<BankAccount> {
+    /**
+     * get list of bank accounts with passed types
+     */
+    getByType(types: BankAccountTypeEnum | BankAccountTypeEnum[], isExclude?: boolean): BankAccount[];
+    /**
+     * get amount of initial loans
+     */
+    getInitialLoanAmount(): number;
+    /**
+     * get amount of current loans
+     */
+    getCurrentLoanAmount(): number;
+    /**
+     * get collection filtered by property id
+     */
+    getByPropertyId(id: number): BankAccountCollection;
+    /**
+     * get collection filtered by properties ids
+     */
+    getByPropertiesIds(ids: number[]): BankAccountCollection;
+    /**
+     * get collection of active bank accounts
+     */
+    getActiveBankAccounts(): BankAccountCollection;
+    /**
+     * get reduction of loan (reduction of principle) percentage
+     */
+    getPrincipleReductionPercent(): number;
+    /**
+     * Get collection of loan bank accounts
+     */
+    getLoanAccounts(): BankAccountCollection;
+    getSavingsAccounts(): BankAccountCollection;
+    getOpeningBalance(): number;
+    get currentBalance(): number;
+    /**
+     * Get Collection of bank accounts with property tank type
+     */
+    getPropertyBankAccounts(): BankAccountCollection;
+    /**
+     * Get Collection of bank accounts with work tank type
+     */
+    getWorkBankAccounts(): BankAccountCollection;
+    /**
+     * Get Collection of bank accounts by tank type
+     */
+    getByTankType(tankType: TankTypeEnum): BankAccountCollection;
+    /**
+     * Get list of all bank account properties
+     */
+    getBankAccountPropertiesList(): BankAccountProperty[];
+    /**
+     * Get lis of unique properties from all bank accounts properties
+     */
+    getProperties(): Property[];
+    getPropertyBalanceAmount(propertyId: number): number;
+}

package/lib/collections/bank-transaction.collection.d.ts

@@ -1,72 +1,72 @@
-import { BankTransaction } from '../models/bank/bank-transaction';
-import { MonthNumberEnum } from '../models/financial-year/month-number.enum';
-import { IncomeSource } from '../models/income-source/income-source';
-import { BankAccount } from '../models/bank/bank-account';
-import { Collection } from './collection';
-import { CollectionDictionary } from './collection-dictionary';
-import { TransactionAllocationCollection } from './transaction-allocation.collection';
-/**
- * Collection of bank transactions.
- * IMPORTANT: Create this collection based on bank transactions from TransactionAllocationService
- * @TODO find way to accept interface with allocation instead of bankTransaction to prevent wrong usage
- * because all amounts calculates with allocated amounts but not from bank transactions amounts.
- */
-export declare class BankTransactionCollection extends Collection<BankTransaction> {
-    getAmount(): number;
-    /**
-     * Difference between total bank transactions amount and sum of allocations for passed bank transactions
-     */
-    getUnallocatedAmount(allocations: TransactionAllocationCollection): number;
-    /**
-     * get date of the last transaction
-     */
-    getLastTransactionDate(): Date;
-    /**
-     * get list of credit transactions
-     */
-    get creditTransactions(): BankTransactionCollection;
-    /**
-     * get list of debit transactions
-     */
-    get debitTransactions(): BankTransactionCollection;
-    /**
-     * get difference between debit and credit transactions amounts
-     */
-    get balanceAmount(): number;
-    /**
-     * get list of transactions for passed month
-     * @param monthIndex Month number from 0 to 11
-     */
-    getTransactionsByMonth(monthIndex: MonthNumberEnum): BankTransactionCollection;
-    /**
-     * get list of transactions by provided bank accounts
-     * @param bankAccounts by which transactions should be returned
-     */
-    getByBankAccounts(bankAccounts: BankAccount[]): BankTransaction[];
-    /**
-     * get list of transactions by provided ids of bank accounts
-     * @param ids of bank accounts
-     */
-    getByBankAccountsIds(ids: number[]): BankTransactionCollection;
-    /**
-     * Find Bank Transaction available for transfer
-     */
-    findTransfer(bankTransaction: BankTransaction): BankTransaction;
-    /**
-     * Group bank transactions by transaction id.
-     * Each group is bank transaction collection and contains bank transactions related to transactions via allocations
-     */
-    groupByTransaction(allocations: TransactionAllocationCollection): CollectionDictionary<BankTransactionCollection>;
-    /**
-     * Get collection of bank transactions related with passed allocations
-     */
-    getByAllocations(allocations: TransactionAllocationCollection): BankTransactionCollection;
-    /**
-     * Set allocate operation for bank transactions with amounts equal to salary
-     */
-    preselectAllocateOperationForSalary(salaryIncomeSources: IncomeSource[]): void;
-    /**
-     * Get collection of unallocated bankTransactions
-     */
-    getUnallocatedBankTransactions(allocations: TransactionAllocationCollection): BankTransactionCollection;
-}
+import { BankTransaction } from '../models/bank/bank-transaction';
+import { MonthNumberEnum } from '../models/financial-year/month-number.enum';
+import { IncomeSource } from '../models/income-source/income-source';
+import { BankAccount } from '../models/bank/bank-account';
+import { Collection } from './collection';
+import { CollectionDictionary } from './collection-dictionary';
+import { TransactionAllocationCollection } from './transaction-allocation.collection';
+/**
+ * Collection of bank transactions.
+ * IMPORTANT: Create this collection based on bank transactions from TransactionAllocationService
+ * @TODO find way to accept interface with allocation instead of bankTransaction to prevent wrong usage
+ * because all amounts calculates with allocated amounts but not from bank transactions amounts.
+ */
+export declare class BankTransactionCollection extends Collection<BankTransaction> {
+    getAmount(): number;
+    /**
+     * Difference between total bank transactions amount and sum of allocations for passed bank transactions
+     */
+    getUnallocatedAmount(allocations: TransactionAllocationCollection): number;
+    /**
+     * get date of the last transaction
+     */
+    getLastTransactionDate(): Date;
+    /**
+     * get list of credit transactions
+     */
+    get creditTransactions(): BankTransactionCollection;
+    /**
+     * get list of debit transactions
+     */
+    get debitTransactions(): BankTransactionCollection;
+    /**
+     * get difference between debit and credit transactions amounts
+     */
+    get balanceAmount(): number;
+    /**
+     * get list of transactions for passed month
+     * @param monthIndex Month number from 0 to 11
+     */
+    getTransactionsByMonth(monthIndex: MonthNumberEnum): BankTransactionCollection;
+    /**
+     * get list of transactions by provided bank accounts
+     * @param bankAccounts by which transactions should be returned
+     */
+    getByBankAccounts(bankAccounts: BankAccount[]): BankTransaction[];
+    /**
+     * get list of transactions by provided ids of bank accounts
+     * @param ids of bank accounts
+     */
+    getByBankAccountsIds(ids: number[]): BankTransactionCollection;
+    /**
+     * Find Bank Transaction available for transfer
+     */
+    findTransfer(bankTransaction: BankTransaction): BankTransaction;
+    /**
+     * Group bank transactions by transaction id.
+     * Each group is bank transaction collection and contains bank transactions related to transactions via allocations
+     */
+    groupByTransaction(allocations: TransactionAllocationCollection): CollectionDictionary<BankTransactionCollection>;
+    /**
+     * Get collection of bank transactions related with passed allocations
+     */
+    getByAllocations(allocations: TransactionAllocationCollection): BankTransactionCollection;
+    /**
+     * Set allocate operation for bank transactions with amounts equal to salary
+     */
+    preselectAllocateOperationForSalary(salaryIncomeSources: IncomeSource[]): void;
+    /**
+     * Get collection of unallocated bankTransactions
+     */
+    getUnallocatedBankTransactions(allocations: TransactionAllocationCollection): BankTransactionCollection;
+}

package/lib/collections/client-movement.collection.d.ts

@@ -1,17 +1,17 @@
-import { Collection } from './collection';
-import { ClientMovement } from '../models/client/client-movement';
-import { EmployeeCollection } from './employee.collection';
-import { ClientCollection } from './client.collection';
-import { FirmTypeEnum } from '../db/Enums/firm-type.enum';
-/**
- * Collection of tax review
- */
-export declare class ClientMovementCollection extends Collection<ClientMovement> {
-    get active(): ClientMovementCollection;
-    get employees(): EmployeeCollection;
-    get clients(): ClientCollection;
-    get accountant(): ClientMovement;
-    get advisors(): ClientMovementCollection;
-    getByEmployeeId(id: number): ClientMovementCollection;
-    getByFirmType(firmType: FirmTypeEnum): ClientMovementCollection;
-}
+import { Collection } from './collection';
+import { ClientMovement } from '../models/client/client-movement';
+import { EmployeeCollection } from './employee.collection';
+import { ClientCollection } from './client.collection';
+import { FirmTypeEnum } from '../db/Enums/firm-type.enum';
+/**
+ * Collection of tax review
+ */
+export declare class ClientMovementCollection extends Collection<ClientMovement> {
+    get active(): ClientMovementCollection;
+    get employees(): EmployeeCollection;
+    get clients(): ClientCollection;
+    get accountant(): ClientMovement;
+    get advisors(): ClientMovementCollection;
+    getByEmployeeId(id: number): ClientMovementCollection;
+    getByFirmType(firmType: FirmTypeEnum): ClientMovementCollection;
+}

package/lib/collections/client-portfolio-report.collection.d.ts

@@ -1,26 +1,26 @@
-/**
- * Collection of employee clients tax summary information
- */
-import { Collection } from './collection';
-import { ClientPortfolioReport } from '../models/client/client-portfolio-report';
-export declare class ClientPortfolioReportCollection extends Collection<ClientPortfolioReport> {
-    get marketValue(): number;
-    get loanBalance(): number;
-    get equityPosition(): number;
-    /**
-     * Get average market value if there are more than 1 item in the collection
-     */
-    get averageMarketValue(): number;
-    /**
-     * Get average loan balance if there are more than 1 item in the collection
-     */
-    get averageLoanBalance(): number;
-    /**
-     * Get average equity position if there are more than 1 item in the collection
-     */
-    get averageEquityPosition(): number;
-    /**
-     * Return report by provided category name
-     */
-    getByCategoryName(name: string): ClientPortfolioReport;
-}
+/**
+ * Collection of employee clients tax summary information
+ */
+import { Collection } from './collection';
+import { ClientPortfolioReport } from '../models/client/client-portfolio-report';
+export declare class ClientPortfolioReportCollection extends Collection<ClientPortfolioReport> {
+    get marketValue(): number;
+    get loanBalance(): number;
+    get equityPosition(): number;
+    /**
+     * Get average market value if there are more than 1 item in the collection
+     */
+    get averageMarketValue(): number;
+    /**
+     * Get average loan balance if there are more than 1 item in the collection
+     */
+    get averageLoanBalance(): number;
+    /**
+     * Get average equity position if there are more than 1 item in the collection
+     */
+    get averageEquityPosition(): number;
+    /**
+     * Return report by provided category name
+     */
+    getByCategoryName(name: string): ClientPortfolioReport;
+}

package/lib/collections/client.collection.d.ts

@@ -1,4 +1,4 @@
-import { Collection } from './collection';
-import { User } from '../models/user/user';
-export declare class ClientCollection extends Collection<User> {
-}
+import { Collection } from './collection';
+import { User } from '../models/user/user';
+export declare class ClientCollection extends Collection<User> {
+}

package/lib/collections/collection-dictionary.d.ts

@@ -1,47 +1,47 @@
-import { Collection as BaseCollection } from './collection';
-/**
- * List of collections grouped by passed property
- */
-export declare class CollectionDictionary<Collection extends BaseCollection<object>> {
-    /**
-     * List of grouped collections
-     */
-    items: {
-        [key: string]: Collection;
-    };
-    /**
-     * Constructor function of passed collection for creating new instances
-     */
-    private collectionConstructor;
-    /**
-     * @param collection The Collection instance to be grouped
-     * @param path Path to the property to be grouped (Examples: 'transaction', 'property.category')
-     * @param prop Optional: Field to group by (Default 'id', Examples: 'id', 'amount', 'date')
-     */
-    constructor(collection: Collection, path?: string, prop?: string);
-    /**
-     * List of collections keys
-     */
-    get keys(): string[];
-    /**
-     * Get collection by key or return empty collection if key does not exist
-     */
-    get(key: string | number): Collection;
-    /**
-     * Add new item by key
-     */
-    add(key: string | number, value: Collection): void;
-    /**
-     * Join several collections by ids
-     */
-    merge(keys: number[]): Collection;
-    /**
-     * Create instance of collection
-     */
-    createCollection(items?: object[]): Collection;
-    length(): number;
-    /**
-     * Group collection items by passed path into items object
-     */
-    private groupItems;
-}
+import { Collection as BaseCollection } from './collection';
+/**
+ * List of collections grouped by passed property
+ */
+export declare class CollectionDictionary<Collection extends BaseCollection<object>> {
+    /**
+     * List of grouped collections
+     */
+    items: {
+        [key: string]: Collection;
+    };
+    /**
+     * Constructor function of passed collection for creating new instances
+     */
+    private collectionConstructor;
+    /**
+     * @param collection The Collection instance to be grouped
+     * @param path Path to the property to be grouped (Examples: 'transaction', 'property.category')
+     * @param prop Optional: Field to group by (Default 'id', Examples: 'id', 'amount', 'date')
+     */
+    constructor(collection: Collection, path?: string, prop?: string);
+    /**
+     * List of collections keys
+     */
+    get keys(): string[];
+    /**
+     * Get collection by key or return empty collection if key does not exist
+     */
+    get(key: string | number): Collection;
+    /**
+     * Add new item by key
+     */
+    add(key: string | number, value: Collection): void;
+    /**
+     * Join several collections by ids
+     */
+    merge(keys: number[]): Collection;
+    /**
+     * Create instance of collection
+     */
+    createCollection(items?: object[]): Collection;
+    length(): number;
+    /**
+     * Group collection items by passed path into items object
+     */
+    private groupItems;
+}

package/lib/collections/collection.d.ts

@@ -1,37 +1,37 @@
-import { CollectionDictionary } from './collection-dictionary';
-/**
- * Base collection class. Contains common properties and methods for all collections
- */
-export declare class Collection<Model extends object> implements Iterable<Model> {
-    items: Model[];
-    constructor(items?: Model[]);
-    create(items?: Model[]): this;
-    getBy(field: string, value: any): this;
-    groupBy(path?: string): CollectionDictionary<Collection<Model>>;
-    indexBy(path: string): object;
-    /**
-     * Iterator that allow to iterate collection items
-     */
-    [Symbol.iterator](): Iterator<Model>;
-    /**
-     * get collection length
-     */
-    get length(): number;
-    /**
-     * Get list of items ids
-     */
-    getIds(): number[];
-    /**
-     * Get single item by id
-     */
-    getById(id: number): Model;
-    getByIds(ids: number[]): Model[];
-    /**
-     * Get total sum of items by field
-     * @param field Name of the field for sum
-     */
-    sumBy(field: string): number;
-    toArray(): Model[];
-    get first(): Model;
-    get last(): Model;
-}
+import { CollectionDictionary } from './collection-dictionary';
+/**
+ * Base collection class. Contains common properties and methods for all collections
+ */
+export declare class Collection<Model extends object> implements Iterable<Model> {
+    items: Model[];
+    constructor(items?: Model[]);
+    create(items?: Model[]): this;
+    getBy(field: string, value: any): this;
+    groupBy(path?: string): CollectionDictionary<Collection<Model>>;
+    indexBy(path: string): object;
+    /**
+     * Iterator that allow to iterate collection items
+     */
+    [Symbol.iterator](): Iterator<Model>;
+    /**
+     * get collection length
+     */
+    get length(): number;
+    /**
+     * Get list of items ids
+     */
+    getIds(): number[];
+    /**
+     * Get single item by id
+     */
+    getById(id: number): Model;
+    getByIds(ids: number[]): Model[];
+    /**
+     * Get total sum of items by field
+     * @param field Name of the field for sum
+     */
+    sumBy(field: string): number;
+    toArray(): Model[];
+    get first(): Model;
+    get last(): Model;
+}

package/lib/collections/depreciation-forecast.collection.d.ts

@@ -1,11 +1,11 @@
-import { Collection } from './collection';
-import { DepreciationForecast } from '../models/depreciation/depreciation-forecast';
-/**
- * Collection of depreciations
- */
-export declare class DepreciationForecastCollection extends Collection<DepreciationForecast> {
-    filterByYear(financialYear: number): any;
-    getClaimAmountByMonth(month: number): number;
-    get amount(): number;
-    get claimAmount(): number;
-}
+import { Collection } from './collection';
+import { DepreciationForecast } from '../models/depreciation/depreciation-forecast';
+/**
+ * Collection of depreciations
+ */
+export declare class DepreciationForecastCollection extends Collection<DepreciationForecast> {
+    filterByYear(financialYear: number): any;
+    getClaimAmountByMonth(month: number): number;
+    get amount(): number;
+    get claimAmount(): number;
+}

package/lib/collections/depreciation.collection.d.ts

@@ -1,28 +1,28 @@
-import { TankTypeEnum } from '../db/Enums/tank-type.enum';
-import { Collection } from './collection';
-import { Depreciation } from '../models/depreciation/depreciation';
-import { DepreciationCapitalProject } from '../models/depreciation/depreciation-capital-project';
-export declare class DepreciationCollection extends Collection<Depreciation> {
-    /**
-     * Get total amount of all depreciations in the collection
-     */
-    get amount(): number;
-    get claimAmount(): number;
-    getClaimAmountByYear(year: number): number;
-    getCurrentYearForecastAmount(): number;
-    get assetValue(): number;
-    /**
-     * Get new depreciations collections filtered by tank type
-     */
-    getByTankType(tankType: TankTypeEnum): DepreciationCollection;
-    getByPropertiesIds(ids: number[]): DepreciationCollection;
-    getWithoutBorrowingExpenses(): DepreciationCollection;
-    getWorkDepreciations(): DepreciationCollection;
-    getPropertyDepreciations(): DepreciationCollection;
-    getPlantEquipment(): DepreciationCollection;
-    getCapitalDepreciations(): DepreciationCollection;
-    getBorrowingExpenseDepreciations(): DepreciationCollection;
-    getWrittenOffDepreciations(): DepreciationCollection;
-    getLowValuePoolDepreciations(): DepreciationCollection;
-    getCapitalProjects(): DepreciationCapitalProject[];
-}
+import { TankTypeEnum } from '../db/Enums/tank-type.enum';
+import { Collection } from './collection';
+import { Depreciation } from '../models/depreciation/depreciation';
+import { DepreciationCapitalProject } from '../models/depreciation/depreciation-capital-project';
+export declare class DepreciationCollection extends Collection<Depreciation> {
+    /**
+     * Get total amount of all depreciations in the collection
+     */
+    get amount(): number;
+    get claimAmount(): number;
+    getClaimAmountByYear(year: number): number;
+    getCurrentYearForecastAmount(): number;
+    get assetValue(): number;
+    /**
+     * Get new depreciations collections filtered by tank type
+     */
+    getByTankType(tankType: TankTypeEnum): DepreciationCollection;
+    getByPropertiesIds(ids: number[]): DepreciationCollection;
+    getWithoutBorrowingExpenses(): DepreciationCollection;
+    getWorkDepreciations(): DepreciationCollection;
+    getPropertyDepreciations(): DepreciationCollection;
+    getPlantEquipment(): DepreciationCollection;
+    getCapitalDepreciations(): DepreciationCollection;
+    getBorrowingExpenseDepreciations(): DepreciationCollection;
+    getWrittenOffDepreciations(): DepreciationCollection;
+    getLowValuePoolDepreciations(): DepreciationCollection;
+    getCapitalProjects(): DepreciationCapitalProject[];
+}

package/lib/collections/employee.collection.d.ts

@@ -1,6 +1,6 @@
-import { Collection } from './collection';
-import { User } from '../models/user/user';
-export declare class EmployeeCollection extends Collection<User> {
-    get accountant(): User;
-    get advisors(): User[];
-}
+import { Collection } from './collection';
+import { User } from '../models/user/user';
+export declare class EmployeeCollection extends Collection<User> {
+    get accountant(): User;
+    get advisors(): User[];
+}