@scayle/storefront-core 8.14.2 → 8.14.4

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # @scayle/storefront-core
 
+## 8.14.4
+
+### Patch Changes
+
+**Dependencies**
+
+- Updated dependency to @scayle/storefront-api@18.2.0
+
+## 8.14.3
+
+### Patch Changes
+
+- Export the `BasketItemUpdateData` type.
+
 ## 8.14.2
 
 ### Patch Changes
@@ -172,12 +186,12 @@ To get the default campaign key, you can call the RPC method:
 ```typescript
 // Before
 async function rpcMethod(context) {
-  const campaignKey = { context }
+  const campaignKey = { context };
   // ...
 }
 // After
 async function rpcMethod(context) {
-  const campaignKey = await context.callRpc?.('getCampaignKey')
+  const campaignKey = await context.callRpc?.("getCampaignKey");
   // ...
 }
 ```
@@ -366,43 +380,43 @@ See [Overriding core RPC Methods](https://scayle.dev/en/storefront-guide/develop
 
     ```ts
     const BadgeLabel = {
-      NEW: 'new',
-      SOLD_OUT: 'sold_out',
-      ONLINE_EXCLUSIVE: 'online_exclusive',
-      SUSTAINABLE: 'sustainable',
-      PREMIUM: 'premium',
-      DEFAULT: '',
-    } as const
+      NEW: "new",
+      SOLD_OUT: "sold_out",
+      ONLINE_EXCLUSIVE: "online_exclusive",
+      SUSTAINABLE: "sustainable",
+      PREMIUM: "premium",
+      DEFAULT: "",
+    } as const;
 
     type BadgeLabelParamsKeys =
-      | 'isNew'
-      | 'isSoldOut'
-      | 'isOnlineOnly'
-      | 'isSustainable'
-      | 'isPremium'
-    type BadgeLabelParams = Partial<Record<BadgeLabelParamsKeys, boolean>>
+      | "isNew"
+      | "isSoldOut"
+      | "isOnlineOnly"
+      | "isSustainable"
+      | "isPremium";
+    type BadgeLabelParams = Partial<Record<BadgeLabelParamsKeys, boolean>>;
 
     const getBadgeLabel = (params: BadgeLabelParams = {}): string => {
       if (!params) {
-        return BadgeLabel.DEFAULT
+        return BadgeLabel.DEFAULT;
       }
       const { isNew, isSoldOut, isOnlineOnly, isSustainable, isPremium } =
-        params
+        params;
 
       if (isNew) {
-        return BadgeLabel.NEW
+        return BadgeLabel.NEW;
       } else if (isSoldOut) {
-        return BadgeLabel.SOLD_OUT
+        return BadgeLabel.SOLD_OUT;
       } else if (isOnlineOnly) {
-        return BadgeLabel.ONLINE_EXCLUSIVE
+        return BadgeLabel.ONLINE_EXCLUSIVE;
       } else if (isSustainable) {
-        return BadgeLabel.SUSTAINABLE
+        return BadgeLabel.SUSTAINABLE;
       } else if (isPremium) {
-        return BadgeLabel.PREMIUM
+        return BadgeLabel.PREMIUM;
       } else {
-        return BadgeLabel.DEFAULT
+        return BadgeLabel.DEFAULT;
       }
-    }
+    };
     ```
 
 - **\[💥 BREAKING\]** We've standardized our configuration to use `sapi` (Storefront API) throughout the codebase, replacing the deprecated `bapi` keyword. This change improves clarity and consistency by removing the `initBapi` function, replacing the `bapiClient` property with `sapiClient` within the `RPCContext`, and updating all code references accordingly. `BapiConfig` is not exported anymore and has been superseded by `SapiConfig`.
@@ -418,15 +432,15 @@ See [Overriding core RPC Methods](https://scayle.dev/en/storefront-guide/develop
         storefront: {
           // ...
           bapi: {
-            host: '...',
-            token: '...',
+            host: "...",
+            token: "...",
           },
           // ...
         },
         // ...
       },
       // ...
-    }
+    };
     ```
 
   - _Legacy Environment Variables:_
@@ -446,15 +460,15 @@ See [Overriding core RPC Methods](https://scayle.dev/en/storefront-guide/develop
         storefront: {
           // ...
           sapi: {
-            host: '...',
-            token: '...',
+            host: "...",
+            token: "...",
           },
           // ...
         },
         // ...
       },
       // ...
-    }
+    };
     ```
 
   - _New Environment Variables:_
@@ -472,19 +486,19 @@ See [Overriding core RPC Methods](https://scayle.dev/en/storefront-guide/develop
 
     ```ts
     const { data, fetching, fetch, error, status } = useUser(
-      'getUser',
+      "getUser"
       // ...
-    )
-    data.value.user.authentication.storefrontAccessToken
+    );
+    data.value.user.authentication.storefrontAccessToken;
     ```
 
   - _Current Usage of dedicated `getAccessToken` RPC method:_
 
     ```ts
     const { data: accessToken } = useRpc(
-      'getAccessToken',
+      "getAccessToken"
       // ...
-    )
+    );
     ```
 
 - **\[💥 BREAKING\]** We've enhanced security for basket and wishlist keys by switching the default hashing algorithm from MD5 to the more robust SHA256.
@@ -507,7 +521,7 @@ See [Overriding core RPC Methods](https://scayle.dev/en/storefront-guide/develop
         // ...
       },
       // ...
-    })
+    });
     ```
 
 - **\[💥 BREAKING\]** The attribute `loginShopId` is removed from the `ShopUser` interface as the shop now uses session cookies.
@@ -516,23 +530,23 @@ See [Overriding core RPC Methods](https://scayle.dev/en/storefront-guide/develop
   - _Previous Usage of `searchProducts` RPC method:_
 
     ```ts
-    const getSearchSuggestionsRpc = useRpcCall('searchProducts')
+    const getSearchSuggestionsRpc = useRpcCall("searchProducts");
 
     data.value = await searchProducts({
       term: String(searchQuery.value),
       ...params,
-    })
+    });
     ```
 
   - _Current Usage of `getSearchSuggestions` RPC method:_
 
     ```ts
-    const getSearchSuggestionsRpc = useRpcCall('getSearchSuggestions')
+    const getSearchSuggestionsRpc = useRpcCall("getSearchSuggestions");
 
     data.value = await getSearchSuggestionsRpc({
       term: String(searchQuery.value),
       ...params,
-    })
+    });
     ```
 
 - **\[💥 BREAKING\]** Improved basket updating: Adding an item to your basket with a reduced quantity will now correctly update the basket contents.

package/dist/index.d.ts

@@ -7,6 +7,7 @@ export * from './constants';
 export * from './cache';
 export * from './helpers';
 export * from './types';
+export type { BasketItemUpdateData } from './rpc/methods';
 /**
  * Core RPC methods available within `@scayle/storefront-core`.
  */

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

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

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

@@ -1,4 +1,4 @@
-import type { PromotionsParams, PromotionsResponseData, RpcContext } from '../../types';
+import type { PromotionsParams, RpcContext } from '../../types';
 /**
  * Retrieves promotions based on provided parameters.
  *
@@ -14,7 +14,7 @@ import type { PromotionsParams, PromotionsResponseData, RpcContext } from '../..
  * @returns A Promise that resolves with the promotion data.
  * It will return an `ErrorResponse` if the The Storefront API request fails.
  */
-export declare const getPromotions: (params: Omit<PromotionsParams, "ids"> | undefined, context: RpcContext) => Promise<Response | PromotionsResponseData>;
+export declare const getPromotions: (params: Omit<PromotionsParams, "ids"> | undefined, context: RpcContext) => Promise<any>;
 /**
  * Retrieves currently active promotions.
  *
@@ -30,7 +30,7 @@ export declare const getPromotions: (params: Omit<PromotionsParams, "ids"> | und
  * @returns A Promise that resolves with the current promotion data.
  * It will return an `ErrorResponse` if the The Storefront API request fails.
  */
-export declare const getCurrentPromotions: (params: Omit<PromotionsParams, "ids" | "activeAt"> | undefined, context: RpcContext) => Promise<Response | PromotionsResponseData>;
+export declare const getCurrentPromotions: (params: Omit<PromotionsParams, "ids" | "activeAt"> | undefined, context: RpcContext) => Promise<any>;
 /**
  * Retrieves promotions by their IDs.
  *
@@ -43,4 +43,4 @@ export declare const getCurrentPromotions: (params: Omit<PromotionsParams, "ids"
  * @returns A Promise that resolves with the promotion data.
  * It will return an `ErrorResponse` if the The Storefront API request fails.
  */
-export declare const getPromotionsByIds: (ids: string[], context: RpcContext) => Promise<Response | PromotionsResponseData>;
+export declare const getPromotionsByIds: (ids: string[], context: RpcContext) => Promise<any>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@scayle/storefront-core",
-  "version": "8.14.2",
+  "version": "8.14.4",
   "description": "Collection of essential utilities to work with the Storefront API",
   "author": "SCAYLE Commerce Engine",
   "license": "MIT",
@@ -63,7 +63,7 @@
     "fishery": "^2.2.3"
   },
   "dependencies": {
-    "@scayle/storefront-api": "18.1.1",
+    "@scayle/storefront-api": "18.2.0",
     "@scayle/unstorage-scayle-kv-driver": "0.1.1",
     "crypto-js": "^4.2.0",
     "hookable": "^5.5.3",
@@ -74,13 +74,13 @@
     "utility-types": "^3.11.0"
   },
   "devDependencies": {
-    "@scayle/eslint-config-storefront": "4.4.1",
+    "@scayle/eslint-config-storefront": "4.5.0",
     "@types/crypto-js": "4.2.2",
-    "@types/node": "22.13.10",
+    "@types/node": "22.13.14",
     "@types/webpack-env": "1.18.8",
     "@vitest/coverage-v8": "2.1.9",
     "dprint": "0.49.1",
-    "eslint": "9.22.0",
+    "eslint": "9.23.0",
     "eslint-formatter-gitlab": "5.1.0",
     "fishery": "2.2.3",
     "publint": "0.2.12",