jest-allure2-reporter/dist/runtime/types.d.ts

Idiomatic Jest reporter for Allure Framework

import type { AttachmentsOptions, BuiltinContentAttachmentHandler, BuiltinFileAttachmentHandler, LabelName, LinkType, MaybeNullish, MaybePromise, Parameter, Primitive, Severity, Status, StatusDetails } from 'jest-allure2-reporter';
import type { Function_ } from '../utils';
export interface AllureRuntime {
    /**
     * Advanced API for attaching metadata to the same step or test.
     * Useful when your artifacts are delayed and are created asynchronously.
     */
    $bind(options?: AllureRuntimeBindOptions): AllureRuntime;
    /**
     * Attach a runtime plugin using a callback.
     * The callback will be called with the runtime plugin context.
     */
    $plug(callback: AllureRuntimePluginCallback): void;
    description(value: string): void;
    descriptionHtml(value: string): void;
    displayName(value: string): void;
    fullName(value: string): void;
    historyId(value: Primitive): void;
    label(name: LabelName, value: string): void;
    link(url: string, name?: string, type?: LinkType): void;
    parameter(name: string, value: unknown, options?: ParameterOptions): void;
    parameters(parameters: object): void;
    status(status: Status, statusDetails?: StatusDetails): void;
    statusDetails(statusDetails: StatusDetails): void;
    attachment<T extends AttachmentContent>(name: string, content: MaybePromise<T>, options?: Omit<ContentAttachmentOptions, 'name'>): Promise<string | undefined>;
    attachment<T extends AttachmentContent>(name: string, content: MaybePromise<T>, mimeType?: string): Promise<string | undefined>;
    createAttachment<T extends AttachmentContent, F extends Function_<MaybePromise<T>>>(function_: F, name: string): F;
    createAttachment<T extends AttachmentContent, F extends Function_<MaybePromise<T>>>(function_: F, options: ContentAttachmentOptions): typeof function_;
    fileAttachment(filePath: string | Promise<string>, name?: string): Promise<string | undefined>;
    fileAttachment(filePath: string | Promise<string>, options?: FileAttachmentOptions): Promise<string | undefined>;
    createFileAttachment<F extends Function_<MaybePromise<string>>>(function_: F, name?: string): F;
    createFileAttachment<F extends Function_<MaybePromise<string>>>(function_: F, options?: FileAttachmentOptions): F;
    createStep<F extends Function>(name: string, function_: F): F;
    createStep<F extends Function>(name: string, arguments_: UserParameter[], function_: F): F;
    step<T>(name: string, function_: () => T): T;
    epic(value: string): void;
    feature(value: string): void;
    issue(name: string, url?: string): void;
    owner(value: string): void;
    package(value: string): void;
    parentSuite(name: string): void;
    severity(value: Severity): void;
    story(value: string): void;
    subSuite(name: string): void;
    suite(name: string): void;
    tag(value: string): void;
    tags(...values: string[]): void;
    testClass(value: string): void;
    testMethod(value: string): void;
    thread(value: Primitive): void;
    tms(name: string, url?: string): void;
}
export interface SharedReporterConfig {
    overwrite: boolean;
    resultsDir: string;
    injectGlobals: boolean;
    attachments: Required<AttachmentsOptions>;
}
export type AllureRuntimePluginCallback = (context: AllureRuntimePluginContext) => void;
export type HandlebarsAPI = typeof import('handlebars');
export interface AllureRuntimePluginContext {
    readonly runtime: AllureRuntime;
    readonly handlebars: HandlebarsAPI;
    readonly contentAttachmentHandlers: Record<BuiltinContentAttachmentHandler | 'default' | string, ContentAttachmentHandler>;
    readonly fileAttachmentHandlers: Record<BuiltinFileAttachmentHandler | 'default' | string, FileAttachmentHandler>;
    inferMimeType: MIMEInferer;
}
export type AttachmentOptions<Context extends AttachmentContext> = {
    name?: string;
    mimeType?: string;
    handler?: string | AttachmentHandler<Context>;
};
export type FileAttachmentOptions = AttachmentOptions<FileAttachmentContext>;
export type ContentAttachmentOptions = AttachmentOptions<ContentAttachmentContext> & {
    name: string;
};
export type UserParameter = MaybeNullish<string | Omit<Parameter, 'value'>>;
export type ParameterOptions = Pick<Parameter, 'mode' | 'excluded'>;
export type AllureRuntimeBindOptions = {
    /** @default true */
    metadata?: boolean;
    /** @default false */
    time?: boolean;
};
export interface AttachmentContext {
    name: string;
    mimeType: string;
    outDir: string;
    sourcePath?: string;
    content?: AttachmentContent;
}
export interface FileAttachmentContext extends AttachmentContext {
    sourcePath: string;
}
export interface ContentAttachmentContext extends AttachmentContext {
    content: AttachmentContent;
}
export type AttachmentContent = Buffer | string;
export type AttachmentHandler<Context extends AttachmentContext> = (context: Readonly<Context>) => MaybePromise<string | undefined>;
export type FileAttachmentHandler = AttachmentHandler<FileAttachmentContext>;
export type ContentAttachmentHandler = AttachmentHandler<ContentAttachmentContext>;
export type MIMEInferer = (context: MIMEInfererContext) => string | undefined;
export interface MIMEInfererContext {
    sourcePath?: string;
    content?: AttachmentContent;
}