@ls-stack/utils 3.65.0 → 3.67.0

package/dist/testUtils.d.cts

@@ -1,133 +0,0 @@
-import { YamlStringifyOptions } from './yamlStringify.cjs';
-
-declare function createLoggerStore({ filterKeys: defaultFilterKeys, rejectKeys: defaultRejectKeys, splitLongLines: defaultSplitLongLines, maxLineLengthBeforeSplit: defaultMaxLineLengthBeforeSplit, fromLastSnapshot: defaultFromLastSnapshot, arrays: defaultArrays, changesOnly: defaultChangesOnly, useEmojiForBooleans: defaultUseEmojiForBooleans, }?: {
-    filterKeys?: string[];
-    rejectKeys?: string[];
-    splitLongLines?: true;
-    maxLineLengthBeforeSplit?: number;
-    fromLastSnapshot?: boolean;
-    arrays?: 'all' | 'firstAndLast' | 'length' | {
-        firstNItems: number;
-    };
-    changesOnly?: boolean;
-    useEmojiForBooleans?: boolean;
-}): {
-    add: (render: Record<string, unknown> | readonly Record<string, unknown>[]) => void;
-    reset: (keepLastRender?: boolean) => void;
-    getSnapshot: ({ arrays, changesOnly, filterKeys, rejectKeys, includeLastSnapshotEndMark, splitLongLines, maxLineLengthBeforeSplit, fromLastSnapshot, useEmojiForBooleans, }?: {
-        arrays?: "all" | "firstAndLast" | "length" | {
-            firstNItems: number;
-        };
-        changesOnly?: boolean;
-        filterKeys?: string[];
-        rejectKeys?: string[];
-        includeLastSnapshotEndMark?: boolean;
-        splitLongLines?: boolean;
-        maxLineLengthBeforeSplit?: number;
-        fromLastSnapshot?: boolean;
-        useEmojiForBooleans?: boolean;
-    }) => string;
-    waitNextLog: (timeout?: number) => Promise<void>;
-    readonly changesSnapshot: string;
-    readonly snapshot: string;
-    readonly snapshotFromLast: string;
-    logsCount: () => number;
-    readonly rendersTime: number[];
-    addMark: (label: string) => void;
-};
-declare function getResultFn<T extends (...args: any[]) => any>(fnGetter: () => T, wrapper?: (...args: any[]) => any): T;
-declare function waitController(): {
-    wait: Promise<void>;
-    stopWaiting: () => void;
-    stopWaitingAfter: (ms: number) => void;
-};
-/**
- * Produces a more compact and readable snapshot of a value using yaml. By
- * default booleans are shown as `✅` and `❌`, use `showBooleansAs` to
- * disable/configure this.
- *
- * Filtering patterns in `rejectKeys` and `filterKeys`:
- *
- * - `'prop'` - Only root-level properties named 'prop'
- * - `'**prop'` - Any property named exactly 'prop' at any level (root or nested)
- * - `'*.prop'` - Any nested property named 'prop' at second level (excludes
- *   root-level matches)
- * - `'test.*.prop'` - Any property named 'prop' at second level of 'test'
- * - `'test.*.test.**prop'` - Any property named 'prop' inside of 'test.*.test'
- * - `'prop.nested'` - Exact nested property paths like `obj.prop.nested`
- * - `'prop.**nested'` - All nested properties inside root `prop` with name
- *   `nested`
- * - `'prop[0]'` - The first item of the `prop` array
- * - `'prop[*]'` - All items of the `prop` array
- * - `'prop[0].nested'` - `nested` prop of the first item of the `prop` array
- * - `'prop[*].nested'` - `nested` prop of all items of the `prop` array
- * - `'prop[*]**nested'` - all `nested` props of all items of the `prop` array
- * - `'prop[0-2]'` - The first three items of the `prop` array
- * - `'prop[4-*]'` - All items of the `prop` array from the fourth index to the
- *   end
- * - `'prop[0-2].nested.**prop'` - Combining multiple nested patterns is supported
- * - Root array:
- *
- *   - `'[0]'` - The first item of the root array
- *   - `'[*]'` - All items of the array
- *   - `'[0].nested'` - `nested` prop of the first item of the array
- *   - `'[*].nested'` - `nested` prop of all items of the array
- *   - `'[*]**nested'` - all `nested` props of all items of the array
- *   - `'[0-2]'` - The first three items of the array
- *   - `'[4-*]'` - All items of the array from the fourth index to the end
- * - Expanding the patterns with parentheses:
- *
- *   - `'prop.test.(prop1|prop2|prop3.prop4)'` - Will produce `prop.test.prop1`,
- *       `prop.test.prop2`, and `prop.test.prop3.prop4`
- * - Array filtering by value:
- *
- *   - `'users[%name="John"]'` - Filters the `users` with the `name` property equal
- *       to `John`
- *   - `'users[%name="John" | "Jane"]'` - Filters the `users` with the `name`
- *       property equal to `John` or `Jane`
- *   - `'users[%name="John" | "Jane" && %age=20]'` - AND and OR are supported by
- *       using `&&` and `||`, nesting logical operators is not supported yet
- *   - `'users[%config.name="John" | "Jane"]'` - Dot notation is supported
- *
- * Check more supported patterns in {@link filterObjectOrArrayKeys} docs.
- *
- * @param value - The value to snapshot.
- * @param options - The options for the snapshot.
- * @param options.collapseObjects - Whether to collapse objects into a single
- *   line.
- * @param options.maxLineLength - The maximum length of a line.
- * @param options.showUndefined - Whether to show undefined values.
- * @param options.showBooleansAs - Whether to show booleans as text, by default
- *   true is `✅` and false is `❌`
- * @param options.rejectKeys - The keys to reject.
- * @param options.filterKeys - The keys to filter.
- * @param options.ignoreProps - The props to ignore.
- * @param options.replaceValues - Function to replace values at specific paths.
- *   Returns `false` to keep original value or `{newValue}` to replace.
- * @param options.sortKeys - Sort all keys by a specific order (default:
- *   `simpleValuesFirst`).
- * @param options.sortPatterns - Sort specific keys by pattern. Use to control
- *   the order of specific properties. The same patterns as `filterKeys` are
- *   supported.
- * @returns The compact snapshot of the value.
- */
-declare function compactSnapshot(value: unknown, { collapseObjects, maxLineLength, showUndefined, showBooleansAs, replaceValues, rejectKeys, filterKeys, sortKeys, sortPatterns, ...options }?: YamlStringifyOptions & {
-    showBooleansAs?: boolean | {
-        props?: Record<string, {
-            trueText?: string;
-            falseText?: string;
-        } | true>;
-        ignoreProps?: string[];
-        trueText?: string;
-        falseText?: string;
-    };
-    replaceValues?: (value: unknown, path: string) => false | {
-        newValue: unknown;
-    };
-    rejectKeys?: string[] | string;
-    filterKeys?: string[] | string;
-    sortKeys?: 'asc' | 'desc' | 'simpleValuesFirst' | false;
-    sortPatterns?: string[];
-}): string;
-
-export { compactSnapshot, createLoggerStore, getResultFn, waitController };

package/dist/testUtils.js

@@ -1,359 +0,0 @@
-import {
-  yamlStringify
-} from "./chunk-B6DNOZCP.js";
-import {
-  omit,
-  pick
-} from "./chunk-ZXIKIA5B.js";
-import "./chunk-GMJTLFM6.js";
-import {
-  filterObjectOrArrayKeys
-} from "./chunk-MI4UE2PQ.js";
-import "./chunk-IATIXMCE.js";
-import {
-  deepEqual
-} from "./chunk-JQFUKJU5.js";
-import {
-  deepReplaceValues
-} from "./chunk-PUKVXYYL.js";
-import {
-  defer
-} from "./chunk-DFXNVEH6.js";
-import {
-  clampMin
-} from "./chunk-DBOWTYR4.js";
-import "./chunk-BM4PYVOX.js";
-import {
-  arrayWithPrevAndIndex,
-  filterAndMap
-} from "./chunk-WFQJUJTC.js";
-import {
-  isObject
-} from "./chunk-C2SVCIWE.js";
-import {
-  isPlainObject
-} from "./chunk-JF2MDHOJ.js";
-
-// src/testUtils.ts
-function createLoggerStore({
-  filterKeys: defaultFilterKeys,
-  rejectKeys: defaultRejectKeys,
-  splitLongLines: defaultSplitLongLines = true,
-  maxLineLengthBeforeSplit: defaultMaxLineLengthBeforeSplit = 80,
-  fromLastSnapshot: defaultFromLastSnapshot = false,
-  arrays: defaultArrays = { firstNItems: 1 },
-  changesOnly: defaultChangesOnly = false,
-  useEmojiForBooleans: defaultUseEmojiForBooleans = true
-} = {}) {
-  let logs = [];
-  let logsTime = [];
-  let startTime = Date.now();
-  let onNextLog = () => {
-  };
-  function reset(keepLastRender = false) {
-    logs = keepLastRender ? [logs.at(-1)] : [];
-    logsTime = [];
-    startTime = Date.now();
-  }
-  function add(render) {
-    if (!isObject(render)) {
-      for (const [i, r] of render.entries()) {
-        logs.push({
-          i: i + 1,
-          ...r
-        });
-        logsTime.push(Date.now() - startTime);
-      }
-    } else {
-      logs.push(render);
-      logsTime.push(Date.now() - startTime);
-    }
-    onNextLog();
-    if (logs.length > 100) {
-      throw new Error("Too many logs");
-    }
-  }
-  function logsCount() {
-    return logs.filter((item) => !item._lastSnapshotMark).length;
-  }
-  async function waitNextLog(timeout = 50) {
-    return new Promise((resolve) => {
-      const timeoutId = setTimeout(() => {
-        throw new Error("Timeout");
-      }, timeout);
-      onNextLog = () => {
-        clearTimeout(timeoutId);
-        resolve();
-      };
-    });
-  }
-  function getSnapshot({
-    arrays = defaultArrays,
-    changesOnly = defaultChangesOnly,
-    filterKeys = defaultFilterKeys,
-    rejectKeys = defaultRejectKeys,
-    includeLastSnapshotEndMark = true,
-    splitLongLines = defaultSplitLongLines,
-    maxLineLengthBeforeSplit = defaultMaxLineLengthBeforeSplit,
-    fromLastSnapshot = defaultFromLastSnapshot,
-    useEmojiForBooleans = defaultUseEmojiForBooleans
-  } = {}) {
-    let rendersToUse = logs;
-    if (changesOnly || filterKeys || rejectKeys) {
-      rendersToUse = [];
-      for (let { item, prev } of arrayWithPrevAndIndex(logs)) {
-        if (item._lastSnapshotMark || item._mark) {
-          rendersToUse.push(item);
-          continue;
-        }
-        if (filterKeys) {
-          prev = prev && pick(prev, filterKeys);
-          item = pick(item, filterKeys);
-        }
-        if (rejectKeys) {
-          prev = prev && omit(prev, rejectKeys);
-          item = omit(item, rejectKeys);
-        }
-        if (!deepEqual(prev, item)) {
-          rendersToUse.push(item);
-        }
-      }
-    }
-    if (fromLastSnapshot) {
-      const lastSnapshotMark = rendersToUse.findLastIndex(
-        (item) => item._lastSnapshotMark === true
-      );
-      rendersToUse = rendersToUse.slice(clampMin(lastSnapshotMark, 0));
-    }
-    logs.push({ _lastSnapshotMark: true });
-    const propDivider = "\u22C5";
-    const snapShot = `
-${filterAndMap(rendersToUse, (render, i) => {
-      if (render._lastSnapshotMark) {
-        if (includeLastSnapshotEndMark) {
-          if (rendersToUse.length === 1) {
-            return "\u22C5\u22C5\u22C5";
-          }
-          if (i !== rendersToUse.length - 1) {
-            return "\u22C5\u22C5\u22C5";
-          }
-          return false;
-        } else {
-          return false;
-        }
-      }
-      if (render._mark) {
-        const prevIsLastSnapshotMark = rendersToUse[i - 1]?._lastSnapshotMark;
-        let mark = `${prevIsLastSnapshotMark ? "" : "\n"}>>> ${String(render._mark)}`;
-        const nextRender = rendersToUse[i + 1];
-        if (nextRender && !nextRender._mark && !nextRender._lastSnapshotMark) {
-          mark = `${mark}
-`;
-        }
-        return mark;
-      }
-      let line = "";
-      for (const [key, _value] of Object.entries(render)) {
-        let value = _value;
-        if (Array.isArray(value)) {
-          if (arrays === "length") {
-            value = `Array(${value.length})`;
-          } else if (arrays === "firstAndLast" && value.length > 2) {
-            const intermediateSize = clampMin(value.length - 2, 0);
-            value = [value[0], `\u2026(${intermediateSize} between)`, value.at(-1)];
-          } else if (typeof arrays === "object" && value.length > 2) {
-            value = [
-              ...value.slice(0, arrays.firstNItems),
-              `\u2026(${value.length - arrays.firstNItems} more)`
-            ];
-          }
-        }
-        if (typeof value === "boolean" && useEmojiForBooleans) {
-          value = value ? "\u2705" : "\u274C";
-        }
-        if (value === "") {
-          value = `''`;
-        }
-        if (typeof value === "object" && value !== null) {
-          value = JSON.stringify(value).replace(/:true/g, ":\u2705").replace(/:false/g, ":\u274C").replace(/:""/g, ":''").replace(/"/g, "").replace(/,/g, ", ");
-        }
-        line += `${key}: ${value} ${propDivider} `;
-      }
-      line = line.slice(0, (propDivider.length + 2) * -1);
-      if (splitLongLines && line.length > maxLineLengthBeforeSplit) {
-        const parts = line.split(` ${propDivider} `);
-        if (parts.length === 1) {
-          return line;
-        }
-        line = "";
-        const propDividerML = "\u22C5";
-        for (const { item, index } of arrayWithPrevAndIndex(parts)) {
-          if (index === 0) {
-            line += `\u250C\u2500
-${propDividerML} `;
-          } else if (index === parts.length - 1) {
-            line += `${propDividerML} `;
-          } else {
-            line += `${propDividerML} `;
-          }
-          line += `${item}
-`;
-          if (index === parts.length - 1) {
-            line += "\u2514\u2500";
-          }
-        }
-      } else {
-        line = `-> ${line}`;
-      }
-      return line;
-    }).join("\n")}
-`;
-    return snapShot === `
-\u22C5\u22C5\u22C5
-` ? "\u22C5\u22C5\u22C5empty\u22C5\u22C5\u22C5" : snapShot;
-  }
-  function addMark(label) {
-    add({ _mark: label });
-  }
-  return {
-    add,
-    reset,
-    getSnapshot,
-    waitNextLog,
-    get changesSnapshot() {
-      return getSnapshot({ changesOnly: true });
-    },
-    get snapshot() {
-      return getSnapshot();
-    },
-    get snapshotFromLast() {
-      return getSnapshot({ fromLastSnapshot: true });
-    },
-    logsCount,
-    get rendersTime() {
-      return logsTime;
-    },
-    addMark
-  };
-}
-function getResultFn(fnGetter, wrapper) {
-  return (...args) => {
-    const fn = fnGetter();
-    if (wrapper) {
-      return wrapper(fn(...args));
-    } else {
-      return fn(...args);
-    }
-  };
-}
-function waitController() {
-  const { promise, resolve } = defer();
-  return {
-    wait: promise,
-    stopWaiting: () => {
-      resolve();
-    },
-    stopWaitingAfter: (ms) => {
-      setTimeout(() => {
-        resolve();
-      }, ms);
-    }
-  };
-}
-function compactSnapshot(value, {
-  collapseObjects = true,
-  maxLineLength = 100,
-  showUndefined = false,
-  showBooleansAs = true,
-  replaceValues,
-  rejectKeys,
-  filterKeys,
-  sortKeys,
-  sortPatterns,
-  ...options
-} = {}) {
-  let processedValue = value;
-  if (rejectKeys || filterKeys) {
-    if (isPlainObject(processedValue) || Array.isArray(processedValue)) {
-      processedValue = filterObjectOrArrayKeys(processedValue, {
-        rejectKeys,
-        filterKeys,
-        sortKeys,
-        sortPatterns
-      });
-    }
-  }
-  if (replaceValues) {
-    processedValue = deepReplaceValues(processedValue, replaceValues);
-  }
-  processedValue = showBooleansAs ? replaceBooleansWithEmoji(processedValue, showBooleansAs) : processedValue;
-  return `
-${yamlStringify(processedValue, {
-    collapseObjects,
-    maxLineLength,
-    showUndefined,
-    ...options
-  })}`;
-}
-function replaceBooleansWithEmoji(value, showBooleansAs, visited = /* @__PURE__ */ new Set()) {
-  if (showBooleansAs === false) {
-    return value;
-  }
-  const defaultTrueText = "\u2705";
-  const defaultFalseText = "\u274C";
-  const config = typeof showBooleansAs === "boolean" ? { trueText: defaultTrueText, falseText: defaultFalseText } : {
-    trueText: showBooleansAs.trueText ?? defaultTrueText,
-    falseText: showBooleansAs.falseText ?? defaultFalseText,
-    props: showBooleansAs.props ?? {},
-    ignoreProps: showBooleansAs.ignoreProps ?? []
-  };
-  function processValue(val, propName) {
-    if (typeof val === "boolean") {
-      if (propName && config.ignoreProps?.includes(propName)) {
-        return val;
-      }
-      if (propName && config.props?.[propName]) {
-        const propConfig = config.props[propName];
-        if (propConfig === true) {
-          return val ? config.trueText : config.falseText;
-        }
-        return val ? propConfig.trueText ?? config.trueText : propConfig.falseText ?? config.falseText;
-      }
-      return val ? config.trueText : config.falseText;
-    }
-    if (Array.isArray(val)) {
-      if (visited.has(val)) {
-        throw new Error("Circular reference detected in array");
-      }
-      visited.add(val);
-      try {
-        return val.map((item) => processValue(item));
-      } finally {
-        visited.delete(val);
-      }
-    }
-    if (isPlainObject(val)) {
-      if (visited.has(val)) {
-        throw new Error("Circular reference detected in object");
-      }
-      visited.add(val);
-      try {
-        const result = {};
-        for (const [key, itemValue] of Object.entries(val)) {
-          result[key] = processValue(itemValue, key);
-        }
-        return result;
-      } finally {
-        visited.delete(val);
-      }
-    }
-    return val;
-  }
-  return processValue(value);
-}
-export {
-  compactSnapshot,
-  createLoggerStore,
-  getResultFn,
-  waitController
-};