@nosto/search-js 3.21.1 → 3.21.2

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

@@ -8,5 +8,22 @@ export type SearchHitWithSku = SearchHit & {
  * @param type - The type of search that the hit belongs to.
  * @param hit - The search hit to add to the cart.
  * @param quantity - The quantity of the hit to add to the cart.
+ *
+ * @example
+ * ```ts
+ * import { addToCart } from '@nosto/search-js'
+ *
+ * // Add a single product to cart
+ * await addToCart('serp', {
+ *   productId: '123',
+ *   skuId: 'sku-123'
+ * })
+ *
+ * // Add multiple quantities
+ * await addToCart('serp', {
+ *   productId: '456',
+ *   skuId: 'sku-456'
+ * }, 3)
+ * ```
  */
 export declare function addToCart(type: SearchTrackOptions, hit: SearchHitWithSku, quantity?: number): Promise<void>;

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

@@ -6,5 +6,33 @@ import { DecoratedResult, HitDecorator, SearchOptions } from './types';
  * @param query - The search query to be executed.
  * @param options - An object containing optional parameters for the search.
  * @returns A promise that resolves to the search result.
+ *
+ * @example
+ * ```ts
+ * import { search } from '@nosto/search-js'
+ * import { priceDecorator } from '@nosto/search-js/currencies'
+ *
+ * // Basic search
+ * const results = await search({ query: 'shoes' })
+ *
+ * // Search with decorators
+ * const decoratedResults = await search(
+ *   { query: 'shoes' },
+ *   { hitDecorators: [priceDecorator()] }
+ * )
+ * ```
+ *
+ * @example
+ * ```ts
+ * import { search } from '@nosto/search-js'
+ *
+ * // Search with filters
+ * const results = await search({
+ *   query: 'shoes',
+ *   filters: {
+ *     color: ['red', 'blue']
+ *   }
+ * })
+ * ```
  */
 export declare function search<HD extends readonly HitDecorator[]>(query: SearchQuery, options?: SearchOptions<HD>): Promise<DecoratedResult<HD>>;

package/dist/currencies/src/getCurrencyFormatting.d.ts

@@ -5,6 +5,43 @@ export interface CurrencyConfig {
     defaultLocale: string;
     currencySettings: CurrencyFormats;
 }
+/**
+ * Creates a currency formatting function with customizable settings.
+ *
+ * @param overrides - Optional configuration to override default currency settings.
+ * @returns An object containing the formatCurrency function.
+ *
+ * @example
+ * ```ts
+ * import { getCurrencyFormatting } from '@nosto/search-js/currencies'
+ *
+ * // Use default settings from Nosto
+ * const { formatCurrency } = getCurrencyFormatting()
+ * console.log(formatCurrency(1234.56)) // Uses default currency
+ * console.log(formatCurrency(1234.56, 'USD')) // "$1,234.56"
+ * ```
+ *
+ * @example
+ * ```ts
+ * import { getCurrencyFormatting } from '@nosto/search-js/currencies'
+ *
+ * // Override with custom settings
+ * const { formatCurrency } = getCurrencyFormatting({
+ *   defaultCurrency: 'EUR',
+ *   defaultLocale: 'de-DE',
+ *   currencySettings: {
+ *     EUR: {
+ *       currencyBeforeAmount: false,
+ *       currencyToken: '€',
+ *       decimalCharacter: ',',
+ *       groupingSeparator: '.',
+ *       decimalPlaces: 2
+ *     }
+ *   }
+ * })
+ * console.log(formatCurrency(1234.56)) // "1.234,56€"
+ * ```
+ */
 export declare function getCurrencyFormatting(overrides?: Partial<CurrencyConfig>): {
     formatCurrency: (value: number, currency?: string) => string;
 };

package/dist/currencies/src/priceDecorator.d.ts

@@ -8,8 +8,49 @@ export type Result = SearchProduct & FormattedPrices & {
     skus?: (SearchProductSku & FormattedPrices)[];
 };
 /**
- * Exposes currency formatting logic as a SearchProduct decorator
- * Sets priceText and listPriceText fields on product and SKU level
- * Requires price, listPrice and priceCurrencyCode fields to be present
+ * Exposes currency formatting logic as a SearchProduct decorator.
+ * Sets priceText and listPriceText fields on product and SKU level.
+ * Requires price, listPrice and priceCurrencyCode fields to be present.
+ *
+ * @param config - Optional configuration to customize currency formatting.
+ * @returns A decorator function that adds formatted price text to search products.
+ *
+ * @example
+ * ```ts
+ * import { search } from '@nosto/search-js'
+ * import { priceDecorator } from '@nosto/search-js/currencies'
+ *
+ * // Use with default settings
+ * const results = await search(
+ *   { query: 'shoes' },
+ *   { hitDecorators: [priceDecorator()] }
+ * )
+ * console.log(results.products.hits[0].priceText) // "$99.99"
+ * ```
+ *
+ * @example
+ * ```ts
+ * import { search } from '@nosto/search-js'
+ * import { priceDecorator } from '@nosto/search-js/currencies'
+ *
+ * // Use with custom currency settings
+ * const customDecorator = priceDecorator({
+ *   defaultCurrency: 'EUR',
+ *   currencySettings: {
+ *     EUR: {
+ *       currencyBeforeAmount: true,
+ *       currencyToken: '€',
+ *       decimalCharacter: ',',
+ *       groupingSeparator: '.',
+ *       decimalPlaces: 2
+ *     }
+ *   }
+ * })
+ * const results = await search(
+ *   { query: 'shoes' },
+ *   { hitDecorators: [customDecorator] }
+ * )
+ * console.log(results.products.hits[0].priceText) // "€99,99"
+ * ```
  */
 export declare function priceDecorator(config?: Partial<CurrencyConfig>): (hit: SearchProduct) => Result;

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

@@ -31,13 +31,6 @@ type RangeProps = [number | undefined, number | undefined];
  * ```
  */
 export declare function useRange(id: string): {
-    readonly min: 0;
-    readonly max: 0;
-    readonly range: readonly [0, 0];
-    readonly active: false;
-    readonly toggleActive: () => void;
-    readonly updateRange: () => void;
-} | {
     /** Min value */
     min: number;
     /** Max value */

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

@@ -80,9 +80,9 @@ export declare function useRangeSelector(id: string, rangeSize: number): {
     /** Maximum value */
     max: number;
     /** Range value */
-    range: number[] | readonly [0, 0];
+    range: number[];
     /** Update range function */
-    updateRange: (([from, to]: [number | undefined, number | undefined]) => void) | (() => void);
+    updateRange: ([from, to]: [number | undefined, number | undefined]) => void;
     /** Ranges */
     ranges: {
         min: number;

package/dist/thumbnails/src/thumbnailDecorator.d.ts

@@ -5,5 +5,29 @@ export type Config = {
 /**
  * Replaces full size images with thumbnail sized versions.
  * Uses `shopifyThumbnailDecorator` and `nostoThumbnailDecorator` based on the platform.
+ *
+ * @param config - Configuration object specifying the desired thumbnail size.
+ * @returns A decorator function that transforms image URLs to thumbnail versions.
+ *
+ * @example
+ * ```ts
+ * import { search } from '@nosto/search-js'
+ * import { thumbnailDecorator } from '@nosto/search-js/thumbnails'
+ *
+ * // Use thumbnail decorator with search
+ * const results = await search(
+ *   { query: 'shoes' },
+ *   {
+ *     hitDecorators: [
+ *       thumbnailDecorator({ size: '200x200' })
+ *     ]
+ *   }
+ * )
+ * console.log(results.products.hits[0].thumb_url)
+ *
+ * // Available sizes: '100x100', '200x200', '400x400', '600x600', '800x800'
+ * const smallThumbs = thumbnailDecorator({ size: '100x100' })
+ * const largeThumbs = thumbnailDecorator({ size: '800x800' })
+ * ```
  */
 export declare function thumbnailDecorator({ size }: Config): (hit: import('@nosto/nosto-js/client').SearchProduct) => import('@nosto/nosto-js/client').SearchProduct;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nosto/search-js",
-  "version": "3.21.1",
+  "version": "3.21.2",
   "license": "ISC",
   "type": "module",
   "files": [