@ventlio/tanstack-query 0.5.4 → 0.5.6

package/dist/request/transformer.js

@@ -1,21 +1,21 @@
-//
-const errorTransformer = (data) => {
-    return {
-        timeStamp: new Date(),
-        status: false,
-        data: data.data,
-        ...data,
-    };
-};
-//
-const successTransformer = (data) => {
-    return {
-        message: data.message ?? 'Request successful',
-        statusCode: data.statusCode,
-        timeStamp: new Date(),
-        status: true,
-        data: data.data,
-    };
+//
+const errorTransformer = (data) => {
+    return {
+        timeStamp: new Date(),
+        data: data.data,
+        ...data,
+        status: false,
+    };
+};
+//
+const successTransformer = (data) => {
+    return {
+        message: data.message ?? 'Request successful',
+        statusCode: data.statusCode,
+        timeStamp: new Date(),
+        status: true,
+        data: data.data,
+    };
 };
 
 export { errorTransformer, successTransformer };

package/dist/stores/index.d.ts

@@ -1,2 +1,2 @@
-export * from './useHeaderStore';
-export * from './usePauseFutureRequests';
+export * from './useHeaderStore';
+export * from './usePauseFutureRequests';

package/dist/stores/useHeaderStore.d.ts

@@ -1,7 +1,7 @@
-import type { QueryHeaders } from '../types';
-interface IUserHeaders {
-    headers: QueryHeaders | undefined;
-    setHeader: (headers: QueryHeaders) => void;
-}
-export declare const useHeaderStore: import("zustand").UseBoundStore<import("zustand").StoreApi<IUserHeaders>>;
-export {};
+import type { QueryHeaders } from '../types';
+interface IUserHeaders {
+    headers: QueryHeaders | undefined;
+    setHeader: (headers: QueryHeaders) => void;
+}
+export declare const useHeaderStore: import("zustand").UseBoundStore<import("zustand").StoreApi<IUserHeaders>>;
+export {};

package/dist/stores/useHeaderStore.js

@@ -1,10 +1,10 @@
 import { create } from 'zustand';
 
-const useHeaderStore = create((set) => ({
-    headers: undefined,
-    setHeader(headers) {
-        set({ headers });
-    },
+const useHeaderStore = create((set) => ({
+    headers: undefined,
+    setHeader(headers) {
+        set({ headers });
+    },
 }));
 
 export { useHeaderStore };

package/dist/stores/usePauseFutureRequests.d.ts

@@ -1,7 +1,7 @@
-export interface PauseFutureRequest {
-    isFutureQueriesPaused: boolean;
-    isFutureMutationsPaused: boolean;
-    pauseFutureMutation: (status: boolean) => void;
-    pauseFutureQueries: (status: boolean) => void;
-}
-export declare const usePauseFutureRequests: import("zustand").UseBoundStore<import("zustand").StoreApi<PauseFutureRequest>>;
+export interface PauseFutureRequest {
+    isFutureQueriesPaused: boolean;
+    isFutureMutationsPaused: boolean;
+    pauseFutureMutation: (status: boolean) => void;
+    pauseFutureQueries: (status: boolean) => void;
+}
+export declare const usePauseFutureRequests: import("zustand").UseBoundStore<import("zustand").StoreApi<PauseFutureRequest>>;

package/dist/stores/usePauseFutureRequests.js

@@ -1,18 +1,18 @@
 import { create } from 'zustand';
 
-const usePauseFutureRequests = create((set) => {
-    const pauseFutureQueries = (status) => {
-        return set({ isFutureQueriesPaused: status });
-    };
-    const pauseFutureMutation = (status) => {
-        return set({ isFutureQueriesPaused: status });
-    };
-    return {
-        isFutureMutationsPaused: false,
-        isFutureQueriesPaused: false,
-        pauseFutureQueries,
-        pauseFutureMutation,
-    };
+const usePauseFutureRequests = create((set) => {
+    const pauseFutureQueries = (status) => {
+        return set({ isFutureQueriesPaused: status });
+    };
+    const pauseFutureMutation = (status) => {
+        return set({ isFutureQueriesPaused: status });
+    };
+    return {
+        isFutureMutationsPaused: false,
+        isFutureQueriesPaused: false,
+        pauseFutureQueries,
+        pauseFutureMutation,
+    };
 });
 
 export { usePauseFutureRequests };

package/dist/types/index.d.ts

@@ -1,29 +1,27 @@
-import type { QueryKey } from '@tanstack/react-query';
-import type { RawAxiosRequestHeaders } from 'axios';
-import type { IMakeRequest } from '../request';
-export interface BootstrapConfig {
-    environments?: {
-        appBaseUrl: string;
-        appTimeout: number;
-    };
-    context?: ContextType;
-    modelConfig?: BootstrapModelConfig;
-    mutationMiddleware?: (mutateRequestConfig?: IMakeRequest & {
-        mutationKey: QueryKey;
-    }) => Promise<boolean>;
-    queryMiddleware?: (queryRequestConfig?: IMakeRequest & {
-        queryKey: QueryKey;
-    }) => Promise<boolean>;
-}
-export interface BootstrapModelConfig {
-    idColumn: string;
-}
-export type ContextType = 'app' | 'web' | 'electronjs';
-export interface TanstackQueryConfig {
-    options?: BootstrapConfig;
-}
-export interface IUseQueryHeaders {
-    getHeaders: () => QueryHeaders;
-    setQueryHeaders: (header: QueryHeaders) => void;
-}
-export type QueryHeaders = RawAxiosRequestHeaders | undefined;
+import type { RawAxiosRequestHeaders } from 'axios';
+import type { IRequestError, IRequestSuccess } from '../request';
+export interface BootstrapConfig {
+    environments?: {
+        appBaseUrl: string;
+        appTimeout: number;
+    };
+    context?: ContextType;
+    modelConfig?: BootstrapModelConfig;
+    middleware?: <T = any>(next: () => Promise<IRequestSuccess<T> | IRequestError>, configs?: {
+        baseUrl: string;
+        path: string;
+        body?: Record<string, any>;
+    }) => Promise<IRequestError | IRequestSuccess<T>>;
+}
+export interface BootstrapModelConfig {
+    idColumn: string;
+}
+export type ContextType = 'app' | 'web' | 'electronjs';
+export interface TanstackQueryConfig {
+    options?: BootstrapConfig;
+}
+export interface IUseQueryHeaders {
+    getHeaders: () => QueryHeaders;
+    setQueryHeaders: (header: QueryHeaders) => void;
+}
+export type QueryHeaders = RawAxiosRequestHeaders | undefined;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ventlio/tanstack-query",
-  "version": "0.5.4",
+  "version": "0.5.6",
   "license": "MIT",
   "main": "dist/index.js",
   "contributors": [
@@ -80,7 +80,7 @@
     "ts-jest": "^29.1.0",
     "ts-node": "^10.9.1",
     "tslib": "^2.5.0",
-    "typescript": "^4.9.5"
+    "typescript": "^5.5.4"
   },
   "files": [
     "dist/**/*",

package/src/queries/useDeleteRequest.ts

@@ -33,22 +33,21 @@ export const useDeleteRequest = <TResponse>(deleteOptions?: DefaultRequestOption
       timeout: TIMEOUT,
     };
 
-    let shouldContinue = true;
-
-    if (queryConfigOptions?.queryMiddleware) {
-      shouldContinue = await queryConfigOptions.queryMiddleware({ queryKey, ...requestOptions });
+    let deleteResponse: IRequestError | IRequestSuccess<TResponse>;
+    if (queryConfigOptions?.middleware) {
+      // perform global middleware
+      deleteResponse = await queryConfigOptions.middleware(async () => await makeRequest<TResponse>(requestOptions), {
+        path: requestUrl,
+        baseUrl: baseUrl ?? API_URL,
+      });
+    } else {
+      deleteResponse = await makeRequest<TResponse>(requestOptions);
     }
 
-    if (shouldContinue) {
-      const postResponse = await makeRequest<TResponse>(requestOptions);
-
-      if (postResponse.status) {
-        res(postResponse as IRequestSuccess<TResponse>);
-      } else {
-        rej(postResponse);
-      }
+    if (deleteResponse.status) {
+      res(deleteResponse as IRequestSuccess<TResponse>);
     } else {
-      rej(null);
+      rej(deleteResponse);
     }
   };
 
@@ -101,5 +100,5 @@ export const useDeleteRequest = <TResponse>(deleteOptions?: DefaultRequestOption
     // eslint-disable-next-line react-hooks/exhaustive-deps
   }, [isFutureQueriesPaused]);
 
-  return { destroy, ...query, isLoading: query.isLoading || isFutureQueriesPaused };
+  return { destroy, ...query, isLoading: (query.isLoading as boolean) || isFutureQueriesPaused };
 };

package/src/queries/useGetInfiniteRequest.ts

@@ -1,4 +1,4 @@
-import type { InfiniteData, QueryKey, UseQueryOptions } from '@tanstack/react-query';
+import type { InfiniteData, UseQueryOptions } from '@tanstack/react-query';
 import { useInfiniteQuery, useQueryClient } from '@tanstack/react-query';
 import { startTransition, useEffect, useMemo, useState } from 'react';
 import { useEnvironmentVariables, useQueryConfig } from '../config';
@@ -53,7 +53,6 @@ export const useGetInfiniteRequest = <TResponse extends Record<string, any>>({
         | PromiseLike<IRequestError | IRequestSuccess<TResponse & { pagination: Pagination }>>
     ) => void,
     rej: (reason?: any) => void,
-    queryKey: QueryKey,
     pageParam?: string
   ) => {
     if (load) {
@@ -66,25 +65,24 @@ export const useGetInfiniteRequest = <TResponse extends Record<string, any>>({
         timeout: TIMEOUT,
       };
 
-      let shouldContinue = true;
-
-      if (queryConfigOptions?.queryMiddleware) {
-        shouldContinue = await queryConfigOptions.queryMiddleware({ queryKey, ...requestOptions });
+      let getResponse: IRequestError | IRequestSuccess<TResponse>;
+      if (queryConfigOptions?.middleware) {
+        // perform global middleware
+        getResponse = await queryConfigOptions.middleware(async () => await makeRequest<TResponse>(requestOptions), {
+          path,
+          baseUrl: baseUrl ?? API_URL,
+        });
+      } else {
+        getResponse = await makeRequest<TResponse>(requestOptions);
       }
 
-      if (shouldContinue) {
-        const getResponse = await makeRequest<TResponse>(requestOptions);
-
-        if (getResponse.status) {
-          res(getResponse as IRequestSuccess<TResponse & { pagination: Pagination }>);
-        } else {
-          rej(getResponse);
-        }
+      if (getResponse.status) {
+        res(getResponse as IRequestSuccess<TResponse & { pagination: Pagination }>);
       } else {
-        rej(null);
+        rej(getResponse);
       }
     } else {
-      res(null as any);
+      rej(null);
     }
   };
 
@@ -112,9 +110,9 @@ export const useGetInfiniteRequest = <TResponse extends Record<string, any>>({
 
   const query = useInfiniteQuery<any, any, InfiniteData<IRequestSuccess<TResponse & { pagination: Pagination }>>>({
     queryKey: [requestPath, {}],
-    queryFn: ({ pageParam = requestPath, queryKey }) =>
+    queryFn: ({ pageParam = requestPath }) =>
       new Promise<IRequestSuccess<TResponse & { pagination: Pagination }> | IRequestError>((res, rej) =>
-        sendRequest(res, rej, queryKey, pageParam as string)
+        sendRequest(res, rej, pageParam as string)
       ),
     enabled: load && !isFutureQueriesPaused,
     getNextPageParam: (lastPage) => constructPaginationLink('next_page', lastPage),
@@ -185,6 +183,6 @@ export const useGetInfiniteRequest = <TResponse extends Record<string, any>>({
   return {
     get,
     ...query,
-    isLoading: query.isLoading || isFutureQueriesPaused,
+    isLoading: (query.isLoading as boolean) || isFutureQueriesPaused,
   };
 };

package/src/queries/useGetRequest.ts

@@ -1,12 +1,10 @@
-import type { QueryKey, UseQueryOptions } from '@tanstack/react-query';
-import { useQuery, useQueryClient } from '@tanstack/react-query';
+import { QueryKey, useQuery, useQueryClient, UseQueryOptions } from '@tanstack/react-query';
 import { startTransition, useEffect, useMemo, useState } from 'react';
 import { useEnvironmentVariables, useQueryConfig } from '../config';
 
-import type { IRequestError, IRequestSuccess } from '../request';
-import { makeRequest } from '../request';
+import { IRequestError, IRequestSuccess, makeRequest } from '../request';
 import { useHeaderStore, usePauseFutureRequests } from '../stores';
-import type { DefaultRequestOptions, IPagination, TanstackQueryOption } from './queries.interface';
+import { DefaultRequestOptions, IPagination, TanstackQueryOption } from './queries.interface';
 
 export const useGetRequest = <TResponse extends Record<string, any>>({
   path,
@@ -45,36 +43,31 @@ export const useGetRequest = <TResponse extends Record<string, any>>({
     rej: (reason?: any) => void,
     queryKey: QueryKey
   ) => {
-    if (load) {
-      const [url] = queryKey;
-      const requestUrl = (url ?? requestPath) as string;
-
-      const requestOptions = {
-        path: requestUrl,
-        headers: { ...globalHeaders, ...headers },
-        baseURL: baseUrl ?? API_URL,
-        timeout: TIMEOUT,
-      };
-
-      let shouldContinue = true;
-
-      if (queryConfigOptions?.queryMiddleware) {
-        shouldContinue = await queryConfigOptions.queryMiddleware({ queryKey, ...requestOptions });
-      }
-
-      if (shouldContinue) {
-        const getResponse = await makeRequest<TResponse>(requestOptions);
+    const [url] = queryKey;
+    const requestUrl = (url ?? requestPath) as string;
+
+    const requestOptions = {
+      path: requestUrl,
+      headers: { ...globalHeaders, ...headers },
+      baseURL: baseUrl ?? API_URL,
+      timeout: TIMEOUT,
+    };
+
+    let getResponse: IRequestError | IRequestSuccess<TResponse>;
+    if (queryConfigOptions?.middleware) {
+      // perform global middleware
+      getResponse = await queryConfigOptions.middleware(async () => await makeRequest<TResponse>(requestOptions), {
+        path,
+        baseUrl: baseUrl ?? API_URL,
+      });
+    } else {
+      getResponse = await makeRequest<TResponse>(requestOptions);
+    }
 
-        if (getResponse.status) {
-          res(getResponse as IRequestSuccess<TResponse>);
-        } else {
-          rej(getResponse);
-        }
-      } else {
-        rej(null);
-      }
+    if (getResponse.status) {
+      res(getResponse as IRequestSuccess<TResponse>);
     } else {
-      res(null as any);
+      rej(getResponse);
     }
   };
 
@@ -104,7 +97,7 @@ export const useGetRequest = <TResponse extends Record<string, any>>({
   }, [keyTracker, requestPath, queryClient, queryOptions?.staleTime]);
 
   const nextPage = () => {
-    if (query.data?.data.pagination) {
+    if (query.data.data.pagination) {
       const pagination: IPagination = query.data.data.pagination;
       if (pagination.next_page !== pagination.current_page && pagination.next_page > pagination.current_page) {
         setRequestPath(constructPaginationLink(requestPath, pagination.next_page));
@@ -113,7 +106,7 @@ export const useGetRequest = <TResponse extends Record<string, any>>({
   };
 
   const prevPage = () => {
-    if (query.data?.data.pagination) {
+    if (query.data.data.pagination) {
       const pagination: IPagination = query.data.data.pagination;
       if (pagination.previous_page !== pagination.current_page && pagination.previous_page < pagination.current_page) {
         setRequestPath(constructPaginationLink(requestPath, pagination.previous_page));
@@ -184,7 +177,7 @@ export const useGetRequest = <TResponse extends Record<string, any>>({
 
   return {
     ...query,
-    isLoading: query.isLoading || isFutureQueriesPaused,
+    isLoading: (query.isLoading as boolean) || isFutureQueriesPaused,
     setRequestPath,
     nextPage,
     prevPage,

package/src/queries/usePatchRequest.ts

@@ -33,32 +33,34 @@ export const usePatchRequest = <TResponse>({ path, baseUrl, headers }: { path: s
       onUploadProgress,
     };
 
-    let shouldContinue = true;
+    let patchResponse: IRequestError | IRequestSuccess<TResponse>;
+    if (config.options?.middleware) {
+      // perform global middleware
+      const middlewareResponse = await config.options.middleware(
+        async () => await makeRequest<TResponse>(requestOptions),
+        {
+          path,
+          baseUrl: baseUrl ?? API_URL,
+          body: data,
+        }
+      );
 
-    if (config.options?.mutationMiddleware) {
-      shouldContinue = await config.options.mutationMiddleware({
-        mutationKey: [path, { type: 'mutation' }],
-        ...requestOptions,
-      });
+      patchResponse = middlewareResponse;
+    } else {
+      patchResponse = await makeRequest<TResponse>(requestOptions);
     }
-
-    if (shouldContinue) {
-      const patchResponse = await makeRequest<TResponse>(requestOptions);
-      if (patchResponse.status) {
-        // scroll to top after success
-        if (config.options?.context !== 'app') {
-          scrollToTop();
-        }
-        res(patchResponse as IRequestSuccess<TResponse>);
-      } else {
-        // scroll to top after error
-        if (config.options?.context !== 'app') {
-          scrollToTop();
-        }
-        rej(patchResponse);
+    if (patchResponse.status) {
+      // scroll to top after success
+      if (config.options?.context !== 'app') {
+        scrollToTop();
       }
+      res(patchResponse as IRequestSuccess<TResponse>);
     } else {
-      rej(null);
+      // scroll to top after error
+      if (config.options?.context !== 'app') {
+        scrollToTop();
+      }
+      rej(patchResponse);
     }
   };
 

package/src/queries/usePostRequest.ts

@@ -59,34 +59,31 @@ export const usePostRequest = <TResponse>({
       ...requestConfig,
     };
 
-    let shouldContinue = true;
-
-    if (config.options?.mutationMiddleware) {
-      shouldContinue = await config.options.mutationMiddleware({
-        mutationKey: [path, { type: 'mutation' }],
-        ...requestOptions,
+    let postResponse: IRequestError | IRequestSuccess<TResponse>;
+    if (config.options?.middleware) {
+      // perform global middleware
+      postResponse = await config.options.middleware(async () => await makeRequest<TResponse>(requestOptions), {
+        path,
+        baseUrl: baseUrl ?? API_URL,
+        body: data,
       });
+    } else {
+      postResponse = await makeRequest<TResponse>(requestOptions);
     }
 
-    if (shouldContinue) {
-      const postResponse = await makeRequest<TResponse>(requestOptions);
-
-      if (postResponse.status) {
-        // scroll to top after success
-
-        if (config.options?.context !== 'app') {
-          scrollToTop();
-        }
-        res(postResponse as IRequestSuccess<TResponse>);
-      } else {
-        // scroll to top after error
-        if (config.options?.context !== 'app') {
-          scrollToTop();
-        }
-        rej(postResponse);
+    if (postResponse.status) {
+      // scroll to top after success
+
+      if (config.options?.context !== 'app') {
+        scrollToTop();
       }
+      res(postResponse as IRequestSuccess<TResponse>);
     } else {
-      rej(null);
+      // scroll to top after error
+      if (config.options?.context !== 'app') {
+        scrollToTop();
+      }
+      rej(postResponse);
     }
   };
 

package/src/queries/usePutRequest.ts

@@ -33,32 +33,29 @@ export const usePutRequest = <TResponse>({ path, baseUrl, headers }: { path: str
       onUploadProgress,
     };
 
-    let shouldContinue = true;
-
-    if (config.options?.mutationMiddleware) {
-      shouldContinue = await config.options.mutationMiddleware({
-        mutationKey: [path, { type: 'mutation' }],
-        ...requestOptions,
+    let putResponse: IRequestError | IRequestSuccess<TResponse>;
+    if (config.options?.middleware) {
+      // perform global middleware
+      putResponse = await config.options.middleware(async () => await makeRequest<TResponse>(requestOptions), {
+        path,
+        baseUrl: baseUrl ?? API_URL,
+        body: data,
       });
+    } else {
+      putResponse = await makeRequest<TResponse>(requestOptions);
     }
-
-    if (shouldContinue) {
-      const putResponse = await makeRequest<TResponse>(requestOptions);
-      if (putResponse.status) {
-        // scroll to top after success
-        if (config.options?.context !== 'app') {
-          scrollToTop();
-        }
-        res(putResponse as IRequestSuccess<TResponse>);
-      } else {
-        // scroll to top after error
-        if (config.options?.context !== 'app') {
-          scrollToTop();
-        }
-        rej(putResponse);
+    if (putResponse.status) {
+      // scroll to top after success
+      if (config.options?.context !== 'app') {
+        scrollToTop();
       }
+      res(putResponse as IRequestSuccess<TResponse>);
     } else {
-      rej(null);
+      // scroll to top after error
+      if (config.options?.context !== 'app') {
+        scrollToTop();
+      }
+      rej(putResponse);
     }
   };
 

package/src/request/make-request.ts

@@ -3,7 +3,7 @@ import axios from 'axios';
 import { axiosInstance } from './axios-instance';
 
 import { ContentType, HttpMethod } from './request.enum';
-import type { IMakeRequest } from './request.interface';
+import type { IMakeRequest, IRequestError, IRequestSuccess } from './request.interface';
 import { errorTransformer, successTransformer } from './transformer';
 
 export async function makeRequest<TResponse>({
@@ -16,7 +16,7 @@ export async function makeRequest<TResponse>({
   timeout,
   appFileConfig,
   onUploadProgress,
-}: IMakeRequest) {
+}: IMakeRequest): Promise<IRequestSuccess<TResponse> | IRequestError> {
   // check if file is included in mobile app environment and extract all file input to avoid
   // it being formatted to object using axios formData builder
   const isApp = appFileConfig?.isApp;

package/src/request/transformer.ts

@@ -4,9 +4,9 @@ import type { IRequestError, IRequestSuccess, IServerRequestError, IServerReques
 export const errorTransformer = (data: IServerRequestError & { statusCode: number }): IRequestError => {
   return {
     timeStamp: new Date(),
-    status: false,
     data: data.data,
     ...data,
+    status: false,
   };
 };
 

package/src/types/index.ts

@@ -1,6 +1,5 @@
-import type { QueryKey } from '@tanstack/react-query';
 import type { RawAxiosRequestHeaders } from 'axios';
-import type { IMakeRequest } from '../request';
+import type { IRequestError, IRequestSuccess } from '../request';
 
 export interface BootstrapConfig {
   environments?: {
@@ -9,8 +8,10 @@ export interface BootstrapConfig {
   };
   context?: ContextType;
   modelConfig?: BootstrapModelConfig;
-  mutationMiddleware?: (mutateRequestConfig?: IMakeRequest & { mutationKey: QueryKey }) => Promise<boolean>;
-  queryMiddleware?: (queryRequestConfig?: IMakeRequest & { queryKey: QueryKey }) => Promise<boolean>;
+  middleware?: <T = any>(
+    next: () => Promise<IRequestSuccess<T> | IRequestError>,
+    configs?: { baseUrl: string; path: string; body?: Record<string, any> }
+  ) => Promise<IRequestError | IRequestSuccess<T>>;
 }
 
 export interface BootstrapModelConfig {