@woniru/we-installer 0.1.0

package/README.md

@@ -0,0 +1,107 @@
+# Woniru Engine Installer (WE)
+
+This repository contains the **public NPX installer** for **Woniru Engine (WE)**.
+
+The installer is intentionally small and public. It **does not** contain the engine source code.  
+Instead, it guides the user through GitHub authorization and then **downloads the private WE repository** (only if the user has access), installs dependencies, and launches a local configuration wizard.
+
+---
+
+## Quick Start
+
+Run the installer using NPX:
+
+```bash
+npx @woniru/we-installer
+```
+
+## What the Installer Does
+
+1. The installer performs the following steps:
+1. Opens a browser to authorize with GitHub using the Device Flow.
+1. Verifies that the user has collaborator access to the private Woniru Engine repository.
+1. Downloads the engine source code from the repository.
+1. Runs npm install in the project directory.
+1. Launches a local configuration wizard.
+
+## The configuration wizard guides the user through:
+
+### Step 1 — Redis Setup
+
+- Connect to an existing Redis instance, or
+
+- Automatically create a new Redis instance using Docker.
+
+### Step 2 — Database Configuration
+
+- Database host
+
+- Database user
+
+- Database password
+
+- Database name
+
+- Applies the WE schema to the database.
+
+### Step 3 — Admin Access
+
+- Creates the initial admin user.
+
+- Displays commands required to start the server.
+
+## Default Admin Credentials
+
+After installation completes, the default admin account is:
+
+**Username:** 
+``` 
+admin@we.com 
+```
+
+**Password:**
+``` 
+weAdmin 
+```
+
+These credentials can be changed after logging into the system.
+
+## Commands After Installation
+
+The installer provides two commands:
+
+**Start the server:** 
+```
+npm run dev --redisAdminKey=<your-admin-key>
+```
+
+**Recalculate user permissions:**
+```
+ npm run recalculate:user-permissions
+```
+
+The second command is only required if permissions need to be recalculated after changes.
+
+## Access Control
+
+This installer is public, but the **Woniru Engine repository is private**.
+
+If you are a collaborator on the repository, the installer will download the engine successfully.
+
+If you are not authorized, the installer will stop with an access error.
+
+## Requirements
+
+Before running the installer ensure the following are installed:
+
+**Node.js** version 18 or higher
+
+**npm** version 9 or higher
+
+**Docker Desktop** for running private redis instance
+
+Network access is required for:
+
+- GitHub
+- npm registry
+- your configured database server

package/bin/we-installer.js

@@ -0,0 +1,34 @@
+#!/usr/bin/env node
+
+const { runAuth } = require("../src/auth");
+const { runDownload } = require("../src/download");
+
+const command = process.argv[2];
+
+(async () => {
+	if (!command) {
+		console.log("Usage: we-installer <command>");
+		console.log("Commands:");
+		console.log("  auth       Authenticate with GitHub");
+		console.log("  install    Auth + download repo");
+		process.exit(0);
+	}
+
+	if (command === "auth") {
+		await runAuth();
+		return;
+	}
+
+	if (command === "install") {
+		const { token, user, ui } = await runAuth(); // make sure runAuth returns ui as well (see note below)
+		await runDownload({ token, ui });
+		console.log(`Done. Authenticated as ${user.login}.`);
+		return;
+	}
+
+	console.log(`Unknown command: ${command}`);
+	process.exit(1);
+})().catch((err) => {
+	console.error("Error:", err.message);
+	process.exit(1);
+});

package/package.json

@@ -0,0 +1,20 @@
+{
+	"name": "@woniru/we-installer",
+	"version": "0.1.0",
+	"private": false,
+	"type": "commonjs",
+	"bin": {
+		"we-installer": "./bin/we-installer.js"
+	},
+	"dependencies": {
+		"adm-zip": "^0.5.16",
+		"mysql2": "^3.18.2",
+		"open": "^11.0.0",
+		"redis": "^5.11.0"
+	},
+	"files": [
+		"bin",
+		"src",
+		"templates"
+	]
+}

package/src/auth.js

@@ -0,0 +1,87 @@
+// src/auth.js
+const { requestDeviceCode, pollForAccessToken } = require("./githubDeviceFlow");
+const { startAuthServer } = require("./authServer");
+const { getGithubUser } = require("./githubApi");
+
+function openBrowserNative(url) {
+	const { exec } = require("child_process");
+	const platform = process.platform;
+
+	// Best-effort open; no external deps
+	if (platform === "win32") exec(`start "" "${url}"`);
+	else if (platform === "darwin") exec(`open "${url}"`);
+	else exec(`xdg-open "${url}"`);
+}
+
+/**
+ * Auth flow:
+ * 1) Request device code
+ * 2) Start local server + open browser
+ * 3) Poll GitHub for access token
+ * 4) Fetch /user to confirm identity
+ * 5) Switch UI phase to "install" so the page shows Accept/Manual section
+ *
+ * Returns: { token, user, ui }
+ */
+async function runAuth() {
+	const clientId = 'Ov23lifTq8hC15zQcG4C';
+	if (!clientId) throw new Error("Missing env var WE_GITHUB_CLIENT_ID");
+
+	// Optional: allow overriding scope later; default is repo for private repo access
+	const scope = "repo";
+
+	console.log("Requesting GitHub device code...");
+	const device = await requestDeviceCode({ clientId, scope });
+
+	const ui = await startAuthServer({
+		verificationUri: device.verification_uri,
+		userCode: device.user_code
+	});
+
+	console.log("\nOpen this page to continue:");
+	console.log(ui.url + "\n");
+
+	// Best-effort open browser (user can still open manually from printed URL)
+	try { openBrowserNative(ui.url); } catch { }
+
+	// Phase: auth
+	ui.setPhase("auth");
+	ui.setStatus("Waiting for approval in GitHub…");
+
+	// Poll for access token
+	let token;
+	try {
+		token = await pollForAccessToken({
+			clientId,
+			deviceCode: device.device_code,
+			intervalSeconds: device.interval ?? 5,
+			expiresInSeconds: device.expires_in ?? 900
+		});
+	} catch (err) {
+		ui.setStatus(`Authorization failed ❌ ${err.message}`);
+		throw err;
+	}
+
+	// Verify identity
+	ui.setStatus("Authorized ✅ Verifying identity…");
+
+	let me;
+	try {
+		me = await getGithubUser({ token });
+	} catch (err) {
+		ui.setStatus(`Failed to verify identity ❌ ${err.message}`);
+		throw err;
+	}
+
+	ui.setUserLogin(me.login);
+	console.log(`✅ GitHub authentication successful as: ${me.login}`);
+
+	// ✅ THIS is the “one line” you were looking for:
+	// Move UI to install-choice phase so the page hides auth controls and shows Accept/Manual.
+	ui.setPhase("install");
+	ui.setStatus("Choose install location in the browser: Accept (use current directory) or Choose manually…");
+
+	return { token, user: me, ui };
+}
+
+module.exports = { runAuth };