exp: Simpler defaultResultHandler and status-encoded Client types

CHANGELOG.md

@@ -1,5 +1,26 @@
 # Changelog
 
+## Version 29
+
+### v29.0.0
+
+- Breaking change: The `defaultResultHandler` no longer wraps endpoint output in
+  `{ status: "success", data: … }` and error messages in `{ status: "error", error: { message: … } }`:
+  - On success, the endpoint output is sent as-is (bare JSON object);
+  - On error, the body is `{ message: … }` (without `error` wrapper and `status` field);
+  - The HTTP status code (`200` vs `4xx`/`5xx`) already discriminates success vs error, making the
+    `status` string redundant;
+  - `DefaultResponse<OUT>` type is simplified to `OUT | { message: string }`;
+  - `arrayResultHandler` is not affected — it already returns bare arrays and plain-text errors.
+
+```diff
+- { "status": "success", "data": { "greetings": "Hello!" } }
++ { "greetings": "Hello!" }
+
+- { "status": "error", "error": { "message": "Not found" } }
++ { "message": "Not found" }
+```
+
 ## Version 28
 
 ### v28.1.0

README.md

@@ -273,7 +273,7 @@ curl -L -X GET 'localhost:8090/v1/hello?name=Rick'
 You should receive the following response:
 
 ```json
-{ "status": "success", "data": { "greetings": "Hello, Rick. Happy coding!" } }
+{ "greetings": "Hello, Rick. Happy coding!" }
 ```
 
 # Basic features
@@ -869,8 +869,8 @@ The `defaultResultHandler` sets the HTTP status code and ensures the following t
 
 ```ts
 type DefaultResponse<OUT> =
-  | { status: "success"; data: OUT } // Positive response
-  | { status: "error"; error: { message: string } }; // or Negative response
+  | OUT // Positive response
+  | { message: string }; // or Negative response
 ```
 
 You can create your own result handler by using this example as a template:
@@ -885,17 +885,17 @@ import {
 
 const yourResultHandler = new ResultHandler({
   positive: (data) => ({
-    schema: z.object({ data }),
+    schema: data,
     mimeType: "application/json", // optinal or array
   }),
-  negative: z.object({ error: z.string() }),
+  negative: z.object({ message: z.string() }),
   handler: ({ error, input, output, request, response, logger }) => {
     if (error) {
       const { statusCode } = ensureHttpError(error);
       const message = getMessageFromError(error);
-      return void response.status(statusCode).json({ error: message });
+      return void response.status(statusCode).json({ message });
     }
-    response.status(200).json({ data: output });
+    response.status(200).json(output);
   },
 });
 ```
@@ -1108,7 +1108,7 @@ test("should respond successfully", async () => {
   expect(loggerMock._getLogs().error).toHaveLength(0);
   expect(responseMock._getStatusCode()).toBe(200);
   expect(responseMock._getHeaders()).toHaveProperty("x-custom", "one"); // lower case!
-  expect(responseMock._getJSONData()).toEqual({ status: "success" });
+  expect(responseMock._getJSONData()).toEqual({ greetings: "Hello, World" });
 });
 ```
 

cjs-test/quick-start.spec.ts

@@ -31,12 +31,7 @@ describe("CJS Test", async () => {
       );
       expect(response.status).toBe(200);
       const json = await response.json();
-      expect(json).toEqual({
-        status: "success",
-        data: {
-          greetings: "Hello, Rick. Happy coding!",
-        },
-      });
+      expect(json).toEqual({ greetings: "Hello, Rick. Happy coding!" });
     });
   });
 });

compat-test/quick-start.spec.ts

@@ -40,12 +40,7 @@ describe("ESM Test", async () => {
       );
       expect(response.status).toBe(200);
       const json = await response.json();
-      expect(json).toEqual({
-        status: "success",
-        data: {
-          greetings: "Hello, Rick. Happy coding!",
-        },
-      });
+      expect(json).toEqual({ greetings: "Hello, Rick. Happy coding!" });
     });
   });
 });

esm-test/quick-start.spec.ts

@@ -31,12 +31,7 @@ describe("ESM Test", async () => {
       );
       expect(response.status).toBe(200);
       const json = await response.json();
-      expect(json).toEqual({
-        status: "success",
-        data: {
-          greetings: "Hello, Rick. Happy coding!",
-        },
-      });
+      expect(json).toEqual({ greetings: "Hello, Rick. Happy coding!" });
     });
   });
 });

example/__snapshots__/index.spec.ts.snap

@@ -1,18 +1,19 @@
 // Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html
 
 exports[`Example > Client > Issue #2177: should handle path params correctly 1`] = `
-{
-  "data": {
+[
+  200,
+  {
     "createdAt": "2022-01-22T00:00:00.000Z",
     "name": "Alan Turing",
   },
-  "status": "success",
-}
+]
 `;
 
 exports[`Example > Client > Should perform the request with a positive response 1`] = `
-{
-  "data": {
+[
+  200,
+  {
     "features": [
       {
         "features": [
@@ -42,97 +43,75 @@ exports[`Example > Client > Should perform the request with a positive response
     "id": 10,
     "name": "John Doe",
   },
-  "status": "success",
-}
+]
 `;
 
 exports[`Example > Negative > GET request should fail on missing input param 1`] = `
 {
-  "error": {
-    "message": "id: Invalid input: expected string, received undefined",
-  },
-  "status": "error",
+  "message": "id: Invalid input: expected string, received undefined",
 }
 `;
 
 exports[`Example > Negative > PATCH request should fail on schema validation 1`] = `
 {
-  "error": {
-    "message": "id: should be greater than or equal to 0",
-  },
-  "status": "error",
+  "message": "id: should be greater than or equal to 0",
 }
 `;
 
 exports[`Example > Negative > Should fail to upload if the file is too large 1`] = `
 {
-  "error": {
-    "message": "The file is too large",
-  },
-  "status": "error",
+  "message": "The file is too large",
 }
 `;
 
 exports[`Example > Negative > Should respond with error to the missing static file request 1`] = `
 {
-  "error": {
-    "message": "Can not GET /public/missing.svg",
-  },
-  "status": "error",
+  "message": "Can not GET /public/missing.svg",
 }
 `;
 
 exports[`Example > Positive > Should accept raw data 0 1`] = `
 {
-  "data": {
-    "length": 48687,
-  },
-  "status": "success",
+  "length": 48687,
 }
 `;
 
 exports[`Example > Positive > Should accept raw data 1 1`] = `
 {
-  "data": {
-    "length": 48687,
-  },
-  "status": "success",
+  "length": 48687,
 }
 `;
 
 exports[`Example > Positive > Should handle valid GET request 1`] = `
 {
-  "data": {
-    "features": [
-      {
-        "features": [
-          {
-            "title": "Above 180cm",
-          },
-        ],
-        "title": "Tall",
-      },
-      {
-        "title": "Young",
-      },
-      {
-        "features": [
-          {
-            "features": [
-              {
-                "title": "About Typescript",
-              },
-            ],
-            "title": "Tells funny jokes",
-          },
-        ],
-        "title": "Cute",
-      },
-    ],
-    "id": 50,
-    "name": "John Doe",
-  },
-  "status": "success",
+  "features": [
+    {
+      "features": [
+        {
+          "title": "Above 180cm",
+        },
+      ],
+      "title": "Tall",
+    },
+    {
+      "title": "Young",
+    },
+    {
+      "features": [
+        {
+          "features": [
+            {
+              "title": "About Typescript",
+            },
+          ],
+          "title": "Tells funny jokes",
+        },
+      ],
+      "title": "Cute",
+    },
+  ],
+  "id": 50,
+  "name": "John Doe",
 }
 `;
 
@@ -175,46 +154,43 @@ exports[`Example > Positive > Should respond with array (legacy API ResultHandle
 
 exports[`Example > Positive > Should respond with paginated list (ez.paginated) 1`] = `
 {
-  "data": {
-    "limit": 20,
-    "offset": 0,
-    "total": 8,
-    "users": [
-      {
-        "name": "Maria Merian",
-        "role": "manager",
-      },
-      {
-        "name": "Mary Anning",
-        "role": "operator",
-      },
-      {
-        "name": "Marie Skłodowska Curie",
-        "role": "admin",
-      },
-      {
-        "name": "Henrietta Leavitt",
-        "role": "manager",
-      },
-      {
-        "name": "Lise Meitner",
-        "role": "operator",
-      },
-      {
-        "name": "Alice Ball",
-        "role": "admin",
-      },
-      {
-        "name": "Gerty Cori",
-        "role": "manager",
-      },
-      {
-        "name": "Helen Taussig",
-        "role": "operator",
-      },
-    ],
-  },
-  "status": "success",
+  "limit": 20,
+  "offset": 0,
+  "total": 8,
+  "users": [
+    {
+      "name": "Maria Merian",
+      "role": "manager",
+    },
+    {
+      "name": "Mary Anning",
+      "role": "operator",
+    },
+    {
+      "name": "Marie Skłodowska Curie",
+      "role": "admin",
+    },
+    {
+      "name": "Henrietta Leavitt",
+      "role": "manager",
+    },
+    {
+      "name": "Lise Meitner",
+      "role": "operator",
+    },
+    {
+      "name": "Alice Ball",
+      "role": "admin",
+    },
+    {
+      "name": "Gerty Cori",
+      "role": "manager",
+    },
+    {
+      "name": "Helen Taussig",
+      "role": "operator",
+    },
+  ],
 }
 `;
 
@@ -226,9 +202,6 @@ exports[`Example > Positive > Should stream an image with a correct header 1`] =
 
 exports[`Example > Protocol > Issue #2706: Should handle parser failures but retain CORS headers 1`] = `
 {
-  "error": {
-    "message": StringMatching /Unterminated string in JSON at position 14/,
-  },
-  "status": "error",
+  "message": StringMatching /Unterminated string in JSON at position 14/,
 }
 `;