@beepbox.net/gofetch-client 0.1.2 → 0.2.1

package/README.md

@@ -4,8 +4,6 @@ Typesafe [Eden treaty](https://elysiajs.com/eden/overview) client for the [gofet
 
 Route paths, query params, bodies, and responses are inferred from the server — no manual typing.
 
-Eden Treaty types request params from validator **output** (after arktype morphs). This package applies `MapTreatyClientWire` plus generated wire patches so query/body/header inputs match HTTP (`string` URLs, `'true' | 'false'`, `limit` as `number | string`, opaque `cursor` strings, etc.) while server handlers still receive parsed types. Run `bun run build:types` after API schema changes; `validate-wire-output` fails the build if morph output types leak into requests.
-
 ## Install
 
 ```bash
@@ -21,6 +19,36 @@ const api = createClient()
 // defaults to https://gofetch.blaqat.net
 ```
 
+## Friendly fetcher
+
+Prefer short, namespaced methods over the full treaty path? Use `createFetcher`:
+
+```ts
+import { createFetcher } from '@beepbox.net/gofetch-client'
+
+const client = createFetcher()
+
+const { data } = await client.util.resolveShortUrl('https://tinyurl.com/buwnpvpd')
+console.log(data?.modName)
+```
+
+It wraps the same treaty client — every method maps directly to a route and keeps
+the generated request/response types:
+
+```ts
+await client.beep.list({ songType: 'Original', limit: 20 })
+await client.beep.get(id)
+await client.event.removeHost(eventId, userId)
+await client.user.me({ headers: { Authorization: `Bearer ${token}` } })
+```
+
+Methods are grouped by namespace: `beep`, `event`, `platform`, `source`, `forum`,
+`submission`, `weightGroup`, `xp`, `user`, `util`. Every method takes an optional
+trailing `opts` (`{ headers }`) for per-request auth. The raw treaty client is
+always reachable via `client.raw` as an escape hatch.
+
+`createFetcher` accepts the same options as `createClient` (`baseUrl`, `token`).
+
 ## Auth
 
 Pass a JWT from Discord OAuth (`/v0/auth/discord` → callback):