@vitest/browser 1.6.0 → 2.0.0-beta.10

package/dist/context.js

@@ -0,0 +1,87 @@
+function convertElementToXPath(element) {
+  if (!element || !(element instanceof Element))
+    throw new Error(`Expected DOM element to be an instance of Element, received ${typeof element}`);
+  return getPathTo(element);
+}
+function getPathTo(element) {
+  if (element.id !== "")
+    return `id("${element.id}")`;
+  if (!element.parentNode || element === document.documentElement)
+    return element.tagName;
+  let ix = 0;
+  const siblings = element.parentNode.childNodes;
+  for (let i = 0; i < siblings.length; i++) {
+    const sibling = siblings[i];
+    if (sibling === element)
+      return `${getPathTo(element.parentNode)}/${element.tagName}[${ix + 1}]`;
+    if (sibling.nodeType === 1 && sibling.tagName === element.tagName)
+      ix++;
+  }
+  return "invalid xpath";
+}
+const state = () => __vitest_worker__;
+const runner = () => __vitest_browser_runner__;
+const filepath = () => state().filepath || state().current?.file?.filepath || void 0;
+const rpc = () => state().rpc;
+const contextId = runner().contextId;
+const channel = new BroadcastChannel(`vitest:${contextId}`);
+function triggerCommand(command, ...args) {
+  return rpc().triggerCommand(contextId, command, filepath(), args);
+}
+const userEvent = {
+  click(element, options = {}) {
+    const xpath = convertElementToXPath(element);
+    return triggerCommand("__vitest_click", xpath, options);
+  }
+};
+const screenshotIds = {};
+const page = {
+  get config() {
+    return runner().config;
+  },
+  viewport(width, height) {
+    const id = runner().iframeId;
+    channel.postMessage({ type: "viewport", width, height, id });
+    return new Promise((resolve, reject) => {
+      channel.addEventListener("message", function handler(e) {
+        if (e.data.type === "viewport:done" && e.data.id === id) {
+          channel.removeEventListener("message", handler);
+          resolve();
+        }
+        if (e.data.type === "viewport:fail" && e.data.id === id) {
+          channel.removeEventListener("message", handler);
+          reject(new Error(e.data.error));
+        }
+      });
+    });
+  },
+  async screenshot(options = {}) {
+    const currentTest = state().current;
+    if (!currentTest)
+      throw new Error("Cannot take a screenshot outside of a test.");
+    if (currentTest.concurrent) {
+      throw new Error(
+        "Cannot take a screenshot in a concurrent test because concurrent tests run at the same time in the same iframe and affect each other's environment. Use a non-concurrent test to take a screenshot."
+      );
+    }
+    const repeatCount = currentTest.result?.repeatCount ?? 0;
+    const taskName = getTaskFullName(currentTest);
+    const number = screenshotIds[repeatCount]?.[taskName] ?? 1;
+    screenshotIds[repeatCount] ??= {};
+    screenshotIds[repeatCount][taskName] = number + 1;
+    const name = options.path || `${taskName.replace(/[^a-z0-9]/g, "-")}-${number}.png`;
+    return triggerCommand(
+      "__vitest_screenshot",
+      name,
+      {
+        ...options,
+        element: options.element ? convertElementToXPath(options.element) : void 0
+      }
+    );
+  }
+};
+function getTaskFullName(task) {
+  return task.suite ? `${getTaskFullName(task.suite)} ${task.name}` : task.name;
+}
+
+export { page, userEvent };

package/dist/index.d.ts

@@ -1,6 +1,9 @@
-import { Plugin } from 'vite';
-import { WorkspaceProject } from 'vitest/node';
+import { BrowserCommand, WorkspaceProject } from 'vitest/node';
+export { BrowserCommand } from 'vitest/node';
+import { Plugin } from 'vitest/config';
+
+declare function defineBrowserCommand<T extends unknown[]>(fn: BrowserCommand<T>): BrowserCommand<T>;
 
 declare const _default: (project: WorkspaceProject, base?: string) => Plugin[];
 
-export { _default as default };
+export { _default as default, defineBrowserCommand };