@rentman/rm-core 8.1.7 → 8.1.8-dev1

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 (115) hide show
  1. package/changelog.md +923 -917
  2. package/dist/rm-core.js +18307 -11023
  3. package/dist/rm-core.min.js +1 -16
  4. package/dist/types/classes/ApiFormatter.d.ts +73 -66
  5. package/dist/types/classes/ApiRequestService.d.ts +18 -21
  6. package/dist/types/classes/ApiResponseProcessor.d.ts +29 -30
  7. package/dist/types/classes/CacheSyncer.d.ts +36 -0
  8. package/dist/types/classes/ChangesCompilation.d.ts +33 -36
  9. package/dist/types/classes/ChangesDelta.d.ts +61 -68
  10. package/dist/types/classes/ChangesDeltaBase.d.ts +76 -79
  11. package/dist/types/classes/ChangesProcessor.d.ts +40 -45
  12. package/dist/types/classes/CollectionEntryService.d.ts +23 -27
  13. package/dist/types/classes/CollectionResourceService.d.ts +6 -7
  14. package/dist/types/classes/ColumnCache.d.ts +21 -22
  15. package/dist/types/classes/ColumnExpansion.d.ts +21 -23
  16. package/dist/types/classes/ColumnHandler.d.ts +20 -22
  17. package/dist/types/classes/ColumnInfo.d.ts +14 -14
  18. package/dist/types/classes/ColumnSet.d.ts +37 -39
  19. package/dist/types/classes/ColumnSubsetCache.d.ts +14 -15
  20. package/dist/types/classes/ColumnUtil.d.ts +100 -101
  21. package/dist/types/classes/ConversionMapService.d.ts +25 -28
  22. package/dist/types/classes/CreateRequest.d.ts +17 -20
  23. package/dist/types/classes/CreatedChangesDelta.d.ts +17 -18
  24. package/dist/types/classes/InternalChangesDelta.d.ts +47 -51
  25. package/dist/types/classes/ItemCache.d.ts +27 -30
  26. package/dist/types/classes/ItemCreateService.d.ts +18 -25
  27. package/dist/types/classes/ItemEntryService.d.ts +32 -35
  28. package/dist/types/classes/KeyService.d.ts +18 -18
  29. package/dist/types/classes/LockService.d.ts +29 -32
  30. package/dist/types/classes/ModuleChangesCompilation.d.ts +18 -19
  31. package/dist/types/classes/ParentChangesDelta.d.ts +39 -47
  32. package/dist/types/classes/QueryColumnExtractor.d.ts +18 -20
  33. package/dist/types/classes/QueryContainsLocalIdParser.d.ts +15 -17
  34. package/dist/types/classes/QueryLinkedToParser.d.ts +15 -16
  35. package/dist/types/classes/QueryLocallyMatchableParser.d.ts +18 -19
  36. package/dist/types/classes/QueryMatcher.d.ts +18 -19
  37. package/dist/types/classes/QueryParser.d.ts +25 -26
  38. package/dist/types/classes/QueryParserBase.d.ts +20 -20
  39. package/dist/types/classes/QueryParserIdUpdater.d.ts +15 -16
  40. package/dist/types/classes/QueryService.d.ts +12 -13
  41. package/dist/types/classes/RequestBuffer.d.ts +24 -29
  42. package/dist/types/classes/RequestBufferManager.d.ts +20 -26
  43. package/dist/types/classes/RequestColumnExpansion.d.ts +15 -16
  44. package/dist/types/classes/SocketMessageHandler.d.ts +34 -43
  45. package/dist/types/classes/TemplateCache.d.ts +63 -70
  46. package/dist/types/classes/Util.d.ts +28 -31
  47. package/dist/types/classes/cache/AbstractCache.d.ts +95 -112
  48. package/dist/types/classes/cache/CachedQueryHandlerBase.d.ts +68 -75
  49. package/dist/types/classes/cache/ItemHandlerBase.d.ts +95 -106
  50. package/dist/types/classes/cache/server/ServerCache.d.ts +82 -94
  51. package/dist/types/classes/cache/server/ServerCachedQueryHandler.d.ts +25 -34
  52. package/dist/types/classes/cache/server/ServerItemHandler.d.ts +44 -53
  53. package/dist/types/classes/cache/transaction/TransactionCache.d.ts +319 -327
  54. package/dist/types/classes/cache/transaction/TransactionCachedQueryHandler.d.ts +31 -30
  55. package/dist/types/classes/cache/transaction/TransactionCollectionHandler.d.ts +24 -30
  56. package/dist/types/classes/cache/transaction/TransactionEventHandler.d.ts +21 -24
  57. package/dist/types/classes/cache/transaction/TransactionItemHandler.d.ts +89 -97
  58. package/dist/types/classes/cache/transaction/TransactionValidator.d.ts +33 -35
  59. package/dist/types/constants.d.ts +7 -7
  60. package/dist/types/core.d.ts +45 -51
  61. package/dist/types/factories/ApiResponseProcessorFactory.d.ts +6 -6
  62. package/dist/types/factories/CacheSyncerFactory.d.ts +10 -0
  63. package/dist/types/factories/ChangesCompilationFactory.d.ts +5 -6
  64. package/dist/types/factories/ChangesDeltaFactory.d.ts +13 -15
  65. package/dist/types/factories/ChangesProcessorFactory.d.ts +13 -19
  66. package/dist/types/factories/CollectionEntryFactory.d.ts +11 -14
  67. package/dist/types/factories/CollectionResourceFactory.d.ts +18 -22
  68. package/dist/types/factories/ColumnExpansionFactory.d.ts +7 -9
  69. package/dist/types/factories/ColumnInfoFactory.d.ts +7 -8
  70. package/dist/types/factories/ColumnSetFactory.d.ts +18 -20
  71. package/dist/types/factories/ColumnSubsetCacheFactory.d.ts +8 -9
  72. package/dist/types/factories/CreateRequestFactory.d.ts +9 -11
  73. package/dist/types/factories/ItemCacheFactory.d.ts +6 -8
  74. package/dist/types/factories/ItemEntryFactory.d.ts +12 -15
  75. package/dist/types/factories/ItemResourceFactory.d.ts +11 -14
  76. package/dist/types/factories/ModuleChangesCompilationFactory.d.ts +4 -5
  77. package/dist/types/factories/QueryMatcherFactory.d.ts +7 -8
  78. package/dist/types/factories/QueryParserFactory.d.ts +5 -6
  79. package/dist/types/factories/RequestColumnExpansionFactory.d.ts +8 -9
  80. package/dist/types/factories/TemplateFactory.d.ts +8 -11
  81. package/dist/types/factories/TransactionCacheFactory.d.ts +13 -15
  82. package/dist/types/index.d.ts +1 -7
  83. package/dist/types/interfaces/AbstractCacheDependencyInterface.d.ts +36 -43
  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 -7
  91. package/dist/types/interfaces/SocketMessageInterface.d.ts +3 -3
  92. package/dist/types/interfaces/TransactionCollectionHandlerDependencyInterface.d.ts +17 -21
  93. package/dist/types/interfaces/TransactionItemHandlerDependencyInterface.d.ts +22 -27
  94. package/dist/types/internal.d.ts +104 -0
  95. package/dist/types/models/CachedQueryItem.d.ts +19 -0
  96. package/dist/types/models/CollectionEntry.d.ts +21 -24
  97. package/dist/types/models/CollectionOptions.d.ts +42 -24
  98. package/dist/types/models/CollectionResource.d.ts +87 -78
  99. package/dist/types/models/ItemEntry.d.ts +18 -19
  100. package/dist/types/models/ItemEntryOptions.d.ts +8 -8
  101. package/dist/types/models/ItemResource.d.ts +90 -88
  102. package/dist/types/models/Template.d.ts +11 -13
  103. package/dist/types/types/ItemTypesCollection.d.ts +343 -345
  104. package/dist/types/types/PromiseInterface.d.ts +2 -2
  105. package/package.json +48 -38
  106. package/readme.md +15 -15
  107. package/dist/types/classes/CollectionMatcherBase.d.ts +0 -22
  108. package/dist/types/classes/CollectionMatcherCachedCollectionProcessor.d.ts +0 -32
  109. package/dist/types/classes/cache/CollectionMatcherCachedQueryProcessor.d.ts +0 -36
  110. package/dist/types/classes/index.d.ts +0 -46
  111. package/dist/types/factories/CollectionMatcherFactory.d.ts +0 -19
  112. package/dist/types/factories/index.d.ts +0 -21
  113. package/dist/types/interfaces/index.d.ts +0 -11
  114. package/dist/types/models/index.d.ts +0 -7
  115. package/dist/types/types/index.d.ts +0 -2
@@ -1,94 +1,82 @@
1
- import { ApiEnumItemType } from '@rentman/backend-types';
2
- import { ChangesDelta, TransactionCache, TransactionOptions, TransactionValidatorFactory } from '../..';
3
- import { RmCore } from '../../../core';
4
- import { ServerCacheDependencyInterface } from '../../../interfaces/ServerCacheDependencyInterface';
5
- import { ItemEntry } from '../../../models';
6
- import { ApiRequestColumn, ApiRequestColumnMap, CollectionQuery, CollectionResourceParentIdMap, EntryParent, EntryParentNull, FieldMap, ItemIdConversionMap, ItemTypeMap, PromiseInterface } from '../../../types';
7
- import { ApiResponseProcessor } from '../../ApiResponseProcessor';
8
- import { ChangesDeltaResult } from '../../ChangesDeltaBase';
9
- import { OnAfterCreateCallback } from '../../ChangesProcessor';
10
- import { ParentChangesDelta } from '../../ParentChangesDelta';
11
- import { AbstractCache } from '../AbstractCache';
12
- import { CachedQueryItem } from '../CachedQueryHandlerBase';
13
- import { ServerCachedQueryHandler } from './ServerCachedQueryHandler';
14
- import { ServerItemEntryChanges, ServerItemHandler } from './ServerItemHandler';
15
- /**
16
- * @description
17
- * The {@link ServerCache ServerCache} is responsible for keeping track of {@link ItemEntry ItemEntries} and {@link CollectionEntry CollectionEntries}
18
- * which are saved on the server.
19
- *
20
- * It's basically a local representation of the database
21
- */
22
- export declare class ServerCache extends AbstractCache {
23
- dependencies: ServerCacheDependencyInterface;
24
- readonly itemHandler: ServerItemHandler;
25
- readonly cachedQueryHandler: ServerCachedQueryHandler;
26
- parent: null;
27
- constructor(dependencies: ServerCacheDependencyInterface, core: RmCore);
28
- getServerCache(): ServerCache;
29
- createChild(id?: string, validatorFactory?: TransactionValidatorFactory, options?: TransactionOptions): TransactionCache;
30
- expandCollectionResources<ItemTypeType extends ApiEnumItemType>(itemType: ItemTypeType, collections: CollectionResourceParentIdMap<ItemTypeType>, newRequestColumns: ApiRequestColumn[]): PromiseInterface<CollectionResourceParentIdMap>;
31
- /**
32
- *
33
- * @param response
34
- * @param requestColumnMap
35
- * @param isCalledAfterSocketUpdate
36
- * @param changesDelta
37
- * @param conversionMap
38
- * @param directRequestItemMap Should be a map of ItemType->ItemId of items that were directly part of the create/update request (queries should be excluded from this because we don't want to overwrite the user's changes (derived values are also queries))
39
- */
40
- processResponse(response: ApiResponseProcessor, requestColumnMap: ApiRequestColumnMap, isCalledAfterSocketUpdate?: boolean, changesDelta?: ChangesDelta, directRequestItemMap?: ItemTypeMap<Record<string, boolean>>, conversionMap?: ItemIdConversionMap): PromiseInterface<ChangesDeltaResult>;
41
- /**
42
- * @description
43
- * Applies changes to this transaction and its children
44
- * ServerCache.applyChangesFromParent should be used when processing an API update/create/delete
45
- */
46
- applyChangesFromParent(parentChangesDelta: ParentChangesDelta, isCalledAfterSocketUpdate?: boolean): PromiseInterface<void>;
47
- /**
48
- * @description
49
- * Gets the fields required to set the parent
50
- */
51
- getLinkFieldsByParent<ItemTypeType extends ApiEnumItemType>(parent: EntryParent, itemType: ItemTypeType): Partial<FieldMap<ItemTypeType>>;
52
- /**
53
- * @description
54
- * Gets the entry's parent
55
- *
56
- * @param itemEntry The entry to get the parent from
57
- * @param _fromInitial Unused parameter, there for alignment with {@link TransactionCache.getParent TransactionCache.getParent]
58
- * @param _providedFields Unused parameter, there for alignment with {@link TransactionCache.getParent TransactionCache.getParent]
59
- *
60
- * @remark
61
- * Use {@link CollectionResource.getParent CollectionResource.getParent} instead of {@link TransactionCache.getParent TransactionCache.getParent} if you're getting the parent in the onRemove callback
62
- */
63
- getParent<ItemTypeType extends ApiEnumItemType = any>(itemEntry: ItemEntry<ItemTypeType>, _fromInitial?: boolean, _providedFields?: FieldMap<ItemTypeType>): EntryParentNull;
64
- getItemChangesRecursively(itemEntryId: ItemEntry['id'], copyFields?: boolean): FieldMap;
65
- /**
66
- * @description
67
- * Only takes the local changes into account, used for saving
68
- */
69
- getLocalItemEntryChangesTuple(itemEntryId: ItemEntry['id']): {
70
- entry: ItemEntry;
71
- changes: ServerItemEntryChanges;
72
- };
73
- getCollectionChangesRecursively<ItemTypeType extends ApiEnumItemType>(itemType: ItemTypeType, parsedQuery: CollectionQuery): CachedQueryItem<ItemTypeType> | undefined;
74
- /**
75
- * @description
76
- * Invalidates the complete server cache, all items will be re-fetched whenever they are requested
77
- */
78
- invalidateCache(): void;
79
- /**
80
- * @description
81
- * Merges the passed changes from the child Transaction into this Transaction's own changes and then propagates
82
- * them to all child Transactions
83
- */
84
- applyChangesFromChild(transaction: TransactionCache, breakUpByParent?: boolean, onAfterCreateCallback?: OnAfterCreateCallback): PromiseInterface<ItemIdConversionMap>;
85
- /**
86
- * @description
87
- * Applies changes to this transaction and its children
88
- * ServerCache.applyChangesDelta should be used when processing an API response which should create new entries on the ServerCache (such as a Query)
89
- */
90
- applyChangesDelta(changesDelta: ChangesDelta, isCalledAfterSocketUpdate?: boolean, conversionMap?: ItemIdConversionMap): PromiseInterface<ChangesDeltaResult>;
91
- getLocalItemEntry(itemEntryId: ItemEntry['id']): ItemEntry | undefined;
92
- getLocalItemEntryByItemId(itemType: ApiEnumItemType, itemId: ItemEntry['itemId']): ItemEntry | undefined;
93
- getChangesFromItemChanges<ItemTypeType extends ApiEnumItemType = any>(changesObject: ServerItemEntryChanges<ItemTypeType>): FieldMap<ItemTypeType>;
94
- }
1
+ import { ApiEnumItemType } from '@rentman/backend-types';
2
+ import { AbstractCache, ApiRequestColumn, ApiRequestColumnMap, ApiResponseProcessor, CachedQueryItem, ChangesDelta, ChangesDeltaResult, CollectionQuery, CollectionResourceParentIdMap, EntryParent, EntryParentNull, FieldMap, ItemEntry, ItemIdConversionMap, ItemTypeMap, OnAfterCreateCallback, ParentChangesDelta, PromiseInterface, RmCore, ServerCacheDependencyInterface, ServerCachedQueryHandler, ServerItemEntryChanges, ServerItemHandler, TransactionCache, TransactionOptions, TransactionValidatorFactory } from '../../../internal';
3
+ /**
4
+ * @description
5
+ * The {@link ServerCache ServerCache} is responsible for keeping track of {@link ItemEntry ItemEntries} and {@link CollectionEntry CollectionEntries}
6
+ * which are saved on the server.
7
+ *
8
+ * It's basically a local representation of the database
9
+ */
10
+ export declare class ServerCache extends AbstractCache {
11
+ dependencies: ServerCacheDependencyInterface;
12
+ readonly itemHandler: ServerItemHandler;
13
+ readonly cachedQueryHandler: ServerCachedQueryHandler;
14
+ parent: null;
15
+ constructor(dependencies: ServerCacheDependencyInterface, core: RmCore);
16
+ getServerCache(): ServerCache;
17
+ createChild(id?: string, validatorFactory?: TransactionValidatorFactory, options?: TransactionOptions): TransactionCache;
18
+ expandCollectionResources<ItemTypeType extends ApiEnumItemType>(itemType: ItemTypeType, collections: CollectionResourceParentIdMap<ItemTypeType>, newRequestColumns: ApiRequestColumn[]): PromiseInterface<CollectionResourceParentIdMap>;
19
+ /**
20
+ *
21
+ * @param response
22
+ * @param requestColumnMap
23
+ * @param isCalledAfterSocketUpdate
24
+ * @param changesDelta
25
+ * @param conversionMap
26
+ * @param directRequestItemMap Should be a map of ItemType->ItemId of items that were directly part of the create/update request (queries should be excluded from this because we don't want to overwrite the user's changes (derived values are also queries))
27
+ */
28
+ processResponse(response: ApiResponseProcessor, requestColumnMap: ApiRequestColumnMap, isCalledAfterSocketUpdate?: boolean, changesDelta?: ChangesDelta, directRequestItemMap?: ItemTypeMap<Record<string, boolean>>, conversionMap?: ItemIdConversionMap): PromiseInterface<ChangesDeltaResult>;
29
+ /**
30
+ * @description
31
+ * Applies changes to this transaction and its children
32
+ * ServerCache.applyChangesFromParent should be used when processing an API update/create/delete
33
+ */
34
+ applyChangesFromParent(parentChangesDelta: ParentChangesDelta, isCalledAfterSocketUpdate?: boolean): PromiseInterface<void>;
35
+ /**
36
+ * @description
37
+ * Gets the fields required to set the parent
38
+ */
39
+ getLinkFieldsByParent<ItemTypeType extends ApiEnumItemType>(parent: EntryParent, itemType: ItemTypeType): Partial<FieldMap<ItemTypeType>>;
40
+ /**
41
+ * @description
42
+ * Gets the entry's parent
43
+ *
44
+ * @param itemEntry The entry to get the parent from
45
+ * @param _fromInitial Unused parameter, there for alignment with {@link TransactionCache.getParent TransactionCache.getParent]
46
+ * @param _providedFields Unused parameter, there for alignment with {@link TransactionCache.getParent TransactionCache.getParent]
47
+ *
48
+ * @remark
49
+ * Use {@link CollectionResource.getParent CollectionResource.getParent} instead of {@link TransactionCache.getParent TransactionCache.getParent} if you're getting the parent in the onRemove callback
50
+ */
51
+ getParent<ItemTypeType extends ApiEnumItemType = any>(itemEntry: ItemEntry<ItemTypeType>, _fromInitial?: boolean, _providedFields?: FieldMap<ItemTypeType>): EntryParentNull;
52
+ getItemChangesRecursively(itemEntryId: ItemEntry['id'], copyFields?: boolean): FieldMap;
53
+ /**
54
+ * @description
55
+ * Only takes the local changes into account, used for saving
56
+ */
57
+ getLocalItemEntryChangesTuple(itemEntryId: ItemEntry['id']): {
58
+ entry: ItemEntry;
59
+ changes: ServerItemEntryChanges;
60
+ };
61
+ getCollectionChangesRecursively<ItemTypeType extends ApiEnumItemType>(itemType: ItemTypeType, parsedQuery: CollectionQuery): CachedQueryItem<ItemTypeType> | undefined;
62
+ /**
63
+ * @description
64
+ * Invalidates the complete server cache, all items will be re-fetched whenever they are requested
65
+ */
66
+ invalidateCache(): void;
67
+ /**
68
+ * @description
69
+ * Merges the passed changes from the child Transaction into this Transaction's own changes and then propagates
70
+ * them to all child Transactions
71
+ */
72
+ applyChangesFromChild(transaction: TransactionCache, breakUpByParent?: boolean, onAfterCreateCallback?: OnAfterCreateCallback): PromiseInterface<ItemIdConversionMap>;
73
+ /**
74
+ * @description
75
+ * Applies changes to this transaction and its children
76
+ * ServerCache.applyChangesDelta should be used when processing an API response which should create new entries on the ServerCache (such as a Query)
77
+ */
78
+ applyChangesDelta(changesDelta: ChangesDelta, isCalledAfterSocketUpdate?: boolean, conversionMap?: ItemIdConversionMap): PromiseInterface<ChangesDeltaResult>;
79
+ getLocalItemEntry(itemEntryId: ItemEntry['id']): ItemEntry | undefined;
80
+ getLocalItemEntryByItemId(itemType: ApiEnumItemType, itemId: ItemEntry['itemId']): ItemEntry | undefined;
81
+ getChangesFromItemChanges<ItemTypeType extends ApiEnumItemType = any>(changesObject: ServerItemEntryChanges<ItemTypeType>): FieldMap<ItemTypeType>;
82
+ }
@@ -1,34 +1,25 @@
1
- import { ApiEnumItemType, ItemId } from '@rentman/backend-types';
2
- import { ColumnSubsetCacheFactory, RequestColumnExpansionFactory } from '../../../factories';
3
- import { ApiRequestColumns, ApiRequestService, CollectionQuery, ColumnSubsetCache, ColumnUtil, ParentIdMap, PromiseInterface } from '../../../index';
4
- import { ErrorHandlerInterface, PromiseLibraryInterface } from '../../../interfaces';
5
- import { ItemEntry } from '../../../models';
6
- import { CollectionOptions } from '../../../models/CollectionOptions';
7
- import { CollectionEntryService } from '../../index';
8
- import { RequestBufferManager } from '../../RequestBufferManager';
9
- import { CachedQueryHandlerBase, CachedQueryItem } from '../CachedQueryHandlerBase';
10
- import { ServerCache } from './ServerCache';
11
- import { ServerItemHandler } from './ServerItemHandler';
12
- export declare class ServerCachedQueryHandler extends CachedQueryHandlerBase {
13
- private columnSubsetCacheFactory;
14
- private requestBufferManager;
15
- private apiRequestService;
16
- private errorHandler;
17
- private itemHandler;
18
- protected transaction: ServerCache;
19
- constructor(columnSubsetCacheFactory: ColumnSubsetCacheFactory, requestBufferManager: RequestBufferManager, requestColumnExpansionFactory: RequestColumnExpansionFactory, apiRequestService: ApiRequestService, collectionEntryService: CollectionEntryService, errorHandler: ErrorHandlerInterface, itemHandler: ServerItemHandler, promiseService: PromiseLibraryInterface, columnUtil: ColumnUtil, transaction: ServerCache);
20
- __fetchCachedQueryItem<ItemTypeType extends ApiEnumItemType>(itemType: ItemTypeType, options: CollectionOptions): PromiseInterface<CachedQueryItem<ItemTypeType>>;
21
- __fetchLinkedCachedQueryItems<ItemTypeType extends ApiEnumItemType>(parentType: ApiEnumItemType, parentIdArray: ItemId[] | (() => ItemId[]), itemType: ItemTypeType, options: CollectionOptions): PromiseInterface<ParentIdMap<CachedQueryItem<ItemTypeType>>>;
22
- __addItemEntriesToCachedQueries<ItemTypeType extends ApiEnumItemType = any>(itemType: ItemTypeType, parsedQuery: CollectionQuery, itemEntries: Array<ItemEntry<ItemTypeType>>): void;
23
- /**
24
- * @description
25
- * Expands the columns of the items in the cached query
26
- */
27
- __expandCachedQuery<ItemTypeType extends ApiEnumItemType = any>(cachedQuery: CachedQueryItem<ItemTypeType>, newColumns: ApiRequestColumns, force?: boolean): PromiseInterface<CachedQueryItem<ItemTypeType>>;
28
- /**
29
- * @description
30
- * Fetches the data for the passed ItemType/options, will do nothing if the requested CollectionEntry/columns are already cached.
31
- * Will create a new {@link CollectionEntry CollectionEntry} if the CollectionEntry didn't exist yet
32
- */
33
- __fetchItemEntriesByQueryData<ItemTypeType extends ApiEnumItemType>(itemType: ItemTypeType, options: CollectionOptions<ItemTypeType>, columnSubsetCache: ColumnSubsetCache<ItemTypeType>, collectionQuery: CollectionQuery): PromiseInterface<CachedQueryItem<ItemTypeType>>;
34
- }
1
+ import { ApiEnumItemType, ItemId } from '@rentman/backend-types';
2
+ import { ApiRequestColumns, ApiRequestService, CachedQueryHandlerBase, CachedQueryItem, CollectionEntryService, CollectionOptions, CollectionQuery, ColumnSubsetCache, ColumnSubsetCacheFactory, ColumnUtil, ErrorHandlerInterface, ItemEntry, ParentIdMap, PromiseInterface, PromiseLibraryInterface, RequestBufferManager, RequestColumnExpansionFactory, ServerCache, ServerItemHandler } from '../../../internal';
3
+ export declare class ServerCachedQueryHandler extends CachedQueryHandlerBase {
4
+ private columnSubsetCacheFactory;
5
+ private requestBufferManager;
6
+ private apiRequestService;
7
+ private errorHandler;
8
+ private itemHandler;
9
+ protected transaction: ServerCache;
10
+ constructor(columnSubsetCacheFactory: ColumnSubsetCacheFactory, requestBufferManager: RequestBufferManager, requestColumnExpansionFactory: RequestColumnExpansionFactory, apiRequestService: ApiRequestService, collectionEntryService: CollectionEntryService, errorHandler: ErrorHandlerInterface, itemHandler: ServerItemHandler, promiseService: PromiseLibraryInterface, columnUtil: ColumnUtil, transaction: ServerCache);
11
+ __fetchCachedQueryItem<ItemTypeType extends ApiEnumItemType>(itemType: ItemTypeType, options: CollectionOptions): PromiseInterface<CachedQueryItem<ItemTypeType>>;
12
+ __fetchLinkedCachedQueryItems<ItemTypeType extends ApiEnumItemType>(parentType: ApiEnumItemType, parentIdArray: ItemId[] | (() => ItemId[]), itemType: ItemTypeType, options: CollectionOptions): PromiseInterface<ParentIdMap<CachedQueryItem<ItemTypeType>>>;
13
+ __addItemEntriesToCachedQueries<ItemTypeType extends ApiEnumItemType = any>(itemType: ItemTypeType, parsedQuery: CollectionQuery, itemEntries: Array<ItemEntry<ItemTypeType>>): void;
14
+ /**
15
+ * @description
16
+ * Expands the columns of the items in the cached query
17
+ */
18
+ __expandCachedQuery<ItemTypeType extends ApiEnumItemType = any>(cachedQuery: CachedQueryItem<ItemTypeType>, newColumns: ApiRequestColumns, force?: boolean): PromiseInterface<CachedQueryItem<ItemTypeType>>;
19
+ /**
20
+ * @description
21
+ * Fetches the data for the passed ItemType/options, will do nothing if the requested CollectionEntry/columns are already cached.
22
+ * Will create a new {@link CollectionEntry CollectionEntry} if the CollectionEntry didn't exist yet
23
+ */
24
+ __fetchItemEntriesByQueryData<ItemTypeType extends ApiEnumItemType>(itemType: ItemTypeType, options: CollectionOptions<ItemTypeType>, columnSubsetCache: ColumnSubsetCache<ItemTypeType>, collectionQuery: CollectionQuery): PromiseInterface<CachedQueryItem<ItemTypeType>>;
25
+ }
@@ -1,53 +1,44 @@
1
- import { ApiEnumItemType, ItemId } from '@rentman/backend-types';
2
- import { ColumnSubsetCacheFactory, ItemCacheFactory, ItemEntryFactory, QueryParserFactory, RequestColumnExpansionFactory } from '../../../factories';
3
- import { ErrorHandlerInterface, PromiseLibraryInterface } from '../../../interfaces';
4
- import { ItemEntry, ItemEntryOptions } from '../../../models';
5
- import { ApiQuery, ApiRequestColumns, FieldMap, PromiseInterface } from '../../../types';
6
- import { ChangesDelta } from '../../ChangesDelta';
7
- import { ChangesDeltaItemUpdateDelta } from '../../ChangesDeltaBase';
8
- import { ChangesDeltaItemCreateDelta } from '../../CreatedChangesDelta';
9
- import { ApiFormatter, ApiResponseProcessor, ColumnExpansion, ColumnSet, ColumnUtil, QueryService, RequestBufferManager, RequestBufferResponse, TransactionItemEntryChanges } from '../../index';
10
- import { ItemHandlerBase, ProcessItemEntryChangesResult } from '../ItemHandlerBase';
11
- import { ServerCache } from './ServerCache';
12
- export declare type ServerItemEntryChanges<ItemTypeType extends ApiEnumItemType = any> = FieldMap<ItemTypeType>;
13
- export declare class ServerItemHandler extends ItemHandlerBase {
14
- private requestBufferManager;
15
- private queryParserFactory;
16
- private queryService;
17
- private columnSubsetCacheFactory;
18
- protected transaction: ServerCache;
19
- itemChanges: {
20
- [itemEntryId: number]: ServerItemEntryChanges;
21
- };
22
- constructor(requestBufferManager: RequestBufferManager, queryParserFactory: QueryParserFactory, queryService: QueryService, columnSubsetCacheFactory: ColumnSubsetCacheFactory, errorHandler: ErrorHandlerInterface, promiseService: PromiseLibraryInterface, columnUtil: ColumnUtil, apiFormatter: ApiFormatter, itemEntryFactory: ItemEntryFactory, itemCacheFactory: ItemCacheFactory, requestColumnExpansionFactory: RequestColumnExpansionFactory, transaction: ServerCache);
23
- createItemEntry(createTuple: ChangesDeltaItemCreateDelta): ItemEntry;
24
- /**
25
- * @description
26
- * Processes updates on a cached entry
27
- */
28
- processItemEntryChanges<ItemTypeType extends ApiEnumItemType = any>(itemEntryChangesTuple: ChangesDeltaItemUpdateDelta<ItemTypeType>, _isCalledAfterSocketUpdate?: boolean, _createItemChangesIfNoneExist?: boolean): ProcessItemEntryChangesResult<ItemTypeType>;
29
- copyTransactionItemEntryChanges(itemEntryChanges: TransactionItemEntryChanges, entry: ItemEntry): ServerItemEntryChanges;
30
- fetchItemEntry<ItemTypeType extends ApiEnumItemType>(itemType: ItemTypeType, itemId: ItemId, options: ItemEntryOptions): PromiseInterface<ItemEntry<ItemTypeType>>;
31
- fetchItemEntriesByQuery<ItemTypeType extends ApiEnumItemType>(itemType: ItemTypeType, query: ApiQuery, entryOptions: ItemEntryOptions): PromiseInterface<Array<ItemEntry<ItemTypeType>>>;
32
- extendItemEntries<ItemTypeType extends ApiEnumItemType>(itemType: ItemTypeType, itemEntries: Array<ItemEntry<ItemTypeType>>, newColumns: ApiRequestColumns): PromiseInterface<Array<ItemEntry<ItemTypeType>>>;
33
- fetchItemEntries<ItemTypeType extends ApiEnumItemType>(itemType: ItemTypeType, itemIds: ItemId[], options: ItemEntryOptions): PromiseInterface<Array<ItemEntry<ItemTypeType>>>;
34
- /**
35
- * @description
36
- * Fetches the data for the ItemEntries linked to the parent Items
37
- *
38
- * @param columns should contain a derived column that refers to the parent
39
- */
40
- fetchLinkedItemEntriesData(parentType: ApiEnumItemType, parentIdArray: ItemId[], itemType: ApiEnumItemType, query: ApiQuery | null, columns: ApiRequestColumns): PromiseInterface<RequestBufferResponse>;
41
- /**
42
- * @description
43
- * General way to process an API response.
44
- * Will call {@link ChangesDelta.setItemCreated setItemCreated} if an entry doesn't exist yet, and otherwise {@link ChangesDelta.setItemUpdated setItemUpdated} if it does.
45
- */
46
- processApiResponse<ItemTypeType extends ApiEnumItemType>(changesDelta: ChangesDelta, response: ApiResponseProcessor, itemType: ItemTypeType, itemIdOfExistingItem: ItemId, itemIdInResponse: ItemId, columnSet: ColumnSet<ItemTypeType>, columnExpansion: ColumnExpansion<ItemTypeType>, updateModified?: boolean): void;
47
- /**
48
- * @description
49
- * Fetches the data for the passed ItemType/ItemId/columns, will do nothing if the requested ItemEntry/columns are already cached.
50
- * Will create a new {@link ItemEntry ItemEntry} if the ItemEntry didn't exist yet
51
- */
52
- private fetchItemEntryData;
53
- }
1
+ import { ApiEnumItemType, ItemId } from '@rentman/backend-types';
2
+ import { ApiFormatter, ApiQuery, ApiRequestColumns, ApiResponseProcessor, ChangesDelta, ChangesDeltaItemCreateDelta, ChangesDeltaItemUpdateDelta, ColumnExpansion, ColumnSet, ColumnSubsetCacheFactory, ColumnUtil, ErrorHandlerInterface, FieldMap, ItemCacheFactory, ItemEntry, ItemEntryFactory, ItemEntryOptions, ItemHandlerBase, ProcessItemEntryChangesResult, PromiseInterface, PromiseLibraryInterface, QueryParserFactory, QueryService, RequestBufferManager, RequestBufferResponse, RequestColumnExpansionFactory, ServerCache, TransactionItemEntryChanges } from '../../../internal';
3
+ export declare type ServerItemEntryChanges<ItemTypeType extends ApiEnumItemType = any> = FieldMap<ItemTypeType>;
4
+ export declare class ServerItemHandler extends ItemHandlerBase {
5
+ private requestBufferManager;
6
+ private queryParserFactory;
7
+ private queryService;
8
+ private columnSubsetCacheFactory;
9
+ protected transaction: ServerCache;
10
+ itemChanges: {
11
+ [itemEntryId: number]: ServerItemEntryChanges;
12
+ };
13
+ constructor(requestBufferManager: RequestBufferManager, queryParserFactory: QueryParserFactory, queryService: QueryService, columnSubsetCacheFactory: ColumnSubsetCacheFactory, errorHandler: ErrorHandlerInterface, promiseService: PromiseLibraryInterface, columnUtil: ColumnUtil, apiFormatter: ApiFormatter, itemEntryFactory: ItemEntryFactory, itemCacheFactory: ItemCacheFactory, requestColumnExpansionFactory: RequestColumnExpansionFactory, transaction: ServerCache);
14
+ createItemEntry(createTuple: ChangesDeltaItemCreateDelta): ItemEntry;
15
+ /**
16
+ * @description
17
+ * Processes updates on a cached entry
18
+ */
19
+ processItemEntryChanges<ItemTypeType extends ApiEnumItemType = any>(itemEntryChangesTuple: ChangesDeltaItemUpdateDelta<ItemTypeType>, _isCalledAfterSocketUpdate?: boolean, _createItemChangesIfNoneExist?: boolean): ProcessItemEntryChangesResult<ItemTypeType>;
20
+ copyTransactionItemEntryChanges(itemEntryChanges: TransactionItemEntryChanges, entry: ItemEntry): ServerItemEntryChanges;
21
+ fetchItemEntry<ItemTypeType extends ApiEnumItemType>(itemType: ItemTypeType, itemId: ItemId, options: ItemEntryOptions): PromiseInterface<ItemEntry<ItemTypeType>>;
22
+ fetchItemEntriesByQuery<ItemTypeType extends ApiEnumItemType>(itemType: ItemTypeType, query: ApiQuery, entryOptions: ItemEntryOptions): PromiseInterface<Array<ItemEntry<ItemTypeType>>>;
23
+ extendItemEntries<ItemTypeType extends ApiEnumItemType>(itemType: ItemTypeType, itemEntries: Array<ItemEntry<ItemTypeType>>, newColumns: ApiRequestColumns): PromiseInterface<Array<ItemEntry<ItemTypeType>>>;
24
+ fetchItemEntries<ItemTypeType extends ApiEnumItemType>(itemType: ItemTypeType, itemIds: ItemId[], options: ItemEntryOptions): PromiseInterface<Array<ItemEntry<ItemTypeType>>>;
25
+ /**
26
+ * @description
27
+ * Fetches the data for the ItemEntries linked to the parent Items
28
+ *
29
+ * @param columns should contain a derived column that refers to the parent
30
+ */
31
+ fetchLinkedItemEntriesData(parentType: ApiEnumItemType, parentIdArray: ItemId[], itemType: ApiEnumItemType, query: ApiQuery | null, columns: ApiRequestColumns): PromiseInterface<RequestBufferResponse>;
32
+ /**
33
+ * @description
34
+ * General way to process an API response.
35
+ * Will call {@link ChangesDelta.setItemCreated setItemCreated} if an entry doesn't exist yet, and otherwise {@link ChangesDelta.setItemUpdated setItemUpdated} if it does.
36
+ */
37
+ processApiResponse<ItemTypeType extends ApiEnumItemType>(changesDelta: ChangesDelta, response: ApiResponseProcessor, itemType: ItemTypeType, itemIdOfExistingItem: ItemId, itemIdInResponse: ItemId, columnSet: ColumnSet<ItemTypeType>, columnExpansion: ColumnExpansion<ItemTypeType>, updateModified?: boolean): void;
38
+ /**
39
+ * @description
40
+ * Fetches the data for the passed ItemType/ItemId/columns, will do nothing if the requested ItemEntry/columns are already cached.
41
+ * Will create a new {@link ItemEntry ItemEntry} if the ItemEntry didn't exist yet
42
+ */
43
+ private fetchItemEntryData;
44
+ }