@oscarpalmer/jhunal 0.16.0 → 0.18.0

package/dist/constants.d.mts

@@ -1,27 +1,40 @@
-import { Values } from "./models.mjs";
+import { ReportingType } from "./models/validation.model.mjs";
+import { Values } from "./models/misc.model.mjs";
 
 //#region src/constants.d.ts
-declare const ERROR_NAME = "SchematicError";
-declare const EXPRESSION_PROPERTY: RegExp;
 declare const MESSAGE_CONSTRUCTOR = "Expected a constructor function";
-declare const MESSAGE_SCHEMA_INVALID_EMPTY = "Schema must have at least one property";
-declare const MESSAGE_SCHEMA_INVALID_PROPERTY_DISALLOWED = "'<key>.<property>' property is not allowed for schemas in $type";
-declare const MESSAGE_SCHEMA_INVALID_PROPERTY_REQUIRED = "'<>.$required' property must be a boolean";
-declare const MESSAGE_SCHEMA_INVALID_PROPERTY_TYPE = "'<>' property must be of a valid type";
-declare const MESSAGE_SCHEMA_INVALID_TYPE = "Schema must be an object";
-declare const MESSAGE_VALIDATOR_INVALID_KEY = "Validator '<>' does not exist";
-declare const MESSAGE_VALIDATOR_INVALID_TYPE = "Validators must be an object";
-declare const MESSAGE_VALIDATOR_INVALID_VALUE = "Validator '<>' must be a function or an array of functions";
+declare const NAME_SCHEMATIC = "Schematic";
+declare const NAME_ERROR_SCHEMATIC = "SchematicError";
+declare const NAME_ERROR_VALIDATION = "ValidationError";
 declare const PROPERTY_REQUIRED = "$required";
+declare const PROPERTY_SCHEMATIC = "$schematic";
 declare const PROPERTY_TYPE = "$type";
 declare const PROPERTY_VALIDATORS = "$validators";
-declare const SCHEMATIC_NAME = "$schematic";
+declare const VALIDATION_MESSAGE_INVALID_INPUT = "Expected 'object' as input but received <>";
+declare const VALIDATION_MESSAGE_INVALID_REQUIRED = "Expected <> for required property '<>'";
+declare const VALIDATION_MESSAGE_INVALID_TYPE = "Expected <> for '<>' but received <>";
+declare const VALIDATION_MESSAGE_INVALID_VALUE = "Value does not satisfy validator for '<>' and type '<>'";
+declare const VALIDATION_MESSAGE_INVALID_VALUE_SUFFIX = " at index <>";
+declare const REPORTING_ALL: ReportingType;
+declare const REPORTING_FIRST: ReportingType;
+declare const REPORTING_NONE: ReportingType;
+declare const REPORTING_THROW: ReportingType;
+declare const REPORTING_TYPES: Set<ReportingType>;
+declare const SCHEMATIC_MESSAGE_SCHEMA_INVALID_EMPTY = "Schema must have at least one property";
+declare const SCHEMATIC_MESSAGE_SCHEMA_INVALID_PROPERTY_DISALLOWED = "'<>.<>' property is not allowed for schemas in $type";
+declare const SCHEMATIC_MESSAGE_SCHEMA_INVALID_PROPERTY_NULLABLE = "'<>' property must not be 'null' or 'undefined'";
+declare const SCHEMATIC_MESSAGE_SCHEMA_INVALID_PROPERTY_REQUIRED = "'<>.$required' property must be a boolean";
+declare const SCHEMATIC_MESSAGE_SCHEMA_INVALID_PROPERTY_TYPE = "'<>' property must be of a valid type";
+declare const SCHEMATIC_MESSAGE_SCHEMA_INVALID_TYPE = "Schema must be an object";
+declare const SCHEMATIC_MESSAGE_VALIDATOR_INVALID_KEY = "Validator '<>' does not exist";
+declare const SCHEMATIC_MESSAGE_VALIDATOR_INVALID_TYPE = "Validators must be an object";
+declare const SCHEMATIC_MESSAGE_VALIDATOR_INVALID_VALUE = "Validator '<>' must be a function or an array of functions";
 declare const TEMPLATE_PATTERN = "<>";
-declare const TEMPLATE_PATTERN_KEY = "<key>";
-declare const TEMPLATE_PATTERN_PROPERTY = "<property>";
+declare const TYPE_ARRAY = "array";
+declare const TYPE_NULL = "null";
 declare const TYPE_OBJECT = "object";
 declare const TYPE_UNDEFINED = "undefined";
 declare const VALIDATABLE_TYPES: Set<keyof Values>;
 declare const TYPE_ALL: Set<keyof Values>;
 //#endregion
-export { ERROR_NAME, EXPRESSION_PROPERTY, MESSAGE_CONSTRUCTOR, MESSAGE_SCHEMA_INVALID_EMPTY, MESSAGE_SCHEMA_INVALID_PROPERTY_DISALLOWED, MESSAGE_SCHEMA_INVALID_PROPERTY_REQUIRED, MESSAGE_SCHEMA_INVALID_PROPERTY_TYPE, MESSAGE_SCHEMA_INVALID_TYPE, MESSAGE_VALIDATOR_INVALID_KEY, MESSAGE_VALIDATOR_INVALID_TYPE, MESSAGE_VALIDATOR_INVALID_VALUE, PROPERTY_REQUIRED, PROPERTY_TYPE, PROPERTY_VALIDATORS, SCHEMATIC_NAME, TEMPLATE_PATTERN, TEMPLATE_PATTERN_KEY, TEMPLATE_PATTERN_PROPERTY, TYPE_ALL, TYPE_OBJECT, TYPE_UNDEFINED, VALIDATABLE_TYPES };
+export { MESSAGE_CONSTRUCTOR, NAME_ERROR_SCHEMATIC, NAME_ERROR_VALIDATION, NAME_SCHEMATIC, PROPERTY_REQUIRED, PROPERTY_SCHEMATIC, PROPERTY_TYPE, PROPERTY_VALIDATORS, REPORTING_ALL, REPORTING_FIRST, REPORTING_NONE, REPORTING_THROW, REPORTING_TYPES, 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_SCHEMA_INVALID_TYPE, SCHEMATIC_MESSAGE_VALIDATOR_INVALID_KEY, SCHEMATIC_MESSAGE_VALIDATOR_INVALID_TYPE, SCHEMATIC_MESSAGE_VALIDATOR_INVALID_VALUE, TEMPLATE_PATTERN, TYPE_ALL, TYPE_ARRAY, TYPE_NULL, TYPE_OBJECT, TYPE_UNDEFINED, VALIDATABLE_TYPES, VALIDATION_MESSAGE_INVALID_INPUT, VALIDATION_MESSAGE_INVALID_REQUIRED, VALIDATION_MESSAGE_INVALID_TYPE, VALIDATION_MESSAGE_INVALID_VALUE, VALIDATION_MESSAGE_INVALID_VALUE_SUFFIX };

package/dist/constants.mjs

@@ -1,22 +1,39 @@
 //#region src/constants.ts
-const ERROR_NAME = "SchematicError";
-const EXPRESSION_PROPERTY = /(^|\.)\$(required|type|validators)(\.|$)/;
 const MESSAGE_CONSTRUCTOR = "Expected a constructor function";
-const MESSAGE_SCHEMA_INVALID_EMPTY = "Schema must have at least one property";
-const MESSAGE_SCHEMA_INVALID_PROPERTY_DISALLOWED = "'<key>.<property>' property is not allowed for schemas in $type";
-const MESSAGE_SCHEMA_INVALID_PROPERTY_REQUIRED = "'<>.$required' property must be a boolean";
-const MESSAGE_SCHEMA_INVALID_PROPERTY_TYPE = "'<>' property must be of a valid type";
-const MESSAGE_SCHEMA_INVALID_TYPE = "Schema must be an object";
-const MESSAGE_VALIDATOR_INVALID_KEY = "Validator '<>' does not exist";
-const MESSAGE_VALIDATOR_INVALID_TYPE = "Validators must be an object";
-const MESSAGE_VALIDATOR_INVALID_VALUE = "Validator '<>' must be a function or an array of functions";
+const NAME_SCHEMATIC = "Schematic";
+const NAME_ERROR_SCHEMATIC = "SchematicError";
+const NAME_ERROR_VALIDATION = "ValidationError";
 const PROPERTY_REQUIRED = "$required";
+const PROPERTY_SCHEMATIC = "$schematic";
 const PROPERTY_TYPE = "$type";
 const PROPERTY_VALIDATORS = "$validators";
-const SCHEMATIC_NAME = "$schematic";
+const VALIDATION_MESSAGE_INVALID_INPUT = "Expected 'object' as input but received <>";
+const VALIDATION_MESSAGE_INVALID_REQUIRED = "Expected <> for required property '<>'";
+const VALIDATION_MESSAGE_INVALID_TYPE = "Expected <> for '<>' but received <>";
+const VALIDATION_MESSAGE_INVALID_VALUE = "Value does not satisfy validator for '<>' and type '<>'";
+const VALIDATION_MESSAGE_INVALID_VALUE_SUFFIX = " at index <>";
+const REPORTING_ALL = "all";
+const REPORTING_FIRST = "first";
+const REPORTING_NONE = "none";
+const REPORTING_THROW = "throw";
+const REPORTING_TYPES = new Set([
+	"all",
+	REPORTING_FIRST,
+	REPORTING_NONE,
+	REPORTING_THROW
+]);
+const SCHEMATIC_MESSAGE_SCHEMA_INVALID_EMPTY = "Schema must have at least one property";
+const SCHEMATIC_MESSAGE_SCHEMA_INVALID_PROPERTY_DISALLOWED = "'<>.<>' property is not allowed for schemas in $type";
+const SCHEMATIC_MESSAGE_SCHEMA_INVALID_PROPERTY_NULLABLE = "'<>' property must not be 'null' or 'undefined'";
+const SCHEMATIC_MESSAGE_SCHEMA_INVALID_PROPERTY_REQUIRED = "'<>.$required' property must be a boolean";
+const SCHEMATIC_MESSAGE_SCHEMA_INVALID_PROPERTY_TYPE = "'<>' property must be of a valid type";
+const SCHEMATIC_MESSAGE_SCHEMA_INVALID_TYPE = "Schema must be an object";
+const SCHEMATIC_MESSAGE_VALIDATOR_INVALID_KEY = "Validator '<>' does not exist";
+const SCHEMATIC_MESSAGE_VALIDATOR_INVALID_TYPE = "Validators must be an object";
+const SCHEMATIC_MESSAGE_VALIDATOR_INVALID_VALUE = "Validator '<>' must be a function or an array of functions";
 const TEMPLATE_PATTERN = "<>";
-const TEMPLATE_PATTERN_KEY = "<key>";
-const TEMPLATE_PATTERN_PROPERTY = "<property>";
+const TYPE_ARRAY = "array";
+const TYPE_NULL = "null";
 const TYPE_OBJECT = "object";
 const TYPE_UNDEFINED = "undefined";
 const VALIDATABLE_TYPES = new Set([
@@ -36,4 +53,4 @@ const TYPE_ALL = new Set([
 	TYPE_UNDEFINED
 ]);
 //#endregion
-export { ERROR_NAME, EXPRESSION_PROPERTY, MESSAGE_CONSTRUCTOR, MESSAGE_SCHEMA_INVALID_EMPTY, MESSAGE_SCHEMA_INVALID_PROPERTY_DISALLOWED, MESSAGE_SCHEMA_INVALID_PROPERTY_REQUIRED, MESSAGE_SCHEMA_INVALID_PROPERTY_TYPE, MESSAGE_SCHEMA_INVALID_TYPE, MESSAGE_VALIDATOR_INVALID_KEY, MESSAGE_VALIDATOR_INVALID_TYPE, MESSAGE_VALIDATOR_INVALID_VALUE, PROPERTY_REQUIRED, PROPERTY_TYPE, PROPERTY_VALIDATORS, SCHEMATIC_NAME, TEMPLATE_PATTERN, TEMPLATE_PATTERN_KEY, TEMPLATE_PATTERN_PROPERTY, TYPE_ALL, TYPE_OBJECT, TYPE_UNDEFINED, VALIDATABLE_TYPES };
+export { MESSAGE_CONSTRUCTOR, NAME_ERROR_SCHEMATIC, NAME_ERROR_VALIDATION, NAME_SCHEMATIC, PROPERTY_REQUIRED, PROPERTY_SCHEMATIC, PROPERTY_TYPE, PROPERTY_VALIDATORS, REPORTING_ALL, REPORTING_FIRST, REPORTING_NONE, REPORTING_THROW, REPORTING_TYPES, 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_SCHEMA_INVALID_TYPE, SCHEMATIC_MESSAGE_VALIDATOR_INVALID_KEY, SCHEMATIC_MESSAGE_VALIDATOR_INVALID_TYPE, SCHEMATIC_MESSAGE_VALIDATOR_INVALID_VALUE, TEMPLATE_PATTERN, TYPE_ALL, TYPE_ARRAY, TYPE_NULL, TYPE_OBJECT, TYPE_UNDEFINED, VALIDATABLE_TYPES, VALIDATION_MESSAGE_INVALID_INPUT, VALIDATION_MESSAGE_INVALID_REQUIRED, VALIDATION_MESSAGE_INVALID_TYPE, VALIDATION_MESSAGE_INVALID_VALUE, VALIDATION_MESSAGE_INVALID_VALUE_SUFFIX };

package/dist/helpers.d.mts

@@ -1,7 +1,14 @@
+import { ReportingInformation, ValidatedProperty } 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(property: ValidatedProperty): string;
+declare function getInvalidTypeMessage(property: ValidatedProperty, actual: unknown): string;
+declare function getInvalidValidatorMessage(property: ValidatedProperty, type: ValueName, index: number, length: number): string;
+declare function getReporting(value: unknown): ReportingInformation;
 /**
  * Creates a validator function for a given constructor
  * @param constructor - Constructor to check against
@@ -16,4 +23,4 @@ declare function instanceOf<Instance>(constructor: Constructor<Instance>): (valu
  */
 declare function isSchematic(value: unknown): value is Schematic<never>;
 //#endregion
-export { instanceOf, isSchematic };
+export { getInvalidInputMessage, getInvalidMissingMessage, getInvalidTypeMessage, getInvalidValidatorMessage, getReporting, instanceOf, isSchematic };

package/dist/helpers.mjs

@@ -1,6 +1,53 @@
-import { MESSAGE_CONSTRUCTOR } from "./constants.mjs";
-import { isConstructor } from "@oscarpalmer/atoms/is";
+import { 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 } 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(property) {
+	let message = VALIDATION_MESSAGE_INVALID_REQUIRED.replace("<>", renderTypes(property.types));
+	message = message.replace("<>", property.key.full);
+	return message;
+}
+function getInvalidTypeMessage(property, actual) {
+	let message = VALIDATION_MESSAGE_INVALID_TYPE.replace("<>", renderTypes(property.types));
+	message = message.replace("<>", property.key.full);
+	message = message.replace("<>", getValueType(actual));
+	return message;
+}
+function getInvalidValidatorMessage(property, type, index, length) {
+	let message = VALIDATION_MESSAGE_INVALID_VALUE.replace("<>", property.key.full);
+	message = message.replace("<>", type);
+	if (length > 1) message += VALIDATION_MESSAGE_INVALID_VALUE_SUFFIX.replace("<>", String(index));
+	return message;
+}
+function getPropertyType(original) {
+	if (typeof original === "function") return "a validated value";
+	if (Array.isArray(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 {
+		["all"]: type === "all",
+		[REPORTING_FIRST]: type === REPORTING_FIRST,
+		[REPORTING_NONE]: type === REPORTING_NONE,
+		[REPORTING_THROW]: type === REPORTING_THROW
+	};
+}
+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
@@ -21,5 +68,23 @@ function instanceOf(constructor) {
 function isSchematic(value) {
 	return typeof value === "object" && value !== null && "$schematic" in value && value["$schematic"] === true;
 }
+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);
+	}
+	const { length } = parts;
+	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 ? ", or " : " or ";
+	}
+	return rendered;
+}
 //#endregion
-export { instanceOf, isSchematic };
+export { getInvalidInputMessage, getInvalidMissingMessage, getInvalidTypeMessage, getInvalidValidatorMessage, getReporting, instanceOf, isSchematic };