Use eager loaded relations to determine whether or not to show conditional properties of a JSON Resource

[jamiethorpe]

Currently, conditional properties of a JSON Resource will either display or not display Required if they use methods like whenLoaded. I think it would be a great idea to take this a step further and check the controller to see if any relations are eager loaded. If they are, the docs would compare that to the properties using the whenLoaded method and only display the ones that match. This would make the docs much easier to read from the perspective of the developer consuming them.

[romalytvynenko]

@jamiethorpe can you please share some code examples of how exactly your controllers (I guess) looks like?

I'm interested in the part of how you load relationships, so I can ship this feature!

[jamiethorpe]

Absolutely. Here's an example:

public function index(IndexTransactionRequest $request)
{
    try {
        $transactions = Transaction::with(['currentStage', 'ledgerEntries'])
            ->filter(new TransactionFilter($request->all()))
            ->get();

        return TransactionResource::collection($transactions);

    } catch (\Exception $e) {
        Log::error('There was an error fetching transactions', [
            'message' => $e->getMessage(),
            'trace' => $e->getTrace(),
        ]);

        return response()->json(['error' => 'Unable to fetch transactions'], 500);
    }
}

Then this would be the resource:

/**
 * @mixin Transaction
 */
class TransactionResource extends JsonResource
{
    public function toArray($request)
    {
        return [
            'id' => $this->id,
            /** @var array{'amount': float, 'minorAmount': int, 'currency': string} $amount */
            'amount' => money_detail($this->amount),
            'occurredAt' => $this->occurred_at,
            'description' => $this->description,
            'currencyCode' => $this->currency_code,
            'sourceSystem' => $this->source_system,
            'sourceSystemId' => $this->source_system_id,
            'sourceSystemBatchId' => $this->source_system_batch_id,
            'usage' => new UsageResource($this->whenLoaded('usage')),
            'stages' => TransactionStageResource::collection($this->whenLoaded('stages')),
            'images' => TransactionImageResource::collection($this->whenLoaded('images')),
            'notes' => NoteResource::collection($this->whenLoaded('notes')),
            'currentStage' => new TransactionStageResource($this->whenLoaded('currentStage')),
            'identifiers' => TransactionIdentifierResource::collection($this->whenLoaded('identifiers')),
            /** @var array{'amount': float, 'minorAmount': int, 'currency': string} $amount */
            'totalCharged' => $this->when($this->relationLoaded('ledgerEntries'), function () {
                return money_detail($this->totalCharged);
            }),
            /** @var object $metadata Will contain anything included with the metadata when the transaction was originally sent */
            'metadata' => $this->metadata,
            'createdAt' => $this->created_at,
            'updatedAt' => $this->updated_at,
            'accountId' => $this->when($this->whenloaded('account'), $this->account?->id),
        ];
    }
}

So instead of the docs page showing all of the relations that are conditional based on whenLoaded, it would be great if they only showed the ones that were loaded in the controller via the with or load methods.