@carlsebastian/jsu 1.1.1 → 1.2.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@carlsebastian/jsu",
-  "version": "1.1.1",
+  "version": "1.2.1",
   "description": "A ready-to-use JavaScripts custom utilities such as types validations, formats validations, formatter, and many more!",
   "main": "./global.js",
   "types": "./src/types/global.d.ts",

package/src/types/arithmetic/arithmetic.d.ts

@@ -1,18 +1,17 @@
-interface ArithmeticAPI {
+export interface ArithmeticAPI {
     /**
-     *  Accumulates the total divided value of the first and second numerical values.
+     *  Accumulates the total divided value of the given collection of numerical values.
      *
      *  ***Note***:
      *   - Using a zero (`0`) to divide other given numerical values would always resulted to `NaN`.
      *
-     *  @param num1 - The first or primary base numerical value of this operation.
-     *  @param num2 - The second numerical value to divide with primary value.
+     *  @param nums - The collection of numerical values to divide.
      *  @returns The total accumulated result of this operation.
      */
-    Divide(num1: number, num2: number): number;
+    Divide(...nums: number[]): number;
 
     /**
-     *  Accumulates the total divided value of the first, second, and third numerical values.
+     *  Accumulates the total divided value of the first, second, third, fourth, and fifth numerical values.
      *
      *  ***Note***:
      *   - Using a zero (`0`) to divide other given numerical values would always resulted to `NaN`.
@@ -20,9 +19,11 @@ interface ArithmeticAPI {
      *  @param num1 - The first or primary base numerical value of this operation.
      *  @param num2 - The second numerical value to divide with primary value.
      *  @param num3 - The third numerical value to divide with the given first 2 numerical values.
+     *  @param num4 - The fourth numerical value to divide with the given first 3 numerical values.
+     *  @param num5 - The fifth numerical value to divide with the other given 4 numerical values.
      *  @returns The total accumulated result of this operation.
      */
-    Divide(num1: number, num2: number, num3: number): number;
+    Divide(num1: number, num2: number, num3: number, num4: number, num5: number): number;
 
     /**
      *  Accumulates the total divided value of the first, second, third, and fourth numerical values.
@@ -39,7 +40,7 @@ interface ArithmeticAPI {
     Divide(num1: number, num2: number, num3: number, num4: number): number;
 
     /**
-     *  Accumulates the total divided value of the first, second, third, and fourth numerical values.
+     *  Accumulates the total divided value of the first, second, and third numerical values.
      *
      *  ***Note***:
      *   - Using a zero (`0`) to divide other given numerical values would always resulted to `NaN`.
@@ -47,51 +48,35 @@ interface ArithmeticAPI {
      *  @param num1 - The first or primary base numerical value of this operation.
      *  @param num2 - The second numerical value to divide with primary value.
      *  @param num3 - The third numerical value to divide with the given first 2 numerical values.
-     *  @param num4 - The fourth numerical value to divide with the given first 3 numerical values.
      *  @returns The total accumulated result of this operation.
      */
-    Divide(num1: number, num2: number, num3: number, num4: number): number;
+    Divide(num1: number, num2: number, num3: number): number;
 
     /**
-     *  Accumulates the total divided value of the first, second, third, fourth, and fifth numerical values.
+     *  Accumulates the total divided value of the first and second numerical values.
      *
      *  ***Note***:
      *   - Using a zero (`0`) to divide other given numerical values would always resulted to `NaN`.
      *
      *  @param num1 - The first or primary base numerical value of this operation.
      *  @param num2 - The second numerical value to divide with primary value.
-     *  @param num3 - The third numerical value to divide with the given first 2 numerical values.
-     *  @param num4 - The fourth numerical value to divide with the given first 3 numerical values.
-     *  @param num5 - The fifth numerical value to divide with the other given 4 numerical values.
      *  @returns The total accumulated result of this operation.
      */
-    Divide(num1: number, num2: number, num3: number, num4: number, num5: number): number;
-
-    /**
-     *  Accumulates the total divided value of the given collection of numerical values.
-     *
-     *  ***Note***:
-     *   - Using a zero (`0`) to divide other given numerical values would always resulted to `NaN`.
-     *
-     *  @param nums - The collection of numerical values to divide.
-     *  @returns The total accumulated result of this operation.
-     */
-    Divide(...nums: number[]): number;
+    Divide(num1: number, num2: number): number;
 
     /**
-     *  Accumulates the total multiplied value of the first and second numerical values.
+     *  Accumulates the total multiplied value of the given collection of numerical values.
      *
      *  ***Note***:
      *   - Using a zero (`0`) to multiply other given numerical values would always resulted to (`0`).
      *
-     *  @param num1 - The first or primary base numerical value of this operation.
-     *  @param num2 - The second numerical value to multiply with primary value.
+     *  @param nums - The collection of numerical values to multiply.
      *  @returns The total accumulated result of this operation.
      */
-    Multiply(num1: number, num2: number): number;
+    Multiply(...nums: number[]): number;
 
     /**
-     *  Accumulates the total multiplied value of the first, second, and third numerical values.
+     *  Accumulates the total multiplied value of the first, second, third, fourth, and fifth numerical values.
      *
      *  ***Note***:
      *   - Using a zero (`0`) to multiply other given numerical values would always resulted to (`0`).
@@ -99,9 +84,11 @@ interface ArithmeticAPI {
      *  @param num1 - The first or primary base numerical value of this operation.
      *  @param num2 - The second numerical value to multiply with primary value.
      *  @param num3 - The third numerical value to multiply with the given first 2 numerical values.
+     *  @param num4 - The fourth numerical value to multiply with the given first 3 numerical values.
+     *  @param num5 - The fifth numerical value to multiply with the other given 4 numerical values.
      *  @returns The total accumulated result of this operation.
      */
-    Multiply(num1: number, num2: number, num3: number): number;
+    Multiply(num1: number, num2: number, num3: number, num4: number, num5: number): number;
 
     /**
      *  Accumulates the total multiplied value of the first, second, third, and fourth numerical values.
@@ -118,7 +105,7 @@ interface ArithmeticAPI {
     Multiply(num1: number, num2: number, num3: number, num4: number): number;
 
     /**
-     *  Accumulates the total multiplied value of the first, second, third, and fourth numerical values.
+     *  Accumulates the total multiplied value of the first, second, and third numerical values.
      *
      *  ***Note***:
      *   - Using a zero (`0`) to multiply other given numerical values would always resulted to (`0`).
@@ -126,55 +113,41 @@ interface ArithmeticAPI {
      *  @param num1 - The first or primary base numerical value of this operation.
      *  @param num2 - The second numerical value to multiply with primary value.
      *  @param num3 - The third numerical value to multiply with the given first 2 numerical values.
-     *  @param num4 - The fourth numerical value to multiply with the given first 3 numerical values.
      *  @returns The total accumulated result of this operation.
-     */
-    Multiply(num1: number, num2: number, num3: number, num4: number): number;
+    */
+    Multiply(num1: number, num2: number, num3: number): number;
 
     /**
-     *  Accumulates the total multiplied value of the first, second, third, fourth, and fifth numerical values.
+     *  Accumulates the total multiplied value of the first and second numerical values.
      *
      *  ***Note***:
      *   - Using a zero (`0`) to multiply other given numerical values would always resulted to (`0`).
      *
      *  @param num1 - The first or primary base numerical value of this operation.
      *  @param num2 - The second numerical value to multiply with primary value.
-     *  @param num3 - The third numerical value to multiply with the given first 2 numerical values.
-     *  @param num4 - The fourth numerical value to multiply with the given first 3 numerical values.
-     *  @param num5 - The fifth numerical value to multiply with the other given 4 numerical values.
-     *  @returns The total accumulated result of this operation.
-     */
-    Multiply(num1: number, num2: number, num3: number, num4: number, num5: number): number;
-
-    /**
-     *  Accumulates the total multiplied value of the given collection of numerical values.
-     *
-     *  ***Note***:
-     *   - Using a zero (`0`) to multiply other given numerical values would always resulted to (`0`).
-     *
-     *  @param nums - The collection of numerical values to multiply.
      *  @returns The total accumulated result of this operation.
      */
-    Multiply(...nums: number[]): number;
+    Multiply(num1: number, num2: number): number;
 
     /**
-     *  Accumulates the total subtracted value of the first and second numerical values.
+     *  Accumulates the total subtracted value of the given collection of numerical values.
      *
-     *  @param num1 - The first or primary base numerical value of this operation.
-     *  @param num2 - The second numerical value to subtract with primary value.
+     *  @param nums - The collection of numerical values to subtract.
      *  @returns The total accumulated result of this operation.
      */
-    Subtract(num1: number, num2: number): number;
+    Subtract(...nums: number[]): number;
 
     /**
-     *  Accumulates the total subtracted value of the first, second, and third numerical values.
+     *  Accumulates the total subtracted value of the first, second, third, fourth, and fifth numerical values.
      *
      *  @param num1 - The first or primary base numerical value of this operation.
      *  @param num2 - The second numerical value to subtract with primary value.
      *  @param num3 - The third numerical value to subtract with the given first 2 numerical values.
+     *  @param num4 - The fourth numerical value to subtract with the given first 3 numerical values.
+     *  @param num5 - The fifth numerical value to subtract with the other given 4 numerical values.
      *  @returns The total accumulated result of this operation.
      */
-    Subtract(num1: number, num2: number, num3: number): number;
+    Subtract(num1: number, num2: number, num3: number, num4: number, num5: number): number;
 
     /**
      *  Accumulates the total subtracted value of the first, second, third, and fourth numerical values.
@@ -188,54 +161,43 @@ interface ArithmeticAPI {
     Subtract(num1: number, num2: number, num3: number, num4: number): number;
 
     /**
-     *  Accumulates the total subtracted value of the first, second, third, and fourth numerical values.
+     *  Accumulates the total subtracted value of the first, second, and third numerical values.
      *
      *  @param num1 - The first or primary base numerical value of this operation.
      *  @param num2 - The second numerical value to subtract with primary value.
      *  @param num3 - The third numerical value to subtract with the given first 2 numerical values.
-     *  @param num4 - The fourth numerical value to subtract with the given first 3 numerical values.
      *  @returns The total accumulated result of this operation.
      */
-    Subtract(num1: number, num2: number, num3: number, num4: number): number;
+    Subtract(num1: number, num2: number, num3: number): number;
 
     /**
-     *  Accumulates the total subtracted value of the first, second, third, fourth, and fifth numerical values.
+     *  Accumulates the total subtracted value of the first and second numerical values.
      *
      *  @param num1 - The first or primary base numerical value of this operation.
      *  @param num2 - The second numerical value to subtract with primary value.
-     *  @param num3 - The third numerical value to subtract with the given first 2 numerical values.
-     *  @param num4 - The fourth numerical value to subtract with the given first 3 numerical values.
-     *  @param num5 - The fifth numerical value to subtract with the other given 4 numerical values.
-     *  @returns The total accumulated result of this operation.
-     */
-    Subtract(num1: number, num2: number, num3: number, num4: number, num5: number): number;
-
-    /**
-     *  Accumulates the total subtracted value of the given collection of numerical values.
-     *
-     *  @param nums - The collection of numerical values to subtract.
      *  @returns The total accumulated result of this operation.
      */
-    Subtract(...nums: number[]): number;
+    Subtract(num1: number, num2: number): number;
 
     /**
-     *  Accumulates the total summed value of the first and second numerical values.
+     *  Accumulates the total summed value of the given collection of numerical values.
      *
-     *  @param num1 - The first or primary base numerical value of this operation.
-     *  @param num2 - The second numerical value to sum with primary value.
+     *  @param nums - The collection of numerical values to sum.
      *  @returns The total accumulated result of this operation.
      */
-    Sum(num1: number, num2: number): number;
+    Sum(...nums: number[]): number;
 
     /**
-     *  Accumulates the total summed value of the first, second, and third numerical values.
+     *  Accumulates the total summed value of the first, second, third, fourth, and fifth numerical values.
      *
      *  @param num1 - The first or primary base numerical value of this operation.
      *  @param num2 - The second numerical value to sum with primary value.
      *  @param num3 - The third numerical value to sum with the given first 2 numerical values.
+     *  @param num4 - The fourth numerical value to sum with the given first 3 numerical values.
+     *  @param num5 - The fifth numerical value to sum with the other given 4 numerical values.
      *  @returns The total accumulated result of this operation.
      */
-    Sum(num1: number, num2: number, num3: number): number;
+    Sum(num1: number, num2: number, num3: number, num4: number, num5: number): number;
 
     /**
      *  Accumulates the total summed value of the first, second, third, and fourth numerical values.
@@ -249,33 +211,30 @@ interface ArithmeticAPI {
     Sum(num1: number, num2: number, num3: number, num4: number): number;
 
     /**
-     *  Accumulates the total summed value of the first, second, third, and fourth numerical values.
+     *  Accumulates the total summed value of the first, second, and third numerical values.
      *
      *  @param num1 - The first or primary base numerical value of this operation.
      *  @param num2 - The second numerical value to sum with primary value.
      *  @param num3 - The third numerical value to sum with the given first 2 numerical values.
-     *  @param num4 - The fourth numerical value to sum with the given first 3 numerical values.
      *  @returns The total accumulated result of this operation.
      */
-    Sum(num1: number, num2: number, num3: number, num4: number): number;
+    Sum(num1: number, num2: number, num3: number): number;
 
     /**
-     *  Accumulates the total summed value of the first, second, third, fourth, and fifth numerical values.
+     *  Accumulates the total summed value of the first and second numerical values.
      *
      *  @param num1 - The first or primary base numerical value of this operation.
      *  @param num2 - The second numerical value to sum with primary value.
-     *  @param num3 - The third numerical value to sum with the given first 2 numerical values.
-     *  @param num4 - The fourth numerical value to sum with the given first 3 numerical values.
-     *  @param num5 - The fifth numerical value to sum with the other given 4 numerical values.
      *  @returns The total accumulated result of this operation.
      */
-    Sum(num1: number, num2: number, num3: number, num4: number, num5: number): number;
+    Sum(num1: number, num2: number): number;
+}
 
+declare global {
     /**
-     *  Accumulates the total summed value of the given collection of numerical values.
-     *
-     *  @param nums - The collection of numerical values to sum.
-     *  @returns The total accumulated result of this operation.
+     *  A collection of basic math operation.
      */
-    Sum(...nums: number[]): number;
+    var Arithmetic: ArithmeticAPI;
 }
+
+export { }

package/src/types/custom/custom.d.ts

@@ -1,8 +1,13 @@
+import { CustomUtilitiesAPI } from "./utils/custom.utils.js"
+import { GeneratorAPI } from "./utils/generator/generator.js"
+
+export type CustomAPI = CustomUtilitiesAPI & GeneratorAPI;
+
 declare global {
     /**
      *  A collection of customized utilities (`ad-hoc`)
      */
-    readonly var Custom: CustomAPI
+    var Custom: CustomAPI;
 }
 
 export { }

package/src/types/custom/error/builder/error.builder.d.ts

@@ -1,7 +1,7 @@
 /**
  *  A collection of customized error emitter contents for `ErrorConstructorAPI`.
  */
-type ErrorRaiseAPI = {
+export type ErrorRaiseAPI = {
     /**
      *  Builds and emit the contents of `ArgumentError`.
      *
@@ -10,7 +10,7 @@ type ErrorRaiseAPI = {
      *  @param received_arg - The received argument data.
      *  @param expected_args - The expected argument(s) of emitter to receive.
      */
-    _ArgumentError(emitter_id: string, argument_id?: string, received_arg?: string, ...expected_args?: string[]): never;
+    _ArgumentError(emitter_id: string, argument_id?: string, received_arg?: string, ...expected_args: string[]): never;
 
     /**
      *  Builds and emit the contents of `IndexOutOfBoundsError`.

package/src/types/custom/error/constructor/error.base.d.ts

@@ -1,4 +1,6 @@
+import { BaseMeta } from "./error.meta.js";
+
 /**
  *  A central class constructor for making customized or enhanced error.
  */
-class CustomError<Meta extends BaseMeta = BaseMeta> extends Error {}
+export class CustomError<Meta extends BaseMeta = BaseMeta> extends Error {}

package/src/types/custom/error/constructor/error.custom.d.ts

@@ -1,50 +1,52 @@
-type ErrorConstructorAPI = {
+import { ArgumentErrorMeta, IndexOutOfBoundsErrorMeta, InvalidPropertyErrorMeta, MissingParameterErrorMeta, MissingPropertyErrorMeta, NoSuchElementTagErrorMeta, NotSupportedErrorMeta, UnknownPropertyErrorMeta } from "./error.meta.js";
+
+export type ErrorConstructorAPI = {
     /**
      *  A customized and enhanced `TypeError`.
      */
     ArgumentError: {
-        new (meta: ArgumentErrorMeta): ArgumentErrorMeta;
+        new(meta: ArgumentErrorMeta): ArgumentErrorMeta;
     };
     /**
      *  A customized and enhanced `RangeError`.
      */
     IndexOutOfBoundsError: {
-        new (meta: IndexOutOfBoundsErrorMeta): IndexOutOfBoundsErrorMeta;
+        new(meta: IndexOutOfBoundsErrorMeta): IndexOutOfBoundsErrorMeta;
     };
     /**
      *  A customized error for invalid properties.
      */
     InvalidPropertyError: {
-        new (meta: InvalidPropertyErrorMeta): InvalidPropertyErrorMeta;
+        new(meta: InvalidPropertyErrorMeta): InvalidPropertyErrorMeta;
     };
     /**
      *  A customized error for missing parameter value.
      */
     MissingParameterError: {
-        new (meta: MissingParameterErrorMeta): MissingParameterErrorMeta;
+        new(meta: MissingParameterErrorMeta): MissingParameterErrorMeta;
     };
     /**
      *  A customized error for missing property.
      */
     MissingPropertyError: {
-        new (meta: MissingPropertyError): MissingPropertyError;
+        new(meta: MissingPropertyErrorMeta): MissingPropertyErrorMeta;
     };
     /**
      *  A customized error for unqualified element's tag.
      */
     NoSuchElementTagError: {
-        new (meta: NoSuchElementTagErrorMeta): NoSuchElementTagErrorMeta;
+        new(meta: NoSuchElementTagErrorMeta): NoSuchElementTagErrorMeta;
     };
     /**
      *  A customized error for not supported objects, etc.
      */
     NotSupportedError: {
-        new (meta: NotSupportedErrorMeta): NotSupportedErrorMeta;
+        new(meta: NotSupportedErrorMeta): NotSupportedErrorMeta;
     };
     /**
      *  A customized error for unknown property.
      */
     UnknownPropertyError: {
-        new (meta: UnknownPropertyErrorMeta): UnknownPropertyErrorMeta;
+        new(meta: UnknownPropertyErrorMeta): UnknownPropertyErrorMeta;
     };
 }

package/src/types/custom/error/constructor/error.meta.d.ts

@@ -1,18 +1,18 @@
 /**
  *  Default meta data of custom error constructors.
  */
-type BaseMeta<OtherArguments extends {} = {}> = {
+export type BaseMeta<OtherArguments extends {} = {}> = {
     Message: string;
     Context?: { Message?: string; Emitter: string };
     Args?: { Id: string } & OtherArguments;
     Guide?: string;
 }
 
-type ArgumentErrorMeta = BaseMeta<{ ReceivedArgument: string, ExpectedArguments: string[] }>;
-type IndexOutOfBoundsErrorMeta = BaseMeta<{ Index: number, MaxBound: number }>;
-type InvalidPropertyErrorMeta = BaseMeta<{ PropertyId: string }>;
-type MissingParameterErrorMeta = BaseMeta<{ Value: string }>;
-type MissingPropertyErrorMeta = BaseMeta<{ PropertyId: string }>;
-type NoSuchElementTagErrorMeta = BaseMeta<{ Tag: string, TagOf: "HTMLElement" | "MathMLElement" | "SVGElement" }>;
-type NotSupportedErrorMeta = BaseMeta;
-type UnknownPropertyErrorMeta = BaseMeta<{ PropertyId: string }>;
+export type ArgumentErrorMeta = BaseMeta<{ ReceivedArgument: string, ExpectedArguments: string[] }>;
+export type IndexOutOfBoundsErrorMeta = BaseMeta<{ Index: number, MaxBound: number }>;
+export type InvalidPropertyErrorMeta = BaseMeta<{ PropertyId: string }>;
+export type MissingParameterErrorMeta = BaseMeta<{ Value: string }>;
+export type MissingPropertyErrorMeta = BaseMeta<{ PropertyId: string }>;
+export type NoSuchElementTagErrorMeta = BaseMeta<{ Tag: string, TagOf: "HTMLElement" | "MathMLElement" | "SVGElement" }>;
+export type NotSupportedErrorMeta = BaseMeta;
+export type UnknownPropertyErrorMeta = BaseMeta<{ PropertyId: string }>;

package/src/types/custom/error/error.d.ts

@@ -1,5 +1,22 @@
+import { ErrorRaiseAPI } from "./builder/error.builder.js";
+import { ErrorConstructorAPI } from "./constructor/error.custom.js";
+
+export interface ErrorAPI {
+    /**
+     *  A collection of customized error constructors.
+     */
+    readonly Constructors: ErrorConstructorAPI,
+    /**
+     *  A collection of pre-defined customized error constructors builder.
+     */
+    readonly Raise: ErrorRaiseAPI
+}
+
 declare global {
-    readonly var ERROR: ErrorAPI;
+    /**
+     *  A collection of customized error constructors.
+     */
+    var ERROR: ErrorAPI;
 }
 
 export { }

package/src/types/custom/utils/custom.utils.d.ts

@@ -1,7 +1,7 @@
 /**
  *  A collection of customized utilities (`ad-hoc`).
  */
-type CustomUtilitiesAPI = {
+export type CustomUtilitiesAPI = {
     /**
      *  Clamps the current numeric value into its `minimum` and/or `maximum` numeric value.
      *
@@ -41,7 +41,7 @@ type CustomUtilitiesAPI = {
      *  @param data - The data of key-pair data.
      *  @param opt - A options of what would be the state configuration of the defined key-pair data.
      */
-    DefineProperty<K, D>(obj: { [prop: string]: any }, key: K, data: D, opt?: 'def' | 'hard' | 'med' | 'soft'): { [prop: string]: any } & { [prop in K]: D; };
+    DefineProperty<K, D>(obj: { [prop: string]: any }, key: K, data: D, opt?: 'def' | 'hard' | 'med' | 'soft'): { [prop: string]: any } & { [prop in K extends string ? K : string]: D; };
 
     /**
      *  Defines the given key-pair data to the `globalThis` or `window` API.

package/src/types/custom/utils/generator/generator.d.ts

@@ -1,7 +1,7 @@
 /**
  *  Configuration for generator's contents.
  */
-interface GeneratorAPIConfig {
+export interface GeneratorAPIConfig {
     /**
      *  A configuration state for including or excluding numerical values at generator's content.
      */
@@ -35,7 +35,7 @@ interface GeneratorAPIConfig {
 /**
  *  A collection of randomized content generators.
  */
-class GeneratorAPI {
+export class GeneratorAPI {
     /**
      *  The `size` or `length` of contents of generators to generate.
      */
@@ -78,15 +78,15 @@ class GeneratorAPI {
      *  @param min - The minimum or lowest integer value it can generate. (Default: 0)
      *  @param max - The maximum or highest integer value it can generate. (Default: 1)
      */
-    readonly RandomInteger(min?: number, max?: number): number;
+    RandomInteger(min?: number, max?: number): number;
 
     /**
      *  Generates a set of randomized characters in lowercase and/or uppercase.
      */
-    readonly RandomCharacters(): string;
+    RandomCharacters(): string;
 
     /**
      *  Generates a new set of randomized tokens that can be used for ids, session id, etc.
      */
-    readonly NewToken(): string;
+    NewToken(): string;
 }

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

@@ -1,4 +1,4 @@
-interface DOMClassOfAPI {
+export interface DOMClassOfAPI {
     /**
      *  Search the given `class` token at the element's `DOMTokenList`.
      *

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

@@ -1,4 +1,4 @@
-interface DOMIdOfAPI {
+export interface DOMIdOfAPI {
     /**
      *  The current unique `id` value of the element.
      *

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

@@ -1,4 +1,6 @@
-interface DOMStyleOfAPI {
+import { CSSDeclaration } from "../element/element.js";
+
+export interface DOMStyleOfAPI {
     /**
      *  Set the given `CSSStyle` object properties from the element.
      *