binary-collections 2.0.7 → 2.0.9

package/lib/package-resolutions-updater.d.ts

@@ -0,0 +1,352 @@
+import ansiColors from 'ansi-colors';
+import * as dotenv from 'dotenv';
+import fs from 'fs';
+import https from 'https';
+import os from 'os';
+import path from 'path';
+import { getArgs } from './utils.js';
+import 'minimist';
+
+/**
+ * 📦 GitHub Package Resolver
+ *
+ * This script updates the commit hashes in `package.json`'s `resolutions` field
+ * for GitHub tarball URLs (typically using `raw/branch-name/...`) to point to the
+ * latest commit SHA of the corresponding repository and branch.
+ *
+ * 🔍 Features:
+ * - Parses GitHub URLs to extract repository owner, name, and branch.
+ * - Fetches the latest commit SHA across all branches using GitHub's API.
+ * - Replaces the old branch or commit in the URL with the latest SHA.
+ * - Overwrites `package.json` with the updated URLs.
+ *
+ * 🛠 Requirements:
+ * - GitHub Personal Access Token (GITHUB_TOKEN) via `.env`
+ * - ESM support (`type: "module"` in `package.json`)
+ * - Node.js v18+ recommended for ESM and `fetch` fallback compatibility
+ *
+ * 🧩 Dependencies:
+ * - `ansi-colors` – for styled terminal output
+ * - `dotenv` – to load GitHub token from `.env`
+ *
+ * ✅ Use case:
+ * - Ensures package resolutions always use immutable SHAs instead of mutable branch names.
+ * - Helps achieve deterministic builds in monorepos or projects with internal GitHub packages.
+ */
+
+
+const projectDir = process.cwd();
+const envPath = path.join(projectDir, ".env");
+const args = getArgs();
+const ACCESS_TOKEN = process.env.GITHUB_TOKEN || process.env.ACCESS_TOKEN;
+
+// Show help if --help/-h is passed
+if (args.help || args.h) {
+  showHelp();
+}
+
+/**
+ * Display help information for the package-resolutions-updater script.
+ */
+function showHelp() {
+  const helpText = `\n\
+GitHub Package Resolutions Updater\n\
+Usage:\n  node src/package-resolutions-updater.mjs [options]\n\
+Options:\n  --help, -h           Show this help message\n\
+Description:\n  Updates the commit hashes in package.json's 'resolutions' field for GitHub tarball URLs to point to the latest commit SHA of the corresponding repository and branch.\n\
+Features:\n  - Parses GitHub URLs to extract repository owner, name, and branch.\n  - Fetches the latest commit SHA across all branches using GitHub's API.\n  - Replaces the old branch or commit in the URL with the latest SHA.\n  - Overwrites package.json with the updated URLs.\n\
+Requirements:\n  - GitHub Personal Access Token (GITHUB_TOKEN) via .env\n  - ESM support (type: "module" in package.json)\n  - Node.js v18+ recommended\n\
+Dependencies:\n  - ansi-colors – for styled terminal output\n  - dotenv – to load GitHub token from .env\n\
+Examples:\n  node src/package-resolutions-updater.mjs\n  node src/package-resolutions-updater.mjs --help\n\n`;
+  console.log(helpText);
+  process.exit(0);
+}
+
+// Load the .env file using dotenv (ESM import)
+if (fs.existsSync(envPath)) dotenv.config({ path: envPath });
+
+// 📌 Static override rules
+const specialPackageOverrides = [
+  // SBG packages
+  { pkg: "sbg-utility", branch: "sbg-utility", repo: "static-blog-generator", owner: "dimaslanjaka" },
+  { pkg: "sbg-api", branch: "sbg-api", repo: "static-blog-generator", owner: "dimaslanjaka" },
+  { pkg: "instant-indexing", branch: "instant-indexing", repo: "static-blog-generator", owner: "dimaslanjaka" },
+  { pkg: "sbg-server", branch: "master", repo: "static-blog-generator", owner: "dimaslanjaka" },
+  { pkg: "sbg-cli", branch: "master", repo: "static-blog-generator", owner: "dimaslanjaka" },
+  { pkg: "static-blog-generator", branch: "master", repo: "static-blog-generator", owner: "dimaslanjaka" },
+  // Hexo family
+  { pkg: "hexo", branch: "monorepo-v7", repo: "hexo", owner: "dimaslanjaka" },
+  { pkg: "hexo-util", branch: "monorepo-v7", repo: "hexo", owner: "dimaslanjaka" },
+  { pkg: "warehouse", branch: "monorepo-v7", repo: "hexo", owner: "dimaslanjaka" },
+  { pkg: "hexo-server", branch: "monorepo-v7", repo: "hexo", owner: "dimaslanjaka" },
+  { pkg: "hexo-log", branch: "monorepo-v7", repo: "hexo", owner: "dimaslanjaka" },
+  { pkg: "hexo-front-matter", branch: "monorepo-v7", repo: "hexo", owner: "dimaslanjaka" },
+  { pkg: "hexo-cli", branch: "monorepo-v7", repo: "hexo", owner: "dimaslanjaka" },
+  { pkg: "hexo-asset-link", branch: "monorepo-v7", repo: "hexo", owner: "dimaslanjaka" },
+  { pkg: "hexo-post-parser", branch: "pre-release", repo: "hexo-post-parser", owner: "dimaslanjaka" },
+  { pkg: "hexo-seo", branch: "pre-release", repo: "hexo-seo", owner: "dimaslanjaka" },
+  { pkg: "hexo-is", branch: "master", repo: "hexo-is", owner: "dimaslanjaka" },
+  { pkg: "markdown-it", branch: "master", repo: "markdown-it", owner: "dimaslanjaka" },
+  { pkg: "hexo-renderers", branch: "pre-release", repo: "hexo-renderers", owner: "dimaslanjaka" },
+  { pkg: "hexo-shortcodes", branch: "pre-release", repo: "hexo-shortcodes", owner: "dimaslanjaka" },
+  { pkg: "google-news-sitemap", branch: "master", repo: "google-news-sitemap", owner: "dimaslanjaka" },
+  { pkg: "git-command-helper", branch: "pre-release", repo: "git-command-helper", owner: "dimaslanjaka" },
+  {
+    pkg: "nodejs-package-types",
+    branch: "main",
+    repo: "nodejs-package-types",
+    owner: "dimaslanjaka"
+  },
+  { pkg: "cross-spawn", branch: "private", repo: "node-cross-spawn", owner: "dimaslanjaka" },
+  { pkg: "hexo-generator-redirect", branch: "master", repo: "hexo-generator-redirect", owner: "dimaslanjaka" },
+  { pkg: "binary-collections", branch: "master", repo: "bin", owner: "dimaslanjaka" },
+  { pkg: "@types/hexo", branch: "monorepo-v7", repo: "hexo", owner: "dimaslanjaka" },
+  { pkg: "@types/git-command-helper", branch: "pre-release", repo: "git-command-helper", owner: "dimaslanjaka" }
+];
+
+// --- Optimized: Load package.json once at the top ---
+const pkgPath = path.join(process.cwd(), "package.json");
+let pkg;
+try {
+  pkg = JSON.parse(fs.readFileSync(pkgPath, "utf-8"));
+} catch (e) {
+  console.error(ansiColors.red(`Failed to read package.json: ${e.message}`));
+  process.exit(1);
+}
+
+// --- Use a random User-Agent for GitHub API requests ---
+const GITHUB_USER_AGENTS = [
+  "octokit-rest.js/19.0.7",
+  "GitHub CLI/2.40.0",
+  "Mozilla/5.0 (compatible; GitHubCopilot/1.0)",
+  "PostmanRuntime/7.32.3",
+  "binary-collections-resolver/1.0 (+https://github.com/dimaslanjaka/bin)"
+];
+
+// --- User-Agent persistence in system temp folder ---
+const userAgentDir = path.join(os.tmpdir(), "nodejs");
+const userAgentFile = path.join(userAgentDir, "useragent.txt");
+let selectedUserAgent;
+try {
+  if (!fs.existsSync(userAgentDir)) fs.mkdirSync(userAgentDir, { recursive: true });
+  if (fs.existsSync(userAgentFile)) {
+    const fileAgent = fs.readFileSync(userAgentFile, "utf-8").trim();
+    if (GITHUB_USER_AGENTS.includes(fileAgent)) {
+      selectedUserAgent = fileAgent;
+    }
+  }
+  if (!selectedUserAgent) {
+    selectedUserAgent = GITHUB_USER_AGENTS[Math.floor(Math.random() * GITHUB_USER_AGENTS.length)];
+    fs.writeFileSync(userAgentFile, selectedUserAgent, "utf-8");
+  }
+} catch (_e) {
+  // fallback to random if any error
+  selectedUserAgent = GITHUB_USER_AGENTS[Math.floor(Math.random() * GITHUB_USER_AGENTS.length)];
+}
+
+/**
+ * Fetch JSON from a URL with GitHub headers.
+ * @param {string} url
+ * @returns {Promise<any>}
+ */
+function fetchJson(url) {
+  const headers = {
+    "User-Agent": selectedUserAgent,
+    Accept: "application/vnd.github.v3+json",
+    "X-GitHub-Api-Version": "2022-11-28",
+    ...(ACCESS_TOKEN ? { Authorization: `token ${ACCESS_TOKEN}` } : {})
+  };
+  return new Promise((resolve, reject) => {
+    https
+      .get(url, { headers }, (res) => {
+        let data = "";
+        res.on("data", (chunk) => (data += chunk));
+        res.on("end", () => {
+          try {
+            const json = JSON.parse(data);
+            if (res.statusCode < 200 || res.statusCode >= 300) {
+              return reject(
+                new Error(`GitHub API Error ${res.statusCode}: ${json.message || "Unknown error"}\nURL: ${url}`)
+              );
+            }
+            resolve(json);
+          } catch {
+            reject(new Error(`Invalid JSON from: ${url}`));
+          }
+        });
+      })
+      .on("error", reject);
+  });
+}
+
+/**
+ * Get latest commit SHA from a specific branch.
+ */
+async function getLatestCommit(owner, repo, branch = "main") {
+  const url = `https://api.github.com/repos/${owner}/${repo}/commits/${branch}`;
+  const json = await fetchJson(url);
+
+  const sha = json.sha;
+  const dateStr = json.commit?.committer?.date || json.commit?.author?.date;
+
+  if (!sha || !dateStr) {
+    console.log(json);
+    throw new Error(`Missing SHA or date for ${owner}/${repo}@${branch}`);
+  }
+
+  return {
+    owner,
+    repo,
+    branch,
+    sha,
+    date: new Date(dateStr).toISOString()
+  };
+}
+
+/**
+ * Get latest commit SHA from all branches and pick the latest.
+ */
+async function getLatestCommitAcrossBranches(owner, repo) {
+  const branches = await fetchJson(`https://api.github.com/repos/${owner}/${repo}/branches`);
+
+  const commits = await Promise.all(
+    branches.map(async ({ name, commit }) => {
+      const commitSha = commit?.sha;
+      if (!commitSha) {
+        console.warn(`No commit SHA for '${owner}/${repo}' branch: ${name}`);
+        return { branch: name, sha: "", date: new Date(0) };
+      }
+
+      try {
+        const commitData = await fetchJson(`https://api.github.com/repos/${owner}/${repo}/commits/${commitSha}`);
+        const dateStr = commitData.commit?.committer?.date || commitData.commit?.author?.date;
+        const date = dateStr ? new Date(dateStr) : new Date(0);
+        return { branch: name, sha: commitData.sha, date };
+      } catch (e) {
+        console.warn(`Failed to fetch commit for ${name}: ${e.message}`);
+        return { branch: name, sha: commitSha, date: new Date(0) };
+      }
+    })
+  );
+
+  const latest = commits.reduce((a, b) => (a.date > b.date ? a : b), { date: new Date(0) });
+
+  return {
+    owner,
+    repo,
+    branch: latest.branch,
+    sha: latest.sha,
+    date: latest.date.toISOString()
+  };
+}
+
+/**
+ * Replace the branch or commit in a GitHub raw URL with the latest hash.
+ */
+function replaceRawWithLatestHash(url, latestHash) {
+  const match = url.match(/^https:\/\/github\.com\/([^/]+)\/([^/]+)\/raw\/([^/]+)\/(.+)$/);
+  if (!match) throw new Error("Invalid GitHub raw URL");
+
+  const [, owner, repo, _oldHash, path] = match;
+  return `https://github.com/${owner}/${repo}/raw/${latestHash}/${path}`;
+}
+
+/**
+ * Parse GitHub URLs and extract owner, repo, branch, and original URL.
+ */
+function parseGitHubUrl(url) {
+  const ghRepoRoot = /^https:\/\/github\.com\/([^/]+)\/([^/]+)\/?$/;
+  const ghTreeOrBlob = /^https:\/\/github\.com\/([^/]+)\/([^/]+)\/(tree|blob)\/([^/]+(?:\/[^/]+)*)/;
+  const ghRaw = /^https:\/\/raw\.githubusercontent\.com\/([^/]+)\/([^/]+)\/([^/]+)(\/.+)?$/;
+  const ghDotComRaw = /^https:\/\/github\.com\/([^/]+)\/([^/]+)\/raw\/([^/]+)\/.+/;
+
+  let match;
+
+  if ((match = url.match(ghRaw))) {
+    const [, owner, repo, branch] = match;
+    return { owner, repo, branch, url };
+  }
+
+  if ((match = url.match(ghDotComRaw))) {
+    const [, owner, repo, branch] = match;
+    return { owner, repo, branch, url };
+  }
+
+  if ((match = url.match(ghTreeOrBlob))) {
+    const [, owner, repo, , branchPath] = match;
+    return { owner, repo, branch: branchPath, url };
+  }
+
+  if ((match = url.match(ghRepoRoot))) {
+    const [, owner, repo] = match;
+    return { owner, repo, url };
+  }
+
+  throw new Error(`Unsupported GitHub URL: ${url}`);
+}
+
+// --- Main logic ---
+(async () => {
+  const entries = Object.entries(pkg.resolutions || {});
+  if (entries.length === 0) {
+    console.log(ansiColors.yellow("No resolutions found in package.json"));
+    return;
+  }
+  console.log(`Processing ${entries.length} resolution(s)...`);
+  const updates = [];
+  for (const [currentPkgName, url] of entries) {
+    // Validate if URL is a GitHub URL
+    let repo;
+    try {
+      repo = parseGitHubUrl(url);
+      console.log(`✅ Valid GitHub URL for ${ansiColors.cyan(currentPkgName)}: ${url}`);
+    } catch (error) {
+      console.log(`⏭️  Skipping ${ansiColors.yellow(currentPkgName)}: ${error.message}`);
+      continue;
+    }
+    try {
+      const override = specialPackageOverrides.find((p) => p.pkg === currentPkgName);
+      const latest = override
+        ? await getLatestCommit(override.owner, override.repo, override.branch)
+        : await getLatestCommitAcrossBranches(repo.owner, repo.repo);
+      const new_url = replaceRawWithLatestHash(url, latest.sha);
+      updates.push({
+        currentPkgName,
+        url,
+        new_url,
+        repo,
+        latest
+      });
+    } catch (error) {
+      console.log(`❌ Failed to process ${ansiColors.red(currentPkgName)}: ${error.message}`);
+    }
+  }
+  if (updates.length === 0) {
+    console.log(ansiColors.yellow("No GitHub URLs were processed"));
+    return;
+  }
+  console.log(`\n📝 Applying updates to ${updates.length} GitHub URL(s)...`);
+  let changed = false;
+  for (const { currentPkgName, url, new_url, repo, latest } of updates) {
+    if (url !== new_url) {
+      console.log(`\n${ansiColors.cyan(currentPkgName)}:`);
+      console.log("  from:", url.replace(repo.branch, ansiColors.red(repo.branch)));
+      console.log("    to:", new_url.replace(latest.sha, ansiColors.green(latest.sha)));
+      pkg.resolutions[currentPkgName] = new_url;
+      changed = true;
+    } else {
+      console.log(`\n${ansiColors.cyan(currentPkgName)}: ${ansiColors.gray("already up-to-date")}`);
+    }
+  }
+  if (changed) {
+    try {
+      fs.writeFileSync(pkgPath, JSON.stringify(pkg, null, 2) + "\n");
+      console.log(`\n✅ package.json updated successfully`);
+    } catch (e) {
+      console.error(ansiColors.red(`Failed to write package.json: ${e.message}`));
+      process.exit(1);
+    }
+  } else {
+    console.log(ansiColors.green("No changes to package.json were necessary."));
+  }
+})();