inferred-types 0.37.6 → 0.40.2

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

@@ -0,0 +1,8 @@
+import { Scalar } from "src/types";
+/**
+ * **isScalar**(value)
+ *
+ * Type guard to check whether the value passed in is a _scalar_ value.
+ */
+export declare function isScalar<T>(value: T): value is T & Scalar;
+//# sourceMappingURL=isScalar.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"isScalar.d.ts","sourceRoot":"","sources":["../../../../src/runtime/type-guards/isScalar.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,WAAW,CAAC;AAInC;;;;GAIG;AACH,wBAAgB,QAAQ,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG,KAAK,IAAI,CAAC,GAAG,MAAM,CAGzD"}

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

@@ -0,0 +1,9 @@
+import { isNull, isNumber, isString, isSymbol } from "src/runtime";
+/**
+ * **isScalar**(value)
+ *
+ * Type guard to check whether the value passed in is a _scalar_ value.
+ */
+export function isScalar(value) {
+    return isString(value) || isNumber(value) || isSymbol(value) || isNull(value);
+}

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

@@ -0,0 +1,8 @@
+import { Constant } from "src/constants";
+/**
+ * **isSpecificConstant**(kind)
+ *
+ * A higher order type guard which tests for a specific `Constant` type.
+ */
+export declare function isSpecificConstant<TKind extends string>(kind: TKind): (value: unknown) => value is Constant<TKind>;
+//# sourceMappingURL=isSpecificConstant.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"isSpecificConstant.d.ts","sourceRoot":"","sources":["../../../../src/runtime/type-guards/isSpecificConstant.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AAEzC;;;;GAIG;AACH,wBAAgB,kBAAkB,CAChC,KAAK,SAAS,MAAM,EACpB,IAAI,EAAE,KAAK,WACI,OAAO,8BAGvB"}

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

@@ -0,0 +1,11 @@
+import { isEqual, isConstant } from "src/runtime";
+/**
+ * **isSpecificConstant**(kind)
+ *
+ * A higher order type guard which tests for a specific `Constant` type.
+ */
+export function isSpecificConstant(kind) {
+    return (value) => {
+        return isConstant(value) && isEqual(value.kind)(kind) ? true : false;
+    };
+}

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

@@ -0,0 +1,11 @@
+/**
+ * **isString**
+ *
+ * Returns true or false on whether the passed in parameter is a
+ * string (either a wide string or a string literal).
+ *
+ * The boolean return is traceable by the type system as well as the
+ * runtime system.
+ */
+export declare function isString<T>(value: T): value is T & string;
+//# sourceMappingURL=isString.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"isString.d.ts","sourceRoot":"","sources":["../../../../src/runtime/type-guards/isString.ts"],"names":[],"mappings":"AACA;;;;;;;;GAQG;AACH,wBAAgB,QAAQ,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG,KAAK,IAAI,CAAC,GAAG,MAAM,CAEzD"}

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

@@ -0,0 +1,12 @@
+/**
+ * **isString**
+ *
+ * Returns true or false on whether the passed in parameter is a
+ * string (either a wide string or a string literal).
+ *
+ * The boolean return is traceable by the type system as well as the
+ * runtime system.
+ */
+export function isString(value) {
+    return (typeof value === "string");
+}

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

@@ -0,0 +1,8 @@
+/**
+ * **isSymbol**(value)
+ *
+ * Runtime type guard which narrows the passed in type
+ * to being a **symbol** when condition is met.
+ */
+export declare function isSymbol<T>(value: T): value is T & symbol;
+//# sourceMappingURL=isSymbol.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"isSymbol.d.ts","sourceRoot":"","sources":["../../../../src/runtime/type-guards/isSymbol.ts"],"names":[],"mappings":"AACA;;;;;GAKG;AACH,wBAAgB,QAAQ,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG,KAAK,IAAI,CAAC,GAAG,MAAM,CAIzD"}

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

@@ -0,0 +1,9 @@
+/**
+ * **isSymbol**(value)
+ *
+ * Runtime type guard which narrows the passed in type
+ * to being a **symbol** when condition is met.
+ */
+export function isSymbol(value) {
+    return (typeof value === "symbol");
+}

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

@@ -0,0 +1,7 @@
+/**
+ * **isTrue**(value)
+ *
+ * Type guard which detects whether the given value is `true`.
+ */
+export declare function isTrue(value: unknown): value is true;
+//# sourceMappingURL=isTrue.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"isTrue.d.ts","sourceRoot":"","sources":["../../../../src/runtime/type-guards/isTrue.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,wBAAgB,MAAM,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,IAAI,CAEpD"}

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

@@ -0,0 +1,8 @@
+/**
+ * **isTrue**(value)
+ *
+ * Type guard which detects whether the given value is `true`.
+ */
+export function isTrue(value) {
+    return value === true;
+}

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

@@ -0,0 +1,9 @@
+import { FalsyValue } from "src/types";
+/**
+ * **isTruthy**
+ *
+ * Creates a TypeGuard which checks whether a value is considered _truthy_
+ * in Javascript.
+ */
+export declare const isTruthy: <V>(val: V) => val is Exclude<V, FalsyValue>;
+//# sourceMappingURL=isTruthy.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"isTruthy.d.ts","sourceRoot":"","sources":["../../../../src/runtime/type-guards/isTruthy.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,UAAU,EAAE,MAAM,WAAW,CAAC;AAIvC;;;;;GAKG;AACH,eAAO,MAAM,QAAQ,8CAEpB,CAAC"}

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

@@ -0,0 +1,10 @@
+import { FALSY_VALUES } from "src/constants";
+/**
+ * **isTruthy**
+ *
+ * Creates a TypeGuard which checks whether a value is considered _truthy_
+ * in Javascript.
+ */
+export const isTruthy = (val) => {
+    return !FALSY_VALUES.includes(val);
+};

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

@@ -0,0 +1,8 @@
+import { TypeToken } from "src/types";
+/**
+ * **isTypeToken**(val)
+ *
+ * Type guard which checks whether the given value is a valid `TypeToken`
+ */
+export declare function isTypeToken(val: unknown): val is TypeToken;
+//# sourceMappingURL=isTypeToken.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"isTypeToken.d.ts","sourceRoot":"","sources":["../../../../src/runtime/type-guards/isTypeToken.ts"],"names":[],"mappings":"AAAA,OAAO,EAAI,SAAS,EAAE,MAAM,WAAW,CAAC;AAMxC;;;;GAIG;AACH,wBAAgB,WAAW,CAAC,GAAG,EAAE,OAAO,GAAG,GAAG,IAAI,SAAS,CAQ1D"}

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

@@ -0,0 +1,17 @@
+import { endsWith, isString, startsWith, stripLeading, stripTrailing } from "src/runtime";
+import { TYPE_TOKEN_ALL } from "src/constants";
+const validTokens = Array.from(TYPE_TOKEN_ALL);
+/**
+ * **isTypeToken**(val)
+ *
+ * Type guard which checks whether the given value is a valid `TypeToken`
+ */
+export function isTypeToken(val) {
+    if (isString(val) && startsWith("<<")(val) && endsWith(">>")(val)) {
+        const token = stripTrailing(stripLeading(val, "<<"), ">>").replace(/\:.*/, "");
+        return validTokens.includes(token) ? true : false;
+    }
+    else {
+        return false;
+    }
+}

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

@@ -0,0 +1,8 @@
+import { Narrowable, TypeTuple } from "src/types";
+/**
+ * **isTypeTuple**(value)
+ *
+ * A type-guard which detects if passed in value is a `TypeTuple`.
+ */
+export declare function isTypeTuple<T extends Narrowable, V extends TypeTuple<T, string>>(value: unknown | V): value is V;
+//# sourceMappingURL=isTypeTuple.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"isTypeTuple.d.ts","sourceRoot":"","sources":["../../../../src/runtime/type-guards/isTypeTuple.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAG,SAAS,EAAE,MAAM,WAAW,CAAC;AAEnD;;;;GAIG;AACH,wBAAgB,WAAW,CAAC,CAAC,SAAS,UAAU,EAAE,CAAC,SAAS,SAAS,CAAC,CAAC,EAAE,MAAM,CAAC,EAAE,KAAK,EAAE,OAAO,GAAG,CAAC,GAAG,KAAK,IAAI,CAAC,CAEhH"}

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

@@ -0,0 +1,8 @@
+/**
+ * **isTypeTuple**(value)
+ *
+ * A type-guard which detects if passed in value is a `TypeTuple`.
+ */
+export function isTypeTuple(value) {
+    return Array.isArray(value) && value.length === 3 && typeof value[1] === "function";
+}

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

@@ -0,0 +1,7 @@
+/**
+ * **isUndefined**(value)
+ *
+ * Type guard which determines whether a type is undefined or not.
+ */
+export declare function isUndefined(value: unknown): value is undefined;
+//# sourceMappingURL=isUndefined.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"isUndefined.d.ts","sourceRoot":"","sources":["../../../../src/runtime/type-guards/isUndefined.ts"],"names":[],"mappings":"AAEA;;;;GAIG;AACH,wBAAgB,WAAW,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,SAAS,CAE9D"}

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

@@ -0,0 +1,8 @@
+/**
+ * **isUndefined**(value)
+ *
+ * Type guard which determines whether a type is undefined or not.
+ */
+export function isUndefined(value) {
+    return (typeof value === "undefined") ? true : false;
+}

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

@@ -0,0 +1,46 @@
+import { Type, TypeDefaultValue, TypeDefn, TypeHasDefaultValue, TypeIsRequired, TypeKind, TypeKindContainerNarrow, TypeKindContainerWide, TypeKindFalsy, TypeKindLiteral, TypeKindWide } from "src/types";
+/**
+ * **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/src/runtime/type-guards/runtime-type-guards.d.ts.map

@@ -0,0 +1 @@
+{"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,MAAM,WAAW,CAAC;AASnB;;;;;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/src/runtime/type-guards/runtime-type-guards.js

@@ -0,0 +1,76 @@
+/* eslint-disable @typescript-eslint/no-explicit-any */
+import { FALSY_TYPE_KINDS, LITERAL_TYPE_KINDS, WIDE_TYPE_KINDS, } from "src/constants";
+/**
+ * **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/src/types/base-types/AnyArray.d.ts

@@ -0,0 +1,7 @@
+/**
+ * **AnyArray**
+ *
+ * Any array, either readonly or otherwise.
+ */
+export type AnyArray = unknown[] | readonly unknown[];
+//# sourceMappingURL=AnyArray.d.ts.map

package/dist/src/types/base-types/AnyArray.d.ts.map

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

package/dist/src/types/base-types/AnyArray.js

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

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

@@ -0,0 +1,13 @@
+import { AnyObject, EmptyObject } from "..";
+/**
+ * **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/src/types/base-types/AnyFunction.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"AnyFunction.d.ts","sourceRoot":"","sources":["../../../../src/types/base-types/AnyFunction.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,SAAS,EAAE,WAAW,EAAE,MAAM,IAAI,CAAC;AAE5C;;;;;;;;;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/src/types/base-types/AnyFunction.js

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

package/dist/src/types/base-types/AnyObject.d.ts

@@ -0,0 +1,8 @@
+import { EmptyObject, IndexableObject, NarrowObject, Narrowable } from "src/types/index";
+/**
+ * **AnyObject**
+ *
+ * Meant to represent any valid object type (both indexable and not).
+ */
+export type AnyObject = IndexableObject | EmptyObject | NarrowObject<Narrowable> | object;
+//# sourceMappingURL=AnyObject.d.ts.map

package/dist/src/types/base-types/AnyObject.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"AnyObject.d.ts","sourceRoot":"","sources":["../../../../src/types/base-types/AnyObject.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,WAAW,EAAE,eAAe,EAAE,YAAY,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAEzF;;;;GAIG;AACH,MAAM,MAAM,SAAS,GAAG,eAAe,GAAG,WAAW,GAAG,YAAY,CAAC,UAAU,CAAC,GAAG,MAAM,CAAC"}

package/dist/src/types/base-types/AnyObject.js

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

package/dist/src/types/base-types/Container.d.ts

@@ -0,0 +1,8 @@
+import { AnyArray, AnyObject } from "..";
+/**
+ * **Container**
+ *
+ * A type which represents any object or array.
+ */
+export type Container = AnyObject | AnyArray;
+//# sourceMappingURL=Container.d.ts.map

package/dist/src/types/base-types/Container.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Container.d.ts","sourceRoot":"","sources":["../../../../src/types/base-types/Container.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAG,SAAS,EAAE,MAAM,IAAI,CAAC;AAE1C;;;;GAIG;AACH,MAAM,MAAM,SAAS,GAAG,SAAS,GAAG,QAAQ,CAAC"}

package/dist/src/types/base-types/Container.js

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

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

@@ -0,0 +1,14 @@
+import { Something, Nothing } from "..";
+/**
+ * **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/src/types/base-types/CouldHaveValue.d.ts.map

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

package/dist/src/types/base-types/CouldHaveValue.js

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

package/dist/src/types/base-types/Defined.d.ts

@@ -0,0 +1,8 @@
+import { Something } from "src/types/index";
+/**
+ * **Defined**
+ *
+ * Represents **every** type except for the _undefined_ type.
+ */
+export type Defined = Something | null;
+//# sourceMappingURL=Defined.d.ts.map

package/dist/src/types/base-types/Defined.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Defined.d.ts","sourceRoot":"","sources":["../../../../src/types/base-types/Defined.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,SAAS,EAAC,MAAM,iBAAiB,CAAC;AAE1C;;;;GAIG;AACH,MAAM,MAAM,OAAO,GAAG,SAAS,GAAG,IAAI,CAAC"}

package/dist/src/types/base-types/Defined.js

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

package/dist/src/types/base-types/Digital.d.ts

@@ -0,0 +1,26 @@
+import { Digit, NumericChar, NumericSign } from "..";
+/**
+ * **Digital**
+ *
+ * A Tuple which represents a number as leading `NumericSign` and then
+ * an array of numeric digits.
+ *
+ * **Related:** `DigitalLiteral`
+ */
+export type Digital = [
+    NumericSign,
+    readonly [Digit, ...Digit[]]
+];
+/**
+ * **DigitalLiteral**
+ *
+ * A Tuple which represents a number as a leading `NumericSign` and
+ * then an array of numeric string literals.
+ *
+ * **Related:** `Digital`
+ */
+export type DigitalLiteral = [
+    NumericSign,
+    readonly [`${NumericChar}`, ...`${NumericChar}`[]]
+];
+//# sourceMappingURL=Digital.d.ts.map

package/dist/src/types/base-types/Digital.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Digital.d.ts","sourceRoot":"","sources":["../../../../src/types/base-types/Digital.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,WAAW,EAAE,WAAW,EAAE,MAAM,IAAI,CAAC;AAErD;;;;;;;GAOG;AACH,MAAM,MAAM,OAAO,GAAG;IACpB,WAAW;IACX,SAAS,CAAC,KAAK,EAAE,GAAG,KAAK,EAAE,CAAC;CAC7B,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B,WAAW;IACX,SAAS,CAAC,GAAG,WAAW,EAAE,EAAE,GAAG,GAAG,WAAW,EAAE,EAAE,CAAC;CACnD,CAAC"}

package/dist/src/types/base-types/Digital.js

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

package/dist/src/types/base-types/EmptyObject.d.ts

@@ -0,0 +1,9 @@
+/**
+ * **EmptyObject**
+ *
+ * An object/dictionary with explicitly **no** defined properties.
+ */
+export type EmptyObject = {
+    [key: string | symbol]: never;
+};
+//# sourceMappingURL=EmptyObject.d.ts.map

package/dist/src/types/base-types/EmptyObject.d.ts.map

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

package/dist/src/types/base-types/EmptyObject.js

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

package/dist/src/types/base-types/FalsyValue.d.ts

@@ -0,0 +1,9 @@
+/**
+ * **FalsyValue**
+ *
+ * A union of all _falsy_ values.
+ *
+ * Note: any value which is _not_ falsy is "truthy"
+ */
+export type FalsyValue = false | 0 | -0 | "" | null | undefined;
+//# sourceMappingURL=FalsyValue.d.ts.map

package/dist/src/types/base-types/FalsyValue.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"FalsyValue.d.ts","sourceRoot":"","sources":["../../../../src/types/base-types/FalsyValue.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AACH,MAAM,MAAM,UAAU,GAAG,KAAK,GAAG,CAAC,GAAG,CAAC,CAAC,GAAI,EAAE,GAAG,IAAI,GAAG,SAAS,CAAE"}

package/dist/src/types/base-types/FalsyValue.js

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

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

@@ -0,0 +1,6 @@
+/**
+ * An identity function is one which receives a value `T`
+ * and returns the same value `T`.
+ */
+export type IdentityFunction = <T>(val: T) => T;
+//# sourceMappingURL=IdentityFunction.d.ts.map

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

@@ -0,0 +1 @@
+{"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/src/types/base-types/IdentityFunction.js

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

package/dist/src/types/base-types/Indexable.d.ts

@@ -0,0 +1,9 @@
+import { IndexableObject } from "..";
+/**
+ * **Indexable**
+ *
+ * A type which can be _indexed_. This means either an array of
+ * some sort, an indexable object, a `Map`, or a `WeakMap`.
+ */
+export type Indexable = IndexableObject | unknown[] | readonly unknown[] | WeakMap<any, any> | Map<any, any>;
+//# sourceMappingURL=Indexable.d.ts.map

package/dist/src/types/base-types/Indexable.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Indexable.d.ts","sourceRoot":"","sources":["../../../../src/types/base-types/Indexable.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,eAAe,EAAE,MAAM,IAAI,CAAC;AAErC;;;;;GAKG;AACH,MAAM,MAAM,SAAS,GAAG,eAAe,GAAG,OAAO,EAAE,GAAG,SAAS,OAAO,EAAE,GAAG,OAAO,CAAC,GAAG,EAAE,GAAG,CAAC,GAAG,GAAG,CAAC,GAAG,EAAC,GAAG,CAAC,CAAC"}

package/dist/src/types/base-types/Indexable.js

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

package/dist/src/types/base-types/IndexableObject.d.ts

@@ -0,0 +1,15 @@
+import { ObjectKey, ExpandRecursively, IfNever, Keys, AnyObject } from "..";
+export type GenericIndexableObject = {
+    [key: string | symbol]: unknown;
+};
+/**
+ * **IndexableObject**`<[TObj]>`
+ *
+ * Represents any object which _can_ be indexed by a valid key
+ * for a JS object/dictionary. These keys may be explicitly defined
+ * or can be generically allowed via a generic index like `{[key: string]: unknown}`.
+ *
+ * **Related:** `EmptyObject`, `IndexedObject`
+ */
+export type IndexableObject<TObj extends AnyObject = GenericIndexableObject> = IfNever<TObj, never, IfNever<Keys<TObj>["length"], GenericIndexableObject, ExpandRecursively<Record<ObjectKey, unknown> & TObj>>>;
+//# sourceMappingURL=IndexableObject.d.ts.map

package/dist/src/types/base-types/IndexableObject.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"IndexableObject.d.ts","sourceRoot":"","sources":["../../../../src/types/base-types/IndexableObject.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAG,iBAAiB,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,MAAM,IAAI,CAAC;AAE7E,MAAM,MAAM,sBAAsB,GAAG;IACnC,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC;CACjC,CAAC;AAEF;;;;;;;;GAQG;AACH,MAAM,MAAM,eAAe,CAAC,IAAI,SAAS,SAAS,GAAG,sBAAsB,IAC3E,OAAO,CACL,IAAI,EACJ,KAAK,EACL,OAAO,CACL,IAAI,CAAC,IAAI,CAAC,CAAC,QAAQ,CAAC,EACpB,sBAAsB,EACtB,iBAAiB,CAAE,MAAM,CAAC,SAAS,EAAE,OAAO,CAAC,GAAG,IAAI,CAAE,CACvD,CACF,CAAC"}

package/dist/src/types/base-types/IndexableObject.js

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

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

@@ -0,0 +1,3 @@
+import { EmptyObject, IndexableObject, Length } from "..";
+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/src/types/base-types/IndexedObject.d.ts.map

@@ -0,0 +1 @@
+{"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,MAAM,IAAI,CAAC;AAE3D,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"}