@rentman/rm-core 1.1.13 → 1.1.14

package/changelog.md

@@ -1,204 +1,208 @@
-#Changelog
-Contains new features, breaking changes and their reasoning
-
-##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
+
+##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
+

package/dist/dist/classes/ApiFormatter.d.ts

@@ -27,7 +27,7 @@ export declare class ApiFormatter {
     formatRequestDate(value: any): any;
     formatRequestDuration(value: any): any;
     formatRequestColor(value: any): any;
-    getDefaultValue(columnType: any): false | "" | 0 | moment.Moment | moment.Duration | "0" | "#000000" | null;
+    getDefaultValue(columnType: any): false | moment.Moment | 0 | moment.Duration | "" | "0" | "#000000" | null;
     isDefaultValue(columnType: any, value: any): any;
     clone(columnType: any, value: any): any;
     getCloneFunction(columnType: any): (date: any) => any;

package/dist/dist/classes/ItemAdministrator.d.ts

@@ -89,7 +89,7 @@ export declare class ItemAdministrator {
     updateItemIdMap(collectionMap: any, conversionMap: any): void;
     createCollectionResource(collectionEntry: CollectionEntry, resourceOptions: any, processOptions?: boolean): CollectionResource;
     createItemResource(itemEntry: ItemEntry, options: any, isRoot: boolean): ItemResource;
-    onBeforeSave(key: string, callback: any): () => boolean;
-    onSaveSuccess(key: string, callback: any): () => boolean;
-    onSaveWithoutClosing(key: string, callback: any): () => boolean;
+    onBeforeSave(key: string, callback: any): () => void;
+    onSaveSuccess(key: string, callback: any): () => void;
+    onSaveWithoutClosing(key: string, callback: any): () => void;
 }

package/dist/dist/classes/LocalCache.d.ts

@@ -45,7 +45,7 @@ export declare class LocalCache {
     private executeCallbacks(event, ...args);
     enableChangesWatcher(): void;
     disableChangesWatcher(): void;
-    registerCallback(event: string, key: string, callback: any): () => boolean;
+    registerCallback(event: string, key: string, callback: any): () => void;
     onDeactivateItem(itemEntry: any): void;
     onActivateItem(itemEntry: any): void;
 }