@rentman/rm-core 12.0.4 → 12.0.5-2

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

@@ -1,77 +1,65 @@
-import { ApiEnumItemType } from '@rentman/backend-types';
-import { AbstractCache, ApiRequestColumnArray, ApiRequestColumnMap, ApiResponseProcessor, CachedQueryItem, ChangesDelta, ChangesDeltaResult, CollectionQuery, CollectionResourceParentIdMap, EntryParent, EntryParentNull, FieldMap, ItemEntry, ItemEntryChangesTuple, ItemIdConversionMap, ItemTypeMap, OnAfterCreateCallback, ParentChangesDelta, PromiseInterface, RmCore, ServerCacheDependencyInterface, ServerCachedQueryHandler, ServerItemHandler, TransactionCache, TransactionOptions, TransactionValidatorFactory } from '../../../internal';
-/**
- * @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, options?: TransactionOptions): TransactionCache;
-    expandCollectionResources<ItemTypeType extends ApiEnumItemType>(itemType: ItemTypeType, collections: CollectionResourceParentIdMap<ItemTypeType>, newRequestColumns: ApiRequestColumnArray): PromiseInterface<CollectionResourceParentIdMap>;
-    /**
-     *
-     * @param response
-     * @param requestColumnMap
-     * @param isCalledAfterSocketUpdate
-     * @param changesDelta
-     * @param conversionMap
-     * @param directRequestItemMap Should be a map of ItemType->ItemId of items that were directly part of the create/update request (queries should be excluded from this because we don't want to overwrite the user's changes (derived values are also queries))
-     */
-    processResponse(response: ApiResponseProcessor, requestColumnMap: ApiRequestColumnMap, isCalledAfterSocketUpdate?: boolean, changesDelta?: ChangesDelta, directRequestItemMap?: ItemTypeMap<Record<string, boolean>>, conversionMap?: ItemIdConversionMap): PromiseInterface<ChangesDeltaResult>;
-    /**
-     * @description
-     * Applies changes to this transaction and its children
-     * ServerCache.applyChangesFromParent should be used when processing an API update/create/delete
-     */
-    applyChangesFromParent(parentChangesDelta: ParentChangesDelta, isCalledAfterSocketUpdate?: boolean): PromiseInterface<void>;
-    /**
-     * @description
-     * Gets the fields required to set the parent
-     */
-    getLinkFieldsByParent<ItemTypeType extends ApiEnumItemType>(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 ApiEnumItemType = any>(itemEntry: ItemEntry<ItemTypeType>, _fromInitial?: boolean, _providedFields?: FieldMap<ItemTypeType>): EntryParentNull;
-    /**
-     * @description
-     * Only takes the local changes into account, used for saving
-     */
-    getLocalItemEntryChangesTuple<ItemTypeType extends ApiEnumItemType>(itemEntryId: ItemEntry<ItemTypeType>['id']): ItemEntryChangesTuple<ItemTypeType>;
-    getCollectionChangesRecursively<ItemTypeType extends ApiEnumItemType>(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
-     * ServerCache.applyChangesDelta should be used when processing an API response which should create new entries on the ServerCache (such as a Query)
-     */
-    applyChangesDelta(changesDelta: ChangesDelta, isCalledAfterSocketUpdate?: boolean, conversionMap?: ItemIdConversionMap): PromiseInterface<ChangesDeltaResult>;
-    getLocalItemEntry(itemEntryId: ItemEntry['id']): ItemEntry | undefined;
-    getLocalItemEntryByItemId(itemType: ApiEnumItemType, itemId: ItemEntry['itemId']): ItemEntry | undefined;
-}
+import { ApiEnumItemType } from '@rentman/backend-types';
+import { AbstractCache, ApiRequestColumnArray, ApiRequestColumnMap, ApiResponseProcessor, CachedQueryItem, ChangesDelta, ChangesDeltaResult, CollectionQuery, CollectionResourceParentIdMap, EntryParent, FieldMap, ItemEntry, ItemEntryChangesTuple, ItemIdConversionMap, OnAfterCreateCallback, ParentChangesDelta, PromiseInterface, ResponseItemUpdateModeMap, RmCore, ServerCacheDependencyInterface, ServerCachedQueryHandler, ServerItemHandler, TransactionCache, TransactionOptions, TransactionValidatorFactory } from '../../../internal';
+/**
+ * @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, options?: TransactionOptions): TransactionCache;
+    expandCollectionResources<ItemTypeType extends ApiEnumItemType>(itemType: ItemTypeType, collections: CollectionResourceParentIdMap<ItemTypeType>, newRequestColumns: ApiRequestColumnArray): PromiseInterface<CollectionResourceParentIdMap>;
+    /**
+     *
+     * @param response
+     * @param requestColumnMap
+     * @param isCalledAfterSocketUpdate
+     * @param changesDelta
+     * @param conversionMap
+     * @param itemUpdateModeMap Allows you to overwrite the update mode for specific items, this is useful when you want to process the direct items of an update/create request
+     */
+    processResponse(response: ApiResponseProcessor, requestColumnMap: ApiRequestColumnMap, isCalledAfterSocketUpdate?: boolean, changesDelta?: ChangesDelta, itemUpdateModeMap?: ResponseItemUpdateModeMap, conversionMap?: ItemIdConversionMap): PromiseInterface<ChangesDeltaResult>;
+    /**
+     * @description
+     * Applies changes to this transaction and its children
+     * ServerCache.applyChangesFromParent should be used when processing an API update/create/delete
+     */
+    applyChangesFromParent(parentChangesDelta: ParentChangesDelta, isCalledAfterSocketUpdate?: boolean): PromiseInterface<void>;
+    /**
+     * @description
+     * Gets the fields required to set the parent
+     */
+    getLinkFieldsByParent<ItemTypeType extends ApiEnumItemType>(parent: EntryParent, itemType: ItemTypeType): Partial<FieldMap<ItemTypeType>>;
+    /**
+     * @description
+     * Only takes the local changes into account, used for saving
+     */
+    getLocalItemEntryChangesTuple<ItemTypeType extends ApiEnumItemType>(itemEntryId: ItemEntry<ItemTypeType>['id']): ItemEntryChangesTuple<ItemTypeType>;
+    getCollectionChangesRecursively<ItemTypeType extends ApiEnumItemType>(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
+     * ServerCache.applyChangesDelta should be used when processing an API response which should create new entries on the ServerCache (such as a Query)
+     */
+    applyChangesDelta(changesDelta: ChangesDelta, isCalledAfterSocketUpdate?: boolean, conversionMap?: ItemIdConversionMap): PromiseInterface<ChangesDeltaResult>;
+    getLocalItemEntry(itemEntryId: ItemEntry['id']): ItemEntry | undefined;
+    getLocalItemEntryByItemId(itemType: ApiEnumItemType, itemId: ItemEntry['itemId']): ItemEntry | undefined;
+}

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

@@ -1,27 +1,27 @@
-import { ApiEnumItemType } from '@rentman/backend-types';
-import { ApiRequestColumns, ApiRequestService, CachedQueryHandlerBase, CachedQueryItem, CachedQueryOptions, CollectionEntryService, CollectionQuery, ColumnUtil, ErrorHandlerInterface, ItemEntry, PromiseInterface, PromiseLibraryInterface, RequestBufferManager, RequestColumnExpansionFactory, RequestColumnsOperationsCache, RequestColumnsOperationsCacheFactory, ServerCache, ServerItemHandler } from '../../../internal';
-export declare class ServerCachedQueryHandler extends CachedQueryHandlerBase {
-    private requestBufferManager;
-    private apiRequestService;
-    private errorHandler;
-    private itemHandler;
-    protected transaction: ServerCache;
-    constructor(requestColumnOperationsCacheFactory: RequestColumnsOperationsCacheFactory, requestBufferManager: RequestBufferManager, requestColumnExpansionFactory: RequestColumnExpansionFactory, apiRequestService: ApiRequestService, collectionEntryService: CollectionEntryService, errorHandler: ErrorHandlerInterface, itemHandler: ServerItemHandler, promiseService: PromiseLibraryInterface, columnUtil: ColumnUtil, transaction: ServerCache);
-    __addItemEntriesToCachedQueries<ItemTypeType extends ApiEnumItemType = any>(itemType: ItemTypeType, parsedQuery: CollectionQuery, itemEntries: ItemEntry<ItemTypeType>[]): void;
-    /**
-     * @description
-     * Expands the columns of the items in the cached query
-     */
-    __expandCachedQuery<ItemTypeType extends ApiEnumItemType>(itemType: ItemTypeType, queryString: string, columnsOperationsCache: RequestColumnsOperationsCache<ItemTypeType>, usePrivateBuffer: boolean, batchedLinkedToQuery?: CollectionQuery): 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 ApiEnumItemType>(itemType: ItemTypeType, options: CachedQueryOptions, columnsOperationsCache: RequestColumnsOperationsCache<ItemTypeType>, collectionQuery: CollectionQuery, batchedLinkedToQuery?: CollectionQuery): PromiseInterface<CachedQueryItem<ItemTypeType>>;
-    /**
-     * Merged the request columns with columns required for delete relations and the query matcher.
-     * This method is in the server cache because the queries contain the superset of all columns here.
-     */
-    expandColumnsWithRequiredColumns(itemType: ApiEnumItemType, requestColumns: ApiRequestColumns): ApiRequestColumns;
-}
+import { ApiEnumItemType } from '@rentman/backend-types';
+import { ApiRequestColumns, ApiRequestService, CachedQueryHandlerBase, CachedQueryItem, CachedQueryOptions, CollectionEntryService, CollectionQuery, ColumnUtil, ErrorHandlerInterface, ItemEntry, PromiseInterface, PromiseLibraryInterface, RequestBufferManager, RequestColumnExpansionFactory, RequestColumnsOperationsCache, RequestColumnsOperationsCacheFactory, ServerCache, ServerItemHandler } from '../../../internal';
+export declare class ServerCachedQueryHandler extends CachedQueryHandlerBase {
+    private requestBufferManager;
+    private apiRequestService;
+    private errorHandler;
+    private itemHandler;
+    protected transaction: ServerCache;
+    constructor(requestColumnOperationsCacheFactory: RequestColumnsOperationsCacheFactory, requestBufferManager: RequestBufferManager, requestColumnExpansionFactory: RequestColumnExpansionFactory, apiRequestService: ApiRequestService, collectionEntryService: CollectionEntryService, errorHandler: ErrorHandlerInterface, itemHandler: ServerItemHandler, promiseService: PromiseLibraryInterface, columnUtil: ColumnUtil, transaction: ServerCache);
+    __addItemEntriesToCachedQueries<ItemTypeType extends ApiEnumItemType = any>(itemType: ItemTypeType, parsedQuery: CollectionQuery, itemEntries: ItemEntry<ItemTypeType>[]): void;
+    /**
+     * @description
+     * Expands the columns of the items in the cached query
+     */
+    __expandCachedQuery<ItemTypeType extends ApiEnumItemType>(itemType: ItemTypeType, queryString: string, columnsOperationsCache: RequestColumnsOperationsCache<ItemTypeType>, usePrivateBuffer: boolean, batchedLinkedToQuery?: CollectionQuery): 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 ApiEnumItemType>(itemType: ItemTypeType, options: CachedQueryOptions, columnsOperationsCache: RequestColumnsOperationsCache<ItemTypeType>, collectionQuery: CollectionQuery, batchedLinkedToQuery?: CollectionQuery): PromiseInterface<CachedQueryItem<ItemTypeType>>;
+    /**
+     * Merged the request columns with columns required for delete relations and the query matcher.
+     * This method is in the server cache because the queries contain the superset of all columns here.
+     */
+    expandColumnsWithRequiredColumns(itemType: ApiEnumItemType, requestColumns: ApiRequestColumns): ApiRequestColumns;
+}

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

@@ -1,39 +1,39 @@
-import { ApiEnumItemType, ItemId } from '@rentman/backend-types';
-import { ApiFormatter, ApiQuery, ApiRequestColumns, ApiResponseProcessor, ChangesDelta, ChangesDeltaItemCreateDelta, ChangesDeltaItemUpdateDelta, ColumnExpansion, ColumnSet, ColumnUtil, ErrorHandlerInterface, ItemCacheFactory, ItemEntry, ItemEntryFactory, ItemEntryOptions, ItemHandlerBase, ProcessItemEntryChangesResult, PromiseInterface, PromiseLibraryInterface, QueryParserFactory, QueryService, RequestBufferManager, RequestBufferResponse, RequestColumnExpansionFactory, RequestColumnsOperationsCacheFactory, ServerCache } from '../../../internal';
-export declare class ServerItemHandler extends ItemHandlerBase {
-    private requestBufferManager;
-    private queryParserFactory;
-    private queryService;
-    private requestColumnsOperationsCacheFactory;
-    protected transaction: ServerCache;
-    constructor(requestBufferManager: RequestBufferManager, queryParserFactory: QueryParserFactory, queryService: QueryService, requestColumnsOperationsCacheFactory: RequestColumnsOperationsCacheFactory, 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 ApiEnumItemType = any>(itemEntryChangesTuple: ChangesDeltaItemUpdateDelta<ItemTypeType>, _isCalledAfterSocketUpdate?: boolean, _createItemChangesIfNoneExist?: boolean): ProcessItemEntryChangesResult<ItemTypeType>;
-    fetchItemEntry<ItemTypeType extends ApiEnumItemType>(itemType: ItemTypeType, itemId: ItemId, options: ItemEntryOptions): PromiseInterface<ItemEntry<ItemTypeType>>;
-    fetchItemEntriesByQuery<ItemTypeType extends ApiEnumItemType>(itemType: ItemTypeType, query: ApiQuery, entryOptions: ItemEntryOptions): PromiseInterface<ItemEntry<ItemTypeType>[]>;
-    extendItemEntries<ItemTypeType extends ApiEnumItemType>(itemType: ItemTypeType, itemEntries: ItemEntry<ItemTypeType>[], newColumns: ApiRequestColumns): PromiseInterface<ItemEntry<ItemTypeType>[]>;
-    fetchItemEntries<ItemTypeType extends ApiEnumItemType>(itemType: ItemTypeType, itemIds: ItemId[], options: ItemEntryOptions): PromiseInterface<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: ApiEnumItemType, parentIdArray: ItemId[], itemType: ApiEnumItemType, 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 ApiEnumItemType>(changesDelta: ChangesDelta, response: ApiResponseProcessor, itemType: ItemTypeType, itemIdOfExistingItem: ItemId, itemIdInResponse: ItemId, columnSet: ColumnSet<ItemTypeType>, columnExpansion: ColumnExpansion<ItemTypeType>, updateModified?: boolean): 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 { ApiEnumItemType, ItemId } from '@rentman/backend-types';
+import { ApiFormatter, ApiQuery, ApiRequestColumns, ApiResponseProcessor, ChangesDelta, ChangesDeltaItemCreateDelta, ChangesDeltaItemUpdateDelta, ChangesDeltaItemUpdateMode, ColumnExpansion, ColumnSet, ColumnUtil, ErrorHandlerInterface, ItemCacheFactory, ItemEntry, ItemEntryFactory, ItemEntryOptions, ItemHandlerBase, ProcessItemEntryChangesResult, PromiseInterface, PromiseLibraryInterface, QueryParserFactory, QueryService, RequestBufferManager, RequestBufferResponse, RequestColumnExpansionFactory, RequestColumnsOperationsCacheFactory, ServerCache } from '../../../internal';
+export declare class ServerItemHandler extends ItemHandlerBase {
+    private requestBufferManager;
+    private queryParserFactory;
+    private queryService;
+    private requestColumnsOperationsCacheFactory;
+    protected transaction: ServerCache;
+    constructor(requestBufferManager: RequestBufferManager, queryParserFactory: QueryParserFactory, queryService: QueryService, requestColumnsOperationsCacheFactory: RequestColumnsOperationsCacheFactory, 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 ApiEnumItemType = any>(itemEntryChangesTuple: ChangesDeltaItemUpdateDelta<ItemTypeType>, _isCalledAfterSocketUpdate?: boolean, _createItemChangesIfNoneExist?: boolean): ProcessItemEntryChangesResult<ItemTypeType>;
+    fetchItemEntry<ItemTypeType extends ApiEnumItemType>(itemType: ItemTypeType, itemId: ItemId, options: ItemEntryOptions): PromiseInterface<ItemEntry<ItemTypeType>>;
+    fetchItemEntriesByQuery<ItemTypeType extends ApiEnumItemType>(itemType: ItemTypeType, query: ApiQuery, entryOptions: ItemEntryOptions): PromiseInterface<ItemEntry<ItemTypeType>[]>;
+    extendItemEntries<ItemTypeType extends ApiEnumItemType>(itemType: ItemTypeType, itemEntries: ItemEntry<ItemTypeType>[], newColumns: ApiRequestColumns): PromiseInterface<ItemEntry<ItemTypeType>[]>;
+    fetchItemEntries<ItemTypeType extends ApiEnumItemType>(itemType: ItemTypeType, itemIds: ItemId[], options: ItemEntryOptions): PromiseInterface<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: ApiEnumItemType, parentIdArray: ItemId[], itemType: ApiEnumItemType, 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 ApiEnumItemType>(changesDelta: ChangesDelta, response: ApiResponseProcessor, itemType: ItemTypeType, itemIdOfExistingItem: ItemId, itemIdInResponse: ItemId, columnSet: ColumnSet<ItemTypeType>, columnExpansion: ColumnExpansion<ItemTypeType>, mode: ChangesDeltaItemUpdateMode): 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;
+}