@rentman/rm-core 1.1.18 → 1.1.19

package/changelog.md

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

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

@@ -2,7 +2,7 @@ import { CollectionCache, CollectionEntryService, CollectionHandler, CollectionM
 import { CollectionMatcherFactory, ColumnSetFactory, LocalCacheFactory, ModuleChangesCompilationFactory } from '../factories';
 import { ApiRequestServiceInterface, AuthInterface, ErrorHandlerInterface, LocalCacheManagerInterface, PromiseInterface } from '../interfaces';
 import { CollectionEntry, CollectionResource, ItemEntry, ItemResource } from '../models';
-import { CollectionEntryParentIdMap, CollectionResourceParentIdMap, CreateRequestParameterMap, ItemDefinition, ItemId, ItemIdConversionMap, ItemOptions, ItemResourceItemTypeMap, ItemType, TemplateResponseItemEntryMap, TemplateResponseLinkedItemEntryMap } from '../types';
+import { CollectionEntryParentIdMap, CollectionResourceParentIdMap, CreateRequestParameterMap, ItemDefinition, ItemId, ItemIdConversionMap, ItemOptions, ItemResourceItemTypeMap, ItemType, LocalCacheCallbackCondition, OnSaveCallback, TemplateResponseItemEntryMap, TemplateResponseLinkedItemEntryMap } from '../types';
 export declare class ItemAdministrator {
     private apiRequestService;
     private authInterface;
@@ -73,7 +73,7 @@ export declare class ItemAdministrator {
     saveCurrentLocalCache(closeTab?: boolean, parameters?: CreateRequestParameterMap, breakupByParent?: boolean, onAfterCreateCallback?: (conversionMap: ItemIdConversionMap) => void): any;
     getCurrentCollections(): CollectionCache;
     getCurrentItems(): ItemCache;
-    getCurrentChanges(): {
+    getModuleChanges(localCache?: LocalCache): {
         itemType: string;
         itemId: number;
         items: any;
@@ -90,7 +90,6 @@ 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): () => void;
-    onSaveSuccess(key: string, callback: any): () => void;
-    onSaveWithoutClosing(key: string, callback: any): () => void;
+    onBeforeSave(key: string, callback: (localCache: LocalCache) => any, condition?: LocalCacheCallbackCondition): () => void;
+    onSaveSuccess(key: string, callback: OnSaveCallback, condition?: LocalCacheCallbackCondition): () => void;
 }

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

@@ -2,7 +2,7 @@ import { CollectionCache, ItemCache, ItemResourceService, LockService } from '..
 import { ChangesProcessorFactory, CollectionCacheFactory, CollectionResourceFactory, ItemCacheFactory, ItemResourceFactory } from '../factories';
 import { ErrorHandlerInterface, PromiseInterface } from '../interfaces';
 import { CollectionEntry, CollectionResource, ItemEntry, ItemResource } from '../models';
-import { CollectionEntryParentIdMap, CreateRequestParameterMap, ItemIdConversionMap, ItemOptions } from '../types';
+import { CollectionEntryParentIdMap, CreateRequestParameterMap, ItemIdConversionMap, ItemOptions, OnSaveCallback, LocalCacheCallbackCondition } from '../types';
 export declare class LocalCache {
     private errorHandler;
     private lockService;
@@ -19,12 +19,8 @@ export declare class LocalCache {
     collections: CollectionCache;
     deferredCollections: CollectionCache;
     tabRequestParameters: {};
-    callbacks: {
-        onBeforeSave: {};
-        onSaveSuccess: {};
-        onSaveWithoutClosing: {};
-    };
-    changesInterval: null | number;
+    private callbacks;
+    private changesInterval;
     hasChanges: boolean;
     constructor(errorHandler: ErrorHandlerInterface, lockService: LockService, itemResourceFactory: ItemResourceFactory, collectionCacheFactory: CollectionCacheFactory, changesProcessorFactory: ChangesProcessorFactory, itemCacheFactory: ItemCacheFactory, collectionResourceFactory: CollectionResourceFactory, itemResourceService: ItemResourceService, promiseService: PromiseInterface, id?: string);
     createItemResource(itemEntry: ItemEntry, options: ItemOptions, isRoot?: boolean, isNew?: boolean): ItemResource;
@@ -42,10 +38,12 @@ export declare class LocalCache {
     private collectionHasChanges(collectionEntry);
     isLockable(): boolean;
     save(closeTab?: boolean, parameters?: CreateRequestParameterMap, breakUpByParent?: boolean, onAfterCreateCallback?: (conversionMap: ItemIdConversionMap) => void): any;
-    private executeCallbacks(event, ...args);
+    onBeforeSave(key: string, callback: (localCache: LocalCache) => any, condition?: LocalCacheCallbackCondition): () => void;
+    onSaveSuccess(key: string, callback: OnSaveCallback, condition?: LocalCacheCallbackCondition): () => void;
+    private executeCallbackEvent<T>(callbacks, execute, closeTab);
+    private executeCallbacks<T>(callbacks, execute);
     enableChangesWatcher(): void;
     disableChangesWatcher(): void;
-    registerCallback(event: string, key: string, callback: any): () => void;
     onDeactivateItem(itemEntry: any): void;
     onActivateItem(itemEntry: any): void;
 }

package/dist/dist/types/ItemTypesCollection.d.ts

@@ -1,4 +1,4 @@
-import { ApiResponseProcessor, CollectionMatcher, ColumnSet, RequestColumnExpansion } from '../classes';
+import { ApiResponseProcessor, CollectionMatcher, ColumnSet, LocalCache, RequestColumnExpansion } from '../classes';
 import { ENTRY_STATUS } from '../constants';
 import { CollectionEntry, CollectionResource, ItemEntry, ItemResource } from '../models';
 export declare type EntryParent = {
@@ -25,6 +25,23 @@ export declare type StateKey = {
     template?: string;
     itemId?: string;
 };
+export declare type OnSaveCallback = (localCache: LocalCache, conversionMap: ItemIdConversionMap) => any;
+export declare const enum LocalCacheCallbackCondition {
+    Always = "always",
+    OnClose = "onClose",
+    SkipOnClose = "skipOnClose",
+}
+export declare type LocalCacheCallbacks<T> = {
+    always: {
+        [key: string]: T;
+    };
+    onClose: {
+        [key: string]: T;
+    };
+    skipOnClose: {
+        [key: string]: T;
+    };
+};
 export declare type ItemResourceItemIdMap = {
     [itemId: number]: ItemResource;
 };