bupkis 0.18.2 → 1.0.0

package/dist/snapshot/serializer.js

@@ -0,0 +1,237 @@
+/**
+ * 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
+ */
+const { entries, getOwnPropertyNames } = Object;
+const { isArray } = Array;
+import stringify from 'json-stable-stringify';
+import { isA, isError } from "../guards.js";
+/**
+ * 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 (isA(value, RegExp)) {
+        return value.toString();
+    }
+    if (isA(value, Date)) {
+        return value.toISOString();
+    }
+    if (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 (isA(value, Map)) {
+        return {
+            __type: 'Map',
+            entries: [...value.entries()],
+        };
+    }
+    // Set to array
+    if (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
+ */
+export 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(stringify(processed, { space: 2 }));
+};
+/**
+ * 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 const nodeTestCompatibleSerializer = (value) => 
+// Node:test expects the same format as our default serializer
+defaultSerializer(value);
+//# sourceMappingURL=serializer.js.map

package/dist/snapshot/serializer.js.map

@@ -0,0 +1 @@
+{"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,OAAO,SAAS,MAAM,uBAAuB,CAAC;AAE9C,OAAO,EAAE,GAAG,EAAE,OAAO,EAAE,qBAAqB;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,GAAG,CAAC,KAAK,EAAE,MAAM,CAAC,EAAE,CAAC;QACvB,OAAO,KAAK,CAAC,QAAQ,EAAE,CAAC;IAC1B,CAAC;IAED,IAAI,GAAG,CAAC,KAAK,EAAE,IAAI,CAAC,EAAE,CAAC;QACrB,OAAO,KAAK,CAAC,WAAW,EAAE,CAAC;IAC7B,CAAC;IAED,IAAI,OAAO,CAAC,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,GAAG,CAAC,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,GAAG,CAAC,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;AACH,MAAM,CAAC,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,SAAS,CAAC,SAAS,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;AACpD,CAAC,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,MAAM,CAAC,MAAM,4BAA4B,GAAG,CAAC,KAAc,EAAU,EAAE;AACrE,8DAA8D;AAC9D,iBAAiB,CAAC,KAAK,CAAC,CAAC"}

package/dist/standard-schema.cjs

@@ -0,0 +1,13 @@
+"use strict";
+/**
+ * Standard Schema v1 specification types.
+ *
+ * These types define the Standard Schema interface that enables
+ * interoperability between different validation libraries (Zod, Valibot,
+ * ArkType, etc.).
+ *
+ * @packageDocumentation
+ * @see {@link https://standardschema.dev | Standard Schema Specification}
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=standard-schema.js.map

package/dist/standard-schema.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"standard-schema.js","sourceRoot":"","sources":["../src/standard-schema.ts"],"names":[],"mappings":";AAAA;;;;;;;;;GASG"}

package/dist/standard-schema.d.cts

@@ -0,0 +1,192 @@
+/**
+ * Standard Schema v1 specification types.
+ *
+ * These types define the Standard Schema interface that enables
+ * interoperability between different validation libraries (Zod, Valibot,
+ * ArkType, etc.).
+ *
+ * @packageDocumentation
+ * @see {@link https://standardschema.dev | Standard Schema Specification}
+ */
+/**
+ * The Standard Schema interface.
+ *
+ * This is the primary interface that validation libraries implement to be
+ * Standard Schema compliant. The interface is designed to be minimal and
+ * non-invasive, tucked behind the `~standard` property to avoid API conflicts.
+ *
+ * @template Input - The input type accepted by the schema
+ * @template Output - The output type produced after successful validation
+ */
+export interface StandardSchemaV1<Input = unknown, Output = Input> {
+    /**
+     * The Standard Schema properties.
+     *
+     * This property uses a tilde prefix to:
+     *
+     * - Avoid conflicts with existing library APIs
+     * - De-prioritize in IDE autocomplete (tilde sorts after alphanumeric)
+     * - Signal special/internal nature of the property
+     */
+    readonly '~standard': StandardSchemaV1.Props<Input, Output>;
+}
+export declare namespace StandardSchemaV1 {
+    /**
+     * The result interface if validation fails.
+     *
+     * Contains an array of issues describing what went wrong during validation.
+     */
+    interface FailureResult {
+        /**
+         * The issues of failed validation.
+         *
+         * Always present and non-empty when validation fails.
+         */
+        readonly issues: ReadonlyArray<Issue>;
+    }
+    /**
+     * Infers the input type of a Standard Schema.
+     *
+     * Utility type for extracting the input type from a schema instance.
+     *
+     * @template Schema - The Standard Schema to extract the input type from
+     */
+    type InferInput<Schema extends StandardSchemaV1> = NonNullable<Schema['~standard']['types']>['input'];
+    /**
+     * Infers the output type of a Standard Schema.
+     *
+     * Utility type for extracting the output type from a schema instance.
+     *
+     * @template Schema - The Standard Schema to extract the output type from
+     */
+    type InferOutput<Schema extends StandardSchemaV1> = NonNullable<Schema['~standard']['types']>['output'];
+    /**
+     * The issue interface of the failure output.
+     *
+     * Describes a single validation problem, including a human-readable message
+     * and optional path to the problematic value in nested structures.
+     */
+    interface Issue {
+        /**
+         * The error message of the issue.
+         *
+         * Human-readable description of what validation rule was violated.
+         */
+        readonly message: string;
+        /**
+         * The path of the issue, if any.
+         *
+         * For nested structures, indicates where in the object/array hierarchy the
+         * validation failed. Can contain property keys or path segment objects.
+         */
+        readonly path?: ReadonlyArray<PathSegment | PropertyKey> | undefined;
+    }
+    /**
+     * The path segment interface of the issue.
+     *
+     * Allows path elements to carry additional metadata beyond just the key.
+     */
+    interface PathSegment {
+        /**
+         * The key representing a path segment.
+         *
+         * Can be a string, number, or symbol identifying the path component.
+         */
+        readonly key: PropertyKey;
+    }
+    /**
+     * The Standard Schema properties interface.
+     *
+     * Contains the actual validation logic and metadata required by the spec.
+     *
+     * @template Input - The input type accepted by the schema
+     * @template Output - The output type produced after successful validation
+     */
+    interface Props<Input = unknown, Output = Input> {
+        /**
+         * Inferred types associated with the schema.
+         *
+         * Optional property that allows TypeScript type inference for the schema.
+         * Not all libraries may provide this.
+         */
+        readonly types?: Types<Input, Output> | undefined;
+        /**
+         * Validates unknown input values.
+         *
+         * This function performs validation and returns either a success result
+         * with the validated/transformed data, or a failure result with validation
+         * issues. May return a Promise for async validation.
+         *
+         * @param value - The unknown value to validate
+         * @returns Result object or Promise resolving to result object
+         */
+        readonly validate: (value: unknown) => Promise<Result<Output>> | Result<Output>;
+        /**
+         * The vendor name of the schema library.
+         *
+         * Examples: 'zod', 'valibot', 'arktype', 'yup', etc.
+         */
+        readonly vendor: string;
+        /**
+         * The version number of the standard.
+         *
+         * Currently only version 1 is defined. Future versions will increment this
+         * number to maintain backward compatibility.
+         */
+        readonly version: 1;
+    }
+    /**
+     * The result interface of the validate function.
+     *
+     * A discriminated union that represents either successful or failed
+     * validation.
+     */
+    type Result<Output> = FailureResult | SuccessResult<Output>;
+    /**
+     * The result interface if validation succeeds.
+     *
+     * Contains the validated/transformed output value and explicitly sets
+     * `issues` to undefined to distinguish from failure results.
+     *
+     * @template Output - The output type after successful validation
+     */
+    interface SuccessResult<Output> {
+        /**
+         * The non-existent issues.
+         *
+         * Explicitly undefined to create a discriminated union with FailureResult.
+         */
+        readonly issues?: undefined;
+        /**
+         * The typed output value.
+         *
+         * This may be the same as the input or a transformed version, depending on
+         * the schema's validation logic.
+         */
+        readonly value: Output;
+    }
+    /**
+     * The Standard Schema types interface.
+     *
+     * Provides TypeScript type information for schemas that support type
+     * inference.
+     *
+     * @template Input - The input type of the schema
+     * @template Output - The output type of the schema
+     */
+    interface Types<Input = unknown, Output = Input> {
+        /**
+         * The input type of the schema.
+         *
+         * The type of values that can be passed to the validate function.
+         */
+        readonly input: Input;
+        /**
+         * The output type of the schema.
+         *
+         * The type of values produced after successful validation.
+         */
+        readonly output: Output;
+    }
+}
+//# sourceMappingURL=standard-schema.d.ts.map

package/dist/standard-schema.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"standard-schema.d.ts","sourceRoot":"","sources":["../src/standard-schema.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAEH;;;;;;;;;GASG;AACH,MAAM,WAAW,gBAAgB,CAAC,KAAK,GAAG,OAAO,EAAE,MAAM,GAAG,KAAK;IAC/D;;;;;;;;OAQG;IACH,QAAQ,CAAC,WAAW,EAAE,gBAAgB,CAAC,KAAK,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;CAC7D;AAGD,MAAM,CAAC,OAAO,WAAW,gBAAgB,CAAC;IACxC;;;;OAIG;IACH,UAAiB,aAAa;QAC5B;;;;WAIG;QACH,QAAQ,CAAC,MAAM,EAAE,aAAa,CAAC,KAAK,CAAC,CAAC;KACvC;IAED;;;;;;OAMG;IACH,KAAY,UAAU,CAAC,MAAM,SAAS,gBAAgB,IAAI,WAAW,CACnE,MAAM,CAAC,WAAW,CAAC,CAAC,OAAO,CAAC,CAC7B,CAAC,OAAO,CAAC,CAAC;IAEX;;;;;;OAMG;IACH,KAAY,WAAW,CAAC,MAAM,SAAS,gBAAgB,IAAI,WAAW,CACpE,MAAM,CAAC,WAAW,CAAC,CAAC,OAAO,CAAC,CAC7B,CAAC,QAAQ,CAAC,CAAC;IAEZ;;;;;OAKG;IACH,UAAiB,KAAK;QACpB;;;;WAIG;QACH,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;QAEzB;;;;;WAKG;QACH,QAAQ,CAAC,IAAI,CAAC,EAAE,aAAa,CAAC,WAAW,GAAG,WAAW,CAAC,GAAG,SAAS,CAAC;KACtE;IAED;;;;OAIG;IACH,UAAiB,WAAW;QAC1B;;;;WAIG;QACH,QAAQ,CAAC,GAAG,EAAE,WAAW,CAAC;KAC3B;IAED;;;;;;;OAOG;IACH,UAAiB,KAAK,CAAC,KAAK,GAAG,OAAO,EAAE,MAAM,GAAG,KAAK;QACpD;;;;;WAKG;QACH,QAAQ,CAAC,KAAK,CAAC,EAAE,KAAK,CAAC,KAAK,EAAE,MAAM,CAAC,GAAG,SAAS,CAAC;QAElD;;;;;;;;;WASG;QACH,QAAQ,CAAC,QAAQ,EAAE,CACjB,KAAK,EAAE,OAAO,KACX,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC;QAE9C;;;;WAIG;QACH,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;QAExB;;;;;WAKG;QACH,QAAQ,CAAC,OAAO,EAAE,CAAC,CAAC;KACrB;IAED;;;;;OAKG;IACH,KAAY,MAAM,CAAC,MAAM,IAAI,aAAa,GAAG,aAAa,CAAC,MAAM,CAAC,CAAC;IAEnE;;;;;;;OAOG;IACH,UAAiB,aAAa,CAAC,MAAM;QACnC;;;;WAIG;QACH,QAAQ,CAAC,MAAM,CAAC,EAAE,SAAS,CAAC;QAE5B;;;;;WAKG;QACH,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;KACxB;IAED;;;;;;;;OAQG;IACH,UAAiB,KAAK,CAAC,KAAK,GAAG,OAAO,EAAE,MAAM,GAAG,KAAK;QACpD;;;;WAIG;QACH,QAAQ,CAAC,KAAK,EAAE,KAAK,CAAC;QAEtB;;;;WAIG;QACH,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;KACzB;CACF"}

package/dist/standard-schema.d.ts

@@ -0,0 +1,192 @@
+/**
+ * Standard Schema v1 specification types.
+ *
+ * These types define the Standard Schema interface that enables
+ * interoperability between different validation libraries (Zod, Valibot,
+ * ArkType, etc.).
+ *
+ * @packageDocumentation
+ * @see {@link https://standardschema.dev | Standard Schema Specification}
+ */
+/**
+ * The Standard Schema interface.
+ *
+ * This is the primary interface that validation libraries implement to be
+ * Standard Schema compliant. The interface is designed to be minimal and
+ * non-invasive, tucked behind the `~standard` property to avoid API conflicts.
+ *
+ * @template Input - The input type accepted by the schema
+ * @template Output - The output type produced after successful validation
+ */
+export interface StandardSchemaV1<Input = unknown, Output = Input> {
+    /**
+     * The Standard Schema properties.
+     *
+     * This property uses a tilde prefix to:
+     *
+     * - Avoid conflicts with existing library APIs
+     * - De-prioritize in IDE autocomplete (tilde sorts after alphanumeric)
+     * - Signal special/internal nature of the property
+     */
+    readonly '~standard': StandardSchemaV1.Props<Input, Output>;
+}
+export declare namespace StandardSchemaV1 {
+    /**
+     * The result interface if validation fails.
+     *
+     * Contains an array of issues describing what went wrong during validation.
+     */
+    interface FailureResult {
+        /**
+         * The issues of failed validation.
+         *
+         * Always present and non-empty when validation fails.
+         */
+        readonly issues: ReadonlyArray<Issue>;
+    }
+    /**
+     * Infers the input type of a Standard Schema.
+     *
+     * Utility type for extracting the input type from a schema instance.
+     *
+     * @template Schema - The Standard Schema to extract the input type from
+     */
+    type InferInput<Schema extends StandardSchemaV1> = NonNullable<Schema['~standard']['types']>['input'];
+    /**
+     * Infers the output type of a Standard Schema.
+     *
+     * Utility type for extracting the output type from a schema instance.
+     *
+     * @template Schema - The Standard Schema to extract the output type from
+     */
+    type InferOutput<Schema extends StandardSchemaV1> = NonNullable<Schema['~standard']['types']>['output'];
+    /**
+     * The issue interface of the failure output.
+     *
+     * Describes a single validation problem, including a human-readable message
+     * and optional path to the problematic value in nested structures.
+     */
+    interface Issue {
+        /**
+         * The error message of the issue.
+         *
+         * Human-readable description of what validation rule was violated.
+         */
+        readonly message: string;
+        /**
+         * The path of the issue, if any.
+         *
+         * For nested structures, indicates where in the object/array hierarchy the
+         * validation failed. Can contain property keys or path segment objects.
+         */
+        readonly path?: ReadonlyArray<PathSegment | PropertyKey> | undefined;
+    }
+    /**
+     * The path segment interface of the issue.
+     *
+     * Allows path elements to carry additional metadata beyond just the key.
+     */
+    interface PathSegment {
+        /**
+         * The key representing a path segment.
+         *
+         * Can be a string, number, or symbol identifying the path component.
+         */
+        readonly key: PropertyKey;
+    }
+    /**
+     * The Standard Schema properties interface.
+     *
+     * Contains the actual validation logic and metadata required by the spec.
+     *
+     * @template Input - The input type accepted by the schema
+     * @template Output - The output type produced after successful validation
+     */
+    interface Props<Input = unknown, Output = Input> {
+        /**
+         * Inferred types associated with the schema.
+         *
+         * Optional property that allows TypeScript type inference for the schema.
+         * Not all libraries may provide this.
+         */
+        readonly types?: Types<Input, Output> | undefined;
+        /**
+         * Validates unknown input values.
+         *
+         * This function performs validation and returns either a success result
+         * with the validated/transformed data, or a failure result with validation
+         * issues. May return a Promise for async validation.
+         *
+         * @param value - The unknown value to validate
+         * @returns Result object or Promise resolving to result object
+         */
+        readonly validate: (value: unknown) => Promise<Result<Output>> | Result<Output>;
+        /**
+         * The vendor name of the schema library.
+         *
+         * Examples: 'zod', 'valibot', 'arktype', 'yup', etc.
+         */
+        readonly vendor: string;
+        /**
+         * The version number of the standard.
+         *
+         * Currently only version 1 is defined. Future versions will increment this
+         * number to maintain backward compatibility.
+         */
+        readonly version: 1;
+    }
+    /**
+     * The result interface of the validate function.
+     *
+     * A discriminated union that represents either successful or failed
+     * validation.
+     */
+    type Result<Output> = FailureResult | SuccessResult<Output>;
+    /**
+     * The result interface if validation succeeds.
+     *
+     * Contains the validated/transformed output value and explicitly sets
+     * `issues` to undefined to distinguish from failure results.
+     *
+     * @template Output - The output type after successful validation
+     */
+    interface SuccessResult<Output> {
+        /**
+         * The non-existent issues.
+         *
+         * Explicitly undefined to create a discriminated union with FailureResult.
+         */
+        readonly issues?: undefined;
+        /**
+         * The typed output value.
+         *
+         * This may be the same as the input or a transformed version, depending on
+         * the schema's validation logic.
+         */
+        readonly value: Output;
+    }
+    /**
+     * The Standard Schema types interface.
+     *
+     * Provides TypeScript type information for schemas that support type
+     * inference.
+     *
+     * @template Input - The input type of the schema
+     * @template Output - The output type of the schema
+     */
+    interface Types<Input = unknown, Output = Input> {
+        /**
+         * The input type of the schema.
+         *
+         * The type of values that can be passed to the validate function.
+         */
+        readonly input: Input;
+        /**
+         * The output type of the schema.
+         *
+         * The type of values produced after successful validation.
+         */
+        readonly output: Output;
+    }
+}
+//# sourceMappingURL=standard-schema.d.ts.map

package/dist/standard-schema.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"standard-schema.d.ts","sourceRoot":"","sources":["../src/standard-schema.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAEH;;;;;;;;;GASG;AACH,MAAM,WAAW,gBAAgB,CAAC,KAAK,GAAG,OAAO,EAAE,MAAM,GAAG,KAAK;IAC/D;;;;;;;;OAQG;IACH,QAAQ,CAAC,WAAW,EAAE,gBAAgB,CAAC,KAAK,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;CAC7D;AAGD,MAAM,CAAC,OAAO,WAAW,gBAAgB,CAAC;IACxC;;;;OAIG;IACH,UAAiB,aAAa;QAC5B;;;;WAIG;QACH,QAAQ,CAAC,MAAM,EAAE,aAAa,CAAC,KAAK,CAAC,CAAC;KACvC;IAED;;;;;;OAMG;IACH,KAAY,UAAU,CAAC,MAAM,SAAS,gBAAgB,IAAI,WAAW,CACnE,MAAM,CAAC,WAAW,CAAC,CAAC,OAAO,CAAC,CAC7B,CAAC,OAAO,CAAC,CAAC;IAEX;;;;;;OAMG;IACH,KAAY,WAAW,CAAC,MAAM,SAAS,gBAAgB,IAAI,WAAW,CACpE,MAAM,CAAC,WAAW,CAAC,CAAC,OAAO,CAAC,CAC7B,CAAC,QAAQ,CAAC,CAAC;IAEZ;;;;;OAKG;IACH,UAAiB,KAAK;QACpB;;;;WAIG;QACH,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;QAEzB;;;;;WAKG;QACH,QAAQ,CAAC,IAAI,CAAC,EAAE,aAAa,CAAC,WAAW,GAAG,WAAW,CAAC,GAAG,SAAS,CAAC;KACtE;IAED;;;;OAIG;IACH,UAAiB,WAAW;QAC1B;;;;WAIG;QACH,QAAQ,CAAC,GAAG,EAAE,WAAW,CAAC;KAC3B;IAED;;;;;;;OAOG;IACH,UAAiB,KAAK,CAAC,KAAK,GAAG,OAAO,EAAE,MAAM,GAAG,KAAK;QACpD;;;;;WAKG;QACH,QAAQ,CAAC,KAAK,CAAC,EAAE,KAAK,CAAC,KAAK,EAAE,MAAM,CAAC,GAAG,SAAS,CAAC;QAElD;;;;;;;;;WASG;QACH,QAAQ,CAAC,QAAQ,EAAE,CACjB,KAAK,EAAE,OAAO,KACX,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC;QAE9C;;;;WAIG;QACH,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;QAExB;;;;;WAKG;QACH,QAAQ,CAAC,OAAO,EAAE,CAAC,CAAC;KACrB;IAED;;;;;OAKG;IACH,KAAY,MAAM,CAAC,MAAM,IAAI,aAAa,GAAG,aAAa,CAAC,MAAM,CAAC,CAAC;IAEnE;;;;;;;OAOG;IACH,UAAiB,aAAa,CAAC,MAAM;QACnC;;;;WAIG;QACH,QAAQ,CAAC,MAAM,CAAC,EAAE,SAAS,CAAC;QAE5B;;;;;WAKG;QACH,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;KACxB;IAED;;;;;;;;OAQG;IACH,UAAiB,KAAK,CAAC,KAAK,GAAG,OAAO,EAAE,MAAM,GAAG,KAAK;QACpD;;;;WAIG;QACH,QAAQ,CAAC,KAAK,EAAE,KAAK,CAAC;QAEtB;;;;WAIG;QACH,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;KACzB;CACF"}

package/dist/standard-schema.js

@@ -0,0 +1,12 @@
+/**
+ * Standard Schema v1 specification types.
+ *
+ * These types define the Standard Schema interface that enables
+ * interoperability between different validation libraries (Zod, Valibot,
+ * ArkType, etc.).
+ *
+ * @packageDocumentation
+ * @see {@link https://standardschema.dev | Standard Schema Specification}
+ */
+export {};
+//# sourceMappingURL=standard-schema.js.map

package/dist/standard-schema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"standard-schema.js","sourceRoot":"","sources":["../src/standard-schema.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG"}