inferred-types 0.42.0 → 0.43.0

package/dist/runtime/runtime-types/kind.js

@@ -1,108 +0,0 @@
-import { asArray, ifLength, ifUndefined, isTrue, toCamelCase } from "../index.js";
-const t = (token) => {
-    return token;
-};
-/**
- * encodes all CSV values to ensure that the `,` character is
- * replaced with `,` placeholder
- */
-export function encodeCsvValue(input) {
-    return input.replace(/\,/g, ",");
-}
-/**
- * decodes all CSV values to ensure that the `,` placeholder
- * value is converted back to an actual `,` character
- */
-export function decodeCsvValue(input) {
-    return input.replace(/,/g, ",");
-}
-/**
- * **kind**
- *
- * An API surface for creating a `TypeToken` for the runtime and the represented _type_
- * to the type system.
- *
- * ### Example
- * ```ts
- * const val: string = kind.string(); // type system sees a string
- * if (isTypeToken(val)) {
- *    // this type guard will PASS and transform the type
- *    // of `val` to it's actual runtime value of `<<string>>`
- * }
- * ```
- */
-export const kind = {
-    /**
-     * **string**(_literals_)
-     *
-     * create a wide `string` type or add parameters to create a string literal
-     * or a union of string literals.
-     */
-    string(...literals) {
-        return ifLength(asArray(literals), 0, () => t("<<string>>"), () => t(`<<stringLiteral:${literals.map(encodeCsvValue).join(",")}>>`));
-    },
-    /**
-     * **number**(_literals_)
-     *
-     * create a token for a wide `number` type or add parameters to create a
-     * numeric literal or union of numeric literals.
-     */
-    number(...literals) {
-        return ifLength(asArray(literals), 0, () => t("<<number>>"), () => t(`<<numericLiteral:${literals.join(",")}>>`));
-    },
-    /**
-     * **numericString**()
-     *
-     * create a token for a numeric value wrapped as a string literal (`${number}`)
-     */
-    numericString() { return t("<<numericString>>"); },
-    /**
-     * call with no params for wide `boolean` type, add `true` or `false` as param
-     * to narrow.
-     */
-    boolean: (literal = undefined) => ifUndefined(literal, () => t("<<boolean>>"), () => (isTrue(literal)
-        ? t("<<true>>")
-        : t("<<false>>"))),
-    /**
-     * **booleanString**()
-     *
-     * create a token for a boolean value wrapped as a string literal (`${boolean}`)
-     */
-    booleanString() { return t("<<booleanString>>"); },
-    /**
-     * returns a type of `AnyObject`
-     */
-    object() { return t("<<object>>"); },
-    objectLiteral(obj) { t(`<<objectLiteral:${JSON.stringify(obj)}>>`); },
-    emptyObject() { return t("<<emptyObject>>"); },
-    function: () => t("<<function>>"),
-    array: () => t("<<array>>"),
-    tuple(...tuple) {
-        return t(`<<tuple:${JSON.stringify(tuple)}>>`);
-    },
-    /**
-     * returns the _undefined_ type
-     */
-    undefined() { t("<<undefined>>"); },
-    null: () => "<null>",
-    literal: (...literals) => literals,
-    union: (...union) => `union:${union.join(",")}`,
-    explicitType: (typeName) => t(`<<explicitType:${typeName}>>`),
-    timeInMinutes: (time) => t(`<<timeInMinutes:${time}>>`),
-    /**
-     * a string type that _starts with_ an explicit string literal
-     */
-    startsWith: (startWith) => t(`<<startsWith:${startWith}>>`),
-    /**
-     * a string type that _ends with_ an explicit string literal
-     */
-    endsWith: (endWith) => t(`<<endsWith:${endWith}>>`),
-    // TODO: rethink types like camelCase which cannot be statically typed
-    // but instead require a type utility for verification
-    /**
-     * a string literal which conforms to the `camelCase` capitalization convention
-     */
-    camelCase(v) {
-        return t(`<<camelCase:${toCamelCase(v)}>>`);
-    },
-};

package/dist/runtime/runtime-types/typeTuples.d.ts

@@ -1,11 +0,0 @@
-import { AlphaChar } from "../../types/index";
-/**
- * **typeTuples**
- *
- * A dictionary of `TypeTuple` definitions
- */
-export declare const typeTuples: {
-    readonly digit: import("../../types/index").TypeTuple<0 | 1 | 2 | 5 | 4 | 3 | 8 | 6 | 7 | 9, "A numeric digit (aka, 0-9)">;
-    readonly alpha: import("../../types/index").TypeTuple<AlphaChar, "A alpha (upper or lowercase)">;
-};
-//# sourceMappingURL=typeTuples.d.ts.map

package/dist/runtime/runtime-types/typeTuples.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"typeTuples.d.ts","sourceRoot":"","sources":["../../../src/runtime/runtime-types/typeTuples.ts"],"names":[],"mappings":"AAEA,OAAO,EAAG,SAAS,EAAW,0BAAwB;AAqCtD;;;;GAIG;AACH,eAAO,MAAM,UAAU;;;CAKb,CAAC"}

package/dist/runtime/runtime-types/typeTuples.js

@@ -1,34 +0,0 @@
-/* eslint-disable @typescript-eslint/no-explicit-any */
-import { ALPHA_CHARS } from "../../constants/index.js";
-import { createTypeTuple, kind } from "../index.js";
-const digit = createTypeTuple(kind.explicitType("Digit"), (val) => {
-    return typeof val === "string" && ["0", "1", "2", "3", "4", "5", "6", "7", "8", "9"].includes(val);
-}, "A numeric digit (aka, 0-9)");
-const alpha = createTypeTuple(kind.explicitType("AlphaChar"), (val) => {
-    return typeof val === "string" && ALPHA_CHARS.includes(val);
-}, "A alpha (upper or lowercase)");
-// const alphaLowercase = createTypeTuple(
-//   runtimeType.explicitType<Join<LowerAlphaChar[]>>(),
-//   <T>(val: T): val is T & Lowercase<T> => {
-//     return typeof val === "string" && split(val).every(i => LOWER_ALPHA_CHARS.includes(i as LowerAlphaChar));
-//   },
-//   "A string with lowercase alphabetic characters"
-// );
-// const alphaUppercase = createTypeTuple(
-//   runtimeType.explicitType<Join<UpperAlphaChar[]>>(),
-//   <T>(val: T): val is T & Join<UpperAlphaChar[]> => {
-//     return typeof val === "string" && split(val).every(i => LOWER_ALPHA_CHARS.includes(i as any));
-//   },
-//   "A string with uppercase alphabetic characters"
-// );
-/**
- * **typeTuples**
- *
- * A dictionary of `TypeTuple` definitions
- */
-export const typeTuples = {
-    digit,
-    alpha,
-    // alphaLowercase,
-    // alphaUppercase
-};

package/dist/runtime/runtime-types/valueTypes.d.ts

@@ -1,28 +0,0 @@
-import { AnyFunction, Narrowable } from "../../types/index";
-export type ValueTuple = [type: unknown, narrowable: boolean];
-/**
- * An API surface for choosing a **type** which is defined for run-time
- * use but is translatable to the type system as well.
- */
-export type ValueTypes = {
-    string: [string, false];
-    boolean: [];
-};
-export declare const valueTypes: {
-    string: [string, false];
-    boolean: [boolean, false];
-    number: [number, false];
-    function: [AnyFunction, false];
-    object: [Record<string, unknown>, false];
-    array: <T>(arr?: T[]) => [T[], false];
-    null: [null, false];
-    symbol: [symbol, false];
-    undefined: [undefined, false];
-    true: [true, true];
-    false: [false, true];
-    /** pass in a literal type */
-    literal: <N extends Narrowable, T_1 extends string | number | boolean | symbol | Record<PropertyKey, N> | null | undefined>(v: T_1) => [T_1, true];
-    literalArray: <N_1 extends Narrowable, T_2 extends string | number | boolean | symbol | Record<PropertyKey, N_1> | null | undefined>(arr: T_2[]) => (boolean | T_2[])[];
-};
-export type ValueTypeFunc<N extends Narrowable, T extends Record<PropertyKey, N> | number | string | boolean | symbol | null | AnyFunction> = (v: ValueTypes) => [T, boolean];
-//# sourceMappingURL=valueTypes.d.ts.map

package/dist/runtime/runtime-types/valueTypes.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"valueTypes.d.ts","sourceRoot":"","sources":["../../../src/runtime/runtime-types/valueTypes.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,UAAU,EAAE,0BAAwB;AAE1D,MAAM,MAAM,UAAU,GAAG,CAAC,IAAI,EAAE,OAAO,EAAE,UAAU,EAAE,OAAO,CAAC,CAAC;AAE9D;;;GAGG;AACH,MAAM,MAAM,UAAU,GAAG;IACvB,MAAM,EAAE,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;IACxB,OAAO,EAAE,EAAE,CAAC;CACb,CAAC;AAEF,eAAO,MAAM,UAAU;;;;;;;;;;;;IAcrB,6BAA6B;;;CAe9B,CAAC;AAEF,MAAM,MAAM,aAAa,CACvB,CAAC,SAAS,UAAU,EACpB,CAAC,SAAS,MAAM,CAAC,WAAW,EAAE,CAAC,CAAC,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,MAAM,GAAG,IAAI,GAAG,WAAW,IACxF,CAAC,CAAC,EAAE,UAAU,KAAK,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC"}

package/dist/runtime/runtime-types/valueTypes.js

@@ -1,20 +0,0 @@
-export const valueTypes = {
-    // WIDE
-    string: ["", false],
-    boolean: [true, false],
-    number: [0, false],
-    function: [(() => ""), false],
-    object: [{}, false],
-    array: (arr = []) => [arr, false],
-    null: [null, false],
-    symbol: [Symbol("type"), false],
-    undefined: [undefined, false],
-    // NARROW
-    true: [true, true],
-    false: [false, true],
-    /** pass in a literal type */
-    literal: (v) => {
-        return [v, true];
-    },
-    literalArray: (arr) => [arr, true],
-};

package/dist/runtime/state/Configurator.d.ts

@@ -1,39 +0,0 @@
-import { ExpandRecursively } from "../../types/index";
-type Omit<T, K extends keyof T> = Pick<T, Exclude<keyof T, K>>;
-export interface IConfigurator<C = {}> {
-    set<V, K extends string, KV = {
-        [U in K]: V;
-    }>(key: K, value: V): asserts this is IConfigurator<ExpandRecursively<C & KV>>;
-    remove<K extends string & keyof C>(key: K): asserts this is IConfigurator<ExpandRecursively<Omit<C, K>>>;
-    done(): C;
-}
-/**
- * **Configurator**
- *
- * This function provides a configurator which uses TypeScript assertions
- * to narrow the scope of variables. Using type assertions though means we
- * can't also return values and therefore a _fluent_ API style is not possible.
- *
- * Note: this approach does require, that you explicitly use the `IConfigurator`
- * interface exported by this library. Without it you'd getting annoying TS errors
- * on every call to `set()` but adding it is simple enough:
- *
- * ```ts
- * import { Configurator, IConfigurator } from "inferred-types";
- * const config: IConfigurator = Configurator();
- * ```
- *
- * If you want to specify some guideline params which you expect to be set, you
- * can add them like so:
- *
- * ```ts
- * export type IExpected = { foo: number, bar: string };
- * const config: IConfigurator<IExpected> = Configurator<IExpected>();
- * ```
- *
- * This configuration will ensure that `foo` and `bar` will be seen as optional
- * parameters. If you set them they will stop being optional.
- */
-export declare function Configurator(): IConfigurator<{}>;
-export {};
-//# sourceMappingURL=Configurator.d.ts.map

package/dist/runtime/state/Configurator.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"Configurator.d.ts","sourceRoot":"","sources":["../../../src/runtime/state/Configurator.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,iBAAiB,EAAE,0BAAwB;AAEpD,KAAK,IAAI,CAAC,CAAC,EAAE,CAAC,SAAS,MAAM,CAAC,IAAI,IAAI,CAAC,CAAC,EAAE,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;AAS/D,MAAM,WAAW,aAAa,CAAC,CAAC,GAAG,EAAE;IACnC,GAAG,CAAC,CAAC,EAAE,CAAC,SAAS,MAAM,EAAE,EAAE,GAAG;SAAG,CAAC,IAAI,CAAC,GAAG,CAAC;KAAE,EAC3C,GAAG,EAAE,CAAC,EACN,KAAK,EAAE,CAAC,GACP,OAAO,CAAC,IAAI,IAAI,aAAa,CAAC,iBAAiB,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC;IAC5D,MAAM,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM,CAAC,EAC/B,GAAG,EAAE,CAAC,GACL,OAAO,CAAC,IAAI,IAAI,aAAa,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;IAChE,IAAI,IAAI,CAAC,CAAC;CACX;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,wBAAgB,YAAY,sBA0B3B"}

package/dist/runtime/state/Configurator.js

@@ -1,55 +0,0 @@
-function omit(obj, ...removals) {
-    const untyped = removals;
-    return Object.fromEntries(Object.entries(obj).filter(([key]) => !untyped.includes(key)));
-}
-/**
- * **Configurator**
- *
- * This function provides a configurator which uses TypeScript assertions
- * to narrow the scope of variables. Using type assertions though means we
- * can't also return values and therefore a _fluent_ API style is not possible.
- *
- * Note: this approach does require, that you explicitly use the `IConfigurator`
- * interface exported by this library. Without it you'd getting annoying TS errors
- * on every call to `set()` but adding it is simple enough:
- *
- * ```ts
- * import { Configurator, IConfigurator } from "inferred-types";
- * const config: IConfigurator = Configurator();
- * ```
- *
- * If you want to specify some guideline params which you expect to be set, you
- * can add them like so:
- *
- * ```ts
- * export type IExpected = { foo: number, bar: string };
- * const config: IConfigurator<IExpected> = Configurator<IExpected>();
- * ```
- *
- * This configuration will ensure that `foo` and `bar` will be seen as optional
- * parameters. If you set them they will stop being optional.
- */
-export function Configurator() {
-    let configuration = () => ({});
-    const api = () => {
-        return {
-            set(key, value) {
-                const keyValue = { [key]: value };
-                const config = configuration();
-                const updated = { ...config, ...keyValue };
-                configuration = () => updated;
-                return updated;
-            },
-            remove(key) {
-                const config = configuration();
-                const updated = omit(config, key);
-                configuration = () => updated;
-                return updated;
-            },
-            done() {
-                return configuration();
-            },
-        };
-    };
-    return api();
-}

package/dist/runtime/state/FluentConfigurator.d.ts

@@ -1,28 +0,0 @@
-import { ExpandRecursively } from "../../types/index";
-export interface IFluentConfigurator<C> {
-    /**
-     * **set**
-     *
-     * Sets a new key/value pair to the configurator.
-     *
-     * @param key the key to put this new configuration item
-     * @param value the value of the configuration item
-     */
-    set<V, K extends string, KV = {
-        [U in K]: V;
-    }>(key: K, value: V): IFluentConfigurator<C & KV>;
-    done(): ExpandRecursively<C>;
-}
-/**
- * This function will return a basic _configurator_ API surface which allows
- * you to add name/value pairs to a growing dictionary of strongly typed data.
- *
- * When configuration is complete, you call the `done()` endpoint and the typed
- * configuration will be returned with the API removed.
- *
- * > **Note:** the approach taken here requires that you configure using a **fluent style**
- * exclusively. If you don't the non-fluent properties set will not show up
- * in the typing or the run-time object.
- */
-export declare function FluentConfigurator<I>(initial?: I): IFluentConfigurator<{}>;
-//# sourceMappingURL=FluentConfigurator.d.ts.map

package/dist/runtime/state/FluentConfigurator.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"FluentConfigurator.d.ts","sourceRoot":"","sources":["../../../src/runtime/state/FluentConfigurator.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,0BAAwB;AAEpD,MAAM,WAAW,mBAAmB,CAAC,CAAC;IACpC;;;;;;;OAOG;IACH,GAAG,CAAC,CAAC,EAAE,CAAC,SAAS,MAAM,EAAE,EAAE,GAAG;SAAG,CAAC,IAAI,CAAC,GAAG,CAAC;KAAE,EAAE,GAAG,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG,mBAAmB,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC;IAC9F,IAAI,IAAI,iBAAiB,CAAC,CAAC,CAAC,CAAC;CAC9B;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,kBAAkB,CAAC,CAAC,EAAE,OAAO,GAAE,CAAW,2BAsBzD"}

package/dist/runtime/state/FluentConfigurator.js

@@ -1,29 +0,0 @@
-/**
- * This function will return a basic _configurator_ API surface which allows
- * you to add name/value pairs to a growing dictionary of strongly typed data.
- *
- * When configuration is complete, you call the `done()` endpoint and the typed
- * configuration will be returned with the API removed.
- *
- * > **Note:** the approach taken here requires that you configure using a **fluent style**
- * exclusively. If you don't the non-fluent properties set will not show up
- * in the typing or the run-time object.
- */
-export function FluentConfigurator(initial = {}) {
-    const api = (current) => {
-        return {
-            set(key, value) {
-                const keyValue = { [key]: value };
-                const updated = { ...keyValue, ...current };
-                return api(updated);
-            },
-            done() {
-                return current;
-            },
-        };
-    };
-    if (initial && typeof initial !== "object") {
-        throw new Error("The FluentConfigurator was passed a non-object based value as the initial value. This is not allowed.");
-    }
-    return initial ? api(initial) : api({});
-}

package/dist/runtime/state/index.d.ts

@@ -1,3 +0,0 @@
-export * from "./Configurator";
-export * from "./FluentConfigurator";
-//# sourceMappingURL=index.d.ts.map

package/dist/runtime/state/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/runtime/state/index.ts"],"names":[],"mappings":"AAMA,cAAc,gBAAgB,CAAC;AAC/B,cAAc,sBAAsB,CAAC"}

package/dist/runtime/state/index.js

@@ -1,10 +0,0 @@
-// #autoindex
-// #region auto-indexed files
-// index last changed at: 8th Aug, 2022, 09:51 AM ( GMT-7 )
-// hash-code: 397c607b
-// file exports
-export * from "./Configurator.js";
-export * from "./FluentConfigurator.js";
-// #endregion auto-indexed files
-// see https://github.com/inocan-group/do-devops/docs/autoindex.md
-// for more info

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

@@ -1,46 +0,0 @@
-import { Type, TypeDefaultValue, TypeDefn, TypeHasDefaultValue, TypeIsRequired, TypeKind, TypeKindContainerNarrow, TypeKindContainerWide, TypeKindFalsy, TypeKindLiteral, TypeKindWide } from "../../types/index";
-/**
- * **isTypeDefn**()
- *
- * A type guard that validates the passed in variable is some sort of
- * `TypeDefn<T>` type.
- */
-export declare function isTypeDefn<TKind extends TypeKind, TRequired extends boolean, TDesc extends string = string, TUnderlying extends readonly unknown[] | "no-underlying" = "no-underlying", TDefaultValue extends TypeDefaultValue<TKind, TRequired, TUnderlying> = TypeDefaultValue<TKind, TRequired, TUnderlying>, TValidations extends readonly unknown[] | "no-validations" = readonly unknown[] | "no-validations", TD extends TypeDefn<TKind, TRequired, TDesc, TUnderlying, TDefaultValue, TValidations> = TypeDefn<TKind, TRequired, TDesc, TUnderlying, TDefaultValue, TValidations>>(thing: unknown | TD): thing is TD;
-/**
- * **isRuntimeType**(thing)
- *
- * A type guard which identifies if the value passed in is a `Type` type definition.
- */
-export declare function isRuntimeType<U extends Type>(thing: unknown | U): thing is U;
-export declare function isObjectType<U extends Type<"object", TypeIsRequired, string>>(thing: unknown): thing is U;
-export declare function isIntersectionType<U extends Type<"intersection", TypeIsRequired, string, readonly Type[]>>(thing: unknown | U): thing is U;
-export declare function isUnionType<U extends Type<"union", TypeIsRequired, string, readonly Type[]>>(thing: unknown | U): thing is U;
-export declare function isTupleType<U extends Type<"tuple", TypeIsRequired, string, readonly Type[]>>(thing: unknown | U): thing is U;
-/** Type Guard to validate that type is a "wide type" (e.g., string, number, boolean) */
-export declare function isWideType<TKind extends TypeKindWide, TRequired extends TypeIsRequired, TUnderlying extends readonly any[] | readonly [], TDesc extends string, U extends Type<TKind, TRequired, TDesc, TUnderlying>>(thing: unknown | U): thing is U;
-/** Type Guard to validate that type is a "falsy type" (e.g., undefined, null) */
-export declare function isFalsyType<TKind extends TypeKindFalsy, TRequired extends TypeIsRequired, TDesc extends string, TUnderlying extends readonly any[] | readonly [], U extends Type<TKind, TRequired, TDesc, TUnderlying>>(thing: unknown | U): thing is U;
-/**
- * **isLiteralType**(t)
- *
- * Type Guard to validate that runtime type is a "literal type"
- * (e.g., string literal, numeric literal, boolean literal, true,
- * false, etc.)
- */
-export declare function isLiteralType<TKind extends TypeKindLiteral, TRequired extends TypeIsRequired, TDesc extends string, TUnderlying extends readonly unknown[] | readonly [], TDefault extends TypeHasDefaultValue, U extends Type<TKind, TRequired, TDesc, TUnderlying, TDefault>>(thing: unknown | U): thing is U;
-export declare function isStringLiteralType<U extends Type<"stringLiteral", TypeIsRequired, string, readonly string[]>>(thing: unknown | U): thing is U;
-/**
- * Type Guard to validate that type is a "narrow container" (e.g., object, tuple, etc.)
- */
-export declare function isNarrowContainer<TKind extends TypeKindContainerNarrow, TRequired extends TypeIsRequired, TDesc extends string, TUnderlying extends readonly unknown[] | readonly [], TDefault extends TypeHasDefaultValue, U extends Type<TKind, TRequired, TDesc, TUnderlying, TDefault>>(thing: unknown | U): thing is U;
-/**
- * Type Guard to validate that runtime type has _underlying_ aspects
- * which are being used to define it's type.
- */
-export declare function hasUnderlyingTypes<TKind extends TypeKindContainerNarrow | TypeKindLiteral, TRequired extends TypeIsRequired, TDesc extends string, TUnderlying extends readonly unknown[] | readonly [], TDefault extends TypeHasDefaultValue, U extends Type<TKind, TRequired, TDesc, TUnderlying, TDefault>>(thing: unknown | U): thing is U;
-/**
- * Type Guard to validate that runtime type has _underlying_ aspects
- * which are being used to define it's type.
- */
-export declare function hasNoUnderlyingTypes<TKind extends TypeKindWide | TypeKindFalsy | TypeKindContainerWide, TRequired extends TypeIsRequired, TDesc extends string, TUnderlying extends readonly unknown[] | readonly [], TDefault extends TypeHasDefaultValue, U extends Type<TKind, TRequired, TDesc, TUnderlying, TDefault>>(thing: unknown | U): thing is U;
-//# sourceMappingURL=runtime-type-guards.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"runtime-type-guards.d.ts","sourceRoot":"","sources":["../../../src/runtime/type-guards/runtime-type-guards.ts"],"names":[],"mappings":"AAEA,OAAO,EAEL,IAAI,EACJ,gBAAgB,EAChB,QAAQ,EACR,mBAAmB,EACnB,cAAc,EACd,QAAQ,EACR,uBAAuB,EACvB,qBAAqB,EACrB,aAAa,EACb,eAAe,EACf,YAAY,EACb,0BAAwB;AASzB;;;;;GAKG;AACH,wBAAgB,UAAU,CACxB,KAAK,SAAS,QAAQ,EACtB,SAAS,SAAS,OAAO,EACzB,KAAK,SAAS,MAAM,GAAG,MAAM,EAC7B,WAAW,SAAS,SAAS,OAAO,EAAE,GAAG,eAAe,GAAG,eAAe,EAC1E,aAAa,SAAS,gBAAgB,CAAC,KAAK,EAAE,SAAS,EAAE,WAAW,CAAC,GAAG,gBAAgB,CAAC,KAAK,EAAE,SAAS,EAAE,WAAW,CAAC,EACvH,YAAY,SAAS,SAAS,OAAO,EAAE,GAAG,gBAAgB,GAAG,SAAS,OAAO,EAAE,GAAG,gBAAgB,EAClG,EAAE,SAAS,QAAQ,CAAC,KAAK,EAAE,SAAS,EAAE,KAAK,EAAE,WAAW,EAAE,aAAa,EAAE,YAAY,CAAC,GAAG,QAAQ,CAAC,KAAK,EAAE,SAAS,EAAE,KAAK,EAAG,WAAW,EAAE,aAAa,EAAE,YAAY,CAAC,EACrK,KAAK,EAAE,OAAO,GAAG,EAAE,GAAG,KAAK,IAAI,EAAE,CAMlC;AAED;;;;GAIG;AACH,wBAAgB,aAAa,CAC3B,CAAC,SAAS,IAAI,EACd,KAAK,EAAE,OAAO,GAAG,CAAC,GAAG,KAAK,IAAI,CAAC,CAIhC;AAED,wBAAgB,YAAY,CAC1B,CAAC,SAAS,IAAI,CAAC,QAAQ,EAAE,cAAc,EAAE,MAAM,CAAC,EAChD,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,CAAC,CAM5B;AAED,wBAAgB,kBAAkB,CAChC,CAAC,SAAS,IAAI,CAAC,cAAc,EAAE,cAAc,EAAE,MAAM,EAAE,SAAS,IAAI,EAAE,CAAC,EACvE,KAAK,EAAE,OAAO,GAAG,CAAC,GAAG,KAAK,IAAI,CAAC,CAEhC;AAED,wBAAgB,WAAW,CACzB,CAAC,SAAS,IAAI,CAAC,OAAO,EAAE,cAAc,EAAE,MAAM,EAAE,SAAS,IAAI,EAAE,CAAC,EAChE,KAAK,EAAE,OAAO,GAAG,CAAC,GAAG,KAAK,IAAI,CAAC,CAEhC;AAED,wBAAgB,WAAW,CACzB,CAAC,SAAS,IAAI,CAAC,OAAO,EAAE,cAAc,EAAE,MAAM,EAAE,SAAS,IAAI,EAAE,CAAC,EAChE,KAAK,EAAE,OAAO,GAAG,CAAC,GAAG,KAAK,IAAI,CAAC,CAEhC;AAED,wFAAwF;AACxF,wBAAgB,UAAU,CACxB,KAAK,SAAS,YAAY,EAC1B,SAAS,SAAS,cAAc,EAChC,WAAW,SAAS,SAAS,GAAG,EAAE,GAAG,SAAS,EAAE,EAChD,KAAK,SAAS,MAAM,EACpB,CAAC,SAAS,IAAI,CACZ,KAAK,EAAE,SAAS,EAAE,KAAK,EAAE,WAAW,CACrC,EACD,KAAK,EAAE,OAAO,GAAG,CAAC,GAAG,KAAK,IAAI,CAAC,CAEhC;AAED,iFAAiF;AACjF,wBAAgB,WAAW,CACzB,KAAK,SAAS,aAAa,EAC3B,SAAS,SAAS,cAAc,EAChC,KAAK,SAAS,MAAM,EACpB,WAAW,SAAS,SAAS,GAAG,EAAE,GAAG,SAAS,EAAE,EAChD,CAAC,SAAS,IAAI,CACZ,KAAK,EAAE,SAAS,EAAE,KAAK,EAAE,WAAW,CACrC,EACD,KAAK,EAAE,OAAO,GAAG,CAAC,GAAG,KAAK,IAAI,CAAC,CAEhC;AAED;;;;;;GAMG;AACH,wBAAgB,aAAa,CAC3B,KAAK,SAAS,eAAe,EAC7B,SAAS,SAAS,cAAc,EAChC,KAAK,SAAS,MAAM,EACpB,WAAW,SAAS,SAAS,OAAO,EAAE,GAAG,SAAS,EAAE,EACpD,QAAQ,SAAS,mBAAmB,EACpC,CAAC,SAAS,IAAI,CACZ,KAAK,EAAE,SAAS,EAAE,KAAK,EAAE,WAAW,EAAE,QAAQ,CAC/C,EACD,KAAK,EAAE,OAAO,GAAG,CAAC,GAAG,KAAK,IAAI,CAAC,CAEhC;AAED,wBAAgB,mBAAmB,CACjC,CAAC,SAAS,IAAI,CAAC,eAAe,EAAE,cAAc,EAAE,MAAM,EAAE,SAAS,MAAM,EAAE,CAAC,EAC1E,KAAK,EAAE,OAAO,GAAG,CAAC,GAAG,KAAK,IAAI,CAAC,CAIhC;AAED;;GAEG;AACH,wBAAgB,iBAAiB,CAC/B,KAAK,SAAS,uBAAuB,EACrC,SAAS,SAAS,cAAc,EAChC,KAAK,SAAS,MAAM,EACpB,WAAW,SAAS,SAAS,OAAO,EAAE,GAAG,SAAS,EAAE,EACpD,QAAQ,SAAS,mBAAmB,EACpC,CAAC,SAAS,IAAI,CACZ,KAAK,EAAE,SAAS,EAAG,KAAK,EAAG,WAAW,EAAG,QAAQ,CAClD,EACD,KAAK,EAAE,OAAO,GAAG,CAAC,GAAG,KAAK,IAAI,CAAC,CAEhC;AAED;;;GAGG;AACH,wBAAgB,kBAAkB,CAChC,KAAK,SAAS,uBAAuB,GAAG,eAAe,EACvD,SAAS,SAAS,cAAc,EAChC,KAAK,SAAS,MAAM,EACpB,WAAW,SAAS,SAAS,OAAO,EAAE,GAAG,SAAS,EAAE,EACpD,QAAQ,SAAS,mBAAmB,EACpC,CAAC,SAAS,IAAI,CACZ,KAAK,EAAE,SAAS,EAAG,KAAK,EAAG,WAAW,EAAG,QAAQ,CAClD,EACD,KAAK,EAAE,OAAO,GAAG,CAAC,GAAG,KAAK,IAAI,CAAC,CAEhC;AAED;;;GAGG;AACH,wBAAgB,oBAAoB,CAClC,KAAK,SAAS,YAAY,GAAG,aAAa,GAAG,qBAAqB,EAClE,SAAS,SAAS,cAAc,EAChC,KAAK,SAAS,MAAM,EACpB,WAAW,SAAS,SAAS,OAAO,EAAE,GAAG,SAAS,EAAE,EACpD,QAAQ,SAAS,mBAAmB,EACpC,CAAC,SAAS,IAAI,CACZ,KAAK,EAAE,SAAS,EAAG,KAAK,EAAG,WAAW,EAAG,QAAQ,CAClD,EACD,KAAK,EAAE,OAAO,GAAG,CAAC,GAAG,KAAK,IAAI,CAAC,CAEhC"}

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

@@ -1,76 +0,0 @@
-/* eslint-disable @typescript-eslint/no-explicit-any */
-import { FALSY_TYPE_KINDS, LITERAL_TYPE_KINDS, WIDE_TYPE_KINDS, } from "../../constants/index.js";
-/**
- * **isTypeDefn**()
- *
- * A type guard that validates the passed in variable is some sort of
- * `TypeDefn<T>` type.
- */
-export function isTypeDefn(thing) {
-    return (typeof thing === "object" && "kind" in thing && typeof thing.isRequired === "boolean")
-        ? true
-        : false;
-}
-/**
- * **isRuntimeType**(thing)
- *
- * A type guard which identifies if the value passed in is a `Type` type definition.
- */
-export function isRuntimeType(thing) {
-    return (typeof thing === "object" && "_type" in thing && thing._type === "Type");
-}
-export function isObjectType(thing) {
-    return (isRuntimeType(thing) &&
-        thing.kind === "object" &&
-        Array.isArray(thing.underlying));
-}
-export function isIntersectionType(thing) {
-    return isRuntimeType(thing) && thing.kind === "intersection";
-}
-export function isUnionType(thing) {
-    return isRuntimeType(thing) && thing.kind === "union";
-}
-export function isTupleType(thing) {
-    return isRuntimeType(thing) && thing.kind === "union";
-}
-/** Type Guard to validate that type is a "wide type" (e.g., string, number, boolean) */
-export function isWideType(thing) {
-    return isRuntimeType(thing) && WIDE_TYPE_KINDS.includes(thing.kind);
-}
-/** Type Guard to validate that type is a "falsy type" (e.g., undefined, null) */
-export function isFalsyType(thing) {
-    return isRuntimeType(thing) && FALSY_TYPE_KINDS.includes(thing.kind);
-}
-/**
- * **isLiteralType**(t)
- *
- * Type Guard to validate that runtime type is a "literal type"
- * (e.g., string literal, numeric literal, boolean literal, true,
- * false, etc.)
- */
-export function isLiteralType(thing) {
-    return isRuntimeType(thing) && LITERAL_TYPE_KINDS.includes(thing.kind) && Array.isArray(thing.underlying);
-}
-export function isStringLiteralType(thing) {
-    return (isRuntimeType(thing) && thing.kind === "stringLiteral");
-}
-/**
- * Type Guard to validate that type is a "narrow container" (e.g., object, tuple, etc.)
- */
-export function isNarrowContainer(thing) {
-    return isRuntimeType(thing) && LITERAL_TYPE_KINDS.includes(thing.kind);
-}
-/**
- * Type Guard to validate that runtime type has _underlying_ aspects
- * which are being used to define it's type.
- */
-export function hasUnderlyingTypes(thing) {
-    return isRuntimeType(thing) && Array.isArray(thing.underlying);
-}
-/**
- * Type Guard to validate that runtime type has _underlying_ aspects
- * which are being used to define it's type.
- */
-export function hasNoUnderlyingTypes(thing) {
-    return hasUnderlyingTypes(thing) ? false : true;
-}

package/dist/types/base-types/AnyFunction.d.ts

@@ -1,13 +0,0 @@
-import { AnyObject, EmptyObject } from "../index";
-/**
- * **AnyFunction**`<[TArgs],[TReturn],[TDict]>`
- *
- * A type which is meant to match on _all_ types of functions which can exist.
- * This includes basic functions as well as functions which have KeyValue dictionaries
- * in intersection with them.
- *
- * **Note:** _you may optionally limit the types you are matching by using any of of
- * the optional generics provided_
- */
-export type AnyFunction<TArgs extends readonly any[] = any[], TReturn = any, TProps extends AnyObject = AnyObject> = TProps extends EmptyObject ? (...args: TArgs) => TReturn : ((...args: TArgs) => TReturn) & TProps;
-//# sourceMappingURL=AnyFunction.d.ts.map

package/dist/types/base-types/AnyFunction.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"AnyFunction.d.ts","sourceRoot":"","sources":["../../../src/types/base-types/AnyFunction.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,SAAS,EAAE,WAAW,EAAE,iBAAwB;AAEzD;;;;;;;;;GASG;AACH,MAAM,MAAM,WAAW,CACrB,KAAK,SAAS,SAAS,GAAG,EAAE,GAAG,GAAG,EAAE,EACpC,OAAO,GAAG,GAAG,EACb,MAAM,SAAS,SAAS,GAAG,SAAS,IAClC,MAAM,SAAS,WAAW,GAC1B,CAAC,GAAG,IAAI,EAAE,KAAK,KAAK,OAAO,GAC3B,CAAC,CAAC,GAAG,IAAI,EAAE,KAAK,KAAK,OAAO,CAAC,GAAG,MAAM,CAAC"}

package/dist/types/base-types/CouldHaveValue.d.ts

@@ -1,14 +0,0 @@
-import { Something, Nothing } from "../index";
-/**
- * **CouldHaveValue**
- *
- * This is functionally equivalent to the "unknown" type but expressed in a
- * more explicit manner.
- *
- * From this we see that _unknown_ represents both "nothing" or "something":
- *
- * - nothing: aka, `undefined` or `null`
- * - something: aka, `{}`
- */
-export type CouldHaveValue = Something | Nothing;
-//# sourceMappingURL=CouldHaveValue.d.ts.map

package/dist/types/base-types/CouldHaveValue.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"CouldHaveValue.d.ts","sourceRoot":"","sources":["../../../src/types/base-types/CouldHaveValue.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,OAAO,EAAE,iBAAwB;AAErD;;;;;;;;;;GAUG;AACH,MAAM,MAAM,cAAc,GAAG,SAAS,GAAG,OAAO,CAAC"}

package/dist/types/base-types/IdentityFunction.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"IdentityFunction.d.ts","sourceRoot":"","sources":["../../../src/types/base-types/IdentityFunction.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,KAAK,CAAC,CAAC"}

package/dist/types/base-types/IndexedObject.d.ts

@@ -1,3 +0,0 @@
-import { EmptyObject, IndexableObject, Length } from "../index";
-export type IndexedObject<T extends EmptyObject | IndexableObject = EmptyObject | IndexableObject> = T extends EmptyObject ? never : Length<T> extends 0 ? never : T;
-//# sourceMappingURL=IndexedObject.d.ts.map

package/dist/types/base-types/IndexedObject.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"IndexedObject.d.ts","sourceRoot":"","sources":["../../../src/types/base-types/IndexedObject.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAG,eAAe,EAAE,MAAM,EAAE,iBAAwB;AAExE,MAAM,MAAM,aAAa,CACvB,CAAC,SAAS,WAAW,GAAG,eAAe,GAAG,WAAW,GAAG,eAAe,IACrE,CAAC,SAAS,WAAW,GACrB,KAAK,GACL,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC,GACjB,KAAK,GACL,CAAC,CAAC"}

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

@@ -1,10 +0,0 @@
-import { AnyFunction } from "../../index";
-/**
- * **NarrowingFn**`<TParams, TReturn>`
- *
- * Very similar to `BaseFunction` but where the base function's provide narrowing
- * characteristics.
- */
-export type NarrowingFn<TParams extends readonly unknown[] = readonly unknown[], TReturn = unknown> = <AA extends TParams>(...args: AA) => TReturn;
-export type AsNarrowingFn<TFn extends AnyFunction> = TFn extends NarrowingFn ? TFn : <T extends readonly unknown[]>(...args: T & Parameters<TFn>) => ReturnType<TFn>;
-//# sourceMappingURL=NarrowingFn.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"NarrowingFn.d.ts","sourceRoot":"","sources":["../../../../src/types/base-types/fns/NarrowingFn.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,oBAAwB;AAE9C;;;;;GAKG;AACH,MAAM,MAAM,WAAW,CACrB,OAAO,SAAS,SAAS,OAAO,EAAE,GAAG,SAAS,OAAO,EAAE,EACvD,OAAO,GAAG,OAAO,IACf,CAAC,EAAE,SAAS,OAAO,EAAE,GAAG,IAAI,EAAE,EAAE,KAAK,OAAO,CAAC;AAEjD,MAAM,MAAM,aAAa,CACvB,GAAG,SAAS,WAAW,IACrB,GAAG,SAAS,WAAW,GACzB,GAAG,GACH,CAAC,CAAC,SAAS,SAAS,OAAO,EAAE,EAAE,GAAG,IAAI,EAAE,CAAC,GAAG,UAAU,CAAC,GAAG,CAAC,KAAK,UAAU,CAAC,GAAG,CAAC,CAAC"}

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

@@ -1,14 +0,0 @@
-import { And, LogicFunction } from "../../index";
-/**
- * **IfAnd**`<TConditions[], [IF], [ELSE], [TParams]>`
- *
- * Takes an array of _conditions_ and if all of them evaluate to `true`
- * then the `IF` type is returned otherwise the `ELSE` type.
- *
- * - By default, `IF` is **true** and `ELSE` is **false**.
- * - If `TParams` is passed in -- as a tuple of values -- and a function
- * is encountered in the conditions tuple then `TParams` will be used as
- * parameters passed into the function.
- */
-export type IfAnd<TConditions extends readonly (boolean | LogicFunction<TParams>)[], IF = true, ELSE = false, TParams extends readonly unknown[] = readonly unknown[]> = [And<TConditions>] extends [true] ? IF : [And<TConditions>] extends [false] ? ELSE : [And<TConditions>] extends [boolean] ? IF | ELSE : ELSE;
-//# sourceMappingURL=IfAnd.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"IfAnd.d.ts","sourceRoot":"","sources":["../../../../src/types/boolean-logic/branching/IfAnd.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,GAAG,EAAE,aAAa,EAAE,oBAAwB;AAErD;;;;;;;;;;GAUG;AACH,MAAM,MAAM,KAAK,CACf,WAAW,SAAS,SAAS,CAAC,OAAO,GAAG,aAAa,CAAC,OAAO,CAAC,CAAC,EAAE,EACjE,EAAE,GAAG,IAAI,EACT,IAAI,GAAG,KAAK,EACZ,OAAO,SAAS,SAAS,OAAO,EAAE,GAAG,SAAS,OAAO,EAAE,IACrD,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC,SAAS,CAAC,IAAI,CAAC,GACnC,EAAE,GACF,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC,SAAS,CAAC,KAAK,CAAC,GAChC,IAAI,GACJ,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC,SAAS,CAAC,OAAO,CAAC,GAAG,EAAE,GAAG,IAAI,GAAG,IAAI,CAAE"}

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

@@ -1,8 +0,0 @@
-import { IsArray } from "../../index";
-/**
- * **IfArray**`<T, IF, ELSE>`
- *
- * Type utility which convert to type `IF` or `ELSE` based on whether `T` is an array.
- */
-export type IfArray<T, IF = T & unknown[], ELSE = Exclude<T, unknown[]>> = IsArray<T> extends true ? IF : ELSE;
-//# sourceMappingURL=IfArray.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"IfArray.d.ts","sourceRoot":"","sources":["../../../../src/types/boolean-logic/branching/IfArray.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,oBAAwB;AAG1C;;;;GAIG;AACH,MAAM,MAAM,OAAO,CAAC,CAAC,EACnB,EAAE,GAAG,CAAC,GAAG,OAAO,EAAE,EAClB,IAAI,GAAG,OAAO,CAAC,CAAC,EAAE,OAAO,EAAE,CAAC,IAC1B,OAAO,CAAC,CAAC,CAAC,SAAS,IAAI,GAAG,EAAE,GAAG,IAAI,CAAC"}

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

@@ -1,3 +0,0 @@
-import { IsBoolean } from "../../index";
-export type IfBoolean<T, TRUE = T & boolean, FALSE = Exclude<T, boolean>> = IsBoolean<T> extends true ? TRUE : FALSE;
-//# sourceMappingURL=IfBoolean.d.ts.map