allure-js-commons

const ALLURE_HTTP_EXCHANGE_CONTENT_TYPE: string;

const ALLURE_HTTP_EXCHANGE_FILE_EXTENSION: string;

const ALLURE_HTTP_EXCHANGE_SCHEMA_VERSION: number;

const ALLURE_HTTP_REDACTED_VALUE: string;

const StatusByPriority: Status[];

allureId: (value: string) => PromiseLike<void>;

attachment: (
    name: string,
    content: Buffer | Uint8Array | string,
    options: ContentType | string | AttachmentOptions
) => PromiseLike<void>;

attachmentPath: (
    name: string,
    path: string,
    options: ContentType | string | Omit<AttachmentOptions, 'encoding'>
) => PromiseLike<void>;

attachTrace: (name: string, path: string) => PromiseLike<void>;

description: (markdown: string) => PromiseLike<void>;

descriptionHtml: (html: string) => PromiseLike<void>;

displayName: (name: string) => PromiseLike<void>;

epic: (name: string) => PromiseLike<void>;

feature: (name: string) => PromiseLike<void>;

globalAttachment: (
    name: string,
    content: Buffer | Uint8Array | string,
    options: ContentType | string | AttachmentOptions
) => PromiseLike<void>;

globalAttachmentPath: (
    name: string,
    path: string,
    options: ContentType | string | Omit<AttachmentOptions, 'encoding'>
) => PromiseLike<void>;

globalError: (details: StatusDetails) => PromiseLike<void>;

historyId: (value: string) => PromiseLike<void>;

issue: (url: string, name?: string) => PromiseLike<void>;

label: (name: LabelName | string, value: string) => PromiseLike<void>;

labels: (...labelsList: Label[]) => PromiseLike<void>;

layer: (name: string) => PromiseLike<void>;

link: (
    url: string,
    name?: string,
    type?: LinkType | string
) => PromiseLike<void>;

links: (...linksList: Link[]) => PromiseLike<void>;

logStep: (name: string, status?: Status, error?: Error) => PromiseLike<void>;

owner: (name: string) => PromiseLike<void>;

parameter: (
    name: string,
    value: string,
    options?: ParameterOptions
) => PromiseLike<void>;

parentSuite: (name: string) => PromiseLike<void>;

severity: (name: string) => PromiseLike<void>;

step: <T = void>(
    name: string,
    body: (context: StepContext) => T | PromiseLike<T>
) => PromiseLike<T>;

story: (name: string) => PromiseLike<void>;

subSuite: (name: string) => PromiseLike<void>;

suite: (name: string) => PromiseLike<void>;

tag: (name: string) => PromiseLike<void>;

tags: (...tagsList: string[]) => PromiseLike<void>;

testCaseId: (value: string) => PromiseLike<void>;

tms: (url: string, name?: string) => PromiseLike<void>;

type HttpExchange = {
    schemaVersion: typeof ALLURE_HTTP_EXCHANGE_SCHEMA_VERSION;
    request: HttpExchangeRequest;
    response?: HttpExchangeResponse;
    error?: HttpExchangeError;
    start?: number;
    stop?: number;
};

type HttpExchangeBody = {
    contentType?: string;
    encoding?: 'utf8' | 'base64';
    value?: string;
    size?: number;
    truncated?: boolean;
    form?: HttpExchangeNameValue[];
    parts?: HttpExchangeBodyPart[];
    stream?: HttpExchangeStream;
};

type HttpExchangeBodyPart = {
    name?: string;
    fileName?: string;
    headers?: HttpExchangeNameValue[];
    contentType?: string;
    encoding?: 'utf8' | 'base64';
    value?: string;
    size?: number;
    truncated?: boolean;
};

type HttpExchangeCookie = HttpExchangeNameValue & {
    path?: string;
    domain?: string;
    expires?: string;
    httpOnly?: boolean;
    secure?: boolean;
    sameSite?: string;
};

type HttpExchangeError = {
    name?: string;
    message?: string;
    stack?: string;
};

type HttpExchangeInformationalResponse = {
    status?: number;
    statusText?: string;
    headers?: HttpExchangeNameValue[];
};

type HttpExchangeNameValue = {
    name: string;
    value: string;
};

type HttpExchangeRequest = {
    method: string;
    url: string;
    httpVersion?: string;
    cookies?: HttpExchangeCookie[];
    headers?: HttpExchangeNameValue[];
    query?: HttpExchangeNameValue[];
    body?: HttpExchangeBody;
    trailers?: HttpExchangeNameValue[];
};

type HttpExchangeResponse = {
    status?: number;
    statusText?: string;
    httpVersion?: string;
    cookies?: HttpExchangeCookie[];
    headers?: HttpExchangeNameValue[];
    body?: HttpExchangeBody;
    trailers?: HttpExchangeNameValue[];
    informationalResponses?: HttpExchangeInformationalResponse[];
};

type HttpExchangeStream = {
    type?: string;
    complete?: boolean;
    chunkCount?: number;
};

type ParameterMode = 'hidden' | 'masked' | 'default';

type ParameterOptions = Pick<Parameter, 'mode' | 'excluded'>;

type TestOrStepResult = StepResult | TestResult;