react-instantsearch-core 7.41.0 → 7.43.0

package/dist/cjs/components/InstantSearchSSRProvider.js

@@ -24,6 +24,10 @@ function InstantSearchSSRProvider(_0) {
     var ssrSearchRef = _react.default.useRef(null);
     // This is used to re-map the result index to the requesting widget
     var recommendIdx = _react.default.useRef(0);
+    var hydrationCompleteRef = _react.default.useRef(false);
+    _react.default.useEffect(function() {
+        hydrationCompleteRef.current = true;
+    }, []);
     // When <DynamicWidgets> is mounted, a second provider is used above the user-land
     // <InstantSearchSSRProvider> in `getServerState()`.
     // To avoid the user's provider overriding the context value with an empty object,
@@ -31,10 +35,12 @@ function InstantSearchSSRProvider(_0) {
     if (Object.keys(props).length === 0) {
         return /*#__PURE__*/ _react.default.createElement(_react.default.Fragment, null, children);
     }
+    var contextValue = _object_spread_props._(_object_spread._({}, props), {
+        ssrSearchRef: ssrSearchRef,
+        recommendIdx: recommendIdx,
+        hydrationCompleteRef: hydrationCompleteRef
+    });
     return /*#__PURE__*/ _react.default.createElement(_InstantSearchSSRContext.InstantSearchSSRContext.Provider, {
-        value: _object_spread_props._(_object_spread._({}, props), {
-            ssrSearchRef: ssrSearchRef,
-            recommendIdx: recommendIdx
-        })
+        value: contextValue
     }, children);
 }

package/dist/cjs/connectors/useChat.js

@@ -10,8 +10,35 @@ Object.defineProperty(exports, "useChat", {
     }
 });
 var _interop_require_default = require("@swc/helpers/_/_interop_require_default");
+var _object_spread = require("@swc/helpers/_/_object_spread");
+var _object_spread_props = require("@swc/helpers/_/_object_spread_props");
 var _connectChat = /*#__PURE__*/ _interop_require_default._(require("instantsearch.js/cjs/connectors/chat/connectChat"));
 var _useConnector = require("../hooks/useConnector");
+var _useIsHydrated = require("../lib/useIsHydrated");
 function useChat(props, additionalWidgetProperties) {
-    return (0, _useConnector.useConnector)(_connectChat.default, props, additionalWidgetProperties);
+    var isHydrated = (0, _useIsHydrated.useIsHydrated)();
+    var chatState = (0, _useConnector.useConnector)(_connectChat.default, props, additionalWidgetProperties);
+    if (isHydrated) {
+        return chatState;
+    }
+    // Server rendering only promises the closed Chat shell, so a render that has
+    // to reproduce that markup shows no conversation either. `status` is pinned
+    // with `messages` because it diverges two ways: a server render suppresses
+    // `resumeStream()`, which the browser runs synchronously while initialising,
+    // and a caller-owned chat can already be streaming. `error` is pinned because
+    // a caller-owned chat can already have failed, which a connector-built one
+    // cannot, since its failures arrive in a microtask. `suggestions` is pinned
+    // because the connector derives them from those messages. Only an `id` given
+    // as a connector option passes through, because that value is the same on
+    // both sides. Anything else is withheld: the default is random per Chat, and
+    // an `id` carried by a caller-owned instance is no safer, since the server and
+    // the browser each construct their own.
+    return _object_spread_props._(_object_spread._({}, chatState), {
+        error: undefined,
+        id: 'id' in props && props.id || '',
+        messages: [],
+        open: false,
+        status: 'ready',
+        suggestions: undefined
+    });
 }

package/dist/cjs/connectors/usePromptSuggestions.js

@@ -0,0 +1,17 @@
+'use strict';
+
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+Object.defineProperty(exports, "usePromptSuggestions", {
+    enumerable: true,
+    get: function() {
+        return usePromptSuggestions;
+    }
+});
+var _interop_require_default = require("@swc/helpers/_/_interop_require_default");
+var _connectPromptSuggestions = /*#__PURE__*/ _interop_require_default._(require("instantsearch.js/cjs/connectors/prompt-suggestions/connectPromptSuggestions"));
+var _useConnector = require("../hooks/useConnector");
+function usePromptSuggestions(props, additionalWidgetProperties) {
+    return (0, _useConnector.useConnector)(_connectPromptSuggestions.default, props, additionalWidgetProperties);
+}

package/dist/cjs/index.js

@@ -22,6 +22,7 @@ _export_star._(require("./components/InstantSearchSSRProvider"), exports);
 _export_star._(require("./connectors/useAutocomplete"), exports);
 _export_star._(require("./connectors/useBreadcrumb"), exports);
 _export_star._(require("./connectors/useChat"), exports);
+_export_star._(require("./connectors/usePromptSuggestions"), exports);
 _export_star._(require("./connectors/useChatTrigger"), exports);
 _export_star._(require("./connectors/useClearRefinements"), exports);
 _export_star._(require("./connectors/useConfigure"), exports);

package/dist/cjs/lib/useIsHydrated.js

@@ -0,0 +1,49 @@
+'use strict';
+
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+Object.defineProperty(exports, "useIsHydrated", {
+    enumerable: true,
+    get: function() {
+        return useIsHydrated;
+    }
+});
+var _interop_require_wildcard = require("@swc/helpers/_/_interop_require_wildcard");
+var _sliced_to_array = require("@swc/helpers/_/_sliced_to_array");
+var _react = /*#__PURE__*/ _interop_require_wildcard._(require("react"));
+var _useInstantSearchServerContext = require("./useInstantSearchServerContext");
+var _useInstantSearchSSRContext = require("./useInstantSearchSSRContext");
+var subscribe = function subscribe() {
+    return function() {};
+};
+var getClientSnapshot = function getClientSnapshot() {
+    return true;
+};
+var getServerSnapshot = function getServerSnapshot() {
+    return false;
+};
+function useNativeIsHydrated() {
+    return _react.useSyncExternalStore(subscribe, getClientSnapshot, getServerSnapshot);
+}
+// React 16 and 17 have no `useSyncExternalStore`, so the flip waits for an
+// effect and the render itself cannot tell hydration from a plain mount. These
+// contexts provide that signal for the supported `getServerState` and
+// `InstantSearchSSRProvider` flow: the server context covers state collection,
+// and the SSR context covers HTML rendering and hydration.
+//
+// The shim's React 16 and 17 fallback ignores the server snapshot, so using it
+// here would not distinguish initial hydration from later provider children.
+function useLegacyIsHydrated() {
+    var _ssrContext_hydrationCompleteRef;
+    var serverContext = (0, _useInstantSearchServerContext.useInstantSearchServerContext)();
+    var ssrContext = (0, _useInstantSearchSSRContext.useInstantSearchSSRContext)();
+    var isServerRendered = serverContext !== null || ssrContext !== null;
+    var isProviderHydrated = (ssrContext === null || ssrContext === void 0 ? void 0 : (_ssrContext_hydrationCompleteRef = ssrContext.hydrationCompleteRef) === null || _ssrContext_hydrationCompleteRef === void 0 ? void 0 : _ssrContext_hydrationCompleteRef.current) === true;
+    var _React_useState = _sliced_to_array._(_react.useState(!isServerRendered || isProviderHydrated), 2), isHydrated = _React_useState[0], setIsHydrated = _React_useState[1];
+    _react.useEffect(function() {
+        setIsHydrated(true);
+    }, []);
+    return isHydrated;
+}
+var useIsHydrated = typeof _react.useSyncExternalStore === 'function' ? useNativeIsHydrated : useLegacyIsHydrated;

package/dist/cjs/version.js

@@ -9,4 +9,4 @@ Object.defineProperty(exports, "default", {
         return _default;
     }
 });
-var _default = '7.41.0';
+var _default = '7.43.0';

package/dist/es/components/InstantSearchSSRProvider.js

@@ -16,6 +16,10 @@ import { InstantSearchSSRContext } from '../lib/InstantSearchSSRContext.js';
     var ssrSearchRef = React__default.useRef(null);
     // This is used to re-map the result index to the requesting widget
     var recommendIdx = React__default.useRef(0);
+    var hydrationCompleteRef = React__default.useRef(false);
+    React__default.useEffect(function() {
+        hydrationCompleteRef.current = true;
+    }, []);
     // When <DynamicWidgets> is mounted, a second provider is used above the user-land
     // <InstantSearchSSRProvider> in `getServerState()`.
     // To avoid the user's provider overriding the context value with an empty object,
@@ -23,11 +27,13 @@ import { InstantSearchSSRContext } from '../lib/InstantSearchSSRContext.js';
     if (Object.keys(props).length === 0) {
         return /*#__PURE__*/ React__default.createElement(React__default.Fragment, null, children);
     }
+    var contextValue = _$1(_$2({}, props), {
+        ssrSearchRef: ssrSearchRef,
+        recommendIdx: recommendIdx,
+        hydrationCompleteRef: hydrationCompleteRef
+    });
     return /*#__PURE__*/ React__default.createElement(InstantSearchSSRContext.Provider, {
-        value: _$1(_$2({}, props), {
-            ssrSearchRef: ssrSearchRef,
-            recommendIdx: recommendIdx
-        })
+        value: contextValue
     }, children);
 }
 

package/dist/es/connectors/useChat.d.ts

@@ -1,5 +1,5 @@
 import type { AdditionalWidgetProperties } from '../hooks/useConnector';
-import type { ChatConnectorParams } from 'instantsearch.js/es/connectors/chat/connectChat';
+import type { ChatConnectorParams, ChatWidgetDescription } from 'instantsearch.js/es/connectors/chat/connectChat';
 import type { UIMessage } from 'instantsearch.js/es/lib/chat';
 export type UseChatProps<TUiMessage extends UIMessage = UIMessage> = ChatConnectorParams<TUiMessage>;
-export declare function useChat<TUiMessage extends UIMessage = UIMessage>(props: UseChatProps<TUiMessage>, additionalWidgetProperties?: AdditionalWidgetProperties): import("instantsearch.js/es/connectors/chat/connectChat").ChatRenderState<TUiMessage>;
+export declare function useChat<TUiMessage extends UIMessage = UIMessage>(props: UseChatProps<TUiMessage>, additionalWidgetProperties?: AdditionalWidgetProperties): ChatWidgetDescription<TUiMessage>['renderState'];

package/dist/es/connectors/useChat.js

@@ -1,8 +1,35 @@
+import { _ as _$1 } from '@swc/helpers/esm/_object_spread.js';
+import { _ } from '@swc/helpers/esm/_object_spread_props.js';
 import connectChat from 'instantsearch.js/es/connectors/chat/connectChat.js';
 import { useConnector } from '../hooks/useConnector.js';
+import { useIsHydrated } from '../lib/useIsHydrated.js';
 
 function useChat(props, additionalWidgetProperties) {
-    return useConnector(connectChat, props, additionalWidgetProperties);
+    var isHydrated = useIsHydrated();
+    var chatState = useConnector(connectChat, props, additionalWidgetProperties);
+    if (isHydrated) {
+        return chatState;
+    }
+    // Server rendering only promises the closed Chat shell, so a render that has
+    // to reproduce that markup shows no conversation either. `status` is pinned
+    // with `messages` because it diverges two ways: a server render suppresses
+    // `resumeStream()`, which the browser runs synchronously while initialising,
+    // and a caller-owned chat can already be streaming. `error` is pinned because
+    // a caller-owned chat can already have failed, which a connector-built one
+    // cannot, since its failures arrive in a microtask. `suggestions` is pinned
+    // because the connector derives them from those messages. Only an `id` given
+    // as a connector option passes through, because that value is the same on
+    // both sides. Anything else is withheld: the default is random per Chat, and
+    // an `id` carried by a caller-owned instance is no safer, since the server and
+    // the browser each construct their own.
+    return _(_$1({}, chatState), {
+        error: undefined,
+        id: 'id' in props && props.id || '',
+        messages: [],
+        open: false,
+        status: 'ready',
+        suggestions: undefined
+    });
 }
 
 export { useChat };

package/dist/es/connectors/usePromptSuggestions.d.ts

@@ -0,0 +1,4 @@
+import type { AdditionalWidgetProperties } from '../hooks/useConnector';
+import type { PromptSuggestionsConnectorParams } from 'instantsearch.js/es/connectors/prompt-suggestions/connectPromptSuggestions';
+export type UsePromptSuggestionsProps = PromptSuggestionsConnectorParams;
+export declare function usePromptSuggestions(props: UsePromptSuggestionsProps, additionalWidgetProperties?: AdditionalWidgetProperties): import("instantsearch.js/es/connectors/prompt-suggestions/connectPromptSuggestions").PromptSuggestionsRenderState;

package/dist/es/connectors/usePromptSuggestions.js

@@ -0,0 +1,8 @@
+import connectPromptSuggestions from 'instantsearch.js/es/connectors/prompt-suggestions/connectPromptSuggestions.js';
+import { useConnector } from '../hooks/useConnector.js';
+
+function usePromptSuggestions(props, additionalWidgetProperties) {
+    return useConnector(connectPromptSuggestions, props, additionalWidgetProperties);
+}
+
+export { usePromptSuggestions };

package/dist/es/index.d.ts

@@ -9,6 +9,7 @@ export * from './components/InstantSearchSSRProvider';
 export * from './connectors/useAutocomplete';
 export * from './connectors/useBreadcrumb';
 export * from './connectors/useChat';
+export * from './connectors/usePromptSuggestions';
 export * from './connectors/useChatTrigger';
 export * from './connectors/useClearRefinements';
 export * from './connectors/useConfigure';

package/dist/es/index.js

@@ -9,6 +9,7 @@ export { InstantSearchSSRProvider } from './components/InstantSearchSSRProvider.
 export { useAutocomplete } from './connectors/useAutocomplete.js';
 export { useBreadcrumb } from './connectors/useBreadcrumb.js';
 export { useChat } from './connectors/useChat.js';
+export { usePromptSuggestions } from './connectors/usePromptSuggestions.js';
 export { useChatTrigger } from './connectors/useChatTrigger.js';
 export { useClearRefinements } from './connectors/useClearRefinements.js';
 export { useConfigure } from './connectors/useConfigure.js';

package/dist/es/lib/InstantSearchSSRContext.d.ts

@@ -1,5 +1,5 @@
-import type { InstantSearchServerState } from '../components/InstantSearchSSRProvider';
 import type { InternalInstantSearch } from './useInstantSearchApi';
+import type { InstantSearchServerState } from '../components/InstantSearchSSRProvider';
 import type { UiState } from 'instantsearch.js';
 import type { MutableRefObject } from 'react';
 export type InstantSearchSSRContextApi<TUiState extends UiState, TRouteState = TUiState> = InstantSearchServerState & {

package/dist/es/lib/useIsHydrated.d.ts

@@ -0,0 +1,9 @@
+declare function useNativeIsHydrated(): boolean;
+/**
+ * Whether this render can use browser state, or has to reproduce the markup a
+ * server produced without it.
+ *
+ * @internal
+ */
+export declare const useIsHydrated: typeof useNativeIsHydrated;
+export {};

package/dist/es/lib/useIsHydrated.js

@@ -0,0 +1,45 @@
+import { _ } from '@swc/helpers/esm/_sliced_to_array.js';
+import * as React from 'react';
+import { useInstantSearchServerContext } from './useInstantSearchServerContext.js';
+import { useInstantSearchSSRContext } from './useInstantSearchSSRContext.js';
+
+var subscribe = function subscribe() {
+    return function() {};
+};
+var getClientSnapshot = function getClientSnapshot() {
+    return true;
+};
+var getServerSnapshot = function getServerSnapshot() {
+    return false;
+};
+function useNativeIsHydrated() {
+    return React.useSyncExternalStore(subscribe, getClientSnapshot, getServerSnapshot);
+}
+// React 16 and 17 have no `useSyncExternalStore`, so the flip waits for an
+// effect and the render itself cannot tell hydration from a plain mount. These
+// contexts provide that signal for the supported `getServerState` and
+// `InstantSearchSSRProvider` flow: the server context covers state collection,
+// and the SSR context covers HTML rendering and hydration.
+//
+// The shim's React 16 and 17 fallback ignores the server snapshot, so using it
+// here would not distinguish initial hydration from later provider children.
+function useLegacyIsHydrated() {
+    var _ssrContext_hydrationCompleteRef;
+    var serverContext = useInstantSearchServerContext();
+    var ssrContext = useInstantSearchSSRContext();
+    var isServerRendered = serverContext !== null || ssrContext !== null;
+    var isProviderHydrated = (ssrContext === null || ssrContext === void 0 ? void 0 : (_ssrContext_hydrationCompleteRef = ssrContext.hydrationCompleteRef) === null || _ssrContext_hydrationCompleteRef === void 0 ? void 0 : _ssrContext_hydrationCompleteRef.current) === true;
+    var _React_useState = _(React.useState(!isServerRendered || isProviderHydrated), 2), isHydrated = _React_useState[0], setIsHydrated = _React_useState[1];
+    React.useEffect(function() {
+        setIsHydrated(true);
+    }, []);
+    return isHydrated;
+}
+/**
+ * Whether this render can use browser state, or has to reproduce the markup a
+ * server produced without it.
+ *
+ * @internal
+ */ var useIsHydrated = typeof React.useSyncExternalStore === 'function' ? useNativeIsHydrated : useLegacyIsHydrated;
+
+export { useIsHydrated };

package/dist/es/lib/useIsomorphicLayoutEffect.d.ts

@@ -1,7 +1,7 @@
-import { useLayoutEffect } from 'react';
+import { useEffect } from 'react';
 /**
  * `useLayoutEffect` that doesn't show a warning when server-side rendering.
  *
  * It uses `useEffect` on the server (no-op), and `useLayoutEffect` on the browser.
  */
-export declare const useIsomorphicLayoutEffect: typeof useLayoutEffect;
+export declare const useIsomorphicLayoutEffect: typeof useEffect;

package/dist/es/version.d.ts

@@ -1,2 +1,2 @@
-declare const _default: "7.41.0";
+declare const _default: "7.43.0";
 export default _default;

package/dist/es/version.js

@@ -1,3 +1,3 @@
-var version = '7.41.0';
+var version = '7.43.0';
 
 export { version as default };