refactor: refactor all NodeType and NodesSources class-name resolution and improve nodetypes:validate-files (#262)

Author: roadiz-ci

composer.json

@@ -3,7 +3,7 @@
     "description": "Roadiz sub-package which generates Typescript interfaces skeleton based on your schema",
     "type": "library",
     "require": {
-        "roadiz/nodetype-contracts": "^3.0.0",
+        "roadiz/nodetype-contracts": "^3.1.1",
         "symfony/http-foundation": "7.3.*"
     },
     "require-dev": {

src/DeclarationGeneratorFactory.php

@@ -4,6 +4,7 @@
 
 namespace RZ\Roadiz\Typescript\Declaration;
 
+use RZ\Roadiz\Contracts\NodeType\NodeTypeClassLocatorInterface;
 use RZ\Roadiz\Contracts\NodeType\NodeTypeFieldInterface;
 use RZ\Roadiz\Contracts\NodeType\NodeTypeInterface;
 use RZ\Roadiz\Typescript\Declaration\Generators\AbstractFieldGenerator;
@@ -17,8 +18,10 @@
 
 final readonly class DeclarationGeneratorFactory
 {
-    public function __construct(private ParameterBag $nodeTypesBag)
-    {
+    public function __construct(
+        private ParameterBag $nodeTypesBag,
+        private NodeTypeClassLocatorInterface $nodeTypeClassLocator,
+    ) {
     }
 
     public function getNodeTypesBag(): ParameterBag
@@ -35,15 +38,16 @@ public function createForNodeType(NodeTypeInterface $nodeType): NodeTypeGenerato
     {
         return new NodeTypeGenerator(
             $nodeType,
-            $this
+            $this,
+            $this->nodeTypeClassLocator
         );
     }
 
     public function createForNodeTypeField(NodeTypeFieldInterface $field): AbstractFieldGenerator
     {
         return match (true) {
             $field->isDocuments() => new DocumentsFieldGenerator($field, $this->nodeTypesBag),
-            $field->isNodes() => new NodeReferencesFieldGenerator($field, $this->nodeTypesBag),
+            $field->isNodes() => new NodeReferencesFieldGenerator($this->nodeTypeClassLocator, $field, $this->nodeTypesBag),
             $field->isChildrenNodes() => new ChildrenNodeFieldGenerator($field, $this->nodeTypesBag),
             $field->isMultiple(), $field->isEnum() => new EnumFieldGenerator($field, $this->nodeTypesBag),
             default => new ScalarFieldGenerator($field, $this->nodeTypesBag),

src/Generators/DeclarationGenerator.php

@@ -4,6 +4,7 @@
 
 namespace RZ\Roadiz\Typescript\Declaration\Generators;
 
+use RZ\Roadiz\Contracts\NodeType\NodeTypeClassLocatorInterface;
 use RZ\Roadiz\Contracts\NodeType\NodeTypeInterface;
 use RZ\Roadiz\Typescript\Declaration\DeclarationGeneratorFactory;
 
@@ -19,6 +20,7 @@ final class DeclarationGenerator
      */
     public function __construct(
         private readonly DeclarationGeneratorFactory $generatorFactory,
+        private readonly NodeTypeClassLocatorInterface $nodeTypeClassLocator,
         array $nodeTypes = [],
     ) {
         if (empty($nodeTypes)) {
@@ -45,7 +47,7 @@ public function getContents(): string
 
     private function getAllTypesInterface(): string
     {
-        $nodeTypeNames = array_map(fn (NodeTypeInterface $nodeType) => $nodeType->getSourceEntityClassName(), $this->nodeTypes);
+        $nodeTypeNames = array_map(fn (NodeTypeInterface $nodeType) => $this->nodeTypeClassLocator->getSourceEntityClassName($nodeType), $this->nodeTypes);
 
         $nodeTypeNames = implode(' | ', $nodeTypeNames);
 

src/Generators/NodeReferencesFieldGenerator.php

@@ -4,10 +4,21 @@
 
 namespace RZ\Roadiz\Typescript\Declaration\Generators;
 
+use RZ\Roadiz\Contracts\NodeType\NodeTypeClassLocatorInterface;
+use RZ\Roadiz\Contracts\NodeType\NodeTypeFieldInterface;
 use RZ\Roadiz\Contracts\NodeType\NodeTypeInterface;
+use Symfony\Component\HttpFoundation\ParameterBag;
 
 final class NodeReferencesFieldGenerator extends AbstractFieldGenerator
 {
+    public function __construct(
+        private readonly NodeTypeClassLocatorInterface $nodeTypeClassLocator,
+        NodeTypeFieldInterface $field,
+        ParameterBag $nodeTypesBag,
+    ) {
+        parent::__construct($field, $nodeTypesBag);
+    }
+
     #[\Override]
     protected function getNullableAssertion(): string
     {
@@ -46,7 +57,7 @@ private function getUnionType(): string
             return 'RoadizNodesSources';
         }
 
-        return implode(' | ', array_map(fn (NodeTypeInterface $nodeType) => $nodeType->getSourceEntityClassName(), $nodeTypes));
+        return implode(' | ', array_map(fn (NodeTypeInterface $nodeType) => $this->nodeTypeClassLocator->getSourceEntityClassName($nodeType), $nodeTypes));
     }
 
     #[\Override]

src/Generators/NodeTypeGenerator.php

@@ -4,6 +4,7 @@
 
 namespace RZ\Roadiz\Typescript\Declaration\Generators;
 
+use RZ\Roadiz\Contracts\NodeType\NodeTypeClassLocatorInterface;
 use RZ\Roadiz\Contracts\NodeType\NodeTypeFieldInterface;
 use RZ\Roadiz\Contracts\NodeType\NodeTypeInterface;
 use RZ\Roadiz\Contracts\NodeType\SerializableInterface;
@@ -19,6 +20,7 @@ final class NodeTypeGenerator
     public function __construct(
         private readonly NodeTypeInterface $nodeType,
         private readonly DeclarationGeneratorFactory $generatorFactory,
+        private readonly NodeTypeClassLocatorInterface $nodeTypeClassLocator,
     ) {
         $this->fieldGenerators = [];
 
@@ -54,7 +56,7 @@ public function getContents(): string
     protected function getInterfaceBody(): string
     {
         $lines = [
-            'export interface '.$this->nodeType->getSourceEntityClassName().' extends RoadizNodesSources {',
+            'export interface '.$this->nodeTypeClassLocator->getSourceEntityClassName($this->nodeType).' extends RoadizNodesSources {',
             $this->getFieldsContents(),
             '}',
         ];