executable-stories-formatters 0.4.0 → 0.6.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -132,13 +132,6 @@ interface StoryMeta {
132
132
  /** Key used to store StoryMeta in test metadata */
133
133
  declare const STORY_META_KEY = "story";
134
134
 
135
- /**
136
- * Raw types for Layer 1: Framework Adapters.
137
- *
138
- * These types are permissive and gather best-effort data from each framework.
139
- * The ACL (Layer 2) will normalize these into strict canonical types.
140
- */
141
-
142
135
  /** Permissive status from any framework */
143
136
  type RawStatus = "pass" | "fail" | "skip" | "todo" | "pending" | "timeout" | "interrupted" | "unknown";
144
137
  /** Raw attachment - don't decide inline vs link yet */
@@ -209,8 +202,16 @@ interface RawTestCase {
209
202
  /** CI environment info */
210
203
  interface RawCIInfo {
211
204
  name: string;
205
+ /** Typed provider key (stable identifier) */
206
+ provider?: CIProvider;
212
207
  url?: string;
213
208
  buildNumber?: string;
209
+ /** Git branch name */
210
+ branch?: string;
211
+ /** Git commit SHA */
212
+ commitSha?: string;
213
+ /** Pull/merge request number */
214
+ prNumber?: string;
214
215
  }
215
216
  /** Raw run - all framework data gathered */
216
217
  interface RawRun {
@@ -230,6 +231,30 @@ interface RawRun {
230
231
  ci?: RawCIInfo;
231
232
  }
232
233
 
234
+ /**
235
+ * Typed CI provider and canonical CI info.
236
+ *
237
+ * RawCIInfo.name = legacy transport string (kept for backward compat + schema).
238
+ * CIInfo.displayName = canonical display name for downstream consumers.
239
+ *
240
+ * All downstream code (HTML meta, notifications, history) uses CIInfo via mappers.
241
+ */
242
+
243
+ type CIProvider = "github" | "gitlab" | "circleci" | "jenkins" | "azure" | "buildkite" | "travis" | "unknown";
244
+ interface CIInfo {
245
+ provider: CIProvider;
246
+ displayName: string;
247
+ url?: string;
248
+ buildNumber?: string;
249
+ branch?: string;
250
+ commitSha?: string;
251
+ prNumber?: string;
252
+ }
253
+ /** Convert RawCIInfo (legacy transport) to canonical CIInfo. */
254
+ declare function toCIInfo(raw?: RawCIInfo): CIInfo | undefined;
255
+ /** Convert canonical CIInfo back to RawCIInfo (for serialization). */
256
+ declare function toRawCIInfo(ci?: CIInfo): RawCIInfo | undefined;
257
+
233
258
  /**
234
259
  * Jest Adapter - Layer 1.
235
260
  *
@@ -400,4 +425,4 @@ interface PlaywrightAdapterOptions {
400
425
  */
401
426
  declare function adaptPlaywrightRun(testResults: Array<[PlaywrightTestCase, PlaywrightTestResult]>, options?: PlaywrightAdapterOptions): RawRun;
402
427
 
403
- export { type VitestState as A, type VitestTestCase as B, type VitestTestModule as C, type DocEntry as D, type VitestTestResult as E, 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 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 OtelSpan as l, type PlaywrightAnnotation as m, type PlaywrightAttachment as n, type PlaywrightError as o, type PlaywrightLocation as p, type PlaywrightStatus as q, type PlaywrightTestCase as r, type PlaywrightTestResult as s, type RawStepEvent as t, type RawTestCase as u, STORY_META_KEY as v, type StepKeyword as w, type StepMode as x, type StoryFileReport as y, type VitestSerializedError as z };
428
+ 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 };
@@ -132,13 +132,6 @@ interface StoryMeta {
132
132
  /** Key used to store StoryMeta in test metadata */
133
133
  declare const STORY_META_KEY = "story";
134
134
 
135
- /**
136
- * Raw types for Layer 1: Framework Adapters.
137
- *
138
- * These types are permissive and gather best-effort data from each framework.
139
- * The ACL (Layer 2) will normalize these into strict canonical types.
140
- */
141
-
142
135
  /** Permissive status from any framework */
143
136
  type RawStatus = "pass" | "fail" | "skip" | "todo" | "pending" | "timeout" | "interrupted" | "unknown";
144
137
  /** Raw attachment - don't decide inline vs link yet */
@@ -209,8 +202,16 @@ interface RawTestCase {
209
202
  /** CI environment info */
210
203
  interface RawCIInfo {
211
204
  name: string;
205
+ /** Typed provider key (stable identifier) */
206
+ provider?: CIProvider;
212
207
  url?: string;
213
208
  buildNumber?: string;
209
+ /** Git branch name */
210
+ branch?: string;
211
+ /** Git commit SHA */
212
+ commitSha?: string;
213
+ /** Pull/merge request number */
214
+ prNumber?: string;
214
215
  }
215
216
  /** Raw run - all framework data gathered */
216
217
  interface RawRun {
@@ -230,6 +231,30 @@ interface RawRun {
230
231
  ci?: RawCIInfo;
231
232
  }
232
233
 
234
+ /**
235
+ * Typed CI provider and canonical CI info.
236
+ *
237
+ * RawCIInfo.name = legacy transport string (kept for backward compat + schema).
238
+ * CIInfo.displayName = canonical display name for downstream consumers.
239
+ *
240
+ * All downstream code (HTML meta, notifications, history) uses CIInfo via mappers.
241
+ */
242
+
243
+ type CIProvider = "github" | "gitlab" | "circleci" | "jenkins" | "azure" | "buildkite" | "travis" | "unknown";
244
+ interface CIInfo {
245
+ provider: CIProvider;
246
+ displayName: string;
247
+ url?: string;
248
+ buildNumber?: string;
249
+ branch?: string;
250
+ commitSha?: string;
251
+ prNumber?: string;
252
+ }
253
+ /** Convert RawCIInfo (legacy transport) to canonical CIInfo. */
254
+ declare function toCIInfo(raw?: RawCIInfo): CIInfo | undefined;
255
+ /** Convert canonical CIInfo back to RawCIInfo (for serialization). */
256
+ declare function toRawCIInfo(ci?: CIInfo): RawCIInfo | undefined;
257
+
233
258
  /**
234
259
  * Jest Adapter - Layer 1.
235
260
  *
@@ -400,4 +425,4 @@ interface PlaywrightAdapterOptions {
400
425
  */
401
426
  declare function adaptPlaywrightRun(testResults: Array<[PlaywrightTestCase, PlaywrightTestResult]>, options?: PlaywrightAdapterOptions): RawRun;
402
427
 
403
- export { type VitestState as A, type VitestTestCase as B, type VitestTestModule as C, type DocEntry as D, type VitestTestResult as E, 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 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 OtelSpan as l, type PlaywrightAnnotation as m, type PlaywrightAttachment as n, type PlaywrightError as o, type PlaywrightLocation as p, type PlaywrightStatus as q, type PlaywrightTestCase as r, type PlaywrightTestResult as s, type RawStepEvent as t, type RawTestCase as u, STORY_META_KEY as v, type StepKeyword as w, type StepMode as x, type StoryFileReport as y, type VitestSerializedError as z };
428
+ 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 };