@rentman/rm-core 4.0.3 → 5.0.0

package/dist/types/classes/TemplateCache.d.ts

@@ -1,66 +1,66 @@
-import { RequestColumnExpansionFactory, TemplateFactory } from '../factories';
-import { ErrorHandlerInterface, PromiseLibraryInterface } from '../interfaces';
-import { Template } from '../models';
-import { EntryParentNull, ItemId, ItemType, PromiseInterface } from '../types';
-import { ApiRequestService } from './ApiRequestService';
-import { ColumnHandler } from './ColumnHandler';
-import { ColumnUtil } from './ColumnUtil';
-export declare class TemplateCache {
-    private columnUtil;
-    private promiseService;
-    private columnHandler;
-    private templateFactory;
-    private errorHandler;
-    private requestColumnExpansionFactory;
-    private apiRequestService;
-    private pendingTemplateBufferMap;
-    templates: {
-        [itemType: string]: Template<any>;
-    };
-    constructor(columnUtil: ColumnUtil, promiseService: PromiseLibraryInterface, columnHandler: ColumnHandler, templateFactory: TemplateFactory, errorHandler: ErrorHandlerInterface, requestColumnExpansionFactory: RequestColumnExpansionFactory, apiRequestService: ApiRequestService);
-    /**
-     * @description
-     * Fetches a {@link Template template}, {@link TransactionItemHandler.createItems TransactionItemHandler.createItems} is a convenience function for this
-     *
-     * @param itemType The {@link ItemType ItemType} of the template item
-     * @param itemId Used for caching, multiple concurrent template calls for the same itemId will return the same template
-     * @param templateOptions
-     * @param templateColumns Additional columns to be fetched, will be stored in the template - warning - the Template won't have values for those columns
-     * @param entryParentOrParentItemType An optional {@link EntryParentNull entry parent} or {@link ItemType parent itemType}, if the parent is passed the templateColumns will be expanded with the proper link columns (Through {@link ColumnUtil.getColumnsFromLink ColumnUtil.getColumnsFromLink})
-     *
-     * @example
-     * ```
-     *  const parent: EntryParent = {
-     *      itemType: 'Functie',
-     *      itemId: 10,
-     *  };
-     *
-     *  return core.templateCache
-     *      .fetchTemplate(
-     *          'Planningpersoneel',
-     *          undefined,
-     *          {},
-     *          {},
-     *          parent,
-     *      )
-     *      .then(
-     *          (template: Template<'Planningpersoneel'>) => {
-     *              const changesDelta = transaction.createChangesDelta();
-     *
-     *              for (const itemResource of selectedItems) {
-     *                  changesDelta.setItemCreated(
-     *                      core.keyService.getLocalId(),
-     *                      template.fields,
-     *                      template.columns,
-     *                      parent,
-     *                  );
-     *              }
-     *
-     *              transaction.applyChangesDelta(changesDelta);
-     *          );
-     *  ```
-     */
-    fetchTemplate<ItemTypeType extends ItemType>(itemType: ItemTypeType, itemId?: ItemId, templateOptions?: any, templateColumns?: any, entryParentOrParentItemType?: EntryParentNull | ItemType): PromiseInterface<Template<ItemTypeType>>;
-    private fetchTemplateById;
-    private constructTemplateBuffer;
-}
+import { RequestColumnExpansionFactory, TemplateFactory } from '../factories';
+import { ErrorHandlerInterface, PromiseLibraryInterface } from '../interfaces';
+import { Template } from '../models';
+import { EntryParentNull, ItemId, ItemType, PromiseInterface } from '../types';
+import { ApiRequestService } from './ApiRequestService';
+import { ColumnHandler } from './ColumnHandler';
+import { ColumnUtil } from './ColumnUtil';
+export declare class TemplateCache {
+    private columnUtil;
+    private promiseService;
+    private columnHandler;
+    private templateFactory;
+    private errorHandler;
+    private requestColumnExpansionFactory;
+    private apiRequestService;
+    private pendingTemplateBufferMap;
+    templates: {
+        [itemType: string]: Template<any>;
+    };
+    constructor(columnUtil: ColumnUtil, promiseService: PromiseLibraryInterface, columnHandler: ColumnHandler, templateFactory: TemplateFactory, errorHandler: ErrorHandlerInterface, requestColumnExpansionFactory: RequestColumnExpansionFactory, apiRequestService: ApiRequestService);
+    /**
+     * @description
+     * Fetches a {@link Template template}, {@link TransactionItemHandler.createItems TransactionItemHandler.createItems} is a convenience function for this
+     *
+     * @param itemType The {@link ItemType ItemType} of the template item
+     * @param itemId Used for caching, multiple concurrent template calls for the same itemId will return the same template
+     * @param templateOptions
+     * @param templateColumns Additional columns to be fetched, will be stored in the template - warning - the Template won't have values for those columns
+     * @param entryParentOrParentItemType An optional {@link EntryParentNull entry parent} or {@link ItemType parent itemType}, if the parent is passed the templateColumns will be expanded with the proper link columns (Through {@link ColumnUtil.getColumnsFromLink ColumnUtil.getColumnsFromLink})
+     *
+     * @example
+     * ```
+     *  const parent: EntryParent = {
+     *      itemType: 'Functie',
+     *      itemId: 10,
+     *  };
+     *
+     *  return core.templateCache
+     *      .fetchTemplate(
+     *          'Planningpersoneel',
+     *          undefined,
+     *          {},
+     *          {},
+     *          parent,
+     *      )
+     *      .then(
+     *          (template: Template<'Planningpersoneel'>) => {
+     *              const changesDelta = transaction.createChangesDelta();
+     *
+     *              for (const itemResource of selectedItems) {
+     *                  changesDelta.setItemCreated(
+     *                      core.keyService.getLocalId(),
+     *                      template.fields,
+     *                      template.columns,
+     *                      parent,
+     *                  );
+     *              }
+     *
+     *              transaction.applyChangesDelta(changesDelta);
+     *          );
+     *  ```
+     */
+    fetchTemplate<ItemTypeType extends ItemType>(itemType: ItemTypeType, itemId?: ItemId, templateOptions?: any, templateColumns?: any, entryParentOrParentItemType?: EntryParentNull | ItemType): PromiseInterface<Template<ItemTypeType>>;
+    private fetchTemplateById;
+    private constructTemplateBuffer;
+}

package/dist/types/classes/Util.d.ts

@@ -1,30 +1,30 @@
-import { PromiseInterface } from '../types';
-export declare function instantiateOptions(options: {
-    [key: string]: any;
-}, values: object): void;
-export declare function shallowMerge(object: any, defaults: any): any;
-export declare function hasProperties(object: any): boolean;
-export declare function getFirstProperty(object: any): string | null;
-export declare function inArray(needle: any, haystack: any): boolean;
-export declare function filterArray<T>(source: T[], callback: (elem: T) => boolean): boolean;
-export declare function emptyArray(array: any): void;
-export declare function pathExists(source: any, path: any): boolean;
-export declare function createPath<T>(object: any, path: Array<number | string>, defaults: any[]): T;
-export declare function getPath(object: {}, path: Array<number | string>, create?: boolean): any;
-export declare function extend(dst: any, ...args: any[]): any;
-export declare function merge(dst: any, ...args: any[]): any;
-export declare function isObject(value: any): boolean;
-export declare function isBlankObject(value: any): boolean;
-export declare function isString(value: any): boolean;
-export declare function isNumber(value: any): boolean;
-export declare function isDate(value: any): boolean;
-export declare const isArray: (arg: any) => arg is any[];
-export declare function isFunction<T>(value: any): value is T;
-export declare function isPromiseLike<T = any>(obj: any): obj is PromiseInterface<T>;
-export declare function isRegExp(value: any): boolean;
-export declare function isBoolean(value: any): boolean;
-export declare function isElement(node: any): boolean;
-export declare function isWindow(obj: any): boolean;
-export declare function isDefined(value: any): boolean;
-export declare function equals(o1: any, o2: any): boolean;
-export declare function copy(source: any, destination?: any, maxDepth?: any): any;
+import { PromiseInterface } from '../types';
+export declare function instantiateOptions(options: {
+    [key: string]: any;
+}, values: object): void;
+export declare function shallowMerge(object: any, defaults: any): any;
+export declare function hasProperties(object: any): boolean;
+export declare function getFirstProperty(object: any): string | null;
+export declare function inArray(needle: any, haystack: any): boolean;
+export declare function filterArray<T>(source: T[], callback: (elem: T) => boolean): boolean;
+export declare function emptyArray(array: any): void;
+export declare function pathExists(source: any, path: any): boolean;
+export declare function createPath<T>(object: any, path: Array<number | string>, defaults: any[]): T;
+export declare function getPath(object: {}, path: Array<number | string>, create?: boolean): any;
+export declare function extend(dst: any, ...args: any[]): any;
+export declare function merge(dst: any, ...args: any[]): any;
+export declare function isObject(value: any): boolean;
+export declare function isBlankObject(value: any): boolean;
+export declare function isString(value: any): boolean;
+export declare function isNumber(value: any): boolean;
+export declare function isDate(value: any): boolean;
+export declare const isArray: (arg: any) => arg is any[];
+export declare function isFunction<T>(value: any): value is T;
+export declare function isPromiseLike<T = any>(obj: any): obj is PromiseInterface<T>;
+export declare function isRegExp(value: any): boolean;
+export declare function isBoolean(value: any): boolean;
+export declare function isElement(node: any): boolean;
+export declare function isWindow(obj: any): boolean;
+export declare function isDefined(value: any): boolean;
+export declare function equals(o1: any, o2: any): boolean;
+export declare function copy(source: any, destination?: any, maxDepth?: any): any;

package/dist/types/classes/cache/AbstractCache.d.ts

@@ -1,101 +1,101 @@
-import { RmCore } from '../../core';
-import { AbstractCacheDependencyInterface } from '../../interfaces';
-import { CollectionEntry, ItemEntry } from '../../models';
-import { EntryParentNull, FieldMap, ItemIdConversionMap, ItemType, PromiseInterface } from '../../types';
-import { ChangesDelta } from '../ChangesDelta';
-import { ChangesDeltaResult } from '../ChangesDeltaBase';
-import { OnAfterCreateCallback } from '../ChangesProcessor';
-import { CollectionCache } from '../CollectionCache';
-import { InternalChangesDelta } from '../InternalChangesDelta';
-import { ItemCache } from '../ItemCache';
-import { ServerCache } from './server/ServerCache';
-import { ServerCollectionHandler } from './server/ServerCollectionHandler';
-import { ServerItemEntryChanges, ServerItemHandler } from './server/ServerItemHandler';
-import { TransactionCache } from './transaction/TransactionCache';
-import { TransactionCollectionHandler } from './transaction/TransactionCollectionHandler';
-import { TransactionItemEntryChanges, TransactionItemHandler } from './transaction/TransactionItemHandler';
-import { TransactionValidatorFactory } from './transaction/TransactionValidator';
-export declare abstract class AbstractCache {
-    protected dependencies: AbstractCacheDependencyInterface;
-    core: RmCore;
-    children: TransactionCache[];
-    readonly itemHandler: TransactionItemHandler | ServerItemHandler;
-    readonly collectionHandler: TransactionCollectionHandler | ServerCollectionHandler;
-    parent: AbstractCache | null;
-    protected constructor(dependencies: AbstractCacheDependencyInterface, core: RmCore);
-    createChild(id?: string, validatorFactory?: TransactionValidatorFactory): TransactionCache;
-    onChildDestroy(cache: TransactionCache): void;
-    abstract getLocalCollectionEntryByQueryString(itemType: ItemType, queryString: string): CollectionEntry | undefined;
-    /**
-     * @description
-     * Returns {@link ItemEntry ItemEntries} that fit the collection's query, copies over the collectionChanges on all transactions in the chain.
-     */
-    abstract getCollectionChangesRecursively(collectionEntryId: CollectionEntry['id']): ItemEntry[];
-    /**
-     * @description
-     * Returns this transaction and all parents
-     */
-    getTransactionChain(): AbstractCache[];
-    /**
-     * @description
-     * Returns the {@link TransactionCollectionHandler.entries CollectionCache} of the transaction
-     */
-    getCurrentCollectionEntryCache(): CollectionCache;
-    /**
-     * @description
-     * Returns the {@link TransactionItemHandler.entries ItemCache} of the transaction
-     */
-    getCurrentItemEntryCache(): ItemCache;
-    abstract getServerCache(): ServerCache;
-    abstract getLocalItemEntry(itemEntryId: ItemEntry['id']): ItemEntry | undefined;
-    abstract getLocalItemEntryByItemId(itemType: ItemType, itemId: ItemEntry['itemId']): ItemEntry | undefined;
-    abstract getLocalCollectionEntry(collectionEntryId: CollectionEntry['id']): CollectionEntry | undefined;
-    /**
-     * @description
-     * Applies changes from a child transaction to a parent
-     */
-    abstract applyChangesFromChild(transaction: TransactionCache, breakUpByParent?: boolean, onAfterCreateCallback?: OnAfterCreateCallback): PromiseInterface<ItemIdConversionMap>;
-    /**
-     * @description
-     * Called by a parent transaction, propagates changes downwards to all child caches
-     *
-     * @remarks
-     * - Should only be used by the core
-     *
-     * todo[cache] Should we refetch derived values just like in applyChangesDelta ?
-     *
-     * @internal
-     */
-    abstract applyChangesFromParent(internalChangesDelta: InternalChangesDelta, isCalledAfterApiSave: boolean, isCalledAfterSocketUpdate: boolean): void;
-    abstract getParent<ItemTypeType extends ItemType = any>(itemEntry: ItemEntry<ItemTypeType>, fromInitial?: boolean, providedFields?: FieldMap<ItemTypeType>): EntryParentNull;
-    abstract getItemChangesRecursively(itemEntryId: ItemEntry['id'], copyFields?: boolean): FieldMap;
-    abstract getLocalItemEntryChangesTuple(itemEntryId: ItemEntry['id']): any;
-    /**
-     * @description
-     * Because the `itemChanges` object differs between the {@link ServerItemHandler.itemChanges ServerItemHandler} and the {@link TransactionItemHandler.itemChanges TransactionItemHandler} we need a function to normalise those values
-     *
-     * @remarks
-     * - Should only be used by the core
-     *
-     * @internal
-     */
-    abstract getChangesFromItemChanges<ItemTypeType extends ItemType = any>(changesObject: ServerItemEntryChanges<ItemTypeType> | TransactionItemEntryChanges<ItemTypeType>): FieldMap<ItemTypeType>;
-    abstract applyChangesDelta(changesDelta: ChangesDelta): PromiseInterface<ChangesDeltaResult>;
-    protected getParentFromFields<ItemTypeType extends ItemType = any>(itemEntry: ItemEntry<ItemTypeType>, fields: FieldMap<ItemTypeType>): EntryParentNull;
-    /**
-     * @description
-     * Called by applyChangesDelta from ServerCache and TransactionCache. Applies creates, updates and moves, doesn't apply deletes
-     *
-     * @private
-     */
-    protected _applyChangesDelta(changesDelta: ChangesDelta): {
-        result: ChangesDeltaResult;
-        internalChangesDelta: InternalChangesDelta;
-        rollbackFunctions: Array<(changesDelta: ChangesDelta) => void>;
-    };
-    /**
-     * @description
-     * Ensures that for all updated items in the delta the required derived values are present
-     */
-    protected fetchUpdatedDerivedValuesFromDelta(changesDelta: ChangesDelta): PromiseInterface<ItemEntry[][]>;
-}
+import { RmCore } from '../../core';
+import { AbstractCacheDependencyInterface } from '../../interfaces';
+import { CollectionEntry, ItemEntry } from '../../models';
+import { EntryParentNull, FieldMap, ItemIdConversionMap, ItemType, PromiseInterface } from '../../types';
+import { ChangesDelta } from '../ChangesDelta';
+import { ChangesDeltaResult } from '../ChangesDeltaBase';
+import { OnAfterCreateCallback } from '../ChangesProcessor';
+import { CollectionCache } from '../CollectionCache';
+import { InternalChangesDelta } from '../InternalChangesDelta';
+import { ItemCache } from '../ItemCache';
+import { ServerCache } from './server/ServerCache';
+import { ServerCollectionHandler } from './server/ServerCollectionHandler';
+import { ServerItemEntryChanges, ServerItemHandler } from './server/ServerItemHandler';
+import { TransactionCache } from './transaction/TransactionCache';
+import { TransactionCollectionHandler } from './transaction/TransactionCollectionHandler';
+import { TransactionItemEntryChanges, TransactionItemHandler } from './transaction/TransactionItemHandler';
+import { TransactionValidatorFactory } from './transaction/TransactionValidator';
+export declare abstract class AbstractCache {
+    protected dependencies: AbstractCacheDependencyInterface;
+    core: RmCore;
+    children: TransactionCache[];
+    readonly itemHandler: TransactionItemHandler | ServerItemHandler;
+    readonly collectionHandler: TransactionCollectionHandler | ServerCollectionHandler;
+    parent: AbstractCache | null;
+    protected constructor(dependencies: AbstractCacheDependencyInterface, core: RmCore);
+    createChild(id?: string, validatorFactory?: TransactionValidatorFactory): TransactionCache;
+    onChildDestroy(cache: TransactionCache): void;
+    abstract getLocalCollectionEntryByQueryString(itemType: ItemType, queryString: string): CollectionEntry | undefined;
+    /**
+     * @description
+     * Returns {@link ItemEntry ItemEntries} that fit the collection's query, copies over the collectionChanges on all transactions in the chain.
+     */
+    abstract getCollectionChangesRecursively(collectionEntryId: CollectionEntry['id']): ItemEntry[];
+    /**
+     * @description
+     * Returns this transaction and all parents
+     */
+    getTransactionChain(): AbstractCache[];
+    /**
+     * @description
+     * Returns the {@link TransactionCollectionHandler.entries CollectionCache} of the transaction
+     */
+    getCurrentCollectionEntryCache(): CollectionCache;
+    /**
+     * @description
+     * Returns the {@link TransactionItemHandler.entries ItemCache} of the transaction
+     */
+    getCurrentItemEntryCache(): ItemCache;
+    abstract getServerCache(): ServerCache;
+    abstract getLocalItemEntry(itemEntryId: ItemEntry['id']): ItemEntry | undefined;
+    abstract getLocalItemEntryByItemId(itemType: ItemType, itemId: ItemEntry['itemId']): ItemEntry | undefined;
+    abstract getLocalCollectionEntry(collectionEntryId: CollectionEntry['id']): CollectionEntry | undefined;
+    /**
+     * @description
+     * Applies changes from a child transaction to a parent
+     */
+    abstract applyChangesFromChild(transaction: TransactionCache, breakUpByParent?: boolean, onAfterCreateCallback?: OnAfterCreateCallback): PromiseInterface<ItemIdConversionMap>;
+    /**
+     * @description
+     * Called by a parent transaction, propagates changes downwards to all child caches
+     *
+     * @remarks
+     * - Should only be used by the core
+     *
+     * todo[cache] Should we refetch derived values just like in applyChangesDelta ?
+     *
+     * @internal
+     */
+    abstract applyChangesFromParent(internalChangesDelta: InternalChangesDelta, isCalledAfterApiSave: boolean, isCalledAfterSocketUpdate: boolean): void;
+    abstract getParent<ItemTypeType extends ItemType = any>(itemEntry: ItemEntry<ItemTypeType>, fromInitial?: boolean, providedFields?: FieldMap<ItemTypeType>): EntryParentNull;
+    abstract getItemChangesRecursively(itemEntryId: ItemEntry['id'], copyFields?: boolean): FieldMap;
+    abstract getLocalItemEntryChangesTuple(itemEntryId: ItemEntry['id']): any;
+    /**
+     * @description
+     * Because the `itemChanges` object differs between the {@link ServerItemHandler.itemChanges ServerItemHandler} and the {@link TransactionItemHandler.itemChanges TransactionItemHandler} we need a function to normalise those values
+     *
+     * @remarks
+     * - Should only be used by the core
+     *
+     * @internal
+     */
+    abstract getChangesFromItemChanges<ItemTypeType extends ItemType = any>(changesObject: ServerItemEntryChanges<ItemTypeType> | TransactionItemEntryChanges<ItemTypeType>): FieldMap<ItemTypeType>;
+    abstract applyChangesDelta(changesDelta: ChangesDelta): PromiseInterface<ChangesDeltaResult>;
+    protected getParentFromFields<ItemTypeType extends ItemType = any>(itemEntry: ItemEntry<ItemTypeType>, fields: FieldMap<ItemTypeType>): EntryParentNull;
+    /**
+     * @description
+     * Called by applyChangesDelta from ServerCache and TransactionCache. Applies creates, updates and moves, doesn't apply deletes
+     *
+     * @private
+     */
+    protected _applyChangesDelta(changesDelta: ChangesDelta): {
+        result: ChangesDeltaResult;
+        internalChangesDelta: InternalChangesDelta;
+        rollbackFunctions: Array<(changesDelta: ChangesDelta) => void>;
+    };
+    /**
+     * @description
+     * Ensures that for all updated items in the delta the required derived values are present
+     */
+    protected fetchUpdatedDerivedValuesFromDelta(changesDelta: ChangesDelta): PromiseInterface<ItemEntry[][]>;
+}

package/dist/types/classes/cache/CollectionHandlerBase.d.ts

@@ -1,68 +1,68 @@
-import { CollectionCacheFactory, RequestColumnExpansionFactory } from '../../factories';
-import { CollectionEntry, CollectionEntryOptions, ItemEntry } from '../../models';
-import { ApiQuery, ApiRequestColumn, CollectionEntryParentIdMap, CollectionResourceParentIdMap, ItemId, ItemType, PromiseInterface, QueryCallback } from '../../types';
-import { CollectionCache } from '../CollectionCache';
-import { CollectionEntryService } from '../CollectionEntryService';
-import { CollectionMatcher } from '../CollectionMatcher';
-import { ColumnUtil } from '../ColumnUtil';
-import { AbstractCache } from './AbstractCache';
-export declare abstract class CollectionHandlerBase {
-    protected collectionEntryService: CollectionEntryService;
-    protected columnUtil: ColumnUtil;
-    protected requestColumnExpansionFactory: RequestColumnExpansionFactory;
-    protected transaction: AbstractCache;
-    entries: CollectionCache;
-    collectionChanges: {
-        [itemType: string]: {
-            [queryString: string]: ItemEntry[];
-        };
-    };
-    protected constructor(collectionEntryService: CollectionEntryService, columnUtil: ColumnUtil, requestColumnExpansionFactory: RequestColumnExpansionFactory, collectionCacheFactory: CollectionCacheFactory, transaction: AbstractCache);
-    setCollectionChanges<ItemTypeType extends ItemType>(itemType: ItemTypeType, queryString: string, itemEntries: Array<ItemEntry<ItemTypeType>>): void;
-    getCollectionChanges<ItemTypeType extends ItemType>(itemType: ItemTypeType, queryString: string): undefined | Array<ItemEntry<ItemTypeType>>;
-    /**
-     * @description
-     * Creates a new {@link CollectionEntry CollectionEntry} and stores it in this transaction's {@link CollectionCache CollectionCache}
-     */
-    createCollectionEntry<ItemTypeType extends ItemType>(itemType: ItemTypeType, options: CollectionEntryOptions): CollectionEntry<ItemTypeType>;
-    /**
-     * @description
-     * Creates a {@link CollectionMatcher CollectionMatcher} with the transaction's collections
-     */
-    abstract getCollectionMatcher(): CollectionMatcher;
-    /**
-     * @description
-     * Fetches a {@link CollectionEntry CollectionEntry} with the given options
-     */
-    abstract fetchCollectionEntry<ItemTypeType extends ItemType>(itemType: ItemTypeType, options: CollectionEntryOptions): PromiseInterface<CollectionEntry<ItemTypeType>>;
-    /**
-     * @description
-     * Fetches collections linked to the passed parents
-     */
-    abstract fetchLinkedCollectionEntries<ItemTypeType extends ItemType>(parentType: ItemType, parentIdArray: ItemId[] | (() => ItemId[]), itemType: ItemTypeType, options: CollectionEntryOptions): PromiseInterface<CollectionEntryParentIdMap<ItemTypeType>>;
-    /**
-     * @description
-     * Expands the items in the collections with the passed columns
-     */
-    abstract expandCollectionEntries<ItemTypeType extends ItemType>(parentType: ItemType, itemType: ItemTypeType, collections: CollectionResourceParentIdMap, newColumns: ApiRequestColumn[]): PromiseInterface<CollectionResourceParentIdMap>;
-    /**
-     * @description
-     * Extends the collections' {@link CollectionEntry.queryParams queryParams} and {@link CollectionEntry.query queries} and fetches the {@link ItemEntry ItemEntries} with the new queries
-     */
-    abstract extendCollectionEntries<T extends CollectionResourceParentIdMap>(parentType: ItemType, itemType: ItemType, options: CollectionEntryOptions, queryCallback: QueryCallback, collections: T): PromiseInterface<void>;
-    /**
-     * @description
-     * Adds the passed {@link ItemEntry ItemEntries} to the collection's changes on the transaction,
-     * will skip the ItemEntry if the `skipEntryFilterFn` callback returns `true`
-     */
-    protected _addItemEntriesToCollectionChanges<CollectionEntryType extends CollectionEntry>(collectionEntry: CollectionEntryType, itemEntries: Array<ItemEntry<CollectionEntryType['itemType']>>, skipEntryFilterFn: (temEntry: ItemEntry) => boolean, isCalledAfterSocketUpdate: boolean): void;
-    protected abstract handleAddedItemEntriesCallback<CollectionEntryType extends CollectionEntry>(collectionEntry: CollectionEntryType, addedEntries: Array<ItemEntry<CollectionEntryType['itemType']>>, isCalledAfterSocketUpdate: boolean): void;
-    removeItemEntriesFromCollectionChanges(collectionEntry: CollectionEntry, idArray: ItemId[], isCalledAfterSocketUpdate?: boolean): void | never[];
-    protected abstract handleRemovedItemEntriesCallback<CollectionEntryType extends CollectionEntry>(collectionEntry: CollectionEntryType, removedItemEntries: Array<ItemEntry<CollectionEntryType['itemType']>>, isCalledAfterSocketUpdate: boolean): void;
-    /**
-     * @description
-     * Expands the option's {@link CollectionEntryOptions.columns columns} with the columns required for the {@link CollectionMatcher CollectionMatcher} to function.
-     * Data fetched for a parent transaction might also fit in a child transaction, so those {@link CollectionEntryOptions.queryColumns queryColumns} should also be taken into account
-     */
-    protected expandColumnsWithQueryColumns(itemType: ItemType, options: CollectionEntryOptions, query: ApiQuery): void;
-}
+import { CollectionCacheFactory, RequestColumnExpansionFactory } from '../../factories';
+import { CollectionEntry, CollectionEntryOptions, ItemEntry } from '../../models';
+import { ApiQuery, ApiRequestColumn, CollectionEntryParentIdMap, CollectionResourceParentIdMap, ItemId, ItemType, PromiseInterface, QueryCallback } from '../../types';
+import { CollectionCache } from '../CollectionCache';
+import { CollectionEntryService } from '../CollectionEntryService';
+import { CollectionMatcher } from '../CollectionMatcher';
+import { ColumnUtil } from '../ColumnUtil';
+import { AbstractCache } from './AbstractCache';
+export declare abstract class CollectionHandlerBase {
+    protected collectionEntryService: CollectionEntryService;
+    protected columnUtil: ColumnUtil;
+    protected requestColumnExpansionFactory: RequestColumnExpansionFactory;
+    protected transaction: AbstractCache;
+    entries: CollectionCache;
+    collectionChanges: {
+        [itemType: string]: {
+            [queryString: string]: ItemEntry[];
+        };
+    };
+    protected constructor(collectionEntryService: CollectionEntryService, columnUtil: ColumnUtil, requestColumnExpansionFactory: RequestColumnExpansionFactory, collectionCacheFactory: CollectionCacheFactory, transaction: AbstractCache);
+    setCollectionChanges<ItemTypeType extends ItemType>(itemType: ItemTypeType, queryString: string, itemEntries: Array<ItemEntry<ItemTypeType>>): void;
+    getCollectionChanges<ItemTypeType extends ItemType>(itemType: ItemTypeType, queryString: string): undefined | Array<ItemEntry<ItemTypeType>>;
+    /**
+     * @description
+     * Creates a new {@link CollectionEntry CollectionEntry} and stores it in this transaction's {@link CollectionCache CollectionCache}
+     */
+    createCollectionEntry<ItemTypeType extends ItemType>(itemType: ItemTypeType, options: CollectionEntryOptions): CollectionEntry<ItemTypeType>;
+    /**
+     * @description
+     * Creates a {@link CollectionMatcher CollectionMatcher} with the transaction's collections
+     */
+    abstract getCollectionMatcher(): CollectionMatcher;
+    /**
+     * @description
+     * Fetches a {@link CollectionEntry CollectionEntry} with the given options
+     */
+    abstract fetchCollectionEntry<ItemTypeType extends ItemType>(itemType: ItemTypeType, options: CollectionEntryOptions): PromiseInterface<CollectionEntry<ItemTypeType>>;
+    /**
+     * @description
+     * Fetches collections linked to the passed parents
+     */
+    abstract fetchLinkedCollectionEntries<ItemTypeType extends ItemType>(parentType: ItemType, parentIdArray: ItemId[] | (() => ItemId[]), itemType: ItemTypeType, options: CollectionEntryOptions): PromiseInterface<CollectionEntryParentIdMap<ItemTypeType>>;
+    /**
+     * @description
+     * Expands the items in the collections with the passed columns
+     */
+    abstract expandCollectionEntries<ItemTypeType extends ItemType>(parentType: ItemType, itemType: ItemTypeType, collections: CollectionResourceParentIdMap, newColumns: ApiRequestColumn[]): PromiseInterface<CollectionResourceParentIdMap>;
+    /**
+     * @description
+     * Extends the collections' {@link CollectionEntry.queryParams queryParams} and {@link CollectionEntry.query queries} and fetches the {@link ItemEntry ItemEntries} with the new queries
+     */
+    abstract extendCollectionEntries<T extends CollectionResourceParentIdMap>(parentType: ItemType, itemType: ItemType, options: CollectionEntryOptions, queryCallback: QueryCallback, collections: T): PromiseInterface<void>;
+    /**
+     * @description
+     * Adds the passed {@link ItemEntry ItemEntries} to the collection's changes on the transaction,
+     * will skip the ItemEntry if the `skipEntryFilterFn` callback returns `true`
+     */
+    protected _addItemEntriesToCollectionChanges<CollectionEntryType extends CollectionEntry>(collectionEntry: CollectionEntryType, itemEntries: Array<ItemEntry<CollectionEntryType['itemType']>>, skipEntryFilterFn: (temEntry: ItemEntry) => boolean, isCalledAfterSocketUpdate: boolean): void;
+    protected abstract handleAddedItemEntriesCallback<CollectionEntryType extends CollectionEntry>(collectionEntry: CollectionEntryType, addedEntries: Array<ItemEntry<CollectionEntryType['itemType']>>, isCalledAfterSocketUpdate: boolean): void;
+    removeItemEntriesFromCollectionChanges(collectionEntry: CollectionEntry, idArray: ItemId[], isCalledAfterSocketUpdate?: boolean): void | never[];
+    protected abstract handleRemovedItemEntriesCallback<CollectionEntryType extends CollectionEntry>(collectionEntry: CollectionEntryType, removedItemEntries: Array<ItemEntry<CollectionEntryType['itemType']>>, isCalledAfterSocketUpdate: boolean): void;
+    /**
+     * @description
+     * Expands the option's {@link CollectionEntryOptions.columns columns} with the columns required for the {@link CollectionMatcher CollectionMatcher} to function.
+     * Data fetched for a parent transaction might also fit in a child transaction, so those {@link CollectionEntryOptions.queryColumns queryColumns} should also be taken into account
+     */
+    protected expandColumnsWithQueryColumns(itemType: ItemType, options: CollectionEntryOptions, query: ApiQuery): void;
+}

package/dist/types/classes/cache/CollectionMatcherCacheProcessor.d.ts

@@ -1,26 +1,26 @@
-import { QueryMatcherFactory } from '../../factories';
-import { CollectionEntry, ItemEntry } from '../../models';
-import { ItemId, ItemType } from '../../types';
-import { ApiRequestService } from '../ApiRequestService';
-import { CollectionMatcher } from '../CollectionMatcher';
-import { AbstractCache } from './AbstractCache';
-export declare type GroupedCollectionMatcherResult<ItemTypeType extends ItemType> = {
-    fitting: Array<ItemEntry<ItemTypeType>>;
-    notFitting: ItemId[];
-    maybe: Array<ItemEntry<ItemTypeType>>;
-};
-/**
- * @description
- * Processes a delta and adds the items to the right collections, this is the ONLY class that should change collection items
- *
- * ------
- *
- * @remark
- * The CollectionMatcherCacheProcessor is allowed to directly access/modify the transaction because it's ONLY called from applyChangesFromParent
- */
-export declare class CollectionMatcherCacheProcessor extends CollectionMatcher {
-    private apiRequestService;
-    constructor(apiRequestService: ApiRequestService, queryMatcherFactory: QueryMatcherFactory, transaction: AbstractCache, getCollectionEntries: (itemType: ItemType) => CollectionEntry[]);
-    removeFromAndAddToCollections(isCalledAfterSocketUpdate?: boolean): void;
-    private groupItemEntries;
-}
+import { QueryMatcherFactory } from '../../factories';
+import { CollectionEntry, ItemEntry } from '../../models';
+import { ItemId, ItemType } from '../../types';
+import { ApiRequestService } from '../ApiRequestService';
+import { CollectionMatcher } from '../CollectionMatcher';
+import { AbstractCache } from './AbstractCache';
+export declare type GroupedCollectionMatcherResult<ItemTypeType extends ItemType> = {
+    fitting: Array<ItemEntry<ItemTypeType>>;
+    notFitting: ItemId[];
+    maybe: Array<ItemEntry<ItemTypeType>>;
+};
+/**
+ * @description
+ * Processes a delta and adds the items to the right collections, this is the ONLY class that should change collection items
+ *
+ * ------
+ *
+ * @remark
+ * The CollectionMatcherCacheProcessor is allowed to directly access/modify the transaction because it's ONLY called from applyChangesFromParent
+ */
+export declare class CollectionMatcherCacheProcessor extends CollectionMatcher {
+    private apiRequestService;
+    constructor(apiRequestService: ApiRequestService, queryMatcherFactory: QueryMatcherFactory, transaction: AbstractCache, getCollectionEntries: (itemType: ItemType) => CollectionEntry[]);
+    removeFromAndAddToCollections(isCalledAfterSocketUpdate?: boolean): void;
+    private groupItemEntries;
+}