ortoni-report 2.0.9 → 3.0.0

package/dist/cli/cli.mjs

@@ -4,11 +4,12 @@ import {
   __require,
   __toESM,
   startReportServer
-} from "../chunk-RHM5OWYN.mjs";
+} from "../chunk-DW4XGLAZ.mjs";
 
 // node_modules/commander/lib/error.js
 var require_error = __commonJS({
   "node_modules/commander/lib/error.js"(exports) {
+    "use strict";
     var CommanderError2 = class extends Error {
       /**
        * Constructs the CommanderError class
@@ -44,6 +45,7 @@ var require_error = __commonJS({
 // node_modules/commander/lib/argument.js
 var require_argument = __commonJS({
   "node_modules/commander/lib/argument.js"(exports) {
+    "use strict";
     var { InvalidArgumentError: InvalidArgumentError2 } = require_error();
     var Argument2 = class {
       /**
@@ -171,6 +173,7 @@ var require_argument = __commonJS({
 // node_modules/commander/lib/help.js
 var require_help = __commonJS({
   "node_modules/commander/lib/help.js"(exports) {
+    "use strict";
     var { humanReadableArgName } = require_argument();
     var Help2 = class {
       constructor() {
@@ -247,8 +250,7 @@ var require_help = __commonJS({
        * @returns {Option[]}
        */
       visibleGlobalOptions(cmd) {
-        if (!this.showGlobalOptions)
-          return [];
+        if (!this.showGlobalOptions) return [];
         const globalOptions = [];
         for (let ancestorCmd = cmd.parent; ancestorCmd; ancestorCmd = ancestorCmd.parent) {
           const visibleOptions = ancestorCmd.options.filter(
@@ -559,11 +561,9 @@ var require_help = __commonJS({
       wrap(str, width, indent, minColumnWidth = 40) {
         const indents = " \\f\\t\\v\xA0\u1680\u2000-\u200A\u202F\u205F\u3000\uFEFF";
         const manualIndent = new RegExp(`[\\n][${indents}]+`);
-        if (str.match(manualIndent))
-          return str;
+        if (str.match(manualIndent)) return str;
         const columnWidth = width - indent;
-        if (columnWidth < minColumnWidth)
-          return str;
+        if (columnWidth < minColumnWidth) return str;
         const leadingStr = str.slice(0, indent);
         const columnText = str.slice(indent).replace("\r\n", "\n");
         const indentString = " ".repeat(indent);
@@ -576,8 +576,7 @@ var require_help = __commonJS({
         );
         const lines = columnText.match(regex) || [];
         return leadingStr + lines.map((line, i) => {
-          if (line === "\n")
-            return "";
+          if (line === "\n") return "";
           return (i > 0 ? indentString : "") + line.trimEnd();
         }).join("\n");
       }
@@ -589,6 +588,7 @@ var require_help = __commonJS({
 // node_modules/commander/lib/option.js
 var require_option = __commonJS({
   "node_modules/commander/lib/option.js"(exports) {
+    "use strict";
     var { InvalidArgumentError: InvalidArgumentError2 } = require_error();
     var Option2 = class {
       /**
@@ -829,8 +829,7 @@ var require_option = __commonJS({
        */
       valueFromOption(value, option) {
         const optionKey = option.attributeName();
-        if (!this.dualOptions.has(optionKey))
-          return true;
+        if (!this.dualOptions.has(optionKey)) return true;
         const preset = this.negativeOptions.get(optionKey).presetArg;
         const negativeValue = preset !== void 0 ? preset : false;
         return option.negate === (negativeValue === value);
@@ -862,6 +861,7 @@ var require_option = __commonJS({
 // node_modules/commander/lib/suggestSimilar.js
 var require_suggestSimilar = __commonJS({
   "node_modules/commander/lib/suggestSimilar.js"(exports) {
+    "use strict";
     var maxDistance = 3;
     function editDistance(a, b) {
       if (Math.abs(a.length - b.length) > maxDistance)
@@ -897,8 +897,7 @@ var require_suggestSimilar = __commonJS({
       return d[a.length][b.length];
     }
     function suggestSimilar(word, candidates) {
-      if (!candidates || candidates.length === 0)
-        return "";
+      if (!candidates || candidates.length === 0) return "";
       candidates = Array.from(new Set(candidates));
       const searchingOptions = word.startsWith("--");
       if (searchingOptions) {
@@ -909,8 +908,7 @@ var require_suggestSimilar = __commonJS({
       let bestDistance = maxDistance;
       const minSimilarity = 0.4;
       candidates.forEach((candidate) => {
-        if (candidate.length <= 1)
-          return;
+        if (candidate.length <= 1) return;
         const distance = editDistance(word, candidate);
         const length = Math.max(word.length, candidate.length);
         const similarity = (length - distance) / length;
@@ -944,17 +942,18 @@ var require_suggestSimilar = __commonJS({
 // node_modules/commander/lib/command.js
 var require_command = __commonJS({
   "node_modules/commander/lib/command.js"(exports) {
-    var EventEmitter = __require("events").EventEmitter;
-    var childProcess = __require("child_process");
-    var path2 = __require("path");
-    var fs2 = __require("fs");
-    var process2 = __require("process");
+    "use strict";
+    var EventEmitter = __require("node:events").EventEmitter;
+    var childProcess = __require("node:child_process");
+    var path2 = __require("node:path");
+    var fs2 = __require("node:fs");
+    var process2 = __require("node:process");
     var { Argument: Argument2, humanReadableArgName } = require_argument();
     var { CommanderError: CommanderError2 } = require_error();
     var { Help: Help2 } = require_help();
     var { Option: Option2, DualOptions } = require_option();
     var { suggestSimilar } = require_suggestSimilar();
-    var Command2 = class extends EventEmitter {
+    var Command2 = class _Command extends EventEmitter {
       /**
        * Initialize a new `Command`.
        *
@@ -1077,17 +1076,14 @@ var require_command = __commonJS({
           cmd.description(desc);
           cmd._executableHandler = true;
         }
-        if (opts.isDefault)
-          this._defaultCommandName = cmd._name;
+        if (opts.isDefault) this._defaultCommandName = cmd._name;
         cmd._hidden = !!(opts.noHelp || opts.hidden);
         cmd._executableFile = opts.executableFile || null;
-        if (args)
-          cmd.arguments(args);
+        if (args) cmd.arguments(args);
         this._registerCommand(cmd);
         cmd.parent = this;
         cmd.copyInheritedSettings(this);
-        if (desc)
-          return this;
+        if (desc) return this;
         return cmd;
       }
       /**
@@ -1100,7 +1096,7 @@ var require_command = __commonJS({
        * @return {Command} new command
        */
       createCommand(name) {
-        return new Command2(name);
+        return new _Command(name);
       }
       /**
        * You can customise the help with a subclass of Help by overriding createHelp,
@@ -1119,8 +1115,7 @@ var require_command = __commonJS({
        * @return {(Command | object)} `this` command for chaining, or stored configuration
        */
       configureHelp(configuration) {
-        if (configuration === void 0)
-          return this._helpConfiguration;
+        if (configuration === void 0) return this._helpConfiguration;
         this._helpConfiguration = configuration;
         return this;
       }
@@ -1143,8 +1138,7 @@ var require_command = __commonJS({
        * @return {(Command | object)} `this` command for chaining, or stored configuration
        */
       configureOutput(configuration) {
-        if (configuration === void 0)
-          return this._outputConfiguration;
+        if (configuration === void 0) return this._outputConfiguration;
         Object.assign(this._outputConfiguration, configuration);
         return this;
       }
@@ -1155,8 +1149,7 @@ var require_command = __commonJS({
        * @return {Command} `this` command for chaining
        */
       showHelpAfterError(displayHelp = true) {
-        if (typeof displayHelp !== "string")
-          displayHelp = !!displayHelp;
+        if (typeof displayHelp !== "string") displayHelp = !!displayHelp;
         this._showHelpAfterError = displayHelp;
         return this;
       }
@@ -1185,10 +1178,8 @@ var require_command = __commonJS({
 - specify the name in Command constructor or using .name()`);
         }
         opts = opts || {};
-        if (opts.isDefault)
-          this._defaultCommandName = cmd._name;
-        if (opts.noHelp || opts.hidden)
-          cmd._hidden = true;
+        if (opts.isDefault) this._defaultCommandName = cmd._name;
+        if (opts.noHelp || opts.hidden) cmd._hidden = true;
         this._registerCommand(cmd);
         cmd.parent = this;
         cmd._checkForBrokenPassThrough();
@@ -1294,10 +1285,8 @@ var require_command = __commonJS({
         const helpDescription = description ?? "display help for command";
         const helpCommand = this.createCommand(helpName);
         helpCommand.helpOption(false);
-        if (helpArgs)
-          helpCommand.arguments(helpArgs);
-        if (helpDescription)
-          helpCommand.description(helpDescription);
+        if (helpArgs) helpCommand.arguments(helpArgs);
+        if (helpDescription) helpCommand.description(helpDescription);
         this._addImplicitHelpCommand = true;
         this._helpCommand = helpCommand;
         return this;
@@ -1890,15 +1879,12 @@ Expecting one of '${allowedValues.join("', '")}'`);
         const sourceExt = [".js", ".ts", ".tsx", ".mjs", ".cjs"];
         function findFile(baseDir, baseName) {
           const localBin = path2.resolve(baseDir, baseName);
-          if (fs2.existsSync(localBin))
-            return localBin;
-          if (sourceExt.includes(path2.extname(baseName)))
-            return void 0;
+          if (fs2.existsSync(localBin)) return localBin;
+          if (sourceExt.includes(path2.extname(baseName))) return void 0;
           const foundExt = sourceExt.find(
             (ext) => fs2.existsSync(`${localBin}${ext}`)
           );
-          if (foundExt)
-            return `${localBin}${foundExt}`;
+          if (foundExt) return `${localBin}${foundExt}`;
           return void 0;
         }
         this._checkForMissingMandatoryOptions();
@@ -2003,8 +1989,7 @@ Expecting one of '${allowedValues.join("', '")}'`);
        */
       _dispatchSubcommand(commandName, operands, unknown) {
         const subCommand = this._findCommand(commandName);
-        if (!subCommand)
-          this.help({ error: true });
+        if (!subCommand) this.help({ error: true });
         let promiseChain;
         promiseChain = this._chainOrCallSubCommandHook(
           promiseChain,
@@ -2247,8 +2232,7 @@ Expecting one of '${allowedValues.join("', '")}'`);
        * @return {Command | undefined}
        */
       _findCommand(name) {
-        if (!name)
-          return void 0;
+        if (!name) return void 0;
         return this.commands.find(
           (cmd) => cmd._name === name || cmd._aliases.includes(name)
         );
@@ -2341,8 +2325,7 @@ Expecting one of '${allowedValues.join("', '")}'`);
         while (args.length) {
           const arg = args.shift();
           if (arg === "--") {
-            if (dest === unknown)
-              dest.push(arg);
+            if (dest === unknown) dest.push(arg);
             dest.push(...args);
             break;
           }
@@ -2356,8 +2339,7 @@ Expecting one of '${allowedValues.join("', '")}'`);
             if (option) {
               if (option.required) {
                 const value = args.shift();
-                if (value === void 0)
-                  this.optionMissingArgument(option);
+                if (value === void 0) this.optionMissingArgument(option);
                 this.emit(`option:${option.name()}`, value);
               } else if (option.optional) {
                 let value = null;
@@ -2398,25 +2380,21 @@ Expecting one of '${allowedValues.join("', '")}'`);
           if ((this._enablePositionalOptions || this._passThroughOptions) && operands.length === 0 && unknown.length === 0) {
             if (this._findCommand(arg)) {
               operands.push(arg);
-              if (args.length > 0)
-                unknown.push(...args);
+              if (args.length > 0) unknown.push(...args);
               break;
             } else if (this._getHelpCommand() && arg === this._getHelpCommand().name()) {
               operands.push(arg);
-              if (args.length > 0)
-                operands.push(...args);
+              if (args.length > 0) operands.push(...args);
               break;
             } else if (this._defaultCommandName) {
               unknown.push(arg);
-              if (args.length > 0)
-                unknown.push(...args);
+              if (args.length > 0) unknown.push(...args);
               break;
             }
           }
           if (this._passThroughOptions) {
             dest.push(arg);
-            if (args.length > 0)
-              dest.push(...args);
+            if (args.length > 0) dest.push(...args);
             break;
           }
           dest.push(arg);
@@ -2595,8 +2573,7 @@ Expecting one of '${allowedValues.join("', '")}'`);
        * @private
        */
       unknownOption(flag) {
-        if (this._allowUnknownOption)
-          return;
+        if (this._allowUnknownOption) return;
         let suggestion = "";
         if (flag.startsWith("--") && this._showSuggestionAfterError) {
           let candidateFlags = [];
@@ -2618,8 +2595,7 @@ Expecting one of '${allowedValues.join("', '")}'`);
        * @private
        */
       _excessArguments(receivedArgs) {
-        if (this._allowExcessArguments)
-          return;
+        if (this._allowExcessArguments) return;
         const expected = this.registeredArguments.length;
         const s = expected === 1 ? "" : "s";
         const forSubcommand = this.parent ? ` for '${this.name()}'` : "";
@@ -2638,8 +2614,7 @@ Expecting one of '${allowedValues.join("', '")}'`);
           const candidateNames = [];
           this.createHelp().visibleCommands(this).forEach((command) => {
             candidateNames.push(command.name());
-            if (command.alias())
-              candidateNames.push(command.alias());
+            if (command.alias()) candidateNames.push(command.alias());
           });
           suggestion = suggestSimilar(unknownName, candidateNames);
         }
@@ -2659,8 +2634,7 @@ Expecting one of '${allowedValues.join("', '")}'`);
        * @return {(this | string | undefined)} `this` command for chaining, or version string if no arguments
        */
       version(str, flags, description) {
-        if (str === void 0)
-          return this._version;
+        if (str === void 0) return this._version;
         this._version = str;
         flags = flags || "-V, --version";
         description = description || "output the version number";
@@ -2697,8 +2671,7 @@ Expecting one of '${allowedValues.join("', '")}'`);
        * @return {(string|Command)}
        */
       summary(str) {
-        if (str === void 0)
-          return this._summary;
+        if (str === void 0) return this._summary;
         this._summary = str;
         return this;
       }
@@ -2711,8 +2684,7 @@ Expecting one of '${allowedValues.join("', '")}'`);
        * @return {(string|Command)}
        */
       alias(alias) {
-        if (alias === void 0)
-          return this._aliases[0];
+        if (alias === void 0) return this._aliases[0];
         let command = this;
         if (this.commands.length !== 0 && this.commands[this.commands.length - 1]._executableHandler) {
           command = this.commands[this.commands.length - 1];
@@ -2738,8 +2710,7 @@ Expecting one of '${allowedValues.join("', '")}'`);
        * @return {(string[]|Command)}
        */
       aliases(aliases) {
-        if (aliases === void 0)
-          return this._aliases;
+        if (aliases === void 0) return this._aliases;
         aliases.forEach((alias) => this.alias(alias));
         return this;
       }
@@ -2751,8 +2722,7 @@ Expecting one of '${allowedValues.join("', '")}'`);
        */
       usage(str) {
         if (str === void 0) {
-          if (this._usage)
-            return this._usage;
+          if (this._usage) return this._usage;
           const args = this.registeredArguments.map((arg) => {
             return humanReadableArgName(arg);
           });
@@ -2772,8 +2742,7 @@ Expecting one of '${allowedValues.join("', '")}'`);
        * @return {(string|Command)}
        */
       name(str) {
-        if (str === void 0)
-          return this._name;
+        if (str === void 0) return this._name;
         this._name = str;
         return this;
       }
@@ -2805,8 +2774,7 @@ Expecting one of '${allowedValues.join("', '")}'`);
        * @return {(string|null|Command)}
        */
       executableDir(path3) {
-        if (path3 === void 0)
-          return this._executableDir;
+        if (path3 === void 0) return this._executableDir;
         this._executableDir = path3;
         return this;
       }
@@ -3018,6 +2986,7 @@ Expecting one of '${allowedValues.join("', '")}'`);
 // node_modules/commander/index.js
 var require_commander = __commonJS({
   "node_modules/commander/index.js"(exports) {
+    "use strict";
     var { Argument: Argument2 } = require_argument();
     var { Command: Command2 } = require_command();
     var { CommanderError: CommanderError2, InvalidArgumentError: InvalidArgumentError2 } = require_error();

package/dist/ortoni-report.d.mts

@@ -0,0 +1,114 @@
+import { Reporter, FullConfig, Suite, TestCase, TestResult, TestError, FullResult } from '@playwright/test/reporter';
+
+/**
+ * Configuration options for OrtoniReport.
+ */
+interface OrtoniReportConfig {
+    /**
+     * Open the report in local host (Trace viewer is accessible only in localhost)
+     * @example "always"| "never"| "on-failure";
+     * @default "never"
+     */
+    open?: "always" | "never" | "on-failure";
+    /**
+     * The title of the HTML report.
+     * @example "Ortoni Playwright Test Report"
+     */
+    title?: string;
+    /**
+     * Add project on the list of the tests? (Filtering projects still works if hidden)
+     * @example true to display, false to hide.
+     * @default false
+     */
+    showProject?: boolean;
+    /**
+     * The name of the project.
+     * @example "Ortoni Project"
+     */
+    projectName?: string;
+    /**
+     * The name of the author.
+     * @example "Koushik Chatterjee"
+     */
+    authorName?: string;
+    /**
+     * The type of tests being run.
+     * @example "Regression"
+     */
+    testType?: string;
+    /**
+     * The preferred theme for the report.
+     * Can be either "light" or "dark".
+     * @default "System theme"
+     * @example "dark"
+     */
+    preferredTheme?: "light" | "dark";
+    /**
+     * If true, images will be encoded in base64.
+     * @default false
+     * @example true
+     */
+    base64Image?: boolean;
+    /**
+     * The local relative of the logo image.
+     * Recommended to keep within the ${folderPath} folder
+     * @example "folderPath/logo.png"
+     */
+    logo?: string;
+    /**
+     * The filename to the html report.
+     * @example "index.html"
+     * @default "ortoni-report.html"
+     */
+    filename?: string;
+    /**
+     * The folder name.
+     * @example "report"
+     * @default "ortoni-report"
+     */
+    folderPath?: string;
+    /**
+     * Port to connect
+     * @example 3600
+     */
+    port?: number;
+    /**
+     * Display console logs?
+     * @example boolean
+     * @default true
+     */
+    stdIO?: boolean;
+    /**
+     * Metadata for the report. ['TestCycle': 'Cycle 1', 'TestEnvironment':'QA', etc]
+     * @example { "key": "value" } as string
+     */
+    meta?: Record<string, string>;
+}
+
+declare class OrtoniReport implements Reporter {
+    private ortoniConfig;
+    private testResultProcessor;
+    private htmlGenerator;
+    private fileManager;
+    private serverManager;
+    private results;
+    private projectSet;
+    private overAllStatus;
+    private folderPath;
+    private outputFilename;
+    private outputPath;
+    private dbManager;
+    private shouldGenerateReport;
+    private showConsoleLogs;
+    constructor(ortoniConfig?: OrtoniReportConfig);
+    private reportsCount;
+    onBegin(config: FullConfig, _suite: Suite): Promise<void>;
+    onStdOut(chunk: string | Buffer, _test: void | TestCase, _result: void | TestResult): void;
+    onTestEnd(test: TestCase, result: TestResult): void;
+    printsToStdio(): boolean;
+    onError(error: TestError): void;
+    onEnd(result: FullResult): Promise<void>;
+    onExit(): Promise<void>;
+}
+
+export { OrtoniReport, type OrtoniReportConfig, OrtoniReport as default };