@rentman/rm-core 12.1.1 → 12.1.3

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

@@ -1,11 +1,6 @@
-import { ApiEnumApiType, ApiEnumItemType, ApiFields, ResponseColumn } from '@rentman/backend-types';
+import { ApiEnumApiType, ApiEnumItemType } from '@rentman/backend-types';
 import moment from 'moment';
 import { ApiEnumApiTypeToTsTypeMap, ColumnInfo, FieldMap, ItemTypeColumnIds } from '../internal';
-declare type GetChangesResult<ItemTypeType extends ApiEnumItemType = any, ColumnId extends keyof ApiFields[ItemTypeType] = any> = {
-    oldValue: FieldMap<ItemTypeType, [ColumnId]>[ColumnId];
-    newValue: FieldMap<ItemTypeType, [ColumnId]>[ColumnId];
-    column: ResponseColumn<ItemTypeType, ColumnId>;
-};
 /**
  * @description
  * A service which provides functions to transform data that comes from/goes to the API
@@ -29,24 +24,10 @@ export declare class ApiFormatter {
      * Currently only used for Moment objects
      */
     isExpensiveFormat(columnType: ApiEnumApiType): boolean;
-    /**
-     * @description
-     * Overwrites the values in 'changes' if the values in 'initial' and 'changes' are the same and the parent transaction
-     * copied over the field (leaving user changes intact)
-     *
-     * We have to check the parent transaction because on a child transaction initial/modified can be equal (the copied field of the parent)
-     * and will then incorrectly be overwritten by applyChangesFromParent
-     *
-     * Note: parentChanges can be undefined for local items
-     */
-    mergeCopyFields<ItemTypeType extends ApiEnumItemType, ColumnIds extends ItemTypeColumnIds<ItemTypeType> = any>(parentChanges: FieldMap<ItemTypeType, ColumnIds> | undefined, changes: FieldMap<ItemTypeType, ColumnIds>, initial: FieldMap<ItemTypeType, ColumnIds>, newInitial: FieldMap<ItemTypeType, ColumnIds>, columns: ColumnInfo<ItemTypeType>[]): FieldMap<ItemTypeType, ColumnIds>;
     formatRequestLocal<ItemTypeType extends ApiEnumItemType>(fields: FieldMap<ItemTypeType>, columns: ColumnInfo<ItemTypeType>[]): {
         [columnId: string]: any;
     };
-    hasChanges<ItemTypeType extends ApiEnumItemType>(initial: FieldMap<ItemTypeType>, modified: FieldMap<ItemTypeType>, columns: ColumnInfo<ItemTypeType>[], includeReadOnlyColumns?: boolean, forceCompare?: boolean): boolean;
-    getChanges<ItemTypeType extends ApiEnumItemType = any, ColumnIds extends ItemTypeColumnIds<ItemTypeType> = any>(initial: FieldMap<ItemTypeType, ColumnIds>, modified: FieldMap<ItemTypeType, ColumnIds>, columns: ColumnInfo<ItemTypeType, ColumnIds[number]>[]): GetChangesResult<ItemTypeType, ColumnIds[number]>[];
     copyFields<ItemTypeType extends ApiEnumItemType = any, ColumnIds extends ItemTypeColumnIds<ItemTypeType> = any>(source: Partial<FieldMap<ItemTypeType, ColumnIds>>, destination: Partial<FieldMap<ItemTypeType>>, columns: ColumnInfo<ItemTypeType, ColumnIds[number]>[]): FieldMap<ItemTypeType, ColumnIds>;
-    shallowCopyFields<ItemTypeType extends ApiEnumItemType>(shallowSource: FieldMap<ItemTypeType>, deepSource: FieldMap<ItemTypeType>, destination: FieldMap<ItemTypeType>, columns: ColumnInfo<ItemTypeType>[]): FieldMap<ItemTypeType>;
     setDefaultValues<ItemTypeType extends ApiEnumItemType = any>(destination: FieldMap<ItemTypeType>, columns: ColumnInfo<ItemTypeType>[]): FieldMap<ItemTypeType>;
     /**
      * @description
@@ -73,4 +54,3 @@ export declare class ApiFormatter {
     cloneDate(date: moment.Moment): moment.Moment;
     identity<T>(input: T): T;
 }
-export {};

package/dist/types/src/classes/ChangesDeltaBase.d.ts

@@ -5,10 +5,25 @@ export declare type ChangesDeltaResult = {
     created: ItemEntry[];
 };
 export declare enum ChangesDeltaItemUpdateMode {
+    /**
+     * For create/update responses you always want to overwrite whatever is cached
+     */
     CLEAR_ALWAYS = "overwrite",
+    /**
+     * For socket messages you want to clear the user's changes if they are the same as what is received
+     */
     CLEAR_WHEN_SAME = "same",
+    /**
+     * For user changes you want to store them if they are different than on a parent
+     */
     KEEP_WHEN_DIFFERENT = "different",
+    /**
+     * Used when expanding local items
+     */
     APPEND = "append",
+    /**
+     * Used for query responses (you don't want to do anything with user changes)
+     */
     QUERY = "query"
 }
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rentman/rm-core",
-  "version": "12.1.1",
+  "version": "12.1.3",
   "description": "Rentman core functionalities",
   "main": "./dist/rm-core.js",
   "types": "./dist/types/src/index.d.ts",