Transforming to TypeScript

Thanks to the typescript-transformer package, it is possible to automatically transform data objects into TypeScript definitions.

For example, the following data object:

class DataObject extends Data
{
    public function __construct(
        public null|int $nullable,
        public int $int,
        public bool $bool,
        public string $string,
        public float $float,
        /** @var string[] */
        public array $array,
        public Lazy|string $lazy,
        public Optional|string $optional,
        public SimpleData $simpleData,
        /** @var \Spatie\LaravelData\Tests\Fakes\SimpleData[] */
        public DataCollection $dataCollection,
    )
    {
    }
}

... can be transformed to the following TypeScript type:

{
    nullable: number | null;
    int: number;
    bool: boolean;
    string: string;
    float: number;
    array: Array<string>;
    lazy? : string;
    optional? : string;
    simpleData: SimpleData;
    dataCollection: Array<SimpleData>;
}

##Installation of extra package

First, you must install the spatie/laravel-typescript-transformer into your project.

composer require spatie/laravel-typescript-transformer

Next, publish the config file of the typescript-transformer package with:

php artisan vendor:publish --tag=typescript-transformer-config

Finally, add the Spatie\LaravelData\Support\TypeScriptTransformer\DataTypeScriptTransformer transformer to the transformers in the typescript-transformer.php config file.

If you're using the DtoTransformer provided by the package, then be sure to put the DataTypeScriptTransformer before the DtoTransformer.

##Usage

Annotate each data object that you want to transform to Typescript with a /** @typescript */ annotation or a #[TypeScript] attribute.

To generate the typescript file , run this command:

php artisan typescript:transform

If you want to transform all the data objects within your application to TypeScript, you can use the DataTypeScriptCollector, which should be added to the collectors in typescript-transformer.php.

If you're using the DefaultCollector provided by the package, then be sure to put the DataTypeScriptCollector before the DefaultCollector.

##Optional types

An optional or lazy property will automatically be transformed into an optional type within TypeScript:

class DataObject extends Data
{
    public function __construct(
        public Lazy|string $lazy,
        public Optional|string $optional,
    )
    {
    }
}

This will be transformed into:

{
    lazy? : string;
    optional? : string;
}

If you want to have optional typed properties in TypeScript without typing your properties optional or lazy within PHP, then you can use the Optional attribute from the typescript-transformer package.

Don't forget to alias it as TypeScriptOptional when you're already using this package's Optional type!

use Spatie\TypeScriptTransformer\Attributes\Optional as TypeScriptOptional;

class DataObject extends Data
{
    public function __construct(
        #[TypeScriptOptional]
        public int $id,
        public string $someString,
        public Optional|string $optional,
    )
    {
    }
}

You can also make all the properties of a data object optional in TypeScript like this:

class DataObject extends Data
{
    #[TypeScriptOptional]
    public function __construct(
        public int $id,
        public string $someString,
        public Optional|string $optional,
    )
    {
    }
}