@ls-stack/utils 3.24.0 → 3.24.1

package/docs/testUtils.md

@@ -14,7 +14,7 @@
 function compactSnapshot(value, __namedParameters): string;
 ```
 
-Defined in: [packages/utils/src/testUtils.ts:439](https://github.com/lucasols/utils/blob/main/packages/utils/src/testUtils.ts#L439)
+Defined in: [packages/utils/src/testUtils.ts:487](https://github.com/lucasols/utils/blob/main/packages/utils/src/testUtils.ts#L487)
 
 #### Parameters
 

package/lib/testUtils.cjs

@@ -753,14 +753,20 @@ function waitController() {
     }
   };
 }
-function matchesKeyPattern(path, pattern) {
-  if (path === pattern) {
+function matchesKeyPattern(fullPath, key, pattern, currentPath) {
+  if (fullPath === pattern) {
     return true;
   }
-  if (pattern.includes("*")) {
-    const regexPattern = pattern.replace(/\./g, "\\.").replace(/\*/g, "[^.]*");
-    const regex = new RegExp(`^${regexPattern}$`);
-    return regex.test(path);
+  if (pattern.startsWith("*.")) {
+    const propName = pattern.slice(2);
+    return currentPath !== "" && key === propName;
+  }
+  if (pattern.startsWith("*") && !pattern.startsWith("*.")) {
+    const propName = pattern.slice(1);
+    return key === propName;
+  }
+  if (!pattern.includes("*")) {
+    return currentPath === "" && key === pattern;
   }
   return false;
 }
@@ -792,12 +798,19 @@ function applyKeyFiltering(value, { rejectKeys, filterKeys }, currentPath = "",
   }
   if (Array.isArray(value)) {
     if (visited.has(value)) {
-      throw new Error("Circular reference detected in array during key filtering");
+      throw new Error(
+        "Circular reference detected in array during key filtering"
+      );
     }
     visited.add(value);
     try {
       return value.map(
-        (item, index) => applyKeyFiltering(item, { rejectKeys, filterKeys }, currentPath ? `${currentPath}[${index}]` : `[${index}]`, visited)
+        (item, index) => applyKeyFiltering(
+          item,
+          { rejectKeys, filterKeys },
+          currentPath ? `${currentPath}[${index}]` : `[${index}]`,
+          visited
+        )
       );
     } finally {
       visited.delete(value);
@@ -805,7 +818,9 @@ function applyKeyFiltering(value, { rejectKeys, filterKeys }, currentPath = "",
   }
   if (isPlainObject(value)) {
     if (visited.has(value)) {
-      throw new Error("Circular reference detected in object during key filtering");
+      throw new Error(
+        "Circular reference detected in object during key filtering"
+      );
     }
     visited.add(value);
     try {
@@ -813,23 +828,43 @@ function applyKeyFiltering(value, { rejectKeys, filterKeys }, currentPath = "",
       for (const [key, itemValue] of Object.entries(value)) {
         const fullPath = currentPath ? `${currentPath}.${key}` : key;
         if (rejectKeys?.some(
-          (rejectPath) => matchesKeyPattern(fullPath, rejectPath) || matchesKeyPattern(key, rejectPath)
+          (rejectPath) => matchesKeyPattern(fullPath, key, rejectPath, currentPath)
         )) {
           continue;
         }
         if (filterKeys) {
-          const shouldInclude = filterKeys.some(
-            (filterPath) => (
-              // Exact match
-              matchesKeyPattern(fullPath, filterPath) || matchesKeyPattern(key, filterPath) || // This path is a parent of a filter pattern (so we include it to allow children)
-              isParentOfPattern(fullPath, filterPath)
-            )
+          const exactMatch = filterKeys.some(
+            (filterPath) => matchesKeyPattern(fullPath, key, filterPath, currentPath)
+          );
+          const isParent = filterKeys.some(
+            (filterPath) => isParentOfPattern(fullPath, filterPath)
           );
-          if (!shouldInclude) {
+          if (!exactMatch && !isParent) {
             continue;
           }
+          if (exactMatch) {
+            result[key] = applyKeyFiltering(
+              itemValue,
+              { rejectKeys },
+              fullPath,
+              visited
+            );
+          } else {
+            result[key] = applyKeyFiltering(
+              itemValue,
+              { rejectKeys, filterKeys },
+              fullPath,
+              visited
+            );
+          }
+        } else {
+          result[key] = applyKeyFiltering(
+            itemValue,
+            { rejectKeys, filterKeys },
+            fullPath,
+            visited
+          );
         }
-        result[key] = applyKeyFiltering(itemValue, { rejectKeys, filterKeys }, fullPath, visited);
       }
       return result;
     } finally {
@@ -849,7 +884,10 @@ function compactSnapshot(value, {
 } = {}) {
   let processedValue = value;
   if (rejectKeys || filterKeys) {
-    processedValue = applyKeyFiltering(processedValue, { rejectKeys, filterKeys });
+    processedValue = applyKeyFiltering(processedValue, {
+      rejectKeys: Array.isArray(rejectKeys) ? rejectKeys : rejectKeys ? [rejectKeys] : void 0,
+      filterKeys: Array.isArray(filterKeys) ? filterKeys : filterKeys ? [filterKeys] : void 0
+    });
   }
   processedValue = showBooleansAs ? replaceBooleansWithEmoji(processedValue, showBooleansAs) : processedValue;
   return `

package/lib/testUtils.d.cts

@@ -51,8 +51,59 @@ declare function compactSnapshot(value: unknown, { collapseObjects, maxLineLengt
         trueText?: string;
         falseText?: string;
     };
-    rejectKeys?: string[];
-    filterKeys?: string[];
+    /**
+     * Reject (exclude) keys from the snapshot using pattern matching.
+     *
+     * **Pattern Syntax:**
+     * - `'prop'` - Only root-level properties named 'prop'
+     * - `'prop.nested'` - Exact nested property paths like `obj.prop.nested`
+     * - `'*prop'` - Any property named exactly 'prop' at any level (root or nested)
+     * - `'*.prop'` - Any nested property named 'prop' (excludes root-level matches)
+     *
+     * **Examples:**
+     * ```typescript
+     * // Reject root-level 'secret' only
+     * rejectKeys: ['secret']
+     *
+     * // Reject nested 'password' properties only
+     * rejectKeys: ['*.password']
+     *
+     * // Reject any 'apiKey' property at any level
+     * rejectKeys: ['*apiKey']
+     *
+     * // Reject specific nested path
+     * rejectKeys: ['user.settings.theme']
+     * ```
+     */
+    rejectKeys?: string[] | string;
+    /**
+     * Filter (include only) keys that match the specified patterns.
+     *
+     * **Pattern Syntax:** (same as rejectKeys)
+     * - `'prop'` - Only root-level properties named 'prop'
+     * - `'prop.nested'` - Exact nested property paths like `obj.prop.nested`
+     * - `'*prop'` - Any property named exactly 'prop' at any level (root or nested)
+     * - `'*.prop'` - Any nested property named 'prop' (excludes root-level matches)
+     *
+     * **Examples:**
+     * ```typescript
+     * // Include only root-level 'user'
+     * filterKeys: ['user']
+     *
+     * // Include all 'name' properties at any level
+     * filterKeys: ['*name']
+     *
+     * // Include only nested 'id' properties
+     * filterKeys: ['*.id']
+     *
+     * // Include specific nested paths
+     * filterKeys: ['user.profile.email', 'settings.theme']
+     * ```
+     *
+     * **Note:** When filtering, parent paths are automatically included if needed
+     * to preserve the structure for nested matches.
+     */
+    filterKeys?: string[] | string;
 }): string;
 
 export { compactSnapshot, createLoggerStore, getResultFn, waitController };

package/lib/testUtils.d.ts

@@ -51,8 +51,59 @@ declare function compactSnapshot(value: unknown, { collapseObjects, maxLineLengt
         trueText?: string;
         falseText?: string;
     };
-    rejectKeys?: string[];
-    filterKeys?: string[];
+    /**
+     * Reject (exclude) keys from the snapshot using pattern matching.
+     *
+     * **Pattern Syntax:**
+     * - `'prop'` - Only root-level properties named 'prop'
+     * - `'prop.nested'` - Exact nested property paths like `obj.prop.nested`
+     * - `'*prop'` - Any property named exactly 'prop' at any level (root or nested)
+     * - `'*.prop'` - Any nested property named 'prop' (excludes root-level matches)
+     *
+     * **Examples:**
+     * ```typescript
+     * // Reject root-level 'secret' only
+     * rejectKeys: ['secret']
+     *
+     * // Reject nested 'password' properties only
+     * rejectKeys: ['*.password']
+     *
+     * // Reject any 'apiKey' property at any level
+     * rejectKeys: ['*apiKey']
+     *
+     * // Reject specific nested path
+     * rejectKeys: ['user.settings.theme']
+     * ```
+     */
+    rejectKeys?: string[] | string;
+    /**
+     * Filter (include only) keys that match the specified patterns.
+     *
+     * **Pattern Syntax:** (same as rejectKeys)
+     * - `'prop'` - Only root-level properties named 'prop'
+     * - `'prop.nested'` - Exact nested property paths like `obj.prop.nested`
+     * - `'*prop'` - Any property named exactly 'prop' at any level (root or nested)
+     * - `'*.prop'` - Any nested property named 'prop' (excludes root-level matches)
+     *
+     * **Examples:**
+     * ```typescript
+     * // Include only root-level 'user'
+     * filterKeys: ['user']
+     *
+     * // Include all 'name' properties at any level
+     * filterKeys: ['*name']
+     *
+     * // Include only nested 'id' properties
+     * filterKeys: ['*.id']
+     *
+     * // Include specific nested paths
+     * filterKeys: ['user.profile.email', 'settings.theme']
+     * ```
+     *
+     * **Note:** When filtering, parent paths are automatically included if needed
+     * to preserve the structure for nested matches.
+     */
+    filterKeys?: string[] | string;
 }): string;
 
 export { compactSnapshot, createLoggerStore, getResultFn, waitController };

package/lib/testUtils.js

@@ -253,14 +253,20 @@ function waitController() {
     }
   };
 }
-function matchesKeyPattern(path, pattern) {
-  if (path === pattern) {
+function matchesKeyPattern(fullPath, key, pattern, currentPath) {
+  if (fullPath === pattern) {
     return true;
   }
-  if (pattern.includes("*")) {
-    const regexPattern = pattern.replace(/\./g, "\\.").replace(/\*/g, "[^.]*");
-    const regex = new RegExp(`^${regexPattern}$`);
-    return regex.test(path);
+  if (pattern.startsWith("*.")) {
+    const propName = pattern.slice(2);
+    return currentPath !== "" && key === propName;
+  }
+  if (pattern.startsWith("*") && !pattern.startsWith("*.")) {
+    const propName = pattern.slice(1);
+    return key === propName;
+  }
+  if (!pattern.includes("*")) {
+    return currentPath === "" && key === pattern;
   }
   return false;
 }
@@ -292,12 +298,19 @@ function applyKeyFiltering(value, { rejectKeys, filterKeys }, currentPath = "",
   }
   if (Array.isArray(value)) {
     if (visited.has(value)) {
-      throw new Error("Circular reference detected in array during key filtering");
+      throw new Error(
+        "Circular reference detected in array during key filtering"
+      );
     }
     visited.add(value);
     try {
       return value.map(
-        (item, index) => applyKeyFiltering(item, { rejectKeys, filterKeys }, currentPath ? `${currentPath}[${index}]` : `[${index}]`, visited)
+        (item, index) => applyKeyFiltering(
+          item,
+          { rejectKeys, filterKeys },
+          currentPath ? `${currentPath}[${index}]` : `[${index}]`,
+          visited
+        )
       );
     } finally {
       visited.delete(value);
@@ -305,7 +318,9 @@ function applyKeyFiltering(value, { rejectKeys, filterKeys }, currentPath = "",
   }
   if (isPlainObject(value)) {
     if (visited.has(value)) {
-      throw new Error("Circular reference detected in object during key filtering");
+      throw new Error(
+        "Circular reference detected in object during key filtering"
+      );
     }
     visited.add(value);
     try {
@@ -313,23 +328,43 @@ function applyKeyFiltering(value, { rejectKeys, filterKeys }, currentPath = "",
       for (const [key, itemValue] of Object.entries(value)) {
         const fullPath = currentPath ? `${currentPath}.${key}` : key;
         if (rejectKeys?.some(
-          (rejectPath) => matchesKeyPattern(fullPath, rejectPath) || matchesKeyPattern(key, rejectPath)
+          (rejectPath) => matchesKeyPattern(fullPath, key, rejectPath, currentPath)
         )) {
           continue;
         }
         if (filterKeys) {
-          const shouldInclude = filterKeys.some(
-            (filterPath) => (
-              // Exact match
-              matchesKeyPattern(fullPath, filterPath) || matchesKeyPattern(key, filterPath) || // This path is a parent of a filter pattern (so we include it to allow children)
-              isParentOfPattern(fullPath, filterPath)
-            )
+          const exactMatch = filterKeys.some(
+            (filterPath) => matchesKeyPattern(fullPath, key, filterPath, currentPath)
+          );
+          const isParent = filterKeys.some(
+            (filterPath) => isParentOfPattern(fullPath, filterPath)
           );
-          if (!shouldInclude) {
+          if (!exactMatch && !isParent) {
             continue;
           }
+          if (exactMatch) {
+            result[key] = applyKeyFiltering(
+              itemValue,
+              { rejectKeys },
+              fullPath,
+              visited
+            );
+          } else {
+            result[key] = applyKeyFiltering(
+              itemValue,
+              { rejectKeys, filterKeys },
+              fullPath,
+              visited
+            );
+          }
+        } else {
+          result[key] = applyKeyFiltering(
+            itemValue,
+            { rejectKeys, filterKeys },
+            fullPath,
+            visited
+          );
         }
-        result[key] = applyKeyFiltering(itemValue, { rejectKeys, filterKeys }, fullPath, visited);
       }
       return result;
     } finally {
@@ -349,7 +384,10 @@ function compactSnapshot(value, {
 } = {}) {
   let processedValue = value;
   if (rejectKeys || filterKeys) {
-    processedValue = applyKeyFiltering(processedValue, { rejectKeys, filterKeys });
+    processedValue = applyKeyFiltering(processedValue, {
+      rejectKeys: Array.isArray(rejectKeys) ? rejectKeys : rejectKeys ? [rejectKeys] : void 0,
+      filterKeys: Array.isArray(filterKeys) ? filterKeys : filterKeys ? [filterKeys] : void 0
+    });
   }
   processedValue = showBooleansAs ? replaceBooleansWithEmoji(processedValue, showBooleansAs) : processedValue;
   return `

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@ls-stack/utils",
   "description": "Universal TypeScript utilities for browser and Node.js",
-  "version": "3.24.0",
+  "version": "3.24.1",
   "license": "MIT",
   "files": [
     "lib",