bupkis 0.1.2 → 0.3.0

package/dist/commonjs/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAGH,mBAAmB,UAAU,CAAC;AAE9B,OAAO,KAAK,SAAS,MAAM,sBAAsB,CAAC;AAClD,OAAO,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAErD,OAAO,KAAK,KAAK,MAAM,YAAY,CAAC;AACpC,OAAO,KAAK,MAAM,MAAM,aAAa,CAAC;AAEtC,YAAY,KAAK,QAAQ,MAAM,eAAe,CAAC;AAC/C,OAAO,KAAK,MAAM,MAAM,aAAa,CAAC;AACtC,YAAY,KAAK,KAAK,MAAM,YAAY,CAAC;AACzC,OAAO,KAAK,IAAI,MAAM,WAAW,CAAC;AAElC,OAAO,EAAE,CAAC,EAAE,MAAM,QAAQ,CAAC;AAE3B,OAAO,EAAE,eAAe,EAAE,oBAAoB,EAAE,IAAI,EAAE,GAAG,EAAE,CAAC;AAC5D,QAAA,MAAQ,eAAe,0DAAE,oBAAoB,+DAAE,IAAI,0CAAE,GAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;6ZACrC,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;GAgBG;AAEH,OAAO,EAAE,CAAC,EAAE,MAAM,QAAQ,CAAC;AAG3B,OAAO,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAErD,OAAO,EAAE,cAAc,EAAE,MAAM,YAAY,CAAC;AAE5C;;;;;;;;;GASG;AACH,YAAY,KAAK,KAAK,MAAM,YAAY,CAAC;AAEzC;;;GAGG;AACH,OAAO,EAAE,CAAC,EAAE,CAAC;AAEb;;GAEG;AACH,YAAY,EACV,MAAM,EACN,iBAAiB,EACjB,sBAAsB,EACtB,MAAM,EACN,WAAW,EACX,MAAM,EACN,KAAK,EACL,UAAU,GACX,MAAM,YAAY,CAAC;AACpB,OAAO,EAAE,eAAe,EAAE,oBAAoB,EAAE,IAAI,EAAE,GAAG,EAAE,CAAC;AAC5D,QAAA;AACE;;;;;;;GAOG;AACH,eAAe;AACf;;;;;;;GAOG;AACH,oBAAoB;AACpB;;;;GAIG;AACH,IAAI;AACJ;;;;GAIG;AACH,GAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;icAEgB,CAAC"}

package/dist/commonjs/index.js

@@ -7,54 +7,56 @@
  * guards, schema definitions, utility functions, and error types.
  *
  * @module bupkis
+ * @category API
+ * @example
+ *
+ * ```ts
+ * import { expect, expectAsync, z, createAssertion } from 'bupkis';
+ * ```
+ *
+ * @showGroups
  */
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || (function () {
-    var ownKeys = function(o) {
-        ownKeys = Object.getOwnPropertyNames || function (o) {
-            var ar = [];
-            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
-            return ar;
-        };
-        return ownKeys(o);
-    };
-    return function (mod) {
-        if (mod && mod.__esModule) return mod;
-        var result = {};
-        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
-        __setModuleDefault(result, mod);
-        return result;
-    };
-})();
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.use = exports.fail = exports.createAsyncAssertion = exports.createAssertion = exports.z = exports.util = exports.schema = exports.guards = exports.error = exports.expectAsync = exports.expect = exports.assertion = void 0;
+exports.use = exports.fail = exports.createAsyncAssertion = exports.createAssertion = exports.z = exports.AssertionError = exports.expectAsync = exports.expect = void 0;
+const v4_1 = require("zod/v4");
+Object.defineProperty(exports, "z", { enumerable: true, get: function () { return v4_1.z; } });
 const bootstrap_js_1 = require("./bootstrap.js");
-exports.assertion = __importStar(require("./assertion/index.js"));
 var bootstrap_js_2 = require("./bootstrap.js");
 Object.defineProperty(exports, "expect", { enumerable: true, get: function () { return bootstrap_js_2.expect; } });
 Object.defineProperty(exports, "expectAsync", { enumerable: true, get: function () { return bootstrap_js_2.expectAsync; } });
-exports.error = __importStar(require("./error.js"));
-exports.guards = __importStar(require("./guards.js"));
-exports.schema = __importStar(require("./schema.js"));
-exports.util = __importStar(require("./util.js"));
-var v4_1 = require("zod/v4");
-Object.defineProperty(exports, "z", { enumerable: true, get: function () { return v4_1.z; } });
-const { createAssertion, createAsyncAssertion, fail, use, ..._rest } = bootstrap_js_1.expect;
+var error_js_1 = require("./error.js");
+Object.defineProperty(exports, "AssertionError", { enumerable: true, get: function () { return error_js_1.AssertionError; } });
+const { 
+/**
+ * The main factory function for creating asynchronous assertions.
+ *
+ * Exported from the entry point; is also a property of {@link Expect} and
+ * {@link ExpectAsync}.
+ *
+ * @function
+ */
+createAssertion, 
+/**
+ * The main factory function for creating asynchronous assertions.
+ *
+ * Exported from the entry point; is also a property of {@link Expect} and
+ * {@link ExpectAsync}.
+ *
+ * @function
+ */
+createAsyncAssertion, 
+/**
+ * {@inheritDoc FailFn}
+ *
+ * @function
+ */
+fail, 
+/**
+ * {@inheritDoc UseFn}
+ *
+ * @function
+ */
+use, ..._rest } = bootstrap_js_1.expect;
 exports.createAssertion = createAssertion;
 exports.createAsyncAssertion = createAsyncAssertion;
 exports.fail = fail;

package/dist/commonjs/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";AAAA;;;;;;;;GAQG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAEH,iDAA6D;AAG7D,kEAAkD;AAClD,+CAAqD;AAA5C,sGAAA,MAAM,OAAA;AAAE,2GAAA,WAAW,OAAA;AAE5B,oDAAoC;AACpC,sDAAsC;AAGtC,sDAAsC;AAEtC,kDAAkC;AAElC,6BAA2B;AAAlB,uFAAA,CAAC,OAAA;AAGV,MAAM,EAAE,eAAe,EAAE,oBAAoB,EAAE,IAAI,EAAE,GAAG,EAAE,GAAG,KAAK,EAAE,GAClE,qBAAiB,CAAC;AAFX,0CAAe;AAAE,oDAAoB;AAAE,oBAAI;AAAE,kBAAG"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;GAgBG;;;AAEH,+BAA2B;AAuBlB,kFAvBA,MAAC,OAuBA;AArBV,iDAA6D;AAC7D,+CAAqD;AAA5C,sGAAA,MAAM,OAAA;AAAE,2GAAA,WAAW,OAAA;AAE5B,uCAA4C;AAAnC,0GAAA,cAAc,OAAA;AAkCvB,MAAM;AACJ;;;;;;;GAOG;AACH,eAAe;AACf;;;;;;;GAOG;AACH,oBAAoB;AACpB;;;;GAIG;AACH,IAAI;AACJ;;;;GAIG;AACH,GAAG,EACH,GAAG,KAAK,EACT,GAAG,qBAAiB,CAAC;AAjCb,0CAAe;AAAE,oDAAoB;AAAE,oBAAI;AAAE,kBAAG"}

package/dist/commonjs/metadata.d.ts

@@ -2,15 +2,9 @@
  * Defines Bupkis' Zod metadata registry
  *
  * @packageDocumentation
+ * @internal
  */
-import { z } from 'zod';
 import { kStringLiteral } from './constant.js';
-/**
- * Metadata stored in Zod registry
- *
- * @knipignore
- */
-export type BupkisMeta = z.infer<typeof BupkisRegistrySchema>;
 /**
  * Zod metadata registry for Bupkis
  */
@@ -30,24 +24,4 @@ export declare const BupkisRegistry: z.core.$ZodRegistry<{
     description?: string | undefined;
     name?: string | undefined;
 }, z.core.$ZodType<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>>;
-/**
- * Final schema for Bupkis registry
- */
-declare const BupkisRegistrySchema: z.ZodUnion<readonly [z.ZodObject<{
-    description: z.ZodOptional<z.ZodString>;
-    name: z.ZodOptional<z.ZodString>;
-}, z.core.$strip>, z.ZodObject<{
-    value: z.ZodString;
-    values: z.ZodOptional<z.ZodNever>;
-    [kStringLiteral]: z.ZodLiteral<true>;
-    description: z.ZodOptional<z.ZodString>;
-    name: z.ZodOptional<z.ZodString>;
-}, z.core.$strip>, z.ZodObject<{
-    value: z.ZodOptional<z.ZodNever>;
-    values: z.ZodReadonly<z.ZodTuple<[z.ZodString], z.ZodString>>;
-    [kStringLiteral]: z.ZodLiteral<true>;
-    description: z.ZodOptional<z.ZodString>;
-    name: z.ZodOptional<z.ZodString>;
-}, z.core.$strip>]>;
-export {};
 //# sourceMappingURL=metadata.d.ts.map

package/dist/commonjs/metadata.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"metadata.d.ts","sourceRoot":"","sources":["../../src/metadata.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,OAAO,EAAE,cAAc,EAAE,MAAM,eAAe,CAAC;AAE/C;;;;GAIG;AACH,MAAM,MAAM,UAAU,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAC;AAE9D;;GAEG;AACH,eAAO,MAAM,cAAc;;;;;;;;;;;;;;;iFAA2B,CAAC;AAqBvD;;GAEG;AAGH,QAAA,MAAM,oBAAoB;;;;;;;;;;;;;;;mBAaxB,CAAC"}
+{"version":3,"file":"metadata.d.ts","sourceRoot":"","sources":["../../src/metadata.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAIH,OAAO,EAAE,cAAc,EAAE,MAAM,eAAe,CAAC;AAO/C;;GAEG;AACH,eAAO,MAAM,cAAc;;;;;;;;;;;;;;;iFAA2B,CAAC"}

package/dist/commonjs/metadata.js

@@ -3,21 +3,22 @@
  * Defines Bupkis' Zod metadata registry
  *
  * @packageDocumentation
+ * @internal
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.BupkisRegistry = void 0;
-const zod_1 = require("zod");
+const v4_1 = require("zod/v4");
 const constant_js_1 = require("./constant.js");
 /**
  * Zod metadata registry for Bupkis
  */
-exports.BupkisRegistry = zod_1.z.registry();
+exports.BupkisRegistry = v4_1.z.registry();
 /**
  * Base schema for all metadata
  */
-const BaseBupkisMetadataSchema = zod_1.z.object({
-    description: zod_1.z.string().optional().describe('Human-friendly description'),
-    name: zod_1.z
+const BaseBupkisMetadataSchema = v4_1.z.object({
+    description: v4_1.z.string().optional().describe('Human-friendly description'),
+    name: v4_1.z
         .string()
         .optional()
         .describe('Internal name; used by Assertion.prototype.toString()'),
@@ -25,27 +26,27 @@ const BaseBupkisMetadataSchema = zod_1.z.object({
 /**
  * Base schema for metadata referring to string literal flag
  */
-const StringLiteralFlagSchema = zod_1.z.object({
+const StringLiteralFlagSchema = v4_1.z.object({
     ...BaseBupkisMetadataSchema.shape,
-    [constant_js_1.kStringLiteral]: zod_1.z.literal(true),
+    [constant_js_1.kStringLiteral]: v4_1.z.literal(true),
 });
 /**
  * Final schema for Bupkis registry
  */
 // TODO: Figure out how to make this rule allow type-only usage. Or just export it and tag it.
 // eslint-disable-next-line @typescript-eslint/no-unused-vars
-const BupkisRegistrySchema = zod_1.z.union([
-    zod_1.z.object({ ...BaseBupkisMetadataSchema.shape }),
-    zod_1.z.object({
+const BupkisRegistrySchema = v4_1.z.union([
+    v4_1.z.object({ ...BaseBupkisMetadataSchema.shape }),
+    v4_1.z.object({
         ...StringLiteralFlagSchema.shape,
-        value: zod_1.z.string(),
-        values: zod_1.z.never().optional(),
+        value: v4_1.z.string(),
+        values: v4_1.z.never().optional(),
     }),
-    zod_1.z.object({
+    v4_1.z.object({
         ...StringLiteralFlagSchema.shape,
-        value: zod_1.z.never().optional(),
+        value: v4_1.z.never().optional(),
         // eslint-disable-next-line no-restricted-syntax
-        values: zod_1.z.tuple([zod_1.z.string()]).rest(zod_1.z.string()).readonly(),
+        values: v4_1.z.tuple([v4_1.z.string()]).rest(v4_1.z.string()).readonly(),
     }),
 ]);
 //# sourceMappingURL=metadata.js.map

package/dist/commonjs/metadata.js.map

@@ -1 +1 @@
-{"version":3,"file":"metadata.js","sourceRoot":"","sources":["../../src/metadata.ts"],"names":[],"mappings":";AAAA;;;;GAIG;;;AAEH,6BAAwB;AAExB,+CAA+C;AAS/C;;GAEG;AACU,QAAA,cAAc,GAAG,OAAC,CAAC,QAAQ,EAAc,CAAC;AAEvD;;GAEG;AACH,MAAM,wBAAwB,GAAG,OAAC,CAAC,MAAM,CAAC;IACxC,WAAW,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,4BAA4B,CAAC;IACzE,IAAI,EAAE,OAAC;SACJ,MAAM,EAAE;SACR,QAAQ,EAAE;SACV,QAAQ,CAAC,uDAAuD,CAAC;CACrE,CAAC,CAAC;AAEH;;GAEG;AACH,MAAM,uBAAuB,GAAG,OAAC,CAAC,MAAM,CAAC;IACvC,GAAG,wBAAwB,CAAC,KAAK;IACjC,CAAC,4BAAc,CAAC,EAAE,OAAC,CAAC,OAAO,CAAC,IAAI,CAAC;CAClC,CAAC,CAAC;AAEH;;GAEG;AACH,8FAA8F;AAC9F,6DAA6D;AAC7D,MAAM,oBAAoB,GAAG,OAAC,CAAC,KAAK,CAAC;IACnC,OAAC,CAAC,MAAM,CAAC,EAAE,GAAG,wBAAwB,CAAC,KAAK,EAAE,CAAC;IAC/C,OAAC,CAAC,MAAM,CAAC;QACP,GAAG,uBAAuB,CAAC,KAAK;QAChC,KAAK,EAAE,OAAC,CAAC,MAAM,EAAE;QACjB,MAAM,EAAE,OAAC,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE;KAC7B,CAAC;IACF,OAAC,CAAC,MAAM,CAAC;QACP,GAAG,uBAAuB,CAAC,KAAK;QAChC,KAAK,EAAE,OAAC,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE;QAC3B,gDAAgD;QAChD,MAAM,EAAE,OAAC,CAAC,KAAK,CAAC,CAAC,OAAC,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,OAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;KAC1D,CAAC;CACH,CAAC,CAAC"}
+{"version":3,"file":"metadata.js","sourceRoot":"","sources":["../../src/metadata.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAEH,+BAA2B;AAE3B,+CAA+C;AAO/C;;GAEG;AACU,QAAA,cAAc,GAAG,MAAC,CAAC,QAAQ,EAAc,CAAC;AAEvD;;GAEG;AACH,MAAM,wBAAwB,GAAG,MAAC,CAAC,MAAM,CAAC;IACxC,WAAW,EAAE,MAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,4BAA4B,CAAC;IACzE,IAAI,EAAE,MAAC;SACJ,MAAM,EAAE;SACR,QAAQ,EAAE;SACV,QAAQ,CAAC,uDAAuD,CAAC;CACrE,CAAC,CAAC;AAEH;;GAEG;AACH,MAAM,uBAAuB,GAAG,MAAC,CAAC,MAAM,CAAC;IACvC,GAAG,wBAAwB,CAAC,KAAK;IACjC,CAAC,4BAAc,CAAC,EAAE,MAAC,CAAC,OAAO,CAAC,IAAI,CAAC;CAClC,CAAC,CAAC;AAEH;;GAEG;AACH,8FAA8F;AAC9F,6DAA6D;AAC7D,MAAM,oBAAoB,GAAG,MAAC,CAAC,KAAK,CAAC;IACnC,MAAC,CAAC,MAAM,CAAC,EAAE,GAAG,wBAAwB,CAAC,KAAK,EAAE,CAAC;IAC/C,MAAC,CAAC,MAAM,CAAC;QACP,GAAG,uBAAuB,CAAC,KAAK;QAChC,KAAK,EAAE,MAAC,CAAC,MAAM,EAAE;QACjB,MAAM,EAAE,MAAC,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE;KAC7B,CAAC;IACF,MAAC,CAAC,MAAM,CAAC;QACP,GAAG,uBAAuB,CAAC,KAAK;QAChC,KAAK,EAAE,MAAC,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE;QAC3B,gDAAgD;QAChD,MAAM,EAAE,MAAC,CAAC,KAAK,CAAC,CAAC,MAAC,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,MAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;KAC1D,CAAC;CACH,CAAC,CAAC"}

package/dist/commonjs/schema.d.ts

@@ -1,30 +1,49 @@
 /**
- * Zod schema definitions for common types and validation patterns.
+ * Arguably-useful Zod schemas for common types and validation patterns.
  *
  * This module provides reusable Zod schemas for validating constructors,
  * functions, property keys, promises, and other common JavaScript types used
- * throughout the assertion system. These tend to work around Zod's
- * limitations.
+ * throughout the assertion system. These tend to work around the impedance
+ * mismatch between **BUPKIS** and Zod.
  *
  * These are used internally, but consumers may also find them useful.
  *
- * @document schema.md
+ * For example, we have {@link FunctionSchema} which accepts any
+ * function—regardless of its signature. We need this because Zod v4's
+ * `z.function()` no longer returns a `ZodType` (ref:
+ * {@link https://zod.dev/v4/changelog | Zod v4 Migration Guide}) and so behaves
+ * differently. `FunctionSchema` allows us to work with functions as _values_
+ * instead of something to be implemented.
+ *
+ * Similarly—but not a new development—`z.promise()` does not parse a
+ * {@link Promise} object; it parses the _fulfilled value_. This is not what we
+ * want for "is a Promise" assertions, but it _can_ be useful for making sense
+ * of the fulfilled value. To solve this, we have
+ * {@link WrappedPromiseLikeSchema} (which explicitly supports
+ * {@link PromiseLike}/"thenable" objects).
+ *
+ * @category API
+ * @example
+ *
+ * ```ts
+ * import * as schema from 'bupkis/schema';
+ * ```
+ *
  * @packageDocumentation
  */
 import { z } from 'zod/v4';
-import { type Constructor } from './types.js';
+import { type Constructor, type MutableOrReadonly } from './types.js';
 /**
  * A Zod schema that validates JavaScript classes or constructor functions.
  *
  * This schema validates values that can be used as constructors, including ES6
  * classes, traditional constructor functions, and built-in constructors. It
- * uses the {@link isConstructable} guard function to determine if a value can be
+ * uses the {@link isConstructible} guard function to determine if a value can be
  * invoked with the `new` operator to create object instances.
  *
- * @remarks
+ * @privateRemarks
  * The schema is registered in the {@link BupkisRegistry} with the name
  * `ClassSchema` for later reference and type checking purposes.
- * @category Schema
  * @example
  *
  * ```typescript
@@ -38,6 +57,8 @@ import { type Constructor } from './types.js';
  * ClassSchema.parse(() => {}); // ✗ Throws validation error
  * ClassSchema.parse({}); // ✗ Throws validation error
  * ```
+ *
+ * @group Schema
  */
 export declare const ClassSchema: z.ZodCustom<Constructor, Constructor>;
 /**
@@ -49,10 +70,9 @@ export declare const ClassSchema: z.ZodCustom<Constructor, Constructor>;
  * including regular functions, arrow functions, async functions, generator
  * functions, and methods.
  *
- * @remarks
+ * @privateRemarks
  * The schema is registered in the {@link BupkisRegistry} with the name
  * `FunctionSchema` for later reference and type checking purposes.
- * @category Schema
  * @example
  *
  * ```typescript
@@ -64,8 +84,10 @@ export declare const ClassSchema: z.ZodCustom<Constructor, Constructor>;
  * FunctionSchema.parse('not a function'); // ✗ Throws validation error
  * FunctionSchema.parse({}); // ✗ Throws validation error
  * ```
+ *
+ * @group Schema
  */
-export declare const FunctionSchema: z.ZodCustom<(...args: any[]) => any, (...args: any[]) => any>;
+export declare const FunctionSchema: z.ZodCustom<(...args: MutableOrReadonly<unknown[]>) => unknown, (...args: MutableOrReadonly<unknown[]>) => unknown>;
 /**
  * A Zod schema that validates JavaScript property keys.
  *
@@ -74,10 +96,9 @@ export declare const FunctionSchema: z.ZodCustom<(...args: any[]) => any, (...ar
  * types that JavaScript automatically converts to property keys when used in
  * object access or assignment operations.
  *
- * @remarks
+ * @privateRemarks
  * The schema is registered in the `BupkisRegistry` with the name
  * `PropertyKeySchema` for later reference and type checking purposes.
- * @category Schema
  * @example
  *
  * ```typescript
@@ -87,6 +108,8 @@ export declare const FunctionSchema: z.ZodCustom<(...args: any[]) => any, (...ar
  * PropertyKeySchema.parse({}); // ✗ Throws validation error
  * PropertyKeySchema.parse(null); // ✗ Throws validation error
  * ```
+ *
+ * @group Schema
  */
 export declare const PropertyKeySchema: z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodSymbol]>;
 /**
@@ -98,12 +121,11 @@ export declare const PropertyKeySchema: z.ZodUnion<readonly [z.ZodString, z.ZodN
  * resolved value, meaning the result of parsing remains a Promise or thenable
  * object.
  *
- * @remarks
+ * @privateRemarks
  * The schema is registered in the `BupkisRegistry` with the name
  * `WrappedPromiseLikeSchema` for later reference and type checking purposes.
  * This is useful when you need to validate that something is thenable without
  * automatically resolving it.
- * @category Schema
  * @example
  *
  * ```typescript
@@ -112,6 +134,8 @@ export declare const PropertyKeySchema: z.ZodUnion<readonly [z.ZodString, z.ZodN
  * WrappedPromiseLikeSchema.parse(42); // ✗ Throws validation error
  * WrappedPromiseLikeSchema.parse({}); // ✗ Throws validation error
  * ```
+ *
+ * @group Schema
  */
 export declare const WrappedPromiseLikeSchema: z.ZodCustom<PromiseLike<unknown>, PromiseLike<unknown>>;
 /**
@@ -125,7 +149,6 @@ export declare const WrappedPromiseLikeSchema: z.ZodCustom<PromiseLike<unknown>,
  * @remarks
  * The schema is registered in the `BupkisRegistry` with the name
  * `StrongMapSchema` for later reference and type checking purposes.
- * @category Schema
  * @example
  *
  * ```typescript
@@ -138,6 +161,8 @@ export declare const WrappedPromiseLikeSchema: z.ZodCustom<PromiseLike<unknown>,
  * const weakMap = new WeakMap();
  * StrongMapSchema.parse(weakMap); // ✗ Throws validation error
  * ```
+ *
+ * @group Schema
  */
 export declare const StrongMapSchema: z.ZodCustom<Map<unknown, unknown>, Map<unknown, unknown>>;
 /**
@@ -151,7 +176,6 @@ export declare const StrongMapSchema: z.ZodCustom<Map<unknown, unknown>, Map<unk
  * @remarks
  * The schema is registered in the `BupkisRegistry` with the name
  * `StrongSetSchema` for later reference and type checking purposes.
- * @category Schema
  * @example
  *
  * ```typescript
@@ -161,6 +185,8 @@ export declare const StrongMapSchema: z.ZodCustom<Map<unknown, unknown>, Map<unk
  * const weakSet = new WeakSet();
  * StrongSetSchema.parse(weakSet); // ✗ Throws validation error
  * ```
+ *
+ * @group Schema
  */
 export declare const StrongSetSchema: z.ZodCustom<Set<unknown>, Set<unknown>>;
 /**
@@ -172,10 +198,12 @@ export declare const StrongSetSchema: z.ZodCustom<Set<unknown>, Set<unknown>>;
  * `Object.prototype`, making them useful as pure data containers or
  * dictionaries.
  *
- * @remarks
+ * @privateRemarks
  * The schema is registered in the `BupkisRegistry` with the name
  * `ObjectWithNullPrototype` for later reference and type checking purposes.
- * @category Schema
+ *
+ * Changing this to be a `ZodRecord` would be nice, but that would end up
+ * blasting away the original object's prototype.
  * @example
  *
  * ```typescript
@@ -189,6 +217,15 @@ export declare const StrongSetSchema: z.ZodCustom<Set<unknown>, Set<unknown>>;
  * const emptyObj = {};
  * NullProtoObjectSchema.parse(emptyObj); // ✗ Throws validation error
  * ```
+ *
+ * @group Schema
+ * @see Aliases: {@link NullProtoObjectSchema}, {@link DictionarySchema}
+ */
+export declare const DictionarySchema: z.ZodCustom<Record<PropertyKey, unknown>, Record<PropertyKey, unknown>>;
+/**
+ * {@inheritDoc DictionarySchema}
+ *
+ * @group Schema
  */
 export declare const NullProtoObjectSchema: z.ZodCustom<Record<PropertyKey, unknown>, Record<PropertyKey, unknown>>;
 /**
@@ -199,13 +236,12 @@ export declare const NullProtoObjectSchema: z.ZodCustom<Record<PropertyKey, unkn
  * function's internal `[[ToString]]` representation to distinguish async
  * functions from regular functions that might return Promises.
  *
- * @remarks
+ * @privateRemarks
  * The schema is registered in the `BupkisRegistry` with the name
  * `AsyncFunctionSchema` for later reference and type checking purposes. This
  * schema cannot reliably detect functions that return Promises but are not
  * declared with `async`, as this determination requires static analysis that is
  * not available at runtime.
- * @category Schema
  * @example
  *
  * ```typescript
@@ -225,8 +261,10 @@ export declare const NullProtoObjectSchema: z.ZodCustom<Record<PropertyKey, unkn
  * const regularFn = () => 42;
  * AsyncFunctionSchema.parse(regularFn); // ✗ Throws validation error
  * ```
+ *
+ * @group Schema
  */
-export declare const AsyncFunctionSchema: z.ZodCustom<(...args: any[]) => any, (...args: any[]) => any>;
+export declare const AsyncFunctionSchema: z.ZodCustom<(...args: MutableOrReadonly<unknown[]>) => unknown, (...args: MutableOrReadonly<unknown[]>) => unknown>;
 /**
  * A Zod schema that validates truthy JavaScript values.
  *
@@ -235,10 +273,9 @@ export declare const AsyncFunctionSchema: z.ZodCustom<(...args: any[]) => any, (
  * if it converts to `true` when evaluated in a boolean context - essentially
  * any value that is not one of the eight falsy values.
  *
- * @remarks
+ * @privateRemarks
  * The schema is registered in the `BupkisRegistry` with the name `Truthy` and
  * indicates that it accepts anything as valid input for evaluation.
- * @category Schema
  * @example
  *
  * ```typescript
@@ -252,6 +289,8 @@ export declare const AsyncFunctionSchema: z.ZodCustom<(...args: any[]) => any, (
  * TruthySchema.parse(''); // ✗ Throws validation error
  * TruthySchema.parse(null); // ✗ Throws validation error
  * ```
+ *
+ * @group Schema
  */
 export declare const TruthySchema: z.ZodNonOptional<z.ZodAny>;
 /**
@@ -262,10 +301,9 @@ export declare const TruthySchema: z.ZodNonOptional<z.ZodAny>;
  * in JavaScript are: `false`, `0`, `-0`, `0n`, `""` (empty string), `null`,
  * `undefined`, and `NaN`.
  *
- * @remarks
+ * @privateRemarks
  * The schema is registered in the `BupkisRegistry` with the name `Falsy` and
  * indicates that it accepts anything as valid input for evaluation.
- * @category Schema
  * @example
  *
  * ```typescript
@@ -282,6 +320,8 @@ export declare const TruthySchema: z.ZodNonOptional<z.ZodAny>;
  * FalsySchema.parse('hello'); // ✗ Throws validation error
  * FalsySchema.parse({}); // ✗ Throws validation error
  * ```
+ *
+ * @group Schema
  */
 export declare const FalsySchema: z.ZodNullable<z.ZodAny>;
 /**
@@ -293,10 +333,9 @@ export declare const FalsySchema: z.ZodNullable<z.ZodAny>;
  * distinguishing them from objects and functions which are non-primitive
  * reference types.
  *
- * @remarks
+ * @privateRemarks
  * The schema is registered in the `BupkisRegistry` with the name `Primitive`
  * and indicates that it accepts primitive values as valid input.
- * @category Schema
  * @example
  *
  * ```typescript
@@ -311,6 +350,8 @@ export declare const FalsySchema: z.ZodNullable<z.ZodAny>;
  * PrimitiveSchema.parse([]); // ✗ Throws validation error (array)
  * PrimitiveSchema.parse(() => {}); // ✗ Throws validation error (function)
  * ```
+ *
+ * @group Schema
  */
 export declare const PrimitiveSchema: z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean, z.ZodBigInt, z.ZodSymbol, z.ZodNull, z.ZodUndefined]>;
 /**
@@ -323,12 +364,11 @@ export declare const PrimitiveSchema: z.ZodUnion<readonly [z.ZodString, z.ZodNum
  * it useful for validating collections where the specific array mutability or
  * tuple structure is not critical.
  *
- * @remarks
+ * @privateRemarks
  * The schema is registered in the {@link BupkisRegistry} with the name
  * `ArrayLike` for later reference and type checking purposes. This schema is
  * particularly useful when you need to accept various forms of array-like data
  * without being restrictive about mutability or exact tuple structure.
- * @category Schema
  * @example
  *
  * ```typescript
@@ -340,8 +380,10 @@ export declare const PrimitiveSchema: z.ZodUnion<readonly [z.ZodString, z.ZodNum
  * ArrayLikeSchema.parse({}); // ✗ Throws validation error
  * ArrayLikeSchema.parse(null); // ✗ Throws validation error
  * ```
+ *
+ * @group Schema
  */
-export declare const ArrayLikeSchema: z.ZodUnion<readonly [z.ZodArray<z.ZodAny>, z.ZodTuple<[z.ZodAny], z.ZodAny>, z.ZodObject<{
+export declare const ArrayLikeSchema: z.ZodUnion<readonly [z.ZodArray<z.ZodUnknown>, z.ZodTuple<[z.ZodUnknown], z.ZodUnknown>, z.ZodObject<{
     length: z.ZodNumber;
 }, z.core.$loose>]>;
 /**
@@ -353,10 +395,9 @@ export declare const ArrayLikeSchema: z.ZodUnion<readonly [z.ZodArray<z.ZodAny>,
  * It ensures the validated value is a proper regular expression object with all
  * associated methods and properties.
  *
- * @remarks
+ * @privateRemarks
  * The schema is registered in the `BupkisRegistry` with the name `RegExp` for
  * later reference and type checking purposes.
- * @category Schema
  * @example
  *
  * ```typescript
@@ -368,6 +409,8 @@ export declare const ArrayLikeSchema: z.ZodUnion<readonly [z.ZodArray<z.ZodAny>,
  * RegExpSchema.parse(/abc/.source); // ✗ Throws validation error (string pattern)
  * RegExpSchema.parse({}); // ✗ Throws validation error (object)
  * ```
+ *
+ * @group Schema
  */
 export declare const RegExpSchema: z.ZodCustom<RegExp, RegExp>;
 //# sourceMappingURL=schema.d.ts.map

package/dist/commonjs/schema.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"schema.d.ts","sourceRoot":"","sources":["../../src/schema.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AAEH,OAAO,EAAE,CAAC,EAAE,MAAM,QAAQ,CAAC;AAU3B,OAAO,EAAE,KAAK,WAAW,EAAE,MAAM,YAAY,CAAC;AAE9C;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AAEH,eAAO,MAAM,WAAW,uCAGU,CAAC;AAEnC;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,eAAO,MAAM,cAAc,wBACP,GAAG,EAAE,KAAK,GAAG,YAAb,GAAG,EAAE,KAAK,GAAG,CAM9B,CAAC;AAEJ;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,eAAO,MAAM,iBAAiB,8DAG4B,CAAC;AAE3D;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,eAAO,MAAM,wBAAwB,yDAK4B,CAAC;AAElE;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,eAAO,MAAM,eAAe,2DAI4B,CAAC;AAEzD;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,eAAO,MAAM,eAAe,yCAI4B,CAAC;AAEzD;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,eAAO,MAAM,qBAAqB,yEAK8B,CAAC;AAEjE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkCG;AACH,eAAO,MAAM,mBAAmB,wBAlMZ,GAAG,EAAE,KAAK,GAAG,YAAb,GAAG,EAAE,KAAK,GAAG,CAsM2B,CAAC;AAE7D;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,eAAO,MAAM,YAAY,4BAOrB,CAAC;AAEL;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,eAAO,MAAM,WAAW,yBAKsB,CAAC;AAE/C;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,eAAO,MAAM,eAAe,oHAWsB,CAAC;AAEnD;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,eAAO,MAAM,eAAe;;mBASxB,CAAC;AAEL;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,eAAO,MAAM,YAAY,6BAGsB,CAAC"}
+{"version":3,"file":"schema.d.ts","sourceRoot":"","sources":["../../src/schema.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG;AAEH,OAAO,EAAE,CAAC,EAAE,MAAM,QAAQ,CAAC;AAU3B,OAAO,EAAE,KAAK,WAAW,EAAE,KAAK,iBAAiB,EAAE,MAAM,YAAY,CAAC;AAEtE;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AAEH,eAAO,MAAM,WAAW,uCAGU,CAAC;AAEnC;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,eAAO,MAAM,cAAc,wBACP,iBAAiB,CAAC,OAAO,EAAE,CAAC,KAAK,OAAO,YAAxC,iBAAiB,CAAC,OAAO,EAAE,CAAC,KAAK,OAAO,CAMzD,CAAC;AAEJ;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,eAAO,MAAM,iBAAiB,8DAG4B,CAAC;AAE3D;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,eAAO,MAAM,wBAAwB,yDAK4B,CAAC;AAElE;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,eAAO,MAAM,eAAe,2DAI4B,CAAC;AAEzD;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,eAAO,MAAM,eAAe,yCAI4B,CAAC;AAEzD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;AACH,eAAO,MAAM,gBAAgB,yEAKmC,CAAC;AAEjE;;;;GAIG;AACH,eAAO,MAAM,qBAAqB,yEAAmB,CAAC;AAEtD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmCG;AACH,eAAO,MAAM,mBAAmB,wBAnNZ,iBAAiB,CAAC,OAAO,EAAE,CAAC,KAAK,OAAO,YAAxC,iBAAiB,CAAC,OAAO,EAAE,CAAC,KAAK,OAAO,CAuNA,CAAC;AAE7D;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,eAAO,MAAM,YAAY,4BAOrB,CAAC;AAEL;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,eAAO,MAAM,WAAW,yBAKsB,CAAC;AAE/C;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,eAAO,MAAM,eAAe,oHAWsB,CAAC;AAEnD;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,eAAO,MAAM,eAAe;;mBASxB,CAAC;AAEL;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,eAAO,MAAM,YAAY,6BAGsB,CAAC"}