@rentman/rm-core 6.0.2 → 6.1.2
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 +722 -713
- package/dist/rm-core.js +9636 -9616
- package/dist/rm-core.min.js +1 -1
- package/dist/types/classes/ApiFormatter.d.ts +55 -55
- package/dist/types/classes/ApiRequestService.d.ts +20 -20
- package/dist/types/classes/ApiResponseProcessor.d.ts +31 -31
- package/dist/types/classes/ChangesCompilation.d.ts +34 -34
- package/dist/types/classes/ChangesDelta.d.ts +61 -59
- package/dist/types/classes/ChangesDeltaBase.d.ts +50 -50
- package/dist/types/classes/ChangesProcessor.d.ts +47 -47
- package/dist/types/classes/CollectionEntryService.d.ts +26 -26
- package/dist/types/classes/CollectionMatcherBase.d.ts +21 -21
- package/dist/types/classes/CollectionMatcherCachedCollectionProcessor.d.ts +31 -31
- package/dist/types/classes/CollectionResourceService.d.ts +7 -7
- package/dist/types/classes/ColumnCache.d.ts +21 -21
- package/dist/types/classes/ColumnExpansion.d.ts +22 -22
- package/dist/types/classes/ColumnHandler.d.ts +21 -21
- package/dist/types/classes/ColumnInfo.d.ts +14 -14
- package/dist/types/classes/ColumnSet.d.ts +38 -38
- package/dist/types/classes/ColumnSubsetCache.d.ts +10 -10
- package/dist/types/classes/ColumnUtil.d.ts +99 -99
- package/dist/types/classes/ConversionMapService.d.ts +27 -27
- package/dist/types/classes/CreateRequest.d.ts +19 -19
- package/dist/types/classes/CreatedChangesDelta.d.ts +15 -15
- package/dist/types/classes/InternalChangesDelta.d.ts +39 -39
- package/dist/types/classes/ItemCache.d.ts +29 -29
- package/dist/types/classes/ItemCreateService.d.ts +24 -24
- package/dist/types/classes/ItemEntryService.d.ts +34 -34
- package/dist/types/classes/KeyService.d.ts +17 -17
- package/dist/types/classes/LockService.d.ts +32 -32
- package/dist/types/classes/ModuleChangesCompilation.d.ts +18 -18
- package/dist/types/classes/QueryColumnExtractor.d.ts +20 -20
- package/dist/types/classes/QueryLinkedToParser.d.ts +16 -16
- package/dist/types/classes/QueryLocallyMatchableParser.d.ts +19 -19
- package/dist/types/classes/QueryMatcher.d.ts +18 -18
- package/dist/types/classes/QueryParser.d.ts +24 -24
- package/dist/types/classes/QueryParserBase.d.ts +29 -29
- package/dist/types/classes/QueryParserIdUpdater.d.ts +16 -16
- package/dist/types/classes/QueryService.d.ts +18 -18
- package/dist/types/classes/RequestBuffer.d.ts +28 -28
- package/dist/types/classes/RequestBufferManager.d.ts +25 -25
- package/dist/types/classes/RequestColumnExpansion.d.ts +15 -15
- package/dist/types/classes/SocketMessageHandler.d.ts +39 -39
- package/dist/types/classes/TemplateCache.d.ts +66 -66
- package/dist/types/classes/Util.d.ts +30 -30
- package/dist/types/classes/cache/AbstractCache.d.ts +102 -102
- package/dist/types/classes/cache/CachedQueryHandlerBase.d.ts +73 -73
- package/dist/types/classes/cache/CollectionMatcherCachedQueryProcessor.d.ts +35 -35
- package/dist/types/classes/cache/ItemHandlerBase.d.ts +93 -93
- package/dist/types/classes/cache/server/ServerCache.d.ts +82 -82
- package/dist/types/classes/cache/server/ServerCachedQueryHandler.d.ts +34 -34
- package/dist/types/classes/cache/server/ServerItemHandler.d.ts +52 -52
- package/dist/types/classes/cache/transaction/TransactionCache.d.ts +330 -330
- package/dist/types/classes/cache/transaction/TransactionCachedQueryHandler.d.ts +23 -23
- package/dist/types/classes/cache/transaction/TransactionCollectionHandler.d.ts +28 -28
- package/dist/types/classes/cache/transaction/TransactionEventHandler.d.ts +24 -24
- package/dist/types/classes/cache/transaction/TransactionItemHandler.d.ts +90 -90
- package/dist/types/classes/cache/transaction/TransactionValidator.d.ts +28 -28
- package/dist/types/classes/index.d.ts +46 -46
- package/dist/types/constants.d.ts +7 -7
- package/dist/types/core.d.ts +51 -51
- package/dist/types/factories/ApiResponseProcessorFactory.d.ts +6 -6
- package/dist/types/factories/ChangesCompilationFactory.d.ts +6 -6
- package/dist/types/factories/ChangesDeltaFactory.d.ts +13 -11
- package/dist/types/factories/ChangesProcessorFactory.d.ts +22 -22
- package/dist/types/factories/CollectionEntryFactory.d.ts +14 -14
- package/dist/types/factories/CollectionMatcherFactory.d.ts +19 -19
- package/dist/types/factories/CollectionResourceFactory.d.ts +22 -22
- package/dist/types/factories/ColumnExpansionFactory.d.ts +8 -8
- package/dist/types/factories/ColumnInfoFactory.d.ts +7 -7
- package/dist/types/factories/ColumnSetFactory.d.ts +19 -19
- package/dist/types/factories/ColumnSubsetCacheFactory.d.ts +7 -7
- package/dist/types/factories/CreateRequestFactory.d.ts +11 -11
- package/dist/types/factories/ItemCacheFactory.d.ts +8 -8
- package/dist/types/factories/ItemEntryFactory.d.ts +15 -15
- package/dist/types/factories/ItemResourceFactory.d.ts +14 -14
- package/dist/types/factories/ModuleChangesCompilationFactory.d.ts +5 -5
- package/dist/types/factories/QueryMatcherFactory.d.ts +7 -7
- package/dist/types/factories/QueryParserFactory.d.ts +6 -6
- package/dist/types/factories/RequestColumnExpansionFactory.d.ts +6 -6
- package/dist/types/factories/TemplateFactory.d.ts +10 -10
- package/dist/types/factories/TransactionCacheFactory.d.ts +15 -15
- package/dist/types/factories/index.d.ts +21 -21
- package/dist/types/index.d.ts +7 -7
- package/dist/types/interfaces/AbstractCacheDependencyInterface.d.ts +43 -43
- package/dist/types/interfaces/ApiRequestServiceInterface.d.ts +11 -11
- package/dist/types/interfaces/AuthInterface.d.ts +9 -9
- 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 +7 -7
- package/dist/types/interfaces/SocketMessageInterface.d.ts +3 -3
- package/dist/types/interfaces/TransactionCollectionHandlerDependencyInterface.d.ts +20 -20
- package/dist/types/interfaces/TransactionItemHandlerDependencyInterface.d.ts +26 -26
- package/dist/types/interfaces/index.d.ts +11 -11
- package/dist/types/models/CollectionEntry.d.ts +23 -23
- package/dist/types/models/CollectionOptions.d.ts +18 -18
- package/dist/types/models/CollectionResource.d.ts +72 -72
- package/dist/types/models/ItemEntry.d.ts +19 -19
- package/dist/types/models/ItemEntryOptions.d.ts +8 -8
- package/dist/types/models/ItemResource.d.ts +84 -84
- package/dist/types/models/Template.d.ts +11 -11
- package/dist/types/models/index.d.ts +7 -7
- package/dist/types/types/ItemTypesCollection.d.ts +263 -263
- package/dist/types/types/PromiseInterface.d.ts +2 -2
- package/dist/types/types/index.d.ts +2 -2
- package/package.json +36 -36
- package/readme.md +15 -15
|
@@ -1,82 +1,82 @@
|
|
|
1
|
-
import { ChangesDelta, InternalChangesDelta, TransactionCache, TransactionValidatorFactory } from '../..';
|
|
2
|
-
import { RmCore } from '../../../core';
|
|
3
|
-
import { ServerCacheDependencyInterface } from '../../../interfaces/ServerCacheDependencyInterface';
|
|
4
|
-
import { ItemEntry } from '../../../models';
|
|
5
|
-
import { ApiRequestColumn, ApiRequestColumnMap, CollectionQuery, CollectionResourceParentIdMap, EntryParent, EntryParentNull, FieldMap, ItemIdConversionMap, ItemType, PromiseInterface } from '../../../types';
|
|
6
|
-
import { ApiResponseProcessor } from '../../ApiResponseProcessor';
|
|
7
|
-
import { ChangesDeltaResult } from '../../ChangesDeltaBase';
|
|
8
|
-
import { OnAfterCreateCallback } from '../../ChangesProcessor';
|
|
9
|
-
import { AbstractCache } from '../AbstractCache';
|
|
10
|
-
import { CachedQueryItem } from '../CachedQueryHandlerBase';
|
|
11
|
-
import { ServerCachedQueryHandler } from './ServerCachedQueryHandler';
|
|
12
|
-
import { ServerItemEntryChanges, ServerItemHandler } from './ServerItemHandler';
|
|
13
|
-
/**
|
|
14
|
-
* @description
|
|
15
|
-
* The {@link ServerCache ServerCache} is responsible for keeping track of {@link ItemEntry ItemEntries} and {@link CollectionEntry CollectionEntries}
|
|
16
|
-
* which are saved on the server.
|
|
17
|
-
*
|
|
18
|
-
* It's basically a local representation of the database
|
|
19
|
-
*/
|
|
20
|
-
export declare class ServerCache extends AbstractCache {
|
|
21
|
-
dependencies: ServerCacheDependencyInterface;
|
|
22
|
-
readonly itemHandler: ServerItemHandler;
|
|
23
|
-
readonly cachedQueryHandler: ServerCachedQueryHandler;
|
|
24
|
-
parent: null;
|
|
25
|
-
constructor(dependencies: ServerCacheDependencyInterface, core: RmCore);
|
|
26
|
-
getServerCache(): ServerCache;
|
|
27
|
-
createChild(id?: string, validatorFactory?: TransactionValidatorFactory): TransactionCache;
|
|
28
|
-
expandCollectionResources<ItemTypeType extends ItemType>(itemType: ItemTypeType, collections: CollectionResourceParentIdMap<ItemTypeType>, newRequestColumns: ApiRequestColumn[]): PromiseInterface<CollectionResourceParentIdMap>;
|
|
29
|
-
processResponse(response: ApiResponseProcessor, requestColumnMap: ApiRequestColumnMap, isCalledAfterApiSave?: boolean, isCalledAfterSocketUpdate?: boolean, changesDelta?: ChangesDelta): PromiseInterface<ChangesDeltaResult>;
|
|
30
|
-
/**
|
|
31
|
-
* @description
|
|
32
|
-
* 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
|
|
33
|
-
*/
|
|
34
|
-
applyChangesFromParent(internalChangesDelta: InternalChangesDelta, isCalledAfterApiSave?: boolean, isCalledAfterSocketUpdate?: boolean): PromiseInterface<void>;
|
|
35
|
-
/**
|
|
36
|
-
* @description
|
|
37
|
-
* Gets the fields required to set the parent
|
|
38
|
-
*/
|
|
39
|
-
getLinkFieldsByParent<ItemTypeType extends ItemType>(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 ItemType = any>(itemEntry: ItemEntry<ItemTypeType>, _fromInitial?: boolean, _providedFields?: FieldMap<ItemTypeType>): EntryParentNull;
|
|
52
|
-
getItemChangesRecursively(itemEntryId: ItemEntry['id'], copyFields?: boolean): FieldMap;
|
|
53
|
-
/**
|
|
54
|
-
* @description
|
|
55
|
-
* Only takes the local changes into account, used for saving
|
|
56
|
-
*/
|
|
57
|
-
getLocalItemEntryChangesTuple(itemEntryId: ItemEntry['id']): {
|
|
58
|
-
entry: ItemEntry;
|
|
59
|
-
changes: ServerItemEntryChanges;
|
|
60
|
-
};
|
|
61
|
-
getCollectionChangesRecursively<ItemTypeType extends ItemType>(itemType: ItemTypeType, parsedQuery: CollectionQuery): CachedQueryItem<ItemTypeType> | undefined;
|
|
62
|
-
/**
|
|
63
|
-
* @description
|
|
64
|
-
* Invalidates the complete server cache, all items will be re-fetched whenever they are requested
|
|
65
|
-
*/
|
|
66
|
-
invalidateCache(): void;
|
|
67
|
-
/**
|
|
68
|
-
* @description
|
|
69
|
-
* Merges the passed changes from the child Transaction into this Transaction's own changes and then propagates
|
|
70
|
-
* them to all child Transactions
|
|
71
|
-
*/
|
|
72
|
-
applyChangesFromChild(transaction: TransactionCache, breakUpByParent?: boolean, onAfterCreateCallback?: OnAfterCreateCallback): PromiseInterface<ItemIdConversionMap>;
|
|
73
|
-
/**
|
|
74
|
-
* @description
|
|
75
|
-
* Applies changes to this transaction and its children
|
|
76
|
-
* Differs from {@link TransactionCache.applyChangesDelta TransactionCache.applyChangesDelta} in the handling of deleted entries and the applyChangesFromParent call
|
|
77
|
-
*/
|
|
78
|
-
applyChangesDelta(changesDelta: ChangesDelta, isCalledAfterApiSave?: boolean, isCalledAfterSocketUpdate?: boolean): PromiseInterface<ChangesDeltaResult>;
|
|
79
|
-
getLocalItemEntry(itemEntryId: ItemEntry['id']): ItemEntry | undefined;
|
|
80
|
-
getLocalItemEntryByItemId(itemType: ItemType, itemId: ItemEntry['itemId']): ItemEntry | undefined;
|
|
81
|
-
getChangesFromItemChanges<ItemTypeType extends ItemType = any>(changesObject: ServerItemEntryChanges<ItemTypeType>): FieldMap<ItemTypeType>;
|
|
82
|
-
}
|
|
1
|
+
import { ChangesDelta, InternalChangesDelta, TransactionCache, TransactionValidatorFactory } from '../..';
|
|
2
|
+
import { RmCore } from '../../../core';
|
|
3
|
+
import { ServerCacheDependencyInterface } from '../../../interfaces/ServerCacheDependencyInterface';
|
|
4
|
+
import { ItemEntry } from '../../../models';
|
|
5
|
+
import { ApiRequestColumn, ApiRequestColumnMap, CollectionQuery, CollectionResourceParentIdMap, EntryParent, EntryParentNull, FieldMap, ItemIdConversionMap, ItemType, PromiseInterface } from '../../../types';
|
|
6
|
+
import { ApiResponseProcessor } from '../../ApiResponseProcessor';
|
|
7
|
+
import { ChangesDeltaResult } from '../../ChangesDeltaBase';
|
|
8
|
+
import { OnAfterCreateCallback } from '../../ChangesProcessor';
|
|
9
|
+
import { AbstractCache } from '../AbstractCache';
|
|
10
|
+
import { CachedQueryItem } from '../CachedQueryHandlerBase';
|
|
11
|
+
import { ServerCachedQueryHandler } from './ServerCachedQueryHandler';
|
|
12
|
+
import { ServerItemEntryChanges, ServerItemHandler } from './ServerItemHandler';
|
|
13
|
+
/**
|
|
14
|
+
* @description
|
|
15
|
+
* The {@link ServerCache ServerCache} is responsible for keeping track of {@link ItemEntry ItemEntries} and {@link CollectionEntry CollectionEntries}
|
|
16
|
+
* which are saved on the server.
|
|
17
|
+
*
|
|
18
|
+
* It's basically a local representation of the database
|
|
19
|
+
*/
|
|
20
|
+
export declare class ServerCache extends AbstractCache {
|
|
21
|
+
dependencies: ServerCacheDependencyInterface;
|
|
22
|
+
readonly itemHandler: ServerItemHandler;
|
|
23
|
+
readonly cachedQueryHandler: ServerCachedQueryHandler;
|
|
24
|
+
parent: null;
|
|
25
|
+
constructor(dependencies: ServerCacheDependencyInterface, core: RmCore);
|
|
26
|
+
getServerCache(): ServerCache;
|
|
27
|
+
createChild(id?: string, validatorFactory?: TransactionValidatorFactory): TransactionCache;
|
|
28
|
+
expandCollectionResources<ItemTypeType extends ItemType>(itemType: ItemTypeType, collections: CollectionResourceParentIdMap<ItemTypeType>, newRequestColumns: ApiRequestColumn[]): PromiseInterface<CollectionResourceParentIdMap>;
|
|
29
|
+
processResponse(response: ApiResponseProcessor, requestColumnMap: ApiRequestColumnMap, isCalledAfterApiSave?: boolean, isCalledAfterSocketUpdate?: boolean, changesDelta?: ChangesDelta): PromiseInterface<ChangesDeltaResult>;
|
|
30
|
+
/**
|
|
31
|
+
* @description
|
|
32
|
+
* 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
|
|
33
|
+
*/
|
|
34
|
+
applyChangesFromParent(internalChangesDelta: InternalChangesDelta, isCalledAfterApiSave?: boolean, isCalledAfterSocketUpdate?: boolean): PromiseInterface<void>;
|
|
35
|
+
/**
|
|
36
|
+
* @description
|
|
37
|
+
* Gets the fields required to set the parent
|
|
38
|
+
*/
|
|
39
|
+
getLinkFieldsByParent<ItemTypeType extends ItemType>(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 ItemType = any>(itemEntry: ItemEntry<ItemTypeType>, _fromInitial?: boolean, _providedFields?: FieldMap<ItemTypeType>): EntryParentNull;
|
|
52
|
+
getItemChangesRecursively(itemEntryId: ItemEntry['id'], copyFields?: boolean): FieldMap;
|
|
53
|
+
/**
|
|
54
|
+
* @description
|
|
55
|
+
* Only takes the local changes into account, used for saving
|
|
56
|
+
*/
|
|
57
|
+
getLocalItemEntryChangesTuple(itemEntryId: ItemEntry['id']): {
|
|
58
|
+
entry: ItemEntry;
|
|
59
|
+
changes: ServerItemEntryChanges;
|
|
60
|
+
};
|
|
61
|
+
getCollectionChangesRecursively<ItemTypeType extends ItemType>(itemType: ItemTypeType, parsedQuery: CollectionQuery): CachedQueryItem<ItemTypeType> | undefined;
|
|
62
|
+
/**
|
|
63
|
+
* @description
|
|
64
|
+
* Invalidates the complete server cache, all items will be re-fetched whenever they are requested
|
|
65
|
+
*/
|
|
66
|
+
invalidateCache(): void;
|
|
67
|
+
/**
|
|
68
|
+
* @description
|
|
69
|
+
* Merges the passed changes from the child Transaction into this Transaction's own changes and then propagates
|
|
70
|
+
* them to all child Transactions
|
|
71
|
+
*/
|
|
72
|
+
applyChangesFromChild(transaction: TransactionCache, breakUpByParent?: boolean, onAfterCreateCallback?: OnAfterCreateCallback): PromiseInterface<ItemIdConversionMap>;
|
|
73
|
+
/**
|
|
74
|
+
* @description
|
|
75
|
+
* Applies changes to this transaction and its children
|
|
76
|
+
* Differs from {@link TransactionCache.applyChangesDelta TransactionCache.applyChangesDelta} in the handling of deleted entries and the applyChangesFromParent call
|
|
77
|
+
*/
|
|
78
|
+
applyChangesDelta(changesDelta: ChangesDelta, isCalledAfterApiSave?: boolean, isCalledAfterSocketUpdate?: boolean): PromiseInterface<ChangesDeltaResult>;
|
|
79
|
+
getLocalItemEntry(itemEntryId: ItemEntry['id']): ItemEntry | undefined;
|
|
80
|
+
getLocalItemEntryByItemId(itemType: ItemType, itemId: ItemEntry['itemId']): ItemEntry | undefined;
|
|
81
|
+
getChangesFromItemChanges<ItemTypeType extends ItemType = any>(changesObject: ServerItemEntryChanges<ItemTypeType>): FieldMap<ItemTypeType>;
|
|
82
|
+
}
|
|
@@ -1,34 +1,34 @@
|
|
|
1
|
-
import { ColumnSubsetCacheFactory, RequestColumnExpansionFactory } from '../../../factories';
|
|
2
|
-
import { ApiRequestColumns, ApiRequestService, CollectionQuery, ColumnSubsetCache, ColumnUtil, ParentIdMap, PromiseInterface } from '../../../index';
|
|
3
|
-
import { ErrorHandlerInterface, PromiseLibraryInterface } from '../../../interfaces';
|
|
4
|
-
import { ItemEntry } from '../../../models';
|
|
5
|
-
import { CollectionOptions } from '../../../models/CollectionOptions';
|
|
6
|
-
import { ItemId, ItemType } from '../../../types';
|
|
7
|
-
import { CollectionEntryService } from '../../index';
|
|
8
|
-
import { RequestBufferManager } from '../../RequestBufferManager';
|
|
9
|
-
import { CachedQueryHandlerBase, CachedQueryItem } from '../CachedQueryHandlerBase';
|
|
10
|
-
import { ServerCache } from './ServerCache';
|
|
11
|
-
import { ServerItemHandler } from './ServerItemHandler';
|
|
12
|
-
export declare class ServerCachedQueryHandler extends CachedQueryHandlerBase {
|
|
13
|
-
private columnSubsetCacheFactory;
|
|
14
|
-
private requestBufferManager;
|
|
15
|
-
private apiRequestService;
|
|
16
|
-
private errorHandler;
|
|
17
|
-
private itemHandler;
|
|
18
|
-
protected transaction: ServerCache;
|
|
19
|
-
constructor(columnSubsetCacheFactory: ColumnSubsetCacheFactory, requestBufferManager: RequestBufferManager, requestColumnExpansionFactory: RequestColumnExpansionFactory, apiRequestService: ApiRequestService, collectionEntryService: CollectionEntryService, errorHandler: ErrorHandlerInterface, itemHandler: ServerItemHandler, promiseService: PromiseLibraryInterface, columnUtil: ColumnUtil, transaction: ServerCache);
|
|
20
|
-
__fetchCachedQueryItem<ItemTypeType extends ItemType>(itemType: ItemTypeType, options: CollectionOptions): PromiseInterface<CachedQueryItem<ItemTypeType>>;
|
|
21
|
-
__fetchLinkedCachedQueryItems<ItemTypeType extends ItemType>(parentType: ItemType, parentIdArray: ItemId[] | (() => ItemId[]), itemType: ItemTypeType, options: CollectionOptions): PromiseInterface<ParentIdMap<CachedQueryItem<ItemTypeType>>>;
|
|
22
|
-
__addItemEntriesToCachedQueries<ItemTypeType extends ItemType>(itemType: ItemTypeType, parsedQuery: CollectionQuery, itemEntries: Array<ItemEntry<ItemTypeType>>): void;
|
|
23
|
-
/**
|
|
24
|
-
* @description
|
|
25
|
-
* Expands the columns of the items in the cached query
|
|
26
|
-
*/
|
|
27
|
-
__expandCachedQuery<ItemTypeType extends ItemType = any>(cachedQuery: CachedQueryItem<ItemTypeType>, newColumns: ApiRequestColumns): PromiseInterface<CachedQueryItem<ItemTypeType>>;
|
|
28
|
-
/**
|
|
29
|
-
* @description
|
|
30
|
-
* Fetches the data for the passed ItemType/options, will do nothing if the requested CollectionEntry/columns are already cached.
|
|
31
|
-
* Will create a new {@link CollectionEntry CollectionEntry} if the CollectionEntry didn't exist yet
|
|
32
|
-
*/
|
|
33
|
-
__fetchItemEntriesByQueryData<ItemTypeType extends ItemType>(itemType: ItemTypeType, options: CollectionOptions<ItemTypeType>, columnSubsetCache: ColumnSubsetCache<ItemTypeType>, collectionQuery: CollectionQuery): PromiseInterface<CachedQueryItem<ItemTypeType>>;
|
|
34
|
-
}
|
|
1
|
+
import { ColumnSubsetCacheFactory, RequestColumnExpansionFactory } from '../../../factories';
|
|
2
|
+
import { ApiRequestColumns, ApiRequestService, CollectionQuery, ColumnSubsetCache, ColumnUtil, ParentIdMap, PromiseInterface } from '../../../index';
|
|
3
|
+
import { ErrorHandlerInterface, PromiseLibraryInterface } from '../../../interfaces';
|
|
4
|
+
import { ItemEntry } from '../../../models';
|
|
5
|
+
import { CollectionOptions } from '../../../models/CollectionOptions';
|
|
6
|
+
import { ItemId, ItemType } from '../../../types';
|
|
7
|
+
import { CollectionEntryService } from '../../index';
|
|
8
|
+
import { RequestBufferManager } from '../../RequestBufferManager';
|
|
9
|
+
import { CachedQueryHandlerBase, CachedQueryItem } from '../CachedQueryHandlerBase';
|
|
10
|
+
import { ServerCache } from './ServerCache';
|
|
11
|
+
import { ServerItemHandler } from './ServerItemHandler';
|
|
12
|
+
export declare class ServerCachedQueryHandler extends CachedQueryHandlerBase {
|
|
13
|
+
private columnSubsetCacheFactory;
|
|
14
|
+
private requestBufferManager;
|
|
15
|
+
private apiRequestService;
|
|
16
|
+
private errorHandler;
|
|
17
|
+
private itemHandler;
|
|
18
|
+
protected transaction: ServerCache;
|
|
19
|
+
constructor(columnSubsetCacheFactory: ColumnSubsetCacheFactory, requestBufferManager: RequestBufferManager, requestColumnExpansionFactory: RequestColumnExpansionFactory, apiRequestService: ApiRequestService, collectionEntryService: CollectionEntryService, errorHandler: ErrorHandlerInterface, itemHandler: ServerItemHandler, promiseService: PromiseLibraryInterface, columnUtil: ColumnUtil, transaction: ServerCache);
|
|
20
|
+
__fetchCachedQueryItem<ItemTypeType extends ItemType>(itemType: ItemTypeType, options: CollectionOptions): PromiseInterface<CachedQueryItem<ItemTypeType>>;
|
|
21
|
+
__fetchLinkedCachedQueryItems<ItemTypeType extends ItemType>(parentType: ItemType, parentIdArray: ItemId[] | (() => ItemId[]), itemType: ItemTypeType, options: CollectionOptions): PromiseInterface<ParentIdMap<CachedQueryItem<ItemTypeType>>>;
|
|
22
|
+
__addItemEntriesToCachedQueries<ItemTypeType extends ItemType>(itemType: ItemTypeType, parsedQuery: CollectionQuery, itemEntries: Array<ItemEntry<ItemTypeType>>): void;
|
|
23
|
+
/**
|
|
24
|
+
* @description
|
|
25
|
+
* Expands the columns of the items in the cached query
|
|
26
|
+
*/
|
|
27
|
+
__expandCachedQuery<ItemTypeType extends ItemType = any>(cachedQuery: CachedQueryItem<ItemTypeType>, newColumns: ApiRequestColumns): PromiseInterface<CachedQueryItem<ItemTypeType>>;
|
|
28
|
+
/**
|
|
29
|
+
* @description
|
|
30
|
+
* Fetches the data for the passed ItemType/options, will do nothing if the requested CollectionEntry/columns are already cached.
|
|
31
|
+
* Will create a new {@link CollectionEntry CollectionEntry} if the CollectionEntry didn't exist yet
|
|
32
|
+
*/
|
|
33
|
+
__fetchItemEntriesByQueryData<ItemTypeType extends ItemType>(itemType: ItemTypeType, options: CollectionOptions<ItemTypeType>, columnSubsetCache: ColumnSubsetCache<ItemTypeType>, collectionQuery: CollectionQuery): PromiseInterface<CachedQueryItem<ItemTypeType>>;
|
|
34
|
+
}
|
|
@@ -1,52 +1,52 @@
|
|
|
1
|
-
import { ColumnSubsetCacheFactory, ItemCacheFactory, ItemEntryFactory, QueryParserFactory, RequestColumnExpansionFactory } from '../../../factories';
|
|
2
|
-
import { ErrorHandlerInterface, PromiseLibraryInterface } from '../../../interfaces';
|
|
3
|
-
import { ItemEntry, ItemEntryOptions } from '../../../models';
|
|
4
|
-
import { ApiQuery, ApiRequestColumns, FieldMap, ItemId, ItemType, PromiseInterface } from '../../../types';
|
|
5
|
-
import { ChangesDelta } from '../../ChangesDelta';
|
|
6
|
-
import { ChangesDeltaItemUpdateDelta } from '../../ChangesDeltaBase';
|
|
7
|
-
import { ChangesDeltaItemCreateDelta } from '../../CreatedChangesDelta';
|
|
8
|
-
import { ApiFormatter, ApiResponseProcessor, ColumnExpansion, ColumnSet, ColumnUtil, QueryService, RequestBufferManager, RequestBufferResponse, TransactionItemEntryChanges } from '../../index';
|
|
9
|
-
import { ItemHandlerBase } from '../ItemHandlerBase';
|
|
10
|
-
import { ServerCache } from './ServerCache';
|
|
11
|
-
export declare type ServerItemEntryChanges<ItemTypeType extends ItemType = any> = FieldMap<ItemTypeType>;
|
|
12
|
-
export declare class ServerItemHandler extends ItemHandlerBase {
|
|
13
|
-
private requestBufferManager;
|
|
14
|
-
private queryParserFactory;
|
|
15
|
-
private queryService;
|
|
16
|
-
private columnSubsetCacheFactory;
|
|
17
|
-
protected transaction: ServerCache;
|
|
18
|
-
itemChanges: {
|
|
19
|
-
[itemEntryId: number]: ServerItemEntryChanges;
|
|
20
|
-
};
|
|
21
|
-
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);
|
|
22
|
-
createItemEntry(createTuple: ChangesDeltaItemCreateDelta): ItemEntry;
|
|
23
|
-
/**
|
|
24
|
-
* @description
|
|
25
|
-
* Processes updates on a cached entry
|
|
26
|
-
*/
|
|
27
|
-
processItemEntryChanges<ItemTypeType extends ItemType = any>(itemEntryChangesTuple: ChangesDeltaItemUpdateDelta<ItemTypeType>, _forceOverwrite?: boolean, _updateInitial?: boolean, _isCalledAfterSocketUpdate?: boolean, _createItemChangesIfNoneExist?: boolean): FieldMap<ItemTypeType> | null;
|
|
28
|
-
copyTransactionItemEntryChanges(itemEntryChanges: TransactionItemEntryChanges, entry: ItemEntry): ServerItemEntryChanges;
|
|
29
|
-
fetchItemEntry<ItemTypeType extends ItemType>(itemType: ItemTypeType, itemId: ItemId, options: ItemEntryOptions): PromiseInterface<ItemEntry<ItemTypeType>>;
|
|
30
|
-
fetchItemEntriesByQuery<ItemTypeType extends ItemType>(itemType: ItemTypeType, query: ApiQuery, entryOptions: ItemEntryOptions): PromiseInterface<Array<ItemEntry<ItemTypeType>>>;
|
|
31
|
-
extendItemEntries<ItemTypeType extends ItemType>(itemType: ItemTypeType, itemEntries: Array<ItemEntry<ItemTypeType>>, newColumns: ApiRequestColumns): PromiseInterface<Array<ItemEntry<ItemTypeType>>>;
|
|
32
|
-
fetchItemEntries<ItemTypeType extends ItemType>(itemType: ItemTypeType, itemIds: ItemId[], options: ItemEntryOptions): PromiseInterface<Array<ItemEntry<ItemTypeType>>>;
|
|
33
|
-
/**
|
|
34
|
-
* @description
|
|
35
|
-
* Fetches the data for the ItemEntries linked to the parent Items
|
|
36
|
-
*
|
|
37
|
-
* @param columns should contain a derived column that refers to the parent
|
|
38
|
-
*/
|
|
39
|
-
fetchLinkedItemEntriesData(parentType: ItemType, parentIdArray: ItemId[], itemType: ItemType, query: ApiQuery | null, columns: ApiRequestColumns): PromiseInterface<RequestBufferResponse>;
|
|
40
|
-
/**
|
|
41
|
-
* @description
|
|
42
|
-
* General way to process an API response.
|
|
43
|
-
* Will call {@link ChangesDelta.setItemCreated setItemCreated} if an entry doesn't exist yet, and otherwise {@link ChangesDelta.setItemUpdated setItemUpdated} if it does.
|
|
44
|
-
*/
|
|
45
|
-
processApiResponse<ItemTypeType extends ItemType>(changesDelta: ChangesDelta, response: ApiResponseProcessor, itemType: ItemTypeType, itemId: ItemId, columnSet: ColumnSet<ItemTypeType>, columnExpansion: ColumnExpansion<ItemTypeType>): void;
|
|
46
|
-
/**
|
|
47
|
-
* @description
|
|
48
|
-
* Fetches the data for the passed ItemType/ItemId/columns, will do nothing if the requested ItemEntry/columns are already cached.
|
|
49
|
-
* Will create a new {@link ItemEntry ItemEntry} if the ItemEntry didn't exist yet
|
|
50
|
-
*/
|
|
51
|
-
private fetchItemEntryData;
|
|
52
|
-
}
|
|
1
|
+
import { ColumnSubsetCacheFactory, ItemCacheFactory, ItemEntryFactory, QueryParserFactory, RequestColumnExpansionFactory } from '../../../factories';
|
|
2
|
+
import { ErrorHandlerInterface, PromiseLibraryInterface } from '../../../interfaces';
|
|
3
|
+
import { ItemEntry, ItemEntryOptions } from '../../../models';
|
|
4
|
+
import { ApiQuery, ApiRequestColumns, FieldMap, ItemId, ItemType, PromiseInterface } from '../../../types';
|
|
5
|
+
import { ChangesDelta } from '../../ChangesDelta';
|
|
6
|
+
import { ChangesDeltaItemUpdateDelta } from '../../ChangesDeltaBase';
|
|
7
|
+
import { ChangesDeltaItemCreateDelta } from '../../CreatedChangesDelta';
|
|
8
|
+
import { ApiFormatter, ApiResponseProcessor, ColumnExpansion, ColumnSet, ColumnUtil, QueryService, RequestBufferManager, RequestBufferResponse, TransactionItemEntryChanges } from '../../index';
|
|
9
|
+
import { ItemHandlerBase } from '../ItemHandlerBase';
|
|
10
|
+
import { ServerCache } from './ServerCache';
|
|
11
|
+
export declare type ServerItemEntryChanges<ItemTypeType extends ItemType = any> = FieldMap<ItemTypeType>;
|
|
12
|
+
export declare class ServerItemHandler extends ItemHandlerBase {
|
|
13
|
+
private requestBufferManager;
|
|
14
|
+
private queryParserFactory;
|
|
15
|
+
private queryService;
|
|
16
|
+
private columnSubsetCacheFactory;
|
|
17
|
+
protected transaction: ServerCache;
|
|
18
|
+
itemChanges: {
|
|
19
|
+
[itemEntryId: number]: ServerItemEntryChanges;
|
|
20
|
+
};
|
|
21
|
+
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);
|
|
22
|
+
createItemEntry(createTuple: ChangesDeltaItemCreateDelta): ItemEntry;
|
|
23
|
+
/**
|
|
24
|
+
* @description
|
|
25
|
+
* Processes updates on a cached entry
|
|
26
|
+
*/
|
|
27
|
+
processItemEntryChanges<ItemTypeType extends ItemType = any>(itemEntryChangesTuple: ChangesDeltaItemUpdateDelta<ItemTypeType>, _forceOverwrite?: boolean, _updateInitial?: boolean, _isCalledAfterSocketUpdate?: boolean, _createItemChangesIfNoneExist?: boolean): FieldMap<ItemTypeType> | null;
|
|
28
|
+
copyTransactionItemEntryChanges(itemEntryChanges: TransactionItemEntryChanges, entry: ItemEntry): ServerItemEntryChanges;
|
|
29
|
+
fetchItemEntry<ItemTypeType extends ItemType>(itemType: ItemTypeType, itemId: ItemId, options: ItemEntryOptions): PromiseInterface<ItemEntry<ItemTypeType>>;
|
|
30
|
+
fetchItemEntriesByQuery<ItemTypeType extends ItemType>(itemType: ItemTypeType, query: ApiQuery, entryOptions: ItemEntryOptions): PromiseInterface<Array<ItemEntry<ItemTypeType>>>;
|
|
31
|
+
extendItemEntries<ItemTypeType extends ItemType>(itemType: ItemTypeType, itemEntries: Array<ItemEntry<ItemTypeType>>, newColumns: ApiRequestColumns): PromiseInterface<Array<ItemEntry<ItemTypeType>>>;
|
|
32
|
+
fetchItemEntries<ItemTypeType extends ItemType>(itemType: ItemTypeType, itemIds: ItemId[], options: ItemEntryOptions): PromiseInterface<Array<ItemEntry<ItemTypeType>>>;
|
|
33
|
+
/**
|
|
34
|
+
* @description
|
|
35
|
+
* Fetches the data for the ItemEntries linked to the parent Items
|
|
36
|
+
*
|
|
37
|
+
* @param columns should contain a derived column that refers to the parent
|
|
38
|
+
*/
|
|
39
|
+
fetchLinkedItemEntriesData(parentType: ItemType, parentIdArray: ItemId[], itemType: ItemType, query: ApiQuery | null, columns: ApiRequestColumns): PromiseInterface<RequestBufferResponse>;
|
|
40
|
+
/**
|
|
41
|
+
* @description
|
|
42
|
+
* General way to process an API response.
|
|
43
|
+
* Will call {@link ChangesDelta.setItemCreated setItemCreated} if an entry doesn't exist yet, and otherwise {@link ChangesDelta.setItemUpdated setItemUpdated} if it does.
|
|
44
|
+
*/
|
|
45
|
+
processApiResponse<ItemTypeType extends ItemType>(changesDelta: ChangesDelta, response: ApiResponseProcessor, itemType: ItemTypeType, itemId: ItemId, columnSet: ColumnSet<ItemTypeType>, columnExpansion: ColumnExpansion<ItemTypeType>): void;
|
|
46
|
+
/**
|
|
47
|
+
* @description
|
|
48
|
+
* Fetches the data for the passed ItemType/ItemId/columns, will do nothing if the requested ItemEntry/columns are already cached.
|
|
49
|
+
* Will create a new {@link ItemEntry ItemEntry} if the ItemEntry didn't exist yet
|
|
50
|
+
*/
|
|
51
|
+
private fetchItemEntryData;
|
|
52
|
+
}
|