inferred-types 0.51.1 → 0.51.2

package/src/types/boolean-logic/operators/NotLength.ts

@@ -1,12 +0,0 @@
-import { If, IsNotEqual, Length } from "inferred-types/dist/types/index";
-
-/**
- * **NotLength**`<T>`
- *
- * Boolean operator which detects whether `T` is _not_ a certain length.
- */
-export type NotLength<T extends readonly unknown[], U extends number> = If<
-  IsNotEqual<Length<T>, U>,
-  true,
-  false
->;

package/src/types/boolean-logic/operators/PhoneOperators.ts

@@ -1,62 +0,0 @@
-import {
-  IsStringLiteral,
-  GetPhoneCountryCode,
-  IsTrue,
-  PhoneNumber,
-  PhoneCountryCode,
-  IsErrorCondition,
-  MaybeError
-} from "inferred-types/dist/types/index";
-
-// BOOLEAN OPERATORS for PHONE TYPES
-
-/**
- * **IsPhoneNumber**`<T>`
- *
- * Boolean operator which tests whether `T` has a
- * type that supports it being a phone number.
- *
- * **Note:**
- *
- * - this utility relies on the using the `PhoneNumber<T>` validation
- * technique to determine that whether it is a phone number but whereas
- * this utility returns `T` _or_ and `ErrorCode` this produces a boolean
- * outcome.
- *
- * **Related:** `PhoneNumber`, `HasPhoneCountryCode`
- */
-export type IsPhoneNumber<T extends string | number> = IsErrorCondition<PhoneNumber<T>> extends true
-  ? false
-  : MaybeError<PhoneNumber<T>> extends true
-  ? boolean
-  : true;
-
-
-/**
- * **HasPhoneCountryCode**`<T>`
- *
- * Boolean operator which validates whether the passed in `T` has a country code leading it (ignoring any leading
- * whitespace):
- *
- * - by default, the country code is not only parsed out of the phone number but also validated against an world
- * wide index of valid country codes
- * - if you want to just validate that user _attempted_ to express a country code then you can change the check by
- * setting `TExplicit` to **false**.
- *
- * **Related:** `IsPhoneNumber`, `PhoneNumber`
- */
-export type HasPhoneCountryCode<
-  TPhone,
-  TExplicit extends boolean = true
-> = TPhone extends string
-? IsStringLiteral<TPhone> extends true
-    ? IsTrue<TExplicit> extends true
-      ? GetPhoneCountryCode<TPhone> extends PhoneCountryCode
-        ? true
-        : false
-      : GetPhoneCountryCode<TPhone> extends ""
-        ? false
-        : true
-: boolean
-: false;
-

package/src/types/boolean-logic/operators/README.md

@@ -1,3 +0,0 @@
-# Operators
-
-Operators are utility functions which return back a `true` or `false` value (with some also returning a `boolean` value if resolution is not possible at design time).

package/src/types/boolean-logic/operators/Returns.ts

@@ -1,16 +0,0 @@
-import {  TypedFunction } from "inferred-types/dist/types/index";
-
-/**
- * **Returns**`<TFn,TExpected>`
- *
- * Boolean type utility which detects whether `TFn` is a function
- * and _extends_ `TExpected` in it's return type.
- */
-export type Returns<
-  TFn,
-  TExpected
-> = TFn extends TypedFunction
-  ? ReturnType<TFn> extends TExpected
-    ? true
-    : false
-  : false;

package/src/types/boolean-logic/operators/ReturnsBoolean.ts

@@ -1,13 +0,0 @@
-import {   IsBoolean, TypedFunction } from "inferred-types/dist/types/index";
-
-/**
- * **ReturnsBoolean**`<T>`
- *
- * Type utility which indicates whether the _return value_ of `T` is
- * a `false` value. Possible values are `true`, `false`, or `boolean`.
- *
- * Note: any non-functions passed in as `T` are always a **false** value
- */
-export type ReturnsBoolean<T> = T extends TypedFunction
-  ? IsBoolean<ReturnType<T>>
-  : false;

package/src/types/boolean-logic/operators/ReturnsFalse.ts

@@ -1,15 +0,0 @@
-import { IsEqual, TypedFunction } from "inferred-types/dist/types/index";
-
-/**
- * **ReturnsTrue**`<T>`
- *
- * Type utility which indicates whether the _return value_ of `T` is
- * a `false` value. Possible values are `true`, `false`, or `boolean`.
- *
- * Note: any non-functions passed in as `T` are removed from the result set
- */
-export type ReturnsFalse<T> = T extends TypedFunction
-  ? ReturnType<T> extends false
-    ? true
-    : IsEqual<ReturnType<T>, boolean> extends true ? boolean : false
-  : false;

package/src/types/boolean-logic/operators/ReturnsTrue.ts

@@ -1,17 +0,0 @@
-import {  TypedFunction } from "inferred-types/dist/types/index";
-
-
-/**
- * **ReturnsTrue**`<T>`
- *
- * Type utility which indicates whether the _return value_ of `T` is
- * a `true` value. Return value are always either `true` or `false`.
- *
- * Note: any non-functions passed in as `T` are always a **false** value
- * and so is a `boolean` value
- */
-export type ReturnsTrue<T> = T extends TypedFunction
-  ? ReturnType<T> extends true
-    ? true
-    : false
-  : false;

package/src/types/boolean-logic/operators/SomeEqual.ts

@@ -1,17 +0,0 @@
-import { IfEqual , AfterFirst, First } from "inferred-types/dist/types/index";
-
-/**
- * **SomeEqual**`<TVal, TList>`
- *
- * A type utility which tests whether `TVal` is exactly equal to an array of values
- * stored in `TList`. Possible results are `true`, `false`. A wide `boolean` type
- * is not possible as equality operator can always be evaluated at design time.
- *
- * **See Also:** `SomeExtend` and `IfSomeEqual`
- */
-export type SomeEqual<
-TList extends readonly unknown[],
-  TVal,
-> = [] extends TList
-? false
-: IfEqual<TVal, First<TList>, true, SomeEqual<AfterFirst<TList>, TVal>>;

package/src/types/boolean-logic/operators/SomeExtend.ts

@@ -1,26 +0,0 @@
-import { AfterFirst, First, If, Extends } from "inferred-types/dist/types/index";
-
-type SomeAcc<
-  TList extends readonly unknown[],
-  TExtend
-> = [] extends TList
-  ? false
-  : If<
-      Extends<First<TList>, TExtend>,
-      true,
-      SomeAcc<
-        AfterFirst<TList>,
-        TExtend
-      >
-    >;
-
-/**
- * **SomeExtend**`<TList, TExtend>`
- *
- * Boolean util which checks whether **some** of the elements
- * in `TList` _extend_ `TExtend`.
- */
-export type SomeExtend<
-  TList extends readonly unknown[],
-  TExtend
-> = SomeAcc<TList,TExtend>;

package/src/types/boolean-logic/operators/StartsWith.ts

@@ -1,54 +0,0 @@
-import {
-  AsString,
-  IsWideType,
-  TupleToUnion,
-  IsEqual
-} from "inferred-types/dist/types/index";
-
-
-type Check<
-  TValue extends string,
-  TComparator extends string | number
->= TValue extends `${TComparator}${string}`
-? true
-: false;
-
-type Process<
-  TValue extends string,
-  TComparator extends string | number | readonly string[]
-> = TComparator extends readonly string[]
-? Check<
-    [TValue] extends [number] ? `${TValue}` : TValue ,
-    TupleToUnion<TComparator>
-  >
-: Check<
-    [TValue] extends [number] ? `${TValue}` : TValue,
-    AsString<TComparator>
-  >;
-
-/**
- * **StartsWith**<TValue, TComparator>
- *
- * A type utility which checks whether `TValue` _starts with_ the
- * value of `TComparator`.
- *
- * - numeric values for `TValue` will be converted into string literals
- * prior to comparison
- * - a tuple value in `TComparator` is allowed and will test whether
- * _any_ of the patterns start `TValue`
- * - a union type for `TComparator` is allowed so long as it's only for a single character
- *    - this can be much more type efficient for unions with lots of characters
- *    - if you need larger pattern matches then use a Tuple for `TComparator`
- */
-export type StartsWith<
-  TValue extends string | number,
-  TComparator extends string | number | readonly string[]
-> = [IsWideType<TValue>] extends [true]
-? boolean
-: [IsWideType<TComparator>] extends [true]
-? boolean
-: IsEqual<Process<AsString<TValue>, TComparator>, boolean> extends true
-  ? true
-  : Process<AsString<TValue>, TComparator>;
-
-

package/src/types/boolean-logic/operators/UnionHasArray.ts

@@ -1,22 +0,0 @@
-import { HasArray, IsUnion, UnionToTuple } from "inferred-types/dist/types/index";
-
-
-type Process<
-  T extends readonly unknown[]
-> = HasArray<T> extends true
-? true
-: false;
-
-
-/**
- * **UnionHasArray**`<T>`
- *
- * A boolean operator which tests whether T is:
- *
- * - indeed a _union_ type
- * - and that one of the elements of the union is an array
- * of some sort.
- */
-export type UnionHasArray<T> = IsUnion<T> extends true
-? Process<UnionToTuple<T>>
-: false;

package/src/types/boolean-logic/operators/Validate.ts

@@ -1,54 +0,0 @@
-import {
-  AsString,
-  ErrorCondition,
-  IsBoolean,
-  IsFalse,
-  IsTrue,
-  IsWideType,
-  LogicFunction,
-} from "inferred-types/dist/types/index";
-
-
-type WideBooleanNotAllowed = ErrorCondition<
-  "wide-boolean-not-allowed",
-  `Call to Validate<T,E> received a wide boolean type for T!`
->;
-
-type WideReturnNotAllowed<T> = ErrorCondition<
-  "wide-return-not-allowed",
-  `Call to Validate<T,E> returned a wide type: ${AsString<T>}!`
->;
-
-
-/**
- * **Validate**`<T,[E]>`
- *
- * Branching utility which proxies through the value of `T` when it is
- * **not** `false` or _returns_ false, otherwise it passes along `E`.
- *
- * - `E` by default is _never_
- * - if `T` is a wide boolean type an `ErrorCondition<"wide-boolean-not-allowed">`
- * will be returned
- *
- * ```ts
- * const fn = <T extends string>(dp: T & Validate<IsDotPath<T>>) => {}
- * ```
- */
-export type Validate<
-  TTest,
-  TErr = never
-> = [IsTrue<TTest>] extends [true]
-  ? TTest
-  : [IsFalse<TTest>] extends [true]
-  ? TErr
-  : [IsBoolean<TTest>] extends [true]
-  ? WideBooleanNotAllowed
-  : [TTest] extends [LogicFunction]
-    ? [IsTrue<ReturnType<TTest>>] extends [true]
-      ? TTest
-    : [IsFalse<ReturnType<TTest>>] extends [true]
-      ? TErr
-    : WideBooleanNotAllowed
-  : [IsWideType<TTest>] extends [true]
-    ? WideReturnNotAllowed<TTest>
-    : TTest;

package/src/types/boolean-logic/operators/YouTube-operators.ts

@@ -1,68 +0,0 @@
-import { YouTubeVideoUrl, YouTubeUrl, IsStringLiteral, GetUrlQueryParams, YouTubePlaylistUrl } from "inferred-types/dist/types/index";
-
-type VideoUrlKind ="single-video" | "video-in-playlist" | "both";
-
-/**
- * **IsYouTubeUrl**`<T>`
- *
- * Boolean operator which returns _true_ when the string is a
- * possible YouTube URL.
- */
-export type IsYouTubeUrl<T> = [T] extends [string]
-? [IsStringLiteral<T>] extends [true]
-  ? [T] extends [YouTubeUrl]
-    ? true
-    : false
-  : boolean
-: false;
-
-type _VideoKind<
-  TQueryParams extends string,
-  TKind extends VideoUrlKind
-> = TQueryParams extends `${string}list=${string}`
-? TKind extends "single-video"
-  ? false
-  : true
-: TKind extends "video-in-playlist"
-  ? false
-  : true;
-
-
-/**
- * **IsYouTubeVideoUrl**`<TTest,[TKind]>`
- *
- * Boolean operator which returns _true_ when the string is a
- * possible YouTube URL which is for playing a video.
- *
- * **Note:** by default any URL which plays a video is allowed but
- * you can change `TKind` to "single-video" or "video-in-playlist"
- * to isolate to just one of the play styles.
- *
- * **Related:** `IsYouTubeUrl`, `YouTubeVideoUrl`
- */
-export type IsYouTubeVideoUrl<
-  TTest,
-  TKind extends VideoUrlKind = "both"
-> = [TTest] extends [string]
-? [IsStringLiteral<TTest>] extends [true]
-  ? [TTest] extends [YouTubeVideoUrl]
-    ? _VideoKind<GetUrlQueryParams<TTest>, TKind>
-    : false
-  : boolean
-: false;
-
-
-/**
- * **IsYouTubeUrl**`<T>`
- *
- * Boolean operator which returns _true_ when the string is a
- * possible YouTube URL.
- */
-export type IsYouTubePlaylist<T> = [T] extends [string]
-? [IsStringLiteral<T>] extends [true]
-  ? [T] extends [YouTubePlaylistUrl]
-    ? true
-    : false
-  : boolean
-: false;
-

package/src/types/boolean-logic/operators/index.ts

@@ -1,103 +0,0 @@
-export * from "./ApiOperators";
-export * from "./AllExtend";
-export * from "./AllLiteral";
-export * from "./AreSameType";
-export * from "./AllStringLiterals";
-export * from "./AllNumericLiterals";
-export * from "./Contains";
-export * from "./ContainsAll";
-export * from "./DoesExtend";
-export * from "./Extends";
-export * from "./DoesNotExtend";
-export * from "./ExtendsAll";
-export * from "./ExtendsSome";
-export * from "./ExtendsNone";
-export * from "./EndsWith";
-export * from "./SomeEqual";
-export * from "./SomeExtend";
-export * from "./NarrowlyContains";
-export * from "./Returns";
-export * from "./ReturnsTrue";
-export * from "./ReturnsFalse";
-export * from "./NotEqual";
-export * from "./StartsWith";
-export * from "./HasParameters";
-export * from "./HasUnionType";
-export * from "./HasSameValues";
-export * from "./IsNegativeNumber";
-export * from "./IsVueRef";
-export * from "./IsNarrowingFn";
-export * from "./IsLiteralFn";
-export * from "./IsValidIndex";
-export * from "./IsObjectLiteral";
-export * from "./IsTuple";
-export * from "./IsNothing";
-export * from "./IsGreaterThan";
-export * from "./IsLessThan";
-export * from "./IsDotPath";
-export * from "./IsSingularNoun";
-export * from "./IsAllLowercase";
-export * from "./IsAllCaps";
-export * from "./IsSingleChar";
-export * from "./IsDefined";
-export * from "./IsOptionalScalar";
-export * from "./IsObject";
-export * from "./IsLength";
-export * from "./IsScalar";
-export * from "./IsEmptyObject";
-export * from "./IsLiteral";
-export * from "./IsUndefined";
-export * from "./IsWideType";
-export * from "./IsBoolean";
-export * from "./IsTrue";
-export * from "./IsFalse";
-export * from "./IsFalsy";
-export * from "./IsStringLiteral";
-export * from "./IsNumericLiteral";
-export * from "./IsBooleanLiteral";
-export * from "./IsEqual";
-export * from "./IsUnion";
-export * from "./IsUnionArray";
-export * from "./IsArray";
-export * from "./IsReadonlyArray";
-export * from "./IsNull";
-export * from "./IsSymbol";
-export * from "./IsNumber";
-export * from "./IsErrorCondition";
-export * from "./IsNever";
-export * from "./IsTruthy";
-export * from "./IsString";
-export * from "./IsEqual";
-export * from "./IsNotEqual";
-export * from "./IsFunction";
-export * from "./IsFnWithParams";
-export * from "./IsContainer";
-export * from "./NotLength";
-export * from "./HasCharacters";
-export * from "./HasOtherCharacters";
-export * from "./IsReadonlyObject";
-export * from "./AreSameLength";
-export * from "./HasWideValues";
-export * from "./HasProp";
-export * from "./Validate"
-export * from "./HasSameKeys"
-export * from "./HasIndex"
-export * from "./IsWideUnion";
-export * from "./IsLiteralUnion";
-export * from "./IsNonLiteralUnion";
-export * from "./HasRequiredProps";
-export * from "./IsValidDotPath";
-export * from "./IsCssHexadecimal";
-export * from "./IsFloat";
-export * from "./IsInteger";
-export * from "./IsUrl";
-export * from "./Network-operators";
-export * from "./PhoneOperators";
-export * from "./IsUnset";
-export * from "./IsEmptyString"
-export * from "./IsPositiveNumber"
-export * from "./HaveSameNumericSign"
-export * from "./HasArray"
-export * from "./UnionHasArray"
-export * from "./MaybeError"
-export * from "./IsNumberLike";

package/src/types/classes/Constructor.ts

@@ -1,10 +0,0 @@
- 
-
-/**
- * Define a class constructor; allowing strong typing for constructor's parameters
- * and the returned class structure.
- */
-export type Constructor<
-  Ctor extends readonly unknown[] = readonly unknown[], 
-  Klass = any
-> = new (...props: Ctor) => Klass;

package/src/types/classes/KlassMeta.ts

@@ -1,28 +0,0 @@
- 
-
-
-/**
- * **KlassMeta**`<T>`
- * 
- * Given a class constructor `CTor`, this will return a tuple:
- * 
- * ```ts
- * {
- *  args: ConstructorParams<CTor>,
- *  instance: InstanceType<CTor>,
- *  class_decorators: ClassDecoratorContext<CTor>,
- *  field_decorators: ClassFieldDecoratorContext<CTor>
- * }
- * ```
- */
-export type KlassMeta<
-  CTor extends abstract new (...args: any[]) => any
-> = CTor extends abstract new (...args: infer P) => infer R 
-  ? {
-      params: P;
-      instance: R;
-      class_decorators: ClassDecoratorContext<CTor>;
-      field_decorators: ClassFieldDecoratorContext<CTor>;
-  }
-  : never;
-

package/src/types/classes/index.ts

@@ -1,2 +0,0 @@
-export * from "./Constructor";
-export * from "./KlassMeta";

package/src/types/containers/IsEmptyContainer.ts

@@ -1,21 +0,0 @@
-import { Container,    ExplicitlyEmptyObject,  Dictionary,  Keys } from "inferred-types/dist/types/index";
-
-/**
- * **EmptyContainer**`<T>`
- *
- * Boolean utility which tests whether a container is "empty"
- * (meaning it has no keys).
- *
- * **Related:** `NonEmptyContainer`
- */
-export type IsEmptyContainer<
-  T extends Container
-> = T extends Dictionary
-  ? T extends ExplicitlyEmptyObject
-    ? true
-    : Keys<T>["length"] extends 0
-      ? true
-      : false
-  : Keys<T>["length"] extends 0
-  ? true
-  : false;

package/src/types/containers/IsNonEmptyContainer.ts

@@ -1,15 +0,0 @@
-import { IsEmptyContainer } from "./IsEmptyContainer";
-
-import { Container } from "inferred-types/dist/types/index";
-
-/**
- * **NonEmptyContainer**`<T>`
- *
- * Boolean utility which tests whether a container has keys
- * (aka, is not "empty")
- *
- * **Related:** `EmptyContainer`
- */
-export type IsNonEmptyContainer<
-  T extends Container
-> = IsEmptyContainer<T> extends true ? false : true;

package/src/types/containers/RemoveEmpty.ts

@@ -1,78 +0,0 @@
-import { Marked } from "inferred-types/dist/constants/index";
-
-import {
-  As,
-  Container,
-  Dictionary,
-  EmptyObject,
-  Tuple,
-  IsEmptyString,
-  IsNever,
-  IsNull,
-  IsUndefined,
-  Or,
-  IsEmptyContainer,
-  RemoveMarked,
-  Keys,
-  AfterFirst, First
-} from "inferred-types/dist/types/index";
-
-
-type IsEmpty<T> = Or<[
-  IsNull<T>,
-  T extends Container ? IsEmptyContainer<T> : false,
-  IsEmptyString<T>,
-  IsUndefined<T>,
-  IsNever<T>,
-]> extends true ? true : false;
-
-
-type ProcessTup<
-  T extends Tuple,
-  Result extends Tuple =[]
-> = [] extends T
-? Result
-: ProcessTup<
-    AfterFirst<T>,
-    [
-      ...Result,
-      IsEmpty<First<T>> extends true ? Marked : First<T>
-    ]
-  >;
-
-type ProcessObj<
-    TObj extends Dictionary,
-    TKeys extends readonly (keyof TObj)[],
-    TResult extends Dictionary = EmptyObject
-> = [] extends TKeys
-? TResult
-: ProcessObj<
-    TObj,
-    AfterFirst<TKeys>,
-    IsEmpty<First<TKeys>> extends true
-      ? TResult & Record<First<TKeys>, TObj[First<TKeys>]>
-      : TResult
-  >
-
-
-
-/**
- * **RemoveEmpty**
- *
- * A _container_ utility looks at all immediate keys of the
- * container and removes all which are "empty". Being empty means:
- *
- * - is either `null`, `undefined`, or `never`
- * - has an _empty string literal_ of `""`
- * - is an empty container
- *
- * For any value `T` which is not a container nor a union type, the value
- * is just passed through.
- */
-export type RemoveEmpty<T> = T extends Tuple
-? As<RemoveMarked<ProcessTup<T>>, readonly unknown[]>
-: T extends Dictionary
-? As<RemoveMarked<ProcessObj<T, Keys<T>>>, Dictionary>
-: T;
-
-