@ventlio/tanstack-query 0.5.4 → 0.5.5

package/dist/request/make-request.js

@@ -3,86 +3,86 @@ import { axiosInstance } from './axios-instance.js';
 import { HttpMethod, ContentType } from './request.enum.js';
 import { errorTransformer, successTransformer } from './transformer.js';
 
-async function makeRequest({ body = {}, method = HttpMethod.GET, path, isFormData, headers = {}, baseURL, timeout, appFileConfig, onUploadProgress, }) {
-    // 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;
-    const appFiles = isApp ? getAppFiles(body, appFileConfig.fileSelectors) : {};
-    // configure body
-    body = (isFormData ? axios.toFormData(body) : body);
-    // configure request header1
-    configureRequestHeader(isFormData, headers, isApp, appFiles, body);
-    try {
-        const axiosRequest = axiosInstance({ baseURL, headers, timeout });
-        const axiosRequestConfig = {
-            url: path,
-            method,
-            onUploadProgress,
-        };
-        if (Object.keys(body).length > 0 || (isFormData && !isApp && [...body.keys()].length > 0)) {
-            axiosRequestConfig.data = body;
-        }
-        //   send request
-        const resp = await axiosRequest(axiosRequestConfig);
-        // get response json
-        const jsonResp = await resp.data;
-        // get response code
-        const responseCode = resp.status;
-        if (responseCode > 299) {
-            // server returned an error
-            return errorTransformer({ ...jsonResp, statusCode: responseCode });
-        }
-        return successTransformer({
-            statusCode: responseCode,
-            ...jsonResp,
-            status: resp.status,
-        });
-    }
-    catch (error) {
-        const errorData = error?.response?.data;
-        return errorTransformer({
-            statusCode: error.status,
-            message: error.message,
-            code: error.status || error.statusCode,
-            ...errorData,
-        });
-    }
-}
-const configureRequestHeader = (isFormData, headers, isApp, appFiles, body) => {
-    if (!isFormData) {
-        headers['Content-Type'] = ContentType.APPLICATION_JSON;
-    }
-    else if (isApp) {
-        headers['Content-Type'] = ContentType.MULTIPART_FORM_DATA;
-        // add the app files
-        for (const fileKey in appFiles) {
-            const currentFile = appFiles[fileKey];
-            if (Array.isArray(currentFile)) {
-                for (const innerFile of currentFile) {
-                    body.append(fileKey, innerFile);
-                }
-            }
-            else {
-                body.append(fileKey, currentFile);
-            }
-        }
-    }
-    else {
-        delete headers['Content-Type'];
-    }
-};
-function getAppFiles(body, fileSelectors = []) {
-    const files = {};
-    if (body) {
-        if (fileSelectors.length > 0) {
-            //
-            for (const fileKey of fileSelectors) {
-                files[fileKey] = body[fileKey];
-                delete body[fileKey];
-            }
-        }
-    }
-    return files;
+async function makeRequest({ body = {}, method = HttpMethod.GET, path, isFormData, headers = {}, baseURL, timeout, appFileConfig, onUploadProgress, }) {
+    // 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;
+    const appFiles = isApp ? getAppFiles(body, appFileConfig.fileSelectors) : {};
+    // configure body
+    body = (isFormData ? axios.toFormData(body) : body);
+    // configure request header1
+    configureRequestHeader(isFormData, headers, isApp, appFiles, body);
+    try {
+        const axiosRequest = axiosInstance({ baseURL, headers, timeout });
+        const axiosRequestConfig = {
+            url: path,
+            method,
+            onUploadProgress,
+        };
+        if (Object.keys(body).length > 0 || (isFormData && !isApp && [...body.keys()].length > 0)) {
+            axiosRequestConfig.data = body;
+        }
+        //   send request
+        const resp = await axiosRequest(axiosRequestConfig);
+        // get response json
+        const jsonResp = await resp.data;
+        // get response code
+        const responseCode = resp.status;
+        if (responseCode > 299) {
+            // server returned an error
+            return errorTransformer({ ...jsonResp, statusCode: responseCode });
+        }
+        return successTransformer({
+            statusCode: responseCode,
+            ...jsonResp,
+            status: resp.status,
+        });
+    }
+    catch (error) {
+        const errorData = error?.response?.data;
+        return errorTransformer({
+            statusCode: error.status,
+            message: error.message,
+            code: error.status || error.statusCode,
+            ...errorData,
+        });
+    }
+}
+const configureRequestHeader = (isFormData, headers, isApp, appFiles, body) => {
+    if (!isFormData) {
+        headers['Content-Type'] = ContentType.APPLICATION_JSON;
+    }
+    else if (isApp) {
+        headers['Content-Type'] = ContentType.MULTIPART_FORM_DATA;
+        // add the app files
+        for (const fileKey in appFiles) {
+            const currentFile = appFiles[fileKey];
+            if (Array.isArray(currentFile)) {
+                for (const innerFile of currentFile) {
+                    body.append(fileKey, innerFile);
+                }
+            }
+            else {
+                body.append(fileKey, currentFile);
+            }
+        }
+    }
+    else {
+        delete headers['Content-Type'];
+    }
+};
+function getAppFiles(body, fileSelectors = []) {
+    const files = {};
+    if (body) {
+        if (fileSelectors.length > 0) {
+            //
+            for (const fileKey of fileSelectors) {
+                files[fileKey] = body[fileKey];
+                delete body[fileKey];
+            }
+        }
+    }
+    return files;
 }
 
 export { makeRequest };

package/dist/request/request.enum.d.ts

@@ -1,11 +1,11 @@
-export declare enum HttpMethod {
-    GET = "GET",
-    POST = "POST",
-    PUT = "PUT",
-    PATCH = "PATCH",
-    DELETE = "DELETE"
-}
-export declare enum ContentType {
-    APPLICATION_JSON = "application/json",
-    MULTIPART_FORM_DATA = "multipart/form-data"
-}
+export declare enum HttpMethod {
+    GET = "GET",
+    POST = "POST",
+    PUT = "PUT",
+    PATCH = "PATCH",
+    DELETE = "DELETE"
+}
+export declare enum ContentType {
+    APPLICATION_JSON = "application/json",
+    MULTIPART_FORM_DATA = "multipart/form-data"
+}

package/dist/request/request.enum.js

@@ -1,15 +1,15 @@
-var HttpMethod;
-(function (HttpMethod) {
-    HttpMethod["GET"] = "GET";
-    HttpMethod["POST"] = "POST";
-    HttpMethod["PUT"] = "PUT";
-    HttpMethod["PATCH"] = "PATCH";
-    HttpMethod["DELETE"] = "DELETE";
-})(HttpMethod || (HttpMethod = {}));
-var ContentType;
-(function (ContentType) {
-    ContentType["APPLICATION_JSON"] = "application/json";
-    ContentType["MULTIPART_FORM_DATA"] = "multipart/form-data";
+var HttpMethod;
+(function (HttpMethod) {
+    HttpMethod["GET"] = "GET";
+    HttpMethod["POST"] = "POST";
+    HttpMethod["PUT"] = "PUT";
+    HttpMethod["PATCH"] = "PATCH";
+    HttpMethod["DELETE"] = "DELETE";
+})(HttpMethod || (HttpMethod = {}));
+var ContentType;
+(function (ContentType) {
+    ContentType["APPLICATION_JSON"] = "application/json";
+    ContentType["MULTIPART_FORM_DATA"] = "multipart/form-data";
 })(ContentType || (ContentType = {}));
 
 export { ContentType, HttpMethod };

package/dist/request/request.interface.d.ts

@@ -1,48 +1,48 @@
-import type { AxiosProgressEvent, RawAxiosRequestHeaders } from 'axios';
-import type { HttpMethod } from './request.enum';
-export interface IMakeRequest {
-    baseURL: string;
-    timeout?: number;
-    path: string;
-    body?: Record<string, any> | null;
-    method?: HttpMethod;
-    isFormData?: boolean;
-    headers: RawAxiosRequestHeaders;
-    appFileConfig?: AppFileConfig;
-    onUploadProgress?: (progressEvent: AxiosProgressEvent) => void;
-}
-export interface AppFileConfig {
-    fileSelectors?: string[];
-    isApp: boolean;
-}
-export interface AxiosInstanceOption {
-    bearerToken?: string;
-    contentType?: string;
-}
-export interface IRequestError {
-    statusCode: number;
-    message: string;
-    timeStamp: Date;
-    status: boolean;
-    data?: any;
-}
-export interface IRequestSuccess<T> {
-    statusCode: number;
-    message: string;
-    timeStamp: Date;
-    status: boolean;
-    data: T;
-}
-export interface IServerRequestSuccess {
-    status?: boolean;
-    data: any;
-    message?: string;
-}
-export interface IServerRequestError {
-    status?: boolean;
-    code?: number;
-    success?: boolean;
-    message: string;
-    error?: Record<string, any>;
-    data?: Record<string, any>;
-}
+import type { AxiosProgressEvent, RawAxiosRequestHeaders } from 'axios';
+import type { HttpMethod } from './request.enum';
+export interface IMakeRequest {
+    baseURL: string;
+    timeout?: number;
+    path: string;
+    body?: Record<string, any> | null;
+    method?: HttpMethod;
+    isFormData?: boolean;
+    headers: RawAxiosRequestHeaders;
+    appFileConfig?: AppFileConfig;
+    onUploadProgress?: (progressEvent: AxiosProgressEvent) => void;
+}
+export interface AppFileConfig {
+    fileSelectors?: string[];
+    isApp: boolean;
+}
+export interface AxiosInstanceOption {
+    bearerToken?: string;
+    contentType?: string;
+}
+export interface IRequestError {
+    statusCode: number;
+    message: string;
+    timeStamp: Date;
+    status: boolean;
+    data?: any;
+}
+export interface IRequestSuccess<T> {
+    statusCode: number;
+    message: string;
+    timeStamp: Date;
+    status: boolean;
+    data: T;
+}
+export interface IServerRequestSuccess {
+    status?: boolean;
+    data: any;
+    message?: string;
+}
+export interface IServerRequestError {
+    status?: boolean;
+    code?: number;
+    success?: boolean;
+    message: string;
+    error?: Record<string, any>;
+    data?: Record<string, any>;
+}

package/dist/request/transformer.d.ts

@@ -1,7 +1,7 @@
-import type { IRequestError, IRequestSuccess, IServerRequestError, IServerRequestSuccess } from './request.interface';
-export declare const errorTransformer: (data: IServerRequestError & {
-    statusCode: number;
-}) => IRequestError;
-export declare const successTransformer: <T>(data: IServerRequestSuccess & {
-    statusCode: number;
-}) => IRequestSuccess<T>;
+import type { IRequestError, IRequestSuccess, IServerRequestError, IServerRequestSuccess } from './request.interface';
+export declare const errorTransformer: (data: IServerRequestError & {
+    statusCode: number;
+}) => IRequestError;
+export declare const successTransformer: <T>(data: IServerRequestSuccess & {
+    statusCode: number;
+}) => IRequestSuccess<T>;

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,34 @@
-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 { QueryKey } from '@tanstack/react-query';
+import type { RawAxiosRequestHeaders } from 'axios';
+import type { IMakeRequest, IRequestError, IRequestSuccess } 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>;
+    middleware?: <T = any>(next: () => Promise<IRequestSuccess<T> | IRequestError>, configs?: {
+        baseUrl: string;
+        path: string;
+        body?: Record<string, any>;
+    }) => Promise<false | 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.5",
   "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

@@ -40,12 +40,31 @@ export const useDeleteRequest = <TResponse>(deleteOptions?: DefaultRequestOption
     }
 
     if (shouldContinue) {
-      const postResponse = await makeRequest<TResponse>(requestOptions);
+      let deleteResponse: IRequestError | IRequestSuccess<TResponse>;
+      if (queryConfigOptions?.middleware) {
+        // perform global middleware
+        const middlewareResponse = await queryConfigOptions.middleware(
+          async () => await makeRequest<TResponse>(requestOptions),
+          {
+            path: requestUrl,
+            baseUrl: baseUrl ?? API_URL,
+          }
+        );
+
+        if (!middlewareResponse) {
+          rej();
+          return;
+        }
+
+        deleteResponse = middlewareResponse;
+      } else {
+        deleteResponse = await makeRequest<TResponse>(requestOptions);
+      }
 
-      if (postResponse.status) {
-        res(postResponse as IRequestSuccess<TResponse>);
+      if (deleteResponse.status) {
+        res(deleteResponse as IRequestSuccess<TResponse>);
       } else {
-        rej(postResponse);
+        rej(deleteResponse);
       }
     } else {
       rej(null);
@@ -101,5 +120,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

@@ -73,7 +73,26 @@ export const useGetInfiniteRequest = <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 & { pagination: Pagination }>);
@@ -185,6 +204,6 @@ export const useGetInfiniteRequest = <TResponse extends Record<string, any>>({
   return {
     get,
     ...query,
-    isLoading: query.isLoading || isFutureQueriesPaused,
+    isLoading: (query.isLoading as boolean) || isFutureQueriesPaused,
   };
 };