@commercengine/storefront-sdk 0.13.2 → 0.13.4

package/dist/index.mjs

@@ -1121,7 +1121,7 @@ var CatalogClient = class extends StorefrontAPIClient {
 	/**
 	* Get details for a specific product
 	*
-	* @param pathParams - The path parameters (product ID or slug)
+	* @param pathParams - The path parameters. Accepts product ID or product slug.
 	* @param headers - Optional header parameters (customer_group_id, etc.)
 	* @returns Promise with product details
 	*
@@ -1129,7 +1129,7 @@ var CatalogClient = class extends StorefrontAPIClient {
 	* ```typescript
 	* // Get product by ID
 	* const { data, error } = await sdk.catalog.getProductDetail(
-	*   { product_id_or_slug: "prod_123" }
+	*   { product_id: "prod_123" }
 	* );
 	*
 	* if (error) {
@@ -1141,14 +1141,15 @@ var CatalogClient = class extends StorefrontAPIClient {
 	* console.log("Price:", data.product.pricing?.selling_price);
 	* console.log("Description:", data.product.short_description);
 	*
-	* // Get product by slug
+	* // Get product by slug (also accepted in place of product_id)
 	* const { data: slugData, error: slugError } = await sdk.catalog.getProductDetail({
-	*   product_id_or_slug: "detox-candy"
+	*   product_id: "detox-candy"
 	* });
 	*
 	* // Override customer group ID for this specific request
 	* const { data: overrideData, error: overrideError } = await sdk.catalog.getProductDetail(
-	*   { product_id_or_slug: "detox-candy" },
+	*   { product_id: "detox-candy" },
+	*   undefined,
 	*   {
 	*     "x-customer-group-id": "premium_customers" // Override default SDK config
 	*   }
@@ -1164,7 +1165,7 @@ var CatalogClient = class extends StorefrontAPIClient {
 	*/
 	async getProductDetail(pathParams, options, headers) {
 		const mergedHeaders = this.mergeHeaders(headers);
-		return this.executeRequest(() => this.client.GET("/catalog/products/{product_id_or_slug}", { params: {
+		return this.executeRequest(() => this.client.GET("/catalog/products/{product_id}", { params: {
 			path: pathParams,
 			query: options,
 			header: mergedHeaders
@@ -1173,12 +1174,13 @@ var CatalogClient = class extends StorefrontAPIClient {
 	/**
 	* List all variants for a specific product
 	*
-	* @param pathParams - The path parameters (product ID)
+	* @param pathParams - The path parameters. Accepts product ID or product slug.
 	* @param headers - Optional header parameters (customer_group_id, etc.)
 	* @returns Promise with product variants and pagination info
 	*
 	* @example
 	* ```typescript
+	* // By product ID
 	* const { data, error } = await sdk.catalog.listProductVariants(
 	*   { product_id: "prod_123" }
 	* );
@@ -1194,9 +1196,15 @@ var CatalogClient = class extends StorefrontAPIClient {
 	*   console.log(`Variant: ${variant.name} - SKU: ${variant.sku} - Price: ${variant.pricing?.selling_price}`);
 	* });
 	*
+	* // By product slug (also accepted in place of product_id)
+	* const { data: slugData, error: slugError } = await sdk.catalog.listProductVariants(
+	*   { product_id: "detox-candy" }
+	* );
+	*
 	* // Override customer group ID for this specific request
 	* const { data: overrideData, error: overrideError } = await sdk.catalog.listProductVariants(
 	*   { product_id: "prod_123" },
+	*   undefined,
 	*   {
 	*     "x-customer-group-id": "wholesale_customers" // Override default SDK config
 	*   }
@@ -1214,12 +1222,13 @@ var CatalogClient = class extends StorefrontAPIClient {
 	/**
 	* Get details for a specific product variant
 	*
-	* @param pathParams - The path parameters (product ID and variant ID)
+	* @param pathParams - The path parameters. Accepts product ID or slug for product_id, and variant ID or slug for variant_id.
 	* @param headers - Optional header parameters (customer_group_id, etc.)
 	* @returns Promise with variant details
 	*
 	* @example
 	* ```typescript
+	* // By product ID and variant ID
 	* const { data, error } = await sdk.catalog.getVariantDetail(
 	*   {
 	*     product_id: "prod_123",
@@ -1236,6 +1245,14 @@ var CatalogClient = class extends StorefrontAPIClient {
 	* console.log("SKU:", data.variant.sku);
 	* console.log("Price:", data.variant.pricing?.selling_price);
 	* console.log("Stock available:", data.variant.stock_available);
+	*
+	* // By product slug and variant slug (also accepted in place of IDs)
+	* const { data: slugData, error: slugError } = await sdk.catalog.getVariantDetail(
+	*   {
+	*     product_id: "detox-candy",
+	*     variant_id: "detox-candy-100g"
+	*   }
+	* );
 	* ```
 	*/
 	async getVariantDetail(pathParams, options, headers) {
@@ -1365,19 +1382,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 +1402,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