create-guardio 0.0.7 → 0.0.9

package/index.mjs

@@ -1,11 +1,22 @@
 #!/usr/bin/env node
 import { createInterface } from "node:readline";
-import { mkdir, writeFile } from "node:fs/promises";
-import { resolve, dirname } from "node:path";
+import { mkdir, writeFile, mkdtemp } from "node:fs/promises";
+import { createWriteStream } from "node:fs";
+import { readdirSync, cpSync, existsSync } from "node:fs";
+import { resolve, dirname, join } from "node:path";
 import { fileURLToPath } from "node:url";
+import { pipeline } from "node:stream/promises";
+import { tmpdir } from "node:os";
+import { spawnSync } from "node:child_process";
+import decompress from "decompress";
 
 const __dirname = dirname(fileURLToPath(import.meta.url));
 
+const DASHBOARD_REPO =
+  process.env.GUARDIO_DASHBOARD_REPO || "radoslaw-sz/guardio";
+const DASHBOARD_BRANCH = process.env.GUARDIO_DASHBOARD_BRANCH || "main";
+const DASHBOARD_TARBALL_URL = `https://github.com/${DASHBOARD_REPO}/archive/refs/heads/${DASHBOARD_BRANCH}.tar.gz`;
+
 const rl = createInterface({ input: process.stdin, output: process.stdout });
 
 function ask(question, defaultAnswer = "") {
@@ -27,46 +38,83 @@ function askYesNo(question, defaultAnswer = "n") {
   );
 }
 
+async function setupDashboardFromTarball(guardioPath) {
+  const dashboardPath = join(guardioPath, "dashboard");
+  console.log("Downloading dashboard from GitHub...");
+  let res;
+  try {
+    res = await fetch(DASHBOARD_TARBALL_URL, { redirect: "follow" });
+  } catch (err) {
+    console.error(
+      "Could not download dashboard template. Check network and GUARDIO_DASHBOARD_REPO.",
+    );
+    throw err;
+  }
+  if (!res.ok) {
+    throw new Error(
+      `Dashboard download failed: ${res.status} ${res.statusText}. Check repo (${DASHBOARD_REPO}) and branch (${DASHBOARD_BRANCH}).`,
+    );
+  }
+  const tmpDir = await mkdtemp(join(tmpdir(), "guardio-dashboard-"));
+  const tarPath = join(tmpDir, "archive.tar.gz");
+  const w = createWriteStream(tarPath);
+  await pipeline(res.body, w);
+  console.log("Extracting...");
+  const extractDir = join(tmpDir, "extract");
+  await mkdir(extractDir, { recursive: true });
+  await decompress(tarPath, extractDir);
+  const topLevel = readdirSync(extractDir)[0];
+  if (!topLevel) {
+    throw new Error("Dashboard tarball had no top-level directory.");
+  }
+  const srcDashboard = join(extractDir, topLevel, "packages", "dashboard");
+  if (!existsSync(srcDashboard)) {
+    throw new Error(
+      "Dashboard tarball missing packages/dashboard. Wrong repo or branch?",
+    );
+  }
+  await mkdir(dashboardPath, { recursive: true });
+  cpSync(srcDashboard, dashboardPath, { recursive: true });
+  console.log("Installing dashboard dependencies...");
+  const installResult = spawnSync(
+    "pnpm",
+    ["install"],
+    { cwd: dashboardPath, stdio: "inherit", shell: true },
+  );
+  if (installResult.status !== 0) {
+    const npmResult = spawnSync(
+      "npm",
+      ["install"],
+      { cwd: dashboardPath, stdio: "inherit", shell: true },
+    );
+    if (npmResult.status !== 0) {
+      throw new Error("Failed to install dashboard dependencies (tried pnpm and npm).");
+    }
+  }
+}
+
 async function main() {
   console.log("\nCreate Guardio\n");
 
-  const guardioDir = await ask("Guardio directory", "./mcp-server-gated");
+  const guardioDir = await ask("Guardio directory", "guardio-project");
   const guardioPath = resolve(process.cwd(), guardioDir);
 
-  // Servers: at least one, with name + URL
-  const servers = [];
-  let serverName = await ask("First MCP server name", "default");
-  let serverUrl = await ask("MCP server URL", "https://example.com/mcp");
-  servers.push({ name: serverName, type: "url", url: serverUrl });
-
-  while (await askYesNo("Add another MCP server?", "n")) {
-    serverName = await ask("MCP server name", "server-" + (servers.length + 1));
-    serverUrl = await ask("MCP server URL", "https://example.com/mcp");
-    servers.push({ name: serverName, type: "url", url: serverUrl });
-  }
-
   const portStr = await ask("Guardio HTTP server port", "3939");
   const port = parseInt(portStr, 10) || 3939;
 
-  const installDashboard = await askYesNo("Install dashboard?", "n");
+  const useStorage = await askYesNo(
+    "Use storage and events (for dashboard / policy state)?",
+    "n",
+  );
+
+  // All built-in policy plugins by default
+  const plugins = [
+    { type: "policy", name: "deny-tool-access" },
+    { type: "policy", name: "deny-regex-parameter" },
+  ];
 
-  // Built-in plugins: by category
-  console.log("\nPolicy plugins:");
-  console.log("  1) none");
-  console.log("  2) deny-tool-access");
-  console.log("  3) regex");
-  console.log("  4) both");
-  const policyChoice = await ask("Policy plugins (1-4)", "1");
-  const policyNum = parseInt(policyChoice, 10) || 1;
-  const policyPlugins = [];
-  if (policyNum === 2 || policyNum === 4) policyPlugins.push({ type: "policy", name: "deny-tool-access" });
-  if (policyNum === 3 || policyNum === 4) policyPlugins.push({ type: "policy", name: "regex" });
-
-  const useStorage = await askYesNo("Use storage and events (for dashboard / policy state)?", installDashboard ? "y" : "n");
-
-  const plugins = [...policyPlugins];
   if (useStorage) {
-    console.log("  1) sqlite (local file)");
+    console.log("  1) sqlite (in-memory or file)");
     console.log("  2) postgres");
     const storageBackend = await ask("Storage backend (1-2)", "1");
     if (storageBackend === "2") {
@@ -79,20 +127,35 @@ async function main() {
       plugins.push({ type: "eventSink", name: "postgres" });
       plugins.push({ type: "eventSinkStore", name: "postgres" });
     } else {
-      const sqliteConfig = { database: "guardio.sqlite" };
+      const sqliteInMemory = await askYesNo(
+        "Use in-memory SQLite? (y = in-memory, n = file guardio.sqlite)",
+        "y",
+      );
+      const sqliteConfig = sqliteInMemory
+        ? { inMemory: true }
+        : { database: "guardio.sqlite" };
       plugins.push({ type: "storage", name: "sqlite", config: sqliteConfig });
       plugins.push({ type: "eventSink", name: "sqlite", config: sqliteConfig });
-      plugins.push({ type: "eventSinkStore", name: "sqlite", config: sqliteConfig });
+      plugins.push({
+        type: "eventSinkStore",
+        name: "sqlite",
+        config: sqliteConfig,
+      });
     }
   }
 
-  const addExamplePlugin = await askYesNo("Add example custom policy plugin?", "n");
+  const addExamplePlugin = await askYesNo(
+    "Add example custom policy plugin?",
+    "n",
+  );
   if (addExamplePlugin) {
     plugins.push({ type: "policy", name: "example", path: "./plugins/example" });
   }
 
+  const installDashboard = await askYesNo("Install dashboard?", "n");
+
   const config = {
-    servers,
+    servers: [],
     client: { port, host: "127.0.0.1" },
     plugins,
   };
@@ -117,8 +180,7 @@ async function main() {
     },
   };
   if (installDashboard) {
-    packageJson.dependencies["@guardiojs/dashboard"] = "*";
-    packageJson.scripts.dashboard = "guardio-dashboard";
+    packageJson.scripts.dashboard = "cd dashboard && npm run dev";
   }
   await writeFile(
     resolve(guardioPath, "package.json"),
@@ -126,6 +188,10 @@ async function main() {
     "utf-8",
   );
 
+  if (installDashboard) {
+    await setupDashboardFromTarball(guardioPath);
+  }
+
   const tsconfig = {
     compilerOptions: {
       target: "ES2022",
@@ -145,6 +211,9 @@ async function main() {
 
   const configTsContent = `import type { GuardioConfig } from "@guardiojs/guardio";
 
+// Example server (uncomment and add to servers array to proxy an MCP server):
+// { name: "nuvei-docs", type: "url", url: "https://mcp.nuvei.com/sse" }
+
 const config: GuardioConfig = ${JSON.stringify(config, null, 2).replace(/^/gm, "  ")};
 
 export default config;
@@ -171,9 +240,9 @@ export default config;
 class ExamplePolicyPlugin implements PolicyPluginInterface {
   readonly name = "example";
 
-  evaluate(context: PolicyRequestContext): PolicyResult {
+  async evaluate(context: PolicyRequestContext): Promise<PolicyResult> {
     // Example: allow all calls. Replace with your policy logic.
-    return { verdict: "allow" };
+    return Promise.resolve({ verdict: "allow" });
   }
 }
 
@@ -192,7 +261,7 @@ export default new ExamplePolicyPlugin();
 Add a plugin by setting \`path\` in \`guardio.config.ts\` to a directory that contains \`index.js\` or \`index.mjs\` (compile from \`index.ts\` with \`npm run build\`).
 
 - The directory must have \`index.js\` or \`index.mjs\` whose **default export is the plugin instance** (no descriptor).
-- Policy: implement \`PolicyPluginInterface\` (name, evaluate). Config: \`{ "type": "policy", "name": "my-policy", "path": "./plugins/my-policy" }\`.
+- Policy: implement \`PolicyPluginInterface\` (name, evaluate returning Promise<PolicyResult>). Config: \`{ "type": "policy", "name": "my-policy", "path": "./plugins/my-policy" }\`.
 
 Import types from "@guardiojs/guardio".${addExamplePlugin ? " See example/ for a policy plugin." : ""}
 `;
@@ -204,7 +273,10 @@ Import types from "@guardiojs/guardio".${addExamplePlugin ? " See example/ for a
 
   console.log("\n---\n");
   console.log("Next steps");
-  console.log("  cd " + guardioDir + " && npm install");
+  console.log("  cd " + guardioDir);
+  console.log(
+    "  npm install   # or: pnpm install, yarn, bun install, etc.",
+  );
   if (addExamplePlugin) {
     console.log("  npm run build   # compile plugins (index.ts → index.js)");
   }
@@ -213,9 +285,9 @@ Import types from "@guardiojs/guardio".${addExamplePlugin ? " See example/ for a
   console.log("  npm run guardio");
   console.log("");
   if (installDashboard) {
-    console.log("Run dashboard (point it at Guardio URL):");
-    console.log("  npm run dashboard");
-    console.log("  # Dashboard needs Guardio base URL, e.g. http://127.0.0.1:" + port);
+    console.log("Run dashboard (standalone copy from GitHub; point at Guardio URL):");
+    console.log("  pnpm run dashboard   # or: npm run dashboard");
+    console.log("  # Guardio base URL: http://127.0.0.1:" + port);
     console.log("");
   }
   console.log("Add to MCP client (use URL):");

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-guardio",
-  "version": "0.0.7",
+  "version": "0.0.9",
   "description": "Scaffold a Guardio project",
   "type": "module",
   "bin": {
@@ -18,5 +18,8 @@
     "agents"
   ],
   "author": "Radoslaw Szymkiewicz",
-  "license": "Apache-2.0"
+  "license": "Apache-2.0",
+  "dependencies": {
+    "decompress": "^4.2.1"
+  }
 }