inferred-types 0.44.0 → 0.45.2

package/dist/runtime/type-conversion/asChars.d.ts

@@ -0,0 +1,8 @@
+import { Chars } from "../../types/index";
+/**
+ * **asChars**`(str)`
+ *
+ * Converts a string into an array of characters.
+ */
+export declare const asChars: <T extends string>(str: T) => Chars<T>;
+//# sourceMappingURL=asChars.d.ts.map

package/dist/runtime/type-conversion/asChars.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"asChars.d.ts","sourceRoot":"","sources":["../../../src/runtime/type-conversion/asChars.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,0BAAwB;AAExC;;;;GAIG;AACH,eAAO,MAAM,OAAO,0BAA2B,CAAC,KAAG,MAAM,CAAC,CAEzD,CAAA"}

package/dist/runtime/type-conversion/asChars.js

@@ -0,0 +1,8 @@
+/**
+ * **asChars**`(str)`
+ *
+ * Converts a string into an array of characters.
+ */
+export const asChars = (str) => {
+    return str.split("");
+};

package/dist/runtime/type-conversion/index.d.ts

@@ -9,4 +9,6 @@ export * from "./union";
 export * from "./toNumber";
 export * from "./asRecord";
 export * from "./asString";
+export * from "./asChars";
+export * from "./ip6GroupExpansion";
 //# sourceMappingURL=index.d.ts.map

package/dist/runtime/type-conversion/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/runtime/type-conversion/index.ts"],"names":[],"mappings":"AACA,cAAc,gBAAgB,CAAC;AAC/B,cAAc,YAAY,CAAC;AAC3B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,eAAe,CAAC;AAC9B,cAAc,YAAY,CAAC;AAC3B,cAAc,aAAa,CAAC;AAC5B,cAAc,SAAS,CAAC;AACxB,cAAc,SAAS,CAAC;AACxB,cAAc,YAAY,CAAC;AAC3B,cAAc,YAAY,CAAC;AAC3B,cAAc,YAAY,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/runtime/type-conversion/index.ts"],"names":[],"mappings":"AACA,cAAc,gBAAgB,CAAC;AAC/B,cAAc,YAAY,CAAC;AAC3B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,eAAe,CAAC;AAC9B,cAAc,YAAY,CAAC;AAC3B,cAAc,aAAa,CAAC;AAC5B,cAAc,SAAS,CAAC;AACxB,cAAc,SAAS,CAAC;AACxB,cAAc,YAAY,CAAC;AAC3B,cAAc,YAAY,CAAC;AAC3B,cAAc,YAAY,CAAC;AAC3B,cAAc,WAAW,CAAC;AAC1B,cAAc,qBAAqB,CAAC"}

package/dist/runtime/type-conversion/index.js

@@ -9,3 +9,5 @@ export * from "./union.js";
 export * from "./toNumber.js";
 export * from "./asRecord.js";
 export * from "./asString.js";
+export * from "./asChars.js";
+export * from "./ip6GroupExpansion.js";

package/dist/runtime/type-conversion/ip6GroupExpansion.d.ts

@@ -0,0 +1,14 @@
+import { Ip6GroupExpansion } from "../../types/index";
+/**
+ * **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 declare const ip6GroupExpansion: <T extends string>(ip: T) => Ip6GroupExpansion<T>;
+//# sourceMappingURL=ip6GroupExpansion.d.ts.map

package/dist/runtime/type-conversion/ip6GroupExpansion.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ip6GroupExpansion.d.ts","sourceRoot":"","sources":["../../../src/runtime/type-conversion/ip6GroupExpansion.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,0BAAuB;AAGnD;;;;;;;;;;GAUG;AACH,eAAO,MAAM,iBAAiB,yBAA0B,CAAC,yBAExD,CAAA"}

package/dist/runtime/type-conversion/ip6GroupExpansion.js

@@ -0,0 +1,15 @@
+import { stripTrailing } from "../literals/stripTrailing.js";
+/**
+ * **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 = (ip) => {
+    return stripTrailing(ip.replaceAll("::", ":0000:"), ":");
+};

package/dist/runtime/type-guards/api-tg.d.ts

@@ -0,0 +1,33 @@
+import { Dictionary, Narrowable, OptionalParamFn, TypedFunction } from "../../types/index";
+export declare const isEscapeFunction: <T>(val: T) => val is T & (() => unknown);
+/**
+ * **isOptionalParamFunction**`(val)`
+ *
+ * A type guard which ensures that the value passed in is not only a _function_
+ * but also has the `optionalParam` value set to **true** indicating that it
+ * is safe to be called _without_ parameters.
+ *
+ * **Note:** this is similar to an "escape function" but whereas an API can
+ * only have one escape function, an API may have as many ze
+ */
+export declare const isOptionalParamFunction: <T>(val: T) => val is T & OptionalParamFn;
+/**
+ * **isApi**`(val)`
+ *
+ * Type guard which validates that the value passed in is an `Api` type
+ * with "surface" and "_kind" property.
+ *
+ * **Related:** `isFluentApi()`
+ */
+export declare const isApi: <T extends Narrowable>(api: T) => api is T & {
+    __kind: "api";
+    surface: Dictionary | TypedFunction;
+};
+/**
+ * **isApiSurface**`(val)`
+ *
+ * A type guard which tests whether the value passed in is the SurfaceArea
+ * of an API (or could be).
+ */
+export declare const isApiSurface: <T>(val: T) => val is T & (Dictionary | TypedFunction);
+//# sourceMappingURL=api-tg.d.ts.map

package/dist/runtime/type-guards/api-tg.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"api-tg.d.ts","sourceRoot":"","sources":["../../../src/runtime/type-guards/api-tg.ts"],"names":[],"mappings":"AAAA,OAAO,EAAG,UAAU,EAAG,UAAU,EAAE,eAAe,EAAE,aAAa,EAAE,0BAAwB;AAK3F,eAAO,MAAM,gBAAgB,WAAY,CAAC,uBAAqB,OAAO,CAErE,CAAA;AAGD;;;;;;;;;GASG;AACH,eAAO,MAAM,uBAAuB,WAAY,CAAC,+BAEhD,CAAA;AAED;;;;;;;GAOG;AACH,eAAO,MAAM,KAAK,8BAA+B,CAAC;YAAwB,KAAK;aAAW,UAAU,GAAG,aAAa;CAEnH,CAAA;AAED;;;;;GAKG;AACH,eAAO,MAAM,YAAY,WAAY,CAAC,4CAErC,CAAA"}

package/dist/runtime/type-guards/api-tg.js

@@ -0,0 +1,38 @@
+import { isFunction } from "./isFunction.js";
+import { isObject } from "./isObject.js";
+export const isEscapeFunction = (val) => {
+    return isFunction(val) && "escape" in val && val.escape === true;
+};
+/**
+ * **isOptionalParamFunction**`(val)`
+ *
+ * A type guard which ensures that the value passed in is not only a _function_
+ * but also has the `optionalParam` value set to **true** indicating that it
+ * is safe to be called _without_ parameters.
+ *
+ * **Note:** this is similar to an "escape function" but whereas an API can
+ * only have one escape function, an API may have as many ze
+ */
+export const isOptionalParamFunction = (val) => {
+    return isFunction(val) && "optionalParams" in val && val.optionalParams === true;
+};
+/**
+ * **isApi**`(val)`
+ *
+ * Type guard which validates that the value passed in is an `Api` type
+ * with "surface" and "_kind" property.
+ *
+ * **Related:** `isFluentApi()`
+ */
+export const isApi = (api) => {
+    return isObject(api) && "surface" in api && "_kind" in api && api._kind === "api";
+};
+/**
+ * **isApiSurface**`(val)`
+ *
+ * A type guard which tests whether the value passed in is the SurfaceArea
+ * of an API (or could be).
+ */
+export const isApiSurface = (val) => {
+    return isObject(val) && Object.keys(val).some(k => isEscapeFunction(val[k]));
+};

package/dist/runtime/type-guards/hasWhitespace.d.ts

@@ -0,0 +1,7 @@
+/**
+ * **hasWhiteSpace**`(val)`
+ *
+ * Type guard which checks whether a string has a any whitespace characters in it
+ */
+export declare const hasWhiteSpace: <T>(val: T) => val is T;
+//# sourceMappingURL=hasWhitespace.d.ts.map

package/dist/runtime/type-guards/hasWhitespace.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"hasWhitespace.d.ts","sourceRoot":"","sources":["../../../src/runtime/type-guards/hasWhitespace.ts"],"names":[],"mappings":"AAIA;;;;GAIG;AACH,eAAO,MAAM,aAAa,WAAY,CAAC,aAEtC,CAAA"}

package/dist/runtime/type-guards/hasWhitespace.js

@@ -0,0 +1,11 @@
+import { WHITESPACE_CHARS } from "../../constants/Characters.js";
+import { asChars } from "../type-conversion/index.js";
+import { isString } from "./isString.js";
+/**
+ * **hasWhiteSpace**`(val)`
+ *
+ * Type guard which checks whether a string has a any whitespace characters in it
+ */
+export const hasWhiteSpace = (val) => {
+    return isString(val) && asChars(val).some(c => WHITESPACE_CHARS.includes(c));
+};

package/dist/runtime/type-guards/index.d.ts

@@ -35,5 +35,16 @@ export * from "./isDoneFn";
 export * from "./isUrl";
 export * from "./isCssAspectRatio";
 export * from "./isInlineSvg";
+export * from "./youtube";
+export * from "./repos";
+export * from "./network-tg";
+export * from "./isHexadecimal";
+export * from "./isTrimmable";
+export * from "./hasWhitespace";
+export * from "./isEmail";
+export * from "./isPhoneNumber";
+export * from "./isUnset";
+export * from "./api-tg";
+export * from "./isFunction";
 export * from "./higher-order/index";
 //# sourceMappingURL=index.d.ts.map

package/dist/runtime/type-guards/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/runtime/type-guards/index.ts"],"names":[],"mappings":"AAAA,cAAc,aAAa,CAAC;AAC5B,cAAc,WAAW,CAAC;AAC1B,cAAc,UAAU,CAAC;AACzB,cAAc,aAAa,CAAC;AAC5B,cAAc,YAAY,CAAC;AAC3B,cAAc,eAAe,CAAC;AAC9B,cAAc,eAAe,CAAC;AAC9B,cAAc,aAAa,CAAC;AAC5B,cAAc,YAAY,CAAC;AAC3B,cAAc,eAAe,CAAC;AAC9B,cAAc,YAAY,CAAC;AAC3B,cAAc,UAAU,CAAC;AACzB,cAAc,YAAY,CAAA;AAC1B,cAAc,WAAW,CAAC;AAC1B,cAAc,cAAc,CAAC;AAC7B,cAAc,WAAW,CAAC;AAC1B,cAAc,eAAe,CAAC;AAC9B,cAAc,sBAAsB,CAAC;AACrC,cAAc,mBAAmB,CAAC;AAClC,cAAc,cAAc,CAAC;AAC7B,cAAc,SAAS,CAAC;AACxB,cAAc,WAAW,CAAC;AAC1B,cAAc,mBAAmB,CAAC;AAClC,cAAc,mBAAmB,CAAC;AAClC,cAAc,kBAAkB,CAAC;AACjC,cAAc,cAAc,CAAC;AAC7B,cAAc,YAAY,CAAC;AAC3B,cAAc,aAAa,CAAC;AAC5B,cAAc,YAAY,CAAC;AAC3B,cAAc,eAAe,CAAC;AAC9B,cAAc,oBAAoB,CAAC;AACnC,cAAc,YAAY,CAAC;AAC3B,cAAc,WAAW,CAAC;AAC1B,cAAc,YAAY,CAAC;AAC3B,cAAc,SAAS,CAAC;AACxB,cAAc,oBAAoB,CAAC;AACnC,cAAc,eAAe,CAAC;AAE9B,cAAc,sBAAsB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/runtime/type-guards/index.ts"],"names":[],"mappings":"AAAA,cAAc,aAAa,CAAC;AAC5B,cAAc,WAAW,CAAC;AAC1B,cAAc,UAAU,CAAC;AACzB,cAAc,aAAa,CAAC;AAC5B,cAAc,YAAY,CAAC;AAC3B,cAAc,eAAe,CAAC;AAC9B,cAAc,eAAe,CAAC;AAC9B,cAAc,aAAa,CAAC;AAC5B,cAAc,YAAY,CAAC;AAC3B,cAAc,eAAe,CAAC;AAC9B,cAAc,YAAY,CAAC;AAC3B,cAAc,UAAU,CAAC;AACzB,cAAc,YAAY,CAAA;AAC1B,cAAc,WAAW,CAAC;AAC1B,cAAc,cAAc,CAAC;AAC7B,cAAc,WAAW,CAAC;AAC1B,cAAc,eAAe,CAAC;AAC9B,cAAc,sBAAsB,CAAC;AACrC,cAAc,mBAAmB,CAAC;AAClC,cAAc,cAAc,CAAC;AAC7B,cAAc,SAAS,CAAC;AACxB,cAAc,WAAW,CAAC;AAC1B,cAAc,mBAAmB,CAAC;AAClC,cAAc,mBAAmB,CAAC;AAClC,cAAc,kBAAkB,CAAC;AACjC,cAAc,cAAc,CAAC;AAC7B,cAAc,YAAY,CAAC;AAC3B,cAAc,aAAa,CAAC;AAC5B,cAAc,YAAY,CAAC;AAC3B,cAAc,eAAe,CAAC;AAC9B,cAAc,oBAAoB,CAAC;AACnC,cAAc,YAAY,CAAC;AAC3B,cAAc,WAAW,CAAC;AAC1B,cAAc,YAAY,CAAC;AAC3B,cAAc,SAAS,CAAC;AACxB,cAAc,oBAAoB,CAAC;AACnC,cAAc,eAAe,CAAC;AAC9B,cAAc,WAAW,CAAC;AAC1B,cAAc,SAAS,CAAC;AACxB,cAAc,cAAc,CAAC;AAC7B,cAAc,iBAAiB,CAAC;AAChC,cAAc,eAAe,CAAC;AAC9B,cAAc,iBAAiB,CAAC;AAChC,cAAc,WAAW,CAAC;AAC1B,cAAc,iBAAiB,CAAC;AAChC,cAAc,WAAW,CAAC;AAC1B,cAAc,UAAU,CAAC;AACzB,cAAc,cAAc,CAAC;AAE7B,cAAc,sBAAsB,CAAC"}

package/dist/runtime/type-guards/index.js

@@ -35,4 +35,15 @@ export * from "./isDoneFn.js";
 export * from "./isUrl.js";
 export * from "./isCssAspectRatio.js";
 export * from "./isInlineSvg.js";
+export * from "./youtube.js";
+export * from "./repos.js";
+export * from "./network-tg.js";
+export * from "./isHexadecimal.js";
+export * from "./isTrimmable.js";
+export * from "./hasWhitespace.js";
+export * from "./isEmail.js";
+export * from "./isPhoneNumber.js";
+export * from "./isUnset.js";
+export * from "./api-tg.js";
+export * from "./isFunction.js";
 export * from "./higher-order/index.js";

package/dist/runtime/type-guards/isConstant.d.ts

@@ -1,3 +1,9 @@
 import { Constant } from "../../constants/index";
+/**
+ * **isConstant**`(val)`
+ *
+ * Type guard which checks to see if it is of type
+ * `Constant<T>`.
+ */
 export declare function isConstant<K extends string>(value: unknown): value is Constant<K>;
 //# sourceMappingURL=isConstant.d.ts.map

package/dist/runtime/type-guards/isConstant.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"isConstant.d.ts","sourceRoot":"","sources":["../../../src/runtime/type-guards/isConstant.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,QAAQ,EAAE,8BAA4B;AAG/C,wBAAgB,UAAU,CACxB,CAAC,SAAS,MAAM,EAChB,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,QAAQ,CAAC,CAAC,CAAC,CAEtC"}
+{"version":3,"file":"isConstant.d.ts","sourceRoot":"","sources":["../../../src/runtime/type-guards/isConstant.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,QAAQ,EAAG,8BAA4B;AAGhD;;;;;GAKG;AACH,wBAAgB,UAAU,CACxB,CAAC,SAAS,MAAM,EAChB,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,QAAQ,CAAC,CAAC,CAAC,CAMtC"}

package/dist/runtime/type-guards/isConstant.js

@@ -1,4 +1,14 @@
-import { isObject, isEqual, isTypeOf } from "../index.js";
+import { isObject } from "../index.js";
+/**
+ * **isConstant**`(val)`
+ *
+ * Type guard which checks to see if it is of type
+ * `Constant<T>`.
+ */
 export function isConstant(value) {
-    return isObject(value) && "_type" in value && isTypeOf("string")(value._type) && isEqual(value._type)("Constant") ? true : false;
+    return isObject(value) &&
+        "_type" in value &&
+        "kind" in value &&
+        value._type === "Constant"
+        ? true : false;
 }

package/dist/runtime/type-guards/isEmail.d.ts

@@ -0,0 +1,7 @@
+/**
+ * **isEmail**`(val)`
+ *
+ * Tests to see if a string is shaped as an email address.
+ */
+export declare const isEmail: <T>(val: T) => val is T & `${string}@${string}.${string}`;
+//# sourceMappingURL=isEmail.d.ts.map

package/dist/runtime/type-guards/isEmail.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"isEmail.d.ts","sourceRoot":"","sources":["../../../src/runtime/type-guards/isEmail.ts"],"names":[],"mappings":"AAGA;;;;GAIG;AACH,eAAO,MAAM,OAAO,WAAY,CAAC,+CAMhC,CAAA"}

package/dist/runtime/type-guards/isEmail.js

@@ -0,0 +1,11 @@
+import { asChars, isString, last } from "../index.js";
+/**
+ * **isEmail**`(val)`
+ *
+ * Tests to see if a string is shaped as an email address.
+ */
+export const isEmail = (val) => {
+    return isString(val) && (val.split("@").length === 2 &&
+        val.split("@")[1].split(".").length > 1 &&
+        asChars(last(val.split("@")[1].split("."))).length > 1);
+};

package/dist/runtime/type-guards/isHexadecimal.d.ts

@@ -0,0 +1,8 @@
+/**
+ * **isHexadecimal**`(val)`
+ *
+ * Type guard which checks whether all of the characters in the given string
+ * are hexadecimal characters.
+ */
+export declare const isHexadecimal: <T>(val: T) => val is T;
+//# sourceMappingURL=isHexadecimal.d.ts.map

package/dist/runtime/type-guards/isHexadecimal.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"isHexadecimal.d.ts","sourceRoot":"","sources":["../../../src/runtime/type-guards/isHexadecimal.ts"],"names":[],"mappings":"AAKA;;;;;GAKG;AACH,eAAO,MAAM,aAAa,WAAY,CAAC,aAGtC,CAAA"}

package/dist/runtime/type-guards/isHexadecimal.js

@@ -0,0 +1,13 @@
+import { asChars } from "../type-conversion/asChars.js";
+import { isNumericString } from "./isNumericString.js";
+import { isString } from "./isString.js";
+/**
+ * **isHexadecimal**`(val)`
+ *
+ * Type guard which checks whether all of the characters in the given string
+ * are hexadecimal characters.
+ */
+export const isHexadecimal = (val) => {
+    return isString(val) &&
+        asChars(val).every(i => isNumericString(i) || ["a", "b", "c", "d", "e", "f"].includes(i.toLowerCase()));
+};

package/dist/runtime/type-guards/isPhoneNumber.d.ts

@@ -0,0 +1,14 @@
+/**
+ * **isPhoneNumber**`(val)`
+ *
+ * Type guard which validates that a string is in the shape of a phone
+ * number.
+ *
+ * - Only valid characters (numeric, whitespace, `+`, `-`, `.`, and parenthesis)
+ * - at least 7 numeric characters, 8 if `+` character used
+ * - leading character (after whitespace) must be numeric, `(` or `+`
+ *
+ * **Related:** `asPhoneNumber()`, `PhoneNumber`
+ */
+export declare const isPhoneNumber: <T>(val: T) => val is T;
+//# sourceMappingURL=isPhoneNumber.d.ts.map

package/dist/runtime/type-guards/isPhoneNumber.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"isPhoneNumber.d.ts","sourceRoot":"","sources":["../../../src/runtime/type-guards/isPhoneNumber.ts"],"names":[],"mappings":"AAKA;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,aAAa,WAAY,CAAC,aAoBtC,CAAA"}

package/dist/runtime/type-guards/isPhoneNumber.js

@@ -0,0 +1,26 @@
+import { WHITESPACE_CHARS } from "../../constants/Characters.js";
+import { NUMERIC_CHAR } from "../../constants/NumericChar.js";
+import { isString, asChars, retainChars, stripChars } from "../index.js";
+/**
+ * **isPhoneNumber**`(val)`
+ *
+ * Type guard which validates that a string is in the shape of a phone
+ * number.
+ *
+ * - Only valid characters (numeric, whitespace, `+`, `-`, `.`, and parenthesis)
+ * - at least 7 numeric characters, 8 if `+` character used
+ * - leading character (after whitespace) must be numeric, `(` or `+`
+ *
+ * **Related:** `asPhoneNumber()`, `PhoneNumber`
+ */
+export const isPhoneNumber = (val) => {
+    return (isString(val) &&
+        ["+", "(", ...NUMERIC_CHAR].includes(asChars(val.trim())[0]) &&
+        [...NUMERIC_CHAR].includes([...asChars(val.trim())].pop()) &&
+        (val.trim().startsWith(`+`)
+            ? asChars(retainChars(val, ...NUMERIC_CHAR)).length >= 8
+            : val.trim().startsWith("00")
+                ? asChars(retainChars(val, ...NUMERIC_CHAR)).length >= 10
+                : asChars(retainChars(val, ...NUMERIC_CHAR)).length >= 7) &&
+        stripChars(val, ...NUMERIC_CHAR, ...WHITESPACE_CHARS, "(", ")", "+", ".", "-") === "");
+};

package/dist/runtime/type-guards/isSpecificConstant.js

@@ -1,5 +1,4 @@
-import { isConstant } from "./isConstant.js";
-import { isEqual } from "./higher-order/isEqual.js";
+import { isConstant } from "../index.js";
 /**
  * **isSpecificConstant**(kind)
  *
@@ -7,6 +6,6 @@ import { isEqual } from "./higher-order/isEqual.js";
  */
 export function isSpecificConstant(kind) {
     return (value) => {
-        return isConstant(value) && isEqual(value.kind)(kind) ? true : false;
+        return isConstant(value) && value.kind === kind ? true : false;
     };
 }

package/dist/runtime/type-guards/isTrimmable.d.ts

@@ -0,0 +1,7 @@
+/**
+ * **isTrimable**`(val)`
+ *
+ * tests whether a string has whitespace on either left or right edges.
+ */
+export declare const isTrimable: <T>(val: T) => val is T;
+//# sourceMappingURL=isTrimmable.d.ts.map

package/dist/runtime/type-guards/isTrimmable.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"isTrimmable.d.ts","sourceRoot":"","sources":["../../../src/runtime/type-guards/isTrimmable.ts"],"names":[],"mappings":"AAEA;;;;GAIG;AACH,eAAO,MAAM,UAAU,WAAY,CAAC,aAEnC,CAAA"}

package/dist/runtime/type-guards/isTrimmable.js

@@ -0,0 +1,9 @@
+import { isString } from "./isString.js";
+/**
+ * **isTrimable**`(val)`
+ *
+ * tests whether a string has whitespace on either left or right edges.
+ */
+export const isTrimable = (val) => {
+    return isString(val) && val !== val.trim();
+};

package/dist/runtime/type-guards/isUnset.d.ts

@@ -0,0 +1,18 @@
+import { Unset } from "../../types/index";
+/**
+ * **isUnset**`(val)`
+ *
+ * Type guard which validates that the value passed in `Unset`.
+ *
+ * **Related:** `isSet()`
+ */
+export declare const isUnset: (val: unknown) => val is Unset;
+/**
+ * **isSet**`(val)`
+ *
+ * Type guard which validates that the value passed in is **not** `Unset`.
+ *
+ * **Related:** `isUnset()`
+ */
+export declare const isSet: <T>(val: T) => val is Exclude<T, Unset>;
+//# sourceMappingURL=isUnset.d.ts.map

package/dist/runtime/type-guards/isUnset.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"isUnset.d.ts","sourceRoot":"","sources":["../../../src/runtime/type-guards/isUnset.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,0BAAwB;AAGxC;;;;;;GAMG;AACH,eAAO,MAAM,OAAO,QAAS,OAAO,iBAEnC,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,KAAK,WAAY,CAAC,6BAI9B,CAAA"}

package/dist/runtime/type-guards/isUnset.js

@@ -0,0 +1,23 @@
+import { isObject } from "./isObject.js";
+/**
+ * **isUnset**`(val)`
+ *
+ * Type guard which validates that the value passed in `Unset`.
+ *
+ * **Related:** `isSet()`
+ */
+export const isUnset = (val) => {
+    return isObject(val) && val.kind === "Unset";
+};
+/**
+ * **isSet**`(val)`
+ *
+ * Type guard which validates that the value passed in is **not** `Unset`.
+ *
+ * **Related:** `isUnset()`
+ */
+export const isSet = (val) => {
+    return isObject(val)
+        ? val.kind !== "Unset" ? true : false
+        : true;
+};

package/dist/runtime/type-guards/isUrl.d.ts

@@ -1,6 +1,4 @@
-import { NetworkProtocol } from "../../types/string-literals";
-import { TupleToUnion } from "../../types/type-conversion";
-import { Keys } from "../../types/index";
+import { Keys, TupleToUnion, NetworkProtocol } from "../../types/index";
 /**
  * **isUri**`(val, ...protocols)`
  *
@@ -23,5 +21,5 @@ export declare const isUri: <T, P extends readonly NetworkProtocol[]>(val: T, ..
  *
  * **Related:** `isUri`
  */
-export declare const isUrl: <T, P extends readonly NetworkProtocol[]>(val: T, ...protocols: P) => val is T & `${Keys<P>["length"] extends 0 ? "http" | "https" : TupleToUnion<P>}://${string}`;
+export declare const isUrl: <T, P extends readonly NetworkProtocol[]>(val: T, ...protocols: P) => val is T & `${Keys<P>["length"] extends 0 ? "https" | "http" : TupleToUnion<P>}://${string}`;
 //# sourceMappingURL=isUrl.d.ts.map

package/dist/runtime/type-guards/isUrl.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"isUrl.d.ts","sourceRoot":"","sources":["../../../src/runtime/type-guards/isUrl.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAO,oCAAkC;AAIjE,OAAO,EAAE,YAAY,EAAE,oCAAkC;AACzD,OAAO,EAAE,IAAI,EAAE,0BAAwB;AAEvC;;;;;;;;;;GAUG;AACH,eAAO,MAAM,KAAK,iDAGX,CAAC,gBAAgB,CAAC,gGAUxB,CAAA;AAGD;;;;;;;;;GASG;AACH,eAAO,MAAM,KAAK,iDAGX,CAAC,gBAAgB,CAAC,iGAUxB,CAAA"}
+{"version":3,"file":"isUrl.d.ts","sourceRoot":"","sources":["../../../src/runtime/type-guards/isUrl.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,IAAI,EAAC,YAAY,EAAG,eAAe,EAAQ,0BAAwB;AAE5E;;;;;;;;;;GAUG;AACH,eAAO,MAAM,KAAK,iDAGX,CAAC,gBAAgB,CAAC,gGAUxB,CAAA;AAGD;;;;;;;;;GASG;AACH,eAAO,MAAM,KAAK,iDAGX,CAAC,gBAAgB,CAAC,iGAUxB,CAAA"}

package/dist/runtime/type-guards/isUrl.js

@@ -1,6 +1,5 @@
-import { isString } from "./isString.js";
-import { NETWORK_PROTOCOL_LOOKUP } from "../../constants/Network.js";
-import { valuesOf } from "../dictionary/valuesOf.js";
+import { isString, valuesOf } from "../index.js";
+import { NETWORK_PROTOCOL_LOOKUP } from "../../constants/index.js";
 /**
  * **isUri**`(val, ...protocols)`
  *

package/dist/runtime/type-guards/network-tg.d.ts

@@ -0,0 +1,54 @@
+import { DomainName, GetUrlProtocolPrefix, GetUrlSource } from "../../types/index";
+import { AsString } from "../../types/type-conversion/AsString";
+/**
+ * **isIp4Address**`(val)`
+ *
+ * Type guard which checks whether the value is a valid IPv4 address.
+ */
+export declare const isIp4Address: <T>(val: T) => val is T & `${number}.${number}.${number}.${number}`;
+/**
+ * **isIp6Address**`(val)`
+ *
+ * Type guard which checks whether the value is a valid IPv6 address.
+ */
+export declare const isIp6Address: <T>(val: T) => val is T & (`0${string}:${string}` | `1${string}:${string}` | `2${string}:${string}` | `3${string}:${string}` | `4${string}:${string}` | `5${string}:${string}` | `6${string}:${string}` | `7${string}:${string}` | `8${string}:${string}` | `9${string}:${string}` | `A${string}:${string}` | `B${string}:${string}` | `C${string}:${string}` | `D${string}:${string}` | `E${string}:${string}` | `F${string}:${string}` | `a${string}:${string}` | `b${string}:${string}` | `c${string}:${string}` | `d${string}:${string}` | `e${string}:${string}` | `f${string}:${string}`);
+/**
+ * **isIpAddress**`(val)`
+ *
+ * Type guard which checks whether the value is a valid IP address (v4 or v6).
+ */
+export declare const isIpAddress: <T>(val: T) => val is T & (`${number}.${number}.${number}.${number}` | `0${string}:${string}` | `1${string}:${string}` | `2${string}:${string}` | `3${string}:${string}` | `4${string}:${string}` | `5${string}:${string}` | `6${string}:${string}` | `7${string}:${string}` | `8${string}:${string}` | `9${string}:${string}` | `A${string}:${string}` | `B${string}:${string}` | `C${string}:${string}` | `D${string}:${string}` | `E${string}:${string}` | `F${string}:${string}` | `a${string}:${string}` | `b${string}:${string}` | `c${string}:${string}` | `d${string}:${string}` | `e${string}:${string}` | `f${string}:${string}`);
+/**
+ * **hasUrlPort**`(val)`
+ *
+ * Type guard which tests whether there is an explicit _port_ reference
+ * in the passed in URL (versus implicitly using the default port of the
+ * protocol)
+ */
+export declare const hasUrlPort: <T>(val: T) => val is T & `${GetUrlProtocolPrefix<T>}${GetUrlSource<AsString<T>>}:${number}${string}`;
+/**
+ * **isUrlPath**`(val)`
+ *
+ * Type guard which checks whether the value is a valid `UrlPath`
+ */
+export declare const isUrlPath: <T>(val: T) => val is T & ("" | `/.${string}` | `/-${string}` | `/_${string}` | `/0${string}` | `/1${string}` | `/2${string}` | `/3${string}` | `/4${string}` | `/5${string}` | `/6${string}` | `/7${string}` | `/8${string}` | `/9${string}` | `/A${string}` | `/B${string}` | `/C${string}` | `/D${string}` | `/E${string}` | `/F${string}` | `/G${string}` | `/H${string}` | `/I${string}` | `/J${string}` | `/K${string}` | `/L${string}` | `/M${string}` | `/N${string}` | `/O${string}` | `/P${string}` | `/Q${string}` | `/R${string}` | `/S${string}` | `/T${string}` | `/U${string}` | `/V${string}` | `/W${string}` | `/X${string}` | `/Y${string}` | `/Z${string}` | `/a${string}` | `/b${string}` | `/c${string}` | `/d${string}` | `/e${string}` | `/f${string}` | `/g${string}` | `/h${string}` | `/i${string}` | `/j${string}` | `/k${string}` | `/l${string}` | `/m${string}` | `/n${string}` | `/o${string}` | `/p${string}` | `/q${string}` | `/r${string}` | `/s${string}` | `/t${string}` | `/u${string}` | `/v${string}` | `/w${string}` | `/x${string}` | `/y${string}` | `/z${string}` | `/@${string}`);
+/**
+ * **isDomainName**`(val)`
+ *
+ * Type guard which checks whether the value is a valid DNS domain name
+ */
+export declare const isDomainName: <T>(val: T) => val is T & DomainName<AsString<T>>;
+/**
+ * **isUrlSource**`(val)`
+ *
+ * Type guard which checks whether the value is a valid URL source
+ * (aka, an IP address or a Domain Name)
+ */
+export declare const isUrlSource: <T>(val: T) => boolean;
+/**
+ * **hasUrlQueryParameter**`(val,prop)`
+ *
+ * Tests whether the valued in has a query parameter specified by `prop`.
+ */
+export declare const hasUrlQueryParameter: <T, P extends string>(val: T, prop: P) => boolean;
+//# sourceMappingURL=network-tg.d.ts.map

package/dist/runtime/type-guards/network-tg.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"network-tg.d.ts","sourceRoot":"","sources":["../../../src/runtime/type-guards/network-tg.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,oBAAoB,EAAE,YAAY,EAAwC,0BAAuB;AAKtH,OAAO,EAAE,QAAQ,EAAE,6CAA0C;AAQ7D;;;;GAIG;AACH,eAAO,MAAM,YAAY,WAAY,CAAC,yDAKrC,CAAA;AAED;;;;GAIG;AACH,eAAO,MAAM,YAAY,WAAY,CAAC,qjBAOrC,CAAA;AAED;;;;GAIG;AACH,eAAO,MAAM,WAAW,WAAY,CAAC,imBAEpC,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,UAAU,WAAY,CAAC,2FAEnC,CAAA;AAED;;;;GAIG;AACH,eAAO,MAAM,SAAS,WAAY,CAAC,ojCAalC,CAAA;AAED;;;;GAIG;AACH,eAAO,MAAM,YAAY,WAAY,CAAC,uCAQrC,CAAA;AAED;;;;;GAKG;AACH,eAAO,MAAM,WAAW,WAAY,CAAC,YAEpC,CAAA;AAGD;;;;GAIG;AACH,eAAO,MAAM,oBAAoB,6BAA6B,CAAC,QAAQ,CAAC,YAGvE,CAAA"}

package/dist/runtime/type-guards/network-tg.js

@@ -0,0 +1,94 @@
+import { asChars } from "../type-conversion/asChars.js";
+import { isAlpha } from "./isAlpha.js";
+import { isNumericString } from "./isNumericString.js";
+import { isString } from "./isString.js";
+import { ip6GroupExpansion } from "../type-conversion/index.js";
+import { isHexadecimal } from "./isHexadecimal.js";
+import { getUrlQueryParams, removeUrlProtocol } from "../meta/index.js";
+/**
+ * **isIp4Address**`(val)`
+ *
+ * Type guard which checks whether the value is a valid IPv4 address.
+ */
+export const isIp4Address = (val) => {
+    return isString(val) &&
+        (val.split(".").length === 4) &&
+        (val.split(".").every(i => isNumericString(i))) &&
+        val.split(".").every(i => Number(i) >= 0 && Number(i) <= 255);
+};
+/**
+ * **isIp6Address**`(val)`
+ *
+ * Type guard which checks whether the value is a valid IPv6 address.
+ */
+export const isIp6Address = (val) => {
+    const expanded = isString(val)
+        ? ip6GroupExpansion(val)
+        : "";
+    return isString(val) && isString(expanded) &&
+        (expanded.split(":").every(i => asChars(i).length >= 1 && asChars(i).length <= 4)) &&
+        expanded.split(":").every(i => isHexadecimal(i));
+};
+/**
+ * **isIpAddress**`(val)`
+ *
+ * Type guard which checks whether the value is a valid IP address (v4 or v6).
+ */
+export const isIpAddress = (val) => {
+    return isIp4Address(val) || isIp6Address(val);
+};
+/**
+ * **hasUrlPort**`(val)`
+ *
+ * Type guard which tests whether there is an explicit _port_ reference
+ * in the passed in URL (versus implicitly using the default port of the
+ * protocol)
+ */
+export const hasUrlPort = (val) => {
+    return isString(val) && asChars(removeUrlProtocol(val)).some(i => i === ":");
+};
+/**
+ * **isUrlPath**`(val)`
+ *
+ * Type guard which checks whether the value is a valid `UrlPath`
+ */
+export const isUrlPath = (val) => {
+    return isString(val) &&
+        (val === "" || val.startsWith("/")) &&
+        (asChars(val).every(c => isAlpha(c) ||
+            isNumericString(c) ||
+            c === "_" ||
+            c === "@" ||
+            c === "." ||
+            c === "-"));
+};
+/**
+ * **isDomainName**`(val)`
+ *
+ * Type guard which checks whether the value is a valid DNS domain name
+ */
+export const isDomainName = (val) => {
+    return isString(val) &&
+        val.split(".").filter(i => i).length > 1 &&
+        isString(val.split(".").filter(i => i).pop()) &&
+        asChars(val.split(".").filter(i => i).pop()).length > 1 &&
+        val.split(".").filter(i => i).every(i => isAlpha(i) || isNumericString(i) || i === "-" || i === "_");
+};
+/**
+ * **isUrlSource**`(val)`
+ *
+ * Type guard which checks whether the value is a valid URL source
+ * (aka, an IP address or a Domain Name)
+ */
+export const isUrlSource = (val) => {
+    return isDomainName(val) || isIpAddress(val);
+};
+/**
+ * **hasUrlQueryParameter**`(val,prop)`
+ *
+ * Tests whether the valued in has a query parameter specified by `prop`.
+ */
+export const hasUrlQueryParameter = (val, prop) => {
+    const re = new RegExp(`${prop}=`);
+    return isString(val) && re.test(getUrlQueryParams(val));
+};