@scayle/storefront-core 7.40.1 → 7.41.0

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @scayle/storefront-core
 
+## 7.41.0
+
+### Minor Changes
+
+- Add `purifySensitiveData` sanitization helper
+
 ## 7.40.1
 
 ### Patch Changes

package/dist/helpers/sanitizationHelpers.cjs

@@ -3,6 +3,20 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.stripShopLocaleFromPath = void 0;
+exports.stripShopLocaleFromPath = exports.purifySensitiveData = void 0;
+var _radash = require("radash");
+const SANITIZATION_MASK = "********";
 const stripShopLocaleFromPath = (locale, path, splitter = "/") => path.split(splitter).filter(segment => segment.toLowerCase() !== locale.toLowerCase()).join("/");
-exports.stripShopLocaleFromPath = stripShopLocaleFromPath;
+exports.stripShopLocaleFromPath = stripShopLocaleFromPath;
+const purifySensitiveData = (data = {}, blacklistedKeys = ["password"]) => {
+  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 ? SANITIZATION_MASK : value;
+    return purifiedPayload;
+  }, {});
+};
+exports.purifySensitiveData = purifySensitiveData;

package/dist/helpers/sanitizationHelpers.d.ts

@@ -1 +1,2 @@
 export declare const stripShopLocaleFromPath: (locale: string, path: string, splitter?: string) => string;
+export declare const purifySensitiveData: (data?: Record<string, any>, blacklistedKeys?: string[]) => Record<string, any>;

package/dist/helpers/sanitizationHelpers.mjs

@@ -1 +1,19 @@
+import { isObject } from "radash";
+const SANITIZATION_MASK = "********";
 export const stripShopLocaleFromPath = (locale, path, splitter = "/") => path.split(splitter).filter((segment) => segment.toLowerCase() !== locale.toLowerCase()).join("/");
+export const purifySensitiveData = (data = {}, blacklistedKeys = ["password"]) => {
+  return Object.entries(data).reduce(
+    (purifiedPayload, [key, value]) => {
+      if (isObject(value)) {
+        purifiedPayload[key] = purifySensitiveData(value, blacklistedKeys);
+        return purifiedPayload;
+      }
+      const isSensitiveData = blacklistedKeys.some(
+        (excludedKey) => key.includes(excludedKey)
+      );
+      purifiedPayload[key] = isSensitiveData ? SANITIZATION_MASK : value;
+      return purifiedPayload;
+    },
+    {}
+  );
+};

package/package.json

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