Merge pull request #57 from OpenNBS/feature/fix-typescript-typing-issues

Author: tomast1337

NoteBlockWorld.code-workspace

@@ -2,36 +2,36 @@
   "folders": [
     {
       "path": ".",
-      "name": "Root",
+      "name": "Root"
     },
     {
       "path": "./apps/backend",
-      "name": "Backend",
+      "name": "Backend"
     },
     {
       "path": "./apps/frontend",
-      "name": "Frontend",
+      "name": "Frontend"
     },
     {
       "path": "./packages/configs",
-      "name": "configs",
+      "name": "configs"
     },
     {
       "path": "./packages/database",
-      "name": "database",
+      "name": "database"
     },
     {
       "path": "./packages/song",
-      "name": "song",
+      "name": "song"
     },
     {
       "path": "./packages/sounds",
-      "name": "sounds",
+      "name": "sounds"
     },
     {
       "path": "./packages/thumbnail",
-      "name": "thumbnail",
-    },
+      "name": "thumbnail"
+    }
   ],
   "settings": {
     "window.title": "${dirty}${rootName}${separator}${profileName}${separator}${appName}",
@@ -41,12 +41,12 @@
     "eslint.format.enable": true,
     "mdx.server.enable": true,
     "editor.codeActionsOnSave": {
-      "source.fixAll": "explicit",
+      "source.fixAll": "explicit"
     },
     "search.exclude": {
       "**/.git": true,
       "**/node_modules": true,
-      "**/dist": true,
+      "**/dist": true
     },
     "workbench.colorCustomizations": {
       "activityBar.activeBackground": "#fac977",
@@ -65,8 +65,8 @@
       "titleBar.activeBackground": "#f8b646",
       "titleBar.activeForeground": "#15202b",
       "titleBar.inactiveBackground": "#f8b64699",
-      "titleBar.inactiveForeground": "#15202b99",
+      "titleBar.inactiveForeground": "#15202b99"
     },
-    "peacock.color": "#f8b646",
-  },
+    "peacock.color": "#f8b646"
+  }
 }

apps/backend/package.json

@@ -60,7 +60,8 @@
     "@nbw/database": "workspace:*",
     "@nbw/song": "workspace:*",
     "@nbw/thumbnail": "workspace:*",
-    "@nbw/sounds": "workspace:*"
+    "@nbw/sounds": "workspace:*",
+    "@nbw/config": "workspace:*"
   },
   "devDependencies": {
     "@faker-js/faker": "^9.3.0",
@@ -70,6 +71,7 @@
     "@types/bcryptjs": "^2.4.6",
     "@types/bun": "^1.2.10",
     "@types/express": "^4.17.21",
+    "@types/jest": "^29.5.12",
     "@types/multer": "^1.4.12",
     "@types/node": "^20.17.10",
     "@types/passport": "^1.0.17",
@@ -79,8 +81,10 @@
     "@types/passport-local": "^1.0.38",
     "@types/passport-oauth2": "^1.4.17",
     "@types/supertest": "^2.0.16",
+    "jest": "^29.7.0",
     "source-map-support": "^0.5.21",
     "supertest": "^6.3.4",
+    "ts-jest": "^29.1.2",
     "ts-loader": "^9.5.1",
     "ts-node": "^10.9.2",
     "tsc-watch": "^6.2.1",

apps/backend/src/song-browser/song-browser.service.ts

@@ -50,8 +50,9 @@ export class SongBrowserService {
       ) {
         const missing = BROWSER_SONGS.paddedFeaturedPageSize - songPage.length;
 
-        const additionalSongs =
-          await this.songService.getSongsBeforeTimespan(time);
+        const additionalSongs = await this.songService.getSongsBeforeTimespan(
+          time,
+        );
 
         songPage.push(...additionalSongs.slice(0, missing));
       }

apps/backend/src/song/song.service.ts

@@ -73,8 +73,9 @@ export class SongService {
       'username profileImage -_id',
     )) as unknown as SongWithUser;
 
-    const webhookMessageId =
-      await this.songWebhookService.syncSongWebhook(populatedSong);
+    const webhookMessageId = await this.songWebhookService.syncSongWebhook(
+      populatedSong,
+    );
 
     songDocument.webhookMessageId = webhookMessageId;
 
@@ -170,8 +171,9 @@ export class SongService {
       'username profileImage -_id',
     )) as unknown as SongWithUser;
 
-    const webhookMessageId =
-      await this.songWebhookService.syncSongWebhook(populatedSong);
+    const webhookMessageId = await this.songWebhookService.syncSongWebhook(
+      populatedSong,
+    );
 
     foundSong.webhookMessageId = webhookMessageId;
 
@@ -418,16 +420,13 @@ export class SongService {
     ])) as unknown as { _id: string; count: number }[];
 
     // Return object with category names as keys and counts as values
-    return categories.reduce(
-      (acc, category) => {
-        if (category._id) {
-          acc[category._id] = category.count;
-        }
+    return categories.reduce((acc, category) => {
+      if (category._id) {
+        acc[category._id] = category.count;
+      }
 
-        return acc;
-      },
-      {} as Record<string, number>,
-    );
+      return acc;
+    }, {} as Record<string, number>);
   }
 
   public async getSongsByCategory(

apps/backend/tsconfig.json

@@ -1,33 +1,36 @@
 {
-  "extends": "../../tsconfig.base.json",
-  "compilerOptions": {
-    // NestJS specific settings
-    "module": "commonjs",
-    "target": "ES2021",
-    "declaration": true,
-    "removeComments": true,
-    "allowSyntheticDefaultImports": true,
-    "sourceMap": true,
-    "outDir": "./dist",
-    "baseUrl": "./",
-    // Relaxed strict settings for backend
-    "strictNullChecks": false,
-    "noImplicitAny": false,
-    "strictBindCallApply": false,
-    "forceConsistentCasingInFileNames": false,
-    "noFallthroughCasesInSwitch": false,
-    // Path mapping
-    "paths": {
-      "@server/*": ["src/*"]
-    }
-  },
-  "include": ["src/**/*.ts"],
-  "exclude": [
-    "node_modules",
-    "dist",
-    "**/*.spec.ts",
-    "**/*.test.ts",
-    "e2e/**/*",
-    "test/**/*"
-  ]
-}
+    "extends": "../../tsconfig.base.json",
+    "compilerOptions": {
+        // NestJS specific settings
+        "module": "commonjs",
+        "target": "ES2021",
+        "declaration": true,
+        "removeComments": true,
+        "allowSyntheticDefaultImports": true,
+        "sourceMap": true,
+        "outDir": "./dist",
+        "baseUrl": "./",
+        // Relaxed strict settings for backend
+        "strictNullChecks": false,
+        "noImplicitAny": false,
+        "strictBindCallApply": false,
+        "forceConsistentCasingInFileNames": false,
+        "noFallthroughCasesInSwitch": false,
+        // Path mapping
+        "paths": {
+            "@server/*": [
+                "src/*"
+            ]
+        }
+    },
+    "include": [
+        "src/**/*.ts",
+        "src/**/*.d.ts"
+    ],
+    "exclude": [
+        "node_modules",
+        "dist",
+        "e2e/**/*",
+        "test/**/*"
+    ]
+}

apps/frontend/package.json

@@ -17,6 +17,7 @@
     "@hookform/resolvers": "^3.3.4",
     "@mdx-js/loader": "^3.0.1",
     "@mdx-js/react": "^3.0.1",
+    "@nbw/database": "workspace:*",
     "@next/mdx": "^14.2.6",
     "@next/third-parties": "^14.2.5",
     "@radix-ui/react-dialog": "^1.0.5",

apps/frontend/posts/blog/2024-10-07_changelog-october-2024.md

@@ -21,6 +21,7 @@ Here's what we've been up to since the last update:
   - The idea is to host guest writers from the community once in a while, so stay tuned!
 - Added the _About_ page! We're proud of our history and want to share it with you. We also want to acknowledge all the great people that have made this website possible, and everyone who's helped us along the way. Make sure to drop by and read about how Note Block World came to be!
 - The navigation bar at the top has been redesigned:
+
   - Now features _Songs_, _Help_, _Blog_, and _About_ tabs.
   - The _Upload_ icon is no longer shown on mobile devices.
   - The external links (_GitHub_, _Changelog_, and _Donate_) have been moved from inside your user menu into a 'Settings' menu, so they're now accessible even if you aren't logged in.
@@ -31,6 +32,7 @@ Here's what we've been up to since the last update:
 ### Bugfixes and improvements
 
 - Added more mob sounds to the available custom instruments:
+
   - Polar Bear
   - Phantom
   - Evoker

apps/frontend/posts/help/1_creating-song.md

@@ -64,6 +64,7 @@ Once you've made a selection, you can:
 Selecting notes also lets you change them in other ways, all of which are available in the context menu that appears when you right-click the workspace, or by using the keyboard shortcuts below:
 
 - **Transpose**: You can transpose the selected notes up or down by a certain number of semitones. This is useful for changing the key of a section of the song, or for creating harmonies.
+
   - **Transpose up** (`Ctrl+R`): Transpose the selected notes up by one semitone.
   - **Transpose down** (`Ctrl+F`): Transpose the selected notes down by one semitone.
   - **Transpose one octave up**: Transpose the selected notes up by one octave (12 semitones).

apps/frontend/posts/help/5_custom-instruments.md

@@ -38,6 +38,7 @@ You've added a custom instrument to your song! You can now use it just like any
 There are a few limitations to keep in mind when working with custom instruments in Note Block Studio:
 
 - **Custom instruments are not saved with the song file**: Song files only store the custom instrument settings, not the sound files themselves. This means that if you share your song with someone else, they won't have access to your custom instruments unless you also share the sound files you used. There are two ways to work around this limitation:
+
   - **Share the sound files** along with the song file, so others can use the custom instruments in your song. You can save the song in a ZIP file that includes the sound files you used by going to _File_ > _Save song with custom sounds..._. Alternatively, you can save only the instruments to a ZIP file by going to _Settings_ > _Instrument settings..._ and clicking _Export sounds_.
   - **Use the same sound files** for custom instruments in all your songs, so you don't have to share them every time you share a song. In the section _Downloading songs that use custom instruments_ further down this article, you'll learn how to obtain Minecraft sound files that you can use to standardize the reference to your custom sound files.
 

apps/frontend/src/app/(content)/page.tsx

@@ -1,13 +1,13 @@
 import { Metadata } from 'next';
 
-import { FeaturedSongsDtoType, SongPreviewDtoType } from '@nbw/database';
+import type { FeaturedSongsDto, SongPreviewDto } from '@nbw/database';
 import axiosInstance from '@web/lib/axios';
 import { HomePageProvider } from '@web/modules/browse/components/client/context/HomePage.context';
 import { HomePageComponent } from '@web/modules/browse/components/HomePageComponent';
 
 async function fetchRecentSongs() {
   try {
-    const response = await axiosInstance.get<SongPreviewDtoType[]>(
+    const response = await axiosInstance.get<SongPreviewDto[]>(
       '/song-browser/recent',
       {
         params: {
@@ -25,9 +25,9 @@ async function fetchRecentSongs() {
   }
 }
 
-async function fetchFeaturedSongs(): Promise<FeaturedSongsDtoType> {
+async function fetchFeaturedSongs(): Promise<FeaturedSongsDto> {
   try {
-    const response = await axiosInstance.get<FeaturedSongsDtoType>(
+    const response = await axiosInstance.get<FeaturedSongsDto>(
       '/song-browser/featured',
     );