inferred-types 0.42.0 → 0.43.0

package/dist/types/lists/index.d.ts

@@ -2,10 +2,13 @@ export * from "./AfterFirst";
 export * from "./AllowNonTupleWhenSingular";
 export * from "./ArrayElementType";
 export * from "./First";
+export * from "./Second";
 export * from "./AsArray";
 export * from "./AsTuple";
 export * from "./FirstString";
 export * from "./Filter";
+export * from "./FilterLiterals";
+export * from "./FilterWideTypes";
 export * from "./Length";
 export * from "./Last";
 export * from "./IndexOf";
@@ -13,6 +16,8 @@ export * from "./UnionFromProp";
 export * from "./Flatten";
 export * from "./Reverse";
 export * from "./Retain";
+export * from "./RetainLiterals";
+export * from "./RetainWideTypes";
 export * from "./Find";
 export * from "./Slice";
 export * from "./Last";
@@ -24,11 +29,12 @@ export * from "./Filter";
 export * from "./NumericKeys";
 export * from "./ConvertAndMap";
 export * from "./ConvertAndMap";
+export * from "./ConvertSet";
 export * from "./Pop";
 export * from "./Shift";
 export * from "./ReplaceLast";
 export * from "./BeforeLast";
 export * from "./GetEach";
 export * from "./ToCSV";
-export * from "./extractors/index";
+export * from "./Push";
 //# sourceMappingURL=index.d.ts.map

package/dist/types/lists/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/types/lists/index.ts"],"names":[],"mappings":"AAOA,cAAc,cAAc,CAAC;AAC7B,cAAc,6BAA6B,CAAC;AAC5C,cAAc,oBAAoB,CAAC;AACnC,cAAc,SAAS,CAAC;AACxB,cAAc,WAAW,CAAC;AAC1B,cAAc,WAAW,CAAC;AAC1B,cAAc,eAAe,CAAC;AAC9B,cAAc,UAAU,CAAC;AACzB,cAAc,UAAU,CAAC;AACzB,cAAc,QAAQ,CAAC;AACvB,cAAc,WAAW,CAAC;AAC1B,cAAc,iBAAiB,CAAC;AAChC,cAAc,WAAW,CAAC;AAC1B,cAAc,WAAW,CAAC;AAC1B,cAAc,UAAU,CAAC;AACzB,cAAc,QAAQ,CAAC;AACvB,cAAc,SAAS,CAAC;AACxB,cAAc,QAAQ,CAAC;AACvB,cAAc,iBAAiB,CAAC;AAChC,cAAc,eAAe,CAAC;AAC9B,cAAc,kBAAkB,CAAC;AACjC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,UAAU,CAAC;AACzB,cAAc,eAAe,CAAC;AAC9B,cAAc,iBAAiB,CAAC;AAChC,cAAc,iBAAiB,CAAC;AAChC,cAAc,OAAO,CAAC;AACtB,cAAc,SAAS,CAAC;AACxB,cAAc,eAAe,CAAC;AAC9B,cAAc,cAAc,CAAC;AAC7B,cAAc,WAAW,CAAC;AAC1B,cAAc,SAAS,CAAC;AAExB,cAAc,oBAAoB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/types/lists/index.ts"],"names":[],"mappings":"AAOA,cAAc,cAAc,CAAC;AAC7B,cAAc,6BAA6B,CAAC;AAC5C,cAAc,oBAAoB,CAAC;AACnC,cAAc,SAAS,CAAC;AACxB,cAAc,UAAU,CAAC;AACzB,cAAc,WAAW,CAAC;AAC1B,cAAc,WAAW,CAAC;AAC1B,cAAc,eAAe,CAAC;AAC9B,cAAc,UAAU,CAAC;AACzB,cAAc,kBAAkB,CAAC;AACjC,cAAc,mBAAmB,CAAC;AAClC,cAAc,UAAU,CAAC;AACzB,cAAc,QAAQ,CAAC;AACvB,cAAc,WAAW,CAAC;AAC1B,cAAc,iBAAiB,CAAC;AAChC,cAAc,WAAW,CAAC;AAC1B,cAAc,WAAW,CAAC;AAC1B,cAAc,UAAU,CAAC;AACzB,cAAc,kBAAkB,CAAC;AACjC,cAAc,mBAAmB,CAAC;AAClC,cAAc,QAAQ,CAAC;AACvB,cAAc,SAAS,CAAC;AACxB,cAAc,QAAQ,CAAC;AACvB,cAAc,iBAAiB,CAAC;AAChC,cAAc,eAAe,CAAC;AAC9B,cAAc,kBAAkB,CAAC;AACjC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,UAAU,CAAC;AACzB,cAAc,eAAe,CAAC;AAC9B,cAAc,iBAAiB,CAAC;AAChC,cAAc,iBAAiB,CAAC;AAChC,cAAc,cAAc,CAAC;AAC7B,cAAc,OAAO,CAAC;AACtB,cAAc,SAAS,CAAC;AACxB,cAAc,eAAe,CAAC;AAC9B,cAAc,cAAc,CAAC;AAC7B,cAAc,WAAW,CAAC;AAC1B,cAAc,SAAS,CAAC;AACxB,cAAc,QAAQ,CAAA"}

package/dist/types/lists/index.js

@@ -7,10 +7,13 @@ export * from "./AfterFirst.js";
 export * from "./AllowNonTupleWhenSingular.js";
 export * from "./ArrayElementType.js";
 export * from "./First.js";
+export * from "./Second.js";
 export * from "./AsArray.js";
 export * from "./AsTuple.js";
 export * from "./FirstString.js";
 export * from "./Filter.js";
+export * from "./FilterLiterals.js";
+export * from "./FilterWideTypes.js";
 export * from "./Length.js";
 export * from "./Last.js";
 export * from "./IndexOf.js";
@@ -18,6 +21,8 @@ export * from "./UnionFromProp.js";
 export * from "./Flatten.js";
 export * from "./Reverse.js";
 export * from "./Retain.js";
+export * from "./RetainLiterals.js";
+export * from "./RetainWideTypes.js";
 export * from "./Find.js";
 export * from "./Slice.js";
 export * from "./Last.js";
@@ -29,13 +34,14 @@ export * from "./Filter.js";
 export * from "./NumericKeys.js";
 export * from "./ConvertAndMap.js";
 export * from "./ConvertAndMap.js";
+export * from "./ConvertSet.js";
 export * from "./Pop.js";
 export * from "./Shift.js";
 export * from "./ReplaceLast.js";
 export * from "./BeforeLast.js";
 export * from "./GetEach.js";
 export * from "./ToCSV.js";
-export * from "./extractors/index.js";
+export * from "./Push.js";
 // #endregion auto-indexed files
 // see https://github.com/inocan-group/do-devops/docs/autoindex.md
 // for more info

package/dist/types/literals/Box.d.ts

@@ -1,4 +1,4 @@
-import { AnyFunction, HasParameters } from "../index";
+import { HasParameters, TypedFunction } from "../index";
 export interface Box<T> {
     __type: "box";
     value: T;
@@ -8,6 +8,6 @@ export interface Box<T> {
      * **note:** if the boxed value is a function with parameters you
      * can pass the parameters directly into the `b.unbox(params)` call.
      */
-    unbox: HasParameters<Box<T>["value"]> extends true ? Box<T>["value"] extends AnyFunction ? Box<T>["value"] extends (...args: infer A) => infer R ? <N extends A>(...args: N) => R : () => ReturnType<T> : () => T : () => T;
+    unbox: HasParameters<Box<T>["value"]> extends true ? Box<T>["value"] extends TypedFunction ? Box<T>["value"] extends (...args: infer A) => infer R ? <N extends A>(...args: N) => R : () => ReturnType<T> : () => T : () => T;
 }
 //# sourceMappingURL=Box.d.ts.map

package/dist/types/literals/Box.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Box.d.ts","sourceRoot":"","sources":["../../../src/types/literals/Box.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,WAAW,EAAC,aAAa,EAAE,iBAAwB;AAE5D,MAAM,WAAW,GAAG,CAAC,CAAC;IACpB,MAAM,EAAE,KAAK,CAAC;IACd,KAAK,EAAE,CAAC,CAAC;IACT;;;;;OAKG;IACH,KAAK,EAAE,aAAa,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,SAAS,IAAI,GAC9C,GAAG,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,SAAS,WAAW,GACjC,GAAG,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,SAAS,CAAC,GAAG,IAAI,EAAE,MAAM,CAAC,KAAK,MAAM,CAAC,GACnD,CAAC,CAAC,SAAS,CAAC,EAAE,GAAG,IAAI,EAAE,CAAC,KAAK,CAAC,GAC9B,MAAM,UAAU,CAAC,CAAC,CAAC,GACrB,MAAM,CAAC,GACT,MAAM,CAAC,CAAC;CACb"}
+{"version":3,"file":"Box.d.ts","sourceRoot":"","sources":["../../../src/types/literals/Box.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,aAAa,EAAE,aAAa,EAAE,iBAAwB;AAE/D,MAAM,WAAW,GAAG,CAAC,CAAC;IACpB,MAAM,EAAE,KAAK,CAAC;IACd,KAAK,EAAE,CAAC,CAAC;IACT;;;;;OAKG;IACH,KAAK,EAAE,aAAa,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,SAAS,IAAI,GAC9C,GAAG,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,SAAS,aAAa,GACnC,GAAG,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,SAAS,CAAC,GAAG,IAAI,EAAE,MAAM,CAAC,KAAK,MAAM,CAAC,GACnD,CAAC,CAAC,SAAS,CAAC,EAAE,GAAG,IAAI,EAAE,CAAC,KAAK,CAAC,GAC9B,MAAM,UAAU,CAAC,CAAC,CAAC,GACrB,MAAM,CAAC,GACT,MAAM,CAAC,CAAC;CACb"}

package/dist/types/literals/Choices.d.ts

@@ -0,0 +1,102 @@
+import { Dictionary, If, IsTrue, HandleDoneFn, AfterFirst, First, ExpandRecursively, ShapeCallback, AsString, EmptyObject, Scalar, MergeObjects, As } from "../index";
+/**
+ * **createChoice**(name, [value])
+ *
+ * Creates a "choice" for a Choice API. Values may be:
+ *
+ * - any `Scalar` value
+ * - a callback of the form `s => s.literal(42)`
+ * - or if left _undefined_ the value will be set to the name
+ */
+export type CreateChoice = <TName extends string, TValue extends ChoiceValue>(name: TName, value?: TValue) => Choice;
+export type ChoiceCallback = (cb: CreateChoice) => Choice;
+export type Choice<K extends string = string, V = unknown> = {
+    name: K;
+    value: V;
+};
+export type ChoiceValue = ShapeCallback | Scalar | Dictionary | undefined;
+/**
+ * **AsChoice**
+ *
+ * Converts a name/value pairing from createChoice() into a Choice.
+ */
+export type AsChoice<TName extends string = string, TValue extends ChoiceValue = ChoiceValue> = [TValue] extends [ShapeCallback] ? {
+    name: TName;
+    value: HandleDoneFn<ReturnType<TValue>>;
+} : [TValue] extends [Scalar | Dictionary] ? {
+    name: TName;
+    value: TValue;
+} : {
+    name: TName;
+    value: TName;
+};
+type ProcessChoices<T extends string | [string, Scalar] | Choice | ChoiceCallback> = T extends string ? Choice<T, T> : T extends [string, Scalar] ? Choice<T[0], T[1]> : T extends Choice ? T : T extends ChoiceCallback ? ReturnType<ChoiceCallback> : never;
+export type ToChoices<T extends readonly (string | [string, Scalar] | Choice | ChoiceCallback)[]> = {
+    [K in keyof T]: ProcessChoices<T[K]>;
+};
+export type ChoiceApiOptions = {
+    /**
+     * A choice may only be chosen once
+     */
+    unique: boolean;
+    max: number | null;
+    /**
+     * the API style as it's presented after configuration
+     */
+    style: "fn" | "object";
+};
+export type ChoiceApi<_TChoices extends readonly Choice[], _TOptions extends ChoiceApiOptions> = EmptyObject;
+export type ChoiceApiConfig<TChoices extends readonly Choice[], TOptions extends ChoiceApiOptions> = {
+    done: () => ChoiceApi<TChoices, TOptions>;
+    allowChoicesToBeUsedOnlyOnce: () => ChoiceApiConfig<TChoices, As<MergeObjects<TOptions, {
+        unique: true;
+    }>, ChoiceApiOptions>>;
+    /**
+     * configured choices can be _reused_ multiple times
+     */
+    allowChoicesToBeUsedMultipleTimes: () => ChoiceApiConfig<TChoices, As<MergeObjects<TOptions, {
+        unique: false;
+    }>, ChoiceApiOptions>>;
+    setStyle: <TStyle extends "fn" | "object">(style: TStyle) => ChoiceApiConfig<TChoices, As<MergeObjects<TOptions, {
+        style: TStyle;
+    }>, ChoiceApiOptions>>;
+    /**
+     * set a maximum number of choices that should be allowed
+     */
+    maximumChoices: <TMax extends number>(max: TMax) => ChoiceApiConfig<TChoices, As<MergeObjects<TOptions, {
+        max: TMax;
+    }>, ChoiceApiOptions>>;
+};
+export type MultipleChoice<TChoices extends Dictionary<string> = Dictionary<string>, TForceUnique extends boolean = boolean, TState extends readonly unknown[] = [], TExclude extends string = never> = {
+    selected: TState;
+    forceUnique: TForceUnique;
+    choices: TChoices;
+    <T extends string & Exclude<keyof TChoices, TExclude>>(s: T): MultipleChoice<TChoices, TForceUnique, [
+        ...TState,
+        T extends keyof TChoices ? TChoices[T] : never
+    ], AsString<If<IsTrue<TForceUnique>, TExclude | T, TExclude>>>;
+    /** return the selected choices */
+    done: () => TState;
+};
+/**
+ * **MultiChoiceCallback**`<TApi>`
+ *
+ * Provides the typing so that you can easily incorporate a "choice"
+ * as a parameter to your functions.
+ *
+ * It is intended to be used with the runtime utility `handleDoneFn()`
+ * so that if a user doesn't terminate their callback with a call to
+ * `.done()` then this is done for them.
+ */
+export type MultiChoiceCallback<TApi extends MultipleChoice> = <CB extends ((c: TApi) => unknown)>(cb: CB) => HandleDoneFn<ReturnType<CB>>;
+type MergeKVs<TInput extends readonly Dictionary[], TOutput extends Dictionary = EmptyObject> = [] extends TInput ? ExpandRecursively<TOutput> : MergeKVs<AfterFirst<TInput>, First<TInput> extends keyof TOutput ? TOutput : TOutput & First<TInput>>;
+/**
+ * **ChoiceBuilder**
+ *
+ * Builds a Choice API surface:
+ */
+export type ChoiceBuilder = <TChoices extends readonly Choice[]>(...choices: TChoices) => ({
+    chooseMany: <TForce extends boolean>(force: TForce) => MultipleChoice<MergeKVs<TChoices> extends Dictionary<string> ? MergeKVs<TChoices> : never, TForce>;
+});
+export {};
+//# sourceMappingURL=Choices.d.ts.map

package/dist/types/literals/Choices.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Choices.d.ts","sourceRoot":"","sources":["../../../src/types/literals/Choices.ts"],"names":[],"mappings":"AACA,OAAO,EACL,UAAU,EACV,EAAE,EACF,MAAM,EACN,YAAY,EACZ,UAAU,EACV,KAAK,EACL,iBAAiB,EACjB,aAAa,EACb,QAAQ,EACR,WAAW,EACX,MAAM,EACN,YAAY,EACZ,EAAE,EACH,iBAAwB;AAGzB;;;;;;;;GAQG;AACH,MAAM,MAAM,YAAY,GAAG,CACzB,KAAK,SAAS,MAAM,EACpB,MAAM,SAAS,WAAW,EAC1B,IAAI,EAAE,KAAK,EAAE,KAAK,CAAC,EAAE,MAAM,KAAK,MAAM,CAAC;AAEzC,MAAM,MAAM,cAAc,GAAG,CAAC,EAAE,EAAE,YAAY,KAAK,MAAM,CAAC;AAG1D,MAAM,MAAM,MAAM,CAChB,CAAC,SAAS,MAAM,GAAG,MAAM,EACzB,CAAC,GAAG,OAAO,IACT;IAAE,IAAI,EAAE,CAAC,CAAC;IAAC,KAAK,EAAE,CAAC,CAAA;CAAE,CAAC;AAE1B,MAAM,MAAM,WAAW,GAAG,aAAa,GAAG,MAAM,GAAG,UAAU,GAAG,SAAS,CAAC;AAE1E;;;;GAIG;AACH,MAAM,MAAM,QAAQ,CAClB,KAAK,SAAS,MAAM,GAAG,MAAM,EAC7B,MAAM,SAAS,WAAW,GAAG,WAAW,IACtC,CAAC,MAAM,CAAC,SAAS,CAAC,aAAa,CAAC,GAClC;IAAC,IAAI,EAAE,KAAK,CAAC;IAAC,KAAK,EAAE,YAAY,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,CAAA;CAAC,GACtD,CAAC,MAAM,CAAC,SAAS,CAAC,MAAM,GAAG,UAAU,CAAC,GACpC;IAAC,IAAI,EAAE,KAAK,CAAC;IAAC,KAAK,EAAE,MAAM,CAAA;CAAE,GAC7B;IAAC,IAAI,EAAE,KAAK,CAAC;IAAC,KAAK,EAAE,KAAK,CAAA;CAAC,CAAC;AAEhC,KAAK,cAAc,CACjB,CAAC,SAAS,MAAM,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,MAAM,GAAG,cAAc,IAC3D,CAAC,SAAS,MAAM,GAClB,MAAM,CAAC,CAAC,EAAC,CAAC,CAAC,GACX,CAAC,SAAS,CAAC,MAAM,EAAE,MAAM,CAAC,GAC1B,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,EAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GACjB,CAAC,SAAS,MAAM,GAChB,CAAC,GACD,CAAC,SAAS,cAAc,GACxB,UAAU,CAAC,cAAc,CAAC,GAC1B,KAAK,CAAC;AAER,MAAM,MAAM,SAAS,CACnB,CAAC,SAAS,SAAS,CAAC,MAAM,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,MAAM,GAAG,cAAc,CAAC,EAAE,IACxE;KACD,CAAC,IAAI,MAAM,CAAC,GAAG,cAAc,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;CACrC,CAAA;AAED,MAAM,MAAM,gBAAgB,GAAG;IAC7B;;OAEG;IACH,MAAM,EAAE,OAAO,CAAC;IAChB,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;IACnB;;OAEG;IACH,KAAK,EAAE,IAAI,GAAG,QAAQ,CAAC;CACxB,CAAA;AAED,MAAM,MAAM,SAAS,CACnB,SAAS,SAAS,SAAS,MAAM,EAAE,EACnC,SAAS,SAAS,gBAAgB,IAChC,WAAW,CAAC;AAGhB,MAAM,MAAM,eAAe,CACzB,QAAQ,SAAS,SAAS,MAAM,EAAE,EAClC,QAAQ,SAAS,gBAAgB,IAC/B;IACF,IAAI,EAAE,MAAM,SAAS,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;IAC1C,4BAA4B,EAAE,MAAM,eAAe,CACjD,QAAQ,EACR,EAAE,CAAC,YAAY,CAAC,QAAQ,EAAE;QAAC,MAAM,EAAE,IAAI,CAAA;KAAC,CAAC,EAAE,gBAAgB,CAAC,CAC7D,CAAC;IACF;;OAEG;IACH,iCAAiC,EAAE,MAAM,eAAe,CACtD,QAAQ,EACR,EAAE,CAAC,YAAY,CAAC,QAAQ,EAAE;QAAC,MAAM,EAAE,KAAK,CAAA;KAAC,CAAC,EAAE,gBAAgB,CAAC,CAC9D,CAAC;IACF,QAAQ,EAAE,CAAC,MAAM,SAAS,IAAI,GAAG,QAAQ,EAAE,KAAK,EAAE,MAAM,KAAK,eAAe,CAC1E,QAAQ,EACR,EAAE,CAAC,YAAY,CAAC,QAAQ,EAAE;QAAC,KAAK,EAAE,MAAM,CAAA;KAAC,CAAC,EAAE,gBAAgB,CAAC,CAC9D,CAAC;IACF;;OAEG;IACH,cAAc,EAAE,CAAC,IAAI,SAAS,MAAM,EAAE,GAAG,EAAE,IAAI,KAAK,eAAe,CACjE,QAAQ,EACR,EAAE,CAAC,YAAY,CAAC,QAAQ,EAAE;QAAC,GAAG,EAAE,IAAI,CAAA;KAAC,CAAC,EAAE,gBAAgB,CAAC,CAC1D,CAAC;CACH,CAAA;AAyDD,MAAM,MAAM,cAAc,CACxB,QAAQ,SAAS,UAAU,CAAC,MAAM,CAAC,GAAG,UAAU,CAAC,MAAM,CAAC,EACxD,YAAY,SAAS,OAAO,GAAG,OAAO,EACtC,MAAM,SAAS,SAAS,OAAO,EAAE,GAAG,EAAE,EACtC,QAAQ,SAAS,MAAM,GAAG,KAAK,IAC7B;IACF,QAAQ,EAAE,MAAM,CAAC;IACjB,WAAW,EAAE,YAAY,CAAC;IAC1B,OAAO,EAAE,QAAQ,CAAC;IAClB,CAAC,CAAC,SAAS,MAAM,GAAG,OAAO,CAAC,MAAM,QAAQ,EAAE,QAAQ,CAAC,EAAE,CAAC,EAAE,CAAC,GACzD,cAAc,CACZ,QAAQ,EACR,YAAY,EACZ;QACE,GAAG,MAAM;QACT,CAAC,SAAS,MAAM,QAAQ,GACpB,QAAQ,CAAC,CAAC,CAAC,GACX,KAAK;KACV,EACD,QAAQ,CAAC,EAAE,CACT,MAAM,CAAC,YAAY,CAAC,EACpB,QAAQ,GAAG,CAAC,EACZ,QAAQ,CACT,CAAC,CACH,CAAC;IACJ,kCAAkC;IAClC,IAAI,EAAE,MAAM,MAAM,CAAC;CACpB,CAAC;AAEF;;;;;;;;;GASG;AACH,MAAM,MAAM,mBAAmB,CAAC,IAAI,SAAS,cAAc,IAAI,CAC7D,EAAE,SAAS,CAAC,CAAC,CAAC,EAAE,IAAI,KAAK,OAAO,CAAC,EACjC,EAAE,EAAE,EAAE,KAAM,YAAY,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC,CAAC;AAG3C,KAAK,QAAQ,CACX,MAAM,SAAS,SAAS,UAAU,EAAE,EACpC,OAAO,SAAS,UAAU,GAAG,WAAW,IACtC,EAAE,SAAS,MAAM,GACjB,iBAAiB,CAAC,OAAO,CAAC,GAC5B,QAAQ,CACN,UAAU,CAAC,MAAM,CAAC,EAClB,KAAK,CAAC,MAAM,CAAC,SAAS,MAAM,OAAO,GACjC,OAAO,GACP,OAAO,GAAG,KAAK,CAAC,MAAM,CAAC,CAC1B,CAAC;AAEJ;;;;GAIG;AACH,MAAM,MAAM,aAAa,GAAE,CACzB,QAAQ,SAAS,SAAS,MAAM,EAAE,EAClC,GAAG,OAAO,EAAE,QAAQ,KAAK,CAAC;IAC1B,UAAU,EAAE,CACV,MAAM,SAAS,OAAO,EACtB,KAAK,EAAE,MAAM,KACf,cAAc,CACX,QAAQ,CAAC,QAAQ,CAAC,SAAS,UAAU,CAAC,MAAM,CAAC,GAC3C,QAAQ,CAAC,QAAQ,CAAC,GAClB,KAAK,EACR,MAAM,CACP,CAAC;CACH,CAAC,CAAC"}

package/dist/types/literals/DoneFnTuple.d.ts

@@ -0,0 +1,28 @@
+import { IsTrue, If, Fn, FnDefn, TupleToUnion, Narrow } from "../index";
+/**
+ * **DoneFnTuple**`<[TTuple],[TMakeUnion],[TFns]>`
+ *
+ * This type utility quickly builds the types you'll need for an
+ * API surface with the `done()` command returning the stored state
+ * as either a **Tuple** or a **Union** of the tuple state.
+ *
+ * **Related:** `HasDoneFn`, `Narrow`, `DoneFnKv`, `createDoneTupleFn`
+ */
+export type DoneFnTuple<TFns extends {
+    [key: string]: FnDefn;
+} = {
+    add: [
+        <TAdd extends Narrow>(a: TAdd) => boolean,
+        "add a value to the tuple/union"
+    ];
+}, TMakeUnion extends boolean = false, TState extends readonly Narrow[] = Narrow[]> = {
+    [K in keyof TFns]: Fn<TFns[K]>;
+} & {
+    state: TState;
+    type_as_union: TMakeUnion;
+    done: Fn<[
+        () => If<IsTrue<TMakeUnion>, TupleToUnion<TState>, TState>,
+        "exits the API surface with the state which has been accumulated so far"
+    ]>;
+};
+//# sourceMappingURL=DoneFnTuple.d.ts.map

package/dist/types/literals/DoneFnTuple.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"DoneFnTuple.d.ts","sourceRoot":"","sources":["../../../src/types/literals/DoneFnTuple.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,EAAE,EAAE,EAAE,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,EAAC,iBAAwB;AAG9E;;;;;;;;GAQG;AACH,MAAM,MAAM,WAAW,CACvB,IAAI,SAAS;IAAC,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;CAAC,GAAG;IACrC,GAAG,EAAE;QACH,CAAC,IAAI,SAAS,MAAM,EAAE,CAAC,EAAE,IAAI,KAAK,OAAO;QACzC,gCAAgC;KACjC,CAAC;CACH,EACD,UAAU,SAAS,OAAO,GAAG,KAAK,EAClC,MAAM,SAAS,SAAS,MAAM,EAAE,GAAG,MAAM,EAAE,IACvC;KACD,CAAC,IAAI,MAAM,IAAI,GAAG,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;CAC/B,GAAG;IACF,KAAK,EAAE,MAAM,CAAC;IACd,aAAa,EAAE,UAAU,CAAC;IAC1B,IAAI,EAAE,EAAE,CAAC;QACP,MAAM,EAAE,CAAC,MAAM,CAAC,UAAU,CAAC,EAAE,YAAY,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;QAC1D,wEAAwE;KACzE,CAAC,CAAC;CACJ,CAAA"}

package/dist/types/literals/ExpandRecursively.d.ts

@@ -1,14 +1,21 @@
-import { AfterFirst, Decrement, First, Tuple } from "../index";
-type ExpandTuple<TLength extends number, TContent extends Tuple, TTuple extends Tuple = []> = TLength extends 0 ? Readonly<TTuple> : ExpandTuple<Decrement<TLength>, AfterFirst<TContent>, [
-    ...TTuple,
-    First<TContent>
+import { AfterFirst, AnyFunction, AsLiteralFn, AsNarrowingFn, Dictionary, First, FnProps, IsNarrowingFn, TypedFunction } from "../index";
+type ExpandParameters<TFn extends TypedFunction, TParams extends readonly unknown[], TResults extends readonly unknown[] = []> = [] extends TParams ? IsNarrowingFn<TFn> extends true ? AsNarrowingFn<TResults, ReturnType<TFn>, ExpandDictionary<FnProps<TFn>>> : AsLiteralFn<TResults, ReturnType<TFn>, ExpandDictionary<FnProps<TFn>>> : ExpandParameters<TFn, AfterFirst<TParams>, [
+    ...TResults,
+    First<TParams> extends Dictionary ? ExpandDictionary<First<TParams>> : First<TParams>
 ]>;
 /**
  * Recursively goes over an object based structure and tries to reduce
  * it down to just a simple key/value type.
  */
-export type ExpandRecursively<T> = T extends Tuple ? T["length"] extends number ? ExpandTuple<T["length"], T> : T : T extends object ? {
-    [K in keyof T]: ExpandRecursively<T[K]>;
+export type ExpandRecursively<T> = T extends Dictionary ? {
+    [K in keyof T]: T[K] extends AnyFunction ? T[K] extends TypedFunction ? ExpandParameters<T[K], Parameters<T[K]>> : T[K] : ExpandRecursively<T[K]>;
+} : T;
+/**
+ * Recursively goes over an object based structure and tries to reduce
+ * it down to just a simple key/value type.
+ */
+export type ExpandDictionary<T> = T extends Dictionary ? {
+    [K in keyof T]: T[K] extends AnyFunction ? T[K] : ExpandRecursively<T[K]>;
 } : T;
 export {};
 //# sourceMappingURL=ExpandRecursively.d.ts.map

package/dist/types/literals/ExpandRecursively.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ExpandRecursively.d.ts","sourceRoot":"","sources":["../../../src/types/literals/ExpandRecursively.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,SAAS,EAAE,KAAK,EAAE,KAAK,EAAE,iBAAwB;AAEtE,KAAK,WAAW,CACd,OAAO,SAAS,MAAM,EACtB,QAAQ,SAAS,KAAK,EACtB,MAAM,SAAS,KAAK,GAAG,EAAE,IACvB,OAAO,SAAS,CAAC,GACjB,QAAQ,CAAC,MAAM,CAAC,GAChB,WAAW,CACT,SAAS,CAAC,OAAO,CAAC,EAClB,UAAU,CAAC,QAAQ,CAAC,EACpB;IAAC,GAAG,MAAM;IAAE,KAAK,CAAC,QAAQ,CAAC;CAAC,CAC/B,CAAC;AAEJ;;;GAGG;AACH,MAAM,MAAM,iBAAiB,CAAC,CAAC,IAAI,CAAC,SAAS,KAAK,GAC9C,CAAC,CAAC,QAAQ,CAAC,SAAS,MAAM,GACxB,WAAW,CAAC,CAAC,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,GAC3B,CAAC,GACH,CAAC,SAAS,MAAM,GAChB;KAAG,CAAC,IAAI,MAAM,CAAC,GAAG,iBAAiB,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;CAAE,GAC3C,CAAC,CAAC"}
+{"version":3,"file":"ExpandRecursively.d.ts","sourceRoot":"","sources":["../../../src/types/literals/ExpandRecursively.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,UAAU,EAAE,WAAW,EAAE,WAAW,EAAE,aAAa,EAAa,UAAU,EAAE,KAAK,EAAE,OAAO,EAAE,aAAa,EAAS,aAAa,EAAE,iBAAwB;AAclK,KAAK,gBAAgB,CACnB,GAAG,SAAS,aAAa,EACzB,OAAO,SAAS,SAAS,OAAO,EAAE,EAClC,QAAQ,SAAS,SAAS,OAAO,EAAE,GAAG,EAAE,IACtC,EAAE,SAAS,OAAO,GACpB,aAAa,CAAC,GAAG,CAAC,SAAS,IAAI,GAC7B,aAAa,CAAC,QAAQ,EAAC,UAAU,CAAC,GAAG,CAAC,EAAC,gBAAgB,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,GACtE,WAAW,CAAC,QAAQ,EAAC,UAAU,CAAC,GAAG,CAAC,EAAC,gBAAgB,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,GACtE,gBAAgB,CACd,GAAG,EACH,UAAU,CAAC,OAAO,CAAC,EACnB;IACE,GAAG,QAAQ;IACX,KAAK,CAAC,OAAO,CAAC,SAAS,UAAU,GAC7B,gBAAgB,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,GAChC,KAAK,CAAC,OAAO,CAAC;CACnB,CACF,CAAA;AAEH;;;GAGG;AACH,MAAM,MAAM,iBAAiB,CAAC,CAAC,IAAI,CAAC,SAAS,UAAU,GACnD;KAAG,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,WAAW,GACtC,CAAC,CAAC,CAAC,CAAC,SAAS,aAAa,GACxB,gBAAgB,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GACxC,CAAC,CAAC,CAAC,CAAC,GACN,iBAAiB,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;CAC1B,GACD,CAAC,CAAC;AAEN;;;GAGG;AACH,MAAM,MAAM,gBAAgB,CAAC,CAAC,IAAI,CAAC,SAAS,UAAU,GAClD;KAAG,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,WAAW,GACtC,CAAC,CAAC,CAAC,CAAC,GACJ,iBAAiB,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;CAC1B,GACD,CAAC,CAAC"}

package/dist/types/literals/FromDefn.d.ts

@@ -0,0 +1,55 @@
+import { Constant } from "../../constants/index";
+import { EmptyObject, Dictionary, ObjectKey, Tuple, IsEqual, Contains, Keys, Values, HandleDoneFn, AfterFirst, First, AsDictionary, TupleToUnion, ExpandDictionary, NarrowableScalar, ShapeCallback, UnionElDefn } from "../index";
+type HandleObject<TObj extends Dictionary, TKeys extends readonly unknown[], TResult extends Dictionary = EmptyObject> = [] extends TKeys ? ExpandDictionary<TResult> : HandleObject<TObj, AfterFirst<TKeys>, First<TKeys> extends keyof TObj ? TObj[First<TKeys>] extends ShapeCallback ? Record<First<TKeys>, HandleDoneFn<ReturnType<TObj[First<TKeys>]>>> & TResult : Record<First<TKeys>, TObj[First<TKeys>]> & TResult : never>;
+type ProcessUnion<T extends UnionElDefn> = T extends Tuple ? TupleToUnion<T> : T extends ShapeCallback ? HandleDoneFn<ReturnType<T>> : never;
+type IterateUnion<T extends readonly UnionElDefn[]> = {
+    [K in keyof T]: ProcessUnion<T[K]>;
+};
+/**
+ * **AsUnion**
+ *
+ * Receives a `UnionTokenSet`, a `ShapeCallback` or just a tuple of values
+ * and makes this into _union type_.
+ */
+export type AsUnion<T extends UnionElDefn | readonly [UnionElDefn, ...UnionElDefn[]]> = T extends UnionElDefn[] ? TupleToUnion<IterateUnion<T>> : T extends UnionElDefn ? ProcessUnion<T> : never;
+export type IsDictionaryDefinition<T> = T extends Dictionary ? Contains<Values<T>, ShapeCallback> : false;
+/**
+ * converts non-tuple definition types to actual type
+ */
+type ToType<T, TElse> = [
+    T
+] extends [ShapeCallback] ? HandleDoneFn<ReturnType<T>> : [IsDictionaryDefinition<T>] extends [true] ? HandleObject<AsDictionary<T>, Keys<AsDictionary<T>>> : IsEqual<TElse, Constant<"not-set">> extends true ? T : TElse;
+/**
+ * iterates over tuple definition types to convert into real types
+ */
+type IterateOverDefinitions<T extends readonly unknown[], TElse> = {
+    [K in keyof T]: ToType<T[K], TElse>;
+};
+export type TypeDefinition = NarrowableScalar | ShapeCallback;
+/**
+ * **DictShapeDefn**`<T>`
+ *
+ * A _dictionary_ shape which provides direct value input or use of
+ * the `ShapeCallback` API to any of the dictionaries values.
+ *
+ * Use of the generic `T` is not required but adding it as a separate
+ * generic will increase the narrowness of your types.
+ */
+export type DictTypeDefinition<V extends TypeDefinition = TypeDefinition> = Record<ObjectKey, V>;
+/**
+ * **FromDefn**`<T, [TElse]>`
+ *
+ * Takes either a singular `T` or a tuple of values for `T` and
+ * looks for any cases where a `ShapeCallback` is found:
+ *
+ * - where it is found, it will resolve the type
+ * - where it is not it will simply proxy the values through
+ * - if `TElse` is set you can redirect values which don't use
+ * the ShapeCallback API to a specific type.
+ *
+ * Note: when dictionary objects are found the _values_ will be
+ * interrogated for ShapeCallback's.
+ */
+export type FromDefn<T, TElse = Constant<"not-set">> = T extends readonly unknown[] ? IterateOverDefinitions<T, TElse> : ToType<T, TElse>;
+export {};
+//# sourceMappingURL=FromDefn.d.ts.map

package/dist/types/literals/FromDefn.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"FromDefn.d.ts","sourceRoot":"","sources":["../../../src/types/literals/FromDefn.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,8BAA4B;AAC/C,OAAO,EAAE,WAAW,EAClB,UAAU,EACV,SAAS,EACT,KAAK,EACL,OAAO,EACP,QAAQ,EACR,IAAI,EACJ,MAAM,EACN,YAAY,EACZ,UAAU,EACV,KAAK,EACL,YAAY,EACZ,YAAY,EACZ,gBAAgB,EAChB,gBAAgB,EAChB,aAAa,EACb,WAAW,EACX,iBAAwB;AAE1B,KAAK,YAAY,CACf,IAAI,SAAS,UAAU,EACvB,KAAK,SAAS,SAAS,OAAO,EAAE,EAChC,OAAO,SAAS,UAAU,GAAG,WAAW,IACtC,EAAE,SAAS,KAAK,GAClB,gBAAgB,CAAC,OAAO,CAAC,GACzB,YAAY,CACV,IAAI,EACJ,UAAU,CAAC,KAAK,CAAC,EACjB,KAAK,CAAC,KAAK,CAAC,SAAS,MAAM,IAAI,GAC3B,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,SAAS,aAAa,GACtC,MAAM,CACJ,KAAK,CAAC,KAAK,CAAC,EACZ,YAAY,CAAC,UAAU,CAAE,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAE,CAAC,CAC/C,GAAG,OAAO,GACX,MAAM,CACJ,KAAK,CAAC,KAAK,CAAC,EACZ,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CACnB,GAAG,OAAO,GACb,KAAK,CACV,CAAC;AAGJ,KAAK,YAAY,CACf,CAAC,SAAS,WAAW,IACnB,CAAC,SAAS,KAAK,GACb,YAAY,CAAC,CAAC,CAAC,GACf,CAAC,SAAS,aAAa,GACrB,YAAY,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,GACzB,KAAK,CAAC;AAChB,KAAK,YAAY,CAAC,CAAC,SAAS,SAAS,WAAW,EAAE,IAAI;KACnD,CAAC,IAAI,MAAM,CAAC,GAAG,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;CACnC,CAAA;AAED;;;;;GAKG;AACH,MAAM,MAAM,OAAO,CAAC,CAAC,SAAS,WAAW,GAAG,SAAS,CAAC,WAAW,EAAE,GAAG,WAAW,EAAE,CAAC,IAAI,CAAC,SAAS,WAAW,EAAE,GAC7G,YAAY,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,GAC7B,CAAC,SAAS,WAAW,GACrB,YAAY,CAAC,CAAC,CAAC,GACf,KAAK,CAAC;AAER,MAAM,MAAM,sBAAsB,CAAC,CAAC,IAAI,CAAC,SAAS,UAAU,GAC1D,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,aAAa,CAAC,GAClC,KAAK,CAAC;AAER;;GAEG;AACH,KAAK,MAAM,CACT,CAAC,EACD,KAAK,IAEP;IAAC,CAAC;CAAC,SAAS,CAAC,aAAa,CAAC,GACvB,YAAY,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,GAC7B,CAAC,sBAAsB,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,IAAI,CAAC,GACxC,YAAY,CAAC,YAAY,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC,GACtD,OAAO,CAAC,KAAK,EAAE,QAAQ,CAAC,SAAS,CAAC,CAAC,SAAS,IAAI,GAC9C,CAAC,GACD,KAAK,CAAC;AAEV;;GAEG;AACH,KAAK,sBAAsB,CACzB,CAAC,SAAS,SAAS,OAAO,EAAE,EAC5B,KAAK,IACH;KACD,CAAC,IAAI,MAAM,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC;CACpC,CAAA;AAED,MAAM,MAAM,cAAc,GAAG,gBAAgB,GAAG,aAAa,CAAC;AAG9D;;;;;;;;GAQG;AACH,MAAM,MAAM,kBAAkB,CAC5B,CAAC,SAAS,cAAc,GAAG,cAAc,IACvC,MAAM,CACR,SAAS,EACT,CAAC,CACF,CAAC;AAGF;;;;;;;;;;;;;GAaG;AACH,MAAM,MAAM,QAAQ,CAClB,CAAC,EACD,KAAK,GAAG,QAAQ,CAAC,SAAS,CAAC,IACzB,CAAC,SAAS,SAAS,OAAO,EAAE,GAC9B,sBAAsB,CAAC,CAAC,EAAC,KAAK,CAAC,GAC/B,MAAM,CAAC,CAAC,EAAC,KAAK,CAAC,CAAC"}

package/dist/types/literals/FromTokenNames.d.ts

@@ -0,0 +1,19 @@
+import { ObjectKey } from "../base-types/ObjectKey";
+import { IsNever } from "../boolean-logic/operators/IsNever";
+export type WideTokenNames = "string" | "number" | "boolean" | "null" | "undefined" | "never" | "unknown" | "string[]" | "number[]" | "boolean[]" | "unknown[]";
+export type ConvertWideTokenNames<T extends WideTokenNames> = T extends "string" ? string : T extends "number" ? number : T extends "boolean" ? boolean : T extends "null" ? null : T extends "undefined" ? undefined : T extends "never" ? never : T extends "unknown" ? unknown : T extends "string[]" ? string[] : T extends "number[]" ? number[] : T extends "boolean[]" ? boolean[] : T extends "unknown[]" ? unknown[] : never;
+export type WideContainerNames = "object" | "Dictionary" | "Map" | "Set" | "WeakMap";
+type ConvertWideContainerNames<T extends WideContainerNames> = T extends "object" ? object : T extends "Dictionary" ? Record<ObjectKey, unknown> : T extends "Map" ? Map<unknown, unknown> : T extends "Set" ? Set<unknown> : T extends "WeakMap" ? WeakMap<object, unknown> : never;
+/**
+ * **FromWideTokens**`<T, [TElse]>`
+ *
+ * Looks for `WideContainerNames` or `WideTokenNames` and converts them to
+ * the type they describe. If it is `T` is not any of these tokens it is
+ * simply proxied through.
+ *
+ * If you'd prefer to setup a different type for when no token is matched
+ * you can add it under `TElse`.
+ */
+export type FromWideTokens<T, TElse = never> = T extends WideTokenNames | WideContainerNames ? T extends WideTokenNames ? ConvertWideTokenNames<T> : T extends WideContainerNames ? ConvertWideContainerNames<T> : never : IsNever<TElse> extends true ? T : TElse;
+export {};
+//# sourceMappingURL=FromTokenNames.d.ts.map

package/dist/types/literals/FromTokenNames.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"FromTokenNames.d.ts","sourceRoot":"","sources":["../../../src/types/literals/FromTokenNames.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAC;AACpD,OAAO,EAAE,OAAO,EAAE,MAAM,oCAAoC,CAAC;AAE7D,MAAM,MAAM,cAAc,GAAG,QAAQ,GACnC,QAAQ,GACR,SAAS,GACT,MAAM,GACN,WAAW,GACX,OAAO,GACP,SAAS,GACT,UAAU,GACV,UAAU,GACV,WAAW,GACX,WAAW,CAAC;AAGd,MAAM,MAAM,qBAAqB,CAAC,CAAC,SAAS,cAAc,IAAI,CAAC,SAAS,QAAQ,GAC9E,MAAM,GACN,CAAC,SAAS,QAAQ,GAClB,MAAM,GACN,CAAC,SAAS,SAAS,GACnB,OAAO,GACP,CAAC,SAAS,MAAM,GAChB,IAAI,GACJ,CAAC,SAAS,WAAW,GACrB,SAAS,GACT,CAAC,SAAS,OAAO,GACjB,KAAK,GACL,CAAC,SAAS,SAAS,GACnB,OAAO,GACP,CAAC,SAAS,UAAU,GACpB,MAAM,EAAE,GACR,CAAC,SAAS,UAAU,GACpB,MAAM,EAAE,GACR,CAAC,SAAS,WAAW,GACrB,OAAO,EAAE,GACT,CAAC,SAAS,WAAW,GACrB,OAAO,EAAE,GACT,KAAK,CAAC;AAGR,MAAM,MAAM,kBAAkB,GAAG,QAAQ,GACvC,YAAY,GACZ,KAAK,GACL,KAAK,GACL,SAAS,CAAC;AAEZ,KAAK,yBAAyB,CAAC,CAAC,SAAS,kBAAkB,IAAI,CAAC,SAAS,QAAQ,GAC/E,MAAM,GACN,CAAC,SAAS,YAAY,GACtB,MAAM,CAAC,SAAS,EAAC,OAAO,CAAC,GACzB,CAAC,SAAS,KAAK,GACf,GAAG,CAAC,OAAO,EAAC,OAAO,CAAC,GACpB,CAAC,SAAS,KAAK,GACf,GAAG,CAAC,OAAO,CAAC,GACZ,CAAC,SAAS,SAAS,GACnB,OAAO,CAAC,MAAM,EAAE,OAAO,CAAC,GACxB,KAAK,CAAC;AAER;;;;;;;;;GASG;AACH,MAAM,MAAM,cAAc,CACxB,CAAC,EACD,KAAK,GAAG,KAAK,IACX,CAAC,SAAS,cAAc,GAAG,kBAAkB,GAC/C,CAAC,SAAS,cAAc,GACtB,qBAAqB,CAAC,CAAC,CAAC,GACxB,CAAC,SAAS,kBAAkB,GAC5B,yBAAyB,CAAC,CAAC,CAAC,GAC5B,KAAK,GACP,OAAO,CAAC,KAAK,CAAC,SAAS,IAAI,GACzB,CAAC,GACD,KAAK,CAAA"}

package/dist/types/literals/Narrow.d.ts

@@ -0,0 +1,10 @@
+import { Narrowable } from "./Narrowable";
+/**
+ * **Narrow**
+ *
+ * Just like the `Narrowable` type, this type is used in the _extends_
+ * clause during runtime to extract the narrowest types possible. Unlike
+ * the `Narrowable` type, **Narrow** _excludes_ **symbols**.
+ */
+export type Narrow = Exclude<Narrowable, symbol>;
+//# sourceMappingURL=Narrow.d.ts.map

package/dist/types/literals/Narrow.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Narrow.d.ts","sourceRoot":"","sources":["../../../src/types/literals/Narrow.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE1C;;;;;;GAMG;AACH,MAAM,MAAM,MAAM,GAAG,OAAO,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC"}

package/dist/types/literals/RuntimeUnion.d.ts

@@ -0,0 +1,14 @@
+import { TupleToUnion } from "../type-conversion";
+/**
+ * **RuntimeUnion**`<T>`
+ *
+ * Represents a _union type_ at runtime where the `ReturnType` is the
+ * union type of the member in the `members` array.
+ */
+export type RuntimeUnion<T extends readonly unknown[]> = {
+    kind: "Union";
+    members: T;
+    type: TupleToUnion<T>;
+    includes: (v: unknown) => boolean;
+};
+//# sourceMappingURL=RuntimeUnion.d.ts.map

package/dist/types/literals/RuntimeUnion.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"RuntimeUnion.d.ts","sourceRoot":"","sources":["../../../src/types/literals/RuntimeUnion.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAElD;;;;;GAKG;AACH,MAAM,MAAM,YAAY,CACtB,CAAC,SAAS,SAAS,OAAO,EAAE,IAC1B;IACF,IAAI,EAAE,OAAO,CAAC;IACd,OAAO,EAAE,CAAC,CAAC;IACX,IAAI,EAAE,YAAY,CAAC,CAAC,CAAC,CAAC;IACtB,QAAQ,EAAE,CAAC,CAAC,EAAE,OAAO,KAAK,OAAO,CAAC;CACnC,CAAA"}

package/dist/types/literals/Shape.d.ts

@@ -0,0 +1,222 @@
+import { If, Narrowable, ObjectKey, IsNever, IsTrue, TupleToUnion, IsFalse, Tuple, HandleDoneFn, AsLiteralFn, AsArray, ZipCode, MilitaryTime, TimeResolution, CivilianTime, Ip4Address, Ip6Address, Zip, ZipPlus4, As, Container, TypeTokenKind } from "../index";
+import { AsUnion, FromDefn } from "./FromDefn";
+import { FromWideTokens, WideContainerNames, WideTokenNames } from "./FromTokenNames";
+type Narrow = Exclude<Narrowable, symbol>;
+/**
+ * **Shape**
+ *
+ * This is a union type that captures all signatures of **shapes** which
+ * are produced as the runtime representation of a type by utilities
+ * like the `ShapeApi` and the `shape()` runtime function.
+ */
+export type Shape = `<<${TypeTokenKind}${string}>>`;
+/**
+ * **ShapeAddOrDone**`<TTuple, TMakeUnion>`
+ *
+ * The structure of endpoints on the `ShapeApi` which return
+ * a tuple or union.
+ */
+export type ShapeTupleOrUnion<TTuple extends readonly Narrow[] = Narrow[], TMakeUnion extends boolean = boolean> = {
+    add: <TAdd extends Narrow>(a: TAdd) => ShapeTupleOrUnion<[...TTuple, TAdd], TMakeUnion>;
+    done: () => If<IsTrue<TMakeUnion>, TupleToUnion<TTuple>, TTuple>;
+};
+export type WideTypeName = "string" | "number" | "boolean" | "null" | "undefined" | "unknown" | "object";
+export type StringTokenUtilities<T> = {
+    /**
+     * **numericString**
+     *
+     * A string type which holds numeric content (e.g., \`${number}\`)
+     */
+    numericString: () => `${number}`;
+    /**
+     * traditional 5 digit zip code (e.g., 90210)
+     */
+    zip: () => Zip;
+    /**
+     * A 5 digit code, a dash, and then a 4 digit code used for greater
+     * geographic specificity. You can use the [melissa](https://lookups.melissa.com/home/zip4/zip4/)
+     * API to see what 4 digit codes are available for a known base zip code.
+     */
+    zipPlus4: () => ZipPlus4;
+    /**
+     * **zipCode**
+     *
+     * A union type including both `zip` and `zipPlus4` patterns.
+     */
+    zipCode: () => ZipCode;
+    /**
+     * **militaryTime**
+     *
+     * Time based on a 24-hour military clock. You may optionally choose your time
+     * resolution but the default is `HH:MM`; options are:
+     *
+     * - `HH:MM` - 12:49, 22:15, etc.
+     * - `HH:MM:SS`
+     * - `HH:MM:SS.ms`
+     */
+    militaryTime: <T extends TimeResolution = "HH:MM">(resolution?: T) => MilitaryTime<T>;
+    /**
+     * **civilianTime**
+     *
+     * Time based on a 12-hour civilian clock. You may optionally choose your time
+     * resolution but the default is `HH:MM`; options are:
+     *
+     * - `HH:MM` - 9:45am, 3:45pm, etc.
+     * - `HH:MM:SS`
+     * - `HH:MM:SS.ms`
+     */
+    civilianTime: <T extends TimeResolution = "HH:MM">(resolution?: T) => CivilianTime<T>;
+    /**
+     * **ipv4Address**
+     *
+     * A simple representation of a IPv4 address.
+     */
+    ipv4Address: () => Ip4Address;
+    /**
+     * **ipv6Address**
+     *
+     * A simple representation of a fully qualified Ip6Address.
+     */
+    ipv6Address: () => Ip6Address;
+    done: () => T;
+};
+export type ShapeApi__Scalars<TUnion = never, TExclude extends string = ""> = Omit<{
+    /**
+     * **string**(_literals_)
+     *
+     * When called with:
+     *
+     * - **no parameters** sets the type to `string`
+     *   - you may also choose other well known string literal patterns off an extended API
+     *     when you initially call with no params
+     * - **one parameter** makes it a _string literal_
+     * - **more than one** parameter results in a _union type_ of string literals.
+     */
+    string: (<T extends readonly string[]>(...literals: T) => T["length"] extends 0 ? StringTokenUtilities<string> : T["length"] extends 1 ? T[0] : TupleToUnion<T>);
+    /**
+     * **number**(_literals_)
+     *
+     * When called with:
+     *
+     * - **no parameters** sets the type to `number`
+     * - **one parameter** makes it a _numeric literal_
+     * - **more than one** parameter results in a _union type_ of numeric literals.
+     */
+    number: <T extends readonly number[]>(...literals: T) => T["length"] extends 0 ? number : T["length"] extends 1 ? T[0] : TupleToUnion<T>;
+    /**
+     * **boolean**(_literal_)
+     *
+     * When called with _no_ parameters it results in a `boolean` type; however
+     * you may add `true` or `false` into the call signature to make it a literal.
+     */
+    boolean: <L extends boolean>(v?: L) => If<IsTrue<L>, true, If<IsFalse<L>, false, boolean>>;
+    /**
+     * **null**()
+     *
+     * Set as a `null` value.
+     */
+    null: () => If<IsNever<TUnion>, null, null | TUnion>;
+    /**
+     * **undefined**()
+     *
+     * Set as a `undefined` value.
+     */
+    undefined: () => If<IsNever<TUnion>, undefined, undefined | TUnion>;
+    /**
+     * **unknown**()
+     *
+     * Set as an `unknown` value.
+     */
+    unknown: () => If<IsNever<TUnion>, unknown, unknown | TUnion>;
+}, TExclude>;
+export type UnionElDefn = ShapeCallback | Tuple;
+type ShapeApi__Union = {
+    union: <U extends readonly [UnionElDefn, ...UnionElDefn[]]>(...elements: U) => AsUnion<U>;
+};
+export type DictionaryTypeDefn = Record<ObjectKey, ShapeCallback>;
+/**
+ * **FnArgsDefn**
+ *
+ * The definition of a function's argument
+ */
+export type FnArgsDefn = ShapeCallback | WideContainerNames;
+/**
+ * **FnReturnTypeDefn**
+ *
+ * The definition of _return type_ of a function
+ */
+export type FnReturnTypeDefn = WideTokenNames | ShapeCallback;
+/**
+ * **FnPropertiesDefn**
+ *
+ * The definition of the _optional_ properties associated with a function.
+ */
+export type FnPropertiesDefn = DictionaryTypeDefn;
+type ShapeApi__Functions = {
+    fn: <TArgs extends readonly FnArgsDefn[]>(...args: TArgs) => ({
+        returns: <TReturn extends FnReturnTypeDefn>(rtn: TReturn) => ({
+            addProperties: <TProps extends FnPropertiesDefn>(kv: TProps) => AsLiteralFn<FromWideTokens<TArgs, FromDefn<TArgs>>, FromWideTokens<TReturn, FromDefn<TReturn>>, FromDefn<TProps>>;
+            done: () => AsLiteralFn<FromDefn<TArgs>, FromDefn<TReturn>>;
+        });
+        done: () => AsLiteralFn<FromDefn<TArgs>>;
+    });
+};
+export type RecordKeyWideTokens = "string" | "symbol" | "string | symbol";
+export type RecordKeyDefn = RecordKeyWideTokens | ShapeCallback;
+export type FromRecordKeyDefn<T extends RecordKeyDefn> = T extends ShapeCallback ? HandleDoneFn<ReturnType<T>> : T extends "string" ? string : T extends "symbol" ? symbol : T extends "string | symbol" ? string | symbol : never;
+/**
+ * An input type for defining an object's "key".
+ *
+ * Note: use of `FromDefn<T>` will translate this into the actual key value.
+ */
+export type ObjKeyDefn = RecordKeyWideTokens | ShapeCallback;
+export type ArrayTypeDefn = "string[]" | "number[]" | "boolean[]" | "unknown[]" | ShapeCallback;
+export type RecordValueTypeDefn = ShapeCallback | WideTokenNames;
+export type MapKeyDefn = ShapeCallback | WideTokenNames;
+export type MapValueDefn = ShapeCallback | WideTokenNames;
+export type WeakMapKeyDefn = WideContainerNames | ShapeCallback;
+export type WeakMapValueDefn = ShapeCallback | WideTokenNames;
+type ShapeApi__WideContainers = {
+    record: <TKey extends ObjKeyDefn = "string | symbol", TValue extends RecordValueTypeDefn = "unknown">(key?: TKey, value?: TValue) => Record<FromDefn<TKey>, FromDefn<TValue>>;
+    array: <T extends ArrayTypeDefn = "unknown[]">(type?: T) => AsArray<FromDefn<T>>;
+    set: <T extends WideTokenNames | ShapeCallback = "unknown">(type?: T) => T extends ShapeCallback ? Set<HandleDoneFn<ReturnType<T>>> : T extends WideTokenNames ? Set<FromDefn<T>> : Set<unknown>;
+    map: <TKey extends MapKeyDefn = "unknown", TValue extends MapValueDefn = "unknown">(key?: TKey, value?: TValue) => Map<FromDefn<TKey>, FromDefn<TValue>>;
+    weakMap: <TKey extends WeakMapKeyDefn = "object", TValue extends WeakMapValueDefn = "unknown">(key?: TKey, value?: TValue) => WeakMap<As<FromDefn<TKey>, Container>, FromDefn<TValue>>;
+};
+export type TupleDefn = WideTokenNames | ShapeCallback;
+type ShapeApi__LiteralContainers = {
+    dictionary: <T extends DictionaryTypeDefn>(obj: T) => FromDefn<T>;
+    /**
+     * **tuple**(el, el, ...)
+     *
+     * Allows the definition of a **tuple** by expressing each of the elements
+     * in the tuple using the built-in "wide types" or with any type you need
+     * using the callback api.
+     *
+     * ```ts
+     * // [string, number, 42 | 56]
+     * const tuple = 📦.tuple("string", "number", s => s.number(42,56))
+     * ```
+     */
+    tuple: <T extends readonly TupleDefn[]>(...elements: T) => FromDefn<T>;
+};
+/**
+ * The `ShapeApi` is an API surface for defining types which have a runtime aspect
+ * to them as well.
+ *
+ * This is precisely what the `shape()` runtime utility exposes
+ * but any function can add this -- typically by associating a property on a function
+ * -- with the `ShapeCallback` type which simply gives this API to the caller of
+ * the function.
+ */
+export type ShapeApi = ShapeApi__Scalars & ShapeApi__Union & ShapeApi__Functions & ShapeApi__WideContainers & ShapeApi__LiteralContainers;
+/**
+ * **ShapeCallback**
+ *
+ * This is a function signature for a property which you want to use
+ * the `SharpApi` with to define types.
+ */
+export type ShapeCallback = (api: ShapeApi) => unknown;
+export type ScalarCallback = (api: ShapeApi__Scalars & ShapeApi__Union) => unknown;
+export {};
+//# sourceMappingURL=Shape.d.ts.map