@rentman/rm-core 59.4.0 → 59.5.0-RM4-44763
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.
- package/dist/rm-core.js +1 -1
- package/dist/rm-core.js.map +1 -1
- package/dist/types/src/classes/ApiRequestService.d.ts +0 -3
- package/dist/types/src/classes/ChangesCompilation.d.ts +0 -7
- package/dist/types/src/classes/ChangesDelta.d.ts +1 -6
- package/dist/types/src/classes/ChangesProcessor.d.ts +3 -7
- package/dist/types/src/classes/ChildChangesDelta.d.ts +1 -12
- package/dist/types/src/classes/cache/transaction/TransactionCache.d.ts +5 -0
- package/dist/types/src/classes/cache/transaction/TransactionEventHandler.d.ts +1 -0
- package/dist/types/src/interfaces/ApiRequestServiceInterface.d.ts +1 -2
- package/dist/types/src/types/ItemTypesCollection.d.ts +0 -3
- package/package.json +1 -1
|
@@ -9,9 +9,6 @@ export declare class ApiRequestService {
|
|
|
9
9
|
delete<ItemTypeType extends ApiItemType>(itemType: ApiItemType, itemIds: ItemId[], uniqueTransactionId?: string): Promise<ApiResponseProcessor<ItemTypeType>>;
|
|
10
10
|
updateItems<ItemTypeType extends ApiItemType>(itemType: ItemTypeType, items: ApiRequestItemMap, columns: ApiRequestColumnMap, uniqueTransactionId?: string): Promise<ApiResponseProcessor<ItemTypeType>>;
|
|
11
11
|
requestSkeleton<ItemTypeType extends ApiItemType = ApiItemType>(params: any, requestCanceler?: Promise<any>): Promise<ApiResponseProcessor<ItemTypeType>>;
|
|
12
|
-
moveItems<ItemTypeType extends ApiItemType>(parentType: ItemTypeType, parentId: ItemId, items: {
|
|
13
|
-
[itemType: string]: ItemId[];
|
|
14
|
-
}, uniqueTransactionId?: string): Promise<ApiResponseProcessor<ItemTypeType>>;
|
|
15
12
|
columns<ItemTypeType extends ApiItemType>(itemType: ItemTypeType, columns: {
|
|
16
13
|
[itemType: string]: ApiRequestColumns | true;
|
|
17
14
|
}, params?: any): Promise<ApiResponseProcessor<ItemTypeType>>;
|
|
@@ -10,23 +10,16 @@ export type DeleteCompilation = {
|
|
|
10
10
|
[itemType: string]: ItemEntry[];
|
|
11
11
|
};
|
|
12
12
|
export type UpdateCompilation = ItemEntryMap;
|
|
13
|
-
export type MoveCompilation = {
|
|
14
|
-
[parentType: string]: {
|
|
15
|
-
[parentId: number]: ItemEntry[];
|
|
16
|
-
};
|
|
17
|
-
};
|
|
18
13
|
export declare class ChangesCompilation {
|
|
19
14
|
private transaction;
|
|
20
15
|
compilation: {
|
|
21
16
|
create: CreateCompilation;
|
|
22
17
|
delete: DeleteCompilation;
|
|
23
18
|
update: UpdateCompilation;
|
|
24
|
-
move: MoveCompilation;
|
|
25
19
|
};
|
|
26
20
|
constructor(transaction: TransactionCache);
|
|
27
21
|
private processDelta;
|
|
28
22
|
private getDefaultParent;
|
|
29
|
-
private addMoveEntry;
|
|
30
23
|
private addDeleteEntry;
|
|
31
24
|
private addUpdateEntry;
|
|
32
25
|
private addCreateEntry;
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { ApiFields, ApiItemType, ItemId } from '@rentman/backend-types';
|
|
2
|
-
import { ChangesDeltaBase, ChangesDeltaBaseItemDeleteDelta, ChangesDeltaBaseItemUpdateDelta, ChangesDeltaItemCreateDelta, ChangesDeltaItemUpdateMode, ColumnExpansion, ColumnSet, CreatedChangesDelta,
|
|
2
|
+
import { ChangesDeltaBase, ChangesDeltaBaseItemDeleteDelta, ChangesDeltaBaseItemUpdateDelta, ChangesDeltaItemCreateDelta, ChangesDeltaItemUpdateMode, ColumnExpansion, ColumnSet, CreatedChangesDelta, EntryParentNull, ErrorHandlerInterface, FieldMap, ItemCreateService, ItemEntry, ItemEntryChangesTuple, ItemEntryService, RequestParameters } from '../internal';
|
|
3
3
|
export interface ChangesDeltaItemDeleteDelta<ItemTypeType extends ApiItemType> extends ChangesDeltaBaseItemDeleteDelta<ItemTypeType> {
|
|
4
4
|
isCascaded: boolean;
|
|
5
5
|
}
|
|
@@ -75,11 +75,6 @@ export declare class ChangesDelta extends ChangesDeltaBase<ChangesDeltaItemDelet
|
|
|
75
75
|
* @internal
|
|
76
76
|
*/
|
|
77
77
|
_setItemCreated<ItemTypeType extends ApiItemType, Fields extends Partial<FieldMap<ItemTypeType>>>(itemId: ItemId, fields: Fields, columns: ColumnSet<ItemTypeType>, parent?: EntryParentNull, isRoot?: boolean, isApiResponse?: boolean): this;
|
|
78
|
-
/**
|
|
79
|
-
* @description
|
|
80
|
-
* Convenience function to assign the proper parent fields, will call {@link ChangesDeltaBase.setItemUpdated setItemUpdated} internally
|
|
81
|
-
*/
|
|
82
|
-
setItemMoved<ItemTypeType extends ApiItemType>(entry: ItemEntry<ItemTypeType>, to: EntryParent): this;
|
|
83
78
|
setItemRestored<ItemTypeType extends ApiItemType>(itemEntry: ItemEntry<ItemTypeType>, transactionItemEntryChanges: FieldMap<ItemTypeType>): void;
|
|
84
79
|
isEmpty(): boolean;
|
|
85
80
|
toJSON(): any;
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { ApiRequestService, ChangesCompilationFactory, ChangesDeltaFactory, ErrorHandlerInterface,
|
|
1
|
+
import { ApiRequestService, ChangesCompilationFactory, ChangesDeltaFactory, ErrorHandlerInterface, ItemIdConversionMap, RequestBufferManager, RequestColumnExpansionFactory, TransactionCache } from '../internal';
|
|
2
2
|
export type OnAfterCreateCallback = (conversionMap: ItemIdConversionMap) => void;
|
|
3
3
|
/**
|
|
4
4
|
* @description
|
|
@@ -9,7 +9,6 @@ export declare class ChangesProcessor {
|
|
|
9
9
|
private changesCompilationFactory;
|
|
10
10
|
private changesDeltaFactory;
|
|
11
11
|
private errorHandler;
|
|
12
|
-
private itemEntryService;
|
|
13
12
|
private requestBufferManager;
|
|
14
13
|
private requestColumnExpansionFactory;
|
|
15
14
|
private transaction;
|
|
@@ -17,17 +16,15 @@ export declare class ChangesProcessor {
|
|
|
17
16
|
private onAfterCreateCallback?;
|
|
18
17
|
private itemIdConversionMap;
|
|
19
18
|
private serverCache;
|
|
20
|
-
constructor(apiRequestService: ApiRequestService, changesCompilationFactory: ChangesCompilationFactory, changesDeltaFactory: ChangesDeltaFactory, errorHandler: ErrorHandlerInterface,
|
|
19
|
+
constructor(apiRequestService: ApiRequestService, changesCompilationFactory: ChangesCompilationFactory, changesDeltaFactory: ChangesDeltaFactory, errorHandler: ErrorHandlerInterface, requestBufferManager: RequestBufferManager, requestColumnExpansionFactory: RequestColumnExpansionFactory, transaction: TransactionCache, breakUpByParent?: boolean | undefined, onAfterCreateCallback?: OnAfterCreateCallback | undefined);
|
|
21
20
|
/**
|
|
22
21
|
* @description
|
|
23
22
|
* Executes the requests in the order of:
|
|
24
23
|
* 1. create
|
|
25
|
-
* 2.
|
|
24
|
+
* 2. update
|
|
26
25
|
* 3. delete
|
|
27
|
-
* 4. update
|
|
28
26
|
*/
|
|
29
27
|
execute(): Promise<ItemIdConversionMap>;
|
|
30
|
-
private buildMoveRequest;
|
|
31
28
|
private getMapValue;
|
|
32
29
|
private executeCreateRequests;
|
|
33
30
|
private executeCreateRequest;
|
|
@@ -35,5 +32,4 @@ export declare class ChangesProcessor {
|
|
|
35
32
|
private executeUpdateRequest;
|
|
36
33
|
private executeDeleteRequests;
|
|
37
34
|
private executeDeleteRequest;
|
|
38
|
-
private executeMoveRequests;
|
|
39
35
|
}
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { ApiItemType } from '@rentman/backend-types';
|
|
2
|
-
import { ChangesDeltaBase, ChangesDeltaBaseItemDeleteDelta, ChangesDeltaBaseItemUpdateDelta, ChangesDeltaItemUpdateMode,
|
|
2
|
+
import { ChangesDeltaBase, ChangesDeltaBaseItemDeleteDelta, ChangesDeltaBaseItemUpdateDelta, ChangesDeltaItemUpdateMode, FieldMap, ItemEntry, ItemEntryService } from '../internal';
|
|
3
3
|
export type ChildChangesDeltaItemCreateDelta<ItemTypeType extends ApiItemType = any> = {
|
|
4
4
|
entry: ItemEntry<ItemTypeType>;
|
|
5
5
|
fields: FieldMap<ItemTypeType>;
|
|
@@ -29,21 +29,10 @@ export declare class ChildChangesDelta extends ChangesDeltaBase<ChildChangesDelt
|
|
|
29
29
|
created: {
|
|
30
30
|
[itemEntryId: string]: ChildChangesDeltaItemCreateDelta;
|
|
31
31
|
};
|
|
32
|
-
moved: {
|
|
33
|
-
[itemEntryId: number]: {
|
|
34
|
-
entry: ItemEntry;
|
|
35
|
-
to: EntryParent;
|
|
36
|
-
};
|
|
37
|
-
};
|
|
38
32
|
constructor(itemEntryService: ItemEntryService);
|
|
39
33
|
setItemUpdated<ItemTypeType extends ApiItemType>(entry: ItemEntry<ItemTypeType>, fields: Readonly<Partial<FieldMap<ItemTypeType>>>, mode?: ChangesDeltaItemUpdateMode): this;
|
|
40
34
|
setItemDeleted(tuple: ChildChangesDeltaItemDeleteDelta<any>): this;
|
|
41
35
|
setItemsDeleted(deleted: ChildChangesDeltaItemDeleteDelta<any>[]): this;
|
|
42
36
|
setItemCreated<ItemTypeType extends ApiItemType>(itemEntry: ItemEntry<ItemTypeType>, fields: Partial<FieldMap<ItemTypeType>>): void;
|
|
43
|
-
/**
|
|
44
|
-
* @remark
|
|
45
|
-
* Parent fields are non-writable so we need to keep track of moved entries another way (to do a linkTo request)
|
|
46
|
-
*/
|
|
47
|
-
setItemMoved(entry: ItemEntry, to: EntryParent): void;
|
|
48
37
|
isEmpty(): boolean;
|
|
49
38
|
}
|
|
@@ -233,6 +233,11 @@ export declare class TransactionCache extends AbstractCache {
|
|
|
233
233
|
* Adds a callback that will fire when the transaction is saved successfully
|
|
234
234
|
*/
|
|
235
235
|
onSaveSuccess(key: string, callback: TransactionCacheCallbackType['onSaveSuccess'], condition?: TransactionCacheCallbackCondition, priority?: number): () => void;
|
|
236
|
+
/**
|
|
237
|
+
* @description
|
|
238
|
+
* Adds a callback that will fire when the root item of the transaction is deleted
|
|
239
|
+
*/
|
|
240
|
+
onRootItemDeleted(key: string, callback: TransactionCacheCallbackType['onRootItemDelete'], condition?: TransactionCacheCallbackCondition, priority?: number): () => void;
|
|
236
241
|
/**
|
|
237
242
|
* @description
|
|
238
243
|
* Returns a {@link ModuleChangesCompilationResult ModuleChangesCompilationResult} for the transaction
|
|
@@ -3,6 +3,7 @@ export type TransactionCacheCallbackCondition = 'always' | 'onClose' | 'skipOnCl
|
|
|
3
3
|
export type TransactionCacheCallbackType = {
|
|
4
4
|
onBeforeSave: (transaction: TransactionCache) => any;
|
|
5
5
|
onSaveSuccess: (transaction: TransactionCache, conversionMap: ItemIdConversionMap) => any;
|
|
6
|
+
onRootItemDelete: () => any;
|
|
6
7
|
};
|
|
7
8
|
export declare class TransactionEventHandler {
|
|
8
9
|
private errorHandler;
|
|
@@ -1,12 +1,11 @@
|
|
|
1
1
|
import { ApiItemType, ItemId } from '@rentman/backend-types';
|
|
2
|
-
import { ApiRequestColumnMap, ApiRequestColumns, ApiRequestItemMap, ApiRequestLimit
|
|
2
|
+
import { ApiRequestColumnMap, ApiRequestColumns, ApiRequestItemMap, ApiRequestLimit } from '../internal';
|
|
3
3
|
export interface ApiRequestServiceInterface {
|
|
4
4
|
template(itemType: ApiItemType, params: any): Promise<any>;
|
|
5
5
|
create(itemType: ApiItemType, itemId: ItemId, values: any, columns: ApiRequestColumnMap, parentType?: ApiItemType, parentId?: ItemId, uniqueTransactionId?: string): Promise<any>;
|
|
6
6
|
delete(itemType: ApiItemType, itemIds: ItemId[], uniqueTransactionId?: string): Promise<any>;
|
|
7
7
|
updateItems(itemType: ApiItemType, items: ApiRequestItemMap, columns: ApiRequestColumnMap, uniqueTransactionId?: string): Promise<any>;
|
|
8
8
|
requestSkeleton(params: any, requestCanceler?: Promise<any>): Promise<any>;
|
|
9
|
-
moveItems(parentType: ApiItemType, parentId: ItemId, items: ApiRequestMoveItems, uniqueTransactionId?: string): Promise<any>;
|
|
10
9
|
columns(itemType: ApiItemType, columns: {
|
|
11
10
|
[itemType: string]: ApiRequestColumns | true;
|
|
12
11
|
}, params?: any): Promise<any>;
|
|
@@ -261,9 +261,6 @@ export type ApiRequestColumnMap = {
|
|
|
261
261
|
export type ApiRequestColumnArrayMap = {
|
|
262
262
|
[itemType in ApiItemType]?: ApiRequestColumnArray;
|
|
263
263
|
};
|
|
264
|
-
export type ApiRequestMoveItems = {
|
|
265
|
-
[itemType: string]: ItemId[];
|
|
266
|
-
};
|
|
267
264
|
export type ApiRequestLimit<ItemTypeType extends ApiItemType = any> = {
|
|
268
265
|
field: ItemTypeColumnId<ItemTypeType>;
|
|
269
266
|
order?: 'desc' | 'asc';
|