@checkly/playwright-reporter 1.1.0 → 1.2.0

package/CHANGELOG.md

@@ -4,6 +4,26 @@ All notable changes to `@checkly/playwright-reporter` will be documented in this
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/).
 
+## 1.2.0 (2026-01-21)
+
+### Breaking Changes
+
+- **Credentials now required** - The reporter now requires Checkly credentials (`apiKey` + `accountId`) or explicit `dryRun: true`. Previously, missing credentials would silently skip uploading. Now you'll get a clear error message explaining what's needed.
+
+**If you're not using Checkly Test Sessions**, add `dryRun: true` to your config:
+
+```typescript
+reporter: [['@checkly/playwright-reporter', { dryRun: true }]]
+```
+
+### Added
+
+- Clear error messages for credential issues:
+  - Shows both the config option and environment variable (e.g., "apiKey / CHECKLY_API_KEY")
+  - Includes a direct link to the API keys settings page
+  - Invalid API keys show "Authentication failed" instead of a generic error
+  - Wrong account IDs show "Access denied" with guidance to check the account ID
+
 ## 1.1.0 (2026-01-20)
 
 > **Note:** This minor version contains breaking changes. Due to options API configurations in 1.0.x that could lead to broken states, we decided to publish this as a minor version and unpublish previous 1.0.x releases to prevent issues. If you were using 1.0.x, please update your configuration as described below.

package/dist/index.d.ts

@@ -21,6 +21,10 @@ interface JSONReportTestResult extends JSONReportTestResult$1 {
     _checkly?: ChecklyData;
 }
 
+declare class MissingCredentialsError extends Error {
+    constructor(missing: string[]);
+}
+
 /**
  * Configuration options for the Checkly Playwright Reporter.
  */
@@ -61,4 +65,4 @@ declare const _default: ChecklyReporterClass;
  */
 declare function createChecklyReporter(options?: ChecklyReporterOptions): ['@checkly/playwright-reporter', ChecklyReporterOptions];
 
-export { type ChecklyConsoleLog, type ChecklyData, type ChecklyNetworkRequest, type ChecklyReporterOptions, type JSONReportTestResult, createChecklyReporter, _default as default };
+export { type ChecklyConsoleLog, type ChecklyData, type ChecklyNetworkRequest, type ChecklyReporterOptions, type JSONReportTestResult, MissingCredentialsError, createChecklyReporter, _default as default };

package/dist/index.js

@@ -30,6 +30,7 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 // src/index.ts
 var index_exports = {};
 __export(index_exports, {
+  MissingCredentialsError: () => MissingCredentialsError,
   createChecklyReporter: () => createChecklyReporter,
   default: () => index_default
 });
@@ -1635,6 +1636,18 @@ function createClient(options) {
 }
 
 // src/extensions/checkly-upload.ts
+var MissingCredentialsError = class extends Error {
+  constructor(missing) {
+    const missingList = missing.map((m) => m === "CHECKLY_API_KEY" ? "apiKey / CHECKLY_API_KEY" : "accountId / CHECKLY_ACCOUNT_ID").join(", ");
+    super(
+      `Missing required Checkly credentials: ${missingList}.
+  Provide them via reporter options or environment variables.
+  Get your API key at: https://app.checklyhq.com/settings/user/api-keys
+  Or use dryRun: true for local report generation.`
+    );
+    this.name = "MissingCredentialsError";
+  }
+};
 function getPackageVersion() {
   try {
     const packageJson = JSON.parse(fs5.readFileSync(path4.join(__dirname, "..", "package.json"), "utf-8"));
@@ -1713,6 +1726,20 @@ function checklyUpload(options = {}) {
       });
       log("\u2705 Session created", { id: testSession.testSessionId });
     } catch (err2) {
+      if (err2 instanceof UnauthorizedError) {
+        console.error(
+          "[Checkly] Authentication failed: Invalid API key.\n  Please verify your apiKey option or CHECKLY_API_KEY environment variable is correct.\n  Get your API key at: https://app.checklyhq.com/settings/user/api-keys"
+        );
+        api = void 0;
+        return;
+      }
+      if (err2 instanceof ForbiddenError) {
+        console.error(
+          "[Checkly] Access denied: You do not have access to this account.\n  Please verify your accountId option or CHECKLY_ACCOUNT_ID environment variable is correct.\n  Get your API key at: https://app.checklyhq.com/settings/user/api-keys"
+        );
+        api = void 0;
+        return;
+      }
       console.error("[Checkly] Failed to create test session:", err2);
     }
   }
@@ -1847,10 +1874,14 @@ function checklyUpload(options = {}) {
       assetCollector = new AssetCollector(resolvedOutputDir);
       zipper = new Zipper({ outputPath: zipPath });
       if (!canUpload) {
-        if (!dryRun && (!apiKey || !accountId)) {
-          log("\u26A0\uFE0F Skipping upload (missing API credentials)");
+        if (dryRun) {
+          console.warn("[Checkly] Dry run mode - report will be generated locally");
+          return;
         }
-        return;
+        const missing = [];
+        if (!apiKey) missing.push("CHECKLY_API_KEY");
+        if (!accountId) missing.push("CHECKLY_ACCOUNT_ID");
+        throw new MissingCredentialsError(missing);
       }
       api = createClient({
         apiKey,
@@ -2452,5 +2483,6 @@ function createChecklyReporter(options = {}) {
 }
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
+  MissingCredentialsError,
   createChecklyReporter
 });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@checkly/playwright-reporter",
-  "version": "1.1.0",
+  "version": "1.2.0",
   "description": "Standalone Playwright reporter for Checkly - compatible with Playwright 1.40-1.57+",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -35,10 +35,11 @@
     "tsup": "8.5.1",
     "tsx": "4.19.0",
     "typescript": "5.9.3",
-    "@checkly/reporter-utils": "1.1.0"
+    "@checkly/reporter-utils": "1.2.0"
   },
   "scripts": {
     "build": "tsup",
+    "test:e2e": "pnpm build && vitest run --config vitest.e2e.config.ts",
     "test:integration": "playwright test -c src/__tests__/integration/playwright.config.ts",
     "test:integration:validate": "tsx src/__tests__/integration/validate-baseline.ts",
     "test:pw-version": "./scripts/test-pw-version.sh",