@rentman/rm-core 9.2.1 → 9.2.3

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.
Files changed (106) hide show
  1. package/changelog.md +1341 -1005
  2. package/dist/rm-core.js +1815 -1643
  3. package/dist/rm-core.min.js +1 -1
  4. package/dist/types/classes/ApiFormatter.d.ts +73 -73
  5. package/dist/types/classes/ApiRequestService.d.ts +18 -18
  6. package/dist/types/classes/ApiResponseProcessor.d.ts +29 -29
  7. package/dist/types/classes/CacheSyncer.d.ts +44 -44
  8. package/dist/types/classes/ChangesCompilation.d.ts +33 -33
  9. package/dist/types/classes/ChangesDelta.d.ts +61 -61
  10. package/dist/types/classes/ChangesDeltaBase.d.ts +78 -78
  11. package/dist/types/classes/ChangesProcessor.d.ts +40 -40
  12. package/dist/types/classes/CollectionEntryService.d.ts +24 -24
  13. package/dist/types/classes/CollectionResourceService.d.ts +6 -6
  14. package/dist/types/classes/ColumnCache.d.ts +19 -19
  15. package/dist/types/classes/ColumnExpansion.d.ts +19 -19
  16. package/dist/types/classes/ColumnHandler.d.ts +20 -20
  17. package/dist/types/classes/ColumnInfo.d.ts +15 -15
  18. package/dist/types/classes/ColumnSet.d.ts +37 -37
  19. package/dist/types/classes/ColumnSubsetCache.d.ts +14 -14
  20. package/dist/types/classes/ColumnUtil.d.ts +108 -101
  21. package/dist/types/classes/ConversionMapService.d.ts +25 -25
  22. package/dist/types/classes/CreateRequest.d.ts +17 -17
  23. package/dist/types/classes/CreatedChangesDelta.d.ts +17 -17
  24. package/dist/types/classes/InternalChangesDelta.d.ts +43 -43
  25. package/dist/types/classes/ItemCache.d.ts +27 -27
  26. package/dist/types/classes/ItemCreateService.d.ts +18 -18
  27. package/dist/types/classes/ItemEntryService.d.ts +32 -32
  28. package/dist/types/classes/KeyService.d.ts +18 -18
  29. package/dist/types/classes/LockService.d.ts +29 -29
  30. package/dist/types/classes/ModuleChangesCompilation.d.ts +18 -18
  31. package/dist/types/classes/ParentChangesDelta.d.ts +39 -39
  32. package/dist/types/classes/QueryColumnExtractor.d.ts +18 -18
  33. package/dist/types/classes/QueryContainsLocalIdParser.d.ts +17 -17
  34. package/dist/types/classes/QueryLinkedToParser.d.ts +17 -17
  35. package/dist/types/classes/QueryLocallyMatchableParser.d.ts +20 -20
  36. package/dist/types/classes/QueryMatcher.d.ts +24 -24
  37. package/dist/types/classes/QueryParser.d.ts +25 -25
  38. package/dist/types/classes/QueryParserBase.d.ts +20 -20
  39. package/dist/types/classes/QueryParserIdUpdater.d.ts +17 -17
  40. package/dist/types/classes/QueryService.d.ts +12 -12
  41. package/dist/types/classes/RequestBuffer.d.ts +24 -24
  42. package/dist/types/classes/RequestBufferManager.d.ts +32 -32
  43. package/dist/types/classes/RequestColumnExpansion.d.ts +15 -15
  44. package/dist/types/classes/SocketMessageHandler.d.ts +34 -34
  45. package/dist/types/classes/TemplateCache.d.ts +62 -62
  46. package/dist/types/classes/Util.d.ts +28 -28
  47. package/dist/types/classes/cache/AbstractCache.d.ts +85 -85
  48. package/dist/types/classes/cache/CachedQueryHandlerBase.d.ts +68 -68
  49. package/dist/types/classes/cache/ItemHandlerBase.d.ts +102 -102
  50. package/dist/types/classes/cache/server/ServerCache.d.ts +78 -78
  51. package/dist/types/classes/cache/server/ServerCachedQueryHandler.d.ts +25 -25
  52. package/dist/types/classes/cache/server/ServerItemHandler.d.ts +43 -43
  53. package/dist/types/classes/cache/transaction/TransactionCache.d.ts +318 -318
  54. package/dist/types/classes/cache/transaction/TransactionCachedQueryHandler.d.ts +37 -36
  55. package/dist/types/classes/cache/transaction/TransactionCollectionHandler.d.ts +24 -24
  56. package/dist/types/classes/cache/transaction/TransactionEventHandler.d.ts +21 -21
  57. package/dist/types/classes/cache/transaction/TransactionItemHandler.d.ts +90 -90
  58. package/dist/types/classes/cache/transaction/TransactionValidator.d.ts +33 -33
  59. package/dist/types/constants.d.ts +7 -7
  60. package/dist/types/core.d.ts +45 -45
  61. package/dist/types/factories/ApiResponseProcessorFactory.d.ts +6 -6
  62. package/dist/types/factories/CacheSyncerFactory.d.ts +10 -10
  63. package/dist/types/factories/ChangesCompilationFactory.d.ts +5 -5
  64. package/dist/types/factories/ChangesDeltaFactory.d.ts +13 -13
  65. package/dist/types/factories/ChangesProcessorFactory.d.ts +13 -13
  66. package/dist/types/factories/CollectionEntryFactory.d.ts +11 -11
  67. package/dist/types/factories/CollectionResourceFactory.d.ts +18 -18
  68. package/dist/types/factories/ColumnExpansionFactory.d.ts +7 -7
  69. package/dist/types/factories/ColumnInfoFactory.d.ts +7 -7
  70. package/dist/types/factories/ColumnSetFactory.d.ts +18 -18
  71. package/dist/types/factories/ColumnSubsetCacheFactory.d.ts +8 -8
  72. package/dist/types/factories/CreateRequestFactory.d.ts +9 -9
  73. package/dist/types/factories/ItemCacheFactory.d.ts +6 -6
  74. package/dist/types/factories/ItemEntryFactory.d.ts +12 -12
  75. package/dist/types/factories/ItemResourceFactory.d.ts +11 -11
  76. package/dist/types/factories/ModuleChangesCompilationFactory.d.ts +4 -4
  77. package/dist/types/factories/QueryMatcherFactory.d.ts +7 -7
  78. package/dist/types/factories/QueryParserFactory.d.ts +5 -5
  79. package/dist/types/factories/RequestColumnExpansionFactory.d.ts +8 -8
  80. package/dist/types/factories/TemplateFactory.d.ts +8 -8
  81. package/dist/types/factories/TransactionCacheFactory.d.ts +13 -13
  82. package/dist/types/index.d.ts +1 -1
  83. package/dist/types/interfaces/AbstractCacheDependencyInterface.d.ts +36 -36
  84. package/dist/types/interfaces/ApiRequestServiceInterface.d.ts +12 -12
  85. package/dist/types/interfaces/AuthInterface.d.ts +10 -10
  86. package/dist/types/interfaces/ErrorHandlerInterface.d.ts +5 -5
  87. package/dist/types/interfaces/ExceptionHandlerInterface.d.ts +3 -3
  88. package/dist/types/interfaces/LinkTreeServiceInterface.d.ts +4 -4
  89. package/dist/types/interfaces/PromiseLibraryInterface.d.ts +25 -25
  90. package/dist/types/interfaces/ServerCacheDependencyInterface.d.ts +5 -5
  91. package/dist/types/interfaces/SocketMessageInterface.d.ts +3 -3
  92. package/dist/types/interfaces/TransactionCollectionHandlerDependencyInterface.d.ts +17 -17
  93. package/dist/types/interfaces/TransactionItemHandlerDependencyInterface.d.ts +22 -22
  94. package/dist/types/internal.d.ts +104 -104
  95. package/dist/types/models/CachedQueryItem.d.ts +19 -19
  96. package/dist/types/models/CollectionEntry.d.ts +21 -21
  97. package/dist/types/models/CollectionOptions.d.ts +44 -44
  98. package/dist/types/models/CollectionResource.d.ts +87 -87
  99. package/dist/types/models/ItemEntry.d.ts +18 -18
  100. package/dist/types/models/ItemEntryOptions.d.ts +8 -8
  101. package/dist/types/models/ItemResource.d.ts +90 -90
  102. package/dist/types/models/Template.d.ts +11 -11
  103. package/dist/types/types/ItemTypesCollection.d.ts +345 -345
  104. package/dist/types/types/PromiseInterface.d.ts +2 -2
  105. package/package.json +50 -50
  106. package/readme.md +15 -15
@@ -1,32 +1,32 @@
1
- import { ApiEnumItemType, ApiQuery, ItemId } from '@rentman/backend-types';
2
- import { ApiRequestColumns, ApiRequestService, ChangesDeltaFactory, KeyService, PromiseInterface, PromiseLibraryInterface, RequestBufferResponse, RequestColumnExpansionFactory, ServerCache } from '../internal';
3
- /**
4
- * @description
5
- * Allows to have finer control over the RequestBuffer and to merge specific requests
6
- *
7
- * @param maxTimeout The maximum timeout to wait (if expectedSize is not reached) before doing the query anyways.
8
- * @param expectedSize The amount of items expected to be in the query, when this amount is reached the buffer will flush before the maxTimeout is reached.
9
- */
10
- export declare type RequestBufferManagerPrioritySettings = {
11
- maxTimeout: number;
12
- expectedSize: number;
13
- };
14
- export declare class RequestBufferManager {
15
- private promiseLibrary;
16
- private apiRequestService;
17
- private requestColumnExpansionFactory;
18
- private keyService;
19
- private changesDeltaFactory;
20
- private pendingBufferMap;
21
- private pendingTrueBufferMap;
22
- private pendingPriorityBufferMap;
23
- private serverCache;
24
- constructor(promiseLibrary: PromiseLibraryInterface, apiRequestService: ApiRequestService, requestColumnExpansionFactory: RequestColumnExpansionFactory, keyService: KeyService, changesDeltaFactory: ChangesDeltaFactory);
25
- setServerCache(serverCache: ServerCache): void;
26
- fetchByIds(itemType: ApiEnumItemType, itemIds: ItemId[], requestColumns: ApiRequestColumns): PromiseInterface<RequestBufferResponse>;
27
- fetchById(itemType: ApiEnumItemType, itemId: ItemId, requestColumns: ApiRequestColumns): PromiseInterface<RequestBufferResponse>;
28
- fetchByQuery(itemType: ApiEnumItemType, query: [ApiQuery, string], requestColumns: ApiRequestColumns, priorityBufferSettings: RequestBufferManagerPrioritySettings | null): PromiseInterface<RequestBufferResponse>;
29
- private constructPriorityBuffer;
30
- private constructBuffer;
31
- private _constructBuffer;
32
- }
1
+ import { ApiEnumItemType, ApiQuery, ItemId } from '@rentman/backend-types';
2
+ import { ApiRequestColumns, ApiRequestService, ChangesDeltaFactory, KeyService, PromiseInterface, PromiseLibraryInterface, RequestBufferResponse, RequestColumnExpansionFactory, ServerCache } from '../internal';
3
+ /**
4
+ * @description
5
+ * Allows to have finer control over the RequestBuffer and to merge specific requests
6
+ *
7
+ * @param maxTimeout The maximum timeout to wait (if expectedSize is not reached) before doing the query anyways.
8
+ * @param expectedSize The amount of items expected to be in the query, when this amount is reached the buffer will flush before the maxTimeout is reached.
9
+ */
10
+ export declare type RequestBufferManagerPrioritySettings = {
11
+ maxTimeout: number;
12
+ expectedSize: number;
13
+ };
14
+ export declare class RequestBufferManager {
15
+ private promiseLibrary;
16
+ private apiRequestService;
17
+ private requestColumnExpansionFactory;
18
+ private keyService;
19
+ private changesDeltaFactory;
20
+ private pendingBufferMap;
21
+ private pendingTrueBufferMap;
22
+ private pendingPriorityBufferMap;
23
+ private serverCache;
24
+ constructor(promiseLibrary: PromiseLibraryInterface, apiRequestService: ApiRequestService, requestColumnExpansionFactory: RequestColumnExpansionFactory, keyService: KeyService, changesDeltaFactory: ChangesDeltaFactory);
25
+ setServerCache(serverCache: ServerCache): void;
26
+ fetchByIds(itemType: ApiEnumItemType, itemIds: ItemId[], requestColumns: ApiRequestColumns): PromiseInterface<RequestBufferResponse>;
27
+ fetchById(itemType: ApiEnumItemType, itemId: ItemId, requestColumns: ApiRequestColumns): PromiseInterface<RequestBufferResponse>;
28
+ fetchByQuery(itemType: ApiEnumItemType, query: [ApiQuery, string], requestColumns: ApiRequestColumns, priorityBufferSettings: RequestBufferManagerPrioritySettings | null): PromiseInterface<RequestBufferResponse>;
29
+ private constructPriorityBuffer;
30
+ private constructBuffer;
31
+ private _constructBuffer;
32
+ }
@@ -1,15 +1,15 @@
1
- import { ApiEnumItemType } from '@rentman/backend-types';
2
- import { ApiRequestColumns, ColumnSet, ColumnUtil, RequestColumnMergeResult } from '../internal';
3
- declare type RequestColumnMap = {
4
- [itemType: string]: ApiRequestColumns;
5
- };
6
- export declare class RequestColumnExpansion {
7
- private columnUtil;
8
- private columns;
9
- private columnSetIdMap;
10
- constructor(columnUtil: ColumnUtil);
11
- expandWithRequestColumns(itemType: ApiEnumItemType, requestColumns: ApiRequestColumns): RequestColumnMergeResult;
12
- expand<T extends ColumnSet<ApiEnumItemType>>(columnSet: T): void;
13
- get(): RequestColumnMap;
14
- }
15
- export {};
1
+ import { ApiEnumItemType } from '@rentman/backend-types';
2
+ import { ApiRequestColumns, ColumnSet, ColumnUtil, RequestColumnMergeResult } from '../internal';
3
+ declare type RequestColumnMap = {
4
+ [itemType: string]: ApiRequestColumns;
5
+ };
6
+ export declare class RequestColumnExpansion {
7
+ private columnUtil;
8
+ private columns;
9
+ private columnSetIdMap;
10
+ constructor(columnUtil: ColumnUtil);
11
+ expandWithRequestColumns(itemType: ApiEnumItemType, requestColumns: ApiRequestColumns): RequestColumnMergeResult;
12
+ expand<T extends ColumnSet<ApiEnumItemType>>(columnSet: T): void;
13
+ get(): RequestColumnMap;
14
+ }
15
+ export {};
@@ -1,34 +1,34 @@
1
- import { ApiEnumItemType } from '@rentman/backend-types';
2
- import { ApiFormatter, ApiRequestService, CachedQueryItem, ChangesDeltaFactory, ErrorHandlerInterface, PromiseLibraryInterface, QueryMatcherFactory, RequestBufferManager, RequestColumnExpansionFactory, SocketMessage, TransactionCacheFactory } from '../internal';
3
- export declare type CachedQueryMatchingResult<ItemTypeType extends ApiEnumItemType> = {
4
- fitting: CachedQueryItem<ItemTypeType>[];
5
- notfitting: CachedQueryItem<ItemTypeType>[];
6
- maybe: CachedQueryItem<ItemTypeType>[];
7
- };
8
- export declare class SocketMessageHandler {
9
- private requestBufferManager;
10
- private changesDeltaFactory;
11
- private apiFormatter;
12
- private errorHandler;
13
- private transactionCacheFactory;
14
- private promiseService;
15
- private requestColumnExpansionFactory;
16
- private apiRequestService;
17
- private queryMatcherFactory;
18
- constructor(requestBufferManager: RequestBufferManager, changesDeltaFactory: ChangesDeltaFactory, apiFormatter: ApiFormatter, errorHandler: ErrorHandlerInterface, transactionCacheFactory: TransactionCacheFactory, promiseService: PromiseLibraryInterface, requestColumnExpansionFactory: RequestColumnExpansionFactory, apiRequestService: ApiRequestService, queryMatcherFactory: QueryMatcherFactory);
19
- onMessageReceived(message: SocketMessage): any;
20
- private formatMessageValues;
21
- private getCollectionsWithLimitByItemType;
22
- /**
23
- * @description
24
- * When an item is created or updated, we should check if it fits in any of the cached queries (using the values provided by the socket message)
25
- * If we think it fits (or maybe) we should fetch the complete item with the superset of columns (the socket message might not have all values)
26
- */
27
- private processMessage;
28
- private processFunctionChangesResolve;
29
- private isFunctionChangesResolveMessage;
30
- private handleCreate;
31
- private handleUpdate;
32
- private handleDelete;
33
- private handleLinkMove;
34
- }
1
+ import { ApiEnumItemType } from '@rentman/backend-types';
2
+ import { ApiFormatter, ApiRequestService, CachedQueryItem, ChangesDeltaFactory, ErrorHandlerInterface, PromiseLibraryInterface, QueryMatcherFactory, RequestBufferManager, RequestColumnExpansionFactory, SocketMessage, TransactionCacheFactory } from '../internal';
3
+ export declare type CachedQueryMatchingResult<ItemTypeType extends ApiEnumItemType> = {
4
+ fitting: CachedQueryItem<ItemTypeType>[];
5
+ notfitting: CachedQueryItem<ItemTypeType>[];
6
+ maybe: CachedQueryItem<ItemTypeType>[];
7
+ };
8
+ export declare class SocketMessageHandler {
9
+ private requestBufferManager;
10
+ private changesDeltaFactory;
11
+ private apiFormatter;
12
+ private errorHandler;
13
+ private transactionCacheFactory;
14
+ private promiseService;
15
+ private requestColumnExpansionFactory;
16
+ private apiRequestService;
17
+ private queryMatcherFactory;
18
+ constructor(requestBufferManager: RequestBufferManager, changesDeltaFactory: ChangesDeltaFactory, apiFormatter: ApiFormatter, errorHandler: ErrorHandlerInterface, transactionCacheFactory: TransactionCacheFactory, promiseService: PromiseLibraryInterface, requestColumnExpansionFactory: RequestColumnExpansionFactory, apiRequestService: ApiRequestService, queryMatcherFactory: QueryMatcherFactory);
19
+ onMessageReceived(message: SocketMessage): any;
20
+ private formatMessageValues;
21
+ private getCollectionsWithLimitByItemType;
22
+ /**
23
+ * @description
24
+ * When an item is created or updated, we should check if it fits in any of the cached queries (using the values provided by the socket message)
25
+ * If we think it fits (or maybe) we should fetch the complete item with the superset of columns (the socket message might not have all values)
26
+ */
27
+ private processMessage;
28
+ private processFunctionChangesResolve;
29
+ private isFunctionChangesResolveMessage;
30
+ private handleCreate;
31
+ private handleUpdate;
32
+ private handleDelete;
33
+ private handleLinkMove;
34
+ }
@@ -1,62 +1,62 @@
1
- import { ApiEnumItemType, ItemId } from '@rentman/backend-types';
2
- import { ApiRequestService, ApiResponse, ColumnHandler, ColumnUtil, EntryParentNull, ErrorHandlerInterface, ItemTypeColumnIds, PromiseInterface, PromiseLibraryInterface, RequestColumnExpansionFactory, Template, TemplateFactory } from '../internal';
3
- export declare class TemplateCache {
4
- private columnUtil;
5
- private promiseService;
6
- private columnHandler;
7
- private templateFactory;
8
- private errorHandler;
9
- private requestColumnExpansionFactory;
10
- private apiRequestService;
11
- private pendingTemplateBufferMap;
12
- templateResponses: {
13
- [itemType: string]: ApiResponse;
14
- };
15
- constructor(columnUtil: ColumnUtil, promiseService: PromiseLibraryInterface, columnHandler: ColumnHandler, templateFactory: TemplateFactory, errorHandler: ErrorHandlerInterface, requestColumnExpansionFactory: RequestColumnExpansionFactory, apiRequestService: ApiRequestService);
16
- /**
17
- * @description
18
- * Fetches a {@link Template template}, use {@link ItemCreateService.createItemsFromValues createItemsFromValues} to easily create new items from a set of values.
19
- * The best way to process the template's values is to call {@link ItemCreateService.processTemplate processTemplate}
20
- *
21
- * @param itemType The {@link ApiEnumItemType ItemType} of the template item
22
- * @param itemId Used for caching, multiple concurrent template calls for the same itemId will return the same template
23
- * @param templateOptions
24
- * @param templateColumns Additional columns to be fetched, will be stored in the template - warning - the Template won't have values for those columns
25
- * @param entryParentOrParentItemType An optional {@link EntryParentNull entry parent} or {@link ApiEnumItemType parent itemType}, if the parent is passed the templateColumns will be expanded with the proper link columns (Through {@link ColumnUtil.getColumnsFromLink ColumnUtil.getColumnsFromLink})
26
- *
27
- * @example
28
- * ```
29
- * const parent: EntryParent = {
30
- * itemType: 'Functie',
31
- * itemId: 10,
32
- * };
33
- *
34
- * return core.templateCache
35
- * .fetchTemplate(
36
- * 'Planningpersoneel',
37
- * undefined,
38
- * {},
39
- * {},
40
- * parent,
41
- * )
42
- * .then(
43
- * (template: Template<'Planningpersoneel'>) => {
44
- * const changesDelta = transaction.createChangesDelta();
45
- *
46
- * for (const itemResource of selectedItems) {
47
- * changesDelta.setItemCreated(
48
- * core.keyService.getLocalId(),
49
- * template.getFields(),
50
- * template.columns,
51
- * parent,
52
- * );
53
- * }
54
- *
55
- * return transaction.applyChangesDelta(changesDelta);
56
- * );
57
- * ```
58
- */
59
- fetchTemplate<ItemTypeType extends ApiEnumItemType, ColumnIds extends ItemTypeColumnIds<ItemTypeType> = ItemTypeColumnIds<ItemTypeType>>(itemType: ItemTypeType, itemId?: ItemId, templateOptions?: any, templateColumns?: any, entryParentOrParentItemType?: EntryParentNull | ApiEnumItemType): PromiseInterface<Template<ItemTypeType, ColumnIds>>;
60
- private fetchTemplateById;
61
- private constructTemplateBuffer;
62
- }
1
+ import { ApiEnumItemType, ItemId } from '@rentman/backend-types';
2
+ import { ApiRequestService, ApiResponse, ColumnHandler, ColumnUtil, EntryParentNull, ErrorHandlerInterface, ItemTypeColumnIds, PromiseInterface, PromiseLibraryInterface, RequestColumnExpansionFactory, Template, TemplateFactory } from '../internal';
3
+ export declare class TemplateCache {
4
+ private columnUtil;
5
+ private promiseService;
6
+ private columnHandler;
7
+ private templateFactory;
8
+ private errorHandler;
9
+ private requestColumnExpansionFactory;
10
+ private apiRequestService;
11
+ private pendingTemplateBufferMap;
12
+ templateResponses: {
13
+ [itemType: string]: ApiResponse;
14
+ };
15
+ constructor(columnUtil: ColumnUtil, promiseService: PromiseLibraryInterface, columnHandler: ColumnHandler, templateFactory: TemplateFactory, errorHandler: ErrorHandlerInterface, requestColumnExpansionFactory: RequestColumnExpansionFactory, apiRequestService: ApiRequestService);
16
+ /**
17
+ * @description
18
+ * Fetches a {@link Template template}, use {@link ItemCreateService.createItemsFromValues createItemsFromValues} to easily create new items from a set of values.
19
+ * The best way to process the template's values is to call {@link ItemCreateService.processTemplate processTemplate}
20
+ *
21
+ * @param itemType The {@link ApiEnumItemType ItemType} of the template item
22
+ * @param itemId Used for caching, multiple concurrent template calls for the same itemId will return the same template
23
+ * @param templateOptions
24
+ * @param templateColumns Additional columns to be fetched, will be stored in the template - warning - the Template won't have values for those columns
25
+ * @param entryParentOrParentItemType An optional {@link EntryParentNull entry parent} or {@link ApiEnumItemType parent itemType}, if the parent is passed the templateColumns will be expanded with the proper link columns (Through {@link ColumnUtil.getColumnsFromLink ColumnUtil.getColumnsFromLink})
26
+ *
27
+ * @example
28
+ * ```
29
+ * const parent: EntryParent = {
30
+ * itemType: 'Functie',
31
+ * itemId: 10,
32
+ * };
33
+ *
34
+ * return core.templateCache
35
+ * .fetchTemplate(
36
+ * 'Planningpersoneel',
37
+ * undefined,
38
+ * {},
39
+ * {},
40
+ * parent,
41
+ * )
42
+ * .then(
43
+ * (template: Template<'Planningpersoneel'>) => {
44
+ * const changesDelta = transaction.createChangesDelta();
45
+ *
46
+ * for (const itemResource of selectedItems) {
47
+ * changesDelta.setItemCreated(
48
+ * core.keyService.getLocalId(),
49
+ * template.getFields(),
50
+ * template.columns,
51
+ * parent,
52
+ * );
53
+ * }
54
+ *
55
+ * return transaction.applyChangesDelta(changesDelta);
56
+ * );
57
+ * ```
58
+ */
59
+ fetchTemplate<ItemTypeType extends ApiEnumItemType, ColumnIds extends ItemTypeColumnIds<ItemTypeType> = ItemTypeColumnIds<ItemTypeType>>(itemType: ItemTypeType, itemId?: ItemId, templateOptions?: any, templateColumns?: any, entryParentOrParentItemType?: EntryParentNull | ApiEnumItemType): PromiseInterface<Template<ItemTypeType, ColumnIds>>;
60
+ private fetchTemplateById;
61
+ private constructTemplateBuffer;
62
+ }
@@ -1,28 +1,28 @@
1
- import { PromiseInterface } from '../internal';
2
- export declare function findIndex<T>(haystack: T[], callback: (item: T) => boolean): number;
3
- export declare function shallowMerge(object: any, defaults: any): any;
4
- export declare function hasProperties(object: any): boolean;
5
- export declare function getFirstProperty(object: any): string | null;
6
- export declare function inArray(needle: any, haystack: any): boolean;
7
- export declare function filterArray<T>(source: T[], callback: (elem: T) => boolean): boolean;
8
- export declare function emptyArray(array: any[]): void;
9
- export declare function pathExists(source: any, path: string[]): boolean;
10
- export declare function createPath<T>(object: any, path: (number | string)[], defaults: any[]): T;
11
- export declare function getPath(object: {}, path: (number | string)[], create?: boolean): any;
12
- export declare function extend(dst: any, ...args: any[]): any;
13
- export declare function merge(dst: any, ...args: any[]): any;
14
- export declare function isObject(value: any): boolean;
15
- export declare function isBlankObject(value: any): boolean;
16
- export declare function isString(value: any): boolean;
17
- export declare function isNumber(value: any): boolean;
18
- export declare function isDate(value: any): boolean;
19
- export declare const isArray: (arg: any) => arg is any[];
20
- export declare function isFunction<T>(value: any): value is T;
21
- export declare function isPromiseLike<T = any>(obj: any): obj is PromiseInterface<T>;
22
- export declare function isRegExp(value: any): boolean;
23
- export declare function isBoolean(value: any): boolean;
24
- export declare function isElement(node: any): boolean;
25
- export declare function isWindow(obj: any): boolean;
26
- export declare function isDefined(value: any): boolean;
27
- export declare function equals(o1: any, o2: any): boolean;
28
- export declare function copy(source: object, destination?: object, maxDepth?: any): any;
1
+ import { PromiseInterface } from '../internal';
2
+ export declare function findIndex<T>(haystack: T[], callback: (item: T) => boolean): number;
3
+ export declare function shallowMerge(object: any, defaults: any): any;
4
+ export declare function hasProperties(object: any): boolean;
5
+ export declare function getFirstProperty(object: any): string | null;
6
+ export declare function inArray(needle: any, haystack: any): boolean;
7
+ export declare function filterArray<T>(source: T[], callback: (elem: T) => boolean): boolean;
8
+ export declare function emptyArray(array: any[]): void;
9
+ export declare function pathExists(source: any, path: string[]): boolean;
10
+ export declare function createPath<T>(object: any, path: (number | string)[], defaults: any[]): T;
11
+ export declare function getPath(object: {}, path: (number | string)[], create?: boolean): any;
12
+ export declare function extend(dst: any, ...args: any[]): any;
13
+ export declare function merge(dst: any, ...args: any[]): any;
14
+ export declare function isObject(value: any): boolean;
15
+ export declare function isBlankObject(value: any): boolean;
16
+ export declare function isString(value: any): boolean;
17
+ export declare function isNumber(value: any): boolean;
18
+ export declare function isDate(value: any): boolean;
19
+ export declare const isArray: (arg: any) => arg is any[];
20
+ export declare function isFunction<T>(value: any): value is T;
21
+ export declare function isPromiseLike<T = any>(obj: any): obj is PromiseInterface<T>;
22
+ export declare function isRegExp(value: any): boolean;
23
+ export declare function isBoolean(value: any): boolean;
24
+ export declare function isElement(node: any): boolean;
25
+ export declare function isWindow(obj: any): boolean;
26
+ export declare function isDefined(value: any): boolean;
27
+ export declare function equals(o1: any, o2: any): boolean;
28
+ export declare function copy(source: object, destination?: object, maxDepth?: any): any;
@@ -1,85 +1,85 @@
1
- import { ApiEnumItemType } from '@rentman/backend-types';
2
- import { RmCore } from '../../core';
3
- import { AbstractCacheDependencyInterface, ApiRequestColumn, CachedQueryItem, ChangesDelta, ChangesDeltaBase, ChangesDeltaResult, CollectionQuery, CollectionResourceParentIdMap, EntryParentNull, FieldMap, InternalChangesDelta, ItemCache, ItemEntry, ItemEntryChangesTuple, ItemHandlerBase, ItemIdConversionMap, OnAfterCreateCallback, ParentChangesDelta, PromiseInterface, ServerCache, ServerCachedQueryHandler, TransactionCache, TransactionCachedQueryHandler, TransactionValidatorFactory } from '../../internal';
4
- export declare type TransactionOptions = {
5
- /**
6
- * @description
7
- * Sets the TransactionCache to 'transparent' mode, whenever {@link AbstractCache.createChild createChild} is called it will actually be called on the parent
8
- */
9
- transparent: boolean;
10
- };
11
- export declare abstract class AbstractCache {
12
- dependencies: AbstractCacheDependencyInterface;
13
- core: RmCore;
14
- children: TransactionCache[];
15
- readonly itemHandler: ItemHandlerBase;
16
- readonly cachedQueryHandler: TransactionCachedQueryHandler | ServerCachedQueryHandler;
17
- parent: AbstractCache | null;
18
- protected constructor(dependencies: AbstractCacheDependencyInterface, core: RmCore);
19
- abstract createChild(id?: string, validatorFactory?: TransactionValidatorFactory, options?: TransactionOptions): TransactionCache;
20
- onChildDestroy(cache: TransactionCache): void;
21
- /**
22
- * @description
23
- * Expands the items in the collections with the passed columns
24
- *
25
- * todo[limit] move to TransactionCache ?
26
- */
27
- abstract expandCollectionResources<ItemTypeType extends ApiEnumItemType>(itemType: ItemTypeType, collections: CollectionResourceParentIdMap<ItemTypeType>, newColumns: ApiRequestColumn[]): PromiseInterface<CollectionResourceParentIdMap>;
28
- /**
29
- * @description
30
- * Returns {@link ItemEntry ItemEntries} that fit the collection's query, copies over the collectionChanges on all transactions in the chain.
31
- */
32
- abstract getCollectionChangesRecursively<ItemTypeType extends ApiEnumItemType>(itemType: ItemTypeType, parsedQuery: CollectionQuery): CachedQueryItem<ItemTypeType> | undefined;
33
- /**
34
- * @description
35
- * Returns this transaction and all parents
36
- */
37
- getTransactionChain(): AbstractCache[];
38
- /**
39
- * @description
40
- * Returns the {@link TransactionItemHandler.entries ItemCache} of the transaction
41
- */
42
- getCurrentItemEntryCache(): ItemCache;
43
- abstract getServerCache(): ServerCache;
44
- abstract getLocalItemEntry(itemEntryId: ItemEntry['id']): ItemEntry | undefined;
45
- abstract getLocalItemEntryByItemId(itemType: ApiEnumItemType, itemId: ItemEntry['itemId']): ItemEntry | undefined;
46
- /**
47
- * @description
48
- * Applies changes from a child transaction to a parent
49
- */
50
- abstract applyChangesFromChild(transaction: TransactionCache, breakUpByParent?: boolean, onAfterCreateCallback?: OnAfterCreateCallback): PromiseInterface<ItemIdConversionMap>;
51
- /**
52
- * @description
53
- * Called by a parent transaction, propagates changes downwards to all child caches
54
- *
55
- * @remarks
56
- * - Should only be used by the core
57
- *
58
- * todo[cache] Should we refetch derived values just like in applyChangesDelta ?
59
- *
60
- * @internal
61
- */
62
- abstract applyChangesFromParent(parentChangesDelta: ParentChangesDelta, isCalledAfterSocketUpdate: boolean): void;
63
- abstract getParent<ItemTypeType extends ApiEnumItemType = any>(itemEntry: ItemEntry<ItemTypeType>, fromInitial?: boolean, providedFields?: FieldMap<ItemTypeType>): EntryParentNull;
64
- abstract getItemChangesRecursively<ItemTypeType extends ApiEnumItemType>(itemEntryId: ItemEntry<ItemTypeType>['id'], copyFields?: boolean): FieldMap<ItemTypeType>;
65
- abstract getLocalItemEntryChangesTuple<ItemTypeType extends ApiEnumItemType>(itemEntryId: ItemEntry<ItemTypeType>['id']): ItemEntryChangesTuple<ItemTypeType>;
66
- abstract applyChangesDelta(changesDelta: ChangesDelta): PromiseInterface<ChangesDeltaResult>;
67
- protected getParentFromFields<ItemTypeType extends ApiEnumItemType = any>(itemEntry: ItemEntry<ItemTypeType>, fields?: FieldMap<ItemTypeType>): EntryParentNull;
68
- /**
69
- * @description
70
- * Called by applyChangesDelta from ServerCache and TransactionCache. Applies creates, updates and moves, doesn't apply deletes
71
- *
72
- * @private
73
- */
74
- protected _applyChangesDelta(changesDelta: ChangesDelta | InternalChangesDelta): {
75
- result: ChangesDeltaResult;
76
- parentChangesDelta: ParentChangesDelta;
77
- matchingDelta: ParentChangesDelta;
78
- undoFunctions: ((changesDelta: InternalChangesDelta) => void)[];
79
- };
80
- /**
81
- * @description
82
- * Ensures that for all updated items in the delta the required derived values are present
83
- */
84
- protected fetchUpdatedDerivedValuesFromDelta(changesDelta: ChangesDeltaBase): PromiseInterface<void>;
85
- }
1
+ import { ApiEnumItemType } from '@rentman/backend-types';
2
+ import { RmCore } from '../../core';
3
+ import { AbstractCacheDependencyInterface, ApiRequestColumn, CachedQueryItem, ChangesDelta, ChangesDeltaBase, ChangesDeltaResult, CollectionQuery, CollectionResourceParentIdMap, EntryParentNull, FieldMap, InternalChangesDelta, ItemCache, ItemEntry, ItemEntryChangesTuple, ItemHandlerBase, ItemIdConversionMap, OnAfterCreateCallback, ParentChangesDelta, PromiseInterface, ServerCache, ServerCachedQueryHandler, TransactionCache, TransactionCachedQueryHandler, TransactionValidatorFactory } from '../../internal';
4
+ export declare type TransactionOptions = {
5
+ /**
6
+ * @description
7
+ * Sets the TransactionCache to 'transparent' mode, whenever {@link AbstractCache.createChild createChild} is called it will actually be called on the parent
8
+ */
9
+ transparent: boolean;
10
+ };
11
+ export declare abstract class AbstractCache {
12
+ dependencies: AbstractCacheDependencyInterface;
13
+ core: RmCore;
14
+ children: TransactionCache[];
15
+ readonly itemHandler: ItemHandlerBase;
16
+ readonly cachedQueryHandler: TransactionCachedQueryHandler | ServerCachedQueryHandler;
17
+ parent: AbstractCache | null;
18
+ protected constructor(dependencies: AbstractCacheDependencyInterface, core: RmCore);
19
+ abstract createChild(id?: string, validatorFactory?: TransactionValidatorFactory, options?: TransactionOptions): TransactionCache;
20
+ onChildDestroy(cache: TransactionCache): void;
21
+ /**
22
+ * @description
23
+ * Expands the items in the collections with the passed columns
24
+ *
25
+ * todo[limit] move to TransactionCache ?
26
+ */
27
+ abstract expandCollectionResources<ItemTypeType extends ApiEnumItemType>(itemType: ItemTypeType, collections: CollectionResourceParentIdMap<ItemTypeType>, newColumns: ApiRequestColumn[]): PromiseInterface<CollectionResourceParentIdMap>;
28
+ /**
29
+ * @description
30
+ * Returns {@link ItemEntry ItemEntries} that fit the collection's query, copies over the collectionChanges on all transactions in the chain.
31
+ */
32
+ abstract getCollectionChangesRecursively<ItemTypeType extends ApiEnumItemType>(itemType: ItemTypeType, parsedQuery: CollectionQuery): CachedQueryItem<ItemTypeType> | undefined;
33
+ /**
34
+ * @description
35
+ * Returns this transaction and all parents
36
+ */
37
+ getTransactionChain(): AbstractCache[];
38
+ /**
39
+ * @description
40
+ * Returns the {@link TransactionItemHandler.entries ItemCache} of the transaction
41
+ */
42
+ getCurrentItemEntryCache(): ItemCache;
43
+ abstract getServerCache(): ServerCache;
44
+ abstract getLocalItemEntry(itemEntryId: ItemEntry['id']): ItemEntry | undefined;
45
+ abstract getLocalItemEntryByItemId(itemType: ApiEnumItemType, itemId: ItemEntry['itemId']): ItemEntry | undefined;
46
+ /**
47
+ * @description
48
+ * Applies changes from a child transaction to a parent
49
+ */
50
+ abstract applyChangesFromChild(transaction: TransactionCache, breakUpByParent?: boolean, onAfterCreateCallback?: OnAfterCreateCallback): PromiseInterface<ItemIdConversionMap>;
51
+ /**
52
+ * @description
53
+ * Called by a parent transaction, propagates changes downwards to all child caches
54
+ *
55
+ * @remarks
56
+ * - Should only be used by the core
57
+ *
58
+ * todo[cache] Should we refetch derived values just like in applyChangesDelta ?
59
+ *
60
+ * @internal
61
+ */
62
+ abstract applyChangesFromParent(parentChangesDelta: ParentChangesDelta, isCalledAfterSocketUpdate: boolean): void;
63
+ abstract getParent<ItemTypeType extends ApiEnumItemType = any>(itemEntry: ItemEntry<ItemTypeType>, fromInitial?: boolean, providedFields?: FieldMap<ItemTypeType>): EntryParentNull;
64
+ abstract getItemChangesRecursively<ItemTypeType extends ApiEnumItemType>(itemEntryId: ItemEntry<ItemTypeType>['id'], copyFields?: boolean): FieldMap<ItemTypeType>;
65
+ abstract getLocalItemEntryChangesTuple<ItemTypeType extends ApiEnumItemType>(itemEntryId: ItemEntry<ItemTypeType>['id']): ItemEntryChangesTuple<ItemTypeType>;
66
+ abstract applyChangesDelta(changesDelta: ChangesDelta): PromiseInterface<ChangesDeltaResult>;
67
+ protected getParentFromFields<ItemTypeType extends ApiEnumItemType = any>(itemEntry: ItemEntry<ItemTypeType>, fields?: FieldMap<ItemTypeType>): EntryParentNull;
68
+ /**
69
+ * @description
70
+ * Called by applyChangesDelta from ServerCache and TransactionCache. Applies creates, updates and moves, doesn't apply deletes
71
+ *
72
+ * @private
73
+ */
74
+ protected _applyChangesDelta(changesDelta: ChangesDelta | InternalChangesDelta): {
75
+ result: ChangesDeltaResult;
76
+ parentChangesDelta: ParentChangesDelta;
77
+ matchingDelta: ParentChangesDelta;
78
+ undoFunctions: ((changesDelta: InternalChangesDelta) => void)[];
79
+ };
80
+ /**
81
+ * @description
82
+ * Ensures that for all updated items in the delta the required derived values are present
83
+ */
84
+ protected fetchUpdatedDerivedValuesFromDelta(changesDelta: ChangesDeltaBase): PromiseInterface<void>;
85
+ }