@scayle/storefront-core 8.61.2 → 8.62.0

package/CHANGELOG.md

@@ -1,5 +1,42 @@
 # @scayle/storefront-core
 
+## 8.62.0
+
+### Minor Changes
+
+- **\[Promotions\]** Added customer-segmented promotion fetches when a valid session token is present.
+
+  `getPromotions`, `getCurrentPromotions`, and `getPromotionsByIds` accept a `segmentation` flag. When it is `true` and the request has a non-expired access token, the handlers call the Storefront API with `customerToken` and skip the shared cache so results match the logged-in customer. When it is `false`, handlers use the cached anonymous promotion list so customer-specific promotions are not stored in shared cache responses.
+
+  **\[BREAKING\]** `getPromotionsByIds` now expects `{ ids: string[], segmentation: boolean }` instead of a bare `string[]` array.
+  - Before (custom RPC handler via `context.callRpc`):
+
+    ```ts
+    const promotions = await context.callRpc?.('getPromotionsByIds', [
+      'promo-1',
+      'promo-2',
+    ])
+    ```
+
+  - After:
+
+    ```ts
+    const promotions = await context.callRpc?.('getPromotionsByIds', {
+      ids: ['promo-1', 'promo-2'],
+      segmentation: true,
+    })
+    ```
+
+  Promotion list handlers use `POST` instead of `GET` so `segmentation` and `customerToken` are not sent in the URL.
+
+  **\[User\]** Exported `getValidatedAccessToken` to return a JWT only when it is present and not expired. Basket merge and promotion handlers use it when passing `customerToken` to the Storefront API.
+
+## 8.61.3
+
+### Patch Changes
+
+- Fix `updateTokens` and `updateUser` return type from `void` to `Promise<void>` in `ContextWithSession`. The underlying implementations were already async (`await session.save()`), but the incorrect `void` type prevented call sites from knowing they needed to await the result. All call sites in the RPC methods and customer API now correctly await these calls, ensuring session state is persisted before execution continues.
+
 ## 8.61.2
 
 No changes in this release.

package/dist/api/customer.mjs

@@ -58,7 +58,7 @@ export class CustomerAPIClient {
             grant_type: "refresh_token",
             refresh_token: this.context.refreshToken
           });
-          this.context.updateTokens({
+          await this.context.updateTokens({
             accessToken: tokens?.access_token,
             refreshToken: tokens?.refresh_token
           });

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

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

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

@@ -2,45 +2,67 @@ import type { PromotionsParams, PromotionsResponseData, RpcHandler } from '../..
 /**
  * Retrieves promotions based on provided parameters.
  *
- * This function uses the Storefront cache (`cached()`) with a `getPromotions` key prefix to improve performance.
+ * Uses the Storefront cache (`cached()`) with a `getPromotions` key prefix to improve performance.
  * Cached entries are returned if found; otherwise, data is fetched and cached.
  *
+ * When `segmentation` is `true` and the request includes a valid customer access token, promotions are
+ * fetched directly from the Storefront API and are not cached.
+ *
  * @param params The parameters for retrieving promotions.
  * @param params.pagination Pagination settings.
  * @param params.pagination.page Page number.
  * @param params.pagination.perPage Number of items per page.
+ * @param params.segmentation When `true`, fetches customer-segmented promotions without caching.
+ * Defaults to `false`.
  * @param context The RPC context.
  *
  * @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: RpcHandler<Omit<PromotionsParams, 'ids'>, PromotionsResponseData>;
+export declare const getPromotions: RpcHandler<Omit<PromotionsParams, 'ids' | 'customerToken'> & {
+    segmentation: boolean;
+}, PromotionsResponseData>;
 /**
  * Retrieves currently active promotions.
  *
- * This function uses the Storefront cache (`cached()`) with a `getPromotions` key prefix to improve performance.
+ * Uses the Storefront cache (`cached()`) with a `getPromotions` key prefix to improve performance.
  * Cached entries are returned if found; otherwise, data is fetched and cached.
  *
+ * When `segmentation` is `true` and the request includes a valid customer access token, promotions are
+ * fetched directly from the Storefront API and are not cached.
+ *
  * @param params The parameters for retrieving promotions.
  * @param params.pagination Pagination settings.
  * @param params.pagination.page Page number.
  * @param params.pagination.perPage Number of items per page.
+ * @param params.segmentation When `true`, fetches customer-segmented promotions without caching.
+ * Defaults to `false`.
  * @param context The RPC context.
  *
  * @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: RpcHandler<Omit<PromotionsParams, 'ids' | 'activeAt'>, PromotionsResponseData>;
+export declare const getCurrentPromotions: RpcHandler<Omit<PromotionsParams, 'ids' | 'activeAt' | 'customerToken'> & {
+    segmentation: boolean;
+}, PromotionsResponseData>;
 /**
  * Retrieves promotions by their IDs.
  *
- * This function uses the Storefront cache (`cached()`) with a `getByIds-promotions` key prefix to improve performance.
+ * Uses the Storefront cache (`cached()`) with a `getByIds-promotions` key prefix to improve performance.
  * Cached entries are returned if found; otherwise, data is fetched and cached.
  *
- * @param ids An array of promotion IDs.
+ * When `segmentation` is `true` and the request includes a valid customer access token, promotions are
+ * fetched directly from the Storefront API and are not cached.
+ *
+ * @param params Request parameters.
+ * @param params.ids Promotion IDs to retrieve.
+ * @param params.segmentation When `true`, fetches customer-segmented promotions without caching.
  * @param context The RPC context.
  *
  * @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: RpcHandler<string[], PromotionsResponseData>;
+export declare const getPromotionsByIds: RpcHandler<{
+    ids: string[];
+    segmentation: boolean;
+}, PromotionsResponseData>;

package/dist/rpc/methods/promotion.mjs

@@ -4,6 +4,7 @@ import {
 } from "../../constants/index.mjs";
 import { mapSAPIFetchErrorToResponse } from "../../utils/sapi.mjs";
 import { defineRpcHandler } from "../../utils/index.mjs";
+import { getValidatedAccessToken } from "../../utils/user.mjs";
 const setPaginationDefault = (pagination) => {
   return {
     page: pagination?.page || PROMOTION_PAGE_DEFAULT,
@@ -11,42 +12,69 @@ const setPaginationDefault = (pagination) => {
   };
 };
 export const getPromotions = defineRpcHandler(
-  async (params = {}, context) => {
+  async (params = { segmentation: false }, context) => {
     const { sapiClient, cached } = context;
+    const { segmentation, ...promotionsParams } = params;
+    const customerToken = getValidatedAccessToken(context.accessToken);
+    if (segmentation && customerToken) {
+      return mapSAPIFetchErrorToResponse(sapiClient.promotions.get)({
+        ...promotionsParams,
+        pagination: setPaginationDefault(params.pagination),
+        customerToken
+      });
+    }
     return await cached(
       mapSAPIFetchErrorToResponse(sapiClient.promotions.get),
       {
         cacheKeyPrefix: "getPromotions"
       }
     )({
-      ...params,
+      ...promotionsParams,
       pagination: setPaginationDefault(params.pagination)
     });
   },
-  { method: "GET" }
+  { method: "POST" }
 );
 export const getCurrentPromotions = defineRpcHandler(
-  async (params = {}, context) => {
+  async (params = { segmentation: false }, context) => {
     const { sapiClient, cached } = context;
     const now = /* @__PURE__ */ new Date();
     now.setSeconds(0, 0);
     const activeAt = now.toISOString();
+    const { segmentation, ...promotionsParams } = params;
+    const customerToken = getValidatedAccessToken(context.accessToken);
+    if (segmentation && customerToken) {
+      return mapSAPIFetchErrorToResponse(sapiClient.promotions.get)({
+        ...promotionsParams,
+        activeAt,
+        pagination: setPaginationDefault(params.pagination),
+        customerToken
+      });
+    }
     return await cached(
       mapSAPIFetchErrorToResponse(sapiClient.promotions.get),
       {
         cacheKeyPrefix: "getPromotions"
       }
     )({
-      ...params,
+      ...promotionsParams,
       activeAt,
       pagination: setPaginationDefault(params.pagination)
     });
   },
-  { method: "GET" }
+  { method: "POST" }
 );
 export const getPromotionsByIds = defineRpcHandler(
-  async (ids, context) => {
+  async (params, context) => {
     const { sapiClient, cached } = context;
+    const { ids, segmentation } = params;
+    const customerToken = getValidatedAccessToken(context.accessToken);
+    if (segmentation && customerToken) {
+      return mapSAPIFetchErrorToResponse(sapiClient.promotions.getByIds)(
+        ids,
+        customerToken
+      );
+    }
     return await cached(
       mapSAPIFetchErrorToResponse(sapiClient.promotions.getByIds),
       {
@@ -54,5 +82,5 @@ export const getPromotionsByIds = defineRpcHandler(
       }
     )(ids);
   },
-  { method: "GET" }
+  { method: "POST" }
 );

package/dist/rpc/methods/session.mjs

@@ -36,11 +36,11 @@ export async function postLogin(context, tokens) {
     return fetchUserResponse;
   }
   const user = await unwrap(fetchUserResponse);
-  context.updateTokens({
+  await context.updateTokens({
     accessToken: tokens.access_token,
     refreshToken: tokens.refresh_token
   });
-  context.updateUser(user);
+  await context.updateUser(user);
   const { customerId } = decodeJwt(tokens.access_token);
   await Promise.all([
     mergeBaskets(
@@ -201,7 +201,7 @@ export const refreshAccessToken = defineRpcHandler(
         grant_type: "refresh_token",
         refresh_token: refreshToken
       });
-      context.updateTokens({
+      await context.updateTokens({
         accessToken: tokens?.access_token,
         refreshToken: tokens?.refresh_token
       });
@@ -337,7 +337,7 @@ export const updatePasswordByHash = defineRpcHandler(
         ...passwordHash,
         shop_id: shopId
       });
-      context.updateTokens({
+      await context.updateTokens({
         accessToken: tokens.access_token,
         refreshToken: tokens.refresh_token
       });

package/dist/rpc/methods/user.mjs

@@ -98,7 +98,7 @@ const getAccessToken = defineRpcHandler(
           grant_type: "refresh_token",
           refresh_token: context.refreshToken
         });
-        context.updateTokens({
+        await context.updateTokens({
           accessToken: tokens.access_token,
           refreshToken: tokens.refresh_token
         });

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

@@ -72,8 +72,8 @@ export interface ContextWithSession {
     destroySession: () => Promise<void>;
     createUserBoundSession: () => Promise<void>;
     updateSessionCustomData: (updatedCustomData: SessionCustomData) => Promise<void>;
-    updateUser: (user: ShopUser) => void;
-    updateTokens: (tokens: OAuthTokens) => void;
+    updateUser: (user: ShopUser) => Promise<void>;
+    updateTokens: (tokens: OAuthTokens) => Promise<void>;
 }
 /**
  * Context interface without session information.

package/dist/utils/user.mjs

@@ -6,7 +6,7 @@ export const getValidatedAccessToken = (accessToken) => {
   }
   const payload = decodeJwt(accessToken);
   if (!payload.exp || payload.exp < Date.now() / 1e3) {
-    return;
+    return void 0;
   }
   return accessToken;
 };
@@ -51,7 +51,9 @@ export const mergeBaskets = async (fromBasketKey, toBasketKey, withOptions, cont
       }
     );
     fromBasket.items.map(async (item) => {
-      return await sapiClient.basket.deleteItem(fromBasketKey, item.key);
+      return await sapiClient.basket.deleteItem(fromBasketKey, item.key, {
+        customerToken: getValidatedAccessToken(context.accessToken) ?? void 0
+      });
     });
     return mergedBasket;
   }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@scayle/storefront-core",
-  "version": "8.61.2",
+  "version": "8.62.0",
   "description": "Collection of essential utilities to work with the Storefront API",
   "author": "SCAYLE Commerce Engine",
   "license": "MIT",
@@ -41,7 +41,7 @@
     "fishery": "^2.2.3"
   },
   "dependencies": {
-    "@scayle/storefront-api": "^19.0.0",
+    "@scayle/storefront-api": "^19.1.0",
     "@scayle/unstorage-scayle-kv-driver": "^2.1.0",
     "crypto-js": "^4.2.0",
     "hookable": "^5.5.3",
@@ -56,20 +56,19 @@
     "@types/crypto-js": "4.2.2",
     "@types/node": "24.12.2",
     "@types/webpack-env": "1.18.8",
-    "@vitest/coverage-v8": "4.1.5",
+    "@vitest/coverage-v8": "4.1.7",
     "eslint-formatter-gitlab": "7.1.0",
-    "eslint": "10.3.0",
+    "eslint": "10.4.0",
     "fishery": "2.4.0",
-    "publint": "0.3.18",
-    "rimraf": "6.1.3",
+    "publint": "0.3.21",
     "typescript": "6.0.3",
     "unbuild": "3.6.1",
     "unstorage": "1.17.5",
-    "vitest": "4.1.5",
+    "vitest": "4.1.7",
     "@scayle/vitest-config-storefront": "1.0.0"
   },
   "scripts": {
-    "clean": "rimraf ./dist",
+    "clean": "node -e \"require('fs').rmSync('./dist',{recursive:true,force:true})\"",
     "build": "unbuild",
     "typecheck": "tsc --noEmit -p tsconfig.json",
     "lint": "eslint .",