@oscarpalmer/jhunal 0.18.0 → 0.19.0

package/dist/index.d.mts

@@ -1,4 +1,5 @@
 import { Constructor, GenericCallback, PlainObject, Simplify } from "@oscarpalmer/atoms/models";
+import { Result } from "@oscarpalmer/atoms/result/models";
 
 //#region src/models/infer.model.d.ts
 /**
@@ -273,6 +274,7 @@ type ValidationInformation = {
   key: ValidationInformationKey;
   message: string;
   validator?: GenericCallback;
+  value: unknown;
 };
 type ValidationInformationKey = ValidatedPropertyKey;
 //#endregion
@@ -293,6 +295,24 @@ declare class Schematic<Model> {
    * @returns `true` if the value matches the schema, otherwise throws an error
    */
   is(value: unknown, errors: 'throw'): asserts value is Model;
+  /**
+   * Does the value match the schema?
+   *
+   * Will validate that the value matches the schema and return a result of `true` or all validation information for validation failures from the same depth in the object.
+   * @param value Value to validate
+   * @param errors All
+   * @returns `true` if the value matches the schema, otherwise `false`
+   */
+  is(value: unknown, errors: 'all'): Result<true, ValidationInformation[]>;
+  /**
+   * Does the value match the schema?
+   *
+   * Will validate that the value matches the schema and return a result of `true` or all validation information for the failing property.
+   * @param value Value to validate
+   * @param errors First
+   * @returns `true` if the value matches the schema, otherwise `false`
+   */
+  is(value: unknown, errors: 'first'): Result<true, ValidationInformation>;
   /**
    * Does the value match the schema?
    *

package/dist/index.mjs

@@ -1,5 +1,6 @@
 import { isConstructor, isPlainObject } from "@oscarpalmer/atoms/is";
 import { join } from "@oscarpalmer/atoms/string";
+import { error } from "@oscarpalmer/atoms/result/misc";
 //#region src/constants.ts
 const MESSAGE_CONSTRUCTOR = "Expected a constructor function";
 const NAME_SCHEMATIC = "Schematic";
@@ -258,6 +259,7 @@ function validateNamed(property, name, value, validation) {
 		const validator = propertyValidators[index];
 		if (!validator(value)) {
 			validation.push({
+				value,
 				key: { ...property.key },
 				message: getInvalidValidatorMessage(property, name, index, length),
 				validator
@@ -267,17 +269,20 @@ function validateNamed(property, name, value, validation) {
 	}
 	return true;
 }
-function validateObject(obj, properties, reporting, validation) {
+function validateObject(obj, properties, reporting, property, validation) {
 	if (!isPlainObject(obj)) {
-		if (reporting.throw && validation == null) throw new ValidationError([{
+		const information = {
 			key: {
 				full: "",
 				short: ""
 			},
-			message: getInvalidInputMessage(obj)
-		}]);
-		return false;
+			message: property == null ? getInvalidInputMessage(obj) : getInvalidTypeMessage(property, obj),
+			value: obj
+		};
+		if (reporting.throw) throw new ValidationError([information]);
+		return reporting.none ? false : [information];
 	}
+	const allInformation = [];
 	const propertiesLength = properties.length;
 	outer: for (let propertyIndex = 0; propertyIndex < propertiesLength; propertyIndex += 1) {
 		const property = properties[propertyIndex];
@@ -285,12 +290,17 @@ function validateObject(obj, properties, reporting, validation) {
 		const value = obj[key.short];
 		if (value === void 0 && required) {
 			const information = {
+				value,
 				key: { ...key },
 				message: getInvalidMissingMessage(property)
 			};
 			if (reporting.throw && validation == null) throw new ValidationError([information]);
 			if (validation != null) validation.push(information);
-			return false;
+			if (reporting.all) {
+				allInformation.push(information);
+				continue;
+			}
+			return reporting.none ? false : [information];
 		}
 		const typesLength = types.length;
 		const information = [];
@@ -298,32 +308,31 @@ function validateObject(obj, properties, reporting, validation) {
 			const type = types[typeIndex];
 			if (validateValue(type, property, value, reporting, information)) continue outer;
 		}
-		if (reporting.throw && validation == null) throw new ValidationError(information.length === 0 ? [{
+		if (information.length === 0) information.push({
+			value,
 			key: { ...key },
 			message: getInvalidTypeMessage(property, value)
-		}] : information);
+		});
+		if (reporting.throw && validation == null) throw new ValidationError(information);
 		validation?.push(...information);
-		return false;
+		if (reporting.all) {
+			allInformation.push(...information);
+			continue;
+		}
+		return reporting.none ? false : information;
 	}
-	return true;
+	return reporting.none ? true : allInformation.length === 0 ? true : allInformation;
 }
 function validateValue(type, property, value, reporting, validation) {
-	let result;
 	switch (true) {
-		case typeof type === "function":
-			result = type(value);
-			break;
-		case Array.isArray(type):
-			result = validateObject(value, type, reporting, validation);
-			break;
-		case isSchematic(type):
-			result = type.is(value, reporting);
-			break;
-		default:
-			result = validateNamed(property, type, value, validation);
-			break;
+		case typeof type === "function": return type(value);
+		case Array.isArray(type): {
+			const nested = validateObject(value, type, reporting, property, validation);
+			return typeof nested !== "boolean" ? false : nested;
+		}
+		case isSchematic(type): return type.is(value, reporting);
+		default: return validateNamed(property, type, value, validation);
 	}
-	return result;
 }
 const validators = {
 	array: Array.isArray,
@@ -350,7 +359,10 @@ var Schematic = class {
 		this.#properties = properties;
 	}
 	is(value, errors) {
-		return validateObject(value, this.#properties, getReporting(errors));
+		const reporting = getReporting(errors);
+		const result = validateObject(value, this.#properties, reporting);
+		if (typeof result === "boolean") return result;
+		return error(reporting.all ? result : result[0]);
 	}
 };
 function schematic(schema) {

package/dist/models/validation.model.d.mts

@@ -75,6 +75,7 @@ type ValidationInformation = {
   key: ValidationInformationKey;
   message: string;
   validator?: GenericCallback;
+  value: unknown;
 };
 type ValidationInformationKey = ValidatedPropertyKey;
 //#endregion

package/dist/schematic.d.mts

@@ -1,8 +1,9 @@
 import { Infer } from "./models/infer.model.mjs";
 import { TypedSchema } from "./models/schema.typed.model.mjs";
-import { ValidatedProperty } from "./models/validation.model.mjs";
+import { ValidatedProperty, ValidationInformation } from "./models/validation.model.mjs";
 import { Schema } from "./models/schema.plain.model.mjs";
 import { PlainObject } from "@oscarpalmer/atoms/models";
+import { Result } from "@oscarpalmer/atoms/result/models";
 
 //#region src/schematic.d.ts
 /**
@@ -21,6 +22,24 @@ declare class Schematic<Model> {
    * @returns `true` if the value matches the schema, otherwise throws an error
    */
   is(value: unknown, errors: 'throw'): asserts value is Model;
+  /**
+   * Does the value match the schema?
+   *
+   * Will validate that the value matches the schema and return a result of `true` or all validation information for validation failures from the same depth in the object.
+   * @param value Value to validate
+   * @param errors All
+   * @returns `true` if the value matches the schema, otherwise `false`
+   */
+  is(value: unknown, errors: 'all'): Result<true, ValidationInformation[]>;
+  /**
+   * Does the value match the schema?
+   *
+   * Will validate that the value matches the schema and return a result of `true` or all validation information for the failing property.
+   * @param value Value to validate
+   * @param errors First
+   * @returns `true` if the value matches the schema, otherwise `false`
+   */
+  is(value: unknown, errors: 'first'): Result<true, ValidationInformation>;
   /**
    * Does the value match the schema?
    *

package/dist/schematic.mjs

@@ -4,6 +4,7 @@ import { SchematicError } from "./models/validation.model.mjs";
 import { getProperties } from "./validation/property.validation.mjs";
 import { validateObject } from "./validation/value.validation.mjs";
 import { isPlainObject } from "@oscarpalmer/atoms/is";
+import { error } from "@oscarpalmer/atoms/result/misc";
 //#region src/schematic.ts
 /**
 * A schematic for validating objects
@@ -15,7 +16,10 @@ var Schematic = class {
 		this.#properties = properties;
 	}
 	is(value, errors) {
-		return validateObject(value, this.#properties, getReporting(errors));
+		const reporting = getReporting(errors);
+		const result = validateObject(value, this.#properties, reporting);
+		if (typeof result === "boolean") return result;
+		return error(reporting.all ? result : result[0]);
 	}
 };
 function schematic(schema) {

package/dist/validation/value.validation.d.mts

@@ -1,6 +1,6 @@
 import { ReportingInformation, ValidatedProperty, ValidationInformation } from "../models/validation.model.mjs";
 
 //#region src/validation/value.validation.d.ts
-declare function validateObject(obj: unknown, properties: ValidatedProperty[], reporting: ReportingInformation, validation?: ValidationInformation[]): boolean;
+declare function validateObject(obj: unknown, properties: ValidatedProperty[], reporting: ReportingInformation, property?: ValidatedProperty, validation?: ValidationInformation[]): boolean | ValidationInformation[];
 //#endregion
 export { validateObject };

package/dist/validation/value.validation.mjs

@@ -1,3 +1,4 @@
+import "../constants.mjs";
 import { getInvalidInputMessage, getInvalidMissingMessage, getInvalidTypeMessage, getInvalidValidatorMessage, isSchematic } from "../helpers.mjs";
 import { ValidationError } from "../models/validation.model.mjs";
 import { isPlainObject } from "@oscarpalmer/atoms/is";
@@ -11,6 +12,7 @@ function validateNamed(property, name, value, validation) {
 		const validator = propertyValidators[index];
 		if (!validator(value)) {
 			validation.push({
+				value,
 				key: { ...property.key },
 				message: getInvalidValidatorMessage(property, name, index, length),
 				validator
@@ -20,17 +22,20 @@ function validateNamed(property, name, value, validation) {
 	}
 	return true;
 }
-function validateObject(obj, properties, reporting, validation) {
+function validateObject(obj, properties, reporting, property, validation) {
 	if (!isPlainObject(obj)) {
-		if (reporting.throw && validation == null) throw new ValidationError([{
+		const information = {
 			key: {
 				full: "",
 				short: ""
 			},
-			message: getInvalidInputMessage(obj)
-		}]);
-		return false;
+			message: property == null ? getInvalidInputMessage(obj) : getInvalidTypeMessage(property, obj),
+			value: obj
+		};
+		if (reporting.throw) throw new ValidationError([information]);
+		return reporting.none ? false : [information];
 	}
+	const allInformation = [];
 	const propertiesLength = properties.length;
 	outer: for (let propertyIndex = 0; propertyIndex < propertiesLength; propertyIndex += 1) {
 		const property = properties[propertyIndex];
@@ -38,12 +43,17 @@ function validateObject(obj, properties, reporting, validation) {
 		const value = obj[key.short];
 		if (value === void 0 && required) {
 			const information = {
+				value,
 				key: { ...key },
 				message: getInvalidMissingMessage(property)
 			};
 			if (reporting.throw && validation == null) throw new ValidationError([information]);
 			if (validation != null) validation.push(information);
-			return false;
+			if (reporting.all) {
+				allInformation.push(information);
+				continue;
+			}
+			return reporting.none ? false : [information];
 		}
 		const typesLength = types.length;
 		const information = [];
@@ -51,32 +61,31 @@ function validateObject(obj, properties, reporting, validation) {
 			const type = types[typeIndex];
 			if (validateValue(type, property, value, reporting, information)) continue outer;
 		}
-		if (reporting.throw && validation == null) throw new ValidationError(information.length === 0 ? [{
+		if (information.length === 0) information.push({
+			value,
 			key: { ...key },
 			message: getInvalidTypeMessage(property, value)
-		}] : information);
+		});
+		if (reporting.throw && validation == null) throw new ValidationError(information);
 		validation?.push(...information);
-		return false;
+		if (reporting.all) {
+			allInformation.push(...information);
+			continue;
+		}
+		return reporting.none ? false : information;
 	}
-	return true;
+	return reporting.none ? true : allInformation.length === 0 ? true : allInformation;
 }
 function validateValue(type, property, value, reporting, validation) {
-	let result;
 	switch (true) {
-		case typeof type === "function":
-			result = type(value);
-			break;
-		case Array.isArray(type):
-			result = validateObject(value, type, reporting, validation);
-			break;
-		case isSchematic(type):
-			result = type.is(value, reporting);
-			break;
-		default:
-			result = validateNamed(property, type, value, validation);
-			break;
+		case typeof type === "function": return type(value);
+		case Array.isArray(type): {
+			const nested = validateObject(value, type, reporting, property, validation);
+			return typeof nested !== "boolean" ? false : nested;
+		}
+		case isSchematic(type): return type.is(value, reporting);
+		default: return validateNamed(property, type, value, validation);
 	}
-	return result;
 }
 const validators = {
 	array: Array.isArray,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@oscarpalmer/jhunal",
-  "version": "0.18.0",
+  "version": "0.19.0",
   "description": "Flies free beneath the glistening moons…",
   "keywords": [
     "schema",

package/src/models/validation.model.ts

@@ -116,6 +116,7 @@ export type ValidationInformation = {
 	key: ValidationInformationKey;
 	message: string;
 	validator?: GenericCallback;
+	value: unknown;
 };
 
 export type ValidationInformationKey = ValidatedPropertyKey;

package/src/schematic.ts

@@ -1,13 +1,19 @@
 import {isPlainObject} from '@oscarpalmer/atoms/is';
 import type {PlainObject} from '@oscarpalmer/atoms/models';
-import {SCHEMATIC_MESSAGE_SCHEMA_INVALID_TYPE, PROPERTY_SCHEMATIC} from './constants';
+import type {Result} from '@oscarpalmer/atoms/result/models';
+import {PROPERTY_SCHEMATIC, SCHEMATIC_MESSAGE_SCHEMA_INVALID_TYPE} from './constants';
 import {getReporting, isSchematic} from './helpers';
 import type {Infer} from './models/infer.model';
 import type {Schema} from './models/schema.plain.model';
 import type {TypedSchema} from './models/schema.typed.model';
-import {SchematicError, type ValidatedProperty} from './models/validation.model';
+import {
+	SchematicError,
+	type ValidatedProperty,
+	type ValidationInformation,
+} from './models/validation.model';
 import {getProperties} from './validation/property.validation';
 import {validateObject} from './validation/value.validation';
+import {error} from '@oscarpalmer/atoms/result/misc';
 
 /**
  * A schematic for validating objects
@@ -27,7 +33,7 @@ export class Schematic<Model> {
 
 	/**
 	 * Does the value match the schema?
-	 * 
+	 *
 	 * Will assert that the values matches the schema and throw an error if it does not. The error will contain all validation information for the first property that fails validation.
 	 * @param value Value to validate
 	 * @param errors Throws an error for the first validation failure
@@ -37,15 +43,43 @@ export class Schematic<Model> {
 
 	/**
 	 * Does the value match the schema?
-	 * 
+	 *
+	 * Will validate that the value matches the schema and return a result of `true` or all validation information for validation failures from the same depth in the object.
+	 * @param value Value to validate
+	 * @param errors All
+	 * @returns `true` if the value matches the schema, otherwise `false`
+	 */
+	is(value: unknown, errors: 'all'): Result<true, ValidationInformation[]>;
+
+	/**
+	 * Does the value match the schema?
+	 *
+	 * Will validate that the value matches the schema and return a result of `true` or all validation information for the failing property.
+	 * @param value Value to validate
+	 * @param errors First
+	 * @returns `true` if the value matches the schema, otherwise `false`
+	 */
+	is(value: unknown, errors: 'first'): Result<true, ValidationInformation>;
+
+	/**
+	 * Does the value match the schema?
+	 *
 	 * Will validate that the value matches the schema and return `true` or `false`, without any validation information for validation failures.
 	 * @param value Value to validate
 	 * @returns `true` if the value matches the schema, otherwise `false`
 	 */
 	is(value: unknown): value is Model;
 
-	is(value: unknown, errors?: unknown): boolean {
-		return validateObject(value, this.#properties, getReporting(errors));
+	is(value: unknown, errors?: unknown): unknown {
+		const reporting = getReporting(errors);
+
+		const result = validateObject(value, this.#properties, reporting);
+
+		if (typeof result === 'boolean') {
+			return result;
+		}
+
+		return error(reporting.all ? result : result[0]);
 	}
 }
 

package/src/validation/value.validation.ts

@@ -1,5 +1,6 @@
 import {isPlainObject} from '@oscarpalmer/atoms/is';
 import type {GenericCallback} from '@oscarpalmer/atoms/models';
+import {TYPE_OBJECT} from '../constants';
 import {
 	getInvalidInputMessage,
 	getInvalidMissingMessage,
@@ -39,6 +40,7 @@ function validateNamed(
 
 		if (!validator(value)) {
 			validation.push({
+				value,
 				key: {...property.key},
 				message: getInvalidValidatorMessage(property, name, index, length),
 				validator: validator as GenericCallback,
@@ -55,21 +57,26 @@ export function validateObject(
 	obj: unknown,
 	properties: ValidatedProperty[],
 	reporting: ReportingInformation,
+	property?: ValidatedProperty,
 	validation?: ValidationInformation[],
-): boolean {
+): boolean | ValidationInformation[] {
 	if (!isPlainObject(obj)) {
-		if (reporting.throw && validation == null) {
-			throw new ValidationError([
-				{
-					key: {full: '', short: ''},
-					message: getInvalidInputMessage(obj),
-				},
-			]);
+		const information = {
+			key: {full: '', short: ''},
+			message:
+				property == null ? getInvalidInputMessage(obj) : getInvalidTypeMessage(property, obj),
+			value: obj,
+		};
+
+		if (reporting.throw) {
+			throw new ValidationError([information]);
 		}
 
-		return false;
+		return reporting.none ? false : [information];
 	}
 
+	const allInformation: ValidationInformation[] = [];
+
 	const propertiesLength = properties.length;
 
 	outer: for (let propertyIndex = 0; propertyIndex < propertiesLength; propertyIndex += 1) {
@@ -81,6 +88,7 @@ export function validateObject(
 
 		if (value === undefined && required) {
 			const information: ValidationInformation = {
+				value,
 				key: {...key},
 				message: getInvalidMissingMessage(property),
 			};
@@ -93,7 +101,13 @@ export function validateObject(
 				validation.push(information);
 			}
 
-			return false;
+			if (reporting.all) {
+				allInformation.push(information);
+
+				continue;
+			}
+
+			return reporting.none ? false : [information];
 		}
 
 		const typesLength = types.length;
@@ -108,25 +122,30 @@ export function validateObject(
 			}
 		}
 
+		if (information.length === 0) {
+			information.push({
+				value,
+				key: {...key},
+				message: getInvalidTypeMessage(property, value),
+			});
+		}
+
 		if (reporting.throw && validation == null) {
-			throw new ValidationError(
-				information.length === 0
-					? [
-							{
-								key: {...key},
-								message: getInvalidTypeMessage(property, value),
-							},
-						]
-					: information,
-			);
+			throw new ValidationError(information);
 		}
 
 		validation?.push(...information);
 
-		return false;
+		if (reporting.all) {
+			allInformation.push(...information);
+
+			continue;
+		}
+
+		return reporting.none ? false : information;
 	}
 
-	return true;
+	return reporting.none ? true : allInformation.length === 0 ? true : allInformation;
 }
 
 function validateValue(
@@ -136,27 +155,21 @@ function validateValue(
 	reporting: ReportingInformation,
 	validation: ValidationInformation[],
 ): boolean {
-	let result: boolean;
-
 	switch (true) {
 		case typeof type === 'function':
-			result = (type as GenericCallback)(value);
-			break;
+			return (type as GenericCallback)(value);
 
-		case Array.isArray(type):
-			result = validateObject(value, type, reporting, validation);
-			break;
+		case Array.isArray(type): {
+			const nested = validateObject(value, type, reporting, property, validation);
+			return typeof nested !== 'boolean' ? false : nested;
+		}
 
 		case isSchematic(type):
-			result = type.is(value, reporting as never) as unknown as boolean;
-			break;
+			return type.is(value, reporting as never) as unknown as boolean;
 
 		default:
-			result = validateNamed(property, type as ValueName, value, validation);
-			break;
+			return validateNamed(property, type as ValueName, value, validation);
 	}
-
-	return result;
 }
 
 //
@@ -169,7 +182,7 @@ const validators: Record<ValueName, (value: unknown) => boolean> = {
 	function: value => typeof value === 'function',
 	null: value => value === null,
 	number: value => typeof value === 'number',
-	object: value => typeof value === 'object' && value !== null,
+	object: value => typeof value === TYPE_OBJECT && value !== null,
 	string: value => typeof value === 'string',
 	symbol: value => typeof value === 'symbol',
 	undefined: value => value === undefined,