ortoni-report 2.0.3 → 2.0.5

package/changelog.md

@@ -1,5 +1,33 @@
 # Change Log:
 
+## v2.0.5
+
+### 🚀 New Features
+- **Open report in localhost**: Introduced the ability to open the report on localhost with configurable options:
+  - `open?: "always" | "never" | "on-failure"`.
+- **Open Trace viewer within the same browser**: Added functionality to view the Playwright trace within the same browser tab, enhancing the user experience.
+
+### ✨ Improvements
+- **Perfect Test content UI**: Enhanced the UI of the test content for a more polished and user-friendly interface.
+- **Refactored code with multiple classes and utilities**: Codebase has been refactored for better organization, incorporating multiple classes and utilities to improve maintainability and scalability.
+
+## Version 2.0.4
+
+### 🚀 New Features
+- **Tags & Annotations**: Added support for tags and annotations, allowing for more detailed reporting and metadata.
+- **Project charts & summary UI**: Enhanced the user interface of project charts and the summary section for better presentation and usability.
+
+### ✨ Improvements
+
+- **Snippets color**: Improved the color scheme of code snippets for better readability.
+
+### 🛠 Fixes
+- **Console warning**: Resolved a console warning issue, improving overall stability.
+
+### Documentation
+- **Removed colors package**: Updated documentation to reflect the removal of the `colors` package.
+
+
 ## Version 2.0.3
 
 #### 🚀 New Features

package/dist/ortoni-report.d.ts

@@ -4,6 +4,12 @@ import { Reporter, FullConfig, Suite, TestCase, TestResult, FullResult } from '@
  * 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 "always"
+     */
+    open?: "always" | "never" | "on-failure";
     /**
      * The title of the HTML report.
      * @example "Ortoni Playwright Test Report"
@@ -12,6 +18,7 @@ interface OrtoniReportConfig {
     /**
     * 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;
     /**
@@ -21,7 +28,7 @@ interface OrtoniReportConfig {
     projectName?: string;
     /**
      * The name of the author.
-     * @example "John Doe"
+     * @example "Koushik Chatterjee"
      */
     authorName?: string;
     /**
@@ -43,69 +50,48 @@ interface OrtoniReportConfig {
      */
     base64Image?: boolean;
     /**
-     * The local relative or absolute path to the logo image.
-     * @example "./assets/logo.png"
-     * @example "/absolute/path/to/logo.png"
+     * 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 "playwright-report"
+    * @example "report"
+    * @default "ortoni-report"
     */
     folderPath?: string;
-}
-
-interface Steps {
-    snippet: string | undefined;
-    title: string;
-    location: string;
-}
-interface TestResultData {
-    suiteTags: string[];
-    testTags: string[];
-    location: string;
-    retry: string;
-    isRetry: number;
-    projectName: any;
-    suite: any;
-    title: string;
-    status: "passed" | "failed" | "timedOut" | "skipped" | "interrupted" | "expected" | "unexpected" | "flaky";
-    flaky: string;
-    duration: string;
-    errors: any[];
-    steps: Steps[];
-    logs: string;
-    screenshotPath?: string | null | undefined;
-    screenshots?: string[];
-    filePath: string;
-    filters: Set<string>;
-    tracePath?: string;
-    videoPath?: string;
-    base64Image: boolean | undefined;
+    /**
+    * Port to connect
+    * @example 3600
+    */
+    port?: number;
 }
 
 declare class OrtoniReport implements Reporter {
-    private projectRoot;
+    private ortoniConfig;
+    private testResultProcessor;
+    private htmlGenerator;
+    private fileManager;
+    private serverManager;
     private results;
-    private groupedResults;
-    private suiteName;
-    private config;
     private projectSet;
+    private overAllStatus;
     private folderPath;
-    constructor(config?: OrtoniReportConfig);
-    onBegin(config: FullConfig, suite: Suite): void;
-    onTestBegin(test: TestCase, result: TestResult): void;
+    private outputFilename;
+    private outputPath;
+    constructor(ortoniConfig?: OrtoniReportConfig);
+    onBegin(config: FullConfig, _suite: Suite): void;
+    onTestBegin(_test: TestCase, _result: TestResult): void;
     onTestEnd(test: TestCase, result: TestResult): void;
-    private attachFiles;
     onEnd(result: FullResult): void;
-    private registerPartial;
-    private groupResults;
-    generateHTML(filteredResults: TestResultData[], totalDuration: string, cssContent: string): string;
+    onExit(): Promise<void>;
 }
 
-export { OrtoniReportConfig, OrtoniReport as default };
+export { OrtoniReport, OrtoniReportConfig, OrtoniReport as default };