Add "undefined field error" and "type error" error message customization support

Author: SerafimArts

resources/config.schema.json

@@ -6,6 +6,16 @@
     "description": "A mapper configuration schema",
     "additionalProperties": false,
     "properties": {
+        "type_error_message": {
+            "type": "string",
+            "minLength": 1,
+            "description": "Custom error message on property type error"
+        },
+        "undefined_error_message": {
+            "type": "string",
+            "minLength": 1,
+            "description": "Custom error message on property value missing error"
+        },
         "normalize_as_array": {
             "type": "boolean",
             "description": "Responsible for enabling or disabling the conversion to an associative array"

src/Exception/Mapping/RuntimeException.php

@@ -32,6 +32,15 @@ public function __construct(
         );
     }
 
+    public function updateMessage(string $message): void
+    {
+        $this->template->updateTemplateMessage($message);
+
+        if ($this->message instanceof Template) {
+            $this->message->updateTemplateMessage($message);
+        }
+    }
+
     private static function createTemplate(string $template, \Throwable $context, PathInterface $path): Template
     {
         $suffix = '';

src/Exception/Template.php

@@ -28,14 +28,19 @@ final class Template implements \Stringable
     public ValuePrinterInterface $values;
 
     public function __construct(
-        private readonly string $template,
+        private string $template,
         private readonly \Throwable $context,
     ) {
         $this->types = self::createDefaultTypePrinter();
         $this->paths = self::createDefaultPathPrinter();
         $this->values = self::createDefaultValuePrinter();
     }
 
+    public function updateTemplateMessage(string $message): void
+    {
+        $this->template = $message;
+    }
+
     private static function createDefaultTypePrinter(): TypePrinterInterface
     {
         return new PrettyPrinter(

src/Mapping/Driver/ArrayConfigDriver.php

@@ -44,6 +44,8 @@ abstract protected function getConfiguration(\ReflectionClass $class): ?array;
      *
      * @return array{
      *     normalize_as_array?: bool,
+     *     type_error_message?: non-empty-string,
+     *     undefined_error_message?: non-empty-string,
      *     discriminator?: array{
      *         field: non-empty-string,
      *         map: array<non-empty-string, non-empty-string>,
@@ -189,6 +191,24 @@ class: $reflection,
 
             $metadata = $class->getPropertyOrCreate($propertyName);
 
+            // ---------------------------------------------------------------------
+            //  start: Property Error Message
+            // ---------------------------------------------------------------------
+
+            if (\array_key_exists('type_error_message', $propertyConfig)) {
+                // @phpstan-ignore-next-line : Additional DbC invariant
+                assert(\is_string($propertyConfig['type_error_message']));
+
+                $metadata->typeErrorMessage = $propertyConfig['type_error_message'];
+            }
+
+            if (\array_key_exists('undefined_error_message', $propertyConfig)) {
+                // @phpstan-ignore-next-line : Additional DbC invariant
+                assert(\is_string($propertyConfig['undefined_error_message']));
+
+                $metadata->undefinedErrorMessage = $propertyConfig['undefined_error_message'];
+            }
+
             // -----------------------------------------------------------------
             //  start: Property Type
             // -----------------------------------------------------------------