sefiutils 1.3.2 → 1.4.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "sefiutils",
-  "version": "1.3.2",
+  "version": "1.4.0",
   "description": "Utilities (and Jest/Vitest tests) for Selenium Webdriver Tests and some React tools as well",
   "author": "Jens von Pilgrim <jens.vonpilgrim@bht-berlin.de>",
   "license": "EPL-2.0",

package/src/seUtils.ts

@@ -116,14 +116,22 @@ export async function waitFor<T>(callback: () => Promise<T>, timeout = 1000, int
 /**
  * Takes screenshot of current window and saves it to the given file.
  * The folder is created if it does not yet exists.
+ * 
+ * @param fileName the file name to save the screenshot to, e.g. "screenshots/test.png", if null or empty, no screenshot is saved.
+ * @param pngProcessor optional function to process the png data, e.g., for creating a hash (or comparision with a reference png). The png data is given as base64 string.
  */
-export async function saveScreenshot(driver: WebDriver, fileName: string): Promise<void> {
+export async function saveScreenshot(driver: WebDriver, fileName: string | null, pngProcessor?: (png: string) => void): Promise<void> {
     const pngBase64 = await driver.takeScreenshot();
-    const dirName = path.dirname(fileName);
-    if (!fs.existsSync(dirName)) {
-        await fsPromises.mkdir(dirName, { recursive: true });
+    if (pngProcessor) {
+        pngProcessor(pngBase64);
+    }
+    if (fileName) {
+        const dirName = path.dirname(fileName);
+        if (!fs.existsSync(dirName)) {
+            await fsPromises.mkdir(dirName, { recursive: true });
+        }
+        await fsPromises.writeFile(fileName, pngBase64, 'base64');
     }
-    await fsPromises.writeFile(fileName, pngBase64, 'base64');
 }
 
 
@@ -736,7 +744,7 @@ export function findBestMatchingIndex(candidates: string[], variations: string[]
     return -1;
 }
 
-export type InputElementByLabelResultType = [WebElement|undefined, string|undefined, "child"|"for"|"near"|"type"|"not found"];
+export type InputElementByLabelResultType = [WebElement | undefined, string | undefined, "child" | "for" | "near" | "type" | "not found"];
 
 /**
  * Returns the best matching input element identified by the given label candidates.
@@ -754,9 +762,9 @@ export type InputElementByLabelResultType = [WebElement|undefined, string|undefi
  * @return The input element (or undefined), the associated label (or undefined) and how the input element was found (child, for, near, type or not found)
  * @package findSelectAsWell If true, select elements are also considered; otherwise, only input and textarea elements are considered
  */
-export async function getInputElementByLabel(driver: WebDriver, 
-        labelCandidates: string[], typeHints: string[], positionHint = -1, findSelectAsWell = false
-    )
+export async function getInputElementByLabel(driver: WebDriver,
+    labelCandidates: string[], typeHints: string[], positionHint = -1, findSelectAsWell = false
+)
     : Promise<InputElementByLabelResultType> {
     const tagsToFind = ["input", "textarea"];
     labelCandidates = labelCandidates.map(l => l.toLowerCase());
@@ -769,7 +777,7 @@ export async function getInputElementByLabel(driver: WebDriver,
             const txtLabels: string[] = [];
             for (const weLabel of weLabels) {
                 try {
-                    const text = (await weLabel.getText()).toLowerCase().replace(/:\s*/,"").trim();
+                    const text = (await weLabel.getText()).toLowerCase().replace(/:\s*/, "").trim();
                     txtLabels.push(text);
                 } catch (error) {
                     txtLabels.push("");