@ls-stack/utils 3.24.1 → 3.25.0

package/lib/testUtils.js

@@ -1,6 +1,6 @@
 import {
   yamlStringify
-} from "./chunk-JAPKLFIK.js";
+} from "./chunk-QLD7KG5I.js";
 import {
   omit,
   pick
@@ -9,6 +9,9 @@ import "./chunk-IATIXMCE.js";
 import {
   deepEqual
 } from "./chunk-JQFUKJU5.js";
+import {
+  filterObjectOrArrayKeys
+} from "./chunk-XXYTMSFH.js";
 import {
   defer
 } from "./chunk-DFXNVEH6.js";
@@ -253,126 +256,6 @@ function waitController() {
     }
   };
 }
-function matchesKeyPattern(fullPath, key, pattern, currentPath) {
-  if (fullPath === pattern) {
-    return true;
-  }
-  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;
-}
-function isParentOfPattern(path, pattern) {
-  if (pattern.includes("*")) {
-    const patternParts = pattern.split(".");
-    const pathParts = path.split(".");
-    if (pathParts.length >= patternParts.length) {
-      return false;
-    }
-    for (let i = 0; i < pathParts.length; i++) {
-      const pathPart = pathParts[i];
-      const patternPart = patternParts[i];
-      if (patternPart === "*") {
-        continue;
-      }
-      if (pathPart !== patternPart) {
-        return false;
-      }
-    }
-    return true;
-  } else {
-    return pattern.startsWith(`${path}.`);
-  }
-}
-function applyKeyFiltering(value, { rejectKeys, filterKeys }, currentPath = "", visited = /* @__PURE__ */ new Set()) {
-  if (!isPlainObject(value) && !Array.isArray(value)) {
-    return value;
-  }
-  if (Array.isArray(value)) {
-    if (visited.has(value)) {
-      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
-        )
-      );
-    } finally {
-      visited.delete(value);
-    }
-  }
-  if (isPlainObject(value)) {
-    if (visited.has(value)) {
-      throw new Error(
-        "Circular reference detected in object during key filtering"
-      );
-    }
-    visited.add(value);
-    try {
-      const result = {};
-      for (const [key, itemValue] of Object.entries(value)) {
-        const fullPath = currentPath ? `${currentPath}.${key}` : key;
-        if (rejectKeys?.some(
-          (rejectPath) => matchesKeyPattern(fullPath, key, rejectPath, currentPath)
-        )) {
-          continue;
-        }
-        if (filterKeys) {
-          const exactMatch = filterKeys.some(
-            (filterPath) => matchesKeyPattern(fullPath, key, filterPath, currentPath)
-          );
-          const isParent = filterKeys.some(
-            (filterPath) => isParentOfPattern(fullPath, filterPath)
-          );
-          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
-          );
-        }
-      }
-      return result;
-    } finally {
-      visited.delete(value);
-    }
-  }
-  return value;
-}
 function compactSnapshot(value, {
   collapseObjects = true,
   maxLineLength = 100,
@@ -384,10 +267,12 @@ function compactSnapshot(value, {
 } = {}) {
   let processedValue = value;
   if (rejectKeys || filterKeys) {
-    processedValue = applyKeyFiltering(processedValue, {
-      rejectKeys: Array.isArray(rejectKeys) ? rejectKeys : rejectKeys ? [rejectKeys] : void 0,
-      filterKeys: Array.isArray(filterKeys) ? filterKeys : filterKeys ? [filterKeys] : void 0
-    });
+    if (isPlainObject(processedValue) || Array.isArray(processedValue)) {
+      processedValue = filterObjectOrArrayKeys(processedValue, {
+        rejectKeys,
+        filterKeys
+      });
+    }
   }
   processedValue = showBooleansAs ? replaceBooleansWithEmoji(processedValue, showBooleansAs) : processedValue;
   return `

package/lib/tsResult.d.cts

@@ -36,12 +36,21 @@ type ResultMethods<T, E extends ResultValidErrors> = {
 type ResultMethodsKeys = keyof ResultMethods<any, any>;
 /** @deprecated Use `t-result` library instead. */
 declare function ok(): Ok<void>;
-/** @deprecated Use `t-result` library instead. */
+/**
+ * @param value
+ * @deprecated Use `t-result` library instead.
+ */
 declare function ok<T>(value: T): Ok<T>;
-/** @deprecated Use `t-result` library instead. */
+/**
+ * @param error
+ * @deprecated Use `t-result` library instead.
+ */
 declare function err<E extends ResultValidErrors>(error: E): Err<E>;
 declare function unknownToResultError(error: unknown): Err<Error>;
-/** Unwraps a promise result */
+/**
+ * Unwraps a promise result
+ * @param result
+ */
 declare function asyncUnwrap<T>(result: Promise<Result<T, ResultValidErrors>>): Promise<T>;
 declare function asyncMap<T, E extends ResultValidErrors>(resultPromise: Promise<Result<T, E>>): {
     err: <NewError extends ResultValidErrors>(mapFn: (error: E) => NewError) => Promise<Result<T, NewError>>;
@@ -62,13 +71,28 @@ declare const Result: {
     asyncMap: typeof asyncMap;
     getOkErr: typeof getOkErr;
 };
-/** @deprecated Use `t-result` library instead. */
+/**
+ * @param fn
+ * @param errorNormalizer
+ * @deprecated Use `t-result` library instead.
+ */
 declare function resultify<T, E extends ResultValidErrors = Error>(fn: () => T extends Promise<any> ? never : T, errorNormalizer?: (err: unknown) => E): Result<T, E>;
-/** @deprecated Use `t-result` library instead. */
+/**
+ * @param fn
+ * @param errorNormalizer
+ * @deprecated Use `t-result` library instead.
+ */
 declare function resultify<T, E extends ResultValidErrors = Error>(fn: () => Promise<T>, errorNormalizer?: (err: unknown) => E): Promise<Result<Awaited<T>, E>>;
-/** @deprecated Use `t-result` library instead. */
+/**
+ * @param fn
+ * @param errorNormalizer
+ * @deprecated Use `t-result` library instead.
+ */
 declare function resultify<T, E extends ResultValidErrors = Error>(fn: Promise<T>, errorNormalizer?: (err: unknown) => E): Promise<Result<T, E>>;
-/** @deprecated Use `t-result` library instead. */
+/**
+ * @param error
+ * @deprecated Use `t-result` library instead.
+ */
 declare function unknownToError(error: unknown): Error;
 /** @deprecated Use `t-result` library instead. */
 type TypedResult<T, E extends ResultValidErrors = Error> = {

package/lib/tsResult.d.ts

@@ -36,12 +36,21 @@ type ResultMethods<T, E extends ResultValidErrors> = {
 type ResultMethodsKeys = keyof ResultMethods<any, any>;
 /** @deprecated Use `t-result` library instead. */
 declare function ok(): Ok<void>;
-/** @deprecated Use `t-result` library instead. */
+/**
+ * @param value
+ * @deprecated Use `t-result` library instead.
+ */
 declare function ok<T>(value: T): Ok<T>;
-/** @deprecated Use `t-result` library instead. */
+/**
+ * @param error
+ * @deprecated Use `t-result` library instead.
+ */
 declare function err<E extends ResultValidErrors>(error: E): Err<E>;
 declare function unknownToResultError(error: unknown): Err<Error>;
-/** Unwraps a promise result */
+/**
+ * Unwraps a promise result
+ * @param result
+ */
 declare function asyncUnwrap<T>(result: Promise<Result<T, ResultValidErrors>>): Promise<T>;
 declare function asyncMap<T, E extends ResultValidErrors>(resultPromise: Promise<Result<T, E>>): {
     err: <NewError extends ResultValidErrors>(mapFn: (error: E) => NewError) => Promise<Result<T, NewError>>;
@@ -62,13 +71,28 @@ declare const Result: {
     asyncMap: typeof asyncMap;
     getOkErr: typeof getOkErr;
 };
-/** @deprecated Use `t-result` library instead. */
+/**
+ * @param fn
+ * @param errorNormalizer
+ * @deprecated Use `t-result` library instead.
+ */
 declare function resultify<T, E extends ResultValidErrors = Error>(fn: () => T extends Promise<any> ? never : T, errorNormalizer?: (err: unknown) => E): Result<T, E>;
-/** @deprecated Use `t-result` library instead. */
+/**
+ * @param fn
+ * @param errorNormalizer
+ * @deprecated Use `t-result` library instead.
+ */
 declare function resultify<T, E extends ResultValidErrors = Error>(fn: () => Promise<T>, errorNormalizer?: (err: unknown) => E): Promise<Result<Awaited<T>, E>>;
-/** @deprecated Use `t-result` library instead. */
+/**
+ * @param fn
+ * @param errorNormalizer
+ * @deprecated Use `t-result` library instead.
+ */
 declare function resultify<T, E extends ResultValidErrors = Error>(fn: Promise<T>, errorNormalizer?: (err: unknown) => E): Promise<Result<T, E>>;
-/** @deprecated Use `t-result` library instead. */
+/**
+ * @param error
+ * @deprecated Use `t-result` library instead.
+ */
 declare function unknownToError(error: unknown): Error;
 /** @deprecated Use `t-result` library instead. */
 type TypedResult<T, E extends ResultValidErrors = Error> = {

package/lib/typingFnUtils.d.cts

@@ -1,28 +1,43 @@
 import { NonPartial } from './typingUtils.cjs';
 
 declare function asNonPartial<T extends Record<string, unknown>>(obj: T): NonPartial<T>;
-/** a wrapper to Object.entries with a better typing inference */
+/**
+ * a wrapper to Object.entries with a better typing inference
+ * @param obj
+ */
 declare function typedObjectEntries<T extends Record<string, unknown>>(obj: T): NonNullable<{
     [K in keyof T]: [K, T[K]];
 }[keyof T]>[];
-/** a wrapper to Object.keys with a better typing inference */
+/**
+ * a wrapper to Object.keys with a better typing inference
+ * @param obj
+ */
 declare function typedObjectKeys<T extends Record<string, unknown>>(obj: T): (keyof T)[];
-/** a safe way to cast types, use to substitute the `as Type` */
+/**
+ * a safe way to cast types, use to substitute the `as Type`
+ * @param value
+ */
 declare function asType<T = unknown>(value: T): T;
-/** narrow a string to a union of strings */
+/**
+ * narrow a string to a union of strings
+ * @param key
+ * @param union
+ */
 declare function narrowStringToUnion<const T extends string>(key: string | undefined | null, union: T[] | readonly T[] | Set<T>): T | undefined;
 /**
  * Type helper to check if a type is a subtype of another type.
  *
  * @template BaseType - The base type to check against
  * @template SubType - The type that should extend BaseType
- * @returns {unknown} Returns undefined, only used for type checking
+ * @returns Returns undefined, only used for type checking
  */
 declare function typeOnRightExtendsLeftType<BaseType, SubType extends BaseType>(): unknown;
 /** @deprecated use typeOnRightExtendsLeftType instead */
 declare const isSubTypeOf: typeof typeOnRightExtendsLeftType;
 /**
  * Type helper to narrow a string to a key of an object.
+ * @param key
+ * @param obj
  */
 declare function isObjKey<T extends Record<string, unknown>>(key: unknown, obj: T): key is keyof T;
 type UnionDiff<T, U> = [
@@ -43,7 +58,6 @@ type UnionDiff<T, U> = [
  * @template T - The first union type (left side)
  * @template U - The second union type (right side)
  * @param _diff - null if unions are identical, or an object describing the errors
- * @returns void - This function is only used for type checking
  */
 declare function unionsAreTheSame<T, U>(_diff: UnionDiff<T, U>): void;
 

package/lib/typingFnUtils.d.ts

@@ -1,28 +1,43 @@
 import { NonPartial } from './typingUtils.js';
 
 declare function asNonPartial<T extends Record<string, unknown>>(obj: T): NonPartial<T>;
-/** a wrapper to Object.entries with a better typing inference */
+/**
+ * a wrapper to Object.entries with a better typing inference
+ * @param obj
+ */
 declare function typedObjectEntries<T extends Record<string, unknown>>(obj: T): NonNullable<{
     [K in keyof T]: [K, T[K]];
 }[keyof T]>[];
-/** a wrapper to Object.keys with a better typing inference */
+/**
+ * a wrapper to Object.keys with a better typing inference
+ * @param obj
+ */
 declare function typedObjectKeys<T extends Record<string, unknown>>(obj: T): (keyof T)[];
-/** a safe way to cast types, use to substitute the `as Type` */
+/**
+ * a safe way to cast types, use to substitute the `as Type`
+ * @param value
+ */
 declare function asType<T = unknown>(value: T): T;
-/** narrow a string to a union of strings */
+/**
+ * narrow a string to a union of strings
+ * @param key
+ * @param union
+ */
 declare function narrowStringToUnion<const T extends string>(key: string | undefined | null, union: T[] | readonly T[] | Set<T>): T | undefined;
 /**
  * Type helper to check if a type is a subtype of another type.
  *
  * @template BaseType - The base type to check against
  * @template SubType - The type that should extend BaseType
- * @returns {unknown} Returns undefined, only used for type checking
+ * @returns Returns undefined, only used for type checking
  */
 declare function typeOnRightExtendsLeftType<BaseType, SubType extends BaseType>(): unknown;
 /** @deprecated use typeOnRightExtendsLeftType instead */
 declare const isSubTypeOf: typeof typeOnRightExtendsLeftType;
 /**
  * Type helper to narrow a string to a key of an object.
+ * @param key
+ * @param obj
  */
 declare function isObjKey<T extends Record<string, unknown>>(key: unknown, obj: T): key is keyof T;
 type UnionDiff<T, U> = [
@@ -43,7 +58,6 @@ type UnionDiff<T, U> = [
  * @template T - The first union type (left side)
  * @template U - The second union type (right side)
  * @param _diff - null if unions are identical, or an object describing the errors
- * @returns void - This function is only used for type checking
  */
 declare function unionsAreTheSame<T, U>(_diff: UnionDiff<T, U>): void;
 

package/lib/yamlStringify.cjs

@@ -72,12 +72,12 @@ function yamlStringify(obj, {
   addRootObjSpaces = "beforeAndAfter"
 } = {}) {
   if (isObject(obj) || Array.isArray(obj) || typeof obj === "function") {
-    return `${stringifyValue(obj, "", maxLineLength, !!showUndefined, maxDepth, 0, collapseObjects, addRootObjSpaces)}
+    return `${stringifyValue(obj, "", maxLineLength, !!showUndefined, maxDepth, 0, collapseObjects, addRootObjSpaces, false)}
 `;
   }
   return JSON.stringify(obj) || "undefined";
 }
-function stringifyValue(value, indent, maxLineLength, showUndefined, maxDepth, depth, collapseObjects, addObjSpaces) {
+function stringifyValue(value, indent, maxLineLength, showUndefined, maxDepth, depth, collapseObjects, addObjSpaces, isArrayItem) {
   let result = "";
   const childIndent = `${indent}  `;
   if (isPlainObject(value)) {
@@ -96,7 +96,8 @@ function stringifyValue(value, indent, maxLineLength, showUndefined, maxDepth, d
           return typeof val === "number" || typeof val === "boolean" || val === null || val === void 0;
         }
       );
-      if (isSimpleObject && entries.length > 0) {
+      const shouldCollapse = isArrayItem ? entries.length > 1 : entries.length > 0;
+      if (isSimpleObject && shouldCollapse) {
         let line = "{ ";
         line += entries.map(([key, val]) => {
           let valueStr;
@@ -143,20 +144,29 @@ function stringifyValue(value, indent, maxLineLength, showUndefined, maxDepth, d
         maxDepth,
         depth + 1,
         collapseObjects,
-        addObjSpaces
+        addObjSpaces,
+        false
       );
-      const willBeCollapsed = isObject(objVal) && (Object.keys(objVal).length === 0 || collapseObjects && depth + 1 > 0 && Object.entries(objVal).filter(([, val]) => val !== void 0 || showUndefined).every(([, val]) => {
-        if (typeof val === "string") {
-          return !val.includes("'") && !val.includes('"') && !val.includes("\\");
-        }
-        return typeof val === "number" || typeof val === "boolean" || val === null || val === void 0;
-      }));
-      const prevWasCollapsed = prevValue && isObject(prevValue) && (Object.keys(prevValue).length === 0 || collapseObjects && depth + 1 > 0 && Object.entries(prevValue).filter(([, val]) => val !== void 0 || showUndefined).every(([, val]) => {
-        if (typeof val === "string") {
-          return !val.includes("'") && !val.includes('"') && !val.includes("\\");
-        }
-        return typeof val === "number" || typeof val === "boolean" || val === null || val === void 0;
-      }));
+      const willBeCollapsed = isObject(objVal) && (Object.keys(objVal).length === 0 || collapseObjects && depth + 1 > 0 && (() => {
+        const filteredEntries = Object.entries(objVal).filter(([, val]) => val !== void 0 || showUndefined);
+        const shouldCollapseThis = isArrayItem ? filteredEntries.length > 1 : filteredEntries.length > 0;
+        return shouldCollapseThis && filteredEntries.every(([, val]) => {
+          if (typeof val === "string") {
+            return !val.includes("'") && !val.includes('"') && !val.includes("\\");
+          }
+          return typeof val === "number" || typeof val === "boolean" || val === null || val === void 0;
+        });
+      })());
+      const prevWasCollapsed = prevValue && isObject(prevValue) && (Object.keys(prevValue).length === 0 || collapseObjects && depth + 1 > 0 && (() => {
+        const filteredEntries = Object.entries(prevValue).filter(([, val]) => val !== void 0 || showUndefined);
+        const shouldCollapseThis = isArrayItem ? filteredEntries.length > 1 : filteredEntries.length > 0;
+        return shouldCollapseThis && filteredEntries.every(([, val]) => {
+          if (typeof val === "string") {
+            return !val.includes("'") && !val.includes('"') && !val.includes("\\");
+          }
+          return typeof val === "number" || typeof val === "boolean" || val === null || val === void 0;
+        });
+      })());
       if (!afterSpaceWasAdded && indent === "" && isObject(objVal) && !willBeCollapsed && prevValue && !prevWasCollapsed && (addObjSpaces === "before" || addObjSpaces === "beforeAndAfter")) {
         result += "\n";
       }
@@ -219,7 +229,8 @@ function stringifyValue(value, indent, maxLineLength, showUndefined, maxDepth, d
           maxDepth,
           depth + 1,
           collapseObjects,
-          addObjSpaces
+          addObjSpaces,
+          true
         );
       }).join(", ");
       line += "]";
@@ -243,7 +254,8 @@ function stringifyValue(value, indent, maxLineLength, showUndefined, maxDepth, d
             maxDepth,
             depth + 1,
             collapseObjects,
-            addObjSpaces
+            addObjSpaces,
+            true
           );
           arrayString = arrayString.trimStart();
           result += arrayString;
@@ -256,7 +268,8 @@ function stringifyValue(value, indent, maxLineLength, showUndefined, maxDepth, d
             maxDepth,
             depth + 1,
             collapseObjects,
-            addObjSpaces
+            addObjSpaces,
+            true
           );
         }
         result += "\n";
@@ -310,7 +323,8 @@ ${indent}${line}
       maxDepth,
       depth + 1,
       collapseObjects,
-      addObjSpaces
+      addObjSpaces,
+      false
     );
   }
   return JSON.stringify(value);

package/lib/yamlStringify.js

@@ -1,6 +1,6 @@
 import {
   yamlStringify
-} from "./chunk-JAPKLFIK.js";
+} from "./chunk-QLD7KG5I.js";
 import "./chunk-IATIXMCE.js";
 import "./chunk-4REIIZQY.js";
 import "./chunk-JF2MDHOJ.js";

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@ls-stack/utils",
   "description": "Universal TypeScript utilities for browser and Node.js",
-  "version": "3.24.1",
+  "version": "3.25.0",
   "license": "MIT",
   "files": [
     "lib",
@@ -84,6 +84,10 @@
       "import": "./lib/exhaustiveMatch.js",
       "require": "./lib/exhaustiveMatch.cjs"
     },
+    "./filterObjectOrArrayKeys": {
+      "import": "./lib/filterObjectOrArrayKeys.js",
+      "require": "./lib/filterObjectOrArrayKeys.cjs"
+    },
     "./getAutoIncrementId": {
       "import": "./lib/getAutoIncrementId.js",
       "require": "./lib/getAutoIncrementId.cjs"