@allurereport/plugin-api 3.11.0 → 3.13.0

package/dist/plugin.d.ts

@@ -1,4 +1,4 @@
-import type { AllureHistory, AttachmentLink, CategoryDefinition, CiDescriptor, HistoryDataPoint, Statistic, TestError, TestResult, TestStatus } from "@allurereport/core-api";
+import type { AllureHistory, AttachmentLink, AllureCheckResult, CategoryDefinition, CiDescriptor, HistoryDataPoint, Statistic, TestError, TestResult, TestStatus } from "@allurereport/core-api";
 import type { QualityGateValidationResult } from "./qualityGate.js";
 import type { ResultFile } from "./resultFile.js";
 import type { AllureStore } from "./store.js";
@@ -7,6 +7,9 @@ export interface PluginDescriptor {
     enabled?: boolean;
     options?: Record<string, any>;
 }
+export interface PluginConstructorContext {
+    enabled?: boolean;
+}
 export interface ReportFiles {
     addFile(path: string, data: Buffer): Promise<string>;
 }
@@ -32,6 +35,7 @@ export interface PluginContext {
     history?: AllureHistory;
 }
 export type SummaryTestResult = Pick<TestResult, "name" | "id" | "status" | "duration">;
+export type SummaryCheckResult = Pick<AllureCheckResult, "name" | "status">;
 export interface PluginSummary {
     href?: string;
     remoteHref?: string;
@@ -46,6 +50,7 @@ export interface PluginSummary {
     newTests?: SummaryTestResult[];
     flakyTests?: SummaryTestResult[];
     retryTests?: SummaryTestResult[];
+    checks?: SummaryCheckResult[];
     createdAt?: number;
     meta?: Record<string, any>;
 }

package/dist/utils/summary.d.ts

@@ -1,7 +1,8 @@
-import { type AllureHistory, type CiDescriptor, type TestResult } from "@allurereport/core-api";
-import type { PluginSummary, SummaryTestResult } from "../plugin.js";
+import { AllureCheckResult, type AllureHistory, type CiDescriptor, type TestResult } from "@allurereport/core-api";
+import type { PluginSummary, SummaryCheckResult, SummaryTestResult } from "../plugin.js";
 import type { AllureStore } from "../store.js";
 export declare const convertToSummaryTestResult: (tr: TestResult) => SummaryTestResult;
+export declare const convertToSummaryCheckResult: (check: AllureCheckResult) => SummaryCheckResult;
 export declare const createPluginSummary: (params: {
     filter?: (testResult: TestResult) => boolean;
     name: string;

package/dist/utils/summary.js

@@ -1,12 +1,17 @@
-import { getWorstStatus } from "@allurereport/core-api";
+import { getWorstStatus, } from "@allurereport/core-api";
 export const convertToSummaryTestResult = (tr) => ({
     id: tr.id,
     name: tr.name,
     status: tr.status,
     duration: tr.duration,
 });
+export const convertToSummaryCheckResult = (check) => ({
+    name: check.name,
+    status: check.status,
+});
 export const createPluginSummary = async (params) => {
     const { name, filter, plugin, store, history, meta } = params;
+    const allChecks = await store.allCheckResults();
     const allTrs = await store.allTestResults({ filter });
     const mainBranchHistory = (await history?.readHistory?.({ branch: "" })) ?? [];
     const newTrs = await store.allNewTestResults(filter, mainBranchHistory);
@@ -21,6 +26,7 @@ export const createPluginSummary = async (params) => {
         newTests: newTrs.map(convertToSummaryTestResult),
         flakyTests: flakyTrs.map(convertToSummaryTestResult),
         retryTests: retryTrs.map(convertToSummaryTestResult),
+        checks: allChecks.map(convertToSummaryCheckResult),
         name,
         duration,
         createdAt,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@allurereport/plugin-api",
-  "version": "3.11.0",
+  "version": "3.13.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.11.0"
+    "@allurereport/core-api": "3.13.0"
   },
   "devDependencies": {
     "@types/node": "^20",