Add support for expanding dot notation in TypeScript transformer.

Author: menthol

docs/advanced-usage/typescript.md

@@ -128,3 +128,53 @@ class DataObject extends Data
     }
 }
 ```
+
+### Dotted Notation Expansion
+
+When using the `MapOutputName` or `MapName` attributes with dot notation (e.g., 'user.name'), the TypeScript transformer will respect the `expand_dot_notation` configuration setting:
+
+```php
+class UserData extends Data
+{
+    public function __construct(
+        #[MapOutputName('user.name')]
+        public string $name,
+        #[MapOutputName('user.profile.bio')]
+        public string $userBio,
+    ) {
+    }
+}
+```
+
+With `expand_dot_notation` disabled (default), this will generate:
+
+```tsx
+{
+    'user.name': string;
+    'user.profile.bio': string;
+}
+```
+
+When you enable `expand_dot_notation` in your `config/data.php` file:
+
+```php
+'features' => [
+    // Other features...
+    'expand_dot_notation' => true,
+],
+```
+
+The same data object will generate a nested TypeScript interface:
+
+```tsx
+{
+    user: {
+        name: string;
+        profile: {
+            bio: string;
+        };
+    };
+}
+```
+
+This ensures that your TypeScript interfaces match the structure of your JSON output when using dotted notation expansion.

src/Support/TypeScriptTransformer/DataTypeScriptTransformer.php

@@ -2,6 +2,7 @@
 
 namespace Spatie\LaravelData\Support\TypeScriptTransformer;
 
+use Illuminate\Support\Arr;
 use phpDocumentor\Reflection\Fqsen;
 use phpDocumentor\Reflection\Type;
 use phpDocumentor\Reflection\Types\Array_;
@@ -55,9 +56,9 @@ protected function transformProperties(
 
         $isOptional = $dataClass->attributes->has(TypeScriptOptional::class);
 
-        return array_reduce(
+        $results = array_reduce(
             $this->resolveProperties($class),
-            function (string $carry, ReflectionProperty $property) use ($isOptional, $dataClass, $missingSymbols) {
+            function (array $carry, ReflectionProperty $property) use ($isOptional, $dataClass, $missingSymbols) {
                 /** @var \Spatie\LaravelData\Support\DataProperty $dataProperty */
                 $dataProperty = $dataClass->properties[$property->getName()];
 
@@ -88,16 +89,26 @@ function (string $carry, ReflectionProperty $property) use ($isOptional, $dataCl
 
                 $propertyName = $dataProperty->outputMappedName ?? $dataProperty->name;
 
-                if (! preg_match('/^[$_a-zA-Z][$_a-zA-Z0-9]*$/', $propertyName)) {
-                    $propertyName = "'{$propertyName}'";
+                if (config('data.features.expand_dot_notation') && str_contains($propertyName, '.')) {
+                    Arr::set(
+                        $carry,
+                        $propertyName,
+                        $isOptional
+                            ? "?: {$transformed}"
+                            : ": {$transformed}",
+                    );
+                } else {
+                    $carry[$propertyName] = $isOptional
+                        ? "?: {$transformed}"
+                        : ": {$transformed}";
                 }
 
-                return $isOptional
-                    ? "{$carry}{$propertyName}?: {$transformed};".PHP_EOL
-                    : "{$carry}{$propertyName}: {$transformed};".PHP_EOL;
+                return $carry;
             },
-            ''
+            []
         );
+
+        return $this->arrayToTypeScript($results);
     }
 
     protected function resolveTypeForProperty(
@@ -189,4 +200,23 @@ protected function cursorPaginatedCollectionType(string $class): Type
             ]),
         ]);
     }
+
+    protected function arrayToTypeScript(array $array): string
+    {
+        $carry = '';
+
+        foreach ($array as $propertyName => $value) {
+            if (! preg_match('/^[$_a-zA-Z][$_a-zA-Z0-9]*$/', $propertyName)) {
+                $propertyName = "'{$propertyName}'";
+            }
+
+            if (is_array($value)) {
+                $carry .= "{$propertyName}: {".PHP_EOL.$this->arrayToTypeScript($value).'};'.PHP_EOL;
+            } else {
+                $carry .= "{$propertyName}{$value};".PHP_EOL;
+            }
+        }
+
+        return $carry;
+    }
 }

tests/Support/TypeScriptTransformer/DataTypeScriptTransformerTest.php

@@ -340,3 +340,65 @@ public function __construct(
     expect($transformer->canTransform($reflection))->toBeTrue();
     assertMatchesSnapshot($transformer->transform($reflection, 'DataObject')->transformed);
 });
+
+it('handles dotted property names with expand_dot_notation disabled', function () {
+    $config = TypeScriptTransformerConfig::create();
+    config()->set('data.features.expand_dot_notation', false);
+
+    $data = new class ('hello', 'world') extends Data {
+        public function __construct(
+            #[MapOutputName('user.name')]
+            public string $userName,
+            #[MapOutputName('user.profile.bio')]
+            public string $userBio,
+        ) {
+        }
+    };
+
+    $transformer = new DataTypeScriptTransformer($config);
+    $reflection = new ReflectionClass($data);
+
+    expect($transformer->canTransform($reflection))->toBeTrue();
+    $this->assertEquals(
+        <<<TXT
+        {
+        'user.name': string;
+        'user.profile.bio': string;
+        }
+        TXT,
+        $transformer->transform($reflection, 'DataObject')->transformed
+    );
+});
+
+it('handles dotted property names with expand_dot_notation enabled', function () {
+    $config = TypeScriptTransformerConfig::create();
+    config()->set('data.features.expand_dot_notation', true);
+
+    $data = new class ('hello', 'world') extends Data {
+        public function __construct(
+            #[MapOutputName('user.name')]
+            public string $userName,
+            #[MapOutputName('user.profile.bio')]
+            public string $userBio,
+        ) {
+        }
+    };
+
+    $transformer = new DataTypeScriptTransformer($config);
+    $reflection = new ReflectionClass($data);
+
+    expect($transformer->canTransform($reflection))->toBeTrue();
+    $this->assertEquals(
+        <<<TXT
+        {
+        user: {
+        name: string;
+        profile: {
+        bio: string;
+        };
+        };
+        }
+        TXT,
+        $transformer->transform($reflection, 'DataObject')->transformed
+    );
+});