flowstride 1.0.9 → 1.0.11

package/README.md

@@ -24,29 +24,49 @@ Flowstride requires Node.js 18 or higher.
 **1. Install globally (or as a dev dependency in your project):**
 
 ```bash
-npm install -g flowstride
+npm i flowstride --save-dev
 ```
 
 **2. Initialize a new Flowstride workspace:**
 
 ```bash
-flowstride init
+npx flowstride init
 ```
 
 _(This creates the default directory structure (`/flows`, `/reports`, `/plugins`) and generates a `example.flow` sample file.)_
 
-**3. Run your first test:**
+**3. Install VS Code Extension (Highly Recommended):**
+
+To get the best developer experience, including syntax highlighting, auto-completion, and native IDE support for .flow files, install our official VS Code extension directly via the VS Code CLI.
+
+Run the command below:
+
+```bash
+code --install-extension flowstride.flowstride-vscode
+```
+
+_Alternatively, you can open the Extensions tab in VS Code and search for Flowstride Automation_
+
+**4. Run your first test:**
 
 ```bash
-flowstride run
+npx flowstride run
 
 OR
 
-flowstride run flows/example.flow
+npx flowstride run flows/example.flow
 ```
 
 _(This command executes your test while instantly booting up the local Flowstride Dashboard.)_
 
+**5. Login to Flowstride Cloud:**
+
+Authenticate your local project with your Cloud account to unlock Cloud features after signing up at [cloud.flowstride.io](https://cloud.flowstride.io).
+
+```bash
+npx flowstride login
+```
+
 ---
 
 ## Privacy & Data Security

package/dist/cli/index.js

@@ -45,6 +45,7 @@ const fs = __importStar(require("fs"));
 const path = __importStar(require("path"));
 const os = __importStar(require("os"));
 const tar = __importStar(require("tar"));
+const child_process_1 = require("child_process");
 const prompts_1 = require("@inquirer/prompts");
 const chalk_1 = __importDefault(require("chalk"));
 const ora_1 = __importDefault(require("ora"));
@@ -53,7 +54,7 @@ const API_BASE = process.env.FLOWSTRIDE_API_URL || "https://cloud.flowstride.io"
 program
     .name("flowstride")
     .description("Flowstride: The Enterprise Flow-First Automation CLI")
-    .version("1.0.9");
+    .version("1.0.11");
 program
     .command("init")
     .description("Initialise a new Flowstride workspace in the current directory")
@@ -154,20 +155,20 @@ program
                             cwd: nodeModulesPath,
                             strip: 1,
                         });
+                        installSpinner.text = "Wiring up Enterprise dependencies...";
+                        (0, child_process_1.execSync)("npm install --omit=dev", {
+                            cwd: nodeModulesPath,
+                            stdio: "ignore",
+                        });
                         installSpinner.succeed(chalk_1.default.green("Enterprise Engine installed successfully!"));
                     }
                     catch (installError) {
                         installSpinner.stop();
-                        // ==========================================
-                        // TEMPORARY DEBUG LOG TO UNMASK THE ERROR
-                        // ==========================================
                         console.error(chalk_1.default.bgRed.white("\n[RAW SYSTEM ERROR]:"), installError);
-                        // ==========================================
                         console.log(chalk_1.default.red("\n✖ Failed to install the Enterprise Engine. Please check your internet connection or verify your project configuration."));
                         if (fs.existsSync(nodeModulesPath)) {
                             fs.rmSync(nodeModulesPath, { recursive: true, force: true });
                         }
-                        // THE FIX: Strict Rollback on Failure
                         console.log(chalk_1.default.yellow("⚠️ Reverting login: Enterprise Engine is required to sync."));
                         if (fs.existsSync(credentialsPath))
                             fs.unlinkSync(credentialsPath);
@@ -180,7 +181,6 @@ program
                     }
                 }
                 else {
-                    // THE FIX: Strict Rollback on Decline
                     console.log(chalk_1.default.yellow(`\n⚠️ Installation skipped.`));
                     console.log(chalk_1.default.red(`✖ Reverting login: You must install the Enterprise Engine to sync this workspace.`));
                     if (fs.existsSync(credentialsPath))
@@ -189,7 +189,6 @@ program
                 }
             }
         }
-        // Only print this if the engine was successfully verified or installed
         console.log(chalk_1.default.bold.green(`\n✅ Machine synchronized with Flowstride Enterprise.`));
     }
     catch (error) {
@@ -211,7 +210,6 @@ program
         }
         catch (err) { }
     }
-    // THE FIX: Defensive Self-Healing. If login exists but engine is missing, drop to OS.
     if (!process.env.FLOWSTRIDE_API_KEY &&
         token &&
         !fs.existsSync(nodeModulesPath)) {
@@ -252,13 +250,17 @@ program
     }
 });
 program
-    .command("run")
+    .command("run [targetPath]")
     .description("Execute all .flow automation journeys in the ./flows directory")
     .option("-b, --bail", "Stop execution on first failure", false)
     .option("--headed", "Run browser in headed mode", false)
     .option("--headless <boolean>", "Run browser in headless mode", (val) => val === "true", true)
     .option("--workers <number>", "Number of parallel workers to spawn (Pro feature)")
-    .action(async (options) => {
+    .action(async (targetPath, options) => {
+    if (typeof targetPath === "object") {
+        options = targetPath;
+        targetPath = undefined;
+    }
     let token = process.env.FLOWSTRIDE_API_KEY || null;
     let forceOS = false;
     const credentialsPath = path.join(process.cwd(), ".flowstride", "login", "login.json");
@@ -270,7 +272,6 @@ program
         }
         catch (err) { }
     }
-    // THE FIX: Defensive Self-Healing
     if (!process.env.FLOWSTRIDE_API_KEY &&
         token &&
         !fs.existsSync(nodeModulesPath)) {
@@ -315,13 +316,13 @@ program
     if (options.headed) {
         options.headless = false;
     }
-    const strictUiFlowsDir = path.resolve(process.cwd(), "./flows");
+    const resolvedTargetPath = targetPath ? targetPath : "./flows";
+    const strictUiFlowsDir = path.resolve(process.cwd(), resolvedTargetPath);
     if (!fs.existsSync(strictUiFlowsDir)) {
         console.error(`\n[ERROR]: Could not find ${strictUiFlowsDir}.`);
-        console.error(`Flowstride requires all UI tests to be inside a './flows' directory.`);
+        console.error(`Flowstride requires all UI tests to be inside a valid directory.`);
         process.exit(1);
     }
-    // Inject our DRM state into options before passing to runner
     options.forceOS = forceOS;
     await (0, run_1.runAction)(strictUiFlowsDir, options);
 });
@@ -329,7 +330,7 @@ async function handleOfflinePrompt() {
     console.log(chalk_1.default.yellow("🛜 OFFLINE: Unable to reach Flowstride Cloud. Enterprise Sync paused."));
     if (process.env.CI || process.env.FLOWSTRIDE_API_KEY) {
         console.log(chalk_1.default.yellow("⚠️ CI/CD Environment: Automatically falling back to OS Engine."));
-        return true; // Force OS
+        return true;
     }
     const runAnyway = await (0, prompts_1.confirm)({
         message: "⚠️ Execute a local OS run anyway? (Pro features are disabled on OS)",
@@ -338,7 +339,7 @@ async function handleOfflinePrompt() {
     if (!runAnyway) {
         process.exit(0);
     }
-    return true; // User said yes, Force OS
+    return true;
 }
 program
     .command("report")

package/dist/reporting/pdf_generator.d.ts

@@ -0,0 +1,4 @@
+export declare class PdfGenerator {
+    generateTestcasePdf(data: any, customOutputPath?: string): Promise<string>;
+    private generateReportHtml;
+}

package/dist/reporting/pdf_generator.js

@@ -0,0 +1,187 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PdfGenerator = void 0;
+const fs = __importStar(require("fs"));
+const path = __importStar(require("path"));
+const playwright_1 = require("playwright");
+class PdfGenerator {
+    async generateTestcasePdf(data, customOutputPath) {
+        let outputDir = "";
+        if (customOutputPath) {
+            outputDir = customOutputPath;
+            if (!fs.existsSync(outputDir)) {
+                fs.mkdirSync(outputDir, { recursive: true });
+            }
+        }
+        else {
+            outputDir = path.join(process.cwd(), ".flowstride", "artifacts");
+            if (!fs.existsSync(outputDir)) {
+                fs.mkdirSync(outputDir, { recursive: true });
+            }
+        }
+        const fileName = `Flowstride_Test_Log_${Date.now()}.pdf`;
+        const pdfPath = path.join(outputDir, fileName);
+        const htmlContent = this.generateReportHtml(data);
+        const browser = await playwright_1.chromium.launch({ headless: true });
+        const page = await browser.newPage();
+        await page.setContent(htmlContent, { waitUntil: "networkidle" });
+        await page.pdf({
+            path: pdfPath,
+            format: "A4",
+            printBackground: true,
+            margin: { top: "30px", right: "30px", bottom: "30px", left: "30px" },
+        });
+        await browser.close();
+        return pdfPath;
+    }
+    generateReportHtml(data) {
+        let scenariosToProcess = [];
+        if (data && data.files && Array.isArray(data.files)) {
+            data.files.forEach((fileObj) => {
+                if (fileObj.scenarios && Array.isArray(fileObj.scenarios)) {
+                    scenariosToProcess.push(...fileObj.scenarios);
+                }
+            });
+        }
+        else if (Array.isArray(data)) {
+            scenariosToProcess = data;
+        }
+        const groupedScenarios = {};
+        scenariosToProcess.forEach((scenario) => {
+            const key = scenario.fileName || "General";
+            if (!groupedScenarios[key])
+                groupedScenarios[key] = [];
+            groupedScenarios[key].push(scenario);
+        });
+        let totalSteps = 0;
+        let passedSteps = 0;
+        let failedSteps = 0;
+        let tablesHtml = "";
+        for (const [fileName, fileScenarios] of Object.entries(groupedScenarios)) {
+            const flatSteps = fileScenarios.flatMap((s) => s.steps || []);
+            let fileRows = "";
+            flatSteps.forEach((step, idx) => {
+                totalSteps++;
+                const status = (step.status || "PENDING").toUpperCase();
+                const isSuccess = status === "PASS" || status === "PASSED" || status === "SUCCESS";
+                const isFail = status === "FAILED" || status === "FAIL";
+                if (isSuccess)
+                    passedSteps++;
+                else if (isFail)
+                    failedSteps++;
+                const color = isSuccess ? "#10b981" : isFail ? "#ef4444" : "#64748b";
+                const actualResultText = isFail
+                    ? "Validation Failed"
+                    : "Action verified successfully.";
+                const actualResultColor = isFail ? "#ef4444" : "#64748b";
+                fileRows += `
+          <tr>
+            <td style="padding: 16px 14px; border-bottom: 1px solid #e2e8f0; color: #64748b; font-weight: 500; width: 50px;">${idx + 1}</td>
+            <td style="padding: 16px 14px; border-bottom: 1px solid #e2e8f0; font-weight: 700; color: #1e293b;">${step.command || "action"}</td>
+            <td style="padding: 16px 14px; border-bottom: 1px solid #e2e8f0; color: #475569; font-style: italic;">${step.type || ""} ${step.description || "-"}</td>
+            <td style="padding: 16px 14px; border-bottom: 1px solid #e2e8f0; color: ${actualResultColor};">${actualResultText}</td>
+            <td style="padding: 16px 14px; border-bottom: 1px solid #e2e8f0; font-weight: 900; font-size: 10px; color: ${color};">${status}</td>
+          </tr>
+        `;
+            });
+            tablesHtml += `
+        <div class="file-separator">
+          <span>📄 ${fileName.toUpperCase()}</span>
+        </div>
+        <table>
+          <thead>
+            <tr>
+              <th>S/N</th>
+              <th>Action</th>
+              <th>Expected Result</th>
+              <th>Actual Result</th>
+              <th>Status</th>
+            </tr>
+          </thead>
+          <tbody>
+            ${fileRows || '<tr><td colspan="5" style="text-align:center;padding:20px;color:#64748b;">No test steps recorded.</td></tr>'}
+          </tbody>
+        </table>
+      `;
+        }
+        return `
+      <!DOCTYPE html>
+      <html>
+      <head>
+        <style>
+          body { font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, Helvetica, Arial, sans-serif; padding: 20px; color: #1e293b; }
+          .header { border-bottom: 4px solid #0f172a; padding-bottom: 24px; margin-bottom: 40px; }
+          .title { font-size: 36px; font-weight: 900; text-transform: uppercase; margin: 0 0 8px 0; color: #0f172a; }
+          .subtitle { font-size: 14px; color: #64748b; font-weight: 500; margin: 0; }
+          .summary { display: flex; gap: 15px; margin-bottom: 20px; }
+          .stat-box { padding: 15px; border-radius: 8px; background: #f8fafc; flex: 1; text-align: center; border: 1px solid #e2e8f0; }
+          .stat-value { font-size: 22px; font-weight: bold; }
+          
+          .file-separator { text-align: center; margin: 50px 0 20px 0; border-bottom: 1px solid rgba(124, 58, 237, 0.3); line-height: 0.1em; }
+          .file-separator span { background: #fff; padding: 0 15px; color: #7c3aed; font-weight: 900; font-size: 11px; letter-spacing: 0.1em; }
+          
+          table { width: 100%; border-collapse: collapse; border: 1px solid #e2e8f0; border-radius: 8px; overflow: hidden; font-size: 13px; }
+          th { background: #0f172a; color: white; text-align: left; padding: 14px; font-weight: 600; font-size: 11px; }
+        </style>
+      </head>
+      <body>
+        <div class="header">
+          <h1 class="title">Test Case Log</h1>
+          <p class="subtitle">Project: Flowstride Community Edition</p>
+        </div>
+        <div class="summary">
+          <div class="stat-box">
+            <div class="stat-value" style="color: #1e293b;">${totalSteps}</div>
+            <div style="font-size:10px;color:#64748b;text-transform:uppercase;margin-top:4px;font-weight:700;">Total Steps</div>
+          </div>
+          <div class="stat-box">
+            <div class="stat-value" style="color:#10b981;">${passedSteps}</div>
+            <div style="font-size:10px;color:#64748b;text-transform:uppercase;margin-top:4px;font-weight:700;">Passed</div>
+          </div>
+          <div class="stat-box">
+            <div class="stat-value" style="color:#ef4444;">${failedSteps}</div>
+            <div style="font-size:10px;color:#64748b;text-transform:uppercase;margin-top:4px;font-weight:700;">Failed</div>
+          </div>
+        </div>
+        
+        ${tablesHtml}
+
+      </body>
+      </html>
+    `;
+    }
+}
+exports.PdfGenerator = PdfGenerator;

package/dist/runner/flow_orchestrator.d.ts

@@ -8,8 +8,10 @@ export declare class FlowOrchestrator {
     private httpServer;
     private globalTestScenarios;
     private stepStatusRegistry;
+    private pdfGenerator;
     constructor(worker: FlowWorker, workerCount?: number, config?: FlowstrideConfig | undefined);
     private forwardToDashboard;
     private executeTestRun;
     start(targetPath: string): Promise<void>;
+    private handleExportPdfRequest;
 }

package/dist/runner/flow_orchestrator.js

@@ -41,7 +41,9 @@ const fs = __importStar(require("fs"));
 const path = __importStar(require("path"));
 const http = __importStar(require("http"));
 const chalk_1 = __importDefault(require("chalk"));
+const ora_1 = __importDefault(require("ora"));
 const ws_1 = require("ws");
+const pdf_generator_1 = require("../reporting/pdf_generator");
 class FlowOrchestrator {
     worker;
     workerCount;
@@ -50,10 +52,12 @@ class FlowOrchestrator {
     httpServer = null;
     globalTestScenarios = [];
     stepStatusRegistry = new Map();
+    pdfGenerator;
     constructor(worker, workerCount = 1, config) {
         this.worker = worker;
         this.workerCount = workerCount;
         this.config = config;
+        this.pdfGenerator = new pdf_generator_1.PdfGenerator();
         this.worker.on("worker_event", (data) => {
             this.forwardToDashboard(data.type, data.payload);
         });
@@ -221,14 +225,28 @@ class FlowOrchestrator {
                 ws.on("message", async (message) => {
                     const data = JSON.parse(message.toString());
                     if (data.type === "EXPORT_PDF_REQ") {
-                        console.log(chalk_1.default.magenta(`\n[Notice]: Exporting high-fidelity PDF reports is a Flowstride Enterprise feature.`));
-                        console.log(chalk_1.default.magenta(`[Notice]: Visit flowstride.io to upgrade and unlock advanced reporting.\n`));
+                        let scenariosToExport = data.payload || [];
+                        if (scenariosToExport.length === 0) {
+                            scenariosToExport = this.globalTestScenarios;
+                        }
+                        await this.handleExportPdfRequest(scenariosToExport);
                     }
                     else if (data.type === "REPLAY_REQ") {
                         await this.worker.handleReplayRequest(data.payload);
                     }
                     else if (data.type === "RERUN_REQ") {
-                        await this.executeTestRun(targetPath);
+                        const requestedFile = data.payload?.filePath;
+                        let specificTarget = targetPath;
+                        if (requestedFile) {
+                            const targetStat = fs.statSync(targetPath);
+                            if (targetStat.isDirectory()) {
+                                specificTarget = path.join(targetPath, requestedFile);
+                            }
+                            else {
+                                specificTarget = path.join(path.dirname(targetPath), requestedFile);
+                            }
+                        }
+                        await this.executeTestRun(specificTarget);
                     }
                     else if (data.type === "STOP_REQ") {
                         console.log(chalk_1.default.yellow("\nReceived STOP signal from Dashboard. Halting execution..."));
@@ -265,5 +283,21 @@ class FlowOrchestrator {
             throw e;
         }
     }
+    async handleExportPdfRequest(testScenariosFromUI) {
+        try {
+            const spinner = (0, ora_1.default)(chalk_1.default.blue("Compiling high-fidelity PDF report...")).start();
+            const pdfPath = await this.pdfGenerator.generateTestcasePdf(testScenariosFromUI);
+            // Convert the saved PDF to base64 to trigger the native browser download UI
+            const pdfBuffer = fs.readFileSync(pdfPath);
+            const base64Data = pdfBuffer.toString("base64");
+            this.forwardToDashboard("EXPORT_PDF_RES", { base64: base64Data });
+            this.forwardToDashboard("EXPORT_PDF_SUCCESS", { path: pdfPath });
+            spinner.succeed(chalk_1.default.green(`PDF Exported Successfully: ${pdfPath}`));
+        }
+        catch (e) {
+            console.error(chalk_1.default.red(`\n[Report Error]: Failed to generate PDF - ${e.message}`));
+            this.forwardToDashboard("EXPORT_PDF_ERROR", { error: e.message });
+        }
+    }
 }
 exports.FlowOrchestrator = FlowOrchestrator;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "flowstride",
-  "version": "1.0.9",
+  "version": "1.0.11",
   "description": "An opensource flowfirst test automation framework",
   "workspaces": [
     "packages/flowstride_report"