inferred-types 0.44.0 → 0.45.2

package/dist/runtime/type-guards/repos.d.ts

@@ -16,30 +16,30 @@ export declare const isRepoSource: <T>(v: T) => v is T & ("github" | "bitbucket"
  * `v 1.0.12` are allowed.
  * - by default the `allowPrefix` option is set to false
  */
-export declare const isSemanticVersion: <T, P extends boolean>(v: T, allowPrefix?: P) => v is T & `${[P] extends [true] ? import("../../types/index").OptionalSpace | "v" | "v " : ""}${number}.${number}.${number}`;
+export declare const isSemanticVersion: <T, P extends boolean>(v: T, allowPrefix?: P) => v is T & `${[P] extends [true] ? "v" | import("../../types/index").OptionalSpace | "v " : ""}${number}.${number}.${number}`;
 /**
  * **isRepoUrl**`(val)`
  *
  * Type guard which validates that the value passed in is a valid Repo URL
  */
-export declare const isRepoUrl: <T>(val: T) => val is T & (`https://github.com/${string}` | "https://github.com" | `https://github.io/${string}` | "https://github.io" | `https://bitbucket.com/${string}` | "https://bitbucket.com" | `https://gitlab.com/${string}` | "https://gitlab.com" | `https://aws.amazon.com/codecommit/${string}`);
+export declare const isRepoUrl: <T>(val: T) => val is T & (`https://github.com/${string}` | "https://github.com" | `https://github.com?${string}` | `https://github.io/${string}` | "https://github.io" | `https://github.io?${string}` | `https://bitbucket.com/${string}` | "https://bitbucket.com" | `https://bitbucket.com?${string}` | `https://gitlab.com/${string}` | "https://gitlab.com" | `https://gitlab.com?${string}` | `https://aws.amazon.com/codecommit/${string}` | `https://aws.amazon.com/codecommit/?${string}`);
 /**
  * **isGithubUrl**`(val)`
  *
  * Type guard which validates that the value passed in is a valid Github URL
  */
-export declare const isGithubUrl: <T>(val: T) => val is T & (`https://github.com/${string}` | "https://github.com" | `https://github.io/${string}` | "https://github.io");
-export declare const isGithubRepoUrl: <T>(val: T) => val is T & (`https://github.com/${string}/0${string}` | `https://github.com/${string}/1${string}` | `https://github.com/${string}/2${string}` | `https://github.com/${string}/3${string}` | `https://github.com/${string}/4${string}` | `https://github.com/${string}/5${string}` | `https://github.com/${string}/6${string}` | `https://github.com/${string}/7${string}` | `https://github.com/${string}/8${string}` | `https://github.com/${string}/9${string}` | `https://github.com/${string}/x${string}` | `https://github.com/${string}/E${string}` | `https://github.com/${string}/A${string}` | `https://github.com/${string}/B${string}` | `https://github.com/${string}/C${string}` | `https://github.com/${string}/D${string}` | `https://github.com/${string}/F${string}` | `https://github.com/${string}/G${string}` | `https://github.com/${string}/H${string}` | `https://github.com/${string}/I${string}` | `https://github.com/${string}/J${string}` | `https://github.com/${string}/K${string}` | `https://github.com/${string}/L${string}` | `https://github.com/${string}/M${string}` | `https://github.com/${string}/N${string}` | `https://github.com/${string}/O${string}` | `https://github.com/${string}/P${string}` | `https://github.com/${string}/Q${string}` | `https://github.com/${string}/R${string}` | `https://github.com/${string}/S${string}` | `https://github.com/${string}/T${string}` | `https://github.com/${string}/U${string}` | `https://github.com/${string}/V${string}` | `https://github.com/${string}/W${string}` | `https://github.com/${string}/X${string}` | `https://github.com/${string}/Y${string}` | `https://github.com/${string}/Z${string}` | `https://github.com/${string}/a${string}` | `https://github.com/${string}/b${string}` | `https://github.com/${string}/c${string}` | `https://github.com/${string}/d${string}` | `https://github.com/${string}/e${string}` | `https://github.com/${string}/f${string}` | `https://github.com/${string}/g${string}` | `https://github.com/${string}/h${string}` | `https://github.com/${string}/i${string}` | `https://github.com/${string}/j${string}` | `https://github.com/${string}/k${string}` | `https://github.com/${string}/l${string}` | `https://github.com/${string}/m${string}` | `https://github.com/${string}/n${string}` | `https://github.com/${string}/o${string}` | `https://github.com/${string}/p${string}` | `https://github.com/${string}/q${string}` | `https://github.com/${string}/r${string}` | `https://github.com/${string}/s${string}` | `https://github.com/${string}/t${string}` | `https://github.com/${string}/u${string}` | `https://github.com/${string}/v${string}` | `https://github.com/${string}/w${string}` | `https://github.com/${string}/y${string}` | `https://github.com/${string}/z${string}`);
+export declare const isGithubUrl: <T>(val: T) => val is T & (`https://github.com/${string}` | "https://github.com" | `https://github.com?${string}` | `https://github.io/${string}` | "https://github.io" | `https://github.io?${string}`);
+export declare const isGithubRepoUrl: <T>(val: T) => val is T & (`https://github.com/${string}/0${string}` | `https://github.com/${string}/1${string}` | `https://github.com/${string}/2${string}` | `https://github.com/${string}/3${string}` | `https://github.com/${string}/4${string}` | `https://github.com/${string}/5${string}` | `https://github.com/${string}/6${string}` | `https://github.com/${string}/7${string}` | `https://github.com/${string}/8${string}` | `https://github.com/${string}/9${string}` | `https://github.com/${string}/A${string}` | `https://github.com/${string}/B${string}` | `https://github.com/${string}/C${string}` | `https://github.com/${string}/D${string}` | `https://github.com/${string}/E${string}` | `https://github.com/${string}/F${string}` | `https://github.com/${string}/G${string}` | `https://github.com/${string}/H${string}` | `https://github.com/${string}/I${string}` | `https://github.com/${string}/J${string}` | `https://github.com/${string}/K${string}` | `https://github.com/${string}/L${string}` | `https://github.com/${string}/M${string}` | `https://github.com/${string}/N${string}` | `https://github.com/${string}/O${string}` | `https://github.com/${string}/P${string}` | `https://github.com/${string}/Q${string}` | `https://github.com/${string}/R${string}` | `https://github.com/${string}/S${string}` | `https://github.com/${string}/T${string}` | `https://github.com/${string}/U${string}` | `https://github.com/${string}/V${string}` | `https://github.com/${string}/W${string}` | `https://github.com/${string}/X${string}` | `https://github.com/${string}/Y${string}` | `https://github.com/${string}/Z${string}` | `https://github.com/${string}/a${string}` | `https://github.com/${string}/b${string}` | `https://github.com/${string}/c${string}` | `https://github.com/${string}/d${string}` | `https://github.com/${string}/e${string}` | `https://github.com/${string}/f${string}` | `https://github.com/${string}/g${string}` | `https://github.com/${string}/h${string}` | `https://github.com/${string}/i${string}` | `https://github.com/${string}/j${string}` | `https://github.com/${string}/k${string}` | `https://github.com/${string}/l${string}` | `https://github.com/${string}/m${string}` | `https://github.com/${string}/n${string}` | `https://github.com/${string}/o${string}` | `https://github.com/${string}/p${string}` | `https://github.com/${string}/q${string}` | `https://github.com/${string}/r${string}` | `https://github.com/${string}/s${string}` | `https://github.com/${string}/t${string}` | `https://github.com/${string}/u${string}` | `https://github.com/${string}/v${string}` | `https://github.com/${string}/w${string}` | `https://github.com/${string}/x${string}` | `https://github.com/${string}/y${string}` | `https://github.com/${string}/z${string}`);
 /**
  * **isBitbucketUrl**`(val)`
  *
  * Type guard which validates that the value passed in is a valid BitBucket URL
  */
-export declare const isBitbucketUrl: <T>(val: T) => val is T & (`https://bitbucket.com/${string}` | "https://bitbucket.com");
+export declare const isBitbucketUrl: <T>(val: T) => val is T & (`https://bitbucket.com/${string}` | "https://bitbucket.com" | `https://bitbucket.com?${string}`);
 /**
  * **isCodeCommitUrl**`(val)`
  *
  * Type guard which validates that the value passed in is a valid AWS Code Commit URL
  */
-export declare const isCodeCommitUrl: <T>(val: T) => val is T & `https://aws.amazon.com/codecommit/${string}`;
+export declare const isCodeCommitUrl: <T>(val: T) => val is T & (`https://aws.amazon.com/codecommit/${string}` | `https://aws.amazon.com/codecommit/?${string}`);
 //# sourceMappingURL=repos.d.ts.map

package/dist/runtime/type-guards/repos.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"repos.d.ts","sourceRoot":"","sources":["../../../src/runtime/type-guards/repos.ts"],"names":[],"mappings":"AAYA;;;;;GAKG;AACH,eAAO,MAAM,YAAY,SAAU,CAAC,0EAEnC,CAAA;AAED;;;;;;;;;;GAUG;AACH,eAAO,MAAM,iBAAiB,4BAC1B,CAAC,gBACU,CAAC,gIAcf,CAAA;AAED;;;;GAIG;AACH,eAAO,MAAM,SAAS,WAAY,CAAC,mSAMlC,CAAA;AAED;;;;GAIG;AACH,eAAO,MAAM,WAAW,WAAY,CAAC,6HAMpC,CAAA;AAED,eAAO,MAAM,eAAe,WAAY,CAAC,urFAMxC,CAAA;AAED;;;;GAIG;AACH,eAAO,MAAM,cAAc,WAAY,CAAC,6EAMvC,CAAA;AAED;;;;GAIG;AACH,eAAO,MAAM,eAAe,WAAY,CAAC,6DAMxC,CAAA"}
+{"version":3,"file":"repos.d.ts","sourceRoot":"","sources":["../../../src/runtime/type-guards/repos.ts"],"names":[],"mappings":"AAYA;;;;;GAKG;AACH,eAAO,MAAM,YAAY,SAAU,CAAC,0EAEnC,CAAA;AAED;;;;;;;;;;GAUG;AACH,eAAO,MAAM,iBAAiB,4BAC1B,CAAC,gBACU,CAAC,gIAcf,CAAA;AAED;;;;GAIG;AACH,eAAO,MAAM,SAAS,WAAY,CAAC,0dAMlC,CAAA;AAED;;;;GAIG;AACH,eAAO,MAAM,WAAW,WAAY,CAAC,8LAMpC,CAAA;AAED,eAAO,MAAM,eAAe,WAAY,CAAC,urFAMxC,CAAA;AAED;;;;GAIG;AACH,eAAO,MAAM,cAAc,WAAY,CAAC,iHAMvC,CAAA;AAED;;;;GAIG;AACH,eAAO,MAAM,eAAe,WAAY,CAAC,gHAMxC,CAAA"}

package/dist/runtime/type-guards/youtube.d.ts

@@ -0,0 +1,44 @@
+import { YouTubeCreatorUrl, YouTubeFeedType, YouTubeFeedUrl, YouTubePlaylistUrl } from "../../types/index";
+/**
+ * **isYouTubeUrl**`(val)`
+ *
+ * Type guard which checks whether the passed in value is a valid
+ * YouTube URL.
+ */
+export declare const isYouTubeUrl: <T>(val: T) => val is T & (`https://www.youtube.com/${string}` | "https://www.youtube.com" | `https://www.youtube.com?${string}` | `https://youtube.com/${string}` | "https://youtube.com" | `https://youtube.com?${string}` | `https://youtu.be/${string}` | "https://youtu.be" | `https://youtu.be?${string}`);
+/**
+ * **isYouTubeShareUrl**`(val)`
+ *
+ * Type guard which checks whether the passed in value is a URL
+ * from YouTube's _URL shortening_ site `https://youtu.be`.
+ */
+export declare const isYouTubeShareUrl: <T>(val: T) => val is T & (`https://youtu.be/${string}` | "https://youtu.be" | `https://youtu.be?${string}`);
+/**
+ * **isYouTubeVideoUrl**`(val)`
+ *
+ * Type guard which checks whether the passed in value is a valid
+ * YouTube URL _which plays video_.
+ */
+export declare const isYouTubeVideoUrl: <T>(val: T) => val is T & (`https://www.youtube.com/${string}` | "https://www.youtube.com" | `https://www.youtube.com?${string}` | `https://youtube.com/${string}` | "https://youtube.com" | `https://youtube.com?${string}` | `https://youtu.be/${string}` | "https://youtu.be" | `https://youtu.be?${string}`);
+/**
+ * **isYouTubePlaylistUrl**`(val)`
+ *
+ * Type guard which checks whether the passed in value is a valid
+ * YouTube URL which points to a "playlist" on the platform.
+ */
+export declare const isYouTubePlaylistUrl: <T>(val: T) => val is T & YouTubePlaylistUrl;
+/**
+ * **isYouTubeFeedUrl**`(val,[kind])**
+ *
+ * Type guard which checks whether the passed in value is a valid
+ * YouTube URL which responds with "feed" content. This is content
+ * which is available to a logged in user and helps them see lists
+ * of videos related to their settings.
+ *
+ * By default any "feed" URL is matched but you can narrow that down
+ * to a specific feed type by specifying the `kind` variable.
+ */
+export declare const isYouTubeFeedUrl: <T, U extends YouTubeFeedType = YouTubeFeedType>(val: T, type?: U) => val is T & YouTubeFeedUrl<U>;
+export declare const isYouTubeCreatorUrl: <T extends string>(url: T) => url is T & YouTubeCreatorUrl;
+export declare const isYouTubeVideosInPlaylist: <T>(val: T) => val is T & `https://www.youtube.com/playlist?${string}list=${string}`;
+//# sourceMappingURL=youtube.d.ts.map

package/dist/runtime/type-guards/youtube.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"youtube.d.ts","sourceRoot":"","sources":["../../../src/runtime/type-guards/youtube.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,iBAAiB,EACjB,eAAe,EACf,cAAc,EACd,kBAAkB,EAInB,0BAAwB;AAKzB;;;;;GAKG;AACH,eAAO,MAAM,YAAY,WAAY,CAAC,sSAMrC,CAAA;AAED;;;;;GAKG;AACH,eAAO,MAAM,iBAAiB,WAAW,CAAC,kGAEzC,CAAA;AAED;;;;;GAKG;AACH,eAAO,MAAM,iBAAiB,WAAY,CAAC,sSAM1C,CAAA;AAED;;;;;GAKG;AACH,eAAO,MAAM,oBAAoB,WAAY,CAAC,kCAS7C,CAAA;AAeD;;;;;;;;;;GAUG;AACH,eAAO,MAAM,gBAAgB,wDAIvB,CAAC,SACC,CAAC,iCAMR,CAAA;AAED,eAAO,MAAM,mBAAmB,0BACzB,CAAC,iCAOP,CAAA;AAED,eAAO,MAAM,yBAAyB,WAAY,CAAC,0EAKlD,CAAA"}

package/dist/runtime/type-guards/youtube.js

@@ -0,0 +1,84 @@
+import { isString } from "./isString.js";
+import { isUndefined } from "./isUndefined.js";
+import { hasUrlQueryParameter } from "./network-tg.js";
+/**
+ * **isYouTubeUrl**`(val)`
+ *
+ * Type guard which checks whether the passed in value is a valid
+ * YouTube URL.
+ */
+export const isYouTubeUrl = (val) => {
+    return isString(val) && (val.startsWith("https://www.youtube.com") ||
+        val.startsWith("https://youtube.com") ||
+        val.startsWith("https://youtu.be"));
+};
+/**
+ * **isYouTubeShareUrl**`(val)`
+ *
+ * Type guard which checks whether the passed in value is a URL
+ * from YouTube's _URL shortening_ site `https://youtu.be`.
+ */
+export const isYouTubeShareUrl = (val) => {
+    return isString(val) && val.startsWith(`https://youtu.be`);
+};
+/**
+ * **isYouTubeVideoUrl**`(val)`
+ *
+ * Type guard which checks whether the passed in value is a valid
+ * YouTube URL _which plays video_.
+ */
+export const isYouTubeVideoUrl = (val) => {
+    return isString(val) && (val.startsWith("https://www.youtube.com") ||
+        val.startsWith("https://youtube.com") ||
+        val.startsWith("https://youtu.be"));
+};
+/**
+ * **isYouTubePlaylistUrl**`(val)`
+ *
+ * Type guard which checks whether the passed in value is a valid
+ * YouTube URL which points to a "playlist" on the platform.
+ */
+export const isYouTubePlaylistUrl = (val) => {
+    return isString(val) && (val === `https://www.youtube.com/feed/playlists` ||
+        val === `https://youtube.com/feed/playlists` ||
+        val === `https://www.youtube.com/channel/playlists` ||
+        val === `https://youtube.com/channel/playlists` ||
+        (val.startsWith(`https://www.youtube.com/@`) && val.endsWith(`/playlists`)) ||
+        (val.startsWith(`https://youtube.com/@`) && val.endsWith(`/playlists`)));
+};
+/**
+ * maps the "feed type" to a URL path
+ */
+const feed_map = (type) => {
+    return isUndefined(type)
+        ? `/feed`
+        : type === "liked"
+            ? `/playlist?list=LL`
+            : ["history", "playlists", "trending", "subscriptions"].includes(type)
+                ? `/feed/${type}`
+                : `/feed/`;
+};
+/**
+ * **isYouTubeFeedUrl**`(val,[kind])**
+ *
+ * Type guard which checks whether the passed in value is a valid
+ * YouTube URL which responds with "feed" content. This is content
+ * which is available to a logged in user and helps them see lists
+ * of videos related to their settings.
+ *
+ * By default any "feed" URL is matched but you can narrow that down
+ * to a specific feed type by specifying the `kind` variable.
+ */
+export const isYouTubeFeedUrl = (val, type = undefined) => {
+    return isString(val) && (val.startsWith(`https://www.youtube.com${feed_map(type)}`) ||
+        val.startsWith(`https://youtube.com${feed_map(type)}`));
+};
+export const isYouTubeCreatorUrl = (url) => {
+    return isString(url) && (url.startsWith(`https://www.youtube.com/@`) ||
+        url.startsWith(`https://youtube.com/@`) ||
+        url.startsWith(`https://www.youtube.com/channel/`));
+};
+export const isYouTubeVideosInPlaylist = (val) => {
+    return isString(val) && (val.startsWith(`https://www.youtube.com/playlist?`) ||
+        val.startsWith(`https://youtube.com/playlist?`)) && hasUrlQueryParameter(val, "list");
+};

package/dist/types/api/api.d.ts

@@ -1,4 +1,4 @@
-import { Dictionary, EmptyObject, TypedFunction, Contains, IsNever, Values, Throw, AfterFirst, First, FindExtends, ExpandRecursively, ShapeCallback, Scalar, TupleToUnion } from "../index";
+import { Dictionary, EmptyObject, TypedFunction, Values, Throw, AfterFirst, First, ExpandRecursively, TupleToUnion, Unset, PublicKeyOf, IfUnset, KeyOf, Fail, Extends, UpsertKeyValue, Tuple, ReduceValues, IsEscapeFunction, RemoveNever, If, WhenNever, HasEscapeFunction, ErrorCondition } from "../index";
 /**
  * **ValueCallback**`<TVal, TReturn>`
  *
@@ -10,16 +10,16 @@ import { Dictionary, EmptyObject, TypedFunction, Contains, IsNever, Values, Thro
  * ```
  */
 export type ValueCallback<TVal, TReturn> = <V extends TVal>(v: V) => TReturn;
-export type EscapeFunction<T extends () => any = () => any> = T & {
-    escape: true;
-};
+type _GetEscapeFunction<T extends readonly unknown[]> = WhenNever<First<RemoveNever<{
+    [K in keyof T]: If<IsEscapeFunction<T[K]>, T[K], never>;
+}>>, Throw<"no-escape-function">>;
 /**
- * **HasEscapeFunction**`<T>`
+ * **GetEscapeFunction**`<T>`
  *
- * Checks whether the API surface passed in has an escape function defined.
+ * Gets an escape function from an `Api` and from a `Dictionary | TypeFunction`
+ * if it exists. If it does not exist then returns an ErrorCondition.
  */
-export type HasEscapeFunction<T extends Dictionary | TypedFunction> = T extends Dictionary ? Contains<Values<T>, EscapeFunction> : T extends TypedFunction ? T extends EscapeFunction ? true : false : false;
-export type GetEscapeFunction<T extends Dictionary | TypedFunction> = T extends Dictionary ? FindExtends<Values<T>, EscapeFunction> extends TypedFunction ? FindExtends<Values<T>, EscapeFunction> : never : T extends TypedFunction ? T extends EscapeFunction ? T : never : never;
+export type GetEscapeFunction<T extends Dictionary | TypedFunction | Api> = T extends Api ? _GetEscapeFunction<Values<T["surface"]>> : _GetEscapeFunction<Values<T>>;
 export type FluentState<T> = {
     state: T;
     config: {
@@ -39,28 +39,73 @@ type ExpandFluentFns<TFluentState extends FluentState<any>, TFns extends readonl
  * Defines the callback loop necessary to manage state via a
  * Fluent API.
  */
-type FluentApi<TSurface extends Dictionary | TypedFunction, TState, TFluentFns extends readonly FluentFn<TState, any, any>[]> = <T extends FluentState<TState>>(state: T) => ExpandRecursively<TSurface & ExpandFluentFns<FluentState<TState>, TFluentFns>>;
+export type FluentApi<TSurface extends Dictionary | TypedFunction, TState, TFluentFns extends readonly FluentFn<TState, any, any>[]> = <T extends FluentState<TState>>(state: T) => ExpandRecursively<TSurface & ExpandFluentFns<FluentState<TState>, TFluentFns>>;
+/**
+ * **ApiState**
+ *
+ * For API's which manage state, the state should be a Dictionary
+ * or Tuple in shape.
+ */
+export type ApiState = Dictionary | Tuple;
 /**
- * **ToFluent**`<TSurface,TState,TUseOnce>`
+ * **ApiConfig**`<TSurface,TState>`
  *
- * Upgrades a base API to an API which supports state management
- * and a Fluent API style.
+ * The configuration of your API provides opportunities to
+ * show or mask various parts of your surface area based on
+ * the current _state_ you are in.
  */
-export type ToFluent<TSurface extends Dictionary | TypedFunction, TState, TFluentFns extends readonly FluentFn<TState, any, any>[] = []> = {
-    addFluentFn: <TName extends string, TFn extends <TCb extends (<T extends FluentState<TState>>(state: T) => TypedFunction<TState>)>(cb: TCb) => void, TUse extends boolean = false>(name: TName, fn: TFn, useOnce?: TUse) => ToFluent<TSurface, TState, [
-        ...TFluentFns,
-        FluentFn<TState, TName, TFn>
-    ]>;
-    done: () => FluentApi<TSurface, TState, TFluentFns>;
+export type ApiConfig<TSurface extends ApiSurface<Api> = ApiSurface<Api>, TState extends ApiState = ApiState> = {
+    callOnce: readonly string[];
+    called: readonly string[];
+    mask: ((state: TState, called: readonly string[]) => readonly (KeyOf<TSurface>)[]);
 };
-export type Api<TSurface extends Dictionary | TypedFunction, TState = never> = HasEscapeFunction<TSurface> extends true ? IsNever<TState> extends true ? TSurface : ToFluent<TSurface, TState> : Throw<"no-escape-function">;
-export type ApiCallbackOptions<TProxy extends readonly (Scalar | ShapeCallback)[] = readonly (Scalar | ShapeCallback)[]> = {
+/**
+ * **ApiOptions**`<[TSurface]>`
+ *
+ * The _options_ which go into defining an API surface.
+ */
+export type ApiOptions<TSurface extends Dictionary | TypedFunction | Unset = Unset> = {
     /**
-     * Allow types _other_ than the callback API to be passed into this
-     * function and have them proxied through.
+     * any _state_ which the API is managing (making it a `FluentApi`)
+     *
+     * @default Unset;
      */
-    proxy?: TProxy;
+    state: Unset | Dictionary;
+    /**
+     * An array of _keys_ to the API surface which should only be allowed
+     * to be called once (and will be _masked_ thereafter from runtime).
+     *
+     * **Note:** _this only really makes sense when you're managing state_.
+     */
+    callOnce: IfUnset<TSurface, readonly PropertyKey[], readonly PublicKeyOf<AsApi<TSurface>>[]>;
 };
+/**
+ * **Api**
+ *
+ * An API definition typically created via `AsApi<TSurface,TOpts>` which is
+ * not responsible for managing state.
+ *
+ * **Related:** `FluentApi`, `AsFluentApi`
+ */
+export type Api<TSurface extends Dictionary | TypedFunction = Dictionary | TypedFunction> = {
+    _kind: "api";
+    surface: TSurface;
+};
+/**
+ * **ApiReturn**
+ *
+ * The expected/desired types that could result from calling the API's
+ * _endpoints_.
+ *
+ * Note: this does not consider the possibility of a user
+ */
+export type ApiReturn<T extends Api> = "surface" extends keyof T ? T["surface"] extends Dictionary ? TupleToUnion<ReduceValues<T["surface"]>> : never : unknown;
+/**
+ * **ApiSurface**`<T>`
+ *
+ * Extracts the API's surface area from an `Api`.
+ */
+export type ApiSurface<T extends Api> = T["surface"];
 /**
  * **ApiCallback**`<TSurface,[TOpts]>`
  *
@@ -72,28 +117,42 @@ export type ApiCallbackOptions<TProxy extends readonly (Scalar | ShapeCallback)[
  *
  * **Related:** `HandleApiCallback`, `ApiCallbackInfo`
  */
-export type ApiCallback<TSurface extends Dictionary | TypedFunction, TOpts extends ApiCallbackOptions = ApiCallbackOptions> = HasEscapeFunction<TSurface> extends true ? <TCall extends ((api: ExpandRecursively<TSurface>) => unknown) | (TOpts["proxy"] extends readonly unknown[] ? TupleToUnion<TOpts["proxy"]> : never)>(cb: TCall) => HandleApiCallback<TCall extends TypedFunction ? ReturnType<TCall> : TCall> : Throw<"no-escape-function">;
+export type ApiCallback<TApi extends Api> = <TCall extends (api: ApiSurface<TApi>) => unknown>(cb: TCall) => ReturnType<TCall>;
 /**
- * **ApiEscape**`<T>`
+ * **Api**`<TSurface>`
  *
- * Given a `T` which extends `Api` or `ApiCallback`, this utility will expose
- * the escape function.
+ * Validates a candidate for a _stateless_ API and returns it as an `Api<TSurface>`
+ * if valid. If not valid you'll get a `ErrorCondition`.
  */
-export type ApiEscape<T extends Dictionary | TypedFunction | ApiCallback<Dictionary | TypedFunction>> = T extends ApiCallback<Dictionary | TypedFunction> ? T extends TypedFunction ? Parameters<T>[0] extends Dictionary | TypedFunction ? GetEscapeFunction<Parameters<T>[0]> : never : never : GetEscapeFunction<T>;
+export type AsApi<TSurface extends Dictionary | TypedFunction> = HasEscapeFunction<TSurface> extends true ? Api<TSurface> : Throw<"no-escape-function">;
+export type ApiStateInitializer<TApi> = <T extends Dictionary>(state: T) => TApi;
 /**
- * **ApiReturn**`<T>`
+ * A builder API for defining _stateless_ API's.
  *
- * Given a `T` which extends `ApiCallback`, this utility will expose
- * the _default_ return value provided by the _escape function_.
+ * Note: ironically this is **not** a stateless API.
+ */
+export type DefineStatelessApi<T extends Dictionary = EmptyObject, _C extends {
+    called: readonly KeyOf<T>[];
+    callOnce: ["escapeFunction"];
+} = {
+    called: [];
+    callOnce: ["escapeFunction"];
+}> = ({
+    escapeFunction: (state: T) => <TKey extends string, TFn extends () => unknown>(key: Fail<TKey, Extends<TKey, KeyOf<T>>>, fn: TFn) => ReturnType<TFn>;
+    addFn: (state: T) => <TKey extends string, TFn extends TypedFunction>(key: Fail<TKey, KeyOf<T>>, fn: TFn) => ExpandRecursively<T["surface"] & Record<TKey, TFn>> extends T["surface"] ? UpsertKeyValue<T, "surface", ExpandRecursively<T["surface"] & Record<TKey, TFn>>> : never;
+});
+/**
+ * **ApiEscape**`<T>`
+ *
+ * Given a `T` which extends `Api` or `ApiCallback`, this utility will expose
+ * the escape function.
  */
-export type ApiReturn<T extends Dictionary | TypedFunction> = ApiEscape<T> extends TypedFunction ? ReturnType<ApiEscape<T>> : Throw<"no-escape-function">;
+export type ApiEscape<T extends Dictionary | TypedFunction | ApiCallback<Api>> = T extends ApiCallback<Api> ? T extends TypedFunction ? Parameters<T>[0] extends Dictionary | TypedFunction ? GetEscapeFunction<Parameters<T>[0]> : never : never : GetEscapeFunction<T>;
 /**
- * **HandleApiCallback**`<TReturn, TApi>`
+ * **ApiHandler**`<TApi,THandle>`
  *
- * Given a returned value `TReturn` from the callback,
- * it either proxies that value through if the user completed
- * the API calling, or calls the _escape function_ if not.
+ * An API handler for a specific API
  */
-export type HandleApiCallback<TReturn> = TReturn extends Dictionary | TypedFunction ? GetEscapeFunction<TReturn> extends TypedFunction ? ReturnType<GetEscapeFunction<TReturn>> : TReturn : TReturn;
+export type ApiHandler<TApi extends Api, _THandle extends (t: unknown, e: ErrorCondition) => unknown> = (api: TApi) => <R>(result: R) => unknown;
 export {};
 //# sourceMappingURL=api.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"api.d.ts","sourceRoot":"","sources":["../../../src/types/api/api.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,UAAU,EACV,WAAW,EACX,aAAa,EACb,QAAQ,EACR,OAAO,EACP,MAAM,EACN,KAAK,EACL,UAAU,EACV,KAAK,EACL,WAAW,EACX,iBAAiB,EACjB,aAAa,EACb,MAAM,EACN,YAAY,EACb,iBAAwB;AAEzB;;;;;;;;;GASG;AACH,MAAM,MAAM,aAAa,CACvB,IAAI,EACJ,OAAO,IACL,CAAC,CAAC,SAAS,IAAI,EAAE,CAAC,EAAE,CAAC,KAAK,OAAO,CAAC;AAEtC,MAAM,MAAM,cAAc,CACxB,CAAC,SAAS,MAAM,GAAG,GAAG,MAAM,GAAG,IAC7B,CAAC,GAAG;IAAE,MAAM,EAAE,IAAI,CAAA;CAAE,CAAA;AAExB;;;;GAIG;AACH,MAAM,MAAM,iBAAiB,CAC3B,CAAC,SAAS,UAAU,GAAG,aAAa,IAClC,CAAC,SAAS,UAAU,GACtB,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,cAAc,CAAC,GACnC,CAAC,SAAS,aAAa,GACrB,CAAC,SAAS,cAAc,GACtB,IAAI,GACJ,KAAK,GACP,KAAK,CAAC;AAEV,MAAM,MAAM,iBAAiB,CAC3B,CAAC,SAAS,UAAU,GAAG,aAAa,IAClC,CAAC,SAAS,UAAU,GACtB,WAAW,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,cAAc,CAAC,SAAS,aAAa,GAC1D,WAAW,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,cAAc,CAAC,GACtC,KAAK,GACP,CAAC,SAAS,aAAa,GACrB,CAAC,SAAS,cAAc,GACtB,CAAC,GACD,KAAK,GACP,KAAK,CAAC;AAEV,MAAM,MAAM,WAAW,CAAC,CAAC,IAAI;IAC3B,KAAK,EAAE,CAAC,CAAC;IACT,MAAM,EAAE;QACN,OAAO,EAAE,MAAM,CAAC,EAAE,CAAC;QACnB,IAAI,EAAE,MAAM,CAAC,EAAE,CAAC;KACjB,CAAC;CACH,CAAA;AAED,MAAM,MAAM,QAAQ,CAClB,MAAM,EACN,KAAK,SAAS,MAAM,EACpB,GAAG,SAAS,CAAC,GAAG,SAAS,CACvB,CAAC,CAAC,SAAS,WAAW,CAAC,MAAM,CAAC,EAAE,KAAK,EAAE,CAAC,KAAK,aAAa,CAAC,MAAM,CAAC,CAAC,EACnE,KAAK,SAAS,OAAO,EACrB,EAAE,EAAE,GAAG,EAAE,OAAO,CAAC,EAAE,KAAK,KAAK,IAAI,EACnC,KAAK,SAAS,OAAO,GAAG,KAAK,IAC3B;IACF,IAAI,EAAE,KAAK,CAAC;IACZ,EAAE,EAAE,GAAG,CAAC;IACR,OAAO,EAAE,KAAK,CAAC;CAChB,CAAA;AAGD,KAAK,eAAe,CAClB,YAAY,SAAS,WAAW,CAAC,GAAG,CAAC,EACrC,IAAI,SAAS,SAAS,QAAQ,CAAC,YAAY,CAAC,OAAO,CAAC,EAAE,GAAG,EAAE,GAAG,CAAC,EAAE,EACjE,UAAU,SAAS,UAAU,GAAG,WAAW,IACzC,EAAE,SAAS,IAAI,GACjB,UAAU,GACV,eAAe,CACb,YAAY,EACZ,UAAU,CAAC,IAAI,CAAC,EAChB,UAAU,GAAG,MAAM,CACjB,KAAK,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,EACnB,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,CAClB,CACF,CAAC;AAGJ;;;;;GAKG;AACH,KAAK,SAAS,CACZ,QAAQ,SAAS,UAAU,GAAG,aAAa,EAC3C,MAAM,EACN,UAAU,SAAS,SAAS,QAAQ,CAAC,MAAM,EAAE,GAAG,EAAE,GAAG,CAAC,EAAE,IACtD,CAAC,CAAC,SAAS,WAAW,CAAC,MAAM,CAAC,EAAE,KAAK,EAAE,CAAC,KAAK,iBAAiB,CAChE,QAAQ,GAAG,eAAe,CAAC,WAAW,CAAC,MAAM,CAAC,EAAC,UAAU,CAAC,CAC3D,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,QAAQ,CAClB,QAAQ,SAAS,UAAU,GAAG,aAAa,EAC3C,MAAM,EACN,UAAU,SAAS,SAAS,QAAQ,CAAC,MAAM,EAAE,GAAG,EAAE,GAAG,CAAC,EAAE,GAAG,EAAE,IAC3D;IACF,WAAW,EAAE,CACX,KAAK,SAAS,MAAM,EACpB,GAAG,SAAS,CAAC,GAAG,SAAS,CACvB,CAAC,CAAC,SAAS,WAAW,CAAC,MAAM,CAAC,EAAE,KAAK,EAAE,CAAC,KAAK,aAAa,CAAC,MAAM,CAAC,CACnE,EAAE,EAAE,EAAE,GAAG,KAAK,IAAI,EACnB,IAAI,SAAS,OAAO,GAAG,KAAK,EAC5B,IAAI,EAAE,KAAK,EAAE,EAAE,EAAE,GAAG,EAAE,OAAO,CAAC,EAAE,IAAI,KAAK,QAAQ,CAC/C,QAAQ,EACR,MAAM,EACN;QACE,GAAG,UAAU;QACb,QAAQ,CAAC,MAAM,EAAC,KAAK,EAAC,GAAG,CAAC;KAC3B,CACF,CAAC;IACJ,IAAI,EAAE,MAAM,SAAS,CAAC,QAAQ,EAAC,MAAM,EAAC,UAAU,CAAC,CAAC;CACnD,CAAC;AAGF,MAAM,MAAM,GAAG,CACb,QAAQ,SAAS,UAAU,GAAG,aAAa,EAC3C,MAAM,GAAG,KAAK,IACZ,iBAAiB,CAAC,QAAQ,CAAC,SAAS,IAAI,GACxC,OAAO,CAAC,MAAM,CAAC,SAAS,IAAI,GAC1B,QAAQ,GACR,QAAQ,CAAC,QAAQ,EAAC,MAAM,CAAC,GAC3B,KAAK,CAAC,oBAAoB,CAAC,CAAC;AAEhC,MAAM,MAAM,kBAAkB,CAC5B,MAAM,SAAS,SAAS,CAAC,MAAM,GAAG,aAAa,CAAC,EAAE,GAAI,SAAS,CAAC,MAAM,GAAG,aAAa,CAAC,EAAE,IACvF;IACF;;;OAGG;IACH,KAAK,CAAC,EAAG,MAAM,CAAC;CAGjB,CAAA;AAED;;;;;;;;;;GAUG;AACH,MAAM,MAAM,WAAW,CACrB,QAAQ,SAAS,UAAU,GAAG,aAAa,EAC3C,KAAK,SAAS,kBAAkB,GAAG,kBAAkB,IACnD,iBAAiB,CAAC,QAAQ,CAAC,SAAS,IAAI,GAC1C,CACE,KAAK,SAAS,CAAC,CAAC,GAAG,EAAE,iBAAiB,CAAC,QAAQ,CAAC,KAAK,OAAO,CAAC,GAAG,CAC9D,KAAK,CAAC,OAAO,CAAC,SAAS,SAAS,OAAO,EAAE,GACrC,YAAY,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,GAC5B,KAAK,CACR,EAEH,EAAE,EAAE,KAAK,KACL,iBAAiB,CAAC,KAAK,SAAS,aAAa,GACzC,UAAU,CAAC,KAAK,CAAC,GACjB,KAAK,CACR,GACP,KAAK,CAAC,oBAAoB,CAAC,CAAC;AAG9B;;;;;GAKG;AACH,MAAM,MAAM,SAAS,CACnB,CAAC,SAAS,UAAU,GAAG,aAAa,GAAG,WAAW,CAAC,UAAU,GAAG,aAAa,CAAC,IAC5E,CAAC,SAAS,WAAW,CAAE,UAAU,GAAG,aAAa,CAAC,GACpD,CAAC,SAAS,aAAa,GACrB,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,UAAU,GAAG,aAAa,GACjD,iBAAiB,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GACnC,KAAK,GACP,KAAK,GACP,iBAAiB,CAAC,CAAC,CAAC,CAAC;AAEvB;;;;;GAKG;AACH,MAAM,MAAM,SAAS,CACrB,CAAC,SAAS,UAAU,GAAG,aAAa,IAChC,SAAS,CAAC,CAAC,CAAC,SAAS,aAAa,GACpC,UAAU,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,GACxB,KAAK,CAAC,oBAAoB,CAAC,CAAC;AAG9B;;;;;;GAMG;AACH,MAAM,MAAM,iBAAiB,CAC3B,OAAO,IACL,OAAO,SAAS,UAAU,GAAG,aAAa,GAC5C,iBAAiB,CAAC,OAAO,CAAC,SAAS,aAAa,GAC9C,UAAU,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC,GACtC,OAAO,GACT,OAAO,CAAC"}
+{"version":3,"file":"api.d.ts","sourceRoot":"","sources":["../../../src/types/api/api.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,UAAU,EACV,WAAW,EACX,aAAa,EACb,MAAM,EACN,KAAK,EACL,UAAU,EACV,KAAK,EACL,iBAAiB,EACjB,YAAY,EACZ,KAAK,EACL,WAAW,EACX,OAAO,EACP,KAAK,EACL,IAAI,EACJ,OAAO,EACP,cAAc,EACd,KAAK,EACL,YAAY,EACZ,gBAAgB,EAChB,WAAW,EACX,EAAE,EACF,SAAS,EACT,iBAAiB,EACjB,cAAc,EACf,iBAAwB;AAEzB;;;;;;;;;GASG;AACH,MAAM,MAAM,aAAa,CACvB,IAAI,EACJ,OAAO,IACL,CAAC,CAAC,SAAS,IAAI,EAAE,CAAC,EAAE,CAAC,KAAK,OAAO,CAAC;AAGtC,KAAK,kBAAkB,CACrB,CAAC,SAAS,SAAS,OAAO,EAAE,IAC1B,SAAS,CACX,KAAK,CACH,WAAW,CAAC;KACT,CAAC,IAAI,MAAM,CAAC,GAAG,EAAE,CAChB,gBAAgB,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EACtB,CAAC,CAAC,CAAC,CAAC,EACJ,KAAK,CACN;CACF,CAAC,CACH,EACD,KAAK,CAAC,oBAAoB,CAAC,CAC5B,CAAC;AAGF;;;;;GAKG;AACH,MAAM,MAAM,iBAAiB,CAC3B,CAAC,SAAS,UAAU,GAAG,aAAa,GAAG,GAAG,IACxC,CAAC,SAAS,GAAG,GACb,kBAAkB,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,GACxC,kBAAkB,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;AAElC,MAAM,MAAM,WAAW,CAAC,CAAC,IAAI;IAC3B,KAAK,EAAE,CAAC,CAAC;IACT,MAAM,EAAE;QACN,OAAO,EAAE,MAAM,CAAC,EAAE,CAAC;QACnB,IAAI,EAAE,MAAM,CAAC,EAAE,CAAC;KACjB,CAAC;CACH,CAAA;AAED,MAAM,MAAM,QAAQ,CAClB,MAAM,EACN,KAAK,SAAS,MAAM,EACpB,GAAG,SAAS,CAAC,GAAG,SAAS,CACvB,CAAC,CAAC,SAAS,WAAW,CAAC,MAAM,CAAC,EAAE,KAAK,EAAE,CAAC,KAAK,aAAa,CAAC,MAAM,CAAC,CAAC,EACnE,KAAK,SAAS,OAAO,EACrB,EAAE,EAAE,GAAG,EAAE,OAAO,CAAC,EAAE,KAAK,KAAK,IAAI,EACnC,KAAK,SAAS,OAAO,GAAG,KAAK,IAC3B;IACF,IAAI,EAAE,KAAK,CAAC;IACZ,EAAE,EAAE,GAAG,CAAC;IACR,OAAO,EAAE,KAAK,CAAC;CAChB,CAAA;AAGD,KAAK,eAAe,CAClB,YAAY,SAAS,WAAW,CAAC,GAAG,CAAC,EACrC,IAAI,SAAS,SAAS,QAAQ,CAAC,YAAY,CAAC,OAAO,CAAC,EAAE,GAAG,EAAE,GAAG,CAAC,EAAE,EACjE,UAAU,SAAS,UAAU,GAAG,WAAW,IACzC,EAAE,SAAS,IAAI,GACjB,UAAU,GACV,eAAe,CACb,YAAY,EACZ,UAAU,CAAC,IAAI,CAAC,EAChB,UAAU,GAAG,MAAM,CACjB,KAAK,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,EACnB,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,CAClB,CACF,CAAC;AAGJ;;;;;GAKG;AACH,MAAM,MAAM,SAAS,CACnB,QAAQ,SAAS,UAAU,GAAG,aAAa,EAC3C,MAAM,EACN,UAAU,SAAS,SAAS,QAAQ,CAAC,MAAM,EAAE,GAAG,EAAE,GAAG,CAAC,EAAE,IACtD,CAAC,CAAC,SAAS,WAAW,CAAC,MAAM,CAAC,EAAE,KAAK,EAAE,CAAC,KAAK,iBAAiB,CAChE,QAAQ,GAAG,eAAe,CAAC,WAAW,CAAC,MAAM,CAAC,EAAC,UAAU,CAAC,CAC3D,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,QAAQ,GAAG,UAAU,GAAG,KAAK,CAAC;AAE1C;;;;;;GAMG;AACH,MAAM,MAAM,SAAS,CACnB,QAAQ,SAAS,UAAU,CAAC,GAAG,CAAC,GAAG,UAAU,CAAC,GAAG,CAAC,EAClD,MAAM,SAAS,QAAQ,GAAG,QAAQ,IAChC;IACF,QAAQ,EAAE,SAAS,MAAM,EAAE,CAAC;IAC5B,MAAM,EAAE,SAAS,MAAM,EAAE,CAAC;IAC1B,IAAI,EAAE,CAAC,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,SAAS,MAAM,EAAE,KAAK,SAAS,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,CAAA;CACnF,CAAC;AAuCF;;;;GAIG;AACH,MAAM,MAAM,UAAU,CACpB,QAAQ,SAAS,UAAU,GAAG,aAAa,GAAG,KAAK,GAAG,KAAK,IACxD;IACH;;;;OAIG;IACH,KAAK,EAAE,KAAK,GAAG,UAAU,CAAC;IAE1B;;;;;OAKG;IACH,QAAQ,EAAE,OAAO,CAAC,QAAQ,EAAE,SAAS,WAAW,EAAE,EAAE,SAAS,WAAW,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,CAAC;CAE9F,CAAC;AAIF;;;;;;;GAOG;AACH,MAAM,MAAM,GAAG,CACb,QAAQ,SAAS,UAAU,GAAG,aAAa,GAAG,UAAU,GAAG,aAAa,IACtE;IACF,KAAK,EAAE,KAAK,CAAC;IACb,OAAO,EAAE,QAAQ,CAAC;CACnB,CAAA;AAED;;;;;;;GAOG;AACH,MAAM,MAAM,SAAS,CACnB,CAAC,SAAS,GAAG,IACX,SAAS,SAAS,MAAM,CAAC,GAC3B,CAAC,CAAC,SAAS,CAAC,SAAS,UAAU,GAC7B,YAAY,CAAC,YAAY,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,GACxC,KAAK,GACP,OAAO,CAAC;AAGV;;;;GAIG;AACH,MAAM,MAAM,UAAU,CAAC,CAAC,SAAS,GAAG,IAAI,CAAC,CAAC,SAAS,CAAC,CAAC;AAErD;;;;;;;;;;GAUG;AACH,MAAM,MAAM,WAAW,CACrB,IAAI,SAAS,GAAG,IACd,CAAC,KAAK,SAAS,CAAC,GAAG,EAAE,UAAU,CAAC,IAAI,CAAC,KAAK,OAAO,EAAE,EAAE,EAAE,KAAK,KAAK,UAAU,CAAC,KAAK,CAAC,CAAC;AAgBvF;;;;;GAKG;AACH,MAAM,MAAM,KAAK,CACf,QAAQ,SAAS,UAAU,GAAG,aAAa,IACzC,iBAAiB,CAAC,QAAQ,CAAC,SAAS,IAAI,GACxC,GAAG,CAAC,QAAQ,CAAC,GACb,KAAK,CAAC,oBAAoB,CAAC,CAAC;AAEhC,MAAM,MAAM,mBAAmB,CAC7B,IAAI,IACF,CAAC,CAAC,SAAS,UAAU,EAAE,KAAK,EAAE,CAAC,KAAK,IAAI,CAAC;AAE7C;;;;GAIG;AACH,MAAM,MAAM,kBAAkB,CAC5B,CAAC,SAAS,UAAU,GAAG,WAAW,EAClC,EAAE,SAAS;IACT,MAAM,EAAE,SAAS,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC;IAC5B,QAAQ,EAAE,CAAC,gBAAgB,CAAC,CAAC;CAC9B,GAAG;IAAE,MAAM,EAAE,EAAE,CAAC;IAAC,QAAQ,EAAE,CAAC,gBAAgB,CAAC,CAAA;CAAC,IAC7C,CAAC;IACH,cAAc,EAAE,CAAC,KAAK,EAAE,CAAC,KAAK,CAC5B,IAAI,SAAS,MAAM,EACnB,GAAG,SAAS,MAAM,OAAO,EAEzB,GAAG,EAAE,IAAI,CAAC,IAAI,EAAE,OAAO,CAAC,IAAI,EAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAE,EACxC,EAAE,EAAE,GAAG,KACJ,UAAU,CAAC,GAAG,CAAC,CAAC;IACrB,KAAK,EAAE,CAAC,KAAK,EAAE,CAAC,KAAK,CACnB,IAAI,SAAS,MAAM,EACnB,GAAG,SAAS,aAAa,EACzB,GAAG,EAAE,IAAI,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,EAAE,EAAE,GAAG,KAClC,iBAAiB,CAAC,CAAC,CAAC,SAAS,CAAC,GAAG,MAAM,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC,SAAS,CAAC,CAAC,SAAS,CAAC,GACnE,cAAc,CAAC,CAAC,EAAE,SAAS,EAAG,iBAAiB,CAAC,CAAC,CAAC,SAAS,CAAC,GAAG,MAAM,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC,CAAC,GACnF,KAAK,CAAA;CAEZ,CAAC,CAAC;AAIH;;;;;GAKG;AACH,MAAM,MAAM,SAAS,CACnB,CAAC,SAAS,UAAU,GAAG,aAAa,GAAG,WAAW,CAAC,GAAG,CAAC,IACrD,CAAC,SAAS,WAAW,CAAC,GAAG,CAAC,GAC5B,CAAC,SAAS,aAAa,GACrB,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,UAAU,GAAG,aAAa,GACjD,iBAAiB,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GACnC,KAAK,GACP,KAAK,GACP,iBAAiB,CAAC,CAAC,CAAC,CAAC;AAkBvB;;;;GAIG;AACH,MAAM,MAAM,UAAU,CACpB,IAAI,SAAS,GAAG,EAChB,QAAQ,SAAS,CAAC,CAAC,EAAE,OAAO,EAAE,CAAC,EAAE,cAAc,KAAK,OAAO,IACzD,CAAC,GAAG,EAAE,IAAI,KAAK,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,KAAK,OAAO,CAAC"}

package/dist/types/base-types/fns/EscapeFunction.d.ts

@@ -0,0 +1,22 @@
+import { ExpandDictionary, ExpandRecursively, FnProps } from "../..";
+/**
+ * **EscapeFunction**`<[T]>`
+ *
+ * An escape function is a function which takes no parameters and
+ * marks itself by setting the key `escape` to the value **true**.
+ *
+ * If this utility is used with a generic it will ensure that the function
+ * has the `escape` property set. If no generic is used then it will just
+ * present a generalized shape for escape functions.
+ * ```ts
+ * // () => string & {escape: true}
+ * type Esc = EscapeFunction<() => string>;
+ * // () => unknown & {escape: true}
+ * type Esc2 = EscapeFunction;
+ * ```
+ */
+export type EscapeFunction = () => any & {
+    escape: true;
+};
+export type AsEscapeFunction<T> = T extends EscapeFunction ? ExpandRecursively<T & ExpandDictionary<Record<"escape", true> & FnProps<T>>> : never;
+//# sourceMappingURL=EscapeFunction.d.ts.map

package/dist/types/base-types/fns/EscapeFunction.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"EscapeFunction.d.ts","sourceRoot":"","sources":["../../../../src/types/base-types/fns/EscapeFunction.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,iBAAiB,EAAE,OAAO,EAAE,MAAM,OAAO,CAAC;AAErE;;;;;;;;;;;;;;;GAeG;AACH,MAAM,MAAM,cAAc,GAAG,MAAM,GAAG,GAAG;IAAC,MAAM,EAAE,IAAI,CAAA;CAAC,CAAC;AAExD,MAAM,MAAM,gBAAgB,CAAC,CAAC,IAAI,CAAC,SAAS,cAAc,GACxD,iBAAiB,CAAC,CAAC,GAAG,gBAAgB,CAAC,MAAM,CAAC,QAAQ,EAAC,IAAI,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,GAC3E,KAAK,CAAC"}

package/dist/types/base-types/fns/OptionalParamFn.d.ts

@@ -0,0 +1,30 @@
+import { If, Some, Throw, TypedFunction } from "../../index";
+/**
+ * **OptionalParamFn**
+ *
+ * A function which either has _no_ parameters or any parameters it
+ * does have are _optional_ in a way that it is safe to call it without
+ * any parameters.
+ *
+ * To make the runtime aware of this flexibility, a property `optionalParams`
+ * must be set to **true**. To convert a regular function to be this kind of
+ * function you can use the `AsOptionalParamFn` utility.
+ */
+export type OptionalParamFn = ((() => any) | ((p1?: any, p2?: any, p3?: any, p4?: any) => any)) & {
+    optionalParams: true;
+};
+/**
+ * **AsOptionalParamFn**`<T>`
+ *
+ * Converts the function passed in into a `OptionalParamFn` where possible and
+ * converts to `ErrorCondition<"invalid-conversion">` otherwise.
+ */
+export type AsOptionalParamFn<T extends TypedFunction> = Parameters<T>["length"] extends 0 ? T & {
+    optionalParams: true;
+} : If<Some<Parameters<T>, "extends", undefined>, Throw<"invalid-conversion", `To convert to a OptionalParamFn, a function must have _no_ required Parameters but required params were found!`, `AsOptionalParamFn`, {
+    library: "inferred-types";
+    params: Parameters<T>;
+}>, T & {
+    optionalParams: true;
+}>;
+//# sourceMappingURL=OptionalParamFn.d.ts.map

package/dist/types/base-types/fns/OptionalParamFn.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"OptionalParamFn.d.ts","sourceRoot":"","sources":["../../../../src/types/base-types/fns/OptionalParamFn.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,EAAE,EACF,IAAI,EACJ,KAAK,EACL,aAAa,EACd,oBAAwB;AAGzB;;;;;;;;;;GAUG;AACH,MAAM,MAAM,eAAe,GAAG,CAC5B,CAAC,MAAM,GAAG,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,EAAE,GAAG,EAAE,EAAE,CAAC,EAAE,GAAG,EAAE,EAAE,CAAC,EAAE,GAAG,EAAE,EAAE,CAAC,EAAC,GAAG,KAAK,GAAG,CAAC,CAC/D,GAAG;IAAE,cAAc,EAAE,IAAI,CAAA;CAAE,CAAC;AAI7B;;;;;GAKG;AACH,MAAM,MAAM,iBAAiB,CAAC,CAAC,SAAS,aAAa,IAAI,UAAU,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,SAAS,CAAC,GACxF,CAAC,GAAG;IAAE,cAAc,EAAE,IAAI,CAAA;CAAE,GAC5B,EAAE,CACA,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE,SAAS,EAAE,SAAS,CAAC,EACzC,KAAK,CACH,oBAAoB,EAAE,gHAAgH,EACtI,mBAAmB,EACnB;IAAE,OAAO,EAAE,gBAAgB,CAAC;IAAC,MAAM,EAAE,UAAU,CAAC,CAAC,CAAC,CAAA;CAAE,CACrD,EACD,CAAC,GAAG;IAAE,cAAc,EAAE,IAAI,CAAA;CAAE,CAC7B,CAAC"}

package/dist/types/base-types/fns/index.d.ts

@@ -5,4 +5,6 @@ export * from "./IdentityFunction";
 export * from "./AnyFunction";
 export * from "./TypedFunction";
 export * from "./AnyFnWithDict";
+export * from "./OptionalParamFn";
+export * from "./EscapeFunction";
 //# sourceMappingURL=index.d.ts.map

package/dist/types/base-types/fns/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/types/base-types/fns/index.ts"],"names":[],"mappings":"AAAA,cAAc,cAAc,CAAC;AAC7B,cAAc,aAAa,CAAC;AAC5B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,oBAAoB,CAAC;AACnC,cAAc,eAAe,CAAC;AAC9B,cAAc,iBAAiB,CAAA;AAC/B,cAAc,iBAAiB,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/types/base-types/fns/index.ts"],"names":[],"mappings":"AAAA,cAAc,cAAc,CAAC;AAC7B,cAAc,aAAa,CAAC;AAC5B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,oBAAoB,CAAC;AACnC,cAAc,eAAe,CAAC;AAC9B,cAAc,iBAAiB,CAAA;AAC/B,cAAc,iBAAiB,CAAA;AAC/B,cAAc,mBAAmB,CAAA;AACjC,cAAc,kBAAkB,CAAA"}

package/dist/types/base-types/fns/index.js

@@ -5,3 +5,5 @@ export * from "./IdentityFunction.js";
 export * from "./AnyFunction.js";
 export * from "./TypedFunction.js";
 export * from "./AnyFnWithDict.js";
+export * from "./OptionalParamFn.js";
+export * from "./EscapeFunction.js";

package/dist/types/boolean-logic/branching/If.d.ts

@@ -1,14 +1,13 @@
-import { ErrorCondition, IsBoolean, IsBooleanLiteral, IsFalse, IsNever, IsTrue, LogicFunction, ProxyError, Throw } from "../../index";
+import { ErrorCondition, IsBoolean, IsBooleanLiteral, IsFalse, IsNever, IsTrue, LogicFunction, Throw } from "../../index";
 type InvalidTest<TTest> = Throw<"invalid-test", `Call of If<TTest, ...> received an invalid TTest that does not evaluate to a boolean type!`, "If", {
     library: "inferred-types";
     test: TTest;
 }>;
-type ReceivedError<TTest extends ErrorCondition> = ProxyError<TTest, "If", "TTest">;
 /**
  * **If**`<TTest,[TIf],[TElse],[TMaybe]>`
  *
  * Branching utility which tests `TTest` for a boolean value.
  */
-export type If<TTest, TIf = true, TElse = false, TMaybe = TIf | TElse, TNever = never> = [IsNever<TTest>] extends [true] ? TNever : [TTest] extends [ErrorCondition] ? ReceivedError<TTest> : [TTest] extends [boolean] ? [IsTrue<TTest>] extends [true] ? TIf : [IsBooleanLiteral<TTest>] extends [true] ? TElse : TMaybe : [TTest] extends [LogicFunction] ? [IsTrue<ReturnType<TTest>>] extends [true] ? TIf : [IsFalse<ReturnType<TTest>>] extends [true] ? TElse : [IsBoolean<ReturnType<TTest>>] extends [true] ? TMaybe : never : InvalidTest<TTest>;
+export type If<TTest, TIf = true, TElse = false, TMaybe = TIf | TElse, TNever = never, TError = never> = [IsNever<TTest>] extends [true] ? TNever : [TTest] extends [ErrorCondition] ? TError : [TTest] extends [boolean] ? [IsTrue<TTest>] extends [true] ? TIf : [IsBooleanLiteral<TTest>] extends [true] ? TElse : TMaybe : [TTest] extends [LogicFunction] ? [IsTrue<ReturnType<TTest>>] extends [true] ? TIf : [IsFalse<ReturnType<TTest>>] extends [true] ? TElse : [IsBoolean<ReturnType<TTest>>] extends [true] ? TMaybe : never : InvalidTest<TTest>;
 export {};
 //# sourceMappingURL=If.d.ts.map

package/dist/types/boolean-logic/branching/If.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"If.d.ts","sourceRoot":"","sources":["../../../../src/types/boolean-logic/branching/If.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,SAAS,EAAE,gBAAgB,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,aAAa,EAAE,UAAU,EAAE,KAAK,EAAG,oBAAwB;AAE3I,KAAK,WAAW,CAAC,KAAK,IAAI,KAAK,CAC7B,cAAc,EACd,4FAA4F,EAC5F,IAAI,EACJ;IACE,OAAO,EAAE,gBAAgB,CAAC;IAC1B,IAAI,EAAE,KAAK,CAAC;CACb,CACF,CAAA;AAED,KAAK,aAAa,CAAC,KAAK,SAAS,cAAc,IAAI,UAAU,CAC3D,KAAK,EACL,IAAI,EACJ,OAAO,CACR,CAAA;AAaD;;;;GAIG;AACH,MAAM,MAAM,EAAE,CACZ,KAAK,EACL,GAAG,GAAG,IAAI,EACV,KAAK,GAAG,KAAK,EACb,MAAM,GAAG,GAAG,GAAG,KAAK,EACpB,MAAM,GAAG,KAAK,IACX,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,SAAS,CAAC,IAAI,CAAC,GAClC,MAAM,GACN,CAAC,KAAK,CAAC,SAAS,CAAC,cAAc,CAAC,GAC9B,aAAa,CAAC,KAAK,CAAC,GACtB,CAAC,KAAK,CAAC,SAAS,CAAC,OAAO,CAAC,GACvB,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,SAAS,CAAC,IAAI,CAAC,GAC5B,GAAG,GACH,CAAC,gBAAgB,CAAC,KAAK,CAAC,CAAC,SAAS,CAAC,IAAI,CAAC,GACtC,KAAK,GACL,MAAM,GACV,CAAC,KAAK,CAAC,SAAS,CAAC,aAAa,CAAC,GAC7B,CAAC,MAAM,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC,IAAI,CAAC,GACxC,GAAG,GACL,CAAC,OAAO,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC,IAAI,CAAC,GACzC,KAAK,GACL,CAAC,SAAS,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC,IAAI,CAAC,GAC3C,MAAM,GACN,KAAK,GACT,WAAW,CAAC,KAAK,CAAC,CAAC"}
+{"version":3,"file":"If.d.ts","sourceRoot":"","sources":["../../../../src/types/boolean-logic/branching/If.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,SAAS,EAAE,gBAAgB,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,aAAa,EAAE,KAAK,EAAG,oBAAwB;AAE/H,KAAK,WAAW,CAAC,KAAK,IAAI,KAAK,CAC7B,cAAc,EACd,4FAA4F,EAC5F,IAAI,EACJ;IACE,OAAO,EAAE,gBAAgB,CAAC;IAC1B,IAAI,EAAE,KAAK,CAAC;CACb,CACF,CAAA;AAeD;;;;GAIG;AACH,MAAM,MAAM,EAAE,CACZ,KAAK,EACL,GAAG,GAAG,IAAI,EACV,KAAK,GAAG,KAAK,EACb,MAAM,GAAG,GAAG,GAAG,KAAK,EACpB,MAAM,GAAG,KAAK,EACd,MAAM,GAAG,KAAK,IACX,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,SAAS,CAAC,IAAI,CAAC,GAClC,MAAM,GACN,CAAC,KAAK,CAAC,SAAS,CAAC,cAAc,CAAC,GAC9B,MAAM,GACR,CAAC,KAAK,CAAC,SAAS,CAAC,OAAO,CAAC,GACvB,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,SAAS,CAAC,IAAI,CAAC,GAC5B,GAAG,GACH,CAAC,gBAAgB,CAAC,KAAK,CAAC,CAAC,SAAS,CAAC,IAAI,CAAC,GACtC,KAAK,GACL,MAAM,GACV,CAAC,KAAK,CAAC,SAAS,CAAC,aAAa,CAAC,GAC7B,CAAC,MAAM,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC,IAAI,CAAC,GACxC,GAAG,GACL,CAAC,OAAO,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC,IAAI,CAAC,GACzC,KAAK,GACL,CAAC,SAAS,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC,IAAI,CAAC,GAC3C,MAAM,GACN,KAAK,GACT,WAAW,CAAC,KAAK,CAAC,CAAC"}

package/dist/types/boolean-logic/branching/IfUnset.d.ts

@@ -0,0 +1,12 @@
+import { IsUndefined, Unset } from "../../index";
+/**
+ * **IfUnset**`<TTest,TElse,[TIf]>`
+ *
+ * Branching utility which will proxy _any_ type through except
+ * for those set with `Unset<[T]>`.
+ *
+ * When `Unset` is found then it will be replaced with `TElse`.
+ */
+export type IfUnset<TTest, TElse, TIf = TTest> = TTest extends Unset ? TElse : Exclude<TIf, Unset>;
+export type IfUnsetOrUndefined<TTest, TElse, TIf = TTest> = TTest extends Unset ? TElse : IsUndefined<TTest> extends true ? TElse : Exclude<TIf, Unset | undefined>;
+//# sourceMappingURL=IfUnset.d.ts.map

package/dist/types/boolean-logic/branching/IfUnset.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"IfUnset.d.ts","sourceRoot":"","sources":["../../../../src/types/boolean-logic/branching/IfUnset.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,WAAW,EACX,KAAK,EACN,oBAAwB;AAGzB;;;;;;;GAOG;AACH,MAAM,MAAM,OAAO,CACjB,KAAK,EACL,KAAK,EACL,GAAG,GAAG,KAAK,IACT,KAAK,SAAS,KAAK,GACrB,KAAK,GACL,OAAO,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;AAGtB,MAAM,MAAM,kBAAkB,CAC9B,KAAK,EACL,KAAK,EACL,GAAG,GAAG,KAAK,IACP,KAAK,SAAS,KAAK,GACrB,KAAK,GACL,WAAW,CAAC,KAAK,CAAC,SAAS,IAAI,GAC/B,KAAK,GACL,OAAO,CAAC,GAAG,EAAE,KAAK,GAAG,SAAS,CAAC,CAAC"}

package/dist/types/boolean-logic/branching/OnPass.d.ts

@@ -5,12 +5,13 @@ export type OnPassRemap<TNever = unknown, TFalse = unknown, TError = unknown> =
     false: TFalse;
     error: TError;
 };
-type Merge<A extends Partial<OnPassRemap>, TKeys extends readonly (ObjectKey & keyof A)[], TConfig extends OnPassRemap = {
+type Merge<TUser extends Partial<OnPassRemap>, TKeys extends readonly (ObjectKey & keyof TUser)[], TConfig extends OnPassRemap = {
     never: never;
     false: false;
     error: Constant<"not-set">;
-}> = [] extends TKeys ? TConfig : Merge<A, AfterFirst<TKeys>, As<ExpandDictionary<Record<First<TKeys>, A[First<TKeys>]> & Omit<TConfig, First<TKeys>>>, OnPassRemap>>;
+}> = [] extends TKeys ? TConfig : Merge<TUser, AfterFirst<TKeys>, As<ExpandDictionary<Record<First<TKeys>, TUser[First<TKeys>]> & Omit<TConfig, First<TKeys>>>, OnPassRemap>>;
 type Process<TTest, TPass, TRemap extends OnPassRemap<unknown, unknown, unknown>> = [IsNever<TTest>] extends [true] ? TRemap["never"] : [IsErrorCondition<TTest>] extends [true] ? TRemap["error"] extends Constant<"not-set"> ? TTest : TRemap["error"] : [IsFalse<TTest>] extends [true] ? TRemap["false"] : TPass;
+type Iterate<TTest extends readonly unknown[], TPass, TRemap extends OnPassRemap<unknown, unknown, unknown>> = [] extends TTest ? TPass : Process<First<TTest>, TPass, TRemap> extends TPass ? Iterate<AfterFirst<TTest>, TPass, TRemap> : Process<First<TTest>, TPass, TRemap>;
 /**
  * **OnPass**`<TTest, TPass,[TRemap],[TFalse]>`
  *
@@ -24,6 +25,6 @@ type Process<TTest, TPass, TRemap extends OnPassRemap<unknown, unknown, unknown>
  * - the `TRemap` allows you to remap error conditions
  * as well if needed
  */
-export type OnPass<TTest, TPass, TRemap extends Partial<OnPassRemap<unknown, unknown, unknown>> = OnPassRemap<never, false, Constant<"not-set">>> = Process<TTest, TPass, TRemap extends OnPassRemap<never, false, Constant<"not-set">> ? TRemap : Merge<TRemap, Keys<TRemap>>>;
+export type OnPass<TTest, TPass, TRemap extends Partial<OnPassRemap<unknown, unknown, unknown>> = OnPassRemap<never, false, Constant<"not-set">>> = TTest extends readonly unknown[] ? Iterate<TTest, TPass, TRemap extends OnPassRemap<never, false, Constant<"not-set">> ? TRemap : Merge<TRemap, Keys<TRemap>>> : Process<TTest, TPass, TRemap extends OnPassRemap<never, false, Constant<"not-set">> ? TRemap : Merge<TRemap, Keys<TRemap>>>;
 export {};
 //# sourceMappingURL=OnPass.d.ts.map

package/dist/types/boolean-logic/branching/OnPass.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"OnPass.d.ts","sourceRoot":"","sources":["../../../../src/types/boolean-logic/branching/OnPass.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,UAAU,EACV,EAAE,EACF,gBAAgB,EAChB,KAAK,EACL,IAAI,EACJ,SAAS,EACT,gBAAgB,EAChB,OAAO,EACP,OAAO,EACR,oBAAwB;AACzB,OAAO,EAAE,QAAQ,EAAE,iCAA4B;AAE/C,MAAM,MAAM,WAAW,CACrB,MAAM,GAAG,OAAO,EAChB,MAAM,GAAG,OAAO,EAChB,MAAM,GAAG,OAAO,IACd;IACF,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;CACf,CAAA;AAED,KAAK,KAAK,CACR,CAAC,SAAS,OAAO,CAAC,WAAW,CAAC,EAC9B,KAAK,SAAS,SAAS,CAAC,SAAS,GAAG,MAAM,CAAC,CAAC,EAAE,EAC9C,OAAO,SAAS,WAAW,GAAG;IAAE,KAAK,EAAE,KAAK,CAAC;IAAC,KAAK,EAAE,KAAK,CAAC;IAAC,KAAK,EAAE,QAAQ,CAAC,SAAS,CAAC,CAAA;CAAE,IACtF,EAAE,SAAS,KAAK,GAChB,OAAO,GACP,KAAK,CACL,CAAC,EACD,UAAU,CAAC,KAAK,CAAC,EACjB,EAAE,CAAC,gBAAgB,CACjB,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,GACnC,IAAI,CAAC,OAAO,EAAE,KAAK,CAAC,KAAK,CAAC,CAAC,CAC9B,EAAE,WAAW,CAAC,CAChB,CAAC;AAGJ,KAAK,OAAO,CACV,KAAK,EACL,KAAK,EACL,MAAM,SAAS,WAAW,CAAC,OAAO,EAAE,OAAO,EAAE,OAAO,CAAC,IACnD,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,SAAS,CAAC,IAAI,CAAC,GAC/B,MAAM,CAAC,OAAO,CAAC,GACf,CAAC,gBAAgB,CAAC,KAAK,CAAC,CAAC,SAAS,CAAC,IAAI,CAAC,GACxC,MAAM,CAAC,OAAO,CAAC,SAAS,QAAQ,CAAC,SAAS,CAAC,GAAG,KAAK,GAAG,MAAM,CAAC,OAAO,CAAC,GACrE,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,SAAS,CAAC,IAAI,CAAC,GAC/B,MAAM,CAAC,OAAO,CAAC,GACf,KAAK,CAAC;AAEV;;;;;;;;;;;;GAYG;AACH,MAAM,MAAM,MAAM,CAChB,KAAK,EACL,KAAK,EACL,MAAM,SAAS,OAAO,CAAC,WAAW,CAAC,OAAO,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC,GAAG,WAAW,CAAC,KAAK,EAAE,KAAK,EAAE,QAAQ,CAAC,SAAS,CAAC,CAAC,IAG/G,OAAO,CACL,KAAK,EACL,KAAK,EACL,MAAM,SAAS,WAAW,CAAC,KAAK,EAAE,KAAK,EAAE,QAAQ,CAAC,SAAS,CAAC,CAAC,GAC3D,MAAM,GACN,KAAK,CAAC,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC,CAC9B,CAAC"}
+{"version":3,"file":"OnPass.d.ts","sourceRoot":"","sources":["../../../../src/types/boolean-logic/branching/OnPass.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,UAAU,EACV,EAAE,EACF,gBAAgB,EAChB,KAAK,EACL,IAAI,EACJ,SAAS,EACT,gBAAgB,EAChB,OAAO,EACP,OAAO,EACR,oBAAwB;AACzB,OAAO,EAAE,QAAQ,EAAE,iCAA4B;AAE/C,MAAM,MAAM,WAAW,CACrB,MAAM,GAAG,OAAO,EAChB,MAAM,GAAG,OAAO,EAChB,MAAM,GAAG,OAAO,IACd;IACF,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;CACf,CAAA;AAED,KAAK,KAAK,CACR,KAAK,SAAS,OAAO,CAAC,WAAW,CAAC,EAClC,KAAK,SAAS,SAAS,CAAC,SAAS,GAAG,MAAM,KAAK,CAAC,EAAE,EAClD,OAAO,SAAS,WAAW,GAAG;IAAE,KAAK,EAAE,KAAK,CAAC;IAAC,KAAK,EAAE,KAAK,CAAC;IAAC,KAAK,EAAE,QAAQ,CAAC,SAAS,CAAC,CAAA;CAAE,IACtF,EAAE,SAAS,KAAK,GAChB,OAAO,GACP,KAAK,CACL,KAAK,EACL,UAAU,CAAC,KAAK,CAAC,EACjB,EAAE,CAAC,gBAAgB,CACjB,MAAM,CACJ,KAAK,CAAC,KAAK,CAAC,EACZ,KAAK,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CACpB,GAAG,IAAI,CAAC,OAAO,EAAE,KAAK,CAAC,KAAK,CAAC,CAAC,CAChC,EAAE,WAAW,CAAC,CAChB,CAAC;AAGJ,KAAK,OAAO,CACV,KAAK,EACL,KAAK,EACL,MAAM,SAAS,WAAW,CAAC,OAAO,EAAE,OAAO,EAAE,OAAO,CAAC,IACnD,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,SAAS,CAAC,IAAI,CAAC,GAC/B,MAAM,CAAC,OAAO,CAAC,GACf,CAAC,gBAAgB,CAAC,KAAK,CAAC,CAAC,SAAS,CAAC,IAAI,CAAC,GACxC,MAAM,CAAC,OAAO,CAAC,SAAS,QAAQ,CAAC,SAAS,CAAC,GAAG,KAAK,GAAG,MAAM,CAAC,OAAO,CAAC,GACrE,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,SAAS,CAAC,IAAI,CAAC,GAC/B,MAAM,CAAC,OAAO,CAAC,GACf,KAAK,CAAC;AAEV,KAAK,OAAO,CACV,KAAK,SAAS,SAAS,OAAO,EAAE,EAChC,KAAK,EACL,MAAM,SAAS,WAAW,CAAC,OAAO,EAAE,OAAO,EAAE,OAAO,CAAC,IACnD,EAAE,SAAS,KAAK,GAClB,KAAK,GACL,OAAO,CACL,KAAK,CAAC,KAAK,CAAC,EACZ,KAAK,EACL,MAAM,CACP,SAAS,KAAK,GAGb,OAAO,CACL,UAAU,CAAC,KAAK,CAAC,EACjB,KAAK,EACL,MAAM,CACP,GACD,OAAO,CACP,KAAK,CAAC,KAAK,CAAC,EACZ,KAAK,EACL,MAAM,CACP,CAEF;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,MAAM,MAAM,CAChB,KAAK,EACL,KAAK,EACL,MAAM,SAAS,OAAO,CAAC,WAAW,CAAC,OAAO,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC,GAAG,WAAW,CAAC,KAAK,EAAE,KAAK,EAAE,QAAQ,CAAC,SAAS,CAAC,CAAC,IAC7G,KAAK,SAAS,SAAS,OAAO,EAAE,GAClC,OAAO,CAAC,KAAK,EAAC,KAAK,EAAC,MAAM,SAAS,WAAW,CAAC,KAAK,EAAE,KAAK,EAAE,QAAQ,CAAC,SAAS,CAAC,CAAC,GAC7E,MAAM,GACN,KAAK,CAAC,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC,CAC9B,GAED,OAAO,CACL,KAAK,EACL,KAAK,EACL,MAAM,SAAS,WAAW,CAAC,KAAK,EAAE,KAAK,EAAE,QAAQ,CAAC,SAAS,CAAC,CAAC,GAC3D,MAAM,GACN,KAAK,CAAC,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC,CAC9B,CAAC"}

package/dist/types/boolean-logic/branching/WhenNever.d.ts

@@ -0,0 +1,11 @@
+import { IsNever } from "../operators";
+/**
+ * **WhenNever**`<T, [TMapTo]>`
+ *
+ * When `T` is _never_ this utility will map it to `TMapTo`; in all
+ * other cases it just proxies `T` through.
+ *
+ * **Note:** if not specified, `TMapTo` will be set to **false**.
+ */
+export type WhenNever<T, TMapTo = false> = IsNever<T> extends true ? TMapTo : T;
+//# sourceMappingURL=WhenNever.d.ts.map

package/dist/types/boolean-logic/branching/WhenNever.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"WhenNever.d.ts","sourceRoot":"","sources":["../../../../src/types/boolean-logic/branching/WhenNever.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AAGvC;;;;;;;GAOG;AACH,MAAM,MAAM,SAAS,CACnB,CAAC,EACD,MAAM,GAAG,KAAK,IACZ,OAAO,CAAC,CAAC,CAAC,SAAS,IAAI,GACzB,MAAM,GACN,CAAC,CAAC"}

package/dist/types/boolean-logic/branching/index.d.ts

@@ -11,4 +11,6 @@ export * from "./Default";
 export * from "./Iff";
 export * from "./Fail";
 export * from "./OnPass";
+export * from "./IfUnset";
+export * from "./WhenNever";
 //# sourceMappingURL=index.d.ts.map