Generate full API Platform IRI as TS type literal (#53)

Author: kubk

composer.json

@@ -24,7 +24,8 @@
         "webmozart/assert": "^1.10",
         "jfcherng/php-diff": "^6.10",
         "jawira/case-converter": "^3.4",
-        "phpstan/phpdoc-parser": "^1.6"
+        "phpstan/phpdoc-parser": "^1.6",
+        "doctrine/inflector": "^2.0"
     },
     "license": "GPL-3.0-or-later",
     "autoload": {

src/Bridge/ApiPlatform/ApiPlatformInputTypeResolver.php

@@ -16,12 +16,16 @@
 
 class ApiPlatformInputTypeResolver implements UnknownTypeResolverInterface
 {
+    private ApiPlatformIriGenerator $apiPlatformIriGenerator;
+
     public function __construct(
         /** @var array<string, string> */
         private array $classMap = [],
         // https://www.typescriptlang.org/docs/handbook/2/template-literal-types.html
         private bool $useTypeScriptTemplateLiteral = false,
+        private bool $useApiPlatformIriGenerator = false,
     ) {
+        $this->apiPlatformIriGenerator = new ApiPlatformIriGenerator();
     }
 
     public function supports(PhpUnknownType $type, DtoType|null $dto, DtoList $dtoList): bool
@@ -62,7 +66,11 @@ public function resolve(PhpUnknownType $type, DtoType|null $dto, DtoList $dtoLis
         }
 
         if ($this->useTypeScriptTemplateLiteral) {
-            return '`/api/${string}`';
+            if ($this->useApiPlatformIriGenerator) {
+                $pluralizedTypeName = $this->apiPlatformIriGenerator->generate($type);
+                return sprintf('`/api/%s/${string}`', $pluralizedTypeName);
+            }
+            return'`/api/${string}`';
         }
 
         return PhpBaseType::string();

src/Bridge/ApiPlatform/ApiPlatformIriGenerator.php

@@ -0,0 +1,26 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Riverwaysoft\DtoConverter\Bridge\ApiPlatform;
+
+use Doctrine\Inflector\Inflector;
+use Doctrine\Inflector\InflectorFactory;
+use Jawira\CaseConverter\Convert;
+use Riverwaysoft\DtoConverter\Dto\PhpType\PhpUnknownType;
+
+class ApiPlatformIriGenerator
+{
+    private Inflector $inflector;
+
+    public function __construct()
+    {
+        $this->inflector = InflectorFactory::create()->build();
+    }
+
+    public function generate(PhpUnknownType $type): string
+    {
+        $pluralized = $this->inflector->pluralize($type->getName());
+        return (new Convert($pluralized))->toSnake();
+    }
+}

src/Bridge/ApiPlatform/ApiPlatformIriGeneratorTest.php

@@ -0,0 +1,20 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Riverwaysoft\DtoConverter\Bridge\ApiPlatform;
+
+use PHPUnit\Framework\TestCase;
+use Riverwaysoft\DtoConverter\Dto\PhpType\PhpUnknownType;
+
+class ApiPlatformIriGeneratorTest extends TestCase
+{
+    public function testGeneration(): void
+    {
+        $generator = new ApiPlatformIriGenerator();
+
+        $this->assertEquals('food_categories', $generator->generate(new PhpUnknownType('FoodCategory')));
+        $this->assertEquals('users', $generator->generate(new PhpUnknownType('User')));
+        $this->assertEquals('food_analyze_rule_categories', $generator->generate(new PhpUnknownType('FoodAnalyzeRuleCategory')));
+    }
+}

tests/TypeScriptGeneratorTest.php

@@ -327,7 +327,7 @@ class UserCreateInput
                 new ApiPlatformInputTypeResolver([
                     'LocationEmbeddable' => '{ lat: string; lan: string }',
                     'Money' => '{ currency: string; amount: number }',
-                ], true),
+                ], true, true),
                 new ClassNameTypeResolver(),
             ],
             new OutputFilesProcessor([

tests/__snapshots__/TypeScriptGeneratorTest__testApiPlatformInput__2.ts

@@ -16,11 +16,11 @@ export type ProfileOutput = {
 };
 
 export type UserCreateInput = {
-  profile: `/api/${string}`;
+  profile: `/api/profiles/${string}`;
   promotedAt: string | null;
   userTheme: ColorEnum;
-  industriesUnion: `/api/${string}`[] | null;
-  industriesNullable: `/api/${string}`[] | null;
+  industriesUnion: `/api/industries/${string}`[] | null;
+  industriesNullable: `/api/industries/${string}`[] | null;
   money: { currency: string; amount: number };
   gender: { value: GenderEnum };
   location: { lat: string; lan: string };