@testomatio/reporter 1.6.13 → 2.0.1-beta-esm

package/lib/services/key-values.js

@@ -1,58 +1,61 @@
-const debug = require('debug')('@testomatio/reporter:services-key-value');
-const { dataStorage } = require('../data-storage');
-
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.keyValueStorage = void 0;
+const debug_1 = __importDefault(require("debug"));
+const data_storage_js_1 = require("../data-storage.js");
+const debug = (0, debug_1.default)('@testomatio/reporter:services-key-value');
 class KeyValueStorage {
-  static #instance;
-
-  /**
-   *
-   * @returns {KeyValueStorage}
-   */
-  static getInstance() {
-    if (!this.#instance) {
-      this.#instance = new KeyValueStorage();
+    static #instance;
+    /**
+     *
+     * @returns {KeyValueStorage}
+     */
+    static getInstance() {
+        if (!this.#instance) {
+            this.#instance = new KeyValueStorage();
+        }
+        return this.#instance;
+    }
+    /**
+     * 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, context = null) {
+        if (!keyValue)
+            return;
+        data_storage_js_1.dataStorage.putData('keyvalue', keyValue, context);
+    }
+    #isKeyValueObject(smth) {
+        return smth && typeof smth === 'object' && !Array.isArray(smth) && smth !== null;
     }
-    return this.#instance;
-  }
-
-  /**
-   * Stores key-value pair and passes it to reporter
-   * @param {{key: string}} keyValue - key-value pair(s) as object
-   * @param {*} context - full test title
-   */
-  put(keyValue, context = null) {
-    if (!keyValue) return;
-    dataStorage.putData('keyvalue', keyValue, context);
-  }
-
-  #isKeyValueObject(smth) {
-    return smth && typeof smth === 'object' && !Array.isArray(smth) && smth !== null;
-  }
-
-  /**
-   * 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 = null) {
-    const keyValuesList = dataStorage.getData('keyvalue', context);
-    if (!keyValuesList || !keyValuesList?.length) return {};
-
-    const keyValues = {};
-    for (const keyValue of keyValuesList) {
-      if (this.#isKeyValueObject(keyValue)) {
-        Object.assign(keyValues, keyValue);
-      } else if (typeof keyValue === 'string') {
-        try {
-          Object.assign(keyValues, JSON.parse(keyValue));
-        } catch (e) {
-          debug(`Error parsing key-values for test ${context}`, keyValue);
+    /**
+     * 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 = null) {
+        const keyValuesList = data_storage_js_1.dataStorage.getData('keyvalue', context);
+        if (!keyValuesList || !keyValuesList?.length)
+            return {};
+        const keyValues = {};
+        for (const keyValue of keyValuesList) {
+            if (this.#isKeyValueObject(keyValue)) {
+                Object.assign(keyValues, keyValue);
+            }
+            else if (typeof keyValue === 'string') {
+                try {
+                    Object.assign(keyValues, JSON.parse(keyValue));
+                }
+                catch (e) {
+                    debug(`Error parsing key-values for test ${context}`, keyValue);
+                }
+            }
         }
-      }
+        return keyValues;
     }
-
-    return keyValues;
-  }
 }
-
-module.exports.keyValueStorage = KeyValueStorage.getInstance();
+exports.keyValueStorage = KeyValueStorage.getInstance();

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 {};