@lokalise/playwright-reporters 1.6.0 → 1.8.0

package/dist/analytics/elastic.d.ts

@@ -17,10 +17,31 @@ export declare class Elastic {
     private readonly elasticToken;
     constructor(analyticsConfig: ElasticConfig);
     setNativeRequestContext(): Promise<void>;
+    /**
+     * This method saves a flaky test data to Elasticsearch.
+     */
     saveFlakyData(flake: ReturnType<typeof formFlakyTestData>): Promise<void>;
+    /**
+     * This method saves a failed test data to Elasticsearch.
+     */
     saveFailedData(failure: ReturnType<typeof formFailedTestData>): Promise<void>;
+    /**
+     * This method saves the test run summary to Elasticsearch.
+     */
     saveBuildData(build: ReturnType<typeof formBuildData>): Promise<void>;
+    /**
+     * This method saves the browser usage data to Elasticsearch.
+     */
     saveBrowserUsageData(usageData: ReturnType<typeof formBrowserUsageData>): Promise<void>;
+    /**
+     * This method retrieves the last test run data from Elasticsearch.
+     * It is used for analytics of the main branch, where the index only contains data from the main branch.
+     */
     getLastRunDataByTime(): Promise<string | null>;
+    /**
+     * This method retrieves the last test run data from Elasticsearch.
+     * It is used for analytics of the feature branches, where the index contains data from all PREnv.
+     * It is therefore necessary to filter the data by the PREnv ID as well as the project name.
+     */
     getLastRunDataByPrenvIdAndProject(prenvId: string, projects?: string[]): Promise<string | null>;
 }

package/dist/analytics/elastic.js

@@ -21,6 +21,9 @@ class Elastic {
             }),
         });
     }
+    /**
+     * This method saves a flaky test data to Elasticsearch.
+     */
     async saveFlakyData(flake) {
         try {
             await this.request.post(`/${this.flakyTestIndex}/_doc`, { data: flake });
@@ -29,6 +32,9 @@ class Elastic {
             (0, logger_1.logger)(error);
         }
     }
+    /**
+     * This method saves a failed test data to Elasticsearch.
+     */
     async saveFailedData(failure) {
         try {
             await this.request.post(`/${this.failedTestIndex}/_doc`, {
@@ -39,6 +45,9 @@ class Elastic {
             (0, logger_1.logger)(error);
         }
     }
+    /**
+     * This method saves the test run summary to Elasticsearch.
+     */
     async saveBuildData(build) {
         try {
             await this.request.post(`/${this.testRunIndex}/_doc`, { data: build });
@@ -47,6 +56,9 @@ class Elastic {
             (0, logger_1.logger)(error);
         }
     }
+    /**
+     * This method saves the browser usage data to Elasticsearch.
+     */
     async saveBrowserUsageData(usageData) {
         try {
             await this.request.post(`/${this.browserUsageIndex}/_doc`, {
@@ -57,6 +69,10 @@ class Elastic {
             (0, logger_1.logger)(error);
         }
     }
+    /**
+     * This method retrieves the last test run data from Elasticsearch.
+     * It is used for analytics of the main branch, where the index only contains data from the main branch.
+     */
     async getLastRunDataByTime() {
         try {
             const response = await this.request.post(`/${this.testRunIndex}/_search`, {
@@ -79,6 +95,11 @@ class Elastic {
             return null;
         }
     }
+    /**
+     * This method retrieves the last test run data from Elasticsearch.
+     * It is used for analytics of the feature branches, where the index contains data from all PREnv.
+     * It is therefore necessary to filter the data by the PREnv ID as well as the project name.
+     */
     async getLastRunDataByPrenvIdAndProject(prenvId, projects) {
         try {
             const response = await this.request.post(`/${this.testRunIndex}/_search`, {

package/dist/analytics/reporter.d.ts

@@ -16,11 +16,21 @@ export default class AnalyticsReporter implements Reporter {
     private readonly isMainPREnv;
     private workerCount;
     constructor(options: ReporterOptions);
+    /**
+     * This method is used to determine if the browser data should be saved for a given test.
+     * The browser data is saved only if the following conditions are met:
+     * - The browserUsageIndex is provided in the options.
+     * - The test project name does not match any of the projects in the ignoreProjects list.
+     * @param test The TestCase for which the browser data is to be saved.
+     */
     private shouldSaveBrowserData;
     onBegin(config: FullConfig, suite: Suite): Promise<this | undefined>;
     onStepBegin(test: TestCase, result: TestResult, step: TestStep): this | undefined;
     onStepEnd(test: TestCase, result: TestResult, step: TestStep): this | undefined;
     onTestEnd(test: TestCase, result: TestResult): Promise<this | undefined>;
+    /**
+     * This method is used to log the analytics data in the console for debugging purposes.
+     */
     private onEndDebug;
     onEnd(result: FullResult): Promise<void>;
 }

package/dist/analytics/reporter.js

@@ -27,6 +27,13 @@ class AnalyticsReporter {
         this.isMainPREnv = (0, helpers_1.isMainPREnv)(options);
         this.elastic = new elastic_1.Elastic(options);
     }
+    /**
+     * This method is used to determine if the browser data should be saved for a given test.
+     * The browser data is saved only if the following conditions are met:
+     * - The browserUsageIndex is provided in the options.
+     * - The test project name does not match any of the projects in the ignoreProjects list.
+     * @param test The TestCase for which the browser data is to be saved.
+     */
     shouldSaveBrowserData(test) {
         const testProjectName = test?.parent?.project()?.name;
         const isIgnoredProject = this.options.ignoreProjects?.some((project) => testProjectName?.includes(project));
@@ -126,6 +133,9 @@ class AnalyticsReporter {
             console.error("Could not perform 'onTestEnd' analytics step", error);
         }
     }
+    /**
+     * This method is used to log the analytics data in the console for debugging purposes.
+     */
     onEndDebug(buildData, browserUsageData) {
         (0, transform_1.calculateRuntime)(this.runStartTime);
         (0, transform_1.calculateRetriedTests)(this.listOfFlakyTests);
@@ -148,6 +158,12 @@ class AnalyticsReporter {
                 }
                 return projectData;
             })();
+            /**
+             * This function is used to get the last stored build data.
+             *
+             * - If the prenvId is provided, it will return the last build data for the given prenvId.
+             * - If the prenvId is not provided, it will return the last build data by time.
+             */
             const getLastBuildData = async () => {
                 if (this.options.prenvId) {
                     const listOfProjectNames = Object.entries(projectData)

package/dist/analytics/transform.d.ts

@@ -2,11 +2,11 @@ import { type FullResult, type TestCase, type TestResult, type TestStep } from '
 import type { TestAnalyticsData, BrowserUsageData } from './report.types';
 import type AnalyticsReporter from './reporter';
 export declare const calculateRuntime: (startTime: number) => void;
-export declare const calculateRetriedTests: (listOfNonPassingTests: AnalyticsReporter['listOfNonPassingTests']) => void;
-export declare const calculateHooksDuration: (steps: TestStep[], hook: 'before' | 'after') => number;
+export declare const calculateRetriedTests: (listOfNonPassingTests: AnalyticsReporter["listOfNonPassingTests"]) => void;
+export declare const calculateHooksDuration: (steps: TestStep[], hook: "before" | "after") => number;
 export declare const getTeamNames: (test: TestCase) => {
     type: string;
-    description?: string | undefined;
+    description?: string;
 }[];
 export declare const formFailedTestData: (test: TestCase, result: TestResult, testRunId: string, prenvId?: string) => {
     prenvId?: string | undefined;
@@ -15,7 +15,7 @@ export declare const formFailedTestData: (test: TestCase, result: TestResult, te
     name: string;
     team: string | null;
     testRunId: string;
-    status: import("playwright/types/test").TestStatus;
+    status: "skipped" | "failed" | "interrupted" | "passed" | "timedOut";
     hooksDuration: number;
     beforeHookDuration: number;
     afterHookDuration: number;
@@ -32,7 +32,7 @@ export declare const formFlakyTestData: (test: TestCase, result: TestResult, tes
     name: string;
     team: string | null;
     testRunId: string;
-    status: import("playwright/types/test").TestStatus;
+    status: "skipped" | "failed" | "interrupted" | "passed" | "timedOut";
     hooksDuration: number;
     beforeHookDuration: number;
     afterHookDuration: number;
@@ -43,7 +43,7 @@ export declare const formFlakyTestData: (test: TestCase, result: TestResult, tes
     };
 };
 export declare const formBuildData: (args: {
-    result: Pick<FullResult, 'status'>;
+    result: Pick<FullResult, "status">;
     startTime: number;
     endTime: number;
     numberOfTests: number;
@@ -71,10 +71,18 @@ export declare const formBuildData: (args: {
     buildId: string;
     prenvId: string | undefined;
 };
-export declare const addTeamCount: (teamStats: TeamStats, ownerTestAnnotations: TestCase['annotations']) => {
+export declare const addTeamCount: (teamStats: TeamStats, ownerTestAnnotations: TestCase["annotations"]) => {
     [x: string]: number;
 };
-export declare const getBuildIdWithPrefix: (lastRunData: string | null, currentBuildId: string) => string;
+/**
+ * This function is used to compute the build id with prefix.
+ * The prefix is required to differentiate between different builds in case the PREnv is reset and the build id starts from 1 again.
+ * The prefix is incremented by 1 when the current build id is less than the last build id.
+ * @param previousBuildId - The last build id with prefix
+ * @param currentBuildId - The current build id without prefix
+ * @returns The new build id with prefix
+ */
+export declare const getBuildIdWithPrefix: (previousBuildId: string | null, currentBuildId: string) => string;
 export declare const formBrowserUsageData: (args: {
     startTime: number;
     testRunId: string;
@@ -92,6 +100,4 @@ export declare const formBrowserUsageData: (args: {
     browserUsageFromRequest: number;
     browserUsageAfterCreation: number;
 };
-type TeamName = string;
-export type TeamStats = Record<TeamName, number>;
-export {};
+export type TeamStats = Record<string, number>;

package/dist/analytics/transform.js

@@ -100,8 +100,18 @@ const addTeamCount = (teamStats, ownerTestAnnotations) => {
     return testOwnerCount;
 };
 exports.addTeamCount = addTeamCount;
-const getBuildIdWithPrefix = (lastRunData, currentBuildId) => {
-    const lastBuildIdWithPrefix = lastRunData ?? '0001-00001';
+/**
+ * This function is used to compute the build id with prefix.
+ * The prefix is required to differentiate between different builds in case the PREnv is reset and the build id starts from 1 again.
+ * The prefix is incremented by 1 when the current build id is less than the last build id.
+ * @param previousBuildId - The last build id with prefix
+ * @param currentBuildId - The current build id without prefix
+ * @returns The new build id with prefix
+ */
+const getBuildIdWithPrefix = (previousBuildId, currentBuildId) => {
+    // If the previous build does not exist, for instance on a new index, the default value is set.
+    const lastBuildIdWithPrefix = previousBuildId ?? '0001-00001';
+    // We are getting the prefix from the last stored build id, or setting the default value.
     const previousPrefix = (() => {
         const defaultPrefix = '0001';
         if (lastBuildIdWithPrefix.includes('-')) {
@@ -109,12 +119,15 @@ const getBuildIdWithPrefix = (lastRunData, currentBuildId) => {
         }
         return defaultPrefix;
     })();
+    // We are getting the last build id from the last stored build id.
     const lastBuildId = (() => {
         if (lastBuildIdWithPrefix.includes('-')) {
             return lastBuildIdWithPrefix.split('-').at(1);
         }
         return lastBuildIdWithPrefix;
     })();
+    // We are comparing the current build id with the last build id.
+    // If the current build id is less than the last build id, we are incrementing the prefix by 1, as it indicates the PREnv reset.
     if (Number(currentBuildId) < Number(lastBuildId)) {
         const newPrefix = String(Number(previousPrefix) + 1).padStart(4, '0');
         return `${newPrefix}-${currentBuildId.padStart(5, '0')}`;
@@ -122,7 +135,6 @@ const getBuildIdWithPrefix = (lastRunData, currentBuildId) => {
     return `${previousPrefix}-${currentBuildId.padStart(5, '0')}`;
 };
 exports.getBuildIdWithPrefix = getBuildIdWithPrefix;
-// eslint-disable-next-line max-statements
 const formBrowserUsageData = (args) => {
     let browserUsageFromRequest = 0;
     let browserUsageAfterCreation = 0;

package/dist/index.d.ts

@@ -1,5 +1,7 @@
 import AnalyticsReporter, { defineAnalyticsReporterConfig } from './analytics/reporter';
+import PermissionsReporter, { definePermissionsReporterConfig } from './permissions/reporter';
 import RetryReporter, { defineRetryReporterConfig } from './retry/reporter';
 import StepDurationReporter, { defineStepDurationReporterConfig } from './stepDuration/reporter';
 import TimelineReporter, { defineTimelineReporterConfig } from './timeline/reporter';
-export { AnalyticsReporter, defineAnalyticsReporterConfig, RetryReporter, defineRetryReporterConfig, TimelineReporter, defineTimelineReporterConfig, StepDurationReporter, defineStepDurationReporterConfig, };
+import TranslationReporter, { defineTranslationReporterConfig } from './translation/reporter';
+export { AnalyticsReporter, defineAnalyticsReporterConfig, RetryReporter, defineRetryReporterConfig, TimelineReporter, defineTimelineReporterConfig, StepDurationReporter, defineStepDurationReporterConfig, PermissionsReporter, definePermissionsReporterConfig, TranslationReporter, defineTranslationReporterConfig, };

package/dist/index.js

@@ -23,16 +23,22 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.defineStepDurationReporterConfig = exports.StepDurationReporter = exports.defineTimelineReporterConfig = exports.TimelineReporter = exports.defineRetryReporterConfig = exports.RetryReporter = exports.defineAnalyticsReporterConfig = exports.AnalyticsReporter = void 0;
+exports.defineTranslationReporterConfig = exports.TranslationReporter = exports.definePermissionsReporterConfig = exports.PermissionsReporter = exports.defineStepDurationReporterConfig = exports.StepDurationReporter = exports.defineTimelineReporterConfig = exports.TimelineReporter = exports.defineRetryReporterConfig = exports.RetryReporter = exports.defineAnalyticsReporterConfig = exports.AnalyticsReporter = void 0;
 const reporter_1 = __importStar(require("./analytics/reporter"));
 exports.AnalyticsReporter = reporter_1.default;
 Object.defineProperty(exports, "defineAnalyticsReporterConfig", { enumerable: true, get: function () { return reporter_1.defineAnalyticsReporterConfig; } });
-const reporter_2 = __importStar(require("./retry/reporter"));
-exports.RetryReporter = reporter_2.default;
-Object.defineProperty(exports, "defineRetryReporterConfig", { enumerable: true, get: function () { return reporter_2.defineRetryReporterConfig; } });
-const reporter_3 = __importStar(require("./stepDuration/reporter"));
-exports.StepDurationReporter = reporter_3.default;
-Object.defineProperty(exports, "defineStepDurationReporterConfig", { enumerable: true, get: function () { return reporter_3.defineStepDurationReporterConfig; } });
-const reporter_4 = __importStar(require("./timeline/reporter"));
-exports.TimelineReporter = reporter_4.default;
-Object.defineProperty(exports, "defineTimelineReporterConfig", { enumerable: true, get: function () { return reporter_4.defineTimelineReporterConfig; } });
+const reporter_2 = __importStar(require("./permissions/reporter"));
+exports.PermissionsReporter = reporter_2.default;
+Object.defineProperty(exports, "definePermissionsReporterConfig", { enumerable: true, get: function () { return reporter_2.definePermissionsReporterConfig; } });
+const reporter_3 = __importStar(require("./retry/reporter"));
+exports.RetryReporter = reporter_3.default;
+Object.defineProperty(exports, "defineRetryReporterConfig", { enumerable: true, get: function () { return reporter_3.defineRetryReporterConfig; } });
+const reporter_4 = __importStar(require("./stepDuration/reporter"));
+exports.StepDurationReporter = reporter_4.default;
+Object.defineProperty(exports, "defineStepDurationReporterConfig", { enumerable: true, get: function () { return reporter_4.defineStepDurationReporterConfig; } });
+const reporter_5 = __importStar(require("./timeline/reporter"));
+exports.TimelineReporter = reporter_5.default;
+Object.defineProperty(exports, "defineTimelineReporterConfig", { enumerable: true, get: function () { return reporter_5.defineTimelineReporterConfig; } });
+const reporter_6 = __importStar(require("./translation/reporter"));
+exports.TranslationReporter = reporter_6.default;
+Object.defineProperty(exports, "defineTranslationReporterConfig", { enumerable: true, get: function () { return reporter_6.defineTranslationReporterConfig; } });

package/dist/permissions/elastic.d.ts

@@ -0,0 +1,13 @@
+import type { PermissionsReportData } from "./reporter";
+export type ElasticOptions = {
+    permissionsIndex: string;
+    elasticUrl: string;
+    elasticToken: string;
+};
+export declare class Elastic {
+    private readonly options;
+    private request;
+    constructor(options: ElasticOptions);
+    setRequestContext(): Promise<void>;
+    savePermissionsData(testData: PermissionsReportData): Promise<void>;
+}

package/dist/permissions/elastic.js

@@ -0,0 +1,28 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Elastic = void 0;
+const test_1 = require("@playwright/test");
+class Elastic {
+    constructor(options) {
+        this.options = options;
+    }
+    async setRequestContext() {
+        this.request = await test_1.request.newContext({
+            baseURL: this.options.elasticUrl,
+            ignoreHTTPSErrors: true,
+            ...(this.options.elasticToken && {
+                extraHTTPHeaders: { Authorization: `ApiKey ${this.options.elasticToken}` },
+            }),
+        });
+    }
+    async savePermissionsData(testData) {
+        try {
+            await this.request.post(`/${this.options.permissionsIndex}/_doc`, { data: testData });
+        }
+        catch (error) {
+            console.error("Failed to save permissions data");
+            console.error(error);
+        }
+    }
+}
+exports.Elastic = Elastic;

package/dist/permissions/reporter.d.ts

@@ -0,0 +1,25 @@
+import type { TestCase, TestResult, Reporter, TestStep } from '@playwright/test/reporter';
+import { type ElasticOptions } from './elastic';
+type ReporterOptions = {
+    annotationName: string;
+    stepName: string;
+    debug: boolean;
+} & ElasticOptions;
+export type PermissionsReportData = {
+    title: string;
+    permissions: Record<string, boolean>;
+    failedStep: string;
+    timestamp: number;
+};
+export default class PermissionsReporter implements Reporter {
+    private readonly options;
+    private readonly elastic;
+    private readonly debugLogging;
+    private failedTestData;
+    constructor(options: ReporterOptions);
+    onBegin(): Promise<void>;
+    onTestEnd(test: TestCase): Promise<void>;
+    onStepEnd(test: TestCase, _result: TestResult, step: TestStep): void;
+}
+export declare const definePermissionsReporterConfig: (options: ConstructorParameters<typeof PermissionsReporter>[0]) => ReporterOptions;
+export {};

package/dist/permissions/reporter.js

@@ -0,0 +1,58 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.definePermissionsReporterConfig = void 0;
+const elastic_1 = require("./elastic");
+// eslint-disable-next-line import/no-default-export
+class PermissionsReporter {
+    constructor(options) {
+        this.elastic = new elastic_1.Elastic(options);
+        this.options = options;
+        this.failedTestData = {};
+        this.debugLogging = options.debug ? console.info : () => { };
+    }
+    async onBegin() {
+        await this.elastic.setRequestContext();
+    }
+    async onTestEnd(test) {
+        // Omit the results if the test is passing
+        if (test.outcome() === 'expected') {
+            this.debugLogging('Not reporting test - test passed');
+            return;
+        }
+        // Omit the results if the test does not contain the annotation
+        if (!test.annotations.find((annotation) => annotation.type === this.options.annotationName)) {
+            this.debugLogging('Not reporting test - no permission annotation');
+            return;
+        }
+        // Test Title
+        const testTitle = test.title;
+        // Permissions as object
+        const testPermissions = test.annotations.find((annotation) => annotation.type === this.options.annotationName);
+        const permissionContents = testPermissions?.description ? JSON.parse(testPermissions.description) : {};
+        // Which step failed
+        const failedStep = this.failedTestData[test.id];
+        // Send payload body
+        const reportData = {
+            title: testTitle,
+            permissions: permissionContents,
+            failedStep,
+            timestamp: Date.now()
+        };
+        await this.elastic.savePermissionsData(reportData);
+    }
+    onStepEnd(test, _result, step) {
+        if (!step.title.includes(this.options.stepName)) {
+            this.debugLogging('Not reporting step - no step annotation', step.title);
+            return;
+        }
+        if (!step.error) {
+            this.debugLogging("Not reporting step - no error");
+            return;
+        }
+        this.debugLogging('Captured step name with error:', step.title);
+        this.failedTestData[test.id] = step.title;
+    }
+}
+exports.default = PermissionsReporter;
+const definePermissionsReporterConfig = (options) => options;
+exports.definePermissionsReporterConfig = definePermissionsReporterConfig;

package/dist/translation/elastic.d.ts

@@ -0,0 +1,15 @@
+import type { BaseTranslationReport } from './reporter';
+export type ElasticOptions = {
+    dryRun: boolean;
+    debug: boolean;
+    translationIndex: string;
+    elasticUrl: string;
+    elasticToken: string;
+};
+export declare class Elastic {
+    private readonly options;
+    private request;
+    constructor(options: ElasticOptions);
+    setRequestContext(): Promise<void>;
+    saveTranslationsData(testData: BaseTranslationReport): Promise<void>;
+}

package/dist/translation/elastic.js

@@ -0,0 +1,32 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Elastic = void 0;
+const node_http2_1 = require("node:http2");
+const test_1 = require("@playwright/test");
+class Elastic {
+    constructor(options) {
+        this.options = options;
+    }
+    async setRequestContext() {
+        this.request = await test_1.request.newContext({
+            baseURL: this.options.elasticUrl,
+            ignoreHTTPSErrors: true,
+            extraHTTPHeaders: {
+                Authorization: `ApiKey ${this.options.elasticToken}`,
+            },
+        });
+    }
+    async saveTranslationsData(testData) {
+        try {
+            const response = await this.request.post(`/${this.options.translationIndex}/_doc`, {
+                data: testData,
+            });
+            (0, test_1.expect)(response.status()).toEqual(node_http2_1.constants.HTTP_STATUS_CREATED);
+        }
+        catch (error) {
+            console.error('Failed to save Shopify translation data');
+            console.error(error);
+        }
+    }
+}
+exports.Elastic = Elastic;

package/dist/translation/reporter.d.ts

@@ -0,0 +1,33 @@
+import type { Reporter, TestCase, TestResult, TestStep } from '@playwright/test/reporter';
+import type { ElasticOptions } from './elastic';
+export declare enum ShopifySteps {
+    importing = "Start IMPORTING content",
+    translating = "Start TRANSLATING content",
+    publishing = "Start PUBLISHING content"
+}
+export type BaseTranslationReport = {
+    totalImportDuration: number;
+    totalTranslationDuration: number;
+    totalPublishDuration: number;
+    totalImportSteps: number;
+    totalTranslationSteps: number;
+    totalPublishingSteps: number;
+    name: string;
+    duration: number;
+    testRunId: string;
+    result: string;
+    timestamp_: number;
+};
+export type TranslationsReportData = {
+    data: Record<string, BaseTranslationReport>;
+};
+export default class TranslationReporter implements Reporter {
+    private readonly elastic;
+    private readonly options;
+    readonly listOfTests: TranslationsReportData;
+    constructor(options: ElasticOptions);
+    onBegin(): Promise<void>;
+    onStepEnd(test: TestCase, result: TestResult, step: TestStep): void;
+    onTestEnd(test: TestCase, result: TestResult): Promise<void>;
+}
+export declare const defineTranslationReporterConfig: (options: ConstructorParameters<typeof TranslationReporter>[0]) => ElasticOptions;

package/dist/translation/reporter.js

@@ -0,0 +1,101 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.defineTranslationReporterConfig = exports.ShopifySteps = void 0;
+const faker_1 = require("@faker-js/faker");
+const elastic_1 = require("./elastic");
+var ShopifySteps;
+(function (ShopifySteps) {
+    ShopifySteps["importing"] = "Start IMPORTING content";
+    ShopifySteps["translating"] = "Start TRANSLATING content";
+    ShopifySteps["publishing"] = "Start PUBLISHING content";
+})(ShopifySteps || (exports.ShopifySteps = ShopifySteps = {}));
+// eslint-disable-next-line import/no-default-export
+class TranslationReporter {
+    constructor(options) {
+        this.options = options;
+        this.listOfTests = { data: {} };
+        this.elastic = new elastic_1.Elastic(options);
+    }
+    async onBegin() {
+        try {
+            if (!this.options.dryRun) {
+                await this.elastic.setRequestContext();
+            }
+        }
+        catch (error) {
+            console.error("Could not perform 'onBegin' analytics step", error);
+        }
+    }
+    // eslint-disable-next-line max-statements
+    onStepEnd(test, result, step) {
+        try {
+            const testProjectName = test?.parent?.project()?.name;
+            if (!testProjectName?.toLowerCase().includes('shopify')) {
+                return;
+            }
+            const stepName = step.title;
+            const testId = `${test.id}-${result.retry ?? 0}`;
+            // Ensure that the data object for this test ID exists
+            if (!this.listOfTests.data[testId]) {
+                this.listOfTests.data[testId] = {
+                    totalImportDuration: 0,
+                    totalPublishDuration: 0,
+                    totalTranslationDuration: 0,
+                    totalImportSteps: 0,
+                    totalTranslationSteps: 0,
+                    totalPublishingSteps: 0,
+                    name: test.title,
+                    duration: 0,
+                    testRunId: faker_1.faker.string.uuid(),
+                    result: '',
+                    timestamp_: 0,
+                };
+            }
+            if (stepName.toLowerCase().includes(ShopifySteps.importing.toLowerCase())) {
+                // Directly accumulate the duration of the importing step
+                this.listOfTests.data[testId].totalImportDuration += step.duration;
+                this.listOfTests.data[testId].totalImportSteps++;
+            }
+            if (stepName.toLowerCase().includes(ShopifySteps.translating.toLowerCase())) {
+                this.listOfTests.data[testId].totalTranslationSteps++;
+                this.listOfTests.data[testId].totalTranslationDuration += step.duration;
+            }
+            if (stepName.toLowerCase().includes(ShopifySteps.publishing.toLowerCase())) {
+                this.listOfTests.data[testId].totalPublishingSteps++;
+                this.listOfTests.data[testId].totalPublishDuration += step.duration;
+            }
+        }
+        catch (error) {
+            console.error("Could not perform 'onStepEnd' analytics step", error);
+        }
+    }
+    async onTestEnd(test, result) {
+        try {
+            const testProjectName = test?.parent?.project()?.name;
+            if (!testProjectName?.toLowerCase().includes('shopify')) {
+                return;
+            }
+            const testId = `${test.id}-${result.retry ?? 0}`;
+            // No need to calculate totalImportDuration here; it's already accumulated
+            this.listOfTests.data[testId] = {
+                ...this.listOfTests.data[testId],
+                timestamp_: result.startTime.getTime(),
+                name: test.title,
+                result: result.status,
+                duration: result.duration,
+            };
+            if (this.options.debug) {
+                console.log(this.listOfTests.data[testId]);
+            }
+            if (!this.options.dryRun) {
+                await this.elastic.saveTranslationsData(this.listOfTests.data[testId]);
+            }
+        }
+        catch (error) {
+            console.error("Could not perform 'onTestEnd' analytics step", error);
+        }
+    }
+}
+exports.default = TranslationReporter;
+const defineTranslationReporterConfig = (options) => options;
+exports.defineTranslationReporterConfig = defineTranslationReporterConfig;

package/dist/translation/tests/transform.test.d.ts

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

package/dist/translation/tests/transform.test.js

@@ -0,0 +1,162 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const test_1 = __importStar(require("@playwright/test"));
+const reporter_1 = __importStar(require("../reporter"));
+test_1.default.describe('TranslationReporter Unit Tests', () => {
+    let reporter;
+    test_1.default.beforeEach(async () => {
+        reporter = new reporter_1.default({
+            dryRun: true, // Use dryRun to prevent requests to Elastic
+            debug: false,
+            elasticToken: '',
+            elasticUrl: '',
+            translationIndex: '',
+        });
+    });
+    test_1.default.describe('onStepEnd', () => {
+        // eslint-disable-next-line max-statements
+        (0, test_1.default)('should correctly accumulate data for importing step', () => {
+            const testCase = {
+                id: 'test-id',
+                title: 'Shopify Import Test',
+                parent: {
+                    project: () => ({ name: 'shopify' }),
+                },
+            };
+            const testResult = {
+                retry: 0,
+            };
+            const testStep1 = {
+                title: reporter_1.ShopifySteps.importing,
+                duration: 50,
+            };
+            const testStep2 = {
+                title: reporter_1.ShopifySteps.importing,
+                duration: 50,
+            };
+            const testStep3 = {
+                title: reporter_1.ShopifySteps.importing,
+                duration: 100,
+            };
+            const testStep4 = {
+                title: reporter_1.ShopifySteps.translating,
+                duration: 300,
+            };
+            const testStep5 = {
+                title: reporter_1.ShopifySteps.translating,
+                duration: 200,
+            };
+            const testStep6 = {
+                title: reporter_1.ShopifySteps.publishing,
+                duration: 600,
+            };
+            reporter.onStepEnd(testCase, testResult, testStep1);
+            reporter.onStepEnd(testCase, testResult, testStep2);
+            reporter.onStepEnd(testCase, testResult, testStep3);
+            reporter.onStepEnd(testCase, testResult, testStep4);
+            reporter.onStepEnd(testCase, testResult, testStep5);
+            reporter.onStepEnd(testCase, testResult, testStep6);
+            const testId = `${testCase.id}-${testResult.retry ?? 0}`;
+            const resultData = reporter.listOfTests.data[testId];
+            (0, test_1.expect)(resultData).toMatchObject({
+                totalImportDuration: 200,
+                totalTranslationDuration: 500,
+                totalPublishDuration: 600,
+                totalImportSteps: 3,
+                totalTranslationSteps: 2,
+                totalPublishingSteps: 1,
+                name: 'Shopify Import Test',
+                duration: 0,
+                testRunId: test_1.expect.any(String),
+                result: '',
+                timestamp_: 0,
+            });
+        });
+        (0, test_1.default)('should not accumulate data for non-Shopify tests', () => {
+            const testCase = {
+                id: 'test-id',
+                title: 'Non-Shopify Test',
+                parent: {
+                    project: () => ({ name: 'other-project' }),
+                },
+            };
+            const testResult = {
+                retry: 0,
+            };
+            const testStep = {
+                title: 'Some Step',
+                duration: 400,
+            };
+            reporter.onStepEnd(testCase, testResult, testStep);
+            const testId = `${testCase.id}-${testResult.retry ?? 0}`;
+            const resultData = reporter.listOfTests.data[testId];
+            (0, test_1.expect)(resultData).toBeUndefined();
+        });
+    });
+    test_1.default.describe('onTestEnd', () => {
+        (0, test_1.default)('should correctly finalize and store test data', async () => {
+            const testCase = {
+                id: 'test-id',
+                title: 'Shopify Final Test',
+                parent: {
+                    project: () => ({ name: 'shopify' }),
+                },
+            };
+            const testResult = {
+                retry: 0,
+                startTime: new Date(),
+                status: 'passed',
+                duration: 600,
+            };
+            await reporter.onTestEnd(testCase, testResult);
+            const testId = `${testCase.id}-${testResult.retry ?? 0}`;
+            const resultData = reporter.listOfTests.data[testId];
+            (0, test_1.expect)(resultData.name).toBe(testCase.title);
+            (0, test_1.expect)(resultData.result).toBe(testResult.status);
+            (0, test_1.expect)(resultData.duration).toBe(testResult.duration);
+            (0, test_1.expect)(resultData.timestamp_).toBe(testResult.startTime.getTime());
+        });
+        (0, test_1.default)('should not store data for non-Shopify tests', async () => {
+            const testCase = {
+                id: 'non-shopify-test-id',
+                title: 'Non-Shopify Test',
+                parent: {
+                    project: () => ({ name: 'other-project' }),
+                },
+            };
+            const testResult = {
+                retry: 0,
+                startTime: new Date(),
+                status: 'passed',
+                duration: 600,
+            };
+            await reporter.onTestEnd(testCase, testResult);
+            const testId = `${testCase.id}-${testResult.retry ?? 0}`;
+            const resultData = reporter.listOfTests.data[testId];
+            (0, test_1.expect)(resultData).toBeUndefined();
+        });
+    });
+});

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@lokalise/playwright-reporters",
-	"version": "1.6.0",
+	"version": "1.8.0",
 	"scripts": {
 		"lint:eslint": "eslint --cache . --ext .js,.cjs,.ts",
 		"lint:ts": "tsc --noEmit",
@@ -41,37 +41,48 @@
 		"./testSimilarity": {
 			"import": "./dist/testSimilarity/reporter.js",
 			"require": "./dist/testSimilarity/reporter.js"
+		},
+		"./permissions": {
+			"import": "./dist/permissions/reporter.js",
+			"require": "./dist/permissions/reporter.js"
+		},
+		"./translation": {
+			"import": "./dist/translation/reporter.js",
+			"require": "./dist/translation/reporter.js"
 		}
 	},
 	"publishConfig": {
 		"access": "public"
 	},
 	"devDependencies": {
-		"@commitlint/cli": "19.2.2",
+		"@commitlint/cli": "19.4.0",
 		"@commitlint/config-conventional": "19.2.2",
-		"@commitlint/prompt-cli": "19.2.2",
-		"@lokalise/eslint-config-frontend": "^4.6.0",
-		"@lokalise/prettier-config": "^1.0.0",
+		"@commitlint/prompt-cli": "19.4.0",
+		"@lokalise/eslint-config-frontend": "^4.6.1",
+		"@lokalise/prettier-config": "^1.0.1",
 		"@semantic-release/changelog": "6.0.3",
-		"@semantic-release/commit-analyzer": "12.0.0",
+		"@semantic-release/commit-analyzer": "13.0.0",
 		"@semantic-release/git": "10.0.1",
-		"@semantic-release/github": "10.0.3",
-		"@semantic-release/npm": "12.0.0",
-		"@semantic-release/release-notes-generator": "13.0.0",
-		"@types/lodash": "^4.17.0",
-		"@types/node": "^20.12.7",
+		"@semantic-release/github": "10.1.6",
+		"@semantic-release/npm": "12.0.1",
+		"@semantic-release/release-notes-generator": "14.0.1",
+		"@types/lodash": "^4.17.7",
+		"@types/node": "^22.3.0",
 		"eslint-config-prettier": "^9.1.0",
-		"eslint-plugin-prettier": "^5.1.3",
-		"husky": "9.0.11",
-		"prettier": "^3.2.5",
-		"semantic-release": "23.0.8",
-		"typescript": "5.4.5"
+		"eslint-plugin-prettier": "^5.2.1",
+		"husky": "9.1.4",
+		"prettier": "^3.3.3",
+		"semantic-release": "24.0.0",
+		"typescript": "5.5.4"
 	},
 	"dependencies": {
 		"@faker-js/faker": "^8.4.1",
-		"@playwright/test": "^1.43.1",
+		"@playwright/test": "^1.46.0",
 		"fastest-levenshtein": "^1.0.16",
 		"lodash": "^4.17.21"
 	},
+	"overrides": {
+		"conventional-changelog-conventionalcommits": ">= 8.0.0"
+	},
 	"prettier": "@lokalise/prettier-config"
 }