@allurereport/core-api 3.0.0-beta.8 → 3.0.0

package/dist/aggregate.d.ts

@@ -1,8 +1,16 @@
-export type Statistic = {
+export type DiffStatistic = {
+    regressed?: number;
+    fixed?: number;
+    malfunctioned?: number;
+    new?: number;
+};
+export type Statistic = DiffStatistic & {
     failed?: number;
     broken?: number;
     passed?: number;
     skipped?: number;
     unknown?: number;
     total: number;
+    retries?: number;
+    flaky?: number;
 };

package/dist/ci.d.ts

@@ -0,0 +1,25 @@
+export declare enum CiType {
+    Amazon = "amazon",
+    Azure = "azure",
+    Bitbucket = "bitbucket",
+    Circle = "circle",
+    Drone = "drone",
+    Github = "github",
+    Gitlab = "gitlab",
+    Jenkins = "jenkins",
+    Local = "local"
+}
+export interface CiDescriptor {
+    type: CiType;
+    detected: boolean;
+    repoName: string;
+    jobUid: string;
+    jobUrl: string;
+    jobName: string;
+    jobRunUid: string;
+    jobRunUrl: string;
+    jobRunName: string;
+    jobRunBranch: string;
+    pullRequestName: string;
+    pullRequestUrl: string;
+}

package/dist/ci.js

@@ -0,0 +1,12 @@
+export var CiType;
+(function (CiType) {
+    CiType["Amazon"] = "amazon";
+    CiType["Azure"] = "azure";
+    CiType["Bitbucket"] = "bitbucket";
+    CiType["Circle"] = "circle";
+    CiType["Drone"] = "drone";
+    CiType["Github"] = "github";
+    CiType["Gitlab"] = "gitlab";
+    CiType["Jenkins"] = "jenkins";
+    CiType["Local"] = "local";
+})(CiType || (CiType = {}));

package/dist/config.d.ts

@@ -0,0 +1 @@
+export type DefaultLabelsConfig = Record<string, string | string[]>;

package/dist/config.js

@@ -0,0 +1 @@
+export {};

package/dist/constants.d.ts

@@ -1,6 +1,8 @@
 import type { Statistic } from "./aggregate.js";
-import type { TestStatus } from "./model.js";
-export declare const statusesList: TestStatus[];
+import type { SeverityLevel, TestStatus } from "./model.js";
+export declare const statusesList: readonly TestStatus[];
+export declare const severityLevels: readonly SeverityLevel[];
+export declare const severityLabelName = "severity";
 export declare const unsuccessfulStatuses: Set<TestStatus>;
 export declare const successfulStatuses: Set<TestStatus>;
 export declare const includedInSuccessRate: Set<TestStatus>;

package/dist/constants.js

@@ -1,4 +1,6 @@
 export const statusesList = ["failed", "broken", "passed", "skipped", "unknown"];
+export const severityLevels = ["blocker", "critical", "normal", "minor", "trivial"];
+export const severityLabelName = "severity";
 export const unsuccessfulStatuses = new Set(["failed", "broken"]);
 export const successfulStatuses = new Set(["passed"]);
 export const includedInSuccessRate = new Set([...unsuccessfulStatuses, ...successfulStatuses]);

package/dist/environment.d.ts

@@ -1,4 +1,14 @@
+import type { TestLabel } from "./metadata.js";
 export interface EnvironmentItem {
     name: string;
     values: string[];
 }
+export type ReportVariables = Record<string, string>;
+export type EnvironmentMatcherPayload = {
+    labels: TestLabel[];
+};
+export type EnvironmentDescriptor = {
+    variables?: ReportVariables;
+    matcher: (payload: EnvironmentMatcherPayload) => boolean;
+};
+export type EnvironmentsConfig = Record<string, EnvironmentDescriptor>;

package/dist/history.d.ts

@@ -1,13 +1,19 @@
+import type { TestLabel } from "./metadata.js";
 import type { TestError, TestStatus } from "./model.js";
 export interface HistoryTestResult {
     id: string;
     name: string;
     fullName?: string;
+    environment?: string;
     status: TestStatus;
     error?: TestError;
     start?: number;
     stop?: number;
     duration?: number;
+    labels?: TestLabel[];
+    url: string;
+    historyId?: string;
+    reportLinks?: any[];
 }
 export interface HistoryDataPoint {
     uuid: string;
@@ -16,4 +22,9 @@ export interface HistoryDataPoint {
     knownTestCaseIds: string[];
     testResults: Record<string, HistoryTestResult>;
     metrics: Record<string, number>;
+    url: string;
+}
+export interface AllureHistory {
+    readHistory(branch?: string): Promise<HistoryDataPoint[]>;
+    appendHistory(history: HistoryDataPoint, branch?: string): Promise<void>;
 }

package/dist/index.d.ts

@@ -1,5 +1,6 @@
 export type * from "./aggregate.js";
 export * from "./constants.js";
+export * from "./ci.js";
 export type * from "./environment.js";
 export type * from "./history.js";
 export type * from "./known.js";
@@ -7,6 +8,8 @@ export type * from "./metadata.js";
 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";
@@ -14,3 +17,7 @@ export * from "./utils/comparator.js";
 export * from "./utils/predicate.js";
 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";

package/dist/index.js

@@ -1,7 +1,13 @@
 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";
 export * from "./utils/predicate.js";
 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";

package/dist/model.d.ts

@@ -1,6 +1,8 @@
 import type { TestLabel, TestLink, TestParameter } from "./metadata.js";
 import type { TestCase } from "./testCase.js";
 export type TestStatus = "failed" | "broken" | "passed" | "skipped" | "unknown";
+export type TestStatusTransition = "regressed" | "fixed" | "malfunctioned" | "new";
+export type SeverityLevel = "blocker" | "critical" | "normal" | "minor" | "trivial";
 export interface SourceMetadata {
     readerId: string;
     metadata: {
@@ -19,6 +21,7 @@ export interface TestResult {
     status: TestStatus;
     error?: TestError;
     testCase?: TestCase;
+    environment?: string;
     fullName?: string;
     historyId?: string;
     description?: string;
@@ -33,6 +36,7 @@ export interface TestResult {
     flaky: boolean;
     muted: boolean;
     known: boolean;
+    transition?: TestStatusTransition;
     hidden: boolean;
     hostId?: string;
     threadId?: string;
@@ -43,6 +47,15 @@ export interface TestResult {
     sourceMetadata: SourceMetadata;
     runSelector?: string;
     retries?: TestResult[];
+    categories?: any;
+    titlePath?: string[];
+}
+export interface TestEnvGroup {
+    id: string;
+    name: string;
+    fullName?: string;
+    status: TestStatus;
+    testResultsByEnv: Record<string, string>;
 }
 export interface TestFixtureResult {
     id: string;
@@ -67,7 +80,11 @@ export interface DefaultTestStepResult {
     stop?: number;
     duration?: number;
     steps: TestStepResult[];
+    stepId?: string;
     type: "step";
+    message?: string;
+    trace?: string;
+    hasSimilarErrorInSubSteps?: boolean;
 }
 export interface AttachmentLinkFile {
     id: string;
@@ -97,3 +114,7 @@ export interface AttachmentTestStepResult {
     link: AttachmentLinkExpected | AttachmentLinkLinked | AttachmentLinkInvalid;
     type: "attachment";
 }
+export interface RepoData {
+    name: string;
+    branch: string;
+}

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/environment.d.ts

@@ -0,0 +1,5 @@
+import type { EnvironmentsConfig } from "../environment.js";
+import type { TestEnvGroup, TestResult } from "../model.js";
+export declare const DEFAULT_ENVIRONMENT = "default";
+export declare const matchEnvironment: (envConfig: EnvironmentsConfig, tr: Pick<TestResult, "labels">) => string;
+export declare const getRealEnvsCount: (group: TestEnvGroup) => number;

package/dist/utils/environment.js

@@ -0,0 +1,12 @@
+export const DEFAULT_ENVIRONMENT = "default";
+export const matchEnvironment = (envConfig, tr) => {
+    return (Object.entries(envConfig).find(([, { matcher }]) => matcher({ labels: tr.labels }))?.[0] ?? DEFAULT_ENVIRONMENT);
+};
+export const getRealEnvsCount = (group) => {
+    const { testResultsByEnv = {} } = group ?? {};
+    const envsCount = Object.keys(testResultsByEnv).length ?? 0;
+    if (envsCount <= 1 && DEFAULT_ENVIRONMENT in testResultsByEnv) {
+        return 0;
+    }
+    return envsCount;
+};

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/status.d.ts

@@ -0,0 +1,4 @@
+import type { TestStatus } from "../model.js";
+export declare const StatusByPriority: TestStatus[];
+export declare const statusToPriority: (status: TestStatus | undefined) => number;
+export declare const getWorstStatus: (items: TestStatus[]) => TestStatus | undefined;

package/dist/utils/status.js

@@ -0,0 +1,13 @@
+export const StatusByPriority = ["failed", "broken", "passed", "skipped", "unknown"];
+export const statusToPriority = (status) => {
+    if (!status) {
+        return -1;
+    }
+    return StatusByPriority.indexOf(status);
+};
+export const getWorstStatus = (items) => {
+    if (items.length === 0) {
+        return;
+    }
+    return items.sort((a, b) => statusToPriority(a) - statusToPriority(b))[0];
+};

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.8",
+  "version": "3.0.0",
   "description": "Allure Core API",
   "keywords": [
     "allure"
@@ -25,14 +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.8",
-    "allure-vitest": "^3.0.9",
+    "@vitest/runner": "^2.1.9",
+    "@vitest/snapshot": "^2.1.9",
+    "allure-vitest": "^3.3.3",
     "eslint": "^8.57.0",
     "eslint-config-prettier": "^9.1.0",
     "eslint-plugin-import": "^2.29.1",
@@ -42,6 +47,6 @@
     "eslint-plugin-prefer-arrow": "^1.2.3",
     "rimraf": "^6.0.1",
     "typescript": "^5.6.3",
-    "vitest": "^2.1.8"
+    "vitest": "^2.1.9"
   }
 }