@allurereport/reader-api 3.0.0-beta.3

package/README.md

@@ -0,0 +1,25 @@
+# Reader API
+
+[<img src="https://allurereport.org/public/img/allure-report.svg" height="85px" alt="Allure Report logo" align="right" />](https://allurereport.org "Allure Report")
+
+- Learn more about Allure Report at https://allurereport.org
+- 📚 [Documentation](https://allurereport.org/docs/) – discover official documentation for Allure Report
+- ❓ [Questions and Support](https://github.com/orgs/allure-framework/discussions/categories/questions-support) – get help from the team and community
+- 📢 [Official announcements](https://github.com/orgs/allure-framework/discussions/categories/announcements) – be in touch with the latest updates
+- 💬 [General Discussion ](https://github.com/orgs/allure-framework/discussions/categories/general-discussion) – engage in casual conversations, share insights and ideas with the community
+
+---
+
+## Overview
+
+The interfaces in the package describe the entities used for building Allure Readers.
+
+## Install
+
+Use your favorite package manager to install the package:
+
+```shell
+npm add @allurereport/reader-api
+yarn add @allurereport/reader-api
+pnpm add @allurereport/reader-api
+```

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./model.js";
+export * from "./reader.js";
+export * from "./resultFile.js";

package/dist/index.js

@@ -0,0 +1,3 @@
+export * from "./model.js";
+export * from "./reader.js";
+export * from "./resultFile.js";

package/dist/model.d.ts

@@ -0,0 +1,86 @@
+export type RawTestStatus = "failed" | "broken" | "passed" | "skipped" | "unknown";
+export type RawMetadata = {
+    [key: string]: any;
+};
+export interface RawFixtureResult {
+    uuid?: string;
+    testResults?: string[];
+    type: "before" | "after";
+    name?: string;
+    start?: number;
+    stop?: number;
+    duration?: number;
+    status?: RawTestStatus;
+    message?: string;
+    trace?: string;
+    steps?: RawStep[];
+}
+export interface RawTestResult {
+    uuid?: string;
+    name?: string;
+    status?: RawTestStatus;
+    fullName?: string;
+    testId?: string;
+    testCaseName?: string;
+    historyId?: string;
+    description?: string;
+    descriptionHtml?: string;
+    precondition?: string;
+    preconditionHtml?: string;
+    expectedResult?: string;
+    expectedResultHtml?: string;
+    start?: number;
+    stop?: number;
+    duration?: number;
+    message?: string;
+    trace?: string;
+    flaky?: boolean;
+    muted?: boolean;
+    known?: boolean;
+    hostId?: string;
+    threadId?: string;
+    parameters?: RawTestParameter[];
+    steps?: RawStep[];
+    labels?: RawTestLabel[];
+    links?: RawTestLink[];
+}
+export interface RawTestLabel {
+    name?: string;
+    value?: string;
+}
+export interface RawTestLink {
+    name?: string;
+    url?: string;
+    type?: string;
+}
+export interface RawTestParameter {
+    name?: string;
+    value?: string;
+    hidden?: boolean;
+    excluded?: boolean;
+    masked?: boolean;
+}
+export type RawStep = RawTestStepResult | RawTestAttachment;
+export interface RawTestStepResult {
+    name?: string;
+    status?: RawTestStatus;
+    message?: string;
+    trace?: string;
+    start?: number;
+    stop?: number;
+    duration?: number;
+    parameters?: RawTestParameter[];
+    steps?: RawStep[];
+    type: "step";
+}
+export interface RawTestAttachment {
+    name?: string;
+    originalFileName?: string;
+    contentType?: string;
+    contentLength?: number;
+    optional?: boolean;
+    start?: number;
+    stop?: number;
+    duration?: number;
+    type: "attachment";
+}

package/dist/model.js

@@ -0,0 +1 @@
+export {};

package/dist/reader.d.ts

@@ -0,0 +1,16 @@
+import { ResultFile } from "@allurereport/plugin-api";
+import { RawFixtureResult, RawMetadata, RawTestResult } from "./model.js";
+export interface ReaderContext {
+    readerId: string;
+    metadata?: RawMetadata;
+}
+export interface ResultsVisitor {
+    visitTestResult(result: RawTestResult, context: ReaderContext): Promise<void>;
+    visitTestFixtureResult(result: RawFixtureResult, context: ReaderContext): Promise<void>;
+    visitAttachmentFile(result: ResultFile, context: ReaderContext): Promise<void>;
+    visitMetadata(metadata: RawMetadata, context: ReaderContext): Promise<void>;
+}
+export interface ResultsReader {
+    read(visitor: ResultsVisitor, data: ResultFile): Promise<boolean>;
+    readerId(): string;
+}

package/dist/reader.js

@@ -0,0 +1 @@
+export {};

package/dist/resultFile.d.ts

@@ -0,0 +1,32 @@
+import type { ResultFile } from "@allurereport/plugin-api";
+import { ReadStream } from "node:fs";
+import "node:fs/promises";
+import { Readable } from "node:stream";
+export declare abstract class BaseResultFile implements ResultFile {
+    fileName: string;
+    protected constructor(fileName: string);
+    protected abstract getContent(): ReadStream | undefined;
+    abstract getContentLength(): number | undefined;
+    getContentType(): string | undefined;
+    getOriginalFileName(): string;
+    asJson<T>(): Promise<T | undefined>;
+    asUtf8String(): Promise<string | undefined>;
+    asBuffer(): Promise<Buffer | undefined>;
+    writeTo(path: string): Promise<void>;
+    readContent<T>(transform: (stream: ReadStream) => Promise<T | undefined>): Promise<T | undefined>;
+}
+export declare class BufferResultFile extends BaseResultFile {
+    buffer: Buffer;
+    constructor(buffer: Buffer, fileName: string);
+    protected getContent(): ReadStream | undefined;
+    getContentLength(): number | undefined;
+}
+export declare class PathResultFile extends BaseResultFile {
+    path: string;
+    constructor(path: string, fileName?: string);
+    protected getContent(): ReadStream | undefined;
+    getContentLength(): number | undefined;
+}
+export declare const readSteamToJson: <T extends unknown>(stream: Readable) => Promise<T | undefined>;
+export declare const readStreamToString: (stream: Readable) => Promise<string>;
+export declare const readStreamToBuffer: (stream: Readable) => Promise<Buffer>;

package/dist/resultFile.js

@@ -0,0 +1,82 @@
+import { lookup } from "mime-types";
+import { ReadStream, createReadStream, createWriteStream, existsSync, statSync } from "node:fs";
+import "node:fs/promises";
+import { basename } from "node:path";
+import { pipeline } from "node:stream/promises";
+export class BaseResultFile {
+    constructor(fileName) {
+        this.fileName = fileName;
+    }
+    getContentType() {
+        const res = lookup(this.getOriginalFileName());
+        if (res === false) {
+            return undefined;
+        }
+        return res;
+    }
+    getOriginalFileName() {
+        return this.fileName;
+    }
+    async asJson() {
+        return await this.readContent(readSteamToJson);
+    }
+    async asUtf8String() {
+        return await this.readContent(readStreamToString);
+    }
+    async asBuffer() {
+        return await this.readContent(readStreamToBuffer);
+    }
+    async writeTo(path) {
+        await this.readContent(async (stream) => {
+            await pipeline(stream, createWriteStream(path));
+        });
+    }
+    async readContent(transform) {
+        const content = this.getContent();
+        return content ? await transform(content) : undefined;
+    }
+}
+export class BufferResultFile extends BaseResultFile {
+    constructor(buffer, fileName) {
+        super(basename(fileName));
+        this.buffer = buffer;
+    }
+    getContent() {
+        return ReadStream.from(this.buffer, { encoding: "utf8" });
+    }
+    getContentLength() {
+        return this.buffer.length;
+    }
+}
+export class PathResultFile extends BaseResultFile {
+    constructor(path, fileName = basename(path)) {
+        super(fileName);
+        this.path = path;
+    }
+    getContent() {
+        if (existsSync(this.path)) {
+            return createReadStream(this.path);
+        }
+        else {
+            return undefined;
+        }
+    }
+    getContentLength() {
+        return statSync(this.path, { throwIfNoEntry: false })?.size;
+    }
+}
+export const readSteamToJson = async (stream) => {
+    const text = await readStreamToString(stream);
+    return JSON.parse(text);
+};
+export const readStreamToString = async (stream) => {
+    const res = await readStreamToBuffer(stream);
+    return res.toString("utf-8");
+};
+export const readStreamToBuffer = async (stream) => {
+    const chunks = [];
+    for await (const chunk of stream) {
+        chunks.push(Buffer.from(chunk));
+    }
+    return Buffer.concat(chunks);
+};

package/package.json

@@ -0,0 +1,54 @@
+{
+  "name": "@allurereport/reader-api",
+  "version": "3.0.0-beta.3",
+  "description": "Allure Reader API",
+  "keywords": [
+    "allure",
+    "testing"
+  ],
+  "repository": "https://github.com/allure-framework/allure3",
+  "license": "Apache-2.0",
+  "author": "Qameta Software",
+  "type": "module",
+  "exports": {
+    ".": "./dist/index.js"
+  },
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "run clean && tsc --project ./tsconfig.json",
+    "clean": "rimraf ./dist",
+    "test": "rimraf ./out && vitest run"
+  },
+  "dependencies": {
+    "@allurereport/core-api": "3.0.0-beta.3",
+    "@allurereport/plugin-api": "3.0.0-beta.3",
+    "mime-types": "^2.1.35"
+  },
+  "devDependencies": {
+    "@stylistic/eslint-plugin": "^2.6.1",
+    "@types/eslint": "^8.56.11",
+    "@types/mime-types": "^2.1.4",
+    "@types/node": "^20.17.9",
+    "@typescript-eslint/eslint-plugin": "^8.0.0",
+    "@typescript-eslint/parser": "^8.0.0",
+    "@vitest/runner": "^2.1.8",
+    "allure-vitest": "^3.0.7",
+    "eslint": "^8.57.0",
+    "eslint-config-prettier": "^9.1.0",
+    "eslint-plugin-import": "^2.29.1",
+    "eslint-plugin-jsdoc": "^50.0.0",
+    "eslint-plugin-n": "^17.10.1",
+    "eslint-plugin-no-null": "^1.0.2",
+    "eslint-plugin-prefer-arrow": "^1.2.3",
+    "rimraf": "^6.0.1",
+    "ts-node": "^10.9.2",
+    "tslib": "^2.7.0",
+    "typescript": "^5.6.3",
+    "vitest": "^2.1.8"
+  }
+}