@rentman/rm-core 10.0.4 → 10.0.6

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.
Files changed (130) hide show
  1. package/changelog.md +1397 -1386
  2. package/dist/rm-core.js +996 -959
  3. package/dist/rm-core.min.js +1 -1
  4. package/dist/types/classes/ApiFormatter.d.ts +79 -79
  5. package/dist/types/classes/ApiRequestService.d.ts +18 -18
  6. package/dist/types/classes/ApiResponseProcessor.d.ts +29 -29
  7. package/dist/types/classes/BusinessLogicManager/BusinessLogicManager.d.ts +98 -98
  8. package/dist/types/classes/BusinessLogicManager/BusinessLogicRule.d.ts +94 -94
  9. package/dist/types/classes/BusinessLogicManager/Customfield/CustomFieldTypeBusinessLogicRule.d.ts +18 -18
  10. package/dist/types/classes/BusinessLogicManager/Documents/DocumentTemplateBusinessLogicRule.d.ts +25 -25
  11. package/dist/types/classes/BusinessLogicManager/Exemplaar/ExemplaarAanschafdatumBusinessLogicRule.d.ts +14 -14
  12. package/dist/types/classes/BusinessLogicManager/Factuur/FactuurBetalingsconditieBusinessLogicRule.d.ts +20 -20
  13. package/dist/types/classes/BusinessLogicManager/Factuur/FactuurDatumBusinessLogicRule.d.ts +19 -19
  14. package/dist/types/classes/BusinessLogicManager/Factuur/FactuurNumberseriesBusinessLogicRule.d.ts +14 -14
  15. package/dist/types/classes/BusinessLogicManager/Functie/FunctieNaaminternBusinessLogicRule.d.ts +18 -18
  16. package/dist/types/classes/BusinessLogicManager/Functie/FunctieTwowayBusinessLogicRule.d.ts +14 -14
  17. package/dist/types/classes/BusinessLogicManager/Materiaal/MateriaalTelexemplarenBusinessLogicRule.d.ts +15 -15
  18. package/dist/types/classes/BusinessLogicManager/Materiaal/MateriaalTypeBusinessLogicRule.d.ts +18 -18
  19. package/dist/types/classes/BusinessLogicManager/Materiaal/MateriaalVerhuurBusinessLogicRule.d.ts +18 -18
  20. package/dist/types/classes/BusinessLogicManager/Materiaal/SurfaceArticleSizeBusinessLogicRule.d.ts +19 -19
  21. package/dist/types/classes/BusinessLogicManager/OfferteContract/OfferteContractDatumBusinessLogicRule.d.ts +26 -26
  22. package/dist/types/classes/BusinessLogicManager/PlanningPersoneelTransport/PlanningPersoneelTransportBusinessLogicRule.d.ts +29 -29
  23. package/dist/types/classes/BusinessLogicManager/Project/ProjectClientNoteBusinessLogicRule.d.ts +23 -23
  24. package/dist/types/classes/BusinessLogicManager/Reparatie/ReparatieExemplaarBusinessLogicRule.d.ts +14 -14
  25. package/dist/types/classes/BusinessLogicManager/Rol/RolDocumentAccessBusinessLogicRule.d.ts +18 -18
  26. package/dist/types/classes/BusinessLogicManager/Rol/RolEditOwnDataBusinessLogicRule.d.ts +18 -18
  27. package/dist/types/classes/BusinessLogicManager/Rol/RolFileAccessBusinessLogicRule.d.ts +18 -18
  28. package/dist/types/classes/BusinessLogicManager/Rol/RolPersoneelsplannerToegangBusinessLogicRule.d.ts +18 -18
  29. package/dist/types/classes/BusinessLogicManager/Rol/RolProjectenBewerkenBusinessLogicRule.d.ts +18 -18
  30. package/dist/types/classes/BusinessLogicManager/Rol/RolProjectenToegangBusinessLogicRule.d.ts +18 -18
  31. package/dist/types/classes/CacheSyncer.d.ts +70 -70
  32. package/dist/types/classes/ChangesCompilation.d.ts +33 -33
  33. package/dist/types/classes/ChangesDelta.d.ts +65 -62
  34. package/dist/types/classes/ChangesDeltaBase.d.ts +79 -79
  35. package/dist/types/classes/ChangesProcessor.d.ts +40 -40
  36. package/dist/types/classes/CollectionEntryService.d.ts +24 -24
  37. package/dist/types/classes/CollectionResourceService.d.ts +6 -6
  38. package/dist/types/classes/ColumnCache.d.ts +19 -19
  39. package/dist/types/classes/ColumnExpansion.d.ts +19 -19
  40. package/dist/types/classes/ColumnHandler.d.ts +20 -20
  41. package/dist/types/classes/ColumnInfo.d.ts +15 -15
  42. package/dist/types/classes/ColumnSet.d.ts +37 -37
  43. package/dist/types/classes/ColumnSubsetCache.d.ts +14 -14
  44. package/dist/types/classes/ColumnUtil.d.ts +108 -108
  45. package/dist/types/classes/ConversionMapService.d.ts +25 -25
  46. package/dist/types/classes/CreateRequest.d.ts +17 -17
  47. package/dist/types/classes/CreatedChangesDelta.d.ts +17 -17
  48. package/dist/types/classes/InternalChangesDelta.d.ts +44 -44
  49. package/dist/types/classes/ItemCache.d.ts +27 -27
  50. package/dist/types/classes/ItemCreateService.d.ts +18 -18
  51. package/dist/types/classes/ItemEntryService.d.ts +32 -32
  52. package/dist/types/classes/KeyService.d.ts +18 -18
  53. package/dist/types/classes/LockService.d.ts +28 -29
  54. package/dist/types/classes/ModuleChangesCompilation.d.ts +18 -18
  55. package/dist/types/classes/ParentChangesDelta.d.ts +41 -39
  56. package/dist/types/classes/QueryColumnExtractor.d.ts +18 -18
  57. package/dist/types/classes/QueryContainsLocalIdParser.d.ts +17 -17
  58. package/dist/types/classes/QueryLinkedToParser.d.ts +17 -17
  59. package/dist/types/classes/QueryLocallyMatchableParser.d.ts +20 -20
  60. package/dist/types/classes/QueryMatcher.d.ts +24 -24
  61. package/dist/types/classes/QueryParser.d.ts +25 -25
  62. package/dist/types/classes/QueryParserBase.d.ts +20 -20
  63. package/dist/types/classes/QueryParserIdUpdater.d.ts +17 -17
  64. package/dist/types/classes/QueryService.d.ts +12 -12
  65. package/dist/types/classes/RequestBuffer.d.ts +24 -24
  66. package/dist/types/classes/RequestBufferManager.d.ts +32 -32
  67. package/dist/types/classes/RequestColumnExpansion.d.ts +15 -15
  68. package/dist/types/classes/SocketMessageHandler.d.ts +34 -34
  69. package/dist/types/classes/TemplateCache.d.ts +62 -62
  70. package/dist/types/classes/Util.d.ts +28 -28
  71. package/dist/types/classes/cache/AbstractCache.d.ts +86 -86
  72. package/dist/types/classes/cache/CachedQueryHandlerBase.d.ts +68 -68
  73. package/dist/types/classes/cache/ItemHandlerBase.d.ts +102 -102
  74. package/dist/types/classes/cache/server/ServerCache.d.ts +78 -78
  75. package/dist/types/classes/cache/server/ServerCachedQueryHandler.d.ts +25 -25
  76. package/dist/types/classes/cache/server/ServerItemHandler.d.ts +43 -43
  77. package/dist/types/classes/cache/transaction/TransactionCache.d.ts +318 -318
  78. package/dist/types/classes/cache/transaction/TransactionCachedQueryHandler.d.ts +37 -37
  79. package/dist/types/classes/cache/transaction/TransactionCollectionHandler.d.ts +24 -24
  80. package/dist/types/classes/cache/transaction/TransactionEventHandler.d.ts +21 -21
  81. package/dist/types/classes/cache/transaction/TransactionItemHandler.d.ts +90 -90
  82. package/dist/types/classes/cache/transaction/TransactionValidator.d.ts +33 -33
  83. package/dist/types/constants.d.ts +7 -7
  84. package/dist/types/core.d.ts +48 -48
  85. package/dist/types/factories/ApiResponseProcessorFactory.d.ts +6 -6
  86. package/dist/types/factories/CacheSyncerFactory.d.ts +10 -10
  87. package/dist/types/factories/ChangesCompilationFactory.d.ts +5 -5
  88. package/dist/types/factories/ChangesDeltaFactory.d.ts +13 -13
  89. package/dist/types/factories/ChangesProcessorFactory.d.ts +13 -13
  90. package/dist/types/factories/CollectionEntryFactory.d.ts +11 -11
  91. package/dist/types/factories/CollectionResourceFactory.d.ts +18 -18
  92. package/dist/types/factories/ColumnExpansionFactory.d.ts +7 -7
  93. package/dist/types/factories/ColumnInfoFactory.d.ts +7 -7
  94. package/dist/types/factories/ColumnSetFactory.d.ts +18 -18
  95. package/dist/types/factories/ColumnSubsetCacheFactory.d.ts +8 -8
  96. package/dist/types/factories/CreateRequestFactory.d.ts +9 -9
  97. package/dist/types/factories/ItemCacheFactory.d.ts +6 -6
  98. package/dist/types/factories/ItemEntryFactory.d.ts +12 -12
  99. package/dist/types/factories/ItemResourceFactory.d.ts +11 -11
  100. package/dist/types/factories/ModuleChangesCompilationFactory.d.ts +4 -4
  101. package/dist/types/factories/QueryMatcherFactory.d.ts +7 -7
  102. package/dist/types/factories/QueryParserFactory.d.ts +5 -5
  103. package/dist/types/factories/RequestColumnExpansionFactory.d.ts +8 -8
  104. package/dist/types/factories/TemplateFactory.d.ts +8 -8
  105. package/dist/types/factories/TransactionCacheFactory.d.ts +13 -13
  106. package/dist/types/index.d.ts +1 -1
  107. package/dist/types/interfaces/AbstractCacheDependencyInterface.d.ts +38 -38
  108. package/dist/types/interfaces/ApiRequestServiceInterface.d.ts +12 -12
  109. package/dist/types/interfaces/AuthInterface.d.ts +10 -10
  110. package/dist/types/interfaces/ErrorHandlerInterface.d.ts +6 -6
  111. package/dist/types/interfaces/ExceptionHandlerInterface.d.ts +3 -3
  112. package/dist/types/interfaces/LinkTreeServiceInterface.d.ts +4 -4
  113. package/dist/types/interfaces/PromiseLibraryInterface.d.ts +33 -33
  114. package/dist/types/interfaces/ServerCacheDependencyInterface.d.ts +5 -5
  115. package/dist/types/interfaces/SocketMessageInterface.d.ts +3 -3
  116. package/dist/types/interfaces/TransactionCollectionHandlerDependencyInterface.d.ts +17 -17
  117. package/dist/types/interfaces/TransactionItemHandlerDependencyInterface.d.ts +22 -22
  118. package/dist/types/internal.d.ts +128 -128
  119. package/dist/types/models/CachedQueryItem.d.ts +19 -19
  120. package/dist/types/models/CollectionEntry.d.ts +21 -21
  121. package/dist/types/models/CollectionOptions.d.ts +44 -44
  122. package/dist/types/models/CollectionResource.d.ts +87 -87
  123. package/dist/types/models/ItemEntry.d.ts +18 -18
  124. package/dist/types/models/ItemEntryOptions.d.ts +8 -8
  125. package/dist/types/models/ItemResource.d.ts +90 -90
  126. package/dist/types/models/Template.d.ts +11 -11
  127. package/dist/types/types/ItemTypesCollection.d.ts +345 -345
  128. package/dist/types/types/PromiseInterface.d.ts +2 -2
  129. package/package.json +50 -50
  130. package/readme.md +16 -16
@@ -1,86 +1,86 @@
1
- import { ApiEnumItemType } from '@rentman/backend-types';
2
- import { RmCore } from '../../core';
3
- import { AbstractCacheDependencyInterface, ApiRequestColumn, CachedQueryItem, ChangesDelta, ChangesDeltaBase, ChangesDeltaResult, CollectionQuery, CollectionResourceParentIdMap, EntryParentNull, FieldMap, InternalChangesDelta, ItemCache, ItemEntry, ItemEntryChangesTuple, ItemHandlerBase, ItemIdConversionMap, OnAfterCreateCallback, ParentChangesDelta, PromiseInterface, ServerCache, ServerCachedQueryHandler, TransactionCache, TransactionCachedQueryHandler, TransactionValidatorFactory } from '../../internal';
4
- export declare type TransactionOptions = {
5
- /**
6
- * @description
7
- * Sets the TransactionCache to 'transparent' mode, whenever {@link AbstractCache.createChild createChild} is called it will actually be called on the parent
8
- */
9
- transparent: boolean;
10
- };
11
- export declare abstract class AbstractCache {
12
- dependencies: AbstractCacheDependencyInterface;
13
- core: RmCore;
14
- children: TransactionCache[];
15
- readonly itemHandler: ItemHandlerBase;
16
- readonly cachedQueryHandler: TransactionCachedQueryHandler | ServerCachedQueryHandler;
17
- parent: AbstractCache | null;
18
- protected constructor(dependencies: AbstractCacheDependencyInterface, core: RmCore);
19
- abstract createChild(id?: string, validatorFactory?: TransactionValidatorFactory, options?: TransactionOptions): TransactionCache;
20
- onChildDestroy(cache: TransactionCache): void;
21
- /**
22
- * @description
23
- * Expands the items in the collections with the passed columns
24
- *
25
- * todo[limit] move to TransactionCache ?
26
- */
27
- abstract expandCollectionResources<ItemTypeType extends ApiEnumItemType>(itemType: ItemTypeType, collections: CollectionResourceParentIdMap<ItemTypeType>, newColumns: ApiRequestColumn[]): PromiseInterface<CollectionResourceParentIdMap>;
28
- /**
29
- * @description
30
- * Returns {@link ItemEntry ItemEntries} that fit the collection's query, copies over the collectionChanges on all transactions in the chain.
31
- */
32
- abstract getCollectionChangesRecursively<ItemTypeType extends ApiEnumItemType>(itemType: ItemTypeType, parsedQuery: CollectionQuery): CachedQueryItem<ItemTypeType> | undefined;
33
- /**
34
- * @description
35
- * Returns this transaction and all parents
36
- */
37
- getTransactionChain(includeServerCache: false): TransactionCache[];
38
- getTransactionChain(includeServerCache?: true): AbstractCache[];
39
- /**
40
- * @description
41
- * Returns the {@link TransactionItemHandler.entries ItemCache} of the transaction
42
- */
43
- getCurrentItemEntryCache(): ItemCache;
44
- abstract getServerCache(): ServerCache;
45
- abstract getLocalItemEntry(itemEntryId: ItemEntry['id']): ItemEntry | undefined;
46
- abstract getLocalItemEntryByItemId(itemType: ApiEnumItemType, itemId: ItemEntry['itemId']): ItemEntry | undefined;
47
- /**
48
- * @description
49
- * Applies changes from a child transaction to a parent
50
- */
51
- abstract applyChangesFromChild(transaction: TransactionCache, breakUpByParent?: boolean, onAfterCreateCallback?: OnAfterCreateCallback): PromiseInterface<ItemIdConversionMap>;
52
- /**
53
- * @description
54
- * Called by a parent transaction, propagates changes downwards to all child caches
55
- *
56
- * @remarks
57
- * - Should only be used by the core
58
- *
59
- * todo[cache] Should we refetch derived values just like in applyChangesDelta ?
60
- *
61
- * @internal
62
- */
63
- abstract applyChangesFromParent(parentChangesDelta: ParentChangesDelta, isCalledAfterSocketUpdate: boolean): void;
64
- abstract getParent<ItemTypeType extends ApiEnumItemType = any>(itemEntry: ItemEntry<ItemTypeType>, fromInitial?: boolean, providedFields?: FieldMap<ItemTypeType>): EntryParentNull;
65
- abstract getItemChangesRecursively<ItemTypeType extends ApiEnumItemType>(itemEntryId: ItemEntry<ItemTypeType>['id'], copyFields?: boolean): FieldMap<ItemTypeType>;
66
- abstract getLocalItemEntryChangesTuple<ItemTypeType extends ApiEnumItemType>(itemEntryId: ItemEntry<ItemTypeType>['id']): ItemEntryChangesTuple<ItemTypeType>;
67
- abstract applyChangesDelta(changesDelta: ChangesDelta): PromiseInterface<ChangesDeltaResult>;
68
- protected getParentFromFields<ItemTypeType extends ApiEnumItemType = any>(itemEntry: ItemEntry<ItemTypeType>, fields?: FieldMap<ItemTypeType>): EntryParentNull;
69
- /**
70
- * @description
71
- * Called by applyChangesDelta from ServerCache and TransactionCache. Applies creates, updates and moves, doesn't apply deletes
72
- *
73
- * @private
74
- */
75
- protected _applyChangesDelta(changesDelta: ChangesDelta | InternalChangesDelta): {
76
- result: ChangesDeltaResult;
77
- parentChangesDelta: ParentChangesDelta;
78
- matchingDelta: ParentChangesDelta;
79
- undoFunctions: ((changesDelta: InternalChangesDelta) => void)[];
80
- };
81
- /**
82
- * @description
83
- * Ensures that for all updated items in the delta the required derived values are present
84
- */
85
- protected fetchUpdatedDerivedValuesFromDelta(changesDelta: ChangesDeltaBase): PromiseInterface<void>;
86
- }
1
+ import { ApiEnumItemType } from '@rentman/backend-types';
2
+ import { RmCore } from '../../core';
3
+ import { AbstractCacheDependencyInterface, ApiRequestColumn, CachedQueryItem, ChangesDelta, ChangesDeltaBase, ChangesDeltaResult, CollectionQuery, CollectionResourceParentIdMap, EntryParentNull, FieldMap, InternalChangesDelta, ItemCache, ItemEntry, ItemEntryChangesTuple, ItemHandlerBase, ItemIdConversionMap, OnAfterCreateCallback, ParentChangesDelta, PromiseInterface, ServerCache, ServerCachedQueryHandler, TransactionCache, TransactionCachedQueryHandler, TransactionValidatorFactory } from '../../internal';
4
+ export declare type TransactionOptions = {
5
+ /**
6
+ * @description
7
+ * Sets the TransactionCache to 'transparent' mode, whenever {@link AbstractCache.createChild createChild} is called it will actually be called on the parent
8
+ */
9
+ transparent: boolean;
10
+ };
11
+ export declare abstract class AbstractCache {
12
+ dependencies: AbstractCacheDependencyInterface;
13
+ core: RmCore;
14
+ children: TransactionCache[];
15
+ readonly itemHandler: ItemHandlerBase;
16
+ readonly cachedQueryHandler: TransactionCachedQueryHandler | ServerCachedQueryHandler;
17
+ parent: AbstractCache | null;
18
+ protected constructor(dependencies: AbstractCacheDependencyInterface, core: RmCore);
19
+ abstract createChild(id?: string, validatorFactory?: TransactionValidatorFactory, options?: TransactionOptions): TransactionCache;
20
+ onChildDestroy(cache: TransactionCache): void;
21
+ /**
22
+ * @description
23
+ * Expands the items in the collections with the passed columns
24
+ *
25
+ * todo[limit] move to TransactionCache ?
26
+ */
27
+ abstract expandCollectionResources<ItemTypeType extends ApiEnumItemType>(itemType: ItemTypeType, collections: CollectionResourceParentIdMap<ItemTypeType>, newColumns: ApiRequestColumn[]): PromiseInterface<CollectionResourceParentIdMap>;
28
+ /**
29
+ * @description
30
+ * Returns {@link ItemEntry ItemEntries} that fit the collection's query, copies over the collectionChanges on all transactions in the chain.
31
+ */
32
+ abstract getCollectionChangesRecursively<ItemTypeType extends ApiEnumItemType>(itemType: ItemTypeType, parsedQuery: CollectionQuery): CachedQueryItem<ItemTypeType> | undefined;
33
+ /**
34
+ * @description
35
+ * Returns this transaction and all parents
36
+ */
37
+ getTransactionChain(includeServerCache: false): TransactionCache[];
38
+ getTransactionChain(includeServerCache?: true): AbstractCache[];
39
+ /**
40
+ * @description
41
+ * Returns the {@link TransactionItemHandler.entries ItemCache} of the transaction
42
+ */
43
+ getCurrentItemEntryCache(): ItemCache;
44
+ abstract getServerCache(): ServerCache;
45
+ abstract getLocalItemEntry(itemEntryId: ItemEntry['id']): ItemEntry | undefined;
46
+ abstract getLocalItemEntryByItemId(itemType: ApiEnumItemType, itemId: ItemEntry['itemId']): ItemEntry | undefined;
47
+ /**
48
+ * @description
49
+ * Applies changes from a child transaction to a parent
50
+ */
51
+ abstract applyChangesFromChild(transaction: TransactionCache, breakUpByParent?: boolean, onAfterCreateCallback?: OnAfterCreateCallback): PromiseInterface<ItemIdConversionMap>;
52
+ /**
53
+ * @description
54
+ * Called by a parent transaction, propagates changes downwards to all child caches
55
+ *
56
+ * @remarks
57
+ * - Should only be used by the core
58
+ *
59
+ * todo[cache] Should we refetch derived values just like in applyChangesDelta ?
60
+ *
61
+ * @internal
62
+ */
63
+ abstract applyChangesFromParent(parentChangesDelta: ParentChangesDelta, isCalledAfterSocketUpdate: boolean): void;
64
+ abstract getParent<ItemTypeType extends ApiEnumItemType = any>(itemEntry: ItemEntry<ItemTypeType>, fromInitial?: boolean, providedFields?: FieldMap<ItemTypeType>): EntryParentNull;
65
+ abstract getItemChangesRecursively<ItemTypeType extends ApiEnumItemType>(itemEntryId: ItemEntry<ItemTypeType>['id'], copyFields?: boolean): FieldMap<ItemTypeType>;
66
+ abstract getLocalItemEntryChangesTuple<ItemTypeType extends ApiEnumItemType>(itemEntryId: ItemEntry<ItemTypeType>['id']): ItemEntryChangesTuple<ItemTypeType>;
67
+ abstract applyChangesDelta(changesDelta: ChangesDelta): PromiseInterface<ChangesDeltaResult>;
68
+ protected getParentFromFields<ItemTypeType extends ApiEnumItemType = any>(itemEntry: ItemEntry<ItemTypeType>, fields?: FieldMap<ItemTypeType>): EntryParentNull;
69
+ /**
70
+ * @description
71
+ * Called by applyChangesDelta from ServerCache and TransactionCache. Applies creates, updates and moves, doesn't apply deletes
72
+ *
73
+ * @private
74
+ */
75
+ protected _applyChangesDelta(changesDelta: ChangesDelta | InternalChangesDelta): {
76
+ result: ChangesDeltaResult;
77
+ parentChangesDelta: ParentChangesDelta;
78
+ matchingDelta: ParentChangesDelta;
79
+ undoFunctions: ((changesDelta: InternalChangesDelta) => void)[];
80
+ };
81
+ /**
82
+ * @description
83
+ * Ensures that for all updated items in the delta the required derived values are present
84
+ */
85
+ protected fetchUpdatedDerivedValuesFromDelta(changesDelta: ChangesDeltaBase): PromiseInterface<void>;
86
+ }
@@ -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
+ }