@qualflare/playwright 0.1.0

package/LICENSE

@@ -0,0 +1,190 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright 2026 Qualflare
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,139 @@
+# @qualflare/playwright
+
+[![npm version](https://img.shields.io/npm/v/%40qualflare%2Fplaywright.svg)](https://www.npmjs.com/package/@qualflare/playwright)
+[![CI](https://github.com/Qualflare/qualflare-playwright/actions/workflows/ci.yml/badge.svg)](https://github.com/Qualflare/qualflare-playwright/actions/workflows/ci.yml)
+[![License: Apache-2.0](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](./LICENSE)
+
+A native Playwright reporter for [Qualflare](https://qualflare.com) — captures test results directly
+from your `playwright test` run: status, real retry counts and flakiness, nested `test.step()` trees,
+screenshots, videos, and author-facing metadata (labels, links, tags, priority, custom attachments).
+
+The reporter itself makes **no network calls**. It writes a report directory, and
+[`qualflare-cli`](https://github.com/Qualflare/qualflare-cli) uploads it — which is what lets any
+number of sharded CI jobs merge into a single Launch.
+
+## Install
+
+```sh
+npm install --save-dev @qualflare/playwright
+```
+
+Requires `@playwright/test` `>=1.40.0` (installed separately as a peer dependency) and Node `>=18`
+(Playwright 1.62+ itself requires Node `>=20`). You also need
+[`@qualflare/cli`](https://github.com/Qualflare/qualflare-cli) **v0.1.17 or newer** to upload what
+this reporter writes.
+
+The peer range is deliberately open-ended rather than capped at a known-good version, so a new
+Playwright release never hard-blocks `npm install` for you. 1.40, 1.50 and 1.62 are exercised in CI
+against a real `playwright test` run; newer versions are untested but not refused — please
+[open an issue](https://github.com/Qualflare/qualflare-playwright/issues) if one misbehaves.
+
+## Quickstart
+
+```ts
+// playwright.config.ts
+import { defineConfig } from '@playwright/test';
+import { qualflareReporter } from '@qualflare/playwright';
+
+export default defineConfig({
+  reporter: [['list'], qualflareReporter({ environment: 'staging' })],
+});
+```
+
+`qualflareReporter()` is a typed helper. Playwright types reporter options as `any`, so the
+hand-written tuple form silently accepts typos — but it works too, if you prefer it:
+
+```ts
+reporter: [['list'], ['@qualflare/playwright/reporter', { environment: 'staging' }]],
+```
+
+Then run your tests and upload the results — two steps, and no token needed for the first:
+
+```sh
+# 1. Run. Writes ./qualflare-results (JSON + any videos). Zero network calls.
+npx playwright test
+
+# 2. Upload. `qf login <identifier> <token>` stores the credential once.
+qf <your-project-identifier> collect ./qualflare-results
+```
+
+### Sharded CI
+
+Point every shard at the **same** `outputDir` and collect once at the end. Each process writes its
+own uniquely-named file, so shards never overwrite each other, and `qf collect` merges every file in
+the directory into a single Launch:
+
+```sh
+# in each parallel job — all writing to the same directory
+npx playwright test --shard="$SHARD_INDEX/$SHARD_TOTAL"
+
+# once, after all shards finish (e.g. with the directory restored from CI artifacts)
+qf <your-project-identifier> collect ./qualflare-results
+```
+
+Nothing needs configuring for this: Playwright hands reporters its own `--shard` value, so each
+case is stamped with the shard that ran it automatically. (Playwright's shard index is 1-based and
+Qualflare's is 0-based; the conversion is handled for you.)
+
+## Enriching your tests
+
+```ts
+import { test, expect } from '@playwright/test';
+import { qualflare } from '@qualflare/playwright';
+
+test('a user can check out @smoke', async ({ page }) => {
+  qualflare.label('epic', 'Billing');
+  qualflare.link('https://tracker.example/QF-42', { type: 'issue', name: 'QF-42' });
+  qualflare.priority('high');
+
+  await qualflare.step('add an item to the cart', async () => {
+    qualflare.parameter('sku', 'BOOK-1');
+    await page.getByRole('button', { name: 'Add' }).click();
+  });
+
+  await expect(page.getByTestId('total')).toHaveText('10.00');
+});
+```
+
+`qualflare.step()` delegates to Playwright's own `test.step()`, so your steps appear in the
+Playwright HTML report and trace viewer as well as in Qualflare. Full reference in
+[`docs/METADATA-API.md`](./docs/METADATA-API.md).
+
+## Configuration
+
+Every option has an environment-variable override, and everything has a sensible default — see
+[`docs/CONFIGURATION.md`](./docs/CONFIGURATION.md). There is no `token` option: this reporter makes
+no requests, so it has no credential.
+
+## Known limitations
+
+- **Traces are not uploaded.** Playwright traces are `application/zip`, which Qualflare's attachment
+  upload endpoint rejects. They are deliberately not attached rather than attached as a link to
+  nothing.
+- **`pw:api` and `fixture` steps are filtered out by default** (`includeApiSteps`) — a single
+  browser test emits hundreds, which buries the steps you actually wrote. A *failed* one is always
+  kept.
+- **`outputDir` is merged blindly** — `qf collect` uploads every report file it finds, with no
+  run-identity check, so a directory left over from a previous run is silently merged into the
+  current one. Clear it at the start of each run.
+- **`merge-reports` mode is not supported** in v0.1.0 — use the `outputDir` flow above rather than
+  Playwright's `blob` reporter.
+
+Full details in [`docs/LIMITATIONS.md`](./docs/LIMITATIONS.md).
+
+## Development
+
+```sh
+npm run typecheck        # tsc --noEmit
+npm run lint             # eslint .
+npm run build            # tsup -> dist/ (ESM + CJS + d.ts)
+npm test                 # unit tests
+npm run test:integration # spawns a REAL `playwright test` against test/integration/fixtures/
+```
+
+The integration suite loads the reporter from the built `dist/`, not `src/`, so it exercises the
+real package `exports` map — run `npm run build` first.
+
+## License
+
+Apache-2.0

package/dist/index.cjs

@@ -0,0 +1,139 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var src_exports = {};
+__export(src_exports, {
+  qualflare: () => qualflare,
+  qualflareReporter: () => qualflareReporter
+});
+module.exports = __toCommonJS(src_exports);
+
+// src/runtime/qualflare-api.ts
+var import_test = require("@playwright/test");
+
+// src/shared/constants.ts
+var RESERVED_MESSAGE_MEDIA_TYPE = "application/vnd.qualflare.message+json";
+var MAX_VIDEO_UPLOAD_BYTES = 50 * 1024 * 1024;
+
+// src/shared/logger.ts
+var PREFIX = "[qualflare-playwright]";
+var logger = {
+  debug(...args) {
+    console.debug(PREFIX, ...args);
+  },
+  info(...args) {
+    console.log(PREFIX, ...args);
+  },
+  warn(...args) {
+    console.warn(PREFIX, ...args);
+  },
+  error(...args) {
+    console.error(PREFIX, ...args);
+  }
+};
+
+// src/runtime/qualflare-api.ts
+function send(message) {
+  try {
+    void import_test.test.info().attach(`qualflare:${message.type}`, {
+      body: Buffer.from(JSON.stringify(message), "utf8"),
+      contentType: RESERVED_MESSAGE_MEDIA_TYPE
+    }).catch((err) => {
+      logger.warn(`qualflare.${message.type}() could not be recorded: ${err.message}`);
+    });
+  } catch {
+    logger.warn(`qualflare.${message.type}() was called outside a running test; the call was ignored.`);
+  }
+}
+var qualflare = {
+  /** Arbitrary name/value metadata (epic, feature, story, owner, severity). */
+  label(name, value) {
+    send({ type: "label", name, value });
+  },
+  /** A typed external reference. `type` defaults to `custom`. */
+  link(url, opts) {
+    send({ type: "link", url, linkType: opts?.type, name: opts?.name });
+  },
+  /** One or more free-text tags. */
+  tag(...tags) {
+    send({ type: "tag", tags });
+  },
+  /** Markdown description shown on the case. */
+  description(text) {
+    send({ type: "description", text });
+  },
+  /** Case priority (low | medium | high | critical). */
+  priority(value) {
+    send({ type: "priority", value });
+  },
+  /** A named input. Inside an open `step()` it attaches to that step;
+   * outside any step it lands in the case's properties. `masked` is a
+   * display hint for the UI only — the server does not redact the value. */
+  parameter(name, value, opts) {
+    send({ type: "parameter", name, value, masked: opts?.masked });
+  },
+  /** Attach in-memory content. */
+  attachment(name, content, opts) {
+    const contentBase64 = opts?.encoding === "base64" ? content : Buffer.from(content, "utf8").toString("base64");
+    send({ type: "attachment", name, contentBase64, mimeType: opts?.mimeType });
+  },
+  /** Attach a file from disk. */
+  attachmentFromFile(name, path, opts) {
+    send({ type: "attachment_from_file", name, path, mimeType: opts?.mimeType });
+  },
+  /**
+   * Records a named step around `fn`.
+   *
+   * Unlike the cucumber-js equivalent, this delegates to Playwright's own
+   * `test.step()` as well, so the step shows up in Playwright's HTML report
+   * and trace viewer in addition to Qualflare — there is no reason to make
+   * users choose, and a step that exists in only one of the two is a
+   * confusing thing to debug against.
+   */
+  async step(name, fn) {
+    return import_test.test.step(name, async () => {
+      send({ type: "step_start", name, timestamp: Date.now() });
+      try {
+        const result = await fn();
+        send({ type: "step_stop", status: "passed", timestamp: Date.now() });
+        return result;
+      } catch (err) {
+        send({
+          type: "step_stop",
+          status: "failed",
+          error: err instanceof Error ? err.message : String(err),
+          timestamp: Date.now()
+        });
+        throw err;
+      }
+    });
+  }
+};
+
+// src/index.ts
+function qualflareReporter(options = {}) {
+  return ["@qualflare/playwright/reporter", options];
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  qualflare,
+  qualflareReporter
+});
+//# sourceMappingURL=index.cjs.map

package/dist/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/index.ts","../src/runtime/qualflare-api.ts","../src/shared/constants.ts","../src/shared/logger.ts"],"sourcesContent":["import type { ReporterDescription } from '@playwright/test';\n\nimport type { QualflarePlaywrightOptions } from './config/resolve-config.js';\n\nexport { qualflare } from './runtime/qualflare-api.js';\n\nexport type { QualflarePlaywrightOptions, ResolvedReporterConfig } from './config/resolve-config.js';\n\nexport type {\n  Attachment,\n  Case,\n  CasePriority,\n  CaseStatus,\n  Collect,\n  FrameworkCategory,\n  Label,\n  Link,\n  LinkType,\n  Metadata,\n  NanosecondDuration,\n  Parameter,\n  Platform,\n  Step,\n  Suite,\n} from './shared/types.js';\n\n/**\n * Typed helper for registering the reporter.\n *\n * Playwright types a reporter's options as `any` (`ReporterDescription` ends\n * in `[string, any]`), so writing the tuple by hand gives no autocomplete and\n * silently accepts typos. This returns the same tuple with the options\n * checked:\n *\n * ```ts\n * import { defineConfig } from '@playwright/test';\n * import { qualflareReporter } from '@qualflare/playwright';\n *\n * export default defineConfig({\n *   reporter: [['list'], qualflareReporter({ environment: 'staging' })],\n * });\n * ```\n */\nexport function qualflareReporter(options: QualflarePlaywrightOptions = {}): ReporterDescription {\n  return ['@qualflare/playwright/reporter', options];\n}\n","import { test } from '@playwright/test';\n\nimport { RESERVED_MESSAGE_MEDIA_TYPE } from '../shared/constants.js';\nimport { logger } from '../shared/logger.js';\nimport type { CasePriority, LinkType } from '../shared/types.js';\nimport type { RuntimeMessage } from './message-types.js';\n\n/**\n * Ships one structured message from the test process to the reporter.\n *\n * Playwright runs tests in worker processes and reporters in the main\n * process, with no shared memory — the only user-reachable channel back is\n * `testInfo.attach()`. So every `qualflare.*()` call is serialized and\n * attached under a reserved content type; the reporter recognizes that exact\n * type in `onTestEnd`, replays it as a model mutation, and excludes it from\n * real attachment processing. Same trick `@qualflare/cucumberjs` plays with\n * `World.attach()`, for the same reason.\n *\n * `test.info()` throws when called outside a running test (module scope, a\n * `globalSetup`, a stray import). Warn and drop: a metadata call is never\n * worth failing somebody's suite over.\n */\nfunction send(message: RuntimeMessage): void {\n  try {\n    // The .catch() is not optional. `attach()` returns a promise, and an\n    // unhandled rejection TERMINATES the process by default on Node >= 15 —\n    // a metadata call would take the user's entire test run down with it.\n    // The surrounding try/catch only covers a synchronous throw from\n    // `test.info()` (called outside a running test), not this.\n    void test\n      .info()\n      .attach(`qualflare:${message.type}`, {\n        body: Buffer.from(JSON.stringify(message), 'utf8'),\n        contentType: RESERVED_MESSAGE_MEDIA_TYPE,\n      })\n      .catch((err: unknown) => {\n        logger.warn(`qualflare.${message.type}() could not be recorded: ${(err as Error).message}`);\n      });\n  } catch {\n    logger.warn(`qualflare.${message.type}() was called outside a running test; the call was ignored.`);\n  }\n}\n\n/**\n * Author-facing metadata API. Import it in a spec and annotate tests with\n * business context Playwright itself has no concept of:\n *\n * ```ts\n * import { qualflare } from '@qualflare/playwright';\n *\n * test('checks out', async ({ page }) => {\n *   qualflare.label('epic', 'Billing');\n *   qualflare.link('https://tracker/QF-1', { type: 'issue', name: 'QF-1' });\n *   await qualflare.step('pay', async () => { ... });\n * });\n * ```\n */\nexport const qualflare = {\n  /** Arbitrary name/value metadata (epic, feature, story, owner, severity). */\n  label(name: string, value: string): void {\n    send({ type: 'label', name, value });\n  },\n\n  /** A typed external reference. `type` defaults to `custom`. */\n  link(url: string, opts?: { type?: LinkType; name?: string }): void {\n    send({ type: 'link', url, linkType: opts?.type, name: opts?.name });\n  },\n\n  /** One or more free-text tags. */\n  tag(...tags: string[]): void {\n    send({ type: 'tag', tags });\n  },\n\n  /** Markdown description shown on the case. */\n  description(text: string): void {\n    send({ type: 'description', text });\n  },\n\n  /** Case priority (low | medium | high | critical). */\n  priority(value: CasePriority): void {\n    send({ type: 'priority', value });\n  },\n\n  /** A named input. Inside an open `step()` it attaches to that step;\n   * outside any step it lands in the case's properties. `masked` is a\n   * display hint for the UI only — the server does not redact the value. */\n  parameter(name: string, value?: string, opts?: { masked?: boolean }): void {\n    send({ type: 'parameter', name, value, masked: opts?.masked });\n  },\n\n  /** Attach in-memory content. */\n  attachment(name: string, content: string, opts?: { encoding?: 'utf8' | 'base64'; mimeType?: string }): void {\n    const contentBase64 = opts?.encoding === 'base64' ? content : Buffer.from(content, 'utf8').toString('base64');\n    send({ type: 'attachment', name, contentBase64, mimeType: opts?.mimeType });\n  },\n\n  /** Attach a file from disk. */\n  attachmentFromFile(name: string, path: string, opts?: { mimeType?: string }): void {\n    send({ type: 'attachment_from_file', name, path, mimeType: opts?.mimeType });\n  },\n\n  /**\n   * Records a named step around `fn`.\n   *\n   * Unlike the cucumber-js equivalent, this delegates to Playwright's own\n   * `test.step()` as well, so the step shows up in Playwright's HTML report\n   * and trace viewer in addition to Qualflare — there is no reason to make\n   * users choose, and a step that exists in only one of the two is a\n   * confusing thing to debug against.\n   */\n  async step<T>(name: string, fn: () => T | Promise<T>): Promise<T> {\n    return test.step(name, async () => {\n      send({ type: 'step_start', name, timestamp: Date.now() });\n      try {\n        const result = await fn();\n        send({ type: 'step_stop', status: 'passed', timestamp: Date.now() });\n        return result;\n      } catch (err) {\n        send({\n          type: 'step_stop',\n          status: 'failed',\n          error: err instanceof Error ? err.message : String(err),\n          timestamp: Date.now(),\n        });\n        throw err;\n      }\n    });\n  },\n};\n","/**\n * Shared constants used across the reporter and the author-facing runtime\n * API.\n */\n\n/** Reserved `testInfo.attach()` content type used to smuggle structured\n * `qualflare.*()` calls (label/tag/step/etc.) from test and hook code back to\n * the reporter — the only channel Playwright gives user code back to a\n * running reporter. The reporter recognizes this exact content type and\n * replays the message as a model mutation instead of reporting it as a\n * literal attachment. */\nexport const RESERVED_MESSAGE_MEDIA_TYPE = 'application/vnd.qualflare.message+json';\n\n/** Server-side caps this client should respect defensively (see\n * `api-service/internal/core/domain/launch/launch.go`). */\nexport const MAX_SUITES_PER_LAUNCH = 2000;\nexport const MAX_CASES_PER_SUITE = 5000;\nexport const MAX_STEPS_PER_CASE = 1000;\nexport const MAX_PARAMETERS_PER_STEP = 50;\nexport const MAX_ATTACHMENTS_PER_CASE = 50;\nexport const MAX_LABELS_PER_CASE = 100;\nexport const MAX_LINKS_PER_CASE = 20;\nexport const MAX_TAGS_PER_CASE = 64;\nexport const MAX_TAG_LENGTH = 255;\n\n/** Mirrors `launch.MaxAttachmentUploadFileSize` — the server's hard cap on a\n * single `POST /api/v1/attachments/upload-url` request (video). */\nexport const MAX_VIDEO_UPLOAD_BYTES = 50 * 1024 * 1024;\n\n/** Client-side SOFT cap on steps recorded per scenario attempt — well under\n * the server's 1000-per-case hard cap (`MAX_STEPS_PER_CASE`). Once hit,\n * further steps within that attempt are dropped (with a one-time warning),\n * not queued and truncated later. */\nexport const MAX_STEPS_PER_TEST_ATTEMPT = 300;\n","/**\n * A minimal logger writing to stderr. Deliberately avoids stdout, since\n * that's typically Playwright's own reporter output stream and shouldn't be\n * polluted with reporter diagnostics.\n */\n\nconst PREFIX = '[qualflare-playwright]';\n\nexport const logger = {\n  debug(...args: unknown[]): void {\n    console.debug(PREFIX, ...args);\n  },\n  info(...args: unknown[]): void {\n    console.log(PREFIX, ...args);\n  },\n  warn(...args: unknown[]): void {\n    console.warn(PREFIX, ...args);\n  },\n  error(...args: unknown[]): void {\n    console.error(PREFIX, ...args);\n  },\n};\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACAA,kBAAqB;;;ACWd,IAAM,8BAA8B;AAgBpC,IAAM,yBAAyB,KAAK,OAAO;;;ACrBlD,IAAM,SAAS;AAER,IAAM,SAAS;AAAA,EACpB,SAAS,MAAuB;AAC9B,YAAQ,MAAM,QAAQ,GAAG,IAAI;AAAA,EAC/B;AAAA,EACA,QAAQ,MAAuB;AAC7B,YAAQ,IAAI,QAAQ,GAAG,IAAI;AAAA,EAC7B;AAAA,EACA,QAAQ,MAAuB;AAC7B,YAAQ,KAAK,QAAQ,GAAG,IAAI;AAAA,EAC9B;AAAA,EACA,SAAS,MAAuB;AAC9B,YAAQ,MAAM,QAAQ,GAAG,IAAI;AAAA,EAC/B;AACF;;;AFCA,SAAS,KAAK,SAA+B;AAC3C,MAAI;AAMF,SAAK,iBACF,KAAK,EACL,OAAO,aAAa,QAAQ,IAAI,IAAI;AAAA,MACnC,MAAM,OAAO,KAAK,KAAK,UAAU,OAAO,GAAG,MAAM;AAAA,MACjD,aAAa;AAAA,IACf,CAAC,EACA,MAAM,CAAC,QAAiB;AACvB,aAAO,KAAK,aAAa,QAAQ,IAAI,6BAA8B,IAAc,OAAO,EAAE;AAAA,IAC5F,CAAC;AAAA,EACL,QAAQ;AACN,WAAO,KAAK,aAAa,QAAQ,IAAI,6DAA6D;AAAA,EACpG;AACF;AAgBO,IAAM,YAAY;AAAA;AAAA,EAEvB,MAAM,MAAc,OAAqB;AACvC,SAAK,EAAE,MAAM,SAAS,MAAM,MAAM,CAAC;AAAA,EACrC;AAAA;AAAA,EAGA,KAAK,KAAa,MAAiD;AACjE,SAAK,EAAE,MAAM,QAAQ,KAAK,UAAU,MAAM,MAAM,MAAM,MAAM,KAAK,CAAC;AAAA,EACpE;AAAA;AAAA,EAGA,OAAO,MAAsB;AAC3B,SAAK,EAAE,MAAM,OAAO,KAAK,CAAC;AAAA,EAC5B;AAAA;AAAA,EAGA,YAAY,MAAoB;AAC9B,SAAK,EAAE,MAAM,eAAe,KAAK,CAAC;AAAA,EACpC;AAAA;AAAA,EAGA,SAAS,OAA2B;AAClC,SAAK,EAAE,MAAM,YAAY,MAAM,CAAC;AAAA,EAClC;AAAA;AAAA;AAAA;AAAA,EAKA,UAAU,MAAc,OAAgB,MAAmC;AACzE,SAAK,EAAE,MAAM,aAAa,MAAM,OAAO,QAAQ,MAAM,OAAO,CAAC;AAAA,EAC/D;AAAA;AAAA,EAGA,WAAW,MAAc,SAAiB,MAAkE;AAC1G,UAAM,gBAAgB,MAAM,aAAa,WAAW,UAAU,OAAO,KAAK,SAAS,MAAM,EAAE,SAAS,QAAQ;AAC5G,SAAK,EAAE,MAAM,cAAc,MAAM,eAAe,UAAU,MAAM,SAAS,CAAC;AAAA,EAC5E;AAAA;AAAA,EAGA,mBAAmB,MAAc,MAAc,MAAoC;AACjF,SAAK,EAAE,MAAM,wBAAwB,MAAM,MAAM,UAAU,MAAM,SAAS,CAAC;AAAA,EAC7E;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAWA,MAAM,KAAQ,MAAc,IAAsC;AAChE,WAAO,iBAAK,KAAK,MAAM,YAAY;AACjC,WAAK,EAAE,MAAM,cAAc,MAAM,WAAW,KAAK,IAAI,EAAE,CAAC;AACxD,UAAI;AACF,cAAM,SAAS,MAAM,GAAG;AACxB,aAAK,EAAE,MAAM,aAAa,QAAQ,UAAU,WAAW,KAAK,IAAI,EAAE,CAAC;AACnE,eAAO;AAAA,MACT,SAAS,KAAK;AACZ,aAAK;AAAA,UACH,MAAM;AAAA,UACN,QAAQ;AAAA,UACR,OAAO,eAAe,QAAQ,IAAI,UAAU,OAAO,GAAG;AAAA,UACtD,WAAW,KAAK,IAAI;AAAA,QACtB,CAAC;AACD,cAAM;AAAA,MACR;AAAA,IACF,CAAC;AAAA,EACH;AACF;;;ADrFO,SAAS,kBAAkB,UAAsC,CAAC,GAAwB;AAC/F,SAAO,CAAC,kCAAkC,OAAO;AACnD;","names":[]}

package/dist/index.d.cts

@@ -0,0 +1,79 @@
+import { ReporterDescription } from '@playwright/test';
+import { L as LinkType, C as CasePriority, Q as QualflarePlaywrightOptions } from './resolve-config-CSjXFl7v.cjs';
+export { A as Attachment, a as Case, b as CaseStatus, c as Collect, F as FrameworkCategory, d as Label, e as Link, M as Metadata, N as NanosecondDuration, P as Parameter, f as Platform, R as ResolvedReporterConfig, S as Step, g as Suite } from './resolve-config-CSjXFl7v.cjs';
+
+/**
+ * Author-facing metadata API. Import it in a spec and annotate tests with
+ * business context Playwright itself has no concept of:
+ *
+ * ```ts
+ * import { qualflare } from '@qualflare/playwright';
+ *
+ * test('checks out', async ({ page }) => {
+ *   qualflare.label('epic', 'Billing');
+ *   qualflare.link('https://tracker/QF-1', { type: 'issue', name: 'QF-1' });
+ *   await qualflare.step('pay', async () => { ... });
+ * });
+ * ```
+ */
+declare const qualflare: {
+    /** Arbitrary name/value metadata (epic, feature, story, owner, severity). */
+    label(name: string, value: string): void;
+    /** A typed external reference. `type` defaults to `custom`. */
+    link(url: string, opts?: {
+        type?: LinkType;
+        name?: string;
+    }): void;
+    /** One or more free-text tags. */
+    tag(...tags: string[]): void;
+    /** Markdown description shown on the case. */
+    description(text: string): void;
+    /** Case priority (low | medium | high | critical). */
+    priority(value: CasePriority): void;
+    /** A named input. Inside an open `step()` it attaches to that step;
+     * outside any step it lands in the case's properties. `masked` is a
+     * display hint for the UI only — the server does not redact the value. */
+    parameter(name: string, value?: string, opts?: {
+        masked?: boolean;
+    }): void;
+    /** Attach in-memory content. */
+    attachment(name: string, content: string, opts?: {
+        encoding?: "utf8" | "base64";
+        mimeType?: string;
+    }): void;
+    /** Attach a file from disk. */
+    attachmentFromFile(name: string, path: string, opts?: {
+        mimeType?: string;
+    }): void;
+    /**
+     * Records a named step around `fn`.
+     *
+     * Unlike the cucumber-js equivalent, this delegates to Playwright's own
+     * `test.step()` as well, so the step shows up in Playwright's HTML report
+     * and trace viewer in addition to Qualflare — there is no reason to make
+     * users choose, and a step that exists in only one of the two is a
+     * confusing thing to debug against.
+     */
+    step<T>(name: string, fn: () => T | Promise<T>): Promise<T>;
+};
+
+/**
+ * Typed helper for registering the reporter.
+ *
+ * Playwright types a reporter's options as `any` (`ReporterDescription` ends
+ * in `[string, any]`), so writing the tuple by hand gives no autocomplete and
+ * silently accepts typos. This returns the same tuple with the options
+ * checked:
+ *
+ * ```ts
+ * import { defineConfig } from '@playwright/test';
+ * import { qualflareReporter } from '@qualflare/playwright';
+ *
+ * export default defineConfig({
+ *   reporter: [['list'], qualflareReporter({ environment: 'staging' })],
+ * });
+ * ```
+ */
+declare function qualflareReporter(options?: QualflarePlaywrightOptions): ReporterDescription;
+
+export { CasePriority, LinkType, QualflarePlaywrightOptions, qualflare, qualflareReporter };

package/dist/index.d.ts

@@ -0,0 +1,79 @@
+import { ReporterDescription } from '@playwright/test';
+import { L as LinkType, C as CasePriority, Q as QualflarePlaywrightOptions } from './resolve-config-CSjXFl7v.js';
+export { A as Attachment, a as Case, b as CaseStatus, c as Collect, F as FrameworkCategory, d as Label, e as Link, M as Metadata, N as NanosecondDuration, P as Parameter, f as Platform, R as ResolvedReporterConfig, S as Step, g as Suite } from './resolve-config-CSjXFl7v.js';
+
+/**
+ * Author-facing metadata API. Import it in a spec and annotate tests with
+ * business context Playwright itself has no concept of:
+ *
+ * ```ts
+ * import { qualflare } from '@qualflare/playwright';
+ *
+ * test('checks out', async ({ page }) => {
+ *   qualflare.label('epic', 'Billing');
+ *   qualflare.link('https://tracker/QF-1', { type: 'issue', name: 'QF-1' });
+ *   await qualflare.step('pay', async () => { ... });
+ * });
+ * ```
+ */
+declare const qualflare: {
+    /** Arbitrary name/value metadata (epic, feature, story, owner, severity). */
+    label(name: string, value: string): void;
+    /** A typed external reference. `type` defaults to `custom`. */
+    link(url: string, opts?: {
+        type?: LinkType;
+        name?: string;
+    }): void;
+    /** One or more free-text tags. */
+    tag(...tags: string[]): void;
+    /** Markdown description shown on the case. */
+    description(text: string): void;
+    /** Case priority (low | medium | high | critical). */
+    priority(value: CasePriority): void;
+    /** A named input. Inside an open `step()` it attaches to that step;
+     * outside any step it lands in the case's properties. `masked` is a
+     * display hint for the UI only — the server does not redact the value. */
+    parameter(name: string, value?: string, opts?: {
+        masked?: boolean;
+    }): void;
+    /** Attach in-memory content. */
+    attachment(name: string, content: string, opts?: {
+        encoding?: "utf8" | "base64";
+        mimeType?: string;
+    }): void;
+    /** Attach a file from disk. */
+    attachmentFromFile(name: string, path: string, opts?: {
+        mimeType?: string;
+    }): void;
+    /**
+     * Records a named step around `fn`.
+     *
+     * Unlike the cucumber-js equivalent, this delegates to Playwright's own
+     * `test.step()` as well, so the step shows up in Playwright's HTML report
+     * and trace viewer in addition to Qualflare — there is no reason to make
+     * users choose, and a step that exists in only one of the two is a
+     * confusing thing to debug against.
+     */
+    step<T>(name: string, fn: () => T | Promise<T>): Promise<T>;
+};
+
+/**
+ * Typed helper for registering the reporter.
+ *
+ * Playwright types a reporter's options as `any` (`ReporterDescription` ends
+ * in `[string, any]`), so writing the tuple by hand gives no autocomplete and
+ * silently accepts typos. This returns the same tuple with the options
+ * checked:
+ *
+ * ```ts
+ * import { defineConfig } from '@playwright/test';
+ * import { qualflareReporter } from '@qualflare/playwright';
+ *
+ * export default defineConfig({
+ *   reporter: [['list'], qualflareReporter({ environment: 'staging' })],
+ * });
+ * ```
+ */
+declare function qualflareReporter(options?: QualflarePlaywrightOptions): ReporterDescription;
+
+export { CasePriority, LinkType, QualflarePlaywrightOptions, qualflare, qualflareReporter };