refactor: implemented review related fixes

Author: Ruslan

src/create-entity-api.ts

@@ -180,7 +180,6 @@ export function createEntityApi<
           },
           providesTags: (response) => getEntityTags(entityName, response, getEntityId),
         }),
-
         /**
          * Creates a query endpoint for infinite searching entities. Behaves similar to `search`:
          * - A query endpoint that requests `GET /{baseEndpoint}` for searching entities.
@@ -232,8 +231,18 @@ export function createEntityApi<
             }
           },
         }),
-
-        searchList: builder.infiniteQuery<TSearchResponse & { minPage?: number }, TSearchRequest, number>({
+        /**
+         * Creates a query endpoint for infinite searching entities.
+         * - A query endpoint that requests `GET /{baseEndpoint}` for searching entities.
+         * - Accepts request params described by `entitySearchRequestConstructor` and returns `entitySearchResponseConstructor` extending `PaginationRequest` and `PaginationResponse` respectively.
+         * But accumulates data from newly requested pages.
+         * This query can be used with `useSearchPaginatedInfiniteQuery` hook to implement infinite scrolling lists.
+         * It supports loading data in both directions using `fetchNextPage` and `fetchPreviousPage` callbacks, and provides other useful props.
+         *
+         * @param {TSearchRequest} params - The parameters for searching the entities.
+         * @return {Promise<InfiniteData<TSearchResponse, number>>} A promise that resolves to the search result.
+         */
+        searchPaginated: builder.infiniteQuery<TSearchResponse, TSearchRequest, number>({
           infiniteQueryOptions: {
             initialPageParam: 1,
 

src/hooks/use-infinite-query.ts

@@ -8,7 +8,7 @@ import { BaseEntity, PaginationRequest, PaginationResponse } from '../models';
 import { EntityApi, EntityMutationEndpointName } from '../types';
 
 /**
- * @deprecated This hook will be removed. Instead, use 'useSearchInfiniteQuery' hook in your entity API directly
+ * @deprecated This hook will be removed. Instead, use 'useSearchPaginatedInfiniteQuery' hook in your entity API directly
  */
 export const useInfiniteQuery = <
   TEntity extends BaseEntity,

src/types/entity-api.ts

@@ -22,7 +22,10 @@ export type EntityEndpointsDefinitions<
   create: MutationDefinition<Partial<TEntity>, BaseQueryFunction, string, TEntity>;
   search: QueryDefinition<TSearchRequest, BaseQueryFunction, string, TSearchResponse>;
   searchInfinite: QueryDefinition<TSearchRequest, BaseQueryFunction, string, TSearchResponse & { minPage?: number }>;
-  searchList: InfiniteQueryDefinition<
+  /**
+   * @deprecated This endpoint will be removed. Instead, use 'useSearchPaginatedInfiniteQuery' hook in your entity API
+   */
+  searchPaginated: InfiniteQueryDefinition<
     TSearchRequest,
     number,
     BaseQueryFunction,

src/utils/create-entity-api-utils.ts

@@ -75,12 +75,7 @@ export const createEntityApiUtils = <
               | (TSearchResponse & {
                   minPage?: number;
                 })
-              | InfiniteData<
-                  TSearchResponse & {
-                    minPage?: number;
-                  },
-                  number
-                >
+              | InfiniteData<TSearchResponse, number>
             >;
 
             if ('data' in endpointData && Array.isArray(endpointData.data)) {
@@ -149,12 +144,7 @@ export const createEntityApiUtils = <
               | (TSearchResponse & {
                   minPage?: number;
                 })
-              | InfiniteData<
-                  TSearchResponse & {
-                    minPage?: number;
-                  },
-                  number
-                >
+              | InfiniteData<TSearchResponse, number>
             >;
 
             if ('data' in endpointData && Array.isArray(endpointData.data)) {

src/utils/find-entity-in-pages.ts

@@ -0,0 +1,18 @@
+// export const findEntityInPages = (
+//   pages: Array<any>,
+//   entityId: unknown,
+// ): { pageIndex: number; itemIndex: number } | null => {
+//   let existingItemIndex = -1;
+
+//   const existingPageIndex = pages.findIndex((page) => {
+//     const itemIndex = page.data.findIndex((item: { id: unkown }) => item.id === entityId);
+
+//     if (itemIndex !== -1) {
+//       existingItemIndex = itemIndex;
+
+//       return true;
+//     }
+
+//     return false;
+//   });
+// };