Implemented NeoForge metadata wrapper

src/loaders/neoforge/neoforge-metadata.ts

@@ -0,0 +1,120 @@
+import { Dependency } from "@/dependencies";
+import { MINECRAFT } from "@/games/minecraft";
+import { LoaderMetadata } from "@/loaders/loader-metadata";
+import { PlatformType } from "@/platforms";
+import { $i } from "@/utils/collections";
+import { asString } from "@/utils/string-utils";
+import { getNeoForgeDependencies, normalizeNeoForgeDependency } from "./neoforge-dependency";
+import { NeoForgeMetadataCustomPayload, getDependenciesFromNeoForgeMetadataCustomPayload, getNeoForgeMetadataCustomPayload, getLoadersFromNeoForgeMetadataCustomPayload, getProjectIdFromNeoForgeMetadataCustomPayload } from "./neoforge-metadata-custom-payload";
+import { NeoForgeMod } from "./neoforge-mod";
+import { RawNeoForgeMetadata } from "./raw-neoforge-metadata";
+
+/**
+ * Represents NeoForge mod metadata.
+ */
+export class NeoForgeMetadata implements LoaderMetadata {
+    /**
+     * The raw NeoForge metadata used to create this instance.
+     */
+    private readonly _raw: RawNeoForgeMetadata;
+
+    /**
+     * Constructs a new {@link NeoForgeMetadata} instance.
+     *
+     * @param raw - The raw NeoForge metadata.
+     */
+    private constructor(raw: RawNeoForgeMetadata) {
+        this._raw = raw || {} as RawNeoForgeMetadata;
+    }
+
+    /**
+     * Creates a new {@link NeoForgeMetadata} instance from the given raw metadata.
+     *
+     * @param raw - The raw NeoForge metadata.
+     *
+     * @returns A new `NeoForgeMetadata` instance.
+     */
+    static from(raw: RawNeoForgeMetadata): NeoForgeMetadata {
+        return new NeoForgeMetadata(raw);
+    }
+
+    /**
+     * @inheritdoc
+     */
+    get id(): string {
+        return asString(this.mod.modId || "");
+    }
+
+    /**
+     * @inheritdoc
+     */
+    get name(): string {
+        return asString(this.mod.displayName || this.mod.modId || "");
+    }
+
+    /**
+     * @inheritdoc
+     */
+    get version(): string {
+        return asString(this.mod.version || "*");
+    }
+
+    /**
+     * @inheritdoc
+     */
+    get loaders(): string[] {
+        return getLoadersFromNeoForgeMetadataCustomPayload(this._raw);
+    }
+
+    /**
+     * @inheritdoc
+     */
+    get gameName(): string {
+        return MINECRAFT;
+    }
+
+    /**
+     * @inheritdoc
+     */
+    get gameVersions(): string[] {
+        return [...(this.dependencies.find(x => x.id === this.gameName)?.versions || [])];
+    }
+
+    /**
+     * @inheritdoc
+     */
+    get dependencies(): Dependency[] {
+        const baseDependencies = getNeoForgeDependencies(this._raw).map(normalizeNeoForgeDependency).filter(x => x);
+        const payloadDependencies = getDependenciesFromNeoForgeMetadataCustomPayload(this.customPayload);
+        const dependencyMap = $i(baseDependencies).concat(payloadDependencies).filter(x => x).map(x => [x.id, x] as const).toMap();
+        return [...dependencyMap.values()];
+    }
+
+    /**
+     * The mod represented by this metadata.
+     */
+    get mod(): NeoForgeMod {
+        return this._raw.mods?.[0] || {} as NeoForgeMod;
+    }
+
+    /**
+     * The raw NeoForge metadata representing this instance.
+     */
+    get raw(): RawNeoForgeMetadata {
+        return this._raw;
+    }
+
+    /**
+     * The custom payload attached to the NeoForge metadata.
+     */
+    get customPayload(): NeoForgeMetadataCustomPayload {
+        return getNeoForgeMetadataCustomPayload(this._raw);
+    }
+
+    /**
+     * @inheritdoc
+     */
+    getProjectId(platform: PlatformType): string {
+        return getProjectIdFromNeoForgeMetadataCustomPayload(this.customPayload, platform) || this.id;
+    }
+}

tests/content/neoforge/mods.toml

@@ -15,13 +15,12 @@ license="MIT"
 
 [[dependencies.example-mod]]
     modId="minecraft"
-    mandatory=true
+    type="required"
     versionRange="[1.17, 1.18)"
     side="BOTH"
 
 [[dependencies.example-mod]]
     modId="neoforge"
-    mandatory=true
     versionRange="[34,)"
     ordering="NONE"
     side="BOTH"
@@ -35,7 +34,7 @@ license="MIT"
 
 [[dependencies.example-mod]]
     modId="suggested-mod"
-    mandatory=false
+    type="optional"
     versionRange="*"
     ordering="NONE"
     side="BOTH"
@@ -45,19 +44,16 @@ license="MIT"
         github="v0.3.0"
         ignore=["curseforge"]
 
-
 [[dependencies.example-mod]]
-    modId="included-mod"
-    mandatory=false
-    embedded=true
-    versionRange="*"
+    modId="conflicting-mod"
+    type="discouraged"
+    versionRange="(,0.40.0)"
     ordering="NONE"
     side="BOTH"
 
 [[dependencies.example-mod]]
     modId="breaking-mod"
-    mandatory=false
-    incompatible=true
+    type="incompatible"
     versionRange="*"
     ordering="NONE"
     side="BOTH"
@@ -66,8 +62,8 @@ license="MIT"
     modrinth="AANobbMI"
     curseforge=394468
     github="mc1.18-0.4.0-alpha5"
-    loaders=["forge", "forge2"]
+    loaders=["neoforge", "neoforge2"]
     dependencies=[
         "recommended-mod@0.2.0(recommended){modrinth:AAAA}{curseforge:42}{github:v0.2.0}#(ignore)",
-        "conflicting-mod@<0.40.0(conflicting)",
+        "included-mod(embedded)",
     ]

tests/unit/loaders/neoforge/neoforge-metadata.spec.ts

@@ -0,0 +1,229 @@
+import { readFileSync } from "node:fs";
+import { resolve as resolvePath } from "node:path";
+import { parse as parseToml } from "toml";
+import { DependencyType } from "@/dependencies/dependency-type";
+import { PlatformType } from "@/platforms/platform-type";
+import { RawNeoForgeMetadata } from "@/loaders/neoforge/raw-neoforge-metadata";
+import { NeoForgeMetadata } from "@/loaders/neoforge/neoforge-metadata";
+
+const RAW_METADATA: RawNeoForgeMetadata = Object.freeze(parseToml(
+    readFileSync(resolvePath(__dirname, "../../../content/neoforge/mods.toml"), "utf8")
+));
+
+describe("NeoForgeMetadata", () => {
+    describe("from", () => {
+        test("constructs new NeoForgeMetadata instance using given raw metadata", () => {
+            const metadata = NeoForgeMetadata.from(RAW_METADATA);
+
+            expect(metadata).toBeInstanceOf(NeoForgeMetadata);
+            expect(metadata.raw).toBe(RAW_METADATA);
+        });
+    });
+
+    describe("id", () => {
+        test("returns id of the mod", () => {
+            const metadata = NeoForgeMetadata.from(RAW_METADATA);
+
+            expect(metadata.id).toBe("example-mod");
+        });
+    });
+
+    describe("name", () => {
+        test("returns name of the mod", () => {
+            const metadata = NeoForgeMetadata.from(RAW_METADATA);
+
+            expect(metadata.name).toBe("Example Mod");
+        });
+    });
+
+    describe("version", () => {
+        test("returns version of the mod", () => {
+            const metadata = NeoForgeMetadata.from(RAW_METADATA);
+
+            expect(metadata.version).toBe("0.1.0");
+        });
+    });
+
+    describe("loaders", () => {
+        test(`returns 'neoforge' by default`, () => {
+            const rawWithoutLoadersField = {
+                ...RAW_METADATA,
+                "mc-publish": {
+                    ...RAW_METADATA["mc-publish"],
+                    loaders: undefined,
+                },
+            };
+
+            const metadata = NeoForgeMetadata.from(rawWithoutLoadersField);
+
+            expect(metadata.loaders).toEqual(["neoforge"]);
+        });
+
+        test("returns the same value as the 'loaders' field in the custom payload", () => {
+            const metadata = NeoForgeMetadata.from(RAW_METADATA);
+
+            expect(metadata.loaders).toEqual(["neoforge", "neoforge2"]);
+        });
+    });
+
+    describe("gameName", () => {
+        test("always returns 'minecraft'", () => {
+            expect(NeoForgeMetadata.from({} as RawNeoForgeMetadata).gameName).toBe("minecraft");
+            expect(NeoForgeMetadata.from(RAW_METADATA).gameName).toBe("minecraft");
+        });
+    });
+
+    describe("gameVersions", () => {
+        test("returns an empty array if no dependencies were specified", () => {
+            const metadata = NeoForgeMetadata.from({} as RawNeoForgeMetadata);
+
+            expect(metadata.gameVersions).toEqual([]);
+        });
+
+        test("returns the same value as the 'minecraft' dependency", () => {
+            const metadata = NeoForgeMetadata.from({ dependencies: { "example-mod": [{ modId: "minecraft", versionRange: "[1.16.5,)" }] } } as unknown as RawNeoForgeMetadata);
+
+            expect(metadata.gameVersions).toEqual(["[1.16.5,)"]);
+        });
+
+        test("returns the same values as the 'minecraft' dependency", () => {
+            const metadata = NeoForgeMetadata.from(RAW_METADATA);
+
+            expect(metadata.gameVersions).toEqual(["[1.17, 1.18)"]);
+        });
+    });
+
+    describe("dependencies", () => {
+        test("returns an empty array if no dependencies were specified", () => {
+            const metadata = NeoForgeMetadata.from({} as RawNeoForgeMetadata);
+
+            expect(metadata.dependencies).toEqual([]);
+        });
+
+        test("returns dependencies if they were specified", () => {
+            const metadata = NeoForgeMetadata.from({ dependencies: { "example-mod": [{ modId: "breaking-mod", versionRange: "*", type: "incompatible" }] } } as unknown as RawNeoForgeMetadata);
+
+            const dependencies = metadata.dependencies;
+
+            expect(dependencies).toHaveLength(1);
+            expect(dependencies[0]).toMatchObject({ id: "breaking-mod", versions: ["*"], type: DependencyType.INCOMPATIBLE });
+        });
+
+        test("regular dependencies have no aliases", () => {
+            const metadata = NeoForgeMetadata.from(RAW_METADATA);
+
+            const dependencies = metadata.dependencies;
+            const regularDependencies = ["included-mod", "conflicting-mod", "breaking-mod"].map(id => dependencies.find(x => x.id === id));
+
+            for (const dependency of regularDependencies) {
+                for (const platform of PlatformType.values()) {
+                    expect(dependency?.getProjectId(platform)).toBe(dependency.id);
+                }
+            }
+        });
+
+        test(`special dependencies ('neoforge', 'minecraft', 'java') are ignored by default`, () => {
+            const metadata = NeoForgeMetadata.from(RAW_METADATA);
+
+            const dependencies = metadata.dependencies;
+
+            expect(dependencies.find(x => x.id === "neoforge")?.isIgnored()).toBe(true);
+            expect(dependencies.find(x => x.id === "minecraft")?.isIgnored()).toBe(true);
+            expect(dependencies.find(x => x.id === "java")?.isIgnored()).toBe(true);
+        });
+
+        test("regular dependencies are not ignored by default", () => {
+            const metadata = NeoForgeMetadata.from(RAW_METADATA);
+
+            const dependencies = metadata.dependencies;
+
+            expect(dependencies.find(x => x.id === "included-mod")?.isIgnored()).toBe(false);
+            expect(dependencies.find(x => x.id === "suggested-mod")?.isIgnored()).toBe(false);
+            expect(dependencies.find(x => x.id === "conflicting-mod")?.isIgnored()).toBe(false);
+            expect(dependencies.find(x => x.id === "breaking-mod")?.isIgnored()).toBe(false);
+        });
+
+        test("returns dependencies merged with the 'dependencies' declaration from the custom payload", () => {
+            const metadata = NeoForgeMetadata.from(RAW_METADATA);
+
+            const dependencies = metadata.dependencies;
+
+            expect(dependencies).toHaveLength(8);
+            expect(dependencies.find(x => x.id === "neoforge")).toMatchObject({ versions: ["[34,)"], type: DependencyType.REQUIRED });
+            expect(dependencies.find(x => x.id === "minecraft")).toMatchObject({ versions: ["[1.17, 1.18)"], type: DependencyType.REQUIRED });
+            expect(dependencies.find(x => x.id === "java")).toMatchObject({ versions: ["[16,)"], type: DependencyType.REQUIRED });
+            expect(dependencies.find(x => x.id === "recommended-mod")).toMatchObject({ versions: ["0.2.0"], type: DependencyType.RECOMMENDED });
+            expect(dependencies.find(x => x.id === "included-mod")).toMatchObject({ versions: ["*"], type: DependencyType.EMBEDDED });
+            expect(dependencies.find(x => x.id === "suggested-mod")).toMatchObject({ versions: ["*"], type: DependencyType.OPTIONAL });
+            expect(dependencies.find(x => x.id === "conflicting-mod")).toMatchObject({ versions: ["(,0.40.0)"], type: DependencyType.CONFLICTING });
+            expect(dependencies.find(x => x.id === "breaking-mod")).toMatchObject({ versions: ["*"], type: DependencyType.INCOMPATIBLE });
+
+            const merged = dependencies.find(x => x.id === "recommended-mod");
+            expect(merged.getProjectId(PlatformType.MODRINTH)).toBe("AAAA");
+            expect(merged.getProjectId(PlatformType.CURSEFORGE)).toBe("42");
+            expect(merged.getProjectId(PlatformType.GITHUB)).toBe("v0.2.0");
+            expect(merged.isIgnored()).toBe(true);
+
+            const withMetadata = dependencies.find(x => x.id === "suggested-mod");
+            expect(withMetadata.getProjectId(PlatformType.MODRINTH)).toBe("BBBB");
+            expect(withMetadata.getProjectId(PlatformType.CURSEFORGE)).toBe("43");
+            expect(withMetadata.getProjectId(PlatformType.GITHUB)).toBe("v0.3.0");
+            expect(withMetadata.isIgnored()).toBe(false);
+            expect(withMetadata.isIgnored(PlatformType.CURSEFORGE)).toBe(true);
+        });
+    });
+
+    describe("mod", () => {
+        test("returns the main mod entry in the metadata", () => {
+            const metadata = NeoForgeMetadata.from(RAW_METADATA);
+
+            expect(metadata.mod?.modId).toBe("example-mod");
+        });
+
+        test("returns an empty mod entry if no mods were specified in the metadata", () => {
+            const metadata = NeoForgeMetadata.from({} as RawNeoForgeMetadata);
+
+            expect(metadata.mod).toEqual({});
+        });
+    });
+
+    describe("raw", () => {
+        test("returns the raw metadata oject this instance was created from", () => {
+            const metadata = NeoForgeMetadata.from(RAW_METADATA);
+
+            expect(metadata.raw).toBe(RAW_METADATA);
+        });
+    });
+
+    describe("customPayload", () => {
+        test("returns an empty object by default", () => {
+            const metadata = NeoForgeMetadata.from({} as RawNeoForgeMetadata);
+
+            expect(metadata.customPayload).toEqual({});
+        });
+
+        test("return the custom payload if it was specified", () => {
+            const metadata = NeoForgeMetadata.from(RAW_METADATA);
+
+            expect(metadata.customPayload?.loaders).toEqual(["neoforge", "neoforge2"]);
+        });
+    });
+
+    describe("getProjectId", () => {
+        test("returns the mod id by default", () => {
+            const metadata = NeoForgeMetadata.from({ mods: [{ modId: "example-mod" }] } as RawNeoForgeMetadata);
+
+            for (const platform of PlatformType.values()) {
+                expect(metadata.getProjectId(platform)).toBe("example-mod");
+            }
+        });
+
+        test("returns the same value as one specified in the custom payload", () => {
+            const metadata = NeoForgeMetadata.from(RAW_METADATA);
+
+            expect(metadata.getProjectId(PlatformType.MODRINTH)).toBe("AANobbMI");
+            expect(metadata.getProjectId(PlatformType.CURSEFORGE)).toBe("394468");
+            expect(metadata.getProjectId(PlatformType.GITHUB)).toBe("mc1.18-0.4.0-alpha5");
+        });
+    });
+});