@scayle/storefront-core 8.2.2 → 8.3.0

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @scayle/storefront-core
 
+## 8.3.0
+
+### Minor Changes
+
+- [Basket] Add support to update existing basket items using the `updateBasketItem` RPC.
+
 ## 8.2.2
 
 ### Patch Changes

package/dist/rpc/methods/basket/basket.cjs

@@ -3,7 +3,7 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.removeItemFromBasket = exports.mergeBaskets = exports.getBasket = exports.clearBasket = exports.addItemsToBasket = exports.addItemToBasket = void 0;
+exports.updateBasketItem = exports.removeItemFromBasket = exports.mergeBaskets = exports.getBasket = exports.clearBasket = exports.addItemsToBasket = exports.addItemToBasket = void 0;
 var _errors = require("../../../errors/index.cjs");
 var _types = require("../../../types/index.cjs");
 var _constants = require("../../../constants/index.cjs");
@@ -215,6 +215,45 @@ const mergeBaskets = exports.mergeBaskets = async function mergeBaskets2({
     orderCustomData
   }, context);
 };
+const updateBasketItem = exports.updateBasketItem = async function updateBasketItem2({
+  basketItemKey,
+  update,
+  with: _with
+}, context) {
+  if (!(0, _types.hasSession)(context)) {
+    return new _errors.ErrorResponse(_constants.HttpStatusCode.BAD_REQUEST, _constants.HttpStatusMessage.BAD_REQUEST, "No Session found");
+  }
+  const {
+    basketKey,
+    sapiClient
+  } = context;
+  const resolvedWith = getWithParams({
+    with: _with
+  }, context);
+  const {
+    quantity,
+    ...updateParams
+  } = update;
+  const result = await sapiClient.basket.updateItem(basketKey, basketItemKey, quantity, {
+    ...updateParams,
+    with: resolvedWith
+  });
+  if (result.type === "success") {
+    return {
+      basket: result.basket
+    };
+  } else {
+    context.log.error("Updating basket item failed", {
+      kind: result.kind,
+      basketKey,
+      basketItemKey,
+      update
+    });
+    return new _errors.ErrorResponse(_constants.HttpStatusCode.BAD_REQUEST, SAPI_ERROR_NAME, "Updating basket item failed", {
+      failureKind: result.kind
+    });
+  }
+};
 function parseBasketError(response) {
   const parsedError = {
     message: "",

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

@@ -1,4 +1,4 @@
-import type { AddOrUpdateItemError } from '@scayle/storefront-api';
+import type { AddOrUpdateItemError, UpdateBasketItemQuantity } from '@scayle/storefront-api';
 import { ErrorResponse } from '../../../errors';
 import type { AddOrUpdateItemType, BasketResponseData, BasketWithOptions, Product, RpcContext, Variant } from '../../../types';
 import { ExistingItemHandling } from '../../../constants';
@@ -55,3 +55,31 @@ export declare const mergeBaskets: ({ fromBasketKey, toBasketKey, with: _with, o
     readonly basket: BasketResponseData<Product, Variant>;
     readonly errors: AddOrUpdateItemError[];
 } | undefined>;
+/**
+ * An object containing properties of a basket item than should be applied to the basket item during the update.
+ */
+export type BasketItemUpdateData = Partial<Omit<UpdateBasketItemQuantity, 'basketKey' | 'itemKey' | 'with' | 'quantity'>> & {
+    quantity: number;
+};
+export interface UpdateBasketItemRequestParameter {
+    /** key of the item to be updated. */
+    basketItemKey: string;
+    /** The update data that should be applied to the basket item- */
+    update: BasketItemUpdateData;
+    /** An object describing which data the returned basket should contain. */
+    with?: BasketWithOptions;
+}
+/**
+ * Applies the provided update data to a specific item in a basket.
+ *
+ * @param params - The request parameters.
+ * @param params.basketItemKey  - The key of the item to be updated.
+ * @param params.update - The update data that should be applied to the basket item.
+ * @param params.with - An object describing which data the returned basket should contain.
+ * @param context - The rpc context associated with the request.
+ *
+ * @returns A promise that resolves with the updated basket. In case of an error the, the failure kind will be resolved.
+ */
+export declare const updateBasketItem: ({ basketItemKey, update, with: _with }: UpdateBasketItemRequestParameter, context: RpcContext) => Promise<ErrorResponse | {
+    basket: BasketResponseData<Product, Variant>;
+}>;

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

@@ -223,6 +223,45 @@ export const mergeBaskets = async function mergeBaskets2({ fromBasketKey, toBask
     context
   );
 };
+export const updateBasketItem = async function updateBasketItem2({ basketItemKey, update, with: _with }, context) {
+  if (!hasSession(context)) {
+    return new ErrorResponse(
+      HttpStatusCode.BAD_REQUEST,
+      HttpStatusMessage.BAD_REQUEST,
+      "No Session found"
+    );
+  }
+  const { basketKey, sapiClient } = context;
+  const resolvedWith = getWithParams(
+    { with: _with },
+    context
+  );
+  const { quantity, ...updateParams } = update;
+  const result = await sapiClient.basket.updateItem(
+    basketKey,
+    basketItemKey,
+    quantity,
+    { ...updateParams, with: resolvedWith }
+  );
+  if (result.type === "success") {
+    return { basket: result.basket };
+  } else {
+    context.log.error("Updating basket item failed", {
+      kind: result.kind,
+      basketKey,
+      basketItemKey,
+      update
+    });
+    return new ErrorResponse(
+      HttpStatusCode.BAD_REQUEST,
+      SAPI_ERROR_NAME,
+      "Updating basket item failed",
+      {
+        failureKind: result.kind
+      }
+    );
+  }
+};
 function parseBasketError(response) {
   const parsedError = {
     message: "",

package/dist/rpc/methods/checkout/checkout.cjs

@@ -37,7 +37,7 @@ const getCheckoutToken = exports.getCheckoutToken = async function getCheckoutTo
     carrier,
     basketId: context.basketKey,
     campaignKey: context.campaignKey
-  }).setIssuedAt(now).setNotBefore(now).setExpirationTime("1h").setIssuer(`${"@scayle/storefront-core"}@${"8.2.2"}`).setProtectedHeader({
+  }).setIssuedAt(now).setNotBefore(now).setExpirationTime("1h").setIssuer(`${"@scayle/storefront-core"}@${"8.3.0"}`).setProtectedHeader({
     alg: "HS256",
     typ: "JWT"
   }).sign(secret);

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

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@scayle/storefront-core",
-  "version": "8.2.2",
+  "version": "8.3.0",
   "description": "Collection of essential utilities to work with the Storefront API",
   "author": "SCAYLE Commerce Engine",
   "license": "MIT",