modpack-lock 0.5.0 → 0.5.1

package/README.md

@@ -1,6 +1,6 @@
 <a href="https://www.npmjs.com/package/modpack-lock"><img alt="NPM: npmjs.com/package/modpack-lock" src="https://img.shields.io/npm/v/modpack-lock?style=for-the-badge&logo=npm&logoColor=white&label=npm&color=%23C12127&labelColor=%23505050"></a>
-<a href="https://github.com/nickesc/modpack-lock"><img alt="Source: Github" src="https://img.shields.io/badge/source-github-brightgreen?style=for-the-badge&logo=github&labelColor=%23505050"></a>
-<a href="https://github.com/nickesc/modpack-lock/actions/workflows/generateLockfile-tests.yml"><img alt="Tests: github.com/nickesc/modpack-lock/actions/workflows/generateLockfile-tests.yml" src="https://img.shields.io/github/actions/workflow/status/nickesc/modpack-lock/modpack-lock-tests.yml?logo=github&label=tests&logoColor=white&style=for-the-badge&labelColor=%23505050"></a>
+<a href="https://github.com/nickesc/modpack-lock"><img alt="Source: github.com/nickesc/modpack-lock" src="https://img.shields.io/badge/source-github-brightgreen?style=for-the-badge&logo=github&labelColor=%23505050"></a>
+<a href="https://github.com/nickesc/modpack-lock/actions/workflows/modpack-lock-tests.yml"><img alt="Tests: github.com/nickesc/modpack-lock/actions/workflows/modpack-lock-tests.yml" src="https://img.shields.io/github/actions/workflow/status/nickesc/modpack-lock/modpack-lock-tests.yml?logo=github&label=tests&logoColor=white&style=for-the-badge&labelColor=%23505050"></a>
 
 # modpack-lock
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "modpack-lock",
-  "version": "0.5.0",
+  "version": "0.5.1",
   "description": "Creates a modpack lockfile for files hosted on Modrinth (mods, resource packs, shaders and datapacks)",
   "bugs": {
     "url": "https://github.com/nickesc/modpack-lock/issues"
@@ -11,7 +11,7 @@
   },
   "homepage": "https://nickesc.github.io/modpack-lock",
   "license": "MIT",
-  "author": "N. Escobar <nick@nescobar.media> (https://nickesc.github.io/)",
+  "author": "N. Escobar <nick@nickesc.io> (https://nickesc.github.io/)",
   "type": "module",
   "main": "src/modpack-lock.js",
   "bin": {

package/src/config/api.js

@@ -1,3 +1,9 @@
+import pkg from '../../package.json' with { type: 'json' };
+import * as constants from './constants.js';
+
+/** User-Agent header for Modrinth API requests */
+export const PACKAGE_USER_AGENT = `${constants.AUTHOR_USERNAME}/${pkg.name}/${pkg.version}`;
+
 /** Modrinth API base URL */
 export const MODRINTH_API_BASE = 'https://api.modrinth.com/v2';
 
@@ -30,3 +36,6 @@ export const GITHUB_FEATURED_LICENSES_ENDPOINT = `${GITHUB_LICENSES_ENDPOINT}?fe
 
 /** GitHub license endpoint */
 export const GITHUB_LICENSE_ENDPOINT = (license) => `${GITHUB_API_BASE}/licenses/${license}`;
+
+/** GitHub Accept request header */
+export const GITHUB_ACCEPT_HEADER = 'application/vnd.github+json';

package/src/config/constants.js

@@ -1,5 +1,8 @@
 import pkg from '../../package.json' with { type: 'json' };
 
+/** Author username */
+export const AUTHOR_USERNAME = 'nickesc';
+
 /** Lockfile format version -- increment on changes to the format */
 export const LOCKFILE_VERSION = "1.0.1";
 

package/src/generate_lockfile.js

@@ -71,7 +71,7 @@ async function writeLockfile(lockfile, outputPath) {
  */
 function generateCategoryReadme(category, entries, projectsMap, usersMap) {
     const categoryTitle = category.charAt(0).toUpperCase() + category.slice(1);
-    const lines = [`# ${categoryTitle}`, '', '| Name | Author | Version |', '|-|-|-|'];
+    const lines = [`# ${categoryTitle}`, '', '| Name | Author | Version | Dependencies | Dependants |', '|-|-|-|-|-|'];
 
     // Map category to Modrinth URL path segment
     const categoryPathMap = {};
@@ -80,11 +80,21 @@ function generateCategoryReadme(category, entries, projectsMap, usersMap) {
     }
     const categoryPath = categoryPathMap[category] || 'project';
 
+    // Build a set of project_ids present in this category for filtering dependencies
+    const categoryProjectIds = new Set();
+    for (const entry of entries) {
+        if (entry.version && entry.version.project_id) {
+            categoryProjectIds.add(entry.version.project_id);
+        }
+    }
+
     for (const entry of entries) {
         const version = entry.version;
         let nameCell = '';
         let authorCell = '';
         let versionCell = '';
+        let dependenciesCell = '';
+        let dependantsCell = '';
 
         if (version && version.project_id) {
             const project = projectsMap[version.project_id];
@@ -123,15 +133,68 @@ function generateCategoryReadme(category, entries, projectsMap, usersMap) {
 
             // Version column
             versionCell = version.version_number || 'Unknown';
+
+            // Dependencies column - only show dependencies that are present in this category
+            if (version.dependencies && Array.isArray(version.dependencies) && version.dependencies.length > 0) {
+                const dependencyLinks = [];
+                for (const dep of version.dependencies) {
+                    if (dep.project_id && categoryProjectIds.has(dep.project_id)) {
+                        const depProject = projectsMap[dep.project_id];
+                        if (depProject) {
+                            const depProjectName = depProject.title || depProject.slug || 'Unknown';
+                            const depProjectSlug = depProject.slug || depProject.id;
+                            const depUrl = `https://modrinth.com/${categoryPath}/${depProjectSlug}`;
+                            if (depProject.icon_url) {
+                                dependencyLinks.push(`<a href="${depUrl}"><img alt="${depProjectName}" src="${depProject.icon_url}" height="20px"></a>`);
+                            } else {
+                                dependencyLinks.push(`[${depProjectName}](${depUrl})`);
+                            }
+                        }
+                    }
+                }
+                dependenciesCell = dependencyLinks.length > 0 ? dependencyLinks.join(' ') : '-';
+            } else {
+                dependenciesCell = '-';
+            }
+
+            // Dependants column - find all entries in the same category that depend on this project
+            const dependants = [];
+            for (const catEntry of entries) {
+                // Skip if this is the same entry (same project_id)
+                if (catEntry.version && catEntry.version.project_id === version.project_id) {
+                    continue;
+                }
+                if (catEntry.version && catEntry.version.dependencies && Array.isArray(catEntry.version.dependencies)) {
+                    const hasDependency = catEntry.version.dependencies.some(
+                        dep => dep.project_id === version.project_id
+                    );
+                    if (hasDependency) {
+                        const depProject = projectsMap[catEntry.version.project_id];
+                        if (depProject) {
+                            const depProjectName = depProject.title || depProject.slug || 'Unknown';
+                            const depProjectSlug = depProject.slug || depProject.id;
+                            const depUrl = `https://modrinth.com/${categoryPath}/${depProjectSlug}`;
+                            if (depProject.icon_url) {
+                                dependants.push(`<a href="${depUrl}"><img alt="${depProjectName}" src="${depProject.icon_url}" height="20px"></a>`);
+                            } else {
+                                dependants.push(`[${depProjectName}](${depUrl})`);
+                            }
+                        }
+                    }
+                }
+            }
+            dependantsCell = dependants.length > 0 ? dependants.join(' ') : '-';
         } else {
             // File not found on Modrinth
             const fileName = path.basename(entry.path);
             nameCell = fileName;
             authorCell = 'Unknown';
             versionCell = '-';
+            dependenciesCell = '-';
+            dependantsCell = '-';
         }
 
-        lines.push(`| ${nameCell} | ${authorCell} | ${versionCell} |`);
+        lines.push(`| ${nameCell} | ${authorCell} | ${versionCell} | ${dependenciesCell} | ${dependantsCell} |`);
     }
 
     return lines.join('\n') + '\n';

package/src/github_interactions.js

@@ -9,7 +9,14 @@ import * as config from './config/index.js';
 export async function getLicenseList(featured = false) {
     try {
         const url = featured ? config.GITHUB_FEATURED_LICENSES_ENDPOINT : config.GITHUB_LICENSES_ENDPOINT;
-        const response = await fetch(url);
+        const response = await fetch(url,
+            {
+                headers: {
+                    'Accept': config.GITHUB_ACCEPT_HEADER,
+                    'User-Agent': config.PACKAGE_USER_AGENT
+                }
+            }
+        );
         if (!response.ok) {
             const errorText = await response.text();
             throw new Error(`GitHub API error (${response.status}): ${errorText}`);
@@ -50,7 +57,12 @@ export async function getLicenseText(spdxId) {
     }
     try {
         const url = config.GITHUB_LICENSE_ENDPOINT(spdxId.toLowerCase());
-        const response = await fetch(url);
+        const response = await fetch(url, {
+            headers: {
+                'Accept': config.GITHUB_ACCEPT_HEADER,
+                'User-Agent': config.PACKAGE_USER_AGENT
+            },
+        });
         if (!response.ok) {
             const errorText = await response.text();
             throw new Error(`GitHub API error (${response.status}): ${errorText}`);

package/src/modrinth_interactions.js

@@ -24,6 +24,7 @@ export async function getVersionsFromHashes(hashes) {
             method: 'POST',
             headers: {
                 'Content-Type': 'application/json',
+                'User-Agent': config.PACKAGE_USER_AGENT,
             },
             body: JSON.stringify({
                 hashes: hashes,
@@ -57,7 +58,11 @@ export async function getProjects(projectIds) {
     for (const chunk of chunks) {
         try {
             const url = `${config.MODRINTH_PROJECTS_ENDPOINT}?ids=${encodeURIComponent(JSON.stringify(chunk))}`;
-            const response = await fetch(url);
+            const response = await fetch(url, {
+                headers: {
+                    'User-Agent': config.PACKAGE_USER_AGENT,
+                },
+            });
 
             if (!response.ok) {
                 const errorText = await response.text();
@@ -89,7 +94,11 @@ export async function getUsers(userIds) {
     for (const chunk of chunks) {
         try {
             const url = `${config.MODRINTH_USERS_ENDPOINT}?ids=${encodeURIComponent(JSON.stringify(chunk))}`;
-            const response = await fetch(url);
+            const response = await fetch(url, {
+                headers: {
+                    'User-Agent': config.PACKAGE_USER_AGENT,
+                },
+            });
 
             if (!response.ok) {
                 const errorText = await response.text();
@@ -114,7 +123,11 @@ export async function getUsers(userIds) {
 export async function getMinecraftVersions() {
     try {
         const url = config.MODRINTH_MINECRAFT_VERSIONS_ENDPOINT;
-        const response = await fetch(url);
+        const response = await fetch(url, {
+            headers: {
+                'User-Agent': config.PACKAGE_USER_AGENT,
+            },
+        });
         if (!response.ok) {
             const errorText = await response.text();
             throw new Error(`Modrinth API error (${response.status}): ${errorText}`);
@@ -144,7 +157,11 @@ export async function getMinecraftVersions() {
 export async function getModloaders() {
     try {
         const url = config.MODRINTH_MODLOADERS_ENDPOINT;
-        const response = await fetch(url);
+        const response = await fetch(url, {
+            headers: {
+                'User-Agent': config.PACKAGE_USER_AGENT,
+            },
+        });
         if (!response.ok) {
             const errorText = await response.text();
             throw new Error(`Modrinth API error (${response.status}): ${errorText}`);