@oscarpalmer/jhunal 0.21.0 → 0.22.0

package/src/models/validation.model.ts

@@ -4,11 +4,18 @@ import {NAME_ERROR_SCHEMATIC, NAME_ERROR_VALIDATION} from '../constants';
 import type {Schematic} from '../schematic';
 import type {ValueName} from './misc.model';
 
+// #region Named validation
+
+export type NamedValidatorHandlers = {
+	[Key in ValueName]?: Array<(value: unknown) => boolean>;
+};
+
+export type NamedValidators = Record<ValueName, (value: unknown) => boolean>;
+
+// #endregion
+
 // #region Reporting
 
-/**
- * Maps each {@link ReportingType} to a boolean flag
- */
 export type ReportingInformation = Record<ReportingType, boolean> & {
 	type: ReportingType;
 };
@@ -16,16 +23,16 @@ export type ReportingInformation = Record<ReportingType, boolean> & {
 /**
  * Controls how validation failures are reported
  *
- * - `'none'` — returns a boolean _(default)_
- * - `'first'` — returns the first failure as a `Result`
- * - `'all'` — returns all failures as a `Result` _(from same level)_
- * - `'throw'` — throws a {@link ValidationError} on failure
+ * - `'none'`, returns a boolean _(default)_
+ * - `'first'`, returns the first failure as a `Result`
+ * - `'all'`, returns all failures as a `Result` _(from same level)_
+ * - `'throw'`, throws a {@link ValidationError} on failure
  */
 export type ReportingType = 'all' | 'first' | 'none' | 'throw';
 
 // #endregion
 
-// #region Schematic validation
+// #region Errors
 
 /**
  * Thrown when a schema definition is invalid
@@ -38,66 +45,6 @@ export class SchematicError extends Error {
 	}
 }
 
-// #endregion
-
-// #region Validated property
-
-/**
- * The runtime representation of a parsed schema property, used internally during validation
- *
- * @example
- * ```ts
- * const parsed: ValidatedProperty = {
- *   key: 'age',
- *   required: true,
- *   types: ['number'],
- *   validators: { number: [(v) => v > 0] },
- * };
- * ```
- */
-export type ValidatedProperty = {
-	/**
-	 * The property name in the schema
-	 */
-	key: string;
-	/**
-	 * Whether the property is required
-	 */
-	required: boolean;
-	/**
-	 * The allowed types for this property
-	 */
-	types: ValidatedPropertyType[];
-	/**
-	 * Custom validators grouped by {@link ValueName}
-	 */
-	validators: ValidatedPropertyValidators;
-};
-
-/**
- * A union of valid types for a {@link ValidatedProperty}'s `types` array
- *
- * Can be a callback _(custom validator)_, a {@link Schematic}, a nested {@link ValidatedProperty}, or a {@link ValueName} string
- */
-export type ValidatedPropertyType =
-	| GenericCallback
-	| ValidatedProperty[]
-	| Schematic<unknown>
-	| ValueName;
-
-/**
- * A map of validator functions keyed by {@link ValueName}, used at runtime in {@link ValidatedProperty}
- *
- * Each key holds an array of validator functions that receive an `unknown` value and return a `boolean`
- */
-export type ValidatedPropertyValidators = {
-	[Key in ValueName]?: Array<(value: unknown) => boolean>;
-};
-
-// #endregion
-
-// #region Property validation
-
 /**
  * Thrown in `'throw'` mode when one or more properties fail validation; `information` holds all failures
  */
@@ -114,6 +61,10 @@ export class ValidationError extends Error {
 	}
 }
 
+// #endregion
+
+// #region Results
+
 /**
  * Describes a single validation failure
  */
@@ -129,13 +80,17 @@ export type ValidationInformation = {
 };
 
 /**
- * 
+ *
  */
 export type ValidationInformationKey = {
 	full: string;
 	short: string;
 };
 
+// #endregion
+
+// #region Options
+
 /**
  * Options for validation
  */
@@ -150,13 +105,23 @@ export type ValidationOptions<Errors extends ReportingType> = {
 	strict?: boolean;
 };
 
-export type ValidationParameters = {
+// #endregion
+
+// #region Validator
+
+export type Validator = (
+	input: unknown,
+	parameters: ValidatorParameters,
+	get: boolean,
+) => boolean | ValidationInformation[];
+
+export type ValidatorParameters = {
 	information?: ValidationInformation[];
-	origin?: ValidatedProperty;
 	output: PlainObject;
-	prefix?: string;
 	reporting: ReportingInformation;
 	strict: boolean;
 };
 
+export type ValidatorType = Function | PlainObject | Schematic<unknown> | ValueName;
+
 // #endregion

package/src/schematic.ts

@@ -9,12 +9,11 @@ import type {Schema} from './models/schema.plain.model';
 import type {TypedSchema} from './models/schema.typed.model';
 import {
 	SchematicError,
-	type ValidatedProperty,
 	type ValidationInformation,
 	type ValidationOptions,
+	type Validator,
 } from './models/validation.model';
-import {getProperties} from './validation/property.validation';
-import {validateObject} from './validation/value.validation';
+import {getObjectValidator} from './validation';
 
 /**
  * A schematic for validating objects
@@ -22,16 +21,16 @@ import {validateObject} from './validation/value.validation';
 export class Schematic<Model> {
 	declare private readonly $schematic: true;
 
-	#properties: ValidatedProperty[];
+	#validator: Validator;
 
-	constructor(properties: ValidatedProperty[]) {
+	constructor(validator: Validator) {
 		Object.defineProperty(this, PROPERTY_SCHEMATIC, {
 			value: true,
 		});
 
-		this.#properties = properties;
+		this.#validator = validator;
 
-		schematicProperties.set(this, properties);
+		schematicValidator.set(this, validator);
 	}
 
 	/**
@@ -107,14 +106,14 @@ export class Schematic<Model> {
 	get(value: unknown, options?: unknown): unknown {
 		const parameters = getParameters(options);
 
-		const result = validateObject(value, this.#properties, parameters, true);
+		const result = this.#validator(value, parameters, true);
 
-		if (result == null) {
-			return;
-		}
-
-		if (!Array.isArray(result)) {
-			return parameters.reporting.none ? result : ok(result);
+		if (typeof result === 'boolean') {
+			return parameters.reporting.none
+				? result
+					? parameters.output
+					: undefined
+				: ok(parameters.output);
 		}
 
 		return error(parameters.reporting.all ? result : result[0]);
@@ -193,14 +192,10 @@ export class Schematic<Model> {
 	is(value: unknown, options?: unknown): unknown {
 		const parameters = getParameters(options);
 
-		const result = validateObject(value, this.#properties, parameters, false);
+		const result = this.#validator(value, parameters, false);
 
-		if (result == null) {
-			return false;
-		}
-
-		if (!Array.isArray(result)) {
-			return parameters.reporting.none ? true : ok(true);
+		if (typeof result === 'boolean') {
+			return parameters.reporting.none ? result : ok(result);
 		}
 
 		return error(parameters.reporting.all ? result : result[0]);
@@ -234,7 +229,7 @@ export function schematic<Model extends Schema>(schema: Model): Schematic<Model>
 		throw new SchematicError(SCHEMATIC_MESSAGE_SCHEMA_INVALID_TYPE);
 	}
 
-	return new Schematic<Model>(getProperties(schema));
+	return new Schematic<Model>(getObjectValidator(schema));
 }
 
-export const schematicProperties = new WeakMap<Schematic<unknown>, ValidatedProperty[]>();
+export const schematicValidator = new WeakMap<Schematic<unknown>, Validator>();