Merge pull request #31 from RonasIT/fix/types-fixes

fix: types fixes

Author: ipakhomov

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@ronas-it/rtkq-entity-api",
-  "version": "1.0.0-alpha.1",
+  "version": "1.0.0-alpha.2",
   "description": "Wrapper utilities for CRUD operations with REST APIs entities using RTK Query",
   "license": "MIT",
   "author": "Ronas IT",

package.json

@@ -37,7 +37,6 @@ import {
  * @param {((pagination: Pagination, request: TSearchRequest) => number) | undefined} [options.getCurrentPage=((pagination) => pagination.currentPage)] - The function to get current page.
  * @returns {Omit<EntityApi<TEntity, TSearchRequest, TEntityRequest, TSearchResponse, typeof omitEndpoints>, keyof EntityApiCustomHooks> & EntityApiCustomHooks<TEntity, TSearchRequest, TSearchResponse>} The entity API.
  */
-
 export function createEntityApi<
   TEntity extends BaseEntity,
   TSearchRequest extends PaginationRequest = PaginationRequest,

src/create-entity-api.ts

@@ -6,5 +6,8 @@ export type EntityApiCustomHooks<
   TSearchRequest extends PaginationRequest = PaginationRequest,
   TSearchResponse extends PaginationResponse<TEntity> = PaginationResponse<TEntity>,
 > = {
+  /**
+   * @deprecated This hook will be removed. Instead, use 'useSearchPaginatedInfiniteQuery' hook in your entity API
+   */
   useSearchInfiniteQuery: ReturnType<typeof createInfiniteQueryHook<TEntity, TSearchRequest, TSearchResponse>>;
 };

src/types/custom-hooks.ts

@@ -75,7 +75,7 @@ export type EntityApiUtils<
    */
   handleEntityUpdate: (
     arg: EntityPartial<TEntity> | TEntity['id'],
-    endpointLifecycle: LifecycleApi<EntityPartial<TEntity>, EntityPartial<TEntity> | TEntity['id']>,
+    endpointLifecycle: LifecycleApi<EntityPartial<TEntity> | void, EntityPartial<TEntity> | TEntity['id']>,
     options?: {
       optimistic?: boolean;
       shouldRefetchEntity?: boolean;