@carlsebastian/jsu 1.1.1 → 1.2.1

package/src/types/dom/dom.d.ts

@@ -1,8 +1,122 @@
+import { DOMClassOfAPI } from "./attr/attr.class.js";
+import { DOMIdOfAPI } from "./attr/attr.id.js";
+import { DOMStyleOfAPI } from "./attr/attr.style.js";
+import { DOMCreateAPI } from "./element/create/element.create.js";
+import { ElementTags, ResolveTag } from "./element/element.js";
+import { DOMGetElementByAPI } from "./element/getElementBy/dom.getElementBy.js";
+import { VerifierTagAPI } from "./element/tag-verifier/verifier.js";
+
+export interface DomAPI {
+    /**
+     *  Access the element's `DOMTokenList` and returns set collection of for it.
+     *
+     *  @param element - The element to access the `DOMTokenList`.
+     */
+    ClassOf(element: Element): DOMClassOfAPI;
+
+    /**
+     *  A collection of customized and enhanced `create` of `DocumentObjectModel`.
+     */
+    Create: DOMCreateAPI;
+
+    /**
+     *  Access the element's `id` attribute and returns a set of for it.
+     *
+     *  @param element - The element to access the `id` attribute.
+     */
+    IdOf(element: Element): DOMIdOfAPI;
+
+    /**
+     *  A enhanced version collection of element retrieval methods.
+     */
+    GetElementBy: DOMGetElementByAPI;
+
+    /**
+     *  Mounts the given `childNode` to its given `parentNode`.
+     *
+     *  @param parentNode - The parent node to mount the given child node.
+     *  @param childNode - The given child node to mount.
+     */
+    Mount(parentNode: ParentNode, childNode: ChildNode): void;
+
+    /**
+     *  Mounts the given `childNode` collection to its given `parentNode`.
+     *
+     *  @param parentNode - The parent node to mount the given collection of child node.
+     *  @param childNodes - The given collection of child nodes to mount.
+     */
+    Mount(parentNode: ParentNode, ...childNodes: ChildNode[]): void;
+
+    /**
+     *  Search and retrieves the first element to match the given selector.
+     *
+     *  @param selector - The selector of element to search.
+     *  @returns The element that matches the given selector.
+     */
+    Select<T extends keyof ElementTags>(selector: T): ResolveTag<T>;
+
+    /**
+     *  Search and retrieves the first element to match the given selector.
+     *
+     *  @param selector - The selector of element to search.
+     *  @param root - The parent element to search the given element selector at. (Default: Document)
+     *  @returns The element that matches the given selector.
+     */
+    Select<T extends keyof ElementTags>(selector: T, root: ParentNode): ResolveTag<T>;
+
+    /**
+     *  Search and retrieves the collection of elements that matches the given selector.
+     *
+     *  @param selector - The selector of elements to search.
+     *  @returns The collection of elements that matches the given selector.
+     */
+    SelectAll<T extends keyof ElementTags>(selector: T): ResolveTag<T>;
+
+    /**
+     *  Search and retrieves the collection of elements that matches the given selector.
+     *
+     *  @param selector - The selector of elements to search.
+     *  @param root - The parent element to search the given element selector at. (Default: Document)
+     *  @returns The collection of elements that matches the given selector.
+     */
+    SelectAll<T extends keyof ElementTags>(selector: T, root?: ParentNode): ResolveTag<T>;
+
+    /**
+     *  Access the element's `CSSStyleDeclaration` and returns a set collection of for it.
+     *
+     *  @param element - The element to access its `CSSStyleDeclaration`.
+     */
+    StyleOf(element: Element): DOMStyleOfAPI;
+
+    /**
+     *  Unmounts the given `childNode` from its `parentNode`.
+     *
+     *  @param childNode - The child node to unmount.
+     */
+    Unmount(childNode: ChildNode): void;
+
+    /**
+     *  Unmounts the given `childNode` collection from their `parentNode`.
+     *
+     *  @param childNodes - The collection of child nodes to unmount.
+     */
+    Unmount(...childNodes: ChildNode[]): void;
+
+    /**
+     *  Verifies the given tag of element.
+     *
+     *  @param tag - The tag of element to verify.
+     *
+     *  @throw {ArgumentError} - When parameter tag is not in string format.
+     */
+    VerifyTag<KTag extends keyof ElementTags>(tag: KTag): VerifierTagAPI<KTag>;
+}
+
 declare global {
     /**
      *  A collection of customized and/or enhanced `DocumentObjectModel` methods.
      */
-    readonly var DOM: DomAPI;
+    var DOM: DomAPI;
 }
 
 export { }

package/src/types/dom/element/create/element.create.d.ts

@@ -1,7 +1,9 @@
+import { HTMLElementConfig, HTMLElementTags, MathElementConfig, MathElementTags, ResolveTag, SVGElementConfig, SVGElementTags } from "../element.js";
+
 /**
  *  A collection of `DOM` element creation API methods.
  */
-interface DOMCreateAPI {
+export interface DOMCreateAPI {
     /**
      *  Generates an instance of `HTMLElement` with the given qualified tag.
      *

package/src/types/{api → dom/element}/element.d.ts

@@ -1,12 +1,12 @@
-type HTMLElementTags = HTMLElementTagNameMap;
-type MathElementTags = MathMLElementTagNameMap;
-type SVGElementTags = SVGElementTagNameMap;
-type ElementTags = HTMLElementTags & MathElementTags & SVGElementTags;
-type CSSDeclaration = CSSStyleDeclaration;
+export type HTMLElementTags = HTMLElementTagNameMap;
+export type MathElementTags = MathMLElementTagNameMap;
+export type SVGElementTags = SVGElementTagNameMap;
+export type ElementTags = HTMLElementTags & MathElementTags & SVGElementTags;
+export type CSSDeclaration = CSSStyleDeclaration;
 
-type XMLNameSpace = "http://www.w3.org/1998/Math/MathML" | "http://www.w3.org/1999/xhtml" | "http://www.w3.org/2000/svg";
+export type XMLNameSpace = "http://www.w3.org/1998/Math/MathML" | "http://www.w3.org/1999/xhtml" | "http://www.w3.org/2000/svg";
 
-type HTMLElementConfig = {
+export type HTMLElementConfig = {
     ClassNames?: string | string[];
     Id?: string;
     Text?: string;
@@ -14,7 +14,7 @@ type HTMLElementConfig = {
     [OtherAttr: string]: any;
 }
 
-type MathElementConfig = {
+export type MathElementConfig = {
     Data?: {
         [DataCustomKey: string]: string;
     },
@@ -30,7 +30,7 @@ type MathElementConfig = {
     ScriptLevel?: string;
 }
 
-type SVGElementConfig = {
+export type SVGElementConfig = {
     ClassNames?: string | string[];
     Id?: string;
     Styles?: CSSDeclaration;
@@ -40,16 +40,16 @@ type SVGElementConfig = {
     [OtherAttr: string]: any;
 }
 
-type ResolveTag<T extends keyof ElementTags> =
+export type ResolveTag<T extends keyof ElementTags> =
     T extends keyof HTMLElementTags ? HTMLElementTags[T] :
     T extends keyof MathElementTags ? MathElementTags[T] :
     T extends keyof SVGElementTags ? SVGElementTags[T] : null;
 
-type ResolveTagNS<NS extends XMLNameSpace, T extends keyof ElementTags> =
+export type ResolveTagNS<NS extends XMLNameSpace, T extends keyof ElementTags> =
     NS extends "http://www.w3.org/1998/Math/MathML" ?
-        T extends keyof MathElementTags ? MathElementTags[T] : MathMLElement :
+    T extends keyof MathElementTags ? MathElementTags[T] : MathMLElement :
     NS extends "http://www.w3.org/1999/xhtml" ?
-        T extends keyof HTMLElementTags ? HTMLElementTags[T] : HTMLElement :
+    T extends keyof HTMLElementTags ? HTMLElementTags[T] : HTMLElement :
     NS extends "http://www.w3.org/2000/svg" ?
-        T extends keyof SVGElementTags ? SVGElementTags[T] : SVGElement :
+    T extends keyof SVGElementTags ? SVGElementTags[T] : SVGElement :
     never;

package/src/types/dom/element/getElementBy/dom.getElementBy.d.ts

@@ -1,4 +1,6 @@
-interface DOMGetElementByAPI {
+import { ElementTags, ResolveTag, ResolveTagNS, XMLNameSpace } from "../element.js";
+
+export interface DOMGetElementByAPI {
     /**
      *  Search and retrieves the elements with the given class name.
      *

package/src/types/dom/element/tag-verifier/verifier.d.ts

@@ -1,4 +1,6 @@
-interface VerifierTagAPI<K extends keyof ElementTags> {
+import { ElementTags, ResolveTag } from "../element.js";
+
+export interface VerifierTagAPI<K extends keyof ElementTags> {
     /**
      *  Verifies the given tag of element whether if its qualified as instance of `HTMLElement`.
      */

package/src/types/global.d.ts

@@ -8,16 +8,26 @@
 /// <reference types="./primitives/primitives.d.ts" />
 /// <reference types="./storage/storage.d.ts" />
 
+import { ArithmeticAPI } from "./arithmetic/arithmetic.js";
+import { CustomAPI } from "./custom/custom.js";
+import { DomAPI } from "./dom/dom.js";
+import { DOMGetElementByAPI } from "./dom/element/getElementBy/dom.getElementBy.js";
+import { ErrorAPI } from "./custom/error/error.js";
+import { GuardsAPI } from "./guards/guards.js";
+import { PrimitivesAPI } from "./primitives/primitives.js";
+import { StorageAPI } from "./storage/storage.js";
+import { VariablesAPI } from "./variables.js";
+
 declare global {
-    readonly var Arithmetic: ArithmeticAPI;
-    readonly var Custom: CustomAPI;
-    readonly var DOM: DomAPI;
-    readonly var ERROR: ErrorAPI;
-    readonly var GetElementBy: DOMGetElementByAPI;
-    readonly var Guards: GuardsAPI;
-    readonly var Primitives: PrimitivesAPI;
-    readonly var STORAGE: StorageAPI;
-    readonly var Variables: VariablesAPI
+    var Arithmetic: ArithmeticAPI;
+    var Custom: CustomAPI;
+    var DOM: DomAPI;
+    var ERROR: ErrorAPI;
+    var GetElementBy: DOMGetElementByAPI;
+    var Guards: GuardsAPI;
+    var Primitives: PrimitivesAPI;
+    var STORAGE: StorageAPI;
+    var Variables: VariablesAPI;
 }
 
 export { };

package/src/types/guards/format/guards.format.d.ts

@@ -0,0 +1,155 @@
+export interface FormatGuardsAPI {
+    /**
+     *  Validates whether if the specified ***function*** argument is ***anonymous***.
+     *
+     *  @param func - The function to validate.
+     */
+    IsFuncAnonymous(func: Function): boolean;
+
+    /**
+     *  Validates whether if the specified ***function*** argument is ***asynchronous***.
+     *
+     *  @param func - The function to validate.
+     */
+    IsFuncAsynchronous(func: Function): func is AsyncGeneratorFunction;
+
+    /**
+     *  Validates whether if the specified ***string*** argument includes lowercase characters.
+     *
+     *  @param str - The string to validate.
+     */
+    HasLowerCase(str: string): boolean;
+
+    /**
+     *  Validates whether if the specified ***string*** argument starts with lowercase character.
+     *
+     *  @param str - The string to validate.
+     */
+    IsStartsWithLowerCase(str: string): boolean;
+
+    /**
+     *  Validates whether if the specified ***string*** argument ends with lowercase character.
+     *
+     *  @param str - The string to validate.
+     */
+    IsEndsWithLowerCase(str: string): boolean;
+
+    /**
+     *  Validates whether if the specified ***string*** argument includes uppercase characters.
+     *
+     *  @param str - The string to validate.
+     */
+    HasUpperCase(str: string): boolean;
+
+    /**
+     *  Validates whether if the specified ***string*** argument starts with uppercase character.
+     *
+     *  @param str - The string to validate.
+     */
+    IsStartsWithUpperCase(str)
+
+    /**
+     *  Validates whether if the specified ***string*** argument ends with uppercase character.
+     *
+     *  @param str - The string to validate.
+     */
+    IsEndsWithUpperCase(str: string): boolean;
+
+    /**
+     *  Validates whether if the specified ***string*** argument includes numbers.
+     *
+     *  @param str - The string to validate.
+     */
+    HasNumbers(str: string): boolean;
+
+    /**
+     *  Validates whether if the specified ***string*** argument starts with number.
+     *
+     *  @param str - The string to validate.
+     */
+    IsStartsWithNumber(str: string): boolean;
+
+    /**
+     *  Validates whether if the specified ***string*** argument ends with number.
+     *
+     *  @param str - The string to validate.
+     */
+    IsEndsWithNumber(str: string): boolean;
+
+    /**
+     *  Validates whether if the specified ***string*** argument includes specified characters.
+     *
+     *  @param str - The string to validate.
+     */
+    HasSpecialCharacters(str: string): boolean;
+
+    /**
+     *  Validates whether if the specified ***string*** argument starts with special character.
+     *
+     *  @param str - The string to validate.
+     */
+    IsStartsWithSpecialCharacter(str: string): boolean;
+
+    /**
+     *  Validates whether if the specified ***string*** argument ends with special character.
+     *
+     *  @param str - The string to validate.
+     */
+    IsEndsWithSpecialCharacter(str: string): boolean;
+
+    /**
+     *  Validates whether if the specified ***string*** argument includes ASCII characters.
+     *
+     *  @param str - The string to validate.
+     */
+    HasASCII(str: string): boolean;
+
+    /**
+     *  Validates whether if the specified ***string*** argument starts with ASCII character.
+     *
+     *  @param str - The string to validate.
+     */
+    IsStartsWithASCII(str: string): boolean;
+
+    /**
+     *  Validates whether if the specified ***string*** argument ends with ASCII character.
+     *
+     *  @param str - The string to validate.
+     */
+    IsEndsWithASCII(str: string): boolean;
+
+    /**
+     *  Validates whether if the specified ***string*** argument is empty.
+     *
+     *  @param str - The string to validate.
+     */
+    IsStrEmpty(str: string): boolean;
+
+    /**
+     *  Validates whether if the specified ***array*** argument is empty.
+     *
+     *  @param arr - The array to validate.
+     */
+    IsArrEmpty(arr: Array<unknown>): arr is never[];
+
+    /**
+     *  Validates whether if the specified ***plain object*** is empty.
+     *
+     *  @param obj - The plain object to validate.
+     */
+    IsPlainObjEmpty(obj: { [prop: string]: unknown }): boolean;
+
+    /**
+     *  Validates whether if the specified ***map object*** is empty.
+     *
+     *  @param mObj - The map object to validate.
+     */
+    IsMapObjEmpty(mObj: Map<unknown, unknown>): boolean;
+
+    /**
+     *  Validates whether if the specified ***set object*** is empty.
+     *
+     *  @param sObj - The set object to validate.
+     */
+    IsSetObjEmpty(sObj: Set<unknown>): boolean;
+}

package/src/types/guards/guards.d.ts

@@ -1,8 +1,13 @@
+import { FormatGuardsAPI } from "./format/guards.format.js";
+import { TypeGuardsAPI } from "./type/guards.type.js";
+
+export type GuardsAPI = FormatGuardsAPI & TypeGuardsAPI;
+
 declare global {
     /**
      *  A collection of data types and formats guards validation.
      */
-    readonly var Guards: GuardsAPI;
+    var Guards: GuardsAPI;
 }
 
 export { }

package/src/types/guards/type/guards.type.d.ts

@@ -0,0 +1,120 @@
+export interface TypeGuardsAPI {
+    /**
+     *  Validates whether if the specified argument is `null` or `undefined`.
+     *
+     *  @param arg - The argument to validate.
+     */
+    IsNullOrUndefined<T>(arg: T): Extract<T, null | undefined>;
+
+    /**
+     *  Validates whether if the specified argument is a `string`.
+     *
+     *  @param arg - The argument to validate.
+     */
+    IsStr(arg: any): arg is string;
+
+    /**
+     *  Validates whether if the specified argument is an `array`.
+     *
+     *  @param arg - The argument to validate.
+     */
+    IsArr(arg: any): arg is Array;
+
+    /**
+     *  Validates whether if the specified argument is a `function`.
+     *
+     *  @param arg - The argument to validate.
+     */
+    IsFunc(arg: any): arg is Function;
+
+    /**
+     *  Validates whether if the specified argument is a `map object`.
+     *
+     *  @param arg - The argument to validate.
+     */
+    IsMapObj(arg: any): arg is Map;
+
+    /**
+     *  Validates whether if the specified argument is a `set object`.
+     *
+     *  @param arg - The argument to validate.
+     */
+    IsSetObj(arg: any): arg is Set;
+
+    /**
+     *  Validates whether if the specified argument is a `plain object`.
+     *
+     *  @param arg - The argument to validate.
+     */
+    IsPlainObj(arg: any): arg is { [prop: string]: any }
+
+    /**
+     *  Validates whether if the specified argument is a `boolean`.
+     *
+     *  @param arg - The argument to validate.
+     */
+    IsBool(arg: any): arg is boolean;
+
+    /**
+     *  Validates whether if the specified argument is a `number`.
+     *
+     *  @param arg - The argument to validate.
+     */
+    IsNum(arg: any): arg is number;
+
+    /**
+     *  Validates whether if the specified argument is a `Node`.
+     *
+     *  @param arg - The argument to validate.
+     */
+    IsNode(arg: any): arg is Node;
+
+    /**
+     *  Validates whether if the specified argument is a `ParentNode`.
+     *
+     *  @param arg - The argument to validate.
+     */
+    IsParentNode(arg: any): arg is ParentNode;
+
+    /**
+     *  Validates whether if the specified argument is a `ChildNode`.
+     *
+     *  @param arg - The argument to validate.
+     */
+    IsChildNode(arg: any): arg is ChildNode;
+
+    /**
+     *  Validates whether if the specified argument is an `Element` or instance of it.
+     *
+     *  @param arg - The argument to validate.
+     */
+    IsElement(arg: any): arg is Element;
+
+    /**
+     *  Validates whether if the specified argument is an `HTMLElement` or instance of it.
+     *
+     *  @param arg - The argument to validate.
+     */
+    IsHTMLElement(arg: any): arg is HTMLElement;
+
+    /**
+     *  Validates whether if the specified argument is an `HTMLUnknownElement` or instance of it.
+     *
+     *  @param arg - The argument to validate.
+     */
+    IsUnknownElement(arg: any): arg is HTMLUnknownElement;
+
+    /**
+     *  Validates whether if the specified argument is `Iterator`.
+     *
+     *  @param arg - The argument to validate.
+     */
+    IsIterator(arg: any): arg is Iterator;
+
+    /**
+     *  Validates whether if the specified argument is `RegExp`.
+     *
+     *  @param arg - The argument to validate.
+     */
+    IsRegExp(arg: any): arg is RegExp;
+}