inferred-types 0.51.1 → 0.51.2

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

@@ -1,161 +0,0 @@
-import {
-  AsString,
-  HexadecimalChar,
-  IsStringLiteral,
-  NumericChar,
-  NumericCharZeroToFive,
-  ReplaceAll,
-  StripTrailing,
-  Suggest,
-  UnionToTuple
-} from "inferred-types/dist/types/index";
-import  { IPv6 } from "inferred-types/dist/constants/index";
-
-/**
- * **IPv4Number**
- *
- * A high resolution typing for a single octet of an **IP version 4** IP address.
- */
-export type Ip4Octet =
-| `25${NumericCharZeroToFive}`
- | `24${NumericChar}`
- | `23${NumericChar}`
- | `22${NumericChar}`
- | `21${NumericChar}`
- | `20${NumericChar}`
- | `1${NumericChar}${NumericChar}`
- | `${NumericChar}${NumericChar}`
- | `${NumericChar}`;
-
-
-export type Ip4NetmaskSuggestion<TVlan extends readonly number[] = [1,10]> = Suggest<[
-  `10.0.0.0/8`,
-  `192.168.0.0/16`,
-  `172.16.0.0/16`,
-  `10.10.${AsString<UnionToTuple<TVlan>>}.0/24`,
-  `192.168.${AsString<UnionToTuple<TVlan>>}.0/24`,
-  `172.16.${AsString<UnionToTuple<TVlan>>}.0/24`,
-]>;
-
-export type Ip4Netmask8 = `${Ip4Octet}.0.0.0/8`;
-export type Ip4Netmask16 = `${Ip4Octet}.${number}.0.0/16`;
-export type Ip4Netmask24 = `${Ip4Octet}.${number}.${number}.0/24`;
-export type Ip4Netmask32 = `${number}.${number}.${number}.${number}/32`;
-
-/**
- * **Ip4Netmask**
- *
- * A type which includes patterns for `/8`, `/16`, `/24`, and `/32` netmasks
- */
-export type Ip4Netmask = Ip4Netmask8 | Ip4Netmask16 | Ip4Netmask24 | Ip4Netmask32;
-
-
-/**
-* the range of IPv6 addresses which are considered **multicast**.
-*/
-export type IP6Multicast = typeof IPv6["Multicast"];
-
-/**
-* the range of IPv6 addresses which are considered **unicast**.
-*/
-export type IP6Unicast = typeof IPv6["Unicast"];
-
-export type Ip6Loopback = typeof IPv6["Loopback"];
-
-export type Ip6Group = `${HexadecimalChar}${string}`;
-
-
-/**
- * **Ipv4**
- *
- * A simple representation of an IPv4 address
- */
-export type Ip4Address = `${number}.${number}.${number}.${number}`;
-
-
-export type Ip6AddressFull = `${string}:${string}:${string}:${string}:${string}:${string}:${string}:${string}`;
-
-export type Ip6AddressLoose = `${HexadecimalChar}${string}:${string}`
-
-/**
- * **Ip6GroupExpansion**`<T>`
- *
- * Expands an IPv6's address by changing
- */
-export type Ip6GroupExpansion<T> = T extends string
-? IsStringLiteral<T> extends true
-  ? StripTrailing<ReplaceAll<T,"::", ":0000:">, ":">
-  : string
-: never;
-
-
-
-/**
- * An IPv6 Address
- *
- * **Notes:**
- *
- * - a full representation is 8 groups of 4 hexadecimal characters and
- * is _rarely_ used as it's just way too much specificity for most situations.
- * It is also impossible to type this in a strong manner due to the huge optionality.
- * - in a full representation you may drop the leading 0's (and it's considered
- * best practice to do so)
- * - if one of the groups is all zeros you can simply express it as `::`
- *
- * Rather than expressing a _specific_ IPv6 address the more common thing
- * is to express an **IP subnet** owned by an organization or an individual.
- *
- * **Related:** `Ip6Subnet`
- */
-export type Ip6Address =
-| `${string}:${string}:${string}:${string}:${string}:${string}:${string}:${string}`
-| `${string}::${string}:${string}:${string}:${string}:${string}:${string}`
-| `${string}:${string}::${string}:${string}:${string}:${string}:${string}`
-| `${string}:${string}:${string}::${string}:${string}:${string}:${string}`
-| `${string}:${string}:${string}:${string}::${string}:${string}:${string}`
-| `${string}:${string}:${string}:${string}:${string}::${string}:${string}`
-| `${string}:${string}:${string}:${string}:${string}:${string}::${string}`
-| `${string}:${string}:${string}:${string}:${string}:${string}:${string}::`;
-
-
-
-export type Ip6SubnetPrefix = `${string}:${string}:${string}:${string}`;
-
-export type AsIp6Prefix<
-  T extends readonly Ip6Group[]
-> = T extends [Ip6Group]
-? `${T[0]}:${string}:${string}:${string}`
-: T extends [Ip6Group,Ip6Group]
-? `${T[0]}:${T[1]}:${string}:${string}`
-: T extends [Ip6Group,Ip6Group,Ip6Group]
-? `${T[0]}:${T[1]}:${T[2]}:${string}`
-: T extends [Ip6Group,Ip6Group,Ip6Group,Ip6Group,...Ip6Group[]]
-? `${T[0]}:${T[1]}:${T[3]}:${T[4]}`
-: `${string}:${string}:${string}:${string}`;
-
-/**
- * An IPv6 subnet.
- *
- * When an organization or even an individual receives IPv6 addresses they almost
- * always receive MANY ip addresses (aka, a subnet of addresses). The most
- * common subnet masks are `48` (for organizations) and `64` for individuals.
- *
- * ```ts
- * // 2001:db8:1:1::/64
- * IpSubnet<"2001:db8:1:1",64>
- * ```
- */
-export type Ip6Subnet<
-  TPrefix extends Ip6SubnetPrefix = Ip6SubnetPrefix,
-  TMask extends number = number
-> = `${TPrefix}::/${TMask}`;
-
-
-/**
- * **SuggestIpAddress**
- *
- * Some simple examples of IP addresses which can be given as a
- * suggested set of string where people need to enter an **IPv4**
- * address.
- */
-export type SuggestIpAddress = Suggest<"192.168.1.1" | "10.10.1.1" | "172.168.1.1">;

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

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

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

@@ -1,10 +0,0 @@
-import  { LOWER_ALPHA_CHARS } from "inferred-types/dist/constants/index";
-
-/**
- * **LowerAlphaChar**
- *
- * Lowercase alphabetic character.
- *
- * **Related:** `AlphaChar`, `UpperAlphaChar`, `LowerAlpha`
- */
-export type LowerAlphaChar =typeof LOWER_ALPHA_CHARS[number];

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

@@ -1,7 +0,0 @@
-import { Bracket, NumericChar, Punctuation, SpecialChar, Whitespace } from "inferred-types/dist/types/index";
-
-
-/**
- * Non-alphabetic characters including whitespace, string numerals, and
- */
-export type NonAlphaChar = Whitespace | Punctuation | NumericChar | Bracket | SpecialChar;

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

@@ -1,33 +0,0 @@
-import type {
-  NON_ZERO_NUMERIC_CHAR,
-  NUMERIC_CHAR
-} from "inferred-types/dist/constants/index";
-
-/**
- * **NumericChar**
- *
- * Numeric string characters.
- *
- * **Related:** `NUMERIC_CHAR`, `Digit`
- */
-export type NumericChar = typeof NUMERIC_CHAR[number];
-
-/**
- * **NonZeroNumericChar**
- *
- * Numeric string characters with the exception of "0".
- */
-export type NonZeroNumericChar = typeof NON_ZERO_NUMERIC_CHAR[number];
-
-
-export type NumericCharZeroToOne = "0" | "1" ;
-export type NumericCharZeroToTwo = "0" | "1" | "2" ;
-export type NumericCharZeroToThree = "0" | "1" | "2" | "3" ;
-export type NumericCharZeroToFour = "0" | "1" | "2" | "3" | "4";
-export type NumericCharZeroToFive = "0" | "1" | "2" | "3" | "4" | "5";
-
-
-export type NumericCharOneToTwo =  "1" | "2" ;
-export type NumericCharOneToThree =  "1" | "2" | "3" ;
-export type NumericCharOneToFour =  "1" | "2" | "3" | "4";
-export type NumericCharOneToFive =  "1" | "2" | "3" | "4" | "5";

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

@@ -1,48 +0,0 @@
-import { AfterFirst, First } from "inferred-types/dist/types/index";
-
-type Cascade<
-  T extends readonly string[],
-  TResult extends string = ""
-> = [] extends T
-? TResult
-: Cascade<
-    AfterFirst<T>,
-    `${TResult}${First<T> | ""}`
-  >;
-
-
-/**
- * **Optional**`<T>`
- *
- * String literal utility which makes the text `T` either present
- * or just an _empty string_ (aka, "optional").
- *
- * - if you send in an array of strings they will build a
- * string literal up left-to-right.
- */
-export type Optional<
-  T extends string | readonly string[]
-> = T extends readonly string[]
-? Cascade<T>
-: T | "";
-
-
-/**
- * **Opt**`<T>`
- *
- * > _alias for `Optional<T>`_
- *
- * String literal utility which makes the text `T` either present
- * or just an _empty string_ (aka, "optional").
- *
- * - if you send in an array of strings they will build a
- * string literal up left-to-right.
- */
-export type Opt<T extends string | readonly string[]> =
-Optional<T>;
-
-
-/**
- * an _optional_ percentage symbol
- */
-export type OptPercent = "%" | "";

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

@@ -1,22 +0,0 @@
-/**
- * **OptionalSpace**
- *
- * Allows for an optional space to be included
- */
-export type OptionalSpace = "" | " ";
-
-/**
- * @alias `OptionalSpace`
- */
-export type OptSpace = OptionalSpace;
-
-/**
- * _zero, one, or two_ **space** characters
- */
-export type OptSpace2 = OptionalSpace | "  ";
-
-
-/**
- * **0** _to_ **4** _space_ characters
- */
-export type OptSpace4 = OptionalSpace |  "   " |  "    ";

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

@@ -1 +0,0 @@
-export type PlusMinus = "+" | "-";

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

@@ -1,9 +0,0 @@
-
-/**
- * **Punctuation**
- * 
- * Common punctuation characters found in prose.
- * 
- * **Related:** `Whitespace`, `Alpha`, `Bracket`, `QuotationMark`
- */
-export type Punctuation = "." | "," | ";" | "!" | "?";

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

@@ -1,54 +0,0 @@
-import {
-  Mutable,
-  TupleToUnion,
-  OptionalSpace,
-  Values,
-  Flatten,
-  UrlsFrom,
-} from "inferred-types/dist/types/index";
-import  {  REPO_PAGE_TYPES, REPO_SOURCES, REPO_SOURCE_LOOKUP } from "inferred-types/dist/constants/index";
-
-/**
- * **RepoSources**
- *
- * common sources for source code repositories.
- */
-export type RepoSource = TupleToUnion<Mutable<typeof REPO_SOURCES>>;
-
-/**
- * **RepoPageType**
- *
- * a union of descriptive page names you'd expect to find in a source
- * code repository.
- */
-export type RepoPageType = TupleToUnion<Mutable<typeof REPO_PAGE_TYPES>>;
-
-export type RepoUrls = UrlsFrom<Flatten<
-  Mutable<Values<typeof REPO_SOURCE_LOOKUP>>
->>;
-
-/**
- * **SemanticVersion**`<[TAllowPrefix]>`
- *
- * Provides a type for _sematic versions_.
- *
- * - by default it not only allows the `${major}.${minor}.${patch}` nomenclature
- * but also _optionally_ allows a prefix of `v`:
- *    - `0.10.1` - valid
- *    - `v0.10.1` - also valid
- *    - `v 0.10.1` - also valid
- * - this prefixing can be disabled by setting `TPrefix` to false
- */
-export type SemanticVersion<
-  TPrefix extends boolean = true
-> = `${[TPrefix] extends [true] ? `${"v" | ""}${OptionalSpace}` : ""}${number}.${number}.${number}`
-
-
-/**
- * **GitRef**
- *
- * A type that provides the basic shape of a non-HTTP reference
- * to a Git repository.
- */
-export type GitRef = `git@${string}.${string}:${string}.git`
-

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

@@ -1,37 +0,0 @@
-import  { SINGULAR_NOUN_ENDINGS } from "inferred-types/dist/constants/index";
-import { AlphaChar , TupleToUnion, Mutable,  Chars, AllExtend, If } from "inferred-types/dist/types/index";
-/**
- * **SingularNounEnding**
- *
- * A union of characters which when found at the end of a word are a strong
- * indicator that the word is a singular noun.
- *
- * **Related:** `SingularNoun`, `IsSingularNoun`
- */
-export type SingularNounEnding = TupleToUnion<Mutable<typeof SINGULAR_NOUN_ENDINGS>>;
-
-/**
- * **SingularNoun**`<T>`
- *
- * Type utility which provides an _identity_ mapping to `T` for singular nouns but maps
- * to _never_ in all other cases.
- *
- * Singular nouns are words which contain only `Alpha` characters and end in one of the
- * character sequences specified in `SingularNounEnding`.
- *
- * ```ts
- * // never
- * type T1 = SingularNoun<"foobar">;
- * // rush
- * type T2 = SingularNoun<"rush">;
- * ```
- *
- * **Related:** `IsSingularNoun`
- */
-export type SingularNoun<T extends string> = T extends `${infer Prelude}${SingularNounEnding}`
-  ? If<
-      AllExtend<Chars<Prelude>, AlphaChar>,
-      T,
-      never
-    >
-  : never;

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

@@ -1,5 +0,0 @@
-
-/**
- * **SpecialChar**
- */
-export type SpecialChar = "@" | "~" | "^" | "#" | "&" | "*";

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

@@ -1,5 +0,0 @@
-
-/**
- * Characters which typically are used to separate words (but not including a space)
- */
-export type StringDelimiter = "_" | "-" | "/" | "\\";

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

@@ -1,10 +0,0 @@
-import { UPPER_ALPHA_CHARS } from "inferred-types/dist/constants/index";
-
-/**
- * **UpperAlphaChar**
- *
- * Uppercase alphabetic character.
- *
- * **Related:** `AlphaChar`, `LowerAlphaChar`, `UpperAlpha`
- */
-export type UpperAlphaChar = typeof UPPER_ALPHA_CHARS[number];

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

@@ -1,61 +0,0 @@
-import {
-  AfterFirst,
-  First,
-  Split,
-  IsValidDotPath,
-  Container,
-  IsVueRef,
-  AsRef,
-  IsLiteral,
-  IsStringLiteral
-} from "inferred-types/dist/types/index";
-
-
-type Process<
-    TContainer extends Container,
-    TIndexes extends readonly string[]
-> = [] extends TIndexes
-  ? TContainer
-  : First<TIndexes> extends keyof TContainer
-    ? TContainer[First<TIndexes>] extends Container
-      ? Process<
-          TContainer[First<TIndexes>],
-          AfterFirst<TIndexes>
-        >
-      : AfterFirst<TIndexes>["length"] extends 0
-        ? TContainer[First<TIndexes>]
-        : false
-    : IsVueRef<TContainer> extends true
-      ? First<TIndexes> extends keyof AsRef<TContainer>["value"]
-        ? TIndexes["length"] extends 1
-          ? AsRef<TContainer>["value"][First<TIndexes>]
-          : AsRef<TContainer>["value"][First<TIndexes>] extends Container
-            ? Process<
-                AsRef<TContainer>["value"][First<TIndexes>],
-                AfterFirst<TIndexes>
-              >
-            : AfterFirst<TIndexes>["length"] extends 0
-              ? AsRef<TContainer>["value"][First<TIndexes>]
-              : false
-        : false
-      : false; // not a ref
-
-
-export type ValueAtDotPath<
-  TValue extends Container,
-  TPath extends string
-> = [IsValidDotPath<TValue,TPath>] extends [true]
-? IsLiteral<TValue> extends true
-  ? IsStringLiteral<TPath> extends true
-    ? Split<TPath,"."> extends readonly string[]
-      ? Process<
-          TValue,
-          Split<TPath,".">
-        >
-      : never
-    : string
-  : string
-: never;
-
-
-

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

@@ -1,20 +0,0 @@
-import { AlphaNumericChar } from "./AlphaNumeric";
-
-
-/**
- * **VariableChar**
- * 
- * Characters allowed in a variable name.
- * 
- * **Related:** `PropertyChar`
- */
-export type VariableChar = AlphaNumericChar | "_" | ".";
-
-/**
- * **VariableChar**
- * 
- * Characters allowed as an object property name.
- * 
- * **Related:** `VariableChar`
- */
-export type PropertyChar = VariableChar | "-";

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

@@ -1,19 +0,0 @@
-import {
-  WHITESPACE_CHARS
-} from "inferred-types/dist/constants/index";
-
-/**
- * **Whitespace**
- *
- * Characters typically representing "white space"
- *
- * **Related:** `OptWhitespace`
- */
-export type Whitespace = typeof WHITESPACE_CHARS[number];
-
-/**
- * Allows for a whitespace character (optionally)
- *
- * **Related:** `Whitespace`
- */
-export type OptWhitespace = Whitespace | "";