@testrelic/playwright-analytics 2.2.4 → 2.2.5

package/dist/index.d.cts

@@ -2,7 +2,7 @@ import { ReporterConfig, NavigationType } from '@testrelic/core';
 export { ATTACHMENT_CONTENT_TYPE, ATTACHMENT_NAME, ApiAssertion, ApiCallRecord, ApiCallStep, ApiCallStepRequest, ApiCallStepResponse, AssertionLocation, AssertionType, CIMetadata, FailureDiagnostic, NavigationStep, NavigationType, NetworkStats, PAYLOAD_VERSION, ReporterConfig, StepAssertion, StepTestIdentity, Summary, TestRelicDataPayload, TestResult, TestRunReport, TimelineEntry, TimelineStep, isTestRelicDataPayload } from '@testrelic/core';
 export { testRelicFixture } from './fixture.cjs';
 export { testRelicApiFixture } from './api-fixture.cjs';
-import '@playwright/test';
+import { PlaywrightTestConfig, defineConfig as defineConfig$1 } from '@playwright/test';
 
 /**
  * TestRelicReporter — Playwright custom reporter
@@ -82,6 +82,7 @@ declare class TestRelicReporter {
     private startedAt;
     private testRunId;
     private collectedTests;
+    private fixtureDataReceived;
     private cloudClient;
     private cloudRunId;
     constructor(options?: Partial<ReporterConfig>);
@@ -100,6 +101,34 @@ declare class TestRelicReporter {
  */
 declare const SCHEMA_VERSION = "1.3.0";
 
+/**
+ * defineConfig — Wrapper around Playwright's defineConfig with sensible defaults.
+ *
+ * Automatically enables video capture, screenshots, and the TestRelic reporter
+ * so users don't need to configure these manually.
+ */
+
+/**
+ * Wraps Playwright's `defineConfig` with TestRelic defaults:
+ * - `use.video: 'on'`
+ * - `use.screenshot: 'on'`
+ * - `use.trace: 'on'` (captures network HAR, DOM snapshots, and console logs)
+ * - Appends the TestRelic reporter if not already present
+ *
+ * User-provided values always take priority.
+ *
+ * @example
+ * ```ts
+ * import { defineConfig } from '@testrelic/playwright-analytics';
+ *
+ * export default defineConfig({
+ *   testDir: './tests',
+ *   // video, screenshot, and reporter are configured automatically
+ * });
+ * ```
+ */
+declare function defineConfig(config: PlaywrightTestConfig, reporterOptions?: Partial<ReporterConfig>): ReturnType<typeof defineConfig$1>;
+
 /**
  * @testrelic/playwright-analytics — Main entry point
  *
@@ -121,4 +150,4 @@ declare function recordNavigation(testInfo: {
     }>;
 } | null | undefined, url: string, navigationType?: NavigationType): void;
 
-export { SCHEMA_VERSION, TestRelicReporter as default, recordNavigation };
+export { SCHEMA_VERSION, TestRelicReporter as default, defineConfig, recordNavigation };

package/dist/index.d.ts

@@ -2,7 +2,7 @@ import { ReporterConfig, NavigationType } from '@testrelic/core';
 export { ATTACHMENT_CONTENT_TYPE, ATTACHMENT_NAME, ApiAssertion, ApiCallRecord, ApiCallStep, ApiCallStepRequest, ApiCallStepResponse, AssertionLocation, AssertionType, CIMetadata, FailureDiagnostic, NavigationStep, NavigationType, NetworkStats, PAYLOAD_VERSION, ReporterConfig, StepAssertion, StepTestIdentity, Summary, TestRelicDataPayload, TestResult, TestRunReport, TimelineEntry, TimelineStep, isTestRelicDataPayload } from '@testrelic/core';
 export { testRelicFixture } from './fixture.js';
 export { testRelicApiFixture } from './api-fixture.js';
-import '@playwright/test';
+import { PlaywrightTestConfig, defineConfig as defineConfig$1 } from '@playwright/test';
 
 /**
  * TestRelicReporter — Playwright custom reporter
@@ -82,6 +82,7 @@ declare class TestRelicReporter {
     private startedAt;
     private testRunId;
     private collectedTests;
+    private fixtureDataReceived;
     private cloudClient;
     private cloudRunId;
     constructor(options?: Partial<ReporterConfig>);
@@ -100,6 +101,34 @@ declare class TestRelicReporter {
  */
 declare const SCHEMA_VERSION = "1.3.0";
 
+/**
+ * defineConfig — Wrapper around Playwright's defineConfig with sensible defaults.
+ *
+ * Automatically enables video capture, screenshots, and the TestRelic reporter
+ * so users don't need to configure these manually.
+ */
+
+/**
+ * Wraps Playwright's `defineConfig` with TestRelic defaults:
+ * - `use.video: 'on'`
+ * - `use.screenshot: 'on'`
+ * - `use.trace: 'on'` (captures network HAR, DOM snapshots, and console logs)
+ * - Appends the TestRelic reporter if not already present
+ *
+ * User-provided values always take priority.
+ *
+ * @example
+ * ```ts
+ * import { defineConfig } from '@testrelic/playwright-analytics';
+ *
+ * export default defineConfig({
+ *   testDir: './tests',
+ *   // video, screenshot, and reporter are configured automatically
+ * });
+ * ```
+ */
+declare function defineConfig(config: PlaywrightTestConfig, reporterOptions?: Partial<ReporterConfig>): ReturnType<typeof defineConfig$1>;
+
 /**
  * @testrelic/playwright-analytics — Main entry point
  *
@@ -121,4 +150,4 @@ declare function recordNavigation(testInfo: {
     }>;
 } | null | undefined, url: string, navigationType?: NavigationType): void;
 
-export { SCHEMA_VERSION, TestRelicReporter as default, recordNavigation };
+export { SCHEMA_VERSION, TestRelicReporter as default, defineConfig, recordNavigation };