@nosto/search-js 1.0.3 → 1.1.0

package/README.md

@@ -5,6 +5,12 @@ Search JS is a wrapper for the Nosto Search functionality with some extended fun
 * Nosto product thumbnails
 * Retry logic
 
+For @nosto/search-js specific API documentation, see [Our Typedoc](https://nosto.github.io/search-js/).
+
+For more information about Nosto platform, see [Our documentation](https://docs.nosto.com/techdocs).
+
+For sources, issues and contributions, see the [GitHub repository](https://github.com/Nosto/search-js).
+
 ## Installation
 
 To install the package, use your preferred package manager:

package/dist/currencies/priceDecorator.d.ts

@@ -1,14 +1,14 @@
 import { SearchProduct, SearchProductSku } from "@nosto/nosto-js/client";
 import { CurrencyConfig } from "./getCurrencyFormatting";
-type FormattedPrices = {
+export type FormattedPrices = {
     priceText?: string;
     listPriceText?: string;
 };
+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
  */
-export declare function priceDecorator(config?: Partial<CurrencyConfig>): (hit: SearchProduct) => SearchProduct & FormattedPrices & {
-    skus?: (SearchProductSku & FormattedPrices)[];
-};
-export {};
+export declare function priceDecorator(config?: Partial<CurrencyConfig>): (hit: SearchProduct) => Result;

package/dist/currencies.d.ts

@@ -1,2 +1,3 @@
+/** @module currencies */
 export { getCurrencyFormatting, type CurrencyConfig } from "./currencies/getCurrencyFormatting";
-export { priceDecorator } from "./currencies/priceDecorator";
+export { priceDecorator, type FormattedPrices, type Result } from "./currencies/priceDecorator";

package/dist/search/applyDecorators.d.ts

@@ -0,0 +1,21 @@
+import { SearchResult } from "@nosto/nosto-js/client";
+import { HitDecorator } from "./types";
+export declare function applyDecorators<HD extends HitDecorator[]>(response: SearchResult, decorators?: HD): {
+    products: {
+        hits: ((ReturnType<HD[number]> extends infer T ? T extends ReturnType<HD[number]> ? T extends any ? (x: T) => void : never : never : never) extends (x: infer I) => void ? I : never)[];
+        categoryId?: string;
+        categoryPath?: string;
+        collapse?: string;
+        facets?: import("@nosto/nosto-js/client").SearchFacet[];
+        from?: number;
+        fuzzy?: boolean;
+        size?: number;
+        total: number;
+    };
+    autocorrect?: import("@nosto/nosto-js/client").SearchAutocorrect;
+    explain?: import("@nosto/nosto-js/client").SearchExplain;
+    keywords?: import("@nosto/nosto-js/client").SearchKeywords;
+    query?: string;
+    redirect?: string;
+    abTests?: import("@nosto/nosto-js/client").ABTest[];
+};

package/dist/search/search.d.ts

@@ -0,0 +1,28 @@
+import { SearchQuery } from "@nosto/nosto-js/client";
+import { HitDecorator, Options } from "./types";
+/**
+ * Performs a search operation using the provided query and options.
+ *
+ * @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.
+ */
+export declare function search<HD extends HitDecorator[]>(query: SearchQuery, options?: Options<HD>): Promise<{
+    products: {
+        hits: ((ReturnType<HD[number]> extends infer T ? T extends ReturnType<HD[number]> ? T extends any ? (x: T) => void : never : never : never) extends (x: infer I) => void ? I : never)[];
+        categoryId?: string;
+        categoryPath?: string;
+        collapse?: string;
+        facets?: import("@nosto/nosto-js/client").SearchFacet[];
+        from?: number;
+        fuzzy?: boolean;
+        size?: number;
+        total: number;
+    };
+    autocorrect?: import("@nosto/nosto-js/client").SearchAutocorrect;
+    explain?: import("@nosto/nosto-js/client").SearchExplain;
+    keywords?: import("@nosto/nosto-js/client").SearchKeywords;
+    query?: string;
+    redirect?: string;
+    abTests?: import("@nosto/nosto-js/client").ABTest[];
+}>;

package/dist/search/searchWithRetries.d.ts

@@ -0,0 +1,7 @@
+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>;
+/**
+ * Should the error trigger a search retry
+ */
+export declare function shouldRetry(error: unknown): error is object;

package/dist/search/types.d.ts

@@ -0,0 +1,24 @@
+import { SearchOptions, SearchProduct, SearchResult } from "@nosto/nosto-js/client";
+export type Options<HD extends HitDecorator[]> = SearchOptions & {
+    /**
+     * Hit decorators to apply to the search results.
+     */
+    hitDecorators?: HD;
+    /**
+     * Maximum number of retry attempts. Default: 0 (no retries).
+     */
+    maxRetries?: number;
+    /**
+     * Interval (in ms) between retry attempts. Default: 1000 ms.
+     */
+    retryInterval?: number;
+};
+export type HitDecorator = (hit: SearchProduct) => SearchProduct;
+type ToIntersection<U> = (U extends any ? (x: U) => void : never) extends (x: infer I) => void ? I : never;
+export type DecoratedProduct<HD extends HitDecorator[]> = ToIntersection<ReturnType<HD[number]>>;
+export type DecoratedResult<HD extends HitDecorator[]> = Omit<SearchResult, "products"> & {
+    products: SearchResult["products"] & {
+        hits: DecoratedProduct<HD>[];
+    };
+};
+export {};

package/dist/search/utils/delay.d.ts

@@ -0,0 +1 @@
+export declare function delay(ms: number): Promise<void>;

package/dist/search.cjs.js

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const s=require("./index.es-D_7T9vdv.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 l(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(!f(c))throw console.info("Skipping retry logic for",c),c;if(n>=i)throw c;n++,await o(u)}}function f(t){return!t||typeof t!="object"?!1:!("status"in t)||h(t.status)}function h(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 l(u,t,i);return a(n,r)}exports.search=y;

package/dist/search.d.ts

@@ -1,17 +1,3 @@
-import { SearchOptions, SearchProduct, SearchQuery, SearchResult } from "@nosto/nosto-js/client";
-export type Options = SearchOptions & {
-    /**
-     * Hit decorators to apply to the search results.
-     */
-    hitDecorators?: HitDecorator[];
-};
-/**
- * Performs a search operation using the provided query and options.
- *
- * @param query - The search query to be executed.
- * @param options - An object containing optional parameters for the search.
- * @param options.hitDecorators - An optional array of decorators to be applied to the search results.
- * @returns A promise that resolves to the search result.
- */
-export declare function search(query: SearchQuery, { hitDecorators, ...options }?: Options): Promise<SearchResult>;
-export type HitDecorator = (hit: SearchProduct) => SearchProduct;
+/** @module ./ */
+export { search } from "./search/search";
+export type { Options, HitDecorator } from "./search/types";

package/dist/search.es.js

@@ -0,0 +1,43 @@
+import { s as a } from "./index.es-Bcd5IQh9.js";
+function s(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(a), n = await f(u, t, i);
+  return s(n, e);
+}
+export {
+  p as search
+};

package/dist/thumbnails/generateThumbnailUrl.d.ts

@@ -1,8 +1,10 @@
 import { ThumbnailSize } from "./types";
-type Props = {
+export type Props = {
     size: ThumbnailSize;
     productId: string;
     hash: string;
 };
+/**
+ * Generates a thumbnail URL for a given product and size
+ */
 export declare function generateThumbnailUrl({ size, productId, hash }: Props): string;
-export {};

package/dist/thumbnails/shopifyThumbnailDecorator.d.ts

@@ -1,6 +1,6 @@
 import { SearchProduct } from "@nosto/nosto-js/client";
 import { ShopifySize } from "./types";
-type Config = {
+export type Config = {
     size: ShopifySize;
 };
 /**
@@ -8,4 +8,3 @@ type Config = {
  * This decorator will only affect the image URLs from Shopify CDN.
  */
 export declare function shopifyThumbnailDecorator({ size }: Config): (hit: SearchProduct) => SearchProduct;
-export {};

package/dist/thumbnails/thumbnailDecorator.d.ts

@@ -1,10 +1,9 @@
 import { SearchProduct } from "@nosto/nosto-js/client";
 import { ThumbnailSize } from "./types";
-type Config = {
+export type Config = {
     size: ThumbnailSize;
 };
 /**
  * Replaces full size images with thumbnail sized versions.
  */
 export declare function thumbnailDecorator({ size }: Config): (hit: SearchProduct) => SearchProduct;
-export {};

package/dist/thumbnails/types.d.ts

@@ -1,33 +1,33 @@
 /**
  * Nosto thumbnail size code.
  *
- * "1": 170x170 px
- * "2": 100x100 px
- * "3": 90x70 px
- * "4": 50x50 px
- * "5": 30x30 px
- * "6": 100x140 px
- * "7": 200x200 px
- * "8": 400x400 px
- * "9": 750x750 px
- * "10": Original (Square)
- * "11": 200x200 px (Square)
- * "12": 400x400 px (Square)
- * "13": 750x750 px (Square)
+ * * 1: 170x170 px
+ * * 2: 100x100 px
+ * * 3: 90x70 px
+ * * 4: 50x50 px
+ * * 5: 30x30 px
+ * * 6: 100x140 px
+ * * 7: 200x200 px
+ * * 8: 400x400 px
+ * * 9: 750x750 px
+ * * 10: Original (Square)
+ * * 11: 200x200 px (Square)
+ * * 12: 400x400 px (Square)
+ * * 13: 750x750 px (Square)
  */
 export type ThumbnailSize = "1" | "2" | "3" | "4" | "5" | "6" | "7" | "8" | "9" | "10" | "11" | "12" | "13" | "orig";
 /**
  * Shopify thumbnail size code.
  *
- * Pico (16×16 px)
- * Icon (32×32 px)
- * Thumb (50×50 px)
- * Small (100×100 px)
- * Compact (160×160 px)
- * Medium (240×240 px)
- * Large (480×480 px)
- * Grande (600×600 px)
- * Original (1024×1024 px)
- * Master (full size)
+ * * Pico (16×16 px)
+ * * Icon (32×32 px)
+ * * Thumb (50×50 px)
+ * * Small (100×100 px)
+ * * Compact (160×160 px)
+ * * Medium (240×240 px)
+ * * Large (480×480 px)
+ * * Grande (600×600 px)
+ * * Original (1024×1024 px)
+ * * Master (full size)
  */
 export type ShopifySize = "pico" | "icon" | "thumb" | "small" | "compact" | "medium" | "large" | "grande" | "original" | "master";

package/dist/thumbnails.d.ts

@@ -1,4 +1,5 @@
-export { generateThumbnailUrl } from "./thumbnails/generateThumbnailUrl";
-export { thumbnailDecorator } from "./thumbnails/thumbnailDecorator";
-export { shopifyThumbnailDecorator } from "./thumbnails/shopifyThumbnailDecorator";
+/** @module thumbnails */
+export { generateThumbnailUrl, type Props } from "./thumbnails/generateThumbnailUrl";
+export { thumbnailDecorator, type Config } from "./thumbnails/thumbnailDecorator";
+export { shopifyThumbnailDecorator, type Config as ShopifyConfig } from "./thumbnails/shopifyThumbnailDecorator";
 export type { ThumbnailSize, ShopifySize } from "./thumbnails/types";

package/package.json

@@ -1,23 +1,23 @@
 {
   "name": "@nosto/search-js",
-  "version": "1.0.3",
+  "version": "1.1.0",
   "license": "ISC",
   "type": "module",
   "files": [
     "dist"
   ],
-  "main": "./dist/index.cjs.js",
-  "module": "./dist/index.es.js",
-  "types": "./dist/index.d.ts",
+  "main": "./dist/search.cjs.js",
+  "module": "./dist/search.es.js",
+  "types": "./dist/search.d.ts",
   "directories": {
     "doc": "docs",
     "test": "test"
   },
   "exports": {
     ".": {
-      "types": "./dist/index.d.ts",
-      "import": "./dist/index.es.js",
-      "require": "./dist/index.cjs.js"
+      "types": "./dist/search.d.ts",
+      "import": "./dist/search.es.js",
+      "require": "./dist/search.cjs.js"
     },
     "./currencies": {
       "types": "./dist/currencies.d.ts",
@@ -39,7 +39,7 @@
     "test": "vitest --run",
     "lint": "eslint '{src,test}/**/*.ts'",
     "preview": "vite preview",
-    "typedoc": "typedoc src/index.ts"
+    "typedoc": "typedoc src/search.ts src/currencies.ts src/thumbnails.ts"
   },
   "devDependencies": {
     "@nosto/nosto-js": "^1.4.4",

package/dist/index.cjs.js

@@ -1 +0,0 @@
-"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const a=require("./index.es-D_7T9vdv.cjs");async function i(t,{hitDecorators:r,...u}={}){const c=await new Promise(a.s);return r!=null&&r.length?d(await c.search(t,u),r):await c.search(t,u)}function d(t,r){if(!t.products)return t;const u=c=>r.reduce((e,n)=>n(e),c);return{...t,products:{...t.products,hits:t.products.hits.map(u)}}}exports.search=i;

package/dist/index.d.ts

@@ -1 +0,0 @@
-export { search, type Options, type HitDecorator } from "./search";

package/dist/index.es.js

@@ -1,20 +0,0 @@
-import { s as d } from "./index.es-Bcd5IQh9.js";
-async function p(r, { hitDecorators: t, ...u } = {}) {
-  const a = await new Promise(d);
-  return t != null && t.length ? i(await a.search(r, u), t) : await a.search(r, u);
-}
-function i(r, t) {
-  if (!r.products)
-    return r;
-  const u = (a) => t.reduce((c, n) => n(c), a);
-  return {
-    ...r,
-    products: {
-      ...r.products,
-      hits: r.products.hits.map(u)
-    }
-  };
-}
-export {
-  p as search
-};