@rentman/rm-core 12.0.4 → 12.0.5-2

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

@@ -1,28 +1,28 @@
-import { PromiseInterface } from '../internal';
-export declare function findIndex<T>(haystack: T[], callback: (item: T) => boolean): number;
-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: string[]): boolean;
-export declare function createPath<T>(object: any, path: (number | string)[], defaults: any[]): T;
-export declare function getPath(object: {}, path: (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: object, destination?: object, maxDepth?: any): any;
+import { PromiseInterface } from '../internal';
+export declare function findIndex<T>(haystack: T[], callback: (item: T) => boolean): number;
+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: string[]): boolean;
+export declare function createPath<T>(object: any, path: (number | string)[], defaults: any[]): T;
+export declare function getPath(object: {}, path: (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: object, destination?: object, maxDepth?: any): any;

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

@@ -1,92 +1,85 @@
-import { ApiEnumItemType } from '@rentman/backend-types';
-import { RmCore } from '../../core';
-import { AbstractCacheDependencyInterface, ApiRequestColumnArray, CachedQueryItem, ChangesDelta, ChangesDeltaBase, ChangesDeltaResult, CollectionQuery, CollectionResourceParentIdMap, EntryParentNull, FieldMap, InternalChangesDelta, ItemCache, ItemEntry, ItemEntryChangesTuple, ItemHandlerBase, ItemIdConversionMap, OnAfterCreateCallback, ParentChangesDelta, PromiseInterface, ServerCache, ServerCachedQueryHandler, TransactionCache, TransactionCachedQueryHandler, TransactionValidatorFactory } from '../../internal';
-export declare type TransactionOptions = {
-    /**
-     * @description
-     * Sets the TransactionCache to 'transparent' mode, whenever {@link AbstractCache.createChild createChild} is called it will actually be called on the parent
-     */
-    transparent: boolean;
-};
-export declare abstract class AbstractCache {
-    dependencies: AbstractCacheDependencyInterface;
-    core: RmCore;
-    children: TransactionCache[];
-    readonly itemHandler: ItemHandlerBase;
-    readonly cachedQueryHandler: TransactionCachedQueryHandler | ServerCachedQueryHandler;
-    parent: AbstractCache | null;
-    protected constructor(dependencies: AbstractCacheDependencyInterface, core: RmCore);
-    abstract createChild(id?: string, validatorFactory?: TransactionValidatorFactory, options?: TransactionOptions): TransactionCache;
-    onChildDestroy(cache: TransactionCache): void;
-    /**
-     * @description
-     * Expands the items in the collections with the passed columns
-     *
-     * todo[limit] move to TransactionCache ?
-     */
-    abstract expandCollectionResources<ItemTypeType extends ApiEnumItemType>(itemType: ItemTypeType, collections: CollectionResourceParentIdMap<ItemTypeType>, newColumns: ApiRequestColumnArray): PromiseInterface<CollectionResourceParentIdMap>;
-    /**
-     * @description
-     * Returns {@link ItemEntry ItemEntries} that fit the collection's query, copies over the collectionChanges on all transactions in the chain.
-     */
-    abstract getCollectionChangesRecursively<ItemTypeType extends ApiEnumItemType>(itemType: ItemTypeType, parsedQuery: CollectionQuery): CachedQueryItem<ItemTypeType> | undefined;
-    /**
-     * @description
-     * Returns this transaction and all parents
-     */
-    getTransactionChain(includeServerCache: false): TransactionCache[];
-    getTransactionChain(includeServerCache?: true): AbstractCache[];
-    /**
-     * @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: ApiEnumItemType, itemId: ItemEntry['itemId']): ItemEntry | 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(parentChangesDelta: ParentChangesDelta, isCalledAfterSocketUpdate: boolean): void;
-    abstract getParent<ItemTypeType extends ApiEnumItemType = any>(itemEntry: ItemEntry<ItemTypeType>, fromInitial?: boolean, providedFields?: FieldMap<ItemTypeType>): EntryParentNull;
-    abstract getLocalItemEntryChangesTuple<ItemTypeType extends ApiEnumItemType>(itemEntryId: ItemEntry<ItemTypeType>['id']): ItemEntryChangesTuple<ItemTypeType>;
-    abstract applyChangesDelta(changesDelta: ChangesDelta): PromiseInterface<ChangesDeltaResult>;
-    /**
-     * Differs from {@link getParent getParent} that it only does minimal field lookups (but you cannot provide it with fields) instead of doing {@link ItemHandlerBase.collectFields collectFields}
-     * todo: clean this up some time (merge the 2 functions)
-     *
-     * @param itemEntry
-     */
-    getParentFast(itemEntry: ItemEntry): EntryParentNull;
-    protected getParentFromFields<ItemTypeType extends ApiEnumItemType = 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 | InternalChangesDelta): {
-        result: ChangesDeltaResult;
-        parentChangesDelta: ParentChangesDelta;
-        matchingDelta: ParentChangesDelta;
-        undoFunctions: ((changesDelta: InternalChangesDelta) => void)[];
-    };
-    /**
-     * @description
-     * Ensures that for all updated items in the delta the required derived values are present
-     */
-    protected fetchUpdatedDerivedValuesFromDelta(changesDelta: ChangesDeltaBase): PromiseInterface<void>;
-}
+import { ApiEnumItemType } from '@rentman/backend-types';
+import { RmCore } from '../../core';
+import { AbstractCacheDependencyInterface, ApiRequestColumnArray, CachedQueryItem, ChangesDelta, ChangesDeltaBase, ChangesDeltaResult, CollectionQuery, CollectionResourceParentIdMap, EntryParentNull, FieldMap, InternalChangesDelta, ItemCache, ItemEntry, ItemEntryChangesTuple, ItemHandlerBase, ItemIdConversionMap, OnAfterCreateCallback, ParentChangesDelta, PromiseInterface, ServerCache, ServerCachedQueryHandler, TransactionCache, TransactionCachedQueryHandler, TransactionValidatorFactory } from '../../internal';
+export declare type TransactionOptions = {
+    /**
+     * @description
+     * Sets the TransactionCache to 'transparent' mode, whenever {@link AbstractCache.createChild createChild} is called it will actually be called on the parent
+     */
+    transparent: boolean;
+};
+export declare abstract class AbstractCache {
+    dependencies: AbstractCacheDependencyInterface;
+    core: RmCore;
+    children: TransactionCache[];
+    readonly itemHandler: ItemHandlerBase;
+    readonly cachedQueryHandler: TransactionCachedQueryHandler | ServerCachedQueryHandler;
+    parent: AbstractCache | null;
+    protected constructor(dependencies: AbstractCacheDependencyInterface, core: RmCore);
+    abstract createChild(id?: string, validatorFactory?: TransactionValidatorFactory, options?: TransactionOptions): TransactionCache;
+    onChildDestroy(cache: TransactionCache): void;
+    /**
+     * @description
+     * Expands the items in the collections with the passed columns
+     *
+     * todo[limit] move to TransactionCache ?
+     */
+    abstract expandCollectionResources<ItemTypeType extends ApiEnumItemType>(itemType: ItemTypeType, collections: CollectionResourceParentIdMap<ItemTypeType>, newColumns: ApiRequestColumnArray): PromiseInterface<CollectionResourceParentIdMap>;
+    /**
+     * @description
+     * Returns {@link ItemEntry ItemEntries} that fit the collection's query, copies over the collectionChanges on all transactions in the chain.
+     */
+    abstract getCollectionChangesRecursively<ItemTypeType extends ApiEnumItemType>(itemType: ItemTypeType, parsedQuery: CollectionQuery): CachedQueryItem<ItemTypeType> | undefined;
+    /**
+     * @description
+     * Returns this transaction and all parents
+     */
+    getTransactionChain(includeServerCache: false): TransactionCache[];
+    getTransactionChain(includeServerCache?: true): AbstractCache[];
+    /**
+     * @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: ApiEnumItemType, itemId: ItemEntry['itemId']): ItemEntry | 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(parentChangesDelta: ParentChangesDelta, isCalledAfterSocketUpdate: boolean): void;
+    getParent<ItemTypeType extends ApiEnumItemType = any>(itemEntry: ItemEntry<ItemTypeType>, fromInitial?: boolean): EntryParentNull;
+    abstract getLocalItemEntryChangesTuple<ItemTypeType extends ApiEnumItemType>(itemEntryId: ItemEntry<ItemTypeType>['id']): ItemEntryChangesTuple<ItemTypeType>;
+    abstract applyChangesDelta(changesDelta: ChangesDelta): PromiseInterface<ChangesDeltaResult>;
+    protected getParentFromFields<ItemTypeType extends ApiEnumItemType = 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 | InternalChangesDelta): {
+        result: ChangesDeltaResult;
+        parentChangesDelta: ParentChangesDelta;
+        matchingDelta: ParentChangesDelta;
+        undoFunctions: ((changesDelta: InternalChangesDelta) => void)[];
+    };
+    /**
+     * @description
+     * Ensures that for all updated items in the delta the required derived values are present
+     */
+    protected fetchUpdatedDerivedValuesFromDelta(changesDelta: ChangesDeltaBase): PromiseInterface<void>;
+}

package/dist/types/src/classes/cache/CachedQueryHandlerBase.d.ts

@@ -1,70 +1,70 @@
-import { ApiEnumItemType } from '@rentman/backend-types';
-import { AbstractCache, ApiQuery, ApiRequestLimit, CachedQueryItem, CollectionEntryService, CollectionOptions, CollectionQuery, ColumnUtil, EntryParentNull, ItemEntry, ParentItemMap, PromiseInterface, PromiseLibraryInterface, RequestColumnExpansionFactory, RequestColumnsOperationsCache, RequestColumnsOperationsCacheFactory, RequestColumnsTuple } from '../../internal';
-export declare type CachedQueryItemTree<ItemTypeType extends ApiEnumItemType = any> = {
-    item: CachedQueryItem<ItemTypeType>;
-    children: ParentItemMap<CachedQueryItemTree> | null;
-};
-/**
- * We're using a subset of the collection options here, because whenever we access the columns, we'd want to do it
- * through the columns operations cache.
- */
-export declare type CachedQueryOptions = {
-    limit: ApiRequestLimit | null;
-    preventCaching: boolean;
-    usePrivateBuffer: boolean;
-    parent: EntryParentNull;
-};
-export declare abstract class CachedQueryHandlerBase {
-    protected collectionEntryService: CollectionEntryService;
-    protected columnUtil: ColumnUtil;
-    protected requestColumnExpansionFactory: RequestColumnExpansionFactory;
-    protected requestColumnsOperationsCacheFactory: RequestColumnsOperationsCacheFactory;
-    protected promiseService: PromiseLibraryInterface;
-    protected transaction: AbstractCache;
-    /**
-     * @description
-     * Items (per ItemType) that fit in a query
-     *
-     * @remark
-     * Contains the requestColumns so that new items can include these columns (saving requests when they match)
-     */
-    cachedQueries: {
-        [itemType: string]: {
-            [queryString: string]: CachedQueryItem;
-        };
-    };
-    protected constructor(collectionEntryService: CollectionEntryService, columnUtil: ColumnUtil, requestColumnExpansionFactory: RequestColumnExpansionFactory, requestColumnsOperationsCacheFactory: RequestColumnsOperationsCacheFactory, promiseService: PromiseLibraryInterface, transaction: AbstractCache);
-    /**
-     * Every time a cached query item is created, either 'resolve' or 'reject' has to be called on the cached query item.
-     */
-    setCachedQuery<ItemTypeType extends ApiEnumItemType>(itemType: ItemTypeType, parsedQuery: CollectionQuery, requestColumnsTuple: RequestColumnsTuple, itemEntries?: ItemEntry<ItemTypeType>[]): CachedQueryItem<ItemTypeType>;
-    getCachedQueryItems<ItemTypeType extends ApiEnumItemType>(itemType: ItemTypeType, queryString: string): undefined | ItemEntry<ItemTypeType>[];
-    getCachedQueryObjectsByItemType(itemType: ApiEnumItemType): CachedQueryItem[];
-    /**
-     * @description
-     * Fetches collections linked to the passed parents
-     */
-    abstract __fetchItemEntriesByQueryData<ItemTypeType extends ApiEnumItemType>(itemType: ItemTypeType, options: CachedQueryOptions, columnsOperationsCache: RequestColumnsOperationsCache<ItemTypeType>, collectionQuery: CollectionQuery, batchedLinkedToQuery?: CollectionQuery): PromiseInterface<CachedQueryItem<ItemTypeType>>;
-    /**
-     * @description
-     * Removes the passed {@link ItemId ItemIds} from the Transaction's query cache
-     */
-    __removeItemEntriesFromCachedQueries<ItemTypeType extends ApiEnumItemType>(itemType: ItemTypeType, parsedQuery: CollectionQuery, itemEntries: ItemEntry<ItemTypeType>[]): ItemEntry<ItemTypeType>[];
-    abstract __expandCachedQuery<ItemTypeType extends ApiEnumItemType>(itemType: ItemTypeType, queryString: string, columnsOperationsCache: RequestColumnsOperationsCache<ItemTypeType>, usePrivateBuffer: boolean, batchedLinkedToQuery?: CollectionQuery): PromiseInterface<CachedQueryItem<ItemTypeType>>;
-    /**
-     * @description
-     * Expands the option's {@link CollectionOptions.columns columns} with the columns required for the {@link CacheSyncer CacheSyncer} to function.
-     * Data fetched for a parent transaction might also fit in a child transaction, so those {@link CollectionOptions.queryColumns queryColumns} should also be taken into account
-     */
-    expandColumnsWithQueryColumns(itemType: ApiEnumItemType, options: CollectionOptions, query: ApiQuery): void;
-    /**
-     * Every time a cached query item is created, either 'resolve' or 'reject' has to be called on the cached query item.
-     */
-    protected constructCachedQuery<ItemTypeType extends ApiEnumItemType>(itemType: ItemTypeType, parsedQuery: CollectionQuery, itemEntries: ItemEntry<ItemTypeType>[], requestColumnsTuple: RequestColumnsTuple): CachedQueryItem<ItemTypeType>;
-    /**
-     * @description
-     * Adds the passed {@link ItemEntry ItemEntries} to the Transaction's query cache,
-     * will skip the ItemEntry if the `skipEntryFilterFn` callback returns `true`
-     */
-    protected __addItemEntriesToCachedQueries<ItemTypeType extends ApiEnumItemType>(itemType: ItemTypeType, parsedQuery: CollectionQuery, itemEntries: ItemEntry<ItemTypeType>[], skipEntryFilterFn: (temEntry: ItemEntry) => boolean): void;
-}
+import { ApiEnumItemType } from '@rentman/backend-types';
+import { AbstractCache, ApiQuery, ApiRequestLimit, CachedQueryItem, CollectionEntryService, CollectionOptions, CollectionQuery, ColumnUtil, EntryParentNull, ItemEntry, ParentItemMap, PromiseInterface, PromiseLibraryInterface, RequestColumnExpansionFactory, RequestColumnsOperationsCache, RequestColumnsOperationsCacheFactory, RequestColumnsTuple } from '../../internal';
+export declare type CachedQueryItemTree<ItemTypeType extends ApiEnumItemType = any> = {
+    item: CachedQueryItem<ItemTypeType>;
+    children: ParentItemMap<CachedQueryItemTree> | null;
+};
+/**
+ * We're using a subset of the collection options here, because whenever we access the columns, we'd want to do it
+ * through the columns operations cache.
+ */
+export declare type CachedQueryOptions = {
+    limit: ApiRequestLimit | null;
+    preventCaching: boolean;
+    usePrivateBuffer: boolean;
+    parent: EntryParentNull;
+};
+export declare abstract class CachedQueryHandlerBase {
+    protected collectionEntryService: CollectionEntryService;
+    protected columnUtil: ColumnUtil;
+    protected requestColumnExpansionFactory: RequestColumnExpansionFactory;
+    protected requestColumnsOperationsCacheFactory: RequestColumnsOperationsCacheFactory;
+    protected promiseService: PromiseLibraryInterface;
+    protected transaction: AbstractCache;
+    /**
+     * @description
+     * Items (per ItemType) that fit in a query
+     *
+     * @remark
+     * Contains the requestColumns so that new items can include these columns (saving requests when they match)
+     */
+    cachedQueries: {
+        [itemType: string]: {
+            [queryString: string]: CachedQueryItem;
+        };
+    };
+    protected constructor(collectionEntryService: CollectionEntryService, columnUtil: ColumnUtil, requestColumnExpansionFactory: RequestColumnExpansionFactory, requestColumnsOperationsCacheFactory: RequestColumnsOperationsCacheFactory, promiseService: PromiseLibraryInterface, transaction: AbstractCache);
+    /**
+     * Every time a cached query item is created, either 'resolve' or 'reject' has to be called on the cached query item.
+     */
+    setCachedQuery<ItemTypeType extends ApiEnumItemType>(itemType: ItemTypeType, parsedQuery: CollectionQuery, requestColumnsTuple: RequestColumnsTuple, itemEntries?: ItemEntry<ItemTypeType>[]): CachedQueryItem<ItemTypeType>;
+    getCachedQueryItems<ItemTypeType extends ApiEnumItemType>(itemType: ItemTypeType, queryString: string): undefined | ItemEntry<ItemTypeType>[];
+    getCachedQueryObjectsByItemType(itemType: ApiEnumItemType): CachedQueryItem[];
+    /**
+     * @description
+     * Fetches collections linked to the passed parents
+     */
+    abstract __fetchItemEntriesByQueryData<ItemTypeType extends ApiEnumItemType>(itemType: ItemTypeType, options: CachedQueryOptions, columnsOperationsCache: RequestColumnsOperationsCache<ItemTypeType>, collectionQuery: CollectionQuery, batchedLinkedToQuery?: CollectionQuery): PromiseInterface<CachedQueryItem<ItemTypeType>>;
+    /**
+     * @description
+     * Removes the passed {@link ItemId ItemIds} from the Transaction's query cache
+     */
+    __removeItemEntriesFromCachedQueries<ItemTypeType extends ApiEnumItemType>(itemType: ItemTypeType, parsedQuery: CollectionQuery, itemEntries: ItemEntry<ItemTypeType>[]): ItemEntry<ItemTypeType>[];
+    abstract __expandCachedQuery<ItemTypeType extends ApiEnumItemType>(itemType: ItemTypeType, queryString: string, columnsOperationsCache: RequestColumnsOperationsCache<ItemTypeType>, usePrivateBuffer: boolean, batchedLinkedToQuery?: CollectionQuery): PromiseInterface<CachedQueryItem<ItemTypeType>>;
+    /**
+     * @description
+     * Expands the option's {@link CollectionOptions.columns columns} with the columns required for the {@link CacheSyncer CacheSyncer} to function.
+     * Data fetched for a parent transaction might also fit in a child transaction, so those {@link CollectionOptions.queryColumns queryColumns} should also be taken into account
+     */
+    expandColumnsWithQueryColumns(itemType: ApiEnumItemType, options: CollectionOptions, query: ApiQuery): void;
+    /**
+     * Every time a cached query item is created, either 'resolve' or 'reject' has to be called on the cached query item.
+     */
+    protected constructCachedQuery<ItemTypeType extends ApiEnumItemType>(itemType: ItemTypeType, parsedQuery: CollectionQuery, itemEntries: ItemEntry<ItemTypeType>[], requestColumnsTuple: RequestColumnsTuple): CachedQueryItem<ItemTypeType>;
+    /**
+     * @description
+     * Adds the passed {@link ItemEntry ItemEntries} to the Transaction's query cache,
+     * will skip the ItemEntry if the `skipEntryFilterFn` callback returns `true`
+     */
+    protected __addItemEntriesToCachedQueries<ItemTypeType extends ApiEnumItemType>(itemType: ItemTypeType, parsedQuery: CollectionQuery, itemEntries: ItemEntry<ItemTypeType>[], skipEntryFilterFn: (temEntry: ItemEntry) => boolean): void;
+}

package/dist/types/src/classes/cache/ItemHandlerBase.d.ts

@@ -1,107 +1,107 @@
-import { ApiEnumItemType, ItemId } from '@rentman/backend-types';
-import { AbstractCache, ApiFormatter, ApiQuery, ChangesDeltaBase, ChangesDeltaItemCreateDelta, ChangesDeltaItemUpdateDelta, ColumnInfo, ColumnUtil, ErrorHandlerInterface, FieldMap, ItemCache, ItemCacheFactory, ItemEntry, ItemEntryFactory, ItemEntryOptions, ItemTypeColumnId, PromiseInterface, PromiseLibraryInterface, RequestColumnExpansionFactory } from '../../internal';
-export declare enum ItemCacheStatus {
-    CACHED = "cached",
-    NOT_CACHED = "not_cached",
-    NO_CHANGES = "no_changes"
-}
-export interface ItemEntryChangesTuple<ItemTypeType extends ApiEnumItemType> {
-    entry: ItemEntry<ItemTypeType>;
-    changes: FieldMap<ItemTypeType>;
-}
-export declare type ProcessItemEntryChangesResult<ItemTypeType extends ApiEnumItemType> = {
-    status: ItemCacheStatus.NO_CHANGES | ItemCacheStatus.NOT_CACHED;
-    previous: {
-        rollback: null;
-        complete: null | FieldMap<ItemTypeType>;
-    };
-} | {
-    status: ItemCacheStatus.CACHED;
-    previous: {
-        rollback: Partial<FieldMap<ItemTypeType>>;
-        complete: null | FieldMap<ItemTypeType>;
-    };
-};
-export declare abstract class ItemHandlerBase {
-    protected columnUtil: ColumnUtil;
-    protected apiFormatter: ApiFormatter;
-    protected itemEntryFactory: ItemEntryFactory;
-    protected promiseService: PromiseLibraryInterface;
-    protected errorHandler: ErrorHandlerInterface;
-    protected requestColumnExpansionFactory: RequestColumnExpansionFactory;
-    protected transaction: AbstractCache;
-    readonly entries: ItemCache;
-    itemChanges: {
-        [itemEntryId: number]: FieldMap;
-    };
-    protected constructor(columnUtil: ColumnUtil, apiFormatter: ApiFormatter, itemEntryFactory: ItemEntryFactory, promiseService: PromiseLibraryInterface, errorHandler: ErrorHandlerInterface, requestColumnExpansionFactory: RequestColumnExpansionFactory, itemCacheFactory: ItemCacheFactory, transaction: AbstractCache);
-    lookUpItemField<ItemTypeType extends ApiEnumItemType, ColumnId extends ItemTypeColumnId<ItemTypeType>>(entry: ItemEntry<ItemTypeType>, columnId: ColumnId): undefined | FieldMap<ItemTypeType>[ColumnId];
-    collectFields<ItemTypeType extends ApiEnumItemType>(itemEntry: ItemEntry<ItemTypeType>): FieldMap<ItemTypeType>;
-    /**
-     * @description
-     * Copies the passed ItemEntryChanges into a format the implementing ItemHandler can put in his ItemChanges
-     * @param itemEntryChanges
-     * @param entry
-     */
-    copyTransactionItemEntryChanges<ItemTypeType extends ApiEnumItemType>(itemEntryChanges: FieldMap<ItemTypeType>, entry: ItemEntry<ItemTypeType>): FieldMap<ItemTypeType>;
-    /**
-     * @description
-     * Fetches the ItemEntries for the given query, does not look in the cache, since we don't know which ItemIds belong to the query !
-     */
-    abstract fetchItemEntriesByQuery<ItemTypeType extends ApiEnumItemType>(itemType: ItemTypeType, query: ApiQuery, entryOptions: ItemEntryOptions): PromiseInterface<ItemEntry<ItemTypeType>[]>;
-    /**
-     * @description
-     * Fetches the ItemEntries for the given ItemIds
-     */
-    abstract fetchItemEntries<ItemTypeType extends ApiEnumItemType>(itemType: ItemTypeType, itemIds: ItemId[], options: ItemEntryOptions): PromiseInterface<ItemEntry<ItemTypeType>[]>;
-    /**
-     * @description
-     * Fetches an ItemEntry with the given itemId
-     */
-    abstract fetchItemEntry<ItemTypeType extends ApiEnumItemType>(itemType: ItemTypeType, itemId: ItemId, options: ItemEntryOptions, isRoot?: boolean): PromiseInterface<ItemEntry<ItemTypeType>>;
-    /**
-     * @description
-     * Processes the passed {@link ChangesDeltaItemUpdateDelta update delta} on the transaction, if there are no {@link TransactionItemHandler.itemChanges itemChanges} the new values will not be processed
-     */
-    abstract processItemEntryChanges<ItemTypeType extends ApiEnumItemType>(itemEntryChangesTuple: ChangesDeltaItemUpdateDelta<ItemTypeType>, isCalledAfterSocketUpdate: boolean, createItemChangesIfNoneExist: boolean): ProcessItemEntryChangesResult<ItemTypeType>;
-    /**
-     * @description
-     * Traverses the column path and returns the fields of the derived item, returns undefined if the item isn't found
-     *
-     * ---------------------
-     *
-     * @remark
-     * Assumes the derived item's values are already cached
-     */
-    getDerivedValues(itemEntry: ItemEntry, columnPath: string[]): Readonly<FieldMap> | undefined;
-    /**
-     * @description
-     * Returns the value of the columnPath, or undefined when the path couldn't be traversed
-     *
-     * @param itemEntry The root entry to start the path from
-     * @param columnPath Can either be an array of columnIds (['column', 'column2']) or a config column string ('column>column2')
-     */
-    getDerivedValue<T extends any = any>(itemEntry: ItemEntry, columnPath: string[] | string): T | undefined;
-    /**
-     * @description
-     * Clears the entry from this transaction, removing it from the {@link ItemCache ItemCache} and removing all changes
-     */
-    clearItemEntry(entry: ItemEntry): void;
-    /**
-     * @description
-     * Recursively fetches derived values as separate requests, instead of as columns of a primary item
-     * Can be used when derived values of a local item have to be fetched, since a local item can't be used as root item of a query
-     */
-    fetchDerivedValuesByColumn<ItemTypeType extends ApiEnumItemType>(itemEntries: ItemEntry<ItemTypeType>[], rootColumn: ColumnInfo<ItemTypeType>, changesDelta?: ChangesDeltaBase): PromiseInterface<void | ItemEntry<ItemTypeType>[]>;
-    resolveDerivedValues<ItemTypeType extends ApiEnumItemType>(itemEntries: ItemEntry<ItemTypeType>[], columns: ColumnInfo<ItemTypeType>[], changesDelta?: ChangesDeltaBase): PromiseInterface<ItemEntry<ItemTypeType>[]>;
-    /**
-     * @description
-     * Creates a new {@link ItemEntry ItemEntry} from the passed {@link ChangesDeltaItemCreateDelta ChangesDeltaItemCreateDelta} and stores it in this transaction's {@link ItemCache ItemCache}
-     */
-    createItemEntry(createTuple: ChangesDeltaItemCreateDelta): ItemEntry;
-    /**
-     * @description
-     * Gets the value of the given column, will look into the current delta before attempting to read itemChanges
-     */
-    protected getItemIdByColumn<ItemTypeType extends ApiEnumItemType>(itemEntry: ItemEntry<ItemTypeType>, column: ColumnInfo<ItemTypeType>, changesDelta?: ChangesDeltaBase): ItemId;
-}
+import { ApiEnumItemType, ItemId } from '@rentman/backend-types';
+import { AbstractCache, ApiFormatter, ApiQuery, ChangesDeltaBase, ChangesDeltaItemCreateDelta, ChangesDeltaItemUpdateDelta, ColumnInfo, ColumnUtil, ErrorHandlerInterface, FieldMap, ItemCache, ItemCacheFactory, ItemEntry, ItemEntryFactory, ItemEntryOptions, ItemTypeColumnId, PromiseInterface, PromiseLibraryInterface, RequestColumnExpansionFactory } from '../../internal';
+export declare enum ItemCacheStatus {
+    CACHED = "cached",
+    NOT_CACHED = "not_cached",
+    NO_CHANGES = "no_changes"
+}
+export interface ItemEntryChangesTuple<ItemTypeType extends ApiEnumItemType> {
+    entry: ItemEntry<ItemTypeType>;
+    changes: FieldMap<ItemTypeType>;
+}
+export declare type ProcessItemEntryChangesResult<ItemTypeType extends ApiEnumItemType> = {
+    status: ItemCacheStatus.NO_CHANGES | ItemCacheStatus.NOT_CACHED;
+    previous: {
+        rollback: null;
+        complete: null | FieldMap<ItemTypeType>;
+    };
+} | {
+    status: ItemCacheStatus.CACHED;
+    previous: {
+        rollback: Partial<FieldMap<ItemTypeType>>;
+        complete: null | FieldMap<ItemTypeType>;
+    };
+};
+export declare abstract class ItemHandlerBase {
+    protected columnUtil: ColumnUtil;
+    protected apiFormatter: ApiFormatter;
+    protected itemEntryFactory: ItemEntryFactory;
+    protected promiseService: PromiseLibraryInterface;
+    protected errorHandler: ErrorHandlerInterface;
+    protected requestColumnExpansionFactory: RequestColumnExpansionFactory;
+    protected transaction: AbstractCache;
+    readonly entries: ItemCache;
+    itemChanges: {
+        [itemEntryId: number]: FieldMap;
+    };
+    protected constructor(columnUtil: ColumnUtil, apiFormatter: ApiFormatter, itemEntryFactory: ItemEntryFactory, promiseService: PromiseLibraryInterface, errorHandler: ErrorHandlerInterface, requestColumnExpansionFactory: RequestColumnExpansionFactory, itemCacheFactory: ItemCacheFactory, transaction: AbstractCache);
+    lookUpItemField<ItemTypeType extends ApiEnumItemType, ColumnId extends ItemTypeColumnId<ItemTypeType>>(entry: ItemEntry<ItemTypeType>, columnId: ColumnId): undefined | FieldMap<ItemTypeType>[ColumnId];
+    collectFields<ItemTypeType extends ApiEnumItemType>(itemEntry: ItemEntry<ItemTypeType>): FieldMap<ItemTypeType>;
+    /**
+     * @description
+     * Copies the passed ItemEntryChanges into a format the implementing ItemHandler can put in his ItemChanges
+     * @param itemEntryChanges
+     * @param entry
+     */
+    copyTransactionItemEntryChanges<ItemTypeType extends ApiEnumItemType>(itemEntryChanges: FieldMap<ItemTypeType>, entry: ItemEntry<ItemTypeType>): FieldMap<ItemTypeType>;
+    /**
+     * @description
+     * Fetches the ItemEntries for the given query, does not look in the cache, since we don't know which ItemIds belong to the query !
+     */
+    abstract fetchItemEntriesByQuery<ItemTypeType extends ApiEnumItemType>(itemType: ItemTypeType, query: ApiQuery, entryOptions: ItemEntryOptions): PromiseInterface<ItemEntry<ItemTypeType>[]>;
+    /**
+     * @description
+     * Fetches the ItemEntries for the given ItemIds
+     */
+    abstract fetchItemEntries<ItemTypeType extends ApiEnumItemType>(itemType: ItemTypeType, itemIds: ItemId[], options: ItemEntryOptions): PromiseInterface<ItemEntry<ItemTypeType>[]>;
+    /**
+     * @description
+     * Fetches an ItemEntry with the given itemId
+     */
+    abstract fetchItemEntry<ItemTypeType extends ApiEnumItemType>(itemType: ItemTypeType, itemId: ItemId, options: ItemEntryOptions, isRoot?: boolean): PromiseInterface<ItemEntry<ItemTypeType>>;
+    /**
+     * @description
+     * Processes the passed {@link ChangesDeltaItemUpdateDelta update delta} on the transaction, if there are no {@link TransactionItemHandler.itemChanges itemChanges} the new values will not be processed
+     */
+    abstract processItemEntryChanges<ItemTypeType extends ApiEnumItemType>(itemEntryChangesTuple: ChangesDeltaItemUpdateDelta<ItemTypeType>, isCalledAfterSocketUpdate: boolean, createItemChangesIfNoneExist: boolean): ProcessItemEntryChangesResult<ItemTypeType>;
+    /**
+     * @description
+     * Traverses the column path and returns the fields of the derived item, returns undefined if the item isn't found
+     *
+     * ---------------------
+     *
+     * @remark
+     * Assumes the derived item's values are already cached
+     */
+    getDerivedValues(itemEntry: ItemEntry, columnPath: string[]): Readonly<FieldMap> | undefined;
+    /**
+     * @description
+     * Returns the value of the columnPath, or undefined when the path couldn't be traversed
+     *
+     * @param itemEntry The root entry to start the path from
+     * @param columnPath Can either be an array of columnIds (['column', 'column2']) or a config column string ('column>column2')
+     */
+    getDerivedValue<T extends any = any>(itemEntry: ItemEntry, columnPath: string[] | string): T | undefined;
+    /**
+     * @description
+     * Clears the entry from this transaction, removing it from the {@link ItemCache ItemCache} and removing all changes
+     */
+    clearItemEntry(entry: ItemEntry): void;
+    /**
+     * @description
+     * Recursively fetches derived values as separate requests, instead of as columns of a primary item
+     * Can be used when derived values of a local item have to be fetched, since a local item can't be used as root item of a query
+     */
+    fetchDerivedValuesByColumn<ItemTypeType extends ApiEnumItemType>(itemEntries: ItemEntry<ItemTypeType>[], rootColumn: ColumnInfo<ItemTypeType>, changesDelta?: ChangesDeltaBase): PromiseInterface<void | ItemEntry<ItemTypeType>[]>;
+    resolveDerivedValues<ItemTypeType extends ApiEnumItemType>(itemEntries: ItemEntry<ItemTypeType>[], columns: ColumnInfo<ItemTypeType>[], changesDelta?: ChangesDeltaBase): PromiseInterface<ItemEntry<ItemTypeType>[]>;
+    /**
+     * @description
+     * Creates a new {@link ItemEntry ItemEntry} from the passed {@link ChangesDeltaItemCreateDelta ChangesDeltaItemCreateDelta} and stores it in this transaction's {@link ItemCache ItemCache}
+     */
+    createItemEntry(createTuple: ChangesDeltaItemCreateDelta): ItemEntry;
+    /**
+     * @description
+     * Gets the value of the given column, will look into the current delta before attempting to read itemChanges
+     */
+    protected getItemIdByColumn<ItemTypeType extends ApiEnumItemType>(itemEntry: ItemEntry<ItemTypeType>, column: ColumnInfo<ItemTypeType>, changesDelta?: ChangesDeltaBase): ItemId;
+}