@allurereport/plugin-api
Advanced tools
+2
-0
@@ -16,2 +16,3 @@ import type { CategoriesConfig, DefaultLabelsConfig, EnvironmentsConfig, ReportVariables } from "@allurereport/core-api"; | ||
| environment?: string; | ||
| allowedEnvironments?: string[]; | ||
| environments?: EnvironmentsConfig; | ||
@@ -26,3 +27,4 @@ variables?: ReportVariables; | ||
| categories?: CategoriesConfig; | ||
| globalAttachments?: string[]; | ||
| } | ||
| export declare const defineConfig: (allureConfig: Config) => Config; |
+14
-5
@@ -55,6 +55,14 @@ import type { AllureHistory, AttachmentLink, CategoryDefinition, CiDescriptor, Statistic, TestError, TestResult, TestStatus } from "@allurereport/core-api"; | ||
| } | ||
| export type PluginGlobalError = TestError & { | ||
| environment?: string; | ||
| }; | ||
| export type PluginGlobalAttachment = AttachmentLink & { | ||
| environment?: string; | ||
| }; | ||
| export interface PluginGlobals { | ||
| exitCode?: ExitCode; | ||
| errors: TestError[]; | ||
| attachments: AttachmentLink[]; | ||
| errors: PluginGlobalError[]; | ||
| attachments: PluginGlobalAttachment[]; | ||
| errorsByEnv?: Record<string, PluginGlobalError[]>; | ||
| attachmentsByEnv?: Record<string, PluginGlobalAttachment[]>; | ||
| } | ||
@@ -68,5 +76,6 @@ export interface BatchOptions { | ||
| fileName?: string; | ||
| environment?: string; | ||
| }) => Promise<void>): () => void; | ||
| onGlobalExitCode(listener: (payload: ExitCode) => Promise<void>): () => void; | ||
| onGlobalError(listener: (error: TestError) => Promise<void>): () => void; | ||
| onGlobalError(listener: (error: PluginGlobalError) => Promise<void>): () => void; | ||
| onQualityGateResults(listener: (payload: QualityGateValidationResult[]) => Promise<void>): () => void; | ||
@@ -78,5 +87,5 @@ onTestResults(listener: (trIds: string[]) => Promise<void>, options?: BatchOptions): () => void; | ||
| export interface RealtimeEventsDispatcher { | ||
| sendGlobalAttachment(attachment: ResultFile, fileName?: string): void; | ||
| sendGlobalAttachment(attachment: ResultFile, fileName?: string, environment?: string): void; | ||
| sendGlobalExitCode(payload: ExitCode): void; | ||
| sendGlobalError(error: TestError): void; | ||
| sendGlobalError(error: PluginGlobalError): void; | ||
| sendQualityGateResults(payload: QualityGateValidationResult[]): void; | ||
@@ -83,0 +92,0 @@ sendTestResult(trId: string): void; |
+4
-2
| import type { AttachmentLink, EnvironmentIdentity, HistoryDataPoint, HistoryTestResult, KnownTestFailure, ReportVariables, Statistic, TestCase, TestEnvGroup, TestError, TestFixtureResult, TestResult } from "@allurereport/core-api"; | ||
| import type { ExitCode } from "./plugin.js"; | ||
| import type { ExitCode, PluginGlobalAttachment, PluginGlobalError } from "./plugin.js"; | ||
| import type { QualityGateValidationResult } from "./qualityGate.js"; | ||
@@ -25,3 +25,5 @@ import type { ResultFile } from "./resultFile.js"; | ||
| allGlobalErrors: () => Promise<TestError[]>; | ||
| allGlobalErrorsByEnv: () => Promise<Record<string, PluginGlobalError[]>>; | ||
| allGlobalAttachments: () => Promise<AttachmentLink[]>; | ||
| allGlobalAttachmentsByEnv: () => Promise<Record<string, PluginGlobalAttachment[]>>; | ||
| testCaseById: (tcId: string) => Promise<TestCase | undefined>; | ||
@@ -63,3 +65,3 @@ testResultById: (trId: string) => Promise<TestResult | undefined>; | ||
| globalAttachmentIds: string[]; | ||
| globalErrors: TestError[]; | ||
| globalErrors: PluginGlobalError[]; | ||
| testCases: Record<string, TestCase>; | ||
@@ -66,0 +68,0 @@ fixtures: Record<string, TestFixtureResult>; |
+2
-2
| { | ||
| "name": "@allurereport/plugin-api", | ||
| "version": "3.4.1", | ||
| "version": "3.5.0", | ||
| "description": "Allure Plugin API", | ||
@@ -29,3 +29,3 @@ "keywords": [ | ||
| "dependencies": { | ||
| "@allurereport/core-api": "3.4.1" | ||
| "@allurereport/core-api": "3.5.0" | ||
| }, | ||
@@ -32,0 +32,0 @@ "devDependencies": { |
30166
2.21%645
2.06%+ Added
- Removed
Updated