@commercengine/storefront-sdk 0.13.2 → 0.13.3

package/dist/index.d.mts

@@ -4079,7 +4079,8 @@ interface components {
       backorder?: boolean;
       on_subscription: boolean;
       on_promotion: boolean;
-      category_ids: string[];
+      category_ids: string[]; /** @description Expanded category objects. */
+      categories?: components["schemas"]["Category"][];
       tags: string[] | null;
       reviews_count: number;
       reviews_rating_sum: number | null;
@@ -4475,12 +4476,20 @@ interface components {
      * @description Loyalty Point Activity
      */
     LoyaltyPointActivity: {
-      /** @enum {string} */activity_type?: "earned" | "redeemed"; /** @constant */
-      activity?: "order";
-      reference_number?: string;
+      /**
+       * @description The action that occurred.
+       * @enum {string}
+       */
+      action?: "add" | "remove";
+      /**
+       * @description The activity that occurred.
+       * @enum {string}
+       */
+      activity?: "order-placed" | "credit-note-issued" | "tier-upgrade" | "tier-downgrade" | "points-expired" | "points-carryforward" | "signup" | "bonus" | "other";
+      reference_number?: string | null;
       title?: string;
-      loyalty_point?: number;
-      remarks?: string; /** Format: date-time */
+      loyalty_points?: number;
+      remarks?: string | null; /** Format: date-time */
       created_at?: string; /** Format: date-time */
       modified_at?: string;
     }; /** ManualPaymentMethod */
@@ -5388,17 +5397,55 @@ interface components {
        * @description Maximum number of records returned for a page.
        * @default 25
        */
-      limit: number;
+      limit: number; /** @description provide list of attributes for specific facets or * for all facets. All attributes supported in the filter parameter are also supported here. */
+      facets?: string[];
       /**
-       * @description provide list of attributes for specific facets or * for all facets.
-       *     ```json
-       *     For specific facets: ["size", "color", "brand"]
-       *     ```
-       *     ```json
-       *     For all facets: ["*"]
-       *     ```
+       * @description Filter expression(s) to narrow results. Omit for no filtering.
+       *
+       *     **Syntax:** `attribute OPERATOR value`
+       *
+       *     **Operators:**
+       *
+       *     | Operator | Description | Example |
+       *     |---|---|---|
+       *     | `=` | Equal to | `product_type = physical` |
+       *     | `!=` | Not equal to | `product_type != bundle` |
+       *     | `>`, `>=`, `<`, `<=` | Comparison | `rating > 4` |
+       *     | `TO` | Inclusive range (`>=` AND `<=`) | `pricing.selling_price 100 TO 500` |
+       *     | `IN [...]` | Matches any value in the list | `product_type IN [physical,bundle]` |
+       *     | `NOT IN [...]` | Excludes all values in the list | `product_type NOT IN [physical,bundle]` |
+       *     | `EXISTS` | Attribute is present (even if `null` or empty) | `tags EXISTS` |
+       *     | `NOT EXISTS` | Attribute is absent | `tags NOT EXISTS` |
+       *     | `IS NULL` | Value is `null` | `variant_id IS NULL` |
+       *     | `IS NOT NULL` | Value is not `null` | `variant_id IS NOT NULL` |
+       *     | `IS EMPTY` | Value is `""`, `[]`, or `{}` | `tags IS EMPTY` |
+       *     | `IS NOT EMPTY` | Value is not empty | `tags IS NOT EMPTY` |
+       *     | `AND` | Both conditions must match | `rating > 4 AND product_type = physical` |
+       *     | `OR` | Either condition must match | `product_type = physical OR product_type = bundle` |
+       *     | `NOT` | Negates a condition | `NOT product_type = bundle` |
+       *
+       *     **Important rules:**
+       *     - Operators are **case-sensitive** — must be uppercase (`AND`, not `and`).
+       *     - String value comparison is **case-insensitive** — `product_type = Physical` matches `physical`.
+       *     - Operator precedence: `NOT` > `AND` > `OR`. Use parentheses to override.
+       *     - String values containing whitespace must be wrapped in single quotes.
+       *     - `IN` takes comma-separated values in square brackets.
+       *     - Maximum array nesting depth is **2 levels**.
+       *
+       *     **Supported attributes:** `product_type`, `categories.name`, `attributes.key`, `pricing.listing_price`, `pricing.selling_price`, `pricing.tax_rate`, `product_id`, `variant_id`, `product_name`, `variant_name`, `tags`, `sku`, `stock_available`, `rating`
+       *
+       *     **Combining conditions:**
+       *     - **String:** Use `AND`/`OR` operators inline — `"rating > 4 AND product_type = physical"`
+       *     - **Array of strings:** Conditions are combined with AND — `["rating > 4", "product_type = physical"]`
+       *     - **Nested arrays:** Inner arrays express OR, outer array expresses AND — `["product_type = physical", ["product_type = bundle", "rating > 4"]]`
        */
-      facets?: string[];
+      filter?: string | (string | string[])[];
+      /**
+       * @description Sort results by attributes. Use `asc` for ascending order and `desc` for descending order.
+       * @example product_type:desc
+       * @example product_name:asc
+       */
+      sort?: string[];
     }; /** SellerDetail */
     SellerDetail: components["schemas"]["SellerInfo"] & {
       description?: string;
@@ -8993,7 +9040,6 @@ interface operations {
             success?: boolean;
             content?: {
               loyalty?: components["schemas"]["CustomerLoyalty"];
-              loyalty_point_balance?: number;
             };
           };
         };
@@ -13434,19 +13480,15 @@ declare class CatalogClient 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
    * });
@@ -13458,17 +13500,51 @@ declare class CatalogClient 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

package/dist/index.iife.js

@@ -1745,19 +1745,15 @@ Object.defineProperties(exports, { __esModule: { value: true }, [Symbol.toString
 		/**
 		* 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
 		* });
@@ -1769,17 +1765,51 @@ Object.defineProperties(exports, { __esModule: { value: true }, [Symbol.toString
 		*
 		* 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