@sitecore-content-sdk/react 2.4.0-canary.20260824045921 → 2.4.0-canary.20260826121528

package/dist/cjs/search/index.js

@@ -1,9 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.debug = exports.useInfiniteSearch = exports.useSearch = void 0;
+exports.debug = exports.useSuggest = exports.useInfiniteSearch = exports.useSearch = void 0;
 var useSearch_1 = require("./useSearch");
 Object.defineProperty(exports, "useSearch", { enumerable: true, get: function () { return useSearch_1.useSearch; } });
 var useInfiniteSearch_1 = require("./useInfiniteSearch");
 Object.defineProperty(exports, "useInfiniteSearch", { enumerable: true, get: function () { return useInfiniteSearch_1.useInfiniteSearch; } });
+var useSuggest_1 = require("./useSuggest");
+Object.defineProperty(exports, "useSuggest", { enumerable: true, get: function () { return useSuggest_1.useSuggest; } });
 var search_1 = require("@sitecore-content-sdk/search");
 Object.defineProperty(exports, "debug", { enumerable: true, get: function () { return search_1.debug; } });

package/dist/cjs/search/useInfiniteSearch.js

@@ -6,13 +6,15 @@ const react_1 = require("react");
 const utils_1 = require("./utils");
 /**
  * React hook for performing infinite search queries.
+ * Supports keyword search via `query` and More Like This (MLT) via `seedItemId` or `seedItemUrl`.
+ * Those query fields are mutually exclusive.
  * @param {UseInfiniteSearchOptions} options - Configuration options for the infinite search hook.
  * @returns {UseInfiniteSearchState} The infinite search state.
  * @throws {Error} if the search index ID is not provided.
  * @public
  */
 const useInfiniteSearch = (options) => {
-    const { query, searchIndexId, pageSize = utils_1.DEFAULT_PAGE_SIZE, sort, enabled = true, locale, facet } = options;
+    const { query, searchIndexId, pageSize = utils_1.DEFAULT_PAGE_SIZE, sort, enabled = true, locale, facet, seedItemId, seedItemUrl, } = options;
     const [state, setState] = (0, react_1.useState)(() => {
         const error = !searchIndexId
             ? new Error('useInfiniteSearch: searchIndexId is required when initializing the hook')
@@ -54,8 +56,8 @@ const useInfiniteSearch = (options) => {
             });
         }
         try {
-            const searchParams = Object.assign(Object.assign({ searchIndexId, keyphrase: query, limit: pageSize, offset,
-                sort }, (locale !== undefined && { locale })), (facet !== undefined && { facet }));
+            const searchParams = Object.assign(Object.assign(Object.assign(Object.assign({ searchIndexId, keyphrase: query, limit: pageSize, offset,
+                sort }, (locale !== undefined && { locale })), (facet !== undefined && { facet })), (seedItemId !== undefined && { seedItemId })), (seedItemUrl !== undefined && { seedItemUrl }));
             const { results: searchResults, total: totalResults, facets } = await searchService.search(searchParams, { signal });
             if (signal.aborted) {
                 return;
@@ -98,7 +100,7 @@ const useInfiniteSearch = (options) => {
                 });
             }
         }
-    }, [searchService, pageSize, sort, query, searchIndexId, locale, facet]);
+    }, [searchService, pageSize, sort, query, searchIndexId, locale, facet, seedItemId, seedItemUrl]);
     (0, react_1.useEffect)(() => {
         if (enabled) {
             search(0, false);

package/dist/cjs/search/useSearch.js

@@ -5,13 +5,15 @@ const react_1 = require("react");
 const utils_1 = require("./utils");
 /**
  * React hook for performing search queries with pagination.
+ * Supports keyword search via `query` and More Like This (MLT) via `seedItemId` or `seedItemUrl`.
+ * Those query fields are mutually exclusive.
  * @param {UseSearchOptions} options - Configuration options for the search hook.
  * @returns {UseSearchState} The search state.
  * @throws {Error} if the search index ID is not provided.
  * @public
  */
 const useSearch = (options) => {
-    const { query, page = 1, searchIndexId, pageSize = utils_1.DEFAULT_PAGE_SIZE, sort, enabled = true, keepPreviousData = false, locale, facet, } = options;
+    const { query, page = 1, searchIndexId, pageSize = utils_1.DEFAULT_PAGE_SIZE, sort, enabled = true, keepPreviousData = false, locale, facet, seedItemId, seedItemUrl, } = options;
     const [state, setState] = (0, react_1.useState)(() => {
         const error = !searchIndexId
             ? new Error('useSearch: searchIndexId is required when initializing the hook')
@@ -46,8 +48,8 @@ const useSearch = (options) => {
         }));
         try {
             const offset = (0, utils_1.getOffset)(page, pageSize);
-            const searchParams = Object.assign(Object.assign({ searchIndexId, keyphrase: query, limit: pageSize, offset,
-                sort }, (locale !== undefined && { locale })), (facet !== undefined && { facet }));
+            const searchParams = Object.assign(Object.assign(Object.assign(Object.assign({ searchIndexId, keyphrase: query, limit: pageSize, offset,
+                sort }, (locale !== undefined && { locale })), (facet !== undefined && { facet })), (seedItemId !== undefined && { seedItemId })), (seedItemUrl !== undefined && { seedItemUrl }));
             const { results: searchResults, total, facets } = await searchService.search(searchParams, {
                 signal,
             });
@@ -81,7 +83,7 @@ const useSearch = (options) => {
                 previousStatus: 'error',
             });
         }
-    }, [searchService, searchIndexId, page, pageSize, sort, query, keepPreviousData, locale, facet]);
+    }, [searchService, searchIndexId, page, pageSize, sort, query, keepPreviousData, locale, facet, seedItemId, seedItemUrl]);
     (0, react_1.useEffect)(() => {
         if (enabled) {
             search();

package/dist/cjs/search/useSuggest.js

@@ -0,0 +1,104 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.useSuggest = void 0;
+const react_1 = require("react");
+const utils_1 = require("./utils");
+/**
+ * React hook for typeahead suggestions via `/v1/search/suggest`.
+ * @param {UseSuggestOptions} options - Configuration options for the suggest hook.
+ * @returns {UseSuggestState} The suggest state.
+ * @throws {Error} if the search index ID is not provided.
+ * @public
+ */
+const useSuggest = (options) => {
+    const { query, searchIndexId, enabled = true, keepPreviousData = false, locale } = options;
+    const trimmedQuery = typeof query === 'string' ? query.trim() : '';
+    const [state, setState] = (0, react_1.useState)(() => {
+        const error = !searchIndexId
+            ? new Error('useSuggest: searchIndexId is required when initializing the hook')
+            : null;
+        const status = !searchIndexId ? 'error' : 'idle';
+        return {
+            querySuggestions: [],
+            previewResults: [],
+            error,
+            status,
+            previousStatus: 'idle',
+        };
+    });
+    const searchService = (0, utils_1.useSearchService)();
+    const abortControllerRef = (0, react_1.useRef)(null);
+    const suggest = (0, react_1.useCallback)(async () => {
+        if (!searchService || !searchIndexId) {
+            return;
+        }
+        if (!trimmedQuery) {
+            setState((prev) => ({
+                querySuggestions: keepPreviousData ? prev.querySuggestions : [],
+                previewResults: keepPreviousData ? prev.previewResults : [],
+                status: 'idle',
+                error: null,
+                previousStatus: prev.status,
+            }));
+            return;
+        }
+        abortControllerRef.current = new AbortController();
+        const signal = abortControllerRef.current.signal;
+        setState((prev) => ({
+            querySuggestions: keepPreviousData ? prev.querySuggestions : [],
+            previewResults: keepPreviousData ? prev.previewResults : [],
+            status: 'loading',
+            error: null,
+            previousStatus: prev.status,
+        }));
+        try {
+            const suggestParams = Object.assign({ searchIndexId, keyphrase: trimmedQuery }, (locale !== undefined && { locale }));
+            const { querySuggestions, previewResults } = await searchService.suggest(suggestParams, {
+                signal,
+            });
+            if (signal.aborted) {
+                return;
+            }
+            setState({
+                querySuggestions,
+                previewResults,
+                status: 'success',
+                error: null,
+                previousStatus: 'success',
+            });
+        }
+        catch (err) {
+            if (signal.aborted) {
+                return;
+            }
+            const errorMessage = err instanceof Error ? err : new Error(JSON.stringify(err));
+            setState({
+                querySuggestions: [],
+                previewResults: [],
+                status: 'error',
+                error: errorMessage,
+                previousStatus: 'error',
+            });
+        }
+    }, [searchService, searchIndexId, trimmedQuery, keepPreviousData, locale]);
+    (0, react_1.useEffect)(() => {
+        if (enabled) {
+            suggest();
+        }
+        return () => {
+            var _a;
+            (_a = abortControllerRef.current) === null || _a === void 0 ? void 0 : _a.abort();
+        };
+    }, [suggest, enabled]);
+    return (0, react_1.useMemo)(() => ({
+        error: state.error,
+        querySuggestions: state.querySuggestions,
+        previewResults: state.previewResults,
+        status: state.status,
+        isLoading: state.status === 'loading',
+        isSuccess: state.status === 'success',
+        isError: state.status === 'error',
+        isPreviousData: keepPreviousData && state.previousStatus === 'success' && state.status === 'loading',
+    }), [state, keepPreviousData]);
+};
+exports.useSuggest = useSuggest;

package/dist/esm/search/index.js

@@ -1,3 +1,4 @@
 export { useSearch } from './useSearch';
 export { useInfiniteSearch, } from './useInfiniteSearch';
+export { useSuggest } from './useSuggest';
 export { debug } from '@sitecore-content-sdk/search';

package/dist/esm/search/useInfiniteSearch.js

@@ -3,13 +3,15 @@ import { useCallback, useEffect, useMemo, useRef, useState } from 'react';
 import { DEFAULT_PAGE_SIZE, useSearchService } from './utils';
 /**
  * React hook for performing infinite search queries.
+ * Supports keyword search via `query` and More Like This (MLT) via `seedItemId` or `seedItemUrl`.
+ * Those query fields are mutually exclusive.
  * @param {UseInfiniteSearchOptions} options - Configuration options for the infinite search hook.
  * @returns {UseInfiniteSearchState} The infinite search state.
  * @throws {Error} if the search index ID is not provided.
  * @public
  */
 export const useInfiniteSearch = (options) => {
-    const { query, searchIndexId, pageSize = DEFAULT_PAGE_SIZE, sort, enabled = true, locale, facet } = options;
+    const { query, searchIndexId, pageSize = DEFAULT_PAGE_SIZE, sort, enabled = true, locale, facet, seedItemId, seedItemUrl, } = options;
     const [state, setState] = useState(() => {
         const error = !searchIndexId
             ? new Error('useInfiniteSearch: searchIndexId is required when initializing the hook')
@@ -51,8 +53,8 @@ export const useInfiniteSearch = (options) => {
             });
         }
         try {
-            const searchParams = Object.assign(Object.assign({ searchIndexId, keyphrase: query, limit: pageSize, offset,
-                sort }, (locale !== undefined && { locale })), (facet !== undefined && { facet }));
+            const searchParams = Object.assign(Object.assign(Object.assign(Object.assign({ searchIndexId, keyphrase: query, limit: pageSize, offset,
+                sort }, (locale !== undefined && { locale })), (facet !== undefined && { facet })), (seedItemId !== undefined && { seedItemId })), (seedItemUrl !== undefined && { seedItemUrl }));
             const { results: searchResults, total: totalResults, facets } = await searchService.search(searchParams, { signal });
             if (signal.aborted) {
                 return;
@@ -95,7 +97,7 @@ export const useInfiniteSearch = (options) => {
                 });
             }
         }
-    }, [searchService, pageSize, sort, query, searchIndexId, locale, facet]);
+    }, [searchService, pageSize, sort, query, searchIndexId, locale, facet, seedItemId, seedItemUrl]);
     useEffect(() => {
         if (enabled) {
             search(0, false);

package/dist/esm/search/useSearch.js

@@ -2,13 +2,15 @@ import { useCallback, useEffect, useMemo, useRef, useState } from 'react';
 import { DEFAULT_PAGE_SIZE, getOffset, useSearchService } from './utils';
 /**
  * React hook for performing search queries with pagination.
+ * Supports keyword search via `query` and More Like This (MLT) via `seedItemId` or `seedItemUrl`.
+ * Those query fields are mutually exclusive.
  * @param {UseSearchOptions} options - Configuration options for the search hook.
  * @returns {UseSearchState} The search state.
  * @throws {Error} if the search index ID is not provided.
  * @public
  */
 export const useSearch = (options) => {
-    const { query, page = 1, searchIndexId, pageSize = DEFAULT_PAGE_SIZE, sort, enabled = true, keepPreviousData = false, locale, facet, } = options;
+    const { query, page = 1, searchIndexId, pageSize = DEFAULT_PAGE_SIZE, sort, enabled = true, keepPreviousData = false, locale, facet, seedItemId, seedItemUrl, } = options;
     const [state, setState] = useState(() => {
         const error = !searchIndexId
             ? new Error('useSearch: searchIndexId is required when initializing the hook')
@@ -43,8 +45,8 @@ export const useSearch = (options) => {
         }));
         try {
             const offset = getOffset(page, pageSize);
-            const searchParams = Object.assign(Object.assign({ searchIndexId, keyphrase: query, limit: pageSize, offset,
-                sort }, (locale !== undefined && { locale })), (facet !== undefined && { facet }));
+            const searchParams = Object.assign(Object.assign(Object.assign(Object.assign({ searchIndexId, keyphrase: query, limit: pageSize, offset,
+                sort }, (locale !== undefined && { locale })), (facet !== undefined && { facet })), (seedItemId !== undefined && { seedItemId })), (seedItemUrl !== undefined && { seedItemUrl }));
             const { results: searchResults, total, facets } = await searchService.search(searchParams, {
                 signal,
             });
@@ -78,7 +80,7 @@ export const useSearch = (options) => {
                 previousStatus: 'error',
             });
         }
-    }, [searchService, searchIndexId, page, pageSize, sort, query, keepPreviousData, locale, facet]);
+    }, [searchService, searchIndexId, page, pageSize, sort, query, keepPreviousData, locale, facet, seedItemId, seedItemUrl]);
     useEffect(() => {
         if (enabled) {
             search();

package/dist/esm/search/useSuggest.js

@@ -0,0 +1,100 @@
+import { useCallback, useEffect, useMemo, useRef, useState } from 'react';
+import { useSearchService } from './utils';
+/**
+ * React hook for typeahead suggestions via `/v1/search/suggest`.
+ * @param {UseSuggestOptions} options - Configuration options for the suggest hook.
+ * @returns {UseSuggestState} The suggest state.
+ * @throws {Error} if the search index ID is not provided.
+ * @public
+ */
+export const useSuggest = (options) => {
+    const { query, searchIndexId, enabled = true, keepPreviousData = false, locale } = options;
+    const trimmedQuery = typeof query === 'string' ? query.trim() : '';
+    const [state, setState] = useState(() => {
+        const error = !searchIndexId
+            ? new Error('useSuggest: searchIndexId is required when initializing the hook')
+            : null;
+        const status = !searchIndexId ? 'error' : 'idle';
+        return {
+            querySuggestions: [],
+            previewResults: [],
+            error,
+            status,
+            previousStatus: 'idle',
+        };
+    });
+    const searchService = useSearchService();
+    const abortControllerRef = useRef(null);
+    const suggest = useCallback(async () => {
+        if (!searchService || !searchIndexId) {
+            return;
+        }
+        if (!trimmedQuery) {
+            setState((prev) => ({
+                querySuggestions: keepPreviousData ? prev.querySuggestions : [],
+                previewResults: keepPreviousData ? prev.previewResults : [],
+                status: 'idle',
+                error: null,
+                previousStatus: prev.status,
+            }));
+            return;
+        }
+        abortControllerRef.current = new AbortController();
+        const signal = abortControllerRef.current.signal;
+        setState((prev) => ({
+            querySuggestions: keepPreviousData ? prev.querySuggestions : [],
+            previewResults: keepPreviousData ? prev.previewResults : [],
+            status: 'loading',
+            error: null,
+            previousStatus: prev.status,
+        }));
+        try {
+            const suggestParams = Object.assign({ searchIndexId, keyphrase: trimmedQuery }, (locale !== undefined && { locale }));
+            const { querySuggestions, previewResults } = await searchService.suggest(suggestParams, {
+                signal,
+            });
+            if (signal.aborted) {
+                return;
+            }
+            setState({
+                querySuggestions,
+                previewResults,
+                status: 'success',
+                error: null,
+                previousStatus: 'success',
+            });
+        }
+        catch (err) {
+            if (signal.aborted) {
+                return;
+            }
+            const errorMessage = err instanceof Error ? err : new Error(JSON.stringify(err));
+            setState({
+                querySuggestions: [],
+                previewResults: [],
+                status: 'error',
+                error: errorMessage,
+                previousStatus: 'error',
+            });
+        }
+    }, [searchService, searchIndexId, trimmedQuery, keepPreviousData, locale]);
+    useEffect(() => {
+        if (enabled) {
+            suggest();
+        }
+        return () => {
+            var _a;
+            (_a = abortControllerRef.current) === null || _a === void 0 ? void 0 : _a.abort();
+        };
+    }, [suggest, enabled]);
+    return useMemo(() => ({
+        error: state.error,
+        querySuggestions: state.querySuggestions,
+        previewResults: state.previewResults,
+        status: state.status,
+        isLoading: state.status === 'loading',
+        isSuccess: state.status === 'success',
+        isError: state.status === 'error',
+        isPreviousData: keepPreviousData && state.previousStatus === 'success' && state.status === 'loading',
+    }), [state, keepPreviousData]);
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sitecore-content-sdk/react",
-  "version": "2.4.0-canary.20260824045921",
+  "version": "2.4.0-canary.20260826121528",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",
   "sideEffects": false,
@@ -32,7 +32,7 @@
     "url": "https://github.com/sitecore/content-sdk/issues"
   },
   "devDependencies": {
-    "@sitecore-content-sdk/analytics-core": "2.1.3-canary.20260824045921",
+    "@sitecore-content-sdk/analytics-core": "2.1.3-canary.20260826121528",
     "@sitecore-feaas/clientside": "^0.6.0",
     "@stylistic/eslint-plugin": "^5.2.2",
     "@testing-library/dom": "^10.4.0",
@@ -71,16 +71,16 @@
     "typescript": "~5.8.3"
   },
   "peerDependencies": {
-    "@sitecore-content-sdk/analytics-core": "2.1.3-canary.20260824045921",
-    "@sitecore-content-sdk/events": "2.1.3-canary.20260824045921",
+    "@sitecore-content-sdk/analytics-core": "2.1.3-canary.20260826121528",
+    "@sitecore-content-sdk/events": "2.1.3-canary.20260826121528",
     "@sitecore-feaas/clientside": "^0.6.0",
     "react": "^19.2.1",
     "react-dom": "^19.2.1"
   },
   "dependencies": {
-    "@sitecore-content-sdk/content": "2.3.0-canary.20260824045921",
-    "@sitecore-content-sdk/core": "2.1.4-canary.20260824045921",
-    "@sitecore-content-sdk/search": "0.4.1-canary.20260824045921",
+    "@sitecore-content-sdk/content": "2.3.0-canary.20260826121528",
+    "@sitecore-content-sdk/core": "2.1.4-canary.20260826121528",
+    "@sitecore-content-sdk/search": "0.5.0-canary.20260826121528",
     "fast-deep-equal": "^3.1.3"
   },
   "description": "",

package/types/search/index.d.ts

@@ -1,5 +1,6 @@
 export { useSearch, UseSearchState, UseSearchOptions } from './useSearch';
 export { useInfiniteSearch, UseInfiniteSearchState, UseInfiniteSearchOptions, } from './useInfiniteSearch';
+export { useSuggest, UseSuggestState, UseSuggestOptions } from './useSuggest';
 export { SearchStatus } from './utils';
 export { debug } from '@sitecore-content-sdk/search';
 //# sourceMappingURL=index.d.ts.map

package/types/search/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/search/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,cAAc,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAC;AAC1E,OAAO,EACL,iBAAiB,EACjB,sBAAsB,EACtB,wBAAwB,GACzB,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AACvC,OAAO,EAAE,KAAK,EAAE,MAAM,8BAA8B,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/search/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,cAAc,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAC;AAC1E,OAAO,EACL,iBAAiB,EACjB,sBAAsB,EACtB,wBAAwB,GACzB,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EAAE,UAAU,EAAE,eAAe,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAC;AAC9E,OAAO,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AACvC,OAAO,EAAE,KAAK,EAAE,MAAM,8BAA8B,CAAC"}

package/types/search/useInfiniteSearch.d.ts

@@ -2,12 +2,15 @@ import { SearchStatus } from './utils';
 import { SearchDocument, SearchParameters, FacetRequest, FacetResult } from '@sitecore-content-sdk/search';
 /**
  * Options for the useInfiniteSearch hook.
+ * `query`, `seedItemId`, and `seedItemUrl` are mutually exclusive.
+ * Use `seedItemId` or `seedItemUrl` for More Like This (MLT) widget queries.
  * @public
  */
 export interface UseInfiniteSearchOptions<T extends SearchDocument = SearchDocument> {
     /**
      * The query string to search for.
      * By default empty string is used.
+     * Mutually exclusive with `seedItemId` and `seedItemUrl`.
      */
     query?: string;
     /**
@@ -39,6 +42,16 @@ export interface UseInfiniteSearchOptions<T extends SearchDocument = SearchDocum
      * Use 'fields' to filter results by specific facet values. Both can be combined.
      */
     facet?: FacetRequest;
+    /**
+     * Item ID used as the seed for More Like This (MLT) results.
+     * Mutually exclusive with `query` and `seedItemUrl`.
+     */
+    seedItemId?: string;
+    /**
+     * Item URL used as the seed for More Like This (MLT) results.
+     * Mutually exclusive with `query` and `seedItemId`.
+     */
+    seedItemUrl?: string;
 }
 /**
  * The state of the useInfiniteSearch hook.
@@ -121,6 +134,8 @@ type InternalInfiniteSearchState<T extends SearchDocument = SearchDocument> = {
 };
 /**
  * React hook for performing infinite search queries.
+ * Supports keyword search via `query` and More Like This (MLT) via `seedItemId` or `seedItemUrl`.
+ * Those query fields are mutually exclusive.
  * @param {UseInfiniteSearchOptions} options - Configuration options for the infinite search hook.
  * @returns {UseInfiniteSearchState} The infinite search state.
  * @throws {Error} if the search index ID is not provided.

package/types/search/useInfiniteSearch.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"useInfiniteSearch.d.ts","sourceRoot":"","sources":["../../src/search/useInfiniteSearch.ts"],"names":[],"mappings":"AAEA,OAAO,EAAqB,YAAY,EAAoB,MAAM,SAAS,CAAC;AAC5E,OAAO,EAAE,cAAc,EAAE,gBAAgB,EAAE,YAAY,EAAE,WAAW,EAAE,MAAM,8BAA8B,CAAC;AAE3G;;;GAGG;AACH,MAAM,WAAW,wBAAwB,CAAC,CAAC,SAAS,cAAc,GAAG,cAAc;IACjF;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IACtB;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,IAAI,CAAC,EAAE,gBAAgB,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC;IACnC;;;OAGG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB;;;;OAIG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;;OAGG;IACH,KAAK,CAAC,EAAE,YAAY,CAAC;CACtB;AAED;;;GAGG;AACH,MAAM,MAAM,sBAAsB,CAAC,CAAC,SAAS,cAAc,GAAG,cAAc,IAAI,IAAI,CAClF,2BAA2B,CAAC,CAAC,CAAC,EAC9B,QAAQ,CACT,GAAG;IACF;;OAEG;IACH,QAAQ,EAAE,MAAM,IAAI,CAAC;IACrB;;OAEG;IACH,WAAW,EAAE,OAAO,CAAC;IACrB;;OAEG;IACH,SAAS,EAAE,OAAO,CAAC;IACnB;;OAEG;IACH,SAAS,EAAE,OAAO,CAAC;IACnB;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;IACjB;;OAEG;IACH,aAAa,EAAE,OAAO,CAAC;IACvB;;OAEG;IACH,kBAAkB,EAAE,OAAO,CAAC;CAC7B,CAAC;AAEF,KAAK,2BAA2B,CAAC,CAAC,SAAS,cAAc,GAAG,cAAc,IAAI;IAC5E;;OAEG;IACH,OAAO,EAAE,CAAC,EAAE,CAAC;IACb;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,MAAM,CAAC,EAAE,WAAW,EAAE,CAAC;IACvB;;OAEG;IACH,KAAK,EAAE,KAAK,GAAG,IAAI,CAAC;IACpB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;;;;;;;OAQG;IACH,MAAM,EAAE,YAAY,CAAC;IACrB;;;;;;;OAOG;IACH,cAAc,EAAE,IAAI,CAAC,YAAY,EAAE,SAAS,CAAC,CAAC;CAC/C,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,iBAAiB,GAAI,CAAC,SAAS,cAAc,GAAG,cAAc,EACzE,SAAS,wBAAwB,CAAC,CAAC,CAAC,KACnC,sBAAsB,CAAC,CAAC,CAoK1B,CAAC"}
+{"version":3,"file":"useInfiniteSearch.d.ts","sourceRoot":"","sources":["../../src/search/useInfiniteSearch.ts"],"names":[],"mappings":"AAEA,OAAO,EAAqB,YAAY,EAAoB,MAAM,SAAS,CAAC;AAC5E,OAAO,EAAE,cAAc,EAAE,gBAAgB,EAAE,YAAY,EAAE,WAAW,EAAE,MAAM,8BAA8B,CAAC;AAE3G;;;;;GAKG;AACH,MAAM,WAAW,wBAAwB,CAAC,CAAC,SAAS,cAAc,GAAG,cAAc;IACjF;;;;OAIG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IACtB;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,IAAI,CAAC,EAAE,gBAAgB,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC;IACnC;;;OAGG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB;;;;OAIG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;;OAGG;IACH,KAAK,CAAC,EAAE,YAAY,CAAC;IACrB;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED;;;GAGG;AACH,MAAM,MAAM,sBAAsB,CAAC,CAAC,SAAS,cAAc,GAAG,cAAc,IAAI,IAAI,CAClF,2BAA2B,CAAC,CAAC,CAAC,EAC9B,QAAQ,CACT,GAAG;IACF;;OAEG;IACH,QAAQ,EAAE,MAAM,IAAI,CAAC;IACrB;;OAEG;IACH,WAAW,EAAE,OAAO,CAAC;IACrB;;OAEG;IACH,SAAS,EAAE,OAAO,CAAC;IACnB;;OAEG;IACH,SAAS,EAAE,OAAO,CAAC;IACnB;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;IACjB;;OAEG;IACH,aAAa,EAAE,OAAO,CAAC;IACvB;;OAEG;IACH,kBAAkB,EAAE,OAAO,CAAC;CAC7B,CAAC;AAEF,KAAK,2BAA2B,CAAC,CAAC,SAAS,cAAc,GAAG,cAAc,IAAI;IAC5E;;OAEG;IACH,OAAO,EAAE,CAAC,EAAE,CAAC;IACb;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,MAAM,CAAC,EAAE,WAAW,EAAE,CAAC;IACvB;;OAEG;IACH,KAAK,EAAE,KAAK,GAAG,IAAI,CAAC;IACpB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;;;;;;;OAQG;IACH,MAAM,EAAE,YAAY,CAAC;IACrB;;;;;;;OAOG;IACH,cAAc,EAAE,IAAI,CAAC,YAAY,EAAE,SAAS,CAAC,CAAC;CAC/C,CAAC;AAEF;;;;;;;;GAQG;AACH,eAAO,MAAM,iBAAiB,GAAI,CAAC,SAAS,cAAc,GAAG,cAAc,EACzE,SAAS,wBAAwB,CAAC,CAAC,CAAC,KACnC,sBAAsB,CAAC,CAAC,CAgL1B,CAAC"}

package/types/search/useSearch.d.ts

@@ -2,12 +2,15 @@ import { SearchDocument, SearchParameters, FacetRequest, FacetResult } from '@si
 import { SearchStatus } from './utils';
 /**
  * Options for the useSearch hook.
+ * `query`, `seedItemId`, and `seedItemUrl` are mutually exclusive.
+ * Use `seedItemId` or `seedItemUrl` for More Like This (MLT) widget queries.
  * @public
  */
 export interface UseSearchOptions<T extends SearchDocument = SearchDocument> {
     /**
      * The query string to search for.
      * By default empty string is used.
+     * Mutually exclusive with `seedItemId` and `seedItemUrl`.
      */
     query?: string;
     /**
@@ -49,6 +52,16 @@ export interface UseSearchOptions<T extends SearchDocument = SearchDocument> {
      * Use 'fields' to filter results by specific facet values. Both can be combined.
      */
     facet?: FacetRequest;
+    /**
+     * Item ID used as the seed for More Like This (MLT) results.
+     * Mutually exclusive with `query` and `seedItemUrl`.
+     */
+    seedItemId?: string;
+    /**
+     * Item URL used as the seed for More Like This (MLT) results.
+     * Mutually exclusive with `query` and `seedItemId`.
+     */
+    seedItemUrl?: string;
 }
 type InternalState<T extends SearchDocument = SearchDocument> = {
     /**
@@ -112,6 +125,8 @@ export type UseSearchState<T extends SearchDocument = SearchDocument> = Omit<Int
 };
 /**
  * React hook for performing search queries with pagination.
+ * Supports keyword search via `query` and More Like This (MLT) via `seedItemId` or `seedItemUrl`.
+ * Those query fields are mutually exclusive.
  * @param {UseSearchOptions} options - Configuration options for the search hook.
  * @returns {UseSearchState} The search state.
  * @throws {Error} if the search index ID is not provided.

package/types/search/useSearch.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"useSearch.d.ts","sourceRoot":"","sources":["../../src/search/useSearch.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,cAAc,EAAE,gBAAgB,EAAE,YAAY,EAAE,WAAW,EAAE,MAAM,8BAA8B,CAAC;AAC3G,OAAO,EAAgC,YAAY,EAAoB,MAAM,SAAS,CAAC;AAEvF;;;GAGG;AACH,MAAM,WAAW,gBAAgB,CAAC,CAAC,SAAS,cAAc,GAAG,cAAc;IACzE;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IACtB;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,IAAI,CAAC,EAAE,gBAAgB,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC;IACnC;;;OAGG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB;;;OAGG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B;;;;OAIG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;;OAGG;IACH,KAAK,CAAC,EAAE,YAAY,CAAC;CACtB;AAED,KAAK,aAAa,CAAC,CAAC,SAAS,cAAc,GAAG,cAAc,IAAI;IAC9D;;OAEG;IACH,OAAO,EAAE,CAAC,EAAE,CAAC;IACb;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,MAAM,CAAC,EAAE,WAAW,EAAE,CAAC;IACvB;;OAEG;IACH,KAAK,EAAE,KAAK,GAAG,IAAI,CAAC;IACpB;;;;;;;;OAQG;IACH,MAAM,EAAE,YAAY,CAAC;IACrB;;;OAGG;IACH,cAAc,EAAE,YAAY,CAAC;CAC9B,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,cAAc,CAAC,CAAC,SAAS,cAAc,GAAG,cAAc,IAAI,IAAI,CAC1E,aAAa,CAAC,CAAC,CAAC,EAChB,gBAAgB,CACjB,GAAG;IACF;;OAEG;IACH,SAAS,EAAE,OAAO,CAAC;IACnB;;OAEG;IACH,SAAS,EAAE,OAAO,CAAC;IACnB;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;IACjB;;;OAGG;IACH,cAAc,EAAE,OAAO,CAAC;CACzB,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,SAAS,GAAI,CAAC,SAAS,cAAc,GAAG,cAAc,EACjE,SAAS,gBAAgB,CAAC,CAAC,CAAC,KAC3B,cAAc,CAAC,CAAC,CAiIlB,CAAC"}
+{"version":3,"file":"useSearch.d.ts","sourceRoot":"","sources":["../../src/search/useSearch.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,cAAc,EAAE,gBAAgB,EAAE,YAAY,EAAE,WAAW,EAAE,MAAM,8BAA8B,CAAC;AAC3G,OAAO,EAAgC,YAAY,EAAoB,MAAM,SAAS,CAAC;AAEvF;;;;;GAKG;AACH,MAAM,WAAW,gBAAgB,CAAC,CAAC,SAAS,cAAc,GAAG,cAAc;IACzE;;;;OAIG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IACtB;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,IAAI,CAAC,EAAE,gBAAgB,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC;IACnC;;;OAGG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB;;;OAGG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B;;;;OAIG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;;OAGG;IACH,KAAK,CAAC,EAAE,YAAY,CAAC;IACrB;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,KAAK,aAAa,CAAC,CAAC,SAAS,cAAc,GAAG,cAAc,IAAI;IAC9D;;OAEG;IACH,OAAO,EAAE,CAAC,EAAE,CAAC;IACb;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,MAAM,CAAC,EAAE,WAAW,EAAE,CAAC;IACvB;;OAEG;IACH,KAAK,EAAE,KAAK,GAAG,IAAI,CAAC;IACpB;;;;;;;;OAQG;IACH,MAAM,EAAE,YAAY,CAAC;IACrB;;;OAGG;IACH,cAAc,EAAE,YAAY,CAAC;CAC9B,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,cAAc,CAAC,CAAC,SAAS,cAAc,GAAG,cAAc,IAAI,IAAI,CAC1E,aAAa,CAAC,CAAC,CAAC,EAChB,gBAAgB,CACjB,GAAG;IACF;;OAEG;IACH,SAAS,EAAE,OAAO,CAAC;IACnB;;OAEG;IACH,SAAS,EAAE,OAAO,CAAC;IACnB;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;IACjB;;;OAGG;IACH,cAAc,EAAE,OAAO,CAAC;CACzB,CAAC;AAEF;;;;;;;;GAQG;AACH,eAAO,MAAM,SAAS,GAAI,CAAC,SAAS,cAAc,GAAG,cAAc,EACjE,SAAS,gBAAgB,CAAC,CAAC,CAAC,KAC3B,cAAc,CAAC,CAAC,CAqIlB,CAAC"}

package/types/search/useSuggest.d.ts

@@ -0,0 +1,97 @@
+import { SearchDocument, QuerySuggestionItem } from '@sitecore-content-sdk/search';
+import { SearchStatus } from './utils';
+/**
+ * Options for the useSuggest hook.
+ * `/v1/search/suggest` accepts only `keyphrase`; `seedItemId` and `seedItemUrl` are not supported.
+ * @public
+ */
+export interface UseSuggestOptions {
+    /**
+     * Partial text used for typeahead suggestions.
+     * Mapped to `keyphrase` on `SearchService.suggest()`.
+     * When omitted or whitespace only, no request is sent.
+     */
+    query?: string;
+    /**
+     * The ID of the search index to use.
+     */
+    searchIndexId: string;
+    /**
+     * Specifies whether the suggest request should automatically run.
+     * @default true
+     */
+    enabled?: boolean;
+    /**
+     * Specifies whether the previous suggestions should be kept when fetching new results.
+     * @default false
+     */
+    keepPreviousData?: boolean;
+    /**
+     * The locale to use for the suggest request. Required for multi-locale index configurations.
+     * Format: letters and hyphens only (e.g. 'en', 'fr-FR', 'el-GR').
+     * Omit for single-locale indexes.
+     */
+    locale?: string;
+}
+type InternalSuggestState<T extends SearchDocument = SearchDocument> = {
+    /**
+     * Autocomplete completions from query suggestion mode.
+     */
+    querySuggestions: QuerySuggestionItem[];
+    /**
+     * Document previews from preview results mode.
+     */
+    previewResults: T[];
+    /**
+     * The error object if the last suggest request failed, or null if no error occurred.
+     */
+    error: Error | null;
+    /**
+     * The status of the suggest request.
+     * It will be set to:
+     * - 'idle' if no suggest request has been made yet.
+     * - 'loading' if a suggest request is currently in progress.
+     * - 'success' if a suggest request was successful.
+     * - 'error' if a suggest request failed.
+     * @default 'idle'
+     */
+    status: SearchStatus;
+    /**
+     * The status of the previous suggest request.
+     * @default 'idle'
+     */
+    previousStatus: SearchStatus;
+};
+/**
+ * The state of the useSuggest hook.
+ * @public
+ */
+export type UseSuggestState<T extends SearchDocument = SearchDocument> = Omit<InternalSuggestState<T>, 'previousStatus'> & {
+    /**
+     * Whether a suggest request is currently in progress.
+     */
+    isLoading: boolean;
+    /**
+     * Whether the suggest request was successful.
+     */
+    isSuccess: boolean;
+    /**
+     * Whether the suggest request failed.
+     */
+    isError: boolean;
+    /**
+     * Whether the suggestions from the previous query are returned.
+     * Will be `true` if `keepPreviousData` is set.
+     */
+    isPreviousData: boolean;
+};
+/**
+ * React hook for typeahead suggestions via `/v1/search/suggest`.
+ * @param {UseSuggestOptions} options - Configuration options for the suggest hook.
+ * @returns {UseSuggestState} The suggest state.
+ * @throws {Error} if the search index ID is not provided.
+ * @public
+ */
+export declare const useSuggest: <T extends SearchDocument = SearchDocument>(options: UseSuggestOptions) => UseSuggestState<T>;
+export {};
+//# sourceMappingURL=useSuggest.d.ts.map

package/types/search/useSuggest.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useSuggest.d.ts","sourceRoot":"","sources":["../../src/search/useSuggest.ts"],"names":[],"mappings":"AACA,OAAO,EACL,cAAc,EAEd,mBAAmB,EACpB,MAAM,8BAA8B,CAAC;AACtC,OAAO,EAAE,YAAY,EAAoB,MAAM,SAAS,CAAC;AAEzD;;;;GAIG;AACH,MAAM,WAAW,iBAAiB;IAChC;;;;OAIG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IACtB;;;OAGG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB;;;OAGG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B;;;;OAIG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,KAAK,oBAAoB,CAAC,CAAC,SAAS,cAAc,GAAG,cAAc,IAAI;IACrE;;OAEG;IACH,gBAAgB,EAAE,mBAAmB,EAAE,CAAC;IACxC;;OAEG;IACH,cAAc,EAAE,CAAC,EAAE,CAAC;IACpB;;OAEG;IACH,KAAK,EAAE,KAAK,GAAG,IAAI,CAAC;IACpB;;;;;;;;OAQG;IACH,MAAM,EAAE,YAAY,CAAC;IACrB;;;OAGG;IACH,cAAc,EAAE,YAAY,CAAC;CAC9B,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,eAAe,CAAC,CAAC,SAAS,cAAc,GAAG,cAAc,IAAI,IAAI,CAC3E,oBAAoB,CAAC,CAAC,CAAC,EACvB,gBAAgB,CACjB,GAAG;IACF;;OAEG;IACH,SAAS,EAAE,OAAO,CAAC;IACnB;;OAEG;IACH,SAAS,EAAE,OAAO,CAAC;IACnB;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;IACjB;;;OAGG;IACH,cAAc,EAAE,OAAO,CAAC;CACzB,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,UAAU,GAAI,CAAC,SAAS,cAAc,GAAG,cAAc,EAClE,SAAS,iBAAiB,KACzB,eAAe,CAAC,CAAC,CAgHnB,CAAC"}