Merge pull request #4 from falsepopsky/dev

 fix: endpoint `/v1/games/:game_id` queries parameters

Author: falsepopsky

.changeset/hungry-jokes-hunt.md

@@ -0,0 +1,18 @@
+---
+'@untidy/mobygames': patch
+---
+
+fix: The endpoint `/v1/games/:game_id` only supports the format `brief`, `normal` and `full`. Not
+`id`.
+
+Response from the endpoint:
+
+```js
+
+{
+  code: 13,
+  error: 'Invalid format',
+  message: 'Output format must be one of brief, normal, or full.'
+}
+
+```

.github/workflows/static.yaml

@@ -1,9 +1,7 @@
 name: Deploy static content to Pages
 
 on:
-  push:
-    branches:
-      - main
+  workflow_dispatch:
 
 permissions:
   contents: read

packages/api/CHANGELOG.md

@@ -4,8 +4,8 @@
 
 ### Major Changes
 
-- b21d293: This package provides access to the MobyGames API, allowing you to retrieve game data through
-  various endpoints with optional query parameters.
+- b21d293: This package provides access to the MobyGames API, allowing you to retrieve game data
+  through various endpoints with optional query parameters.
 
   - `/games`
   - `/games/:game_id`

packages/api/package.json

@@ -16,6 +16,13 @@
   "files": [
     "dist"
   ],
+  "keywords": [
+    "api",
+    "database",
+    "games",
+    "videogames",
+    "mobygames"
+  ],
   "scripts": {
     "clean:build": "rm -rf dist",
     "prebuild": "pnpm run clean:build",

packages/api/src/index.ts

@@ -84,7 +84,7 @@ export interface QueriesGamesRecent extends QueriesBase {
 
 export type QueriesRandom = Omit<QueriesBase, 'offset'>;
 
-export type QueriesGameById = Omit<QueriesBase, 'limit' | 'offset'>;
+export type QueriesGameById = Record<'format', 'normal' | 'brief' | 'full'>;
 
 export interface GetGenres {
   genres: Genre[];
@@ -126,8 +126,8 @@ export type GetGameById<Q extends QueriesGameById> = Q['format'] extends 'normal
   ? GameNormal
   : Q['format'] extends 'brief'
     ? GameBrief
-    : Q['format'] extends 'id'
-      ? GamesType<number>
+    : Q['format'] extends 'full'
+      ? GameNormal
       : GameNormal;
 
 export interface GetGamePlatforms {

packages/web/package.json

@@ -9,11 +9,11 @@
     "preview": "astro preview"
   },
   "dependencies": {
-    "@astrojs/check": "^0.5.9",
+    "@astrojs/check": "^0.5.10",
     "@astrojs/starlight": "^0.21.2",
     "@astrojs/starlight-tailwind": "^2.0.1",
     "@astrojs/tailwind": "^5.1.0",
-    "astro": "^4.5.8",
+    "astro": "^4.5.9",
     "sharp": "^0.33.2",
     "tailwindcss": "^3.4.1",
     "typescript": "^5.4.3"

packages/web/src/env.d.ts

@@ -1,2 +1,2 @@
 /// <reference path="../.astro/types.d.ts" />
-/// <reference types="astro/client" />
+/// <reference types="astro/client" />