@allurereport/plugin-api 3.6.2 → 3.8.0

package/dist/config.d.ts

@@ -21,6 +21,7 @@ export interface Config {
     qualityGate?: QualityGateConfig;
     allureService?: {
         accessToken?: string;
+        legacy?: boolean;
     };
     categories?: CategoriesConfig;
     globalAttachments?: string[];

package/dist/plugin.d.ts

@@ -68,18 +68,19 @@ export interface PluginGlobals {
 export interface BatchOptions {
     maxTimeout?: number;
 }
+export type RealtimeListenerResult = void | Promise<void>;
 export interface RealtimeSubscriber {
     onGlobalAttachment(listener: (payload: {
         attachment: ResultFile;
         fileName?: string;
         environment?: string;
-    }) => Promise<void>): () => void;
-    onGlobalExitCode(listener: (payload: ExitCode) => Promise<void>): () => void;
-    onGlobalError(listener: (error: PluginGlobalError) => Promise<void>): () => void;
-    onQualityGateResults(listener: (payload: QualityGateValidationResult[]) => Promise<void>): () => void;
-    onTestResults(listener: (trIds: string[]) => Promise<void>, options?: BatchOptions): () => void;
-    onTestFixtureResults(listener: (tfrIds: string[]) => Promise<void>, options?: BatchOptions): () => void;
-    onAttachmentFiles(listener: (afIds: string[]) => Promise<void>, options?: BatchOptions): () => void;
+    }) => RealtimeListenerResult): () => void;
+    onGlobalExitCode(listener: (payload: ExitCode) => RealtimeListenerResult): () => void;
+    onGlobalError(listener: (error: PluginGlobalError) => RealtimeListenerResult): () => void;
+    onQualityGateResults(listener: (payload: QualityGateValidationResult[]) => RealtimeListenerResult): () => void;
+    onTestResults(listener: (trIds: string[]) => RealtimeListenerResult, options?: BatchOptions): () => void;
+    onTestFixtureResults(listener: (tfrIds: string[]) => RealtimeListenerResult, options?: BatchOptions): () => void;
+    onAttachmentFiles(listener: (afIds: string[]) => RealtimeListenerResult, options?: BatchOptions): () => void;
 }
 export interface RealtimeEventsDispatcher {
     sendGlobalAttachment(attachment: ResultFile, fileName?: string, environment?: string): void;

package/dist/store.d.ts

@@ -1,4 +1,4 @@
-import type { AttachmentLink, EnvironmentIdentity, HistoryDataPoint, HistoryTestResult, KnownTestFailure, ReportVariables, Statistic, TestCase, TestEnvGroup, TestError, TestFixtureResult, TestResult } from "@allurereport/core-api";
+import type { AllureCheckResult, AttachmentLink, EnvironmentIdentity, HistoryDataPoint, HistoryTestResult, KnownTestFailure, ReportVariables, Statistic, TestCase, TestEnvGroup, TestError, TestFixtureResult, TestResult } from "@allurereport/core-api";
 import type { ExitCode, PluginGlobalAttachment, PluginGlobalError } from "./plugin.js";
 import type { QualityGateValidationResult } from "./qualityGate.js";
 import type { ResultFile } from "./resultFile.js";
@@ -17,6 +17,8 @@ export interface AllureStore {
     allHistoryDataPointsByEnvironmentId: (environmentId: string) => Promise<HistoryDataPoint[]>;
     allKnownIssues: () => Promise<KnownTestFailure[]>;
     allNewTestResults: (filter?: TestResultFilter, history?: HistoryDataPoint[]) => Promise<TestResult[]>;
+    addCheckResult: (result: AllureCheckResult) => Promise<void>;
+    allCheckResults: () => Promise<AllureCheckResult[]>;
     qualityGateResults: () => Promise<QualityGateValidationResult[]>;
     qualityGateResultsByEnv: () => Promise<Record<string, QualityGateValidationResult[]>>;
     qualityGateResultsByEnvironmentId: () => Promise<Record<string, QualityGateValidationResult[]>>;
@@ -62,6 +64,7 @@ export interface AllureStoreDump {
     attachments: Record<string, AttachmentLink>;
     globalAttachmentIds: string[];
     globalErrors: PluginGlobalError[];
+    checkResults: AllureCheckResult[];
     testCases: Record<string, TestCase>;
     fixtures: Record<string, TestFixtureResult>;
     environments: Array<string | EnvironmentIdentity>;
@@ -82,6 +85,7 @@ export declare enum AllureStoreDumpFiles {
     GlobalErrors = "global-errors.json",
     GlobalAttachments = "global-attachments.json",
     Attachments = "attachments.json",
+    CheckResults = "check-results.json",
     Environments = "environments.json",
     ReportVariables = "report-variables.json",
     IndexAttachmentsByTestResults = "index-attachments-by-test-results.json",

package/dist/store.js

@@ -6,6 +6,7 @@ export var AllureStoreDumpFiles;
     AllureStoreDumpFiles["GlobalErrors"] = "global-errors.json";
     AllureStoreDumpFiles["GlobalAttachments"] = "global-attachments.json";
     AllureStoreDumpFiles["Attachments"] = "attachments.json";
+    AllureStoreDumpFiles["CheckResults"] = "check-results.json";
     AllureStoreDumpFiles["Environments"] = "environments.json";
     AllureStoreDumpFiles["ReportVariables"] = "report-variables.json";
     AllureStoreDumpFiles["IndexAttachmentsByTestResults"] = "index-attachments-by-test-results.json";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@allurereport/plugin-api",
-  "version": "3.6.2",
+  "version": "3.8.0",
   "description": "Allure Plugin API",
   "keywords": [
     "allure"
@@ -26,7 +26,7 @@
     "lint:fix": "oxlint --import-plugin --fix src test features stories"
   },
   "dependencies": {
-    "@allurereport/core-api": "3.6.2"
+    "@allurereport/core-api": "3.8.0"
   },
   "devDependencies": {
     "@types/node": "^20.17.9",