muagqa 1.0.0

package/README.md

@@ -0,0 +1,18 @@
+# 🧪 MuagQA CLI  
+**Generate, pull, and record Playwright test scripts using one-time session tokens from MuagQA.**
+
+MuagQA CLI simplifies automation by allowing testers to:
+- Regenerate test cases in the MuagQA dashboard  
+- Receive a **one-time session token**  
+- Run: `muagqa pull <token>`  
+- Automatically open **Playwright Codegen** for each test case  
+- Save recordings into `generated-tests/`
+
+---
+
+## 🚀 Installation
+
+Install globally:
+
+```bash
+npm install -g muagqa

package/bin/muagqa

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+import("../src/index.js");

package/package.json

@@ -0,0 +1,23 @@
+{
+  "name": "muagqa",
+  "version": "1.0.0",
+  "description": "MuagQA CLI — Test case runner with one-time session token and Playwright recorder",
+  "author": "Mary C.N. Enwezor",
+  "license": "MIT",
+  "type": "module",
+
+  "bin": {
+    "muagqa": "./bin/muagqa"
+  },
+
+  "dependencies": {
+    "axios": "^1.6.0",
+    "chalk": "^5.3.0",
+    "fs-extra": "^11.2.0",
+    "inquirer": "^9.2.7",
+    "node-fetch": "^3.3.2",
+    "ora": "^7.0.1",
+    "playwright": "^1.41.0",
+    "yargs": "^17.7.2"
+  }
+}

package/src/api.js

@@ -0,0 +1,15 @@
+import axios from "axios";
+import chalk from "chalk";
+
+export async function validateSessionToken(token) {
+  try {
+    const res = await axios.post("https://muagqa.vercel.app/api/cli/validate", {
+      token
+    });
+
+    return res.data;
+  } catch (err) {
+    console.log(chalk.red("\n❌ Failed to validate token.\n"));
+    throw err;
+  }
+}

package/src/fileManager.js

@@ -0,0 +1,5 @@
+import fs from "fs-extra";
+
+export function ensureFolder(path) {
+  fs.ensureDirSync(path);
+}

package/src/index.js

@@ -0,0 +1,21 @@
+#!/usr/bin/env node
+import inquirer from "inquirer";
+import chalk from "chalk";
+import run from "./runner.js";
+
+console.log(chalk.cyan.bold("\n🚀 MuagQA CLI — One-Time Test Case Recorder\n"));
+
+async function startCLI() {
+  const { token } = await inquirer.prompt([
+    {
+      type: "input",
+      name: "token",
+      message: "Enter your one-time session token:",
+      validate: v => v.trim() !== "" || "Token is required."
+    }
+  ]);
+
+  await run(token);
+}
+
+startCLI();

package/src/playwrightInstaller.js

@@ -0,0 +1,19 @@
+import { execSync } from "child_process";
+import chalk from "chalk";
+
+export function ensurePlaywrightInstalled() {
+  try {
+    execSync("npx playwright --version", { stdio: "ignore" });
+    return; // Already installed, nothing else to do
+  } catch (e) {
+    console.log(chalk.yellow("📦 Playwright not detected. Installing browsers..."));
+  }
+
+  try {
+    execSync("npx playwright install", { stdio: "inherit" });
+    console.log(chalk.green("✔ Playwright installation complete.\n"));
+  } catch (err) {
+    console.log(chalk.red("❌ Failed to install Playwright browsers."));
+    throw err;
+  }
+}

package/src/playwrightRunner.js

@@ -0,0 +1,20 @@
+import { exec } from "child_process";
+import chalk from "chalk";
+
+export function openCodegenForTest(testCase) {
+  return new Promise((resolve) => {
+    const outputPath = `./generated-tests/${testCase.id}.spec.ts`;
+
+    console.log(chalk.cyan(`\n▶ Recording: ${testCase.title}`));
+    console.log(chalk.gray(`Description: ${testCase.description}\n`));
+
+    const cmd = `npx playwright codegen ${testCase.startUrl || ""} --output=${outputPath}`;
+
+    const child = exec(cmd);
+
+    child.on("exit", () => {
+      console.log(chalk.green(`✔ Saved recording to ${outputPath}`));
+      resolve();
+    });
+  });
+}

package/src/runner.js

@@ -0,0 +1,48 @@
+import chalk from "chalk";
+import ora from "ora";
+import { validateSessionToken } from "./api.js";
+import { ensureFolder } from "./fileManager.js";
+import { openCodegenForTest } from "./playwrightRunner.js";
+import { ensurePlaywrightInstalled } from "./playwrightInstaller.js";
+
+
+export default async function run(token) {
+  const spinner = ora("Validating token...").start();
+
+  try {
+    const result = await validateSessionToken(token);
+
+    if (!result.success) {
+      spinner.fail("Invalid token.");
+      console.log(chalk.red(`\n❌ ${result.error}\n`));
+      return;
+    }
+
+    spinner.succeed("Token valid!");
+
+    const { testCases } = result;
+
+    if (!testCases || testCases.length === 0) {
+      console.log(chalk.red("\n⚠ No test cases found.\n"));
+      return;
+    }
+
+    console.log(chalk.green(`\n📌 ${testCases.length} test cases found.\n`));
+
+     await ensurePlaywrightInstalled();
+
+    ensureFolder("./generated-tests");
+
+    // sequentially open codegen for each test
+    for (const testCase of testCases) {
+      await openCodegenForTest(testCase);
+    }
+
+    console.log(chalk.green.bold("\n🎉 All test cases recorded successfully!\n"));
+    console.log(chalk.yellow("⚠ Token has now expired. Generate a new one for the next session.\n"));
+
+  } catch (err) {
+    spinner.fail("An error occurred.");
+    console.error(err);
+  }
+}