@pol-studios/hooks 1.0.8 → 1.0.10

package/dist/chunk-KRFN7UQV.js

@@ -0,0 +1,77 @@
+// src/version/useVersionCheck.ts
+import { useState, useEffect, useRef, useCallback } from "react";
+var DEFAULT_POLLING_INTERVAL = 18e4;
+function useVersionCheck(options = {}) {
+  const {
+    pollingInterval = DEFAULT_POLLING_INTERVAL,
+    enabled = typeof window !== "undefined" && window.location.hostname !== "localhost"
+  } = options;
+  const [hasUpdate, setHasUpdate] = useState(false);
+  const [error, setError] = useState(false);
+  const initialDeploymentId = useRef(null);
+  const dismissedDeploymentId = useRef(null);
+  const latestDeploymentId = useRef(null);
+  const getDeploymentId = useCallback(async () => {
+    if (typeof window === "undefined") return null;
+    try {
+      const response = await fetch(window.location.origin, {
+        method: "HEAD",
+        cache: "no-store"
+      });
+      const deploymentUrl = response.headers.get("x-vercel-deployment-url");
+      if (deploymentUrl) {
+        setError(false);
+        return deploymentUrl;
+      }
+      const deploymentId = response.headers.get("x-vercel-id") || null;
+      if (deploymentId) {
+        setError(false);
+      }
+      return deploymentId;
+    } catch {
+      setError(true);
+      return null;
+    }
+  }, []);
+  const checkForUpdate = useCallback(async () => {
+    const currentDeploymentId = await getDeploymentId();
+    if (!currentDeploymentId) {
+      return;
+    }
+    latestDeploymentId.current = currentDeploymentId;
+    if (initialDeploymentId.current === null) {
+      initialDeploymentId.current = currentDeploymentId;
+      return;
+    }
+    if (currentDeploymentId !== initialDeploymentId.current && currentDeploymentId !== dismissedDeploymentId.current) {
+      setHasUpdate(true);
+    }
+  }, [getDeploymentId]);
+  const refresh = useCallback(() => {
+    window.location.reload();
+  }, []);
+  const dismiss = useCallback(() => {
+    if (latestDeploymentId.current) {
+      dismissedDeploymentId.current = latestDeploymentId.current;
+    }
+    setHasUpdate(false);
+  }, []);
+  useEffect(() => {
+    if (!enabled) return;
+    checkForUpdate();
+    const intervalId = setInterval(checkForUpdate, pollingInterval);
+    return () => {
+      clearInterval(intervalId);
+    };
+  }, [enabled, pollingInterval, checkForUpdate]);
+  return {
+    hasUpdate,
+    refresh,
+    dismiss,
+    error
+  };
+}
+
+export {
+  useVersionCheck
+};

package/dist/index.d.ts

@@ -8,6 +8,7 @@ export { ActionType, Toast, ToastAction, ToastState, ToasterToast, actionTypes,
 export { useHideOnScroll, useHidingOnScroll, useScrollDirection, useScrollPosition, useScrollRestoration } from './scroll/index.js';
 export { NetworkStatus, NetworkStatus as OnlineStatus, QueuedMutation, useMutationQueue, useNetworkStatus, useOnline } from './network/index.js';
 export { useRenderCount, useRenderHookCount, useStateTracker, useTrackedState } from './debug/index.js';
+export { UseVersionCheckOptions, UseVersionCheckReturn, useVersionCheck } from './version/index.js';
 export { dateReviver, downloadFile, getFile, getFilePost, hasCameraAsync, isDev, isDevEnvironment, isIphone, isPwaLaunched, isUsable, parseWithDate, withComponentMemo } from './_utils/index.js';
 import 'react';
 import 'react/jsx-runtime';

package/dist/index.js

@@ -16,6 +16,9 @@ import {
   useStateTracker,
   useTrackedState
 } from "./chunk-XIISC67B.js";
+import {
+  useVersionCheck
+} from "./chunk-KRFN7UQV.js";
 import {
   ChangeTrackingContext,
   ChangeTrackingProvider,
@@ -163,6 +166,7 @@ export {
   useThemeDetector,
   useToast,
   useTrackedState,
+  useVersionCheck,
   useWindowDimensions,
   withComponentMemo
 };

package/dist/version/index.d.ts

@@ -0,0 +1,39 @@
+interface UseVersionCheckOptions {
+    /** Polling interval in milliseconds. Default: 180000 (3 minutes) */
+    pollingInterval?: number;
+    /** Whether version checking is enabled. Default: true in production */
+    enabled?: boolean;
+}
+interface UseVersionCheckReturn {
+    /** Whether a new version is available */
+    hasUpdate: boolean;
+    /** Refresh the page to get the new version */
+    refresh: () => void;
+    /** Dismiss the update notification (won't show again for this deployment) */
+    dismiss: () => void;
+    /** Whether an error occurred during version check */
+    error: boolean;
+}
+/**
+ * Hook to detect when a new version of the app has been deployed on Vercel.
+ * Uses the x-vercel-deployment-url header to detect changes.
+ *
+ * @param options - Configuration options
+ * @returns Object with hasUpdate, refresh, dismiss, and error
+ *
+ * @example
+ * ```tsx
+ * const { hasUpdate, refresh, dismiss } = useVersionCheck();
+ *
+ * if (hasUpdate) {
+ *   return (
+ *     <Banner onRefresh={refresh} onDismiss={dismiss}>
+ *       A new version is available!
+ *     </Banner>
+ *   );
+ * }
+ * ```
+ */
+declare function useVersionCheck(options?: UseVersionCheckOptions): UseVersionCheckReturn;
+
+export { type UseVersionCheckOptions, type UseVersionCheckReturn, useVersionCheck };

package/dist/version/index.js

@@ -0,0 +1,7 @@
+import {
+  useVersionCheck
+} from "../chunk-KRFN7UQV.js";
+import "../chunk-QGM4M3NI.js";
+export {
+  useVersionCheck
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pol-studios/hooks",
-  "version": "1.0.8",
+  "version": "1.0.10",
   "description": "React hooks for POL applications",
   "license": "UNLICENSED",
   "type": "module",
@@ -54,28 +54,36 @@
       "import": "./dist/debug/index.js",
       "types": "./dist/debug/index.d.ts"
     },
+    "./version": {
+      "import": "./dist/version/index.js",
+      "types": "./dist/version/index.d.ts"
+    },
     "./utils": {
       "import": "./dist/_utils/index.js",
       "types": "./dist/_utils/index.d.ts"
     }
   },
+  "scripts": {
+    "build": "tsup",
+    "dev": "tsup --watch",
+    "prepublishOnly": "pnpm build"
+  },
   "publishConfig": {
     "access": "public"
   },
   "peerDependencies": {
     "react": "^18.0.0 || ^19.0.0",
     "react-dom": "^18.0.0 || ^19.0.0",
-    "@pol-studios/utils": ">=1.0.0"
+    "@tanstack/react-query": "^5.0.0"
   },
   "dependencies": {
-    "@tanstack/react-query": "^5.0.0",
+    "@pol-studios/utils": "workspace:*",
     "framer-motion": "^11.0.0",
     "lodash": "^4.17.21"
   },
   "devDependencies": {
     "tsup": "^8.0.0",
-    "typescript": "^5.0.0",
-    "@pol-studios/utils": "1.0.8"
+    "typescript": "^5.0.0"
   },
   "keywords": [
     "hooks",
@@ -83,9 +91,5 @@
     "state",
     "storage",
     "toast"
-  ],
-  "scripts": {
-    "build": "tsup",
-    "dev": "tsup --watch"
-  }
-}
+  ]
+}