inferred-types 0.46.1 → 0.47.0

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,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"}
+{"version":3,"file":"Whitespace.d.ts","sourceRoot":"","sources":["../../../../src/types/string-literals/character-sets/Whitespace.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,iCAA4B;AAC5D,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/index.d.ts

@@ -27,7 +27,7 @@ export * from "./Repos";
 export * from "./Variable";
 export * from "./Optional";
 export * from "./YouTube";
-export * from "./phone";
 export * from "./brackets/index";
 export * from "./quotation-marks/index";
+export * from "./phone/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;AAC3B,cAAc,YAAY,CAAC;AAC3B,cAAc,WAAW,CAAC;AAC1B,cAAc,SAAS,CAAC;AAExB,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;AAE1B,cAAc,kBAAkB,CAAC;AACjC,cAAc,yBAAyB,CAAC;AACxC,cAAc,eAAe,CAAC"}

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

@@ -27,6 +27,6 @@ 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";
+export * from "./phone/index.js";

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

@@ -0,0 +1,12 @@
+import { LocalPhoneNumber, PhoneAreaCode, PhoneNumberDelimiter } from "../../../index";
+/**
+ * **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>}`;
+//# sourceMappingURL=CountryPhoneNumber.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"CountryPhoneNumber.d.ts","sourceRoot":"","sources":["../../../../../src/types/string-literals/character-sets/phone/CountryPhoneNumber.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,gBAAgB,EAChB,aAAa,EACb,oBAAoB,EACrB,uBAAwB;AAIzB;;;;;;;;GAQG;AACH,MAAM,MAAM,kBAAkB,CAC5B,UAAU,SAAS,oBAAoB,GAAG,oBAAoB,IAC5D,GAAG,aAAa,GAAG,UAAU,GAAG,gBAAgB,CAAC,UAAU,CAAC,EAAE,CAAA"}

package/dist/types/string-literals/character-sets/phone/CountryPhoneNumber.js

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

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

@@ -0,0 +1,9 @@
+import { NumericChar, Optional } from "../../../index";
+/**
+ * **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}`>}`;
+//# sourceMappingURL=DialCountryCode.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"DialCountryCode.d.ts","sourceRoot":"","sources":["../../../../../src/types/string-literals/character-sets/phone/DialCountryCode.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,QAAQ,EAAE,uBAAwB;AAExD;;;;;GAKG;AACH,MAAM,MAAM,eAAe,GAAG,GAAG,GAAG,GAAG,IAAI,GAAI,KAAK,MAAM,EAAE,GAAG,GAAG,OAAO,CAAC,WAAW,EAAE,GAAG,CAAC,EAAE,GAAG,QAAQ,CAAC,GAAG,MAAM,EAAE,CAAC,EAAE,CAAC"}

package/dist/types/string-literals/character-sets/phone/DialCountryCode.js

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

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

@@ -0,0 +1,14 @@
+import { IsStringLiteral, PhoneNumberDelimiter, RetainUntil, StartsWith, Trim } from "../../../index";
+/**
+ * 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;
+//# sourceMappingURL=GetPhoneCountryCode.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"GetPhoneCountryCode.d.ts","sourceRoot":"","sources":["../../../../../src/types/string-literals/character-sets/phone/GetPhoneCountryCode.ts"],"names":[],"mappings":"AACA,OAAO,EACL,eAAe,EACf,oBAAoB,EACpB,WAAW,EACX,UAAU,EACV,IAAI,EACL,uBAAuB;AAExB;;;;;;;;;;GAUG;AACH,MAAM,MAAM,mBAAmB,CAAC,CAAC,IAAI,CAAC,SAAS,MAAM,GACnD,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,IAAI,CAAC,GAC/B,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,GAAG,GAAG,IAAI,CAAC,SAAS,IAAI,GAC1C,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,GAAG,GAAG,GAAG,IAAI,GAAG,MAAM,EAAE,GAAG,oBAAoB,GAAG,MAAM,EAAE,CAAC,GAC5E,WAAW,CAAC,EAAE,EAAE,GAAG,CAAC,GACpB,EAAE,GACJ,EAAE,GACJ,MAAM,GACV,KAAK,CAAC"}

package/dist/types/string-literals/character-sets/phone/GetPhoneCountryCode.js

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

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

@@ -0,0 +1,10 @@
+import { HasPhoneCountryCode, IsLessThan, IsStringLiteral, NumericChar, RetainChars, StrLen, Trim } from "../../../index";
+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<StrLen<RetainChars<Trim<`${T}`>, NumericChar>>, 8> extends true ? StrLen<RetainChars<Trim<`${T}`>, NumericChar>> extends 7 ? "regional" : "short-code" : "country" : string : never;
+//# sourceMappingURL=GetPhoneNumberType.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"GetPhoneNumberType.d.ts","sourceRoot":"","sources":["../../../../../src/types/string-literals/character-sets/phone/GetPhoneNumberType.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,mBAAmB,EACnB,UAAU,EACV,eAAe,EACf,WAAW,EACX,WAAW,EACX,MAAM,EACN,IAAI,EACL,uBAAwB;AAGzB,MAAM,MAAM,eAAe,GAAG,eAAe,GAAG,SAAS,GAAG,UAAU,GAAG,YAAY,CAAC;AAEtF;;;;;GAKG;AACH,MAAM,MAAM,kBAAkB,CAAC,CAAC,IAAI,CAAC,SAAS,MAAM,GAClD,eAAe,CAAC,CAAC,CAAC,SAAS,IAAI,GAC7B,mBAAmB,CAAC,CAAC,EAAC,KAAK,CAAC,SAAS,IAAI,GACvC,eAAe,GACf,UAAU,CACR,MAAM,CACJ,WAAW,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,EACxB,WAAW,CACZ,CAAC,EACF,CAAC,CACF,SAAS,IAAI,GACV,MAAM,CACJ,WAAW,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,EACxB,WAAW,CACZ,CAAC,SAAS,CAAC,GACV,UAAU,GACV,YAAY,GACd,SAAS,GACjB,MAAM,GACN,KAAK,CAAC"}

package/dist/types/string-literals/character-sets/phone/GetPhoneNumberType.js

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

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

@@ -0,0 +1,12 @@
+import { CountryPhoneNumber, DialCountryCode, PhoneNumberDelimiter } from "../../../index";
+/**
+ * **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>}`;
+//# sourceMappingURL=InternationalPhoneNumber.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"InternationalPhoneNumber.d.ts","sourceRoot":"","sources":["../../../../../src/types/string-literals/character-sets/phone/InternationalPhoneNumber.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,kBAAkB,EAClB,eAAe,EACf,oBAAoB,EACrB,uBAAuB;AAExB;;;;;;;;GAQG;AACH,MAAM,MAAM,wBAAwB,CAClC,UAAU,SAAS,oBAAoB,GAAG,oBAAoB,IAC5D,GAAG,eAAe,GAAG,UAAU,GAAG,kBAAkB,CAAC,UAAU,CAAC,EAAE,CAAC"}

package/dist/types/string-literals/character-sets/phone/InternationalPhoneNumber.js

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

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

@@ -0,0 +1,12 @@
+import { NumericChar, PhoneNumberDelimiter } from "../../../index";
+/**
+ * **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}`;
+//# sourceMappingURL=LocalPhoneNumber.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"LocalPhoneNumber.d.ts","sourceRoot":"","sources":["../../../../../src/types/string-literals/character-sets/phone/LocalPhoneNumber.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,oBAAoB,EAAE,uBAAuB;AAEnE;;;;;;;;GAQG;AACH,MAAM,MAAM,gBAAgB,CAC5B,UAAU,SAAS,oBAAoB,GAAG,oBAAoB,IAC1D,GAAG,WAAW,GAAG,MAAM,GAAG,UAAU,GAAG,MAAM,EAAE,CAAC"}

package/dist/types/string-literals/character-sets/phone/LocalPhoneNumber.js

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

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

@@ -0,0 +1,6 @@
+import { NumericChar } from "../../../index";
+/**
+ * **PhoneAreaCode**
+ */
+export type PhoneAreaCode = `(${number})` | `${NumericChar}${number}`;
+//# sourceMappingURL=PhoneAreaCode.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"PhoneAreaCode.d.ts","sourceRoot":"","sources":["../../../../../src/types/string-literals/character-sets/phone/PhoneAreaCode.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,uBAAwB;AAG9C;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG,IAAI,MAAM,GAAG,GAAG,GAAG,WAAW,GAAG,MAAM,EAAE,CAAC"}

package/dist/types/string-literals/character-sets/phone/PhoneAreaCode.js

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

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

@@ -0,0 +1,13 @@
+import type { PHONE_COUNTRY_CODES } from "../../../../constants/index";
+import { FirstOfEach } from "../../../tuples";
+import { Mutable } from "../../../type-conversion";
+export type PhoneCountryLookup = Mutable<[...typeof PHONE_COUNTRY_CODES]>;
+/**
+ * **PhoneCountryCode**
+ *
+ * The official list of _phone_ country codes
+ *
+ * **Related:** `DialCountryCode`
+ */
+export type PhoneCountryCode = FirstOfEach<PhoneCountryLookup>;
+//# sourceMappingURL=PhoneCountryCode.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"PhoneCountryCode.d.ts","sourceRoot":"","sources":["../../../../../src/types/string-literals/character-sets/phone/PhoneCountryCode.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,mBAAmB,EAAE,oCAA4B;AAC/D,OAAO,EAAE,WAAW,EAAE,wBAAyB;AAC/C,OAAO,EAAE,OAAO,EAAE,iCAAkC;AAEpD,MAAM,MAAM,kBAAkB,GAAG,OAAO,CAAC,CAAC,GAAG,OAAO,mBAAmB,CAAC,CAAC,CAAC;AAE1E;;;;;;GAMG;AACH,MAAM,MAAM,gBAAgB,GAAG,WAAW,CAAC,kBAAkB,CAAC,CAAC"}

package/dist/types/string-literals/character-sets/phone/PhoneCountryCode.js

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

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

@@ -0,0 +1,23 @@
+import { LocalPhoneNumber, OnPass, PhoneNumberDelimiter, InternationalPhoneNumber, CountryPhoneNumber, IsStringLiteral, IsNumericLiteral, As, ErrorCondition } from "../../../index";
+type Process<T extends string, _TDelimiter extends PhoneNumberDelimiter = PhoneNumberDelimiter> = OnPass<[
+], T>;
+/**
+ * **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 number | string | null = null, TDelimiter extends PhoneNumberDelimiter = PhoneNumberDelimiter> = T extends null ? LocalPhoneNumber<TDelimiter> | CountryPhoneNumber<TDelimiter> | InternationalPhoneNumber<TDelimiter> : IsStringLiteral<T> extends true ? Process<As<T, string>, TDelimiter> : IsNumericLiteral<T> extends true ? Process<`${As<T, number>}`, TDelimiter> : T extends string ? string | ErrorCondition<"invalid-phone-number"> : T extends number ? number | ErrorCondition<"invalid-phone-number"> : never;
+export {};
+//# sourceMappingURL=PhoneNumber.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"PhoneNumber.d.ts","sourceRoot":"","sources":["../../../../../src/types/string-literals/character-sets/phone/PhoneNumber.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,gBAAgB,EAChB,MAAM,EACN,oBAAoB,EACpB,wBAAwB,EACxB,kBAAkB,EAClB,eAAe,EACf,gBAAgB,EAChB,EAAE,EACF,cAAc,EACf,uBAAwB;AAuDzB,KAAK,OAAO,CACV,CAAC,SAAS,MAAM,EAChB,WAAW,SAAS,oBAAoB,GAAG,oBAAoB,IAC7D,MAAM,CACJ;CAIC,EACD,CAAC,CACF,CAAC;AAIN;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,MAAM,WAAW,CACrB,CAAC,SAAS,MAAM,GAAG,MAAM,GAAG,IAAI,GAAG,IAAI,EACvC,UAAU,SAAS,oBAAoB,GAAG,oBAAoB,IAC5D,CAAC,SAAS,IAAI,GAChB,gBAAgB,CAAC,UAAU,CAAC,GAC5B,kBAAkB,CAAC,UAAU,CAAC,GAC9B,wBAAwB,CAAC,UAAU,CAAC,GACpC,eAAe,CAAC,CAAC,CAAC,SAAS,IAAI,GAC3B,OAAO,CAAC,EAAE,CAAC,CAAC,EAAE,MAAM,CAAC,EAAC,UAAU,CAAC,GACjC,gBAAgB,CAAC,CAAC,CAAC,SAAS,IAAI,GAC9B,OAAO,CAAC,GAAG,EAAE,CAAC,CAAC,EAAE,MAAM,CAAC,EAAE,EAAE,UAAU,CAAC,GACvC,CAAC,SAAS,MAAM,GAChB,MAAM,GAAG,cAAc,CAAC,sBAAsB,CAAC,GAC/C,CAAC,SAAS,MAAM,GAChB,MAAM,GAAG,cAAc,CAAC,sBAAsB,CAAC,GAC/C,KAAK,CAAC"}

package/dist/types/string-literals/character-sets/phone/PhoneNumber.js

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

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

@@ -0,0 +1,5 @@
+/**
+ * delimiter characters commonly used to separate digits in phone numbers
+ */
+export type PhoneNumberDelimiter = " " | "-" | ".";
+//# sourceMappingURL=PhoneNumberDelimiter.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"PhoneNumberDelimiter.d.ts","sourceRoot":"","sources":["../../../../../src/types/string-literals/character-sets/phone/PhoneNumberDelimiter.ts"],"names":[],"mappings":"AACA;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,CAAC"}

package/dist/types/string-literals/character-sets/phone/PhoneNumberDelimiter.js

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

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

@@ -0,0 +1,19 @@
+import { IsGreaterThan, IsStringLiteral, NumericChar, Throw } from "../../../index";
+/**
+ * **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<T["length"], 6> extends true ? Throw<"invalid-short-code", `Short codes must be less than 7 digits [${T["length"]}]`> : T : Throw<"invalid-short-code", `Short codes may vary from region to region but they must always contain only numbers: ${T}!`> : string : never;
+//# sourceMappingURL=PhoneShortCode.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"PhoneShortCode.d.ts","sourceRoot":"","sources":["../../../../../src/types/string-literals/character-sets/phone/PhoneShortCode.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,aAAa,EACb,eAAe,EACf,WAAW,EACX,KAAK,EACN,uBAAwB;AAEzB;;;;;;;;;;;;;;;GAeG;AACH,MAAM,MAAM,cAAc,CACxB,CAAC,SAAS,MAAM,GAAG,IAAI,GAAG,IAAI,IAC5B,CAAC,SAAS,IAAI,GAChB,GAAG,WAAW,GAAG,MAAM,GAAG,WAAW,EAAE,GACvC,CAAC,SAAS,MAAM,GACd,eAAe,CAAC,CAAC,CAAC,SAAS,IAAI,GAC7B,CAAC,SAAS,GAAG,MAAM,EAAE,GACnB,aAAa,CAAC,CAAC,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,SAAS,IAAI,GACxC,KAAK,CAAC,oBAAoB,EAAE,2CAA2C,CAAC,CAAC,QAAQ,CAAC,GAAG,CAAC,GACtF,CAAC,GACH,KAAK,CAAC,oBAAoB,EAAE,yFAAyF,CAAC,GAAG,CAAC,GAC5H,MAAM,GACV,KAAK,CAAC"}

package/dist/types/string-literals/character-sets/phone/PhoneShortCode.js

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

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

@@ -0,0 +1,30 @@
+import { And, Contains, ErrorCondition, If, IsEqual, IsGreaterThan, IsLessThan, IsStringLiteral, NumericChar, OnPass, Optional, Or, StartsWith, StripChars, StrLen, Unset } from "../../../index";
+type _RightLength<T extends string> = If<StartsWith<T, "+">, If<Contains<T, "1-">, // using 1- for country code nomenclature
+If<StrLen<T> extends 16 ? true : false, T, ErrorCondition<"invalid-raw-phone-number", `Wrong number of characters for international number: ${T}`>>, If<StrLen<T> extends 15 ? true : false, 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<StrLen<T> extends 15 ? true : false, T, ErrorCondition<"invalid-raw-phone-number", `Wrong number of characters for international number: ${T}`>>, If<StrLen<T> extends 14 ? true : false, T, ErrorCondition<"invalid-raw-phone-number", `Wrong number of characters for international number: ${T}`>>>, If<Or<[IsEqual<StrLen<T>, 10>, IsEqual<StrLen<T>, 12>]>, T, If<And<[IsGreaterThan<StrLen<T>, 2>, IsLessThan<StrLen<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;
+export {};
+//# sourceMappingURL=RawPhoneNumber.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"RawPhoneNumber.d.ts","sourceRoot":"","sources":["../../../../../src/types/string-literals/character-sets/phone/RawPhoneNumber.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,GAAG,EACH,QAAQ,EACR,cAAc,EACd,EAAE,EACF,OAAO,EACP,aAAa,EACb,UAAU,EACV,eAAe,EACf,WAAW,EACX,MAAM,EACN,QAAQ,EACR,EAAE,EACF,UAAU,EACV,UAAU,EACV,MAAM,EACN,KAAK,EACN,uBAAwB;AAGzB,KAAK,YAAY,CAAC,CAAC,SAAS,MAAM,IAAK,EAAE,CACvC,UAAU,CAAC,CAAC,EAAE,GAAG,CAAC,EAClB,EAAE,CACA,QAAQ,CAAC,CAAC,EAAE,IAAI,CAAC,EAAE,yCAAyC;AAC5D,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,EAAE,GAAG,IAAI,GAAG,KAAK,EAAE,CAAC,EAAE,cAAc,CAAC,0BAA0B,EAAE,wDAAwD,CAAC,EAAE,CAAC,CAAC,EACnJ,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,EAAE,GAAG,IAAI,GAAG,KAAK,EAAE,CAAC,EAAE,cAAc,CAAC,0BAA0B,EAAE,wDAAwD,CAAC,EAAE,CAAC,CAAC,CACpJ,EACD,EAAE,CACA,UAAU,CAAC,CAAC,EAAC,IAAI,CAAC,EAClB,EAAE,CACA,QAAQ,CAAC,CAAC,EAAE,IAAI,CAAC,EAAE,yCAAyC;AAC5D,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,EAAE,GAAG,IAAI,GAAG,KAAK,EAAE,CAAC,EAAE,cAAc,CAAC,0BAA0B,EAAE,wDAAwD,CAAC,EAAE,CAAC,CAAC,EACnJ,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,EAAE,GAAG,IAAI,GAAG,KAAK,EAAE,CAAC,EAAE,cAAc,CAAC,0BAA0B,EAAE,wDAAwD,CAAC,EAAE,CAAC,CAAC,CACpJ,EACD,EAAE,CACA,EAAE,CAAC,CAAE,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAE,CAAC,EACtD,CAAC,EACD,EAAE,CACA,GAAG,CAAC,CAAE,aAAa,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,EAC7D,CAAC,EACD,cAAc,CAAC,0BAA0B,CAAC,CAC3C,CACF,CACF,CACF,CAAC;AAGF,KAAK,WAAW,CAAC,CAAC,SAAS,MAAM,IAAI,UAAU,CAAC,CAAC,EAAE,WAAW,GAAG,GAAG,GAAG,GAAG,CAAC,SAAS,EAAE,GACpF,CAAC,GACD,cAAc,CACZ,0BAA0B,EAC1B,6IAA6I,CAC9I,CAAC;AAEJ;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,MAAM,cAAc,CACxB,CAAC,SAAS,MAAM,GAAG,KAAK,GAAG,KAAK,IAC9B,CAAC,SAAS,KAAK,GACjB,GAAG,QAAQ,CAAC,GAAG,CAAC,GAAG,MAAM,GAAG,WAAW,GAAG,WAAW,EAAE,GACvD,CAAC,SAAS,MAAM,GAChB,eAAe,CAAC,CAAC,CAAC,SAAS,IAAI,GAC7B,MAAM,CACJ;IACE,WAAW,CAAC,CAAC,CAAC;IACd,YAAY,CAAC,CAAC,CAAC;CAChB,EACD,CAAC,CACF,GACD,CAAC,GAAG,cAAc,CAAC,0BAA0B,CAAC,GAChD,KAAK,CAAC"}

package/dist/types/string-literals/character-sets/phone/RawPhoneNumber.js

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

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

@@ -0,0 +1,27 @@
+import { GetPhoneCountryCode, IsStringLiteral, Trim } from "../../../index";
+/**
+ * **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;
+//# sourceMappingURL=RemovePhoneCountryCode.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"RemovePhoneCountryCode.d.ts","sourceRoot":"","sources":["../../../../../src/types/string-literals/character-sets/phone/RemovePhoneCountryCode.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAE,eAAe,EAAE,IAAI,EAAE,uBAAuB;AAG5E;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,MAAM,MAAM,sBAAsB,CAChC,CAAC,IACC,CAAC,SAAS,MAAM,GAClB,eAAe,CAAC,CAAC,CAAC,SAAS,IAAI,GAC7B,mBAAmB,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS,EAAE,GACrC,CAAC,GACD,IAAI,CAAC,CAAC,CAAC,SAAS,IAAI,mBAAmB,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,MAAM,IAAI,EAAE,GAC9D,IAAI,GACJ,CAAC,GACP,MAAM,GACN,KAAK,CAAC"}

package/dist/types/string-literals/character-sets/phone/RemovePhoneCountryCode.js

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

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

@@ -0,0 +1,17 @@
+import type { PHONE_FORMAT } from "../../../../constants/index";
+import { ErrorCondition, GetPhoneCountryCode, GetPhoneNumberType, HasPhoneCountryCode, IsStringLiteral, PhoneNumber } from "../../../index";
+/**
+ * **PhoneFormat**
+ *
+ * A union type of _formats_ used for telephone numbers
+ */
+export type PhoneFormat = typeof PHONE_FORMAT[number];
+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 ? FormatLookup<TPhone>[TFormat] : PhoneNumber<TPhone> : FormatLookup<TPhone>[TFormat] | ErrorCondition<"invalid-phone-number">;
+export {};
+//# sourceMappingURL=ToPhoneFormat.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"ToPhoneFormat.d.ts","sourceRoot":"","sources":["../../../../../src/types/string-literals/character-sets/phone/ToPhoneFormat.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,YAAY,EACb,oCAA2B;AAE5B,OAAO,EACL,cAAc,EACd,mBAAmB,EACnB,kBAAkB,EAClB,mBAAmB,EACnB,eAAe,EACf,WAAW,EACZ,uBAAwB;AAEzB;;;;GAIG;AACH,MAAM,MAAM,WAAW,GAAG,OAAO,YAAY,CAAC,MAAM,CAAC,CAAC;AAEtD,KAAK,YAAY,CAAC,CAAC,SAAS,MAAM,IAAI;IACpC,6BAA6B,EAAE,mBAAmB,CAAC,CAAC,CAAC,SAAS,IAAI,GAC9D,IAAI,mBAAmB,CAAC,CAAC,CAAC,IAAI,MAAM,IAAI,MAAM,IAAI,MAAM,EAAE,GAC1D,kBAAkB,CAAC,CAAC,CAAC,SAAS,UAAU,GACtC,GAAG,MAAM,IAAI,MAAM,EAAE,GACrB,GAAG,MAAM,IAAI,MAAM,IAAI,MAAM,EAAE,CAAC;IACtC,6BAA6B,EAAE,mBAAmB,CAAC,CAAC,CAAC,SAAS,IAAI,GAChE,IAAI,mBAAmB,CAAC,CAAC,CAAC,IAAI,MAAM,IAAI,MAAM,IAAI,MAAM,EAAE,GAC1D,kBAAkB,CAAC,CAAC,CAAC,SAAS,UAAU,GACtC,GAAG,MAAM,IAAI,MAAM,EAAE,GACrB,GAAG,MAAM,IAAI,MAAM,IAAI,MAAM,EAAE,CAAC;IACpC,mCAAmC,EAAE,EAAE,CAAC;IACxC,mCAAmC,EAAE,EAAE,CAAC;CACzC,GAAG,MAAM,CAAC,WAAW,EAAE,GAAG,CAAC,CAAC;AAE7B,MAAM,MAAM,aAAa,CACvB,MAAM,SAAS,MAAM,EACrB,OAAO,SAAS,WAAW,IACzB,eAAe,CAAC,MAAM,CAAC,SAAS,IAAI,GACtC,WAAW,CAAC,MAAM,CAAC,SAAS,MAAM,GAC9B,YAAY,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,GAC7B,WAAW,CAAC,MAAM,CAAC,GACvB,YAAY,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,GAAG,cAAc,CAAC,sBAAsB,CAAC,CAAC"}

package/dist/types/string-literals/character-sets/phone/ToPhoneFormat.js

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

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

@@ -0,0 +1,15 @@
+export * from "./PhoneShortCode";
+export * from "./PhoneNumber";
+export * from "./RawPhoneNumber";
+export * from "./CountryPhoneNumber";
+export * from "./GetPhoneCountryCode";
+export * from "./GetPhoneNumberType";
+export * from "./RemovePhoneCountryCode";
+export * from "./InternationalPhoneNumber";
+export * from "./ToPhoneFormat";
+export * from "./PhoneAreaCode";
+export * from "./LocalPhoneNumber";
+export * from "./PhoneCountryCode";
+export * from "./PhoneNumberDelimiter";
+export * from "./DialCountryCode";
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../src/types/string-literals/character-sets/phone/index.ts"],"names":[],"mappings":"AAAA,cAAc,kBAAkB,CAAC;AACjC,cAAc,eAAe,CAAC;AAC9B,cAAc,kBAAkB,CAAC;AACjC,cAAc,sBAAsB,CAAC;AACrC,cAAc,uBAAuB,CAAC;AACtC,cAAc,sBAAsB,CAAC;AACrC,cAAc,0BAA0B,CAAC;AACzC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,iBAAiB,CAAC;AAChC,cAAc,iBAAiB,CAAC;AAChC,cAAc,oBAAoB,CAAC;AACnC,cAAc,oBAAoB,CAAC;AACnC,cAAc,wBAAwB,CAAC;AACvC,cAAc,mBAAmB,CAAC"}

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

@@ -0,0 +1,14 @@
+export * from "./PhoneShortCode.js";
+export * from "./PhoneNumber.js";
+export * from "./RawPhoneNumber.js";
+export * from "./CountryPhoneNumber.js";
+export * from "./GetPhoneCountryCode.js";
+export * from "./GetPhoneNumberType.js";
+export * from "./RemovePhoneCountryCode.js";
+export * from "./InternationalPhoneNumber.js";
+export * from "./ToPhoneFormat.js";
+export * from "./PhoneAreaCode.js";
+export * from "./LocalPhoneNumber.js";
+export * from "./PhoneCountryCode.js";
+export * from "./PhoneNumberDelimiter.js";
+export * from "./DialCountryCode.js";