executable-stories-formatters 0.3.0 → 0.5.0

package/dist/{index-DCJ0NvAp.d.cts → index-C4QO-SVT.d.cts}

@@ -1,3 +1,25 @@
+/**
+ * OTel span types for trace waterfall rendering.
+ *
+ * Structurally compatible with autotel's SerializedSpan
+ * and raw OTel nanosecond formats. No import dependency on autotel.
+ */
+type OtelAttributeValue = string | number | boolean | string[] | number[] | boolean[];
+interface OtelSpan {
+    spanId: string;
+    parentSpanId?: string;
+    name: string;
+    /** Preferred: epoch-based milliseconds (from autotel's SerializedSpan) */
+    startTimeMs?: number;
+    durationMs?: number;
+    /** Compatibility: raw OTel nanosecond timestamps */
+    startTimeUnixNano?: number;
+    endTimeUnixNano?: number;
+    status: "ok" | "error" | "unset";
+    statusMessage?: string;
+    attributes?: Record<string, OtelAttributeValue>;
+}
+
 /**
  * Story types — the shared vocabulary for all framework adapters.
  *
@@ -5,6 +27,7 @@
  * They now live in formatters so every adapter can import them
  * from the same place that defines RawRun (the output contract).
  */
+
 /** BDD step keywords for scenario documentation */
 type StepKeyword = "Given" | "When" | "Then" | "And" | "But";
 /** Step execution mode for docs rendering */
@@ -103,17 +126,12 @@ interface StoryMeta {
     docs?: DocEntry[];
     /** Order in which story.init() was called (for source ordering) */
     sourceOrder?: number;
+    /** OTel spans from autotel for trace waterfall rendering */
+    otelSpans?: OtelSpan[];
 }
 /** Key used to store StoryMeta in test metadata */
 declare const STORY_META_KEY = "story";
 
-/**
- * Raw types for Layer 1: Framework Adapters.
- *
- * These types are permissive and gather best-effort data from each framework.
- * The ACL (Layer 2) will normalize these into strict canonical types.
- */
-
 /** Permissive status from any framework */
 type RawStatus = "pass" | "fail" | "skip" | "todo" | "pending" | "timeout" | "interrupted" | "unknown";
 /** Raw attachment - don't decide inline vs link yet */
@@ -184,8 +202,16 @@ interface RawTestCase {
 /** CI environment info */
 interface RawCIInfo {
     name: string;
+    /** Typed provider key (stable identifier) */
+    provider?: CIProvider;
     url?: string;
     buildNumber?: string;
+    /** Git branch name */
+    branch?: string;
+    /** Git commit SHA */
+    commitSha?: string;
+    /** Pull/merge request number */
+    prNumber?: string;
 }
 /** Raw run - all framework data gathered */
 interface RawRun {
@@ -205,6 +231,30 @@ interface RawRun {
     ci?: RawCIInfo;
 }
 
+/**
+ * Typed CI provider and canonical CI info.
+ *
+ * RawCIInfo.name = legacy transport string (kept for backward compat + schema).
+ * CIInfo.displayName = canonical display name for downstream consumers.
+ *
+ * All downstream code (HTML meta, notifications, history) uses CIInfo via mappers.
+ */
+
+type CIProvider = "github" | "gitlab" | "circleci" | "jenkins" | "azure" | "buildkite" | "travis" | "unknown";
+interface CIInfo {
+    provider: CIProvider;
+    displayName: string;
+    url?: string;
+    buildNumber?: string;
+    branch?: string;
+    commitSha?: string;
+    prNumber?: string;
+}
+/** Convert RawCIInfo (legacy transport) to canonical CIInfo. */
+declare function toCIInfo(raw?: RawCIInfo): CIInfo | undefined;
+/** Convert canonical CIInfo back to RawCIInfo (for serialization). */
+declare function toRawCIInfo(ci?: CIInfo): RawCIInfo | undefined;
+
 /**
  * Jest Adapter - Layer 1.
  *
@@ -375,4 +425,4 @@ interface PlaywrightAdapterOptions {
  */
 declare function adaptPlaywrightRun(testResults: Array<[PlaywrightTestCase, PlaywrightTestResult]>, options?: PlaywrightAdapterOptions): RawRun;
 
-export { type VitestTestCase as A, type VitestTestModule as B, type VitestTestResult as C, type DocEntry as D, type JestAdapterOptions as J, type PlaywrightAdapterOptions as P, type RawStatus as R, type StoryMeta as S, type VitestAdapterOptions as V, type StoryStep as a, type RawAttachment as b, type RawRun as c, type RawCIInfo as d, adaptJestRun as e, adaptPlaywrightRun as f, adaptVitestRun as g, type DocPhase as h, type JestAggregatedResult as i, type JestFileResult as j, type JestTestResult as k, type PlaywrightAnnotation as l, type PlaywrightAttachment as m, type PlaywrightError as n, type PlaywrightLocation as o, type PlaywrightStatus as p, type PlaywrightTestCase as q, type PlaywrightTestResult as r, type RawStepEvent as s, type RawTestCase as t, STORY_META_KEY as u, type StepKeyword as v, type StepMode as w, type StoryFileReport as x, type VitestSerializedError as y, type VitestState as z };
+export { type VitestSerializedError as A, type VitestState as B, type CIInfo as C, type DocEntry as D, type VitestTestCase as E, type VitestTestModule as F, type VitestTestResult as G, toCIInfo as H, toRawCIInfo as I, type JestAdapterOptions as J, type OtelAttributeValue as O, type PlaywrightAdapterOptions as P, type RawStatus as R, type StoryMeta as S, type VitestAdapterOptions as V, type StoryStep as a, type RawAttachment as b, type RawRun as c, type CIProvider as d, type RawCIInfo as e, adaptJestRun as f, adaptPlaywrightRun as g, adaptVitestRun as h, type DocPhase as i, type JestAggregatedResult as j, type JestFileResult as k, type JestTestResult as l, type OtelSpan as m, type PlaywrightAnnotation as n, type PlaywrightAttachment as o, type PlaywrightError as p, type PlaywrightLocation as q, type PlaywrightStatus as r, type PlaywrightTestCase as s, type PlaywrightTestResult as t, type RawStepEvent as u, type RawTestCase as v, STORY_META_KEY as w, type StepKeyword as x, type StepMode as y, type StoryFileReport as z };

package/dist/{index-DCJ0NvAp.d.ts → index-C4QO-SVT.d.ts}

@@ -1,3 +1,25 @@
+/**
+ * OTel span types for trace waterfall rendering.
+ *
+ * Structurally compatible with autotel's SerializedSpan
+ * and raw OTel nanosecond formats. No import dependency on autotel.
+ */
+type OtelAttributeValue = string | number | boolean | string[] | number[] | boolean[];
+interface OtelSpan {
+    spanId: string;
+    parentSpanId?: string;
+    name: string;
+    /** Preferred: epoch-based milliseconds (from autotel's SerializedSpan) */
+    startTimeMs?: number;
+    durationMs?: number;
+    /** Compatibility: raw OTel nanosecond timestamps */
+    startTimeUnixNano?: number;
+    endTimeUnixNano?: number;
+    status: "ok" | "error" | "unset";
+    statusMessage?: string;
+    attributes?: Record<string, OtelAttributeValue>;
+}
+
 /**
  * Story types — the shared vocabulary for all framework adapters.
  *
@@ -5,6 +27,7 @@
  * They now live in formatters so every adapter can import them
  * from the same place that defines RawRun (the output contract).
  */
+
 /** BDD step keywords for scenario documentation */
 type StepKeyword = "Given" | "When" | "Then" | "And" | "But";
 /** Step execution mode for docs rendering */
@@ -103,17 +126,12 @@ interface StoryMeta {
     docs?: DocEntry[];
     /** Order in which story.init() was called (for source ordering) */
     sourceOrder?: number;
+    /** OTel spans from autotel for trace waterfall rendering */
+    otelSpans?: OtelSpan[];
 }
 /** Key used to store StoryMeta in test metadata */
 declare const STORY_META_KEY = "story";
 
-/**
- * Raw types for Layer 1: Framework Adapters.
- *
- * These types are permissive and gather best-effort data from each framework.
- * The ACL (Layer 2) will normalize these into strict canonical types.
- */
-
 /** Permissive status from any framework */
 type RawStatus = "pass" | "fail" | "skip" | "todo" | "pending" | "timeout" | "interrupted" | "unknown";
 /** Raw attachment - don't decide inline vs link yet */
@@ -184,8 +202,16 @@ interface RawTestCase {
 /** CI environment info */
 interface RawCIInfo {
     name: string;
+    /** Typed provider key (stable identifier) */
+    provider?: CIProvider;
     url?: string;
     buildNumber?: string;
+    /** Git branch name */
+    branch?: string;
+    /** Git commit SHA */
+    commitSha?: string;
+    /** Pull/merge request number */
+    prNumber?: string;
 }
 /** Raw run - all framework data gathered */
 interface RawRun {
@@ -205,6 +231,30 @@ interface RawRun {
     ci?: RawCIInfo;
 }
 
+/**
+ * Typed CI provider and canonical CI info.
+ *
+ * RawCIInfo.name = legacy transport string (kept for backward compat + schema).
+ * CIInfo.displayName = canonical display name for downstream consumers.
+ *
+ * All downstream code (HTML meta, notifications, history) uses CIInfo via mappers.
+ */
+
+type CIProvider = "github" | "gitlab" | "circleci" | "jenkins" | "azure" | "buildkite" | "travis" | "unknown";
+interface CIInfo {
+    provider: CIProvider;
+    displayName: string;
+    url?: string;
+    buildNumber?: string;
+    branch?: string;
+    commitSha?: string;
+    prNumber?: string;
+}
+/** Convert RawCIInfo (legacy transport) to canonical CIInfo. */
+declare function toCIInfo(raw?: RawCIInfo): CIInfo | undefined;
+/** Convert canonical CIInfo back to RawCIInfo (for serialization). */
+declare function toRawCIInfo(ci?: CIInfo): RawCIInfo | undefined;
+
 /**
  * Jest Adapter - Layer 1.
  *
@@ -375,4 +425,4 @@ interface PlaywrightAdapterOptions {
  */
 declare function adaptPlaywrightRun(testResults: Array<[PlaywrightTestCase, PlaywrightTestResult]>, options?: PlaywrightAdapterOptions): RawRun;
 
-export { type VitestTestCase as A, type VitestTestModule as B, type VitestTestResult as C, type DocEntry as D, type JestAdapterOptions as J, type PlaywrightAdapterOptions as P, type RawStatus as R, type StoryMeta as S, type VitestAdapterOptions as V, type StoryStep as a, type RawAttachment as b, type RawRun as c, type RawCIInfo as d, adaptJestRun as e, adaptPlaywrightRun as f, adaptVitestRun as g, type DocPhase as h, type JestAggregatedResult as i, type JestFileResult as j, type JestTestResult as k, type PlaywrightAnnotation as l, type PlaywrightAttachment as m, type PlaywrightError as n, type PlaywrightLocation as o, type PlaywrightStatus as p, type PlaywrightTestCase as q, type PlaywrightTestResult as r, type RawStepEvent as s, type RawTestCase as t, STORY_META_KEY as u, type StepKeyword as v, type StepMode as w, type StoryFileReport as x, type VitestSerializedError as y, type VitestState as z };
+export { type VitestSerializedError as A, type VitestState as B, type CIInfo as C, type DocEntry as D, type VitestTestCase as E, type VitestTestModule as F, type VitestTestResult as G, toCIInfo as H, toRawCIInfo as I, type JestAdapterOptions as J, type OtelAttributeValue as O, type PlaywrightAdapterOptions as P, type RawStatus as R, type StoryMeta as S, type VitestAdapterOptions as V, type StoryStep as a, type RawAttachment as b, type RawRun as c, type CIProvider as d, type RawCIInfo as e, adaptJestRun as f, adaptPlaywrightRun as g, adaptVitestRun as h, type DocPhase as i, type JestAggregatedResult as j, type JestFileResult as k, type JestTestResult as l, type OtelSpan as m, type PlaywrightAnnotation as n, type PlaywrightAttachment as o, type PlaywrightError as p, type PlaywrightLocation as q, type PlaywrightStatus as r, type PlaywrightTestCase as s, type PlaywrightTestResult as t, type RawStepEvent as u, type RawTestCase as v, STORY_META_KEY as w, type StepKeyword as x, type StepMode as y, type StoryFileReport as z };