@spiffcommerce/core 31.2.4 → 31.3.0

package/CHANGELOG.md

@@ -14,6 +14,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - `Fixed` for any bug fixes.
 - `Security` in case of vulnerabilities.
 
+## [31.3.0] - 10-09-2025
+
+## Added
+
+- The function `ProductCollection.fetchProductsFeed` now supports an additional metafield filters parameter for filtering via attached workflows.
+
 ## [31.2.4] - 04-09-2025
 
 ## Fixed
@@ -24,7 +30,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## Added
 
-- The `collectionId`field will now be available on the complete event.
+- The `collectionId` field will now be available on the complete event.
 
 ## [31.2.2] - 01-09-2025
 

package/dist/index.d.ts

@@ -1570,7 +1570,7 @@ interface BundleOptions {
     readonly?: boolean;
 }
 
-interface ProductMetafieldFilter {
+interface MetafieldFilter {
     operator: "Equals" | "IsEmpty";
     invert?: boolean;
     metafieldConfigurationId: string;
@@ -1633,19 +1633,20 @@ declare class ProductCollection {
      * @param filters A list of metafield filters to apply.
      * @param tags An object of tag filters to apply.
      */
-    filterProducts(filters?: ProductMetafieldFilter[], tags?: ProductTagFilter, sortKey?: ProductCollectionProductSortKey, sortDescending?: boolean): Promise<CollectionProduct[]>;
+    filterProducts(filters?: MetafieldFilter[], tags?: ProductTagFilter, sortKey?: ProductCollectionProductSortKey, sortDescending?: boolean): Promise<CollectionProduct[]>;
     /**
      * Fetches a paginated feed of products.
      * @param offset The zero-based start index.
      * @param limit The maximum number of products to return.
-     * @param filters Optional metafield filters to apply to the query.
+     * @param productFilters Optional product metafields to filter the products by.
      * @param tags Optional object of tag filters to apply.
      * @param sortKey Optional field of the products to sort by.
      * @param sortDescending Optional boolean to indicate if the sort should be in descending order.
      * @param quickSearch Optional string to filter products by name.
+     * @param workflowFilters Optional workflow metafields to filter the products and their workflows by.
      * @returns
      */
-    fetchProductsFeed(offset: number, limit: number, filters?: ProductMetafieldFilter[], tags?: ProductTagFilter, sortKey?: ProductCollectionProductSortKey, sortDescending?: boolean, quickSearch?: string): Promise<{
+    fetchProductsFeed(offset: number, limit: number, productFilters?: MetafieldFilter[], tags?: ProductTagFilter, sortKey?: ProductCollectionProductSortKey, sortDescending?: boolean, quickSearch?: string, workflowFilters?: MetafieldFilter[]): Promise<{
         items: CollectionProduct[];
         total: number;
     }>;