shop-client 3.16.0 → 3.18.0

package/dist/products.d.ts

@@ -1,5 +1,5 @@
 import { ShopInfo } from './store.js';
-import { f as CurrencyCode, P as Product, k as ProductClassification, l as SEOContent, S as ShopifyProduct, a as ShopifySingleProduct, O as OpenRouterConfig } from './types-BRXamZMS.js';
+import { f as CurrencyCode, P as Product, E as EnhancedProductResponse, l as ProductClassification, m as SEOContent, M as MinimalProduct, S as ShopifyProduct, a as ShopifySingleProduct, O as OpenRouterConfig } from './types-B4WDm14E.js';
 
 /**
  * Interface for product operations
@@ -7,12 +7,14 @@ import { f as CurrencyCode, P as Product, k as ProductClassification, l as SEOCo
 interface ProductOperations {
     /**
      * Fetches all products from the store across all pages.
+     * Use `shop.products.minimal.all()` for MinimalProduct returns.
      */
     all(options?: {
         currency?: CurrencyCode;
     }): Promise<Product[] | null>;
     /**
      * Fetches products with pagination support.
+     * Use `shop.products.minimal.paginated()` for MinimalProduct returns.
      */
     paginated(options?: {
         page?: number;
@@ -21,10 +23,23 @@ interface ProductOperations {
     }): Promise<Product[] | null>;
     /**
      * Finds a specific product by its handle.
+     * Use `shop.products.minimal.find()` for MinimalProduct returns.
      */
     find(productHandle: string, options?: {
         currency?: CurrencyCode;
     }): Promise<Product | null>;
+    /**
+     * Finds a product and enhances it with AI-generated content using an external service.
+     *
+     * @param productHandle - The handle of the product to find.
+     * @param options - Options for the request.
+     * @param options.apiKey - API key for the enhancement service.
+     * @param options.endpoint - Optional custom endpoint URL for the enhancement service. Defaults to the standard worker URL.
+     */
+    findEnhanced(productHandle: string, options?: {
+        apiKey?: string;
+        endpoint?: string;
+    }): Promise<EnhancedProductResponse | null>;
     /**
      * Finds a product by handle and enriches its content using LLM.
      * Requires an OpenRouter API key via options.apiKey or ShopClient options.
@@ -76,12 +91,22 @@ interface ProductOperations {
      * Fetches products that are showcased/featured on the store's homepage.
      */
     showcased(): Promise<Product[]>;
+    /**
+     * Showcase namespace for convenience methods related to featured items.
+     */
+    showcase: {
+        /**
+         * Returns showcased products in MinimalProduct form.
+         */
+        minimal(): Promise<MinimalProduct[]>;
+    };
     /**
      * 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.
+     * Use `shop.products.minimal.predictiveSearch()` for MinimalProduct returns.
      */
     predictiveSearch(query: string, options?: {
         limit?: number;
@@ -91,6 +116,7 @@ interface ProductOperations {
     }): Promise<Product[]>;
     /**
      * Product recommendations for a given product ID using Shopify Ajax API.
+     * Use `shop.products.minimal.recommendations()` for MinimalProduct returns.
      */
     recommendations(productId: number, options?: {
         limit?: number;
@@ -98,11 +124,48 @@ interface ProductOperations {
         locale?: string;
         currency?: CurrencyCode;
     }): Promise<Product[] | null>;
+    /**
+     * Minimal namespace for convenience methods that always return MinimalProduct types.
+     */
+    minimal: {
+        all(options?: {
+            currency?: CurrencyCode;
+        }): Promise<MinimalProduct[] | null>;
+        paginated(options?: {
+            page?: number;
+            limit?: number;
+            currency?: CurrencyCode;
+        }): Promise<MinimalProduct[] | null>;
+        find(productHandle: string, options?: {
+            currency?: CurrencyCode;
+        }): Promise<MinimalProduct | null>;
+        showcased(): Promise<MinimalProduct[]>;
+        predictiveSearch(query: string, options?: {
+            limit?: number;
+            locale?: string;
+            currency?: CurrencyCode;
+            unavailableProducts?: "show" | "hide" | "last";
+        }): Promise<MinimalProduct[]>;
+        recommendations(productId: number, options?: {
+            limit?: number;
+            intent?: "related" | "complementary";
+            locale?: string;
+            currency?: CurrencyCode;
+        }): Promise<MinimalProduct[] | null>;
+    };
 }
 /**
  * Creates product operations for a store instance
  */
-declare function createProductOperations(baseUrl: string, storeDomain: string, fetchProducts: (page: number, limit: number) => Promise<Product[] | null>, productsDto: (products: ShopifyProduct[]) => Product[] | null, productDto: (product: ShopifySingleProduct) => Product, getStoreInfo: () => Promise<ShopInfo>, findProduct: (handle: string) => Promise<Product | null>, ai?: {
+declare function createProductOperations(baseUrl: string, storeDomain: string, fetchProducts: (page: number, limit: number, options?: {
+    minimal?: boolean;
+}) => Promise<Product[] | MinimalProduct[] | null>, productsDto: (products: ShopifyProduct[], options?: {
+    minimal?: boolean;
+}) => Product[] | MinimalProduct[] | null, productDto: (product: ShopifySingleProduct, options?: {
+    minimal?: boolean;
+}) => Product | MinimalProduct, getStoreInfo: () => Promise<ShopInfo>, _findProduct: (handle: string, options?: {
+    minimal?: boolean;
+}) => Promise<Product | MinimalProduct | null>, ai?: {
     openRouter?: OpenRouterConfig;
 }): ProductOperations;
 

package/dist/products.mjs

@@ -1,7 +1,7 @@
 import {
   createProductOperations
-} from "./chunk-THCO3JT4.mjs";
-import "./chunk-D5MTUWFO.mjs";
+} from "./chunk-6XDBGOFZ.mjs";
+import "./chunk-O77Z6OBJ.mjs";
 import "./chunk-U3RQRBXZ.mjs";
 export {
   createProductOperations

package/dist/store.d.ts

@@ -1,4 +1,4 @@
-import { J as JsonLdEntry, d as CountryDetectionResult, f as CurrencyCode } from './types-BRXamZMS.js';
+import { J as JsonLdEntry, d as CountryDetectionResult, f as CurrencyCode } from './types-B4WDm14E.js';
 
 /**
  * Store operations interface for managing store-related functionality.

package/dist/store.mjs

@@ -1,8 +1,8 @@
 import {
   createShopOperations
-} from "./chunk-OA76XD32.mjs";
-import "./chunk-D5MTUWFO.mjs";
-import "./chunk-G7OCMGA6.mjs";
+} from "./chunk-YWAW6C74.mjs";
+import "./chunk-O77Z6OBJ.mjs";
+import "./chunk-SBHTEKLB.mjs";
 import "./chunk-U3RQRBXZ.mjs";
 export {
   createShopOperations

package/dist/{types-BRXamZMS.d.ts → types-B4WDm14E.d.ts}

@@ -116,6 +116,7 @@ type ShopifyProductVariant = ShopifyBaseVariant & {
     } | null;
     available: boolean;
     price: string | number;
+    grams?: number | undefined;
     weightInGrams?: number | undefined;
     compare_at_price?: string | number | undefined;
 };
@@ -321,6 +322,31 @@ type Product = {
     variantOptionsMap: Record<string, string>;
     enriched_content?: string;
 };
+/**
+ * Minimal product structure with reduced data.
+ */
+type MinimalProduct = {
+    title: string;
+    bodyHtml: string | null;
+    price: number;
+    compareAtPrice: number;
+    discount: number;
+    images: {
+        src: string;
+    }[];
+    featuredImage: string | null;
+    available: boolean;
+    localizedPricing: Pick<LocalizedPricing, "priceFormatted" | "compareAtPriceFormatted">;
+    options: {
+        key: string;
+        name: string;
+        values: string[];
+    }[];
+    variantOptionsMap: Record<string, string>;
+    url: string;
+    slug: string;
+    platformId: string;
+};
 /**
  * Shopify collection structure from API responses.
  */
@@ -409,6 +435,37 @@ type SEOContent = {
     tags: string[];
     marketingCopy: string;
 };
+type EnhancedProductImage = {
+    textContext: string;
+    url: string;
+    alt: string;
+};
+type EnhancedProductCanonical = {
+    title: string;
+    summary: string;
+    highlights: string[];
+    materials: unknown;
+    fit_and_size: unknown;
+    care: unknown;
+    what_makes_it_special: unknown;
+    missing_info: unknown[];
+    images: EnhancedProductImage[];
+};
+type EnhancedProductEnrichment = {
+    canonical: EnhancedProductCanonical;
+    markdown: string;
+};
+/**
+ * The response object from the enhanced product search.
+ */
+type EnhancedProductResponse = {
+    /** The original Shopify product data. */
+    shopify: ShopifyProduct;
+    /** The AI-enriched content. */
+    enrichment: EnhancedProductEnrichment;
+    /** Cache status of the response (e.g., 'hit', 'miss'). */
+    cache: string;
+};
 type StoreTypeBreakdown = Partial<Record<"adult_male" | "adult_female" | "kid_male" | "kid_female" | "generic", Partial<Record<"clothing" | "beauty" | "accessories" | "home-decor" | "food-and-beverages", string[]>>>>;
 
-export type { Collection as C, JsonLdEntry as J, LocalizedPricing as L, MetaTag as M, OpenRouterConfig as O, Product as P, ShopifyProduct as S, ShopifySingleProduct as a, ShopifyCollection as b, StoreTypeBreakdown as c, CountryDetectionResult as d, CountryScores as e, CurrencyCode as f, ProductImage as g, ProductOption as h, ProductVariant as i, ProductVariantImage as j, ProductClassification as k, SEOContent as l, SystemUserPrompt as m };
+export type { Collection as C, EnhancedProductResponse as E, JsonLdEntry as J, LocalizedPricing as L, MinimalProduct as M, OpenRouterConfig as O, Product as P, ShopifyProduct as S, ShopifySingleProduct as a, ShopifyCollection as b, StoreTypeBreakdown as c, CountryDetectionResult as d, CountryScores as e, CurrencyCode as f, MetaTag as g, ProductImage as h, ProductOption as i, ProductVariant as j, ProductVariantImage as k, ProductClassification as l, SEOContent as m, SystemUserPrompt as n };

package/dist/utils/detect-country.d.ts

@@ -1,4 +1,4 @@
-import { d as CountryDetectionResult } from '../types-BRXamZMS.js';
+import { d as CountryDetectionResult } from '../types-B4WDm14E.js';
 
 /**
  * Detects the country of a Shopify store by analyzing various signals in the HTML content.

package/dist/utils/detect-country.mjs

@@ -1,6 +1,6 @@
 import {
   detectShopCountry
-} from "../chunk-G7OCMGA6.mjs";
+} from "../chunk-SBHTEKLB.mjs";
 export {
   detectShopCountry
 };

package/dist/utils/func.d.ts

@@ -1,4 +1,4 @@
-import { f as CurrencyCode } from '../types-BRXamZMS.js';
+import { f as CurrencyCode } from '../types-B4WDm14E.js';
 
 declare function extractDomainWithoutSuffix(domain: string): string | null;
 declare function generateStoreSlug(domain: string): string;

package/dist/utils/rate-limit.mjs

@@ -2,7 +2,7 @@ import {
   configureRateLimit,
   getRateLimitStatus,
   rateLimitedFetch
-} from "../chunk-D5MTUWFO.mjs";
+} from "../chunk-O77Z6OBJ.mjs";
 export {
   configureRateLimit,
   getRateLimitStatus,

package/package.json

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