inferred-types 0.51.1 → 0.51.3

package/src/runtime/tsconfig.json

@@ -1,47 +0,0 @@
-{
-  "references": [
-    {
-      "path": "../constants"
-    },
-    {
-      "path": "../types"
-    }
-  ],
-  "compilerOptions": {
-    "strict": true,
-    "skipLibCheck": true,
-    "module": "ES2022",
-    "target": "ESNext",
-    "moduleResolution": "node",
-    "declaration": true,
-    "declarationMap": true,
-    "baseUrl": ".",
-    "rootDir": "..",
-    "outDir": "../../dist",
-    "composite": true,
-    "forceConsistentCasingInFileNames": true,
-    "paths": {
-      "src/types/index": [
-        "../types/index.ts"
-      ],
-      "inferred-types/dist/types/index": [
-        "../types/index.ts"
-      ],
-      "inferred-types/dist/constants/index": [
-        "../constants/index.ts"
-      ],
-      "src/runtime/index": [
-        "../runtime/index.ts"
-      ],
-      "inferred-types/dist/runtime/index": [
-        "../runtime/index.ts"
-      ],
-    },
-  },
-  "include": [
-    "**/*.ts",
-  ],
-  "exclude": [
-    "node_modules"
-  ]
-}

package/src/runtime/type-conversion/asChars.ts

@@ -1,10 +0,0 @@
-import { Chars } from "inferred-types/dist/types/index";
-
-/**
- * **asChars**`(str)`
- *
- * Converts a string into an array of characters.
- */
-export const asChars = <T extends string>(str: T): Chars<T> => {
-  return str.split("") as Chars<T>;
-}

package/src/runtime/type-conversion/asRecord.ts

@@ -1,14 +0,0 @@
-import { AsRecord, ObjectKey } from "inferred-types/dist/types/index";
-
-/**
- * **asRecord**`<T>`(obj: T) → AsRecord`<T>`
- *
- * An "identity function" with regards to runtime information but
- * helps convert a `object` to a `Record<ObjectKey,unknown>` which
- * is indexable.
- */
-export const asRecord = <
-  T extends Record<ObjectKey, unknown> | object
->(obj: T): AsRecord<T> => {
-  return obj as AsRecord<T>;
-}

package/src/runtime/type-conversion/asString.ts

@@ -1,35 +0,0 @@
-import { AsString } from "inferred-types/dist/types/index";
-import { isArray, isBoolean, isNumber, isString} from "src/runtime/index"
-
-/**
- * **asString**`(value)
- *
- * Attempts to convert the value passed in into a string
- * using the same methods available to the type utility
- * `AsString<T>`.
- *
- * If unable to convert to a string then it will provide
- * the runtime value of `String(value)` but the type system
- * will be set to `never`.
- *
- * - if an array is passed in then it will be joined
- * together -- no delimiter characters -- into a string
- * - if a tuple of `SimpleToken[]` is discovered it will
- * set the runtime type to a token of `<<string::...>>` while the
- * type of the string will be
- */
-export const asString = <T>(value: T): AsString<T> => {
-  return (
-    isString(value)
-      ? value
-      : isNumber(value)
-      ? `${value}`
-      : isBoolean(value)
-      ? `${value}`
-      : isArray(value)
-      ? value.join("")
-      : String(value)
-  ) as unknown as AsString<T>;
-}
-
-

package/src/runtime/type-conversion/csv.ts

@@ -1,56 +0,0 @@
-import { Never } from "inferred-types/dist/constants/index";
-import { isNumberLike } from "../type-guards";
-import { CsvToJsonTuple, CsvToTuple, CsvToTupleStr } from "inferred-types/dist/types/index";
-
-export type CsvFormat =
-| "string-tuple"
-| "string-numeric-tuple"
-| "json-tuple";
-
-
-/**
- * **csv**`(csv, [format])`
- *
- * Converts a CSV string literal into a tuple of values
- * (based on format).
- *
- * **Note:** either _no space_ or _a single space_ between values
- * will provide a trimmed value but any additional whitespace
- * after the comma will result in some leading whitespace in
- * some values.
- *
- * @default format `string-numeric-tuple`
- */
-export const csv = <
-  T extends string,
-  F extends CsvFormat = `string-numeric-tuple`
->(
-  csv: T,
-  format: F = `string-numeric-tuple` as F
-) => {
-
-  const tuple: unknown[] = [];
-
-  csv.split(/,\s{0,1}/).forEach(v => {
-    tuple.push(
-      format === "string-numeric-tuple"
-        ? isNumberLike(v) ? Number(v) : v
-        : format === "json-tuple"
-          ? isNumberLike(v)
-            ? Number(v)
-            : v === "true" ? true : v === "false" ? false
-            : `"${v}"`
-        : format === "string-tuple"
-          ? `${v}`
-          : Never
-    )
-  })
-
-  return tuple as F extends "string-numeric-tuple"
-    ? CsvToTuple<T>
-    : F extends "json-tuple"
-    ? CsvToJsonTuple<T>
-    : F extends "string-tuple"
-    ? CsvToTupleStr<T>
-    : never
-}

package/src/runtime/type-conversion/index.ts

@@ -1,18 +0,0 @@
-
-export * from "./mergeObjects";
-export * from "./optional";
-export * from "./mergeScalars";
-export * from "./mergeTuples";
-export * from "./unionize";
-export * from "./intersect";
-export * from "./never";
-export * from "./union";
-export * from "./toNumber";
-export * from "./asRecord";
-export * from "./asString";
-export * from "./asChars";
-export * from "./ip6GroupExpansion";
-export * from "./csv";
-export * from "./lookupCountry";
-export * from "./json";
-

package/src/runtime/type-conversion/intersect.ts

@@ -1,12 +0,0 @@
-/* eslint-disable @typescript-eslint/no-unused-vars */
-
-/**
- * **intersect**(value, intersectedWith)
- * 
- * Runtime utility which receives `value` property and returns it with an
- * unchanged _runtime_ value but with the type now intersected with the
- * value provided by `intersectedWith`.
- */
-export function intersect<T,U>(value: T, intersectedWith: U): T & U {
-  return value as T & U;
-}

package/src/runtime/type-conversion/ip6GroupExpansion.ts

@@ -1,17 +0,0 @@
-import { Ip6GroupExpansion } from "inferred-types/dist/types/index"
-import { stripTrailing } from "../literals/stripTrailing";
-
-/**
- * **ip6GroupExpansion**`(ip)`
- *
- * Looks at the IPv6 address and expands all instances of `::` to add
- * a block of `0000` where it was.
- *
- * ```ts
- * // fe89:0000:1256
- * const ip6 = ip6GroupExpansion("fe89::1256");
- * ```
- */
-export const ip6GroupExpansion = <T extends string>(ip: T) => {
-  return stripTrailing(ip.replaceAll("::", ":0000:"), ":") as Ip6GroupExpansion<T>;
-}

package/src/runtime/type-conversion/json.ts

@@ -1,32 +0,0 @@
-import { JsonValue, JsonValues } from "inferred-types/dist/types/index";
-import { isNumberLike } from "src/runtime/index";
-
-/**
- * **jsonValue**`(val)`
- *
- * Converts a string value to JSON value
- *
- * **Related:** `jsonValues()`
- */
-export const jsonValue = <T>(val: T): JsonValue<T> => {
-  return (
-    isNumberLike(val)
-    ? Number(val)
-    : val === "true"
-    ? true
-    : val === "false"
-    ? false
-    : `"${val}"`
-  ) as unknown as JsonValue<T>
-}
-
-/**
- * **jsonValues**`(values)`
- *
- * Converts string values to JSON values
- *
- * **Related:** `csv`
- */
-export const jsonValues = <T extends unknown[]>(...val: T): JsonValues<T> => {
-  return val.map(i => jsonValue(i)) as unknown[] as JsonValues<T>
-}

package/src/runtime/type-conversion/lookupCountry.ts

@@ -1,242 +0,0 @@
-import { NumberLike } from "inferred-types/dist/types/index";
-import {
-  Iso3166_1_Alpha2,
-  Iso3166_1_Alpha3,
-  Iso3166_1_CountryCode,
-  Iso3166_1_CountryName,
-  Iso3166Alpha2Lookup,
-  Iso3166Alpha3Lookup,
-  Iso3166CodeLookup,
-  Iso3166CountryLookup,
-  Suggest
-} from "inferred-types/dist/types/index";
-import { isIso3166Alpha2, isIso3166Alpha3, isIso3166CountryName, isNumber, isNumberLike } from "../type-guards";
-import { ISO3166_1 } from "inferred-types/dist/constants/index";
-import { AsString } from"inferred-types/dist/types/index";
-import { uppercase } from "../literals";
-
-type Props = "alpha2" | "alpha3" | "countryCode" | "name";
-
-const lookupAlpha2Code = <
-  T extends Iso3166_1_Alpha2,
-  P extends Props
->(
-  code: T,
-  prop: P
-): P extends "name"
-? Iso3166_1_CountryName
-: P extends "alpha2"
-? Iso3166_1_Alpha2
-: P extends "alpha3"
-? Iso3166_1_Alpha3
-: P extends "countryCode"
-? Iso3166_1_CountryCode
-: never => {
-  const found = ISO3166_1.find(i => i["alpha2"]=== code);
-
-  return (
-    found ? found[prop] : undefined
-  ) as unknown as P extends "name"
-  ? Iso3166_1_CountryName
-  : P extends "alpha2"
-  ? Iso3166_1_Alpha2
-  : P extends "alpha3"
-  ? Iso3166_1_Alpha3
-  : P extends "countryCode"
-  ? Iso3166_1_CountryCode
-  : never;
-}
-
-
-const lookupAlpha3Code = <P extends Props>(
-  code: Iso3166_1_Alpha3,
-  prop: P
-): P extends "name"
-? Iso3166_1_CountryName
-: P extends "alpha2"
-? Iso3166_1_Alpha2
-: P extends "alpha3"
-? Iso3166_1_Alpha3
-: P extends "countryCode"
-? Iso3166_1_CountryCode
-: never => {
-  const found = ISO3166_1.find(i => i["alpha3"]=== code);
-
-  return (
-    found ? found[prop] : undefined
-  ) as unknown as P extends "name"
-  ? Iso3166_1_CountryName
-  : P extends "alpha2"
-  ? Iso3166_1_Alpha2
-  : P extends "alpha3"
-  ? Iso3166_1_Alpha3
-  : P extends "countryCode"
-  ? Iso3166_1_CountryCode
-  : never;
-}
-
-const lookupName = <
-  T extends Iso3166_1_CountryName,
-  P extends Props
->(
-  name: T,
-  prop: P
-): P extends "name"
-? Iso3166_1_CountryName
-: P extends "alpha2"
-? Iso3166_1_Alpha2
-: P extends "alpha3"
-? Iso3166_1_Alpha3
-: P extends "countryCode"
-? Iso3166_1_CountryCode
-: never => {
-  const found = ISO3166_1.find(i => i["name"] === name);
-
-  return (
-    found ? found[prop] : undefined
-  ) as unknown as P extends "name"
-  ? Iso3166_1_CountryName
-  : P extends "alpha2"
-  ? Iso3166_1_Alpha2
-  : P extends "alpha3"
-  ? Iso3166_1_Alpha3
-  : P extends "countryCode"
-  ? Iso3166_1_CountryCode
-  : never;
-}
-
-
-const lookupNumericCode = <
-T extends NumberLike,
-P extends Props
->(
-  code: T,
-  prop: P
-): string | undefined => {
-  let num: string = isNumber(code) ? `${code}` : code as `${number}`;
-  if (num.length === 1) {
-    num = `00${num}`
-  } else if (num.length === 2) {
-    num = `0${num}`;
-  }
-
-  const found = ISO3166_1.find(i => i["countryCode"] === num);
-
-  return found ? found[prop] : undefined;
-}
-
-/**
- * **lookupCountryName**`(code)`
- *
- * Looks up a country name by either the alpha-2, alpha-3, or country code
- * as defined by the [ISO3166-1](https://en.wikipedia.org/wiki/ISO_3166-1) standard.
- *
- * - the ISO standard uses uppercase characters for Alpha2 and Alpha3 codes but
- * this utility will handle upper or lowercase
- * - it will correctly type the country name if the code passed in is a literal
- * string (and a valid code)
- *
- * **Related:** `lookupCountryAlpha2()`, `lookupCountryAlpha3()`
- */
-export const lookupCountryName = <T extends Suggest<Iso3166_1_Alpha2 | Iso3166_1_Alpha3 | Iso3166_1_CountryCode>>(
-  code: T
-) => {
-  const uc = uppercase(code);
-
-  return (
-    isNumberLike(code)
-    ? lookupNumericCode(code, "name")
-    : isIso3166Alpha2(uc)
-      ? lookupAlpha2Code(uc, "name")
-      : isIso3166Alpha3(uc)
-      ? lookupAlpha3Code(uc, "name")
-      : undefined
-  ) as unknown as Iso3166CountryLookup<Uppercase<AsString<T>>>;
-}
-
-/**
- * Looks up the Alpha2 component of a [ISO3166-1](https://en.wikipedia.org/wiki/ISO_3166-1)
- * standard.
- */
-export const lookupCountryAlpha2 = <
-  T extends Suggest<Iso3166_1_Alpha3 |
-  Iso3166_1_CountryCode |
-  Iso3166_1_CountryName
->>(
-  code: T
-) => {
-  const uc = uppercase(code);
-
-  return (
-    isNumberLike(code)
-    ? lookupNumericCode(code, "alpha2")
-    : isIso3166Alpha2(uc)
-      ? lookupAlpha2Code(uc, "alpha2")
-      : isIso3166Alpha3(uc)
-      ? lookupAlpha3Code(uc, "alpha2")
-      : isIso3166CountryName(code)
-      ? lookupName(code, "alpha2")
-      : undefined
-  ) as unknown as T extends Iso3166_1_CountryName
-  ? Iso3166Alpha2Lookup<T>
-  : Iso3166Alpha2Lookup<Uppercase<AsString<T>>>;
-}
-
-/**
- * Looks up the Alpha3 component of a [ISO3166-1](https://en.wikipedia.org/wiki/ISO_3166-1)
- * standard.
- */
-export const lookupCountryAlpha3 = <
-  T extends Suggest<
-    Iso3166_1_Alpha2
-  | Iso3166_1_CountryCode
-  | Iso3166_1_CountryName
->>(
-  token: T
-) => {
-  const uc = uppercase(token);
-
-  return (
-    isNumberLike(token)
-    ? lookupNumericCode(token, "alpha3")
-    : isIso3166Alpha2(uc)
-      ? lookupAlpha2Code(uc, "alpha3")
-      : isIso3166Alpha3(uc)
-      ? lookupAlpha3Code(uc, "alpha3")
-      : isIso3166CountryName(token)
-      ? lookupName(token as any, "alpha3")
-      : undefined
-  ) as unknown as T extends Iso3166_1_CountryName
-  ? Iso3166Alpha3Lookup<T>
-  : Iso3166Alpha3Lookup<Uppercase<AsString<T>>>;
-}
-
-
-/**
- * Looks up the Alpha3 component of a [ISO3166-1](https://en.wikipedia.org/wiki/ISO_3166-1)
- * standard.
- */
-export const lookupCountryCode = <
-  T extends Suggest<
-    Iso3166_1_Alpha2
-  | Iso3166_1_Alpha3
-  | Iso3166_1_CountryName
->>(
-  token: T
-) => {
-  const uc = uppercase(token);
-
-  return (
-    isNumberLike(token)
-    ? lookupNumericCode(token, "countryCode")
-    : isIso3166Alpha2(uc)
-      ? lookupAlpha2Code(uc, "countryCode")
-      : isIso3166Alpha3(uc)
-      ? lookupAlpha3Code(uc, "countryCode")
-      : isIso3166CountryName(token)
-      ? lookupName(token as any, "countryCode")
-      : undefined
-  ) as unknown as T extends Iso3166_1_CountryName
-  ? Iso3166CodeLookup<T>
-  : Iso3166CodeLookup<Uppercase<AsString<T>>>;
-}

package/src/runtime/type-conversion/mergeObjects.ts

@@ -1,31 +0,0 @@
-import { Dictionary, MergeObjects, NarrowObject, Narrowable } from "inferred-types/dist/types/index";
-import { sharedKeys } from "src/runtime/index";
-import { withoutKeys } from "src/runtime/index";
-
-
-export function mergeObjects<
-  D extends Narrowable,
-  O extends Narrowable,
-  TDefault extends NarrowObject<D>,
-  TOverride extends NarrowObject<O>,
->(
-  defVal: TDefault,
-  override: TOverride
-) {
-  const intersectingKeys = sharedKeys(defVal, override) as string[];
-  const defUnique = withoutKeys(defVal, ...intersectingKeys as readonly string[]) as unknown as string[];
-  const overrideUnique = withoutKeys(defVal, ...intersectingKeys as readonly string[]);
-
-  const merged = {
-    ...(intersectingKeys.reduce(
-      (acc, key) => typeof override[key] === "undefined"
-        ? { ...acc, [key]: defVal[key] }
-        : { ...acc, [key]: override[key] },
-      {} as Dictionary
-    )),
-    ...defUnique,
-    ...overrideUnique,
-  };
-
-  return merged as unknown as MergeObjects<TDefault, TOverride>
-}

package/src/runtime/type-conversion/mergeScalars.ts

@@ -1,16 +0,0 @@
-import type { MergeScalars, Scalar } from "inferred-types/dist/types/index";
-import { isUndefined } from "../type-guards/isUndefined";
-
-
-/**
- * **mergeScalars**(a,b)
- *
- * The value of scalar `b` _overrides_ that of `a` unless `b` is
- * undefined.
- */
-export function mergeScalars<
-  A extends Scalar | undefined,
-  B extends Scalar | undefined
->(a: A, b: B) {
-  return (isUndefined(b) ? a : b) as MergeScalars<A,B>;
-}

package/src/runtime/type-conversion/mergeTuples.ts

@@ -1,16 +0,0 @@
-import type { MergeTuples, Narrowable } from "inferred-types/dist/types/index";
-
-/**
- * **mergeTuples**(a,b)
- *
- * Replaces values in `a` with `b` unless `b` is _undefined_. Also, if
- * `a` has more elements than `b` then these extra elements will be
- * appended to the end.
- */
-export function mergeTuples<A extends readonly Narrowable[], B extends readonly Narrowable[]>(a: A, b: B): MergeTuples<A,B> {
-  return (
-    b.length > a.length
-      ? b.map((v,idx) => v !== undefined ? v : a[idx])
-      : [...b, ...a.slice(b.length)].map((v,idx) => v !== undefined ? v : a[idx])
-  ) as unknown as MergeTuples<A,B>;
-}

package/src/runtime/type-conversion/mutable.ts

@@ -1,5 +0,0 @@
-import { Narrowable , Mutable } from "inferred-types/dist/types/index";
-
-export function mutable<T extends Narrowable | readonly Narrowable[]>(value: T): Mutable<T> {
-  return value as Mutable<T>;
-}

package/src/runtime/type-conversion/never.ts

@@ -1,13 +0,0 @@
-
-/**
- * **never**(val)
- * 
- * You can pass a value into this utility and it's runtime type
- * will be unchanged but it's _type_ will be converted to `never`.
- * 
- * **Related:** if you prefer to keep runtime and type system in sync
- * there is also the `Never` constant which can be used.
- */
-export function never(val: unknown): never {
-  return val as never;
-}

package/src/runtime/type-conversion/optional.ts

@@ -1,37 +0,0 @@
-import { Narrowable } from "inferred-types/dist/types/index";
-
-
-
-/**
- * **optional**(value)
- *
- * A function which takes the value `T` and widens it to include
- * a union with _undefined_.
- */
-export function optional<
-  T extends Narrowable
->(value: T) {
-  return value as T | undefined;
-}
-
-/**
- * **orNull**`(value)`
- *
- * widens the type for the value passed in to be whatever type it
- * currently is _in union with_ `null`.
- */
-export function orNull<T extends Narrowable>(value: T) {
-  return value as T | null;
-}
-
-/**
- * **optionalOrNull**`(value)`
- *
- *  widens the type for the value passed in to be whatever type it
- * currently is _in union with_ `null and `undefined`.
- *
- * **Related:** `optional()`, `orNull()`
- */
-export function optionalOrNull<T extends Narrowable>(value: T) {
-  return value as T | null | undefined;
-}

package/src/runtime/type-conversion/toNumber.ts

@@ -1,35 +0,0 @@
-import { Narrowable, Scalar, ToNumber } from "inferred-types/dist/types/index";
-
-
-
-const convertScalar = <T extends Narrowable>(val: T) => {
-  switch (typeof val) {
-    case "number":
-      return val;
-    case "string":
-      return Number(val);
-    case "boolean":
-      return val ? 1 : 0;
-    default:
-      throw Error(`${typeof val} is an invalid scalar type to convert to a number!`);
-  }
-};
-const convertList = <T extends readonly Scalar[]>(val: T) => val.map(i => convertScalar(i));
-
-/**
- * **toNumber**(value)
- *
- * Runtime utility which converts a value into a _numeric_ variant:
- *
- * - for scalars (and objects) it will try to convert to number but otherwise returns `NaN` to runtime and `never` to type system
- * - for arrays it will iterate over each element and try to convert to a number like above
- */
-export function toNumber<
-  T extends Narrowable
->(value: T): ToNumber<T> {
-  return (
-    Array.isArray(value)
-    ? convertList(value)
-    : convertScalar(value)
-  ) as unknown as ToNumber<T>;
-}

package/src/runtime/type-conversion/union.ts

@@ -1,15 +0,0 @@
-import { Narrowable, TupleToUnion } from "inferred-types/dist/types/index";
-
-/**
- * **union**(options) => (value)
- *
- * A higher order function which creates a union type with a runtime value set.
- *
- * **Related:** `unionize`
- */
-export const union = <
-  TOptions extends readonly Narrowable[]
-// eslint-disable-next-line @typescript-eslint/no-unused-vars
->(...options: TOptions) => <
-  TValue extends TupleToUnion<TOptions>
->(value: TValue) => value as TupleToUnion<TOptions>;

package/src/runtime/type-conversion/unionize.ts

@@ -1,12 +0,0 @@
-
-/**
- * **unionize**(value,inUnionWith)
- * 
- * Takes a runtime **value** and modifies it's type to be a union with
- * the type of `inUnionWith` parameter (but does not change the actual
- * runtime value).
- */
-// eslint-disable-next-line @typescript-eslint/no-unused-vars
-export function unionize<T,U>(value: T, inUnionWith: U): T | U {
-  return value as T | U;
-}