npm - shop-client - Versions diffs - 3.15.0 → 3.17.0 - Mend

shop-client 3.15.0 → 3.17.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (24) hide show

package/README.md +99 -7
package/dist/ai/enrich.d.ts +4 -1
package/dist/ai/enrich.mjs +2 -2
package/dist/{chunk-QCB3U4AO.mjs → chunk-242GBM2V.mjs} +136 -14
package/dist/chunk-3KRUT5BD.mjs +734 -0
package/dist/{chunk-2W623LCW.mjs → chunk-5TGMDRUF.mjs} +100 -50
package/dist/{chunk-D5MTUWFO.mjs → chunk-O77Z6OBJ.mjs} +21 -6
package/dist/{chunk-G7OCMGA6.mjs → chunk-SBHTEKLB.mjs} +3 -1
package/dist/{chunk-OA76XD32.mjs → chunk-YWAW6C74.mjs} +5 -5
package/dist/collections.d.ts +16 -2
package/dist/collections.mjs +2 -2
package/dist/index.d.ts +8 -4
package/dist/index.mjs +180 -79
package/dist/products.d.ts +63 -2
package/dist/products.mjs +2 -2
package/dist/store.d.ts +1 -1
package/dist/store.mjs +3 -3
package/dist/{types-BRXamZMS.d.ts → types-w9n4csBQ.d.ts} +27 -1
package/dist/utils/detect-country.d.ts +1 -1
package/dist/utils/detect-country.mjs +1 -1
package/dist/utils/func.d.ts +1 -1
package/dist/utils/rate-limit.mjs +1 -1
package/package.json +1 -1
package/dist/chunk-ESTBP7AD.mjs +0 -553

package/README.md CHANGED Viewed

@@ -359,7 +359,7 @@ Fetches all products from the store with automatic pagination handling.
 const allProducts = await shop.products.all();
 ```
-**Returns:** `Product[]` - Array of all products in the store
+**Returns:** `Product[] | null`
 #### `products.paginated(options)`
@@ -379,7 +379,7 @@ const products = await shop.products.paginated({
 - `limit` (number, optional): Products per page (default: 250, max: 250)
  - `currency` (CurrencyCode, optional): ISO 4217 code aligned with `Intl.NumberFormatOptions['currency']` (e.g., `"USD"`, `"EUR"`, `"JPY"`)
-**Returns:** `Product[]` - Array of products for the specified page
+**Returns:** `Product[] | null`
 #### `products.find(handle)`
@@ -397,7 +397,7 @@ const productEur = await shop.products.find("product-handle", { currency: "EUR"
  - `options` (object, optional): Additional options
    - `currency` (CurrencyCode, optional): ISO 4217 code aligned with `Intl.NumberFormatOptions['currency']`
-**Returns:** `Product | null` - Product object or null if not found
+**Returns:** `Product | null`
 #### `products.showcased()`
@@ -407,7 +407,25 @@ Fetches products featured on the store's homepage.
 const showcasedProducts = await shop.products.showcased();
 ```
-**Returns:** `Product[]` - Array of featured products
+**Returns:** `Product[]`
+#### `products.infoHtml(productHandle, content?)`
+Fetches the extracted HTML content from the product page. This is useful for getting the main product description and content directly from the page HTML.
+```typescript
+// Fetch from store
+const html = await shop.products.infoHtml("product-handle");
+// Use provided HTML
+const htmlFromContent = await shop.products.infoHtml("product-handle", "<html>...</html>");
+```
+**Parameters:**
+- `productHandle` (string): The product handle
+- `content` (string, optional): HTML content to extract from. If provided, skips fetching the product page.
+**Returns:** `Promise<string | null>` - Extracted HTML content or null if not found
 #### `products.filter()`
@@ -457,6 +475,8 @@ const results = await shop.products.predictiveSearch("dress", {
 - Extracts handles from Ajax results, fetches full products via `find`
 - Falls back to non-locale path when locale returns 404/417
+**Returns:** `Product[]`
 ### Recommendations
 #### `products.recommendations(productId, options?)`
@@ -475,6 +495,30 @@ const recos = await shop.products.recommendations(1234567890, {
 - Returns normalized `Product[]`
 - Locale-aware endpoint `/{locale}/recommendations/products.json`
+### Minimal Products
+Convenience methods for minimal product returns:
+```typescript
+// All products (minimal)
+const minimalAll = await shop.products.minimal.all();
+// Paginated (minimal)
+const minimalPage = await shop.products.minimal.paginated({ page: 1, limit: 25 });
+// Find one (minimal)
+const minimalOne = await shop.products.minimal.find("product-handle");
+// Showcased (minimal)
+const minimalShowcased = await shop.products.showcase.minimal();
+// Predictive search (minimal)
+const minimalSearch = await shop.products.minimal.predictiveSearch("dress", { limit: 10 });
+// Recommendations (minimal)
+const minimalRecos = await shop.products.minimal.recommendations(1234567890, { limit: 6 });
+```
 ### Collections
 #### `collections.all()`
@@ -540,7 +584,7 @@ const products = await shop.collections.products.all("collection-handle");
 **Parameters:**
 - `handle` (string): The collection handle
-**Returns:** `Product[] | null` - Array of products in the collection
+**Returns:** `Product[] | null`
 #### `collections.products.paginated(handle, options)`
@@ -561,13 +605,52 @@ const products = await shop.collections.products.paginated("collection-handle",
   - `limit` (number, optional): Products per page (default: 250)
   - `currency` (CurrencyCode, optional): ISO 4217 code aligned with `Intl.NumberFormatOptions['currency']`
-**Returns:** `Product[]` - Array of products for the specified page
+**Returns:** `Product[] | null`
+#### `collections.products.minimal.*`
+Convenience methods for minimal product returns from collections:
+```typescript
+// All products (minimal)
+const minimalCollectionAll = await shop.collections.products.minimal.all("collection-handle");
+// Paginated (minimal)
+const minimalCollectionPage = await shop.collections.products.minimal.paginated("collection-handle", {
+  page: 1,
+  limit: 25,
+});
+```
 #### Currency Override
 By default, pricing is formatted using the store’s detected currency.
 You can override the currency for product and collection queries by passing a `currency` option.
-This override updates `Product.currency` and `Product.localizedPricing.currency` (and related formatted strings) only.
+This override updates product pricing display fields only:
+- `Product.localizedPricing` formatted strings
+- `MinimalProduct.localizedPricing` formatted strings
+### Showcased Products
+#### `products.showcased()`
+Fetches products showcased on the store’s homepage as full products.
+```typescript
+const featuredProducts = await shop.products.showcased();
+```
+**Returns:** `Product[]`
+#### `products.showcase.minimal()`
+Fetches showcased products as minimal product items.
+```typescript
+const minimalFeatured = await shop.products.showcase.minimal();
+```
+**Returns:** `MinimalProduct[]`
 ```typescript
 // Products
@@ -739,6 +822,12 @@ const enrichedMarkdown = await shop.products.enriched('some-product-handle', {
 });
 // enrichedMarkdown?.enriched_content → markdown
+// Use provided content instead of fetching product page
+const enrichedFromContent = await shop.products.enriched('some-product-handle', {
+  outputFormat: 'markdown',
+  content: '<html>...</html>',
+});
 const enrichedJson = await shop.products.enriched('some-product-handle', {
   outputFormat: 'json',
 });
@@ -747,6 +836,7 @@ const enrichedJson = await shop.products.enriched('some-product-handle', {
 // Build prompts without calling the LLM (useful for debugging)
 const { system, user } = await shop.products.enrichedPrompts('some-product-handle', {
   outputFormat: 'markdown',
+  content: '<html>...</html>', // Optional content
 });
 ```
@@ -976,6 +1066,7 @@ type MetaTag =
 ```typescript
 async function searchProducts(shop: ShopClient, query: string) {
   const allProducts = await shop.products.all();
+  if (!allProducts) return [];
   return allProducts.filter(product =>
     product.title.toLowerCase().includes(query.toLowerCase()) ||
     product.tags.some(tag => tag.toLowerCase().includes(query.toLowerCase()))
@@ -988,6 +1079,7 @@ async function searchProducts(shop: ShopClient, query: string) {
 ```typescript
 async function monitorPrices(shop: ShopClient) {
   const products = await shop.products.all();
+  if (!products) return [];
   return products.map(product => ({
     handle: product.handle,
     title: product.title,

package/dist/ai/enrich.d.ts CHANGED Viewed

@@ -1,4 +1,4 @@
-import { O as OpenRouterConfig, k as ProductClassification, l as SEOContent, m as SystemUserPrompt, a as ShopifySingleProduct } from '../types-BRXamZMS.js';
+import { O as OpenRouterConfig, l as ProductClassification, m as SEOContent, n as SystemUserPrompt, a as ShopifySingleProduct } from '../types-w9n4csBQ.js';
 declare function buildEnrichPrompt(args: {
     bodyInput: string;
@@ -11,10 +11,12 @@ declare function buildEnrichPromptForProduct(domain: string, handle: string, opt
     useGfm?: boolean;
     inputType?: "markdown" | "html";
     outputFormat?: "markdown" | "json";
+    htmlContent?: string;
 }): Promise<SystemUserPrompt>;
 declare function buildClassifyPromptForProduct(domain: string, handle: string, options?: {
     useGfm?: boolean;
     inputType?: "markdown" | "html";
+    htmlContent?: string;
 }): Promise<SystemUserPrompt>;
 interface EnrichedProductResult {
     bodyHtml: string;
@@ -63,6 +65,7 @@ declare function enrichProduct(domain: string, handle: string, options?: {
     model?: string;
     outputFormat?: "markdown" | "json";
     openRouter?: OpenRouterConfig;
+    htmlContent?: string;
 }): Promise<EnrichedProductResult>;
 /**
  * Classify product content into a three-tier hierarchy using LLM.

package/dist/ai/enrich.mjs CHANGED Viewed

@@ -13,8 +13,8 @@ import {
   htmlToMarkdown,
   mergeWithLLM,
   pruneBreakdownForSignals
-} from "../chunk-2W623LCW.mjs";
-import "../chunk-D5MTUWFO.mjs";
+} from "../chunk-5TGMDRUF.mjs";
+import "../chunk-O77Z6OBJ.mjs";
 export {
   buildClassifyPrompt,
   buildClassifyPromptForProduct,

package/dist/{chunk-QCB3U4AO.mjs → chunk-242GBM2V.mjs} RENAMED Viewed

@@ -1,6 +1,6 @@
 import {
   rateLimitedFetch
-} from "./chunk-D5MTUWFO.mjs";
+} from "./chunk-O77Z6OBJ.mjs";
 import {
   formatPrice
 } from "./chunk-U3RQRBXZ.mjs";
@@ -37,10 +37,25 @@ function createCollectionOperations(baseUrl, storeDomain, fetchCollections, coll
       }
     };
   }
+  function applyCurrencyOverrideMinimal(product, currency) {
+    var _a;
+    const compareAtPrice = (_a = product.compareAtPrice) != null ? _a : 0;
+    return {
+      ...product,
+      localizedPricing: {
+        priceFormatted: formatPrice(product.price, currency),
+        compareAtPriceFormatted: formatPrice(compareAtPrice, currency)
+      }
+    };
+  }
   function maybeOverrideProductsCurrency(products, currency) {
-    if (!products || !currency) return products;
+    if (!products || !currency || products.length === 0) return products;
     return products.map((p) => applyCurrencyOverride(p, currency));
   }
+  function maybeOverrideMinimalProductsCurrency(products, currency) {
+    if (!products || !currency || products.length === 0) return products;
+    return products.map((p) => applyCurrencyOverrideMinimal(p, currency));
+  }
   return {
     /**
      * Fetches collections with pagination support.
@@ -141,7 +156,7 @@ function createCollectionOperations(baseUrl, storeDomain, fetchCollections, coll
      * ```
      */
     find: async (collectionHandle) => {
-      var _a, _b;
+      var _a, _b, _c;
       if (!collectionHandle || typeof collectionHandle !== "string") {
         throw new Error("Collection handle is required and must be a string");
       }
@@ -174,17 +189,25 @@ function createCollectionOperations(baseUrl, storeDomain, fetchCollections, coll
             result.collection.handle,
             {
               limit: 1,
-              page: 1
+              page: 1,
+              minimal: true
             }
           )) == null ? void 0 : _a.at(0);
           const collectionProductImage = (_b = collectionProduct == null ? void 0 : collectionProduct.images) == null ? void 0 : _b[0];
           if (collectionProduct && collectionProductImage) {
-            collectionImage = {
-              id: collectionProductImage.id,
-              src: collectionProductImage.src,
-              alt: collectionProductImage.alt || collectionProduct.title,
-              created_at: collectionProductImage.createdAt || (/* @__PURE__ */ new Date()).toISOString()
-            };
+            const rec = collectionProductImage;
+            const src = typeof rec.src === "string" ? rec.src : String((_c = rec.src) != null ? _c : "");
+            if (src) {
+              const id = typeof rec.id === "number" ? rec.id : 0;
+              const alt = typeof rec.alt === "string" && rec.alt.trim() ? rec.alt : collectionProduct.title;
+              const createdAt = typeof rec.createdAt === "string" && rec.createdAt.trim() ? rec.createdAt : typeof rec.created_at === "string" && rec.created_at.trim() ? rec.created_at : (/* @__PURE__ */ new Date()).toISOString();
+              collectionImage = {
+                id,
+                src,
+                alt,
+                created_at: createdAt
+              };
+            }
           }
         }
         const collectionData = collectionsDto([
@@ -256,6 +279,7 @@ function createCollectionOperations(baseUrl, storeDomain, fetchCollections, coll
        * @param options - Pagination options
        * @param options.page - Page number (default: 1)
        * @param options.limit - Number of products per page (default: 250, max: 250)
+       * Use `shop.collections.products.minimal.paginated()` for MinimalProduct returns.
        *
        * @returns {Promise<Product[] | null>} Array of products from the collection or null if error occurs
        *
@@ -296,14 +320,22 @@ function createCollectionOperations(baseUrl, storeDomain, fetchCollections, coll
         }
         const products = await fetchPaginatedProductsFromCollection(
           sanitizedHandle,
-          { page, limit }
+          {
+            page,
+            limit,
+            minimal: false
+          }
+        );
+        return maybeOverrideProductsCurrency(
+          products,
+          options == null ? void 0 : options.currency
         );
-        return maybeOverrideProductsCurrency(products, options == null ? void 0 : options.currency);
       },
       /**
        * Fetches all products from a specific collection.
        *
        * @param collectionHandle - The collection handle to fetch products from
+       * Use `shop.collections.products.minimal.all()` for MinimalProduct returns.
        *
        * @returns {Promise<Product[] | null>} Array of all products from the collection or null if error occurs
        *
@@ -342,7 +374,8 @@ function createCollectionOperations(baseUrl, storeDomain, fetchCollections, coll
               sanitizedHandle,
               {
                 page: currentPage,
-                limit
+                limit,
+                minimal: false
               }
             );
             if (!products || products.length === 0 || products.length < limit) {
@@ -354,7 +387,10 @@ function createCollectionOperations(baseUrl, storeDomain, fetchCollections, coll
             allProducts.push(...products);
             currentPage++;
           }
-          return maybeOverrideProductsCurrency(allProducts, options == null ? void 0 : options.currency);
+          return maybeOverrideProductsCurrency(
+            allProducts,
+            options == null ? void 0 : options.currency
+          );
         } catch (error) {
           console.error(
             `Error fetching all products for collection ${sanitizedHandle}:`,
@@ -421,6 +457,92 @@ function createCollectionOperations(baseUrl, storeDomain, fetchCollections, coll
           );
           return null;
         }
+      },
+      minimal: {
+        paginated: async (collectionHandle, options) => {
+          var _a, _b;
+          if (!collectionHandle || typeof collectionHandle !== "string") {
+            throw new Error(
+              "Collection handle is required and must be a string"
+            );
+          }
+          const sanitizedHandle = collectionHandle.trim().replace(/[^a-zA-Z0-9\-_]/g, "");
+          if (!sanitizedHandle) {
+            throw new Error("Invalid collection handle format");
+          }
+          if (sanitizedHandle.length > 255) {
+            throw new Error("Collection handle is too long");
+          }
+          const page = (_a = options == null ? void 0 : options.page) != null ? _a : 1;
+          const limit = (_b = options == null ? void 0 : options.limit) != null ? _b : 250;
+          if (page < 1 || limit < 1 || limit > 250) {
+            throw new Error(
+              "Invalid pagination parameters: page must be >= 1, limit must be between 1 and 250"
+            );
+          }
+          const products = await fetchPaginatedProductsFromCollection(
+            sanitizedHandle,
+            {
+              page,
+              limit,
+              minimal: true
+            }
+          );
+          const final = maybeOverrideMinimalProductsCurrency(
+            products,
+            options == null ? void 0 : options.currency
+          );
+          return final || null;
+        },
+        all: async (collectionHandle, options) => {
+          if (!collectionHandle || typeof collectionHandle !== "string") {
+            throw new Error(
+              "Collection handle is required and must be a string"
+            );
+          }
+          const sanitizedHandle = collectionHandle.trim().replace(/[^a-zA-Z0-9\-_]/g, "");
+          if (!sanitizedHandle) {
+            throw new Error("Invalid collection handle format");
+          }
+          if (sanitizedHandle.length > 255) {
+            throw new Error("Collection handle is too long");
+          }
+          try {
+            const limit = 250;
+            const allProducts = [];
+            let currentPage = 1;
+            while (true) {
+              const products = await fetchPaginatedProductsFromCollection(
+                sanitizedHandle,
+                {
+                  page: currentPage,
+                  limit,
+                  minimal: true
+                }
+              );
+              if (!products || products.length === 0 || products.length < limit) {
+                if (products && products.length > 0) {
+                  allProducts.push(...products);
+                }
+                break;
+              }
+              allProducts.push(...products);
+              currentPage++;
+            }
+            const final = maybeOverrideMinimalProductsCurrency(
+              allProducts,
+              options == null ? void 0 : options.currency
+            );
+            return final || null;
+          } catch (error) {
+            console.error(
+              `Error fetching all products for collection ${sanitizedHandle}:`,
+              baseUrl,
+              error
+            );
+            return null;
+          }
+        }
       }
     }
   };