@cronn/playwright-utils 0.0.1 → 0.1.0

package/dist/index.d.mts

@@ -1,5 +1,14 @@
 import { Normalizer } from "@cronn/playwright-file-snapshots";
 import { APIRequestContext, Locator, Page } from "@playwright/test";
+//#region src/environment.d.ts
+/**
+ * Whether the current process runs in a CI environment, based on the `CI`
+ * environment variable.
+ *
+ * Evaluated once when the module is loaded.
+ */
+declare const isCI: boolean;
+//#endregion
 //#region src/api/fetch-adapter.d.ts
 type FetchAPI = typeof fetch;
 /**
@@ -12,7 +21,22 @@ type FetchAPI = typeof fetch;
  * @param requestContext - Playwright request context to send requests with
  * @returns A function with the signature of the global `fetch`
  */
-declare function fetchAdapter(requestContext: APIRequestContext): FetchAPI;
+declare function createFetchAdapter(requestContext: APIRequestContext): FetchAPI;
+//#endregion
+//#region src/file.d.ts
+/**
+ * Resolves the given path segments against the root directory of the closest
+ * package, i.e. the closest directory containing a `package.json`, searching
+ * upwards from the current working directory.
+ *
+ * Useful for referencing files independently of the directory a test run is
+ * started from, e.g. a subdirectory of the package.
+ *
+ * @param paths - Path segments to resolve against the package root
+ * @returns The absolute path to the resolved location
+ * @throws If no package root can be found
+ */
+declare function resolveFromPackageRoot(...paths: Array<string>): string;
 //#endregion
 //#region src/normalizers/mask-base-url.d.ts
 /**
@@ -46,5 +70,4 @@ declare function maskedValueWithIndex(name: string): (index: number) => string;
  */
 type PlaywrightTarget = Page | Locator;
 //#endregion
-export { type PlaywrightTarget, fetchAdapter, maskBaseURL, maskedValue, maskedValueWithIndex };
-//# sourceMappingURL=index.d.mts.map
+export { type PlaywrightTarget, createFetchAdapter, isCI, maskBaseURL, maskedValue, maskedValueWithIndex, resolveFromPackageRoot };

package/dist/index.mjs

@@ -1,4 +1,15 @@
+import path from "node:path";
+import { packageDirectorySync } from "package-directory";
 import { maskString, stringNormalizer } from "@cronn/playwright-file-snapshots";
+//#region src/environment.ts
+/**
+* Whether the current process runs in a CI environment, based on the `CI`
+* environment variable.
+*
+* Evaluated once when the module is loaded.
+*/
+const isCI = process.env.CI === "true";
+//#endregion
 //#region src/api/fetch-adapter.ts
 /**
 * Creates a `fetch`-compatible function backed by a Playwright
@@ -10,7 +21,7 @@ import { maskString, stringNormalizer } from "@cronn/playwright-file-snapshots";
 * @param requestContext - Playwright request context to send requests with
 * @returns A function with the signature of the global `fetch`
 */
-function fetchAdapter(requestContext) {
+function createFetchAdapter(requestContext) {
 	return async (input, init) => {
 		const response = await requestContext.fetch(mapToUrl(input), await mapToOptions(input instanceof Request ? input : null, init));
 		const responseBody = await response.body();
@@ -43,6 +54,25 @@ function mapToRequestBody(body) {
 	return { data: body };
 }
 //#endregion
+//#region src/file.ts
+/**
+* Resolves the given path segments against the root directory of the closest
+* package, i.e. the closest directory containing a `package.json`, searching
+* upwards from the current working directory.
+*
+* Useful for referencing files independently of the directory a test run is
+* started from, e.g. a subdirectory of the package.
+*
+* @param paths - Path segments to resolve against the package root
+* @returns The absolute path to the resolved location
+* @throws If no package root can be found
+*/
+function resolveFromPackageRoot(...paths) {
+	const packageDir = packageDirectorySync();
+	if (packageDir === void 0) throw new Error("Unable to resolve package directory");
+	return path.resolve(packageDir, ...paths);
+}
+//#endregion
 //#region src/normalizers/masked-value.ts
 /**
 * Formats a name as a masked placeholder, e.g. `maskedValue("base url")`
@@ -78,6 +108,4 @@ function identity(value) {
 	return value;
 }
 //#endregion
-export { fetchAdapter, maskBaseURL, maskedValue, maskedValueWithIndex };
-
-//# sourceMappingURL=index.mjs.map
+export { createFetchAdapter, isCI, maskBaseURL, maskedValue, maskedValueWithIndex, resolveFromPackageRoot };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cronn/playwright-utils",
-  "version": "0.0.1",
+  "version": "0.1.0",
   "description": "Utilities for writing tests with Playwright",
   "keywords": [
     "playwright",
@@ -28,29 +28,8 @@
       "default": "./dist/index.mjs"
     }
   },
-  "scripts": {
-    "build": "tsdown",
-    "clean": "rimraf .turbo dist coverage playwright-report test-results docs/.vitepress/cache docs/.vitepress/dist && pnpm run pnpm:clean",
-    "compile": "tsc",
-    "docs:build": "vitepress build docs",
-    "docs:dev": "vitepress dev docs",
-    "docs:preview": "vitepress preview docs",
-    "format:check": "oxfmt --check",
-    "format:fix": "oxfmt",
-    "knip:check": "knip",
-    "knip:fix": "knip --fix",
-    "lint:check": "eslint . --max-warnings=0",
-    "lint:fix": "eslint . --max-warnings=0 --fix",
-    "playwright:install": "playwright install chromium",
-    "pnpm:check": "pnpm dedupe --check",
-    "pnpm:clean": "pnpm pm clean && pnpm store prune",
-    "pnpm:fix": "pnpm dedupe",
-    "prepublishOnly": "pnpm turbo run ci",
-    "release": "pnpm turbo run build && pnpm changeset publish",
-    "test:integration": "playwright test",
-    "test:unit": "vitest run",
-    "test:unit:coverage": "vitest run --coverage",
-    "version": "pnpm changeset version && pnpm turbo run format:fix"
+  "dependencies": {
+    "package-directory": "8.2.0"
   },
   "devDependencies": {
     "@arethetypeswrong/core": "0.18.5",
@@ -75,7 +54,8 @@
     "typescript-eslint": "8.67.0",
     "vitepress": "2.0.0-alpha.19",
     "vitepress-plugin-group-icons": "1.7.6",
-    "vitest": "4.1.10"
+    "vitest": "4.1.10",
+    "node": "runtime:24.19.0"
   },
   "peerDependencies": {
     "@cronn/playwright-file-snapshots": "^2",
@@ -85,15 +65,38 @@
     "packageManager": {
       "name": "pnpm",
       "version": "11.22.0",
-      "onFail": "ignore"
+      "onFail": "download"
     },
     "runtime": {
       "name": "node",
       "version": "24.19.0",
-      "onFail": "ignore"
+      "onFail": "download"
     }
   },
   "engines": {
     "node": "^22 || ^24 || >=26"
+  },
+  "scripts": {
+    "build": "tsdown",
+    "clean": "rimraf .turbo dist coverage playwright-report test-results docs/.vitepress/cache docs/.vitepress/dist && pnpm run pnpm:clean",
+    "compile": "tsc",
+    "docs:build": "vitepress build docs",
+    "docs:dev": "vitepress dev docs",
+    "docs:preview": "vitepress preview docs",
+    "format:check": "oxfmt --check",
+    "format:fix": "oxfmt",
+    "knip:check": "knip",
+    "knip:fix": "knip --fix",
+    "lint:check": "eslint . --max-warnings=0",
+    "lint:fix": "eslint . --max-warnings=0 --fix",
+    "playwright:install": "playwright install chromium",
+    "pnpm:check": "pnpm dedupe --check",
+    "pnpm:clean": "pnpm pm clean && pnpm store prune",
+    "pnpm:fix": "pnpm dedupe",
+    "release": "pnpm turbo run build && pnpm changeset publish",
+    "test:integration": "playwright test",
+    "test:unit": "vitest run",
+    "test:unit:coverage": "vitest run --coverage",
+    "version": "pnpm changeset version && pnpm turbo run format:fix"
   }
-}
+}

package/dist/index.d.mts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.mts","names":[],"sources":["../src/api/fetch-adapter.ts","../src/normalizers/mask-base-url.ts","../src/normalizers/masked-value.ts","../src/types/playwright.ts"],"mappings":";;;KAEY,kBAAkB;;;;;;;;;;;iBAgBd,aAAa,gBAAgB,oBAAoB;;;;;;;;;iBCPjD,YAAY,QAC1B,8BACC,WAAW;;;;;;;;;iBCPE,YAAY;;;;;;;iBAWZ,qBAAqB,gBAAgB;;;;;;;KCXzC,mBAAmB,OAAO"}

package/dist/index.mjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.mjs","names":[],"sources":["../src/api/fetch-adapter.ts","../src/normalizers/masked-value.ts","../src/normalizers/mask-base-url.ts"],"sourcesContent":["import type { APIRequestContext } from \"@playwright/test\";\n\nexport type FetchAPI = typeof fetch;\n\ntype PlaywrightFetchOptions = NonNullable<\n  Parameters<APIRequestContext[\"fetch\"]>[1]\n>;\n\n/**\n * Creates a `fetch`-compatible function backed by a Playwright\n * {@link APIRequestContext}.\n *\n * Useful for passing Playwright's request context to API clients that expect\n * the standard Fetch API.\n *\n * @param requestContext - Playwright request context to send requests with\n * @returns A function with the signature of the global `fetch`\n */\nexport function fetchAdapter(requestContext: APIRequestContext): FetchAPI {\n  return async (input, init): Promise<Response> => {\n    const response = await requestContext.fetch(\n      mapToUrl(input),\n      await mapToOptions(input instanceof Request ? input : null, init),\n    );\n\n    const responseBody = await response.body();\n    return new Response(Buffer.from(responseBody), {\n      status: response.status(),\n      headers: response.headers(),\n    });\n  };\n}\n\nfunction mapToUrl(input: RequestInfo | URL): string {\n  if (typeof input === \"string\") {\n    return input;\n  }\n\n  if (input instanceof Request) {\n    return input.url;\n  }\n\n  return input.toString();\n}\n\nasync function mapToOptions(\n  request: Request | null,\n  init?: RequestInit,\n): Promise<PlaywrightFetchOptions> {\n  const requestBody =\n    request?.body !== null ? await request?.bytes() : undefined;\n  return {\n    method: request?.method ?? init?.method,\n    headers: mapToRequestHeaders(request?.headers ?? init?.headers),\n    ...mapToRequestBody(\n      requestBody !== undefined ? Buffer.from(requestBody) : init?.body,\n    ),\n  };\n}\n\nfunction mapToRequestHeaders(\n  headers: HeadersInit | undefined,\n): PlaywrightFetchOptions[\"headers\"] {\n  if (Array.isArray(headers)) {\n    return Object.fromEntries(headers);\n  }\n\n  if (headers instanceof Headers) {\n    return Object.fromEntries(headers.entries());\n  }\n\n  return headers;\n}\n\nfunction mapToRequestBody(\n  body: BodyInit | null | undefined,\n): Pick<PlaywrightFetchOptions, \"data\" | \"multipart\"> {\n  if (body instanceof FormData) {\n    return {\n      multipart: body,\n    };\n  }\n\n  return {\n    data: body,\n  };\n}\n","/**\n * Formats a name as a masked placeholder, e.g. `maskedValue(\"base url\")`\n * returns `[BASE_URL]`.\n *\n * @param name - Name of the masked value\n */\nexport function maskedValue(name: string): string {\n  const normalizedName = name.toUpperCase().replace(/[ -.:,;]/g, \"_\");\n  return `[${normalizedName}]`;\n}\n\n/**\n * Creates a factory for indexed masked placeholders, e.g. `[USER_1]`.\n *\n * @param name - Name of the masked value\n * @returns A function mapping an index to a masked placeholder\n */\nexport function maskedValueWithIndex(name: string): (index: number) => string {\n  return (index: number) => maskedValue(`${name}_${index}`);\n}\n","import type { Normalizer } from \"@cronn/playwright-file-snapshots\";\nimport { maskString, stringNormalizer } from \"@cronn/playwright-file-snapshots\";\n\nimport { maskedValue } from \"./masked-value\";\n\n/**\n * Creates a normalizer that replaces occurrences of the base URL with\n * `[BASE_URL]`, keeping file snapshots stable across environments.\n *\n * @param baseURL - Base URL to mask; if `undefined`, values are left unchanged\n */\nexport function maskBaseURL<TValue>(\n  baseURL: string | undefined,\n): Normalizer<TValue> {\n  if (baseURL === undefined) {\n    return identity<TValue>;\n  }\n\n  return stringNormalizer(maskString(baseURL, maskedValue(\"BASE_URL\")));\n}\n\nfunction identity<TValue>(value: TValue): TValue {\n  return value;\n}\n"],"mappings":";;;;;;;;;;;;AAkBA,SAAgB,aAAa,gBAA6C;CACxE,OAAO,OAAO,OAAO,SAA4B;EAC/C,MAAM,WAAW,MAAM,eAAe,MACpC,SAAS,KAAK,GACd,MAAM,aAAa,iBAAiB,UAAU,QAAQ,MAAM,IAAI,CAClE;EAEA,MAAM,eAAe,MAAM,SAAS,KAAK;EACzC,OAAO,IAAI,SAAS,OAAO,KAAK,YAAY,GAAG;GAC7C,QAAQ,SAAS,OAAO;GACxB,SAAS,SAAS,QAAQ;EAC5B,CAAC;CACH;AACF;AAEA,SAAS,SAAS,OAAkC;CAClD,IAAI,OAAO,UAAU,UACnB,OAAO;CAGT,IAAI,iBAAiB,SACnB,OAAO,MAAM;CAGf,OAAO,MAAM,SAAS;AACxB;AAEA,eAAe,aACb,SACA,MACiC;CACjC,MAAM,cACJ,SAAS,SAAS,OAAO,MAAM,SAAS,MAAM,IAAI,KAAA;CACpD,OAAO;EACL,QAAQ,SAAS,UAAU,MAAM;EACjC,SAAS,oBAAoB,SAAS,WAAW,MAAM,OAAO;EAC9D,GAAG,iBACD,gBAAgB,KAAA,IAAY,OAAO,KAAK,WAAW,IAAI,MAAM,IAC/D;CACF;AACF;AAEA,SAAS,oBACP,SACmC;CACnC,IAAI,MAAM,QAAQ,OAAO,GACvB,OAAO,OAAO,YAAY,OAAO;CAGnC,IAAI,mBAAmB,SACrB,OAAO,OAAO,YAAY,QAAQ,QAAQ,CAAC;CAG7C,OAAO;AACT;AAEA,SAAS,iBACP,MACoD;CACpD,IAAI,gBAAgB,UAClB,OAAO,EACL,WAAW,KACb;CAGF,OAAO,EACL,MAAM,KACR;AACF;;;;;;;;;AChFA,SAAgB,YAAY,MAAsB;CAEhD,OAAO,IADgB,KAAK,YAAY,CAAC,CAAC,QAAQ,aAAa,GACvC,EAAE;AAC5B;;;;;;;AAQA,SAAgB,qBAAqB,MAAyC;CAC5E,QAAQ,UAAkB,YAAY,GAAG,KAAK,GAAG,OAAO;AAC1D;;;;;;;;;ACRA,SAAgB,YACd,SACoB;CACpB,IAAI,YAAY,KAAA,GACd,OAAO;CAGT,OAAO,iBAAiB,WAAW,SAAS,YAAY,UAAU,CAAC,CAAC;AACtE;AAEA,SAAS,SAAiB,OAAuB;CAC/C,OAAO;AACT"}