@scayle/storefront-core 7.52.1 → 7.54.0

package/CHANGELOG.md

@@ -1,5 +1,24 @@
 # @scayle/storefront-core
 
+## 7.54.0
+
+### Minor Changes
+
+- Add new function `purifySensitiveValue` to `sanitizationHelpers` to purify specific value.
+- Introduced a new parameter `showFirstAndLastChar` to both `purifySensitiveValue` and `purifySensitiveData`.
+
+## 7.53.0
+
+### Minor Changes
+
+- Deprecate `isCmsPreview` flag in `RpcContext`. This flag indicated that the current session is or has been inside of a CMS editor. With the the introduction of 'Live Preview' for the cms provider 'contentful' and 'storyblok' this flag is no longer necessary.
+
+### Patch Changes
+
+- Removes option `considerItemGroupForUniqueness` from `addItemsToBasket` since this is now enabled by default.
+- Updated dependencies
+  - @scayle/storefront-api@17.2.0
+
 ## 7.52.1
 
 ### Patch Changes

package/dist/helpers/sanitizationHelpers.cjs

@@ -3,19 +3,28 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.stripShopLocaleFromPath = exports.purifySensitiveData = exports.createAndPurifyHeaders = void 0;
+exports.stripShopLocaleFromPath = exports.purifySensitiveValue = exports.purifySensitiveData = exports.createAndPurifyHeaders = void 0;
 var _radash = require("radash");
 const SANITIZATION_MASK = "********";
+const regex = /(?<!^).(?!$)/g;
 const stripShopLocaleFromPath = (locale, path, splitter = "/") => path.split(splitter).filter(segment => segment.toLowerCase() !== locale.toLowerCase()).join("/");
 exports.stripShopLocaleFromPath = stripShopLocaleFromPath;
-const purifySensitiveData = (data = {}, blacklistedKeys = ["password"]) => {
+const purifySensitiveValue = (value, showFirstAndLastChar = false) => {
+  return showFirstAndLastChar && value.length > 2 ? value.replace(regex, "*") : SANITIZATION_MASK;
+};
+exports.purifySensitiveValue = purifySensitiveValue;
+const purifySensitiveData = (data = {}, blacklistedKeys = ["password"], showFirstAndLastChar = false) => {
   return Object.entries(data).reduce((purifiedPayload, [key, value]) => {
     if ((0, _radash.isObject)(value)) {
       purifiedPayload[key] = purifySensitiveData(value, blacklistedKeys);
       return purifiedPayload;
     }
     const isSensitiveData = blacklistedKeys.some(excludedKey => key.includes(excludedKey));
-    purifiedPayload[key] = isSensitiveData && value !== "" ? SANITIZATION_MASK : value;
+    if (isSensitiveData && value) {
+      purifiedPayload[key] = purifySensitiveValue(value, showFirstAndLastChar);
+    } else {
+      purifiedPayload[key] = value;
+    }
     return purifiedPayload;
   }, {});
 };

package/dist/helpers/sanitizationHelpers.d.ts

@@ -1,3 +1,4 @@
 export declare const stripShopLocaleFromPath: (locale: string, path: string, splitter?: string) => string;
-export declare const purifySensitiveData: (data?: Record<string, any>, blacklistedKeys?: string[]) => Record<string, any>;
+export declare const purifySensitiveValue: (value: string, showFirstAndLastChar?: boolean) => string;
+export declare const purifySensitiveData: (data?: Record<string, any>, blacklistedKeys?: string[], showFirstAndLastChar?: boolean) => Record<string, any>;
 export declare const createAndPurifyHeaders: (headers: Partial<Record<string, string | undefined>>) => Headers;

package/dist/helpers/sanitizationHelpers.mjs

@@ -1,7 +1,11 @@
 import { isObject, shake } from "radash";
 const SANITIZATION_MASK = "********";
+const regex = /(?<!^).(?!$)/g;
 export const stripShopLocaleFromPath = (locale, path, splitter = "/") => path.split(splitter).filter((segment) => segment.toLowerCase() !== locale.toLowerCase()).join("/");
-export const purifySensitiveData = (data = {}, blacklistedKeys = ["password"]) => {
+export const purifySensitiveValue = (value, showFirstAndLastChar = false) => {
+  return showFirstAndLastChar && value.length > 2 ? value.replace(regex, "*") : SANITIZATION_MASK;
+};
+export const purifySensitiveData = (data = {}, blacklistedKeys = ["password"], showFirstAndLastChar = false) => {
   return Object.entries(data).reduce(
     (purifiedPayload, [key, value]) => {
       if (isObject(value)) {
@@ -11,7 +15,11 @@ export const purifySensitiveData = (data = {}, blacklistedKeys = ["password"]) =
       const isSensitiveData = blacklistedKeys.some(
         (excludedKey) => key.includes(excludedKey)
       );
-      purifiedPayload[key] = isSensitiveData && value !== "" ? SANITIZATION_MASK : value;
+      if (isSensitiveData && value) {
+        purifiedPayload[key] = purifySensitiveValue(value, showFirstAndLastChar);
+      } else {
+        purifiedPayload[key] = value;
+      }
       return purifiedPayload;
     },
     {}

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

@@ -90,8 +90,7 @@ const addItemsToBasket = exports.addItemsToBasket = async function addItemsToBas
     skipAvailabilityCheck: false,
     includeItemsWithoutProductData: resolvedWith?.includeItemsWithoutProductData
   }, {
-    existingItemHandling: params.existingItemHandling || _constants.ExistingItemHandling.AddQuantityToExisting,
-    considerItemGroupForUniqueness: Boolean(params.considerItemGroupForUniqueness ?? null)
+    existingItemHandling: params.existingItemHandling || _constants.ExistingItemHandling.AddQuantityToExisting
   });
   if (result.type === "success") {
     return result.basket;

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

@@ -9,7 +9,6 @@ export declare const addItemsToBasket: (params: {
     items: AddOrUpdateItemType[];
     existingItemHandling: ExistingItemHandling;
     with?: BasketWithOptions | undefined;
-    considerItemGroupForUniqueness?: boolean | undefined;
 }, context: RpcContext) => Promise<BasketResponseData<Product, Variant>>;
 export declare const getBasket: (options: BasketWithOptions | undefined, context: RpcContext) => Promise<BasketResponseData<Product, Variant>>;
 export declare const removeItemFromBasket: (options: {

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

@@ -90,10 +90,7 @@ export const addItemsToBasket = async function addItemsToBasket2(params, context
       includeItemsWithoutProductData: resolvedWith?.includeItemsWithoutProductData
     },
     {
-      existingItemHandling: params.existingItemHandling || ExistingItemHandling.AddQuantityToExisting,
-      considerItemGroupForUniqueness: Boolean(
-        params.considerItemGroupForUniqueness ?? null
-      )
+      existingItemHandling: params.existingItemHandling || ExistingItemHandling.AddQuantityToExisting
     }
   );
   if (result.type === "success") {

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

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

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

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

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

@@ -58,6 +58,9 @@ export type RpcContext = {
     };
     bapiClient: StorefrontAPIClient;
     cached: CachedType;
+    /**
+     * @deprecated this flag will be removed in a future release.
+     */
     isCmsPreview: boolean;
     shopId: number;
     domain: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@scayle/storefront-core",
-  "version": "7.52.1",
+  "version": "7.54.0",
   "description": "Collection of essential utilities to work with the Storefront API",
   "author": "SCAYLE Commerce Engine",
   "license": "MIT",
@@ -59,7 +59,7 @@
     "test:ci": "vitest --run --passWithNoTests --coverage --reporter=default --reporter=junit"
   },
   "dependencies": {
-    "@scayle/storefront-api": "17.1.0",
+    "@scayle/storefront-api": "17.2.0",
     "crypto-js": "4.2.0",
     "jose": "5.4.0",
     "radash": "12.1.0",
@@ -71,7 +71,7 @@
   "devDependencies": {
     "@scayle/eslint-config-storefront": "4.2.0",
     "@types/crypto-js": "4.2.2",
-    "@types/node": "20.14.0",
+    "@types/node": "20.14.1",
     "@types/webpack-env": "1.18.5",
     "@vitest/coverage-v8": "1.6.0",
     "dprint": "0.46.1",