berkelium-studio 0.0.0-stage → 0.2.0

package/README.md

@@ -1,3 +1,24 @@
-# Temporary Holding Version
+# berkelium-studio
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+One command to install and open **Berkelium Studio**:
+
+```
+npx berkelium-studio
+```
+
+It downloads the installer for your computer from the official GitHub release, checks it against the
+release's `SHA256SUMS.txt`, and installs it:
+
+| System | What happens |
+|---|---|
+| macOS (Apple Silicon) | Copies Berkelium.app into Applications and opens it |
+| Windows 10/11 (64-bit) | Runs the Berkelium installer |
+| Linux (64-bit) | Saves the AppImage to `~/Applications` and starts it |
+
+Intel Macs are not supported. These builds are not notarized by Apple yet, so macOS may ask once on first
+launch: open **System Settings > Privacy & Security** and click **Open Anyway**.
+
+Options: `--download-only` (save the installer, do not install), `--version 0.2.0` (a specific release).
+
+This package contains no app code. It always installs the same tested files as the
+[Releases page](https://github.com/kmmohaimenulhaque-code/Berkelium-Neural-Rendering-Studio/releases).

package/bin/berkelium-studio.js

@@ -0,0 +1,172 @@
+#!/usr/bin/env node
+// berkelium-studio: download, verify and install Berkelium Studio.
+//
+// This package holds no app code on purpose. It fetches the installer from the
+// official GitHub release, checks it against SHA256SUMS.txt from the same
+// release, and installs it. So npx users get exactly the files the release
+// pipeline tested, and there is no second copy of the app to keep in sync.
+//
+// No dependencies: Node 18+ has fetch, and the rest is the standard library.
+
+"use strict";
+
+const crypto = require("crypto");
+const fs = require("fs");
+const os = require("os");
+const path = require("path");
+const { spawn, spawnSync } = require("child_process");
+const { Readable } = require("stream");
+const { pipeline } = require("stream/promises");
+
+const REPO = "kmmohaimenulhaque-code/Berkelium-Neural-Rendering-Studio";
+const API = `https://api.github.com/repos/${REPO}/releases`;
+
+const args = process.argv.slice(2);
+const downloadOnly = args.includes("--download-only");
+const versionArg = (() => {
+    const i = args.indexOf("--version");
+    return i >= 0 ? args[i + 1] : null;
+})();
+
+function die(message) {
+    console.error(`\nberkelium-studio: ${message}`);
+    process.exit(1);
+}
+
+// Which installer fits this computer. Matches the release file names.
+function target() {
+    const { platform, arch } = process;
+    if (platform === "darwin" && arch === "arm64") return { suffix: "-mac-arm64.dmg", kind: "mac" };
+    if (platform === "darwin") die("Intel Macs are not supported. Berkelium needs an Apple Silicon Mac (M1 or newer).");
+    if (platform === "win32" && arch === "x64") return { suffix: "-win-x64.exe", kind: "windows" };
+    if (platform === "linux" && arch === "x64") return { suffix: "-linux-x86_64.AppImage", kind: "linux" };
+    die(`no installer for ${platform} ${arch}. Supported: macOS Apple Silicon, Windows x64, Linux x64.`);
+}
+
+async function getJson(url) {
+    const r = await fetch(url, { headers: { "User-Agent": "berkelium-studio-installer", Accept: "application/vnd.github+json" } });
+    if (r.status === 404) die(versionArg ? `release v${versionArg} not found.` : "no published release found.");
+    if (r.status === 403) die("GitHub rate limit reached. Try again in a few minutes.");
+    if (!r.ok) die(`GitHub answered ${r.status} for ${url}`);
+    return r.json();
+}
+
+async function download(url, dest, label) {
+    const r = await fetch(url, { headers: { "User-Agent": "berkelium-studio-installer" }, redirect: "follow" });
+    if (!r.ok || !r.body) die(`download failed (${r.status}): ${url}`);
+    const total = Number(r.headers.get("content-length")) || 0;
+    let done = 0;
+    let lastShown = 0;
+    const counter = new (require("stream").Transform)({
+        transform(chunk, _enc, cb) {
+            done += chunk.length;
+            const now = Date.now();
+            if (process.stdout.isTTY && now - lastShown > 250) {
+                lastShown = now;
+                const pct = total ? ` ${Math.floor((done / total) * 100)}%` : "";
+                process.stdout.write(`\r  ${label}: ${(done / 1e6).toFixed(0)} MB${pct}   `);
+            }
+            cb(null, chunk);
+        },
+    });
+    await pipeline(Readable.fromWeb(r.body), counter, fs.createWriteStream(dest));
+    if (process.stdout.isTTY) process.stdout.write("\n");
+}
+
+function sha256(file) {
+    return new Promise((resolve, reject) => {
+        const h = crypto.createHash("sha256");
+        fs.createReadStream(file).on("data", (d) => h.update(d)).on("end", () => resolve(h.digest("hex"))).on("error", reject);
+    });
+}
+
+function run(cmd, cmdArgs, opts = {}) {
+    const r = spawnSync(cmd, cmdArgs, { stdio: "pipe", encoding: "utf-8", ...opts });
+    if (r.status !== 0) throw new Error(`${cmd} ${cmdArgs.join(" ")} failed: ${(r.stderr || r.stdout || "").trim()}`);
+    return r.stdout;
+}
+
+// macOS: mount the dmg, copy the app into Applications, unmount, open it.
+// A dmg this tool downloads itself is usually not marked "quarantined" the way
+// browser downloads are. A reused browser download keeps its mark, so macOS may
+// still ask once. We never remove that mark: it is the user's Gatekeeper decision.
+function installMac(dmg) {
+    const mount = fs.mkdtempSync(path.join(os.tmpdir(), "berkelium-dmg-"));
+    run("hdiutil", ["attach", dmg, "-nobrowse", "-readonly", "-mountpoint", mount]);
+    try {
+        const app = path.join(mount, "Berkelium.app");
+        if (!fs.existsSync(app)) throw new Error("Berkelium.app not found in the dmg");
+        let destDir = "/Applications";
+        try {
+            fs.accessSync(destDir, fs.constants.W_OK);
+        } catch {
+            destDir = path.join(os.homedir(), "Applications"); // no admin rights: install for this user only
+            fs.mkdirSync(destDir, { recursive: true });
+        }
+        const dest = path.join(destDir, "Berkelium.app");
+        spawnSync("osascript", ["-e", 'tell application "Berkelium" to quit'], { stdio: "ignore" });
+        fs.rmSync(dest, { recursive: true, force: true });
+        run("ditto", [app, dest]); // ditto keeps the code signature and permissions intact
+        console.log(`  Installed: ${dest}`);
+        return dest;
+    } finally {
+        spawnSync("hdiutil", ["detach", mount, "-quiet"], { stdio: "ignore" });
+    }
+}
+
+async function main() {
+    const t = target();
+    console.log("Berkelium Studio installer");
+    const release = await getJson(versionArg ? `${API}/tags/v${versionArg.replace(/^v/, "")}` : `${API}/latest`);
+    const asset = release.assets.find((a) => a.name.endsWith(t.suffix));
+    const sums = release.assets.find((a) => a.name === "SHA256SUMS.txt");
+    if (!asset) die(`release ${release.tag_name} has no file ending in ${t.suffix}`);
+    if (!sums) die(`release ${release.tag_name} has no SHA256SUMS.txt, so the download cannot be verified`);
+    console.log(`  Release: ${release.tag_name}`);
+
+    const dir = path.join(os.homedir(), "Downloads");
+    const destDir = fs.existsSync(dir) ? dir : os.tmpdir();
+    const file = path.join(destDir, asset.name);
+
+    const sumsText = await (await fetch(sums.browser_download_url, { headers: { "User-Agent": "berkelium-studio-installer" } })).text();
+    const expected = (sumsText.split("\n").map((l) => l.trim().split(/\s+/)).find(([, name]) => name === asset.name) || [])[0];
+    if (!expected) die(`${asset.name} is not listed in SHA256SUMS.txt`);
+
+    // Reuse a finished earlier download only if it still matches the checksum.
+    if (!(fs.existsSync(file) && (await sha256(file)) === expected)) {
+        await download(asset.browser_download_url, file + ".part", asset.name);
+        fs.renameSync(file + ".part", file);
+    }
+    const actual = await sha256(file);
+    if (actual !== expected) {
+        fs.rmSync(file, { force: true });
+        die(`checksum mismatch for ${asset.name}. The file was deleted. Try again.`);
+    }
+    console.log(`  Verified: SHA-256 matches the release (${expected.slice(0, 12)}...)`);
+
+    if (downloadOnly) {
+        console.log(`  Saved: ${file}`);
+        return;
+    }
+
+    if (t.kind === "mac") {
+        const app = installMac(file);
+        spawn("open", [app], { detached: true, stdio: "ignore" }).unref();
+        console.log("  Opening Berkelium...");
+    } else if (t.kind === "windows") {
+        console.log("  Starting the installer...");
+        spawn(file, [], { detached: true, stdio: "ignore" }).unref();
+    } else {
+        const appsDir = path.join(os.homedir(), "Applications");
+        fs.mkdirSync(appsDir, { recursive: true });
+        const dest = path.join(appsDir, "Berkelium.AppImage");
+        fs.copyFileSync(file, dest);
+        fs.chmodSync(dest, 0o755);
+        console.log(`  Installed: ${dest}`);
+        spawn(dest, [], { detached: true, stdio: "ignore" }).unref();
+        console.log("  Starting Berkelium...");
+    }
+    console.log("Done.");
+}
+
+main().catch((err) => die(err.message));

package/package.json

@@ -1,6 +1,35 @@
 {
   "name": "berkelium-studio",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.2.0",
+  "description": "Installs and opens Berkelium Studio, the neural rendering studio (3D viewport, code editor, free AI chat).",
+  "bin": {
+    "berkelium-studio": "bin/berkelium-studio.js"
+  },
+  "files": [
+    "bin/",
+    "README.md"
+  ],
+  "engines": {
+    "node": ">=18"
+  },
+  "os": [
+    "darwin",
+    "win32",
+    "linux"
+  ],
+  "keywords": [
+    "berkelium",
+    "3d",
+    "cad",
+    "neural-rendering",
+    "electron",
+    "installer"
+  ],
+  "author": "Team Berkelium",
+  "license": "SEE LICENSE IN https://github.com/kmmohaimenulhaque-code/Berkelium-Neural-Rendering-Studio/blob/main/LICENSE",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/kmmohaimenulhaque-code/Berkelium-Neural-Rendering-Studio.git"
+  },
+  "homepage": "https://github.com/kmmohaimenulhaque-code/Berkelium-Neural-Rendering-Studio"
+}