@allurereport/charts-api 3.0.0-beta.21

package/README.md

@@ -0,0 +1,25 @@
+# Charts API
+
+[<img src="https://allurereport.org/public/img/allure-report.svg" height="85px" alt="Allure Report logo" align="right" />](https://allurereport.org "Allure Report")
+
+- Learn more about Allure Report at https://allurereport.org
+- 📚 [Documentation](https://allurereport.org/docs/) – discover official documentation for Allure Report
+- ❓ [Questions and Support](https://github.com/orgs/allure-framework/discussions/categories/questions-support) – get help from the team and community
+- 📢 [Official announcements](https://github.com/orgs/allure-framework/discussions/categories/announcements) – be in touch with the latest updates
+- 💬 [General Discussion ](https://github.com/orgs/allure-framework/discussions/categories/general-discussion) – engage in casual conversations, share insights and ideas with the community
+
+---
+
+## Overview
+
+The interfaces in the package describe the entities used for building Allure Charts.
+
+## Install
+
+Use your favorite package manager to install the package:
+
+```shell
+npm add @allurereport/charts-api
+yarn add @allurereport/charts-api
+pnpm add @allurereport/charts-api
+```

package/dist/constants.d.ts

@@ -0,0 +1,10 @@
+export declare const DEFAULT_CHART_HISTORY_LIMIT = 10;
+export declare const defaultChartsConfig: ({
+    type: string;
+    title: string;
+    dataType?: undefined;
+} | {
+    type: string;
+    dataType: string;
+    title: string;
+})[];

package/dist/constants.js

@@ -0,0 +1,66 @@
+export const DEFAULT_CHART_HISTORY_LIMIT = 10;
+export const defaultChartsConfig = [
+    {
+        type: "pie",
+        title: "Current status",
+    },
+    {
+        type: "trend",
+        dataType: "status",
+        title: "Status dynamics",
+    },
+    {
+        type: "bar",
+        dataType: "statusBySeverity",
+        title: "Test result severities",
+    },
+    {
+        type: "bar",
+        dataType: "statusTrend",
+        title: "Status change dynamics",
+    },
+    {
+        type: "bar",
+        dataType: "statusChangeTrend",
+        title: "Test base growth dynamics",
+    },
+    {
+        type: "treemap",
+        dataType: "coverageDiff",
+        title: "Coverage diff map",
+    },
+    {
+        type: "treemap",
+        dataType: "successRateDistribution",
+        title: "Success rate distribution",
+    },
+    {
+        type: "heatmap",
+        title: "Problems distribution by environment",
+    },
+    {
+        type: "bar",
+        dataType: "stabilityRateDistribution",
+        title: "Stability rate distribution",
+    },
+    {
+        type: "bar",
+        dataType: "durationsByLayer",
+        title: "Durations by layer histogram",
+    },
+    {
+        type: "bar",
+        dataType: "performanceTrend",
+        title: "Performance dynamics",
+    },
+    {
+        type: "bar",
+        dataType: "fbsuAgePyramid",
+        title: "FBSU age pyramid",
+    },
+    {
+        type: "funnel",
+        dataType: "testingPyramid",
+        title: "Testing pyramid",
+    },
+];

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./constants.js";
+export * from "./types.js";

package/dist/index.js

@@ -0,0 +1,2 @@
+export * from "./constants.js";
+export * from "./types.js";

package/dist/types.d.ts

@@ -0,0 +1,214 @@
+import type { HistoryDataPoint, SeverityLevel, Statistic, TestResult, TestStatus } from "@allurereport/core-api";
+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",
+    DurationsByLayer = "durationsByLayer",
+    FbsuAgePyramid = "fbsuAgePyramid",
+    StabilityRateDistribution = "stabilityRateDistribution"
+}
+export declare enum TreeMapChartType {
+    SuccessRateDistribution = "successRateDistribution",
+    CoverageDiff = "coverageDiff"
+}
+export declare enum ChartMode {
+    Raw = "raw",
+    Percent = "percent",
+    Diverging = "diverging"
+}
+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;
+export type ExecutionIdFn = (executionOrder: number) => string;
+export type ExecutionNameFn = (executionOrder: number) => string;
+export type TrendMetadataFnOverrides = {
+    executionIdAccessor?: ExecutionIdFn;
+    executionNameAccessor?: ExecutionNameFn;
+};
+export type TrendDataType = TestStatus | SeverityLevel;
+export type TrendStats<T extends TrendDataType> = Record<T, number>;
+export type TrendCalculationResult<T extends TrendDataType> = {
+    points: Record<TrendPointId, TrendPoint>;
+    series: Record<T, TrendPointId[]>;
+};
+export interface GenericTrendChartData<SeriesType extends string, Metadata extends BaseTrendSliceMetadata = BaseTrendSliceMetadata> {
+    type: ChartType.Trend;
+    dataType: ChartDataType;
+    mode: ChartMode;
+    title?: string;
+    points: Record<TrendPointId, TrendPoint>;
+    slices: Record<TrendSliceId, TrendSlice<Metadata>>;
+    series: Record<SeriesType, TrendPointId[]>;
+    min: number;
+    max: number;
+}
+export type StatusTrendChartData = GenericTrendChartData<TestStatus>;
+export type SeverityTrendChartData = GenericTrendChartData<SeverityLevel>;
+export type TrendChartData = StatusTrendChartData | SeverityTrendChartData;
+export interface BarChartData {
+    type: ChartType.Bar;
+    dataType: BarChartType;
+    mode: ChartMode;
+    title?: string;
+    data: BarGroup<string, string>[];
+    keys: readonly string[];
+    indexBy: string;
+    groupMode: BarGroupMode;
+    xAxisConfig?: {
+        legend?: string;
+        enabled?: boolean;
+        format?: string;
+        domain?: number[];
+        tickValues?: number | number[];
+    };
+    yAxisConfig?: {
+        legend?: string;
+        enabled?: boolean;
+        format?: string;
+        tickValues?: number | number[];
+        domain?: number[];
+    };
+    layout?: "horizontal" | "vertical";
+    threshold?: number;
+}
+export interface TreeMapChartData {
+    type: ChartType.TreeMap;
+    dataType: TreeMapChartType;
+    title?: string;
+    treeMap: TreeMapNode;
+}
+export interface HeatMapChartData<T extends Record<string, any> = {}> {
+    type: ChartType.HeatMap;
+    title?: string;
+    data: HeatMapSerie<T>[];
+}
+export interface PieChartData {
+    type: ChartType.Pie;
+    title?: string;
+    slices: PieSlice[];
+    percentage: number;
+}
+export interface ComingSoonChartData {
+    type: ChartType.ComingSoon;
+    title?: string;
+}
+export type GeneratedChartData = TrendChartData | PieChartData | BarChartData | ComingSoonChartData | TreeMapChartData | HeatMapChartData;
+export type GeneratedChartsData = Record<ChartId, GeneratedChartData>;
+export type TrendChartOptions = {
+    type: ChartType.Trend;
+    dataType: ChartDataType;
+    mode?: ChartMode;
+    title?: string;
+    limit?: number;
+    metadata?: TrendMetadataFnOverrides;
+};
+export type PieChartOptions = {
+    type: ChartType.Pie;
+    title?: string;
+};
+export type BarChartOptions = {
+    type: ChartType.Bar;
+    dataType: BarChartType;
+    mode?: ChartMode;
+    title?: string;
+    limit?: number;
+    threshold?: number;
+};
+export type TreeMapChartOptions = {
+    type: ChartType.TreeMap;
+    dataType: TreeMapChartType;
+    title?: string;
+};
+export type HeatMapChartOptions = {
+    type: ChartType.HeatMap;
+    title?: string;
+};
+export type ComingSoonChartOptions = {
+    type: ChartType.ComingSoon;
+    title?: string;
+};
+export type ChartOptions = TrendChartOptions | PieChartOptions | BarChartOptions | ComingSoonChartOptions | TreeMapChartOptions | HeatMapChartOptions;
+export interface AllureChartsStoreData {
+    historyDataPoints: HistoryDataPoint[];
+    testResults: TestResult[];
+    statistic: Statistic;
+}
+export interface TrendDataAccessor<T extends TrendDataType> {
+    getCurrentData: (storeData: AllureChartsStoreData) => TrendStats<T>;
+    getHistoricalData: (historyPoint: HistoryDataPoint) => TrendStats<T>;
+    getAllValues: () => readonly T[];
+}
+export interface BarDataAccessor<G extends string, T extends string> {
+    getItems: (storeData: AllureChartsStoreData, limitedHistoryDataPoints: HistoryDataPoint[], isFullHistory: boolean) => BarGroup<G, T>[];
+    getGroupKeys: () => readonly T[];
+    getGroupMode: () => BarGroupMode;
+}
+export interface TreeMapDataAccessor<T extends TreeMapNode> {
+    getTreeMap: (storeData: AllureChartsStoreData) => T;
+}
+export interface HeatMapDataAccessor<T extends Record<string, unknown> = {}> {
+    getHeatMap: (storeData: AllureChartsStoreData) => HeatMapSerie<T>[];
+}

package/dist/types.js

@@ -0,0 +1,40 @@
+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["DurationsByLayer"] = "durationsByLayer";
+    BarChartType["FbsuAgePyramid"] = "fbsuAgePyramid";
+    BarChartType["StabilityRateDistribution"] = "stabilityRateDistribution";
+})(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["Diverging"] = "diverging";
+})(ChartMode || (ChartMode = {}));
+export var BarGroupMode;
+(function (BarGroupMode) {
+    BarGroupMode["Grouped"] = "grouped";
+    BarGroupMode["Stacked"] = "stacked";
+})(BarGroupMode || (BarGroupMode = {}));

package/package.json

@@ -0,0 +1,56 @@
+{
+  "name": "@allurereport/charts-api",
+  "version": "3.0.0-beta.21",
+  "description": "Allure Charts API",
+  "keywords": [
+    "allure",
+    "testing",
+    "charts"
+  ],
+  "repository": "https://github.com/allure-framework/allure3",
+  "license": "Apache-2.0",
+  "author": "Qameta Software",
+  "type": "module",
+  "exports": {
+    ".": "./dist/index.js"
+  },
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "run clean && tsc --project ./tsconfig.json",
+    "clean": "rimraf ./dist",
+    "eslint": "eslint ./src/**/*.{js,jsx,ts,tsx}",
+    "eslint:format": "eslint --fix ./src/**/*.{js,jsx,ts,tsx}"
+  },
+  "dependencies": {
+    "@allurereport/core-api": "3.0.0-beta.21",
+    "@allurereport/plugin-api": "3.0.0-beta.21",
+    "d3-shape": "^3.2.0"
+  },
+  "devDependencies": {
+    "@stylistic/eslint-plugin": "^2.6.1",
+    "@types/d3-shape": "^3.1.6",
+    "@types/eslint": "^8.56.11",
+    "@types/mime-types": "^2.1.4",
+    "@types/node": "^20.17.9",
+    "@typescript-eslint/eslint-plugin": "^8.0.0",
+    "@typescript-eslint/parser": "^8.0.0",
+    "@vitest/runner": "^2.1.9",
+    "allure-vitest": "^3.3.3",
+    "eslint": "^8.57.0",
+    "eslint-config-prettier": "^9.1.0",
+    "eslint-plugin-import": "^2.29.1",
+    "eslint-plugin-jsdoc": "^50.0.0",
+    "eslint-plugin-n": "^17.10.1",
+    "eslint-plugin-no-null": "^1.0.2",
+    "eslint-plugin-prefer-arrow": "^1.2.3",
+    "rimraf": "^6.0.1",
+    "ts-node": "^10.9.2",
+    "tslib": "^2.7.0",
+    "typescript": "^5.6.3"
+  }
+}