@oscarpalmer/jhunal 0.21.0 → 0.22.0

package/dist/models/schema.plain.model.d.mts

@@ -25,19 +25,13 @@ type PlainSchema = {
  * };
  * ```
  */
-type Schema = SchemaIndex;
+type Schema = PlainSchema;
 /**
  * A union of all valid types for a single schema entry
  *
  * Can be a {@link Constructor}, {@link PlainSchema}, {@link SchemaProperty}, {@link Schematic}, {@link ValueName} string, or a custom validator function
  */
 type SchemaEntry = Constructor | PlainSchema | SchemaProperty | Schematic<unknown> | ValueName | ((value: unknown) => boolean);
-/**
- * Index signature interface backing {@link Schema}, allowing string-keyed entries of {@link PlainSchema}, {@link SchemaEntry}, or arrays of {@link SchemaEntry}
- */
-interface SchemaIndex {
-  [key: string]: PlainSchema | SchemaEntry | SchemaEntry[];
-}
 /**
  * A property definition with explicit type(s), an optional requirement flag, and optional validators
  *
@@ -89,4 +83,4 @@ type SchemaPropertyType = Constructor | PlainSchema | Schematic<unknown> | Value
  */
 type PropertyValidators<Value> = { [Key in ExtractValueNames<Value>]?: ((value: Values[Key]) => boolean) | Array<(value: Values[Key]) => boolean> };
 //#endregion
-export { PlainSchema, PropertyValidators, Schema, SchemaEntry, SchemaIndex, SchemaProperty, SchemaPropertyType };
+export { PlainSchema, PropertyValidators, Schema, SchemaEntry, SchemaProperty, SchemaPropertyType };

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

@@ -3,19 +3,18 @@ import { ValueName } from "./misc.model.mjs";
 import { GenericCallback, PlainObject } from "@oscarpalmer/atoms/models";
 
 //#region src/models/validation.model.d.ts
-/**
- * Maps each {@link ReportingType} to a boolean flag
- */
+type NamedValidatorHandlers = { [Key in ValueName]?: Array<(value: unknown) => boolean> };
+type NamedValidators = Record<ValueName, (value: unknown) => boolean>;
 type ReportingInformation = Record<ReportingType, boolean> & {
   type: ReportingType;
 };
 /**
  * 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
  */
 type ReportingType = 'all' | 'first' | 'none' | 'throw';
 /**
@@ -24,49 +23,6 @@ type ReportingType = 'all' | 'first' | 'none' | 'throw';
 declare class SchematicError extends Error {
   constructor(message: string);
 }
-/**
- * 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] },
- * };
- * ```
- */
-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
- */
-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`
- */
-type ValidatedPropertyValidators = { [Key in ValueName]?: Array<(value: unknown) => boolean> };
 /**
  * Thrown in `'throw'` mode when one or more properties fail validation; `information` holds all failures
  */
@@ -103,13 +59,13 @@ type ValidationOptions<Errors extends ReportingType> = {
    */
   strict?: boolean;
 };
-type ValidationParameters = {
+type Validator = (input: unknown, parameters: ValidatorParameters, get: boolean) => boolean | ValidationInformation[];
+type ValidatorParameters = {
   information?: ValidationInformation[];
-  origin?: ValidatedProperty;
   output: PlainObject;
-  prefix?: string;
   reporting: ReportingInformation;
   strict: boolean;
 };
+type ValidatorType = Function | PlainObject | Schematic<unknown> | ValueName;
 //#endregion
-export { ReportingInformation, ReportingType, SchematicError, ValidatedProperty, ValidatedPropertyType, ValidatedPropertyValidators, ValidationError, ValidationInformation, ValidationInformationKey, ValidationOptions, ValidationParameters };
+export { NamedValidatorHandlers, NamedValidators, ReportingInformation, ReportingType, SchematicError, ValidationError, ValidationInformation, ValidationInformationKey, ValidationOptions, Validator, ValidatorParameters, ValidatorType };

package/dist/schematic.d.mts

@@ -1,6 +1,6 @@
 import { Infer } from "./models/infer.model.mjs";
 import { TypedSchema } from "./models/schema.typed.model.mjs";
-import { ValidatedProperty, ValidationInformation, ValidationOptions } from "./models/validation.model.mjs";
+import { ValidationInformation, ValidationOptions, Validator } 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";
@@ -12,7 +12,7 @@ import { Result } from "@oscarpalmer/atoms/result/models";
 declare class Schematic<Model> {
   #private;
   private readonly $schematic;
-  constructor(properties: ValidatedProperty[]);
+  constructor(validator: Validator);
   /**
    * Parse a value according to the schema
    *
@@ -156,6 +156,6 @@ declare function schematic<Model extends Schema>(schema: Model): Schematic<Infer
  * @returns A schematic for the given typed schema
  */
 declare function schematic<Model extends PlainObject>(schema: TypedSchema<Model>): Schematic<Model>;
-declare const schematicProperties: WeakMap<Schematic<unknown>, ValidatedProperty[]>;
+declare const schematicValidator: WeakMap<Schematic<unknown>, Validator>;
 //#endregion
-export { Schematic, schematic, schematicProperties };
+export { Schematic, schematic, schematicValidator };

package/dist/schematic.mjs

@@ -1,8 +1,7 @@
 import { PROPERTY_SCHEMATIC, SCHEMATIC_MESSAGE_SCHEMA_INVALID_TYPE } from "./constants.mjs";
 import { getParameters, isSchematic } from "./helpers.mjs";
 import { SchematicError } from "./models/validation.model.mjs";
-import { getProperties } from "./validation/property.validation.mjs";
-import { validateObject } from "./validation/value.validation.mjs";
+import { getObjectValidator } from "./validation.mjs";
 import { isPlainObject } from "@oscarpalmer/atoms/is";
 import { error, ok } from "@oscarpalmer/atoms/result/misc";
 //#region src/schematic.ts
@@ -10,32 +9,30 @@ import { error, ok } from "@oscarpalmer/atoms/result/misc";
 * A schematic for validating objects
 */
 var Schematic = class {
-	#properties;
-	constructor(properties) {
+	#validator;
+	constructor(validator) {
 		Object.defineProperty(this, PROPERTY_SCHEMATIC, { value: true });
-		this.#properties = properties;
-		schematicProperties.set(this, properties);
+		this.#validator = validator;
+		schematicValidator.set(this, validator);
 	}
 	get(value, options) {
 		const parameters = getParameters(options);
-		const result = validateObject(value, this.#properties, parameters, true);
-		if (result == null) return;
-		if (!Array.isArray(result)) return parameters.reporting.none ? result : ok(result);
+		const result = this.#validator(value, parameters, true);
+		if (typeof result === "boolean") return parameters.reporting.none ? result ? parameters.output : void 0 : ok(parameters.output);
 		return error(parameters.reporting.all ? result : result[0]);
 	}
 	is(value, options) {
 		const parameters = getParameters(options);
-		const result = validateObject(value, this.#properties, parameters, false);
-		if (result == null) return false;
-		if (!Array.isArray(result)) return parameters.reporting.none ? true : ok(true);
+		const result = this.#validator(value, parameters, false);
+		if (typeof result === "boolean") return parameters.reporting.none ? result : ok(result);
 		return error(parameters.reporting.all ? result : result[0]);
 	}
 };
 function schematic(schema) {
 	if (isSchematic(schema)) return schema;
 	if (!isPlainObject(schema)) throw new SchematicError(SCHEMATIC_MESSAGE_SCHEMA_INVALID_TYPE);
-	return new Schematic(getProperties(schema));
+	return new Schematic(getObjectValidator(schema));
 }
-const schematicProperties = /* @__PURE__ */ new WeakMap();
+const schematicValidator = /* @__PURE__ */ new WeakMap();
 //#endregion
-export { Schematic, schematic, schematicProperties };
+export { Schematic, schematic, schematicValidator };

package/dist/validation.d.mts

@@ -0,0 +1,7 @@
+import { ValidationInformationKey, Validator } from "./models/validation.model.mjs";
+import { PlainObject } from "@oscarpalmer/atoms";
+
+//#region src/validation.d.ts
+declare function getObjectValidator(original: PlainObject, origin?: ValidationInformationKey, fromType?: boolean): Validator;
+//#endregion
+export { getObjectValidator };

package/dist/validation.mjs

@@ -0,0 +1,245 @@
+import { PROPERTY_REQUIRED, PROPERTY_TYPE, PROPERTY_VALIDATORS, SCHEMATIC_MESSAGE_SCHEMA_INVALID_EMPTY, SCHEMATIC_MESSAGE_SCHEMA_INVALID_PROPERTY_DISALLOWED, SCHEMATIC_MESSAGE_SCHEMA_INVALID_PROPERTY_NULLABLE, SCHEMATIC_MESSAGE_SCHEMA_INVALID_PROPERTY_REQUIRED, SCHEMATIC_MESSAGE_SCHEMA_INVALID_PROPERTY_TYPE, SCHEMATIC_MESSAGE_VALIDATOR_INVALID_KEY, SCHEMATIC_MESSAGE_VALIDATOR_INVALID_TYPE, SCHEMATIC_MESSAGE_VALIDATOR_INVALID_VALUE, TYPE_ALL } from "./constants.mjs";
+import { getInvalidInputMessage, getInvalidMissingMessage, getInvalidTypeMessage, getInvalidValidatorMessage, getUnknownKeysMessage, instanceOf, isSchematic } from "./helpers.mjs";
+import { SchematicError, ValidationError } from "./models/validation.model.mjs";
+import { schematicValidator } from "./schematic.mjs";
+import { isConstructor, isPlainObject } from "@oscarpalmer/atoms/is";
+import { join } from "@oscarpalmer/atoms";
+import { clone } from "@oscarpalmer/atoms/value/clone";
+//#region src/validation.ts
+function getDisallowedProperty(obj) {
+	if ("$required" in obj) return PROPERTY_REQUIRED;
+	if ("$type" in obj) return PROPERTY_TYPE;
+	if ("$validators" in obj) return PROPERTY_VALIDATORS;
+}
+function getFunctionValidator(fn) {
+	const validator = isConstructor(fn) ? instanceOf(fn) : fn;
+	return (input) => validator(input) === true;
+}
+function getNamedValidator(key, name, handlers) {
+	const validator = namedValidators[name];
+	const named = handlers[name] ?? [];
+	const { length } = named;
+	return (input, parameters) => {
+		if (!validator(input)) return false;
+		for (let index = 0; index < length; index += 1) {
+			const handler = named[index];
+			if (handler(input) === true) continue;
+			const information = {
+				key,
+				validator,
+				message: getInvalidValidatorMessage(key.full, name, index, length),
+				value: input
+			};
+			parameters.information?.push(information);
+			return parameters.reporting.none ? false : [information];
+		}
+		return true;
+	};
+}
+function getNamedHandlers(original, prefix) {
+	const handlers = {};
+	if (original == null) return handlers;
+	if (!isPlainObject(original)) throw new TypeError(SCHEMATIC_MESSAGE_VALIDATOR_INVALID_TYPE);
+	const keys = Object.keys(original);
+	const { length } = keys;
+	for (let index = 0; index < length; index += 1) {
+		const key = keys[index];
+		if (!TYPE_ALL.has(key)) throw new TypeError(SCHEMATIC_MESSAGE_VALIDATOR_INVALID_KEY.replace("<>", key));
+		const value = original[key];
+		handlers[key] = (Array.isArray(value) ? value : [value]).map((item) => {
+			if (typeof item !== "function") throw new TypeError(SCHEMATIC_MESSAGE_VALIDATOR_INVALID_VALUE.replace("<>", key).replace("<>", prefix));
+			return item;
+		});
+	}
+	return handlers;
+}
+function getObjectValidator(original, origin, fromType) {
+	const keys = Object.keys(original);
+	const keysLength = keys.length;
+	if (keysLength === 0) throw new SchematicError(SCHEMATIC_MESSAGE_SCHEMA_INVALID_EMPTY);
+	if (fromType ?? false) {
+		const property = getDisallowedProperty(original);
+		if (property != null) throw new SchematicError(SCHEMATIC_MESSAGE_SCHEMA_INVALID_PROPERTY_DISALLOWED.replace("<>", origin.full).replace("<>", property));
+	}
+	const set = /* @__PURE__ */ new Set();
+	const items = [];
+	for (let keyIndex = 0; keyIndex < keysLength; keyIndex += 1) {
+		const key = keys[keyIndex];
+		const value = original[key];
+		if (value == null) throw new SchematicError(SCHEMATIC_MESSAGE_SCHEMA_INVALID_PROPERTY_NULLABLE.replace("<>", join([origin?.full, key], ".")));
+		const prefixedKey = origin == null ? key : join([origin.full, key], ".");
+		const fullKey = {
+			full: prefixedKey,
+			short: key
+		};
+		let handlers = {};
+		let required = true;
+		let typed = false;
+		let types;
+		const validators = [];
+		if (isPlainObject(value)) {
+			typed = PROPERTY_TYPE in value;
+			const type = typed ? value[PROPERTY_TYPE] : value;
+			handlers = getNamedHandlers(value[PROPERTY_VALIDATORS], prefixedKey);
+			required = getRequired(key, value) ?? required;
+			types = Array.isArray(type) ? type : [type];
+		} else types = Array.isArray(value) ? value : [value];
+		if (types.length === 0) throw new SchematicError(SCHEMATIC_MESSAGE_SCHEMA_INVALID_PROPERTY_TYPE.replace("<>", prefixedKey).replace("<>", String(value)));
+		const typesLength = types.length;
+		for (let typeIndex = 0; typeIndex < typesLength; typeIndex += 1) {
+			const type = types[typeIndex];
+			let validator;
+			switch (true) {
+				case typeof type === "function":
+					validator = getFunctionValidator(type);
+					break;
+				case isPlainObject(type):
+					validator = getObjectValidator(type, fullKey, typed);
+					break;
+				case isSchematic(type):
+					validator = getSchematicValidator(type);
+					break;
+				case TYPE_ALL.has(type):
+					validator = getNamedValidator(fullKey, type, handlers);
+					break;
+				default: throw new SchematicError(SCHEMATIC_MESSAGE_SCHEMA_INVALID_PROPERTY_TYPE.replace("<>", prefixedKey).replace("<>", String(type)));
+			}
+			validators.push(validator);
+		}
+		set.add(key);
+		items.push({
+			types,
+			key: fullKey,
+			required: required && !types.includes("undefined"),
+			validator: getValidator(validators)
+		});
+	}
+	const validatorsLength = items.length;
+	return (input, parameters, get) => {
+		if (!isPlainObject(input)) {
+			if (origin != null) return false;
+			const information = {
+				key: {
+					full: "",
+					short: ""
+				},
+				value: input,
+				message: getInvalidInputMessage(input)
+			};
+			if (parameters.reporting.throw) throw new ValidationError([information]);
+			parameters.information?.push(information);
+			return parameters.reporting.none ? false : [information];
+		}
+		if (parameters.strict) {
+			const unknownKeys = Object.keys(input).filter((key) => !set.has(key));
+			if (unknownKeys.length > 0) {
+				const information = {
+					key: origin ?? {
+						full: "",
+						short: ""
+					},
+					message: getUnknownKeysMessage(unknownKeys),
+					value: input
+				};
+				if (parameters.reporting.throw) throw new ValidationError([information]);
+				parameters.information?.push(information);
+				return parameters.reporting.none ? false : [information];
+			}
+		}
+		const allInformation = [];
+		const output = {};
+		for (let validatorIndex = 0; validatorIndex < validatorsLength; validatorIndex += 1) {
+			const { key, required, types, validator } = items[validatorIndex];
+			const value = input[key.short];
+			if (value === void 0) {
+				if (required) {
+					if (parameters.reporting.none) return false;
+					const information = {
+						key,
+						value,
+						message: getInvalidMissingMessage(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];
+				}
+				continue;
+			}
+			const previousOutput = parameters.output;
+			parameters.output = output;
+			const result = validator(value, parameters, get);
+			parameters.output = previousOutput;
+			if (result === false) continue;
+			if (result === true) {
+				if (get) output[key.short] = clone(value);
+				continue;
+			}
+			if (parameters.reporting.none) return false;
+			const information = typeof result !== "boolean" && result.length > 0 ? result : [{
+				key,
+				value,
+				message: getInvalidTypeMessage(key.full, types, value)
+			}];
+			if (parameters.reporting.throw) throw new ValidationError(information);
+			if (parameters.reporting.all) {
+				allInformation.push(...information);
+				continue;
+			}
+			return information;
+		}
+		if (get) if (origin == null) parameters.output = output;
+		else parameters.output[origin.short] = output;
+		return parameters.reporting.none || allInformation.length === 0 ? true : allInformation;
+	};
+}
+function getRequired(key, obj) {
+	if (!("$required" in obj)) return;
+	if (typeof obj["$required"] !== "boolean") throw new SchematicError(SCHEMATIC_MESSAGE_SCHEMA_INVALID_PROPERTY_REQUIRED.replace("<>", key));
+	return obj[PROPERTY_REQUIRED];
+}
+function getSchematicValidator(schematic) {
+	const validator = schematicValidator.get(schematic);
+	return (input, parameters, get) => {
+		let result = false;
+		if (isPlainObject(input)) result = validator(input, parameters, get);
+		if (typeof result === "boolean") return result;
+		parameters.information?.push(...result);
+		return result.length === 0 ? true : result;
+	};
+}
+function getValidator(validators) {
+	const { length } = validators;
+	return (input, parameters, get) => {
+		const allInformation = [];
+		for (let index = 0; index < length; index += 1) {
+			const previousInformation = parameters.information;
+			parameters.information = [];
+			const result = validators[index](input, parameters, get);
+			parameters.information = previousInformation;
+			if (result === false) continue;
+			if (result === true) return true;
+			parameters.information?.push(...result);
+			allInformation.push(...result);
+		}
+		return allInformation;
+	};
+}
+const namedValidators = {
+	array: Array.isArray,
+	bigint: (value) => typeof value === "bigint",
+	boolean: (value) => typeof value === "boolean",
+	date: (value) => value instanceof Date,
+	function: (value) => typeof value === "function",
+	null: (value) => value === null,
+	number: (value) => typeof value === "number",
+	object: (value) => typeof value === "object" && value !== null,
+	string: (value) => typeof value === "string",
+	symbol: (value) => typeof value === "symbol",
+	undefined: (value) => value === void 0
+};
+//#endregion
+export { getObjectValidator };

package/package.json

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

package/src/helpers.ts

@@ -30,9 +30,8 @@ import type {ValueName} from './models/misc.model';
 import type {
 	ReportingInformation,
 	ReportingType,
-	ValidatedProperty,
-	ValidatedPropertyType,
-	ValidationParameters,
+	ValidatorParameters,
+	ValidatorType,
 } from './models/validation.model';
 import type {Schematic} from './schematic';
 
@@ -40,7 +39,7 @@ export function getInvalidInputMessage(actual: unknown): string {
 	return VALIDATION_MESSAGE_INVALID_INPUT.replace(TEMPLATE_PATTERN, getValueType(actual));
 }
 
-export function getInvalidMissingMessage(key: string, types: ValidatedPropertyType[]): string {
+export function getInvalidMissingMessage(key: string, types: ValidatorType[]): string {
 	let message = VALIDATION_MESSAGE_INVALID_REQUIRED.replace(TEMPLATE_PATTERN, renderTypes(types));
 
 	message = message.replace(TEMPLATE_PATTERN, key);
@@ -50,7 +49,7 @@ export function getInvalidMissingMessage(key: string, types: ValidatedPropertyTy
 
 export function getInvalidTypeMessage(
 	key: string,
-	types: ValidatedPropertyType[],
+	types: ValidatorType[],
 	actual: unknown,
 ): string {
 	let message = VALIDATION_MESSAGE_INVALID_TYPE.replace(TEMPLATE_PATTERN, renderTypes(types));
@@ -78,7 +77,7 @@ export function getInvalidValidatorMessage(
 	return message;
 }
 
-export function getParameters(input?: unknown): ValidationParameters {
+export function getParameters(input?: unknown): ValidatorParameters {
 	if (typeof input === 'boolean') {
 		return {
 			output: {},
@@ -104,12 +103,16 @@ export function getParameters(input?: unknown): ValidationParameters {
 	};
 }
 
-function getPropertyType(original: ValidatedPropertyType): string {
+function getPropertyType(original: ValidatorType): string {
 	if (typeof original === 'function') {
 		return 'a validated value';
 	}
 
 	if (Array.isArray(original)) {
+		return `'array'`;
+	}
+
+	if (isPlainObject(original)) {
 		return `'${TYPE_OBJECT}'`;
 	}
 
@@ -227,7 +230,7 @@ function renderParts(parts: string[], delimiterShort: string, delimiterLong: str
 	return rendered;
 }
 
-function renderTypes(types: ValidatedPropertyType[]): string {
+function renderTypes(types: ValidatorType[]): string {
 	const unique = new Set<string>();
 	const parts: string[] = [];
 

package/src/index.ts

@@ -1,5 +1,10 @@
 export {instanceOf, isSchematic} from './helpers';
 export type {Schema} from './models/schema.plain.model';
 export type {TypedSchema} from './models/schema.typed.model';
-export {SchematicError, ValidationError} from './models/validation.model';
+export {
+	SchematicError,
+	ValidationError,
+	type ValidationInformation,
+	type ValidationOptions,
+} from './models/validation.model';
 export {schematic, type Schematic} from './schematic';

package/src/models/schema.plain.model.ts

@@ -25,7 +25,7 @@ export type PlainSchema = {
  * };
  * ```
  */
-export type Schema = SchemaIndex;
+export type Schema = PlainSchema;
 
 /**
  * A union of all valid types for a single schema entry
@@ -40,13 +40,6 @@ export type SchemaEntry =
 	| ValueName
 	| ((value: unknown) => boolean);
 
-/**
- * Index signature interface backing {@link Schema}, allowing string-keyed entries of {@link PlainSchema}, {@link SchemaEntry}, or arrays of {@link SchemaEntry}
- */
-export interface SchemaIndex {
-	[key: string]: PlainSchema | SchemaEntry | SchemaEntry[];
-}
-
 /**
  * A property definition with explicit type(s), an optional requirement flag, and optional validators
  *