@nosto/search-js 0.1.0

package/LICENSE

@@ -0,0 +1,29 @@
+BSD 3-Clause License
+
+Copyright (c) 2025, Nosto
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+
+* Neither the name of the copyright holder nor the names of its
+  contributors may be used to endorse or promote products derived from
+  this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

package/README.md

@@ -0,0 +1,48 @@
+# 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
+
+## Installation
+
+To install the package, use your preferred package manager:
+
+```bash
+yarn add @nosto/search-js
+# or
+npm install @nosto/search-js --save
+```
+
+## Nosto stub
+
+When using this library, it is not necessary to create the Nosto stub. It will be created automatically as soon as the library is imported for the first time.
+
+## Usage
+
+The main export of this library is the `search` function. It is compatible with the search function of the Nosto JS API and adds a couple of additional options
+
+```ts
+import { search } from "@nosto/search-js"
+import { priceDecorator } from "@nosto/search-js/currencies"
+
+const response = await search({
+    query: 'my search',
+    products: { 
+        fields: [
+            "productId",
+            "name",
+            "price",
+            "listPrice",
+            "priceCurrencyCode"
+        ] 
+    }
+}, {
+    track: 'serp',
+    hitDecorators: [
+        priceDecorator()
+    ]
+})
+
+```

package/dist/currencies/getCurrencyFormatting.d.ts

@@ -0,0 +1,11 @@
+import { CurrencySettingsDTO } from "@nosto/nosto-js/client";
+type CurrencyFormats = Record<string, CurrencySettingsDTO>;
+export interface CurrencyConfig {
+    defaultCurrency: string;
+    defaultLocale: string;
+    currencySettings: CurrencyFormats;
+}
+export declare function getCurrencyFormatting(overrides?: Partial<CurrencyConfig>): {
+    formatCurrency: (value: number, currency?: string) => string;
+};
+export {};

package/dist/currencies/priceDecorator.d.ts

@@ -0,0 +1,14 @@
+import { SearchProduct, SearchProductSku } from "@nosto/nosto-js/client";
+import { CurrencyConfig } from "./getCurrencyFormatting";
+type FormattedPrices = {
+    priceText?: string;
+    listPriceText?: string;
+};
+/**
+ * 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 {};

package/dist/currencies.cjs.js

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const y=require("./index.es-D_7T9vdv.cjs"),g={defaultCurrency:"EUR",defaultLocale:"en-US",currencySettings:{}},p={EUR:"de-DE",GBP:"en-GB",USD:"en-US",AUD:"en-AU",CAD:"en-CA",INR:"en-IN",AFN:"en-IN",BDT:"en-IN",BTN:"en-IN",MMK:"en-IN",NPR:"en-IN",PKR:"en-IN"};function d(o={}){const u={...g,...o};o.currencySettings||y.s(c=>{u.currencySettings=c.internal.getSettings().currencySettings});function a(c,n){const{defaultCurrency:t,currencySettings:e,defaultLocale:i}=u,s=n??t,m=p[s]??i;if(s in e){const r=e[s],l=new Intl.NumberFormat(m,{useGrouping:!!r.groupingSeparator,minimumFractionDigits:r.decimalPlaces,maximumFractionDigits:r.decimalPlaces}).formatToParts(c).map(f=>f.type==="group"?r.groupingSeparator:f.type==="decimal"?r.decimalCharacter:f.value).join("");return r!=null&&r.currencyBeforeAmount?`${r.currencyToken}${l}`:`${l}${r==null?void 0:r.currencyToken}`}return new Intl.NumberFormat(m,{style:"currency",currency:s}).format(c)}return{formatCurrency:a}}function C(o){const{formatCurrency:u}=d(o);function a(n,t){const e={};return n.price!==void 0&&(e.priceText=u(n.price,t)),n.listPrice!==void 0&&(e.listPriceText=u(n.listPrice,t)),Object.assign({},n,e)}function c(n){return n.price!==void 0||n.listPrice!==void 0}return function(t){if(!c(t))return t;const e=a(t,t.priceCurrencyCode);return e.skus&&e.skus.some(c)&&(e.skus=e.skus.map(i=>c(i)?a(i,t.priceCurrencyCode):i)),e}}exports.getCurrencyFormatting=d;exports.priceDecorator=C;

package/dist/currencies.d.ts

@@ -0,0 +1,2 @@
+export { getCurrencyFormatting, type CurrencyConfig } from "./currencies/getCurrencyFormatting";
+export { priceDecorator } from "./currencies/priceDecorator";

package/dist/currencies.es.js

@@ -0,0 +1,68 @@
+import { s as d } from "./index.es-Bcd5IQh9.js";
+const y = {
+  defaultCurrency: "EUR",
+  defaultLocale: "en-US",
+  /** @hidden  */
+  currencySettings: {}
+}, p = {
+  EUR: "de-DE",
+  GBP: "en-GB",
+  USD: "en-US",
+  AUD: "en-AU",
+  CAD: "en-CA",
+  //India, Afghanistan, Bangladesh, Bhutan, Myanmar, Nepal, and Pakistan uses lakhs and crores notation
+  INR: "en-IN",
+  AFN: "en-IN",
+  BDT: "en-IN",
+  BTN: "en-IN",
+  MMK: "en-IN",
+  NPR: "en-IN",
+  PKR: "en-IN"
+};
+function g(o = {}) {
+  const u = {
+    ...y,
+    ...o
+  };
+  o.currencySettings || d((c) => {
+    u.currencySettings = c.internal.getSettings().currencySettings;
+  });
+  function a(c, n) {
+    const { defaultCurrency: t, currencySettings: e, defaultLocale: i } = u, s = n ?? t, m = p[s] ?? i;
+    if (s in e) {
+      const r = e[s], l = new Intl.NumberFormat(m, {
+        useGrouping: !!r.groupingSeparator,
+        minimumFractionDigits: r.decimalPlaces,
+        maximumFractionDigits: r.decimalPlaces
+      }).formatToParts(c).map((f) => f.type === "group" ? r.groupingSeparator : f.type === "decimal" ? r.decimalCharacter : f.value).join("");
+      return r != null && r.currencyBeforeAmount ? `${r.currencyToken}${l}` : `${l}${r == null ? void 0 : r.currencyToken}`;
+    }
+    return new Intl.NumberFormat(m, {
+      style: "currency",
+      currency: s
+    }).format(c);
+  }
+  return {
+    formatCurrency: a
+  };
+}
+function S(o) {
+  const { formatCurrency: u } = g(o);
+  function a(n, t) {
+    const e = {};
+    return n.price !== void 0 && (e.priceText = u(n.price, t)), n.listPrice !== void 0 && (e.listPriceText = u(n.listPrice, t)), Object.assign({}, n, e);
+  }
+  function c(n) {
+    return n.price !== void 0 || n.listPrice !== void 0;
+  }
+  return function(t) {
+    if (!c(t))
+      return t;
+    const e = a(t, t.priceCurrencyCode);
+    return e.skus && e.skus.some(c) && (e.skus = e.skus.map((i) => c(i) ? a(i, t.priceCurrencyCode) : i)), e;
+  };
+}
+export {
+  g as getCurrencyFormatting,
+  S as priceDecorator
+};

package/dist/index.cjs.js

@@ -0,0 +1 @@
+"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

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

package/dist/index.es-Bcd5IQh9.js

@@ -0,0 +1,20 @@
+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

@@ -0,0 +1 @@
+"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;

package/dist/index.es.js

@@ -0,0 +1,20 @@
+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
+};

package/dist/search.d.ts

@@ -0,0 +1,17 @@
+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;

package/dist/thumbnails/generateThumbnailUrl.d.ts

@@ -0,0 +1,8 @@
+import { ThumbnailSize } from "./types";
+type Props = {
+    size: ThumbnailSize;
+    productId: string;
+    hash: string;
+};
+export declare function generateThumbnailUrl({ size, productId, hash }: Props): string;
+export {};

package/dist/thumbnails/shopifyThumbnailDecorator.d.ts

@@ -0,0 +1,11 @@
+import { SearchProduct } from "@nosto/nosto-js/client";
+import { ShopifySize } from "./types";
+type Config = {
+    size: ShopifySize;
+};
+/**
+ * Replaces full size images with specified Shopify thumbnail size.
+ * 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

@@ -0,0 +1,10 @@
+import { SearchProduct } from "@nosto/nosto-js/client";
+import { ThumbnailSize } from "./types";
+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

@@ -0,0 +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)
+ */
+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)
+ */
+export type ShopifySize = "pico" | "icon" | "thumb" | "small" | "compact" | "medium" | "large" | "grande" | "original" | "master";

package/dist/thumbnails.cjs.js

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const c=require("./index.es-D_7T9vdv.cjs");function i({size:o,productId:n,hash:t}){const u=c.i();if(!u)throw new Error("Client script settings are not yet available");return`https://${u.thumbnailHost}/${u.account}/${o}/${n}/${t}/A`}function s({size:o}){function n(a,r){if(r)return i({size:o,productId:a,hash:r})}function t(a,r){if(r)return r.map(e=>({...e,imageUrl:n(a,e.imageHash)??e.imageUrl}))}function u(a,r,e){if(!e)return r;if(r)return e.map(l=>i({size:o,productId:a,hash:l}))}return function(r){const e=r.productId;return e?{...r,imageUrl:n(e,r.imageHash)??r.imageUrl,thumbUrl:n(e,r.thumbHash)??r.thumbUrl,skus:t(e,r.skus),alternateImageUrls:u(e,r.alternateImageUrls,r.alternateImageHashes)}:r}}const m=/cdn\.shopify\.com/;function f({size:o}){function n(r){return r?new URL(r).hostname.match(m):!1}function t(r){return r?n(r)?r.replace(/(\.jpg|\.png|\.jpeg|\.gif|\.webp)/,`_${o}$1`):r:""}function u(r){if(r)return r.map(e=>({...e,imageUrl:t(e.imageUrl)}))}function a(r){if(r)return r.map(e=>t(e))}return function(e){return n(e.imageUrl)?{...e,imageUrl:t(e.imageUrl),thumbUrl:t(e.thumbUrl),skus:u(e.skus),alternateImageUrls:a(e.alternateImageUrls)}:e}}exports.generateThumbnailUrl=i;exports.shopifyThumbnailDecorator=f;exports.thumbnailDecorator=s;

package/dist/thumbnails.d.ts

@@ -0,0 +1,4 @@
+export { generateThumbnailUrl } from "./thumbnails/generateThumbnailUrl";
+export { thumbnailDecorator } from "./thumbnails/thumbnailDecorator";
+export { shopifyThumbnailDecorator } from "./thumbnails/shopifyThumbnailDecorator";
+export type { ThumbnailSize, ShopifySize } from "./thumbnails/types";

package/dist/thumbnails.es.js

@@ -0,0 +1,80 @@
+import { i as m } from "./index.es-Bcd5IQh9.js";
+function i({ size: o, productId: n, hash: t }) {
+  const u = m();
+  if (!u)
+    throw new Error("Client script settings are not yet available");
+  return `https://${u.thumbnailHost}/${u.account}/${o}/${n}/${t}/A`;
+}
+function s({ size: o }) {
+  function n(a, r) {
+    if (r)
+      return i({
+        size: o,
+        productId: a,
+        hash: r
+      });
+  }
+  function t(a, r) {
+    if (r)
+      return r.map((e) => ({
+        ...e,
+        imageUrl: n(a, e.imageHash) ?? e.imageUrl
+      }));
+  }
+  function u(a, r, e) {
+    if (!e)
+      return r;
+    if (r)
+      return e.map(
+        (f) => i({
+          size: o,
+          productId: a,
+          hash: f
+        })
+      );
+  }
+  return function(r) {
+    const e = r.productId;
+    return e ? {
+      ...r,
+      imageUrl: n(e, r.imageHash) ?? r.imageUrl,
+      thumbUrl: n(e, r.thumbHash) ?? r.thumbUrl,
+      skus: t(e, r.skus),
+      alternateImageUrls: u(e, r.alternateImageUrls, r.alternateImageHashes)
+    } : r;
+  };
+}
+const l = /cdn\.shopify\.com/;
+function g({ size: o }) {
+  function n(r) {
+    return r ? new URL(r).hostname.match(l) : !1;
+  }
+  function t(r) {
+    return r ? n(r) ? r.replace(/(\.jpg|\.png|\.jpeg|\.gif|\.webp)/, `_${o}$1`) : r : "";
+  }
+  function u(r) {
+    if (r)
+      return r.map((e) => ({
+        ...e,
+        imageUrl: t(e.imageUrl)
+      }));
+  }
+  function a(r) {
+    if (r)
+      return r.map((e) => t(e));
+  }
+  return function(e) {
+    return n(e.imageUrl) ? {
+      ...e,
+      imageUrl: t(e.imageUrl),
+      thumbUrl: t(e.thumbUrl),
+      skus: u(e.skus),
+      alternateImageUrls: a(e.alternateImageUrls)
+    } : e;
+  };
+}
+export {
+  i as generateThumbnailUrl,
+  g as shopifyThumbnailDecorator,
+  s as thumbnailDecorator
+};

package/package.json

@@ -0,0 +1,65 @@
+{
+  "name": "@nosto/search-js",
+  "version": "0.1.0",
+  "license": "ISC",
+  "type": "module",
+  "files": [
+    "dist"
+  ],
+  "main": "./dist/index.cjs.js",
+  "module": "./dist/index.es.js",
+  "types": "./dist/index.d.ts",
+  "directories": {
+    "doc": "docs",
+    "test": "test"
+  },
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.es.js",
+      "require": "./dist/index.cjs.js"
+    },
+    "./currencies": {
+      "types": "./dist/currencies.d.ts",
+      "import": "./dist/currencies.es.js",
+      "require": "./dist/currencies.cjs.js"
+    },
+    "./thumbnails": {
+      "types": "./dist/thumbnails.d.ts",
+      "import": "./dist/thumbnails.es.js",
+      "require": "./dist/thumbnails.cjs.js"
+    }
+  },
+  "keywords": [],
+  "author": "Nosto",
+  "scripts": {
+    "dev": "vite",
+    "build": "tsc && vite build && npm run build-dts && npm run typedoc",
+    "build-dts": "tsc --noEmit false --emitDeclarationOnly",
+    "test": "vitest --run",
+    "lint": "eslint '{src,test}/**/*.ts'",
+    "preview": "vite preview",
+    "typedoc": "typedoc src/index.ts"
+  },
+  "devDependencies": {
+    "@nosto/nosto-js": "^1.4.4",
+    "@testing-library/dom": "^10.4.0",
+    "@types/eslint-config-prettier": "^6.11.3",
+    "@types/node": "^22.10.10",
+    "copyfiles": "^2.4.1",
+    "eslint": "^9.19.0",
+    "eslint-config-prettier": "^10.0.1",
+    "eslint-plugin-barrel-files": "^2.1.0",
+    "eslint-plugin-prettier": "^5.2.3",
+    "jsdom": "^26.0.0",
+    "prettier": "^3.3.3",
+    "typedoc": "^0.27.2",
+    "typescript": "^5.7.3",
+    "typescript-eslint": "^8.22.0",
+    "vite": "^6.0.11",
+    "vitest": "^3.0.4"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}