bupkis 0.18.1 → 0.18.2

package/dist/snapshot/serializer.cjs

@@ -1,246 +0,0 @@
-"use strict";
-/**
- * Serialization utilities for converting values to snapshot strings.
- *
- * Provides default serialization logic that handles:
- *
- * - Circular references
- * - Non-JSON types (Functions, Symbols, BigInt, etc.)
- * - Error objects
- * - Map and Set collections
- * - Key sorting for deterministic output
- *
- * @packageDocumentation
- */
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.nodeTestCompatibleSerializer = exports.defaultSerializer = void 0;
-const { entries, getOwnPropertyNames } = Object;
-const { isArray } = Array;
-const json_stable_stringify_1 = __importDefault(require("json-stable-stringify"));
-const guards_js_1 = require("../guards.cjs");
-/**
- * Default JSON replacer that handles non-JSON types.
- *
- * Converts JavaScript-specific types into JSON-serializable representations:
- *
- * - Functions: omitted (`undefined`)
- * - Symbols: converted to string
- * - BigInt: converted to string with `n` suffix
- * - `undefined`: converted to string `'undefined'`
- * - RegExp: converted to string representation
- * - Date: converted to ISO string
- * - Error: converted to object with name, message, and other properties
- * - Map: converted to `{ __type: 'Map', entries: [...] }`
- * - Set: converted to `{ __type: 'Set', values: [...] }`
- *
- * @example
- *
- * ```typescript
- * defaultReplacer(Symbol('test')); // 'Symbol(test)'
- * defaultReplacer(42n); // '42n'
- * defaultReplacer(() => {}); // undefined (omitted)
- * ```
- *
- * @function
- * @param value - Value to convert
- * @returns Converted value, or `undefined` to omit
- */
-const defaultReplacer = (value) => {
-    // Functions are omitted
-    if (typeof value === 'function' || value === undefined) {
-        return undefined;
-    }
-    // Symbols converted to string
-    if (typeof value === 'symbol') {
-        return value.toString();
-    }
-    // BigInt converted to string with suffix
-    if (typeof value === 'bigint') {
-        return `${value.toString()}n`;
-    }
-    if ((0, guards_js_1.isA)(value, RegExp)) {
-        return value.toString();
-    }
-    if ((0, guards_js_1.isA)(value, Date)) {
-        return value.toISOString();
-    }
-    if ((0, guards_js_1.isError)(value)) {
-        const errorProps = {
-            message: value.message,
-            name: value.name,
-        };
-        // Include other enumerable properties
-        for (const prop of getOwnPropertyNames(value)) {
-            if (prop !== 'stack') {
-                // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
-                errorProps[prop] = value[prop];
-            }
-        }
-        return errorProps;
-    }
-    // Map to array of entries
-    if ((0, guards_js_1.isA)(value, Map)) {
-        return {
-            __type: 'Map',
-            entries: [...value.entries()],
-        };
-    }
-    // Set to array
-    if ((0, guards_js_1.isA)(value, Set)) {
-        return {
-            __type: 'Set',
-            values: [...value.values()],
-        };
-    }
-    return value;
-};
-/**
- * Detects and marks circular references in an object graph, and applies
- * replacer for special types.
- *
- * Uses a WeakSet to track visited objects without holding strong references.
- * Circular references are replaced with the string `'[Circular]'`.
- *
- * @example
- *
- * ```typescript
- * const obj: any = { a: 1 };
- * obj.self = obj;
- * detectCircular(obj, defaultReplacer); // { a: 1, self: '[Circular]' }
- * ```
- *
- * @function
- * @param value - Value to process
- * @param replacer - Function to transform values
- * @returns Value with circular references replaced and special types converted
- */
-const detectCircular = (value, replacer) => {
-    const seen = new WeakSet();
-    /**
-     * @function
-     */
-    const visit = (val) => {
-        // Apply replacer first (handles special types)
-        const replaced = replacer(val);
-        // If replacer returned something different, use it
-        if (replaced !== val) {
-            // If replaced is an object, we need to visit it recursively
-            if (typeof replaced === 'object' && replaced !== null) {
-                val = replaced;
-            }
-            else {
-                // Primitive or special transformation, return as-is
-                return replaced;
-            }
-        }
-        // Primitives can't be circular
-        if (typeof val !== 'object' || val === null) {
-            return val;
-        }
-        // Check if we've seen this object before
-        if (seen.has(val)) {
-            return '[Circular]';
-        }
-        // Mark as seen
-        seen.add(val);
-        // Handle arrays
-        if (isArray(val)) {
-            return val.map((item) => visit(item));
-        }
-        // Handle plain objects
-        const result = {};
-        for (const [key, value] of entries(val)) {
-            const visited = visit(value);
-            // Only include if not undefined (functions are omitted)
-            if (visited !== undefined) {
-                result[key] = visited;
-            }
-        }
-        return result;
-    };
-    return visit(value);
-};
-/**
- * Default serializer using JSON.stringify with custom handling.
- *
- * This serializer provides robust handling of JavaScript values including:
- *
- * - Circular reference detection
- * - Non-JSON type conversion
- * - Optional key sorting for deterministic output
- * - Custom replacer support
- *
- * The output is formatted with 2-space indentation for readability.
- *
- * @example
- *
- * ```typescript
- * const obj = { b: 2, a: 1, date: new Date('2025-01-01') };
- * defaultSerializer(obj, { sortKeys: true });
- * // Returns:
- * // {
- * //   "a": 1,
- * //   "b": 2,
- * //   "date": "2025-01-01T00:00:00.000Z"
- * // }
- * ```
- *
- * @example
- *
- * ```typescript
- * const circular: any = { a: 1 };
- * circular.self = circular;
- * defaultSerializer(circular);
- * // Returns:
- * // {
- * //   "a": 1,
- * //   "self": "[Circular]"
- * // }
- * ```
- *
- * @function
- * @param value - Value to serialize
- * @param options - Serialization options
- * @returns JSON string representation
- */
-const defaultSerializer = (value, options = {}) => {
-    const { replacer = defaultReplacer } = options;
-    // Handle circular references and apply replacer
-    const processed = detectCircular(value, replacer);
-    // Don't pass replacer to stringify - it's already been applied
-    return String((0, json_stable_stringify_1.default)(processed, { space: 2 }));
-};
-exports.defaultSerializer = defaultSerializer;
-/**
- * Serializer compatible with node:test's snapshot format.
- *
- * This is currently an alias for {@link defaultSerializer}, but exists as a
- * separate export to allow for future node:test-specific customization.
- *
- * @example
- *
- * ```typescript
- * import test from 'node:test';
- * import { nodeTestCompatibleSerializer } from 'bupkis/snapshot';
- *
- * test('my test', (t) => {
- *   const data = { foo: 'bar' };
- *   expect(data, 'to match snapshot', t, {
- *     serializer: nodeTestCompatibleSerializer,
- *   });
- * });
- * ```
- *
- * @function
- * @param value - Value to serialize
- * @returns JSON string representation
- */
-const nodeTestCompatibleSerializer = (value) => {
-    // Node:test expects the same format as our default serializer
-    return (0, exports.defaultSerializer)(value);
-};
-exports.nodeTestCompatibleSerializer = nodeTestCompatibleSerializer;
-//# sourceMappingURL=serializer.js.map

package/dist/snapshot/serializer.cjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"serializer.js","sourceRoot":"","sources":["../../src/snapshot/serializer.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;GAYG;;;;;;AAEH,MAAM,EAAE,OAAO,EAAE,mBAAmB,EAAE,GAAG,MAAM,CAAC;AAChD,MAAM,EAAE,OAAO,EAAE,GAAG,KAAK,CAAC;AAE1B,kFAA8C;AAE9C,6CAA4C;AAgD5C;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,MAAM,eAAe,GAAG,CAAC,KAAc,EAAW,EAAE;IAClD,wBAAwB;IACxB,IAAI,OAAO,KAAK,KAAK,UAAU,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;QACvD,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,8BAA8B;IAC9B,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QAC9B,OAAO,KAAK,CAAC,QAAQ,EAAE,CAAC;IAC1B,CAAC;IAED,yCAAyC;IACzC,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QAC9B,OAAO,GAAG,KAAK,CAAC,QAAQ,EAAE,GAAG,CAAC;IAChC,CAAC;IAED,IAAI,IAAA,eAAG,EAAC,KAAK,EAAE,MAAM,CAAC,EAAE,CAAC;QACvB,OAAO,KAAK,CAAC,QAAQ,EAAE,CAAC;IAC1B,CAAC;IAED,IAAI,IAAA,eAAG,EAAC,KAAK,EAAE,IAAI,CAAC,EAAE,CAAC;QACrB,OAAO,KAAK,CAAC,WAAW,EAAE,CAAC;IAC7B,CAAC;IAED,IAAI,IAAA,mBAAO,EAAC,KAAK,CAAC,EAAE,CAAC;QACnB,MAAM,UAAU,GAA4B;YAC1C,OAAO,EAAE,KAAK,CAAC,OAAO;YACtB,IAAI,EAAE,KAAK,CAAC,IAAI;SACjB,CAAC;QAEF,sCAAsC;QACtC,KAAK,MAAM,IAAI,IAAI,mBAAmB,CAAC,KAAK,CAAC,EAAE,CAAC;YAC9C,IAAI,IAAI,KAAK,OAAO,EAAE,CAAC;gBACrB,sEAAsE;gBACtE,UAAU,CAAC,IAAI,CAAC,GAAI,KAAa,CAAC,IAAI,CAAC,CAAC;YAC1C,CAAC;QACH,CAAC;QAED,OAAO,UAAU,CAAC;IACpB,CAAC;IAED,0BAA0B;IAC1B,IAAI,IAAA,eAAG,EAAC,KAAK,EAAE,GAAG,CAAC,EAAE,CAAC;QACpB,OAAO;YACL,MAAM,EAAE,KAAK;YACb,OAAO,EAAE,CAAC,GAAG,KAAK,CAAC,OAAO,EAAE,CAAC;SAC9B,CAAC;IACJ,CAAC;IAED,eAAe;IACf,IAAI,IAAA,eAAG,EAAC,KAAK,EAAE,GAAG,CAAC,EAAE,CAAC;QACpB,OAAO;YACL,MAAM,EAAE,KAAK;YACb,MAAM,EAAE,CAAC,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC;SAC5B,CAAC;IACJ,CAAC;IAED,OAAO,KAAK,CAAC;AACf,CAAC,CAAC;AAEF;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,cAAc,GAAG,CACrB,KAAc,EACd,QAAqC,EAC5B,EAAE;IACX,MAAM,IAAI,GAAG,IAAI,OAAO,EAAU,CAAC;IAEnC;;OAEG;IACH,MAAM,KAAK,GAAG,CAAC,GAAY,EAAW,EAAE;QACtC,+CAA+C;QAC/C,MAAM,QAAQ,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAC;QAE/B,mDAAmD;QACnD,IAAI,QAAQ,KAAK,GAAG,EAAE,CAAC;YACrB,4DAA4D;YAC5D,IAAI,OAAO,QAAQ,KAAK,QAAQ,IAAI,QAAQ,KAAK,IAAI,EAAE,CAAC;gBACtD,GAAG,GAAG,QAAQ,CAAC;YACjB,CAAC;iBAAM,CAAC;gBACN,oDAAoD;gBACpD,OAAO,QAAQ,CAAC;YAClB,CAAC;QACH,CAAC;QAED,+BAA+B;QAC/B,IAAI,OAAO,GAAG,KAAK,QAAQ,IAAI,GAAG,KAAK,IAAI,EAAE,CAAC;YAC5C,OAAO,GAAG,CAAC;QACb,CAAC;QAED,yCAAyC;QACzC,IAAI,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC;YAClB,OAAO,YAAY,CAAC;QACtB,CAAC;QAED,eAAe;QACf,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAEd,gBAAgB;QAChB,IAAI,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC;YACjB,OAAO,GAAG,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC;QACxC,CAAC;QAED,uBAAuB;QACvB,MAAM,MAAM,GAA4B,EAAE,CAAC;QAC3C,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC;YACxC,MAAM,OAAO,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC;YAC7B,wDAAwD;YACxD,IAAI,OAAO,KAAK,SAAS,EAAE,CAAC;gBAC1B,MAAM,CAAC,GAAG,CAAC,GAAG,OAAO,CAAC;YACxB,CAAC;QACH,CAAC;QACD,OAAO,MAAM,CAAC;IAChB,CAAC,CAAC;IAEF,OAAO,KAAK,CAAC,KAAK,CAAC,CAAC;AACtB,CAAC,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA0CG;AACI,MAAM,iBAAiB,GAAG,CAC/B,KAAc,EACd,UAA6B,EAAE,EACvB,EAAE;IACV,MAAM,EAAE,QAAQ,GAAG,eAAe,EAAE,GAAG,OAAO,CAAC;IAE/C,gDAAgD;IAChD,MAAM,SAAS,GAAG,cAAc,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;IAClD,+DAA+D;IAC/D,OAAO,MAAM,CAAC,IAAA,+BAAS,EAAC,SAAS,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;AACpD,CAAC,CAAC;AAVW,QAAA,iBAAiB,qBAU5B;AAEF;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACI,MAAM,4BAA4B,GAAG,CAAC,KAAc,EAAU,EAAE;IACrE,8DAA8D;IAC9D,OAAO,IAAA,yBAAiB,EAAC,KAAK,CAAC,CAAC;AAClC,CAAC,CAAC;AAHW,QAAA,4BAA4B,gCAGvC"}

package/dist/snapshot/serializer.d.cts

@@ -1,126 +0,0 @@
-/**
- * Serialization utilities for converting values to snapshot strings.
- *
- * Provides default serialization logic that handles:
- *
- * - Circular references
- * - Non-JSON types (Functions, Symbols, BigInt, etc.)
- * - Error objects
- * - Map and Set collections
- * - Key sorting for deterministic output
- *
- * @packageDocumentation
- */
-/**
- * Options for the default serializer.
- */
-export interface SerializerOptions {
-    /**
-     * Maximum depth for nested objects.
-     *
-     * Deeper objects will be replaced with `[Object]` or `[Array]`.
-     *
-     * @default Infinity
-     */
-    depth?: number;
-    /**
-     * Custom replacer for non-serializable values.
-     *
-     * This function is called for each value during serialization and can
-     * transform or filter values before they're converted to JSON.
-     *
-     * @example
-     *
-     * ```typescript
-     * replacer: (value) => {
-     *   // Redact secrets
-     *   if (typeof value === 'object' && value && 'password' in value) {
-     *     return { ...value, password: '[REDACTED]' };
-     *   }
-     *   return value;
-     * };
-     * ```
-     *
-     * @param value - The value to process
-     * @returns The transformed value, or `undefined` to omit
-     */
-    replacer?: (value: unknown) => unknown;
-    /**
-     * Whether to sort object keys alphabetically.
-     *
-     * This ensures deterministic output regardless of property insertion order.
-     *
-     * @default true
-     */
-    sortKeys?: boolean;
-}
-/**
- * Default serializer using JSON.stringify with custom handling.
- *
- * This serializer provides robust handling of JavaScript values including:
- *
- * - Circular reference detection
- * - Non-JSON type conversion
- * - Optional key sorting for deterministic output
- * - Custom replacer support
- *
- * The output is formatted with 2-space indentation for readability.
- *
- * @example
- *
- * ```typescript
- * const obj = { b: 2, a: 1, date: new Date('2025-01-01') };
- * defaultSerializer(obj, { sortKeys: true });
- * // Returns:
- * // {
- * //   "a": 1,
- * //   "b": 2,
- * //   "date": "2025-01-01T00:00:00.000Z"
- * // }
- * ```
- *
- * @example
- *
- * ```typescript
- * const circular: any = { a: 1 };
- * circular.self = circular;
- * defaultSerializer(circular);
- * // Returns:
- * // {
- * //   "a": 1,
- * //   "self": "[Circular]"
- * // }
- * ```
- *
- * @function
- * @param value - Value to serialize
- * @param options - Serialization options
- * @returns JSON string representation
- */
-export declare const defaultSerializer: (value: unknown, options?: SerializerOptions) => string;
-/**
- * Serializer compatible with node:test's snapshot format.
- *
- * This is currently an alias for {@link defaultSerializer}, but exists as a
- * separate export to allow for future node:test-specific customization.
- *
- * @example
- *
- * ```typescript
- * import test from 'node:test';
- * import { nodeTestCompatibleSerializer } from 'bupkis/snapshot';
- *
- * test('my test', (t) => {
- *   const data = { foo: 'bar' };
- *   expect(data, 'to match snapshot', t, {
- *     serializer: nodeTestCompatibleSerializer,
- *   });
- * });
- * ```
- *
- * @function
- * @param value - Value to serialize
- * @returns JSON string representation
- */
-export declare const nodeTestCompatibleSerializer: (value: unknown) => string;
-//# sourceMappingURL=serializer.d.ts.map

package/dist/snapshot/serializer.d.cts.map

@@ -1 +0,0 @@
-{"version":3,"file":"serializer.d.ts","sourceRoot":"","sources":["../../src/snapshot/serializer.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AASH;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC;;;;;;OAMG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,QAAQ,CAAC,EAAE,CAAC,KAAK,EAAE,OAAO,KAAK,OAAO,CAAC;IAEvC;;;;;;OAMG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB;AAsKD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA0CG;AACH,eAAO,MAAM,iBAAiB,GAC5B,OAAO,OAAO,EACd,UAAS,iBAAsB,KAC9B,MAOF,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,eAAO,MAAM,4BAA4B,GAAI,OAAO,OAAO,KAAG,MAG7D,CAAC"}

package/dist/snapshot/serializer.d.ts

@@ -1,126 +0,0 @@
-/**
- * Serialization utilities for converting values to snapshot strings.
- *
- * Provides default serialization logic that handles:
- *
- * - Circular references
- * - Non-JSON types (Functions, Symbols, BigInt, etc.)
- * - Error objects
- * - Map and Set collections
- * - Key sorting for deterministic output
- *
- * @packageDocumentation
- */
-/**
- * Options for the default serializer.
- */
-export interface SerializerOptions {
-    /**
-     * Maximum depth for nested objects.
-     *
-     * Deeper objects will be replaced with `[Object]` or `[Array]`.
-     *
-     * @default Infinity
-     */
-    depth?: number;
-    /**
-     * Custom replacer for non-serializable values.
-     *
-     * This function is called for each value during serialization and can
-     * transform or filter values before they're converted to JSON.
-     *
-     * @example
-     *
-     * ```typescript
-     * replacer: (value) => {
-     *   // Redact secrets
-     *   if (typeof value === 'object' && value && 'password' in value) {
-     *     return { ...value, password: '[REDACTED]' };
-     *   }
-     *   return value;
-     * };
-     * ```
-     *
-     * @param value - The value to process
-     * @returns The transformed value, or `undefined` to omit
-     */
-    replacer?: (value: unknown) => unknown;
-    /**
-     * Whether to sort object keys alphabetically.
-     *
-     * This ensures deterministic output regardless of property insertion order.
-     *
-     * @default true
-     */
-    sortKeys?: boolean;
-}
-/**
- * Default serializer using JSON.stringify with custom handling.
- *
- * This serializer provides robust handling of JavaScript values including:
- *
- * - Circular reference detection
- * - Non-JSON type conversion
- * - Optional key sorting for deterministic output
- * - Custom replacer support
- *
- * The output is formatted with 2-space indentation for readability.
- *
- * @example
- *
- * ```typescript
- * const obj = { b: 2, a: 1, date: new Date('2025-01-01') };
- * defaultSerializer(obj, { sortKeys: true });
- * // Returns:
- * // {
- * //   "a": 1,
- * //   "b": 2,
- * //   "date": "2025-01-01T00:00:00.000Z"
- * // }
- * ```
- *
- * @example
- *
- * ```typescript
- * const circular: any = { a: 1 };
- * circular.self = circular;
- * defaultSerializer(circular);
- * // Returns:
- * // {
- * //   "a": 1,
- * //   "self": "[Circular]"
- * // }
- * ```
- *
- * @function
- * @param value - Value to serialize
- * @param options - Serialization options
- * @returns JSON string representation
- */
-export declare const defaultSerializer: (value: unknown, options?: SerializerOptions) => string;
-/**
- * Serializer compatible with node:test's snapshot format.
- *
- * This is currently an alias for {@link defaultSerializer}, but exists as a
- * separate export to allow for future node:test-specific customization.
- *
- * @example
- *
- * ```typescript
- * import test from 'node:test';
- * import { nodeTestCompatibleSerializer } from 'bupkis/snapshot';
- *
- * test('my test', (t) => {
- *   const data = { foo: 'bar' };
- *   expect(data, 'to match snapshot', t, {
- *     serializer: nodeTestCompatibleSerializer,
- *   });
- * });
- * ```
- *
- * @function
- * @param value - Value to serialize
- * @returns JSON string representation
- */
-export declare const nodeTestCompatibleSerializer: (value: unknown) => string;
-//# sourceMappingURL=serializer.d.ts.map

package/dist/snapshot/serializer.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"serializer.d.ts","sourceRoot":"","sources":["../../src/snapshot/serializer.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AASH;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC;;;;;;OAMG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,QAAQ,CAAC,EAAE,CAAC,KAAK,EAAE,OAAO,KAAK,OAAO,CAAC;IAEvC;;;;;;OAMG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB;AAsKD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA0CG;AACH,eAAO,MAAM,iBAAiB,GAC5B,OAAO,OAAO,EACd,UAAS,iBAAsB,KAC9B,MAOF,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,eAAO,MAAM,4BAA4B,GAAI,OAAO,OAAO,KAAG,MAG7D,CAAC"}