@rentman/rm-core 1.0.22 → 1.0.23

package/changelog.md

@@ -0,0 +1,20 @@
+#Changelog
+Contains new features, breaking changes and their reasoning
+
+##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/definitions/src/classes/ItemAdministrator.d.ts

@@ -1,10 +1,10 @@
 import ColumnSetFactory from "../factories/ColumnSetFactory";
 import ModuleChangesCompilerFactory from "../factories/ModuleChangesCompilerFactory";
-import ResourceCacheFactory from "../factories/ResourceCacheFactory";
+import LocalCacheFactory from "../factories/LocalCacheFactory";
 import ApiRequestServiceInterface from '../interfaces/ApiRequestServiceInterface';
 import AuthInterface from '../interfaces/AuthInterface';
 import ErrorHandlerInterface from '../interfaces/ErrorHandlerInterface';
-import ResourceCacheInterface from '../interfaces/ResourceCacheInterface';
+import LocalCacheManagerInterface from '../interfaces/LocalCacheManagerInterface';
 import CollectionResource from '../models/CollectionResource';
 import ItemResource from '../models/ItemResource';
 import CollectionCache from './CollectionCache';
@@ -17,26 +17,26 @@ import ItemHandler from './ItemHandler';
 import ItemRequestService from "./ItemRequestService";
 import KeyService from "./KeyService";
 import QueryService from "./QueryService";
-import ResourceCache from "./ResourceCache";
+import LocalCache from "./LocalCache";
 import ItemEntry from '../models/ItemEntry';
 import { CollectionEntryParentIdMap, CollectionResourceParentIdMap, ItemResourceItemTypeMap, TemplateResponseItemEntryMap } from '../types/ItemTypesCollection';
 export default class ItemAdministrator {
     private apiRequestService;
-    private resourceCacheInterface;
+    private localCacheManager;
     private authInterface;
     private errorHandler;
     private itemHandler;
     private collectionHandler;
     private columnSetFactory;
     private itemRequestService;
-    private resourceCacheFactory;
+    private localCacheFactory;
     private moduleChangesCompilerFactory;
     private collectionEntryService;
     private collectionResourceService;
     private itemEntryService;
     private keyService;
     private queryService;
-    constructor(apiRequestService: ApiRequestServiceInterface, resourceCacheInterface: ResourceCacheInterface, authInterface: AuthInterface, errorHandler: ErrorHandlerInterface, itemHandler: ItemHandler, collectionHandler: CollectionHandler, columnSetFactory: ColumnSetFactory, itemRequestService: ItemRequestService, resourceCacheFactory: ResourceCacheFactory, moduleChangesCompilerFactory: ModuleChangesCompilerFactory, collectionEntryService: CollectionEntryService, collectionResourceService: CollectionResourceService, itemEntryService: ItemEntryService, keyService: KeyService, queryService: QueryService);
+    constructor(apiRequestService: ApiRequestServiceInterface, localCacheManager: LocalCacheManagerInterface, authInterface: AuthInterface, errorHandler: ErrorHandlerInterface, itemHandler: ItemHandler, collectionHandler: CollectionHandler, columnSetFactory: ColumnSetFactory, itemRequestService: ItemRequestService, localCacheFactory: LocalCacheFactory, moduleChangesCompilerFactory: ModuleChangesCompilerFactory, collectionEntryService: CollectionEntryService, collectionResourceService: CollectionResourceService, itemEntryService: ItemEntryService, keyService: KeyService, queryService: QueryService);
     getItemDefinition(itemType: string, itemId: any, options: any): {
         itemType: string;
         options: any;
@@ -85,9 +85,7 @@ export default class ItemAdministrator {
             resource: any;
         };
     };
-    /** @deprecated */
-    getCollection(itemType: string, query: any, options: any): PromiseLike<any>;
-    _getCollection(itemType: string, options: any): PromiseLike<CollectionResource>;
+    getCollection(itemType: string, options: any): PromiseLike<CollectionResource>;
     getCollectionFromDef(definition: any): PromiseLike<CollectionResource>;
     getLinkCollection(linkType: string, linkId: number, itemType: string, options: any): PromiseLike<CollectionResource>;
     getLinkCollections(linkType: string, linkIdArray: number[], itemType: string, options: any): PromiseLike<CollectionResourceParentIdMap>;
@@ -96,11 +94,7 @@ export default class ItemAdministrator {
     getItemByDef(definition: any, isRoot: boolean): PromiseLike<any>;
     cloneItem(newItemId: number, itemResource: any, options: any): ItemResource;
     cloneCollection(collectionResource: any, options: any, conversionMap: any): CollectionResource;
-    /**
-     * @deprecated
-     */
-    saveCurrentTab(closeTab: any, parameters: any, breakupByParent: any, onAfterCreateCallback: any, keepTabHeading: any): any;
-    saveCurrentResourceCache(closeTab: boolean, parameters: any, breakupByParent: boolean, onAfterCreateCallback: any, keepTabHeading?: boolean): any;
+    saveCurrentLocalCache(closeTab: boolean, parameters: any, breakupByParent: boolean, onAfterCreateCallback: any, keepTabHeading?: boolean): any;
     getCurrentCollections(): CollectionCache;
     getCurrentItems(): ItemCache;
     getCurrentChanges(): {
@@ -113,32 +107,15 @@ export default class ItemAdministrator {
     addCollection(collectionEntry: any, resourceOptions: any, processOptions?: any): CollectionResource;
     addCollections(collectionEntries: CollectionEntryParentIdMap, resourceOptions: any): CollectionResourceParentIdMap;
     processLinkedItems(linkedEntries: any[], options: any, addToCollections: boolean): ItemResourceItemTypeMap;
-    /**
-     * @deprecated
-     */
-    getTabEntry(): ResourceCache;
-    getResourceCache(): ResourceCache;
-    /**
-     * @deprecated
-     */
-    resetTabEntry(): void;
-    resetResourceCache(): void;
+    getLocalCache(): LocalCache;
+    resetLocalCache(): void;
     addToCollections(itemEntries: any[], resultCollectionResource: any): ItemResource[];
     removeFromCollections(itemEntries: any[], resultCollectionResource: any): any;
     updateItemIdMap(collectionMap: any, conversionMap: any): void;
     createCollectionResource(collectionEntry: any, resourceOptions: any, processOptions?: any): CollectionResource;
     createItemResource(itemEntry: any, options: any, isRoot: boolean): ItemResource;
     createItemResources(itemEntries: any[], options: any): ItemResource[];
-    /**
-     * @deprecated
-     */
     onBeforeSave(key: string, callback: any): () => void;
-    /**
-     * @deprecated
-     */
     onSaveSuccess(key: string, callback: any): () => void;
-    /**
-     * @deprecated
-     */
     onSaveWithoutClosing(key: string, callback: any): () => void;
 }

package/dist/definitions/src/classes/{ResourceCache.d.ts → LocalCache.d.ts}

@@ -18,7 +18,7 @@ import ItemHandler from "./ItemHandler";
 import ItemResourceService from './ItemResourceService';
 import LockService from "./LockService";
 import PromiseService from "./PromiseService";
-export default class ResourceCache {
+export default class LocalCache {
     private apiRequestService;
     private errorHandler;
     private itemHandler;
@@ -44,7 +44,7 @@ export default class ResourceCache {
         onSaveWithoutClosing: {};
     };
     changesInterval: null | number;
-    _hasChanges: boolean;
+    hasChanges: boolean;
     rootItem: ItemEntry;
     constructor(apiRequestService: ApiRequestServiceInterface, errorHandler: ErrorHandlerInterface, itemHandler: ItemHandler, collectionHandler: CollectionHandler, columnHandler: ColumnHandler, lockService: LockService, itemResourceFactory: ItemResourceFactory, collectionCacheFactory: CollectionCacheFactory, changesProcessorFactory: ChangesProcessorFactory, itemCacheFactory: ItemCacheFactory, collectionResourceFactory: CollectionResourceFactory, itemEntryService: ItemEntryService, itemResourceService: ItemResourceService, promiseService: PromiseService);
     addSingleItem(itemEntry: ItemEntry, options: any, isRoot: any): ItemResource;
@@ -55,7 +55,7 @@ export default class ResourceCache {
     updateSingleItems(conversionMap: any): void;
     revertChanges(): any;
     resetCollection(collectionEntry: CollectionEntry): void;
-    hasChanges: boolean;
+    _hasChanges(): boolean;
     detectChanges(): boolean;
     collectionHasChanges(collectionEntry: CollectionEntry): boolean;
     isLockable(): boolean;
@@ -71,8 +71,5 @@ export default class ResourceCache {
      * @deprecated
      */
     disableWatcher(): void;
-    /**
-     * @deprecated
-     */
     registerCallback(event: string, key: string, callback: any): () => void;
 }

package/dist/definitions/src/factories/{ResourceCacheFactory.d.ts → LocalCacheFactory.d.ts}

@@ -5,7 +5,7 @@ import ItemHandler from "../classes/ItemHandler";
 import ItemResourceService from '../classes/ItemResourceService';
 import LockService from "../classes/LockService";
 import PromiseService from '../classes/PromiseService';
-import ResourceCache from "../classes/ResourceCache";
+import LocalCache from "../classes/LocalCache";
 import ApiRequestServiceInterface from '../interfaces/ApiRequestServiceInterface';
 import ErrorHandlerInterface from '../interfaces/ErrorHandlerInterface';
 import ChangesProcessorFactory from "./ChangesProcessorFactory";
@@ -13,7 +13,7 @@ import CollectionCacheFactory from "./CollectionCacheFactory";
 import CollectionResourceFactory from "./CollectionResourceFactory";
 import ItemCacheFactory from "./ItemCacheFactory";
 import ItemResourceFactory from "./ItemResourceFactory";
-export default class ResourceCacheFactory {
+export default class LocalCacheFactory {
     private apiRequestService;
     private errorHandler;
     private itemHandler;
@@ -29,5 +29,5 @@ export default class ResourceCacheFactory {
     private itemResourceService;
     private promiseService;
     constructor(apiRequestService: ApiRequestServiceInterface, errorHandler: ErrorHandlerInterface, itemHandler: ItemHandler, collectionHandler: CollectionHandler, columnHandler: ColumnHandler, lockService: LockService, itemResourceFactory: ItemResourceFactory, collectionCacheFactory: CollectionCacheFactory, changesProcessorFactory: ChangesProcessorFactory, itemCacheFactory: ItemCacheFactory, collectionResourceFactory: CollectionResourceFactory, itemEntryService: ItemEntryService, itemResourceService: ItemResourceService, promiseService: PromiseService);
-    construct(): ResourceCache;
+    construct(): LocalCache;
 }

package/dist/definitions/src/index.d.ts

@@ -33,11 +33,11 @@ import ModuleChangesCompilerFactory from "./factories/ModuleChangesCompilerFacto
 import QueryMatcherFactory from "./factories/QueryMatcherFactory";
 import QueryParserFactory from "./factories/QueryParserFactory";
 import RequestColumnExpansionFactory from "./factories/RequestColumnExpansionFactory";
-import ResourceCacheFactory from "./factories/ResourceCacheFactory";
+import LocalCacheFactory from "./factories/LocalCacheFactory";
 import ApiRequestServiceInterface from './interfaces/ApiRequestServiceInterface';
 import AuthInterface from './interfaces/AuthInterface';
 import ErrorHandlerInterface from './interfaces/ErrorHandlerInterface';
-import ResourceCacheInterface from './interfaces/ResourceCacheInterface';
+import LocalCacheManagerInterface from './interfaces/LocalCacheManagerInterface';
 export default class RmCore {
     version: string;
     promiseService: PromiseService;
@@ -70,14 +70,13 @@ export default class RmCore {
     columnSetFactory: ColumnSetFactory;
     createRequestFactory: CreateRequestFactory;
     itemResourceFactory: ItemResourceFactory;
-    resourceCacheFactory: ResourceCacheFactory;
+    localCacheFactory: LocalCacheFactory;
     moduleChangesCompilerFactory: ModuleChangesCompilerFactory;
     queryParserFactory: QueryParserFactory;
     batchStatusFactory: BatchStatusFactory;
     socketMessageHandler: SocketMessageHandler;
     apiRequestService: ApiRequestService;
-    destroy: () => void;
-    constructor(externalApiRequestService: ApiRequestServiceInterface, resourceCacheInterface: ResourceCacheInterface, authInterface: AuthInterface, errorHandlerInterface: ErrorHandlerInterface);
+    constructor(externalApiRequestService: ApiRequestServiceInterface, localCacheManager: LocalCacheManagerInterface, authInterface: AuthInterface, errorHandlerInterface: ErrorHandlerInterface);
 }
 export declare function noop(): void;
 export declare function identity(value: any): any;

package/dist/definitions/src/interfaces/LocalCacheManagerInterface.d.ts

@@ -0,0 +1,6 @@
+import LocalCache from '../classes/LocalCache';
+export default interface LocalCacheManagerInterface {
+    updateTabParams(conversionMap: any, keepTabHeading: boolean): Promise<any>;
+    getCacheManager(userId: string): LocalCache;
+    setCacheManager(userId: string, entry: LocalCache): any;
+}