inferred-types 0.44.0 → 0.45.2

package/dist/types/string-literals/character-sets/Url.d.ts

@@ -1,4 +1,4 @@
-import { AlphaNumericChar, As, AsString, ExpandUnion, IsStringLiteral, IsTrue, StripAfter, StripBefore, StripChars, StripLeading, StripTrailing, TupleToUnion, DnsName, DomainName, Ip4Address, Mutable, Values, Flatten, EmptyObject } from "../../index";
+import { AlphaNumericChar, AsString, ExpandUnion, IsStringLiteral, StripAfter, StripChars, StripLeading, StripTrailing, TupleToUnion, DnsName, DomainName, Ip4Address, Mutable, Values, Flatten, EmptyObject, IsEqual, NumericChar, RetainWhile, AsNumber, StripWhile } from "../../index";
 import { NETWORK_PROTOCOL_LOOKUP } from "../../../constants/index";
 export type NetworkProtocol = Exclude<TupleToUnion<Mutable<Flatten<Values<typeof NETWORK_PROTOCOL_LOOKUP>>>>, "">;
 /**
@@ -20,9 +20,22 @@ export type PortSpecifierOptions = {
     portRequirement?: "optional" | "required" | "not-allowed";
     ports?: number;
 };
+/**
+ * **GetUrlProtocol**`<T>`
+ *
+ * Gets the network protocol used in the URL string passed into `T`.
+ */
+export type GetUrlProtocol<T> = T extends string ? T extends `${NetworkProtocolPrefix}${string}` ? StripAfter<T, "://"> : IsEqual<T, string> extends true ? string : never : never;
+/**
+ * **GetUrlProtocolPrefix**`<T>`
+ *
+ * Just like `GetUrlProtocol` but adds in the `://` so long
+ * as there's a protocol found.
+ */
+export type GetUrlProtocolPrefix<T> = T extends string ? GetUrlProtocol<T> extends NetworkProtocol ? NetworkProtocolPrefix<GetUrlProtocol<T>> : "" : "";
 type _Ports<TOpt extends PortSpecifierOptions> = TOpt["ports"] extends number ? `${TOpt["ports"]}` : `${number}`;
 /**
- * **PortSpecifier**`<TOpt>`
+ * **UrlPort**`<TOpt>`
  *
  * Produces a string literal for the _port_ designation of
  * many protocols. Basically just a `:${number}` and
@@ -33,49 +46,55 @@ type _Ports<TOpt extends PortSpecifierOptions> = TOpt["ports"] extends number ?
  *   - `required`
  *   - or `not-allowed`
  */
-export type PortSpecifier<TOpt extends PortSpecifierOptions = {
+export type UrlPort<TOpt extends PortSpecifierOptions = {
     portRequirement: "not-allowed";
     ports: number;
 }> = [TOpt["portRequirement"]] extends ["required"] ? `:${_Ports<TOpt>}` : [TOpt["portRequirement"]] extends ["optional"] ? "" | `:${_Ports<TOpt>}` : ``;
+/**
+ * **GetUrlPort**`<T>`
+ *
+ * Returns the port designated in the URL passed in if found.
+ *
+ * - if `T` is a literal string and port not found then value is "default"
+ * - if `T` is a wide string then the value will be `number | "default"`
+ * - all non-string based values result in `never`
+ */
+export type GetUrlPort<T> = T extends string ? IsStringLiteral<T> extends true ? RemoveNetworkProtocol<T> extends `${string}:${infer Port extends number}${infer Rest}` ? AsNumber<RetainWhile<`${Port}${Rest}`, NumericChar>> : "default" : number | "default" : never;
+/**
+ * **RemoveUrlPort**`<T,[TOpt]>`
+ *
+ * Removes a _port specification_ in a URL if found otherwise returns string literal
+ * as it was.
+ */
+export type RemoveUrlPort<T> = T extends string ? IsStringLiteral<T> extends true ? RemoveNetworkProtocol<T> extends `${infer Before}:${infer _Port extends `${number}`}${infer After}` ? `${GetUrlProtocolPrefix<T>}${Before}${StripWhile<After, NumericChar>}` : T : string : never;
 export type ProtocolOptions = {
     /**
      * whether the protocol prefix should be optional
      * @default false
      */
-    optional?: boolean;
+    protocolOptional?: boolean;
     /**
-     * whether to allow for `http://` along with `https://`
-     * @default false
+     * The Network Protocols to use.
      */
-    allowInsecure?: boolean;
-    protocol?: "http" | "ws" | "both";
+    protocols?: NetworkProtocol[];
+};
+export type UrlOptions = {
+    /**
+     * Specify how you'd like to allow for queryParameters in the URL's
+     * you're generating.
+     *
+     * - you may choose "any", "none"
+     *
+     * @default "any"
+     */
+    queryParameters?: "any" | "none";
 };
-/**
- * **HttpProtocol**`<[TOpt]>`
- *
- * A utility which provides different ways of
- * requiring an **HTTP** based protocol string.
- *
- * - by default this only allows `https://`
- * - you can choose to make the protocol _optional_
- * or enable insure `http://` too.
- */
-export type WebsocketProtocol<TOpt extends ProtocolOptions = EmptyObject> = IsTrue<TOpt["allowInsecure"]> extends true ? IsTrue<TOpt["optional"]> extends true ? `wss://` | `ws://` | "" : `wss://` | `ws://` : IsTrue<TOpt["optional"]> extends true ? `wss://` | "" : `wss://`;
-/**
- * **HttpProtocol**`<[TOpt]>`
- *
- * A utility which provides different ways of
- * requiring an **HTTP** based protocol string.
- *
- * - by default this only allows `https://`
- * - you can choose to make the protocol _optional_
- * or enable insure `http://` too.
- */
-export type HttpProtocol<TOpt extends ProtocolOptions = EmptyObject> = IsTrue<TOpt["allowInsecure"]> extends true ? IsTrue<TOpt["optional"]> extends true ? `https://` | `http://` | "" : `https://` | `http://` : IsTrue<TOpt["optional"]> extends true ? `https://` | "" : `https://`;
 /**
  * **RemoveHttpProtocol**`<T>`
  *
  * Removes both `http://` and `https://` prefixes to a string.
+ *
+ * **Related:** `RemoveNetworkProtocol`
  */
 export type RemoveHttpProtocol<T extends string> = T extends `http://${infer Insecure}` ? Insecure : T extends `https://${infer Secure}` ? Secure : T;
 /**
@@ -88,6 +107,7 @@ export type RemoveHttpProtocol<T extends string> = T extends `http://${infer Ins
  * `TProtocol`
  */
 export type RemoveNetworkProtocol<TContent extends string, TProtocol extends NetworkProtocol = NetworkProtocol> = TContent extends `${NetworkProtocolPrefix<TProtocol>}${infer Rest}` ? Rest : TContent;
+type UrlPathChars = AlphaNumericChar | "_" | "@" | "." | "-";
 /**
  * **UrlPath**`<T>`
  *
@@ -101,7 +121,7 @@ export type RemoveNetworkProtocol<TContent extends string, TProtocol extends Net
  * pass in a string to `T` and it will be validated and return
  * `never` when an invalid character is used.
  */
-export type UrlPath<T extends string | null = null> = T extends null ? "" | `/${AlphaNumericChar | "_"}${string}` : T extends string ? IsStringLiteral<T> extends true ? T extends `${string}/` ? never : StripChars<T, AlphaNumericChar | "/" | "_" | "." | "-"> extends "" ? T : never : never : never;
+export type UrlPath<T extends string | null = null> = T extends null ? "" | `/${UrlPathChars}${string}` : T extends string ? IsStringLiteral<T> extends true ? T extends `${string}/` ? never : StripChars<T, UrlPathChars | "/"> extends "" ? T : never : never : never;
 /**
  * **GetUrlSource**`<T>`
  *
@@ -110,8 +130,17 @@ export type UrlPath<T extends string | null = null> = T extends null ? "" | `/${
  * - if _not_ a string literal then just proxies through `string`
  * - if not able to find it then it returns the literal ''
  */
-export type GetUrlSource<T extends string> = IsStringLiteral<T> extends true ? RemoveNetworkProtocol<T> extends `${infer Domain extends DnsName | Ip4Address}${"" | `/${string}`}` ? StripAfter<Domain, "/"> : "" : string;
-type _GetUrlPath<T extends string> = StripAfter<As<StripBefore<RemoveNetworkProtocol<T>, "/">, string>, "?"> extends string ? StripAfter<As<StripBefore<RemoveNetworkProtocol<T>, "/">, string>, "?"> : never;
+export type GetUrlSource<T extends string> = IsStringLiteral<T> extends true ? StripAfter<StripAfter<RemoveNetworkProtocol<T>, "/">, ":"> extends `${infer Domain extends DnsName | Ip4Address}` ? Domain : never : string;
+/**
+ * **RemoveUrlSource**`<T>`
+ *
+ * Removes the URL source (aka, domain name or IP address) from a URL string when
+ * it can be identified.
+ */
+export type RemoveUrlSource<T extends string> = IsStringLiteral<T> extends true ? GetUrlSource<T> extends string ? IsStringLiteral<GetUrlSource<T>> extends true ? T extends `${infer Before}${GetUrlSource<T>}${infer After}` ? `${Before}${After}` : T : T : T : string;
+type _GetUrlPath<T extends string> = [
+    T
+] extends [`${string}//${string}`] ? never : T extends "" ? "" : StripAfter<T, "?"> extends "/" ? "" : T extends `/${string}` ? StripAfter<T, "?"> : never;
 /**
  * **GetUrlPath**`<T>`
  *
@@ -121,7 +150,25 @@ type _GetUrlPath<T extends string> = StripAfter<As<StripBefore<RemoveNetworkProt
  * - removes the domain name or IP address
  * - removes any trailing query parameters
  */
-export type GetUrlPath<T extends string> = IsStringLiteral<T> extends true ? RemoveNetworkProtocol<T> extends `${string}/${string}` ? _GetUrlPath<RemoveNetworkProtocol<T>> extends "" ? "" : `/${_GetUrlPath<RemoveNetworkProtocol<T>>}` : "" : string;
+export type GetUrlPath<T extends string> = [IsStringLiteral<T>] extends [true] ? _GetUrlPath<RemoveUrlSource<RemoveNetworkProtocol<RemoveUrlPort<T>>>> : string;
+/**
+ * **GetUrlQueryParams**`<T>`
+ *
+ * Given a URL passed into `T`, this utility will extract the
+ * query parameters portion of the URL or `""` if none exists.
+ */
+export type GetUrlQueryParams<T extends string> = T extends `${string}?${infer QP}` ? `?${QP}` : "";
+/**
+ * **AnyQueryParams**
+ *
+ * A type which represents any string value for query parameters
+ * or no query parameters at all.
+ *
+ * Can be quite useful for creating pattern matching types where
+ * you don't want to be blocked by someone having put some silly
+ * marketing QP at the end of a URL.
+ */
+export type AnyQueryParams = `?${string}` | "";
 type RelativeStart = `../` | `./`;
 /**
  * **RelativeUrl**
@@ -148,8 +195,9 @@ export type Uri<T extends NetworkProtocol = NetworkProtocol> = `${T}://${string}
  */
 export type AddUrlPathSegment<TExisting extends string, TAdd extends string> = TExisting extends `${string}/` ? `${TExisting}${StripTrailing<StripLeading<TAdd, "/">, "/">}` : `${TExisting}/${StripTrailing<StripLeading<TAdd, "/">, "/">}`;
 type _Path<T extends string> = GetUrlPath<T> extends UrlPath ? GetUrlPath<T> : never;
-type _UrlsFromProtocol<TContent extends string, TProto extends WebsocketProtocol<TOpt> | HttpProtocol<TOpt>, TOpt extends ProtocolOptions & PortSpecifierOptions> = `${TProto}${GetUrlSource<TContent>}${PortSpecifier<TOpt>}${AddUrlPathSegment<_Path<TContent>, `${string}`>}` | `${TProto}${GetUrlSource<TContent>}${PortSpecifier<TOpt>}${_Path<TContent>}`;
-type _UrlsFrom<T extends string, TOpt extends ProtocolOptions & PortSpecifierOptions = EmptyObject> = TOpt["protocol"] extends "ws" ? _UrlsFromProtocol<T, WebsocketProtocol<TOpt>, TOpt> : TOpt["protocol"] extends "both" ? _UrlsFromProtocol<T, WebsocketProtocol<TOpt>, TOpt> | _UrlsFromProtocol<T, HttpProtocol<TOpt>, TOpt> : _UrlsFromProtocol<T, HttpProtocol<TOpt>, TOpt>;
+type _Proto<TOpt extends ProtocolOptions & PortSpecifierOptions & UrlOptions> = NetworkProtocolPrefix<[] extends TOpt["protocols"] ? "https" : TupleToUnion<TOpt["protocols"]>>;
+type _QP<TOpt extends ProtocolOptions & PortSpecifierOptions & UrlOptions> = TOpt["queryParameters"] extends "none" ? "" : `${AnyQueryParams}`;
+type _UrlsFrom<TContent extends string, TOpt extends ProtocolOptions & PortSpecifierOptions & UrlOptions> = [TOpt["protocolOptional"]] extends [true] ? `${_Proto<TOpt>}${GetUrlSource<TContent>}${UrlPort<TOpt>}${AddUrlPathSegment<_Path<TContent>, `${string}`>}` | `${_Proto<TOpt>}${GetUrlSource<TContent>}${UrlPort<TOpt>}${_Path<TContent>}${_QP<TOpt>}` | `${GetUrlSource<TContent>}${UrlPort<TOpt>}${_Path<TContent>}${_QP<TOpt>}` | `${GetUrlSource<TContent>}${UrlPort<TOpt>}${AddUrlPathSegment<_Path<TContent>, `${string}`>}` : `${_Proto<TOpt>}${GetUrlSource<TContent>}${UrlPort<TOpt>}${AddUrlPathSegment<_Path<TContent>, `${string}`>}` | `${_Proto<TOpt>}${GetUrlSource<TContent>}${UrlPort<TOpt>}${_Path<TContent>}${_QP<TOpt>}`;
 /**
  * **UrlsFrom**`<T, [TOpt]>`
  *
@@ -161,7 +209,7 @@ type _UrlsFrom<T extends string, TOpt extends ProtocolOptions & PortSpecifierOpt
  * - you can also switch the protocol between `http`,`ws`, or `both`
  * - the default protocol is `http`
  */
-export type UrlsFrom<T extends string | readonly string[], TOpt extends ProtocolOptions & PortSpecifierOptions = EmptyObject> = T extends string ? ExpandUnion<_UrlsFrom<T, TOpt>> : T extends readonly string[] ? TupleToUnion<{
+export type UrlsFrom<T extends string | readonly string[], TOpt extends ProtocolOptions & PortSpecifierOptions & UrlOptions = EmptyObject> = T extends string ? ExpandUnion<_UrlsFrom<T, TOpt>> : T extends readonly string[] ? TupleToUnion<{
     [K in keyof T]: IsStringLiteral<T[K]> extends true ? ExpandUnion<_UrlsFrom<AsString<T[K]>, TOpt>> : never;
 }> : never;
 export {};

package/dist/types/string-literals/character-sets/Url.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Url.d.ts","sourceRoot":"","sources":["../../../../src/types/string-literals/character-sets/Url.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,gBAAgB,EAChB,EAAE,EACF,QAAQ,EACR,WAAW,EACX,eAAe,EACf,MAAM,EACN,UAAU,EACV,WAAW,EACX,UAAU,EACV,YAAY,EACZ,aAAa,EACb,YAAY,EACZ,OAAO,EAAE,UAAU,EACnB,UAAU,EACV,OAAO,EACP,MAAM,EACN,OAAO,EACP,WAAW,EACZ,oBAAwB;AACzB,OAAO,EAAE,uBAAuB,EAAE,iCAA4B;AAE9D,MAAM,MAAM,eAAe,GAAG,OAAO,CAAC,YAAY,CAChD,OAAO,CACL,OAAO,CAAC,MAAM,CAAC,OAAO,uBAAuB,CAAC,CAAC,CAChD,CACF,EAAE,EAAE,CAAC,CAAC;AAEP;;;;;GAKG;AACH,MAAM,MAAM,qBAAqB,CAC/B,CAAC,SAAS,eAAe,GAAG,eAAe,IACzC,GAAG,CAAC,KAAK,CAAA;AAEb,MAAM,MAAM,oBAAoB,GAAG;IACjC;;;;;;;OAOG;IACH,eAAe,CAAC,EAAE,UAAU,GAAG,UAAU,GAAG,aAAa,CAAA;IAEzD,KAAK,CAAC,EAAE,MAAM,CAAA;CACf,CAAA;AAGD,KAAK,MAAM,CACT,IAAI,SAAS,oBAAoB,IAC/B,IAAI,CAAC,OAAO,CAAC,SAAS,MAAM,GAC9B,GAAG,IAAI,CAAC,OAAO,CAAC,EAAE,GAClB,GAAG,MAAM,EAAE,CAAC;AAEd;;;;;;;;;;;GAWG;AACH,MAAM,MAAM,aAAa,CACvB,IAAI,SAAS,oBAAoB,GAAG;IAAE,eAAe,EAAE,aAAa,CAAC;IAAC,KAAK,EAAE,MAAM,CAAA;CAAE,IACnF,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC,SAAS,CAAC,UAAU,CAAC,GAC9C,IAAI,MAAM,CAAC,IAAI,CAAC,EAAE,GAClB,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC,SAAS,CAAC,UAAU,CAAC,GAC9C,EAAE,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,EAAE,GACvB,EAAE,CAAC;AAEP,MAAM,MAAM,eAAe,GAAG;IAC5B;;;OAGG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB;;;OAGG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IAExB,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,MAAM,CAAA;CAClC,CAAA;AAED;;;;;;;;;GASG;AACH,MAAM,MAAM,iBAAiB,CAC3B,IAAI,SAAS,eAAe,GAAG,WAAW,IAE1C,MAAM,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC,SAAS,IAAI,GACxC,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,SAAS,IAAI,GACrC,QAAQ,GAAG,OAAO,GAAG,EAAE,GACvB,QAAQ,GAAG,OAAO,GAClB,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,SAAS,IAAI,GACrC,QAAQ,GAAG,EAAE,GACb,QAAQ,CAAC;AAEb;;;;;;;;;GASG;AACH,MAAM,MAAM,YAAY,CACtB,IAAI,SAAS,eAAe,GAAG,WAAW,IAE1C,MAAM,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC,SAAS,IAAI,GACxC,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,SAAS,IAAI,GACrC,UAAU,GAAG,SAAS,GAAG,EAAE,GAC3B,UAAU,GAAG,SAAS,GACtB,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,SAAS,IAAI,GACrC,UAAU,GAAG,EAAE,GACf,UAAU,CAAC;AAEf;;;;GAIG;AACH,MAAM,MAAM,kBAAkB,CAAC,CAAC,SAAS,MAAM,IAAI,CAAC,SAAS,UAAU,MAAM,QAAQ,EAAE,GACnF,QAAQ,GACR,CAAC,SAAS,WAAW,MAAM,MAAM,EAAE,GACnC,MAAM,GACN,CAAC,CAAC;AAEN;;;;;;;;GAQG;AACH,MAAM,MAAM,qBAAqB,CAC/B,QAAQ,SAAS,MAAM,EACvB,SAAS,SAAS,eAAe,GAAG,eAAe,IACjD,QAAQ,SAAS,GAAG,qBAAqB,CAAC,SAAS,CAAC,GAAG,MAAM,IAAI,EAAE,GACrE,IAAI,GACJ,QAAQ,CAAC;AAEX;;;;;;;;;;;;GAYG;AACH,MAAM,MAAM,OAAO,CAAC,CAAC,SAAS,MAAM,GAAG,IAAI,GAAG,IAAI,IAAI,CAAC,SAAS,IAAI,GAChE,EAAE,GAAG,IAAI,gBAAgB,GAAG,GAAG,GAAG,MAAM,EAAE,GAC1C,CAAC,SAAS,MAAM,GAChB,eAAe,CAAC,CAAC,CAAC,SAAS,IAAI,GAC7B,CAAC,SAAS,GAAG,MAAM,GAAG,GACpB,KAAK,GACP,UAAU,CAAC,CAAC,EAAE,gBAAgB,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,CAAE,SAAS,EAAE,GACjE,CAAC,GACD,KAAK,GACT,KAAK,GACL,KAAK,CAAC;AAEV;;;;;;;GAOG;AACH,MAAM,MAAM,YAAY,CACtB,CAAC,SAAS,MAAM,IACd,eAAe,CAAC,CAAC,CAAC,SAAS,IAAI,GAC/B,qBAAqB,CAAC,CAAC,CAAC,SAAS,GAAG,MAAM,MAAM,SAAS,OAAO,GAAG,UAAU,GAAG,EAAE,GAAG,IAAI,MAAM,EAAE,EAAE,GACnG,UAAU,CAAC,MAAM,EAAE,GAAG,CAAC,GACvB,EAAE,GACF,MAAM,CAAC;AAEX,KAAK,WAAW,CAAC,CAAC,SAAS,MAAM,IACjC,UAAU,CACR,EAAE,CAAC,WAAW,CAAC,qBAAqB,CAAC,CAAC,CAAC,EAAE,GAAG,CAAC,EAAE,MAAM,CAAC,EACtD,GAAG,CACJ,SAAS,MAAM,GACZ,UAAU,CACZ,EAAE,CAAC,WAAW,CAAC,qBAAqB,CAAC,CAAC,CAAC,EAAE,GAAG,CAAC,EAAE,MAAM,CAAC,EACtD,GAAG,CACF,GACC,KAAK,CAAC;AAEV;;;;;;;;GAQG;AACH,MAAM,MAAM,UAAU,CACpB,CAAC,SAAS,MAAM,IACd,eAAe,CAAC,CAAC,CAAC,SAAS,IAAI,GACjC,qBAAqB,CAAC,CAAC,CAAC,SAAS,GAAG,MAAM,IAAI,MAAM,EAAE,GACpD,WAAW,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC,SAAS,EAAE,GAC9C,EAAE,GACF,IAAI,WAAW,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC,EAAE,GAC7C,EAAE,GACJ,MAAM,CAAA;AAER,KAAK,aAAa,GAAG,KAAK,GAAG,IAAI,CAAC;AAElC;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG,GAAG,aAAa,GAAG,OAAO,EAAE,CAAC;AAEvD;;;;GAIG;AACH,MAAM,MAAM,iBAAiB,GAAG,GAAG,eAAe,MAAM,UAAU,GAAG,UAAU,IAAI,MAAM,EAAE,CAAC;AAE5F,MAAM,MAAM,UAAU,GAClB,CAAC,CAAC,CAAC,SAAS,eAAe,EAAE,CAAC,SAAS,UAAU,EAAE,CAAC,SAAS,WAAW,EACxE,QAAQ,EAAE,CAAC,EACX,MAAM,EAAE,CAAC,EACT,QAAQ,EAAE,CAAC,KACR,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,GACtB,CAAC,CAAC,CAAC,SAAS,WAAW,EAAE,GAAG,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC;AAE3C;;;;GAIG;AACH,MAAM,MAAM,GAAG,CACb,CAAC,SAAS,eAAe,GAAG,eAAe,IACzC,GAAG,CAAC,MAAM,MAAM,EAAE,CAAC;AAEvB;;;;;GAKG;AACH,MAAM,MAAM,iBAAiB,CAC3B,SAAS,SAAS,MAAM,EACxB,IAAI,SAAS,MAAM,IACjB,SAAS,SAAS,GAAG,MAAM,GAAG,GAChC,GAAG,SAAS,GAAG,aAAa,CAAC,YAAY,CAAC,IAAI,EAAE,GAAG,CAAC,EAAE,GAAG,CAAC,EAAE,GAC5D,GAAG,SAAS,IAAI,aAAa,CAAC,YAAY,CAAC,IAAI,EAAE,GAAG,CAAC,EAAE,GAAG,CAAC,EAAE,CAAC;AAEhE,KAAK,KAAK,CAAC,CAAC,SAAS,MAAM,IAAI,UAAU,CAAC,CAAC,CAAC,SAAS,OAAO,GACxD,UAAU,CAAC,CAAC,CAAC,GACb,KAAK,CAAC;AAGV,KAAK,iBAAiB,CACpB,QAAQ,SAAS,MAAM,EACvB,MAAM,SAAS,iBAAiB,CAAC,IAAI,CAAC,GAAG,YAAY,CAAC,IAAI,CAAC,EAC3D,IAAI,SAAS,eAAe,GAAG,oBAAoB,IACjD,GAAG,MAAM,GAAG,YAAY,CAAC,QAAQ,CAAC,GAAG,aAAa,CAAC,IAAI,CAAC,GAAG,iBAAiB,CAAC,KAAK,CAAC,QAAQ,CAAC,EAAE,GAAG,MAAM,EAAE,CAAC,EAAE,GAAG,GAAG,MAAM,GAAG,YAAY,CAAC,QAAQ,CAAC,GAAG,aAAa,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC,QAAQ,CAAC,EAAE,CAAA;AAI/L,KAAK,SAAS,CACZ,CAAC,SAAS,MAAM,EAChB,IAAI,SAAS,eAAe,GAAG,oBAAoB,GAAG,WAAW,IAC/D,IAAI,CAAC,UAAU,CAAC,SAAS,IAAI,GAC/B,iBAAiB,CAAC,CAAC,EAAC,iBAAiB,CAAC,IAAI,CAAC,EAAC,IAAI,CAAC,GACjD,IAAI,CAAC,UAAU,CAAC,SAAS,MAAM,GAC7B,iBAAiB,CAAC,CAAC,EAAC,iBAAiB,CAAC,IAAI,CAAC,EAAC,IAAI,CAAC,GACjD,iBAAiB,CAAC,CAAC,EAAC,YAAY,CAAC,IAAI,CAAC,EAAC,IAAI,CAAC,GAC5C,iBAAiB,CAAC,CAAC,EAAC,YAAY,CAAC,IAAI,CAAC,EAAC,IAAI,CAAC,CAAC;AAGjD;;;;;;;;;;GAUG;AACH,MAAM,MAAM,QAAQ,CAClB,CAAC,SAAS,MAAM,GAAG,SAAS,MAAM,EAAE,EACpC,IAAI,SAAS,eAAe,GAAG,oBAAoB,GAAG,WAAW,IAC/D,CAAC,SAAS,MAAM,GAClB,WAAW,CAAC,SAAS,CAAC,CAAC,EAAC,IAAI,CAAC,CAAC,GAC9B,CAAC,SAAS,SAAS,MAAM,EAAE,GACzB,YAAY,CACZ;KACG,CAAC,IAAI,MAAM,CAAC,GAAG,eAAe,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,IAAI,GAC9C,WAAW,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,GAC5C,KAAK;CACV,CACF,GACC,KAAK,CAAC"}
+{"version":3,"file":"Url.d.ts","sourceRoot":"","sources":["../../../../src/types/string-literals/character-sets/Url.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,gBAAgB,EAChB,QAAQ,EACR,WAAW,EACX,eAAe,EACf,UAAU,EACV,UAAU,EACV,YAAY,EACZ,aAAa,EACb,YAAY,EACZ,OAAO,EAAE,UAAU,EACnB,UAAU,EACV,OAAO,EACP,MAAM,EACN,OAAO,EACP,WAAW,EACX,OAAO,EACP,WAAW,EACX,WAAW,EACX,QAAQ,EAER,UAAU,EACX,oBAAwB;AACzB,OAAO,EAAE,uBAAuB,EAAE,iCAA4B;AAE9D,MAAM,MAAM,eAAe,GAAG,OAAO,CAAC,YAAY,CAChD,OAAO,CACL,OAAO,CAAC,MAAM,CAAC,OAAO,uBAAuB,CAAC,CAAC,CAChD,CACF,EAAE,EAAE,CAAC,CAAC;AAEP;;;;;GAKG;AACH,MAAM,MAAM,qBAAqB,CAC/B,CAAC,SAAS,eAAe,GAAG,eAAe,IACzC,GAAG,CAAC,KAAK,CAAA;AAEb,MAAM,MAAM,oBAAoB,GAAG;IACjC;;;;;;;OAOG;IACH,eAAe,CAAC,EAAE,UAAU,GAAG,UAAU,GAAG,aAAa,CAAA;IAEzD,KAAK,CAAC,EAAE,MAAM,CAAA;CACf,CAAA;AAED;;;;GAIG;AACH,MAAM,MAAM,cAAc,CAAC,CAAC,IAAI,CAAC,SAAS,MAAM,GAC9C,CAAC,SAAS,GAAG,qBAAqB,GAAG,MAAM,EAAE,GAC7C,UAAU,CAAC,CAAC,EAAC,KAAK,CAAC,GACnB,OAAO,CAAC,CAAC,EAAC,MAAM,CAAC,SAAS,IAAI,GAC5B,MAAM,GACN,KAAK,GACP,KAAK,CAAC;AAER;;;;;GAKG;AACH,MAAM,MAAM,oBAAoB,CAAC,CAAC,IAAI,CAAC,SAAS,MAAM,GACpD,cAAc,CAAC,CAAC,CAAC,SAAS,eAAe,GACvC,qBAAqB,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,GACxC,EAAE,GACJ,EAAE,CAAC;AAGL,KAAK,MAAM,CACT,IAAI,SAAS,oBAAoB,IAC/B,IAAI,CAAC,OAAO,CAAC,SAAS,MAAM,GAC9B,GAAG,IAAI,CAAC,OAAO,CAAC,EAAE,GAClB,GAAG,MAAM,EAAE,CAAC;AAEd;;;;;;;;;;;GAWG;AACH,MAAM,MAAM,OAAO,CACjB,IAAI,SAAS,oBAAoB,GAAG;IAAE,eAAe,EAAE,aAAa,CAAC;IAAC,KAAK,EAAE,MAAM,CAAA;CAAE,IACnF,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC,SAAS,CAAC,UAAU,CAAC,GAC9C,IAAI,MAAM,CAAC,IAAI,CAAC,EAAE,GAClB,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC,SAAS,CAAC,UAAU,CAAC,GAC9C,EAAE,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,EAAE,GACvB,EAAE,CAAC;AAEP;;;;;;;;GAQG;AACH,MAAM,MAAM,UAAU,CAAC,CAAC,IAAI,CAAC,SAAS,MAAM,GAC1C,eAAe,CAAC,CAAC,CAAC,SAAS,IAAI,GAC7B,qBAAqB,CAAC,CAAC,CAAC,SAAS,GAAG,MAAM,IAAI,MAAM,IAAI,SAAS,MAAM,GAAG,MAAM,IAAI,EAAE,GACpF,QAAQ,CAAC,WAAW,CAAC,GAAG,IAAI,GAAG,IAAI,EAAE,EAAE,WAAW,CAAC,CAAC,GACpD,SAAS,GACX,MAAM,GAAG,SAAS,GACpB,KAAK,CAAC;AAMR;;;;;GAKG;AACH,MAAM,MAAM,aAAa,CACvB,CAAC,IACC,CAAC,SAAS,MAAM,GAClB,eAAe,CAAC,CAAC,CAAC,SAAS,IAAI,GAC7B,qBAAqB,CAAC,CAAC,CAAC,SAAS,GAAG,MAAM,MAAM,IAAI,MAAM,KAAK,SAAS,GAAG,MAAM,EAAE,GAAG,MAAM,KAAK,EAAE,GACjG,GAAG,oBAAoB,CAAC,CAAC,CAAC,GAAG,MAAM,GAAG,UAAU,CAAC,KAAK,EAAE,WAAW,CAAC,EAAE,GACtE,CAAC,GACH,MAAM,GACR,KAAK,CAAC;AAIR,MAAM,MAAM,eAAe,GAAG;IAC5B;;;OAGG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B;;OAEG;IACH,SAAS,CAAC,EAAE,eAAe,EAAE,CAAA;CAC9B,CAAA;AAED,MAAM,MAAM,UAAU,GAAG;IACvB;;;;;;;OAOG;IACH,eAAe,CAAC,EAAE,KAAK,GAAG,MAAM,CAAE;CACnC,CAAA;AAED;;;;;;GAMG;AACH,MAAM,MAAM,kBAAkB,CAAC,CAAC,SAAS,MAAM,IAAI,CAAC,SAAS,UAAU,MAAM,QAAQ,EAAE,GACnF,QAAQ,GACR,CAAC,SAAS,WAAW,MAAM,MAAM,EAAE,GACnC,MAAM,GACN,CAAC,CAAC;AAEN;;;;;;;;GAQG;AACH,MAAM,MAAM,qBAAqB,CAC/B,QAAQ,SAAS,MAAM,EACvB,SAAS,SAAS,eAAe,GAAG,eAAe,IACjD,QAAQ,SAAS,GAAG,qBAAqB,CAAC,SAAS,CAAC,GAAG,MAAM,IAAI,EAAE,GACrE,IAAI,GACJ,QAAQ,CAAC;AAEX,KAAK,YAAY,GAAG,gBAAgB,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,CAAC;AAE7D;;;;;;;;;;;;GAYG;AACH,MAAM,MAAM,OAAO,CAAC,CAAC,SAAS,MAAM,GAAG,IAAI,GAAG,IAAI,IAAI,CAAC,SAAS,IAAI,GAChE,EAAE,GAAG,IAAI,YAAY,GAAG,MAAM,EAAE,GAChC,CAAC,SAAS,MAAM,GAChB,eAAe,CAAC,CAAC,CAAC,SAAS,IAAI,GAC7B,CAAC,SAAS,GAAG,MAAM,GAAG,GACpB,KAAK,GACP,UAAU,CAAC,CAAC,EAAE,YAAY,GAAG,GAAG,CAAE,SAAS,EAAE,GAC3C,CAAC,GACD,KAAK,GACT,KAAK,GACL,KAAK,CAAC;AAEV;;;;;;;GAOG;AACH,MAAM,MAAM,YAAY,CACtB,CAAC,SAAS,MAAM,IACd,eAAe,CAAC,CAAC,CAAC,SAAS,IAAI,GAC/B,UAAU,CAAC,UAAU,CAAC,qBAAqB,CAAC,CAAC,CAAC,EAAE,GAAG,CAAC,EAAE,GAAG,CAAC,SACxD,GAAG,MAAM,MAAM,SAAS,OAAO,GAAG,UAAU,EAAE,GAChD,MAAM,GACN,KAAK,GACL,MAAM,CAAC;AAEX;;;;;GAKG;AACH,MAAM,MAAM,eAAe,CAAC,CAAC,SAAS,MAAM,IAAI,eAAe,CAAC,CAAC,CAAC,SAAS,IAAI,GAC7E,YAAY,CAAC,CAAC,CAAC,SAAS,MAAM,GAC5B,eAAe,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,SAAS,IAAI,GAC3C,CAAC,SAAS,GAAG,MAAM,MAAM,GAAG,YAAY,CAAC,CAAC,CAAC,GAAG,MAAM,KAAK,EAAE,GACzD,GAAG,MAAM,GAAG,KAAK,EAAE,GACnB,CAAC,GACH,CAAC,GACH,CAAC,GACH,MAAM,CAAC;AAGT,KAAK,WAAW,CAAC,CAAC,SAAS,MAAM,IAC9B;IAAC,CAAC;CAAC,SAAS,CAAC,GAAG,MAAM,KAAK,MAAM,EAAE,CAAC,GAC/B,KAAK,GACL,CAAC,SAAS,EAAE,GACV,EAAE,GACF,UAAU,CAAC,CAAC,EAAC,GAAG,CAAC,SAAS,GAAG,GAC7B,EAAE,GACF,CAAC,SAAS,IAAI,MAAM,EAAE,GACpB,UAAU,CAAC,CAAC,EAAC,GAAG,CAAC,GACjB,KAAK,CAAC;AAElB;;;;;;;;GAQG;AACH,MAAM,MAAM,UAAU,CACpB,CAAC,SAAS,MAAM,IACd,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,IAAI,CAAC,GACrC,WAAW,CACT,eAAe,CAAC,qBAAqB,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC,CACzD,GACD,MAAM,CAAC;AAGT;;;;;GAKG;AACH,MAAM,MAAM,iBAAiB,CAC3B,CAAC,SAAS,MAAM,IACd,CAAC,SAAS,GAAG,MAAM,IAAI,MAAM,EAAE,EAAE,GACnC,IAAI,EAAE,EAAE,GACR,EAAE,CAAC;AAEL;;;;;;;;;GASG;AACH,MAAM,MAAM,cAAc,GAAG,IAAI,MAAM,EAAE,GAAG,EAAE,CAAC;AAI/C,KAAK,aAAa,GAAG,KAAK,GAAG,IAAI,CAAC;AAElC;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG,GAAG,aAAa,GAAG,OAAO,EAAE,CAAC;AAEvD;;;;GAIG;AACH,MAAM,MAAM,iBAAiB,GAAG,GAAG,eAAe,MAAM,UAAU,GAAG,UAAU,IAAI,MAAM,EAAE,CAAC;AAE5F,MAAM,MAAM,UAAU,GAClB,CAAC,CAAC,CAAC,SAAS,eAAe,EAAE,CAAC,SAAS,UAAU,EAAE,CAAC,SAAS,WAAW,EACxE,QAAQ,EAAE,CAAC,EACX,MAAM,EAAE,CAAC,EACT,QAAQ,EAAE,CAAC,KACR,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,GACtB,CAAC,CAAC,CAAC,SAAS,WAAW,EAAE,GAAG,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC;AAE3C;;;;GAIG;AACH,MAAM,MAAM,GAAG,CACb,CAAC,SAAS,eAAe,GAAG,eAAe,IACzC,GAAG,CAAC,MAAM,MAAM,EAAE,CAAC;AAEvB;;;;;GAKG;AACH,MAAM,MAAM,iBAAiB,CAC3B,SAAS,SAAS,MAAM,EACxB,IAAI,SAAS,MAAM,IACjB,SAAS,SAAS,GAAG,MAAM,GAAG,GAChC,GAAG,SAAS,GAAG,aAAa,CAAC,YAAY,CAAC,IAAI,EAAE,GAAG,CAAC,EAAE,GAAG,CAAC,EAAE,GAC5D,GAAG,SAAS,IAAI,aAAa,CAAC,YAAY,CAAC,IAAI,EAAE,GAAG,CAAC,EAAE,GAAG,CAAC,EAAE,CAAC;AAEhE,KAAK,KAAK,CAAC,CAAC,SAAS,MAAM,IAAI,UAAU,CAAC,CAAC,CAAC,SAAS,OAAO,GACxD,UAAU,CAAC,CAAC,CAAC,GACb,KAAK,CAAC;AAEV,KAAK,MAAM,CAAC,IAAI,SAAS,eAAe,GAAG,oBAAoB,GAAG,UAAU,IAC5E,qBAAqB,CAAC,EAAE,SAAS,IAAI,CAAC,WAAW,CAAC,GAC9C,OAAO,GACP,YAAY,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC;AAErC,KAAK,GAAG,CACN,IAAI,SAAS,eAAe,GAAG,oBAAoB,GAAG,UAAU,IAC9D,IAAI,CAAC,iBAAiB,CAAC,SAAS,MAAM,GACxC,EAAE,GACF,GAAG,cAAc,EAAE,CAAC;AAEtB,KAAK,SAAS,CACZ,QAAQ,SAAS,MAAM,EACvB,IAAI,SAAS,eAAe,GAAG,oBAAoB,GAAG,UAAU,IAC9D,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC,SAAS,CAAC,IAAI,CAAC,GAC3C,GAAG,MAAM,CAAC,IAAI,CAAC,GAAG,YAAY,CAAC,QAAQ,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,GAAG,iBAAiB,CAAC,KAAK,CAAC,QAAQ,CAAC,EAAE,GAAG,MAAM,EAAE,CAAC,EAAE,GAC5G,GAAG,MAAM,CAAC,IAAI,CAAC,GAAG,YAAY,CAAC,QAAQ,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC,QAAQ,CAAC,GAAG,GAAG,CAAC,IAAI,CAAC,EAAE,GACxF,GAAG,YAAY,CAAC,QAAQ,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC,QAAQ,CAAC,GAAG,GAAG,CAAC,IAAI,CAAC,EAAE,GACzE,GAAG,YAAY,CAAC,QAAQ,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,GAAG,iBAAiB,CAAC,KAAK,CAAC,QAAQ,CAAC,EAAE,GAAG,MAAM,EAAE,CAAC,EAAE,GAE7F,GAAG,MAAM,CAAC,IAAI,CAAC,GAAG,YAAY,CAAC,QAAQ,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,GAAG,iBAAiB,CAAC,KAAK,CAAC,QAAQ,CAAC,EAAE,GAAG,MAAM,EAAE,CAAC,EAAE,GAC9G,GAAG,MAAM,CAAC,IAAI,CAAC,GAAG,YAAY,CAAC,QAAQ,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC,QAAQ,CAAC,GAAG,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC;AAGzF;;;;;;;;;;GAUG;AACH,MAAM,MAAM,QAAQ,CAClB,CAAC,SAAS,MAAM,GAAG,SAAS,MAAM,EAAE,EACpC,IAAI,SAAS,eAAe,GAAG,oBAAoB,GAAG,UAAU,GAAG,WAAW,IAC5E,CAAC,SAAS,MAAM,GAClB,WAAW,CAAC,SAAS,CAAC,CAAC,EAAC,IAAI,CAAC,CAAC,GAC9B,CAAC,SAAS,SAAS,MAAM,EAAE,GACzB,YAAY,CACZ;KACG,CAAC,IAAI,MAAM,CAAC,GAAG,eAAe,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,IAAI,GAC9C,WAAW,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,GAC5C,KAAK;CACV,CACF,GACC,KAAK,CAAC"}

package/dist/types/string-literals/character-sets/Url.js

@@ -1 +1,2 @@
+;
 export {};

package/dist/types/string-literals/character-sets/Whitespace.d.ts

@@ -1,7 +1,9 @@
+import { WHITESPACE_CHARS } from "../../../constants/index";
+import { Mutable, TupleToUnion } from "../../index";
 /**
  * **Whitespace**
  *
  * Characters typically representing "white space"
  */
-export type Whitespace = " " | "\n" | "\t";
+export type Whitespace = TupleToUnion<Mutable<typeof WHITESPACE_CHARS>>;
 //# sourceMappingURL=Whitespace.d.ts.map

package/dist/types/string-literals/character-sets/Whitespace.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Whitespace.d.ts","sourceRoot":"","sources":["../../../../src/types/string-literals/character-sets/Whitespace.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,MAAM,MAAM,UAAU,GAAG,GAAG,GAAG,IAAI,GAAG,IAAI,CAAC"}
+{"version":3,"file":"Whitespace.d.ts","sourceRoot":"","sources":["../../../../src/types/string-literals/character-sets/Whitespace.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,iCAA4B;AACvD,OAAO,EAAE,OAAO,EAAE,YAAY,EAAE,oBAAwB;AAExD;;;;GAIG;AACH,MAAM,MAAM,UAAU,GAAG,YAAY,CAAC,OAAO,CAAC,OAAO,gBAAgB,CAAC,CAAC,CAAC"}

package/dist/types/string-literals/character-sets/YouTube.d.ts

@@ -0,0 +1,127 @@
+import { AsString, Contains, HasQueryParameter, IsEqual, IsUnion, Last, Split, TupleToUnion, UnionToTuple, AnyQueryParams, GetUrlPath, UrlsFrom, Optional } from "../../index";
+/**
+ * **YouTubePageType**
+ *
+ * A union type enumeration of the _types_ of pages on YouTube.
+ */
+export type YouTubePageType = "home" | "play::video::solo" | "play::video::solo::share-link" | "play::video::solo::share-link::with-timestamp" | "play::video::in-list" | "play::video::in-list::share-link" | "play::video::in-list::share-link::with-timestamp" | "playlist::show" | "creator::featured" | "creator::videos" | "creator::playlists" | "creator::other" | "feed::history" | "feed::playlists" | "feed::liked" | "feed::subscriptions" | "feed::trending" | "feed::other" | "other";
+export type YouTubeFeedType = "history" | "playlists" | "liked" | "subscriptions" | "trending" | "other";
+/**
+ * **YouTubeUrl**
+ *
+ * A type which should match all URL's pointing to YouTube
+ */
+export type YouTubeUrl = UrlsFrom<["www.youtube.com", "youtube.com", "youtu.be"]>;
+/**
+ * **YouTubeHome**
+ *
+ * The URLs representing the home page of YouTube
+ */
+export type YouTubeHome = `https://www.youtube.com${AnyQueryParams}` | `https://youtube.com${AnyQueryParams}`;
+/**
+ * **YouTubeShareUrl**
+ *
+ * a URL which comes from YouTube's _URL shortened_ `https://youtu.be` site.
+ */
+export type YouTubeShareUrl = UrlsFrom<"youtu.be">;
+/**
+ * **YouTubeVideo**
+ *
+ * Type pattern which will match all URL's which relate to
+ * a YouTubeVideo.
+ *
+ * **Note:** there can be some _false positives_ when the query parameters
+ * may state that this is a video to watch in a list of videos. You can avoid
+ * this ambiguity with the `IsYouTubeVideo` and `IsYouTubeList` operators.
+ */
+export type YouTubeVideoUrl = UrlsFrom<[
+    "www.youtube.com/watch",
+    "youtube.com/watch"
+]> | YouTubeShareUrl;
+/**
+ * **YouTubeCreatorUrl**
+ *
+ * Pages associated with a YouTube creator. This can include your own
+ * pages even if you don't consider yourself a full creator (yet).
+ */
+export type YouTubeCreatorUrl = UrlsFrom<[
+    `www.youtube.com/channel/${string}`,
+    `youtube.com/channel/${string}`
+]> | `https://www.youtube.com/@${string}${Optional<"/featured" | "/videos" | "/playlists">}`;
+/**
+ * **YouTubePlaylistUrl**
+ *
+ * A URL pattern which should match all playlist URL's on YouTube.
+ * That includes both the logged in user's as well as other peoples.
+ *
+ * **Related:** `YouTubeUsersPlaylistUrl`
+ */
+export type YouTubePlaylistUrl = UrlsFrom<[
+    `www.youtube.com/channel/playlists`,
+    `www.youtube.com/@${string}/playlists`,
+    `youtube.com/channel/playlists`,
+    `youtube.com/@${string}/playlists`
+]> | YouTubeUsersPlaylistUrl;
+type _FeedMap<T extends YouTubeFeedType> = IsEqual<T, YouTubeFeedType> extends true ? `feed` : T extends "liked" ? `playlist?list=LL` : Contains<["history", "playlists", "trending", "subscriptions"], T> extends true ? `feed/${T}` : `feed/${string}`;
+/**
+ * Maps the feed type to a URL path
+ */
+type FeedMap<T extends YouTubeFeedType> = IsUnion<T> extends true ? TupleToUnion<{
+    [K in keyof UnionToTuple<T>]: UnionToTuple<T>[K] extends YouTubeFeedType ? _FeedMap<UnionToTuple<T>[K]> : never;
+}> : _FeedMap<T>;
+/**
+ * **YouTubeFeedUrl**`<[T]>`
+ *
+ * A URL pattern which matches all "feeds" on YouTube where
+ * "feeds" are pages that organize videos/content for a logged
+ * in user based on their configuration.
+ *
+ * By default, all feed URLs are matched but you can narrow
+ * this matching down by choosing a value for `T` in the
+ * `YouTubeFeedType` union.
+ */
+export type YouTubeFeedUrl<T extends YouTubeFeedType = YouTubeFeedType> = `https://www.youtube.com/${AsString<FeedMap<T>>}${string}` | `https://youtube.com/${AsString<FeedMap<T>>}${string}`;
+/**
+ * **YouTubeUsersPlaylistUrl**
+ *
+ * The URL which brings a logged in user to their own playlists.
+ *
+ * **Related:** `YouTubePlaylistUrl`
+ */
+export type YouTubeUsersPlaylistUrl = `https://www.youtube.com/feed/playlists${AnyQueryParams}`;
+/**
+ * **YouTubeLikedPlaylistUrl**
+ *
+ * The URL which brings a logged in user to a playlist of their _liked_
+ * videos.
+ */
+export type YouTubeLikedPlaylistUrl = `https://www.youtube.com/playlist?${string}list=LL${string}`;
+/**
+ * **YouTubeVideosInPlaylist**
+ *
+ * A URL which shows all the videos in a given playlist
+ */
+export type YouTubeVideosInPlaylist = `https://www.youtube.com/playlist?${string}list=${string}`;
+/**
+ * **YouTubeHistoryUrl**
+ *
+ * The URL which brings a logged in user to a list of their previously watched
+ * videos.
+ */
+export type YouTubeHistoryUrl = `https://www.youtube.com/feed/history${AnyQueryParams}`;
+/**
+ * **YouTubeSubscriptionsUrl**
+ *
+ * The URL which brings a logged in user to their list of subscriptions.
+ */
+export type YouTubeSubscriptionsUrl = `https://www.youtube.com/feed/subscriptions${AnyQueryParams}`;
+/**
+ * **GetYouTubePageType**`<T>`
+ *
+ * Given a URL passed into `T`, this utility will give you an indication
+ * of what type of YouTube content you'll find at this location (or return
+ * _never_ if it's not a YouTube URL).
+ */
+export type GetYouTubePageType<T> = T extends YouTubeUrl ? T extends YouTubeHome ? "home" : T extends YouTubeVideoUrl ? HasQueryParameter<T, "list"> extends true ? T extends YouTubeShareUrl ? HasQueryParameter<T, "t"> extends true ? "play::video::in-list::share-link::with-timestamp" : "play::video::in-list::share-link" : "play::video::in-list" : T extends YouTubeShareUrl ? HasQueryParameter<T, "t"> extends true ? "play::video::solo::share-link::with-timestamp" : "play::video::solo::share-link" : "play::video::solo" : T extends YouTubeCreatorUrl ? GetUrlPath<T> extends `${string}/videos` ? "creator::videos" : GetUrlPath<T> extends `${string}/playlists` ? "creator::playlists" : Last<Split<GetUrlPath<T>, "/">> extends `@${string}` ? "creator::featured" : GetUrlPath<T> extends `${string}/featured` ? "creator::featured" : "creator::other" : T extends YouTubeFeedUrl ? T extends YouTubeFeedUrl<"history"> ? "feed::history" : T extends YouTubeFeedUrl<"playlists"> ? "feed::playlists" : T extends YouTubeFeedUrl<"liked"> ? "feed::liked" : T extends YouTubeFeedUrl<"subscriptions"> ? "feed::subscriptions" : T extends YouTubeFeedUrl<"trending"> ? "feed::trending" : "feed::other" : T extends YouTubeVideosInPlaylist ? "playlist::show" : "other" : never;
+export {};
+//# sourceMappingURL=YouTube.d.ts.map

package/dist/types/string-literals/character-sets/YouTube.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"YouTube.d.ts","sourceRoot":"","sources":["../../../../src/types/string-literals/character-sets/YouTube.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,QAAQ,EACR,QAAQ,EACR,iBAAiB,EACjB,OAAO,EACP,OAAO,EACP,IAAI,EACJ,KAAK,EACL,YAAY,EACZ,YAAY,EACZ,cAAc,EACd,UAAU,EACV,QAAQ,EACR,QAAQ,EACT,oBAAwB;AAIzB;;;;GAIG;AACH,MAAM,MAAM,eAAe,GACzB,MAAM,GACN,mBAAmB,GACnB,+BAA+B,GAC/B,+CAA+C,GAC/C,sBAAsB,GACtB,kCAAkC,GAClC,kDAAkD,GAClD,gBAAgB,GAChB,mBAAmB,GACnB,iBAAiB,GACjB,oBAAoB,GACpB,gBAAgB,GAChB,eAAe,GACf,iBAAiB,GACjB,aAAa,GACb,qBAAqB,GACrB,gBAAgB,GAChB,aAAa,GACb,OAAO,CAAC;AAEV,MAAM,MAAM,eAAe,GAAG,SAAS,GAAG,WAAW,GAAG,OAAO,GAAG,eAAe,GAAG,UAAU,GAAG,OAAO,CAAC;AAEzG;;;;GAIG;AACH,MAAM,MAAM,UAAU,GAAG,QAAQ,CAAC,CAAC,iBAAiB,EAAE,aAAa,EAAE,UAAU,CAAC,CAAC,CAAC;AAElF;;;;GAIG;AACH,MAAM,MAAM,WAAW,GAAG,0BAA0B,cAAc,EAAE,GAAG,sBAAsB,cAAc,EAAE,CAAA;AAE7G;;;;GAIG;AACH,MAAM,MAAM,eAAe,GAAG,QAAQ,CAAC,UAAU,CAAC,CAAC;AAEnD;;;;;;;;;GASG;AACH,MAAM,MAAM,eAAe,GAAG,QAAQ,CAAC;IACrC,uBAAuB;IAAE,mBAAmB;CAC7C,CAAC,GAAG,eAAe,CAAC;AAErB;;;;;GAKG;AACH,MAAM,MAAM,iBAAiB,GAAG,QAAQ,CAAC;IACvC,2BAA2B,MAAM,EAAE;IACnC,uBAAuB,MAAM,EAAE;CAChC,CAAC,GAAG,4BAA4B,MAAM,GAAG,QAAQ,CAAC,WAAW,GAAG,SAAS,GAAG,YAAY,CAAC,EAAE,CAAA;AAG5F;;;;;;;GAOG;AACH,MAAM,MAAM,kBAAkB,GAAG,QAAQ,CAAC;IACxC,mCAAmC;IACnC,oBAAoB,MAAM,YAAY;IACtC,+BAA+B;IAC/B,gBAAgB,MAAM,YAAY;CACnC,CAAC,GAAG,uBAAuB,CAAC;AAE7B,KAAK,QAAQ,CAAC,CAAC,SAAS,eAAe,IAAI,OAAO,CAAC,CAAC,EAAC,eAAe,CAAC,SAAS,IAAI,GAChF,MAAM,GACN,CAAC,SAAS,OAAO,GACjB,kBAAkB,GAClB,QAAQ,CAAC,CAAC,SAAS,EAAC,WAAW,EAAC,UAAU,EAAC,eAAe,CAAC,EAAC,CAAC,CAAC,SAAS,IAAI,GACzE,QAAQ,CAAC,EAAE,GACX,QAAQ,MAAM,EAAE,CAAC;AAErB;;GAEG;AACH,KAAK,OAAO,CAAC,CAAC,SAAS,eAAe,IAAI,OAAO,CAAC,CAAC,CAAC,SAAS,IAAI,GAC7D,YAAY,CAAC;KACV,CAAC,IAAI,MAAM,YAAY,CAAC,CAAC,CAAC,GAAG,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,eAAe,GACpE,QAAQ,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAC5B,KAAK;CACV,CAAC,GACF,QAAQ,CAAC,CAAC,CAAC,CAAE;AAEjB;;;;;;;;;;GAUG;AACH,MAAM,MAAM,cAAc,CACxB,CAAC,SAAS,eAAe,GAAG,eAAe,IAE1C,2BAA2B,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,GAAG,MAAM,EAAE,GAC1D,uBAAuB,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,GAAG,MAAM,EAAE,CAAC;AAE1D;;;;;;GAMG;AACH,MAAM,MAAM,uBAAuB,GAAG,yCAAyC,cAAc,EAAE,CAAA;AAE/F;;;;;GAKG;AACH,MAAM,MAAM,uBAAuB,GAAG,oCAAoC,MAAM,UAAU,MAAM,EAAE,CAAA;AAElG;;;;GAIG;AACH,MAAM,MAAM,uBAAuB,GAAG,oCAAoC,MAAM,QAAQ,MAAM,EAAE,CAAA;AAEhG;;;;;GAKG;AACH,MAAM,MAAM,iBAAiB,GAAG,uCAAuC,cAAc,EAAE,CAAC;AAExF;;;;GAIG;AACH,MAAM,MAAM,uBAAuB,GAAG,6CAA6C,cAAc,EAAE,CAAC;AAGpG;;;;;;GAMG;AACH,MAAM,MAAM,kBAAkB,CAAC,CAAC,IAAI,CAAC,SAAS,UAAU,GACtD,CAAC,SAAS,WAAW,GACnB,MAAM,GACR,CAAC,SAAS,eAAe,GACrB,iBAAiB,CAAC,CAAC,EAAC,MAAM,CAAC,SAAS,IAAI,GACtC,CAAC,SAAS,eAAe,GACvB,iBAAiB,CAAC,CAAC,EAAC,GAAG,CAAC,SAAS,IAAI,GACjC,kDAAkD,GAClD,kCAAkC,GACtC,sBAAsB,GACxB,CAAC,SAAS,eAAe,GACvB,iBAAiB,CAAC,CAAC,EAAC,GAAG,CAAC,SAAS,IAAI,GACnC,+CAA+C,GAC/C,+BAA+B,GACjC,mBAAmB,GAC3B,CAAC,SAAS,iBAAiB,GACvB,UAAU,CAAC,CAAC,CAAC,SAAS,GAAG,MAAM,SAAS,GACtC,iBAAiB,GACjB,UAAU,CAAC,CAAC,CAAC,SAAS,GAAG,MAAM,YAAY,GAC3C,oBAAoB,GACpB,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC,SAAS,IAAI,MAAM,EAAE,GACpD,mBAAmB,GACnB,UAAU,CAAC,CAAC,CAAC,SAAS,GAAG,MAAM,WAAW,GAC1C,mBAAmB,GACnB,gBAAgB,GACtB,CAAC,SAAS,cAAc,GACpB,CAAC,SAAS,cAAc,CAAC,SAAS,CAAC,GACjC,eAAe,GACf,CAAC,SAAS,cAAc,CAAC,WAAW,CAAC,GACrC,iBAAiB,GACjB,CAAC,SAAS,cAAc,CAAC,OAAO,CAAC,GACjC,aAAa,GACb,CAAC,SAAS,cAAc,CAAC,eAAe,CAAC,GACzC,qBAAqB,GACrB,CAAC,SAAS,cAAc,CAAC,UAAU,CAAC,GACpC,gBAAgB,GAChB,aAAa,GACnB,CAAC,SAAS,uBAAuB,GAC/B,gBAAgB,GAClB,OAAO,GACP,KAAK,CAAC"}

package/dist/types/string-literals/character-sets/YouTube.js

@@ -0,0 +1 @@
+export {};

package/dist/types/string-literals/character-sets/index.d.ts

@@ -25,6 +25,9 @@ export * from "./CSS";
 export * from "./InlineSvg";
 export * from "./Repos";
 export * from "./Variable";
+export * from "./Optional";
+export * from "./YouTube";
+export * from "./phone";
 export * from "./brackets/index";
 export * from "./quotation-marks/index";
 //# sourceMappingURL=index.d.ts.map

package/dist/types/string-literals/character-sets/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/types/string-literals/character-sets/index.ts"],"names":[],"mappings":"AAAA,cAAc,SAAS,CAAC;AACxB,cAAc,cAAc,CAAC;AAC7B,cAAc,YAAY,CAAC;AAC3B,cAAc,aAAa,CAAC;AAC5B,cAAc,kBAAkB,CAAC;AACjC,cAAc,kBAAkB,CAAC;AACjC,cAAc,eAAe,CAAC;AAC9B,cAAc,cAAc,CAAC;AAC7B,cAAc,OAAO,CAAC;AACtB,cAAc,OAAO,CAAC;AACtB,cAAc,cAAc,CAAC;AAC7B,cAAc,aAAa,CAAC;AAC5B,cAAc,iBAAiB,CAAC;AAChC,cAAc,mBAAmB,CAAC;AAClC,cAAc,cAAc,CAAC;AAC7B,cAAc,eAAe,CAAC;AAC9B,cAAc,eAAe,CAAC;AAC9B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,eAAe,CAAC;AAC9B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,kBAAkB,CAAC;AACjC,cAAc,cAAc,CAAC;AAC7B,cAAc,aAAa,CAAC;AAC5B,cAAc,OAAO,CAAC;AACtB,cAAc,aAAa,CAAC;AAC5B,cAAc,SAAS,CAAC;AACxB,cAAc,YAAY,CAAC;AAE3B,cAAc,kBAAkB,CAAC;AACjC,cAAc,yBAAyB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/types/string-literals/character-sets/index.ts"],"names":[],"mappings":"AAAA,cAAc,SAAS,CAAC;AACxB,cAAc,cAAc,CAAC;AAC7B,cAAc,YAAY,CAAC;AAC3B,cAAc,aAAa,CAAC;AAC5B,cAAc,kBAAkB,CAAC;AACjC,cAAc,kBAAkB,CAAC;AACjC,cAAc,eAAe,CAAC;AAC9B,cAAc,cAAc,CAAC;AAC7B,cAAc,OAAO,CAAC;AACtB,cAAc,OAAO,CAAC;AACtB,cAAc,cAAc,CAAC;AAC7B,cAAc,aAAa,CAAC;AAC5B,cAAc,iBAAiB,CAAC;AAChC,cAAc,mBAAmB,CAAC;AAClC,cAAc,cAAc,CAAC;AAC7B,cAAc,eAAe,CAAC;AAC9B,cAAc,eAAe,CAAC;AAC9B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,eAAe,CAAC;AAC9B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,kBAAkB,CAAC;AACjC,cAAc,cAAc,CAAC;AAC7B,cAAc,aAAa,CAAC;AAC5B,cAAc,OAAO,CAAC;AACtB,cAAc,aAAa,CAAC;AAC5B,cAAc,SAAS,CAAC;AACxB,cAAc,YAAY,CAAC;AAC3B,cAAc,YAAY,CAAC;AAC3B,cAAc,WAAW,CAAC;AAC1B,cAAc,SAAS,CAAC;AAExB,cAAc,kBAAkB,CAAC;AACjC,cAAc,yBAAyB,CAAC"}

package/dist/types/string-literals/character-sets/index.js

@@ -25,5 +25,8 @@ export * from "./CSS.js";
 export * from "./InlineSvg.js";
 export * from "./Repos.js";
 export * from "./Variable.js";
+export * from "./Optional.js";
+export * from "./YouTube.js";
+export * from "./phone.js";
 export * from "./brackets/index.js";
 export * from "./quotation-marks/index.js";

package/dist/types/string-literals/character-sets/phone.d.ts

@@ -0,0 +1,192 @@
+import { PHONE_COUNTRY_CODES, PHONE_FORMAT } from "../../../constants/index";
+import { AsString, FirstOfEach, IsLessThan, IsStringLiteral, Length, NumericChar, RetainChars, StartsWith, StripChars, Trim, TupleToUnion, Whitespace, Mutable, HasPhoneCountryCode, Optional, RetainUntil, Not, And, Throw, IsGreaterThan, HasCharacters, Extends, Or, OnPass, ErrorCondition, Unset, If, IsLength, Contains } from "../../index";
+/**
+ * delimiter characters commonly used to separate digits in phone numbers
+ */
+export type PhoneNumberDelimiter = " " | "-" | ".";
+/**
+ * **PhoneFormat**
+ *
+ * A union type of _formats_ used for telephone numbers
+ */
+export type PhoneFormat = TupleToUnion<typeof PHONE_FORMAT>;
+/**
+ * **PhoneCountryCode**
+ *
+ * The official list of _phone_ country codes
+ *
+ * **Related:** `DialCountryCode`
+ */
+export type PhoneCountryCode = FirstOfEach<Mutable<typeof PHONE_COUNTRY_CODES>>;
+/**
+ * **DialCountryCode**
+ *
+ * A simplified representation of `PhoneCountryCode` so as to not make other
+ * phone patterns too complex.
+ */
+export type DialCountryCode = `${"+" | "00"}${`1-${number}` | `${Exclude<NumericChar, "0">}`}${Optional<`${number}`>}`;
+/**
+ * **LocalPhoneNumber**`<[TDelimiter]>`
+ *
+ * Provides a shape for phone numbers local a region of country that do
+ * not have a _country code_ designation nor what is referred to as the
+ * "area code" in the USA.
+ *
+ * **Related:** `CountryPhoneNumber`, `InternationalPhoneNumber`, `PhoneNumber`
+ */
+export type LocalPhoneNumber<TDelimiter extends PhoneNumberDelimiter = PhoneNumberDelimiter> = `${NumericChar}${number}${TDelimiter}${number}`;
+/**
+ * **PhoneAreaCode**
+ */
+export type PhoneAreaCode = `(${number})` | `${NumericChar}${number}`;
+/**
+ * **PhoneShortCode**`<[T]>`
+ *
+ * A [phone short code](https://en.wikipedia.org/wiki/Short_code) is a short numeric
+ * phone number typically used for SMS/MMS purposes but can be call based too.
+ *
+ * There are regional variances but typically are always _less_ digits than a regional
+ * phone number of 7 digits.
+ *
+ * This utility -- when used without a generic `T` -- will just give a basic shape
+ * for the short code but not really validate it.
+ *
+ * If you want validation, pass it the value you're testing in as `T`. If `T` is a
+ * valid short code then it will be proxied through "as is" but if it is not, it
+ * will be converted to an `ErrorCondition<"invalid-short-code">`
+ */
+export type PhoneShortCode<T extends string | null = null> = T extends null ? `${NumericChar}${number}${NumericChar}` : T extends string ? IsStringLiteral<T> extends true ? T extends `${number}` ? IsGreaterThan<Length<T>, 6> extends true ? Throw<"invalid-short-code", `Short codes must be less than 7 digits [${Length<T>}]`> : T : Throw<"invalid-short-code", `Short codes may vary from region to region but they must always contain only numbers: ${T}!`> : string : never;
+/**
+ * **CountryPhoneNumber**`<[TDelimiter]>`
+ *
+ * Provides a shape phone number meant for use within a country. It includes
+ * the local number plus what would be referred to as the "area code" in the
+ * USA.
+ *
+ * **Related:** `InternationalPhoneNumber`, `LocalPhoneNumber`, `PhoneNumber`
+ */
+export type CountryPhoneNumber<TDelimiter extends PhoneNumberDelimiter = PhoneNumberDelimiter> = `${PhoneAreaCode}${TDelimiter}${LocalPhoneNumber<TDelimiter>}`;
+/**
+ * **InternationalPhoneNumber**`<[TDelimiter]>`
+ *
+ * A phone number which explicitly leads by expressing the _country_ that the number belongs to.
+ *
+ * - uses `+` or `00` prefix to mark as a country code
+ *
+ * **Related:** `CountryPhoneNumber`, `LocalPhoneNumber`, `PhoneNumber`
+ */
+export type InternationalPhoneNumber<TDelimiter extends PhoneNumberDelimiter = PhoneNumberDelimiter> = `${DialCountryCode}${TDelimiter}${CountryPhoneNumber<TDelimiter>}`;
+type _RightLength<T extends string> = If<StartsWith<T, "+">, If<Contains<T, "1-">, // using 1- for country code nomenclature
+If<IsLength<T, 16>, T, ErrorCondition<"invalid-raw-phone-number", `Wrong number of characters for international number: ${T}`>>, If<IsLength<T, 15>, T, ErrorCondition<"invalid-raw-phone-number", `Wrong number of characters for international number: ${T}`>>>, If<StartsWith<T, "00">, If<Contains<T, "1-">, // using 1- for country code nomenclature
+If<IsLength<T, 15>, T, ErrorCondition<"invalid-raw-phone-number", `Wrong number of characters for international number: ${T}`>>, If<IsLength<T, 14>, T, ErrorCondition<"invalid-raw-phone-number", `Wrong number of characters for international number: ${T}`>>>, If<Or<[IsLength<T, 10>, IsLength<T, 12>]>, T, If<And<[IsGreaterThan<Length<T>, 2>, IsLessThan<Length<T>, 8>]>, T, ErrorCondition<"invalid-raw-phone-number">>>>>;
+type _RightChars<T extends string> = StripChars<T, NumericChar | "+" | "-"> extends "" ? T : ErrorCondition<"invalid-raw-phone-number", `The only valid characters in a raw phone number is numeric characters with the rare exception of a "+" or "-" when used in the right manner`>;
+/**
+ * **RawPhoneNumber**`<[T]>`
+ *
+ * This is the most compact form of phone number storage as it has no delimiters
+ * but still can contain a number representing an international,
+ * country or regional phone number and even a `PhoneShortCode`.
+ *
+ * **Generic Use**
+ *
+ * - without using the generic, you'll get a very basic shape that can be used as in input
+ * type but it will by no means ensure this _is_ a RawPhone number
+ * - to get real validation that a type is a `RawPhoneNumber` pass it in as `T`
+ * - valid values are:
+ *    - numeric only characters with the exception of:
+ *      - possible start of `+`
+ *      - possible inclusion of `1-${number}` in country code area
+ *    - length of 3-7, 10, 12 digits
+ *    - 14 digits if it leads with `00` or `+`
+ */
+export type RawPhoneNumber<T extends string | Unset = Unset> = T extends Unset ? `${Optional<"+">}${number}${NumericChar}${NumericChar}` : T extends string ? IsStringLiteral<T> extends true ? OnPass<[
+    _RightChars<T>,
+    _RightLength<T>
+], T> : T | ErrorCondition<"invalid-raw-phone-number"> : never;
+/** T or ErrorCondition */
+type _AppropriateNumerics<T extends string> = HasPhoneCountryCode<T> extends true ? IsLessThan<Length<RetainChars<RemovePhoneCountryCode<T>, NumericChar>>, 10> extends true ? Throw<"invalid-phone-number", `Invalid international phone number; international numbers require at least 10 numeric digits beyond the country code: ${T}`, `PhoneNumber`> : T : HasCharacters<Trim<T>, PhoneNumberDelimiter> extends true ? Not<Or<[
+    Extends<Length<RetainChars<RemovePhoneCountryCode<T>, NumericChar>>, 10>,
+    Extends<Length<RetainChars<RemovePhoneCountryCode<T>, NumericChar>>, 7>
+]>> extends true ? Throw<"invalid-phone-number", `Phone numbers which have " ", "-", or "." delimiters can not be short codes and therefore must have a length of 7 or 10 digits not ${Length<RetainChars<RemovePhoneCountryCode<T>, NumericChar>>}!`> : T : Trim<T> extends "" ? Throw<"invalid-phone-number", "No numeric characters found!"> : T;
+/** T or ErrorCondition */
+type _ValidChars<T extends string> = StripChars<T, IsGreaterThan<Length<T>, 6> extends true ? NumericChar | "(" | ")" | Whitespace | "-" | "." : NumericChar> extends "" ? true : Throw<"invalid-phone-number", IsGreaterThan<Length<T>, 6> extends true ? `Excluding any country code references, the only valid characters in a phone number are numeric characters and '-', '.', and parenthesis but other characters were found: ${Trim<T>}` : `The phone number passed in has less than 7 numeric digits which means that it is either a short code or this is an invalid number ... short codes can only accept numeric digits though and we found more than that: ${Trim<T>}`>;
+type _InvalidCountryCode<T extends string> = And<[
+    HasPhoneCountryCode<T, false>,
+    Not<HasPhoneCountryCode<T, true>>
+]> extends true ? Throw<"invalid-phone-number", `This looked like an international number but the country code ${GetPhoneCountryCode<T>} is not a valid country code!`> : true;
+/**
+ * **PhoneNumber**`<[T]>`
+ *
+ * Without use of the generic `T`, provides a basic shape for phone
+ * numbers which should keep people on good behavior when
+ * accepting phone numbers.
+ *
+ * When passing a string into `T`, this utility will do a lot more
+ * validity checking on the value.
+ *
+ * - Only valid characters (numeric, whitespace, `+`, `-`, `.`, and parenthesis)
+ * - all _leading_ and _trailing_ whitespace removed for remaining comparisons
+ * - at least 7 numeric characters
+ *    - 8 if `+` character used as leading character (after whitespace)
+ *    - 10 if `00` are leading characters
+ * - leading character (after whitespace) must be numeric, `(` or `+`
+ */
+export type PhoneNumber<T extends string | null = null, TDelimiter extends PhoneNumberDelimiter = PhoneNumberDelimiter> = T extends null ? LocalPhoneNumber<TDelimiter> | CountryPhoneNumber<TDelimiter> | InternationalPhoneNumber<TDelimiter> : T extends string ? IsStringLiteral<T> extends true ? OnPass<[
+    _ValidChars<RemovePhoneCountryCode<T>>,
+    _InvalidCountryCode<T>,
+    _AppropriateNumerics<T>
+], T> : string : never;
+/**
+ * GetPhoneCountryCode`<T>`
+ *
+ * Attempts to find a country code signature in a phone number.
+ *
+ * - it returns the country code without the leading `+` or `00` prefix
+ * - if there is no delimiter or prefix for the country code then, then it
+ * will use a _real_ list of country codes to try to extract this value
+ * - if not found it returns an empty string (`""`)
+ * - if `T` is a _wide_ string string then this will return `string` back
+ */
+export type GetPhoneCountryCode<T> = T extends string ? [IsStringLiteral<T>] extends [true] ? StartsWith<Trim<T>, "+" | "00"> extends true ? [Trim<T>] extends [`${"+" | "00"}${infer CC}${PhoneNumberDelimiter}${string}`] ? RetainUntil<CC, " "> : "" : "" : string : never;
+/**
+ * **RemoveCountryCode**`<T,[TExplicitCountryCode]>`
+ *
+ * Removes the country code -- where present -- to reveal
+ * just a country-based number.
+ *
+ * **Note:** there are two approaches this utility can take toward
+ * removal of the country code:
+ *
+ * - the default relies on a space delimiter being present between
+ * the country code and the remaining phone number; use this if
+ * this is a reasonable assumption as it is more type performant.
+ * - if you might have a string of numbers -- even possibly without
+ * the `+` or `00` prefixes -- then you can set `TExplicitCountryCode`
+ * to `true`
+ *   - when set to true, it will still be able to extract _real_ country codes
+ * from the string but if an _imagined_ country code has been entered it will
+ * fail.
+ *   - if it is an _imagined_ country code which does have a `+` or `00` prefix
+ * then the type will be `ErrorCondition<"invalid-country-code">`
+ *   - if no country code prefix then you'll likely get a
+ * `ErrorCondition<"too-many-digits">` error (unless of course your have _other_
+ * problems).
+ */
+export type RemovePhoneCountryCode<T> = T extends string ? IsStringLiteral<T> extends true ? GetPhoneCountryCode<Trim<T>> extends "" ? T : Trim<T> extends `+${GetPhoneCountryCode<Trim<T>>} ${infer Rest}` ? Rest : T : string : never;
+export type PhoneNumberType = "international" | "country" | "regional" | "short-code";
+/**
+ * **GetPhoneNumberType**`<T>`
+ *
+ * Indicates whether the phone number is "international", "country", or "regional"
+ * based on the shape and number of digits
+ */
+export type GetPhoneNumberType<T> = T extends string ? IsStringLiteral<T> extends true ? HasPhoneCountryCode<T, false> extends true ? "international" : IsLessThan<Length<RetainChars<Trim<AsString<T>>, NumericChar>>, 8> extends true ? Length<RetainChars<Trim<AsString<T>>, NumericChar>> extends 7 ? "regional" : "short-code" : "country" : string : never;
+type FormatLookup<T extends string> = {
+    "Dashed (e.g., 456-555-1212)": HasPhoneCountryCode<T> extends true ? `+${GetPhoneCountryCode<T>} ${number}-${number}-${number}` : GetPhoneNumberType<T> extends "regional" ? `${number}-${number}` : `${number}-${number}-${number}`;
+    "Dotted (e.g., 456.555.1212)": HasPhoneCountryCode<T> extends true ? `+${GetPhoneCountryCode<T>} ${number}.${number}.${number}` : GetPhoneNumberType<T> extends "regional" ? `${number}.${number}` : `${number}.${number}-${number}`;
+    "ParaSpaced (e.g., (456) 555 1212)": "";
+    "ParaDashed (e.g., (456) 555-1212)": "";
+} & Record<PhoneFormat, any>;
+export type ToPhoneFormat<TPhone extends string, TFormat extends PhoneFormat> = IsStringLiteral<TPhone> extends true ? PhoneNumber<TPhone> extends string ? Trim<TPhone> & FormatLookup<TPhone>[TFormat] : PhoneNumber<TPhone> : FormatLookup<TPhone>[TFormat] | ErrorCondition<"invalid-phone-number">;
+export {};
+//# sourceMappingURL=phone.d.ts.map