@oscarpalmer/jhunal 0.13.0 → 0.15.0

package/types/schematic.d.ts

@@ -9,14 +9,24 @@ export declare class Schematic<Model> {
     constructor(properties: ValidatedProperty[]);
     /**
      * Does the value match the schema?
+     * @param value - Value to validate
+     * @returns `true` if the value matches the schema, otherwise `false`
      */
     is(value: unknown): value is Model;
 }
 /**
  * Create a schematic from a schema
+ * @template Model - Schema type
+ * @param schema - Schema to create the schematic from
+ * @throws Throws {@link SchematicError} if the schema can not be converted into a schematic
+ * @returns A schematic for the given schema
  */
 export declare function schematic<Model extends Schema>(schema: Model): Schematic<Infer<Model>>;
 /**
  * Create a schematic from a typed schema
+ * @template Model - Existing type
+ * @param schema - Typed schema to create the schematic from
+ * @throws Throws {@link SchematicError} if the schema can not be converted into a schematic
+ * @returns A schematic for the given typed schema
  */
 export declare function schematic<Model extends PlainObject>(schema: TypedSchema<Model>): Schematic<Model>;

package/types/validation/property.validation.d.ts

@@ -1,3 +1,3 @@
 import type { PlainObject } from '@oscarpalmer/atoms/models';
 import { type ValidatedProperty } from '../models';
-export declare function getProperties(original: PlainObject, prefix?: string, fromTypes?: boolean): ValidatedProperty[];
+export declare function getProperties(original: PlainObject, prefix?: string, fromType?: boolean): ValidatedProperty[];

package/dist/node_modules/@oscarpalmer/atoms/dist/internal/array/compact.js

@@ -1,12 +0,0 @@
-function compact(array, strict) {
-	if (!Array.isArray(array)) return [];
-	if (strict === true) return array.filter(Boolean);
-	const { length } = array;
-	const compacted = [];
-	for (let index = 0; index < length; index += 1) {
-		const item = array[index];
-		if (item != null) compacted.push(item);
-	}
-	return compacted;
-}
-export { compact };

package/dist/node_modules/@oscarpalmer/atoms/dist/internal/string.js

@@ -1,24 +0,0 @@
-import { compact } from "./array/compact.js";
-/**
-* Get the string value from any value
-* @param value Original value
-* @returns String representation of the value
-*/
-function getString(value) {
-	if (typeof value === "string") return value;
-	if (value == null) return "";
-	if (typeof value === "function") return getString(value());
-	if (typeof value !== "object") return String(value);
-	const asString = String(value.valueOf?.() ?? value);
-	return asString.startsWith("[object ") ? JSON.stringify(value) : asString;
-}
-/**
-* Join an array of values into a string
-* @param value Array of values
-* @param delimiter Delimiter to use between values
-* @returns Joined string
-*/
-function join(value, delimiter) {
-	return compact(value).map(getString).join(typeof delimiter === "string" ? delimiter : "");
-}
-export { join };