@ventlio/tanstack-query 0.5.4 → 0.5.5

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,
@@ -63,7 +61,26 @@ export const useGetRequest = <TResponse extends Record<string, any>>({
       }
 
       if (shouldContinue) {
-        const getResponse = await makeRequest<TResponse>(requestOptions);
+        let getResponse: IRequestError | IRequestSuccess<TResponse>;
+        if (queryConfigOptions?.middleware) {
+          // perform global middleware
+          const middlewareResponse = await queryConfigOptions.middleware(
+            async () => await makeRequest<TResponse>(requestOptions),
+            {
+              path,
+              baseUrl: baseUrl ?? API_URL,
+            }
+          );
+
+          if (!middlewareResponse) {
+            rej();
+            return;
+          }
+
+          getResponse = middlewareResponse;
+        } else {
+          getResponse = await makeRequest<TResponse>(requestOptions);
+        }
 
         if (getResponse.status) {
           res(getResponse as IRequestSuccess<TResponse>);
@@ -104,7 +121,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 +130,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 +201,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

@@ -43,7 +43,27 @@ export const usePatchRequest = <TResponse>({ path, baseUrl, headers }: { path: s
     }
 
     if (shouldContinue) {
-      const patchResponse = await makeRequest<TResponse>(requestOptions);
+      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 (!middlewareResponse) {
+          rej();
+          return;
+        }
+
+        patchResponse = middlewareResponse;
+      } else {
+        patchResponse = await makeRequest<TResponse>(requestOptions);
+      }
       if (patchResponse.status) {
         // scroll to top after success
         if (config.options?.context !== 'app') {

package/src/queries/usePostRequest.ts

@@ -69,7 +69,27 @@ export const usePostRequest = <TResponse>({
     }
 
     if (shouldContinue) {
-      const postResponse = await makeRequest<TResponse>(requestOptions);
+      let postResponse: 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 (!middlewareResponse) {
+          rej();
+          return;
+        }
+
+        postResponse = middlewareResponse;
+      } else {
+        postResponse = await makeRequest<TResponse>(requestOptions);
+      }
 
       if (postResponse.status) {
         // scroll to top after success

package/src/queries/usePutRequest.ts

@@ -43,7 +43,27 @@ export const usePutRequest = <TResponse>({ path, baseUrl, headers }: { path: str
     }
 
     if (shouldContinue) {
-      const putResponse = await makeRequest<TResponse>(requestOptions);
+      let putResponse: 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 (!middlewareResponse) {
+          rej();
+          return;
+        }
+
+        putResponse = middlewareResponse;
+      } else {
+        putResponse = await makeRequest<TResponse>(requestOptions);
+      }
       if (putResponse.status) {
         // scroll to top after success
         if (config.options?.context !== 'app') {

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,6 @@
 import type { QueryKey } from '@tanstack/react-query';
 import type { RawAxiosRequestHeaders } from 'axios';
-import type { IMakeRequest } from '../request';
+import type { IMakeRequest, IRequestError, IRequestSuccess } from '../request';
 
 export interface BootstrapConfig {
   environments?: {
@@ -11,6 +11,10 @@ export interface BootstrapConfig {
   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<false | IRequestSuccess<T>>;
 }
 
 export interface BootstrapModelConfig {