@rentman/rm-core 6.0.1 → 6.0.2

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

@@ -1,35 +1,35 @@
-import { QueryMatcherFactory } from '../../factories';
-import { PromiseLibraryInterface } from '../../interfaces';
-import { ItemEntry } from '../../models';
-import { CollectionQuery, ItemType, PromiseInterface } from '../../types';
-import { ApiRequestService } from '../ApiRequestService';
-import { ChangesDeltaBase } from '../ChangesDeltaBase';
-import { CollectionMatcherBase, CollectionMatcherMatches } from '../CollectionMatcherBase';
-import { QueryService } from '../QueryService';
-import { AbstractCache } from './AbstractCache';
-import { CachedQueryItem } from './CachedQueryHandlerBase';
-export declare type GroupedCollectionMatcherResult<ItemTypeType extends ItemType> = {
-    fitting: Array<ItemEntry<ItemTypeType>>;
-    notFitting: Array<ItemEntry<ItemTypeType>>;
-    maybe: Array<ItemEntry<ItemTypeType>>;
-};
-/**
- * @description
- * Processes all cached queries and adds/removes item entries that do/don't fit the query
- */
-export declare class CollectionMatcherCachedQueryProcessor extends CollectionMatcherBase {
-    private apiRequestService;
-    private promiseService;
-    private getQueries;
-    protected map: {
-        [itemTypeAndQueryString: string]: {
-            itemType: ItemType;
-            query: CollectionQuery;
-            matches: CollectionMatcherMatches;
-            cachedQuery: CachedQueryItem;
-        };
-    };
-    constructor(apiRequestService: ApiRequestService, promiseService: PromiseLibraryInterface, queryService: QueryService, queryMatcherFactory: QueryMatcherFactory, transaction: AbstractCache, getQueries: (itemType: ItemType) => CachedQueryItem[]);
-    __removeFromAndAddToCachedQueries(_isCalledAfterSocketUpdate?: boolean, changesDelta?: ChangesDeltaBase): PromiseInterface<void[]>;
-    protected _expand<ItemTypeType extends ItemType = string>(itemEntry: ItemEntry<ItemTypeType>, matchFunction: (itemType: ItemTypeType, parsedQuery: CollectionQuery) => boolean | 'maybe'): this;
-}
+import { QueryMatcherFactory } from '../../factories';
+import { PromiseLibraryInterface } from '../../interfaces';
+import { ItemEntry } from '../../models';
+import { CollectionQuery, ItemType, PromiseInterface } from '../../types';
+import { ApiRequestService } from '../ApiRequestService';
+import { ChangesDeltaBase } from '../ChangesDeltaBase';
+import { CollectionMatcherBase, CollectionMatcherMatches } from '../CollectionMatcherBase';
+import { QueryService } from '../QueryService';
+import { AbstractCache } from './AbstractCache';
+import { CachedQueryItem } from './CachedQueryHandlerBase';
+export declare type GroupedCollectionMatcherResult<ItemTypeType extends ItemType> = {
+    fitting: Array<ItemEntry<ItemTypeType>>;
+    notFitting: Array<ItemEntry<ItemTypeType>>;
+    maybe: Array<ItemEntry<ItemTypeType>>;
+};
+/**
+ * @description
+ * Processes all cached queries and adds/removes item entries that do/don't fit the query
+ */
+export declare class CollectionMatcherCachedQueryProcessor extends CollectionMatcherBase {
+    private apiRequestService;
+    private promiseService;
+    private getQueries;
+    protected map: {
+        [itemTypeAndQueryString: string]: {
+            itemType: ItemType;
+            query: CollectionQuery;
+            matches: CollectionMatcherMatches;
+            cachedQuery: CachedQueryItem;
+        };
+    };
+    constructor(apiRequestService: ApiRequestService, promiseService: PromiseLibraryInterface, queryService: QueryService, queryMatcherFactory: QueryMatcherFactory, transaction: AbstractCache, getQueries: (itemType: ItemType) => CachedQueryItem[]);
+    __removeFromAndAddToCachedQueries(_isCalledAfterSocketUpdate?: boolean, changesDelta?: ChangesDeltaBase): PromiseInterface<void[]>;
+    protected _expand<ItemTypeType extends ItemType = string>(itemEntry: ItemEntry<ItemTypeType>, matchFunction: (itemType: ItemTypeType, parsedQuery: CollectionQuery) => boolean | 'maybe'): this;
+}

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

@@ -1,93 +1,93 @@
-import { ItemCacheFactory, ItemEntryFactory, RequestColumnExpansionFactory } from '../../factories';
-import { ErrorHandlerInterface, PromiseLibraryInterface } from '../../interfaces';
-import { ItemEntry, ItemEntryOptions } from '../../models';
-import { ApiQuery, ApiRequestColumns, FieldMap, ItemId, ItemType, PromiseInterface } from '../../types';
-import { ApiFormatter } from '../ApiFormatter';
-import { ChangesDeltaBase, ChangesDeltaItemUpdateDelta } from '../ChangesDeltaBase';
-import { ColumnInfo } from '../ColumnInfo';
-import { ColumnUtil } from '../ColumnUtil';
-import { ChangesDeltaItemCreateDelta } from '../CreatedChangesDelta';
-import { ItemCache } from '../ItemCache';
-import { AbstractCache } from './AbstractCache';
-import { ServerItemEntryChanges } from './server/ServerItemHandler';
-import { TransactionItemEntryChanges } from './transaction/TransactionItemHandler';
-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;
-    abstract itemChanges: ServerItemEntryChanges | TransactionItemEntryChanges;
-    protected constructor(columnUtil: ColumnUtil, apiFormatter: ApiFormatter, itemEntryFactory: ItemEntryFactory, promiseService: PromiseLibraryInterface, errorHandler: ErrorHandlerInterface, requestColumnExpansionFactory: RequestColumnExpansionFactory, itemCacheFactory: ItemCacheFactory, transaction: AbstractCache);
-    /**
-     * @description
-     * Copies the passed ItemEntryChanges into a format the implementing ItemHandler can put in his ItemChanges
-     * @param itemEntryChanges
-     * @param entry
-     */
-    abstract copyTransactionItemEntryChanges(itemEntryChanges: TransactionItemEntryChanges, entry: ItemEntry): any;
-    /**
-     * @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 ItemType>(itemType: ItemTypeType, query: ApiQuery, entryOptions: ItemEntryOptions): PromiseInterface<Array<ItemEntry<ItemTypeType>>>;
-    /**
-     * @description
-     * Fetches the ItemEntries for the given ItemIds
-     */
-    abstract fetchItemEntries<ItemTypeType extends ItemType>(itemType: ItemTypeType, itemIds: ItemId[], options: ItemEntryOptions): PromiseInterface<Array<ItemEntry<ItemTypeType>>>;
-    /**
-     * @description
-     * Fetches an ItemEntry with the given itemId
-     */
-    abstract fetchItemEntry<ItemTypeType extends ItemType>(itemType: ItemTypeType, itemId: ItemId, options: ItemEntryOptions): 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 ItemType>(itemEntryChangesTuple: ChangesDeltaItemUpdateDelta<ItemTypeType>, forceOverwrite: boolean, updateInitial: boolean, isCalledAfterSocketUpdate: boolean, createItemChangesIfNoneExist: boolean): FieldMap<ItemTypeType> | null;
-    /**
-     * @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 ItemType>(itemEntries: Array<ItemEntry<ItemTypeType>>, rootColumn: ColumnInfo<ItemTypeType>, changesDelta?: ChangesDeltaBase): PromiseInterface<void | Array<ItemEntry<ItemTypeType>>>;
-    resolveDerivedValues<ItemTypeType extends ItemType>(itemEntries: Array<ItemEntry<ItemTypeType>>, columns: Array<ColumnInfo<ItemTypeType>>, changesDelta?: ChangesDeltaBase): PromiseInterface<Array<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 ItemType>(itemEntry: ItemEntry<ItemTypeType>, column: ColumnInfo<ItemTypeType>, changesDelta?: ChangesDeltaBase): ItemId;
-    protected expandColumnsWithCachedQueryColumns(itemType: ItemType, requestColumns?: ApiRequestColumns): ApiRequestColumns;
-}
+import { ItemCacheFactory, ItemEntryFactory, RequestColumnExpansionFactory } from '../../factories';
+import { ErrorHandlerInterface, PromiseLibraryInterface } from '../../interfaces';
+import { ItemEntry, ItemEntryOptions } from '../../models';
+import { ApiQuery, ApiRequestColumns, FieldMap, ItemId, ItemType, PromiseInterface } from '../../types';
+import { ApiFormatter } from '../ApiFormatter';
+import { ChangesDeltaBase, ChangesDeltaItemUpdateDelta } from '../ChangesDeltaBase';
+import { ColumnInfo } from '../ColumnInfo';
+import { ColumnUtil } from '../ColumnUtil';
+import { ChangesDeltaItemCreateDelta } from '../CreatedChangesDelta';
+import { ItemCache } from '../ItemCache';
+import { AbstractCache } from './AbstractCache';
+import { ServerItemEntryChanges } from './server/ServerItemHandler';
+import { TransactionItemEntryChanges } from './transaction/TransactionItemHandler';
+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;
+    abstract itemChanges: ServerItemEntryChanges | TransactionItemEntryChanges;
+    protected constructor(columnUtil: ColumnUtil, apiFormatter: ApiFormatter, itemEntryFactory: ItemEntryFactory, promiseService: PromiseLibraryInterface, errorHandler: ErrorHandlerInterface, requestColumnExpansionFactory: RequestColumnExpansionFactory, itemCacheFactory: ItemCacheFactory, transaction: AbstractCache);
+    /**
+     * @description
+     * Copies the passed ItemEntryChanges into a format the implementing ItemHandler can put in his ItemChanges
+     * @param itemEntryChanges
+     * @param entry
+     */
+    abstract copyTransactionItemEntryChanges(itemEntryChanges: TransactionItemEntryChanges, entry: ItemEntry): any;
+    /**
+     * @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 ItemType>(itemType: ItemTypeType, query: ApiQuery, entryOptions: ItemEntryOptions): PromiseInterface<Array<ItemEntry<ItemTypeType>>>;
+    /**
+     * @description
+     * Fetches the ItemEntries for the given ItemIds
+     */
+    abstract fetchItemEntries<ItemTypeType extends ItemType>(itemType: ItemTypeType, itemIds: ItemId[], options: ItemEntryOptions): PromiseInterface<Array<ItemEntry<ItemTypeType>>>;
+    /**
+     * @description
+     * Fetches an ItemEntry with the given itemId
+     */
+    abstract fetchItemEntry<ItemTypeType extends ItemType>(itemType: ItemTypeType, itemId: ItemId, options: ItemEntryOptions): 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 ItemType>(itemEntryChangesTuple: ChangesDeltaItemUpdateDelta<ItemTypeType>, forceOverwrite: boolean, updateInitial: boolean, isCalledAfterSocketUpdate: boolean, createItemChangesIfNoneExist: boolean): FieldMap<ItemTypeType> | null;
+    /**
+     * @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 ItemType>(itemEntries: Array<ItemEntry<ItemTypeType>>, rootColumn: ColumnInfo<ItemTypeType>, changesDelta?: ChangesDeltaBase): PromiseInterface<void | Array<ItemEntry<ItemTypeType>>>;
+    resolveDerivedValues<ItemTypeType extends ItemType>(itemEntries: Array<ItemEntry<ItemTypeType>>, columns: Array<ColumnInfo<ItemTypeType>>, changesDelta?: ChangesDeltaBase): PromiseInterface<Array<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 ItemType>(itemEntry: ItemEntry<ItemTypeType>, column: ColumnInfo<ItemTypeType>, changesDelta?: ChangesDeltaBase): ItemId;
+    protected expandColumnsWithCachedQueryColumns(itemType: ItemType, requestColumns?: ApiRequestColumns): ApiRequestColumns;
+}

package/dist/types/classes/cache/server/ServerCache.d.ts

@@ -1,82 +1,82 @@
-import { ChangesDelta, InternalChangesDelta, TransactionCache, TransactionValidatorFactory } from '../..';
-import { RmCore } from '../../../core';
-import { ServerCacheDependencyInterface } from '../../../interfaces/ServerCacheDependencyInterface';
-import { ItemEntry } from '../../../models';
-import { ApiRequestColumn, ApiRequestColumnMap, CollectionQuery, CollectionResourceParentIdMap, EntryParent, EntryParentNull, FieldMap, ItemIdConversionMap, ItemType, PromiseInterface } from '../../../types';
-import { ApiResponseProcessor } from '../../ApiResponseProcessor';
-import { ChangesDeltaResult } from '../../ChangesDeltaBase';
-import { OnAfterCreateCallback } from '../../ChangesProcessor';
-import { AbstractCache } from '../AbstractCache';
-import { CachedQueryItem } from '../CachedQueryHandlerBase';
-import { ServerCachedQueryHandler } from './ServerCachedQueryHandler';
-import { ServerItemEntryChanges, ServerItemHandler } from './ServerItemHandler';
-/**
- * @description
- * The {@link ServerCache ServerCache} is responsible for keeping track of {@link ItemEntry ItemEntries} and {@link CollectionEntry CollectionEntries}
- * which are saved on the server.
- *
- * It's basically a local representation of the database
- */
-export declare class ServerCache extends AbstractCache {
-    dependencies: ServerCacheDependencyInterface;
-    readonly itemHandler: ServerItemHandler;
-    readonly cachedQueryHandler: ServerCachedQueryHandler;
-    parent: null;
-    constructor(dependencies: ServerCacheDependencyInterface, core: RmCore);
-    getServerCache(): ServerCache;
-    createChild(id?: string, validatorFactory?: TransactionValidatorFactory): TransactionCache;
-    expandCollectionResources<ItemTypeType extends ItemType>(itemType: ItemTypeType, collections: CollectionResourceParentIdMap<ItemTypeType>, newRequestColumns: ApiRequestColumn[]): PromiseInterface<CollectionResourceParentIdMap>;
-    processResponse(response: ApiResponseProcessor, requestColumnMap: ApiRequestColumnMap, isCalledAfterApiSave?: boolean, isCalledAfterSocketUpdate?: boolean, changesDelta?: ChangesDelta): PromiseInterface<ChangesDeltaResult>;
-    /**
-     * @description
-     * Applies the changes of the changesDelta created by the API call ({@link ChangesProcessor ChangesProcessor}/{@link SocketMessageHandler SocketMessageHandler}, or manually through a module function) on all caches
-     */
-    applyChangesFromParent(internalChangesDelta: InternalChangesDelta, isCalledAfterApiSave?: boolean, isCalledAfterSocketUpdate?: boolean): PromiseInterface<void>;
-    /**
-     * @description
-     * Gets the fields required to set the parent
-     */
-    getLinkFieldsByParent<ItemTypeType extends ItemType>(parent: EntryParent, itemType: ItemTypeType): Partial<FieldMap<ItemTypeType>>;
-    /**
-     * @description
-     * Gets the entry's parent
-     *
-     * @param itemEntry The entry to get the parent from
-     * @param _fromInitial Unused parameter, there for alignment with {@link TransactionCache.getParent TransactionCache.getParent]
-     * @param _providedFields Unused parameter, there for alignment with {@link TransactionCache.getParent TransactionCache.getParent]
-     *
-     * @remark
-     * Use {@link CollectionResource.getParent CollectionResource.getParent} instead of {@link TransactionCache.getParent TransactionCache.getParent} if you're getting the parent in the onRemove callback
-     */
-    getParent<ItemTypeType extends ItemType = any>(itemEntry: ItemEntry<ItemTypeType>, _fromInitial?: boolean, _providedFields?: FieldMap<ItemTypeType>): EntryParentNull;
-    getItemChangesRecursively(itemEntryId: ItemEntry['id'], copyFields?: boolean): FieldMap;
-    /**
-     * @description
-     * Only takes the local changes into account, used for saving
-     */
-    getLocalItemEntryChangesTuple(itemEntryId: ItemEntry['id']): {
-        entry: ItemEntry;
-        changes: ServerItemEntryChanges;
-    };
-    getCollectionChangesRecursively<ItemTypeType extends ItemType>(itemType: ItemTypeType, parsedQuery: CollectionQuery): CachedQueryItem<ItemTypeType> | undefined;
-    /**
-     * @description
-     * Invalidates the complete server cache, all items will be re-fetched whenever they are requested
-     */
-    invalidateCache(): void;
-    /**
-     * @description
-     * Merges the passed changes from the child Transaction into this Transaction's own changes and then propagates
-     * them to all child Transactions
-     */
-    applyChangesFromChild(transaction: TransactionCache, breakUpByParent?: boolean, onAfterCreateCallback?: OnAfterCreateCallback): PromiseInterface<ItemIdConversionMap>;
-    /**
-     * @description
-     * Applies changes to this transaction and its children
-     * Differs from {@link TransactionCache.applyChangesDelta TransactionCache.applyChangesDelta} in the handling of deleted entries and the applyChangesFromParent call
-     */
-    applyChangesDelta(changesDelta: ChangesDelta, isCalledAfterApiSave?: boolean, isCalledAfterSocketUpdate?: boolean): PromiseInterface<ChangesDeltaResult>;
-    getLocalItemEntry(itemEntryId: ItemEntry['id']): ItemEntry | undefined;
-    getLocalItemEntryByItemId(itemType: ItemType, itemId: ItemEntry['itemId']): ItemEntry | undefined;
-    getChangesFromItemChanges<ItemTypeType extends ItemType = any>(changesObject: ServerItemEntryChanges<ItemTypeType>): FieldMap<ItemTypeType>;
-}
+import { ChangesDelta, InternalChangesDelta, TransactionCache, TransactionValidatorFactory } from '../..';
+import { RmCore } from '../../../core';
+import { ServerCacheDependencyInterface } from '../../../interfaces/ServerCacheDependencyInterface';
+import { ItemEntry } from '../../../models';
+import { ApiRequestColumn, ApiRequestColumnMap, CollectionQuery, CollectionResourceParentIdMap, EntryParent, EntryParentNull, FieldMap, ItemIdConversionMap, ItemType, PromiseInterface } from '../../../types';
+import { ApiResponseProcessor } from '../../ApiResponseProcessor';
+import { ChangesDeltaResult } from '../../ChangesDeltaBase';
+import { OnAfterCreateCallback } from '../../ChangesProcessor';
+import { AbstractCache } from '../AbstractCache';
+import { CachedQueryItem } from '../CachedQueryHandlerBase';
+import { ServerCachedQueryHandler } from './ServerCachedQueryHandler';
+import { ServerItemEntryChanges, ServerItemHandler } from './ServerItemHandler';
+/**
+ * @description
+ * The {@link ServerCache ServerCache} is responsible for keeping track of {@link ItemEntry ItemEntries} and {@link CollectionEntry CollectionEntries}
+ * which are saved on the server.
+ *
+ * It's basically a local representation of the database
+ */
+export declare class ServerCache extends AbstractCache {
+    dependencies: ServerCacheDependencyInterface;
+    readonly itemHandler: ServerItemHandler;
+    readonly cachedQueryHandler: ServerCachedQueryHandler;
+    parent: null;
+    constructor(dependencies: ServerCacheDependencyInterface, core: RmCore);
+    getServerCache(): ServerCache;
+    createChild(id?: string, validatorFactory?: TransactionValidatorFactory): TransactionCache;
+    expandCollectionResources<ItemTypeType extends ItemType>(itemType: ItemTypeType, collections: CollectionResourceParentIdMap<ItemTypeType>, newRequestColumns: ApiRequestColumn[]): PromiseInterface<CollectionResourceParentIdMap>;
+    processResponse(response: ApiResponseProcessor, requestColumnMap: ApiRequestColumnMap, isCalledAfterApiSave?: boolean, isCalledAfterSocketUpdate?: boolean, changesDelta?: ChangesDelta): PromiseInterface<ChangesDeltaResult>;
+    /**
+     * @description
+     * Applies the changes of the changesDelta created by the API call ({@link ChangesProcessor ChangesProcessor}/{@link SocketMessageHandler SocketMessageHandler}, or manually through a module function) on all caches
+     */
+    applyChangesFromParent(internalChangesDelta: InternalChangesDelta, isCalledAfterApiSave?: boolean, isCalledAfterSocketUpdate?: boolean): PromiseInterface<void>;
+    /**
+     * @description
+     * Gets the fields required to set the parent
+     */
+    getLinkFieldsByParent<ItemTypeType extends ItemType>(parent: EntryParent, itemType: ItemTypeType): Partial<FieldMap<ItemTypeType>>;
+    /**
+     * @description
+     * Gets the entry's parent
+     *
+     * @param itemEntry The entry to get the parent from
+     * @param _fromInitial Unused parameter, there for alignment with {@link TransactionCache.getParent TransactionCache.getParent]
+     * @param _providedFields Unused parameter, there for alignment with {@link TransactionCache.getParent TransactionCache.getParent]
+     *
+     * @remark
+     * Use {@link CollectionResource.getParent CollectionResource.getParent} instead of {@link TransactionCache.getParent TransactionCache.getParent} if you're getting the parent in the onRemove callback
+     */
+    getParent<ItemTypeType extends ItemType = any>(itemEntry: ItemEntry<ItemTypeType>, _fromInitial?: boolean, _providedFields?: FieldMap<ItemTypeType>): EntryParentNull;
+    getItemChangesRecursively(itemEntryId: ItemEntry['id'], copyFields?: boolean): FieldMap;
+    /**
+     * @description
+     * Only takes the local changes into account, used for saving
+     */
+    getLocalItemEntryChangesTuple(itemEntryId: ItemEntry['id']): {
+        entry: ItemEntry;
+        changes: ServerItemEntryChanges;
+    };
+    getCollectionChangesRecursively<ItemTypeType extends ItemType>(itemType: ItemTypeType, parsedQuery: CollectionQuery): CachedQueryItem<ItemTypeType> | undefined;
+    /**
+     * @description
+     * Invalidates the complete server cache, all items will be re-fetched whenever they are requested
+     */
+    invalidateCache(): void;
+    /**
+     * @description
+     * Merges the passed changes from the child Transaction into this Transaction's own changes and then propagates
+     * them to all child Transactions
+     */
+    applyChangesFromChild(transaction: TransactionCache, breakUpByParent?: boolean, onAfterCreateCallback?: OnAfterCreateCallback): PromiseInterface<ItemIdConversionMap>;
+    /**
+     * @description
+     * Applies changes to this transaction and its children
+     * Differs from {@link TransactionCache.applyChangesDelta TransactionCache.applyChangesDelta} in the handling of deleted entries and the applyChangesFromParent call
+     */
+    applyChangesDelta(changesDelta: ChangesDelta, isCalledAfterApiSave?: boolean, isCalledAfterSocketUpdate?: boolean): PromiseInterface<ChangesDeltaResult>;
+    getLocalItemEntry(itemEntryId: ItemEntry['id']): ItemEntry | undefined;
+    getLocalItemEntryByItemId(itemType: ItemType, itemId: ItemEntry['itemId']): ItemEntry | undefined;
+    getChangesFromItemChanges<ItemTypeType extends ItemType = any>(changesObject: ServerItemEntryChanges<ItemTypeType>): FieldMap<ItemTypeType>;
+}

package/dist/types/classes/cache/server/ServerCachedQueryHandler.d.ts

@@ -1,34 +1,34 @@
-import { ColumnSubsetCacheFactory, RequestColumnExpansionFactory } from '../../../factories';
-import { ApiRequestColumns, ApiRequestService, CollectionQuery, ColumnSubsetCache, ColumnUtil, ParentIdMap, PromiseInterface } from '../../../index';
-import { ErrorHandlerInterface, PromiseLibraryInterface } from '../../../interfaces';
-import { ItemEntry } from '../../../models';
-import { CollectionOptions } from '../../../models/CollectionOptions';
-import { ItemId, ItemType } from '../../../types';
-import { CollectionEntryService } from '../../index';
-import { RequestBufferManager } from '../../RequestBufferManager';
-import { CachedQueryHandlerBase, CachedQueryItem } from '../CachedQueryHandlerBase';
-import { ServerCache } from './ServerCache';
-import { ServerItemHandler } from './ServerItemHandler';
-export declare class ServerCachedQueryHandler extends CachedQueryHandlerBase {
-    private columnSubsetCacheFactory;
-    private requestBufferManager;
-    private apiRequestService;
-    private errorHandler;
-    private itemHandler;
-    protected transaction: ServerCache;
-    constructor(columnSubsetCacheFactory: ColumnSubsetCacheFactory, requestBufferManager: RequestBufferManager, requestColumnExpansionFactory: RequestColumnExpansionFactory, apiRequestService: ApiRequestService, collectionEntryService: CollectionEntryService, errorHandler: ErrorHandlerInterface, itemHandler: ServerItemHandler, promiseService: PromiseLibraryInterface, columnUtil: ColumnUtil, transaction: ServerCache);
-    __fetchCachedQueryItem<ItemTypeType extends ItemType>(itemType: ItemTypeType, options: CollectionOptions): PromiseInterface<CachedQueryItem<ItemTypeType>>;
-    __fetchLinkedCachedQueryItems<ItemTypeType extends ItemType>(parentType: ItemType, parentIdArray: ItemId[] | (() => ItemId[]), itemType: ItemTypeType, options: CollectionOptions): PromiseInterface<ParentIdMap<CachedQueryItem<ItemTypeType>>>;
-    __addItemEntriesToCachedQueries<ItemTypeType extends ItemType>(itemType: ItemTypeType, parsedQuery: CollectionQuery, itemEntries: Array<ItemEntry<ItemTypeType>>): void;
-    /**
-     * @description
-     * Expands the columns of the items in the cached query
-     */
-    __expandCachedQuery<ItemTypeType extends ItemType = any>(cachedQuery: CachedQueryItem<ItemTypeType>, newColumns: ApiRequestColumns): PromiseInterface<CachedQueryItem<ItemTypeType>>;
-    /**
-     * @description
-     * Fetches the data for the passed ItemType/options, will do nothing if the requested CollectionEntry/columns are already cached.
-     * Will create a new {@link CollectionEntry CollectionEntry} if the CollectionEntry didn't exist yet
-     */
-    __fetchItemEntriesByQueryData<ItemTypeType extends ItemType>(itemType: ItemTypeType, options: CollectionOptions<ItemTypeType>, columnSubsetCache: ColumnSubsetCache<ItemTypeType>, collectionQuery: CollectionQuery): PromiseInterface<CachedQueryItem<ItemTypeType>>;
-}
+import { ColumnSubsetCacheFactory, RequestColumnExpansionFactory } from '../../../factories';
+import { ApiRequestColumns, ApiRequestService, CollectionQuery, ColumnSubsetCache, ColumnUtil, ParentIdMap, PromiseInterface } from '../../../index';
+import { ErrorHandlerInterface, PromiseLibraryInterface } from '../../../interfaces';
+import { ItemEntry } from '../../../models';
+import { CollectionOptions } from '../../../models/CollectionOptions';
+import { ItemId, ItemType } from '../../../types';
+import { CollectionEntryService } from '../../index';
+import { RequestBufferManager } from '../../RequestBufferManager';
+import { CachedQueryHandlerBase, CachedQueryItem } from '../CachedQueryHandlerBase';
+import { ServerCache } from './ServerCache';
+import { ServerItemHandler } from './ServerItemHandler';
+export declare class ServerCachedQueryHandler extends CachedQueryHandlerBase {
+    private columnSubsetCacheFactory;
+    private requestBufferManager;
+    private apiRequestService;
+    private errorHandler;
+    private itemHandler;
+    protected transaction: ServerCache;
+    constructor(columnSubsetCacheFactory: ColumnSubsetCacheFactory, requestBufferManager: RequestBufferManager, requestColumnExpansionFactory: RequestColumnExpansionFactory, apiRequestService: ApiRequestService, collectionEntryService: CollectionEntryService, errorHandler: ErrorHandlerInterface, itemHandler: ServerItemHandler, promiseService: PromiseLibraryInterface, columnUtil: ColumnUtil, transaction: ServerCache);
+    __fetchCachedQueryItem<ItemTypeType extends ItemType>(itemType: ItemTypeType, options: CollectionOptions): PromiseInterface<CachedQueryItem<ItemTypeType>>;
+    __fetchLinkedCachedQueryItems<ItemTypeType extends ItemType>(parentType: ItemType, parentIdArray: ItemId[] | (() => ItemId[]), itemType: ItemTypeType, options: CollectionOptions): PromiseInterface<ParentIdMap<CachedQueryItem<ItemTypeType>>>;
+    __addItemEntriesToCachedQueries<ItemTypeType extends ItemType>(itemType: ItemTypeType, parsedQuery: CollectionQuery, itemEntries: Array<ItemEntry<ItemTypeType>>): void;
+    /**
+     * @description
+     * Expands the columns of the items in the cached query
+     */
+    __expandCachedQuery<ItemTypeType extends ItemType = any>(cachedQuery: CachedQueryItem<ItemTypeType>, newColumns: ApiRequestColumns): PromiseInterface<CachedQueryItem<ItemTypeType>>;
+    /**
+     * @description
+     * Fetches the data for the passed ItemType/options, will do nothing if the requested CollectionEntry/columns are already cached.
+     * Will create a new {@link CollectionEntry CollectionEntry} if the CollectionEntry didn't exist yet
+     */
+    __fetchItemEntriesByQueryData<ItemTypeType extends ItemType>(itemType: ItemTypeType, options: CollectionOptions<ItemTypeType>, columnSubsetCache: ColumnSubsetCache<ItemTypeType>, collectionQuery: CollectionQuery): PromiseInterface<CachedQueryItem<ItemTypeType>>;
+}

package/dist/types/classes/cache/server/ServerItemHandler.d.ts

@@ -1,52 +1,52 @@
-import { ColumnSubsetCacheFactory, ItemCacheFactory, ItemEntryFactory, QueryParserFactory, RequestColumnExpansionFactory } from '../../../factories';
-import { ErrorHandlerInterface, PromiseLibraryInterface } from '../../../interfaces';
-import { ItemEntry, ItemEntryOptions } from '../../../models';
-import { ApiQuery, ApiRequestColumns, FieldMap, ItemId, ItemType, PromiseInterface } from '../../../types';
-import { ChangesDelta } from '../../ChangesDelta';
-import { ChangesDeltaItemUpdateDelta } from '../../ChangesDeltaBase';
-import { ChangesDeltaItemCreateDelta } from '../../CreatedChangesDelta';
-import { ApiFormatter, ApiResponseProcessor, ColumnExpansion, ColumnSet, ColumnUtil, QueryService, RequestBufferManager, RequestBufferResponse, TransactionItemEntryChanges } from '../../index';
-import { ItemHandlerBase } from '../ItemHandlerBase';
-import { ServerCache } from './ServerCache';
-export declare type ServerItemEntryChanges<ItemTypeType extends ItemType = any> = FieldMap<ItemTypeType>;
-export declare class ServerItemHandler extends ItemHandlerBase {
-    private requestBufferManager;
-    private queryParserFactory;
-    private queryService;
-    private columnSubsetCacheFactory;
-    protected transaction: ServerCache;
-    itemChanges: {
-        [itemEntryId: number]: ServerItemEntryChanges;
-    };
-    constructor(requestBufferManager: RequestBufferManager, queryParserFactory: QueryParserFactory, queryService: QueryService, columnSubsetCacheFactory: ColumnSubsetCacheFactory, errorHandler: ErrorHandlerInterface, promiseService: PromiseLibraryInterface, columnUtil: ColumnUtil, apiFormatter: ApiFormatter, itemEntryFactory: ItemEntryFactory, itemCacheFactory: ItemCacheFactory, requestColumnExpansionFactory: RequestColumnExpansionFactory, transaction: ServerCache);
-    createItemEntry(createTuple: ChangesDeltaItemCreateDelta): ItemEntry;
-    /**
-     * @description
-     * Processes updates on a cached entry
-     */
-    processItemEntryChanges<ItemTypeType extends ItemType = any>(itemEntryChangesTuple: ChangesDeltaItemUpdateDelta<ItemTypeType>, _forceOverwrite?: boolean, _updateInitial?: boolean, _isCalledAfterSocketUpdate?: boolean, _createItemChangesIfNoneExist?: boolean): FieldMap<ItemTypeType> | null;
-    copyTransactionItemEntryChanges(itemEntryChanges: TransactionItemEntryChanges, entry: ItemEntry): ServerItemEntryChanges;
-    fetchItemEntry<ItemTypeType extends ItemType>(itemType: ItemTypeType, itemId: ItemId, options: ItemEntryOptions): PromiseInterface<ItemEntry<ItemTypeType>>;
-    fetchItemEntriesByQuery<ItemTypeType extends ItemType>(itemType: ItemTypeType, query: ApiQuery, entryOptions: ItemEntryOptions): PromiseInterface<Array<ItemEntry<ItemTypeType>>>;
-    extendItemEntries<ItemTypeType extends ItemType>(itemType: ItemTypeType, itemEntries: Array<ItemEntry<ItemTypeType>>, newColumns: ApiRequestColumns): PromiseInterface<Array<ItemEntry<ItemTypeType>>>;
-    fetchItemEntries<ItemTypeType extends ItemType>(itemType: ItemTypeType, itemIds: ItemId[], options: ItemEntryOptions): PromiseInterface<Array<ItemEntry<ItemTypeType>>>;
-    /**
-     * @description
-     * Fetches the data for the ItemEntries linked to the parent Items
-     *
-     * @param columns should contain a derived column that refers to the parent
-     */
-    fetchLinkedItemEntriesData(parentType: ItemType, parentIdArray: ItemId[], itemType: ItemType, query: ApiQuery | null, columns: ApiRequestColumns): PromiseInterface<RequestBufferResponse>;
-    /**
-     * @description
-     * General way to process an API response.
-     * Will call {@link ChangesDelta.setItemCreated setItemCreated} if an entry doesn't exist yet, and otherwise {@link ChangesDelta.setItemUpdated setItemUpdated} if it does.
-     */
-    processApiResponse<ItemTypeType extends ItemType>(changesDelta: ChangesDelta, response: ApiResponseProcessor, itemType: ItemTypeType, itemId: ItemId, columnSet: ColumnSet<ItemTypeType>, columnExpansion: ColumnExpansion<ItemTypeType>): void;
-    /**
-     * @description
-     * Fetches the data for the passed ItemType/ItemId/columns, will do nothing if the requested ItemEntry/columns are already cached.
-     * Will create a new {@link ItemEntry ItemEntry} if the ItemEntry didn't exist yet
-     */
-    private fetchItemEntryData;
-}
+import { ColumnSubsetCacheFactory, ItemCacheFactory, ItemEntryFactory, QueryParserFactory, RequestColumnExpansionFactory } from '../../../factories';
+import { ErrorHandlerInterface, PromiseLibraryInterface } from '../../../interfaces';
+import { ItemEntry, ItemEntryOptions } from '../../../models';
+import { ApiQuery, ApiRequestColumns, FieldMap, ItemId, ItemType, PromiseInterface } from '../../../types';
+import { ChangesDelta } from '../../ChangesDelta';
+import { ChangesDeltaItemUpdateDelta } from '../../ChangesDeltaBase';
+import { ChangesDeltaItemCreateDelta } from '../../CreatedChangesDelta';
+import { ApiFormatter, ApiResponseProcessor, ColumnExpansion, ColumnSet, ColumnUtil, QueryService, RequestBufferManager, RequestBufferResponse, TransactionItemEntryChanges } from '../../index';
+import { ItemHandlerBase } from '../ItemHandlerBase';
+import { ServerCache } from './ServerCache';
+export declare type ServerItemEntryChanges<ItemTypeType extends ItemType = any> = FieldMap<ItemTypeType>;
+export declare class ServerItemHandler extends ItemHandlerBase {
+    private requestBufferManager;
+    private queryParserFactory;
+    private queryService;
+    private columnSubsetCacheFactory;
+    protected transaction: ServerCache;
+    itemChanges: {
+        [itemEntryId: number]: ServerItemEntryChanges;
+    };
+    constructor(requestBufferManager: RequestBufferManager, queryParserFactory: QueryParserFactory, queryService: QueryService, columnSubsetCacheFactory: ColumnSubsetCacheFactory, errorHandler: ErrorHandlerInterface, promiseService: PromiseLibraryInterface, columnUtil: ColumnUtil, apiFormatter: ApiFormatter, itemEntryFactory: ItemEntryFactory, itemCacheFactory: ItemCacheFactory, requestColumnExpansionFactory: RequestColumnExpansionFactory, transaction: ServerCache);
+    createItemEntry(createTuple: ChangesDeltaItemCreateDelta): ItemEntry;
+    /**
+     * @description
+     * Processes updates on a cached entry
+     */
+    processItemEntryChanges<ItemTypeType extends ItemType = any>(itemEntryChangesTuple: ChangesDeltaItemUpdateDelta<ItemTypeType>, _forceOverwrite?: boolean, _updateInitial?: boolean, _isCalledAfterSocketUpdate?: boolean, _createItemChangesIfNoneExist?: boolean): FieldMap<ItemTypeType> | null;
+    copyTransactionItemEntryChanges(itemEntryChanges: TransactionItemEntryChanges, entry: ItemEntry): ServerItemEntryChanges;
+    fetchItemEntry<ItemTypeType extends ItemType>(itemType: ItemTypeType, itemId: ItemId, options: ItemEntryOptions): PromiseInterface<ItemEntry<ItemTypeType>>;
+    fetchItemEntriesByQuery<ItemTypeType extends ItemType>(itemType: ItemTypeType, query: ApiQuery, entryOptions: ItemEntryOptions): PromiseInterface<Array<ItemEntry<ItemTypeType>>>;
+    extendItemEntries<ItemTypeType extends ItemType>(itemType: ItemTypeType, itemEntries: Array<ItemEntry<ItemTypeType>>, newColumns: ApiRequestColumns): PromiseInterface<Array<ItemEntry<ItemTypeType>>>;
+    fetchItemEntries<ItemTypeType extends ItemType>(itemType: ItemTypeType, itemIds: ItemId[], options: ItemEntryOptions): PromiseInterface<Array<ItemEntry<ItemTypeType>>>;
+    /**
+     * @description
+     * Fetches the data for the ItemEntries linked to the parent Items
+     *
+     * @param columns should contain a derived column that refers to the parent
+     */
+    fetchLinkedItemEntriesData(parentType: ItemType, parentIdArray: ItemId[], itemType: ItemType, query: ApiQuery | null, columns: ApiRequestColumns): PromiseInterface<RequestBufferResponse>;
+    /**
+     * @description
+     * General way to process an API response.
+     * Will call {@link ChangesDelta.setItemCreated setItemCreated} if an entry doesn't exist yet, and otherwise {@link ChangesDelta.setItemUpdated setItemUpdated} if it does.
+     */
+    processApiResponse<ItemTypeType extends ItemType>(changesDelta: ChangesDelta, response: ApiResponseProcessor, itemType: ItemTypeType, itemId: ItemId, columnSet: ColumnSet<ItemTypeType>, columnExpansion: ColumnExpansion<ItemTypeType>): void;
+    /**
+     * @description
+     * Fetches the data for the passed ItemType/ItemId/columns, will do nothing if the requested ItemEntry/columns are already cached.
+     * Will create a new {@link ItemEntry ItemEntry} if the ItemEntry didn't exist yet
+     */
+    private fetchItemEntryData;
+}