@argos-ci/vitest 0.4.6 → 0.5.0

package/dist/index.d.mts

@@ -1,5 +1,5 @@
-import "@argos-ci/core";
 import { ScreenshotMetadata } from "@argos-ci/util";
+import "@argos-ci/core";
 import { ArgosAttachment } from "@argos-ci/playwright";
 import { StabilizationPluginOptions, ViewportOption } from "@argos-ci/browser";
 //#region src/metadata.d.ts
@@ -142,8 +142,8 @@ type SerializableSnapshotOptions = Omit<VitestSnapshotOptions, "serialize" | "na
 //#region src/index.d.ts
 declare module "vitest/browser" {
   interface BrowserCommands {
-    argosScreenshot: (name: string, options?: VitestScreenshotOptions, test?: TestMetadata) => Promise<ArgosAttachment[]>;
-    argosSnapshot: (name: string, content: string, options?: SerializableSnapshotOptions, test?: TestMetadata) => Promise<ArgosAttachment[]>;
+    argosScreenshot: (name: string, options?: VitestScreenshotOptions, test?: TestMetadata, captureIndex?: number | null) => Promise<ArgosAttachment[]>;
+    argosSnapshot: (name: string, content: string, options?: SerializableSnapshotOptions, test?: TestMetadata, captureIndex?: number | null) => Promise<ArgosAttachment[]>;
   }
 }
 /**

package/dist/index.mjs

@@ -1,3 +1,4 @@
+import { getTestRunKey, nextCaptureIndex } from "@argos-ci/util";
 //#region src/test-context.ts
 /**
 * Get the current Vitest test task, or `undefined` when not inside a test.
@@ -137,6 +138,23 @@ async function getTestMetadata() {
 	if (!task) return null;
 	return buildTestMetadata(task);
 }
+/**
+* Take the next capture index for the current Vitest test, or `null` outside a
+* test. Screenshots and snapshots share the counter, so a test that mixes both
+* still numbers them in the order it produced them.
+*
+* Runs on the test side, where the test context is available; the number then
+* crosses the RPC boundary to the Node command.
+*/
+async function takeCaptureIndex() {
+	const task = await getCurrentTest();
+	if (!task) return null;
+	return nextCaptureIndex(getTestRunKey({
+		id: task.id,
+		retry: task.result?.retryCount ?? void 0,
+		repeat: task.result?.repeatCount ?? void 0
+	}));
+}
 //#endregion
 //#region ../../node_modules/.pnpm/tinyrainbow@3.1.1/node_modules/tinyrainbow/dist/index.js
 var b = {
@@ -1142,9 +1160,13 @@ async function argosScreenshot(nameOrOptions, maybeOptions) {
 	const name = typeof nameOrOptions === "string" ? nameOrOptions : void 0;
 	const options = typeof nameOrOptions === "string" ? maybeOptions : nameOrOptions;
 	if (!await checkIsVitestEnv()) return [];
-	const [resolvedName, test] = await Promise.all([resolveAutoName(name, { reservedLength: SCREENSHOT_NAME_RESERVED }), getTestMetadata()]);
+	const [resolvedName, test, captureIndex] = await Promise.all([
+		resolveAutoName(name, { reservedLength: SCREENSHOT_NAME_RESERVED }),
+		getTestMetadata(),
+		takeCaptureIndex()
+	]);
 	const { server } = await import("vitest/browser");
-	return server.commands.argosScreenshot(resolvedName, options ?? {}, test);
+	return server.commands.argosScreenshot(resolvedName, options ?? {}, test, captureIndex);
 }
 /**
 * Take an Argos snapshot of any serializable value, mimicking
@@ -1181,15 +1203,19 @@ async function argosSnapshot(content, options = {}) {
 	if (!await checkIsVitestEnv()) return [];
 	const rawExtension = options.extension ?? ".txt";
 	const extension = rawExtension.startsWith(".") ? rawExtension : `.${rawExtension}`;
-	const [resolvedName, test] = await Promise.all([resolveAutoName(options.name, { reservedLength: 9 + extension.length + 11 }), getTestMetadata()]);
+	const [resolvedName, test, captureIndex] = await Promise.all([
+		resolveAutoName(options.name, { reservedLength: 9 + extension.length + 11 }),
+		getTestMetadata(),
+		takeCaptureIndex()
+	]);
 	const serialized = serializeSnapshot(content, options);
 	const { serialize: _serialize, name: _name, ...serializableOptions } = options;
 	if (checkIsBrowserEnv()) {
 		const { server } = await import("vitest/browser");
-		return server.commands.argosSnapshot(resolvedName, serialized, serializableOptions, test);
+		return server.commands.argosSnapshot(resolvedName, serialized, serializableOptions, test, captureIndex);
 	}
-	const { writeSnapshotFile } = await import("./snapshot-file-D8dL3z_T.mjs");
-	return writeSnapshotFile(resolvedName, serialized, serializableOptions, test);
+	const { writeSnapshotFile } = await import("./snapshot-file-CZE4r9Wl.mjs");
+	return writeSnapshotFile(resolvedName, serialized, serializableOptions, test, captureIndex);
 }
 /**
 * Check if we are running in a Vitest environment.

package/dist/plugin.d.mts

@@ -174,7 +174,7 @@ type TestMetadata = ScreenshotMetadata["test"];
  * Arguments of the `argosScreenshot` browser command.
  * Only serializable values cross the browser/node RPC boundary.
  */
-type ArgosScreenshotCommandArgs = [name: string, options?: VitestScreenshotOptions, test?: TestMetadata];
+type ArgosScreenshotCommandArgs = [name: string, options?: VitestScreenshotOptions, test?: TestMetadata, captureIndex?: number | null];
 /**
  * Create the `argosScreenshot` browser command used to capture Argos
  * screenshots from Vitest browser tests.
@@ -191,7 +191,7 @@ declare const createArgosScreenshotCommand: (pluginOptions?: ArgosVitestPluginOp
  * Only serializable values cross the browser/node RPC boundary — the value is
  * already serialized to a string on the browser side.
  */
-type ArgosSnapshotCommandArgs = [name: string, content: string, options?: SerializableSnapshotOptions, test?: TestMetadata];
+type ArgosSnapshotCommandArgs = [name: string, content: string, options?: SerializableSnapshotOptions, test?: TestMetadata, captureIndex?: number | null];
 /**
  * Create the `argosSnapshot` browser command used to write serialized snapshots
  * from Vitest browser tests. The serialized string is produced on the browser

package/dist/plugin.mjs

@@ -188,7 +188,7 @@ async function getVitestVersion() {
 * and are merged with the serializable per-call options (per-call wins).
 */
 const createArgosScreenshotCommand = (pluginOptions = {}) => {
-	return async (ctx, name, options, test) => {
+	return async (ctx, name, options, test, captureIndex) => {
 		if (!name) throw new Error("The `name` argument is required.");
 		const merged = {
 			...pluginOptions,
@@ -208,7 +208,8 @@ const createArgosScreenshotCommand = (pluginOptions = {}) => {
 					},
 					playwrightLibraries: ["vitest"],
 					viewport,
-					test
+					test,
+					captureIndex
 				});
 			};
 			const attachments = [];
@@ -276,7 +277,7 @@ function normalizeExtension(extension) {
 * This is the shared Node-side primitive used by both the browser command (which
 * receives the already-serialized string over RPC) and the Node code path.
 */
-async function writeSnapshotFile(name, content, options = {}, test) {
+async function writeSnapshotFile(name, content, options = {}, test, captureIndex) {
 	if (!name) throw new Error("The `name` argument is required.");
 	const root = options.root ?? "./snapshots";
 	const extension = normalizeExtension(options.extension ?? DEFAULT_EXTENSION);
@@ -298,7 +299,8 @@ async function writeSnapshotFile(name, content, options = {}, test) {
 			version: sdkVersion
 		},
 		...tags ? { tags } : {},
-		...resolvedTest ? { test: resolvedTest } : {}
+		...resolvedTest ? { test: resolvedTest } : {},
+		...captureIndex != null ? { capture: { index: captureIndex } } : {}
 	};
 	await createDirectory(dirname(snapshotPath));
 	await Promise.all([writeFile(snapshotPath, content, "utf-8"), writeMetadata(snapshotPath, metadata)]);
@@ -320,12 +322,12 @@ async function writeSnapshotFile(name, content, options = {}, test) {
 * side and this command writes it (and its metadata) to disk on the Node side.
 */
 const createArgosSnapshotCommand = (pluginOptions = {}) => {
-	return async (_ctx, name, content, options, test) => {
+	return async (_ctx, name, content, options, test, captureIndex) => {
 		if (!name) throw new Error("The `name` argument is required.");
 		return writeSnapshotFile(name, content, {
 			root: pluginOptions.root,
 			...options
-		}, test);
+		}, test, captureIndex);
 	};
 };
 //#endregion

package/dist/{snapshot-file-D8dL3z_T.mjs → snapshot-file-CZE4r9Wl.mjs}

@@ -1,8 +1,8 @@
 import { createRequire } from "node:module";
+import { createDirectory, getGitRepositoryPath, getMetadataPath, getScreenshotName, readVersionFromPackage, writeMetadata } from "@argos-ci/util";
 import { writeFile } from "node:fs/promises";
 import { dirname, relative, resolve } from "node:path";
 import { getSnapshotMimeType } from "@argos-ci/core";
-import { createDirectory, getGitRepositoryPath, getMetadataPath, getScreenshotName, readVersionFromPackage, writeMetadata } from "@argos-ci/util";
 //#region src/version.ts
 const require = createRequire(import.meta.url);
 /**
@@ -60,7 +60,7 @@ function normalizeExtension(extension) {
 * This is the shared Node-side primitive used by both the browser command (which
 * receives the already-serialized string over RPC) and the Node code path.
 */
-async function writeSnapshotFile(name, content, options = {}, test) {
+async function writeSnapshotFile(name, content, options = {}, test, captureIndex) {
 	if (!name) throw new Error("The `name` argument is required.");
 	const root = options.root ?? "./snapshots";
 	const extension = normalizeExtension(options.extension ?? DEFAULT_EXTENSION);
@@ -82,7 +82,8 @@ async function writeSnapshotFile(name, content, options = {}, test) {
 			version: sdkVersion
 		},
 		...tags ? { tags } : {},
-		...resolvedTest ? { test: resolvedTest } : {}
+		...resolvedTest ? { test: resolvedTest } : {},
+		...captureIndex != null ? { capture: { index: captureIndex } } : {}
 	};
 	await createDirectory(dirname(snapshotPath));
 	await Promise.all([writeFile(snapshotPath, content, "utf-8"), writeMetadata(snapshotPath, metadata)]);

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@argos-ci/vitest",
   "description": "Vitest SDK for visual testing with Argos.",
-  "version": "0.4.6",
+  "version": "0.5.0",
   "author": "Smooth Code",
   "license": "MIT",
   "repository": {
@@ -52,9 +52,9 @@
   },
   "dependencies": {
     "@argos-ci/browser": "6.4.5",
-    "@argos-ci/core": "6.8.1",
-    "@argos-ci/playwright": "7.4.6",
-    "@argos-ci/util": "4.1.0"
+    "@argos-ci/core": "6.8.3",
+    "@argos-ci/playwright": "7.5.0",
+    "@argos-ci/util": "4.2.0"
   },
   "peerDependencies": {
     "@vitest/browser": ">=4",
@@ -81,5 +81,5 @@
     "check-format": "prettier --check --ignore-unknown --ignore-path=./.gitignore --ignore-path=../../.gitignore --ignore-path=../../.prettierignore .",
     "lint": "eslint ."
   },
-  "gitHead": "180580eb5a263a65ed15cbd18cdd98d39f3a5325"
+  "gitHead": "b2a9a9d84dc14e148a68295f56cfdfec03f887f1"
 }