@spiffcommerce/core 26.4.4 → 26.5.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.
 
+## [26.5.0] - 18-11-2024
+
+### Added
+
+-   ProductCollection has a new function `fetchProductsFeed`, which fetches a paginated array of product collection products (entries in the product collection). Note that this does not edit the internal array of previously fetched products like `fetchProducts` does, so calls to `fetchProductsFeed` will not change the array that is returned by `getProducts`. If `fetchProducts` has already been called, or if the ProductCollection has been initialised with products, `fetchProductsFeed` will avoid making any network calls where it can.
+
 ## [26.4.0] - 07-11-2024
 
 ### Added

package/dist/index.d.ts

@@ -1544,6 +1544,17 @@ declare class ProductCollection {
      * @param filters A list of filters to apply.
      */
     filterProducts(filters: ProductMetafieldFilter[]): 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 filters to apply to the query.
+     * @returns
+     */
+    fetchProductsFeed(offset: number, limit: number, filters?: ProductMetafieldFilter[]): Promise<{
+        items: CollectionProduct[];
+        total: number;
+    }>;
     getTransformCollection(): TransformCollection$1 | undefined;
     /**
      * The raw collection resource. This is generally not needed and should be avoided.
@@ -3954,6 +3965,7 @@ type ProductCollectionResource = {
     id: string;
     globalPropertyConfiguration?: GlobalPropertyConfiguration;
     productCollectionProducts?: ProductCollectionProductResource[];
+    productCollectionProductsFeed?: ProductCollectionProductsFeedResource;
     name: string;
     description?: string;
     image?: Asset;
@@ -3967,6 +3979,10 @@ type ProductCollectionProductResource = {
     productId: string;
     workflowId?: string;
 };
+type ProductCollectionProductsFeedResource = {
+    items: ProductCollectionProductResource[];
+    total: number;
+};
 type GlobalPropertyState = {
     id: string;
     aspects: GlobalPropertyStateAspect[];