@reportforge/playwright-pdf 0.12.0 → 0.13.0

package/README.md

@@ -55,7 +55,7 @@ Three templates, one reporter. Every PDF is fully offline — fonts, charts, and
 - **CI/CD snippets** — GitHub Actions, GitLab CI, Bitbucket Pipelines, Jenkins, Azure DevOps
 - **Live runs** — opt-in `live` streams per-test progress to an unguessable watch link printed at run start; all shards of one CI run converge on a single live dashboard while tests execute. The PDF is still produced at the end, unchanged
 - **Shard merging** — combine N Playwright JSON shard reports into one PDF via `shardResults`; accepts glob patterns or explicit paths
-- **Notifications** — post pass/fail summaries to Slack, Teams, Discord, or email after each run; configurable trigger (`always` / `failure` / `success`) per channel; email supports optional PDF attachment via `attachPdf`
+- **Notifications** — post pass/fail summaries to Slack, Teams, Discord, or email after each run; configurable trigger (`always` / `failure` / `success`) per channel; email and Discord support optional PDF attachment via `attachPdf`
 - **Flakiness trend** — top-N flakiest tests table with per-test dot sparkline across stored history runs in the `detailed` template; `flakinessTopN` option (default 5, `0` disables)
 - **Offline failure analysis** — sorts each failure into one of 7 root-cause buckets and renders a per-test root-cause chip inline under the failed test in the `detailed` PDF (dominant-cause one-liner in `executive`). No network, no AI service — a small embedded classifier that updates itself safely over your existing license refresh; pin it any time. Full details at [reportforge.org/docs/advanced/failure-analysis](https://reportforge.org/docs/advanced/failure-analysis).
 - `npx @reportforge/playwright-pdf export-feedback` — exports locally-collected unrecognized failures (tokenized, local-only) for optional manual sharing.
@@ -194,7 +194,7 @@ All options are the second element of the reporter tuple.
 | `maxInlineFailures` | `number` | derived from `compressionLevel` | Cap on failure entries rendered inline in the PDF. Overflow is written to a sibling `{basename}-failures.json` sidecar file. |
 | `maxFileSizeMb` | `number` | `8` | Soft cap on the final PDF size in MB. If exceeded, the report is re-rendered once with the `'max'` compression preset. |
 | `shardResults` | `string \| string[]` | — | Glob or path array of Playwright JSON shard report files to merge into one PDF. See the Shard Merging docs. |
-| `notify` | `object` | — | Notification channels: `slack`, `teams`, `discord` (each `{ url, enabled, on }`), `email` (`{ to, enabled, on, attachPdf }`). See the Notifications docs. |
+| `notify` | `object` | — | Notification channels: `slack`, `teams` (each `{ url, enabled, on }`), `discord` (`{ url, enabled, on, attachPdf }`), `email` (`{ to, enabled, on, attachPdf }`). See the Notifications docs. |
 | `failureAnalysis` | `object` | `{ enabled: true }` | Offline failure root-cause analysis (embedded Naive Bayes; no runtime network). Fields: `enabled` (default `true`), `maxClusters` (default `10`), `minStrength` (`weak`\|`moderate`\|`strong`, default `weak`), `maxFailuresToAnalyse` (default `500`), `collectUnclassified` (default `true`), `autoUpdateModel` (default `true`). See the Failure Analysis docs. |
 | `capture` | `object` | `{}` (off) | Opt-in rich execution capture for the defect log (reporter-side; no fixtures, no test-code changes). Fields: `steps` (a copy-pasteable "Steps to Reproduce" outline built from the Playwright step tree — each row a Markdown list line indented under its parent `test.step`, default `false`), `apiSteps` (include every top-level `pw:api` action (click/fill/check/goto) in the outline for a full action trail; off by default the outline shows only `test.step` intent + `expect` assertions, default `false`), `console` (Node stdout/stderr tail, default `false`), `evidence` (trace/video file links, default `false`), `maxSteps` (default `50`), `maxConsoleLines` (default `50`). Renders in the Defect Log section of the `detailed` template. |
 | `live` | `object` | `{}` (off) | Opt-in live test-execution streaming. When `enabled`, the reporter prints an unguessable watch link to the CI logs at run start and streams per-test progress to the hosted dashboard while tests run — all shards of one CI run converge on a single live view. Fields: `enabled` (default `false`), `runId` (override the auto-derived run id), `serverUrl` (override the streaming server), `steps` (`none`\|`failed`\|`intent`\|`all`, default `failed`; `intent` shows only your `test.step` names plus any failing step), `console` (stream stdout/stderr tails, default `false`), `flushMs` (batch debounce 500–10000, default `2000`). The PDF at the end of the run is unaffected. Requires an active subscription with the `live` entitlement. See the Live Runs docs. |
@@ -282,6 +282,7 @@ notify: {
     url: process.env.DISCORD_WEBHOOK_URL,
     enabled: true,
     on: 'failure',
+    attachPdf: true,             // upload the PDF with the message (default: false)
   },
   email: {
     to: ['team@company.com', 'qa@company.com'],
@@ -304,6 +305,8 @@ The `on` trigger controls when the message fires:
 
 **Email** requires `RESEND_API_KEY` in the environment (get one at [resend.com](https://resend.com)). Sender defaults to `noreply@reportforge.org`; override with `RESEND_FROM`. Store webhook URLs and API keys as CI secrets — never commit them.
 
+**PDF attachment** (`attachPdf: true`) is available on `email` and `discord` — Slack and Teams webhooks cannot carry file uploads. On Discord the PDF is uploaded with the message; if the upload fails or the PDF exceeds Discord's file-size cap, the summary still posts without the attachment. With multiple templates, the first PDF is attached.
+
 The summary includes pass rate, test counts, duration, and the report filename. Notifications require a valid license and fire after PDF generation (or after a PDF failure — you still get the ping).
 
 ### Test History Trending

package/dist/cli/index.js

@@ -11921,7 +11921,7 @@ ${issues}`);
   }
   return result.data;
 }
-var hexColor, channelConfigSchema, emailChannelConfigSchema, notifyConfigSchema, failureAnalysisConfigSchema, captureConfigSchema, liveConfigSchema, sectionFlagsShape, sectionFlagsSchema, sectionsSchema, ReporterOptionsSchema;
+var hexColor, channelConfigSchema, discordChannelConfigSchema, emailChannelConfigSchema, notifyConfigSchema, failureAnalysisConfigSchema, captureConfigSchema, liveConfigSchema, sectionFlagsShape, sectionFlagsSchema, sectionsSchema, ReporterOptionsSchema;
 var init_schema = __esm({
   "src/config/schema.ts"() {
     "use strict";
@@ -11938,6 +11938,9 @@ var init_schema = __esm({
       on: external_exports.enum(["always", "failure", "success"]).default("always"),
       enabled: external_exports.boolean().default(false)
     });
+    discordChannelConfigSchema = channelConfigSchema.extend({
+      attachPdf: external_exports.boolean().default(false)
+    });
     emailChannelConfigSchema = external_exports.object({
       to: external_exports.array(external_exports.string().email('Each "to" entry must be a valid email')).min(1, '"to" must have at least one address'),
       on: external_exports.enum(["always", "failure", "success"]).default("always"),
@@ -11947,7 +11950,7 @@ var init_schema = __esm({
     notifyConfigSchema = external_exports.object({
       slack: channelConfigSchema.optional(),
       teams: channelConfigSchema.optional(),
-      discord: channelConfigSchema.optional(),
+      discord: discordChannelConfigSchema.optional(),
       email: emailChannelConfigSchema.optional()
     }).optional();
     failureAnalysisConfigSchema = external_exports.object({

package/dist/index.d.mts

@@ -158,7 +158,12 @@ interface ReporterOptions {
      * `on` controls the trigger: `'always'` (default), `'failure'`, or `'success'`.
      *
      * - `slack` / `teams` / `discord`: webhook URL channels
+     * - `discord`: `attachPdf: true` uploads the PDF with the message (falls back
+     *   to the summary alone if the upload fails or the PDF exceeds Discord's cap)
      * - `email`: sends via Resend; `to` is required; `attachPdf: true` attaches the PDF
+     *
+     * Slack and Teams webhooks cannot carry file uploads, so `attachPdf` does not
+     * exist on those channels.
      */
     notify?: {
         slack?: {
@@ -175,6 +180,7 @@ interface ReporterOptions {
             url: string;
             on?: 'always' | 'failure' | 'success';
             enabled?: boolean;
+            attachPdf?: boolean;
         };
         email?: {
             to: string[];

package/dist/index.d.ts

@@ -158,7 +158,12 @@ interface ReporterOptions {
      * `on` controls the trigger: `'always'` (default), `'failure'`, or `'success'`.
      *
      * - `slack` / `teams` / `discord`: webhook URL channels
+     * - `discord`: `attachPdf: true` uploads the PDF with the message (falls back
+     *   to the summary alone if the upload fails or the PDF exceeds Discord's cap)
      * - `email`: sends via Resend; `to` is required; `attachPdf: true` attaches the PDF
+     *
+     * Slack and Teams webhooks cannot carry file uploads, so `attachPdf` does not
+     * exist on those channels.
      */
     notify?: {
         slack?: {
@@ -175,6 +180,7 @@ interface ReporterOptions {
             url: string;
             on?: 'always' | 'failure' | 'success';
             enabled?: boolean;
+            attachPdf?: boolean;
         };
         email?: {
             to: string[];

package/dist/index.js

@@ -10454,6 +10454,9 @@ var channelConfigSchema = external_exports.object({
   on: external_exports.enum(["always", "failure", "success"]).default("always"),
   enabled: external_exports.boolean().default(false)
 });
+var discordChannelConfigSchema = channelConfigSchema.extend({
+  attachPdf: external_exports.boolean().default(false)
+});
 var emailChannelConfigSchema = external_exports.object({
   to: external_exports.array(external_exports.string().email('Each "to" entry must be a valid email')).min(1, '"to" must have at least one address'),
   on: external_exports.enum(["always", "failure", "success"]).default("always"),
@@ -10463,7 +10466,7 @@ var emailChannelConfigSchema = external_exports.object({
 var notifyConfigSchema = external_exports.object({
   slack: channelConfigSchema.optional(),
   teams: channelConfigSchema.optional(),
-  discord: channelConfigSchema.optional(),
+  discord: discordChannelConfigSchema.optional(),
   email: emailChannelConfigSchema.optional()
 }).optional();
 var failureAnalysisConfigSchema = external_exports.object({
@@ -13199,7 +13202,7 @@ function fmtMb(bytes) {
 }
 
 // src/reporter.ts
-var import_path12 = __toESM(require("path"));
+var import_path13 = __toESM(require("path"));
 
 // src/history/HistoryManager.ts
 init_cjs_shims();
@@ -13280,6 +13283,8 @@ init_cjs_shims();
 
 // src/notify/NotificationSender.ts
 init_cjs_shims();
+var import_promises2 = require("fs/promises");
+var import_path12 = require("path");
 
 // src/notify/formatters/slack.ts
 init_cjs_shims();
@@ -13529,6 +13534,7 @@ var FORMATTERS = {
   teams: buildTeamsPayload,
   discord: buildDiscordPayload
 };
+var DISCORD_MAX_UPLOAD_BYTES = 25 * 1024 * 1024;
 var NotificationSender = class {
   async sendAll(reportData, notifyConfig, pdfPaths) {
     const result = { sent: [], skipped: [], failed: [] };
@@ -13541,6 +13547,9 @@ var NotificationSender = class {
           return Promise.resolve();
         }
         const payload = FORMATTERS[name](reportData.stats, pdfPaths, reportTitle);
+        if (name === "discord" && notifyConfig.discord?.attachPdf && pdfPaths.length > 0) {
+          return this.postDiscordWithPdf(channel.url, payload, pdfPaths[0], result);
+        }
         return this.post(name, channel.url, payload, result);
       })
     );
@@ -13582,6 +13591,47 @@ var NotificationSender = class {
       })
     );
   }
+  /**
+   * Posts the summary to a Discord webhook with the PDF as a multipart file
+   * upload (`payload_json` + `files[0]`). Any problem — unreadable file, PDF
+   * over Discord's upload cap, or a failed upload — falls back to the plain
+   * JSON summary post so the notification still lands; only the fallback's
+   * outcome is recorded in the result. Attaches the first PDF only (matches
+   * the email channel's multi-template behaviour).
+   */
+  async postDiscordWithPdf(url, payload, pdfPath, result) {
+    let file;
+    try {
+      file = await (0, import_promises2.readFile)(pdfPath);
+      if (file.byteLength > DISCORD_MAX_UPLOAD_BYTES) {
+        const mb = (file.byteLength / 1024 / 1024).toFixed(1);
+        throw new Error(`PDF is ${mb}MB \u2014 over Discord's upload limit`);
+      }
+    } catch (err) {
+      logger.warn(
+        `[notify] discord: ${err instanceof Error ? err.message : String(err)} \u2014 sending summary without the PDF`
+      );
+      return this.post("discord", url, payload, result);
+    }
+    const form = new FormData();
+    form.append("payload_json", JSON.stringify(payload));
+    form.append("files[0]", new Blob([new Uint8Array(file)], { type: "application/pdf" }), (0, import_path12.basename)(pdfPath));
+    const controller = new AbortController();
+    const timeoutId = setTimeout(() => controller.abort(), 3e4);
+    try {
+      const res = await fetch(url, { method: "POST", body: form, signal: controller.signal });
+      if (!res.ok) throw new Error(`HTTP ${res.status}`);
+      logger.info("[notify] discord: sent (PDF attached)");
+      result.sent.push("discord");
+    } catch (err) {
+      logger.warn(
+        `[notify] discord: upload failed (${err instanceof Error ? err.message : String(err)}) \u2014 retrying without the PDF`
+      );
+      return this.post("discord", url, payload, result);
+    } finally {
+      clearTimeout(timeoutId);
+    }
+  }
   async post(name, url, payload, result) {
     const controller = new AbortController();
     const timeoutId = setTimeout(() => controller.abort(), 1e4);
@@ -13951,7 +14001,7 @@ var PdfReporter = class {
     this.liveConsole = false;
     this.options = parseOptions(rawOptions);
     this.dataCollector = new DataCollector(this.options.capture);
-    const version = true ? "0.12.0" : "0.x";
+    const version = true ? "0.13.0" : "0.x";
     logger.info(`@reportforge/playwright-pdf v${version} initialised`);
     this.licenseClient = new LicenseClient({
       licenseKey: this.options.licenseKey,
@@ -14219,7 +14269,7 @@ var PdfReporter = class {
   }
   resolveProjectName() {
     try {
-      const pkgPath = import_path12.default.resolve(process.cwd(), "package.json");
+      const pkgPath = import_path13.default.resolve(process.cwd(), "package.json");
       const pkg = require(pkgPath);
       return pkg.name ?? "Playwright Tests";
     } catch {
@@ -14269,9 +14319,9 @@ function deriveVerdict(stats) {
 }
 function resolveHistoryPath(options, cwd) {
   if (options.historyFile) {
-    return import_path12.default.isAbsolute(options.historyFile) ? options.historyFile : import_path12.default.resolve(cwd, options.historyFile);
+    return import_path13.default.isAbsolute(options.historyFile) ? options.historyFile : import_path13.default.resolve(cwd, options.historyFile);
   }
-  return import_path12.default.join(resolveProjectDir(options, cwd), "history.json");
+  return import_path13.default.join(resolveProjectDir(options, cwd), "history.json");
 }
 function flattenSuiteNodes(suites) {
   return suites.flatMap((s) => [s, ...flattenSuiteNodes(s.suites)]);

package/dist/index.mjs

@@ -10455,6 +10455,9 @@ var channelConfigSchema = external_exports.object({
   on: external_exports.enum(["always", "failure", "success"]).default("always"),
   enabled: external_exports.boolean().default(false)
 });
+var discordChannelConfigSchema = channelConfigSchema.extend({
+  attachPdf: external_exports.boolean().default(false)
+});
 var emailChannelConfigSchema = external_exports.object({
   to: external_exports.array(external_exports.string().email('Each "to" entry must be a valid email')).min(1, '"to" must have at least one address'),
   on: external_exports.enum(["always", "failure", "success"]).default("always"),
@@ -10464,7 +10467,7 @@ var emailChannelConfigSchema = external_exports.object({
 var notifyConfigSchema = external_exports.object({
   slack: channelConfigSchema.optional(),
   teams: channelConfigSchema.optional(),
-  discord: channelConfigSchema.optional(),
+  discord: discordChannelConfigSchema.optional(),
   email: emailChannelConfigSchema.optional()
 }).optional();
 var failureAnalysisConfigSchema = external_exports.object({
@@ -13281,6 +13284,8 @@ init_esm_shims();
 
 // src/notify/NotificationSender.ts
 init_esm_shims();
+import { readFile as readFile2 } from "fs/promises";
+import { basename as basename3 } from "path";
 
 // src/notify/formatters/slack.ts
 init_esm_shims();
@@ -13530,6 +13535,7 @@ var FORMATTERS = {
   teams: buildTeamsPayload,
   discord: buildDiscordPayload
 };
+var DISCORD_MAX_UPLOAD_BYTES = 25 * 1024 * 1024;
 var NotificationSender = class {
   async sendAll(reportData, notifyConfig, pdfPaths) {
     const result = { sent: [], skipped: [], failed: [] };
@@ -13542,6 +13548,9 @@ var NotificationSender = class {
           return Promise.resolve();
         }
         const payload = FORMATTERS[name](reportData.stats, pdfPaths, reportTitle);
+        if (name === "discord" && notifyConfig.discord?.attachPdf && pdfPaths.length > 0) {
+          return this.postDiscordWithPdf(channel.url, payload, pdfPaths[0], result);
+        }
         return this.post(name, channel.url, payload, result);
       })
     );
@@ -13583,6 +13592,47 @@ var NotificationSender = class {
       })
     );
   }
+  /**
+   * Posts the summary to a Discord webhook with the PDF as a multipart file
+   * upload (`payload_json` + `files[0]`). Any problem — unreadable file, PDF
+   * over Discord's upload cap, or a failed upload — falls back to the plain
+   * JSON summary post so the notification still lands; only the fallback's
+   * outcome is recorded in the result. Attaches the first PDF only (matches
+   * the email channel's multi-template behaviour).
+   */
+  async postDiscordWithPdf(url, payload, pdfPath, result) {
+    let file;
+    try {
+      file = await readFile2(pdfPath);
+      if (file.byteLength > DISCORD_MAX_UPLOAD_BYTES) {
+        const mb = (file.byteLength / 1024 / 1024).toFixed(1);
+        throw new Error(`PDF is ${mb}MB \u2014 over Discord's upload limit`);
+      }
+    } catch (err) {
+      logger.warn(
+        `[notify] discord: ${err instanceof Error ? err.message : String(err)} \u2014 sending summary without the PDF`
+      );
+      return this.post("discord", url, payload, result);
+    }
+    const form = new FormData();
+    form.append("payload_json", JSON.stringify(payload));
+    form.append("files[0]", new Blob([new Uint8Array(file)], { type: "application/pdf" }), basename3(pdfPath));
+    const controller = new AbortController();
+    const timeoutId = setTimeout(() => controller.abort(), 3e4);
+    try {
+      const res = await fetch(url, { method: "POST", body: form, signal: controller.signal });
+      if (!res.ok) throw new Error(`HTTP ${res.status}`);
+      logger.info("[notify] discord: sent (PDF attached)");
+      result.sent.push("discord");
+    } catch (err) {
+      logger.warn(
+        `[notify] discord: upload failed (${err instanceof Error ? err.message : String(err)}) \u2014 retrying without the PDF`
+      );
+      return this.post("discord", url, payload, result);
+    } finally {
+      clearTimeout(timeoutId);
+    }
+  }
   async post(name, url, payload, result) {
     const controller = new AbortController();
     const timeoutId = setTimeout(() => controller.abort(), 1e4);
@@ -13952,7 +14002,7 @@ var PdfReporter = class {
     this.liveConsole = false;
     this.options = parseOptions(rawOptions);
     this.dataCollector = new DataCollector(this.options.capture);
-    const version = true ? "0.12.0" : "0.x";
+    const version = true ? "0.13.0" : "0.x";
     logger.info(`@reportforge/playwright-pdf v${version} initialised`);
     this.licenseClient = new LicenseClient({
       licenseKey: this.options.licenseKey,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@reportforge/playwright-pdf",
-  "version": "0.12.0",
+  "version": "0.13.0",
   "description": "Enterprise-ready PDF reports for Playwright Test — minimal, detailed, and executive templates with CI/CD integrations",
   "license": "MIT",
   "author": "ReportForge",