Restructure message package

Move response classes to own package
Split ResponseIface into Err and Success respopnse ifaces

Author: dhaeckel

src/Message/BatchRequestIface.php

@@ -22,14 +22,14 @@
 
 namespace Haeckel\JsonRpcServerContract\Message;
 
-use Haeckel\JsonRpcServerContract\DataStruct\CollectionIface;
+use Haeckel\JsonRpcServerContract\{DataStruct, Response};
 
 /**
- * @extends CollectionIface<RequestIface|NotificationIface>
+ * @extends DataStruct\CollectionIface<RequestIface|NotificationIface>
  *
  * @link https://www.jsonrpc.org/specification#batch
  */
-interface BatchRequestIface extends CollectionIface
+interface BatchRequestIface extends DataStruct\CollectionIface
 {
     /** @no-named-arguments */
     public function add(RequestIface|NotificationIface ...$elements): void;
@@ -43,10 +43,10 @@ public function remove(RequestIface|NotificationIface ...$elements): void;
      * if any request of a batch is invalid or hast invalid json, add the error response here
      * @no-named-arguments
      */
-    public function addResponseForInvalidReq(ResponseIface ...$response): void;
+    public function addResponseForInvalidReq(Response\ErrorIface ...$response): void;
 
     /**
-     * @return list<ResponseIface>
+     * @return list<Response\ErrorIface>
      */
     public function getResponsesForInvalidRequests(): array;
 }

src/Message/ResponseIface.php

@@ -0,0 +1,14 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Haeckel\JsonRpcServerContract\Response;
+
+interface BaseIface extends \JsonSerializable
+{
+    public function getId(): null|int|string;
+    public function withId(null|int|string $id): static;
+
+    public function getJsonrpc(): string;
+    public function withJsonrpc(string $jsonrpc): static;
+}

src/Response/BaseIface.php

@@ -20,22 +20,22 @@
 
 declare(strict_types=1);
 
-namespace Haeckel\JsonRpcServerContract\Message;
+namespace Haeckel\JsonRpcServerContract\Response;
 
 use Haeckel\JsonRpcServerContract\DataStruct\CollectionIface;
 
 /**
- * @extends CollectionIface<ResponseIface>
+ * @extends CollectionIface<ErrorIface|SuccessIface>
  *
  * @link https://www.jsonrpc.org/specification#batch
  */
-interface BatchResponseIface extends CollectionIface
+interface BatchIface extends CollectionIface
 {
     /** @no-named-arguments */
-    public function add(ResponseIface ...$elements): void;
+    public function add(ErrorIface|SuccessIface ...$elements): void;
 
-    public function current(): ?ResponseIface;
+    public function current(): null|ErrorIface|SuccessIface;
 
     /** @no-named-arguments */
-    public function remove(ResponseIface ...$elements): void;
+    public function remove(ErrorIface|SuccessIface ...$elements): void;
 }

src/Message/BatchResponseIface.php renamed to src/Response/BatchIface.php

@@ -0,0 +1,13 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Haeckel\JsonRpcServerContract\Response;
+
+use Haeckel\JsonRpcServerContract\Message;
+
+interface ErrorIface extends BaseIface
+{
+    public function getError(): null|Message\ErrorObjectIface;
+    public function withError(null|Message\ErrorObjectIface $error): static;
+}

src/Response/ErrorIface.php

@@ -0,0 +1,35 @@
+<?php
+
+/**
+ * This file is part of haeckel/json-rpc-server-contracts.
+ *
+ * haeckel/json-rpc-server-contracts is free software:
+ * you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License
+ * as published by the Free Software Foundation, either version 3 of the License,
+ * or (at your option) any later version.
+ *
+ * haeckel/json-rpc-server-contracts is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY;
+ * without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+ * See the GNU Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License along with
+ * haeckel/json-rpc-server-contracts.
+ * If not, see <https://www.gnu.org/licenses/>.
+ */
+
+declare(strict_types=1);
+
+namespace Haeckel\JsonRpcServerContract\Response;
+
+/** @link https://www.jsonrpc.org/specification#response_object */
+interface SuccessIface extends BaseIface
+{
+    /** @return array<mixed>|bool|float|int|string|\stdClass|\JsonSerializable */
+    public function getResult(): array|bool|float|int|string|\stdClass|\JsonSerializable;
+
+    /** @param array<mixed>|bool|float|int|string|\stdClass|\JsonSerializable $result */
+    public function withResult(
+        array|bool|float|int|string|\stdClass|\JsonSerializable $result,
+    ): static;
+}

src/Response/SuccessIface.php

@@ -22,11 +22,12 @@
 
 namespace Haeckel\JsonRpcServerContract\Server;
 
-use Haeckel\JsonRpcServerContract\Message;
+use Haeckel\JsonRpcServerContract\Response;
 
 /** serialize the response and output it */
 interface EmitterIface
 {
-    /** @throws \Throwable */
-    public function emit(Message\ResponseIface|Message\BatchResponseIface $response): void;
+    public function emit(
+        Response\BatchIface|Response\ErrorIface|Response\SuccessIface $response,
+    ): void;
 }

src/Server/EmitterIface.php

@@ -22,7 +22,7 @@
 
 namespace Haeckel\JsonRpcServerContract\Server;
 
-use Haeckel\JsonRpcServerContract\Message;
+use Haeckel\JsonRpcServerContract\{Message, Response};
 
 /**
  * can be used compose classes the offer general services,
@@ -33,5 +33,5 @@ interface MiddlewareIface
     public function process(
         Message\NotificationIface|Message\RequestIface $request,
         RequestHandlerIface|NotificationHandlerIface $handler,
-    ): ?Message\ResponseIface;
+    ): null|Response\ErrorIface|Response\SuccessIface;
 }

src/Server/MiddlewareIface.php

@@ -22,10 +22,11 @@
 
 namespace Haeckel\JsonRpcServerContract\Server;
 
-use Haeckel\JsonRpcServerContract\{Exception, Message};
+use Haeckel\JsonRpcServerContract\{Exception, Message, Response};
 
 interface RequestHandlerIface
 {
-    /** @throws Exception\JsonRpcErrorIface */
-    public function handle(Message\RequestIface $request): Message\ResponseIface;
+    public function handle(
+        Message\RequestIface $request,
+    ): Response\ErrorIface|Response\SuccessIface;
 }