@rentman/rm-core 9.2.3 → 9.3.0

package/dist/types/classes/CacheSyncer.d.ts

@@ -6,12 +6,13 @@ export declare type CacheSyncerQueryMap = ItemTypeMap<{
         collectionResources: CollectionResource[];
     };
 }>;
-export declare type CacheSyncerMatches<ItemTypeType extends ApiEnumItemType> = {
-    [itemId: number]: {
-        item: ItemEntry<ItemTypeType>;
-        isMatch: boolean | 'maybe';
-    };
+declare type CacheSyncerMatchesMapEntry = {
+    query: CollectionQuery;
+    items: ItemEntry[];
 };
+declare type CacheSyncerMatchesMap = ItemTypeMap<{
+    [cachedQueryString: string]: CacheSyncerMatchesMapEntry;
+}>;
 export declare class CacheSyncer {
     private queryService;
     private queryMatcherFactory;
@@ -19,15 +20,39 @@ export declare class CacheSyncer {
     private promiseService;
     private transaction;
     private cachedQueryMap;
-    private matchedItemEntryMap;
+    matches: {
+        true: CacheSyncerMatchesMap;
+        false: CacheSyncerMatchesMap;
+        maybe: CacheSyncerMatchesMap;
+    };
     constructor(queryService: QueryService, queryMatcherFactory: QueryMatcherFactory, apiRequestService: ApiRequestService, promiseService: PromiseLibraryInterface, transaction: AbstractCache, cachedQueryMap: CacheSyncerQueryMap);
+    getMatches<ItemTypeType extends ApiEnumItemType>(itemType: ItemTypeType, queryString: string, type: 'true' | 'false' | 'maybe'): ItemEntry<ItemTypeType>[];
+    /**
+     * Syncing of collections always runs in 3 phases:
+     * - Remove items from collections
+     * - Add items to collections
+     * - Process MAYBE matches
+     * -- Remove MAYBE items from collections
+     * -- Add MAYBE items to collections
+     *
+     * @param isCalledAfterSocketUpdate
+     * @param changesDelta
+     */
     syncCollections(isCalledAfterSocketUpdate?: boolean, changesDelta?: ChangesDeltaBase): PromiseInterface<void>;
+    /**
+     * Syncing of cached queries runs in 3 phases:
+     * - Remove items from collections
+     * - Add items to collections
+     * - Process MAYBE matches
+     * -- Remove MAYBE items from collections
+     * -- Add MAYBE items to collections
+     *
+     * @param _isCalledAfterSocketUpdate
+     * @param changesDelta
+     */
     syncCachedQueries(_isCalledAfterSocketUpdate?: boolean, changesDelta?: ChangesDeltaBase): PromiseInterface<void[]>;
     expand<ItemEntryType extends ItemEntry>(itemEntry: ItemEntryType, fields: FieldMap<ItemEntryType['itemType']>): this;
     processDelta(parentChangesDelta: ParentChangesDelta): this;
-    groupMatchedItemEntries<ItemTypeType extends ApiEnumItemType>(itemType: ItemTypeType, query: CollectionQuery): {
-        [key in 'fitting' | 'notFitting' | 'maybe']: ItemEntry<ItemTypeType>[];
-    };
     _expand<ItemTypeType extends ApiEnumItemType = any>(itemEntry: ItemEntry<ItemTypeType>, matchFunction: (itemType: ItemTypeType, parsedQuery: CollectionQuery) => boolean | 'maybe'): this;
     /**
      * Unlike the functions that use a promise accumulator, this function *can* result in a rejection. It should be handled
@@ -38,7 +63,8 @@ export declare class CacheSyncer {
      * Returns null if none of the promises resulted in an exception, or the exception otherwise.
      */
     private resolveAll;
-    private syncCollection;
-    private syncCachedQuery;
     private addMatchedEntriesToCollections;
+    private processCollectionMaybe;
+    private processCachedQueryMaybe;
 }
+export {};

package/package.json

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