@scayle/storefront-core 8.54.0 → 8.56.0

package/CHANGELOG.md

@@ -1,5 +1,34 @@
 # @scayle/storefront-core
 
+## 8.56.0
+
+### Minor Changes
+
+- Added support for custom session data in the RPC context type definitions.
+
+  The `ContextWithSession` interface now includes a `sessionCustomData` property (which may be `undefined`) to read custom session data and an `updateSessionCustomData` method to update it.
+  The `ContextWithoutSession` interface has been updated accordingly to maintain type consistency.
+  The `SessionCustomData` interface can be augmented using TypeScript module augmentation to provide type safety for custom session properties.
+
+### Patch Changes
+
+**Dependencies**
+
+- Updated dependency to @scayle/storefront-api@18.19.0
+- Updated dependency to @scayle/unstorage-scayle-kv-driver@2.0.9
+
+## 8.55.0
+
+### Minor Changes
+
+- Updated the type of the `removeItemFromBasket` RPC to accurately reflect that error responses can be returned if removing an item from the basket fails (these error responses were already being returned before; only the type was updated). Additionally, the `clearBasket` RPC now removes items sequentially to avoid conflicts between basket updates and returns an error response if any items in the basket could not be removed.
+
+### Patch Changes
+
+**Dependencies**
+
+- Updated dependency to @scayle/storefront-api@18.19.0
+
 ## 8.54.0
 
 ### Minor Changes

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

@@ -86,12 +86,12 @@ export declare const removeItemFromBasket: RpcHandler<{
     basket: BasketResponseData<Product, Variant>;
 }>;
 /**
- * Clears the basket, removing all items.
+ * Clears the basket, by removing all items sequentially.
  *
  * @param context The RPC context.
  *
  * @returns True if the basket was cleared successfully. It will return
- * an `ErrorResponse` alternatively iIf an error occurs during basket clearing.
+ * an `ErrorResponse` alternatively if an error occurs during basket clearing.
  */
 export declare const clearBasket: RpcHandler<boolean>;
 /**

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

@@ -213,7 +213,7 @@ export const removeItemFromBasket = defineRpcHandler(async (options, context) =>
   const campaignKey = await context.callRpc?.("getCampaignKey");
   const _orderCustomData = await context.callRpc?.("getOrderCustomData");
   const resolvedWith = getWithParams(options, context);
-  const basket = await sapiClient.basket.deleteItem(
+  const response = await sapiClient.basket.deleteItem(
     basketKey,
     options.itemKey,
     {
@@ -227,7 +227,14 @@ export const removeItemFromBasket = defineRpcHandler(async (options, context) =>
       customerToken: getValidatedAccessToken(context.accessToken) ?? void 0
     }
   );
-  return { basket };
+  if ("code" in response) {
+    return new ErrorResponse(
+      response.code,
+      SAPI_ERROR_NAME,
+      response.message
+    );
+  }
+  return { basket: response };
 });
 export const clearBasket = defineRpcHandler(
   async (context) => {
@@ -236,12 +243,15 @@ export const clearBasket = defineRpcHandler(
       return getBasketResponse;
     }
     const { basket } = await unwrap(getBasketResponse);
-    await Promise.all(
-      basket.items.map(async (item) => {
-        await removeItemFromBasket({ itemKey: item.key }, context);
-      })
-    );
-    context.log.debug("The basket has been cleared");
+    for (const item of basket.items) {
+      const response = await removeItemFromBasket(
+        { itemKey: item.key },
+        context
+      );
+      if (response instanceof ErrorResponse) {
+        return response;
+      }
+    }
     return true;
   }
 );

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

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

package/dist/types/api/context.d.ts

@@ -27,7 +27,7 @@ export interface RuntimeConfiguration {
 }
 /**
  * Additional context information for RPC calls.
- * AThis interface can be augmented to extend the `RpcContext` type and
+ * This interface can be augmented to extend the `RpcContext` type and
  * allows to adding custom properties to the RPC context.
  *
  * @example
@@ -42,6 +42,22 @@ export interface RuntimeConfiguration {
  */
 export interface AdditionalRpcContext {
 }
+/**
+ * Interface for custom session data.
+ * This interface can be augmented to extend the `RpcContextWithSession` type and
+ * allows to adding custom data properties to the session on the RPC context.
+ *
+ * @example
+ * ```typescript
+ * declare module '@scayle/storefront-core' {
+ *   interface SessionCustomData {
+ *     myCustomData: string
+ *   }
+ * }
+ * ```
+ */
+export interface SessionCustomData {
+}
 /**
  * Context interface with session information.
  */
@@ -52,8 +68,10 @@ export interface ContextWithSession {
     user: ShopUser | undefined;
     accessToken: string | undefined;
     refreshToken: string | undefined;
+    sessionCustomData: SessionCustomData | undefined;
     destroySession: () => Promise<void>;
     createUserBoundSession: () => Promise<void>;
+    updateSessionCustomData: (updatedCustomData: SessionCustomData) => Promise<void>;
     updateUser: (user: ShopUser) => void;
     updateTokens: (tokens: OAuthTokens) => void;
 }
@@ -67,9 +85,11 @@ export interface ContextWithoutSession {
     user: undefined;
     accessToken: undefined;
     refreshToken: undefined;
+    sessionCustomData: undefined;
     destroySession: undefined;
     createUserBoundSession: undefined;
     updateUser: undefined;
+    updateSessionCustomData: undefined;
     updateTokens: undefined;
 }
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@scayle/storefront-core",
-  "version": "8.54.0",
+  "version": "8.56.0",
   "description": "Collection of essential utilities to work with the Storefront API",
   "author": "SCAYLE Commerce Engine",
   "license": "MIT",
@@ -48,16 +48,16 @@
     "ufo": "^1.5.3",
     "uncrypto": "^0.1.3",
     "utility-types": "^3.11.0",
-    "@scayle/unstorage-scayle-kv-driver": "2.0.9",
-    "@scayle/storefront-api": "18.18.1"
+    "@scayle/storefront-api": "18.19.0",
+    "@scayle/unstorage-scayle-kv-driver": "2.0.9"
   },
   "devDependencies": {
     "@types/crypto-js": "4.2.2",
     "@types/node": "22.19.1",
     "@types/webpack-env": "1.18.8",
-    "@vitest/coverage-v8": "4.0.14",
+    "@vitest/coverage-v8": "4.0.15",
     "dprint": "0.50.2",
-    "eslint-formatter-gitlab": "6.0.1",
+    "eslint-formatter-gitlab": "7.0.0",
     "eslint": "9.39.1",
     "fishery": "2.3.1",
     "publint": "0.3.15",
@@ -65,9 +65,9 @@
     "typescript": "5.9.3",
     "unbuild": "3.6.1",
     "unstorage": "1.17.3",
-    "vitest": "4.0.14",
-    "@scayle/vitest-config-storefront": "1.0.0",
-    "@scayle/eslint-config-storefront": "4.7.15"
+    "vitest": "4.0.15",
+    "@scayle/eslint-config-storefront": "4.7.16",
+    "@scayle/vitest-config-storefront": "1.0.0"
   },
   "volta": {
     "node": "22.21.1"