kayto_ts 0.1.8 → 0.1.10

package/README.md

@@ -224,11 +224,71 @@ const clientWithHooks = clientApi<CatsEndpoints>({
 });
 ```
 
+## Success Handling (Cats API)
+
+```ts
+async function fetchCatsUI() {
+  let loading = true;
+
+  try {
+    const result = await client.get("/api/cats");
+
+    if (!result.ok) {
+      throw result.error;
+    }
+
+    const cats = result.responses[200];
+
+    if (!cats) {
+      throw new Error("Cats response is empty");
+    }
+
+    return cats;
+  } catch (error) {
+    // UI can show toast/snackbar here
+    throw error;
+  } finally {
+    loading = false;
+  }
+}
+```
+
+```ts
+async function createCatUI() {
+  let loading = true;
+
+  try {
+    const result = await client.post("/api/cats", {
+      body: {
+        name: "Milo",
+        age: 2,
+      },
+    });
+
+    if (!result.ok) {
+      throw result.error;
+    }
+
+    const created = result.responses[201] ?? result.responses[200];
+
+    if (!created) {
+      throw new Error("Create cat payload is empty");
+    }
+
+    return created;
+  } catch (error) {
+    throw error;
+  } finally {
+    loading = false;
+  }
+}
+```
+
 ## Error Handling
 
 All requests return a discriminated union:
 
-- success: `{ ok: true, result, response }`
+- success: `{ ok: true, responses, response }`
 - failure: `{ ok: false, error, response? }`
 
 `error.kind` values:
@@ -246,6 +306,15 @@ You can also handle them generically via `message` / `status` / `cause` without
 ```ts
 const result = await client.get("/api/cats");
 
+if (result.ok) {
+  const success = result.responses[200];
+  console.log(success);
+}
+```
+
+```ts
+const result = await client.get("/api/cats");
+
 if (!result.ok) {
   console.error("Request failed:", result.error.message);
 
@@ -291,5 +360,5 @@ Client parses response body automatically by `content-type`:
 ## Notes
 
 - Runtime shape validation is not built in yet (current typing is compile-time only).
-- If you need runtime validation, validate `result.result` in consumer code (ArkType/Zod/etc.).
+- If you need runtime validation, validate `result.responses[statusCode]` in consumer code (ArkType/Zod/etc.).
 - Current entrypoint is `src/index.ts`.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "kayto_ts",
-  "version": "0.1.8",
+  "version": "0.1.10",
   "description": "Type-safe HTTP client for working with kayto-generated endpoint schemas.",
   "repository": {
     "type": "git",