@oscarpalmer/jhunal 0.14.0 → 0.15.0

package/dist/helpers.js

@@ -1,11 +1,22 @@
 import { MESSAGE_CONSTRUCTOR } from "./constants.js";
 import { isConstructor } from "@oscarpalmer/atoms/is";
+/**
+* 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;
 }

package/dist/index.js

@@ -1,4 +1,4 @@
-import { instanceOf } from "./helpers.js";
+import { instanceOf, isSchematic } from "./helpers.js";
 import { SchematicError } from "./models.js";
 import { schematic } from "./schematic.js";
-export { SchematicError, instanceOf, schematic };
+export { SchematicError, instanceOf, isSchematic, schematic };

package/dist/jhunal.full.js

@@ -86,15 +86,34 @@ const TYPE_ALL = new Set([
 	"null",
 	TYPE_UNDEFINED
 ]);
+/**
+* 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_NAME in value && value[SCHEMATIC_NAME] === true;
 }
+/**
+* A custom error class for schema validation failures, with its `name` set to {@link ERROR_NAME}
+*
+* @example
+* ```ts
+* throw new SchematicError('Expected a string, received a number');
+* ```
+*/
 var SchematicError = class extends Error {
 	constructor(message) {
 		super(message);
@@ -234,6 +253,8 @@ var Schematic = class {
 	}
 	/**
 	* Does the value match the schema?
+	* @param value - Value to validate
+	* @returns `true` if the value matches the schema, otherwise `false`
 	*/
 	is(value) {
 		return validateObject(value, this.#properties);
@@ -244,4 +265,4 @@ function schematic(schema) {
 	if (!isPlainObject(schema)) throw new SchematicError(MESSAGE_SCHEMA_INVALID_TYPE);
 	return new Schematic(getProperties(schema));
 }
-export { SchematicError, instanceOf, schematic };
+export { SchematicError, instanceOf, isSchematic, schematic };

package/dist/models.js

@@ -1,4 +1,12 @@
 import { ERROR_NAME } from "./constants.js";
+/**
+* A custom error class for schema validation failures, with its `name` set to {@link ERROR_NAME}
+*
+* @example
+* ```ts
+* throw new SchematicError('Expected a string, received a number');
+* ```
+*/
 var SchematicError = class extends Error {
 	constructor(message) {
 		super(message);

package/dist/schematic.js

@@ -15,6 +15,8 @@ var Schematic = class {
 	}
 	/**
 	* Does the value match the schema?
+	* @param value - Value to validate
+	* @returns `true` if the value matches the schema, otherwise `false`
 	*/
 	is(value) {
 		return validateObject(value, this.#properties);

package/dist/validation/property.validation.js

@@ -1,8 +1,8 @@
 import { EXPRESSION_PROPERTY, MESSAGE_SCHEMA_INVALID_EMPTY, MESSAGE_SCHEMA_INVALID_PROPERTY_DISALLOWED, MESSAGE_SCHEMA_INVALID_PROPERTY_REQUIRED, MESSAGE_SCHEMA_INVALID_PROPERTY_TYPE, MESSAGE_VALIDATOR_INVALID_KEY, MESSAGE_VALIDATOR_INVALID_TYPE, MESSAGE_VALIDATOR_INVALID_VALUE, PROPERTY_REQUIRED, PROPERTY_TYPE, PROPERTY_VALIDATORS, TEMPLATE_PATTERN_KEY, TEMPLATE_PATTERN_PROPERTY, TYPE_ALL, TYPE_OBJECT, TYPE_UNDEFINED, VALIDATABLE_TYPES } from "../constants.js";
 import { instanceOf, isSchematic } from "../helpers.js";
 import { SchematicError } from "../models.js";
-import { join } from "../node_modules/@oscarpalmer/atoms/dist/internal/string.js";
 import { isConstructor, isPlainObject } from "@oscarpalmer/atoms/is";
+import { join } from "@oscarpalmer/atoms/string/misc";
 function getDisallowedProperty(obj) {
 	if ("$required" in obj) return PROPERTY_REQUIRED;
 	if ("$type" in obj) return PROPERTY_TYPE;

package/package.json

@@ -45,5 +45,5 @@
 	},
 	"type": "module",
 	"types": "./types/index.d.ts",
-	"version": "0.14.0"
+	"version": "0.15.0"
 }

package/src/helpers.ts

@@ -1,8 +1,14 @@
 import {isConstructor} from '@oscarpalmer/atoms/is';
+import type {Constructor} from '@oscarpalmer/atoms/models';
 import {MESSAGE_CONSTRUCTOR, SCHEMATIC_NAME} from './constants';
-import type {Constructor} from './models';
 import type {Schematic} from './schematic';
 
+/**
+ * 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 {
@@ -15,6 +21,11 @@ export function instanceOf<Instance>(
 	};
 }
 
+/**
+ * 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' &&

package/src/index.ts

@@ -1,3 +1,3 @@
-export {instanceOf} from './helpers';
+export {instanceOf, isSchematic} from './helpers';
 export {SchematicError, type Schema, type TypedSchema} from './models';
 export {schematic, type Schematic} from './schematic';