@allurereport/charts-api 3.0.0-beta.26 → 3.0.0

package/dist/constants.js

@@ -1,4 +1,4 @@
-import { BarChartType, ChartType, FunnelChartType, TreeMapChartType } from "./types.js";
+import { ChartType } from "./types.js";
 export const DEFAULT_CHART_HISTORY_LIMIT = 10;
 export const defaultChartsConfig = [
     {
@@ -10,57 +10,74 @@ export const defaultChartsConfig = [
         title: "Status dynamics",
     },
     {
-        type: ChartType.Bar,
-        dataType: BarChartType.StatusBySeverity,
-        title: "Test result severities",
+        type: ChartType.TrSeverities,
+        title: "Test results by severities",
+        levels: ["blocker", "critical", "normal", "minor", "trivial"],
+        statuses: ["passed", "failed", "broken", "skipped", "unknown"],
+        includeUnset: true,
     },
     {
-        type: ChartType.Bar,
-        dataType: BarChartType.StatusTrend,
-        title: "Status change dynamics",
+        type: ChartType.StatusTransitions,
+        title: "Status transitions",
     },
     {
-        type: ChartType.Bar,
-        dataType: BarChartType.StatusChangeTrend,
+        type: ChartType.TestBaseGrowthDynamics,
         title: "Test base growth dynamics",
     },
     {
-        type: ChartType.TreeMap,
-        dataType: TreeMapChartType.CoverageDiff,
+        type: ChartType.CoverageDiff,
         title: "Coverage diff map",
     },
     {
-        type: ChartType.TreeMap,
-        dataType: TreeMapChartType.SuccessRateDistribution,
+        type: ChartType.SuccessRateDistribution,
         title: "Success rate distribution",
     },
     {
-        type: ChartType.HeatMap,
+        type: ChartType.ProblemsDistribution,
+        by: "environment",
         title: "Problems distribution by environment",
     },
     {
-        type: ChartType.Bar,
-        dataType: BarChartType.StabilityRateDistribution,
-        title: "Stability rate distribution",
+        type: ChartType.StabilityDistribution,
+        title: "Stability distribution by features",
+        skipStatuses: ["skipped", "unknown"],
+        threshold: 90,
+        groupBy: "feature",
     },
     {
-        type: ChartType.Bar,
-        dataType: BarChartType.DurationsByLayer,
+        type: ChartType.StabilityDistribution,
+        title: "Stability distribution by epics",
+        skipStatuses: ["skipped", "unknown"],
+        threshold: 90,
+        groupBy: "epic",
+    },
+    {
+        type: ChartType.StabilityDistribution,
+        title: "Stability distribution by stories",
+        skipStatuses: ["skipped", "unknown"],
+        threshold: 90,
+        groupBy: "story",
+    },
+    {
+        type: ChartType.Durations,
+        title: "Durations histogram",
+        groupBy: "none",
+    },
+    {
+        type: ChartType.Durations,
         title: "Durations by layer histogram",
+        groupBy: "layer",
     },
     {
-        type: ChartType.Bar,
-        dataType: "performanceTrend",
-        title: "Performance dynamics",
+        type: ChartType.DurationDynamics,
+        title: "Durations dynamics",
     },
     {
-        type: ChartType.Bar,
-        dataType: BarChartType.FbsuAgePyramid,
+        type: ChartType.FBSUAgePyramid,
         title: "FBSU age pyramid",
     },
     {
-        type: ChartType.Funnel,
-        dataType: FunnelChartType.TestingPyramid,
+        type: ChartType.TestingPyramid,
         title: "Testing pyramid",
     },
 ];

package/dist/types.d.ts

@@ -1,33 +1,23 @@
 import type { HistoryDataPoint, SeverityLevel, Statistic, TestResult, TestStatus } from "@allurereport/core-api";
 export declare enum ChartType {
-    Trend = "trend",
     CurrentStatus = "currentStatus",
     StatusDynamics = "statusDynamics",
-    TreeMap = "treemap",
-    HeatMap = "heatmap",
-    Bar = "bar",
-    Funnel = "funnel",
-    ComingSoon = "coming-soon"
+    StatusTransitions = "statusTransitions",
+    StabilityDistribution = "stabilityDistribution",
+    TestBaseGrowthDynamics = "testBaseGrowthDynamics",
+    FBSUAgePyramid = "fbsuAgePyramid",
+    Durations = "durations",
+    DurationDynamics = "durationDynamics",
+    TrSeverities = "testResultSeverities",
+    TestingPyramid = "testingPyramid",
+    CoverageDiff = "coverageDiff",
+    SuccessRateDistribution = "successRateDistribution",
+    ProblemsDistribution = "problemsDistribution"
 }
 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 FunnelChartType {
-    TestingPyramid = "testingPyramid"
-}
-export declare enum TreeMapChartType {
-    SuccessRateDistribution = "successRateDistribution",
-    CoverageDiff = "coverageDiff"
-}
 export declare enum ChartMode {
     Raw = "raw",
     Percent = "percent",
@@ -51,8 +41,9 @@ export interface TrendSlice<Metadata extends BaseTrendSliceMetadata = BaseTrendS
     max: number;
     metadata: TrendSliceMetadata<Metadata>;
 }
+export type PieSliceStatus = TestStatus | "__empty__";
 export interface BasePieSlice {
-    status: TestStatus;
+    status: PieSliceStatus;
     count: number;
 }
 export interface PieSlice extends BasePieSlice {
@@ -62,16 +53,6 @@ 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;
@@ -99,7 +80,7 @@ export type TrendCalculationResult<T extends TrendDataType> = {
     series: Record<T, TrendPointId[]>;
 };
 export interface GenericTrendChartData<SeriesType extends string, Metadata extends BaseTrendSliceMetadata = BaseTrendSliceMetadata> {
-    type: ChartType.Trend;
+    type: "trend";
     dataType: ChartDataType;
     mode: ChartMode;
     title?: string;
@@ -112,52 +93,25 @@ export interface GenericTrendChartData<SeriesType extends string, Metadata exten
 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;
+    type: ChartType.CoverageDiff | ChartType.SuccessRateDistribution;
     title?: string;
     treeMap: TreeMapNode;
 }
 export interface HeatMapChartData<T extends Record<string, any> = {}> {
-    type: ChartType.HeatMap;
+    type: ChartType.ProblemsDistribution;
     title?: string;
     data: HeatMapSerie<T>[];
 }
-export interface ComingSoonChartData {
-    type: ChartType.ComingSoon;
+export interface TestingPyramidChartData {
+    type: ChartType.TestingPyramid;
     title?: string;
-}
-export interface FunnelChartData {
-    type: ChartType.Funnel;
-    dataType: FunnelChartType;
-    title?: string;
-    data: Record<string, number | string>[];
+    data: {
+        layer: string;
+        testCount: number;
+        successRate: number;
+        percentage: number;
+    }[];
 }
 export interface CurrentStatusChartData {
     type: ChartType.CurrentStatus;
@@ -176,16 +130,89 @@ export interface StatusDynamicsChartData {
     limit?: number;
     statuses?: TestStatus[];
 }
-export type GeneratedChartData = TrendChartData | BarChartData | CurrentStatusChartData | StatusDynamicsChartData | ComingSoonChartData | TreeMapChartData | HeatMapChartData | FunnelChartData;
-export type GeneratedChartsData = Record<ChartId, GeneratedChartData>;
-export type TrendChartOptions = {
-    type: ChartType.Trend;
-    dataType: ChartDataType;
-    mode?: ChartMode;
+export interface StatusTransitionsChartData {
+    type: ChartType.StatusTransitions;
     title?: string;
-    limit?: number;
-    metadata?: TrendMetadataFnOverrides;
+    data: {
+        id: string | "current";
+        timestamp: number;
+        prevItemTimestamp: number;
+        fixed: number;
+        regressed: number;
+        malfunctioned: number;
+    }[];
+}
+export interface DurationsChartData {
+    type: ChartType.Durations;
+    title?: string;
+    data: {
+        from: number;
+        to: number;
+        [key: string]: number;
+    }[];
+    keys: {
+        [id: string]: string;
+    };
+    groupBy: "layer" | "none";
+}
+export interface StabilityDistributionChartData {
+    type: ChartType.StabilityDistribution;
+    title?: string;
+    data: {
+        id: string;
+        stabilityRate: number;
+    }[];
+    keys: {
+        [id: string]: string;
+    };
+    threshold?: number;
+}
+export interface TestBaseGrowthDynamicsChartData {
+    type: ChartType.TestBaseGrowthDynamics;
+    title?: string;
+    data: ({
+        [key in `new:${TestStatus}` | `removed:${TestStatus}`]: number;
+    } & {
+        id: string;
+        timestamp: number;
+    })[];
+    statuses: TestStatus[];
+}
+export interface FBSUAgePyramidChartData {
+    type: ChartType.FBSUAgePyramid;
+    title?: string;
+    data: {
+        id: string;
+        timestamp: number;
+        failed: number;
+        broken: number;
+        skipped: number;
+        unknown: number;
+    }[];
+    statuses: Exclude<TestStatus, "passed">[];
+}
+export type TrSeveritiesChartData = {
+    type: ChartType.TrSeverities;
+    title?: string;
+    data: ({
+        id: SeverityLevel | "unset";
+    } & Record<TestStatus, number>)[];
+    levels: (SeverityLevel | "unset")[];
+    statuses: TestStatus[];
 };
+export type DurationDynamicsChartData = {
+    type: ChartType.DurationDynamics;
+    title?: string;
+    data: {
+        id: string;
+        timestamp: number;
+        duration: number;
+        sequentialDuration: number;
+        speedup: number;
+    }[];
+};
+export type GeneratedChartData = TrendChartData | CurrentStatusChartData | StatusDynamicsChartData | StatusTransitionsChartData | DurationsChartData | StabilityDistributionChartData | TestBaseGrowthDynamicsChartData | FBSUAgePyramidChartData | TreeMapChartData | HeatMapChartData | TestingPyramidChartData | TrSeveritiesChartData | DurationDynamicsChartData;
+export type GeneratedChartsData = Record<ChartId, GeneratedChartData>;
 export type CurrentStatusChartOptions = {
     type: ChartType.CurrentStatus;
     title?: string;
@@ -198,34 +225,62 @@ export type StatusDynamicsChartOptions = {
     limit?: number;
     statuses?: TestStatus[];
 };
-export type BarChartOptions = {
-    type: ChartType.Bar;
-    dataType: BarChartType;
-    mode?: ChartMode;
+export type StatusTransitionsChartOptions = {
+    type: ChartType.StatusTransitions;
     title?: string;
     limit?: number;
+};
+export type DurationsChartOptions = {
+    type: ChartType.Durations;
+    title?: string;
+    groupBy?: "layer" | "none";
+};
+export type StabilityDistributionChartOptions = {
+    type: ChartType.StabilityDistribution;
+    title?: string;
     threshold?: number;
+    skipStatuses?: TestStatus[];
+    groupBy?: "feature" | "epic" | "story" | "suite" | "severity" | "owner" | `label-name:${string}`;
+    groupValues?: string[];
 };
-export type TreeMapChartOptions = {
-    type: ChartType.TreeMap;
-    dataType: TreeMapChartType;
+export type TestBaseGrowthDynamicsChartOptions = {
+    type: ChartType.TestBaseGrowthDynamics;
     title?: string;
+    statuses?: TestStatus[];
+    limit?: number;
 };
-export type HeatMapChartOptions = {
-    type: ChartType.HeatMap;
+export type FBSUAgePyramidChartOptions = {
+    type: ChartType.FBSUAgePyramid;
+    title?: string;
+    limit?: number;
+};
+export type TrSeveritiesChartOptions = {
+    type: ChartType.TrSeverities;
     title?: string;
+    levels?: SeverityLevel[];
+    statuses?: TestStatus[];
+    includeUnset?: boolean;
 };
-export type ComingSoonChartOptions = {
-    type: ChartType.ComingSoon;
+export type DurationDynamicsChartOptions = {
+    type: ChartType.DurationDynamics;
     title?: string;
+    limit?: number;
 };
-export type FunnelChartOptions = {
-    type: ChartType.Funnel;
-    dataType: FunnelChartType;
+export type TreeMapChartOptions = {
+    type: ChartType.CoverageDiff | ChartType.SuccessRateDistribution;
+    title?: string;
+};
+export type HeatMapChartOptions = {
+    type: ChartType.ProblemsDistribution;
+    by: "environment";
+    title?: string;
+};
+export type TestingPyramidChartOptions = {
+    type: ChartType.TestingPyramid;
     title?: string;
     layers?: string[];
 };
-export type ChartOptions = TrendChartOptions | CurrentStatusChartOptions | StatusDynamicsChartOptions | BarChartOptions | ComingSoonChartOptions | TreeMapChartOptions | HeatMapChartOptions | FunnelChartOptions;
+export type ChartOptions = CurrentStatusChartOptions | StatusDynamicsChartOptions | DurationsChartOptions | TreeMapChartOptions | HeatMapChartOptions | TestingPyramidChartOptions | StatusTransitionsChartOptions | StabilityDistributionChartOptions | FBSUAgePyramidChartOptions | TestBaseGrowthDynamicsChartOptions | TrSeveritiesChartOptions | DurationDynamicsChartOptions;
 export interface AllureChartsStoreData {
     historyDataPoints: HistoryDataPoint[];
     testResults: TestResult[];
@@ -236,11 +291,6 @@ export interface TrendDataAccessor<T extends TrendDataType> {
     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;
 }

package/dist/types.js

@@ -1,45 +1,27 @@
 export var ChartType;
 (function (ChartType) {
-    ChartType["Trend"] = "trend";
     ChartType["CurrentStatus"] = "currentStatus";
     ChartType["StatusDynamics"] = "statusDynamics";
-    ChartType["TreeMap"] = "treemap";
-    ChartType["HeatMap"] = "heatmap";
-    ChartType["Bar"] = "bar";
-    ChartType["Funnel"] = "funnel";
-    ChartType["ComingSoon"] = "coming-soon";
+    ChartType["StatusTransitions"] = "statusTransitions";
+    ChartType["StabilityDistribution"] = "stabilityDistribution";
+    ChartType["TestBaseGrowthDynamics"] = "testBaseGrowthDynamics";
+    ChartType["FBSUAgePyramid"] = "fbsuAgePyramid";
+    ChartType["Durations"] = "durations";
+    ChartType["DurationDynamics"] = "durationDynamics";
+    ChartType["TrSeverities"] = "testResultSeverities";
+    ChartType["TestingPyramid"] = "testingPyramid";
+    ChartType["CoverageDiff"] = "coverageDiff";
+    ChartType["SuccessRateDistribution"] = "successRateDistribution";
+    ChartType["ProblemsDistribution"] = "problemsDistribution";
 })(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 FunnelChartType;
-(function (FunnelChartType) {
-    FunnelChartType["TestingPyramid"] = "testingPyramid";
-})(FunnelChartType || (FunnelChartType = {}));
-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

@@ -1,6 +1,6 @@
 {
   "name": "@allurereport/charts-api",
-  "version": "3.0.0-beta.26",
+  "version": "3.0.0",
   "description": "Allure Charts API",
   "keywords": [
     "allure",
@@ -27,8 +27,8 @@
     "eslint:format": "eslint --fix ./src/**/*.{js,jsx,ts,tsx}"
   },
   "dependencies": {
-    "@allurereport/core-api": "3.0.0-beta.26",
-    "@allurereport/plugin-api": "3.0.0-beta.26",
+    "@allurereport/core-api": "3.0.0",
+    "@allurereport/plugin-api": "3.0.0",
     "d3-shape": "^3.2.0"
   },
   "devDependencies": {