@oscarpalmer/jhunal 0.16.0 → 0.17.0

package/dist/constants.d.mts

@@ -2,10 +2,10 @@ import { Values } from "./models.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_NULLABLE = "'<>' property must not be 'null' or 'undefined'";
 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";
@@ -24,4 +24,4 @@ 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 { ERROR_NAME, MESSAGE_CONSTRUCTOR, MESSAGE_SCHEMA_INVALID_EMPTY, MESSAGE_SCHEMA_INVALID_PROPERTY_DISALLOWED, MESSAGE_SCHEMA_INVALID_PROPERTY_NULLABLE, 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 };

package/dist/constants.mjs

@@ -1,9 +1,9 @@
 //#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_NULLABLE = "'<>' property must not be 'null' or 'undefined'";
 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";
@@ -36,4 +36,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 { ERROR_NAME, MESSAGE_CONSTRUCTOR, MESSAGE_SCHEMA_INVALID_EMPTY, MESSAGE_SCHEMA_INVALID_PROPERTY_DISALLOWED, MESSAGE_SCHEMA_INVALID_PROPERTY_NULLABLE, 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 };

package/dist/index.d.mts

@@ -83,7 +83,7 @@ type InferSchemaEntry<Value> = Value extends (infer Item)[] ? InferSchemaEntryVa
  *
  * @template Value - single schema entry
  */
-type InferSchemaEntryValue<Value> = Value extends Constructor<infer Instance> ? Instance : Value extends Schematic<infer Model> ? Model : Value extends SchemaProperty ? InferPropertyType<Value['$type']> : Value extends NestedSchema ? Infer<Omit<Value, '$required'>> : Value extends ValueName ? Values[Value & ValueName] : Value extends Schema ? Infer<Value> : never;
+type InferSchemaEntryValue<Value> = Value extends Constructor<infer Instance> ? Instance : Value extends Schematic<infer Model> ? Model : Value extends SchemaProperty ? InferPropertyType<Value['$type']> : Value extends PlainSchema ? Infer<Value & Schema> : Value extends ValueName ? Values[Value & ValueName] : Value extends Schema ? Infer<Value> : never;
 /**
  * Determines whether a schema entry is optional
  *
@@ -91,11 +91,7 @@ type InferSchemaEntryValue<Value> = Value extends Constructor<infer Instance> ?
  *
  * @template Value - Schema entry to check
  */
-type IsOptionalProperty<Value> = Value extends SchemaProperty ? Value['$required'] extends false ? true : false : Value extends {
-  $required?: boolean;
-} ? Value extends {
-  $required: false;
-} ? true : false : false;
+type IsOptionalProperty<Value> = Value extends SchemaProperty ? Value['$required'] extends false ? true : false : false;
 /**
  * Extracts the last member from a union type by leveraging intersection of function return types
  *
@@ -114,24 +110,6 @@ type MapToValueTypes<Value extends unknown[]> = Value extends [infer Head, ...in
  * @template Value - Tuple of types to map
  */
 type MapToSchemaPropertyTypes<Value extends unknown[]> = Value extends [infer Head, ...infer Tail] ? [ToSchemaPropertyTypeEach<Head>, ...MapToSchemaPropertyTypes<Tail>] : [];
-/**
- * A nested schema definition that may include a `$required` flag alongside arbitrary string-keyed properties
- *
- * @example
- * ```ts
- * const address: NestedSchema = {
- *   $required: false,
- *   street: 'string',
- *   city: 'string',
- * };
- * ```
- */
-type NestedSchema = {
-  /**
-   * Whether the nested schema is required (defaults to `true`)
-   */
-  $required?: boolean;
-} & Schema;
 /**
  * Extracts keys from an object type that are optional
  *
@@ -142,7 +120,11 @@ type OptionalKeys<Value> = { [Key in keyof Value]-?: {} extends Pick<Value, Key>
  * A generic schema allowing {@link NestedSchema}, {@link SchemaEntry}, or arrays of {@link SchemaEntry} as values
  */
 type PlainSchema = {
-  [key: string]: NestedSchema | SchemaEntry | SchemaEntry[];
+  [key: string]: PlainSchema | SchemaEntry | SchemaEntry[] | undefined;
+} & {
+  $required?: never;
+  $type?: never;
+  $validators?: never;
 };
 /**
  * A map of optional validator functions keyed by {@link ValueName}, used to add custom validation to {@link SchemaProperty} definitions
@@ -183,12 +165,12 @@ type Schema = SchemaIndex;
  *
  * Can be a {@link Constructor}, nested {@link Schema}, {@link SchemaProperty}, {@link Schematic}, {@link ValueName} string, or a custom validator function
  */
-type SchemaEntry = Constructor | Schema | SchemaProperty | Schematic<unknown> | ValueName | ((value: unknown) => boolean);
+type SchemaEntry = Constructor | PlainSchema | SchemaProperty | Schematic<unknown> | ValueName | ((value: unknown) => boolean);
 /**
  * Index signature interface backing {@link Schema}, allowing string-keyed entries of {@link NestedSchema}, {@link SchemaEntry}, or arrays of {@link SchemaEntry}
  */
 interface SchemaIndex {
-  [key: string]: NestedSchema | SchemaEntry | SchemaEntry[];
+  [key: string]: PlainSchema | SchemaEntry | SchemaEntry[];
 }
 /**
  * A property definition with explicit type(s), an optional requirement flag, and optional validators
@@ -226,12 +208,7 @@ type SchemaProperty = {
  */
 type SchemaPropertyType = Constructor | PlainSchema | Schematic<unknown> | ValueName | ((value: unknown) => boolean);
 /**
- * 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');
- * ```
+ * A custom error class for schematic validation failures
  */
 declare class SchematicError extends Error {
   constructor(message: string);
@@ -251,7 +228,7 @@ type ToSchemaPropertyType<Value> = UnwrapSingle<DeduplicateTuple<MapToSchemaProp
  *
  * @template Value - type to convert
  */
-type ToSchemaPropertyTypeEach<Value> = Value extends NestedSchema ? Omit<Value, '$required'> : Value extends PlainObject ? TypedSchema<Value> : ToValueType<Value>;
+type ToSchemaPropertyTypeEach<Value> = Value extends PlainObject ? TypedSchema<Value> : ToValueType<Value>;
 /**
  * Converts a type into its corresponding {@link ValueName}-representation
  *
@@ -513,23 +490,23 @@ declare class Schematic<Model> {
   constructor(properties: ValidatedProperty[]);
   /**
    * Does the value match the schema?
-   * @param value - Value to validate
+   * @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
+ * @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
  */
 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
+ * @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
  */

package/dist/index.mjs

@@ -2,10 +2,10 @@ import { isConstructor, isPlainObject } from "@oscarpalmer/atoms/is";
 import { join } from "@oscarpalmer/atoms/string";
 //#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_NULLABLE = "'<>' property must not be 'null' or 'undefined'";
 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";
@@ -61,12 +61,7 @@ function isSchematic(value) {
 //#endregion
 //#region src/models.ts
 /**
-* 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');
-* ```
+* A custom error class for schematic validation failures
 */
 var SchematicError = class extends Error {
 	constructor(message) {
@@ -92,8 +87,8 @@ function getProperties(original, prefix, fromType) {
 	const properties = [];
 	for (let keyIndex = 0; keyIndex < keysLength; keyIndex += 1) {
 		const key = keys[keyIndex];
-		if (EXPRESSION_PROPERTY.test(key)) continue;
 		const value = original[key];
+		if (value == null) throw new SchematicError(MESSAGE_SCHEMA_INVALID_PROPERTY_NULLABLE.replace("<>", join([prefix, key], ".")));
 		const types = [];
 		let required = true;
 		let validators = {};
@@ -213,7 +208,7 @@ var Schematic = class {
 	}
 	/**
 	* Does the value match the schema?
-	* @param value - Value to validate
+	* @param value Value to validate
 	* @returns `true` if the value matches the schema, otherwise `false`
 	*/
 	is(value) {

package/dist/models.d.mts

@@ -84,7 +84,7 @@ type InferSchemaEntry<Value> = Value extends (infer Item)[] ? InferSchemaEntryVa
  *
  * @template Value - single schema entry
  */
-type InferSchemaEntryValue<Value> = Value extends Constructor<infer Instance> ? Instance : Value extends Schematic<infer Model> ? Model : Value extends SchemaProperty ? InferPropertyType<Value['$type']> : Value extends NestedSchema ? Infer<Omit<Value, '$required'>> : Value extends ValueName ? Values[Value & ValueName] : Value extends Schema ? Infer<Value> : never;
+type InferSchemaEntryValue<Value> = Value extends Constructor<infer Instance> ? Instance : Value extends Schematic<infer Model> ? Model : Value extends SchemaProperty ? InferPropertyType<Value['$type']> : Value extends PlainSchema ? Infer<Value & Schema> : Value extends ValueName ? Values[Value & ValueName] : Value extends Schema ? Infer<Value> : never;
 /**
  * Determines whether a schema entry is optional
  *
@@ -92,11 +92,7 @@ type InferSchemaEntryValue<Value> = Value extends Constructor<infer Instance> ?
  *
  * @template Value - Schema entry to check
  */
-type IsOptionalProperty<Value> = Value extends SchemaProperty ? Value['$required'] extends false ? true : false : Value extends {
-  $required?: boolean;
-} ? Value extends {
-  $required: false;
-} ? true : false : false;
+type IsOptionalProperty<Value> = Value extends SchemaProperty ? Value['$required'] extends false ? true : false : false;
 /**
  * Extracts the last member from a union type by leveraging intersection of function return types
  *
@@ -115,24 +111,6 @@ type MapToValueTypes<Value extends unknown[]> = Value extends [infer Head, ...in
  * @template Value - Tuple of types to map
  */
 type MapToSchemaPropertyTypes<Value extends unknown[]> = Value extends [infer Head, ...infer Tail] ? [ToSchemaPropertyTypeEach<Head>, ...MapToSchemaPropertyTypes<Tail>] : [];
-/**
- * A nested schema definition that may include a `$required` flag alongside arbitrary string-keyed properties
- *
- * @example
- * ```ts
- * const address: NestedSchema = {
- *   $required: false,
- *   street: 'string',
- *   city: 'string',
- * };
- * ```
- */
-type NestedSchema = {
-  /**
-   * Whether the nested schema is required (defaults to `true`)
-   */
-  $required?: boolean;
-} & Schema;
 /**
  * Extracts keys from an object type that are optional
  *
@@ -143,7 +121,11 @@ type OptionalKeys<Value> = { [Key in keyof Value]-?: {} extends Pick<Value, Key>
  * A generic schema allowing {@link NestedSchema}, {@link SchemaEntry}, or arrays of {@link SchemaEntry} as values
  */
 type PlainSchema = {
-  [key: string]: NestedSchema | SchemaEntry | SchemaEntry[];
+  [key: string]: PlainSchema | SchemaEntry | SchemaEntry[] | undefined;
+} & {
+  $required?: never;
+  $type?: never;
+  $validators?: never;
 };
 /**
  * A map of optional validator functions keyed by {@link ValueName}, used to add custom validation to {@link SchemaProperty} definitions
@@ -184,12 +166,12 @@ type Schema = SchemaIndex;
  *
  * Can be a {@link Constructor}, nested {@link Schema}, {@link SchemaProperty}, {@link Schematic}, {@link ValueName} string, or a custom validator function
  */
-type SchemaEntry = Constructor | Schema | SchemaProperty | Schematic<unknown> | ValueName | ((value: unknown) => boolean);
+type SchemaEntry = Constructor | PlainSchema | SchemaProperty | Schematic<unknown> | ValueName | ((value: unknown) => boolean);
 /**
  * Index signature interface backing {@link Schema}, allowing string-keyed entries of {@link NestedSchema}, {@link SchemaEntry}, or arrays of {@link SchemaEntry}
  */
 interface SchemaIndex {
-  [key: string]: NestedSchema | SchemaEntry | SchemaEntry[];
+  [key: string]: PlainSchema | SchemaEntry | SchemaEntry[];
 }
 /**
  * A property definition with explicit type(s), an optional requirement flag, and optional validators
@@ -227,12 +209,7 @@ type SchemaProperty = {
  */
 type SchemaPropertyType = Constructor | PlainSchema | Schematic<unknown> | ValueName | ((value: unknown) => boolean);
 /**
- * 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');
- * ```
+ * A custom error class for schematic validation failures
  */
 declare class SchematicError extends Error {
   constructor(message: string);
@@ -252,7 +229,7 @@ type ToSchemaPropertyType<Value> = UnwrapSingle<DeduplicateTuple<MapToSchemaProp
  *
  * @template Value - type to convert
  */
-type ToSchemaPropertyTypeEach<Value> = Value extends NestedSchema ? Omit<Value, '$required'> : Value extends PlainObject ? TypedSchema<Value> : ToValueType<Value>;
+type ToSchemaPropertyTypeEach<Value> = Value extends PlainObject ? TypedSchema<Value> : ToValueType<Value>;
 /**
  * Converts a type into its corresponding {@link ValueName}-representation
  *
@@ -504,4 +481,4 @@ type Values = {
   undefined: undefined;
 };
 //#endregion
-export { Infer, NestedSchema, Schema, SchemaProperty, SchematicError, TypedPropertyOptional, TypedPropertyRequired, TypedSchema, ValidatedProperty, ValidatedPropertyType, ValidatedPropertyValidators, ValueName, Values };
+export { Infer, Schema, SchemaProperty, SchematicError, TypedPropertyOptional, TypedPropertyRequired, TypedSchema, ValidatedProperty, ValidatedPropertyType, ValidatedPropertyValidators, ValueName, Values };

package/dist/models.mjs

@@ -1,12 +1,7 @@
 import { ERROR_NAME } from "./constants.mjs";
 //#region src/models.ts
 /**
-* 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');
-* ```
+* A custom error class for schematic validation failures
 */
 var SchematicError = class extends Error {
 	constructor(message) {

package/dist/schematic.d.mts

@@ -11,23 +11,23 @@ declare class Schematic<Model> {
   constructor(properties: ValidatedProperty[]);
   /**
    * Does the value match the schema?
-   * @param value - Value to validate
+   * @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
+ * @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
  */
 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
+ * @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
  */

package/dist/schematic.mjs

@@ -16,7 +16,7 @@ var Schematic = class {
 	}
 	/**
 	* Does the value match the schema?
-	* @param value - Value to validate
+	* @param value Value to validate
 	* @returns `true` if the value matches the schema, otherwise `false`
 	*/
 	is(value) {

package/dist/validation/property.validation.mjs

@@ -1,4 +1,4 @@
-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.mjs";
+import { MESSAGE_SCHEMA_INVALID_EMPTY, MESSAGE_SCHEMA_INVALID_PROPERTY_DISALLOWED, MESSAGE_SCHEMA_INVALID_PROPERTY_NULLABLE, 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.mjs";
 import { instanceOf, isSchematic } from "../helpers.mjs";
 import { SchematicError } from "../models.mjs";
 import { isConstructor, isPlainObject } from "@oscarpalmer/atoms/is";
@@ -20,8 +20,8 @@ function getProperties(original, prefix, fromType) {
 	const properties = [];
 	for (let keyIndex = 0; keyIndex < keysLength; keyIndex += 1) {
 		const key = keys[keyIndex];
-		if (EXPRESSION_PROPERTY.test(key)) continue;
 		const value = original[key];
+		if (value == null) throw new SchematicError(MESSAGE_SCHEMA_INVALID_PROPERTY_NULLABLE.replace("<>", join([prefix, key], ".")));
 		const types = [];
 		let required = true;
 		let validators = {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@oscarpalmer/jhunal",
-  "version": "0.16.0",
+  "version": "0.17.0",
   "description": "Flies free beneath the glistening moons…",
   "keywords": [
     "schema",
@@ -38,7 +38,7 @@
     "watch": "npx vite build --watch"
   },
   "dependencies": {
-    "@oscarpalmer/atoms": "^0.166"
+    "@oscarpalmer/atoms": "^0.168"
   },
   "devDependencies": {
     "@types/node": "^25.5",
@@ -51,4 +51,4 @@
     "vitest": "npm:@voidzero-dev/vite-plus-test@latest"
   },
   "packageManager": "npm@11.11.1"
-}
+}

package/src/constants.ts

@@ -2,8 +2,6 @@ import type {ValueName} from './models';
 
 export const ERROR_NAME = 'SchematicError';
 
-export const EXPRESSION_PROPERTY = /(^|\.)\$(required|type|validators)(\.|$)/;
-
 export const MESSAGE_CONSTRUCTOR = 'Expected a constructor function';
 
 export const MESSAGE_SCHEMA_INVALID_EMPTY = 'Schema must have at least one property';
@@ -11,6 +9,9 @@ export const MESSAGE_SCHEMA_INVALID_EMPTY = 'Schema must have at least one prope
 export const MESSAGE_SCHEMA_INVALID_PROPERTY_DISALLOWED =
 	"'<key>.<property>' property is not allowed for schemas in $type";
 
+export const MESSAGE_SCHEMA_INVALID_PROPERTY_NULLABLE =
+	"'<>' property must not be 'null' or 'undefined'";
+
 export const MESSAGE_SCHEMA_INVALID_PROPERTY_REQUIRED = "'<>.$required' property must be a boolean";
 
 export const MESSAGE_SCHEMA_INVALID_PROPERTY_TYPE = "'<>' property must be of a valid type";

package/src/models.ts

@@ -135,8 +135,8 @@ type InferSchemaEntryValue<Value> =
 			? Model
 			: Value extends SchemaProperty
 				? InferPropertyType<Value['$type']>
-				: Value extends NestedSchema
-					? Infer<Omit<Value, '$required'>>
+				: Value extends PlainSchema
+					? Infer<Value & Schema>
 					: Value extends ValueName
 						? Values[Value & ValueName]
 						: Value extends Schema
@@ -154,11 +154,7 @@ type IsOptionalProperty<Value> = Value extends SchemaProperty
 	? Value['$required'] extends false
 		? true
 		: false
-	: Value extends {$required?: boolean}
-		? Value extends {$required: false}
-			? true
-			: false
-		: false;
+	: false;
 
 /**
  * Extracts the last member from a union type by leveraging intersection of function return types
@@ -188,25 +184,6 @@ type MapToSchemaPropertyTypes<Value extends unknown[]> = Value extends [infer He
 	? [ToSchemaPropertyTypeEach<Head>, ...MapToSchemaPropertyTypes<Tail>]
 	: [];
 
-/**
- * A nested schema definition that may include a `$required` flag alongside arbitrary string-keyed properties
- *
- * @example
- * ```ts
- * const address: NestedSchema = {
- *   $required: false,
- *   street: 'string',
- *   city: 'string',
- * };
- * ```
- */
-export type NestedSchema = {
-	/**
-	 * Whether the nested schema is required (defaults to `true`)
-	 */
-	$required?: boolean;
-} & Schema;
-
 /**
  * Extracts keys from an object type that are optional
  *
@@ -220,7 +197,11 @@ type OptionalKeys<Value> = {
  * A generic schema allowing {@link NestedSchema}, {@link SchemaEntry}, or arrays of {@link SchemaEntry} as values
  */
 type PlainSchema = {
-	[key: string]: NestedSchema | SchemaEntry | SchemaEntry[];
+	[key: string]: PlainSchema | SchemaEntry | SchemaEntry[] | undefined;
+} & {
+	$required?: never;
+	$type?: never;
+	$validators?: never;
 };
 
 /**
@@ -271,7 +252,7 @@ export type Schema = SchemaIndex;
  */
 type SchemaEntry =
 	| Constructor
-	| Schema
+	| PlainSchema
 	| SchemaProperty
 	| Schematic<unknown>
 	| ValueName
@@ -281,7 +262,7 @@ type SchemaEntry =
  * Index signature interface backing {@link Schema}, allowing string-keyed entries of {@link NestedSchema}, {@link SchemaEntry}, or arrays of {@link SchemaEntry}
  */
 interface SchemaIndex {
-	[key: string]: NestedSchema | SchemaEntry | SchemaEntry[];
+	[key: string]: PlainSchema | SchemaEntry | SchemaEntry[];
 }
 
 /**
@@ -327,12 +308,7 @@ type SchemaPropertyType =
 	| ((value: unknown) => boolean);
 
 /**
- * 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');
- * ```
+ * A custom error class for schematic validation failures
  */
 export class SchematicError extends Error {
 	constructor(message: string) {
@@ -360,11 +336,9 @@ type ToSchemaPropertyType<Value> = UnwrapSingle<
  *
  * @template Value - type to convert
  */
-type ToSchemaPropertyTypeEach<Value> = Value extends NestedSchema
-	? Omit<Value, '$required'>
-	: Value extends PlainObject
-		? TypedSchema<Value>
-		: ToValueType<Value>;
+type ToSchemaPropertyTypeEach<Value> = Value extends PlainObject
+	? TypedSchema<Value>
+	: ToValueType<Value>;
 
 /**
  * Converts a type into its corresponding {@link ValueName}-representation

package/src/schematic.ts

@@ -30,7 +30,7 @@ export class Schematic<Model> {
 
 	/**
 	 * Does the value match the schema?
-	 * @param value - Value to validate
+	 * @param value Value to validate
 	 * @returns `true` if the value matches the schema, otherwise `false`
 	 */
 	is(value: unknown): value is Model {
@@ -40,8 +40,8 @@ export class Schematic<Model> {
 
 /**
  * Create a schematic from a schema
- * @template Model - Schema type
- * @param schema - Schema to create the schematic from
+ * @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
  */
@@ -49,8 +49,8 @@ export function schematic<Model extends Schema>(schema: Model): Schematic<Infer<
 
 /**
  * Create a schematic from a typed schema
- * @template Model - Existing type
- * @param schema - Typed schema to create the schematic from
+ * @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
  */

package/src/validation/property.validation.ts

@@ -2,9 +2,9 @@ import {isConstructor, isPlainObject} from '@oscarpalmer/atoms/is';
 import type {PlainObject} from '@oscarpalmer/atoms/models';
 import {join} from '@oscarpalmer/atoms/string';
 import {
-	EXPRESSION_PROPERTY,
 	MESSAGE_SCHEMA_INVALID_EMPTY,
 	MESSAGE_SCHEMA_INVALID_PROPERTY_DISALLOWED,
+	MESSAGE_SCHEMA_INVALID_PROPERTY_NULLABLE,
 	MESSAGE_SCHEMA_INVALID_PROPERTY_REQUIRED,
 	MESSAGE_SCHEMA_INVALID_PROPERTY_TYPE,
 	MESSAGE_VALIDATOR_INVALID_KEY,
@@ -74,12 +74,17 @@ export function getProperties(
 	for (let keyIndex = 0; keyIndex < keysLength; keyIndex += 1) {
 		const key = keys[keyIndex];
 
-		if (EXPRESSION_PROPERTY.test(key)) {
-			continue;
-		}
-
 		const value = original[key];
 
+		if (value == null) {
+			throw new SchematicError(
+				MESSAGE_SCHEMA_INVALID_PROPERTY_NULLABLE.replace(
+					TEMPLATE_PATTERN,
+					join([prefix, key], '.'),
+				),
+			);
+		}
+
 		const types: ValidatedPropertyType[] = [];
 
 		let required = true;