query-harbor 0.0.5 → 0.0.6

package/dist/hooks/apiHandler.d.ts

@@ -0,0 +1,24 @@
+import { AxiosRequestHeaders, AxiosResponse } from 'axios';
+interface ActionHandlerParams {
+    action: "GET" | "POST" | "PUT" | "DELETE";
+    url: string;
+    data?: any;
+    headers?: AxiosRequestHeaders;
+}
+export interface ApiSuccessResponse {
+    status: true;
+    data: any;
+    message?: string;
+    statusCode: number;
+}
+interface ApiErrorResponse {
+    status: false;
+    error: string;
+    message: string;
+    statusCode?: number;
+    type?: string;
+}
+type ApiResponse = ApiSuccessResponse | ApiErrorResponse;
+export declare const ActionHandler: ({ action, url, data, headers }: ActionHandlerParams) => Promise<AxiosResponse>;
+export declare const APIHandler: ({ action, url, data, headers }: ActionHandlerParams) => Promise<ApiResponse>;
+export {};

package/dist/hooks/useCookie.d.ts

@@ -0,0 +1,24 @@
+/**
+ *
+ * @example
+ * // Usage example:
+ * const { cookie, setCookie, removeCookie } = useCookie({ cookieName: "accessToken" });
+ *
+ * // Get cookie value
+ * const token = cookie.accessToken;
+ *
+ * // Set new cookie
+ * setCookie("accessToken", "new-token-value", { path: "/", maxAge: 3600 });
+ *
+ * // Remove cookie
+ * removeCookie("accessToken", { path: "/" });
+ */
+export declare const useCookie: ({ cookieName }: {
+    cookieName: string;
+}) => {
+    cookie: {
+        [x: string]: any;
+    };
+    setCookie: (name: string, value: import('universal-cookie').Cookie, options?: import('universal-cookie').CookieSetOptions) => void;
+    removeCookie: (name: string, options?: import('universal-cookie').CookieSetOptions) => void;
+};

package/dist/hooks/useGlobalInfiniteQuery.d.ts

@@ -0,0 +1,28 @@
+interface UseGlobalInfiniteQueryParams<T> {
+    url: string;
+    queryKey: string[];
+    methodType: "GET" | "POST" | "PUT" | "DELETE";
+    data?: T;
+    enabled?: boolean;
+    staleTime?: number;
+}
+interface QueryResult<T> {
+    data: T[];
+    nextPage?: number;
+    hasMore: boolean;
+    totalCount: number;
+}
+/**
+ * Custom hook for handling infinite scrolling queries with React Query.
+ */
+export declare const useGlobalInfiniteQuery: <T>({ url, queryKey, methodType, data, enabled, staleTime, }: UseGlobalInfiniteQueryParams<T>) => {
+    refetchQuery: () => void;
+    queryData: any[];
+    isLoading: boolean;
+    isError: boolean;
+    error: Error;
+    fetchNextPage: (options?: import('@tanstack/react-query').FetchNextPageOptions) => Promise<import('@tanstack/react-query').InfiniteQueryObserverResult<import('@tanstack/react-query').InfiniteData<QueryResult<T>, unknown>, Error>>;
+    hasNextPage: boolean;
+    totalCount: number;
+};
+export {};

package/dist/hooks/useGlobalMutation.d.ts

@@ -0,0 +1,32 @@
+interface UseGlobalMutationParams<T> {
+    url: string;
+    queriesToInvalidate?: string[];
+    methodType: "POST" | "PUT" | "DELETE";
+    data?: T;
+    isFormData?: boolean;
+    closePopup?: (state: boolean) => void;
+    excludedIndexKeys?: string[];
+}
+interface MutationFunctionParams<T> {
+    isPriorityDataAvailable?: boolean;
+    priorityData?: T;
+}
+/**
+ * Custom hook for handling global mutations with React Query.
+ * @param {string} url - The endpoint URL for the mutation.
+ * @param {Array<string>} queriesToInvalidate - Array of query keys to invalidate after successful mutation.
+ * @param {string} methodType - The HTTP method type (POST, PUT, DELETE).
+ * @param {Object} [data] - The default data to be sent with the mutation.
+ * @param {boolean} [isFormData] - Whether the data should be processed as FormData.
+ * @param {Function} [closePopup] - Optional callback to close a popup after successful mutation.
+ * @param {Array<string>} [excludedIndexKeys] - Keys for which array indices should not be included in FormData.
+ * @returns {Object} An object containing mutation-related functions and state.
+ */
+export declare const useGlobalMutation: <T extends Record<string, any>>({ url, queriesToInvalidate, methodType, data, isFormData, closePopup, excludedIndexKeys, }: UseGlobalMutationParams<T>) => {
+    runMutation: (params?: MutationFunctionParams<T>) => void;
+    mutationLoading: boolean;
+    mutationData: any;
+    mutationError: string;
+    isMutationSucceeded: boolean;
+};
+export {};

package/dist/hooks/useGlobalQuery.d.ts

@@ -0,0 +1,58 @@
+import { QueryKey } from '@tanstack/react-query';
+interface UseGlobalQueryParams {
+    url: string;
+    queryKey: QueryKey;
+    methodType: "GET" | "POST" | "PUT" | "DELETE";
+    data?: any;
+    enabled?: boolean;
+    staleTime?: number;
+    refetchOnWindowFocus?: boolean;
+}
+interface UseGlobalQueryReturn {
+    refetchQuery: () => void;
+    queryData: any;
+    isLoading: boolean;
+    isError: boolean;
+    error: unknown;
+}
+/**
+ * Custom hook for handling global queries with React Query.
+ * @param {string} url - The endpoint URL for the query.
+ * @param {QueryKey} queryKey - The unique key for identifying and caching the query.
+ * @param {"GET" | "POST" | "PUT" | "DELETE"} methodType - The HTTP method type.
+ * @param {any} [data] - The data to be sent with the request (for POST, PUT methods).
+ * @param {boolean} [enabled=true] - Whether the query is enabled or disabled.
+ * @param {boolean} [refetchOnWindowFocus] - Refetch on window focus if the data is stale (default: false).
+ * @param {number} [staleTime] - Duration in milliseconds until the data is considered stale (default: 5 minutes).
+ *
+ *
+ * Return type for the `useGlobalQuery` hook.
+ * @return {Function} refetchQuery - Function to invalidate and refetch the query.
+ * @return {any} queryData - The data returned from the query.
+ * @return {boolean} isLoading - Whether the query is currently loading.
+ * @return {boolean} isError - Whether the query encountered an error.
+ * @return {unknown} error - The error object if the query failed.
+
+ *
+ * @example
+ * // Example usage:
+ * const { queryData, isLoading, isError, error, refetchQuery } = useGlobalQuery({
+ *   url: "/api/data",
+ *   queryKey: ["data"],
+ *   methodType: "GET",
+ * });
+ *
+ * if (isLoading) return <div>Loading...</div>;
+ * if (isError) return <div>Error: {error.message}</div>;
+ *
+ * return (
+ *   <div>
+ *     <h1>Data:</h1>
+ *     <pre>{queryData.map((data) => <p>{data}</p>)}</pre>
+ *     <button onClick={refetchQuery}>Refresh Data</button>
+ *   </div>
+ * );
+ *
+ */
+export declare const useGlobalQuery: ({ url, queryKey, methodType, data, enabled, staleTime, refetchOnWindowFocus }: UseGlobalQueryParams) => UseGlobalQueryReturn;
+export {};

package/dist/index.d.ts

@@ -0,0 +1,4 @@
+export { useGlobalQuery } from './hooks/useGlobalQuery';
+export { useGlobalMutation } from './hooks/useGlobalMutation';
+export { useGlobalInfiniteQuery } from './hooks/useGlobalInfiniteQuery';
+export { useCookie } from './hooks/useCookie';

package/package.json

@@ -1,11 +1,24 @@
 {
   "name": "query-harbor",
-  "version": "0.0.5",
+  "version": "0.0.6",
   "type": "module",
-  "files": ["dist"],
+  "files": [
+    "dist"
+  ],
   "main": "./dist/query-harbor.umd.js",
   "module": "./dist/query-harbor.es.js",
-  "keywords": ["react", "react-query", "hooks", "tanstack", "query", "react-hooks", "harbor", "query-harbor", "react-query-hooks", "custom-hooks"],
+  "keywords": [
+    "react",
+    "react-query",
+    "hooks",
+    "tanstack",
+    "query",
+    "react-hooks",
+    "harbor",
+    "query-harbor",
+    "react-query-hooks",
+    "custom-hooks"
+  ],
   "author": "Rohit Chaware",
   "license": "MIT",
   "description": "A React Query utility package for efficient data fetching and caching",
@@ -42,6 +55,7 @@
     "eslint-plugin-react-hooks": "^5.0.0",
     "eslint-plugin-react-refresh": "^0.4.18",
     "globals": "^15.14.0",
-    "vite": "^6.1.0"
+    "vite": "^6.1.0",
+    "vite-plugin-dts": "^4.5.0"
   }
 }