@flowriki/agent 0.1.0-beta.1

package/dist/cli.js

@@ -0,0 +1,225 @@
+#!/usr/bin/env node
+import {
+  AGENT_VERSION,
+  connect,
+  disconnect,
+  doctor,
+  resolveCheckouts,
+  start,
+  status
+} from "./chunk-ATOHKUGQ.js";
+
+// src/cli.ts
+import { parseArgs } from "util";
+process.on("warning", (warning) => {
+  if (warning.name === "ExperimentalWarning" && /SQLite/i.test(warning.message)) return;
+  console.warn(`${warning.name}: ${warning.message}`);
+});
+var paint = (code) => (s) => `\x1B[${code}m${s}\x1B[0m`;
+var bold = paint("1");
+var dim = paint("2");
+var red = paint("31");
+var green = paint("32");
+var yellow = paint("33");
+var HELP = `${bold("Flowriki agent")} ${dim(AGENT_VERSION)}
+
+Runs your Flowriki tests on this computer. The browser under test and your
+project files stay here.
+
+${bold("USAGE")}
+  flowriki-agent connect            connect this computer to your account
+  flowriki-agent start              run the agent (stays in the foreground)
+  flowriki-agent status             is it connected, and what is prepared
+  flowriki-agent doctor             diagnose setup problems
+  flowriki-agent disconnect         forget this computer's credential
+
+${bold("OPTIONS")}
+  --project <dir>        a checkout to serve; repeat for several.
+                         Remembered, so later runs need no arguments.
+  --name <label>         how this computer appears in your dashboard
+  --service <url>        advanced: a self-hosted Flowriki. Defaults to the
+                         hosted service, which is what you want.
+  --json                 machine-readable output for status and doctor
+  -h, --help             this
+  -v, --version          version
+
+${bold("NOTE")}
+  ${dim("`start` stays in the foreground. Closing the terminal stops the agent;")}
+  ${dim("nothing is installed as a background service.")}
+`;
+async function main(argv) {
+  let parsed;
+  try {
+    parsed = parseArgs({
+      args: argv,
+      allowPositionals: true,
+      options: {
+        project: { type: "string", multiple: true },
+        name: { type: "string" },
+        service: { type: "string" },
+        json: { type: "boolean" },
+        help: { type: "boolean", short: "h" },
+        version: { type: "boolean", short: "v" }
+      }
+    });
+  } catch (error) {
+    console.error(`${error.message}
+
+Run \`flowriki-agent --help\`.`);
+    return 2;
+  }
+  const { values, positionals } = parsed;
+  if (values.version) {
+    console.log(AGENT_VERSION);
+    return 0;
+  }
+  const command = positionals[0];
+  if (values.help || !command) {
+    console.log(HELP);
+    return values.help || !command ? 0 : 2;
+  }
+  const service = values.service ? String(values.service) : void 0;
+  const projects = (values.project ?? []).map(String);
+  switch (command) {
+    case "connect": {
+      const result = await connect({
+        ...service ? { service } : {},
+        ...values.name ? { machineName: String(values.name) } : {},
+        onProgress: (note) => {
+          if (note.kind !== "approve") return;
+          const url = String(note.detail?.["url"] ?? "");
+          console.log(`
+  ${bold("Approve this computer in your browser")}`);
+          console.log(`  ${url}
+`);
+          if (note.detail?.["canOpen"] === false) {
+            console.log(dim("  No graphical session here \u2014 open that link on a computer that has one.\n"));
+          } else {
+            console.log(dim("  Opening it for you. If nothing happens, use the link above.\n"));
+          }
+        }
+      });
+      if (!result.ok) {
+        console.error(`${red("could not connect")} \u2014 ${result.message}`);
+        return 1;
+      }
+      console.log(
+        result.reused ? `${green("already connected")} as ${bold(result.connection.machineName)}` : `${green("connected")} as ${bold(result.connection.machineName)}`
+      );
+      console.log(dim("  Next: flowriki-agent start"));
+      return 0;
+    }
+    case "start": {
+      const started = await start({
+        ...service ? { service } : {},
+        ...projects.length ? { projects } : {},
+        onProgress: (note) => {
+          if (note.kind === "skipped") {
+            for (const s of note.detail?.["skipped"] ?? []) {
+              console.error(yellow(`! skipped ${s.root} \u2014 ${s.why}`));
+            }
+          }
+          if (note.kind === "activity" && note.detail?.["kind"]) {
+            console.log(yellow(`  > ${note.detail["kind"]} \u2014 ${note.detail["detail"] ?? ""}`));
+          }
+        },
+        onStatus: (state, detail) => console.log(dim(`  ${state}${detail ? ` \u2014 ${detail}` : ""}`))
+      });
+      if (!started.ok) {
+        console.error(`${red(started.reason.replace(/-/g, " "))} \u2014 ${started.message}`);
+        if (started.reason === "not-connected") console.error(dim("  Run: flowriki-agent connect"));
+        return 1;
+      }
+      console.log(`${bold("Flowriki agent")} ${dim(AGENT_VERSION)}`);
+      console.log(dim(`  connected as ${started.connection.machineName}`));
+      if (started.projects.length === 0) {
+        console.log(yellow("  no projects prepared \u2014 this machine is online and idle"));
+        console.log(dim("  Add one:  flowriki-agent start --project /path/to/a/checkout"));
+      }
+      for (const project of started.projects) {
+        console.log(dim(`  project  ${project.name}  (${project.root})`));
+      }
+      console.log(dim("\n  Running in the foreground. Ctrl-C to stop.\n"));
+      let stopping = false;
+      const shutdown = async (signal) => {
+        if (stopping) return;
+        stopping = true;
+        console.log(dim(`
+  ${signal} \u2014 stopping`));
+        await started.stop();
+        process.exit(0);
+      };
+      process.on("SIGINT", () => void shutdown("SIGINT"));
+      process.on("SIGTERM", () => void shutdown("SIGTERM"));
+      return await new Promise(() => {
+      });
+    }
+    case "status": {
+      const state = status(service);
+      if (values.json) {
+        console.log(JSON.stringify(state, null, 2));
+        return 0;
+      }
+      console.log(`${bold("Flowriki agent")} ${dim(AGENT_VERSION)}`);
+      console.log(`  service   ${state.service}`);
+      console.log(
+        `  account   ${state.connected ? green(`connected as ${state.machineName}`) : yellow("not connected")}`
+      );
+      console.log(
+        `  process   ${state.running ? green(`running (pid ${state.running.pid})`) : dim("not running here")}`
+      );
+      if (state.checkouts.length === 0) console.log(dim("  projects  none prepared"));
+      for (const c of state.checkouts) {
+        console.log(
+          c.project ? `  project   ${c.project}  ${dim(c.root)}` : yellow(`  project   ${c.root} \u2014 ${c.why}`)
+        );
+      }
+      return state.connected ? 0 : 1;
+    }
+    case "doctor": {
+      const found = await doctor(service);
+      if (values.json) {
+        console.log(JSON.stringify(found, null, 2));
+        return found.problems.length ? 1 : 0;
+      }
+      console.log(`${bold("Flowriki agent")} ${dim(found.agentVersion)}`);
+      console.log(`  node       ${found.node}  ${dim(`${found.platform}/${found.arch}`)}`);
+      console.log(`  protocol   ${found.protocolVersion}`);
+      console.log(`  data       ${found.dataDir}`);
+      console.log(`  service    ${found.service}  ${found.reachable ? green("reachable") : red("unreachable")}`);
+      console.log(`  credential ${found.credentialFingerprint ?? dim("none stored")}`);
+      console.log(
+        `  browsers   ${found.playwright.chromiumInstalled ? green("chromium ready") : yellow("chromium not installed")}  ${dim(found.playwright.browsersPath ?? "")}`
+      );
+      for (const problem of found.problems) console.log(red(`  ! ${problem}`));
+      return found.problems.length ? 1 : 0;
+    }
+    case "disconnect": {
+      const gone = disconnect(service);
+      console.log(
+        gone.ok ? `${green("disconnected")} from ${gone.service}` : yellow(`nothing stored for ${gone.service}`)
+      );
+      if (gone.ok) {
+        console.log(dim("  The device stays listed in your dashboard until you revoke it there."));
+      }
+      return 0;
+    }
+    case "projects": {
+      const { projects: found, skipped } = resolveCheckouts(projects.length ? projects : [process.cwd()]);
+      for (const p of found) console.log(`  ${p.name}  ${dim(p.root)}`);
+      for (const s of skipped) console.log(yellow(`  ${s.root} \u2014 ${s.why}`));
+      return found.length ? 0 : 1;
+    }
+    default:
+      console.error(`unknown command: ${command}
+
+Run \`flowriki-agent --help\`.`);
+      return 2;
+  }
+}
+main(process.argv.slice(2)).then((code) => {
+  if (code !== 0) process.exitCode = code;
+}).catch((error) => {
+  console.error(red(error.message));
+  process.exitCode = 1;
+});

package/dist/engine.js

@@ -0,0 +1,19 @@
+#!/usr/bin/env node
+import {
+  AGENT_VERSION,
+  connect,
+  disconnect,
+  doctor,
+  resolveCheckouts,
+  start,
+  status
+} from "./chunk-ATOHKUGQ.js";
+export {
+  AGENT_VERSION,
+  connect,
+  disconnect,
+  doctor,
+  resolveCheckouts,
+  start,
+  status
+};

package/package.json

@@ -0,0 +1,52 @@
+{
+  "name": "@flowriki/agent",
+  "version": "0.1.0-beta.1",
+  "description": "Run Flowriki UI tests on your own computer. Connects this machine to your Flowriki account.",
+  "license": "SEE LICENSE IN LICENSE",
+  "type": "module",
+  "bin": {
+    "flowriki-agent": "dist/cli.js"
+  },
+  "main": "./dist/engine.js",
+  "exports": {
+    ".": "./dist/engine.js",
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE"
+  ],
+  "engines": {
+    "node": ">=22.13"
+  },
+  "os": [
+    "darwin",
+    "linux",
+    "win32"
+  ],
+  "cpu": [
+    "x64",
+    "arm64"
+  ],
+  "dependencies": {
+    "playwright": "1.63.0",
+    "ws": "^8.21.3",
+    "zod": "^3.24.1"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Muhammad-Safiullah/flowriki.git",
+    "directory": "packages/agent-npm"
+  },
+  "keywords": [
+    "flowriki",
+    "e2e",
+    "testing",
+    "playwright",
+    "agent"
+  ],
+  "publishConfig": {
+    "access": "public"
+  }
+}