@rentman/rm-core 6.2.3 → 6.2.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -11,6 +11,18 @@ import { ItemCache } from '../ItemCache';
11
11
  import { AbstractCache } from './AbstractCache';
12
12
  import { ServerItemEntryChanges } from './server/ServerItemHandler';
13
13
  import { TransactionItemEntryChanges } from './transaction/TransactionItemHandler';
14
+ export declare enum ItemCacheStatus {
15
+ CACHED = "cached",
16
+ NOT_CACHED = "not_cached",
17
+ NO_CHANGES = "no_changes"
18
+ }
19
+ export declare type ProcessItemEntryChangesResult<ItemTypeType extends ItemType> = {
20
+ status: ItemCacheStatus.NO_CHANGES | ItemCacheStatus.NOT_CACHED;
21
+ previous: null;
22
+ } | {
23
+ status: ItemCacheStatus.CACHED;
24
+ previous: FieldMap<ItemTypeType>;
25
+ };
14
26
  export declare abstract class ItemHandlerBase {
15
27
  protected columnUtil: ColumnUtil;
16
28
  protected apiFormatter: ApiFormatter;
@@ -48,7 +60,7 @@ export declare abstract class ItemHandlerBase {
48
60
  * @description
49
61
  * Processes the passed {@link ChangesDeltaItemUpdateDelta update delta} on the transaction, if there are no {@link TransactionItemHandler.itemChanges itemChanges} the new values will not be processed
50
62
  */
51
- abstract processItemEntryChanges<ItemTypeType extends ItemType>(itemEntryChangesTuple: ChangesDeltaItemUpdateDelta<ItemTypeType>, forceOverwrite: boolean, updateInitial: boolean, isCalledAfterSocketUpdate: boolean, createItemChangesIfNoneExist: boolean): FieldMap<ItemTypeType> | null;
63
+ abstract processItemEntryChanges<ItemTypeType extends ItemType>(itemEntryChangesTuple: ChangesDeltaItemUpdateDelta<ItemTypeType>, forceOverwrite: boolean, updateInitial: boolean, isCalledAfterSocketUpdate: boolean, createItemChangesIfNoneExist: boolean): ProcessItemEntryChangesResult<ItemTypeType>;
52
64
  /**
53
65
  * @description
54
66
  * Traverses the column path and returns the fields of the derived item, returns undefined if the item isn't found
@@ -6,7 +6,7 @@ import { ChangesDelta } from '../../ChangesDelta';
6
6
  import { ChangesDeltaItemUpdateDelta } from '../../ChangesDeltaBase';
7
7
  import { ChangesDeltaItemCreateDelta } from '../../CreatedChangesDelta';
8
8
  import { ApiFormatter, ApiResponseProcessor, ColumnExpansion, ColumnSet, ColumnUtil, QueryService, RequestBufferManager, RequestBufferResponse, TransactionItemEntryChanges } from '../../index';
9
- import { ItemHandlerBase } from '../ItemHandlerBase';
9
+ import { ItemHandlerBase, ProcessItemEntryChangesResult } from '../ItemHandlerBase';
10
10
  import { ServerCache } from './ServerCache';
11
11
  export declare type ServerItemEntryChanges<ItemTypeType extends ItemType = any> = FieldMap<ItemTypeType>;
12
12
  export declare class ServerItemHandler extends ItemHandlerBase {
@@ -24,7 +24,7 @@ export declare class ServerItemHandler extends ItemHandlerBase {
24
24
  * @description
25
25
  * Processes updates on a cached entry
26
26
  */
27
- processItemEntryChanges<ItemTypeType extends ItemType = any>(itemEntryChangesTuple: ChangesDeltaItemUpdateDelta<ItemTypeType>, _forceOverwrite?: boolean, _updateInitial?: boolean, _isCalledAfterSocketUpdate?: boolean, _createItemChangesIfNoneExist?: boolean): FieldMap<ItemTypeType> | null;
27
+ processItemEntryChanges<ItemTypeType extends ItemType = any>(itemEntryChangesTuple: ChangesDeltaItemUpdateDelta<ItemTypeType>, _forceOverwrite?: boolean, _updateInitial?: boolean, _isCalledAfterSocketUpdate?: boolean, _createItemChangesIfNoneExist?: boolean): ProcessItemEntryChangesResult<ItemTypeType>;
28
28
  copyTransactionItemEntryChanges(itemEntryChanges: TransactionItemEntryChanges, entry: ItemEntry): ServerItemEntryChanges;
29
29
  fetchItemEntry<ItemTypeType extends ItemType>(itemType: ItemTypeType, itemId: ItemId, options: ItemEntryOptions): PromiseInterface<ItemEntry<ItemTypeType>>;
30
30
  fetchItemEntriesByQuery<ItemTypeType extends ItemType>(itemType: ItemTypeType, query: ApiQuery, entryOptions: ItemEntryOptions): PromiseInterface<Array<ItemEntry<ItemTypeType>>>;
@@ -4,7 +4,7 @@ import { ApiQuery, ApiRequestColumns, DeregFunction, FieldChangeCallback, FieldM
4
4
  import { ChangesDelta } from '../../ChangesDelta';
5
5
  import { ChangesDeltaBase, ChangesDeltaItemUpdateDelta, ChangesDeltaResult } from '../../ChangesDeltaBase';
6
6
  import { ChangesDeltaItemCreateDelta, ColumnSubsetCache } from '../../index';
7
- import { ItemHandlerBase } from '../ItemHandlerBase';
7
+ import { ItemHandlerBase, ProcessItemEntryChangesResult } from '../ItemHandlerBase';
8
8
  import { TransactionCache } from './TransactionCache';
9
9
  import { TransactionValidator } from './TransactionValidator';
10
10
  export declare type TransactionItemEntryChanges<ItemTypeType extends ItemType = any> = {
@@ -61,7 +61,7 @@ export declare class TransactionItemHandler extends ItemHandlerBase {
61
61
  * @returns
62
62
  * The previous changes {@link FieldMap FieldMap}, returns `null` when the item was not cached or no fields were changed.
63
63
  */
64
- processItemEntryChanges<ItemTypeType extends ItemType = any>(itemEntryChangesTuple: ChangesDeltaItemUpdateDelta<ItemTypeType>, forceOverwrite?: boolean, updateInitial?: boolean, isCalledAfterSocketUpdate?: boolean, createItemChangesIfNoneExist?: boolean): FieldMap<ItemTypeType> | null;
64
+ processItemEntryChanges<ItemTypeType extends ItemType = any>(itemEntryChangesTuple: ChangesDeltaItemUpdateDelta<ItemTypeType>, forceOverwrite?: boolean, updateInitial?: boolean, isCalledAfterSocketUpdate?: boolean, createItemChangesIfNoneExist?: boolean): ProcessItemEntryChangesResult<ItemTypeType>;
65
65
  cloneItemEntries<ItemTypeType extends ItemType>(changesDelta: ChangesDelta, itemEntries: Array<ItemEntry<ItemTypeType>>, conversionMap?: ItemIdConversionMap, modifyFieldsCallback?: ModifyFieldsCallback): ItemId[];
66
66
  cloneItemEntry<ItemTypeType extends ItemType>(changesDelta: ChangesDelta, sourceEntry: ItemEntry<ItemTypeType>, conversionMap?: ItemIdConversionMap, modifyFieldsCallback?: ModifyFieldsCallback): ItemId;
67
67
  fetchItemEntriesByQuery<ItemTypeType extends ItemType>(itemType: ItemTypeType, query: ApiQuery, entryOptions: ItemEntryOptions): PromiseInterface<Array<ItemEntry<ItemTypeType>>>;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@rentman/rm-core",
3
- "version": "6.2.3",
3
+ "version": "6.2.4",
4
4
  "description": "Rentman core functionalities",
5
5
  "main": "./dist/rm-core.js",
6
6
  "types": "./dist/types/index.d.ts",