xdbc 1.0.119 → 1.0.121

package/dist/DBC/INSTANCE.js

@@ -6,13 +6,13 @@ import { DBC } from "../DBC";
  * Maintainer: Salvatore Callari (XDBC@WaXCode.net) */
 export class INSTANCE extends DBC {
     /**
-     * Checks if the value **toCheck** is complies to the {@link RegExp } **expression**.
+     * Checks if the value **toCheck** is an instance of the specified **reference**.
      *
-     * @param toCheck	The value that has comply to the {@link RegExp } **expression** for this {@link DBC } to be fulfilled.
-     * @param reference	The {@link RegExp } the one **toCheck** has comply to in order for this {@link DBC } to be
-     * 					fulfilled.
+     * @param toCheck	The value that has to be an instance of the **reference** in order for this {@link DBC }
+     * 					to be fulfilled.
+     * @param reference	The {@link object } the one **toCheck** has to be an instance of.
      *
-     * @returns TRUE if the value **toCheck** is of the specified **type**, otherwise FALSE. */
+     * @returns TRUE if the value **toCheck** is is an instance of the *reference**, otherwise FALSE. */
     // biome-ignore lint/suspicious/noExplicitAny: In order to perform an "instanceof" check.
     static checkAlgorithm(toCheck, reference) {
         if (!(toCheck instanceof reference)) {

package/dist/DBC/ZOD.js

@@ -0,0 +1,112 @@
+import { DBC } from "../DBC";
+/**
+ * A {@link DBC } defining that the an {@link object }s gotta be an instance of a certain {@link ZOD.schema }.
+ *
+ * @remarks
+ * Maintainer: Salvatore Callari (XDBC@WaXCode.net) */
+export class ZOD extends DBC {
+    /**
+     * Checks if the value **toCheck** complies to the specified {@link z.ZodType }.
+     *
+     * @param toCheck	The value that has to comply to the specified **schema** in order for this {@link DBC }
+     * @param schema	The {@link z.ZodType } the {@link object } **toCheck** has comply to in order for this {@link DBC } to be
+     * 					fulfilled.
+     *
+     * @returns TRUE if the value **toCheck** complies to the specified **schema**, otherwise FALSE. */
+    // biome-ignore lint/suspicious/noExplicitAny: In order to perform an "instanceof" check.
+    static checkAlgorithm(toCheck, schema) {
+        if (!schema.safeParse(toCheck).success) {
+            return `Value has to correspond to "${JSON.stringify(schema.def)}" but is of type "${typeof toCheck}"`;
+        }
+        return true;
+    }
+    /**
+     * A parameter-decorator factory using the {@link ZOD.checkAlgorithm } to determine whether this {@link DBC } is fulfilled
+     * by the tagged parameter.
+     *
+     * @param schema	See {@link ZOD.checkAlgorithm }.
+     * @param path		See {@link DBC.decPrecondition }.
+     * @param dbc		See {@link DBC.decPrecondition }.
+     *
+     * @returns See {@link DBC.decPrecondition }. */
+    static PRE(
+    // biome-ignore lint/suspicious/noExplicitAny: In order to perform an "instanceof" check.
+    schema, path = undefined, dbc = "WaXCode.DBC") {
+        return DBC.decPrecondition((value, target, methodName, parameterIndex) => {
+            return ZOD.checkAlgorithm(value, schema);
+        }, dbc, path);
+    }
+    /**
+     * A method-decorator factory using the {@link ZOD.checkAlgorithm } to determine whether this {@link DBC } is fulfilled
+     * by the tagged method's returnvalue.
+     *
+     * @param schema	See {@link ZOD.checkAlgorithm }.
+     * @param path	See {@link DBC.Postcondition }.
+     * @param dbc	See {@link DBC.decPostcondition }.
+     *
+     * @returns See {@link DBC.decPostcondition }. */
+    static POST(
+    // biome-ignore lint/suspicious/noExplicitAny: In order to perform an "instanceof" check.
+    schema, path = undefined, dbc = "WaXCode.DBC") {
+        return DBC.decPostcondition((value, target, propertyKey) => {
+            return ZOD.checkAlgorithm(value, schema);
+        }, dbc, path);
+    }
+    /**
+     * A field-decorator factory using the {@link ZOD.checkAlgorithm } to determine whether this {@link DBC } is fulfilled
+     * by the tagged method's returnvalue.
+     *
+     * @param schema	See {@link ZOD.checkAlgorithm }.
+     * @param path	See {@link DBC.decInvariant }.
+     * @param dbc	See {@link DBC.decInvariant }.
+     *
+     * @returns See {@link DBC.decInvariant }. */
+    static INVARIANT(
+    // biome-ignore lint/suspicious/noExplicitAny: In order to perform an "instanceof" check.
+    schema, path = undefined, dbc = "WaXCode.DBC") {
+        return DBC.decInvariant([new ZOD(schema)], path, dbc);
+    }
+    // #endregion Condition checking.
+    // #region Referenced Condition checking.
+    //
+    // For usage in dynamic scenarios (like with AE-DBC).
+    //
+    /**
+     * Invokes the {@link ZOD.checkAlgorithm } passing the value **toCheck** and the {@link ZOD.schema } .
+     *
+     * @param toCheck See {@link ZOD.checkAlgorithm }.
+     *
+     * @returns See {@link ZOD.checkAlgorithm}. */
+    // biome-ignore lint/suspicious/noExplicitAny: <explanation>
+    check(toCheck) {
+        return ZOD.checkAlgorithm(toCheck, this.schema);
+    }
+    /**
+     * Invokes the {@link ZOD.checkAlgorithm } passing the value **toCheck** and the {@link ZOD.schema } .
+     *
+     * @param toCheck 	See {@link ZOD.checkAlgorithm }.
+     * @param schema	See {@link ZOD.checkAlgorithm }.
+     * @param id		A {@link string } identifying this {@link ZOD } via the {@link DBC.Infringement }-Message.
+     *
+     * @returns The **CANDIDATE** **toCheck** doesn't fulfill this {@link ZOD }.
+     *
+     * @throws A {@link DBC.Infringement } if the **CANDIDATE** **toCheck** does not fulfill this {@link DEFINED }. */
+    static tsCheck(toCheck, schema, id = undefined) {
+        const result = ZOD.checkAlgorithm(toCheck, schema);
+        if (result === true) {
+            return toCheck;
+        }
+        else {
+            throw new DBC.Infringement(`${id ? `(${id}) ` : ""}${result}`);
+        }
+    }
+    /**
+     * Creates this {@link ZOD } by setting the protected property {@link ZOD.schema } used by {@link ZOD.check }.
+     *
+     * @param schema See {@link ZOD.check }. */
+    // biome-ignore lint/suspicious/noExplicitAny: <explanation>
+    constructor(schema) {
+        super();
+        this.schema = schema;
+    }
+}

package/package.json

@@ -1,5 +1,5 @@
 {
-	"version": "1.0.119",
+	"version": "1.0.121",
 	"name": "xdbc",
 	"scripts": {
 		"docs": "typedoc",

package/src/DBC/ZOD.ts

@@ -17,7 +17,8 @@ export class ZOD extends DBC {
 	// biome-ignore lint/suspicious/noExplicitAny: In order to perform an "instanceof" check.
 	public static checkAlgorithm(toCheck: any, schema: z.ZodType): boolean | string {
 		if (!schema.safeParse(toCheck).success) {
-			return `Value has to correspond to "${schema.toString()}" but is of type "${typeof toCheck}"`;
+			console.log(schema)
+			return `Value has to correspond to "${JSON.stringify(schema.def)}" but is of type "${typeof toCheck}"`;
 		}
 
 		return true;