xdbc 1.0.85 → 1.0.86

package/dist/DBC/AE.js

@@ -25,9 +25,7 @@ export class AE extends DBC {
      *
      * @returns As soon as the "condition" returns a {@link string }, instead of TRUE, the returned string. TRUE if the
      * 			"condition" never returns a {@link string}. */
-    static checkAlgorithm(
-    // biome-ignore lint/suspicious/noExplicitAny: <explanation>
-    condition, value, index, idxEnd) {
+    static checkAlgorithm(condition, value, index, idxEnd) {
         if (Array.isArray(value)) {
             if (index !== undefined && idxEnd === undefined) {
                 if (index > -1 && index < value.length) {
@@ -85,9 +83,7 @@ export class AE extends DBC {
                 }
             }
             else {
-                return AE.checkAlgorithm(
-                // biome-ignore lint/suspicious/noExplicitAny: <explanation>
-                realConditions, value, index, idxEnd);
+                return AE.checkAlgorithm(realConditions, value, index, idxEnd);
             }
             return true;
         }, dbc, path);
@@ -133,9 +129,7 @@ export class AE extends DBC {
      * @param toCheck See {@link EQ.checkAlgorithm }.
      *
      * @returns See {@link EQ.checkAlgorithm}. */
-    check(
-    // biome-ignore lint/suspicious/noExplicitAny: <explanation>
-    toCheck) {
+    check(toCheck) {
         if (Array.isArray(this.conditions)) {
             for (const currentCondition of this.conditions) {
                 const result = AE.checkAlgorithm(currentCondition, toCheck, this.index, this.idxEnd);

package/dist/DBC/OR.js

@@ -0,0 +1,101 @@
+import { DBC } from "../DBC.js";
+/**
+ * A {@link DBC } defining that all elements of an {@link object }s have to fulfill
+ * one of the given {@link object }s check-methods (( toCheck : any ) => boolean | string ).
+ *
+ * @remarks
+ * Maintainer: Callari, Salvatore (XDBC@WaXCode.net) */
+export class OR extends DBC {
+    // #region Condition checking.
+    /**
+     * Checks each element of the "value"-{@link Array < any >} against the given "condition", if it is one. If it is not
+     * the "value" itself will be checked.
+     *
+     * @param conditions	The { check: (toCheck: any) => boolean | string }-{@link object }s to check the "value" against.
+     * @param value			Either "value"-{@link Array < any >}, which's elements will be checked, or the value to be
+     * 						checked itself.
+     * @param index			If specified with "idxEnd" being undefined, this {@link Number } will be seen as the index of
+     * 						the value-{@link Array }'s element to check. If value isn't an {@link Array } this parameter
+     * 						will not have any effect.
+     * 						With "idxEnd" not undefined this parameter indicates the beginning of the span of elements to
+     * 						check within the value-{@link Array }.
+     * @param idxEnd		Indicates the last element's index (including) of the span of value-{@link Array } elements to check.
+     * 						Setting this parameter to -1 specifies that all value-{@link Array }'s elements beginning from the
+     * 						specified "index" shall be checked.
+     *
+     * @returns TRUE if at least one of the provided "conditions" is fulfilled, otherwise a {@link string } containing all "conditions" returned {@link string }s separated by " || ". */
+    static checkAlgorithm(conditions, value) {
+        let result = "";
+        for (let i = 0; i < conditions.length; i++) {
+            const conditionResult = conditions[i].check(value);
+            if (typeof conditionResult !== "boolean") {
+                result += `${conditionResult}${i === conditions.length - 1 ? "" : " || "}`;
+            }
+            else {
+                return true;
+            }
+        }
+        return true;
+    }
+    /**
+     * A parameter-decorator factory using the {@link OR.checkAlgorithm } with either multiple or a single one
+     * of the "realConditions" to check the tagged parameter-value against with.
+     * When specifying an "index" and the tagged parameter's "value" is an {@link Array }, the "realConditions" apply to the
+     * element at the specified "index".
+     * If the {@link Array } is too short the currently processed { check: (toCheck: any) => boolean | string } of
+     * "realConditions" will be verified to TRUE automatically, considering optional parameters.
+     * If an "index" is specified but the tagged parameter's value isn't an array, the "index" is treated as being undefined.
+     * If "index" is undefined and the tagged parameter's value is an {@link Array } each element of it will be checked
+     * against the "realConditions".
+     *
+     * @param realConditions	Either one or more { check: (toCheck: any) => boolean | string } to check the tagged parameter-value
+     * 							against with.
+     * @param path				See {@link DBC.decPrecondition }.
+     * @param dbc				See {@link DBC.decPrecondition }.
+     *
+     * @returns	A {@link string } as soon as one { check: (toCheck: any) => boolean | string } of "realConditions" returns one.
+     * 			Otherwise TRUE. */
+    static PRE(conditions, path = undefined, dbc = "WaXCode.DBC") {
+        return DBC.decPrecondition((value, target, methodName, parameterIndex) => {
+            return OR.checkAlgorithm(conditions, value);
+        }, dbc, path);
+    }
+    /**
+     * A method-decorator factory using the {@link OR.checkAlgorithm } with either multiple or a single one
+     * of the "realConditions" to check the tagged method's return-value against with.
+     *
+     * @param realConditions	Either one or more { check: (toCheck: any) => boolean | string } to check the tagged parameter-value
+     * 							against with.
+     * @param path				See {@link DBC.decPrecondition }.
+     * @param dbc				See {@link DBC.decPrecondition }.
+     *
+     * @returns	A {@link string } as soon as one { check: (toCheck: any) => boolean | string } of "realConditions" return one.
+     * 			Otherwise TRUE. */
+    static POST(conditions, path = undefined, dbc = "WaXCode.DBC") {
+        return DBC.decPostcondition((value, target, propertyKey) => {
+            return OR.checkAlgorithm(conditions, value);
+        }, dbc, path);
+    }
+    // #endregion Condition checking.
+    // #region Referenced Condition checking.
+    //
+    // For usage in dynamic scenarios (like global functions).
+    //
+    /**
+     * Invokes the {@link OR.checkAlgorithm } passing the value "toCheck" and {@link OR.conditions }.
+     *
+     * @param toCheck See {@link OR.checkAlgorithm }.
+     *
+     * @returns See {@link OR.checkAlgorithm}. */
+    check(toCheck) {
+        return OR.checkAlgorithm(this.conditions, toCheck);
+    }
+    /**
+     * Creates this {@link OR } by setting the protected property {@link OR.conditions } used by {@link OR.check }.
+     *
+     * @param conditions See {@link OR.check }. */
+    constructor(conditions) {
+        super();
+        this.conditions = conditions;
+    }
+}

package/dist/DBC/REGEX.js

@@ -63,7 +63,6 @@ export class REGEX extends DBC {
      * @param toCheck See {@link EQ.checkAlgorithm }.
      *
      * @returns See {@link EQ.checkAlgorithm}. */
-    // biome-ignore lint/suspicious/noExplicitAny: <explanation>
     check(toCheck) {
         return REGEX.checkAlgorithm(toCheck, this.expression);
     }

package/dist/DBC.js

@@ -93,6 +93,29 @@ export class DBC {
         return descriptor;
     }
     // #endregion Parameter-value requests.
+    // #region Invariant
+    /**
+     *
+     * @param toCheck
+     * @returns
+     */
+    check(toCheck) {
+        return false;
+    }
+    /**
+     *
+     * @param conditions
+     * @param property
+     * @returns
+     */
+    static decInvariant(conditions, property) {
+        return (toCheck) => {
+            for (const condition of conditions) {
+                condition.check(new toCheck(...[])[property]);
+            }
+        };
+    }
+    // #endregion Invariant
     // #region Postcondition
     /**
      *

package/package.json

@@ -1,5 +1,5 @@
 {
-	"version": "1.0.85",
+	"version": "1.0.86",
 	"name": "xdbc",
 	"scripts": {
 		"format": "biome format ./src --write",

package/src/DBC/AE.ts

@@ -26,8 +26,9 @@ export class AE extends DBC {
 	 * @returns As soon as the "condition" returns a {@link string }, instead of TRUE, the returned string. TRUE if the
 	 * 			"condition" never returns a {@link string}. */
 	public static checkAlgorithm(
-		// biome-ignore lint/suspicious/noExplicitAny: <explanation>
-		condition: { check: (toCheck: any) => boolean | string },
+		condition: {
+			check: (toCheck: unknown | null | undefined) => boolean | string;
+		},
 		value: object,
 		index: number | undefined,
 		idxEnd: number | undefined,
@@ -86,10 +87,11 @@ export class AE extends DBC {
 	 * @returns	A {@link string } as soon as one { check: (toCheck: any) => boolean | string } of "realConditions" returns one.
 	 * 			Otherwise TRUE. */
 	public static PRE(
-		realConditions: // biome-ignore lint/suspicious/noExplicitAny: <explanation>
-			| Array<{ check: (toCheck: any) => boolean | string }>
-			// biome-ignore lint/suspicious/noExplicitAny: <explanation>
-			| { check: (toCheck: any) => boolean | string },
+		realConditions:
+			| Array<{
+					check: (toCheck: unknown | undefined | null) => boolean | string;
+			  }>
+			| { check: (toCheck: unknown | undefined | null) => boolean | string },
 		index: number | undefined = undefined,
 		idxEnd: number | undefined = undefined,
 		path: string | undefined = undefined,
@@ -119,8 +121,9 @@ export class AE extends DBC {
 					}
 				} else {
 					return AE.checkAlgorithm(
-						// biome-ignore lint/suspicious/noExplicitAny: <explanation>
-						realConditions as { check: (toCheck: any) => boolean | string },
+						realConditions as {
+							check: (toCheck: unknown | undefined | null) => boolean | string;
+						},
 						value,
 						index,
 						idxEnd,
@@ -200,10 +203,7 @@ export class AE extends DBC {
 	 * @param toCheck See {@link EQ.checkAlgorithm }.
 	 *
 	 * @returns See {@link EQ.checkAlgorithm}. */
-	public check(
-		// biome-ignore lint/suspicious/noExplicitAny: <explanation>
-		toCheck: any,
-	) {
+	public check(toCheck: object) {
 		if (Array.isArray(this.conditions)) {
 			for (const currentCondition of this.conditions) {
 				const result = AE.checkAlgorithm(
@@ -232,10 +232,11 @@ export class AE extends DBC {
 	 *
 	 * @param equivalent See {@link EQ.check }. */
 	public constructor(
-		protected conditions: // biome-ignore lint/suspicious/noExplicitAny: <explanation>
-			| Array<{ check: (toCheck: any) => boolean | string }>
-			// biome-ignore lint/suspicious/noExplicitAny: <explanation>
-			| { check: (toCheck: any) => boolean | string },
+		protected conditions:
+			| Array<{
+					check: (toCheck: unknown | undefined | null) => boolean | string;
+			  }>
+			| { check: (toCheck: unknown | undefined | null) => boolean | string },
 		protected index: number | undefined = undefined,
 		protected idxEnd: number | undefined = undefined,
 	) {

package/src/DBC/OR.ts

@@ -0,0 +1,145 @@
+import { DBC } from "../DBC.js";
+/**
+ * A {@link DBC } defining that all elements of an {@link object }s have to fulfill
+ * one of the given {@link object }s check-methods (( toCheck : any ) => boolean | string ).
+ *
+ * @remarks
+ * Maintainer: Callari, Salvatore (XDBC@WaXCode.net) */
+export class OR extends DBC {
+	// #region Condition checking.
+	/**
+	 * Checks each element of the "value"-{@link Array < any >} against the given "condition", if it is one. If it is not
+	 * the "value" itself will be checked.
+	 *
+	 * @param conditions	The { check: (toCheck: any) => boolean | string }-{@link object }s to check the "value" against.
+	 * @param value			Either "value"-{@link Array < any >}, which's elements will be checked, or the value to be
+	 * 						checked itself.
+	 * @param index			If specified with "idxEnd" being undefined, this {@link Number } will be seen as the index of
+	 * 						the value-{@link Array }'s element to check. If value isn't an {@link Array } this parameter
+	 * 						will not have any effect.
+	 * 						With "idxEnd" not undefined this parameter indicates the beginning of the span of elements to
+	 * 						check within the value-{@link Array }.
+	 * @param idxEnd		Indicates the last element's index (including) of the span of value-{@link Array } elements to check.
+	 * 						Setting this parameter to -1 specifies that all value-{@link Array }'s elements beginning from the
+	 * 						specified "index" shall be checked.
+	 *
+	 * @returns TRUE if at least one of the provided "conditions" is fulfilled, otherwise a {@link string } containing all "conditions" returned {@link string }s separated by " || ". */
+	public static checkAlgorithm(
+		conditions: Array<{
+			check: (toCheck: unknown | undefined | null) => boolean | string;
+		}>,
+		value: object,
+	): boolean | string {
+		let result = "";
+
+		for (let i = 0; i < conditions.length; i++) {
+			const conditionResult = conditions[i].check(value);
+
+			if (typeof conditionResult !== "boolean") {
+				result += `${conditionResult}${i === conditions.length - 1 ? "" : " || "}`;
+			} else {
+				return true;
+			}
+		}
+
+		return true;
+	}
+	/**
+	 * A parameter-decorator factory using the {@link OR.checkAlgorithm } with either multiple or a single one
+	 * of the "realConditions" to check the tagged parameter-value against with.
+	 * When specifying an "index" and the tagged parameter's "value" is an {@link Array }, the "realConditions" apply to the
+	 * element at the specified "index".
+	 * If the {@link Array } is too short the currently processed { check: (toCheck: any) => boolean | string } of
+	 * "realConditions" will be verified to TRUE automatically, considering optional parameters.
+	 * If an "index" is specified but the tagged parameter's value isn't an array, the "index" is treated as being undefined.
+	 * If "index" is undefined and the tagged parameter's value is an {@link Array } each element of it will be checked
+	 * against the "realConditions".
+	 *
+	 * @param realConditions	Either one or more { check: (toCheck: any) => boolean | string } to check the tagged parameter-value
+	 * 							against with.
+	 * @param path				See {@link DBC.decPrecondition }.
+	 * @param dbc				See {@link DBC.decPrecondition }.
+	 *
+	 * @returns	A {@link string } as soon as one { check: (toCheck: any) => boolean | string } of "realConditions" returns one.
+	 * 			Otherwise TRUE. */
+	public static PRE(
+		conditions: Array<{
+			check: (toCheck: unknown | undefined | null) => boolean | string;
+		}>,
+		path: string | undefined = undefined,
+		dbc = "WaXCode.DBC",
+	): (
+		target: object,
+		methodName: string | symbol,
+		parameterIndex: number,
+	) => void {
+		return DBC.decPrecondition(
+			(
+				value: object,
+				target: object,
+				methodName: string,
+				parameterIndex: number,
+			) => {
+				return OR.checkAlgorithm(conditions, value);
+			},
+			dbc,
+			path,
+		);
+	}
+	/**
+	 * A method-decorator factory using the {@link OR.checkAlgorithm } with either multiple or a single one
+	 * of the "realConditions" to check the tagged method's return-value against with.
+	 *
+	 * @param realConditions	Either one or more { check: (toCheck: any) => boolean | string } to check the tagged parameter-value
+	 * 							against with.
+	 * @param path				See {@link DBC.decPrecondition }.
+	 * @param dbc				See {@link DBC.decPrecondition }.
+	 *
+	 * @returns	A {@link string } as soon as one { check: (toCheck: any) => boolean | string } of "realConditions" return one.
+	 * 			Otherwise TRUE. */
+	public static POST(
+		conditions: Array<{
+			check: (toCheck: unknown | undefined | null) => boolean | string;
+		}>,
+		path: string | undefined = undefined,
+		dbc = "WaXCode.DBC",
+	): (
+		target: object,
+		propertyKey: string,
+		descriptor: PropertyDescriptor,
+	) => PropertyDescriptor {
+		return DBC.decPostcondition(
+			(value: object, target: object, propertyKey: string) => {
+				return OR.checkAlgorithm(conditions, value);
+			},
+			dbc,
+			path,
+		);
+	}
+	// #endregion Condition checking.
+	// #region Referenced Condition checking.
+	//
+	// For usage in dynamic scenarios (like global functions).
+	//
+	/**
+	 * Invokes the {@link OR.checkAlgorithm } passing the value "toCheck" and {@link OR.conditions }.
+	 *
+	 * @param toCheck See {@link OR.checkAlgorithm }.
+	 *
+	 * @returns See {@link OR.checkAlgorithm}. */
+	public check(toCheck: object) {
+		return OR.checkAlgorithm(this.conditions, toCheck);
+	}
+	/**
+	 * Creates this {@link OR } by setting the protected property {@link OR.conditions } used by {@link OR.check }.
+	 *
+	 * @param conditions See {@link OR.check }. */
+	public constructor(
+		protected conditions: Array<{
+			check: (toCheck: unknown | undefined | null) => boolean | string;
+		}>,
+	) {
+		super();
+	}
+	// #endregion Referenced Condition checking.
+}

package/src/DBC/REGEX.ts

@@ -106,8 +106,7 @@ export class REGEX extends DBC {
 	 * @param toCheck See {@link EQ.checkAlgorithm }.
 	 *
 	 * @returns See {@link EQ.checkAlgorithm}. */
-	// biome-ignore lint/suspicious/noExplicitAny: <explanation>
-	public check(toCheck: any) {
+	public check(toCheck: unknown | null | undefined) {
 		return REGEX.checkAlgorithm(toCheck, this.expression);
 	}
 	/**

package/src/DBC.ts

@@ -122,6 +122,31 @@ export class DBC {
 		return descriptor;
 	}
 	// #endregion Parameter-value requests.
+	// #region Invariant
+	/**
+	 *
+	 * @param toCheck
+	 * @returns
+	 */
+	check(toCheck: unknown | null | undefined): boolean | string {
+		return false;
+	}
+	/**
+	 *
+	 * @param conditions
+	 * @param property
+	 * @returns
+	 */
+	public static decInvariant(conditions: Array<DBC>, property: string) {
+		return (
+			toCheck: new (...args: Array<unknown | null | undefined>) => object,
+		) => {
+			for (const condition of conditions) {
+				condition.check(new toCheck(...[])[property]);
+			}
+		};
+	}
+	// #endregion Invariant
 	// #region Postcondition
 	/**
 	 *