@olomonhelpdesk2/helpdesk 0.1.9 → 0.1.10

package/helpdesk-capture.mjs

@@ -154,7 +154,20 @@ var CAPTURE_CONTRACT = {
   /**
    * Injected before every shot. Necessary, not sufficient — see above.
    */
-  motionOff: "*,*::before,*::after{animation:none!important;transition:none!important;caret-color:transparent!important}"
+  motionOff: "*,*::before,*::after{animation:none!important;transition:none!important;caret-color:transparent!important}",
+  /**
+   * What an app uses to leave its own floating widgets out of the pictures.
+   *
+   * A feedback button or a chat launcher sits on top of the product on every
+   * screen, and an article about the product should show only the product. The
+   * capture sets `marker` on `<html>` of every page it photographs, so an app
+   * can style a widget away under `html[data-helpdesk-capture]`, and it removes
+   * any element carrying `hide` itself. Removed before the screen is read, so
+   * what is not in the picture is not asked about either.
+   */
+  marker: "data-helpdesk-capture",
+  hide: "data-helpdesk-hide",
+  hideOff: "[data-helpdesk-hide]{display:none!important}"
 };
 var VISUAL_STABILITY = {
   /** Gap between comparison frames. Short enough to be cheap, long enough to differ. */
@@ -2077,6 +2090,8 @@ async function playwrightBrowser(options = {}) {
           const response = await page.goto(url, { waitUntil: "networkidle", timeout: 3e4 });
           status = response?.status();
           await page.addStyleTag({ content: CAPTURE_CONTRACT.motionOff }).catch(() => void 0);
+          await page.addStyleTag({ content: CAPTURE_CONTRACT.hideOff }).catch(() => void 0);
+          await page.evaluate((name) => document.documentElement.setAttribute(name, ""), CAPTURE_CONTRACT.marker).catch(() => void 0);
           await page.evaluate(() => document.fonts?.ready).catch(() => void 0);
         },
         async text() {
@@ -3193,7 +3208,8 @@ function buildStoryboard(options) {
   const beneath = options.routes.filter(
     (route) => !covered.has(route.path) && !route.skipped && [...covered].some((base) => base !== "/" && route.path.startsWith(`${base}/`))
   );
-  const ordered = [...covered].map((path3) => byPath.get(path3)).filter((route) => Boolean(route) && !route.skipped).sort((a, b) => a.path.length - b.path.length).concat(beneath.sort((a, b) => a.path.length - b.path.length));
+  const own = [...covered].map((path3) => byPath.get(path3)).filter((route) => Boolean(route) && !route.skipped);
+  const ordered = options.inOrder ? own : own.sort((a, b) => a.path.length - b.path.length).concat(beneath.sort((a, b) => a.path.length - b.path.length));
   const limit = options.maxSteps ?? 5;
   const steps = ordered.slice(0, limit).map((route, index) => ({
     route: route.path,

package/helpdesk-seed.mjs

@@ -1002,7 +1002,20 @@ var CAPTURE_CONTRACT = {
   /**
    * Injected before every shot. Necessary, not sufficient — see above.
    */
-  motionOff: "*,*::before,*::after{animation:none!important;transition:none!important;caret-color:transparent!important}"
+  motionOff: "*,*::before,*::after{animation:none!important;transition:none!important;caret-color:transparent!important}",
+  /**
+   * What an app uses to leave its own floating widgets out of the pictures.
+   *
+   * A feedback button or a chat launcher sits on top of the product on every
+   * screen, and an article about the product should show only the product. The
+   * capture sets `marker` on `<html>` of every page it photographs, so an app
+   * can style a widget away under `html[data-helpdesk-capture]`, and it removes
+   * any element carrying `hide` itself. Removed before the screen is read, so
+   * what is not in the picture is not asked about either.
+   */
+  marker: "data-helpdesk-capture",
+  hide: "data-helpdesk-hide",
+  hideOff: "[data-helpdesk-hide]{display:none!important}"
 };
 var RECORDING_MISS_STATUS = 599;
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@olomonhelpdesk2/helpdesk",
-  "version": "0.1.9",
+  "version": "0.1.10",
   "description": "Reads a product's screens, plans its help articles, and photographs them.",
   "type": "module",
   "engines": {