@oscarpalmer/jhunal 0.22.0 → 0.23.0

package/dist/helpers.d.mts

@@ -1,28 +0,0 @@
-import { ReportingInformation, ValidatorParameters, ValidatorType } from "./models/validation.model.mjs";
-import { Schematic } from "./schematic.mjs";
-import { ValueName } from "./models/misc.model.mjs";
-import { Constructor } from "@oscarpalmer/atoms/models";
-
-//#region src/helpers.d.ts
-declare function getInvalidInputMessage(actual: unknown): string;
-declare function getInvalidMissingMessage(key: string, types: ValidatorType[]): string;
-declare function getInvalidTypeMessage(key: string, types: ValidatorType[], actual: unknown): string;
-declare function getInvalidValidatorMessage(key: string, type: ValueName, index: number, length: number): string;
-declare function getParameters(input?: unknown): ValidatorParameters;
-declare function getReporting(value: unknown): ReportingInformation;
-declare function getUnknownKeysMessage(keys: string[]): string;
-/**
- * Creates a validator function for a given constructor
- * @param constructor - Constructor to check against
- * @throws Will throw a `TypeError` if the provided argument is not a valid constructor
- * @returns Validator function that checks if a value is an instance of the constructor
- */
-declare function instanceOf<Instance>(constructor: Constructor<Instance>): (value: unknown) => value is Instance;
-/**
- * Is the value a schematic?
- * @param value Value to check
- * @returns `true` if the value is a schematic, `false` otherwise
- */
-declare function isSchematic(value: unknown): value is Schematic<never>;
-//#endregion
-export { getInvalidInputMessage, getInvalidMissingMessage, getInvalidTypeMessage, getInvalidValidatorMessage, getParameters, getReporting, getUnknownKeysMessage, instanceOf, isSchematic };

package/dist/helpers.mjs

@@ -1,120 +0,0 @@
-import { CONJUNCTION_AND, CONJUNCTION_AND_COMMA, CONJUNCTION_OR, CONJUNCTION_OR_COMMA, MESSAGE_CONSTRUCTOR, NAME_SCHEMATIC, REPORTING_FIRST, REPORTING_NONE, REPORTING_THROW, REPORTING_TYPES, TYPE_ARRAY, TYPE_NULL, TYPE_OBJECT, TYPE_UNDEFINED, VALIDATION_MESSAGE_INVALID_INPUT, VALIDATION_MESSAGE_INVALID_REQUIRED, VALIDATION_MESSAGE_INVALID_TYPE, VALIDATION_MESSAGE_INVALID_VALUE, VALIDATION_MESSAGE_INVALID_VALUE_SUFFIX, VALIDATION_MESSAGE_UNKNOWN_KEYS } from "./constants.mjs";
-import { isConstructor, isPlainObject } from "@oscarpalmer/atoms/is";
-//#region src/helpers.ts
-function getInvalidInputMessage(actual) {
-	return VALIDATION_MESSAGE_INVALID_INPUT.replace("<>", getValueType(actual));
-}
-function getInvalidMissingMessage(key, types) {
-	let message = VALIDATION_MESSAGE_INVALID_REQUIRED.replace("<>", renderTypes(types));
-	message = message.replace("<>", key);
-	return message;
-}
-function getInvalidTypeMessage(key, types, actual) {
-	let message = VALIDATION_MESSAGE_INVALID_TYPE.replace("<>", renderTypes(types));
-	message = message.replace("<>", key);
-	message = message.replace("<>", getValueType(actual));
-	return message;
-}
-function getInvalidValidatorMessage(key, type, index, length) {
-	let message = VALIDATION_MESSAGE_INVALID_VALUE.replace("<>", key);
-	message = message.replace("<>", type);
-	if (length > 1) message += VALIDATION_MESSAGE_INVALID_VALUE_SUFFIX.replace("<>", String(index));
-	return message;
-}
-function getParameters(input) {
-	if (typeof input === "boolean") return {
-		output: {},
-		reporting: getReporting(REPORTING_NONE),
-		strict: input
-	};
-	if (REPORTING_TYPES.has(input)) return {
-		output: {},
-		reporting: getReporting(input),
-		strict: false
-	};
-	const options = isPlainObject(input) ? input : {};
-	return {
-		output: {},
-		reporting: getReporting(options.errors),
-		strict: typeof options.strict === "boolean" ? options.strict : false
-	};
-}
-function getPropertyType(original) {
-	if (typeof original === "function") return "a validated value";
-	if (Array.isArray(original)) return `'array'`;
-	if (isPlainObject(original)) return `'${TYPE_OBJECT}'`;
-	if (isSchematic(original)) return `a ${NAME_SCHEMATIC}`;
-	return `'${String(original)}'`;
-}
-function getReporting(value) {
-	const type = REPORTING_TYPES.has(value) ? value : REPORTING_NONE;
-	return {
-		type,
-		["all"]: type === "all",
-		[REPORTING_FIRST]: type === REPORTING_FIRST,
-		[REPORTING_NONE]: type === REPORTING_NONE,
-		[REPORTING_THROW]: type === REPORTING_THROW
-	};
-}
-function getUnknownKeysMessage(keys) {
-	return VALIDATION_MESSAGE_UNKNOWN_KEYS.replace("<>", renderKeys(keys));
-}
-function getValueType(value) {
-	const valueType = typeof value;
-	switch (true) {
-		case value === null: return `'${TYPE_NULL}'`;
-		case value === void 0: return `'${TYPE_UNDEFINED}'`;
-		case valueType !== TYPE_OBJECT: return `'${valueType}'`;
-		case Array.isArray(value): return `'${TYPE_ARRAY}'`;
-		case isPlainObject(value): return `'${TYPE_OBJECT}'`;
-		case isSchematic(value): return `a ${NAME_SCHEMATIC}`;
-		default: return value.constructor.name;
-	}
-}
-/**
-* Creates a validator function for a given constructor
-* @param constructor - Constructor to check against
-* @throws Will throw a `TypeError` if the provided argument is not a valid constructor
-* @returns Validator function that checks if a value is an instance of the constructor
-*/
-function instanceOf(constructor) {
-	if (!isConstructor(constructor)) throw new TypeError(MESSAGE_CONSTRUCTOR);
-	return (value) => {
-		return value instanceof constructor;
-	};
-}
-/**
-* Is the value a schematic?
-* @param value Value to check
-* @returns `true` if the value is a schematic, `false` otherwise
-*/
-function isSchematic(value) {
-	return typeof value === "object" && value !== null && "$schematic" in value && value["$schematic"] === true;
-}
-function renderKeys(keys) {
-	return renderParts(keys.map((key) => `'${key}'`), CONJUNCTION_AND, CONJUNCTION_AND_COMMA);
-}
-function renderParts(parts, delimiterShort, delimiterLong) {
-	const { length } = parts;
-	if (length === 1) return parts[0];
-	let rendered = "";
-	for (let index = 0; index < length; index += 1) {
-		rendered += parts[index];
-		if (index < length - 2) rendered += ", ";
-		else if (index === length - 2) rendered += parts.length > 2 ? delimiterLong : delimiterShort;
-	}
-	return rendered;
-}
-function renderTypes(types) {
-	const unique = /* @__PURE__ */ new Set();
-	const parts = [];
-	for (let index = 0; index < types.length; index += 1) {
-		const rendered = getPropertyType(types[index]);
-		if (unique.has(rendered)) continue;
-		unique.add(rendered);
-		parts.push(rendered);
-	}
-	return renderParts(parts, CONJUNCTION_OR, CONJUNCTION_OR_COMMA);
-}
-//#endregion
-export { getInvalidInputMessage, getInvalidMissingMessage, getInvalidTypeMessage, getInvalidValidatorMessage, getParameters, getReporting, getUnknownKeysMessage, instanceOf, isSchematic };

package/dist/validation.d.mts

@@ -1,7 +0,0 @@
-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/src/helpers.ts

@@ -1,249 +0,0 @@
-import {isConstructor, isPlainObject} from '@oscarpalmer/atoms/is';
-import type {Constructor} from '@oscarpalmer/atoms/models';
-import {
-	COMMA,
-	CONJUNCTION_AND,
-	CONJUNCTION_AND_COMMA,
-	CONJUNCTION_OR,
-	CONJUNCTION_OR_COMMA,
-	MESSAGE_CONSTRUCTOR,
-	NAME_SCHEMATIC,
-	PROPERTY_SCHEMATIC,
-	REPORTING_ALL,
-	REPORTING_FIRST,
-	REPORTING_NONE,
-	REPORTING_THROW,
-	REPORTING_TYPES,
-	TEMPLATE_PATTERN,
-	TYPE_ARRAY,
-	TYPE_NULL,
-	TYPE_OBJECT,
-	TYPE_UNDEFINED,
-	VALIDATION_MESSAGE_INVALID_INPUT,
-	VALIDATION_MESSAGE_INVALID_REQUIRED,
-	VALIDATION_MESSAGE_INVALID_TYPE,
-	VALIDATION_MESSAGE_INVALID_VALUE,
-	VALIDATION_MESSAGE_INVALID_VALUE_SUFFIX,
-	VALIDATION_MESSAGE_UNKNOWN_KEYS,
-} from './constants';
-import type {ValueName} from './models/misc.model';
-import type {
-	ReportingInformation,
-	ReportingType,
-	ValidatorParameters,
-	ValidatorType,
-} from './models/validation.model';
-import type {Schematic} from './schematic';
-
-export function getInvalidInputMessage(actual: unknown): string {
-	return VALIDATION_MESSAGE_INVALID_INPUT.replace(TEMPLATE_PATTERN, getValueType(actual));
-}
-
-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);
-
-	return message;
-}
-
-export function getInvalidTypeMessage(
-	key: string,
-	types: ValidatorType[],
-	actual: unknown,
-): string {
-	let message = VALIDATION_MESSAGE_INVALID_TYPE.replace(TEMPLATE_PATTERN, renderTypes(types));
-
-	message = message.replace(TEMPLATE_PATTERN, key);
-	message = message.replace(TEMPLATE_PATTERN, getValueType(actual));
-
-	return message;
-}
-
-export function getInvalidValidatorMessage(
-	key: string,
-	type: ValueName,
-	index: number,
-	length: number,
-): string {
-	let message = VALIDATION_MESSAGE_INVALID_VALUE.replace(TEMPLATE_PATTERN, key);
-
-	message = message.replace(TEMPLATE_PATTERN, type);
-
-	if (length > 1) {
-		message += VALIDATION_MESSAGE_INVALID_VALUE_SUFFIX.replace(TEMPLATE_PATTERN, String(index));
-	}
-
-	return message;
-}
-
-export function getParameters(input?: unknown): ValidatorParameters {
-	if (typeof input === 'boolean') {
-		return {
-			output: {},
-			reporting: getReporting(REPORTING_NONE),
-			strict: input,
-		};
-	}
-
-	if (REPORTING_TYPES.has(input as ReportingType)) {
-		return {
-			output: {},
-			reporting: getReporting(input as ReportingType),
-			strict: false,
-		};
-	}
-
-	const options = isPlainObject(input) ? input : {};
-
-	return {
-		output: {},
-		reporting: getReporting(options.errors),
-		strict: typeof options.strict === 'boolean' ? options.strict : false,
-	};
-}
-
-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}'`;
-	}
-
-	if (isSchematic(original)) {
-		return `a ${NAME_SCHEMATIC}`;
-	}
-
-	return `'${String(original)}'`;
-}
-
-export function getReporting(value: unknown): ReportingInformation {
-	const type = REPORTING_TYPES.has(value as ReportingType)
-		? (value as ReportingType)
-		: REPORTING_NONE;
-
-	return {
-		type,
-		[REPORTING_ALL]: type === REPORTING_ALL,
-		[REPORTING_FIRST]: type === REPORTING_FIRST,
-		[REPORTING_NONE]: type === REPORTING_NONE,
-		[REPORTING_THROW]: type === REPORTING_THROW,
-	} as ReportingInformation;
-}
-
-export function getUnknownKeysMessage(keys: string[]): string {
-	return VALIDATION_MESSAGE_UNKNOWN_KEYS.replace(TEMPLATE_PATTERN, renderKeys(keys));
-}
-
-function getValueType(value: unknown): string {
-	const valueType = typeof value;
-
-	switch (true) {
-		case value === null:
-			return `'${TYPE_NULL}'`;
-
-		case value === undefined:
-			return `'${TYPE_UNDEFINED}'`;
-
-		case valueType !== TYPE_OBJECT:
-			return `'${valueType}'`;
-
-		case Array.isArray(value):
-			return `'${TYPE_ARRAY}'`;
-
-		case isPlainObject(value):
-			return `'${TYPE_OBJECT}'`;
-
-		case isSchematic(value):
-			return `a ${NAME_SCHEMATIC}`;
-
-		default:
-			return value.constructor.name;
-	}
-}
-
-/**
- * Creates a validator function for a given constructor
- * @param constructor - Constructor to check against
- * @throws Will throw a `TypeError` if the provided argument is not a valid constructor
- * @returns Validator function that checks if a value is an instance of the constructor
- */
-export function instanceOf<Instance>(
-	constructor: Constructor<Instance>,
-): (value: unknown) => value is Instance {
-	if (!isConstructor(constructor)) {
-		throw new TypeError(MESSAGE_CONSTRUCTOR);
-	}
-
-	return (value: unknown): value is Instance => {
-		return value instanceof constructor;
-	};
-}
-
-/**
- * Is the value a schematic?
- * @param value Value to check
- * @returns `true` if the value is a schematic, `false` otherwise
- */
-export function isSchematic(value: unknown): value is Schematic<never> {
-	return (
-		typeof value === 'object' &&
-		value !== null &&
-		PROPERTY_SCHEMATIC in value &&
-		value[PROPERTY_SCHEMATIC] === true
-	);
-}
-
-function renderKeys(keys: string[]): string {
-	return renderParts(
-		keys.map(key => `'${key}'`),
-		CONJUNCTION_AND,
-		CONJUNCTION_AND_COMMA,
-	);
-}
-
-function renderParts(parts: string[], delimiterShort: string, delimiterLong: string): string {
-	const {length} = parts;
-
-	if (length === 1) {
-		return parts[0];
-	}
-
-	let rendered = '';
-
-	for (let index = 0; index < length; index += 1) {
-		rendered += parts[index];
-
-		if (index < length - 2) {
-			rendered += COMMA;
-		} else if (index === length - 2) {
-			rendered += parts.length > 2 ? delimiterLong : delimiterShort;
-		}
-	}
-
-	return rendered;
-}
-
-function renderTypes(types: ValidatorType[]): string {
-	const unique = new Set<string>();
-	const parts: string[] = [];
-
-	for (let index = 0; index < types.length; index += 1) {
-		const rendered = getPropertyType(types[index]);
-
-		if (unique.has(rendered)) {
-			continue;
-		}
-
-		unique.add(rendered);
-		parts.push(rendered);
-	}
-
-	return renderParts(parts, CONJUNCTION_OR, CONJUNCTION_OR_COMMA);
-}