@scayle/storefront-core 8.41.4 → 8.42.0

package/CHANGELOG.md

@@ -1,5 +1,42 @@
 # @scayle/storefront-core
 
+## 8.42.0
+
+### Minor Changes
+
+- Added `promotions` field to `BasketItem` type to support multiple promotions per basket item.
+
+  The `promotions` field is an array of `BasketItemPromotion` objects.
+  With the introduction of the new `promotions` array field, the `promotion` field is now deprecated.
+
+  Before:
+
+  ```json
+  "promotion": {
+      "id": "123",
+      "name": "Promotion 1",
+      "isActive": true,
+  }
+  ```
+
+  After:
+
+  ```json
+  "promotions": [{
+      "id": "123",
+      "name": "Promotion 1",
+      "isActive": true,
+  }]
+  ```
+
+  For more details, see the [Storefront API documentation](https://scayle.dev/en/api-guides/storefront-api/resources/baskets/get-a-basket).
+
+### Patch Changes
+
+**Dependencies**
+
+- Updated dependency to @scayle/storefront-api@18.14.0
+
 ## 8.41.4
 
 ### Patch Changes

package/dist/index.d.ts

@@ -68,4 +68,4 @@ export type RpcMethodParameters<N extends RpcMethodName> = Parameters<RpcMethod<
  */
 export type RpcMethodReturnType<N extends RpcMethodName> = ReturnType<RpcMethod<N>>;
 export type RpcMethodCall = <N extends RpcMethodName, P extends RpcMethodParameters<N>, TResult extends Exclude<Awaited<RpcMethodReturnType<N>>, Response>>(...args: P extends RpcContext ? [N] : [N, P]) => Promise<TResult>;
-export { ExistingItemHandling, AddToBasketFailureKind, UpdateBasketItemFailureKind, AddToWishlistFailureKind, PromotionEffectType, FilterTypes, APISortOption, APISortOrder, type Pagination, type ProductSortConfig, type ShopCountryCustomData, } from '@scayle/storefront-api';
+export { ExistingItemHandling, AddToBasketFailureKind, UpdateBasketItemFailureKind, AddToWishlistFailureKind, PromotionEffectType, FilterTypes, APISortOption, APISortOrder, type Pagination, type ProductSortConfig, type ShopCountryCustomData, type BasketItemPromotion, } from '@scayle/storefront-api';

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

@@ -7,7 +7,8 @@ import { mergeBaskets as mergeBasketFunction } from '../../../utils/user';
  *
  * @param params The parameters for adding a single item to a basket.
  * @param params.variantId The ID of the variant to add.
- * @param params.promotionId The ID of the promotion.
+ * @param params.promotionId @deprecated - In a future release `promotionId` will be removed. Consider using {@link params.promotions} instead.
+ * @param params.promotions The promotions to add.
  * @param params.quantity The quantity of the item to add.
  * @param params.displayData Display data for the item.
  * @param params.customData Custom data for the item.

package/dist/rpc/methods/basket/basket.mjs

@@ -17,6 +17,7 @@ function getWithParams(params, context) {
 export const addItemToBasket = defineRpcHandler(async ({
   variantId,
   promotionId,
+  promotions,
   quantity,
   displayData,
   customData,
@@ -46,6 +47,7 @@ export const addItemToBasket = defineRpcHandler(async ({
         quantity,
         params: {
           promotionId: promotionId ?? void 0,
+          promotions: promotions ?? void 0,
           campaignKey,
           displayData,
           pricePromotionKey: resolvedWith?.pricePromotionKey || "",
@@ -101,6 +103,7 @@ export const addItemsToBasket = defineRpcHandler(async (params, context) => {
     quantity: item.quantity,
     params: {
       promotionId: item.promotionId ?? void 0,
+      promotions: item.promotions ?? void 0,
       campaignKey,
       displayData: item.displayData,
       pricePromotionKey: resolvedWith?.pricePromotionKey || "",

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

@@ -33,7 +33,7 @@ export const getCheckoutToken = defineRpcHandler(async (jwtPayload = {}, context
     carrier,
     basketId: context.basketKey,
     campaignKey
-  }).setIssuedAt(now).setNotBefore(now).setExpirationTime("1h").setIssuer(`${"@scayle/storefront-core"}@${"8.41.4"}`).setProtectedHeader({ alg: "HS256", typ: "JWT" }).sign(secret);
+  }).setIssuedAt(now).setNotBefore(now).setExpirationTime("1h").setIssuer(`${"@scayle/storefront-core"}@${"8.42.0"}`).setProtectedHeader({ alg: "HS256", typ: "JWT" }).sign(secret);
   return {
     accessToken: refreshedAccessToken,
     checkoutJwt

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

@@ -25,7 +25,14 @@ export interface AddOrUpdateItemType {
     itemGroup?: ItemGroup;
     /** If the product is not in the "catalog" anymore, keep it in the basket */
     includeItemsWithoutProductData?: boolean;
+    /**
+     * @deprecated - In a future release `promotionId` will be removed. Consider using {@link promotions} instead.
+     */
     promotionId?: string | null;
+    promotions?: {
+        id: string;
+        code?: string | null;
+    }[];
 }
 /**
  * Options for fetching a basket, extending the base `BasketWith` type.

package/dist/utils/user.mjs

@@ -17,7 +17,7 @@ export const mergeBaskets = async (fromBasketKey, toBasketKey, withOptions, cont
       variantId: item.variant.id,
       quantity: item.quantity,
       params: {
-        promotionId: item.promotionId,
+        promotions: item.promotions,
         customData: item.customData,
         displayData: item.displayData,
         itemGroup: item.itemGroup,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@scayle/storefront-core",
-  "version": "8.41.4",
+  "version": "8.42.0",
   "description": "Collection of essential utilities to work with the Storefront API",
   "author": "SCAYLE Commerce Engine",
   "license": "MIT",
@@ -56,7 +56,7 @@
     "ufo": "^1.5.3",
     "uncrypto": "^0.1.3",
     "utility-types": "^3.11.0",
-    "@scayle/storefront-api": "18.13.1",
+    "@scayle/storefront-api": "18.14.0",
     "@scayle/unstorage-scayle-kv-driver": "1.1.0"
   },
   "devDependencies": {
@@ -74,8 +74,8 @@
     "unbuild": "3.6.1",
     "unstorage": "1.17.0",
     "vitest": "3.2.4",
-    "@scayle/eslint-config-storefront": "4.7.6",
-    "@scayle/vitest-config-storefront": "1.0.0"
+    "@scayle/vitest-config-storefront": "1.0.0",
+    "@scayle/eslint-config-storefront": "4.7.6"
   },
   "volta": {
     "node": "22.18.0"