@rentman/rm-core 66.1.7 → 66.1.8-children-query-as-function

package/dist/types/src/classes/cache/CachedQueryHandlerBase.d.ts

@@ -10,6 +10,7 @@ export interface ParentCachedQueryItemTuple<ItemTypeType extends ApiItemType> {
     readonly cachedQueryItem: CachedQueryItem<ItemTypeType>;
     readonly options: CollectionOptions<ItemTypeType>;
     children: CachedQueryItemsItemTypeTuple<ApiItemType>[] | null;
+    readonly parentItemId?: ItemId;
 }
 export interface CachedQueryItemTuple<ItemTypeType extends ApiItemType> extends ParentCachedQueryItemTuple<ItemTypeType> {
     children: null;

package/dist/types/src/classes/cache/transaction/TransactionCache.d.ts

@@ -369,7 +369,6 @@ export declare class TransactionCache extends AbstractCache {
     clearItemError(itemEntryId: ItemEntry['id'], columnId?: string, errorKey?: string): void;
     clearItemError(itemEntryId: ItemEntry['id'], columnId: string, errorKey?: string): void;
     clearItemError(itemEntryId: ItemEntry['id'], columnId: string, errorKey: string): void;
-    private updateSignals;
     /**
      * This method:
      * - calls changes listeners for single items;

package/dist/types/src/classes/cache/transaction/TransactionCachedQueryHandler.d.ts

@@ -1,16 +1,19 @@
 import { ApiItemType, ItemId } from '@rentman/backend-types';
-import { ApiQuery, CachedQueryHandlerBase, CachedQueryHandlerCollectionTuple, CachedQueryItem, CachedQueryItemsItemTypeTuple, CachedQueryItemTuple, CachedQueryOptions, ChangesDeltaBase, ChildCollectionsOption, CollectionItemResourceChanges, CollectionOptions, CollectionQuery, CollectionResource, EntryParent, ItemIdConversionMap, LinkCollectionBatchQueryTuple, MatchesAccumulatorMap, MatchingResultsAccumulatorMapType, MatchingResultsAccumulatorTuple, ParentCachedQueryItemTuple, RequestColumnsOperationsCache, RequireOnly, TransactionCache, TransactionCollectionHandlerDependencyInterface } from '../../../internal';
+import { ApiQuery, CachedQueryHandlerBase, CachedQueryHandlerCollectionTuple, CachedQueryItem, CachedQueryItemsItemTypeTuple, CachedQueryItemTuple, CachedQueryOptions, ChangesDeltaBase, ChildCollectionsOption, ChildrenQueryFunction, CollectionItemResourceChanges, CollectionOptions, CollectionQuery, CollectionResource, EntryParent, ItemIdConversionMap, LinkCollectionBatchQueryTuple, MatchesAccumulatorMap, MatchingResultsAccumulatorMapType, MatchingResultsAccumulatorTuple, ParentCachedQueryItemTuple, RequestColumnsOperationsCache, RequireOnly, TransactionCache, TransactionCollectionHandlerDependencyInterface } from '../../../internal';
 import { RootQueryNode } from '../../matcher/RootQueryNode';
-export interface LinkCollectionOptionsItemTypeTuple<ItemTypeType extends ApiItemType> {
-    itemType: ItemTypeType;
-    linkCollectionOptions: LinkCollectionOptionsTuple<ItemTypeType>;
-}
 interface CollectionQueryTuple<ItemTypeType extends ApiItemType> {
     parsedQuery: CollectionQuery<ItemTypeType>;
     options: CollectionOptions<ItemTypeType>;
 }
-interface LinkCollectionOptionsTuple<ItemTypeType extends ApiItemType> extends LinkCollectionBatchQueryTuple<ItemTypeType> {
+interface QueryCallbackCollectionOptionsTuple<ItemTypeType extends ApiItemType> {
     collectionQueryTuples: CollectionQueryTuple<ItemTypeType>[];
+    parentItemIds: ItemId[];
+    batchQuery: CollectionQuery<ItemTypeType>;
+}
+export interface QueryCallbackCollectionOptionsItemTypeTuple<ItemTypeType extends ApiItemType> {
+    itemType: ItemTypeType;
+    queryCallbackCollectionOptions: QueryCallbackCollectionOptionsTuple<ItemTypeType>;
+    parentItemIds: ItemId[];
 }
 interface TransactionCachedQueryHandlerCollectionTuple<ItemTypeType extends ApiItemType> extends CachedQueryHandlerCollectionTuple<ItemTypeType> {
     collectionResources?: WeakRef<CollectionResource<ItemTypeType, any, any>>[];
@@ -61,13 +64,14 @@ export declare class TransactionCachedQueryHandler extends CachedQueryHandlerBas
      * Fetches collections linked to the passed parents
      * @returns An array of cached query items. The items are in the same order as the parent IDs.
      */
-    __fetchLinkedCachedQueryItems<const ItemTypeType extends ApiItemType>(itemType: ItemTypeType, linkCollectionOptionsTuple: LinkCollectionOptionsTuple<ItemTypeType>): Promise<CachedQueryItemTuple<ItemTypeType>[]>;
     createBatchLinkedToQuery<ItemTypeType extends ApiItemType>(parentItemType: ApiItemType, parentItemIds: ItemId[], additionalQuery?: ApiQuery<ItemTypeType>): CollectionQuery<ItemTypeType>;
+    private getOrCreateChildrenQueryFunction;
     /**
      * The order of the `collectionQueryTuples` property of the result will be the same as the order of
      * `parentItemIds`.
      */
-    processLinkCollectionOptions<ItemTypeType extends ApiItemType>(itemType: ItemTypeType, parentItemType: ApiItemType, parentItemIds: ItemId[], options: CollectionOptions<ItemTypeType>): LinkCollectionOptionsTuple<ItemTypeType>;
+    processCollectionOptions<ItemTypeType extends ApiItemType>(itemType: ItemTypeType, parentItemIds: ItemId[], queryFn: ChildrenQueryFunction<ItemTypeType>, bareOptions: CollectionOptions<ItemTypeType>): QueryCallbackCollectionOptionsTuple<ItemTypeType>;
+    __fetchCachedQueryItems<const ItemTypeType extends ApiItemType>(itemType: ItemTypeType, queryCallbackCollectionOptionsTuple: QueryCallbackCollectionOptionsTuple<ItemTypeType>): Promise<CachedQueryItemTuple<ItemTypeType>[]>;
     __fetchParentCachedQueryItem<const ItemTypeType extends ApiItemType>(itemType: ItemTypeType, options: CollectionOptions<ItemTypeType>): Promise<ParentCachedQueryItemTuple<ItemTypeType>>;
     __fetchChildCachedQueryItems(parentItemType: ApiItemType, parentItemIds: ItemId[], childCollectionOptions: ChildCollectionsOption): Promise<CachedQueryItemsItemTypeTuple<ApiItemType>[]>;
     /**
@@ -77,8 +81,7 @@ export declare class TransactionCachedQueryHandler extends CachedQueryHandlerBas
      * todo: Rename this method and {@link __fetchItemEntriesByQueryData} to something that's easier to understand.
      */
     __fetchParentItemEntriesByQueryData<ItemTypeType extends ApiItemType>(itemType: ItemTypeType, options: CollectionOptions<ItemTypeType>, columnsOperationsCache: RequestColumnsOperationsCache<ItemTypeType>, collectionQuery: CollectionQuery<ItemTypeType>): Promise<ParentCachedQueryItemTuple<ItemTypeType>>;
-    private cloneOptions;
-    fetchChildCachedQueryItems(linkCollectionOptionsItemTypeTuples: LinkCollectionOptionsItemTypeTuple<ApiItemType>[]): Promise<CachedQueryItemsItemTypeTuple<ApiItemType>[]>;
+    private fetchChildCachedQueryItems;
     /**
      * Updates the items included in cached queries and collection resources based on query matcher results. Note that
      * method does not clear child collection resources of removed item resources.
@@ -94,7 +97,7 @@ export declare class TransactionCachedQueryHandler extends CachedQueryHandlerBas
      * Sets the `children` property for each of the cached queries in `cachedQueryItemTuples`. Assumes the `children`
      * *options* property is the same for all cached query items.
      *
-     * The `children` property will remain `null` if  the children option is unset.
+     * The `children` property will remain `null` if the children option is unset.
      */
     private resolveParentCachedQueryItems;
     private resolveLocalCachedQueryItem;

package/dist/types/src/models/CollectionOptions.d.ts

@@ -1,5 +1,6 @@
-import { ApiItemType } from '@rentman/backend-types';
+import { ApiItemType, ItemId } from '@rentman/backend-types';
 import { AggregatedChangesListener, ApiQuery, ApiRequestColumnArray, ApiRequestColumns, ChildCollectionResources, CollectionItemChangesListener, CollectionResource, EntryParent, ItemEntry, ItemResource, ItemTypeColumnId } from '../internal';
+export type ChildrenQueryFunction<ItemType extends ApiItemType> = (parentItemIds: ItemId[]) => ApiQuery<ItemType>;
 export interface CollectionResourceOrder<ItemTypeType extends ApiItemType> {
     field: ItemTypeColumnId<ItemTypeType>;
     order?: 'desc' | 'asc';
@@ -28,7 +29,7 @@ export type ChildCollectionsOption = {
  * operations cache.
  */
 export interface CachedQueryOptions<ItemType extends ApiItemType> {
-    query?: ApiQuery<ItemType>;
+    query?: ApiQuery<ItemType> | ChildrenQueryFunction<ItemType>;
     parent?: EntryParent;
     order?: CollectionResourceOrder<ItemType>;
     /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rentman/rm-core",
-  "version": "66.1.7",
+  "version": "66.1.8-children-query-as-function",
   "description": "Rentman core functionalities",
   "main": "./dist/rm-core.js",
   "types": "./dist/types/src/index.d.ts",