@rentman/rm-core 12.1.2 → 12.1.3

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 (146) hide show
  1. package/changelog.md +1502 -1495
  2. package/dist/rm-core.js +831 -911
  3. package/dist/rm-core.min.js +1 -1
  4. package/dist/types/src/FieldLookupProxy.d.ts +4 -4
  5. package/dist/types/src/classes/ApiFormatter.d.ts +56 -76
  6. package/dist/types/src/classes/ApiRequestService.d.ts +18 -18
  7. package/dist/types/src/classes/ApiResponseProcessor.d.ts +29 -29
  8. package/dist/types/src/classes/BusinessLogicManager/BusinessLogicManager.d.ts +100 -100
  9. package/dist/types/src/classes/BusinessLogicManager/BusinessLogicRule.d.ts +93 -93
  10. package/dist/types/src/classes/BusinessLogicManager/Customfield/CustomFieldTypeBusinessLogicRule.d.ts +17 -17
  11. package/dist/types/src/classes/BusinessLogicManager/Documents/DocumentTemplateBusinessLogicRule.d.ts +24 -24
  12. package/dist/types/src/classes/BusinessLogicManager/Exemplaar/ExemplaarAanschafdatumBusinessLogicRule.d.ts +13 -13
  13. package/dist/types/src/classes/BusinessLogicManager/Factuur/FactuurBetalingsconditieBusinessLogicRule.d.ts +19 -19
  14. package/dist/types/src/classes/BusinessLogicManager/Factuur/FactuurDatumBusinessLogicRule.d.ts +18 -18
  15. package/dist/types/src/classes/BusinessLogicManager/Factuur/FactuurNumberseriesBusinessLogicRule.d.ts +13 -13
  16. package/dist/types/src/classes/BusinessLogicManager/Functie/FunctieNaaminternBusinessLogicRule.d.ts +17 -17
  17. package/dist/types/src/classes/BusinessLogicManager/Functie/FunctieTwowayBusinessLogicRule.d.ts +13 -13
  18. package/dist/types/src/classes/BusinessLogicManager/Materiaal/MateriaalTelexemplarenBusinessLogicRule.d.ts +15 -15
  19. package/dist/types/src/classes/BusinessLogicManager/Materiaal/MateriaalTypeBusinessLogicRule.d.ts +17 -17
  20. package/dist/types/src/classes/BusinessLogicManager/Materiaal/MateriaalVerhuurBusinessLogicRule.d.ts +17 -17
  21. package/dist/types/src/classes/BusinessLogicManager/Materiaal/SurfaceArticleSizeBusinessLogicRule.d.ts +18 -18
  22. package/dist/types/src/classes/BusinessLogicManager/OfferteContract/OfferteContractDatumBusinessLogicRule.d.ts +25 -25
  23. package/dist/types/src/classes/BusinessLogicManager/PlanningPersoneelTransport/PlanningPersoneelTransportBusinessLogicRule.d.ts +28 -28
  24. package/dist/types/src/classes/BusinessLogicManager/Project/ProjectClientNoteBusinessLogicRule.d.ts +22 -22
  25. package/dist/types/src/classes/BusinessLogicManager/Reparatie/ReparatieExemplaarAantalBusinessLogicRule.d.ts +13 -13
  26. package/dist/types/src/classes/BusinessLogicManager/Reparatie/ReparatieExemplaarLocationBusinessLogicRule.d.ts +23 -23
  27. package/dist/types/src/classes/BusinessLogicManager/Rol/RolDocumentAccessBusinessLogicRule.d.ts +17 -17
  28. package/dist/types/src/classes/BusinessLogicManager/Rol/RolEditOwnDataBusinessLogicRule.d.ts +17 -17
  29. package/dist/types/src/classes/BusinessLogicManager/Rol/RolFileAccessBusinessLogicRule.d.ts +17 -17
  30. package/dist/types/src/classes/BusinessLogicManager/Rol/RolPersoneelsplannerToegangBusinessLogicRule.d.ts +17 -17
  31. package/dist/types/src/classes/BusinessLogicManager/Rol/RolProjectenBewerkenBusinessLogicRule.d.ts +17 -17
  32. package/dist/types/src/classes/BusinessLogicManager/Rol/RolProjectenToegangBusinessLogicRule.d.ts +17 -17
  33. package/dist/types/src/classes/CacheSyncer.d.ts +71 -71
  34. package/dist/types/src/classes/ChangesCompilation.d.ts +33 -33
  35. package/dist/types/src/classes/ChangesDelta.d.ts +65 -65
  36. package/dist/types/src/classes/ChangesDeltaBase.d.ts +103 -88
  37. package/dist/types/src/classes/ChangesProcessor.d.ts +40 -40
  38. package/dist/types/src/classes/CollectionEntryService.d.ts +24 -24
  39. package/dist/types/src/classes/CollectionResourceService.d.ts +6 -6
  40. package/dist/types/src/classes/ColumnCache.d.ts +19 -19
  41. package/dist/types/src/classes/ColumnExpansion.d.ts +19 -19
  42. package/dist/types/src/classes/ColumnHandler.d.ts +20 -20
  43. package/dist/types/src/classes/ColumnInfo.d.ts +15 -15
  44. package/dist/types/src/classes/ColumnSet.d.ts +37 -37
  45. package/dist/types/src/classes/ColumnUtil.d.ts +108 -108
  46. package/dist/types/src/classes/ConversionMapService.d.ts +25 -25
  47. package/dist/types/src/classes/CreateRequest.d.ts +17 -17
  48. package/dist/types/src/classes/CreatedChangesDelta.d.ts +17 -17
  49. package/dist/types/src/classes/InternalChangesDelta.d.ts +44 -44
  50. package/dist/types/src/classes/ItemCache.d.ts +27 -27
  51. package/dist/types/src/classes/ItemCreateService.d.ts +18 -18
  52. package/dist/types/src/classes/ItemEntryService.d.ts +32 -32
  53. package/dist/types/src/classes/KeyService.d.ts +18 -18
  54. package/dist/types/src/classes/LockService.d.ts +28 -28
  55. package/dist/types/src/classes/ModuleChangesCompilation.d.ts +17 -17
  56. package/dist/types/src/classes/ParentChangesDelta.d.ts +41 -41
  57. package/dist/types/src/classes/QueryColumnExtractor.d.ts +18 -18
  58. package/dist/types/src/classes/QueryContainsLocalIdParser.d.ts +17 -17
  59. package/dist/types/src/classes/QueryLinkedToParser.d.ts +17 -17
  60. package/dist/types/src/classes/QueryLocallyMatchableParser.d.ts +20 -20
  61. package/dist/types/src/classes/QueryMatcher.d.ts +25 -25
  62. package/dist/types/src/classes/QueryParser.d.ts +25 -25
  63. package/dist/types/src/classes/QueryParserBase.d.ts +20 -20
  64. package/dist/types/src/classes/QueryParserIdUpdater.d.ts +17 -17
  65. package/dist/types/src/classes/QueryService.d.ts +12 -12
  66. package/dist/types/src/classes/RequestBuffer.d.ts +26 -26
  67. package/dist/types/src/classes/RequestBufferManager.d.ts +21 -21
  68. package/dist/types/src/classes/RequestColumnExpansion.d.ts +13 -13
  69. package/dist/types/src/classes/RequestColumnsOperationsCache.d.ts +46 -46
  70. package/dist/types/src/classes/SocketMessageHandler.d.ts +34 -34
  71. package/dist/types/src/classes/TemplateCache.d.ts +64 -64
  72. package/dist/types/src/classes/Util.d.ts +28 -28
  73. package/dist/types/src/classes/cache/AbstractCache.d.ts +85 -85
  74. package/dist/types/src/classes/cache/CachedQueryHandlerBase.d.ts +70 -70
  75. package/dist/types/src/classes/cache/ItemHandlerBase.d.ts +107 -107
  76. package/dist/types/src/classes/cache/server/ServerCache.d.ts +65 -65
  77. package/dist/types/src/classes/cache/server/ServerCachedQueryHandler.d.ts +27 -27
  78. package/dist/types/src/classes/cache/server/ServerItemHandler.d.ts +39 -39
  79. package/dist/types/src/classes/cache/transaction/TransactionCache.d.ts +298 -298
  80. package/dist/types/src/classes/cache/transaction/TransactionCachedQueryHandler.d.ts +50 -50
  81. package/dist/types/src/classes/cache/transaction/TransactionCollectionHandler.d.ts +24 -24
  82. package/dist/types/src/classes/cache/transaction/TransactionEventHandler.d.ts +21 -21
  83. package/dist/types/src/classes/cache/transaction/TransactionItemHandler.d.ts +80 -80
  84. package/dist/types/src/classes/cache/transaction/TransactionValidator.d.ts +33 -33
  85. package/dist/types/src/constants.d.ts +7 -7
  86. package/dist/types/src/core.d.ts +48 -48
  87. package/dist/types/src/factories/ApiResponseProcessorFactory.d.ts +6 -6
  88. package/dist/types/src/factories/CacheSyncerFactory.d.ts +14 -14
  89. package/dist/types/src/factories/ChangesCompilationFactory.d.ts +5 -5
  90. package/dist/types/src/factories/ChangesDeltaFactory.d.ts +13 -13
  91. package/dist/types/src/factories/ChangesProcessorFactory.d.ts +13 -13
  92. package/dist/types/src/factories/CollectionEntryFactory.d.ts +11 -11
  93. package/dist/types/src/factories/CollectionResourceFactory.d.ts +18 -18
  94. package/dist/types/src/factories/ColumnExpansionFactory.d.ts +7 -7
  95. package/dist/types/src/factories/ColumnInfoFactory.d.ts +7 -7
  96. package/dist/types/src/factories/ColumnSetFactory.d.ts +18 -18
  97. package/dist/types/src/factories/CreateRequestFactory.d.ts +9 -9
  98. package/dist/types/src/factories/ItemCacheFactory.d.ts +6 -6
  99. package/dist/types/src/factories/ItemEntryFactory.d.ts +12 -12
  100. package/dist/types/src/factories/ItemResourceFactory.d.ts +11 -11
  101. package/dist/types/src/factories/ModuleChangesCompilationFactory.d.ts +6 -6
  102. package/dist/types/src/factories/QueryMatcherFactory.d.ts +8 -8
  103. package/dist/types/src/factories/QueryParserFactory.d.ts +5 -5
  104. package/dist/types/src/factories/RequestColumnExpansionFactory.d.ts +6 -6
  105. package/dist/types/src/factories/RequestColumnsOperationsCacheFactory.d.ts +8 -8
  106. package/dist/types/src/factories/TemplateFactory.d.ts +8 -8
  107. package/dist/types/src/factories/TransactionCacheFactory.d.ts +13 -13
  108. package/dist/types/src/index.d.ts +1 -1
  109. package/dist/types/src/interfaces/AbstractCacheDependencyInterface.d.ts +38 -38
  110. package/dist/types/src/interfaces/ApiRequestServiceInterface.d.ts +12 -12
  111. package/dist/types/src/interfaces/AuthInterface.d.ts +10 -10
  112. package/dist/types/src/interfaces/ErrorHandlerInterface.d.ts +6 -6
  113. package/dist/types/src/interfaces/ExceptionHandlerInterface.d.ts +3 -3
  114. package/dist/types/src/interfaces/LinkTreeServiceInterface.d.ts +4 -4
  115. package/dist/types/src/interfaces/PromiseLibraryInterface.d.ts +33 -33
  116. package/dist/types/src/interfaces/ServerCacheDependencyInterface.d.ts +5 -5
  117. package/dist/types/src/interfaces/SocketMessageInterface.d.ts +3 -3
  118. package/dist/types/src/interfaces/TransactionCollectionHandlerDependencyInterface.d.ts +17 -17
  119. package/dist/types/src/interfaces/TransactionItemHandlerDependencyInterface.d.ts +22 -22
  120. package/dist/types/src/internal.d.ts +128 -128
  121. package/dist/types/src/models/CachedQueryItem.d.ts +40 -40
  122. package/dist/types/src/models/CollectionEntry.d.ts +22 -22
  123. package/dist/types/src/models/CollectionOptions.d.ts +44 -44
  124. package/dist/types/src/models/CollectionResource.d.ts +87 -87
  125. package/dist/types/src/models/ItemEntry.d.ts +19 -19
  126. package/dist/types/src/models/ItemEntryOptions.d.ts +8 -8
  127. package/dist/types/src/models/ItemResource.d.ts +95 -95
  128. package/dist/types/src/models/Template.d.ts +11 -11
  129. package/dist/types/src/types/ItemTypesCollection.d.ts +361 -361
  130. package/dist/types/src/types/PromiseInterface.d.ts +2 -2
  131. package/dist/types/tests/integration/core.test.d.ts +1 -1
  132. package/dist/types/tests/integration/helpers/helpers.d.ts +32 -32
  133. package/dist/types/tests/integration/transactions/field_lookup.test.d.ts +1 -1
  134. package/dist/types/tests/integration/transactions/get_by.test.d.ts +1 -1
  135. package/dist/types/tests/integration/transactions/updates.test.d.ts +1 -1
  136. package/dist/types/tests/mocks/ApiMocked.d.ts +19 -19
  137. package/dist/types/tests/mocks/PromiseLibrary.mocked.d.ts +2 -2
  138. package/dist/types/tests/regression/RM4_17754.test.d.ts +1 -1
  139. package/dist/types/tests/regression/RM4_18216.test.d.ts +1 -1
  140. package/dist/types/tests/unit/query_contains_local_id_parser.test.d.ts +1 -1
  141. package/dist/types/tests/unit/query_linked_to_parser.test.d.ts +1 -1
  142. package/dist/types/tests/unit/query_matcher.test.d.ts +1 -1
  143. package/dist/types/tests/unit/query_parser_id_updater.test.d.ts +1 -1
  144. package/dist/types/tests/unit/query_service.test.d.ts +1 -1
  145. package/package.json +57 -57
  146. package/readme.md +16 -16
@@ -1,107 +1,107 @@
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, ItemTypeColumnId, PromiseInterface, PromiseLibraryInterface, RequestColumnExpansionFactory } from '../../internal';
3
- export declare enum ItemCacheStatus {
4
- CACHED = "cached",
5
- NOT_CACHED = "not_cached",
6
- NO_CHANGES = "no_changes"
7
- }
8
- export interface ItemEntryChangesTuple<ItemTypeType extends ApiEnumItemType> {
9
- entry: ItemEntry<ItemTypeType>;
10
- changes: FieldMap<ItemTypeType>;
11
- }
12
- export declare type ProcessItemEntryChangesResult<ItemTypeType extends ApiEnumItemType> = {
13
- status: ItemCacheStatus.NO_CHANGES | ItemCacheStatus.NOT_CACHED;
14
- previous: {
15
- rollback: null;
16
- complete: null | FieldMap<ItemTypeType>;
17
- };
18
- } | {
19
- status: ItemCacheStatus.CACHED;
20
- previous: {
21
- rollback: Partial<FieldMap<ItemTypeType>>;
22
- complete: null | FieldMap<ItemTypeType>;
23
- };
24
- };
25
- export declare abstract class ItemHandlerBase {
26
- protected columnUtil: ColumnUtil;
27
- protected apiFormatter: ApiFormatter;
28
- protected itemEntryFactory: ItemEntryFactory;
29
- protected promiseService: PromiseLibraryInterface;
30
- protected errorHandler: ErrorHandlerInterface;
31
- protected requestColumnExpansionFactory: RequestColumnExpansionFactory;
32
- protected transaction: AbstractCache;
33
- readonly entries: ItemCache;
34
- itemChanges: {
35
- [itemEntryId: number]: FieldMap;
36
- };
37
- protected constructor(columnUtil: ColumnUtil, apiFormatter: ApiFormatter, itemEntryFactory: ItemEntryFactory, promiseService: PromiseLibraryInterface, errorHandler: ErrorHandlerInterface, requestColumnExpansionFactory: RequestColumnExpansionFactory, itemCacheFactory: ItemCacheFactory, transaction: AbstractCache);
38
- lookUpItemField<ItemTypeType extends ApiEnumItemType, ColumnId extends ItemTypeColumnId<ItemTypeType>>(entry: ItemEntry<ItemTypeType>, columnId: ColumnId): undefined | FieldMap<ItemTypeType>[ColumnId];
39
- collectFields<ItemTypeType extends ApiEnumItemType>(itemEntry: ItemEntry<ItemTypeType>): FieldMap<ItemTypeType>;
40
- /**
41
- * @description
42
- * Copies the passed ItemEntryChanges into a format the implementing ItemHandler can put in his ItemChanges
43
- * @param itemEntryChanges
44
- * @param entry
45
- */
46
- copyTransactionItemEntryChanges<ItemTypeType extends ApiEnumItemType>(itemEntryChanges: FieldMap<ItemTypeType>, entry: ItemEntry<ItemTypeType>): FieldMap<ItemTypeType>;
47
- /**
48
- * @description
49
- * Fetches the ItemEntries for the given query, does not look in the cache, since we don't know which ItemIds belong to the query !
50
- */
51
- abstract fetchItemEntriesByQuery<ItemTypeType extends ApiEnumItemType>(itemType: ItemTypeType, query: ApiQuery, entryOptions: ItemEntryOptions): PromiseInterface<ItemEntry<ItemTypeType>[]>;
52
- /**
53
- * @description
54
- * Fetches the ItemEntries for the given ItemIds
55
- */
56
- abstract fetchItemEntries<ItemTypeType extends ApiEnumItemType>(itemType: ItemTypeType, itemIds: ItemId[], options: ItemEntryOptions): PromiseInterface<ItemEntry<ItemTypeType>[]>;
57
- /**
58
- * @description
59
- * Fetches an ItemEntry with the given itemId
60
- */
61
- abstract fetchItemEntry<ItemTypeType extends ApiEnumItemType>(itemType: ItemTypeType, itemId: ItemId, options: ItemEntryOptions, isRoot?: boolean): PromiseInterface<ItemEntry<ItemTypeType>>;
62
- /**
63
- * @description
64
- * 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
65
- */
66
- abstract processItemEntryChanges<ItemTypeType extends ApiEnumItemType>(itemEntryChangesTuple: ChangesDeltaItemUpdateDelta<ItemTypeType>, isCalledAfterSocketUpdate: boolean, createItemChangesIfNoneExist: boolean): ProcessItemEntryChangesResult<ItemTypeType>;
67
- /**
68
- * @description
69
- * Traverses the column path and returns the fields of the derived item, returns undefined if the item isn't found
70
- *
71
- * ---------------------
72
- *
73
- * @remark
74
- * Assumes the derived item's values are already cached
75
- */
76
- getDerivedValues(itemEntry: ItemEntry, columnPath: string[]): Readonly<FieldMap> | undefined;
77
- /**
78
- * @description
79
- * Returns the value of the columnPath, or undefined when the path couldn't be traversed
80
- *
81
- * @param itemEntry The root entry to start the path from
82
- * @param columnPath Can either be an array of columnIds (['column', 'column2']) or a config column string ('column>column2')
83
- */
84
- getDerivedValue<T extends any = any>(itemEntry: ItemEntry, columnPath: string[] | string): T | undefined;
85
- /**
86
- * @description
87
- * Clears the entry from this transaction, removing it from the {@link ItemCache ItemCache} and removing all changes
88
- */
89
- clearItemEntry(entry: ItemEntry): void;
90
- /**
91
- * @description
92
- * Recursively fetches derived values as separate requests, instead of as columns of a primary item
93
- * 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
94
- */
95
- fetchDerivedValuesByColumn<ItemTypeType extends ApiEnumItemType>(itemEntries: ItemEntry<ItemTypeType>[], rootColumn: ColumnInfo<ItemTypeType>, changesDelta?: ChangesDeltaBase): PromiseInterface<void | ItemEntry<ItemTypeType>[]>;
96
- resolveDerivedValues<ItemTypeType extends ApiEnumItemType>(itemEntries: ItemEntry<ItemTypeType>[], columns: ColumnInfo<ItemTypeType>[], changesDelta?: ChangesDeltaBase): PromiseInterface<ItemEntry<ItemTypeType>[]>;
97
- /**
98
- * @description
99
- * Creates a new {@link ItemEntry ItemEntry} from the passed {@link ChangesDeltaItemCreateDelta ChangesDeltaItemCreateDelta} and stores it in this transaction's {@link ItemCache ItemCache}
100
- */
101
- createItemEntry(createTuple: ChangesDeltaItemCreateDelta): ItemEntry;
102
- /**
103
- * @description
104
- * Gets the value of the given column, will look into the current delta before attempting to read itemChanges
105
- */
106
- protected getItemIdByColumn<ItemTypeType extends ApiEnumItemType>(itemEntry: ItemEntry<ItemTypeType>, column: ColumnInfo<ItemTypeType>, changesDelta?: ChangesDeltaBase): ItemId;
107
- }
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, ItemTypeColumnId, PromiseInterface, PromiseLibraryInterface, RequestColumnExpansionFactory } from '../../internal';
3
+ export declare enum ItemCacheStatus {
4
+ CACHED = "cached",
5
+ NOT_CACHED = "not_cached",
6
+ NO_CHANGES = "no_changes"
7
+ }
8
+ export interface ItemEntryChangesTuple<ItemTypeType extends ApiEnumItemType> {
9
+ entry: ItemEntry<ItemTypeType>;
10
+ changes: FieldMap<ItemTypeType>;
11
+ }
12
+ export declare type ProcessItemEntryChangesResult<ItemTypeType extends ApiEnumItemType> = {
13
+ status: ItemCacheStatus.NO_CHANGES | ItemCacheStatus.NOT_CACHED;
14
+ previous: {
15
+ rollback: null;
16
+ complete: null | FieldMap<ItemTypeType>;
17
+ };
18
+ } | {
19
+ status: ItemCacheStatus.CACHED;
20
+ previous: {
21
+ rollback: Partial<FieldMap<ItemTypeType>>;
22
+ complete: null | FieldMap<ItemTypeType>;
23
+ };
24
+ };
25
+ export declare abstract class ItemHandlerBase {
26
+ protected columnUtil: ColumnUtil;
27
+ protected apiFormatter: ApiFormatter;
28
+ protected itemEntryFactory: ItemEntryFactory;
29
+ protected promiseService: PromiseLibraryInterface;
30
+ protected errorHandler: ErrorHandlerInterface;
31
+ protected requestColumnExpansionFactory: RequestColumnExpansionFactory;
32
+ protected transaction: AbstractCache;
33
+ readonly entries: ItemCache;
34
+ itemChanges: {
35
+ [itemEntryId: number]: FieldMap;
36
+ };
37
+ protected constructor(columnUtil: ColumnUtil, apiFormatter: ApiFormatter, itemEntryFactory: ItemEntryFactory, promiseService: PromiseLibraryInterface, errorHandler: ErrorHandlerInterface, requestColumnExpansionFactory: RequestColumnExpansionFactory, itemCacheFactory: ItemCacheFactory, transaction: AbstractCache);
38
+ lookUpItemField<ItemTypeType extends ApiEnumItemType, ColumnId extends ItemTypeColumnId<ItemTypeType>>(entry: ItemEntry<ItemTypeType>, columnId: ColumnId): undefined | FieldMap<ItemTypeType>[ColumnId];
39
+ collectFields<ItemTypeType extends ApiEnumItemType>(itemEntry: ItemEntry<ItemTypeType>): FieldMap<ItemTypeType>;
40
+ /**
41
+ * @description
42
+ * Copies the passed ItemEntryChanges into a format the implementing ItemHandler can put in his ItemChanges
43
+ * @param itemEntryChanges
44
+ * @param entry
45
+ */
46
+ copyTransactionItemEntryChanges<ItemTypeType extends ApiEnumItemType>(itemEntryChanges: FieldMap<ItemTypeType>, entry: ItemEntry<ItemTypeType>): FieldMap<ItemTypeType>;
47
+ /**
48
+ * @description
49
+ * Fetches the ItemEntries for the given query, does not look in the cache, since we don't know which ItemIds belong to the query !
50
+ */
51
+ abstract fetchItemEntriesByQuery<ItemTypeType extends ApiEnumItemType>(itemType: ItemTypeType, query: ApiQuery, entryOptions: ItemEntryOptions): PromiseInterface<ItemEntry<ItemTypeType>[]>;
52
+ /**
53
+ * @description
54
+ * Fetches the ItemEntries for the given ItemIds
55
+ */
56
+ abstract fetchItemEntries<ItemTypeType extends ApiEnumItemType>(itemType: ItemTypeType, itemIds: ItemId[], options: ItemEntryOptions): PromiseInterface<ItemEntry<ItemTypeType>[]>;
57
+ /**
58
+ * @description
59
+ * Fetches an ItemEntry with the given itemId
60
+ */
61
+ abstract fetchItemEntry<ItemTypeType extends ApiEnumItemType>(itemType: ItemTypeType, itemId: ItemId, options: ItemEntryOptions, isRoot?: boolean): PromiseInterface<ItemEntry<ItemTypeType>>;
62
+ /**
63
+ * @description
64
+ * 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
65
+ */
66
+ abstract processItemEntryChanges<ItemTypeType extends ApiEnumItemType>(itemEntryChangesTuple: ChangesDeltaItemUpdateDelta<ItemTypeType>, isCalledAfterSocketUpdate: boolean, createItemChangesIfNoneExist: boolean): ProcessItemEntryChangesResult<ItemTypeType>;
67
+ /**
68
+ * @description
69
+ * Traverses the column path and returns the fields of the derived item, returns undefined if the item isn't found
70
+ *
71
+ * ---------------------
72
+ *
73
+ * @remark
74
+ * Assumes the derived item's values are already cached
75
+ */
76
+ getDerivedValues(itemEntry: ItemEntry, columnPath: string[]): Readonly<FieldMap> | undefined;
77
+ /**
78
+ * @description
79
+ * Returns the value of the columnPath, or undefined when the path couldn't be traversed
80
+ *
81
+ * @param itemEntry The root entry to start the path from
82
+ * @param columnPath Can either be an array of columnIds (['column', 'column2']) or a config column string ('column>column2')
83
+ */
84
+ getDerivedValue<T extends any = any>(itemEntry: ItemEntry, columnPath: string[] | string): T | undefined;
85
+ /**
86
+ * @description
87
+ * Clears the entry from this transaction, removing it from the {@link ItemCache ItemCache} and removing all changes
88
+ */
89
+ clearItemEntry(entry: ItemEntry): void;
90
+ /**
91
+ * @description
92
+ * Recursively fetches derived values as separate requests, instead of as columns of a primary item
93
+ * 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
94
+ */
95
+ fetchDerivedValuesByColumn<ItemTypeType extends ApiEnumItemType>(itemEntries: ItemEntry<ItemTypeType>[], rootColumn: ColumnInfo<ItemTypeType>, changesDelta?: ChangesDeltaBase): PromiseInterface<void | ItemEntry<ItemTypeType>[]>;
96
+ resolveDerivedValues<ItemTypeType extends ApiEnumItemType>(itemEntries: ItemEntry<ItemTypeType>[], columns: ColumnInfo<ItemTypeType>[], changesDelta?: ChangesDeltaBase): PromiseInterface<ItemEntry<ItemTypeType>[]>;
97
+ /**
98
+ * @description
99
+ * Creates a new {@link ItemEntry ItemEntry} from the passed {@link ChangesDeltaItemCreateDelta ChangesDeltaItemCreateDelta} and stores it in this transaction's {@link ItemCache ItemCache}
100
+ */
101
+ createItemEntry(createTuple: ChangesDeltaItemCreateDelta): ItemEntry;
102
+ /**
103
+ * @description
104
+ * Gets the value of the given column, will look into the current delta before attempting to read itemChanges
105
+ */
106
+ protected getItemIdByColumn<ItemTypeType extends ApiEnumItemType>(itemEntry: ItemEntry<ItemTypeType>, column: ColumnInfo<ItemTypeType>, changesDelta?: ChangesDeltaBase): ItemId;
107
+ }
@@ -1,65 +1,65 @@
1
- import { ApiEnumItemType } from '@rentman/backend-types';
2
- import { AbstractCache, ApiRequestColumnArray, ApiRequestColumnMap, ApiResponseProcessor, CachedQueryItem, ChangesDelta, ChangesDeltaResult, CollectionQuery, CollectionResourceParentIdMap, EntryParent, FieldMap, ItemEntry, ItemEntryChangesTuple, ItemIdConversionMap, OnAfterCreateCallback, ParentChangesDelta, PromiseInterface, ResponseItemUpdateModeMap, RmCore, ServerCacheDependencyInterface, ServerCachedQueryHandler, ServerItemHandler, TransactionCache, TransactionOptions, TransactionValidatorFactory } from '../../../internal';
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: ApiRequestColumnArray): PromiseInterface<CollectionResourceParentIdMap>;
19
- /**
20
- *
21
- * @param response
22
- * @param requestColumnMap
23
- * @param isCalledAfterSocketUpdate
24
- * @param changesDelta
25
- * @param conversionMap
26
- * @param itemUpdateModeMap Allows you to overwrite the update mode for specific items, this is useful when you want to process the direct items of an update/create request
27
- */
28
- processResponse(response: ApiResponseProcessor, requestColumnMap: ApiRequestColumnMap, isCalledAfterSocketUpdate?: boolean, changesDelta?: ChangesDelta, itemUpdateModeMap?: ResponseItemUpdateModeMap, 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
- * Only takes the local changes into account, used for saving
43
- */
44
- getLocalItemEntryChangesTuple<ItemTypeType extends ApiEnumItemType>(itemEntryId: ItemEntry<ItemTypeType>['id']): ItemEntryChangesTuple<ItemTypeType>;
45
- getCollectionChangesRecursively<ItemTypeType extends ApiEnumItemType>(itemType: ItemTypeType, parsedQuery: CollectionQuery): CachedQueryItem<ItemTypeType> | undefined;
46
- /**
47
- * @description
48
- * Invalidates the complete server cache, all items will be re-fetched whenever they are requested
49
- */
50
- invalidateCache(): void;
51
- /**
52
- * @description
53
- * Merges the passed changes from the child Transaction into this Transaction's own changes and then propagates
54
- * them to all child Transactions
55
- */
56
- applyChangesFromChild(transaction: TransactionCache, breakUpByParent?: boolean, onAfterCreateCallback?: OnAfterCreateCallback): PromiseInterface<ItemIdConversionMap>;
57
- /**
58
- * @description
59
- * Applies changes to this transaction and its children
60
- * ServerCache.applyChangesDelta should be used when processing an API response which should create new entries on the ServerCache (such as a Query)
61
- */
62
- applyChangesDelta(changesDelta: ChangesDelta, isCalledAfterSocketUpdate?: boolean, conversionMap?: ItemIdConversionMap): PromiseInterface<ChangesDeltaResult>;
63
- getLocalItemEntry(itemEntryId: ItemEntry['id']): ItemEntry | undefined;
64
- getLocalItemEntryByItemId(itemType: ApiEnumItemType, itemId: ItemEntry['itemId']): ItemEntry | undefined;
65
- }
1
+ import { ApiEnumItemType } from '@rentman/backend-types';
2
+ import { AbstractCache, ApiRequestColumnArray, ApiRequestColumnMap, ApiResponseProcessor, CachedQueryItem, ChangesDelta, ChangesDeltaResult, CollectionQuery, CollectionResourceParentIdMap, EntryParent, FieldMap, ItemEntry, ItemEntryChangesTuple, ItemIdConversionMap, OnAfterCreateCallback, ParentChangesDelta, PromiseInterface, ResponseItemUpdateModeMap, RmCore, ServerCacheDependencyInterface, ServerCachedQueryHandler, ServerItemHandler, TransactionCache, TransactionOptions, TransactionValidatorFactory } from '../../../internal';
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: ApiRequestColumnArray): PromiseInterface<CollectionResourceParentIdMap>;
19
+ /**
20
+ *
21
+ * @param response
22
+ * @param requestColumnMap
23
+ * @param isCalledAfterSocketUpdate
24
+ * @param changesDelta
25
+ * @param conversionMap
26
+ * @param itemUpdateModeMap Allows you to overwrite the update mode for specific items, this is useful when you want to process the direct items of an update/create request
27
+ */
28
+ processResponse(response: ApiResponseProcessor, requestColumnMap: ApiRequestColumnMap, isCalledAfterSocketUpdate?: boolean, changesDelta?: ChangesDelta, itemUpdateModeMap?: ResponseItemUpdateModeMap, 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
+ * Only takes the local changes into account, used for saving
43
+ */
44
+ getLocalItemEntryChangesTuple<ItemTypeType extends ApiEnumItemType>(itemEntryId: ItemEntry<ItemTypeType>['id']): ItemEntryChangesTuple<ItemTypeType>;
45
+ getCollectionChangesRecursively<ItemTypeType extends ApiEnumItemType>(itemType: ItemTypeType, parsedQuery: CollectionQuery): CachedQueryItem<ItemTypeType> | undefined;
46
+ /**
47
+ * @description
48
+ * Invalidates the complete server cache, all items will be re-fetched whenever they are requested
49
+ */
50
+ invalidateCache(): void;
51
+ /**
52
+ * @description
53
+ * Merges the passed changes from the child Transaction into this Transaction's own changes and then propagates
54
+ * them to all child Transactions
55
+ */
56
+ applyChangesFromChild(transaction: TransactionCache, breakUpByParent?: boolean, onAfterCreateCallback?: OnAfterCreateCallback): PromiseInterface<ItemIdConversionMap>;
57
+ /**
58
+ * @description
59
+ * Applies changes to this transaction and its children
60
+ * ServerCache.applyChangesDelta should be used when processing an API response which should create new entries on the ServerCache (such as a Query)
61
+ */
62
+ applyChangesDelta(changesDelta: ChangesDelta, isCalledAfterSocketUpdate?: boolean, conversionMap?: ItemIdConversionMap): PromiseInterface<ChangesDeltaResult>;
63
+ getLocalItemEntry(itemEntryId: ItemEntry['id']): ItemEntry | undefined;
64
+ getLocalItemEntryByItemId(itemType: ApiEnumItemType, itemId: ItemEntry['itemId']): ItemEntry | undefined;
65
+ }
@@ -1,27 +1,27 @@
1
- import { ApiEnumItemType } from '@rentman/backend-types';
2
- import { ApiRequestColumns, ApiRequestService, CachedQueryHandlerBase, CachedQueryItem, CachedQueryOptions, CollectionEntryService, CollectionQuery, ColumnUtil, ErrorHandlerInterface, ItemEntry, PromiseInterface, PromiseLibraryInterface, RequestBufferManager, RequestColumnExpansionFactory, RequestColumnsOperationsCache, RequestColumnsOperationsCacheFactory, ServerCache, ServerItemHandler } from '../../../internal';
3
- export declare class ServerCachedQueryHandler extends CachedQueryHandlerBase {
4
- private requestBufferManager;
5
- private apiRequestService;
6
- private errorHandler;
7
- private itemHandler;
8
- protected transaction: ServerCache;
9
- constructor(requestColumnOperationsCacheFactory: RequestColumnsOperationsCacheFactory, requestBufferManager: RequestBufferManager, requestColumnExpansionFactory: RequestColumnExpansionFactory, apiRequestService: ApiRequestService, collectionEntryService: CollectionEntryService, errorHandler: ErrorHandlerInterface, itemHandler: ServerItemHandler, promiseService: PromiseLibraryInterface, columnUtil: ColumnUtil, transaction: ServerCache);
10
- __addItemEntriesToCachedQueries<ItemTypeType extends ApiEnumItemType = any>(itemType: ItemTypeType, parsedQuery: CollectionQuery, itemEntries: ItemEntry<ItemTypeType>[]): void;
11
- /**
12
- * @description
13
- * Expands the columns of the items in the cached query
14
- */
15
- __expandCachedQuery<ItemTypeType extends ApiEnumItemType>(itemType: ItemTypeType, queryString: string, columnsOperationsCache: RequestColumnsOperationsCache<ItemTypeType>, usePrivateBuffer: boolean, batchedLinkedToQuery?: CollectionQuery): PromiseInterface<CachedQueryItem<ItemTypeType>>;
16
- /**
17
- * @description
18
- * Fetches the data for the passed ItemType/options, will do nothing if the requested CollectionEntry/columns are already cached.
19
- * Will create a new {@link CollectionEntry CollectionEntry} if the CollectionEntry didn't exist yet
20
- */
21
- __fetchItemEntriesByQueryData<ItemTypeType extends ApiEnumItemType>(itemType: ItemTypeType, options: CachedQueryOptions, columnsOperationsCache: RequestColumnsOperationsCache<ItemTypeType>, collectionQuery: CollectionQuery, batchedLinkedToQuery?: CollectionQuery): PromiseInterface<CachedQueryItem<ItemTypeType>>;
22
- /**
23
- * Merged the request columns with columns required for delete relations and the query matcher.
24
- * This method is in the server cache because the queries contain the superset of all columns here.
25
- */
26
- expandColumnsWithRequiredColumns(itemType: ApiEnumItemType, requestColumns: ApiRequestColumns): ApiRequestColumns;
27
- }
1
+ import { ApiEnumItemType } from '@rentman/backend-types';
2
+ import { ApiRequestColumns, ApiRequestService, CachedQueryHandlerBase, CachedQueryItem, CachedQueryOptions, CollectionEntryService, CollectionQuery, ColumnUtil, ErrorHandlerInterface, ItemEntry, PromiseInterface, PromiseLibraryInterface, RequestBufferManager, RequestColumnExpansionFactory, RequestColumnsOperationsCache, RequestColumnsOperationsCacheFactory, ServerCache, ServerItemHandler } from '../../../internal';
3
+ export declare class ServerCachedQueryHandler extends CachedQueryHandlerBase {
4
+ private requestBufferManager;
5
+ private apiRequestService;
6
+ private errorHandler;
7
+ private itemHandler;
8
+ protected transaction: ServerCache;
9
+ constructor(requestColumnOperationsCacheFactory: RequestColumnsOperationsCacheFactory, requestBufferManager: RequestBufferManager, requestColumnExpansionFactory: RequestColumnExpansionFactory, apiRequestService: ApiRequestService, collectionEntryService: CollectionEntryService, errorHandler: ErrorHandlerInterface, itemHandler: ServerItemHandler, promiseService: PromiseLibraryInterface, columnUtil: ColumnUtil, transaction: ServerCache);
10
+ __addItemEntriesToCachedQueries<ItemTypeType extends ApiEnumItemType = any>(itemType: ItemTypeType, parsedQuery: CollectionQuery, itemEntries: ItemEntry<ItemTypeType>[]): void;
11
+ /**
12
+ * @description
13
+ * Expands the columns of the items in the cached query
14
+ */
15
+ __expandCachedQuery<ItemTypeType extends ApiEnumItemType>(itemType: ItemTypeType, queryString: string, columnsOperationsCache: RequestColumnsOperationsCache<ItemTypeType>, usePrivateBuffer: boolean, batchedLinkedToQuery?: CollectionQuery): PromiseInterface<CachedQueryItem<ItemTypeType>>;
16
+ /**
17
+ * @description
18
+ * Fetches the data for the passed ItemType/options, will do nothing if the requested CollectionEntry/columns are already cached.
19
+ * Will create a new {@link CollectionEntry CollectionEntry} if the CollectionEntry didn't exist yet
20
+ */
21
+ __fetchItemEntriesByQueryData<ItemTypeType extends ApiEnumItemType>(itemType: ItemTypeType, options: CachedQueryOptions, columnsOperationsCache: RequestColumnsOperationsCache<ItemTypeType>, collectionQuery: CollectionQuery, batchedLinkedToQuery?: CollectionQuery): PromiseInterface<CachedQueryItem<ItemTypeType>>;
22
+ /**
23
+ * Merged the request columns with columns required for delete relations and the query matcher.
24
+ * This method is in the server cache because the queries contain the superset of all columns here.
25
+ */
26
+ expandColumnsWithRequiredColumns(itemType: ApiEnumItemType, requestColumns: ApiRequestColumns): ApiRequestColumns;
27
+ }
@@ -1,39 +1,39 @@
1
- import { ApiEnumItemType, ItemId } from '@rentman/backend-types';
2
- import { ApiFormatter, ApiQuery, ApiRequestColumns, ApiResponseProcessor, ChangesDelta, ChangesDeltaItemCreateDelta, ChangesDeltaItemUpdateDelta, ChangesDeltaItemUpdateMode, ColumnExpansion, ColumnSet, ColumnUtil, ErrorHandlerInterface, ItemCacheFactory, ItemEntry, ItemEntryFactory, ItemEntryOptions, ItemHandlerBase, ProcessItemEntryChangesResult, PromiseInterface, PromiseLibraryInterface, QueryParserFactory, QueryService, RequestBufferManager, RequestBufferResponse, RequestColumnExpansionFactory, RequestColumnsOperationsCacheFactory, ServerCache } from '../../../internal';
3
- export declare class ServerItemHandler extends ItemHandlerBase {
4
- private requestBufferManager;
5
- private queryParserFactory;
6
- private queryService;
7
- private requestColumnsOperationsCacheFactory;
8
- protected transaction: ServerCache;
9
- constructor(requestBufferManager: RequestBufferManager, queryParserFactory: QueryParserFactory, queryService: QueryService, requestColumnsOperationsCacheFactory: RequestColumnsOperationsCacheFactory, errorHandler: ErrorHandlerInterface, promiseService: PromiseLibraryInterface, columnUtil: ColumnUtil, apiFormatter: ApiFormatter, itemEntryFactory: ItemEntryFactory, itemCacheFactory: ItemCacheFactory, requestColumnExpansionFactory: RequestColumnExpansionFactory, transaction: ServerCache);
10
- createItemEntry(createTuple: ChangesDeltaItemCreateDelta): ItemEntry;
11
- /**
12
- * @description
13
- * Processes updates on a cached entry
14
- */
15
- processItemEntryChanges<ItemTypeType extends ApiEnumItemType = any>(itemEntryChangesTuple: ChangesDeltaItemUpdateDelta<ItemTypeType>, _isCalledAfterSocketUpdate?: boolean, _createItemChangesIfNoneExist?: boolean): ProcessItemEntryChangesResult<ItemTypeType>;
16
- fetchItemEntry<ItemTypeType extends ApiEnumItemType>(itemType: ItemTypeType, itemId: ItemId, options: ItemEntryOptions): PromiseInterface<ItemEntry<ItemTypeType>>;
17
- fetchItemEntriesByQuery<ItemTypeType extends ApiEnumItemType>(itemType: ItemTypeType, query: ApiQuery, entryOptions: ItemEntryOptions): PromiseInterface<ItemEntry<ItemTypeType>[]>;
18
- extendItemEntries<ItemTypeType extends ApiEnumItemType>(itemType: ItemTypeType, itemEntries: ItemEntry<ItemTypeType>[], newColumns: ApiRequestColumns): PromiseInterface<ItemEntry<ItemTypeType>[]>;
19
- fetchItemEntries<ItemTypeType extends ApiEnumItemType>(itemType: ItemTypeType, itemIds: ItemId[], options: ItemEntryOptions): PromiseInterface<ItemEntry<ItemTypeType>[]>;
20
- /**
21
- * @description
22
- * Fetches the data for the ItemEntries linked to the parent Items
23
- *
24
- * @param columns should contain a derived column that refers to the parent
25
- */
26
- fetchLinkedItemEntriesData(parentType: ApiEnumItemType, parentIdArray: ItemId[], itemType: ApiEnumItemType, query: ApiQuery | null, columns: ApiRequestColumns): PromiseInterface<RequestBufferResponse>;
27
- /**
28
- * @description
29
- * General way to process an API response.
30
- * Will call {@link ChangesDelta.setItemCreated setItemCreated} if an entry doesn't exist yet, and otherwise {@link ChangesDelta.setItemUpdated setItemUpdated} if it does.
31
- */
32
- processApiResponse<ItemTypeType extends ApiEnumItemType>(changesDelta: ChangesDelta, response: ApiResponseProcessor, itemType: ItemTypeType, itemIdOfExistingItem: ItemId, itemIdInResponse: ItemId, columnSet: ColumnSet<ItemTypeType>, columnExpansion: ColumnExpansion<ItemTypeType>, mode: ChangesDeltaItemUpdateMode): void;
33
- /**
34
- * @description
35
- * Fetches the data for the passed ItemType/ItemId/columns, will do nothing if the requested ItemEntry/columns are already cached.
36
- * Will create a new {@link ItemEntry ItemEntry} if the ItemEntry didn't exist yet
37
- */
38
- private fetchItemEntryData;
39
- }
1
+ import { ApiEnumItemType, ItemId } from '@rentman/backend-types';
2
+ import { ApiFormatter, ApiQuery, ApiRequestColumns, ApiResponseProcessor, ChangesDelta, ChangesDeltaItemCreateDelta, ChangesDeltaItemUpdateDelta, ChangesDeltaItemUpdateMode, ColumnExpansion, ColumnSet, ColumnUtil, ErrorHandlerInterface, ItemCacheFactory, ItemEntry, ItemEntryFactory, ItemEntryOptions, ItemHandlerBase, ProcessItemEntryChangesResult, PromiseInterface, PromiseLibraryInterface, QueryParserFactory, QueryService, RequestBufferManager, RequestBufferResponse, RequestColumnExpansionFactory, RequestColumnsOperationsCacheFactory, ServerCache } from '../../../internal';
3
+ export declare class ServerItemHandler extends ItemHandlerBase {
4
+ private requestBufferManager;
5
+ private queryParserFactory;
6
+ private queryService;
7
+ private requestColumnsOperationsCacheFactory;
8
+ protected transaction: ServerCache;
9
+ constructor(requestBufferManager: RequestBufferManager, queryParserFactory: QueryParserFactory, queryService: QueryService, requestColumnsOperationsCacheFactory: RequestColumnsOperationsCacheFactory, errorHandler: ErrorHandlerInterface, promiseService: PromiseLibraryInterface, columnUtil: ColumnUtil, apiFormatter: ApiFormatter, itemEntryFactory: ItemEntryFactory, itemCacheFactory: ItemCacheFactory, requestColumnExpansionFactory: RequestColumnExpansionFactory, transaction: ServerCache);
10
+ createItemEntry(createTuple: ChangesDeltaItemCreateDelta): ItemEntry;
11
+ /**
12
+ * @description
13
+ * Processes updates on a cached entry
14
+ */
15
+ processItemEntryChanges<ItemTypeType extends ApiEnumItemType = any>(itemEntryChangesTuple: ChangesDeltaItemUpdateDelta<ItemTypeType>, _isCalledAfterSocketUpdate?: boolean, _createItemChangesIfNoneExist?: boolean): ProcessItemEntryChangesResult<ItemTypeType>;
16
+ fetchItemEntry<ItemTypeType extends ApiEnumItemType>(itemType: ItemTypeType, itemId: ItemId, options: ItemEntryOptions): PromiseInterface<ItemEntry<ItemTypeType>>;
17
+ fetchItemEntriesByQuery<ItemTypeType extends ApiEnumItemType>(itemType: ItemTypeType, query: ApiQuery, entryOptions: ItemEntryOptions): PromiseInterface<ItemEntry<ItemTypeType>[]>;
18
+ extendItemEntries<ItemTypeType extends ApiEnumItemType>(itemType: ItemTypeType, itemEntries: ItemEntry<ItemTypeType>[], newColumns: ApiRequestColumns): PromiseInterface<ItemEntry<ItemTypeType>[]>;
19
+ fetchItemEntries<ItemTypeType extends ApiEnumItemType>(itemType: ItemTypeType, itemIds: ItemId[], options: ItemEntryOptions): PromiseInterface<ItemEntry<ItemTypeType>[]>;
20
+ /**
21
+ * @description
22
+ * Fetches the data for the ItemEntries linked to the parent Items
23
+ *
24
+ * @param columns should contain a derived column that refers to the parent
25
+ */
26
+ fetchLinkedItemEntriesData(parentType: ApiEnumItemType, parentIdArray: ItemId[], itemType: ApiEnumItemType, query: ApiQuery | null, columns: ApiRequestColumns): PromiseInterface<RequestBufferResponse>;
27
+ /**
28
+ * @description
29
+ * General way to process an API response.
30
+ * Will call {@link ChangesDelta.setItemCreated setItemCreated} if an entry doesn't exist yet, and otherwise {@link ChangesDelta.setItemUpdated setItemUpdated} if it does.
31
+ */
32
+ processApiResponse<ItemTypeType extends ApiEnumItemType>(changesDelta: ChangesDelta, response: ApiResponseProcessor, itemType: ItemTypeType, itemIdOfExistingItem: ItemId, itemIdInResponse: ItemId, columnSet: ColumnSet<ItemTypeType>, columnExpansion: ColumnExpansion<ItemTypeType>, mode: ChangesDeltaItemUpdateMode): void;
33
+ /**
34
+ * @description
35
+ * Fetches the data for the passed ItemType/ItemId/columns, will do nothing if the requested ItemEntry/columns are already cached.
36
+ * Will create a new {@link ItemEntry ItemEntry} if the ItemEntry didn't exist yet
37
+ */
38
+ private fetchItemEntryData;
39
+ }