inferred-types 0.37.6 → 0.40.2

package/dist/src/types/dictionary/Get.d.ts

@@ -0,0 +1,29 @@
+import type { IfUndefined, ErrorCondition, IfOptionalScalar, IfExtends, ErrorConditionHandler, ToString, ValueAtDotPath } from "src/types";
+import { NoDefaultValue, NotDefined } from "src/constants";
+type ResolveDefVal<TValue, TDefVal> = IfUndefined<TValue, TDefVal extends NoDefaultValue ? undefined : TDefVal, TValue>;
+type ResolveHandler<TValue, THandler> = IfExtends<TValue, ErrorCondition<any>, THandler extends NotDefined ? TValue : THandler extends ErrorConditionHandler ? ReturnType<THandler> : THandler, TValue>;
+/**
+ * **Get**`<T,K,[DevVal, Handler]>`
+ *
+ * Get the type of a property of an object:
+ * ```ts
+ * type Car = {
+ *    make: "Chevy",
+ *    model: "Malibu",
+ *    colors: [ "red", "blue" ]
+ * }
+ * // "red"
+ * type T = Get<Car, "colors.0">;
+ * ```
+ *
+ * - if a _valid_ dotpath leads to a value which is optionally
+ * undefined, you may specify a _default value_ with `TDefVal`
+ * - if you want to resolve an _invalid_ dotpath to something
+ * besides the default `ErrorCondition<"invalid-path">`
+ * you can set `THandler` to the type you'd like it to become.
+ */
+export type Get<TContainer, TDotPath extends string | number | null, TDefVal = NoDefaultValue, THandler = NotDefined> = TDotPath extends "" ? TContainer : TDotPath extends null ? TContainer : IfOptionalScalar<TContainer, ResolveHandler<ErrorCondition<"invalid-path", `The path of "${TDotPath}" is an invalid dotpath and can not be used!`, {
+    library: "Get<TContainer,TDotPath>";
+}>, THandler>, ResolveHandler<ResolveDefVal<ValueAtDotPath<TContainer, ToString<TDotPath>>, TDefVal>, THandler>>;
+export {};
+//# sourceMappingURL=Get.d.ts.map

package/dist/src/types/dictionary/Get.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Get.d.ts","sourceRoot":"","sources":["../../../../src/types/dictionary/Get.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAEV,WAAW,EACX,cAAc,EACd,gBAAgB,EAChB,SAAS,EACT,qBAAqB,EACrB,QAAQ,EACR,cAAc,EACf,MAAM,WAAW,CAAC;AACnB,OAAO,EAAE,cAAc,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAE3D,KAAK,aAAa,CAChB,MAAM,EACN,OAAO,IACL,WAAW,CACb,MAAM,EACN,OAAO,SAAS,cAAc,GAC1B,SAAS,GACT,OAAO,EACX,MAAM,CACP,CAAC;AAEF,KAAK,cAAc,CACjB,MAAM,EACN,QAAQ,IACN,SAAS,CACX,MAAM,EAAE,cAAc,CAAC,GAAG,CAAC,EAE3B,QAAQ,SAAS,UAAU,GACvB,MAAM,GACN,QAAQ,SAAS,qBAAqB,GACpC,UAAU,CAAC,QAAQ,CAAC,GACpB,QAAQ,EAEd,MAAM,CACP,CAAC;AAGF;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,MAAM,GAAG,CACb,UAAU,EACV,QAAQ,SAAS,MAAM,GAAG,MAAM,GAAG,IAAI,EACvC,OAAO,GAAG,cAAc,EACxB,QAAQ,GAAG,UAAU,IACnB,QAAQ,SAAS,EAAE,GACnB,UAAU,GACV,QAAQ,SAAS,IAAI,GACrB,UAAU,GACV,gBAAgB,CACd,UAAU,EACV,cAAc,CACZ,cAAc,CACZ,cAAc,EACd,gBAAgB,QAAQ,8CAA8C,EACtE;IAAE,OAAO,EAAE,0BAA0B,CAAA;CAAC,CACvC,EACD,QAAQ,CACT,EAED,cAAc,CACZ,aAAa,CACX,cAAc,CAAC,UAAU,EAAE,QAAQ,CAAC,QAAQ,CAAC,CAAC,EAC9C,OAAO,CACR,EACD,QAAQ,CACT,CACF,CAAC"}

package/dist/src/types/dictionary/Get.js

@@ -0,0 +1,2 @@
+/* eslint-disable @typescript-eslint/no-explicit-any */
+export {};

package/dist/src/types/dictionary/Keys.d.ts

@@ -0,0 +1,19 @@
+import { IfNever, ExplicitKeys, Container } from "..";
+/**
+ * **Keys**`<TContainer>`
+ *
+ * Provides the _explicit keys_ of a container `TContainer` as an array of values.
+ *
+ * ```ts
+ * type Obj = { foo: 1, bar: 2, [key: string]: unknown };
+ * type Arr = [1,2,3];
+ * // readonly ["foo", "bar"]
+ * type K1 = Keys<Obj>;
+ * // readonly [0,1,2]
+ * type K2 = Keys<Arr>;
+ * ```
+ *
+ * **Related:** `ValidKey`
+ */
+export type Keys<TContainer extends Container> = IfNever<TContainer, readonly [], ExplicitKeys<TContainer>>;
+//# sourceMappingURL=Keys.d.ts.map

package/dist/src/types/dictionary/Keys.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Keys.d.ts","sourceRoot":"","sources":["../../../../src/types/dictionary/Keys.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,OAAO,EACP,YAAY,EACZ,SAAS,EACV,MAAM,IAAI,CAAC;AAEZ;;;;;;;;;;;;;;;GAeG;AACH,MAAM,MAAM,IAAI,CACd,UAAU,SAAS,SAAS,IACxB,OAAO,CACX,UAAU,EACV,SAAS,EAAE,EACX,YAAY,CAAC,UAAU,CAAC,CAEzB,CAAC"}

package/dist/src/types/dictionary/Keys.js

@@ -0,0 +1 @@
+export {};

package/dist/src/types/dictionary/KeysEqualValue.d.ts

@@ -0,0 +1,17 @@
+import { IfEqual } from "..";
+/**
+ * **KeysEqualValue**`<TObj,TValue>`
+ *
+ * The _keys_ on a given object `TObj` which are _equal to_ `TValue`.
+ *
+ * ```ts
+ * // "foo"
+ * type Str = KeysEqualValue<{ foo: string; bar: 5; baz: "bye" }, string>;
+ * ```
+ *
+ * **Related:** `KeysWithValue`
+ */
+export type KeysEqualValue<TObj extends object, TWithValue> = {
+    [K in keyof TObj]: TObj[K] extends readonly unknown[] ? IfEqual<TObj[K], TWithValue, K, never> : IfEqual<TObj[K], TWithValue, K, never>;
+}[keyof TObj];
+//# sourceMappingURL=KeysEqualValue.d.ts.map

package/dist/src/types/dictionary/KeysEqualValue.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"KeysEqualValue.d.ts","sourceRoot":"","sources":["../../../../src/types/dictionary/KeysEqualValue.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,IAAI,CAAC;AAE7B;;;;;;;;;;;GAWG;AACH,MAAM,MAAM,cAAc,CAAC,IAAI,SAAS,MAAM,EAAE,UAAU,IAAI;KAC3D,CAAC,IAAI,MAAM,IAAI,GAAG,IAAI,CAAC,CAAC,CAAC,SAAS,SAAS,OAAO,EAAE,GACjD,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,UAAU,EAAE,CAAC,EAAE,KAAK,CAAC,GACtC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,UAAU,EAAE,CAAC,EAAE,KAAK,CAAC;CAC3C,CAAC,MAAM,IAAI,CAAC,CAAC"}

package/dist/src/types/dictionary/KeysEqualValue.js

@@ -0,0 +1 @@
+export {};

package/dist/src/types/dictionary/KeysNotEqualValue.d.ts

@@ -0,0 +1,17 @@
+import { AnyObject, Narrowable, IfEqual } from "..";
+/**
+ * **KeysNotEqualValue**`<TObj, TValue>`
+ *
+ * The _keys_ on a given object `T` which _do not_ explicitly equal the type value of `W`.
+ *
+ * ```ts
+ * // "bar"
+ * type Str = KeysNotEqualValue<{ foo: 6; bar: 5 }, 5>;
+ * ```
+ *
+ * **Related:** `KeysEqualValue`, `KeysWithoutValue`
+ */
+export type KeysNotEqualValue<TObj extends AnyObject, TValue extends Narrowable> = {
+    [K in keyof TObj]: IfEqual<TObj[K], TValue, never, Readonly<K>>;
+}[keyof TObj];
+//# sourceMappingURL=KeysNotEqualValue.d.ts.map

package/dist/src/types/dictionary/KeysNotEqualValue.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"KeysNotEqualValue.d.ts","sourceRoot":"","sources":["../../../../src/types/dictionary/KeysNotEqualValue.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,UAAU,EAAE,OAAO,EAAE,MAAM,IAAI,CAAC;AAEpD;;;;;;;;;;;GAWG;AACH,MAAM,MAAM,iBAAiB,CAC7B,IAAI,SAAS,SAAS,EACtB,MAAM,SAAS,UAAU,IACrB;KACC,CAAC,IAAI,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC;CAClE,CAAC,MAAM,IAAI,CAAC,CAAC"}

package/dist/src/types/dictionary/KeysNotEqualValue.js

@@ -0,0 +1 @@
+export {};

package/dist/src/types/dictionary/KeysWithValue.d.ts

@@ -0,0 +1,18 @@
+import { AnyObject } from "..";
+/**
+ * **KeysWithValue**`<TObj,TValue>`
+ *
+ * The _keys_ on a given object `TObj` which extend the value
+ * of `TValue`.
+ *
+ * ```ts
+ * // "foo" | "baz"
+ * type Str = KeysWithValue<{ foo: "hi"; bar: 5; baz: "bye" }, string>;
+ * ```
+ *
+ * **Related:** `KeysEqualValue`
+ */
+export type KeysWithValue<TObj extends AnyObject, TValue> = {
+    [K in keyof TObj]: TObj[K] extends readonly unknown[] ? [TObj[K]] extends [Readonly<TValue>] ? K : never : [TObj[K]] extends [TValue] ? K : never;
+}[keyof TObj];
+//# sourceMappingURL=KeysWithValue.d.ts.map

package/dist/src/types/dictionary/KeysWithValue.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"KeysWithValue.d.ts","sourceRoot":"","sources":["../../../../src/types/dictionary/KeysWithValue.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,IAAI,CAAC;AAE/B;;;;;;;;;;;;GAYG;AACH,MAAM,MAAM,aAAa,CAAC,IAAI,SAAS,SAAS,EAAE,MAAM,IAAI;KACzD,CAAC,IAAI,MAAM,IAAI,GAAG,IAAI,CAAC,CAAC,CAAC,SAAS,SAAS,OAAO,EAAE,GACjD,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,GAAG,KAAK,GAChD,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,KAAK;CAC3C,CAAC,MAAM,IAAI,CAAC,CAAC"}

package/dist/src/types/dictionary/KeysWithValue.js

@@ -0,0 +1 @@
+export {};

package/dist/src/types/dictionary/KeysWithoutValue.d.ts

@@ -0,0 +1,15 @@
+import { AnyObject, Narrowable } from "..";
+/**
+ * **KeysWithoutValue**`<TObj, TValue>`
+ *
+ * The _keys_ on a given object `T` which _do not_ extend the type value of `W`.
+ *
+ * ```ts
+ * // "foo"
+ * type T = KeysWithoutValue<{ foo: "hi"; bar: 5; baz: number }, number>;
+ * ```
+ */
+export type KeysWithoutValue<TObj extends AnyObject, TValue extends Narrowable> = {
+    [K in keyof TObj]: TObj[K] extends TValue ? never : Readonly<K>;
+}[keyof TObj];
+//# sourceMappingURL=KeysWithoutValue.d.ts.map

package/dist/src/types/dictionary/KeysWithoutValue.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"KeysWithoutValue.d.ts","sourceRoot":"","sources":["../../../../src/types/dictionary/KeysWithoutValue.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAG,UAAU,EAAE,MAAM,IAAI,CAAC;AAE5C;;;;;;;;;GASG;AACH,MAAM,MAAM,gBAAgB,CAC5B,IAAI,SAAS,SAAS,EACtB,MAAM,SAAS,UAAU,IACrB;KACC,CAAC,IAAI,MAAM,IAAI,GAAG,IAAI,CAAC,CAAC,CAAC,SAAS,MAAM,GAAG,KAAK,GAAG,QAAQ,CAAC,CAAC,CAAC;CAClE,CAAC,MAAM,IAAI,CAAC,CAAC"}

package/dist/src/types/dictionary/KeysWithoutValue.js

@@ -0,0 +1 @@
+export {};

package/dist/src/types/dictionary/MakePropsMutable.d.ts

@@ -0,0 +1,40 @@
+import { ExpandRecursively, AsArray, Mutable, WithKeys, WithoutKeys, AnyObject, SimplifyObject, ObjectKey } from "src/types";
+/**
+ * **MakePropsMutable**`<TObj,TMutProps>`
+ *
+ * Given a dictionary of type `<TObj>`, this utility function will
+ * make the properties of `TMutProps` _mutable_. `TMutProps` can be
+ * a union type (as shown below) or a union.
+ *
+ * ```ts
+ * // { foo: string, bar?: number, readonly baz: number }
+ * type Example = MutableProps<{
+ *    readonly foo: string,
+ *    bar?: number,
+ *    readonly baz: number
+ * }, "foo" | "bar">;
+ * ```
+ *
+ * **Related:** `MutablePropsExclusive`
+ */
+export type MakePropsMutable<TObj extends AnyObject, TMutProps extends ObjectKey[] | ObjectKey> = SimplifyObject<Mutable<WithKeys<TObj, TMutProps>> & WithoutKeys<TObj, TMutProps>>;
+/**
+ * **MutablePropsExclusive**`<T,M>`
+ *
+ * Given a dictionary of type `<T>`, this utility function will
+ * make the properties represented by `M` _mutable_ and all others
+ * immutable.
+ *
+ * ```ts
+ * // { foo: string, readonly bar: number, readonly baz: number }
+ * type Example = MutableProps<{
+ *    readonly foo: string,
+ *    bar?: number,
+ *    readonly baz: number
+ * }, "foo">;
+ * ```
+ *
+ * **Related:** `MutableProps`
+ */
+export type MutablePropsExclusive<T extends AnyObject, M extends (keyof T & ObjectKey) | readonly (keyof T & ObjectKey)[]> = ExpandRecursively<Mutable<WithKeys<T, M>> & Readonly<WithoutKeys<T, AsArray<M>>>>;
+//# sourceMappingURL=MakePropsMutable.d.ts.map

package/dist/src/types/dictionary/MakePropsMutable.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"MakePropsMutable.d.ts","sourceRoot":"","sources":["../../../../src/types/dictionary/MakePropsMutable.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAG,OAAO,EAAE,OAAO,EAAG,QAAQ,EAAE,WAAW,EAAG,SAAS,EAAE,cAAc,EAAE,SAAS,EAAE,MAAM,WAAW,CAAC;AAGhI;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,MAAM,gBAAgB,CAC1B,IAAI,SAAS,SAAS,EACtB,SAAS,SAAS,SAAS,EAAE,GAAG,SAAS,IACvC,cAAc,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC,GACjD,WAAW,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC,CAAC;AAElC;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,MAAM,qBAAqB,CAC/B,CAAC,SAAS,SAAS,EACnB,CAAC,SAAS,CAAC,MAAM,CAAC,GAAG,SAAS,CAAC,GAAG,SAAS,CAAC,MAAM,CAAC,GAAG,SAAS,CAAC,EAAE,IAChE,iBAAiB,CACnB,OAAO,CAAC,QAAQ,CAAC,CAAC,EAAC,CAAC,CAAC,CAAC,GAAG,QAAQ,CAAC,WAAW,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAC9D,CAAC"}

package/dist/src/types/dictionary/MakePropsMutable.js

@@ -0,0 +1 @@
+export {};

package/dist/src/types/dictionary/MapTo.d.ts

@@ -0,0 +1,228 @@
+import { AnyObject, MergeObjects, OptRequired } from "..";
+export declare const DEFAULT_ONE_TO_MANY_MAPPING: FinalizedMapConfig<"req", "I -> O[]", "opt">;
+export declare const DEFAULT_ONE_TO_ONE_MAPPING: FinalizedMapConfig<"req", "I -> O", "req">;
+export declare const DEFAULT_MANY_TO_ONE_MAPPING: FinalizedMapConfig<"req", "I[] -> O", "req">;
+/**
+ * The _default_ One-to-Many mapping that the mapTo() utility provides
+ */
+export type DefaultOneToManyMapping = typeof DEFAULT_ONE_TO_MANY_MAPPING;
+/**
+ * The _default_ One-to-One mapping that the mapTo() utility provides
+ */
+export type DefaultOneToOneMapping = typeof DEFAULT_ONE_TO_ONE_MAPPING;
+/**
+ * The _default_ Many-to-One mapping that the mapTo() utility provides
+ */
+export type DefaultManyToOneMapping = typeof DEFAULT_MANY_TO_ONE_MAPPING;
+/**
+ * Expresses relationship between inputs/outputs:
+ */
+export declare enum MapCardinality {
+    /** every input results in 0:M outputs */
+    OneToMany = "I -> O[]",
+    /** every input results in 0:1 outputs */
+    OneToOne = "I -> O",
+    /** every input is an array of type I and reduced to a single O  */
+    ManyToOne = "I[] -> O"
+}
+export type MapCardinalityIllustrated = `${string | number}`;
+/**
+ * The _user_ configuration of a **mapTo** mapper function
+ * which will be finalized by merging it with the appropriate
+ * default mapping type.
+ */
+export interface MapConfig<IR extends OptRequired | undefined = undefined, D extends MapCardinalityIllustrated | undefined = undefined, OR extends OptRequired | undefined = undefined> {
+    input?: IR;
+    output?: OR;
+    cardinality?: D;
+    /**
+     * Whether calls to the final `MapFn` will be logged to stderr
+     * for debugging purposes. Defaults to false; if you specify
+     * a _string_ for a value that will be sent to stderr along
+     * with other debugging info.
+     */
+    debug?: boolean | string;
+}
+/**
+ * A finalized configuration of a **mapTo** mapper functions cardinality
+ * relationships between _inputs_ and _outputs_.
+ *
+ * Note: _this configuration does _not_ yet include the actual mapping
+ * configuration between the input and output._
+ */
+export type FinalizedMapConfig<IR extends OptRequired = MapIR<DefaultOneToManyMapping & string>, D extends MapCardinalityIllustrated = MapCard<DefaultOneToManyMapping>, OR extends OptRequired = MapOR<DefaultOneToManyMapping>> = Required<Omit<MapConfig<IR, D, OR>, "debug">> & {
+    finalized: true;
+    debug: boolean | string;
+};
+/**
+ * User configuration exposed by a config function which specifies the
+ * cardinality already (e.g., `oneToMany()`, `manyToOne()`)
+ */
+type MapCardinalityConfig<IR extends OptRequired | undefined, OR extends OptRequired | undefined> = {
+    /** whether we the input can _optionally_ be an `undefined` value or not */
+    input?: IR;
+    /** whether we the output can _optionally_ be an `undefined` value or not */
+    output?: OR;
+    /**
+     * Whether calls to the final `MapFn` will be logged to stderr
+     * for debugging purposes. Defaults to false; if you set to a string
+     * value than this will be echoed out with stderr.
+     */
+    debug?: boolean | string;
+};
+/**
+ * **ConfiguredMap**
+ *
+ * A partial application of the mapTo() utility which has expressed the
+ * configuration of the _inputs_ and _outputs_ and provides a `.map()`
+ * method which allows the user configure the specifics of the mapping.
+ */
+export type ConfiguredMap<C extends FinalizedMapConfig<OptRequired, MapCardinalityIllustrated, OptRequired>> = {
+    map: <I, O>(map: MapTo<I, O, C>) => Mapper<I, O, C>;
+    input: MapIR<C>;
+    cardinality: MapCard<C>;
+    output: MapOR<C>;
+    debug: boolean | string;
+};
+/**
+ * Extracts the IR, Cardinality, and OR generics from a FinalizedMapConfig
+ */
+export type DecomposeMapConfig<M extends FinalizedMapConfig<OptRequired, MapCardinalityIllustrated, OptRequired>> = M extends MapConfig<infer IR, infer D, infer OR> ? IR extends OptRequired | undefined ? D extends MapCardinalityIllustrated | undefined ? OR extends OptRequired | undefined ? [IR, D, OR] : never : never : never : M extends FinalizedMapConfig<infer IR, infer D, infer OR> ? IR extends OptRequired ? D extends MapCardinalityIllustrated ? OR extends OptRequired ? [IR, D, OR] : never : never : never : never;
+/** extracts IR from a `FinalizedMapConfig` */
+export type MapIR<T extends FinalizedMapConfig<OptRequired, MapCardinalityIllustrated, OptRequired>> = DecomposeMapConfig<T>[0];
+/**
+ * extracts the MapCardinality from a `FinalizedMapConfig`
+ */
+export type MapCard<T extends FinalizedMapConfig<OptRequired, MapCardinalityIllustrated, OptRequired>> = DecomposeMapConfig<T>[1];
+/** extracts OR from a `FinalizedMapConfig` */
+export type MapOR<T extends FinalizedMapConfig<OptRequired, MapCardinalityIllustrated, OptRequired>> = DecomposeMapConfig<T>[2];
+/**
+ * Merges the types of a userland configuration with a default configuration
+ */
+export type AsFinalizedConfig<U extends MapConfig<OptRequired | undefined, MapCardinalityIllustrated | undefined, OptRequired | undefined>, D extends FinalizedMapConfig<OptRequired, MapCardinalityIllustrated, OptRequired>> = MergeObjects<U & AnyObject, D> extends FinalizedMapConfig<infer IR, infer C, infer OR> ? FinalizedMapConfig<IR, C, OR> : never;
+export type MapperApi = {
+    /**
+     * Provides opportunity to configure _input_, _output_, and _cardinality_
+     * prior to providing a mapping function.
+     *
+     * Note: _the defaults for configuration are defined by the_ `DEFAULT_ONE_TO_MANY_MAPPING`
+     * _constant made available as a symbol from this library._
+     */
+    config: <C extends MapConfig<OptRequired, //
+    MapCardinalityIllustrated, OptRequired>>(config: C) => ConfiguredMap<AsFinalizedConfig<C, //
+    DefaultOneToManyMapping>>;
+    /**
+     * Provides a nice 1:1 ratio between the input and output.
+     *
+     * By default the input and output are considered to be _required_
+     * properties but this can be changed with the options hash provided.
+     * ```ts
+     * const mapper = mapTo.oneToOne().map(...);
+     * // add in ability to filter out some inputs
+     * const mapAndFilter = mapTo.oneToOne({ output: "opt" })
+     * ```
+     */
+    oneToOne: <C extends MapCardinalityConfig<OptRequired, OptRequired>>(config?: C) => ConfiguredMap<AsFinalizedConfig<C, //
+    DefaultOneToOneMapping>>;
+    /**
+     * **manyToOne** _mapping_
+     *
+     * Provides a configuration where multiple inputs `I[]` will be mapped to a
+     * single output `O`.
+     *
+     * Choosing this configuration will, by default, set both input and output
+     * to be "required" but you can change this default if you so choose.
+     */
+    manyToOne: <C extends MapCardinalityConfig<OptRequired | undefined, //
+    //
+    OptRequired | undefined>>(config?: C) => ConfiguredMap<AsFinalizedConfig<C, //
+    DefaultManyToOneMapping>>;
+    oneToMany: <C extends MapCardinalityConfig<OptRequired | undefined, //
+    //
+    OptRequired | undefined>>(config?: C) => ConfiguredMap<AsFinalizedConfig<C, //
+    DefaultOneToManyMapping>>;
+};
+export type MapInput<I, //
+IR extends OptRequired, C extends MapCardinalityIllustrated> = C extends MapCardinality.OneToMany | "I -> O[]" ? IR extends "opt" ? I | undefined : I : C extends MapCardinality.OneToOne | "I -> O" ? IR extends "opt" ? I | undefined : I : C extends MapCardinality.ManyToOne | "I[] -> O" ? IR extends "opt" ? I[] | undefined : I[] : never;
+export type MapOutput<O, //
+OR extends OptRequired, C extends MapCardinalityIllustrated> = C extends MapCardinality.OneToMany | "I -> O[]" ? OR extends "opt" ? O[] : [O, ...O[]] : C extends MapCardinality.OneToOne | "I -> O" ? OR extends "opt" ? O | null : O : C extends MapCardinality.ManyToOne | "I[] -> O" ? OR extends "opt" ? O | null : O : never;
+/**
+ * **MapTo<I, O>**
+ *
+ * A mapping function between an input type `I` and output type `O`. Defaults to using
+ * the _default_ OneToMany mapping config.
+ *
+ * **Note:** this type is designed to guide the userland mapping; refer
+ * to `MapFn` if you want the type output by the `mapFn()` utility.
+ */
+export type MapTo<I, O, C extends FinalizedMapConfig<OptRequired, MapCardinalityIllustrated, OptRequired> = DefaultOneToManyMapping> = MapIR<C> extends "opt" ? (source?: MapInput<I, MapIR<C>, MapCard<C>>) => MapOutput<O, MapOR<C>, MapCard<C>> : (source: MapInput<I, MapIR<C>, MapCard<C>>) => MapOutput<O, MapOR<C>, MapCard<C>>;
+export type MapFnOutput<I, O, S, OR extends OptRequired, C extends MapCardinalityIllustrated> = C extends "I -> O[]" | MapCardinality.OneToMany ? S extends I[] ? OR extends "opt" ? O[] : [O, ...O[]] : OR extends "opt" ? O[] | null : O[] : C extends MapCardinality.OneToOne | "I -> O" ? S extends I[] ? OR extends "opt" ? O[] : [O, ...O[]] : OR extends "opt" ? O | null : O : C extends MapCardinality.ManyToOne | "I[] -> O" ? S extends I[][] ? OR extends "opt" ? O[] : [O, ...O[]] : OR extends "opt" ? O | null : O : never;
+export type MapFnInput<I, IR extends OptRequired, D extends MapCardinalityIllustrated> = D extends "I -> O[]" | MapCardinality.OneToMany ? IR extends "opt" ? I | I[] | undefined : I | I[] : D extends MapCardinality.OneToOne | "I -> O" ? IR extends "opt" ? I | I[] | undefined : I | I[] : D extends MapCardinality.ManyToOne | "I[] -> O" ? IR extends "opt" ? I[] | I[][] | undefined : I[] | I[][] : never;
+/**
+ * The mapping function provided by the `mapFn()` utility. This _fn_
+ * is intended to be used in two ways:
+ *
+ * 1. Iterative:
+ *    ```ts
+ *    const m = mapTo<I,O>(i => [ ... ]);
+ *    // maps inputs to outputs
+ *    const out = inputs.map(m);
+ *    ```
+ * 2. Block:
+ *    ```ts
+ *    // maps inputs to outputs (filtering or splitting where appr.)
+ *    const out2 = m(inputs);
+ *    ```
+ */
+export type MapFn<I, O, C extends FinalizedMapConfig<OptRequired, MapCardinalityIllustrated, OptRequired>> = MapIR<C> extends "opt" ? <S extends MapFnInput<I, MapIR<C>, MapCard<C>>>(source?: S) => MapFnOutput<I, O, S, MapOR<C>, MapCard<C>> : <S extends MapFnInput<I, MapIR<C>, MapCard<C>>>(source: S) => MapFnOutput<I, O, S, MapOR<C>, MapCard<C>>;
+/**
+ * **Mapper**
+ *
+ * A fully configured _mapper_ stemming from the **mapTo()** utility. It is both a mapping
+ * function and a dictionary which describes the mapper's properties.
+ * ```ts
+ * const m = mapTo.oneToOne().map( ... );
+ * const mapped = m(inputs);
+ * const mappedOver = inputs.map(m);
+ * ```
+ *
+ * Note: the root of a `Mapper` is the mapper function but
+ * this is combined with a dictionary of settings and types
+ * which you can use. For instance, look at the `fnSignature`
+ * property to get the _type_ signature of the map function.
+ */
+export type Mapper<I = unknown, O = unknown, C extends FinalizedMapConfig<OptRequired, MapCardinalityIllustrated, OptRequired> = FinalizedMapConfig<OptRequired, MapCardinalityIllustrated, OptRequired>> = {
+    input: MapIR<C>;
+    output: MapOR<C>;
+    cardinality: MapCard<C>;
+    debug: boolean | string;
+    inputType: I;
+    outputType: O;
+    /**
+     * Provides the _type_ information for mapper function.
+     *
+     * Note: _this is just a **type**_ not the actual function which positioned
+     * at the root of the Mapper type
+     */
+    fnSignature: MapFn<I, O, C>;
+} & MapFn<I, O, C>;
+/**
+ * **MapInputFrom**
+ *
+ * Type utility which extracts the `I` type from a fully configured `Mapper`
+ */
+export type MapInputFrom<T extends Mapper> = T extends Mapper<infer I> ? I : never;
+/**
+ * **MapOutputFrom**
+ *
+ * Type utility which extracts the output [`O`] type from a fully configured `Mapper`
+ */
+export type MapOutputFrom<T extends Mapper> = T extends Mapper<any, infer O> ? O : never;
+/**
+ * **MapCardinalityFrom**
+ *
+ * Type utility which extracts _cardinality_ of a `Mapper`'s inputs to outputs
+ */
+export type MapCardinalityFrom<T extends Mapper> = T extends Mapper<any, any, infer C> ? C extends FinalizedMapConfig<OptRequired, infer Cardinality, OptRequired> ? Cardinality : never : never;
+export {};
+//# sourceMappingURL=MapTo.d.ts.map

package/dist/src/types/dictionary/MapTo.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"MapTo.d.ts","sourceRoot":"","sources":["../../../../src/types/dictionary/MapTo.ts"],"names":[],"mappings":"AACA,OAAO,EACL,SAAS,EACT,YAAY,EACZ,WAAW,EACZ,MAAM,IAAI,CAAC;AAgBZ,eAAO,MAAM,2BAA2B,8CAItC,CAAC;AAEH,eAAO,MAAM,0BAA0B,4CAIrC,CAAC;AAEH,eAAO,MAAM,2BAA2B,8CAItC,CAAC;AAEH;;GAEG;AACH,MAAM,MAAM,uBAAuB,GAAG,OAAO,2BAA2B,CAAC;AAEzE;;GAEG;AACH,MAAM,MAAM,sBAAsB,GAAG,OAAO,0BAA0B,CAAC;AAEvE;;GAEG;AACH,MAAM,MAAM,uBAAuB,GAAG,OAAO,2BAA2B,CAAC;AAGzE;;GAEG;AACH,oBAAY,cAAc;IACxB,yCAAyC;IACzC,SAAS,aAAa;IACtB,yCAAyC;IACzC,QAAQ,WAAW;IACnB,mEAAmE;IACnE,SAAS,aAAa;CACvB;AAED,MAAM,MAAM,yBAAyB,GAAG,GAAG,MAAM,GAAG,MAAM,EAAE,CAAC;AAE7D;;;;GAIG;AACH,MAAM,WAAW,SAAS,CACxB,EAAE,SAAS,WAAW,GAAG,SAAS,GAAG,SAAS,EAC9C,CAAC,SAAS,yBAAyB,GAAG,SAAS,GAAG,SAAS,EAC3D,EAAE,SAAS,WAAW,GAAG,SAAS,GAAG,SAAS;IAE9C,KAAK,CAAC,EAAE,EAAE,CAAC;IACX,MAAM,CAAC,EAAE,EAAE,CAAC;IACZ,WAAW,CAAC,EAAE,CAAC,CAAC;IAChB;;;;;OAKG;IACH,KAAK,CAAC,EAAE,OAAO,GAAG,MAAM,CAAC;CAC1B;AAED;;;;;;GAMG;AACH,MAAM,MAAM,kBAAkB,CAC5B,EAAE,SAAS,WAAW,GAAG,KAAK,CAAC,uBAAuB,GAAG,MAAM,CAAC,EAChE,CAAC,SAAS,yBAAyB,GAAG,OAAO,CAAC,uBAAuB,CAAC,EACtE,EAAE,SAAS,WAAW,GAAG,KAAK,CAAC,uBAAuB,CAAC,IACrD,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,EAAE,CAAC,EAAE,EAAE,CAAC,EAAE,OAAO,CAAC,CAAC,GAAG;IAAE,SAAS,EAAE,IAAI,CAAC;IAAC,KAAK,EAAE,OAAO,GAAG,MAAM,CAAA;CAAE,CAAC;AAEjG;;;GAGG;AACH,KAAK,oBAAoB,CACvB,EAAE,SAAS,WAAW,GAAG,SAAS,EAClC,EAAE,SAAS,WAAW,GAAG,SAAS,IAChC;IACF,2EAA2E;IAC3E,KAAK,CAAC,EAAE,EAAE,CAAC;IACX,4EAA4E;IAC5E,MAAM,CAAC,EAAE,EAAE,CAAC;IACZ;;;;OAIG;IACH,KAAK,CAAC,EAAE,OAAO,GAAG,MAAM,CAAC;CAC1B,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,MAAM,aAAa,CACvB,CAAC,SAAS,kBAAkB,CAAC,WAAW,EAAE,yBAAyB,EAAE,WAAW,CAAC,IAC/E;IACF,GAAG,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,GAAG,EAAE,KAAK,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,KAAK,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;IACpD,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC;IAChB,WAAW,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC;IACxB,MAAM,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC;IACjB,KAAK,EAAE,OAAO,GAAG,MAAM,CAAC;CACzB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,kBAAkB,CAC5B,CAAC,SAAS,kBAAkB,CAAC,WAAW,EAAE,yBAAyB,EAAE,WAAW,CAAC,IAC/E,CAAC,SAAS,SAAS,CAAC,MAAM,EAAE,EAAE,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC,GAChD,EAAE,SAAS,WAAW,GAAG,SAAS,GAChC,CAAC,SAAS,yBAAyB,GAAG,SAAS,GAC7C,EAAE,SAAS,WAAW,GAAG,SAAS,GAChC,CAAC,EAAE,EAAE,CAAC,EAAE,EAAE,CAAC,GACX,KAAK,GACP,KAAK,GACP,KAAK,GACP,CAAC,SAAS,kBAAkB,CAAC,MAAM,EAAE,EAAE,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC,GACzD,EAAE,SAAS,WAAW,GACpB,CAAC,SAAS,yBAAyB,GACjC,EAAE,SAAS,WAAW,GACpB,CAAC,EAAE,EAAE,CAAC,EAAE,EAAE,CAAC,GACX,KAAK,GACP,KAAK,GACP,KAAK,GACP,KAAK,CAAC;AAEV,8CAA8C;AAC9C,MAAM,MAAM,KAAK,CACf,CAAC,SAAS,kBAAkB,CAAC,WAAW,EAAE,yBAAyB,EAAE,WAAW,CAAC,IAC/E,kBAAkB,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AAE7B;;GAEG;AACH,MAAM,MAAM,OAAO,CACjB,CAAC,SAAS,kBAAkB,CAAC,WAAW,EAAE,yBAAyB,EAAE,WAAW,CAAC,IAC/E,kBAAkB,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AAE7B,8CAA8C;AAC9C,MAAM,MAAM,KAAK,CACf,CAAC,SAAS,kBAAkB,CAAC,WAAW,EAAE,yBAAyB,EAAE,WAAW,CAAC,IAC/E,kBAAkB,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AAE7B;;GAEG;AACH,MAAM,MAAM,iBAAiB,CAC3B,CAAC,SAAS,SAAS,CACjB,WAAW,GAAG,SAAS,EACvB,yBAAyB,GAAG,SAAS,EACrC,WAAW,GAAG,SAAS,CACxB,EACD,CAAC,SAAS,kBAAkB,CAAC,WAAW,EAAE,yBAAyB,EAAE,WAAW,CAAC,IAC/E,YAAY,CAAC,CAAC,GAAG,SAAS,EAAE,CAAC,CAAC,SAAS,kBAAkB,CAAC,MAAM,EAAE,EAAE,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC,GACtF,kBAAkB,CAAC,EAAE,EAAE,CAAC,EAAE,EAAE,CAAC,GAC7B,KAAK,CAAC;AAEV,MAAM,MAAM,SAAS,GAAG;IACtB;;;;;;OAMG;IACH,MAAM,EAAE,CACN,CAAC,SAAS,SAAS,CACjB,WAAW,EAAE,EAAE;IACf,yBAAyB,EACzB,WAAW,CACZ,EAED,MAAM,EAAE,CAAC,KACN,aAAa,CAChB,iBAAiB,CACf,CAAC,EAAE,EAAE;IACL,uBAAuB,CACxB,CACF,CAAC;IAEF;;;;;;;;;;OAUG;IACH,QAAQ,EAAE,CAAC,CAAC,SAAS,oBAAoB,CAAC,WAAW,EAAE,WAAW,CAAC,EACjE,MAAM,CAAC,EAAE,CAAC,KACP,aAAa,CAChB,iBAAiB,CACf,CAAC,EAAE,EAAE;IACL,sBAAsB,CACvB,CACF,CAAC;IAEF;;;;;;;;OAQG;IACH,SAAS,EAAE,CACT,CAAC,SAAS,oBAAoB,CAC5B,WAAW,GAAG,SAAS,EAAE,EAAE;IAC3B,AADyB,EAAE;IAC3B,WAAW,GAAG,SAAS,CACxB,EAED,MAAM,CAAC,EAAE,CAAC,KACP,aAAa,CAChB,iBAAiB,CACf,CAAC,EAAE,EAAE;IACL,uBAAuB,CACxB,CACF,CAAC;IAEF,SAAS,EAAE,CACT,CAAC,SAAS,oBAAoB,CAC5B,WAAW,GAAG,SAAS,EAAE,EAAE;IAC3B,AADyB,EAAE;IAC3B,WAAW,GAAG,SAAS,CACxB,EAED,MAAM,CAAC,EAAE,CAAC,KACP,aAAa,CAChB,iBAAiB,CACf,CAAC,EAAE,EAAE;IACL,uBAAuB,CACxB,CACF,CAAC;CACH,CAAC;AAEF,MAAM,MAAM,QAAQ,CAClB,CAAC,EAAE,EAAE;AACL,EAAE,SAAS,WAAW,EACtB,CAAC,SAAS,yBAAyB,IACjC,CAAC,SAAS,cAAc,CAAC,SAAS,GAAG,UAAU,GAC/C,EAAE,SAAS,KAAK,GACd,CAAC,GAAG,SAAS,GACb,CAAC,GACH,CAAC,SAAS,cAAc,CAAC,QAAQ,GAAG,QAAQ,GAC5C,EAAE,SAAS,KAAK,GACd,CAAC,GAAG,SAAS,GACb,CAAC,GACH,CAAC,SAAS,cAAc,CAAC,SAAS,GAAG,UAAU,GAC/C,EAAE,SAAS,KAAK,GACd,CAAC,EAAE,GAAG,SAAS,GACf,CAAC,EAAE,GACL,KAAK,CAAC;AAEV,MAAM,MAAM,SAAS,CACnB,CAAC,EAAE,EAAE;AACL,EAAE,SAAS,WAAW,EACtB,CAAC,SAAS,yBAAyB,IACjC,CAAC,SAAS,cAAc,CAAC,SAAS,GAAG,UAAU,GAC/C,EAAE,SAAS,KAAK,GACd,CAAC,EAAE,GACH,CAAC,CAAC,EAAE,GAAG,CAAC,EAAE,CAAC,GACb,CAAC,SAAS,cAAc,CAAC,QAAQ,GAAG,QAAQ,GAC5C,EAAE,SAAS,KAAK,GACd,CAAC,GAAG,IAAI,GACR,CAAC,GACH,CAAC,SAAS,cAAc,CAAC,SAAS,GAAG,UAAU,GAC/C,EAAE,SAAS,KAAK,GACd,CAAC,GAAG,IAAI,GACR,CAAC,GACH,KAAK,CAAC;AAEV;;;;;;;;GAQG;AACH,MAAM,MAAM,KAAK,CACf,CAAC,EACD,CAAC,EACD,CAAC,SAAS,kBAAkB,CAC1B,WAAW,EACX,yBAAyB,EACzB,WAAW,CACZ,GAAG,uBAAuB,IACzB,KAAK,CAAC,CAAC,CAAC,SAAS,KAAK,GACtB,CAAC,MAAM,CAAC,EAAE,QAAQ,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,KAAK,SAAS,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,GAClF,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,KAAK,SAAS,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC;AAEtF,MAAM,MAAM,WAAW,CACrB,CAAC,EACD,CAAC,EACD,CAAC,EACD,EAAE,SAAS,WAAW,EACtB,CAAC,SAAS,yBAAyB,IACjC,CAAC,SAAS,UAAU,GAAG,cAAc,CAAC,SAAS,GAC/C,CAAC,SAAS,CAAC,EAAE,GACX,EAAE,SAAS,KAAK,GACd,CAAC,EAAE,GACH,CAAC,CAAC,EAAE,GAAG,CAAC,EAAE,CAAC,GACb,EAAE,SAAS,KAAK,GAChB,CAAC,EAAE,GAAG,IAAI,GACV,CAAC,EAAE,GACL,CAAC,SAAS,cAAc,CAAC,QAAQ,GAAG,QAAQ,GAC5C,CAAC,SAAS,CAAC,EAAE,GACX,EAAE,SAAS,KAAK,GACd,CAAC,EAAE,GACH,CAAC,CAAC,EAAE,GAAG,CAAC,EAAE,CAAC,GACb,EAAE,SAAS,KAAK,GAChB,CAAC,GAAG,IAAI,GACR,CAAC,GACH,CAAC,SAAS,cAAc,CAAC,SAAS,GAAG,UAAU,GAC/C,CAAC,SAAS,CAAC,EAAE,EAAE,GACb,EAAE,SAAS,KAAK,GACd,CAAC,EAAE,GACH,CAAC,CAAC,EAAE,GAAG,CAAC,EAAE,CAAC,GACb,EAAE,SAAS,KAAK,GAChB,CAAC,GAAG,IAAI,GACR,CAAC,GACH,KAAK,CAAC;AAEV,MAAM,MAAM,UAAU,CAAC,CAAC,EAAE,EAAE,SAAS,WAAW,EAAE,CAAC,SAAS,yBAAyB,IAAI,CAAC,SACtF,UAAU,GACV,cAAc,CAAC,SAAS,GACxB,EAAE,SAAS,KAAK,GACd,CAAC,GAAG,CAAC,EAAE,GAAG,SAAS,GACnB,CAAC,GAAG,CAAC,EAAE,GACT,CAAC,SAAS,cAAc,CAAC,QAAQ,GAAG,QAAQ,GAC5C,EAAE,SAAS,KAAK,GACd,CAAC,GAAG,CAAC,EAAE,GAAG,SAAS,GACnB,CAAC,GAAG,CAAC,EAAE,GACT,CAAC,SAAS,cAAc,CAAC,SAAS,GAAG,UAAU,GAC/C,EAAE,SAAS,KAAK,GACd,CAAC,EAAE,GAAG,CAAC,EAAE,EAAE,GAAG,SAAS,GACvB,CAAC,EAAE,GAAG,CAAC,EAAE,EAAE,GACb,KAAK,CAAC;AAEV;;;;;;;;;;;;;;;GAeG;AACH,MAAM,MAAM,KAAK,CACf,CAAC,EACD,CAAC,EACD,CAAC,SAAS,kBAAkB,CAAC,WAAW,EAAE,yBAAyB,EAAE,WAAW,CAAC,IAC/E,KAAK,CAAC,CAAC,CAAC,SAAS,KAAK,GACtB,CAAC,CAAC,SAAS,UAAU,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,EAC5C,MAAM,CAAC,EAAE,CAAC,KACP,WAAW,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,GAC/C,CAAC,CAAC,SAAS,UAAU,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,EAC5C,MAAM,EAAE,CAAC,KACN,WAAW,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC;AAEpD;;;;;;;;;;;;;;;GAeG;AACH,MAAM,MAAM,MAAM,CAChB,CAAC,GAAG,OAAO,EACX,CAAC,GAAG,OAAO,EACX,CAAC,SAAS,kBAAkB,CAC1B,WAAW,EACX,yBAAyB,EACzB,WAAW,CACZ,GAAG,kBAAkB,CAAC,WAAW,EAAE,yBAAyB,EAAE,WAAW,CAAC,IACzE;IACF,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC;IAChB,MAAM,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC;IACjB,WAAW,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC;IACxB,KAAK,EAAE,OAAO,GAAG,MAAM,CAAC;IACxB,SAAS,EAAE,CAAC,CAAC;IACb,UAAU,EAAE,CAAC,CAAC;IACd;;;;;OAKG;IACH,WAAW,EAAE,KAAK,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;CAC7B,GAAG,KAAK,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;AAEnB;;;;GAIG;AACH,MAAM,MAAM,YAAY,CAAC,CAAC,SAAS,MAAM,IAAI,CAAC,SAAS,MAAM,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;AAEnF;;;;GAIG;AACH,MAAM,MAAM,aAAa,CAAC,CAAC,SAAS,MAAM,IAAI,CAAC,SAAS,MAAM,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;AAEzF;;;;GAIG;AACH,MAAM,MAAM,kBAAkB,CAAC,CAAC,SAAS,MAAM,IAAI,CAAC,SAAS,MAAM,CAAC,GAAG,EAAE,GAAG,EAAE,MAAM,CAAC,CAAC,GAClF,CAAC,SAAS,kBAAkB,CAAC,WAAW,EAAE,MAAM,WAAW,EAAE,WAAW,CAAC,GACvE,WAAW,GACX,KAAK,GACP,KAAK,CAAC"}

package/dist/src/types/dictionary/MapTo.js

@@ -0,0 +1,34 @@
+/**
+ * utility function to take a fully-qualified _user_ config
+ * and make it into a FinalizedMapConfig
+ */
+const toFinalizedConfig = (config) => {
+    return { ...config, finalized: true };
+};
+export const DEFAULT_ONE_TO_MANY_MAPPING = toFinalizedConfig({
+    input: "req",
+    output: "opt",
+    cardinality: "I -> O[]",
+});
+export const DEFAULT_ONE_TO_ONE_MAPPING = toFinalizedConfig({
+    input: "req",
+    output: "req",
+    cardinality: "I -> O",
+});
+export const DEFAULT_MANY_TO_ONE_MAPPING = toFinalizedConfig({
+    input: "req",
+    output: "req",
+    cardinality: "I[] -> O",
+});
+/**
+ * Expresses relationship between inputs/outputs:
+ */
+export var MapCardinality;
+(function (MapCardinality) {
+    /** every input results in 0:M outputs */
+    MapCardinality["OneToMany"] = "I -> O[]";
+    /** every input results in 0:1 outputs */
+    MapCardinality["OneToOne"] = "I -> O";
+    /** every input is an array of type I and reduced to a single O  */
+    MapCardinality["ManyToOne"] = "I[] -> O";
+})(MapCardinality || (MapCardinality = {}));

package/dist/src/types/dictionary/MaybeRef.d.ts

@@ -0,0 +1,17 @@
+import { VueRef } from "..";
+/**
+ * **MaybeRef**`<T>`
+ *
+ * Used to represent a type which is either of the two:
+ *
+ * - `T`
+ * - `VueRef<T>`
+ *
+ * **Related:** `IsRef`, `IfRef`
+ * ```ts
+ * // number | VueRef<number>
+ * type T = MaybeRef<number>;
+ * ```
+ */
+export type MaybeRef<T> = T | VueRef<T>;
+//# sourceMappingURL=MaybeRef.d.ts.map

package/dist/src/types/dictionary/MaybeRef.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"MaybeRef.d.ts","sourceRoot":"","sources":["../../../../src/types/dictionary/MaybeRef.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,IAAI,CAAC;AAE5B;;;;;;;;;;;;;GAaG;AACH,MAAM,MAAM,QAAQ,CAAC,CAAC,IAAI,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC"}

package/dist/src/types/dictionary/MaybeRef.js

@@ -0,0 +1 @@
+export {};

package/dist/src/types/dictionary/MutableProps.d.ts

@@ -0,0 +1,9 @@
+import { ReadonlyKeys } from "..";
+/**
+ * **MutableProps**`<T>`
+ *
+ * Reduces an object down to just the key/value pairs which
+ * are mutable.
+ */
+export type MutableProps<T extends object> = Omit<T, ReadonlyKeys<T>>;
+//# sourceMappingURL=MutableProps.d.ts.map

package/dist/src/types/dictionary/MutableProps.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"MutableProps.d.ts","sourceRoot":"","sources":["../../../../src/types/dictionary/MutableProps.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,IAAI,CAAC;AAElC;;;;;GAKG;AACH,MAAM,MAAM,YAAY,CAAC,CAAC,SAAS,MAAM,IAAI,IAAI,CAAC,CAAC,EAAE,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC"}

package/dist/src/types/dictionary/MutableProps.js

@@ -0,0 +1 @@
+export {};

package/dist/src/types/dictionary/NonNumericKeys.d.ts

@@ -0,0 +1,9 @@
+/**
+ * **NonNumericKeys**`<T>`
+ *
+ * The keys in an array/object `T` which are _not_ numeric keys.
+ */
+export type NonNumericKeys<T extends object> = {
+    [K in keyof T]: K extends number ? never : Readonly<K>;
+}[keyof T];
+//# sourceMappingURL=NonNumericKeys.d.ts.map

package/dist/src/types/dictionary/NonNumericKeys.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"NonNumericKeys.d.ts","sourceRoot":"","sources":["../../../../src/types/dictionary/NonNumericKeys.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,MAAM,MAAM,cAAc,CAAC,CAAC,SAAS,MAAM,IAAI;KAC5C,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,SAAS,MAAM,GAAG,KAAK,GAAG,QAAQ,CAAC,CAAC,CAAC;CACvD,CAAC,MAAM,CAAC,CAAC,CAAC"}

package/dist/src/types/dictionary/NonNumericKeys.js

@@ -0,0 +1 @@
+export {};

package/dist/src/types/dictionary/NonStringKeys.d.ts

@@ -0,0 +1,15 @@
+import { AnyObject } from "../base-types";
+/**
+ * **NonStringKeys**`<T>`
+ *
+ * Builds a union type of the keys of `T` which are _not_
+ * _string_ keys. This can be useful as _symbols_ can also
+ * be seen as valid keys and these keys are often used for
+ * "identity" purposes.
+ *
+ * **Related:** `StringKeys`
+ */
+export type NonStringKeys<T extends AnyObject> = {
+    [K in keyof T]: K extends string ? never : Readonly<K>;
+}[keyof T];
+//# sourceMappingURL=NonStringKeys.d.ts.map

package/dist/src/types/dictionary/NonStringKeys.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"NonStringKeys.d.ts","sourceRoot":"","sources":["../../../../src/types/dictionary/NonStringKeys.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AAE1C;;;;;;;;;GASG;AACH,MAAM,MAAM,aAAa,CAAC,CAAC,SAAS,SAAS,IAAI;KAC9C,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,SAAS,MAAM,GAAG,KAAK,GAAG,QAAQ,CAAC,CAAC,CAAC;CACvD,CAAC,MAAM,CAAC,CAAC,CAAC"}

package/dist/src/types/dictionary/NonStringKeys.js

@@ -0,0 +1 @@
+export {};

package/dist/src/types/dictionary/OptionalKeys.d.ts

@@ -0,0 +1,11 @@
+/**
+ * **OptionalKeys**`<T>`
+ *
+ * Extracts the _optional_ keys in the object's type.
+ */
+export type OptionalKeys<T extends object> = {
+    [K in keyof T]-?: {} extends {
+        [P in K]: T[K];
+    } ? K : never;
+}[keyof T];
+//# sourceMappingURL=OptionalKeys.d.ts.map

package/dist/src/types/dictionary/OptionalKeys.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"OptionalKeys.d.ts","sourceRoot":"","sources":["../../../../src/types/dictionary/OptionalKeys.ts"],"names":[],"mappings":"AACA;;;;GAIG;AACH,MAAM,MAAM,YAAY,CAAC,CAAC,SAAS,MAAM,IAAI;KAC1C,CAAC,IAAI,MAAM,CAAC,CAAC,CAAC,GAAG,EAAE,SAAS;SAAG,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;KAAE,GAC3C,CAAC,GACD,KAAK;CACV,CAAC,MAAM,CAAC,CAAC,CAAC"}

package/dist/src/types/dictionary/OptionalKeys.js

@@ -0,0 +1 @@
+export {};

package/dist/src/types/dictionary/OptionalProps.d.ts

@@ -0,0 +1,8 @@
+import { OptionalKeys } from "..";
+/**
+ * **OptionalProps**
+ *
+ * Reduces an object to only key/value pairs where the key is optional
+ */
+export type OptionalProps<T extends object> = Pick<T, OptionalKeys<T>>;
+//# sourceMappingURL=OptionalProps.d.ts.map

package/dist/src/types/dictionary/OptionalProps.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"OptionalProps.d.ts","sourceRoot":"","sources":["../../../../src/types/dictionary/OptionalProps.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,IAAI,CAAC;AAElC;;;;GAIG;AACH,MAAM,MAAM,aAAa,CAAC,CAAC,SAAS,MAAM,IAAI,IAAI,CAAC,CAAC,EAAE,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC"}

package/dist/src/types/dictionary/OptionalProps.js

@@ -0,0 +1 @@
+export {};