chore: make modMetadata mandatory part of ModRepoRelease

mclib/src/ModQueryService.ts

@@ -76,11 +76,9 @@ export class ModQueryService {
             }
             // Try to get releases for this mod ID
             try {
-                const repoReleases = await repo.getModReleases(modRepoMeta.id);
+                const rawRepoReleases = await repo.getModReleases(modRepoMeta.id);
                 // Attach the metadata to the release
-                repoReleases.forEach(release => {
-                    release.modMetadata = modRepoMeta;
-                });
+                const repoReleases = rawRepoReleases.map(release => ({ ...release, modMetadata: modRepoMeta }));
                 releases.push(...repoReleases);
             } catch (error) {
                 logger.error("Error fetching mod releases for %s from %s: %s", modRepoMeta.id, repo.getRepositoryName(), error);

mclib/src/finder/LocalSolutionFinder.test.ts

@@ -279,7 +279,7 @@ describe('SolutionFinder', () => {
                 loader: ModLoader.FABRIC
             });
             expect(result.mods).toHaveLength(1);
-            expect(result.mods[0].modMetadata!.id).toBe('ice-and-fire-dragons');
+            expect(result.mods[0].modMetadata.id).toBe('ice-and-fire-dragons');
             expect(result.mods[0].modVersion).toBe('2.0.0');
         });
 

mclib/src/index.ts

@@ -14,6 +14,7 @@ export {
 
 export type {
   MCConfig,
+  RawModRepoRelease,
   ModRepoRelease,
   MCVersion,
   ModReleases

mclib/src/repos/CurseForgeRepository.ts

@@ -1,5 +1,5 @@
 import type { IRepository } from "./IRepository";
-import { ModRepoRelease, ModRepositoryName, ModLoader, ModRepoMetadata, MCVersion, ModLoaderUtil, ModReleases } from "..";
+import { RawModRepoRelease, ModRepositoryName, ModLoader, ModRepoMetadata, MCVersion, ModLoaderUtil } from "..";
 import { cf_fingerprint } from 'cf-fingerprint';
 import { logger } from "../logger";
 
@@ -20,7 +20,7 @@ export class CurseForgeRepository implements IRepository {
         return null;
     }
 
-    async getModReleases(modId: string): Promise<ModReleases> {
+    async getModReleases(modId: string): Promise<RawModRepoRelease[]> {
         type Data = {
             data: {
                 displayName: string;
@@ -33,7 +33,7 @@ export class CurseForgeRepository implements IRepository {
         if (!filesResp.ok) throw new Error("Could not fetch files from CurseForge");
         const jsonResp: Data = await filesResp.json();
 
-        const releases: ModRepoRelease[] = jsonResp.data.map(file => {
+        const releases: RawModRepoRelease[] = jsonResp.data.map(file => {
             const mcVersions: Set<MCVersion> = new Set();
             const loaders: Set<ModLoader> = new Set();
             for (let gameVersion of file.gameVersions || []) {

mclib/src/repos/IRepository.ts

@@ -1,4 +1,4 @@
-import type { ModReleases, ModRepoMetadata, ModRepositoryName } from "..";
+import type { ModRepoMetadata, ModRepositoryName, RawModRepoRelease } from "..";
 
 /**
  * Interface for a mod repository
@@ -16,7 +16,7 @@ export interface IRepository {
      * @param modId The ID of the mod.
      * @returns A promise resolving to an array of mod releases.
      */
-    getModReleases(modId: string): Promise<ModReleases>;
+    getModReleases(modId: string): Promise<RawModRepoRelease[]>;
 
     /**
      * Search for mods by a query string.

mclib/src/repos/ModrinthRepository.ts

@@ -1,5 +1,5 @@
 import type { IRepository } from "./IRepository";
-import { ModRepoRelease, ModRepositoryName, ModRepoMetadata, ModLoaderUtil, ModReleases } from "..";
+import { ModRepositoryName, ModRepoMetadata, ModLoaderUtil, RawModRepoRelease } from "..";
 
 export class ModrinthRepository implements IRepository {
 
@@ -17,7 +17,7 @@ export class ModrinthRepository implements IRepository {
         return data.project_id || null;
     }
 
-    async getModReleases(modId: string): Promise<ModReleases> {
+    async getModReleases(modId: string): Promise<RawModRepoRelease[]> {
         type Data = Array<{
             game_versions: string[];
             version_number: string;
@@ -31,7 +31,7 @@ export class ModrinthRepository implements IRepository {
         if (!versionsResp.ok) throw new Error("Could not fetch versions from Modrinth");
         const jsonResp: Data = await versionsResp.json();
 
-        const releases: ModRepoRelease[] = jsonResp.map(file => {
+        const releases: RawModRepoRelease[] = jsonResp.map(file => {
             const mcVersions = new Set(file.game_versions);
             const loaders = new Set(file.loaders.map(ModLoaderUtil.from));
             return {

mclib/src/types.ts

@@ -42,8 +42,12 @@ export type MCConfig = {
     loader: ModLoader;
 };
 
-/** Represents a release of a mod */
-export type ModRepoRelease = {
+/** Represents a release of a mod (a release is tied to a repository !) */
+export type ModRepoRelease = RawModRepoRelease & {
+    /** Repository-specific metadata about the mod itself*/
+    modMetadata: ModRepoMetadata
+};
+export type RawModRepoRelease = {
     /** List of Minecraft versions compatible with this release */
     mcVersions: Set<MCVersion>;
     /** Mod version */
@@ -54,8 +58,6 @@ export type ModRepoRelease = {
     loaders: Set<ModLoader>;
     /** Download URL for the mod release */
     downloadUrl: string;
-
-    modMetadata?: ModRepoMetadata;
 };
 
 export type ModMetadata = ModRepoMetadata[];