index.d.ts

import type { TestInfo } from "@playwright/test"
import type {
    CoverageReportOptions,
    ReportDescription,
    V8CoverageEntry,
    Watermarks,
    CoverageResults,
    CoverageSummary,
    MetricsSummary,
    CoverageFile,
    CoverageRange,
    AddedResults
} from "monocart-coverage-reports";

export type {
    TestInfo,

    CoverageReportOptions,
    ReportDescription,
    V8CoverageEntry,
    Watermarks,
    CoverageResults,
    CoverageSummary,
    MetricsSummary,
    CoverageFile,
    CoverageRange,
    AddedResults
}

export interface Helper {

    find: (callback: ((item: any, parent: any) => void)) => any;
    filter: (callback: ((item: any, parent: any) => void)) => any[];
    /** Traverse all cases, suites, and steps. */
    forEach: (callback: ((item: any, parent: any) => void | "break")) => void;

    /** send email with nodemailer: https://nodemailer.com/ */
    sendEmail: (emailOptions: {
        /** email transport: https://nodemailer.com/smtp/ */
        transport: any;
        /** email message: https://nodemailer.com/message/ */
        message: any;
    }) => Promise<void>;

}

export type MonocartReporterOptions = {
    /** logging levels: off, error, info, debug */
    logging?: string;

    /** the report name */
    name?: string;

    /** 
     * image url, supports data url:
     * `data:image/png;base64,${fs.readFileSync('path-to/your-logo.png').toString('base64')}`
    */
    logo?: string;

    /** the output file path (relative process.cwd) */
    outputFile?: string;

    /** output json file for data only */
    json?: boolean;

    /** output zip file for all report files
     * {boolean} using default path
     * {string} zip file path
     */
    zip?: boolean | string | {
        /** the zip file path */
        outputFile?: string;
        /** whether to clean the files after zipped */
        clean?: boolean;
    };

    /**
     *  whether to copy attachments to the reporter output dir, defaults to true
     *  it is useful when there are multiple html reports being output
     */
    copyAttachments?: boolean;

    /** attachment path handler, for example:  
     * ```js
     * attachmentPath: (currentPath, extras) => `https://cenfun.github.io/monocart-reporter/${currentPath}` 
     * ```
     */
    attachmentPath?: (currentPath: string, extras: any) => string;

    /** custom trace viewer url: https://github.com/cenfun/monocart-reporter?#view-trace-online */
    traceViewerUrl?: string;

    /** timezone offset in minutes, For example: GMT+0800 = -480 */
    timezoneOffset?: number;

    /** normal or exclude-idle */
    durationStrategy?: 'normal' | 'exclude-idle',

    /** Indicates whether to clean previous files in output dir before generating report. Defaults to true. */
    clean?: boolean;

    /** global coverage options: https://github.com/cenfun/monocart-reporter?#code-coverage-report 
     * ```js
     * coverage: {
     *   entryFilter: (entry) => true,
     *   sourceFilter: (sourcePath) => sourcePath.search(/src\/.+/) !== -1,
     * }
     * ```
    */
    coverage?: CoverageReportOptions;

    /** Global State Management: https://github.com/cenfun/monocart-reporter?#global-state-management */
    state?: {
        data?: any;
        server?: {
            host?: string;
            port?: number;
        }
        onReceive?: (...args: any[]) => any;
        onClose?: (data: any, config: any) => void;
    },

    /** trend data handler: https://github.com/cenfun/monocart-reporter?#trend-chart 
     * ```js
     * trend: () => './monocart-report/index.json'
     * ```
    */
    trend?: string | (() => Promise<string | any>);

    /** custom tags style: https://github.com/cenfun/monocart-reporter?#style-tags 
     * ```js
     * tags: {
     *   smoke: {
     *     'background': '#6F9913'
     *   },
     *   sanity: {
     *     'background': '#178F43'
     *   }
     * }
     * ```
    */
    tags?: {
        [key: string]: any;
    };

    /** columns data handler: https://github.com/cenfun/monocart-reporter?#style-tags */
    columns?: (defaultColumns: any[]) => void;

    /** rows data handler (suite, case and step) https://github.com/cenfun/monocart-reporter?#custom-data-visitor */
    visitor?: (data: any, metadata: any) => void;

    /** enable/disable custom fields in comments. Defaults to true. */
    customFieldsInComments?: boolean;

    /** mermaid options */
    mermaid?: {
        /** mermaid script url, for example: https://cdn.jsdelivr.net/npm/mermaid@latest/dist/mermaid.min.js */
        scriptSrc?: string;
        /** mermaid config: https://mermaid.js.org/config/schema-docs/config.html */
        config?: any;
    }

    /** enable/disable group or levels */
    groupOptions?: {
        group?: boolean;

        shard?: boolean;
        project?: boolean;
        file?: boolean;
        describe?: boolean;
        step?: boolean;

        merge?: boolean;
    }

    /**
     * onData hook
     */
    onData?: (reportData: any, rawData: any) => Promise<void>;


    /** onEnd hook: https://github.com/cenfun/monocart-reporter?#onend-hook */
    onEnd?: (reportData: any, helper: Helper) => Promise<void>;

}

/**
 * merge
 */
export function merge(
    reportDataList: any[],
    options?: MonocartReporterOptions
): Promise<void>;

/**
 * audit
 */
export type AuditReportOptions = {
    title?: string;
    outputDir?: string;
    outputName?: string;
};

export function attachAuditReport(
    runnerResult: any,
    testInfo: TestInfo,
    options?: AuditReportOptions
): Promise<any>;


/**
 * coverage
 */

export function addCoverageReport(
    coverageData: any[] | any,
    testInfo: TestInfo
): Promise<AddedResults>;

export function attachCoverageReport(
    coverageData: any[] | any,
    testInfo: TestInfo,
    options?: CoverageReportOptions
): Promise<CoverageResults>;


/**
 * network
 */
export type NetworkReportOptions = {
    title?: string;
    outputDir?: string;
    outputName?: string;

    // Whether inline all scripts to the single HTML file.
    inline?: boolean;
};

export function attachNetworkReport(
    har: string | Buffer,
    testInfo: TestInfo,
    options?: NetworkReportOptions
): Promise<any>;

export function setMetadata(
    data: {
        [key: string]: any;
    },
    testInfo: TestInfo
): void;

/**
 * state
 */
export type StateOptions = {
    host?: string;
    port?: number;
    timeout?: number;
};

export type State = {
    get: {
        (key: string): Promise<any>,
        (...args: string[]): Promise<any[]>
    },
    set: {
        (key: string, value: any): Promise<void>,
        (obj: any): Promise<void>
    },
    remove: {
        (key: string): Promise<void>,
        (...args: string[]): Promise<void>
    },
    send: (...args: any[]) => Promise<any>
}

export function useState(options?: StateOptions): State;