Release igdb-wrapper 0.6.1

Author: TDanks2000

.github/workflows/release.yml

@@ -34,14 +34,54 @@ jobs:
       - name: Install dependencies
         run: bun install --frozen-lockfile
 
+      - name: Typecheck
+        run: bun run typecheck
+
+      - name: Run tests
+        run: bun run test
+
       - name: Build
         run: bun run build
 
+      - name: Resolve release tag
+        id: release
+        run: |
+          NAME="$(node -p "require('./package.json').name")"
+          VERSION="$(node -p "require('./package.json').version")"
+          echo "tag=${NAME}@${VERSION}" >> "$GITHUB_OUTPUT"
+
+      - name: Generate and verify release notes
+        env:
+          GH_TOKEN: ${{ github.token }}
+          TAG: ${{ steps.release.outputs.tag }}
+        run: |
+          gh api "repos/${GITHUB_REPOSITORY}/releases/generate-notes" \
+            -f tag_name="$TAG" \
+            -f target_commitish="$GITHUB_SHA" \
+            --jq '.body // ""' > release-notes.md
+          if ! grep -q '[^[:space:]]' release-notes.md; then
+            echo "GitHub generated empty release notes for ${TAG}" >&2
+            exit 1
+          fi
+
       - name: Create version PR or publish
+        id: changesets
         uses: changesets/action@v1
         with:
           version: bun run changeset version
           publish: npm publish --access public --provenance
-          createGithubReleases: true
+          createGithubReleases: false
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Create GitHub release
+        if: steps.changesets.outputs.published == 'true'
+        env:
+          GH_TOKEN: ${{ github.token }}
+          TAG: ${{ steps.release.outputs.tag }}
+        run: |
+          if gh release view "$TAG" >/dev/null 2>&1; then
+            gh release edit "$TAG" --title "$TAG" --notes-file release-notes.md
+          else
+            gh release create "$TAG" --verify-tag --title "$TAG" --notes-file release-notes.md
+          fi

CHANGELOG.md

@@ -1,5 +1,11 @@
 # @api-wrappers/igdb-wrapper
 
+## 0.6.1
+
+### Patch Changes
+
+- Route protobuf requests through api-core so plugins, retries, timeouts, and shared transport behaviour apply consistently.
+
 ## 0.6.0
 
 ### Minor Changes

bun.lock

@@ -1,6 +1,6 @@
 {
 	"name": "@api-wrappers/igdb-wrapper",
-	"version": "0.6.0",
+	"version": "0.6.1",
 	"description": "Type-safe TypeScript client for the IGDB API with a fluent query builder, automatic retries, and built-in rate limiting",
 	"module": "./dist/index.mjs",
 	"type": "module",
@@ -69,6 +69,6 @@
 		"typescript": "^5"
 	},
 	"dependencies": {
-		"@api-wrappers/api-core": "^0.0.2"
+		"@api-wrappers/api-core": "^0.0.3"
 	}
 }

package.json

@@ -189,6 +189,7 @@ describe("IGDBClient", () => {
 
 	test("supports meta and protobuf requests", async () => {
 		const protobufBytes = new Uint8Array([8, 1, 18, 4]);
+		const coreRequestUrls: string[] = [];
 		const fetchMock = (async (input, init) => {
 			const url = String(input);
 
@@ -210,6 +211,7 @@ describe("IGDBClient", () => {
 				expect(init?.method).toBe("POST");
 				expect(headers.get("accept")).toBe("application/octet-stream");
 				expect(headers.get("authorization")).toBe("Bearer access-token");
+				expect(headers.get("x-core-request")).toBe("yes");
 				expect(init?.body).toBe("fields id,name; limit 1;");
 				return new Response(protobufBytes, {
 					headers: { "content-type": "application/octet-stream" },
@@ -219,7 +221,25 @@ describe("IGDBClient", () => {
 			throw new Error(`Unexpected request: ${url}`);
 		}) as typeof fetch;
 
-		const client = new IGDBClient({ ...testConfig, fetch: fetchMock });
+		const client = new IGDBClient({
+			...testConfig,
+			fetch: fetchMock,
+			plugins: [
+				{
+					name: "protobuf-core-probe",
+					beforeRequest(ctx) {
+						if (ctx.url.endsWith(".pb")) {
+							coreRequestUrls.push(ctx.url);
+							return {
+								...ctx,
+								headers: { ...ctx.headers, "x-core-request": "yes" },
+							};
+						}
+						return ctx;
+					},
+				},
+			],
+		});
 
 		await expect(client.games.meta()).resolves.toEqual([
 			{ name: "name", type: "String" },
@@ -230,6 +250,7 @@ describe("IGDBClient", () => {
 		await client.dispose();
 
 		expect([...bytes]).toEqual([...protobufBytes]);
+		expect(coreRequestUrls).toEqual(["https://api.igdb.com/v4/games.pb"]);
 	});
 
 	test("builds IGDB image URLs and tag numbers from documented formulas", () => {

src/__tests__/igdb-client.test.ts

@@ -46,16 +46,8 @@ interface IGDBCountResponse {
 
 export class HttpClient {
 	readonly #client: ReturnType<typeof createClient>;
-	readonly #auth: AuthManager;
-	readonly #clientId: string;
-	readonly #fetch: typeof globalThis.fetch;
-	readonly #timeoutMs: number | undefined;
 
 	constructor(options: HttpClientOptions) {
-		this.#auth = options.auth;
-		this.#clientId = options.clientId;
-		this.#fetch = options.fetch ?? globalThis.fetch;
-		this.#timeoutMs = options.timeoutMs;
 		this.#client = createClient({
 			baseUrl: IGDB_BASE,
 			defaultHeaders: {
@@ -95,38 +87,18 @@ export class HttpClient {
 
 	async requestProtobuf(endpoint: string, body: string): Promise<ArrayBuffer> {
 		const normalized = normalizeEndpoint(endpoint).replace(/\.pb$/, "");
-		const url = `${IGDB_BASE}/${normalized}.pb`;
-		const token = await this.#auth.getAccessToken();
-		const controller =
-			this.#timeoutMs === undefined ? null : new AbortController();
-		const timeout =
-			controller === null
-				? undefined
-				: setTimeout(() => controller.abort(), this.#timeoutMs);
 
 		try {
-			const response = await this.#fetch(url, {
+			return await this.#client.request<ArrayBuffer>(`/${normalized}.pb`, {
 				body,
 				headers: {
 					accept: "application/octet-stream",
-					authorization: `Bearer ${token}`,
-					"client-id": this.#clientId,
-					"content-type": "text/plain",
 				},
 				method: "POST",
-				signal: controller?.signal,
+				responseType: "arrayBuffer",
 			});
-
-			if (!response.ok) {
-				throw await toIGDBResponseError(response, `${normalized}.pb`);
-			}
-
-			return response.arrayBuffer();
 		} catch (error) {
-			if (error instanceof IGDBError) throw error;
 			throw toIGDBError(error, `${normalized}.pb`);
-		} finally {
-			if (timeout) clearTimeout(timeout);
 		}
 	}
 
@@ -183,32 +155,6 @@ function normalizeEndpoint(endpoint: string): string {
 	return endpoint.replace(/^\/+/, "").replace(/\/+$/, "");
 }
 
-async function toIGDBResponseError(
-	response: Response,
-	endpoint: string,
-): Promise<IGDBError> {
-	const body = await response.text().catch(() => "");
-
-	if (response.status === 401) {
-		return new IGDBAuthError("Unauthorized - check your client credentials");
-	}
-
-	if (response.status === 429) {
-		return new IGDBRateLimitError(readRetryAfterMs(response));
-	}
-
-	return new IGDBError(`HTTP ${response.status} on /${endpoint}: ${body}`);
-}
-
-function readRetryAfterMs(response: Response): number | undefined {
-	const raw = response.headers.get("retry-after");
-	if (!raw) return undefined;
-	const seconds = Number(raw);
-	if (Number.isFinite(seconds)) return Math.max(0, seconds * 1000);
-	const date = Date.parse(raw);
-	return Number.isNaN(date) ? undefined : Math.max(0, date - Date.now());
-}
-
 function toIGDBError(error: unknown, endpoint: string): IGDBError {
 	const cause = unwrapPluginError(error);
 	if (cause instanceof IGDBError) return cause;