@oscarpalmer/jhunal 0.25.0 → 0.26.0

package/dist/index.d.mts

@@ -461,7 +461,7 @@ declare class Schema<Model> {
    * @param options Validation options
    * @returns Deeply cloned value, or `undefined` if it's invalid
    */
-  get(value: unknown, options: GetOptions<'none'>): Model | undefined;
+  get(value: unknown, options: Partial<GetOptions<'none'>>): Model | undefined;
   /**
    * Parse a value according to the schema
    *
@@ -533,7 +533,7 @@ declare class Schema<Model> {
    * @param options Validation options
    * @returns `true` if the value matches the schema, otherwise `false`
    */
-  is(value: unknown, options: IsOptions<'none'>): value is Model;
+  is(value: unknown, options: Partial<IsOptions<'none'>>): value is Model;
   /**
    * Does the value match the schema?
    *

package/dist/index.mjs

@@ -319,7 +319,7 @@ const namedValidators = {
 	undefined: (value) => value === void 0
 };
 //#endregion
-//#region src/validator/schematic.validator.ts
+//#region src/validator/schema.validator.ts
 function getSchemaValidator(schematic) {
 	const validator = schemaValidators.get(schematic);
 	return (input, parameters, get) => {
@@ -357,8 +357,8 @@ function getObjectValidator(original, origin, fromType) {
 	for (let keyIndex = 0; keyIndex < keysLength; keyIndex += 1) {
 		const key = keys[keyIndex];
 		const value = original[key];
-		if (value == null) throw new SchematicError(getSchematicPropertyNullableMessage(join([origin?.full, key], ".")));
 		const prefixedKey = origin == null ? key : join([origin.full, key], ".");
+		if (value == null) throw new SchematicError(getSchematicPropertyNullableMessage(prefixedKey));
 		const fullKey = {
 			full: prefixedKey,
 			short: key
@@ -414,20 +414,18 @@ function getObjectValidator(original, origin, fromType) {
 	}
 	const validatorsLength = items.length;
 	return (input, parameters, get) => {
-		if (!isPlainObject(input)) {
-			if (origin != null) return [];
-			const information = {
-				key: {
-					full: "",
-					short: ""
-				},
-				value: input,
-				message: getInputTypeMessage(input)
-			};
-			if (parameters.reporting.throw) throw new ValidationError([information]);
-			parameters.information?.push(information);
-			return [information];
-		}
+		if (!isPlainObject(input)) return origin == null ? report({
+			key: {
+				full: "",
+				short: ""
+			},
+			message: {
+				arguments: [input],
+				callback: getInputTypeMessage
+			},
+			original: parameters,
+			value: input
+		}, true) : [];
 		if (parameters.strict) {
 			const unknownKeys = Object.keys(input).filter((key) => !set.has(key));
 			if (unknownKeys.length > 0) {
@@ -444,6 +442,7 @@ function getObjectValidator(original, origin, fromType) {
 				return [information];
 			}
 		}
+		const getAndClone = get && parameters.clone;
 		const allInformation = [];
 		const output = {};
 		for (let validatorIndex = 0; validatorIndex < validatorsLength; validatorIndex += 1) {
@@ -452,22 +451,24 @@ function getObjectValidator(original, origin, fromType) {
 			if (value === void 0) {
 				if (required) {
 					if (get && defaults != null) {
-						output[key.short] = clone(defaults.value);
+						const defaultValue = clone(defaults.value);
+						if (parameters.clone) output[key.short] = defaultValue;
+						else input[key.short] = defaultValue;
 						continue;
 					}
 					if (parameters.reporting.none) return [];
-					const information = {
+					const reported = report({
 						key,
 						value,
-						message: getInputPropertyMissingMessage(key.full, types)
-					};
-					if (parameters.reporting.throw) throw new ValidationError([information]);
-					parameters.information?.push(information);
-					if (parameters.reporting.all) {
-						allInformation.push(information);
-						continue;
-					}
-					return [information];
+						information: { all: allInformation },
+						message: {
+							arguments: [key.full, types],
+							callback: getInputPropertyMissingMessage
+						},
+						original: parameters
+					});
+					if (reported == null) continue;
+					return reported;
 				}
 				continue;
 			}
@@ -476,23 +477,32 @@ function getObjectValidator(original, origin, fromType) {
 			const result = validator(value, parameters, get);
 			parameters.output = previousOutput;
 			if (result === true) {
-				if (get && !isPlainObject(value)) output[key.short] = parameters.clone ? clone(value) : value;
+				if (getAndClone && !isPlainObject(value)) output[key.short] = clone(value);
 				continue;
 			}
 			if (parameters.reporting.none) return [];
-			const information = typeof result !== "boolean" && result.length > 0 ? result : [{
+			const reported = report({
 				key,
 				value,
-				message: getInputPropertyTypeMessage(key.full, types, value)
-			}];
-			if (parameters.reporting.throw) throw new ValidationError(information);
-			if (parameters.reporting.all) {
-				allInformation.push(...information);
-				continue;
-			}
-			return information;
+				extract: false,
+				information: {
+					all: allInformation,
+					existing: typeof result !== "boolean" && result.length > 0 ? result : void 0
+				},
+				message: {
+					arguments: [
+						key.full,
+						types,
+						value
+					],
+					callback: getInputPropertyTypeMessage
+				},
+				original: parameters
+			});
+			if (reported == null) continue;
+			return reported;
 		}
-		if (get) if (origin == null) parameters.output = output;
+		if (getAndClone) if (origin == null) parameters.output = output;
 		else parameters.output[origin.short] = output;
 		return allInformation.length === 0 ? true : allInformation;
 	};
@@ -503,6 +513,18 @@ function getRequired(obj, key, allowed) {
 	if (typeof obj["$required"] !== "boolean") throw new SchematicError(getRequiredMessage(key));
 	return obj[PROPERTY_REQUIRED];
 }
+function report(parameters, getReports) {
+	const { information, message, original } = parameters;
+	const reported = information?.existing ?? [{
+		key: parameters.key,
+		value: parameters.value,
+		message: message.callback(...message.arguments)
+	}];
+	if (original.reporting.throw) throw new ValidationError(reported);
+	information?.all.push(...reported);
+	if (parameters.extract ?? true) original.information?.push(...reported);
+	if ((getReports ?? false) || !original.reporting.all) return reported;
+}
 //#endregion
 //#region src/schema.ts
 /**
@@ -518,7 +540,7 @@ var Schema = class {
 	get(value, options) {
 		const parameters = getParameters(options);
 		const result = this.#validator(value, parameters, true);
-		if (result === true) return parameters.reporting.none || parameters.reporting.throw ? parameters.output : ok(parameters.output);
+		if (result === true) return parameters.reporting.none || parameters.reporting.throw ? parameters.clone ? parameters.output : value : ok(parameters.clone ? parameters.output : value);
 		if (parameters.reporting.none) return;
 		return error(parameters.reporting.all ? result : result[0]);
 	}

package/dist/schema.d.mts

@@ -75,7 +75,7 @@ declare class Schema<Model> {
    * @param options Validation options
    * @returns Deeply cloned value, or `undefined` if it's invalid
    */
-  get(value: unknown, options: GetOptions<'none'>): Model | undefined;
+  get(value: unknown, options: Partial<GetOptions<'none'>>): Model | undefined;
   /**
    * Parse a value according to the schema
    *
@@ -147,7 +147,7 @@ declare class Schema<Model> {
    * @param options Validation options
    * @returns `true` if the value matches the schema, otherwise `false`
    */
-  is(value: unknown, options: IsOptions<'none'>): value is Model;
+  is(value: unknown, options: Partial<IsOptions<'none'>>): value is Model;
   /**
    * Does the value match the schema?
    *

package/dist/schema.mjs

@@ -18,7 +18,7 @@ var Schema = class {
 	get(value, options) {
 		const parameters = getParameters(options);
 		const result = this.#validator(value, parameters, true);
-		if (result === true) return parameters.reporting.none || parameters.reporting.throw ? parameters.output : ok(parameters.output);
+		if (result === true) return parameters.reporting.none || parameters.reporting.throw ? parameters.clone ? parameters.output : value : ok(parameters.clone ? parameters.output : value);
 		if (parameters.reporting.none) return;
 		return error(parameters.reporting.all ? result : result[0]);
 	}

package/dist/validator/object.validator.mjs

@@ -6,7 +6,7 @@ import { getBaseValidator } from "./base.validator.mjs";
 import { getFunctionValidator } from "./function.validator.mjs";
 import { getNamedHandlers } from "./named.handler.mjs";
 import { getNamedValidator } from "./named.validator.mjs";
-import { getSchemaValidator } from "./schematic.validator.mjs";
+import { getSchemaValidator } from "./schema.validator.mjs";
 import { isPlainObject } from "@oscarpalmer/atoms/is";
 import { join } from "@oscarpalmer/atoms/string";
 import { clone } from "@oscarpalmer/atoms/value/clone";
@@ -35,8 +35,8 @@ function getObjectValidator(original, origin, fromType) {
 	for (let keyIndex = 0; keyIndex < keysLength; keyIndex += 1) {
 		const key = keys[keyIndex];
 		const value = original[key];
-		if (value == null) throw new SchematicError(getSchematicPropertyNullableMessage(join([origin?.full, key], ".")));
 		const prefixedKey = origin == null ? key : join([origin.full, key], ".");
+		if (value == null) throw new SchematicError(getSchematicPropertyNullableMessage(prefixedKey));
 		const fullKey = {
 			full: prefixedKey,
 			short: key
@@ -92,20 +92,18 @@ function getObjectValidator(original, origin, fromType) {
 	}
 	const validatorsLength = items.length;
 	return (input, parameters, get) => {
-		if (!isPlainObject(input)) {
-			if (origin != null) return [];
-			const information = {
-				key: {
-					full: "",
-					short: ""
-				},
-				value: input,
-				message: getInputTypeMessage(input)
-			};
-			if (parameters.reporting.throw) throw new ValidationError([information]);
-			parameters.information?.push(information);
-			return [information];
-		}
+		if (!isPlainObject(input)) return origin == null ? report({
+			key: {
+				full: "",
+				short: ""
+			},
+			message: {
+				arguments: [input],
+				callback: getInputTypeMessage
+			},
+			original: parameters,
+			value: input
+		}, true) : [];
 		if (parameters.strict) {
 			const unknownKeys = Object.keys(input).filter((key) => !set.has(key));
 			if (unknownKeys.length > 0) {
@@ -122,6 +120,7 @@ function getObjectValidator(original, origin, fromType) {
 				return [information];
 			}
 		}
+		const getAndClone = get && parameters.clone;
 		const allInformation = [];
 		const output = {};
 		for (let validatorIndex = 0; validatorIndex < validatorsLength; validatorIndex += 1) {
@@ -130,22 +129,24 @@ function getObjectValidator(original, origin, fromType) {
 			if (value === void 0) {
 				if (required) {
 					if (get && defaults != null) {
-						output[key.short] = clone(defaults.value);
+						const defaultValue = clone(defaults.value);
+						if (parameters.clone) output[key.short] = defaultValue;
+						else input[key.short] = defaultValue;
 						continue;
 					}
 					if (parameters.reporting.none) return [];
-					const information = {
+					const reported = report({
 						key,
 						value,
-						message: getInputPropertyMissingMessage(key.full, types)
-					};
-					if (parameters.reporting.throw) throw new ValidationError([information]);
-					parameters.information?.push(information);
-					if (parameters.reporting.all) {
-						allInformation.push(information);
-						continue;
-					}
-					return [information];
+						information: { all: allInformation },
+						message: {
+							arguments: [key.full, types],
+							callback: getInputPropertyMissingMessage
+						},
+						original: parameters
+					});
+					if (reported == null) continue;
+					return reported;
 				}
 				continue;
 			}
@@ -154,23 +155,32 @@ function getObjectValidator(original, origin, fromType) {
 			const result = validator(value, parameters, get);
 			parameters.output = previousOutput;
 			if (result === true) {
-				if (get && !isPlainObject(value)) output[key.short] = parameters.clone ? clone(value) : value;
+				if (getAndClone && !isPlainObject(value)) output[key.short] = clone(value);
 				continue;
 			}
 			if (parameters.reporting.none) return [];
-			const information = typeof result !== "boolean" && result.length > 0 ? result : [{
+			const reported = report({
 				key,
 				value,
-				message: getInputPropertyTypeMessage(key.full, types, value)
-			}];
-			if (parameters.reporting.throw) throw new ValidationError(information);
-			if (parameters.reporting.all) {
-				allInformation.push(...information);
-				continue;
-			}
-			return information;
+				extract: false,
+				information: {
+					all: allInformation,
+					existing: typeof result !== "boolean" && result.length > 0 ? result : void 0
+				},
+				message: {
+					arguments: [
+						key.full,
+						types,
+						value
+					],
+					callback: getInputPropertyTypeMessage
+				},
+				original: parameters
+			});
+			if (reported == null) continue;
+			return reported;
 		}
-		if (get) if (origin == null) parameters.output = output;
+		if (getAndClone) if (origin == null) parameters.output = output;
 		else parameters.output[origin.short] = output;
 		return allInformation.length === 0 ? true : allInformation;
 	};
@@ -181,5 +191,17 @@ function getRequired(obj, key, allowed) {
 	if (typeof obj["$required"] !== "boolean") throw new SchematicError(getRequiredMessage(key));
 	return obj[PROPERTY_REQUIRED];
 }
+function report(parameters, getReports) {
+	const { information, message, original } = parameters;
+	const reported = information?.existing ?? [{
+		key: parameters.key,
+		value: parameters.value,
+		message: message.callback(...message.arguments)
+	}];
+	if (original.reporting.throw) throw new ValidationError(reported);
+	information?.all.push(...reported);
+	if (parameters.extract ?? true) original.information?.push(...reported);
+	if ((getReports ?? false) || !original.reporting.all) return reported;
+}
 //#endregion
 export { getObjectValidator };

package/dist/validator/{schematic.validator.d.mts → schema.validator.d.mts}

@@ -1,7 +1,7 @@
 import { Validator } from "../models/validation.model.mjs";
 import { Schema } from "../schema.mjs";
 
-//#region src/validator/schematic.validator.d.ts
+//#region src/validator/schema.validator.d.ts
 declare function getSchemaValidator(schematic: Schema<unknown>): Validator;
 //#endregion
 export { getSchemaValidator };

package/dist/validator/{schematic.validator.mjs → schema.validator.mjs}

@@ -1,6 +1,6 @@
 import { schemaValidators } from "../schema.mjs";
 import { isPlainObject } from "@oscarpalmer/atoms/is";
-//#region src/validator/schematic.validator.ts
+//#region src/validator/schema.validator.ts
 function getSchemaValidator(schematic) {
 	const validator = schemaValidators.get(schematic);
 	return (input, parameters, get) => {

package/package.json

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

package/src/schema.ts

@@ -102,7 +102,7 @@ export class Schema<Model> {
 	 * @param options Validation options
 	 * @returns Deeply cloned value, or `undefined` if it's invalid
 	 */
-	get(value: unknown, options: GetOptions<'none'>): Model | undefined;
+	get(value: unknown, options: Partial<GetOptions<'none'>>): Model | undefined;
 
 	/**
 	 * Parse a value according to the schema
@@ -121,8 +121,10 @@ export class Schema<Model> {
 
 		if (result === true) {
 			return parameters.reporting.none || parameters.reporting.throw
-				? parameters.output
-				: ok(parameters.output);
+				? parameters.clone
+					? parameters.output
+					: value
+				: ok(parameters.clone ? parameters.output : value);
 		}
 
 		if (parameters.reporting.none) {
@@ -200,7 +202,7 @@ export class Schema<Model> {
 	 * @param options Validation options
 	 * @returns `true` if the value matches the schema, otherwise `false`
 	 */
-	is(value: unknown, options: IsOptions<'none'>): value is Model;
+	is(value: unknown, options: Partial<IsOptions<'none'>>): value is Model;
 
 	/**
 	 * Does the value match the schema?

package/src/validator/object.validator.ts

@@ -34,13 +34,33 @@ import {
 	type Validator,
 	type ValidatorDefaults,
 	type ValidatorItem,
+	type ValidatorParameters,
 	type ValidatorType,
 } from '../models/validation.model';
 import {getBaseValidator} from './base.validator';
 import {getFunctionValidator} from './function.validator';
 import {getNamedHandlers} from './named.handler';
 import {getNamedValidator} from './named.validator';
-import {getSchemaValidator} from './schematic.validator';
+import {getSchemaValidator} from './schema.validator';
+
+type ReportParameters<Callback extends (...args: any[]) => string> = {
+	extract?: boolean;
+	information?: ReportParametersInformation;
+	key: ValidationInformationKey;
+	message: ReportParametersMessage<Callback>;
+	original: ValidatorParameters;
+	value: unknown;
+};
+
+type ReportParametersMessage<Callback extends (...args: any[]) => string> = {
+	arguments: Parameters<Callback>;
+	callback: Callback;
+};
+
+type ReportParametersInformation = {
+	all: ValidationInformation[];
+	existing?: ValidationInformation[];
+};
 
 function getDefaults(
 	obj: PlainObject,
@@ -106,12 +126,12 @@ export function getObjectValidator(
 		const key = keys[keyIndex];
 		const value = original[key];
 
+		const prefixedKey = origin == null ? key : join([origin.full, key], '.');
+
 		if (value == null) {
-			throw new SchematicError(getSchematicPropertyNullableMessage(join([origin?.full, key], '.')));
+			throw new SchematicError(getSchematicPropertyNullableMessage(prefixedKey));
 		}
 
-		const prefixedKey = origin == null ? key : join([origin.full, key], '.');
-
 		const fullKey: ValidationInformationKey = {
 			full: prefixedKey,
 			short: key,
@@ -203,26 +223,23 @@ export function getObjectValidator(
 
 	return (input, parameters, get) => {
 		if (!isPlainObject(input)) {
-			if (origin != null) {
-				return [];
-			}
-
-			const information: ValidationInformation = {
-				key: {
-					full: '',
-					short: '',
-				},
-				value: input,
-				message: getInputTypeMessage(input),
-			};
-
-			if (parameters.reporting.throw) {
-				throw new ValidationError([information]);
-			}
-
-			parameters.information?.push(information);
-
-			return [information];
+			return origin == null
+				? report(
+						{
+							key: {
+								full: '',
+								short: '',
+							},
+							message: {
+								arguments: [input],
+								callback: getInputTypeMessage,
+							},
+							original: parameters,
+							value: input,
+						},
+						true,
+					)
+				: [];
 		}
 
 		if (parameters.strict) {
@@ -249,6 +266,8 @@ export function getObjectValidator(
 			}
 		}
 
+		const getAndClone = get && parameters.clone;
+
 		const allInformation: ValidationInformation[] = [];
 		const output: PlainObject = {};
 
@@ -260,7 +279,13 @@ export function getObjectValidator(
 			if (value === undefined) {
 				if (required) {
 					if (get && defaults != null) {
-						output[key.short] = clone(defaults.value);
+						const defaultValue = clone(defaults.value);
+
+						if (parameters.clone) {
+							output[key.short] = defaultValue;
+						} else {
+							input[key.short] = defaultValue;
+						}
 
 						continue;
 					}
@@ -269,25 +294,24 @@ export function getObjectValidator(
 						return [];
 					}
 
-					const information: ValidationInformation = {
+					const reported = report({
 						key,
 						value,
-						message: getInputPropertyMissingMessage(key.full, types),
-					};
-
-					if (parameters.reporting.throw) {
-						throw new ValidationError([information]);
-					}
-
-					parameters.information?.push(information);
-
-					if (parameters.reporting.all) {
-						allInformation.push(information);
-
+						information: {
+							all: allInformation,
+						},
+						message: {
+							arguments: [key.full, types],
+							callback: getInputPropertyMissingMessage,
+						},
+						original: parameters,
+					});
+
+					if (reported == null) {
 						continue;
 					}
 
-					return [information];
+					return reported;
 				}
 
 				continue;
@@ -302,8 +326,8 @@ export function getObjectValidator(
 			parameters.output = previousOutput;
 
 			if (result === true) {
-				if (get && !isPlainObject(value)) {
-					output[key.short] = parameters.clone ? clone(value) : value;
+				if (getAndClone && !isPlainObject(value)) {
+					output[key.short] = clone(value);
 				}
 
 				continue;
@@ -313,31 +337,29 @@ export function getObjectValidator(
 				return [];
 			}
 
-			const information: ValidationInformation[] =
-				typeof result !== 'boolean' && result.length > 0
-					? result
-					: [
-							{
-								key,
-								value,
-								message: getInputPropertyTypeMessage(key.full, types, value),
-							},
-						];
-
-			if (parameters.reporting.throw) {
-				throw new ValidationError(information);
-			}
-
-			if (parameters.reporting.all) {
-				allInformation.push(...information);
+			const reported = report({
+				key,
+				value,
+				extract: false,
+				information: {
+					all: allInformation,
+					existing: typeof result !== 'boolean' && result.length > 0 ? result : undefined,
+				},
+				message: {
+					arguments: [key.full, types, value],
+					callback: getInputPropertyTypeMessage,
+				},
+				original: parameters,
+			});
 
+			if (reported == null) {
 				continue;
 			}
 
-			return information;
+			return reported;
 		}
 
-		if (get) {
+		if (getAndClone) {
 			if (origin == null) {
 				parameters.output = output;
 			} else {
@@ -364,3 +386,41 @@ function getRequired(obj: PlainObject, key: string, allowed: boolean): boolean |
 
 	return obj[PROPERTY_REQUIRED];
 }
+
+function report<Callback extends (...args: any[]) => string>(
+	parameters: ReportParameters<Callback>,
+	getReports: true,
+): ValidationInformation[];
+
+function report<Callback extends (...args: any[]) => string>(
+	parameters: ReportParameters<Callback>,
+): ValidationInformation[] | undefined;
+
+function report<Callback extends (...args: any[]) => string>(
+	parameters: ReportParameters<Callback>,
+	getReports?: boolean,
+): ValidationInformation[] | undefined {
+	const {information, message, original} = parameters;
+
+	const reported: ValidationInformation[] = information?.existing ?? [
+		{
+			key: parameters.key,
+			value: parameters.value,
+			message: message.callback(...message.arguments),
+		},
+	];
+
+	if (original.reporting.throw) {
+		throw new ValidationError(reported);
+	}
+
+	information?.all.push(...reported);
+
+	if (parameters.extract ?? true) {
+		original.information?.push(...reported);
+	}
+
+	if ((getReports ?? false) || !original.reporting.all) {
+		return reported;
+	}
+}