@ventlio/tanstack-query 0.5.4 → 0.5.6

package/dist/queries/usePutRequest.d.ts

@@ -1,86 +1,86 @@
-import type { MutateOptions } from '@tanstack/react-query';
-import type { IRequestError, IRequestSuccess } from '../request/request.interface';
-import type { DefaultRequestOptions } from './queries.interface';
-export declare const usePutRequest: <TResponse>({ path, baseUrl, headers }: {
-    path: string;
-} & DefaultRequestOptions) => {
-    isLoading: boolean;
-    data: undefined;
-    variables: undefined;
-    error: null;
-    isError: false;
-    isIdle: true;
-    isPending: false;
-    isSuccess: false;
-    status: "idle";
-    mutate: import("@tanstack/react-query/build/legacy/types").UseMutateFunction<IRequestSuccess<TResponse>, IRequestError, void, unknown>;
-    reset: () => void;
-    context: unknown;
-    failureCount: number;
-    failureReason: IRequestError | null;
-    isPaused: boolean;
-    submittedAt: number;
-    mutateAsync: import("@tanstack/react-query/build/legacy/types").UseMutateAsyncFunction<IRequestSuccess<TResponse>, IRequestError, void, unknown>;
-    put: (data: any, options?: MutateOptions<IRequestSuccess<TResponse>, IRequestError, void, unknown> | undefined) => Promise<IRequestSuccess<TResponse> | undefined>;
-    uploadProgressPercent: number;
-} | {
-    isLoading: boolean;
-    data: undefined;
-    variables: void;
-    error: null;
-    isError: false;
-    isIdle: false;
-    isPending: true;
-    isSuccess: false;
-    status: "pending";
-    mutate: import("@tanstack/react-query/build/legacy/types").UseMutateFunction<IRequestSuccess<TResponse>, IRequestError, void, unknown>;
-    reset: () => void;
-    context: unknown;
-    failureCount: number;
-    failureReason: IRequestError | null;
-    isPaused: boolean;
-    submittedAt: number;
-    mutateAsync: import("@tanstack/react-query/build/legacy/types").UseMutateAsyncFunction<IRequestSuccess<TResponse>, IRequestError, void, unknown>;
-    put: (data: any, options?: MutateOptions<IRequestSuccess<TResponse>, IRequestError, void, unknown> | undefined) => Promise<IRequestSuccess<TResponse> | undefined>;
-    uploadProgressPercent: number;
-} | {
-    isLoading: boolean;
-    data: undefined;
-    error: IRequestError;
-    variables: void;
-    isError: true;
-    isIdle: false;
-    isPending: false;
-    isSuccess: false;
-    status: "error";
-    mutate: import("@tanstack/react-query/build/legacy/types").UseMutateFunction<IRequestSuccess<TResponse>, IRequestError, void, unknown>;
-    reset: () => void;
-    context: unknown;
-    failureCount: number;
-    failureReason: IRequestError | null;
-    isPaused: boolean;
-    submittedAt: number;
-    mutateAsync: import("@tanstack/react-query/build/legacy/types").UseMutateAsyncFunction<IRequestSuccess<TResponse>, IRequestError, void, unknown>;
-    put: (data: any, options?: MutateOptions<IRequestSuccess<TResponse>, IRequestError, void, unknown> | undefined) => Promise<IRequestSuccess<TResponse> | undefined>;
-    uploadProgressPercent: number;
-} | {
-    isLoading: boolean;
-    data: IRequestSuccess<TResponse>;
-    error: null;
-    variables: void;
-    isError: false;
-    isIdle: false;
-    isPending: false;
-    isSuccess: true;
-    status: "success";
-    mutate: import("@tanstack/react-query/build/legacy/types").UseMutateFunction<IRequestSuccess<TResponse>, IRequestError, void, unknown>;
-    reset: () => void;
-    context: unknown;
-    failureCount: number;
-    failureReason: IRequestError | null;
-    isPaused: boolean;
-    submittedAt: number;
-    mutateAsync: import("@tanstack/react-query/build/legacy/types").UseMutateAsyncFunction<IRequestSuccess<TResponse>, IRequestError, void, unknown>;
-    put: (data: any, options?: MutateOptions<IRequestSuccess<TResponse>, IRequestError, void, unknown> | undefined) => Promise<IRequestSuccess<TResponse> | undefined>;
-    uploadProgressPercent: number;
-};
+import type { MutateOptions } from '@tanstack/react-query';
+import type { IRequestError, IRequestSuccess } from '../request/request.interface';
+import type { DefaultRequestOptions } from './queries.interface';
+export declare const usePutRequest: <TResponse>({ path, baseUrl, headers }: {
+    path: string;
+} & DefaultRequestOptions) => {
+    isLoading: boolean;
+    data: undefined;
+    variables: undefined;
+    error: null;
+    isError: false;
+    isIdle: true;
+    isPending: false;
+    isSuccess: false;
+    status: "idle";
+    mutate: import("@tanstack/react-query").UseMutateFunction<IRequestSuccess<TResponse>, IRequestError, void, unknown>;
+    reset: () => void;
+    context: unknown;
+    failureCount: number;
+    failureReason: IRequestError | null;
+    isPaused: boolean;
+    submittedAt: number;
+    mutateAsync: import("@tanstack/react-query").UseMutateAsyncFunction<IRequestSuccess<TResponse>, IRequestError, void, unknown>;
+    put: (data: any, options?: MutateOptions<IRequestSuccess<TResponse>, IRequestError, void, unknown> | undefined) => Promise<IRequestSuccess<TResponse> | undefined>;
+    uploadProgressPercent: number;
+} | {
+    isLoading: boolean;
+    data: undefined;
+    variables: void;
+    error: null;
+    isError: false;
+    isIdle: false;
+    isPending: true;
+    isSuccess: false;
+    status: "pending";
+    mutate: import("@tanstack/react-query").UseMutateFunction<IRequestSuccess<TResponse>, IRequestError, void, unknown>;
+    reset: () => void;
+    context: unknown;
+    failureCount: number;
+    failureReason: IRequestError | null;
+    isPaused: boolean;
+    submittedAt: number;
+    mutateAsync: import("@tanstack/react-query").UseMutateAsyncFunction<IRequestSuccess<TResponse>, IRequestError, void, unknown>;
+    put: (data: any, options?: MutateOptions<IRequestSuccess<TResponse>, IRequestError, void, unknown> | undefined) => Promise<IRequestSuccess<TResponse> | undefined>;
+    uploadProgressPercent: number;
+} | {
+    isLoading: boolean;
+    data: undefined;
+    error: IRequestError;
+    variables: void;
+    isError: true;
+    isIdle: false;
+    isPending: false;
+    isSuccess: false;
+    status: "error";
+    mutate: import("@tanstack/react-query").UseMutateFunction<IRequestSuccess<TResponse>, IRequestError, void, unknown>;
+    reset: () => void;
+    context: unknown;
+    failureCount: number;
+    failureReason: IRequestError | null;
+    isPaused: boolean;
+    submittedAt: number;
+    mutateAsync: import("@tanstack/react-query").UseMutateAsyncFunction<IRequestSuccess<TResponse>, IRequestError, void, unknown>;
+    put: (data: any, options?: MutateOptions<IRequestSuccess<TResponse>, IRequestError, void, unknown> | undefined) => Promise<IRequestSuccess<TResponse> | undefined>;
+    uploadProgressPercent: number;
+} | {
+    isLoading: boolean;
+    data: IRequestSuccess<TResponse>;
+    error: null;
+    variables: void;
+    isError: false;
+    isIdle: false;
+    isPending: false;
+    isSuccess: true;
+    status: "success";
+    mutate: import("@tanstack/react-query").UseMutateFunction<IRequestSuccess<TResponse>, IRequestError, void, unknown>;
+    reset: () => void;
+    context: unknown;
+    failureCount: number;
+    failureReason: IRequestError | null;
+    isPaused: boolean;
+    submittedAt: number;
+    mutateAsync: import("@tanstack/react-query").UseMutateAsyncFunction<IRequestSuccess<TResponse>, IRequestError, void, unknown>;
+    put: (data: any, options?: MutateOptions<IRequestSuccess<TResponse>, IRequestError, void, unknown> | undefined) => Promise<IRequestSuccess<TResponse> | undefined>;
+    uploadProgressPercent: number;
+};

package/dist/request/axios-instance.d.ts

@@ -1,3 +1,3 @@
-import type { AxiosInstance } from 'axios';
-import type { IMakeRequest } from './request.interface';
-export declare const axiosInstance: ({ baseURL, timeout, headers }: Partial<IMakeRequest>) => AxiosInstance;
+import type { AxiosInstance } from 'axios';
+import type { IMakeRequest } from './request.interface';
+export declare const axiosInstance: ({ baseURL, timeout, headers }: Partial<IMakeRequest>) => AxiosInstance;

package/dist/request/axios-instance.js

@@ -1,11 +1,11 @@
 import axios from 'axios';
 
-const axiosInstance = ({ baseURL, timeout, headers }) => {
-    return axios.create({
-        baseURL,
-        timeout,
-        headers,
-    });
+const axiosInstance = ({ baseURL, timeout, headers }) => {
+    return axios.create({
+        baseURL,
+        timeout,
+        headers,
+    });
 };
 
 export { axiosInstance };

package/dist/request/buildFormData.d.ts

@@ -1 +1 @@
-export declare const buildFormData: (body: Record<string, any>) => FormData;
+export declare const buildFormData: (body: Record<string, any>) => FormData;

package/dist/request/buildFormData.js

@@ -1,43 +1,43 @@
-const buildFormData = (body) => {
-    const formData = new FormData();
-    const handleArrayValue = (key, value) => {
-        for (const item of value) {
-            if (item instanceof File) {
-                formData.append(key, item);
-            }
-            else if (item instanceof Object) {
-                formData.append(key, JSON.stringify(item));
-            }
-            else {
-                formData.append(key, item);
-            }
-        }
-    };
-    const handleObjectValue = (key, value) => {
-        if (value instanceof File) {
-            formData.append(key, value);
-        }
-        else {
-            formData.append(key, JSON.stringify(value));
-        }
-    };
-    const handlePrimitiveValue = (key, value) => {
-        formData.append(key, value);
-    };
-    const bodyKeys = Object.keys(body);
-    bodyKeys.forEach((key) => {
-        const inputValue = body[key];
-        if (Array.isArray(inputValue) && inputValue.length > 0) {
-            handleArrayValue(key, inputValue);
-        }
-        else if (inputValue instanceof Object) {
-            handleObjectValue(key, inputValue);
-        }
-        else {
-            handlePrimitiveValue(key, inputValue);
-        }
-    });
-    return formData;
+const buildFormData = (body) => {
+    const formData = new FormData();
+    const handleArrayValue = (key, value) => {
+        for (const item of value) {
+            if (item instanceof File) {
+                formData.append(key, item);
+            }
+            else if (item instanceof Object) {
+                formData.append(key, JSON.stringify(item));
+            }
+            else {
+                formData.append(key, item);
+            }
+        }
+    };
+    const handleObjectValue = (key, value) => {
+        if (value instanceof File) {
+            formData.append(key, value);
+        }
+        else {
+            formData.append(key, JSON.stringify(value));
+        }
+    };
+    const handlePrimitiveValue = (key, value) => {
+        formData.append(key, value);
+    };
+    const bodyKeys = Object.keys(body);
+    bodyKeys.forEach((key) => {
+        const inputValue = body[key];
+        if (Array.isArray(inputValue) && inputValue.length > 0) {
+            handleArrayValue(key, inputValue);
+        }
+        else if (inputValue instanceof Object) {
+            handleObjectValue(key, inputValue);
+        }
+        else {
+            handlePrimitiveValue(key, inputValue);
+        }
+    });
+    return formData;
 };
 
 export { buildFormData };

package/dist/request/index.d.ts

@@ -1,6 +1,6 @@
-export * from './axios-instance';
-export * from './buildFormData';
-export * from './make-request';
-export * from './request.enum';
-export * from './request.interface';
-export * from './transformer';
+export * from './axios-instance';
+export * from './buildFormData';
+export * from './make-request';
+export * from './request.enum';
+export * from './request.interface';
+export * from './transformer';

package/dist/request/make-request.d.ts

@@ -1,2 +1,2 @@
-import type { IMakeRequest } from './request.interface';
-export declare function makeRequest<TResponse>({ body, method, path, isFormData, headers, baseURL, timeout, appFileConfig, onUploadProgress, }: IMakeRequest): Promise<import("./request.interface").IRequestError>;
+import type { IMakeRequest, IRequestError, IRequestSuccess } from './request.interface';
+export declare function makeRequest<TResponse>({ body, method, path, isFormData, headers, baseURL, timeout, appFileConfig, onUploadProgress, }: IMakeRequest): Promise<IRequestSuccess<TResponse> | IRequestError>;

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>;