@beepbox.net/gofetch-client 0.1.0 → 0.1.1

package/README.md

@@ -0,0 +1,98 @@
+# @beepbox.net/gofetch-client
+
+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
+```
+
+## Quick start
+
+```ts
+import { createClient } from '@beepbox.net/gofetch-client'
+
+const api = createClient()
+// defaults to https://gofetch.blaqat.net
+```
+
+## Auth
+
+Pass a JWT from Discord OAuth (`/v0/auth/discord` → callback):
+
+```ts
+const api = createClient({ token: process.env.GOFETCH_TOKEN })
+
+const { data: me } = await api.v1.user.me.get()
+// me is fully typed (displayName, role, etc.)
+```
+
+Per-request headers also work:
+
+```ts
+await api.v1.beep.post(body, {
+	headers: { Authorization: `Bearer ${token}` },
+})
+```
+
+**Test server** (`NODE_ENV=test`): use `x-test-api-key` with a seeded user id instead of a JWT:
+
+```ts
+const api = createClient({ baseUrl: 'http://localhost:3001' })
+
+await api.v1.user.me.get({
+	headers: { 'x-test-api-key': 'seed-user-admin' },
+})
+```
+
+## List / filter beeps
+
+`GET /v1/beep` — filter by author, platform, song type, state, etc.:
+
+```ts
+const { data } = await api.v1.beep.get({
+	query: {
+		userId: 'some-user-id',
+		songType: 'Original',
+		state: 'Complete',
+		limit: 20,
+		expand: ['authors', 'platforms'],
+	},
+})
+
+// data.data  → beeps
+// data.nextCursor → pagination cursor
+```
+
+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
+const api = createClient({
+	baseUrl: 'https://gofetch.blaqat.net',
+	token: optionalJwt,
+})
+```
+
+## API docs
+
+Live OpenAPI reference: https://gofetch.blaqat.net/docs

package/package.json

@@ -1,10 +1,11 @@
 {
 	"name": "@beepbox.net/gofetch-client",
-	"version": "0.1.0",
+	"version": "0.1.1",
 	"description": "Typesafe Eden treaty client for the gofetch API",
 	"license": "UNLICENSED",
 	"files": [
-		"dist"
+		"dist",
+		"README.md"
 	],
 	"type": "module",
 	"main": "./dist/index.js",