fix(jsonld): item uri template type

Author: soyuka

features/hydra/item_uri_template.feature

@@ -146,13 +146,13 @@ Feature: Exposing a collection of objects should use the specified operation to
       "hydra:member":[
         {
           "@id":"/item_referenced_in_collection/a",
-          "@type":"CollectionReferencingItem",
+          "@type":"ItemReferencedInCollection",
           "id":"a",
           "name":"hello"
         },
         {
           "@id":"/item_referenced_in_collection/b",
-          "@type":"CollectionReferencingItem",
+          "@type":"ItemReferencedInCollection",
           "id":"b",
           "name":"you"
         }

features/jsonld/input_output.feature

@@ -381,6 +381,7 @@ Feature: JSON-LD DTO input and output
     Then the response status code should be 200
     And the response should be in JSON
     And the header "Content-Type" should be equal to "application/ld+json; charset=utf-8"
+    Then print last JSON response
     And the JSON should be valid according to this schema:
     """
     {
@@ -402,7 +403,7 @@ Feature: JSON-LD DTO input and output
             "required": ["@id", "@type", "foo", "bar"],
             "properties": {
               "@id": {"pattern": "^/.well-known/genid/.+$"},
-              "@type": {"pattern": "^DummyCollectionDtoOutput$"},
+              "@type": {"pattern": "^DummyFooCollectionDto$"},
               "foo": {"type": "string"},
               "bar": {"type": "integer"}
             }

src/JsonLd/Serializer/ItemNormalizer.php

@@ -18,6 +18,7 @@
 use ApiPlatform\Metadata\Exception\ItemNotFoundException;
 use ApiPlatform\Metadata\HttpOperation;
 use ApiPlatform\Metadata\IriConverterInterface;
+use ApiPlatform\Metadata\Operation\Factory\OperationMetadataFactoryInterface;
 use ApiPlatform\Metadata\Property\Factory\PropertyMetadataFactoryInterface;
 use ApiPlatform\Metadata\Property\Factory\PropertyNameCollectionFactoryInterface;
 use ApiPlatform\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface;
@@ -70,7 +71,7 @@ final class ItemNormalizer extends AbstractItemNormalizer
         '@vocab',
     ];
 
-    public function __construct(ResourceMetadataCollectionFactoryInterface $resourceMetadataCollectionFactory, PropertyNameCollectionFactoryInterface $propertyNameCollectionFactory, PropertyMetadataFactoryInterface $propertyMetadataFactory, IriConverterInterface $iriConverter, ResourceClassResolverInterface $resourceClassResolver, private readonly ContextBuilderInterface $contextBuilder, ?PropertyAccessorInterface $propertyAccessor = null, ?NameConverterInterface $nameConverter = null, ?ClassMetadataFactoryInterface $classMetadataFactory = null, array $defaultContext = [], ?ResourceAccessCheckerInterface $resourceAccessChecker = null, protected ?TagCollectorInterface $tagCollector = null)
+    public function __construct(ResourceMetadataCollectionFactoryInterface $resourceMetadataCollectionFactory, PropertyNameCollectionFactoryInterface $propertyNameCollectionFactory, PropertyMetadataFactoryInterface $propertyMetadataFactory, IriConverterInterface $iriConverter, ResourceClassResolverInterface $resourceClassResolver, private readonly ContextBuilderInterface $contextBuilder, ?PropertyAccessorInterface $propertyAccessor = null, ?NameConverterInterface $nameConverter = null, ?ClassMetadataFactoryInterface $classMetadataFactory = null, array $defaultContext = [], ?ResourceAccessCheckerInterface $resourceAccessChecker = null, protected ?TagCollectorInterface $tagCollector = null, private ?OperationMetadataFactoryInterface $operationMetadataFactory = null)
     {
         parent::__construct($propertyNameCollectionFactory, $propertyMetadataFactory, $iriConverter, $resourceClassResolver, $propertyAccessor, $nameConverter, $classMetadataFactory, $defaultContext, $resourceMetadataCollectionFactory, $resourceAccessChecker, $tagCollector);
     }
@@ -115,7 +116,9 @@ public function normalize(mixed $object, ?string $format = null, array $context
                 $context['output']['iri'] = null;
             }
 
-            if ($this->resourceClassResolver->isResourceClass($resourceClass)) {
+            if (isset($context['item_uri_template']) && $this->operationMetadataFactory) {
+                $context['output']['operation'] = $this->operationMetadataFactory->create($context['item_uri_template']);
+            } elseif ($this->resourceClassResolver->isResourceClass($resourceClass)) {
                 $context['output']['operation'] = $this->resourceMetadataCollectionFactory->create($resourceClass)->getOperation();
             }
 
@@ -141,6 +144,11 @@ public function normalize(mixed $object, ?string $format = null, array $context
         }
 
         $operation = $context['operation'] ?? null;
+
+        if ($this->operationMetadataFactory && isset($context['item_uri_template']) && !$operation) {
+            $operation = $this->operationMetadataFactory->create($context['item_uri_template']);
+        }
+
         if ($isResourceClass && !$operation) {
             $operation = $this->resourceMetadataCollectionFactory->create($resourceClass)->getOperation();
         }

src/Symfony/Bundle/Resources/config/jsonld.xml

@@ -31,6 +31,7 @@
             <argument>%api_platform.serializer.default_context%</argument>
             <argument type="service" id="api_platform.security.resource_access_checker" on-invalid="ignore" />
             <argument type="service" id="api_platform.http_cache.tag_collector" on-invalid="ignore" />
+            <argument type="service" id="api_platform.metadata.operation.metadata_factory" on-invalid="ignore" />
 
             <!-- Run before serializer.normalizer.json_serializable -->
             <tag name="serializer.normalizer" priority="-890" />

tests/Fixtures/TestBundle/ApiResource/ItemUriTemplateWithCollection/Recipe.php

@@ -51,8 +51,6 @@ class Recipe
 
     public ?string $totalTime = null;
 
-    public ?string $recipeCategory = null;
-
     public ?string $recipeCuisine = null;
 
     public ?string $suitableForDiet = null;
@@ -66,8 +64,6 @@ public static function provide(Operation $operation, array $uriVariables = [], a
         $recipe->prepTime = 'PT15M';
         $recipe->cookTime = 'PT30M';
         $recipe->totalTime = 'PT45M';
-        $recipe->recipeYield = '2 servings';
-        $recipe->recipeCategory = ['Lunch', 'Dinner'];
         $recipe->recipeIngredient = ['Ingredient 1', 'Ingredient 2'];
         $recipe->recipeInstructions = 'Do these things.';
 

tests/Functional/JsonLdTest.php

@@ -156,12 +156,12 @@ public function testItemUriTemplate(): void
         $this->assertJsonContains([
             'member' => [
                 [
-                    '@type' => 'ItemRecipe',
+                    '@type' => 'RecipeCollection',
                     '@id' => '/item_uri_template_recipes/1',
                     'name' => 'Dummy Recipe',
                 ],
                 [
-                    '@type' => 'ItemRecipe',
+                    '@type' => 'RecipeCollection',
                     '@id' => '/item_uri_template_recipes/2',
                     'name' => 'Dummy Recipe 2',
                 ],
@@ -204,17 +204,17 @@ public function testItemUriTemplateWithStateOption(): void
         $this->assertJsonContains([
             'member' => [
                 [
-                    '@type' => 'ItemRecipe',
+                    '@type' => 'Recipe',
                     '@id' => '/item_uri_template_recipes_state_option/1',
                     'name' => 'Recipe 0',
                 ],
                 [
-                    '@type' => 'ItemRecipe',
+                    '@type' => 'Recipe',
                     '@id' => '/item_uri_template_recipes_state_option/2',
                     'name' => 'Recipe 1',
                 ],
                 [
-                    '@type' => 'ItemRecipe',
+                    '@type' => 'Recipe',
                     '@id' => '/item_uri_template_recipes_state_option/3',
                     'name' => 'Recipe 2',
                 ],