@forgebook/testing 0.1.5 → 0.1.7

package/dist/src/touchWindow.d.ts

@@ -0,0 +1,8 @@
+import { type TouchWindowRequest } from "forgebook/real-touch";
+/**
+ * Opens the catalogue in a touch window and waits until the person closes it.
+ *
+ * @param request - the catalogue's address.
+ */
+export declare const openTouchWindow: (request: TouchWindowRequest) => Promise<void>;
+//# sourceMappingURL=touchWindow.d.ts.map

package/dist/src/touchWindow.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"touchWindow.d.ts","sourceRoot":"","sources":["../../src/touchWindow.ts"],"names":[],"mappings":"AAcA,OAAO,EAAmB,KAAK,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAwBhF;;;;GAIG;AACH,eAAO,MAAM,eAAe,YAAmB,kBAAkB,KAAG,OAAO,CAAC,IAAI,CAqB/E,CAAC"}

package/dist/src/touchWindow.js

@@ -0,0 +1,64 @@
+/**
+ * The window `forgebook dev --touch` opens: the catalogue in a Chromium of Playwright's, with Chromium's own touch
+ * emulation, so the mouse makes real touch events (trusted, with the browser's own scrolling) where the catalogue's
+ * Touch switch can only simulate them.
+ *
+ * @remarks
+ * Loaded from the project by the command only when it runs, as the check is, so the core needs no browser. The
+ * emulation is turned on through the browser's protocol (CDP) in every page of the window, popups included, and the
+ * pages are marked (`forgebook/real-touch`) so the catalogue's simulated touch stays off there. Still a computer: no
+ * virtual keyboard, no viewport shrinking under it, no iOS Safari.
+ *
+ * @module
+ */
+import { chromium } from "@playwright/test";
+import { REAL_TOUCH_FLAG } from "forgebook/real-touch";
+/** How many fingers the emulation offers. */
+const MAX_TOUCH_POINTS = 5;
+/** The pages whose emulation is on: the first page is turned on before it loads, and the context then reports it. */
+const emulated = new WeakSet();
+/**
+ * Turns Chromium's touch emulation on in a page: the mouse's presses become touches, as in DevTools' device mode.
+ *
+ * @param page - the page.
+ */
+const emulateTouch = async (page) => {
+    if (emulated.has(page))
+        return;
+    emulated.add(page);
+    const session = await page.context().newCDPSession(page);
+    await session.send("Emulation.setTouchEmulationEnabled", {
+        enabled: true,
+        maxTouchPoints: MAX_TOUCH_POINTS
+    });
+    await session.send("Emulation.setEmitTouchEventsForMouse", { enabled: true, configuration: "mobile" });
+};
+/**
+ * Opens the catalogue in a touch window and waits until the person closes it.
+ *
+ * @param request - the catalogue's address.
+ */
+export const openTouchWindow = async (request) => {
+    const browser = await chromium.launch({ headless: false });
+    // the window's own size, not a fixed viewport: the person resizes it as they like
+    const context = await browser.newContext({ viewport: null, hasTouch: true });
+    await context.addInitScript((flag) => {
+        Object.defineProperty(window, flag, { value: true });
+    }, REAL_TOUCH_FLAG);
+    context.on("page", (page) => {
+        void emulateTouch(page);
+    });
+    const page = await context.newPage();
+    await emulateTouch(page);
+    await page.goto(request.url);
+    await new Promise((done) => {
+        browser.on("disconnected", () => done());
+        // the last page closed closes the window
+        context.on("close", () => done());
+        page.on("close", () => {
+            if (context.pages().length === 0)
+                void browser.close();
+        });
+    });
+};
+//# sourceMappingURL=touchWindow.js.map

package/dist/src/touchWindow.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"touchWindow.js","sourceRoot":"","sources":["../../src/touchWindow.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AACH,OAAO,EAAE,QAAQ,EAAa,MAAM,kBAAkB,CAAC;AACvD,OAAO,EAAE,eAAe,EAA2B,MAAM,sBAAsB,CAAC;AAEhF,6CAA6C;AAC7C,MAAM,gBAAgB,GAAG,CAAC,CAAC;AAE3B,qHAAqH;AACrH,MAAM,QAAQ,GAAG,IAAI,OAAO,EAAQ,CAAC;AAErC;;;;GAIG;AACH,MAAM,YAAY,GAAG,KAAK,EAAE,IAAU,EAAiB,EAAE;IACvD,IAAI,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC;QAAE,OAAO;IAC/B,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IACnB,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,OAAO,EAAE,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;IACzD,MAAM,OAAO,CAAC,IAAI,CAAC,oCAAoC,EAAE;QACvD,OAAO,EAAE,IAAI;QACb,cAAc,EAAE,gBAAgB;KACjC,CAAC,CAAC;IACH,MAAM,OAAO,CAAC,IAAI,CAAC,sCAAsC,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,aAAa,EAAE,QAAQ,EAAE,CAAC,CAAC;AACzG,CAAC,CAAC;AAEF;;;;GAIG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG,KAAK,EAAE,OAA2B,EAAiB,EAAE;IAClF,MAAM,OAAO,GAAG,MAAM,QAAQ,CAAC,MAAM,CAAC,EAAE,QAAQ,EAAE,KAAK,EAAE,CAAC,CAAC;IAC3D,kFAAkF;IAClF,MAAM,OAAO,GAAG,MAAM,OAAO,CAAC,UAAU,CAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC,CAAC;IAC7E,MAAM,OAAO,CAAC,aAAa,CAAC,CAAC,IAAY,EAAQ,EAAE;QACjD,MAAM,CAAC,cAAc,CAAC,MAAM,EAAE,IAAI,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;IACvD,CAAC,EAAE,eAAe,CAAC,CAAC;IACpB,OAAO,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,IAAU,EAAQ,EAAE;QACtC,KAAK,YAAY,CAAC,IAAI,CAAC,CAAC;IAC1B,CAAC,CAAC,CAAC;IACH,MAAM,IAAI,GAAG,MAAM,OAAO,CAAC,OAAO,EAAE,CAAC;IACrC,MAAM,YAAY,CAAC,IAAI,CAAC,CAAC;IACzB,MAAM,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;IAC7B,MAAM,IAAI,OAAO,CAAO,CAAC,IAAI,EAAE,EAAE;QAC/B,OAAO,CAAC,EAAE,CAAC,cAAc,EAAE,GAAS,EAAE,CAAC,IAAI,EAAE,CAAC,CAAC;QAC/C,yCAAyC;QACzC,OAAO,CAAC,EAAE,CAAC,OAAO,EAAE,GAAS,EAAE,CAAC,IAAI,EAAE,CAAC,CAAC;QACxC,IAAI,CAAC,EAAE,CAAC,OAAO,EAAE,GAAS,EAAE;YAC1B,IAAI,OAAO,CAAC,KAAK,EAAE,CAAC,MAAM,KAAK,CAAC;gBAAE,KAAK,OAAO,CAAC,KAAK,EAAE,CAAC;QACzD,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@forgebook/testing",
-  "version": "0.1.5",
+  "version": "0.1.7",
   "description": "Tests from a package's stories: each story and variant in the browser with axe, spills and overlays, screenshots, and each story rendered on the server.",
   "license": "MIT",
   "repository": {
@@ -59,18 +59,22 @@
       "types": "./dist/src/shotStories.d.ts",
       "default": "./dist/src/shotStories.js"
     },
+    "./touch": {
+      "types": "./dist/src/touchWindow.d.ts",
+      "default": "./dist/src/touchWindow.js"
+    },
     "./fonts.css": "./dist/src/fonts/fonts.css"
   },
   "dependencies": {
     "@axe-core/playwright": "4.14.0",
     "@ensiria/cli-kit": "^0.1.1",
-    "@forgebook/story-format": "0.1.3"
+    "@forgebook/story-format": "0.1.4"
   },
   "peerDependencies": {
     "@playwright/test": "^1.64.0",
     "vite": "^8.0.0",
     "vitest": "^5.0.0",
-    "forgebook": "^0.1.4"
+    "forgebook": "^0.1.6"
   },
   "devDependencies": {
     "@playwright/test": "1.64.1",
@@ -79,9 +83,9 @@
     "react": "19.3.0",
     "vite": "8.3.5",
     "vitest": "5.0.5",
+    "@forgebook/typescript-config": "0.0.0",
     "@forgebook/tools": "0.0.0",
-    "forgebook": "0.1.4",
-    "@forgebook/typescript-config": "0.0.0"
+    "forgebook": "0.1.6"
   },
   "publishConfig": {
     "access": "public"