Merge branch hotfix/v2.7.33

Author: roadiz-ci

.github/workflows/run-test.yml

@@ -3,7 +3,6 @@ name: Static analysis and code style
 on:
     push:
         branches:
-            - main
             - develop
             - 'release/**'
             - 'hotfix/**'
@@ -20,7 +19,7 @@ jobs:
         runs-on: ubuntu-latest
         strategy:
             matrix:
-                php-version: ['8.1', '8.2', '8.3']
+                php-version: ['8.3', '8.4', '8.5']
         steps:
             - uses: shivammathur/setup-php@v2
               with:
@@ -36,7 +35,5 @@ jobs:
                       ${{ runner.os }}-php-${{ matrix.php-version }}-
             - name: Install Dependencies
               run: composer install --no-scripts --no-ansi --no-interaction --no-progress
-            - name: Run PHP Code Sniffer
-              run: vendor/bin/phpcs -p ./src
             - name: Run PHPStan
               run: vendor/bin/phpstan analyse --no-progress -c phpstan.neon

LICENSE.md

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright © 2024 Ambroise Maupate
+Copyright © 2025 Ambroise Maupate
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 

Makefile

@@ -3,12 +3,12 @@
     "description": "Roadiz sub-package which generates Typescript interfaces skeleton based on your schema",
     "type": "library",
     "require": {
-        "roadiz/nodetype-contracts": "~1.1.2",
-        "symfony/http-foundation": "6.4.*"
+        "roadiz/nodetype-contracts": "^3.1.1",
+        "symfony/http-foundation": "7.4.*"
     },
     "require-dev": {
-        "phpstan/phpstan": "^1.5.3",
-        "squizlabs/php_codesniffer": "^3.5"
+        "phpstan/phpstan": "^2.1.36",
+        "phpstan/phpdoc-parser": "<2"
     },
     "license": "MIT",
     "authors": [
@@ -26,8 +26,8 @@
     },
     "extra": {
         "branch-alias": {
-            "dev-master": "2.3.x-dev",
-            "dev-develop": "2.4.x-dev"
+            "dev-master": "2.7.x-dev",
+            "dev-develop": "2.8.x-dev"
         }
     }
 }

composer.json

@@ -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;
@@ -15,15 +16,14 @@
 use RZ\Roadiz\Typescript\Declaration\Generators\ScalarFieldGenerator;
 use Symfony\Component\HttpFoundation\ParameterBag;
 
-final class DeclarationGeneratorFactory
+final readonly class DeclarationGeneratorFactory
 {
-    public function __construct(private readonly ParameterBag $nodeTypesBag)
-    {
+    public function __construct(
+        private ParameterBag $nodeTypesBag,
+        private NodeTypeClassLocatorInterface $nodeTypeClassLocator,
+    ) {
     }
 
-    /**
-     * @return ParameterBag
-     */
     public function getNodeTypesBag(): ParameterBag
     {
         return $this->nodeTypesBag;
@@ -34,29 +34,20 @@ public function getHumanBool(bool $bool): string
         return $bool ? 'true' : 'false';
     }
 
-    /**
-     * @param NodeTypeInterface $nodeType
-     *
-     * @return NodeTypeGenerator
-     */
     public function createForNodeType(NodeTypeInterface $nodeType): NodeTypeGenerator
     {
         return new NodeTypeGenerator(
             $nodeType,
-            $this
+            $this,
+            $this->nodeTypeClassLocator
         );
     }
 
-    /**
-     * @param NodeTypeFieldInterface $field
-     *
-     * @return AbstractFieldGenerator
-     */
     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),

phpcs.xml.dist

@@ -12,19 +12,10 @@ abstract class AbstractFieldGenerator
     // Four spaces
     public const INDENTATION_MARK = '    ';
 
-    protected NodeTypeFieldInterface $field;
-    protected ParameterBag $nodeTypesBag;
-
-    /**
-     * @param NodeTypeFieldInterface $field
-     * @param ParameterBag $nodeTypesBag
-     */
     public function __construct(
-        NodeTypeFieldInterface $field,
-        ParameterBag $nodeTypesBag
+        protected readonly NodeTypeFieldInterface $field,
+        protected readonly ParameterBag $nodeTypesBag,
     ) {
-        $this->field = $field;
-        $this->nodeTypesBag = $nodeTypesBag;
     }
 
     protected function getNullableAssertion(): string
@@ -36,18 +27,18 @@ abstract protected function getType(): string;
 
     private function getDeclaration(): string
     {
-        return static::INDENTATION_MARK .
-            $this->field->getVarName() .
-            $this->getNullableAssertion() . ': ' .
+        return static::INDENTATION_MARK.
+            $this->field->getVarName().
+            $this->getNullableAssertion().': '.
             $this->getType();
     }
 
     public function getContents(): string
     {
         return implode(PHP_EOL, [
-                $this->getIntroduction(),
-                $this->getDeclaration()
-            ]);
+            $this->getIntroduction(),
+            $this->getDeclaration(),
+        ]);
     }
 
     protected function getIntroductionLines(): array
@@ -60,19 +51,14 @@ protected function getIntroductionLines(): array
         }
 
         if (!empty($this->field->getGroupName())) {
-            $lines[] = 'Group: ' . $this->field->getGroupName();
+            $lines[] = 'Group: '.$this->field->getGroupName();
         }
 
         return $lines;
     }
 
-    /**
-     * @return string
-     */
     public function getIntroduction(): string
     {
-        return implode(PHP_EOL, array_map(function (string $line) {
-            return static::INDENTATION_MARK . '// ' . $line;
-        }, $this->getIntroductionLines()));
+        return implode(PHP_EOL, array_map(fn (string $line) => static::INDENTATION_MARK.'// '.$line, $this->getIntroductionLines()));
     }
 }

src/DeclarationGeneratorFactory.php

@@ -6,23 +6,28 @@
 
 final class ChildrenNodeFieldGenerator extends AbstractFieldGenerator
 {
+    #[\Override]
     public function getContents(): string
     {
         return implode(PHP_EOL, [
             $this->getIntroduction(),
         ]);
     }
+
+    #[\Override]
     protected function getIntroductionLines(): array
     {
         $lines = [
-            'This node-type uses "blocks" which are available through parent RoadizNodesSources.blocks'
+            'This node-type uses "blocks" which are available through parent RoadizNodesSources.blocks',
         ];
-        if (!empty($this->field->getDefaultValues())) {
-            $lines[] = 'Possible block node-types: ' . $this->field->getDefaultValues();
+        if (!empty($this->field->getDefaultValuesAsArray())) {
+            $lines[] = 'Possible block node-types: '.json_encode($this->field->getDefaultValuesAsArray());
         }
+
         return $lines;
     }
 
+    #[\Override]
     protected function getType(): string
     {
         return '';

src/Generators/AbstractFieldGenerator.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;
 
@@ -15,12 +16,12 @@ final class DeclarationGenerator
     private array $nodeTypes;
 
     /**
-     * @param DeclarationGeneratorFactory $generatorFactory
      * @param NodeTypeInterface[] $nodeTypes
      */
     public function __construct(
         private readonly DeclarationGeneratorFactory $generatorFactory,
-        array $nodeTypes = []
+        private readonly NodeTypeClassLocatorInterface $nodeTypeClassLocator,
+        array $nodeTypes = [],
     ) {
         if (empty($nodeTypes)) {
             $this->nodeTypes = array_unique($this->generatorFactory->getNodeTypesBag()->all());
@@ -41,14 +42,12 @@ public function getContents(): string
 
         $blocks[] = $this->getAllTypesInterface();
 
-        return implode(PHP_EOL . PHP_EOL, $blocks);
+        return implode(PHP_EOL.PHP_EOL, $blocks);
     }
 
     private function getAllTypesInterface(): string
     {
-        $nodeTypeNames = array_map(function (NodeTypeInterface $nodeType) {
-            return $nodeType->getSourceEntityClassName();
-        }, $this->nodeTypes);
+        $nodeTypeNames = array_map($this->nodeTypeClassLocator->getSourceEntityClassName(...), $this->nodeTypes);
 
         $nodeTypeNames = implode(' | ', $nodeTypeNames);
 

src/Generators/ChildrenNodeFieldGenerator.php

@@ -6,11 +6,13 @@
 
 final class DocumentsFieldGenerator extends AbstractFieldGenerator
 {
+    #[\Override]
     protected function getNullableAssertion(): string
     {
         return ''; // always available even if empty
     }
 
+    #[\Override]
     protected function getType(): string
     {
         return 'Array<RoadizDocument>';