@testomatio/reporter 2.0.0-beta-esm → 2.0.0-beta.1-xml

package/lib/pipe/testomatio.js

@@ -15,12 +15,11 @@ const utils_js_1 = require("../utils/utils.js");
 const pipe_utils_js_1 = require("../utils/pipe_utils.js");
 const config_js_1 = require("../config.js");
 const debug = (0, debug_1.default)('@testomatio/reporter:pipe:testomatio');
-if (process.env.TESTOMATIO_RUN) {
-    // process.env.runId = process.env.TESTOMATIO_RUN;
-}
+if (process.env.TESTOMATIO_RUN)
+    process.env.runId = process.env.TESTOMATIO_RUN;
 /**
- * @typedef {import('../../types').Pipe} Pipe
- * @typedef {import('../../types').TestData} TestData
+ * @typedef {import('../../types/types.js').Pipe} Pipe
+ * @typedef {import('../../types/types.js').TestData} TestData
  * @class TestomatioPipe
  * @implements {Pipe}
  */
@@ -59,11 +58,13 @@ class TestomatioPipe {
         this.axios = axios_1.default.create({
             baseURL: `${this.url.trim()}`,
             timeout: constants_js_1.AXIOS_TIMEOUT,
-            proxy: proxy ? {
-                host: proxy.hostname,
-                port: parseInt(proxy.port, 10),
-                protocol: proxy.protocol,
-            } : false,
+            proxy: proxy
+                ? {
+                    host: proxy.hostname,
+                    port: parseInt(proxy.port, 10),
+                    protocol: proxy.protocol,
+                }
+                : false,
         });
         // Pass the axios instance to the retry function
         (0, axios_retry_1.default)(this.axios, {
@@ -94,9 +95,10 @@ class TestomatioPipe {
         // do not finish this run (for parallel testing)
         this.proceed = process.env.TESTOMATIO_PROCEED;
         this.jiraId = process.env.TESTOMATIO_JIRA_ID;
-        this.runId = params.runId || process.env.runId;
+        this.runId = params.runId || process.env.TESTOMATIO_RUN;
         this.createNewTests = params.createNewTests ?? !!process.env.TESTOMATIO_CREATE;
         this.hasUnmatchedTests = false;
+        this.requestFailures = 0;
         if (!(0, utils_js_1.isValidUrl)(this.url.trim())) {
             this.isEnabled = false;
             console.error(constants_js_1.APP_PREFIX, picocolors_1.default.red(`Error creating report on Testomat.io, report url '${this.url}' is invalid`));
@@ -141,10 +143,9 @@ class TestomatioPipe {
      */
     async createRun(params = {}) {
         this.batch.isEnabled = params.isBatchEnabled ?? this.batch.isEnabled;
-        debug('Creating run...');
         if (!this.isEnabled)
             return;
-        if (this.batch.isEnabled)
+        if (this.batch.isEnabled && this.isEnabled)
             this.batch.intervalFunction = setInterval(this.#batchUpload, this.batch.intervalTime);
         let buildUrl = process.env.BUILD_URL || process.env.CI_JOB_URL || process.env.CIRCLE_BUILD_URL;
         // GitHub Actions Url
@@ -177,12 +178,14 @@ class TestomatioPipe {
         }).filter(([, value]) => !!value));
         debug(' >>>>>> Run params', JSON.stringify(runParams, null, 2));
         if (this.runId) {
+            this.store.runId = this.runId;
             debug(`Run with id ${this.runId} already created, updating...`);
             const resp = await this.axios.put(`/api/reporter/${this.runId}`, runParams);
             if (resp.data.artifacts)
                 (0, pipe_utils_js_1.setS3Credentials)(resp.data.artifacts);
             return;
         }
+        debug('Creating run...');
         try {
             const resp = await this.axios.post(`/api/reporter`, runParams, {
                 maxContentLength: Infinity,
@@ -201,37 +204,39 @@ class TestomatioPipe {
             debug('Run created', this.runId);
         }
         catch (err) {
-            console.error(constants_js_1.APP_PREFIX, 'Error creating Testomat.io report, please check if your API key is valid. Skipping report | ', err?.response?.statusText || err?.status || err.message);
+            const errorText = err.response?.data?.message || err.message;
+            console.log(errorText || err);
+            if (!this.apiKey)
+                console.error('Testomat.io API key is not set');
+            if (!this.apiKey?.startsWith('tstmt'))
+                console.error('Testomat.io API key is invalid');
+            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);
         }
         debug('"createRun" function finished');
     }
     /**
      * Decides whether to skip test reporting in case of too many request failures
-     * @param {TestData} testData
      * @returns {boolean}
      */
-    #cancelTestReportingInCaseOfTooManyReqFailures(testData) {
-        if (this.reportingCanceledDueToReqFailures)
-            return true;
-        const retriesCountWithinTime = this.retriesTimestamps.filter(timestamp => Date.now() - timestamp < constants_js_1.REPORTER_REQUEST_RETRIES.withinTimeSeconds * 1000).length;
-        debug(`${retriesCountWithinTime} failed requests within ${constants_js_1.REPORTER_REQUEST_RETRIES.withinTimeSeconds}s`);
-        if (retriesCountWithinTime > constants_js_1.REPORTER_REQUEST_RETRIES.maxTotalRetries) {
-            const errorMessage = picocolors_1.default.yellow(`${retriesCountWithinTime} requests were failed within ${constants_js_1.REPORTER_REQUEST_RETRIES.withinTimeSeconds}s,\
- reporting for test "${testData.title}" to Testomat is skipped`);
-            console.warn(`${constants_js_1.APP_PREFIX} ${errorMessage}`);
+    #cancelTestReportingInCaseOfTooManyReqFailures() {
+        if (!process.env.TESTOMATIO_MAX_REQUEST_FAILURES)
+            return;
+        const cancelReporting = this.requestFailures >= parseInt(process.env.TESTOMATIO_MAX_REQUEST_FAILURES, 10);
+        if (cancelReporting) {
             this.reportingCanceledDueToReqFailures = true;
-            this.notReportedTestsCount++;
-            return true;
+            let errorMessage = `⚠️ ${process.env.TESTOMATIO_MAX_REQUEST_FAILURES}`;
+            errorMessage += ' requests were failed, reporting to Testomat aborted.';
+            console.warn(`${constants_js_1.APP_PREFIX} ${picocolors_1.default.yellow(errorMessage)}`);
         }
-        return false;
+        return cancelReporting;
     }
     #uploadSingleTest = async (data) => {
         if (!this.isEnabled)
             return;
         if (!this.runId)
             return;
-        if (this.#cancelTestReportingInCaseOfTooManyReqFailures(data))
+        if (this.#cancelTestReportingInCaseOfTooManyReqFailures())
             return;
         data.api_key = this.apiKey;
         data.create = this.createNewTests;
@@ -240,9 +245,9 @@ class TestomatioPipe {
         }
         const json = json_cycle_1.default.stringify(data);
         debug('Adding test', json);
-        return this.axios
-            .post(`/api/reporter/${this.runId}/testrun`, json, axiosAddTestrunRequestConfig)
-            .catch(err => {
+        return this.axios.post(`/api/reporter/${this.runId}/testrun`, json, axiosAddTestrunRequestConfig).catch(err => {
+            this.requestFailures++;
+            this.notReportedTestsCount++;
             if (err.response) {
                 if (err.response.status >= 400) {
                     const responseData = err.response.data || { message: '' };
@@ -266,6 +271,10 @@ class TestomatioPipe {
     #batchUpload = async () => {
         if (!this.batch.isEnabled)
             return;
+        if (!this.batch.tests.length)
+            return;
+        if (this.#cancelTestReportingInCaseOfTooManyReqFailures())
+            return;
         // prevent infinite loop
         if (this.batch.numberOfTimesCalledWithoutTests > 10) {
             debug('📨 Batch upload: no tests to send for 10 times, stopping batch');
@@ -284,6 +293,8 @@ class TestomatioPipe {
         return this.axios
             .post(`/api/reporter/${this.runId}/testrun`, { api_key: this.apiKey, tests: testsToSend, batch_index: this.batch.batchIndex }, axiosAddTestrunRequestConfig)
             .catch(err => {
+            this.requestFailures++;
+            this.notReportedTestsCount += testsToSend.length;
             if (err.response) {
                 if (err.response.status >= 400) {
                     const responseData = err.response.data || { message: '' };
@@ -323,15 +334,21 @@ class TestomatioPipe {
             this.#batchUpload();
     }
     /**
-     * @param {import('../../types').RunData} params
+     * @param {import('../../types/types.js').RunData} params
      * @returns
      */
     async finishRun(params) {
         if (!this.isEnabled)
             return;
-        if (this.batch.intervalFunction)
-            clearInterval(this.batch.intervalFunction);
         await this.#batchUpload();
+        if (this.batch.intervalFunction) {
+            clearInterval(this.batch.intervalFunction);
+            // this code is required in case test is added after run is finished
+            // (e.g. if test has artifacts, add test function will be invoked only after artifacts are uploaded)
+            // batch stops working after run is finished; thus, disable it to use single test uploading
+            this.batch.intervalFunction = null;
+            this.batch.isEnabled = false;
+        }
         debug('Finishing run...');
         if (this.reportingCanceledDueToReqFailures) {
             const errorMessage = picocolors_1.default.red(`⚠️ Due to request failures, ${this.notReportedTestsCount} test(s) were not reported to Testomat.io`);
@@ -351,7 +368,9 @@ class TestomatioPipe {
             if (this.runId && !this.proceed) {
                 await this.axios.put(`/api/reporter/${this.runId}`, {
                     api_key: this.apiKey,
+                    duration: params.duration,
                     status_event,
+                    detach: params.detach,
                     tests: params.tests,
                 });
                 if (this.runUrl) {
@@ -368,17 +387,13 @@ class TestomatioPipe {
             }
             if (this.hasUnmatchedTests) {
                 console.log('');
-                // eslint-disable-next-line max-len
                 console.log(constants_js_1.APP_PREFIX, picocolors_1.default.yellow(picocolors_1.default.bold('⚠️ Some reported tests were not found in Testomat.io project')));
-                // eslint-disable-next-line max-len
                 console.log(constants_js_1.APP_PREFIX, `If you use Testomat.io as a reporter only, please re-run tests using ${picocolors_1.default.bold('TESTOMATIO_CREATE=1')}`);
-                // eslint-disable-next-line max-len
                 console.log(constants_js_1.APP_PREFIX, `But to keep your tests consistent it is recommended to ${picocolors_1.default.bold('import tests first')}`);
                 console.log(constants_js_1.APP_PREFIX, 'If tests were imported but still not matched, assign test IDs to your tests.');
                 console.log(constants_js_1.APP_PREFIX, 'You can do that automatically via command line tools:');
                 console.log(constants_js_1.APP_PREFIX, picocolors_1.default.bold('npx check-tests ... --update-ids'), 'See: https://bit.ly/js-update-ids');
                 console.log(constants_js_1.APP_PREFIX, 'or for Cucumber:');
-                // eslint-disable-next-line max-len
                 console.log(constants_js_1.APP_PREFIX, picocolors_1.default.bold('npx check-cucumber ... --update-ids'), 'See: https://bit.ly/bdd-update-ids');
             }
         }
@@ -400,7 +415,7 @@ function printCreateIssue(err) {
     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'); // eslint-disable-line max-len
+        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)

package/lib/reporter-functions.d.ts

@@ -0,0 +1,34 @@
+declare namespace _default {
+    export { saveArtifact as artifact };
+    export { logMessage as log };
+    export { addStep as step };
+    export { setKeyValue as keyValue };
+}
+export default _default;
+/**
+ * Stores path to file as artifact and uploads it to the S3 storage
+ * @param {string | {path: string, type: string, name: string}} data - path to file or object with path, type and name
+ */
+declare function saveArtifact(data: string | {
+    path: string;
+    type: string;
+    name: string;
+}, context?: any): void;
+/**
+ * Attach log message(s) to the test report
+ * @param  string
+ */
+declare function logMessage(...args: any[]): void;
+/**
+ * Similar to "log" function but marks message in report as a step
+ * @param {string} message
+ */
+declare function addStep(message: string): void;
+/**
+ * Add key-value pair(s) to the test report
+ * @param {{[key: string]: string} | string} keyValue object { key: value } (multiple props allowed) or key (string)
+ * @param {string?} value
+ */
+declare function setKeyValue(keyValue: {
+    [key: string]: string;
+} | string, value?: string | null): void;

package/lib/reporter-functions.js

@@ -1,37 +1,47 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const index_js_1 = require("./services/index.js");
-const playwright_js_1 = require("./adapter/playwright.js");
-if (process.env.PLAYWRIGHT_TEST_BASE_URL)
-    (0, playwright_js_1.initPlaywrightForStorage)();
 /**
  * Stores path to file as artifact and uploads it to the S3 storage
  * @param {string | {path: string, type: string, name: string}} data - path to file or object with path, type and name
  */
 function saveArtifact(data, context = null) {
+    if (process.env.IS_PLAYWRIGHT)
+        throw new Error(`This function is not available in Playwright framework.
+    /Playwright supports artifacts out of the box`);
     if (!data)
         return;
     index_js_1.services.artifacts.put(data, context);
 }
 /**
  * Attach log message(s) to the test report
- * @param  {...any} args
+ * @param  string
  */
 function logMessage(...args) {
+    if (process.env.IS_PLAYWRIGHT)
+        throw new Error('This function is not available in Playwright framework');
     index_js_1.services.logger._templateLiteralLog(...args);
 }
 /**
  * Similar to "log" function but marks message in report as a step
- * @param {*} message
+ * @param {string} message
  */
 function addStep(message) {
+    if (process.env.IS_PLAYWRIGHT)
+        throw new Error('This function is not available in Playwright framework. Use playwright steps');
     index_js_1.services.logger.step(message);
 }
 /**
  * Add key-value pair(s) to the test report
- * @param {*} keyValue
+ * @param {{[key: string]: string} | string} keyValue object { key: value } (multiple props allowed) or key (string)
+ * @param {string?} value
  */
-function setKeyValue(keyValue) {
+function setKeyValue(keyValue, value = null) {
+    if (process.env.IS_PLAYWRIGHT)
+        throw new Error('This function is not available in Playwright framework. Use test tag instead.');
+    if (typeof keyValue === 'string') {
+        keyValue = { [keyValue]: value };
+    }
     index_js_1.services.keyValues.put(keyValue);
 }
 module.exports = {

package/lib/reporter.d.ts

@@ -0,0 +1,232 @@
+export type artifact = typeof import("./reporter-functions.js");
+export const artifact: (data: string | {
+    path: string;
+    type: string;
+    name: string;
+}, context?: any) => void;
+export type log = typeof import("./reporter-functions.js");
+export const log: (...args: any[]) => void;
+export type logger = typeof import("./services/index.js");
+export const logger: {
+    "__#12@#originalUserLogger": {
+        assert(condition?: boolean, ...data: any[]): void;
+        assert(value: any, message?: string, ...optionalParams: any[]): void;
+        clear(): void;
+        clear(): void;
+        count(label?: string): void;
+        count(label?: string): void;
+        countReset(label?: string): void;
+        countReset(label?: string): void;
+        debug(...data: any[]): void;
+        debug(message?: any, ...optionalParams: any[]): void;
+        dir(item?: any, options?: any): void;
+        dir(obj: any, options?: import("util").InspectOptions): void;
+        dirxml(...data: any[]): void;
+        dirxml(...data: any[]): void;
+        error(...data: any[]): void;
+        error(message?: any, ...optionalParams: any[]): void;
+        group(...data: any[]): void;
+        group(...label: any[]): void;
+        groupCollapsed(...data: any[]): void;
+        groupCollapsed(...label: any[]): void;
+        groupEnd(): void;
+        groupEnd(): void;
+        info(...data: any[]): void;
+        info(message?: any, ...optionalParams: any[]): void;
+        log(...data: any[]): void;
+        log(message?: any, ...optionalParams: any[]): void;
+        table(tabularData?: any, properties?: string[]): void;
+        table(tabularData: any, properties?: readonly string[]): void;
+        time(label?: string): void;
+        time(label?: string): void;
+        timeEnd(label?: string): void;
+        timeEnd(label?: string): void;
+        timeLog(label?: string, ...data: any[]): void;
+        timeLog(label?: string, ...data: any[]): void;
+        timeStamp(label?: string): void;
+        timeStamp(label?: string): void;
+        trace(...data: any[]): void;
+        trace(message?: any, ...optionalParams: any[]): void;
+        warn(...data: any[]): void;
+        warn(message?: any, ...optionalParams: any[]): void;
+        Console: console.ConsoleConstructor;
+        profile(label?: string): void;
+        profileEnd(label?: string): void;
+    };
+    "__#12@#userLoggerWithOverridenMethods": any;
+    logLevel: string;
+    step(strings: any, ...values: any[]): void;
+    getLogs(context: string): string[];
+    "__#12@#stringifyLogs"(...args: any[]): string;
+    _templateLiteralLog(strings: any, ...args: any[]): void;
+    "__#12@#logWrapper"(argsArray: any, level: any): void;
+    assert(...args: any[]): void;
+    debug(...args: any[]): void;
+    error(...args: any[]): void;
+    info(...args: any[]): void;
+    log(...args: any[]): void;
+    trace(...args: any[]): void;
+    warn(...args: any[]): void;
+    intercept(userLogger: any): void;
+    stopInterception(): void;
+    configure(config?: {
+        logLevel?: string;
+        prettyObjects?: boolean;
+    }): void;
+    prettyObjects: boolean;
+};
+export type meta = typeof import("./reporter-functions.js");
+export const meta: (keyValue: {
+    [key: string]: string;
+} | string, value?: string | null) => void;
+export type step = typeof import("./reporter-functions.js");
+export const step: (message: string) => void;
+declare namespace _default {
+    let testomatioLogger: {
+        "__#12@#originalUserLogger": {
+            assert(condition?: boolean, ...data: any[]): void;
+            assert(value: any, message?: string, ...optionalParams: any[]): void;
+            clear(): void;
+            clear(): void;
+            count(label?: string): void;
+            count(label?: string): void;
+            countReset(label?: string): void;
+            countReset(label?: string): void;
+            debug(...data: any[]): void;
+            debug(message?: any, ...optionalParams: any[]): void;
+            dir(item?: any, options?: any): void;
+            dir(obj: any, options?: import("util").InspectOptions): void;
+            dirxml(...data: any[]): void;
+            dirxml(...data: any[]): void;
+            error(...data: any[]): void;
+            error(message?: any, ...optionalParams: any[]): void;
+            group(...data: any[]): void;
+            group(...label: any[]): void;
+            groupCollapsed(...data: any[]): void;
+            groupCollapsed(...label: any[]): void;
+            groupEnd(): void;
+            groupEnd(): void;
+            info(...data: any[]): void;
+            info(message?: any, ...optionalParams: any[]): void;
+            log(...data: any[]): void;
+            log(message?: any, ...optionalParams: any[]): void;
+            table(tabularData?: any, properties?: string[]): void;
+            table(tabularData: any, properties?: readonly string[]): void;
+            time(label?: string): void;
+            time(label?: string): void;
+            timeEnd(label?: string): void;
+            timeEnd(label?: string): void;
+            timeLog(label?: string, ...data: any[]): void;
+            timeLog(label?: string, ...data: any[]): void;
+            timeStamp(label?: string): void;
+            timeStamp(label?: string): void;
+            trace(...data: any[]): void;
+            trace(message?: any, ...optionalParams: any[]): void;
+            warn(...data: any[]): void;
+            warn(message?: any, ...optionalParams: any[]): void;
+            Console: console.ConsoleConstructor;
+            profile(label?: string): void;
+            profileEnd(label?: string): void;
+        };
+        "__#12@#userLoggerWithOverridenMethods": any;
+        logLevel: string;
+        step(strings: any, ...values: any[]): void;
+        getLogs(context: string): string[];
+        "__#12@#stringifyLogs"(...args: any[]): string;
+        _templateLiteralLog(strings: any, ...args: any[]): void;
+        "__#12@#logWrapper"(argsArray: any, level: any): void;
+        assert(...args: any[]): void;
+        debug(...args: any[]): void;
+        error(...args: any[]): void;
+        info(...args: any[]): void;
+        log(...args: any[]): void;
+        trace(...args: any[]): void;
+        warn(...args: any[]): void;
+        intercept(userLogger: any): void;
+        stopInterception(): void;
+        configure(config?: {
+            logLevel?: string;
+            prettyObjects?: boolean;
+        }): void;
+        prettyObjects: boolean;
+    };
+    let artifact: (data: string | {
+        path: string;
+        type: string;
+        name: string;
+    }, context?: any) => void;
+    let log: (...args: any[]) => void;
+    let logger: {
+        "__#12@#originalUserLogger": {
+            assert(condition?: boolean, ...data: any[]): void;
+            assert(value: any, message?: string, ...optionalParams: any[]): void;
+            clear(): void;
+            clear(): void;
+            count(label?: string): void;
+            count(label?: string): void;
+            countReset(label?: string): void;
+            countReset(label?: string): void;
+            debug(...data: any[]): void;
+            debug(message?: any, ...optionalParams: any[]): void;
+            dir(item?: any, options?: any): void;
+            dir(obj: any, options?: import("util").InspectOptions): void;
+            dirxml(...data: any[]): void;
+            dirxml(...data: any[]): void;
+            error(...data: any[]): void;
+            error(message?: any, ...optionalParams: any[]): void;
+            group(...data: any[]): void;
+            group(...label: any[]): void;
+            groupCollapsed(...data: any[]): void;
+            groupCollapsed(...label: any[]): void;
+            groupEnd(): void;
+            groupEnd(): void;
+            info(...data: any[]): void;
+            info(message?: any, ...optionalParams: any[]): void;
+            log(...data: any[]): void;
+            log(message?: any, ...optionalParams: any[]): void;
+            table(tabularData?: any, properties?: string[]): void;
+            table(tabularData: any, properties?: readonly string[]): void;
+            time(label?: string): void;
+            time(label?: string): void;
+            timeEnd(label?: string): void;
+            timeEnd(label?: string): void;
+            timeLog(label?: string, ...data: any[]): void;
+            timeLog(label?: string, ...data: any[]): void;
+            timeStamp(label?: string): void;
+            timeStamp(label?: string): void;
+            trace(...data: any[]): void;
+            trace(message?: any, ...optionalParams: any[]): void;
+            warn(...data: any[]): void;
+            warn(message?: any, ...optionalParams: any[]): void;
+            Console: console.ConsoleConstructor;
+            profile(label?: string): void;
+            profileEnd(label?: string): void;
+        };
+        "__#12@#userLoggerWithOverridenMethods": any;
+        logLevel: string;
+        step(strings: any, ...values: any[]): void;
+        getLogs(context: string): string[];
+        "__#12@#stringifyLogs"(...args: any[]): string;
+        _templateLiteralLog(strings: any, ...args: any[]): void;
+        "__#12@#logWrapper"(argsArray: any, level: any): void;
+        assert(...args: any[]): void;
+        debug(...args: any[]): void;
+        error(...args: any[]): void;
+        info(...args: any[]): void;
+        log(...args: any[]): void;
+        trace(...args: any[]): void;
+        warn(...args: any[]): void;
+        intercept(userLogger: any): void;
+        stopInterception(): void;
+        configure(config?: {
+            logLevel?: string;
+            prettyObjects?: boolean;
+        }): void;
+        prettyObjects: boolean;
+    };
+    let meta: (keyValue: {
+        [key: string]: string;
+    } | string, value?: string | null) => void;
+    let step: (message: string) => void;
+}
+export default _default;

package/lib/reporter.js

@@ -1,49 +1,35 @@
 "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;
-};
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.step = exports.meta = exports.logger = exports.log = exports.artifact = void 0;
-const client_js_1 = __importDefault(require("./client.js"));
-const TRConstants = __importStar(require("./constants.js"));
+// import TestomatClient from './client.js';
+// import * as TRConstants from './constants.js';
 const index_js_1 = require("./services/index.js");
 const reporter_functions_js_1 = __importDefault(require("./reporter-functions.js"));
+exports.artifact = reporter_functions_js_1.default.artifact;
+exports.log = reporter_functions_js_1.default.log;
+exports.logger = index_js_1.services.logger;
+exports.meta = reporter_functions_js_1.default.keyValue;
+exports.step = reporter_functions_js_1.default.step;
+/**
+ * @typedef {import('./reporter-functions.js')} artifact
+ * @typedef {import('./reporter-functions.js')} log
+ * @typedef {import('./services/index.js')} logger
+ * @typedef {import('./reporter-functions.js')} meta
+ * @typedef {import('./reporter-functions.js')} step
+ */
 module.exports = {
-    // TODO: deprecate in future; use log or testomat.log
+    /**
+     * @deprecated Use `log` or `testomat.log`
+     */
     testomatioLogger: index_js_1.services.logger,
     artifact: reporter_functions_js_1.default.artifact,
     log: reporter_functions_js_1.default.log,
     logger: index_js_1.services.logger,
     meta: reporter_functions_js_1.default.keyValue,
     step: reporter_functions_js_1.default.step,
-    TestomatClient: client_js_1.default,
-    TRConstants,
+    // TestomatClient,
+    // TRConstants,
 };
-exports.artifact = reporter_functions_js_1.default.artifact;
-exports.log = reporter_functions_js_1.default.log;
-exports.logger = index_js_1.services.logger;
-exports.meta = reporter_functions_js_1.default.keyValue;
-exports.step = reporter_functions_js_1.default.step;

package/lib/services/artifacts.d.ts

@@ -0,0 +1,33 @@
+export const artifactStorage: ArtifactStorage;
+/**
+ * Artifact storage is supposed to store file paths
+ */
+declare class ArtifactStorage {
+    static "__#13@#instance": any;
+    /**
+     * Singleton
+     * @returns {ArtifactStorage}
+     */
+    static getInstance(): ArtifactStorage;
+    /**
+     * Stores path to file as artifact and uploads it to the S3 storage
+     * @param {string | {path: string, type: string, name: string}} data - path to file or object with path, type and name
+     * @param {*} context testId or test title
+     */
+    put(data: string | {
+        path: string;
+        type: string;
+        name: string;
+    }, context?: any): void;
+    /**
+     * Returns list of artifacts to upload
+     * @param {*} context testId or test context from test runner
+     * @returns {(string | {path: string, type: string, name: string})[]}
+     */
+    get(context: any): (string | {
+        path: string;
+        type: string;
+        name: string;
+    })[];
+}
+export {};

package/lib/services/index.d.ts

@@ -0,0 +1,9 @@
+export namespace services {
+    export { logger };
+    export { artifactStorage as artifacts };
+    export { keyValueStorage as keyValues };
+    export function setContext(context: any): void;
+}
+import { logger } from './logger.js';
+import { artifactStorage } from './artifacts.js';
+import { keyValueStorage } from './key-values.js';