@beepbox.net/gofetch-client 0.2.1 → 0.2.3

package/README.md

@@ -2,12 +2,10 @@
 
 Typesafe [Eden treaty](https://elysiajs.com/eden/overview) client for the [gofetch](https://gofetch.blaqat.net) API.
 
-Route paths, query params, bodies, and responses are inferred from the server — no manual typing.
-
 ## Install
 
 ```bash
-npm install @beepbox.net/gofetch-client @elysiajs/eden elysia
+bun add @beepbox.net/gofetch-client
 ```
 
 ## Quick start
@@ -19,12 +17,17 @@ const api = createClient()
 // defaults to https://gofetch.blaqat.net
 ```
 
+## API docs
+
+Live OpenAPI reference: https://gofetch.blaqat.net/docs
+
 ## Friendly fetcher
 
-Prefer short, namespaced methods over the full treaty path? Use `createFetcher`:
+cuter wrapper over the normal client for better dev experience
 
 ```ts
 import { createFetcher } from '@beepbox.net/gofetch-client'
+// `createFetcher` accepts the same options as `createClient` (`baseUrl`, `token`).
 
 const client = createFetcher()
 
@@ -32,9 +35,6 @@ 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)
@@ -42,22 +42,20 @@ 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.
+## Auth
 
-`createFetcher` accepts the same options as `createClient` (`baseUrl`, `token`).
+gofetch is a standalone API. Discord OAuth completes at `GET /v0/auth/discord/callback`, which returns JSON:
 
-## Auth
+```json
+{ "accessToken": "<jwt>", "user": { ... } }
+```
 
-Pass a JWT from Discord OAuth (`/v0/auth/discord` → callback):
+Your app runs the login UX (redirect to `/v0/auth/discord`, handle the callback response, store the JWT). Then pass the token into the client:
 
 ```ts
-const api = createClient({ token: process.env.GOFETCH_TOKEN })
+const api = createClient({ token: accessToken })
 
 const { data: me } = await api.v1.user.me.get()
-// me is fully typed (displayName, role, etc.)
 ```
 
 Per-request headers also work:
@@ -99,21 +97,6 @@ const { data } = await api.v1.beep.get({
 
 Public list works without auth (URLs hidden for guests). Authenticated callers see full fields.
 
-## Resolve a short URL
-
-`GET /v1/util/resolve/short` — follows redirects / meta-refresh / canonical links to a final BeepBox mod URL:
-
-```ts
-const { data } = await api.v1.util.resolve.short.get({
-	query: { url: 'https://tinyurl.com/your-link' },
-})
-
-// data.resolvedUrl, data.modName, data.modId
-// data.steps? — hop-by-hop trace
-```
-
-Related: `api.v1.util.resolve.platform.get({ query: { url } })` maps a song URL to a known platform.
-
 ## Custom base URL
 
 ```ts
@@ -122,7 +105,3 @@ const api = createClient({
 	token: optionalJwt,
 })
 ```
-
-## API docs
-
-Live OpenAPI reference: https://gofetch.blaqat.net/docs