@scayle/storefront-core 8.52.0 → 8.53.1

package/CHANGELOG.md

@@ -1,5 +1,27 @@
 # @scayle/storefront-core
 
+## 8.53.1
+
+### Patch Changes
+
+- Updated `fetchAllFiltersForCategory`, `getFilters`, `getProductsCount`, and `getProductsByCategory` RPC methods to support `includeSoldOut`, `includeSellableForFree`, and `orFiltersOperator` parameters. These parameters are now correctly passed to the Storefront API client, ensuring consistent filtering behavior.
+
+**Dependencies**
+
+- Updated dependency to @scayle/unstorage-scayle-kv-driver@2.0.9
+- Updated dependency to @scayle/storefront-api@18.18.1
+
+## 8.53.0
+
+### Minor Changes
+
+- Added support for promotions on order items by introducing the `OrderItemPromotion` interface and extending the `OrderItem` type with an optional `promotions` field.
+
+  This enables developers to access promotion information (`id`, `name`, and `version`) directly from order items, improving visibility into which promotions were applied to each item in an order.
+  Additionally, the `appliedReductions` array within the order item price now includes an optional `id` field, allowing for better tracking and identification of specific discount reductions.
+
+  For further details, see the [Order API](https://scayle.dev/en/api-guides/storefront-api/resources/orders).
+
 ## 8.52.0
 
 ### Minor Changes

package/dist/rpc/methods/checkout/checkout.mjs

@@ -37,7 +37,7 @@ export const getCheckoutToken = defineRpcHandler(async (jwtPayload = {}, context
       ...customData,
       ...orderCustomData
     }
-  }).setIssuedAt(now).setNotBefore(now).setExpirationTime("1h").setIssuer(`${"@scayle/storefront-core"}@${"8.52.0"}`).setProtectedHeader({ alg: "HS256", typ: "JWT" }).sign(secret);
+  }).setIssuedAt(now).setNotBefore(now).setExpirationTime("1h").setIssuer(`${"@scayle/storefront-core"}@${"8.53.1"}`).setProtectedHeader({ alg: "HS256", typ: "JWT" }).sign(secret);
   return {
     accessToken: refreshedAccessToken,
     checkoutJwt

package/dist/rpc/methods/products.d.ts

@@ -1,3 +1,4 @@
+import type { ProductsSearchEndpointParameters } from '@scayle/storefront-api';
 import type { FetchFiltersParams, FetchFiltersResponse, FetchProductParams, FetchProductsByCategoryParams, FetchProductsByCategoryResponse, FetchProductsByIdsParams, FetchProductsByReferenceKeysParams, FetchProductsCountParams, FetchProductsCountResponse, Product, RpcContext, RpcHandler } from '../../types';
 /**
  * Resolves the category ID from provided parameters.
@@ -106,6 +107,9 @@ export declare const getProductsCount: RpcHandler<FetchProductsCountParams, Fetc
  * @param params The parameters for fetching filters for a category.
  * @param params.includedFilters An array of filter slugs to include.
  * @param params.category Category data.
+ * @param params.includeSoldOut Whether to include sold out products.
+ * @param params.includeSellableForFree Whether to include products sellable for free.
+ * @param params.orFiltersOperator The operator for OR filters.
  * @param context The RPC context.
  *
  * @returns A Promise resolving to an array of filter slugs.
@@ -117,6 +121,9 @@ export declare const fetchAllFiltersForCategory: RpcHandler<{
     category: {
         id?: number;
     };
+    includeSoldOut?: boolean;
+    includeSellableForFree?: boolean;
+    orFiltersOperator?: ProductsSearchEndpointParameters['orFiltersOperator'];
 }, string[]>;
 /**
  * Retrieves filters and product count for a given category.

package/dist/rpc/methods/products.mjs

@@ -94,7 +94,10 @@ export const getProductsCount = async function getProductsCount2(params, context
     context,
     categoryId,
     attributes || [],
-    includedFilters
+    includedFilters,
+    includeSoldOut,
+    includeSellableForFree,
+    orFiltersOperator
   );
   if (response instanceof ErrorResponse) {
     return response;
@@ -124,14 +127,23 @@ export const getProductsCount = async function getProductsCount2(params, context
     count: productCount?.pagination.total
   };
 };
-export const fetchAllFiltersForCategory = async function fetchAllFiltersForCategory2({ includedFilters = [], category }, context) {
+export const fetchAllFiltersForCategory = async function fetchAllFiltersForCategory2({
+  includedFilters = [],
+  category,
+  includeSoldOut,
+  includeSellableForFree,
+  orFiltersOperator
+}, context) {
   const { cached, sapiClient } = context;
   const campaignKey = await context.callRpc?.("getCampaignKey");
   const fetchAndMapFiltersToSlugs = async () => {
     const filtersFromSAPI = await cached(sapiClient.filters.get)({
       where: { categoryId: category.id },
       campaignKey,
-      including: includedFilters
+      including: includedFilters,
+      includeSoldOut,
+      includeSellableForFree,
+      orFiltersOperator
     });
     return mapFiltersToSlugs(filtersFromSAPI);
   };
@@ -141,11 +153,14 @@ export const fetchAllFiltersForCategory = async function fetchAllFiltersForCateg
     cacheKey: `filters-for-category-${category.id}`
   })();
 };
-async function getSanitizedAttributes(context, categoryId, attributes, includedFilters) {
+async function getSanitizedAttributes(context, categoryId, attributes, includedFilters, includeSoldOut, includeSellableForFree, orFiltersOperator) {
   const response = await fetchAllFiltersForCategory(
     {
       category: { id: categoryId },
-      includedFilters
+      includedFilters,
+      includeSoldOut,
+      includeSellableForFree,
+      orFiltersOperator
     },
     context
   );
@@ -178,7 +193,10 @@ export const getFilters = async function getFilters2(params, context) {
     context,
     categoryId,
     attributes || [],
-    includedFilters
+    includedFilters,
+    includeSoldOut,
+    includeSellableForFree,
+    orFiltersOperator
   );
   if (response instanceof ErrorResponse) {
     return response;
@@ -254,7 +272,10 @@ export const getProductsByCategory = async function getProductsByCategory2(param
     context,
     categoryId,
     attributes || [],
-    includedFilters
+    includedFilters,
+    includeSoldOut,
+    includeSellableForFree,
+    orFiltersOperator
   );
   if (response instanceof ErrorResponse) {
     return response;

package/dist/types/sapi/order.d.ts

@@ -105,6 +105,11 @@ export type OrderStatus = 'order_open' | 'payment_pending' | 'payment_reserved'
 export type OrderStatusCode = 'order_created' | 'order_open' | 'order_pended' | 'order_confirmed' | 'order_delegated' | 'order_shipped' | 'order_invoiced' | 'order_aborted' | 'order_cancelled' | 'order_imported' | 'order_invoice_error';
 export type BillingStatusCode = 'billing_open' | 'billing_pending' | 'billing_payment_pending' | 'billing_completed' | 'billing_payment_cancelled' | 'billing_partially_refunded' | 'billing_refunded';
 export type ShippingStatusCode = 'shipping_open' | 'shipping_not_deliverable' | 'shipping_ordered' | 'shipping_delivered' | 'shipping_cancelled' | 'shipping_undeliverable' | 'shipping_returned' | 'shipping_partially_returned' | 'shipping_partially_undeliverable';
+export interface OrderItemPromotion {
+    id: string;
+    name: string;
+    version: string;
+}
 export interface OrderItem<Product = Record<string, unknown>, Variant = Record<string, unknown>> {
     id?: string;
     /**
@@ -175,6 +180,7 @@ export interface OrderItem<Product = Record<string, unknown>, Variant = Record<s
             category: 'sale' | 'campaign' | 'voucher' | 'promotion';
             code?: string;
             type: 'relative' | 'absolute';
+            id?: string;
         }[];
         overrideWithoutTax?: number;
         overrideWithTax?: number;
@@ -217,6 +223,10 @@ export interface OrderItem<Product = Record<string, unknown>, Variant = Record<s
     warehousePackageGroupId?: null | number;
     createdAt: string;
     updatedAt: string;
+    /**
+     * Promotions applied to the order item.
+     */
+    promotions?: OrderItemPromotion[];
 }
 export interface Order<Product = Record<string, unknown>, Variant = Record<string, unknown>> {
     /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@scayle/storefront-core",
-  "version": "8.52.0",
+  "version": "8.53.1",
   "description": "Collection of essential utilities to work with the Storefront API",
   "author": "SCAYLE Commerce Engine",
   "license": "MIT",
@@ -48,25 +48,25 @@
     "ufo": "^1.5.3",
     "uncrypto": "^0.1.3",
     "utility-types": "^3.11.0",
-    "@scayle/storefront-api": "18.18.1",
-    "@scayle/unstorage-scayle-kv-driver": "2.0.8"
+    "@scayle/unstorage-scayle-kv-driver": "2.0.9",
+    "@scayle/storefront-api": "18.18.1"
   },
   "devDependencies": {
     "@types/crypto-js": "4.2.2",
-    "@types/node": "22.19.0",
+    "@types/node": "22.19.1",
     "@types/webpack-env": "1.18.8",
-    "@vitest/coverage-v8": "3.2.4",
+    "@vitest/coverage-v8": "4.0.13",
     "dprint": "0.50.2",
     "eslint-formatter-gitlab": "6.0.1",
     "eslint": "9.39.1",
     "fishery": "2.3.1",
     "publint": "0.3.15",
-    "rimraf": "6.1.0",
+    "rimraf": "6.1.2",
     "typescript": "5.9.3",
     "unbuild": "3.6.1",
-    "unstorage": "1.17.2",
-    "vitest": "3.2.4",
-    "@scayle/eslint-config-storefront": "4.7.13",
+    "unstorage": "1.17.3",
+    "vitest": "4.0.13",
+    "@scayle/eslint-config-storefront": "4.7.14",
     "@scayle/vitest-config-storefront": "1.0.0"
   },
   "volta": {