@nosto/search-js 1.5.1 → 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/preact/src/hooks/usePagination.d.ts

@@ -0,0 +1,43 @@
+/**
+ * Pagination page type.
+ */
+export type Page = {
+    from: number;
+    page: number;
+    current: boolean;
+};
+/**
+ * Preact hook that import pagination state to the component.
+ *
+ * **Should always be at the top of the component!**
+ *
+ * @example
+ * ```jsx
+ * import { usePagination } from '@nosto/search-js/preact'
+ *
+ * export default () => {
+ *     const { pages } = usePagination()
+ *
+ *     return pages.map((page) => <li>
+ *         {page.current ? <span>{page.page}</span> : <a>
+ *             {page.page}
+ *         </a>}
+ *     </li>)
+ * }
+ * ```
+ *
+ * @group Hooks
+ */
+export declare function usePagination(options?: {
+    width?: number;
+}): {
+    totalPages: number;
+    resultsFrom: number;
+    resultsTo: number;
+    current?: Page;
+    prev?: Page;
+    next?: Page;
+    first?: Page;
+    last?: Page;
+    pages: Page[];
+};

package/dist/search-B0-bVNMy.js

@@ -0,0 +1,43 @@
+import { s } from "./index.es-B8mbAxS4.js";
+function a(t, r) {
+  if (!t.products || !(r != null && r.length))
+    return t;
+  const e = (i) => r.reduce((u, n) => n(u), i);
+  return {
+    ...t,
+    products: {
+      ...t.products,
+      hits: t.products.hits.map(e)
+    }
+  };
+}
+function o(t) {
+  return new Promise((r) => setTimeout(r, t));
+}
+async function f(t, r, e) {
+  const { maxRetries: i = 0, retryInterval: u = 1e3 } = e;
+  let n = 0;
+  for (; ; )
+    try {
+      return await t.search(r, e);
+    } catch (c) {
+      if (!h(c))
+        throw console.info("Skipping retry logic for", c), c;
+      if (n >= i)
+        throw c;
+      n++, await o(u);
+    }
+}
+function h(t) {
+  return !t || typeof t != "object" ? !1 : !("status" in t) || l(t.status);
+}
+function l(t) {
+  return typeof t == "number" && (t < 400 || t >= 500);
+}
+async function p(t, r = {}) {
+  const { hitDecorators: e, ...i } = r, u = await new Promise(s), n = await f(u, t, i);
+  return a(n, e);
+}
+export {
+  p as s
+};

package/dist/search-BVJZK90N.cjs

@@ -0,0 +1 @@
+"use strict";const s=require("./index.es-DlUp67LT.cjs");function a(t,e){if(!t.products||!(e!=null&&e.length))return t;const r=i=>e.reduce((u,n)=>n(u),i);return{...t,products:{...t.products,hits:t.products.hits.map(r)}}}function o(t){return new Promise(e=>setTimeout(e,t))}async function f(t,e,r){const{maxRetries:i=0,retryInterval:u=1e3}=r;let n=0;for(;;)try{return await t.search(e,r)}catch(c){if(!h(c))throw console.info("Skipping retry logic for",c),c;if(n>=i)throw c;n++,await o(u)}}function h(t){return!t||typeof t!="object"?!1:!("status"in t)||l(t.status)}function l(t){return typeof t=="number"&&(t<400||t>=500)}async function y(t,e={}){const{hitDecorators:r,...i}=e,u=await new Promise(s.s),n=await f(u,t,i);return a(n,r)}exports.search=y;

package/dist/thumbnails/thumbnails.cjs.js

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const p=require("../index.es-D_7T9vdv.cjs");function s({size:e,productId:a,hash:u}){const i=p.i();if(!i)throw new Error("Client script settings are not yet available");return`https://${i.thumbnailHost}/${i.account}/${e}/${a}/${u}/A`}function l({size:e}){function a(c,r){if(r)return s({size:e,productId:c,hash:r})}function u(c,r){if(r)return r.map(t=>({...t,imageUrl:a(c,t.imageHash)??t.imageUrl}))}function i(c,r,t){if(!t)return r;if(r)return t.map(n=>s({size:e,productId:c,hash:n}))}return function(r){const t=r.productId;return t?{...r,imageUrl:a(t,r.imageHash)??r.imageUrl,thumbUrl:a(t,r.thumbHash)??r.thumbUrl,skus:u(t,r.skus),alternateImageUrls:i(t,r.alternateImageUrls,r.alternateImageHashes)}:r}}const g=/cdn\.shopify\.com/,m={1:"170x170_crop_center",2:"100x100_crop_center",3:"90x70_crop_center",4:"50x50_crop_center",5:"30x30_crop_center",6:"100x140_crop_center",7:"200x200_crop_center",8:"400x400",9:"750x750"};function U(e){return e in m}function f({size:e,fallback:a=u=>u}){if(e==="orig")return a;const u=m[e]||e;function i(n){return n?new URL(n).hostname.match(g):!1}function c(n){return n?i(n)?n.replace(/(\.jpg|\.png|\.jpeg|\.gif|\.webp)/,`_${u}$1`):n:""}function r(n){if(n)return n.map(o=>({...o,imageUrl:c(o.imageUrl)}))}function t(n){if(n)return n.map(o=>c(o))}return function(o){return i(o.imageUrl)?{...o,imageUrl:c(o.imageUrl),thumbUrl:c(o.thumbUrl),skus:r(o.skus),alternateImageUrls:t(o.alternateImageUrls)}:a(o)}}function d(){var e;return(e=window.Nosto)==null?void 0:e.shopifyScript}function b({size:e}){const a=l({size:e});return d()&&U(e)?f({size:e,fallback:a}):a}exports.generateThumbnailUrl=s;exports.nostoThumbnailDecorator=l;exports.shopifyThumbnailDecorator=f;exports.thumbnailDecorator=b;
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const p=require("../index.es-DlUp67LT.cjs");function s({size:e,productId:a,hash:u}){const i=p.i();if(!i)throw new Error("Client script settings are not yet available");return`https://${i.thumbnailHost}/${i.account}/${e}/${a}/${u}/A`}function l({size:e}){function a(c,r){if(r)return s({size:e,productId:c,hash:r})}function u(c,r){if(r)return r.map(t=>({...t,imageUrl:a(c,t.imageHash)??t.imageUrl}))}function i(c,r,t){if(!t)return r;if(r)return t.map(n=>s({size:e,productId:c,hash:n}))}return function(r){const t=r.productId;return t?{...r,imageUrl:a(t,r.imageHash)??r.imageUrl,thumbUrl:a(t,r.thumbHash)??r.thumbUrl,skus:u(t,r.skus),alternateImageUrls:i(t,r.alternateImageUrls,r.alternateImageHashes)}:r}}const g=/cdn\.shopify\.com/,m={1:"170x170_crop_center",2:"100x100_crop_center",3:"90x70_crop_center",4:"50x50_crop_center",5:"30x30_crop_center",6:"100x140_crop_center",7:"200x200_crop_center",8:"400x400",9:"750x750"};function U(e){return e in m}function f({size:e,fallback:a=u=>u}){if(e==="orig")return a;const u=m[e]||e;function i(n){return n?new URL(n).hostname.match(g):!1}function c(n){return n?i(n)?n.replace(/(\.jpg|\.png|\.jpeg|\.gif|\.webp)/,`_${u}$1`):n:""}function r(n){if(n)return n.map(o=>({...o,imageUrl:c(o.imageUrl)}))}function t(n){if(n)return n.map(o=>c(o))}return function(o){return i(o.imageUrl)?{...o,imageUrl:c(o.imageUrl),thumbUrl:c(o.thumbUrl),skus:r(o.skus),alternateImageUrls:t(o.alternateImageUrls)}:a(o)}}function d(){var e;return(e=window.Nosto)==null?void 0:e.shopifyScript}function b({size:e}){const a=l({size:e});return d()&&U(e)?f({size:e,fallback:a}):a}exports.generateThumbnailUrl=s;exports.nostoThumbnailDecorator=l;exports.shopifyThumbnailDecorator=f;exports.thumbnailDecorator=b;

package/dist/thumbnails/thumbnails.es.js

@@ -1,4 +1,4 @@
-import { i as m } from "../index.es-Bcd5IQh9.js";
+import { i as m } from "../index.es-B8mbAxS4.js";
 function s({ size: e, productId: a, hash: i }) {
   const u = m();
   if (!u)

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/dist/utils/src/range.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Generate an array of numbers from start to exlusive end
+ * @param start number of array range start
+ * @param end number of array range end
+ * @returns an array of numbers from start to exlusive end
+ * @example
+ * ```ts
+ * range(1, 5) // [1, 2, 3, 4]
+ * ```
+ */
+export declare function range(start: number, end: number): number[];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nosto/search-js",
-  "version": "1.5.1",
+  "version": "1.7.0",
   "license": "ISC",
   "type": "module",
   "files": [
@@ -53,28 +53,29 @@
     "install:dev": "(cd dev/preact && npm i --ignore-scripts)"
   },
   "devDependencies": {
-    "@nosto/nosto-js": "^1.5.0",
+    "@nosto/nosto-js": "^1.7.0",
     "@testing-library/dom": "^10.4.0",
     "@types/eslint-config-prettier": "^6.11.3",
-    "@types/node": "^22.13.10",
+    "@types/node": "^22.13.13",
     "concurrently": "^9.1.2",
     "copyfiles": "^2.4.1",
-    "eslint": "^9.22.0",
+    "eslint": "^9.23.0",
     "eslint-config-prettier": "^10.1.1",
     "eslint-plugin-barrel-files": "^3.0.1",
-    "eslint-plugin-prettier": "^5.2.3",
-    "eslint-plugin-simple-import-sort": "^12.1.1",
-    "eslint-plugin-unused-imports": "^4.1.4",
+    "eslint-plugin-prettier": "^5.2.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",
     "typescript": "^5.8.2",
-    "typescript-eslint": "^8.26.0",
-    "vite": "^6.2.1",
+    "typescript-eslint": "^8.28.0",
+    "vite": "^6.2.3",
     "vite-plugin-dts": "^4.5.3",
-    "vitest": "^3.0.8"
+    "vitest": "^3.0.9"
   },
   "publishConfig": {
     "access": "public"

package/dist/index.es-Bcd5IQh9.js

@@ -1,20 +0,0 @@
-function o() {
-  window.nostojs = window.nostojs ?? function(n) {
-    (window.nostojs.q = window.nostojs.q ?? []).push(n);
-  };
-}
-async function i(n) {
-  return window.nostojs(n);
-}
-let t = null;
-typeof window < "u" && (o(), i((n) => {
-  t = n.internal.getSettings();
-}));
-function s() {
-  return t;
-}
-typeof window < "u" && o();
-export {
-  s as i,
-  i as s
-};

package/dist/index.es-D_7T9vdv.cjs

@@ -1 +0,0 @@
-"use strict";function o(){window.nostojs=window.nostojs??function(n){(window.nostojs.q=window.nostojs.q??[]).push(n)}}async function t(n){return window.nostojs(n)}let s=null;typeof window<"u"&&(o(),t(n=>{s=n.internal.getSettings()}));function i(){return s}typeof window<"u"&&o();exports.i=i;exports.s=t;