@rentman/rm-core 9.2.2 → 9.2.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/changelog.md +1345 -1008
- package/dist/rm-core.js +987 -929
- package/dist/rm-core.min.js +1 -1
- package/dist/types/classes/ApiFormatter.d.ts +73 -73
- package/dist/types/classes/ApiRequestService.d.ts +18 -18
- package/dist/types/classes/ApiResponseProcessor.d.ts +29 -29
- package/dist/types/classes/CacheSyncer.d.ts +44 -44
- package/dist/types/classes/ChangesCompilation.d.ts +33 -33
- package/dist/types/classes/ChangesDelta.d.ts +61 -61
- package/dist/types/classes/ChangesDeltaBase.d.ts +78 -78
- package/dist/types/classes/ChangesProcessor.d.ts +40 -40
- package/dist/types/classes/CollectionEntryService.d.ts +24 -24
- package/dist/types/classes/CollectionResourceService.d.ts +6 -6
- package/dist/types/classes/ColumnCache.d.ts +19 -19
- package/dist/types/classes/ColumnExpansion.d.ts +19 -19
- package/dist/types/classes/ColumnHandler.d.ts +20 -20
- package/dist/types/classes/ColumnInfo.d.ts +15 -15
- package/dist/types/classes/ColumnSet.d.ts +37 -37
- package/dist/types/classes/ColumnSubsetCache.d.ts +14 -14
- package/dist/types/classes/ColumnUtil.d.ts +108 -101
- package/dist/types/classes/ConversionMapService.d.ts +25 -25
- package/dist/types/classes/CreateRequest.d.ts +17 -17
- package/dist/types/classes/CreatedChangesDelta.d.ts +17 -17
- package/dist/types/classes/InternalChangesDelta.d.ts +43 -43
- package/dist/types/classes/ItemCache.d.ts +27 -27
- package/dist/types/classes/ItemCreateService.d.ts +18 -18
- package/dist/types/classes/ItemEntryService.d.ts +32 -32
- package/dist/types/classes/KeyService.d.ts +18 -18
- package/dist/types/classes/LockService.d.ts +29 -29
- package/dist/types/classes/ModuleChangesCompilation.d.ts +18 -18
- package/dist/types/classes/ParentChangesDelta.d.ts +39 -39
- package/dist/types/classes/QueryColumnExtractor.d.ts +18 -18
- package/dist/types/classes/QueryContainsLocalIdParser.d.ts +17 -17
- package/dist/types/classes/QueryLinkedToParser.d.ts +17 -17
- package/dist/types/classes/QueryLocallyMatchableParser.d.ts +20 -20
- package/dist/types/classes/QueryMatcher.d.ts +24 -24
- package/dist/types/classes/QueryParser.d.ts +25 -25
- package/dist/types/classes/QueryParserBase.d.ts +20 -20
- package/dist/types/classes/QueryParserIdUpdater.d.ts +17 -17
- package/dist/types/classes/QueryService.d.ts +12 -12
- package/dist/types/classes/RequestBuffer.d.ts +24 -24
- package/dist/types/classes/RequestBufferManager.d.ts +32 -32
- package/dist/types/classes/RequestColumnExpansion.d.ts +15 -15
- package/dist/types/classes/SocketMessageHandler.d.ts +34 -34
- package/dist/types/classes/TemplateCache.d.ts +62 -62
- package/dist/types/classes/Util.d.ts +28 -28
- package/dist/types/classes/cache/AbstractCache.d.ts +85 -85
- package/dist/types/classes/cache/CachedQueryHandlerBase.d.ts +68 -68
- package/dist/types/classes/cache/ItemHandlerBase.d.ts +102 -102
- package/dist/types/classes/cache/server/ServerCache.d.ts +78 -78
- package/dist/types/classes/cache/server/ServerCachedQueryHandler.d.ts +25 -25
- package/dist/types/classes/cache/server/ServerItemHandler.d.ts +43 -43
- package/dist/types/classes/cache/transaction/TransactionCache.d.ts +318 -318
- package/dist/types/classes/cache/transaction/TransactionCachedQueryHandler.d.ts +37 -37
- package/dist/types/classes/cache/transaction/TransactionCollectionHandler.d.ts +24 -24
- package/dist/types/classes/cache/transaction/TransactionEventHandler.d.ts +21 -21
- package/dist/types/classes/cache/transaction/TransactionItemHandler.d.ts +90 -90
- package/dist/types/classes/cache/transaction/TransactionValidator.d.ts +33 -33
- package/dist/types/constants.d.ts +7 -7
- package/dist/types/core.d.ts +45 -45
- package/dist/types/factories/ApiResponseProcessorFactory.d.ts +6 -6
- package/dist/types/factories/CacheSyncerFactory.d.ts +10 -10
- package/dist/types/factories/ChangesCompilationFactory.d.ts +5 -5
- package/dist/types/factories/ChangesDeltaFactory.d.ts +13 -13
- package/dist/types/factories/ChangesProcessorFactory.d.ts +13 -13
- package/dist/types/factories/CollectionEntryFactory.d.ts +11 -11
- package/dist/types/factories/CollectionResourceFactory.d.ts +18 -18
- package/dist/types/factories/ColumnExpansionFactory.d.ts +7 -7
- package/dist/types/factories/ColumnInfoFactory.d.ts +7 -7
- package/dist/types/factories/ColumnSetFactory.d.ts +18 -18
- package/dist/types/factories/ColumnSubsetCacheFactory.d.ts +8 -8
- package/dist/types/factories/CreateRequestFactory.d.ts +9 -9
- package/dist/types/factories/ItemCacheFactory.d.ts +6 -6
- package/dist/types/factories/ItemEntryFactory.d.ts +12 -12
- package/dist/types/factories/ItemResourceFactory.d.ts +11 -11
- package/dist/types/factories/ModuleChangesCompilationFactory.d.ts +4 -4
- package/dist/types/factories/QueryMatcherFactory.d.ts +7 -7
- package/dist/types/factories/QueryParserFactory.d.ts +5 -5
- package/dist/types/factories/RequestColumnExpansionFactory.d.ts +8 -8
- package/dist/types/factories/TemplateFactory.d.ts +8 -8
- package/dist/types/factories/TransactionCacheFactory.d.ts +13 -13
- package/dist/types/index.d.ts +1 -1
- package/dist/types/interfaces/AbstractCacheDependencyInterface.d.ts +36 -36
- package/dist/types/interfaces/ApiRequestServiceInterface.d.ts +12 -12
- package/dist/types/interfaces/AuthInterface.d.ts +10 -10
- package/dist/types/interfaces/ErrorHandlerInterface.d.ts +5 -5
- package/dist/types/interfaces/ExceptionHandlerInterface.d.ts +3 -3
- package/dist/types/interfaces/LinkTreeServiceInterface.d.ts +4 -4
- package/dist/types/interfaces/PromiseLibraryInterface.d.ts +25 -25
- package/dist/types/interfaces/ServerCacheDependencyInterface.d.ts +5 -5
- package/dist/types/interfaces/SocketMessageInterface.d.ts +3 -3
- package/dist/types/interfaces/TransactionCollectionHandlerDependencyInterface.d.ts +17 -17
- package/dist/types/interfaces/TransactionItemHandlerDependencyInterface.d.ts +22 -22
- package/dist/types/internal.d.ts +104 -104
- package/dist/types/models/CachedQueryItem.d.ts +19 -19
- package/dist/types/models/CollectionEntry.d.ts +21 -21
- package/dist/types/models/CollectionOptions.d.ts +44 -44
- package/dist/types/models/CollectionResource.d.ts +87 -87
- package/dist/types/models/ItemEntry.d.ts +18 -18
- package/dist/types/models/ItemEntryOptions.d.ts +8 -8
- package/dist/types/models/ItemResource.d.ts +90 -90
- package/dist/types/models/Template.d.ts +11 -11
- package/dist/types/types/ItemTypesCollection.d.ts +345 -345
- package/dist/types/types/PromiseInterface.d.ts +2 -2
- package/package.json +50 -50
- package/readme.md +15 -15
|
@@ -1,68 +1,68 @@
|
|
|
1
|
-
import { ApiEnumItemType, ItemId } from '@rentman/backend-types';
|
|
2
|
-
import { AbstractCache, ApiQuery, ApiRequestColumns, CachedQueryItem, CollectionEntryService, CollectionOptions, CollectionQuery, ColumnSubsetCache, ColumnUtil, ItemEntry, ParentIdMap, ParentItemMap, PromiseInterface, PromiseLibraryInterface, RequestColumnExpansionFactory } from '../../internal';
|
|
3
|
-
export declare type CachedQueryItemTree<ItemTypeType extends ApiEnumItemType = any> = {
|
|
4
|
-
item: CachedQueryItem<ItemTypeType>;
|
|
5
|
-
children: ParentItemMap<CachedQueryItemTree> | null;
|
|
6
|
-
};
|
|
7
|
-
export declare abstract class CachedQueryHandlerBase {
|
|
8
|
-
protected collectionEntryService: CollectionEntryService;
|
|
9
|
-
protected columnUtil: ColumnUtil;
|
|
10
|
-
protected requestColumnExpansionFactory: RequestColumnExpansionFactory;
|
|
11
|
-
protected promiseService: PromiseLibraryInterface;
|
|
12
|
-
protected transaction: AbstractCache;
|
|
13
|
-
/**
|
|
14
|
-
* @description
|
|
15
|
-
* Items (per ItemType) that fit in a query
|
|
16
|
-
*
|
|
17
|
-
* @remark
|
|
18
|
-
* Contains the requestColumns so that new items can include these columns (saving requests when they match)
|
|
19
|
-
*/
|
|
20
|
-
cachedQueries: {
|
|
21
|
-
[itemType: string]: {
|
|
22
|
-
[queryString: string]: CachedQueryItem;
|
|
23
|
-
};
|
|
24
|
-
};
|
|
25
|
-
protected constructor(collectionEntryService: CollectionEntryService, columnUtil: ColumnUtil, requestColumnExpansionFactory: RequestColumnExpansionFactory, promiseService: PromiseLibraryInterface, transaction: AbstractCache);
|
|
26
|
-
/**
|
|
27
|
-
* Every time a cached query item is created, either 'resolve' or 'reject' has to be called on the cached query item.
|
|
28
|
-
*/
|
|
29
|
-
setCachedQuery<ItemTypeType extends ApiEnumItemType>(itemType: ItemTypeType, parsedQuery: CollectionQuery, requestColumns: ApiRequestColumns, itemEntries?: ItemEntry<ItemTypeType>[]): CachedQueryItem<ItemTypeType>;
|
|
30
|
-
getCachedQueryItems<ItemTypeType extends ApiEnumItemType>(itemType: ItemTypeType, queryString: string): undefined | ItemEntry<ItemTypeType>[];
|
|
31
|
-
getCachedQueryObjectsByItemType(itemType: ApiEnumItemType): CachedQueryItem[];
|
|
32
|
-
/**
|
|
33
|
-
* @description
|
|
34
|
-
* Fetches a {@link CollectionEntry CollectionEntry} with the given options
|
|
35
|
-
*/
|
|
36
|
-
abstract __fetchCachedQueryItem<ItemTypeType extends ApiEnumItemType>(itemType: ItemTypeType, options: CollectionOptions): PromiseInterface<CachedQueryItem<ItemTypeType>>;
|
|
37
|
-
/**
|
|
38
|
-
* @description
|
|
39
|
-
* Fetches collections linked to the passed parents
|
|
40
|
-
*/
|
|
41
|
-
abstract __fetchItemEntriesByQueryData<ItemTypeType extends ApiEnumItemType>(itemType: ItemTypeType, options: CollectionOptions<ItemTypeType>, columnSubsetCache: ColumnSubsetCache<ItemTypeType>, collectionQuery: CollectionQuery, batchedLinkedToQuery?: CollectionQuery): PromiseInterface<CachedQueryItem<ItemTypeType>>;
|
|
42
|
-
/**
|
|
43
|
-
* @description
|
|
44
|
-
* Fetches collections linked to the passed parents
|
|
45
|
-
*/
|
|
46
|
-
abstract __fetchLinkedCachedQueryItems<ItemTypeType extends ApiEnumItemType>(parentType: ApiEnumItemType, parentIdArray: ItemId[] | (() => ItemId[]), itemType: ItemTypeType, options: CollectionOptions): PromiseInterface<ParentIdMap<CachedQueryItem<ItemTypeType>>>;
|
|
47
|
-
/**
|
|
48
|
-
* @description
|
|
49
|
-
* Removes the passed {@link ItemId ItemIds} from the Transaction's query cache
|
|
50
|
-
*/
|
|
51
|
-
__removeItemEntriesFromCachedQueries<ItemTypeType extends ApiEnumItemType>(itemType: ItemTypeType, parsedQuery: CollectionQuery, itemEntries: ItemEntry<ItemTypeType>[]): ItemEntry<ItemTypeType>[];
|
|
52
|
-
/**
|
|
53
|
-
* @description
|
|
54
|
-
* Expands the option's {@link CollectionOptions.columns columns} with the columns required for the {@link CacheSyncer CacheSyncer} to function.
|
|
55
|
-
* 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
|
|
56
|
-
*/
|
|
57
|
-
expandColumnsWithQueryColumns(itemType: ApiEnumItemType, options: CollectionOptions, query: ApiQuery): void;
|
|
58
|
-
/**
|
|
59
|
-
* Every time a cached query item is created, either 'resolve' or 'reject' has to be called on the cached query item.
|
|
60
|
-
*/
|
|
61
|
-
protected constructCachedQuery<ItemTypeType extends ApiEnumItemType>(itemType: ItemTypeType, parsedQuery: CollectionQuery, itemEntries: ItemEntry<ItemTypeType>[], requestColumns: ApiRequestColumns): CachedQueryItem<ItemTypeType>;
|
|
62
|
-
/**
|
|
63
|
-
* @description
|
|
64
|
-
* Adds the passed {@link ItemEntry ItemEntries} to the Transaction's query cache,
|
|
65
|
-
* will skip the ItemEntry if the `skipEntryFilterFn` callback returns `true`
|
|
66
|
-
*/
|
|
67
|
-
protected __addItemEntriesToCachedQueries<ItemTypeType extends ApiEnumItemType>(itemType: ItemTypeType, parsedQuery: CollectionQuery, itemEntries: ItemEntry<ItemTypeType>[], skipEntryFilterFn: (temEntry: ItemEntry) => boolean): void;
|
|
68
|
-
}
|
|
1
|
+
import { ApiEnumItemType, ItemId } from '@rentman/backend-types';
|
|
2
|
+
import { AbstractCache, ApiQuery, ApiRequestColumns, CachedQueryItem, CollectionEntryService, CollectionOptions, CollectionQuery, ColumnSubsetCache, ColumnUtil, ItemEntry, ParentIdMap, ParentItemMap, PromiseInterface, PromiseLibraryInterface, RequestColumnExpansionFactory } from '../../internal';
|
|
3
|
+
export declare type CachedQueryItemTree<ItemTypeType extends ApiEnumItemType = any> = {
|
|
4
|
+
item: CachedQueryItem<ItemTypeType>;
|
|
5
|
+
children: ParentItemMap<CachedQueryItemTree> | null;
|
|
6
|
+
};
|
|
7
|
+
export declare abstract class CachedQueryHandlerBase {
|
|
8
|
+
protected collectionEntryService: CollectionEntryService;
|
|
9
|
+
protected columnUtil: ColumnUtil;
|
|
10
|
+
protected requestColumnExpansionFactory: RequestColumnExpansionFactory;
|
|
11
|
+
protected promiseService: PromiseLibraryInterface;
|
|
12
|
+
protected transaction: AbstractCache;
|
|
13
|
+
/**
|
|
14
|
+
* @description
|
|
15
|
+
* Items (per ItemType) that fit in a query
|
|
16
|
+
*
|
|
17
|
+
* @remark
|
|
18
|
+
* Contains the requestColumns so that new items can include these columns (saving requests when they match)
|
|
19
|
+
*/
|
|
20
|
+
cachedQueries: {
|
|
21
|
+
[itemType: string]: {
|
|
22
|
+
[queryString: string]: CachedQueryItem;
|
|
23
|
+
};
|
|
24
|
+
};
|
|
25
|
+
protected constructor(collectionEntryService: CollectionEntryService, columnUtil: ColumnUtil, requestColumnExpansionFactory: RequestColumnExpansionFactory, promiseService: PromiseLibraryInterface, transaction: AbstractCache);
|
|
26
|
+
/**
|
|
27
|
+
* Every time a cached query item is created, either 'resolve' or 'reject' has to be called on the cached query item.
|
|
28
|
+
*/
|
|
29
|
+
setCachedQuery<ItemTypeType extends ApiEnumItemType>(itemType: ItemTypeType, parsedQuery: CollectionQuery, requestColumns: ApiRequestColumns, itemEntries?: ItemEntry<ItemTypeType>[]): CachedQueryItem<ItemTypeType>;
|
|
30
|
+
getCachedQueryItems<ItemTypeType extends ApiEnumItemType>(itemType: ItemTypeType, queryString: string): undefined | ItemEntry<ItemTypeType>[];
|
|
31
|
+
getCachedQueryObjectsByItemType(itemType: ApiEnumItemType): CachedQueryItem[];
|
|
32
|
+
/**
|
|
33
|
+
* @description
|
|
34
|
+
* Fetches a {@link CollectionEntry CollectionEntry} with the given options
|
|
35
|
+
*/
|
|
36
|
+
abstract __fetchCachedQueryItem<ItemTypeType extends ApiEnumItemType>(itemType: ItemTypeType, options: CollectionOptions): PromiseInterface<CachedQueryItem<ItemTypeType>>;
|
|
37
|
+
/**
|
|
38
|
+
* @description
|
|
39
|
+
* Fetches collections linked to the passed parents
|
|
40
|
+
*/
|
|
41
|
+
abstract __fetchItemEntriesByQueryData<ItemTypeType extends ApiEnumItemType>(itemType: ItemTypeType, options: CollectionOptions<ItemTypeType>, columnSubsetCache: ColumnSubsetCache<ItemTypeType>, collectionQuery: CollectionQuery, batchedLinkedToQuery?: CollectionQuery): PromiseInterface<CachedQueryItem<ItemTypeType>>;
|
|
42
|
+
/**
|
|
43
|
+
* @description
|
|
44
|
+
* Fetches collections linked to the passed parents
|
|
45
|
+
*/
|
|
46
|
+
abstract __fetchLinkedCachedQueryItems<ItemTypeType extends ApiEnumItemType>(parentType: ApiEnumItemType, parentIdArray: ItemId[] | (() => ItemId[]), itemType: ItemTypeType, options: CollectionOptions): PromiseInterface<ParentIdMap<CachedQueryItem<ItemTypeType>>>;
|
|
47
|
+
/**
|
|
48
|
+
* @description
|
|
49
|
+
* Removes the passed {@link ItemId ItemIds} from the Transaction's query cache
|
|
50
|
+
*/
|
|
51
|
+
__removeItemEntriesFromCachedQueries<ItemTypeType extends ApiEnumItemType>(itemType: ItemTypeType, parsedQuery: CollectionQuery, itemEntries: ItemEntry<ItemTypeType>[]): ItemEntry<ItemTypeType>[];
|
|
52
|
+
/**
|
|
53
|
+
* @description
|
|
54
|
+
* Expands the option's {@link CollectionOptions.columns columns} with the columns required for the {@link CacheSyncer CacheSyncer} to function.
|
|
55
|
+
* 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
|
|
56
|
+
*/
|
|
57
|
+
expandColumnsWithQueryColumns(itemType: ApiEnumItemType, options: CollectionOptions, query: ApiQuery): void;
|
|
58
|
+
/**
|
|
59
|
+
* Every time a cached query item is created, either 'resolve' or 'reject' has to be called on the cached query item.
|
|
60
|
+
*/
|
|
61
|
+
protected constructCachedQuery<ItemTypeType extends ApiEnumItemType>(itemType: ItemTypeType, parsedQuery: CollectionQuery, itemEntries: ItemEntry<ItemTypeType>[], requestColumns: ApiRequestColumns): CachedQueryItem<ItemTypeType>;
|
|
62
|
+
/**
|
|
63
|
+
* @description
|
|
64
|
+
* Adds the passed {@link ItemEntry ItemEntries} to the Transaction's query cache,
|
|
65
|
+
* will skip the ItemEntry if the `skipEntryFilterFn` callback returns `true`
|
|
66
|
+
*/
|
|
67
|
+
protected __addItemEntriesToCachedQueries<ItemTypeType extends ApiEnumItemType>(itemType: ItemTypeType, parsedQuery: CollectionQuery, itemEntries: ItemEntry<ItemTypeType>[], skipEntryFilterFn: (temEntry: ItemEntry) => boolean): void;
|
|
68
|
+
}
|
|
@@ -1,102 +1,102 @@
|
|
|
1
|
-
import { ApiEnumItemType, ItemId } from '@rentman/backend-types';
|
|
2
|
-
import { AbstractCache, ApiFormatter, ApiQuery, ChangesDeltaBase, ChangesDeltaItemCreateDelta, ChangesDeltaItemUpdateDelta, ColumnInfo, ColumnUtil, ErrorHandlerInterface, FieldMap, ItemCache, ItemCacheFactory, ItemEntry, ItemEntryFactory, ItemEntryOptions, PromiseInterface, PromiseLibraryInterface, RequestColumnExpansionFactory, TransactionItemEntryChanges } from '../../internal';
|
|
3
|
-
export declare enum ItemCacheStatus {
|
|
4
|
-
CACHED = "cached",
|
|
5
|
-
NOT_CACHED = "not_cached",
|
|
6
|
-
NO_CHANGES = "no_changes"
|
|
7
|
-
}
|
|
8
|
-
export interface ItemEntryChanges<ItemTypeType extends ApiEnumItemType> {
|
|
9
|
-
fields: FieldMap<ItemTypeType>;
|
|
10
|
-
}
|
|
11
|
-
export interface ItemEntryChangesTuple<ItemTypeType extends ApiEnumItemType> {
|
|
12
|
-
entry: ItemEntry<ItemTypeType>;
|
|
13
|
-
changes: ItemEntryChanges<ItemTypeType>;
|
|
14
|
-
}
|
|
15
|
-
export declare type ProcessItemEntryChangesResult<ItemTypeType extends ApiEnumItemType> = {
|
|
16
|
-
status: ItemCacheStatus.NO_CHANGES | ItemCacheStatus.NOT_CACHED;
|
|
17
|
-
previous: null;
|
|
18
|
-
} | {
|
|
19
|
-
status: ItemCacheStatus.CACHED;
|
|
20
|
-
previous: FieldMap<ItemTypeType>;
|
|
21
|
-
};
|
|
22
|
-
export declare abstract class ItemHandlerBase {
|
|
23
|
-
protected columnUtil: ColumnUtil;
|
|
24
|
-
protected apiFormatter: ApiFormatter;
|
|
25
|
-
protected itemEntryFactory: ItemEntryFactory;
|
|
26
|
-
protected promiseService: PromiseLibraryInterface;
|
|
27
|
-
protected errorHandler: ErrorHandlerInterface;
|
|
28
|
-
protected requestColumnExpansionFactory: RequestColumnExpansionFactory;
|
|
29
|
-
protected transaction: AbstractCache;
|
|
30
|
-
readonly entries: ItemCache;
|
|
31
|
-
abstract itemChanges: {
|
|
32
|
-
[itemEntryId: number]: ItemEntryChanges<any>;
|
|
33
|
-
};
|
|
34
|
-
protected constructor(columnUtil: ColumnUtil, apiFormatter: ApiFormatter, itemEntryFactory: ItemEntryFactory, promiseService: PromiseLibraryInterface, errorHandler: ErrorHandlerInterface, requestColumnExpansionFactory: RequestColumnExpansionFactory, itemCacheFactory: ItemCacheFactory, transaction: AbstractCache);
|
|
35
|
-
/**
|
|
36
|
-
* @description
|
|
37
|
-
* Copies the passed ItemEntryChanges into a format the implementing ItemHandler can put in his ItemChanges
|
|
38
|
-
* @param itemEntryChanges
|
|
39
|
-
* @param entry
|
|
40
|
-
*/
|
|
41
|
-
abstract copyTransactionItemEntryChanges<ItemTypeType extends ApiEnumItemType>(itemEntryChanges: TransactionItemEntryChanges<ItemTypeType>, entry: ItemEntry<ItemTypeType>): ItemEntryChanges<ItemTypeType>;
|
|
42
|
-
/**
|
|
43
|
-
* @description
|
|
44
|
-
* Fetches the ItemEntries for the given query, does not look in the cache, since we don't know which ItemIds belong to the query !
|
|
45
|
-
*/
|
|
46
|
-
abstract fetchItemEntriesByQuery<ItemTypeType extends ApiEnumItemType>(itemType: ItemTypeType, query: ApiQuery, entryOptions: ItemEntryOptions): PromiseInterface<ItemEntry<ItemTypeType>[]>;
|
|
47
|
-
/**
|
|
48
|
-
* @description
|
|
49
|
-
* Fetches the ItemEntries for the given ItemIds
|
|
50
|
-
*/
|
|
51
|
-
abstract fetchItemEntries<ItemTypeType extends ApiEnumItemType>(itemType: ItemTypeType, itemIds: ItemId[], options: ItemEntryOptions): PromiseInterface<ItemEntry<ItemTypeType>[]>;
|
|
52
|
-
/**
|
|
53
|
-
* @description
|
|
54
|
-
* Fetches an ItemEntry with the given itemId
|
|
55
|
-
*/
|
|
56
|
-
abstract fetchItemEntry<ItemTypeType extends ApiEnumItemType>(itemType: ItemTypeType, itemId: ItemId, options: ItemEntryOptions, isRoot?: boolean): PromiseInterface<ItemEntry<ItemTypeType>>;
|
|
57
|
-
/**
|
|
58
|
-
* @description
|
|
59
|
-
* 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
|
|
60
|
-
*/
|
|
61
|
-
abstract processItemEntryChanges<ItemTypeType extends ApiEnumItemType>(itemEntryChangesTuple: ChangesDeltaItemUpdateDelta<ItemTypeType>, isCalledAfterSocketUpdate: boolean, createItemChangesIfNoneExist: boolean): ProcessItemEntryChangesResult<ItemTypeType>;
|
|
62
|
-
/**
|
|
63
|
-
* @description
|
|
64
|
-
* Traverses the column path and returns the fields of the derived item, returns undefined if the item isn't found
|
|
65
|
-
*
|
|
66
|
-
* ---------------------
|
|
67
|
-
*
|
|
68
|
-
* @remark
|
|
69
|
-
* Assumes the derived item's values are already cached
|
|
70
|
-
*/
|
|
71
|
-
getDerivedValues(itemEntry: ItemEntry, columnPath: string[]): Readonly<FieldMap> | undefined;
|
|
72
|
-
/**
|
|
73
|
-
* @description
|
|
74
|
-
* Returns the value of the columnPath, or undefined when the path couldn't be traversed
|
|
75
|
-
*
|
|
76
|
-
* @param itemEntry The root entry to start the path from
|
|
77
|
-
* @param columnPath Can either be an array of columnIds (['column', 'column2']) or a config column string ('column>column2')
|
|
78
|
-
*/
|
|
79
|
-
getDerivedValue<T extends any = any>(itemEntry: ItemEntry, columnPath: string[] | string): T | undefined;
|
|
80
|
-
/**
|
|
81
|
-
* @description
|
|
82
|
-
* Clears the entry from this transaction, removing it from the {@link ItemCache ItemCache} and removing all changes
|
|
83
|
-
*/
|
|
84
|
-
clearItemEntry(entry: ItemEntry): void;
|
|
85
|
-
/**
|
|
86
|
-
* @description
|
|
87
|
-
* Recursively fetches derived values as separate requests, instead of as columns of a primary item
|
|
88
|
-
* 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
|
|
89
|
-
*/
|
|
90
|
-
fetchDerivedValuesByColumn<ItemTypeType extends ApiEnumItemType>(itemEntries: ItemEntry<ItemTypeType>[], rootColumn: ColumnInfo<ItemTypeType>, changesDelta?: ChangesDeltaBase): PromiseInterface<void | ItemEntry<ItemTypeType>[]>;
|
|
91
|
-
resolveDerivedValues<ItemTypeType extends ApiEnumItemType>(itemEntries: ItemEntry<ItemTypeType>[], columns: ColumnInfo<ItemTypeType>[], changesDelta?: ChangesDeltaBase): PromiseInterface<ItemEntry<ItemTypeType>[]>;
|
|
92
|
-
/**
|
|
93
|
-
* @description
|
|
94
|
-
* Creates a new {@link ItemEntry ItemEntry} from the passed {@link ChangesDeltaItemCreateDelta ChangesDeltaItemCreateDelta} and stores it in this transaction's {@link ItemCache ItemCache}
|
|
95
|
-
*/
|
|
96
|
-
createItemEntry(createTuple: ChangesDeltaItemCreateDelta): ItemEntry;
|
|
97
|
-
/**
|
|
98
|
-
* @description
|
|
99
|
-
* Gets the value of the given column, will look into the current delta before attempting to read itemChanges
|
|
100
|
-
*/
|
|
101
|
-
protected getItemIdByColumn<ItemTypeType extends ApiEnumItemType>(itemEntry: ItemEntry<ItemTypeType>, column: ColumnInfo<ItemTypeType>, changesDelta?: ChangesDeltaBase): ItemId;
|
|
102
|
-
}
|
|
1
|
+
import { ApiEnumItemType, ItemId } from '@rentman/backend-types';
|
|
2
|
+
import { AbstractCache, ApiFormatter, ApiQuery, ChangesDeltaBase, ChangesDeltaItemCreateDelta, ChangesDeltaItemUpdateDelta, ColumnInfo, ColumnUtil, ErrorHandlerInterface, FieldMap, ItemCache, ItemCacheFactory, ItemEntry, ItemEntryFactory, ItemEntryOptions, PromiseInterface, PromiseLibraryInterface, RequestColumnExpansionFactory, TransactionItemEntryChanges } from '../../internal';
|
|
3
|
+
export declare enum ItemCacheStatus {
|
|
4
|
+
CACHED = "cached",
|
|
5
|
+
NOT_CACHED = "not_cached",
|
|
6
|
+
NO_CHANGES = "no_changes"
|
|
7
|
+
}
|
|
8
|
+
export interface ItemEntryChanges<ItemTypeType extends ApiEnumItemType> {
|
|
9
|
+
fields: FieldMap<ItemTypeType>;
|
|
10
|
+
}
|
|
11
|
+
export interface ItemEntryChangesTuple<ItemTypeType extends ApiEnumItemType> {
|
|
12
|
+
entry: ItemEntry<ItemTypeType>;
|
|
13
|
+
changes: ItemEntryChanges<ItemTypeType>;
|
|
14
|
+
}
|
|
15
|
+
export declare type ProcessItemEntryChangesResult<ItemTypeType extends ApiEnumItemType> = {
|
|
16
|
+
status: ItemCacheStatus.NO_CHANGES | ItemCacheStatus.NOT_CACHED;
|
|
17
|
+
previous: null;
|
|
18
|
+
} | {
|
|
19
|
+
status: ItemCacheStatus.CACHED;
|
|
20
|
+
previous: FieldMap<ItemTypeType>;
|
|
21
|
+
};
|
|
22
|
+
export declare abstract class ItemHandlerBase {
|
|
23
|
+
protected columnUtil: ColumnUtil;
|
|
24
|
+
protected apiFormatter: ApiFormatter;
|
|
25
|
+
protected itemEntryFactory: ItemEntryFactory;
|
|
26
|
+
protected promiseService: PromiseLibraryInterface;
|
|
27
|
+
protected errorHandler: ErrorHandlerInterface;
|
|
28
|
+
protected requestColumnExpansionFactory: RequestColumnExpansionFactory;
|
|
29
|
+
protected transaction: AbstractCache;
|
|
30
|
+
readonly entries: ItemCache;
|
|
31
|
+
abstract itemChanges: {
|
|
32
|
+
[itemEntryId: number]: ItemEntryChanges<any>;
|
|
33
|
+
};
|
|
34
|
+
protected constructor(columnUtil: ColumnUtil, apiFormatter: ApiFormatter, itemEntryFactory: ItemEntryFactory, promiseService: PromiseLibraryInterface, errorHandler: ErrorHandlerInterface, requestColumnExpansionFactory: RequestColumnExpansionFactory, itemCacheFactory: ItemCacheFactory, transaction: AbstractCache);
|
|
35
|
+
/**
|
|
36
|
+
* @description
|
|
37
|
+
* Copies the passed ItemEntryChanges into a format the implementing ItemHandler can put in his ItemChanges
|
|
38
|
+
* @param itemEntryChanges
|
|
39
|
+
* @param entry
|
|
40
|
+
*/
|
|
41
|
+
abstract copyTransactionItemEntryChanges<ItemTypeType extends ApiEnumItemType>(itemEntryChanges: TransactionItemEntryChanges<ItemTypeType>, entry: ItemEntry<ItemTypeType>): ItemEntryChanges<ItemTypeType>;
|
|
42
|
+
/**
|
|
43
|
+
* @description
|
|
44
|
+
* Fetches the ItemEntries for the given query, does not look in the cache, since we don't know which ItemIds belong to the query !
|
|
45
|
+
*/
|
|
46
|
+
abstract fetchItemEntriesByQuery<ItemTypeType extends ApiEnumItemType>(itemType: ItemTypeType, query: ApiQuery, entryOptions: ItemEntryOptions): PromiseInterface<ItemEntry<ItemTypeType>[]>;
|
|
47
|
+
/**
|
|
48
|
+
* @description
|
|
49
|
+
* Fetches the ItemEntries for the given ItemIds
|
|
50
|
+
*/
|
|
51
|
+
abstract fetchItemEntries<ItemTypeType extends ApiEnumItemType>(itemType: ItemTypeType, itemIds: ItemId[], options: ItemEntryOptions): PromiseInterface<ItemEntry<ItemTypeType>[]>;
|
|
52
|
+
/**
|
|
53
|
+
* @description
|
|
54
|
+
* Fetches an ItemEntry with the given itemId
|
|
55
|
+
*/
|
|
56
|
+
abstract fetchItemEntry<ItemTypeType extends ApiEnumItemType>(itemType: ItemTypeType, itemId: ItemId, options: ItemEntryOptions, isRoot?: boolean): PromiseInterface<ItemEntry<ItemTypeType>>;
|
|
57
|
+
/**
|
|
58
|
+
* @description
|
|
59
|
+
* 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
|
|
60
|
+
*/
|
|
61
|
+
abstract processItemEntryChanges<ItemTypeType extends ApiEnumItemType>(itemEntryChangesTuple: ChangesDeltaItemUpdateDelta<ItemTypeType>, isCalledAfterSocketUpdate: boolean, createItemChangesIfNoneExist: boolean): ProcessItemEntryChangesResult<ItemTypeType>;
|
|
62
|
+
/**
|
|
63
|
+
* @description
|
|
64
|
+
* Traverses the column path and returns the fields of the derived item, returns undefined if the item isn't found
|
|
65
|
+
*
|
|
66
|
+
* ---------------------
|
|
67
|
+
*
|
|
68
|
+
* @remark
|
|
69
|
+
* Assumes the derived item's values are already cached
|
|
70
|
+
*/
|
|
71
|
+
getDerivedValues(itemEntry: ItemEntry, columnPath: string[]): Readonly<FieldMap> | undefined;
|
|
72
|
+
/**
|
|
73
|
+
* @description
|
|
74
|
+
* Returns the value of the columnPath, or undefined when the path couldn't be traversed
|
|
75
|
+
*
|
|
76
|
+
* @param itemEntry The root entry to start the path from
|
|
77
|
+
* @param columnPath Can either be an array of columnIds (['column', 'column2']) or a config column string ('column>column2')
|
|
78
|
+
*/
|
|
79
|
+
getDerivedValue<T extends any = any>(itemEntry: ItemEntry, columnPath: string[] | string): T | undefined;
|
|
80
|
+
/**
|
|
81
|
+
* @description
|
|
82
|
+
* Clears the entry from this transaction, removing it from the {@link ItemCache ItemCache} and removing all changes
|
|
83
|
+
*/
|
|
84
|
+
clearItemEntry(entry: ItemEntry): void;
|
|
85
|
+
/**
|
|
86
|
+
* @description
|
|
87
|
+
* Recursively fetches derived values as separate requests, instead of as columns of a primary item
|
|
88
|
+
* 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
|
|
89
|
+
*/
|
|
90
|
+
fetchDerivedValuesByColumn<ItemTypeType extends ApiEnumItemType>(itemEntries: ItemEntry<ItemTypeType>[], rootColumn: ColumnInfo<ItemTypeType>, changesDelta?: ChangesDeltaBase): PromiseInterface<void | ItemEntry<ItemTypeType>[]>;
|
|
91
|
+
resolveDerivedValues<ItemTypeType extends ApiEnumItemType>(itemEntries: ItemEntry<ItemTypeType>[], columns: ColumnInfo<ItemTypeType>[], changesDelta?: ChangesDeltaBase): PromiseInterface<ItemEntry<ItemTypeType>[]>;
|
|
92
|
+
/**
|
|
93
|
+
* @description
|
|
94
|
+
* Creates a new {@link ItemEntry ItemEntry} from the passed {@link ChangesDeltaItemCreateDelta ChangesDeltaItemCreateDelta} and stores it in this transaction's {@link ItemCache ItemCache}
|
|
95
|
+
*/
|
|
96
|
+
createItemEntry(createTuple: ChangesDeltaItemCreateDelta): ItemEntry;
|
|
97
|
+
/**
|
|
98
|
+
* @description
|
|
99
|
+
* Gets the value of the given column, will look into the current delta before attempting to read itemChanges
|
|
100
|
+
*/
|
|
101
|
+
protected getItemIdByColumn<ItemTypeType extends ApiEnumItemType>(itemEntry: ItemEntry<ItemTypeType>, column: ColumnInfo<ItemTypeType>, changesDelta?: ChangesDeltaBase): ItemId;
|
|
102
|
+
}
|
|
@@ -1,78 +1,78 @@
|
|
|
1
|
-
import { ApiEnumItemType } from '@rentman/backend-types';
|
|
2
|
-
import { AbstractCache, ApiRequestColumn, 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';
|
|
3
|
-
/**
|
|
4
|
-
* @description
|
|
5
|
-
* The {@link ServerCache ServerCache} is responsible for keeping track of {@link ItemEntry ItemEntries} and {@link CollectionEntry CollectionEntries}
|
|
6
|
-
* which are saved on the server.
|
|
7
|
-
*
|
|
8
|
-
* It's basically a local representation of the database
|
|
9
|
-
*/
|
|
10
|
-
export declare class ServerCache extends AbstractCache {
|
|
11
|
-
dependencies: ServerCacheDependencyInterface;
|
|
12
|
-
readonly itemHandler: ServerItemHandler;
|
|
13
|
-
readonly cachedQueryHandler: ServerCachedQueryHandler;
|
|
14
|
-
parent: null;
|
|
15
|
-
constructor(dependencies: ServerCacheDependencyInterface, core: RmCore);
|
|
16
|
-
getServerCache(): ServerCache;
|
|
17
|
-
createChild(id?: string, validatorFactory?: TransactionValidatorFactory, options?: TransactionOptions): TransactionCache;
|
|
18
|
-
expandCollectionResources<ItemTypeType extends ApiEnumItemType>(itemType: ItemTypeType, collections: CollectionResourceParentIdMap<ItemTypeType>, newRequestColumns: ApiRequestColumn[]): PromiseInterface<CollectionResourceParentIdMap>;
|
|
19
|
-
/**
|
|
20
|
-
*
|
|
21
|
-
* @param response
|
|
22
|
-
* @param requestColumnMap
|
|
23
|
-
* @param isCalledAfterSocketUpdate
|
|
24
|
-
* @param changesDelta
|
|
25
|
-
* @param conversionMap
|
|
26
|
-
* @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))
|
|
27
|
-
*/
|
|
28
|
-
processResponse(response: ApiResponseProcessor, requestColumnMap: ApiRequestColumnMap, isCalledAfterSocketUpdate?: boolean, changesDelta?: ChangesDelta, directRequestItemMap?: ItemTypeMap<Record<string, boolean>>, conversionMap?: ItemIdConversionMap): PromiseInterface<ChangesDeltaResult>;
|
|
29
|
-
/**
|
|
30
|
-
* @description
|
|
31
|
-
* Applies changes to this transaction and its children
|
|
32
|
-
* ServerCache.applyChangesFromParent should be used when processing an API update/create/delete
|
|
33
|
-
*/
|
|
34
|
-
applyChangesFromParent(parentChangesDelta: ParentChangesDelta, isCalledAfterSocketUpdate?: boolean): PromiseInterface<void>;
|
|
35
|
-
/**
|
|
36
|
-
* @description
|
|
37
|
-
* Gets the fields required to set the parent
|
|
38
|
-
*/
|
|
39
|
-
getLinkFieldsByParent<ItemTypeType extends ApiEnumItemType>(parent: EntryParent, itemType: ItemTypeType): Partial<FieldMap<ItemTypeType>>;
|
|
40
|
-
/**
|
|
41
|
-
* @description
|
|
42
|
-
* Gets the entry's parent
|
|
43
|
-
*
|
|
44
|
-
* @param itemEntry The entry to get the parent from
|
|
45
|
-
* @param _fromInitial Unused parameter, there for alignment with {@link TransactionCache.getParent TransactionCache.getParent]
|
|
46
|
-
* @param _providedFields Unused parameter, there for alignment with {@link TransactionCache.getParent TransactionCache.getParent]
|
|
47
|
-
*
|
|
48
|
-
* @remark
|
|
49
|
-
* Use {@link CollectionResource.getParent CollectionResource.getParent} instead of {@link TransactionCache.getParent TransactionCache.getParent} if you're getting the parent in the onRemove callback
|
|
50
|
-
*/
|
|
51
|
-
getParent<ItemTypeType extends ApiEnumItemType = any>(itemEntry: ItemEntry<ItemTypeType>, _fromInitial?: boolean, _providedFields?: FieldMap<ItemTypeType>): EntryParentNull;
|
|
52
|
-
getItemChangesRecursively<ItemTypeType extends ApiEnumItemType>(itemEntryId: ItemEntry<ItemTypeType>['id'], copyFields?: boolean): FieldMap<ItemTypeType>;
|
|
53
|
-
/**
|
|
54
|
-
* @description
|
|
55
|
-
* Only takes the local changes into account, used for saving
|
|
56
|
-
*/
|
|
57
|
-
getLocalItemEntryChangesTuple<ItemTypeType extends ApiEnumItemType>(itemEntryId: ItemEntry<ItemTypeType>['id']): ItemEntryChangesTuple<ItemTypeType>;
|
|
58
|
-
getCollectionChangesRecursively<ItemTypeType extends ApiEnumItemType>(itemType: ItemTypeType, parsedQuery: CollectionQuery): CachedQueryItem<ItemTypeType> | undefined;
|
|
59
|
-
/**
|
|
60
|
-
* @description
|
|
61
|
-
* Invalidates the complete server cache, all items will be re-fetched whenever they are requested
|
|
62
|
-
*/
|
|
63
|
-
invalidateCache(): void;
|
|
64
|
-
/**
|
|
65
|
-
* @description
|
|
66
|
-
* Merges the passed changes from the child Transaction into this Transaction's own changes and then propagates
|
|
67
|
-
* them to all child Transactions
|
|
68
|
-
*/
|
|
69
|
-
applyChangesFromChild(transaction: TransactionCache, breakUpByParent?: boolean, onAfterCreateCallback?: OnAfterCreateCallback): PromiseInterface<ItemIdConversionMap>;
|
|
70
|
-
/**
|
|
71
|
-
* @description
|
|
72
|
-
* Applies changes to this transaction and its children
|
|
73
|
-
* ServerCache.applyChangesDelta should be used when processing an API response which should create new entries on the ServerCache (such as a Query)
|
|
74
|
-
*/
|
|
75
|
-
applyChangesDelta(changesDelta: ChangesDelta, isCalledAfterSocketUpdate?: boolean, conversionMap?: ItemIdConversionMap): PromiseInterface<ChangesDeltaResult>;
|
|
76
|
-
getLocalItemEntry(itemEntryId: ItemEntry['id']): ItemEntry | undefined;
|
|
77
|
-
getLocalItemEntryByItemId(itemType: ApiEnumItemType, itemId: ItemEntry['itemId']): ItemEntry | undefined;
|
|
78
|
-
}
|
|
1
|
+
import { ApiEnumItemType } from '@rentman/backend-types';
|
|
2
|
+
import { AbstractCache, ApiRequestColumn, 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';
|
|
3
|
+
/**
|
|
4
|
+
* @description
|
|
5
|
+
* The {@link ServerCache ServerCache} is responsible for keeping track of {@link ItemEntry ItemEntries} and {@link CollectionEntry CollectionEntries}
|
|
6
|
+
* which are saved on the server.
|
|
7
|
+
*
|
|
8
|
+
* It's basically a local representation of the database
|
|
9
|
+
*/
|
|
10
|
+
export declare class ServerCache extends AbstractCache {
|
|
11
|
+
dependencies: ServerCacheDependencyInterface;
|
|
12
|
+
readonly itemHandler: ServerItemHandler;
|
|
13
|
+
readonly cachedQueryHandler: ServerCachedQueryHandler;
|
|
14
|
+
parent: null;
|
|
15
|
+
constructor(dependencies: ServerCacheDependencyInterface, core: RmCore);
|
|
16
|
+
getServerCache(): ServerCache;
|
|
17
|
+
createChild(id?: string, validatorFactory?: TransactionValidatorFactory, options?: TransactionOptions): TransactionCache;
|
|
18
|
+
expandCollectionResources<ItemTypeType extends ApiEnumItemType>(itemType: ItemTypeType, collections: CollectionResourceParentIdMap<ItemTypeType>, newRequestColumns: ApiRequestColumn[]): PromiseInterface<CollectionResourceParentIdMap>;
|
|
19
|
+
/**
|
|
20
|
+
*
|
|
21
|
+
* @param response
|
|
22
|
+
* @param requestColumnMap
|
|
23
|
+
* @param isCalledAfterSocketUpdate
|
|
24
|
+
* @param changesDelta
|
|
25
|
+
* @param conversionMap
|
|
26
|
+
* @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))
|
|
27
|
+
*/
|
|
28
|
+
processResponse(response: ApiResponseProcessor, requestColumnMap: ApiRequestColumnMap, isCalledAfterSocketUpdate?: boolean, changesDelta?: ChangesDelta, directRequestItemMap?: ItemTypeMap<Record<string, boolean>>, conversionMap?: ItemIdConversionMap): PromiseInterface<ChangesDeltaResult>;
|
|
29
|
+
/**
|
|
30
|
+
* @description
|
|
31
|
+
* Applies changes to this transaction and its children
|
|
32
|
+
* ServerCache.applyChangesFromParent should be used when processing an API update/create/delete
|
|
33
|
+
*/
|
|
34
|
+
applyChangesFromParent(parentChangesDelta: ParentChangesDelta, isCalledAfterSocketUpdate?: boolean): PromiseInterface<void>;
|
|
35
|
+
/**
|
|
36
|
+
* @description
|
|
37
|
+
* Gets the fields required to set the parent
|
|
38
|
+
*/
|
|
39
|
+
getLinkFieldsByParent<ItemTypeType extends ApiEnumItemType>(parent: EntryParent, itemType: ItemTypeType): Partial<FieldMap<ItemTypeType>>;
|
|
40
|
+
/**
|
|
41
|
+
* @description
|
|
42
|
+
* Gets the entry's parent
|
|
43
|
+
*
|
|
44
|
+
* @param itemEntry The entry to get the parent from
|
|
45
|
+
* @param _fromInitial Unused parameter, there for alignment with {@link TransactionCache.getParent TransactionCache.getParent]
|
|
46
|
+
* @param _providedFields Unused parameter, there for alignment with {@link TransactionCache.getParent TransactionCache.getParent]
|
|
47
|
+
*
|
|
48
|
+
* @remark
|
|
49
|
+
* Use {@link CollectionResource.getParent CollectionResource.getParent} instead of {@link TransactionCache.getParent TransactionCache.getParent} if you're getting the parent in the onRemove callback
|
|
50
|
+
*/
|
|
51
|
+
getParent<ItemTypeType extends ApiEnumItemType = any>(itemEntry: ItemEntry<ItemTypeType>, _fromInitial?: boolean, _providedFields?: FieldMap<ItemTypeType>): EntryParentNull;
|
|
52
|
+
getItemChangesRecursively<ItemTypeType extends ApiEnumItemType>(itemEntryId: ItemEntry<ItemTypeType>['id'], copyFields?: boolean): FieldMap<ItemTypeType>;
|
|
53
|
+
/**
|
|
54
|
+
* @description
|
|
55
|
+
* Only takes the local changes into account, used for saving
|
|
56
|
+
*/
|
|
57
|
+
getLocalItemEntryChangesTuple<ItemTypeType extends ApiEnumItemType>(itemEntryId: ItemEntry<ItemTypeType>['id']): ItemEntryChangesTuple<ItemTypeType>;
|
|
58
|
+
getCollectionChangesRecursively<ItemTypeType extends ApiEnumItemType>(itemType: ItemTypeType, parsedQuery: CollectionQuery): CachedQueryItem<ItemTypeType> | undefined;
|
|
59
|
+
/**
|
|
60
|
+
* @description
|
|
61
|
+
* Invalidates the complete server cache, all items will be re-fetched whenever they are requested
|
|
62
|
+
*/
|
|
63
|
+
invalidateCache(): void;
|
|
64
|
+
/**
|
|
65
|
+
* @description
|
|
66
|
+
* Merges the passed changes from the child Transaction into this Transaction's own changes and then propagates
|
|
67
|
+
* them to all child Transactions
|
|
68
|
+
*/
|
|
69
|
+
applyChangesFromChild(transaction: TransactionCache, breakUpByParent?: boolean, onAfterCreateCallback?: OnAfterCreateCallback): PromiseInterface<ItemIdConversionMap>;
|
|
70
|
+
/**
|
|
71
|
+
* @description
|
|
72
|
+
* Applies changes to this transaction and its children
|
|
73
|
+
* ServerCache.applyChangesDelta should be used when processing an API response which should create new entries on the ServerCache (such as a Query)
|
|
74
|
+
*/
|
|
75
|
+
applyChangesDelta(changesDelta: ChangesDelta, isCalledAfterSocketUpdate?: boolean, conversionMap?: ItemIdConversionMap): PromiseInterface<ChangesDeltaResult>;
|
|
76
|
+
getLocalItemEntry(itemEntryId: ItemEntry['id']): ItemEntry | undefined;
|
|
77
|
+
getLocalItemEntryByItemId(itemType: ApiEnumItemType, itemId: ItemEntry['itemId']): ItemEntry | undefined;
|
|
78
|
+
}
|
|
@@ -1,25 +1,25 @@
|
|
|
1
|
-
import { ApiEnumItemType, ItemId } from '@rentman/backend-types';
|
|
2
|
-
import { ApiRequestColumns, ApiRequestService, CachedQueryHandlerBase, CachedQueryItem, CollectionEntryService, CollectionOptions, CollectionQuery, ColumnSubsetCache, ColumnSubsetCacheFactory, ColumnUtil, ErrorHandlerInterface, ItemEntry, ParentIdMap, PromiseInterface, PromiseLibraryInterface, RequestBufferManager, RequestColumnExpansionFactory, ServerCache, ServerItemHandler } from '../../../internal';
|
|
3
|
-
export declare class ServerCachedQueryHandler extends CachedQueryHandlerBase {
|
|
4
|
-
private columnSubsetCacheFactory;
|
|
5
|
-
private requestBufferManager;
|
|
6
|
-
private apiRequestService;
|
|
7
|
-
private errorHandler;
|
|
8
|
-
private itemHandler;
|
|
9
|
-
protected transaction: ServerCache;
|
|
10
|
-
constructor(columnSubsetCacheFactory: ColumnSubsetCacheFactory, requestBufferManager: RequestBufferManager, requestColumnExpansionFactory: RequestColumnExpansionFactory, apiRequestService: ApiRequestService, collectionEntryService: CollectionEntryService, errorHandler: ErrorHandlerInterface, itemHandler: ServerItemHandler, promiseService: PromiseLibraryInterface, columnUtil: ColumnUtil, transaction: ServerCache);
|
|
11
|
-
__fetchCachedQueryItem<ItemTypeType extends ApiEnumItemType>(itemType: ItemTypeType, options: CollectionOptions): PromiseInterface<CachedQueryItem<ItemTypeType>>;
|
|
12
|
-
__fetchLinkedCachedQueryItems<ItemTypeType extends ApiEnumItemType>(parentType: ApiEnumItemType, parentIdArray: ItemId[] | (() => ItemId[]), itemType: ItemTypeType, options: CollectionOptions): PromiseInterface<ParentIdMap<CachedQueryItem<ItemTypeType>>>;
|
|
13
|
-
__addItemEntriesToCachedQueries<ItemTypeType extends ApiEnumItemType = any>(itemType: ItemTypeType, parsedQuery: CollectionQuery, itemEntries: ItemEntry<ItemTypeType>[]): void;
|
|
14
|
-
/**
|
|
15
|
-
* @description
|
|
16
|
-
* Expands the columns of the items in the cached query
|
|
17
|
-
*/
|
|
18
|
-
__expandCachedQuery<ItemTypeType extends ApiEnumItemType = any>(cachedQuery: CachedQueryItem<ItemTypeType>, newColumns: ApiRequestColumns, force?: boolean): PromiseInterface<CachedQueryItem<ItemTypeType>>;
|
|
19
|
-
/**
|
|
20
|
-
* @description
|
|
21
|
-
* Fetches the data for the passed ItemType/options, will do nothing if the requested CollectionEntry/columns are already cached.
|
|
22
|
-
* Will create a new {@link CollectionEntry CollectionEntry} if the CollectionEntry didn't exist yet
|
|
23
|
-
*/
|
|
24
|
-
__fetchItemEntriesByQueryData<ItemTypeType extends ApiEnumItemType>(itemType: ItemTypeType, options: CollectionOptions<ItemTypeType>, columnSubsetCache: ColumnSubsetCache<ItemTypeType>, collectionQuery: CollectionQuery, batchedLinkedToQuery?: CollectionQuery): PromiseInterface<CachedQueryItem<ItemTypeType>>;
|
|
25
|
-
}
|
|
1
|
+
import { ApiEnumItemType, ItemId } from '@rentman/backend-types';
|
|
2
|
+
import { ApiRequestColumns, ApiRequestService, CachedQueryHandlerBase, CachedQueryItem, CollectionEntryService, CollectionOptions, CollectionQuery, ColumnSubsetCache, ColumnSubsetCacheFactory, ColumnUtil, ErrorHandlerInterface, ItemEntry, ParentIdMap, PromiseInterface, PromiseLibraryInterface, RequestBufferManager, RequestColumnExpansionFactory, ServerCache, ServerItemHandler } from '../../../internal';
|
|
3
|
+
export declare class ServerCachedQueryHandler extends CachedQueryHandlerBase {
|
|
4
|
+
private columnSubsetCacheFactory;
|
|
5
|
+
private requestBufferManager;
|
|
6
|
+
private apiRequestService;
|
|
7
|
+
private errorHandler;
|
|
8
|
+
private itemHandler;
|
|
9
|
+
protected transaction: ServerCache;
|
|
10
|
+
constructor(columnSubsetCacheFactory: ColumnSubsetCacheFactory, requestBufferManager: RequestBufferManager, requestColumnExpansionFactory: RequestColumnExpansionFactory, apiRequestService: ApiRequestService, collectionEntryService: CollectionEntryService, errorHandler: ErrorHandlerInterface, itemHandler: ServerItemHandler, promiseService: PromiseLibraryInterface, columnUtil: ColumnUtil, transaction: ServerCache);
|
|
11
|
+
__fetchCachedQueryItem<ItemTypeType extends ApiEnumItemType>(itemType: ItemTypeType, options: CollectionOptions): PromiseInterface<CachedQueryItem<ItemTypeType>>;
|
|
12
|
+
__fetchLinkedCachedQueryItems<ItemTypeType extends ApiEnumItemType>(parentType: ApiEnumItemType, parentIdArray: ItemId[] | (() => ItemId[]), itemType: ItemTypeType, options: CollectionOptions): PromiseInterface<ParentIdMap<CachedQueryItem<ItemTypeType>>>;
|
|
13
|
+
__addItemEntriesToCachedQueries<ItemTypeType extends ApiEnumItemType = any>(itemType: ItemTypeType, parsedQuery: CollectionQuery, itemEntries: ItemEntry<ItemTypeType>[]): void;
|
|
14
|
+
/**
|
|
15
|
+
* @description
|
|
16
|
+
* Expands the columns of the items in the cached query
|
|
17
|
+
*/
|
|
18
|
+
__expandCachedQuery<ItemTypeType extends ApiEnumItemType = any>(cachedQuery: CachedQueryItem<ItemTypeType>, newColumns: ApiRequestColumns, force?: boolean): PromiseInterface<CachedQueryItem<ItemTypeType>>;
|
|
19
|
+
/**
|
|
20
|
+
* @description
|
|
21
|
+
* Fetches the data for the passed ItemType/options, will do nothing if the requested CollectionEntry/columns are already cached.
|
|
22
|
+
* Will create a new {@link CollectionEntry CollectionEntry} if the CollectionEntry didn't exist yet
|
|
23
|
+
*/
|
|
24
|
+
__fetchItemEntriesByQueryData<ItemTypeType extends ApiEnumItemType>(itemType: ItemTypeType, options: CollectionOptions<ItemTypeType>, columnSubsetCache: ColumnSubsetCache<ItemTypeType>, collectionQuery: CollectionQuery, batchedLinkedToQuery?: CollectionQuery): PromiseInterface<CachedQueryItem<ItemTypeType>>;
|
|
25
|
+
}
|