inferred-types 0.36.4 → 0.37.1

package/src/types/fluent/index.ts

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

package/src/types/functions/FinalReturn.ts

@@ -1,12 +0,0 @@
-/**
- * A type utility which looks at a chain for functions and reduces the type
- * to the final `ReturnType` of the chain.
- * 
- * ```ts
- * // number
- * type T = FinalReturn<() => (foo: string) => (bar: string) => () => number>;
- * ```
- */
-export type FinalReturn<T extends any> = T extends (...args: any[]) => any
-  ? FinalReturn<ReturnType<T>>
-  : T;

package/src/types/functions/LogicFunction.ts

@@ -1,4 +0,0 @@
-/**
- * A function which returns a boolean value
- */
-export type LogicFunction<T extends readonly any[]> = (...args: T) => boolean;

package/src/types/functions/index.ts

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

package/src/types/index.ts

@@ -1,49 +0,0 @@
-// #autoindex
-// #region auto-indexed files
-// index last changed at: 8th Aug, 2022, 09:51 AM ( GMT-7 )
-// hash-code: fbd4603a
-
-// file exports
-export * from "./Api";
-export * from "./Constructor";
-export * from "./EnumValues";
-export * from "./ExpandRecursively";
-export * from "./lists/First";
-export * from "./FunctionType";
-export * from "./If";
-export * from "./Include";
-export * from "./KeyedRecord";
-export * from "./Keys";
-export * from "./Length";
-export * from "./Mutable";
-export * from "./Narrowable";
-export * from "./Not";
-export * from "./Numeric";
-export * from "./Opaque";
-export * from "./Retain";
-export * from "./SimplifyObject";
-export * from "./Transformer";
-export * from "./TypeGuard";
-export * from "./Where";
-export * from "./append-types";
-export * from "./maybe";
-export * from "./ruleset-types";
-export * from "./runtime";
-export * from "./type-testing";
-// directory exports
-export * from "./alphabetic/index";
-export * from "./dictionary/index";
-export * from "./fluent/index";
-export * from "./functions/index";
-export * from "./kv/index";
-export * from "./lists/index";
-export * from "./literal-unions/index";
-export * from "./string-literals/index";
-export * from "./tuples/index";
-export * from "./type-conversion/index";
-export * from "./boolean-logic/index";
-
-// #endregion auto-indexed files
-
-// see https://github.com/inocan-group/do-devops/docs/autoindex.md
-// for more info

package/src/types/kv/DictFromKv.ts

@@ -1,3 +0,0 @@
-export type DictFromKv<T extends readonly { key: string; value: unknown }[]> = {
-  [R in T[number] as R["key"]]: R["value"];
-};

package/src/types/kv/KeyValue.ts

@@ -1,12 +0,0 @@
-import { ExpandRecursively } from "../ExpandRecursively";
-
-/**
- * Provides a strongly typed _key_ and _value_ for a dictionary `T`
- * 
- * ```ts
- * type Obj = { foo: 1, bar: "hi" };
- * // ["foo", 1 ]
- * type Foo = KeyValue<Obj, "foo">;
- * ```
- */
-export type KeyValue<T extends object, K extends keyof T> = [K & keyof T, ExpandRecursively<T[K]>];

package/src/types/kv/KvFrom.ts

@@ -1,8 +0,0 @@
-/**
- * Type utility which takes an object type and converts to an array of KV objects:
- * ```ts
- * // [ {key: "id", value: 123 } | {key: "foo", value: "bar" } ][]
- * type Arr = KvFrom<{ id: 123, foo: "bar" }>;
- * ```
- */
-export type KvFrom<T extends object> = Array<{ [K in keyof T]: { key: K; value: T[K] } }[keyof T]>;

package/src/types/kv/KvTuple.ts

@@ -1,14 +0,0 @@
-/**
- * **KvTuple**
- * 
- * a key/value of type `T` represented as `[key, kv]`
- * 
- * ```ts
- * type Obj = { foo: 1, bar: "hi" };
- * // ["foo", { foo: 1 } ]
- * type Foo = KvTuple<Obj, "foo">;
- * ```
- * 
- * **Note:** _consider use of `KeyValue<T,K>` as an alternate representation_
- */
-export type KvTuple<T, K extends keyof T> = [K, Record<K, T[K]>];

package/src/types/kv/index.ts

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

package/src/types/lists/AfterFirst.ts

@@ -1,10 +0,0 @@
-/**
- * **AfterFirst**`<T>`
- *
- * returns the elements in an array _after_ the first element
- */
-export type AfterFirst<T extends readonly any[]> = T extends readonly [any, ...any[]]
-  ? T extends readonly [any, ...infer Rest]
-    ? Rest
-    : never
-  : T;

package/src/types/lists/ConvertAndMap.ts

@@ -1,151 +0,0 @@
-import { TupleToUnion, UnionToTuple } from "../type-conversion";
-import { Narrowable } from "../Narrowable";
-import { First } from "./First";
-import { AfterFirst } from "./AfterFirst";
-import { Keys } from "../Keys";
-
-import { DictionaryWithoutValue } from "../dictionary/props";
-
-// [Mapped Tuple Types](https://github.com/Microsoft/TypeScript/issues/25947)
-
-/**
- * The basic shape of a `Converter`
- */
-export type ConverterShape<
-  S extends Narrowable,
-  N extends Narrowable,
-  B extends Narrowable,
-  O extends Narrowable
-> = {
-  string: <T extends string>(v: T) => S;
-  number: <T extends number>(v: T) => N;
-  boolean: <T extends boolean>(v: T) => B;
-  object: <T extends Record<string, any>>(v: T) => O;
-};
-
-type ConverterKeys<S, N, B, O> = UnionToTuple<
-  Keys<
-    DictionaryWithoutValue<
-      {
-        string: S;
-        number: N;
-        boolean: B;
-        object: O;
-      },
-      undefined
-    >
-  >
->;
-
-type ConverterInputType<T extends string> = T extends "string"
-  ? string
-  : T extends "number"
-  ? number
-  : T extends "boolean"
-  ? boolean
-  : T extends "object"
-  ? Record<string, any>
-  : unknown;
-
-type ConverterInputUnion<
-  TConverted extends readonly any[],
-  TRemaining extends readonly string[]
-> = [] extends TRemaining
-  ? // we're done iterating
-    TConverted
-  : // recurse
-    ConverterInputUnion<
-      [...TConverted, ConverterInputType<First<TRemaining>>],
-      AfterFirst<TRemaining>
-    >;
-
-/**
- * **AvailableConverters**
- *
- * Type utility which will produce the correct union type for a "converter"
- */
-export type AvailableConverters<S, N, B, O> = ConverterKeys<S, N, B, O> extends readonly string[]
-  ? TupleToUnion<ConverterInputUnion<[], ConverterKeys<S, N, B, O>>>
-  : never;
-
-/**
- * **Converter**
- *
- * A type converter coming from the `createConverter()` utility. It receives
- * one or more broad types (e.g., number, string, etc.) -- what it can take
- * is based on what is configured -- and then converts based on the value
- * passed in.
- *
- * The primary goal is to preserve as many _narrow_ types as possible in this process.
- */
-export type Converter<
-  S extends Narrowable,
-  N extends Narrowable,
-  B extends Narrowable,
-  O extends Narrowable
-> = <T extends AvailableConverters<S, N, B, O>>(input: T) => ConverterShape<S, N, B, O>;
-
-export type Conversion<TInput extends Narrowable, TOutput extends Narrowable> = <T extends TInput>(
-  input: T
-) => TOutput;
-
-export type ConverterCoverage = "string" | "number" | "boolean" | "object";
-
-/**
- * Extracts the coverage provided by a `StrongMap` as a Tuple
- */
-export type MapCoverage<T extends StrongMap<ConverterCoverage>> = T extends StrongMap<
-  infer Coverage
->
-  ? UnionToTuple<Coverage>
-  : never;
-
-export type StrongMapTypes<K extends readonly any[]> = [] extends K
-  ? never
-  : TupleToUnion<
-      [
-        First<K> extends "string"
-          ? TupleToUnion<[string, ...UnionToTuple<StrongMapTypes<AfterFirst<K>>>]>
-          : First<K> extends "number"
-          ? TupleToUnion<[number, ...UnionToTuple<StrongMapTypes<AfterFirst<K>>>]>
-          : First<K> extends "boolean"
-          ? TupleToUnion<[boolean, ...UnionToTuple<StrongMapTypes<AfterFirst<K>>>]>
-          : First<K> extends "object"
-          ? TupleToUnion<[Record<string, any>, ...UnionToTuple<StrongMapTypes<AfterFirst<K>>>]>
-          : never,
-        ...UnionToTuple<StrongMapTypes<AfterFirst<K>>>
-      ]
-    >;
-
-export type StrongMap<TDefined = ConverterCoverage> = {
-  string: TDefined extends "string" ? <T extends string, R extends any>(v: T) => R : never;
-  number: TDefined extends "number" ? <T extends number, R extends any>(v: T) => R : never;
-  boolean: TDefined extends "boolean" ? <T extends boolean, R extends any>(v: T) => R : never;
-  object: TDefined extends "object"
-    ? <T extends Record<string, any>, R extends any>(v: T) => R
-    : never;
-};
-
-export type StrongMapTransformer<M extends StrongMap> = <
-  T extends readonly StrongMapTypes<MapCoverage<M>>[]
->(
-  tuple: T
-) => {
-  [K in keyof T]: T[K] extends string
-    ? M["string"] extends (...args: any[]) => any
-      ? ReturnType<M["string"]>
-      : never
-    : T[K] extends number
-    ? M["number"] extends (...args: any[]) => any
-      ? ReturnType<M["number"]>
-      : never
-    : T[K] extends boolean
-    ? M["boolean"] extends (...args: any[]) => any
-      ? ReturnType<M["boolean"]>
-      : never
-    : T[K] extends Record<string, any>
-    ? M["object"] extends (...args: any[]) => any
-      ? ReturnType<M["object"]>
-      : never
-    : never;
-}[keyof T];

package/src/types/lists/FilterTuple.ts

@@ -1,20 +0,0 @@
-/**
- * **FilterTuple**
- *
- * Allows a known tuple `T` to be _filtered down_ by eliminating all items
- * in the Tuple that _extend_ type `F`
- * ```ts
- * type T = [1,"foo",3];
- * // [1,3]
- * type T2 = FilterTuple<T, string>;
- * ```
- */
-export type FilterTuple<
-  TTuple extends any[] | readonly any[],
-  TFilter,
-  Result extends any[] = []
-> = TTuple extends [infer A, ...infer R]
-  ? [A] extends [TFilter]
-    ? FilterTuple<R, TFilter, Result>
-    : FilterTuple<R, TFilter, [...Result, A]>
-  : Result;

package/src/types/lists/First.ts

@@ -1,8 +0,0 @@
-/**
- * Returns the first values type in an array of values
- */
-export type First<T extends readonly any[]> = T[0] extends T[number] ? T[0] : never;
-
-export type FirstOrUndefined<T extends unknown> = T extends [unknown, ...[unknown]]
-  ? First<T>
-  : undefined;

package/src/types/lists/FirstString.ts

@@ -1,4 +0,0 @@
-/**
- * returns the first `string` value from an array of values
- */
-export type FirstString<T> = T extends [infer S extends string, ...unknown[]] ? S : never;

package/src/types/lists/Split.ts

@@ -1,21 +0,0 @@
-/**
- * **Split**`<T, SEP>`
- *
- * Splits a string literal `T` by string literal _separator_ `SEP`. The result is an array
- * of string literals.
- */
-export type Split<
-  T extends string,
-  SEP extends string,
-  ANSWER extends string[] = []
-> = string extends T
-  ? // wide string so we can only return wide string[]
-    string[]
-  : T extends SEP
-  ? // the string === separator results in empty array
-    ANSWER
-  : // test whether can recurse
-  T extends `${infer HEAD}${SEP}${infer TAIL}`
-  ? // recurse to produce strong literal type
-    Split<TAIL, SEP, [...ANSWER, HEAD]>
-  : [...ANSWER, T];

package/src/types/lists/UniqueForProp.ts

@@ -1,18 +0,0 @@
-import { Get } from "../dictionary/Get";
-import { Narrowable } from "../Narrowable";
-
-/**
- * Create a union type based on a given property in an array of objects
- * ```ts
- * const data = [
- *    { id: 123, color: "blue" },
- *    { id: 456, color: "red" },
- *  ] as const;
- * // 123 | 456
- * type U = UniqueForProp<typeof data, "id">;
- * ```
- */
-export type UniqueForProp<
-  T extends readonly Record<string, Narrowable>[],
-  P extends string
-> = Readonly<Get<T[number], P>>;

package/src/types/lists/index.ts

@@ -1,18 +0,0 @@
-// #autoindex
-
-// #region auto-indexed files
-// index last changed at: 8th Aug, 2022, 09:51 AM ( GMT-7 )
-// hash-code: 582c0cf0
-
-// file exports
-export * from "./AfterFirst";
-export * from "./First";
-export * from "./FirstString";
-export * from "./FilterTuple";
-export * from "./Split";
-export * from "./UniqueForProp";
-
-// #endregion auto-indexed files
-
-// see https://github.com/inocan-group/do-devops/docs/autoindex.md
-// for more info

package/src/types/literal-unions/OptRequired.ts

@@ -1,4 +0,0 @@
-/**
- * Expresses whether an option is "opt" (optional) or "req" (required)
- */
-export type OptRequired = "opt" | "req";

package/src/types/literal-unions/index.ts

@@ -1 +0,0 @@
-export * from "./OptRequired";

package/src/types/maybe.ts

@@ -1,9 +0,0 @@
-/**
- * Accepts the `true` literal or _undefined_.
- */
-export type MaybeTrue = true | undefined;
-
-/**
- * Accepts the `false` literal or _undefined_.
- */
-export type MaybeFalse = false | undefined;

package/src/types/ruleset-types.ts

@@ -1,76 +0,0 @@
-import { TypeCondition } from "src/runtime/type-checks/ifTypeOf";
-import { OptionalKeys } from "./dictionary/props";
-import { SameKeys } from "./dictionary/SameKeys";
-
-/**
- * **RuleDefinition**
- *
- * A rule definition is the typing for the fluent API surface that is built up
- * with the **ruleset** utility.
- */
-export type RuleDefinition<
-  /** the data which will be evaluated on rule execution */
-  T extends object,
-  /** the optional props -- as a union type -- which must be defined per the rule */
-  H extends string = "",
-  /** the key/values which will be evaluated on execution (wide type) */
-  E extends Partial<SameKeys<T>> = {},
-  /** the key/values which will be evaluated on execution (narrow type) */
-  N extends Partial<SameKeys<T>> = {}
-> = {
-  /**
-   * sets up a true/false check that a given property is defined; this
-   * condition can only be applied to _optional_ properties.
-   */
-  has(optProp: OptionalKeys<T>): RuleDefinition<T, H & typeof optProp, E, N>;
-
-  /**
-   * Validates that a given property extends a certain value's type; comparison
-   * is made assuming "wide types".
-   */
-  equals<K extends keyof T, V extends Pick<T, K>>(
-    prop: K,
-    value: V
-  ): RuleDefinition<T, H, E & Record<K, V>, N>;
-
-  /**
-   * Validates that a given property extends a certain value's type; comparison
-   * is made assuming "narrow types". This is only available for props which
-   * expose a
-   */
-  narrowlyEquals<K extends keyof T, V extends Pick<T, K>>(
-    prop: K,
-    value: V
-  ): RuleDefinition<T, H, E, N & Record<K, V>>;
-};
-
-/**
- * **DynamicRule**
- *
- * A dynamic rule allows type and runtime validation of a data structure
- * which extends a known `State`. It then returns the literal type `true`
- * or `false`.
- *
- * ```ts
- * type State = { id?: string; favorite: boolean; color: string };
- * // type-safe way to check whether optional prop is actually set
- * const rule: DynamicRule<State> = s => s
- *  .has("id")
- *  .equals("favorite", true)
- *  .equals("color", "red");
- * ```
- */
-export type DynamicRule<TState extends any, TResult extends true | false> = (
-  rule: TypeCondition<any, TState>
-) => TResult;
-
-/**
- * **DynamicRuleSet**
- *
- * A function which accepts the agreed `TState` generic as input and returns a discrete
- * `true` or `false` value.
- */
-export type DynamicRuleSet<
-  TState extends any,
-  TRules extends Record<string, TypeCondition<any, TState>>
-> = (rules: TRules) => true | false;

package/src/types/runtime.ts

@@ -1,39 +0,0 @@
-// runtime types relate to the types coming out of the runtime utilities
-
-import { TypeGuard } from "./TypeGuard";
-
-export type RuntimeType<T> = {
-  __kind: "type";
-
-  type: T;
-  is: TypeGuard<T>;
-};
-
-export type RuntimeProp<P extends Readonly<PropertyKey>, T extends RuntimeType<any>> = {
-  __kind: "prop";
-  key: Readonly<P>;
-  valueType: Readonly<T["type"]>;
-  /**
-   * Provides the _type_ to the type system when used with `typeof`.
-   *
-   * ```ts
-   * const t = number();
-   * // number
-   * type T = typeof t.type;
-   * ```
-   *
-   * **Note:** _the runtime system will get a string equivalent name:_
-   * ```ts
-   * const t = number();
-   * // "number"
-   * console.log(t.type);
-   * ```
-   */
-  type: Record<P, T["type"]>;
-  is: TypeGuard<Record<P, T["type"]>>;
-};
-
-export type TypeOptions<T extends Partial<object> = {}> = {
-  /** each type has a default type guard but you can override if you need to be more specific */
-  typeGuard?: TypeGuard<T>;
-} & T;

package/src/types/string-literals/Break.ts

@@ -1,22 +0,0 @@
-
-/**
- * **Break<T,D>**
- * 
- * Takes a string `T`, and splits it into a tuple of the form `[F, R]`.
- * ```ts
- * // ["the", " long and winding road"]
- * type T1 = Break<"the long and winding road", " ">;
- * // ["there", " I was, there I was"]
- * type T2 = Break<"there I was, there I was", " ">;
- * ```
- */
-export type Break<T extends string, D extends string> = (
-  string extends T ? [string, string] : (
-    T extends `${infer F}${D}${infer _R}` ? (
-      F extends `${infer _X}${D}${infer _Y}` ? never : (
-        T extends `${F}${infer R}` ? [F, R] : never
-      )
-    ) : [T, ""]
-  )
-);
-

package/src/types/string-literals/Concat.ts

@@ -1,9 +0,0 @@
-/**
- * Concatenates two arrays (of literals).
- * ```ts
- * // [ "foo", "bar", "baz" ]
- * type T = ArrConcat<["foo"], ["bar", "baz"]>;
- * ```
- */
-export type ArrConcat<A extends any[], B extends any[]> = [...A, ...B];
-

package/src/types/string-literals/LeftWhitespace.ts

@@ -1,13 +0,0 @@
-import { Replace } from "./Replace";
-import { TrimLeft } from "./TrimLeft";
-
-/**
- * Provides the _left_ whitespace of a string
- * ```ts
- * // "\n\t "
- * type T = LeftWhitespace<"\n\t foobar">;
- * ```
- */
-export type LeftWhitespace<S extends string> = string extends S
-  ? string
-  : Replace<S, TrimLeft<S>, "">;

package/src/types/string-literals/Replace.ts

@@ -1,17 +0,0 @@
-/**
- * Type utility which takes a string `S` and replaces the substring `W` with `P`.
- * ```ts
- * const fooy = "fooy";
- * // "Foo"
- * type Foo = Replace<typeof fooy, "y", "">;
- * ```
- *
- * Note: _the first match is replaced and all subsequent matches are ignored_
- */
-export type Replace<S extends string, W extends string, P extends string> = S extends ""
-  ? ""
-  : W extends ""
-  ? S
-  : S extends `${infer F}${W}${infer E}`
-  ? `${F}${P}${E}`
-  : S;

package/src/types/string-literals/RightWhitespace.ts

@@ -1,13 +0,0 @@
-import { Replace } from "./Replace";
-import { TrimRight } from "./TrimRight";
-
-/**
- * Provides the _left_ whitespace of a string
- * ```ts
- * // "\n\t "
- * type T = LeftWhitespace<"\n\t foobar">;
- * ```
- */
-export type RightWhitespace<S extends string> = string extends S
-  ? string
-  : Replace<S, TrimRight<S>, "">;

package/src/types/string-literals/StringLength.ts

@@ -1,34 +0,0 @@
-/**
- * Type utility that provides the _length_ of a given string type in a way which
- * is _not_ limited to TS's recursive string length of roughly 48.
- * 
- * ```ts
- * // 3
- * type Three = StringLength<"foo">;
- * ```
- */
-export type StringLength<S extends string, R extends number[] = []>
-  = S extends `${infer _First}${infer _Second}${infer _Third}${infer _Fourth}${infer _Fifth}${infer _Sixth}${infer _Sevebnth}${infer _Eighth}${infer _Ninth}${infer _Tenth}${infer Rest}`
-  ? StringLength<Rest, [...R, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1]>
-  : S extends `${infer _First}${infer _Second}${infer _Third}${infer _Fourth}${infer _Fifth}${infer _Sixth}${infer _Sevebnth}${infer _Eighth}${infer _Ninth}${infer Rest}`
-  ? StringLength<Rest, [...R, 1, 1, 1, 1, 1, 1, 1, 1, 1]>
-  : S extends `${infer _First}${infer _Second}${infer _Third}${infer _Fourth}${infer _Fifth}${infer _Sixth}${infer _Sevebnth}${infer _Eighth}${infer Rest}`
-  ? StringLength<Rest, [...R, 1, 1, 1, 1, 1, 1, 1, 1]>
-  : S extends `${infer _First}${infer _Second}${infer _Third}${infer _Fourth}${infer _Fifth}${infer _Sixth}${infer _Sevebnth}${infer Rest}`
-  ? StringLength<Rest, [...R, 1, 1, 1, 1, 1, 1, 1]>
-  : S extends `${infer _First}${infer _Second}${infer _Third}${infer _Fourth}${infer _Fifth}${infer _Sixth}${infer Rest}`
-  ? StringLength<Rest, [...R, 1, 1, 1, 1, 1, 1]>
-  : S extends `${infer _First}${infer _Second}${infer _Third}${infer _Fourth}${infer _Fifth}}${infer Rest}`
-  ? StringLength<Rest, [...R, 1, 1, 1, 1, 1]>
-  : S extends `${infer _First}${infer _Second}${infer _Third}${infer _Fourth}${infer Rest}`
-  ? StringLength<Rest, [...R, 1, 1, 1, 1]>
-  : S extends `${infer _First}${infer _Second}${infer _Third}${infer Rest}`
-  ? StringLength<Rest, [...R, 1, 1, 1]>
-  : S extends `${infer _First}${infer _Second}${infer Rest}`
-  ? StringLength<Rest, [...R, 1, 1]>
-  : S extends `${infer _First}${infer Rest}`
-  ? StringLength<Rest, [...R, 1]>
-  : [...R]["length"];
-
-
-