taxtank-core 2.0.1 → 2.0.3

package/package.json

@@ -1,15 +1,15 @@
 {
   "name": "taxtank-core",
-  "version": "2.0.1",
+  "version": "2.0.3",
   "private": false,
   "peerDependencies": {
-    "@angular/common": "^20.1.4",
-    "@angular/compiler": "^20.1.4",
-    "@angular/core": "^20.1.4",
-    "@angular/forms": "^20.1.4",
-    "@angular/platform-browser": "^20.1.4",
-    "@angular/platform-browser-dynamic": "^20.1.4",
-    "@angular/router": "^20.1.4",
+    "@angular/common": "^19.0.2",
+    "@angular/compiler": "^19.0.2",
+    "@angular/core": "^19.0.2",
+    "@angular/forms": "^19.0.2",
+    "@angular/platform-browser": "^19.0.2",
+    "@angular/platform-browser-dynamic": "^19.0.2",
+    "@angular/router": "^19.0.2",
     "@auth0/angular-jwt": "^5.2.0",
     "@rxweb/reactive-form-validators": "^13.0.1",
     "@types/facebook-js-sdk": "^3.3.10",
@@ -31,7 +31,7 @@
     "moment-range": "^4.0.2",
     "ngx-pipes": "^3.2.2",
     "rxjs": "~7.8.0",
-    "@e965/xlsx": "^0.20.3"
+    "xlsx": "^0.18.5"
   },
   "dependencies": {
     "tslib": "^2.8.1"

package/public-api.d.ts

@@ -0,0 +1,187 @@
+/**
+ * Public API Surface of @taxtank/core
+ */
+export * from './src/lib/core.module';
+export * from './src/lib/pipes';
+/**
+ * Collections
+ */
+export * from './src/lib/collections';
+/**
+ * DB models
+ */
+export * from './src/lib/db/Models/abstract-model';
+export * from './src/lib/db/Models/transaction/transaction-base';
+export * from './src/lib/models/chart-accounts/chart-accounts-category.e-collection';
+/**
+ * DB enums
+ */
+export * from './src/lib/db/Enums';
+export * from './src/lib/db/Enums/address-type.enum';
+export * from './src/lib/db/Enums/chart-accounts/chart-accounts-category.enum';
+export * from './src/lib/db/Enums/chart-accounts/chart-accounts-etp.enum';
+export * from './src/lib/db/Enums/chart-accounts/chart-accounts-heading-list.enum';
+export * from './src/lib/db/Enums/chart-accounts/chart-accounts-heading-taxable.enum';
+export * from './src/lib/db/Enums/chart-accounts/chart-accounts-heading-list.enum';
+export * from './src/lib/db/Enums/chart-accounts/chart-accounts-heading-tax-deductible.enum';
+export * from './src/lib/db/Enums/chart-accounts/chart-accounts-heading-vehicle-list.enum';
+export * from './src/lib/db/Enums/chart-accounts/chart-accounts-list.enum';
+export * from './src/lib/db/Enums/chart-accounts/chart-accounts-meta-field-list.enum';
+export * from './src/lib/db/Enums/chart-accounts/chart-accounts-meta-field-type.enum';
+export * from './src/lib/db/Enums/chart-accounts/chart-accounts-type.enum';
+export * from './src/lib/db/Enums/chat-status.enum';
+export * from './src/lib/db/Enums/depreciation-calculation.enum';
+export * from './src/lib/db/Enums/depreciation-calculation-percent.enum';
+export * from './src/lib/db/Enums/depreciation-type.enum';
+export * from './src/lib/db/Enums/depreciation-write-off-amount.enum';
+export * from './src/lib/db/Enums/firm/firm-type.enum';
+export * from './src/lib/db/Enums/income-source';
+export * from './src/lib/db/Enums/invite-status.enum';
+export * from './src/lib/db/Enums/youtube-videos.enum';
+export * from './src/lib/db/Enums/bank/loan';
+export * from './src/lib/db/Enums/phone-type.enum';
+export * from './src/lib/db/Enums/property/property-depreciation-calculation.enum';
+export * from './src/lib/db/Enums/property/property-category-list.enum';
+export * from './src/lib/db/Enums/property/property-share-access.enum';
+export * from './src/lib/db/Enums/property/property-share-status.enum';
+export * from './src/lib/db/Enums/registration-invite-status.enum';
+export * from './src/lib/db/Enums/salary-forecast-frequency.enum';
+export * from './src/lib/db/Enums/service-notification-status.enum';
+export * from './src/lib/db/Enums/service-notification-type.enum';
+export * from './src/lib/db/Enums/setup-item-type.enum';
+export * from './src/lib/db/Enums/sole/sole-depreciation-method.enum';
+export * from './src/lib/db/Enums/sole/sole-invoice-statuses.enum';
+export * from './src/lib/db/Enums/sole/sole-invoice-tax-type.enum';
+export * from './src/lib/db/Enums/sole/sole-invoice-template-tax-type.enum';
+export * from './src/lib/db/Enums/sole/sole-invoice-state.enum';
+export * from './src/lib/db/Enums/subscription/service-payment-status.enum';
+export * from './src/lib/db/Enums/subscription/service-price-recurring-interval.enum';
+export * from './src/lib/db/Enums/subscription/service-price-type.enum';
+export * from './src/lib/db/Enums/subscription/service-product-status.enum';
+export * from './src/lib/db/Enums/subscription/service-product-id.enum';
+export * from './src/lib/db/Enums/subscription/service-subscription-status.enum';
+export * from './src/lib/db/Enums/spare-document-spare-type.enum';
+export * from './src/lib/db/Enums/tank-type.enum';
+export * from './src/lib/db/Enums/tax-calculation-medicare-exemption.enum';
+export * from './src/lib/db/Enums/tax-calculation-type.enum';
+export * from './src/lib/db/Enums/tax-return/tax-return-category-list.enum';
+export * from './src/lib/db/Enums/tax-return/tax-return-category-section.enum';
+export * from './src/lib/db/Enums/tax-review-status.enum';
+export * from './src/lib/db/Enums/tax-summary-list.enum';
+export * from './src/lib/db/Enums/tax-summary-section.enum';
+export * from './src/lib/db/Enums/tax-summary-tax-summary.enum';
+export * from './src/lib/db/Enums/ticket-feedback.enum';
+export * from './src/lib/db/Enums/ticket-status.enum';
+export * from './src/lib/db/Enums/ticket-types.enum';
+export * from './src/lib/db/Enums/transaction-operation.enum';
+export * from './src/lib/db/Enums/transaction-source.enum';
+export * from './src/lib/db/Enums/transaction-type.enum';
+export * from './src/lib/db/Enums/user-event-status.enum';
+export * from './src/lib/db/Enums/user-event-type-frequency.enum';
+export * from './src/lib/db/Enums/user-event-type-user-type.enum';
+export * from './src/lib/db/Enums/user-event-type-employee-type.enum';
+export * from './src/lib/db/Enums/user-event-type-client-type.enum';
+export * from './src/lib/db/Enums/user-medicare-exemption.enum';
+export * from './src/lib/db/Enums/user-status.enum';
+export * from './src/lib/db/Enums/user-title.enum';
+export * from './src/lib/db/Enums/user-work-depreciation-calculation.enum';
+export * from './src/lib/db/Enums/user-working-holiday-maker.enum';
+export * from './src/lib/db/Enums/vehicle-claim-details-method.enum';
+export * from './src/lib/db/Enums/vehicle-logbook-purpose.enum';
+export * from './src/lib/db/Enums/property/property-sale/tax-exemption.enum';
+export * from './src/lib/db/Enums/property/property-sale/tax-exemption-meta-field.enum';
+/**
+ * Models and related enums and consts
+ */
+export * from './src/lib/models';
+export * from './src/lib/models/account-setup/account-setup-item';
+export * from './src/lib/models/badge/badge';
+export * from './src/lib/models/badge/badge-color.enum';
+export * from './src/lib/models/chart/chart-data';
+export * from './src/lib/models/chart/chart-serie';
+export * from './src/lib/models/client/client-details';
+export * from './src/lib/models/client/client-invite';
+export * from './src/lib/models/client/client-movement';
+export * from './src/lib/models/client/client-portfolio-chart-data';
+export * from './src/lib/models/client/client-portfolio-report';
+export * from './src/lib/models/color/alphabet-colors.enum';
+export * from './src/lib/models/document/document';
+export * from './src/lib/models/document/document-api-url-prefix.enum';
+export * from './src/lib/models/document/document-file-types.const';
+export * from './src/lib/models/document/document-folder';
+export * from './src/lib/models/employee/employee-details';
+export * from './src/lib/models/employee/employee-invite';
+export * from './src/lib/models/endpoint/endpoint';
+export * from './src/lib/models/endpoint/endpoints.const';
+export * from './src/lib/models/event/app-event';
+export * from './src/lib/models/event/app-event-type.enum';
+export * from './src/lib/models/export/export-data-table';
+export * from './src/lib/models/export/export-format.enum';
+export * from './src/lib/models/file/icons-file.enum';
+export * from './src/lib/models/financial-year/financial-year';
+export * from './src/lib/models/financial-year/month-name-short.enum';
+export * from './src/lib/models/financial-year/month-number.enum';
+export * from './src/lib/models/financial-year/months.const';
+export * from './src/lib/models/firm/firm';
+export * from './src/lib/models/income-position/income-position';
+export * from './src/lib/models/notification/notification';
+export * from './src/lib/models/pdf/pdf-orientation.enum';
+export * from './src/lib/models/pdf/pdf-settings';
+export * from './src/lib/models/phone/phone';
+export * from './src/lib/models/registration-invite/registration-invite';
+export * from './src/lib/models/report';
+export * from './src/lib/models/service-subscription/module-url-list.const';
+export * from './src/lib/models/service-subscription/service-payment';
+export * from './src/lib/models/service-subscription/service-price';
+export * from './src/lib/models/service-subscription/service-product';
+export * from './src/lib/models/service-subscription/service-subscription';
+export * from './src/lib/models/service-subscription/service-subscription-item';
+export * from './src/lib/models/tax-review/tax-review';
+export * from './src/lib/models/tax-summary/report-item';
+export * from './src/lib/models/tax-summary/report-item-details';
+export * from './src/lib/models/tax-summary/tax-summary';
+export * from './src/lib/models/tax-summary/tax-summary-section';
+export * from './src/lib/models/tax-summary/tax-summary-type.enum';
+export * from './src/lib/models/toast/toast';
+export * from './src/lib/models/toast/toast-type.enum';
+export * from './src/lib/models/transaction/income-amount-type.enum';
+export * from './src/lib/models/transaction/transaction';
+export * from './src/lib/models/transaction/transaction-allocation';
+export * from './src/lib/models/transaction/transaction-category.enum';
+export * from './src/lib/models/transaction/transaction-meta-field';
+export * from './src/lib/models/user-event/user-event-type-category';
+export * from './src/lib/models/user-event/user-event-setting';
+export * from './src/lib/models/user-event/user-event-setting-field.enum';
+export * from './src/lib/models/user-event/user-event-type';
+/**
+ * Services
+ */
+export * from './src/lib/services';
+export * from './src/lib/resolvers';
+/**
+ * Interfaces
+ */
+export * from './src/lib/interfaces';
+/**
+ * Functions
+ */
+export * from './src/lib/functions/clone-deep';
+export * from './src/lib/functions/create-date';
+export * from './src/lib/functions/enum-to-list';
+export * from './src/lib/functions/get-doc-icon';
+export * from './src/lib/functions/mat-options-functions';
+export * from './src/lib/functions/mat-sort-options';
+export * from './src/lib/functions/array';
+/**
+ * Interceptors
+ */
+export * from './src/lib/interceptors/interceptors.module';
+/**
+ * Forms
+ */
+export * from './src/lib/forms';
+export * from './src/lib/validators';
+/**
+ * Messages
+ */
+export * from './src/lib/messages';

package/src/lib/collections/account-setup-item.collection.d.ts

@@ -0,0 +1,10 @@
+import { AccountSetupItem } from '../models';
+import { Collection } from './collection';
+import { User } from '../models';
+export declare class AccountSetupItemCollection extends Collection<AccountSetupItem> {
+    constructor(items: AccountSetupItem[]);
+    isCompleted(): boolean;
+    getByUser(user: User): this;
+    getScore(): number;
+    setUrlId(id: string): void;
+}

package/src/lib/collections/allocation-group.collection.d.ts

@@ -0,0 +1,5 @@
+import { Collection } from './collection';
+import { AllocationGroup } from '../models';
+export declare class AllocationGroupCollection extends Collection<AllocationGroup> {
+    constructor(items: AllocationGroup[]);
+}

package/src/lib/collections/allocation-rule.collection.d.ts

@@ -0,0 +1,15 @@
+import { Collection } from './collection';
+import { AllocationRule } from '../models';
+import { CollectionDictionary } from './collection-dictionary';
+import { BankTransactionCollection } from './bank-transaction.collection';
+export declare class AllocationRuleCollection extends Collection<AllocationRule> {
+    getExpense(): this;
+    getIncome(): this;
+    getTransfer(): this;
+    /**
+     * Get dictionary where key is bank transaction id and value is collection of matched rules.
+     * Group by this way for better performance
+     * @TODO Alex: break bank transactions by pagination in case of bad performance
+     */
+    groupByBankTransaction(bankTransactions: BankTransactionCollection): CollectionDictionary<AllocationRuleCollection>;
+}

package/src/lib/collections/asset-sale.collection.d.ts

@@ -0,0 +1,19 @@
+import { Collection } from './collection';
+import { AssetSale } from '../models';
+export declare class AssetSaleCollection extends Collection<AssetSale> {
+    get grossCapitalProfit(): number;
+    get fullExemptionSales(): this;
+    /**
+     * true only for isTaxFree=true
+     */
+    get fullExemptionGrossCapitalProfit(): number;
+    get halfExemptionGrossCapitalProfit(): number;
+    get noExemptionGrossCapitalProfit(): number;
+    get taxableGrossCapitalProfit(): number;
+    get currentYearCapitalLoss(): number;
+    calculateForwardCapitalLoss(priorCapitalLoss: number): number;
+    /**
+     * NET CAPITAL GAIN/(LOSS) AFTER CONCESSIONS & DISCOUNTS
+     */
+    calculateNetCapitalGain(priorCapitalLoss: number): number;
+}

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

@@ -0,0 +1,57 @@
+import { Collection } from './collection';
+import { TankTypeEnum } from '../db/Enums/tank-type.enum';
+import { BankAccount, BankAccountProperty, Property } from '../models';
+import { CollectionDictionary } from './collection-dictionary';
+import { LoanCollection } from './loan';
+/**
+ * Collection of bank accounts.
+ */
+export declare class BankAccountCollection extends Collection<BankAccount> {
+    /**
+     * get collection filtered by property id
+     */
+    getByPropertyId(id: number): BankAccountCollection;
+    groupByProperty(): CollectionDictionary<BankAccountCollection>;
+    /**
+     * get collection filtered by properties ids
+     */
+    getByPropertiesIds(ids: number[]): BankAccountCollection;
+    /**
+     * @TODO feature functionality allow to work with shared accounts
+     * get collection of active bank accounts
+     */
+    getActive(): BankAccountCollection;
+    getConnected(): BankAccountCollection;
+    getLoanAccounts(): BankAccountCollection;
+    getLoanAndOffsetAccounts(): BankAccountCollection;
+    getDebitAccounts(): BankAccountCollection;
+    get loans(): LoanCollection;
+    getOpeningBalance(): number;
+    get currentBalance(): number;
+    get bankShortNames(): string;
+    /**
+     * 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[];
+    /**
+     * @TODO Alex not efficient, filter bankAccounts by property first
+     */
+    getPropertyBalanceAmount(propertyId: number): number;
+    get propertiesBalanceAmount(): number;
+    get propertiesMonthlyRepaymentAmount(): number;
+    getPropertyMonthlyRepaymentAmount(propertyId: number): number;
+    getLVR(property: Property): number;
+    /**
+     * @TODO Alex/Vik: maybe we should get it from jwtToken or think about some localStorageService?
+     */
+    getOwn(): this;
+    getActiveLoanAccountsByProperties(ids: number[]): BankAccountCollection;
+}

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

@@ -0,0 +1,77 @@
+import { BankTransaction, IncomeSource, MonthNumberEnum } from '../models';
+import { Collection } from './collection';
+import { CollectionDictionary } from './collection-dictionary';
+import { TransactionAllocationCollection } from './transaction';
+import { BankAccountCollection } from './bank-account.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;
+    getAllocatedAmount(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: BankAccountCollection): BankTransactionCollection;
+    /**
+     * 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;
+    getAllocated(allocations: TransactionAllocationCollection): this;
+    getUnallocated(allocations: TransactionAllocationCollection): this;
+    /**
+     * Allocated sum of credit transactions
+     */
+    getCreditAmount(allocations: TransactionAllocationCollection): number;
+    /**
+     * Allocated sum of debit transactions
+     */
+    getDebitAmount(allocations: TransactionAllocationCollection): number;
+}

package/src/lib/collections/chart-accounts/chart-accounts-value.collection.d.ts

@@ -0,0 +1,12 @@
+import { Collection } from '../collection';
+import { ChartAccountsValue } from '../../models';
+export declare class ChartAccountsValueCollection extends Collection<ChartAccountsValue> {
+    /**
+     * $ amount u can claim per 1km
+     */
+    getKmsRate(isSole: boolean): number;
+    /**
+     * $ amount u can claim per 1hour
+     */
+    getHoursRate(isSole: boolean): number;
+}

package/src/lib/collections/chart-accounts/index.d.ts

@@ -0,0 +1 @@
+export * from './chart-accounts-value.collection';

package/src/lib/collections/chart-accounts.collection.d.ts

@@ -0,0 +1,10 @@
+import { Collection } from './collection';
+import { ChartAccounts } from '../models';
+export declare class ChartAccountsCollection extends Collection<ChartAccounts> {
+    constructor(items?: ChartAccounts[]);
+    getManual(): this;
+    /**
+     * Get 'Kms travelled for work' related chart account value
+     */
+    getVehicleKmsRate(year?: number): number;
+}

package/src/lib/collections/chat/chat.collection.d.ts

@@ -0,0 +1,5 @@
+import { Collection } from '../collection';
+import { Chat } from '../../models';
+export declare class ChatCollection extends Collection<Chat> {
+    getActive(): this;
+}

package/src/lib/collections/chat/index.d.ts

@@ -0,0 +1,3 @@
+export * from './chat.collection';
+export * from './message-document.collection';
+export * from './message.collection';

package/src/lib/collections/chat/message-document.collection.d.ts

@@ -0,0 +1,11 @@
+import { Collection } from '../collection';
+import { MessageDocument } from '../../models';
+/**
+ * Collection of MessageDocument instances
+ */
+export declare class MessageDocumentCollection extends Collection<MessageDocument> {
+    /**
+     * get list of documents which are not attached to any message
+     */
+    getUnattached(): MessageDocumentCollection;
+}

package/src/lib/collections/chat/message.collection.d.ts

@@ -0,0 +1,18 @@
+import { Collection } from '../collection';
+import { Message, User } from '../../models';
+export declare class MessageCollection extends Collection<Message> {
+    getFirstUnreadMessage(user: User): Message;
+    /**
+     * Get List of unread chats
+     */
+    getUnread(): Message[];
+    getFromActiveChats(): this;
+    /**
+     * Get amount of chats that contains unread messages
+     */
+    getUnreadChatsAmount(isFromEmployee?: boolean): number;
+    /**
+     * Check if chat has unread chats
+     */
+    hasUnread(): boolean;
+}

package/src/lib/collections/client-invite.collection.d.ts

@@ -0,0 +1,5 @@
+import { Collection } from './collection';
+import { ClientInvite } from '../models/client/client-invite';
+export declare class ClientInviteCollection extends Collection<ClientInvite> {
+    getPending(): this;
+}

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

@@ -0,0 +1,22 @@
+import { Collection } from './collection';
+import { ClientMovement } from '../models';
+import { EmployeeCollection } from './firm';
+import { ClientCollection } from './client.collection';
+import { FirmTypeEnum } from '../db/Enums';
+import { CollectionDictionary } from './collection-dictionary';
+/**
+ * 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;
+    /**
+     * group clients (client movements) by tanks
+     */
+    groupByRoles(): CollectionDictionary<ClientMovementCollection>;
+}

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

@@ -0,0 +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;
+}

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

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

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

@@ -0,0 +1,57 @@
+import { Collection as BaseCollection } from './collection';
+import { AbstractModel } from '../db/Models';
+/**
+ * @TODO refactor with Map
+ * 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;
+    constructor(collection: Collection, path?: string);
+    /**
+     * List of collections keys
+     */
+    get keys(): string[];
+    get values(): Collection[];
+    /**
+     * push new elements in existing item
+     */
+    addTo(key: string | number, ...models: AbstractModel[]): void;
+    /**
+     * Add new item by key
+     */
+    add(key: string | number, value?: Collection): void;
+    /**
+     * Get collection by key or return empty collection if key does not exist
+     */
+    get(key: string | number): Collection;
+    /**
+     * @TODO bad name, it just gets items by keys, same as get method by multiple keys
+     * Join several collections by ids, return collection of uniq models (skip duplicates)
+     */
+    merge(keys: number[] | string[]): Collection;
+    /**
+     * Create instance of collection
+     */
+    createCollection(items?: object[]): Collection;
+    get length(): number;
+    /**
+     * @Todo find a better solution to get list of the sorted keys
+     * Get array of the "keys" by provided order
+     */
+    getSortedKeys(isDesc?: boolean): string[];
+    keysIntersection(keys: string[] | number[]): string[];
+    /**
+     * Group collection items by passed path into items object
+     */
+    private groupItems;
+    filter(callback: (collection: Collection) => boolean): CollectionDictionary<Collection>;
+}