Generate typescript definitions

[benbjurstrom]

Related to #99

This pull request adds collector and transformer classes which can be used with the spatie/laravel-typescript-transformer package to generate typescript definitions from ValidatedDTO Classes.

This is especially useful when passing ValidatedDTOs through Inertia.js to a typescript based frontend.

Since this feature won't be used by everyone the spatie/typescript-transformer package is not added as a required dependency. Therefore to generate typescript definitions the user would need to complete the following steps.

Step 1:

Install the spatie/typescript-transformer package.

composer require spatie/typescript-transformer

Step 2:

Publish the typescript-transformer config

php artisan vendor:publish --provider="Spatie\LaravelTypeScriptTransformer\TypeScriptTransformerServiceProvider"

Step 3:

Register the packages TypeScriptCollector and TypeScriptTransformer in the typescript-transformer config

//config/typescript-transformer.php
   ...
    /*
     * Collectors will search for classes in the `auto_discover_types` paths and choose the correct
     * transformer to transform them. By default, we include a DefaultCollector which will search
     * for @typescript annotated and #[TypeScript] attributed classes to transform.
     */

    'collectors' => [
        Spatie\TypeScriptTransformer\Collectors\DefaultCollector::class,
        Spatie\TypeScriptTransformer\Collectors\EnumCollector::class,
+       WendellAdriel\ValidatedDTO\Support\TypeScriptCollector,
    ],

    /*
     * Transformers take PHP classes(e.g., enums) as an input and will output
     * a TypeScript representation of the PHP class.
     */

    'transformers' => [
        Spatie\LaravelTypeScriptTransformer\Transformers\SpatieStateTransformer::class,
        Spatie\TypeScriptTransformer\Transformers\EnumTransformer::class,
        Spatie\TypeScriptTransformer\Transformers\SpatieEnumTransformer::class,
        Spatie\LaravelTypeScriptTransformer\Transformers\DtoTransformer::class,
+       WendellAdriel\ValidatedDTO\Support\TypeScriptTransformer,
    ],
   ...

Step 4:

Run the command to generate the TypeScript types.

 php artisan typescript:transform

By default the definitions are added here: resources/types/generated.d.ts.

[WendellAdriel]

Is it possible to make this work with any of the DTOs by checking if it's a subclass of the SimpleDTO instead?

[WendellAdriel]

Is it possible to make this work with any of the DTOs by checking if it's a subclass of the SimpleDTO instead?

[benbjurstrom]

Made the change, seems to work just as well with SimpleDTO.

[WendellAdriel]

@benbjurstrom can you just check if there's any code style issue to be fixed, please?

[WendellAdriel]

Thanks for the awesome contribution @benbjurstrom!!! 💪 🔥