ValidResourceAssertion.php

<?php

declare(strict_types=1);

namespace Undabot\JsonApi\Util;

use Undabot\JsonApi\Util\Exception\ValidationException;

/**
 * @internal
 *
 * @psalm-suppress UnusedClass
 */
final class ValidResourceAssertion
{
    /**
     * @param array<string,mixed> $resource
     *
     * @throws ValidationException
     */
    public static function assert(array $resource): void
    {
        // `type` is only required member, `id` is not required when creating a resource without client-generated ID
        JsonApiAssertion::keyIsset($resource, 'type', 'Resource must have key `type`');

        // According to the JSON:API specification, these are the only allowed keys
        $allowedKeys = ['type', 'id', 'links', 'meta', 'attributes', 'relationships'];

        // Assert that there are only whitelisted keys present
        $disallowedKeys = array_diff(array_keys($resource), $allowedKeys);
        JsonApiAssertion::count(
            $disallowedKeys,
            0,
            sprintf('Resource can only have keys: %s', implode(', ', $allowedKeys))
        );

        JsonApiAssertion::string($resource['type'], 'Resource `type` must be string');

        // Id is optional for resources sent in POST requests
        if (true === \array_key_exists('id', $resource)) {
            JsonApiAssertion::string($resource['id'], 'Resource `id` must be string');
        }

        // @todo validate attributes
        // @todo validate relationships
        // @todo valdiate links
        // @todo validate meta
    }
}