testcafe-reporter-cucumber-json/lib/cucumber-json-interfaces.d.ts

Cucumber JSON TestCafe reporter plugin.

import { TestRunInfo, BrowserInfo } from './reporter-interface';
export interface MultiBrowserFeatureReport {
    [userAgent: string]: FeatureReport;
}
export interface FeatureReport {
    description: string;
    elements: Scenario[];
    id: string;
    keyword: string;
    line: number;
    metadata: Metadata | CustomMetadata[];
    name: string;
    runInfo: RunInfo | undefined;
    skipped: boolean;
    tags: Tag[];
    uri: string;
}
export interface RunInfo {
    endTime: Date;
    passed: number;
    startTime: Date;
    testCount: number;
    userAgents: string[];
    warnings: string[];
}
export interface CustomMetadata {
    label?: string;
    name: string;
    value: string;
}
export interface Scenario {
    id: string;
    keyword: string;
    line: number;
    name: string;
    skipped: boolean;
    sourceLine: string;
    status: StepStatus;
    steps: Step[];
    tags: Tag[];
    type: string;
    uri: string;
}
export interface MultiBrowserScenario {
    [userAgent: string]: Scenario;
}
export interface Step {
    hidden: boolean;
    image: string[] | undefined;
    keyword: string;
    match: Match;
    name: string;
    result: StepResult;
    tags: Tag[];
    text: string[];
}
export interface Match {
    location: string;
}
export interface StepResult {
    duration: number;
    error_message: string | undefined;
    status: StepStatus;
}
export declare type StepStatus = 'passed' | 'failed' | 'skipped' | 'undefined';
export interface Tag {
    line: number;
    name: string;
}
export declare const testcafeDefaultStep: Step;
export interface CustomReportData {
    data: Metadata[];
    title: string;
}
export interface CucumberJsonReportInterface {
    createFeature: (name: string, path: string) => CucumberJsonReportInterface;
    createScenario: (name: string, testRunInfo: TestRunInfo) => CucumberJsonReportInterface;
    currentFeature: MultiBrowserFeatureReport | undefined;
    currentScenario: MultiBrowserScenario | undefined;
    finalizeWith: (endTime: Date, passed: number, warnings: string[]) => CucumberJsonReportInterface;
    initializeWith: (startTime: Date, userAgents: string[], testCount: number) => CucumberJsonReportInterface;
    toJson: (userAgent: string) => string;
    withBrowserError: (error: string | undefined, userAgent: string) => CucumberJsonReportInterface;
    withBrowserScreenshots: (path: string[] | undefined, userAgent: string) => CucumberJsonReportInterface;
    withBrowserInfo: (userAgent: string, browserInfo: BrowserInfo) => CucumberJsonReportInterface;
    writeJsonFiles: () => void;
}
export interface Metadata {
    app: AppNameVersion | undefined;
    browser: Browser;
    device: string;
    platform: Platform;
    reportTime: Date;
    startTime: Date;
}
export interface Platform {
    name: PlatformName;
    version: string;
}
export interface NameVersion {
    name: string;
    version: string;
}
export interface AppNameVersion {
    name: string;
    version?: string;
}
export interface Browser {
    name: BrowserName;
    version: string;
}
export declare type BrowserName = 'Internet Explorer' | 'edge' | 'chrome' | 'firefox' | 'safari' | 'opera' | 'unknown';
export declare type PlatformName = 'windows' | 'osx' | 'linux' | 'ubuntu' | 'android' | 'ios' | 'unknown';