@nosto/search-js 2.0.0 → 2.1.0

package/README.md

@@ -1,12 +1,18 @@
 # Search JS
 
-Search JS is a wrapper for the Nosto Search functionality with some extended functionality such as
-* Nosto currency formatting
-* Nosto product thumbnails
-* Retry logic
+Nosto Search JS is an implementation of Nosto Search. In addition to the base search functionality, it also provides the following features:
 
+* **Currency formatting**: Format prices based on Nosto settings.
+* **Product thumbnails**: Thumbnail resizing.
+* **Retry logic**: Retry failed search queries automatically.
+* **Preact components**: Build modern search interfaces.
+* **Autocomplete**: Fast and responsive autocomplete tools.
+* **Category search**: Display and filter by categories.
+* **SERPs**: Build search result pages with sorting and pagination.
+* **Utilities**: Helpers for common tasks like array or object merging and equality checks.
+* **Infinite scroll**: Loads more components upon scrolling to the end of results.
+  
 ## Installation
-
 To install the package, use your preferred package manager:
 
 ```bash
@@ -22,7 +28,43 @@ Read [Nosto Techdocs](https://docs.nosto.com/techdocs/apis/frontend/oss/search-j
 [Library TypeDoc page](https://nosto.github.io/search-js/) includes detailed library helpers documentation and examples.
 
 ## Packages
-### `preact/legacy`
-The `preact/legacy` package is designed to provide backward compatibility for existing Search Template implementations. It serves as a bridge to support legacy functionality.
 
-> The components included in this package are intended solely for compatibility purposes. They are not recommended for use in new development or as active components in modern applications.
+### `core`
+The `core` package provides the foundational functionality for interacting with Nosto Search. It includes utilities for managing search queries, applying decorators, and handling search results.
+
+---
+
+### `currencies`
+The `currencies` package provides utilities for formatting monetary values and decorating search results with price information.
+
+---
+
+### `preact` packages
+
+#### `preact/autocomplete`
+The `preact/autocomplete` package helps you add autocomplete functionality to your search interface.
+
+#### `preact/category`
+The `preact/category` package provides tools to show and interact with category-based search results.
+
+#### `preact/common`
+The `preact/common` package includes shared components that are used across other `preact` packages.
+
+#### `preact/hooks`
+The `preact/hooks` package offers hooks to manage state and actions in your search app.
+
+#### `preact/serp`
+The `preact/serp` package provides tools to create Search Engine Results Pages (SERPs) with features like pagination, sorting, and displaying results.
+
+#### `preact/legacy`
+The `preact/legacy` package is designed to provide backward compatibility for existing Search Template implementations.
+
+> The components included in this package are intended solely for compatibility purposes. They are not recommended for use in new development or as active components in modern applications.
+
+### `thumbnails`
+The `thumbnails` package helps you resize thumbnails. It supports different formats, including Shopify and Nosto-specific ones.
+
+---
+
+### `utils`
+The `utils` package includes handy tools for common tasks like array or object merging, checking equality, and generating unique values.

package/dist/core/core.d.ts

@@ -1,4 +1,4 @@
 /** @module ./ */
 export { addToCart, type SearchHitWithSku } from './src/addToCart';
 export { search } from './src/search';
-export type { DecoratedProduct, DecoratedResult, HitDecorator, Options, ToIntersection } from './src/types';
+export type { DecoratedProduct, DecoratedResult, HitDecorator, SearchOptions, ToIntersection } from './src/types';

package/dist/core/src/search.d.ts

@@ -1,5 +1,5 @@
 import { SearchQuery } from '@nosto/nosto-js/client';
-import { HitDecorator, Options } from './types';
+import { HitDecorator, SearchOptions } from './types';
 /**
  * Performs a search operation using the provided query and options.
  *
@@ -7,7 +7,7 @@ import { HitDecorator, Options } from './types';
  * @param options - An object containing optional parameters for the search.
  * @returns A promise that resolves to the search result.
  */
-export declare function search<HD extends readonly HitDecorator[]>(query: SearchQuery, options?: Options<HD>): Promise<{
+export declare function search<HD extends readonly HitDecorator[]>(query: SearchQuery, options?: SearchOptions<HD>): Promise<{
     products: {
         hits: import('./types').ToIntersection<ReturnType<HD[number]>>[];
         categoryId?: string;

package/dist/core/src/searchWithRetries.d.ts

@@ -1,6 +1,6 @@
 import { API, SearchQuery, SearchResult } from '@nosto/nosto-js/client';
-import { Options } from './types';
-export declare function searchWithRetries(api: API, query: SearchQuery, options: Options<[]>): Promise<SearchResult>;
+import { SearchOptions } from './types';
+export declare function searchWithRetries(api: API, query: SearchQuery, options: SearchOptions<[]>): Promise<SearchResult>;
 /**
  * Should the error trigger a search retry
  */

package/dist/core/src/types.d.ts

@@ -1,5 +1,5 @@
-import { SearchOptions, SearchProduct, SearchResult } from '@nosto/nosto-js/client';
-export type Options<HD extends readonly HitDecorator[] = readonly HitDecorator[]> = SearchOptions & {
+import { SearchOptions as BaseOptions, SearchProduct, SearchResult } from '@nosto/nosto-js/client';
+export type SearchOptions<HD extends readonly HitDecorator[] = readonly HitDecorator[]> = BaseOptions & {
     /**
      * Hit decorators to apply to the search results.
      */

package/dist/preact/src/actions/newSearch.d.ts

@@ -1,4 +1,4 @@
-import { Options as SearchConfig } from '../../../core/src/types';
+import { SearchOptions } from '../../../core/src/types';
 import { SearchQuery } from '@nosto/nosto-js/client';
 import { ActionContext } from './types';
-export declare function newSearch(context: ActionContext, query: SearchQuery, options?: SearchConfig): Promise<void>;
+export declare function newSearch(context: ActionContext, query: SearchQuery, options?: SearchOptions): Promise<void>;

package/dist/preact/src/actions/updateSearch.d.ts

@@ -1,4 +1,4 @@
-import { Options as SearchConfig } from '../../../core/src/types';
+import { SearchOptions } from '../../../core/src/types';
 import { SearchQuery } from '@nosto/nosto-js/client';
 import { ActionContext } from './types';
-export declare function updateSearch(context: ActionContext, query: SearchQuery, options?: SearchConfig): Promise<void>;
+export declare function updateSearch(context: ActionContext, query: SearchQuery, options?: SearchOptions): Promise<void>;

package/dist/preact/src/config/base/baseConfig.d.ts

@@ -1,4 +1,4 @@
-import { Options as SearchConfig } from '../../../../core/src/types';
+import { SearchOptions } from '../../../../core/src/types';
 import { SearchQuery } from '@nosto/nosto-js/client';
 import { PageType } from '../../api/types';
 export declare const defaultBaseConfig: {
@@ -13,7 +13,7 @@ export interface BaseConfig {
     /**
      * Configuration for the search queries
      */
-    search?: SearchConfig;
+    search?: SearchOptions;
     /**
      * Custom function, when provided, can be used to modify search query before sending it to the server.
      * A default implementation is provided in the config that returns the query without any modification.

package/dist/preact/src/config/pages/autocomplete/config.d.ts

@@ -8,7 +8,7 @@ export interface AutocompleteConfig extends BaseConfig {
 }
 export type PublicAutocompleteConfig = Omit<AutocompleteConfig, keyof typeof defaultAutocompleteConfig | "pageType"> & Partial<Pick<AutocompleteConfig, keyof typeof defaultAutocompleteConfig>>;
 export declare function makeAutocompleteConfig(config: PublicAutocompleteConfig): {
-    search?: import('../../../../../core/src/types').Options | undefined;
+    search?: import('../../../../../core/src/types').SearchOptions | undefined;
     defaultCurrency: string;
     queryModifications: (query: import('@nosto/nosto-js/client').SearchQuery, pageType: import('../../../api/types').PageType | undefined) => import('@nosto/nosto-js/client').SearchQuery;
     pageType: "autocomplete";

package/dist/preact/src/config/pages/category/config.d.ts

@@ -33,7 +33,7 @@ export interface CategoryConfig extends BaseConfig {
 }
 export type PublicCategoryConfig = Omit<CategoryConfig, keyof typeof defaultCategoryConfig | "pageType"> & Partial<Pick<CategoryConfig, keyof typeof defaultCategoryConfig>>;
 export declare function makeCategoryConfig(config: PublicCategoryConfig): {
-    search?: import('../../../../../core/src/types').Options | undefined;
+    search?: import('../../../../../core/src/types').SearchOptions | undefined;
     categoryId: () => string;
     categoryPath: () => string;
     defaultCurrency: string;

package/dist/preact/src/config/pages/serp/config.d.ts

@@ -25,7 +25,7 @@ export interface SerpConfig extends BaseConfig {
 }
 export type PublicSerpConfig = Omit<SerpConfig, keyof typeof defaultSerpConfig | "pageType"> & Partial<Pick<SerpConfig, keyof typeof defaultSerpConfig>>;
 export declare function makeSerpConfig(config?: PublicSerpConfig): {
-    search?: import('../../../../../core/src/types').Options | undefined;
+    search?: import('../../../../../core/src/types').SearchOptions | undefined;
     defaultCurrency: string;
     queryModifications: (query: import('@nosto/nosto-js/client').SearchQuery, pageType: import('../../../api/types').PageType | undefined) => import('@nosto/nosto-js/client').SearchQuery;
     persistentSearchCache: boolean;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nosto/search-js",
-  "version": "2.0.0",
+  "version": "2.1.0",
   "license": "ISC",
   "type": "module",
   "files": [
@@ -84,13 +84,13 @@
     "prepare": "husky"
   },
   "devDependencies": {
-    "@nosto/nosto-js": "^1.7.0",
+    "@nosto/nosto-js": "^2.0.0",
     "@testing-library/dom": "^10.4.0",
     "@types/eslint-config-prettier": "^6.11.3",
     "@types/node": "^22.14.1",
     "concurrently": "^9.1.2",
     "copyfiles": "^2.4.1",
-    "eslint": "^9.24.0",
+    "eslint": "^9.25.0",
     "eslint-config-prettier": "^10.1.2",
     "eslint-plugin-barrel-files": "^3.0.1",
     "eslint-plugin-prettier": "^5.2.6",
@@ -102,12 +102,12 @@
     "isbot": "^5.1.26",
     "jsdom": "^26.1.0",
     "prettier": "^3.5.3",
-    "typedoc": "^0.28.2",
+    "typedoc": "^0.28.3",
     "typescript": "^5.8.3",
-    "typescript-eslint": "^8.30.0",
-    "vite": "^6.2.6",
+    "typescript-eslint": "^8.30.1",
+    "vite": "^6.3.2",
     "vite-plugin-dts": "^4.5.3",
-    "vitest": "^3.1.1",
+    "vitest": "^3.1.2",
     "@commitlint/cli": "^19.8.0",
     "@commitlint/config-conventional": "^19.8.0"
   },