xdbc 1.0.97 → 1.0.98

package/package.json

@@ -1,5 +1,5 @@
 {
-	"version": "1.0.97",
+	"version": "1.0.98",
 	"name": "xdbc",
 	"scripts": {
 		"docs": "typedoc",

package/src/DBC/HasAttribute.ts

@@ -109,6 +109,23 @@ export class HasAttribute extends DBC {
 	) {
 		return DBC.decInvariant([new HasAttribute(toCheckFor, invert)], path, dbc);
 	}
+	/**
+	 * A field-decorator factory using the {@link hasAttribute.checkAlgorithm } to determine whether this {@link DBC } is
+	 * fulfilled by the tagged field's class instance.
+	 *
+	 * @param toCheckFor	See {@link hasAttribute.checkAlgorithm }.
+	 * @param path			See {@link DBC.decInvariant }.
+	 * @param dbc			See {@link DBC.decInvariant }.
+	 *
+	 * @returns See {@link DBC.decInvariant }. */
+	public static cINVARIANT(
+		toCheckFor: any,
+		invert = false,
+		path: string | undefined = undefined,
+		dbc = "WaXCode.DBC",
+	) {
+		return DBC.decClassInvariant([new HasAttribute(toCheckFor, invert)], path, dbc);
+	}
 	// #endregion Condition checking.
 	// #region Referenced Condition checking.
 	//

package/src/DBC.ts

@@ -123,6 +123,89 @@ export class DBC {
 		return descriptor;
 	}
 	// #endregion Parameter-value requests.
+	// #region Class
+	/**
+	 * A property-decorator factory serving as a **D**esign **B**y **C**ontract Invariant.
+	 * This invariant aims to check the instance of the class not the value to be get or set.
+	 *
+	 * @param contracts The {@link DBC }-Contracts the value shall uphold.
+	 *
+	 * @throws 	A {@link DBC.Infringement } whenever the property is tried to be get or set without the instance of it's class
+	 * 			fulfilling the specified **contracts**. */
+	public static decClassInvariant(
+		contracts: Array<{
+			check: (toCheck: unknown | null | undefined) => boolean | string;
+		}>,
+		path: string | undefined = undefined,
+		dbc = "WaXCode.DBC",
+	) {
+		return (target: unknown, propertyKey: string | symbol, descriptor: PropertyDescriptor) => {
+			if (!DBC.resolveDBCPath(window, dbc).executionSettings.checkInvariants) {
+				return;
+			}
+			const originalSetter = descriptor.set;
+    		const originalGetter = descriptor.get;
+			// biome-ignore lint/suspicious/noExplicitAny: Necessary to intercept UNDEFINED and NULL.
+			let value: any;
+			// #region Replace original property.
+			Object.defineProperty(target, propertyKey, {
+				get() {
+					if (
+						!DBC.resolveDBCPath(window, dbc).executionSettings.checkInvariants
+					) {
+						return;
+					}
+
+					const realValue = path ? DBC.resolve(this, path) : this;
+					// #region Check if all "contracts" are fulfilled.
+					for (const contract of contracts) {
+						const result = contract.check(realValue);
+
+						if (typeof result === "string") {
+							DBC.resolveDBCPath(window, dbc).reportFieldInfringement(
+								result,
+								target as object,
+								path,
+								propertyKey as string,
+								realValue,
+							);
+						}
+					}
+					// #endregion Check if all "contracts" are fulfilled.
+					return originalGetter[ propertyKey ];
+				},
+				set(newValue) {
+					if (
+						!DBC.resolveDBCPath(window, dbc).executionSettings.checkInvariants
+					) {
+						return;
+					}
+
+					const realValue = path ? DBC.resolve(this, path) : this;
+					// #region Check if all "contracts" are fulfilled.
+					for (const contract of contracts) {
+						const result = contract.check(realValue);
+
+						if (typeof result === "string") {
+							DBC.resolveDBCPath(window, dbc).reportFieldInfringement(
+								result,
+								target as object,
+								path,
+								propertyKey as string,
+								realValue,
+							);
+						}
+					}
+					// #endregion Check if all "contracts" are fulfilled.
+					value = newValue;
+				},
+				enumerable: true,
+				configurable: true,
+			});
+			// #endregion Replace original property.
+		};
+	}
+	// #endregion Class
 	// #region Invariant
 	/**
 	 * A property-decorator factory serving as a **D**esign **B**y **C**ontract Invariant.