@commercengine/storefront-sdk 0.13.1 → 0.13.3

package/dist/index.mjs

@@ -1365,19 +1365,15 @@ var CatalogClient = class extends StorefrontAPIClient {
 	/**
 	* Search for products
 	*
-	* @param searchData - The search query and filters
+	* @param searchData - The search query, filters, sort, and pagination options
 	* @param headers - Optional header parameters (customer_group_id, etc.)
-	* @returns Promise with search results including products, facets, and pagination
+	* @returns Promise with search results including SKUs, facet distribution, facet stats, and pagination
 	*
 	* @example
 	* ```typescript
+	* // Basic search
 	* const { data, error } = await sdk.catalog.searchProducts({
 	*   query: "smartphone",
-	*   filters: {
-	*     category: ["electronics", "mobile"],
-	*     price_range: { min: 100, max: 1000 },
-	*     brand: ["Apple", "Samsung"] // facet names depend on product configuration
-	*   },
 	*   page: 1,
 	*   limit: 20
 	* });
@@ -1389,17 +1385,51 @@ var CatalogClient = class extends StorefrontAPIClient {
 	*
 	* console.log("Search results:", data.skus?.length || 0, "products found");
 	* console.log("Facet distribution:", data.facet_distribution);
-	* console.log("Price range:", data.facet_stats.price_range);
+	* console.log("Facet stats:", data.facet_stats);
+	* console.log("Pagination:", data.pagination);
 	*
 	* data.skus?.forEach(sku => {
 	*   console.log(`Found: ${sku.product_name} - ${sku.pricing?.selling_price}`);
 	* });
 	*
+	* // With filter (string expression — Meilisearch syntax)
+	* const { data: filtered, error: filteredError } = await sdk.catalog.searchProducts({
+	*   query: "laptop",
+	*   filter: "pricing.selling_price 500 TO 2000 AND product_type = physical",
+	*   sort: ["pricing.selling_price:asc"],
+	*   facets: ["product_type", "categories.name", "tags"],
+	*   page: 1,
+	*   limit: 10
+	* });
+	*
+	* // With filter (array of conditions — combined with AND)
+	* const { data: arrayFiltered, error: arrayError } = await sdk.catalog.searchProducts({
+	*   query: "shoes",
+	*   filter: ["product_type = physical", "rating >= 4", "stock_available > 0"],
+	*   sort: ["rating:desc"],
+	*   facets: ["*"],
+	*   page: 1,
+	*   limit: 25
+	* });
+	*
+	* // With filter (nested arrays — inner arrays use OR, outer uses AND)
+	* const { data: nestedFiltered, error: nestedError } = await sdk.catalog.searchProducts({
+	*   query: "headphones",
+	*   filter: [
+	*     "pricing.selling_price 50 TO 300",
+	*     ["product_type = physical", "product_type = bundle"]
+	*   ],
+	*   page: 1,
+	*   limit: 25
+	* });
+	*
 	* // Override customer group ID for this specific request
 	* const { data: overrideData, error: overrideError } = await sdk.catalog.searchProducts(
 	*   {
 	*     query: "laptop",
-	*     filters: { category: ["computers"] }
+	*     filter: "categories.name = computers",
+	*     page: 1,
+	*     limit: 20
 	*   },
 	*   {
 	*     "x-customer-group-id": "01H9XYZ12345USERID" // Override default SDK config