docdex 0.1.0

package/CHANGELOG.md

@@ -0,0 +1,6 @@
+# Changelog
+
+## 0.1.0
+- Initial npm scaffold for the Docdex CLI (`docdex`/`docdexd` bin).
+- Postinstall downloader to fetch platform-specific `docdexd` binaries.
+- Supports macOS (arm64/x64) and Linux (arm64/x64, gnu/musl auto-detect).

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 bekir dağ
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,28 @@
+# Docdex (npm)
+
+Install the Docdex CLI via npm:
+
+```bash
+npm i -g docdex
+# or
+npx docdex --version
+```
+
+Requirements:
+- Node.js >= 18
+- Supported platforms: macOS (arm64, x64), Linux glibc (arm64, x64). Musl (Alpine) is detected automatically when artifacts are available.
+
+How it works:
+- The package ships a small launcher (`docdex`/`docdexd`); `postinstall` downloads the correct `docdexd` binary for your platform from the GitHub release matching the npm package version.
+
+Environment overrides (optional):
+- `DOCDEX_DOWNLOAD_REPO` — `owner/repo` slug hosting release assets (required if `package.json` repository is still a placeholder).
+- `DOCDEX_DOWNLOAD_BASE` — full base URL for release downloads (defaults to `https://github.com/<repo>/releases/download`).
+- `DOCDEX_VERSION` — force a specific version/tag when testing.
+- `DOCDEX_LIBC` — force `gnu` or `musl` on Linux if auto-detection is wrong.
+- `DOCDEX_GITHUB_TOKEN` — token for authenticated GitHub downloads (avoids rate limits/private release issues).
+
+Notes:
+- Release assets are expected to be named `docdexd-<platform>.tar.gz` with a matching `.sha256`.
+- License: MIT (see `LICENSE`).
+- Changelog: see `CHANGELOG.md`.

package/bin/docdex.js

@@ -0,0 +1,29 @@
+#!/usr/bin/env node
+"use strict";
+
+const fs = require("node:fs");
+const path = require("node:path");
+const { spawn } = require("node:child_process");
+
+const { detectPlatformKey } = require("../lib/platform");
+
+function run() {
+  const platformKey = detectPlatformKey();
+  const binaryPath = path.join(__dirname, "..", "dist", platformKey, "docdexd");
+
+  if (!fs.existsSync(binaryPath)) {
+    console.error(
+      `[docdex] Missing binary for ${platformKey}. Try reinstalling or set DOCDEX_DOWNLOAD_REPO to a repo with release assets.`
+    );
+    process.exit(1);
+  }
+
+  const child = spawn(binaryPath, process.argv.slice(2), { stdio: "inherit" });
+  child.on("exit", (code) => process.exit(code ?? 1));
+  child.on("error", (err) => {
+    console.error(`[docdex] failed to launch binary: ${err.message}`);
+    process.exit(1);
+  });
+}
+
+run();

package/lib/install.js

@@ -0,0 +1,111 @@
+#!/usr/bin/env node
+"use strict";
+
+const fs = require("node:fs");
+const https = require("node:https");
+const os = require("node:os");
+const path = require("node:path");
+const { pipeline } = require("node:stream/promises");
+const tar = require("tar");
+
+const pkg = require("../package.json");
+const { artifactName, detectPlatformKey } = require("./platform");
+
+const MAX_REDIRECTS = 5;
+const USER_AGENT = "docdex-installer";
+const PLACEHOLDER_REPO_TOKEN = /OWNER|REPO/i;
+
+function parseRepoSlug() {
+  const envRepo = process.env.DOCDEX_DOWNLOAD_REPO;
+  if (envRepo) return envRepo;
+
+  const repoUrl = pkg.repository?.url || "";
+  const match = repoUrl.match(/github\.com[:/](.+?)(\.git)?$/);
+
+  if (match && match[1] && !PLACEHOLDER_REPO_TOKEN.test(match[1])) {
+    return match[1];
+  }
+
+  throw new Error("Set DOCDEX_DOWNLOAD_REPO env var or update package.json repository.url to owner/repo");
+}
+
+function getDownloadBase(repoSlug) {
+  return process.env.DOCDEX_DOWNLOAD_BASE || `https://github.com/${repoSlug}/releases/download`;
+}
+
+function getVersion() {
+  const envVersion = process.env.DOCDEX_VERSION;
+  const version = (envVersion || pkg.version || "").replace(/^v/, "");
+
+  if (!version) {
+    throw new Error("Missing package version; set DOCDEX_VERSION or package.json version");
+  }
+
+  return version;
+}
+
+function requestOptions() {
+  const headers = { "User-Agent": USER_AGENT };
+  const token = process.env.DOCDEX_GITHUB_TOKEN || process.env.GITHUB_TOKEN;
+  if (token) headers.Authorization = `Bearer ${token}`;
+  return { headers };
+}
+
+function download(url, dest, redirects = 0) {
+  if (redirects > MAX_REDIRECTS) {
+    throw new Error(`Too many redirects while fetching ${url}`);
+  }
+
+  return new Promise((resolve, reject) => {
+    https
+      .get(url, requestOptions(), (res) => {
+        if (res.statusCode && res.statusCode >= 300 && res.statusCode < 400 && res.headers.location) {
+          res.resume();
+          return download(res.headers.location, dest, redirects + 1).then(resolve, reject);
+        }
+
+        if (res.statusCode !== 200) {
+          res.resume();
+          return reject(new Error(`Download failed (${res.statusCode}) from ${url}`));
+        }
+
+        const file = fs.createWriteStream(dest);
+        pipeline(res, file).then(resolve).catch(reject);
+      })
+      .on("error", reject);
+  });
+}
+
+async function extractTarball(archivePath, targetDir) {
+  await fs.promises.mkdir(targetDir, { recursive: true });
+  await tar.x({ file: archivePath, cwd: targetDir, gzip: true });
+}
+
+async function main() {
+  const platformKey = detectPlatformKey();
+  const version = getVersion();
+  const repoSlug = parseRepoSlug();
+  const archive = artifactName(platformKey);
+  const downloadUrl = `${getDownloadBase(repoSlug)}/v${version}/${archive}`;
+  const distDir = path.join(__dirname, "..", "dist", platformKey);
+  const tmpFile = path.join(os.tmpdir(), `${archive}.${process.pid}.tgz`);
+
+  console.log(`[docdex] Fetching ${archive} for ${platformKey}...`);
+  await fs.promises.rm(distDir, { recursive: true, force: true });
+  await download(downloadUrl, tmpFile);
+  await extractTarball(tmpFile, distDir);
+
+  const binaryPath = path.join(distDir, "docdexd");
+  if (!fs.existsSync(binaryPath)) {
+    throw new Error(`Downloaded archive missing binary at ${binaryPath}`);
+  }
+
+  await fs.promises.chmod(binaryPath, 0o755).catch(() => {});
+  await fs.promises.rm(tmpFile, { force: true });
+  console.log(`[docdex] Installed binary to ${binaryPath}`);
+}
+
+main().catch((err) => {
+  console.error(`[docdex] install failed: ${err.message}`);
+  process.exit(1);
+});

package/lib/platform.js

@@ -0,0 +1,43 @@
+"use strict";
+
+function detectLibc() {
+  const override = process.env.DOCDEX_LIBC;
+  if (override) {
+    const libc = override.toLowerCase();
+    if (libc === "musl" || libc === "gnu") {
+      return libc;
+    }
+  }
+
+  const report = typeof process.report?.getReport === "function" ? process.report.getReport() : null;
+  const glibcVersion = report?.header?.glibcVersionRuntime;
+  return glibcVersion ? "gnu" : "musl";
+}
+
+function detectPlatformKey() {
+  const platform = process.platform;
+  const arch = process.arch;
+
+  if (platform === "darwin") {
+    if (arch === "arm64") return "darwin-arm64";
+    if (arch === "x64") return "darwin-x64";
+  }
+
+  if (platform === "linux") {
+    const libc = detectLibc();
+    if (arch === "arm64") return `linux-arm64-${libc}`;
+    if (arch === "x64") return `linux-x64-${libc}`;
+  }
+
+  throw new Error(`Unsupported platform: ${platform}/${arch}`);
+}
+
+function artifactName(platformKey) {
+  return `docdexd-${platformKey}.tar.gz`;
+}
+
+module.exports = {
+  detectLibc,
+  detectPlatformKey,
+  artifactName
+};

package/package.json

@@ -0,0 +1,51 @@
+{
+  "name": "docdex",
+  "version": "0.1.0",
+  "description": "Docdex CLI as an npm-installable binary wrapper.",
+  "bin": {
+    "docdex": "bin/docdex.js",
+    "docdexd": "bin/docdex.js"
+  },
+  "files": [
+    "bin",
+    "lib",
+    "README.md",
+    "CHANGELOG.md",
+    "LICENSE"
+  ],
+  "scripts": {
+    "postinstall": "node ./lib/install.js"
+  },
+  "engines": {
+    "node": ">=18"
+  },
+  "os": [
+    "darwin",
+    "linux"
+  ],
+  "cpu": [
+    "arm64",
+    "x64"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/bekirdag/docdex.git"
+  },
+  "bugs": {
+    "url": "https://github.com/bekirdag/docdex/issues"
+  },
+  "homepage": "https://github.com/bekirdag/docdex#readme",
+  "license": "MIT",
+  "author": "bekir dağ",
+  "keywords": [
+    "docdex",
+    "search",
+    "cli"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "tar": "^6.2.1"
+  }
+}