chore: add GEMINI.md for workspace instructions and update package.json to include api-client module imports

Author: tomast1337

GEMINI.md

@@ -0,0 +1,29 @@
+# Gemini Workspace Instructions
+
+This document provides instructions for the Gemini AI assistant to effectively interact with the NoteBlockWorld project.
+
+## Package Manager
+
+This project uses **Bun** as the package manager and runtime. Do not use `npm`, `yarn`, or `pnpm`.
+
+- **Installation:** `bun install`
+- **Running scripts:** `bun run <script_name>`
+- **Adding dependencies:** `bun add <package_name>`
+- **Running tests:** `bun test`
+
+## Project Structure
+
+This is a TypeScript monorepo managed with Bun workspaces.
+
+- **`apps/`**: Contains the main applications.
+    - **`apps/backend`**: A NestJS application for the server-side logic.
+    - **`apps/frontend`**: A Next.js application for the user interface.
+- **`packages/`**: Contains shared libraries and modules used across the monorepo.
+    - **`packages/api-client`**: Client for communicating with the backend API.
+    - **`packages/configs`**: Shared configurations (e.g., ESLint, Prettier).
+    - **`packages/database`**: Database schemas, queries, and connection logic.
+    - **`packages/song`**: Core logic for handling and manipulating song data.
+    - **`packages/sounds`**: Logic related to fetching and managing sounds.
+    - **`packages/thumbnail`**: A library for generating song thumbnails.
+- **`tests/`**: Contains end-to-end tests, likely using Cypress.
+- **`tsconfig.base.json`**: The base TypeScript configuration for the entire monorepo.

bun.lock

@@ -160,6 +160,20 @@
         "eslint-plugin-mdx": "^3.1.5",
       },
     },
+    "packages/api-client": {
+      "name": "@nbw/api-client",
+      "dependencies": {
+        "@nbw/database": "workspace:*",
+        "axios": "^1.6.7",
+      },
+      "devDependencies": {
+        "@types/bun": "latest",
+        "typescript": "^5",
+      },
+      "peerDependencies": {
+        "typescript": "^5",
+      },
+    },
     "packages/configs": {
       "name": "@nbw/config",
       "devDependencies": {
@@ -607,6 +621,8 @@
 
     "@napi-rs/wasm-runtime": ["@napi-rs/[email protected]", "", { "dependencies": { "@emnapi/core": "^1.4.3", "@emnapi/runtime": "^1.4.3", "@tybys/wasm-util": "^0.10.0" } }, "sha512-ZVWUcfwY4E/yPitQJl481FjFo3K22D6qF0DuFH6Y/nbnE11GY5uguDxZMGXPQ8WQ0128MXQD7TnfHyK4oWoIJQ=="],
 
+    "@nbw/api-client": ["@nbw/api-client@workspace:packages/api-client"],
+
     "@nbw/backend": ["@nbw/backend@workspace:apps/backend"],
 
     "@nbw/config": ["@nbw/config@workspace:packages/configs"],
@@ -3189,6 +3205,8 @@
 
     "@napi-rs/wasm-runtime/@emnapi/runtime": ["@emnapi/[email protected]", "", { "dependencies": { "tslib": "^2.4.0" } }, "sha512-97/BJ3iXHww3djw6hYIfErCZFee7qCtrneuLa20UXFCOTCfBM2cvQHjWJ2EG0s0MtdNwInarqCTz35i4wWXHsQ=="],
 
+    "@nbw/api-client/@types/bun": ["@types/[email protected]", "", { "dependencies": { "bun-types": "1.2.22" } }, "sha512-5A/KrKos2ZcN0c6ljRSOa1fYIyCKhZfIVYeuyb4snnvomnpFqC0tTsEkdqNxbAgExV384OETQ//WAjl3XbYqQA=="],
+
     "@nbw/backend/@types/bun": ["@types/[email protected]", "", { "dependencies": { "bun-types": "1.2.22" } }, "sha512-5A/KrKos2ZcN0c6ljRSOa1fYIyCKhZfIVYeuyb4snnvomnpFqC0tTsEkdqNxbAgExV384OETQ//WAjl3XbYqQA=="],
 
     "@nbw/config/@types/bun": ["@types/[email protected]", "", { "dependencies": { "bun-types": "1.2.22" } }, "sha512-5A/KrKos2ZcN0c6ljRSOa1fYIyCKhZfIVYeuyb4snnvomnpFqC0tTsEkdqNxbAgExV384OETQ//WAjl3XbYqQA=="],
@@ -4043,6 +4061,8 @@
 
     "@jest/types/@types/node/undici-types": ["[email protected]", "", {}, "sha512-Ny6QZ2Nju20vw1SRHe3d9jVu6gJ+4e3+MMpqu7pqE5HT6WsTSlce++GQmK5UXS8mzV8DSYHrQH+Xrf2jVcuKNg=="],
 
+    "@nbw/api-client/@types/bun/bun-types": ["[email protected]", "", { "dependencies": { "@types/node": "*" }, "peerDependencies": { "@types/react": "^19" } }, "sha512-hwaAu8tct/Zn6Zft4U9BsZcXkYomzpHJX28ofvx7k0Zz2HNz54n1n+tDgxoWFGB4PcFvJXJQloPhaV2eP3Q6EA=="],
+
     "@nbw/backend/@types/bun/bun-types": ["[email protected]", "", { "dependencies": { "@types/node": "*" }, "peerDependencies": { "@types/react": "^19" } }, "sha512-hwaAu8tct/Zn6Zft4U9BsZcXkYomzpHJX28ofvx7k0Zz2HNz54n1n+tDgxoWFGB4PcFvJXJQloPhaV2eP3Q6EA=="],
 
     "@nbw/config/@types/bun/bun-types": ["[email protected]", "", { "dependencies": { "@types/node": "*" }, "peerDependencies": { "@types/react": "^19" } }, "sha512-hwaAu8tct/Zn6Zft4U9BsZcXkYomzpHJX28ofvx7k0Zz2HNz54n1n+tDgxoWFGB4PcFvJXJQloPhaV2eP3Q6EA=="],
@@ -4281,6 +4301,10 @@
 
     "@istanbuljs/load-nyc-config/find-up/locate-path/p-locate": ["[email protected]", "", { "dependencies": { "p-limit": "^2.2.0" } }, "sha512-R79ZZ/0wAxKGu3oYMlz8jy/kbhsNrS7SKZ7PxEHBgJ5+F2mtFW2fK2cOtBh1cHYkQsbzFV7I+EoRKe6Yt0oK7A=="],
 
+    "@nbw/api-client/@types/bun/bun-types/@types/node": ["@types/[email protected]", "", { "dependencies": { "undici-types": "~6.20.0" } }, "sha512-+lTU0PxZXn0Dr1NBtC7Y8cR21AJr87dLLU953CWA6pMxxv/UDc7jYAY90upcrie1nRcD6XNG5HOYEDtgW5TxAg=="],
+
+    "@nbw/api-client/@types/bun/bun-types/@types/react": ["@types/[email protected]", "", { "dependencies": { "csstype": "^3.0.2" } }, "sha512-AwAfQ2Wa5bCx9WP8nZL2uMZWod7J7/JSplxbTmBQ5ms6QpqNYm672H0Vu9ZVKVngQ+ii4R/byguVEUZQyeg44g=="],
+
     "@nbw/backend/@types/bun/bun-types/@types/node": ["@types/[email protected]", "", { "dependencies": { "undici-types": "~6.20.0" } }, "sha512-+lTU0PxZXn0Dr1NBtC7Y8cR21AJr87dLLU953CWA6pMxxv/UDc7jYAY90upcrie1nRcD6XNG5HOYEDtgW5TxAg=="],
 
     "@nbw/backend/@types/bun/bun-types/@types/react": ["@types/[email protected]", "", { "dependencies": { "csstype": "^3.0.2" } }, "sha512-AwAfQ2Wa5bCx9WP8nZL2uMZWod7J7/JSplxbTmBQ5ms6QpqNYm672H0Vu9ZVKVngQ+ii4R/byguVEUZQyeg44g=="],
@@ -4385,6 +4409,8 @@
 
     "@istanbuljs/load-nyc-config/find-up/locate-path/p-locate/p-limit": ["[email protected]", "", { "dependencies": { "p-try": "^2.0.0" } }, "sha512-//88mFWSJx8lxCzwdAABTJL2MyWB12+eIY7MDL2SqLmAkeKU9qxRvWuSyTjm3FUmpBEMuFfckAIqEaVGUDxb6w=="],
 
+    "@nbw/api-client/@types/bun/bun-types/@types/node/undici-types": ["[email protected]", "", {}, "sha512-Ny6QZ2Nju20vw1SRHe3d9jVu6gJ+4e3+MMpqu7pqE5HT6WsTSlce++GQmK5UXS8mzV8DSYHrQH+Xrf2jVcuKNg=="],
+
     "@nbw/backend/@types/bun/bun-types/@types/node/undici-types": ["[email protected]", "", {}, "sha512-Ny6QZ2Nju20vw1SRHe3d9jVu6gJ+4e3+MMpqu7pqE5HT6WsTSlce++GQmK5UXS8mzV8DSYHrQH+Xrf2jVcuKNg=="],
 
     "@nbw/config/@types/bun/bun-types/@types/node/undici-types": ["[email protected]", "", {}, "sha512-Ny6QZ2Nju20vw1SRHe3d9jVu6gJ+4e3+MMpqu7pqE5HT6WsTSlce++GQmK5UXS8mzV8DSYHrQH+Xrf2jVcuKNg=="],

package.json

@@ -33,6 +33,10 @@
     "./sounds": {
       "import": "./packages/sounds/dist/index.js",
       "types": "./packages/sounds/dist/index.d.ts"
+    },
+    "./api-client": {
+      "import": "./packages/api-client/dist/index.js",
+      "types": "./packages/api-client/dist/index.d.ts"
     }
   },
   "scripts": {