Skip to content

Commit c7a4be1

Browse files
rubenvanasscherubenvanassche
committed
Rollback to typescript transformer 2
1 parent a0a163b commit c7a4be1

File tree

23 files changed

+380
-327
lines changed

23 files changed

+380
-327
lines changed

‎src/Support/TypeScriptTransformer/DataTypeScriptCollector.php

+22
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
<?php
2+
3+
namespace Spatie\LaravelData\Support\TypeScriptTransformer;
4+
5+
use ReflectionClass;
6+
use Spatie\LaravelData\Contracts\BaseData;
7+
use Spatie\TypeScriptTransformer\Collectors\Collector;
8+
use Spatie\TypeScriptTransformer\Structures\TransformedType;
9+
10+
class DataTypeScriptCollector extends Collector
11+
{
12+
public function getTransformedType(ReflectionClass $class): ?TransformedType
13+
{
14+
if (! $class->isSubclassOf(BaseData::class)) {
15+
return null;
16+
}
17+
18+
$transformer = new DataTypeScriptTransformer($this->config);
19+
20+
return $transformer->transform($class, $class->getShortName());
21+
}
22+
}

‎src/Support/TypeScriptTransformer/DataTypeScriptTransformer.php

+155-7
Original file line numberDiff line numberDiff line change
@@ -2,21 +2,169 @@
22

33
namespace Spatie\LaravelData\Support\TypeScriptTransformer;
44

5+
use phpDocumentor\Reflection\Fqsen;
6+
use phpDocumentor\Reflection\Type;
7+
use phpDocumentor\Reflection\Types\Array_;
8+
use phpDocumentor\Reflection\Types\Boolean;
9+
use phpDocumentor\Reflection\Types\Integer;
10+
use phpDocumentor\Reflection\Types\Nullable;
11+
use phpDocumentor\Reflection\Types\Object_;
12+
use phpDocumentor\Reflection\Types\String_;
513
use ReflectionClass;
14+
use ReflectionProperty;
15+
use RuntimeException;
616
use Spatie\LaravelData\Contracts\BaseData;
7-
use Spatie\TypeScriptTransformer\Transformers\ClassTransformer;
17+
use Spatie\LaravelData\Enums\DataTypeKind;
18+
use Spatie\LaravelData\Support\DataConfig;
19+
use Spatie\LaravelData\Support\DataProperty;
20+
use Spatie\LaravelData\Support\Lazy\ClosureLazy;
21+
use Spatie\LaravelTypeScriptTransformer\Transformers\DtoTransformer;
22+
use Spatie\TypeScriptTransformer\Attributes\Optional as TypeScriptOptional;
23+
use Spatie\TypeScriptTransformer\Structures\MissingSymbolsCollection;
24+
use Spatie\TypeScriptTransformer\TypeProcessors\DtoCollectionTypeProcessor;
25+
use Spatie\TypeScriptTransformer\TypeProcessors\ReplaceDefaultsTypeProcessor;
26+
use Spatie\TypeScriptTransformer\Types\StructType;
827

9-
class DataTypeScriptTransformer extends ClassTransformer
28+
class DataTypeScriptTransformer extends DtoTransformer
1029
{
11-
protected function shouldTransform(ReflectionClass $reflection): bool
30+
public function canTransform(ReflectionClass $class): bool
1231
{
13-
return $reflection->implementsInterface(BaseData::class);
32+
return $class->isSubclassOf(BaseData::class);
1433
}
1534

16-
protected function classPropertyProcessors(): array
35+
protected function typeProcessors(): array
1736
{
18-
return array_merge(parent::classPropertyProcessors(), [
19-
new DataUtilitiesClassPropertyProcessor(),
37+
return [
38+
new ReplaceDefaultsTypeProcessor(
39+
$this->config->getDefaultTypeReplacements()
40+
),
41+
new RemoveLazyTypeProcessor(),
42+
new RemoveOptionalTypeProcessor(),
43+
new DtoCollectionTypeProcessor(),
44+
];
45+
}
46+
47+
48+
protected function transformProperties(
49+
ReflectionClass $class,
50+
MissingSymbolsCollection $missingSymbols
51+
): string {
52+
$dataClass = app(DataConfig::class)->getDataClass($class->getName());
53+
54+
$isOptional = $dataClass->attributes->contains(
55+
fn (object $attribute) => $attribute instanceof TypeScriptOptional
56+
);
57+
58+
return array_reduce(
59+
$this->resolveProperties($class),
60+
function (string $carry, ReflectionProperty $property) use ($isOptional, $dataClass, $missingSymbols) {
61+
/** @var \Spatie\LaravelData\Support\DataProperty $dataProperty */
62+
$dataProperty = $dataClass->properties[$property->getName()];
63+
64+
$type = $this->resolveTypeForProperty($property, $dataProperty, $missingSymbols);
65+
66+
if ($type === null) {
67+
return $carry;
68+
}
69+
70+
$isOptional = $isOptional
71+
|| $dataProperty->attributes->contains(
72+
fn (object $attribute) => $attribute instanceof TypeScriptOptional
73+
)
74+
|| ($dataProperty->type->lazyType && $dataProperty->type->lazyType !== ClosureLazy::class)
75+
|| $dataProperty->type->isOptional;
76+
77+
$transformed = $this->typeToTypeScript(
78+
$type,
79+
$missingSymbols,
80+
$property->getDeclaringClass()->getName(),
81+
);
82+
83+
$propertyName = $dataProperty->outputMappedName ?? $dataProperty->name;
84+
85+
if (! preg_match('/^[$_a-zA-Z][$_a-zA-Z0-9]*$/', $propertyName)) {
86+
$propertyName = "'{$propertyName}'";
87+
}
88+
89+
return $isOptional
90+
? "{$carry}{$propertyName}?: {$transformed};" . PHP_EOL
91+
: "{$carry}{$propertyName}: {$transformed};" . PHP_EOL;
92+
},
93+
''
94+
);
95+
}
96+
97+
protected function resolveTypeForProperty(
98+
ReflectionProperty $property,
99+
DataProperty $dataProperty,
100+
MissingSymbolsCollection $missingSymbols,
101+
): ?Type {
102+
if (! $dataProperty->type->kind->isDataCollectable()) {
103+
return $this->reflectionToType(
104+
$property,
105+
$missingSymbols,
106+
...$this->typeProcessors()
107+
);
108+
}
109+
110+
$collectionType = match ($dataProperty->type->kind) {
111+
DataTypeKind::DataCollection, DataTypeKind::Array, DataTypeKind::Enumerable => $this->defaultCollectionType($dataProperty->type->dataClass),
112+
DataTypeKind::Paginator, DataTypeKind::DataPaginatedCollection => $this->paginatedCollectionType($dataProperty->type->dataClass),
113+
DataTypeKind::CursorPaginator, DataTypeKind::DataCursorPaginatedCollection => $this->cursorPaginatedCollectionType($dataProperty->type->dataClass),
114+
null => throw new RuntimeException('Cannot end up here since the type is dataCollectable')
115+
};
116+
117+
if ($dataProperty->type->isNullable()) {
118+
return new Nullable($collectionType);
119+
}
120+
121+
return $collectionType;
122+
}
123+
124+
protected function defaultCollectionType(string $class): Type
125+
{
126+
return new Array_(new Object_(new Fqsen("\\{$class}")));
127+
}
128+
129+
protected function paginatedCollectionType(string $class): Type
130+
{
131+
return new StructType([
132+
'data' => $this->defaultCollectionType($class),
133+
'links' => new Array_(new StructType([
134+
'url' => new Nullable(new String_()),
135+
'label' => new String_(),
136+
'active' => new Boolean(),
137+
])),
138+
'meta' => new StructType([
139+
'current_page' => new Integer(),
140+
'first_page_url' => new String_(),
141+
'from' => new Nullable(new Integer()),
142+
'last_page' => new Integer(),
143+
'last_page_url' => new String_(),
144+
'next_page_url' => new Nullable(new String_()),
145+
'path' => new String_(),
146+
'per_page' => new Integer(),
147+
'prev_page_url' => new Nullable(new String_()),
148+
'to' => new Nullable(new Integer()),
149+
'total' => new Integer(),
150+
151+
]),
152+
]);
153+
}
154+
155+
protected function cursorPaginatedCollectionType(string $class): Type
156+
{
157+
return new StructType([
158+
'data' => $this->defaultCollectionType($class),
159+
'links' => new Array_(),
160+
'meta' => new StructType([
161+
'path' => new String_(),
162+
'per_page' => new Integer(),
163+
'next_cursor' => new Nullable(new String_()),
164+
'next_cursor_url' => new Nullable(new String_()),
165+
'prev_cursor' => new Nullable(new String_()),
166+
'prev_cursor_url' => new Nullable(new String_()),
167+
]),
20168
]);
21169
}
22170
}

‎src/Support/TypeScriptTransformer/DataUtilitiesClassPropertyProcessor.php

-139
This file was deleted.

‎src/Support/TypeScriptTransformer/RemoveLazyTypeProcessor.php

+47
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
<?php
2+
3+
namespace Spatie\LaravelData\Support\TypeScriptTransformer;
4+
5+
use Exception;
6+
use phpDocumentor\Reflection\Type;
7+
use phpDocumentor\Reflection\Types\Compound;
8+
use phpDocumentor\Reflection\Types\Object_;
9+
use ReflectionMethod;
10+
use ReflectionParameter;
11+
use ReflectionProperty;
12+
use Spatie\LaravelData\Lazy;
13+
use Spatie\TypeScriptTransformer\Structures\MissingSymbolsCollection;
14+
use Spatie\TypeScriptTransformer\TypeProcessors\TypeProcessor;
15+
16+
class RemoveLazyTypeProcessor implements TypeProcessor
17+
{
18+
public function process(
19+
Type $type,
20+
ReflectionParameter | ReflectionMethod | ReflectionProperty $reflection,
21+
MissingSymbolsCollection $missingSymbolsCollection
22+
): ?Type {
23+
if (! $type instanceof Compound) {
24+
return $type;
25+
}
26+
27+
/** @var \Illuminate\Support\Collection $types */
28+
$types = collect(iterator_to_array($type->getIterator()))
29+
->reject(function (Type $type) {
30+
if (! $type instanceof Object_) {
31+
return false;
32+
}
33+
34+
return is_a((string)$type->getFqsen(), Lazy::class, true);
35+
});
36+
37+
if ($types->isEmpty()) {
38+
throw new Exception("Type {$reflection->getDeclaringClass()->name}:{$reflection->getName()} cannot be only Lazy");
39+
}
40+
41+
if ($types->count() === 1) {
42+
return $types->first();
43+
}
44+
45+
return new Compound($types->all());
46+
}
47+
}

0 commit comments

Comments
 (0)