@allurereport/web-commons 3.0.0-beta.14 → 3.0.0-beta.16

package/dist/charts/getSeverityTrendData.js

@@ -35,6 +35,7 @@ export const getSeverityTrendData = (testResults, reportName, historyPoints, cha
     }, {
         type: chartOptions.type,
         dataType: chartOptions.dataType,
+        mode: chartOptions.mode,
         title: chartOptions.title,
         points: {},
         slices: {},

package/dist/charts/getStatusTrendData.js

@@ -1,5 +1,5 @@
 import { statusesList } from "@allurereport/core-api";
-import { createEmptySeries, createEmptyStats, getTrendDataGeneric, mergeTrendDataGeneric, normalizeStatistic } from "../charts.js";
+import { createEmptySeries, createEmptyStats, getTrendDataGeneric, mergeTrendDataGeneric, normalizeStatistic, } from "../charts.js";
 export const getStatusTrendData = (currentStatistic, reportName, historyPoints, chartOptions) => {
     const { limit } = chartOptions;
     const historyLimit = limit && limit > 0 ? Math.max(0, limit - 1) : undefined;
@@ -26,6 +26,7 @@ export const getStatusTrendData = (currentStatistic, reportName, historyPoints,
     }, {
         type: chartOptions.type,
         dataType: chartOptions.dataType,
+        mode: chartOptions.mode,
         title: chartOptions.title,
         points: {},
         slices: {},

package/dist/charts.d.ts

@@ -1,6 +1,7 @@
 import type { SeverityLevel, TestResult, TestStatus } from "@allurereport/core-api";
 import type { PieArcDatum } from "d3-shape";
 export type BasePieSlice = Pick<PieSlice, "status" | "count">;
+export declare const DEFAULT_CHART_HISTORY_LIMIT = 10;
 export declare const d3Arc: import("d3-shape").Arc<any, PieArcDatum<BasePieSlice>>;
 export declare const d3Pie: import("d3-shape").Pie<any, BasePieSlice>;
 export declare const getPercentage: (value: number, total: number) => number;
@@ -8,11 +9,14 @@ export declare enum ChartType {
     Trend = "trend",
     Pie = "pie"
 }
-export declare enum ChartData {
+export declare enum ChartDataType {
     Status = "status",
     Severity = "severity"
 }
-export type ChartMode = "raw" | "percent";
+export declare enum ChartMode {
+    Raw = "raw",
+    Percent = "percent"
+}
 export type ChartId = string;
 export type ExecutionIdFn = (executionOrder: number) => string;
 export type ExecutionNameFn = (executionOrder: number) => string;
@@ -22,7 +26,7 @@ export type TrendMetadataFnOverrides = {
 };
 export type TrendChartOptions = {
     type: ChartType.Trend;
-    dataType: ChartData;
+    dataType: ChartDataType;
     mode?: ChartMode;
     title?: string;
     limit?: number;
@@ -47,7 +51,8 @@ export type TrendSlice<Metadata extends BaseMetadata> = {
 };
 export type GenericTrendChartData<Metadata extends BaseMetadata, SeriesType extends string> = {
     type: ChartType.Trend;
-    dataType: ChartData;
+    dataType: ChartDataType;
+    mode: ChartMode;
     title?: string;
     points: Record<TrendPointId, TrendPoint>;
     slices: Record<TrendSliceId, TrendSlice<Metadata>>;

package/dist/charts.js

@@ -1,4 +1,5 @@
 import { arc, pie } from "d3-shape";
+export const DEFAULT_CHART_HISTORY_LIMIT = 10;
 export const d3Arc = arc().innerRadius(40).outerRadius(50).cornerRadius(2).padAngle(0.03);
 export const d3Pie = pie()
     .value((d) => d.count)
@@ -10,11 +11,16 @@ export var ChartType;
     ChartType["Trend"] = "trend";
     ChartType["Pie"] = "pie";
 })(ChartType || (ChartType = {}));
-export var ChartData;
-(function (ChartData) {
-    ChartData["Status"] = "status";
-    ChartData["Severity"] = "severity";
-})(ChartData || (ChartData = {}));
+export var ChartDataType;
+(function (ChartDataType) {
+    ChartDataType["Status"] = "status";
+    ChartDataType["Severity"] = "severity";
+})(ChartDataType || (ChartDataType = {}));
+export var ChartMode;
+(function (ChartMode) {
+    ChartMode["Raw"] = "raw";
+    ChartMode["Percent"] = "percent";
+})(ChartMode || (ChartMode = {}));
 export const createEmptyStats = (items) => items.reduce((acc, item) => ({ ...acc, [item]: 0 }), {});
 export const createEmptySeries = (items) => items.reduce((acc, item) => ({ ...acc, [item]: [] }), {});
 export const normalizeStatistic = (statistic, itemType) => {
@@ -50,7 +56,7 @@ const calculatePercentValues = (stats, executionId, itemType) => {
         const value = stats[item] ?? 0;
         points[pointId] = {
             x: executionId,
-            y: (value / total) * 100,
+            y: value / total,
         };
         series[item].push(pointId);
     });
@@ -81,10 +87,10 @@ export const mergeTrendDataGeneric = (trendData, trendDataPart, itemType) => {
     };
 };
 export const getTrendDataGeneric = (stats, reportName, executionOrder, itemType, chartOptions) => {
-    const { type, dataType, title, mode = "raw", metadata = {} } = chartOptions;
+    const { type, dataType, title, mode = ChartMode.Raw, metadata = {} } = chartOptions;
     const { executionIdAccessor, executionNameAccessor } = metadata;
     const executionId = executionIdAccessor ? executionIdAccessor(executionOrder) : `execution-${executionOrder}`;
-    const { points, series } = mode === "percent"
+    const { points, series } = mode === ChartMode.Percent
         ? calculatePercentValues(stats, executionId, itemType)
         : calculateRawValues(stats, executionId, itemType);
     const slices = {};
@@ -107,6 +113,7 @@ export const getTrendDataGeneric = (stats, reportName, executionOrder, itemType,
     return {
         type,
         dataType,
+        mode,
         title,
         points,
         slices,

package/dist/data.d.ts

@@ -5,7 +5,11 @@ export declare const createReportDataScript: (reportFiles?: {
 }[]) => string;
 export declare const ensureReportDataReady: () => Promise<unknown>;
 export declare const loadReportData: (name: string) => Promise<string>;
-export declare const reportDataUrl: (path: string, contentType?: string) => Promise<string>;
-export declare const fetchReportJsonData: <T>(path: string) => Promise<T>;
+export declare const reportDataUrl: (path: string, contentType?: string, params?: {
+    bustCache: boolean;
+}) => Promise<string>;
+export declare const fetchReportJsonData: <T>(path: string, params?: {
+    bustCache: boolean;
+}) => Promise<T>;
 export declare const fetchReportAttachment: (path: string, contentType?: string) => Promise<Response>;
 export declare const getReportOptions: <T>() => T;

package/dist/data.js

@@ -49,22 +49,26 @@ export const loadReportData = async (name) => {
         }
     });
 };
-export const reportDataUrl = async (path, contentType = "application/octet-stream") => {
+export const reportDataUrl = async (path, contentType = "application/octet-stream", params) => {
     if (globalThis.allureReportData) {
-        const dataKey = path.replace(/\?attachment$/, "");
+        const [dataKey] = path.split("?");
         const value = await loadReportData(dataKey);
         return `data:${contentType};base64,${value}`;
     }
     const baseEl = globalThis.document.head.querySelector("base")?.href ?? "https://localhost";
     const url = new URL(path, baseEl);
     const liveReloadHash = globalThis.localStorage.getItem(ALLURE_LIVE_RELOAD_HASH_STORAGE_KEY);
+    const cacheKey = globalThis.allureReportOptions?.cacheKey;
     if (liveReloadHash) {
         url.searchParams.set("live_reload_hash", liveReloadHash);
     }
-    return url.pathname + url.search + url.hash;
+    if (params?.bustCache && cacheKey) {
+        url.searchParams.set("v", cacheKey);
+    }
+    return url.toString();
 };
-export const fetchReportJsonData = async (path) => {
-    const url = await reportDataUrl(path);
+export const fetchReportJsonData = async (path, params) => {
+    const url = await reportDataUrl(path, undefined, params);
     const res = await globalThis.fetch(url);
     if (!res.ok) {
         throw new Error(`Failed to fetch ${url}, response status: ${res.status}`);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@allurereport/web-commons",
-  "version": "3.0.0-beta.14",
+  "version": "3.0.0-beta.16",
   "description": "Collection of utilities used across the web Allure reports",
   "keywords": [
     "allure",
@@ -23,7 +23,7 @@
     "clean": "rimraf ./dist"
   },
   "dependencies": {
-    "@allurereport/core-api": "3.0.0-beta.14"
+    "@allurereport/core-api": "3.0.0-beta.16"
   },
   "devDependencies": {
     "@stylistic/eslint-plugin": "^2.6.1",
@@ -31,7 +31,7 @@
     "@types/eslint": "^8.56.11",
     "@typescript-eslint/eslint-plugin": "^8.0.0",
     "@typescript-eslint/parser": "^8.0.0",
-    "@vitest/runner": "^2.1.8",
+    "@vitest/runner": "^2.1.9",
     "allure-js-commons": "^3.0.9",
     "allure-vitest": "^3.0.9",
     "d3-shape": "^3.2.0",
@@ -45,6 +45,6 @@
     "rimraf": "^6.0.1",
     "tslib": "^2.7.0",
     "typescript": "^5.6.3",
-    "vitest": "^2.1.8"
+    "vitest": "^2.1.9"
   }
 }