@sitecore-content-sdk/react 1.3.0-canary.31 → 1.3.0-canary.35

package/dist/cjs/search/index.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+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; } });

package/dist/cjs/search/useInfiniteSearch.js

@@ -0,0 +1,136 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.useInfiniteSearch = void 0;
+/* eslint-disable no-unused-vars */
+const react_1 = require("react");
+const utils_1 = require("./utils");
+/**
+ * React hook for performing infinite search queries.
+ * @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 } = options;
+    const [state, setState] = (0, react_1.useState)(() => {
+        const error = !searchIndexId
+            ? new Error('useInfiniteSearch: searchIndexId is required when initializing the hook')
+            : null;
+        const status = !searchIndexId ? 'error' : 'idle';
+        return {
+            results: [],
+            total: 0,
+            totalPages: 0,
+            error,
+            offset: 0,
+            status,
+            loadMoreStatus: 'idle',
+        };
+    });
+    const hasNextPage = (0, react_1.useMemo)(() => state.results.length < state.total, [state.results.length, state.total]);
+    const searchService = (0, utils_1.useSearchService)();
+    const abortControllerRef = (0, react_1.useRef)(null);
+    const search = (0, react_1.useCallback)(async (offset, isLoadingMore = false) => {
+        if (!searchService || !searchIndexId) {
+            return;
+        }
+        abortControllerRef.current = new AbortController();
+        const signal = abortControllerRef.current.signal;
+        if (isLoadingMore) {
+            setState((prev) => (Object.assign(Object.assign({}, prev), { error: null, loadMoreStatus: 'loading' })));
+        }
+        else {
+            setState({
+                results: [],
+                total: 0,
+                totalPages: 0,
+                error: null,
+                offset: 0,
+                status: 'loading',
+                loadMoreStatus: 'idle',
+            });
+        }
+        try {
+            const searchParams = {
+                searchIndexId,
+                keyphrase: query,
+                limit: pageSize,
+                offset,
+                sort,
+            };
+            const { results: searchResults, total: totalResults } = await searchService.search(searchParams, { signal });
+            if (signal.aborted) {
+                return;
+            }
+            setState((prev) => {
+                const results = isLoadingMore ? [...prev.results, ...searchResults] : searchResults;
+                const totalPages = Math.ceil(totalResults / pageSize);
+                return {
+                    results,
+                    error: null,
+                    offset,
+                    status: 'success',
+                    loadMoreStatus: 'idle',
+                    total: totalResults,
+                    totalPages,
+                };
+            });
+        }
+        catch (err) {
+            // Don't set error if request was aborted
+            if (signal.aborted) {
+                return;
+            }
+            const errorMessage = err instanceof Error ? err : new Error(JSON.stringify(err));
+            // Don't clean up existing results if appending results
+            if (isLoadingMore) {
+                setState((prev) => (Object.assign(Object.assign({}, prev), { error: errorMessage, loadMoreStatus: 'error' })));
+            }
+            else {
+                setState({
+                    results: [],
+                    total: 0,
+                    totalPages: 0,
+                    error: errorMessage,
+                    offset: 0,
+                    status: 'error',
+                    loadMoreStatus: 'idle',
+                });
+            }
+        }
+    }, [searchService, pageSize, sort, query, searchIndexId]);
+    (0, react_1.useEffect)(() => {
+        if (enabled) {
+            search(0, false);
+        }
+        return () => {
+            var _a;
+            (_a = abortControllerRef.current) === null || _a === void 0 ? void 0 : _a.abort();
+        };
+    }, [search, enabled]);
+    const loadMore = (0, react_1.useCallback)(() => {
+        // Don't load more if already loading or no more pages
+        if (state.loadMoreStatus === 'loading' || !hasNextPage) {
+            return;
+        }
+        const nextOffset = state.offset + pageSize;
+        search(nextOffset, true);
+    }, [search, pageSize, state.offset, hasNextPage, state.loadMoreStatus]);
+    return (0, react_1.useMemo)(() => ({
+        results: state.results,
+        status: state.status,
+        loadMoreStatus: state.loadMoreStatus,
+        total: state.total,
+        totalPages: state.totalPages,
+        error: state.error,
+        loadMore,
+        hasNextPage,
+        isLoading: state.status === 'loading',
+        isSuccess: state.status === 'success',
+        isError: state.status === 'error',
+        isLoadingMore: state.loadMoreStatus === 'loading',
+        isLoadingMoreError: state.loadMoreStatus === 'error',
+    }), [state, loadMore, hasNextPage]);
+};
+exports.useInfiniteSearch = useInfiniteSearch;

package/dist/cjs/search/useSearch.js

@@ -0,0 +1,107 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.useSearch = void 0;
+const react_1 = require("react");
+const utils_1 = require("./utils");
+/**
+ * React hook for performing search queries with pagination.
+ * @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, } = options;
+    const [state, setState] = (0, react_1.useState)(() => {
+        const error = !searchIndexId
+            ? new Error('useSearch: searchIndexId is required when initializing the hook')
+            : null;
+        const status = !searchIndexId ? 'error' : 'idle';
+        return {
+            results: [],
+            total: 0,
+            totalPages: 0,
+            error,
+            status,
+            previousStatus: 'idle',
+        };
+    });
+    const searchService = (0, utils_1.useSearchService)();
+    const abortControllerRef = (0, react_1.useRef)(null);
+    const search = (0, react_1.useCallback)(async () => {
+        if (!searchService || !searchIndexId) {
+            return;
+        }
+        abortControllerRef.current = new AbortController();
+        const signal = abortControllerRef.current.signal;
+        setState((prev) => ({
+            results: keepPreviousData ? prev.results : [],
+            status: 'loading',
+            total: keepPreviousData ? prev.total : 0,
+            totalPages: keepPreviousData ? prev.totalPages : 0,
+            error: null,
+            previousStatus: prev.status,
+        }));
+        try {
+            const offset = (0, utils_1.getOffset)(page, pageSize);
+            const searchParams = {
+                searchIndexId,
+                keyphrase: query,
+                limit: pageSize,
+                offset,
+                sort,
+            };
+            const { results: searchResults, total } = await searchService.search(searchParams, {
+                signal,
+            });
+            if (signal.aborted) {
+                return;
+            }
+            const totalPages = Math.ceil(total / pageSize);
+            setState({
+                results: searchResults,
+                total,
+                totalPages,
+                status: 'success',
+                error: null,
+                previousStatus: 'success',
+            });
+        }
+        catch (err) {
+            // Don't set error if request was aborted
+            if (signal.aborted) {
+                return;
+            }
+            const errorMessage = err instanceof Error ? err : new Error(JSON.stringify(err));
+            setState({
+                results: [],
+                total: 0,
+                totalPages: 0,
+                status: 'error',
+                error: errorMessage,
+                previousStatus: 'error',
+            });
+        }
+    }, [searchService, searchIndexId, page, pageSize, sort, query, keepPreviousData]);
+    (0, react_1.useEffect)(() => {
+        if (enabled) {
+            search();
+        }
+        return () => {
+            var _a;
+            (_a = abortControllerRef.current) === null || _a === void 0 ? void 0 : _a.abort();
+        };
+    }, [search, enabled]);
+    return (0, react_1.useMemo)(() => ({
+        error: state.error,
+        results: state.results,
+        total: state.total,
+        totalPages: state.totalPages,
+        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.useSearch = useSearch;

package/dist/cjs/search/utils.js

@@ -0,0 +1,35 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getOffset = exports.DEFAULT_PAGE_SIZE = void 0;
+exports.useSearchService = useSearchService;
+const search_1 = require("@sitecore-content-sdk/search");
+const react_1 = require("react");
+const withSitecore_1 = require("../enhancers/withSitecore");
+exports.DEFAULT_PAGE_SIZE = 10;
+/**
+ * Hook to initialize and manage SearchService.
+ */
+function useSearchService() {
+    var _a, _b;
+    const { api } = (0, withSitecore_1.useSitecore)();
+    return (0, react_1.useMemo)(() => {
+        var _a;
+        if (!((_a = api === null || api === void 0 ? void 0 : api.edge) === null || _a === void 0 ? void 0 : _a.clientContextId)) {
+            return null;
+        }
+        return new search_1.SearchService({
+            contextId: api.edge.clientContextId,
+            edgeUrl: api.edge.edgeUrl,
+        });
+    }, [(_a = api === null || api === void 0 ? void 0 : api.edge) === null || _a === void 0 ? void 0 : _a.clientContextId, (_b = api === null || api === void 0 ? void 0 : api.edge) === null || _b === void 0 ? void 0 : _b.edgeUrl]);
+}
+/**
+ * Calculates the number of items to skip before returning results.
+ * @param {number} page - The current page number (1-indexed).
+ * @param {number} pageSize - The number of results per page.
+ * @returns The number of items to skip before returning results.
+ */
+const getOffset = (page, pageSize) => {
+    return page === 1 ? 0 : pageSize * (page - 1);
+};
+exports.getOffset = getOffset;

package/dist/esm/search/index.js

@@ -0,0 +1,2 @@
+export { useSearch } from './useSearch';
+export { useInfiniteSearch, } from './useInfiniteSearch';

package/dist/esm/search/useInfiniteSearch.js

@@ -0,0 +1,132 @@
+/* eslint-disable no-unused-vars */
+import { useCallback, useEffect, useMemo, useRef, useState } from 'react';
+import { DEFAULT_PAGE_SIZE, useSearchService } from './utils';
+/**
+ * React hook for performing infinite search queries.
+ * @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 } = options;
+    const [state, setState] = useState(() => {
+        const error = !searchIndexId
+            ? new Error('useInfiniteSearch: searchIndexId is required when initializing the hook')
+            : null;
+        const status = !searchIndexId ? 'error' : 'idle';
+        return {
+            results: [],
+            total: 0,
+            totalPages: 0,
+            error,
+            offset: 0,
+            status,
+            loadMoreStatus: 'idle',
+        };
+    });
+    const hasNextPage = useMemo(() => state.results.length < state.total, [state.results.length, state.total]);
+    const searchService = useSearchService();
+    const abortControllerRef = useRef(null);
+    const search = useCallback(async (offset, isLoadingMore = false) => {
+        if (!searchService || !searchIndexId) {
+            return;
+        }
+        abortControllerRef.current = new AbortController();
+        const signal = abortControllerRef.current.signal;
+        if (isLoadingMore) {
+            setState((prev) => (Object.assign(Object.assign({}, prev), { error: null, loadMoreStatus: 'loading' })));
+        }
+        else {
+            setState({
+                results: [],
+                total: 0,
+                totalPages: 0,
+                error: null,
+                offset: 0,
+                status: 'loading',
+                loadMoreStatus: 'idle',
+            });
+        }
+        try {
+            const searchParams = {
+                searchIndexId,
+                keyphrase: query,
+                limit: pageSize,
+                offset,
+                sort,
+            };
+            const { results: searchResults, total: totalResults } = await searchService.search(searchParams, { signal });
+            if (signal.aborted) {
+                return;
+            }
+            setState((prev) => {
+                const results = isLoadingMore ? [...prev.results, ...searchResults] : searchResults;
+                const totalPages = Math.ceil(totalResults / pageSize);
+                return {
+                    results,
+                    error: null,
+                    offset,
+                    status: 'success',
+                    loadMoreStatus: 'idle',
+                    total: totalResults,
+                    totalPages,
+                };
+            });
+        }
+        catch (err) {
+            // Don't set error if request was aborted
+            if (signal.aborted) {
+                return;
+            }
+            const errorMessage = err instanceof Error ? err : new Error(JSON.stringify(err));
+            // Don't clean up existing results if appending results
+            if (isLoadingMore) {
+                setState((prev) => (Object.assign(Object.assign({}, prev), { error: errorMessage, loadMoreStatus: 'error' })));
+            }
+            else {
+                setState({
+                    results: [],
+                    total: 0,
+                    totalPages: 0,
+                    error: errorMessage,
+                    offset: 0,
+                    status: 'error',
+                    loadMoreStatus: 'idle',
+                });
+            }
+        }
+    }, [searchService, pageSize, sort, query, searchIndexId]);
+    useEffect(() => {
+        if (enabled) {
+            search(0, false);
+        }
+        return () => {
+            var _a;
+            (_a = abortControllerRef.current) === null || _a === void 0 ? void 0 : _a.abort();
+        };
+    }, [search, enabled]);
+    const loadMore = useCallback(() => {
+        // Don't load more if already loading or no more pages
+        if (state.loadMoreStatus === 'loading' || !hasNextPage) {
+            return;
+        }
+        const nextOffset = state.offset + pageSize;
+        search(nextOffset, true);
+    }, [search, pageSize, state.offset, hasNextPage, state.loadMoreStatus]);
+    return useMemo(() => ({
+        results: state.results,
+        status: state.status,
+        loadMoreStatus: state.loadMoreStatus,
+        total: state.total,
+        totalPages: state.totalPages,
+        error: state.error,
+        loadMore,
+        hasNextPage,
+        isLoading: state.status === 'loading',
+        isSuccess: state.status === 'success',
+        isError: state.status === 'error',
+        isLoadingMore: state.loadMoreStatus === 'loading',
+        isLoadingMoreError: state.loadMoreStatus === 'error',
+    }), [state, loadMore, hasNextPage]);
+};

package/dist/esm/search/useSearch.js

@@ -0,0 +1,103 @@
+import { useCallback, useEffect, useMemo, useRef, useState } from 'react';
+import { DEFAULT_PAGE_SIZE, getOffset, useSearchService } from './utils';
+/**
+ * React hook for performing search queries with pagination.
+ * @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, } = options;
+    const [state, setState] = useState(() => {
+        const error = !searchIndexId
+            ? new Error('useSearch: searchIndexId is required when initializing the hook')
+            : null;
+        const status = !searchIndexId ? 'error' : 'idle';
+        return {
+            results: [],
+            total: 0,
+            totalPages: 0,
+            error,
+            status,
+            previousStatus: 'idle',
+        };
+    });
+    const searchService = useSearchService();
+    const abortControllerRef = useRef(null);
+    const search = useCallback(async () => {
+        if (!searchService || !searchIndexId) {
+            return;
+        }
+        abortControllerRef.current = new AbortController();
+        const signal = abortControllerRef.current.signal;
+        setState((prev) => ({
+            results: keepPreviousData ? prev.results : [],
+            status: 'loading',
+            total: keepPreviousData ? prev.total : 0,
+            totalPages: keepPreviousData ? prev.totalPages : 0,
+            error: null,
+            previousStatus: prev.status,
+        }));
+        try {
+            const offset = getOffset(page, pageSize);
+            const searchParams = {
+                searchIndexId,
+                keyphrase: query,
+                limit: pageSize,
+                offset,
+                sort,
+            };
+            const { results: searchResults, total } = await searchService.search(searchParams, {
+                signal,
+            });
+            if (signal.aborted) {
+                return;
+            }
+            const totalPages = Math.ceil(total / pageSize);
+            setState({
+                results: searchResults,
+                total,
+                totalPages,
+                status: 'success',
+                error: null,
+                previousStatus: 'success',
+            });
+        }
+        catch (err) {
+            // Don't set error if request was aborted
+            if (signal.aborted) {
+                return;
+            }
+            const errorMessage = err instanceof Error ? err : new Error(JSON.stringify(err));
+            setState({
+                results: [],
+                total: 0,
+                totalPages: 0,
+                status: 'error',
+                error: errorMessage,
+                previousStatus: 'error',
+            });
+        }
+    }, [searchService, searchIndexId, page, pageSize, sort, query, keepPreviousData]);
+    useEffect(() => {
+        if (enabled) {
+            search();
+        }
+        return () => {
+            var _a;
+            (_a = abortControllerRef.current) === null || _a === void 0 ? void 0 : _a.abort();
+        };
+    }, [search, enabled]);
+    return useMemo(() => ({
+        error: state.error,
+        results: state.results,
+        total: state.total,
+        totalPages: state.totalPages,
+        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/dist/esm/search/utils.js

@@ -0,0 +1,30 @@
+import { SearchService } from '@sitecore-content-sdk/search';
+import { useMemo } from 'react';
+import { useSitecore } from '../enhancers/withSitecore';
+export const DEFAULT_PAGE_SIZE = 10;
+/**
+ * Hook to initialize and manage SearchService.
+ */
+export function useSearchService() {
+    var _a, _b;
+    const { api } = useSitecore();
+    return useMemo(() => {
+        var _a;
+        if (!((_a = api === null || api === void 0 ? void 0 : api.edge) === null || _a === void 0 ? void 0 : _a.clientContextId)) {
+            return null;
+        }
+        return new SearchService({
+            contextId: api.edge.clientContextId,
+            edgeUrl: api.edge.edgeUrl,
+        });
+    }, [(_a = api === null || api === void 0 ? void 0 : api.edge) === null || _a === void 0 ? void 0 : _a.clientContextId, (_b = api === null || api === void 0 ? void 0 : api.edge) === null || _b === void 0 ? void 0 : _b.edgeUrl]);
+}
+/**
+ * Calculates the number of items to skip before returning results.
+ * @param {number} page - The current page number (1-indexed).
+ * @param {number} pageSize - The number of results per page.
+ * @returns The number of items to skip before returning results.
+ */
+export const getOffset = (page, pageSize) => {
+    return page === 1 ? 0 : pageSize * (page - 1);
+};

package/global.d.ts

@@ -0,0 +1,17 @@
+declare module 'style-attr' {
+  export const parse: (
+    style: string,
+    config: { preserveNumbers: boolean }
+  ) => { [key: string]: unknown };
+}
+
+declare namespace NodeJS {
+  export interface Global {
+    [key: string]: unknown;
+    requestAnimationFrame: (callback: () => void) => void;
+    window: Window;
+    document: Document;
+    navigator: Navigator;
+    HTMLElement: HTMLElement;
+  }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sitecore-content-sdk/react",
-  "version": "1.3.0-canary.31",
+  "version": "1.3.0-canary.35",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",
   "sideEffects": false,
@@ -76,16 +76,30 @@
     "react-dom": "^19.1.0"
   },
   "dependencies": {
-    "@sitecore-content-sdk/core": "1.3.0-canary.31",
+    "@sitecore-content-sdk/core": "1.3.0-canary.35",
+    "@sitecore-content-sdk/search": "1.3.0-canary.35",
     "fast-deep-equal": "^3.1.3"
   },
   "description": "",
   "types": "types/index.d.ts",
-  "gitHead": "721a4d75a24fca90fb0cbd3c051db90325f8f086",
+  "gitHead": "11355ebc3060a277b17c0c4283ad36afabfc2b0e",
   "files": [
     "dist",
-    "types"
+    "types",
+    "/*.d.ts"
   ],
+  "exports": {
+    ".": {
+      "import": "./dist/esm/index.js",
+      "require": "./dist/cjs/index.js",
+      "types": "./types/index.d.ts"
+    },
+    "./search": {
+      "import": "./dist/esm/search/index.js",
+      "require": "./dist/cjs/search/index.js",
+      "types": "./types/search/index.d.ts"
+    }
+  },
   "imports": {
     "#rsc-env": {
       "react-server": {

package/search.d.ts

@@ -0,0 +1 @@
+export * from './types/search/index';

package/types/search/index.d.ts

@@ -0,0 +1,4 @@
+export { useSearch, UseSearchState, UseSearchOptions } from './useSearch';
+export { useInfiniteSearch, UseInfiniteSearchState, UseInfiniteSearchOptions, } from './useInfiniteSearch';
+export { SearchStatus } from './utils';
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +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"}

package/types/search/useInfiniteSearch.d.ts

@@ -0,0 +1,116 @@
+import { SearchStatus } from './utils';
+import { SearchDocument, SearchParameters } from '@sitecore-content-sdk/search';
+/**
+ * Options for the useInfiniteSearch hook.
+ * @public
+ */
+export interface UseInfiniteSearchOptions<T extends SearchDocument = SearchDocument> {
+    /**
+     * The query string to search for.
+     * By default empty string is used.
+     */
+    query?: string;
+    /**
+     * The ID of the search index to use.
+     */
+    searchIndexId: string;
+    /**
+     * Number of results per page.
+     * @default 10
+     */
+    pageSize?: number;
+    /**
+     * Specifies the sorting of the search results.
+     */
+    sort?: SearchParameters<T>['sort'];
+    /**
+     * Specifies whether the search should automatically run.
+     * @default true
+     */
+    enabled?: boolean;
+}
+/**
+ * The state of the useInfiniteSearch hook.
+ * @public
+ */
+export type UseInfiniteSearchState<T extends SearchDocument = SearchDocument> = Omit<InternalInfiniteSearchState<T>, 'offset'> & {
+    /**
+     * Load the next page of results.
+     */
+    loadMore: () => void;
+    /**
+     * Whether there are more results available.
+     */
+    hasNextPage: boolean;
+    /**
+     * Whether a search request is currently in progress.
+     */
+    isLoading: boolean;
+    /**
+     * Whether the search request was successful.
+     */
+    isSuccess: boolean;
+    /**
+     * Whether the search request failed.
+     */
+    isError: boolean;
+    /**
+     * Whether a search request for more results is currently in progress.
+     */
+    isLoadingMore: boolean;
+    /**
+     * Whether the search request for more results failed.
+     */
+    isLoadingMoreError: boolean;
+};
+type InternalInfiniteSearchState<T extends SearchDocument = SearchDocument> = {
+    /**
+     * The search results.
+     */
+    results: T[];
+    /**
+     * Total number of results across all pages.
+     */
+    total: number;
+    /**
+     * Total number of pages available based on `total` and `pageSize`.
+     */
+    totalPages: number;
+    /**
+     * The error object if the last search request failed, or null if no error occurred.
+     */
+    error: Error | null;
+    /**
+     * The current offset of the search results.
+     */
+    offset: number;
+    /**
+     * The status of the initial search request.
+     * It will be set to:
+     * - 'idle' if no search request has been made yet.
+     * - 'loading' if a search request is currently in progress.
+     * - 'success' if a search request was successful.
+     * - 'error' if a search request failed.
+     * @default 'idle'
+     */
+    status: SearchStatus;
+    /**
+     * The status of the "load more" request.
+     * It will be set to:
+     * - 'idle' if no "load more" request has been made yet.
+     * - 'loading' if a "load more" request is currently in progress.
+     * - 'error' if a "load more" request failed.
+     * @default 'idle'
+     */
+    loadMoreStatus: Omit<SearchStatus, 'success'>;
+};
+/**
+ * React hook for performing infinite search queries.
+ * @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 declare const useInfiniteSearch: <T extends SearchDocument = SearchDocument>(options: UseInfiniteSearchOptions<T>) => UseInfiniteSearchState<T>;
+export {};
+//# sourceMappingURL=useInfiniteSearch.d.ts.map

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

@@ -0,0 +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,MAAM,8BAA8B,CAAC;AAEhF;;;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;CACnB;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,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,CA6J1B,CAAC"}

package/types/search/useSearch.d.ts

@@ -0,0 +1,107 @@
+import { SearchDocument, SearchParameters } from '@sitecore-content-sdk/search';
+import { SearchStatus } from './utils';
+/**
+ * Options for the useSearch hook.
+ * @public
+ */
+export interface UseSearchOptions<T extends SearchDocument = SearchDocument> {
+    /**
+     * The query string to search for.
+     * By default empty string is used.
+     */
+    query?: string;
+    /**
+     * The current page number (1-indexed).
+     * If not provided, the search will start on page 1.
+     */
+    page?: number;
+    /**
+     * The ID of the search index to use.
+     */
+    searchIndexId: string;
+    /**
+     * Number of results per page.
+     * @default 10
+     */
+    pageSize?: number;
+    /**
+     * Specifies the sorting of the search results.
+     */
+    sort?: SearchParameters<T>['sort'];
+    /**
+     * Specifies whether the search should automatically run.
+     * @default true
+     */
+    enabled?: boolean;
+    /**
+     * Specifies whether the previous search results should be kept when fetching new results.
+     * @default false
+     */
+    keepPreviousData?: boolean;
+}
+type InternalState<T extends SearchDocument = SearchDocument> = {
+    /**
+     * The search results.
+     */
+    results: T[];
+    /**
+     * Total number of results across all pages.
+     */
+    total: number;
+    /**
+     * Total number of pages available based on `total` and `pageSize`.
+     */
+    totalPages: number;
+    /**
+     * The error object if the last search request failed, or null if no error occurred.
+     */
+    error: Error | null;
+    /**
+     * The status of the search.
+     * It will be set to:
+     * - 'idle' if no search request has been made yet.
+     * - 'loading' if a search request is currently in progress.
+     * - 'success' if a search request was successful.
+     * - 'error' if a search request failed.
+     * @default 'idle'
+     */
+    status: SearchStatus;
+    /**
+     * The status of the previous search request.
+     * @default 'idle'
+     */
+    previousStatus: SearchStatus;
+};
+/**
+ * The state of the useSearch hook.
+ * @public
+ */
+export type UseSearchState<T extends SearchDocument = SearchDocument> = Omit<InternalState<T>, 'previousStatus'> & {
+    /**
+     * Whether a search request is currently in progress.
+     */
+    isLoading: boolean;
+    /**
+     * Whether the search request was successful.
+     */
+    isSuccess: boolean;
+    /**
+     * Whether the search request failed.
+     */
+    isError: boolean;
+    /**
+     * Whether the search results from the previous query are returned.
+     * Will be `true` if `keepPreviousData` is set.
+     */
+    isPreviousData: boolean;
+};
+/**
+ * React hook for performing search queries with pagination.
+ * @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 declare const useSearch: <T extends SearchDocument = SearchDocument>(options: UseSearchOptions<T>) => UseSearchState<T>;
+export {};
+//# sourceMappingURL=useSearch.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"useSearch.d.ts","sourceRoot":"","sources":["../../src/search/useSearch.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,cAAc,EAAE,gBAAgB,EAAE,MAAM,8BAA8B,CAAC;AAChF,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;CAC5B;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,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,CAwHlB,CAAC"}

package/types/search/utils.d.ts

@@ -0,0 +1,19 @@
+import { SearchService } from '@sitecore-content-sdk/search';
+export declare const DEFAULT_PAGE_SIZE = 10;
+/**
+ * The status of a search request.
+ * @public
+ */
+export type SearchStatus = 'idle' | 'loading' | 'success' | 'error';
+/**
+ * Hook to initialize and manage SearchService.
+ */
+export declare function useSearchService(): SearchService;
+/**
+ * Calculates the number of items to skip before returning results.
+ * @param {number} page - The current page number (1-indexed).
+ * @param {number} pageSize - The number of results per page.
+ * @returns The number of items to skip before returning results.
+ */
+export declare const getOffset: (page: number, pageSize: number) => number;
+//# sourceMappingURL=utils.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../src/search/utils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,8BAA8B,CAAC;AAI7D,eAAO,MAAM,iBAAiB,KAAK,CAAC;AAEpC;;;GAGG;AACH,MAAM,MAAM,YAAY,GAAG,MAAM,GAAG,SAAS,GAAG,SAAS,GAAG,OAAO,CAAC;AAEpE;;GAEG;AACH,wBAAgB,gBAAgB,kBAa/B;AAED;;;;;GAKG;AACH,eAAO,MAAM,SAAS,GAAI,MAAM,MAAM,EAAE,UAAU,MAAM,WAEvD,CAAC"}