@testomatio/reporter 2.0.0-beta-esm → 2.0.1-beta-esm

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';

package/lib/services/key-values.d.ts

@@ -0,0 +1,27 @@
+export const keyValueStorage: KeyValueStorage;
+declare class KeyValueStorage {
+    static "__#14@#instance": any;
+    /**
+     *
+     * @returns {KeyValueStorage}
+     */
+    static getInstance(): KeyValueStorage;
+    /**
+     * Stores key-value pair and passes it to reporter
+     * @param {{[key: string]: string}} keyValue - key-value pair(s) as object
+     * @param {*} context - full test title
+     */
+    put(keyValue: {
+        [key: string]: string;
+    }, context?: any): void;
+    /**
+     * Returns key-values pairs for the test as object
+     * @param {*} context testId or test context from test runner
+     * @returns {{[key: string]: string} | {}} key-values pairs as object, e.g. {priority: 'high', browser: 'chrome'}
+     */
+    get(context?: any): {
+        [key: string]: string;
+    } | {};
+    #private;
+}
+export {};

package/lib/services/key-values.js

@@ -21,7 +21,7 @@ class KeyValueStorage {
     }
     /**
      * Stores key-value pair and passes it to reporter
-     * @param {{key: string}} keyValue - key-value pair(s) as object
+     * @param {{[key: string]: string}} keyValue - key-value pair(s) as object
      * @param {*} context - full test title
      */
     put(keyValue, context = null) {

package/lib/services/logger.d.ts

@@ -0,0 +1,64 @@
+export const logger: Logger;
+/**
+ * Logger allows to intercept logs from any logger (console.log, tracer, pino, etc)
+ * and save in the testomatio reporter.
+ * Supports different syntaxes to satisfy any user preferences.
+ */
+declare class Logger {
+    static "__#12@#instance": any;
+    /**
+     *
+     * @returns {Logger}
+     */
+    static getInstance(): Logger;
+    logLevel: string;
+    /**
+     * Allows you to define a step inside a test. Step name is attached to the report and
+     * helps to understand the test flow.
+     * @param {*} strings
+     * @param  {...any} values
+     */
+    step(strings: any, ...values: any[]): void;
+    /**
+     *
+     * @param {string} context testId or test context from test runner
+     * @returns {string[]}
+     */
+    getLogs(context: string): string[];
+    /**
+     * Tagget template literal. Allows to use different syntaxes:
+     * 1. Tagget template: log`text ${someVar}`
+     * 2. Standard: log(`text ${someVar}`)
+     * 3. Standard with multiple arguments: log('text', someVar)
+     */
+    _templateLiteralLog(strings: any, ...args: 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;
+    /**
+     * Intercepts user logger messages.
+     * When call this method, Logger start to control the user logger
+     * @param {*} userLogger
+     */
+    intercept(userLogger: any): void;
+    stopInterception(): void;
+    /**
+     * Allows to configure logger. Make sure you do it before the logger usage in your code.
+     *
+     * @param {Object} [config={}] - The configuration object.
+     * @param {string} [config.logLevel] - The desired log level. Valid values are 'DEBUG', 'INFO', 'WARN', and 'ERROR'.
+     * @param {boolean} [config.prettyObjects] - Specifies whether to enable pretty printing of objects.
+     * @returns {void}
+     */
+    configure(config?: {
+        logLevel?: string;
+        prettyObjects?: boolean;
+    }): void;
+    prettyObjects: boolean;
+    #private;
+}
+export {};