@decaf-ts/utils 0.9.6 → 0.10.1

package/lib/esm/tests/TestReporter.d.ts

@@ -0,0 +1,193 @@
+import { MdTableDefinition } from "../utils/md";
+/**
+ * @interface AddAttachParams
+ * @description Parameters for adding an attachment to a report
+ * @summary Interface for attachment parameters
+ * @memberOf module:utils
+ */
+export interface AddAttachParams {
+    attach: string | Buffer;
+    description: string | object;
+    context?: any;
+    bufferFormat?: string;
+}
+/**
+ * @interface AddMsgParams
+ * @description Parameters for adding a message to a report
+ * @summary Interface for message parameters
+ * @memberOf module:utils
+ */
+export interface AddMsgParams {
+    message: string | object;
+    context?: any;
+}
+/**
+ * @typedef {("json"|"image"|"text"|"md")} PayloadType
+ * @description Types of payloads that can be handled
+ * @summary Union type for payload types
+ * @memberOf module:utils
+ */
+export type PayloadType = "json" | "image" | "text" | "md";
+/**
+ * @description Environment variable key for Jest HTML reporters temporary directory path
+ * @summary Constant defining the environment variable key for Jest HTML reporters
+ * @const JestReportersTempPathEnvKey
+ * @memberOf module:utils
+ */
+export declare const JestReportersTempPathEnvKey = "JEST_HTML_REPORTERS_TEMP_DIR_PATH";
+/**
+ * @description Test reporting utility class for managing test results and evidence
+ * @summary A comprehensive test reporter that handles various types of test artifacts including messages,
+ * attachments, data, images, tables, and graphs. It provides methods to report and store test evidence
+ * in different formats and manages dependencies for reporting functionality.
+ *
+ * @template T - Type of data being reported
+ * @param {string} [testCase="tests"] - Name of the test case
+ * @param {string} [basePath] - Base path for storing test reports
+ * @class
+ *
+ * @example
+ * ```typescript
+ * const reporter = new TestReporter('login-test');
+ *
+ * // Report test messages
+ * await reporter.reportMessage('Test Started', 'Login flow initiated');
+ *
+ * // Report test data
+ * await reporter.reportData('user-credentials', { username: 'test' }, 'json');
+ *
+ * // Report test results table
+ * await reporter.reportTable('test-results', {
+ *   headers: ['Step', 'Status'],
+ *   rows: [
+ *     { Step: 'Login', Status: 'Pass' },
+ *     { Step: 'Validation', Status: 'Pass' }
+ *   ]
+ * });
+ *
+ * // Report test evidence
+ * await reporter.reportAttachment('Screenshot', screenshotBuffer);
+ * ```
+ *
+ * @mermaid
+ * sequenceDiagram
+ *   participant Client
+ *   participant TestReporter
+ *   participant FileSystem
+ *   participant Dependencies
+ *
+ *   Client->>TestReporter: new TestReporter(testCase, basePath)
+ *   TestReporter->>FileSystem: Create report directory
+ *
+ *   alt Report Message
+ *     Client->>TestReporter: reportMessage(title, message)
+ *     TestReporter->>Dependencies: Import helpers
+ *     TestReporter->>FileSystem: Store message
+ *   else Report Data
+ *     Client->>TestReporter: reportData(reference, data, type)
+ *     TestReporter->>Dependencies: Process data
+ *     TestReporter->>FileSystem: Store formatted data
+ *   else Report Table
+ *     Client->>TestReporter: reportTable(reference, tableDef)
+ *     TestReporter->>Dependencies: Convert to MD format
+ *     TestReporter->>FileSystem: Store table
+ *   end
+ */
+export declare class TestReporter {
+    protected testCase: string;
+    protected basePath: string;
+    /**
+     * @description Function for adding messages to the test report
+     * @summary Static handler for processing and storing test messages
+     * @type {function(AddMsgParams): Promise<void>}
+     */
+    protected static addMsgFunction: (params: AddMsgParams) => Promise<void>;
+    /**
+     * @description Function for adding attachments to the test report
+     * @summary Static handler for processing and storing test attachments
+     * @type {function(AddAttachParams): Promise<void>}
+     */
+    protected static addAttachFunction: (params: AddAttachParams) => Promise<void>;
+    /**
+     * @description Map of dependencies required by the reporter
+     * @summary Stores the current state of dependencies
+     * @type {SimpleDependencyMap}
+     */
+    private deps?;
+    constructor(testCase?: string, basePath?: string);
+    /**
+     * @description Imports required helper functions
+     * @summary Ensures all necessary dependencies are available and imports helper functions
+     * @return {Promise<void>} Promise that resolves when helpers are imported
+     */
+    private importHelpers;
+    /**
+     * @description Reports a message to the test report
+     * @summary Adds a formatted message to the test report with an optional title
+     * @param {string} title - Title of the message
+     * @param {string | object} message - Content of the message
+     * @return {Promise<void>} Promise that resolves when the message is reported
+     */
+    reportMessage(title: string, message: string | object): Promise<void>;
+    /**
+     * @description Reports an attachment to the test report
+     * @summary Adds a formatted message to the test report with an optional title
+     * @param {string} title - Title of the message
+     * @param {string | Buffer} attachment - Content of the message
+     * @return {Promise<void>} Promise that resolves when the message is reported
+     */
+    reportAttachment(title: string, attachment: string | Buffer): Promise<void>;
+    /**
+     * @description Reports data with specified type
+     * @summary Processes and stores data in the test report with formatting
+     * @param {string} reference - Reference identifier for the data
+     * @param {string | number | object} data - Data to be reported
+     * @param {PayloadType} type - Type of the payload
+     * @param {boolean} [trim=false] - Whether to trim the data
+     * @return {Promise<void>} Promise that resolves when data is reported
+     */
+    protected report(reference: string, data: string | number | object | Buffer, type: PayloadType, trim?: boolean): Promise<void>;
+    /**
+     * @description Reports data with a specified type
+     * @summary Wrapper method for reporting various types of data
+     * @param {string} reference - Reference identifier for the data
+     * @param {string | number | object} data - Data to be reported
+     * @param {PayloadType} [type="json"] - Type of the payload
+     * @param {boolean} [trim=false] - Whether to trim the data
+     * @return {Promise<void>} Promise that resolves when data is reported
+     */
+    reportData(reference: string, data: string | number | object, type?: PayloadType, trim?: boolean): Promise<void>;
+    /**
+     * @description Reports a JSON object
+     * @summary Convenience method for reporting JSON objects
+     * @param {string} reference - Reference identifier for the object
+     * @param {object} json - JSON object to be reported
+     * @param {boolean} [trim=false] - Whether to trim the object
+     * @return {Promise<void>} Promise that resolves when object is reported
+     */
+    reportObject(reference: string, json: object, trim?: boolean): Promise<void>;
+    /**
+     * @description Reports a table in markdown format
+     * @summary Converts and stores a table definition in markdown format
+     * @param {string} reference - Reference identifier for the table
+     * @param {MdTableDefinition} tableDef - Table definition object
+     * @return {Promise<void>} Promise that resolves when table is reported
+     */
+    reportTable(reference: string, tableDef: MdTableDefinition): Promise<void>;
+    /**
+     * @description Reports a graph using Chart.js
+     * @summary Generates and stores a graph visualization
+     * @param {string} reference - Reference identifier for the graph
+     * @param {any} config - Chart.js configuration object
+     * @return {Promise<void>} Promise that resolves when graph is reported
+     */
+    reportGraph(reference: string, config: any): Promise<void>;
+    /**
+     * @description Reports an image to the test report
+     * @summary Stores an image buffer in the test report
+     * @param {string} reference - Reference identifier for the image
+     * @param {Buffer} buffer - Image data buffer
+     * @return {Promise<void>} Promise that resolves when image is reported
+     */
+    reportImage(reference: string, buffer: Buffer): Promise<void>;
+}

package/lib/esm/tests/TestReporter.js

@@ -0,0 +1,260 @@
+import path from "path";
+import fs from "fs";
+import { installIfNotAvailable } from "./../utils/fs.js";
+/**
+ * @description Environment variable key for Jest HTML reporters temporary directory path
+ * @summary Constant defining the environment variable key for Jest HTML reporters
+ * @const JestReportersTempPathEnvKey
+ * @memberOf module:utils
+ */
+export const JestReportersTempPathEnvKey = "JEST_HTML_REPORTERS_TEMP_DIR_PATH";
+/**
+ * @description Array of dependencies required by the test reporter
+ * @summary List of npm packages needed for reporting functionality
+ * @const dependencies
+ * @memberOf module:utils
+ */
+const dependencies = ["jest-html-reporters", "json2md", "chartjs-node-canvas"];
+/**
+ * @description Normalizes imports to handle both CommonJS and ESModule formats
+ * @summary Utility function to handle module import differences between formats
+ * @template T - Type of the imported module
+ * @param {Promise<T>} importPromise - Promise returned by dynamic import
+ * @return {Promise<T>} Normalized module
+ * @function normalizeImport
+ * @memberOf module:utils
+ */
+async function normalizeImport(importPromise) {
+    // CommonJS's `module.exports` is wrapped as `default` in ESModule.
+    return importPromise.then((m) => (m.default || m));
+}
+/**
+ * @description Test reporting utility class for managing test results and evidence
+ * @summary A comprehensive test reporter that handles various types of test artifacts including messages,
+ * attachments, data, images, tables, and graphs. It provides methods to report and store test evidence
+ * in different formats and manages dependencies for reporting functionality.
+ *
+ * @template T - Type of data being reported
+ * @param {string} [testCase="tests"] - Name of the test case
+ * @param {string} [basePath] - Base path for storing test reports
+ * @class
+ *
+ * @example
+ * ```typescript
+ * const reporter = new TestReporter('login-test');
+ *
+ * // Report test messages
+ * await reporter.reportMessage('Test Started', 'Login flow initiated');
+ *
+ * // Report test data
+ * await reporter.reportData('user-credentials', { username: 'test' }, 'json');
+ *
+ * // Report test results table
+ * await reporter.reportTable('test-results', {
+ *   headers: ['Step', 'Status'],
+ *   rows: [
+ *     { Step: 'Login', Status: 'Pass' },
+ *     { Step: 'Validation', Status: 'Pass' }
+ *   ]
+ * });
+ *
+ * // Report test evidence
+ * await reporter.reportAttachment('Screenshot', screenshotBuffer);
+ * ```
+ *
+ * @mermaid
+ * sequenceDiagram
+ *   participant Client
+ *   participant TestReporter
+ *   participant FileSystem
+ *   participant Dependencies
+ *
+ *   Client->>TestReporter: new TestReporter(testCase, basePath)
+ *   TestReporter->>FileSystem: Create report directory
+ *
+ *   alt Report Message
+ *     Client->>TestReporter: reportMessage(title, message)
+ *     TestReporter->>Dependencies: Import helpers
+ *     TestReporter->>FileSystem: Store message
+ *   else Report Data
+ *     Client->>TestReporter: reportData(reference, data, type)
+ *     TestReporter->>Dependencies: Process data
+ *     TestReporter->>FileSystem: Store formatted data
+ *   else Report Table
+ *     Client->>TestReporter: reportTable(reference, tableDef)
+ *     TestReporter->>Dependencies: Convert to MD format
+ *     TestReporter->>FileSystem: Store table
+ *   end
+ */
+export class TestReporter {
+    constructor(testCase = "tests", basePath = path.join(process.cwd(), "workdocs", "reports", "evidences")) {
+        this.testCase = testCase;
+        this.basePath = basePath;
+        this.basePath = path.join(basePath, this.testCase);
+        if (!fs.existsSync(this.basePath)) {
+            fs.mkdirSync(basePath, { recursive: true });
+        }
+    }
+    /**
+     * @description Imports required helper functions
+     * @summary Ensures all necessary dependencies are available and imports helper functions
+     * @return {Promise<void>} Promise that resolves when helpers are imported
+     */
+    async importHelpers() {
+        this.deps = await installIfNotAvailable([dependencies[0]], this.deps);
+        // if (!process.env[JestReportersTempPathEnvKey])
+        //   process.env[JestReportersTempPathEnvKey] = './workdocs/reports';
+        const { addMsg, addAttach } = await normalizeImport(import(`${dependencies[0]}/helper`));
+        TestReporter.addMsgFunction = addMsg;
+        TestReporter.addAttachFunction = addAttach;
+    }
+    /**
+     * @description Reports a message to the test report
+     * @summary Adds a formatted message to the test report with an optional title
+     * @param {string} title - Title of the message
+     * @param {string | object} message - Content of the message
+     * @return {Promise<void>} Promise that resolves when the message is reported
+     */
+    async reportMessage(title, message) {
+        if (!TestReporter.addMsgFunction)
+            await this.importHelpers();
+        const msg = `${title}${message ? `\n${message}` : ""}`;
+        await TestReporter.addMsgFunction({ message: msg });
+    }
+    /**
+     * @description Reports an attachment to the test report
+     * @summary Adds a formatted message to the test report with an optional title
+     * @param {string} title - Title of the message
+     * @param {string | Buffer} attachment - Content of the message
+     * @return {Promise<void>} Promise that resolves when the message is reported
+     */
+    async reportAttachment(title, attachment) {
+        if (!TestReporter.addAttachFunction)
+            await this.importHelpers();
+        await TestReporter.addAttachFunction({
+            attach: attachment,
+            description: title,
+        });
+    }
+    /**
+     * @description Reports data with specified type
+     * @summary Processes and stores data in the test report with formatting
+     * @param {string} reference - Reference identifier for the data
+     * @param {string | number | object} data - Data to be reported
+     * @param {PayloadType} type - Type of the payload
+     * @param {boolean} [trim=false] - Whether to trim the data
+     * @return {Promise<void>} Promise that resolves when data is reported
+     */
+    async report(reference, data, type, trim = false) {
+        try {
+            let attachFunction = this.reportMessage.bind(this);
+            let extension = ".txt";
+            switch (type) {
+                case "image":
+                    data = Buffer.from(data);
+                    extension = ".png";
+                    attachFunction = this.reportAttachment.bind(this);
+                    break;
+                case "json":
+                    if (trim) {
+                        if (data.request)
+                            delete data["request"];
+                        if (data.config)
+                            delete data["config"];
+                    }
+                    data = JSON.stringify(data, null, 2);
+                    extension = ".json";
+                    break;
+                case "md":
+                    extension = ".md";
+                    break;
+                case "text":
+                    extension = ".txt";
+                    break;
+                default:
+                    console.log(`Unsupported type ${type}. assuming text`);
+            }
+            reference = reference.includes("\n")
+                ? reference
+                : `${reference}${extension}`;
+            await attachFunction(reference, data);
+        }
+        catch (e) {
+            throw new Error(`Could not store attach artifact ${reference} under to test report ${this.testCase} - ${e}`);
+        }
+    }
+    /**
+     * @description Reports data with a specified type
+     * @summary Wrapper method for reporting various types of data
+     * @param {string} reference - Reference identifier for the data
+     * @param {string | number | object} data - Data to be reported
+     * @param {PayloadType} [type="json"] - Type of the payload
+     * @param {boolean} [trim=false] - Whether to trim the data
+     * @return {Promise<void>} Promise that resolves when data is reported
+     */
+    async reportData(reference, data, type = "json", trim = false) {
+        return this.report(reference, data, type, trim);
+    }
+    /**
+     * @description Reports a JSON object
+     * @summary Convenience method for reporting JSON objects
+     * @param {string} reference - Reference identifier for the object
+     * @param {object} json - JSON object to be reported
+     * @param {boolean} [trim=false] - Whether to trim the object
+     * @return {Promise<void>} Promise that resolves when object is reported
+     */
+    async reportObject(reference, json, trim = false) {
+        return this.report(reference, json, "json", trim);
+    }
+    /**
+     * @description Reports a table in markdown format
+     * @summary Converts and stores a table definition in markdown format
+     * @param {string} reference - Reference identifier for the table
+     * @param {MdTableDefinition} tableDef - Table definition object
+     * @return {Promise<void>} Promise that resolves when table is reported
+     */
+    async reportTable(reference, tableDef) {
+        this.deps = await installIfNotAvailable([dependencies[1]], this.deps);
+        let txt;
+        try {
+            const json2md = await normalizeImport(import(`${dependencies[1]}`));
+            txt = json2md(tableDef);
+        }
+        catch (e) {
+            throw new Error(`Could not convert JSON to Markdown - ${e}`);
+        }
+        return this.report(reference, txt, "md");
+    }
+    /**
+     * @description Reports a graph using Chart.js
+     * @summary Generates and stores a graph visualization
+     * @param {string} reference - Reference identifier for the graph
+     * @param {any} config - Chart.js configuration object
+     * @return {Promise<void>} Promise that resolves when graph is reported
+     */
+    async reportGraph(reference, config) {
+        this.deps = await installIfNotAvailable([dependencies[2]], this.deps);
+        const { ChartJSNodeCanvas } = await normalizeImport(import(dependencies[2]));
+        const width = 600; //px
+        const height = 800; //px
+        const backgroundColour = "white"; // Uses https://www.w3schools.com/tags/canvas_fillstyle.asp
+        const chartJSNodeCanvas = new ChartJSNodeCanvas({
+            width,
+            height,
+            backgroundColour,
+        });
+        const image = await chartJSNodeCanvas.renderToBuffer(config);
+        return await this.reportImage(reference, image);
+    }
+    /**
+     * @description Reports an image to the test report
+     * @summary Stores an image buffer in the test report
+     * @param {string} reference - Reference identifier for the image
+     * @param {Buffer} buffer - Image data buffer
+     * @return {Promise<void>} Promise that resolves when image is reported
+     */
+    async reportImage(reference, buffer) {
+        return this.report(reference, buffer, "image");
+    }
+}
+//# sourceMappingURL=TestReporter.js.map

package/lib/esm/tests/TestReporter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"TestReporter.js","sourceRoot":"","sources":["../../../src/tests/TestReporter.ts"],"names":[],"mappings":"AAAA,OAAO,IAAI,MAAM,MAAM,CAAC;AACxB,OAAO,EAAE,MAAM,IAAI,CAAC;AACpB,OAAO,EAAE,qBAAqB,EAAE,yBAAoB;AAoCpD;;;;;GAKG;AACH,MAAM,CAAC,MAAM,2BAA2B,GAAG,mCAAmC,CAAC;AAE/E;;;;;GAKG;AACH,MAAM,YAAY,GAAG,CAAC,qBAAqB,EAAE,SAAS,EAAE,qBAAqB,CAAC,CAAC;AAE/E;;;;;;;;GAQG;AACH,KAAK,UAAU,eAAe,CAAI,aAAyB;IACzD,mEAAmE;IACnE,OAAO,aAAa,CAAC,IAAI,CAAC,CAAC,CAAM,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,OAAO,IAAI,CAAC,CAAM,CAAC,CAAC;AAC/D,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAyDG;AACH,MAAM,OAAO,YAAY;IAwBvB,YACY,WAAmB,OAAO,EAC1B,WAAW,IAAI,CAAC,IAAI,CAC5B,OAAO,CAAC,GAAG,EAAE,EACb,UAAU,EACV,SAAS,EACT,WAAW,CACZ;QANS,aAAQ,GAAR,QAAQ,CAAkB;QAC1B,aAAQ,GAAR,QAAQ,CAKjB;QAED,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;QACnD,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC;YAClC,EAAE,CAAC,SAAS,CAAC,QAAQ,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;QAC9C,CAAC;IACH,CAAC;IAED;;;;OAIG;IACK,KAAK,CAAC,aAAa;QACzB,IAAI,CAAC,IAAI,GAAG,MAAM,qBAAqB,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;QACtE,iDAAiD;QACjD,qEAAqE;QACrE,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,GAAG,MAAM,eAAe,CACjD,MAAM,CAAC,GAAG,YAAY,CAAC,CAAC,CAAC,SAAS,CAAC,CACpC,CAAC;QACF,YAAY,CAAC,cAAc,GAAG,MAAM,CAAC;QACrC,YAAY,CAAC,iBAAiB,GAAG,SAAS,CAAC;IAC7C,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,aAAa,CAAC,KAAa,EAAE,OAAwB;QACzD,IAAI,CAAC,YAAY,CAAC,cAAc;YAAE,MAAM,IAAI,CAAC,aAAa,EAAE,CAAC;QAC7D,MAAM,GAAG,GAAG,GAAG,KAAK,GAAG,OAAO,CAAC,CAAC,CAAC,KAAK,OAAO,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC;QACvD,MAAM,YAAY,CAAC,cAAc,CAAC,EAAE,OAAO,EAAE,GAAG,EAAE,CAAC,CAAC;IACtD,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,gBAAgB,CACpB,KAAa,EACb,UAA2B;QAE3B,IAAI,CAAC,YAAY,CAAC,iBAAiB;YAAE,MAAM,IAAI,CAAC,aAAa,EAAE,CAAC;QAChE,MAAM,YAAY,CAAC,iBAAiB,CAAC;YACnC,MAAM,EAAE,UAAU;YAClB,WAAW,EAAE,KAAK;SACnB,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;OAQG;IACO,KAAK,CAAC,MAAM,CACpB,SAAiB,EACjB,IAAuC,EACvC,IAAiB,EACjB,OAAgB,KAAK;QAErB,IAAI,CAAC;YACH,IAAI,cAAc,GAEiB,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACjE,IAAI,SAAS,GAAsC,MAAM,CAAC;YAE1D,QAAQ,IAAI,EAAE,CAAC;gBACb,KAAK,OAAO;oBACV,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,IAAc,CAAC,CAAC;oBACnC,SAAS,GAAG,MAAM,CAAC;oBACnB,cAAc,GAAG,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;oBAClD,MAAM;gBACR,KAAK,MAAM;oBACT,IAAI,IAAI,EAAE,CAAC;wBACT,IAAK,IAA8B,CAAC,OAAO;4BACzC,OAAQ,IAA8B,CAAC,SAAS,CAAC,CAAC;wBACpD,IAAK,IAA6B,CAAC,MAAM;4BACvC,OAAQ,IAA6B,CAAC,QAAQ,CAAC,CAAC;oBACpD,CAAC;oBACD,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;oBACrC,SAAS,GAAG,OAAO,CAAC;oBACpB,MAAM;gBACR,KAAK,IAAI;oBACP,SAAS,GAAG,KAAK,CAAC;oBAClB,MAAM;gBACR,KAAK,MAAM;oBACT,SAAS,GAAG,MAAM,CAAC;oBACnB,MAAM;gBACR;oBACE,OAAO,CAAC,GAAG,CAAC,oBAAoB,IAAI,iBAAiB,CAAC,CAAC;YAC3D,CAAC;YACD,SAAS,GAAG,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC;gBAClC,CAAC,CAAC,SAAS;gBACX,CAAC,CAAC,GAAG,SAAS,GAAG,SAAS,EAAE,CAAC;YAC/B,MAAM,cAAc,CAAC,SAAS,EAAE,IAAuB,CAAC,CAAC;QAC3D,CAAC;QAAC,OAAO,CAAU,EAAE,CAAC;YACpB,MAAM,IAAI,KAAK,CACb,mCAAmC,SAAS,yBAAyB,IAAI,CAAC,QAAQ,MAAM,CAAC,EAAE,CAC5F,CAAC;QACJ,CAAC;IACH,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,UAAU,CACd,SAAiB,EACjB,IAA8B,EAC9B,OAAoB,MAAM,EAC1B,IAAI,GAAG,KAAK;QAEZ,OAAO,IAAI,CAAC,MAAM,CAAC,SAAS,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;IAClD,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,YAAY,CAAC,SAAiB,EAAE,IAAY,EAAE,IAAI,GAAG,KAAK;QAC9D,OAAO,IAAI,CAAC,MAAM,CAAC,SAAS,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,CAAC;IACpD,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,WAAW,CAAC,SAAiB,EAAE,QAA2B;QAC9D,IAAI,CAAC,IAAI,GAAG,MAAM,qBAAqB,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;QACtE,IAAI,GAAW,CAAC;QAChB,IAAI,CAAC;YACH,MAAM,OAAO,GAAG,MAAM,eAAe,CAAC,MAAM,CAAC,GAAG,YAAY,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;YACpE,GAAG,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC;QAC1B,CAAC;QAAC,OAAO,CAAU,EAAE,CAAC;YACpB,MAAM,IAAI,KAAK,CAAC,wCAAwC,CAAC,EAAE,CAAC,CAAC;QAC/D,CAAC;QAED,OAAO,IAAI,CAAC,MAAM,CAAC,SAAS,EAAE,GAAG,EAAE,IAAI,CAAC,CAAC;IAC3C,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,WAAW,CAAC,SAAiB,EAAE,MAAW;QAC9C,IAAI,CAAC,IAAI,GAAG,MAAM,qBAAqB,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;QACtE,MAAM,EAAE,iBAAiB,EAAE,GAAG,MAAM,eAAe,CACjD,MAAM,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CACxB,CAAC;QAEF,MAAM,KAAK,GAAG,GAAG,CAAC,CAAC,IAAI;QACvB,MAAM,MAAM,GAAG,GAAG,CAAC,CAAC,IAAI;QACxB,MAAM,gBAAgB,GAAG,OAAO,CAAC,CAAC,2DAA2D;QAC7F,MAAM,iBAAiB,GAAG,IAAI,iBAAiB,CAAC;YAC9C,KAAK;YACL,MAAM;YACN,gBAAgB;SACjB,CAAC,CAAC;QAEH,MAAM,KAAK,GAAG,MAAM,iBAAiB,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC;QAC7D,OAAO,MAAM,IAAI,CAAC,WAAW,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC;IAClD,CAAC;IACD;;;;;;OAMG;IACH,KAAK,CAAC,WAAW,CAAC,SAAiB,EAAE,MAAc;QACjD,OAAO,IAAI,CAAC,MAAM,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;IACjD,CAAC;CACF"}

package/lib/esm/tests/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./TestReporter";
+export * from "./Consumer";

package/lib/esm/tests/index.js

@@ -0,0 +1,3 @@
+export * from "./TestReporter.js";
+export * from "./Consumer.js";
+//# sourceMappingURL=index.js.map

package/lib/esm/tests/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/tests/index.ts"],"names":[],"mappings":"AAAA,kCAA+B;AAC/B,8BAA2B"}

package/lib/esm/utils/tests.d.ts

@@ -1,193 +1 @@
-import { MdTableDefinition } from "./md";
-/**
- * @interface AddAttachParams
- * @description Parameters for adding an attachment to a report
- * @summary Interface for attachment parameters
- * @memberOf module:utils
- */
-export interface AddAttachParams {
-    attach: string | Buffer;
-    description: string | object;
-    context?: any;
-    bufferFormat?: string;
-}
-/**
- * @interface AddMsgParams
- * @description Parameters for adding a message to a report
- * @summary Interface for message parameters
- * @memberOf module:utils
- */
-export interface AddMsgParams {
-    message: string | object;
-    context?: any;
-}
-/**
- * @typedef {("json"|"image"|"text"|"md")} PayloadType
- * @description Types of payloads that can be handled
- * @summary Union type for payload types
- * @memberOf module:utils
- */
-export type PayloadType = "json" | "image" | "text" | "md";
-/**
- * @description Environment variable key for Jest HTML reporters temporary directory path
- * @summary Constant defining the environment variable key for Jest HTML reporters
- * @const JestReportersTempPathEnvKey
- * @memberOf module:utils
- */
-export declare const JestReportersTempPathEnvKey = "JEST_HTML_REPORTERS_TEMP_DIR_PATH";
-/**
- * @description Test reporting utility class for managing test results and evidence
- * @summary A comprehensive test reporter that handles various types of test artifacts including messages,
- * attachments, data, images, tables, and graphs. It provides methods to report and store test evidence
- * in different formats and manages dependencies for reporting functionality.
- *
- * @template T - Type of data being reported
- * @param {string} [testCase="tests"] - Name of the test case
- * @param {string} [basePath] - Base path for storing test reports
- * @class
- *
- * @example
- * ```typescript
- * const reporter = new TestReporter('login-test');
- *
- * // Report test messages
- * await reporter.reportMessage('Test Started', 'Login flow initiated');
- *
- * // Report test data
- * await reporter.reportData('user-credentials', { username: 'test' }, 'json');
- *
- * // Report test results table
- * await reporter.reportTable('test-results', {
- *   headers: ['Step', 'Status'],
- *   rows: [
- *     { Step: 'Login', Status: 'Pass' },
- *     { Step: 'Validation', Status: 'Pass' }
- *   ]
- * });
- *
- * // Report test evidence
- * await reporter.reportAttachment('Screenshot', screenshotBuffer);
- * ```
- *
- * @mermaid
- * sequenceDiagram
- *   participant Client
- *   participant TestReporter
- *   participant FileSystem
- *   participant Dependencies
- *
- *   Client->>TestReporter: new TestReporter(testCase, basePath)
- *   TestReporter->>FileSystem: Create report directory
- *
- *   alt Report Message
- *     Client->>TestReporter: reportMessage(title, message)
- *     TestReporter->>Dependencies: Import helpers
- *     TestReporter->>FileSystem: Store message
- *   else Report Data
- *     Client->>TestReporter: reportData(reference, data, type)
- *     TestReporter->>Dependencies: Process data
- *     TestReporter->>FileSystem: Store formatted data
- *   else Report Table
- *     Client->>TestReporter: reportTable(reference, tableDef)
- *     TestReporter->>Dependencies: Convert to MD format
- *     TestReporter->>FileSystem: Store table
- *   end
- */
-export declare class TestReporter {
-    protected testCase: string;
-    protected basePath: string;
-    /**
-     * @description Function for adding messages to the test report
-     * @summary Static handler for processing and storing test messages
-     * @type {function(AddMsgParams): Promise<void>}
-     */
-    protected static addMsgFunction: (params: AddMsgParams) => Promise<void>;
-    /**
-     * @description Function for adding attachments to the test report
-     * @summary Static handler for processing and storing test attachments
-     * @type {function(AddAttachParams): Promise<void>}
-     */
-    protected static addAttachFunction: (params: AddAttachParams) => Promise<void>;
-    /**
-     * @description Map of dependencies required by the reporter
-     * @summary Stores the current state of dependencies
-     * @type {SimpleDependencyMap}
-     */
-    private deps?;
-    constructor(testCase?: string, basePath?: string);
-    /**
-     * @description Imports required helper functions
-     * @summary Ensures all necessary dependencies are available and imports helper functions
-     * @return {Promise<void>} Promise that resolves when helpers are imported
-     */
-    private importHelpers;
-    /**
-     * @description Reports a message to the test report
-     * @summary Adds a formatted message to the test report with an optional title
-     * @param {string} title - Title of the message
-     * @param {string | object} message - Content of the message
-     * @return {Promise<void>} Promise that resolves when the message is reported
-     */
-    reportMessage(title: string, message: string | object): Promise<void>;
-    /**
-     * @description Reports an attachment to the test report
-     * @summary Adds a formatted message to the test report with an optional title
-     * @param {string} title - Title of the message
-     * @param {string | Buffer} attachment - Content of the message
-     * @return {Promise<void>} Promise that resolves when the message is reported
-     */
-    reportAttachment(title: string, attachment: string | Buffer): Promise<void>;
-    /**
-     * @description Reports data with specified type
-     * @summary Processes and stores data in the test report with formatting
-     * @param {string} reference - Reference identifier for the data
-     * @param {string | number | object} data - Data to be reported
-     * @param {PayloadType} type - Type of the payload
-     * @param {boolean} [trim=false] - Whether to trim the data
-     * @return {Promise<void>} Promise that resolves when data is reported
-     */
-    protected report(reference: string, data: string | number | object | Buffer, type: PayloadType, trim?: boolean): Promise<void>;
-    /**
-     * @description Reports data with a specified type
-     * @summary Wrapper method for reporting various types of data
-     * @param {string} reference - Reference identifier for the data
-     * @param {string | number | object} data - Data to be reported
-     * @param {PayloadType} [type="json"] - Type of the payload
-     * @param {boolean} [trim=false] - Whether to trim the data
-     * @return {Promise<void>} Promise that resolves when data is reported
-     */
-    reportData(reference: string, data: string | number | object, type?: PayloadType, trim?: boolean): Promise<void>;
-    /**
-     * @description Reports a JSON object
-     * @summary Convenience method for reporting JSON objects
-     * @param {string} reference - Reference identifier for the object
-     * @param {object} json - JSON object to be reported
-     * @param {boolean} [trim=false] - Whether to trim the object
-     * @return {Promise<void>} Promise that resolves when object is reported
-     */
-    reportObject(reference: string, json: object, trim?: boolean): Promise<void>;
-    /**
-     * @description Reports a table in markdown format
-     * @summary Converts and stores a table definition in markdown format
-     * @param {string} reference - Reference identifier for the table
-     * @param {MdTableDefinition} tableDef - Table definition object
-     * @return {Promise<void>} Promise that resolves when table is reported
-     */
-    reportTable(reference: string, tableDef: MdTableDefinition): Promise<void>;
-    /**
-     * @description Reports a graph using Chart.js
-     * @summary Generates and stores a graph visualization
-     * @param {string} reference - Reference identifier for the graph
-     * @param {any} config - Chart.js configuration object
-     * @return {Promise<void>} Promise that resolves when graph is reported
-     */
-    reportGraph(reference: string, config: any): Promise<void>;
-    /**
-     * @description Reports an image to the test report
-     * @summary Stores an image buffer in the test report
-     * @param {string} reference - Reference identifier for the image
-     * @param {Buffer} buffer - Image data buffer
-     * @return {Promise<void>} Promise that resolves when image is reported
-     */
-    reportImage(reference: string, buffer: Buffer): Promise<void>;
-}
+export * from "../tests";