cloudflare-next-intl 0.9.19 → 0.9.21

package/README.md

@@ -687,7 +687,7 @@ export default function GlobalError({
 }
 ```
 
-- `useStaleDeployRecovery(error: unknown, onRecover?: () => Promise<unknown>, delayMs = 5000): boolean`: Detects a stale-deploy error via `isStaleDeployError` and, **once per build id**, waits `delayMs`, runs `onRecover` (if provided) and `clearClientCache` in parallel, then reloads the page. The build id is read from `localStorage['buildId']` (set by `IntlHelperScript`'s `BUILD_ID` check) and a `sessionStorage` marker records which build id already spent its reload, so a repeat failure on the same build falls through to `false` (render your normal error UI) instead of reloading forever. A redeploy changes the build id and re-arms exactly one more attempt. **Exception:** if the build id was written within the last 60 seconds (`localStorage['buildIdSetAt']`, also set by `IntlHelperScript`), the hook recovers anyway — a stale-deploy error moments after adopting a new build is the deploy still settling, not a real failure, so the one-reload cap is bypassed for that window.
+- `useStaleDeployRecovery(error: unknown, onRecover?: () => Promise<unknown>, delayMs = 5000): boolean`: Detects a stale-deploy error via `isStaleDeployError` and, **once per build id**, waits `delayMs`, runs `onRecover` (if provided) and `clearClientCache` in parallel, then reloads the page. The build id is read from `localStorage['buildId']` (set by `IntlHelperScript`'s `BUILD_ID` check) and a `sessionStorage` marker records which build id already spent its reload, so a repeat failure on the same build falls through to `false` (render your normal error UI) instead of reloading forever. A redeploy changes the build id and re-arms exactly one more attempt.
 - `shouldRecoverFromStaleDeploy(error: unknown, buildId: string, marker: string | null, recentBuild = false): boolean`: The pure predicate behind the hook, exported for testing.
 - `isRecentBuild(setAt: number | null, now: number, windowMs = 60000): boolean`: Whether `setAt` (typically `buildIdSetAt`) falls within `windowMs` of `now`.
 

package/dist/src/error_handling/use_stale_deploy_recovery.d.ts

@@ -1,3 +1,4 @@
 export declare function isRecentBuild(setAt: number | null, now: number, windowMs?: number): boolean;
-export declare function shouldRecoverFromStaleDeploy(error: unknown, buildId: string, marker: string | null, recentBuild?: boolean): boolean;
+export declare function shouldRecoverFromStaleDeploy(error: unknown, buildId: string, marker: string | null, recentBuild?: boolean, reloadTime?: number | null, now?: number, throttleMs?: number): boolean;
+export declare function performCacheBustReload(): void;
 export default function useStaleDeployRecovery(error: unknown, onRecover?: () => Promise<unknown>, delayMs?: number): boolean;

package/dist/src/error_handling/use_stale_deploy_recovery.js

@@ -3,9 +3,11 @@ import { useEffect, useState } from 'react';
 import isStaleDeployError from './is_stale_deploy_error.js';
 import clearClientCache from './clear_client_cache.js';
 const RECOVERY_RELOAD_KEY = 'stale-deploy-recovery-reloaded';
+const RECOVERY_TIME_KEY = 'stale-deploy-recovery-time';
 const BUILD_ID_KEY = 'buildId';
 const BUILD_ID_SET_AT_KEY = 'buildIdSetAt';
 const RECENT_BUILD_WINDOW_MS = 60000;
+const RELOAD_THROTTLE_MS = 15000;
 function currentBuildId() {
     try {
         return localStorage.getItem(BUILD_ID_KEY) ?? 'unknown';
@@ -26,21 +28,41 @@ function buildIdSetAt() {
 export function isRecentBuild(setAt, now, windowMs = RECENT_BUILD_WINDOW_MS) {
     return setAt !== null && now - setAt < windowMs;
 }
-export function shouldRecoverFromStaleDeploy(error, buildId, marker, recentBuild = false) {
-    const isMarkerActive = marker !== null && marker !== '' && (buildId === 'unknown' || marker === buildId);
-    return isStaleDeployError(error) && (!isMarkerActive || recentBuild);
+export function shouldRecoverFromStaleDeploy(error, buildId, marker, recentBuild = false, reloadTime = null, now = Date.now(), throttleMs = RELOAD_THROTTLE_MS) {
+    if (!isStaleDeployError(error))
+        return false;
+    const isRecentlyReloaded = reloadTime !== null && now - reloadTime < throttleMs;
+    const isSameBuildMarker = marker !== null && marker !== '' && (buildId === 'unknown' || marker === buildId);
+    if (isSameBuildMarker && isRecentlyReloaded && !recentBuild) {
+        return false;
+    }
+    return true;
 }
 function canRecover(error) {
     if (typeof window === 'undefined')
         return false;
     try {
-        return shouldRecoverFromStaleDeploy(error, currentBuildId(), sessionStorage.getItem(RECOVERY_RELOAD_KEY), isRecentBuild(buildIdSetAt(), Date.now()));
+        const reloadTimeRaw = sessionStorage.getItem(RECOVERY_TIME_KEY);
+        const reloadTime = reloadTimeRaw ? Number(reloadTimeRaw) : null;
+        return shouldRecoverFromStaleDeploy(error, currentBuildId(), sessionStorage.getItem(RECOVERY_RELOAD_KEY), isRecentBuild(buildIdSetAt(), Date.now()), reloadTime, Date.now());
     }
     catch {
         return false;
     }
 }
-export default function useStaleDeployRecovery(error, onRecover, delayMs = 5000) {
+export function performCacheBustReload() {
+    if (typeof window === 'undefined')
+        return;
+    try {
+        const url = new URL(window.location.href);
+        url.searchParams.set('_stale_reload', String(Date.now()));
+        window.location.replace(url.toString());
+    }
+    catch {
+        window.location.reload();
+    }
+}
+export default function useStaleDeployRecovery(error, onRecover, delayMs = 1000) {
     const [recovering] = useState(() => canRecover(error));
     const [initialOnRecover] = useState(() => onRecover);
     const [initialDelayMs] = useState(() => delayMs);
@@ -53,9 +75,10 @@ export default function useStaleDeployRecovery(error, onRecover, delayMs = 5000)
                 .finally(() => {
                 try {
                     sessionStorage.setItem(RECOVERY_RELOAD_KEY, buildId);
+                    sessionStorage.setItem(RECOVERY_TIME_KEY, String(Date.now()));
                 }
                 catch { }
-                window.location.reload();
+                performCacheBustReload();
             });
         }, initialDelayMs);
         return () => clearTimeout(timeout);

package/dist/src/errors_board/client/error_ui_client.js

@@ -12,11 +12,16 @@ export function LocalTime({ format, timestampMs }) {
 }
 export function CopyButton({ text, label = 'Copy', copiedLabel = 'Copied', }) {
     const [copied, setCopied] = useState(false);
+    useEffect(() => {
+        if (!copied)
+            return;
+        const timer = setTimeout(() => setCopied(false), 1500);
+        return () => clearTimeout(timer);
+    }, [copied]);
     function handleCopy(event) {
         event.preventDefault();
         void navigator.clipboard.writeText(text).then(() => {
             setCopied(true);
-            setTimeout(() => setCopied(false), 1500);
         });
     }
     return (_jsx("button", { type: "button", onClick: handleCopy, className: "rounded-md border border-gray-300 px-2 py-1 text-[11px] font-medium text-gray-500 hover:bg-gray-100 hover:text-gray-700 dark:border-gray-700 dark:text-gray-400 dark:hover:bg-gray-800 dark:hover:text-gray-200", children: copied ? copiedLabel : label }));

package/dist/src/server/components/helper_script.js

@@ -40,7 +40,13 @@ export default function HelperScript() {
                         if (sessionStorage.getItem(key) === buildId) return;
                         attemptedThisLoad = true;
                         sessionStorage.setItem(key, buildId);
-                        window.location.reload();
+                        try {
+                            var u = new URL(window.location.href);
+                            u.searchParams.set('_stale_reload', String(Date.now()));
+                            window.location.replace(u.toString());
+                        } catch (e) {
+                            window.location.reload();
+                        }
                     } catch (e) {
                         console.error('Stale Deploy Early Catch Script Error:', e);
                     }
@@ -107,7 +113,16 @@ export default function HelperScript() {
                     // 3. Handle Locale Redirect.
                     // The logic is clearer: redirect only if a non-default locale is set
                     // and the URL isn't already localized.
+                    // Clean up stale reload query parameter if present
                     const { pathname, search, hash } = window.location;
+                    if (search && search.indexOf('_stale_reload=') > -1) {
+                        try {
+                            const cleanUrl = new URL(window.location.href);
+                            cleanUrl.searchParams.delete('_stale_reload');
+                            window.history.replaceState(history.state, '', cleanUrl.pathname + cleanUrl.search + cleanUrl.hash);
+                        } catch (e) {}
+                    }
+
                     if (locale && locale !== '${config.defaultLocale}' && !pathname.startsWith(\`/\${locale}\`)) {
                         const newPath = \`/\${locale}\${pathname === '/' ? '' : pathname}\${search}\${hash}\`;
                         // Redirecting will stop further script execution on this page.

package/dist/src/server/functions/geo.js

@@ -54,12 +54,13 @@ export async function getCountry(input, generate, headerNames) {
     const names = headerNames
         ?? gen?.countryHeaderNames
         ?? defaultCountryHeaderNames;
+    const cookieName = gen?.countryCookieName ?? countryCookieKey;
     if (input) {
         if ('headers' in input && input.headers) {
             const country = extractFromHeaderNames(input.headers, names);
             if (country)
                 return country;
-            const cookieCountry = extractCookieHeader(input.headers, countryCookieKey);
+            const cookieCountry = extractCookieHeader(input.headers, cookieName);
             if (cookieCountry)
                 return cookieCountry;
         }
@@ -67,11 +68,11 @@ export async function getCountry(input, generate, headerNames) {
             const country = extractFromHeaderNames(input, names);
             if (country)
                 return country;
-            const cookieCountry = extractCookieHeader(input, countryCookieKey);
+            const cookieCountry = extractCookieHeader(input, cookieName);
             if (cookieCountry)
                 return cookieCountry;
         }
-        const cookieCountry = extractCookie(input.cookies, countryCookieKey);
+        const cookieCountry = extractCookie(input.cookies, cookieName);
         if (cookieCountry) {
             return cookieCountry;
         }
@@ -86,7 +87,7 @@ export async function getCountry(input, generate, headerNames) {
         const country = extractFromHeaderNames(h, names);
         if (country)
             return country;
-        const cookieCountry = extractCookieHeader(h, countryCookieKey);
+        const cookieCountry = extractCookieHeader(h, cookieName);
         if (cookieCountry)
             return cookieCountry;
     }
@@ -95,7 +96,7 @@ export async function getCountry(input, generate, headerNames) {
     try {
         const { cookies } = await import('next/headers.js');
         const c = await cookies();
-        const country = extractCookie(c, countryCookieKey);
+        const country = extractCookie(c, cookieName);
         if (country)
             return country;
     }
@@ -129,12 +130,13 @@ export async function getTimezone(input, fallback, generate, headerNames) {
     const names = headerNames
         ?? gen?.timezoneHeaderNames
         ?? defaultTimezoneHeaderNames;
+    const cookieName = gen?.timezoneCookieName ?? timezoneCookieKey;
     if (input) {
         if ('headers' in input && input.headers) {
             const tz = extractFromHeaderNames(input.headers, names);
             if (tz)
                 return tz;
-            const cookieTimezone = extractCookieHeader(input.headers, timezoneCookieKey);
+            const cookieTimezone = extractCookieHeader(input.headers, cookieName);
             if (cookieTimezone)
                 return cookieTimezone;
         }
@@ -142,11 +144,11 @@ export async function getTimezone(input, fallback, generate, headerNames) {
             const tz = extractFromHeaderNames(input, names);
             if (tz)
                 return tz;
-            const cookieTimezone = extractCookieHeader(input, timezoneCookieKey);
+            const cookieTimezone = extractCookieHeader(input, cookieName);
             if (cookieTimezone)
                 return cookieTimezone;
         }
-        const cookieTimezone = extractCookie(input.cookies, timezoneCookieKey);
+        const cookieTimezone = extractCookie(input.cookies, cookieName);
         if (cookieTimezone) {
             return cookieTimezone;
         }
@@ -161,7 +163,7 @@ export async function getTimezone(input, fallback, generate, headerNames) {
         const tz = extractFromHeaderNames(h, names);
         if (tz)
             return tz;
-        const cookieTimezone = extractCookieHeader(h, timezoneCookieKey);
+        const cookieTimezone = extractCookieHeader(h, cookieName);
         if (cookieTimezone)
             return cookieTimezone;
     }
@@ -170,7 +172,7 @@ export async function getTimezone(input, fallback, generate, headerNames) {
     try {
         const { cookies } = await import('next/headers.js');
         const c = await cookies();
-        const tz = extractCookie(c, timezoneCookieKey);
+        const tz = extractCookie(c, cookieName);
         if (tz)
             return tz;
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cloudflare-next-intl",
-  "version": "0.9.19",
+  "version": "0.9.21",
   "description": "Optimized Next Intl Package Special for App Router and Cloudflare",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",