@qawolf/testkit 1.0.0 → 1.2.0

package/CHANGELOG.md

@@ -0,0 +1,14 @@
+# Changelog
+
+## [1.2.0] - 2026-07-08
+
+### Added
+
+- Added `startWireGuard(options)` to start a WireGuard connection via the runner client, matching the existing `startOpenVpn` helper.
+
+## [1.1.0] - 2026-05-01
+
+### Added
+
+- Added `saveEnvironmentVariable(name, value)` to save string values to the current QA Wolf environment and update `process.env` for the running flow.
+- Added `reloadEnvironmentVariables()` to fetch the latest environment variables for the current QA Wolf environment and copy string values into `process.env`.

package/README.md

@@ -36,8 +36,23 @@ const qrValue = await readQRCode(page, "[data-testid='qr-code']");
 if (!qrValue) throw new Error("QR code was not visible");
 ```
 
+Save dynamic data to the QA Wolf environment and reload environment variables
+when another flow has updated them.
+
+```ts
+import {
+  reloadEnvironmentVariables,
+  saveEnvironmentVariable,
+} from "@qawolf/testkit";
+
+await saveEnvironmentVariable("LOGIN_TOKEN", token);
+
+await reloadEnvironmentVariables();
+const reloadedToken = process.env["LOGIN_TOKEN"];
+```
+
 Use runner-backed helpers for environment setup, such as connecting through
-OpenVPN before the rest of the flow runs.
+OpenVPN or WireGuard before the rest of the flow runs.
 
 ```ts
 import { startOpenVpn } from "@qawolf/testkit";
@@ -46,3 +61,11 @@ await startOpenVpn({
   configPath: "/tmp/client.ovpn",
 });
 ```
+
+```ts
+import { startWireGuard } from "@qawolf/testkit";
+
+await startWireGuard({
+  configPath: "/tmp/wg0.conf",
+});
+```

package/dist/index.d.ts

@@ -1,10 +1,13 @@
-import type { MountCifsShareOptions, Screenshotable, StartOpenVpnOptions } from "./types.js";
+import type { MountCifsShareOptions, Screenshotable, StartOpenVpnOptions, StartWireGuardOptions } from "./types.js";
 export { configureTestkitClient, getCurrentTestkitClient, resetTestkitClient, } from "./clientScope.js";
-export type { MountCifsShareOptions, SaveBaselineScreenshot, Screenshotable, StartOpenVpnOptions, } from "./types.js";
+export type { MountCifsShareOptions, SaveBaselineScreenshot, Screenshotable, StartOpenVpnOptions, StartWireGuardOptions, } from "./types.js";
 export declare const otp: {
     fromUri(uri: string): string;
 };
+export declare function saveEnvironmentVariable(name: string, value: string): Promise<void>;
+export declare function reloadEnvironmentVariables(): Promise<void>;
 export declare function mountCifsShare(options: MountCifsShareOptions): Promise<string>;
 export declare function startOpenVpn(options: StartOpenVpnOptions): Promise<string>;
+export declare function startWireGuard(options: StartWireGuardOptions): Promise<string>;
 export declare function saveBaselineScreenshot(pageOrLocator: Screenshotable, name: string, screenshotOptions?: unknown): Promise<void>;
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EACV,qBAAqB,EACrB,cAAc,EACd,mBAAmB,EACpB,MAAM,YAAY,CAAC;AAEpB,OAAO,EACL,sBAAsB,EACtB,uBAAuB,EACvB,kBAAkB,GACnB,MAAM,kBAAkB,CAAC;AAE1B,YAAY,EACV,qBAAqB,EACrB,sBAAsB,EACtB,cAAc,EACd,mBAAmB,GACpB,MAAM,YAAY,CAAC;AAEpB,eAAO,MAAM,GAAG;iBACD,MAAM,GAAG,MAAM;CAG7B,CAAC;AAcF,wBAAsB,cAAc,CAClC,OAAO,EAAE,qBAAqB,GAC7B,OAAO,CAAC,MAAM,CAAC,CAEjB;AAED,wBAAsB,YAAY,CAChC,OAAO,EAAE,mBAAmB,GAC3B,OAAO,CAAC,MAAM,CAAC,CAEjB;AAED,wBAAsB,sBAAsB,CAC1C,aAAa,EAAE,cAAc,EAC7B,IAAI,EAAE,MAAM,EACZ,iBAAiB,CAAC,EAAE,OAAO,GAC1B,OAAO,CAAC,IAAI,CAAC,CAUf"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EACV,qBAAqB,EACrB,cAAc,EACd,mBAAmB,EACnB,qBAAqB,EACtB,MAAM,YAAY,CAAC;AAEpB,OAAO,EACL,sBAAsB,EACtB,uBAAuB,EACvB,kBAAkB,GACnB,MAAM,kBAAkB,CAAC;AAE1B,YAAY,EACV,qBAAqB,EACrB,sBAAsB,EACtB,cAAc,EACd,mBAAmB,EACnB,qBAAqB,GACtB,MAAM,YAAY,CAAC;AAEpB,eAAO,MAAM,GAAG;iBACD,MAAM,GAAG,MAAM;CAG7B,CAAC;AA0BF,wBAAsB,uBAAuB,CAC3C,IAAI,EAAE,MAAM,EACZ,KAAK,EAAE,MAAM,GACZ,OAAO,CAAC,IAAI,CAAC,CAuBf;AAED,wBAAsB,0BAA0B,IAAI,OAAO,CAAC,IAAI,CAAC,CA2BhE;AAaD,wBAAsB,cAAc,CAClC,OAAO,EAAE,qBAAqB,GAC7B,OAAO,CAAC,MAAM,CAAC,CAEjB;AAED,wBAAsB,YAAY,CAChC,OAAO,EAAE,mBAAmB,GAC3B,OAAO,CAAC,MAAM,CAAC,CAEjB;AAED,wBAAsB,cAAc,CAClC,OAAO,EAAE,qBAAqB,GAC7B,OAAO,CAAC,MAAM,CAAC,CAEjB;AAED,wBAAsB,sBAAsB,CAC1C,aAAa,EAAE,cAAc,EAC7B,IAAI,EAAE,MAAM,EACZ,iBAAiB,CAAC,EAAE,OAAO,GAC1B,OAAO,CAAC,IAAI,CAAC,CAUf"}

package/dist/index.js

@@ -1,4 +1,5 @@
 import * as OTPAuth from "otpauth";
+import { z } from "zod";
 import { getCurrentTestkitClient } from "./clientScope.js";
 export { configureTestkitClient, getCurrentTestkitClient, resetTestkitClient, } from "./clientScope.js";
 export const otp = {
@@ -6,6 +7,69 @@ export const otp = {
         return OTPAuth.URI.parse(uri).generate();
     },
 };
+const environmentVariablesResponseSchema = z.object({
+    result: z.object({
+        data: z.object({
+            json: z.object({
+                environmentVariables: z.record(z.string(), z.unknown()).optional(),
+            }),
+        }),
+    }),
+});
+function requireEnvironmentVariable(name) {
+    const value = process.env[name];
+    if (!value)
+        throw Error(`${name} is not defined`);
+    return value;
+}
+function getApexApiConfig() {
+    return {
+        environmentId: requireEnvironmentVariable("QAWOLF_ENVIRONMENT_ID"),
+        jwtKey: requireEnvironmentVariable("QAWOLF_TEAM_API_KEY"),
+        url: requireEnvironmentVariable("QAWOLF_API_URL"),
+    };
+}
+export async function saveEnvironmentVariable(name, value) {
+    if (typeof value !== "string")
+        throw Error("value must be a string");
+    const { environmentId, jwtKey, url } = getApexApiConfig();
+    const response = await fetch(`${url}/trpc/environment.upsertEnvironmentVariable`, {
+        body: JSON.stringify({
+            environmentId,
+            environmentVariableName: name,
+            environmentVariableValue: value,
+        }),
+        headers: {
+            Authorization: `Bearer ${jwtKey}`,
+            "Content-Type": "application/json",
+        },
+        method: "POST",
+    });
+    if (response.status !== 200)
+        throw Error(`Failed to save environment variable: ${response.status}`);
+    process.env[name] = value;
+}
+export async function reloadEnvironmentVariables() {
+    const { environmentId, jwtKey, url } = getApexApiConfig();
+    const input = encodeURIComponent(JSON.stringify({ id: environmentId }));
+    const response = await fetch(`${url}/trpc/environment.getEnvironmentWithVariables?input=${input}`, {
+        headers: {
+            Authorization: `Bearer ${jwtKey}`,
+            "Content-Type": "application/json",
+        },
+        method: "GET",
+    });
+    if (!response.ok)
+        throw Error(`Failed to reload environment variables: ${response.status}`);
+    const body = environmentVariablesResponseSchema.parse(await response.json());
+    const environmentVariables = body.result.data.json.environmentVariables;
+    if (environmentVariables && typeof environmentVariables === "object") {
+        for (const [environmentVariableName, environmentVariableValue,] of Object.entries(environmentVariables)) {
+            if (typeof environmentVariableValue === "string")
+                process.env[environmentVariableName] = environmentVariableValue;
+        }
+    }
+}
 function requireClient(helperName) {
     const client = getCurrentTestkitClient();
     if (!client) {
@@ -21,6 +85,9 @@ export async function mountCifsShare(options) {
 export async function startOpenVpn(options) {
     return requireClient("startOpenVpn").startOpenVpn(options);
 }
+export async function startWireGuard(options) {
+    return requireClient("startWireGuard").startWireGuard(options);
+}
 export async function saveBaselineScreenshot(pageOrLocator, name, screenshotOptions) {
     const client = requireClient("saveBaselineScreenshot");
     if (!client.saveBaselineScreenshot) {

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,OAAO,MAAM,SAAS,CAAC;AAGnC,OAAO,EAAE,uBAAuB,EAAE,MAAM,kBAAkB,CAAC;AAO3D,OAAO,EACL,sBAAsB,EACtB,uBAAuB,EACvB,kBAAkB,GACnB,MAAM,kBAAkB,CAAC;AAS1B,MAAM,CAAC,MAAM,GAAG,GAAG;IACjB,OAAO,CAAC,GAAW;QACjB,OAAO,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,CAAC;IAC3C,CAAC;CACF,CAAC;AAEF,SAAS,aAAa,CAAC,UAAkB;IACvC,MAAM,MAAM,GAAG,uBAAuB,EAAE,CAAC;IACzC,IAAI,CAAC,MAAM,EAAE,CAAC;QACZ,MAAM,KAAK,CACT,mBAAmB,UAAU,6BAA6B;YACxD,6DAA6D;YAC7D,GAAG,UAAU,KAAK,CACrB,CAAC;IACJ,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,cAAc,CAClC,OAA8B;IAE9B,OAAO,aAAa,CAAC,gBAAgB,CAAC,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC;AACjE,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,YAAY,CAChC,OAA4B;IAE5B,OAAO,aAAa,CAAC,cAAc,CAAC,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC;AAC7D,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,sBAAsB,CAC1C,aAA6B,EAC7B,IAAY,EACZ,iBAA2B;IAE3B,MAAM,MAAM,GAAG,aAAa,CAAC,wBAAwB,CAAC,CAAC;IACvD,IAAI,CAAC,MAAM,CAAC,sBAAsB,EAAE,CAAC;QACnC,MAAM,KAAK,CACT,qEAAqE;YACnE,uDAAuD;YACvD,mDAAmD,CACtD,CAAC;IACJ,CAAC;IACD,OAAO,MAAM,CAAC,sBAAsB,CAAC,aAAa,EAAE,IAAI,EAAE,iBAAiB,CAAC,CAAC;AAC/E,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,OAAO,MAAM,SAAS,CAAC;AACnC,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAGxB,OAAO,EAAE,uBAAuB,EAAE,MAAM,kBAAkB,CAAC;AAQ3D,OAAO,EACL,sBAAsB,EACtB,uBAAuB,EACvB,kBAAkB,GACnB,MAAM,kBAAkB,CAAC;AAU1B,MAAM,CAAC,MAAM,GAAG,GAAG;IACjB,OAAO,CAAC,GAAW;QACjB,OAAO,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,CAAC;IAC3C,CAAC;CACF,CAAC;AAEF,MAAM,kCAAkC,GAAG,CAAC,CAAC,MAAM,CAAC;IAClD,MAAM,EAAE,CAAC,CAAC,MAAM,CAAC;QACf,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC;YACb,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC;gBACb,oBAAoB,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC,QAAQ,EAAE;aACnE,CAAC;SACH,CAAC;KACH,CAAC;CACH,CAAC,CAAC;AAEH,SAAS,0BAA0B,CAAC,IAAY;IAC9C,MAAM,KAAK,GAAG,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IAChC,IAAI,CAAC,KAAK;QAAE,MAAM,KAAK,CAAC,GAAG,IAAI,iBAAiB,CAAC,CAAC;IAClD,OAAO,KAAK,CAAC;AACf,CAAC;AAED,SAAS,gBAAgB;IACvB,OAAO;QACL,aAAa,EAAE,0BAA0B,CAAC,uBAAuB,CAAC;QAClE,MAAM,EAAE,0BAA0B,CAAC,qBAAqB,CAAC;QACzD,GAAG,EAAE,0BAA0B,CAAC,gBAAgB,CAAC;KAClD,CAAC;AACJ,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,uBAAuB,CAC3C,IAAY,EACZ,KAAa;IAEb,IAAI,OAAO,KAAK,KAAK,QAAQ;QAAE,MAAM,KAAK,CAAC,wBAAwB,CAAC,CAAC;IAErE,MAAM,EAAE,aAAa,EAAE,MAAM,EAAE,GAAG,EAAE,GAAG,gBAAgB,EAAE,CAAC;IAC1D,MAAM,QAAQ,GAAG,MAAM,KAAK,CAC1B,GAAG,GAAG,6CAA6C,EACnD;QACE,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC;YACnB,aAAa;YACb,uBAAuB,EAAE,IAAI;YAC7B,wBAAwB,EAAE,KAAK;SAChC,CAAC;QACF,OAAO,EAAE;YACP,aAAa,EAAE,UAAU,MAAM,EAAE;YACjC,cAAc,EAAE,kBAAkB;SACnC;QACD,MAAM,EAAE,MAAM;KACf,CACF,CAAC;IACF,IAAI,QAAQ,CAAC,MAAM,KAAK,GAAG;QACzB,MAAM,KAAK,CAAC,wCAAwC,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAC;IAEzE,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC;AAC5B,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,0BAA0B;IAC9C,MAAM,EAAE,aAAa,EAAE,MAAM,EAAE,GAAG,EAAE,GAAG,gBAAgB,EAAE,CAAC;IAC1D,MAAM,KAAK,GAAG,kBAAkB,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,EAAE,EAAE,aAAa,EAAE,CAAC,CAAC,CAAC;IACxE,MAAM,QAAQ,GAAG,MAAM,KAAK,CAC1B,GAAG,GAAG,uDAAuD,KAAK,EAAE,EACpE;QACE,OAAO,EAAE;YACP,aAAa,EAAE,UAAU,MAAM,EAAE;YACjC,cAAc,EAAE,kBAAkB;SACnC;QACD,MAAM,EAAE,KAAK;KACd,CACF,CAAC;IACF,IAAI,CAAC,QAAQ,CAAC,EAAE;QACd,MAAM,KAAK,CAAC,2CAA2C,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAC;IAE5E,MAAM,IAAI,GAAG,kCAAkC,CAAC,KAAK,CAAC,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAC;IAC7E,MAAM,oBAAoB,GAAG,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,oBAAoB,CAAC;IACxE,IAAI,oBAAoB,IAAI,OAAO,oBAAoB,KAAK,QAAQ,EAAE,CAAC;QACrE,KAAK,MAAM,CACT,uBAAuB,EACvB,wBAAwB,EACzB,IAAI,MAAM,CAAC,OAAO,CAAC,oBAAoB,CAAC,EAAE,CAAC;YAC1C,IAAI,OAAO,wBAAwB,KAAK,QAAQ;gBAC9C,OAAO,CAAC,GAAG,CAAC,uBAAuB,CAAC,GAAG,wBAAwB,CAAC;QACpE,CAAC;IACH,CAAC;AACH,CAAC;AACD,SAAS,aAAa,CAAC,UAAkB;IACvC,MAAM,MAAM,GAAG,uBAAuB,EAAE,CAAC;IACzC,IAAI,CAAC,MAAM,EAAE,CAAC;QACZ,MAAM,KAAK,CACT,mBAAmB,UAAU,6BAA6B;YACxD,6DAA6D;YAC7D,GAAG,UAAU,KAAK,CACrB,CAAC;IACJ,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,cAAc,CAClC,OAA8B;IAE9B,OAAO,aAAa,CAAC,gBAAgB,CAAC,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC;AACjE,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,YAAY,CAChC,OAA4B;IAE5B,OAAO,aAAa,CAAC,cAAc,CAAC,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC;AAC7D,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,cAAc,CAClC,OAA8B;IAE9B,OAAO,aAAa,CAAC,gBAAgB,CAAC,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC;AACjE,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,sBAAsB,CAC1C,aAA6B,EAC7B,IAAY,EACZ,iBAA2B;IAE3B,MAAM,MAAM,GAAG,aAAa,CAAC,wBAAwB,CAAC,CAAC;IACvD,IAAI,CAAC,MAAM,CAAC,sBAAsB,EAAE,CAAC;QACnC,MAAM,KAAK,CACT,qEAAqE;YACnE,uDAAuD;YACvD,mDAAmD,CACtD,CAAC;IACJ,CAAC;IACD,OAAO,MAAM,CAAC,sBAAsB,CAAC,aAAa,EAAE,IAAI,EAAE,iBAAiB,CAAC,CAAC;AAC/E,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@qawolf/testkit",
-  "version": "1.0.0",
+  "version": "1.2.0",
   "private": false,
   "license": "MIT",
   "sideEffects": false,
@@ -23,7 +23,8 @@
   "files": [
     "/dist",
     "/LICENSE",
-    "/README.md"
+    "/README.md",
+    "/CHANGELOG.md"
   ],
   "scripts": {
     "build": "rm -rf ./dist && tsc -p tsconfig.build.json",
@@ -39,13 +40,17 @@
   "dependencies": {
     "jsqr": "^1.4.0",
     "otpauth": "9.3.6",
-    "playwright": "1.58.2",
     "pngjs": "^6.0.0",
-    "tslib": "^2.5.3"
+    "tslib": "^2.5.3",
+    "zod": "^4.1.11"
   },
   "devDependencies": {
     "@types/pngjs": "^6.0.5",
-    "typescript": "^5.9.2"
+    "playwright": "1.58.2",
+    "typescript": "^5.9.3"
+  },
+  "peerDependencies": {
+    "playwright": "1.58.2"
   },
   "engines": {
     "node": ">=22.22.0 <25"