@nosto/search-js 1.6.0 → 1.7.0

package/dist/preact/src/components/InfiniteScroll/InfiniteScroll.d.ts

@@ -0,0 +1,51 @@
+import { ComponentChildren, ComponentType } from 'preact';
+import { InfiniteScrollWithObserver } from './InfiniteScrollWithObserver';
+/**
+ * Infinite scroll component props
+ * @param children - The children to render
+ * @param loadMoreComponent - The component to render when more results are available
+ * @param pageSize - The page size to use when loading more results
+ */
+export interface InfiniteScrollProps {
+    children: ComponentChildren;
+    loadMoreComponent?: ComponentType<{
+        pageSize?: number;
+    }>;
+    pageSize?: number;
+}
+/**
+ * Infinite scroll component that loads more results when user scrolls to the end of the page.
+ * If the browser does not support IntersectionObserver, a load more button is shown instead.
+ * @param props
+ * @example
+ * ```jsx
+ * import { InfiniteScroll } from "@nosto/search-js/preact"
+ *
+ * <InfiniteScroll pageSize={defaultConfig.pageSize}>
+ *    {products?.hits?.map(hit => <Product hit={hit} />)}
+ * </InfiniteScroll>
+ *
+ * <InfiniteScroll pageSize={defaultConfig.pageSize}>
+ *    <Products />
+ * </InfiniteScroll>
+ *
+ * // With custom load more button
+ * function LoadMoreButton({ pageSize }) {
+ *     const { loadMore } = useLoadMore(pageSize)
+ *
+ *     return (
+ *         <button
+ *              onClick={loadMore}
+ *          >
+ *              More results
+ *         </button>
+ *    )
+ * }
+ *
+ * <InfiniteScroll loadMoreComponent={LoadMoreButton} pageSize={defaultConfig.pageSize}>
+ *   {products?.hits?.map(hit => <Product hit={hit} />)}
+ * </InfiniteScroll>
+ * ```
+ * @group Components
+ */
+export declare const InfiniteScroll: typeof InfiniteScrollWithObserver;

package/dist/preact/src/components/InfiniteScroll/InfiniteScrollWithLink.d.ts

@@ -0,0 +1,6 @@
+import { InfiniteScrollProps } from './InfiniteScroll';
+/**
+ * Infinite scroll component that loads more results when user clicks a link.
+ * @group Components
+ */
+export declare function InfiniteScrollWithLink({ children, loadMoreComponent: LoadMore, pageSize }: InfiniteScrollProps): import("preact").JSX.Element;

package/dist/preact/src/components/InfiniteScroll/InfiniteScrollWithObserver.d.ts

@@ -0,0 +1,7 @@
+import { JSX } from 'preact';
+import { InfiniteScrollProps } from './InfiniteScroll';
+/**
+ * Infinite scroll component that loads more results when user scrolls to the end of the page.
+ * @group Components
+ */
+export declare function InfiniteScrollWithObserver({ children, pageSize }: InfiniteScrollProps): JSX.Element;

package/dist/preact/src/components/InfiniteScroll/LoadMoreLink.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Load more link component
+ * @group Components
+ */
+export declare function LoadMoreLink({ pageSize }: {
+    pageSize?: number;
+}): import("preact").JSX.Element;

package/dist/preact/src/components/InfiniteScroll/utils.d.ts

@@ -0,0 +1,9 @@
+import { SearchQuery, SearchResult } from '@nosto/nosto-js/client';
+/**
+ * Function to check if there are more results to fetch.
+ */
+export declare function hasMoreResults(query: SearchQuery, result: SearchResult): boolean;
+/**
+ * Function to check if IntersectionObserver is supported in the browser.
+ */
+export declare function intersectionObserverSupported(): boolean;

package/dist/preact/src/hooks/useLoadMore/getNextPageQuery.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Function to calculate the new query values for loading more products
+ */
+export declare function getNextPageQuery({ from, size, pageSize }: {
+    from: number;
+    size: number;
+    pageSize: number;
+}): {
+    products: {
+        from: number;
+        size?: undefined;
+    };
+} | {
+    products: {
+        size: number;
+        from?: undefined;
+    };
+};

package/dist/preact/src/hooks/useLoadMore/useLoadMore.d.ts

@@ -0,0 +1,24 @@
+/**
+ * Hook for loading more results by specified pageSize value
+ * @example
+ * ```jsx
+ *  import { useLoadMore } from '@nosto/search-js/preact'
+ *
+ *  function LoadMoreButton({ pageSize }) {
+ *     const { loadMore } = useLoadMore(pageSize)
+ *
+ *     return (
+ *         <a
+ *              onClick={loadMore}
+ *          >
+ *              More results
+ *         </a>
+ *    )
+ * }
+ * ```
+ * @param pageSize - number of additional products to load (default=24)
+ * @group Hooks
+ */
+export declare function useLoadMore(pageSize?: number): {
+    loadMore: () => Promise<void>;
+};

package/dist/utils/src/isBot.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Check if the current user agent is a bot
+ */
+export declare function isBot(): boolean;

package/dist/utils/src/pick.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Pick properties from an object
+ * @param obj - The object to pick properties from
+ * @param props - The properties to pick
+ */
+export declare function pick<T extends object, K extends keyof T>(obj: T, ...props: K[]): Pick<T, K>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nosto/search-js",
-  "version": "1.6.0",
+  "version": "1.7.0",
   "license": "ISC",
   "type": "module",
   "files": [
@@ -63,10 +63,11 @@
     "eslint-config-prettier": "^10.1.1",
     "eslint-plugin-barrel-files": "^3.0.1",
     "eslint-plugin-prettier": "^5.2.4",
-    "eslint-plugin-simple-import-sort": "^12.1.1",
-    "eslint-plugin-unused-imports": "^4.1.4",
     "eslint-plugin-react": "^7.37.4",
     "eslint-plugin-react-hooks": "^5.2.0",
+    "eslint-plugin-simple-import-sort": "^12.1.1",
+    "eslint-plugin-unused-imports": "^4.1.4",
+    "isbot": "^5.1.25",
     "jsdom": "^26.0.0",
     "prettier": "^3.5.3",
     "typedoc": "^0.27.9",