@fitzzero/quickdraw-core 1.0.0 → 1.2.0

package/dist/{types-BADirRXn.d.ts → types-e6WPGE70.d.ts}

@@ -88,6 +88,96 @@ interface UseSubscriptionResult<TData> {
     subscribe: () => void;
     unsubscribe: () => void;
 }
+/**
+ * Options for the useServiceQuery hook.
+ */
+interface UseServiceQueryOptions<TResponse> {
+    /**
+     * Whether to automatically fetch on mount (default: true)
+     */
+    enabled?: boolean;
+    /**
+     * How long data stays fresh in milliseconds (default: 5 minutes)
+     * During this time, cached data is returned without refetching.
+     */
+    staleTime?: number;
+    /**
+     * How long unused data stays in cache in milliseconds (default: 10 minutes)
+     * After this time, inactive queries are garbage collected.
+     * Note: TanStack Query v5 renamed this to `gcTime`.
+     */
+    gcTime?: number;
+    /**
+     * Whether to refetch when component mounts (default: true if data is stale)
+     */
+    refetchOnMount?: boolean | "always";
+    /**
+     * Whether to refetch when window regains focus (default: false)
+     */
+    refetchOnWindowFocus?: boolean | "always";
+    /**
+     * Force a fresh fetch, bypassing cache (default: false)
+     * Useful when you know the cache is invalidated.
+     */
+    skipCache?: boolean;
+    /**
+     * Request timeout in milliseconds (default: 10000)
+     */
+    timeout?: number;
+    /**
+     * Callback when data is successfully fetched
+     */
+    onSuccess?: (data: TResponse) => void;
+    /**
+     * Callback on error
+     */
+    onError?: (error: string) => void;
+    /**
+     * Number of retry attempts on failure (default: 1)
+     */
+    retry?: boolean | number;
+    /**
+     * Delay between retries in milliseconds
+     */
+    retryDelay?: number;
+}
+/**
+ * Return type for the useServiceQuery hook.
+ */
+interface UseServiceQueryResult<TResponse> {
+    /**
+     * The fetched/cached data, or undefined if not yet loaded.
+     */
+    data: TResponse | undefined;
+    /**
+     * True during initial load (no cached data available).
+     */
+    isLoading: boolean;
+    /**
+     * True when any fetch is in progress (including background refetch).
+     */
+    isFetching: boolean;
+    /**
+     * True if the query has errored.
+     */
+    isError: boolean;
+    /**
+     * Error message if the query failed.
+     */
+    error: string | null;
+    /**
+     * True if the data is considered stale (past staleTime).
+     */
+    isStale: boolean;
+    /**
+     * True if the query has successfully fetched data at least once.
+     */
+    isSuccess: boolean;
+    /**
+     * Manually trigger a refetch.
+     */
+    refetch: () => Promise<TResponse | undefined>;
+}
 /**
  * Type helper for defining service methods map on the client.
  * This mirrors the server-side ServiceMethodMap.
@@ -148,4 +238,4 @@ interface QuickdrawSocketContextValue {
     subscriptionRegistry: SubscriptionRegistry;
 }
 
-export type { ClientServiceMethodMap as C, QuickdrawSocketContextValue as Q, SubscriptionDataMap as S, UseServiceOptions as U, QuickdrawProviderProps as a, UseServiceResult as b, UseSubscriptionOptions as c, UseSubscriptionResult as d };
+export type { ClientServiceMethodMap as C, QuickdrawSocketContextValue as Q, SubscriptionDataMap as S, UseServiceOptions as U, QuickdrawProviderProps as a, UseServiceResult as b, UseServiceQueryOptions as c, UseServiceQueryResult as d, UseSubscriptionOptions as e, UseSubscriptionResult as f };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fitzzero/quickdraw-core",
-  "version": "1.0.0",
+  "version": "1.2.0",
   "description": "Fast fullstack patterns for real-time applications with Socket.io and TanStack Query",
   "type": "module",
   "main": "./dist/shared/index.js",
@@ -31,6 +31,17 @@
   "files": [
     "dist"
   ],
+  "scripts": {
+    "build": "tsup",
+    "dev": "tsup --watch",
+    "typecheck": "tsc --noEmit",
+    "lint": "eslint src --ext .ts,.tsx",
+    "lint:fix": "eslint src --ext .ts,.tsx --fix",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "test:coverage": "vitest run --coverage",
+    "prepublishOnly": "pnpm build"
+  },
   "keywords": [
     "socket.io",
     "tanstack-query",
@@ -96,15 +107,5 @@
   },
   "engines": {
     "node": ">=20"
-  },
-  "scripts": {
-    "build": "tsup",
-    "dev": "tsup --watch",
-    "typecheck": "tsc --noEmit",
-    "lint": "eslint src --ext .ts,.tsx",
-    "lint:fix": "eslint src --ext .ts,.tsx --fix",
-    "test": "vitest run",
-    "test:watch": "vitest",
-    "test:coverage": "vitest run --coverage"
   }
-}
+}