@allurereport/core-api 3.16.1 → 3.17.0

package/dist/aggregate.d.ts

@@ -13,4 +13,9 @@ export type Statistic = DiffStatistic & {
     total: number;
     retries?: number;
     flaky?: number;
+    resolutions?: {
+        issues?: number;
+        muted?: number;
+        accepted?: number;
+    };
 };

package/dist/index.d.ts

@@ -6,6 +6,7 @@ export type * from "./environment.js";
 export type * from "./history.js";
 export type * from "./resolutions.js";
 export type * from "./metadata.js";
+export * from "./metrics.js";
 export type * from "./model.js";
 export type * from "./testCase.js";
 export type * from "./testPlan.js";

package/dist/index.js

@@ -1,6 +1,7 @@
 export * from "./constants.js";
 export * from "./ci.js";
 export * from "./gitFlow.js";
+export * from "./metrics.js";
 export * from "./static.js";
 export * from "./categories.js";
 export * from "./utils/step.js";

package/dist/metrics.d.ts

@@ -0,0 +1,32 @@
+export type MetricBetter = "lower" | "higher" | "neutral";
+export interface PerformanceGroupConfig {
+    title: string;
+}
+export interface PerformanceMetricConfig {
+    title: string;
+    unit: string;
+    better: Exclude<MetricBetter, "neutral">;
+    group?: string;
+}
+export interface PerformanceConfig {
+    groups?: Record<string, PerformanceGroupConfig>;
+    metrics?: Record<string, PerformanceMetricConfig>;
+}
+export interface AllurePerformanceResult {
+    id: string;
+    key: string;
+    value: any;
+    start: number;
+    stop: number;
+}
+export interface MetricSample extends AllurePerformanceResult {
+    value: number;
+    source?: string;
+    title?: string;
+    unit?: string;
+    group?: string;
+    groupTitle?: string;
+    better?: MetricBetter;
+}
+export type ResolvableMetric = AllurePerformanceResult & Partial<Pick<MetricSample, "source" | "title" | "unit" | "group" | "groupTitle" | "better">>;
+export declare const resolveMetricSamples: (metrics: readonly ResolvableMetric[], performance?: PerformanceConfig) => MetricSample[];

package/dist/metrics.js

@@ -0,0 +1,29 @@
+const isValidMetricResult = (metric) => typeof metric.id === "string" &&
+    metric.id !== "" &&
+    typeof metric.key === "string" &&
+    metric.key !== "" &&
+    Number.isFinite(metric.start) &&
+    Number.isFinite(metric.stop);
+export const resolveMetricSamples = (metrics, performance = {}) => {
+    const metricsConfig = performance.metrics ?? {};
+    const groupsConfig = performance.groups ?? {};
+    return metrics.reduce((acc, metric) => {
+        const value = Number.isFinite(metric.value) ? Number(metric.value) : undefined;
+        if (value === undefined || !isValidMetricResult(metric)) {
+            return acc;
+        }
+        const metricConfig = metricsConfig[metric.key];
+        const group = metricConfig?.group ?? metric.group;
+        const groupConfig = group ? groupsConfig[group] : undefined;
+        acc.push({
+            ...metric,
+            value,
+            ...(metricConfig?.title ? { title: metricConfig.title } : {}),
+            ...(metricConfig?.unit ? { unit: metricConfig.unit } : {}),
+            ...(group ? { group } : {}),
+            ...(groupConfig?.title ? { groupTitle: groupConfig.title } : {}),
+            ...(metricConfig?.better ? { better: metricConfig.better } : {}),
+        });
+        return acc;
+    }, []);
+};

package/dist/model.d.ts

@@ -49,6 +49,7 @@ export interface TestResult {
     flaky: boolean;
     muted: boolean;
     resolution?: ResolutionCategory;
+    resolutionComment?: string;
     transition?: TestStatusTransition;
     retryHash?: string;
     isRetry: boolean;

package/dist/utils/history.js

@@ -9,6 +9,12 @@ const normalizeHistoryTestResults = (testResults) => {
     }
     return Object.fromEntries(Object.entries(testResults).filter(([, value]) => isRecord(value)));
 };
+const normalizeHistoryMetrics = (metrics) => {
+    if (!isRecord(metrics)) {
+        return {};
+    }
+    return Object.fromEntries(Object.entries(metrics).filter(([, value]) => Number.isFinite(value)));
+};
 const parametersCompare = (a, b) => {
     return (a.name ?? "").localeCompare(b.name ?? "") || (a.value ?? "").localeCompare(b.value ?? "");
 };
@@ -41,7 +47,7 @@ export const normalizeHistoryDataPoint = (historyDataPoint) => ({
     ...historyDataPoint,
     knownTestCaseIds: Array.isArray(historyDataPoint.knownTestCaseIds) ? historyDataPoint.knownTestCaseIds : [],
     testResults: normalizeHistoryTestResults(historyDataPoint.testResults),
-    metrics: isRecord(historyDataPoint.metrics) ? historyDataPoint.metrics : {},
+    metrics: normalizeHistoryMetrics(historyDataPoint.metrics),
     url: historyDataPoint.url ?? "",
 });
 export const normalizeHistoryDataPointUrls = (historyDataPoint) => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@allurereport/core-api",
-  "version": "3.16.1",
+  "version": "3.17.0",
   "description": "Allure Core API",
   "keywords": [
     "allure"