valia/src/schema/services/types.ts

A runtime data validator in TypeScript with advanced type inference, built-in validation functions, and seamless integration for server and client environments.

import type { SetableCriteria, MountedCriteria } from "../formats";
import type { RegistryValue } from "../managers";

export interface MountingTask {
	prevNode: SetableCriteria | MountedCriteria | null;
	prevPath: RegistryValue['partPaths'];
	currNode: SetableCriteria | MountedCriteria;
	partPath: RegistryValue['partPaths'];
}

/**
 * @template U Custom members you want to add to the object.
 */
export type CheckingTaskHooks<U extends Record<string, any> = { [key: string]: any; }> = {
	/**
	 * Criteria responsible for managing the hooks. 
	 * This information will be included in the rejection reasons 
	 * if a hook returns a rejection code.
	 */
	owner: {
		node: MountedCriteria;
		path: RegistryValue['partPaths'];
	}
	/**
	 * Hook executed just before the verification process.
	 * - Returns `true`: Proceeds with the verification.
	 * - Returns `false`: Cancels the verification.
	 * - Returns a rejection code: Terminates the entire verification process.
	 */
	beforeCheck(criteria: MountedCriteria): boolean | string;
	/**
	 * Hook executed immediately after the verification process.
	 * - Returns `true`: Proceed to the other verification.
	 * - Returns `false`: Bypasses the rejection.
	 * - Returns a rejection code: Terminates the entire verification process.
	 */
	afterCheck(criteria: MountedCriteria, reject: string | null): boolean | string;
} & U;

export type CheckingTask = {
	prevPath: RegistryValue['partPaths'];
	currNode: MountedCriteria;
	value: unknown;
	hooks?: CheckingTaskHooks;
}

export interface Rejection {
	path: RegistryValue['partPaths'];
	/**
	 * Error code structured as `<CATEGORY>_<DETAIL>`, where `<CATEGORY>` can be:
	 * 
	 * - `TYPE`: Indicates an error related to a data type (e.g., `TYPE_NOT_STRING`).
	 * - `VALUE`: Indicates an error related to the provided value (e.g., `VALUE_MISSING_KEY`).
	 * - `TEST`: Indicates an error related to a specific test or validation (e.g., `TEST_REGEX_FAILED`).
	 * 
	 * `<DETAIL>`: A specific description of the error, such as `NOT_STRING`, `MISSING_KEY`, etc.
	 */
	code: string;
	type: string;
	label: string | undefined;
	message: string | undefined;
}