@allurereport/core-api 3.0.0-beta.17 → 3.0.0-beta.19

package/dist/charts/types.d.ts

@@ -0,0 +1,80 @@
+import type { TestStatus } from "../model.js";
+export declare enum ChartType {
+    Trend = "trend",
+    Pie = "pie",
+    TreeMap = "treemap",
+    HeatMap = "heatmap",
+    Bar = "bar",
+    Funnel = "funnel",
+    ComingSoon = "coming-soon"
+}
+export declare enum ChartDataType {
+    Status = "status",
+    Severity = "severity"
+}
+export declare enum BarChartType {
+    StatusBySeverity = "statusBySeverity",
+    StatusTrend = "statusTrend",
+    StatusChangeTrend = "statusChangeTrend"
+}
+export declare enum TreeMapChartType {
+    SuccessRateDistribution = "successRateDistribution",
+    CoverageDiff = "coverageDiff"
+}
+export declare enum ChartMode {
+    Raw = "raw",
+    Percent = "percent"
+}
+export type ChartId = string;
+export type TrendPointId = string;
+export type TrendSliceId = string;
+export type BaseMetadata = Record<string, unknown>;
+export interface BaseTrendSliceMetadata extends BaseMetadata {
+    executionId: string;
+    executionName?: string;
+}
+export interface TrendPoint {
+    x: string;
+    y: number;
+}
+export type TrendSliceMetadata<Metadata extends BaseMetadata> = BaseTrendSliceMetadata & Metadata;
+export interface TrendSlice<Metadata extends BaseTrendSliceMetadata = BaseTrendSliceMetadata> {
+    min: number;
+    max: number;
+    metadata: TrendSliceMetadata<Metadata>;
+}
+export interface BasePieSlice {
+    status: TestStatus;
+    count: number;
+}
+export interface PieSlice extends BasePieSlice {
+    d: string | null;
+}
+export type PieChartValues = {
+    percentage: number;
+    slices: PieSlice[];
+};
+export type BarGroupValues<T extends string = string> = Record<T, number>;
+export type BarGroup<G extends string, T extends string = string> = {
+    groupId: G;
+} & BarGroupValues<T>;
+export declare enum BarGroupMode {
+    Grouped = "grouped",
+    Stacked = "stacked"
+}
+export type NewKey<T extends string> = `new${Capitalize<T>}`;
+export type RemovedKey<T extends string> = `removed${Capitalize<T>}`;
+export type TreeMapNode<T extends Record<string, any> = {}> = T & {
+    id: string;
+    value?: number;
+    colorValue?: number;
+    children?: TreeMapNode<T>[];
+};
+export type HeatMapPoint = {
+    x: string;
+    y?: number;
+};
+export type HeatMapSerie<T extends Record<string, any> = Record<string, any>> = {
+    id: string;
+    data: HeatMapPoint[];
+} & T;

package/dist/charts/types.js

@@ -0,0 +1,36 @@
+export var ChartType;
+(function (ChartType) {
+    ChartType["Trend"] = "trend";
+    ChartType["Pie"] = "pie";
+    ChartType["TreeMap"] = "treemap";
+    ChartType["HeatMap"] = "heatmap";
+    ChartType["Bar"] = "bar";
+    ChartType["Funnel"] = "funnel";
+    ChartType["ComingSoon"] = "coming-soon";
+})(ChartType || (ChartType = {}));
+export var ChartDataType;
+(function (ChartDataType) {
+    ChartDataType["Status"] = "status";
+    ChartDataType["Severity"] = "severity";
+})(ChartDataType || (ChartDataType = {}));
+export var BarChartType;
+(function (BarChartType) {
+    BarChartType["StatusBySeverity"] = "statusBySeverity";
+    BarChartType["StatusTrend"] = "statusTrend";
+    BarChartType["StatusChangeTrend"] = "statusChangeTrend";
+})(BarChartType || (BarChartType = {}));
+export var TreeMapChartType;
+(function (TreeMapChartType) {
+    TreeMapChartType["SuccessRateDistribution"] = "successRateDistribution";
+    TreeMapChartType["CoverageDiff"] = "coverageDiff";
+})(TreeMapChartType || (TreeMapChartType = {}));
+export var ChartMode;
+(function (ChartMode) {
+    ChartMode["Raw"] = "raw";
+    ChartMode["Percent"] = "percent";
+})(ChartMode || (ChartMode = {}));
+export var BarGroupMode;
+(function (BarGroupMode) {
+    BarGroupMode["Grouped"] = "grouped";
+    BarGroupMode["Stacked"] = "stacked";
+})(BarGroupMode || (BarGroupMode = {}));

package/dist/charts/utils.d.ts

@@ -0,0 +1,6 @@
+import type { PieArcDatum } from "d3-shape";
+import type { BasePieSlice, PieChartValues, Statistic } from "../index.js";
+export declare const getPercentage: (value: number, total: number) => number;
+export declare const d3Arc: import("d3-shape").Arc<any, PieArcDatum<BasePieSlice>>;
+export declare const d3Pie: import("d3-shape").Pie<any, BasePieSlice>;
+export declare const getPieChartValues: (stats: Statistic) => PieChartValues;

package/dist/charts/utils.js

@@ -0,0 +1,34 @@
+import { arc, pie } from "d3-shape";
+import { statusesList } from "../constants.js";
+export const getPercentage = (value, total) => Math.floor((value / total) * 10000) / 100;
+export const d3Arc = arc().innerRadius(40).outerRadius(50).cornerRadius(2).padAngle(0.03);
+export const d3Pie = pie()
+    .value((d) => d.count)
+    .padAngle(0.03)
+    .sortValues((a, b) => a - b);
+export const getPieChartValues = (stats) => {
+    const convertedStatuses = statusesList
+        .filter((status) => !!stats?.[status])
+        .map((status) => ({
+        status,
+        count: stats[status],
+    }));
+    const arcsData = d3Pie(convertedStatuses);
+    const slices = arcsData
+        .map((arcData) => {
+        const d = d3Arc(arcData);
+        if (!d) {
+            return null;
+        }
+        return {
+            d,
+            ...arcData.data,
+        };
+    })
+        .filter((item) => item !== null);
+    const percentage = getPercentage(stats.passed ?? 0, stats.total);
+    return {
+        slices,
+        percentage,
+    };
+};

package/dist/history.d.ts

@@ -11,6 +11,8 @@ export interface HistoryTestResult {
     duration?: number;
     labels?: TestLabel[];
     url: string;
+    historyId?: string;
+    reportLinks?: any[];
 }
 export interface HistoryDataPoint {
     uuid: string;

package/dist/index.d.ts

@@ -9,6 +9,7 @@ export type * from "./model.js";
 export type * from "./testCase.js";
 export type * from "./testPlan.js";
 export type * from "./config.js";
+export * from "./static.js";
 export * from "./utils/step.js";
 export type * from "./utils/tree.js";
 export * from "./utils/time.js";
@@ -18,3 +19,7 @@ export * from "./utils/label.js";
 export * from "./utils/testplan.js";
 export * from "./utils/status.js";
 export * from "./utils/environment.js";
+export * from "./utils/history.js";
+export * from "./utils/strings.js";
+export * from "./charts/types.js";
+export * from "./charts/utils.js";

package/dist/index.js

@@ -1,5 +1,6 @@
 export * from "./constants.js";
 export * from "./ci.js";
+export * from "./static.js";
 export * from "./utils/step.js";
 export * from "./utils/time.js";
 export * from "./utils/comparator.js";
@@ -8,3 +9,7 @@ export * from "./utils/label.js";
 export * from "./utils/testplan.js";
 export * from "./utils/status.js";
 export * from "./utils/environment.js";
+export * from "./utils/history.js";
+export * from "./utils/strings.js";
+export * from "./charts/types.js";
+export * from "./charts/utils.js";

package/dist/static.d.ts

@@ -0,0 +1,12 @@
+export declare const createScriptTag: (src: string, options?: {
+    async?: false;
+    defer?: false;
+}) => string;
+export declare const createStylesLinkTag: (src: string) => string;
+export declare const createFontLinkTag: (src: string) => string;
+export declare const createFaviconLinkTag: (src: string) => string;
+export declare const createBaseUrlScript: () => string;
+export declare const createReportDataScript: (reportFiles?: {
+    name: string;
+    value: string;
+}[]) => string;

package/dist/static.js

@@ -0,0 +1,55 @@
+export const createScriptTag = (src, options) => {
+    return `<script ${options?.async ? "async" : ""} ${options?.defer ? "defer" : ""} src="${src}"></script>`;
+};
+export const createStylesLinkTag = (src) => {
+    return `<link rel="stylesheet" type="text/css" href="${src}">`;
+};
+export const createFontLinkTag = (src) => {
+    return `<link rel="preload" href="${src}" as="font" type="font/woff" crossorigin /> `;
+};
+export const createFaviconLinkTag = (src) => {
+    return `<link rel="icon" href="${src}">`;
+};
+export const createBaseUrlScript = () => {
+    return `
+    <script>
+      const { origin, pathname } = window.location; 
+      const url = new URL(pathname, origin);
+      const baseEl = document.createElement("base");
+      
+      baseEl.href = url.toString();
+      
+      window.document.head.appendChild(baseEl);
+    </script>
+  `;
+};
+export const createReportDataScript = (reportFiles = []) => {
+    if (!reportFiles?.length) {
+        return `
+      <script async>
+        window.allureReportDataReady = true;
+      </script>
+    `;
+    }
+    const reportFilesDeclaration = reportFiles.map(({ name, value }) => `d('${name}','${value}')`).join(",");
+    return `
+    <script async>
+      window.allureReportDataReady = false;
+      window.allureReportData = window.allureReportData || {};
+
+      function d(name, value){
+        return new Promise(function (resolve) {
+          window.allureReportData[name] = value;
+
+          return resolve(true);
+        });
+      }
+    </script>
+    <script defer>
+      Promise.allSettled([${reportFilesDeclaration}])
+        .then(function(){
+          window.allureReportDataReady = true;
+        })
+    </script>
+  `;
+};

package/dist/utils/history.d.ts

@@ -0,0 +1,3 @@
+import type { HistoryDataPoint, HistoryTestResult } from "../history.js";
+import type { TestResult } from "../model.js";
+export declare const htrsByTr: (hdps: HistoryDataPoint[], tr: TestResult | HistoryTestResult) => HistoryTestResult[];

package/dist/utils/history.js

@@ -0,0 +1,22 @@
+export const htrsByTr = (hdps, tr) => {
+    if (!tr?.historyId) {
+        return [];
+    }
+    return hdps.reduce((acc, dp) => {
+        const htr = dp.testResults[tr.historyId];
+        if (htr) {
+            if (dp.url) {
+                const url = new URL(dp.url);
+                url.hash = tr.id;
+                acc.push({
+                    ...htr,
+                    url: url.toString(),
+                });
+            }
+            else {
+                acc.push(htr);
+            }
+        }
+        return acc;
+    }, []);
+};

package/dist/utils/strings.d.ts

@@ -0,0 +1 @@
+export declare const capitalize: <T extends string>(str: T) => Capitalize<T> | undefined;

package/dist/utils/strings.js

@@ -0,0 +1,6 @@
+export const capitalize = (str) => {
+    if (!str) {
+        return;
+    }
+    return (str.charAt(0).toLocaleUpperCase() + str.slice(1));
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@allurereport/core-api",
-  "version": "3.0.0-beta.17",
+  "version": "3.0.0-beta.19",
   "description": "Allure Core API",
   "keywords": [
     "allure"
@@ -25,15 +25,19 @@
     "eslint:format": "eslint --fix ./src/**/*.{js,jsx,ts,tsx}",
     "test": "rimraf ./out && vitest run"
   },
+  "dependencies": {
+    "d3-shape": "^3.2.0"
+  },
   "devDependencies": {
     "@stylistic/eslint-plugin": "^2.6.1",
+    "@types/d3-shape": "^3.1.6",
     "@types/eslint": "^8.56.11",
     "@types/node": "^20.17.9",
     "@typescript-eslint/eslint-plugin": "^8.0.0",
     "@typescript-eslint/parser": "^8.0.0",
     "@vitest/runner": "^2.1.9",
     "@vitest/snapshot": "^2.1.9",
-    "allure-vitest": "^3.3.0",
+    "allure-vitest": "^3.3.3",
     "eslint": "^8.57.0",
     "eslint-config-prettier": "^9.1.0",
     "eslint-plugin-import": "^2.29.1",