@rentman/rm-core 1.2.2 → 1.2.4

package/changelog.md

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

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, LocalCacheCallbackCondition, OnSaveCallback, TemplateResponseItemEntryMap, TemplateResponseLinkedItemEntryMap } from '../types';
+import { CollectionEntryParentIdMap, CollectionResourceParentIdMap, CreateRequestParameterMap, ItemId, ItemIdConversionMap, ItemOptions, ItemResourceItemTypeMap, ItemType, LocalCacheCallbackCondition, OnSaveCallback, TemplateItemEntryMap, TemplateLinkedItemEntryMap } from '../types';
 export declare class ItemAdministrator {
     private apiRequestService;
     private authInterface;
@@ -23,13 +23,11 @@ export declare class ItemAdministrator {
     private queryService;
     constructor(apiRequestService: ApiRequestServiceInterface, authInterface: AuthInterface, collectionEntryService: CollectionEntryService, collectionHandler: CollectionHandler, collectionMatcherFactory: CollectionMatcherFactory, collectionResourceService: CollectionResourceService, columnSetFactory: ColumnSetFactory, errorHandler: ErrorHandlerInterface, itemEntryService: ItemEntryService, itemHandler: ItemHandler, itemRequestService: ItemRequestService, keyService: KeyService, localCacheFactory: LocalCacheFactory, localCacheManager: LocalCacheManagerInterface, moduleChangesCompilationFactory: ModuleChangesCompilationFactory, promiseInterface: PromiseInterface, queryService: QueryService);
     invalidateCache(): void;
-    getItemDefinition(itemType: ItemType, stateKey: number | string, options: ItemOptions): ItemDefinition;
     getCollectionMatcher(itemEntries: ItemEntry[], addToTab: boolean): CollectionMatcher;
     fetchTitle(itemType: any, itemId: any, deferRequest: any): Promise<any>;
-    getItemById(itemType: ItemType, itemId: ItemId, options: any): Promise<ItemResource>;
+    getItemById(itemType: ItemType, itemId: ItemId, options: ItemOptions, isRoot?: boolean): Promise<ItemResource>;
     getItemsById(itemType: string, itemIds: number[], options: any): Promise<ItemResource[]>;
     getItemsByQuery(itemType: string, query: any, options: any): Promise<ItemResource[]>;
-    getDuplicateById(itemType: string, duplicateId: number, options: any): Promise<any>;
     /**
      * The return value is depended on the return links boolean. true returns the TemplateResponseItemEntryMap.
      * The type has to be asserted at use since you only know the type of the return value when the function is called
@@ -38,9 +36,11 @@ export declare class ItemAdministrator {
      * @param options
      * @param {boolean} returnLinks
      * @param {boolean} isRoot
-     * @returns {Promise<ItemResource> | Promise<TemplateResponseItemEntryMap>}
+     * @returns {Promise<ItemResource | TemplateItemEntryMap>}
      */
-    getNewResource(itemType: string, options?: any, returnLinks?: boolean, isRoot?: boolean): Promise<ItemResource> | Promise<TemplateResponseItemEntryMap>;
+    getNewResource(itemType: ItemType, options?: ItemOptions, returnLinks?: boolean, isRoot?: boolean): Promise<ItemResource | TemplateItemEntryMap>;
+    getDuplicateById(itemType: ItemType, duplicateId: ItemId, options?: ItemOptions, returnLinks?: boolean, isRoot?: boolean): Promise<ItemResource | TemplateItemEntryMap>;
+    getItemByState(itemType: ItemType, stateKey: ItemId | string, options?: ItemOptions, isRoot?: boolean): Promise<ItemResource>;
     getCollectionDef(itemType: string, options: any): {
         itemType: string;
         options: {
@@ -67,7 +67,6 @@ export declare class ItemAdministrator {
     getLinkCollections(linkType: string, linkIdArray: number[], itemType: string, options: any): Promise<CollectionResourceParentIdMap>;
     getLinkCollectionsFromDef(definition: any): Promise<CollectionResourceParentIdMap>;
     getAllLinkCollections(linkType: string, itemType: string, options: any): Promise<CollectionEntryParentIdMap>;
-    getItemByDef(definition: ItemDefinition, isRoot?: boolean): Promise<any>;
     cloneItem(itemResource: ItemResource, options: any): ItemResource;
     cloneCollection(collectionResource: CollectionResource, options: any, conversionMap: any): CollectionResource;
     saveCurrentLocalCache(closeTab?: boolean, parameters?: CreateRequestParameterMap, breakupByParent?: boolean, onAfterCreateCallback?: (conversionMap: ItemIdConversionMap) => void): any;
@@ -81,7 +80,7 @@ export declare class ItemAdministrator {
     addSingleItem(itemEntry: ItemEntry, options: ItemOptions, isRoot?: boolean, localCache?: LocalCache): ItemResource;
     addSingleItems(itemEntries: ItemEntry[], options: ItemOptions): ItemResource[];
     addCollection(collectionEntry: CollectionEntry, options: any): CollectionResource;
-    processLinkedItems(linkedEntries: TemplateResponseLinkedItemEntryMap[], options: ItemOptions, addToCollections: boolean): ItemResourceItemTypeMap;
+    processLinkedItems(linkedEntries: TemplateLinkedItemEntryMap[], options: ItemOptions, addToCollections: boolean): ItemResourceItemTypeMap;
     getLocalCache(): LocalCache;
     resetLocalCache(): void;
     addToCollections(itemEntries: ItemEntry[], resultCollectionResource?: CollectionResource): ItemResource[] | null;

package/dist/dist/classes/ItemEntryService.d.ts

@@ -6,9 +6,11 @@ export declare class ItemEntryService {
     private authInterface;
     private keyService;
     undefinedItemError: string;
-    ALL_PERMISSIONS: number;
     constructor(authInterface: AuthInterface, keyService: KeyService);
-    processOptions(options: any): any;
+    processOptions(options?: any): any;
+    createUnfoundLocalItemError(itemType: ItemType): {
+        message: string;
+    };
     createLocalConversionMap(itemType: ItemType, itemId: ItemId, doExtend: boolean | undefined, apiResponse: ApiResponse): ItemIdConversionMap;
     expandLocalConversionMap(parentType: ItemType, parentId: ItemId, apiResponse: ApiResponse, conversionMap: ItemIdConversionMap): void;
     expandConversionMap(itemEntry: ItemEntry, conversionMap: ItemIdConversionMap, newItemId?: ItemId): any;

package/dist/dist/classes/ItemHandler.d.ts

@@ -3,7 +3,7 @@ import { ENTRY_STATUS } from '../constants';
 import { BatchStatusFactory, ColumnExpansionFactory, ColumnSetFactory, ItemCacheFactory, ItemEntryFactory, TemplateFactory } from '../factories';
 import { ApiRequestServiceInterface, ErrorHandlerInterface, PromiseInterface } from '../interfaces';
 import { ItemEntry, Template } from '../models';
-import { ApiResponse, EntryStatus, FieldMap, ItemId, ItemIdConversionMap, ItemType, RequestColumns, TemplateResponseItemEntryMap, TemplateResponseLinkedItemEntryMap } from '../types';
+import { ApiResponse, EntryStatus, FieldMap, ItemId, ItemIdConversionMap, ItemOptions, ItemType, RequestColumns, TemplateItemEntryMap, TemplateLinkedItemEntryMap } from '../types';
 export declare class ItemHandler {
     private apiFormatter;
     private apiRequestService;
@@ -24,7 +24,8 @@ export declare class ItemHandler {
         [itemType: string]: Template;
     };
     constructor(apiFormatter: ApiFormatter, apiRequestService: ApiRequestServiceInterface, batchStatusFactory: BatchStatusFactory, columnExpansionFactory: ColumnExpansionFactory, columnHandler: ColumnHandler, columnSetFactory: ColumnSetFactory, columnUtil: ColumnUtil, errorHandler: ErrorHandlerInterface, itemCacheFactory: ItemCacheFactory, itemEntryFactory: ItemEntryFactory, itemEntryService: ItemEntryService, keyService: KeyService, promiseService: PromiseInterface, templateFactory: TemplateFactory);
-    fetchItem(itemType: ItemType, itemId: ItemId, options: any, localItemCache: ItemCache): Promise<ItemEntry | TemplateResponseItemEntryMap>;
+    fetchItem(itemType: ItemType, itemId: ItemId, options: any, localItemCache: ItemCache): Promise<ItemEntry>;
+    fetchNewItem(itemType: ItemType, options: ItemOptions, localItemCache: ItemCache): Promise<TemplateItemEntryMap>;
     /**
      *
      * @param itemType
@@ -37,7 +38,7 @@ export declare class ItemHandler {
      */
     fetchItems(itemType: ItemType, itemIds: ItemId[], options: any, localItemCache: ItemCache): Promise<ItemEntry[]>;
     resolveCached(itemEntry: ItemEntry, status: ENTRY_STATUS, options: any): Promise<ItemEntry>;
-    resolveLocal(itemEntry: ItemEntry, parent: any, template: any, localItemCache: ItemCache): TemplateResponseItemEntryMap;
+    resolveLocal(itemEntry: ItemEntry, parent: any, template: any, localItemCache: ItemCache): TemplateItemEntryMap;
     resolveExpansion(itemEntry: ItemEntry, columnExpansion: ColumnExpansion, response: ApiResponse): ItemEntry;
     resolveRemote(itemEntry: ItemEntry, columnSet: ColumnSet, response: ApiResponse): ItemEntry | null;
     resolveRemoteValues(itemEntry: ItemEntry, response: ApiResponse): ItemEntry | null;
@@ -46,7 +47,7 @@ export declare class ItemHandler {
         derived: FieldMap;
     } | null;
     fetchTemplate(itemType: string, templateOptions?: any, templateColumns?: any): Promise<Template>;
-    getEntryStatus(itemType: ItemType, itemId: ItemId, options: any, localItemCache: ItemCache): EntryStatus<ItemEntry>;
+    getEntryStatus(itemType: ItemType, itemId: ItemId, options: any, localItemCache: ItemCache): EntryStatus<ItemEntry> | null;
     isColumnSuperset(itemEntry: ItemEntry, columns: RequestColumns): any;
     getCachedEntryStatus(itemEntry: ItemEntry, options: any): ENTRY_STATUS;
     /**
@@ -60,8 +61,11 @@ export declare class ItemHandler {
      * for every type of entry status there is in this batch request make sure the entries get resolved.
      * then return a array of the resulting ItemEntryArray
      */
-    batchResolve(itemType: ItemType, batchStatus: BatchStatus, requestColumns: RequestColumns, resolved: any, localItemCache: ItemCache): ItemEntry[] | Promise<any>;
-    createLocalEntries(parentType: ItemType, localParentId: ItemId, template: any, itemIdConversion: ItemIdConversionMap, localItemCache: ItemCache, excludeItemTypes?: ItemType[]): TemplateResponseLinkedItemEntryMap[];
+    batchResolve(itemType: ItemType, batchStatus: BatchStatus, requestColumns: RequestColumns, resolved: {
+        entries: ItemEntry[];
+        requests?: ApiResponseProcessor;
+    }): ItemEntry[] | Promise<any>;
+    createLocalEntries(parentType: ItemType, localParentId: ItemId, template: any, itemIdConversion: ItemIdConversionMap, localItemCache: ItemCache, excludeItemTypes?: ItemType[]): TemplateLinkedItemEntryMap[];
     fetchTitle(itemType: ItemType, itemId: ItemId, deferRequest: boolean | undefined, localItemCache: ItemCache): Promise<any>;
     resolveDerivedValues(itemEntries: ItemEntry[], columns: ColumnInfo[], localItemCache: ItemCache): Promise<ItemEntry[]>;
     private getDefaultValuesByColumn(itemEntries, rootColumn);

package/dist/dist/classes/KeyService.d.ts

@@ -3,7 +3,6 @@ export declare class KeyService {
     separator: string;
     constructor();
     getSingleKey(itemType: string, itemId: number | string): string;
-    getCollectionCacheKey(parentType: string, parentId: number, childType: string): string;
     getCssKey(): any;
     parseStateKey(stateKey: string): StateKey | null;
     getDuplicateStateKey(itemId: string | number): string;

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

@@ -10,12 +10,6 @@ export declare type FieldMap = {
     [key: string]: any;
 };
 export declare type ItemOptions = any;
-export declare type ItemDefinition = {
-    itemType: ItemType;
-    itemId: ItemId;
-    options: ItemOptions;
-    isNew: boolean;
-};
 export declare const enum StateKeyType {
     New = "new",
     Duplicate = "duplicate",
@@ -23,10 +17,10 @@ export declare const enum StateKeyType {
 export declare type StateKey = {
     type: StateKeyType;
     template?: string;
-    itemId?: string;
+    itemId?: number;
 };
 export declare type OnSaveCallback = (localCache: LocalCache, conversionMap: ItemIdConversionMap) => any;
-export declare const enum LocalCacheCallbackCondition {
+export declare enum LocalCacheCallbackCondition {
     Always = "always",
     OnClose = "onClose",
     SkipOnClose = "skipOnClose",
@@ -94,11 +88,11 @@ export declare type ColumnExpansionResult = {
     difference: ColumnSet;
 };
 export declare type ApiResponse = ApiResponseProcessor;
-export declare type TemplateResponseItemEntryMap = {
+export declare type TemplateItemEntryMap = {
     main: ItemEntry;
-    linked: TemplateResponseLinkedItemEntryMap[];
+    linked: TemplateLinkedItemEntryMap[];
 };
-export declare type TemplateResponseLinkedItemEntryMap = {
+export declare type TemplateLinkedItemEntryMap = {
     itemType: string;
     itemEntries: ItemEntry[];
 };