shop-client 3.11.0 → 3.13.0

package/README.md

@@ -1,4 +1,4 @@
-# Shop Search
+# Shop Client
 
 [![npm version](https://badge.fury.io/js/shop-client.svg)](https://badge.fury.io/js/shop-client)
 [![TypeScript](https://img.shields.io/badge/TypeScript-Ready-blue.svg)](https://www.typescriptlang.org/)
@@ -205,17 +205,8 @@ Notes:
 
 ### Migration: Barrel → Subpath Imports
 
-#### Package Rename: `shop-search` → `shop-client` (v3.8.2)
-- Install: `npm i shop-client` (replaces `shop-search`)
-- Update imports to `shop-client` (API unchanged)
-
 TypeScript:
 ```ts
-// Before (pre-rename: shop-search)
-import { Store } from 'shop-search';
-const store = new Store("your-store.myshopify.com");
-
-// After (post-rename: shop-client v3.8.2+)
 import { ShopClient } from 'shop-client';
 const client = new ShopClient("your-store.myshopify.com");
 ```
@@ -354,6 +345,8 @@ const storeInfo = await shop.getInfo();
 - `headerLinks`: Navigation menu links
 - `showcase`: Featured products and collections
 - `jsonLdData`: Structured data from the store
+- `country`: ISO 3166-1 alpha-2 code (e.g., `US`, `GB`)
+- `currency`: ISO 4217 currency code (e.g., `USD`, `EUR`)
 
 ### Products
 
@@ -444,6 +437,43 @@ Object.entries(filters || {}).forEach(([optionName, values]) => {
 - Handles products with multiple variant options
 - Returns empty object `{}` if no products have variants
 
+### Predictive Search
+
+#### `products.predictiveSearch(query, options?)`
+
+Locale-aware Shopify Ajax predictive search for products.
+
+```typescript
+const results = await shop.products.predictiveSearch("dress", {
+  limit: 10,           // clamps 1–10
+  locale: "en",        // defaults to "en"
+  // unavailableProducts defaults to "hide"
+  currency: "USD",     // optional override
+});
+```
+
+- Hides unavailable items by default
+- Extracts handles from Ajax results, fetches full products via `find`
+- Falls back to non-locale path when locale returns 404/417
+
+### Recommendations
+
+#### `products.recommendations(productId, options?)`
+
+Shopify Ajax product recommendations for a given product.
+
+```typescript
+const recos = await shop.products.recommendations(1234567890, {
+  limit: 6,                 // clamps 1–10 (default 10)
+  intent: "related",        // or "complementary" (default: related)
+  locale: "en",             // defaults to "en"
+  currency: "USD",          // optional override
+});
+```
+
+- Returns normalized `Product[]`
+- Locale-aware endpoint `/{locale}/recommendations/products.json`
+
 ### Collections
 
 #### `collections.all()`

package/dist/{chunk-EUAKMCAX.mjs → chunk-CUL7ZM2W.mjs}

@@ -192,7 +192,8 @@ async function getInfoForStore(args, options) {
       walletId: shopifyWalletId,
       subDomain: myShopifySubdomain != null ? myShopifySubdomain : null
     },
-    country: countryDetection.country
+    country: countryDetection.country,
+    currency: (countryDetection == null ? void 0 : countryDetection.currencyCode) || null
   };
   const currencyCode = countryDetection == null ? void 0 : countryDetection.currencyCode;
   return { info, currencyCode };
@@ -218,6 +219,7 @@ function createStoreOperations(context) {
      * - `jsonLdData` - Structured data from JSON-LD scripts
      * - `techProvider` - Shopify-specific information (walletId, subDomain)
      * - `country` - Country detection results with ISO 3166-1 alpha-2 codes (e.g., "US", "GB")
+     * - `currency` - ISO 4217 currency code inferred from store (e.g., "USD")
      *
      * @throws {Error} When the store URL is unreachable or returns an error
      *

package/dist/{chunk-CNJRHWIK.mjs → chunk-ZF4M6GMB.mjs}

@@ -450,6 +450,74 @@ function createProductOperations(baseUrl, storeDomain, fetchProducts, productsDt
         console.error("Failed to create product filters:", storeDomain, error);
         throw error;
       }
+    },
+    predictiveSearch: async (query, options) => {
+      var _a, _b, _c, _d, _e;
+      if (!query || typeof query !== "string") {
+        throw new Error("Query is required and must be a string");
+      }
+      const limit = Math.max(1, Math.min((_a = options == null ? void 0 : options.limit) != null ? _a : 10, 10));
+      const unavailable = (options == null ? void 0 : options.unavailableProducts) === "show" || (options == null ? void 0 : options.unavailableProducts) === "hide" ? options.unavailableProducts : "hide";
+      const localeValue = (options == null ? void 0 : options.locale) && options.locale.trim() || "en";
+      const localePrefix = `${localeValue.replace(/^\/|\/$/g, "")}/`;
+      const url = `${baseUrl}${localePrefix}search/suggest.json?q=${encodeURIComponent(query)}&resources[type]=product&resources[limit]=${limit}&resources[options][unavailable_products]=${unavailable}`;
+      const response = await rateLimitedFetch(url, {
+        rateLimitClass: "search:predictive",
+        timeoutMs: 7e3,
+        retry: { maxRetries: 2, baseDelayMs: 300 }
+      });
+      let resp = response;
+      if (!resp.ok && (resp.status === 404 || resp.status === 417)) {
+        const fallbackUrl = `${baseUrl}search/suggest.json?q=${encodeURIComponent(query)}&resources[type]=product&resources[limit]=${limit}&resources[options][unavailable_products]=${unavailable}`;
+        resp = await rateLimitedFetch(fallbackUrl, {
+          rateLimitClass: "search:predictive",
+          timeoutMs: 7e3,
+          retry: { maxRetries: 2, baseDelayMs: 300 }
+        });
+      }
+      if (!resp.ok) {
+        throw new Error(`HTTP ${resp.status}: ${resp.statusText}`);
+      }
+      const data = await resp.json();
+      const raw = (_d = (_c = (_b = data == null ? void 0 : data.resources) == null ? void 0 : _b.results) == null ? void 0 : _c.products) != null ? _d : [];
+      const handles = raw.filter((p) => {
+        var _a2;
+        return Boolean((_a2 = p == null ? void 0 : p.available) != null ? _a2 : true);
+      }).map((p) => {
+        var _a2;
+        return String((_a2 = p == null ? void 0 : p.handle) != null ? _a2 : "");
+      }).filter((h) => h.length > 0).slice(0, limit);
+      const fetched = await Promise.all(handles.map((h) => findProduct(h)));
+      const results = filter(fetched, isNonNullish);
+      const finalProducts = (_e = maybeOverrideProductsCurrency(results, options == null ? void 0 : options.currency)) != null ? _e : [];
+      return finalProducts;
+    },
+    recommendations: async (productId, options) => {
+      var _a, _b;
+      if (!Number.isFinite(productId) || productId <= 0) {
+        throw new Error("Valid productId is required");
+      }
+      const limit = Math.max(1, Math.min((_a = options == null ? void 0 : options.limit) != null ? _a : 10, 10));
+      const intent = (options == null ? void 0 : options.intent) === "complementary" ? "complementary" : "related";
+      const localeValue = (options == null ? void 0 : options.locale) && options.locale.trim() || "en";
+      const localePrefix = `${localeValue.replace(/^\/|\/$/g, "")}/`;
+      const url = `${baseUrl}${localePrefix}recommendations/products.json?product_id=${encodeURIComponent(String(productId))}&limit=${limit}&intent=${intent}`;
+      const resp = await rateLimitedFetch(url, {
+        rateLimitClass: "products:recommendations",
+        timeoutMs: 7e3,
+        retry: { maxRetries: 2, baseDelayMs: 300 }
+      });
+      if (!resp.ok) {
+        if (resp.status === 404) {
+          return [];
+        }
+        throw new Error(`HTTP ${resp.status}: ${resp.statusText}`);
+      }
+      const data = await resp.json();
+      const productsArray = Array.isArray(data) ? data : Array.isArray(data == null ? void 0 : data.products) ? data.products : [];
+      const normalized = productsDto(productsArray) || [];
+      const finalProducts = (_b = maybeOverrideProductsCurrency(normalized, options == null ? void 0 : options.currency)) != null ? _b : [];
+      return finalProducts;
     }
   };
   return operations;

package/dist/index.d.ts

@@ -132,6 +132,7 @@ declare class ShopClient {
      * - `jsonLdData` - Structured data from JSON-LD scripts
      * - `techProvider` - Shopify-specific information (walletId, subDomain)
      * - `country` - Country detection results with ISO 3166-1 alpha-2 codes (e.g., "US", "GB")
+     * - `currency` - ISO 4217 currency code inferred from store (e.g., "USD")
      *
      * @throws {Error} When the store URL is unreachable or returns an error
      *

package/dist/index.mjs

@@ -6,11 +6,11 @@ import {
 } from "./chunk-554O5ED6.mjs";
 import {
   createProductOperations
-} from "./chunk-CNJRHWIK.mjs";
+} from "./chunk-ZF4M6GMB.mjs";
 import {
   createStoreOperations,
   getInfoForStore
-} from "./chunk-EUAKMCAX.mjs";
+} from "./chunk-CUL7ZM2W.mjs";
 import {
   classifyProduct,
   determineStoreType,
@@ -656,6 +656,7 @@ var ShopClient = class {
    * - `jsonLdData` - Structured data from JSON-LD scripts
    * - `techProvider` - Shopify-specific information (walletId, subDomain)
    * - `country` - Country detection results with ISO 3166-1 alpha-2 codes (e.g., "US", "GB")
+   * - `currency` - ISO 4217 currency code inferred from store (e.g., "USD")
    *
    * @throws {Error} When the store URL is unreachable or returns an error
    *

package/dist/products.d.ts

@@ -55,6 +55,24 @@ interface ProductOperations {
      * Creates a filter map of variant options and their distinct values from all products.
      */
     filter(): Promise<Record<string, string[]> | null>;
+    /**
+     * Predictive product search using Shopify Ajax API.
+     */
+    predictiveSearch(query: string, options?: {
+        limit?: number;
+        locale?: string;
+        currency?: CurrencyCode;
+        unavailableProducts?: "show" | "hide" | "last";
+    }): Promise<Product[]>;
+    /**
+     * Product recommendations for a given product ID using Shopify Ajax API.
+     */
+    recommendations(productId: number, options?: {
+        limit?: number;
+        intent?: "related" | "complementary";
+        locale?: string;
+        currency?: CurrencyCode;
+    }): Promise<Product[] | null>;
 }
 /**
  * Creates product operations for a store instance

package/dist/products.mjs

@@ -1,6 +1,6 @@
 import {
   createProductOperations
-} from "./chunk-CNJRHWIK.mjs";
+} from "./chunk-ZF4M6GMB.mjs";
 import "./chunk-D5MTUWFO.mjs";
 import "./chunk-U3RQRBXZ.mjs";
 export {

package/dist/store.d.ts

@@ -1,4 +1,4 @@
-import { J as JsonLdEntry, d as CountryDetectionResult } from './types-luPg5O08.js';
+import { J as JsonLdEntry, d as CountryDetectionResult, f as CurrencyCode } from './types-luPg5O08.js';
 
 /**
  * Store operations interface for managing store-related functionality.
@@ -36,6 +36,7 @@ interface StoreInfo {
         subDomain: string | null;
     };
     country: CountryDetectionResult["country"];
+    currency: CurrencyCode | null;
 }
 /**
  * Creates store operations for a ShopClient instance.

package/dist/store.mjs

@@ -1,6 +1,6 @@
 import {
   createStoreOperations
-} from "./chunk-EUAKMCAX.mjs";
+} from "./chunk-CUL7ZM2W.mjs";
 import "./chunk-D5MTUWFO.mjs";
 import "./chunk-G7OCMGA6.mjs";
 import "./chunk-U3RQRBXZ.mjs";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "shop-client",
-  "version": "3.11.0",
+  "version": "3.13.0",
   "type": "module",
   "main": "./dist/index.mjs",
   "module": "./dist/index.mjs",