xdbc 1.0.116 → 1.0.118

package/dist/DBC/TYPE.js

@@ -76,6 +76,25 @@ export class TYPE extends DBC {
     check(toCheck) {
         return TYPE.checkAlgorithm(toCheck, this.type);
     }
+    /**
+     * Invokes the {@link TYPE.checkAlgorithm } passing the value **toCheck** and the {@link TYPE.type } .
+     *
+     * @param toCheck	See {@link INSTANCE.checkAlgorithm }.
+     * @param type		See {@link INSTANCE.checkAlgorithm }.
+     * @param id		A {@link string } identifying this {@link TYPE } via the {@link DBC.Infringement }-Message.
+     *
+     * @returns The **CANDIDATE** **toCheck** doesn't fulfill this {@link TYPE }.
+     *
+     * @throws A {@link DBC.Infringement } if the **CANDIDATE** **toCheck** does not fulfill this {@link DEFINED }. */
+    static tsCheck(toCheck, type, id = undefined) {
+        const result = TYPE.checkAlgorithm(toCheck, type);
+        if (result === true) {
+            return toCheck;
+        }
+        else {
+            throw new DBC.Infringement(`${id ? `(${id}) ` : ""}${result}`);
+        }
+    }
     /**
      * Creates this {@link TYPE } by setting the protected property {@link TYPE.type } used by {@link TYPE.check }.
      *

package/package.json

@@ -1,5 +1,5 @@
 {
-	"version": "1.0.116",
+	"version": "1.0.118",
 	"name": "xdbc",
 	"scripts": {
 		"docs": "typedoc",
@@ -31,7 +31,8 @@
 	"dependencies": {
 		"@types/reflect-metadata": "^0.1.0",
 		"parcel": "^2.14.4",
-		"reflect-metadata": "^0.2.2"
+		"reflect-metadata": "^0.2.2",
+		"zod": "^4.0.5"
 	},
 	"description": "A Typescript Design by Contract Framework",
 	"repository": {

package/src/DBC/DEFINED.ts

@@ -117,7 +117,7 @@ export class DEFINED extends DBC {
 	 * 
 	 * @throws A {@link DBC.Infringement } if the **CANDIDATE** **toCheck** does not fulfill this {@link DEFINED }.*/
 	public static tsCheck<CANDIDATE = unknown >( toCheck : CANDIDATE | undefined | null, id : string | undefined = undefined ) : CANDIDATE {
-		const result = DEFINED.checkAlgorithm(toCheck );
+		const result = DEFINED.checkAlgorithm(toCheck);
 
 		if( result === true ) {
 			return toCheck as CANDIDATE ;

package/src/DBC/INSTANCE.ts

@@ -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.
 	public static checkAlgorithm(toCheck: any, reference: any): boolean | string {
 		if (!(toCheck instanceof reference)) {

package/src/DBC/TYPE.ts

@@ -110,6 +110,26 @@ export class TYPE extends DBC {
 	public check(toCheck: any) {
 		return TYPE.checkAlgorithm(toCheck, this.type);
 	}
+	/**
+	 * Invokes the {@link TYPE.checkAlgorithm } passing the value **toCheck** and the {@link TYPE.type } .
+	 * 
+	 * @param toCheck	See {@link INSTANCE.checkAlgorithm }.
+	 * @param type		See {@link INSTANCE.checkAlgorithm }.
+	 * @param id		A {@link string } identifying this {@link TYPE } via the {@link DBC.Infringement }-Message.
+	 * 
+	 * @returns The **CANDIDATE** **toCheck** doesn't fulfill this {@link TYPE }.
+	 * 
+	 * @throws A {@link DBC.Infringement } if the **CANDIDATE** **toCheck** does not fulfill this {@link DEFINED }. */
+	public static tsCheck < CANDIDATE = unknown > ( toCheck : any, type : string, id : string | undefined = undefined ) : CANDIDATE {
+		const result = TYPE.checkAlgorithm(toCheck, type);
+
+		if( result === true ) {
+			return toCheck ;
+		}
+		else {
+			throw new DBC.Infringement( `${id?`(${id}) `:""}${result as string }`);
+		}
+	}
 	/**
 	 * Creates this {@link TYPE } by setting the protected property {@link TYPE.type } used by {@link TYPE.check }.
 	 *

package/src/DBC/ZOD.ts

@@ -0,0 +1,144 @@
+import { DBC } from "../DBC";
+import { z } from 'zod';
+/**
+ * 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.
+	public static checkAlgorithm(toCheck: any, schema: z.ZodType): boolean | string {
+		if (!schema.safeParse(toCheck).success) {
+			return `Value has to be an instance of "${schema}" 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 }. */
+	public static PRE(
+		// biome-ignore lint/suspicious/noExplicitAny: In order to perform an "instanceof" check.
+		schema: z.ZodType,
+		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 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 }. */
+	public static POST(
+		// biome-ignore lint/suspicious/noExplicitAny: In order to perform an "instanceof" check.
+		schema: z.ZodType,
+		path: string | undefined = undefined,
+		dbc = "WaXCode.DBC",
+	): (
+		target: object,
+		propertyKey: string,
+		descriptor: PropertyDescriptor,
+	) => PropertyDescriptor {
+		return DBC.decPostcondition(
+			(value: object, target: object, propertyKey: string) => {
+				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 }. */
+	public static INVARIANT(
+		// biome-ignore lint/suspicious/noExplicitAny: In order to perform an "instanceof" check.
+		schema: z.ZodType,
+		path: string | undefined = 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>
+	public check(toCheck: any) {
+		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 }. */
+	public static tsCheck < CANDIDATE = unknown > ( toCheck : any, schema : z.ZodType, id : string | undefined = undefined ) : CANDIDATE {
+		const result = ZOD.checkAlgorithm(toCheck, schema);
+
+		if( result === true ) {
+			return toCheck ;
+		}
+		else {
+			throw new DBC.Infringement( `${id?`(${id}) `:""}${result as string }`);
+		}
+	}
+	/**
+	 * 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>
+	public constructor(protected schema: z.ZodType) {
+		super();
+	}
+}