@rentman/rm-core 1.1.8 → 1.1.9

package/changelog.md

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

package/dist/dist/classes/ChangesProcessor.d.ts

@@ -1,6 +1,8 @@
 import { ApiFormatter, CollectionEntryService, CollectionHandler, ItemHandler } from '../classes';
 import { ChangesCompilationFactory, ColumnExpansionFactory, CreateRequestFactory, RequestColumnExpansionFactory } from '../factories';
 import { ApiRequestServiceInterface, ErrorHandlerInterface, PromiseInterface } from '../interfaces';
+import { CollectionEntry, ItemEntry } from '../models';
+import { CreateRequestParameterMap, ItemIdConversionMap } from '../types';
 export declare class ChangesProcessor {
     private apiRequestService;
     private itemHandler;
@@ -17,8 +19,7 @@ export declare class ChangesProcessor {
     getItemTypeUpdatePriority(itemType: any): 0 | 1 | 2;
     buildMoveRequest(compilationEntries: any): {};
     getMapValue(itemType: any, itemId: any, map: any): any;
-    execute(singleItems: any, collections: any, breakupByParent?: boolean, parameters?: any, onAfterCreateCallback?: any): Promise<any>;
-    private executeCreateRequests(changesCompilation, parameters, conversionMap, breakupByParent, onAfterCreateCallback);
+    private executeCreateRequests(changesCompilation, parameters, conversionMap, breakupByParent?, onAfterCreateCallback?);
     private executeCreateRequest(requestResource, conversionMap);
     private prioritizeUpdateRequests(compilation, parameters);
     private executeUpdateRequests(itemTypes, compilation, parameters);
@@ -30,5 +31,5 @@ export declare class ChangesProcessor {
     private addCollectionMapEntry(collectionMap, parentId, itemEntry, value);
     private forEachCollection(collectionMap, method);
     private onItemsCreated(conversionMap, singleItems, collections);
-    private executeRequests(changesCompilation, parameters, breakupByParent, onAfterCreateCallback);
+    execute(singleItems: ItemEntry[], collections: CollectionEntry[], parameters?: CreateRequestParameterMap, breakupByParent?: boolean, onAfterCreateCallback?: (conversionMap: ItemIdConversionMap) => void): Promise<any>;
 }

package/dist/dist/classes/ColumnUtil.d.ts

@@ -1,4 +1,4 @@
-import { RequestColumns } from '../types';
+import { RequestColumn, RequestColumns } from '../types';
 export declare class ColumnUtil {
     constructor();
     getColumnPath(columns: any, renderAs: any): string;
@@ -31,20 +31,22 @@ export declare class ColumnUtil {
     isColumnSubset(first: any, second: any, secondTrue: any): any;
     containsColumn(requestColumn: any, destination: any): boolean;
     responseColumnsAvailable(itemType: any, requestColumns: any, responseColumnMap: any): boolean;
+    copyRequestColumns(columns: RequestColumns): RequestColumns;
+    copyRequestColumn(requestColumn: RequestColumn): RequestColumn;
     /**
      * Difference: columns that are in second, but not in first
      * @param {Array} first
      * @param {Array} second
      * @returns {Object} An object containing 'merged' and 'difference' properties
      */
-    mergeRequestColumns(first: any, second: any): {
+    mergeRequestColumns(first: RequestColumns, second: RequestColumns): {
         merged: RequestColumns;
         difference: RequestColumns;
     };
     mergeRequestColumn(requestColumn: any, destination: any): any;
     parseRequestColumn(requestColumn: any): {
-        id: any;
-        children: any;
+        id: string;
+        children: RequestColumn[];
     };
     /**
      * Merges two sets of response columns.
@@ -68,8 +70,8 @@ export declare class ColumnUtil {
     isLocalColumnId(columnId: any): boolean;
     processConfigColumns(columns: any): never[];
     processLocalConfigColumns(configColumns: any, localColumns: any, remoteColumnCallback: any, localColumnCallback: any): void;
-    consolidateColumns(configColumns: any, localColumns: any, addRequestColumns: any): {
-        request: any;
+    consolidateColumns(configColumns: any, localColumns: any, addRequestColumns: RequestColumn[]): {
+        request: RequestColumn[];
         local: object[];
     };
     parseConfigColumn(column: any): any;

package/dist/dist/classes/CreateRequest.d.ts

@@ -1,6 +1,6 @@
-import { CollectionCache, CollectionHandler, KeyService } from '../classes';
+import { ChangesCompilation, CollectionCache, CollectionHandler, KeyService } from '../classes';
 import { CollectionMatcherFactory, RequestColumnExpansionFactory } from '../factories';
-import { CreateRequestEntry } from '../types';
+import { CreateRequestEntry, CreateRequestParameterMap } from '../types';
 export declare class CreateRequest {
     private collectionHandler;
     private collectionMatcherFactory;
@@ -11,7 +11,7 @@ export declare class CreateRequest {
     private parameterMap;
     private breakupByParent;
     requests: CreateRequestEntry[];
-    constructor(collectionHandler: CollectionHandler, collectionMatcherFactory: CollectionMatcherFactory, keyService: KeyService, requestColumnExpansionFactory: RequestColumnExpansionFactory, compilation: any, localCollectionCache: CollectionCache, parameterMap: any, breakupByParent?: boolean);
+    constructor(collectionHandler: CollectionHandler, collectionMatcherFactory: CollectionMatcherFactory, keyService: KeyService, requestColumnExpansionFactory: RequestColumnExpansionFactory, compilation: ChangesCompilation, localCollectionCache: CollectionCache, parameterMap: CreateRequestParameterMap, breakupByParent?: boolean);
     finalizeRequest(requestResource: CreateRequestEntry): CreateRequestEntry;
     setRequestParent(parentType: any, requestResource: any): boolean;
     run(): CreateRequestEntry[];

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, ItemId, ItemResourceItemTypeMap, ItemType, TemplateResponseItemEntryMap, TemplateResponseLinkedItemEntryMap } from '../types';
+import { CollectionEntryParentIdMap, CollectionResourceParentIdMap, CreateRequestParameterMap, ItemId, ItemIdConversionMap, ItemResourceItemTypeMap, ItemType, TemplateResponseItemEntryMap, TemplateResponseLinkedItemEntryMap } from '../types';
 export declare class ItemAdministrator {
     private apiRequestService;
     private authInterface;
@@ -73,7 +73,7 @@ export declare class ItemAdministrator {
     getItemByDef(definition: any, isRoot: boolean): Promise<any>;
     cloneItem(itemResource: ItemResource, options: any): ItemResource;
     cloneCollection(collectionResource: CollectionResource, options: any, conversionMap: any): CollectionResource;
-    saveCurrentLocalCache(closeTab: boolean, parameters: any, breakupByParent: boolean | undefined, onAfterCreateCallback: any): any;
+    saveCurrentLocalCache(closeTab?: boolean, parameters?: CreateRequestParameterMap, breakupByParent?: boolean, onAfterCreateCallback?: (conversionMap: ItemIdConversionMap) => void): any;
     getCurrentCollections(): CollectionCache;
     getCurrentItems(): ItemCache;
     getCurrentChanges(): {
@@ -91,8 +91,8 @@ export declare class ItemAdministrator {
     removeFromCollections(itemEntries: ItemEntry[], resultCollectionResource?: CollectionResource): ItemResource[] | null;
     saveLocal(itemResource: ItemResource): Promise<any>;
     updateItemIdMap(collectionMap: any, conversionMap: any): void;
-    createCollectionResource(collectionEntry: any, resourceOptions: any, processOptions?: boolean): CollectionResource;
-    createItemResource(itemEntry: any, options: any, isRoot: boolean): ItemResource;
+    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;

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 } from '../types';
+import { CollectionEntryParentIdMap, CreateRequestParameterMap, ItemIdConversionMap } from '../types';
 export declare class LocalCache {
     private errorHandler;
     private lockService;
@@ -41,7 +41,7 @@ export declare class LocalCache {
     detectChanges(): boolean;
     private collectionHasChanges(collectionEntry);
     isLockable(): boolean;
-    save(closeTab: boolean | undefined, parameters: any, breakUpByParent: any, onAfterCreateCallback: any): any;
+    save(closeTab?: boolean, parameters?: CreateRequestParameterMap, breakUpByParent?: boolean, onAfterCreateCallback?: (conversionMap: ItemIdConversionMap) => void): any;
     private executeCallbacks(event, ...args);
     enableChangesWatcher(): void;
     disableChangesWatcher(): void;

package/dist/dist/factories/CreateRequestFactory.d.ts

@@ -6,5 +6,5 @@ export declare class CreateRequestFactory {
     private keyService;
     private requestColumnExpansionFactory;
     constructor(collectionHandler: CollectionHandler, collectionMatcherFactory: CollectionMatcherFactory, keyService: KeyService, requestColumnExpansionFactory: RequestColumnExpansionFactory);
-    construct(compilation: any, collectionEntries: any, parameterMap: any, breakupByParent?: boolean): CreateRequest;
+    construct(compilation: any, collectionEntries: any, parameterMap: any, breakupByParent?: any): CreateRequest;
 }

package/dist/dist/main.d.ts

@@ -3,6 +3,7 @@ import { ApiResponseProcessorFactory, BatchStatusFactory, ChangesCompilationFact
 import { ApiRequestServiceInterface, AuthInterface, ErrorHandlerInterface, LocalCacheManagerInterface, PromiseInterface } from './interfaces';
 export declare class RmCore {
     version: string;
+    noop: typeof noop;
     apiFormatter: ApiFormatter;
     keyService: KeyService;
     queryService: QueryService;

package/dist/dist/models/EditResource.d.ts

@@ -13,7 +13,7 @@ export declare class EditResource extends ItemResource {
     constructor(apiFormatter: ApiFormatter, lockService: LockService, changesProcessor: ChangesProcessor, errorHandler: ErrorHandlerInterface, promiseService: PromiseInterface, entry: ItemEntry, options: any);
     start(): void;
     rollback(): void;
-    commit(initial: any): void;
+    commit(initial?: boolean): void;
     getLocalCopy(): FieldMap | null;
     copyFields(destination?: any): any;
     setFields(values: any, callOnChange: any): this;

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

@@ -28,6 +28,11 @@ export declare type ItemIdConversionMap = {
         [itemId: number]: number;
     };
 };
+export declare type CreateRequestParameterMap = {
+    [itemType: string]: {
+        [itemId: number]: object;
+    };
+};
 export declare type CollectionEntryBatchStatusMap = {
     [status: string]: CollectionEntryParentIdMap;
 };
@@ -45,7 +50,8 @@ export declare type CollectionMatchResult = {
     notfitting: CollectionEntry[];
     maybe: CollectionEntry[];
 };
-export declare type RequestColumns = Array<string | object> | true;
+export declare type RequestColumn = string | object;
+export declare type RequestColumns = RequestColumn[] | true;
 export declare type ResponseColumn = any;
 export declare type ResponseColumnMap = {
     [itemType: string]: {