@allurereport/core 3.0.0-beta.3 → 3.0.0-beta.5

package/dist/api.d.ts

@@ -7,9 +7,10 @@ export interface FullConfig {
     reportFiles: ReportFiles;
     readers?: ResultsReader[];
     plugins?: PluginInstance[];
-    history?: HistoryDataPoint[];
-    historyPath?: string;
+    history: HistoryDataPoint[];
+    historyPath: string;
     appendHistory?: boolean;
+    knownIssuesPath: string;
     known?: KnownTestFailure[];
     qualityGate?: QualityGateConfig;
     realTime?: any;

package/dist/config.d.ts

@@ -1,22 +1,14 @@
 import type { Config } from "@allurereport/plugin-api";
-import type { QualityGateConfig } from "@allurereport/plugin-api";
-import type { FullConfig, PluginInstance } from "./api.js";
-export { defineConfig } from "@allurereport/plugin-api";
-export declare const createConfig: (opts: {
-    reportName?: string;
+import type { FullConfig } from "./api.js";
+export declare const getPluginId: (key: string) => string;
+export declare const findConfig: (cwd: string, configPath?: string) => Promise<string | undefined>;
+export interface ConfigOverride {
+    name?: string;
     output?: string;
     historyPath?: string;
     knownIssuesPath?: string;
-    plugins?: PluginInstance[];
-    qualityGate?: QualityGateConfig;
-    cwd?: string;
-}) => Promise<FullConfig>;
-export declare const getPluginId: (key: string) => string;
-export declare const findRuntimeConfigPath: (cwd?: string) => Promise<string | undefined>;
-export declare const readRuntimeConfig: (configPath?: string, cwd?: string, output?: string, name?: string) => Promise<FullConfig>;
+}
+export declare const readConfig: (cwd?: string, configPath?: string, override?: ConfigOverride) => Promise<FullConfig>;
 export declare const loadConfig: (configPath: string) => Promise<Config>;
-export declare const resolveConfig: (config: Config, override?: {
-    name?: string;
-    output?: string;
-}) => Promise<FullConfig>;
+export declare const resolveConfig: (config: Config, override?: ConfigOverride) => Promise<FullConfig>;
 export declare const resolvePlugin: (path: string) => Promise<any>;

package/dist/config.js

@@ -1,63 +1,69 @@
-import { readdir } from "node:fs/promises";
-import { join, resolve } from "node:path";
+import * as console from "node:console";
+import { stat } from "node:fs/promises";
+import { resolve } from "node:path";
 import * as process from "node:process";
 import { readHistory } from "./history.js";
 import { readKnownIssues } from "./known.js";
 import { FileSystemReportFiles } from "./plugin.js";
 import { importWrapper } from "./utils/module.js";
-export { defineConfig } from "@allurereport/plugin-api";
-export const createConfig = async (opts) => {
-    const { reportName = "Allure Report", output = "allure-report", historyPath, knownIssuesPath, qualityGate, cwd, } = opts;
-    const workingDirectory = cwd ?? process.cwd();
-    const target = resolve(workingDirectory, output);
-    const history = historyPath ? await readHistory(resolve(workingDirectory, historyPath)) : [];
-    const known = knownIssuesPath ? await readKnownIssues(resolve(workingDirectory, knownIssuesPath)) : [];
-    return {
-        name: reportName,
-        history,
-        historyPath,
-        known,
-        qualityGate,
-        plugins: opts.plugins ?? [],
-        reportFiles: new FileSystemReportFiles(target),
-        output: target,
-    };
-};
-const defaultRuntimeConfig = {};
+import { normalizeImportPath } from "./utils/path.js";
 export const getPluginId = (key) => {
     return key.replace(/^@.*\//, "").replace(/[/\\]/g, "-");
 };
-export const findRuntimeConfigPath = async (cwd = process.cwd()) => {
-    const files = await readdir(cwd);
-    if (files.includes("allurerc.js")) {
-        return join(cwd, "allurerc.js");
+const configNames = ["allurerc.js", "allurerc.mjs"];
+const defaultConfig = {};
+export const findConfig = async (cwd, configPath) => {
+    if (configPath) {
+        const resolved = resolve(cwd, configPath);
+        try {
+            const stats = await stat(resolved);
+            if (stats.isFile()) {
+                return resolved;
+            }
+        }
+        catch (e) {
+            console.error(e);
+        }
+        throw new Error(`invalid config path ${resolved}: not a regular file`);
     }
-    if (files.includes("allurerc.mjs")) {
-        return join(cwd, "allurerc.mjs");
+    for (const configName of configNames) {
+        const resolved = resolve(cwd, configName);
+        try {
+            const stats = await stat(resolved);
+            if (stats.isFile()) {
+                return resolved;
+            }
+        }
+        catch (ignored) {
+        }
     }
-    return undefined;
 };
-export const readRuntimeConfig = async (configPath, cwd, output, name) => {
-    const runtimeConfigPath = !configPath ? await findRuntimeConfigPath(cwd) : resolve(cwd ?? process.cwd(), configPath);
-    const runtimeConfig = runtimeConfigPath ? await loadConfig(runtimeConfigPath) : defaultRuntimeConfig;
-    return await resolveConfig(runtimeConfig, { output, name });
+export const readConfig = async (cwd = process.cwd(), configPath, override) => {
+    const cfg = await findConfig(cwd, configPath);
+    const config = cfg ? await loadConfig(cfg) : { ...defaultConfig };
+    return await resolveConfig(config, override);
 };
 export const loadConfig = async (configPath) => {
-    return (await import(configPath)).default;
+    return (await import(normalizeImportPath(configPath))).default;
 };
 export const resolveConfig = async (config, override = {}) => {
-    const { plugins = {}, name, output, historyPath, ...rest } = config;
-    const pluginInstances = await resolvePlugins(plugins);
-    const out = resolve(override.output ?? output ?? "./allure-report");
-    const history = historyPath ? await readHistory(historyPath) : [];
+    const name = override.name ?? config.name ?? "Allure Report";
+    const historyPath = resolve(override.historyPath ?? config.historyPath ?? "./.allure/history.jsonl");
+    const knownIssuesPath = resolve(override.knownIssuesPath ?? config.knownIssuesPath ?? "./allure/known.json");
+    const output = resolve(override.output ?? config.output ?? "./allure-report");
+    const history = await readHistory(historyPath);
+    const known = await readKnownIssues(knownIssuesPath);
+    const pluginInstances = await resolvePlugins(config.plugins ?? {});
     return {
-        ...rest,
-        name: override.name ?? name ?? "Allure Report",
-        reportFiles: new FileSystemReportFiles(out),
+        name,
+        reportFiles: new FileSystemReportFiles(output),
         plugins: pluginInstances,
-        output: out,
+        output,
         history,
         historyPath,
+        knownIssuesPath,
+        known,
+        qualityGate: config.qualityGate,
     };
 };
 export const resolvePlugin = async (path) => {

package/dist/history.js

@@ -54,5 +54,5 @@ export const writeHistory = async (historyPath, data) => {
     const path = resolve(historyPath);
     const parentDir = dirname(path);
     await mkdir(parentDir, { recursive: true });
-    await writeFile(path, JSON.stringify(data) + "\n", { encoding: "utf-8", flag: "a+" });
+    await writeFile(path, `${JSON.stringify(data)}\n`, { encoding: "utf-8", flag: "a+" });
 };

package/dist/index.d.ts

@@ -1,9 +1,10 @@
-export * from "./api.js";
+export type * from "./api.js";
 export * from "./utils/misc.js";
 export * from "./utils/crypto.js";
+export * from "./utils/path.js";
 export * from "./history.js";
 export * from "./known.js";
-export * from "./config.js";
+export { resolveConfig, readConfig } from "./config.js";
 export * from "./report.js";
 export * from "./plugin.js";
 export * from "./qualityGate.js";

package/dist/index.js

@@ -1,9 +1,9 @@
-export * from "./api.js";
 export * from "./utils/misc.js";
 export * from "./utils/crypto.js";
+export * from "./utils/path.js";
 export * from "./history.js";
 export * from "./known.js";
-export * from "./config.js";
+export { resolveConfig, readConfig } from "./config.js";
 export * from "./report.js";
 export * from "./plugin.js";
 export * from "./qualityGate.js";

package/dist/plugin.d.ts

@@ -1,4 +1,4 @@
-import { PluginState, ReportFiles } from "@allurereport/plugin-api";
+import type { PluginState, ReportFiles } from "@allurereport/plugin-api";
 export declare class DefaultPluginState implements PluginState {
     #private;
     constructor(state: Record<string, any>);

package/dist/report.js

@@ -10,7 +10,7 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
     return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
 };
 var _AllureReport_instances, _AllureReport_reportUuid, _AllureReport_reportName, _AllureReport_store, _AllureReport_readers, _AllureReport_plugins, _AllureReport_reportFiles, _AllureReport_eventEmitter, _AllureReport_events, _AllureReport_qualityGate, _AllureReport_appendHistory, _AllureReport_historyPath, _AllureReport_realTime, _AllureReport_state, _AllureReport_stage, _AllureReport_update, _AllureReport_eachPlugin, _AllureReport_getPluginState;
-import { allure1, allure2, attachments, junitXml } from "@allurereport/reader";
+import { allure1, allure2, attachments, cucumberjson, junitXml } from "@allurereport/reader";
 import { PathResultFile } from "@allurereport/reader-api";
 import console from "node:console";
 import { randomUUID } from "node:crypto";
@@ -126,7 +126,7 @@ export class AllureReport {
             if (initState) {
                 __classPrivateFieldSet(this, _AllureReport_state, {}, "f");
             }
-            for (let descriptor of __classPrivateFieldGet(this, _AllureReport_plugins, "f")) {
+            for (const descriptor of __classPrivateFieldGet(this, _AllureReport_plugins, "f")) {
                 if (!descriptor.enabled) {
                     continue;
                 }
@@ -159,14 +159,14 @@ export class AllureReport {
         this.validate = async () => {
             await __classPrivateFieldGet(this, _AllureReport_qualityGate, "f").validate(__classPrivateFieldGet(this, _AllureReport_store, "f"));
         };
-        const { name, readers = [allure1, allure2, junitXml, attachments], plugins = [], history, known, reportFiles, qualityGate, realTime, appendHistory, historyPath, } = opts;
+        const { name, readers = [allure1, allure2, cucumberjson, junitXml, attachments], plugins = [], history, known, reportFiles, qualityGate, realTime, appendHistory, historyPath, } = opts;
         __classPrivateFieldSet(this, _AllureReport_reportUuid, randomUUID(), "f");
         __classPrivateFieldSet(this, _AllureReport_reportName, name, "f");
         __classPrivateFieldSet(this, _AllureReport_eventEmitter, new EventEmitter(), "f");
         __classPrivateFieldSet(this, _AllureReport_events, new Events(__classPrivateFieldGet(this, _AllureReport_eventEmitter, "f")), "f");
         __classPrivateFieldSet(this, _AllureReport_realTime, realTime, "f");
         __classPrivateFieldSet(this, _AllureReport_appendHistory, appendHistory ?? true, "f");
-        __classPrivateFieldSet(this, _AllureReport_historyPath, historyPath ?? "./.allure/history.jsonl", "f");
+        __classPrivateFieldSet(this, _AllureReport_historyPath, historyPath, "f");
         __classPrivateFieldSet(this, _AllureReport_store, new DefaultAllureStore(history, known, __classPrivateFieldGet(this, _AllureReport_eventEmitter, "f")), "f");
         __classPrivateFieldSet(this, _AllureReport_readers, [...readers], "f");
         __classPrivateFieldSet(this, _AllureReport_plugins, [...plugins], "f");

package/dist/store/convert.d.ts

@@ -1,5 +1,5 @@
-import { AttachmentLink, TestCase, TestFixtureResult, TestResult } from "@allurereport/core-api";
-import { RawFixtureResult, RawTestResult, ReaderContext } from "@allurereport/reader-api";
+import type { AttachmentLink, TestCase, TestFixtureResult, TestResult } from "@allurereport/core-api";
+import type { RawFixtureResult, RawTestResult, ReaderContext } from "@allurereport/reader-api";
 export declare const __unknown = "#___unknown_value___#";
 export type StateData = {
     testCases: Map<string, TestCase>;

package/dist/store/convert.js

@@ -1,4 +1,4 @@
-import { notNull, } from "@allurereport/core-api";
+import { notNull } from "@allurereport/core-api";
 import { findByLabelName } from "@allurereport/core-api";
 import { md5 } from "@allurereport/plugin-api";
 import MarkdownIt from "markdown-it";
@@ -100,9 +100,9 @@ const processAttachmentLink = ({ attachments, visitAttachmentLink }, attach) =>
         });
     }
     const id = md5(attach.originalFileName);
-    let previous = attachments.get(id);
+    const previous = attachments.get(id);
     if (!previous) {
-        const link = {
+        const linkExpected = {
             id,
             originalFileName: attach.originalFileName,
             ext: extname(attach.originalFileName),
@@ -111,9 +111,9 @@ const processAttachmentLink = ({ attachments, visitAttachmentLink }, attach) =>
             used: true,
             missed: true,
         };
-        attachments.set(id, link);
-        visitAttachmentLink(link);
-        return createAttachmentStep(link);
+        attachments.set(id, linkExpected);
+        visitAttachmentLink(linkExpected);
+        return createAttachmentStep(linkExpected);
     }
     if (previous.used) {
         return createAttachmentStep({
@@ -240,13 +240,13 @@ const processTagLabels = (label) => {
     if (label.name === "tag" && label.value) {
         const matchTag = label.value.match(idLabelMatcher);
         if (matchTag) {
-            const id = matchTag?.groups?.["id"];
+            const id = matchTag?.groups?.id;
             return id ? [{ name: "ALLURE_ID", value: id }] : [];
         }
         const matchLabel = label.value.match(tagLabelMatcher);
         if (matchLabel) {
-            const name = matchLabel?.groups?.["name"];
-            const value = matchLabel?.groups?.["value"];
+            const name = matchLabel?.groups?.name;
+            const value = matchLabel?.groups?.value;
             return name && value ? [{ name, value }] : [];
         }
     }

package/dist/store/store.d.ts

@@ -1,8 +1,8 @@
-import { AttachmentLink, HistoryDataPoint, HistoryTestResult, KnownTestFailure, Statistic, TestCase, TestFixtureResult, TestResult } from "@allurereport/core-api";
-import { AllureStore, ResultFile } from "@allurereport/plugin-api";
+import type { AttachmentLink, HistoryDataPoint, HistoryTestResult, KnownTestFailure, Statistic, TestCase, TestFixtureResult, TestResult } from "@allurereport/core-api";
+import type { AllureStore, ResultFile } from "@allurereport/plugin-api";
 import type { RawFixtureResult, RawMetadata, RawTestResult, ReaderContext, ResultsVisitor } from "@allurereport/reader-api";
-import { EventEmitter } from "node:events";
-import { AllureStoreEvents } from "../utils/event.js";
+import type { EventEmitter } from "node:events";
+import type { AllureStoreEvents } from "../utils/event.js";
 export declare class DefaultAllureStore implements AllureStore, ResultsVisitor {
     #private;
     readonly indexTestResultByTestCase: Map<string, TestResult[]>;
@@ -15,8 +15,8 @@ export declare class DefaultAllureStore implements AllureStore, ResultsVisitor {
     constructor(history?: HistoryDataPoint[], known?: KnownTestFailure[], eventEmitter?: EventEmitter<AllureStoreEvents>);
     visitTestResult(raw: RawTestResult, context: ReaderContext): Promise<void>;
     visitTestFixtureResult(result: RawFixtureResult, context: ReaderContext): Promise<void>;
-    visitAttachmentFile(resultFile: ResultFile, context: ReaderContext): Promise<void>;
-    visitMetadata(metadata: RawMetadata, context: ReaderContext): Promise<void>;
+    visitAttachmentFile(resultFile: ResultFile): Promise<void>;
+    visitMetadata(metadata: RawMetadata): Promise<void>;
     allTestCases(): Promise<TestCase[]>;
     allTestResults(options?: {
         includeHidden: boolean;

package/dist/store/store.js

@@ -10,7 +10,7 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
     return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
 };
 var _DefaultAllureStore_testResults, _DefaultAllureStore_attachments, _DefaultAllureStore_attachmentContents, _DefaultAllureStore_testCases, _DefaultAllureStore_metadata, _DefaultAllureStore_history, _DefaultAllureStore_known, _DefaultAllureStore_fixtures, _DefaultAllureStore_eventEmitter;
-import { compareBy, nullsLast, ordinal, reverse, } from "@allurereport/core-api";
+import { compareBy, nullsLast, ordinal, reverse } from "@allurereport/core-api";
 import { md5 } from "@allurereport/plugin-api";
 import { extname } from "node:path";
 import { testFixtureResultRawToState, testResultRawToState } from "./convert.js";
@@ -93,7 +93,7 @@ export class DefaultAllureStore {
         index(this.indexAttachmentByFixture, testFixtureResult.id, ...attachmentLinks);
         __classPrivateFieldGet(this, _DefaultAllureStore_eventEmitter, "f")?.emit("testFixtureResult", testFixtureResult.id);
     }
-    async visitAttachmentFile(resultFile, context) {
+    async visitAttachmentFile(resultFile) {
         const originalFileName = resultFile.getOriginalFileName();
         const id = md5(originalFileName);
         __classPrivateFieldGet(this, _DefaultAllureStore_attachmentContents, "f").set(id, resultFile);
@@ -118,7 +118,7 @@ export class DefaultAllureStore {
         }
         __classPrivateFieldGet(this, _DefaultAllureStore_eventEmitter, "f")?.emit("attachmentFile", id);
     }
-    async visitMetadata(metadata, context) {
+    async visitMetadata(metadata) {
         Object.keys(metadata).forEach((key) => __classPrivateFieldGet(this, _DefaultAllureStore_metadata, "f").set(key, metadata[key]));
     }
     async allTestCases() {
@@ -145,7 +145,6 @@ export class DefaultAllureStore {
         return Array.from(__classPrivateFieldGet(this, _DefaultAllureStore_fixtures, "f").values());
     }
     async allHistoryDataPoints() {
-        console.log(__classPrivateFieldGet(this, _DefaultAllureStore_history, "f"));
         return __classPrivateFieldGet(this, _DefaultAllureStore_history, "f");
     }
     async allKnownIssues() {
@@ -178,11 +177,10 @@ export class DefaultAllureStore {
             return [];
         }
         return (this.indexTestResultByHistoryId.get(tr.historyId) ?? [])
-            .filter((tr) => tr.hidden)
+            .filter((r) => r.hidden)
             .sort(nullsLast(compareBy("start", reverse(ordinal()))));
     }
     async historyByTrId(trId) {
-        console.log(__classPrivateFieldGet(this, _DefaultAllureStore_history, "f"));
         const tr = await this.testResultById(trId);
         if (!tr?.historyId) {
             return [];

package/dist/utils/module.js

@@ -1,3 +1,6 @@
+import { createRequire } from "node:module";
+import { normalizeImportPath } from "./path.js";
+const require = createRequire(import.meta.url);
 export const importWrapper = async (path) => {
-    return import(path);
+    return import(normalizeImportPath(require.resolve(path)));
 };

package/dist/utils/path.d.ts

@@ -0,0 +1 @@
+export declare const normalizeImportPath: (path: string) => string;

package/dist/utils/path.js

@@ -0,0 +1,4 @@
+import { pathToFileURL } from "node:url";
+export const normalizeImportPath = (path) => {
+    return pathToFileURL(path).href;
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@allurereport/core",
-  "version": "3.0.0-beta.3",
+  "version": "3.0.0-beta.5",
   "description": "Collection of generic Allure utilities used across the entire project",
   "keywords": [
     "allure"
@@ -20,20 +20,22 @@
   "scripts": {
     "build": "run clean && tsc --project ./tsconfig.json",
     "clean": "rimraf ./dist",
+    "eslint": "eslint ./src/**/*.{js,jsx,ts,tsx}",
+    "eslint:format": "eslint --fix ./src/**/*.{js,jsx,ts,tsx}",
     "test": "vitest run"
   },
   "dependencies": {
-    "@allurereport/core-api": "3.0.0-beta.3",
-    "@allurereport/plugin-api": "3.0.0-beta.3",
-    "@allurereport/plugin-awesome": "3.0.0-beta.3",
-    "@allurereport/plugin-classic": "3.0.0-beta.3",
-    "@allurereport/plugin-csv": "3.0.0-beta.3",
-    "@allurereport/plugin-log": "3.0.0-beta.3",
-    "@allurereport/plugin-progress": "3.0.0-beta.3",
-    "@allurereport/plugin-slack": "3.0.0-beta.3",
-    "@allurereport/plugin-testplan": "3.0.0-beta.3",
-    "@allurereport/reader": "3.0.0-beta.3",
-    "@allurereport/reader-api": "3.0.0-beta.3",
+    "@allurereport/core-api": "3.0.0-beta.5",
+    "@allurereport/plugin-api": "3.0.0-beta.5",
+    "@allurereport/plugin-awesome": "3.0.0-beta.5",
+    "@allurereport/plugin-classic": "3.0.0-beta.5",
+    "@allurereport/plugin-csv": "3.0.0-beta.5",
+    "@allurereport/plugin-log": "3.0.0-beta.5",
+    "@allurereport/plugin-progress": "3.0.0-beta.5",
+    "@allurereport/plugin-slack": "3.0.0-beta.5",
+    "@allurereport/plugin-testplan": "3.0.0-beta.5",
+    "@allurereport/reader": "3.0.0-beta.5",
+    "@allurereport/reader-api": "3.0.0-beta.5",
     "markdown-it": "^14.1.0"
   },
   "devDependencies": {