react-instantsearch-nextjs 1.2.8 → 1.2.9

package/dist/cjs/InstantSearchNext.js

@@ -25,6 +25,7 @@ var _utils = require("instantsearch.js/cjs/lib/utils");
 var _react = /*#__PURE__*/ _interop_require_wildcard._(require("react"));
 var _reactinstantsearchcore = require("react-instantsearch-core");
 var _InitializePromise = require("./InitializePromise");
+var _RefreshOnClientNavigation = require("./RefreshOnClientNavigation");
 var _TriggerSearch = require("./TriggerSearch");
 var _useDynamicRouteWarning = require("./useDynamicRouteWarning");
 var _useInstantSearchRouting = require("./useInstantSearchRouting");
@@ -71,7 +72,7 @@ function InstantSearchNext(_0) {
         nonce: nonce
     }), children, isServer && /*#__PURE__*/ _react.default.createElement(_TriggerSearch.TriggerSearch, {
         nonce: nonce
-    })));
+    }), !isServer && /*#__PURE__*/ _react.default.createElement(_RefreshOnClientNavigation.RefreshOnClientNavigation, null)));
 }
 function ServerOrHydrationProvider(param) {
     var isServer = param.isServer, children = param.children, instance = param.instance, ignoreMultipleHooksWarning = param.ignoreMultipleHooksWarning;

package/dist/cjs/RefreshOnClientNavigation.js

@@ -0,0 +1,69 @@
+'use strict';
+
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+function _export(target, all) {
+    for(var name in all)Object.defineProperty(target, name, {
+        enumerable: true,
+        get: Object.getOwnPropertyDescriptor(all, name).get
+    });
+}
+_export(exports, {
+    get RefreshOnClientNavigation () {
+        return RefreshOnClientNavigation;
+    },
+    get isClientNavigation () {
+        return isClientNavigation;
+    }
+});
+var _sliced_to_array = require("@swc/helpers/_/_sliced_to_array");
+var _react = require("react");
+var _reactinstantsearchcore = require("react-instantsearch-core");
+// Fallback store for the first location an `InstantSearchNext` instance
+// rendered with, used only in environments without the Navigation Timing API
+// (e.g. jsdom in tests). See `getInitialLocation` below.
+var InstantSearchDocumentLocation = Symbol.for('InstantSearchDocumentLocation');
+/**
+ * The `pathname` + `search` the document was initially loaded with.
+ *
+ * It comes from the Navigation Timing API, which reflects the hard page load
+ * and is *not* affected by client-side (SPA) navigations. The hash is ignored
+ * as it isn't part of the routing state. Falls back to the first location any
+ * instance rendered with (stored on `window`) when Navigation Timing is
+ * unavailable.
+ */ function getInitialLocation(currentLocation) {
+    try {
+        var _performance_getEntriesByType = _sliced_to_array._(performance.getEntriesByType('navigation'), 1), entry = _performance_getEntriesByType[0];
+        if (entry && entry.name) {
+            var url = new URL(entry.name);
+            return url.pathname + url.search;
+        }
+    } catch (e) {
+    // Navigation Timing not available; fall through to the `window` fallback.
+    }
+    if (window[InstantSearchDocumentLocation] === undefined) {
+        window[InstantSearchDocumentLocation] = currentLocation;
+    }
+    return window[InstantSearchDocumentLocation];
+}
+function isClientNavigation() {
+    var currentLocation = window.location.pathname + window.location.search;
+    return getInitialLocation(currentLocation) !== currentLocation;
+}
+function RefreshOnClientNavigation() {
+    var search = (0, _reactinstantsearchcore.useInstantSearchContext)();
+    var hasRefreshed = (0, _react.useRef)(false);
+    (0, _react.useEffect)(function() {
+        if (hasRefreshed.current) {
+            return;
+        }
+        hasRefreshed.current = true;
+        if (search.started && isClientNavigation()) {
+            search.refresh();
+        }
+    }, [
+        search
+    ]);
+    return null;
+}

package/dist/es/InstantSearchNext.js

@@ -5,6 +5,7 @@ import { safelyRunOnBrowser } from 'instantsearch.js/es/lib/utils/index.js';
 import React, { useRef, useEffect } from 'react';
 import { InstantSearch, InstantSearchRSCContext, InstantSearchSSRContext } from 'react-instantsearch-core';
 import { InitializePromise } from './InitializePromise.js';
+import { RefreshOnClientNavigation } from './RefreshOnClientNavigation.js';
 import { TriggerSearch } from './TriggerSearch.js';
 import { useDynamicRouteWarning } from './useDynamicRouteWarning.js';
 import { useInstantSearchRouting } from './useInstantSearchRouting.js';
@@ -52,7 +53,7 @@ function InstantSearchNext(_0) {
         nonce: nonce
     }), children, isServer && /*#__PURE__*/ React.createElement(TriggerSearch, {
         nonce: nonce
-    })));
+    }), !isServer && /*#__PURE__*/ React.createElement(RefreshOnClientNavigation, null)));
 }
 function ServerOrHydrationProvider(param) {
     var isServer = param.isServer, children = param.children, instance = param.instance, ignoreMultipleHooksWarning = param.ignoreMultipleHooksWarning;

package/dist/es/RefreshOnClientNavigation.d.ts

@@ -0,0 +1,28 @@
+declare const InstantSearchDocumentLocation: unique symbol;
+declare global {
+    interface Window {
+        [InstantSearchDocumentLocation]?: string;
+    }
+}
+/**
+ * Whether the current location differs from the one the document was initially
+ * loaded with — i.e. whether we reached this render through a client-side (SPA)
+ * navigation rather than the initial hydration.
+ */
+export declare function isClientNavigation(): boolean;
+/**
+ * Refreshes the search after a client-side navigation.
+ *
+ * On a client-side navigation the App Router remounts `InstantSearchNext` with
+ * the server-streamed `initialResults`, which can be empty (e.g. coming from a
+ * page without InstantSearch) or stale, and the instance doesn't search again
+ * on its own — leaving the new page with no or outdated hits until a full
+ * reload (#7060). When we detect such a navigation we refresh the search so it
+ * re-fetches with the (already correct) current UI state.
+ *
+ * Unlike re-running the router's `onUpdate`, `refresh()` doesn't touch the URL,
+ * so it can't wipe the URL of a nested `<Index>` whose children only register
+ * on a second render pass (#6980).
+ */
+export declare function RefreshOnClientNavigation(): null;
+export {};

package/dist/es/RefreshOnClientNavigation.js

@@ -0,0 +1,70 @@
+import { _ } from '@swc/helpers/esm/_sliced_to_array.js';
+import { useRef, useEffect } from 'react';
+import { useInstantSearchContext } from 'react-instantsearch-core';
+
+// Fallback store for the first location an `InstantSearchNext` instance
+// rendered with, used only in environments without the Navigation Timing API
+// (e.g. jsdom in tests). See `getInitialLocation` below.
+var InstantSearchDocumentLocation = Symbol.for('InstantSearchDocumentLocation');
+/**
+ * The `pathname` + `search` the document was initially loaded with.
+ *
+ * It comes from the Navigation Timing API, which reflects the hard page load
+ * and is *not* affected by client-side (SPA) navigations. The hash is ignored
+ * as it isn't part of the routing state. Falls back to the first location any
+ * instance rendered with (stored on `window`) when Navigation Timing is
+ * unavailable.
+ */ function getInitialLocation(currentLocation) {
+    try {
+        var _performance_getEntriesByType = _(performance.getEntriesByType('navigation'), 1), entry = _performance_getEntriesByType[0];
+        if (entry && entry.name) {
+            var url = new URL(entry.name);
+            return url.pathname + url.search;
+        }
+    } catch (e) {
+    // Navigation Timing not available; fall through to the `window` fallback.
+    }
+    if (window[InstantSearchDocumentLocation] === undefined) {
+        window[InstantSearchDocumentLocation] = currentLocation;
+    }
+    return window[InstantSearchDocumentLocation];
+}
+/**
+ * Whether the current location differs from the one the document was initially
+ * loaded with — i.e. whether we reached this render through a client-side (SPA)
+ * navigation rather than the initial hydration.
+ */ function isClientNavigation() {
+    var currentLocation = window.location.pathname + window.location.search;
+    return getInitialLocation(currentLocation) !== currentLocation;
+}
+/**
+ * Refreshes the search after a client-side navigation.
+ *
+ * On a client-side navigation the App Router remounts `InstantSearchNext` with
+ * the server-streamed `initialResults`, which can be empty (e.g. coming from a
+ * page without InstantSearch) or stale, and the instance doesn't search again
+ * on its own — leaving the new page with no or outdated hits until a full
+ * reload (#7060). When we detect such a navigation we refresh the search so it
+ * re-fetches with the (already correct) current UI state.
+ *
+ * Unlike re-running the router's `onUpdate`, `refresh()` doesn't touch the URL,
+ * so it can't wipe the URL of a nested `<Index>` whose children only register
+ * on a second render pass (#6980).
+ */ function RefreshOnClientNavigation() {
+    var search = useInstantSearchContext();
+    var hasRefreshed = useRef(false);
+    useEffect(function() {
+        if (hasRefreshed.current) {
+            return;
+        }
+        hasRefreshed.current = true;
+        if (search.started && isClientNavigation()) {
+            search.refresh();
+        }
+    }, [
+        search
+    ]);
+    return null;
+}
+
+export { RefreshOnClientNavigation, isClientNavigation };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-instantsearch-nextjs",
-  "version": "1.2.8",
+  "version": "1.2.9",
   "description": "React InstantSearch SSR utilities for Next.js",
   "types": "dist/es/index.d.ts",
   "main": "dist/cjs/index.js",
@@ -52,9 +52,9 @@
   },
   "devDependencies": {
     "@playwright/test": "1.49.1",
-    "instantsearch.js": "4.101.1",
+    "instantsearch.js": "4.102.0",
     "next": "16.0.7",
-    "react-instantsearch-core": "7.35.1",
+    "react-instantsearch-core": "7.36.0",
     "start-server-and-test": "1.15.3",
     "ts-node": "8.4.1"
   },
@@ -62,5 +62,5 @@
     "next": ">= 13.4 < 17",
     "react-instantsearch": ">= 7.1.0 < 8"
   },
-  "gitHead": "8f1f4c966eccc81fbd5b7c3003319d040ec64fdb"
+  "gitHead": "9f2107a28e81b33218bf22a29a1d327348eb7906"
 }