inferred-types 0.51.1 → 0.51.2

package/src/types/string-literals/casing/SnakeCase.ts

@@ -1,60 +0,0 @@
-/* eslint @typescript-eslint/no-unused-vars: "off" */
-import {
-  IsTrue,
-  If,
-  LeftWhitespace,
-  RightWhitespace,
-  Trim,
-  Concat,
-  DashUppercase,
-  LowerAllCaps
-} from "inferred-types/dist/types/index";
-
-/** convert space to dash */
-type SpaceToDash<T extends string> = T extends `${infer Begin}${" "}${infer Rest}`
-  ? SpaceToDash<`${Begin}-${Rest}`>
-  : T;
-
-/**
- * **SnakeCase**`<TString,TPreserve>`
- *
- * Converts a string literal type to _snake_case_ and optionally preserves
- * surrounding whitespace.
- * ```ts
- * // "foo_bar"
- * type T = SnakeCase<"fooBar">;
- * type T = SnakeCase<"\n foo bar \t">;
- * ```
- */
-export type SnakeCase<
-  S extends string,
-  TPreserve extends boolean = false
-> = If<
-  IsTrue<TPreserve>,
-  string extends S
-    ? string
-    : DashUppercase<
-        Uncapitalize<SpaceToDash<Trim<LowerAllCaps<S>>>
-      >
-    > extends `${infer Begin extends string}${"-"}${infer Rest extends string}`
-      ? Concat<[
-          LeftWhitespace<S>,
-          `${Lowercase<Begin>}_${Rest}` extends string
-          ? SnakeCase<`${Lowercase<Begin>}_${Rest}`>
-          : never,
-          RightWhitespace<S>
-      ]>
-      : Concat<[
-        LeftWhitespace<S>,
-        Lowercase<DashUppercase<Uncapitalize<LowerAllCaps<S>>>>,
-        RightWhitespace<S>,
-      ]>,
-  string extends S
-    ? string
-    : DashUppercase<
-        Uncapitalize<SpaceToDash<Trim<LowerAllCaps<S>>>>
-      > extends `${infer Begin}${"-"}${infer Rest}`
-    ? Trim<SnakeCase<`${Lowercase<Begin>}_${Rest}`>>
-    : Trim<Lowercase<DashUppercase<Uncapitalize<LowerAllCaps<S>>>>>
->;
-

package/src/types/string-literals/casing/index.ts

@@ -1,12 +0,0 @@
-export * from "./AllCaps";
-export * from "./CamelCase";
-export * from "./CapFirstAlpha";
-export * from "./CapitalizeWords";
-export * from "./DashToSnake";
-export * from "./DashUppercase";
-export * from "./KebabCase";
-export * from "./LowerAllCaps";
-export * from "./NamingConvention";
-export * from "./PascalCase";
-export * from "./SnakeCase";
-

package/src/types/string-literals/character-sets/Alpha.ts

@@ -1,19 +0,0 @@
-import { AlphaChar, AsArray, IfAllExtend,  If, IsStringLiteral,  Chars } from "inferred-types/dist/types/index";
-
-/**
- * **Alpha**`<T>`
- *
- * Converts `T` to _never_ if `T` is not a alphabetic string. Possible values are:
- *
- * - `T` - when T is a string literal and characters are alphabetic
- * - `string` - when T is a wide string type
- * - `never` - all other types of `T` are converted to never
- */
-export type Alpha<T> = T extends string
-  ? If<
-      IsStringLiteral<T>,
-      IfAllExtend<AsArray<Chars<T>>, AlphaChar, T, never>,
-      string
-    >
-  : never;
-

package/src/types/string-literals/character-sets/AlphaChar.ts

@@ -1,10 +0,0 @@
-import { LowerAlphaChar , UpperAlphaChar } from "inferred-types/dist/types/index";
-
-/**
- * **AlphaChar**
- *
- * Alphabetical character (both upper and lowercase).
- *
- * **Related:** `UpperAlphaChar`, `LowerAlphaChar`, `Alpha`
- */
-export type AlphaChar = UpperAlphaChar | LowerAlphaChar;

package/src/types/string-literals/character-sets/AlphaNumeric.ts

@@ -1,31 +0,0 @@
-import { IsStringLiteral , NumericChar , AlphaChar } from "inferred-types/dist/types/index";
-
-/**
- * Any alphabetic or numeric string character
- */
-export type AlphaNumericChar = AlphaChar | NumericChar;
-
-
-type AlphaNumericAcc<
-  T extends string,
-  TResult extends string
-> = T extends ""
-  ? TResult
-  : // iterate through characters and look for exception
-    T extends `${AlphaNumericChar}${infer REST}`
-      ? AlphaNumericAcc<REST, TResult>
-      : never;
-
-/**
- * **AlphaNumeric**`<T>`
- *
- * Type utility which tests that all characters in `T` are alpha-numeric and returns
- * `T` "as is" in cases where this conditions is met. In cases where the condition is
- * not met, the type is converted to `never`.
- *
- * **Related:** `AlphaNumericChar`
- */
-export type AlphaNumeric<T extends string> = IsStringLiteral<T> extends true
-  ? AlphaNumericAcc<T, T>
-  /** Invalid Alphanumeric string */
-  : never;

package/src/types/string-literals/character-sets/BCP.ts

@@ -1,37 +0,0 @@
-import { Suggest } from "../Suggest";
-
-/**
- * The [BCP47 standard](https://en.wikipedia.org/wiki/IETF_language_tag) is 
- * used to specify a country or region.
- * 
- * Notes:
- * 
- * - it is also used heavily in Javascript, such as the for Locale strings, etc.
- * - this type is not exhaustive but rather just suggests some and allows all
- */
-export type BCP47 = Suggest<
-| "af"
-| "be"
-| "bg"
-| "cy"
-| "en"
-| "es"
-| "fi"
-| "ga"
-| "it"
-| "ja"
-| "ko"
-| "hy"
-| "nl"
-| "no"
-| "pl"
-| "pt"
-| "sa"
-| "sv"
-| "ru"
-| "th"
-| "tr"
-| "uk"
-| "ur"
-| "zh"
->;

package/src/types/string-literals/character-sets/CSV.ts

@@ -1,26 +0,0 @@
-import { Digit } from "inferred-types/dist/types/index";
-
-
-/**
- * **CSV**
- *
- * A string literal type meant to enforce CSV data.
- *
- * - when used _without_ the provided generic it is a fairly loose type which only ensures that somewhere in the string is a comma
- * - the generic, however, allows you to state the minimum number of
- * commas you expect in your data.
- * - today we only provide a single _digit_ so 9 represents 9 commas
- * and 0 represents 10 (the max we'll check for).
- */
-export type CSV<T extends Digit = 1> = T extends 1
-? `${string},${string}`
-: T extends 2 ? `${string},${string},${string}`
-: T extends 3 ? `${string},${string},${string},${string}`
-: T extends 4 ? `${string},${string},${string},${string},${string}`
-: T extends 5 ? `${string},${string},${string},${string},${string},${string}`
-: T extends 6 ? `${string},${string},${string},${string},${string},${string},${string}`
-: T extends 7 ? `${string},${string},${string},${string},${string},${string},${string},${string}`
-: T extends 8 ? `${string},${string},${string},${string},${string},${string},${string},${string},${string}`
-: T extends 9 ? `${string},${string},${string},${string},${string},${string},${string},${string},${string},${string}`
-: T extends 0 ? `${string},${string},${string},${string},${string},${string},${string},${string},${string},${string},${string}`
-: never;

package/src/types/string-literals/character-sets/CarriageReturn.ts

@@ -1,22 +0,0 @@
-import { Indent } from "./Indent";
-
-/** The **carriage return** character */
-export type Cr = "\n";
-
-/** An _optional_ **carriage return** character */
-export type OptCr = "\n" | "";
-
-
-/**
- * a **carriage return** character followed by indentation
- *
- * **Related:** `OptCrThenIndent`, `Cr`, `OptCr`
- */
-export type CrThenIndent = `${Cr}${Indent}`
-
-/**
- * an _optional_ **carriage return** character followed by indentation
- *
- * **Related:** `CrThenIndent`, `Cr`, `OptCr`
- */
-export type OptCrThenIndent = CrThenIndent | "";

package/src/types/string-literals/character-sets/Consonants.ts

@@ -1,19 +0,0 @@
-import  { CONSONANTS } from "inferred-types/dist/constants/index";
-
-/**
- * **Consonants**
- *
- * An array of all consonant characters/letters.
- *
- * **Related:** `Consonant`
- */
-export type Consonants = typeof CONSONANTS;
-
-/**
- * **Consonant**
- *
- * A union type that includes all _consonants_.
- *
- * **Related:** `Consonants`
- */
-export type Consonant = typeof CONSONANTS[number];

package/src/types/string-literals/character-sets/Country.ts

@@ -1,217 +0,0 @@
-import { ISO3166_1 } from "inferred-types/dist/constants/index";
-import {  If, IsEqual, IsStringLiteral } from "inferred-types/dist/types/index";
-import { AfterFirst, First } from "src/types/lists";
-
-
-export type Iso3166_1_Lookup = typeof ISO3166_1;
-
-type Props = "alpha2" | "alpha3" | "countryCode" | "name";
-
-
-/**
- * **Iso3166_1_Alpha2**
- *
- * A union of all 2 character country codes defined by the ISO3166-1
- * standard.
- */
-export type Iso3166_1_Alpha2 = {
-  [K in keyof Iso3166_1_Lookup]: "alpha2" extends keyof Iso3166_1_Lookup[K]
-    ? Iso3166_1_Lookup[K]["alpha2"]
-    : never
-}[number];
-
-/**
- * **Iso3166_1_Alpha3**
- *
- * A union of all 2 character country codes defined by the ISO3166-1
- * standard.
- */
-export type Iso3166_1_Alpha3 = {
-  [K in keyof Iso3166_1_Lookup]: "alpha3" extends keyof Iso3166_1_Lookup[K]
-    ? Iso3166_1_Lookup[K]["alpha3"]
-    : never
-}[number];
-
-
-/**
- * **Iso3166_1_Alpha3**
- *
- * A union of all 2 character country codes defined by the ISO3166-1
- * standard.
- */
-export type Iso3166_1_CountryCode = {
-  [K in keyof Iso3166_1_Lookup]: "countryCode" extends keyof Iso3166_1_Lookup[K]
-    ? Iso3166_1_Lookup[K]["countryCode"]
-    : never
-}[number];
-
-/**
- * **Iso3166_1_Alpha3**
- *
- * A union of all 2 character country codes defined by the ISO3166-1
- * standard.
- */
-export type Iso3166_1_CountryName = {
-  [K in keyof Iso3166_1_Lookup]: "name" extends keyof Iso3166_1_Lookup[K]
-    ? Iso3166_1_Lookup[K]["name"]
-    : never
-}[number];
-
-/**
- * Any identifying aspect of an ISO3166-1 country (alpha2, alpha3, code, name)
- */
-export type Iso3166_1_Token = Iso3166_1_Alpha2 | Iso3166_1_Alpha3 | Iso3166_1_CountryCode | Iso3166_1_CountryName;
-
-
-type LookupAlpha2<
-  T extends Iso3166_1_Alpha2,
-  Lookup extends readonly { name: string; alpha2: string; alpha3: string; countryCode: string }[],
-  Prop extends Props
-> = [] extends Lookup
-? undefined
-: T extends First<Lookup>["alpha2"]
-    ? First<Lookup>[`${Prop}`]
-    : LookupAlpha2<
-        T,
-        AfterFirst<Lookup>,
-        Prop
-      >;
-
-
-type LookupAlpha3<
-  T extends Iso3166_1_Alpha3,
-  Lookup extends readonly { name: string; alpha2: string; alpha3: string; countryCode: string }[],
-  Prop extends Props
-> = [] extends Lookup
-? undefined
-: T extends First<Lookup>["alpha3"]
-    ? First<Lookup>[`${Prop}`]
-    : LookupAlpha3<
-        T,
-        AfterFirst<Lookup>,
-        Prop
-      >;
-
-type LookupCountryCode<
-  T extends Iso3166_1_CountryCode,
-  Lookup extends readonly { name: string; alpha2: string; alpha3: string; countryCode: string }[],
-  Prop extends Props
-> = [] extends Lookup
-? undefined
-: T extends First<Lookup>["countryCode"]
-    ? First<Lookup>[`${Prop}`]
-    : LookupCountryCode<
-        T,
-        AfterFirst<Lookup>,
-        Prop
-      >;
-
-type LookupCountryName<
-T extends Iso3166_1_CountryName,
-Lookup extends readonly { name: string; alpha2: string; alpha3: string; countryCode: string }[],
-Prop extends Props
-> = [] extends Lookup
-? undefined
-: T extends First<Lookup>["name"]
-  ? First<Lookup>[`${Prop}`]
-  : LookupCountryName<
-      T,
-      AfterFirst<Lookup>,
-      Prop
-    >;
-
-/**
- * **Iso3166Country**`<T>`
- *
- * Provides the ISO3166-1 **country name** if provided a valid lookup value (
- * aka, a alpha-2, alpha-3, or country code). If not valid returns _undefined_.
- */
-export type Iso3166CountryLookup<T> = T extends number
-? Iso3166CountryLookup<`${T}`>
-: T extends string
-  ? IsStringLiteral<T> extends true
-  ? T extends Iso3166_1_Alpha2
-    ? LookupAlpha2<T, Iso3166_1_Lookup, "name">
-    : T extends Iso3166_1_Alpha3
-    ? LookupAlpha3<T, Iso3166_1_Lookup, "name">
-    : T extends Iso3166_1_CountryCode
-    ? LookupCountryCode<T, Iso3166_1_Lookup, "name">
-    : T extends Iso3166_1_CountryName
-    ? LookupCountryName<T, Iso3166_1_Lookup, "name">
-    : IsStringLiteral<T> extends true
-    ? undefined
-    : If<IsEqual<T, string>, Iso3166_1_CountryCode | undefined, undefined>
-: undefined
-: undefined;
-
-/**
- * **Iso3166Alpha2Lookup**`<T>`
- *
- * Provides the ISO3166-1 **Alpha 2** code if provided a valid lookup value (
- * aka, a alpha-3, country code, or country name). If not valid returns _undefined_.
- */
-export type Iso3166Alpha2Lookup<T> = T extends number
-? Iso3166CountryLookup<`${T}`>
-: T extends string
-  ? IsStringLiteral<T> extends true
-  ? T extends Iso3166_1_Alpha2
-    ? LookupAlpha2<T, Iso3166_1_Lookup, "alpha2">
-    : T extends Iso3166_1_Alpha3
-    ? LookupAlpha3<T, Iso3166_1_Lookup, "alpha2">
-    : T extends Iso3166_1_CountryCode
-    ? LookupCountryCode<T, Iso3166_1_Lookup, "alpha2">
-    : T extends Iso3166_1_CountryName
-    ? LookupCountryName<T, Iso3166_1_Lookup, "alpha2">
-    : IsStringLiteral<T> extends true
-    ? undefined
-    : If<IsEqual<T, string>, Iso3166_1_Alpha2 | undefined, undefined>
-: undefined
-: undefined;
-
-/**
- * **Iso3166Alpha33Lookup**`<T>`
- *
- * Provides the ISO3166-1 **Alpha 3** code if provided a valid lookup value (
- * aka, a alpha-3, country code, or country name). If not valid returns _undefined_.
- */
-export type Iso3166Alpha3Lookup<T> = T extends number
-? Iso3166CountryLookup<`${T}`>
-: T extends string
-  ? IsStringLiteral<T> extends true
-  ? T extends Iso3166_1_Alpha2
-    ? LookupAlpha2<T, Iso3166_1_Lookup, "alpha3">
-    : T extends Iso3166_1_Alpha3
-    ? LookupAlpha3<T, Iso3166_1_Lookup, "alpha3">
-    : T extends Iso3166_1_CountryCode
-    ? LookupCountryCode<T, Iso3166_1_Lookup, "alpha3">
-    : T extends Iso3166_1_CountryName
-    ? LookupCountryName<T, Iso3166_1_Lookup, "alpha3">
-    : IsStringLiteral<T> extends true
-    ? undefined
-    : If<IsEqual<T, string>, Iso3166_1_Alpha3 | undefined, undefined>
-: undefined
-: undefined;
-
-/**
- * **Iso3166Alpha33Lookup**`<T>`
- *
- * Provides the ISO3166-1 **Alpha 3** code if provided a valid lookup value (
- * aka, a alpha-3, country code, or country name). If not valid returns _undefined_.
- */
-export type Iso3166CodeLookup<T> = T extends number
-? Iso3166CountryLookup<`${T}`>
-: T extends string
-  ? IsStringLiteral<T> extends true
-  ? T extends Iso3166_1_Alpha2
-    ? LookupAlpha2<T, Iso3166_1_Lookup, "countryCode">
-    : T extends Iso3166_1_Alpha3
-    ? LookupAlpha3<T, Iso3166_1_Lookup, "countryCode">
-    : T extends Iso3166_1_CountryCode
-    ? LookupCountryCode<T, Iso3166_1_Lookup, "countryCode">
-    : T extends Iso3166_1_CountryName
-    ? LookupCountryName<T, Iso3166_1_Lookup, "countryCode">
-    : IsStringLiteral<T> extends true
-    ? undefined
-    : If<IsEqual<T, string>, Iso3166_1_CountryCode | undefined, undefined>
-: undefined
-: undefined;

package/src/types/string-literals/character-sets/DomainName.ts

@@ -1,56 +0,0 @@
-
-import {
-  TupleToUnion,
-  Mutable,
-  IsStringLiteral,
-  IsDomainName
-} from "inferred-types/dist/types/index";
-import  { TOP_LEVEL_DOMAINS }  from "inferred-types/dist/constants/index";
-
-/**
- * **TLD**
- *
- * A union type of all of the common top-level domains along with many
- * others which are starting to be used. This is _not_ meant to be
- * comprehensive.
- */
-export type TLD = Mutable<
-  TupleToUnion<typeof TOP_LEVEL_DOMAINS>
->;
-
-/**
- * **DnsName**
- *
- * A simple representation of a DNS name.
- *
- * **Related:** `DomainName`, `UrlsFrom`
- */
-export type DnsName = `${string}.${string}`;
-
-/**
- * **DomainName**
- *
- * Designed to represents a DNS name.
- *
- * - Without the use of a generic this simply applies the same type
- * as `DnsName`
- * - When using the generic to _test_ the potential DNS name we can
- * run more validations and return `never` if they do not pass.
- * - When using the generic with a wide `T` you will get `unknown`
- *
- * **Related:** `DnsName`
- */
-export type DomainName<
-  T extends string | null = null
-> = T extends null
-? DnsName
-: T extends string
-? IsStringLiteral<T> extends true
-  ? IsDomainName<T> extends true
-    ? T & DnsName
-    : never
-  : unknown
-: never;
-
-
-

package/src/types/string-literals/character-sets/DotPathFor.ts

@@ -1,46 +0,0 @@
-import { Container, IsArray } from "inferred-types/dist/types/index";
-
-
-type GenNode<
-  K extends string | number,
-  IsRoot extends boolean,
-  IsArray extends boolean
-> = IsArray extends true
-? K extends `${number}`
-  ? IsRoot extends true
-    ? `${K}`
-    : `.${K}`
-  : never
-: IsRoot extends true
-  ? `${K}`
-  : `.${K}`
-
-
-type GenList<
-  TContainer,
-  IsRoot extends boolean = true,
-  K extends keyof TContainer = keyof TContainer
-> = K extends string | number
-? GenNode<K,IsRoot, IsArray<TContainer>> | (
-  TContainer[K] extends object
-    ? `${GenNode<K,IsRoot, IsArray<TContainer>>}${GenList<TContainer[K],false>}`
-    : never
-  )
-: never;
-
-/**
- * **DotPathFor**`<T>`
- *
- * Provides a union of all valid _dot paths_ for the container
- * `T`.
- *
- * - If `T` is _not_ a container then it will resolve to
- * `"" | null` because `T` can not be dereferenced.
- * - If `T` is a _wide_ container than it will resolve to `string | null` as
- * nothing can be determined at design time
- */
-export type DotPathFor<
-  TContainer
-> = TContainer extends Container
-? "" | GenList<TContainer, true>
-: "";

package/src/types/string-literals/character-sets/Hexadecimal.ts

@@ -1,27 +0,0 @@
-import {
-  Suggest,
-  NumericChar,
-} from "inferred-types/dist/types/index";
-
-/**
- * Valid hexadecimal character
- *
- * **Related:** `IsHexadecimal`, `Hexadecimal`, `SuggestHexadecimal`
- */
-export type HexadecimalChar = NumericChar | "A" | "B" | "C" | "D" | "E" | "F" | "a" | "b" | "c" | "d" | "e" | "f";
-
-/**
- * **Hexadecimal**
- *
- * A decent approximation for typing a _hexadecimal_ number representation.
- * For stronger type checking use `IsHexadecimal<T>`
- */
-export type Hexadecimal = `#${HexadecimalChar}${HexadecimalChar}${string}`
-
-
-
-
-/**
- * A string suggestion for hexadecimal types
- */
-export type SuggestHexadecimal = Suggest<"#FFFF" | "#CBDB">;

package/src/types/string-literals/character-sets/Indent.ts

@@ -1,37 +0,0 @@
-
-/**
- * _indentation of 2 spaces_
- *
- * **Related**: `Indent`, `IndentSpaces`, `Indent4`, `IndentTab`
- */
-export type Indent2 = "  ";
-
-/**
- * _indentation of 4 spaces_
- *
- * **Related**: `Indent`, `IndentSpaces`, `Indent2`, `IndentTab`
- */
-export type Indent4 = "    ";
-
-/**
- * _indentation using the tab character_
- *
- * **Related**: `Indent`, `IndentSpaces`, `Indent2`, `Indent4`
- */
-export type IndentTab = "\t";
-
-/**
- * _indentation using 2 or 4 spaces, or the tab character_
- *
- * **Related**: `IndentSpaces`, `Indent2`, `Indent4`, `IndentTab`
- */
-export type Indent = Indent2 | Indent4 | IndentTab;
-
-
-/**
- * _indentation using 2 or 4 spaces_
- *
- * **Related**: `Indent`, `Indent4`, `IndentTab`
- */
-export type IndentSpaces = Indent2 | Indent4;
-

package/src/types/string-literals/character-sets/InlineSvg.ts

@@ -1,8 +0,0 @@
-
-/**
- * **InlineSvg**`<[T]>`
- *
- * meant to represent a string value that appears to be
- * an inline SVG representation.
- */
-export type InlineSvg<T extends string = string> = `<svg${T}</svg>`