Switch to auto-generated enums from PHP in TypeScript.

backend/config/cli.php

@@ -45,6 +45,7 @@
             'azuracast:api:docs' => Command\Dev\GenerateApiDocsCommand::class,
             'azuracast:new-version' => Command\Dev\NewVersionCommand::class,
             'azuracast:dev:generate-db-fixture' => Command\Dev\GenerateDbFixtureCommand::class,
+            'azuracast:dev:ts' => Command\Dev\GenerateTypescriptClassesCommand::class,
             'azuracast:locale:generate' => Command\Locale\GenerateCommand::class,
             'azuracast:locale:import' => Command\Locale\ImportCommand::class,
             'locale:generate' => Command\Locale\GenerateCommand::class,

backend/src/Console/Command/Dev/GenerateTypescriptClassesCommand.php

@@ -0,0 +1,51 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Console\Command\Dev;
+
+use App\Console\Command\CommandAbstract;
+use App\Container\EnvironmentAwareTrait;
+use App\Container\LoggerAwareTrait;
+use App\TypeScript\NativeJsEnumTransformer;
+use App\TypeScript\NativeJsWriter;
+use Spatie\TypeScriptTransformer\Formatters\PrettierFormatter;
+use Spatie\TypeScriptTransformer\TypeScriptTransformer;
+use Spatie\TypeScriptTransformer\TypeScriptTransformerConfig;
+use Symfony\Component\Console\Attribute\AsCommand;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Output\OutputInterface;
+use Symfony\Component\Console\Style\SymfonyStyle;
+
+#[AsCommand(
+    name: 'azuracast:dev:ts',
+    description: 'Trigger generation of TypeScript equivalents of PHP classes.',
+)]
+final class GenerateTypescriptClassesCommand extends CommandAbstract
+{
+    use LoggerAwareTrait;
+    use EnvironmentAwareTrait;
+
+    protected function execute(InputInterface $input, OutputInterface $output): int
+    {
+        $io = new SymfonyStyle($input, $output);
+
+        $backendBaseDir = $this->environment->getBackendDirectory();
+        $outputFile = $this->environment->getBaseDirectory() . '/frontend/entities/PhpClasses.ts';
+
+        $config = TypeScriptTransformerConfig::create()
+            ->autoDiscoverTypes($backendBaseDir)
+            ->transformers([
+                NativeJsEnumTransformer::class,
+            ])
+            ->transformToNativeEnums()
+            ->writer(NativeJsWriter::class)
+            ->formatter(PrettierFormatter::class)
+            ->outputFile($outputFile);
+
+        TypeScriptTransformer::create($config)->transform();
+
+        $io->writeln('TypeScript classes generated!');
+        return 0;
+    }
+}

backend/src/Radio/Enums/AudioProcessingMethods.php

@@ -4,6 +4,9 @@
 
 namespace App\Radio\Enums;
 
+use Spatie\TypeScriptTransformer\Attributes\TypeScript;
+
+#[TypeScript]
 enum AudioProcessingMethods: string
 {
     case None = 'none';

backend/src/Radio/Enums/BackendAdapters.php

@@ -5,7 +5,9 @@
 namespace App\Radio\Enums;
 
 use App\Radio\Backend\Liquidsoap;
+use Spatie\TypeScriptTransformer\Attributes\TypeScript;
 
+#[TypeScript]
 enum BackendAdapters: string implements AdapterTypeInterface
 {
     case Liquidsoap = 'liquidsoap';

backend/src/Radio/Enums/FrontendAdapters.php

@@ -8,7 +8,9 @@
 use App\Radio\Frontend\Icecast;
 use App\Radio\Frontend\Rsas;
 use App\Radio\Frontend\Shoutcast;
+use Spatie\TypeScriptTransformer\Attributes\TypeScript;
 
+#[TypeScript]
 enum FrontendAdapters: string implements AdapterTypeInterface
 {
     case Icecast = 'icecast';

backend/src/Radio/Enums/RemoteAdapters.php

@@ -9,7 +9,9 @@
 use App\Radio\Remote\Icecast;
 use App\Radio\Remote\Shoutcast1;
 use App\Radio\Remote\Shoutcast2;
+use Spatie\TypeScriptTransformer\Attributes\TypeScript;
 
+#[TypeScript]
 enum RemoteAdapters: string implements AdapterTypeInterface
 {
     case Shoutcast1 = 'shoutcast1';

backend/src/TypeScript/IgnoreCase.php

@@ -0,0 +1,15 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\TypeScript;
+
+use Attribute;
+
+/**
+ * Ignore a specific enum case.
+ */
+#[Attribute(Attribute::TARGET_CLASS_CONSTANT)]
+final class IgnoreCase
+{
+}

backend/src/TypeScript/NativeJsEnumTransformer.php

@@ -0,0 +1,38 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\TypeScript;
+
+use ReflectionEnum;
+use ReflectionEnumBackedCase;
+use Spatie\TypeScriptTransformer\Structures\TransformedType;
+use Spatie\TypeScriptTransformer\Transformers\EnumTransformer;
+
+final class NativeJsEnumTransformer extends EnumTransformer
+{
+    protected function toEnum(ReflectionEnum $enum, string $name): TransformedType
+    {
+        /** @var ReflectionEnumBackedCase[] $enumCases */
+        $enumCases = $enum->getCases();
+
+        $options = array_filter(
+            array_map(
+                function (ReflectionEnumBackedCase $case): ?string {
+                    $hiddenAttributes = $case->getAttributes(IgnoreCase::class);
+                    return (empty($hiddenAttributes))
+                        ? "'{$case->getName()}': {$this->toEnumValue($case)}"
+                        : null;
+                },
+                $enumCases
+            )
+        );
+
+        return TransformedType::create(
+            $enum,
+            $name,
+            'Object.freeze({ ' . implode(', ', $options) . ' } as const)',
+            keyword: 'const'
+        );
+    }
+}

backend/src/TypeScript/NativeJsWriter.php

@@ -0,0 +1,60 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\TypeScript;
+
+use Spatie\TypeScriptTransformer\Structures\TransformedType;
+use Spatie\TypeScriptTransformer\Structures\TypesCollection;
+use Spatie\TypeScriptTransformer\Writers\ModuleWriter;
+
+final class NativeJsWriter extends ModuleWriter
+{
+    public function format(TypesCollection $collection): string
+    {
+        $output = <<<'TS'
+        /*
+         * This file is automatically generated by AzuraCast.
+         * To update it, run:
+         * `backend/bin/console azuracast:dev:ts`
+         */
+
+
+        TS;
+
+        $iterator = $collection->getIterator();
+        $iterator->uasort(function (TransformedType $a, TransformedType $b) {
+            return strcmp($a->name ?? '', $b->name ?? '');
+        });
+
+        /** @var TransformedType $type */
+        foreach ($iterator as $type) {
+            if ($type->isInline) {
+                continue;
+            }
+
+            if ($type->keyword === 'const') {
+                $this->handleNativeJsEnum($type, $output);
+            } else {
+                $output .= "export {$type->toString()}" . PHP_EOL . PHP_EOL;
+            }
+        }
+
+        return $output;
+    }
+
+    protected function handleNativeJsEnum(TransformedType $type, string &$output): void
+    {
+        $output .= "export const {$type->name} = {$type->transformed}";
+        if ($type->trailingSemicolon) {
+            $output .= ';';
+        }
+        $output .= PHP_EOL;
+
+        $output .= "export type {$type->name}Enum = typeof {$type->name}[keyof typeof {$type->name}]";
+        if ($type->trailingSemicolon) {
+            $output .= ';';
+        }
+        $output .= PHP_EOL . PHP_EOL;
+    }
+}

backend/src/Webhook/Enums/WebhookTriggers.php

@@ -4,6 +4,9 @@
 
 namespace App\Webhook\Enums;
 
+use Spatie\TypeScriptTransformer\Attributes\TypeScript;
+
+#[TypeScript]
 enum WebhookTriggers: string
 {
     case SongChanged = 'song_changed';

backend/src/Webhook/Enums/WebhookTypes.php

@@ -4,6 +4,7 @@
 
 namespace App\Webhook\Enums;
 
+use App\TypeScript\IgnoreCase;
 use App\Webhook\Connector\Bluesky;
 use App\Webhook\Connector\Discord;
 use App\Webhook\Connector\Email;
@@ -17,7 +18,9 @@
 use App\Webhook\Connector\RadioReg;
 use App\Webhook\Connector\Telegram;
 use App\Webhook\Connector\TuneIn;
+use Spatie\TypeScriptTransformer\Attributes\TypeScript;
 
+#[TypeScript]
 enum WebhookTypes: string
 {
     case Generic = 'generic';
@@ -38,7 +41,10 @@ enum WebhookTypes: string
     case MatomoAnalytics = 'matomo_analytics';
 
     // Retired connectors
+    #[IgnoreCase]
     case Twitter = 'twitter';
+
+    #[IgnoreCase]
     case GoogleAnalyticsV3 = 'google_analytics';
 
     /**

composer.json

@@ -72,6 +72,7 @@
     "slim/http": "^1.1",
     "slim/slim": "^4.2",
     "spatie/flysystem-dropbox": "^3",
+    "spatie/typescript-transformer": "*",
     "spomky-labs/otphp": "^11",
     "supervisorphp/supervisor": "dev-main",
     "symfony/cache": "^7",