@testomatio/reporter 2.5.2 → 2.6.0

package/lib/adapter/playwright.d.ts

@@ -18,4 +18,16 @@ declare class PlaywrightReporter {
  * @returns {string[]} - array of normalized tags with @ prefix
  */
 export function extractTags(test: any): string[];
+/**
+ * Fetches links from stdout. Returns links and filtered stdout (without data containing markers)
+ *
+ * @param {(string | Buffer)[]} stdout
+ * @returns {{ links: { [key: 'test' | 'jira']: string }[], stdout: (string | Buffer)[] }}
+ */
+export function fetchLinksFromLogs(stdout: (string | Buffer)[]): {
+    links: {
+        [key: "test" | "jira"]: string;
+    }[];
+    stdout: (string | Buffer)[];
+};
 import TestomatioClient from '../client.js';

package/lib/adapter/playwright.js

@@ -4,7 +4,8 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.extractTags = extractTags;
-const picocolors_1 = __importDefault(require("picocolors"));
+exports.fetchLinksFromLogs = fetchLinksFromLogs;
+const debug_1 = __importDefault(require("debug"));
 const crypto_1 = __importDefault(require("crypto"));
 const os_1 = __importDefault(require("os"));
 const path_1 = __importDefault(require("path"));
@@ -16,7 +17,9 @@ const utils_js_1 = require("../utils/utils.js");
 const index_js_1 = require("../services/index.js");
 const data_storage_js_1 = require("../data-storage.js");
 const constants_js_2 = require("../utils/constants.js");
+const picocolors_1 = __importDefault(require("picocolors"));
 const reportTestPromises = [];
+const debug = (0, debug_1.default)('@testomatio/reporter:adapter-playwright');
 class PlaywrightReporter {
     constructor(config = {}) {
         this.client = new client_js_1.default({ apiKey: config?.apiKey });
@@ -53,12 +56,23 @@ class PlaywrightReporter {
         const tags = extractTags(test);
         const fullTestTitle = getTestContextName(test);
         let logs = '';
-        if (result.stderr.length || result.stdout.length) {
-            logs = `\n\n${picocolors_1.default.bold('Logs:')}\n${picocolors_1.default.red(result.stderr.join(''))}\n${result.stdout.join('')}`;
+        // get links along with filtered logs (liks related logs removed)
+        const { stdout: filteredStdout, links } = fetchLinksFromLogs(result.stdout);
+        if (filteredStdout?.length || result.stderr?.length) {
+            logs = `\n\n${picocolors_1.default.bold('Logs:')}\n${picocolors_1.default.red(result.stderr.join(''))}\n${filteredStdout.join('')}`;
         }
+        /*
+          All services fucntions work different for Playwright.
+          We don't have access to test title (as result, to test id) when calling this functions inside a test.
+          Thus, when user calls services functions inside a test, we just log this data to console.
+          Playwright intercepts the console.log on it's end and we just get this data from it.
+          Thus, we have a tiny drawback: all data from services functions inside a test will be logged to console.
+          And this requires a condition to be added for each service function – if its Playwright, then log to console.
+    
+          "get" method of services will not return data for Playwright, we should parse stdout.
+        */
         const manuallyAttachedArtifacts = index_js_1.services.artifacts.get(fullTestTitle);
         const testMeta = index_js_1.services.keyValues.get(fullTestTitle);
-        const links = index_js_1.services.links.get(fullTestTitle);
         const rid = test.id || test.testId || (0, uuid_1.v4)();
         /**
          * @type {{
@@ -259,6 +273,73 @@ function extractTags(test) {
 function getTestContextName(test) {
     return `${test._requireFile || ''}_${test.title}`;
 }
+/**
+ * Fetches links from stdout. Returns links and filtered stdout (without data containing markers)
+ *
+ * @param {(string | Buffer)[]} stdout
+ * @returns {{ links: { [key: 'test' | 'jira']: string }[], stdout: (string | Buffer)[] }}
+ */
+function fetchLinksFromLogs(stdout) {
+    const links = [];
+    const markers = [
+        { key: '[TESTOMATIO-LINK-TESTS]', type: 'test' },
+        { key: '[TESTOMATIO-LINK-JIRA]', type: 'jira' },
+    ];
+    const filteredStdout = [];
+    stdout.forEach(entry => {
+        if (typeof entry !== 'string') {
+            filteredStdout.push(entry);
+            return;
+        }
+        // check if entry contains any of markers
+        if (!markers.some(m => entry.includes(m.key))) {
+            filteredStdout.push(entry);
+            return;
+        }
+        const newEntryLines = [];
+        entry.split('\n').forEach(line => {
+            line = line.trim();
+            let hasMarker = false;
+            for (const marker of markers) {
+                if (line.includes(marker.key)) {
+                    hasMarker = true;
+                    try {
+                        const rawJson = line.split(marker.key)[1]?.trim();
+                        if (!rawJson)
+                            continue;
+                        // smart JSON extraction: take until the last ']', otherwise take the whole string
+                        const lastBracketIndex = rawJson.lastIndexOf(']');
+                        const jsonStr = lastBracketIndex !== -1 ? rawJson.substring(0, lastBracketIndex + 1) : rawJson;
+                        // test ids or jira ids
+                        const ids = JSON.parse(jsonStr);
+                        links.push(...ids
+                            // filter non-truthy ids
+                            .filter(id => !!id)
+                            .map(id => ({
+                            // marker type is either 'test' or 'jira'
+                            [marker.type]: id,
+                        })));
+                    }
+                    catch (e) {
+                        debug('Error parsing links from string:', line, '\n', e);
+                    }
+                }
+            }
+            if (!hasMarker && line) {
+                newEntryLines.push(line);
+            }
+        });
+        if (newEntryLines.length) {
+            filteredStdout.push(newEntryLines.join('\n'));
+        }
+    });
+    return {
+        stdout: filteredStdout,
+        links,
+    };
+}
 module.exports = PlaywrightReporter;
 
 module.exports.extractTags = extractTags;
+
+module.exports.fetchLinksFromLogs = fetchLinksFromLogs;

package/lib/bin/cli.js

@@ -73,25 +73,25 @@ program
     .command('run')
     .alias('test')
     .description('Run tests with the specified command')
-    .argument('<command>', 'Test runner command')
+    .argument('[command]', 'Test runner command')
     .option('--filter <filter>', 'Additional execution filter')
     .option('--filter-list <filter>', 'Get a list of all tests by filter before running')
     .option('--kind <type>', 'Specify run type: automated, manual, or mixed')
     .action(async (command, opts) => {
     const apiKey = process.env['INPUT_TESTOMATIO-KEY'] || config_js_1.config.TESTOMATIO;
     const title = process.env.TESTOMATIO_TITLE;
-    if (!command || !command.split) {
-        console.log(constants_js_1.APP_PREFIX, `No command provided. Use -c option to launch a test runner.`);
-        return process.exit(255);
-    }
     const client = new client_js_1.default({ apiKey, title });
     if (opts.filter || opts.filterList) {
+        console.log(constants_js_1.APP_PREFIX, 'Filtering tests...');
         // Example of use: npx @testomatio/reporter run "npx jest" --filter "testomatio:tag-name=frontend"
         // Example of use: npx @testomatio/reporter run "npx jest" --filter "coverage:file=coverage.yml"
         // Example of use: npx @testomatio/reporter run "npx jest" --filter-list "coverage:file=coverage.yml"
         const [pipe, ...optsArray] = opts?.filter ? opts?.filter.split(':') : opts?.filterList.split(':');
         const pipeOptions = optsArray.join(':');
         const prepareRunParams = { pipe, pipeOptions };
+        if (opts.filterList) {
+            client.pipeStore.filterList = true;
+        }
         try {
             const tests = await client.prepareRun(prepareRunParams);
             if (!tests || tests.length === 0) {
@@ -103,16 +103,44 @@ program
             debug(`Execution pattern: "${pattern}"`);
             if (opts.filterList) {
                 console.log(constants_js_1.APP_PREFIX, picocolors_1.default.blue(`Matched test/suite IDs: ${tests.join(', ')}`));
-                console.log(constants_js_1.APP_PREFIX, picocolors_1.default.green(`Full Running Command: ${filteredCommand}`));
+                if (command)
+                    console.log(constants_js_1.APP_PREFIX, picocolors_1.default.green(`Full Running Command: ${filteredCommand}`));
                 return;
             }
-            command = filteredCommand;
+            if (command && command.split) {
+                command = filteredCommand;
+            }
         }
         catch (err) {
             console.log(constants_js_1.APP_PREFIX, err.message || err);
             return;
         }
     }
+    // just create a run (wich tests which match filters) without executing tests
+    if (!command || !command.split) {
+        const createRunParams = {};
+        if (title) {
+            createRunParams.title = title;
+        }
+        if (opts.kind) {
+            createRunParams.kind = opts.kind;
+        }
+        if (apiKey) {
+            await client.createRun(createRunParams);
+            const runId = process.env.TESTOMATIO_RUN || process.env.runId;
+            if (client.pipeStore.runUrl)
+                console.log(constants_js_1.APP_PREFIX, `📊 Report URL: ${picocolors_1.default.magenta(client.pipeStore.runUrl)}`);
+            if (opts.kind !== 'manual') {
+                console.log(constants_js_1.APP_PREFIX, `No command passed, so you need to run tests yourself:`);
+                console.log(constants_js_1.APP_PREFIX, `TESTOMATIO_RUN=${runId} <command>`);
+            }
+        }
+        else {
+            console.log(constants_js_1.APP_PREFIX, '⚠️  No API key provided. Cannot create run without TESTOMATIO key.');
+            process.exit(1);
+        }
+        return process.exit(0);
+    }
     console.log(constants_js_1.APP_PREFIX, `🚀 Running`, picocolors_1.default.green(command));
     const runTests = async () => {
         const testCmds = command.split(' ');

package/lib/pipe/coverage.js

@@ -89,7 +89,7 @@ class CoveragePipe {
                 }
             }
         });
-        // In case if we have all needed data 
+        // In case if we have all needed data
         this.isEnabled = true;
         debug('Coverage Pipe initialized', {
             branch: this.branch,
@@ -110,6 +110,9 @@ class CoveragePipe {
         this.suiteIds.clear();
         this.tagLabels.clear();
         this.results = [];
+        if (this.store) {
+            this.store.coverageConfiguration = undefined;
+        }
         if (!this.isEnabled)
             return [];
         // Step 1: Validate coverage file path & Git changes & Coverage parsing
@@ -117,6 +120,9 @@ class CoveragePipe {
             return [];
         // Step 2: Extract all available tests and compare with coverage file
         const lines = await this.extractRelevantTestsFromChanges();
+        if (this.store?.filterList && lines.size > 0) {
+            console.log(constants_js_1.APP_PREFIX, `Matched files: ${[...lines].join(', ')}`);
+        }
         if (lines.size === 0) {
             console.log(constants_js_1.APP_PREFIX, 'ℹ️  No matching entries in coverage file for provided Git changes.');
             return [];
@@ -134,11 +140,22 @@ class CoveragePipe {
                 tests.forEach(testId => this.tests.add(testId));
             }
         }
-        if (this.tests.size === 0) {
+        if (this.tests.size === 0 && this.suiteIds.size === 0) {
             console.log(constants_js_1.APP_PREFIX, 'ℹ️  No tests found for execution based on Git changes.');
             return [];
         }
-        this.results = [...this.tests];
+        this.results = [...this.tests, ...this.suiteIds];
+        if (this.store) {
+            this.store.coverageConfiguration = {
+                tests: [...this.tests],
+                suites: [...this.suiteIds],
+            };
+            this.store.coverageDescription = this.#buildRunDescription({
+                matchedLines: lines,
+                testsCount: this.tests.size,
+                suitesCount: this.suiteIds.size,
+            });
+        }
         return this.results;
     }
     addTest(data) { }
@@ -230,7 +247,7 @@ class CoveragePipe {
     #buildGitCommand() {
         if (!this.branch)
             throw new Error(`❌ Invalid changes option for setted branch!`);
-        return `git diff ${this.branch} --name-only`; // Example: 'git diff <master> --name-only' 
+        return `git diff ${this.branch} --name-only`; // Example: 'git diff <master> --name-only'
     }
     /**
      * Retrieves the list of files changed in the current Git working directory
@@ -356,7 +373,7 @@ class CoveragePipe {
                         }
                         // Example: "@Sd74099c1"
                         else if (id.startsWith('@S')) {
-                            this.tests.add(id.slice(1));
+                            this.suiteIds.add(id.slice(1));
                         }
                         // Example: "tag:@TestSmoke"
                         else if (id.startsWith('tag')) {
@@ -369,5 +386,46 @@ class CoveragePipe {
         debug(`Matched lines: ${this.matchedLines}`);
         return this.matchedLines;
     }
+    #buildRunDescription({ matchedLines, testsCount, suitesCount }) {
+        const sourceBranch = process.env.GITHUB_HEAD_REF ||
+            process.env.GITHUB_REF_NAME ||
+            process.env.CI_COMMIT_REF_NAME ||
+            this.#getCurrentGitBranch() ||
+            'current branch';
+        const targetBranch = this.branch || 'target branch';
+        const coverageFile = this.coverageFilePath ? path_1.default.basename(this.coverageFilePath) : 'coverage.yml';
+        const updatedFiles = matchedLines && matchedLines.size > 0 ? [...matchedLines] : this.changedFiles;
+        let description = `Changes to **${updatedFiles.length}** files in ${sourceBranch} to ${targetBranch}.\n\n`;
+        if (suitesCount > 0 || testsCount > 0) {
+            const affectedItems = [];
+            if (suitesCount > 0)
+                affectedItems.push(`**${suitesCount} suites**`);
+            if (testsCount > 0)
+                affectedItems.push(`**${testsCount} individual tests**`);
+            description += `May affect ${affectedItems.join(' and ')} which are recommended to be tested for regression.\n\n`; // eslint-disable-line
+        }
+        description += 'Updated source files:\n';
+        if (updatedFiles.length) {
+            description += updatedFiles.map(file => `* \`${file}\``).join('\n');
+            description += '\n\n';
+        }
+        else {
+            description += '* No matched files found\n\n';
+        }
+        description += `Mapping source files to tests set via \`${coverageFile}\` file.`;
+        return description;
+    }
+    #getCurrentGitBranch() {
+        try {
+            const branch = (0, child_process_1.execSync)('git rev-parse --abbrev-ref HEAD', {
+                encoding: 'utf-8',
+                stdio: ['pipe', 'pipe', 'ignore'],
+            }).trim();
+            return branch || undefined;
+        }
+        catch (err) {
+            return undefined;
+        }
+    }
 }
 module.exports = CoveragePipe;

package/lib/pipe/github.js

@@ -153,6 +153,21 @@ class GitHubPipe {
             return text;
         });
         let body = summary;
+        const coverageConfiguration = this.store?.coverageConfiguration;
+        const isManualRun = this.store?.runKind === 'manual';
+        if (isManualRun && coverageConfiguration) {
+            const testsCount = coverageConfiguration.tests?.length || 0;
+            const suitesCount = coverageConfiguration.suites?.length || 0;
+            body += '\n\n<details>\n<summary><h3>🧭 Coverage Scope</h3></summary>\n\n';
+            if (!testsCount && !suitesCount) {
+                body += '- No tests were affected, run disabled\n';
+            }
+            else {
+                body += `- Suites: ${suitesCount}\n`;
+                body += `- Tests: ${testsCount}\n`;
+            }
+            body += '\n</details>';
+        }
         if (failures.length) {
             body += `\n<details>\n<summary><h3>🟥 Failures (${failures.length})</h4></summary>\n\n${failures.join('\n')}\n`;
             if (failures.length > 20) {

package/lib/pipe/testomatio.js

@@ -178,6 +178,9 @@ class TestomatioPipe {
             return;
         if (this.batch.isEnabled && this.isEnabled)
             this.batch.intervalFunction = setInterval(this.#batchUpload, this.batch.intervalTime);
+        if (this.store) {
+            this.store.runKind = params.kind;
+        }
         let buildUrl = process.env.BUILD_URL || process.env.CI_JOB_URL || process.env.CIRCLE_BUILD_URL;
         // GitHub Actions Url
         if (!buildUrl && process.env.GITHUB_RUN_ID) {
@@ -194,6 +197,16 @@ class TestomatioPipe {
         if (buildUrl && !buildUrl.startsWith('http'))
             buildUrl = undefined;
         const accessEvent = process.env.TESTOMATIO_PUBLISH ? 'publish' : null;
+        const coverageConfiguration = this.store?.coverageConfiguration;
+        let description = null;
+        let configuration = null;
+        if (coverageConfiguration && (coverageConfiguration.tests?.length || coverageConfiguration.suites?.length)) {
+            description = this.store?.coverageDescription || null;
+            configuration = {
+                tests: coverageConfiguration.tests?.map(id => id.replace(/^T/, '')) || [],
+                suites: coverageConfiguration.suites?.map(id => id.replace(/^S/, '')) || [],
+            };
+        }
         const runParams = Object.fromEntries(Object.entries({
             ci_build_url: buildUrl,
             api_key: this.apiKey.trim(),
@@ -206,6 +219,8 @@ class TestomatioPipe {
             shared_run: this.sharedRun,
             shared_run_timeout: this.sharedRunTimeout,
             kind: params.kind,
+            configuration,
+            description,
         }).filter(([, value]) => !!value));
         debug(' >>>>>> Run params', JSON.stringify(runParams, null, 2));
         if (this.runId) {
@@ -250,8 +265,10 @@ class TestomatioPipe {
                 console.error('Testomat.io API key is not set');
             if (!this.apiKey?.startsWith('tstmt'))
                 console.error('Testomat.io API key is invalid');
+            if (process.env.DEBUG || process.env.TESTOMATIO_DEBUG)
+                this.#logFailedResponse(err);
             console.error(constants_js_1.APP_PREFIX, 'Error creating Testomat.io report (see details above), please check if your API key is valid. Skipping report');
-            printCreateIssue(err);
+            printCreateIssue();
         }
         debug('"createRun" function finished');
     }
@@ -295,16 +312,8 @@ class TestomatioPipe {
             this.requestFailures++;
             this.notReportedTestsCount++;
             if (err.response) {
-                if (err.response.status >= 400) {
-                    const responseData = err.response.data || { message: '' };
-                    console.log(constants_js_1.APP_PREFIX, picocolors_1.default.yellow(`Warning: ${responseData.message} (${err.response.status})`), picocolors_1.default.gray(data?.title || ''));
-                    if (err.response?.data?.message?.includes('could not be matched')) {
-                        this.hasUnmatchedTests = true;
-                    }
-                    return;
-                }
-                console.log(constants_js_1.APP_PREFIX, picocolors_1.default.yellow(`Warning: ${data?.title || ''} (${err.response?.status})`), `Report couldn't be processed: ${err?.response?.data?.message}`);
-                printCreateIssue(err);
+                this.#logFailedResponse(err);
+                printCreateIssue();
             }
             else {
                 console.log(constants_js_1.APP_PREFIX, picocolors_1.default.blue(data?.title || ''), "Report couldn't be processed", err);
@@ -354,16 +363,8 @@ class TestomatioPipe {
             this.requestFailures++;
             this.notReportedTestsCount += testsToSend.length;
             if (err.response) {
-                if (err.response.status >= 400) {
-                    const responseData = err.response.data || { message: '' };
-                    console.log(constants_js_1.APP_PREFIX, picocolors_1.default.yellow(`Warning: ${responseData.message} (${err.response.status})`));
-                    if (err.response?.data?.message?.includes('could not be matched')) {
-                        this.hasUnmatchedTests = true;
-                    }
-                    return;
-                }
-                console.log(constants_js_1.APP_PREFIX, picocolors_1.default.yellow(`Warning: (${err.response?.status})`), `Report couldn't be processed: ${err?.response?.data?.message}`);
-                printCreateIssue(err);
+                this.#logFailedResponse(err);
+                printCreateIssue();
             }
             else {
                 console.log(constants_js_1.APP_PREFIX, "Report couldn't be processed", err);
@@ -462,32 +463,67 @@ class TestomatioPipe {
         }
         catch (err) {
             console.log(constants_js_1.APP_PREFIX, 'Error updating status, skipping...', err);
-            printCreateIssue(err);
+            if (process.env.DEBUG || process.env.TESTOMATIO_DEBUG)
+                this.#logFailedResponse(err);
+            printCreateIssue();
         }
         debug('Run finished');
     }
+    #logFailedResponse(error) {
+        let responseBody = stringify(error.response?.data ?? error.response ?? error, { pretty: true });
+        if (!responseBody)
+            responseBody = '<empty>';
+        responseBody = hideTestomatioToken(responseBody);
+        const statusCode = error.status || error.code || error.response?.status || '<unknown status code>';
+        const method = error.response?.config.method || '<unknown method>';
+        const url = error.response?.config.url || '<unknown url>';
+        let message = picocolors_1.default.yellow('\n⚠️ Request to Testomat.io failed:\n');
+        message += picocolors_1.default.bold(`${picocolors_1.default.red(statusCode)} ${method} ${url}\n`);
+        message += `\t${picocolors_1.default.bold('response: ')}${picocolors_1.default.gray(responseBody)}\n`;
+        const requestBody = hideTestomatioToken(stringify(error.response?.config?.data));
+        if (process.env.DEBUG || process.env.TESTOMATIO_DEBUG) {
+            message += `\t${picocolors_1.default.bold('request: ')}${picocolors_1.default.gray(requestBody)}\n`;
+        }
+        else {
+            const requestBodyCut = requestBody.slice(0, 1000);
+            message += `\t${picocolors_1.default.bold('request: ')}${picocolors_1.default.gray(`${requestBodyCut}.....`)}\n`;
+            message += '\trequest body is cut, run with TESTOMATIO_DEBUG=1 to see full body\n';
+        }
+        console.log(message);
+        if (error.response?.data?.message?.includes('could not be matched')) {
+            this.hasUnmatchedTests = true;
+        }
+    }
     toString() {
         return 'Testomatio Reporter';
     }
 }
 let registeredErrorHints = false;
-function printCreateIssue(err) {
+function printCreateIssue() {
     if (registeredErrorHints)
         return;
     registeredErrorHints = true;
     process.on('exit', () => {
-        console.log();
-        console.log(constants_js_1.APP_PREFIX, 'There was an error reporting to Testomat.io:');
-        console.log(constants_js_1.APP_PREFIX, 'If you think this is a bug please create an issue: https://github.com/testomatio/reporter/issues/new');
-        console.log(constants_js_1.APP_PREFIX, 'Provide this information:');
-        console.log('Error:', err.message || err.code);
-        if (!err.config)
-            return;
-        const time = new Date().toUTCString();
-        const { body, url, baseURL, method } = err?.config || {};
-        console.log('```js');
-        console.log({ body: body?.replace(/"(tstmt_[^"]+)"/g, 'tstmt_*'), url, baseURL, method, time });
-        console.log('```');
+        console.log(constants_js_1.APP_PREFIX, 'There was an error reporting to Testomat.io.\n', picocolors_1.default.yellow('If you think this is a bug please create an issue: https://github.com/testomatio/reporter/issues/new.'), picocolors_1.default.yellow('Provide the logs from above'));
     });
 }
+/**
+ * Removes Testomatio token from string data
+ *
+ * @param {string} data
+ * @returns {string}
+ */
+function hideTestomatioToken(data) {
+    return data.replace(/"api_key": "[^"]+"/g, '"api_key": "<hidden>"').replace(/"(tstmt_[^"]+)"/g, 'tstmt_***');
+}
+/**
+ * Stringifies provided data
+ *
+ * @param {any} anything
+ * @param {{ pretty: boolean }} opts
+ * @returns {string}
+ */
+function stringify(anything, opts = { pretty: false }) {
+    return typeof anything === 'string' ? anything : JSON.stringify(anything, null, opts.pretty ? 2 : undefined);
+}
 module.exports = TestomatioPipe;

package/lib/reporter-functions.js

@@ -73,6 +73,10 @@ function setLabel(key, value = null) {
  * @returns {void}
  */
 function linkTest(...testIds) {
+    if (helpers_js_1.isPlaywright) {
+        console.log(`[TESTOMATIO-LINK-TESTS] ${JSON.stringify(testIds)}`);
+        return;
+    }
     const links = testIds.map(testId => ({ test: testId }));
     index_js_1.services.links.put(links);
 }
@@ -82,6 +86,10 @@ function linkTest(...testIds) {
  * @returns {void}
  */
 function linkJira(...jiraIds) {
+    if (helpers_js_1.isPlaywright) {
+        console.log(`[TESTOMATIO-LINK-JIRA] ${JSON.stringify(jiraIds)}`);
+        return;
+    }
     const links = jiraIds.map(jiraId => ({ jira: jiraId }));
     index_js_1.services.links.put(links);
 }

package/lib/services/links.d.ts

@@ -15,8 +15,10 @@ declare class LinkStorage {
     /**
      * Returns links array for the test
      * @param {*} context testId or test context from test runner
-     * @returns {object[]} links array, e.g. [{test: 'TEST-123'}, {jira: 'JIRA-456'}]
+     * @returns {{[key: 'test' | 'jira']: string}[]} links array, e.g. [{test: 'TEST-123'}, {jira: 'JIRA-456'}]
      */
-    get(context?: any): object[];
+    get(context?: any): {
+        [key: "test" | "jira"]: string;
+    }[];
 }
 export {};

package/lib/services/links.js

@@ -32,7 +32,7 @@ class LinkStorage {
     /**
      * Returns links array for the test
      * @param {*} context testId or test context from test runner
-     * @returns {object[]} links array, e.g. [{test: 'TEST-123'}, {jira: 'JIRA-456'}]
+     * @returns {{[key: 'test' | 'jira']: string}[]} links array, e.g. [{test: 'TEST-123'}, {jira: 'JIRA-456'}]
      */
     get(context = null) {
         const linksList = data_storage_js_1.dataStorage.getData('links', context);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@testomatio/reporter",
-  "version": "2.5.2",
+  "version": "2.6.0",
   "description": "Testomatio Reporter Client",
   "engines": {
     "node": ">=18"