bupkis 0.1.2 → 0.2.0

package/src/util.ts

@@ -7,6 +7,13 @@
  * converting shapes to Zod schemas. All functions handle circular references
  * safely.
  *
+ * @category API
+ * @example
+ *
+ * ```ts
+ * import * as util from 'bupkis/util';
+ * ```
+ *
  * @packageDocumentation
  */
 

package/dist/commonjs/api.d.ts

@@ -1,93 +0,0 @@
-/**
- * Contains the main API types
- *
- * @packageDocumentation
- */
-import type { TupleToUnion, UnionToIntersection } from 'type-fest';
-import type { AnyAsyncAssertion, AnyAsyncAssertions, AnySyncAssertion, AnySyncAssertions, BuiltinAsyncAssertions, BuiltinSyncAssertions } from './assertion/assertion-types.js';
-import type { createAssertion, createAsyncAssertion } from './assertion/create.js';
-import { type InferredExpectSlots, type MutableOrReadonly, type UseFn } from './types.js';
-/**
- * Base set of properties included in both {@link Expect} and {@link ExpectAsync}.
- */
-export interface BaseExpect {
-    /**
-     * Creates a new synchronous assertion.
-     */
-    createAssertion: typeof createAssertion;
-    /**
-     * Creates a new asynchronous assertion.
-     */
-    createAsyncAssertion: typeof createAsyncAssertion;
-    /**
-     * Fails immediately with optional `reason`.
-     *
-     * @param reason Reason for failure
-     * @throws {AssertionError}
-     */
-    fail(this: void, reason?: string): never;
-}
-/**
- * The main synchronous assertion function.
- *
- * Contains properties in {@link ExpectSyncProps}.
- *
- * @template T All synchronous assertions available
- * @template U All asynchronous assertions available; for use in
- *   {@link ExpectSyncProps.use}
- * @useDeclaredType
- * @see {@link expect}
- */
-export type Expect<T extends AnySyncAssertions = BuiltinSyncAssertions, U extends AnyAsyncAssertions = BuiltinAsyncAssertions> = ExpectFunction<T> & ExpectSyncProps<T, U>;
-/**
- * The main asynchronous assertion function.
- *
- * Contains properties in {@link ExpectSyncProps}.
- *
- * @useDeclaredType
- * @see {@link expectAsync}
- */
-export type ExpectAsync<T extends AnyAsyncAssertions = BuiltinAsyncAssertions, U extends AnySyncAssertions = BuiltinSyncAssertions> = ExpectAsyncFunction<T> & ExpectAsyncProps<T, U>;
-/**
- * All function overloads for `expectAsync()`; part of {@link ExpectAsync}.
- */
-export type ExpectAsyncFunction<T extends AnyAsyncAssertions = BuiltinAsyncAssertions> = UnionToIntersection<TupleToUnion<{
-    [K in keyof T]: T[K] extends AnyAsyncAssertion ? (...args: MutableOrReadonly<InferredExpectSlots<T[K]['parts']>>) => Promise<void> : never;
-}>>;
-/**
- * Properties available on `expectAsync()`; part of {@link ExpectAsync}.
- */
-export interface ExpectAsyncProps<T extends AnyAsyncAssertions, U extends AnySyncAssertions> extends BaseExpect {
-    /**
-     * Tuple of all assertions available in this `expect()`.
-     */
-    assertions: T;
-    /**
-     * Function to add more assertions to this `expect()`, returning a new
-     * `expect()` and `expectAsync()` pair with the combined assertions.
-     */
-    use: UseFn<U, T>;
-}
-/**
- * All function overloads for `expect()`; part of {@link Expect}.
- *
- * @useDeclaredType
- */
-export type ExpectFunction<T extends AnySyncAssertions = BuiltinSyncAssertions> = UnionToIntersection<TupleToUnion<{
-    [K in keyof T]: T[K] extends AnySyncAssertion ? (...args: MutableOrReadonly<InferredExpectSlots<T[K]['parts']>>) => void : never;
-}>>;
-/**
- * Properties for `expect()`; part of {@link Expect}.
- */
-export interface ExpectSyncProps<T extends AnySyncAssertions, U extends AnyAsyncAssertions> extends BaseExpect {
-    /**
-     * Tuple of all assertions available in this `expect()`.
-     */
-    assertions: T;
-    /**
-     * Function to add more assertions to this `expect()`, returning a new
-     * `expect()` and `expectAsync()` pair with the combined assertions.
-     */
-    use: UseFn<T, U>;
-}
-//# sourceMappingURL=api.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"api.d.ts","sourceRoot":"","sources":["../../src/api.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,KAAK,EAAE,YAAY,EAAE,mBAAmB,EAAE,MAAM,WAAW,CAAC;AAEnE,OAAO,KAAK,EACV,iBAAiB,EACjB,kBAAkB,EAClB,gBAAgB,EAChB,iBAAiB,EACjB,sBAAsB,EACtB,qBAAqB,EACtB,MAAM,gCAAgC,CAAC;AACxC,OAAO,KAAK,EACV,eAAe,EACf,oBAAoB,EACrB,MAAM,uBAAuB,CAAC;AAI/B,OAAO,EACL,KAAK,mBAAmB,EACxB,KAAK,iBAAiB,EACtB,KAAK,KAAK,EACX,MAAM,YAAY,CAAC;AAEpB;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB;;OAEG;IACH,eAAe,EAAE,OAAO,eAAe,CAAC;IACxC;;OAEG;IACH,oBAAoB,EAAE,OAAO,oBAAoB,CAAC;IAClD;;;;;OAKG;IACH,IAAI,CAAC,IAAI,EAAE,IAAI,EAAE,MAAM,CAAC,EAAE,MAAM,GAAG,KAAK,CAAC;CAC1C;AAED;;;;;;;;;;GAUG;AAEH,MAAM,MAAM,MAAM,CAChB,CAAC,SAAS,iBAAiB,GAAG,qBAAqB,EACnD,CAAC,SAAS,kBAAkB,GAAG,sBAAsB,IACnD,cAAc,CAAC,CAAC,CAAC,GAAG,eAAe,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;AAE9C;;;;;;;GAOG;AAEH,MAAM,MAAM,WAAW,CACrB,CAAC,SAAS,kBAAkB,GAAG,sBAAsB,EACrD,CAAC,SAAS,iBAAiB,GAAG,qBAAqB,IACjD,mBAAmB,CAAC,CAAC,CAAC,GAAG,gBAAgB,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;AAEpD;;GAEG;AAEH,MAAM,MAAM,mBAAmB,CAC7B,CAAC,SAAS,kBAAkB,GAAG,sBAAsB,IACnD,mBAAmB,CACrB,YAAY,CAAC;KACV,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,iBAAiB,GAC1C,CACE,GAAG,IAAI,EAAE,iBAAiB,CAAC,mBAAmB,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,KAC3D,OAAO,CAAC,IAAI,CAAC,GAClB,KAAK;CACV,CAAC,CACH,CAAC;AAEF;;GAEG;AAEH,MAAM,WAAW,gBAAgB,CAC/B,CAAC,SAAS,kBAAkB,EAC5B,CAAC,SAAS,iBAAiB,CAC3B,SAAQ,UAAU;IAClB;;OAEG;IACH,UAAU,EAAE,CAAC,CAAC;IACd;;;OAGG;IACH,GAAG,EAAE,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;CAClB;AAED;;;;GAIG;AACH,MAAM,MAAM,cAAc,CACxB,CAAC,SAAS,iBAAiB,GAAG,qBAAqB,IACjD,mBAAmB,CACrB,YAAY,CAAC;KACV,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,gBAAgB,GACzC,CAAC,GAAG,IAAI,EAAE,iBAAiB,CAAC,mBAAmB,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,IAAI,GACxE,KAAK;CACV,CAAC,CACH,CAAC;AAEF;;GAEG;AACH,MAAM,WAAW,eAAe,CAC9B,CAAC,SAAS,iBAAiB,EAC3B,CAAC,SAAS,kBAAkB,CAC5B,SAAQ,UAAU;IAClB;;OAEG;IACH,UAAU,EAAE,CAAC,CAAC;IAEd;;;OAGG;IACH,GAAG,EAAE,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;CAClB"}

package/dist/commonjs/api.js

@@ -1,8 +0,0 @@
-"use strict";
-/**
- * Contains the main API types
- *
- * @packageDocumentation
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=api.js.map

package/dist/commonjs/api.js.map

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

package/dist/esm/api.d.ts

@@ -1,93 +0,0 @@
-/**
- * Contains the main API types
- *
- * @packageDocumentation
- */
-import type { TupleToUnion, UnionToIntersection } from 'type-fest';
-import type { AnyAsyncAssertion, AnyAsyncAssertions, AnySyncAssertion, AnySyncAssertions, BuiltinAsyncAssertions, BuiltinSyncAssertions } from './assertion/assertion-types.js';
-import type { createAssertion, createAsyncAssertion } from './assertion/create.js';
-import { type InferredExpectSlots, type MutableOrReadonly, type UseFn } from './types.js';
-/**
- * Base set of properties included in both {@link Expect} and {@link ExpectAsync}.
- */
-export interface BaseExpect {
-    /**
-     * Creates a new synchronous assertion.
-     */
-    createAssertion: typeof createAssertion;
-    /**
-     * Creates a new asynchronous assertion.
-     */
-    createAsyncAssertion: typeof createAsyncAssertion;
-    /**
-     * Fails immediately with optional `reason`.
-     *
-     * @param reason Reason for failure
-     * @throws {AssertionError}
-     */
-    fail(this: void, reason?: string): never;
-}
-/**
- * The main synchronous assertion function.
- *
- * Contains properties in {@link ExpectSyncProps}.
- *
- * @template T All synchronous assertions available
- * @template U All asynchronous assertions available; for use in
- *   {@link ExpectSyncProps.use}
- * @useDeclaredType
- * @see {@link expect}
- */
-export type Expect<T extends AnySyncAssertions = BuiltinSyncAssertions, U extends AnyAsyncAssertions = BuiltinAsyncAssertions> = ExpectFunction<T> & ExpectSyncProps<T, U>;
-/**
- * The main asynchronous assertion function.
- *
- * Contains properties in {@link ExpectSyncProps}.
- *
- * @useDeclaredType
- * @see {@link expectAsync}
- */
-export type ExpectAsync<T extends AnyAsyncAssertions = BuiltinAsyncAssertions, U extends AnySyncAssertions = BuiltinSyncAssertions> = ExpectAsyncFunction<T> & ExpectAsyncProps<T, U>;
-/**
- * All function overloads for `expectAsync()`; part of {@link ExpectAsync}.
- */
-export type ExpectAsyncFunction<T extends AnyAsyncAssertions = BuiltinAsyncAssertions> = UnionToIntersection<TupleToUnion<{
-    [K in keyof T]: T[K] extends AnyAsyncAssertion ? (...args: MutableOrReadonly<InferredExpectSlots<T[K]['parts']>>) => Promise<void> : never;
-}>>;
-/**
- * Properties available on `expectAsync()`; part of {@link ExpectAsync}.
- */
-export interface ExpectAsyncProps<T extends AnyAsyncAssertions, U extends AnySyncAssertions> extends BaseExpect {
-    /**
-     * Tuple of all assertions available in this `expect()`.
-     */
-    assertions: T;
-    /**
-     * Function to add more assertions to this `expect()`, returning a new
-     * `expect()` and `expectAsync()` pair with the combined assertions.
-     */
-    use: UseFn<U, T>;
-}
-/**
- * All function overloads for `expect()`; part of {@link Expect}.
- *
- * @useDeclaredType
- */
-export type ExpectFunction<T extends AnySyncAssertions = BuiltinSyncAssertions> = UnionToIntersection<TupleToUnion<{
-    [K in keyof T]: T[K] extends AnySyncAssertion ? (...args: MutableOrReadonly<InferredExpectSlots<T[K]['parts']>>) => void : never;
-}>>;
-/**
- * Properties for `expect()`; part of {@link Expect}.
- */
-export interface ExpectSyncProps<T extends AnySyncAssertions, U extends AnyAsyncAssertions> extends BaseExpect {
-    /**
-     * Tuple of all assertions available in this `expect()`.
-     */
-    assertions: T;
-    /**
-     * Function to add more assertions to this `expect()`, returning a new
-     * `expect()` and `expectAsync()` pair with the combined assertions.
-     */
-    use: UseFn<T, U>;
-}
-//# sourceMappingURL=api.d.ts.map

package/dist/esm/api.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"api.d.ts","sourceRoot":"","sources":["../../src/api.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,KAAK,EAAE,YAAY,EAAE,mBAAmB,EAAE,MAAM,WAAW,CAAC;AAEnE,OAAO,KAAK,EACV,iBAAiB,EACjB,kBAAkB,EAClB,gBAAgB,EAChB,iBAAiB,EACjB,sBAAsB,EACtB,qBAAqB,EACtB,MAAM,gCAAgC,CAAC;AACxC,OAAO,KAAK,EACV,eAAe,EACf,oBAAoB,EACrB,MAAM,uBAAuB,CAAC;AAI/B,OAAO,EACL,KAAK,mBAAmB,EACxB,KAAK,iBAAiB,EACtB,KAAK,KAAK,EACX,MAAM,YAAY,CAAC;AAEpB;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB;;OAEG;IACH,eAAe,EAAE,OAAO,eAAe,CAAC;IACxC;;OAEG;IACH,oBAAoB,EAAE,OAAO,oBAAoB,CAAC;IAClD;;;;;OAKG;IACH,IAAI,CAAC,IAAI,EAAE,IAAI,EAAE,MAAM,CAAC,EAAE,MAAM,GAAG,KAAK,CAAC;CAC1C;AAED;;;;;;;;;;GAUG;AAEH,MAAM,MAAM,MAAM,CAChB,CAAC,SAAS,iBAAiB,GAAG,qBAAqB,EACnD,CAAC,SAAS,kBAAkB,GAAG,sBAAsB,IACnD,cAAc,CAAC,CAAC,CAAC,GAAG,eAAe,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;AAE9C;;;;;;;GAOG;AAEH,MAAM,MAAM,WAAW,CACrB,CAAC,SAAS,kBAAkB,GAAG,sBAAsB,EACrD,CAAC,SAAS,iBAAiB,GAAG,qBAAqB,IACjD,mBAAmB,CAAC,CAAC,CAAC,GAAG,gBAAgB,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;AAEpD;;GAEG;AAEH,MAAM,MAAM,mBAAmB,CAC7B,CAAC,SAAS,kBAAkB,GAAG,sBAAsB,IACnD,mBAAmB,CACrB,YAAY,CAAC;KACV,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,iBAAiB,GAC1C,CACE,GAAG,IAAI,EAAE,iBAAiB,CAAC,mBAAmB,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,KAC3D,OAAO,CAAC,IAAI,CAAC,GAClB,KAAK;CACV,CAAC,CACH,CAAC;AAEF;;GAEG;AAEH,MAAM,WAAW,gBAAgB,CAC/B,CAAC,SAAS,kBAAkB,EAC5B,CAAC,SAAS,iBAAiB,CAC3B,SAAQ,UAAU;IAClB;;OAEG;IACH,UAAU,EAAE,CAAC,CAAC;IACd;;;OAGG;IACH,GAAG,EAAE,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;CAClB;AAED;;;;GAIG;AACH,MAAM,MAAM,cAAc,CACxB,CAAC,SAAS,iBAAiB,GAAG,qBAAqB,IACjD,mBAAmB,CACrB,YAAY,CAAC;KACV,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,gBAAgB,GACzC,CAAC,GAAG,IAAI,EAAE,iBAAiB,CAAC,mBAAmB,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,IAAI,GACxE,KAAK;CACV,CAAC,CACH,CAAC;AAEF;;GAEG;AACH,MAAM,WAAW,eAAe,CAC9B,CAAC,SAAS,iBAAiB,EAC3B,CAAC,SAAS,kBAAkB,CAC5B,SAAQ,UAAU;IAClB;;OAEG;IACH,UAAU,EAAE,CAAC,CAAC;IAEd;;;OAGG;IACH,GAAG,EAAE,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;CAClB"}

package/dist/esm/api.js

@@ -1,7 +0,0 @@
-/**
- * Contains the main API types
- *
- * @packageDocumentation
- */
-export {};
-//# sourceMappingURL=api.js.map

package/dist/esm/api.js.map

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

package/src/api.ts

@@ -1,149 +0,0 @@
-/**
- * Contains the main API types
- *
- * @packageDocumentation
- */
-
-import type { TupleToUnion, UnionToIntersection } from 'type-fest';
-
-import type {
-  AnyAsyncAssertion,
-  AnyAsyncAssertions,
-  AnySyncAssertion,
-  AnySyncAssertions,
-  BuiltinAsyncAssertions,
-  BuiltinSyncAssertions,
-} from './assertion/assertion-types.js';
-import type {
-  createAssertion,
-  createAsyncAssertion,
-} from './assertion/create.js';
-// eslint-disable-next-line @typescript-eslint/no-unused-vars
-import type { expect, expectAsync } from './bootstrap.js';
-
-import {
-  type InferredExpectSlots,
-  type MutableOrReadonly,
-  type UseFn,
-} from './types.js';
-
-/**
- * Base set of properties included in both {@link Expect} and {@link ExpectAsync}.
- */
-export interface BaseExpect {
-  /**
-   * Creates a new synchronous assertion.
-   */
-  createAssertion: typeof createAssertion;
-  /**
-   * Creates a new asynchronous assertion.
-   */
-  createAsyncAssertion: typeof createAsyncAssertion;
-  /**
-   * Fails immediately with optional `reason`.
-   *
-   * @param reason Reason for failure
-   * @throws {AssertionError}
-   */
-  fail(this: void, reason?: string): never;
-}
-
-/**
- * The main synchronous assertion function.
- *
- * Contains properties in {@link ExpectSyncProps}.
- *
- * @template T All synchronous assertions available
- * @template U All asynchronous assertions available; for use in
- *   {@link ExpectSyncProps.use}
- * @useDeclaredType
- * @see {@link expect}
- */
-
-export type Expect<
-  T extends AnySyncAssertions = BuiltinSyncAssertions,
-  U extends AnyAsyncAssertions = BuiltinAsyncAssertions,
-> = ExpectFunction<T> & ExpectSyncProps<T, U>;
-
-/**
- * The main asynchronous assertion function.
- *
- * Contains properties in {@link ExpectSyncProps}.
- *
- * @useDeclaredType
- * @see {@link expectAsync}
- */
-
-export type ExpectAsync<
-  T extends AnyAsyncAssertions = BuiltinAsyncAssertions,
-  U extends AnySyncAssertions = BuiltinSyncAssertions,
-> = ExpectAsyncFunction<T> & ExpectAsyncProps<T, U>;
-
-/**
- * All function overloads for `expectAsync()`; part of {@link ExpectAsync}.
- */
-
-export type ExpectAsyncFunction<
-  T extends AnyAsyncAssertions = BuiltinAsyncAssertions,
-> = UnionToIntersection<
-  TupleToUnion<{
-    [K in keyof T]: T[K] extends AnyAsyncAssertion
-      ? (
-          ...args: MutableOrReadonly<InferredExpectSlots<T[K]['parts']>>
-        ) => Promise<void>
-      : never;
-  }>
->;
-
-/**
- * Properties available on `expectAsync()`; part of {@link ExpectAsync}.
- */
-
-export interface ExpectAsyncProps<
-  T extends AnyAsyncAssertions,
-  U extends AnySyncAssertions,
-> extends BaseExpect {
-  /**
-   * Tuple of all assertions available in this `expect()`.
-   */
-  assertions: T;
-  /**
-   * Function to add more assertions to this `expect()`, returning a new
-   * `expect()` and `expectAsync()` pair with the combined assertions.
-   */
-  use: UseFn<U, T>;
-}
-
-/**
- * All function overloads for `expect()`; part of {@link Expect}.
- *
- * @useDeclaredType
- */
-export type ExpectFunction<
-  T extends AnySyncAssertions = BuiltinSyncAssertions,
-> = UnionToIntersection<
-  TupleToUnion<{
-    [K in keyof T]: T[K] extends AnySyncAssertion
-      ? (...args: MutableOrReadonly<InferredExpectSlots<T[K]['parts']>>) => void
-      : never;
-  }>
->;
-
-/**
- * Properties for `expect()`; part of {@link Expect}.
- */
-export interface ExpectSyncProps<
-  T extends AnySyncAssertions,
-  U extends AnyAsyncAssertions,
-> extends BaseExpect {
-  /**
-   * Tuple of all assertions available in this `expect()`.
-   */
-  assertions: T;
-
-  /**
-   * Function to add more assertions to this `expect()`, returning a new
-   * `expect()` and `expectAsync()` pair with the combined assertions.
-   */
-  use: UseFn<T, U>;
-}

package/src/schema.md

@@ -1,15 +0,0 @@
----
-title: About Schemas
-group: Documents
-category: 'For Developers'
----
-
-# About Schemas
-
-The schemas located in [schema.ts](./schema.ts) are used internally, but will be helpful for anyone implementing custom assertions.
-
-These contain workarounds for where Zod's concepts and scope conflict with the aim of _BUPKIS_.
-
-For example, we have a `FunctionSchema` which accepts any function, regardless of its signature. Zod v4's `z.function()` is no longer a `ZodType` and acts differently, but this schema allows us to validate "is a function" assertions and perform assertion matching.
-
-Likewise, `z.promise()` does not parse a `Promise` instance, but rather the resolved value of a promise. This is not what we want for "is a Promise" assertions, so we have `PromiseSchema` to handle that.