@rentman/rm-core 9.2.0 → 9.2.1

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 (106) hide show
  1. package/changelog.md +1005 -1002
  2. package/dist/rm-core.js +673 -674
  3. package/dist/rm-core.min.js +1 -1
  4. package/dist/types/classes/ApiFormatter.d.ts +73 -73
  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/CacheSyncer.d.ts +44 -44
  8. package/dist/types/classes/ChangesCompilation.d.ts +33 -33
  9. package/dist/types/classes/ChangesDelta.d.ts +61 -61
  10. package/dist/types/classes/ChangesDeltaBase.d.ts +78 -78
  11. package/dist/types/classes/ChangesProcessor.d.ts +40 -40
  12. package/dist/types/classes/CollectionEntryService.d.ts +24 -24
  13. package/dist/types/classes/CollectionResourceService.d.ts +6 -6
  14. package/dist/types/classes/ColumnCache.d.ts +19 -19
  15. package/dist/types/classes/ColumnExpansion.d.ts +19 -19
  16. package/dist/types/classes/ColumnHandler.d.ts +20 -20
  17. package/dist/types/classes/ColumnInfo.d.ts +15 -15
  18. package/dist/types/classes/ColumnSet.d.ts +37 -37
  19. package/dist/types/classes/ColumnSubsetCache.d.ts +14 -14
  20. package/dist/types/classes/ColumnUtil.d.ts +101 -101
  21. package/dist/types/classes/ConversionMapService.d.ts +25 -25
  22. package/dist/types/classes/CreateRequest.d.ts +17 -17
  23. package/dist/types/classes/CreatedChangesDelta.d.ts +17 -17
  24. package/dist/types/classes/InternalChangesDelta.d.ts +43 -43
  25. package/dist/types/classes/ItemCache.d.ts +27 -27
  26. package/dist/types/classes/ItemCreateService.d.ts +18 -18
  27. package/dist/types/classes/ItemEntryService.d.ts +32 -32
  28. package/dist/types/classes/KeyService.d.ts +18 -18
  29. package/dist/types/classes/LockService.d.ts +29 -29
  30. package/dist/types/classes/ModuleChangesCompilation.d.ts +18 -18
  31. package/dist/types/classes/ParentChangesDelta.d.ts +39 -39
  32. package/dist/types/classes/QueryColumnExtractor.d.ts +18 -18
  33. package/dist/types/classes/QueryContainsLocalIdParser.d.ts +17 -17
  34. package/dist/types/classes/QueryLinkedToParser.d.ts +17 -17
  35. package/dist/types/classes/QueryLocallyMatchableParser.d.ts +20 -20
  36. package/dist/types/classes/QueryMatcher.d.ts +24 -24
  37. package/dist/types/classes/QueryParser.d.ts +25 -25
  38. package/dist/types/classes/QueryParserBase.d.ts +20 -20
  39. package/dist/types/classes/QueryParserIdUpdater.d.ts +17 -17
  40. package/dist/types/classes/QueryService.d.ts +12 -12
  41. package/dist/types/classes/RequestBuffer.d.ts +24 -24
  42. package/dist/types/classes/RequestBufferManager.d.ts +32 -32
  43. package/dist/types/classes/RequestColumnExpansion.d.ts +15 -15
  44. package/dist/types/classes/SocketMessageHandler.d.ts +34 -34
  45. package/dist/types/classes/TemplateCache.d.ts +62 -62
  46. package/dist/types/classes/Util.d.ts +28 -28
  47. package/dist/types/classes/cache/AbstractCache.d.ts +85 -85
  48. package/dist/types/classes/cache/CachedQueryHandlerBase.d.ts +68 -68
  49. package/dist/types/classes/cache/ItemHandlerBase.d.ts +102 -102
  50. package/dist/types/classes/cache/server/ServerCache.d.ts +78 -78
  51. package/dist/types/classes/cache/server/ServerCachedQueryHandler.d.ts +25 -25
  52. package/dist/types/classes/cache/server/ServerItemHandler.d.ts +43 -43
  53. package/dist/types/classes/cache/transaction/TransactionCache.d.ts +318 -318
  54. package/dist/types/classes/cache/transaction/TransactionCachedQueryHandler.d.ts +36 -36
  55. package/dist/types/classes/cache/transaction/TransactionCollectionHandler.d.ts +24 -24
  56. package/dist/types/classes/cache/transaction/TransactionEventHandler.d.ts +21 -21
  57. package/dist/types/classes/cache/transaction/TransactionItemHandler.d.ts +90 -90
  58. package/dist/types/classes/cache/transaction/TransactionValidator.d.ts +33 -33
  59. package/dist/types/constants.d.ts +7 -7
  60. package/dist/types/core.d.ts +45 -45
  61. package/dist/types/factories/ApiResponseProcessorFactory.d.ts +6 -6
  62. package/dist/types/factories/CacheSyncerFactory.d.ts +10 -10
  63. package/dist/types/factories/ChangesCompilationFactory.d.ts +5 -5
  64. package/dist/types/factories/ChangesDeltaFactory.d.ts +13 -13
  65. package/dist/types/factories/ChangesProcessorFactory.d.ts +13 -13
  66. package/dist/types/factories/CollectionEntryFactory.d.ts +11 -11
  67. package/dist/types/factories/CollectionResourceFactory.d.ts +18 -18
  68. package/dist/types/factories/ColumnExpansionFactory.d.ts +7 -7
  69. package/dist/types/factories/ColumnInfoFactory.d.ts +7 -7
  70. package/dist/types/factories/ColumnSetFactory.d.ts +18 -18
  71. package/dist/types/factories/ColumnSubsetCacheFactory.d.ts +8 -8
  72. package/dist/types/factories/CreateRequestFactory.d.ts +9 -9
  73. package/dist/types/factories/ItemCacheFactory.d.ts +6 -6
  74. package/dist/types/factories/ItemEntryFactory.d.ts +12 -12
  75. package/dist/types/factories/ItemResourceFactory.d.ts +11 -11
  76. package/dist/types/factories/ModuleChangesCompilationFactory.d.ts +4 -4
  77. package/dist/types/factories/QueryMatcherFactory.d.ts +7 -7
  78. package/dist/types/factories/QueryParserFactory.d.ts +5 -5
  79. package/dist/types/factories/RequestColumnExpansionFactory.d.ts +8 -8
  80. package/dist/types/factories/TemplateFactory.d.ts +8 -8
  81. package/dist/types/factories/TransactionCacheFactory.d.ts +13 -13
  82. package/dist/types/index.d.ts +1 -1
  83. package/dist/types/interfaces/AbstractCacheDependencyInterface.d.ts +36 -36
  84. package/dist/types/interfaces/ApiRequestServiceInterface.d.ts +12 -12
  85. package/dist/types/interfaces/AuthInterface.d.ts +10 -10
  86. package/dist/types/interfaces/ErrorHandlerInterface.d.ts +5 -5
  87. package/dist/types/interfaces/ExceptionHandlerInterface.d.ts +3 -3
  88. package/dist/types/interfaces/LinkTreeServiceInterface.d.ts +4 -4
  89. package/dist/types/interfaces/PromiseLibraryInterface.d.ts +25 -25
  90. package/dist/types/interfaces/ServerCacheDependencyInterface.d.ts +5 -5
  91. package/dist/types/interfaces/SocketMessageInterface.d.ts +3 -3
  92. package/dist/types/interfaces/TransactionCollectionHandlerDependencyInterface.d.ts +17 -17
  93. package/dist/types/interfaces/TransactionItemHandlerDependencyInterface.d.ts +22 -22
  94. package/dist/types/internal.d.ts +104 -104
  95. package/dist/types/models/CachedQueryItem.d.ts +19 -19
  96. package/dist/types/models/CollectionEntry.d.ts +21 -21
  97. package/dist/types/models/CollectionOptions.d.ts +44 -44
  98. package/dist/types/models/CollectionResource.d.ts +87 -87
  99. package/dist/types/models/ItemEntry.d.ts +18 -18
  100. package/dist/types/models/ItemEntryOptions.d.ts +8 -8
  101. package/dist/types/models/ItemResource.d.ts +90 -90
  102. package/dist/types/models/Template.d.ts +11 -11
  103. package/dist/types/types/ItemTypesCollection.d.ts +345 -345
  104. package/dist/types/types/PromiseInterface.d.ts +2 -2
  105. package/package.json +50 -50
  106. package/readme.md +15 -15
package/changelog.md CHANGED
@@ -1,1002 +1,1005 @@
1
- #Changelog
2
- Contains new features, breaking changes and their reasoning
3
-
4
- ## 9.2.0
5
- - Greatly speed up core processing on large datasets
6
- - Refactor the way ChangesDeltaBase.setItemUpdated processes fields to reduce `Object.getOwnPropertyDescriptor` calls
7
- - Refactor the way CacheSyncer.processDelta processes updated values to prevent unneeded field copying and `Object.getOwnPropertyDescriptor` calls
8
- - Add `RequestBufferManagerPrioritySettings` to give finer control over request buffering to the caller
9
-
10
- ## 9.1.2
11
- - Delete item lock when transaction is destroyed
12
- > We never deleted item locks causing the items to be locked forever, even though a user wasn't editing them anymore
13
-
14
- ## 9.1.1
15
- - Fix handling of multiple create requests in one transaction
16
-
17
- ## 9.1.0
18
- - Implement cascading deletes based on backend delete relations
19
-
20
- ## 9.0.5
21
- - Prevent an error occurring when `fetchItemEntryData` did not return an itemEntry
22
-
23
- ## 9.0.4
24
- - Remove `MAYBE` matches that did not get returned after the API query from cached queries and collections in `CacheSyncer`
25
-
26
- ## 9.0.3
27
- - Check for empty changesDeltas in `TransactionCache.applyChangesFromParent` to prevent unnecessary calls
28
-
29
- ## 9.0.2
30
- - Improve the way `getLinkCollections` fetches its data to greatly improve performance
31
-
32
- ## 9.0.1
33
- - Accept any version (apposed to `latest`) for @rentman/backend-types
34
-
35
- ## 9.0.0
36
- - **Breaking:** Align item changes in server cache and transaction cache: add `fields` property in server item changes,
37
- rename `changes` in transaction item changes to fields. Remove `getChangesFromItemChanges`.
38
-
39
- ## 8.2.11
40
- - Only copy over cachedQueries when saving child transactions if the parent transaction doesn't have one with the query yet
41
-
42
- ## 8.2.10
43
- - Fix displayname for 'CustomfieldGroup'
44
- - Also set displayname when creating ItemEntries
45
-
46
- ## 8.2.9
47
- - Fixes a bug in which items on the ServerCache would not properly be added to collections
48
-
49
- ## 8.2.8
50
- - Fixes a bug in which newly created items do not appear in collections caused in 8.2.6
51
-
52
- ## 8.2.7
53
- - Merge tabRequestParameters when saving a TransactionCache into another TransactionCache
54
-
55
- ## 8.2.6
56
- - Fixed issue where deleted equipment re-appear
57
-
58
- ## 8.2.5
59
- - Skipped
60
-
61
- ## 8.2.4
62
- - Fixed issue where non-local items were expanded locally.
63
- - Fixed hypothetical situation where an item entry in a local cached query could have an incomplete column set.
64
-
65
- ## 8.2.3
66
- - Did a performance optimization which will cause aggregated columns not to be re-fetched unnecessarily
67
-
68
- ## 8.2.2
69
- - Fixed a bug where derived values would not be fetched for newly created local items
70
- - Did a performance optimization which will cause aggregated columns not to be re-fetched unnecessarily
71
-
72
- ## 8.2.1
73
- - Skipped
74
-
75
- ## 8.2.0
76
- - Added support for collection trees. Now, when requesting a collection you can add the `children` property, which is
77
- a map of collection options. The collection resources will be available in the item resources of the resulting
78
- collection resource. For more information, see [Confluence](https://rentman.atlassian.net/wiki/spaces/~652789241/pages/948404231/Child+collections).
79
-
80
- ## 8.1.9
81
- - RM4-16796 Fixed a bug where loading the same query in quick succession would cause columns/data to be missing
82
-
83
- ## 8.1.8
84
- - Reorganize imports: move all exports to `internal.ts`. This is the only place where things should be exported. All files should import from this file. Resolve duplicate declaration of `InternalCreateDelta` type.
85
- - Improve performance of copying over values in `ChangesDelta`s and `CollectionMatcherBase`
86
- - Merge all `CollectionMatcher` classes into one `CacheSyncer`, so that `processDelta` only has to be done once
87
- - Increase performance of the ApiFormatter on large datasets
88
-
89
- ## 8.1.7
90
- - Fixed a bug where copied over CachedQueryItems weren't resolved (causing them to hang forever)
91
-
92
- ## 8.1.6
93
- - Add missing return statement in ServerCache.applyChangesDelta
94
-
95
- ## 8.1.5
96
- - Only extend missing derived values while resolving local items in `TransactionCachedQueryHandler.__fetchItemEntriesByQueryData`
97
-
98
- ## 8.1.4
99
- - Remove non-created items if they are not returned in the response of a Create request
100
- > If a create would fail, the whole request would fail. So we can assume that if an item isn't returned from a create
101
- > request, the backend has left it out on purpose
102
- - Move cached queries to parent transactions only when saving a child transaction
103
- > Only then you know for sure that items that matched on the child transaction will also match in the parent transaction,
104
- > since you're taking over the changes, this behaviour was changed somewhere in a refactor but was incorrect
105
- - No longer move cached queries to the ServerCache when saving a root transaction
106
- > You probably don't need the result of *all* those cached queries anymore (and it's also inefficient to keep them because the matcher keeps the up-to-date)
107
- - No longer wait for child transactions to sync when applying changes in a parent
108
- > A child transaction can only influence a parent transaction by calling `TransactionCache.save`, which doens't happen whilst applying changes,
109
- > so you don't have to wait for child transactions when applying changes in a parent
110
-
111
- ## 8.1.3
112
- - Allow passing TransactionOptions to TransactionCacheFactory.construct
113
-
114
- ## 8.1.2
115
- - Fixed a bug in which derived values for local items wouldn't be properly be fetched
116
-
117
- ## 8.1.1
118
- - Fixed a bug in which a `Template` request's columns weren't processed
119
-
120
- ## 8.1.0
121
- - Add `cloneCreatedChanges` function to `ChangesDeltaFactory`. This function clone the `created` component of a changes
122
- delta into a destination changes delta.
123
- - Add `TransactionOptions`, implement `transparent` transaction option
124
- - Allow core-mapped TS types instead of backend-mapped TS types in `ApiFormatter.compareFields`
125
- - Fixed a bug where empty update requests where sometimes done
126
- - Fixed a bug where derived values of items returned in a Template request weren't properly resolved
127
-
128
- ## 8.0.3
129
- - Changed the flow of a create request so that it includes all the required columns for all transactions and also processes additionally returned (derived) items
130
- - Fixed a bug where fields referencing local items would already be updated in the `previous` before the `onChange` callbacks were called
131
- - Moved logic of updating IDs in cached queries/collections to TransactionCachedQueryHandler and TransactionCollectionHandler
132
-
133
- ## 8.0.2
134
- - Fixed a bug where deleted entries on a child transaction where not handled properly
135
- - Fixed a bug where saving a child transaction, and then undoing those changes and saving again would not update the parent transaction
136
-
137
- ## 8.0.1
138
- - Uppercase operators and comparators in QueryMatcher, QueryParser and QueryService
139
- - Fix parsing short-hand `IN` queryies
140
-
141
- ## 8.0.0
142
- - Implement `@rentman/backend-types`
143
- > You will now have autocomplete and typing checking on all columns/fields 🥳
144
- - Remove `ChangesDeltaResult.rollback`
145
- > It was never really used/implemented
146
-
147
- ## 7.2.0
148
- - Add the `preventCaching` option to `CollectionOptions`
149
- > Prevents a CachedQueryItem from being cached (the CollectionResource will still be cached), you can use this when you fetch an Itemtype for which the backend doesn't send socket messages (so it never automatically updates)
150
-
151
- ## 7.1.1
152
- - Properly handle moved items in ServerCache.applyChangesFromParent (technically the backend won't ever generate a linkTo (only updates)) but it can happen when manually syncing the server cache (by doing `InternalChangesDelta.setItemMoved`)
153
-
154
- ## 7.1.0
155
- - Automatically keep aggregated values up-to-date by always refetching them
156
-
157
- ## 7.0.15
158
- - Remove an accidentally left in place debugger
159
-
160
- ## 7.0.14
161
- - Take into account collections with a 'limit' (of which the query result isn't cached) when matching socket items
162
-
163
- ## 7.0.13
164
- - Only overwrite the displayname if the required columns are present, instead of defaulting to an empty string
165
-
166
- ## 7.0.12
167
- - Fixed a bug where the core would try to update the cache key (ID) of `fieldChangeCallbacks` even when there were no callbacks for the given itemType
168
-
169
- ## 7.0.11
170
- - Fixed a bug where date values would not be compared if the descriptor was uncalled, this could lead to problems when applying changes from a parent transaction
171
-
172
- ## 7.0.10
173
- - Update references to local IDs in other items when a local ID gets updated
174
-
175
- ## 7.0.9
176
- - Take over `tabRequestParameters` when saving TransactionCache -> TransactionCache
177
-
178
- ## 7.0.8
179
- - Fixed a race condition and loop iteration error which in very rare cases caused itemEntries to be `undefined` and erroring
180
- - Add missing error handling in transaction functions
181
-
182
- ## 7.0.7
183
- - Properly handle `reverse` linkedTo's in QueryColumnExtractor and QueryLocallyMatchableParser
184
- - Implement refreshing of cached queries/collections
185
-
186
- ## 7.0.6
187
- Move fetching of lock from `TransactionItemHandler.processItemEntryChanges` to `TransactionCache.appyChangesDelta` to also capture creates and deletes.
188
-
189
- ## 7.0.5
190
- - Remove automatic fetching of derived values for not-yet-created items
191
-
192
- ## 7.0.4
193
- - Automatically resolve derived values when a new item is created
194
- - Fixed a bug where `AbstractCache.getParentFromFields` would still return `null` incorrectly
195
-
196
- ## 7.0.3
197
- - Fixed a bug where `AbstractCache.getParentFromFields` would still return `undefined` parent values
198
-
199
- ## 7.0.2
200
- - Check if any of the parent fields (`itemtype`, `item`) is `null`, in which case it won't be treated as a valid parent in `AbstractCache.getParentFromFields`
201
-
202
- ## 7.0.1
203
- - Ignore columns in ApiFormatter::hasChanges if the `modified` object does not contain a value for it.
204
-
205
- ## 7.0.0
206
- - **Breaking**: Remove `enableChangesWatcher` and `disableChangesWatcher` in `TransactionCache`.
207
- - Fetch lock token in `TransactionItemHandler.processItemEntryChanges`.
208
-
209
- ## 6.3.10
210
- - Only call `onRemove` of a collection if there are actually any items removed
211
- - Expand cached columns anyways if there are no items to expand in `TransactionCachedQueryHandler.__expandCachedQuery`
212
-
213
- ## 6.3.9
214
- - Fixed a bug where deleted local items would still appear as unsaved changes
215
-
216
- ## 6.3.8
217
- - Always fetch 'id' and 'permissions' columns so that they are always available
218
-
219
- ## 6.3.7
220
- - Fixed a bug where items in a socket message that _might_ fit (`MAYBE`) in a collection would not be checked/added.
221
-
222
- ## 6.3.6
223
- - Fixed a bug where `AbstractCache.fetchUpdatedDerivedValuesFromDelta` would attempt to use ItemChanges not cached on the transaction
224
- resulting in an error
225
-
226
- ## 6.3.5
227
- - Fixed a bug where after creating items derived values would needlessly be refetched
228
- > The core now properly detect that even though an ItemId is updated (after a create) it's still the same item so no request has to be done
229
- - Fixed a bug where ItemEntry's would not be re-cached under their new ItemIds
230
-
231
- ## 6.3.4
232
- - Fixed a bug where already cached itemEntries would not properly be detected when calling `ServerCache.processResponse`
233
- - Fixed a bug where calling `CreatedChangesDelta.remove` would add `empty` values in the array instead of removing the entry
234
-
235
- ## 6.3.3
236
- - Fixed a bug where local ItemEntries were not properly updated after saving
237
-
238
- ## 6.3.2
239
- - Fixed updating item entry itemId field after processing changes
240
-
241
- ## 6.3.1
242
-
243
- - Fixed a bug where query with a local ID would do a request to the server
244
- ```
245
- // This example should now no longer do a request
246
- transaction.getItemsByQuery(
247
- 'Tijd',
248
- {
249
- project: -11,
250
- }
251
- );
252
- ```
253
-
254
- ## 6.3.0
255
- - Allow strict typing of `FieldMap`
256
-
257
- ## 6.2.5
258
- - Remove overwriting itemType with itemType of rootItem during create
259
-
260
- ## 6.2.4
261
- - Fixed a bug where items would not appear in a collection after changes propagated from a parent transaction
262
-
263
- ## 6.2.3
264
- - Fixed a bug where `previous` would actually contain new values because the `previous` object was made after the values were already synced
265
-
266
- ## 6.2.2
267
- - Fixed a bug in syncing of initial values after saving an item causing the item to still be marked having changes
268
-
269
- ## 6.2.1
270
- - Fixed a bug where `ItemEntry`s created on the `ServerCache` where not matched on child `TransactionCache`s
271
-
272
- ## 6.2.0
273
- - Fixed a bug where synchronous validators would leave the validator in `pending` state
274
- - Only re-match items when values are actually changed
275
- - Removed `defered` from `CachedQueryItem` and added `resolve` and `reject`
276
- - Check if ItemEntries are already created before creating new ones, if that is the case treat it like an update
277
- > What could happen was that a faster request created an ItemEntry for the same item as another request
278
- > which caused the double creation of an ItemEntry
279
-
280
- ## 6.1.3
281
- - Add `isPending` function to `TransactionValidator`
282
- - `TransactionCache`s will now be invalid until all pending transaction validators are done
283
-
284
- ## 6.1.2
285
- - Check if an error key exists before deleting it in `TransactionCache.clearItemError`
286
-
287
- ## 6.1.1
288
- - Correctly pass `ErrorHandlerInterface` to `ChangesDeltaFactory`.
289
-
290
- ## 6.1.0
291
- - Return `ChangesDelta` instance in `setItemUpdated`, `setItemDeleted`, `setItemsDeleted` methods, and a promise that resolves to the instance in `setItemCreated` and `setItemsCreated`.
292
-
293
- ## 6.0.2
294
- - Update `query` parameter of `getByQuery`, `getLocalByQuery`, `batchGetLocalByParent`, and `matchQuery` in `ItemCache`.
295
-
296
- ## 6.0.1
297
- - Fixed a bug where a local item wouldn't be found when using `TransactionCache.getItemByState` on a child transaction
298
-
299
- ## 6.0.0
300
- - Refactored query caching structure
301
- - Properly implemented `limit` in collections
302
- - Removed extending of collections
303
-
304
- ## 5.0.1
305
- - Add 'icon' column type to non-selectable column types
306
-
307
- ## 5.0.0
308
- - Fixed a bug where created, creator and permissions was always set to default values
309
- - **Breaking:** Remove `onItemsCreated` collection callback.
310
-
311
- ## 4.0.4
312
- - Fixed a bug where ModuleChangesCompilation wouldn't include all changes
313
-
314
- ## 4.0.3
315
- - Local collections are now correctly identified when using a local ID in a linkTo request instead of the `parent` option
316
- - Fix issue where local collection entries were not moved to server cache after save.
317
-
318
- ## 4.0.2
319
- - Fixed a bug where clearing collections would error after saving a transaction
320
-
321
- ## 4.0.1
322
- - Remove thrown error in `ItemResource.callOnChange`
323
- > The frontend still relied on this and we won't refactor that at this point
324
-
325
- ## 4.0.0
326
- - Removed `ItemResourceOptions.onChange`, this is replaced by `TransactionCache.registerFieldChangeCallback`
327
- > Because the `onChange` is no longer stored on the ItemResource, the ItemResource doesn't have to be cached.
328
- > This way you don't have to call `ItemResource.clearResource` anymore (you do need to deregister the fieldChange callbacks)
329
-
330
- ## 3.1.0
331
- - **Breaking:** Remove `fields` property, add `getFields` method in `Template` class.
332
- - **Breaking:** Add `ConversionMapService`. Update `updateItemValues` to take a `source` and `destination` parameter.
333
- - Update `entry.itemId` for items created items in `TransactionCache.getDelta`.
334
- > This fixes an issue with updating IDs of local items.
335
- - Add dependency interfaces for `AbstractCache`, `ServerCache`, `TransactionCache`, `TransactionCollectionHandler`, `TransactionItemHandler`.
336
- - Add `CreatedChangesDelta` class, which replaces the `created` component of the `ChangesDelta` and includes some query methods. Add `isEmpty` method to `ChangesDelta`.
337
-
338
- ## 3.0.1
339
- - Fixed a bug where the `StateKeyType` enum couldn't be used when imported
340
-
341
- ## 3.0.0
342
- - Remove ViewResource, EditResource, CollectionViewResource and CollectionEditResource
343
- > There was no real distinction between them anymore since the core 2.0 update.
344
- > You can now use the base ItemResource and CollectionResource types instead
345
-
346
- ## 2.4.0
347
- - Update Typescript version to `3.7.2`, also update other plugins
348
-
349
- ## 2.3.0
350
- - Add callbacks when errors are set/cleared to `TransactionEventHandler`
351
- - Added the possibility to differentiate between errors to display below a field and on the save button in `TransactionValidator`
352
- - Changed the format of the error translations from `string` to `() => string` in `TransactionValidator`
353
- > Now the translation function will only be called when the error is actually set, not when it's cleared
354
-
355
- ## 2.2.1
356
- - Fixed a bug where resolving derived values for new items (in `TransactionCache.applyChangesDelta`) would sometimes error
357
-
358
- ## 2.2.0
359
- - `ChangesDelta.setItem(s)Created` will now accept incomplete input values
360
- > It will now fetch a template for you and process the items, so you no longer need to do that yourself
361
-
362
- ## 2.1.2
363
- - Fixed a bug where deleted ItemEntries weren't picked up when detecting transaction changes
364
-
365
- ## 2.1.1
366
- - Fixed a bug where an ItemEntry's errors wouldn't be deleted when the ItemEntry was deleted on a transaction
367
-
368
- ## 2.1.0
369
- - Refactor `TransactionCache.getItemsByQuery` to check cached entries (just like a collection)
370
- - Add `TransactionValidator`, allow passing of a `TransactionValidatorFactory` to a transaction
371
- > You can use these validators to set errors using `setItemError` and `setGlobalError`
372
- - Fixed a bug where `TransactionItemHandler.cloneItemEntry` could only clone entry with changes on the target transaction.
373
- > It will not look for changes recursively on the transaction change
374
-
375
- ## 2.0.19
376
- - Ensure all requestColumns for newly created ItemEntries from a template are available
377
- - Ensure derived values for newly created ItemEntries from a template are available
378
-
379
- ## 2.0.18
380
- - Include read-only columns when detecting changes in TransactionItemHandler.processItemEntryChanges
381
- > Read-only columns shouldn't count as changes on the tab, but they should be taking into account when deciding whether or not to call `onChange`
382
-
383
- ## 2.0.17
384
- - Fixed a bug where deleting an item that isn't in the transaction's item entry cache would result in an error
385
- - Fixed a bug where response columns weren't set for newly created local CollectionEntries
386
- - Fixed a bug where items weren't matched for newly created local CollectionEntries
387
-
388
- ## 2.0.16
389
- - Fixed a bug where queries with a link to a local parent item weren't updated on save
390
-
391
- ## 2.0.15
392
- - Cache ItemEntries that fit collections on the CollectionEntry's query instead of the CollectionEntry's id
393
- - Add a 'hint' to ChangesDeltas which allows skipping the extra request to validate `maybe` query matches
394
- - Create transaction changes for ItemEntry updates in the changesDelta if non exist yet when calling `TransactionCache.applyChangesDelta`
395
- > This allows you to update values on a transaction without having to fetch a resource for it by calling
396
- > `ChangesDelta.setItemUpdated()`
397
-
398
- ## 2.0.14
399
- - Fixed reading of derived values in `getItemIdByColumn` when a ChangesDelta is passed
400
-
401
- ## 2.0.13
402
- - Fixed a bug where the incorrect fields where applied to the ChangesDelta in `TransactionItemHandler.cloneItemEntry`
403
- - A RequestBuffer's promise will now resolve after the ServerCache.processResponse promise is done, ensuring all values are present before continuing
404
- - Request columns for the request ItemType will now properly be taken into account in ServerCache.processResponse ensuring root columns are always properly set. (This is used to update derived values)
405
-
406
- ## 2.0.12
407
- - Fixed a bug where created changes weren't copied to the itemchanges
408
- - Only take readonly parent columns instead of all readonly columns in `ApiFormatter.hasChanges`
409
- - Fixed a bug where ItemEntry's where still in `ItemCache.entriesByEntryId` after clearing them
410
-
411
- ## 2.0.11
412
- - Fixed a bug where changes weren't copied to the itemchanges
413
- - Fixed correct isCalledAfterApiSave values on calls to ServerCache.processResponse
414
-
415
- ## 2.0.10
416
- - Construct `ColumnSet` with proper `requestColumns` when creating a `Template` with additional columns
417
-
418
- ## 2.0.9
419
- - Properly process linked items from the template request in `TransactionItemHandler.createItems`
420
-
421
- ## 2.0.8
422
- - Fixed a bug where not all fields where available even tough an ItemResource with specific columns was created
423
-
424
- ## 2.0.7
425
- - Define abstract copyTransactionItemEntryChanges on ItemHandlerBase
426
- - Implement copyTransactionItemEntryChanges on TransactionItemHandler and ServerItemHandler
427
- - Fix AbstractCache/ServerCache/TransactionCache `getParent` function arguments
428
- > With the newly added arguments the function definitions didn't align anymore causing typescript errors
429
- > Even though the arguments aren't used in the `ServerCache` they're added in there
430
-
431
- ## 2.0.6
432
- - Remove `ApiFormatter.lazyClone`
433
- > You can't lazily clone moment objects because the moment you wanted to clone could be changed in the time the getter isn't invoked, resulting in a different value
434
-
435
- - Create a copy of the child transaction's field instead of copying the object reference in `TransactionCache.applyChangeFromChild` and `ChangesProcessor.executeCreateRequest`
436
- > When writing to the object references you're changing multiple transactions at once, while this should be handled by applyCHangesFromParent
437
-
438
- ## 2.0.5
439
- - Add `callOnAddWithInitialItems` option to `CollectionResourceOptions`
440
- > If `true` the `onAdd` callback will be called with the initial set of items
441
-
442
-
443
- ## 2.0.4
444
- - Add `isCalledAfterSocketUpdate` to `onAdd`, `onRemove` and `onChange` callbacks
445
- > You can use this if a data change should only trigger an action when the user caused it himself
446
-
447
- ## 2.0.3
448
- - Fix `CollectionEditResource.removeItems`
449
- - Move `getCurrentCollectionEntryCache` and `getCurrentItemEntryCache` from `TransactionCache` to `AbstractCache`
450
-
451
- ## 2.0.2
452
- - Fix marking entries as deleted and compiling this into a request
453
-
454
- ## 2.0.1
455
- - Expand CollectionEntry's columns in `ServerCollectionHandler.fetchCollectionData`
456
-
457
- ## 2.0.0 - Major caching refactor
458
- - Completely reworked internal caching structure, see [this Confluence page](https://rentman.atlassian.net/wiki/spaces/DEV/pages/704872456/) for the motivations behind it.
459
-
460
-
461
- ## 1.9.0
462
- - Don't create ItemResources when not returning links in `ItemAdministrator.getNewResourceWithId` and in `ItemAdministrator.constructOnItemsExpanded`
463
-
464
- ## 1.8.0
465
- - Remove `ResourceCache` and `resourceLevel`
466
- > You should now manually call `resource.clearResource` when you no longer need a resource
467
- - Add `onConstruct` function to `ItemResource` and `CollectionResource`
468
- > This is overwritten by the frontend to track resource creation
469
-
470
- ## 1.7.6
471
- - Add priority parameter to local cache callbacks. The callback condition (`always` / `onClose` / `skipOnClose`) no longer has any effect on the order in which the callbacks get executed.
472
- - **Breaking:** Remove `LocalCacheCallbackCondition` enum.
473
- - Add `itemId` parameter to `ItemHandler.fetchNewItem`. An error is thrown when an ID already exists. Add `getNewResourceWithId` to ItemAdministrator. Deprecate `getItemByState`.
474
-
475
- ## 1.7.5
476
- - For template column sets it is no longer assumed all columns are present. This fixes an issue with incomplete column
477
- sets in the front-end.
478
- - Fix issue where `changesProcessor` instance was undefined in `itemResourceFactory` and `collectionResourceFactory`.
479
- Create variables for each core service in order to get a TypeScript error when a dependency hasn't been initialized yet.
480
-
481
- ## 1.7.4
482
- - Add support for strict ItemType type checking in `FieldMap`
483
-
484
- ## 1.7.3
485
- - Add support for strict ItemType type checking
486
- > This is temporarily defaulted to `any` to prevent compile errors in the frontend
487
-
488
- ## 1.7.2
489
- - Fix some typing issues in:
490
- - ApiResponseProcessor
491
- - ItemCache
492
- - KeyService
493
-
494
- ## 1.7.1
495
- - Fix issue where `CreateRequestFactory` would be undefined in `ChangesProcessor`.
496
-
497
- ## 1.7.0
498
- - **Breaking:** remove `ChangesProcessorFactory`. Add `ChangesProcessor` instance to core directly.
499
-
500
- ### Resource caching
501
- - **Breaking:** the following properties are removed:
502
- - On `ItemEntry`: `clearResources`, `deactivateResources`.
503
- - On `CollectionEntry`: `clearResources`, `getCurrentResource`.
504
- - On `CollectionResourceOptions`: `clearOnTabChange`, `clearOnSubTabChange`.
505
- - An additional `level` parameter has been added to all methods that return resources.
506
- - When creating resources using `ItemResourceFactory` or `CollectionResourceFactory`, this parameter is mandatory.
507
- A `defaultResourceLevel` parameter has been added to the `LocalCache` constructor.
508
- - A `clearResources` method has been added to `ItemAdministrator`. When calling this method, all item / collection
509
- and collection resources with a level of `level` or higher will be removed.
510
- - The `clearResources` method has been removed from `LocalCache`.
511
- - The `setCurrentLocalCache` function has been removed from `LocalCacheManagerInterface`.
512
-
513
- ## 1.6.13
514
- - When encountering a collection entry with `PROMISED_EXPAND` status, call `getCachedEntryStatus` after the initial
515
- promise has been resolved.
516
-
517
- > This is the likely cause of the issue where `_resolve` is called on a non-deferred collection entry.
518
-
519
- ## 1.6.12
520
- - Fix error that occurs when trying to resolve a non-deferred collection entry.
521
-
522
- ## 1.6.11
523
- - Fix issue where `QueryMatcher.matchComplexQuery` would return the wrong value.
524
-
525
- ## 1.6.10
526
- - **Breaking**: Remove `linkType`, `linkIdArray` properties from `LinkCollectionDefinition`. Add `linkType`,
527
- `linkIdArray` parameters to `ItemAdministrator.getLinkCollectionsFromDef`.
528
-
529
- ## 1.6.9
530
- - Redeploy of `1.6.8`
531
-
532
- ## 1.6.8
533
- - Add support for `not` in queries
534
-
535
- ## 1.6.7
536
- - Fix issue where `CollectionMatcher.addToCollections` wouldn't return the correct type.
537
-
538
- ## 1.6.6
539
- - Add `callOnAdd` parameter in `CollectionHandler.batchExtend`. Set `updateInitial` to true. Remove `updateInitial` parameter in `CollectionEntry.extend`, as it should always be true.
540
- > The `extend` function only concerns itself with remote items, so no local changes should be generated.
541
-
542
- ## 1.6.5
543
- - Fix issue where a derived column could be marked as the `link` (parent) column in the column set.
544
- > This could lead to instances where a different column would be set to the value of the parent.
545
-
546
- ## 1.6.4
547
- - Fix issue where the `onChange` collection callback would not be called when updating it in the options.
548
- - Add `callOnAdd` parameter to collection matcher. When set to `false`, `onAdd` is not called for the `resultCollectionResource`.
549
-
550
- ## 1.6.3
551
- - Properly type ApiResponseProcessor - fetchObjectArray
552
-
553
- ## 1.6.2
554
- - Fix issue where the collection handler would return collection entries before they were resolved when calling `batchFetch`.
555
-
556
- ## 1.6.1-3
557
- - Check for linkedTo before checking for subqueries in QueryMatcher
558
- > Linkedto also has `.query` and was incorrectly marked as a subquery
559
-
560
- ## 1.6.1-2
561
- - Fixed shorthand query with null values
562
- > The QueryParser would incorrectly identify subqueries when using null in a shorthand
563
-
564
- ## 1.6.1-1
565
- - Fixed shorthand query with Moment values
566
- > The QueryParser would incorrectly identify Moment objects as a subquery
567
-
568
- ## 1.6.1
569
- - Added support for subqueries in QueryParser and QueryMatcher
570
- > Collections using subqueries will always return 'maybe' in the QueryMatcher
571
-
572
- ## 1.6.0
573
- - All external callbacks are now wrapped in a `try ... catch` block. This prevents them from breaking core functionality.
574
- - **Breaking**: Add `ExceptionHandlerInterface` parameter to core constructor.
575
-
576
- ## 1.5.9
577
- - Fix issue that occurs when trying to resolve a `ColumnSet` using a single non-existing column.
578
- Catch exceptions that might occur when resolving an `ItemEntry`.
579
- - Add `mergeRequestColumns`, `mergeResponseColumns` to `ColumnSet`. When encountering new items while expanding a collection, add them to the collection.
580
-
581
- ## 1.5.8
582
- - Introduce `RemoteViewResource` and `LocalViewResource`.
583
- > The `fields` property of a `RemoteViewResource` represents
584
- server values, while the `fields` property of a `LocalViewResource` represents local values.
585
- - The `fields` property of a `ViewResource` is now read only.
586
-
587
- ## 1.5.7-1
588
- - Make ItemResource/CollectionResource base class abstract
589
- - Add missing overload functions in some places
590
- - Fix default comparator `QueryMatcher.parseSimpleQuery`
591
- - Fix `ExtendedCollectionMatchResult` `collection` property type
592
-
593
- ## 1.5.7
594
- - Properly type Collections & ItemResources (and return values) in the whole core.
595
- > The core will now properly return Collections & ItemResources based on the passed CollectionOptions.
596
- > You can now also type the expected collection type
597
-
598
- ```
599
- // Expects a collection with editCollection and editItems both `true`
600
- // Will properly return EditResources for all collection functions
601
- const collection: CollectionEditResource<EditResource>;
602
-
603
- // other variations are:
604
- // CollectionViewResource<ViewResource>
605
- // CollectionViewResource<EditResource>
606
- // CollectionEditResource<ViewResource>
607
-
608
- this.core.itemAdministrator.getCollection(
609
- 'Notitie',
610
- {
611
- editCollection: true, // Will return a CollectionEditResource
612
- editItems: true // Will return EditResources instead of ViewResources in `.items`
613
- }
614
- )
615
- ```
616
-
617
- ## 1.5.6
618
- - Add `getAllLocalCaches` to `LocalCacheManagerInterface`, remove item entries from all local caches on socket delete.
619
-
620
- ## 1.5.5
621
- - Add 'order' column type handling to ApiFormatter functions
622
-
623
- ## 1.5.4
624
- - Fix issue where parent would be incorrectly set when cloning a single item.
625
- - Type functions related to expansion maps in `ItemEntryService`.
626
-
627
- ## 1.5.3
628
- - Fix issue where the `enableSave` collection resource option would default to `false`. This would throw an error when
629
- calling `save` on a collection resource where this option was not explicitly set.
630
-
631
- ## 1.5.2
632
- - Type functions in `ColumnUtil` class.
633
- - Add `getRequestColumnId` and `containsDerivedColumns` to `ColumnUtil`.
634
- > `getRequestColumnId` should be used instead of `Util.getFirstProperty` when retrieving a column ID.
635
- - **Breaking:** Remove `ColumnUtil.isColumnSubset`. Use `ColumnSet.isSuperSetOf` instead.
636
- - Remove `findColumnObject`. Rename `findColumn` to `findRequestColumn`.
637
-
638
- ## 1.5.1
639
- - Properly remove item entry stub from (local) cache when request fails.
640
- - Fix issue where item or collection options could be set to undefined.
641
-
642
- ## 1.5.0
643
- - Add `SocketMessage` type and add types to `SocketMessageHandler`
644
- - Expand local items requested using `getItemById` or `getItemsById` in `ItemAdministrator`.
645
- (`fetchItem` or `fetchItems` in `ItemHandler`.)
646
- - Implement expanding of local collections. This no longer leads to invalid requests.
647
- - **Breaking:** The `expand` function in `CollectionEntry` now has an `ItemCache` parameter.
648
- - **Warning:** This version contains major changes.
649
-
650
- ### Introduce typing of item and collection options
651
- - **Breaking:** Removed `QueryItemType` collection entry option.
652
- - **Breaking:** Removed `ItemResourceService`.
653
- - Removed `processOptions` parameter from `createCollectionResource` (`ItemAdministrator`). It is now equivalent to
654
- `addCollection`.
655
- - When creating an item resource using `ItemResourceFactory`, a collection entry using `CollectionResourceFactory` or a
656
- collection resource using `CollectionResourceFactory` it is no longer necessary to process options beforehand. It is
657
- still necessary when interacting with `CollectionHandler` or `ItemHandler` directly.
658
-
659
- ## v1.4.0
660
- - Add `expandProcessLinkedItems` and `expandAddToCollections` to `ItemAdministrator`. These are analogues to
661
- `processLinkedItems` and `addToCollections`, but also expand the items with (derived) values and columns as necessary.
662
- They have a slightly different type signature.
663
- - Whenever a collection is requested, the `CollectionHandler` now makes sure that added local items are expanded as
664
- necessary.
665
- - **Breaking:** Last parameter of `ItemHandler.createLocalEntries` is now a callback function.
666
- - **Breaking:** Rename `TemplateLinkedItemEntryMap` type to `TemplateItemEntryMap`.
667
-
668
- ## v1.3.8
669
- - Add `isSaving` to `LocalCache`
670
- > We use this to disable the cancel/save buttons while the localCache is saving in the frontend
671
-
672
- ## v1.3.7
673
- - Fix issues that generate invalid requests / changes when moving existing item to another collection, then deleting the parent.
674
- - Remove slip workarounds
675
- - Add api request types
676
- - Add types to `ModuleChangesCompilation`
677
-
678
- ## v1.3.6
679
- - Skip add / remove collection callbacks when calling `revertChanges` (`LocalCache`).
680
-
681
- ## v1.3.5
682
- - Fix issue where items added to collections when resolving wouldn't be removed in `revertChanges` (`LocalCache`).
683
-
684
- ## v1.3.4
685
- - Add country to isFilteredColumn in ColumnUtil
686
-
687
- ## v1.3.3
688
- - Move processLocalConfigColumns and consolidateColumns from ColumnUtil to frontend
689
- > These functions are specifically used for rendering ui-grid in the frontend, so there's
690
- no reason to have them in the core
691
-
692
- ## v1.3.2
693
- - Fix types path in package.json
694
-
695
- ## v1.3.1
696
- - Fix types path in package.json
697
-
698
- ## v1.3.0
699
- - Rename PromiseInterface to PromiseLibraryInterface
700
- > PromiseInterface is now used for the internal promise type
701
-
702
- - Use PromiseInterface instead of Promise as internal promise type
703
- > This allows us to overwrite the PromiseInterface definition in the frontend indicate usage of ng.IPromise
704
-
705
- ## v1.2.9
706
- - Call processOptions in fetchDerivedValuesByColumn
707
- > Bug was introduced earlier but got enabled in v1.2.7
708
-
709
- ## v1.2.8
710
- - Add toJSON methods for ItemResources, ItemEntries, and ColumnSets to fix circular dependencies in JSON.stringify
711
-
712
- ## v1.2.7
713
- - Set itemEntry parent when generating a stub
714
-
715
- ## v1.2.6
716
- - Fix an issue introduced in v1.2.5.
717
-
718
- ## v1.2.5
719
- - When a local item cannot by found, return a newly created item in `getItemByState` (`ItemAdministrator`) only. This
720
- solves an issue with refreshing on a local edit view.
721
-
722
- ## v1.2.4
723
- - **Breaking:** When a local item cannot by found, instead of a new item being created an error is thrown. This means it
724
- is no longer possible to create local items using `getItemById` or `getItemsById` in the `ItemAdministrator` class.
725
- - **Breaking:** Removed `getItemDefinition` and `getItemByDef` in the `ItemAdministrator` class. Added `getItemByState`.
726
- - Renamed types `TemplateResponseItemEntryMap` to `TemplateItemEntryMap` and `TemplateResponseLinkedItemEntryMap` to
727
- `TemplateLinkedItemEntryMap`.
728
- - Removed `getCollectionCacheKey` in `KeyService`. (Legacy code.)
729
-
730
- ## v1.2.3
731
- - Fixed issue where derived values deeper than one layer couldn't be resolved.
732
-
733
- ## v1.2.2
734
- - Fixed issue where in derived values weren't set after create request.
735
-
736
- ## v1.2.1
737
- - **Breaking:** Replaced the `initial` parameter with the `callOnChange` parameter (`true` by default) in the `commit`
738
- function of the `EditResource` class.
739
- - Fixed issue in `setLocalFields` (`ItemEntry`) where some values were wrongly assumed to be present in `initialValues`.
740
- - Optimization: Disabled automatic resolution of derived values in `addItems` (`CollectionEditResource`) when `modInstant` is set to true.
741
-
742
- ## v1.2.0
743
- - **Breaking:** When calling `addItems` or `addItem` on the `CollectionEditResource` class derived values are now
744
- resolved automatically. Instead of a compound object like `{fields: {key: 'value'}, derived: {}}` an object like
745
- `{key: 'value'}` should now be used as argument when calling these functions.
746
- - **Breaking:** Added `localCache` parameter to `CollectionResource` constructor.
747
-
748
- ## v1.1.20
749
- - Fixed minor issue where collection wouldn't be deferred properly before expanding.
750
- - `onChange` is now called automatically when when calling `commit` on an edit resource.
751
-
752
- ## v1.1.19
753
- - **Breaking:** Renamed `getCurrentChanges` to `getModuleChanges` in the `ItemAdministrator` class. Added optional
754
- `localCache` parameter.
755
-
756
- ### Local cache callback refactoring
757
- - Removed `onSaveWithoutClosing` event.
758
- - Added `condition` parameter to `onBeforeSave` and `onSaveSuccess` (possible values are `always`, `onClose` or
759
- `skipOnClose`, defaults to `always`). Callbacks registered with `condition: always` will get executed before other
760
- callbacks.
761
- - Pass the local cache itself to all registered callback functions. Pass the item ID conversion map as second argument
762
- to `onSaveSuccess` callback functions.
763
-
764
- ## v1.1.18
765
- - Calling `expand` on a `CollectionEntry` manually no longer defers the collection entry.
766
- - The `batchFetch` and `batchExpand` functions in the `CollectionHandler` class now properly defer and resolve the
767
- collection entries.
768
-
769
- ## v1.1.17
770
- - Fixed issue where the `getLocalByQuery` function in the `ItemCache` class wouldn't return any items.
771
- - When batch resolving collection entries, `CollectionHandler` now looks for matching items using `getByQuery` instead
772
- of `getByParent`.
773
-
774
- ### Cache invalidation
775
- - Added `queueReload` function to `ItemEntry` class. This will reload the item when the item entry itself or a
776
- collection entry containing the item is requested.
777
- - The `queueReload` function in the `CollectionEntry` class no longer directly defers the item.
778
- - Added `invalidateCache` function to the `ItemAdministrator` class. This will call `queueReload` on all item entries
779
- and collection entries.
780
-
781
- ### Item entry refactoring
782
- - Renamed `process` to `setFields`.
783
- - Replaced `processLocal` with `setLocalFields`. This function no longer has a `modified` parameter.
784
- - `setModified` now also sets local default values.
785
- - Removed `setCreator`. This function was called twice in some instances.
786
- - **Breaking:** Added `derived` parameter to `updateFields`
787
-
788
- ##v1.16
789
- - Pass `hasChanges` as second argument to `onBeforeSave` callbacks in the `LocalCache` class. This fixes an issue with
790
- project financial values in the front-end. [RM4-9577]
791
- - Added `callOnActivate` parameter to `addItems` function in `CollectionEditResource` class. Use this to prevent items
792
- from being added to the local cache.
793
-
794
- ##v1.15
795
- - Fix `fetchItemTypesTranslations` function in `ColumnHandler` class.
796
- - Fix type definition of `PromiseInterface.all`.
797
-
798
- ##v1.14
799
- - The `ChangesCompiler` now always processes local collections. (Even if they don't have edit resources.) This fixes an
800
- issue with recurring appointments in the front-end.
801
-
802
- ##v1.13
803
- - Add option to exclude itemTypes during createLocalEntries.
804
-
805
- ##v1.12
806
- - **Breaking:** `ItemResource.isNew` returns true *only* if the resource was created using
807
- `ItemAdministrator.getNewResource` or `ItemAdministrator.getItemByDef`. This fixes an issue where items where removed
808
- from the local cache inadvertently.
809
- - The `start`, `commit` and `rollback` functions of `EditResource` now return the resource itself to facilitate chaining.
810
- - When calling `CollectionEntry.revertChanges`, callbacks like `onAdd` / `onRemove` and `onActivate` / `onDeactivate`
811
- are now respected. This fixes an issue where items where *not* removed from the local cache.
812
- - When removing *local* items from collections, they are removed from `initial` as well as `modified`. This fixes an
813
- issue where changes were being detected continuously.
814
- - Updated the order of requests in `changesProcessor`. The `update` request is now executed before the `delete` request,
815
- except when updating documents. This fixes several issues.
816
- - `CollectionCache` now uses a map instead of an array to store collections. This fixes an issue where the same
817
- collection was added multiple times.
818
- - Updated all models to use dependency objects. This increases ease of debugging.
819
-
820
- ##v.1.11
821
- - Fixed issue that occurs when saving when having an existing item refer to a newly created item.
822
- - **Breaking:** Removed `ItemResourceService.isNewResource`.
823
- - **Breaking:** Renamed `ItemResource.isNewResource` to `ItemResource.isNew`. Removed parameter.
824
- - `ItemResource.isNew` is equivalent to `ItemResource.isLocal`, while `EditResource.isNew` checks also checks for
825
- completed transactions.
826
-
827
- ##v.1.10
828
- - Fixed issue where changes on different subtabs were not detected.
829
-
830
- ##v1.1.9
831
- - Exposed `noop` function on `RmCore` class.
832
- > This is used in order to check whether a callback has a default value.
833
- - Added `copyRequestColumns` function to `ColumnUtil` class.
834
- - Made parameters of `ItemAdministrator.saveCurrentLocalCache` and `LocalCache.save` optional.
835
- - **Breaking:** Reordered parameters of `ChangesProcessor.execute` to be consistent with
836
- `ItemAdministrator.saveCurrentLocalCache`. The new order is `singleItems` - `collections` - `parameters` -
837
- `breakUpByParent` - `onAfterCreateCallback`.
838
-
839
- ##v1.1.8
840
- - Set default value for `params` to `{filter: false}` in `request` function in `ColumnHandler` class.
841
-
842
- ##v1.1.7
843
- - Fixed issue where cached item entries or collection entries wouldn't be added to the local cache.
844
-
845
- ##v1.1.6
846
- - Fixed issue with deferred item entries.
847
- - Re-enable changes watcher after save.
848
- - Added optional `id` parameter to `LocalCache` constructor.
849
-
850
- ##v1.1.5
851
- - Added `clearItem` function to `LocalCache` class.
852
-
853
- ##v.1.1.4
854
- - Fix issue where items where not added to the local cache automatically when they where added to a collection.
855
- > This depends on the `callOnActivate` parameter. I've added this mainly because extending collections should *not* add
856
- the items to the local cache.
857
- > In other instances this might be debatable because it doesn't do any real harm. *Not*
858
- doing it however can definitely be harmful.
859
-
860
- ##v.1.1.3
861
- - Fixed an issue where all collections in a local cache would be cleared.
862
- - **Breaking:** Renamed `getCacheManager` to `getCurrentLocalCache` and `setCacheManager` to `setCurrentLocalCache` in
863
- `LocalCacheManagerInterface`.
864
-
865
- ##v1.1.2
866
- - Fixed an issue concerning derived values.
867
-
868
- ## v1.1.1
869
- - Fixed an issue where changes wouldn't be detected.
870
- - **Breaking:** Removed the `_hasChanges` function in the `localCache` class. If you want to force changes detection,
871
- call `detectChanges` instead. Otherwise, rely on the `hasChanges` variable.
872
- - **Breaking:** Removed the `enableWatcher` and `disableWatcher` functions. Use `enableChangesWatcher` and
873
- `disableChangesWatcher` instead.
874
-
875
- ## v1.1.0
876
- ### Development
877
-
878
- #### Strict TypeScript compilation
879
- Added the following TypeScript compiler options:
880
- - noImplicitThis
881
- - noImplicitReturns
882
- - strictNullChecks
883
- - noUnusedLocals
884
- - noUnusedParameters
885
-
886
- I would advise enabling these for all TypeScript projects from now on.
887
-
888
- #### Ordered imports and dependencies
889
- Imports are now ordered alphabetically and grouped by folder. Added a TSLint option to enforce this.
890
- Please note that this also applies for imports from the folder the file is currently in.
891
- For example, in `models/ItemResource.ts`, `itemEntry` should be imported like so:
892
- `import { ItemEntry } from '../models';`
893
-
894
- Also, factory and class dependencies should be ordered alphabetically as well. This will make it easier to add and
895
- remove dependencies in the future.
896
-
897
- ### Breaking changes
898
-
899
- - Renamed `changesCompiler` to `changesCompilation`, `changesCompilerFactory` to `changesCompilationFactory`,
900
- `moduleChangesCompiler` to `moduleChangesCompilation` and `moduleChangesCompilerFactory` to
901
- `moduleChangesCompilationFactory`.
902
- - Removed the `allLinks` parameter from the `query` function definition in the `ApiRequestServiceInterface`. This is
903
- no longer supported in the back-end.
904
-
905
- #### Item and collection entries
906
- - Moved *all* functions that handle item entries from the `ItemEntryService` to the `ItemEntry` class.
907
- - Added the following functions to `ItemEntryService`:
908
- - `createLocalConversionMap`;
909
- - `expandLocalConversionMap`;
910
- - `expandConversionMap`;
911
- - `batchExpandConversionMap`;
912
- - `batchClone`.
913
- - Cloning of item entries now works slightly differently. The function will attempt to generate a new
914
- item ID, and update the conversion map accordingly, but will respect the item ID that is already there.
915
-
916
- #### Rework item caching
917
- Newly created item entries and collection entries are no longer added to the global *or* local cache by default.
918
- All entries are added to the global cache on save. Item entries are added to the local cache when resources are created
919
- using the item administrator or when resources are created when adding the items to a collection.
920
-
921
- > This will increase reliability by ensuring the global cache is no longer 'polluted' with local items. Also, this will
922
- > allow for the creation item and collection entries without caching them directly. This is required for the copying and
923
- > pasting of items.
924
-
925
- Other changes:
926
-
927
- - Moved `saveLocal` to `ItemAdministrator`;
928
- - `ItemAdministrator.fetchTitle` should now be called instead of `ItemHandler.fetchTitle`;
929
- - The `ItemAdministrator` collection matching functions (`addToCollections`, `removeFromCollections`) should now be
930
- called instead of those in the `CollectionHandler`. The `CollectionHandler` should only be used to reflect changes
931
- already on the backend. (Use `getCollectionMatcher`.)
932
-
933
-
934
- ##v1.0.33
935
- - Really fix types path
936
-
937
- ##v1.0.33
938
- - Fix types path
939
-
940
- ##v1.0.32
941
- - Update `tsconfig.json` to put definitions in the root folder
942
- > The app had an issue with AOT compilation because of this
943
-
944
- ##v1.0.31
945
- - Fix `columnHandler.fetchItemTypeTranslations`
946
- > It incorrectly looped over the response map, it should now work again
947
-
948
- ##v1.0.30
949
- - Remove `updateTabParams` from LocalCacheManagerInterface
950
- > The function wasn't used
951
-
952
- - Reworked class export
953
- > Imports are now done from @rentman/rm-core, old imports are broken. This is because the old export structure didn't always work
954
-
955
- ##v1.0.29
956
- - Fix inverted inArray check in CollectionEntry.removeItems
957
- > A delete message from the socket deleted all BUT the deleted items, this should now be fixed
958
-
959
- ##v1.0.28
960
- Bug fixes only
961
-
962
- ##v1.0.27
963
- - `ItemEntry.initial` is now undefined by default
964
- > In the SocketMessageHandler we use this check to see if an ItemEntry is a stub
965
-
966
- ##v1.0.26
967
- Bundle both minified and unminified code, include sourcemaps from dev build
968
-
969
- ##v1.0.24, v1.0.25
970
- ! Use version `v1.0.26` !
971
-
972
- - The core now expects a `promiseInterface` that should implement the provided `promiseInterface`
973
- > We need to be able to hook into the promises in order to call a digest cycle to update the ui in the frontend
974
-
975
- - Rename `ItemEntry.entryId` to `ItemEntry.id
976
- > It used to be called `id`, but it was changed in the seperation of the core.
977
- > You can use the `id` to uniquely identify an entry, since itemId can be updated (local to saved id)
978
-
979
- - Rename ItemResource `startTransaction` to `start`
980
- > Other functions are called `commit` and `rollback` so having 'transaction' only for start doesn't make much sense
981
-
982
- - `SocketMessageHandler.onMessageReceived` now returns a promise
983
- > You can now use the updated items or hook into the result to update the ui for example
984
-
985
-
986
- ##v1.0.23
987
- - Rename ResourceCache to LocalCache
988
- > LocalCache only caches local items (name better reflects functionality)
989
-
990
- - Remove getter/setter for hasChanges
991
- > hasChanges is called in a digest loop in the frontend, so for performance reasons we don't want to recompute the value every time
992
-
993
- - Remove `_getCollection` from ItemAdministrator
994
- > `_getCollection` is now named `getCollection` and the old `getCollection` is removed. The query is part of the
995
- > options and should not be given as a separate argument. This was included to support the frontend
996
-
997
- - Remove `saveCurrentTab` from ItemAdministrator
998
- > `saveCurrentTab` makes no sense because the core has no concept of tabs, you should use `saveCurrentLocalCache` instead
999
-
1000
- - Remove `getTabEntry` and `resetTabEntry` from ItemAdministrator
1001
- > `getTabEntry` and `resetTabEntry` make no sense because the core has no concept of tabs, you should use `getLocalCache` and `resetLocalCache` instead
1002
-
1
+ #Changelog
2
+ Contains new features, breaking changes and their reasoning
3
+
4
+ ## 9.2.1
5
+ - Fix bug in 9.2.0 that caused updates of date fields not to be processed.
6
+
7
+ ## 9.2.0
8
+ - Greatly speed up core processing on large datasets
9
+ - Refactor the way ChangesDeltaBase.setItemUpdated processes fields to reduce `Object.getOwnPropertyDescriptor` calls
10
+ - Refactor the way CacheSyncer.processDelta processes updated values to prevent unneeded field copying and `Object.getOwnPropertyDescriptor` calls
11
+ - Add `RequestBufferManagerPrioritySettings` to give finer control over request buffering to the caller
12
+
13
+ ## 9.1.2
14
+ - Delete item lock when transaction is destroyed
15
+ > We never deleted item locks causing the items to be locked forever, even though a user wasn't editing them anymore
16
+
17
+ ## 9.1.1
18
+ - Fix handling of multiple create requests in one transaction
19
+
20
+ ## 9.1.0
21
+ - Implement cascading deletes based on backend delete relations
22
+
23
+ ## 9.0.5
24
+ - Prevent an error occurring when `fetchItemEntryData` did not return an itemEntry
25
+
26
+ ## 9.0.4
27
+ - Remove `MAYBE` matches that did not get returned after the API query from cached queries and collections in `CacheSyncer`
28
+
29
+ ## 9.0.3
30
+ - Check for empty changesDeltas in `TransactionCache.applyChangesFromParent` to prevent unnecessary calls
31
+
32
+ ## 9.0.2
33
+ - Improve the way `getLinkCollections` fetches its data to greatly improve performance
34
+
35
+ ## 9.0.1
36
+ - Accept any version (apposed to `latest`) for @rentman/backend-types
37
+
38
+ ## 9.0.0
39
+ - **Breaking:** Align item changes in server cache and transaction cache: add `fields` property in server item changes,
40
+ rename `changes` in transaction item changes to fields. Remove `getChangesFromItemChanges`.
41
+
42
+ ## 8.2.11
43
+ - Only copy over cachedQueries when saving child transactions if the parent transaction doesn't have one with the query yet
44
+
45
+ ## 8.2.10
46
+ - Fix displayname for 'CustomfieldGroup'
47
+ - Also set displayname when creating ItemEntries
48
+
49
+ ## 8.2.9
50
+ - Fixes a bug in which items on the ServerCache would not properly be added to collections
51
+
52
+ ## 8.2.8
53
+ - Fixes a bug in which newly created items do not appear in collections caused in 8.2.6
54
+
55
+ ## 8.2.7
56
+ - Merge tabRequestParameters when saving a TransactionCache into another TransactionCache
57
+
58
+ ## 8.2.6
59
+ - Fixed issue where deleted equipment re-appear
60
+
61
+ ## 8.2.5
62
+ - Skipped
63
+
64
+ ## 8.2.4
65
+ - Fixed issue where non-local items were expanded locally.
66
+ - Fixed hypothetical situation where an item entry in a local cached query could have an incomplete column set.
67
+
68
+ ## 8.2.3
69
+ - Did a performance optimization which will cause aggregated columns not to be re-fetched unnecessarily
70
+
71
+ ## 8.2.2
72
+ - Fixed a bug where derived values would not be fetched for newly created local items
73
+ - Did a performance optimization which will cause aggregated columns not to be re-fetched unnecessarily
74
+
75
+ ## 8.2.1
76
+ - Skipped
77
+
78
+ ## 8.2.0
79
+ - Added support for collection trees. Now, when requesting a collection you can add the `children` property, which is
80
+ a map of collection options. The collection resources will be available in the item resources of the resulting
81
+ collection resource. For more information, see [Confluence](https://rentman.atlassian.net/wiki/spaces/~652789241/pages/948404231/Child+collections).
82
+
83
+ ## 8.1.9
84
+ - RM4-16796 Fixed a bug where loading the same query in quick succession would cause columns/data to be missing
85
+
86
+ ## 8.1.8
87
+ - Reorganize imports: move all exports to `internal.ts`. This is the only place where things should be exported. All files should import from this file. Resolve duplicate declaration of `InternalCreateDelta` type.
88
+ - Improve performance of copying over values in `ChangesDelta`s and `CollectionMatcherBase`
89
+ - Merge all `CollectionMatcher` classes into one `CacheSyncer`, so that `processDelta` only has to be done once
90
+ - Increase performance of the ApiFormatter on large datasets
91
+
92
+ ## 8.1.7
93
+ - Fixed a bug where copied over CachedQueryItems weren't resolved (causing them to hang forever)
94
+
95
+ ## 8.1.6
96
+ - Add missing return statement in ServerCache.applyChangesDelta
97
+
98
+ ## 8.1.5
99
+ - Only extend missing derived values while resolving local items in `TransactionCachedQueryHandler.__fetchItemEntriesByQueryData`
100
+
101
+ ## 8.1.4
102
+ - Remove non-created items if they are not returned in the response of a Create request
103
+ > If a create would fail, the whole request would fail. So we can assume that if an item isn't returned from a create
104
+ > request, the backend has left it out on purpose
105
+ - Move cached queries to parent transactions only when saving a child transaction
106
+ > Only then you know for sure that items that matched on the child transaction will also match in the parent transaction,
107
+ > since you're taking over the changes, this behaviour was changed somewhere in a refactor but was incorrect
108
+ - No longer move cached queries to the ServerCache when saving a root transaction
109
+ > You probably don't need the result of *all* those cached queries anymore (and it's also inefficient to keep them because the matcher keeps the up-to-date)
110
+ - No longer wait for child transactions to sync when applying changes in a parent
111
+ > A child transaction can only influence a parent transaction by calling `TransactionCache.save`, which doens't happen whilst applying changes,
112
+ > so you don't have to wait for child transactions when applying changes in a parent
113
+
114
+ ## 8.1.3
115
+ - Allow passing TransactionOptions to TransactionCacheFactory.construct
116
+
117
+ ## 8.1.2
118
+ - Fixed a bug in which derived values for local items wouldn't be properly be fetched
119
+
120
+ ## 8.1.1
121
+ - Fixed a bug in which a `Template` request's columns weren't processed
122
+
123
+ ## 8.1.0
124
+ - Add `cloneCreatedChanges` function to `ChangesDeltaFactory`. This function clone the `created` component of a changes
125
+ delta into a destination changes delta.
126
+ - Add `TransactionOptions`, implement `transparent` transaction option
127
+ - Allow core-mapped TS types instead of backend-mapped TS types in `ApiFormatter.compareFields`
128
+ - Fixed a bug where empty update requests where sometimes done
129
+ - Fixed a bug where derived values of items returned in a Template request weren't properly resolved
130
+
131
+ ## 8.0.3
132
+ - Changed the flow of a create request so that it includes all the required columns for all transactions and also processes additionally returned (derived) items
133
+ - Fixed a bug where fields referencing local items would already be updated in the `previous` before the `onChange` callbacks were called
134
+ - Moved logic of updating IDs in cached queries/collections to TransactionCachedQueryHandler and TransactionCollectionHandler
135
+
136
+ ## 8.0.2
137
+ - Fixed a bug where deleted entries on a child transaction where not handled properly
138
+ - Fixed a bug where saving a child transaction, and then undoing those changes and saving again would not update the parent transaction
139
+
140
+ ## 8.0.1
141
+ - Uppercase operators and comparators in QueryMatcher, QueryParser and QueryService
142
+ - Fix parsing short-hand `IN` queryies
143
+
144
+ ## 8.0.0
145
+ - Implement `@rentman/backend-types`
146
+ > You will now have autocomplete and typing checking on all columns/fields 🥳
147
+ - Remove `ChangesDeltaResult.rollback`
148
+ > It was never really used/implemented
149
+
150
+ ## 7.2.0
151
+ - Add the `preventCaching` option to `CollectionOptions`
152
+ > Prevents a CachedQueryItem from being cached (the CollectionResource will still be cached), you can use this when you fetch an Itemtype for which the backend doesn't send socket messages (so it never automatically updates)
153
+
154
+ ## 7.1.1
155
+ - Properly handle moved items in ServerCache.applyChangesFromParent (technically the backend won't ever generate a linkTo (only updates)) but it can happen when manually syncing the server cache (by doing `InternalChangesDelta.setItemMoved`)
156
+
157
+ ## 7.1.0
158
+ - Automatically keep aggregated values up-to-date by always refetching them
159
+
160
+ ## 7.0.15
161
+ - Remove an accidentally left in place debugger
162
+
163
+ ## 7.0.14
164
+ - Take into account collections with a 'limit' (of which the query result isn't cached) when matching socket items
165
+
166
+ ## 7.0.13
167
+ - Only overwrite the displayname if the required columns are present, instead of defaulting to an empty string
168
+
169
+ ## 7.0.12
170
+ - Fixed a bug where the core would try to update the cache key (ID) of `fieldChangeCallbacks` even when there were no callbacks for the given itemType
171
+
172
+ ## 7.0.11
173
+ - Fixed a bug where date values would not be compared if the descriptor was uncalled, this could lead to problems when applying changes from a parent transaction
174
+
175
+ ## 7.0.10
176
+ - Update references to local IDs in other items when a local ID gets updated
177
+
178
+ ## 7.0.9
179
+ - Take over `tabRequestParameters` when saving TransactionCache -> TransactionCache
180
+
181
+ ## 7.0.8
182
+ - Fixed a race condition and loop iteration error which in very rare cases caused itemEntries to be `undefined` and erroring
183
+ - Add missing error handling in transaction functions
184
+
185
+ ## 7.0.7
186
+ - Properly handle `reverse` linkedTo's in QueryColumnExtractor and QueryLocallyMatchableParser
187
+ - Implement refreshing of cached queries/collections
188
+
189
+ ## 7.0.6
190
+ Move fetching of lock from `TransactionItemHandler.processItemEntryChanges` to `TransactionCache.appyChangesDelta` to also capture creates and deletes.
191
+
192
+ ## 7.0.5
193
+ - Remove automatic fetching of derived values for not-yet-created items
194
+
195
+ ## 7.0.4
196
+ - Automatically resolve derived values when a new item is created
197
+ - Fixed a bug where `AbstractCache.getParentFromFields` would still return `null` incorrectly
198
+
199
+ ## 7.0.3
200
+ - Fixed a bug where `AbstractCache.getParentFromFields` would still return `undefined` parent values
201
+
202
+ ## 7.0.2
203
+ - Check if any of the parent fields (`itemtype`, `item`) is `null`, in which case it won't be treated as a valid parent in `AbstractCache.getParentFromFields`
204
+
205
+ ## 7.0.1
206
+ - Ignore columns in ApiFormatter::hasChanges if the `modified` object does not contain a value for it.
207
+
208
+ ## 7.0.0
209
+ - **Breaking**: Remove `enableChangesWatcher` and `disableChangesWatcher` in `TransactionCache`.
210
+ - Fetch lock token in `TransactionItemHandler.processItemEntryChanges`.
211
+
212
+ ## 6.3.10
213
+ - Only call `onRemove` of a collection if there are actually any items removed
214
+ - Expand cached columns anyways if there are no items to expand in `TransactionCachedQueryHandler.__expandCachedQuery`
215
+
216
+ ## 6.3.9
217
+ - Fixed a bug where deleted local items would still appear as unsaved changes
218
+
219
+ ## 6.3.8
220
+ - Always fetch 'id' and 'permissions' columns so that they are always available
221
+
222
+ ## 6.3.7
223
+ - Fixed a bug where items in a socket message that _might_ fit (`MAYBE`) in a collection would not be checked/added.
224
+
225
+ ## 6.3.6
226
+ - Fixed a bug where `AbstractCache.fetchUpdatedDerivedValuesFromDelta` would attempt to use ItemChanges not cached on the transaction
227
+ resulting in an error
228
+
229
+ ## 6.3.5
230
+ - Fixed a bug where after creating items derived values would needlessly be refetched
231
+ > The core now properly detect that even though an ItemId is updated (after a create) it's still the same item so no request has to be done
232
+ - Fixed a bug where ItemEntry's would not be re-cached under their new ItemIds
233
+
234
+ ## 6.3.4
235
+ - Fixed a bug where already cached itemEntries would not properly be detected when calling `ServerCache.processResponse`
236
+ - Fixed a bug where calling `CreatedChangesDelta.remove` would add `empty` values in the array instead of removing the entry
237
+
238
+ ## 6.3.3
239
+ - Fixed a bug where local ItemEntries were not properly updated after saving
240
+
241
+ ## 6.3.2
242
+ - Fixed updating item entry itemId field after processing changes
243
+
244
+ ## 6.3.1
245
+
246
+ - Fixed a bug where query with a local ID would do a request to the server
247
+ ```
248
+ // This example should now no longer do a request
249
+ transaction.getItemsByQuery(
250
+ 'Tijd',
251
+ {
252
+ project: -11,
253
+ }
254
+ );
255
+ ```
256
+
257
+ ## 6.3.0
258
+ - Allow strict typing of `FieldMap`
259
+
260
+ ## 6.2.5
261
+ - Remove overwriting itemType with itemType of rootItem during create
262
+
263
+ ## 6.2.4
264
+ - Fixed a bug where items would not appear in a collection after changes propagated from a parent transaction
265
+
266
+ ## 6.2.3
267
+ - Fixed a bug where `previous` would actually contain new values because the `previous` object was made after the values were already synced
268
+
269
+ ## 6.2.2
270
+ - Fixed a bug in syncing of initial values after saving an item causing the item to still be marked having changes
271
+
272
+ ## 6.2.1
273
+ - Fixed a bug where `ItemEntry`s created on the `ServerCache` where not matched on child `TransactionCache`s
274
+
275
+ ## 6.2.0
276
+ - Fixed a bug where synchronous validators would leave the validator in `pending` state
277
+ - Only re-match items when values are actually changed
278
+ - Removed `defered` from `CachedQueryItem` and added `resolve` and `reject`
279
+ - Check if ItemEntries are already created before creating new ones, if that is the case treat it like an update
280
+ > What could happen was that a faster request created an ItemEntry for the same item as another request
281
+ > which caused the double creation of an ItemEntry
282
+
283
+ ## 6.1.3
284
+ - Add `isPending` function to `TransactionValidator`
285
+ - `TransactionCache`s will now be invalid until all pending transaction validators are done
286
+
287
+ ## 6.1.2
288
+ - Check if an error key exists before deleting it in `TransactionCache.clearItemError`
289
+
290
+ ## 6.1.1
291
+ - Correctly pass `ErrorHandlerInterface` to `ChangesDeltaFactory`.
292
+
293
+ ## 6.1.0
294
+ - Return `ChangesDelta` instance in `setItemUpdated`, `setItemDeleted`, `setItemsDeleted` methods, and a promise that resolves to the instance in `setItemCreated` and `setItemsCreated`.
295
+
296
+ ## 6.0.2
297
+ - Update `query` parameter of `getByQuery`, `getLocalByQuery`, `batchGetLocalByParent`, and `matchQuery` in `ItemCache`.
298
+
299
+ ## 6.0.1
300
+ - Fixed a bug where a local item wouldn't be found when using `TransactionCache.getItemByState` on a child transaction
301
+
302
+ ## 6.0.0
303
+ - Refactored query caching structure
304
+ - Properly implemented `limit` in collections
305
+ - Removed extending of collections
306
+
307
+ ## 5.0.1
308
+ - Add 'icon' column type to non-selectable column types
309
+
310
+ ## 5.0.0
311
+ - Fixed a bug where created, creator and permissions was always set to default values
312
+ - **Breaking:** Remove `onItemsCreated` collection callback.
313
+
314
+ ## 4.0.4
315
+ - Fixed a bug where ModuleChangesCompilation wouldn't include all changes
316
+
317
+ ## 4.0.3
318
+ - Local collections are now correctly identified when using a local ID in a linkTo request instead of the `parent` option
319
+ - Fix issue where local collection entries were not moved to server cache after save.
320
+
321
+ ## 4.0.2
322
+ - Fixed a bug where clearing collections would error after saving a transaction
323
+
324
+ ## 4.0.1
325
+ - Remove thrown error in `ItemResource.callOnChange`
326
+ > The frontend still relied on this and we won't refactor that at this point
327
+
328
+ ## 4.0.0
329
+ - Removed `ItemResourceOptions.onChange`, this is replaced by `TransactionCache.registerFieldChangeCallback`
330
+ > Because the `onChange` is no longer stored on the ItemResource, the ItemResource doesn't have to be cached.
331
+ > This way you don't have to call `ItemResource.clearResource` anymore (you do need to deregister the fieldChange callbacks)
332
+
333
+ ## 3.1.0
334
+ - **Breaking:** Remove `fields` property, add `getFields` method in `Template` class.
335
+ - **Breaking:** Add `ConversionMapService`. Update `updateItemValues` to take a `source` and `destination` parameter.
336
+ - Update `entry.itemId` for items created items in `TransactionCache.getDelta`.
337
+ > This fixes an issue with updating IDs of local items.
338
+ - Add dependency interfaces for `AbstractCache`, `ServerCache`, `TransactionCache`, `TransactionCollectionHandler`, `TransactionItemHandler`.
339
+ - Add `CreatedChangesDelta` class, which replaces the `created` component of the `ChangesDelta` and includes some query methods. Add `isEmpty` method to `ChangesDelta`.
340
+
341
+ ## 3.0.1
342
+ - Fixed a bug where the `StateKeyType` enum couldn't be used when imported
343
+
344
+ ## 3.0.0
345
+ - Remove ViewResource, EditResource, CollectionViewResource and CollectionEditResource
346
+ > There was no real distinction between them anymore since the core 2.0 update.
347
+ > You can now use the base ItemResource and CollectionResource types instead
348
+
349
+ ## 2.4.0
350
+ - Update Typescript version to `3.7.2`, also update other plugins
351
+
352
+ ## 2.3.0
353
+ - Add callbacks when errors are set/cleared to `TransactionEventHandler`
354
+ - Added the possibility to differentiate between errors to display below a field and on the save button in `TransactionValidator`
355
+ - Changed the format of the error translations from `string` to `() => string` in `TransactionValidator`
356
+ > Now the translation function will only be called when the error is actually set, not when it's cleared
357
+
358
+ ## 2.2.1
359
+ - Fixed a bug where resolving derived values for new items (in `TransactionCache.applyChangesDelta`) would sometimes error
360
+
361
+ ## 2.2.0
362
+ - `ChangesDelta.setItem(s)Created` will now accept incomplete input values
363
+ > It will now fetch a template for you and process the items, so you no longer need to do that yourself
364
+
365
+ ## 2.1.2
366
+ - Fixed a bug where deleted ItemEntries weren't picked up when detecting transaction changes
367
+
368
+ ## 2.1.1
369
+ - Fixed a bug where an ItemEntry's errors wouldn't be deleted when the ItemEntry was deleted on a transaction
370
+
371
+ ## 2.1.0
372
+ - Refactor `TransactionCache.getItemsByQuery` to check cached entries (just like a collection)
373
+ - Add `TransactionValidator`, allow passing of a `TransactionValidatorFactory` to a transaction
374
+ > You can use these validators to set errors using `setItemError` and `setGlobalError`
375
+ - Fixed a bug where `TransactionItemHandler.cloneItemEntry` could only clone entry with changes on the target transaction.
376
+ > It will not look for changes recursively on the transaction change
377
+
378
+ ## 2.0.19
379
+ - Ensure all requestColumns for newly created ItemEntries from a template are available
380
+ - Ensure derived values for newly created ItemEntries from a template are available
381
+
382
+ ## 2.0.18
383
+ - Include read-only columns when detecting changes in TransactionItemHandler.processItemEntryChanges
384
+ > Read-only columns shouldn't count as changes on the tab, but they should be taking into account when deciding whether or not to call `onChange`
385
+
386
+ ## 2.0.17
387
+ - Fixed a bug where deleting an item that isn't in the transaction's item entry cache would result in an error
388
+ - Fixed a bug where response columns weren't set for newly created local CollectionEntries
389
+ - Fixed a bug where items weren't matched for newly created local CollectionEntries
390
+
391
+ ## 2.0.16
392
+ - Fixed a bug where queries with a link to a local parent item weren't updated on save
393
+
394
+ ## 2.0.15
395
+ - Cache ItemEntries that fit collections on the CollectionEntry's query instead of the CollectionEntry's id
396
+ - Add a 'hint' to ChangesDeltas which allows skipping the extra request to validate `maybe` query matches
397
+ - Create transaction changes for ItemEntry updates in the changesDelta if non exist yet when calling `TransactionCache.applyChangesDelta`
398
+ > This allows you to update values on a transaction without having to fetch a resource for it by calling
399
+ > `ChangesDelta.setItemUpdated()`
400
+
401
+ ## 2.0.14
402
+ - Fixed reading of derived values in `getItemIdByColumn` when a ChangesDelta is passed
403
+
404
+ ## 2.0.13
405
+ - Fixed a bug where the incorrect fields where applied to the ChangesDelta in `TransactionItemHandler.cloneItemEntry`
406
+ - A RequestBuffer's promise will now resolve after the ServerCache.processResponse promise is done, ensuring all values are present before continuing
407
+ - Request columns for the request ItemType will now properly be taken into account in ServerCache.processResponse ensuring root columns are always properly set. (This is used to update derived values)
408
+
409
+ ## 2.0.12
410
+ - Fixed a bug where created changes weren't copied to the itemchanges
411
+ - Only take readonly parent columns instead of all readonly columns in `ApiFormatter.hasChanges`
412
+ - Fixed a bug where ItemEntry's where still in `ItemCache.entriesByEntryId` after clearing them
413
+
414
+ ## 2.0.11
415
+ - Fixed a bug where changes weren't copied to the itemchanges
416
+ - Fixed correct isCalledAfterApiSave values on calls to ServerCache.processResponse
417
+
418
+ ## 2.0.10
419
+ - Construct `ColumnSet` with proper `requestColumns` when creating a `Template` with additional columns
420
+
421
+ ## 2.0.9
422
+ - Properly process linked items from the template request in `TransactionItemHandler.createItems`
423
+
424
+ ## 2.0.8
425
+ - Fixed a bug where not all fields where available even tough an ItemResource with specific columns was created
426
+
427
+ ## 2.0.7
428
+ - Define abstract copyTransactionItemEntryChanges on ItemHandlerBase
429
+ - Implement copyTransactionItemEntryChanges on TransactionItemHandler and ServerItemHandler
430
+ - Fix AbstractCache/ServerCache/TransactionCache `getParent` function arguments
431
+ > With the newly added arguments the function definitions didn't align anymore causing typescript errors
432
+ > Even though the arguments aren't used in the `ServerCache` they're added in there
433
+
434
+ ## 2.0.6
435
+ - Remove `ApiFormatter.lazyClone`
436
+ > You can't lazily clone moment objects because the moment you wanted to clone could be changed in the time the getter isn't invoked, resulting in a different value
437
+
438
+ - Create a copy of the child transaction's field instead of copying the object reference in `TransactionCache.applyChangeFromChild` and `ChangesProcessor.executeCreateRequest`
439
+ > When writing to the object references you're changing multiple transactions at once, while this should be handled by applyCHangesFromParent
440
+
441
+ ## 2.0.5
442
+ - Add `callOnAddWithInitialItems` option to `CollectionResourceOptions`
443
+ > If `true` the `onAdd` callback will be called with the initial set of items
444
+
445
+
446
+ ## 2.0.4
447
+ - Add `isCalledAfterSocketUpdate` to `onAdd`, `onRemove` and `onChange` callbacks
448
+ > You can use this if a data change should only trigger an action when the user caused it himself
449
+
450
+ ## 2.0.3
451
+ - Fix `CollectionEditResource.removeItems`
452
+ - Move `getCurrentCollectionEntryCache` and `getCurrentItemEntryCache` from `TransactionCache` to `AbstractCache`
453
+
454
+ ## 2.0.2
455
+ - Fix marking entries as deleted and compiling this into a request
456
+
457
+ ## 2.0.1
458
+ - Expand CollectionEntry's columns in `ServerCollectionHandler.fetchCollectionData`
459
+
460
+ ## 2.0.0 - Major caching refactor
461
+ - Completely reworked internal caching structure, see [this Confluence page](https://rentman.atlassian.net/wiki/spaces/DEV/pages/704872456/) for the motivations behind it.
462
+
463
+
464
+ ## 1.9.0
465
+ - Don't create ItemResources when not returning links in `ItemAdministrator.getNewResourceWithId` and in `ItemAdministrator.constructOnItemsExpanded`
466
+
467
+ ## 1.8.0
468
+ - Remove `ResourceCache` and `resourceLevel`
469
+ > You should now manually call `resource.clearResource` when you no longer need a resource
470
+ - Add `onConstruct` function to `ItemResource` and `CollectionResource`
471
+ > This is overwritten by the frontend to track resource creation
472
+
473
+ ## 1.7.6
474
+ - Add priority parameter to local cache callbacks. The callback condition (`always` / `onClose` / `skipOnClose`) no longer has any effect on the order in which the callbacks get executed.
475
+ - **Breaking:** Remove `LocalCacheCallbackCondition` enum.
476
+ - Add `itemId` parameter to `ItemHandler.fetchNewItem`. An error is thrown when an ID already exists. Add `getNewResourceWithId` to ItemAdministrator. Deprecate `getItemByState`.
477
+
478
+ ## 1.7.5
479
+ - For template column sets it is no longer assumed all columns are present. This fixes an issue with incomplete column
480
+ sets in the front-end.
481
+ - Fix issue where `changesProcessor` instance was undefined in `itemResourceFactory` and `collectionResourceFactory`.
482
+ Create variables for each core service in order to get a TypeScript error when a dependency hasn't been initialized yet.
483
+
484
+ ## 1.7.4
485
+ - Add support for strict ItemType type checking in `FieldMap`
486
+
487
+ ## 1.7.3
488
+ - Add support for strict ItemType type checking
489
+ > This is temporarily defaulted to `any` to prevent compile errors in the frontend
490
+
491
+ ## 1.7.2
492
+ - Fix some typing issues in:
493
+ - ApiResponseProcessor
494
+ - ItemCache
495
+ - KeyService
496
+
497
+ ## 1.7.1
498
+ - Fix issue where `CreateRequestFactory` would be undefined in `ChangesProcessor`.
499
+
500
+ ## 1.7.0
501
+ - **Breaking:** remove `ChangesProcessorFactory`. Add `ChangesProcessor` instance to core directly.
502
+
503
+ ### Resource caching
504
+ - **Breaking:** the following properties are removed:
505
+ - On `ItemEntry`: `clearResources`, `deactivateResources`.
506
+ - On `CollectionEntry`: `clearResources`, `getCurrentResource`.
507
+ - On `CollectionResourceOptions`: `clearOnTabChange`, `clearOnSubTabChange`.
508
+ - An additional `level` parameter has been added to all methods that return resources.
509
+ - When creating resources using `ItemResourceFactory` or `CollectionResourceFactory`, this parameter is mandatory.
510
+ A `defaultResourceLevel` parameter has been added to the `LocalCache` constructor.
511
+ - A `clearResources` method has been added to `ItemAdministrator`. When calling this method, all item / collection
512
+ and collection resources with a level of `level` or higher will be removed.
513
+ - The `clearResources` method has been removed from `LocalCache`.
514
+ - The `setCurrentLocalCache` function has been removed from `LocalCacheManagerInterface`.
515
+
516
+ ## 1.6.13
517
+ - When encountering a collection entry with `PROMISED_EXPAND` status, call `getCachedEntryStatus` after the initial
518
+ promise has been resolved.
519
+
520
+ > This is the likely cause of the issue where `_resolve` is called on a non-deferred collection entry.
521
+
522
+ ## 1.6.12
523
+ - Fix error that occurs when trying to resolve a non-deferred collection entry.
524
+
525
+ ## 1.6.11
526
+ - Fix issue where `QueryMatcher.matchComplexQuery` would return the wrong value.
527
+
528
+ ## 1.6.10
529
+ - **Breaking**: Remove `linkType`, `linkIdArray` properties from `LinkCollectionDefinition`. Add `linkType`,
530
+ `linkIdArray` parameters to `ItemAdministrator.getLinkCollectionsFromDef`.
531
+
532
+ ## 1.6.9
533
+ - Redeploy of `1.6.8`
534
+
535
+ ## 1.6.8
536
+ - Add support for `not` in queries
537
+
538
+ ## 1.6.7
539
+ - Fix issue where `CollectionMatcher.addToCollections` wouldn't return the correct type.
540
+
541
+ ## 1.6.6
542
+ - Add `callOnAdd` parameter in `CollectionHandler.batchExtend`. Set `updateInitial` to true. Remove `updateInitial` parameter in `CollectionEntry.extend`, as it should always be true.
543
+ > The `extend` function only concerns itself with remote items, so no local changes should be generated.
544
+
545
+ ## 1.6.5
546
+ - Fix issue where a derived column could be marked as the `link` (parent) column in the column set.
547
+ > This could lead to instances where a different column would be set to the value of the parent.
548
+
549
+ ## 1.6.4
550
+ - Fix issue where the `onChange` collection callback would not be called when updating it in the options.
551
+ - Add `callOnAdd` parameter to collection matcher. When set to `false`, `onAdd` is not called for the `resultCollectionResource`.
552
+
553
+ ## 1.6.3
554
+ - Properly type ApiResponseProcessor - fetchObjectArray
555
+
556
+ ## 1.6.2
557
+ - Fix issue where the collection handler would return collection entries before they were resolved when calling `batchFetch`.
558
+
559
+ ## 1.6.1-3
560
+ - Check for linkedTo before checking for subqueries in QueryMatcher
561
+ > Linkedto also has `.query` and was incorrectly marked as a subquery
562
+
563
+ ## 1.6.1-2
564
+ - Fixed shorthand query with null values
565
+ > The QueryParser would incorrectly identify subqueries when using null in a shorthand
566
+
567
+ ## 1.6.1-1
568
+ - Fixed shorthand query with Moment values
569
+ > The QueryParser would incorrectly identify Moment objects as a subquery
570
+
571
+ ## 1.6.1
572
+ - Added support for subqueries in QueryParser and QueryMatcher
573
+ > Collections using subqueries will always return 'maybe' in the QueryMatcher
574
+
575
+ ## 1.6.0
576
+ - All external callbacks are now wrapped in a `try ... catch` block. This prevents them from breaking core functionality.
577
+ - **Breaking**: Add `ExceptionHandlerInterface` parameter to core constructor.
578
+
579
+ ## 1.5.9
580
+ - Fix issue that occurs when trying to resolve a `ColumnSet` using a single non-existing column.
581
+ Catch exceptions that might occur when resolving an `ItemEntry`.
582
+ - Add `mergeRequestColumns`, `mergeResponseColumns` to `ColumnSet`. When encountering new items while expanding a collection, add them to the collection.
583
+
584
+ ## 1.5.8
585
+ - Introduce `RemoteViewResource` and `LocalViewResource`.
586
+ > The `fields` property of a `RemoteViewResource` represents
587
+ server values, while the `fields` property of a `LocalViewResource` represents local values.
588
+ - The `fields` property of a `ViewResource` is now read only.
589
+
590
+ ## 1.5.7-1
591
+ - Make ItemResource/CollectionResource base class abstract
592
+ - Add missing overload functions in some places
593
+ - Fix default comparator `QueryMatcher.parseSimpleQuery`
594
+ - Fix `ExtendedCollectionMatchResult` `collection` property type
595
+
596
+ ## 1.5.7
597
+ - Properly type Collections & ItemResources (and return values) in the whole core.
598
+ > The core will now properly return Collections & ItemResources based on the passed CollectionOptions.
599
+ > You can now also type the expected collection type
600
+
601
+ ```
602
+ // Expects a collection with editCollection and editItems both `true`
603
+ // Will properly return EditResources for all collection functions
604
+ const collection: CollectionEditResource<EditResource>;
605
+
606
+ // other variations are:
607
+ // CollectionViewResource<ViewResource>
608
+ // CollectionViewResource<EditResource>
609
+ // CollectionEditResource<ViewResource>
610
+
611
+ this.core.itemAdministrator.getCollection(
612
+ 'Notitie',
613
+ {
614
+ editCollection: true, // Will return a CollectionEditResource
615
+ editItems: true // Will return EditResources instead of ViewResources in `.items`
616
+ }
617
+ )
618
+ ```
619
+
620
+ ## 1.5.6
621
+ - Add `getAllLocalCaches` to `LocalCacheManagerInterface`, remove item entries from all local caches on socket delete.
622
+
623
+ ## 1.5.5
624
+ - Add 'order' column type handling to ApiFormatter functions
625
+
626
+ ## 1.5.4
627
+ - Fix issue where parent would be incorrectly set when cloning a single item.
628
+ - Type functions related to expansion maps in `ItemEntryService`.
629
+
630
+ ## 1.5.3
631
+ - Fix issue where the `enableSave` collection resource option would default to `false`. This would throw an error when
632
+ calling `save` on a collection resource where this option was not explicitly set.
633
+
634
+ ## 1.5.2
635
+ - Type functions in `ColumnUtil` class.
636
+ - Add `getRequestColumnId` and `containsDerivedColumns` to `ColumnUtil`.
637
+ > `getRequestColumnId` should be used instead of `Util.getFirstProperty` when retrieving a column ID.
638
+ - **Breaking:** Remove `ColumnUtil.isColumnSubset`. Use `ColumnSet.isSuperSetOf` instead.
639
+ - Remove `findColumnObject`. Rename `findColumn` to `findRequestColumn`.
640
+
641
+ ## 1.5.1
642
+ - Properly remove item entry stub from (local) cache when request fails.
643
+ - Fix issue where item or collection options could be set to undefined.
644
+
645
+ ## 1.5.0
646
+ - Add `SocketMessage` type and add types to `SocketMessageHandler`
647
+ - Expand local items requested using `getItemById` or `getItemsById` in `ItemAdministrator`.
648
+ (`fetchItem` or `fetchItems` in `ItemHandler`.)
649
+ - Implement expanding of local collections. This no longer leads to invalid requests.
650
+ - **Breaking:** The `expand` function in `CollectionEntry` now has an `ItemCache` parameter.
651
+ - **Warning:** This version contains major changes.
652
+
653
+ ### Introduce typing of item and collection options
654
+ - **Breaking:** Removed `QueryItemType` collection entry option.
655
+ - **Breaking:** Removed `ItemResourceService`.
656
+ - Removed `processOptions` parameter from `createCollectionResource` (`ItemAdministrator`). It is now equivalent to
657
+ `addCollection`.
658
+ - When creating an item resource using `ItemResourceFactory`, a collection entry using `CollectionResourceFactory` or a
659
+ collection resource using `CollectionResourceFactory` it is no longer necessary to process options beforehand. It is
660
+ still necessary when interacting with `CollectionHandler` or `ItemHandler` directly.
661
+
662
+ ## v1.4.0
663
+ - Add `expandProcessLinkedItems` and `expandAddToCollections` to `ItemAdministrator`. These are analogues to
664
+ `processLinkedItems` and `addToCollections`, but also expand the items with (derived) values and columns as necessary.
665
+ They have a slightly different type signature.
666
+ - Whenever a collection is requested, the `CollectionHandler` now makes sure that added local items are expanded as
667
+ necessary.
668
+ - **Breaking:** Last parameter of `ItemHandler.createLocalEntries` is now a callback function.
669
+ - **Breaking:** Rename `TemplateLinkedItemEntryMap` type to `TemplateItemEntryMap`.
670
+
671
+ ## v1.3.8
672
+ - Add `isSaving` to `LocalCache`
673
+ > We use this to disable the cancel/save buttons while the localCache is saving in the frontend
674
+
675
+ ## v1.3.7
676
+ - Fix issues that generate invalid requests / changes when moving existing item to another collection, then deleting the parent.
677
+ - Remove slip workarounds
678
+ - Add api request types
679
+ - Add types to `ModuleChangesCompilation`
680
+
681
+ ## v1.3.6
682
+ - Skip add / remove collection callbacks when calling `revertChanges` (`LocalCache`).
683
+
684
+ ## v1.3.5
685
+ - Fix issue where items added to collections when resolving wouldn't be removed in `revertChanges` (`LocalCache`).
686
+
687
+ ## v1.3.4
688
+ - Add country to isFilteredColumn in ColumnUtil
689
+
690
+ ## v1.3.3
691
+ - Move processLocalConfigColumns and consolidateColumns from ColumnUtil to frontend
692
+ > These functions are specifically used for rendering ui-grid in the frontend, so there's
693
+ no reason to have them in the core
694
+
695
+ ## v1.3.2
696
+ - Fix types path in package.json
697
+
698
+ ## v1.3.1
699
+ - Fix types path in package.json
700
+
701
+ ## v1.3.0
702
+ - Rename PromiseInterface to PromiseLibraryInterface
703
+ > PromiseInterface is now used for the internal promise type
704
+
705
+ - Use PromiseInterface instead of Promise as internal promise type
706
+ > This allows us to overwrite the PromiseInterface definition in the frontend indicate usage of ng.IPromise
707
+
708
+ ## v1.2.9
709
+ - Call processOptions in fetchDerivedValuesByColumn
710
+ > Bug was introduced earlier but got enabled in v1.2.7
711
+
712
+ ## v1.2.8
713
+ - Add toJSON methods for ItemResources, ItemEntries, and ColumnSets to fix circular dependencies in JSON.stringify
714
+
715
+ ## v1.2.7
716
+ - Set itemEntry parent when generating a stub
717
+
718
+ ## v1.2.6
719
+ - Fix an issue introduced in v1.2.5.
720
+
721
+ ## v1.2.5
722
+ - When a local item cannot by found, return a newly created item in `getItemByState` (`ItemAdministrator`) only. This
723
+ solves an issue with refreshing on a local edit view.
724
+
725
+ ## v1.2.4
726
+ - **Breaking:** When a local item cannot by found, instead of a new item being created an error is thrown. This means it
727
+ is no longer possible to create local items using `getItemById` or `getItemsById` in the `ItemAdministrator` class.
728
+ - **Breaking:** Removed `getItemDefinition` and `getItemByDef` in the `ItemAdministrator` class. Added `getItemByState`.
729
+ - Renamed types `TemplateResponseItemEntryMap` to `TemplateItemEntryMap` and `TemplateResponseLinkedItemEntryMap` to
730
+ `TemplateLinkedItemEntryMap`.
731
+ - Removed `getCollectionCacheKey` in `KeyService`. (Legacy code.)
732
+
733
+ ## v1.2.3
734
+ - Fixed issue where derived values deeper than one layer couldn't be resolved.
735
+
736
+ ## v1.2.2
737
+ - Fixed issue where in derived values weren't set after create request.
738
+
739
+ ## v1.2.1
740
+ - **Breaking:** Replaced the `initial` parameter with the `callOnChange` parameter (`true` by default) in the `commit`
741
+ function of the `EditResource` class.
742
+ - Fixed issue in `setLocalFields` (`ItemEntry`) where some values were wrongly assumed to be present in `initialValues`.
743
+ - Optimization: Disabled automatic resolution of derived values in `addItems` (`CollectionEditResource`) when `modInstant` is set to true.
744
+
745
+ ## v1.2.0
746
+ - **Breaking:** When calling `addItems` or `addItem` on the `CollectionEditResource` class derived values are now
747
+ resolved automatically. Instead of a compound object like `{fields: {key: 'value'}, derived: {}}` an object like
748
+ `{key: 'value'}` should now be used as argument when calling these functions.
749
+ - **Breaking:** Added `localCache` parameter to `CollectionResource` constructor.
750
+
751
+ ## v1.1.20
752
+ - Fixed minor issue where collection wouldn't be deferred properly before expanding.
753
+ - `onChange` is now called automatically when when calling `commit` on an edit resource.
754
+
755
+ ## v1.1.19
756
+ - **Breaking:** Renamed `getCurrentChanges` to `getModuleChanges` in the `ItemAdministrator` class. Added optional
757
+ `localCache` parameter.
758
+
759
+ ### Local cache callback refactoring
760
+ - Removed `onSaveWithoutClosing` event.
761
+ - Added `condition` parameter to `onBeforeSave` and `onSaveSuccess` (possible values are `always`, `onClose` or
762
+ `skipOnClose`, defaults to `always`). Callbacks registered with `condition: always` will get executed before other
763
+ callbacks.
764
+ - Pass the local cache itself to all registered callback functions. Pass the item ID conversion map as second argument
765
+ to `onSaveSuccess` callback functions.
766
+
767
+ ## v1.1.18
768
+ - Calling `expand` on a `CollectionEntry` manually no longer defers the collection entry.
769
+ - The `batchFetch` and `batchExpand` functions in the `CollectionHandler` class now properly defer and resolve the
770
+ collection entries.
771
+
772
+ ## v1.1.17
773
+ - Fixed issue where the `getLocalByQuery` function in the `ItemCache` class wouldn't return any items.
774
+ - When batch resolving collection entries, `CollectionHandler` now looks for matching items using `getByQuery` instead
775
+ of `getByParent`.
776
+
777
+ ### Cache invalidation
778
+ - Added `queueReload` function to `ItemEntry` class. This will reload the item when the item entry itself or a
779
+ collection entry containing the item is requested.
780
+ - The `queueReload` function in the `CollectionEntry` class no longer directly defers the item.
781
+ - Added `invalidateCache` function to the `ItemAdministrator` class. This will call `queueReload` on all item entries
782
+ and collection entries.
783
+
784
+ ### Item entry refactoring
785
+ - Renamed `process` to `setFields`.
786
+ - Replaced `processLocal` with `setLocalFields`. This function no longer has a `modified` parameter.
787
+ - `setModified` now also sets local default values.
788
+ - Removed `setCreator`. This function was called twice in some instances.
789
+ - **Breaking:** Added `derived` parameter to `updateFields`
790
+
791
+ ##v1.16
792
+ - Pass `hasChanges` as second argument to `onBeforeSave` callbacks in the `LocalCache` class. This fixes an issue with
793
+ project financial values in the front-end. [RM4-9577]
794
+ - Added `callOnActivate` parameter to `addItems` function in `CollectionEditResource` class. Use this to prevent items
795
+ from being added to the local cache.
796
+
797
+ ##v1.15
798
+ - Fix `fetchItemTypesTranslations` function in `ColumnHandler` class.
799
+ - Fix type definition of `PromiseInterface.all`.
800
+
801
+ ##v1.14
802
+ - The `ChangesCompiler` now always processes local collections. (Even if they don't have edit resources.) This fixes an
803
+ issue with recurring appointments in the front-end.
804
+
805
+ ##v1.13
806
+ - Add option to exclude itemTypes during createLocalEntries.
807
+
808
+ ##v1.12
809
+ - **Breaking:** `ItemResource.isNew` returns true *only* if the resource was created using
810
+ `ItemAdministrator.getNewResource` or `ItemAdministrator.getItemByDef`. This fixes an issue where items where removed
811
+ from the local cache inadvertently.
812
+ - The `start`, `commit` and `rollback` functions of `EditResource` now return the resource itself to facilitate chaining.
813
+ - When calling `CollectionEntry.revertChanges`, callbacks like `onAdd` / `onRemove` and `onActivate` / `onDeactivate`
814
+ are now respected. This fixes an issue where items where *not* removed from the local cache.
815
+ - When removing *local* items from collections, they are removed from `initial` as well as `modified`. This fixes an
816
+ issue where changes were being detected continuously.
817
+ - Updated the order of requests in `changesProcessor`. The `update` request is now executed before the `delete` request,
818
+ except when updating documents. This fixes several issues.
819
+ - `CollectionCache` now uses a map instead of an array to store collections. This fixes an issue where the same
820
+ collection was added multiple times.
821
+ - Updated all models to use dependency objects. This increases ease of debugging.
822
+
823
+ ##v.1.11
824
+ - Fixed issue that occurs when saving when having an existing item refer to a newly created item.
825
+ - **Breaking:** Removed `ItemResourceService.isNewResource`.
826
+ - **Breaking:** Renamed `ItemResource.isNewResource` to `ItemResource.isNew`. Removed parameter.
827
+ - `ItemResource.isNew` is equivalent to `ItemResource.isLocal`, while `EditResource.isNew` checks also checks for
828
+ completed transactions.
829
+
830
+ ##v.1.10
831
+ - Fixed issue where changes on different subtabs were not detected.
832
+
833
+ ##v1.1.9
834
+ - Exposed `noop` function on `RmCore` class.
835
+ > This is used in order to check whether a callback has a default value.
836
+ - Added `copyRequestColumns` function to `ColumnUtil` class.
837
+ - Made parameters of `ItemAdministrator.saveCurrentLocalCache` and `LocalCache.save` optional.
838
+ - **Breaking:** Reordered parameters of `ChangesProcessor.execute` to be consistent with
839
+ `ItemAdministrator.saveCurrentLocalCache`. The new order is `singleItems` - `collections` - `parameters` -
840
+ `breakUpByParent` - `onAfterCreateCallback`.
841
+
842
+ ##v1.1.8
843
+ - Set default value for `params` to `{filter: false}` in `request` function in `ColumnHandler` class.
844
+
845
+ ##v1.1.7
846
+ - Fixed issue where cached item entries or collection entries wouldn't be added to the local cache.
847
+
848
+ ##v1.1.6
849
+ - Fixed issue with deferred item entries.
850
+ - Re-enable changes watcher after save.
851
+ - Added optional `id` parameter to `LocalCache` constructor.
852
+
853
+ ##v1.1.5
854
+ - Added `clearItem` function to `LocalCache` class.
855
+
856
+ ##v.1.1.4
857
+ - Fix issue where items where not added to the local cache automatically when they where added to a collection.
858
+ > This depends on the `callOnActivate` parameter. I've added this mainly because extending collections should *not* add
859
+ the items to the local cache.
860
+ > In other instances this might be debatable because it doesn't do any real harm. *Not*
861
+ doing it however can definitely be harmful.
862
+
863
+ ##v.1.1.3
864
+ - Fixed an issue where all collections in a local cache would be cleared.
865
+ - **Breaking:** Renamed `getCacheManager` to `getCurrentLocalCache` and `setCacheManager` to `setCurrentLocalCache` in
866
+ `LocalCacheManagerInterface`.
867
+
868
+ ##v1.1.2
869
+ - Fixed an issue concerning derived values.
870
+
871
+ ## v1.1.1
872
+ - Fixed an issue where changes wouldn't be detected.
873
+ - **Breaking:** Removed the `_hasChanges` function in the `localCache` class. If you want to force changes detection,
874
+ call `detectChanges` instead. Otherwise, rely on the `hasChanges` variable.
875
+ - **Breaking:** Removed the `enableWatcher` and `disableWatcher` functions. Use `enableChangesWatcher` and
876
+ `disableChangesWatcher` instead.
877
+
878
+ ## v1.1.0
879
+ ### Development
880
+
881
+ #### Strict TypeScript compilation
882
+ Added the following TypeScript compiler options:
883
+ - noImplicitThis
884
+ - noImplicitReturns
885
+ - strictNullChecks
886
+ - noUnusedLocals
887
+ - noUnusedParameters
888
+
889
+ I would advise enabling these for all TypeScript projects from now on.
890
+
891
+ #### Ordered imports and dependencies
892
+ Imports are now ordered alphabetically and grouped by folder. Added a TSLint option to enforce this.
893
+ Please note that this also applies for imports from the folder the file is currently in.
894
+ For example, in `models/ItemResource.ts`, `itemEntry` should be imported like so:
895
+ `import { ItemEntry } from '../models';`
896
+
897
+ Also, factory and class dependencies should be ordered alphabetically as well. This will make it easier to add and
898
+ remove dependencies in the future.
899
+
900
+ ### Breaking changes
901
+
902
+ - Renamed `changesCompiler` to `changesCompilation`, `changesCompilerFactory` to `changesCompilationFactory`,
903
+ `moduleChangesCompiler` to `moduleChangesCompilation` and `moduleChangesCompilerFactory` to
904
+ `moduleChangesCompilationFactory`.
905
+ - Removed the `allLinks` parameter from the `query` function definition in the `ApiRequestServiceInterface`. This is
906
+ no longer supported in the back-end.
907
+
908
+ #### Item and collection entries
909
+ - Moved *all* functions that handle item entries from the `ItemEntryService` to the `ItemEntry` class.
910
+ - Added the following functions to `ItemEntryService`:
911
+ - `createLocalConversionMap`;
912
+ - `expandLocalConversionMap`;
913
+ - `expandConversionMap`;
914
+ - `batchExpandConversionMap`;
915
+ - `batchClone`.
916
+ - Cloning of item entries now works slightly differently. The function will attempt to generate a new
917
+ item ID, and update the conversion map accordingly, but will respect the item ID that is already there.
918
+
919
+ #### Rework item caching
920
+ Newly created item entries and collection entries are no longer added to the global *or* local cache by default.
921
+ All entries are added to the global cache on save. Item entries are added to the local cache when resources are created
922
+ using the item administrator or when resources are created when adding the items to a collection.
923
+
924
+ > This will increase reliability by ensuring the global cache is no longer 'polluted' with local items. Also, this will
925
+ > allow for the creation item and collection entries without caching them directly. This is required for the copying and
926
+ > pasting of items.
927
+
928
+ Other changes:
929
+
930
+ - Moved `saveLocal` to `ItemAdministrator`;
931
+ - `ItemAdministrator.fetchTitle` should now be called instead of `ItemHandler.fetchTitle`;
932
+ - The `ItemAdministrator` collection matching functions (`addToCollections`, `removeFromCollections`) should now be
933
+ called instead of those in the `CollectionHandler`. The `CollectionHandler` should only be used to reflect changes
934
+ already on the backend. (Use `getCollectionMatcher`.)
935
+
936
+
937
+ ##v1.0.33
938
+ - Really fix types path
939
+
940
+ ##v1.0.33
941
+ - Fix types path
942
+
943
+ ##v1.0.32
944
+ - Update `tsconfig.json` to put definitions in the root folder
945
+ > The app had an issue with AOT compilation because of this
946
+
947
+ ##v1.0.31
948
+ - Fix `columnHandler.fetchItemTypeTranslations`
949
+ > It incorrectly looped over the response map, it should now work again
950
+
951
+ ##v1.0.30
952
+ - Remove `updateTabParams` from LocalCacheManagerInterface
953
+ > The function wasn't used
954
+
955
+ - Reworked class export
956
+ > Imports are now done from @rentman/rm-core, old imports are broken. This is because the old export structure didn't always work
957
+
958
+ ##v1.0.29
959
+ - Fix inverted inArray check in CollectionEntry.removeItems
960
+ > A delete message from the socket deleted all BUT the deleted items, this should now be fixed
961
+
962
+ ##v1.0.28
963
+ Bug fixes only
964
+
965
+ ##v1.0.27
966
+ - `ItemEntry.initial` is now undefined by default
967
+ > In the SocketMessageHandler we use this check to see if an ItemEntry is a stub
968
+
969
+ ##v1.0.26
970
+ Bundle both minified and unminified code, include sourcemaps from dev build
971
+
972
+ ##v1.0.24, v1.0.25
973
+ ! Use version `v1.0.26` !
974
+
975
+ - The core now expects a `promiseInterface` that should implement the provided `promiseInterface`
976
+ > We need to be able to hook into the promises in order to call a digest cycle to update the ui in the frontend
977
+
978
+ - Rename `ItemEntry.entryId` to `ItemEntry.id
979
+ > It used to be called `id`, but it was changed in the seperation of the core.
980
+ > You can use the `id` to uniquely identify an entry, since itemId can be updated (local to saved id)
981
+
982
+ - Rename ItemResource `startTransaction` to `start`
983
+ > Other functions are called `commit` and `rollback` so having 'transaction' only for start doesn't make much sense
984
+
985
+ - `SocketMessageHandler.onMessageReceived` now returns a promise
986
+ > You can now use the updated items or hook into the result to update the ui for example
987
+
988
+
989
+ ##v1.0.23
990
+ - Rename ResourceCache to LocalCache
991
+ > LocalCache only caches local items (name better reflects functionality)
992
+
993
+ - Remove getter/setter for hasChanges
994
+ > hasChanges is called in a digest loop in the frontend, so for performance reasons we don't want to recompute the value every time
995
+
996
+ - Remove `_getCollection` from ItemAdministrator
997
+ > `_getCollection` is now named `getCollection` and the old `getCollection` is removed. The query is part of the
998
+ > options and should not be given as a separate argument. This was included to support the frontend
999
+
1000
+ - Remove `saveCurrentTab` from ItemAdministrator
1001
+ > `saveCurrentTab` makes no sense because the core has no concept of tabs, you should use `saveCurrentLocalCache` instead
1002
+
1003
+ - Remove `getTabEntry` and `resetTabEntry` from ItemAdministrator
1004
+ > `getTabEntry` and `resetTabEntry` make no sense because the core has no concept of tabs, you should use `getLocalCache` and `resetLocalCache` instead
1005
+