executable-stories-formatters 1.9.0 → 1.9.2

package/dist/adapters.d.cts

@@ -1 +1,183 @@
-export { J as JestAdapterOptions, o as JestAggregatedResult, p as JestFileResult, q as JestTestResult, P as PlaywrightAdapterOptions, s as PlaywrightAnnotation, t as PlaywrightAttachment, u as PlaywrightError, v as PlaywrightLocation, w as PlaywrightStatus, x as PlaywrightTestCase, y as PlaywrightTestResult, G as StoryFileReport, V as VitestAdapterOptions, L as VitestSerializedError, M as VitestState, Q as VitestTestCase, U as VitestTestModule, W as VitestTestResult, j as adaptJestRun, k as adaptPlaywrightRun, l as adaptVitestRun } from './index-CmEmALo3.cjs';
+import { StoryMeta } from 'executable-stories-core/types/story';
+import { RawRun, RawStatus } from 'executable-stories-core/types/raw';
+
+/**
+ * Jest Adapter - Layer 1.
+ *
+ * Transforms Jest test results and story reports into RawRun.
+ */
+
+/** Jest test result shape (subset of what Jest provides) */
+interface JestTestResult {
+    fullName: string;
+    status: "passed" | "failed" | "pending" | "todo";
+    duration?: number;
+    failureMessages?: string[];
+}
+/** Jest file result shape */
+interface JestFileResult {
+    testFilePath: string;
+    testResults: JestTestResult[];
+}
+/** Jest aggregated result shape */
+interface JestAggregatedResult {
+    testResults: JestFileResult[];
+    startTime?: number;
+}
+/** Story file report written by story.init() */
+interface StoryFileReport {
+    testFilePath: string;
+    scenarios: StoryMeta[];
+}
+/** Options for Jest adapter */
+interface JestAdapterOptions {
+    /** Project root directory */
+    projectRoot?: string;
+    /** Package version */
+    packageVersion?: string;
+    /** Git SHA */
+    gitSha?: string;
+}
+/**
+ * Adapt Jest results and story reports to RawRun.
+ *
+ * @param jestResults - Jest aggregated results
+ * @param storyReports - Story reports from story.init()
+ * @param options - Adapter options
+ * @returns RawRun for ACL processing
+ */
+declare function adaptJestRun(jestResults: JestAggregatedResult, storyReports: StoryFileReport[], options?: JestAdapterOptions): RawRun;
+
+/**
+ * Vitest Adapter - Layer 1.
+ *
+ * Transforms Vitest test results into RawRun.
+ */
+
+/** Vitest test state */
+type VitestState = "passed" | "failed" | "skipped" | "pending";
+/** Vitest serialized error */
+interface VitestSerializedError {
+    message?: string;
+    stack?: string;
+    diff?: string;
+}
+/** Vitest test result shape */
+interface VitestTestResult {
+    state?: VitestState;
+    duration?: number;
+    errors?: VitestSerializedError[];
+}
+/** Vitest test case shape (minimal) */
+interface VitestTestCase {
+    name: string;
+    meta: () => Record<string, unknown>;
+    result: () => VitestTestResult | undefined;
+}
+/** Vitest test module shape (minimal) */
+interface VitestTestModule {
+    moduleId?: string;
+    relativeModuleId?: string;
+    children?: {
+        allTests: () => Iterable<VitestTestCase>;
+    };
+}
+/** Options for Vitest adapter */
+interface VitestAdapterOptions {
+    /** Project root directory */
+    projectRoot?: string;
+    /** Package version */
+    packageVersion?: string;
+    /** Git SHA */
+    gitSha?: string;
+    /** Start time (epoch ms) */
+    startedAtMs?: number;
+}
+/**
+ * Adapt Vitest test modules to RawRun.
+ *
+ * @param testModules - Vitest test modules
+ * @param options - Adapter options
+ * @returns RawRun for ACL processing
+ */
+declare function adaptVitestRun(testModules: ReadonlyArray<VitestTestModule>, options?: VitestAdapterOptions): RawRun;
+
+/**
+ * Playwright Adapter - Layer 1.
+ *
+ * Transforms Playwright test results into RawRun.
+ */
+
+/** Playwright test status */
+type PlaywrightStatus = "passed" | "failed" | "skipped" | "timedOut" | "interrupted";
+/** Playwright test error */
+interface PlaywrightError {
+    message?: string;
+    stack?: string;
+}
+/** Playwright attachment */
+interface PlaywrightAttachment {
+    name: string;
+    contentType: string;
+    path?: string;
+    body?: Buffer;
+}
+/** Playwright test result */
+interface PlaywrightTestResult {
+    status: PlaywrightStatus;
+    duration: number;
+    errors: PlaywrightError[];
+    attachments: PlaywrightAttachment[];
+    retry: number;
+    /** Optional step events if caller captures Playwright step timing. */
+    stepEvents?: Array<{
+        index?: number;
+        stepId?: string;
+        title?: string;
+        status?: RawStatus;
+        durationMs?: number;
+        errorMessage?: string;
+    }>;
+}
+/** Playwright test case annotation */
+interface PlaywrightAnnotation {
+    type: string;
+    description?: string;
+}
+/** Playwright test location */
+interface PlaywrightLocation {
+    file: string;
+    line: number;
+    column: number;
+}
+/** Playwright test case shape (minimal) */
+interface PlaywrightTestCase {
+    title: string;
+    titlePath: () => string[];
+    annotations: PlaywrightAnnotation[];
+    location: PlaywrightLocation;
+    retries: number;
+}
+/** Options for Playwright adapter */
+interface PlaywrightAdapterOptions {
+    /** Project root directory */
+    projectRoot?: string;
+    /** Package version */
+    packageVersion?: string;
+    /** Git SHA */
+    gitSha?: string;
+    /** Start time (epoch ms) */
+    startedAtMs?: number;
+    /** Playwright project name */
+    projectName?: string;
+}
+/**
+ * Adapt Playwright test results to RawRun.
+ *
+ * @param testResults - Array of [testCase, result] tuples
+ * @param options - Adapter options
+ * @returns RawRun for ACL processing
+ */
+declare function adaptPlaywrightRun(testResults: Array<[PlaywrightTestCase, PlaywrightTestResult]>, options?: PlaywrightAdapterOptions): RawRun;
+
+export { type JestAdapterOptions, type JestAggregatedResult, type JestFileResult, type JestTestResult, type PlaywrightAdapterOptions, type PlaywrightAnnotation, type PlaywrightAttachment, type PlaywrightError, type PlaywrightLocation, type PlaywrightStatus, type PlaywrightTestCase, type PlaywrightTestResult, type StoryFileReport, type VitestAdapterOptions, type VitestSerializedError, type VitestState, type VitestTestCase, type VitestTestModule, type VitestTestResult, adaptJestRun, adaptPlaywrightRun, adaptVitestRun };

package/dist/adapters.d.ts

@@ -1 +1,183 @@
-export { J as JestAdapterOptions, o as JestAggregatedResult, p as JestFileResult, q as JestTestResult, P as PlaywrightAdapterOptions, s as PlaywrightAnnotation, t as PlaywrightAttachment, u as PlaywrightError, v as PlaywrightLocation, w as PlaywrightStatus, x as PlaywrightTestCase, y as PlaywrightTestResult, G as StoryFileReport, V as VitestAdapterOptions, L as VitestSerializedError, M as VitestState, Q as VitestTestCase, U as VitestTestModule, W as VitestTestResult, j as adaptJestRun, k as adaptPlaywrightRun, l as adaptVitestRun } from './index-CmEmALo3.js';
+import { StoryMeta } from 'executable-stories-core/types/story';
+import { RawRun, RawStatus } from 'executable-stories-core/types/raw';
+
+/**
+ * Jest Adapter - Layer 1.
+ *
+ * Transforms Jest test results and story reports into RawRun.
+ */
+
+/** Jest test result shape (subset of what Jest provides) */
+interface JestTestResult {
+    fullName: string;
+    status: "passed" | "failed" | "pending" | "todo";
+    duration?: number;
+    failureMessages?: string[];
+}
+/** Jest file result shape */
+interface JestFileResult {
+    testFilePath: string;
+    testResults: JestTestResult[];
+}
+/** Jest aggregated result shape */
+interface JestAggregatedResult {
+    testResults: JestFileResult[];
+    startTime?: number;
+}
+/** Story file report written by story.init() */
+interface StoryFileReport {
+    testFilePath: string;
+    scenarios: StoryMeta[];
+}
+/** Options for Jest adapter */
+interface JestAdapterOptions {
+    /** Project root directory */
+    projectRoot?: string;
+    /** Package version */
+    packageVersion?: string;
+    /** Git SHA */
+    gitSha?: string;
+}
+/**
+ * Adapt Jest results and story reports to RawRun.
+ *
+ * @param jestResults - Jest aggregated results
+ * @param storyReports - Story reports from story.init()
+ * @param options - Adapter options
+ * @returns RawRun for ACL processing
+ */
+declare function adaptJestRun(jestResults: JestAggregatedResult, storyReports: StoryFileReport[], options?: JestAdapterOptions): RawRun;
+
+/**
+ * Vitest Adapter - Layer 1.
+ *
+ * Transforms Vitest test results into RawRun.
+ */
+
+/** Vitest test state */
+type VitestState = "passed" | "failed" | "skipped" | "pending";
+/** Vitest serialized error */
+interface VitestSerializedError {
+    message?: string;
+    stack?: string;
+    diff?: string;
+}
+/** Vitest test result shape */
+interface VitestTestResult {
+    state?: VitestState;
+    duration?: number;
+    errors?: VitestSerializedError[];
+}
+/** Vitest test case shape (minimal) */
+interface VitestTestCase {
+    name: string;
+    meta: () => Record<string, unknown>;
+    result: () => VitestTestResult | undefined;
+}
+/** Vitest test module shape (minimal) */
+interface VitestTestModule {
+    moduleId?: string;
+    relativeModuleId?: string;
+    children?: {
+        allTests: () => Iterable<VitestTestCase>;
+    };
+}
+/** Options for Vitest adapter */
+interface VitestAdapterOptions {
+    /** Project root directory */
+    projectRoot?: string;
+    /** Package version */
+    packageVersion?: string;
+    /** Git SHA */
+    gitSha?: string;
+    /** Start time (epoch ms) */
+    startedAtMs?: number;
+}
+/**
+ * Adapt Vitest test modules to RawRun.
+ *
+ * @param testModules - Vitest test modules
+ * @param options - Adapter options
+ * @returns RawRun for ACL processing
+ */
+declare function adaptVitestRun(testModules: ReadonlyArray<VitestTestModule>, options?: VitestAdapterOptions): RawRun;
+
+/**
+ * Playwright Adapter - Layer 1.
+ *
+ * Transforms Playwright test results into RawRun.
+ */
+
+/** Playwright test status */
+type PlaywrightStatus = "passed" | "failed" | "skipped" | "timedOut" | "interrupted";
+/** Playwright test error */
+interface PlaywrightError {
+    message?: string;
+    stack?: string;
+}
+/** Playwright attachment */
+interface PlaywrightAttachment {
+    name: string;
+    contentType: string;
+    path?: string;
+    body?: Buffer;
+}
+/** Playwright test result */
+interface PlaywrightTestResult {
+    status: PlaywrightStatus;
+    duration: number;
+    errors: PlaywrightError[];
+    attachments: PlaywrightAttachment[];
+    retry: number;
+    /** Optional step events if caller captures Playwright step timing. */
+    stepEvents?: Array<{
+        index?: number;
+        stepId?: string;
+        title?: string;
+        status?: RawStatus;
+        durationMs?: number;
+        errorMessage?: string;
+    }>;
+}
+/** Playwright test case annotation */
+interface PlaywrightAnnotation {
+    type: string;
+    description?: string;
+}
+/** Playwright test location */
+interface PlaywrightLocation {
+    file: string;
+    line: number;
+    column: number;
+}
+/** Playwright test case shape (minimal) */
+interface PlaywrightTestCase {
+    title: string;
+    titlePath: () => string[];
+    annotations: PlaywrightAnnotation[];
+    location: PlaywrightLocation;
+    retries: number;
+}
+/** Options for Playwright adapter */
+interface PlaywrightAdapterOptions {
+    /** Project root directory */
+    projectRoot?: string;
+    /** Package version */
+    packageVersion?: string;
+    /** Git SHA */
+    gitSha?: string;
+    /** Start time (epoch ms) */
+    startedAtMs?: number;
+    /** Playwright project name */
+    projectName?: string;
+}
+/**
+ * Adapt Playwright test results to RawRun.
+ *
+ * @param testResults - Array of [testCase, result] tuples
+ * @param options - Adapter options
+ * @returns RawRun for ACL processing
+ */
+declare function adaptPlaywrightRun(testResults: Array<[PlaywrightTestCase, PlaywrightTestResult]>, options?: PlaywrightAdapterOptions): RawRun;
+
+export { type JestAdapterOptions, type JestAggregatedResult, type JestFileResult, type JestTestResult, type PlaywrightAdapterOptions, type PlaywrightAnnotation, type PlaywrightAttachment, type PlaywrightError, type PlaywrightLocation, type PlaywrightStatus, type PlaywrightTestCase, type PlaywrightTestResult, type StoryFileReport, type VitestAdapterOptions, type VitestSerializedError, type VitestState, type VitestTestCase, type VitestTestModule, type VitestTestResult, adaptJestRun, adaptPlaywrightRun, adaptVitestRun };