Responses

Overview

Hybrid responses respect a protocol to which the front-end adapter must adhere. A response contains, among other things, the name of the view component and its properties.

To send a response, use the hybridly or the Hybridly\view functions the same way you would use view:

use App\Data\ChirpData;
use App\Models\Chirp;

class ChirpController extends Controller
{
    public function index()
    {
        $this->authorize('viewAny', Chirp::class);

        $chirps = Chirp::query()
            ->forHomePage()
            ->paginate();

        return hybridly('chirps.index', [
            'chirps' => ChirpData::collection($chirps),
        ]);
    }
}

In the example above, the corresponding single-file component would simply accept a chirps property of the type ChirpData:

<script setup lang="ts">
defineProps<{
  chirps: Paginator<App.Data.ChirpData>
}>()
</script>

Paginator

Since paginators are so common, Hybridly provides typings for them. You don't need any setup, the Paginator type is global. When using paginators without a meta property, you may use UnwrappedPaginator instead.

Updating properties

It is a common pattern to have a POST or PUT hybrid request that ends up redirecting back to the previous page, which essentially refreshes the properties of the page to avoid having stale data.

public function store(UpdateUserRequest $request): HybridResponse
{
    User::update($request->validate());

    return back();
}

Such a redirection, though, implies an additional server round-trip and the re-execution of the server-side controller responsible for the view, which may slow down the response.

Instead, you may return only properties from the POST or PUT controller:

public function store(UpdateUserRequest $request): HybridResponse
{
    $user = User::update($request->validate());

    return hybridly(properties: [
        'user' => $user,
    ]);
}

In that situation, the returned properties will be merged with the current ones, similarly to what happens during a partial reload.

Internal redirects

When making non-get hybrid requests, you may use redirects to a standard GET hybrid endpoint. Hybridly will follow the redirect and update the page accordingly.

class UsersController extends Controller
{
    public function index()
    {
        $users = User::paginate();

        return hybridly('users.index', [
            'users' => UserData::collection($users),
        ]);
    }

    public function store(CreateUserData $data, CreateUser $createUser)
    {
        $createUser->execute($data);

        return to_route('users.index'); // Redirects to `index` above
    }
}

In the example above, using router.post('/users', { data: user }) would redirect to the user index page with the updated users property.

External redirects

It's often necessary to redirect to an external website, or an internal page that doesn't use Hybridly.

If you redirect using a classic server-side redirection, the front-end adapter will not understand the response and will display an error modal.

Instead, you may use hybridly()->external($url) to iniate a client-side redirect using window.location:

hybridly()->external('https://google.com');

This method can also be used when dealing with potentially non-hybrid request. In such cases, a normal RedirectResponse will be returned instead.

File downloads

Download responses using a Content-Disposition header are supported.

You may use any of the usual utilities for creating downloads, such as download, streamDownload, or Storage::download.

return response()->download($invoice->file_path, 'invoice.pdf');

However, in-browser file responses are not supported, as there is no way for Hybridly to differentiate it from a normal response.

The view-model pattern

A component of the model-view-viewmodel pattern, the view-model, is particularly useful when developing hybrid applications.

Aside from its obvious benefits in terms of separation of concerns, the class representing the view-model may be analyzed to be converted to a TypeScript interface.

In other terms, you may create a view-model that extends Data in order to get its typings for free:

// app/ViewModels/ChirpViewModel
class ChirpViewModel extends Data
{
    public function __construct(
        public readonly ChirpData $chirp,
        #[DataCollectionOf(ChirpData::class)]
        public readonly PaginatedDataCollection $comments,
        public readonly string $previous,
    ) {
    }
}

The hybridly function can use a data object (or any Arrayable object, for that matter) in place of an array of properties:

// app/Http/Controllers/ChirpsController
use App\Data\ChirpData;
use App\Models\Chirp;
use App\ViewModels\ChirpViewModel;

class ChirpController extends Controller
{
    public function show(Chirp $chirp) 
    {
        $this->authorize('view', $chirp);

        $comments = $chirp->comments()
          ->withLikeAndCommentCounts()
          ->paginate();

        return hybridly('chirps.show', new ChirpViewModel(
            chirp: ChirpData::from($chirp),
            comments: ChirpData::collection($comments),
            previous: $chirp->parent_id
                ? url()->route('chirp.show', $chirp->parent_id)
                : url()->route('index'),
        ));
    }
}

Unfortunately, since Vue doesn't have support for defineProps's generic parameter to be a global type, you will have to manually type the property keys:

<script setup lang="ts">
const $props = defineProps<{
  chirp: App.ViewModels.ChirpViewModel['chirp'],
  comments: App.ViewModels.ChirpViewModel['comments'],
  previous: App.ViewModels.ChirpViewModel['previous'],
}>()
</script>