@commercengine/pos 0.4.1 → 0.4.3

package/dist/index.mjs

@@ -2001,16 +2001,12 @@ var PosClient = class extends PosAPIClient {
 	* Search products
 	* @param body - Search criteria and parameters
 	* @param headers - Optional header parameters
-	* @returns Promise with search results
+	* @returns Promise with search results including SKUs, facet distribution, facet stats, and pagination
 	* @example
 	* ```typescript
+	* // Basic search
 	* const { data, error } = await pos.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
 	* });
@@ -2020,17 +2016,52 @@ var PosClient = class extends PosAPIClient {
 	* } else {
 	*   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.name} - ${sku.price}`);
+	*     console.log(`Found: ${sku.product_name} - ${sku.pricing?.selling_price}`);
 	*   });
 	* }
 	*
+	* // With filter (string expression — Meilisearch syntax)
+	* const { data: filtered, error: filteredError } = await pos.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 pos.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 pos.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 pos.searchProducts(
 	*   {
 	*     query: "laptop",
-	*     filters: { category: ["computers"] }
+	*     filter: "categories.name = computers",
+	*     page: 1,
+	*     limit: 20
 	*   },
 	*   {
 	*     "x-customer-group-id": "01H9XYZ12345USERID" // Override default SDK config
@@ -2147,32 +2178,33 @@ var PosClient = class extends PosAPIClient {
 	}
 	/**
 	* Get product details
-	* @param pathParams - Product ID or slug
+	* @param pathParams - The path parameters. Accepts product ID or product slug.
 	* @param headers - Optional header parameters
 	* @returns Promise with product details
 	* @example
 	* ```typescript
 	* // Get product by ID
 	* const { data, error } = await pos.getProductDetail(
-	*   { product_id_or_slug: "prod_123" }
+	*   { product_id: "prod_123" }
 	* );
 	*
 	* if (error) {
 	*   console.error("Failed to get product details:", error.message);
 	* } else {
 	*   console.log("Product:", data.product.name);
-	*   console.log("Price:", data.product.price);
-	*   console.log("Description:", data.product.description);
+	*   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 pos.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 pos.getProductDetail(
-	*   { product_id_or_slug: "detox-candy" },
+	*   { product_id: "detox-candy" },
+	*   undefined,
 	*   {
 	*     "x-customer-group-id": "premium_customers" // Override default SDK config
 	*   }
@@ -2181,7 +2213,7 @@ var PosClient = class extends PosAPIClient {
 	*/
 	async getProductDetail(pathParams, query, headers) {
 		const mergedHeaders = this.mergeHeaders(headers);
-		return this.executeRequest(() => this.client.GET("/pos/catalog/products/{product_id_or_slug}", { params: {
+		return this.executeRequest(() => this.client.GET("/pos/catalog/products/{product_id}", { params: {
 			path: pathParams,
 			query,
 			header: mergedHeaders
@@ -2226,11 +2258,12 @@ var PosClient = class extends PosAPIClient {
 	}
 	/**
 	* List product variants
-	* @param pathParams - Product ID
+	* @param pathParams - The path parameters. Accepts product ID or product slug.
 	* @param headers - Optional header parameters
 	* @returns Promise with product variants
 	* @example
 	* ```typescript
+	* // By product ID
 	* const { data, error } = await pos.listProductVariants(
 	*   { product_id: "prod_123" }
 	* );
@@ -2240,13 +2273,19 @@ var PosClient = class extends PosAPIClient {
 	* } else {
 	*   console.log("Variants found:", data.variants?.length || 0);
 	*   data.variants?.forEach(variant => {
-	*     console.log(`Variant: ${variant.name} - SKU: ${variant.sku} - Price: ${variant.price}`);
+	*     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 pos.listProductVariants(
+	*   { product_id: "detox-candy" }
+	* );
+	*
 	* // Override customer group ID for this specific request
 	* const { data: overrideData, error: overrideError } = await pos.listProductVariants(
 	*   { product_id: "prod_123" },
+	*   undefined,
 	*   {
 	*     "x-customer-group-id": "wholesale_customers" // Override default SDK config
 	*   }
@@ -2263,11 +2302,12 @@ var PosClient = class extends PosAPIClient {
 	}
 	/**
 	* Get variant details
-	* @param pathParams - 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
 	* @returns Promise with variant details
 	* @example
 	* ```typescript
+	* // By product ID and variant ID
 	* const { data, error } = await pos.getVariantDetail(
 	*   {
 	*     product_id: "prod_123",
@@ -2280,16 +2320,25 @@ var PosClient = class extends PosAPIClient {
 	* } else {
 	*   console.log("Variant:", data.variant.name);
 	*   console.log("SKU:", data.variant.sku);
-	*   console.log("Price:", data.variant.price);
-	*   console.log("Stock:", data.variant.stock);
+	*   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 pos.getVariantDetail(
+	*   {
+	*     product_id: "detox-candy",
+	*     variant_id: "detox-candy-100g"
+	*   }
+	* );
+	*
 	* // Override customer group ID for this specific request
 	* const { data: overrideData, error: overrideError } = await pos.getVariantDetail(
 	*   {
 	*     product_id: "prod_123",
 	*     variant_id: "var_456"
 	*   },
+	*   undefined,
 	*   {
 	*     "x-customer-group-id": "wholesale_customers" // Override default SDK config
 	*   }