✨ add field types easy getters in objectfields

Author: sebastianMindee

src/Parsing/V2/Field/ObjectField.php

@@ -2,6 +2,8 @@
 
 namespace Mindee\Parsing\V2\Field;
 
+use InvalidArgumentException;
+
 /**
  * A field containing a nested set of inference fields.
  */
@@ -43,4 +45,103 @@ public function toStringFromList(): string
     {
         return substr($this->fields->toString(2), 4);
     }
+
+    /**
+     * Returns a ListField instance for the specified key.
+     *
+     * @param string $key The key of the list field to retrieve.
+     * @return ListField
+     * @throws InvalidArgumentException When the field does not exist or is not a list field.
+     */
+    public function getListField(string $key): ListField
+    {
+        $field = $this->fields->get($key);
+        if (!($field instanceof ListField)) {
+            throw new InvalidArgumentException("Field $key is not a list field.");
+        }
+        return $field;
+    }
+
+    /**
+     * Returns a SimpleField instance for the specified key.
+     *
+     * @param string $key The key of the simple field to retrieve.
+     * @return SimpleField
+     * @throws InvalidArgumentException When the field does not exist or is not a simple field.
+     */
+    public function getSimpleField(string $key): SimpleField
+    {
+        $field = $this->fields->get($key);
+        if (!($field instanceof SimpleField)) {
+            throw new InvalidArgumentException("Field $key is not a simple field.");
+        }
+        return $field;
+    }
+
+    /**
+     * Returns an ObjectField instance for the specified key.
+     *
+     * @param string $key The key of the simple field to retrieve.
+     * @return ObjectField
+     * @throws InvalidArgumentException When the field does not exist or is not a simple field.
+     */
+    public function getObjectField(string $key): ObjectField
+    {
+        $field = $this->fields->get($key);
+        if (!($field instanceof ObjectField)) {
+            throw new InvalidArgumentException("Field $key is not a simple field.");
+        }
+        return $field;
+    }
+
+    /**
+     * Returns an array of SimpleField instances.
+     *
+     * @return SimpleField[]
+     * @throws InvalidArgumentException When a field does not exist or is not a simple field.
+     */
+    public function getSimpleFields(): array
+    {
+        $out = [];
+        foreach ($this->fields->getArrayCopy() as $field) {
+            if ($field instanceof SimpleField) {
+                $out[] = $field;
+            }
+        }
+        return $out;
+    }
+
+    /**
+     * Returns an array of ListField instances.
+     *
+     * @return ListField[]
+     * @throws InvalidArgumentException When a field does not exist or is not a list field.
+     */
+    public function getListFields(): array
+    {
+        $out = [];
+        foreach ($this->fields->getArrayCopy() as $field) {
+            if ($field instanceof ListField) {
+                $out[] = $field;
+            }
+        }
+        return $out;
+    }
+
+    /**
+     * Returns an array of ObjectField instances.
+     *
+     * @return ObjectField[]
+     * @throws InvalidArgumentException When a field does not exist or is not an object field.
+     */
+    public function getObjectFields(): array
+    {
+        $out = [];
+        foreach ($this->fields->getArrayCopy() as $field) {
+            if ($field instanceof ObjectField) {
+                $out[] = $field;
+            }
+        }
+        return $out;
+    }
 }

tests/V2/Parsing/InferenceResponseTest.php

@@ -168,7 +168,14 @@ public function testDeepNestedFieldsMustExposeCorrectTypes(): void
 
         $fieldObject = $root->get('field_object');
         $this->assertInstanceOf(ObjectField::class, $fieldObject);
+        $this->assertInstanceOf(SimpleField::class, $fieldObject->getSimpleField('sub_object_simple'));
+        $this->assertInstanceOf(ListField::class, $fieldObject->getListField('sub_object_list'));
+        $this->assertInstanceOf(ObjectField::class, $fieldObject->getObjectField('sub_object_object'));
+        $this->assertEquals(1, count($fieldObject->getSimpleFields()));
+        $this->assertEquals(1, count($fieldObject->getListFields()));
+        $this->assertEquals(1, count($fieldObject->getObjectFields()));
         $lvl1 = $fieldObject->fields;
+        $this->assertInstanceOf(SimpleField::class, $lvl1->get('sub_object_simple'));
         $this->assertInstanceOf(ListField::class, $lvl1->get('sub_object_list'));
         $this->assertInstanceOf(ObjectField::class, $lvl1->get('sub_object_object'));