Support data objects

[jeffreyvanhees]

For automatic generation of typescript files, I use spatie/laravel-data in combination with spatie/typescript-transformer instead of default resources. It would be great if this is supported for generating schemas, example responses and such. What do you think about it?

[romalytvynenko]

@jeffreyvanhees it would be great indeed.

Can you please share some examples of your code of how you use these libs for requests and responses?

[jeffreyvanhees]

I don't really have any good examples yet, but from their documentation it should be possible to build support for this.

On this page it's very well explained how data objects from request are working:
https://spatie.be/docs/laravel-data/v3/as-a-data-transfer-object/request-to-data-object

... and also how requests can be validated:
https://spatie.be/docs/laravel-data/v3/as-a-data-transfer-object/request-to-data-object#content-validating-a-collection-of-data-objects

And here; how it transforms to a JSON-resource:
https://spatie.be/docs/laravel-data/v3/as-a-resource/from-data-to-resource

When using spatie/typescript-transformer, you'll need to add the typescript-annotation to the data object and the package will generate a typescript file out of the box:

Example:

App\Data\ProductData.php

namespace App\Data;

#[Typescript]
class ProductData extends Data
{
    public function __construct(
        
        public ?int $id,
    
        #[Max(100)]
        public string $name,
        
        #[Max(200)]
        public string $description,
    ) {
        //
    }
}

App\Http\Controllers\ProductController.php

namespace App\Http\Controllers;

use App\Data\ProductData;
use App\Models\Product;

class ProductController extends Controller 
{
    // Now it's used like a Resource
    public function index() 
    {
        $products = Product::all();
        
        return ProductData::collection($products);
    }
    
    // Now it's used like a FormRequest
    public function store(ProductData $productData) 
    {
        Product::create($productData->all());
        
        return redirect()->back();
    }
    
    // Now it's used like a FormRequest
    public function update(Product $product, ProductData $productData) 
    {
        Product::update($productData->all());
        
        return redirect()->back();
    }
}

After running php artisan typescript:transform:
resources/types/types.d.ts

// ...
class ProductData
{
    public ?int $id;
    public string $name;
    public string $description;
} 
// ...

[jeffreyvanhees]

Any thoughts on this @romalytvynenko? :)

[romalytvynenko]

@jeffreyvanhees sorry for 3 moths reply delay. I love the idea. Definitely will work on this. Not sure when. PRs/packages are welcome.

[jeffreyvanhees]

No problem @romalytvynenko! Keep up the good work!

[romalytvynenko]

Hey @jeffreyvanhees

I will definitely a support for spatie/laravel-data package.

Just cannot tell you when exactly that would happen 🙃

[asterd]

Hi! any update on this?

[romalytvynenko]

@asterd no updates on this for now, still planned.

[igorsgm]

Hello @romalytvynenko
Just checking if you've made any progress on this.

This package is amazing.
Thanks!