@oscarpalmer/jhunal 0.21.0 → 0.22.0

package/dist/validation/value.validation.mjs

@@ -1,162 +0,0 @@
-import "../constants.mjs";
-import { getInvalidInputMessage, getInvalidMissingMessage, getInvalidTypeMessage, getInvalidValidatorMessage, getUnknownKeysMessage, isSchematic } from "../helpers.mjs";
-import { ValidationError } from "../models/validation.model.mjs";
-import { schematicProperties } from "../schematic.mjs";
-import { isPlainObject } from "@oscarpalmer/atoms/is";
-import { join } from "@oscarpalmer/atoms/string";
-import { clone } from "@oscarpalmer/atoms/value/clone";
-//#region src/validation/value.validation.ts
-function validateNamed(name, value, parameters) {
-	if (!validators[name](value)) return false;
-	const propertyValidators = parameters.origin.validators[name];
-	if (propertyValidators == null || propertyValidators.length === 0) return true;
-	const { length } = propertyValidators;
-	for (let index = 0; index < length; index += 1) {
-		const validator = propertyValidators[index];
-		if (!validator(value)) {
-			parameters.information.push({
-				value,
-				key: {
-					full: parameters.prefix,
-					short: parameters.origin.key
-				},
-				message: getInvalidValidatorMessage(parameters.prefix, name, index, length),
-				validator
-			});
-			return false;
-		}
-	}
-	return true;
-}
-function validateObject(obj, properties, parameters, get) {
-	if (!isPlainObject(obj)) {
-		const key = parameters?.origin == null ? {
-			full: "",
-			short: ""
-		} : {
-			full: parameters.prefix,
-			short: parameters.origin.key
-		};
-		const information = {
-			key,
-			message: parameters?.origin == null ? getInvalidInputMessage(obj) : getInvalidTypeMessage(key.full, parameters.origin.types, obj),
-			value: obj
-		};
-		if (parameters.reporting.throw) throw new ValidationError([information]);
-		parameters?.information?.push(information);
-		return parameters.reporting.none ? void 0 : [information];
-	}
-	if (parameters.strict) {
-		const objKeys = Object.keys(obj);
-		const propertiesKeys = new Set(properties.map((property) => property.key));
-		const unknownKeys = objKeys.filter((key) => !propertiesKeys.has(key));
-		if (unknownKeys.length > 0) {
-			const information = {
-				key: parameters?.origin == null ? {
-					full: "",
-					short: ""
-				} : {
-					full: join([parameters.prefix, parameters.origin?.key], "."),
-					short: parameters.origin.key
-				},
-				message: getUnknownKeysMessage(unknownKeys.map((key) => join([parameters?.prefix, key], "."))),
-				value: obj
-			};
-			if (parameters.reporting.throw) throw new ValidationError([information]);
-			parameters?.information?.push(information);
-			return parameters.reporting.none ? void 0 : [information];
-		}
-	}
-	const allInformation = [];
-	const output = {};
-	const propertiesLength = properties.length;
-	outer: for (let propertyIndex = 0; propertyIndex < propertiesLength; propertyIndex += 1) {
-		const property = properties[propertyIndex];
-		const { key, required, types } = property;
-		const value = obj[key];
-		if (get && value === void 0 && !required) continue;
-		if (value === void 0 && required) {
-			const prefixedKey = join([parameters.prefix, key], ".");
-			const information = {
-				value,
-				key: {
-					full: prefixedKey,
-					short: key
-				},
-				message: getInvalidMissingMessage(prefixedKey, property.types)
-			};
-			if (parameters.reporting.throw) throw new ValidationError([information]);
-			parameters?.information?.push(information);
-			if (parameters.reporting.all) {
-				allInformation.push(information);
-				continue;
-			}
-			return parameters.reporting.none ? void 0 : [information];
-		}
-		const prefixedKey = join([parameters.prefix, key], ".");
-		const typesLength = types.length;
-		const information = [];
-		for (let typeIndex = 0; typeIndex < typesLength; typeIndex += 1) {
-			const type = types[typeIndex];
-			if (validateValue(type, value, {
-				information,
-				output,
-				origin: property,
-				prefix: prefixedKey,
-				reporting: parameters.reporting,
-				strict: parameters.strict
-			}, get)) {
-				if (get) output[key] = clone(value);
-				continue outer;
-			}
-		}
-		if (information.length === 0) information.push({
-			value,
-			key: {
-				full: prefixedKey,
-				short: key
-			},
-			message: getInvalidTypeMessage(prefixedKey, property.types, value)
-		});
-		if (parameters.reporting.throw) throw new ValidationError(information);
-		parameters?.information?.push(...information);
-		if (parameters.reporting.all) {
-			allInformation.push(...information);
-			continue;
-		}
-		return parameters.reporting.none ? void 0 : information;
-	}
-	if (get) if (parameters.origin == null) parameters.output = output;
-	else parameters.output[parameters.origin.key] = output;
-	return parameters.reporting.none || allInformation.length === 0 ? parameters.output : allInformation;
-}
-function validateSchematic(schematic, value, parameters, get) {
-	const result = validateObject(value, schematicProperties.get(schematic), parameters, get);
-	return result == null || Array.isArray(result) ? false : true;
-}
-function validateValue(type, value, parameters, get) {
-	switch (true) {
-		case typeof type === "function": return type(value);
-		case Array.isArray(type): {
-			const result = validateObject(value, type, parameters, get);
-			return result == null || Array.isArray(result) ? false : true;
-		}
-		case isSchematic(type): return validateSchematic(type, value, parameters, get);
-		default: return validateNamed(type, value, parameters);
-	}
-}
-const validators = {
-	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 { validateObject };

package/src/validation/property.validation.ts

@@ -1,217 +0,0 @@
-import {isConstructor, isPlainObject} from '@oscarpalmer/atoms/is';
-import type {PlainObject} from '@oscarpalmer/atoms/models';
-import {join} from '@oscarpalmer/atoms/string';
-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,
-	TEMPLATE_PATTERN,
-	TYPE_ALL,
-	TYPE_UNDEFINED,
-	VALIDATABLE_TYPES,
-} from '../constants';
-import {instanceOf, isSchematic} from '../helpers';
-import type {ValueName} from '../models/misc.model';
-import {
-	SchematicError,
-	type ValidatedProperty,
-	type ValidatedPropertyType,
-	type ValidatedPropertyValidators,
-} from '../models/validation.model';
-
-function getDisallowedProperty(obj: PlainObject): string | undefined {
-	if (PROPERTY_REQUIRED in obj) {
-		return PROPERTY_REQUIRED;
-	}
-
-	if (PROPERTY_TYPE in obj) {
-		return PROPERTY_TYPE;
-	}
-
-	if (PROPERTY_VALIDATORS in obj) {
-		return PROPERTY_VALIDATORS;
-	}
-}
-
-export function getProperties(
-	original: PlainObject,
-	prefix?: string,
-	fromType?: boolean,
-): ValidatedProperty[] {
-	if (Object.keys(original).length === 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(
-					TEMPLATE_PATTERN,
-					prefix!,
-				).replace(TEMPLATE_PATTERN, property),
-			);
-		}
-	}
-
-	const keys = Object.keys(original);
-	const keysLength = keys.length;
-
-	const properties: ValidatedProperty[] = [];
-
-	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(
-					TEMPLATE_PATTERN,
-					join([prefix, key], '.'),
-				),
-			);
-		}
-
-		const types: ValidatedPropertyType[] = [];
-
-		let required = true;
-		let validators: ValidatedPropertyValidators = {};
-
-		if (isPlainObject(value)) {
-			required = getRequired(key, value) ?? required;
-			validators = getValidators(value[PROPERTY_VALIDATORS]);
-
-			const hasType = PROPERTY_TYPE in value;
-
-			types.push(...getTypes(key, hasType ? value[PROPERTY_TYPE] : value, prefix, hasType));
-		} else {
-			types.push(...getTypes(key, value, prefix));
-		}
-
-		if (!required && !types.includes(TYPE_UNDEFINED)) {
-			types.push(TYPE_UNDEFINED);
-		}
-
-		properties.push({
-			key,
-			types,
-			validators,
-			required: required && !types.includes(TYPE_UNDEFINED),
-		});
-	}
-
-	return properties;
-}
-
-function getRequired(key: string, obj: PlainObject): boolean | undefined {
-	if (!(PROPERTY_REQUIRED in obj)) {
-		return;
-	}
-
-	if (typeof obj[PROPERTY_REQUIRED] !== 'boolean') {
-		throw new SchematicError(
-			SCHEMATIC_MESSAGE_SCHEMA_INVALID_PROPERTY_REQUIRED.replace(TEMPLATE_PATTERN, key),
-		);
-	}
-
-	return obj[PROPERTY_REQUIRED];
-}
-
-function getTypes(
-	key: string,
-	original: unknown,
-	prefix?: string,
-	fromType?: boolean,
-): ValidatedPropertyType[] {
-	const array = Array.isArray(original) ? original : [original];
-	const {length} = array;
-
-	const types: ValidatedPropertyType[] = [];
-
-	for (let index = 0; index < length; index += 1) {
-		const value = array[index];
-
-		switch (true) {
-			case typeof value === 'function':
-				types.push(isConstructor(value) ? instanceOf(value) : value);
-				break;
-
-			case isPlainObject(value):
-				types.push(getProperties(value, join([prefix, key], '.'), fromType));
-				break;
-
-			case isSchematic(value):
-				types.push(value);
-				break;
-
-			case TYPE_ALL.has(value as never):
-				types.push(value as never);
-				break;
-
-			default:
-				throw new SchematicError(
-					SCHEMATIC_MESSAGE_SCHEMA_INVALID_PROPERTY_TYPE.replace(
-						TEMPLATE_PATTERN,
-						join([prefix, key], '.'),
-					),
-				);
-		}
-	}
-
-	if (types.length === 0) {
-		throw new SchematicError(
-			SCHEMATIC_MESSAGE_SCHEMA_INVALID_PROPERTY_TYPE.replace(
-				TEMPLATE_PATTERN,
-				join([prefix, key], '.'),
-			),
-		);
-	}
-
-	return types;
-}
-
-function getValidators(original: unknown): ValidatedPropertyValidators {
-	const validators: ValidatedPropertyValidators = {};
-
-	if (original == null) {
-		return validators;
-	}
-
-	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 (!VALIDATABLE_TYPES.has(key as never)) {
-			throw new TypeError(SCHEMATIC_MESSAGE_VALIDATOR_INVALID_KEY.replace(TEMPLATE_PATTERN, key));
-		}
-
-		const value = (original as PlainObject)[key];
-
-		validators[key as ValueName] = (Array.isArray(value) ? value : [value]).map(item => {
-			if (typeof item !== 'function') {
-				throw new TypeError(
-					SCHEMATIC_MESSAGE_VALIDATOR_INVALID_VALUE.replace(TEMPLATE_PATTERN, key),
-				);
-			}
-
-			return item;
-		});
-	}
-
-	return validators;
-}

package/src/validation/value.validation.ts

@@ -1,293 +0,0 @@
-import {isPlainObject} from '@oscarpalmer/atoms/is';
-import type {GenericCallback, PlainObject} from '@oscarpalmer/atoms/models';
-import {join} from '@oscarpalmer/atoms/string';
-import {clone} from '@oscarpalmer/atoms/value/clone';
-import {TYPE_OBJECT} from '../constants';
-import {
-	getInvalidInputMessage,
-	getInvalidMissingMessage,
-	getInvalidTypeMessage,
-	getInvalidValidatorMessage,
-	getUnknownKeysMessage,
-	isSchematic,
-} from '../helpers';
-import type {ValueName} from '../models/misc.model';
-import {
-	ValidationError,
-	type ValidatedProperty,
-	type ValidatedPropertyType,
-	type ValidationInformation,
-	type ValidationParameters,
-} from '../models/validation.model';
-import {schematicProperties, type Schematic} from '../schematic';
-
-function validateNamed(name: ValueName, value: unknown, parameters: ValidationParameters): boolean {
-	if (!validators[name](value)) {
-		return false;
-	}
-
-	const propertyValidators = parameters.origin!.validators[name];
-
-	if (propertyValidators == null || propertyValidators.length === 0) {
-		return true;
-	}
-
-	const {length} = propertyValidators;
-
-	for (let index = 0; index < length; index += 1) {
-		const validator = propertyValidators[index];
-
-		if (!validator(value)) {
-			parameters.information!.push({
-				value,
-				key: {
-					full: parameters.prefix!,
-					short: parameters.origin!.key,
-				},
-				message: getInvalidValidatorMessage(parameters.prefix!, name, index, length),
-				validator: validator as GenericCallback,
-			});
-
-			return false;
-		}
-	}
-
-	return true;
-}
-
-export function validateObject(
-	obj: unknown,
-	properties: ValidatedProperty[],
-	parameters: ValidationParameters,
-	get: boolean,
-): PlainObject | ValidationInformation[] | undefined {
-	if (!isPlainObject(obj)) {
-		const key =
-			parameters?.origin == null
-				? {full: '', short: ''}
-				: {
-						full: parameters.prefix!,
-						short: parameters.origin.key,
-					};
-
-		const information = {
-			key,
-			message:
-				parameters?.origin == null
-					? getInvalidInputMessage(obj)
-					: getInvalidTypeMessage(key.full, parameters.origin.types, obj),
-			value: obj,
-		};
-
-		if (parameters.reporting.throw) {
-			throw new ValidationError([information]);
-		}
-
-		parameters?.information?.push(information);
-
-		return parameters.reporting.none ? undefined : [information];
-	}
-
-	if (parameters.strict) {
-		const objKeys = Object.keys(obj);
-
-		const propertiesKeys = new Set(properties.map(property => property.key));
-
-		const unknownKeys = objKeys.filter(key => !propertiesKeys.has(key));
-
-		if (unknownKeys.length > 0) {
-			const key =
-				parameters?.origin == null
-					? {full: '', short: ''}
-					: {
-							full: join([parameters.prefix, parameters.origin?.key], '.'),
-							short: parameters.origin.key,
-						};
-
-			const information: ValidationInformation = {
-				key,
-				message: getUnknownKeysMessage(
-					unknownKeys.map(key => join([parameters?.prefix, key], '.')),
-				),
-				value: obj,
-			};
-
-			if (parameters.reporting.throw) {
-				throw new ValidationError([information]);
-			}
-
-			parameters?.information?.push(information);
-
-			return parameters.reporting.none ? undefined : [information];
-		}
-	}
-
-	const allInformation: ValidationInformation[] = [];
-
-	const output: PlainObject = {};
-
-	const propertiesLength = properties.length;
-
-	outer: for (let propertyIndex = 0; propertyIndex < propertiesLength; propertyIndex += 1) {
-		const property = properties[propertyIndex];
-
-		const {key, required, types} = property;
-
-		const value = obj[key];
-
-		if (get && value === undefined && !required) {
-			// TODO: during get, respect a default value for the property
-
-			continue;
-		}
-
-		if (value === undefined && required) {
-			const prefixedKey = join([parameters.prefix, key], '.');
-
-			const information: ValidationInformation = {
-				value,
-				key: {
-					full: prefixedKey,
-					short: key,
-				},
-				message: getInvalidMissingMessage(prefixedKey, property.types),
-			};
-
-			if (parameters.reporting.throw) {
-				throw new ValidationError([information]);
-			}
-
-			parameters?.information?.push(information);
-
-			if (parameters.reporting.all) {
-				allInformation.push(information);
-
-				continue;
-			}
-
-			return parameters.reporting.none ? undefined : [information];
-		}
-
-		const prefixedKey = join([parameters.prefix, key], '.');
-
-		const typesLength = types.length;
-
-		const information: ValidationInformation[] = [];
-
-		for (let typeIndex = 0; typeIndex < typesLength; typeIndex += 1) {
-			const type = types[typeIndex];
-
-			if (
-				validateValue(
-					type,
-					value,
-					{
-						information,
-						output,
-						origin: property,
-						prefix: prefixedKey,
-						reporting: parameters.reporting,
-						strict: parameters.strict,
-					},
-					get,
-				)
-			) {
-				if (get) {
-					output[key] = clone(value);
-				}
-
-				continue outer;
-			}
-		}
-
-		if (information.length === 0) {
-			information.push({
-				value,
-				key: {
-					full: prefixedKey,
-					short: key,
-				},
-				message: getInvalidTypeMessage(prefixedKey, property.types, value),
-			});
-		}
-
-		if (parameters.reporting.throw) {
-			throw new ValidationError(information);
-		}
-
-		parameters?.information?.push(...information);
-
-		if (parameters.reporting.all) {
-			allInformation.push(...information);
-
-			continue;
-		}
-
-		return parameters.reporting.none ? undefined : information;
-	}
-
-	if (get) {
-		if (parameters.origin == null) {
-			parameters.output = output;
-		} else {
-			parameters.output[parameters.origin.key] = output;
-		}
-	}
-
-	return parameters.reporting.none || allInformation.length === 0
-		? parameters.output
-		: allInformation;
-}
-
-function validateSchematic(
-	schematic: Schematic<unknown>,
-	value: unknown,
-	parameters: ValidationParameters,
-	get: boolean,
-): boolean {
-	const properties = schematicProperties.get(schematic)!;
-
-	const result = validateObject(value, properties, parameters, get);
-
-	return result == null || Array.isArray(result) ? false : true;
-}
-
-function validateValue(
-	type: ValidatedPropertyType,
-	value: unknown,
-	parameters: ValidationParameters,
-	get: boolean,
-): boolean {
-	switch (true) {
-		case typeof type === 'function':
-			return (type as GenericCallback)(value);
-
-		case Array.isArray(type): {
-			const result = validateObject(value, type, parameters, get);
-
-			return result == null || Array.isArray(result) ? false : true;
-		}
-
-		case isSchematic(type):
-			return validateSchematic(type, value, parameters, get);
-
-		default:
-			return validateNamed(type as ValueName, value, parameters);
-	}
-}
-
-//
-
-const validators: Record<ValueName, (value: unknown) => boolean> = {
-	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 === TYPE_OBJECT && value !== null,
-	string: value => typeof value === 'string',
-	symbol: value => typeof value === 'symbol',
-	undefined: value => value === undefined,
-};