<?php
/**
 * REST response factories.
 *
 * @package Kordiam
 */

declare( strict_types=1 );

namespace Kordiam\Rest;

use WP_REST_Response;

// Exit if accessed directly.
if ( ! defined( 'ABSPATH' ) ) {
	exit;
}

/**
 * Builds the response bodies the Kordiam backend expects.
 *
 * The shapes are a wire contract with the Kordiam service; do not change them.
 */
final class Response {

	/**
	 * Blocking instantiation: this class is a factory namespace.
	 */
	private function __construct() {
	}

	/**
	 * Answering with data and 200.
	 *
	 * @param mixed $data Response body.
	 *
	 * @return WP_REST_Response The response.
	 */
	public static function ok( $data = '' ): WP_REST_Response {
		return new WP_REST_Response( $data, 200 );
	}

	/**
	 * Answering with an empty body and 200: "understood, nothing to do".
	 *
	 * @return WP_REST_Response The response.
	 */
	public static function accepted_no_action(): WP_REST_Response {
		return new WP_REST_Response( '', 200 );
	}

	/**
	 * Answering with data and 201.
	 *
	 * @param array<string, mixed> $data Response body.
	 *
	 * @return WP_REST_Response The response.
	 */
	public static function created( array $data ): WP_REST_Response {
		return new WP_REST_Response( $data, 201 );
	}

	/**
	 * Answering with a bare string body.
	 *
	 * @param string $text   Body, sent as a JSON string.
	 * @param int    $status HTTP status code.
	 *
	 * @return WP_REST_Response The response.
	 */
	public static function text( string $text, int $status ): WP_REST_Response {
		return new WP_REST_Response( $text, $status );
	}

	/**
	 * Answering with a { message } object.
	 *
	 * @param string $message Human-readable message.
	 * @param int    $status  HTTP status code.
	 *
	 * @return WP_REST_Response The response.
	 */
	public static function message( string $message, int $status ): WP_REST_Response {
		return new WP_REST_Response( array( 'message' => $message ), $status );
	}
}