@codeleap/query 5.8.8 → 5.8.10

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@codeleap/query",
-  "version": "5.8.8",
+  "version": "5.8.10",
   "main": "src/index.ts",
   "license": "UNLICENSED",
   "repository": {
@@ -9,15 +9,15 @@
     "directory": "packages/query"
   },
   "devDependencies": {
-    "@codeleap/config": "5.8.8",
-    "@codeleap/types": "5.8.8",
+    "@codeleap/config": "5.8.10",
+    "@codeleap/types": "5.8.10",
     "ts-node-dev": "1.1.8"
   },
   "scripts": {
     "build": "echo 'No build needed'"
   },
   "peerDependencies": {
-    "@codeleap/types": "5.8.8",
+    "@codeleap/types": "5.8.10",
     "typescript": "5.5.2",
     "@tanstack/react-query": "5.89.0"
   },

package/package.json.bak

@@ -1,6 +1,6 @@
 {
   "name": "@codeleap/query",
-  "version": "5.8.8",
+  "version": "5.8.10",
   "main": "src/index.ts",
   "license": "UNLICENSED",
   "repository": {

package/src/lib/Mutations.ts

@@ -2,6 +2,7 @@ import { InfiniteData } from '@tanstack/query-core'
 import { QueryKeys } from './QueryKeys'
 import { ItemPosition, ListPaginationResponse, PageParam, QueryClient, QueryItem, RemovedItemMap, WithTempId } from '../types'
 import deepEqual from 'fast-deep-equal'
+import { TypeGuards } from '@codeleap/types'
 
 /**
  * Class for managing mutations and cache updates for React Query list data
@@ -115,24 +116,29 @@ export class Mutations<T extends QueryItem, F> {
   }
 
   /**
-   * Removes an item from all cached list queries and returns the positions where it was found
+   * Removes an item from all or specific cached list query and returns the positions where it was found
    * @param itemId - The ID of the item to remove
-   * @returns A RemovedItemMap containing the query keys and positions where the item was found, or null if not found
+   * @param listFilters - Optional filters to target a specific list query. If omitted, removes from all list queries
+   * @returns A RemovedItemMap containing the query keys and positions where the item was found, or null if not found in any query
    * 
    * @example
    * ```typescript
+   * // Remove from all list queries
    * const removedPositions = mutations.removeItem('user-123')
    * 
+   * // Remove from a specific filtered list
+   * const removedPositions = mutations.removeItem('user-123', { status: 'active' })
+   * 
    * // Later, restore the item to its original positions
    * if (removedPositions) {
    *   mutations.addItem(restoredUser, removedPositions)
    * }
    * ```
    */
-  removeItem(itemId: QueryItem['id']): RemovedItemMap | null {
+  removeItem(itemId: QueryItem['id'], listFilters?: F): RemovedItemMap | null {
     this.queryKeys.removeRetrieveQueryData(itemId)
 
-    const listQueries = this.queryKeys.getAllListQueries()
+    const listQueries = TypeGuards.isNil(listFilters) ? this.queryKeys.getAllListQueries() : [this.queryKeys.getListQuery(listFilters)]
 
     const removedItemMap: RemovedItemMap = []
 

package/src/lib/QueryKeys.ts

@@ -336,6 +336,19 @@ export class QueryKeys<T extends QueryItem, F> {
 
     return queries as Query<ListPaginationResponse<T>, Error, Omit<ListSelector<T>, 'allItems'>, QueryKey>[]
   }
+
+  /**
+   * Gets a specific list query from the query cache
+   * @param listFilters - Optional filters to identify a specific list query. If omitted, returns the unfiltered list query
+   * @returns The matching list query, or undefined if not found
+   */
+  getListQuery(listFilters?: F) {
+    const query = this.queryClient.getQueryCache().find({
+      queryKey: this.listKeyWithFilters(listFilters)
+    })
+
+    return query as Query<ListPaginationResponse<T>, Error, Omit<ListSelector<T>, 'allItems'>, QueryKey>
+  }
 }
 
 /**

package/src/lib/QueryManager.ts

@@ -1,4 +1,4 @@
-import { FetchQueryOptions, InfiniteData, MutationFunctionContext, QueryKey, useInfiniteQuery, useMutation, useQuery } from '@tanstack/react-query'
+import { FetchInfiniteQueryOptions, FetchQueryOptions, InfiniteData, MutationFunctionContext, QueryKey, useInfiniteQuery, useMutation, useQuery } from '@tanstack/react-query'
 import { useCallback } from 'react'
 import { createQueryKeys, QueryKeys } from './QueryKeys'
 import { createMutations, Mutations } from './Mutations'
@@ -485,4 +485,39 @@ export class QueryManager<T extends QueryItem, F> {
       queryFn: () => this.options.retrieveFn(id),
     })
   }
+
+  /**
+   * Prefetches a paginated list with filters for improved performance
+   * @param filters - Filter parameters to apply to the list query
+   * @param options - Prefetch options compatible with React Query's infinite queries
+   * @param options.initialOffset - Starting offset for pagination (default: 0)
+   * @returns Promise that resolves when prefetch is complete
+   * 
+   * @description
+   * Use this method to preload paginated list data that users are likely to need soon.
+   * 
+   * @example
+   * ```typescript
+   * const handle = () => {
+   *   queryManager.prefetchList(
+   *     { category: 'electronics' },
+   *     { staleTime: 5 * 60 * 1000 }
+   *   )
+   * }
+   * 
+   * ```
+   */
+  prefetchList(
+    filters?: F,
+    options: Omit<FetchInfiniteQueryOptions<ListPaginationResponse<T>, Error, ListPaginationResponse<T>, QueryKey, number>, 'queryKey' | 'queryFn' | 'initialPageParam'> & { initialOffset?: number } = {}
+  ) {
+    const { initialOffset = 0, ...prefetchOptions } = options
+
+    return this.options.queryClient.prefetchInfiniteQuery({
+      ...prefetchOptions as any,
+      initialPageParam: initialOffset,
+      queryKey: this.queryKeys.listKeyWithFilters(filters),
+      queryFn: () => this.options.listFn(this.options.listLimit ?? 10, initialOffset, filters),
+    })
+  }
 }