@scayle/storefront-core 8.40.0 → 8.41.1

package/CHANGELOG.md

@@ -1,5 +1,25 @@
 # @scayle/storefront-core
 
+## 8.41.1
+
+### Patch Changes
+
+- Improved logging around cache errors to provide more details.
+
+## 8.41.0
+
+### Minor Changes
+
+- Introduce a new `updatePromotions` RPC method to wrap the Storefront API "Bulk update promotions" endpoint.
+  This allows to update all promotions applied to basket's items in a single API call.
+  For more details, see the [Storefront API documentation](https://scayle.dev/en/api-guides/storefront-api/resources/baskets/bulk-update-promotions).
+
+### Patch Changes
+
+**Dependencies**
+
+- Updated dependency to @scayle/storefront-api@18.13.0
+
 ## 8.40.0
 
 ### Patch Changes

package/dist/cache/cached.d.ts

@@ -106,6 +106,7 @@ export declare class Cached {
      * Handles errors during cache operations.
      *
      * @param error The error that occurred.
+     * @param operation The operation which caused the error
      *
      * @private
      */

package/dist/cache/cached.mjs

@@ -24,7 +24,7 @@ export class Cached {
       throw new Error(CACHE_NOT_INITIALIZED_MSG);
     }
     this.cache = cache;
-    this.log = log.space("cached.init");
+    this.log = log.space("cached");
     this.prefix = prefix;
     this.enabled = enabled;
   }
@@ -57,7 +57,7 @@ export class Cached {
         }
       } catch (e) {
         if (e instanceof Error) {
-          this.handleError(e);
+          this.handleError(e, "getting");
         }
       }
       const response = await fn(...args);
@@ -71,7 +71,7 @@ export class Cached {
         await this.setCacheValue(cacheKey, response, options);
       } catch (e) {
         if (e instanceof Error) {
-          this.handleError(e);
+          this.handleError(e, "setting");
         }
       }
       return response;
@@ -136,13 +136,17 @@ export class Cached {
    * Handles errors during cache operations.
    *
    * @param error The error that occurred.
+   * @param operation The operation which caused the error
    *
    * @private
    */
-  handleError(error) {
+  handleError(error, operation) {
     if (error.message === "timeout") {
-      return this.log.error("Cache timeout");
+      return this.log.error(
+        `Cache timeout while ${operation} cache value`,
+        error
+      );
     }
-    this.log.error(error);
+    this.log.error(`Error while ${operation} cache value`, error);
   }
 }

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

@@ -1,5 +1,5 @@
 import { ExistingItemHandling } from '@scayle/storefront-api';
-import type { AddOrUpdateItemError, UpdateBasketItemQuantity, GetApplicablePromotionsByCodeParameters } from '@scayle/storefront-api';
+import type { AddOrUpdateItemError, UpdateBasketItemQuantity, GetApplicablePromotionsByCodeParameters, BulkUpdatePromotionsParameters } from '@scayle/storefront-api';
 import type { AddOrUpdateItemType, BasketResponseData, BasketWithOptions, Product, RpcHandler, Variant } from '../../../types';
 import { mergeBaskets as mergeBasketFunction } from '../../../utils/user';
 /**
@@ -165,3 +165,17 @@ export declare const updateBasketItem: RpcHandler<UpdateBasketItemRequestParamet
 export declare const getApplicablePromotionsByCode: RpcHandler<Omit<GetApplicablePromotionsByCodeParameters, 'basketKey'>, {
     basket: BasketResponseData<Product, Variant>;
 }>;
+/**
+ * Updates the promotions for a basket item.
+ *
+ * @param params The parameters for updating the promotions for a basket item.
+ * @param params.itemId The ID of the item to update.
+ * @param params.promotions The promotions to update.
+ * @param context The RPC context.
+ *
+ * @returns A promise that resolves with the updated basket.
+ * It will return an `ErrorResponse` if no session is found or update operation fails.
+ */
+export declare const updatePromotions: RpcHandler<Omit<BulkUpdatePromotionsParameters, 'basketKey'>, {
+    basket: BasketResponseData<Product, Variant>;
+}>;

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

@@ -305,6 +305,43 @@ export const getApplicablePromotionsByCode = defineRpcHandler(async ({ promotion
     return { basket: result.basket };
   }
 });
+export const updatePromotions = defineRpcHandler(async (params, context) => {
+  if (!hasSession(context)) {
+    return new ErrorResponse(
+      HttpStatusCode.BAD_REQUEST,
+      HttpStatusMessage.BAD_REQUEST,
+      "No Session found"
+    );
+  }
+  const { basketKey, sapiClient } = context;
+  const campaignKey = params.campaignKey ?? await context.callRpc?.("getCampaignKey");
+  const resolvedWith = getWithParams(
+    { with: params.with },
+    context
+  );
+  const result = await mapSAPIFetchErrorToResponse(
+    sapiClient.basket.bulkUpdatePromotions
+  )(
+    basketKey,
+    {
+      ...params,
+      campaignKey,
+      with: resolvedWith
+    }
+  );
+  if (result instanceof Response || result.type === "failure") {
+    context.log.info("Bulk updating promotions failed", {
+      basketKey,
+      items: params.items
+    });
+    return new ErrorResponse(
+      HttpStatusCode.BAD_REQUEST,
+      SAPI_ERROR_NAME,
+      "Bulk updating promotions failed"
+    );
+  }
+  return { basket: result.basket };
+});
 function parseBasketError(response) {
   const parsedError = {
     message: "",

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.40.0"}`).setProtectedHeader({ alg: "HS256", typ: "JWT" }).sign(secret);
+  }).setIssuedAt(now).setNotBefore(now).setExpirationTime("1h").setIssuer(`${"@scayle/storefront-core"}@${"8.41.1"}`).setProtectedHeader({ alg: "HS256", typ: "JWT" }).sign(secret);
   return {
     accessToken: refreshedAccessToken,
     checkoutJwt

package/dist/utils/sapi.d.ts

@@ -1,13 +1,13 @@
 /**
- * Wraps a SAPI API function, catching SAPI FetchErrors and converting them to a structured Response.
+ * Wraps a Storefront API client function, catching Storefront API FetchErrors and converting them to a structured Response.
  * This allows handling SAPI errors in a consistent way, returning a JSON response with status information.
  *
- * @template T The type of the SAPI API function.
+ * @template T The type of the Storefront API client function.
  *
- * @param func The SAPI API function to wrap.
+ * @param func The Storefront API client function to wrap.
  *
  * @returns A wrapped function that returns a Promise resolving to either the original function's result or a JSON Response representing the error.
  *
- * @throws Re-throws any error that is not an instance of FetchError.
+ * @throws Re-throws any error that is not an instance of StorefrontAPI FetchError.
  */
 export declare function mapSAPIFetchErrorToResponse<T extends (...args: any[]) => any>(func: T): (...args: Parameters<T>) => Promise<Awaited<ReturnType<T>> | Response>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@scayle/storefront-core",
-  "version": "8.40.0",
+  "version": "8.41.1",
   "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.12.0",
+    "@scayle/storefront-api": "18.13.0",
     "@scayle/unstorage-scayle-kv-driver": "1.0.3"
   },
   "devDependencies": {