@syngrisi/wdio-sdk 3.16.0 → 3.17.0

package/README.md

@@ -104,6 +104,10 @@ await driver.startTestSession({ params: sessionParams });
 Perform a visual check by providing the check name, image buffer, and any additional parameters.
 
 ```js
+// Wait for webfonts before capturing — screenshots taken before a
+// `font-display: swap` font finishes loading produce flaky "shifted text" diffs
+await driver.waitForFonts();
+
 // Full page screenshot
 const fullPageScreenshot = await browser.saveScreenshot('./screenshot.png');
 await driver.check({

package/dist/WDIODriver.js

@@ -177,6 +177,21 @@ class WDIODriver {
         }
         return result;
     }
+    /**
+     * Waits until all webfonts declared on the page are loaded.
+     * Call it right before taking a screenshot to avoid flaky "slightly shifted text"
+     * diffs caused by `font-display: swap` fonts swapping in after the capture.
+     * Resolves silently after `timeout` ms even if fonts are still loading.
+     *
+     * @param {number} [timeout=5000] - Maximum time to wait for fonts, in milliseconds.
+     * @example
+     * await driver.waitForFonts();
+     * const screenshot = Buffer.from(await browser.takeScreenshot(), 'base64');
+     * await driver.check({ checkName: 'Homepage', imageBuffer: screenshot, params: {} });
+     */
+    async waitForFonts(timeout = 5000) {
+        await (0, wdioHelpers_1.waitForFonts)(timeout);
+    }
     /**
      * Submits a check to Syngrisi with the provided image and associated test details.
      * @param {string} checkName - Name of the check.

package/dist/lib/wdioHelpers.js

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getBrowserVersion = exports.getBrowserFullVersion = exports.isIos = exports.isAndroid = exports.getBrowserName = exports.getOS = exports.getViewport = void 0;
+exports.waitForFonts = exports.getBrowserVersion = exports.getBrowserFullVersion = exports.isIos = exports.isAndroid = exports.getBrowserName = exports.getOS = exports.getViewport = void 0;
 const logger_1 = __importDefault(require("./logger"));
 const log = (0, logger_1.default)('syngrisi-wdio-sdk');
 if (process.env.SYNGRISI_LOG_LEVEL) {
@@ -117,3 +117,21 @@ const getBrowserVersion = () => {
     return fullVersion.split('.')[0];
 };
 exports.getBrowserVersion = getBrowserVersion;
+/**
+ * Waits until all webfonts declared on the page are loaded.
+ * Call it right before taking a screenshot to avoid flaky "slightly shifted text"
+ * diffs caused by `font-display: swap` fonts swapping in after the capture.
+ * Resolves silently after `timeout` ms even if fonts are still loading.
+ */
+const waitForFonts = async (timeout = 5000) => {
+    const start = Date.now();
+    // ponytail: polling instead of executeAsync (deprecated in modern WDIO)
+    while (Date.now() - start < timeout) {
+        const loaded = await browser.execute(() => globalThis.document?.fonts?.status === 'loaded');
+        if (loaded)
+            return;
+        await browser.pause(100);
+    }
+    log.warn(`waitForFonts: webfonts are still loading after ${timeout}ms`);
+};
+exports.waitForFonts = waitForFonts;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@syngrisi/wdio-sdk",
-  "version": "3.16.0",
+  "version": "3.17.0",
   "description": "Syngrisi WebdriverIO SDK — visual regression testing for the Syngrisi Visual Testing Platform",
   "main": "dist/WDIODriver.js",
   "types": "dist/WDIODriver.d.ts",
@@ -38,7 +38,7 @@
   },
   "homepage": "https://github.com/syngrisi/syngrisi/tree/main/packages/wdio-sdk#readme",
   "dependencies": {
-    "@syngrisi/core-api": "^3.16.0",
+    "@syngrisi/core-api": "^3.17.0",
     "form-data": "^4.0.6",
     "loglevel": "^1.9.2",
     "zod": "^4.1.13"
@@ -63,5 +63,5 @@
     "typescript": "^6.0.3",
     "vitest": "^4.1.9"
   },
-  "gitHead": "fe1663bce3a1db72833fe1434c9030b5f75c0b7d"
+  "gitHead": "d674bf0296c42762f95d883d313fd1612c24e3ff"
 }