exp: Simpler defaultResultHandler and status-encoded Client types

CHANGELOG.md

@@ -1,5 +1,46 @@
 # Changelog
 
+## Version 30
+
+### v30.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.
+- Breaking change: The generated `Client::provide()` method returns a `[statusCode, body]` tuple
+  instead of the bare body:
+  - The new `EncodedResponse` interface maps each endpoint to a discriminated union of
+    `[StatusCode, Body]` tuples, with the HTTP status code as the discriminant;
+  - Use destructuring with a status check to narrow the body type:
+
+```typescript
+const [status, body] = await client.provide("get /v1/user/retrieve", {
+  id: "10",
+});
+
+if (status === 200) {
+  body; // narrowed down to { name: string }
+} else if (status === 400) {
+  body; // narrowed down to { message: string }
+}
+```
+
+```diff
+- { "status": "success", "data": { "greetings": "Hello!" } }
++ { "greetings": "Hello!" }
+
+- { "status": "error", "error": { "message": "Not found" } }
++ { "message": "Not found" }
+
+- const response = await client.provide("post /v1/user/create", { name: "John Doe" });
++ const [status, response] = await client.provide("post /v1/user/create", { name: "John Doe" });
+```
+
 ## Version 29
 
 ### v29.0.0

README.md

@@ -274,7 +274,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
@@ -914,8 +914,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:
@@ -930,17 +930,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);
   },
 });
 ```
@@ -1155,7 +1155,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

@@ -32,12 +32,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/migration.spec.ts

@@ -4,6 +4,6 @@ import { describe, test, expect } from "vitest";
 describe("Migration", () => {
   test("should migrate", async () => {
     const fixed = await readFile("./sample.ts", "utf-8");
-    expect(fixed).toContain(`new Integration({});`);
+    expect(fixed).toContain("legacyResultHandler");
   });
 });

compat-test/package.json

@@ -3,7 +3,7 @@
   "type": "module",
   "private": true,
   "scripts": {
-    "pretest": "echo 'await Integration.create({});' > sample.ts",
+    "pretest": "echo 'import { defaultResultHandler } from \"express-zod-api\";' > sample.ts",
     "test": "eslint --fix && vitest --run",
     "posttest": "rm sample.ts"
   },

compat-test/quick-start.spec.ts

@@ -41,12 +41,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

@@ -32,12 +32,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!" });
     });
   });
 });