@rentman/rm-core 1.7.1 → 1.7.3

package/changelog.md

@@ -1,512 +1,522 @@
-#Changelog
-Contains new features, breaking changes and their reasoning
-
-## 1.7.1
-- Fix issue where `CreateRequestFactory` would be undefined in `ChangesProcessor`.
-
-## 1.7.0
-- **Breaking:** remove `ChangesProcessorFactory`. Add `ChangesProcessor` instance to core directly. 
-
-### Resource caching
-- **Breaking:** the following properties are removed:
-    - On `ItemEntry`: `clearResources`, `deactivateResources`.
-    - On `CollectionEntry`: `clearResources`, `getCurrentResource`.
-    - On `CollectionResourceOptions`: `clearOnTabChange`, `clearOnSubTabChange`.
-- An additional `level` parameter has been added to all methods that return resources. 
-- When creating resources using `ItemResourceFactory` or `CollectionResourceFactory`, this parameter is mandatory.
-A `defaultResourceLevel` parameter has been added to the `LocalCache` constructor.
-- A `clearResources` method has been added to `ItemAdministrator`. When calling this method, all item / collection
-and collection resources with a level of `level` or higher will be removed.  
-- The `clearResources` method has been removed from `LocalCache`.
-- The `setCurrentLocalCache` function has been removed from `LocalCacheManagerInterface`.
-
-## 1.6.13
-- When encountering a collection entry with `PROMISED_EXPAND` status, call `getCachedEntryStatus` after the initial
-promise has been resolved.
-
-> This is the likely cause of the issue where `_resolve` is called on a non-deferred collection entry.
-
-## 1.6.12
-- Fix error that occurs when trying to resolve a non-deferred collection entry.
-
-## 1.6.11
-- Fix issue where `QueryMatcher.matchComplexQuery` would return the wrong value.
-
-## 1.6.10
-- **Breaking**: Remove `linkType`, `linkIdArray` properties from `LinkCollectionDefinition`. Add `linkType`,
-`linkIdArray` parameters to `ItemAdministrator.getLinkCollectionsFromDef`.
-
-## 1.6.9
-- Redeploy of `1.6.8`
-
-## 1.6.8
-- Add support for `not` in queries
-
-## 1.6.7
-- Fix issue where `CollectionMatcher.addToCollections` wouldn't return the correct type.
-
-## 1.6.6
-- Add `callOnAdd` parameter in `CollectionHandler.batchExtend`. Set `updateInitial` to true. Remove `updateInitial` parameter in `CollectionEntry.extend`, as it should always be true.
-> The `extend` function only concerns itself with remote items, so no local changes should be generated.
-
-## 1.6.5
-- Fix issue where a derived column could be marked as the `link` (parent) column in the column set.
-> This could lead to instances where a different column would be set to the value of the parent.
-
-## 1.6.4
-- Fix issue where the `onChange` collection callback would not be called when updating it in the options.
-- Add `callOnAdd` parameter to collection matcher. When set to `false`, `onAdd` is not called for the `resultCollectionResource`.
-
-## 1.6.3
-- Properly type ApiResponseProcessor - fetchObjectArray
-
-## 1.6.2
-- Fix issue where the collection handler would return collection entries before they were resolved when calling `batchFetch`.
-
-## 1.6.1-3
-- Check for linkedTo before checking for subqueries in QueryMatcher
-> Linkedto also has `.query` and was incorrectly marked as a subquery 
-
-## 1.6.1-2
-- Fixed shorthand query with null values
-> The QueryParser would incorrectly identify subqueries when using null in a shorthand
-
-## 1.6.1-1
-- Fixed shorthand query with Moment values
-> The QueryParser would incorrectly identify Moment objects as a subquery
-
-## 1.6.1
-- Added support for subqueries in QueryParser and QueryMatcher
-> Collections using subqueries will always return 'maybe' in the QueryMatcher
-
-## 1.6.0
-- All external callbacks are now wrapped in a `try ... catch` block. This prevents them from breaking core functionality. 
-- **Breaking**: Add `ExceptionHandlerInterface` parameter to core constructor. 
-
-## 1.5.9
-- Fix issue that occurs when trying to resolve a `ColumnSet` using a single non-existing column.
-Catch exceptions that might occur when resolving an `ItemEntry`.
-- Add `mergeRequestColumns`, `mergeResponseColumns` to `ColumnSet`. When encountering new items while expanding a collection, add them to the collection.
-
-## 1.5.8
-- Introduce `RemoteViewResource` and `LocalViewResource`.
-> The `fields` property of a `RemoteViewResource` represents
-server values, while the `fields` property of a `LocalViewResource` represents local values.
-- The `fields` property of a `ViewResource` is now read only.
-
-## 1.5.7-1
-- Make ItemResource/CollectionResource base class abstract
-- Add missing overload functions in some places
-- Fix default comparator `QueryMatcher.parseSimpleQuery`
-- Fix `ExtendedCollectionMatchResult` `collection` property type 
-
-## 1.5.7
-- Properly type Collections & ItemResources (and return values) in the whole core.
-> The core will now properly return Collections & ItemResources based on the passed CollectionOptions.
-> You can now also type the expected collection type
-
-``` 
-// Expects a collection with editCollection and editItems both `true`
-// Will properly return EditResources for all collection functions
-const collection: CollectionEditResource<EditResource>;
-
-// other variations are:
-// CollectionViewResource<ViewResource>
-// CollectionViewResource<EditResource>
-// CollectionEditResource<ViewResource>
-
-this.core.itemAdministrator.getCollection(
-	'Notitie',
-	{
-		editCollection: true, // Will return a CollectionEditResource 
-		editItems: true // Will return EditResources instead of ViewResources in `.items`
-	}
-)
-```
-
-## 1.5.6
-- Add `getAllLocalCaches` to `LocalCacheManagerInterface`, remove item entries from all local caches on socket delete.
-
-## 1.5.5
-- Add 'order' column type handling to ApiFormatter functions
-
-## 1.5.4
-- Fix issue where parent would be incorrectly set when cloning a single item.
-- Type functions related to expansion maps in `ItemEntryService`. 
-
-## 1.5.3
-- Fix issue where the `enableSave` collection resource option would default to `false`. This would throw an error when
-calling `save` on a collection resource where this option was not explicitly set. 
-
-## 1.5.2
-- Type functions in `ColumnUtil` class.
-- Add `getRequestColumnId` and `containsDerivedColumns` to `ColumnUtil`.
-> `getRequestColumnId` should be used instead of `Util.getFirstProperty` when retrieving a column ID.
-- **Breaking:** Remove `ColumnUtil.isColumnSubset`. Use `ColumnSet.isSuperSetOf` instead.
-- Remove `findColumnObject`. Rename `findColumn` to `findRequestColumn`. 
-
-## 1.5.1
-- Properly remove item entry stub from (local) cache when request fails.
-- Fix issue where item or collection options could be set to undefined.
-
-## 1.5.0
-- Add `SocketMessage` type and add types to `SocketMessageHandler`
-- Expand local items requested using `getItemById` or `getItemsById` in `ItemAdministrator`.
-(`fetchItem` or `fetchItems` in `ItemHandler`.)
-- Implement expanding of local collections. This no longer leads to invalid requests.
-- **Breaking:** The `expand` function in `CollectionEntry` now has an `ItemCache` parameter.
-- **Warning:** This version contains major changes.
-
-### Introduce typing of item and collection options
-- **Breaking:** Removed `QueryItemType` collection entry option.
-- **Breaking:** Removed `ItemResourceService`. 
-- Removed `processOptions` parameter from `createCollectionResource` (`ItemAdministrator`). It is now equivalent to
-`addCollection`.
-- When creating an item resource using `ItemResourceFactory`, a collection entry using `CollectionResourceFactory` or a
-collection resource using `CollectionResourceFactory` it is no longer necessary to process options beforehand. It is
-still necessary when interacting with `CollectionHandler` or `ItemHandler` directly.
-
-## v1.4.0
-- Add `expandProcessLinkedItems` and `expandAddToCollections` to `ItemAdministrator`. These are analogues to
-`processLinkedItems` and `addToCollections`, but also expand the items with (derived) values and columns as necessary.
-They have a slightly different type signature.
-- Whenever a collection is requested, the `CollectionHandler` now makes sure that added local items are expanded as
-necessary.  
-- **Breaking:** Last parameter of `ItemHandler.createLocalEntries` is now a callback function.
-- **Breaking:** Rename `TemplateLinkedItemEntryMap` type to `TemplateItemEntryMap`.
-
-## v1.3.8
-- Add `isSaving` to `LocalCache`
-> We use this to disable the cancel/save buttons while the localCache is saving in the frontend
-
-## v1.3.7
-- Fix issues that generate invalid requests / changes when moving existing item to another collection, then deleting the parent.
-- Remove slip workarounds
-- Add api request types
-- Add types to `ModuleChangesCompilation`
-
-## v1.3.6
-- Skip add / remove collection callbacks when calling `revertChanges` (`LocalCache`).
-
-## v1.3.5
-- Fix issue where items added to collections when resolving wouldn't be removed in `revertChanges` (`LocalCache`).
-
-## v1.3.4
-- Add country to isFilteredColumn in ColumnUtil
-
-## v1.3.3
-- Move processLocalConfigColumns and consolidateColumns from ColumnUtil to frontend
-> These functions are specifically used for rendering ui-grid in the frontend, so there's 
-no reason to have them in the core
-
-## v1.3.2
-- Fix types path in package.json
-
-## v1.3.1
-- Fix types path in package.json
-
-## v1.3.0
-- Rename PromiseInterface to PromiseLibraryInterface
-> PromiseInterface is now used for the internal promise type
-
-- Use PromiseInterface instead of Promise as internal promise type
-> This allows us to overwrite the PromiseInterface definition in the frontend indicate usage of ng.IPromise
-
-## v1.2.9
-- Call processOptions in fetchDerivedValuesByColumn
-> Bug was introduced earlier but got enabled in v1.2.7
-
-## v1.2.8
-- Add toJSON methods for ItemResources, ItemEntries, and ColumnSets to fix circular dependencies in JSON.stringify
-
-## v1.2.7
-- Set itemEntry parent when generating a stub
-
-## v1.2.6
-- Fix an issue introduced in v1.2.5.
-
-## v1.2.5
-- When a local item cannot by found, return a newly created item in `getItemByState` (`ItemAdministrator`) only. This
-solves an issue with refreshing on a local edit view.
-
-## v1.2.4
-- **Breaking:** When a local item cannot by found, instead of a new item being created an error is thrown. This means it
-is no longer possible to create local items using `getItemById` or `getItemsById` in the `ItemAdministrator` class.
-- **Breaking:** Removed `getItemDefinition` and `getItemByDef` in the `ItemAdministrator` class. Added `getItemByState`.
-- Renamed types `TemplateResponseItemEntryMap` to `TemplateItemEntryMap` and `TemplateResponseLinkedItemEntryMap` to
-`TemplateLinkedItemEntryMap`.
-- Removed `getCollectionCacheKey` in `KeyService`. (Legacy code.)
-
-## v1.2.3
-- Fixed issue where derived values deeper than one layer couldn't be resolved.
-
-## v1.2.2
-- Fixed issue where in derived values weren't set after create request.
-
-## v1.2.1
-- **Breaking:** Replaced the `initial` parameter with the `callOnChange` parameter (`true` by default) in the `commit`
-function of the `EditResource` class.
-- Fixed issue in `setLocalFields` (`ItemEntry`) where some values were wrongly assumed to be present in `initialValues`.
-- Optimization: Disabled automatic resolution of derived values in `addItems` (`CollectionEditResource`) when `modInstant` is set to true.
-
-## v1.2.0
-- **Breaking:** When calling `addItems` or `addItem` on the `CollectionEditResource` class derived values are now
-resolved automatically. Instead of a compound object like `{fields: {key: 'value'}, derived: {}}` an object like
-`{key: 'value'}` should now be used as argument when calling these functions.
-- **Breaking:** Added `localCache` parameter to `CollectionResource` constructor.
-
-## v1.1.20
-- Fixed minor issue where collection wouldn't be deferred properly before expanding.
-- `onChange` is now called automatically when when calling `commit` on an edit resource. 
-
-## v1.1.19
-- **Breaking:** Renamed `getCurrentChanges` to `getModuleChanges` in the `ItemAdministrator` class. Added optional
-`localCache` parameter.
-
-### Local cache callback refactoring
-- Removed `onSaveWithoutClosing` event.
-- Added `condition` parameter to `onBeforeSave` and `onSaveSuccess` (possible values are `always`, `onClose` or
-`skipOnClose`, defaults to `always`). Callbacks registered with `condition: always` will get executed before other
-callbacks.
-- Pass the local cache itself to all registered callback functions. Pass the item ID conversion map as second argument
-to `onSaveSuccess` callback functions.
-
-## v1.1.18
-- Calling `expand` on a `CollectionEntry` manually no longer defers the collection entry.
-- The `batchFetch` and `batchExpand` functions in the `CollectionHandler` class now properly defer and resolve the
-collection entries.
-
-## v1.1.17
-- Fixed issue where the `getLocalByQuery` function in the `ItemCache` class wouldn't return any items.
-- When batch resolving collection entries, `CollectionHandler` now looks for matching items using `getByQuery` instead
-of `getByParent`.
-
-### Cache invalidation
-- Added `queueReload` function to `ItemEntry` class. This will reload the item when the item entry itself or a
-collection entry containing the item is requested.
-- The `queueReload` function in the `CollectionEntry` class no longer directly defers the item.
-- Added `invalidateCache` function to the `ItemAdministrator` class. This will call `queueReload` on all item entries
-and collection entries.
-
-### Item entry refactoring
-- Renamed `process` to `setFields`. 
-- Replaced `processLocal` with `setLocalFields`. This function no longer has a `modified` parameter.
-- `setModified` now also sets local default values.
-- Removed `setCreator`. This function was called twice in some instances.
-- **Breaking:** Added `derived` parameter to `updateFields`  
-
-##v1.16
-- Pass `hasChanges` as second argument to `onBeforeSave` callbacks in  the `LocalCache` class. This fixes an issue with
-project financial values in the front-end. [RM4-9577]
-- Added `callOnActivate` parameter to `addItems` function in `CollectionEditResource` class. Use this to prevent items
-from being added to the local cache.  
-
-##v1.15
-- Fix `fetchItemTypesTranslations` function in `ColumnHandler` class.
-- Fix type definition of `PromiseInterface.all`.
-
-##v1.14
-- The `ChangesCompiler` now always processes local collections. (Even if they don't have edit resources.) This fixes an
-issue with recurring appointments in the front-end.
-
-##v1.13
-- Add option to exclude itemTypes during createLocalEntries.
-
-##v1.12
-- **Breaking:** `ItemResource.isNew` returns true *only* if the resource was created using 
-`ItemAdministrator.getNewResource` or `ItemAdministrator.getItemByDef`. This fixes an issue where items where removed
-from the local cache inadvertently.
-- The `start`, `commit` and `rollback` functions of `EditResource` now return the resource itself to facilitate chaining.
-- When calling `CollectionEntry.revertChanges`, callbacks like `onAdd` / `onRemove` and `onActivate` / `onDeactivate`
-are now respected. This fixes an issue where items where *not* removed from the local cache.
-- When removing *local* items from collections, they are removed from `initial` as well as `modified`. This fixes an
-issue where changes were being detected continuously.
-- Updated the order of requests in `changesProcessor`. The `update` request is now executed before the `delete` request,
-except when updating documents. This fixes several issues.
-- `CollectionCache` now uses a map instead of an array to store collections. This fixes an issue where the same
-collection was added multiple times.
-- Updated all models to use dependency objects. This increases ease of debugging.
-
-##v.1.11
-- Fixed issue that occurs when saving when having an existing item refer to a newly created item.
-- **Breaking:** Removed `ItemResourceService.isNewResource`.
-- **Breaking:** Renamed `ItemResource.isNewResource` to `ItemResource.isNew`. Removed parameter.
-- `ItemResource.isNew` is equivalent to `ItemResource.isLocal`, while `EditResource.isNew` checks also checks for
- completed transactions. 
-
-##v.1.10
-- Fixed issue where changes on different subtabs were not detected.
-
-##v1.1.9
-- Exposed `noop` function on `RmCore` class.
-> This is used in order to check whether a callback has a default value. 
-- Added `copyRequestColumns` function to `ColumnUtil` class.
-- Made parameters of `ItemAdministrator.saveCurrentLocalCache` and `LocalCache.save` optional.
-- **Breaking:** Reordered parameters of `ChangesProcessor.execute` to be consistent with
-`ItemAdministrator.saveCurrentLocalCache`. The new order is `singleItems` - `collections` - `parameters` -
-`breakUpByParent` - `onAfterCreateCallback`.
-
-##v1.1.8
-- Set default value for `params` to `{filter: false}` in `request` function in `ColumnHandler` class.
-
-##v1.1.7
-- Fixed issue where cached item entries or collection entries wouldn't be added to the local cache.
-
-##v1.1.6
-- Fixed issue with deferred item entries.
-- Re-enable changes watcher after save.
-- Added optional `id` parameter to `LocalCache` constructor.
-
-##v1.1.5
-- Added `clearItem` function to `LocalCache` class.
-
-##v.1.1.4
-- Fix issue where items where not added to the local cache automatically when they where added to a collection.
-> This depends on the `callOnActivate` parameter. I've added this mainly because extending collections should *not* add
-the items to the local cache.
-> In other instances this might be debatable because it doesn't do any real harm. *Not*
-doing it however can definitely be harmful. 
-
-##v.1.1.3
-- Fixed an issue where all collections in a local cache would be cleared.
-- **Breaking:** Renamed `getCacheManager` to `getCurrentLocalCache` and `setCacheManager` to `setCurrentLocalCache` in
-`LocalCacheManagerInterface`.
-
-##v1.1.2
-- Fixed an issue concerning derived values.
-
-## v1.1.1
-- Fixed an issue where changes wouldn't be detected.
-- **Breaking:** Removed the `_hasChanges` function in the `localCache` class. If you want to force changes detection,
-call `detectChanges` instead. Otherwise, rely on the `hasChanges` variable.
-- **Breaking:** Removed the `enableWatcher` and `disableWatcher` functions. Use `enableChangesWatcher` and
-`disableChangesWatcher` instead.  
-
-## v1.1.0
-### Development
-
-#### Strict TypeScript compilation
-Added the following TypeScript compiler options:
-- noImplicitThis
-- noImplicitReturns
-- strictNullChecks
-- noUnusedLocals
-- noUnusedParameters
-
-I would advise enabling these for all TypeScript projects from now on.
-
-#### Ordered imports and dependencies
-Imports are now ordered alphabetically and grouped by folder. Added a TSLint option to enforce this.
-Please note that this also applies for imports from the folder the file is currently in.
-For example, in `models/ItemResource.ts`, `itemEntry` should be imported like so:
-`import { ItemEntry } from '../models';`
-
-Also, factory and class dependencies should be ordered alphabetically as well. This will make it easier to add and
-remove dependencies in the future.
-
-### Breaking changes
-
-- Renamed `changesCompiler` to `changesCompilation`, `changesCompilerFactory` to `changesCompilationFactory`,
-`moduleChangesCompiler` to `moduleChangesCompilation` and `moduleChangesCompilerFactory` to
-`moduleChangesCompilationFactory`.
-- Removed the `allLinks` parameter from the `query` function definition in the `ApiRequestServiceInterface`. This is
-no longer supported in the back-end.
-
-#### Item and collection entries
-- Moved *all* functions that handle item entries from the `ItemEntryService` to the `ItemEntry` class.
-- Added the following functions to `ItemEntryService`:
-	- `createLocalConversionMap`;
-	- `expandLocalConversionMap`;
-	- `expandConversionMap`;
-	- `batchExpandConversionMap`;
-	- `batchClone`.
-- Cloning of item entries now works slightly differently. The function will attempt to generate a new
-item ID, and update the conversion map accordingly, but will respect the item ID that is already there.
-
-#### Rework item caching
-Newly created item entries and collection entries are no longer added to the global *or* local cache by default. 
-All entries are added to the global cache on save. Item entries are added to the local cache when resources are created 
-using the item administrator or when resources are created when adding the items to a collection.
-
-> This will increase reliability by ensuring the global cache is no longer 'polluted' with local items. Also, this will
-> allow for the creation item and collection entries without caching them directly. This is required for the copying and
-> pasting of items.
- 
-Other changes: 
- 
-- Moved `saveLocal` to `ItemAdministrator`;
-- `ItemAdministrator.fetchTitle` should now be called instead of `ItemHandler.fetchTitle`;
-- The `ItemAdministrator` collection matching functions (`addToCollections`, `removeFromCollections`) should now be
-called instead of those in the `CollectionHandler`. The `CollectionHandler` should only be used to reflect changes
-already on the backend. (Use `getCollectionMatcher`.)
-
-
-##v1.0.33
-- Really fix types path
-
-##v1.0.33
-- Fix types path
-
-##v1.0.32
-- Update `tsconfig.json` to put definitions in the root folder
-> The app had an issue with AOT compilation because of this
-
-##v1.0.31
-- Fix `columnHandler.fetchItemTypeTranslations`
-> It incorrectly looped over the response map, it should now work again
-
-##v1.0.30
-- Remove `updateTabParams` from LocalCacheManagerInterface
-> The function wasn't used
-
-- Reworked class export
-> Imports are now done from @rentman/rm-core, old imports are broken. This is because the old export structure didn't always work
-
-##v1.0.29
-- Fix inverted inArray check in CollectionEntry.removeItems
-> A delete message from the socket deleted all BUT the deleted items, this should now be fixed
-
-##v1.0.28
-Bug fixes only
-
-##v1.0.27
-- `ItemEntry.initial` is now undefined by default
-> In the SocketMessageHandler we use this check to see if an ItemEntry is a stub 
-
-##v1.0.26
-Bundle both minified and unminified code, include sourcemaps from dev build
-
-##v1.0.24, v1.0.25
-! Use version `v1.0.26` !
-
-- The core now expects a `promiseInterface` that should implement the provided `promiseInterface`
-> We need to be able to hook into the promises in order to call a digest cycle to update the ui in the frontend
-
-- Rename `ItemEntry.entryId` to `ItemEntry.id
-> It used to be called `id`, but it was changed in the seperation of the core.
-> You can use the `id` to uniquely identify an entry, since itemId can be updated (local to saved id)
-
-- Rename ItemResource `startTransaction` to `start`
-> Other functions are called `commit` and `rollback` so having 'transaction' only for start doesn't make much sense
-
-- `SocketMessageHandler.onMessageReceived` now returns a promise
-> You can now use the updated items or hook into the result to update the ui for example
-
-
-##v1.0.23
-- Rename ResourceCache to LocalCache
-> LocalCache only caches local items (name better reflects functionality)
-
-- Remove getter/setter for hasChanges
-> hasChanges is called in a digest loop in the frontend, so for performance reasons we don't want to recompute the value every time
- 
-- Remove `_getCollection` from ItemAdministrator
-> `_getCollection` is now named `getCollection` and the old `getCollection` is removed. The query is part of the
-> options and should not be given as a separate argument. This was included to support the frontend
-
-- Remove `saveCurrentTab` from ItemAdministrator
-> `saveCurrentTab` makes no sense because the core has no concept of tabs, you should use `saveCurrentLocalCache` instead
-
-- Remove `getTabEntry` and `resetTabEntry` from ItemAdministrator
-> `getTabEntry` and `resetTabEntry` make no sense because the core has no concept of tabs, you should use `getLocalCache` and `resetLocalCache` instead
-
+#Changelog
+Contains new features, breaking changes and their reasoning
+
+## 1.7.3
+- Add support for strict ItemType type checking
+> This is temporarily defaulted to `any` to prevent compile errors in the frontend 
+
+## 1.7.2
+- Fix some typing issues in:
+    - ApiResponseProcessor
+    - ItemCache
+    - KeyService 
+
+## 1.7.1
+- Fix issue where `CreateRequestFactory` would be undefined in `ChangesProcessor`.
+
+## 1.7.0
+- **Breaking:** remove `ChangesProcessorFactory`. Add `ChangesProcessor` instance to core directly. 
+
+### Resource caching
+- **Breaking:** the following properties are removed:
+    - On `ItemEntry`: `clearResources`, `deactivateResources`.
+    - On `CollectionEntry`: `clearResources`, `getCurrentResource`.
+    - On `CollectionResourceOptions`: `clearOnTabChange`, `clearOnSubTabChange`.
+- An additional `level` parameter has been added to all methods that return resources. 
+- When creating resources using `ItemResourceFactory` or `CollectionResourceFactory`, this parameter is mandatory.
+A `defaultResourceLevel` parameter has been added to the `LocalCache` constructor.
+- A `clearResources` method has been added to `ItemAdministrator`. When calling this method, all item / collection
+and collection resources with a level of `level` or higher will be removed.  
+- The `clearResources` method has been removed from `LocalCache`.
+- The `setCurrentLocalCache` function has been removed from `LocalCacheManagerInterface`.
+
+## 1.6.13
+- When encountering a collection entry with `PROMISED_EXPAND` status, call `getCachedEntryStatus` after the initial
+promise has been resolved.
+
+> This is the likely cause of the issue where `_resolve` is called on a non-deferred collection entry.
+
+## 1.6.12
+- Fix error that occurs when trying to resolve a non-deferred collection entry.
+
+## 1.6.11
+- Fix issue where `QueryMatcher.matchComplexQuery` would return the wrong value.
+
+## 1.6.10
+- **Breaking**: Remove `linkType`, `linkIdArray` properties from `LinkCollectionDefinition`. Add `linkType`,
+`linkIdArray` parameters to `ItemAdministrator.getLinkCollectionsFromDef`.
+
+## 1.6.9
+- Redeploy of `1.6.8`
+
+## 1.6.8
+- Add support for `not` in queries
+
+## 1.6.7
+- Fix issue where `CollectionMatcher.addToCollections` wouldn't return the correct type.
+
+## 1.6.6
+- Add `callOnAdd` parameter in `CollectionHandler.batchExtend`. Set `updateInitial` to true. Remove `updateInitial` parameter in `CollectionEntry.extend`, as it should always be true.
+> The `extend` function only concerns itself with remote items, so no local changes should be generated.
+
+## 1.6.5
+- Fix issue where a derived column could be marked as the `link` (parent) column in the column set.
+> This could lead to instances where a different column would be set to the value of the parent.
+
+## 1.6.4
+- Fix issue where the `onChange` collection callback would not be called when updating it in the options.
+- Add `callOnAdd` parameter to collection matcher. When set to `false`, `onAdd` is not called for the `resultCollectionResource`.
+
+## 1.6.3
+- Properly type ApiResponseProcessor - fetchObjectArray
+
+## 1.6.2
+- Fix issue where the collection handler would return collection entries before they were resolved when calling `batchFetch`.
+
+## 1.6.1-3
+- Check for linkedTo before checking for subqueries in QueryMatcher
+> Linkedto also has `.query` and was incorrectly marked as a subquery 
+
+## 1.6.1-2
+- Fixed shorthand query with null values
+> The QueryParser would incorrectly identify subqueries when using null in a shorthand
+
+## 1.6.1-1
+- Fixed shorthand query with Moment values
+> The QueryParser would incorrectly identify Moment objects as a subquery
+
+## 1.6.1
+- Added support for subqueries in QueryParser and QueryMatcher
+> Collections using subqueries will always return 'maybe' in the QueryMatcher
+
+## 1.6.0
+- All external callbacks are now wrapped in a `try ... catch` block. This prevents them from breaking core functionality. 
+- **Breaking**: Add `ExceptionHandlerInterface` parameter to core constructor. 
+
+## 1.5.9
+- Fix issue that occurs when trying to resolve a `ColumnSet` using a single non-existing column.
+Catch exceptions that might occur when resolving an `ItemEntry`.
+- Add `mergeRequestColumns`, `mergeResponseColumns` to `ColumnSet`. When encountering new items while expanding a collection, add them to the collection.
+
+## 1.5.8
+- Introduce `RemoteViewResource` and `LocalViewResource`.
+> The `fields` property of a `RemoteViewResource` represents
+server values, while the `fields` property of a `LocalViewResource` represents local values.
+- The `fields` property of a `ViewResource` is now read only.
+
+## 1.5.7-1
+- Make ItemResource/CollectionResource base class abstract
+- Add missing overload functions in some places
+- Fix default comparator `QueryMatcher.parseSimpleQuery`
+- Fix `ExtendedCollectionMatchResult` `collection` property type 
+
+## 1.5.7
+- Properly type Collections & ItemResources (and return values) in the whole core.
+> The core will now properly return Collections & ItemResources based on the passed CollectionOptions.
+> You can now also type the expected collection type
+
+``` 
+// Expects a collection with editCollection and editItems both `true`
+// Will properly return EditResources for all collection functions
+const collection: CollectionEditResource<EditResource>;
+
+// other variations are:
+// CollectionViewResource<ViewResource>
+// CollectionViewResource<EditResource>
+// CollectionEditResource<ViewResource>
+
+this.core.itemAdministrator.getCollection(
+	'Notitie',
+	{
+		editCollection: true, // Will return a CollectionEditResource 
+		editItems: true // Will return EditResources instead of ViewResources in `.items`
+	}
+)
+```
+
+## 1.5.6
+- Add `getAllLocalCaches` to `LocalCacheManagerInterface`, remove item entries from all local caches on socket delete.
+
+## 1.5.5
+- Add 'order' column type handling to ApiFormatter functions
+
+## 1.5.4
+- Fix issue where parent would be incorrectly set when cloning a single item.
+- Type functions related to expansion maps in `ItemEntryService`. 
+
+## 1.5.3
+- Fix issue where the `enableSave` collection resource option would default to `false`. This would throw an error when
+calling `save` on a collection resource where this option was not explicitly set. 
+
+## 1.5.2
+- Type functions in `ColumnUtil` class.
+- Add `getRequestColumnId` and `containsDerivedColumns` to `ColumnUtil`.
+> `getRequestColumnId` should be used instead of `Util.getFirstProperty` when retrieving a column ID.
+- **Breaking:** Remove `ColumnUtil.isColumnSubset`. Use `ColumnSet.isSuperSetOf` instead.
+- Remove `findColumnObject`. Rename `findColumn` to `findRequestColumn`. 
+
+## 1.5.1
+- Properly remove item entry stub from (local) cache when request fails.
+- Fix issue where item or collection options could be set to undefined.
+
+## 1.5.0
+- Add `SocketMessage` type and add types to `SocketMessageHandler`
+- Expand local items requested using `getItemById` or `getItemsById` in `ItemAdministrator`.
+(`fetchItem` or `fetchItems` in `ItemHandler`.)
+- Implement expanding of local collections. This no longer leads to invalid requests.
+- **Breaking:** The `expand` function in `CollectionEntry` now has an `ItemCache` parameter.
+- **Warning:** This version contains major changes.
+
+### Introduce typing of item and collection options
+- **Breaking:** Removed `QueryItemType` collection entry option.
+- **Breaking:** Removed `ItemResourceService`. 
+- Removed `processOptions` parameter from `createCollectionResource` (`ItemAdministrator`). It is now equivalent to
+`addCollection`.
+- When creating an item resource using `ItemResourceFactory`, a collection entry using `CollectionResourceFactory` or a
+collection resource using `CollectionResourceFactory` it is no longer necessary to process options beforehand. It is
+still necessary when interacting with `CollectionHandler` or `ItemHandler` directly.
+
+## v1.4.0
+- Add `expandProcessLinkedItems` and `expandAddToCollections` to `ItemAdministrator`. These are analogues to
+`processLinkedItems` and `addToCollections`, but also expand the items with (derived) values and columns as necessary.
+They have a slightly different type signature.
+- Whenever a collection is requested, the `CollectionHandler` now makes sure that added local items are expanded as
+necessary.  
+- **Breaking:** Last parameter of `ItemHandler.createLocalEntries` is now a callback function.
+- **Breaking:** Rename `TemplateLinkedItemEntryMap` type to `TemplateItemEntryMap`.
+
+## v1.3.8
+- Add `isSaving` to `LocalCache`
+> We use this to disable the cancel/save buttons while the localCache is saving in the frontend
+
+## v1.3.7
+- Fix issues that generate invalid requests / changes when moving existing item to another collection, then deleting the parent.
+- Remove slip workarounds
+- Add api request types
+- Add types to `ModuleChangesCompilation`
+
+## v1.3.6
+- Skip add / remove collection callbacks when calling `revertChanges` (`LocalCache`).
+
+## v1.3.5
+- Fix issue where items added to collections when resolving wouldn't be removed in `revertChanges` (`LocalCache`).
+
+## v1.3.4
+- Add country to isFilteredColumn in ColumnUtil
+
+## v1.3.3
+- Move processLocalConfigColumns and consolidateColumns from ColumnUtil to frontend
+> These functions are specifically used for rendering ui-grid in the frontend, so there's 
+no reason to have them in the core
+
+## v1.3.2
+- Fix types path in package.json
+
+## v1.3.1
+- Fix types path in package.json
+
+## v1.3.0
+- Rename PromiseInterface to PromiseLibraryInterface
+> PromiseInterface is now used for the internal promise type
+
+- Use PromiseInterface instead of Promise as internal promise type
+> This allows us to overwrite the PromiseInterface definition in the frontend indicate usage of ng.IPromise
+
+## v1.2.9
+- Call processOptions in fetchDerivedValuesByColumn
+> Bug was introduced earlier but got enabled in v1.2.7
+
+## v1.2.8
+- Add toJSON methods for ItemResources, ItemEntries, and ColumnSets to fix circular dependencies in JSON.stringify
+
+## v1.2.7
+- Set itemEntry parent when generating a stub
+
+## v1.2.6
+- Fix an issue introduced in v1.2.5.
+
+## v1.2.5
+- When a local item cannot by found, return a newly created item in `getItemByState` (`ItemAdministrator`) only. This
+solves an issue with refreshing on a local edit view.
+
+## v1.2.4
+- **Breaking:** When a local item cannot by found, instead of a new item being created an error is thrown. This means it
+is no longer possible to create local items using `getItemById` or `getItemsById` in the `ItemAdministrator` class.
+- **Breaking:** Removed `getItemDefinition` and `getItemByDef` in the `ItemAdministrator` class. Added `getItemByState`.
+- Renamed types `TemplateResponseItemEntryMap` to `TemplateItemEntryMap` and `TemplateResponseLinkedItemEntryMap` to
+`TemplateLinkedItemEntryMap`.
+- Removed `getCollectionCacheKey` in `KeyService`. (Legacy code.)
+
+## v1.2.3
+- Fixed issue where derived values deeper than one layer couldn't be resolved.
+
+## v1.2.2
+- Fixed issue where in derived values weren't set after create request.
+
+## v1.2.1
+- **Breaking:** Replaced the `initial` parameter with the `callOnChange` parameter (`true` by default) in the `commit`
+function of the `EditResource` class.
+- Fixed issue in `setLocalFields` (`ItemEntry`) where some values were wrongly assumed to be present in `initialValues`.
+- Optimization: Disabled automatic resolution of derived values in `addItems` (`CollectionEditResource`) when `modInstant` is set to true.
+
+## v1.2.0
+- **Breaking:** When calling `addItems` or `addItem` on the `CollectionEditResource` class derived values are now
+resolved automatically. Instead of a compound object like `{fields: {key: 'value'}, derived: {}}` an object like
+`{key: 'value'}` should now be used as argument when calling these functions.
+- **Breaking:** Added `localCache` parameter to `CollectionResource` constructor.
+
+## v1.1.20
+- Fixed minor issue where collection wouldn't be deferred properly before expanding.
+- `onChange` is now called automatically when when calling `commit` on an edit resource. 
+
+## v1.1.19
+- **Breaking:** Renamed `getCurrentChanges` to `getModuleChanges` in the `ItemAdministrator` class. Added optional
+`localCache` parameter.
+
+### Local cache callback refactoring
+- Removed `onSaveWithoutClosing` event.
+- Added `condition` parameter to `onBeforeSave` and `onSaveSuccess` (possible values are `always`, `onClose` or
+`skipOnClose`, defaults to `always`). Callbacks registered with `condition: always` will get executed before other
+callbacks.
+- Pass the local cache itself to all registered callback functions. Pass the item ID conversion map as second argument
+to `onSaveSuccess` callback functions.
+
+## v1.1.18
+- Calling `expand` on a `CollectionEntry` manually no longer defers the collection entry.
+- The `batchFetch` and `batchExpand` functions in the `CollectionHandler` class now properly defer and resolve the
+collection entries.
+
+## v1.1.17
+- Fixed issue where the `getLocalByQuery` function in the `ItemCache` class wouldn't return any items.
+- When batch resolving collection entries, `CollectionHandler` now looks for matching items using `getByQuery` instead
+of `getByParent`.
+
+### Cache invalidation
+- Added `queueReload` function to `ItemEntry` class. This will reload the item when the item entry itself or a
+collection entry containing the item is requested.
+- The `queueReload` function in the `CollectionEntry` class no longer directly defers the item.
+- Added `invalidateCache` function to the `ItemAdministrator` class. This will call `queueReload` on all item entries
+and collection entries.
+
+### Item entry refactoring
+- Renamed `process` to `setFields`. 
+- Replaced `processLocal` with `setLocalFields`. This function no longer has a `modified` parameter.
+- `setModified` now also sets local default values.
+- Removed `setCreator`. This function was called twice in some instances.
+- **Breaking:** Added `derived` parameter to `updateFields`  
+
+##v1.16
+- Pass `hasChanges` as second argument to `onBeforeSave` callbacks in  the `LocalCache` class. This fixes an issue with
+project financial values in the front-end. [RM4-9577]
+- Added `callOnActivate` parameter to `addItems` function in `CollectionEditResource` class. Use this to prevent items
+from being added to the local cache.  
+
+##v1.15
+- Fix `fetchItemTypesTranslations` function in `ColumnHandler` class.
+- Fix type definition of `PromiseInterface.all`.
+
+##v1.14
+- The `ChangesCompiler` now always processes local collections. (Even if they don't have edit resources.) This fixes an
+issue with recurring appointments in the front-end.
+
+##v1.13
+- Add option to exclude itemTypes during createLocalEntries.
+
+##v1.12
+- **Breaking:** `ItemResource.isNew` returns true *only* if the resource was created using 
+`ItemAdministrator.getNewResource` or `ItemAdministrator.getItemByDef`. This fixes an issue where items where removed
+from the local cache inadvertently.
+- The `start`, `commit` and `rollback` functions of `EditResource` now return the resource itself to facilitate chaining.
+- When calling `CollectionEntry.revertChanges`, callbacks like `onAdd` / `onRemove` and `onActivate` / `onDeactivate`
+are now respected. This fixes an issue where items where *not* removed from the local cache.
+- When removing *local* items from collections, they are removed from `initial` as well as `modified`. This fixes an
+issue where changes were being detected continuously.
+- Updated the order of requests in `changesProcessor`. The `update` request is now executed before the `delete` request,
+except when updating documents. This fixes several issues.
+- `CollectionCache` now uses a map instead of an array to store collections. This fixes an issue where the same
+collection was added multiple times.
+- Updated all models to use dependency objects. This increases ease of debugging.
+
+##v.1.11
+- Fixed issue that occurs when saving when having an existing item refer to a newly created item.
+- **Breaking:** Removed `ItemResourceService.isNewResource`.
+- **Breaking:** Renamed `ItemResource.isNewResource` to `ItemResource.isNew`. Removed parameter.
+- `ItemResource.isNew` is equivalent to `ItemResource.isLocal`, while `EditResource.isNew` checks also checks for
+ completed transactions. 
+
+##v.1.10
+- Fixed issue where changes on different subtabs were not detected.
+
+##v1.1.9
+- Exposed `noop` function on `RmCore` class.
+> This is used in order to check whether a callback has a default value. 
+- Added `copyRequestColumns` function to `ColumnUtil` class.
+- Made parameters of `ItemAdministrator.saveCurrentLocalCache` and `LocalCache.save` optional.
+- **Breaking:** Reordered parameters of `ChangesProcessor.execute` to be consistent with
+`ItemAdministrator.saveCurrentLocalCache`. The new order is `singleItems` - `collections` - `parameters` -
+`breakUpByParent` - `onAfterCreateCallback`.
+
+##v1.1.8
+- Set default value for `params` to `{filter: false}` in `request` function in `ColumnHandler` class.
+
+##v1.1.7
+- Fixed issue where cached item entries or collection entries wouldn't be added to the local cache.
+
+##v1.1.6
+- Fixed issue with deferred item entries.
+- Re-enable changes watcher after save.
+- Added optional `id` parameter to `LocalCache` constructor.
+
+##v1.1.5
+- Added `clearItem` function to `LocalCache` class.
+
+##v.1.1.4
+- Fix issue where items where not added to the local cache automatically when they where added to a collection.
+> This depends on the `callOnActivate` parameter. I've added this mainly because extending collections should *not* add
+the items to the local cache.
+> In other instances this might be debatable because it doesn't do any real harm. *Not*
+doing it however can definitely be harmful. 
+
+##v.1.1.3
+- Fixed an issue where all collections in a local cache would be cleared.
+- **Breaking:** Renamed `getCacheManager` to `getCurrentLocalCache` and `setCacheManager` to `setCurrentLocalCache` in
+`LocalCacheManagerInterface`.
+
+##v1.1.2
+- Fixed an issue concerning derived values.
+
+## v1.1.1
+- Fixed an issue where changes wouldn't be detected.
+- **Breaking:** Removed the `_hasChanges` function in the `localCache` class. If you want to force changes detection,
+call `detectChanges` instead. Otherwise, rely on the `hasChanges` variable.
+- **Breaking:** Removed the `enableWatcher` and `disableWatcher` functions. Use `enableChangesWatcher` and
+`disableChangesWatcher` instead.  
+
+## v1.1.0
+### Development
+
+#### Strict TypeScript compilation
+Added the following TypeScript compiler options:
+- noImplicitThis
+- noImplicitReturns
+- strictNullChecks
+- noUnusedLocals
+- noUnusedParameters
+
+I would advise enabling these for all TypeScript projects from now on.
+
+#### Ordered imports and dependencies
+Imports are now ordered alphabetically and grouped by folder. Added a TSLint option to enforce this.
+Please note that this also applies for imports from the folder the file is currently in.
+For example, in `models/ItemResource.ts`, `itemEntry` should be imported like so:
+`import { ItemEntry } from '../models';`
+
+Also, factory and class dependencies should be ordered alphabetically as well. This will make it easier to add and
+remove dependencies in the future.
+
+### Breaking changes
+
+- Renamed `changesCompiler` to `changesCompilation`, `changesCompilerFactory` to `changesCompilationFactory`,
+`moduleChangesCompiler` to `moduleChangesCompilation` and `moduleChangesCompilerFactory` to
+`moduleChangesCompilationFactory`.
+- Removed the `allLinks` parameter from the `query` function definition in the `ApiRequestServiceInterface`. This is
+no longer supported in the back-end.
+
+#### Item and collection entries
+- Moved *all* functions that handle item entries from the `ItemEntryService` to the `ItemEntry` class.
+- Added the following functions to `ItemEntryService`:
+	- `createLocalConversionMap`;
+	- `expandLocalConversionMap`;
+	- `expandConversionMap`;
+	- `batchExpandConversionMap`;
+	- `batchClone`.
+- Cloning of item entries now works slightly differently. The function will attempt to generate a new
+item ID, and update the conversion map accordingly, but will respect the item ID that is already there.
+
+#### Rework item caching
+Newly created item entries and collection entries are no longer added to the global *or* local cache by default. 
+All entries are added to the global cache on save. Item entries are added to the local cache when resources are created 
+using the item administrator or when resources are created when adding the items to a collection.
+
+> This will increase reliability by ensuring the global cache is no longer 'polluted' with local items. Also, this will
+> allow for the creation item and collection entries without caching them directly. This is required for the copying and
+> pasting of items.
+ 
+Other changes: 
+ 
+- Moved `saveLocal` to `ItemAdministrator`;
+- `ItemAdministrator.fetchTitle` should now be called instead of `ItemHandler.fetchTitle`;
+- The `ItemAdministrator` collection matching functions (`addToCollections`, `removeFromCollections`) should now be
+called instead of those in the `CollectionHandler`. The `CollectionHandler` should only be used to reflect changes
+already on the backend. (Use `getCollectionMatcher`.)
+
+
+##v1.0.33
+- Really fix types path
+
+##v1.0.33
+- Fix types path
+
+##v1.0.32
+- Update `tsconfig.json` to put definitions in the root folder
+> The app had an issue with AOT compilation because of this
+
+##v1.0.31
+- Fix `columnHandler.fetchItemTypeTranslations`
+> It incorrectly looped over the response map, it should now work again
+
+##v1.0.30
+- Remove `updateTabParams` from LocalCacheManagerInterface
+> The function wasn't used
+
+- Reworked class export
+> Imports are now done from @rentman/rm-core, old imports are broken. This is because the old export structure didn't always work
+
+##v1.0.29
+- Fix inverted inArray check in CollectionEntry.removeItems
+> A delete message from the socket deleted all BUT the deleted items, this should now be fixed
+
+##v1.0.28
+Bug fixes only
+
+##v1.0.27
+- `ItemEntry.initial` is now undefined by default
+> In the SocketMessageHandler we use this check to see if an ItemEntry is a stub 
+
+##v1.0.26
+Bundle both minified and unminified code, include sourcemaps from dev build
+
+##v1.0.24, v1.0.25
+! Use version `v1.0.26` !
+
+- The core now expects a `promiseInterface` that should implement the provided `promiseInterface`
+> We need to be able to hook into the promises in order to call a digest cycle to update the ui in the frontend
+
+- Rename `ItemEntry.entryId` to `ItemEntry.id
+> It used to be called `id`, but it was changed in the seperation of the core.
+> You can use the `id` to uniquely identify an entry, since itemId can be updated (local to saved id)
+
+- Rename ItemResource `startTransaction` to `start`
+> Other functions are called `commit` and `rollback` so having 'transaction' only for start doesn't make much sense
+
+- `SocketMessageHandler.onMessageReceived` now returns a promise
+> You can now use the updated items or hook into the result to update the ui for example
+
+
+##v1.0.23
+- Rename ResourceCache to LocalCache
+> LocalCache only caches local items (name better reflects functionality)
+
+- Remove getter/setter for hasChanges
+> hasChanges is called in a digest loop in the frontend, so for performance reasons we don't want to recompute the value every time
+ 
+- Remove `_getCollection` from ItemAdministrator
+> `_getCollection` is now named `getCollection` and the old `getCollection` is removed. The query is part of the
+> options and should not be given as a separate argument. This was included to support the frontend
+
+- Remove `saveCurrentTab` from ItemAdministrator
+> `saveCurrentTab` makes no sense because the core has no concept of tabs, you should use `saveCurrentLocalCache` instead
+
+- Remove `getTabEntry` and `resetTabEntry` from ItemAdministrator
+> `getTabEntry` and `resetTabEntry` make no sense because the core has no concept of tabs, you should use `getLocalCache` and `resetLocalCache` instead
+