Laravel TypeScript Transformer

https://github.com/spatie/laravel-typescript-transformer
Admin
Laravel TypeScript Transformer is a package that converts PHP classes and structures into TypeScript...
Tokens:41,030
Snippets:344
Trust Score:10
License:MIT
Update:3 days ago
Show doc for...
Tokens:
Raw
### Usage examples for typescript:dump-routes

Source: https://github.com/spatie/laravel-typescript-transformer

Internal usage examples: one with the literal 'null' filter and the --include-route-closures flag, and another passing a base64-encoded serialized filter string.

```bash
php artisan typescript:dump-routes "null" --include-route-closures
```

```bash
php artisan typescript:dump-routes "$(base64 <<< 'C:...')"
```

--------------------------------

### Configure transformers, directories, writer, and formatter

Source: https://github.com/spatie/laravel-typescript-transformer

Example configuration from the published stub, setting transformers, directories, writer, and formatter.

```php
$config
    ->transformer(AttributedClassTransformer::class)
    ->transformer(EnumTransformer::class)
    ->transformDirectories(app_path())
    ->writer(new GlobalNamespaceWriter('generated.d.ts'))
    ->formatter(PrettierFormatter::class);
```

--------------------------------

### Usage example

Source: https://github.com/spatie/laravel-typescript-transformer

Example of instantiating DataClassTransformer with custom lazy types and nullableAsOptional set to true.

```php
use Spatie\LaravelTypeScriptTransformer\LaravelData\Transformers\DataClassTransformer;

$transformer = new DataClassTransformer(
    customLazyTypes: [CustomLazy::class],
    nullableAsOptional: true,
);
```

--------------------------------

### Usage example: app/Providers/TypeScriptTransformerServiceProvider.php

Source: https://github.com/spatie/laravel-typescript-transformer

Example provider subclassing the application service provider, as published by php artisan typescript:install.

```php
<?php

namespace App\Providers;

use Spatie\TypeScriptTransformer\Formatters\PrettierFormatter;
use Spatie\TypeScriptTransformer\Transformers\AttributedClassTransformer;
use Spatie\TypeScriptTransformer\Transformers\EnumTransformer;
use Spatie\TypeScriptTransformer\TypeScriptTransformerConfigFactory;
use Spatie\TypeScriptTransformer\Writers\GlobalNamespaceWriter;
use Spatie\LaravelTypeScriptTransformer\TypeScriptTransformerApplicationServiceProvider as BaseTypeScriptTransformerServiceProvider;

class TypeScriptTransformerServiceProvider extends BaseTypeScriptTransformerServiceProvider
{
    protected function configure(TypeScriptTransformerConfigFactory $config): void
    {
        $config
            ->transformer(AttributedClassTransformer::class)
            ->transformer(EnumTransformer::class)
            ->transformDirectories(app_path())
            ->writer(new GlobalNamespaceWriter('generated.d.ts'))
            ->formatter(PrettierFormatter::class);
    }
}
```

--------------------------------

### Manual construction example with StrippedActionNameResolver

Source: https://github.com/spatie/laravel-typescript-transformer

Shows how to manually instantiate the provider, overriding the action name resolver and HTTP method priority, then set the PHP node collection and actions. Useful for testing or custom integration.

```php
use Spatie\LaravelTypeScriptTransformer\ActionNameResolvers\StrippedActionNameResolver;
use Spatie\LaravelTypeScriptTransformer\TransformedProviders\LaravelControllerTransformedProvider;

$provider = new LaravelControllerTransformedProvider(
    actionNameResolver: new StrippedActionNameResolver([
        'App\Http\Controllers' => null,
    ]),
    httpMethodsPriority: ['get', 'post', 'delete'],
);
$provider->setPhpNodeCollection(new PhpNodeCollection());
$provider->setActions(new TransformedProviderActions());
```

--------------------------------

### Usage examples for typescript:transform

Source: https://github.com/spatie/laravel-typescript-transformer

Shows one-shot transformation and watch mode with worker subprocess.

```bash
# one-shot transformation (Direct mode)
php artisan typescript:transform

# watch mode, spawning a worker subprocess (Master)
php artisan typescript:transform --watch
```

--------------------------------

### Usage example in application provider configure()

Source: https://github.com/spatie/laravel-typescript-transformer

Shows how to register the LaravelDataTypeScriptTransformerExtension in an application provider's configure() method, passing custom lazy types and data collections, and chaining transformer and directory transformations.

```php
use Spatie\LaravelTypeScriptTransformer\LaravelData\LaravelDataTypeScriptTransformerExtension;
use Spatie\LaravelTypeScriptTransformer\LaravelTypeScriptTransformerExtension;

protected function configure($config): void
{
    $config
        ->extension(new LaravelDataTypeScriptTransformerExtension(
            customLazyTypes: [MyLazyType::class],
            customDataCollections: [MyCollection::class],
        ))
        ->transformer(AttributedClassTransformer::class)
        ->transformDirectories(app_path());
}
```

--------------------------------

### InstallTypeScriptTransformerCommand properties

Source: https://github.com/spatie/laravel-typescript-transformer

Defines the command signature, description, and provider class for the typescript:install artisan command.

```php
public $signature = 'typescript:install';
public $description = 'Installs TypeScript transformer within your Laravel application.';
protected string $provider = 'App\Providers\TypeScriptTransformerServiceProvider';
```

--------------------------------

### Instantiate LaravelRouteTransformedProvider

Source: https://github.com/spatie/laravel-typescript-transformer

Example of creating a LaravelRouteTransformedProvider instance with absoluteUrlsByDefault set to false, then calling provide() to get an array of Transformed objects.

```php
use Spatie\LaravelTypeScriptTransformer\TransformedProviders\LaravelRouteTransformedProvider;

$provider = new LaravelRouteTransformedProvider(
    absoluteUrlsByDefault: false,
);
$transformed = $provider->provide(); // array of Transformed
```

--------------------------------

### Example usage of ResolveLaravelControllerMethodAction

Source: https://github.com/spatie/laravel-typescript-transformer

Example showing how to instantiate and call the action. The result contains TypeScript nodes for the request (from the BaseData parameter) and response (resolved return shape).

```php
use Spatie\LaravelTypeScriptTransformer\Actions\ResolveLaravelControllerMethodAction;
use Spatie\TypeScriptTransformer\PhpNodes\PhpClassNode;

$result = (new ResolveLaravelControllerMethodAction())->execute(
    PhpClassNode::fromClassString(UserController::class),
    'store',
);
// $result['request']  => TypeScriptNode (the FormData object, from the BaseData param)
// $result['response'] => TypeScriptNode (resolved return shape)
```

--------------------------------

### ControllerRouteFilter usage examples

Source: https://github.com/spatie/laravel-typescript-transformer

Shows how to hide a single controller, all controllers in a namespace, or specific controller+action pairs using wildcards.

```php
use Spatie\LaravelTypeScriptTransformer\RouteFilters\ControllerRouteFilter;

// hide a single controller
$filter = new ControllerRouteFilter(UserController::class);

// hide every controller in a namespace
$filter = new ControllerRouteFilter('App\Http\Controllers\Api\*');

// hide specific controller+action pairs
$filter = new ControllerRouteFilter(
    [ResourceController::class, 'index'],
    [ResourceController::class, 'edit'],
);
```

--------------------------------

### ClosureRouteFilter usage example

Source: https://github.com/spatie/laravel-typescript-transformer

Creates a filter that hides routes whose URI starts with 'admin/'.

```php
use Illuminate\Routing\Route;
use Spatie\LaravelTypeScriptTransformer\RouteFilters\ClosureRouteFilter;

$filter = new ClosureRouteFilter(
    fn (Route $route) => str_starts_with($route->uri, 'admin/'),
);
```

--------------------------------

### StrippedActionNameResolver usage examples

Source: https://github.com/spatie/laravel-typescript-transformer

Shows three usage scenarios: stripping a prefix entirely, replacing a prefix with a custom segment, and falling back to default splitting when no prefix matches.

```php
use Spatie\LaravelTypeScriptTransformer\ActionNameResolvers\StrippedActionNameResolver;

// strip the App\Http\Controllers prefix entirely
$resolver = new StrippedActionNameResolver(['App\Http\Controllers' => null]);
$resolver->resolve('App\Http\Controllers\Api\UserController');
// => ['Api', 'UserController']

// replace the prefix with a custom segment
$resolver = new StrippedActionNameResolver(['App\Http\Controllers' => 'Http']);
$resolver->resolve('App\Http\Controllers\UserController');
// => ['Http', 'UserController']

// no matching prefix → default split
$resolver = new StrippedActionNameResolver([]);
$resolver->resolve('Vendor\Package\SomeController');
// => ['Vendor', 'Package', 'SomeController']
```

--------------------------------

### ClosureActionNameResolver usage example

Source: https://github.com/spatie/laravel-typescript-transformer

Instantiates the resolver with a closure that slices the class name by backslashes, starting from index 2.

```php
use Spatie\LaravelTypeScriptTransformer\ActionNameResolvers\ClosureActionNameResolver;

$resolver = new ClosureActionNameResolver(
    fn (string $class) => array_slice(explode('\\', $class), 2),
);
```

--------------------------------

### NamedRouteFilter usage example

Source: https://github.com/spatie/laravel-typescript-transformer

Creates a filter that hides routes named 'simple', any name starting with 'resource.', and 'dashboard'.

```php
use Spatie\LaravelTypeScriptTransformer\RouteFilters\NamedRouteFilter;

$filter = new NamedRouteFilter('simple', 'resource.*', 'dashboard');
```

--------------------------------

### Run tests with composer

Source: https://github.com/spatie/laravel-typescript-transformer/blob/main/README.md

Command to run the package's test suite.

```bash
composer test
```

--------------------------------

### InstallTypeScriptTransformerCommand handle method

Source: https://github.com/spatie/laravel-typescript-transformer

Method signature for the handle method that runs when the command is executed.

```php
public function handle(): void
```

--------------------------------

### InstallTypeScriptTransformerCommand registerServiceProvider method

Source: https://github.com/spatie/laravel-typescript-transformer

Method signature for registering the service provider in bootstrap/providers.php.

```php
protected function registerServiceProvider(): void
```

--------------------------------

### handle() method implementation

Source: https://github.com/spatie/laravel-typescript-transformer

Processes the 'filters' argument (converting the literal string 'null' to null), resolves the route collection via ResolveRouteCollectionAction, and writes the serialized RouteCollection to stdout. Returns self::SUCCESS.

```php
public function handle(
    ResolveRouteCollectionAction $resolveRouteCollectionAction
): int {
    $filters = $this->argument('filters');

    if ($filters === 'null') {
        $filters = null;
    }

    $routeCollection = $resolveRouteCollectionAction->execute(
        includeRouteClosures: $this->option('include-route-closures'),
        filters: $filters === null ? [] : unserialize(base64_decode($filters))
    );

    $this->output->write(serialize($routeCollection));

    return self::SUCCESS;
}
```

--------------------------------

### bootingPackage method signature

Source: https://github.com/spatie/laravel-typescript-transformer

Method signature for booting the package.

```php
public function bootingPackage(): void
```

--------------------------------

### formatTitle method

Source: https://github.com/spatie/laravel-typescript-transformer

Returns a bracket-prefixed heading like '[title] ' when a title is provided, otherwise an empty string. This is used to group messages with a heading.

```php
protected function formatTitle(
    ?string $title = null
): string {
    return $title ? "[$title] " : '';
}
```

--------------------------------

### Constructor with default dependencies

Source: https://github.com/spatie/laravel-typescript-transformer

Constructor for ResolveLaravelControllerMethodAction. All parameters are optional and default to new instances of DocTypeResolver, TranspilePhpStanTypeToTypeScriptNodeAction, and TranspilePhpTypeNodeToTypeScriptNodeAction.

```php
public function __construct(
    protected DocTypeResolver $docTypeResolver = new DocTypeResolver(),
    protected TranspilePhpStanTypeToTypeScriptNodeAction $transpilePhpStanAction = new TranspilePhpStanTypeToTypeScriptNodeAction(),
    protected TranspilePhpTypeNodeToTypeScriptNodeAction $transpilePhpTypeAction = new TranspilePhpTypeNodeToTypeScriptNodeAction(),
) {
}
```

--------------------------------

### LaravelConsoleLogger constructor

Source: https://github.com/spatie/laravel-typescript-transformer

The constructor accepts an Illuminate\Console\Command instance, which is used to invoke output methods for each log level.

```php
public function __construct(
    protected Command $command
) {
}
```

--------------------------------

### Constructor with custom lazy types and nullableAsOptional

Source: https://github.com/spatie/laravel-typescript-transformer

Constructor accepts an array of extra lazy class strings and a flag to treat nullable properties as optional. Custom lazy types are merged into the built-in list.

```php
public function __construct(
    protected array $customLazyTypes = [],
    protected bool $nullableAsOptional = false,
) {
    $this->lazyTypes = array_merge($this->lazyTypes, $this->customLazyTypes);
}
```

--------------------------------

### configurePackage method signature

Source: https://github.com/spatie/laravel-typescript-transformer

Method signature for configuring the package.

```php
public function configurePackage(Package $package): void
```

--------------------------------

### provide method

Source: https://github.com/spatie/laravel-typescript-transformer

Resolves the RouteCollection, hashes it, merges support and transformed items, assigns the writer to items lacking one, and returns the Transformed array.

```php
public function provide(): array
```

--------------------------------

### Usage in TransformTypeScriptCommand::handle()

Source: https://github.com/spatie/laravel-typescript-transformer

Instances are constructed automatically inside TransformTypeScriptCommand::handle() and passed to the core Runner. The logger is used to surface transformer progress and problems on the CLI.

```php
$runner->run(
    logger: new LaravelConsoleLogger($this),
    config: app(TypeScriptTransformerConfig::class),
    mode: ...,
    workerCommand: fn (bool $watch) => 'artisan typescript:transform --worker '.($watch ? '--watch ' : ''),
);
```

--------------------------------

### Handle method for TransformTypeScriptCommand

Source: https://github.com/spatie/laravel-typescript-transformer

Executes the runner with mode selected by --watch and --worker flags. Fails if the TypeScriptTransformerConfig is not bound in the container.

```php
public function handle(Runner $runner): int
{
    if (! app()->has(TypeScriptTransformerConfig::class)) {
        $this->error('TypeScript Transformer is not configured. Run `php artisan typescript:install` first.');
        return self::FAILURE;
    }

    return $runner->run(
        logger: new LaravelConsoleLogger($this),
        config: app(TypeScriptTransformerConfig::class),
        mode: match ([$this->option('watch'), $this->option('worker')]) {
            [false, false] => RunnerMode::Direct,
            [true, false] => RunnerMode::Master,
            [true, true] => RunnerMode::Worker,
            default => throw new Exception('A worker only needs to be started in watch mode.'),
        },
        workerCommand: fn (bool $watch) => 'artisan typescript:transform --worker '.($watch ? '--watch ' : ''),
    );
}
```

--------------------------------

### Override configure method in TypeScriptTransformerApplicationServiceProvider

Source: https://github.com/spatie/laravel-typescript-transformer

Abstract method to override when subclassing the provider to configure the package. Called during registration before defaults are applied.

```php
abstract protected function configure(TypeScriptTransformerConfigFactory $config): void;
```

--------------------------------

### Constructor for LaravelControllerTransformedProvider

Source: https://github.com/spatie/laravel-typescript-transformer

Configures the provider with output location, action name resolver, filters, route resolver, controller collection, support action generator, and HTTP method priority. Closures are always excluded via includeRouteClosures: false.

```php
public function __construct(
    protected string $location = 'controllers',
    protected ActionNameResolver $actionNameResolver = new DefaultActionNameResolver(),
    array $filters = [],
    ResolveRouteCollectionAction $resolveRouteCollectionAction = new ResolveRouteCollectionAction(),
    ?array $routeDirectories = null,
    protected LaravelControllersCollection $controllersCollection = new LaravelControllersCollection(),
    protected GenerateControllerSupportAction $generateSupportAction = new GenerateControllerSupportAction(),
    protected array $httpMethodsPriority = ['get', 'post', 'put', 'patch', 'delete'],
) {
    $this->httpMethodsPriority = array_map('strtolower', $this->httpMethodsPriority);
    parent::__construct(
        resolveRouteCollectionAction: $resolveRouteCollectionAction,
        includeRouteClosures: false,
        filters: $filters,
        routeDirectories: $routeDirectories,
        writer: new ModuleWriter($this->location),
    );
}
```

--------------------------------

### TypeScriptTransformerServiceProvider::bootingPackage

Source: https://github.com/spatie/laravel-typescript-transformer

Publishes the provider stub during console runs, allowing the application to customize the service provider. This method is called during package booting.

```APIDOC
## bootingPackage(): void

### Description
In console runs, publishes the provider stub with the tag `typescript-transformer-provider`. The stub is copied from `stubs/TypeScriptTransformerServiceProvider.stub` to `app_path('Providers/TypeScriptTransformerServiceProvider.php')`.

### Method
`bootingPackage`

### Parameters
None.

### Response
No return value.
```

--------------------------------

### TypeScriptTransformerApplicationServiceProvider::register

Source: https://github.com/spatie/laravel-typescript-transformer

Binds the core configuration object as a singleton in the Laravel container. After registration, `app(TypeScriptTransformerConfig::class)` is available and the `typescript:transform` command works.

```APIDOC
## register(): void

### Description
Binds `Spatie\TypeScriptTransformer\TypeScriptTransformerConfig::class` in the container as a singleton. The binding creates a new `TypeScriptTransformerConfigFactory` with default settings, calls the `configure` method, and returns the built config.

### Method
`register`

### Parameters
None.

### Response
No return value.
```

--------------------------------

### StrippedActionNameResolver constructor

Source: https://github.com/spatie/laravel-typescript-transformer

Constructor for StrippedActionNameResolver. Accepts an optional array of prefix=>replacement mappings. A null replacement removes the prefix entirely.

```php
public function __construct(
    protected array $prefixes = [],
) {
}
```

--------------------------------

### Set data.name_mapping_strategy.output config

Source: https://github.com/spatie/laravel-typescript-transformer

Sets the global fallback output name mapper for Laravel Data. Used when no MapOutputName/MapName attribute is present on the property or class. Must re-resolve the DataConfig instance after setting the config.

```php
config()->set('data.name_mapping_strategy.output', SnakeCaseMapper::class);
app()->forgetInstance(DataConfig::class); // re-resolves the mapper
```

--------------------------------

### handleWatchEvent method

Source: https://github.com/spatie/laravel-typescript-transformer

Handles watch-mode updates. Non-SummarizedWatchEvent events return continue immediately. Logs a message, runs a nested artisan command with a 2-second timeout, and updates the collection if the output differs from the hash.

```php
public function handleWatchEvent(WatchEvent $watchEvent, TransformedCollection $transformedCollection): ?WatchEventResult
```

--------------------------------

### Singleton binding for TypeScriptTransformerConfig

Source: https://github.com/spatie/laravel-typescript-transformer

Binds the configuration object as a singleton in the container.

```php
$this->app->singleton(TypeScriptTransformerConfig::class, function () {
    $builder = (new TypeScriptTransformerConfigFactory())
        ->outputDirectory(resource_path('js/generated'))
        ->configPath((new ReflectionClass($this))->getFileName())
        ->writer(new GlobalNamespaceWriter());

    $this->configure($builder);

    return $builder->get();
});
```

--------------------------------

### directoriesToWatch method

Source: https://github.com/spatie/laravel-typescript-transformer

Returns the directories watched for route changes, which is the routeDirectories property set in the constructor.

```php
public function directoriesToWatch(): array
```

--------------------------------

### RouteController class

Source: https://github.com/spatie/laravel-typescript-transformer

Represents a controller with its actions, file path, and invokable status.

```php
class RouteController
{
    /** @param array<int, RouteControllerAction> $actions */
    public function __construct(
        public string $class,
        public string $file,
        public bool $invokable,
        public array $actions,
    ) {
    }
}
```

--------------------------------

### ResolveRouteCollectionAction supporting methods

Source: https://github.com/spatie/laravel-typescript-transformer

Protected helper methods used internally by the action. resolveRouteParameters extracts route placeholders and marks optional ones; resolveControllerFile resolves the controller source file; resolveUrl builds the route URL by removing trailing question marks from optional parameters.

```php
protected function resolveRouteParameters(Route $route): array
// @return array<array{name: string, optional: bool}>
```

```php
protected function resolveControllerFile(string $controllerClass): ?string
protected function resolveUrl(Route $route): string
// str_replace('?}', '}', $route->getDomain().ltrim($route->uri, '/'))
```

--------------------------------

### execute method signature for GenerateControllerSupportAction

Source: https://github.com/spatie/laravel-typescript-transformer

Defines the execute method with a default array of HTTP methods. Throws InvalidArgumentException if an empty array is passed, and returns cached support if available.

```php
/** @param array<int, string> $httpMethods */
public function execute(array $httpMethods = ['get', 'post', 'put', 'patch', 'delete']): array
```

--------------------------------

### Static NameMapper caching in applyOutputMapper

Source: https://github.com/spatie/laravel-typescript-transformer

Instantiates and caches NameMapper instances statically. If the resolved mapper is neither a NameMapper instance nor a class-string subclass, it is returned as-is (assumed to be a literal string/int output name).

```php
return (self::$mappers[$value] ??= new $value())->map($propertyName);
```

--------------------------------

### TypeScriptTransformerServiceProvider::configurePackage

Source: https://github.com/spatie/laravel-typescript-transformer

Registers the package with Laravel, defining the package name and associated artisan commands. This method is called during package bootstrapping.

```APIDOC
## configurePackage(Package $package): void

### Description
Registers a package named `typescript-transformer` with three commands: `typescript:transform`, `typescript:dump-routes` (hidden), and `typescript:install`.

### Method
`configurePackage`

### Parameters
- **$package** (Package) - Required - The package instance to configure.

### Response
No return value.
```

--------------------------------

### DataClassTransformer constructor

Source: https://github.com/spatie/laravel-typescript-transformer

Constructor for DataClassTransformer with optional parameters for custom lazy types, custom data collections, nullable as optional, and type transpilers.

```php
public function __construct(
    protected array $customLazyTypes = [],
    protected array $customDataCollections = [],
    protected bool $nullableAsOptional = false,
    DocTypeResolver $docTypeResolver = new DocTypeResolver(),
    TranspilePhpStanTypeToTypeScriptNodeAction $transpilePhpStanTypeToTypeScriptTypeAction = new TranspilePhpStanTypeToTypeScriptNodeAction(),
    TranspilePhpTypeNodeToTypeScriptNodeAction $transpilePhpTypeNodeToTypeScriptTypeAction = new TranspilePhpTypeNodeToTypeScriptNodeAction(),
) {
    parent::__construct($docTypeResolver, $transpilePhpStanTypeToTypeScriptTypeAction, $transpilePhpTypeNodeToTypeScriptTypeAction);
}
```

--------------------------------

### setLogger method

Source: https://github.com/spatie/laravel-typescript-transformer

Injects the Logger used for watch-mode error and info messages.

```php
public function setLogger(Logger $logger): void
```

--------------------------------

### ClosureActionNameResolver constructor

Source: https://github.com/spatie/laravel-typescript-transformer

Creates a resolver that wraps a closure in SerializableClosure to survive cross-process watch-mode dumps. The closure takes a controller FQCN and returns name segments.

```php
public function __construct(Closure $resolver)
{
    $this->resolver = new SerializableClosure($resolver);
}
```

--------------------------------

### resolveSupport method signature

Source: https://github.com/spatie/laravel-typescript-transformer

Protected method that returns the result of generateSupportAction->execute with the current httpMethodsPriority.

```php
protected function resolveSupport(): array
```

--------------------------------

### LaravelDataTypeScriptTransformerExtension::__construct

Source: https://github.com/spatie/laravel-typescript-transformer

Constructor for the LaravelDataTypeScriptTransformerExtension class. Initializes the extension with optional custom lazy types and custom data collections.

```APIDOC
## Constructor

### Description
Initializes the extension with optional custom lazy types and custom data collections.

### Method
`__construct`

### Parameters
- `customLazyTypes` (array) - Optional - Additional class names treated as lazy types (hidden properties) in addition to the built-in Laravel Data lazy classes. Default: `[]`.
- `customDataCollections` (array) - Optional - Additional class names treated as array-like data collections (transpiled to arrays). Default: `[]`.

### Usage Example
```php
new LaravelDataTypeScriptTransformerExtension(
    customLazyTypes: [MyLazyType::class],
    customDataCollections: [MyCollection::class],
)
```
```

--------------------------------

### DataClassTransformer::__construct

Source: https://github.com/spatie/laravel-typescript-transformer

Creates a new DataClassTransformer instance. Configures custom lazy types, custom data collections, and nullable-as-optional behavior.

```APIDOC
## DataClassTransformer::__construct

### Description
Creates a new DataClassTransformer instance. Configures custom lazy types, custom data collections, and nullable-as-optional behavior.

### Method
Constructor

### Signature
```php
public function __construct(
    protected array $customLazyTypes = [],
    protected array $customDataCollections = [],
    protected bool $nullableAsOptional = false,
    DocTypeResolver $docTypeResolver = new DocTypeResolver(),
    TranspilePhpStanTypeToTypeScriptNodeAction $transpilePhpStanTypeToTypeScriptTypeAction = new TranspilePhpStanTypeToTypeScriptNodeAction(),
    TranspilePhpTypeNodeToTypeScriptNodeAction $transpilePhpTypeNodeToTypeScriptTypeAction = new TranspilePhpTypeNodeToTypeScriptNodeAction(),
)
```

### Parameters
- `customLazyTypes` (array) - Optional - Default: `[]` - Extra lazy class strings passed to the property processor
- `customDataCollections` (array) - Optional - Default: `[]` - Extra collection class strings to treat as array-like
- `nullableAsOptional` (bool) - Optional - Default: `false` - When `true`, `?Type` properties become optional (`Type?`) instead of `Type | null`
- `docTypeResolver` (DocTypeResolver) - Optional - Default: new instance - Used for docblock type resolution
- `transpilePhpStanTypeToTypeScriptTypeAction` (TranspilePhpStanTypeToTypeScriptNodeAction) - Optional - Default: new instance - PHPStan type transpiler
- `transpilePhpTypeNodeToTypeScriptTypeAction` (TranspilePhpTypeNodeToTypeScriptNodeAction) - Optional - Default: new instance - Native PHP type transpiler

### Usage Example
```php
use Spatie\LaravelTypeScriptTransformer\LaravelData\Transformers\DataClassTransformer;

$transformer = new DataClassTransformer(
    customLazyTypes: [CustomLazy::class],
    nullableAsOptional: true,
);
```
```

--------------------------------

### classPropertyProcessors method

Source: https://github.com/spatie/laravel-typescript-transformer

Returns an array of property processors for transforming class properties, including DataClassPropertyProcessor and FixArrayLikeStructuresClassPropertyProcessor.

```php
protected function classPropertyProcessors(): array
{
    return [
        new DataClassPropertyProcessor(
            $this->customLazyTypes,
            $this->nullableAsOptional,
        ),
        new FixArrayLikeStructuresClassPropertyProcessor(
            replaceArrays: true,
            arrayLikeClassesToReplace: [
                Collection::class,
                EloquentCollection::class,
                DataCollection::class,
                ...$this->customDataCollections,
            ]
        ),
    ];
}
```

--------------------------------

### StrippedActionNameResolver::__construct

Source: https://github.com/spatie/laravel-typescript-transformer

Constructor for the StrippedActionNameResolver that accepts a map of namespace prefixes to replacements. The replacement can be a string or null to remove the prefix entirely.

```APIDOC
## StrippedActionNameResolver::__construct

### Description
Initializes the resolver with a map of prefix => replacement. A null replacement removes the prefix entirely.

### Method
`__construct`

### Signature
`public function __construct(protected array $prefixes = [])`

### Parameters
- `$prefixes` (array<string, string|null>) - Optional - Map of namespace prefixes to replacements. Defaults to `[]`.

### Example
```php
$resolver = new StrippedActionNameResolver(['App\Http\Controllers' => null]);
```
```

--------------------------------

### ControllerRouteFilter constructor

Source: https://github.com/spatie/laravel-typescript-transformer

Accepts variadic arguments that are either class strings/globs or array pairs of controller class and action method globs.

```php
public function __construct(
    string|array ...$controllers
) {
    $this->controllers = $controllers;
}
```

--------------------------------

### TypeScriptTransformerApplicationServiceProvider::configure

Source: https://github.com/spatie/laravel-typescript-transformer

Abstract method that subclasses implement to configure the transformer. It receives a fluent builder to register transformers, writers, formatters, and directories to scan.

```APIDOC
## configure(TypeScriptTransformerConfigFactory $config): void

### Description
Abstract method that must be implemented by subclasses. It configures the transformer using the provided fluent builder. Defaults are applied before this method runs: output directory is `resource_path('js/generated')`, config path points to the provider file, and writer is `GlobalNamespaceWriter`.

### Method
`configure`

### Parameters
- **$config** (TypeScriptTransformerConfigFactory) - Required - The fluent builder for configuring the transformer.

### Response
No return value.
```

--------------------------------

### LaravelControllerTransformedProvider Integration

Source: https://github.com/spatie/laravel-typescript-transformer

Shows how to pass an action name resolver to LaravelControllerTransformedProvider.

```APIDOC
## LaravelControllerTransformedProvider Integration

### Description
Pass any action name resolver to LaravelControllerTransformedProvider to customize how controller names are resolved.

### Usage Example
```php
use Spatie\LaravelTypeScriptTransformer\ActionNameResolvers\StrippedActionNameResolver;
use Spatie\LaravelTypeScriptTransformer\TransformedProviders\LaravelControllerTransformedProvider;

$provider = new LaravelControllerTransformedProvider(
    actionNameResolver: new StrippedActionNameResolver([
        'App\Http\Controllers' => null,
    ]),
);
```
```

--------------------------------

### LaravelRouteTransformedProvider constructor

Source: https://github.com/spatie/laravel-typescript-transformer

Constructor for the LaravelRouteTransformedProvider. Accepts optional route resolver, filters, output path, watch directories, and a flag for absolute URLs. Sets includeRouteClosures to true and uses FlatModuleWriter.

```php
public function __construct(
    ResolveRouteCollectionAction $resolveRouteCollectionAction = new ResolveRouteCollectionAction(),
    array $filters = [],
    string $path = 'helpers/route.ts',
    ?array $routeDirectories = null,
    protected bool $absoluteUrlsByDefault = true,
) {
    parent::__construct(
        resolveRouteCollectionAction: $resolveRouteCollectionAction,
        includeRouteClosures: true,
        filters: $filters,
        routeDirectories: $routeDirectories,
        writer:  new FlatModuleWriter($path)
    );
}
```

--------------------------------

### LaravelControllerReference class

Source: https://github.com/spatie/laravel-typescript-transformer

Defines a reference to a Laravel controller item in the transformed collection. The constructor takes a controller class name and an optional export name. Static factories `supportItem`, `controller`, and `types` produce keys like `laravel-controller::support::{name}`, `laravel-controller::{class}`, and `laravel-controller::{class}::types`. Instance methods `getKey()` returns `laravel-controller::{class}[::{export}]` and `humanFriendlyName()` returns `{class}@{export}` or just `{class}`.

```php
final class LaravelControllerReference implements Reference
{
    public function __construct(
        protected string $controllerClass,
        protected ?string $export = null,
    ) {
    }
}
```

--------------------------------

### LaravelController constructor with typed properties

Source: https://github.com/spatie/laravel-typescript-transformer

Defines the LaravelController class with a constructor that accepts a RouteController, a PhpClassNode, an array of location segments, and per-method request/response type caches. The location array's last segment is used as the transformed name, and the methods array maps method names to TypeScriptNode request/response types.

```php
class LaravelController
{
    /**
     * @param array<string> $location
     * @param array<string, array{request: ?TypeScriptNode, response: ?TypeScriptNode}> $methods
     */
    public function __construct(
        public RouteController $routeController,
        public PhpClassNode $classNode,
        public array $location = [],
        public array $methods = [],
    ) {
    }
}
```

--------------------------------

### TypeScriptFunctionDeclaration for route helper

Source: https://github.com/spatie/laravel-typescript-transformer

Shows the structure of the TypeScript function declaration for the route helper, including generic type parameter, parameters, return type, and raw body.

```php
new TypeScriptFunctionDeclaration(
    new TypeScriptGeneric(new TypeScriptIdentifier('route'), [
        new TypeScriptGenericTypeParameter(new TypeScriptIdentifier('T'),
            extends: TypeScriptOperator::keyof(new TypeScriptIdentifier('RouteParameters'))),
    ]),
    [
        new TypeScriptParameter('name', new TypeScriptIdentifier('T')),
        new TypeScriptParameter('parameters', <conditional>, isOptional: true),
        new TypeScriptParameter('absolute', new TypeScriptIdentifier('boolean'),
            defaultValue: new TypeScriptLiteral($this->absoluteUrlsByDefault)),
    ],
    new TypeScriptString(),
    new TypeScriptRaw(<js body: throws if route not found, interpolates `{param}`, prefixes origin when absolute>),
)('route', body)
```

--------------------------------

### LaravelRouterTransformedProvider constructor

Source: https://github.com/spatie/laravel-typescript-transformer

Constructor for the abstract base class that derives TypeScript from the app's live Router. Injects dependencies for route resolution, closure inclusion, filters, directories to watch, and output writing. Defaults routeDirectories to routes/, bootstrap/, and app/Providers/ when null.

```php
public function __construct(
    protected ResolveRouteCollectionAction $resolveRouteCollectionAction,
    protected bool $includeRouteClosures,
    protected array $filters,
    protected ?array $routeDirectories,
    protected Writer $writer,
) {
    $this->routeDirectories ??= [
        base_path('routes'),
        base_path('bootstrap'),
        app_path('Providers'),
    ];
}
```

--------------------------------

### RouteControllerAction class

Source: https://github.com/spatie/laravel-typescript-transformer

Describes a single route action with method name, parameters, HTTP methods, URL, and optional route name.

```php
class RouteControllerAction
{
    /**
     * @param array<array{name: string, optional: bool}> $parameters
     * @param array<string> $methods
     */
    public function __construct(
        public string $methodName,
        public array $parameters,
        public array $methods,
        public string $url,
        public ?string $name,
    ) {
    }
}
```

--------------------------------

### NamedRouteFilter constructor

Source: https://github.com/spatie/laravel-typescript-transformer

Accepts variadic route-name globs to hide. Supports wildcards via Str::is.

```php
public function __construct(
    string ...$names
) {
    $this->names = $names;
}
```

--------------------------------

### StrippedActionNameResolver::resolve

Source: https://github.com/spatie/laravel-typescript-transformer

Resolves the controller FQCN by stripping configured prefixes. If a prefix matches, the replacement (or null to drop) is applied; otherwise falls back to default splitting.

```php
/** @return array<string> */
public function resolve(string $controllerClass): array
{
    $controllerClass = ltrim($controllerClass, '\\');

    foreach ($this->prefixes as $prefix => $replacement) {
        $prefix = ltrim($prefix, '\\');

        if (! str_starts_with($controllerClass, $prefix)) {
            continue;
        }

        $remainingSegments = explode('\\', ltrim(substr($controllerClass, strlen($prefix)), '\\'));

        if ($replacement === null) {
            return $remainingSegments;
        }

        return [$replacement, ...$remainingSegments];
    }

    return explode('\\', $controllerClass);
}
```

--------------------------------

### RouteClosure class

Source: https://github.com/spatie/laravel-typescript-transformer

Represents a closure-based route with parameters, HTTP methods, URL, and optional name.

```php
class RouteClosure
{
    /**
     * @param array<array{name: string, optional: bool}> $parameters
     * @param array<string> $methods
     */
    public function __construct(
        public array $parameters,
        public array $methods,
        public string $url,
        public ?string $name,
    ) {
    }
}
```

--------------------------------

### RouteCollection class

Source: https://github.com/spatie/laravel-typescript-transformer

Value object holding controllers and closures, serialized by the typescript:dump-routes command.

```php
class RouteCollection
{
    /**
     * @param array<string, RouteController> $controllers
     * @param array<string, RouteClosure> $closures
     */
    public function __construct(
        public array $controllers,
        public array $closures,
    ) {
    }
}
```

--------------------------------

### ClosureRouteFilter constructor

Source: https://github.com/spatie/laravel-typescript-transformer

Accepts a closure that returns true to hide a route. The filter is serializable via SerializableClosure.

```php
public function __construct(
    protected Closure $closure
) {
}
```

--------------------------------

### Constructor with customLazyTypes and customDataCollections

Source: https://github.com/spatie/laravel-typescript-transformer

Defines the constructor for LaravelDataTypeScriptTransformerExtension, accepting optional arrays of custom lazy types and custom data collections. These arrays extend the built-in Laravel Data lazy classes and array-like data collections.

```php
public function __construct(
    protected array $customLazyTypes = [],
    protected array $customDataCollections = [],
) {
}
```

--------------------------------

### ClosureActionNameResolver::__construct

Source: https://github.com/spatie/laravel-typescript-transformer

Creates a new resolver instance that uses a closure to resolve action names. The closure is wrapped in SerializableClosure to support watch-mode dumps.

```APIDOC
## ClosureActionNameResolver::__construct

### Description
Creates a new resolver instance that uses a closure to resolve action names. The closure is wrapped in SerializableClosure to support watch-mode dumps.

### Method
Constructor

### Signature
```php
public function __construct(Closure $resolver)
```

### Parameters
- `$resolver` (Closure(string): array<string>) - Required - Given a controller FQCN, returns the name segments

### Usage Example
```php
use Spatie\LaravelTypeScriptTransformer\ActionNameResolvers\ClosureActionNameResolver;

$resolver = new ClosureActionNameResolver(
    fn (string $class) => array_slice(explode('\\', $class), 2),
);
```
```

--------------------------------

### DefaultActionNameResolver::resolve

Source: https://github.com/spatie/laravel-typescript-transformer

Splits the controller FQCN on backslashes after stripping a leading backslash. Returns an array of segments, e.g., 'App\Http\Controllers\UserController' becomes ['App', 'Http', 'Controllers', 'UserController'].

```php
/** @return array<string> */
public function resolve(string $controllerClass): array
{
    return explode('\\', ltrim($controllerClass, '\\'));
}
```

--------------------------------

### ClosureRouteFilter serialization helpers

Source: https://github.com/spatie/laravel-typescript-transformer

Wraps the closure in SerializableClosure during serialization and restores it on unserialize, enabling use in cross-process watch-mode dumps.

```php
public function __serialize(): array
public function __unserialize(array $data): void
```

--------------------------------

### Generated TypeScript type for User class

Source: https://github.com/spatie/laravel-typescript-transformer/blob/main/README.md

The resulting TypeScript type from the User class. The nullable property becomes a union with null.

```ts
export type User = {
    id: number;
    name: string;
    address: string | null;
}
```

--------------------------------

### Integration with LaravelControllerTransformedProvider

Source: https://github.com/spatie/laravel-typescript-transformer

Passes a StrippedActionNameResolver to LaravelControllerTransformedProvider, mapping 'App\Http\Controllers' to null.

```php
use Spatie\LaravelTypeScriptTransformer\ActionNameResolvers\StrippedActionNameResolver;
use Spatie\LaravelTypeScriptTransformer\TransformedProviders\LaravelControllerTransformedProvider;

$provider = new LaravelControllerTransformedProvider(
    actionNameResolver: new StrippedActionNameResolver([
        'App\Http\Controllers' => null,
    ]),
);
```

--------------------------------

### execute method signature

Source: https://github.com/spatie/laravel-typescript-transformer

Signature for the execute method. Returns an array with 'request' and 'response' keys, each being a TypeScriptNode or null. If the method does not exist on the class, both are null.

```php
/** @return array{request: ?TypeScriptNode, response: ?TypeScriptNode} */
public function execute(PhpClassNode $classNode, string $methodName): array
```

--------------------------------

### Class declaration for TypeScriptTransformerApplicationServiceProvider

Source: https://github.com/spatie/laravel-typescript-transformer

Declares the abstract base provider for application subclasses.

```php
abstract class TypeScriptTransformerApplicationServiceProvider extends ServiceProvider
```

--------------------------------

### ActionNameResolver::resolve

Source: https://github.com/spatie/laravel-typescript-transformer

Interface method that maps a controller fully-qualified class name (FQCN) to an array of name segments used to build the generated TypeScript module path/location. Implementations must return an array of strings.

```APIDOC
## ActionNameResolver::resolve

### Description
Maps a controller FQCN to name segments (`array<string>`) used to build the generated TypeScript module path/location.

### Method
`resolve`

### Signature
`public function resolve(string $controllerClass): array`

### Parameters
- `$controllerClass` (string) - Required - The fully-qualified class name of the controller.

### Return Value
- `array<string>` - The name segments derived from the controller class name.

### Example
```php
$resolver = new DefaultActionNameResolver();
$segments = $resolver->resolve('App\Http\Controllers\UserController');
// => ['App', 'Http', 'Controllers', 'UserController']
```
```

--------------------------------

### StrippedActionNameResolver::resolve

Source: https://github.com/spatie/laravel-typescript-transformer

Resolves a controller FQCN to name segments, applying configured prefix stripping or replacement. Falls back to default splitting if no prefix matches.

```APIDOC
## StrippedActionNameResolver::resolve

### Description
Resolves a controller FQCN to name segments, applying configured prefix stripping or replacement. Falls back to default splitting if no prefix matches.

### Method
`resolve`

### Signature
`public function resolve(string $controllerClass): array`

### Parameters
- `$controllerClass` (string) - Required - The fully-qualified class name of the controller.

### Return Value
- `array<string>` - The name segments derived from the controller class name.

### Behavior
- If the FQCN does not start with any configured prefix, falls back to default segment splitting.
- If it starts with a prefix whose replacement is `null`, the prefix segment(s) are dropped, keeping nested namespaces.
- If it starts with a prefix whose replacement is a string, the replacement becomes the first segment followed by the remaining nested segments.

### Examples
```php
// strip the App\Http\Controllers prefix entirely
$resolver = new StrippedActionNameResolver(['App\Http\Controllers' => null]);
$resolver->resolve('App\Http\Controllers\Api\UserController');
// => ['Api', 'UserController']

// replace the prefix with a custom segment
$resolver = new StrippedActionNameResolver(['App\Http\Controllers' => 'Http']);
$resolver->resolve('App\Http\Controllers\UserController');
// => ['Http', 'UserController']

// no matching prefix → default split
$resolver = new StrippedActionNameResolver([]);
$resolver->resolve('Vendor\Package\SomeController');
// => ['Vendor', 'Package', 'SomeController']
```
```

--------------------------------

### Static cache property for GenerateControllerSupportAction

Source: https://github.com/spatie/laravel-typescript-transformer

Declares a static cache property that stores the generated support code. Used to avoid regenerating the support code on subsequent calls.

```php
/** @var ?array<Transformed> */
protected static ?array $cachedSupport = null;
```

--------------------------------

### LaravelRouteReference class

Source: https://github.com/spatie/laravel-typescript-transformer

Defines a reference to a Laravel route item in the transformed collection. The constructor is private, so use static factories `routes`, `routeParameters`, `function`, and `hasRouteFunction` to create instances. These produce keys like `laravel-route::routes`, `laravel-route::routeParameters`, `laravel-route::function`, and `laravel-route::hasRouteFunction`. Instance methods `getKey()` returns `laravel-route::{key}` and `humanFriendlyName()` returns `laravel-route::{key}`.

```php
final class LaravelRouteReference implements Reference
{
    private function __construct(
        protected string $key,
    ) {
    }
}
```

--------------------------------

### Abstract resolveTransformed method

Source: https://github.com/spatie/laravel-typescript-transformer

Abstract method that subclasses must implement to resolve transformed items from a RouteCollection.

```php
abstract protected function resolveTransformed(RouteCollection $routeCollection): array;
```

--------------------------------

### register method signature

Source: https://github.com/spatie/laravel-typescript-transformer

Method signature for the register method.

```php
public function register(): void
```

--------------------------------

### Usage in LaravelRouterTransformedProvider::handleWatchEvent()

Source: https://github.com/spatie/laravel-typescript-transformer

The logger is used to surface watch-mode route-collection updates and failures. Messages render immediately in the terminal of the master process during watch mode.

```php
$this->logger->info('Detected changes in route collection. Updating TypeScript definitions.');
// on timeout:
$this->logger->error('The nested command to dump the routes collection timed out.');
// on process failure:
$this->logger->error('The nested command to dump the routes collection failed.');
// on unserialize failure:
$this->logger->error('Could not unserialize the routes collection from the nested command.');
```

--------------------------------

### ResolveRouteCollectionAction::execute signature

Source: https://github.com/spatie/laravel-typescript-transformer

Public method that reads application routes and returns a serializable RouteCollection. Accepts a boolean to include closure-defined routes and an optional array of RouteFilter objects. Filters returning hide() === true cause the route to be skipped.

```php
/** @param array<RouteFilter> $filters */
public function execute(
    bool $includeRouteClosures,
    array $filters = [],
): RouteCollection
```

--------------------------------

### buildUrl function declaration and implementation

Source: https://github.com/spatie/laravel-typescript-transformer

Declares and implements the buildUrl function that constructs a URL from a path, optional params, and options. It replaces placeholders, appends query parameters (skipping null/undefined, handling arrays), and prefixes with baseUrl if defined.

```ts
declare function buildUrl(path: string, params?: RouteParams, options?: RouteOptions): string;
```

```js
let url = path;
if (params) {
    for (const [key, value] of Object.entries(params)) {
        url = url.replace(`{${key}}`, String(value));
    }
}
if (options?.query) {
    const searchParams = new URLSearchParams();
    for (const [key, value] of Object.entries(options.query)) {
        if (value === null || value === undefined) { continue; }
        if (Array.isArray(value)) {
            value.forEach((v) => searchParams.append(`${key}[]`, String(v)));
        } else {
            searchParams.append(key, String(value));
        }
    }
    const queryString = searchParams.toString();
    if (queryString) { url += '?' + queryString; }
}
return (typeof baseUrl !== 'undefined' ? baseUrl : '') + '/' + url;
```

--------------------------------

### Class declaration for TypeScriptTransformerServiceProvider

Source: https://github.com/spatie/laravel-typescript-transformer

Declares the package's main service provider, extending PackageServiceProvider.

```php
class TypeScriptTransformerServiceProvider extends PackageServiceProvider
```

--------------------------------

### DefaultActionNameResolver::resolve

Source: https://github.com/spatie/laravel-typescript-transformer

Default implementation that splits the controller FQCN on backslashes (after stripping a leading backslash) to produce the name segments. This is the default behavior used when no custom resolver is configured.

```APIDOC
## DefaultActionNameResolver::resolve

### Description
Splits the controller FQCN on backslashes (after stripping a leading `\`) to produce the name segments.

### Method
`resolve`

### Signature
`public function resolve(string $controllerClass): array`

### Parameters
- `$controllerClass` (string) - Required - The fully-qualified class name of the controller.

### Return Value
- `array<string>` - The name segments derived from the controller class name.

### Example
```php
$resolver = new DefaultActionNameResolver();
$segments = $resolver->resolve('App\Http\Controllers\UserController');
// => ['App', 'Http', 'Controllers', 'UserController']
```
```

--------------------------------

### ControllerRouteFilter hide method signature

Source: https://github.com/spatie/laravel-typescript-transformer

Returns true when the route's controller class and/or action match the configured filters. Returns false for routes without a controller class.

```php
public function hide(Route $route): bool
```

--------------------------------

### execute method signature

Source: https://github.com/spatie/laravel-typescript-transformer

Signature for the main processing method. It receives a PHP property node, an optional type annotation, and a TypeScript property, returning a possibly mutated TypeScriptProperty or null to drop the property.

```php
public function execute(
    PhpPropertyNode $phpPropertyNode,
    ?TypeNode $annotation,
    TypeScriptProperty $property
): ?TypeScriptProperty
```

--------------------------------

### getTransformedLocation method signature with docblock

Source: https://github.com/spatie/laravel-typescript-transformer

Returns all but the last location segment. The docblock indicates the return type is an array of strings.

```php
/** @return array<string> */
public function getTransformedLocation(): array
```
Tokens:
Raw